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
49 #define PERL_ITHR_JOINED 2
50 #define PERL_ITHR_FINISHED 4
51 #define PERL_ITHR_THREAD_EXIT_ONLY 8
52 #define PERL_ITHR_NONVIABLE 16
53 #define PERL_ITHR_DESTROYED 32
55 typedef struct _ithread {
56 struct _ithread *next; /* Next thread in the list */
57 struct _ithread *prev; /* Prev thread in the list */
58 PerlInterpreter *interp; /* The threads interpreter */
59 UV tid; /* Threads module's thread id */
60 perl_mutex mutex; /* Mutex for updating things in this struct */
61 int count; /* How many SVs have a reference to us */
62 int state; /* Detached, joined, finished, etc. */
63 int gimme; /* Context of create */
64 SV *init_function; /* Code to run */
65 SV *params; /* Args to pass function */
67 DWORD thr; /* OS's idea if thread id */
68 HANDLE handle; /* OS's waitable handle */
70 pthread_t thr; /* OS's handle for the thread */
76 #define MY_CXT_KEY "threads::_cxt" XS_VERSION
79 /* Used by Perl interpreter for thread context switching */
86 #define MY_POOL_KEY "threads::_pool" XS_VERSION
89 /* Structure for 'main' thread
90 * Also forms the 'base' for the doubly-linked list of threads */
93 /* Protects the creation and destruction of threads*/
94 perl_mutex create_destruct_mutex;
100 IV default_stack_size;
105 SV *my_pool_sv = *hv_fetch(PL_modglobal, MY_POOL_KEY, \
106 sizeof(MY_POOL_KEY)-1, TRUE); \
107 my_pool_t *my_poolp = INT2PTR(my_pool_t*, SvUV(my_pool_sv))
109 #define MY_POOL (*my_poolp)
112 /* Used by Perl interpreter for thread context switching */
114 S_ithread_set(pTHX_ ithread *thread)
117 MY_CXT.context = thread;
124 return (MY_CXT.context);
128 /* Free any data (such as the Perl interpreter) attached to an ithread
129 * structure. This is a bit like undef on SVs, where the SV isn't freed,
130 * but the PVX is. Must be called with thread->mutex already held.
133 S_ithread_clear(pTHX_ ithread *thread)
135 PerlInterpreter *interp;
137 assert(((thread->state & PERL_ITHR_FINISHED) &&
138 (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)))
140 (thread->state & PERL_ITHR_NONVIABLE));
142 interp = thread->interp;
146 PERL_SET_CONTEXT(interp);
147 S_ithread_set(aTHX_ thread);
149 SvREFCNT_dec(thread->params);
150 thread->params = Nullsv;
152 perl_destruct(interp);
154 thread->interp = NULL;
157 PERL_SET_CONTEXT(aTHX);
161 /* Free an ithread structure and any attached data if its count == 0 */
163 S_ithread_destruct(pTHX_ ithread *thread)
171 /* Determine if thread can be destroyed now */
172 MUTEX_LOCK(&thread->mutex);
173 if (thread->count != 0) {
175 } else if (thread->state & PERL_ITHR_DESTROYED) {
177 } else if (thread->state & PERL_ITHR_NONVIABLE) {
178 thread->state |= PERL_ITHR_DESTROYED;
180 } else if (! (thread->state & PERL_ITHR_FINISHED)) {
182 } else if (! (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED))) {
185 thread->state |= PERL_ITHR_DESTROYED;
188 MUTEX_UNLOCK(&thread->mutex);
189 if (! destroy) return;
191 /* Main thread (0) is immortal and should never get here */
192 assert(thread->tid != 0);
194 /* Remove from circular list of threads */
195 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
196 assert(thread->prev && thread->next);
197 thread->next->prev = thread->prev;
198 thread->prev->next = thread->next;
201 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
203 /* Thread is now disowned */
204 MUTEX_LOCK(&thread->mutex);
205 S_ithread_clear(aTHX_ thread);
208 handle = thread->handle;
209 thread->handle = NULL;
211 MUTEX_UNLOCK(&thread->mutex);
212 MUTEX_DESTROY(&thread->mutex);
220 /* Call PerlMemShared_free() in the context of the "first" interpreter
221 * per http://www.nntp.perl.org/group/perl.perl5.porters/110772
223 aTHX = MY_POOL.main_thread.interp;
224 PerlMemShared_free(thread);
228 /* Warn if exiting with any unjoined threads */
235 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
236 veto_cleanup = (MY_POOL.running_threads || MY_POOL.joinable_threads);
237 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
240 if (ckWARN_d(WARN_THREADS)) {
241 Perl_warn(aTHX_ "Perl exited with active threads:\n\t%"
242 IVdf " running and unjoined\n\t%"
243 IVdf " finished and unjoined\n\t%"
244 IVdf " running and detached\n",
245 MY_POOL.running_threads,
246 MY_POOL.joinable_threads,
247 MY_POOL.detached_threads);
251 return (veto_cleanup);
254 /* Called on exit from main thread */
256 Perl_ithread_hook(pTHX)
259 return ((aTHX == MY_POOL.main_thread.interp) ? S_exit_warning(aTHX) : 0);
263 /* MAGIC (in mg.h sense) hooks */
266 ithread_mg_get(pTHX_ SV *sv, MAGIC *mg)
268 ithread *thread = (ithread *)mg->mg_ptr;
269 SvIV_set(sv, PTR2IV(thread));
275 ithread_mg_free(pTHX_ SV *sv, MAGIC *mg)
277 ithread *thread = (ithread *)mg->mg_ptr;
279 MUTEX_LOCK(&thread->mutex);
281 MUTEX_UNLOCK(&thread->mutex);
283 /* Try to clean up thread */
284 S_ithread_destruct(aTHX_ thread);
290 ithread_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
292 ithread *thread = (ithread *)mg->mg_ptr;
293 MUTEX_LOCK(&thread->mutex);
295 MUTEX_UNLOCK(&thread->mutex);
299 MGVTBL ithread_vtbl = {
300 ithread_mg_get, /* get */
304 ithread_mg_free, /* free */
306 ithread_mg_dup /* dup */
310 /* Provided default, minimum and rational stack sizes */
312 S_good_stack_size(pTHX_ IV stack_size)
316 /* Use default stack size if no stack size specified */
318 return (MY_POOL.default_stack_size);
321 #ifdef PTHREAD_STACK_MIN
322 /* Can't use less than minimum */
323 if (stack_size < PTHREAD_STACK_MIN) {
324 if (ckWARN(WARN_THREADS)) {
325 Perl_warn(aTHX_ "Using minimum thread stack size of %" IVdf, (IV)PTHREAD_STACK_MIN);
327 return (PTHREAD_STACK_MIN);
331 /* Round up to page size boundary */
332 if (MY_POOL.page_size <= 0) {
333 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
334 SETERRNO(0, SS_NORMAL);
336 MY_POOL.page_size = sysconf(_SC_PAGESIZE);
338 MY_POOL.page_size = sysconf(_SC_MMAP_PAGE_SIZE);
340 if ((long)MY_POOL.page_size < 0) {
342 SV * const error = get_sv("@", FALSE);
343 (void)SvUPGRADE(error, SVt_PV);
344 Perl_croak(aTHX_ "PANIC: sysconf: %s", SvPV_nolen(error));
346 Perl_croak(aTHX_ "PANIC: sysconf: pagesize unknown");
350 # ifdef HAS_GETPAGESIZE
351 MY_POOL.page_size = getpagesize();
353 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
354 MY_POOL.page_size = PAGESIZE;
356 MY_POOL.page_size = 8192; /* A conservative default */
359 if (MY_POOL.page_size <= 0) {
360 Perl_croak(aTHX_ "PANIC: bad pagesize %" IVdf, (IV)MY_POOL.page_size);
364 stack_size = ((stack_size + (MY_POOL.page_size - 1)) / MY_POOL.page_size) * MY_POOL.page_size;
370 /* Starts executing the thread.
371 * Passed as the C level function to run in the new thread.
374 STATIC THREAD_RET_TYPE
375 S_ithread_run(LPVOID arg)
378 S_ithread_run(void * arg)
381 ithread *thread = (ithread *)arg;
389 dTHXa(thread->interp);
393 /* Blocked until ->create() call finishes */
394 MUTEX_LOCK(&thread->mutex);
395 MUTEX_UNLOCK(&thread->mutex);
397 PERL_SET_CONTEXT(thread->interp);
398 S_ithread_set(aTHX_ thread);
400 PL_perl_destruct_level = 2;
403 AV *params = (AV *)SvRV(thread->params);
404 int len = (int)av_len(params)+1;
411 /* Put args on the stack */
413 for (ii=0; ii < len; ii++) {
414 XPUSHs(av_shift(params));
418 oldscope = PL_scopestack_ix;
421 /* Run the specified function */
422 len = (int)call_sv(thread->init_function, thread->gimme|G_EVAL);
423 } else if (jmp_rc == 2) {
426 exit_code = STATUS_CURRENT;
427 while (PL_scopestack_ix > oldscope) {
433 /* Remove args from stack and put back in params array */
435 for (ii=len-1; ii >= 0; ii--) {
438 av_store(params, ii, SvREFCNT_inc(sv));
445 /* Check for failure */
446 if (SvTRUE(ERRSV) && ckWARN_d(WARN_THREADS)) {
447 oldscope = PL_scopestack_ix;
450 /* Warn that thread died */
451 Perl_warn(aTHX_ "Thread %" UVuf " terminated abnormally: %" SVf, thread->tid, ERRSV);
452 } else if (jmp_rc == 2) {
453 /* Warn handler exited */
455 exit_code = STATUS_CURRENT;
456 while (PL_scopestack_ix > oldscope) {
463 /* Release function ref */
464 SvREFCNT_dec(thread->init_function);
465 thread->init_function = Nullsv;
468 PerlIO_flush((PerlIO *)NULL);
470 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
471 MUTEX_LOCK(&thread->mutex);
472 /* Mark as finished */
473 thread->state |= PERL_ITHR_FINISHED;
474 /* Clear exit flag if required */
475 if (thread->state & PERL_ITHR_THREAD_EXIT_ONLY) {
479 /* Adjust thread status counts */
480 if (thread->state & PERL_ITHR_DETACHED) {
481 MY_POOL.detached_threads--;
483 MY_POOL.running_threads--;
484 MY_POOL.joinable_threads++;
486 MUTEX_UNLOCK(&thread->mutex);
487 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
489 /* Exit application if required */
491 oldscope = PL_scopestack_ix;
494 /* Warn if there are unjoined threads */
495 S_exit_warning(aTHX);
496 } else if (jmp_rc == 2) {
497 /* Warn handler exited */
498 exit_code = STATUS_CURRENT;
499 while (PL_scopestack_ix > oldscope) {
508 /* Try to clean up thread */
509 S_ithread_destruct(aTHX_ thread);
519 /* Type conversion helper functions */
522 S_ithread_to_SV(pTHX_ SV *obj, ithread *thread, char *classname, bool inc)
527 /* If incrementing thread ref count, then call within mutex lock */
529 MUTEX_LOCK(&thread->mutex);
531 MUTEX_UNLOCK(&thread->mutex);
538 sv = newSVrv(obj, classname);
539 sv_setiv(sv, PTR2IV(thread));
540 mg = sv_magicext(sv, Nullsv, PERL_MAGIC_shared_scalar, &ithread_vtbl, (char *)thread, 0);
541 mg->mg_flags |= MGf_DUP;
548 S_SV_to_ithread(pTHX_ SV *sv)
550 /* Argument is a thread */
552 return (INT2PTR(ithread *, SvIV(SvRV(sv))));
554 /* Argument is classname, therefore return current thread */
555 return (S_ithread_get(aTHX));
560 * Called in context of parent thread.
561 * Called with MY_POOL.create_destruct_mutex locked. (Unlocked on error.)
565 pTHX_ SV *init_function,
572 CLONE_PARAMS clone_param;
573 ithread *current_thread = S_ithread_get(aTHX);
575 SV **tmps_tmp = PL_tmps_stack;
576 IV tmps_ix = PL_tmps_ix;
578 int rc_stack_size = 0;
579 int rc_thread_create = 0;
583 /* Allocate thread structure in context of the main thread's interpreter */
585 PERL_SET_CONTEXT(MY_POOL.main_thread.interp);
586 thread = (ithread *)PerlMemShared_malloc(sizeof(ithread));
588 PERL_SET_CONTEXT(aTHX);
590 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
591 PerlLIO_write(PerlIO_fileno(Perl_error_log), PL_no_mem, strlen(PL_no_mem));
594 Zero(thread, 1, ithread);
596 /* Add to threads list */
597 thread->next = &MY_POOL.main_thread;
598 thread->prev = MY_POOL.main_thread.prev;
599 MY_POOL.main_thread.prev = thread;
600 thread->prev->next = thread;
602 /* Set count to 1 immediately in case thread exits before
603 * we return to caller!
607 /* Block new thread until ->create() call finishes */
608 MUTEX_INIT(&thread->mutex);
609 MUTEX_LOCK(&thread->mutex);
611 thread->tid = MY_POOL.tid_counter++;
612 thread->stack_size = S_good_stack_size(aTHX_ stack_size);
613 thread->gimme = gimme;
614 thread->state = exit_opt;
616 /* "Clone" our interpreter into the thread's interpreter.
617 * This gives thread access to "static data" and code.
619 PerlIO_flush((PerlIO *)NULL);
620 S_ithread_set(aTHX_ thread);
622 SAVEBOOL(PL_srand_called); /* Save this so it becomes the correct value */
623 PL_srand_called = FALSE; /* Set it to false so we can detect if it gets
624 set during the clone */
627 thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE | CLONEf_CLONE_HOST);
629 thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE);
632 /* perl_clone() leaves us in new interpreter's context. As it is tricky
633 * to spot an implicit aTHX, create a new scope with aTHX matching the
634 * context for the duration of our work for new interpreter.
637 dTHXa(thread->interp);
641 /* Here we remove END blocks since they should only run in the thread
644 SvREFCNT_dec(PL_endav);
647 clone_param.flags = 0;
648 if (SvPOK(init_function)) {
649 thread->init_function = newSV(0);
650 sv_copypv(thread->init_function, init_function);
652 thread->init_function = sv_dup(init_function, &clone_param);
653 if (SvREFCNT(thread->init_function) == 0) {
654 SvREFCNT_inc_void(thread->init_function);
658 thread->params = sv_dup(params, &clone_param);
659 SvREFCNT_inc_void(thread->params);
661 /* The code below checks that anything living on the tmps stack and
662 * has been cloned (so it lives in the ptr_table) has a refcount
665 * If the refcount is 0 it means that a something on the stack/context
666 * was holding a reference to it and since we init_stacks() in
667 * perl_clone that won't get cleaned and we will get a leaked scalar.
668 * The reason it was cloned was that it lived on the @_ stack.
670 * Example of this can be found in bugreport 15837 where calls in the
671 * parameter list end up as a temp.
673 * One could argue that this fix should be in perl_clone.
675 while (tmps_ix > 0) {
676 SV* sv = (SV*)ptr_table_fetch(PL_ptr_table, tmps_tmp[tmps_ix]);
678 if (sv && SvREFCNT(sv) == 0) {
679 SvREFCNT_inc_void(sv);
684 SvTEMP_off(thread->init_function);
685 ptr_table_free(PL_ptr_table);
687 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
689 S_ithread_set(aTHX_ current_thread);
690 PERL_SET_CONTEXT(aTHX);
692 /* Create/start the thread */
694 thread->handle = CreateThread(NULL,
695 (DWORD)thread->stack_size,
698 STACK_SIZE_PARAM_IS_A_RESERVATION,
702 STATIC pthread_attr_t attr;
703 STATIC int attr_inited = 0;
704 STATIC int attr_joinable = PTHREAD_CREATE_JOINABLE;
706 pthread_attr_init(&attr);
710 # ifdef PTHREAD_ATTR_SETDETACHSTATE
711 /* Threads start out joinable */
712 PTHREAD_ATTR_SETDETACHSTATE(&attr, attr_joinable);
715 # ifdef _POSIX_THREAD_ATTR_STACKSIZE
716 /* Set thread's stack size */
717 if (thread->stack_size > 0) {
718 rc_stack_size = pthread_attr_setstacksize(&attr, (size_t)thread->stack_size);
722 /* Create the thread */
723 if (! rc_stack_size) {
724 # ifdef OLD_PTHREADS_API
725 rc_thread_create = pthread_create(&thread->thr,
730 # if defined(HAS_PTHREAD_ATTR_SETSCOPE) && defined(PTHREAD_SCOPE_SYSTEM)
731 pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM);
733 rc_thread_create = pthread_create(&thread->thr,
740 # ifdef _POSIX_THREAD_ATTR_STACKSIZE
741 /* Try to get thread's actual stack size */
745 stacksize = pthread_attr_getstacksize(attr);
747 if (! pthread_attr_getstacksize(&attr, &stacksize))
750 thread->stack_size = (IV)stacksize;
757 /* Check for errors */
759 if (thread->handle == NULL) {
761 if (rc_stack_size || rc_thread_create) {
763 /* Must unlock mutex for destruct call */
764 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
766 thread->state |= PERL_ITHR_NONVIABLE;
767 S_ithread_destruct(aTHX_ thread);
769 if (ckWARN_d(WARN_THREADS)) {
771 Perl_warn(aTHX_ "Thread creation failed: pthread_attr_setstacksize(%" IVdf ") returned %d", thread->stack_size, rc_stack_size);
773 Perl_warn(aTHX_ "Thread creation failed: pthread_create returned %d", rc_thread_create);
780 MY_POOL.running_threads++;
785 #endif /* USE_ITHREADS */
788 MODULE = threads PACKAGE = threads PREFIX = ithread_
798 SV *function_to_call;
804 SV *thread_exit_only;
810 if ((items >= 2) && SvROK(ST(1)) && SvTYPE(SvRV(ST(1)))==SVt_PVHV) {
812 Perl_croak(aTHX_ "Usage: threads->create(\\%specs, function, ...)");
814 specs = (HV*)SvRV(ST(1));
818 Perl_croak(aTHX_ "Usage: threads->create(function, ...)");
824 if (sv_isobject(ST(0))) {
826 classname = HvNAME(SvSTASH(SvRV(ST(0))));
827 thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
828 stack_size = thread->stack_size;
829 exit_opt = thread->state & PERL_ITHR_THREAD_EXIT_ONLY;
831 /* threads->create() */
832 classname = (char *)SvPV_nolen(ST(0));
833 stack_size = MY_POOL.default_stack_size;
834 thread_exit_only = get_sv("threads::thread_exit_only", TRUE);
835 exit_opt = (SvTRUE(thread_exit_only))
836 ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
839 function_to_call = ST(idx+1);
844 if (hv_exists(specs, "stack", 5)) {
845 stack_size = SvIV(*hv_fetch(specs, "stack", 5, 0));
846 } else if (hv_exists(specs, "stacksize", 9)) {
847 stack_size = SvIV(*hv_fetch(specs, "stacksize", 9, 0));
848 } else if (hv_exists(specs, "stack_size", 10)) {
849 stack_size = SvIV(*hv_fetch(specs, "stack_size", 10, 0));
853 if (hv_exists(specs, "context", 7)) {
854 str = (char *)SvPV_nolen(*hv_fetch(specs, "context", 7, 0));
869 Perl_croak(aTHX_ "Invalid context: %s", str);
871 } else if (hv_exists(specs, "array", 5)) {
872 if (SvTRUE(*hv_fetch(specs, "array", 5, 0))) {
875 } else if (hv_exists(specs, "scalar", 6)) {
876 if (SvTRUE(*hv_fetch(specs, "scalar", 6, 0))) {
879 } else if (hv_exists(specs, "void", 4)) {
880 if (SvTRUE(*hv_fetch(specs, "void", 4, 0))) {
885 /* exit => thread_only */
886 if (hv_exists(specs, "exit", 4)) {
887 str = (char *)SvPV_nolen(*hv_fetch(specs, "exit", 4, 0));
888 exit_opt = (*str == 't' || *str == 'T')
889 ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
893 context = GIMME_V; /* Implicit context */
895 context |= (GIMME_V & (~(G_ARRAY|G_SCALAR|G_VOID)));
901 for (ii=2; ii < items ; ii++) {
902 av_push(params, SvREFCNT_inc(ST(idx+ii)));
907 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
908 thread = S_ithread_create(aTHX_ function_to_call,
912 newRV_noinc((SV*)params));
914 XSRETURN_UNDEF; /* Mutex already unlocked */
916 ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, FALSE));
917 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
920 MUTEX_UNLOCK(&thread->mutex);
922 /* XSRETURN(1); - implied */
932 int want_running = 0;
935 /* Class method only */
937 Perl_croak(aTHX_ "Usage: threads->list(...)");
939 classname = (char *)SvPV_nolen(ST(0));
941 /* Calling context */
942 list_context = (GIMME_V == G_ARRAY);
944 /* Running or joinable parameter */
946 want_running = SvTRUE(ST(1));
949 /* Walk through threads list */
950 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
951 for (thread = MY_POOL.main_thread.next;
952 thread != &MY_POOL.main_thread;
953 thread = thread->next)
955 /* Ignore detached or joined threads */
956 if (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)) {
960 /* Filter per parameter */
963 if (thread->state & PERL_ITHR_FINISHED) {
964 continue; /* Not running */
967 if (! (thread->state & PERL_ITHR_FINISHED)) {
968 continue; /* Still running - not joinable yet */
973 /* Push object on stack if list context */
975 XPUSHs(sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE)));
979 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
980 /* If scalar context, send back count */
981 if (! list_context) {
992 /* Class method only */
993 if ((items != 1) || SvROK(ST(0))) {
994 Perl_croak(aTHX_ "Usage: threads->self()");
996 classname = (char *)SvPV_nolen(ST(0));
998 thread = S_ithread_get(aTHX);
1000 ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1001 /* XSRETURN(1); - implied */
1009 PERL_UNUSED_VAR(items);
1010 thread = S_SV_to_ithread(aTHX_ ST(0));
1011 XST_mUV(0, thread->tid);
1012 /* XSRETURN(1); - implied */
1030 /* Object method only */
1031 if ((items != 1) || ! sv_isobject(ST(0))) {
1032 Perl_croak(aTHX_ "Usage: $thr->join()");
1035 /* Check if the thread is joinable */
1036 thread = S_SV_to_ithread(aTHX_ ST(0));
1037 join_err = (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED));
1039 if (join_err & PERL_ITHR_DETACHED) {
1040 Perl_croak(aTHX_ "Cannot join a detached thread");
1042 Perl_croak(aTHX_ "Thread already joined");
1046 /* Join the thread */
1048 waitcode = WaitForSingleObject(thread->handle, INFINITE);
1050 pthread_join(thread->thr, &retval);
1053 MUTEX_LOCK(&thread->mutex);
1054 /* Mark as joined */
1055 thread->state |= PERL_ITHR_JOINED;
1057 /* Get the return value from the call_sv */
1060 PerlInterpreter *other_perl;
1061 CLONE_PARAMS clone_params;
1062 ithread *current_thread;
1064 params_copy = (AV *)SvRV(thread->params);
1065 other_perl = thread->interp;
1066 clone_params.stashes = newAV();
1067 clone_params.flags = CLONEf_JOIN_IN;
1068 PL_ptr_table = ptr_table_new();
1069 current_thread = S_ithread_get(aTHX);
1070 S_ithread_set(aTHX_ thread);
1071 /* Ensure 'meaningful' addresses retain their meaning */
1072 ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1073 ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1074 ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1075 params = (AV *)sv_dup((SV*)params_copy, &clone_params);
1076 S_ithread_set(aTHX_ current_thread);
1077 SvREFCNT_dec(clone_params.stashes);
1078 SvREFCNT_inc_void(params);
1079 ptr_table_free(PL_ptr_table);
1080 PL_ptr_table = NULL;
1083 /* We are finished with the thread */
1084 S_ithread_clear(aTHX_ thread);
1085 MUTEX_UNLOCK(&thread->mutex);
1087 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1088 if (! (thread->state & PERL_ITHR_DETACHED)) {
1089 MY_POOL.joinable_threads--;
1091 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1093 /* If no return values, then just return */
1098 /* Put return values on stack */
1099 len = (int)AvFILL(params);
1100 for (ii=0; ii <= len; ii++) {
1101 SV* param = av_shift(params);
1102 XPUSHs(sv_2mortal(param));
1105 /* Free return value array */
1106 SvREFCNT_dec(params);
1112 PERL_UNUSED_VAR(items);
1123 PERL_UNUSED_VAR(items);
1125 /* Check if the thread is detachable */
1126 thread = S_SV_to_ithread(aTHX_ ST(0));
1127 if ((detach_err = (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)))) {
1128 if (detach_err & PERL_ITHR_DETACHED) {
1129 Perl_croak(aTHX_ "Thread already detached");
1131 Perl_croak(aTHX_ "Cannot detach a joined thread");
1135 /* Detach the thread */
1136 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1137 MUTEX_LOCK(&thread->mutex);
1138 thread->state |= PERL_ITHR_DETACHED;
1140 /* Windows has no 'detach thread' function */
1142 PERL_THREAD_DETACH(thread->thr);
1145 if (thread->state & PERL_ITHR_FINISHED) {
1146 MY_POOL.joinable_threads--;
1148 MY_POOL.running_threads--;
1149 MY_POOL.detached_threads++;
1151 MUTEX_UNLOCK(&thread->mutex);
1152 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1154 /* Try to cleanup thread */
1155 S_ithread_destruct(aTHX_ thread);
1165 /* Must have safe signals */
1166 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) {
1167 Perl_croak(aTHX_ "Cannot signal threads without safe signals");
1170 /* Object method only */
1171 if ((items != 2) || ! sv_isobject(ST(0))) {
1172 Perl_croak(aTHX_ "Usage: $thr->kill('SIG...')");
1176 sig_name = SvPV_nolen(ST(1));
1177 if (isALPHA(*sig_name)) {
1178 if (*sig_name == 'S' && sig_name[1] == 'I' && sig_name[2] == 'G') {
1181 if ((signal = whichsig(sig_name)) < 0) {
1182 Perl_croak(aTHX_ "Unrecognized signal name: %s", sig_name);
1185 signal = SvIV(ST(1));
1188 /* Set the signal for the thread */
1189 thread = S_SV_to_ithread(aTHX_ ST(0));
1190 MUTEX_LOCK(&thread->mutex);
1191 if (thread->interp) {
1192 dTHXa(thread->interp);
1193 PL_psig_pend[signal]++;
1196 MUTEX_UNLOCK(&thread->mutex);
1198 /* Return the thread to allow for method chaining */
1200 /* XSRETURN(1); - implied */
1204 ithread_DESTROY(...)
1206 PERL_UNUSED_VAR(items);
1207 sv_unmagic(SvRV(ST(0)), PERL_MAGIC_shared_scalar);
1215 PERL_UNUSED_VAR(items);
1217 /* Compares TIDs to determine thread equality */
1218 if (sv_isobject(ST(0)) && sv_isobject(ST(1))) {
1219 ithread *thr1 = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1220 ithread *thr2 = INT2PTR(ithread *, SvIV(SvRV(ST(1))));
1221 are_equal = (thr1->tid == thr2->tid);
1226 /* Return 0 on false for backward compatibility */
1229 /* XSRETURN(1); - implied */
1241 /* Class method only */
1243 Perl_croak(aTHX_ "Usage: threads->object($tid)");
1245 classname = (char *)SvPV_nolen(ST(0));
1247 if ((items < 2) || ! SvOK(ST(1))) {
1251 /* threads->object($tid) */
1254 /* Walk through threads list */
1255 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1256 for (thread = MY_POOL.main_thread.next;
1257 thread != &MY_POOL.main_thread;
1258 thread = thread->next)
1261 if (thread->tid == tid) {
1262 /* Ignore if detached or joined */
1263 if (! (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED))) {
1264 /* Put object on stack */
1265 ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1271 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1276 /* XSRETURN(1); - implied */
1280 ithread__handle(...);
1284 PERL_UNUSED_VAR(items);
1285 thread = S_SV_to_ithread(aTHX_ ST(0));
1287 XST_mUV(0, PTR2UV(&thread->handle));
1289 XST_mUV(0, PTR2UV(&thread->thr));
1291 /* XSRETURN(1); - implied */
1295 ithread_get_stack_size(...)
1300 PERL_UNUSED_VAR(items);
1301 if (sv_isobject(ST(0))) {
1302 /* $thr->get_stack_size() */
1303 ithread *thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1304 stack_size = thread->stack_size;
1306 /* threads->get_stack_size() */
1307 stack_size = MY_POOL.default_stack_size;
1309 XST_mIV(0, stack_size);
1310 /* XSRETURN(1); - implied */
1314 ithread_set_stack_size(...)
1320 Perl_croak(aTHX_ "Usage: threads->set_stack_size($size)");
1322 if (sv_isobject(ST(0))) {
1323 Perl_croak(aTHX_ "Cannot change stack size of an existing thread");
1326 old_size = MY_POOL.default_stack_size;
1327 MY_POOL.default_stack_size = S_good_stack_size(aTHX_ SvIV(ST(1)));
1328 XST_mIV(0, old_size);
1329 /* XSRETURN(1); - implied */
1333 ithread_is_running(...)
1337 /* Object method only */
1338 if ((items != 1) || ! sv_isobject(ST(0))) {
1339 Perl_croak(aTHX_ "Usage: $thr->is_running()");
1342 thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1343 ST(0) = (thread->state & PERL_ITHR_FINISHED) ? &PL_sv_no : &PL_sv_yes;
1344 /* XSRETURN(1); - implied */
1348 ithread_is_detached(...)
1352 PERL_UNUSED_VAR(items);
1353 thread = S_SV_to_ithread(aTHX_ ST(0));
1354 ST(0) = (thread->state & PERL_ITHR_DETACHED) ? &PL_sv_yes : &PL_sv_no;
1355 /* XSRETURN(1); - implied */
1359 ithread_is_joinable(...)
1363 /* Object method only */
1364 if ((items != 1) || ! sv_isobject(ST(0))) {
1365 Perl_croak(aTHX_ "Usage: $thr->is_joinable()");
1368 thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1369 MUTEX_LOCK(&thread->mutex);
1370 ST(0) = ((thread->state & PERL_ITHR_FINISHED) &&
1371 ! (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)))
1372 ? &PL_sv_yes : &PL_sv_no;
1373 MUTEX_UNLOCK(&thread->mutex);
1374 /* XSRETURN(1); - implied */
1378 ithread_wantarray(...)
1382 PERL_UNUSED_VAR(items);
1383 thread = S_SV_to_ithread(aTHX_ ST(0));
1384 ST(0) = (thread->gimme & G_ARRAY) ? &PL_sv_yes :
1385 (thread->gimme & G_VOID) ? &PL_sv_undef
1386 /* G_SCALAR */ : &PL_sv_no;
1387 /* XSRETURN(1); - implied */
1391 ithread_set_thread_exit_only(...)
1396 Perl_croak(aTHX_ "Usage: ->set_thread_exit_only(boolean)");
1398 thread = S_SV_to_ithread(aTHX_ ST(0));
1399 MUTEX_LOCK(&thread->mutex);
1400 if (SvTRUE(ST(1))) {
1401 thread->state |= PERL_ITHR_THREAD_EXIT_ONLY;
1403 thread->state &= ~PERL_ITHR_THREAD_EXIT_ONLY;
1405 MUTEX_UNLOCK(&thread->mutex);
1407 #endif /* USE_ITHREADS */
1413 SV *my_pool_sv = *hv_fetch(PL_modglobal, MY_POOL_KEY,
1414 sizeof(MY_POOL_KEY)-1, TRUE);
1415 my_pool_t *my_poolp = (my_pool_t*)SvPVX(newSV(sizeof(my_pool_t)-1));
1419 Zero(my_poolp, 1, my_pool_t);
1420 sv_setuv(my_pool_sv, PTR2UV(my_poolp));
1422 PL_perl_destruct_level = 2;
1423 MUTEX_INIT(&MY_POOL.create_destruct_mutex);
1424 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1426 PL_threadhook = &Perl_ithread_hook;
1428 MY_POOL.tid_counter = 1;
1429 # ifdef THREAD_CREATE_NEEDS_STACK
1430 MY_POOL.default_stack_size = THREAD_CREATE_NEEDS_STACK;
1433 /* The 'main' thread is thread 0.
1434 * It is detached (unjoinable) and immortal.
1437 MUTEX_INIT(&MY_POOL.main_thread.mutex);
1439 /* Head of the threads list */
1440 MY_POOL.main_thread.next = &MY_POOL.main_thread;
1441 MY_POOL.main_thread.prev = &MY_POOL.main_thread;
1443 MY_POOL.main_thread.count = 1; /* Immortal */
1445 MY_POOL.main_thread.interp = aTHX;
1446 MY_POOL.main_thread.state = PERL_ITHR_DETACHED; /* Detached */
1447 MY_POOL.main_thread.stack_size = MY_POOL.default_stack_size;
1449 MY_POOL.main_thread.thr = GetCurrentThreadId();
1451 MY_POOL.main_thread.thr = pthread_self();
1454 S_ithread_set(aTHX_ &MY_POOL.main_thread);
1455 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1456 #endif /* USE_ITHREADS */