X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=ext%2Fthreads%2Fthreads.xs;h=40bd2d1436fb85d64634f256c95d54b043ac9976;hb=28f0d0ec424c9050a6c7d38541d2e6b5e66fb97c;hp=bcbd9084155de265b63e48e812feb745134f02ab;hpb=fcea4b7c99fe376a2295931b658ba7f41a47470e;p=p5sagit%2Fp5-mst-13.2.git diff --git a/ext/threads/threads.xs b/ext/threads/threads.xs index bcbd908..40bd2d1 100755 --- a/ext/threads/threads.xs +++ b/ext/threads/threads.xs @@ -2,7 +2,13 @@ #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" @@ -11,53 +17,59 @@ #ifdef USE_ITHREADS - #ifdef WIN32 -#include -#include +# 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 -#ifdef OS2 +# ifdef OS2 typedef perl_os_thread pthread_t; -#else -#include +# 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 -#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 /* OLD_PTHREADS_API */ +#if !defined(HAS_GETPAGESIZE) && defined(I_SYS_PARAM) +# include #endif - - - /* 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_s { - struct ithread_s *next; /* Next thread in the list */ - struct ithread_s *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 */ +#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; /* Are we detached ? */ - int gimme; /* Context of create */ - SV* init_function; /* Code to run */ - SV* params; /* Args to pass function */ + 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 - DWORD thr; /* OS's idea if thread id */ - HANDLE handle; /* OS's waitable handle */ + DWORD thr; /* OS's idea if thread id */ + HANDLE handle; /* OS's waitable handle */ #else - pthread_t thr; /* OS's handle for the thread */ + 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 { @@ -67,129 +79,144 @@ typedef struct { START_MY_CXT +/* Linked list of all threads */ static ithread *threads; -static perl_mutex create_destruct_mutex; /* protects the creation and destruction of threads*/ +/* Protects the creation and destruction of threads*/ +static perl_mutex create_destruct_mutex; static UV tid_counter = 0; -static IV active_threads = 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 +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) +S_ithread_set(pTHX_ ithread *thread) { dMY_CXT; MY_CXT.thread = thread; } -static ithread* -S_ithread_get (pTHX) { +static ithread * +S_ithread_get(pTHX) +{ dMY_CXT; - return MY_CXT.thread; + 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 +/* 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) +S_ithread_clear(pTHX_ ithread *thread) { PerlInterpreter *interp; - assert(thread->state & PERL_ITHR_FINISHED && - (thread->state & PERL_ITHR_DETACHED || - thread->state & PERL_ITHR_JOINED)); + + assert((thread->state & PERL_ITHR_FINISHED) && + (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED))); interp = thread->interp; if (interp) { - dTHXa(interp); - ithread* current_thread; -#ifdef OEMVS - void *ptr; -#endif - PERL_SET_CONTEXT(interp); - current_thread = S_ithread_get(aTHX); - S_ithread_set(aTHX_ thread); - - SvREFCNT_dec(thread->params); - - thread->params = Nullsv; - perl_destruct(interp); - thread->interp = NULL; + 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_free(interp); + PERL_SET_CONTEXT(aTHX); } -/* - * free an ithread structure and any attached data if its count == 0 - */ +/* Free an ithread structure and any attached data if its count == 0 */ static void -S_ithread_destruct (pTHX_ ithread* thread) +S_ithread_destruct(pTHX_ ithread *thread) { #ifdef WIN32 - HANDLE handle; + HANDLE handle; #endif - MUTEX_LOCK(&thread->mutex); + MUTEX_LOCK(&thread->mutex); - /* Thread is still in use */ - if (thread->count != 0) { - MUTEX_UNLOCK(&thread->mutex); - return; - } + /* Thread is still in use */ + if (thread->count != 0) { + MUTEX_UNLOCK(&thread->mutex); + return; + } - MUTEX_LOCK(&create_destruct_mutex); - /* Main thread (0) is immortal and should never get here */ - assert(thread->tid != 0); + /* Main thread (0) is immortal and should never get here */ + assert(thread->tid != 0); - /* Remove from circular list of threads */ - thread->next->prev = thread->prev; - thread->prev->next = thread->next; - thread->next = NULL; - thread->prev = NULL; - MUTEX_UNLOCK(&create_destruct_mutex); + /* 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); + /* Thread is now disowned */ + S_ithread_clear(aTHX_ thread); #ifdef WIN32 - handle = thread->handle; - thread->handle = NULL; + handle = thread->handle; + thread->handle = NULL; #endif - MUTEX_UNLOCK(&thread->mutex); - MUTEX_DESTROY(&thread->mutex); + MUTEX_UNLOCK(&thread->mutex); + MUTEX_DESTROY(&thread->mutex); #ifdef WIN32 - if (handle) - CloseHandle(handle); + 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); + /* 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 && active_threads != 1) { - if (ckWARN_d(WARN_THREADS)) - Perl_warn(aTHX_ "A thread exited while %" IVdf " threads were running", - active_threads); - veto_cleanup = 1; + 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; + return (veto_cleanup); } @@ -198,361 +225,490 @@ Perl_ithread_hook(pTHX) int ithread_mg_get(pTHX_ SV *sv, MAGIC *mg) { - ithread *thread = (ithread *) mg->mg_ptr; + ithread *thread = (ithread *)mg->mg_ptr; SvIV_set(sv, PTR2IV(thread)); SvIOK_on(sv); - return 0; + return (0); } int ithread_mg_free(pTHX_ SV *sv, MAGIC *mg) { - ithread *thread = (ithread *) mg->mg_ptr; + ithread *thread = (ithread *)mg->mg_ptr; + int cleanup; + MUTEX_LOCK(&thread->mutex); - thread->count--; - if (thread->count == 0) { - if(thread->state & PERL_ITHR_FINISHED && - (thread->state & PERL_ITHR_DETACHED || - thread->state & PERL_ITHR_JOINED)) - { - MUTEX_UNLOCK(&thread->mutex); - S_ithread_destruct(aTHX_ thread); - } - else { - MUTEX_UNLOCK(&thread->mutex); - } - } - else { - MUTEX_UNLOCK(&thread->mutex); - } - return 0; + 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; + ithread *thread = (ithread *)mg->mg_ptr; MUTEX_LOCK(&thread->mutex); thread->count++; MUTEX_UNLOCK(&thread->mutex); - return 0; + 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 */ + ithread_mg_get, /* get */ + 0, /* set */ + 0, /* len */ + 0, /* clear */ + ithread_mg_free, /* free */ + 0, /* copy */ + ithread_mg_dup /* dup */ }; -/* - * Starts executing the thread. Needs to clean up memory a tad better. - * Passed as the C level function to run in the new thread - */ +/* 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 +# 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); +} + + +/* 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) { +S_ithread_run(LPVOID arg) #else -static void* -S_ithread_run(void * arg) { +static void * +S_ithread_run(void * arg) #endif - ithread* thread = (ithread*) arg; - dTHXa(thread->interp); - PERL_SET_CONTEXT(thread->interp); - S_ithread_set(aTHX_ thread); +{ + 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); + /* Far from clear messing with ->thr child-side is a good idea */ + MUTEX_LOCK(&thread->mutex); #ifdef WIN32 - thread->thr = GetCurrentThreadId(); + thread->thr = GetCurrentThreadId(); #else - thread->thr = pthread_self(); + thread->thr = pthread_self(); #endif - MUTEX_UNLOCK(&thread->mutex); + 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; - dSP; - ENTER; - SAVETMPS; - PUSHMARK(SP); - for(ii = 0; ii < len; ii++) { - XPUSHs(av_shift(params)); - } - PUTBACK; - len = (int)call_sv(thread->init_function, thread->gimme|G_EVAL); - - SPAGAIN; - for (ii=len-1; ii >= 0; ii--) { - SV *sv = POPs; - av_store(params, ii, SvREFCNT_inc(sv)); - } - if (SvTRUE(ERRSV) && ckWARN_d(WARN_THREADS)) { - Perl_warn(aTHX_ "thread failed to start: %" SVf, ERRSV); - } - FREETMPS; - LEAVE; - SvREFCNT_dec(thread->init_function); - } - - PerlIO_flush((PerlIO*)NULL); - MUTEX_LOCK(&thread->mutex); - thread->state |= PERL_ITHR_FINISHED; - - if (thread->state & PERL_ITHR_DETACHED) { - MUTEX_UNLOCK(&thread->mutex); - S_ithread_destruct(aTHX_ thread); - } else { - MUTEX_UNLOCK(&thread->mutex); - } - MUTEX_LOCK(&create_destruct_mutex); - active_threads--; - MUTEX_UNLOCK(&create_destruct_mutex); + 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; + } + + /* 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 - return (DWORD)0; + return ((DWORD)0); #else - return 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); + MUTEX_LOCK(&thread->mutex); + thread->count++; + MUTEX_UNLOCK(&thread->mutex); + } + + if (! obj) { + obj = newSV(0); } - 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); + + 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; + + return (obj); } static ithread * SV_to_ithread(pTHX_ SV *sv) { - if (SvROK(sv)) - { - return INT2PTR(ithread*, SvIV(SvRV(sv))); - } - else - { - return S_ithread_get(aTHX); - } + /* 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)); } -/* - * ithread->create(); ( aka ithread->new() ) - * Called in context of parent thread - */ +/* threads->create() + * Called in context of parent thread. + */ static SV * -S_ithread_create(pTHX_ SV *obj, char* classname, SV* init_function, SV* params) +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); + ithread *thread; + CLONE_PARAMS clone_param; + ithread *current_thread = S_ithread_get(aTHX); - SV** tmps_tmp = PL_tmps_stack; - IV tmps_ix = PL_tmps_ix; + SV **tmps_tmp = PL_tmps_stack; + IV tmps_ix = PL_tmps_ix; #ifndef WIN32 - int rc_stack_size = 0; - int rc_thread_create = 0; + int rc_stack_size = 0; + int rc_thread_create = 0; #endif + MUTEX_LOCK(&create_destruct_mutex); - MUTEX_LOCK(&create_destruct_mutex); - 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); - - /* Add to threads list */ - thread->next = threads; - thread->prev = threads->prev; - threads->prev = thread; - thread->prev->next = thread; - - /* Set count to 1 immediately in case thread exits before - * we return to caller ! - */ - thread->count = 1; - MUTEX_INIT(&thread->mutex); - thread->tid = tid_counter++; - thread->gimme = GIMME_V; - - /* "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); - - 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 */ + /* 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); + + /* Add to threads list */ + thread->next = threads; + thread->prev = threads->prev; + threads->prev = thread; + thread->prev->next = thread; + + /* Set count to 1 immediately in case thread exits before + * we return to caller! + */ + thread->count = 1; + + MUTEX_INIT(&thread->mutex); + thread->tid = tid_counter++; + thread->stack_size = good_stack_size(aTHX_ stack_size); + thread->gimme = gimme; + + /* "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); + + 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); + thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE | CLONEf_CLONE_HOST); #else - thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE); + 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; - - /* Here we remove END blocks since they should only run - in the thread they are created - */ - SvREFCNT_dec(PL_endav); - PL_endav = newAV(); - 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 + /* 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); - 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. + MY_CXT_CLONE; - 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); - } - } - + /* 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); + } + } - 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); + 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); + } + } - /* Start the thread */ + 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, 0, S_ithread_run, - (LPVOID)thread, 0, &thread->thr); + 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; - 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 - rc_stack_size = pthread_attr_setstacksize(&attr, THREAD_CREATE_NEEDS_STACK); + +# 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 - 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 ); + /* 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 - rc_thread_create = pthread_create( &thread->thr, &attr, - S_ithread_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 + if (! pthread_attr_getstacksize(&attr, &stacksize)) #endif - } - } + if (stacksize > 0) { + thread->stack_size = (IV)stacksize; + } + } +# endif + } #endif - /* Check for errors */ + /* Check for errors */ #ifdef WIN32 - if (thread->handle == NULL) { + if (thread->handle == NULL) { #else - if (rc_stack_size || rc_thread_create) { + if (rc_stack_size || rc_thread_create) { #endif - MUTEX_UNLOCK(&create_destruct_mutex); - sv_2mortal(params); - S_ithread_destruct(aTHX_ thread); + MUTEX_UNLOCK(&create_destruct_mutex); + sv_2mortal(params); + S_ithread_destruct(aTHX_ thread); #ifndef WIN32 - if (ckWARN_d(WARN_THREADS)) { -# ifdef THREAD_CREATE_NEEDS_STACK - if (rc_stack_size) - Perl_warn(aTHX_ "Thread creation failed: pthread_attr_setstacksize(%" IVdf ") returned %d", (IV)THREAD_CREATE_NEEDS_STACK, rc_stack_size); - else -# endif - Perl_warn(aTHX_ "Thread creation failed: pthread_create returned %d", rc_thread_create); - } + 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; - } - active_threads++; - MUTEX_UNLOCK(&create_destruct_mutex); - sv_2mortal(params); + return (&PL_sv_undef); + } + + running_threads++; + MUTEX_UNLOCK(&create_destruct_mutex); - return ithread_to_SV(aTHX_ obj, thread, classname, FALSE); + sv_2mortal(params); + + return (ithread_to_SV(aTHX_ obj, thread, classname, FALSE)); } #endif /* USE_ITHREADS */ -MODULE = threads PACKAGE = threads PREFIX = ithread_ +MODULE = threads PACKAGE = threads PREFIX = ithread_ PROTOTYPES: DISABLE #ifdef USE_ITHREADS @@ -561,29 +717,106 @@ 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) - Perl_croak(aTHX_ "Usage: threads->create(function, ...)"); + 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; + } - classname = (char *)SvPV_nolen(ST(0)); - function_to_call = ST(1); + 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(ii))); + 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, - newRV_noinc((SV*)params))); + classname, + function_to_call, + stack_size, + context, + newRV_noinc((SV*)params))); /* XSRETURN(1); - implied */ @@ -591,31 +824,51 @@ void ithread_list(...) PREINIT: char *classname; - ithread *thr; + ithread *thread; int list_context; IV count = 0; + int want_running; PPCODE: /* Class method only */ if (SvROK(ST(0))) - Perl_croak(aTHX_ "Usage: threads->list()"); + Perl_croak(aTHX_ "Usage: threads->list(...)"); classname = (char *)SvPV_nolen(ST(0)); /* Calling context */ list_context = (GIMME_V == G_ARRAY); + /* Running or joinable parameter */ + if (items > 1) { + want_running = SvTRUE(ST(1)); + } + /* Walk through threads list */ MUTEX_LOCK(&create_destruct_mutex); - for (thr = threads->next; - thr != threads; - thr = thr->next) + for (thread = threads->next; + thread != threads; + thread = thread->next) { /* Ignore detached or joined threads */ - if (thr->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)) { + if (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)) { continue; } + + /* Filter per parameter */ + if (items > 1) { + if (want_running) { + if (thread->state & PERL_ITHR_FINISHED) { + continue; /* Not running */ + } + } else { + if (! (thread->state & PERL_ITHR_FINISHED)) { + continue; /* Still running - not joinable yet */ + } + } + } + /* Push object on stack if list context */ if (list_context) { - XPUSHs(sv_2mortal(ithread_to_SV(aTHX_ NULL, thr, classname, TRUE))); + XPUSHs(sv_2mortal(ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE))); } count++; } @@ -725,6 +978,10 @@ ithread_join(...) 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; @@ -778,8 +1035,58 @@ ithread_detach(...) cleanup = (thread->state & PERL_ITHR_FINISHED); MUTEX_UNLOCK(&thread->mutex); - if (cleanup) + MUTEX_LOCK(&create_destruct_mutex); + if (cleanup) { + joinable_threads--; + } else { + running_threads--; + detached_threads++; + } + MUTEX_UNLOCK(&create_destruct_mutex); + + if (cleanup) { S_ithread_destruct(aTHX_ thread); + } + + +void +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 @@ -790,19 +1097,19 @@ ithread_DESTROY(...) void ithread_equal(...) + PREINIT: + int are_equal = 0; CODE: - /* Compares TIDs to determine thread equality. - * Return 0 on false for backward compatibility. - */ + /* 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)))); - if (thr1->tid == thr2->tid) { - XST_mYES(0); - } else { - XST_mIV(0, 0); - } + 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 */ @@ -813,7 +1120,7 @@ ithread_object(...) PREINIT: char *classname; UV tid; - ithread *thr; + ithread *thread; int found = 0; CODE: /* Class method only */ @@ -825,22 +1132,23 @@ ithread_object(...) XSRETURN_UNDEF; } + /* threads->object($tid) */ tid = SvUV(ST(1)); /* Walk through threads list */ MUTEX_LOCK(&create_destruct_mutex); - for (thr = threads->next; - thr != threads; - thr = thr->next) + for (thread = threads->next; + thread != threads; + thread = thread->next) { /* Look for TID, but ignore detached or joined threads */ - if ((thr->tid != tid) || - (thr->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED))) + 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_ NULL, thr, classname, TRUE)); + ST(0) = sv_2mortal(ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE)); found = 1; break; } @@ -864,49 +1172,146 @@ ithread__handle(...); #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 */ + + +void +ithread_is_running(...) + PREINIT: + ithread *thread; + CODE: + /* Object method only */ + if (! sv_isobject(ST(0))) + Perl_croak(aTHX_ "Usage: $thr->is_running()"); + + thread = INT2PTR(ithread *, SvIV(SvRV(ST(0)))); + MUTEX_LOCK(&thread->mutex); + ST(0) = (thread->state & PERL_ITHR_FINISHED) ? &PL_sv_no : &PL_sv_yes; + MUTEX_UNLOCK(&thread->mutex); + /* XSRETURN(1); - implied */ + + +void +ithread_is_detached(...) + PREINIT: + ithread *thread; + CODE: + thread = SV_to_ithread(aTHX_ ST(0)); + MUTEX_LOCK(&thread->mutex); + ST(0) = (thread->state & PERL_ITHR_DETACHED) ? &PL_sv_yes : &PL_sv_no; + MUTEX_UNLOCK(&thread->mutex); + /* XSRETURN(1); - implied */ + + +void +ithread_is_joinable(...) + PREINIT: + ithread *thread; + CODE: + /* Object method only */ + if (! sv_isobject(ST(0))) + Perl_croak(aTHX_ "Usage: $thr->is_joinable()"); + + thread = INT2PTR(ithread *, SvIV(SvRV(ST(0)))); + MUTEX_LOCK(&thread->mutex); + ST(0) = ((thread->state & PERL_ITHR_FINISHED) && + ! (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED))) + ? &PL_sv_yes : &PL_sv_no; + MUTEX_UNLOCK(&thread->mutex); + /* XSRETURN(1); - implied */ + + +void +ithread_wantarray(...) + PREINIT: + ithread *thread; + CODE: + thread = SV_to_ithread(aTHX_ ST(0)); + MUTEX_LOCK(&thread->mutex); + ST(0) = (thread->gimme & G_ARRAY) ? &PL_sv_yes : + (thread->gimme & G_VOID) ? &PL_sv_undef + /* G_SCALAR */ : &PL_sv_no; + MUTEX_UNLOCK(&thread->mutex); + /* 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); - PL_perl_destruct_level = 2; - MUTEX_INIT(&thread->mutex); - - /* Head of the threads list */ - threads = thread; - thread->next = thread; - thread->prev = thread; - - thread->interp = aTHX; - thread->count = 1; /* Immortal. */ - thread->tid = tid_counter++; - active_threads++; - thread->state = PERL_ITHR_DETACHED; -#ifdef WIN32 - thread->thr = GetCurrentThreadId(); -#else - thread->thr = pthread_self(); -#endif + /* 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); - S_ithread_set(aTHX_ thread); - MUTEX_UNLOCK(&create_destruct_mutex); + 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 */ } -