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