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     SV *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 = Nullsv;
 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 = (AV *)SvRV(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)
 679 {
 680     ithread     *thread;
 681     ithread     *current_thread = S_ithread_get(aTHX);
 682
 683 #if PERL_VERSION <= 8 && PERL_SUBVERSION <= 7
 684     SV         **tmps_tmp = PL_tmps_stack;
 685     IV           tmps_ix  = PL_tmps_ix;
 686 #endif
 687 #ifndef WIN32
 688     int          rc_stack_size = 0;
 689     int          rc_thread_create = 0;
 690 #endif
 691     dMY_POOL;
 692
 693     /* Allocate thread structure in context of the main thread's interpreter */
 694     {
 695         PERL_SET_CONTEXT(MY_POOL.main_thread.interp);
 696         thread = (ithread *)PerlMemShared_malloc(sizeof(ithread));
 697     }
 698     PERL_SET_CONTEXT(aTHX);
 699     if (!thread) {
 700         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
 701         PerlLIO_write(PerlIO_fileno(Perl_error_log), PL_no_mem, strlen(PL_no_mem));
 702         my_exit(1);
 703     }
 704     Zero(thread, 1, ithread);
 705
 706     /* Add to threads list */
 707     thread->next = &MY_POOL.main_thread;
 708     thread->prev = MY_POOL.main_thread.prev;
 709     MY_POOL.main_thread.prev = thread;
 710     thread->prev->next = thread;
 711     MY_POOL.total_threads++;
 712
 713     /* 1 ref to be held by the local var 'thread' in S_ithread_run().
 714      * 1 ref to be held by the threads object that we assume we will
 715      *      be embedded in upon our return.
 716      * 1 ref to be the responsibility of join/detach, so we don't get
 717      *      freed until join/detach, even if no thread objects remain.
 718      *      This allows the following to work:
 719      *          { threads->create(sub{...}); } threads->object(1)->join;
 720      */
 721     thread->count = 3;
 722
 723     /* Block new thread until ->create() call finishes */
 724     MUTEX_INIT(&thread->mutex);
 725     MUTEX_LOCK(&thread->mutex);
 726
 727     thread->tid = MY_POOL.tid_counter++;
 728     thread->stack_size = S_good_stack_size(aTHX_ stack_size);
 729     thread->gimme = gimme;
 730     thread->state = exit_opt;
 731
 732     /* "Clone" our interpreter into the thread's interpreter.
 733      * This gives thread access to "static data" and code.
 734      */
 735     PerlIO_flush((PerlIO *)NULL);
 736     S_ithread_set(aTHX_ thread);
 737
 738     SAVEBOOL(PL_srand_called); /* Save this so it becomes the correct value */
 739     PL_srand_called = FALSE;   /* Set it to false so we can detect if it gets
 740                                   set during the clone */
 741
 742 #ifndef WIN32
 743     /* perl_clone() will leave us the new interpreter's context.  This poses
 744      * two problems for our signal handler.  First, it sets the new context
 745      * before the new interpreter struct is fully initialized, so our signal
 746      * handler might find bogus data in the interpreter struct it gets.
 747      * Second, even if the interpreter is initialized before a signal comes in,
 748      * we would like to avoid that interpreter receiving notifications for
 749      * signals (especially when they ought to be for the one running in this
 750      * thread), until it is running in its own thread.  Another problem is that
 751      * the new thread will not have set the context until some time after it
 752      * has started, so it won't be safe for our signal handler to run until
 753      * that time.
 754      *
 755      * So we block most signals here, so the new thread will inherit the signal
 756      * mask, and unblock them right after the thread creation.  The original
 757      * mask is saved in the thread struct so that the new thread can restore
 758      * the original mask.
 759      */
 760     S_block_most_signals(&thread->initial_sigmask);
 761 #endif
 762
 763 #ifdef WIN32
 764     thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE | CLONEf_CLONE_HOST);
 765 #else
 766     thread->interp = perl_clone(aTHX, CLONEf_KEEP_PTR_TABLE);
 767 #endif
 768
 769     /* perl_clone() leaves us in new interpreter's context.  As it is tricky
 770      * to spot an implicit aTHX, create a new scope with aTHX matching the
 771      * context for the duration of our work for new interpreter.
 772      */
 773     {
 774         CLONE_PARAMS clone_param;
 775
 776         dTHXa(thread->interp);
 777
 778         MY_CXT_CLONE;
 779
 780         /* Here we remove END blocks since they should only run in the thread
 781          * they are created
 782          */
 783         SvREFCNT_dec(PL_endav);
 784         PL_endav = newAV();
 785
 786         clone_param.flags = 0;
 787         if (SvPOK(init_function)) {
 788             thread->init_function = newSV(0);
 789             sv_copypv(thread->init_function, init_function);
 790         } else {
 791             thread->init_function =
 792                 SvREFCNT_inc(sv_dup(init_function, &clone_param));
 793         }
 794
 795         thread->params = sv_dup(params, &clone_param);
 796         SvREFCNT_inc_void(thread->params);
 797
 798 #if PERL_VERSION <= 8 && PERL_SUBVERSION <= 7
 799         /* The code below checks that anything living on the tmps stack and
 800          * has been cloned (so it lives in the ptr_table) has a refcount
 801          * higher than 0.
 802          *
 803          * If the refcount is 0 it means that a something on the stack/context
 804          * was holding a reference to it and since we init_stacks() in
 805          * perl_clone that won't get cleaned and we will get a leaked scalar.
 806          * The reason it was cloned was that it lived on the @_ stack.
 807          *
 808          * Example of this can be found in bugreport 15837 where calls in the
 809          * parameter list end up as a temp.
 810          *
 811          * As of 5.8.8 this is done in perl_clone.
 812          */
 813         while (tmps_ix > 0) {
 814             SV* sv = (SV*)ptr_table_fetch(PL_ptr_table, tmps_tmp[tmps_ix]);
 815             tmps_ix--;
 816             if (sv && SvREFCNT(sv) == 0) {
 817                 SvREFCNT_inc_void(sv);
 818                 SvREFCNT_dec(sv);
 819             }
 820         }
 821 #endif
 822
 823         SvTEMP_off(thread->init_function);
 824         ptr_table_free(PL_ptr_table);
 825         PL_ptr_table = NULL;
 826         PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
 827     }
 828     S_ithread_set(aTHX_ current_thread);
 829     PERL_SET_CONTEXT(aTHX);
 830
 831     /* Create/start the thread */
 832 #ifdef WIN32
 833     thread->handle = CreateThread(NULL,
 834                                   (DWORD)thread->stack_size,
 835                                   S_ithread_run,
 836                                   (LPVOID)thread,
 837                                   STACK_SIZE_PARAM_IS_A_RESERVATION,
 838                                   &thread->thr);
 839 #else
 840     {
 841         STATIC pthread_attr_t attr;
 842         STATIC int attr_inited = 0;
 843         STATIC int attr_joinable = PTHREAD_CREATE_JOINABLE;
 844         if (! attr_inited) {
 845             pthread_attr_init(&attr);
 846             attr_inited = 1;
 847         }
 848
 849 #  ifdef PTHREAD_ATTR_SETDETACHSTATE
 850         /* Threads start out joinable */
 851         PTHREAD_ATTR_SETDETACHSTATE(&attr, attr_joinable);
 852 #  endif
 853
 854 #  ifdef _POSIX_THREAD_ATTR_STACKSIZE
 855         /* Set thread's stack size */
 856         if (thread->stack_size > 0) {
 857             rc_stack_size = pthread_attr_setstacksize(&attr, (size_t)thread->stack_size);
 858         }
 859 #  endif
 860
 861         /* Create the thread */
 862         if (! rc_stack_size) {
 863 #  ifdef OLD_PTHREADS_API
 864             rc_thread_create = pthread_create(&thread->thr,
 865                                               attr,
 866                                               S_ithread_run,
 867                                               (void *)thread);
 868 #  else
 869 #    if defined(HAS_PTHREAD_ATTR_SETSCOPE) && defined(PTHREAD_SCOPE_SYSTEM)
 870             pthread_attr_setscope(&attr, PTHREAD_SCOPE_SYSTEM);
 871 #    endif
 872             rc_thread_create = pthread_create(&thread->thr,
 873                                               &attr,
 874                                               S_ithread_run,
 875                                               (void *)thread);
 876 #  endif
 877         }
 878
 879 #ifndef WIN32
 880     /* Now it's safe to accept signals, since we're in our own interpreter's
 881      * context and we have created the thread.
 882      */
 883     S_set_sigmask(&thread->initial_sigmask);
 884 #endif
 885
 886 #  ifdef _POSIX_THREAD_ATTR_STACKSIZE
 887         /* Try to get thread's actual stack size */
 888         {
 889             size_t stacksize;
 890 #ifdef HPUX1020
 891             stacksize = pthread_attr_getstacksize(attr);
 892 #else
 893             if (! pthread_attr_getstacksize(&attr, &stacksize))
 894 #endif
 895                 if (stacksize > 0) {
 896                     thread->stack_size = (IV)stacksize;
 897                 }
 898         }
 899 #  endif
 900     }
 901 #endif
 902
 903     /* Check for errors */
 904 #ifdef WIN32
 905     if (thread->handle == NULL) {
 906 #else
 907     if (rc_stack_size || rc_thread_create) {
 908 #endif
 909         /* Must unlock mutex for destruct call */
 910         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
 911         sv_2mortal(params);
 912         thread->state |= PERL_ITHR_NONVIABLE;
 913         S_ithread_free(aTHX_ thread);   /* Releases MUTEX */
 914 #ifndef WIN32
 915         if (ckWARN_d(WARN_THREADS)) {
 916             if (rc_stack_size) {
 917                 Perl_warn(aTHX_ "Thread creation failed: pthread_attr_setstacksize(%" IVdf ") returned %d", thread->stack_size, rc_stack_size);
 918             } else {
 919                 Perl_warn(aTHX_ "Thread creation failed: pthread_create returned %d", rc_thread_create);
 920             }
 921         }
 922 #endif
 923         return (NULL);
 924     }
 925
 926     MY_POOL.running_threads++;
 927     sv_2mortal(params);
 928     return (thread);
 929 }
 930
 931 #endif /* USE_ITHREADS */
 932
 933
 934 MODULE = threads    PACKAGE = threads    PREFIX = ithread_
 935 PROTOTYPES: DISABLE
 936
 937 #ifdef USE_ITHREADS
 938
 939 void
 940 ithread_create(...)
 941     PREINIT:
 942         char *classname;
 943         ithread *thread;
 944         SV *function_to_call;
 945         AV *params;
 946         HV *specs;
 947         IV stack_size;
 948         int context;
 949         int exit_opt;
 950         SV *thread_exit_only;
 951         char *str;
 952         int idx;
 953         int ii;
 954         dMY_POOL;
 955     CODE:
 956         if ((items >= 2) && SvROK(ST(1)) && SvTYPE(SvRV(ST(1)))==SVt_PVHV) {
 957             if (--items < 2) {
 958                 Perl_croak(aTHX_ "Usage: threads->create(\\%%specs, function, ...)");
 959             }
 960             specs = (HV*)SvRV(ST(1));
 961             idx = 1;
 962         } else {
 963             if (items < 2) {
 964                 Perl_croak(aTHX_ "Usage: threads->create(function, ...)");
 965             }
 966             specs = NULL;
 967             idx = 0;
 968         }
 969
 970         if (sv_isobject(ST(0))) {
 971             /* $thr->create() */
 972             classname = HvNAME(SvSTASH(SvRV(ST(0))));
 973             thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
 974             MUTEX_LOCK(&thread->mutex);
 975             stack_size = thread->stack_size;
 976             exit_opt = thread->state & PERL_ITHR_THREAD_EXIT_ONLY;
 977             MUTEX_UNLOCK(&thread->mutex);
 978         } else {
 979             /* threads->create() */
 980             classname = (char *)SvPV_nolen(ST(0));
 981             stack_size = MY_POOL.default_stack_size;
 982             thread_exit_only = get_sv("threads::thread_exit_only", GV_ADD);
 983             exit_opt = (SvTRUE(thread_exit_only))
 984                                     ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
 985         }
 986
 987         function_to_call = ST(idx+1);
 988
 989         context = -1;
 990         if (specs) {
 991             /* stack_size */
 992             if (hv_exists(specs, "stack", 5)) {
 993                 stack_size = SvIV(*hv_fetch(specs, "stack", 5, 0));
 994             } else if (hv_exists(specs, "stacksize", 9)) {
 995                 stack_size = SvIV(*hv_fetch(specs, "stacksize", 9, 0));
 996             } else if (hv_exists(specs, "stack_size", 10)) {
 997                 stack_size = SvIV(*hv_fetch(specs, "stack_size", 10, 0));
 998             }
 999
1000             /* context */
1001             if (hv_exists(specs, "context", 7)) {
1002                 str = (char *)SvPV_nolen(*hv_fetch(specs, "context", 7, 0));
1003                 switch (*str) {
1004                     case 'a':
1005                     case 'A':
1006                     case 'l':
1007                     case 'L':
1008                         context = G_ARRAY;
1009                         break;
1010                     case 's':
1011                     case 'S':
1012                         context = G_SCALAR;
1013                         break;
1014                     case 'v':
1015                     case 'V':
1016                         context = G_VOID;
1017                         break;
1018                     default:
1019                         Perl_croak(aTHX_ "Invalid context: %s", str);
1020                 }
1021             } else if (hv_exists(specs, "array", 5)) {
1022                 if (SvTRUE(*hv_fetch(specs, "array", 5, 0))) {
1023                     context = G_ARRAY;
1024                 }
1025             } else if (hv_exists(specs, "list", 4)) {
1026                 if (SvTRUE(*hv_fetch(specs, "list", 4, 0))) {
1027                     context = G_ARRAY;
1028                 }
1029             } else if (hv_exists(specs, "scalar", 6)) {
1030                 if (SvTRUE(*hv_fetch(specs, "scalar", 6, 0))) {
1031                     context = G_SCALAR;
1032                 }
1033             } else if (hv_exists(specs, "void", 4)) {
1034                 if (SvTRUE(*hv_fetch(specs, "void", 4, 0))) {
1035                     context = G_VOID;
1036                 }
1037             }
1038
1039             /* exit => thread_only */
1040             if (hv_exists(specs, "exit", 4)) {
1041                 str = (char *)SvPV_nolen(*hv_fetch(specs, "exit", 4, 0));
1042                 exit_opt = (*str == 't' || *str == 'T')
1043                                     ? PERL_ITHR_THREAD_EXIT_ONLY : 0;
1044             }
1045         }
1046         if (context == -1) {
1047             context = GIMME_V;  /* Implicit context */
1048         } else {
1049             context |= (GIMME_V & (~(G_ARRAY|G_SCALAR|G_VOID)));
1050         }
1051
1052         /* Function args */
1053         params = newAV();
1054         if (items > 2) {
1055             for (ii=2; ii < items ; ii++) {
1056                 av_push(params, SvREFCNT_inc(ST(idx+ii)));
1057             }
1058         }
1059
1060         /* Create thread */
1061         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1062         thread = S_ithread_create(aTHX_ function_to_call,
1063                                         stack_size,
1064                                         context,
1065                                         exit_opt,
1066                                         newRV_noinc((SV*)params));
1067         if (! thread) {
1068             XSRETURN_UNDEF;     /* Mutex already unlocked */
1069         }
1070         ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, FALSE));
1071         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1072
1073         /* Let thread run */
1074         MUTEX_UNLOCK(&thread->mutex);
1075
1076         /* XSRETURN(1); - implied */
1077
1078
1079 void
1080 ithread_list(...)
1081     PREINIT:
1082         char *classname;
1083         ithread *thread;
1084         int list_context;
1085         IV count = 0;
1086         int want_running = 0;
1087         int state;
1088         dMY_POOL;
1089     PPCODE:
1090         /* Class method only */
1091         if (SvROK(ST(0))) {
1092             Perl_croak(aTHX_ "Usage: threads->list(...)");
1093         }
1094         classname = (char *)SvPV_nolen(ST(0));
1095
1096         /* Calling context */
1097         list_context = (GIMME_V == G_ARRAY);
1098
1099         /* Running or joinable parameter */
1100         if (items > 1) {
1101             want_running = SvTRUE(ST(1));
1102         }
1103
1104         /* Walk through threads list */
1105         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1106         for (thread = MY_POOL.main_thread.next;
1107              thread != &MY_POOL.main_thread;
1108              thread = thread->next)
1109         {
1110             MUTEX_LOCK(&thread->mutex);
1111             state = thread->state;
1112             MUTEX_UNLOCK(&thread->mutex);
1113
1114             /* Ignore detached or joined threads */
1115             if (state & PERL_ITHR_UNCALLABLE) {
1116                 continue;
1117             }
1118
1119             /* Filter per parameter */
1120             if (items > 1) {
1121                 if (want_running) {
1122                     if (state & PERL_ITHR_FINISHED) {
1123                         continue;   /* Not running */
1124                     }
1125                 } else {
1126                     if (! (state & PERL_ITHR_FINISHED)) {
1127                         continue;   /* Still running - not joinable yet */
1128                     }
1129                 }
1130             }
1131
1132             /* Push object on stack if list context */
1133             if (list_context) {
1134                 XPUSHs(sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE)));
1135             }
1136             count++;
1137         }
1138         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1139         /* If scalar context, send back count */
1140         if (! list_context) {
1141             XSRETURN_IV(count);
1142         }
1143
1144
1145 void
1146 ithread_self(...)
1147     PREINIT:
1148         char *classname;
1149         ithread *thread;
1150     CODE:
1151         /* Class method only */
1152         if ((items != 1) || SvROK(ST(0))) {
1153             Perl_croak(aTHX_ "Usage: threads->self()");
1154         }
1155         classname = (char *)SvPV_nolen(ST(0));
1156
1157         thread = S_ithread_get(aTHX);
1158
1159         ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1160         /* XSRETURN(1); - implied */
1161
1162
1163 void
1164 ithread_tid(...)
1165     PREINIT:
1166         ithread *thread;
1167     CODE:
1168         PERL_UNUSED_VAR(items);
1169         thread = S_SV_to_ithread(aTHX_ ST(0));
1170         XST_mUV(0, thread->tid);
1171         /* XSRETURN(1); - implied */
1172
1173
1174 void
1175 ithread_join(...)
1176     PREINIT:
1177         ithread *thread;
1178         ithread *current_thread;
1179         int join_err;
1180         AV *params = NULL;
1181         int len;
1182         int ii;
1183 #ifndef WIN32
1184         int rc_join;
1185         void *retval;
1186 #endif
1187         dMY_POOL;
1188     PPCODE:
1189         /* Object method only */
1190         if ((items != 1) || ! sv_isobject(ST(0))) {
1191             Perl_croak(aTHX_ "Usage: $thr->join()");
1192         }
1193
1194         /* Check if the thread is joinable and not ourselves */
1195         thread = S_SV_to_ithread(aTHX_ ST(0));
1196         current_thread = S_ithread_get(aTHX);
1197
1198         MUTEX_LOCK(&thread->mutex);
1199         if ((join_err = (thread->state & PERL_ITHR_UNCALLABLE))) {
1200             MUTEX_UNLOCK(&thread->mutex);
1201             Perl_croak(aTHX_ (join_err & PERL_ITHR_DETACHED)
1202                                 ? "Cannot join a detached thread"
1203                                 : "Thread already joined");
1204         } else if (thread->tid == current_thread->tid) {
1205             MUTEX_UNLOCK(&thread->mutex);
1206             Perl_croak(aTHX_ "Cannot join self");
1207         }
1208
1209         /* Mark as joined */
1210         thread->state |= PERL_ITHR_JOINED;
1211         MUTEX_UNLOCK(&thread->mutex);
1212
1213         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1214         MY_POOL.joinable_threads--;
1215         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1216
1217         /* Join the thread */
1218 #ifdef WIN32
1219         if (WaitForSingleObject(thread->handle, INFINITE) != WAIT_OBJECT_0) {
1220             /* Timeout/abandonment unexpected here; check $^E */
1221             Perl_croak(aTHX_ "PANIC: underlying join failed");
1222         };
1223 #else
1224         if ((rc_join = pthread_join(thread->thr, &retval)) != 0) {
1225             /* In progress/deadlock/unknown unexpected here; check $! */
1226             errno = rc_join;
1227             Perl_croak(aTHX_ "PANIC: underlying join failed");
1228         };
1229 #endif
1230
1231         MUTEX_LOCK(&thread->mutex);
1232         /* Get the return value from the call_sv */
1233         /* Objects do not survive this process - FIXME */
1234         if ((thread->gimme & G_WANT) != G_VOID) {
1235             AV *params_copy;
1236             PerlInterpreter *other_perl;
1237             CLONE_PARAMS clone_params;
1238
1239             params_copy = (AV *)SvRV(thread->params);
1240             other_perl = thread->interp;
1241             clone_params.stashes = newAV();
1242             clone_params.flags = CLONEf_JOIN_IN;
1243             PL_ptr_table = ptr_table_new();
1244             S_ithread_set(aTHX_ thread);
1245             /* Ensure 'meaningful' addresses retain their meaning */
1246             ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1247             ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1248             ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1249             params = (AV *)sv_dup((SV*)params_copy, &clone_params);
1250             S_ithread_set(aTHX_ current_thread);
1251             SvREFCNT_dec(clone_params.stashes);
1252             SvREFCNT_inc_void(params);
1253             ptr_table_free(PL_ptr_table);
1254             PL_ptr_table = NULL;
1255         }
1256
1257         /* If thread didn't die, then we can free its interpreter */
1258         if (! (thread->state & PERL_ITHR_DIED)) {
1259             S_ithread_clear(aTHX_ thread);
1260         }
1261         S_ithread_free(aTHX_ thread);   /* Releases MUTEX */
1262
1263         /* If no return values, then just return */
1264         if (! params) {
1265             XSRETURN_UNDEF;
1266         }
1267
1268         /* Put return values on stack */
1269         len = (int)AvFILL(params);
1270         for (ii=0; ii <= len; ii++) {
1271             SV* param = av_shift(params);
1272             XPUSHs(sv_2mortal(param));
1273         }
1274
1275         /* Free return value array */
1276         SvREFCNT_dec(params);
1277
1278
1279 void
1280 ithread_yield(...)
1281     CODE:
1282         PERL_UNUSED_VAR(items);
1283         YIELD;
1284
1285
1286 void
1287 ithread_detach(...)
1288     PREINIT:
1289         ithread *thread;
1290         int detach_err;
1291         dMY_POOL;
1292     CODE:
1293         PERL_UNUSED_VAR(items);
1294
1295         /* Detach the thread */
1296         thread = S_SV_to_ithread(aTHX_ ST(0));
1297         MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1298         MUTEX_LOCK(&thread->mutex);
1299         if (! (detach_err = (thread->state & PERL_ITHR_UNCALLABLE))) {
1300             /* Thread is detachable */
1301             thread->state |= PERL_ITHR_DETACHED;
1302 #ifdef WIN32
1303             /* Windows has no 'detach thread' function */
1304 #else
1305             PERL_THREAD_DETACH(thread->thr);
1306 #endif
1307             if (thread->state & PERL_ITHR_FINISHED) {
1308                 MY_POOL.joinable_threads--;
1309             } else {
1310                 MY_POOL.running_threads--;
1311                 MY_POOL.detached_threads++;
1312             }
1313         }
1314         MUTEX_UNLOCK(&thread->mutex);
1315         MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1316
1317         if (detach_err) {
1318             Perl_croak(aTHX_ (detach_err & PERL_ITHR_DETACHED)
1319                                 ? "Thread already detached"
1320                                 : "Cannot detach a joined thread");
1321         }
1322
1323         /* If thread is finished and didn't die,
1324          * then we can free its interpreter */
1325         MUTEX_LOCK(&thread->mutex);
1326         if ((thread->state & PERL_ITHR_FINISHED) &&
1327             ! (thread->state & PERL_ITHR_DIED))
1328         {
1329             S_ithread_clear(aTHX_ thread);
1330         }
1331         S_ithread_free(aTHX_ thread);   /* Releases MUTEX */
1332
1333
1334 void
1335 ithread_kill(...)
1336     PREINIT:
1337         ithread *thread;
1338         char *sig_name;
1339         IV signal;
1340     CODE:
1341         /* Must have safe signals */
1342         if (PL_signals & PERL_SIGNALS_UNSAFE_FLAG) {
1343             Perl_croak(aTHX_ "Cannot signal threads without safe signals");
1344         }
1345
1346         /* Object method only */
1347         if ((items != 2) || ! sv_isobject(ST(0))) {
1348             Perl_croak(aTHX_ "Usage: $thr->kill('SIG...')");
1349         }
1350
1351         /* Get signal */
1352         sig_name = SvPV_nolen(ST(1));
1353         if (isALPHA(*sig_name)) {
1354             if (*sig_name == 'S' && sig_name[1] == 'I' && sig_name[2] == 'G') {
1355                 sig_name += 3;
1356             }
1357             if ((signal = whichsig(sig_name)) < 0) {
1358                 Perl_croak(aTHX_ "Unrecognized signal name: %s", sig_name);
1359             }
1360         } else {
1361             signal = SvIV(ST(1));
1362         }
1363
1364         /* Set the signal for the thread */
1365         thread = S_SV_to_ithread(aTHX_ ST(0));
1366         MUTEX_LOCK(&thread->mutex);
1367         if (thread->interp) {
1368             dTHXa(thread->interp);
1369             PL_psig_pend[signal]++;
1370             PL_sig_pending = 1;
1371         }
1372         MUTEX_UNLOCK(&thread->mutex);
1373
1374         /* Return the thread to allow for method chaining */
1375         ST(0) = ST(0);
1376         /* XSRETURN(1); - implied */
1377
1378
1379 void
1380 ithread_DESTROY(...)
1381     CODE:
1382         PERL_UNUSED_VAR(items);
1383         sv_unmagic(SvRV(ST(0)), PERL_MAGIC_shared_scalar);
1384
1385
1386 void
1387 ithread_equal(...)
1388     PREINIT:
1389         int are_equal = 0;
1390     CODE:
1391         PERL_UNUSED_VAR(items);
1392
1393         /* Compares TIDs to determine thread equality */
1394         if (sv_isobject(ST(0)) && sv_isobject(ST(1))) {
1395             ithread *thr1 = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1396             ithread *thr2 = INT2PTR(ithread *, SvIV(SvRV(ST(1))));
1397             are_equal = (thr1->tid == thr2->tid);
1398         }
1399         if (are_equal) {
1400             XST_mYES(0);
1401         } else {
1402             /* Return 0 on false for backward compatibility */
1403             XST_mIV(0, 0);
1404         }
1405         /* XSRETURN(1); - implied */
1406
1407
1408 void
1409 ithread_object(...)
1410     PREINIT:
1411         char *classname;
1412         SV *arg;
1413         UV tid;
1414         ithread *thread;
1415         int state;
1416         int have_obj = 0;
1417         dMY_POOL;
1418     CODE:
1419         /* Class method only */
1420         if (SvROK(ST(0))) {
1421             Perl_croak(aTHX_ "Usage: threads->object($tid)");
1422         }
1423         classname = (char *)SvPV_nolen(ST(0));
1424
1425         /* Turn $tid from PVLV to SV if needed (bug #73330) */
1426         arg = ST(1);
1427         SvGETMAGIC(arg);
1428
1429         if ((items < 2) || ! SvOK(arg)) {
1430             XSRETURN_UNDEF;
1431         }
1432
1433         /* threads->object($tid) */
1434         tid = SvUV(arg);
1435
1436         /* If current thread wants its own object, then behave the same as
1437            ->self() */
1438         thread = S_ithread_get(aTHX);
1439         if (thread->tid == tid) {
1440             ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1441             have_obj = 1;
1442
1443         } else {
1444             /* Walk through threads list */
1445             MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1446             for (thread = MY_POOL.main_thread.next;
1447                  thread != &MY_POOL.main_thread;
1448                  thread = thread->next)
1449             {
1450                 /* Look for TID */
1451                 if (thread->tid == tid) {
1452                     /* Ignore if detached or joined */
1453                     MUTEX_LOCK(&thread->mutex);
1454                     state = thread->state;
1455                     MUTEX_UNLOCK(&thread->mutex);
1456                     if (! (state & PERL_ITHR_UNCALLABLE)) {
1457                         /* Put object on stack */
1458                         ST(0) = sv_2mortal(S_ithread_to_SV(aTHX_ Nullsv, thread, classname, TRUE));
1459                         have_obj = 1;
1460                     }
1461                     break;
1462                 }
1463             }
1464             MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1465         }
1466
1467         if (! have_obj) {
1468             XSRETURN_UNDEF;
1469         }
1470         /* XSRETURN(1); - implied */
1471
1472
1473 void
1474 ithread__handle(...);
1475     PREINIT:
1476         ithread *thread;
1477     CODE:
1478         PERL_UNUSED_VAR(items);
1479         thread = S_SV_to_ithread(aTHX_ ST(0));
1480 #ifdef WIN32
1481         XST_mUV(0, PTR2UV(&thread->handle));
1482 #else
1483         XST_mUV(0, PTR2UV(&thread->thr));
1484 #endif
1485         /* XSRETURN(1); - implied */
1486
1487
1488 void
1489 ithread_get_stack_size(...)
1490     PREINIT:
1491         IV stack_size;
1492         dMY_POOL;
1493     CODE:
1494         PERL_UNUSED_VAR(items);
1495         if (sv_isobject(ST(0))) {
1496             /* $thr->get_stack_size() */
1497             ithread *thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1498             stack_size = thread->stack_size;
1499         } else {
1500             /* threads->get_stack_size() */
1501             stack_size = MY_POOL.default_stack_size;
1502         }
1503         XST_mIV(0, stack_size);
1504         /* XSRETURN(1); - implied */
1505
1506
1507 void
1508 ithread_set_stack_size(...)
1509     PREINIT:
1510         IV old_size;
1511         dMY_POOL;
1512     CODE:
1513         if (items != 2) {
1514             Perl_croak(aTHX_ "Usage: threads->set_stack_size($size)");
1515         }
1516         if (sv_isobject(ST(0))) {
1517             Perl_croak(aTHX_ "Cannot change stack size of an existing thread");
1518         }
1519         if (! looks_like_number(ST(1))) {
1520             Perl_croak(aTHX_ "Stack size must be numeric");
1521         }
1522
1523         old_size = MY_POOL.default_stack_size;
1524         MY_POOL.default_stack_size = S_good_stack_size(aTHX_ SvIV(ST(1)));
1525         XST_mIV(0, old_size);
1526         /* XSRETURN(1); - implied */
1527
1528
1529 void
1530 ithread_is_running(...)
1531     PREINIT:
1532         ithread *thread;
1533     CODE:
1534         /* Object method only */
1535         if ((items != 1) || ! sv_isobject(ST(0))) {
1536             Perl_croak(aTHX_ "Usage: $thr->is_running()");
1537         }
1538
1539         thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1540         MUTEX_LOCK(&thread->mutex);
1541         ST(0) = (thread->state & PERL_ITHR_FINISHED) ? &PL_sv_no : &PL_sv_yes;
1542         MUTEX_UNLOCK(&thread->mutex);
1543         /* XSRETURN(1); - implied */
1544
1545
1546 void
1547 ithread_is_detached(...)
1548     PREINIT:
1549         ithread *thread;
1550     CODE:
1551         PERL_UNUSED_VAR(items);
1552         thread = S_SV_to_ithread(aTHX_ ST(0));
1553         MUTEX_LOCK(&thread->mutex);
1554         ST(0) = (thread->state & PERL_ITHR_DETACHED) ? &PL_sv_yes : &PL_sv_no;
1555         MUTEX_UNLOCK(&thread->mutex);
1556         /* XSRETURN(1); - implied */
1557
1558
1559 void
1560 ithread_is_joinable(...)
1561     PREINIT:
1562         ithread *thread;
1563     CODE:
1564         /* Object method only */
1565         if ((items != 1) || ! sv_isobject(ST(0))) {
1566             Perl_croak(aTHX_ "Usage: $thr->is_joinable()");
1567         }
1568
1569         thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1570         MUTEX_LOCK(&thread->mutex);
1571         ST(0) = ((thread->state & PERL_ITHR_FINISHED) &&
1572                  ! (thread->state & PERL_ITHR_UNCALLABLE))
1573             ? &PL_sv_yes : &PL_sv_no;
1574         MUTEX_UNLOCK(&thread->mutex);
1575         /* XSRETURN(1); - implied */
1576
1577
1578 void
1579 ithread_wantarray(...)
1580     PREINIT:
1581         ithread *thread;
1582     CODE:
1583         PERL_UNUSED_VAR(items);
1584         thread = S_SV_to_ithread(aTHX_ ST(0));
1585         ST(0) = ((thread->gimme & G_WANT) == G_ARRAY) ? &PL_sv_yes :
1586                 ((thread->gimme & G_WANT) == G_VOID)  ? &PL_sv_undef
1587                                        /* G_SCALAR */ : &PL_sv_no;
1588         /* XSRETURN(1); - implied */
1589
1590
1591 void
1592 ithread_set_thread_exit_only(...)
1593     PREINIT:
1594         ithread *thread;
1595     CODE:
1596         if (items != 2) {
1597             Perl_croak(aTHX_ "Usage: ->set_thread_exit_only(boolean)");
1598         }
1599         thread = S_SV_to_ithread(aTHX_ ST(0));
1600         MUTEX_LOCK(&thread->mutex);
1601         if (SvTRUE(ST(1))) {
1602             thread->state |= PERL_ITHR_THREAD_EXIT_ONLY;
1603         } else {
1604             thread->state &= ~PERL_ITHR_THREAD_EXIT_ONLY;
1605         }
1606         MUTEX_UNLOCK(&thread->mutex);
1607
1608
1609 void
1610 ithread_error(...)
1611     PREINIT:
1612         ithread *thread;
1613         SV *err = NULL;
1614     CODE:
1615         /* Object method only */
1616         if ((items != 1) || ! sv_isobject(ST(0))) {
1617             Perl_croak(aTHX_ "Usage: $thr->err()");
1618         }
1619
1620         thread = INT2PTR(ithread *, SvIV(SvRV(ST(0))));
1621         MUTEX_LOCK(&thread->mutex);
1622
1623         /* If thread died, then clone the error into the calling thread */
1624         if (thread->state & PERL_ITHR_DIED) {
1625             PerlInterpreter *other_perl;
1626             CLONE_PARAMS clone_params;
1627             ithread *current_thread;
1628
1629             other_perl = thread->interp;
1630             clone_params.stashes = newAV();
1631             clone_params.flags = CLONEf_JOIN_IN;
1632             PL_ptr_table = ptr_table_new();
1633             current_thread = S_ithread_get(aTHX);
1634             S_ithread_set(aTHX_ thread);
1635             /* Ensure 'meaningful' addresses retain their meaning */
1636             ptr_table_store(PL_ptr_table, &other_perl->Isv_undef, &PL_sv_undef);
1637             ptr_table_store(PL_ptr_table, &other_perl->Isv_no, &PL_sv_no);
1638             ptr_table_store(PL_ptr_table, &other_perl->Isv_yes, &PL_sv_yes);
1639             err = sv_dup(thread->err, &clone_params);
1640             S_ithread_set(aTHX_ current_thread);
1641             SvREFCNT_dec(clone_params.stashes);
1642             SvREFCNT_inc_void(err);
1643             /* If error was an object, bless it into the correct class */
1644             if (thread->err_class) {
1645                 sv_bless(err, gv_stashpv(thread->err_class, 1));
1646             }
1647             ptr_table_free(PL_ptr_table);
1648             PL_ptr_table = NULL;
1649         }
1650
1651         MUTEX_UNLOCK(&thread->mutex);
1652
1653         if (! err) {
1654             XSRETURN_UNDEF;
1655         }
1656
1657         ST(0) = sv_2mortal(err);
1658         /* XSRETURN(1); - implied */
1659
1660
1661 #endif /* USE_ITHREADS */
1662
1663
1664 BOOT:
1665 {
1666 #ifdef USE_ITHREADS
1667     SV *my_pool_sv = *hv_fetch(PL_modglobal, MY_POOL_KEY,
1668                                sizeof(MY_POOL_KEY)-1, TRUE);
1669     my_pool_t *my_poolp = (my_pool_t*)SvPVX(newSV(sizeof(my_pool_t)-1));
1670
1671     MY_CXT_INIT;
1672
1673     Zero(my_poolp, 1, my_pool_t);
1674     sv_setuv(my_pool_sv, PTR2UV(my_poolp));
1675
1676     PL_perl_destruct_level = 2;
1677     MUTEX_INIT(&MY_POOL.create_destruct_mutex);
1678     MUTEX_LOCK(&MY_POOL.create_destruct_mutex);
1679
1680     PL_threadhook = &Perl_ithread_hook;
1681
1682     MY_POOL.tid_counter = 1;
1683 #  ifdef THREAD_CREATE_NEEDS_STACK
1684     MY_POOL.default_stack_size = THREAD_CREATE_NEEDS_STACK;
1685 #  endif
1686
1687     /* The 'main' thread is thread 0.
1688      * It is detached (unjoinable) and immortal.
1689      */
1690
1691     MUTEX_INIT(&MY_POOL.main_thread.mutex);
1692
1693     /* Head of the threads list */
1694     MY_POOL.main_thread.next = &MY_POOL.main_thread;
1695     MY_POOL.main_thread.prev = &MY_POOL.main_thread;
1696
1697     MY_POOL.main_thread.count = 1;                  /* Immortal */
1698
1699     MY_POOL.main_thread.interp = aTHX;
1700     MY_POOL.main_thread.state = PERL_ITHR_DETACHED; /* Detached */
1701     MY_POOL.main_thread.stack_size = MY_POOL.default_stack_size;
1702 #  ifdef WIN32
1703     MY_POOL.main_thread.thr = GetCurrentThreadId();
1704 #  else
1705     MY_POOL.main_thread.thr = pthread_self();
1706 #  endif
1707
1708     S_ithread_set(aTHX_ &MY_POOL.main_thread);
1709     MUTEX_UNLOCK(&MY_POOL.create_destruct_mutex);
1710 #endif /* USE_ITHREADS */
1711 }