dist/threads/threads.xs

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