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