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_JOINABLE 0
49 #define PERL_ITHR_DETACHED 1
50 #define PERL_ITHR_JOINED 2
51 #define PERL_ITHR_FINISHED 4
52 #define PERL_ITHR_THREAD_EXIT_ONLY 8
54 typedef struct _ithread {
55 struct _ithread *next; /* Next thread in the list */
56 struct _ithread *prev; /* Prev thread in the list */
57 PerlInterpreter *interp; /* The threads interpreter */
58 UV tid; /* Threads module's thread id */
59 perl_mutex mutex; /* Mutex for updating things in this struct */
60 int count; /* How many SVs have a reference to us */
61 int state; /* Detached, joined, finished, etc. */
62 int gimme; /* Context of create */
63 SV *init_function; /* Code to run */
64 SV *params; /* Args to pass function */
66 DWORD thr; /* OS's idea if thread id */
67 HANDLE handle; /* OS's waitable handle */
69 pthread_t thr; /* OS's handle for the thread */
75 #define MY_CXT_KEY "threads::_cxt" XS_VERSION
78 /* Used by Perl interpreter for thread context switching */
85 #define MY_POOL_KEY "threads::_pool" XS_VERSION
88 /* Structure for 'main' thread
89 * Also forms the 'base' for the doubly-linked list of threads */
92 /* Protects the creation and destruction of threads*/
93 perl_mutex create_destruct_mutex;
99 IV default_stack_size;
104 SV *my_pool_sv = *hv_fetch(PL_modglobal, MY_POOL_KEY, \
105 sizeof(MY_POOL_KEY)-1, TRUE); \
106 my_pool_t *my_poolp = INT2PTR(my_pool_t*, SvUV(my_pool_sv))
108 #define MY_POOL (*my_poolp)
111 /* Used by Perl interpreter for thread context switching */
113 S_ithread_set(pTHX_ ithread *thread)
116 MY_CXT.context = thread;
123 return (MY_CXT.context);
127 /* Free any data (such as the Perl interpreter) attached to an ithread
128 * structure. This is a bit like undef on SVs, where the SV isn't freed,
129 * but the PVX is. Must be called with thread->mutex already held.
132 S_ithread_clear(pTHX_ ithread *thread)
134 PerlInterpreter *interp;
136 assert((thread->state & PERL_ITHR_FINISHED) &&
137 (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)));
139 interp = thread->interp;
143 PERL_SET_CONTEXT(interp);
144 S_ithread_set(aTHX_ thread);
146 SvREFCNT_dec(thread->params);
147 thread->params = Nullsv;
149 perl_destruct(interp);
151 thread->interp = NULL;
154 PERL_SET_CONTEXT(aTHX);
158 /* Free an ithread structure and any attached data if its count == 0 */
160 S_ithread_destruct(pTHX_ ithread *thread)
167 /* Return if thread is still being used */
168 if (thread->count != 0) {
172 /* Main thread (0) is immortal and should never get here */
173 assert(thread->tid != 0);
175 /* Remove from circular list of threads */
176 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
177 thread->next->prev = thread->prev;
178 thread->prev->next = thread->next;
181 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
183 /* Thread is now disowned */
184 MUTEX_LOCK(&thread->mutex);
185 S_ithread_clear(aTHX_ thread);
188 handle = thread->handle;
189 thread->handle = NULL;
191 MUTEX_UNLOCK(&thread->mutex);
192 MUTEX_DESTROY(&thread->mutex);
200 /* Call PerlMemShared_free() in the context of the "first" interpreter
201 * per http://www.nntp.perl.org/group/perl.perl5.porters/110772
203 aTHX = MY_POOL.main_thread.interp;
204 PerlMemShared_free(thread);
208 /* Warn if exiting with any unjoined threads */
216 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
217 veto_cleanup = (MY_POOL.running_threads || MY_POOL.joinable_threads);
218 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
221 if (ckWARN_d(WARN_THREADS)) {
222 Perl_warn(aTHX_ "Perl exited with active threads:\n\t%"
223 IVdf " running and unjoined\n\t%"
224 IVdf " finished and unjoined\n\t%"
225 IVdf " running and detached\n",
226 MY_POOL.running_threads,
227 MY_POOL.joinable_threads,
228 MY_POOL.detached_threads);
232 return (veto_cleanup);
235 /* Called on exit from main thread */
237 Perl_ithread_hook(pTHX)
240 return ((aTHX == MY_POOL.main_thread.interp) ? S_exit_warning(aTHX) : 0);
244 /* MAGIC (in mg.h sense) hooks */
247 ithread_mg_get(pTHX_ SV *sv, MAGIC *mg)
249 ithread *thread = (ithread *)mg->mg_ptr;
250 SvIV_set(sv, PTR2IV(thread));
256 ithread_mg_free(pTHX_ SV *sv, MAGIC *mg)
258 ithread *thread = (ithread *)mg->mg_ptr;
261 MUTEX_LOCK(&thread->mutex);
262 cleanup = ((--thread->count == 0) &&
263 (thread->state & PERL_ITHR_FINISHED) &&
264 (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)));
265 MUTEX_UNLOCK(&thread->mutex);
268 S_ithread_destruct(aTHX_ thread);
274 ithread_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
276 ithread *thread = (ithread *)mg->mg_ptr;
277 MUTEX_LOCK(&thread->mutex);
279 MUTEX_UNLOCK(&thread->mutex);
283 MGVTBL ithread_vtbl = {
284 ithread_mg_get, /* get */
288 ithread_mg_free, /* free */
290 ithread_mg_dup /* dup */
294 /* Provided default, minimum and rational stack sizes */
296 S_good_stack_size(pTHX_ IV stack_size)
300 /* Use default stack size if no stack size specified */
302 return (MY_POOL.default_stack_size);
305 #ifdef PTHREAD_STACK_MIN
306 /* Can't use less than minimum */
307 if (stack_size < PTHREAD_STACK_MIN) {
308 if (ckWARN(WARN_THREADS)) {
309 Perl_warn(aTHX_ "Using minimum thread stack size of %" IVdf, (IV)PTHREAD_STACK_MIN);
311 return (PTHREAD_STACK_MIN);
315 /* Round up to page size boundary */
316 if (MY_POOL.page_size <= 0) {
317 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
318 SETERRNO(0, SS_NORMAL);
320 MY_POOL.page_size = sysconf(_SC_PAGESIZE);
322 MY_POOL.page_size = sysconf(_SC_MMAP_PAGE_SIZE);
324 if ((long)MY_POOL.page_size < 0) {
326 SV * const error = get_sv("@", FALSE);
327 (void)SvUPGRADE(error, SVt_PV);
328 Perl_croak(aTHX_ "PANIC: sysconf: %s", SvPV_nolen(error));
330 Perl_croak(aTHX_ "PANIC: sysconf: pagesize unknown");
334 # ifdef HAS_GETPAGESIZE
335 MY_POOL.page_size = getpagesize();
337 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
338 MY_POOL.page_size = PAGESIZE;
340 MY_POOL.page_size = 8192; /* A conservative default */
343 if (MY_POOL.page_size <= 0) {
344 Perl_croak(aTHX_ "PANIC: bad pagesize %" IVdf, (IV)MY_POOL.page_size);
348 stack_size = ((stack_size + (MY_POOL.page_size - 1)) / MY_POOL.page_size) * MY_POOL.page_size;
354 /* Starts executing the thread.
355 * Passed as the C level function to run in the new thread.
358 STATIC THREAD_RET_TYPE
359 S_ithread_run(LPVOID arg)
362 S_ithread_run(void * arg)
365 ithread *thread = (ithread *)arg;
374 dTHXa(thread->interp);
378 /* Blocked until ->create() call finishes */
379 MUTEX_LOCK(&thread->mutex);
380 MUTEX_UNLOCK(&thread->mutex);
382 PERL_SET_CONTEXT(thread->interp);
383 S_ithread_set(aTHX_ thread);
385 PL_perl_destruct_level = 2;
388 AV *params = (AV *)SvRV(thread->params);
389 int len = (int)av_len(params)+1;
396 /* Put args on the stack */
398 for (ii=0; ii < len; ii++) {
399 XPUSHs(av_shift(params));
403 oldscope = PL_scopestack_ix;
406 /* Run the specified function */
407 len = (int)call_sv(thread->init_function, thread->gimme|G_EVAL);
408 } else if (jmp_rc == 2) {
411 exit_code = STATUS_CURRENT;
412 while (PL_scopestack_ix > oldscope) {
418 /* Remove args from stack and put back in params array */
420 for (ii=len-1; ii >= 0; ii--) {
423 av_store(params, ii, SvREFCNT_inc(sv));
430 /* Check for failure */
431 if (SvTRUE(ERRSV) && ckWARN_d(WARN_THREADS)) {
432 oldscope = PL_scopestack_ix;
435 /* Warn that thread died */
436 Perl_warn(aTHX_ "Thread %" UVuf " terminated abnormally: %" SVf, thread->tid, ERRSV);
437 } else if (jmp_rc == 2) {
438 /* Warn handler exited */
440 exit_code = STATUS_CURRENT;
441 while (PL_scopestack_ix > oldscope) {
448 /* Release function ref */
449 SvREFCNT_dec(thread->init_function);
450 thread->init_function = Nullsv;
453 PerlIO_flush((PerlIO *)NULL);
455 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
456 MUTEX_LOCK(&thread->mutex);
457 /* Mark as finished */
458 thread->state |= PERL_ITHR_FINISHED;
459 /* Clear exit flag if required */
460 if (thread->state & PERL_ITHR_THREAD_EXIT_ONLY) {
463 /* Cleanup if detached */
464 cleanup = (thread->state & PERL_ITHR_DETACHED);
465 MUTEX_UNLOCK(&thread->mutex);
467 /* Adjust thread status counts */
469 MY_POOL.detached_threads--;
471 MY_POOL.running_threads--;
472 MY_POOL.joinable_threads++;
474 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
476 /* Exit application if required */
478 oldscope = PL_scopestack_ix;
481 /* Warn if there are unjoined threads */
482 S_exit_warning(aTHX);
483 } else if (jmp_rc == 2) {
484 /* Warn handler exited */
485 exit_code = STATUS_CURRENT;
486 while (PL_scopestack_ix > oldscope) {
495 /* Clean up detached thread */
497 S_ithread_destruct(aTHX_ thread);
508 /* Type conversion helper functions */
511 S_ithread_to_SV(pTHX_ SV *obj, ithread *thread, char *classname, bool inc)
516 /* If incrementing thread ref count, then call within mutex lock */
518 MUTEX_LOCK(&thread->mutex);
520 MUTEX_UNLOCK(&thread->mutex);
527 sv = newSVrv(obj, classname);
528 sv_setiv(sv, PTR2IV(thread));
529 mg = sv_magicext(sv, Nullsv, PERL_MAGIC_shared_scalar, &ithread_vtbl, (char *)thread, 0);
530 mg->mg_flags |= MGf_DUP;
537 S_SV_to_ithread(pTHX_ SV *sv)
539 /* Argument is a thread */
541 return (INT2PTR(ithread *, SvIV(SvRV(sv))));
543 /* Argument is classname, therefore return current thread */
544 return (S_ithread_get(aTHX));
549 * Called in context of parent thread.
550 * Called with MY_POOL.create_destruct_mutex locked. (Unlocked on error.)
554 pTHX_ SV *init_function,
563 CLONE_PARAMS clone_param;
564 ithread *current_thread = S_ithread_get(aTHX);
566 SV **tmps_tmp = PL_tmps_stack;
567 IV tmps_ix = PL_tmps_ix;
569 int rc_stack_size = 0;
570 int rc_thread_create = 0;
573 /* Allocate thread structure in context of the main threads interpreter */
575 PERL_SET_CONTEXT(MY_POOL.main_thread.interp);
576 thread = (ithread *)PerlMemShared_malloc(sizeof(ithread));
578 PERL_SET_CONTEXT(aTHX);
580 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
581 PerlLIO_write(PerlIO_fileno(Perl_error_log), PL_no_mem, strlen(PL_no_mem));
584 Zero(thread, 1, ithread);
586 /* Add to threads list */
587 thread->next = &MY_POOL.main_thread;
588 thread->prev = MY_POOL.main_thread.prev;
589 MY_POOL.main_thread.prev = thread;
590 thread->prev->next = thread;
592 /* Set count to 1 immediately in case thread exits before
593 * we return to caller!
597 /* Block new thread until ->create() call finishes */
598 MUTEX_INIT(&thread->mutex);
599 MUTEX_LOCK(&thread->mutex);
601 thread->tid = MY_POOL.tid_counter++;
602 thread->stack_size = S_good_stack_size(aTHX_ stack_size);
603 thread->gimme = gimme;
604 thread->state = exit_opt;
606 /* "Clone" our interpreter into the thread's interpreter.
607 * This gives thread access to "static data" and code.
609 PerlIO_flush((PerlIO *)NULL);
610 S_ithread_set(aTHX_ thread);
612 SAVEBOOL(PL_srand_called); /* Save this so it becomes the correct value */
613 PL_srand_called = FALSE; /* Set it to false so we can detect if it gets
614 set during the clone */
617 thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE | CLONEf_CLONE_HOST);
619 thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE);
622 /* perl_clone() leaves us in new interpreter's context. As it is tricky
623 * to spot an implicit aTHX, create a new scope with aTHX matching the
624 * context for the duration of our work for new interpreter.
627 dTHXa(thread->interp);
631 /* Here we remove END blocks since they should only run in the thread
634 SvREFCNT_dec(PL_endav);
637 if (SvPOK(init_function)) {
638 thread->init_function = newSV(0);
639 sv_copypv(thread->init_function, init_function);
641 clone_param.flags = 0;
642 thread->init_function = sv_dup(init_function, &clone_param);
643 if (SvREFCNT(thread->init_function) == 0) {
644 SvREFCNT_inc_void(thread->init_function);
648 thread->params = sv_dup(params, &clone_param);
649 SvREFCNT_inc_void(thread->params);
651 /* The code below checks that anything living on the tmps stack and
652 * has been cloned (so it lives in the ptr_table) has a refcount
655 * If the refcount is 0 it means that a something on the stack/context
656 * was holding a reference to it and since we init_stacks() in
657 * perl_clone that won't get cleaned and we will get a leaked scalar.
658 * The reason it was cloned was that it lived on the @_ stack.
660 * Example of this can be found in bugreport 15837 where calls in the
661 * parameter list end up as a temp.
663 * One could argue that this fix should be in perl_clone.
665 while (tmps_ix > 0) {
666 SV* sv = (SV*)ptr_table_fetch(PL_ptr_table, tmps_tmp[tmps_ix]);
668 if (sv && SvREFCNT(sv) == 0) {
669 SvREFCNT_inc_void(sv);
674 SvTEMP_off(thread->init_function);
675 ptr_table_free(PL_ptr_table);
677 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
679 S_ithread_set(aTHX_ current_thread);
680 PERL_SET_CONTEXT(aTHX);
682 /* Create/start the thread */
684 thread->handle = CreateThread(NULL,
685 (DWORD)thread->stack_size,
688 STACK_SIZE_PARAM_IS_A_RESERVATION,
692 STATIC pthread_attr_t attr;
693 STATIC int attr_inited = 0;
694 STATIC int attr_joinable = PTHREAD_CREATE_JOINABLE;
696 pthread_attr_init(&attr);
700 # ifdef PTHREAD_ATTR_SETDETACHSTATE
701 /* Threads start out joinable */
702 PTHREAD_ATTR_SETDETACHSTATE(&attr, attr_joinable);
705 # ifdef _POSIX_THREAD_ATTR_STACKSIZE
706 /* Set thread's stack size */
707 if (thread->stack_size > 0) {
708 rc_stack_size = pthread_attr_setstacksize(&attr, (size_t)thread->stack_size);
712 /* Create the thread */
713 if (! rc_stack_size) {
714 # ifdef OLD_PTHREADS_API
715 rc_thread_create = pthread_create(&thread->thr,
720 # if defined(HAS_PTHREAD_ATTR_SETSCOPE) && defined(PTHREAD_SCOPE_SYSTEM)
721 pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM);
723 rc_thread_create = pthread_create(&thread->thr,
730 # ifdef _POSIX_THREAD_ATTR_STACKSIZE
731 /* Try to get thread's actual stack size */
735 stacksize = pthread_attr_getstacksize(attr);
737 if (! pthread_attr_getstacksize(&attr, &stacksize))
740 thread->stack_size = (IV)stacksize;
747 /* Check for errors */
749 if (thread->handle == NULL) {
751 if (rc_stack_size || rc_thread_create) {
753 /* Must unlock mutex for destruct call */
754 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
756 S_ithread_destruct(aTHX_ thread);
758 if (ckWARN_d(WARN_THREADS)) {
760 Perl_warn(aTHX_ "Thread creation failed: pthread_attr_setstacksize(%" IVdf ") returned %d", thread->stack_size, rc_stack_size);
762 Perl_warn(aTHX_ "Thread creation failed: pthread_create returned %d", rc_thread_create);
769 MY_POOL.running_threads++;
774 #endif /* USE_ITHREADS */
777 MODULE = threads PACKAGE = threads PREFIX = ithread_
787 SV *function_to_call;
793 SV *thread_exit_only;
799 if ((items >= 2) && SvROK(ST(1)) && SvTYPE(SvRV(ST(1)))==SVt_PVHV) {
801 Perl_croak(aTHX_ "Usage: threads->create(\\%specs, function, ...)");
803 specs = (HV*)SvRV(ST(1));
807 Perl_croak(aTHX_ "Usage: threads->create(function, ...)");
813 if (sv_isobject(ST(0))) {
815 classname = HvNAME(SvSTASH(SvRV(ST(0))));
816 thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
817 stack_size = thread->stack_size;
818 exit_opt = thread->state & PERL_ITHR_THREAD_EXIT_ONLY;
820 /* threads->create() */
821 classname = (char *)SvPV_nolen(ST(0));
822 stack_size = MY_POOL.default_stack_size;
823 thread_exit_only = get_sv("threads::thread_exit_only", TRUE);
824 exit_opt = (SvTRUE(thread_exit_only))
825 ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
828 function_to_call = ST(idx+1);
833 if (hv_exists(specs, "stack", 5)) {
834 stack_size = SvIV(*hv_fetch(specs, "stack", 5, 0));
835 } else if (hv_exists(specs, "stacksize", 9)) {
836 stack_size = SvIV(*hv_fetch(specs, "stacksize", 9, 0));
837 } else if (hv_exists(specs, "stack_size", 10)) {
838 stack_size = SvIV(*hv_fetch(specs, "stack_size", 10, 0));
842 if (hv_exists(specs, "context", 7)) {
843 str = (char *)SvPV_nolen(*hv_fetch(specs, "context", 7, 0));
858 Perl_croak(aTHX_ "Invalid context: %s", str);
860 } else if (hv_exists(specs, "array", 5)) {
861 if (SvTRUE(*hv_fetch(specs, "array", 5, 0))) {
864 } else if (hv_exists(specs, "scalar", 6)) {
865 if (SvTRUE(*hv_fetch(specs, "scalar", 6, 0))) {
868 } else if (hv_exists(specs, "void", 4)) {
869 if (SvTRUE(*hv_fetch(specs, "void", 4, 0))) {
874 /* exit => thread_only */
875 if (hv_exists(specs, "exit", 4)) {
876 str = (char *)SvPV_nolen(*hv_fetch(specs, "exit", 4, 0));
877 exit_opt = (*str == 't' || *str == 'T')
878 ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
882 context = GIMME_V; /* Implicit context */
884 context |= (GIMME_V & (~(G_ARRAY|G_SCALAR|G_VOID)));
890 for (ii=2; ii < items ; ii++) {
891 av_push(params, SvREFCNT_inc(ST(idx+ii)));
896 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
897 thread = S_ithread_create(aTHX_ function_to_call,
901 newRV_noinc((SV*)params));
903 XSRETURN_UNDEF; /* Mutex already unlocked */
905 ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, FALSE));
908 MUTEX_UNLOCK(&thread->mutex);
909 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
911 /* XSRETURN(1); - implied */
924 /* Class method only */
926 Perl_croak(aTHX_ "Usage: threads->list(...)");
928 classname = (char *)SvPV_nolen(ST(0));
930 /* Calling context */
931 list_context = (GIMME_V == G_ARRAY);
933 /* Running or joinable parameter */
935 want_running = SvTRUE(ST(1));
938 /* Walk through threads list */
939 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
940 for (thread = MY_POOL.main_thread.next;
941 thread != &MY_POOL.main_thread;
942 thread = thread->next)
944 /* Ignore detached or joined threads */
945 if (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)) {
949 /* Filter per parameter */
952 if (thread->state & PERL_ITHR_FINISHED) {
953 continue; /* Not running */
956 if (! (thread->state & PERL_ITHR_FINISHED)) {
957 continue; /* Still running - not joinable yet */
962 /* Push object on stack if list context */
964 XPUSHs(sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE)));
968 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
969 /* If scalar context, send back count */
970 if (! list_context) {
981 /* Class method only */
983 Perl_croak(aTHX_ "Usage: threads->self()");
985 classname = (char *)SvPV_nolen(ST(0));
987 thread = S_ithread_get(aTHX);
989 ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
990 /* XSRETURN(1); - implied */
998 thread = S_SV_to_ithread(aTHX_ ST(0));
999 XST_mUV(0, thread->tid);
1000 /* XSRETURN(1); - implied */
1018 /* Object method only */
1019 if (! sv_isobject(ST(0))) {
1020 Perl_croak(aTHX_ "Usage: $thr->join()");
1023 /* Check if the thread is joinable */
1024 thread = S_SV_to_ithread(aTHX_ ST(0));
1025 join_err = (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED));
1027 if (join_err & PERL_ITHR_DETACHED) {
1028 Perl_croak(aTHX_ "Cannot join a detached thread");
1030 Perl_croak(aTHX_ "Thread already joined");
1034 /* Join the thread */
1036 waitcode = WaitForSingleObject(thread->handle, INFINITE);
1038 pthread_join(thread->thr, &retval);
1041 MUTEX_LOCK(&thread->mutex);
1042 /* Mark as joined */
1043 thread->state |= PERL_ITHR_JOINED;
1045 /* Get the return value from the call_sv */
1048 PerlInterpreter *other_perl;
1049 CLONE_PARAMS clone_params;
1050 ithread *current_thread;
1052 params_copy = (AV *)SvRV(thread->params);
1053 other_perl = thread->interp;
1054 clone_params.stashes = newAV();
1055 clone_params.flags = CLONEf_JOIN_IN;
1056 PL_ptr_table = ptr_table_new();
1057 current_thread = S_ithread_get(aTHX);
1058 S_ithread_set(aTHX_ thread);
1059 /* Ensure 'meaningful' addresses retain their meaning */
1060 ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1061 ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1062 ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1063 params = (AV *)sv_dup((SV*)params_copy, &clone_params);
1064 S_ithread_set(aTHX_ current_thread);
1065 SvREFCNT_dec(clone_params.stashes);
1066 SvREFCNT_inc_void(params);
1067 ptr_table_free(PL_ptr_table);
1068 PL_ptr_table = NULL;
1071 /* We are finished with the thread */
1072 S_ithread_clear(aTHX_ thread);
1073 MUTEX_UNLOCK(&thread->mutex);
1075 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1076 if (! (thread->state & PERL_ITHR_DETACHED)) {
1077 MY_POOL.joinable_threads--;
1079 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1081 /* If no return values, then just return */
1086 /* Put return values on stack */
1087 len = (int)AvFILL(params);
1088 for (ii=0; ii <= len; ii++) {
1089 SV* param = av_shift(params);
1090 XPUSHs(sv_2mortal(param));
1093 /* Free return value array */
1094 SvREFCNT_dec(params);
1111 /* Check if the thread is detachable */
1112 thread = S_SV_to_ithread(aTHX_ ST(0));
1113 if ((detach_err = (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)))) {
1114 if (detach_err & PERL_ITHR_DETACHED) {
1115 Perl_croak(aTHX_ "Thread already detached");
1117 Perl_croak(aTHX_ "Cannot detach a joined thread");
1121 /* Detach the thread */
1122 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1123 MUTEX_LOCK(&thread->mutex);
1124 thread->state |= PERL_ITHR_DETACHED;
1126 /* Windows has no 'detach thread' function */
1128 PERL_THREAD_DETACH(thread->thr);
1130 /* Cleanup if finished */
1131 cleanup = (thread->state & PERL_ITHR_FINISHED);
1132 MUTEX_UNLOCK(&thread->mutex);
1135 MY_POOL.joinable_threads--;
1137 MY_POOL.running_threads--;
1138 MY_POOL.detached_threads++;
1140 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1143 S_ithread_destruct(aTHX_ thread);
1154 /* Must have safe signals */
1155 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) {
1156 Perl_croak(aTHX_ "Cannot signal threads without safe signals");
1159 /* Object method only */
1160 if (! sv_isobject(ST(0))) {
1161 Perl_croak(aTHX_ "Usage: $thr->kill('SIG...')");
1165 sig_name = SvPV_nolen(ST(1));
1166 if (isALPHA(*sig_name)) {
1167 if (*sig_name == 'S' && sig_name[1] == 'I' && sig_name[2] == 'G') {
1170 if ((signal = whichsig(sig_name)) < 0) {
1171 Perl_croak(aTHX_ "Unrecognized signal name: %s", sig_name);
1174 signal = SvIV(ST(1));
1177 /* Set the signal for the thread */
1178 thread = S_SV_to_ithread(aTHX_ ST(0));
1179 MUTEX_LOCK(&thread->mutex);
1180 if (thread->interp) {
1181 dTHXa(thread->interp);
1182 PL_psig_pend[signal]++;
1185 MUTEX_UNLOCK(&thread->mutex);
1187 /* Return the thread to allow for method chaining */
1189 /* XSRETURN(1); - implied */
1193 ithread_DESTROY(...)
1195 sv_unmagic(SvRV(ST(0)), PERL_MAGIC_shared_scalar);
1203 /* Compares TIDs to determine thread equality */
1204 if (sv_isobject(ST(0)) && sv_isobject(ST(1))) {
1205 ithread *thr1 = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1206 ithread *thr2 = INT2PTR(ithread *, SvIV(SvRV(ST(1))));
1207 are_equal = (thr1->tid == thr2->tid);
1212 /* Return 0 on false for backward compatibility */
1215 /* XSRETURN(1); - implied */
1227 /* Class method only */
1229 Perl_croak(aTHX_ "Usage: threads->object($tid)");
1231 classname = (char *)SvPV_nolen(ST(0));
1233 if ((items < 2) || ! SvOK(ST(1))) {
1237 /* threads->object($tid) */
1240 /* Walk through threads list */
1241 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1242 for (thread = MY_POOL.main_thread.next;
1243 thread != &MY_POOL.main_thread;
1244 thread = thread->next)
1247 if (thread->tid == tid) {
1248 /* Ignore if detached or joined */
1249 if (! (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED))) {
1250 /* Put object on stack */
1251 ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1257 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1262 /* XSRETURN(1); - implied */
1266 ithread__handle(...);
1270 thread = S_SV_to_ithread(aTHX_ ST(0));
1272 XST_mUV(0, PTR2UV(&thread->handle));
1274 XST_mUV(0, PTR2UV(&thread->thr));
1276 /* XSRETURN(1); - implied */
1280 ithread_get_stack_size(...)
1285 if (sv_isobject(ST(0))) {
1286 /* $thr->get_stack_size() */
1287 ithread *thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1288 stack_size = thread->stack_size;
1290 /* threads->get_stack_size() */
1291 stack_size = MY_POOL.default_stack_size;
1293 XST_mIV(0, stack_size);
1294 /* XSRETURN(1); - implied */
1298 ithread_set_stack_size(...)
1304 Perl_croak(aTHX_ "Usage: threads->set_stack_size($size)");
1306 if (sv_isobject(ST(0))) {
1307 Perl_croak(aTHX_ "Cannot change stack size of an existing thread");
1310 old_size = MY_POOL.default_stack_size;
1311 MY_POOL.default_stack_size = S_good_stack_size(aTHX_ SvIV(ST(1)));
1312 XST_mIV(0, old_size);
1313 /* XSRETURN(1); - implied */
1317 ithread_is_running(...)
1321 /* Object method only */
1322 if (! sv_isobject(ST(0))) {
1323 Perl_croak(aTHX_ "Usage: $thr->is_running()");
1326 thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1327 ST(0) = (thread->state & PERL_ITHR_FINISHED) ? &PL_sv_no : &PL_sv_yes;
1328 /* XSRETURN(1); - implied */
1332 ithread_is_detached(...)
1336 thread = S_SV_to_ithread(aTHX_ ST(0));
1337 ST(0) = (thread->state & PERL_ITHR_DETACHED) ? &PL_sv_yes : &PL_sv_no;
1338 /* XSRETURN(1); - implied */
1342 ithread_is_joinable(...)
1346 /* Object method only */
1347 if (! sv_isobject(ST(0))) {
1348 Perl_croak(aTHX_ "Usage: $thr->is_joinable()");
1351 thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1352 MUTEX_LOCK(&thread->mutex);
1353 ST(0) = ((thread->state & PERL_ITHR_FINISHED) &&
1354 ! (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)))
1355 ? &PL_sv_yes : &PL_sv_no;
1356 MUTEX_UNLOCK(&thread->mutex);
1357 /* XSRETURN(1); - implied */
1361 ithread_wantarray(...)
1365 thread = S_SV_to_ithread(aTHX_ ST(0));
1366 ST(0) = (thread->gimme & G_ARRAY) ? &PL_sv_yes :
1367 (thread->gimme & G_VOID) ? &PL_sv_undef
1368 /* G_SCALAR */ : &PL_sv_no;
1369 /* XSRETURN(1); - implied */
1373 ithread_set_thread_exit_only(...)
1378 Perl_croak(aTHX_ "Usage: ->set_thread_exit_only(boolean)");
1380 thread = S_SV_to_ithread(aTHX_ ST(0));
1381 MUTEX_LOCK(&thread->mutex);
1382 if (SvTRUE(ST(1))) {
1383 thread->state |= PERL_ITHR_THREAD_EXIT_ONLY;
1385 thread->state &= ~PERL_ITHR_THREAD_EXIT_ONLY;
1387 MUTEX_UNLOCK(&thread->mutex);
1389 #endif /* USE_ITHREADS */
1395 SV *my_pool_sv = *hv_fetch(PL_modglobal, MY_POOL_KEY,
1396 sizeof(MY_POOL_KEY)-1, TRUE);
1397 my_pool_t *my_poolp = (my_pool_t*)SvPVX(newSV(sizeof(my_pool_t)-1));
1401 Zero(my_poolp, 1, my_pool_t);
1402 sv_setuv(my_pool_sv, PTR2UV(my_poolp));
1404 PL_perl_destruct_level = 2;
1405 MUTEX_INIT(&MY_POOL.create_destruct_mutex);
1406 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1408 PL_threadhook = &Perl_ithread_hook;
1410 MY_POOL.tid_counter = 1;
1411 # ifdef THREAD_CREATE_NEEDS_STACK
1412 MY_POOL.default_stack_size = THREAD_CREATE_NEEDS_STACK;
1415 /* The 'main' thread is thread 0.
1416 * It is detached (unjoinable) and immortal.
1419 MUTEX_INIT(&MY_POOL.main_thread.mutex);
1421 /* Head of the threads list */
1422 MY_POOL.main_thread.next = &MY_POOL.main_thread;
1423 MY_POOL.main_thread.prev = &MY_POOL.main_thread;
1425 MY_POOL.main_thread.count = 1; /* Immortal */
1427 MY_POOL.main_thread.interp = aTHX;
1428 MY_POOL.main_thread.state = PERL_ITHR_DETACHED; /* Detached */
1429 MY_POOL.main_thread.stack_size = MY_POOL.default_stack_size;
1431 MY_POOL.main_thread.thr = GetCurrentThreadId();
1433 MY_POOL.main_thread.thr = pthread_self();
1436 S_ithread_set(aTHX_ &MY_POOL.main_thread);
1437 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1438 #endif /* USE_ITHREADS */