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