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