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