This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fix various compiler warnings from XS code
[perl5.git] / dist / threads / threads.xs
1 #define PERL_NO_GET_CONTEXT
2 /* Workaround for mingw 32-bit compiler by mingw-w64.sf.net - has to come before any #include.
3  * It also defines USE_NO_MINGW_SETJMP_TWO_ARGS for the mingw.org 32-bit compilers ... but
4  * that's ok as that compiler makes no use of that symbol anyway */
5 #if defined(WIN32) && defined(__MINGW32__) && !defined(__MINGW64__)
6 #  define USE_NO_MINGW_SETJMP_TWO_ARGS 1
7 #endif
8 #include "EXTERN.h"
9 #include "perl.h"
10 #include "XSUB.h"
11 /* Workaround for XSUB.h bug under WIN32 */
12 #ifdef WIN32
13 #  undef setjmp
14 #  if defined(USE_NO_MINGW_SETJMP_TWO_ARGS) || (!defined(__BORLANDC__) && !defined(__MINGW64__))
15 #    define setjmp(x) _setjmp(x)
16 #  endif
17 #endif
18 #ifdef HAS_PPPORT_H
19 #  define NEED_PL_signals
20 #  define NEED_newRV_noinc
21 #  define NEED_sv_2pv_flags
22 #  include "ppport.h"
23 #  include "threads.h"
24 #endif
25
26 #ifdef USE_ITHREADS
27
28 #ifdef WIN32
29 #  include <windows.h>
30    /* Supposed to be in Winbase.h */
31 #  ifndef STACK_SIZE_PARAM_IS_A_RESERVATION
32 #    define STACK_SIZE_PARAM_IS_A_RESERVATION 0x00010000
33 #  endif
34 #  include <win32thread.h>
35 #else
36 #  ifdef OS2
37 typedef perl_os_thread pthread_t;
38 #  else
39 #    include <pthread.h>
40 #  endif
41 #  include <thread.h>
42 #  define PERL_THREAD_SETSPECIFIC(k,v) pthread_setspecific(k,v)
43 #  ifdef OLD_PTHREADS_API
44 #    define PERL_THREAD_DETACH(t) pthread_detach(&(t))
45 #  else
46 #    define PERL_THREAD_DETACH(t) pthread_detach((t))
47 #  endif
48 #endif
49 #if !defined(HAS_GETPAGESIZE) && defined(I_SYS_PARAM)
50 #  include <sys/param.h>
51 #endif
52
53 /* Values for 'state' member */
54 #define PERL_ITHR_DETACHED           1 /* Thread has been detached */
55 #define PERL_ITHR_JOINED             2 /* Thread is being / has been joined */
56 #define PERL_ITHR_FINISHED           4 /* Thread has finished execution */
57 #define PERL_ITHR_THREAD_EXIT_ONLY   8 /* exit() only exits current thread */
58 #define PERL_ITHR_NONVIABLE         16 /* Thread creation failed */
59 #define PERL_ITHR_DIED              32 /* Thread finished by dying */
60
61 #define PERL_ITHR_UNCALLABLE  (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)
62
63
64 typedef struct _ithread {
65     struct _ithread *next;      /* Next thread in the list */
66     struct _ithread *prev;      /* Prev thread in the list */
67     PerlInterpreter *interp;    /* The threads interpreter */
68     UV tid;                     /* Threads module's thread id */
69     perl_mutex mutex;           /* Mutex for updating things in this struct */
70     int count;                  /* Reference count. See S_ithread_create. */
71     int state;                  /* Detached, joined, finished, etc. */
72     int gimme;                  /* Context of create */
73     SV *init_function;          /* Code to run */
74     AV *params;                 /* Args to pass function */
75 #ifdef WIN32
76     DWORD  thr;                 /* OS's idea if thread id */
77     HANDLE handle;              /* OS's waitable handle */
78 #else
79     pthread_t thr;              /* OS's handle for the thread */
80 #endif
81     IV stack_size;
82     SV *err;                    /* Error from abnormally terminated thread */
83     char *err_class;            /* Error object's classname if applicable */
84 #ifndef WIN32
85     sigset_t initial_sigmask;   /* Thread wakes up with signals blocked */
86 #endif
87 } ithread;
88
89
90 #define MY_CXT_KEY "threads::_cxt" XS_VERSION
91
92 typedef struct {
93     /* Used by Perl interpreter for thread context switching */
94     ithread *context;
95 } my_cxt_t;
96
97 START_MY_CXT
98
99
100 #define MY_POOL_KEY "threads::_pool" XS_VERSION
101
102 typedef struct {
103     /* Structure for 'main' thread
104      * Also forms the 'base' for the doubly-linked list of threads */
105     ithread main_thread;
106
107     /* Protects the creation and destruction of threads*/
108     perl_mutex create_destruct_mutex;
109
110     UV tid_counter;
111     IV joinable_threads;
112     IV running_threads;
113     IV detached_threads;
114     IV total_threads;
115     IV default_stack_size;
116     IV page_size;
117 } my_pool_t;
118
119 #define dMY_POOL \
120     SV *my_pool_sv = *hv_fetch(PL_modglobal, MY_POOL_KEY,               \
121                                sizeof(MY_POOL_KEY)-1, TRUE);            \
122     my_pool_t *my_poolp = INT2PTR(my_pool_t*, SvUV(my_pool_sv))
123
124 #define MY_POOL (*my_poolp)
125
126 #ifndef WIN32
127 /* Block most signals for calling thread, setting the old signal mask to
128  * oldmask, if it is not NULL */
129 STATIC int
130 S_block_most_signals(sigset_t *oldmask)
131 {
132     sigset_t newmask;
133
134     sigfillset(&newmask);
135     /* Don't block certain "important" signals (stolen from mg.c) */
136 #ifdef SIGILL
137     sigdelset(&newmask, SIGILL);
138 #endif
139 #ifdef SIGBUS
140     sigdelset(&newmask, SIGBUS);
141 #endif
142 #ifdef SIGSEGV
143     sigdelset(&newmask, SIGSEGV);
144 #endif
145
146 #if defined(VMS)
147     /* no per-thread blocking available */
148     return sigprocmask(SIG_BLOCK, &newmask, oldmask);
149 #else
150     return pthread_sigmask(SIG_BLOCK, &newmask, oldmask);
151 #endif /* VMS */
152 }
153
154 /* Set the signal mask for this thread to newmask */
155 STATIC int
156 S_set_sigmask(sigset_t *newmask)
157 {
158 #if defined(VMS)
159     return sigprocmask(SIG_SETMASK, newmask, NULL);
160 #else
161     return pthread_sigmask(SIG_SETMASK, newmask, NULL);
162 #endif /* VMS */
163 }
164 #endif /* WIN32 */
165
166 /* Used by Perl interpreter for thread context switching */
167 STATIC void
168 S_ithread_set(pTHX_ ithread *thread)
169 {
170     dMY_CXT;
171     MY_CXT.context = thread;
172 }
173
174 STATIC ithread *
175 S_ithread_get(pTHX)
176 {
177     dMY_CXT;
178     return (MY_CXT.context);
179 }
180
181
182 /* Free any data (such as the Perl interpreter) attached to an ithread
183  * structure.  This is a bit like undef on SVs, where the SV isn't freed,
184  * but the PVX is.  Must be called with thread->mutex already locked.  Also,
185  * must be called with MY_POOL.create_destruct_mutex unlocked as destruction
186  * of the interpreter can lead to recursive destruction calls that could
187  * lead to a deadlock on that mutex.
188  */
189 STATIC void
190 S_ithread_clear(pTHX_ ithread *thread)
191 {
192     PerlInterpreter *interp;
193 #ifndef WIN32
194     sigset_t origmask;
195 #endif
196
197     assert(((thread->state & PERL_ITHR_FINISHED) &&
198             (thread->state & PERL_ITHR_UNCALLABLE))
199                 ||
200            (thread->state & PERL_ITHR_NONVIABLE));
201
202 #ifndef WIN32
203     /* We temporarily set the interpreter context to the interpreter being
204      * destroyed.  It's in no condition to handle signals while it's being
205      * taken apart.
206      */
207     S_block_most_signals(&origmask);
208 #endif
209
210     interp = thread->interp;
211     if (interp) {
212         dTHXa(interp);
213
214         PERL_SET_CONTEXT(interp);
215         S_ithread_set(aTHX_ thread);
216
217         SvREFCNT_dec(thread->params);
218         thread->params = NULL;
219
220         if (thread->err) {
221             SvREFCNT_dec(thread->err);
222             thread->err = Nullsv;
223         }
224
225         perl_destruct(interp);
226         perl_free(interp);
227         thread->interp = NULL;
228     }
229
230     PERL_SET_CONTEXT(aTHX);
231 #ifndef WIN32
232     S_set_sigmask(&origmask);
233 #endif
234 }
235
236
237 /* Decrement the refcount of an ithread, and if it reaches zero, free it.
238  * Must be called with the mutex held.
239  * On return, mutex is released (or destroyed).
240  */
241 STATIC void
242 S_ithread_free(pTHX_ ithread *thread)
243 {
244 #ifdef WIN32
245     HANDLE handle;
246 #endif
247     dMY_POOL;
248
249     if (! (thread->state & PERL_ITHR_NONVIABLE)) {
250         assert(thread->count > 0);
251         if (--thread->count > 0) {
252             MUTEX_UNLOCK(&thread->mutex);
253             return;
254         }
255         assert((thread->state & PERL_ITHR_FINISHED) &&
256                (thread->state & PERL_ITHR_UNCALLABLE));
257     }
258     MUTEX_UNLOCK(&thread->mutex);
259
260     /* Main thread (0) is immortal and should never get here */
261     assert(thread->tid != 0);
262
263     /* Remove from circular list of threads */
264     MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
265     assert(thread->prev && thread->next);
266     thread->next->prev = thread->prev;
267     thread->prev->next = thread->next;
268     thread->next = NULL;
269     thread->prev = NULL;
270     MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
271
272     /* Thread is now disowned */
273     MUTEX_LOCK(&thread->mutex);
274     S_ithread_clear(aTHX_ thread);
275
276 #ifdef WIN32
277     handle = thread->handle;
278     thread->handle = NULL;
279 #endif
280     MUTEX_UNLOCK(&thread->mutex);
281     MUTEX_DESTROY(&thread->mutex);
282
283 #ifdef WIN32
284     if (handle) {
285         CloseHandle(handle);
286     }
287 #endif
288
289     PerlMemShared_free(thread);
290
291     /* total_threads >= 1 is used to veto cleanup by the main thread,
292      * should it happen to exit while other threads still exist.
293      * Decrement this as the very last thing in the thread's existence.
294      * Otherwise, MY_POOL and global state such as PL_op_mutex may get
295      * freed while we're still using it.
296      */
297     MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
298     MY_POOL.total_threads--;
299     MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
300 }
301
302
303 static void
304 S_ithread_count_inc(pTHX_ ithread *thread)
305 {
306     MUTEX_LOCK(&thread->mutex);
307     thread->count++;
308     MUTEX_UNLOCK(&thread->mutex);
309 }
310
311
312 /* Warn if exiting with any unjoined threads */
313 STATIC int
314 S_exit_warning(pTHX)
315 {
316     int veto_cleanup, warn;
317     dMY_POOL;
318
319     MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
320     veto_cleanup = (MY_POOL.total_threads > 0);
321     warn         = (MY_POOL.running_threads || MY_POOL.joinable_threads);
322     MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
323
324     if (warn) {
325         if (ckWARN_d(WARN_THREADS)) {
326             Perl_warn(aTHX_ "Perl exited with active threads:\n\t%"
327                             IVdf " running and unjoined\n\t%"
328                             IVdf " finished and unjoined\n\t%"
329                             IVdf " running and detached\n",
330                             MY_POOL.running_threads,
331                             MY_POOL.joinable_threads,
332                             MY_POOL.detached_threads);
333         }
334     }
335
336     return (veto_cleanup);
337 }
338
339
340 /* Called from perl_destruct() in each thread.  If it's the main thread,
341  * stop it from freeing everything if there are other threads still running.
342  */
343 int
344 Perl_ithread_hook(pTHX)
345 {
346     dMY_POOL;
347     return ((aTHX == MY_POOL.main_thread.interp) ? S_exit_warning(aTHX) : 0);
348 }
349
350
351 /* MAGIC (in mg.h sense) hooks */
352
353 int
354 ithread_mg_get(pTHX_ SV *sv, MAGIC *mg)
355 {
356     ithread *thread = (ithread *)mg->mg_ptr;
357     SvIV_set(sv, PTR2IV(thread));
358     SvIOK_on(sv);
359     return (0);
360 }
361
362 int
363 ithread_mg_free(pTHX_ SV *sv, MAGIC *mg)
364 {
365     ithread *thread = (ithread *)mg->mg_ptr;
366     PERL_UNUSED_ARG(sv);
367     MUTEX_LOCK(&thread->mutex);
368     S_ithread_free(aTHX_ thread);   /* Releases MUTEX */
369     return (0);
370 }
371
372 int
373 ithread_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
374 {
375     PERL_UNUSED_ARG(param);
376     S_ithread_count_inc(aTHX_ (ithread *)mg->mg_ptr);
377     return (0);
378 }
379
380 MGVTBL ithread_vtbl = {
381     ithread_mg_get,     /* get */
382     0,                  /* set */
383     0,                  /* len */
384     0,                  /* clear */
385     ithread_mg_free,    /* free */
386     0,                  /* copy */
387     ithread_mg_dup      /* dup */
388 };
389
390
391 /* Provided default, minimum and rational stack sizes */
392 STATIC IV
393 S_good_stack_size(pTHX_ IV stack_size)
394 {
395     dMY_POOL;
396
397     /* Use default stack size if no stack size specified */
398     if (! stack_size) {
399         return (MY_POOL.default_stack_size);
400     }
401
402 #ifdef PTHREAD_STACK_MIN
403     /* Can't use less than minimum */
404     if (stack_size < PTHREAD_STACK_MIN) {
405         if (ckWARN(WARN_THREADS)) {
406             Perl_warn(aTHX_ "Using minimum thread stack size of %" IVdf, (IV)PTHREAD_STACK_MIN);
407         }
408         return (PTHREAD_STACK_MIN);
409     }
410 #endif
411
412     /* Round up to page size boundary */
413     if (MY_POOL.page_size <= 0) {
414 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
415         SETERRNO(0, SS_NORMAL);
416 #  ifdef _SC_PAGESIZE
417         MY_POOL.page_size = sysconf(_SC_PAGESIZE);
418 #  else
419         MY_POOL.page_size = sysconf(_SC_MMAP_PAGE_SIZE);
420 #  endif
421         if ((long)MY_POOL.page_size < 0) {
422             if (errno) {
423                 SV * const error = get_sv("@", 0);
424                 (void)SvUPGRADE(error, SVt_PV);
425                 Perl_croak(aTHX_ "PANIC: sysconf: %s", SvPV_nolen(error));
426             } else {
427                 Perl_croak(aTHX_ "PANIC: sysconf: pagesize unknown");
428             }
429         }
430 #else
431 #  ifdef HAS_GETPAGESIZE
432         MY_POOL.page_size = getpagesize();
433 #  else
434 #    if defined(I_SYS_PARAM) && defined(PAGESIZE)
435         MY_POOL.page_size = PAGESIZE;
436 #    else
437         MY_POOL.page_size = 8192;   /* A conservative default */
438 #    endif
439 #  endif
440         if (MY_POOL.page_size <= 0) {
441             Perl_croak(aTHX_ "PANIC: bad pagesize %" IVdf, (IV)MY_POOL.page_size);
442         }
443 #endif
444     }
445     stack_size = ((stack_size + (MY_POOL.page_size - 1)) / MY_POOL.page_size) * MY_POOL.page_size;
446
447     return (stack_size);
448 }
449
450
451 /* Starts executing the thread.
452  * Passed as the C level function to run in the new thread.
453  */
454 #ifdef WIN32
455 STATIC THREAD_RET_TYPE
456 S_ithread_run(LPVOID arg)
457 #else
458 STATIC void *
459 S_ithread_run(void * arg)
460 #endif
461 {
462     ithread *thread = (ithread *)arg;
463     int jmp_rc = 0;
464     I32 oldscope;
465     int exit_app = 0;   /* Thread terminated using 'exit' */
466     int exit_code = 0;
467     int died = 0;       /* Thread terminated abnormally */
468
469     dJMPENV;
470
471     dTHXa(thread->interp);
472
473     dMY_POOL;
474
475     /* Blocked until ->create() call finishes */
476     MUTEX_LOCK(&thread->mutex);
477     MUTEX_UNLOCK(&thread->mutex);
478
479     PERL_SET_CONTEXT(thread->interp);
480     S_ithread_set(aTHX_ thread);
481
482 #ifndef WIN32
483     /* Thread starts with most signals blocked - restore the signal mask from
484      * the ithread struct.
485      */
486     S_set_sigmask(&thread->initial_sigmask);
487 #endif
488
489     PL_perl_destruct_level = 2;
490
491     {
492         AV *params = thread->params;
493         int len = (int)av_len(params)+1;
494         int ii;
495
496         dSP;
497         ENTER;
498         SAVETMPS;
499
500         /* Put args on the stack */
501         PUSHMARK(SP);
502         for (ii=0; ii < len; ii++) {
503             XPUSHs(av_shift(params));
504         }
505         PUTBACK;
506
507         oldscope = PL_scopestack_ix;
508         JMPENV_PUSH(jmp_rc);
509         if (jmp_rc == 0) {
510             /* Run the specified function */
511             len = (int)call_sv(thread->init_function, thread->gimme|G_EVAL);
512         } else if (jmp_rc == 2) {
513             /* Thread exited */
514             exit_app = 1;
515             exit_code = STATUS_CURRENT;
516             while (PL_scopestack_ix > oldscope) {
517                 LEAVE;
518             }
519         }
520         JMPENV_POP;
521
522 #ifndef WIN32
523         /* The interpreter is finished, so this thread can stop receiving
524          * signals.  This way, our signal handler doesn't get called in the
525          * middle of our parent thread calling perl_destruct()...
526          */
527         S_block_most_signals(NULL);
528 #endif
529
530         /* Remove args from stack and put back in params array */
531         SPAGAIN;
532         for (ii=len-1; ii >= 0; ii--) {
533             SV *sv = POPs;
534             if (jmp_rc == 0 && (thread->gimme & G_WANT) != G_VOID) {
535                 av_store(params, ii, SvREFCNT_inc(sv));
536             }
537         }
538
539         FREETMPS;
540         LEAVE;
541
542         /* Check for abnormal termination */
543         if (SvTRUE(ERRSV)) {
544             died = PERL_ITHR_DIED;
545             thread->err = newSVsv(ERRSV);
546             /* If ERRSV is an object, remember the classname and then
547              * rebless into 'main' so it will survive 'cloning'
548              */
549             if (sv_isobject(thread->err)) {
550                 thread->err_class = HvNAME(SvSTASH(SvRV(thread->err)));
551                 sv_bless(thread->err, gv_stashpv("main", 0));
552             }
553
554             if (ckWARN_d(WARN_THREADS)) {
555                 oldscope = PL_scopestack_ix;
556                 JMPENV_PUSH(jmp_rc);
557                 if (jmp_rc == 0) {
558                     /* Warn that thread died */
559                     Perl_warn(aTHX_ "Thread %" UVuf " terminated abnormally: %" SVf, thread->tid, ERRSV);
560                 } else if (jmp_rc == 2) {
561                     /* Warn handler exited */
562                     exit_app = 1;
563                     exit_code = STATUS_CURRENT;
564                     while (PL_scopestack_ix > oldscope) {
565                         LEAVE;
566                     }
567                 }
568                 JMPENV_POP;
569             }
570         }
571
572         /* Release function ref */
573         SvREFCNT_dec(thread->init_function);
574         thread->init_function = Nullsv;
575     }
576
577     PerlIO_flush((PerlIO *)NULL);
578
579     MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
580     MUTEX_LOCK(&thread->mutex);
581     /* Mark as finished */
582     thread->state |= (PERL_ITHR_FINISHED | died);
583     /* Clear exit flag if required */
584     if (thread->state & PERL_ITHR_THREAD_EXIT_ONLY) {
585         exit_app = 0;
586     }
587
588     /* Adjust thread status counts */
589     if (thread->state & PERL_ITHR_DETACHED) {
590         MY_POOL.detached_threads--;
591     } else {
592         MY_POOL.running_threads--;
593         MY_POOL.joinable_threads++;
594     }
595     MUTEX_UNLOCK(&thread->mutex);
596     MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
597
598     /* Exit application if required */
599     if (exit_app) {
600         oldscope = PL_scopestack_ix;
601         JMPENV_PUSH(jmp_rc);
602         if (jmp_rc == 0) {
603             /* Warn if there are unjoined threads */
604             S_exit_warning(aTHX);
605         } else if (jmp_rc == 2) {
606             /* Warn handler exited */
607             exit_code = STATUS_CURRENT;
608             while (PL_scopestack_ix > oldscope) {
609                 LEAVE;
610             }
611         }
612         JMPENV_POP;
613
614         my_exit(exit_code);
615     }
616
617     /* At this point, the interpreter may have been freed, so call
618      * free in the the context of of the 'main' interpreter which
619      * can't have been freed due to the veto_cleanup mechanism.
620      */
621     aTHX = MY_POOL.main_thread.interp;
622
623     MUTEX_LOCK(&thread->mutex);
624     S_ithread_free(aTHX_ thread);   /* Releases MUTEX */
625
626 #ifdef WIN32
627     return ((DWORD)0);
628 #else
629     return (0);
630 #endif
631 }
632
633
634 /* Type conversion helper functions */
635
636 STATIC SV *
637 S_ithread_to_SV(pTHX_ SV *obj, ithread *thread, char *classname, bool inc)
638 {
639     SV *sv;
640     MAGIC *mg;
641
642     if (inc)
643         S_ithread_count_inc(aTHX_ thread);
644
645     if (! obj) {
646         obj = newSV(0);
647     }
648
649     sv = newSVrv(obj, classname);
650     sv_setiv(sv, PTR2IV(thread));
651     mg = sv_magicext(sv, Nullsv, PERL_MAGIC_shared_scalar, &ithread_vtbl, (char *)thread, 0);
652     mg->mg_flags |= MGf_DUP;
653     SvREADONLY_on(sv);
654
655     return (obj);
656 }
657
658 STATIC ithread *
659 S_SV_to_ithread(pTHX_ SV *sv)
660 {
661     /* Argument is a thread */
662     if (SvROK(sv)) {
663       return (INT2PTR(ithread *, SvIV(SvRV(sv))));
664     }
665     /* Argument is classname, therefore return current thread */
666     return (S_ithread_get(aTHX));
667 }
668
669
670 /* threads->create()
671  * Called in context of parent thread.
672  * Called with MY_POOL.create_destruct_mutex locked.  (Unlocked on error.)
673  */
674 STATIC ithread *
675 S_ithread_create(
676         pTHX_ SV *init_function,
677         IV        stack_size,
678         int       gimme,
679         int       exit_opt,
680         SV      **params_start,
681         SV      **params_end)
682 {
683     ithread     *thread;
684     ithread     *current_thread = S_ithread_get(aTHX);
685     AV          *params;
686     SV          **array;
687
688 #if PERL_VERSION <= 8 && PERL_SUBVERSION <= 7
689     SV         **tmps_tmp = PL_tmps_stack;
690     IV           tmps_ix  = PL_tmps_ix;
691 #endif
692 #ifndef WIN32
693     int          rc_stack_size = 0;
694     int          rc_thread_create = 0;
695 #endif
696     dMY_POOL;
697
698     /* Allocate thread structure in context of the main thread's interpreter */
699     {
700         PERL_SET_CONTEXT(MY_POOL.main_thread.interp);
701         thread = (ithread *)PerlMemShared_malloc(sizeof(ithread));
702     }
703     PERL_SET_CONTEXT(aTHX);
704     if (!thread) {
705         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
706         PerlLIO_write(PerlIO_fileno(Perl_error_log), PL_no_mem, strlen(PL_no_mem));
707         my_exit(1);
708     }
709     Zero(thread, 1, ithread);
710
711     /* Add to threads list */
712     thread->next = &MY_POOL.main_thread;
713     thread->prev = MY_POOL.main_thread.prev;
714     MY_POOL.main_thread.prev = thread;
715     thread->prev->next = thread;
716     MY_POOL.total_threads++;
717
718     /* 1 ref to be held by the local var 'thread' in S_ithread_run().
719      * 1 ref to be held by the threads object that we assume we will
720      *      be embedded in upon our return.
721      * 1 ref to be the responsibility of join/detach, so we don't get
722      *      freed until join/detach, even if no thread objects remain.
723      *      This allows the following to work:
724      *          { threads->create(sub{...}); } threads->object(1)->join;
725      */
726     thread->count = 3;
727
728     /* Block new thread until ->create() call finishes */
729     MUTEX_INIT(&thread->mutex);
730     MUTEX_LOCK(&thread->mutex);
731
732     thread->tid = MY_POOL.tid_counter++;
733     thread->stack_size = S_good_stack_size(aTHX_ stack_size);
734     thread->gimme = gimme;
735     thread->state = exit_opt;
736
737     /* "Clone" our interpreter into the thread's interpreter.
738      * This gives thread access to "static data" and code.
739      */
740     PerlIO_flush((PerlIO *)NULL);
741     S_ithread_set(aTHX_ thread);
742
743     SAVEBOOL(PL_srand_called); /* Save this so it becomes the correct value */
744     PL_srand_called = FALSE;   /* Set it to false so we can detect if it gets
745                                   set during the clone */
746
747 #ifndef WIN32
748     /* perl_clone() will leave us the new interpreter's context.  This poses
749      * two problems for our signal handler.  First, it sets the new context
750      * before the new interpreter struct is fully initialized, so our signal
751      * handler might find bogus data in the interpreter struct it gets.
752      * Second, even if the interpreter is initialized before a signal comes in,
753      * we would like to avoid that interpreter receiving notifications for
754      * signals (especially when they ought to be for the one running in this
755      * thread), until it is running in its own thread.  Another problem is that
756      * the new thread will not have set the context until some time after it
757      * has started, so it won't be safe for our signal handler to run until
758      * that time.
759      *
760      * So we block most signals here, so the new thread will inherit the signal
761      * mask, and unblock them right after the thread creation.  The original
762      * mask is saved in the thread struct so that the new thread can restore
763      * the original mask.
764      */
765     S_block_most_signals(&thread->initial_sigmask);
766 #endif
767
768 #ifdef WIN32
769     thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE | CLONEf_CLONE_HOST);
770 #else
771     thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE);
772 #endif
773
774     /* perl_clone() leaves us in new interpreter's context.  As it is tricky
775      * to spot an implicit aTHX, create a new scope with aTHX matching the
776      * context for the duration of our work for new interpreter.
777      */
778     {
779 #if (PERL_VERSION < 13) || (PERL_VERSION == 13 && PERL_SUBVERSION <= 1)
780         CLONE_PARAMS clone_param;
781
782         dTHXa(thread->interp);
783
784         MY_CXT_CLONE;
785
786         /* Here we remove END blocks since they should only run in the thread
787          * they are created
788          */
789         SvREFCNT_dec(PL_endav);
790         PL_endav = NULL;
791
792         clone_param.flags = 0;
793         if (SvPOK(init_function)) {
794             thread->init_function = newSV(0);
795             sv_copypv(thread->init_function, init_function);
796         } else {
797             thread->init_function =
798                 SvREFCNT_inc(sv_dup(init_function, &clone_param));
799         }
800
801         thread->params = params = newAV();
802         av_extend(params, params_end - params_start - 1);
803         AvFILLp(params) = params_end - params_start - 1;
804         array = AvARRAY(params);
805         while (params_start < params_end) {
806             *array++ = SvREFCNT_inc(sv_dup(*params_start++, &clone_param));
807         }
808 #else
809         CLONE_PARAMS *clone_param = Perl_clone_params_new(aTHX, thread->interp);
810
811         dTHXa(thread->interp);
812
813         MY_CXT_CLONE;
814
815         /* Here we remove END blocks since they should only run in the thread
816          * they are created
817          */
818         SvREFCNT_dec(PL_endav);
819         PL_endav = NULL;
820
821         if (SvPOK(init_function)) {
822             thread->init_function = newSV(0);
823             sv_copypv(thread->init_function, init_function);
824         } else {
825             thread->init_function = sv_dup_inc(init_function, clone_param);
826         }
827
828         thread->params = params = newAV();
829         av_extend(params, params_end - params_start - 1);
830         AvFILLp(params) = params_end - params_start - 1;
831         array = AvARRAY(params);
832         while (params_start < params_end) {
833             *array++ = SvREFCNT_inc(sv_dup(*params_start++, clone_param));
834         }
835         Perl_clone_params_del(clone_param);
836 #endif
837
838 #if PERL_VERSION <= 8 && PERL_SUBVERSION <= 7
839         /* The code below checks that anything living on the tmps stack and
840          * has been cloned (so it lives in the ptr_table) has a refcount
841          * higher than 0.
842          *
843          * If the refcount is 0 it means that a something on the stack/context
844          * was holding a reference to it and since we init_stacks() in
845          * perl_clone that won't get cleaned and we will get a leaked scalar.
846          * The reason it was cloned was that it lived on the @_ stack.
847          *
848          * Example of this can be found in bugreport 15837 where calls in the
849          * parameter list end up as a temp.
850          *
851          * As of 5.8.8 this is done in perl_clone.
852          */
853         while (tmps_ix > 0) {
854             SV* sv = (SV*)ptr_table_fetch(PL_ptr_table, tmps_tmp[tmps_ix]);
855             tmps_ix--;
856             if (sv && SvREFCNT(sv) == 0) {
857                 SvREFCNT_inc_void(sv);
858                 SvREFCNT_dec(sv);
859             }
860         }
861 #endif
862
863         SvTEMP_off(thread->init_function);
864         ptr_table_free(PL_ptr_table);
865         PL_ptr_table = NULL;
866         PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
867     }
868     S_ithread_set(aTHX_ current_thread);
869     PERL_SET_CONTEXT(aTHX);
870
871     /* Create/start the thread */
872 #ifdef WIN32
873     thread->handle = CreateThread(NULL,
874                                   (DWORD)thread->stack_size,
875                                   S_ithread_run,
876                                   (LPVOID)thread,
877                                   STACK_SIZE_PARAM_IS_A_RESERVATION,
878                                   &thread->thr);
879 #else
880     {
881         STATIC pthread_attr_t attr;
882         STATIC int attr_inited = 0;
883         STATIC int attr_joinable = PTHREAD_CREATE_JOINABLE;
884         if (! attr_inited) {
885             pthread_attr_init(&attr);
886             attr_inited = 1;
887         }
888
889 #  ifdef PTHREAD_ATTR_SETDETACHSTATE
890         /* Threads start out joinable */
891         PTHREAD_ATTR_SETDETACHSTATE(&attr, attr_joinable);
892 #  endif
893
894 #  ifdef _POSIX_THREAD_ATTR_STACKSIZE
895         /* Set thread's stack size */
896         if (thread->stack_size > 0) {
897             rc_stack_size = pthread_attr_setstacksize(&attr, (size_t)thread->stack_size);
898         }
899 #  endif
900
901         /* Create the thread */
902         if (! rc_stack_size) {
903 #  ifdef OLD_PTHREADS_API
904             rc_thread_create = pthread_create(&thread->thr,
905                                               attr,
906                                               S_ithread_run,
907                                               (void *)thread);
908 #  else
909 #    if defined(HAS_PTHREAD_ATTR_SETSCOPE) && defined(PTHREAD_SCOPE_SYSTEM)
910             pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM);
911 #    endif
912             rc_thread_create = pthread_create(&thread->thr,
913                                               &attr,
914                                               S_ithread_run,
915                                               (void *)thread);
916 #  endif
917         }
918
919 #ifndef WIN32
920     /* Now it's safe to accept signals, since we're in our own interpreter's
921      * context and we have created the thread.
922      */
923     S_set_sigmask(&thread->initial_sigmask);
924 #endif
925
926 #  ifdef _POSIX_THREAD_ATTR_STACKSIZE
927         /* Try to get thread's actual stack size */
928         {
929             size_t stacksize;
930 #ifdef HPUX1020
931             stacksize = pthread_attr_getstacksize(attr);
932 #else
933             if (! pthread_attr_getstacksize(&attr, &stacksize))
934 #endif
935                 if (stacksize > 0) {
936                     thread->stack_size = (IV)stacksize;
937                 }
938         }
939 #  endif
940     }
941 #endif
942
943     /* Check for errors */
944 #ifdef WIN32
945     if (thread->handle == NULL) {
946 #else
947     if (rc_stack_size || rc_thread_create) {
948 #endif
949         /* Must unlock mutex for destruct call */
950         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
951         thread->state |= PERL_ITHR_NONVIABLE;
952         S_ithread_free(aTHX_ thread);   /* Releases MUTEX */
953 #ifndef WIN32
954         if (ckWARN_d(WARN_THREADS)) {
955             if (rc_stack_size) {
956                 Perl_warn(aTHX_ "Thread creation failed: pthread_attr_setstacksize(%" IVdf ") returned %d", thread->stack_size, rc_stack_size);
957             } else {
958                 Perl_warn(aTHX_ "Thread creation failed: pthread_create returned %d", rc_thread_create);
959             }
960         }
961 #endif
962         return (NULL);
963     }
964
965     MY_POOL.running_threads++;
966     return (thread);
967 }
968
969 #endif /* USE_ITHREADS */
970
971
972 MODULE = threads    PACKAGE = threads    PREFIX = ithread_
973 PROTOTYPES: DISABLE
974
975 #ifdef USE_ITHREADS
976
977 void
978 ithread_create(...)
979     PREINIT:
980         char *classname;
981         ithread *thread;
982         SV *function_to_call;
983         HV *specs;
984         IV stack_size;
985         int context;
986         int exit_opt;
987         SV *thread_exit_only;
988         char *str;
989         int idx;
990         SV **args_start;
991         SV **args_end;
992         dMY_POOL;
993     CODE:
994         if ((items >= 2) && SvROK(ST(1)) && SvTYPE(SvRV(ST(1)))==SVt_PVHV) {
995             if (--items < 2) {
996                 Perl_croak(aTHX_ "Usage: threads->create(\\%%specs, function, ...)");
997             }
998             specs = (HV*)SvRV(ST(1));
999             idx = 1;
1000         } else {
1001             if (items < 2) {
1002                 Perl_croak(aTHX_ "Usage: threads->create(function, ...)");
1003             }
1004             specs = NULL;
1005             idx = 0;
1006         }
1007
1008         if (sv_isobject(ST(0))) {
1009             /* $thr->create() */
1010             classname = HvNAME(SvSTASH(SvRV(ST(0))));
1011             thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1012             MUTEX_LOCK(&thread->mutex);
1013             stack_size = thread->stack_size;
1014             exit_opt = thread->state & PERL_ITHR_THREAD_EXIT_ONLY;
1015             MUTEX_UNLOCK(&thread->mutex);
1016         } else {
1017             /* threads->create() */
1018             classname = (char *)SvPV_nolen(ST(0));
1019             stack_size = MY_POOL.default_stack_size;
1020             thread_exit_only = get_sv("threads::thread_exit_only", GV_ADD);
1021             exit_opt = (SvTRUE(thread_exit_only))
1022                                     ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
1023         }
1024
1025         function_to_call = ST(idx+1);
1026
1027         context = -1;
1028         if (specs) {
1029             SV **svp;
1030             /* stack_size */
1031             if ((svp = hv_fetch(specs, "stack", 5, 0))) {
1032                 stack_size = SvIV(*svp);
1033             } else if ((svp = hv_fetch(specs, "stacksize", 9, 0))) {
1034                 stack_size = SvIV(*svp);
1035             } else if ((svp = hv_fetch(specs, "stack_size", 10, 0))) {
1036                 stack_size = SvIV(*svp);
1037             }
1038
1039             /* context */
1040             if ((svp = hv_fetch(specs, "context", 7, 0))) {
1041                 str = (char *)SvPV_nolen(*svp);
1042                 switch (*str) {
1043                     case 'a':
1044                     case 'A':
1045                     case 'l':
1046                     case 'L':
1047                         context = G_ARRAY;
1048                         break;
1049                     case 's':
1050                     case 'S':
1051                         context = G_SCALAR;
1052                         break;
1053                     case 'v':
1054                     case 'V':
1055                         context = G_VOID;
1056                         break;
1057                     default:
1058                         Perl_croak(aTHX_ "Invalid context: %s", str);
1059                 }
1060             } else if ((svp = hv_fetch(specs, "array", 5, 0))) {
1061                 if (SvTRUE(*svp)) {
1062                     context = G_ARRAY;
1063                 }
1064             } else if ((svp = hv_fetch(specs, "list", 4, 0))) {
1065                 if (SvTRUE(*svp)) {
1066                     context = G_ARRAY;
1067                 }
1068             } else if ((svp = hv_fetch(specs, "scalar", 6, 0))) {
1069                 if (SvTRUE(*svp)) {
1070                     context = G_SCALAR;
1071                 }
1072             } else if ((svp = hv_fetch(specs, "void", 4, 0))) {
1073                 if (SvTRUE(*svp)) {
1074                     context = G_VOID;
1075                 }
1076             }
1077
1078             /* exit => thread_only */
1079             if ((svp = hv_fetch(specs, "exit", 4, 0))) {
1080                 str = (char *)SvPV_nolen(*svp);
1081                 exit_opt = (*str == 't' || *str == 'T')
1082                                     ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
1083             }
1084         }
1085         if (context == -1) {
1086             context = GIMME_V;  /* Implicit context */
1087         } else {
1088             context |= (GIMME_V & (~(G_ARRAY|G_SCALAR|G_VOID)));
1089         }
1090
1091         /* Function args */
1092         args_start = &ST(idx + 2);
1093         if (items > 2) {
1094             args_end = &ST(idx + items);
1095         } else {
1096             args_end = args_start;
1097         }
1098
1099         /* Create thread */
1100         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1101         thread = S_ithread_create(aTHX_ function_to_call,
1102                                         stack_size,
1103                                         context,
1104                                         exit_opt,
1105                                         args_start,
1106                                         args_end);
1107         if (! thread) {
1108             XSRETURN_UNDEF;     /* Mutex already unlocked */
1109         }
1110         ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, FALSE));
1111         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1112
1113         /* Let thread run */
1114         MUTEX_UNLOCK(&thread->mutex);
1115
1116         /* XSRETURN(1); - implied */
1117
1118
1119 void
1120 ithread_list(...)
1121     PREINIT:
1122         char *classname;
1123         ithread *thread;
1124         int list_context;
1125         IV count = 0;
1126         int want_running = 0;
1127         int state;
1128         dMY_POOL;
1129     PPCODE:
1130         /* Class method only */
1131         if (SvROK(ST(0))) {
1132             Perl_croak(aTHX_ "Usage: threads->list(...)");
1133         }
1134         classname = (char *)SvPV_nolen(ST(0));
1135
1136         /* Calling context */
1137         list_context = (GIMME_V == G_ARRAY);
1138
1139         /* Running or joinable parameter */
1140         if (items > 1) {
1141             want_running = SvTRUE(ST(1));
1142         }
1143
1144         /* Walk through threads list */
1145         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1146         for (thread = MY_POOL.main_thread.next;
1147              thread != &MY_POOL.main_thread;
1148              thread = thread->next)
1149         {
1150             MUTEX_LOCK(&thread->mutex);
1151             state = thread->state;
1152             MUTEX_UNLOCK(&thread->mutex);
1153
1154             /* Ignore detached or joined threads */
1155             if (state & PERL_ITHR_UNCALLABLE) {
1156                 continue;
1157             }
1158
1159             /* Filter per parameter */
1160             if (items > 1) {
1161                 if (want_running) {
1162                     if (state & PERL_ITHR_FINISHED) {
1163                         continue;   /* Not running */
1164                     }
1165                 } else {
1166                     if (! (state & PERL_ITHR_FINISHED)) {
1167                         continue;   /* Still running - not joinable yet */
1168                     }
1169                 }
1170             }
1171
1172             /* Push object on stack if list context */
1173             if (list_context) {
1174                 XPUSHs(sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE)));
1175             }
1176             count++;
1177         }
1178         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1179         /* If scalar context, send back count */
1180         if (! list_context) {
1181             XSRETURN_IV(count);
1182         }
1183
1184
1185 void
1186 ithread_self(...)
1187     PREINIT:
1188         char *classname;
1189         ithread *thread;
1190     CODE:
1191         /* Class method only */
1192         if ((items != 1) || SvROK(ST(0))) {
1193             Perl_croak(aTHX_ "Usage: threads->self()");
1194         }
1195         classname = (char *)SvPV_nolen(ST(0));
1196
1197         thread = S_ithread_get(aTHX);
1198
1199         ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1200         /* XSRETURN(1); - implied */
1201
1202
1203 void
1204 ithread_tid(...)
1205     PREINIT:
1206         ithread *thread;
1207     CODE:
1208         PERL_UNUSED_VAR(items);
1209         thread = S_SV_to_ithread(aTHX_ ST(0));
1210         XST_mUV(0, thread->tid);
1211         /* XSRETURN(1); - implied */
1212
1213
1214 void
1215 ithread_join(...)
1216     PREINIT:
1217         ithread *thread;
1218         ithread *current_thread;
1219         int join_err;
1220         AV *params = NULL;
1221         int len;
1222         int ii;
1223 #ifndef WIN32
1224         int rc_join;
1225         void *retval;
1226 #endif
1227         dMY_POOL;
1228     PPCODE:
1229         /* Object method only */
1230         if ((items != 1) || ! sv_isobject(ST(0))) {
1231             Perl_croak(aTHX_ "Usage: $thr->join()");
1232         }
1233
1234         /* Check if the thread is joinable and not ourselves */
1235         thread = S_SV_to_ithread(aTHX_ ST(0));
1236         current_thread = S_ithread_get(aTHX);
1237
1238         MUTEX_LOCK(&thread->mutex);
1239         if ((join_err = (thread->state & PERL_ITHR_UNCALLABLE))) {
1240             MUTEX_UNLOCK(&thread->mutex);
1241             Perl_croak(aTHX_ (join_err & PERL_ITHR_DETACHED)
1242                                 ? "Cannot join a detached thread"
1243                                 : "Thread already joined");
1244         } else if (thread->tid == current_thread->tid) {
1245             MUTEX_UNLOCK(&thread->mutex);
1246             Perl_croak(aTHX_ "Cannot join self");
1247         }
1248
1249         /* Mark as joined */
1250         thread->state |= PERL_ITHR_JOINED;
1251         MUTEX_UNLOCK(&thread->mutex);
1252
1253         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1254         MY_POOL.joinable_threads--;
1255         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1256
1257         /* Join the thread */
1258 #ifdef WIN32
1259         if (WaitForSingleObject(thread->handle, INFINITE) != WAIT_OBJECT_0) {
1260             /* Timeout/abandonment unexpected here; check $^E */
1261             Perl_croak(aTHX_ "PANIC: underlying join failed");
1262         };
1263 #else
1264         if ((rc_join = pthread_join(thread->thr, &retval)) != 0) {
1265             /* In progress/deadlock/unknown unexpected here; check $! */
1266             errno = rc_join;
1267             Perl_croak(aTHX_ "PANIC: underlying join failed");
1268         };
1269 #endif
1270
1271         MUTEX_LOCK(&thread->mutex);
1272         /* Get the return value from the call_sv */
1273         /* Objects do not survive this process - FIXME */
1274         if ((thread->gimme & G_WANT) != G_VOID) {
1275 #if (PERL_VERSION < 13) || (PERL_VERSION == 13 && PERL_SUBVERSION <= 1)
1276             AV *params_copy;
1277             PerlInterpreter *other_perl;
1278             CLONE_PARAMS clone_params;
1279
1280             params_copy = thread->params;
1281             other_perl = thread->interp;
1282             clone_params.stashes = newAV();
1283             clone_params.flags = CLONEf_JOIN_IN;
1284             PL_ptr_table = ptr_table_new();
1285             S_ithread_set(aTHX_ thread);
1286             /* Ensure 'meaningful' addresses retain their meaning */
1287             ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1288             ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1289             ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1290             params = (AV *)sv_dup((SV*)params_copy, &clone_params);
1291             S_ithread_set(aTHX_ current_thread);
1292             SvREFCNT_dec(clone_params.stashes);
1293             SvREFCNT_inc_void(params);
1294             ptr_table_free(PL_ptr_table);
1295             PL_ptr_table = NULL;
1296 #else
1297             AV *params_copy;
1298             PerlInterpreter *other_perl = thread->interp;
1299             CLONE_PARAMS *clone_params = Perl_clone_params_new(other_perl, aTHX);
1300
1301             params_copy = thread->params;
1302             clone_params->flags |= CLONEf_JOIN_IN;
1303             PL_ptr_table = ptr_table_new();
1304             S_ithread_set(aTHX_ thread);
1305             /* Ensure 'meaningful' addresses retain their meaning */
1306             ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1307             ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1308             ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1309             params = (AV *)sv_dup((SV*)params_copy, clone_params);
1310             S_ithread_set(aTHX_ current_thread);
1311             Perl_clone_params_del(clone_params);
1312             SvREFCNT_inc_void(params);
1313             ptr_table_free(PL_ptr_table);
1314             PL_ptr_table = NULL;
1315 #endif
1316         }
1317
1318         /* If thread didn't die, then we can free its interpreter */
1319         if (! (thread->state & PERL_ITHR_DIED)) {
1320             S_ithread_clear(aTHX_ thread);
1321         }
1322         S_ithread_free(aTHX_ thread);   /* Releases MUTEX */
1323
1324         /* If no return values, then just return */
1325         if (! params) {
1326             XSRETURN_UNDEF;
1327         }
1328
1329         /* Put return values on stack */
1330         len = (int)AvFILL(params);
1331         for (ii=0; ii <= len; ii++) {
1332             SV* param = av_shift(params);
1333             XPUSHs(sv_2mortal(param));
1334         }
1335
1336         /* Free return value array */
1337         SvREFCNT_dec(params);
1338
1339
1340 void
1341 ithread_yield(...)
1342     CODE:
1343         PERL_UNUSED_VAR(items);
1344         YIELD;
1345
1346
1347 void
1348 ithread_detach(...)
1349     PREINIT:
1350         ithread *thread;
1351         int detach_err;
1352         dMY_POOL;
1353     CODE:
1354         PERL_UNUSED_VAR(items);
1355
1356         /* Detach the thread */
1357         thread = S_SV_to_ithread(aTHX_ ST(0));
1358         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1359         MUTEX_LOCK(&thread->mutex);
1360         if (! (detach_err = (thread->state & PERL_ITHR_UNCALLABLE))) {
1361             /* Thread is detachable */
1362             thread->state |= PERL_ITHR_DETACHED;
1363 #ifdef WIN32
1364             /* Windows has no 'detach thread' function */
1365 #else
1366             PERL_THREAD_DETACH(thread->thr);
1367 #endif
1368             if (thread->state & PERL_ITHR_FINISHED) {
1369                 MY_POOL.joinable_threads--;
1370             } else {
1371                 MY_POOL.running_threads--;
1372                 MY_POOL.detached_threads++;
1373             }
1374         }
1375         MUTEX_UNLOCK(&thread->mutex);
1376         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1377
1378         if (detach_err) {
1379             Perl_croak(aTHX_ (detach_err & PERL_ITHR_DETACHED)
1380                                 ? "Thread already detached"
1381                                 : "Cannot detach a joined thread");
1382         }
1383
1384         /* If thread is finished and didn't die,
1385          * then we can free its interpreter */
1386         MUTEX_LOCK(&thread->mutex);
1387         if ((thread->state & PERL_ITHR_FINISHED) &&
1388             ! (thread->state & PERL_ITHR_DIED))
1389         {
1390             S_ithread_clear(aTHX_ thread);
1391         }
1392         S_ithread_free(aTHX_ thread);   /* Releases MUTEX */
1393
1394
1395 void
1396 ithread_kill(...)
1397     PREINIT:
1398         ithread *thread;
1399         char *sig_name;
1400         IV signal;
1401         int no_handler = 1;
1402     CODE:
1403         /* Must have safe signals */
1404         if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) {
1405             Perl_croak(aTHX_ "Cannot signal threads without safe signals");
1406         }
1407
1408         /* Object method only */
1409         if ((items != 2) || ! sv_isobject(ST(0))) {
1410             Perl_croak(aTHX_ "Usage: $thr->kill('SIG...')");
1411         }
1412
1413         /* Get signal */
1414         sig_name = SvPV_nolen(ST(1));
1415         if (isALPHA(*sig_name)) {
1416             if (*sig_name == 'S' && sig_name[1] == 'I' && sig_name[2] == 'G') {
1417                 sig_name += 3;
1418             }
1419             if ((signal = whichsig(sig_name)) < 0) {
1420                 Perl_croak(aTHX_ "Unrecognized signal name: %s", sig_name);
1421             }
1422         } else {
1423             signal = SvIV(ST(1));
1424         }
1425
1426         /* Set the signal for the thread */
1427         thread = S_SV_to_ithread(aTHX_ ST(0));
1428         MUTEX_LOCK(&thread->mutex);
1429         if (thread->interp) {
1430             dTHXa(thread->interp);
1431             if (PL_psig_pend && PL_psig_ptr[signal]) {
1432                 PL_psig_pend[signal]++;
1433                 PL_sig_pending = 1;
1434                 no_handler = 0;
1435             }
1436         } else {
1437             /* Ignore signal to terminated thread */
1438             no_handler = 0;
1439         }
1440         MUTEX_UNLOCK(&thread->mutex);
1441
1442         if (no_handler) {
1443             Perl_croak(aTHX_ "Signal %s received in thread %"UVuf", but no signal handler set.", sig_name, thread->tid);
1444         }
1445
1446         /* Return the thread to allow for method chaining */
1447         ST(0) = ST(0);
1448         /* XSRETURN(1); - implied */
1449
1450
1451 void
1452 ithread_DESTROY(...)
1453     CODE:
1454         PERL_UNUSED_VAR(items);
1455         sv_unmagic(SvRV(ST(0)), PERL_MAGIC_shared_scalar);
1456
1457
1458 void
1459 ithread_equal(...)
1460     PREINIT:
1461         int are_equal = 0;
1462     CODE:
1463         PERL_UNUSED_VAR(items);
1464
1465         /* Compares TIDs to determine thread equality */
1466         if (sv_isobject(ST(0)) && sv_isobject(ST(1))) {
1467             ithread *thr1 = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1468             ithread *thr2 = INT2PTR(ithread *, SvIV(SvRV(ST(1))));
1469             are_equal = (thr1->tid == thr2->tid);
1470         }
1471         if (are_equal) {
1472             XST_mYES(0);
1473         } else {
1474             /* Return 0 on false for backward compatibility */
1475             XST_mIV(0, 0);
1476         }
1477         /* XSRETURN(1); - implied */
1478
1479
1480 void
1481 ithread_object(...)
1482     PREINIT:
1483         char *classname;
1484         SV *arg;
1485         UV tid;
1486         ithread *thread;
1487         int state;
1488         int have_obj = 0;
1489         dMY_POOL;
1490     CODE:
1491         /* Class method only */
1492         if (SvROK(ST(0))) {
1493             Perl_croak(aTHX_ "Usage: threads->object($tid)");
1494         }
1495         classname = (char *)SvPV_nolen(ST(0));
1496
1497         /* Turn $tid from PVLV to SV if needed (bug #73330) */
1498         arg = ST(1);
1499         SvGETMAGIC(arg);
1500
1501         if ((items < 2) || ! SvOK(arg)) {
1502             XSRETURN_UNDEF;
1503         }
1504
1505         /* threads->object($tid) */
1506         tid = SvUV(arg);
1507
1508         /* If current thread wants its own object, then behave the same as
1509            ->self() */
1510         thread = S_ithread_get(aTHX);
1511         if (thread->tid == tid) {
1512             ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1513             have_obj = 1;
1514
1515         } else {
1516             /* Walk through threads list */
1517             MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1518             for (thread = MY_POOL.main_thread.next;
1519                  thread != &MY_POOL.main_thread;
1520                  thread = thread->next)
1521             {
1522                 /* Look for TID */
1523                 if (thread->tid == tid) {
1524                     /* Ignore if detached or joined */
1525                     MUTEX_LOCK(&thread->mutex);
1526                     state = thread->state;
1527                     MUTEX_UNLOCK(&thread->mutex);
1528                     if (! (state & PERL_ITHR_UNCALLABLE)) {
1529                         /* Put object on stack */
1530                         ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1531                         have_obj = 1;
1532                     }
1533                     break;
1534                 }
1535             }
1536             MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1537         }
1538
1539         if (! have_obj) {
1540             XSRETURN_UNDEF;
1541         }
1542         /* XSRETURN(1); - implied */
1543
1544
1545 void
1546 ithread__handle(...);
1547     PREINIT:
1548         ithread *thread;
1549     CODE:
1550         PERL_UNUSED_VAR(items);
1551         thread = S_SV_to_ithread(aTHX_ ST(0));
1552 #ifdef WIN32
1553         XST_mUV(0, PTR2UV(&thread->handle));
1554 #else
1555         XST_mUV(0, PTR2UV(&thread->thr));
1556 #endif
1557         /* XSRETURN(1); - implied */
1558
1559
1560 void
1561 ithread_get_stack_size(...)
1562     PREINIT:
1563         IV stack_size;
1564         dMY_POOL;
1565     CODE:
1566         PERL_UNUSED_VAR(items);
1567         if (sv_isobject(ST(0))) {
1568             /* $thr->get_stack_size() */
1569             ithread *thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1570             stack_size = thread->stack_size;
1571         } else {
1572             /* threads->get_stack_size() */
1573             stack_size = MY_POOL.default_stack_size;
1574         }
1575         XST_mIV(0, stack_size);
1576         /* XSRETURN(1); - implied */
1577
1578
1579 void
1580 ithread_set_stack_size(...)
1581     PREINIT:
1582         IV old_size;
1583         dMY_POOL;
1584     CODE:
1585         if (items != 2) {
1586             Perl_croak(aTHX_ "Usage: threads->set_stack_size($size)");
1587         }
1588         if (sv_isobject(ST(0))) {
1589             Perl_croak(aTHX_ "Cannot change stack size of an existing thread");
1590         }
1591         if (! looks_like_number(ST(1))) {
1592             Perl_croak(aTHX_ "Stack size must be numeric");
1593         }
1594
1595         old_size = MY_POOL.default_stack_size;
1596         MY_POOL.default_stack_size = S_good_stack_size(aTHX_ SvIV(ST(1)));
1597         XST_mIV(0, old_size);
1598         /* XSRETURN(1); - implied */
1599
1600
1601 void
1602 ithread_is_running(...)
1603     PREINIT:
1604         ithread *thread;
1605     CODE:
1606         /* Object method only */
1607         if ((items != 1) || ! sv_isobject(ST(0))) {
1608             Perl_croak(aTHX_ "Usage: $thr->is_running()");
1609         }
1610
1611         thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1612         MUTEX_LOCK(&thread->mutex);
1613         ST(0) = (thread->state & PERL_ITHR_FINISHED) ? &PL_sv_no : &PL_sv_yes;
1614         MUTEX_UNLOCK(&thread->mutex);
1615         /* XSRETURN(1); - implied */
1616
1617
1618 void
1619 ithread_is_detached(...)
1620     PREINIT:
1621         ithread *thread;
1622     CODE:
1623         PERL_UNUSED_VAR(items);
1624         thread = S_SV_to_ithread(aTHX_ ST(0));
1625         MUTEX_LOCK(&thread->mutex);
1626         ST(0) = (thread->state & PERL_ITHR_DETACHED) ? &PL_sv_yes : &PL_sv_no;
1627         MUTEX_UNLOCK(&thread->mutex);
1628         /* XSRETURN(1); - implied */
1629
1630
1631 void
1632 ithread_is_joinable(...)
1633     PREINIT:
1634         ithread *thread;
1635     CODE:
1636         /* Object method only */
1637         if ((items != 1) || ! sv_isobject(ST(0))) {
1638             Perl_croak(aTHX_ "Usage: $thr->is_joinable()");
1639         }
1640
1641         thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1642         MUTEX_LOCK(&thread->mutex);
1643         ST(0) = ((thread->state & PERL_ITHR_FINISHED) &&
1644                  ! (thread->state & PERL_ITHR_UNCALLABLE))
1645             ? &PL_sv_yes : &PL_sv_no;
1646         MUTEX_UNLOCK(&thread->mutex);
1647         /* XSRETURN(1); - implied */
1648
1649
1650 void
1651 ithread_wantarray(...)
1652     PREINIT:
1653         ithread *thread;
1654     CODE:
1655         PERL_UNUSED_VAR(items);
1656         thread = S_SV_to_ithread(aTHX_ ST(0));
1657         ST(0) = ((thread->gimme & G_WANT) == G_ARRAY) ? &PL_sv_yes :
1658                 ((thread->gimme & G_WANT) == G_VOID)  ? &PL_sv_undef
1659                                        /* G_SCALAR */ : &PL_sv_no;
1660         /* XSRETURN(1); - implied */
1661
1662
1663 void
1664 ithread_set_thread_exit_only(...)
1665     PREINIT:
1666         ithread *thread;
1667     CODE:
1668         if (items != 2) {
1669             Perl_croak(aTHX_ "Usage: ->set_thread_exit_only(boolean)");
1670         }
1671         thread = S_SV_to_ithread(aTHX_ ST(0));
1672         MUTEX_LOCK(&thread->mutex);
1673         if (SvTRUE(ST(1))) {
1674             thread->state |= PERL_ITHR_THREAD_EXIT_ONLY;
1675         } else {
1676             thread->state &= ~PERL_ITHR_THREAD_EXIT_ONLY;
1677         }
1678         MUTEX_UNLOCK(&thread->mutex);
1679
1680
1681 void
1682 ithread_error(...)
1683     PREINIT:
1684         ithread *thread;
1685         SV *err = NULL;
1686     CODE:
1687         /* Object method only */
1688         if ((items != 1) || ! sv_isobject(ST(0))) {
1689             Perl_croak(aTHX_ "Usage: $thr->err()");
1690         }
1691
1692         thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1693         MUTEX_LOCK(&thread->mutex);
1694
1695         /* If thread died, then clone the error into the calling thread */
1696         if (thread->state & PERL_ITHR_DIED) {
1697 #if (PERL_VERSION < 13) || (PERL_VERSION == 13 && PERL_SUBVERSION <= 1)
1698             PerlInterpreter *other_perl;
1699             CLONE_PARAMS clone_params;
1700             ithread *current_thread;
1701
1702             other_perl = thread->interp;
1703             clone_params.stashes = newAV();
1704             clone_params.flags = CLONEf_JOIN_IN;
1705             PL_ptr_table = ptr_table_new();
1706             current_thread = S_ithread_get(aTHX);
1707             S_ithread_set(aTHX_ thread);
1708             /* Ensure 'meaningful' addresses retain their meaning */
1709             ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1710             ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1711             ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1712             err = sv_dup(thread->err, &clone_params);
1713             S_ithread_set(aTHX_ current_thread);
1714             SvREFCNT_dec(clone_params.stashes);
1715             SvREFCNT_inc_void(err);
1716             /* If error was an object, bless it into the correct class */
1717             if (thread->err_class) {
1718                 sv_bless(err, gv_stashpv(thread->err_class, 1));
1719             }
1720             ptr_table_free(PL_ptr_table);
1721             PL_ptr_table = NULL;
1722 #else
1723             PerlInterpreter *other_perl = thread->interp;
1724             CLONE_PARAMS *clone_params = Perl_clone_params_new(other_perl, aTHX);
1725             ithread *current_thread;
1726
1727             clone_params->flags |= CLONEf_JOIN_IN;
1728             PL_ptr_table = ptr_table_new();
1729             current_thread = S_ithread_get(aTHX);
1730             S_ithread_set(aTHX_ thread);
1731             /* Ensure 'meaningful' addresses retain their meaning */
1732             ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1733             ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1734             ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1735             err = sv_dup(thread->err, clone_params);
1736             S_ithread_set(aTHX_ current_thread);
1737             Perl_clone_params_del(clone_params);
1738             SvREFCNT_inc_void(err);
1739             /* If error was an object, bless it into the correct class */
1740             if (thread->err_class) {
1741                 sv_bless(err, gv_stashpv(thread->err_class, 1));
1742             }
1743             ptr_table_free(PL_ptr_table);
1744             PL_ptr_table = NULL;
1745 #endif
1746         }
1747
1748         MUTEX_UNLOCK(&thread->mutex);
1749
1750         if (! err) {
1751             XSRETURN_UNDEF;
1752         }
1753
1754         ST(0) = sv_2mortal(err);
1755         /* XSRETURN(1); - implied */
1756
1757
1758 #endif /* USE_ITHREADS */
1759
1760
1761 BOOT:
1762 {
1763 #ifdef USE_ITHREADS
1764     SV *my_pool_sv = *hv_fetch(PL_modglobal, MY_POOL_KEY,
1765                                sizeof(MY_POOL_KEY)-1, TRUE);
1766     my_pool_t *my_poolp = (my_pool_t*)SvPVX(newSV(sizeof(my_pool_t)-1));
1767
1768     MY_CXT_INIT;
1769
1770     Zero(my_poolp, 1, my_pool_t);
1771     sv_setuv(my_pool_sv, PTR2UV(my_poolp));
1772
1773     PL_perl_destruct_level = 2;
1774     MUTEX_INIT(&MY_POOL.create_destruct_mutex);
1775     MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1776
1777     PL_threadhook = &Perl_ithread_hook;
1778
1779     MY_POOL.tid_counter = 1;
1780 #  ifdef THREAD_CREATE_NEEDS_STACK
1781     MY_POOL.default_stack_size = THREAD_CREATE_NEEDS_STACK;
1782 #  endif
1783
1784     /* The 'main' thread is thread 0.
1785      * It is detached (unjoinable) and immortal.
1786      */
1787
1788     MUTEX_INIT(&MY_POOL.main_thread.mutex);
1789
1790     /* Head of the threads list */
1791     MY_POOL.main_thread.next = &MY_POOL.main_thread;
1792     MY_POOL.main_thread.prev = &MY_POOL.main_thread;
1793
1794     MY_POOL.main_thread.count = 1;                  /* Immortal */
1795
1796     MY_POOL.main_thread.interp = aTHX;
1797     MY_POOL.main_thread.state = PERL_ITHR_DETACHED; /* Detached */
1798     MY_POOL.main_thread.stack_size = MY_POOL.default_stack_size;
1799 #  ifdef WIN32
1800     MY_POOL.main_thread.thr = GetCurrentThreadId();
1801 #  else
1802     MY_POOL.main_thread.thr = pthread_self();
1803 #  endif
1804
1805     S_ithread_set(aTHX_ &MY_POOL.main_thread);
1806     MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1807 #endif /* USE_ITHREADS */
1808 }