ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro/State.xs
Revision: 1.214
Committed: Sat Oct 13 23:19:10 2007 UTC (16 years, 7 months ago) by root
Branch: MAIN
Changes since 1.213: +66 -39 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 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 static int (*orig_sigelem_get) (pTHX_ SV *sv, MAGIC *mg);
670
671 /*
672 * This overrides the default magic get method of %SIG elements.
673 * The original one doesn't provide for reading back of PL_diehook/PL_warnhook
674 * and instead of tryign to save and restore the hash elements, we just provide
675 * readback here.
676 * We only do this when the hook is != 0, as they are often set to 0 temporarily,
677 * not expecting this to actually change the hook. This is a potential problem
678 * when a schedule happens then, but we ignore this.
679 */
680 static int
681 coro_sigelem_get (pTHX_ SV *sv, MAGIC *mg)
682 {
683 const char *s = MgPV_nolen_const (mg);
684
685 if (*s == '_')
686 {
687 if (strEQ (s, "__DIE__" ) && PL_diehook ) return sv_setsv (sv, PL_diehook ), 0;
688 if (strEQ (s, "__WARN__") && PL_warnhook) return sv_setsv (sv, PL_warnhook), 0;
689 }
690
691 return orig_sigelem_get (aTHX_ sv, mg);
692 }
693
694 static void
695 coro_setup (pTHX_ struct coro *coro)
696 {
697 /*
698 * emulate part of the perl startup here.
699 */
700 coro_init_stacks (aTHX);
701
702 PL_runops = RUNOPS_DEFAULT;
703 PL_curcop = &PL_compiling;
704 PL_in_eval = EVAL_NULL;
705 PL_comppad = 0;
706 PL_curpm = 0;
707 PL_curpad = 0;
708 PL_localizing = 0;
709 PL_dirty = 0;
710 PL_restartop = 0;
711
712 /* recreate the die/warn hooks */
713 PL_diehook = 0;
714 hv_store (hv_sig, "__DIE__", sizeof ("__DIE__") - 1, newSV (0), 0);
715 PL_diehook = SvREFCNT_inc (rv_diehook);
716
717 PL_warnhook = 0;
718 hv_store (hv_sig, "__WARN__", sizeof ("__WARN__") - 1, newSV (0), 0);
719 PL_warnhook = SvREFCNT_inc (rv_warnhook);
720
721 GvSV (PL_defgv) = newSV (0);
722 GvAV (PL_defgv) = coro->args; coro->args = 0;
723 GvSV (PL_errgv) = newSV (0);
724 GvSV (irsgv) = newSVpvn ("\n", 1); sv_magic (GvSV (irsgv), (SV *)irsgv, PERL_MAGIC_sv, "/", 0);
725 PL_rs = newSVsv (GvSV (irsgv));
726 PL_defoutgv = (GV *)SvREFCNT_inc (stdoutgv);
727
728 {
729 dSP;
730 LOGOP myop;
731
732 Zero (&myop, 1, LOGOP);
733 myop.op_next = Nullop;
734 myop.op_flags = OPf_WANT_VOID;
735
736 PUSHMARK (SP);
737 XPUSHs (sv_2mortal (av_shift (GvAV (PL_defgv))));
738 PUTBACK;
739 PL_op = (OP *)&myop;
740 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX);
741 SPAGAIN;
742 }
743
744 /* this newly created coroutine might be run on an existing cctx which most
745 * likely was suspended in set_stacklevel, called from entersub.
746 * set_stacklevl doesn't do anything on return, but entersub does LEAVE,
747 * so we ENTER here for symmetry
748 */
749 ENTER;
750 }
751
752 static void
753 coro_destroy (pTHX_ struct coro *coro)
754 {
755 if (!IN_DESTRUCT)
756 {
757 /* restore all saved variables and stuff */
758 LEAVE_SCOPE (0);
759 assert (PL_tmps_floor == -1);
760
761 /* free all temporaries */
762 FREETMPS;
763 assert (PL_tmps_ix == -1);
764
765 /* unwind all extra stacks */
766 POPSTACK_TO (PL_mainstack);
767
768 /* unwind main stack */
769 dounwind (-1);
770 }
771
772 SvREFCNT_dec (GvSV (PL_defgv));
773 SvREFCNT_dec (GvAV (PL_defgv));
774 SvREFCNT_dec (GvSV (PL_errgv));
775 SvREFCNT_dec (PL_defoutgv);
776 SvREFCNT_dec (PL_rs);
777 SvREFCNT_dec (GvSV (irsgv));
778
779 SvREFCNT_dec (PL_diehook);
780 SvREFCNT_dec (PL_warnhook);
781
782 SvREFCNT_dec (coro->saved_deffh);
783 SvREFCNT_dec (coro->throw);
784
785 coro_destroy_stacks (aTHX);
786 }
787
788 static void
789 free_coro_mortal (pTHX)
790 {
791 if (expect_true (coro_mortal))
792 {
793 SvREFCNT_dec (coro_mortal);
794 coro_mortal = 0;
795 }
796 }
797
798 static int
799 runops_trace (pTHX)
800 {
801 COP *oldcop = 0;
802 int oldcxix = -2;
803 struct coro *coro = SvSTATE (coro_current); /* trace cctx is tied to specific coro */
804 coro_cctx *cctx = coro->cctx;
805
806 while ((PL_op = CALL_FPTR (PL_op->op_ppaddr) (aTHX)))
807 {
808 PERL_ASYNC_CHECK ();
809
810 if (cctx->flags & CC_TRACE_ALL)
811 {
812 if (PL_op->op_type == OP_LEAVESUB && cctx->flags & CC_TRACE_SUB)
813 {
814 PERL_CONTEXT *cx = &cxstack[cxstack_ix];
815 SV **bot, **top;
816 AV *av = newAV (); /* return values */
817 SV **cb;
818 dSP;
819
820 GV *gv = CvGV (cx->blk_sub.cv);
821 SV *fullname = sv_2mortal (newSV (0));
822 if (isGV (gv))
823 gv_efullname3 (fullname, gv, 0);
824
825 bot = PL_stack_base + cx->blk_oldsp + 1;
826 top = cx->blk_gimme == G_ARRAY ? SP + 1
827 : cx->blk_gimme == G_SCALAR ? bot + 1
828 : bot;
829
830 av_extend (av, top - bot);
831 while (bot < top)
832 av_push (av, SvREFCNT_inc (*bot++));
833
834 PL_runops = RUNOPS_DEFAULT;
835 ENTER;
836 SAVETMPS;
837 EXTEND (SP, 3);
838 PUSHMARK (SP);
839 PUSHs (&PL_sv_no);
840 PUSHs (fullname);
841 PUSHs (sv_2mortal (newRV_noinc ((SV *)av)));
842 PUTBACK;
843 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_sub_cb", sizeof ("_trace_sub_cb") - 1, 0);
844 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
845 SPAGAIN;
846 FREETMPS;
847 LEAVE;
848 PL_runops = runops_trace;
849 }
850
851 if (oldcop != PL_curcop)
852 {
853 oldcop = PL_curcop;
854
855 if (PL_curcop != &PL_compiling)
856 {
857 SV **cb;
858
859 if (oldcxix != cxstack_ix && cctx->flags & CC_TRACE_SUB)
860 {
861 PERL_CONTEXT *cx = &cxstack[cxstack_ix];
862
863 if (CxTYPE (cx) == CXt_SUB && oldcxix < cxstack_ix)
864 {
865 runops_proc_t old_runops = PL_runops;
866 dSP;
867 GV *gv = CvGV (cx->blk_sub.cv);
868 SV *fullname = sv_2mortal (newSV (0));
869
870 if (isGV (gv))
871 gv_efullname3 (fullname, gv, 0);
872
873 PL_runops = RUNOPS_DEFAULT;
874 ENTER;
875 SAVETMPS;
876 EXTEND (SP, 3);
877 PUSHMARK (SP);
878 PUSHs (&PL_sv_yes);
879 PUSHs (fullname);
880 PUSHs (cx->blk_sub.hasargs ? sv_2mortal (newRV_inc ((SV *)cx->blk_sub.argarray)) : &PL_sv_undef);
881 PUTBACK;
882 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_sub_cb", sizeof ("_trace_sub_cb") - 1, 0);
883 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
884 SPAGAIN;
885 FREETMPS;
886 LEAVE;
887 PL_runops = runops_trace;
888 }
889
890 oldcxix = cxstack_ix;
891 }
892
893 if (cctx->flags & CC_TRACE_LINE)
894 {
895 dSP;
896
897 PL_runops = RUNOPS_DEFAULT;
898 ENTER;
899 SAVETMPS;
900 EXTEND (SP, 3);
901 PL_runops = RUNOPS_DEFAULT;
902 PUSHMARK (SP);
903 PUSHs (sv_2mortal (newSVpv (OutCopFILE (oldcop), 0)));
904 PUSHs (sv_2mortal (newSViv (CopLINE (oldcop))));
905 PUTBACK;
906 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_line_cb", sizeof ("_trace_line_cb") - 1, 0);
907 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
908 SPAGAIN;
909 FREETMPS;
910 LEAVE;
911 PL_runops = runops_trace;
912 }
913 }
914 }
915 }
916 }
917
918 TAINT_NOT;
919 return 0;
920 }
921
922 /* inject a fake call to Coro::State::_cctx_init into the execution */
923 /* _cctx_init should be careful, as it could be called at almost any time */
924 /* during execution of a perl program */
925 static void NOINLINE
926 cctx_prepare (pTHX_ coro_cctx *cctx)
927 {
928 dSP;
929 LOGOP myop;
930
931 PL_top_env = &PL_start_env;
932
933 if (cctx->flags & CC_TRACE)
934 PL_runops = runops_trace;
935
936 Zero (&myop, 1, LOGOP);
937 myop.op_next = PL_op;
938 myop.op_flags = OPf_WANT_VOID | OPf_STACKED;
939
940 PUSHMARK (SP);
941 EXTEND (SP, 2);
942 PUSHs (sv_2mortal (newSViv (PTR2IV (cctx))));
943 PUSHs ((SV *)get_cv ("Coro::State::_cctx_init", FALSE));
944 PUTBACK;
945 PL_op = (OP *)&myop;
946 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX);
947 SPAGAIN;
948 }
949
950 /*
951 * this is a _very_ stripped down perl interpreter ;)
952 */
953 static void
954 cctx_run (void *arg)
955 {
956 dTHX;
957
958 /* cctx_run is the alternative tail of transfer(), so unlock here. */
959 UNLOCK;
960
961 /* we now skip the entersub that lead to transfer() */
962 PL_op = PL_op->op_next;
963
964 /* inject a fake subroutine call to cctx_init */
965 cctx_prepare (aTHX_ (coro_cctx *)arg);
966
967 /* somebody or something will hit me for both perl_run and PL_restartop */
968 PL_restartop = PL_op;
969 perl_run (PL_curinterp);
970
971 /*
972 * If perl-run returns we assume exit() was being called or the coro
973 * fell off the end, which seems to be the only valid (non-bug)
974 * reason for perl_run to return. We try to exit by jumping to the
975 * bootstrap-time "top" top_env, as we cannot restore the "main"
976 * coroutine as Coro has no such concept
977 */
978 PL_top_env = main_top_env;
979 JMPENV_JUMP (2); /* I do not feel well about the hardcoded 2 at all */
980 }
981
982 static coro_cctx *
983 cctx_new ()
984 {
985 coro_cctx *cctx;
986 void *stack_start;
987 size_t stack_size;
988
989 ++cctx_count;
990
991 Newz (0, cctx, 1, coro_cctx);
992
993 #if HAVE_MMAP
994 cctx->ssize = ((coro_stacksize * sizeof (long) + PAGESIZE - 1) / PAGESIZE + CORO_STACKGUARD) * PAGESIZE;
995 /* mmap supposedly does allocate-on-write for us */
996 cctx->sptr = mmap (0, cctx->ssize, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, 0, 0);
997
998 if (cctx->sptr != (void *)-1)
999 {
1000 # if CORO_STACKGUARD
1001 mprotect (cctx->sptr, CORO_STACKGUARD * PAGESIZE, PROT_NONE);
1002 # endif
1003 stack_start = CORO_STACKGUARD * PAGESIZE + (char *)cctx->sptr;
1004 stack_size = cctx->ssize - CORO_STACKGUARD * PAGESIZE;
1005 cctx->flags |= CC_MAPPED;
1006 }
1007 else
1008 #endif
1009 {
1010 cctx->ssize = coro_stacksize * (long)sizeof (long);
1011 New (0, cctx->sptr, coro_stacksize, long);
1012
1013 if (!cctx->sptr)
1014 {
1015 perror ("FATAL: unable to allocate stack for coroutine");
1016 _exit (EXIT_FAILURE);
1017 }
1018
1019 stack_start = cctx->sptr;
1020 stack_size = cctx->ssize;
1021 }
1022
1023 REGISTER_STACK (cctx, (char *)stack_start, (char *)stack_start + stack_size);
1024 coro_create (&cctx->cctx, cctx_run, (void *)cctx, stack_start, stack_size);
1025
1026 return cctx;
1027 }
1028
1029 static void
1030 cctx_destroy (coro_cctx *cctx)
1031 {
1032 if (!cctx)
1033 return;
1034
1035 --cctx_count;
1036
1037 #if CORO_USE_VALGRIND
1038 VALGRIND_STACK_DEREGISTER (cctx->valgrind_id);
1039 #endif
1040
1041 #if HAVE_MMAP
1042 if (cctx->flags & CC_MAPPED)
1043 munmap (cctx->sptr, cctx->ssize);
1044 else
1045 #endif
1046 Safefree (cctx->sptr);
1047
1048 Safefree (cctx);
1049 }
1050
1051 /* wether this cctx should be destructed */
1052 #define CCTX_EXPIRED(cctx) ((cctx)->ssize < coro_stacksize || ((cctx)->flags & CC_NOREUSE))
1053
1054 static coro_cctx *
1055 cctx_get (pTHX)
1056 {
1057 while (expect_true (cctx_first))
1058 {
1059 coro_cctx *cctx = cctx_first;
1060 cctx_first = cctx->next;
1061 --cctx_idle;
1062
1063 if (expect_true (!CCTX_EXPIRED (cctx)))
1064 return cctx;
1065
1066 cctx_destroy (cctx);
1067 }
1068
1069 return cctx_new ();
1070 }
1071
1072 static void
1073 cctx_put (coro_cctx *cctx)
1074 {
1075 /* free another cctx if overlimit */
1076 if (expect_false (cctx_idle >= MAX_IDLE_CCTX))
1077 {
1078 coro_cctx *first = cctx_first;
1079 cctx_first = first->next;
1080 --cctx_idle;
1081
1082 cctx_destroy (first);
1083 }
1084
1085 ++cctx_idle;
1086 cctx->next = cctx_first;
1087 cctx_first = cctx;
1088 }
1089
1090 /** coroutine switching *****************************************************/
1091
1092 static void
1093 transfer_check (pTHX_ struct coro *prev, struct coro *next)
1094 {
1095 if (expect_true (prev != next))
1096 {
1097 if (expect_false (!(prev->flags & (CF_RUNNING | CF_NEW))))
1098 croak ("Coro::State::transfer called with non-running/new prev Coro::State, but can only transfer from running or new states");
1099
1100 if (expect_false (next->flags & CF_RUNNING))
1101 croak ("Coro::State::transfer called with running next Coro::State, but can only transfer to inactive states");
1102
1103 if (expect_false (next->flags & CF_DESTROYED))
1104 croak ("Coro::State::transfer called with destroyed next Coro::State, but can only transfer to inactive states");
1105
1106 if (
1107 #if PERL_VERSION_ATLEAST (5,9,0)
1108 expect_false (PL_parser)
1109 #else
1110 expect_false (PL_lex_state != LEX_NOTPARSING)
1111 #endif
1112 )
1113 croak ("Coro::State::transfer called while parsing, but this is not supported");
1114 }
1115 }
1116
1117 /* always use the TRANSFER macro */
1118 static void NOINLINE
1119 transfer (pTHX_ struct coro *prev, struct coro *next)
1120 {
1121 dSTACKLEVEL;
1122
1123 /* sometimes transfer is only called to set idle_sp */
1124 if (expect_false (!next))
1125 {
1126 ((coro_cctx *)prev)->idle_sp = STACKLEVEL;
1127 assert (((coro_cctx *)prev)->idle_te = PL_top_env); /* just for the side-effect when asserts are enabled */
1128 }
1129 else if (expect_true (prev != next))
1130 {
1131 coro_cctx *prev__cctx;
1132
1133 if (expect_false (prev->flags & CF_NEW))
1134 {
1135 /* create a new empty context */
1136 Newz (0, prev->cctx, 1, coro_cctx);
1137 prev->flags &= ~CF_NEW;
1138 prev->flags |= CF_RUNNING;
1139 }
1140
1141 prev->flags &= ~CF_RUNNING;
1142 next->flags |= CF_RUNNING;
1143
1144 LOCK;
1145
1146 /* first get rid of the old state */
1147 save_perl (aTHX_ prev);
1148
1149 if (expect_false (next->flags & CF_NEW))
1150 {
1151 /* need to start coroutine */
1152 next->flags &= ~CF_NEW;
1153 /* setup coroutine call */
1154 coro_setup (aTHX_ next);
1155 }
1156 else
1157 load_perl (aTHX_ next);
1158
1159 prev__cctx = prev->cctx;
1160
1161 /* possibly "free" the cctx */
1162 if (expect_true (prev__cctx->idle_sp == STACKLEVEL && !(prev__cctx->flags & CC_TRACE)))
1163 {
1164 /* I assume that STACKLEVEL is a stronger indicator than PL_top_env changes */
1165 assert (("ERROR: current top_env must equal previous top_env", PL_top_env == prev__cctx->idle_te));
1166
1167 prev->cctx = 0;
1168
1169 /* if the cctx is about to be destroyed we need to make sure we won't see it in cctx_get */
1170 /* without this the next cctx_get might destroy the prev__cctx while still in use */
1171 if (expect_false (CCTX_EXPIRED (prev__cctx)))
1172 if (!next->cctx)
1173 next->cctx = cctx_get (aTHX);
1174
1175 cctx_put (prev__cctx);
1176 }
1177
1178 ++next->usecount;
1179
1180 if (expect_true (!next->cctx))
1181 next->cctx = cctx_get (aTHX);
1182
1183 if (expect_false (prev__cctx != next->cctx))
1184 {
1185 prev__cctx->top_env = PL_top_env;
1186 PL_top_env = next->cctx->top_env;
1187 coro_transfer (&prev__cctx->cctx, &next->cctx->cctx);
1188 }
1189
1190 free_coro_mortal (aTHX);
1191 UNLOCK;
1192
1193 if (expect_false (prev->throw || next->throw))
1194 {
1195 struct coro *coro = SvSTATE (coro_current);
1196
1197 if (coro->throw)
1198 {
1199 SV *exception = coro->throw;
1200 coro->throw = 0;
1201 sv_setsv (ERRSV, exception);
1202 croak (0);
1203 }
1204 }
1205 }
1206 }
1207
1208 struct transfer_args
1209 {
1210 struct coro *prev, *next;
1211 };
1212
1213 #define TRANSFER(ta) transfer (aTHX_ (ta).prev, (ta).next)
1214 #define TRANSFER_CHECK(ta) transfer_check (aTHX_ (ta).prev, (ta).next)
1215
1216 /** high level stuff ********************************************************/
1217
1218 static int
1219 coro_state_destroy (pTHX_ struct coro *coro)
1220 {
1221 if (coro->flags & CF_DESTROYED)
1222 return 0;
1223
1224 coro->flags |= CF_DESTROYED;
1225
1226 if (coro->flags & CF_READY)
1227 {
1228 /* reduce nready, as destroying a ready coro effectively unreadies it */
1229 /* alternative: look through all ready queues and remove the coro */
1230 LOCK;
1231 --coro_nready;
1232 UNLOCK;
1233 }
1234 else
1235 coro->flags |= CF_READY; /* make sure it is NOT put into the readyqueue */
1236
1237 if (coro->mainstack && coro->mainstack != main_mainstack)
1238 {
1239 struct coro temp;
1240
1241 if (coro->flags & CF_RUNNING)
1242 croak ("FATAL: tried to destroy currently running coroutine");
1243
1244 save_perl (aTHX_ &temp);
1245 load_perl (aTHX_ coro);
1246
1247 coro_destroy (aTHX_ coro);
1248
1249 load_perl (aTHX_ &temp);
1250
1251 coro->slot = 0;
1252 }
1253
1254 cctx_destroy (coro->cctx);
1255 SvREFCNT_dec (coro->args);
1256
1257 if (coro->next) coro->next->prev = coro->prev;
1258 if (coro->prev) coro->prev->next = coro->next;
1259 if (coro == coro_first) coro_first = coro->next;
1260
1261 return 1;
1262 }
1263
1264 static int
1265 coro_state_free (pTHX_ SV *sv, MAGIC *mg)
1266 {
1267 struct coro *coro = (struct coro *)mg->mg_ptr;
1268 mg->mg_ptr = 0;
1269
1270 coro->hv = 0;
1271
1272 if (--coro->refcnt < 0)
1273 {
1274 coro_state_destroy (aTHX_ coro);
1275 Safefree (coro);
1276 }
1277
1278 return 0;
1279 }
1280
1281 static int
1282 coro_state_dup (pTHX_ MAGIC *mg, CLONE_PARAMS *params)
1283 {
1284 struct coro *coro = (struct coro *)mg->mg_ptr;
1285
1286 ++coro->refcnt;
1287
1288 return 0;
1289 }
1290
1291 static MGVTBL coro_state_vtbl = {
1292 0, 0, 0, 0,
1293 coro_state_free,
1294 0,
1295 #ifdef MGf_DUP
1296 coro_state_dup,
1297 #else
1298 # define MGf_DUP 0
1299 #endif
1300 };
1301
1302 static void
1303 prepare_transfer (pTHX_ struct transfer_args *ta, SV *prev_sv, SV *next_sv)
1304 {
1305 ta->prev = SvSTATE (prev_sv);
1306 ta->next = SvSTATE (next_sv);
1307 TRANSFER_CHECK (*ta);
1308 }
1309
1310 static void
1311 api_transfer (SV *prev_sv, SV *next_sv)
1312 {
1313 dTHX;
1314 struct transfer_args ta;
1315
1316 prepare_transfer (aTHX_ &ta, prev_sv, next_sv);
1317 TRANSFER (ta);
1318 }
1319
1320 /** Coro ********************************************************************/
1321
1322 static void
1323 coro_enq (pTHX_ SV *coro_sv)
1324 {
1325 av_push (coro_ready [SvSTATE (coro_sv)->prio - PRIO_MIN], coro_sv);
1326 }
1327
1328 static SV *
1329 coro_deq (pTHX_ int min_prio)
1330 {
1331 int prio = PRIO_MAX - PRIO_MIN;
1332
1333 min_prio -= PRIO_MIN;
1334 if (min_prio < 0)
1335 min_prio = 0;
1336
1337 for (prio = PRIO_MAX - PRIO_MIN + 1; --prio >= min_prio; )
1338 if (AvFILLp (coro_ready [prio]) >= 0)
1339 return av_shift (coro_ready [prio]);
1340
1341 return 0;
1342 }
1343
1344 static int
1345 api_ready (SV *coro_sv)
1346 {
1347 dTHX;
1348 struct coro *coro;
1349
1350 if (SvROK (coro_sv))
1351 coro_sv = SvRV (coro_sv);
1352
1353 coro = SvSTATE (coro_sv);
1354
1355 if (coro->flags & CF_READY)
1356 return 0;
1357
1358 coro->flags |= CF_READY;
1359
1360 LOCK;
1361 coro_enq (aTHX_ SvREFCNT_inc (coro_sv));
1362 ++coro_nready;
1363 UNLOCK;
1364
1365 return 1;
1366 }
1367
1368 static int
1369 api_is_ready (SV *coro_sv)
1370 {
1371 dTHX;
1372 return !!(SvSTATE (coro_sv)->flags & CF_READY);
1373 }
1374
1375 static void
1376 prepare_schedule (pTHX_ struct transfer_args *ta)
1377 {
1378 SV *prev_sv, *next_sv;
1379
1380 for (;;)
1381 {
1382 LOCK;
1383 next_sv = coro_deq (aTHX_ PRIO_MIN);
1384
1385 /* nothing to schedule: call the idle handler */
1386 if (expect_false (!next_sv))
1387 {
1388 dSP;
1389 UNLOCK;
1390
1391 ENTER;
1392 SAVETMPS;
1393
1394 PUSHMARK (SP);
1395 PUTBACK;
1396 call_sv (get_sv ("Coro::idle", FALSE), G_DISCARD);
1397
1398 FREETMPS;
1399 LEAVE;
1400 continue;
1401 }
1402
1403 ta->next = SvSTATE (next_sv);
1404
1405 /* cannot transfer to destroyed coros, skip and look for next */
1406 if (expect_false (ta->next->flags & CF_DESTROYED))
1407 {
1408 UNLOCK;
1409 SvREFCNT_dec (next_sv);
1410 /* coro_nready is already taken care of by destroy */
1411 continue;
1412 }
1413
1414 --coro_nready;
1415 UNLOCK;
1416 break;
1417 }
1418
1419 /* free this only after the transfer */
1420 prev_sv = SvRV (coro_current);
1421 ta->prev = SvSTATE (prev_sv);
1422 TRANSFER_CHECK (*ta);
1423 assert (ta->next->flags & CF_READY);
1424 ta->next->flags &= ~CF_READY;
1425 SvRV_set (coro_current, next_sv);
1426
1427 LOCK;
1428 free_coro_mortal (aTHX);
1429 coro_mortal = prev_sv;
1430 UNLOCK;
1431 }
1432
1433 static void
1434 prepare_cede (pTHX_ struct transfer_args *ta)
1435 {
1436 api_ready (coro_current);
1437 prepare_schedule (aTHX_ ta);
1438 }
1439
1440 static int
1441 prepare_cede_notself (pTHX_ struct transfer_args *ta)
1442 {
1443 if (coro_nready)
1444 {
1445 SV *prev = SvRV (coro_current);
1446 prepare_schedule (aTHX_ ta);
1447 api_ready (prev);
1448 return 1;
1449 }
1450 else
1451 return 0;
1452 }
1453
1454 static void
1455 api_schedule (void)
1456 {
1457 dTHX;
1458 struct transfer_args ta;
1459
1460 prepare_schedule (aTHX_ &ta);
1461 TRANSFER (ta);
1462 }
1463
1464 static int
1465 api_cede (void)
1466 {
1467 dTHX;
1468 struct transfer_args ta;
1469
1470 prepare_cede (aTHX_ &ta);
1471
1472 if (expect_true (ta.prev != ta.next))
1473 {
1474 TRANSFER (ta);
1475 return 1;
1476 }
1477 else
1478 return 0;
1479 }
1480
1481 static int
1482 api_cede_notself (void)
1483 {
1484 dTHX;
1485 struct transfer_args ta;
1486
1487 if (prepare_cede_notself (aTHX_ &ta))
1488 {
1489 TRANSFER (ta);
1490 return 1;
1491 }
1492 else
1493 return 0;
1494 }
1495
1496 static void
1497 api_trace (SV *coro_sv, int flags)
1498 {
1499 dTHX;
1500 struct coro *coro = SvSTATE (coro_sv);
1501
1502 if (flags & CC_TRACE)
1503 {
1504 if (!coro->cctx)
1505 coro->cctx = cctx_new ();
1506 else if (!(coro->cctx->flags & CC_TRACE))
1507 croak ("cannot enable tracing on coroutine with custom stack");
1508
1509 coro->cctx->flags |= CC_NOREUSE | (flags & (CC_TRACE | CC_TRACE_ALL));
1510 }
1511 else if (coro->cctx && coro->cctx->flags & CC_TRACE)
1512 {
1513 coro->cctx->flags &= ~(CC_TRACE | CC_TRACE_ALL);
1514
1515 if (coro->flags & CF_RUNNING)
1516 PL_runops = RUNOPS_DEFAULT;
1517 else
1518 coro->slot->runops = RUNOPS_DEFAULT;
1519 }
1520 }
1521
1522 MODULE = Coro::State PACKAGE = Coro::State PREFIX = api_
1523
1524 PROTOTYPES: DISABLE
1525
1526 BOOT:
1527 {
1528 #ifdef USE_ITHREADS
1529 MUTEX_INIT (&coro_mutex);
1530 #endif
1531 BOOT_PAGESIZE;
1532
1533 irsgv = gv_fetchpv ("/" , GV_ADD|GV_NOTQUAL, SVt_PV);
1534 stdoutgv = gv_fetchpv ("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
1535
1536 orig_sigelem_get = PL_vtbl_sigelem.svt_get;
1537 PL_vtbl_sigelem.svt_get = coro_sigelem_get;
1538
1539 hv_sig = coro_get_hv (aTHX_ "SIG", TRUE);
1540 rv_diehook = newRV_inc ((SV *)gv_fetchpv ("Coro::State::diehook" , 0, SVt_PVCV));
1541 rv_warnhook = newRV_inc ((SV *)gv_fetchpv ("Coro::State::warnhook", 0, SVt_PVCV));
1542
1543 coro_state_stash = gv_stashpv ("Coro::State", TRUE);
1544
1545 newCONSTSUB (coro_state_stash, "CC_TRACE" , newSViv (CC_TRACE));
1546 newCONSTSUB (coro_state_stash, "CC_TRACE_SUB" , newSViv (CC_TRACE_SUB));
1547 newCONSTSUB (coro_state_stash, "CC_TRACE_LINE", newSViv (CC_TRACE_LINE));
1548 newCONSTSUB (coro_state_stash, "CC_TRACE_ALL" , newSViv (CC_TRACE_ALL));
1549
1550 main_mainstack = PL_mainstack;
1551 main_top_env = PL_top_env;
1552
1553 while (main_top_env->je_prev)
1554 main_top_env = main_top_env->je_prev;
1555
1556 coroapi.ver = CORO_API_VERSION;
1557 coroapi.rev = CORO_API_REVISION;
1558 coroapi.transfer = api_transfer;
1559
1560 assert (("PRIO_NORMAL must be 0", !PRIO_NORMAL));
1561 }
1562
1563 SV *
1564 new (char *klass, ...)
1565 CODE:
1566 {
1567 struct coro *coro;
1568 MAGIC *mg;
1569 HV *hv;
1570 int i;
1571
1572 Newz (0, coro, 1, struct coro);
1573 coro->args = newAV ();
1574 coro->flags = CF_NEW;
1575
1576 if (coro_first) coro_first->prev = coro;
1577 coro->next = coro_first;
1578 coro_first = coro;
1579
1580 coro->hv = hv = newHV ();
1581 mg = sv_magicext ((SV *)hv, 0, CORO_MAGIC_type_state, &coro_state_vtbl, (char *)coro, 0);
1582 mg->mg_flags |= MGf_DUP;
1583 RETVAL = sv_bless (newRV_noinc ((SV *)hv), gv_stashpv (klass, 1));
1584
1585 av_extend (coro->args, items - 1);
1586 for (i = 1; i < items; i++)
1587 av_push (coro->args, newSVsv (ST (i)));
1588 }
1589 OUTPUT:
1590 RETVAL
1591
1592 # these not obviously related functions are all rolled into the same xs
1593 # function to increase chances that they all will call transfer with the same
1594 # stack offset
1595 void
1596 _set_stacklevel (...)
1597 ALIAS:
1598 Coro::State::transfer = 1
1599 Coro::schedule = 2
1600 Coro::cede = 3
1601 Coro::cede_notself = 4
1602 CODE:
1603 {
1604 struct transfer_args ta;
1605
1606 switch (ix)
1607 {
1608 case 0:
1609 ta.prev = (struct coro *)INT2PTR (coro_cctx *, SvIV (ST (0)));
1610 ta.next = 0;
1611 break;
1612
1613 case 1:
1614 if (items != 2)
1615 croak ("Coro::State::transfer (prev,next) expects two arguments, not %d", items);
1616
1617 prepare_transfer (aTHX_ &ta, ST (0), ST (1));
1618 break;
1619
1620 case 2:
1621 prepare_schedule (aTHX_ &ta);
1622 break;
1623
1624 case 3:
1625 prepare_cede (aTHX_ &ta);
1626 break;
1627
1628 case 4:
1629 if (!prepare_cede_notself (aTHX_ &ta))
1630 XSRETURN_EMPTY;
1631
1632 break;
1633 }
1634
1635 BARRIER;
1636 PUTBACK;
1637 TRANSFER (ta);
1638 SPAGAIN; /* might be the sp of a different coroutine now */
1639 /* be extra careful not to ever do anything after TRANSFER */
1640 }
1641
1642 bool
1643 _destroy (SV *coro_sv)
1644 CODE:
1645 RETVAL = coro_state_destroy (aTHX_ SvSTATE (coro_sv));
1646 OUTPUT:
1647 RETVAL
1648
1649 void
1650 _exit (code)
1651 int code
1652 PROTOTYPE: $
1653 CODE:
1654 _exit (code);
1655
1656 int
1657 cctx_stacksize (int new_stacksize = 0)
1658 CODE:
1659 RETVAL = coro_stacksize;
1660 if (new_stacksize)
1661 coro_stacksize = new_stacksize;
1662 OUTPUT:
1663 RETVAL
1664
1665 int
1666 cctx_count ()
1667 CODE:
1668 RETVAL = cctx_count;
1669 OUTPUT:
1670 RETVAL
1671
1672 int
1673 cctx_idle ()
1674 CODE:
1675 RETVAL = cctx_idle;
1676 OUTPUT:
1677 RETVAL
1678
1679 void
1680 list ()
1681 PPCODE:
1682 {
1683 struct coro *coro;
1684 for (coro = coro_first; coro; coro = coro->next)
1685 if (coro->hv)
1686 XPUSHs (sv_2mortal (newRV_inc ((SV *)coro->hv)));
1687 }
1688
1689 void
1690 call (Coro::State coro, SV *coderef)
1691 ALIAS:
1692 eval = 1
1693 CODE:
1694 {
1695 if (coro->mainstack)
1696 {
1697 struct coro temp;
1698
1699 if (!(coro->flags & CF_RUNNING))
1700 {
1701 save_perl (aTHX_ &temp);
1702 load_perl (aTHX_ coro);
1703 }
1704
1705 {
1706 dSP;
1707 ENTER;
1708 SAVETMPS;
1709 PUTBACK;
1710 PUSHSTACK;
1711 PUSHMARK (SP);
1712
1713 if (ix)
1714 eval_sv (coderef, 0);
1715 else
1716 call_sv (coderef, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
1717
1718 POPSTACK;
1719 SPAGAIN;
1720 FREETMPS;
1721 LEAVE;
1722 PUTBACK;
1723 }
1724
1725 if (!(coro->flags & CF_RUNNING))
1726 {
1727 save_perl (aTHX_ coro);
1728 load_perl (aTHX_ &temp);
1729 }
1730 }
1731 }
1732
1733 SV *
1734 is_ready (Coro::State coro)
1735 PROTOTYPE: $
1736 ALIAS:
1737 is_ready = CF_READY
1738 is_running = CF_RUNNING
1739 is_new = CF_NEW
1740 is_destroyed = CF_DESTROYED
1741 CODE:
1742 RETVAL = boolSV (coro->flags & ix);
1743 OUTPUT:
1744 RETVAL
1745
1746 void
1747 api_trace (SV *coro, int flags = CC_TRACE | CC_TRACE_SUB)
1748
1749 SV *
1750 has_stack (Coro::State coro)
1751 PROTOTYPE: $
1752 CODE:
1753 RETVAL = boolSV (!!coro->cctx);
1754 OUTPUT:
1755 RETVAL
1756
1757 int
1758 is_traced (Coro::State coro)
1759 PROTOTYPE: $
1760 CODE:
1761 RETVAL = (coro->cctx ? coro->cctx->flags : 0) & CC_TRACE_ALL;
1762 OUTPUT:
1763 RETVAL
1764
1765 IV
1766 rss (Coro::State coro)
1767 PROTOTYPE: $
1768 ALIAS:
1769 usecount = 1
1770 CODE:
1771 switch (ix)
1772 {
1773 case 0: RETVAL = coro_rss (aTHX_ coro); break;
1774 case 1: RETVAL = coro->usecount; break;
1775 }
1776 OUTPUT:
1777 RETVAL
1778
1779
1780 MODULE = Coro::State PACKAGE = Coro
1781
1782 BOOT:
1783 {
1784 int i;
1785
1786 sv_pool_rss = coro_get_sv (aTHX_ "Coro::POOL_RSS" , TRUE);
1787 sv_pool_size = coro_get_sv (aTHX_ "Coro::POOL_SIZE" , TRUE);
1788 av_async_pool = coro_get_av (aTHX_ "Coro::async_pool", TRUE);
1789
1790 coro_current = coro_get_sv (aTHX_ "Coro::current", FALSE);
1791 SvREADONLY_on (coro_current);
1792
1793 coro_stash = gv_stashpv ("Coro", TRUE);
1794
1795 newCONSTSUB (coro_stash, "PRIO_MAX", newSViv (PRIO_MAX));
1796 newCONSTSUB (coro_stash, "PRIO_HIGH", newSViv (PRIO_HIGH));
1797 newCONSTSUB (coro_stash, "PRIO_NORMAL", newSViv (PRIO_NORMAL));
1798 newCONSTSUB (coro_stash, "PRIO_LOW", newSViv (PRIO_LOW));
1799 newCONSTSUB (coro_stash, "PRIO_IDLE", newSViv (PRIO_IDLE));
1800 newCONSTSUB (coro_stash, "PRIO_MIN", newSViv (PRIO_MIN));
1801
1802 for (i = PRIO_MAX - PRIO_MIN + 1; i--; )
1803 coro_ready[i] = newAV ();
1804
1805 {
1806 SV *sv = perl_get_sv ("Coro::API", TRUE);
1807 perl_get_sv ("Coro::API", TRUE); /* silence 5.10 warning */
1808
1809 coroapi.schedule = api_schedule;
1810 coroapi.cede = api_cede;
1811 coroapi.cede_notself = api_cede_notself;
1812 coroapi.ready = api_ready;
1813 coroapi.is_ready = api_is_ready;
1814 coroapi.nready = &coro_nready;
1815 coroapi.current = coro_current;
1816
1817 GCoroAPI = &coroapi;
1818 sv_setiv (sv, (IV)&coroapi);
1819 SvREADONLY_on (sv);
1820 }
1821 }
1822
1823 void
1824 _set_current (SV *current)
1825 PROTOTYPE: $
1826 CODE:
1827 SvREFCNT_dec (SvRV (coro_current));
1828 SvRV_set (coro_current, SvREFCNT_inc (SvRV (current)));
1829
1830 int
1831 prio (Coro::State coro, int newprio = 0)
1832 ALIAS:
1833 nice = 1
1834 CODE:
1835 {
1836 RETVAL = coro->prio;
1837
1838 if (items > 1)
1839 {
1840 if (ix)
1841 newprio = coro->prio - newprio;
1842
1843 if (newprio < PRIO_MIN) newprio = PRIO_MIN;
1844 if (newprio > PRIO_MAX) newprio = PRIO_MAX;
1845
1846 coro->prio = newprio;
1847 }
1848 }
1849 OUTPUT:
1850 RETVAL
1851
1852 SV *
1853 ready (SV *self)
1854 PROTOTYPE: $
1855 CODE:
1856 RETVAL = boolSV (api_ready (self));
1857 OUTPUT:
1858 RETVAL
1859
1860 int
1861 nready (...)
1862 PROTOTYPE:
1863 CODE:
1864 RETVAL = coro_nready;
1865 OUTPUT:
1866 RETVAL
1867
1868 void
1869 throw (Coro::State self, SV *throw = &PL_sv_undef)
1870 PROTOTYPE: $;$
1871 CODE:
1872 SvREFCNT_dec (self->throw);
1873 self->throw = SvOK (throw) ? newSVsv (throw) : 0;
1874
1875 # for async_pool speedup
1876 void
1877 _pool_1 (SV *cb)
1878 CODE:
1879 {
1880 struct coro *coro = SvSTATE (coro_current);
1881 HV *hv = (HV *)SvRV (coro_current);
1882 AV *defav = GvAV (PL_defgv);
1883 SV *invoke = hv_delete (hv, "_invoke", sizeof ("_invoke") - 1, 0);
1884 AV *invoke_av;
1885 int i, len;
1886
1887 if (!invoke)
1888 croak ("\3async_pool terminate\2\n");
1889
1890 SvREFCNT_dec (coro->saved_deffh);
1891 coro->saved_deffh = SvREFCNT_inc ((SV *)PL_defoutgv);
1892
1893 hv_store (hv, "desc", sizeof ("desc") - 1,
1894 newSVpvn ("[async_pool]", sizeof ("[async_pool]") - 1), 0);
1895
1896 invoke_av = (AV *)SvRV (invoke);
1897 len = av_len (invoke_av);
1898
1899 sv_setsv (cb, AvARRAY (invoke_av)[0]);
1900
1901 if (len > 0)
1902 {
1903 av_fill (defav, len - 1);
1904 for (i = 0; i < len; ++i)
1905 av_store (defav, i, SvREFCNT_inc (AvARRAY (invoke_av)[i + 1]));
1906 }
1907
1908 SvREFCNT_dec (invoke);
1909 }
1910
1911 void
1912 _pool_2 (SV *cb)
1913 CODE:
1914 {
1915 struct coro *coro = SvSTATE (coro_current);
1916
1917 sv_setsv (cb, &PL_sv_undef);
1918
1919 SvREFCNT_dec ((SV *)PL_defoutgv); PL_defoutgv = (GV *)coro->saved_deffh;
1920 coro->saved_deffh = 0;
1921
1922 if (coro_rss (aTHX_ coro) > SvIV (sv_pool_rss)
1923 || av_len (av_async_pool) + 1 >= SvIV (sv_pool_size))
1924 croak ("\3async_pool terminate\2\n");
1925
1926 av_clear (GvAV (PL_defgv));
1927 hv_store ((HV *)SvRV (coro_current), "desc", sizeof ("desc") - 1,
1928 newSVpvn ("[async_pool idle]", sizeof ("[async_pool idle]") - 1), 0);
1929
1930 coro->prio = 0;
1931
1932 if (coro->cctx && (coro->cctx->flags & CC_TRACE))
1933 api_trace (coro_current, 0);
1934
1935 av_push (av_async_pool, newSVsv (coro_current));
1936 }
1937
1938
1939 MODULE = Coro::State PACKAGE = Coro::AIO
1940
1941 SV *
1942 _get_state ()
1943 CODE:
1944 {
1945 struct io_state *data;
1946
1947 RETVAL = newSV (sizeof (struct io_state));
1948 data = (struct io_state *)SvPVX (RETVAL);
1949 SvCUR_set (RETVAL, sizeof (struct io_state));
1950 SvPOK_only (RETVAL);
1951
1952 data->errorno = errno;
1953 data->laststype = PL_laststype;
1954 data->laststatval = PL_laststatval;
1955 data->statcache = PL_statcache;
1956 }
1957 OUTPUT:
1958 RETVAL
1959
1960 void
1961 _set_state (char *data_)
1962 PROTOTYPE: $
1963 CODE:
1964 {
1965 struct io_state *data = (void *)data_;
1966
1967 errno = data->errorno;
1968 PL_laststype = data->laststype;
1969 PL_laststatval = data->laststatval;
1970 PL_statcache = data->statcache;
1971 }
1972