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