This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
6c337ac74aea08a149daed2d3c763d8a22e576c8
[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_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.  (Unlocked on error.)
721  */
722 STATIC ithread *
723 S_ithread_create(
724         PerlInterpreter *parent_perl,
725         SV       *init_function,
726         IV        stack_size,
727         int       gimme,
728         int       exit_opt,
729         int       params_start,
730         int       num_params)
731 {
732     dTHXa(parent_perl);
733     ithread     *thread;
734     ithread     *current_thread = S_ithread_get(aTHX);
735     AV          *params;
736     SV          **array;
737
738 #if PERL_VERSION <= 8 && PERL_SUBVERSION <= 7
739     SV         **tmps_tmp = PL_tmps_stack;
740     IV           tmps_ix  = PL_tmps_ix;
741 #endif
742 #ifndef WIN32
743     int          rc_stack_size = 0;
744     int          rc_thread_create = 0;
745 #endif
746     dMY_POOL;
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     return (thread);
1017 }
1018
1019 #endif /* USE_ITHREADS */
1020
1021
1022 MODULE = threads    PACKAGE = threads    PREFIX = ithread_
1023 PROTOTYPES: DISABLE
1024
1025 #ifdef USE_ITHREADS
1026
1027 void
1028 ithread_create(...)
1029     PREINIT:
1030         char *classname;
1031         ithread *thread;
1032         SV *function_to_call;
1033         HV *specs;
1034         IV stack_size;
1035         int context;
1036         int exit_opt;
1037         SV *thread_exit_only;
1038         char *str;
1039         int idx;
1040         dMY_POOL;
1041     CODE:
1042         if ((items >= 2) && SvROK(ST(1)) && SvTYPE(SvRV(ST(1)))==SVt_PVHV) {
1043             if (--items < 2) {
1044                 Perl_croak(aTHX_ "Usage: threads->create(\\%%specs, function, ...)");
1045             }
1046             specs = (HV*)SvRV(ST(1));
1047             idx = 1;
1048         } else {
1049             if (items < 2) {
1050                 Perl_croak(aTHX_ "Usage: threads->create(function, ...)");
1051             }
1052             specs = NULL;
1053             idx = 0;
1054         }
1055
1056         if (sv_isobject(ST(0))) {
1057             /* $thr->create() */
1058             classname = HvNAME(SvSTASH(SvRV(ST(0))));
1059             thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1060             MUTEX_LOCK(&thread->mutex);
1061             stack_size = thread->stack_size;
1062             exit_opt = thread->state & PERL_ITHR_THREAD_EXIT_ONLY;
1063             MUTEX_UNLOCK(&thread->mutex);
1064         } else {
1065             /* threads->create() */
1066             classname = (char *)SvPV_nolen(ST(0));
1067             stack_size = MY_POOL.default_stack_size;
1068             thread_exit_only = get_sv("threads::thread_exit_only", GV_ADD);
1069             exit_opt = (SvTRUE(thread_exit_only))
1070                                     ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
1071         }
1072
1073         function_to_call = ST(idx+1);
1074
1075         context = -1;
1076         if (specs) {
1077             SV **svp;
1078             /* stack_size */
1079             if ((svp = hv_fetch(specs, "stack", 5, 0))) {
1080                 stack_size = SvIV(*svp);
1081             } else if ((svp = hv_fetch(specs, "stacksize", 9, 0))) {
1082                 stack_size = SvIV(*svp);
1083             } else if ((svp = hv_fetch(specs, "stack_size", 10, 0))) {
1084                 stack_size = SvIV(*svp);
1085             }
1086
1087             /* context */
1088             if ((svp = hv_fetch(specs, "context", 7, 0))) {
1089                 str = (char *)SvPV_nolen(*svp);
1090                 switch (*str) {
1091                     case 'a':
1092                     case 'A':
1093                     case 'l':
1094                     case 'L':
1095                         context = G_ARRAY;
1096                         break;
1097                     case 's':
1098                     case 'S':
1099                         context = G_SCALAR;
1100                         break;
1101                     case 'v':
1102                     case 'V':
1103                         context = G_VOID;
1104                         break;
1105                     default:
1106                         Perl_croak(aTHX_ "Invalid context: %s", str);
1107                 }
1108             } else if ((svp = hv_fetch(specs, "array", 5, 0))) {
1109                 if (SvTRUE(*svp)) {
1110                     context = G_ARRAY;
1111                 }
1112             } else if ((svp = hv_fetch(specs, "list", 4, 0))) {
1113                 if (SvTRUE(*svp)) {
1114                     context = G_ARRAY;
1115                 }
1116             } else if ((svp = hv_fetch(specs, "scalar", 6, 0))) {
1117                 if (SvTRUE(*svp)) {
1118                     context = G_SCALAR;
1119                 }
1120             } else if ((svp = hv_fetch(specs, "void", 4, 0))) {
1121                 if (SvTRUE(*svp)) {
1122                     context = G_VOID;
1123                 }
1124             }
1125
1126             /* exit => thread_only */
1127             if ((svp = hv_fetch(specs, "exit", 4, 0))) {
1128                 str = (char *)SvPV_nolen(*svp);
1129                 exit_opt = (*str == 't' || *str == 'T')
1130                                     ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
1131             }
1132         }
1133         if (context == -1) {
1134             context = GIMME_V;  /* Implicit context */
1135         } else {
1136             context |= (GIMME_V & (~(G_ARRAY|G_SCALAR|G_VOID)));
1137         }
1138
1139         /* Create thread */
1140         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1141         thread = S_ithread_create(aTHX_ function_to_call,
1142                                         stack_size,
1143                                         context,
1144                                         exit_opt,
1145                                         ax + idx + 2,
1146                                         items > 2 ? items - 2 : 0);
1147         if (! thread) {
1148             XSRETURN_UNDEF;     /* Mutex already unlocked */
1149         }
1150         ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, FALSE));
1151         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1152
1153         /* Let thread run. */
1154         /* See S_ithread_run() for more detail. */
1155         MUTEX_UNLOCK(&thread->mutex);
1156
1157         /* XSRETURN(1); - implied */
1158
1159
1160 void
1161 ithread_list(...)
1162     PREINIT:
1163         char *classname;
1164         ithread *thread;
1165         int list_context;
1166         IV count = 0;
1167         int want_running = 0;
1168         int state;
1169         dMY_POOL;
1170     PPCODE:
1171         /* Class method only */
1172         if (SvROK(ST(0))) {
1173             Perl_croak(aTHX_ "Usage: threads->list(...)");
1174         }
1175         classname = (char *)SvPV_nolen(ST(0));
1176
1177         /* Calling context */
1178         list_context = (GIMME_V == G_ARRAY);
1179
1180         /* Running or joinable parameter */
1181         if (items > 1) {
1182             want_running = SvTRUE(ST(1));
1183         }
1184
1185         /* Walk through threads list */
1186         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1187         for (thread = MY_POOL.main_thread.next;
1188              thread != &MY_POOL.main_thread;
1189              thread = thread->next)
1190         {
1191             MUTEX_LOCK(&thread->mutex);
1192             state = thread->state;
1193             MUTEX_UNLOCK(&thread->mutex);
1194
1195             /* Ignore detached or joined threads */
1196             if (state & PERL_ITHR_UNCALLABLE) {
1197                 continue;
1198             }
1199
1200             /* Filter per parameter */
1201             if (items > 1) {
1202                 if (want_running) {
1203                     if (state & PERL_ITHR_FINISHED) {
1204                         continue;   /* Not running */
1205                     }
1206                 } else {
1207                     if (! (state & PERL_ITHR_FINISHED)) {
1208                         continue;   /* Still running - not joinable yet */
1209                     }
1210                 }
1211             }
1212
1213             /* Push object on stack if list context */
1214             if (list_context) {
1215                 XPUSHs(sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE)));
1216             }
1217             count++;
1218         }
1219         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1220         /* If scalar context, send back count */
1221         if (! list_context) {
1222             XSRETURN_IV(count);
1223         }
1224
1225
1226 void
1227 ithread_self(...)
1228     PREINIT:
1229         char *classname;
1230         ithread *thread;
1231     CODE:
1232         /* Class method only */
1233         if ((items != 1) || SvROK(ST(0))) {
1234             Perl_croak(aTHX_ "Usage: threads->self()");
1235         }
1236         classname = (char *)SvPV_nolen(ST(0));
1237
1238         thread = S_ithread_get(aTHX);
1239
1240         ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1241         /* XSRETURN(1); - implied */
1242
1243
1244 void
1245 ithread_tid(...)
1246     PREINIT:
1247         ithread *thread;
1248     CODE:
1249         PERL_UNUSED_VAR(items);
1250         thread = S_SV_to_ithread(aTHX_ ST(0));
1251         XST_mUV(0, thread->tid);
1252         /* XSRETURN(1); - implied */
1253
1254
1255 void
1256 ithread_join(...)
1257     PREINIT:
1258         ithread *thread;
1259         ithread *current_thread;
1260         int join_err;
1261         AV *params = NULL;
1262         int len;
1263         int ii;
1264 #ifndef WIN32
1265         int rc_join;
1266         void *retval;
1267 #endif
1268         dMY_POOL;
1269     PPCODE:
1270         /* Object method only */
1271         if ((items != 1) || ! sv_isobject(ST(0))) {
1272             Perl_croak(aTHX_ "Usage: $thr->join()");
1273         }
1274
1275         /* Check if the thread is joinable and not ourselves */
1276         thread = S_SV_to_ithread(aTHX_ ST(0));
1277         current_thread = S_ithread_get(aTHX);
1278
1279         MUTEX_LOCK(&thread->mutex);
1280         if ((join_err = (thread->state & PERL_ITHR_UNCALLABLE))) {
1281             MUTEX_UNLOCK(&thread->mutex);
1282             Perl_croak(aTHX_ (join_err & PERL_ITHR_DETACHED)
1283                                 ? "Cannot join a detached thread"
1284                                 : "Thread already joined");
1285         } else if (thread->tid == current_thread->tid) {
1286             MUTEX_UNLOCK(&thread->mutex);
1287             Perl_croak(aTHX_ "Cannot join self");
1288         }
1289
1290         /* Mark as joined */
1291         thread->state |= PERL_ITHR_JOINED;
1292         MUTEX_UNLOCK(&thread->mutex);
1293
1294         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1295         MY_POOL.joinable_threads--;
1296         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1297
1298         /* Join the thread */
1299 #ifdef WIN32
1300         if (WaitForSingleObject(thread->handle, INFINITE) != WAIT_OBJECT_0) {
1301             /* Timeout/abandonment unexpected here; check $^E */
1302             Perl_croak(aTHX_ "PANIC: underlying join failed");
1303         };
1304 #else
1305         if ((rc_join = pthread_join(thread->thr, &retval)) != 0) {
1306             /* In progress/deadlock/unknown unexpected here; check $! */
1307             errno = rc_join;
1308             Perl_croak(aTHX_ "PANIC: underlying join failed");
1309         };
1310 #endif
1311
1312         MUTEX_LOCK(&thread->mutex);
1313         /* Get the return value from the call_sv */
1314         /* Objects do not survive this process - FIXME */
1315         if ((thread->gimme & G_WANT) != G_VOID) {
1316 #if (PERL_VERSION < 13) || (PERL_VERSION == 13 && PERL_SUBVERSION <= 1)
1317             AV *params_copy;
1318             PerlInterpreter *other_perl;
1319             CLONE_PARAMS clone_params;
1320
1321             params_copy = thread->params;
1322             other_perl = thread->interp;
1323             clone_params.stashes = newAV();
1324             clone_params.flags = CLONEf_JOIN_IN;
1325             PL_ptr_table = ptr_table_new();
1326             S_ithread_set(aTHX_ thread);
1327             /* Ensure 'meaningful' addresses retain their meaning */
1328             ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1329             ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1330             ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1331             params = (AV *)sv_dup((SV*)params_copy, &clone_params);
1332             S_ithread_set(aTHX_ current_thread);
1333             SvREFCNT_dec(clone_params.stashes);
1334             SvREFCNT_inc_void(params);
1335             ptr_table_free(PL_ptr_table);
1336             PL_ptr_table = NULL;
1337 #else
1338             AV *params_copy;
1339             PerlInterpreter *other_perl = thread->interp;
1340             CLONE_PARAMS *clone_params = Perl_clone_params_new(other_perl, aTHX);
1341
1342             params_copy = thread->params;
1343             clone_params->flags |= CLONEf_JOIN_IN;
1344             PL_ptr_table = ptr_table_new();
1345             S_ithread_set(aTHX_ thread);
1346             /* Ensure 'meaningful' addresses retain their meaning */
1347             ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1348             ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1349             ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1350             params = (AV *)sv_dup((SV*)params_copy, clone_params);
1351             S_ithread_set(aTHX_ current_thread);
1352             Perl_clone_params_del(clone_params);
1353             SvREFCNT_inc_void(params);
1354             ptr_table_free(PL_ptr_table);
1355             PL_ptr_table = NULL;
1356 #endif
1357         }
1358
1359         /* If thread didn't die, then we can free its interpreter */
1360         if (! (thread->state & PERL_ITHR_DIED)) {
1361             S_ithread_clear(aTHX_ thread);
1362         }
1363         S_ithread_free(aTHX_ thread);   /* Releases MUTEX */
1364
1365         /* If no return values, then just return */
1366         if (! params) {
1367             XSRETURN_UNDEF;
1368         }
1369
1370         /* Put return values on stack */
1371         len = (int)AvFILL(params);
1372         for (ii=0; ii <= len; ii++) {
1373             SV* param = av_shift(params);
1374             XPUSHs(sv_2mortal(param));
1375         }
1376
1377         /* Free return value array */
1378         SvREFCNT_dec(params);
1379
1380
1381 void
1382 ithread_yield(...)
1383     CODE:
1384         PERL_UNUSED_VAR(items);
1385         YIELD;
1386
1387
1388 void
1389 ithread_detach(...)
1390     PREINIT:
1391         ithread *thread;
1392         int detach_err;
1393         dMY_POOL;
1394     CODE:
1395         PERL_UNUSED_VAR(items);
1396
1397         /* Detach the thread */
1398         thread = S_SV_to_ithread(aTHX_ ST(0));
1399         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1400         MUTEX_LOCK(&thread->mutex);
1401         if (! (detach_err = (thread->state & PERL_ITHR_UNCALLABLE))) {
1402             /* Thread is detachable */
1403             thread->state |= PERL_ITHR_DETACHED;
1404 #ifdef WIN32
1405             /* Windows has no 'detach thread' function */
1406 #else
1407             PERL_THREAD_DETACH(thread->thr);
1408 #endif
1409             if (thread->state & PERL_ITHR_FINISHED) {
1410                 MY_POOL.joinable_threads--;
1411             } else {
1412                 MY_POOL.running_threads--;
1413                 MY_POOL.detached_threads++;
1414             }
1415         }
1416         MUTEX_UNLOCK(&thread->mutex);
1417         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1418
1419         if (detach_err) {
1420             Perl_croak(aTHX_ (detach_err & PERL_ITHR_DETACHED)
1421                                 ? "Thread already detached"
1422                                 : "Cannot detach a joined thread");
1423         }
1424
1425         /* If thread is finished and didn't die,
1426          * then we can free its interpreter */
1427         MUTEX_LOCK(&thread->mutex);
1428         if ((thread->state & PERL_ITHR_FINISHED) &&
1429             ! (thread->state & PERL_ITHR_DIED))
1430         {
1431             S_ithread_clear(aTHX_ thread);
1432         }
1433         S_ithread_free(aTHX_ thread);   /* Releases MUTEX */
1434
1435
1436 void
1437 ithread_kill(...)
1438     PREINIT:
1439         ithread *thread;
1440         char *sig_name;
1441         IV signal;
1442         int no_handler = 1;
1443     CODE:
1444         /* Must have safe signals */
1445         if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) {
1446             Perl_croak(aTHX_ "Cannot signal threads without safe signals");
1447         }
1448
1449         /* Object method only */
1450         if ((items != 2) || ! sv_isobject(ST(0))) {
1451             Perl_croak(aTHX_ "Usage: $thr->kill('SIG...')");
1452         }
1453
1454         /* Get signal */
1455         sig_name = SvPV_nolen(ST(1));
1456         if (isALPHA(*sig_name)) {
1457             if (*sig_name == 'S' && sig_name[1] == 'I' && sig_name[2] == 'G') {
1458                 sig_name += 3;
1459             }
1460             if ((signal = whichsig(sig_name)) < 0) {
1461                 Perl_croak(aTHX_ "Unrecognized signal name: %s", sig_name);
1462             }
1463         } else {
1464             signal = SvIV(ST(1));
1465         }
1466
1467         /* Set the signal for the thread */
1468         thread = S_SV_to_ithread(aTHX_ ST(0));
1469         MUTEX_LOCK(&thread->mutex);
1470         if (thread->interp && ! (thread->state & PERL_ITHR_FINISHED)) {
1471             dTHXa(thread->interp);
1472             if (PL_psig_pend && PL_psig_ptr[signal]) {
1473                 PL_psig_pend[signal]++;
1474                 PL_sig_pending = 1;
1475                 no_handler = 0;
1476             }
1477         } else {
1478             /* Ignore signal to terminated/finished thread */
1479             no_handler = 0;
1480         }
1481         MUTEX_UNLOCK(&thread->mutex);
1482
1483         if (no_handler) {
1484             Perl_croak(aTHX_ "Signal %s received in thread %"UVuf", but no signal handler set.", sig_name, thread->tid);
1485         }
1486
1487         /* Return the thread to allow for method chaining */
1488         ST(0) = ST(0);
1489         /* XSRETURN(1); - implied */
1490
1491
1492 void
1493 ithread_DESTROY(...)
1494     CODE:
1495         PERL_UNUSED_VAR(items);
1496         sv_unmagic(SvRV(ST(0)), PERL_MAGIC_shared_scalar);
1497
1498
1499 void
1500 ithread_equal(...)
1501     PREINIT:
1502         int are_equal = 0;
1503     CODE:
1504         PERL_UNUSED_VAR(items);
1505
1506         /* Compares TIDs to determine thread equality */
1507         if (sv_isobject(ST(0)) && sv_isobject(ST(1))) {
1508             ithread *thr1 = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1509             ithread *thr2 = INT2PTR(ithread *, SvIV(SvRV(ST(1))));
1510             are_equal = (thr1->tid == thr2->tid);
1511         }
1512         if (are_equal) {
1513             XST_mYES(0);
1514         } else {
1515             /* Return 0 on false for backward compatibility */
1516             XST_mIV(0, 0);
1517         }
1518         /* XSRETURN(1); - implied */
1519
1520
1521 void
1522 ithread_object(...)
1523     PREINIT:
1524         char *classname;
1525         SV *arg;
1526         UV tid;
1527         ithread *thread;
1528         int state;
1529         int have_obj = 0;
1530         dMY_POOL;
1531     CODE:
1532         /* Class method only */
1533         if (SvROK(ST(0))) {
1534             Perl_croak(aTHX_ "Usage: threads->object($tid)");
1535         }
1536         classname = (char *)SvPV_nolen(ST(0));
1537
1538         /* Turn $tid from PVLV to SV if needed (bug #73330) */
1539         arg = ST(1);
1540         SvGETMAGIC(arg);
1541
1542         if ((items < 2) || ! SvOK(arg)) {
1543             XSRETURN_UNDEF;
1544         }
1545
1546         /* threads->object($tid) */
1547         tid = SvUV(arg);
1548
1549         /* If current thread wants its own object, then behave the same as
1550            ->self() */
1551         thread = S_ithread_get(aTHX);
1552         if (thread->tid == tid) {
1553             ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1554             have_obj = 1;
1555
1556         } else {
1557             /* Walk through threads list */
1558             MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1559             for (thread = MY_POOL.main_thread.next;
1560                  thread != &MY_POOL.main_thread;
1561                  thread = thread->next)
1562             {
1563                 /* Look for TID */
1564                 if (thread->tid == tid) {
1565                     /* Ignore if detached or joined */
1566                     MUTEX_LOCK(&thread->mutex);
1567                     state = thread->state;
1568                     MUTEX_UNLOCK(&thread->mutex);
1569                     if (! (state & PERL_ITHR_UNCALLABLE)) {
1570                         /* Put object on stack */
1571                         ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1572                         have_obj = 1;
1573                     }
1574                     break;
1575                 }
1576             }
1577             MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1578         }
1579
1580         if (! have_obj) {
1581             XSRETURN_UNDEF;
1582         }
1583         /* XSRETURN(1); - implied */
1584
1585
1586 void
1587 ithread__handle(...);
1588     PREINIT:
1589         ithread *thread;
1590     CODE:
1591         PERL_UNUSED_VAR(items);
1592         thread = S_SV_to_ithread(aTHX_ ST(0));
1593 #ifdef WIN32
1594         XST_mUV(0, PTR2UV(&thread->handle));
1595 #else
1596         XST_mUV(0, PTR2UV(&thread->thr));
1597 #endif
1598         /* XSRETURN(1); - implied */
1599
1600
1601 void
1602 ithread_get_stack_size(...)
1603     PREINIT:
1604         IV stack_size;
1605         dMY_POOL;
1606     CODE:
1607         PERL_UNUSED_VAR(items);
1608         if (sv_isobject(ST(0))) {
1609             /* $thr->get_stack_size() */
1610             ithread *thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1611             stack_size = thread->stack_size;
1612         } else {
1613             /* threads->get_stack_size() */
1614             stack_size = MY_POOL.default_stack_size;
1615         }
1616         XST_mIV(0, stack_size);
1617         /* XSRETURN(1); - implied */
1618
1619
1620 void
1621 ithread_set_stack_size(...)
1622     PREINIT:
1623         IV old_size;
1624         dMY_POOL;
1625     CODE:
1626         if (items != 2) {
1627             Perl_croak(aTHX_ "Usage: threads->set_stack_size($size)");
1628         }
1629         if (sv_isobject(ST(0))) {
1630             Perl_croak(aTHX_ "Cannot change stack size of an existing thread");
1631         }
1632         if (! looks_like_number(ST(1))) {
1633             Perl_croak(aTHX_ "Stack size must be numeric");
1634         }
1635
1636         old_size = MY_POOL.default_stack_size;
1637         MY_POOL.default_stack_size = S_good_stack_size(aTHX_ SvIV(ST(1)));
1638         XST_mIV(0, old_size);
1639         /* XSRETURN(1); - implied */
1640
1641
1642 void
1643 ithread_is_running(...)
1644     PREINIT:
1645         ithread *thread;
1646     CODE:
1647         /* Object method only */
1648         if ((items != 1) || ! sv_isobject(ST(0))) {
1649             Perl_croak(aTHX_ "Usage: $thr->is_running()");
1650         }
1651
1652         thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1653         MUTEX_LOCK(&thread->mutex);
1654         ST(0) = (thread->state & PERL_ITHR_FINISHED) ? &PL_sv_no : &PL_sv_yes;
1655         MUTEX_UNLOCK(&thread->mutex);
1656         /* XSRETURN(1); - implied */
1657
1658
1659 void
1660 ithread_is_detached(...)
1661     PREINIT:
1662         ithread *thread;
1663     CODE:
1664         PERL_UNUSED_VAR(items);
1665         thread = S_SV_to_ithread(aTHX_ ST(0));
1666         MUTEX_LOCK(&thread->mutex);
1667         ST(0) = (thread->state & PERL_ITHR_DETACHED) ? &PL_sv_yes : &PL_sv_no;
1668         MUTEX_UNLOCK(&thread->mutex);
1669         /* XSRETURN(1); - implied */
1670
1671
1672 void
1673 ithread_is_joinable(...)
1674     PREINIT:
1675         ithread *thread;
1676     CODE:
1677         /* Object method only */
1678         if ((items != 1) || ! sv_isobject(ST(0))) {
1679             Perl_croak(aTHX_ "Usage: $thr->is_joinable()");
1680         }
1681
1682         thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1683         MUTEX_LOCK(&thread->mutex);
1684         ST(0) = ((thread->state & PERL_ITHR_FINISHED) &&
1685                  ! (thread->state & PERL_ITHR_UNCALLABLE))
1686             ? &PL_sv_yes : &PL_sv_no;
1687         MUTEX_UNLOCK(&thread->mutex);
1688         /* XSRETURN(1); - implied */
1689
1690
1691 void
1692 ithread_wantarray(...)
1693     PREINIT:
1694         ithread *thread;
1695     CODE:
1696         PERL_UNUSED_VAR(items);
1697         thread = S_SV_to_ithread(aTHX_ ST(0));
1698         ST(0) = ((thread->gimme & G_WANT) == G_ARRAY) ? &PL_sv_yes :
1699                 ((thread->gimme & G_WANT) == G_VOID)  ? &PL_sv_undef
1700                                        /* G_SCALAR */ : &PL_sv_no;
1701         /* XSRETURN(1); - implied */
1702
1703
1704 void
1705 ithread_set_thread_exit_only(...)
1706     PREINIT:
1707         ithread *thread;
1708     CODE:
1709         if (items != 2) {
1710             Perl_croak(aTHX_ "Usage: ->set_thread_exit_only(boolean)");
1711         }
1712         thread = S_SV_to_ithread(aTHX_ ST(0));
1713         MUTEX_LOCK(&thread->mutex);
1714         if (SvTRUE(ST(1))) {
1715             thread->state |= PERL_ITHR_THREAD_EXIT_ONLY;
1716         } else {
1717             thread->state &= ~PERL_ITHR_THREAD_EXIT_ONLY;
1718         }
1719         MUTEX_UNLOCK(&thread->mutex);
1720
1721
1722 void
1723 ithread_error(...)
1724     PREINIT:
1725         ithread *thread;
1726         SV *err = NULL;
1727     CODE:
1728         /* Object method only */
1729         if ((items != 1) || ! sv_isobject(ST(0))) {
1730             Perl_croak(aTHX_ "Usage: $thr->err()");
1731         }
1732
1733         thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1734         MUTEX_LOCK(&thread->mutex);
1735
1736         /* If thread died, then clone the error into the calling thread */
1737         if (thread->state & PERL_ITHR_DIED) {
1738 #if (PERL_VERSION < 13) || (PERL_VERSION == 13 && PERL_SUBVERSION <= 1)
1739             PerlInterpreter *other_perl;
1740             CLONE_PARAMS clone_params;
1741             ithread *current_thread;
1742
1743             other_perl = thread->interp;
1744             clone_params.stashes = newAV();
1745             clone_params.flags = CLONEf_JOIN_IN;
1746             PL_ptr_table = ptr_table_new();
1747             current_thread = S_ithread_get(aTHX);
1748             S_ithread_set(aTHX_ thread);
1749             /* Ensure 'meaningful' addresses retain their meaning */
1750             ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1751             ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1752             ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1753             err = sv_dup(thread->err, &clone_params);
1754             S_ithread_set(aTHX_ current_thread);
1755             SvREFCNT_dec(clone_params.stashes);
1756             SvREFCNT_inc_void(err);
1757             /* If error was an object, bless it into the correct class */
1758             if (thread->err_class) {
1759                 sv_bless(err, gv_stashpv(thread->err_class, 1));
1760             }
1761             ptr_table_free(PL_ptr_table);
1762             PL_ptr_table = NULL;
1763 #else
1764             PerlInterpreter *other_perl = thread->interp;
1765             CLONE_PARAMS *clone_params = Perl_clone_params_new(other_perl, aTHX);
1766             ithread *current_thread;
1767
1768             clone_params->flags |= CLONEf_JOIN_IN;
1769             PL_ptr_table = ptr_table_new();
1770             current_thread = S_ithread_get(aTHX);
1771             S_ithread_set(aTHX_ thread);
1772             /* Ensure 'meaningful' addresses retain their meaning */
1773             ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1774             ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1775             ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1776             err = sv_dup(thread->err, clone_params);
1777             S_ithread_set(aTHX_ current_thread);
1778             Perl_clone_params_del(clone_params);
1779             SvREFCNT_inc_void(err);
1780             /* If error was an object, bless it into the correct class */
1781             if (thread->err_class) {
1782                 sv_bless(err, gv_stashpv(thread->err_class, 1));
1783             }
1784             ptr_table_free(PL_ptr_table);
1785             PL_ptr_table = NULL;
1786 #endif
1787         }
1788
1789         MUTEX_UNLOCK(&thread->mutex);
1790
1791         if (! err) {
1792             XSRETURN_UNDEF;
1793         }
1794
1795         ST(0) = sv_2mortal(err);
1796         /* XSRETURN(1); - implied */
1797
1798
1799 #endif /* USE_ITHREADS */
1800
1801
1802 BOOT:
1803 {
1804 #ifdef USE_ITHREADS
1805     SV *my_pool_sv = *hv_fetch(PL_modglobal, MY_POOL_KEY,
1806                                sizeof(MY_POOL_KEY)-1, TRUE);
1807     my_pool_t *my_poolp = (my_pool_t*)SvPVX(newSV(sizeof(my_pool_t)-1));
1808
1809     MY_CXT_INIT;
1810
1811     Zero(my_poolp, 1, my_pool_t);
1812     sv_setuv(my_pool_sv, PTR2UV(my_poolp));
1813
1814     PL_perl_destruct_level = 2;
1815     MUTEX_INIT(&MY_POOL.create_destruct_mutex);
1816     MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1817
1818     PL_threadhook = &Perl_ithread_hook;
1819
1820     MY_POOL.tid_counter = 1;
1821 #  ifdef THREAD_CREATE_NEEDS_STACK
1822     MY_POOL.default_stack_size = THREAD_CREATE_NEEDS_STACK;
1823 #  endif
1824
1825     /* The 'main' thread is thread 0.
1826      * It is detached (unjoinable) and immortal.
1827      */
1828
1829     MUTEX_INIT(&MY_POOL.main_thread.mutex);
1830
1831     /* Head of the threads list */
1832     MY_POOL.main_thread.next = &MY_POOL.main_thread;
1833     MY_POOL.main_thread.prev = &MY_POOL.main_thread;
1834
1835     MY_POOL.main_thread.count = 1;                  /* Immortal */
1836
1837     MY_POOL.main_thread.interp = aTHX;
1838     MY_POOL.main_thread.state = PERL_ITHR_DETACHED; /* Detached */
1839     MY_POOL.main_thread.stack_size = MY_POOL.default_stack_size;
1840 #  ifdef WIN32
1841     MY_POOL.main_thread.thr = GetCurrentThreadId();
1842 #  else
1843     MY_POOL.main_thread.thr = pthread_self();
1844 #  endif
1845
1846     S_ithread_set(aTHX_ &MY_POOL.main_thread);
1847     MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1848 #endif /* USE_ITHREADS */
1849 }