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