This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Eliminated unitialised clone_params value bug accidentally added with
[perl5.git] / ext / threads / threads.xs
CommitLineData
68795e93
NIS
1#define PERL_NO_GET_CONTEXT
2#include "EXTERN.h"
3#include "perl.h"
4#include "XSUB.h"
4dcb9e53
JH
5/* Workaround for XSUB.h bug under WIN32 */
6#ifdef WIN32
7# undef setjmp
c608f8c0
JH
8# if !defined(__BORLANDC__)
9# define setjmp(x) _setjmp(x)
10# endif
4dcb9e53 11#endif
0f1612a7 12#ifdef HAS_PPPORT_H
404aaa48 13# define NEED_PL_signals
0f1612a7
JH
14# define NEED_newRV_noinc
15# define NEED_sv_2pv_nolen
16# include "ppport.h"
17# include "threads.h"
18#endif
68795e93 19
73e09c8f
JH
20#ifdef USE_ITHREADS
21
68795e93 22#ifdef WIN32
fc04eb16 23# include <windows.h>
514612b7
JH
24 /* Supposed to be in Winbase.h */
25# ifndef STACK_SIZE_PARAM_IS_A_RESERVATION
26# define STACK_SIZE_PARAM_IS_A_RESERVATION 0x00010000
27# endif
fc04eb16 28# include <win32thread.h>
68795e93 29#else
fc04eb16 30# ifdef OS2
5c728af0 31typedef perl_os_thread pthread_t;
fc04eb16
JH
32# else
33# include <pthread.h>
34# endif
35# include <thread.h>
36# define PERL_THREAD_SETSPECIFIC(k,v) pthread_setspecific(k,v)
37# ifdef OLD_PTHREADS_API
38# define PERL_THREAD_DETACH(t) pthread_detach(&(t))
39# else
40# define PERL_THREAD_DETACH(t) pthread_detach((t))
41# endif
467f3f08 42#endif
d305c2c9
JH
43#if !defined(HAS_GETPAGESIZE) && defined(I_SYS_PARAM)
44# include <sys/param.h>
45#endif
68795e93 46
62375a60 47/* Values for 'state' member */
69a9b4b8
RGS
48#define PERL_ITHR_DETACHED 1
49#define PERL_ITHR_JOINED 2
50#define PERL_ITHR_FINISHED 4
51#define PERL_ITHR_THREAD_EXIT_ONLY 8
adc09a0e
JH
52#define PERL_ITHR_NONVIABLE 16
53#define PERL_ITHR_DESTROYED 32
fc04eb16
JH
54
55typedef struct _ithread {
56 struct _ithread *next; /* Next thread in the list */
57 struct _ithread *prev; /* Prev thread in the list */
58 PerlInterpreter *interp; /* The threads interpreter */
59 UV tid; /* Threads module's thread id */
60 perl_mutex mutex; /* Mutex for updating things in this struct */
9feacc09 61 int count; /* How many SVs have a reference to us */
fc04eb16
JH
62 int state; /* Detached, joined, finished, etc. */
63 int gimme; /* Context of create */
64 SV *init_function; /* Code to run */
65 SV *params; /* Args to pass function */
68795e93 66#ifdef WIN32
fc04eb16
JH
67 DWORD thr; /* OS's idea if thread id */
68 HANDLE handle; /* OS's waitable handle */
68795e93 69#else
fc04eb16 70 pthread_t thr; /* OS's handle for the thread */
68795e93 71#endif
514612b7 72 IV stack_size;
68795e93
NIS
73} ithread;
74
fc04eb16 75
5c6ff896 76#define MY_CXT_KEY "threads::_cxt" XS_VERSION
628ab322
DM
77
78typedef struct {
861d5cbe
JH
79 /* Used by Perl interpreter for thread context switching */
80 ithread *context;
628ab322
DM
81} my_cxt_t;
82
83START_MY_CXT
84
68795e93 85
5c6ff896 86#define MY_POOL_KEY "threads::_pool" XS_VERSION
68795e93 87
5c6ff896
JH
88typedef struct {
89 /* Structure for 'main' thread
90 * Also forms the 'base' for the doubly-linked list of threads */
91 ithread main_thread;
92
93 /* Protects the creation and destruction of threads*/
94 perl_mutex create_destruct_mutex;
95
96 UV tid_counter;
97 IV joinable_threads;
98 IV running_threads;
99 IV detached_threads;
100 IV default_stack_size;
101 IV page_size;
102} my_pool_t;
103
104#define dMY_POOL \
105 SV *my_pool_sv = *hv_fetch(PL_modglobal, MY_POOL_KEY, \
106 sizeof(MY_POOL_KEY)-1, TRUE); \
107 my_pool_t *my_poolp = INT2PTR(my_pool_t*, SvUV(my_pool_sv))
108
109#define MY_POOL (*my_poolp)
c05ae023
AB
110
111
fc04eb16 112/* Used by Perl interpreter for thread context switching */
861d5cbe 113STATIC void
fc04eb16 114S_ithread_set(pTHX_ ithread *thread)
c05ae023 115{
628ab322 116 dMY_CXT;
861d5cbe 117 MY_CXT.context = thread;
c05ae023
AB
118}
119
861d5cbe 120STATIC ithread *
fc04eb16
JH
121S_ithread_get(pTHX)
122{
628ab322 123 dMY_CXT;
861d5cbe 124 return (MY_CXT.context);
c05ae023
AB
125}
126
127
fc04eb16
JH
128/* Free any data (such as the Perl interpreter) attached to an ithread
129 * structure. This is a bit like undef on SVs, where the SV isn't freed,
130 * but the PVX is. Must be called with thread->mutex already held.
2e676467 131 */
861d5cbe 132STATIC void
fc04eb16 133S_ithread_clear(pTHX_ ithread *thread)
2e676467
DM
134{
135 PerlInterpreter *interp;
fc04eb16 136
adc09a0e
JH
137 assert(((thread->state & PERL_ITHR_FINISHED) &&
138 (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)))
139 ||
140 (thread->state & PERL_ITHR_NONVIABLE));
2e676467
DM
141
142 interp = thread->interp;
143 if (interp) {
fc04eb16
JH
144 dTHXa(interp);
145
146 PERL_SET_CONTEXT(interp);
147 S_ithread_set(aTHX_ thread);
f2cba68d 148
fc04eb16
JH
149 SvREFCNT_dec(thread->params);
150 thread->params = Nullsv;
2e676467 151
fc04eb16 152 perl_destruct(interp);
9ca4d7fd 153 perl_free(interp);
fc04eb16 154 thread->interp = NULL;
2e676467 155 }
fc04eb16 156
2e676467
DM
157 PERL_SET_CONTEXT(aTHX);
158}
159
68795e93 160
fc04eb16 161/* Free an ithread structure and any attached data if its count == 0 */
861d5cbe 162STATIC void
fc04eb16 163S_ithread_destruct(pTHX_ ithread *thread)
68795e93 164{
adc09a0e 165 int destroy = 0;
385d56e4 166#ifdef WIN32
fc04eb16 167 HANDLE handle;
385d56e4 168#endif
adc09a0e
JH
169 dMY_POOL;
170
171 /* Determine if thread can be destroyed now */
172 MUTEX_LOCK(&thread->mutex);
fc04eb16 173 if (thread->count != 0) {
adc09a0e
JH
174 destroy = 0;
175 } else if (thread->state & PERL_ITHR_DESTROYED) {
176 destroy = 0;
177 } else if (thread->state & PERL_ITHR_NONVIABLE) {
178 thread->state |= PERL_ITHR_DESTROYED;
179 destroy = 1;
180 } else if (! (thread->state & PERL_ITHR_FINISHED)) {
181 destroy = 0;
182 } else if (! (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED))) {
183 destroy = 0;
184 } else {
185 thread->state |= PERL_ITHR_DESTROYED;
186 destroy = 1;
fc04eb16 187 }
adc09a0e
JH
188 MUTEX_UNLOCK(&thread->mutex);
189 if (! destroy) return;
9feacc09 190
fc04eb16
JH
191 /* Main thread (0) is immortal and should never get here */
192 assert(thread->tid != 0);
193
194 /* Remove from circular list of threads */
5c6ff896 195 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
adc09a0e
JH
196 assert(thread->prev && thread->next);
197 thread->next->prev = thread->prev;
198 thread->prev->next = thread->next;
fc04eb16
JH
199 thread->next = NULL;
200 thread->prev = NULL;
5c6ff896 201 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
c2f2a82b 202
fc04eb16 203 /* Thread is now disowned */
9ca4d7fd 204 MUTEX_LOCK(&thread->mutex);
fc04eb16 205 S_ithread_clear(aTHX_ thread);
385d56e4
JH
206
207#ifdef WIN32
fc04eb16
JH
208 handle = thread->handle;
209 thread->handle = NULL;
385d56e4 210#endif
fc04eb16
JH
211 MUTEX_UNLOCK(&thread->mutex);
212 MUTEX_DESTROY(&thread->mutex);
385d56e4 213
c7667023 214#ifdef WIN32
fea7688c 215 if (handle) {
fc04eb16 216 CloseHandle(handle);
fea7688c 217 }
c7667023 218#endif
385d56e4 219
fc04eb16
JH
220 /* Call PerlMemShared_free() in the context of the "first" interpreter
221 * per http://www.nntp.perl.org/group/perl.perl5.porters/110772
222 */
5c6ff896 223 aTHX = MY_POOL.main_thread.interp;
fc04eb16 224 PerlMemShared_free(thread);
68795e93
NIS
225}
226
fc04eb16 227
69a9b4b8 228/* Warn if exiting with any unjoined threads */
861d5cbe 229STATIC int
69a9b4b8 230S_exit_warning(pTHX)
62375a60 231{
60bd5ef6 232 int veto_cleanup;
adc09a0e 233 dMY_POOL;
69a9b4b8 234
5c6ff896
JH
235 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
236 veto_cleanup = (MY_POOL.running_threads || MY_POOL.joinable_threads);
237 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
60bd5ef6
RGS
238
239 if (veto_cleanup) {
fc04eb16 240 if (ckWARN_d(WARN_THREADS)) {
4dcb9e53
JH
241 Perl_warn(aTHX_ "Perl exited with active threads:\n\t%"
242 IVdf " running and unjoined\n\t%"
243 IVdf " finished and unjoined\n\t%"
244 IVdf " running and detached\n",
5c6ff896
JH
245 MY_POOL.running_threads,
246 MY_POOL.joinable_threads,
247 MY_POOL.detached_threads);
fc04eb16 248 }
62375a60 249 }
69a9b4b8 250
fc04eb16 251 return (veto_cleanup);
62375a60
NIS
252}
253
69a9b4b8
RGS
254/* Called on exit from main thread */
255int
256Perl_ithread_hook(pTHX)
257{
5c6ff896 258 dMY_POOL;
b5c80a23 259 return ((aTHX == MY_POOL.main_thread.interp) ? S_exit_warning(aTHX) : 0);
69a9b4b8
RGS
260}
261
68795e93
NIS
262
263/* MAGIC (in mg.h sense) hooks */
264
265int
266ithread_mg_get(pTHX_ SV *sv, MAGIC *mg)
267{
fc04eb16 268 ithread *thread = (ithread *)mg->mg_ptr;
45977657 269 SvIV_set(sv, PTR2IV(thread));
68795e93 270 SvIOK_on(sv);
fc04eb16 271 return (0);
68795e93
NIS
272}
273
274int
275ithread_mg_free(pTHX_ SV *sv, MAGIC *mg)
276{
f2cba68d 277 ithread *thread = (ithread *)mg->mg_ptr;
f2cba68d 278
68795e93 279 MUTEX_LOCK(&thread->mutex);
adc09a0e 280 thread->count--;
f2cba68d
JH
281 MUTEX_UNLOCK(&thread->mutex);
282
adc09a0e
JH
283 /* Try to clean up thread */
284 S_ithread_destruct(aTHX_ thread);
285
fc04eb16 286 return (0);
68795e93
NIS
287}
288
289int
290ithread_mg_dup(pTHX_ MAGIC *mg, CLONE_PARAMS *param)
291{
fc04eb16 292 ithread *thread = (ithread *)mg->mg_ptr;
68795e93 293 MUTEX_LOCK(&thread->mutex);
68795e93
NIS
294 thread->count++;
295 MUTEX_UNLOCK(&thread->mutex);
fc04eb16 296 return (0);
68795e93
NIS
297}
298
299MGVTBL ithread_vtbl = {
fc04eb16
JH
300 ithread_mg_get, /* get */
301 0, /* set */
302 0, /* len */
303 0, /* clear */
304 ithread_mg_free, /* free */
305 0, /* copy */
306 ithread_mg_dup /* dup */
68795e93
NIS
307};
308
47ba8780 309
514612b7 310/* Provided default, minimum and rational stack sizes */
861d5cbe
JH
311STATIC IV
312S_good_stack_size(pTHX_ IV stack_size)
514612b7 313{
5c6ff896
JH
314 dMY_POOL;
315
514612b7 316 /* Use default stack size if no stack size specified */
fea7688c 317 if (! stack_size) {
5c6ff896 318 return (MY_POOL.default_stack_size);
fea7688c 319 }
514612b7
JH
320
321#ifdef PTHREAD_STACK_MIN
322 /* Can't use less than minimum */
323 if (stack_size < PTHREAD_STACK_MIN) {
4dcb9e53 324 if (ckWARN(WARN_THREADS)) {
514612b7
JH
325 Perl_warn(aTHX_ "Using minimum thread stack size of %" IVdf, (IV)PTHREAD_STACK_MIN);
326 }
327 return (PTHREAD_STACK_MIN);
328 }
329#endif
330
331 /* Round up to page size boundary */
5c6ff896 332 if (MY_POOL.page_size <= 0) {
d305c2c9 333#if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_MMAP_PAGE_SIZE))
514612b7 334 SETERRNO(0, SS_NORMAL);
d305c2c9 335# ifdef _SC_PAGESIZE
5c6ff896 336 MY_POOL.page_size = sysconf(_SC_PAGESIZE);
d305c2c9 337# else
5c6ff896 338 MY_POOL.page_size = sysconf(_SC_MMAP_PAGE_SIZE);
d305c2c9 339# endif
5c6ff896 340 if ((long)MY_POOL.page_size < 0) {
514612b7
JH
341 if (errno) {
342 SV * const error = get_sv("@", FALSE);
343 (void)SvUPGRADE(error, SVt_PV);
344 Perl_croak(aTHX_ "PANIC: sysconf: %s", SvPV_nolen(error));
345 } else {
346 Perl_croak(aTHX_ "PANIC: sysconf: pagesize unknown");
347 }
348 }
d305c2c9
JH
349#else
350# ifdef HAS_GETPAGESIZE
5c6ff896 351 MY_POOL.page_size = getpagesize();
514612b7 352# else
d305c2c9 353# if defined(I_SYS_PARAM) && defined(PAGESIZE)
5c6ff896 354 MY_POOL.page_size = PAGESIZE;
d305c2c9 355# else
5c6ff896 356 MY_POOL.page_size = 8192; /* A conservative default */
d305c2c9 357# endif
514612b7 358# endif
5c6ff896
JH
359 if (MY_POOL.page_size <= 0) {
360 Perl_croak(aTHX_ "PANIC: bad pagesize %" IVdf, (IV)MY_POOL.page_size);
fea7688c 361 }
514612b7
JH
362#endif
363 }
5c6ff896 364 stack_size = ((stack_size + (MY_POOL.page_size - 1)) / MY_POOL.page_size) * MY_POOL.page_size;
514612b7
JH
365
366 return (stack_size);
367}
368
369
fc04eb16
JH
370/* Starts executing the thread.
371 * Passed as the C level function to run in the new thread.
b1edfb69 372 */
47ba8780 373#ifdef WIN32
861d5cbe 374STATIC THREAD_RET_TYPE
fc04eb16 375S_ithread_run(LPVOID arg)
47ba8780 376#else
861d5cbe 377STATIC void *
fc04eb16 378S_ithread_run(void * arg)
47ba8780 379#endif
fc04eb16
JH
380{
381 ithread *thread = (ithread *)arg;
69a9b4b8
RGS
382 int jmp_rc = 0;
383 I32 oldscope;
384 int exit_app = 0;
385 int exit_code = 0;
f2cba68d 386
69a9b4b8
RGS
387 dJMPENV;
388
fc04eb16 389 dTHXa(thread->interp);
47ba8780 390
5c6ff896
JH
391 dMY_POOL;
392
9ca4d7fd 393 /* Blocked until ->create() call finishes */
fc04eb16 394 MUTEX_LOCK(&thread->mutex);
fc04eb16 395 MUTEX_UNLOCK(&thread->mutex);
9ca4d7fd
JH
396
397 PERL_SET_CONTEXT(thread->interp);
398 S_ithread_set(aTHX_ thread);
47ba8780 399
fc04eb16 400 PL_perl_destruct_level = 2;
f2cba68d 401
fc04eb16
JH
402 {
403 AV *params = (AV *)SvRV(thread->params);
404 int len = (int)av_len(params)+1;
405 int ii;
406
407 dSP;
408 ENTER;
409 SAVETMPS;
410
411 /* Put args on the stack */
412 PUSHMARK(SP);
413 for (ii=0; ii < len; ii++) {
414 XPUSHs(av_shift(params));
415 }
416 PUTBACK;
417
4dcb9e53
JH
418 oldscope = PL_scopestack_ix;
419 JMPENV_PUSH(jmp_rc);
420 if (jmp_rc == 0) {
421 /* Run the specified function */
422 len = (int)call_sv(thread->init_function, thread->gimme|G_EVAL);
423 } else if (jmp_rc == 2) {
69a9b4b8
RGS
424 /* Thread exited */
425 exit_app = 1;
426 exit_code = STATUS_CURRENT;
4dcb9e53
JH
427 while (PL_scopestack_ix > oldscope) {
428 LEAVE;
429 }
430 }
431 JMPENV_POP;
fc04eb16
JH
432
433 /* Remove args from stack and put back in params array */
434 SPAGAIN;
435 for (ii=len-1; ii >= 0; ii--) {
436 SV *sv = POPs;
4dcb9e53
JH
437 if (jmp_rc == 0) {
438 av_store(params, ii, SvREFCNT_inc(sv));
439 }
fc04eb16
JH
440 }
441
4dcb9e53
JH
442 FREETMPS;
443 LEAVE;
444
fc04eb16
JH
445 /* Check for failure */
446 if (SvTRUE(ERRSV) && ckWARN_d(WARN_THREADS)) {
4dcb9e53
JH
447 oldscope = PL_scopestack_ix;
448 JMPENV_PUSH(jmp_rc);
449 if (jmp_rc == 0) {
69a9b4b8 450 /* Warn that thread died */
4dcb9e53
JH
451 Perl_warn(aTHX_ "Thread %" UVuf " terminated abnormally: %" SVf, thread->tid, ERRSV);
452 } else if (jmp_rc == 2) {
69a9b4b8
RGS
453 /* Warn handler exited */
454 exit_app = 1;
455 exit_code = STATUS_CURRENT;
4dcb9e53
JH
456 while (PL_scopestack_ix > oldscope) {
457 LEAVE;
458 }
459 }
460 JMPENV_POP;
fc04eb16
JH
461 }
462
fc04eb16
JH
463 /* Release function ref */
464 SvREFCNT_dec(thread->init_function);
465 thread->init_function = Nullsv;
466 }
62375a60 467
fc04eb16
JH
468 PerlIO_flush((PerlIO *)NULL);
469
5c6ff896 470 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
fc04eb16
JH
471 MUTEX_LOCK(&thread->mutex);
472 /* Mark as finished */
473 thread->state |= PERL_ITHR_FINISHED;
69a9b4b8 474 /* Clear exit flag if required */
fea7688c 475 if (thread->state & PERL_ITHR_THREAD_EXIT_ONLY) {
69a9b4b8 476 exit_app = 0;
fea7688c 477 }
fc04eb16 478
69a9b4b8 479 /* Adjust thread status counts */
adc09a0e 480 if (thread->state & PERL_ITHR_DETACHED) {
5c6ff896 481 MY_POOL.detached_threads--;
4dcb9e53 482 } else {
5c6ff896
JH
483 MY_POOL.running_threads--;
484 MY_POOL.joinable_threads++;
5168baf3 485 }
adc09a0e 486 MUTEX_UNLOCK(&thread->mutex);
5c6ff896 487 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
69a9b4b8
RGS
488
489 /* Exit application if required */
490 if (exit_app) {
491 oldscope = PL_scopestack_ix;
492 JMPENV_PUSH(jmp_rc);
493 if (jmp_rc == 0) {
494 /* Warn if there are unjoined threads */
495 S_exit_warning(aTHX);
496 } else if (jmp_rc == 2) {
497 /* Warn handler exited */
498 exit_code = STATUS_CURRENT;
499 while (PL_scopestack_ix > oldscope) {
500 LEAVE;
501 }
502 }
503 JMPENV_POP;
504
505 my_exit(exit_code);
506 }
507
adc09a0e
JH
508 /* Try to clean up thread */
509 S_ithread_destruct(aTHX_ thread);
91604d21 510
47ba8780 511#ifdef WIN32
fc04eb16 512 return ((DWORD)0);
e8f2bb9a 513#else
fc04eb16 514 return (0);
47ba8780 515#endif
68795e93
NIS
516}
517
fc04eb16
JH
518
519/* Type conversion helper functions */
fea7688c 520
861d5cbe
JH
521STATIC SV *
522S_ithread_to_SV(pTHX_ SV *obj, ithread *thread, char *classname, bool inc)
68795e93
NIS
523{
524 SV *sv;
525 MAGIC *mg;
fc04eb16 526
9ca4d7fd 527 /* If incrementing thread ref count, then call within mutex lock */
68795e93 528 if (inc) {
fc04eb16
JH
529 MUTEX_LOCK(&thread->mutex);
530 thread->count++;
531 MUTEX_UNLOCK(&thread->mutex);
532 }
533
534 if (! obj) {
535 obj = newSV(0);
68795e93 536 }
fc04eb16
JH
537
538 sv = newSVrv(obj, classname);
539 sv_setiv(sv, PTR2IV(thread));
540 mg = sv_magicext(sv, Nullsv, PERL_MAGIC_shared_scalar, &ithread_vtbl, (char *)thread, 0);
68795e93
NIS
541 mg->mg_flags |= MGf_DUP;
542 SvREADONLY_on(sv);
fc04eb16
JH
543
544 return (obj);
68795e93 545}
47ba8780 546
861d5cbe
JH
547STATIC ithread *
548S_SV_to_ithread(pTHX_ SV *sv)
68795e93 549{
fc04eb16
JH
550 /* Argument is a thread */
551 if (SvROK(sv)) {
552 return (INT2PTR(ithread *, SvIV(SvRV(sv))));
553 }
554 /* Argument is classname, therefore return current thread */
555 return (S_ithread_get(aTHX));
47ba8780
AB
556}
557
47ba8780 558
fc04eb16
JH
559/* threads->create()
560 * Called in context of parent thread.
5c6ff896 561 * Called with MY_POOL.create_destruct_mutex locked. (Unlocked on error.)
fc04eb16 562 */
861d5cbe 563STATIC ithread *
fc04eb16 564S_ithread_create(
9ca4d7fd 565 pTHX_ SV *init_function,
514612b7 566 IV stack_size,
9d9ff5b1 567 int gimme,
69a9b4b8 568 int exit_opt,
fc04eb16 569 SV *params)
68795e93 570{
fc04eb16
JH
571 ithread *thread;
572 CLONE_PARAMS clone_param;
573 ithread *current_thread = S_ithread_get(aTHX);
3b1c3273 574
fc04eb16
JH
575 SV **tmps_tmp = PL_tmps_stack;
576 IV tmps_ix = PL_tmps_ix;
d94006e8 577#ifndef WIN32
fc04eb16
JH
578 int rc_stack_size = 0;
579 int rc_thread_create = 0;
d94006e8 580#endif
adc09a0e 581 dMY_POOL;
3b1c3273 582
adc09a0e 583 /* Allocate thread structure in context of the main thread's interpreter */
5c6ff896
JH
584 {
585 PERL_SET_CONTEXT(MY_POOL.main_thread.interp);
586 thread = (ithread *)PerlMemShared_malloc(sizeof(ithread));
587 }
588 PERL_SET_CONTEXT(aTHX);
fc04eb16 589 if (!thread) {
5c6ff896 590 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
fc04eb16
JH
591 PerlLIO_write(PerlIO_fileno(Perl_error_log), PL_no_mem, strlen(PL_no_mem));
592 my_exit(1);
593 }
594 Zero(thread, 1, ithread);
595
596 /* Add to threads list */
5c6ff896
JH
597 thread->next = &MY_POOL.main_thread;
598 thread->prev = MY_POOL.main_thread.prev;
599 MY_POOL.main_thread.prev = thread;
fc04eb16 600 thread->prev->next = thread;
c05ae023 601
fc04eb16
JH
602 /* Set count to 1 immediately in case thread exits before
603 * we return to caller!
604 */
605 thread->count = 1;
606
9ca4d7fd 607 /* Block new thread until ->create() call finishes */
fc04eb16 608 MUTEX_INIT(&thread->mutex);
9ca4d7fd
JH
609 MUTEX_LOCK(&thread->mutex);
610
5c6ff896 611 thread->tid = MY_POOL.tid_counter++;
861d5cbe 612 thread->stack_size = S_good_stack_size(aTHX_ stack_size);
9d9ff5b1 613 thread->gimme = gimme;
69a9b4b8 614 thread->state = exit_opt;
fc04eb16
JH
615
616 /* "Clone" our interpreter into the thread's interpreter.
617 * This gives thread access to "static data" and code.
618 */
619 PerlIO_flush((PerlIO *)NULL);
620 S_ithread_set(aTHX_ thread);
621
622 SAVEBOOL(PL_srand_called); /* Save this so it becomes the correct value */
623 PL_srand_called = FALSE; /* Set it to false so we can detect if it gets
624 set during the clone */
3b1c3273 625
47ba8780 626#ifdef WIN32
fc04eb16 627 thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE | CLONEf_CLONE_HOST);
47ba8780 628#else
fc04eb16 629 thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE);
47ba8780 630#endif
47ba8780 631
fc04eb16
JH
632 /* perl_clone() leaves us in new interpreter's context. As it is tricky
633 * to spot an implicit aTHX, create a new scope with aTHX matching the
634 * context for the duration of our work for new interpreter.
635 */
636 {
637 dTHXa(thread->interp);
638
639 MY_CXT_CLONE;
640
641 /* Here we remove END blocks since they should only run in the thread
642 * they are created
643 */
644 SvREFCNT_dec(PL_endav);
645 PL_endav = newAV();
404aaa48 646
734a3f9b 647 clone_param.flags = 0;
f2e0bb91
JH
648 if (SvPOK(init_function)) {
649 thread->init_function = newSV(0);
650 sv_copypv(thread->init_function, init_function);
651 } else {
f2e0bb91
JH
652 thread->init_function = sv_dup(init_function, &clone_param);
653 if (SvREFCNT(thread->init_function) == 0) {
d4315dd6 654 SvREFCNT_inc_void(thread->init_function);
f2e0bb91 655 }
fc04eb16
JH
656 }
657
658 thread->params = sv_dup(params, &clone_param);
d4315dd6 659 SvREFCNT_inc_void(thread->params);
fc04eb16
JH
660
661 /* The code below checks that anything living on the tmps stack and
662 * has been cloned (so it lives in the ptr_table) has a refcount
663 * higher than 0.
664 *
665 * If the refcount is 0 it means that a something on the stack/context
666 * was holding a reference to it and since we init_stacks() in
667 * perl_clone that won't get cleaned and we will get a leaked scalar.
668 * The reason it was cloned was that it lived on the @_ stack.
669 *
670 * Example of this can be found in bugreport 15837 where calls in the
671 * parameter list end up as a temp.
672 *
673 * One could argue that this fix should be in perl_clone.
674 */
675 while (tmps_ix > 0) {
676 SV* sv = (SV*)ptr_table_fetch(PL_ptr_table, tmps_tmp[tmps_ix]);
677 tmps_ix--;
678 if (sv && SvREFCNT(sv) == 0) {
d4315dd6 679 SvREFCNT_inc_void(sv);
fc04eb16
JH
680 SvREFCNT_dec(sv);
681 }
682 }
683
684 SvTEMP_off(thread->init_function);
685 ptr_table_free(PL_ptr_table);
686 PL_ptr_table = NULL;
687 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
688 }
689 S_ithread_set(aTHX_ current_thread);
690 PERL_SET_CONTEXT(aTHX);
691
692 /* Create/start the thread */
47ba8780 693#ifdef WIN32
fc04eb16 694 thread->handle = CreateThread(NULL,
514612b7 695 (DWORD)thread->stack_size,
fc04eb16
JH
696 S_ithread_run,
697 (LPVOID)thread,
514612b7 698 STACK_SIZE_PARAM_IS_A_RESERVATION,
fc04eb16 699 &thread->thr);
82c40bf6 700#else
fc04eb16 701 {
861d5cbe
JH
702 STATIC pthread_attr_t attr;
703 STATIC int attr_inited = 0;
704 STATIC int attr_joinable = PTHREAD_CREATE_JOINABLE;
fc04eb16
JH
705 if (! attr_inited) {
706 pthread_attr_init(&attr);
707 attr_inited = 1;
708 }
709
fa26028c 710# ifdef PTHREAD_ATTR_SETDETACHSTATE
fc04eb16
JH
711 /* Threads start out joinable */
712 PTHREAD_ATTR_SETDETACHSTATE(&attr, attr_joinable);
fa26028c 713# endif
fc04eb16 714
514612b7 715# ifdef _POSIX_THREAD_ATTR_STACKSIZE
fc04eb16 716 /* Set thread's stack size */
514612b7
JH
717 if (thread->stack_size > 0) {
718 rc_stack_size = pthread_attr_setstacksize(&attr, (size_t)thread->stack_size);
719 }
3eb37d38
AB
720# endif
721
fc04eb16
JH
722 /* Create the thread */
723 if (! rc_stack_size) {
724# ifdef OLD_PTHREADS_API
725 rc_thread_create = pthread_create(&thread->thr,
726 attr,
727 S_ithread_run,
728 (void *)thread);
729# else
730# if defined(HAS_PTHREAD_ATTR_SETSCOPE) && defined(PTHREAD_SCOPE_SYSTEM)
731 pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM);
732# endif
733 rc_thread_create = pthread_create(&thread->thr,
734 &attr,
735 S_ithread_run,
736 (void *)thread);
19a077f6 737# endif
fc04eb16 738 }
514612b7
JH
739
740# ifdef _POSIX_THREAD_ATTR_STACKSIZE
741 /* Try to get thread's actual stack size */
742 {
743 size_t stacksize;
58a3a76c
JH
744#ifdef HPUX1020
745 stacksize = pthread_attr_getstacksize(attr);
746#else
747 if (! pthread_attr_getstacksize(&attr, &stacksize))
748#endif
749 if (stacksize > 0) {
514612b7
JH
750 thread->stack_size = (IV)stacksize;
751 }
514612b7
JH
752 }
753# endif
fc04eb16 754 }
82c40bf6 755#endif
bcd9ca9b 756
fc04eb16 757 /* Check for errors */
d94006e8 758#ifdef WIN32
fc04eb16 759 if (thread->handle == NULL) {
d94006e8 760#else
fc04eb16 761 if (rc_stack_size || rc_thread_create) {
d94006e8 762#endif
9ca4d7fd 763 /* Must unlock mutex for destruct call */
5c6ff896 764 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
fc04eb16 765 sv_2mortal(params);
adc09a0e 766 thread->state |= PERL_ITHR_NONVIABLE;
fc04eb16 767 S_ithread_destruct(aTHX_ thread);
d94006e8 768#ifndef WIN32
514612b7 769 if (ckWARN_d(WARN_THREADS)) {
fea7688c 770 if (rc_stack_size) {
514612b7 771 Perl_warn(aTHX_ "Thread creation failed: pthread_attr_setstacksize(%" IVdf ") returned %d", thread->stack_size, rc_stack_size);
fea7688c 772 } else {
514612b7 773 Perl_warn(aTHX_ "Thread creation failed: pthread_create returned %d", rc_thread_create);
fea7688c 774 }
514612b7 775 }
d94006e8 776#endif
9ca4d7fd 777 return (NULL);
fc04eb16
JH
778 }
779
5c6ff896 780 MY_POOL.running_threads++;
fc04eb16 781 sv_2mortal(params);
9ca4d7fd 782 return (thread);
68795e93 783}
47ba8780 784
73e09c8f 785#endif /* USE_ITHREADS */
e1c44605 786
fcea4b7c 787
fc04eb16 788MODULE = threads PACKAGE = threads PREFIX = ithread_
68795e93 789PROTOTYPES: DISABLE
8222d950 790
73e09c8f
JH
791#ifdef USE_ITHREADS
792
68795e93 793void
f4cc38af
JH
794ithread_create(...)
795 PREINIT:
796 char *classname;
514612b7 797 ithread *thread;
f4cc38af
JH
798 SV *function_to_call;
799 AV *params;
514612b7
JH
800 HV *specs;
801 IV stack_size;
9d9ff5b1 802 int context;
69a9b4b8
RGS
803 int exit_opt;
804 SV *thread_exit_only;
9d9ff5b1 805 char *str;
514612b7 806 int idx;
f4cc38af 807 int ii;
5c6ff896 808 dMY_POOL;
f4cc38af 809 CODE:
514612b7 810 if ((items >= 2) && SvROK(ST(1)) && SvTYPE(SvRV(ST(1)))==SVt_PVHV) {
fea7688c 811 if (--items < 2) {
514612b7 812 Perl_croak(aTHX_ "Usage: threads->create(\\%specs, function, ...)");
fea7688c 813 }
514612b7
JH
814 specs = (HV*)SvRV(ST(1));
815 idx = 1;
816 } else {
fea7688c 817 if (items < 2) {
514612b7 818 Perl_croak(aTHX_ "Usage: threads->create(function, ...)");
fea7688c 819 }
514612b7
JH
820 specs = NULL;
821 idx = 0;
822 }
f4cc38af 823
514612b7
JH
824 if (sv_isobject(ST(0))) {
825 /* $thr->create() */
826 classname = HvNAME(SvSTASH(SvRV(ST(0))));
827 thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
828 stack_size = thread->stack_size;
69a9b4b8 829 exit_opt = thread->state & PERL_ITHR_THREAD_EXIT_ONLY;
514612b7
JH
830 } else {
831 /* threads->create() */
832 classname = (char *)SvPV_nolen(ST(0));
5c6ff896 833 stack_size = MY_POOL.default_stack_size;
69a9b4b8
RGS
834 thread_exit_only = get_sv("threads::thread_exit_only", TRUE);
835 exit_opt = (SvTRUE(thread_exit_only))
836 ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
514612b7
JH
837 }
838
839 function_to_call = ST(idx+1);
840
9d9ff5b1 841 context = -1;
514612b7
JH
842 if (specs) {
843 /* stack_size */
844 if (hv_exists(specs, "stack", 5)) {
845 stack_size = SvIV(*hv_fetch(specs, "stack", 5, 0));
846 } else if (hv_exists(specs, "stacksize", 9)) {
847 stack_size = SvIV(*hv_fetch(specs, "stacksize", 9, 0));
848 } else if (hv_exists(specs, "stack_size", 10)) {
849 stack_size = SvIV(*hv_fetch(specs, "stack_size", 10, 0));
850 }
9d9ff5b1
JH
851
852 /* context */
853 if (hv_exists(specs, "context", 7)) {
854 str = (char *)SvPV_nolen(*hv_fetch(specs, "context", 7, 0));
855 switch (*str) {
856 case 'a':
857 case 'A':
858 context = G_ARRAY;
859 break;
860 case 's':
861 case 'S':
862 context = G_SCALAR;
863 break;
864 case 'v':
865 case 'V':
866 context = G_VOID;
867 break;
868 default:
869 Perl_croak(aTHX_ "Invalid context: %s", str);
870 }
871 } else if (hv_exists(specs, "array", 5)) {
872 if (SvTRUE(*hv_fetch(specs, "array", 5, 0))) {
873 context = G_ARRAY;
874 }
875 } else if (hv_exists(specs, "scalar", 6)) {
876 if (SvTRUE(*hv_fetch(specs, "scalar", 6, 0))) {
877 context = G_SCALAR;
878 }
879 } else if (hv_exists(specs, "void", 4)) {
880 if (SvTRUE(*hv_fetch(specs, "void", 4, 0))) {
881 context = G_VOID;
882 }
883 }
69a9b4b8
RGS
884
885 /* exit => thread_only */
886 if (hv_exists(specs, "exit", 4)) {
887 str = (char *)SvPV_nolen(*hv_fetch(specs, "exit", 4, 0));
888 exit_opt = (*str == 't' || *str == 'T')
889 ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
890 }
9d9ff5b1
JH
891 }
892 if (context == -1) {
893 context = GIMME_V; /* Implicit context */
894 } else {
895 context |= (GIMME_V & (~(G_ARRAY|G_SCALAR|G_VOID)));
514612b7 896 }
f4cc38af
JH
897
898 /* Function args */
899 params = newAV();
900 if (items > 2) {
514612b7
JH
901 for (ii=2; ii < items ; ii++) {
902 av_push(params, SvREFCNT_inc(ST(idx+ii)));
f4cc38af
JH
903 }
904 }
905
906 /* Create thread */
5c6ff896 907 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
9ca4d7fd
JH
908 thread = S_ithread_create(aTHX_ function_to_call,
909 stack_size,
910 context,
911 exit_opt,
912 newRV_noinc((SV*)params));
913 if (! thread) {
914 XSRETURN_UNDEF; /* Mutex already unlocked */
915 }
861d5cbe 916 ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, FALSE));
adc09a0e 917 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
9ca4d7fd
JH
918
919 /* Let thread run */
920 MUTEX_UNLOCK(&thread->mutex);
9ca4d7fd 921
f4cc38af
JH
922 /* XSRETURN(1); - implied */
923
8222d950 924
68795e93 925void
f4cc38af
JH
926ithread_list(...)
927 PREINIT:
928 char *classname;
fc04eb16 929 ithread *thread;
f4cc38af
JH
930 int list_context;
931 IV count = 0;
11db694d 932 int want_running = 0;
5c6ff896 933 dMY_POOL;
f4cc38af
JH
934 PPCODE:
935 /* Class method only */
fea7688c 936 if (SvROK(ST(0))) {
ead32952 937 Perl_croak(aTHX_ "Usage: threads->list(...)");
fea7688c 938 }
f4cc38af
JH
939 classname = (char *)SvPV_nolen(ST(0));
940
941 /* Calling context */
942 list_context = (GIMME_V == G_ARRAY);
943
ead32952
JH
944 /* Running or joinable parameter */
945 if (items > 1) {
946 want_running = SvTRUE(ST(1));
947 }
948
f4cc38af 949 /* Walk through threads list */
5c6ff896
JH
950 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
951 for (thread = MY_POOL.main_thread.next;
952 thread != &MY_POOL.main_thread;
fc04eb16 953 thread = thread->next)
f4cc38af
JH
954 {
955 /* Ignore detached or joined threads */
fc04eb16 956 if (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)) {
f4cc38af
JH
957 continue;
958 }
ead32952
JH
959
960 /* Filter per parameter */
961 if (items > 1) {
962 if (want_running) {
963 if (thread->state & PERL_ITHR_FINISHED) {
964 continue; /* Not running */
965 }
966 } else {
967 if (! (thread->state & PERL_ITHR_FINISHED)) {
968 continue; /* Still running - not joinable yet */
969 }
970 }
971 }
972
f4cc38af
JH
973 /* Push object on stack if list context */
974 if (list_context) {
861d5cbe 975 XPUSHs(sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE)));
f4cc38af
JH
976 }
977 count++;
978 }
5c6ff896 979 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
f4cc38af
JH
980 /* If scalar context, send back count */
981 if (! list_context) {
982 XSRETURN_IV(count);
983 }
678a9b6c
AB
984
985
986void
f4cc38af
JH
987ithread_self(...)
988 PREINIT:
989 char *classname;
fcea4b7c 990 ithread *thread;
f4cc38af
JH
991 CODE:
992 /* Class method only */
11db694d 993 if ((items != 1) || SvROK(ST(0))) {
f4cc38af 994 Perl_croak(aTHX_ "Usage: threads->self()");
fea7688c 995 }
f4cc38af
JH
996 classname = (char *)SvPV_nolen(ST(0));
997
fcea4b7c
JH
998 thread = S_ithread_get(aTHX);
999
861d5cbe 1000 ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
f4cc38af 1001 /* XSRETURN(1); - implied */
47ba8780 1002
47ba8780
AB
1003
1004void
f4cc38af
JH
1005ithread_tid(...)
1006 PREINIT:
1007 ithread *thread;
1008 CODE:
11db694d 1009 PERL_UNUSED_VAR(items);
861d5cbe 1010 thread = S_SV_to_ithread(aTHX_ ST(0));
f4cc38af
JH
1011 XST_mUV(0, thread->tid);
1012 /* XSRETURN(1); - implied */
1013
e1c44605 1014
f9dff5f5 1015void
f4cc38af
JH
1016ithread_join(...)
1017 PREINIT:
fcea4b7c
JH
1018 ithread *thread;
1019 int join_err;
f4cc38af
JH
1020 AV *params;
1021 int len;
1022 int ii;
fcea4b7c
JH
1023#ifdef WIN32
1024 DWORD waitcode;
1025#else
1026 void *retval;
1027#endif
5c6ff896 1028 dMY_POOL;
f4cc38af
JH
1029 PPCODE:
1030 /* Object method only */
11db694d 1031 if ((items != 1) || ! sv_isobject(ST(0))) {
f4cc38af 1032 Perl_croak(aTHX_ "Usage: $thr->join()");
fea7688c 1033 }
f4cc38af 1034
fcea4b7c 1035 /* Check if the thread is joinable */
861d5cbe 1036 thread = S_SV_to_ithread(aTHX_ ST(0));
fcea4b7c 1037 join_err = (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED));
fcea4b7c
JH
1038 if (join_err) {
1039 if (join_err & PERL_ITHR_DETACHED) {
1040 Perl_croak(aTHX_ "Cannot join a detached thread");
1041 } else {
1042 Perl_croak(aTHX_ "Thread already joined");
1043 }
1044 }
1045
1046 /* Join the thread */
1047#ifdef WIN32
1048 waitcode = WaitForSingleObject(thread->handle, INFINITE);
1049#else
1050 pthread_join(thread->thr, &retval);
1051#endif
1052
1053 MUTEX_LOCK(&thread->mutex);
1054 /* Mark as joined */
1055 thread->state |= PERL_ITHR_JOINED;
1056
1057 /* Get the return value from the call_sv */
1058 {
1059 AV *params_copy;
1060 PerlInterpreter *other_perl;
1061 CLONE_PARAMS clone_params;
1062 ithread *current_thread;
1063
1064 params_copy = (AV *)SvRV(thread->params);
1065 other_perl = thread->interp;
1066 clone_params.stashes = newAV();
1067 clone_params.flags = CLONEf_JOIN_IN;
1068 PL_ptr_table = ptr_table_new();
1069 current_thread = S_ithread_get(aTHX);
1070 S_ithread_set(aTHX_ thread);
1071 /* Ensure 'meaningful' addresses retain their meaning */
1072 ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1073 ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1074 ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1075 params = (AV *)sv_dup((SV*)params_copy, &clone_params);
1076 S_ithread_set(aTHX_ current_thread);
1077 SvREFCNT_dec(clone_params.stashes);
d4315dd6 1078 SvREFCNT_inc_void(params);
fcea4b7c
JH
1079 ptr_table_free(PL_ptr_table);
1080 PL_ptr_table = NULL;
1081 }
1082
1083 /* We are finished with the thread */
1084 S_ithread_clear(aTHX_ thread);
1085 MUTEX_UNLOCK(&thread->mutex);
1086
5c6ff896 1087 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
9ca4d7fd 1088 if (! (thread->state & PERL_ITHR_DETACHED)) {
5c6ff896 1089 MY_POOL.joinable_threads--;
9ca4d7fd 1090 }
5c6ff896 1091 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
4dcb9e53 1092
fcea4b7c 1093 /* If no return values, then just return */
f4cc38af
JH
1094 if (! params) {
1095 XSRETURN_UNDEF;
1096 }
1097
1098 /* Put return values on stack */
1099 len = (int)AvFILL(params);
1100 for (ii=0; ii <= len; ii++) {
1101 SV* param = av_shift(params);
1102 XPUSHs(sv_2mortal(param));
1103 }
1104
1105 /* Free return value array */
1106 SvREFCNT_dec(params);
1107
1108
1109void
1110ithread_yield(...)
1111 CODE:
11db694d 1112 PERL_UNUSED_VAR(items);
f4cc38af
JH
1113 YIELD;
1114
1115
1116void
1117ithread_detach(...)
1118 PREINIT:
1119 ithread *thread;
fcea4b7c 1120 int detach_err;
5c6ff896 1121 dMY_POOL;
f4cc38af 1122 CODE:
11db694d
JH
1123 PERL_UNUSED_VAR(items);
1124
fcea4b7c 1125 /* Check if the thread is detachable */
861d5cbe 1126 thread = S_SV_to_ithread(aTHX_ ST(0));
fcea4b7c 1127 if ((detach_err = (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)))) {
fcea4b7c
JH
1128 if (detach_err & PERL_ITHR_DETACHED) {
1129 Perl_croak(aTHX_ "Thread already detached");
1130 } else {
1131 Perl_croak(aTHX_ "Cannot detach a joined thread");
1132 }
1133 }
1134
1135 /* Detach the thread */
5c6ff896 1136 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
9ca4d7fd 1137 MUTEX_LOCK(&thread->mutex);
fcea4b7c
JH
1138 thread->state |= PERL_ITHR_DETACHED;
1139#ifdef WIN32
1140 /* Windows has no 'detach thread' function */
1141#else
1142 PERL_THREAD_DETACH(thread->thr);
1143#endif
fcea4b7c 1144
adc09a0e 1145 if (thread->state & PERL_ITHR_FINISHED) {
5c6ff896 1146 MY_POOL.joinable_threads--;
4dcb9e53 1147 } else {
5c6ff896
JH
1148 MY_POOL.running_threads--;
1149 MY_POOL.detached_threads++;
4dcb9e53 1150 }
adc09a0e 1151 MUTEX_UNLOCK(&thread->mutex);
5c6ff896 1152 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
4dcb9e53 1153
adc09a0e
JH
1154 /* Try to cleanup thread */
1155 S_ithread_destruct(aTHX_ thread);
f4cc38af 1156
47ba8780
AB
1157
1158void
c0003851
JH
1159ithread_kill(...)
1160 PREINIT:
1161 ithread *thread;
1162 char *sig_name;
1163 IV signal;
1164 CODE:
1165 /* Must have safe signals */
fea7688c 1166 if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) {
4dcb9e53 1167 Perl_croak(aTHX_ "Cannot signal threads without safe signals");
fea7688c 1168 }
c0003851
JH
1169
1170 /* Object method only */
11db694d 1171 if ((items != 2) || ! sv_isobject(ST(0))) {
c0003851 1172 Perl_croak(aTHX_ "Usage: $thr->kill('SIG...')");
fea7688c 1173 }
c0003851 1174
c0003851
JH
1175 /* Get signal */
1176 sig_name = SvPV_nolen(ST(1));
1177 if (isALPHA(*sig_name)) {
fea7688c 1178 if (*sig_name == 'S' && sig_name[1] == 'I' && sig_name[2] == 'G') {
c0003851 1179 sig_name += 3;
fea7688c
JH
1180 }
1181 if ((signal = whichsig(sig_name)) < 0) {
c0003851 1182 Perl_croak(aTHX_ "Unrecognized signal name: %s", sig_name);
fea7688c
JH
1183 }
1184 } else {
c0003851 1185 signal = SvIV(ST(1));
fea7688c 1186 }
c0003851
JH
1187
1188 /* Set the signal for the thread */
861d5cbe 1189 thread = S_SV_to_ithread(aTHX_ ST(0));
4dcb9e53 1190 MUTEX_LOCK(&thread->mutex);
3ceb02cd 1191 if (thread->interp) {
c0003851
JH
1192 dTHXa(thread->interp);
1193 PL_psig_pend[signal]++;
1194 PL_sig_pending = 1;
1195 }
4dcb9e53 1196 MUTEX_UNLOCK(&thread->mutex);
c0003851
JH
1197
1198 /* Return the thread to allow for method chaining */
1199 ST(0) = ST(0);
1200 /* XSRETURN(1); - implied */
1201
1202
1203void
f4cc38af
JH
1204ithread_DESTROY(...)
1205 CODE:
11db694d 1206 PERL_UNUSED_VAR(items);
fcea4b7c 1207 sv_unmagic(SvRV(ST(0)), PERL_MAGIC_shared_scalar);
f4cc38af
JH
1208
1209
1210void
1211ithread_equal(...)
fc04eb16
JH
1212 PREINIT:
1213 int are_equal = 0;
f4cc38af 1214 CODE:
11db694d
JH
1215 PERL_UNUSED_VAR(items);
1216
fc04eb16 1217 /* Compares TIDs to determine thread equality */
f4cc38af
JH
1218 if (sv_isobject(ST(0)) && sv_isobject(ST(1))) {
1219 ithread *thr1 = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1220 ithread *thr2 = INT2PTR(ithread *, SvIV(SvRV(ST(1))));
fc04eb16
JH
1221 are_equal = (thr1->tid == thr2->tid);
1222 }
1223 if (are_equal) {
1224 XST_mYES(0);
f4cc38af 1225 } else {
fc04eb16 1226 /* Return 0 on false for backward compatibility */
f4cc38af
JH
1227 XST_mIV(0, 0);
1228 }
1229 /* XSRETURN(1); - implied */
1230
47ba8780 1231
47ba8780 1232void
f4cc38af
JH
1233ithread_object(...)
1234 PREINIT:
1235 char *classname;
1236 UV tid;
fc04eb16 1237 ithread *thread;
9ca4d7fd 1238 int have_obj = 0;
5c6ff896 1239 dMY_POOL;
f4cc38af
JH
1240 CODE:
1241 /* Class method only */
fea7688c 1242 if (SvROK(ST(0))) {
f4cc38af 1243 Perl_croak(aTHX_ "Usage: threads->object($tid)");
fea7688c 1244 }
f4cc38af
JH
1245 classname = (char *)SvPV_nolen(ST(0));
1246
1247 if ((items < 2) || ! SvOK(ST(1))) {
1248 XSRETURN_UNDEF;
1249 }
1250
fc04eb16 1251 /* threads->object($tid) */
f4cc38af
JH
1252 tid = SvUV(ST(1));
1253
1254 /* Walk through threads list */
5c6ff896
JH
1255 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1256 for (thread = MY_POOL.main_thread.next;
1257 thread != &MY_POOL.main_thread;
fc04eb16 1258 thread = thread->next)
f4cc38af 1259 {
9ca4d7fd
JH
1260 /* Look for TID */
1261 if (thread->tid == tid) {
1262 /* Ignore if detached or joined */
1263 if (! (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED))) {
1264 /* Put object on stack */
861d5cbe 1265 ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
9ca4d7fd
JH
1266 have_obj = 1;
1267 }
1268 break;
f4cc38af 1269 }
f4cc38af 1270 }
5c6ff896 1271 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
9ca4d7fd
JH
1272
1273 if (! have_obj) {
f4cc38af
JH
1274 XSRETURN_UNDEF;
1275 }
1276 /* XSRETURN(1); - implied */
1277
1278
1279void
1280ithread__handle(...);
1281 PREINIT:
1282 ithread *thread;
1283 CODE:
11db694d 1284 PERL_UNUSED_VAR(items);
861d5cbe 1285 thread = S_SV_to_ithread(aTHX_ ST(0));
f4cc38af 1286#ifdef WIN32
fcea4b7c 1287 XST_mUV(0, PTR2UV(&thread->handle));
f4cc38af 1288#else
75ba4ae2 1289 XST_mUV(0, PTR2UV(&thread->thr));
f4cc38af
JH
1290#endif
1291 /* XSRETURN(1); - implied */
68795e93 1292
514612b7
JH
1293
1294void
1295ithread_get_stack_size(...)
1296 PREINIT:
1297 IV stack_size;
5c6ff896 1298 dMY_POOL;
514612b7 1299 CODE:
11db694d 1300 PERL_UNUSED_VAR(items);
514612b7
JH
1301 if (sv_isobject(ST(0))) {
1302 /* $thr->get_stack_size() */
1303 ithread *thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1304 stack_size = thread->stack_size;
1305 } else {
1306 /* threads->get_stack_size() */
5c6ff896 1307 stack_size = MY_POOL.default_stack_size;
514612b7
JH
1308 }
1309 XST_mIV(0, stack_size);
1310 /* XSRETURN(1); - implied */
1311
1312
1313void
1314ithread_set_stack_size(...)
1315 PREINIT:
1316 IV old_size;
5c6ff896 1317 dMY_POOL;
514612b7 1318 CODE:
fea7688c 1319 if (items != 2) {
514612b7 1320 Perl_croak(aTHX_ "Usage: threads->set_stack_size($size)");
fea7688c
JH
1321 }
1322 if (sv_isobject(ST(0))) {
514612b7 1323 Perl_croak(aTHX_ "Cannot change stack size of an existing thread");
fea7688c 1324 }
514612b7 1325
5c6ff896
JH
1326 old_size = MY_POOL.default_stack_size;
1327 MY_POOL.default_stack_size = S_good_stack_size(aTHX_ SvIV(ST(1)));
514612b7
JH
1328 XST_mIV(0, old_size);
1329 /* XSRETURN(1); - implied */
1330
ead32952
JH
1331
1332void
1333ithread_is_running(...)
1334 PREINIT:
1335 ithread *thread;
1336 CODE:
1337 /* Object method only */
11db694d 1338 if ((items != 1) || ! sv_isobject(ST(0))) {
ead32952 1339 Perl_croak(aTHX_ "Usage: $thr->is_running()");
fea7688c 1340 }
ead32952
JH
1341
1342 thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
ead32952 1343 ST(0) = (thread->state & PERL_ITHR_FINISHED) ? &PL_sv_no : &PL_sv_yes;
ead32952
JH
1344 /* XSRETURN(1); - implied */
1345
1346
1347void
1348ithread_is_detached(...)
1349 PREINIT:
1350 ithread *thread;
1351 CODE:
11db694d 1352 PERL_UNUSED_VAR(items);
861d5cbe 1353 thread = S_SV_to_ithread(aTHX_ ST(0));
ead32952 1354 ST(0) = (thread->state & PERL_ITHR_DETACHED) ? &PL_sv_yes : &PL_sv_no;
ead32952
JH
1355 /* XSRETURN(1); - implied */
1356
1357
1358void
1359ithread_is_joinable(...)
1360 PREINIT:
1361 ithread *thread;
1362 CODE:
1363 /* Object method only */
11db694d 1364 if ((items != 1) || ! sv_isobject(ST(0))) {
ead32952 1365 Perl_croak(aTHX_ "Usage: $thr->is_joinable()");
fea7688c 1366 }
ead32952
JH
1367
1368 thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1369 MUTEX_LOCK(&thread->mutex);
1370 ST(0) = ((thread->state & PERL_ITHR_FINISHED) &&
1371 ! (thread->state & (PERL_ITHR_DETACHED|PERL_ITHR_JOINED)))
1372 ? &PL_sv_yes : &PL_sv_no;
1373 MUTEX_UNLOCK(&thread->mutex);
1374 /* XSRETURN(1); - implied */
1375
1376
1377void
1378ithread_wantarray(...)
1379 PREINIT:
1380 ithread *thread;
1381 CODE:
11db694d 1382 PERL_UNUSED_VAR(items);
861d5cbe 1383 thread = S_SV_to_ithread(aTHX_ ST(0));
ead32952
JH
1384 ST(0) = (thread->gimme & G_ARRAY) ? &PL_sv_yes :
1385 (thread->gimme & G_VOID) ? &PL_sv_undef
1386 /* G_SCALAR */ : &PL_sv_no;
ead32952
JH
1387 /* XSRETURN(1); - implied */
1388
69a9b4b8
RGS
1389
1390void
1391ithread_set_thread_exit_only(...)
1392 PREINIT:
1393 ithread *thread;
1394 CODE:
fea7688c 1395 if (items != 2) {
69a9b4b8 1396 Perl_croak(aTHX_ "Usage: ->set_thread_exit_only(boolean)");
fea7688c 1397 }
861d5cbe 1398 thread = S_SV_to_ithread(aTHX_ ST(0));
69a9b4b8
RGS
1399 MUTEX_LOCK(&thread->mutex);
1400 if (SvTRUE(ST(1))) {
1401 thread->state |= PERL_ITHR_THREAD_EXIT_ONLY;
1402 } else {
1403 thread->state &= ~PERL_ITHR_THREAD_EXIT_ONLY;
1404 }
1405 MUTEX_UNLOCK(&thread->mutex);
1406
73e09c8f
JH
1407#endif /* USE_ITHREADS */
1408
fc04eb16 1409
68795e93
NIS
1410BOOT:
1411{
73e09c8f 1412#ifdef USE_ITHREADS
5c6ff896
JH
1413 SV *my_pool_sv = *hv_fetch(PL_modglobal, MY_POOL_KEY,
1414 sizeof(MY_POOL_KEY)-1, TRUE);
1415 my_pool_t *my_poolp = (my_pool_t*)SvPVX(newSV(sizeof(my_pool_t)-1));
1416
fc04eb16
JH
1417 MY_CXT_INIT;
1418
5c6ff896
JH
1419 Zero(my_poolp, 1, my_pool_t);
1420 sv_setuv(my_pool_sv, PTR2UV(my_poolp));
1421
fc04eb16 1422 PL_perl_destruct_level = 2;
5c6ff896
JH
1423 MUTEX_INIT(&MY_POOL.create_destruct_mutex);
1424 MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
fc04eb16
JH
1425
1426 PL_threadhook = &Perl_ithread_hook;
1427
5c6ff896
JH
1428 MY_POOL.tid_counter = 1;
1429# ifdef THREAD_CREATE_NEEDS_STACK
1430 MY_POOL.default_stack_size = THREAD_CREATE_NEEDS_STACK;
1431# endif
1432
c372d929
JH
1433 /* The 'main' thread is thread 0.
1434 * It is detached (unjoinable) and immortal.
1435 */
fc04eb16 1436
5c6ff896 1437 MUTEX_INIT(&MY_POOL.main_thread.mutex);
fc04eb16
JH
1438
1439 /* Head of the threads list */
5c6ff896
JH
1440 MY_POOL.main_thread.next = &MY_POOL.main_thread;
1441 MY_POOL.main_thread.prev = &MY_POOL.main_thread;
fc04eb16 1442
5c6ff896 1443 MY_POOL.main_thread.count = 1; /* Immortal */
fc04eb16 1444
5c6ff896
JH
1445 MY_POOL.main_thread.interp = aTHX;
1446 MY_POOL.main_thread.state = PERL_ITHR_DETACHED; /* Detached */
1447 MY_POOL.main_thread.stack_size = MY_POOL.default_stack_size;
fc04eb16 1448# ifdef WIN32
5c6ff896 1449 MY_POOL.main_thread.thr = GetCurrentThreadId();
fc04eb16 1450# else
5c6ff896 1451 MY_POOL.main_thread.thr = pthread_self();
fc04eb16
JH
1452# endif
1453
5c6ff896
JH
1454 S_ithread_set(aTHX_ &MY_POOL.main_thread);
1455 MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
73e09c8f 1456#endif /* USE_ITHREADS */
68795e93 1457}