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