ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro/State.xs
Revision: 1.219
Committed: Tue Dec 4 19:33:45 2007 UTC (16 years, 5 months ago) by root
Branch: MAIN
CVS Tags: rel-4_3, rel-4_31, rel-4_32, rel-4_33, rel-4_34
Changes since 1.218: +5 -0 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 #include "libcoro/coro.c"
2
3 #define PERL_NO_GET_CONTEXT
4 #define PERL_EXT
5
6 #include "EXTERN.h"
7 #include "perl.h"
8 #include "XSUB.h"
9
10 #include "patchlevel.h"
11
12 #include <stdio.h>
13 #include <errno.h>
14 #include <assert.h>
15 #include <inttypes.h> /* portable stdint.h */
16
17 #ifdef HAVE_MMAP
18 # include <unistd.h>
19 # include <sys/mman.h>
20 # ifndef MAP_ANONYMOUS
21 # ifdef MAP_ANON
22 # define MAP_ANONYMOUS MAP_ANON
23 # else
24 # undef HAVE_MMAP
25 # endif
26 # endif
27 # include <limits.h>
28 # ifndef PAGESIZE
29 # define PAGESIZE pagesize
30 # define BOOT_PAGESIZE pagesize = sysconf (_SC_PAGESIZE)
31 static long pagesize;
32 # else
33 # define BOOT_PAGESIZE (void)0
34 # endif
35 #else
36 # define PAGESIZE 0
37 # define BOOT_PAGESIZE (void)0
38 #endif
39
40 #if CORO_USE_VALGRIND
41 # include <valgrind/valgrind.h>
42 # define REGISTER_STACK(cctx,start,end) (cctx)->valgrind_id = VALGRIND_STACK_REGISTER ((start), (end))
43 #else
44 # define REGISTER_STACK(cctx,start,end)
45 #endif
46
47 /* the maximum number of idle cctx that will be pooled */
48 #define MAX_IDLE_CCTX 8
49
50 #define PERL_VERSION_ATLEAST(a,b,c) \
51 (PERL_REVISION > (a) \
52 || (PERL_REVISION == (a) \
53 && (PERL_VERSION > (b) \
54 || (PERL_VERSION == (b) && PERLSUBVERSION >= (c)))))
55
56 #if !PERL_VERSION_ATLEAST (5,6,0)
57 # ifndef PL_ppaddr
58 # define PL_ppaddr ppaddr
59 # endif
60 # ifndef call_sv
61 # define call_sv perl_call_sv
62 # endif
63 # ifndef get_sv
64 # define get_sv perl_get_sv
65 # endif
66 # ifndef get_cv
67 # define get_cv perl_get_cv
68 # endif
69 # ifndef IS_PADGV
70 # define IS_PADGV(v) 0
71 # endif
72 # ifndef IS_PADCONST
73 # define IS_PADCONST(v) 0
74 # endif
75 #endif
76
77 /* 5.8.7 */
78 #ifndef SvRV_set
79 # define SvRV_set(s,v) SvRV(s) = (v)
80 #endif
81
82 /* 5.8.8 */
83 #ifndef GV_NOTQUAL
84 # define GV_NOTQUAL 0
85 #endif
86 #ifndef newSV
87 # define newSV(l) NEWSV(0,l)
88 #endif
89
90 #if !__i386 && !__x86_64 && !__powerpc && !__m68k && !__alpha && !__mips && !__sparc64
91 # undef CORO_STACKGUARD
92 #endif
93
94 #ifndef CORO_STACKGUARD
95 # define CORO_STACKGUARD 0
96 #endif
97
98 /* prefer perl internal functions over our own? */
99 #ifndef CORO_PREFER_PERL_FUNCTIONS
100 # define CORO_PREFER_PERL_FUNCTIONS 0
101 #endif
102
103 /* The next macros try to return the current stack pointer, in an as
104 * portable way as possible. */
105 #define dSTACKLEVEL volatile char stacklevel
106 #define STACKLEVEL ((void *)&stacklevel)
107
108 #define IN_DESTRUCT (PL_main_cv == Nullcv)
109
110 #if __GNUC__ >= 3
111 # define attribute(x) __attribute__(x)
112 # define BARRIER __asm__ __volatile__ ("" : : : "memory")
113 # define expect(expr,value) __builtin_expect ((expr),(value))
114 #else
115 # define attribute(x)
116 # define BARRIER
117 # define expect(expr,value) (expr)
118 #endif
119
120 #define expect_false(expr) expect ((expr) != 0, 0)
121 #define expect_true(expr) expect ((expr) != 0, 1)
122
123 #define NOINLINE attribute ((noinline))
124
125 #include "CoroAPI.h"
126
127 #ifdef USE_ITHREADS
128 static perl_mutex coro_mutex;
129 # define LOCK do { MUTEX_LOCK (&coro_mutex); } while (0)
130 # define UNLOCK do { MUTEX_UNLOCK (&coro_mutex); } while (0)
131 #else
132 # define LOCK (void)0
133 # define UNLOCK (void)0
134 #endif
135
136 /* helper storage struct for Coro::AIO */
137 struct io_state
138 {
139 int errorno;
140 I32 laststype;
141 int laststatval;
142 Stat_t statcache;
143 };
144
145 static size_t coro_stacksize = CORO_STACKSIZE;
146 static struct CoroAPI coroapi;
147 static AV *main_mainstack; /* used to differentiate between $main and others */
148 static JMPENV *main_top_env;
149 static HV *coro_state_stash, *coro_stash;
150 static volatile SV *coro_mortal; /* will be freed after next transfer */
151
152 static GV *irsgv; /* $/ */
153 static GV *stdoutgv; /* *STDOUT */
154 static SV *rv_diehook;
155 static SV *rv_warnhook;
156 static HV *hv_sig; /* %SIG */
157
158 /* async_pool helper stuff */
159 static SV *sv_pool_rss;
160 static SV *sv_pool_size;
161 static AV *av_async_pool;
162
163 static struct coro_cctx *cctx_first;
164 static int cctx_count, cctx_idle;
165
166 enum {
167 CC_MAPPED = 0x01,
168 CC_NOREUSE = 0x02, /* throw this away after tracing */
169 CC_TRACE = 0x04,
170 CC_TRACE_SUB = 0x08, /* trace sub calls */
171 CC_TRACE_LINE = 0x10, /* trace each statement */
172 CC_TRACE_ALL = CC_TRACE_SUB | CC_TRACE_LINE,
173 };
174
175 /* this is a structure representing a c-level coroutine */
176 typedef struct coro_cctx {
177 struct coro_cctx *next;
178
179 /* the stack */
180 void *sptr;
181 size_t ssize;
182
183 /* cpu state */
184 void *idle_sp; /* sp of top-level transfer/schedule/cede call */
185 JMPENV *idle_te; /* same as idle_sp, but for top_env, TODO: remove once stable */
186 JMPENV *top_env;
187 coro_context cctx;
188
189 #if CORO_USE_VALGRIND
190 int valgrind_id;
191 #endif
192 unsigned char flags;
193 } coro_cctx;
194
195 enum {
196 CF_RUNNING = 0x0001, /* coroutine is running */
197 CF_READY = 0x0002, /* coroutine is ready */
198 CF_NEW = 0x0004, /* has never been switched to */
199 CF_DESTROYED = 0x0008, /* coroutine data has been freed */
200 };
201
202 /* the structure where most of the perl state is stored, overlaid on the cxstack */
203 typedef struct {
204 SV *defsv;
205 AV *defav;
206 SV *errsv;
207 SV *irsgv;
208 #define VAR(name,type) type name;
209 # include "state.h"
210 #undef VAR
211 } perl_slots;
212
213 #define SLOT_COUNT ((sizeof (perl_slots) + sizeof (PERL_CONTEXT) - 1) / sizeof (PERL_CONTEXT))
214
215 /* this is a structure representing a perl-level coroutine */
216 struct coro {
217 /* the c coroutine allocated to this perl coroutine, if any */
218 coro_cctx *cctx;
219
220 /* process data */
221 AV *mainstack;
222 perl_slots *slot; /* basically the saved sp */
223
224 AV *args; /* data associated with this coroutine (initial args) */
225 int refcnt; /* coroutines are refcounted, yes */
226 int flags; /* CF_ flags */
227 HV *hv; /* the perl hash associated with this coro, if any */
228
229 /* statistics */
230 int usecount; /* number of transfers to this coro */
231
232 /* coro process data */
233 int prio;
234 SV *throw; /* exception to be thrown */
235
236 /* async_pool */
237 SV *saved_deffh;
238
239 /* linked list */
240 struct coro *next, *prev;
241 };
242
243 typedef struct coro *Coro__State;
244 typedef struct coro *Coro__State_or_hashref;
245
246 /** Coro ********************************************************************/
247
248 #define PRIO_MAX 3
249 #define PRIO_HIGH 1
250 #define PRIO_NORMAL 0
251 #define PRIO_LOW -1
252 #define PRIO_IDLE -3
253 #define PRIO_MIN -4
254
255 /* for Coro.pm */
256 static SV *coro_current;
257 static AV *coro_ready [PRIO_MAX-PRIO_MIN+1];
258 static int coro_nready;
259 static struct coro *coro_first;
260
261 /** lowlevel stuff **********************************************************/
262
263 static SV *
264 coro_get_sv (pTHX_ const char *name, int create)
265 {
266 #if PERL_VERSION_ATLEAST (5,9,0)
267 /* silence stupid and wrong 5.10 warning that I am unable to switch off */
268 get_sv (name, create);
269 #endif
270 return get_sv (name, create);
271 }
272
273 static AV *
274 coro_get_av (pTHX_ const char *name, int create)
275 {
276 #if PERL_VERSION_ATLEAST (5,9,0)
277 /* silence stupid and wrong 5.10 warning that I am unable to switch off */
278 get_av (name, create);
279 #endif
280 return get_av (name, create);
281 }
282
283 static HV *
284 coro_get_hv (pTHX_ const char *name, int create)
285 {
286 #if PERL_VERSION_ATLEAST (5,9,0)
287 /* silence stupid and wrong 5.10 warning that I am unable to switch off */
288 get_hv (name, create);
289 #endif
290 return get_hv (name, create);
291 }
292
293 static AV *
294 coro_clone_padlist (pTHX_ CV *cv)
295 {
296 AV *padlist = CvPADLIST (cv);
297 AV *newpadlist, *newpad;
298
299 newpadlist = newAV ();
300 AvREAL_off (newpadlist);
301 #if PERL_VERSION_ATLEAST (5,9,0)
302 Perl_pad_push (aTHX_ padlist, AvFILLp (padlist) + 1);
303 #else
304 Perl_pad_push (aTHX_ padlist, AvFILLp (padlist) + 1, 1);
305 #endif
306 newpad = (AV *)AvARRAY (padlist)[AvFILLp (padlist)];
307 --AvFILLp (padlist);
308
309 av_store (newpadlist, 0, SvREFCNT_inc (*av_fetch (padlist, 0, FALSE)));
310 av_store (newpadlist, 1, (SV *)newpad);
311
312 return newpadlist;
313 }
314
315 static void
316 free_padlist (pTHX_ AV *padlist)
317 {
318 /* may be during global destruction */
319 if (SvREFCNT (padlist))
320 {
321 I32 i = AvFILLp (padlist);
322 while (i >= 0)
323 {
324 SV **svp = av_fetch (padlist, i--, FALSE);
325 if (svp)
326 {
327 SV *sv;
328 while (&PL_sv_undef != (sv = av_pop ((AV *)*svp)))
329 SvREFCNT_dec (sv);
330
331 SvREFCNT_dec (*svp);
332 }
333 }
334
335 SvREFCNT_dec ((SV*)padlist);
336 }
337 }
338
339 static int
340 coro_cv_free (pTHX_ SV *sv, MAGIC *mg)
341 {
342 AV *padlist;
343 AV *av = (AV *)mg->mg_obj;
344
345 /* casting is fun. */
346 while (&PL_sv_undef != (SV *)(padlist = (AV *)av_pop (av)))
347 free_padlist (aTHX_ padlist);
348
349 return 0;
350 }
351
352 #define CORO_MAGIC_type_cv PERL_MAGIC_ext
353 #define CORO_MAGIC_type_state PERL_MAGIC_ext
354
355 static MGVTBL coro_cv_vtbl = {
356 0, 0, 0, 0,
357 coro_cv_free
358 };
359
360 #define CORO_MAGIC(sv,type) \
361 SvMAGIC (sv) \
362 ? SvMAGIC (sv)->mg_type == type \
363 ? SvMAGIC (sv) \
364 : mg_find (sv, type) \
365 : 0
366
367 #define CORO_MAGIC_cv(cv) CORO_MAGIC (((SV *)(cv)), CORO_MAGIC_type_cv)
368 #define CORO_MAGIC_state(sv) CORO_MAGIC (((SV *)(sv)), CORO_MAGIC_type_state)
369
370 static struct coro *
371 SvSTATE_ (pTHX_ SV *coro)
372 {
373 HV *stash;
374 MAGIC *mg;
375
376 if (SvROK (coro))
377 coro = SvRV (coro);
378
379 if (expect_false (SvTYPE (coro) != SVt_PVHV))
380 croak ("Coro::State object required");
381
382 stash = SvSTASH (coro);
383 if (expect_false (stash != coro_stash && stash != coro_state_stash))
384 {
385 /* very slow, but rare, check */
386 if (!sv_derived_from (sv_2mortal (newRV_inc (coro)), "Coro::State"))
387 croak ("Coro::State object required");
388 }
389
390 mg = CORO_MAGIC_state (coro);
391 return (struct coro *)mg->mg_ptr;
392 }
393
394 #define SvSTATE(sv) SvSTATE_ (aTHX_ (sv))
395
396 /* the next two functions merely cache the padlists */
397 static void
398 get_padlist (pTHX_ CV *cv)
399 {
400 MAGIC *mg = CORO_MAGIC_cv (cv);
401 AV *av;
402
403 if (expect_true (mg && AvFILLp ((av = (AV *)mg->mg_obj)) >= 0))
404 CvPADLIST (cv) = (AV *)AvARRAY (av)[AvFILLp (av)--];
405 else
406 {
407 #if CORO_PREFER_PERL_FUNCTIONS
408 /* this is probably cleaner, but also slower? */
409 CV *cp = Perl_cv_clone (cv);
410 CvPADLIST (cv) = CvPADLIST (cp);
411 CvPADLIST (cp) = 0;
412 SvREFCNT_dec (cp);
413 #else
414 CvPADLIST (cv) = coro_clone_padlist (aTHX_ cv);
415 #endif
416 }
417 }
418
419 static void
420 put_padlist (pTHX_ CV *cv)
421 {
422 MAGIC *mg = CORO_MAGIC_cv (cv);
423 AV *av;
424
425 if (expect_false (!mg))
426 mg = sv_magicext ((SV *)cv, (SV *)newAV (), CORO_MAGIC_type_cv, &coro_cv_vtbl, 0, 0);
427
428 av = (AV *)mg->mg_obj;
429
430 if (expect_false (AvFILLp (av) >= AvMAX (av)))
431 av_extend (av, AvMAX (av) + 1);
432
433 AvARRAY (av)[++AvFILLp (av)] = (SV *)CvPADLIST (cv);
434 }
435
436 /** load & save, init *******************************************************/
437
438 static void
439 load_perl (pTHX_ Coro__State c)
440 {
441 perl_slots *slot = c->slot;
442 c->slot = 0;
443
444 PL_mainstack = c->mainstack;
445
446 GvSV (PL_defgv) = slot->defsv;
447 GvAV (PL_defgv) = slot->defav;
448 GvSV (PL_errgv) = slot->errsv;
449 GvSV (irsgv) = slot->irsgv;
450
451 #define VAR(name,type) PL_ ## name = slot->name;
452 # include "state.h"
453 #undef VAR
454
455 {
456 dSP;
457
458 CV *cv;
459
460 /* now do the ugly restore mess */
461 while (expect_true (cv = (CV *)POPs))
462 {
463 put_padlist (aTHX_ cv); /* mark this padlist as available */
464 CvDEPTH (cv) = PTR2IV (POPs);
465 CvPADLIST (cv) = (AV *)POPs;
466 }
467
468 PUTBACK;
469 }
470 }
471
472 static void
473 save_perl (pTHX_ Coro__State c)
474 {
475 {
476 dSP;
477 I32 cxix = cxstack_ix;
478 PERL_CONTEXT *ccstk = cxstack;
479 PERL_SI *top_si = PL_curstackinfo;
480
481 /*
482 * the worst thing you can imagine happens first - we have to save
483 * (and reinitialize) all cv's in the whole callchain :(
484 */
485
486 XPUSHs (Nullsv);
487 /* this loop was inspired by pp_caller */
488 for (;;)
489 {
490 while (expect_true (cxix >= 0))
491 {
492 PERL_CONTEXT *cx = &ccstk[cxix--];
493
494 if (expect_true (CxTYPE (cx) == CXt_SUB || CxTYPE (cx) == CXt_FORMAT))
495 {
496 CV *cv = cx->blk_sub.cv;
497
498 if (expect_true (CvDEPTH (cv)))
499 {
500 EXTEND (SP, 3);
501 PUSHs ((SV *)CvPADLIST (cv));
502 PUSHs (INT2PTR (SV *, CvDEPTH (cv)));
503 PUSHs ((SV *)cv);
504
505 CvDEPTH (cv) = 0;
506 get_padlist (aTHX_ cv);
507 }
508 }
509 }
510
511 if (expect_true (top_si->si_type == PERLSI_MAIN))
512 break;
513
514 top_si = top_si->si_prev;
515 ccstk = top_si->si_cxstack;
516 cxix = top_si->si_cxix;
517 }
518
519 PUTBACK;
520 }
521
522 /* allocate some space on the context stack for our purposes */
523 /* we manually unroll here, as usually 2 slots is enough */
524 if (SLOT_COUNT >= 1) CXINC;
525 if (SLOT_COUNT >= 2) CXINC;
526 if (SLOT_COUNT >= 3) CXINC;
527 {
528 int i;
529 for (i = 3; i < SLOT_COUNT; ++i)
530 CXINC;
531 }
532 cxstack_ix -= SLOT_COUNT; /* undo allocation */
533
534 c->mainstack = PL_mainstack;
535
536 {
537 perl_slots *slot = c->slot = (perl_slots *)(cxstack + cxstack_ix + 1);
538
539 slot->defav = GvAV (PL_defgv);
540 slot->defsv = DEFSV;
541 slot->errsv = ERRSV;
542 slot->irsgv = GvSV (irsgv);
543
544 #define VAR(name,type) slot->name = PL_ ## name;
545 # include "state.h"
546 #undef VAR
547 }
548 }
549
550 /*
551 * allocate various perl stacks. This is an exact copy
552 * of perl.c:init_stacks, except that it uses less memory
553 * on the (sometimes correct) assumption that coroutines do
554 * not usually need a lot of stackspace.
555 */
556 #if CORO_PREFER_PERL_FUNCTIONS
557 # define coro_init_stacks init_stacks
558 #else
559 static void
560 coro_init_stacks (pTHX)
561 {
562 PL_curstackinfo = new_stackinfo(32, 8);
563 PL_curstackinfo->si_type = PERLSI_MAIN;
564 PL_curstack = PL_curstackinfo->si_stack;
565 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
566
567 PL_stack_base = AvARRAY(PL_curstack);
568 PL_stack_sp = PL_stack_base;
569 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
570
571 New(50,PL_tmps_stack,32,SV*);
572 PL_tmps_floor = -1;
573 PL_tmps_ix = -1;
574 PL_tmps_max = 32;
575
576 New(54,PL_markstack,16,I32);
577 PL_markstack_ptr = PL_markstack;
578 PL_markstack_max = PL_markstack + 16;
579
580 #ifdef SET_MARK_OFFSET
581 SET_MARK_OFFSET;
582 #endif
583
584 New(54,PL_scopestack,8,I32);
585 PL_scopestack_ix = 0;
586 PL_scopestack_max = 8;
587
588 New(54,PL_savestack,24,ANY);
589 PL_savestack_ix = 0;
590 PL_savestack_max = 24;
591
592 #if !PERL_VERSION_ATLEAST (5,9,0)
593 New(54,PL_retstack,4,OP*);
594 PL_retstack_ix = 0;
595 PL_retstack_max = 4;
596 #endif
597 }
598 #endif
599
600 /*
601 * destroy the stacks, the callchain etc...
602 */
603 static void
604 coro_destroy_stacks (pTHX)
605 {
606 while (PL_curstackinfo->si_next)
607 PL_curstackinfo = PL_curstackinfo->si_next;
608
609 while (PL_curstackinfo)
610 {
611 PERL_SI *p = PL_curstackinfo->si_prev;
612
613 if (!IN_DESTRUCT)
614 SvREFCNT_dec (PL_curstackinfo->si_stack);
615
616 Safefree (PL_curstackinfo->si_cxstack);
617 Safefree (PL_curstackinfo);
618 PL_curstackinfo = p;
619 }
620
621 Safefree (PL_tmps_stack);
622 Safefree (PL_markstack);
623 Safefree (PL_scopestack);
624 Safefree (PL_savestack);
625 #if !PERL_VERSION_ATLEAST (5,9,0)
626 Safefree (PL_retstack);
627 #endif
628 }
629
630 static size_t
631 coro_rss (pTHX_ struct coro *coro)
632 {
633 size_t rss = sizeof (*coro);
634
635 if (coro->mainstack)
636 {
637 perl_slots tmp_slot;
638 perl_slots *slot;
639
640 if (coro->flags & CF_RUNNING)
641 {
642 slot = &tmp_slot;
643
644 #define VAR(name,type) slot->name = PL_ ## name;
645 # include "state.h"
646 #undef VAR
647 }
648 else
649 slot = coro->slot;
650
651 rss += sizeof (slot->curstackinfo);
652 rss += (slot->curstackinfo->si_cxmax + 1) * sizeof (PERL_CONTEXT);
653 rss += sizeof (SV) + sizeof (struct xpvav) + (1 + AvMAX (slot->curstack)) * sizeof (SV *);
654 rss += slot->tmps_max * sizeof (SV *);
655 rss += (slot->markstack_max - slot->markstack_ptr) * sizeof (I32);
656 rss += slot->scopestack_max * sizeof (I32);
657 rss += slot->savestack_max * sizeof (ANY);
658
659 #if !PERL_VERSION_ATLEAST (5,9,0)
660 rss += slot->retstack_max * sizeof (OP *);
661 #endif
662 }
663
664 return rss;
665 }
666
667 /** coroutine stack handling ************************************************/
668
669 #if 0
670 static int (*orig_sigelem_get) (pTHX_ SV *sv, MAGIC *mg);
671
672 /*
673 * This overrides the default magic get method of %SIG elements.
674 * The original one doesn't provide for reading back of PL_diehook/PL_warnhook
675 * and instead of tryign to save and restore the hash elements, we just provide
676 * readback here.
677 * We only do this when the hook is != 0, as they are often set to 0 temporarily,
678 * not expecting this to actually change the hook. This is a potential problem
679 * when a schedule happens then, but we ignore this.
680 */
681 static int
682 coro_sigelem_get (pTHX_ SV *sv, MAGIC *mg)
683 {
684 return orig_sigelem_get (aTHX_ sv, mg);
685 const char *s = MgPV_nolen_const (mg);
686
687 if (*s == '_')
688 {
689 if (strEQ (s, "__DIE__" ) && PL_diehook ) return sv_setsv (sv, PL_diehook ), 0;
690 if (strEQ (s, "__WARN__") && PL_warnhook) return sv_setsv (sv, PL_warnhook), 0;
691 }
692
693 return orig_sigelem_get (aTHX_ sv, mg);
694 }
695 #endif
696
697 static void
698 coro_setup (pTHX_ struct coro *coro)
699 {
700 /*
701 * emulate part of the perl startup here.
702 */
703 coro_init_stacks (aTHX);
704
705 PL_runops = RUNOPS_DEFAULT;
706 PL_curcop = &PL_compiling;
707 PL_in_eval = EVAL_NULL;
708 PL_comppad = 0;
709 PL_curpm = 0;
710 PL_curpad = 0;
711 PL_localizing = 0;
712 PL_dirty = 0;
713 PL_restartop = 0;
714
715 /* recreate the die/warn hooks */
716 PL_diehook = 0;
717 hv_store (hv_sig, "__DIE__", sizeof ("__DIE__") - 1, newSV (0), 0);
718 PL_diehook = SvREFCNT_inc (rv_diehook);
719
720 PL_warnhook = 0;
721 hv_store (hv_sig, "__WARN__", sizeof ("__WARN__") - 1, newSV (0), 0);
722 PL_warnhook = SvREFCNT_inc (rv_warnhook);
723
724 GvSV (PL_defgv) = newSV (0);
725 GvAV (PL_defgv) = coro->args; coro->args = 0;
726 GvSV (PL_errgv) = newSV (0);
727 GvSV (irsgv) = newSVpvn ("\n", 1); sv_magic (GvSV (irsgv), (SV *)irsgv, PERL_MAGIC_sv, "/", 0);
728 PL_rs = newSVsv (GvSV (irsgv));
729 PL_defoutgv = (GV *)SvREFCNT_inc (stdoutgv);
730
731 {
732 dSP;
733 LOGOP myop;
734
735 Zero (&myop, 1, LOGOP);
736 myop.op_next = Nullop;
737 myop.op_flags = OPf_WANT_VOID;
738
739 PUSHMARK (SP);
740 XPUSHs (sv_2mortal (av_shift (GvAV (PL_defgv))));
741 PUTBACK;
742 PL_op = (OP *)&myop;
743 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX);
744 SPAGAIN;
745 }
746
747 /* this newly created coroutine might be run on an existing cctx which most
748 * likely was suspended in set_stacklevel, called from entersub.
749 * set_stacklevl doesn't do anything on return, but entersub does LEAVE,
750 * so we ENTER here for symmetry
751 */
752 ENTER;
753 }
754
755 static void
756 coro_destroy (pTHX_ struct coro *coro)
757 {
758 if (!IN_DESTRUCT)
759 {
760 /* restore all saved variables and stuff */
761 LEAVE_SCOPE (0);
762 assert (PL_tmps_floor == -1);
763
764 /* free all temporaries */
765 FREETMPS;
766 assert (PL_tmps_ix == -1);
767
768 /* unwind all extra stacks */
769 POPSTACK_TO (PL_mainstack);
770
771 /* unwind main stack */
772 dounwind (-1);
773 }
774
775 SvREFCNT_dec (GvSV (PL_defgv));
776 SvREFCNT_dec (GvAV (PL_defgv));
777 SvREFCNT_dec (GvSV (PL_errgv));
778 SvREFCNT_dec (PL_defoutgv);
779 SvREFCNT_dec (PL_rs);
780 SvREFCNT_dec (GvSV (irsgv));
781
782 SvREFCNT_dec (PL_diehook);
783 SvREFCNT_dec (PL_warnhook);
784
785 SvREFCNT_dec (coro->saved_deffh);
786 SvREFCNT_dec (coro->throw);
787
788 coro_destroy_stacks (aTHX);
789 }
790
791 static void
792 free_coro_mortal (pTHX)
793 {
794 if (expect_true (coro_mortal))
795 {
796 SvREFCNT_dec (coro_mortal);
797 coro_mortal = 0;
798 }
799 }
800
801 static int
802 runops_trace (pTHX)
803 {
804 COP *oldcop = 0;
805 int oldcxix = -2;
806 struct coro *coro = SvSTATE (coro_current); /* trace cctx is tied to specific coro */
807 coro_cctx *cctx = coro->cctx;
808
809 while ((PL_op = CALL_FPTR (PL_op->op_ppaddr) (aTHX)))
810 {
811 PERL_ASYNC_CHECK ();
812
813 if (cctx->flags & CC_TRACE_ALL)
814 {
815 if (PL_op->op_type == OP_LEAVESUB && cctx->flags & CC_TRACE_SUB)
816 {
817 PERL_CONTEXT *cx = &cxstack[cxstack_ix];
818 SV **bot, **top;
819 AV *av = newAV (); /* return values */
820 SV **cb;
821 dSP;
822
823 GV *gv = CvGV (cx->blk_sub.cv);
824 SV *fullname = sv_2mortal (newSV (0));
825 if (isGV (gv))
826 gv_efullname3 (fullname, gv, 0);
827
828 bot = PL_stack_base + cx->blk_oldsp + 1;
829 top = cx->blk_gimme == G_ARRAY ? SP + 1
830 : cx->blk_gimme == G_SCALAR ? bot + 1
831 : bot;
832
833 av_extend (av, top - bot);
834 while (bot < top)
835 av_push (av, SvREFCNT_inc (*bot++));
836
837 PL_runops = RUNOPS_DEFAULT;
838 ENTER;
839 SAVETMPS;
840 EXTEND (SP, 3);
841 PUSHMARK (SP);
842 PUSHs (&PL_sv_no);
843 PUSHs (fullname);
844 PUSHs (sv_2mortal (newRV_noinc ((SV *)av)));
845 PUTBACK;
846 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_sub_cb", sizeof ("_trace_sub_cb") - 1, 0);
847 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
848 SPAGAIN;
849 FREETMPS;
850 LEAVE;
851 PL_runops = runops_trace;
852 }
853
854 if (oldcop != PL_curcop)
855 {
856 oldcop = PL_curcop;
857
858 if (PL_curcop != &PL_compiling)
859 {
860 SV **cb;
861
862 if (oldcxix != cxstack_ix && cctx->flags & CC_TRACE_SUB)
863 {
864 PERL_CONTEXT *cx = &cxstack[cxstack_ix];
865
866 if (CxTYPE (cx) == CXt_SUB && oldcxix < cxstack_ix)
867 {
868 runops_proc_t old_runops = PL_runops;
869 dSP;
870 GV *gv = CvGV (cx->blk_sub.cv);
871 SV *fullname = sv_2mortal (newSV (0));
872
873 if (isGV (gv))
874 gv_efullname3 (fullname, gv, 0);
875
876 PL_runops = RUNOPS_DEFAULT;
877 ENTER;
878 SAVETMPS;
879 EXTEND (SP, 3);
880 PUSHMARK (SP);
881 PUSHs (&PL_sv_yes);
882 PUSHs (fullname);
883 PUSHs (cx->blk_sub.hasargs ? sv_2mortal (newRV_inc ((SV *)cx->blk_sub.argarray)) : &PL_sv_undef);
884 PUTBACK;
885 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_sub_cb", sizeof ("_trace_sub_cb") - 1, 0);
886 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
887 SPAGAIN;
888 FREETMPS;
889 LEAVE;
890 PL_runops = runops_trace;
891 }
892
893 oldcxix = cxstack_ix;
894 }
895
896 if (cctx->flags & CC_TRACE_LINE)
897 {
898 dSP;
899
900 PL_runops = RUNOPS_DEFAULT;
901 ENTER;
902 SAVETMPS;
903 EXTEND (SP, 3);
904 PL_runops = RUNOPS_DEFAULT;
905 PUSHMARK (SP);
906 PUSHs (sv_2mortal (newSVpv (OutCopFILE (oldcop), 0)));
907 PUSHs (sv_2mortal (newSViv (CopLINE (oldcop))));
908 PUTBACK;
909 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_line_cb", sizeof ("_trace_line_cb") - 1, 0);
910 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
911 SPAGAIN;
912 FREETMPS;
913 LEAVE;
914 PL_runops = runops_trace;
915 }
916 }
917 }
918 }
919 }
920
921 TAINT_NOT;
922 return 0;
923 }
924
925 /* inject a fake call to Coro::State::_cctx_init into the execution */
926 /* _cctx_init should be careful, as it could be called at almost any time */
927 /* during execution of a perl program */
928 static void NOINLINE
929 cctx_prepare (pTHX_ coro_cctx *cctx)
930 {
931 dSP;
932 LOGOP myop;
933
934 PL_top_env = &PL_start_env;
935
936 if (cctx->flags & CC_TRACE)
937 PL_runops = runops_trace;
938
939 Zero (&myop, 1, LOGOP);
940 myop.op_next = PL_op;
941 myop.op_flags = OPf_WANT_VOID | OPf_STACKED;
942
943 PUSHMARK (SP);
944 EXTEND (SP, 2);
945 PUSHs (sv_2mortal (newSViv (PTR2IV (cctx))));
946 PUSHs ((SV *)get_cv ("Coro::State::_cctx_init", FALSE));
947 PUTBACK;
948 PL_op = (OP *)&myop;
949 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX);
950 SPAGAIN;
951 }
952
953 /*
954 * this is a _very_ stripped down perl interpreter ;)
955 */
956 static void
957 cctx_run (void *arg)
958 {
959 dTHX;
960
961 /* cctx_run is the alternative tail of transfer(), so unlock here. */
962 UNLOCK;
963
964 /* we now skip the entersub that lead to transfer() */
965 PL_op = PL_op->op_next;
966
967 /* inject a fake subroutine call to cctx_init */
968 cctx_prepare (aTHX_ (coro_cctx *)arg);
969
970 /* somebody or something will hit me for both perl_run and PL_restartop */
971 PL_restartop = PL_op;
972 perl_run (PL_curinterp);
973
974 /*
975 * If perl-run returns we assume exit() was being called or the coro
976 * fell off the end, which seems to be the only valid (non-bug)
977 * reason for perl_run to return. We try to exit by jumping to the
978 * bootstrap-time "top" top_env, as we cannot restore the "main"
979 * coroutine as Coro has no such concept
980 */
981 PL_top_env = main_top_env;
982 JMPENV_JUMP (2); /* I do not feel well about the hardcoded 2 at all */
983 }
984
985 static coro_cctx *
986 cctx_new ()
987 {
988 coro_cctx *cctx;
989 void *stack_start;
990 size_t stack_size;
991
992 ++cctx_count;
993
994 Newz (0, cctx, 1, coro_cctx);
995
996 #if HAVE_MMAP
997 cctx->ssize = ((coro_stacksize * sizeof (long) + PAGESIZE - 1) / PAGESIZE + CORO_STACKGUARD) * PAGESIZE;
998 /* mmap supposedly does allocate-on-write for us */
999 cctx->sptr = mmap (0, cctx->ssize, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, 0, 0);
1000
1001 if (cctx->sptr != (void *)-1)
1002 {
1003 # if CORO_STACKGUARD
1004 mprotect (cctx->sptr, CORO_STACKGUARD * PAGESIZE, PROT_NONE);
1005 # endif
1006 stack_start = CORO_STACKGUARD * PAGESIZE + (char *)cctx->sptr;
1007 stack_size = cctx->ssize - CORO_STACKGUARD * PAGESIZE;
1008 cctx->flags |= CC_MAPPED;
1009 }
1010 else
1011 #endif
1012 {
1013 cctx->ssize = coro_stacksize * (long)sizeof (long);
1014 New (0, cctx->sptr, coro_stacksize, long);
1015
1016 if (!cctx->sptr)
1017 {
1018 perror ("FATAL: unable to allocate stack for coroutine");
1019 _exit (EXIT_FAILURE);
1020 }
1021
1022 stack_start = cctx->sptr;
1023 stack_size = cctx->ssize;
1024 }
1025
1026 REGISTER_STACK (cctx, (char *)stack_start, (char *)stack_start + stack_size);
1027 coro_create (&cctx->cctx, cctx_run, (void *)cctx, stack_start, stack_size);
1028
1029 return cctx;
1030 }
1031
1032 static void
1033 cctx_destroy (coro_cctx *cctx)
1034 {
1035 if (!cctx)
1036 return;
1037
1038 --cctx_count;
1039
1040 #if CORO_USE_VALGRIND
1041 VALGRIND_STACK_DEREGISTER (cctx->valgrind_id);
1042 #endif
1043
1044 #if HAVE_MMAP
1045 if (cctx->flags & CC_MAPPED)
1046 munmap (cctx->sptr, cctx->ssize);
1047 else
1048 #endif
1049 Safefree (cctx->sptr);
1050
1051 Safefree (cctx);
1052 }
1053
1054 /* wether this cctx should be destructed */
1055 #define CCTX_EXPIRED(cctx) ((cctx)->ssize < coro_stacksize || ((cctx)->flags & CC_NOREUSE))
1056
1057 static coro_cctx *
1058 cctx_get (pTHX)
1059 {
1060 while (expect_true (cctx_first))
1061 {
1062 coro_cctx *cctx = cctx_first;
1063 cctx_first = cctx->next;
1064 --cctx_idle;
1065
1066 if (expect_true (!CCTX_EXPIRED (cctx)))
1067 return cctx;
1068
1069 cctx_destroy (cctx);
1070 }
1071
1072 return cctx_new ();
1073 }
1074
1075 static void
1076 cctx_put (coro_cctx *cctx)
1077 {
1078 /* free another cctx if overlimit */
1079 if (expect_false (cctx_idle >= MAX_IDLE_CCTX))
1080 {
1081 coro_cctx *first = cctx_first;
1082 cctx_first = first->next;
1083 --cctx_idle;
1084
1085 cctx_destroy (first);
1086 }
1087
1088 ++cctx_idle;
1089 cctx->next = cctx_first;
1090 cctx_first = cctx;
1091 }
1092
1093 /** coroutine switching *****************************************************/
1094
1095 static void
1096 transfer_check (pTHX_ struct coro *prev, struct coro *next)
1097 {
1098 if (expect_true (prev != next))
1099 {
1100 if (expect_false (!(prev->flags & (CF_RUNNING | CF_NEW))))
1101 croak ("Coro::State::transfer called with non-running/new prev Coro::State, but can only transfer from running or new states");
1102
1103 if (expect_false (next->flags & CF_RUNNING))
1104 croak ("Coro::State::transfer called with running next Coro::State, but can only transfer to inactive states");
1105
1106 if (expect_false (next->flags & CF_DESTROYED))
1107 croak ("Coro::State::transfer called with destroyed next Coro::State, but can only transfer to inactive states");
1108
1109 if (
1110 #if PERL_VERSION_ATLEAST (5,9,0)
1111 expect_false (PL_parser)
1112 #else
1113 expect_false (PL_lex_state != LEX_NOTPARSING)
1114 #endif
1115 )
1116 croak ("Coro::State::transfer called while parsing, but this is not supported");
1117 }
1118 }
1119
1120 /* always use the TRANSFER macro */
1121 static void NOINLINE
1122 transfer (pTHX_ struct coro *prev, struct coro *next)
1123 {
1124 dSTACKLEVEL;
1125 static volatile int has_throw;
1126
1127 /* sometimes transfer is only called to set idle_sp */
1128 if (expect_false (!next))
1129 {
1130 ((coro_cctx *)prev)->idle_sp = STACKLEVEL;
1131 assert (((coro_cctx *)prev)->idle_te = PL_top_env); /* just for the side-effect when asserts are enabled */
1132 }
1133 else if (expect_true (prev != next))
1134 {
1135 coro_cctx *prev__cctx;
1136
1137 if (expect_false (prev->flags & CF_NEW))
1138 {
1139 /* create a new empty context */
1140 Newz (0, prev->cctx, 1, coro_cctx);
1141 prev->flags &= ~CF_NEW;
1142 prev->flags |= CF_RUNNING;
1143 }
1144
1145 prev->flags &= ~CF_RUNNING;
1146 next->flags |= CF_RUNNING;
1147
1148 LOCK;
1149
1150 /* first get rid of the old state */
1151 save_perl (aTHX_ prev);
1152
1153 if (expect_false (next->flags & CF_NEW))
1154 {
1155 /* need to start coroutine */
1156 next->flags &= ~CF_NEW;
1157 /* setup coroutine call */
1158 coro_setup (aTHX_ next);
1159 }
1160 else
1161 load_perl (aTHX_ next);
1162
1163 prev__cctx = prev->cctx;
1164
1165 /* possibly "free" the cctx */
1166 if (expect_true (prev__cctx->idle_sp == STACKLEVEL && !(prev__cctx->flags & CC_TRACE)))
1167 {
1168 /* I assume that STACKLEVEL is a stronger indicator than PL_top_env changes */
1169 assert (("ERROR: current top_env must equal previous top_env", PL_top_env == prev__cctx->idle_te));
1170
1171 prev->cctx = 0;
1172
1173 /* if the cctx is about to be destroyed we need to make sure we won't see it in cctx_get */
1174 /* without this the next cctx_get might destroy the prev__cctx while still in use */
1175 if (expect_false (CCTX_EXPIRED (prev__cctx)))
1176 if (!next->cctx)
1177 next->cctx = cctx_get (aTHX);
1178
1179 cctx_put (prev__cctx);
1180 }
1181
1182 ++next->usecount;
1183
1184 if (expect_true (!next->cctx))
1185 next->cctx = cctx_get (aTHX);
1186
1187 has_throw = !!next->throw;
1188
1189 if (expect_false (prev__cctx != next->cctx))
1190 {
1191 prev__cctx->top_env = PL_top_env;
1192 PL_top_env = next->cctx->top_env;
1193 coro_transfer (&prev__cctx->cctx, &next->cctx->cctx);
1194 }
1195
1196 free_coro_mortal (aTHX);
1197 UNLOCK;
1198
1199 if (expect_false (has_throw))
1200 {
1201 struct coro *coro = SvSTATE (coro_current);
1202
1203 if (coro->throw)
1204 {
1205 SV *exception = coro->throw;
1206 coro->throw = 0;
1207 sv_setsv (ERRSV, exception);
1208 croak (0);
1209 }
1210 }
1211 }
1212 }
1213
1214 struct transfer_args
1215 {
1216 struct coro *prev, *next;
1217 };
1218
1219 #define TRANSFER(ta) transfer (aTHX_ (ta).prev, (ta).next)
1220 #define TRANSFER_CHECK(ta) transfer_check (aTHX_ (ta).prev, (ta).next)
1221
1222 /** high level stuff ********************************************************/
1223
1224 static int
1225 coro_state_destroy (pTHX_ struct coro *coro)
1226 {
1227 if (coro->flags & CF_DESTROYED)
1228 return 0;
1229
1230 coro->flags |= CF_DESTROYED;
1231
1232 if (coro->flags & CF_READY)
1233 {
1234 /* reduce nready, as destroying a ready coro effectively unreadies it */
1235 /* alternative: look through all ready queues and remove the coro */
1236 LOCK;
1237 --coro_nready;
1238 UNLOCK;
1239 }
1240 else
1241 coro->flags |= CF_READY; /* make sure it is NOT put into the readyqueue */
1242
1243 if (coro->mainstack && coro->mainstack != main_mainstack)
1244 {
1245 struct coro temp;
1246
1247 if (coro->flags & CF_RUNNING)
1248 croak ("FATAL: tried to destroy currently running coroutine");
1249
1250 save_perl (aTHX_ &temp);
1251 load_perl (aTHX_ coro);
1252
1253 coro_destroy (aTHX_ coro);
1254
1255 load_perl (aTHX_ &temp);
1256
1257 coro->slot = 0;
1258 }
1259
1260 cctx_destroy (coro->cctx);
1261 SvREFCNT_dec (coro->args);
1262
1263 if (coro->next) coro->next->prev = coro->prev;
1264 if (coro->prev) coro->prev->next = coro->next;
1265 if (coro == coro_first) coro_first = coro->next;
1266
1267 return 1;
1268 }
1269
1270 static int
1271 coro_state_free (pTHX_ SV *sv, MAGIC *mg)
1272 {
1273 struct coro *coro = (struct coro *)mg->mg_ptr;
1274 mg->mg_ptr = 0;
1275
1276 coro->hv = 0;
1277
1278 if (--coro->refcnt < 0)
1279 {
1280 coro_state_destroy (aTHX_ coro);
1281 Safefree (coro);
1282 }
1283
1284 return 0;
1285 }
1286
1287 static int
1288 coro_state_dup (pTHX_ MAGIC *mg, CLONE_PARAMS *params)
1289 {
1290 struct coro *coro = (struct coro *)mg->mg_ptr;
1291
1292 ++coro->refcnt;
1293
1294 return 0;
1295 }
1296
1297 static MGVTBL coro_state_vtbl = {
1298 0, 0, 0, 0,
1299 coro_state_free,
1300 0,
1301 #ifdef MGf_DUP
1302 coro_state_dup,
1303 #else
1304 # define MGf_DUP 0
1305 #endif
1306 };
1307
1308 static void
1309 prepare_transfer (pTHX_ struct transfer_args *ta, SV *prev_sv, SV *next_sv)
1310 {
1311 ta->prev = SvSTATE (prev_sv);
1312 ta->next = SvSTATE (next_sv);
1313 TRANSFER_CHECK (*ta);
1314 }
1315
1316 static void
1317 api_transfer (SV *prev_sv, SV *next_sv)
1318 {
1319 dTHX;
1320 struct transfer_args ta;
1321
1322 prepare_transfer (aTHX_ &ta, prev_sv, next_sv);
1323 TRANSFER (ta);
1324 }
1325
1326 /** Coro ********************************************************************/
1327
1328 static void
1329 coro_enq (pTHX_ SV *coro_sv)
1330 {
1331 av_push (coro_ready [SvSTATE (coro_sv)->prio - PRIO_MIN], coro_sv);
1332 }
1333
1334 static SV *
1335 coro_deq (pTHX)
1336 {
1337 int prio;
1338
1339 for (prio = PRIO_MAX - PRIO_MIN + 1; --prio >= 0; )
1340 if (AvFILLp (coro_ready [prio]) >= 0)
1341 return av_shift (coro_ready [prio]);
1342
1343 return 0;
1344 }
1345
1346 static int
1347 api_ready (SV *coro_sv)
1348 {
1349 dTHX;
1350 struct coro *coro;
1351
1352 if (SvROK (coro_sv))
1353 coro_sv = SvRV (coro_sv);
1354
1355 coro = SvSTATE (coro_sv);
1356
1357 if (coro->flags & CF_READY)
1358 return 0;
1359
1360 coro->flags |= CF_READY;
1361
1362 LOCK;
1363 coro_enq (aTHX_ SvREFCNT_inc (coro_sv));
1364 ++coro_nready;
1365 UNLOCK;
1366
1367 return 1;
1368 }
1369
1370 static int
1371 api_is_ready (SV *coro_sv)
1372 {
1373 dTHX;
1374 return !!(SvSTATE (coro_sv)->flags & CF_READY);
1375 }
1376
1377 static void
1378 prepare_schedule (pTHX_ struct transfer_args *ta)
1379 {
1380 SV *prev_sv, *next_sv;
1381
1382 for (;;)
1383 {
1384 LOCK;
1385 next_sv = coro_deq (aTHX);
1386
1387 /* nothing to schedule: call the idle handler */
1388 if (expect_false (!next_sv))
1389 {
1390 dSP;
1391 UNLOCK;
1392
1393 ENTER;
1394 SAVETMPS;
1395
1396 PUSHMARK (SP);
1397 PUTBACK;
1398 call_sv (get_sv ("Coro::idle", FALSE), G_DISCARD);
1399 SPAGAIN;
1400
1401 FREETMPS;
1402 LEAVE;
1403 continue;
1404 }
1405
1406 ta->next = SvSTATE (next_sv);
1407
1408 /* cannot transfer to destroyed coros, skip and look for next */
1409 if (expect_false (ta->next->flags & CF_DESTROYED))
1410 {
1411 UNLOCK;
1412 SvREFCNT_dec (next_sv);
1413 /* coro_nready is already taken care of by destroy */
1414 continue;
1415 }
1416
1417 --coro_nready;
1418 UNLOCK;
1419 break;
1420 }
1421
1422 /* free this only after the transfer */
1423 prev_sv = SvRV (coro_current);
1424 ta->prev = SvSTATE (prev_sv);
1425 TRANSFER_CHECK (*ta);
1426 assert (ta->next->flags & CF_READY);
1427 ta->next->flags &= ~CF_READY;
1428 SvRV_set (coro_current, next_sv);
1429
1430 LOCK;
1431 free_coro_mortal (aTHX);
1432 coro_mortal = prev_sv;
1433 UNLOCK;
1434 }
1435
1436 static void
1437 prepare_cede (pTHX_ struct transfer_args *ta)
1438 {
1439 api_ready (coro_current);
1440 prepare_schedule (aTHX_ ta);
1441 }
1442
1443 static int
1444 prepare_cede_notself (pTHX_ struct transfer_args *ta)
1445 {
1446 if (coro_nready)
1447 {
1448 SV *prev = SvRV (coro_current);
1449 prepare_schedule (aTHX_ ta);
1450 api_ready (prev);
1451 return 1;
1452 }
1453 else
1454 return 0;
1455 }
1456
1457 static void
1458 api_schedule (void)
1459 {
1460 dTHX;
1461 struct transfer_args ta;
1462
1463 prepare_schedule (aTHX_ &ta);
1464 TRANSFER (ta);
1465 }
1466
1467 static int
1468 api_cede (void)
1469 {
1470 dTHX;
1471 struct transfer_args ta;
1472
1473 prepare_cede (aTHX_ &ta);
1474
1475 if (expect_true (ta.prev != ta.next))
1476 {
1477 TRANSFER (ta);
1478 return 1;
1479 }
1480 else
1481 return 0;
1482 }
1483
1484 static int
1485 api_cede_notself (void)
1486 {
1487 dTHX;
1488 struct transfer_args ta;
1489
1490 if (prepare_cede_notself (aTHX_ &ta))
1491 {
1492 TRANSFER (ta);
1493 return 1;
1494 }
1495 else
1496 return 0;
1497 }
1498
1499 static void
1500 api_trace (SV *coro_sv, int flags)
1501 {
1502 dTHX;
1503 struct coro *coro = SvSTATE (coro_sv);
1504
1505 if (flags & CC_TRACE)
1506 {
1507 if (!coro->cctx)
1508 coro->cctx = cctx_new ();
1509 else if (!(coro->cctx->flags & CC_TRACE))
1510 croak ("cannot enable tracing on coroutine with custom stack");
1511
1512 coro->cctx->flags |= CC_NOREUSE | (flags & (CC_TRACE | CC_TRACE_ALL));
1513 }
1514 else if (coro->cctx && coro->cctx->flags & CC_TRACE)
1515 {
1516 coro->cctx->flags &= ~(CC_TRACE | CC_TRACE_ALL);
1517
1518 if (coro->flags & CF_RUNNING)
1519 PL_runops = RUNOPS_DEFAULT;
1520 else
1521 coro->slot->runops = RUNOPS_DEFAULT;
1522 }
1523 }
1524
1525 MODULE = Coro::State PACKAGE = Coro::State PREFIX = api_
1526
1527 PROTOTYPES: DISABLE
1528
1529 BOOT:
1530 {
1531 #ifdef USE_ITHREADS
1532 MUTEX_INIT (&coro_mutex);
1533 #endif
1534 BOOT_PAGESIZE;
1535
1536 irsgv = gv_fetchpv ("/" , GV_ADD|GV_NOTQUAL, SVt_PV);
1537 stdoutgv = gv_fetchpv ("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
1538 #if 0
1539 orig_sigelem_get = PL_vtbl_sigelem.svt_get;
1540 PL_vtbl_sigelem.svt_get = coro_sigelem_get;
1541 #endif
1542 hv_sig = coro_get_hv (aTHX_ "SIG", TRUE);
1543 rv_diehook = SvREFCNT_inc ((SV *)gv_fetchpv ("Coro::State::diehook" , 0, SVt_PVCV));
1544 rv_warnhook = SvREFCNT_inc ((SV *)gv_fetchpv ("Coro::State::warnhook", 0, SVt_PVCV));
1545
1546 coro_state_stash = gv_stashpv ("Coro::State", TRUE);
1547
1548 newCONSTSUB (coro_state_stash, "CC_TRACE" , newSViv (CC_TRACE));
1549 newCONSTSUB (coro_state_stash, "CC_TRACE_SUB" , newSViv (CC_TRACE_SUB));
1550 newCONSTSUB (coro_state_stash, "CC_TRACE_LINE", newSViv (CC_TRACE_LINE));
1551 newCONSTSUB (coro_state_stash, "CC_TRACE_ALL" , newSViv (CC_TRACE_ALL));
1552
1553 main_mainstack = PL_mainstack;
1554 main_top_env = PL_top_env;
1555
1556 while (main_top_env->je_prev)
1557 main_top_env = main_top_env->je_prev;
1558
1559 coroapi.ver = CORO_API_VERSION;
1560 coroapi.rev = CORO_API_REVISION;
1561 coroapi.transfer = api_transfer;
1562
1563 assert (("PRIO_NORMAL must be 0", !PRIO_NORMAL));
1564 }
1565
1566 SV *
1567 new (char *klass, ...)
1568 CODE:
1569 {
1570 struct coro *coro;
1571 MAGIC *mg;
1572 HV *hv;
1573 int i;
1574
1575 Newz (0, coro, 1, struct coro);
1576 coro->args = newAV ();
1577 coro->flags = CF_NEW;
1578
1579 if (coro_first) coro_first->prev = coro;
1580 coro->next = coro_first;
1581 coro_first = coro;
1582
1583 coro->hv = hv = newHV ();
1584 mg = sv_magicext ((SV *)hv, 0, CORO_MAGIC_type_state, &coro_state_vtbl, (char *)coro, 0);
1585 mg->mg_flags |= MGf_DUP;
1586 RETVAL = sv_bless (newRV_noinc ((SV *)hv), gv_stashpv (klass, 1));
1587
1588 av_extend (coro->args, items - 1);
1589 for (i = 1; i < items; i++)
1590 av_push (coro->args, newSVsv (ST (i)));
1591 }
1592 OUTPUT:
1593 RETVAL
1594
1595 # these not obviously related functions are all rolled into the same xs
1596 # function to increase chances that they all will call transfer with the same
1597 # stack offset
1598 void
1599 _set_stacklevel (...)
1600 ALIAS:
1601 Coro::State::transfer = 1
1602 Coro::schedule = 2
1603 Coro::cede = 3
1604 Coro::cede_notself = 4
1605 CODE:
1606 {
1607 struct transfer_args ta;
1608
1609 PUTBACK;
1610 switch (ix)
1611 {
1612 case 0:
1613 ta.prev = (struct coro *)INT2PTR (coro_cctx *, SvIV (ST (0)));
1614 ta.next = 0;
1615 break;
1616
1617 case 1:
1618 if (items != 2)
1619 croak ("Coro::State::transfer (prev,next) expects two arguments, not %d", items);
1620
1621 prepare_transfer (aTHX_ &ta, ST (0), ST (1));
1622 break;
1623
1624 case 2:
1625 prepare_schedule (aTHX_ &ta);
1626 break;
1627
1628 case 3:
1629 prepare_cede (aTHX_ &ta);
1630 break;
1631
1632 case 4:
1633 if (!prepare_cede_notself (aTHX_ &ta))
1634 XSRETURN_EMPTY;
1635
1636 break;
1637 }
1638 SPAGAIN;
1639
1640 BARRIER;
1641 PUTBACK;
1642 TRANSFER (ta);
1643 SPAGAIN; /* might be the sp of a different coroutine now */
1644 /* be extra careful not to ever do anything after TRANSFER */
1645 }
1646
1647 bool
1648 _destroy (SV *coro_sv)
1649 CODE:
1650 RETVAL = coro_state_destroy (aTHX_ SvSTATE (coro_sv));
1651 OUTPUT:
1652 RETVAL
1653
1654 void
1655 _exit (code)
1656 int code
1657 PROTOTYPE: $
1658 CODE:
1659 _exit (code);
1660
1661 int
1662 cctx_stacksize (int new_stacksize = 0)
1663 CODE:
1664 RETVAL = coro_stacksize;
1665 if (new_stacksize)
1666 coro_stacksize = new_stacksize;
1667 OUTPUT:
1668 RETVAL
1669
1670 int
1671 cctx_count ()
1672 CODE:
1673 RETVAL = cctx_count;
1674 OUTPUT:
1675 RETVAL
1676
1677 int
1678 cctx_idle ()
1679 CODE:
1680 RETVAL = cctx_idle;
1681 OUTPUT:
1682 RETVAL
1683
1684 void
1685 list ()
1686 PPCODE:
1687 {
1688 struct coro *coro;
1689 for (coro = coro_first; coro; coro = coro->next)
1690 if (coro->hv)
1691 XPUSHs (sv_2mortal (newRV_inc ((SV *)coro->hv)));
1692 }
1693
1694 void
1695 call (Coro::State coro, SV *coderef)
1696 ALIAS:
1697 eval = 1
1698 CODE:
1699 {
1700 if (coro->mainstack)
1701 {
1702 struct coro temp;
1703
1704 if (!(coro->flags & CF_RUNNING))
1705 {
1706 PUTBACK;
1707 save_perl (aTHX_ &temp);
1708 load_perl (aTHX_ coro);
1709 }
1710
1711 {
1712 dSP;
1713 ENTER;
1714 SAVETMPS;
1715 PUTBACK;
1716 PUSHSTACK;
1717 PUSHMARK (SP);
1718
1719 if (ix)
1720 eval_sv (coderef, 0);
1721 else
1722 call_sv (coderef, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
1723
1724 POPSTACK;
1725 SPAGAIN;
1726 FREETMPS;
1727 LEAVE;
1728 PUTBACK;
1729 }
1730
1731 if (!(coro->flags & CF_RUNNING))
1732 {
1733 save_perl (aTHX_ coro);
1734 load_perl (aTHX_ &temp);
1735 SPAGAIN;
1736 }
1737 }
1738 }
1739
1740 SV *
1741 is_ready (Coro::State coro)
1742 PROTOTYPE: $
1743 ALIAS:
1744 is_ready = CF_READY
1745 is_running = CF_RUNNING
1746 is_new = CF_NEW
1747 is_destroyed = CF_DESTROYED
1748 CODE:
1749 RETVAL = boolSV (coro->flags & ix);
1750 OUTPUT:
1751 RETVAL
1752
1753 void
1754 api_trace (SV *coro, int flags = CC_TRACE | CC_TRACE_SUB)
1755
1756 SV *
1757 has_stack (Coro::State coro)
1758 PROTOTYPE: $
1759 CODE:
1760 RETVAL = boolSV (!!coro->cctx);
1761 OUTPUT:
1762 RETVAL
1763
1764 int
1765 is_traced (Coro::State coro)
1766 PROTOTYPE: $
1767 CODE:
1768 RETVAL = (coro->cctx ? coro->cctx->flags : 0) & CC_TRACE_ALL;
1769 OUTPUT:
1770 RETVAL
1771
1772 IV
1773 rss (Coro::State coro)
1774 PROTOTYPE: $
1775 ALIAS:
1776 usecount = 1
1777 CODE:
1778 switch (ix)
1779 {
1780 case 0: RETVAL = coro_rss (aTHX_ coro); break;
1781 case 1: RETVAL = coro->usecount; break;
1782 }
1783 OUTPUT:
1784 RETVAL
1785
1786
1787 MODULE = Coro::State PACKAGE = Coro
1788
1789 BOOT:
1790 {
1791 int i;
1792
1793 sv_pool_rss = coro_get_sv (aTHX_ "Coro::POOL_RSS" , TRUE);
1794 sv_pool_size = coro_get_sv (aTHX_ "Coro::POOL_SIZE" , TRUE);
1795 av_async_pool = coro_get_av (aTHX_ "Coro::async_pool", TRUE);
1796
1797 coro_current = coro_get_sv (aTHX_ "Coro::current", FALSE);
1798 SvREADONLY_on (coro_current);
1799
1800 coro_stash = gv_stashpv ("Coro", TRUE);
1801
1802 newCONSTSUB (coro_stash, "PRIO_MAX", newSViv (PRIO_MAX));
1803 newCONSTSUB (coro_stash, "PRIO_HIGH", newSViv (PRIO_HIGH));
1804 newCONSTSUB (coro_stash, "PRIO_NORMAL", newSViv (PRIO_NORMAL));
1805 newCONSTSUB (coro_stash, "PRIO_LOW", newSViv (PRIO_LOW));
1806 newCONSTSUB (coro_stash, "PRIO_IDLE", newSViv (PRIO_IDLE));
1807 newCONSTSUB (coro_stash, "PRIO_MIN", newSViv (PRIO_MIN));
1808
1809 for (i = PRIO_MAX - PRIO_MIN + 1; i--; )
1810 coro_ready[i] = newAV ();
1811
1812 {
1813 SV *sv = perl_get_sv ("Coro::API", TRUE);
1814 perl_get_sv ("Coro::API", TRUE); /* silence 5.10 warning */
1815
1816 coroapi.schedule = api_schedule;
1817 coroapi.cede = api_cede;
1818 coroapi.cede_notself = api_cede_notself;
1819 coroapi.ready = api_ready;
1820 coroapi.is_ready = api_is_ready;
1821 coroapi.nready = &coro_nready;
1822 coroapi.current = coro_current;
1823
1824 GCoroAPI = &coroapi;
1825 sv_setiv (sv, (IV)&coroapi);
1826 SvREADONLY_on (sv);
1827 }
1828 }
1829
1830 void
1831 _set_current (SV *current)
1832 PROTOTYPE: $
1833 CODE:
1834 SvREFCNT_dec (SvRV (coro_current));
1835 SvRV_set (coro_current, SvREFCNT_inc (SvRV (current)));
1836
1837 int
1838 prio (Coro::State coro, int newprio = 0)
1839 ALIAS:
1840 nice = 1
1841 CODE:
1842 {
1843 RETVAL = coro->prio;
1844
1845 if (items > 1)
1846 {
1847 if (ix)
1848 newprio = coro->prio - newprio;
1849
1850 if (newprio < PRIO_MIN) newprio = PRIO_MIN;
1851 if (newprio > PRIO_MAX) newprio = PRIO_MAX;
1852
1853 coro->prio = newprio;
1854 }
1855 }
1856 OUTPUT:
1857 RETVAL
1858
1859 SV *
1860 ready (SV *self)
1861 PROTOTYPE: $
1862 CODE:
1863 RETVAL = boolSV (api_ready (self));
1864 OUTPUT:
1865 RETVAL
1866
1867 int
1868 nready (...)
1869 PROTOTYPE:
1870 CODE:
1871 RETVAL = coro_nready;
1872 OUTPUT:
1873 RETVAL
1874
1875 void
1876 throw (Coro::State self, SV *throw = &PL_sv_undef)
1877 PROTOTYPE: $;$
1878 CODE:
1879 SvREFCNT_dec (self->throw);
1880 self->throw = SvOK (throw) ? newSVsv (throw) : 0;
1881
1882 # for async_pool speedup
1883 void
1884 _pool_1 (SV *cb)
1885 CODE:
1886 {
1887 struct coro *coro = SvSTATE (coro_current);
1888 HV *hv = (HV *)SvRV (coro_current);
1889 AV *defav = GvAV (PL_defgv);
1890 SV *invoke = hv_delete (hv, "_invoke", sizeof ("_invoke") - 1, 0);
1891 AV *invoke_av;
1892 int i, len;
1893
1894 if (!invoke)
1895 croak ("\3async_pool terminate\2\n");
1896
1897 SvREFCNT_dec (coro->saved_deffh);
1898 coro->saved_deffh = SvREFCNT_inc ((SV *)PL_defoutgv);
1899
1900 hv_store (hv, "desc", sizeof ("desc") - 1,
1901 newSVpvn ("[async_pool]", sizeof ("[async_pool]") - 1), 0);
1902
1903 invoke_av = (AV *)SvRV (invoke);
1904 len = av_len (invoke_av);
1905
1906 sv_setsv (cb, AvARRAY (invoke_av)[0]);
1907
1908 if (len > 0)
1909 {
1910 av_fill (defav, len - 1);
1911 for (i = 0; i < len; ++i)
1912 av_store (defav, i, SvREFCNT_inc (AvARRAY (invoke_av)[i + 1]));
1913 }
1914
1915 SvREFCNT_dec (invoke);
1916 }
1917
1918 void
1919 _pool_2 (SV *cb)
1920 CODE:
1921 {
1922 struct coro *coro = SvSTATE (coro_current);
1923
1924 sv_setsv (cb, &PL_sv_undef);
1925
1926 SvREFCNT_dec ((SV *)PL_defoutgv); PL_defoutgv = (GV *)coro->saved_deffh;
1927 coro->saved_deffh = 0;
1928
1929 if (coro_rss (aTHX_ coro) > SvIV (sv_pool_rss)
1930 || av_len (av_async_pool) + 1 >= SvIV (sv_pool_size))
1931 croak ("\3async_pool terminate\2\n");
1932
1933 av_clear (GvAV (PL_defgv));
1934 hv_store ((HV *)SvRV (coro_current), "desc", sizeof ("desc") - 1,
1935 newSVpvn ("[async_pool idle]", sizeof ("[async_pool idle]") - 1), 0);
1936
1937 coro->prio = 0;
1938
1939 if (coro->cctx && (coro->cctx->flags & CC_TRACE))
1940 api_trace (coro_current, 0);
1941
1942 av_push (av_async_pool, newSVsv (coro_current));
1943 }
1944
1945
1946 MODULE = Coro::State PACKAGE = Coro::AIO
1947
1948 SV *
1949 _get_state ()
1950 CODE:
1951 {
1952 struct io_state *data;
1953
1954 RETVAL = newSV (sizeof (struct io_state));
1955 data = (struct io_state *)SvPVX (RETVAL);
1956 SvCUR_set (RETVAL, sizeof (struct io_state));
1957 SvPOK_only (RETVAL);
1958
1959 data->errorno = errno;
1960 data->laststype = PL_laststype;
1961 data->laststatval = PL_laststatval;
1962 data->statcache = PL_statcache;
1963 }
1964 OUTPUT:
1965 RETVAL
1966
1967 void
1968 _set_state (char *data_)
1969 PROTOTYPE: $
1970 CODE:
1971 {
1972 struct io_state *data = (void *)data_;
1973
1974 errno = data->errorno;
1975 PL_laststype = data->laststype;
1976 PL_laststatval = data->laststatval;
1977 PL_statcache = data->statcache;
1978 }
1979