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