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