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