This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Win32 branch now contains all non-ansification changes in ansiperl branch.
[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 *returnav;
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     dSP;
86     I32 oldmark = TOPMARK;
87     I32 oldscope = scopestack_ix;
88     I32 retval;
89     AV *returnav;
90     int i, ret;
91     dJMPENV;
92     DEBUG_L(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 thread, since we're
109      * 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_L(PerlIO_printf(PerlIO_stderr(), "new thread %p starting at %s\n",
115                           thr, SvPEEK(TOPs)));
116
117     JMPENV_PUSH(ret);
118     switch (ret) {
119     case 3:
120         PerlIO_printf(PerlIO_stderr(), "panic: threadstart\n");
121         /* fall through */
122     case 1:
123         STATUS_ALL_FAILURE;
124         /* fall through */
125     case 2:
126         /* my_exit() was called */
127         while (scopestack_ix > oldscope)
128             LEAVE;
129         JMPENV_POP;
130         av_store(returnav, 0, newSViv(statusvalue));
131         goto finishoff;
132     }
133
134     CATCH_SET(TRUE);
135
136     /* Now duplicate most of perl_call_sv but with a few twists */
137     op = (OP*)&myop;
138     Zero(op, 1, LOGOP);
139     myop.op_flags = OPf_STACKED;
140     myop.op_next = Nullop;
141     myop.op_flags |= OPf_KNOW;
142     myop.op_flags |= OPf_WANT_LIST;
143     op = pp_entersub(ARGS);
144     if (op)
145         runops();
146     SPAGAIN;
147     retval = sp - (stack_base + oldmark);
148     sp = stack_base + oldmark + 1;
149     DEBUG_L(for (i = 1; i <= retval; i++)
150                 PerlIO_printf(PerlIO_stderr(),
151                               "%p returnav[%d] = %s\n",
152                               thr, i, SvPEEK(sp[i - 1]));)
153     returnav = newAV();
154     av_store(returnav, 0, newSVpv("", 0));
155     for (i = 1; i <= retval; i++, sp++)
156         sv_setsv(*av_fetch(returnav, i, TRUE), SvREFCNT_inc(*sp));
157     
158   finishoff:
159 #if 0    
160     /* removed for debug */
161     SvREFCNT_dec(curstack);
162 #endif
163     SvREFCNT_dec(thr->cvcache);
164     SvREFCNT_dec(thr->magicals);
165     SvREFCNT_dec(thr->specific);
166     Safefree(markstack);
167     Safefree(scopestack);
168     Safefree(savestack);
169     Safefree(retstack);
170     Safefree(cxstack);
171     Safefree(tmps_stack);
172     Safefree(ofs);
173
174     MUTEX_LOCK(&thr->mutex);
175     DEBUG_L(PerlIO_printf(PerlIO_stderr(),
176                           "%p: threadstart finishing: state is %u\n",
177                           thr, ThrSTATE(thr)));
178     switch (ThrSTATE(thr)) {
179     case THRf_R_JOINABLE:
180         ThrSETSTATE(thr, THRf_ZOMBIE);
181         MUTEX_UNLOCK(&thr->mutex);
182         DEBUG_L(PerlIO_printf(PerlIO_stderr(),
183                               "%p: R_JOINABLE thread finished\n", thr));
184         break;
185     case THRf_R_JOINED:
186         ThrSETSTATE(thr, THRf_DEAD);
187         MUTEX_UNLOCK(&thr->mutex);
188         remove_thread(thr);
189         DEBUG_L(PerlIO_printf(PerlIO_stderr(),
190                               "%p: R_JOINED thread finished\n", thr));
191         break;
192     case THRf_R_DETACHED:
193         ThrSETSTATE(thr, THRf_DEAD);
194         MUTEX_UNLOCK(&thr->mutex);
195         SvREFCNT_dec(returnav);
196         DEBUG_L(PerlIO_printf(PerlIO_stderr(),
197                               "%p: DETACHED thread finished\n", thr));
198         remove_thread(thr);     /* This might trigger main thread to finish */
199         break;
200     default:
201         MUTEX_UNLOCK(&thr->mutex);
202         croak("panic: illegal state %u at end of threadstart", ThrSTATE(thr));
203         /* NOTREACHED */
204     }
205     return THREAD_RET_CAST(returnav);   /* Available for anyone to join with */
206                                         /* us unless we're detached, in which */
207                                         /* case noone sees the value anyway. */
208 #endif    
209 #else
210     return THREAD_RET_CAST(NULL);
211 #endif
212 }
213
214 static SV *
215 newthread (SV *startsv, AV *initargs, char *Class)
216 {
217     dTHR;
218 #ifdef USE_THREADS
219     dSP;
220     Thread savethread;
221     int i;
222     SV *sv;
223     int err;
224 #ifndef THREAD_CREATE
225     sigset_t fullmask, oldmask;
226 #endif
227     
228     savethread = thr;
229     thr = new_struct_thread(thr);
230     SPAGAIN;
231     DEBUG_L(PerlIO_printf(PerlIO_stderr(),
232                           "%p: newthread (%p), tid is %u, preparing stack\n",
233                           savethread, thr, thr->tid));
234     /* The following pushes the arg list and startsv onto the *new* stack */
235     PUSHMARK(sp);
236     /* Could easily speed up the following greatly */
237     for (i = 0; i <= AvFILL(initargs); i++)
238         XPUSHs(SvREFCNT_inc(*av_fetch(initargs, i, FALSE)));
239     XPUSHs(SvREFCNT_inc(startsv));
240     PUTBACK;
241 #ifdef THREAD_CREATE
242     err = THREAD_CREATE(thr, threadstart);
243 #else    
244     /* On your marks... */
245     MUTEX_LOCK(&thr->mutex);
246     /* Get set...  */
247     sigfillset(&fullmask);
248     if (sigprocmask(SIG_SETMASK, &fullmask, &oldmask) == -1)
249         croak("panic: sigprocmask");
250     err = pthread_create(&thr->self, pthread_attr_default,
251                          threadstart, (void*) thr);
252     /* Go */
253     MUTEX_UNLOCK(&thr->mutex);
254 #endif
255     if (err) {
256         DEBUG_L(PerlIO_printf(PerlIO_stderr(),
257                           "%p: create of %p failed %d\n", savethread, thr, err));
258         /* Thread creation failed--clean up */
259         SvREFCNT_dec(thr->cvcache);
260         remove_thread(thr);
261         MUTEX_DESTROY(&thr->mutex);
262         for (i = 0; i <= AvFILL(initargs); i++)
263             SvREFCNT_dec(*av_fetch(initargs, i, FALSE));
264         SvREFCNT_dec(startsv);
265         return NULL;
266     }
267 #ifdef THREAD_POST_CREATE
268     THREAD_POST_CREATE(thr);
269 #else
270     if (sigprocmask(SIG_SETMASK, &oldmask, 0))
271         croak("panic: sigprocmask");
272 #endif
273     sv = newSViv(thr->tid);
274     sv_magic(sv, thr->oursv, '~', 0, 0);
275     SvMAGIC(sv)->mg_private = Thread_MAGIC_SIGNATURE;
276     return sv_bless(newRV_noinc(sv), gv_stashpv(Class, TRUE));
277 #else
278     croak("No threads in this perl");
279     return &sv_undef;
280 #endif
281 }
282
283 static Signal_t handle_thread_signal _((int sig));
284
285 static Signal_t
286 handle_thread_signal(int sig)
287 {
288     char c = (char) sig;
289     write(sig_pipe[0], &c, 1);
290 }
291
292 MODULE = Thread         PACKAGE = Thread
293 PROTOTYPES: DISABLE
294
295 void
296 new(Class, startsv, ...)
297         char *          Class
298         SV *            startsv
299         AV *            av = av_make(items - 2, &ST(2));
300     PPCODE:
301         XPUSHs(sv_2mortal(newthread(startsv, av, Class)));
302
303 void
304 join(t)
305         Thread  t
306         AV *    av = NO_INIT
307         int     i = NO_INIT
308     PPCODE:
309 #ifdef USE_THREADS
310         DEBUG_L(PerlIO_printf(PerlIO_stderr(), "%p: joining %p (state %u)\n",
311                               thr, t, ThrSTATE(t)););
312         MUTEX_LOCK(&t->mutex);
313         switch (ThrSTATE(t)) {
314         case THRf_R_JOINABLE:
315         case THRf_R_JOINED:
316             ThrSETSTATE(t, THRf_R_JOINED);
317             MUTEX_UNLOCK(&t->mutex);
318             break;
319         case THRf_ZOMBIE:
320             ThrSETSTATE(t, THRf_DEAD);
321             MUTEX_UNLOCK(&t->mutex);
322             remove_thread(t);
323             break;
324         default:
325             MUTEX_UNLOCK(&t->mutex);
326             croak("can't join with thread");
327             /* NOTREACHED */
328         }
329         JOIN(t, &av);
330
331         /* Could easily speed up the following if necessary */
332         for (i = 0; i <= AvFILL(av); i++)
333             XPUSHs(sv_2mortal(*av_fetch(av, i, FALSE)));
334 #endif
335
336 void
337 detach(t)
338         Thread  t
339     CODE:
340 #ifdef USE_THREADS
341         DEBUG_L(PerlIO_printf(PerlIO_stderr(), "%p: detaching %p (state %u)\n",
342                               thr, t, ThrSTATE(t)););
343         MUTEX_LOCK(&t->mutex);
344         switch (ThrSTATE(t)) {
345         case THRf_R_JOINABLE:
346             ThrSETSTATE(t, THRf_R_DETACHED);
347             /* fall through */
348         case THRf_R_DETACHED:
349             DETACH(t);
350             MUTEX_UNLOCK(&t->mutex);
351             break;
352         case THRf_ZOMBIE:
353             ThrSETSTATE(t, THRf_DEAD);
354             DETACH(t);
355             MUTEX_UNLOCK(&t->mutex);
356             remove_thread(t);
357             break;
358         default:
359             MUTEX_UNLOCK(&t->mutex);
360             croak("can't detach thread");
361             /* NOTREACHED */
362         }
363 #endif
364
365 void
366 equal(t1, t2)
367         Thread  t1
368         Thread  t2
369     PPCODE:
370         PUSHs((t1 == t2) ? &sv_yes : &sv_no);
371
372 void
373 flags(t)
374         Thread  t
375     PPCODE:
376 #ifdef USE_THREADS
377         PUSHs(sv_2mortal(newSViv(t->flags)));
378 #endif
379
380 void
381 self(Class)
382         char *  Class
383     PREINIT:
384         SV *sv;
385     PPCODE:        
386 #ifdef USE_THREADS
387         sv = newSViv(thr->tid);
388         sv_magic(sv, thr->oursv, '~', 0, 0);
389         SvMAGIC(sv)->mg_private = Thread_MAGIC_SIGNATURE;
390         PUSHs(sv_2mortal(sv_bless(newRV_noinc(sv), gv_stashpv(Class, TRUE))));
391 #endif
392
393 U32
394 tid(t)
395         Thread  t
396     CODE:
397 #ifdef USE_THREADS
398         MUTEX_LOCK(&t->mutex);
399         RETVAL = t->tid;
400         MUTEX_UNLOCK(&t->mutex);
401 #else 
402         RETVAL = 0;
403 #endif
404     OUTPUT:
405         RETVAL
406
407 void
408 DESTROY(t)
409         SV *    t
410     PPCODE:
411         PUSHs(&sv_yes);
412
413 void
414 yield()
415     CODE:
416 {
417 #ifdef USE_THREADS
418         YIELD;
419 #endif
420 }
421
422 void
423 cond_wait(sv)
424         SV *    sv
425         MAGIC * mg = NO_INIT
426 CODE:                       
427 #ifdef USE_THREADS
428         if (SvROK(sv))
429             sv = SvRV(sv);
430
431         mg = condpair_magic(sv);
432         DEBUG_L(PerlIO_printf(PerlIO_stderr(), "%p: cond_wait %p\n", thr, sv));
433         MUTEX_LOCK(MgMUTEXP(mg));
434         if (MgOWNER(mg) != thr) {
435             MUTEX_UNLOCK(MgMUTEXP(mg));
436             croak("cond_wait for lock that we don't own\n");
437         }
438         MgOWNER(mg) = 0;
439         COND_WAIT(MgCONDP(mg), MgMUTEXP(mg));
440         while (MgOWNER(mg))
441             COND_WAIT(MgOWNERCONDP(mg), MgMUTEXP(mg));
442         MgOWNER(mg) = thr;
443         MUTEX_UNLOCK(MgMUTEXP(mg));
444 #endif
445
446 void
447 cond_signal(sv)
448         SV *    sv
449         MAGIC * mg = NO_INIT
450 CODE:
451 #ifdef USE_THREADS
452         if (SvROK(sv))
453             sv = SvRV(sv);
454
455         mg = condpair_magic(sv);
456         DEBUG_L(PerlIO_printf(PerlIO_stderr(), "%p: cond_signal %p\n",thr,sv));
457         MUTEX_LOCK(MgMUTEXP(mg));
458         if (MgOWNER(mg) != thr) {
459             MUTEX_UNLOCK(MgMUTEXP(mg));
460             croak("cond_signal for lock that we don't own\n");
461         }
462         COND_SIGNAL(MgCONDP(mg));
463         MUTEX_UNLOCK(MgMUTEXP(mg));
464 #endif
465
466 void
467 cond_broadcast(sv)
468         SV *    sv
469         MAGIC * mg = NO_INIT
470 CODE: 
471 #ifdef USE_THREADS
472         if (SvROK(sv))
473             sv = SvRV(sv);
474
475         mg = condpair_magic(sv);
476         DEBUG_L(PerlIO_printf(PerlIO_stderr(), "%p: cond_broadcast %p\n",
477                               thr, sv));
478         MUTEX_LOCK(MgMUTEXP(mg));
479         if (MgOWNER(mg) != thr) {
480             MUTEX_UNLOCK(MgMUTEXP(mg));
481             croak("cond_broadcast for lock that we don't own\n");
482         }
483         COND_BROADCAST(MgCONDP(mg));
484         MUTEX_UNLOCK(MgMUTEXP(mg));
485 #endif
486
487 void
488 list(Class)
489         char *  Class
490     PREINIT:
491         Thread  t;
492         AV *    av;
493         SV **   svp;
494         int     n = 0;
495     PPCODE:
496 #ifdef USE_THREADS
497         av = newAV();
498         /*
499          * Iterate until we have enough dynamic storage for all threads.
500          * We mustn't do any allocation while holding threads_mutex though.
501          */
502         MUTEX_LOCK(&threads_mutex);
503         do {
504             n = nthreads;
505             MUTEX_UNLOCK(&threads_mutex);
506             if (AvFILL(av) < n - 1) {
507                 int i = AvFILL(av);
508                 for (i = AvFILL(av); i < n - 1; i++) {
509                     SV *sv = newSViv(0);        /* fill in tid later */
510                     sv_magic(sv, 0, '~', 0, 0); /* fill in other magic later */
511                     av_push(av, sv_bless(newRV_noinc(sv),
512                                          gv_stashpv(Class, TRUE)));
513         
514                 }
515             }
516             MUTEX_LOCK(&threads_mutex);
517         } while (n < nthreads);
518         n = nthreads;   /* Get the final correct value */
519
520         /*
521          * At this point, there's enough room to fill in av.
522          * Note that we are holding threads_mutex so the list
523          * won't change out from under us but all the remaining
524          * processing is "fast" (no blocking, malloc etc.)
525          */
526         t = thr;
527         svp = AvARRAY(av);
528         do {
529             SV *sv = (SV*)SvRV(*svp);
530             sv_setiv(sv, t->tid);
531             SvMAGIC(sv)->mg_obj = SvREFCNT_inc(t->oursv);
532             SvMAGIC(sv)->mg_flags |= MGf_REFCOUNTED;
533             SvMAGIC(sv)->mg_private = Thread_MAGIC_SIGNATURE;
534             t = t->next;
535             svp++;
536         } while (t != thr);
537         /*  */
538         MUTEX_UNLOCK(&threads_mutex);
539         /* Truncate any unneeded slots in av */
540         av_fill(av, n - 1);
541         /* Finally, push all the new objects onto the stack and drop av */
542         EXTEND(sp, n);
543         for (svp = AvARRAY(av); n > 0; n--, svp++)
544             PUSHs(*svp);
545         (void)sv_2mortal((SV*)av);
546 #endif
547
548
549 MODULE = Thread         PACKAGE = Thread::Signal
550
551 void
552 kill_sighandler_thread()
553     PPCODE:
554         write(sig_pipe[0], "\0", 1);
555         PUSHs(&sv_yes);
556
557 void
558 init_thread_signals()
559     PPCODE:
560         sighandlerp = handle_thread_signal;
561         if (pipe(sig_pipe) == -1)
562             XSRETURN_UNDEF;
563         PUSHs(&sv_yes);
564
565 SV *
566 await_signal()
567     PREINIT:
568         char c;
569         SSize_t ret;
570     CODE:
571         do {
572             ret = read(sig_pipe[1], &c, 1);
573         } while (ret == -1 && errno == EINTR);
574         if (ret == -1)
575             croak("panic: await_signal");
576         if (ret == 0)
577             XSRETURN_UNDEF;
578         RETVAL = c ? psig_ptr[c] : &sv_no;
579     OUTPUT:
580         RETVAL
581