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