X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=ext%2Fthreads%2Fthreads.xs;h=5e6d16cd87453e9941d3c607a91b07575d6c1aa3;hb=fe78ea027a72ff06add9150128e93d05e41f864b;hp=6d8394f191d4df027836e9249898e9eb9662d0f4;hpb=b6a0b9300b0eaf800e7a664e27d617bce6944c76;p=p5sagit%2Fp5-mst-13.2.git diff --git a/ext/threads/threads.xs b/ext/threads/threads.xs index 6d8394f..5e6d16c 100755 --- a/ext/threads/threads.xs +++ b/ext/threads/threads.xs @@ -1,397 +1,1237 @@ -#include "threads.h" +#define PERL_NO_GET_CONTEXT +#include "EXTERN.h" +#include "perl.h" +#include "XSUB.h" +/* Workaround for XSUB.h bug under WIN32 */ +#ifdef WIN32 +# undef setjmp +# define setjmp(x) _setjmp(x) +#endif +#ifdef HAS_PPPORT_H +# define NEED_PL_signals +# define NEED_newRV_noinc +# define NEED_sv_2pv_nolen +# include "ppport.h" +# include "threads.h" +#endif -/* - * Starts executing the thread. Needs to clean up memory a tad better. - */ +#ifdef USE_ITHREADS #ifdef WIN32 -THREAD_RET_TYPE Perl_thread_run(LPVOID arg) { +# include + /* Supposed to be in Winbase.h */ +# ifndef STACK_SIZE_PARAM_IS_A_RESERVATION +# define STACK_SIZE_PARAM_IS_A_RESERVATION 0x00010000 +# endif +# include #else -void* Perl_thread_run(void * arg) { +# ifdef OS2 +typedef perl_os_thread pthread_t; +# else +# include +# endif +# include +# define PERL_THREAD_SETSPECIFIC(k,v) pthread_setspecific(k,v) +# ifdef OLD_PTHREADS_API +# define PERL_THREAD_DETACH(t) pthread_detach(&(t)) +# else +# define PERL_THREAD_DETACH(t) pthread_detach((t)) +# endif +#endif +#if !defined(HAS_GETPAGESIZE) && defined(I_SYS_PARAM) +# include #endif - ithread* thread = (ithread*) arg; - SV* thread_tid_ptr; - SV* thread_ptr; - dTHXa(thread->interp); - PERL_SET_CONTEXT(thread->interp); +/* Values for 'state' member */ +#define PERL_ITHR_JOINABLE 0 +#define PERL_ITHR_DETACHED 1 +#define PERL_ITHR_JOINED 2 +#define PERL_ITHR_FINISHED 4 + +typedef struct _ithread { + struct _ithread *next; /* Next thread in the list */ + struct _ithread *prev; /* Prev thread in the list */ + PerlInterpreter *interp; /* The threads interpreter */ + UV tid; /* Threads module's thread id */ + perl_mutex mutex; /* Mutex for updating things in this struct */ + int count; /* How many SVs have a reference to us */ + int state; /* Detached, joined, finished, etc. */ + int gimme; /* Context of create */ + SV *init_function; /* Code to run */ + SV *params; /* Args to pass function */ #ifdef WIN32 - thread->thr = GetCurrentThreadId(); + DWORD thr; /* OS's idea if thread id */ + HANDLE handle; /* OS's waitable handle */ +#else + pthread_t thr; /* OS's handle for the thread */ +#endif + IV stack_size; +} ithread; + + +/* Used by Perl interpreter for thread context switching */ +#define MY_CXT_KEY "threads::_guts" XS_VERSION + +typedef struct { + ithread *thread; +} my_cxt_t; + +START_MY_CXT + + +/* Linked list of all threads */ +static ithread *threads; + +/* Protects the creation and destruction of threads*/ +static perl_mutex create_destruct_mutex; + +static UV tid_counter = 0; +static IV joinable_threads = 0; +static IV running_threads = 0; +static IV detached_threads = 0; +#ifdef THREAD_CREATE_NEEDS_STACK +static IV default_stack_size = THREAD_CREATE_NEEDS_STACK; #else - thread->thr = pthread_self(); +static IV default_stack_size = 0; +#endif +static IV page_size = 0; + + +/* Used by Perl interpreter for thread context switching */ +static void +S_ithread_set(pTHX_ ithread *thread) +{ + dMY_CXT; + MY_CXT.thread = thread; +} + +static ithread * +S_ithread_get(pTHX) +{ + dMY_CXT; + return (MY_CXT.thread); +} + + +/* Free any data (such as the Perl interpreter) attached to an ithread + * structure. This is a bit like undef on SVs, where the SV isn't freed, + * but the PVX is. Must be called with thread->mutex already held. + */ +static void +S_ithread_clear(pTHX_ ithread *thread) +{ + PerlInterpreter *interp; + + assert(thread->state & PERL_ITHR_FINISHED && + thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)); + + interp = thread->interp; + if (interp) { + dTHXa(interp); + + PERL_SET_CONTEXT(interp); + S_ithread_set(aTHX_ thread); + + SvREFCNT_dec(thread->params); + thread->params = Nullsv; + + perl_destruct(interp); + thread->interp = NULL; + } + if (interp) + perl_free(interp); + + PERL_SET_CONTEXT(aTHX); +} + + +/* Free an ithread structure and any attached data if its count == 0 */ +static void +S_ithread_destruct(pTHX_ ithread *thread) +{ +#ifdef WIN32 + HANDLE handle; +#endif + + MUTEX_LOCK(&thread->mutex); + + /* Thread is still in use */ + if (thread->count != 0) { + MUTEX_UNLOCK(&thread->mutex); + return; + } + + /* Main thread (0) is immortal and should never get here */ + assert(thread->tid != 0); + + /* Remove from circular list of threads */ + MUTEX_LOCK(&create_destruct_mutex); + thread->next->prev = thread->prev; + thread->prev->next = thread->next; + thread->next = NULL; + thread->prev = NULL; + MUTEX_UNLOCK(&create_destruct_mutex); + + /* Thread is now disowned */ + S_ithread_clear(aTHX_ thread); + +#ifdef WIN32 + handle = thread->handle; + thread->handle = NULL; #endif + MUTEX_UNLOCK(&thread->mutex); + MUTEX_DESTROY(&thread->mutex); - SHAREDSvLOCK(threads); - SHAREDSvEDIT(threads); - PERL_THREAD_ALLOC_SPECIFIC(self_key); - PERL_THREAD_SETSPECIFIC(self_key,INT2PTR(void*,thread->tid)); - thread_tid_ptr = Perl_newSVuv(PL_sharedsv_space, thread->tid); - thread_ptr = Perl_newSVuv(PL_sharedsv_space, PTR2UV(thread)); - hv_store_ent((HV*)SHAREDSvGET(threads), thread_tid_ptr, thread_ptr,0); - SvREFCNT_dec(thread_tid_ptr); - SHAREDSvRELEASE(threads); - SHAREDSvUNLOCK(threads); - PL_perl_destruct_level = 2; - - { - - AV* params; - I32 len; - int i; - dSP; - params = (AV*) SvRV(thread->params); - len = av_len(params); - ENTER; - SAVETMPS; - PUSHMARK(SP); - if(len > -1) { - for(i = 0; i < len + 1; i++) { - XPUSHs(av_shift(params)); - } - } - PUTBACK; - call_sv(thread->init_function, G_DISCARD); - FREETMPS; - LEAVE; - - - } - - MUTEX_LOCK(&thread->mutex); - PerlIO_flush((PerlIO*)NULL); - perl_destruct(thread->interp); - perl_free(thread->interp); - if(thread->detached == 1) { - MUTEX_UNLOCK(&thread->mutex); - Perl_thread_destruct(thread); - } else { - MUTEX_UNLOCK(&thread->mutex); - } #ifdef WIN32 - return (DWORD)0; + if (handle) + CloseHandle(handle); +#endif + + /* Call PerlMemShared_free() in the context of the "first" interpreter + * per http://www.nntp.perl.org/group/perl.perl5.porters/110772 + */ + aTHX = PL_curinterp; + PerlMemShared_free(thread); +} + + +/* Called on exit */ +int +Perl_ithread_hook(pTHX) +{ + int veto_cleanup = 0; + MUTEX_LOCK(&create_destruct_mutex); + if ((aTHX == PL_curinterp) && + (running_threads || joinable_threads)) + { + if (ckWARN_d(WARN_THREADS)) { + Perl_warn(aTHX_ "Perl exited with active threads:\n\t%" + IVdf " running and unjoined\n\t%" + IVdf " finished and unjoined\n\t%" + IVdf " running and detached\n", + running_threads, + joinable_threads, + detached_threads); + } + veto_cleanup = 1; + } + MUTEX_UNLOCK(&create_destruct_mutex); + return (veto_cleanup); +} + + +/* MAGIC (in mg.h sense) hooks */ + +int +ithread_mg_get(pTHX_ SV *sv, MAGIC *mg) +{ + ithread *thread = (ithread *)mg->mg_ptr; + SvIV_set(sv, PTR2IV(thread)); + SvIOK_on(sv); + return (0); +} + +int +ithread_mg_free(pTHX_ SV *sv, MAGIC *mg) +{ + ithread *thread = (ithread *)mg->mg_ptr; + int cleanup; + + MUTEX_LOCK(&thread->mutex); + cleanup = ((--thread->count == 0) && + (thread->state & PERL_ITHR_FINISHED) && + (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED))); + MUTEX_UNLOCK(&thread->mutex); + + if (cleanup) + S_ithread_destruct(aTHX_ thread); + return (0); +} + +int +ithread_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param) +{ + ithread *thread = (ithread *)mg->mg_ptr; + MUTEX_LOCK(&thread->mutex); + thread->count++; + MUTEX_UNLOCK(&thread->mutex); + return (0); +} + +MGVTBL ithread_vtbl = { + ithread_mg_get, /* get */ + 0, /* set */ + 0, /* len */ + 0, /* clear */ + ithread_mg_free, /* free */ + 0, /* copy */ + ithread_mg_dup /* dup */ +}; + + +/* Provided default, minimum and rational stack sizes */ +static IV +good_stack_size(pTHX_ IV stack_size) +{ + /* Use default stack size if no stack size specified */ + if (! stack_size) + return (default_stack_size); + +#ifdef PTHREAD_STACK_MIN + /* Can't use less than minimum */ + if (stack_size < PTHREAD_STACK_MIN) { + if (ckWARN(WARN_THREADS)) { + Perl_warn(aTHX_ "Using minimum thread stack size of %" IVdf, (IV)PTHREAD_STACK_MIN); + } + return (PTHREAD_STACK_MIN); + } +#endif + + /* Round up to page size boundary */ + if (page_size <= 0) { +#if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE)) + SETERRNO(0, SS_NORMAL); +# ifdef _SC_PAGESIZE + page_size = sysconf(_SC_PAGESIZE); +# else + page_size = sysconf(_SC_MMAP_PAGE_SIZE); +# endif + if ((long)page_size < 0) { + if (errno) { + SV * const error = get_sv("@", FALSE); + (void)SvUPGRADE(error, SVt_PV); + Perl_croak(aTHX_ "PANIC: sysconf: %s", SvPV_nolen(error)); + } else { + Perl_croak(aTHX_ "PANIC: sysconf: pagesize unknown"); + } + } #else - return 0; +# ifdef HAS_GETPAGESIZE + page_size = getpagesize(); +# else +# if defined(I_SYS_PARAM) && defined(PAGESIZE) + page_size = PAGESIZE; +# else + page_size = 8192; /* A conservative default */ +# endif +# endif + if (page_size <= 0) + Perl_croak(aTHX_ "PANIC: bad pagesize %" IVdf, (IV)page_size); #endif + } + stack_size = ((stack_size + (page_size - 1)) / page_size) * page_size; + return (stack_size); } -/* - * iThread->create(); + +/* Starts executing the thread. + * Passed as the C level function to run in the new thread. */ +#ifdef WIN32 +static THREAD_RET_TYPE +S_ithread_run(LPVOID arg) +#else +static void * +S_ithread_run(void * arg) +#endif +{ + ithread *thread = (ithread *)arg; + int cleanup; + + dTHXa(thread->interp); + PERL_SET_CONTEXT(thread->interp); + S_ithread_set(aTHX_ thread); + +#if 0 + /* Far from clear messing with ->thr child-side is a good idea */ + MUTEX_LOCK(&thread->mutex); +#ifdef WIN32 + thread->thr = GetCurrentThreadId(); +#else + thread->thr = pthread_self(); +#endif + MUTEX_UNLOCK(&thread->mutex); +#endif + + PL_perl_destruct_level = 2; + + { + AV *params = (AV *)SvRV(thread->params); + int len = (int)av_len(params)+1; + int ii; + int jmp_rc = 0; + I32 oldscope; + + dJMPENV; + + dSP; + ENTER; + SAVETMPS; + + /* Put args on the stack */ + PUSHMARK(SP); + for (ii=0; ii < len; ii++) { + XPUSHs(av_shift(params)); + } + PUTBACK; + + oldscope = PL_scopestack_ix; + JMPENV_PUSH(jmp_rc); + if (jmp_rc == 0) { + /* Run the specified function */ + len = (int)call_sv(thread->init_function, thread->gimme|G_EVAL); + } else if (jmp_rc == 2) { + while (PL_scopestack_ix > oldscope) { + LEAVE; + } + } + JMPENV_POP; + + /* Remove args from stack and put back in params array */ + SPAGAIN; + for (ii=len-1; ii >= 0; ii--) { + SV *sv = POPs; + if (jmp_rc == 0) { + av_store(params, ii, SvREFCNT_inc(sv)); + } + } + + FREETMPS; + LEAVE; + + /* Check for failure */ + if (SvTRUE(ERRSV) && ckWARN_d(WARN_THREADS)) { + oldscope = PL_scopestack_ix; + JMPENV_PUSH(jmp_rc); + if (jmp_rc == 0) { + Perl_warn(aTHX_ "Thread %" UVuf " terminated abnormally: %" SVf, thread->tid, ERRSV); + } else if (jmp_rc == 2) { + while (PL_scopestack_ix > oldscope) { + LEAVE; + } + } + JMPENV_POP; + } -SV* Perl_thread_create(char* class, SV* init_function, SV* params) { - ithread* thread = malloc(sizeof(ithread)); - SV* obj_ref; - SV* obj; - SV* temp_store; - PerlInterpreter *current_perl; - - MUTEX_LOCK(&create_mutex); - obj_ref = newSViv(0); - obj = newSVrv(obj_ref, class); - sv_setiv(obj, (IV)thread); - SvREADONLY_on(obj); - PerlIO_flush((PerlIO*)NULL); - current_perl = PERL_GET_CONTEXT; - - /* - * here we put the values of params and function to call onto - * namespace, this is so perl will properly clone them when we - * call perl_clone. - */ - - temp_store = Perl_get_sv(current_perl, "threads::paramtempstore", - TRUE | GV_ADDMULTI); - Perl_sv_setsv_flags(current_perl, temp_store,params, SV_GMAGIC); - params = NULL; - temp_store = NULL; - - temp_store = Perl_get_sv(current_perl, "threads::calltempstore", - TRUE | GV_ADDMULTI); - Perl_sv_setsv_flags(current_perl,temp_store, init_function, SV_GMAGIC); - init_function = NULL; - temp_store = NULL; + /* Release function ref */ + SvREFCNT_dec(thread->init_function); + thread->init_function = Nullsv; + } + + PerlIO_flush((PerlIO *)NULL); + + MUTEX_LOCK(&thread->mutex); + /* Mark as finished */ + thread->state |= PERL_ITHR_FINISHED; + /* Cleanup if detached */ + cleanup = (thread->state & PERL_ITHR_DETACHED); + MUTEX_UNLOCK(&thread->mutex); + + if (cleanup) { + MUTEX_LOCK(&create_destruct_mutex); + detached_threads--; + MUTEX_UNLOCK(&create_destruct_mutex); + S_ithread_destruct(aTHX_ thread); + } else { + MUTEX_LOCK(&create_destruct_mutex); + running_threads--; + joinable_threads++; + MUTEX_UNLOCK(&create_destruct_mutex); + } #ifdef WIN32 - thread->interp = perl_clone(current_perl, 4); + return ((DWORD)0); #else - thread->interp = perl_clone(current_perl, 0); + return (0); #endif +} + + +/* Type conversion helper functions */ +static SV * +ithread_to_SV(pTHX_ SV *obj, ithread *thread, char *classname, bool inc) +{ + SV *sv; + MAGIC *mg; + + if (inc) { + MUTEX_LOCK(&thread->mutex); + thread->count++; + MUTEX_UNLOCK(&thread->mutex); + } + + if (! obj) { + obj = newSV(0); + } + + sv = newSVrv(obj, classname); + sv_setiv(sv, PTR2IV(thread)); + mg = sv_magicext(sv, Nullsv, PERL_MAGIC_shared_scalar, &ithread_vtbl, (char *)thread, 0); + mg->mg_flags |= MGf_DUP; + SvREADONLY_on(sv); + + return (obj); +} + +static ithread * +SV_to_ithread(pTHX_ SV *sv) +{ + /* Argument is a thread */ + if (SvROK(sv)) { + return (INT2PTR(ithread *, SvIV(SvRV(sv)))); + } + /* Argument is classname, therefore return current thread */ + return (S_ithread_get(aTHX)); +} + - thread->init_function = newSVsv(Perl_get_sv(thread->interp, - "threads::calltempstore",FALSE)); - thread->params = newSVsv(Perl_get_sv(thread->interp, - "threads::paramtempstore",FALSE)); +/* threads->create() + * Called in context of parent thread. + */ +static SV * +S_ithread_create( + pTHX_ SV *obj, + char *classname, + SV *init_function, + IV stack_size, + int gimme, + SV *params) +{ + ithread *thread; + CLONE_PARAMS clone_param; + ithread *current_thread = S_ithread_get(aTHX); - /* - * And here we make sure we clean up the data we put in the - * namespace of iThread, both in the new and the calling - * inteprreter */ + SV **tmps_tmp = PL_tmps_stack; + IV tmps_ix = PL_tmps_ix; +#ifndef WIN32 + int rc_stack_size = 0; + int rc_thread_create = 0; +#endif - temp_store = Perl_get_sv(thread->interp, "threads::paramtempstore",FALSE); - Perl_sv_setsv_flags(thread->interp,temp_store, &PL_sv_undef, SV_GMAGIC); + MUTEX_LOCK(&create_destruct_mutex); - temp_store = Perl_get_sv(thread->interp,"threads::calltempstore",FALSE); - Perl_sv_setsv_flags(thread->interp,temp_store, &PL_sv_undef, SV_GMAGIC); + /* Allocate thread structure */ + thread = (ithread *)PerlMemShared_malloc(sizeof(ithread)); + if (!thread) { + MUTEX_UNLOCK(&create_destruct_mutex); + PerlLIO_write(PerlIO_fileno(Perl_error_log), PL_no_mem, strlen(PL_no_mem)); + my_exit(1); + } + Zero(thread, 1, ithread); - PERL_SET_CONTEXT(current_perl); + /* Add to threads list */ + thread->next = threads; + thread->prev = threads->prev; + threads->prev = thread; + thread->prev->next = thread; - temp_store = Perl_get_sv(current_perl,"threads::paramtempstore",FALSE); - Perl_sv_setsv_flags(current_perl, temp_store, &PL_sv_undef, SV_GMAGIC); + /* Set count to 1 immediately in case thread exits before + * we return to caller! + */ + thread->count = 1; - temp_store = Perl_get_sv(current_perl,"threads::calltempstore",FALSE); - Perl_sv_setsv_flags(current_perl, temp_store, &PL_sv_undef, SV_GMAGIC); + MUTEX_INIT(&thread->mutex); + thread->tid = tid_counter++; + thread->stack_size = good_stack_size(aTHX_ stack_size); + thread->gimme = gimme; - /* let's init the thread */ + /* "Clone" our interpreter into the thread's interpreter. + * This gives thread access to "static data" and code. + */ + PerlIO_flush((PerlIO *)NULL); + S_ithread_set(aTHX_ thread); - MUTEX_INIT(&thread->mutex); - thread->tid = tid_counter++; - thread->detached = 0; - thread->count = 1; + SAVEBOOL(PL_srand_called); /* Save this so it becomes the correct value */ + PL_srand_called = FALSE; /* Set it to false so we can detect if it gets + set during the clone */ #ifdef WIN32 + thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE | CLONEf_CLONE_HOST); +#else + thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE); +#endif + + /* perl_clone() leaves us in new interpreter's context. As it is tricky + * to spot an implicit aTHX, create a new scope with aTHX matching the + * context for the duration of our work for new interpreter. + */ + { + dTHXa(thread->interp); + + MY_CXT_CLONE; - thread->handle = CreateThread(NULL, 0, Perl_thread_run, - (LPVOID)thread, 0, &thread->thr); + /* Here we remove END blocks since they should only run in the thread + * they are created + */ + SvREFCNT_dec(PL_endav); + PL_endav = newAV(); + if (SvPOK(init_function)) { + thread->init_function = newSV(0); + sv_copypv(thread->init_function, init_function); + } else { + clone_param.flags = 0; + thread->init_function = sv_dup(init_function, &clone_param); + if (SvREFCNT(thread->init_function) == 0) { + SvREFCNT_inc(thread->init_function); + } + } + + thread->params = sv_dup(params, &clone_param); + SvREFCNT_inc(thread->params); + + /* The code below checks that anything living on the tmps stack and + * has been cloned (so it lives in the ptr_table) has a refcount + * higher than 0. + * + * If the refcount is 0 it means that a something on the stack/context + * was holding a reference to it and since we init_stacks() in + * perl_clone that won't get cleaned and we will get a leaked scalar. + * The reason it was cloned was that it lived on the @_ stack. + * + * Example of this can be found in bugreport 15837 where calls in the + * parameter list end up as a temp. + * + * One could argue that this fix should be in perl_clone. + */ + while (tmps_ix > 0) { + SV* sv = (SV*)ptr_table_fetch(PL_ptr_table, tmps_tmp[tmps_ix]); + tmps_ix--; + if (sv && SvREFCNT(sv) == 0) { + SvREFCNT_inc(sv); + SvREFCNT_dec(sv); + } + } + SvTEMP_off(thread->init_function); + ptr_table_free(PL_ptr_table); + PL_ptr_table = NULL; + PL_exit_flags |= PERL_EXIT_DESTRUCT_END; + } + S_ithread_set(aTHX_ current_thread); + PERL_SET_CONTEXT(aTHX); + + /* Create/start the thread */ +#ifdef WIN32 + thread->handle = CreateThread(NULL, + (DWORD)thread->stack_size, + S_ithread_run, + (LPVOID)thread, + STACK_SIZE_PARAM_IS_A_RESERVATION, + &thread->thr); #else - { - static pthread_attr_t attr; - static int attr_inited = 0; - sigset_t fullmask, oldmask; - static int attr_joinable = PTHREAD_CREATE_JOINABLE; - if (!attr_inited) { - attr_inited = 1; - pthread_attr_init(&attr); - } + { + static pthread_attr_t attr; + static int attr_inited = 0; + static int attr_joinable = PTHREAD_CREATE_JOINABLE; + if (! attr_inited) { + pthread_attr_init(&attr); + attr_inited = 1; + } + # ifdef PTHREAD_ATTR_SETDETACHSTATE - PTHREAD_ATTR_SETDETACHSTATE(&attr, attr_joinable); + /* Threads start out joinable */ + PTHREAD_ATTR_SETDETACHSTATE(&attr, attr_joinable); # endif -# ifdef THREAD_CREATE_NEEDS_STACK - if(pthread_attr_setstacksize(&attr, THREAD_CREATE_NEEDS_STACK)) - croak("panic: pthread_attr_setstacksize failed"); + +# ifdef _POSIX_THREAD_ATTR_STACKSIZE + /* Set thread's stack size */ + if (thread->stack_size > 0) { + rc_stack_size = pthread_attr_setstacksize(&attr, (size_t)thread->stack_size); + } +# endif + + /* Create the thread */ + if (! rc_stack_size) { +# ifdef OLD_PTHREADS_API + rc_thread_create = pthread_create(&thread->thr, + attr, + S_ithread_run, + (void *)thread); +# else +# if defined(HAS_PTHREAD_ATTR_SETSCOPE) && defined(PTHREAD_SCOPE_SYSTEM) + pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM); +# endif + rc_thread_create = pthread_create(&thread->thr, + &attr, + S_ithread_run, + (void *)thread); # endif + } -#ifdef OLD_PTHREADS_API - pthread_create( &thread->thr, attr, Perl_thread_run, (void *)thread); +# ifdef _POSIX_THREAD_ATTR_STACKSIZE + /* Try to get thread's actual stack size */ + { + size_t stacksize; +#ifdef HPUX1020 + stacksize = pthread_attr_getstacksize(attr); #else - pthread_create( &thread->thr, &attr, Perl_thread_run, (void *)thread); + if (! pthread_attr_getstacksize(&attr, &stacksize)) #endif - } + if (stacksize > 0) { + thread->stack_size = (IV)stacksize; + } + } +# endif + } #endif - MUTEX_UNLOCK(&create_mutex); - return obj_ref; -} + /* Check for errors */ +#ifdef WIN32 + if (thread->handle == NULL) { +#else + if (rc_stack_size || rc_thread_create) { +#endif + MUTEX_UNLOCK(&create_destruct_mutex); + sv_2mortal(params); + S_ithread_destruct(aTHX_ thread); +#ifndef WIN32 + if (ckWARN_d(WARN_THREADS)) { + if (rc_stack_size) + Perl_warn(aTHX_ "Thread creation failed: pthread_attr_setstacksize(%" IVdf ") returned %d", thread->stack_size, rc_stack_size); + else + Perl_warn(aTHX_ "Thread creation failed: pthread_create returned %d", rc_thread_create); + } +#endif + return (&PL_sv_undef); + } -/* - * returns the id of the thread - */ -I32 Perl_thread_tid (SV* obj) { - ithread* thread; - if(!SvROK(obj)) { - obj = Perl_thread_self(SvPV_nolen(obj)); - thread = (ithread*)SvIV(SvRV(obj)); - SvREFCNT_dec(obj); - } else { - thread = (ithread*)SvIV(SvRV(obj)); - } - return thread->tid; -} + running_threads++; + MUTEX_UNLOCK(&create_destruct_mutex); + + sv_2mortal(params); -SV* Perl_thread_self (char* class) { - dTHX; - SV* obj_ref; - SV* obj; - SV* thread_tid_ptr; - SV* thread_ptr; - HE* thread_entry; - void* id; - PERL_THREAD_GETSPECIFIC(self_key,id); - SHAREDSvLOCK(threads); - SHAREDSvEDIT(threads); - - thread_tid_ptr = Perl_newSVuv(PL_sharedsv_space, PTR2UV(id)); - - thread_entry = Perl_hv_fetch_ent(PL_sharedsv_space, - (HV*) SHAREDSvGET(threads), - thread_tid_ptr, 0,0); - thread_ptr = HeVAL(thread_entry); - SvREFCNT_dec(thread_tid_ptr); - SHAREDSvRELEASE(threads); - SHAREDSvUNLOCK(threads); - - obj_ref = newSViv(0); - obj = newSVrv(obj_ref, class); - sv_setsv(obj, thread_ptr); - SvREADONLY_on(obj); - return obj_ref; + return (ithread_to_SV(aTHX_ obj, thread, classname, FALSE)); } -/* - * joins the thread this code needs to take the returnvalue from the - * call_sv and send it back */ +#endif /* USE_ITHREADS */ + + +MODULE = threads PACKAGE = threads PREFIX = ithread_ +PROTOTYPES: DISABLE + +#ifdef USE_ITHREADS + +void +ithread_create(...) + PREINIT: + char *classname; + ithread *thread; + SV *function_to_call; + AV *params; + HV *specs; + IV stack_size; + int context; + char *str; + int idx; + int ii; + CODE: + if ((items >= 2) && SvROK(ST(1)) && SvTYPE(SvRV(ST(1)))==SVt_PVHV) { + if (--items < 2) + Perl_croak(aTHX_ "Usage: threads->create(\\%specs, function, ...)"); + specs = (HV*)SvRV(ST(1)); + idx = 1; + } else { + if (items < 2) + Perl_croak(aTHX_ "Usage: threads->create(function, ...)"); + specs = NULL; + idx = 0; + } + + if (sv_isobject(ST(0))) { + /* $thr->create() */ + classname = HvNAME(SvSTASH(SvRV(ST(0)))); + thread = INT2PTR(ithread *, SvIV(SvRV(ST(0)))); + stack_size = thread->stack_size; + } else { + /* threads->create() */ + classname = (char *)SvPV_nolen(ST(0)); + stack_size = default_stack_size; + } + + function_to_call = ST(idx+1); + + context = -1; + if (specs) { + /* stack_size */ + if (hv_exists(specs, "stack", 5)) { + stack_size = SvIV(*hv_fetch(specs, "stack", 5, 0)); + } else if (hv_exists(specs, "stacksize", 9)) { + stack_size = SvIV(*hv_fetch(specs, "stacksize", 9, 0)); + } else if (hv_exists(specs, "stack_size", 10)) { + stack_size = SvIV(*hv_fetch(specs, "stack_size", 10, 0)); + } + + /* context */ + if (hv_exists(specs, "context", 7)) { + str = (char *)SvPV_nolen(*hv_fetch(specs, "context", 7, 0)); + switch (*str) { + case 'a': + case 'A': + context = G_ARRAY; + break; + case 's': + case 'S': + context = G_SCALAR; + break; + case 'v': + case 'V': + context = G_VOID; + break; + default: + Perl_croak(aTHX_ "Invalid context: %s", str); + } + } else if (hv_exists(specs, "array", 5)) { + if (SvTRUE(*hv_fetch(specs, "array", 5, 0))) { + context = G_ARRAY; + } + } else if (hv_exists(specs, "scalar", 6)) { + if (SvTRUE(*hv_fetch(specs, "scalar", 6, 0))) { + context = G_SCALAR; + } + } else if (hv_exists(specs, "void", 4)) { + if (SvTRUE(*hv_fetch(specs, "void", 4, 0))) { + context = G_VOID; + } + } + } + if (context == -1) { + context = GIMME_V; /* Implicit context */ + } else { + context |= (GIMME_V & (~(G_ARRAY|G_SCALAR|G_VOID))); + } + + /* Function args */ + params = newAV(); + if (items > 2) { + for (ii=2; ii < items ; ii++) { + av_push(params, SvREFCNT_inc(ST(idx+ii))); + } + } + + /* Create thread */ + ST(0) = sv_2mortal(S_ithread_create(aTHX_ Nullsv, + classname, + function_to_call, + stack_size, + context, + newRV_noinc((SV*)params))); + /* XSRETURN(1); - implied */ + + +void +ithread_list(...) + PREINIT: + char *classname; + ithread *thread; + int list_context; + IV count = 0; + PPCODE: + /* Class method only */ + if (SvROK(ST(0))) + Perl_croak(aTHX_ "Usage: threads->list()"); + classname = (char *)SvPV_nolen(ST(0)); + + /* Calling context */ + list_context = (GIMME_V == G_ARRAY); + + /* Walk through threads list */ + MUTEX_LOCK(&create_destruct_mutex); + for (thread = threads->next; + thread != threads; + thread = thread->next) + { + /* Ignore detached or joined threads */ + if (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)) { + continue; + } + /* Push object on stack if list context */ + if (list_context) { + XPUSHs(sv_2mortal(ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE))); + } + count++; + } + MUTEX_UNLOCK(&create_destruct_mutex); + /* If scalar context, send back count */ + if (! list_context) { + XSRETURN_IV(count); + } + + +void +ithread_self(...) + PREINIT: + char *classname; + ithread *thread; + CODE: + /* Class method only */ + if (SvROK(ST(0))) + Perl_croak(aTHX_ "Usage: threads->self()"); + classname = (char *)SvPV_nolen(ST(0)); + + thread = S_ithread_get(aTHX); + + ST(0) = sv_2mortal(ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE)); + /* XSRETURN(1); - implied */ + + +void +ithread_tid(...) + PREINIT: + ithread *thread; + CODE: + thread = SV_to_ithread(aTHX_ ST(0)); + XST_mUV(0, thread->tid); + /* XSRETURN(1); - implied */ + -void Perl_thread_join(SV* obj) { - ithread* thread = (ithread*)SvIV(SvRV(obj)); +void +ithread_join(...) + PREINIT: + ithread *thread; + int join_err; + AV *params; + int len; + int ii; #ifdef WIN32 - DWORD waitcode; - waitcode = WaitForSingleObject(thread->handle, INFINITE); + DWORD waitcode; #else - void *retval; - pthread_join(thread->thr,&retval); + void *retval; #endif -} + PPCODE: + /* Object method only */ + if (! sv_isobject(ST(0))) + Perl_croak(aTHX_ "Usage: $thr->join()"); -/* detaches a thread - * needs to better clean up memory */ + /* Check if the thread is joinable */ + thread = SV_to_ithread(aTHX_ ST(0)); + MUTEX_LOCK(&thread->mutex); + join_err = (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)); + MUTEX_UNLOCK(&thread->mutex); + if (join_err) { + if (join_err & PERL_ITHR_DETACHED) { + Perl_croak(aTHX_ "Cannot join a detached thread"); + } else { + Perl_croak(aTHX_ "Thread already joined"); + } + } -void Perl_thread_detach(SV* obj) { - ithread* thread = (ithread*)SvIV(SvRV(obj)); - MUTEX_LOCK(&thread->mutex); - thread->detached = 1; - PERL_THREAD_DETACH(thread->thr); - MUTEX_UNLOCK(&thread->mutex); -} + /* Join the thread */ +#ifdef WIN32 + waitcode = WaitForSingleObject(thread->handle, INFINITE); +#else + pthread_join(thread->thr, &retval); +#endif -void Perl_thread_DESTROY (SV* obj) { - ithread* thread = (ithread*)SvIV(SvRV(obj)); - - MUTEX_LOCK(&thread->mutex); - thread->count--; - MUTEX_UNLOCK(&thread->mutex); - Perl_thread_destruct(thread); -} + MUTEX_LOCK(&thread->mutex); + /* Mark as joined */ + thread->state |= PERL_ITHR_JOINED; -void Perl_thread_destruct (ithread* thread) { - return; - MUTEX_LOCK(&thread->mutex); - if(thread->count != 0) { - MUTEX_UNLOCK(&thread->mutex); - return; - } - MUTEX_UNLOCK(&thread->mutex); - /* it is safe noone is holding a ref to this */ - /*printf("proper destruction!\n");*/ -} + /* Get the return value from the call_sv */ + { + AV *params_copy; + PerlInterpreter *other_perl; + CLONE_PARAMS clone_params; + ithread *current_thread; -MODULE = threads PACKAGE = threads -BOOT: - Perl_sharedsv_init(aTHX); - PL_perl_destruct_level = 2; - threads = Perl_sharedsv_new(aTHX); - SHAREDSvEDIT(threads); - SHAREDSvGET(threads) = (SV *)newHV(); - SHAREDSvRELEASE(threads); - { - - - SV* temp = get_sv("threads::sharedsv_space", TRUE | GV_ADDMULTI); - SV* temp2 = newSViv((IV)PL_sharedsv_space ); - sv_setsv( temp , temp2 ); - } - { - ithread* thread = malloc(sizeof(ithread)); - SV* thread_tid_ptr; - SV* thread_ptr; - MUTEX_INIT(&thread->mutex); - thread->tid = 0; + params_copy = (AV *)SvRV(thread->params); + other_perl = thread->interp; + clone_params.stashes = newAV(); + clone_params.flags = CLONEf_JOIN_IN; + PL_ptr_table = ptr_table_new(); + current_thread = S_ithread_get(aTHX); + S_ithread_set(aTHX_ thread); + /* Ensure 'meaningful' addresses retain their meaning */ + ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef); + ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no); + ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes); + params = (AV *)sv_dup((SV*)params_copy, &clone_params); + S_ithread_set(aTHX_ current_thread); + SvREFCNT_dec(clone_params.stashes); + SvREFCNT_inc(params); + ptr_table_free(PL_ptr_table); + PL_ptr_table = NULL; + } + + /* We are finished with the thread */ + S_ithread_clear(aTHX_ thread); + MUTEX_UNLOCK(&thread->mutex); + + MUTEX_LOCK(&create_destruct_mutex); + joinable_threads--; + MUTEX_UNLOCK(&create_destruct_mutex); + + /* If no return values, then just return */ + if (! params) { + XSRETURN_UNDEF; + } + + /* Put return values on stack */ + len = (int)AvFILL(params); + for (ii=0; ii <= len; ii++) { + SV* param = av_shift(params); + XPUSHs(sv_2mortal(param)); + } + + /* Free return value array */ + SvREFCNT_dec(params); + + +void +ithread_yield(...) + CODE: + YIELD; + + +void +ithread_detach(...) + PREINIT: + ithread *thread; + int detach_err; + int cleanup; + CODE: + thread = SV_to_ithread(aTHX_ ST(0)); + MUTEX_LOCK(&thread->mutex); + + /* Check if the thread is detachable */ + if ((detach_err = (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)))) { + MUTEX_UNLOCK(&thread->mutex); + if (detach_err & PERL_ITHR_DETACHED) { + Perl_croak(aTHX_ "Thread already detached"); + } else { + Perl_croak(aTHX_ "Cannot detach a joined thread"); + } + } + + /* Detach the thread */ + thread->state |= PERL_ITHR_DETACHED; #ifdef WIN32 - thread->thr = GetCurrentThreadId(); + /* Windows has no 'detach thread' function */ #else - thread->thr = pthread_self(); + PERL_THREAD_DETACH(thread->thr); #endif - SHAREDSvEDIT(threads); - PERL_THREAD_ALLOC_SPECIFIC(self_key); - PERL_THREAD_SETSPECIFIC(self_key,0); - thread_tid_ptr = Perl_newSVuv(PL_sharedsv_space, 0); - thread_ptr = Perl_newSVuv(PL_sharedsv_space, PTR2UV(thread)); - hv_store_ent((HV*) SHAREDSvGET(threads), thread_tid_ptr, thread_ptr,0); - SvREFCNT_dec(thread_tid_ptr); - SHAREDSvRELEASE(threads); - } - MUTEX_INIT(&create_mutex); + /* Cleanup if finished */ + cleanup = (thread->state & PERL_ITHR_FINISHED); + MUTEX_UNLOCK(&thread->mutex); -PROTOTYPES: DISABLE + MUTEX_LOCK(&create_destruct_mutex); + if (cleanup) { + joinable_threads--; + } else { + running_threads--; + detached_threads++; + } + MUTEX_UNLOCK(&create_destruct_mutex); -SV * -create (class, function_to_call, ...) - char * class - SV * function_to_call - CODE: - AV* params = newAV(); - if(items > 2) { - int i; - for(i = 2; i < items ; i++) { - av_push(params, ST(i)); - } - } - RETVAL = Perl_thread_create(class, function_to_call, newRV_noinc((SV*) params)); - OUTPUT: - RETVAL - -SV * -self (class) - char* class - CODE: - RETVAL = Perl_thread_self(class); - OUTPUT: - RETVAL + if (cleanup) { + S_ithread_destruct(aTHX_ thread); + } -int -tid (obj) - SV * obj; - CODE: - RETVAL = Perl_thread_tid(obj); - OUTPUT: - RETVAL void -join (obj) - SV * obj - PREINIT: - I32* temp; - PPCODE: - temp = PL_markstack_ptr++; - Perl_thread_join(obj); - if (PL_markstack_ptr != temp) { - /* truly void, because dXSARGS not invoked */ - PL_markstack_ptr = temp; - XSRETURN_EMPTY; /* return empty stack */ - } - /* must have used dXSARGS; list context implied */ - return; /* assume stack size is correct */ +ithread_kill(...) + PREINIT: + ithread *thread; + char *sig_name; + IV signal; + CODE: + /* Must have safe signals */ + if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) + Perl_croak(aTHX_ "Cannot signal threads without safe signals"); + + /* Object method only */ + if (! sv_isobject(ST(0))) + Perl_croak(aTHX_ "Usage: $thr->kill('SIG...')"); + + /* Get signal */ + sig_name = SvPV_nolen(ST(1)); + if (isALPHA(*sig_name)) { + if (*sig_name == 'S' && sig_name[1] == 'I' && sig_name[2] == 'G') + sig_name += 3; + if ((signal = whichsig(sig_name)) < 0) + Perl_croak(aTHX_ "Unrecognized signal name: %s", sig_name); + } else + signal = SvIV(ST(1)); + + /* Set the signal for the thread */ + thread = SV_to_ithread(aTHX_ ST(0)); + MUTEX_LOCK(&thread->mutex); + { + dTHXa(thread->interp); + PL_psig_pend[signal]++; + PL_sig_pending = 1; + } + MUTEX_UNLOCK(&thread->mutex); + + /* Return the thread to allow for method chaining */ + ST(0) = ST(0); + /* XSRETURN(1); - implied */ + + +void +ithread_DESTROY(...) + CODE: + sv_unmagic(SvRV(ST(0)), PERL_MAGIC_shared_scalar); + void -detach (obj) - SV * obj - PREINIT: - I32* temp; - PPCODE: - temp = PL_markstack_ptr++; - Perl_thread_detach(obj); - if (PL_markstack_ptr != temp) { - /* truly void, because dXSARGS not invoked */ - PL_markstack_ptr = temp; - XSRETURN_EMPTY; /* return empty stack */ - } - /* must have used dXSARGS; list context implied */ - return; /* assume stack size is correct */ +ithread_equal(...) + PREINIT: + int are_equal = 0; + CODE: + /* Compares TIDs to determine thread equality */ + if (sv_isobject(ST(0)) && sv_isobject(ST(1))) { + ithread *thr1 = INT2PTR(ithread *, SvIV(SvRV(ST(0)))); + ithread *thr2 = INT2PTR(ithread *, SvIV(SvRV(ST(1)))); + are_equal = (thr1->tid == thr2->tid); + } + if (are_equal) { + XST_mYES(0); + } else { + /* Return 0 on false for backward compatibility */ + XST_mIV(0, 0); + } + /* XSRETURN(1); - implied */ + void -DESTROY (obj) - SV * obj - PREINIT: - I32* temp; - PPCODE: - temp = PL_markstack_ptr++; - Perl_thread_DESTROY(obj); - if (PL_markstack_ptr != temp) { - /* truly void, because dXSARGS not invoked */ - PL_markstack_ptr = temp; - XSRETURN_EMPTY; /* return empty stack */ - } - /* must have used dXSARGS; list context implied */ - return; /* assume stack size is correct */ +ithread_object(...) + PREINIT: + char *classname; + UV tid; + ithread *thread; + int found = 0; + CODE: + /* Class method only */ + if (SvROK(ST(0))) + Perl_croak(aTHX_ "Usage: threads->object($tid)"); + classname = (char *)SvPV_nolen(ST(0)); + if ((items < 2) || ! SvOK(ST(1))) { + XSRETURN_UNDEF; + } + + /* threads->object($tid) */ + tid = SvUV(ST(1)); + + /* Walk through threads list */ + MUTEX_LOCK(&create_destruct_mutex); + for (thread = threads->next; + thread != threads; + thread = thread->next) + { + /* Look for TID, but ignore detached or joined threads */ + if ((thread->tid != tid) || + (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED))) + { + continue; + } + /* Put object on stack */ + ST(0) = sv_2mortal(ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE)); + found = 1; + break; + } + MUTEX_UNLOCK(&create_destruct_mutex); + if (! found) { + XSRETURN_UNDEF; + } + /* XSRETURN(1); - implied */ + + +void +ithread__handle(...); + PREINIT: + ithread *thread; + CODE: + thread = SV_to_ithread(aTHX_ ST(0)); +#ifdef WIN32 + XST_mUV(0, PTR2UV(&thread->handle)); +#else + XST_mUV(0, PTR2UV(&thread->thr)); +#endif + /* XSRETURN(1); - implied */ + + +void +ithread_get_stack_size(...) + PREINIT: + IV stack_size; + CODE: + if (sv_isobject(ST(0))) { + /* $thr->get_stack_size() */ + ithread *thread = INT2PTR(ithread *, SvIV(SvRV(ST(0)))); + stack_size = thread->stack_size; + } else { + /* threads->get_stack_size() */ + stack_size = default_stack_size; + } + XST_mIV(0, stack_size); + /* XSRETURN(1); - implied */ + + +void +ithread_set_stack_size(...) + PREINIT: + IV old_size; + CODE: + if (items != 2) + Perl_croak(aTHX_ "Usage: threads->set_stack_size($size)"); + if (sv_isobject(ST(0))) + Perl_croak(aTHX_ "Cannot change stack size of an existing thread"); + + old_size = default_stack_size; + default_stack_size = good_stack_size(aTHX_ SvIV(ST(1))); + XST_mIV(0, old_size); + /* XSRETURN(1); - implied */ + +#endif /* USE_ITHREADS */ + + +BOOT: +{ +#ifdef USE_ITHREADS + /* The 'main' thread is thread 0. + * It is detached (unjoinable) and immortal. + */ + + ithread *thread; + MY_CXT_INIT; + + PL_perl_destruct_level = 2; + MUTEX_INIT(&create_destruct_mutex); + MUTEX_LOCK(&create_destruct_mutex); + + PL_threadhook = &Perl_ithread_hook; + + thread = (ithread *)PerlMemShared_malloc(sizeof(ithread)); + if (! thread) { + PerlLIO_write(PerlIO_fileno(Perl_error_log), PL_no_mem, strlen(PL_no_mem)); + my_exit(1); + } + Zero(thread, 1, ithread); + + MUTEX_INIT(&thread->mutex); + + thread->tid = tid_counter++; /* Thread 0 */ + + /* Head of the threads list */ + threads = thread; + thread->next = thread; + thread->prev = thread; + + thread->count = 1; /* Immortal */ + + thread->interp = aTHX; + thread->state = PERL_ITHR_DETACHED; /* Detached */ + thread->stack_size = default_stack_size; +# ifdef WIN32 + thread->thr = GetCurrentThreadId(); +# else + thread->thr = pthread_self(); +# endif + + S_ithread_set(aTHX_ thread); + MUTEX_UNLOCK(&create_destruct_mutex); +#endif /* USE_ITHREADS */ +}