1 #define PERL_NO_GET_CONTEXT
5 /* Workaround for XSUB.h bug under WIN32 */
8 # if !defined(__BORLANDC__)
9 # define setjmp(x) _setjmp(x)
13 # define NEED_PL_signals
14 # define NEED_newRV_noinc
15 # define NEED_sv_2pv_nolen
24 /* Supposed to be in Winbase.h */
25 # ifndef STACK_SIZE_PARAM_IS_A_RESERVATION
26 # define STACK_SIZE_PARAM_IS_A_RESERVATION 0x00010000
28 # include <win32thread.h>
31 typedef perl_os_thread pthread_t;
36 # define PERL_THREAD_SETSPECIFIC(k,v) pthread_setspecific(k,v)
37 # ifdef OLD_PTHREADS_API
38 # define PERL_THREAD_DETACH(t) pthread_detach(&(t))
40 # define PERL_THREAD_DETACH(t) pthread_detach((t))
43 #if !defined(HAS_GETPAGESIZE) && defined(I_SYS_PARAM)
44 # include <sys/param.h>
47 /* Values for 'state' member */
48 #define PERL_ITHR_DETACHED 1 /* Thread has been detached */
49 #define PERL_ITHR_JOINED 2 /* Thread has been joined */
50 #define PERL_ITHR_FINISHED 4 /* Thread has finished execution */
51 #define PERL_ITHR_THREAD_EXIT_ONLY 8 /* exit() only exits current thread */
52 #define PERL_ITHR_NONVIABLE 16 /* Thread creation failed */
53 #define PERL_ITHR_DIED 32 /* Thread finished by dying */
55 #define PERL_ITHR_UNCALLABLE (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)
58 typedef struct _ithread {
59 struct _ithread *next; /* Next thread in the list */
60 struct _ithread *prev; /* Prev thread in the list */
61 PerlInterpreter *interp; /* The threads interpreter */
62 UV tid; /* Threads module's thread id */
63 perl_mutex mutex; /* Mutex for updating things in this struct */
64 int count; /* Reference count. See S_ithread_create. */
65 int state; /* Detached, joined, finished, etc. */
66 int gimme; /* Context of create */
67 SV *init_function; /* Code to run */
68 SV *params; /* Args to pass function */
70 DWORD thr; /* OS's idea if thread id */
71 HANDLE handle; /* OS's waitable handle */
73 pthread_t thr; /* OS's handle for the thread */
76 SV *err; /* Error from abnormally terminated thread */
77 char *err_class; /* Error object's classname if applicable */
81 #define MY_CXT_KEY "threads::_cxt" XS_VERSION
84 /* Used by Perl interpreter for thread context switching */
91 #define MY_POOL_KEY "threads::_pool" XS_VERSION
94 /* Structure for 'main' thread
95 * Also forms the 'base' for the doubly-linked list of threads */
98 /* Protects the creation and destruction of threads*/
99 perl_mutex create_destruct_mutex;
106 IV default_stack_size;
111 SV *my_pool_sv = *hv_fetch(PL_modglobal, MY_POOL_KEY, \
112 sizeof(MY_POOL_KEY)-1, TRUE); \
113 my_pool_t *my_poolp = INT2PTR(my_pool_t*, SvUV(my_pool_sv))
115 #define MY_POOL (*my_poolp)
118 /* Used by Perl interpreter for thread context switching */
120 S_ithread_set(pTHX_ ithread *thread)
123 MY_CXT.context = thread;
130 return (MY_CXT.context);
134 /* Free any data (such as the Perl interpreter) attached to an ithread
135 * structure. This is a bit like undef on SVs, where the SV isn't freed,
136 * but the PVX is. Must be called with thread->mutex already locked. Also,
137 * must be called with MY_POOL.create_destruct_mutex unlocked as destruction
138 * of the interpreter can lead to recursive destruction calls that could
139 * lead to a deadlock on that mutex.
142 S_ithread_clear(pTHX_ ithread *thread)
144 PerlInterpreter *interp;
146 assert(((thread->state & PERL_ITHR_FINISHED) &&
147 (thread->state & PERL_ITHR_UNCALLABLE))
149 (thread->state & PERL_ITHR_NONVIABLE));
151 interp = thread->interp;
155 PERL_SET_CONTEXT(interp);
156 S_ithread_set(aTHX_ thread);
158 SvREFCNT_dec(thread->params);
159 thread->params = Nullsv;
162 SvREFCNT_dec(thread->err);
163 thread->err = Nullsv;
166 perl_destruct(interp);
168 thread->interp = NULL;
171 PERL_SET_CONTEXT(aTHX);
175 /* Decrement the refcount of an ithread, and if it reaches zero, free it.
176 * Must be called with the mutex held.
177 * On return, mutex is released (or destroyed).
180 S_ithread_free(pTHX_ ithread *thread)
187 if (! (thread->state & PERL_ITHR_NONVIABLE)) {
188 assert(thread->count > 0);
189 if (--thread->count > 0) {
190 MUTEX_UNLOCK(&thread->mutex);
193 assert((thread->state & PERL_ITHR_FINISHED) &&
194 (thread->state & PERL_ITHR_UNCALLABLE));
196 MUTEX_UNLOCK(&thread->mutex);
198 /* Main thread (0) is immortal and should never get here */
199 assert(thread->tid != 0);
201 /* Remove from circular list of threads */
202 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
203 assert(thread->prev && thread->next);
204 thread->next->prev = thread->prev;
205 thread->prev->next = thread->next;
208 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
210 /* Thread is now disowned */
211 MUTEX_LOCK(&thread->mutex);
212 S_ithread_clear(aTHX_ thread);
215 handle = thread->handle;
216 thread->handle = NULL;
218 MUTEX_UNLOCK(&thread->mutex);
219 MUTEX_DESTROY(&thread->mutex);
227 PerlMemShared_free(thread);
229 /* total_threads >= 1 is used to veto cleanup by the main thread,
230 * should it happen to exit while other threads still exist.
231 * Decrement this as the very last thing in the thread's existence.
232 * Otherwise, MY_POOL and global state such as PL_op_mutex may get
233 * freed while we're still using it.
235 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
236 MY_POOL.total_threads--;
237 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
242 S_ithread_count_inc(pTHX_ ithread *thread)
244 MUTEX_LOCK(&thread->mutex);
246 MUTEX_UNLOCK(&thread->mutex);
250 /* Warn if exiting with any unjoined threads */
254 int veto_cleanup, warn;
257 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
258 veto_cleanup = (MY_POOL.total_threads > 0);
259 warn = (MY_POOL.running_threads || MY_POOL.joinable_threads);
260 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
263 if (ckWARN_d(WARN_THREADS)) {
264 Perl_warn(aTHX_ "Perl exited with active threads:\n\t%"
265 IVdf " running and unjoined\n\t%"
266 IVdf " finished and unjoined\n\t%"
267 IVdf " running and detached\n",
268 MY_POOL.running_threads,
269 MY_POOL.joinable_threads,
270 MY_POOL.detached_threads);
274 return (veto_cleanup);
278 /* Called from perl_destruct() in each thread. If it's the main thread,
279 * stop it from freeing everything if there are other threads still running.
282 Perl_ithread_hook(pTHX)
285 return ((aTHX == MY_POOL.main_thread.interp) ? S_exit_warning(aTHX) : 0);
289 /* MAGIC (in mg.h sense) hooks */
292 ithread_mg_get(pTHX_ SV *sv, MAGIC *mg)
294 ithread *thread = (ithread *)mg->mg_ptr;
295 SvIV_set(sv, PTR2IV(thread));
301 ithread_mg_free(pTHX_ SV *sv, MAGIC *mg)
303 ithread *thread = (ithread *)mg->mg_ptr;
304 MUTEX_LOCK(&thread->mutex);
305 S_ithread_free(aTHX_ thread); /* Releases MUTEX */
310 ithread_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
312 S_ithread_count_inc(aTHX_ (ithread *)mg->mg_ptr);
316 MGVTBL ithread_vtbl = {
317 ithread_mg_get, /* get */
321 ithread_mg_free, /* free */
323 ithread_mg_dup /* dup */
327 /* Provided default, minimum and rational stack sizes */
329 S_good_stack_size(pTHX_ IV stack_size)
333 /* Use default stack size if no stack size specified */
335 return (MY_POOL.default_stack_size);
338 #ifdef PTHREAD_STACK_MIN
339 /* Can't use less than minimum */
340 if (stack_size < PTHREAD_STACK_MIN) {
341 if (ckWARN(WARN_THREADS)) {
342 Perl_warn(aTHX_ "Using minimum thread stack size of %" IVdf, (IV)PTHREAD_STACK_MIN);
344 return (PTHREAD_STACK_MIN);
348 /* Round up to page size boundary */
349 if (MY_POOL.page_size <= 0) {
350 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
351 SETERRNO(0, SS_NORMAL);
353 MY_POOL.page_size = sysconf(_SC_PAGESIZE);
355 MY_POOL.page_size = sysconf(_SC_MMAP_PAGE_SIZE);
357 if ((long)MY_POOL.page_size < 0) {
359 SV * const error = get_sv("@", FALSE);
360 (void)SvUPGRADE(error, SVt_PV);
361 Perl_croak(aTHX_ "PANIC: sysconf: %s", SvPV_nolen(error));
363 Perl_croak(aTHX_ "PANIC: sysconf: pagesize unknown");
367 # ifdef HAS_GETPAGESIZE
368 MY_POOL.page_size = getpagesize();
370 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
371 MY_POOL.page_size = PAGESIZE;
373 MY_POOL.page_size = 8192; /* A conservative default */
376 if (MY_POOL.page_size <= 0) {
377 Perl_croak(aTHX_ "PANIC: bad pagesize %" IVdf, (IV)MY_POOL.page_size);
381 stack_size = ((stack_size + (MY_POOL.page_size - 1)) / MY_POOL.page_size) * MY_POOL.page_size;
387 /* Starts executing the thread.
388 * Passed as the C level function to run in the new thread.
391 STATIC THREAD_RET_TYPE
392 S_ithread_run(LPVOID arg)
395 S_ithread_run(void * arg)
398 ithread *thread = (ithread *)arg;
401 int exit_app = 0; /* Thread terminated using 'exit' */
403 int died = 0; /* Thread terminated abnormally */
407 dTHXa(thread->interp);
411 /* Blocked until ->create() call finishes */
412 MUTEX_LOCK(&thread->mutex);
413 MUTEX_UNLOCK(&thread->mutex);
415 PERL_SET_CONTEXT(thread->interp);
416 S_ithread_set(aTHX_ thread);
418 PL_perl_destruct_level = 2;
421 AV *params = (AV *)SvRV(thread->params);
422 int len = (int)av_len(params)+1;
429 /* Put args on the stack */
431 for (ii=0; ii < len; ii++) {
432 XPUSHs(av_shift(params));
436 oldscope = PL_scopestack_ix;
439 /* Run the specified function */
440 len = (int)call_sv(thread->init_function, thread->gimme|G_EVAL);
441 } else if (jmp_rc == 2) {
444 exit_code = STATUS_CURRENT;
445 while (PL_scopestack_ix > oldscope) {
451 /* Remove args from stack and put back in params array */
453 for (ii=len-1; ii >= 0; ii--) {
456 av_store(params, ii, SvREFCNT_inc(sv));
463 /* Check for abnormal termination */
465 died = PERL_ITHR_DIED;
466 thread->err = newSVsv(ERRSV);
467 /* If ERRSV is an object, remember the classname and then
468 * rebless into 'main' so it will survive 'cloning'
470 if (sv_isobject(thread->err)) {
471 thread->err_class = HvNAME(SvSTASH(SvRV(thread->err)));
472 sv_bless(thread->err, gv_stashpv("main", 0));
475 if (ckWARN_d(WARN_THREADS)) {
476 oldscope = PL_scopestack_ix;
479 /* Warn that thread died */
480 Perl_warn(aTHX_ "Thread %" UVuf " terminated abnormally: %" SVf, thread->tid, ERRSV);
481 } else if (jmp_rc == 2) {
482 /* Warn handler exited */
484 exit_code = STATUS_CURRENT;
485 while (PL_scopestack_ix > oldscope) {
493 /* Release function ref */
494 SvREFCNT_dec(thread->init_function);
495 thread->init_function = Nullsv;
498 PerlIO_flush((PerlIO *)NULL);
500 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
501 MUTEX_LOCK(&thread->mutex);
502 /* Mark as finished */
503 thread->state |= (PERL_ITHR_FINISHED | died);
504 /* Clear exit flag if required */
505 if (thread->state & PERL_ITHR_THREAD_EXIT_ONLY) {
509 /* Adjust thread status counts */
510 if (thread->state & PERL_ITHR_DETACHED) {
511 MY_POOL.detached_threads--;
513 MY_POOL.running_threads--;
514 MY_POOL.joinable_threads++;
516 MUTEX_UNLOCK(&thread->mutex);
517 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
519 /* Exit application if required */
521 oldscope = PL_scopestack_ix;
524 /* Warn if there are unjoined threads */
525 S_exit_warning(aTHX);
526 } else if (jmp_rc == 2) {
527 /* Warn handler exited */
528 exit_code = STATUS_CURRENT;
529 while (PL_scopestack_ix > oldscope) {
538 /* At this point, the interpreter may have been freed, so call
539 * free in the the context of of the 'main' interpreter which
540 * can't have been freed due to the veto_cleanup mechanism.
542 aTHX = MY_POOL.main_thread.interp;
544 MUTEX_LOCK(&thread->mutex);
545 S_ithread_free(aTHX_ thread); /* Releases MUTEX */
555 /* Type conversion helper functions */
558 S_ithread_to_SV(pTHX_ SV *obj, ithread *thread, char *classname, bool inc)
564 S_ithread_count_inc(aTHX_ thread);
570 sv = newSVrv(obj, classname);
571 sv_setiv(sv, PTR2IV(thread));
572 mg = sv_magicext(sv, Nullsv, PERL_MAGIC_shared_scalar, &ithread_vtbl, (char *)thread, 0);
573 mg->mg_flags |= MGf_DUP;
580 S_SV_to_ithread(pTHX_ SV *sv)
582 /* Argument is a thread */
584 return (INT2PTR(ithread *, SvIV(SvRV(sv))));
586 /* Argument is classname, therefore return current thread */
587 return (S_ithread_get(aTHX));
592 * Called in context of parent thread.
593 * Called with MY_POOL.create_destruct_mutex locked. (Unlocked on error.)
597 pTHX_ SV *init_function,
604 ithread *current_thread = S_ithread_get(aTHX);
606 SV **tmps_tmp = PL_tmps_stack;
607 IV tmps_ix = PL_tmps_ix;
609 int rc_stack_size = 0;
610 int rc_thread_create = 0;
614 /* Allocate thread structure in context of the main thread's interpreter */
616 PERL_SET_CONTEXT(MY_POOL.main_thread.interp);
617 thread = (ithread *)PerlMemShared_malloc(sizeof(ithread));
619 PERL_SET_CONTEXT(aTHX);
621 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
622 PerlLIO_write(PerlIO_fileno(Perl_error_log), PL_no_mem, strlen(PL_no_mem));
625 Zero(thread, 1, ithread);
627 /* Add to threads list */
628 thread->next = &MY_POOL.main_thread;
629 thread->prev = MY_POOL.main_thread.prev;
630 MY_POOL.main_thread.prev = thread;
631 thread->prev->next = thread;
632 MY_POOL.total_threads++;
634 /* 1 ref to be held by the local var 'thread' in S_ithread_run().
635 * 1 ref to be held by the threads object that we assume we will
636 * be embedded in upon our return.
637 * 1 ref to be the responsibility of join/detach, so we don't get
638 * freed until join/detach, even if no thread objects remain.
639 * This allows the following to work:
640 * { threads->create(sub{...}); } threads->object(1)->join;
644 /* Block new thread until ->create() call finishes */
645 MUTEX_INIT(&thread->mutex);
646 MUTEX_LOCK(&thread->mutex);
648 thread->tid = MY_POOL.tid_counter++;
649 thread->stack_size = S_good_stack_size(aTHX_ stack_size);
650 thread->gimme = gimme;
651 thread->state = exit_opt;
653 /* "Clone" our interpreter into the thread's interpreter.
654 * This gives thread access to "static data" and code.
656 PerlIO_flush((PerlIO *)NULL);
657 S_ithread_set(aTHX_ thread);
659 SAVEBOOL(PL_srand_called); /* Save this so it becomes the correct value */
660 PL_srand_called = FALSE; /* Set it to false so we can detect if it gets
661 set during the clone */
664 thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE | CLONEf_CLONE_HOST);
666 thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE);
669 /* perl_clone() leaves us in new interpreter's context. As it is tricky
670 * to spot an implicit aTHX, create a new scope with aTHX matching the
671 * context for the duration of our work for new interpreter.
674 CLONE_PARAMS clone_param;
676 dTHXa(thread->interp);
680 /* Here we remove END blocks since they should only run in the thread
683 SvREFCNT_dec(PL_endav);
686 clone_param.flags = 0;
687 if (SvPOK(init_function)) {
688 thread->init_function = newSV(0);
689 sv_copypv(thread->init_function, init_function);
691 thread->init_function = sv_dup(init_function, &clone_param);
692 if (SvREFCNT(thread->init_function) == 0) {
693 SvREFCNT_inc_void(thread->init_function);
697 thread->params = sv_dup(params, &clone_param);
698 SvREFCNT_inc_void(thread->params);
700 /* The code below checks that anything living on the tmps stack and
701 * has been cloned (so it lives in the ptr_table) has a refcount
704 * If the refcount is 0 it means that a something on the stack/context
705 * was holding a reference to it and since we init_stacks() in
706 * perl_clone that won't get cleaned and we will get a leaked scalar.
707 * The reason it was cloned was that it lived on the @_ stack.
709 * Example of this can be found in bugreport 15837 where calls in the
710 * parameter list end up as a temp.
712 * One could argue that this fix should be in perl_clone.
714 while (tmps_ix > 0) {
715 SV* sv = (SV*)ptr_table_fetch(PL_ptr_table, tmps_tmp[tmps_ix]);
717 if (sv && SvREFCNT(sv) == 0) {
718 SvREFCNT_inc_void(sv);
723 SvTEMP_off(thread->init_function);
724 ptr_table_free(PL_ptr_table);
726 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
728 S_ithread_set(aTHX_ current_thread);
729 PERL_SET_CONTEXT(aTHX);
731 /* Create/start the thread */
733 thread->handle = CreateThread(NULL,
734 (DWORD)thread->stack_size,
737 STACK_SIZE_PARAM_IS_A_RESERVATION,
741 STATIC pthread_attr_t attr;
742 STATIC int attr_inited = 0;
743 STATIC int attr_joinable = PTHREAD_CREATE_JOINABLE;
745 pthread_attr_init(&attr);
749 # ifdef PTHREAD_ATTR_SETDETACHSTATE
750 /* Threads start out joinable */
751 PTHREAD_ATTR_SETDETACHSTATE(&attr, attr_joinable);
754 # ifdef _POSIX_THREAD_ATTR_STACKSIZE
755 /* Set thread's stack size */
756 if (thread->stack_size > 0) {
757 rc_stack_size = pthread_attr_setstacksize(&attr, (size_t)thread->stack_size);
761 /* Create the thread */
762 if (! rc_stack_size) {
763 # ifdef OLD_PTHREADS_API
764 rc_thread_create = pthread_create(&thread->thr,
769 # if defined(HAS_PTHREAD_ATTR_SETSCOPE) && defined(PTHREAD_SCOPE_SYSTEM)
770 pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM);
772 rc_thread_create = pthread_create(&thread->thr,
779 # ifdef _POSIX_THREAD_ATTR_STACKSIZE
780 /* Try to get thread's actual stack size */
784 stacksize = pthread_attr_getstacksize(attr);
786 if (! pthread_attr_getstacksize(&attr, &stacksize))
789 thread->stack_size = (IV)stacksize;
796 /* Check for errors */
798 if (thread->handle == NULL) {
800 if (rc_stack_size || rc_thread_create) {
802 /* Must unlock mutex for destruct call */
803 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
805 thread->state |= PERL_ITHR_NONVIABLE;
806 S_ithread_free(aTHX_ thread); /* Releases MUTEX */
808 if (ckWARN_d(WARN_THREADS)) {
810 Perl_warn(aTHX_ "Thread creation failed: pthread_attr_setstacksize(%" IVdf ") returned %d", thread->stack_size, rc_stack_size);
812 Perl_warn(aTHX_ "Thread creation failed: pthread_create returned %d", rc_thread_create);
819 MY_POOL.running_threads++;
824 #endif /* USE_ITHREADS */
827 MODULE = threads PACKAGE = threads PREFIX = ithread_
837 SV *function_to_call;
843 SV *thread_exit_only;
849 if ((items >= 2) && SvROK(ST(1)) && SvTYPE(SvRV(ST(1)))==SVt_PVHV) {
851 Perl_croak(aTHX_ "Usage: threads->create(\\%specs, function, ...)");
853 specs = (HV*)SvRV(ST(1));
857 Perl_croak(aTHX_ "Usage: threads->create(function, ...)");
863 if (sv_isobject(ST(0))) {
865 classname = HvNAME(SvSTASH(SvRV(ST(0))));
866 thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
867 MUTEX_LOCK(&thread->mutex);
868 stack_size = thread->stack_size;
869 exit_opt = thread->state & PERL_ITHR_THREAD_EXIT_ONLY;
870 MUTEX_UNLOCK(&thread->mutex);
872 /* threads->create() */
873 classname = (char *)SvPV_nolen(ST(0));
874 stack_size = MY_POOL.default_stack_size;
875 thread_exit_only = get_sv("threads::thread_exit_only", TRUE);
876 exit_opt = (SvTRUE(thread_exit_only))
877 ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
880 function_to_call = ST(idx+1);
885 if (hv_exists(specs, "stack", 5)) {
886 stack_size = SvIV(*hv_fetch(specs, "stack", 5, 0));
887 } else if (hv_exists(specs, "stacksize", 9)) {
888 stack_size = SvIV(*hv_fetch(specs, "stacksize", 9, 0));
889 } else if (hv_exists(specs, "stack_size", 10)) {
890 stack_size = SvIV(*hv_fetch(specs, "stack_size", 10, 0));
894 if (hv_exists(specs, "context", 7)) {
895 str = (char *)SvPV_nolen(*hv_fetch(specs, "context", 7, 0));
912 Perl_croak(aTHX_ "Invalid context: %s", str);
914 } else if (hv_exists(specs, "array", 5)) {
915 if (SvTRUE(*hv_fetch(specs, "array", 5, 0))) {
918 } else if (hv_exists(specs, "list", 4)) {
919 if (SvTRUE(*hv_fetch(specs, "list", 4, 0))) {
922 } else if (hv_exists(specs, "scalar", 6)) {
923 if (SvTRUE(*hv_fetch(specs, "scalar", 6, 0))) {
926 } else if (hv_exists(specs, "void", 4)) {
927 if (SvTRUE(*hv_fetch(specs, "void", 4, 0))) {
932 /* exit => thread_only */
933 if (hv_exists(specs, "exit", 4)) {
934 str = (char *)SvPV_nolen(*hv_fetch(specs, "exit", 4, 0));
935 exit_opt = (*str == 't' || *str == 'T')
936 ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
940 context = GIMME_V; /* Implicit context */
942 context |= (GIMME_V & (~(G_ARRAY|G_SCALAR|G_VOID)));
948 for (ii=2; ii < items ; ii++) {
949 av_push(params, SvREFCNT_inc(ST(idx+ii)));
954 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
955 thread = S_ithread_create(aTHX_ function_to_call,
959 newRV_noinc((SV*)params));
961 XSRETURN_UNDEF; /* Mutex already unlocked */
963 ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, FALSE));
964 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
967 MUTEX_UNLOCK(&thread->mutex);
969 /* XSRETURN(1); - implied */
979 int want_running = 0;
983 /* Class method only */
985 Perl_croak(aTHX_ "Usage: threads->list(...)");
987 classname = (char *)SvPV_nolen(ST(0));
989 /* Calling context */
990 list_context = (GIMME_V == G_ARRAY);
992 /* Running or joinable parameter */
994 want_running = SvTRUE(ST(1));
997 /* Walk through threads list */
998 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
999 for (thread = MY_POOL.main_thread.next;
1000 thread != &MY_POOL.main_thread;
1001 thread = thread->next)
1003 MUTEX_LOCK(&thread->mutex);
1004 state = thread->state;
1005 MUTEX_UNLOCK(&thread->mutex);
1007 /* Ignore detached or joined threads */
1008 if (state & PERL_ITHR_UNCALLABLE) {
1012 /* Filter per parameter */
1015 if (state & PERL_ITHR_FINISHED) {
1016 continue; /* Not running */
1019 if (! (state & PERL_ITHR_FINISHED)) {
1020 continue; /* Still running - not joinable yet */
1025 /* Push object on stack if list context */
1027 XPUSHs(sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE)));
1031 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1032 /* If scalar context, send back count */
1033 if (! list_context) {
1044 /* Class method only */
1045 if ((items != 1) || SvROK(ST(0))) {
1046 Perl_croak(aTHX_ "Usage: threads->self()");
1048 classname = (char *)SvPV_nolen(ST(0));
1050 thread = S_ithread_get(aTHX);
1052 ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1053 /* XSRETURN(1); - implied */
1061 PERL_UNUSED_VAR(items);
1062 thread = S_SV_to_ithread(aTHX_ ST(0));
1063 XST_mUV(0, thread->tid);
1064 /* XSRETURN(1); - implied */
1071 ithread *current_thread;
1082 /* Object method only */
1083 if ((items != 1) || ! sv_isobject(ST(0))) {
1084 Perl_croak(aTHX_ "Usage: $thr->join()");
1087 /* Check if the thread is joinable and not ourselves */
1088 thread = S_SV_to_ithread(aTHX_ ST(0));
1089 current_thread = S_ithread_get(aTHX);
1091 MUTEX_LOCK(&thread->mutex);
1092 if ((join_err = (thread->state & PERL_ITHR_UNCALLABLE))) {
1093 MUTEX_UNLOCK(&thread->mutex);
1094 Perl_croak(aTHX_ (join_err & PERL_ITHR_DETACHED)
1095 ? "Cannot join a detached thread"
1096 : "Thread already joined");
1097 } else if (thread->tid == current_thread->tid) {
1098 MUTEX_UNLOCK(&thread->mutex);
1099 Perl_croak(aTHX_ "Cannot join self");
1102 /* Mark as joined */
1103 thread->state |= PERL_ITHR_JOINED;
1104 MUTEX_UNLOCK(&thread->mutex);
1106 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1107 MY_POOL.joinable_threads--;
1108 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1110 /* Join the thread */
1112 if (WaitForSingleObject(thread->handle, INFINITE) != WAIT_OBJECT_0) {
1113 /* Timeout/abandonment unexpected here; check $^E */
1114 Perl_croak(aTHX_ "PANIC: underlying join failed");
1117 if ((rc_join = pthread_join(thread->thr, &retval)) != 0) {
1118 /* In progress/deadlock/unknown unexpected here; check $! */
1120 Perl_croak(aTHX_ "PANIC: underlying join failed");
1124 MUTEX_LOCK(&thread->mutex);
1125 /* Get the return value from the call_sv */
1126 /* Objects do not survive this process - FIXME */
1127 if (! (thread->gimme & G_VOID)) {
1129 PerlInterpreter *other_perl;
1130 CLONE_PARAMS clone_params;
1132 params_copy = (AV *)SvRV(thread->params);
1133 other_perl = thread->interp;
1134 clone_params.stashes = newAV();
1135 clone_params.flags = CLONEf_JOIN_IN;
1136 PL_ptr_table = ptr_table_new();
1137 S_ithread_set(aTHX_ thread);
1138 /* Ensure 'meaningful' addresses retain their meaning */
1139 ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1140 ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1141 ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1142 params = (AV *)sv_dup((SV*)params_copy, &clone_params);
1143 S_ithread_set(aTHX_ current_thread);
1144 SvREFCNT_dec(clone_params.stashes);
1145 SvREFCNT_inc_void(params);
1146 ptr_table_free(PL_ptr_table);
1147 PL_ptr_table = NULL;
1150 /* If thread didn't die, then we can free its interpreter */
1151 if (! (thread->state & PERL_ITHR_DIED)) {
1152 S_ithread_clear(aTHX_ thread);
1154 S_ithread_free(aTHX_ thread); /* Releases MUTEX */
1156 /* If no return values, then just return */
1161 /* Put return values on stack */
1162 len = (int)AvFILL(params);
1163 for (ii=0; ii <= len; ii++) {
1164 SV* param = av_shift(params);
1165 XPUSHs(sv_2mortal(param));
1168 /* Free return value array */
1169 SvREFCNT_dec(params);
1175 PERL_UNUSED_VAR(items);
1186 PERL_UNUSED_VAR(items);
1188 /* Detach the thread */
1189 thread = S_SV_to_ithread(aTHX_ ST(0));
1190 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1191 MUTEX_LOCK(&thread->mutex);
1192 if (! (detach_err = (thread->state & PERL_ITHR_UNCALLABLE))) {
1193 /* Thread is detachable */
1194 thread->state |= PERL_ITHR_DETACHED;
1196 /* Windows has no 'detach thread' function */
1198 PERL_THREAD_DETACH(thread->thr);
1200 if (thread->state & PERL_ITHR_FINISHED) {
1201 MY_POOL.joinable_threads--;
1203 MY_POOL.running_threads--;
1204 MY_POOL.detached_threads++;
1207 MUTEX_UNLOCK(&thread->mutex);
1208 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1211 Perl_croak(aTHX_ (detach_err & PERL_ITHR_DETACHED)
1212 ? "Thread already detached"
1213 : "Cannot detach a joined thread");
1216 /* If thread is finished and didn't die,
1217 * then we can free its interpreter */
1218 MUTEX_LOCK(&thread->mutex);
1219 if ((thread->state & PERL_ITHR_FINISHED) &&
1220 ! (thread->state & PERL_ITHR_DIED))
1222 S_ithread_clear(aTHX_ thread);
1224 S_ithread_free(aTHX_ thread); /* Releases MUTEX */
1234 /* Must have safe signals */
1235 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) {
1236 Perl_croak(aTHX_ "Cannot signal threads without safe signals");
1239 /* Object method only */
1240 if ((items != 2) || ! sv_isobject(ST(0))) {
1241 Perl_croak(aTHX_ "Usage: $thr->kill('SIG...')");
1245 sig_name = SvPV_nolen(ST(1));
1246 if (isALPHA(*sig_name)) {
1247 if (*sig_name == 'S' && sig_name[1] == 'I' && sig_name[2] == 'G') {
1250 if ((signal = whichsig(sig_name)) < 0) {
1251 Perl_croak(aTHX_ "Unrecognized signal name: %s", sig_name);
1254 signal = SvIV(ST(1));
1257 /* Set the signal for the thread */
1258 thread = S_SV_to_ithread(aTHX_ ST(0));
1259 MUTEX_LOCK(&thread->mutex);
1260 if (thread->interp) {
1261 dTHXa(thread->interp);
1262 PL_psig_pend[signal]++;
1265 MUTEX_UNLOCK(&thread->mutex);
1267 /* Return the thread to allow for method chaining */
1269 /* XSRETURN(1); - implied */
1273 ithread_DESTROY(...)
1275 PERL_UNUSED_VAR(items);
1276 sv_unmagic(SvRV(ST(0)), PERL_MAGIC_shared_scalar);
1284 PERL_UNUSED_VAR(items);
1286 /* Compares TIDs to determine thread equality */
1287 if (sv_isobject(ST(0)) && sv_isobject(ST(1))) {
1288 ithread *thr1 = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1289 ithread *thr2 = INT2PTR(ithread *, SvIV(SvRV(ST(1))));
1290 are_equal = (thr1->tid == thr2->tid);
1295 /* Return 0 on false for backward compatibility */
1298 /* XSRETURN(1); - implied */
1311 /* Class method only */
1313 Perl_croak(aTHX_ "Usage: threads->object($tid)");
1315 classname = (char *)SvPV_nolen(ST(0));
1317 if ((items < 2) || ! SvOK(ST(1))) {
1321 /* threads->object($tid) */
1324 /* Walk through threads list */
1325 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1326 for (thread = MY_POOL.main_thread.next;
1327 thread != &MY_POOL.main_thread;
1328 thread = thread->next)
1331 if (thread->tid == tid) {
1332 /* Ignore if detached or joined */
1333 MUTEX_LOCK(&thread->mutex);
1334 state = thread->state;
1335 MUTEX_UNLOCK(&thread->mutex);
1336 if (! (state & PERL_ITHR_UNCALLABLE)) {
1337 /* Put object on stack */
1338 ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1344 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1349 /* XSRETURN(1); - implied */
1353 ithread__handle(...);
1357 PERL_UNUSED_VAR(items);
1358 thread = S_SV_to_ithread(aTHX_ ST(0));
1360 XST_mUV(0, PTR2UV(&thread->handle));
1362 XST_mUV(0, PTR2UV(&thread->thr));
1364 /* XSRETURN(1); - implied */
1368 ithread_get_stack_size(...)
1373 PERL_UNUSED_VAR(items);
1374 if (sv_isobject(ST(0))) {
1375 /* $thr->get_stack_size() */
1376 ithread *thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1377 stack_size = thread->stack_size;
1379 /* threads->get_stack_size() */
1380 stack_size = MY_POOL.default_stack_size;
1382 XST_mIV(0, stack_size);
1383 /* XSRETURN(1); - implied */
1387 ithread_set_stack_size(...)
1393 Perl_croak(aTHX_ "Usage: threads->set_stack_size($size)");
1395 if (sv_isobject(ST(0))) {
1396 Perl_croak(aTHX_ "Cannot change stack size of an existing thread");
1398 if (! looks_like_number(ST(1))) {
1399 Perl_croak(aTHX_ "Stack size must be numeric");
1402 old_size = MY_POOL.default_stack_size;
1403 MY_POOL.default_stack_size = S_good_stack_size(aTHX_ SvIV(ST(1)));
1404 XST_mIV(0, old_size);
1405 /* XSRETURN(1); - implied */
1409 ithread_is_running(...)
1413 /* Object method only */
1414 if ((items != 1) || ! sv_isobject(ST(0))) {
1415 Perl_croak(aTHX_ "Usage: $thr->is_running()");
1418 thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1419 MUTEX_LOCK(&thread->mutex);
1420 ST(0) = (thread->state & PERL_ITHR_FINISHED) ? &PL_sv_no : &PL_sv_yes;
1421 MUTEX_UNLOCK(&thread->mutex);
1422 /* XSRETURN(1); - implied */
1426 ithread_is_detached(...)
1430 PERL_UNUSED_VAR(items);
1431 thread = S_SV_to_ithread(aTHX_ ST(0));
1432 MUTEX_LOCK(&thread->mutex);
1433 ST(0) = (thread->state & PERL_ITHR_DETACHED) ? &PL_sv_yes : &PL_sv_no;
1434 MUTEX_UNLOCK(&thread->mutex);
1435 /* XSRETURN(1); - implied */
1439 ithread_is_joinable(...)
1443 /* Object method only */
1444 if ((items != 1) || ! sv_isobject(ST(0))) {
1445 Perl_croak(aTHX_ "Usage: $thr->is_joinable()");
1448 thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1449 MUTEX_LOCK(&thread->mutex);
1450 ST(0) = ((thread->state & PERL_ITHR_FINISHED) &&
1451 ! (thread->state & PERL_ITHR_UNCALLABLE))
1452 ? &PL_sv_yes : &PL_sv_no;
1453 MUTEX_UNLOCK(&thread->mutex);
1454 /* XSRETURN(1); - implied */
1458 ithread_wantarray(...)
1462 PERL_UNUSED_VAR(items);
1463 thread = S_SV_to_ithread(aTHX_ ST(0));
1464 ST(0) = (thread->gimme & G_ARRAY) ? &PL_sv_yes :
1465 (thread->gimme & G_VOID) ? &PL_sv_undef
1466 /* G_SCALAR */ : &PL_sv_no;
1467 /* XSRETURN(1); - implied */
1471 ithread_set_thread_exit_only(...)
1476 Perl_croak(aTHX_ "Usage: ->set_thread_exit_only(boolean)");
1478 thread = S_SV_to_ithread(aTHX_ ST(0));
1479 MUTEX_LOCK(&thread->mutex);
1480 if (SvTRUE(ST(1))) {
1481 thread->state |= PERL_ITHR_THREAD_EXIT_ONLY;
1483 thread->state &= ~PERL_ITHR_THREAD_EXIT_ONLY;
1485 MUTEX_UNLOCK(&thread->mutex);
1494 /* Object method only */
1495 if ((items != 1) || ! sv_isobject(ST(0))) {
1496 Perl_croak(aTHX_ "Usage: $thr->err()");
1499 thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1500 MUTEX_LOCK(&thread->mutex);
1502 /* If thread died, then clone the error into the calling thread */
1503 if (thread->state & PERL_ITHR_DIED) {
1504 PerlInterpreter *other_perl;
1505 CLONE_PARAMS clone_params;
1506 ithread *current_thread;
1508 other_perl = thread->interp;
1509 clone_params.stashes = newAV();
1510 clone_params.flags = CLONEf_JOIN_IN;
1511 PL_ptr_table = ptr_table_new();
1512 current_thread = S_ithread_get(aTHX);
1513 S_ithread_set(aTHX_ thread);
1514 /* Ensure 'meaningful' addresses retain their meaning */
1515 ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1516 ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1517 ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1518 err = sv_dup(thread->err, &clone_params);
1519 S_ithread_set(aTHX_ current_thread);
1520 SvREFCNT_dec(clone_params.stashes);
1521 SvREFCNT_inc_void(err);
1522 /* If error was an object, bless it into the correct class */
1523 if (thread->err_class) {
1524 sv_bless(err, gv_stashpv(thread->err_class, 1));
1526 ptr_table_free(PL_ptr_table);
1527 PL_ptr_table = NULL;
1530 MUTEX_UNLOCK(&thread->mutex);
1536 ST(0) = sv_2mortal(err);
1537 /* XSRETURN(1); - implied */
1540 #endif /* USE_ITHREADS */
1546 SV *my_pool_sv = *hv_fetch(PL_modglobal, MY_POOL_KEY,
1547 sizeof(MY_POOL_KEY)-1, TRUE);
1548 my_pool_t *my_poolp = (my_pool_t*)SvPVX(newSV(sizeof(my_pool_t)-1));
1552 Zero(my_poolp, 1, my_pool_t);
1553 sv_setuv(my_pool_sv, PTR2UV(my_poolp));
1555 PL_perl_destruct_level = 2;
1556 MUTEX_INIT(&MY_POOL.create_destruct_mutex);
1557 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1559 PL_threadhook = &Perl_ithread_hook;
1561 MY_POOL.tid_counter = 1;
1562 # ifdef THREAD_CREATE_NEEDS_STACK
1563 MY_POOL.default_stack_size = THREAD_CREATE_NEEDS_STACK;
1566 /* The 'main' thread is thread 0.
1567 * It is detached (unjoinable) and immortal.
1570 MUTEX_INIT(&MY_POOL.main_thread.mutex);
1572 /* Head of the threads list */
1573 MY_POOL.main_thread.next = &MY_POOL.main_thread;
1574 MY_POOL.main_thread.prev = &MY_POOL.main_thread;
1576 MY_POOL.main_thread.count = 1; /* Immortal */
1578 MY_POOL.main_thread.interp = aTHX;
1579 MY_POOL.main_thread.state = PERL_ITHR_DETACHED; /* Detached */
1580 MY_POOL.main_thread.stack_size = MY_POOL.default_stack_size;
1582 MY_POOL.main_thread.thr = GetCurrentThreadId();
1584 MY_POOL.main_thread.thr = pthread_self();
1587 S_ithread_set(aTHX_ &MY_POOL.main_thread);
1588 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1589 #endif /* USE_ITHREADS */