ext/Thread/Thread.xs

   1 #include "EXTERN.h"
   2 #include "perl.h"
   3 #include "XSUB.h"
   4
   5 /* Magic signature for Thread's mg_private is "Th" */
   6 #define Thread_MAGIC_SIGNATURE 0x5468
   7
   8 #ifdef __cplusplus
   9 #ifdef I_UNISTD
  10 #include <unistd.h>
  11 #endif
  12 #endif
  13 #include <fcntl.h>
  14
  15 static int sig_pipe[2];
  16
  17 #ifndef THREAD_RET_TYPE
  18 #define THREAD_RET_TYPE void *
  19 #define THREAD_RET_CAST(x) ((THREAD_RET_TYPE) x)
  20 #endif
  21
  22 static void
  23 remove_thread(struct perl_thread *t)
  24 {
  25 #ifdef USE_THREADS
  26     DEBUG_L(WITH_THR(PerlIO_printf(PerlIO_stderr(),
  27                                    "%p: remove_thread %p\n", thr, t)));
  28     MUTEX_LOCK(&threads_mutex);
  29     MUTEX_DESTROY(&t->mutex);
  30     nthreads--;
  31     t->prev->next = t->next;
  32     t->next->prev = t->prev;
  33     COND_BROADCAST(&nthreads_cond);
  34     MUTEX_UNLOCK(&threads_mutex);
  35 #endif
  36 }
  37
  38 static THREAD_RET_TYPE
  39 threadstart(void *arg)
  40 {
  41 #ifdef USE_THREADS
  42 #ifdef FAKE_THREADS
  43     Thread savethread = thr;
  44     LOGOP myop;
  45     dSP;
  46     I32 oldscope = scopestack_ix;
  47     I32 retval;
  48     AV *av;
  49     int i;
  50
  51     DEBUG_L(PerlIO_printf(PerlIO_stderr(), "new thread %p starting at %s\n",
  52                           thr, SvPEEK(TOPs)));
  53     thr = (Thread) arg;
  54     savemark = TOPMARK;
  55     thr->prev = thr->prev_run = savethread;
  56     thr->next = savethread->next;
  57     thr->next_run = savethread->next_run;
  58     savethread->next = savethread->next_run = thr;
  59     thr->wait_queue = 0;
  60     thr->private = 0;
  61
  62     /* Now duplicate most of perl_call_sv but with a few twists */
  63     op = (OP*)&myop;
  64     Zero(op, 1, LOGOP);
  65     myop.op_flags = OPf_STACKED;
  66     myop.op_next = Nullop;
  67     myop.op_flags |= OPf_KNOW;
  68     myop.op_flags |= OPf_WANT_LIST;
  69     op = pp_entersub(ARGS);
  70     DEBUG_L(if (!op)
  71             PerlIO_printf(PerlIO_stderr(), "thread starts at Nullop\n"));
  72     /*
  73      * When this thread is next scheduled, we start in the right
  74      * place. When the thread runs off the end of the sub, perl.c
  75      * handles things, using savemark to figure out how much of the
  76      * stack is the return value for any join.
  77      */
  78     thr = savethread;           /* back to the old thread */
  79     return 0;
  80 #else
  81     Thread thr = (Thread) arg;
  82     LOGOP myop;
  83     djSP;
  84     I32 oldmark = TOPMARK;
  85     I32 oldscope = scopestack_ix;
  86     I32 retval;
  87     SV *sv;
  88     AV *av = newAV();
  89     int i, ret;
  90     dJMPENV;
  91     DEBUG_L(PerlIO_printf(PerlIO_stderr(), "new thread %p waiting to start\n",
  92                           thr));
  93
  94     /* Don't call *anything* requiring dTHR until after SET_THR() */
  95     /*
  96      * Wait until our creator releases us. If we didn't do this, then
  97      * it would be potentially possible for out thread to carry on and
  98      * do stuff before our creator fills in our "self" field. For example,
  99      * if we went and created another thread which tried to JOIN with us,
 100      * then we'd be in a mess.
 101      */
 102     MUTEX_LOCK(&thr->mutex);
 103     MUTEX_UNLOCK(&thr->mutex);
 104
 105     /*
 106      * It's safe to wait until now to set the thread-specific pointer
 107      * from our pthread_t structure to our struct perl_thread, since
 108      * we're the only thread who can get at it anyway.
 109      */
 110     SET_THR(thr);
 111
 112     /* Only now can we use SvPEEK (which calls sv_newmortal which does dTHR) */
 113     DEBUG_L(PerlIO_printf(PerlIO_stderr(), "new thread %p starting at %s\n",
 114                           thr, SvPEEK(TOPs)));
 115
 116     sv = POPs;
 117     PUTBACK;
 118     perl_call_sv(sv, G_ARRAY|G_EVAL);
 119     SPAGAIN;
 120     retval = sp - (stack_base + oldmark);
 121     sp = stack_base + oldmark + 1;
 122     if (SvCUR(thr->errsv)) {
 123         MUTEX_LOCK(&thr->mutex);
 124         thr->flags |= THRf_DID_DIE;
 125         MUTEX_UNLOCK(&thr->mutex);
 126         av_store(av, 0, &sv_no);
 127         av_store(av, 1, newSVsv(thr->errsv));
 128         DEBUG_L(PerlIO_printf(PerlIO_stderr(), "%p died: %s\n",
 129                               SvPV(thr->errsv, na)));
 130     } else {
 131         DEBUG_L(STMT_START {
 132             for (i = 1; i <= retval; i++) {
 133                 PerlIO_printf(PerlIO_stderr(), "%p return[%d] = %s\n",
 134                                 thr, i, SvPEEK(sp[i - 1]));
 135             }
 136         } STMT_END);
 137         av_store(av, 0, &sv_yes);
 138         for (i = 1; i <= retval; i++, sp++)
 139             sv_setsv(*av_fetch(av, i, TRUE), SvREFCNT_inc(*sp));
 140     }
 141
 142   finishoff:
 143 #if 0
 144     /* removed for debug */
 145     SvREFCNT_dec(curstack);
 146 #endif
 147     SvREFCNT_dec(thr->cvcache);
 148     SvREFCNT_dec(thr->threadsv);
 149     SvREFCNT_dec(thr->specific);
 150     SvREFCNT_dec(thr->errsv);
 151     SvREFCNT_dec(thr->errhv);
 152     Safefree(markstack);
 153     Safefree(scopestack);
 154     Safefree(savestack);
 155     Safefree(retstack);
 156     Safefree(cxstack);
 157     Safefree(tmps_stack);
 158     Safefree(ofs);
 159
 160     MUTEX_LOCK(&thr->mutex);
 161     DEBUG_L(PerlIO_printf(PerlIO_stderr(),
 162                           "%p: threadstart finishing: state is %u\n",
 163                           thr, ThrSTATE(thr)));
 164     switch (ThrSTATE(thr)) {
 165     case THRf_R_JOINABLE:
 166         ThrSETSTATE(thr, THRf_ZOMBIE);
 167         MUTEX_UNLOCK(&thr->mutex);
 168         DEBUG_L(PerlIO_printf(PerlIO_stderr(),
 169                               "%p: R_JOINABLE thread finished\n", thr));
 170         break;
 171     case THRf_R_JOINED:
 172         ThrSETSTATE(thr, THRf_DEAD);
 173         MUTEX_UNLOCK(&thr->mutex);
 174         remove_thread(thr);
 175         DEBUG_L(PerlIO_printf(PerlIO_stderr(),
 176                               "%p: R_JOINED thread finished\n", thr));
 177         break;
 178     case THRf_R_DETACHED:
 179         ThrSETSTATE(thr, THRf_DEAD);
 180         MUTEX_UNLOCK(&thr->mutex);
 181         SvREFCNT_dec(av);
 182         DEBUG_L(PerlIO_printf(PerlIO_stderr(),
 183                               "%p: DETACHED thread finished\n", thr));
 184         remove_thread(thr);     /* This might trigger main thread to finish */
 185         break;
 186     default:
 187         MUTEX_UNLOCK(&thr->mutex);
 188         croak("panic: illegal state %u at end of threadstart", ThrSTATE(thr));
 189         /* NOTREACHED */
 190     }
 191     return THREAD_RET_CAST(av); /* Available for anyone to join with */
 192                                         /* us unless we're detached, in which */
 193                                         /* case noone sees the value anyway. */
 194 #endif
 195 #else
 196     return THREAD_RET_CAST(NULL);
 197 #endif
 198 }
 199
 200 static SV *
 201 newthread (SV *startsv, AV *initargs, char *classname)
 202 {
 203 #ifdef USE_THREADS
 204     dSP;
 205     Thread savethread;
 206     int i;
 207     SV *sv;
 208     int err;
 209 #ifndef THREAD_CREATE
 210     static pthread_attr_t attr;
 211     static int attr_inited = 0;
 212     sigset_t fullmask, oldmask;
 213 #endif
 214
 215     savethread = thr;
 216     thr = new_struct_thread(thr);
 217     SPAGAIN;
 218     DEBUG_L(PerlIO_printf(PerlIO_stderr(),
 219                           "%p: newthread (%p), tid is %u, preparing stack\n",
 220                           savethread, thr, thr->tid));
 221     /* The following pushes the arg list and startsv onto the *new* stack */
 222     PUSHMARK(sp);
 223     /* Could easily speed up the following greatly */
 224     for (i = 0; i <= AvFILL(initargs); i++)
 225         XPUSHs(SvREFCNT_inc(*av_fetch(initargs, i, FALSE)));
 226     XPUSHs(SvREFCNT_inc(startsv));
 227     PUTBACK;
 228 #ifdef THREAD_CREATE
 229     err = THREAD_CREATE(thr, threadstart);
 230 #else
 231     /* On your marks... */
 232     MUTEX_LOCK(&thr->mutex);
 233     /* Get set...  */
 234     sigfillset(&fullmask);
 235     if (sigprocmask(SIG_SETMASK, &fullmask, &oldmask) == -1)
 236         croak("panic: sigprocmask");
 237     err = 0;
 238     if (!attr_inited) {
 239         attr_inited = 1;
 240         err = pthread_attr_init(&attr);
 241         if (err == 0)
 242             err = pthread_attr_setdetachstate(&attr, ATTR_JOINABLE);
 243     }
 244     if (err == 0)
 245         err = pthread_create(&thr->self, &attr, threadstart, (void*) thr);
 246     /* Go */
 247     MUTEX_UNLOCK(&thr->mutex);
 248 #endif
 249     if (err) {
 250         DEBUG_L(PerlIO_printf(PerlIO_stderr(),
 251                               "%p: create of %p failed %d\n",
 252                               savethread, thr, err));
 253         /* Thread creation failed--clean up */
 254         SvREFCNT_dec(thr->cvcache);
 255         remove_thread(thr);
 256         MUTEX_DESTROY(&thr->mutex);
 257         for (i = 0; i <= AvFILL(initargs); i++)
 258             SvREFCNT_dec(*av_fetch(initargs, i, FALSE));
 259         SvREFCNT_dec(startsv);
 260         return NULL;
 261     }
 262 #ifdef THREAD_POST_CREATE
 263     THREAD_POST_CREATE(thr);
 264 #else
 265     if (sigprocmask(SIG_SETMASK, &oldmask, 0))
 266         croak("panic: sigprocmask");
 267 #endif
 268     sv = newSViv(thr->tid);
 269     sv_magic(sv, thr->oursv, '~', 0, 0);
 270     SvMAGIC(sv)->mg_private = Thread_MAGIC_SIGNATURE;
 271     return sv_bless(newRV_noinc(sv), gv_stashpv(classname, TRUE));
 272 #else
 273     croak("No threads in this perl");
 274     return &sv_undef;
 275 #endif
 276 }
 277
 278 static Signal_t handle_thread_signal _((int sig));
 279
 280 static Signal_t
 281 handle_thread_signal(int sig)
 282 {
 283     char c = (char) sig;
 284     write(sig_pipe[0], &c, 1);
 285 }
 286
 287 MODULE = Thread         PACKAGE = Thread
 288 PROTOTYPES: DISABLE
 289
 290 void
 291 new(classname, startsv, ...)
 292         char *          classname
 293         SV *            startsv
 294         AV *            av = av_make(items - 2, &ST(2));
 295     PPCODE:
 296         XPUSHs(sv_2mortal(newthread(startsv, av, classname)));
 297
 298 void
 299 join(t)
 300         Thread  t
 301         AV *    av = NO_INIT
 302         int     i = NO_INIT
 303     PPCODE:
 304 #ifdef USE_THREADS
 305         DEBUG_L(PerlIO_printf(PerlIO_stderr(), "%p: joining %p (state %u)\n",
 306                               thr, t, ThrSTATE(t)););
 307         MUTEX_LOCK(&t->mutex);
 308         switch (ThrSTATE(t)) {
 309         case THRf_R_JOINABLE:
 310         case THRf_R_JOINED:
 311             ThrSETSTATE(t, THRf_R_JOINED);
 312             MUTEX_UNLOCK(&t->mutex);
 313             break;
 314         case THRf_ZOMBIE:
 315             ThrSETSTATE(t, THRf_DEAD);
 316             MUTEX_UNLOCK(&t->mutex);
 317             remove_thread(t);
 318             break;
 319         default:
 320             MUTEX_UNLOCK(&t->mutex);
 321             croak("can't join with thread");
 322             /* NOTREACHED */
 323         }
 324         JOIN(t, &av);
 325
 326         if (SvTRUE(*av_fetch(av, 0, FALSE))) {
 327             /* Could easily speed up the following if necessary */
 328             for (i = 1; i <= AvFILL(av); i++)
 329                 XPUSHs(sv_2mortal(*av_fetch(av, i, FALSE)));
 330         } else {
 331             char *mess = SvPV(*av_fetch(av, 1, FALSE), na);
 332             DEBUG_L(PerlIO_printf(PerlIO_stderr(),
 333                                   "%p: join propagating die message: %s\n",
 334                                   thr, mess));
 335             croak(mess);
 336         }
 337 #endif
 338
 339 void
 340 detach(t)
 341         Thread  t
 342     CODE:
 343 #ifdef USE_THREADS
 344         DEBUG_L(PerlIO_printf(PerlIO_stderr(), "%p: detaching %p (state %u)\n",
 345                               thr, t, ThrSTATE(t)););
 346         MUTEX_LOCK(&t->mutex);
 347         switch (ThrSTATE(t)) {
 348         case THRf_R_JOINABLE:
 349             ThrSETSTATE(t, THRf_R_DETACHED);
 350             /* fall through */
 351         case THRf_R_DETACHED:
 352             DETACH(t);
 353             MUTEX_UNLOCK(&t->mutex);
 354             break;
 355         case THRf_ZOMBIE:
 356             ThrSETSTATE(t, THRf_DEAD);
 357             DETACH(t);
 358             MUTEX_UNLOCK(&t->mutex);
 359             remove_thread(t);
 360             break;
 361         default:
 362             MUTEX_UNLOCK(&t->mutex);
 363             croak("can't detach thread");
 364             /* NOTREACHED */
 365         }
 366 #endif
 367
 368 void
 369 equal(t1, t2)
 370         Thread  t1
 371         Thread  t2
 372     PPCODE:
 373         PUSHs((t1 == t2) ? &sv_yes : &sv_no);
 374
 375 void
 376 flags(t)
 377         Thread  t
 378     PPCODE:
 379 #ifdef USE_THREADS
 380         PUSHs(sv_2mortal(newSViv(t->flags)));
 381 #endif
 382
 383 void
 384 self(classname)
 385         char *  classname
 386     PREINIT:
 387         SV *sv;
 388     PPCODE:
 389 #ifdef USE_THREADS
 390         sv = newSViv(thr->tid);
 391         sv_magic(sv, thr->oursv, '~', 0, 0);
 392         SvMAGIC(sv)->mg_private = Thread_MAGIC_SIGNATURE;
 393         PUSHs(sv_2mortal(sv_bless(newRV_noinc(sv),
 394                                   gv_stashpv(classname, TRUE))));
 395 #endif
 396
 397 U32
 398 tid(t)
 399         Thread  t
 400     CODE:
 401 #ifdef USE_THREADS
 402         MUTEX_LOCK(&t->mutex);
 403         RETVAL = t->tid;
 404         MUTEX_UNLOCK(&t->mutex);
 405 #else
 406         RETVAL = 0;
 407 #endif
 408     OUTPUT:
 409         RETVAL
 410
 411 void
 412 DESTROY(t)
 413         SV *    t
 414     PPCODE:
 415         PUSHs(&sv_yes);
 416
 417 void
 418 yield()
 419     CODE:
 420 {
 421 #ifdef USE_THREADS
 422         YIELD;
 423 #endif
 424 }
 425
 426 void
 427 cond_wait(sv)
 428         SV *    sv
 429         MAGIC * mg = NO_INIT
 430 CODE:
 431 #ifdef USE_THREADS
 432         if (SvROK(sv))
 433             sv = SvRV(sv);
 434
 435         mg = condpair_magic(sv);
 436         DEBUG_L(PerlIO_printf(PerlIO_stderr(), "%p: cond_wait %p\n", thr, sv));
 437         MUTEX_LOCK(MgMUTEXP(mg));
 438         if (MgOWNER(mg) != thr) {
 439             MUTEX_UNLOCK(MgMUTEXP(mg));
 440             croak("cond_wait for lock that we don't own\n");
 441         }
 442         MgOWNER(mg) = 0;
 443         COND_WAIT(MgCONDP(mg), MgMUTEXP(mg));
 444         while (MgOWNER(mg))
 445             COND_WAIT(MgOWNERCONDP(mg), MgMUTEXP(mg));
 446         MgOWNER(mg) = thr;
 447         MUTEX_UNLOCK(MgMUTEXP(mg));
 448 #endif
 449
 450 void
 451 cond_signal(sv)
 452         SV *    sv
 453         MAGIC * mg = NO_INIT
 454 CODE:
 455 #ifdef USE_THREADS
 456         if (SvROK(sv))
 457             sv = SvRV(sv);
 458
 459         mg = condpair_magic(sv);
 460         DEBUG_L(PerlIO_printf(PerlIO_stderr(), "%p: cond_signal %p\n",thr,sv));
 461         MUTEX_LOCK(MgMUTEXP(mg));
 462         if (MgOWNER(mg) != thr) {
 463             MUTEX_UNLOCK(MgMUTEXP(mg));
 464             croak("cond_signal for lock that we don't own\n");
 465         }
 466         COND_SIGNAL(MgCONDP(mg));
 467         MUTEX_UNLOCK(MgMUTEXP(mg));
 468 #endif
 469
 470 void
 471 cond_broadcast(sv)
 472         SV *    sv
 473         MAGIC * mg = NO_INIT
 474 CODE:
 475 #ifdef USE_THREADS
 476         if (SvROK(sv))
 477             sv = SvRV(sv);
 478
 479         mg = condpair_magic(sv);
 480         DEBUG_L(PerlIO_printf(PerlIO_stderr(), "%p: cond_broadcast %p\n",
 481                               thr, sv));
 482         MUTEX_LOCK(MgMUTEXP(mg));
 483         if (MgOWNER(mg) != thr) {
 484             MUTEX_UNLOCK(MgMUTEXP(mg));
 485             croak("cond_broadcast for lock that we don't own\n");
 486         }
 487         COND_BROADCAST(MgCONDP(mg));
 488         MUTEX_UNLOCK(MgMUTEXP(mg));
 489 #endif
 490
 491 void
 492 list(classname)
 493         char *  classname
 494     PREINIT:
 495         Thread  t;
 496         AV *    av;
 497         SV **   svp;
 498         int     n = 0;
 499     PPCODE:
 500 #ifdef USE_THREADS
 501         av = newAV();
 502         /*
 503          * Iterate until we have enough dynamic storage for all threads.
 504          * We mustn't do any allocation while holding threads_mutex though.
 505          */
 506         MUTEX_LOCK(&threads_mutex);
 507         do {
 508             n = nthreads;
 509             MUTEX_UNLOCK(&threads_mutex);
 510             if (AvFILL(av) < n - 1) {
 511                 int i = AvFILL(av);
 512                 for (i = AvFILL(av); i < n - 1; i++) {
 513                     SV *sv = newSViv(0);        /* fill in tid later */
 514                     sv_magic(sv, 0, '~', 0, 0); /* fill in other magic later */
 515                     av_push(av, sv_bless(newRV_noinc(sv),
 516                                          gv_stashpv(classname, TRUE)));
 517
 518                 }
 519             }
 520             MUTEX_LOCK(&threads_mutex);
 521         } while (n < nthreads);
 522         n = nthreads;   /* Get the final correct value */
 523
 524         /*
 525          * At this point, there's enough room to fill in av.
 526          * Note that we are holding threads_mutex so the list
 527          * won't change out from under us but all the remaining
 528          * processing is "fast" (no blocking, malloc etc.)
 529          */
 530         t = thr;
 531         svp = AvARRAY(av);
 532         do {
 533             SV *sv = (SV*)SvRV(*svp);
 534             sv_setiv(sv, t->tid);
 535             SvMAGIC(sv)->mg_obj = SvREFCNT_inc(t->oursv);
 536             SvMAGIC(sv)->mg_flags |= MGf_REFCOUNTED;
 537             SvMAGIC(sv)->mg_private = Thread_MAGIC_SIGNATURE;
 538             t = t->next;
 539             svp++;
 540         } while (t != thr);
 541         /*  */
 542         MUTEX_UNLOCK(&threads_mutex);
 543         /* Truncate any unneeded slots in av */
 544         av_fill(av, n - 1);
 545         /* Finally, push all the new objects onto the stack and drop av */
 546         EXTEND(sp, n);
 547         for (svp = AvARRAY(av); n > 0; n--, svp++)
 548             PUSHs(*svp);
 549         (void)sv_2mortal((SV*)av);
 550 #endif
 551
 552
 553 MODULE = Thread         PACKAGE = Thread::Signal
 554
 555 void
 556 kill_sighandler_thread()
 557     PPCODE:
 558         write(sig_pipe[0], "\0", 1);
 559         PUSHs(&sv_yes);
 560
 561 void
 562 init_thread_signals()
 563     PPCODE:
 564         sighandlerp = handle_thread_signal;
 565         if (pipe(sig_pipe) == -1)
 566             XSRETURN_UNDEF;
 567         PUSHs(&sv_yes);
 568
 569 SV *
 570 await_signal()
 571     PREINIT:
 572         char c;
 573         SSize_t ret;
 574     CODE:
 575         do {
 576             ret = read(sig_pipe[1], &c, 1);
 577         } while (ret == -1 && errno == EINTR);
 578         if (ret == -1)
 579             croak("panic: await_signal");
 580         if (ret == 0)
 581             XSRETURN_UNDEF;
 582         RETVAL = c ? psig_ptr[c] : &sv_no;
 583     OUTPUT:
 584         RETVAL
 585
 586 MODULE = Thread         PACKAGE = Thread::Specific
 587
 588 void
 589 data(classname = "Thread::Specific")
 590         char *  classname
 591     PPCODE:
 592 #ifdef USE_THREADS
 593         if (AvFILL(thr->specific) == -1) {
 594             GV *gv = gv_fetchpv("Thread::Specific::FIELDS", TRUE, SVt_PVHV);
 595             av_store(thr->specific, 0, newRV((SV*)GvHV(gv)));
 596         }
 597         XPUSHs(sv_bless(newRV((SV*)thr->specific),gv_stashpv(classname,TRUE)));
 598 #endif