This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
535d5ac6dff1474a993345460da88e53c3e46777
[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         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
754         {
755           int fd = PerlIO_fileno(Perl_error_log);
756           if (fd >= 0) {
757             /* If there's no error_log, we cannot scream about it missing. */
758             PERL_UNUSED_RESULT(PerlLIO_write(fd, PL_no_mem, strlen(PL_no_mem)));
759           }
760         }
761         my_exit(1);
762     }
763     Zero(thread, 1, ithread);
764
765     /* Add to threads list */
766     thread->next = &MY_POOL.main_thread;
767     thread->prev = MY_POOL.main_thread.prev;
768     MY_POOL.main_thread.prev = thread;
769     thread->prev->next = thread;
770     MY_POOL.total_threads++;
771
772     /* 1 ref to be held by the local var 'thread' in S_ithread_run().
773      * 1 ref to be held by the threads object that we assume we will
774      *      be embedded in upon our return.
775      * 1 ref to be the responsibility of join/detach, so we don't get
776      *      freed until join/detach, even if no thread objects remain.
777      *      This allows the following to work:
778      *          { threads->create(sub{...}); } threads->object(1)->join;
779      */
780     thread->count = 3;
781
782     /* Block new thread until ->create() call finishes */
783     MUTEX_INIT(&thread->mutex);
784     MUTEX_LOCK(&thread->mutex); /* See S_ithread_run() for more detail. */
785
786     thread->tid = MY_POOL.tid_counter++;
787     thread->stack_size = S_good_stack_size(aTHX_ stack_size);
788     thread->gimme = gimme;
789     thread->state = exit_opt;
790
791     /* "Clone" our interpreter into the thread's interpreter.
792      * This gives thread access to "static data" and code.
793      */
794     PerlIO_flush((PerlIO *)NULL);
795     S_ithread_set(aTHX_ thread);
796
797     SAVEBOOL(PL_srand_called); /* Save this so it becomes the correct value */
798     PL_srand_called = FALSE;   /* Set it to false so we can detect if it gets
799                                   set during the clone */
800
801 #ifdef THREAD_SIGNAL_BLOCKING
802     /* perl_clone() will leave us the new interpreter's context.  This poses
803      * two problems for our signal handler.  First, it sets the new context
804      * before the new interpreter struct is fully initialized, so our signal
805      * handler might find bogus data in the interpreter struct it gets.
806      * Second, even if the interpreter is initialized before a signal comes in,
807      * we would like to avoid that interpreter receiving notifications for
808      * signals (especially when they ought to be for the one running in this
809      * thread), until it is running in its own thread.  Another problem is that
810      * the new thread will not have set the context until some time after it
811      * has started, so it won't be safe for our signal handler to run until
812      * that time.
813      *
814      * So we block most signals here, so the new thread will inherit the signal
815      * mask, and unblock them right after the thread creation.  The original
816      * mask is saved in the thread struct so that the new thread can restore
817      * the original mask.
818      */
819     S_block_most_signals(&thread->initial_sigmask);
820 #endif
821
822 #ifdef WIN32
823     thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE | CLONEf_CLONE_HOST);
824 #else
825     thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE);
826 #endif
827
828     /* perl_clone() leaves us in new interpreter's context.  As it is tricky
829      * to spot an implicit aTHX, create a new scope with aTHX matching the
830      * context for the duration of our work for new interpreter.
831      */
832     {
833 #if (PERL_VERSION > 13) || (PERL_VERSION == 13 && PERL_SUBVERSION > 1)
834         CLONE_PARAMS *clone_param = Perl_clone_params_new(aTHX, thread->interp);
835 #else
836         CLONE_PARAMS clone_param_s;
837         CLONE_PARAMS *clone_param = &clone_param_s;
838 #endif
839         dTHXa(thread->interp);
840
841         MY_CXT_CLONE;
842
843 #if (PERL_VERSION < 13) || (PERL_VERSION == 13 && PERL_SUBVERSION <= 1)
844         clone_param->flags = 0;
845 #endif
846
847         /* Here we remove END blocks since they should only run in the thread
848          * they are created
849          */
850         SvREFCNT_dec(PL_endav);
851         PL_endav = NULL;
852
853         if (SvPOK(init_function)) {
854             thread->init_function = newSV(0);
855             sv_copypv(thread->init_function, init_function);
856         } else {
857             thread->init_function = sv_dup_inc(init_function, clone_param);
858         }
859
860         thread->params = params = newAV();
861         av_extend(params, num_params - 1);
862         AvFILLp(params) = num_params - 1;
863         array = AvARRAY(params);
864
865         /* params_start is an offset onto the Perl stack. This can be
866            reallocated (and hence move) as a side effect of calls to
867            perl_clone() and sv_dup_inc(). Hence copy the parameters
868            somewhere under our control first, before duplicating.  */
869 #if (PERL_VERSION > 8)
870         Copy(parent_perl->Istack_base + params_start, array, num_params, SV *);
871 #else
872         Copy(parent_perl->Tstack_base + params_start, array, num_params, SV *);
873 #endif
874         while (num_params--) {
875             *array = sv_dup_inc(*array, clone_param);
876             ++array;
877         }
878 #if (PERL_VERSION > 13) || (PERL_VERSION == 13 && PERL_SUBVERSION > 1)
879         Perl_clone_params_del(clone_param);
880 #endif
881
882 #if PERL_VERSION <= 8 && PERL_SUBVERSION <= 7
883         /* The code below checks that anything living on the tmps stack and
884          * has been cloned (so it lives in the ptr_table) has a refcount
885          * higher than 0.
886          *
887          * If the refcount is 0 it means that a something on the stack/context
888          * was holding a reference to it and since we init_stacks() in
889          * perl_clone that won't get cleaned and we will get a leaked scalar.
890          * The reason it was cloned was that it lived on the @_ stack.
891          *
892          * Example of this can be found in bugreport 15837 where calls in the
893          * parameter list end up as a temp.
894          *
895          * As of 5.8.8 this is done in perl_clone.
896          */
897         while (tmps_ix > 0) {
898             SV* sv = (SV*)ptr_table_fetch(PL_ptr_table, tmps_tmp[tmps_ix]);
899             tmps_ix--;
900             if (sv && SvREFCNT(sv) == 0) {
901                 SvREFCNT_inc_void(sv);
902                 SvREFCNT_dec(sv);
903             }
904         }
905 #endif
906
907         SvTEMP_off(thread->init_function);
908         ptr_table_free(PL_ptr_table);
909         PL_ptr_table = NULL;
910         PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
911     }
912     S_ithread_set(aTHX_ current_thread);
913     PERL_SET_CONTEXT(aTHX);
914
915     /* Create/start the thread */
916 #ifdef WIN32
917     thread->handle = CreateThread(NULL,
918                                   (DWORD)thread->stack_size,
919                                   S_ithread_run,
920                                   (LPVOID)thread,
921                                   STACK_SIZE_PARAM_IS_A_RESERVATION,
922                                   &thread->thr);
923 #else
924     {
925         STATIC pthread_attr_t attr;
926         STATIC int attr_inited = 0;
927         STATIC int attr_joinable = PTHREAD_CREATE_JOINABLE;
928         if (! attr_inited) {
929             pthread_attr_init(&attr);
930             attr_inited = 1;
931         }
932
933 #  ifdef PTHREAD_ATTR_SETDETACHSTATE
934         /* Threads start out joinable */
935         PTHREAD_ATTR_SETDETACHSTATE(&attr, attr_joinable);
936 #  endif
937
938 #  ifdef _POSIX_THREAD_ATTR_STACKSIZE
939         /* Set thread's stack size */
940         if (thread->stack_size > 0) {
941             rc_stack_size = pthread_attr_setstacksize(&attr, (size_t)thread->stack_size);
942         }
943 #  endif
944
945         /* Create the thread */
946         if (! rc_stack_size) {
947 #  ifdef OLD_PTHREADS_API
948             rc_thread_create = pthread_create(&thread->thr,
949                                               attr,
950                                               S_ithread_run,
951                                               (void *)thread);
952 #  else
953 #    if defined(HAS_PTHREAD_ATTR_SETSCOPE) && defined(PTHREAD_SCOPE_SYSTEM)
954             pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM);
955 #    endif
956             rc_thread_create = pthread_create(&thread->thr,
957                                               &attr,
958                                               S_ithread_run,
959                                               (void *)thread);
960 #  endif
961         }
962
963 #ifdef THREAD_SIGNAL_BLOCKING
964     /* Now it's safe to accept signals, since we're in our own interpreter's
965      * context and we have created the thread.
966      */
967     S_set_sigmask(&thread->initial_sigmask);
968 #endif
969
970 #  ifdef _POSIX_THREAD_ATTR_STACKSIZE
971         /* Try to get thread's actual stack size */
972         {
973             size_t stacksize;
974 #ifdef HPUX1020
975             stacksize = pthread_attr_getstacksize(attr);
976 #else
977             if (! pthread_attr_getstacksize(&attr, &stacksize))
978 #endif
979                 if (stacksize > 0) {
980                     thread->stack_size = (IV)stacksize;
981                 }
982         }
983 #  endif
984     }
985 #endif
986
987     /* Check for errors */
988 #ifdef WIN32
989     if (thread->handle == NULL) {
990 #else
991     if (rc_stack_size || rc_thread_create) {
992 #endif
993         /* Must unlock mutex for destruct call */
994         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
995         thread->state |= PERL_ITHR_NONVIABLE;
996         S_ithread_free(aTHX_ thread);   /* Releases MUTEX */
997 #ifndef WIN32
998         if (ckWARN_d(WARN_THREADS)) {
999             if (rc_stack_size) {
1000                 Perl_warn(aTHX_ "Thread creation failed: pthread_attr_setstacksize(%" IVdf ") returned %d", thread->stack_size, rc_stack_size);
1001             } else {
1002                 Perl_warn(aTHX_ "Thread creation failed: pthread_create returned %d", rc_thread_create);
1003             }
1004         }
1005 #endif
1006         return (NULL);
1007     }
1008
1009     MY_POOL.running_threads++;
1010     return (thread);
1011 }
1012
1013 #endif /* USE_ITHREADS */
1014
1015
1016 MODULE = threads    PACKAGE = threads    PREFIX = ithread_
1017 PROTOTYPES: DISABLE
1018
1019 #ifdef USE_ITHREADS
1020
1021 void
1022 ithread_create(...)
1023     PREINIT:
1024         char *classname;
1025         ithread *thread;
1026         SV *function_to_call;
1027         HV *specs;
1028         IV stack_size;
1029         int context;
1030         int exit_opt;
1031         SV *thread_exit_only;
1032         char *str;
1033         int idx;
1034         dMY_POOL;
1035     CODE:
1036         if ((items >= 2) && SvROK(ST(1)) && SvTYPE(SvRV(ST(1)))==SVt_PVHV) {
1037             if (--items < 2) {
1038                 Perl_croak(aTHX_ "Usage: threads->create(\\%%specs, function, ...)");
1039             }
1040             specs = (HV*)SvRV(ST(1));
1041             idx = 1;
1042         } else {
1043             if (items < 2) {
1044                 Perl_croak(aTHX_ "Usage: threads->create(function, ...)");
1045             }
1046             specs = NULL;
1047             idx = 0;
1048         }
1049
1050         if (sv_isobject(ST(0))) {
1051             /* $thr->create() */
1052             classname = HvNAME(SvSTASH(SvRV(ST(0))));
1053             thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1054             MUTEX_LOCK(&thread->mutex);
1055             stack_size = thread->stack_size;
1056             exit_opt = thread->state & PERL_ITHR_THREAD_EXIT_ONLY;
1057             MUTEX_UNLOCK(&thread->mutex);
1058         } else {
1059             /* threads->create() */
1060             classname = (char *)SvPV_nolen(ST(0));
1061             stack_size = MY_POOL.default_stack_size;
1062             thread_exit_only = get_sv("threads::thread_exit_only", GV_ADD);
1063             exit_opt = (SvTRUE(thread_exit_only))
1064                                     ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
1065         }
1066
1067         function_to_call = ST(idx+1);
1068
1069         context = -1;
1070         if (specs) {
1071             SV **svp;
1072             /* stack_size */
1073             if ((svp = hv_fetch(specs, "stack", 5, 0))) {
1074                 stack_size = SvIV(*svp);
1075             } else if ((svp = hv_fetch(specs, "stacksize", 9, 0))) {
1076                 stack_size = SvIV(*svp);
1077             } else if ((svp = hv_fetch(specs, "stack_size", 10, 0))) {
1078                 stack_size = SvIV(*svp);
1079             }
1080
1081             /* context */
1082             if ((svp = hv_fetch(specs, "context", 7, 0))) {
1083                 str = (char *)SvPV_nolen(*svp);
1084                 switch (*str) {
1085                     case 'a':
1086                     case 'A':
1087                     case 'l':
1088                     case 'L':
1089                         context = G_ARRAY;
1090                         break;
1091                     case 's':
1092                     case 'S':
1093                         context = G_SCALAR;
1094                         break;
1095                     case 'v':
1096                     case 'V':
1097                         context = G_VOID;
1098                         break;
1099                     default:
1100                         Perl_croak(aTHX_ "Invalid context: %s", str);
1101                 }
1102             } else if ((svp = hv_fetch(specs, "array", 5, 0))) {
1103                 if (SvTRUE(*svp)) {
1104                     context = G_ARRAY;
1105                 }
1106             } else if ((svp = hv_fetch(specs, "list", 4, 0))) {
1107                 if (SvTRUE(*svp)) {
1108                     context = G_ARRAY;
1109                 }
1110             } else if ((svp = hv_fetch(specs, "scalar", 6, 0))) {
1111                 if (SvTRUE(*svp)) {
1112                     context = G_SCALAR;
1113                 }
1114             } else if ((svp = hv_fetch(specs, "void", 4, 0))) {
1115                 if (SvTRUE(*svp)) {
1116                     context = G_VOID;
1117                 }
1118             }
1119
1120             /* exit => thread_only */
1121             if ((svp = hv_fetch(specs, "exit", 4, 0))) {
1122                 str = (char *)SvPV_nolen(*svp);
1123                 exit_opt = (*str == 't' || *str == 'T')
1124                                     ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
1125             }
1126         }
1127         if (context == -1) {
1128             context = GIMME_V;  /* Implicit context */
1129         } else {
1130             context |= (GIMME_V & (~(G_ARRAY|G_SCALAR|G_VOID)));
1131         }
1132
1133         /* Create thread */
1134         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1135         thread = S_ithread_create(aTHX_ function_to_call,
1136                                         stack_size,
1137                                         context,
1138                                         exit_opt,
1139                                         ax + idx + 2,
1140                                         items > 2 ? items - 2 : 0);
1141         if (! thread) {
1142             XSRETURN_UNDEF;     /* Mutex already unlocked */
1143         }
1144         ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, FALSE));
1145         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1146
1147         /* Let thread run. */
1148         /* See S_ithread_run() for more detail. */
1149         MUTEX_UNLOCK(&thread->mutex);
1150
1151         /* XSRETURN(1); - implied */
1152
1153
1154 void
1155 ithread_list(...)
1156     PREINIT:
1157         char *classname;
1158         ithread *thread;
1159         int list_context;
1160         IV count = 0;
1161         int want_running = 0;
1162         int state;
1163         dMY_POOL;
1164     PPCODE:
1165         /* Class method only */
1166         if (SvROK(ST(0))) {
1167             Perl_croak(aTHX_ "Usage: threads->list(...)");
1168         }
1169         classname = (char *)SvPV_nolen(ST(0));
1170
1171         /* Calling context */
1172         list_context = (GIMME_V == G_ARRAY);
1173
1174         /* Running or joinable parameter */
1175         if (items > 1) {
1176             want_running = SvTRUE(ST(1));
1177         }
1178
1179         /* Walk through threads list */
1180         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1181         for (thread = MY_POOL.main_thread.next;
1182              thread != &MY_POOL.main_thread;
1183              thread = thread->next)
1184         {
1185             MUTEX_LOCK(&thread->mutex);
1186             state = thread->state;
1187             MUTEX_UNLOCK(&thread->mutex);
1188
1189             /* Ignore detached or joined threads */
1190             if (state & PERL_ITHR_UNCALLABLE) {
1191                 continue;
1192             }
1193
1194             /* Filter per parameter */
1195             if (items > 1) {
1196                 if (want_running) {
1197                     if (state & PERL_ITHR_FINISHED) {
1198                         continue;   /* Not running */
1199                     }
1200                 } else {
1201                     if (! (state & PERL_ITHR_FINISHED)) {
1202                         continue;   /* Still running - not joinable yet */
1203                     }
1204                 }
1205             }
1206
1207             /* Push object on stack if list context */
1208             if (list_context) {
1209                 XPUSHs(sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE)));
1210             }
1211             count++;
1212         }
1213         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1214         /* If scalar context, send back count */
1215         if (! list_context) {
1216             XSRETURN_IV(count);
1217         }
1218
1219
1220 void
1221 ithread_self(...)
1222     PREINIT:
1223         char *classname;
1224         ithread *thread;
1225     CODE:
1226         /* Class method only */
1227         if ((items != 1) || SvROK(ST(0))) {
1228             Perl_croak(aTHX_ "Usage: threads->self()");
1229         }
1230         classname = (char *)SvPV_nolen(ST(0));
1231
1232         thread = S_ithread_get(aTHX);
1233
1234         ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1235         /* XSRETURN(1); - implied */
1236
1237
1238 void
1239 ithread_tid(...)
1240     PREINIT:
1241         ithread *thread;
1242     CODE:
1243         PERL_UNUSED_VAR(items);
1244         thread = S_SV_to_ithread(aTHX_ ST(0));
1245         XST_mUV(0, thread->tid);
1246         /* XSRETURN(1); - implied */
1247
1248
1249 void
1250 ithread_join(...)
1251     PREINIT:
1252         ithread *thread;
1253         ithread *current_thread;
1254         int join_err;
1255         AV *params = NULL;
1256         int len;
1257         int ii;
1258 #ifndef WIN32
1259         int rc_join;
1260         void *retval;
1261 #endif
1262         dMY_POOL;
1263     PPCODE:
1264         /* Object method only */
1265         if ((items != 1) || ! sv_isobject(ST(0))) {
1266             Perl_croak(aTHX_ "Usage: $thr->join()");
1267         }
1268
1269         /* Check if the thread is joinable and not ourselves */
1270         thread = S_SV_to_ithread(aTHX_ ST(0));
1271         current_thread = S_ithread_get(aTHX);
1272
1273         MUTEX_LOCK(&thread->mutex);
1274         if ((join_err = (thread->state & PERL_ITHR_UNCALLABLE))) {
1275             MUTEX_UNLOCK(&thread->mutex);
1276             Perl_croak(aTHX_ (join_err & PERL_ITHR_DETACHED)
1277                                 ? "Cannot join a detached thread"
1278                                 : "Thread already joined");
1279         } else if (thread->tid == current_thread->tid) {
1280             MUTEX_UNLOCK(&thread->mutex);
1281             Perl_croak(aTHX_ "Cannot join self");
1282         }
1283
1284         /* Mark as joined */
1285         thread->state |= PERL_ITHR_JOINED;
1286         MUTEX_UNLOCK(&thread->mutex);
1287
1288         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1289         MY_POOL.joinable_threads--;
1290         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1291
1292         /* Join the thread */
1293 #ifdef WIN32
1294         if (WaitForSingleObject(thread->handle, INFINITE) != WAIT_OBJECT_0) {
1295             /* Timeout/abandonment unexpected here; check $^E */
1296             Perl_croak(aTHX_ "PANIC: underlying join failed");
1297         };
1298 #else
1299         if ((rc_join = pthread_join(thread->thr, &retval)) != 0) {
1300             /* In progress/deadlock/unknown unexpected here; check $! */
1301             errno = rc_join;
1302             Perl_croak(aTHX_ "PANIC: underlying join failed");
1303         };
1304 #endif
1305
1306         MUTEX_LOCK(&thread->mutex);
1307         /* Get the return value from the call_sv */
1308         /* Objects do not survive this process - FIXME */
1309         if ((thread->gimme & G_WANT) != G_VOID) {
1310 #if (PERL_VERSION < 13) || (PERL_VERSION == 13 && PERL_SUBVERSION <= 1)
1311             AV *params_copy;
1312             PerlInterpreter *other_perl;
1313             CLONE_PARAMS clone_params;
1314
1315             params_copy = thread->params;
1316             other_perl = thread->interp;
1317             clone_params.stashes = newAV();
1318             clone_params.flags = CLONEf_JOIN_IN;
1319             PL_ptr_table = ptr_table_new();
1320             S_ithread_set(aTHX_ thread);
1321             /* Ensure 'meaningful' addresses retain their meaning */
1322             ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1323             ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1324             ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1325             params = (AV *)sv_dup((SV*)params_copy, &clone_params);
1326             S_ithread_set(aTHX_ current_thread);
1327             SvREFCNT_dec(clone_params.stashes);
1328             SvREFCNT_inc_void(params);
1329             ptr_table_free(PL_ptr_table);
1330             PL_ptr_table = NULL;
1331 #else
1332             AV *params_copy;
1333             PerlInterpreter *other_perl = thread->interp;
1334             CLONE_PARAMS *clone_params = Perl_clone_params_new(other_perl, aTHX);
1335
1336             params_copy = thread->params;
1337             clone_params->flags |= CLONEf_JOIN_IN;
1338             PL_ptr_table = ptr_table_new();
1339             S_ithread_set(aTHX_ thread);
1340             /* Ensure 'meaningful' addresses retain their meaning */
1341             ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1342             ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1343             ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1344             params = (AV *)sv_dup((SV*)params_copy, clone_params);
1345             S_ithread_set(aTHX_ current_thread);
1346             Perl_clone_params_del(clone_params);
1347             SvREFCNT_inc_void(params);
1348             ptr_table_free(PL_ptr_table);
1349             PL_ptr_table = NULL;
1350 #endif
1351         }
1352
1353         /* If thread didn't die, then we can free its interpreter */
1354         if (! (thread->state & PERL_ITHR_DIED)) {
1355             S_ithread_clear(aTHX_ thread);
1356         }
1357         S_ithread_free(aTHX_ thread);   /* Releases MUTEX */
1358
1359         /* If no return values, then just return */
1360         if (! params) {
1361             XSRETURN_UNDEF;
1362         }
1363
1364         /* Put return values on stack */
1365         len = (int)AvFILL(params);
1366         for (ii=0; ii <= len; ii++) {
1367             SV* param = av_shift(params);
1368             XPUSHs(sv_2mortal(param));
1369         }
1370
1371         /* Free return value array */
1372         SvREFCNT_dec(params);
1373
1374
1375 void
1376 ithread_yield(...)
1377     CODE:
1378         PERL_UNUSED_VAR(items);
1379         YIELD;
1380
1381
1382 void
1383 ithread_detach(...)
1384     PREINIT:
1385         ithread *thread;
1386         int detach_err;
1387         dMY_POOL;
1388     CODE:
1389         PERL_UNUSED_VAR(items);
1390
1391         /* Detach the thread */
1392         thread = S_SV_to_ithread(aTHX_ ST(0));
1393         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1394         MUTEX_LOCK(&thread->mutex);
1395         if (! (detach_err = (thread->state & PERL_ITHR_UNCALLABLE))) {
1396             /* Thread is detachable */
1397             thread->state |= PERL_ITHR_DETACHED;
1398 #ifdef WIN32
1399             /* Windows has no 'detach thread' function */
1400 #else
1401             PERL_THREAD_DETACH(thread->thr);
1402 #endif
1403             if (thread->state & PERL_ITHR_FINISHED) {
1404                 MY_POOL.joinable_threads--;
1405             } else {
1406                 MY_POOL.running_threads--;
1407                 MY_POOL.detached_threads++;
1408             }
1409         }
1410         MUTEX_UNLOCK(&thread->mutex);
1411         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1412
1413         if (detach_err) {
1414             Perl_croak(aTHX_ (detach_err & PERL_ITHR_DETACHED)
1415                                 ? "Thread already detached"
1416                                 : "Cannot detach a joined thread");
1417         }
1418
1419         /* If thread is finished and didn't die,
1420          * then we can free its interpreter */
1421         MUTEX_LOCK(&thread->mutex);
1422         if ((thread->state & PERL_ITHR_FINISHED) &&
1423             ! (thread->state & PERL_ITHR_DIED))
1424         {
1425             S_ithread_clear(aTHX_ thread);
1426         }
1427         S_ithread_free(aTHX_ thread);   /* Releases MUTEX */
1428
1429
1430 void
1431 ithread_kill(...)
1432     PREINIT:
1433         ithread *thread;
1434         char *sig_name;
1435         IV signal;
1436         int no_handler = 1;
1437     CODE:
1438         /* Must have safe signals */
1439         if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) {
1440             Perl_croak(aTHX_ "Cannot signal threads without safe signals");
1441         }
1442
1443         /* Object method only */
1444         if ((items != 2) || ! sv_isobject(ST(0))) {
1445             Perl_croak(aTHX_ "Usage: $thr->kill('SIG...')");
1446         }
1447
1448         /* Get signal */
1449         sig_name = SvPV_nolen(ST(1));
1450         if (isALPHA(*sig_name)) {
1451             if (*sig_name == 'S' && sig_name[1] == 'I' && sig_name[2] == 'G') {
1452                 sig_name += 3;
1453             }
1454             if ((signal = whichsig(sig_name)) < 0) {
1455                 Perl_croak(aTHX_ "Unrecognized signal name: %s", sig_name);
1456             }
1457         } else {
1458             signal = SvIV(ST(1));
1459         }
1460
1461         /* Set the signal for the thread */
1462         thread = S_SV_to_ithread(aTHX_ ST(0));
1463         MUTEX_LOCK(&thread->mutex);
1464         if (thread->interp && ! (thread->state & PERL_ITHR_FINISHED)) {
1465             dTHXa(thread->interp);
1466             if (PL_psig_pend && PL_psig_ptr[signal]) {
1467                 PL_psig_pend[signal]++;
1468                 PL_sig_pending = 1;
1469                 no_handler = 0;
1470             }
1471         } else {
1472             /* Ignore signal to terminated/finished thread */
1473             no_handler = 0;
1474         }
1475         MUTEX_UNLOCK(&thread->mutex);
1476
1477         if (no_handler) {
1478             Perl_croak(aTHX_ "Signal %s received in thread %"UVuf", but no signal handler set.", sig_name, thread->tid);
1479         }
1480
1481         /* Return the thread to allow for method chaining */
1482         ST(0) = ST(0);
1483         /* XSRETURN(1); - implied */
1484
1485
1486 void
1487 ithread_DESTROY(...)
1488     CODE:
1489         PERL_UNUSED_VAR(items);
1490         sv_unmagic(SvRV(ST(0)), PERL_MAGIC_shared_scalar);
1491
1492
1493 void
1494 ithread_equal(...)
1495     PREINIT:
1496         int are_equal = 0;
1497     CODE:
1498         PERL_UNUSED_VAR(items);
1499
1500         /* Compares TIDs to determine thread equality */
1501         if (sv_isobject(ST(0)) && sv_isobject(ST(1))) {
1502             ithread *thr1 = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1503             ithread *thr2 = INT2PTR(ithread *, SvIV(SvRV(ST(1))));
1504             are_equal = (thr1->tid == thr2->tid);
1505         }
1506         if (are_equal) {
1507             XST_mYES(0);
1508         } else {
1509             /* Return 0 on false for backward compatibility */
1510             XST_mIV(0, 0);
1511         }
1512         /* XSRETURN(1); - implied */
1513
1514
1515 void
1516 ithread_object(...)
1517     PREINIT:
1518         char *classname;
1519         SV *arg;
1520         UV tid;
1521         ithread *thread;
1522         int state;
1523         int have_obj = 0;
1524         dMY_POOL;
1525     CODE:
1526         /* Class method only */
1527         if (SvROK(ST(0))) {
1528             Perl_croak(aTHX_ "Usage: threads->object($tid)");
1529         }
1530         classname = (char *)SvPV_nolen(ST(0));
1531
1532         /* Turn $tid from PVLV to SV if needed (bug #73330) */
1533         arg = ST(1);
1534         SvGETMAGIC(arg);
1535
1536         if ((items < 2) || ! SvOK(arg)) {
1537             XSRETURN_UNDEF;
1538         }
1539
1540         /* threads->object($tid) */
1541         tid = SvUV(arg);
1542
1543         /* If current thread wants its own object, then behave the same as
1544            ->self() */
1545         thread = S_ithread_get(aTHX);
1546         if (thread->tid == tid) {
1547             ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1548             have_obj = 1;
1549
1550         } else {
1551             /* Walk through threads list */
1552             MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1553             for (thread = MY_POOL.main_thread.next;
1554                  thread != &MY_POOL.main_thread;
1555                  thread = thread->next)
1556             {
1557                 /* Look for TID */
1558                 if (thread->tid == tid) {
1559                     /* Ignore if detached or joined */
1560                     MUTEX_LOCK(&thread->mutex);
1561                     state = thread->state;
1562                     MUTEX_UNLOCK(&thread->mutex);
1563                     if (! (state & PERL_ITHR_UNCALLABLE)) {
1564                         /* Put object on stack */
1565                         ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1566                         have_obj = 1;
1567                     }
1568                     break;
1569                 }
1570             }
1571             MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1572         }
1573
1574         if (! have_obj) {
1575             XSRETURN_UNDEF;
1576         }
1577         /* XSRETURN(1); - implied */
1578
1579
1580 void
1581 ithread__handle(...);
1582     PREINIT:
1583         ithread *thread;
1584     CODE:
1585         PERL_UNUSED_VAR(items);
1586         thread = S_SV_to_ithread(aTHX_ ST(0));
1587 #ifdef WIN32
1588         XST_mUV(0, PTR2UV(&thread->handle));
1589 #else
1590         XST_mUV(0, PTR2UV(&thread->thr));
1591 #endif
1592         /* XSRETURN(1); - implied */
1593
1594
1595 void
1596 ithread_get_stack_size(...)
1597     PREINIT:
1598         IV stack_size;
1599         dMY_POOL;
1600     CODE:
1601         PERL_UNUSED_VAR(items);
1602         if (sv_isobject(ST(0))) {
1603             /* $thr->get_stack_size() */
1604             ithread *thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1605             stack_size = thread->stack_size;
1606         } else {
1607             /* threads->get_stack_size() */
1608             stack_size = MY_POOL.default_stack_size;
1609         }
1610         XST_mIV(0, stack_size);
1611         /* XSRETURN(1); - implied */
1612
1613
1614 void
1615 ithread_set_stack_size(...)
1616     PREINIT:
1617         IV old_size;
1618         dMY_POOL;
1619     CODE:
1620         if (items != 2) {
1621             Perl_croak(aTHX_ "Usage: threads->set_stack_size($size)");
1622         }
1623         if (sv_isobject(ST(0))) {
1624             Perl_croak(aTHX_ "Cannot change stack size of an existing thread");
1625         }
1626         if (! looks_like_number(ST(1))) {
1627             Perl_croak(aTHX_ "Stack size must be numeric");
1628         }
1629
1630         old_size = MY_POOL.default_stack_size;
1631         MY_POOL.default_stack_size = S_good_stack_size(aTHX_ SvIV(ST(1)));
1632         XST_mIV(0, old_size);
1633         /* XSRETURN(1); - implied */
1634
1635
1636 void
1637 ithread_is_running(...)
1638     PREINIT:
1639         ithread *thread;
1640     CODE:
1641         /* Object method only */
1642         if ((items != 1) || ! sv_isobject(ST(0))) {
1643             Perl_croak(aTHX_ "Usage: $thr->is_running()");
1644         }
1645
1646         thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1647         MUTEX_LOCK(&thread->mutex);
1648         ST(0) = (thread->state & PERL_ITHR_FINISHED) ? &PL_sv_no : &PL_sv_yes;
1649         MUTEX_UNLOCK(&thread->mutex);
1650         /* XSRETURN(1); - implied */
1651
1652
1653 void
1654 ithread_is_detached(...)
1655     PREINIT:
1656         ithread *thread;
1657     CODE:
1658         PERL_UNUSED_VAR(items);
1659         thread = S_SV_to_ithread(aTHX_ ST(0));
1660         MUTEX_LOCK(&thread->mutex);
1661         ST(0) = (thread->state & PERL_ITHR_DETACHED) ? &PL_sv_yes : &PL_sv_no;
1662         MUTEX_UNLOCK(&thread->mutex);
1663         /* XSRETURN(1); - implied */
1664
1665
1666 void
1667 ithread_is_joinable(...)
1668     PREINIT:
1669         ithread *thread;
1670     CODE:
1671         /* Object method only */
1672         if ((items != 1) || ! sv_isobject(ST(0))) {
1673             Perl_croak(aTHX_ "Usage: $thr->is_joinable()");
1674         }
1675
1676         thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1677         MUTEX_LOCK(&thread->mutex);
1678         ST(0) = ((thread->state & PERL_ITHR_FINISHED) &&
1679                  ! (thread->state & PERL_ITHR_UNCALLABLE))
1680             ? &PL_sv_yes : &PL_sv_no;
1681         MUTEX_UNLOCK(&thread->mutex);
1682         /* XSRETURN(1); - implied */
1683
1684
1685 void
1686 ithread_wantarray(...)
1687     PREINIT:
1688         ithread *thread;
1689     CODE:
1690         PERL_UNUSED_VAR(items);
1691         thread = S_SV_to_ithread(aTHX_ ST(0));
1692         ST(0) = ((thread->gimme & G_WANT) == G_ARRAY) ? &PL_sv_yes :
1693                 ((thread->gimme & G_WANT) == G_VOID)  ? &PL_sv_undef
1694                                        /* G_SCALAR */ : &PL_sv_no;
1695         /* XSRETURN(1); - implied */
1696
1697
1698 void
1699 ithread_set_thread_exit_only(...)
1700     PREINIT:
1701         ithread *thread;
1702     CODE:
1703         if (items != 2) {
1704             Perl_croak(aTHX_ "Usage: ->set_thread_exit_only(boolean)");
1705         }
1706         thread = S_SV_to_ithread(aTHX_ ST(0));
1707         MUTEX_LOCK(&thread->mutex);
1708         if (SvTRUE(ST(1))) {
1709             thread->state |= PERL_ITHR_THREAD_EXIT_ONLY;
1710         } else {
1711             thread->state &= ~PERL_ITHR_THREAD_EXIT_ONLY;
1712         }
1713         MUTEX_UNLOCK(&thread->mutex);
1714
1715
1716 void
1717 ithread_error(...)
1718     PREINIT:
1719         ithread *thread;
1720         SV *err = NULL;
1721     CODE:
1722         /* Object method only */
1723         if ((items != 1) || ! sv_isobject(ST(0))) {
1724             Perl_croak(aTHX_ "Usage: $thr->err()");
1725         }
1726
1727         thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1728         MUTEX_LOCK(&thread->mutex);
1729
1730         /* If thread died, then clone the error into the calling thread */
1731         if (thread->state & PERL_ITHR_DIED) {
1732 #if (PERL_VERSION < 13) || (PERL_VERSION == 13 && PERL_SUBVERSION <= 1)
1733             PerlInterpreter *other_perl;
1734             CLONE_PARAMS clone_params;
1735             ithread *current_thread;
1736
1737             other_perl = thread->interp;
1738             clone_params.stashes = newAV();
1739             clone_params.flags = CLONEf_JOIN_IN;
1740             PL_ptr_table = ptr_table_new();
1741             current_thread = S_ithread_get(aTHX);
1742             S_ithread_set(aTHX_ thread);
1743             /* Ensure 'meaningful' addresses retain their meaning */
1744             ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1745             ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1746             ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1747             err = sv_dup(thread->err, &clone_params);
1748             S_ithread_set(aTHX_ current_thread);
1749             SvREFCNT_dec(clone_params.stashes);
1750             SvREFCNT_inc_void(err);
1751             /* If error was an object, bless it into the correct class */
1752             if (thread->err_class) {
1753                 sv_bless(err, gv_stashpv(thread->err_class, 1));
1754             }
1755             ptr_table_free(PL_ptr_table);
1756             PL_ptr_table = NULL;
1757 #else
1758             PerlInterpreter *other_perl = thread->interp;
1759             CLONE_PARAMS *clone_params = Perl_clone_params_new(other_perl, aTHX);
1760             ithread *current_thread;
1761
1762             clone_params->flags |= CLONEf_JOIN_IN;
1763             PL_ptr_table = ptr_table_new();
1764             current_thread = S_ithread_get(aTHX);
1765             S_ithread_set(aTHX_ thread);
1766             /* Ensure 'meaningful' addresses retain their meaning */
1767             ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1768             ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1769             ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1770             err = sv_dup(thread->err, clone_params);
1771             S_ithread_set(aTHX_ current_thread);
1772             Perl_clone_params_del(clone_params);
1773             SvREFCNT_inc_void(err);
1774             /* If error was an object, bless it into the correct class */
1775             if (thread->err_class) {
1776                 sv_bless(err, gv_stashpv(thread->err_class, 1));
1777             }
1778             ptr_table_free(PL_ptr_table);
1779             PL_ptr_table = NULL;
1780 #endif
1781         }
1782
1783         MUTEX_UNLOCK(&thread->mutex);
1784
1785         if (! err) {
1786             XSRETURN_UNDEF;
1787         }
1788
1789         ST(0) = sv_2mortal(err);
1790         /* XSRETURN(1); - implied */
1791
1792
1793 #endif /* USE_ITHREADS */
1794
1795
1796 BOOT:
1797 {
1798 #ifdef USE_ITHREADS
1799     SV *my_pool_sv = *hv_fetch(PL_modglobal, MY_POOL_KEY,
1800                                sizeof(MY_POOL_KEY)-1, TRUE);
1801     my_pool_t *my_poolp = (my_pool_t*)SvPVX(newSV(sizeof(my_pool_t)-1));
1802
1803     MY_CXT_INIT;
1804
1805     Zero(my_poolp, 1, my_pool_t);
1806     sv_setuv(my_pool_sv, PTR2UV(my_poolp));
1807
1808     PL_perl_destruct_level = 2;
1809     MUTEX_INIT(&MY_POOL.create_destruct_mutex);
1810     MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1811
1812     PL_threadhook = &Perl_ithread_hook;
1813
1814     MY_POOL.tid_counter = 1;
1815 #  ifdef THREAD_CREATE_NEEDS_STACK
1816     MY_POOL.default_stack_size = THREAD_CREATE_NEEDS_STACK;
1817 #  endif
1818
1819     /* The 'main' thread is thread 0.
1820      * It is detached (unjoinable) and immortal.
1821      */
1822
1823     MUTEX_INIT(&MY_POOL.main_thread.mutex);
1824
1825     /* Head of the threads list */
1826     MY_POOL.main_thread.next = &MY_POOL.main_thread;
1827     MY_POOL.main_thread.prev = &MY_POOL.main_thread;
1828
1829     MY_POOL.main_thread.count = 1;                  /* Immortal */
1830
1831     MY_POOL.main_thread.interp = aTHX;
1832     MY_POOL.main_thread.state = PERL_ITHR_DETACHED; /* Detached */
1833     MY_POOL.main_thread.stack_size = MY_POOL.default_stack_size;
1834 #  ifdef WIN32
1835     MY_POOL.main_thread.thr = GetCurrentThreadId();
1836 #  else
1837     MY_POOL.main_thread.thr = pthread_self();
1838 #  endif
1839
1840     S_ithread_set(aTHX_ &MY_POOL.main_thread);
1841     MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1842 #endif /* USE_ITHREADS */
1843 }