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