ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro/State.xs
Revision: 1.336
Committed: Thu Dec 4 17:29:40 2008 UTC (15 years, 5 months ago) by root
Branch: MAIN
Changes since 1.335: +3 -4 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 #include "perliol.h"
10
11 #include "patchlevel.h"
12
13 #include <stdio.h>
14 #include <errno.h>
15 #include <assert.h>
16
17 #ifdef WIN32
18 # undef setjmp
19 # undef longjmp
20 # undef _exit
21 # define setjmp _setjmp /* deep magic */
22 #else
23 # include <inttypes.h> /* most portable stdint.h */
24 #endif
25
26 #ifdef HAVE_MMAP
27 # include <unistd.h>
28 # include <sys/mman.h>
29 # ifndef MAP_ANONYMOUS
30 # ifdef MAP_ANON
31 # define MAP_ANONYMOUS MAP_ANON
32 # else
33 # undef HAVE_MMAP
34 # endif
35 # endif
36 # include <limits.h>
37 # ifndef PAGESIZE
38 # define PAGESIZE pagesize
39 # define BOOT_PAGESIZE pagesize = sysconf (_SC_PAGESIZE)
40 static long pagesize;
41 # else
42 # define BOOT_PAGESIZE (void)0
43 # endif
44 #else
45 # define PAGESIZE 0
46 # define BOOT_PAGESIZE (void)0
47 #endif
48
49 #if CORO_USE_VALGRIND
50 # include <valgrind/valgrind.h>
51 #endif
52
53 /* the maximum number of idle cctx that will be pooled */
54 static int cctx_max_idle = 4;
55
56 #define PERL_VERSION_ATLEAST(a,b,c) \
57 (PERL_REVISION > (a) \
58 || (PERL_REVISION == (a) \
59 && (PERL_VERSION > (b) \
60 || (PERL_VERSION == (b) && PERL_SUBVERSION >= (c)))))
61
62 #if !PERL_VERSION_ATLEAST (5,6,0)
63 # ifndef PL_ppaddr
64 # define PL_ppaddr ppaddr
65 # endif
66 # ifndef call_sv
67 # define call_sv perl_call_sv
68 # endif
69 # ifndef get_sv
70 # define get_sv perl_get_sv
71 # endif
72 # ifndef get_cv
73 # define get_cv perl_get_cv
74 # endif
75 # ifndef IS_PADGV
76 # define IS_PADGV(v) 0
77 # endif
78 # ifndef IS_PADCONST
79 # define IS_PADCONST(v) 0
80 # endif
81 #endif
82
83 /* 5.11 */
84 #ifndef CxHASARGS
85 # define CxHASARGS(cx) (cx)->blk_sub.hasargs
86 #endif
87
88 /* 5.10.0 */
89 #ifndef SvREFCNT_inc_NN
90 # define SvREFCNT_inc_NN(sv) SvREFCNT_inc (sv)
91 #endif
92
93 /* 5.8.8 */
94 #ifndef GV_NOTQUAL
95 # define GV_NOTQUAL 0
96 #endif
97 #ifndef newSV
98 # define newSV(l) NEWSV(0,l)
99 #endif
100 #ifndef CvISXSUB_on
101 # define CvISXSUB_on(cv) (void)cv
102 #endif
103 #ifndef CvISXSUB
104 # define CvISXSUB(cv) (CvXSUB (cv) ? TRUE : FALSE)
105 #endif
106 #ifndef Newx
107 # define Newx(ptr,nitems,type) New (0,ptr,nitems,type)
108 #endif
109
110 /* 5.8.7 */
111 #ifndef SvRV_set
112 # define SvRV_set(s,v) SvRV(s) = (v)
113 #endif
114
115 #if !__i386 && !__x86_64 && !__powerpc && !__m68k && !__alpha && !__mips && !__sparc64
116 # undef CORO_STACKGUARD
117 #endif
118
119 #ifndef CORO_STACKGUARD
120 # define CORO_STACKGUARD 0
121 #endif
122
123 /* prefer perl internal functions over our own? */
124 #ifndef CORO_PREFER_PERL_FUNCTIONS
125 # define CORO_PREFER_PERL_FUNCTIONS 0
126 #endif
127
128 /* The next macros try to return the current stack pointer, in an as
129 * portable way as possible. */
130 #if __GNUC__ >= 4
131 # define dSTACKLEVEL int stacklevel_dummy
132 # define STACKLEVEL __builtin_frame_address (0)
133 #else
134 # define dSTACKLEVEL volatile void *stacklevel
135 # define STACKLEVEL ((void *)&stacklevel)
136 #endif
137
138 #define IN_DESTRUCT PL_dirty
139
140 #if __GNUC__ >= 3
141 # define attribute(x) __attribute__(x)
142 # define expect(expr,value) __builtin_expect ((expr),(value))
143 # define INLINE static inline
144 #else
145 # define attribute(x)
146 # define expect(expr,value) (expr)
147 # define INLINE static
148 #endif
149
150 #define expect_false(expr) expect ((expr) != 0, 0)
151 #define expect_true(expr) expect ((expr) != 0, 1)
152
153 #define NOINLINE attribute ((noinline))
154
155 #include "CoroAPI.h"
156 #define GCoroAPI (&coroapi) /* very sneaky */
157
158 #ifdef USE_ITHREADS
159 # if CORO_PTHREAD
160 static void *coro_thx;
161 # endif
162 #endif
163
164 static double (*nvtime)(); /* so why doesn't it take void? */
165
166 /* we hijack an hopefully unused CV flag for our purposes */
167 #define CVf_SLF 0x4000
168 static OP *pp_slf (pTHX);
169
170 static U32 cctx_gen;
171 static size_t cctx_stacksize = CORO_STACKSIZE;
172 static struct CoroAPI coroapi;
173 static AV *main_mainstack; /* used to differentiate between $main and others */
174 static JMPENV *main_top_env;
175 static HV *coro_state_stash, *coro_stash;
176 static volatile SV *coro_mortal; /* will be freed/thrown after next transfer */
177
178 static AV *av_destroy; /* destruction queue */
179 static SV *sv_manager; /* the manager coro */
180 static SV *sv_idle; /* $Coro::idle */
181
182 static GV *irsgv; /* $/ */
183 static GV *stdoutgv; /* *STDOUT */
184 static SV *rv_diehook;
185 static SV *rv_warnhook;
186 static HV *hv_sig; /* %SIG */
187
188 /* async_pool helper stuff */
189 static SV *sv_pool_rss;
190 static SV *sv_pool_size;
191 static SV *sv_async_pool_idle; /* description string */
192 static AV *av_async_pool; /* idle pool */
193 static SV *sv_Coro; /* class string */
194 static CV *cv_pool_handler;
195 static CV *cv_coro_state_new;
196
197 /* Coro::AnyEvent */
198 static SV *sv_activity;
199
200 static struct coro_cctx *cctx_first;
201 static int cctx_count, cctx_idle;
202
203 enum {
204 CC_MAPPED = 0x01,
205 CC_NOREUSE = 0x02, /* throw this away after tracing */
206 CC_TRACE = 0x04,
207 CC_TRACE_SUB = 0x08, /* trace sub calls */
208 CC_TRACE_LINE = 0x10, /* trace each statement */
209 CC_TRACE_ALL = CC_TRACE_SUB | CC_TRACE_LINE,
210 };
211
212 /* this is a structure representing a c-level coroutine */
213 typedef struct coro_cctx
214 {
215 struct coro_cctx *next;
216
217 /* the stack */
218 void *sptr;
219 size_t ssize;
220
221 /* cpu state */
222 void *idle_sp; /* sp of top-level transfer/schedule/cede call */
223 JMPENV *idle_te; /* same as idle_sp, but for top_env, TODO: remove once stable */
224 JMPENV *top_env;
225 coro_context cctx;
226
227 U32 gen;
228 #if CORO_USE_VALGRIND
229 int valgrind_id;
230 #endif
231 unsigned char flags;
232 } coro_cctx;
233
234 coro_cctx *cctx_current; /* the currently running cctx */
235
236 /*****************************************************************************/
237
238 enum {
239 CF_RUNNING = 0x0001, /* coroutine is running */
240 CF_READY = 0x0002, /* coroutine is ready */
241 CF_NEW = 0x0004, /* has never been switched to */
242 CF_DESTROYED = 0x0008, /* coroutine data has been freed */
243 };
244
245 /* the structure where most of the perl state is stored, overlaid on the cxstack */
246 typedef struct
247 {
248 SV *defsv;
249 AV *defav;
250 SV *errsv;
251 SV *irsgv;
252 HV *hinthv;
253 #define VAR(name,type) type name;
254 # include "state.h"
255 #undef VAR
256 } perl_slots;
257
258 #define SLOT_COUNT ((sizeof (perl_slots) + sizeof (PERL_CONTEXT) - 1) / sizeof (PERL_CONTEXT))
259
260 /* this is a structure representing a perl-level coroutine */
261 struct coro {
262 /* the C coroutine allocated to this perl coroutine, if any */
263 coro_cctx *cctx;
264
265 /* state data */
266 struct CoroSLF slf_frame; /* saved slf frame */
267 AV *mainstack;
268 perl_slots *slot; /* basically the saved sp */
269
270 CV *startcv; /* the CV to execute */
271 AV *args; /* data associated with this coroutine (initial args) */
272 int refcnt; /* coroutines are refcounted, yes */
273 int flags; /* CF_ flags */
274 HV *hv; /* the perl hash associated with this coro, if any */
275 void (*on_destroy)(pTHX_ struct coro *coro);
276
277 /* statistics */
278 int usecount; /* number of transfers to this coro */
279
280 /* coro process data */
281 int prio;
282 SV *except; /* exception to be thrown */
283 SV *rouse_cb;
284
285 /* async_pool */
286 SV *saved_deffh;
287 SV *invoke_cb;
288 AV *invoke_av;
289
290 /* linked list */
291 struct coro *next, *prev;
292 };
293
294 typedef struct coro *Coro__State;
295 typedef struct coro *Coro__State_or_hashref;
296
297 /* the following variables are effectively part of the perl context */
298 /* and get copied between struct coro and these variables */
299 /* the mainr easonw e don't support windows process emulation */
300 static struct CoroSLF slf_frame; /* the current slf frame */
301
302 /** Coro ********************************************************************/
303
304 #define PRIO_MAX 3
305 #define PRIO_HIGH 1
306 #define PRIO_NORMAL 0
307 #define PRIO_LOW -1
308 #define PRIO_IDLE -3
309 #define PRIO_MIN -4
310
311 /* for Coro.pm */
312 static SV *coro_current;
313 static SV *coro_readyhook;
314 static AV *coro_ready [PRIO_MAX - PRIO_MIN + 1];
315 static CV *cv_coro_run, *cv_coro_terminate;
316 static struct coro *coro_first;
317 #define coro_nready coroapi.nready
318
319 /** lowlevel stuff **********************************************************/
320
321 static SV *
322 coro_get_sv (pTHX_ const char *name, int create)
323 {
324 #if PERL_VERSION_ATLEAST (5,10,0)
325 /* silence stupid and wrong 5.10 warning that I am unable to switch off */
326 get_sv (name, create);
327 #endif
328 return get_sv (name, create);
329 }
330
331 static AV *
332 coro_get_av (pTHX_ const char *name, int create)
333 {
334 #if PERL_VERSION_ATLEAST (5,10,0)
335 /* silence stupid and wrong 5.10 warning that I am unable to switch off */
336 get_av (name, create);
337 #endif
338 return get_av (name, create);
339 }
340
341 static HV *
342 coro_get_hv (pTHX_ const char *name, int create)
343 {
344 #if PERL_VERSION_ATLEAST (5,10,0)
345 /* silence stupid and wrong 5.10 warning that I am unable to switch off */
346 get_hv (name, create);
347 #endif
348 return get_hv (name, create);
349 }
350
351 /* may croak */
352 INLINE CV *
353 coro_sv_2cv (pTHX_ SV *sv)
354 {
355 HV *st;
356 GV *gvp;
357 return sv_2cv (sv, &st, &gvp, 0);
358 }
359
360 /*****************************************************************************/
361 /* magic glue */
362
363 #define CORO_MAGIC_type_cv 26
364 #define CORO_MAGIC_type_state PERL_MAGIC_ext
365
366 #define CORO_MAGIC_NN(sv, type) \
367 (expect_true (SvMAGIC (sv)->mg_type == type) \
368 ? SvMAGIC (sv) \
369 : mg_find (sv, type))
370
371 #define CORO_MAGIC(sv, type) \
372 (expect_true (SvMAGIC (sv)) \
373 ? CORO_MAGIC_NN (sv, type) \
374 : 0)
375
376 #define CORO_MAGIC_cv(cv) CORO_MAGIC (((SV *)(cv)), CORO_MAGIC_type_cv)
377 #define CORO_MAGIC_state(sv) CORO_MAGIC_NN (((SV *)(sv)), CORO_MAGIC_type_state)
378
379 INLINE struct coro *
380 SvSTATE_ (pTHX_ SV *coro)
381 {
382 HV *stash;
383 MAGIC *mg;
384
385 if (SvROK (coro))
386 coro = SvRV (coro);
387
388 if (expect_false (SvTYPE (coro) != SVt_PVHV))
389 croak ("Coro::State object required");
390
391 stash = SvSTASH (coro);
392 if (expect_false (stash != coro_stash && stash != coro_state_stash))
393 {
394 /* very slow, but rare, check */
395 if (!sv_derived_from (sv_2mortal (newRV_inc (coro)), "Coro::State"))
396 croak ("Coro::State object required");
397 }
398
399 mg = CORO_MAGIC_state (coro);
400 return (struct coro *)mg->mg_ptr;
401 }
402
403 #define SvSTATE(sv) SvSTATE_ (aTHX_ (sv))
404
405 /* faster than SvSTATE, but expects a coroutine hv */
406 #define SvSTATE_hv(hv) ((struct coro *)CORO_MAGIC_NN ((SV *)hv, CORO_MAGIC_type_state)->mg_ptr)
407 #define SvSTATE_current SvSTATE_hv (SvRV (coro_current))
408
409 /*****************************************************************************/
410 /* padlist management and caching */
411
412 static AV *
413 coro_derive_padlist (pTHX_ CV *cv)
414 {
415 AV *padlist = CvPADLIST (cv);
416 AV *newpadlist, *newpad;
417
418 newpadlist = newAV ();
419 AvREAL_off (newpadlist);
420 #if PERL_VERSION_ATLEAST (5,10,0)
421 Perl_pad_push (aTHX_ padlist, AvFILLp (padlist) + 1);
422 #else
423 Perl_pad_push (aTHX_ padlist, AvFILLp (padlist) + 1, 1);
424 #endif
425 newpad = (AV *)AvARRAY (padlist)[AvFILLp (padlist)];
426 --AvFILLp (padlist);
427
428 av_store (newpadlist, 0, SvREFCNT_inc_NN (AvARRAY (padlist)[0]));
429 av_store (newpadlist, 1, (SV *)newpad);
430
431 return newpadlist;
432 }
433
434 static void
435 free_padlist (pTHX_ AV *padlist)
436 {
437 /* may be during global destruction */
438 if (!IN_DESTRUCT)
439 {
440 I32 i = AvFILLp (padlist);
441
442 while (i > 0) /* special-case index 0 */
443 {
444 /* we try to be extra-careful here */
445 AV *av = (AV *)AvARRAY (padlist)[i--];
446 I32 j = AvFILLp (av);
447
448 while (j >= 0)
449 SvREFCNT_dec (AvARRAY (av)[j--]);
450
451 AvFILLp (av) = -1;
452 SvREFCNT_dec (av);
453 }
454
455 SvREFCNT_dec (AvARRAY (padlist)[0]);
456
457 AvFILLp (padlist) = -1;
458 SvREFCNT_dec ((SV*)padlist);
459 }
460 }
461
462 static int
463 coro_cv_free (pTHX_ SV *sv, MAGIC *mg)
464 {
465 AV *padlist;
466 AV *av = (AV *)mg->mg_obj;
467
468 /* casting is fun. */
469 while (&PL_sv_undef != (SV *)(padlist = (AV *)av_pop (av)))
470 free_padlist (aTHX_ padlist);
471
472 SvREFCNT_dec (av); /* sv_magicext increased the refcount */
473
474 return 0;
475 }
476
477 static MGVTBL coro_cv_vtbl = {
478 0, 0, 0, 0,
479 coro_cv_free
480 };
481
482 /* the next two functions merely cache the padlists */
483 static void
484 get_padlist (pTHX_ CV *cv)
485 {
486 MAGIC *mg = CORO_MAGIC_cv (cv);
487 AV *av;
488
489 if (expect_true (mg && AvFILLp ((av = (AV *)mg->mg_obj)) >= 0))
490 CvPADLIST (cv) = (AV *)AvARRAY (av)[AvFILLp (av)--];
491 else
492 {
493 #if CORO_PREFER_PERL_FUNCTIONS
494 /* this is probably cleaner? but also slower! */
495 /* in practise, it seems to be less stable */
496 CV *cp = Perl_cv_clone (aTHX_ cv);
497 CvPADLIST (cv) = CvPADLIST (cp);
498 CvPADLIST (cp) = 0;
499 SvREFCNT_dec (cp);
500 #else
501 CvPADLIST (cv) = coro_derive_padlist (aTHX_ cv);
502 #endif
503 }
504 }
505
506 static void
507 put_padlist (pTHX_ CV *cv)
508 {
509 MAGIC *mg = CORO_MAGIC_cv (cv);
510 AV *av;
511
512 if (expect_false (!mg))
513 mg = sv_magicext ((SV *)cv, (SV *)newAV (), CORO_MAGIC_type_cv, &coro_cv_vtbl, 0, 0);
514
515 av = (AV *)mg->mg_obj;
516
517 if (expect_false (AvFILLp (av) >= AvMAX (av)))
518 av_extend (av, AvFILLp (av) + 1);
519
520 AvARRAY (av)[++AvFILLp (av)] = (SV *)CvPADLIST (cv);
521 }
522
523 /** load & save, init *******************************************************/
524
525 static void
526 load_perl (pTHX_ Coro__State c)
527 {
528 perl_slots *slot = c->slot;
529 c->slot = 0;
530
531 PL_mainstack = c->mainstack;
532
533 GvSV (PL_defgv) = slot->defsv;
534 GvAV (PL_defgv) = slot->defav;
535 GvSV (PL_errgv) = slot->errsv;
536 GvSV (irsgv) = slot->irsgv;
537 GvHV (PL_hintgv) = slot->hinthv;
538
539 #define VAR(name,type) PL_ ## name = slot->name;
540 # include "state.h"
541 #undef VAR
542
543 {
544 dSP;
545
546 CV *cv;
547
548 /* now do the ugly restore mess */
549 while (expect_true (cv = (CV *)POPs))
550 {
551 put_padlist (aTHX_ cv); /* mark this padlist as available */
552 CvDEPTH (cv) = PTR2IV (POPs);
553 CvPADLIST (cv) = (AV *)POPs;
554 }
555
556 PUTBACK;
557 }
558
559 slf_frame = c->slf_frame;
560 CORO_THROW = c->except;
561 }
562
563 static void
564 save_perl (pTHX_ Coro__State c)
565 {
566 c->except = CORO_THROW;
567 c->slf_frame = slf_frame;
568
569 {
570 dSP;
571 I32 cxix = cxstack_ix;
572 PERL_CONTEXT *ccstk = cxstack;
573 PERL_SI *top_si = PL_curstackinfo;
574
575 /*
576 * the worst thing you can imagine happens first - we have to save
577 * (and reinitialize) all cv's in the whole callchain :(
578 */
579
580 XPUSHs (Nullsv);
581 /* this loop was inspired by pp_caller */
582 for (;;)
583 {
584 while (expect_true (cxix >= 0))
585 {
586 PERL_CONTEXT *cx = &ccstk[cxix--];
587
588 if (expect_true (CxTYPE (cx) == CXt_SUB || CxTYPE (cx) == CXt_FORMAT))
589 {
590 CV *cv = cx->blk_sub.cv;
591
592 if (expect_true (CvDEPTH (cv)))
593 {
594 EXTEND (SP, 3);
595 PUSHs ((SV *)CvPADLIST (cv));
596 PUSHs (INT2PTR (SV *, (IV)CvDEPTH (cv)));
597 PUSHs ((SV *)cv);
598
599 CvDEPTH (cv) = 0;
600 get_padlist (aTHX_ cv);
601 }
602 }
603 }
604
605 if (expect_true (top_si->si_type == PERLSI_MAIN))
606 break;
607
608 top_si = top_si->si_prev;
609 ccstk = top_si->si_cxstack;
610 cxix = top_si->si_cxix;
611 }
612
613 PUTBACK;
614 }
615
616 /* allocate some space on the context stack for our purposes */
617 /* we manually unroll here, as usually 2 slots is enough */
618 if (SLOT_COUNT >= 1) CXINC;
619 if (SLOT_COUNT >= 2) CXINC;
620 if (SLOT_COUNT >= 3) CXINC;
621 {
622 int i;
623 for (i = 3; i < SLOT_COUNT; ++i)
624 CXINC;
625 }
626 cxstack_ix -= SLOT_COUNT; /* undo allocation */
627
628 c->mainstack = PL_mainstack;
629
630 {
631 perl_slots *slot = c->slot = (perl_slots *)(cxstack + cxstack_ix + 1);
632
633 slot->defav = GvAV (PL_defgv);
634 slot->defsv = DEFSV;
635 slot->errsv = ERRSV;
636 slot->irsgv = GvSV (irsgv);
637 slot->hinthv = GvHV (PL_hintgv);
638
639 #define VAR(name,type) slot->name = PL_ ## name;
640 # include "state.h"
641 #undef VAR
642 }
643 }
644
645 /*
646 * allocate various perl stacks. This is almost an exact copy
647 * of perl.c:init_stacks, except that it uses less memory
648 * on the (sometimes correct) assumption that coroutines do
649 * not usually need a lot of stackspace.
650 */
651 #if CORO_PREFER_PERL_FUNCTIONS
652 # define coro_init_stacks(thx) init_stacks ()
653 #else
654 static void
655 coro_init_stacks (pTHX)
656 {
657 PL_curstackinfo = new_stackinfo(32, 8);
658 PL_curstackinfo->si_type = PERLSI_MAIN;
659 PL_curstack = PL_curstackinfo->si_stack;
660 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
661
662 PL_stack_base = AvARRAY(PL_curstack);
663 PL_stack_sp = PL_stack_base;
664 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
665
666 New(50,PL_tmps_stack,32,SV*);
667 PL_tmps_floor = -1;
668 PL_tmps_ix = -1;
669 PL_tmps_max = 32;
670
671 New(54,PL_markstack,16,I32);
672 PL_markstack_ptr = PL_markstack;
673 PL_markstack_max = PL_markstack + 16;
674
675 #ifdef SET_MARK_OFFSET
676 SET_MARK_OFFSET;
677 #endif
678
679 New(54,PL_scopestack,8,I32);
680 PL_scopestack_ix = 0;
681 PL_scopestack_max = 8;
682
683 New(54,PL_savestack,24,ANY);
684 PL_savestack_ix = 0;
685 PL_savestack_max = 24;
686
687 #if !PERL_VERSION_ATLEAST (5,10,0)
688 New(54,PL_retstack,4,OP*);
689 PL_retstack_ix = 0;
690 PL_retstack_max = 4;
691 #endif
692 }
693 #endif
694
695 /*
696 * destroy the stacks, the callchain etc...
697 */
698 static void
699 coro_destruct_stacks (pTHX)
700 {
701 while (PL_curstackinfo->si_next)
702 PL_curstackinfo = PL_curstackinfo->si_next;
703
704 while (PL_curstackinfo)
705 {
706 PERL_SI *p = PL_curstackinfo->si_prev;
707
708 if (!IN_DESTRUCT)
709 SvREFCNT_dec (PL_curstackinfo->si_stack);
710
711 Safefree (PL_curstackinfo->si_cxstack);
712 Safefree (PL_curstackinfo);
713 PL_curstackinfo = p;
714 }
715
716 Safefree (PL_tmps_stack);
717 Safefree (PL_markstack);
718 Safefree (PL_scopestack);
719 Safefree (PL_savestack);
720 #if !PERL_VERSION_ATLEAST (5,10,0)
721 Safefree (PL_retstack);
722 #endif
723 }
724
725 #define CORO_RSS \
726 rss += sizeof (SYM (curstackinfo)); \
727 rss += (SYM (curstackinfo->si_cxmax) + 1) * sizeof (PERL_CONTEXT); \
728 rss += sizeof (SV) + sizeof (struct xpvav) + (1 + AvMAX (SYM (curstack))) * sizeof (SV *); \
729 rss += SYM (tmps_max) * sizeof (SV *); \
730 rss += (SYM (markstack_max) - SYM (markstack_ptr)) * sizeof (I32); \
731 rss += SYM (scopestack_max) * sizeof (I32); \
732 rss += SYM (savestack_max) * sizeof (ANY);
733
734 static size_t
735 coro_rss (pTHX_ struct coro *coro)
736 {
737 size_t rss = sizeof (*coro);
738
739 if (coro->mainstack)
740 {
741 if (coro->flags & CF_RUNNING)
742 {
743 #define SYM(sym) PL_ ## sym
744 CORO_RSS;
745 #undef SYM
746 }
747 else
748 {
749 #define SYM(sym) coro->slot->sym
750 CORO_RSS;
751 #undef SYM
752 }
753 }
754
755 return rss;
756 }
757
758 /** coroutine stack handling ************************************************/
759
760 static int (*orig_sigelem_get) (pTHX_ SV *sv, MAGIC *mg);
761 static int (*orig_sigelem_set) (pTHX_ SV *sv, MAGIC *mg);
762 static int (*orig_sigelem_clr) (pTHX_ SV *sv, MAGIC *mg);
763
764 /* apparently < 5.8.8 */
765 #ifndef MgPV_nolen_const
766 #define MgPV_nolen_const(mg) (((((int)(mg)->mg_len)) == HEf_SVKEY) ? \
767 SvPV_nolen((SV*)((mg)->mg_ptr)) : \
768 (const char*)(mg)->mg_ptr)
769 #endif
770
771 /*
772 * This overrides the default magic get method of %SIG elements.
773 * The original one doesn't provide for reading back of PL_diehook/PL_warnhook
774 * and instead of tryign to save and restore the hash elements, we just provide
775 * readback here.
776 * We only do this when the hook is != 0, as they are often set to 0 temporarily,
777 * not expecting this to actually change the hook. This is a potential problem
778 * when a schedule happens then, but we ignore this.
779 */
780 static int
781 coro_sigelem_get (pTHX_ SV *sv, MAGIC *mg)
782 {
783 const char *s = MgPV_nolen_const (mg);
784
785 if (*s == '_')
786 {
787 SV **svp = 0;
788
789 if (strEQ (s, "__DIE__" )) svp = &PL_diehook;
790 if (strEQ (s, "__WARN__")) svp = &PL_warnhook;
791
792 if (svp)
793 {
794 sv_setsv (sv, *svp ? *svp : &PL_sv_undef);
795 return 0;
796 }
797 }
798
799 return orig_sigelem_get ? orig_sigelem_get (aTHX_ sv, mg) : 0;
800 }
801
802 static int
803 coro_sigelem_clr (pTHX_ SV *sv, MAGIC *mg)
804 {
805 const char *s = MgPV_nolen_const (mg);
806
807 if (*s == '_')
808 {
809 SV **svp = 0;
810
811 if (strEQ (s, "__DIE__" )) svp = &PL_diehook;
812 if (strEQ (s, "__WARN__")) svp = &PL_warnhook;
813
814 if (svp)
815 {
816 SV *old = *svp;
817 *svp = 0;
818 SvREFCNT_dec (old);
819 return 0;
820 }
821 }
822
823 return orig_sigelem_clr ? orig_sigelem_clr (aTHX_ sv, mg) : 0;
824 }
825
826 static int
827 coro_sigelem_set (pTHX_ SV *sv, MAGIC *mg)
828 {
829 const char *s = MgPV_nolen_const (mg);
830
831 if (*s == '_')
832 {
833 SV **svp = 0;
834
835 if (strEQ (s, "__DIE__" )) svp = &PL_diehook;
836 if (strEQ (s, "__WARN__")) svp = &PL_warnhook;
837
838 if (svp)
839 {
840 SV *old = *svp;
841 *svp = newSVsv (sv);
842 SvREFCNT_dec (old);
843 return 0;
844 }
845 }
846
847 return orig_sigelem_set ? orig_sigelem_set (aTHX_ sv, mg) : 0;
848 }
849
850 static void
851 prepare_nop (pTHX_ struct coro_transfer_args *ta)
852 {
853 /* kind of mega-hacky, but works */
854 ta->next = ta->prev = (struct coro *)ta;
855 }
856
857 static int
858 slf_check_nop (pTHX_ struct CoroSLF *frame)
859 {
860 return 0;
861 }
862
863 static int
864 slf_check_repeat (pTHX_ struct CoroSLF *frame)
865 {
866 return 1;
867 }
868
869 static UNOP coro_setup_op;
870
871 static void NOINLINE /* noinline to keep it out of the transfer fast path */
872 coro_setup (pTHX_ struct coro *coro)
873 {
874 /*
875 * emulate part of the perl startup here.
876 */
877 coro_init_stacks (aTHX);
878
879 PL_runops = RUNOPS_DEFAULT;
880 PL_curcop = &PL_compiling;
881 PL_in_eval = EVAL_NULL;
882 PL_comppad = 0;
883 PL_comppad_name = 0;
884 PL_comppad_name_fill = 0;
885 PL_comppad_name_floor = 0;
886 PL_curpm = 0;
887 PL_curpad = 0;
888 PL_localizing = 0;
889 PL_dirty = 0;
890 PL_restartop = 0;
891 #if PERL_VERSION_ATLEAST (5,10,0)
892 PL_parser = 0;
893 #endif
894 PL_hints = 0;
895
896 /* recreate the die/warn hooks */
897 PL_diehook = 0; SvSetMagicSV (*hv_fetch (hv_sig, "__DIE__" , sizeof ("__DIE__" ) - 1, 1), rv_diehook );
898 PL_warnhook = 0; SvSetMagicSV (*hv_fetch (hv_sig, "__WARN__", sizeof ("__WARN__") - 1, 1), rv_warnhook);
899
900 GvSV (PL_defgv) = newSV (0);
901 GvAV (PL_defgv) = coro->args; coro->args = 0;
902 GvSV (PL_errgv) = newSV (0);
903 GvSV (irsgv) = newSVpvn ("\n", 1); sv_magic (GvSV (irsgv), (SV *)irsgv, PERL_MAGIC_sv, "/", 0);
904 GvHV (PL_hintgv) = 0;
905 PL_rs = newSVsv (GvSV (irsgv));
906 PL_defoutgv = (GV *)SvREFCNT_inc_NN (stdoutgv);
907
908 {
909 dSP;
910 UNOP myop;
911
912 Zero (&myop, 1, UNOP);
913 myop.op_next = Nullop;
914 myop.op_type = OP_ENTERSUB;
915 myop.op_flags = OPf_WANT_VOID;
916
917 PUSHMARK (SP);
918 PUSHs ((SV *)coro->startcv);
919 PUTBACK;
920 PL_op = (OP *)&myop;
921 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX);
922 }
923
924 /* this newly created coroutine might be run on an existing cctx which most
925 * likely was suspended in pp_slf, so we have to emulate entering pp_slf here.
926 */
927 slf_frame.prepare = prepare_nop; /* provide a nop function for an eventual pp_slf */
928 slf_frame.check = slf_check_nop; /* signal pp_slf to not repeat */
929
930 /* and we have to provide the pp_slf op in any case, so pp_slf can skip it */
931 coro_setup_op.op_next = PL_op;
932 coro_setup_op.op_type = OP_ENTERSUB;
933 coro_setup_op.op_ppaddr = pp_slf;
934 /* no flags etc. required, as an init function won't be called */
935
936 PL_op = (OP *)&coro_setup_op;
937
938 /* copy throw, in case it was set before coro_setup */
939 CORO_THROW = coro->except;
940 }
941
942 static void
943 coro_destruct_perl (pTHX_ struct coro *coro)
944 {
945 if (!IN_DESTRUCT)
946 {
947 /* restore all saved variables and stuff */
948 LEAVE_SCOPE (0);
949 assert (PL_tmps_floor == -1);
950
951 /* free all temporaries */
952 FREETMPS;
953 assert (PL_tmps_ix == -1);
954
955 /* unwind all extra stacks */
956 POPSTACK_TO (PL_mainstack);
957
958 /* unwind main stack */
959 dounwind (-1);
960 }
961
962 SvREFCNT_dec (GvSV (PL_defgv));
963 SvREFCNT_dec (GvAV (PL_defgv));
964 SvREFCNT_dec (GvSV (PL_errgv));
965 SvREFCNT_dec (PL_defoutgv);
966 SvREFCNT_dec (PL_rs);
967 SvREFCNT_dec (GvSV (irsgv));
968 SvREFCNT_dec (GvHV (PL_hintgv));
969
970 SvREFCNT_dec (PL_diehook);
971 SvREFCNT_dec (PL_warnhook);
972
973 SvREFCNT_dec (coro->saved_deffh);
974 SvREFCNT_dec (coro->rouse_cb);
975 SvREFCNT_dec (coro->invoke_cb);
976 SvREFCNT_dec (coro->invoke_av);
977
978 coro_destruct_stacks (aTHX);
979 }
980
981 INLINE void
982 free_coro_mortal (pTHX)
983 {
984 if (expect_true (coro_mortal))
985 {
986 SvREFCNT_dec (coro_mortal);
987 coro_mortal = 0;
988 }
989 }
990
991 static int
992 runops_trace (pTHX)
993 {
994 COP *oldcop = 0;
995 int oldcxix = -2;
996
997 while ((PL_op = CALL_FPTR (PL_op->op_ppaddr) (aTHX)))
998 {
999 PERL_ASYNC_CHECK ();
1000
1001 if (cctx_current->flags & CC_TRACE_ALL)
1002 {
1003 if (PL_op->op_type == OP_LEAVESUB && cctx_current->flags & CC_TRACE_SUB)
1004 {
1005 PERL_CONTEXT *cx = &cxstack[cxstack_ix];
1006 SV **bot, **top;
1007 AV *av = newAV (); /* return values */
1008 SV **cb;
1009 dSP;
1010
1011 GV *gv = CvGV (cx->blk_sub.cv);
1012 SV *fullname = sv_2mortal (newSV (0));
1013 if (isGV (gv))
1014 gv_efullname3 (fullname, gv, 0);
1015
1016 bot = PL_stack_base + cx->blk_oldsp + 1;
1017 top = cx->blk_gimme == G_ARRAY ? SP + 1
1018 : cx->blk_gimme == G_SCALAR ? bot + 1
1019 : bot;
1020
1021 av_extend (av, top - bot);
1022 while (bot < top)
1023 av_push (av, SvREFCNT_inc_NN (*bot++));
1024
1025 PL_runops = RUNOPS_DEFAULT;
1026 ENTER;
1027 SAVETMPS;
1028 EXTEND (SP, 3);
1029 PUSHMARK (SP);
1030 PUSHs (&PL_sv_no);
1031 PUSHs (fullname);
1032 PUSHs (sv_2mortal (newRV_noinc ((SV *)av)));
1033 PUTBACK;
1034 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_sub_cb", sizeof ("_trace_sub_cb") - 1, 0);
1035 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
1036 SPAGAIN;
1037 FREETMPS;
1038 LEAVE;
1039 PL_runops = runops_trace;
1040 }
1041
1042 if (oldcop != PL_curcop)
1043 {
1044 oldcop = PL_curcop;
1045
1046 if (PL_curcop != &PL_compiling)
1047 {
1048 SV **cb;
1049
1050 if (oldcxix != cxstack_ix && cctx_current->flags & CC_TRACE_SUB)
1051 {
1052 PERL_CONTEXT *cx = &cxstack[cxstack_ix];
1053
1054 if (CxTYPE (cx) == CXt_SUB && oldcxix < cxstack_ix)
1055 {
1056 dSP;
1057 GV *gv = CvGV (cx->blk_sub.cv);
1058 SV *fullname = sv_2mortal (newSV (0));
1059
1060 if (isGV (gv))
1061 gv_efullname3 (fullname, gv, 0);
1062
1063 PL_runops = RUNOPS_DEFAULT;
1064 ENTER;
1065 SAVETMPS;
1066 EXTEND (SP, 3);
1067 PUSHMARK (SP);
1068 PUSHs (&PL_sv_yes);
1069 PUSHs (fullname);
1070 PUSHs (CxHASARGS (cx) ? sv_2mortal (newRV_inc ((SV *)cx->blk_sub.argarray)) : &PL_sv_undef);
1071 PUTBACK;
1072 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_sub_cb", sizeof ("_trace_sub_cb") - 1, 0);
1073 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
1074 SPAGAIN;
1075 FREETMPS;
1076 LEAVE;
1077 PL_runops = runops_trace;
1078 }
1079
1080 oldcxix = cxstack_ix;
1081 }
1082
1083 if (cctx_current->flags & CC_TRACE_LINE)
1084 {
1085 dSP;
1086
1087 PL_runops = RUNOPS_DEFAULT;
1088 ENTER;
1089 SAVETMPS;
1090 EXTEND (SP, 3);
1091 PL_runops = RUNOPS_DEFAULT;
1092 PUSHMARK (SP);
1093 PUSHs (sv_2mortal (newSVpv (OutCopFILE (oldcop), 0)));
1094 PUSHs (sv_2mortal (newSViv (CopLINE (oldcop))));
1095 PUTBACK;
1096 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_line_cb", sizeof ("_trace_line_cb") - 1, 0);
1097 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
1098 SPAGAIN;
1099 FREETMPS;
1100 LEAVE;
1101 PL_runops = runops_trace;
1102 }
1103 }
1104 }
1105 }
1106 }
1107
1108 TAINT_NOT;
1109 return 0;
1110 }
1111
1112 static struct CoroSLF cctx_ssl_frame;
1113
1114 static void
1115 slf_prepare_set_stacklevel (pTHX_ struct coro_transfer_args *ta)
1116 {
1117 ta->prev = 0;
1118 }
1119
1120 static int
1121 slf_check_set_stacklevel (pTHX_ struct CoroSLF *frame)
1122 {
1123 *frame = cctx_ssl_frame;
1124
1125 return frame->check (aTHX_ frame); /* execute the restored frame - there must be one */
1126 }
1127
1128 /* initialises PL_top_env and injects a pseudo-slf-call to set the stacklevel */
1129 static void NOINLINE
1130 cctx_prepare (pTHX)
1131 {
1132 PL_top_env = &PL_start_env;
1133
1134 if (cctx_current->flags & CC_TRACE)
1135 PL_runops = runops_trace;
1136
1137 /* we already must be executing an SLF op, there is no other valid way
1138 * that can lead to creation of a new cctx */
1139 assert (("FATAL: can't prepare slf-less cctx in Coro module (please report)",
1140 slf_frame.prepare && PL_op->op_ppaddr == pp_slf));
1141
1142 /* we must emulate leaving pp_slf, which is done inside slf_check_set_stacklevel */
1143 cctx_ssl_frame = slf_frame;
1144
1145 slf_frame.prepare = slf_prepare_set_stacklevel;
1146 slf_frame.check = slf_check_set_stacklevel;
1147 }
1148
1149 /* the tail of transfer: execute stuff we can only do after a transfer */
1150 INLINE void
1151 transfer_tail (pTHX)
1152 {
1153 free_coro_mortal (aTHX);
1154 }
1155
1156 /*
1157 * this is a _very_ stripped down perl interpreter ;)
1158 */
1159 static void
1160 cctx_run (void *arg)
1161 {
1162 #ifdef USE_ITHREADS
1163 # if CORO_PTHREAD
1164 PERL_SET_CONTEXT (coro_thx);
1165 # endif
1166 #endif
1167 {
1168 dTHX;
1169
1170 /* normally we would need to skip the entersub here */
1171 /* not doing so will re-execute it, which is exactly what we want */
1172 /* PL_nop = PL_nop->op_next */
1173
1174 /* inject a fake subroutine call to cctx_init */
1175 cctx_prepare (aTHX);
1176
1177 /* cctx_run is the alternative tail of transfer() */
1178 transfer_tail (aTHX);
1179
1180 /* somebody or something will hit me for both perl_run and PL_restartop */
1181 PL_restartop = PL_op;
1182 perl_run (PL_curinterp);
1183 /*
1184 * Unfortunately, there is no way to get at the return values of the
1185 * coro body here, as perl_run destroys these
1186 */
1187
1188 /*
1189 * If perl-run returns we assume exit() was being called or the coro
1190 * fell off the end, which seems to be the only valid (non-bug)
1191 * reason for perl_run to return. We try to exit by jumping to the
1192 * bootstrap-time "top" top_env, as we cannot restore the "main"
1193 * coroutine as Coro has no such concept.
1194 * This actually isn't valid with the pthread backend, but OSes requiring
1195 * that backend are too broken to do it in a standards-compliant way.
1196 */
1197 PL_top_env = main_top_env;
1198 JMPENV_JUMP (2); /* I do not feel well about the hardcoded 2 at all */
1199 }
1200 }
1201
1202 static coro_cctx *
1203 cctx_new ()
1204 {
1205 coro_cctx *cctx;
1206
1207 ++cctx_count;
1208 New (0, cctx, 1, coro_cctx);
1209
1210 cctx->gen = cctx_gen;
1211 cctx->flags = 0;
1212 cctx->idle_sp = 0; /* can be accessed by transfer between cctx_run and set_stacklevel, on throw */
1213
1214 return cctx;
1215 }
1216
1217 /* create a new cctx only suitable as source */
1218 static coro_cctx *
1219 cctx_new_empty ()
1220 {
1221 coro_cctx *cctx = cctx_new ();
1222
1223 cctx->sptr = 0;
1224 coro_create (&cctx->cctx, 0, 0, 0, 0);
1225
1226 return cctx;
1227 }
1228
1229 /* create a new cctx suitable as destination/running a perl interpreter */
1230 static coro_cctx *
1231 cctx_new_run ()
1232 {
1233 coro_cctx *cctx = cctx_new ();
1234 void *stack_start;
1235 size_t stack_size;
1236
1237 #if HAVE_MMAP
1238 cctx->ssize = ((cctx_stacksize * sizeof (long) + PAGESIZE - 1) / PAGESIZE + CORO_STACKGUARD) * PAGESIZE;
1239 /* mmap supposedly does allocate-on-write for us */
1240 cctx->sptr = mmap (0, cctx->ssize, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, 0, 0);
1241
1242 if (cctx->sptr != (void *)-1)
1243 {
1244 #if CORO_STACKGUARD
1245 mprotect (cctx->sptr, CORO_STACKGUARD * PAGESIZE, PROT_NONE);
1246 #endif
1247 stack_start = (char *)cctx->sptr + CORO_STACKGUARD * PAGESIZE;
1248 stack_size = cctx->ssize - CORO_STACKGUARD * PAGESIZE;
1249 cctx->flags |= CC_MAPPED;
1250 }
1251 else
1252 #endif
1253 {
1254 cctx->ssize = cctx_stacksize * (long)sizeof (long);
1255 New (0, cctx->sptr, cctx_stacksize, long);
1256
1257 if (!cctx->sptr)
1258 {
1259 perror ("FATAL: unable to allocate stack for coroutine, exiting.");
1260 _exit (EXIT_FAILURE);
1261 }
1262
1263 stack_start = cctx->sptr;
1264 stack_size = cctx->ssize;
1265 }
1266
1267 #if CORO_USE_VALGRIND
1268 cctx->valgrind_id = VALGRIND_STACK_REGISTER ((char *)stack_start, (char *)stack_start + stack_size);
1269 #endif
1270
1271 coro_create (&cctx->cctx, cctx_run, (void *)cctx, stack_start, stack_size);
1272
1273 return cctx;
1274 }
1275
1276 static void
1277 cctx_destroy (coro_cctx *cctx)
1278 {
1279 if (!cctx)
1280 return;
1281
1282 assert (("FATAL: tried to destroy current cctx", cctx != cctx_current));//D temporary?
1283
1284 --cctx_count;
1285 coro_destroy (&cctx->cctx);
1286
1287 /* coro_transfer creates new, empty cctx's */
1288 if (cctx->sptr)
1289 {
1290 #if CORO_USE_VALGRIND
1291 VALGRIND_STACK_DEREGISTER (cctx->valgrind_id);
1292 #endif
1293
1294 #if HAVE_MMAP
1295 if (cctx->flags & CC_MAPPED)
1296 munmap (cctx->sptr, cctx->ssize);
1297 else
1298 #endif
1299 Safefree (cctx->sptr);
1300 }
1301
1302 Safefree (cctx);
1303 }
1304
1305 /* wether this cctx should be destructed */
1306 #define CCTX_EXPIRED(cctx) ((cctx)->gen != cctx_gen || ((cctx)->flags & CC_NOREUSE))
1307
1308 static coro_cctx *
1309 cctx_get (pTHX)
1310 {
1311 while (expect_true (cctx_first))
1312 {
1313 coro_cctx *cctx = cctx_first;
1314 cctx_first = cctx->next;
1315 --cctx_idle;
1316
1317 if (expect_true (!CCTX_EXPIRED (cctx)))
1318 return cctx;
1319
1320 cctx_destroy (cctx);
1321 }
1322
1323 return cctx_new_run ();
1324 }
1325
1326 static void
1327 cctx_put (coro_cctx *cctx)
1328 {
1329 assert (("FATAL: cctx_put called on non-initialised cctx in Coro (please report)", cctx->sptr));
1330
1331 /* free another cctx if overlimit */
1332 if (expect_false (cctx_idle >= cctx_max_idle))
1333 {
1334 coro_cctx *first = cctx_first;
1335 cctx_first = first->next;
1336 --cctx_idle;
1337
1338 cctx_destroy (first);
1339 }
1340
1341 ++cctx_idle;
1342 cctx->next = cctx_first;
1343 cctx_first = cctx;
1344 }
1345
1346 /** coroutine switching *****************************************************/
1347
1348 static void
1349 transfer_check (pTHX_ struct coro *prev, struct coro *next)
1350 {
1351 /* TODO: throwing up here is considered harmful */
1352
1353 if (expect_true (prev != next))
1354 {
1355 if (expect_false (!(prev->flags & (CF_RUNNING | CF_NEW))))
1356 croak ("Coro::State::transfer called with a suspended prev Coro::State, but can only transfer from running or new states,");
1357
1358 if (expect_false (next->flags & CF_RUNNING))
1359 croak ("Coro::State::transfer called with running next Coro::State, but can only transfer to inactive states,");
1360
1361 if (expect_false (next->flags & CF_DESTROYED))
1362 croak ("Coro::State::transfer called with destroyed next Coro::State, but can only transfer to inactive states,");
1363
1364 #if !PERL_VERSION_ATLEAST (5,10,0)
1365 if (expect_false (PL_lex_state != LEX_NOTPARSING))
1366 croak ("Coro::State::transfer called while parsing, but this is not supported in your perl version,");
1367 #endif
1368 }
1369 }
1370
1371 /* always use the TRANSFER macro */
1372 static void NOINLINE /* noinline so we have a fixed stackframe */
1373 transfer (pTHX_ struct coro *prev, struct coro *next, int force_cctx)
1374 {
1375 dSTACKLEVEL;
1376
1377 /* sometimes transfer is only called to set idle_sp */
1378 if (expect_false (!prev))
1379 {
1380 cctx_current->idle_sp = STACKLEVEL;
1381 assert (cctx_current->idle_te = PL_top_env); /* just for the side-effect when asserts are enabled */
1382 }
1383 else if (expect_true (prev != next))
1384 {
1385 coro_cctx *cctx_prev;
1386
1387 if (expect_false (prev->flags & CF_NEW))
1388 {
1389 /* create a new empty/source context */
1390 prev->flags &= ~CF_NEW;
1391 prev->flags |= CF_RUNNING;
1392 }
1393
1394 prev->flags &= ~CF_RUNNING;
1395 next->flags |= CF_RUNNING;
1396
1397 /* first get rid of the old state */
1398 save_perl (aTHX_ prev);
1399
1400 if (expect_false (next->flags & CF_NEW))
1401 {
1402 /* need to start coroutine */
1403 next->flags &= ~CF_NEW;
1404 /* setup coroutine call */
1405 coro_setup (aTHX_ next);
1406 }
1407 else
1408 load_perl (aTHX_ next);
1409
1410 /* possibly untie and reuse the cctx */
1411 if (expect_true (
1412 cctx_current->idle_sp == STACKLEVEL
1413 && !(cctx_current->flags & CC_TRACE)
1414 && !force_cctx
1415 ))
1416 {
1417 /* I assume that stacklevel is a stronger indicator than PL_top_env changes */
1418 assert (("FATAL: current top_env must equal previous top_env in Coro (please report)", PL_top_env == cctx_current->idle_te));
1419
1420 /* if the cctx is about to be destroyed we need to make sure we won't see it in cctx_get. */
1421 /* without this the next cctx_get might destroy the running cctx while still in use */
1422 if (expect_false (CCTX_EXPIRED (cctx_current)))
1423 if (expect_true (!next->cctx))
1424 next->cctx = cctx_get (aTHX);
1425
1426 cctx_put (cctx_current);
1427 }
1428 else
1429 prev->cctx = cctx_current;
1430
1431 ++next->usecount;
1432
1433 cctx_prev = cctx_current;
1434 cctx_current = expect_false (next->cctx) ? next->cctx : cctx_get (aTHX);
1435
1436 next->cctx = 0;
1437
1438 if (expect_false (cctx_prev != cctx_current))
1439 {
1440 cctx_prev->top_env = PL_top_env;
1441 PL_top_env = cctx_current->top_env;
1442 coro_transfer (&cctx_prev->cctx, &cctx_current->cctx);
1443 }
1444
1445 transfer_tail (aTHX);
1446 }
1447 }
1448
1449 #define TRANSFER(ta, force_cctx) transfer (aTHX_ (ta).prev, (ta).next, (force_cctx))
1450 #define TRANSFER_CHECK(ta) transfer_check (aTHX_ (ta).prev, (ta).next)
1451
1452 /** high level stuff ********************************************************/
1453
1454 static int
1455 coro_state_destroy (pTHX_ struct coro *coro)
1456 {
1457 if (coro->flags & CF_DESTROYED)
1458 return 0;
1459
1460 if (coro->on_destroy)
1461 coro->on_destroy (aTHX_ coro);
1462
1463 coro->flags |= CF_DESTROYED;
1464
1465 if (coro->flags & CF_READY)
1466 {
1467 /* reduce nready, as destroying a ready coro effectively unreadies it */
1468 /* alternative: look through all ready queues and remove the coro */
1469 --coro_nready;
1470 }
1471 else
1472 coro->flags |= CF_READY; /* make sure it is NOT put into the readyqueue */
1473
1474 if (coro->mainstack
1475 && coro->mainstack != main_mainstack
1476 && coro->slot
1477 && !PL_dirty)
1478 {
1479 struct coro temp;
1480
1481 assert (("FATAL: tried to destroy currently running coroutine", coro->mainstack != PL_mainstack));
1482
1483 save_perl (aTHX_ &temp);
1484 load_perl (aTHX_ coro);
1485
1486 coro_destruct_perl (aTHX_ coro);
1487
1488 load_perl (aTHX_ &temp);
1489
1490 coro->slot = 0;
1491 }
1492
1493 cctx_destroy (coro->cctx);
1494 SvREFCNT_dec (coro->startcv);
1495 SvREFCNT_dec (coro->args);
1496 SvREFCNT_dec (CORO_THROW);
1497
1498 if (coro->next) coro->next->prev = coro->prev;
1499 if (coro->prev) coro->prev->next = coro->next;
1500 if (coro == coro_first) coro_first = coro->next;
1501
1502 return 1;
1503 }
1504
1505 static int
1506 coro_state_free (pTHX_ SV *sv, MAGIC *mg)
1507 {
1508 struct coro *coro = (struct coro *)mg->mg_ptr;
1509 mg->mg_ptr = 0;
1510
1511 coro->hv = 0;
1512
1513 if (--coro->refcnt < 0)
1514 {
1515 coro_state_destroy (aTHX_ coro);
1516 Safefree (coro);
1517 }
1518
1519 return 0;
1520 }
1521
1522 static int
1523 coro_state_dup (pTHX_ MAGIC *mg, CLONE_PARAMS *params)
1524 {
1525 struct coro *coro = (struct coro *)mg->mg_ptr;
1526
1527 ++coro->refcnt;
1528
1529 return 0;
1530 }
1531
1532 static MGVTBL coro_state_vtbl = {
1533 0, 0, 0, 0,
1534 coro_state_free,
1535 0,
1536 #ifdef MGf_DUP
1537 coro_state_dup,
1538 #else
1539 # define MGf_DUP 0
1540 #endif
1541 };
1542
1543 static void
1544 prepare_transfer (pTHX_ struct coro_transfer_args *ta, SV *prev_sv, SV *next_sv)
1545 {
1546 ta->prev = SvSTATE (prev_sv);
1547 ta->next = SvSTATE (next_sv);
1548 TRANSFER_CHECK (*ta);
1549 }
1550
1551 static void
1552 api_transfer (pTHX_ SV *prev_sv, SV *next_sv)
1553 {
1554 struct coro_transfer_args ta;
1555
1556 prepare_transfer (aTHX_ &ta, prev_sv, next_sv);
1557 TRANSFER (ta, 1);
1558 }
1559
1560 /*****************************************************************************/
1561 /* gensub: simple closure generation utility */
1562
1563 #define GENSUB_ARG CvXSUBANY (cv).any_ptr
1564
1565 /* create a closure from XS, returns a code reference */
1566 /* the arg can be accessed via GENSUB_ARG from the callback */
1567 /* the callback must use dXSARGS/XSRETURN */
1568 static SV *
1569 gensub (pTHX_ void (*xsub)(pTHX_ CV *), void *arg)
1570 {
1571 CV *cv = (CV *)newSV (0);
1572
1573 sv_upgrade ((SV *)cv, SVt_PVCV);
1574
1575 CvANON_on (cv);
1576 CvISXSUB_on (cv);
1577 CvXSUB (cv) = xsub;
1578 GENSUB_ARG = arg;
1579
1580 return newRV_noinc ((SV *)cv);
1581 }
1582
1583 /** Coro ********************************************************************/
1584
1585 INLINE void
1586 coro_enq (pTHX_ struct coro *coro)
1587 {
1588 av_push (coro_ready [coro->prio - PRIO_MIN], SvREFCNT_inc_NN (coro->hv));
1589 }
1590
1591 INLINE SV *
1592 coro_deq (pTHX)
1593 {
1594 int prio;
1595
1596 for (prio = PRIO_MAX - PRIO_MIN + 1; --prio >= 0; )
1597 if (AvFILLp (coro_ready [prio]) >= 0)
1598 return av_shift (coro_ready [prio]);
1599
1600 return 0;
1601 }
1602
1603 static int
1604 api_ready (pTHX_ SV *coro_sv)
1605 {
1606 struct coro *coro;
1607 SV *sv_hook;
1608 void (*xs_hook)(void);
1609
1610 coro = SvSTATE (coro_sv);
1611
1612 if (coro->flags & CF_READY)
1613 return 0;
1614
1615 coro->flags |= CF_READY;
1616
1617 sv_hook = coro_nready ? 0 : coro_readyhook;
1618 xs_hook = coro_nready ? 0 : coroapi.readyhook;
1619
1620 coro_enq (aTHX_ coro);
1621 ++coro_nready;
1622
1623 if (sv_hook)
1624 {
1625 dSP;
1626
1627 ENTER;
1628 SAVETMPS;
1629
1630 PUSHMARK (SP);
1631 PUTBACK;
1632 call_sv (sv_hook, G_VOID | G_DISCARD);
1633
1634 FREETMPS;
1635 LEAVE;
1636 }
1637
1638 if (xs_hook)
1639 xs_hook ();
1640
1641 return 1;
1642 }
1643
1644 static int
1645 api_is_ready (pTHX_ SV *coro_sv)
1646 {
1647 return !!(SvSTATE (coro_sv)->flags & CF_READY);
1648 }
1649
1650 /* expects to own a reference to next->hv */
1651 INLINE void
1652 prepare_schedule_to (pTHX_ struct coro_transfer_args *ta, struct coro *next)
1653 {
1654 SV *prev_sv = SvRV (coro_current);
1655
1656 ta->prev = SvSTATE_hv (prev_sv);
1657 ta->next = next;
1658
1659 TRANSFER_CHECK (*ta);
1660
1661 SvRV_set (coro_current, (SV *)next->hv);
1662
1663 free_coro_mortal (aTHX);
1664 coro_mortal = prev_sv;
1665 }
1666
1667 static void
1668 prepare_schedule (pTHX_ struct coro_transfer_args *ta)
1669 {
1670 for (;;)
1671 {
1672 SV *next_sv = coro_deq (aTHX);
1673
1674 if (expect_true (next_sv))
1675 {
1676 struct coro *next = SvSTATE_hv (next_sv);
1677
1678 /* cannot transfer to destroyed coros, skip and look for next */
1679 if (expect_false (next->flags & CF_DESTROYED))
1680 SvREFCNT_dec (next_sv); /* coro_nready has already been taken care of by destroy */
1681 else
1682 {
1683 next->flags &= ~CF_READY;
1684 --coro_nready;
1685
1686 prepare_schedule_to (aTHX_ ta, next);
1687 break;
1688 }
1689 }
1690 else
1691 {
1692 /* nothing to schedule: call the idle handler */
1693 if (SvROK (sv_idle)
1694 && SvOBJECT (SvRV (sv_idle)))
1695 {
1696 ++coro_nready; /* hack so that api_ready doesn't invoke ready hook */
1697 api_ready (aTHX_ SvRV (sv_idle));
1698 --coro_nready;
1699 }
1700 else
1701 {
1702 dSP;
1703
1704 ENTER;
1705 SAVETMPS;
1706
1707 PUSHMARK (SP);
1708 PUTBACK;
1709 call_sv (sv_idle, G_VOID | G_DISCARD);
1710
1711 FREETMPS;
1712 LEAVE;
1713 }
1714 }
1715 }
1716 }
1717
1718 INLINE void
1719 prepare_cede (pTHX_ struct coro_transfer_args *ta)
1720 {
1721 api_ready (aTHX_ coro_current);
1722 prepare_schedule (aTHX_ ta);
1723 }
1724
1725 INLINE void
1726 prepare_cede_notself (pTHX_ struct coro_transfer_args *ta)
1727 {
1728 SV *prev = SvRV (coro_current);
1729
1730 if (coro_nready)
1731 {
1732 prepare_schedule (aTHX_ ta);
1733 api_ready (aTHX_ prev);
1734 }
1735 else
1736 prepare_nop (aTHX_ ta);
1737 }
1738
1739 static void
1740 api_schedule (pTHX)
1741 {
1742 struct coro_transfer_args ta;
1743
1744 prepare_schedule (aTHX_ &ta);
1745 TRANSFER (ta, 1);
1746 }
1747
1748 static void
1749 api_schedule_to (pTHX_ SV *coro_sv)
1750 {
1751 struct coro_transfer_args ta;
1752 struct coro *next = SvSTATE (coro_sv);
1753
1754 SvREFCNT_inc_NN (coro_sv);
1755 prepare_schedule_to (aTHX_ &ta, next);
1756 }
1757
1758 static int
1759 api_cede (pTHX)
1760 {
1761 struct coro_transfer_args ta;
1762
1763 prepare_cede (aTHX_ &ta);
1764
1765 if (expect_true (ta.prev != ta.next))
1766 {
1767 TRANSFER (ta, 1);
1768 return 1;
1769 }
1770 else
1771 return 0;
1772 }
1773
1774 static int
1775 api_cede_notself (pTHX)
1776 {
1777 if (coro_nready)
1778 {
1779 struct coro_transfer_args ta;
1780
1781 prepare_cede_notself (aTHX_ &ta);
1782 TRANSFER (ta, 1);
1783 return 1;
1784 }
1785 else
1786 return 0;
1787 }
1788
1789 static void
1790 api_trace (pTHX_ SV *coro_sv, int flags)
1791 {
1792 struct coro *coro = SvSTATE (coro_sv);
1793
1794 if (coro->flags & CF_RUNNING)
1795 croak ("cannot enable tracing on a running coroutine, caught");
1796
1797 if (flags & CC_TRACE)
1798 {
1799 if (!coro->cctx)
1800 coro->cctx = cctx_new_run ();
1801 else if (!(coro->cctx->flags & CC_TRACE))
1802 croak ("cannot enable tracing on coroutine with custom stack, caught");
1803
1804 coro->cctx->flags |= CC_NOREUSE | (flags & (CC_TRACE | CC_TRACE_ALL));
1805 }
1806 else if (coro->cctx && coro->cctx->flags & CC_TRACE)
1807 {
1808 coro->cctx->flags &= ~(CC_TRACE | CC_TRACE_ALL);
1809
1810 if (coro->flags & CF_RUNNING)
1811 PL_runops = RUNOPS_DEFAULT;
1812 else
1813 coro->slot->runops = RUNOPS_DEFAULT;
1814 }
1815 }
1816
1817 static void
1818 coro_call_on_destroy (pTHX_ struct coro *coro)
1819 {
1820 SV **on_destroyp = hv_fetch (coro->hv, "_on_destroy", sizeof ("_on_destroy") - 1, 0);
1821 SV **statusp = hv_fetch (coro->hv, "_status", sizeof ("_status") - 1, 0);
1822
1823 if (on_destroyp)
1824 {
1825 AV *on_destroy = (AV *)SvRV (*on_destroyp);
1826
1827 while (AvFILLp (on_destroy) >= 0)
1828 {
1829 dSP; /* don't disturb outer sp */
1830 SV *cb = av_pop (on_destroy);
1831
1832 PUSHMARK (SP);
1833
1834 if (statusp)
1835 {
1836 int i;
1837 AV *status = (AV *)SvRV (*statusp);
1838 EXTEND (SP, AvFILLp (status) + 1);
1839
1840 for (i = 0; i <= AvFILLp (status); ++i)
1841 PUSHs (AvARRAY (status)[i]);
1842 }
1843
1844 PUTBACK;
1845 call_sv (sv_2mortal (cb), G_VOID | G_DISCARD);
1846 }
1847 }
1848 }
1849
1850 static void
1851 slf_init_terminate (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
1852 {
1853 int i;
1854 HV *hv = (HV *)SvRV (coro_current);
1855 AV *av = newAV ();
1856
1857 av_extend (av, items - 1);
1858 for (i = 0; i < items; ++i)
1859 av_push (av, SvREFCNT_inc_NN (arg [i]));
1860
1861 hv_store (hv, "_status", sizeof ("_status") - 1, newRV_noinc ((SV *)av), 0);
1862
1863 av_push (av_destroy, (SV *)newRV_inc ((SV *)hv)); /* RVinc for perl */
1864 api_ready (aTHX_ sv_manager);
1865
1866 frame->prepare = prepare_schedule;
1867 frame->check = slf_check_repeat;
1868 }
1869
1870 /*****************************************************************************/
1871 /* async pool handler */
1872
1873 static int
1874 slf_check_pool_handler (pTHX_ struct CoroSLF *frame)
1875 {
1876 HV *hv = (HV *)SvRV (coro_current);
1877 struct coro *coro = (struct coro *)frame->data;
1878
1879 if (!coro->invoke_cb)
1880 return 1; /* loop till we have invoke */
1881 else
1882 {
1883 hv_store (hv, "desc", sizeof ("desc") - 1,
1884 newSVpvn ("[async_pool]", sizeof ("[async_pool]") - 1), 0);
1885
1886 coro->saved_deffh = SvREFCNT_inc_NN ((SV *)PL_defoutgv);
1887
1888 {
1889 dSP;
1890 XPUSHs (sv_2mortal (coro->invoke_cb)); coro->invoke_cb = 0;
1891 PUTBACK;
1892 }
1893
1894 SvREFCNT_dec (GvAV (PL_defgv));
1895 GvAV (PL_defgv) = coro->invoke_av;
1896 coro->invoke_av = 0;
1897
1898 return 0;
1899 }
1900 }
1901
1902 static void
1903 slf_init_pool_handler (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
1904 {
1905 HV *hv = (HV *)SvRV (coro_current);
1906 struct coro *coro = SvSTATE_hv ((SV *)hv);
1907
1908 if (expect_true (coro->saved_deffh))
1909 {
1910 /* subsequent iteration */
1911 SvREFCNT_dec ((SV *)PL_defoutgv); PL_defoutgv = (GV *)coro->saved_deffh;
1912 coro->saved_deffh = 0;
1913
1914 if (coro_rss (aTHX_ coro) > SvUV (sv_pool_rss)
1915 || av_len (av_async_pool) + 1 >= SvIV (sv_pool_size))
1916 {
1917 coro->invoke_cb = SvREFCNT_inc_NN ((SV *)cv_coro_terminate);
1918 coro->invoke_av = newAV ();
1919
1920 frame->prepare = prepare_nop;
1921 }
1922 else
1923 {
1924 av_clear (GvAV (PL_defgv));
1925 hv_store (hv, "desc", sizeof ("desc") - 1, SvREFCNT_inc_NN (sv_async_pool_idle), 0);
1926
1927 coro->prio = 0;
1928
1929 if (coro->cctx && (coro->cctx->flags & CC_TRACE))
1930 api_trace (aTHX_ coro_current, 0);
1931
1932 frame->prepare = prepare_schedule;
1933 av_push (av_async_pool, SvREFCNT_inc (hv));
1934 }
1935 }
1936 else
1937 {
1938 /* first iteration, simply fall through */
1939 frame->prepare = prepare_nop;
1940 }
1941
1942 frame->check = slf_check_pool_handler;
1943 frame->data = (void *)coro;
1944 }
1945
1946 /*****************************************************************************/
1947 /* rouse callback */
1948
1949 #define CORO_MAGIC_type_rouse PERL_MAGIC_ext
1950
1951 static void
1952 coro_rouse_callback (pTHX_ CV *cv)
1953 {
1954 dXSARGS;
1955 SV *data = (SV *)GENSUB_ARG;
1956
1957 if (SvTYPE (SvRV (data)) != SVt_PVAV)
1958 {
1959 /* first call, set args */
1960 AV *av = newAV ();
1961 SV *coro = SvRV (data);
1962
1963 SvRV_set (data, (SV *)av);
1964 api_ready (aTHX_ coro);
1965 SvREFCNT_dec (coro);
1966
1967 /* better take a full copy of the arguments */
1968 while (items--)
1969 av_store (av, items, newSVsv (ST (items)));
1970 }
1971
1972 XSRETURN_EMPTY;
1973 }
1974
1975 static int
1976 slf_check_rouse_wait (pTHX_ struct CoroSLF *frame)
1977 {
1978 SV *data = (SV *)frame->data;
1979
1980 if (CORO_THROW)
1981 return 0;
1982
1983 if (SvTYPE (SvRV (data)) != SVt_PVAV)
1984 return 1;
1985
1986 /* now push all results on the stack */
1987 {
1988 dSP;
1989 AV *av = (AV *)SvRV (data);
1990 int i;
1991
1992 EXTEND (SP, AvFILLp (av) + 1);
1993 for (i = 0; i <= AvFILLp (av); ++i)
1994 PUSHs (sv_2mortal (AvARRAY (av)[i]));
1995
1996 /* we have stolen the elements, so ste length to zero and free */
1997 AvFILLp (av) = -1;
1998 av_undef (av);
1999
2000 PUTBACK;
2001 }
2002
2003 return 0;
2004 }
2005
2006 static void
2007 slf_init_rouse_wait (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2008 {
2009 SV *cb;
2010
2011 if (items)
2012 cb = arg [0];
2013 else
2014 {
2015 struct coro *coro = SvSTATE_current;
2016
2017 if (!coro->rouse_cb)
2018 croak ("Coro::rouse_wait called without rouse callback, and no default rouse callback found either,");
2019
2020 cb = sv_2mortal (coro->rouse_cb);
2021 coro->rouse_cb = 0;
2022 }
2023
2024 if (!SvROK (cb)
2025 || SvTYPE (SvRV (cb)) != SVt_PVCV
2026 || CvXSUB ((CV *)SvRV (cb)) != coro_rouse_callback)
2027 croak ("Coro::rouse_wait called with illegal callback argument,");
2028
2029 {
2030 CV *cv = (CV *)SvRV (cb); /* for GENSUB_ARG */
2031 SV *data = (SV *)GENSUB_ARG;
2032
2033 frame->data = (void *)data;
2034 frame->prepare = SvTYPE (SvRV (data)) == SVt_PVAV ? prepare_nop : prepare_schedule;
2035 frame->check = slf_check_rouse_wait;
2036 }
2037 }
2038
2039 static SV *
2040 coro_new_rouse_cb (pTHX)
2041 {
2042 HV *hv = (HV *)SvRV (coro_current);
2043 struct coro *coro = SvSTATE_hv (hv);
2044 SV *data = newRV_inc ((SV *)hv);
2045 SV *cb = gensub (aTHX_ coro_rouse_callback, (void *)data);
2046
2047 sv_magicext (SvRV (cb), data, CORO_MAGIC_type_rouse, 0, 0, 0);
2048 SvREFCNT_dec (data); /* magicext increases the refcount */
2049
2050 SvREFCNT_dec (coro->rouse_cb);
2051 coro->rouse_cb = SvREFCNT_inc_NN (cb);
2052
2053 return cb;
2054 }
2055
2056 /*****************************************************************************/
2057 /* schedule-like-function opcode (SLF) */
2058
2059 static UNOP slf_restore; /* restore stack as entersub did, for first-re-run */
2060 static const CV *slf_cv;
2061 static SV **slf_argv;
2062 static int slf_argc, slf_arga; /* count, allocated */
2063 static I32 slf_ax; /* top of stack, for restore */
2064
2065 /* this restores the stack in the case we patched the entersub, to */
2066 /* recreate the stack frame as perl will on following calls */
2067 /* since entersub cleared the stack */
2068 static OP *
2069 pp_restore (pTHX)
2070 {
2071 int i;
2072 SV **SP = PL_stack_base + slf_ax;
2073
2074 PUSHMARK (SP);
2075
2076 EXTEND (SP, slf_argc + 1);
2077
2078 for (i = 0; i < slf_argc; ++i)
2079 PUSHs (sv_2mortal (slf_argv [i]));
2080
2081 PUSHs ((SV *)CvGV (slf_cv));
2082
2083 RETURNOP (slf_restore.op_first);
2084 }
2085
2086 static void
2087 slf_prepare_transfer (pTHX_ struct coro_transfer_args *ta)
2088 {
2089 SV **arg = (SV **)slf_frame.data;
2090
2091 prepare_transfer (aTHX_ ta, arg [0], arg [1]);
2092 }
2093
2094 static void
2095 slf_init_transfer (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2096 {
2097 if (items != 2)
2098 croak ("Coro::State::transfer (prev, next) expects two arguments, not %d,", items);
2099
2100 frame->prepare = slf_prepare_transfer;
2101 frame->check = slf_check_nop;
2102 frame->data = (void *)arg; /* let's hope it will stay valid */
2103 }
2104
2105 static void
2106 slf_init_schedule (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2107 {
2108 frame->prepare = prepare_schedule;
2109 frame->check = slf_check_nop;
2110 }
2111
2112 static void
2113 slf_prepare_schedule_to (pTHX_ struct coro_transfer_args *ta)
2114 {
2115 struct coro *next = (struct coro *)slf_frame.data;
2116
2117 SvREFCNT_inc_NN (next->hv);
2118 prepare_schedule_to (aTHX_ ta, next);
2119 }
2120
2121 static void
2122 slf_init_schedule_to (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2123 {
2124 if (!items)
2125 croak ("Coro::schedule_to expects a coroutine argument, caught");
2126
2127 frame->data = (void *)SvSTATE (arg [0]);
2128 frame->prepare = slf_prepare_schedule_to;
2129 frame->check = slf_check_nop;
2130 }
2131
2132 static void
2133 slf_init_cede_to (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2134 {
2135 api_ready (aTHX_ SvRV (coro_current));
2136
2137 slf_init_schedule_to (aTHX_ frame, cv, arg, items);
2138 }
2139
2140 static void
2141 slf_init_cede (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2142 {
2143 frame->prepare = prepare_cede;
2144 frame->check = slf_check_nop;
2145 }
2146
2147 static void
2148 slf_init_cede_notself (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2149 {
2150 frame->prepare = prepare_cede_notself;
2151 frame->check = slf_check_nop;
2152 }
2153
2154 /*
2155 * these not obviously related functions are all rolled into one
2156 * function to increase chances that they all will call transfer with the same
2157 * stack offset
2158 * SLF stands for "schedule-like-function".
2159 */
2160 static OP *
2161 pp_slf (pTHX)
2162 {
2163 I32 checkmark; /* mark SP to see how many elements check has pushed */
2164
2165 /* set up the slf frame, unless it has already been set-up */
2166 /* the latter happens when a new coro has been started */
2167 /* or when a new cctx was attached to an existing coroutine */
2168 if (expect_true (!slf_frame.prepare))
2169 {
2170 /* first iteration */
2171 dSP;
2172 SV **arg = PL_stack_base + TOPMARK + 1;
2173 int items = SP - arg; /* args without function object */
2174 SV *gv = *sp;
2175
2176 /* do a quick consistency check on the "function" object, and if it isn't */
2177 /* for us, divert to the real entersub */
2178 if (SvTYPE (gv) != SVt_PVGV
2179 || !GvCV (gv)
2180 || !(CvFLAGS (GvCV (gv)) & CVf_SLF))
2181 return PL_ppaddr[OP_ENTERSUB](aTHX);
2182
2183 if (!(PL_op->op_flags & OPf_STACKED))
2184 {
2185 /* ampersand-form of call, use @_ instead of stack */
2186 AV *av = GvAV (PL_defgv);
2187 arg = AvARRAY (av);
2188 items = AvFILLp (av) + 1;
2189 }
2190
2191 /* now call the init function, which needs to set up slf_frame */
2192 ((coro_slf_cb)CvXSUBANY (GvCV (gv)).any_ptr)
2193 (aTHX_ &slf_frame, GvCV (gv), arg, items);
2194
2195 /* pop args */
2196 SP = PL_stack_base + POPMARK;
2197
2198 PUTBACK;
2199 }
2200
2201 /* now that we have a slf_frame, interpret it! */
2202 /* we use a callback system not to make the code needlessly */
2203 /* complicated, but so we can run multiple perl coros from one cctx */
2204
2205 do
2206 {
2207 struct coro_transfer_args ta;
2208
2209 slf_frame.prepare (aTHX_ &ta);
2210 TRANSFER (ta, 0);
2211
2212 checkmark = PL_stack_sp - PL_stack_base;
2213 }
2214 while (slf_frame.check (aTHX_ &slf_frame));
2215
2216 slf_frame.prepare = 0; /* invalidate the frame, we are done processing it */
2217
2218 /* exception handling */
2219 if (expect_false (CORO_THROW))
2220 {
2221 SV *exception = sv_2mortal (CORO_THROW);
2222
2223 CORO_THROW = 0;
2224 sv_setsv (ERRSV, exception);
2225 croak (0);
2226 }
2227
2228 /* return value handling - mostly like entersub */
2229 /* make sure we put something on the stack in scalar context */
2230 if (GIMME_V == G_SCALAR)
2231 {
2232 dSP;
2233 SV **bot = PL_stack_base + checkmark;
2234
2235 if (sp == bot) /* too few, push undef */
2236 bot [1] = &PL_sv_undef;
2237 else if (sp != bot + 1) /* too many, take last one */
2238 bot [1] = *sp;
2239
2240 SP = bot + 1;
2241
2242 PUTBACK;
2243 }
2244
2245 return NORMAL;
2246 }
2247
2248 static void
2249 api_execute_slf (pTHX_ CV *cv, coro_slf_cb init_cb, I32 ax)
2250 {
2251 int i;
2252 SV **arg = PL_stack_base + ax;
2253 int items = PL_stack_sp - arg + 1;
2254
2255 assert (("FATAL: SLF call with illegal CV value", !CvANON (cv)));
2256
2257 if (PL_op->op_ppaddr != PL_ppaddr [OP_ENTERSUB]
2258 && PL_op->op_ppaddr != pp_slf)
2259 croak ("FATAL: Coro SLF calls can only be made normally, not via goto or any other means, caught");
2260
2261 CvFLAGS (cv) |= CVf_SLF;
2262 CvXSUBANY (cv).any_ptr = (void *)init_cb;
2263 slf_cv = cv;
2264
2265 /* we patch the op, and then re-run the whole call */
2266 /* we have to put the same argument on the stack for this to work */
2267 /* and this will be done by pp_restore */
2268 slf_restore.op_next = (OP *)&slf_restore;
2269 slf_restore.op_type = OP_CUSTOM;
2270 slf_restore.op_ppaddr = pp_restore;
2271 slf_restore.op_first = PL_op;
2272
2273 slf_ax = ax - 1; /* undo the ax++ inside dAXMARK */
2274
2275 if (PL_op->op_flags & OPf_STACKED)
2276 {
2277 if (items > slf_arga)
2278 {
2279 slf_arga = items;
2280 free (slf_argv);
2281 slf_argv = malloc (slf_arga * sizeof (SV *));
2282 }
2283
2284 slf_argc = items;
2285
2286 for (i = 0; i < items; ++i)
2287 slf_argv [i] = SvREFCNT_inc (arg [i]);
2288 }
2289 else
2290 slf_argc = 0;
2291
2292 PL_op->op_ppaddr = pp_slf;
2293 /*PL_op->op_type = OP_CUSTOM; /* we do behave like entersub still */
2294
2295 PL_op = (OP *)&slf_restore;
2296 }
2297
2298 /*****************************************************************************/
2299 /* PerlIO::cede */
2300
2301 typedef struct
2302 {
2303 PerlIOBuf base;
2304 NV next, every;
2305 } PerlIOCede;
2306
2307 static IV
2308 PerlIOCede_pushed (pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2309 {
2310 PerlIOCede *self = PerlIOSelf (f, PerlIOCede);
2311
2312 self->every = SvCUR (arg) ? SvNV (arg) : 0.01;
2313 self->next = nvtime () + self->every;
2314
2315 return PerlIOBuf_pushed (aTHX_ f, mode, Nullsv, tab);
2316 }
2317
2318 static SV *
2319 PerlIOCede_getarg (pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
2320 {
2321 PerlIOCede *self = PerlIOSelf (f, PerlIOCede);
2322
2323 return newSVnv (self->every);
2324 }
2325
2326 static IV
2327 PerlIOCede_flush (pTHX_ PerlIO *f)
2328 {
2329 PerlIOCede *self = PerlIOSelf (f, PerlIOCede);
2330 double now = nvtime ();
2331
2332 if (now >= self->next)
2333 {
2334 api_cede (aTHX);
2335 self->next = now + self->every;
2336 }
2337
2338 return PerlIOBuf_flush (aTHX_ f);
2339 }
2340
2341 static PerlIO_funcs PerlIO_cede =
2342 {
2343 sizeof(PerlIO_funcs),
2344 "cede",
2345 sizeof(PerlIOCede),
2346 PERLIO_K_DESTRUCT | PERLIO_K_RAW,
2347 PerlIOCede_pushed,
2348 PerlIOBuf_popped,
2349 PerlIOBuf_open,
2350 PerlIOBase_binmode,
2351 PerlIOCede_getarg,
2352 PerlIOBase_fileno,
2353 PerlIOBuf_dup,
2354 PerlIOBuf_read,
2355 PerlIOBuf_unread,
2356 PerlIOBuf_write,
2357 PerlIOBuf_seek,
2358 PerlIOBuf_tell,
2359 PerlIOBuf_close,
2360 PerlIOCede_flush,
2361 PerlIOBuf_fill,
2362 PerlIOBase_eof,
2363 PerlIOBase_error,
2364 PerlIOBase_clearerr,
2365 PerlIOBase_setlinebuf,
2366 PerlIOBuf_get_base,
2367 PerlIOBuf_bufsiz,
2368 PerlIOBuf_get_ptr,
2369 PerlIOBuf_get_cnt,
2370 PerlIOBuf_set_ptrcnt,
2371 };
2372
2373 /*****************************************************************************/
2374 /* Coro::Semaphore & Coro::Signal */
2375
2376 static SV *
2377 coro_waitarray_new (pTHX_ int count)
2378 {
2379 /* a semaphore contains a counter IV in $sem->[0] and any waiters after that */
2380 AV *av = newAV ();
2381 SV **ary;
2382
2383 /* unfortunately, building manually saves memory */
2384 Newx (ary, 2, SV *);
2385 AvALLOC (av) = ary;
2386 #if PERL_VERSION_ATLEAST (5,10,0)
2387 AvARRAY (av) = ary;
2388 #else
2389 /* 5.8.8 needs this syntax instead of AvARRAY = ary, yet */
2390 /* -DDEBUGGING flags this as a bug, despite it perfectly working */
2391 SvPVX ((SV *)av) = (char *)ary;
2392 #endif
2393 AvMAX (av) = 1;
2394 AvFILLp (av) = 0;
2395 ary [0] = newSViv (count);
2396
2397 return newRV_noinc ((SV *)av);
2398 }
2399
2400 /* semaphore */
2401
2402 static void
2403 coro_semaphore_adjust (pTHX_ AV *av, IV adjust)
2404 {
2405 SV *count_sv = AvARRAY (av)[0];
2406 IV count = SvIVX (count_sv);
2407
2408 count += adjust;
2409 SvIVX (count_sv) = count;
2410
2411 /* now wake up as many waiters as are expected to lock */
2412 while (count > 0 && AvFILLp (av) > 0)
2413 {
2414 SV *cb;
2415
2416 /* swap first two elements so we can shift a waiter */
2417 AvARRAY (av)[0] = AvARRAY (av)[1];
2418 AvARRAY (av)[1] = count_sv;
2419 cb = av_shift (av);
2420
2421 if (SvOBJECT (cb))
2422 {
2423 api_ready (aTHX_ cb);
2424 --count;
2425 }
2426 else if (SvTYPE (cb) == SVt_PVCV)
2427 {
2428 dSP;
2429 PUSHMARK (SP);
2430 XPUSHs (sv_2mortal (newRV_inc ((SV *)av)));
2431 PUTBACK;
2432 call_sv (cb, G_VOID | G_DISCARD | G_EVAL | G_KEEPERR);
2433 }
2434
2435 SvREFCNT_dec (cb);
2436 }
2437 }
2438
2439 static void
2440 coro_semaphore_on_destroy (pTHX_ struct coro *coro)
2441 {
2442 /* call $sem->adjust (0) to possibly wake up some other waiters */
2443 coro_semaphore_adjust (aTHX_ (AV *)coro->slf_frame.data, 0);
2444 }
2445
2446 static int
2447 slf_check_semaphore_down_or_wait (pTHX_ struct CoroSLF *frame, int acquire)
2448 {
2449 AV *av = (AV *)frame->data;
2450 SV *count_sv = AvARRAY (av)[0];
2451
2452 /* if we are about to throw, don't actually acquire the lock, just throw */
2453 if (CORO_THROW)
2454 return 0;
2455 else if (SvIVX (count_sv) > 0)
2456 {
2457 SvSTATE_current->on_destroy = 0;
2458
2459 if (acquire)
2460 SvIVX (count_sv) = SvIVX (count_sv) - 1;
2461 else
2462 coro_semaphore_adjust (aTHX_ av, 0);
2463
2464 return 0;
2465 }
2466 else
2467 {
2468 int i;
2469 /* if we were woken up but can't down, we look through the whole */
2470 /* waiters list and only add us if we aren't in there already */
2471 /* this avoids some degenerate memory usage cases */
2472
2473 for (i = 1; i <= AvFILLp (av); ++i)
2474 if (AvARRAY (av)[i] == SvRV (coro_current))
2475 return 1;
2476
2477 av_push (av, SvREFCNT_inc (SvRV (coro_current)));
2478 return 1;
2479 }
2480 }
2481
2482 static int
2483 slf_check_semaphore_down (pTHX_ struct CoroSLF *frame)
2484 {
2485 return slf_check_semaphore_down_or_wait (aTHX_ frame, 1);
2486 }
2487
2488 static int
2489 slf_check_semaphore_wait (pTHX_ struct CoroSLF *frame)
2490 {
2491 return slf_check_semaphore_down_or_wait (aTHX_ frame, 0);
2492 }
2493
2494 static void
2495 slf_init_semaphore_down_or_wait (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2496 {
2497 AV *av = (AV *)SvRV (arg [0]);
2498
2499 if (SvIVX (AvARRAY (av)[0]) > 0)
2500 {
2501 frame->data = (void *)av;
2502 frame->prepare = prepare_nop;
2503 }
2504 else
2505 {
2506 av_push (av, SvREFCNT_inc (SvRV (coro_current)));
2507
2508 frame->data = (void *)sv_2mortal (SvREFCNT_inc ((SV *)av));
2509 frame->prepare = prepare_schedule;
2510
2511 /* to avoid race conditions when a woken-up coro gets terminated */
2512 /* we arrange for a temporary on_destroy that calls adjust (0) */
2513 SvSTATE_current->on_destroy = coro_semaphore_on_destroy;
2514 }
2515 }
2516
2517 static void
2518 slf_init_semaphore_down (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2519 {
2520 slf_init_semaphore_down_or_wait (aTHX_ frame, cv, arg, items);
2521 frame->check = slf_check_semaphore_down;
2522 }
2523
2524 static void
2525 slf_init_semaphore_wait (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2526 {
2527 if (items >= 2)
2528 {
2529 /* callback form */
2530 AV *av = (AV *)SvRV (arg [0]);
2531 CV *cb_cv = coro_sv_2cv (aTHX_ arg [1]);
2532
2533 av_push (av, (SV *)SvREFCNT_inc_NN (cb_cv));
2534
2535 if (SvIVX (AvARRAY (av)[0]) > 0)
2536 coro_semaphore_adjust (aTHX_ av, 0);
2537
2538 frame->prepare = prepare_nop;
2539 frame->check = slf_check_nop;
2540 }
2541 else
2542 {
2543 slf_init_semaphore_down_or_wait (aTHX_ frame, cv, arg, items);
2544 frame->check = slf_check_semaphore_wait;
2545 }
2546 }
2547
2548 /* signal */
2549
2550 static void
2551 coro_signal_wake (pTHX_ AV *av, int count)
2552 {
2553 SvIVX (AvARRAY (av)[0]) = 0;
2554
2555 /* now signal count waiters */
2556 while (count > 0 && AvFILLp (av) > 0)
2557 {
2558 SV *cb;
2559
2560 /* swap first two elements so we can shift a waiter */
2561 cb = AvARRAY (av)[0];
2562 AvARRAY (av)[0] = AvARRAY (av)[1];
2563 AvARRAY (av)[1] = cb;
2564
2565 cb = av_shift (av);
2566
2567 api_ready (aTHX_ cb);
2568 sv_setiv (cb, 0); /* signal waiter */
2569 SvREFCNT_dec (cb);
2570
2571 --count;
2572 }
2573 }
2574
2575 static int
2576 slf_check_signal_wait (pTHX_ struct CoroSLF *frame)
2577 {
2578 /* if we are about to throw, also stop waiting */
2579 return SvROK ((SV *)frame->data) && !CORO_THROW;
2580 }
2581
2582 static void
2583 slf_init_signal_wait (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2584 {
2585 AV *av = (AV *)SvRV (arg [0]);
2586
2587 if (SvIVX (AvARRAY (av)[0]))
2588 {
2589 SvIVX (AvARRAY (av)[0]) = 0;
2590 frame->prepare = prepare_nop;
2591 frame->check = slf_check_nop;
2592 }
2593 else
2594 {
2595 SV *waiter = newRV_inc (SvRV (coro_current)); /* owned by signal av */
2596
2597 av_push (av, waiter);
2598
2599 frame->data = (void *)sv_2mortal (SvREFCNT_inc_NN (waiter)); /* owned by process */
2600 frame->prepare = prepare_schedule;
2601 frame->check = slf_check_signal_wait;
2602 }
2603 }
2604
2605 /*****************************************************************************/
2606 /* Coro::AIO */
2607
2608 #define CORO_MAGIC_type_aio PERL_MAGIC_ext
2609
2610 /* helper storage struct */
2611 struct io_state
2612 {
2613 int errorno;
2614 I32 laststype; /* U16 in 5.10.0 */
2615 int laststatval;
2616 Stat_t statcache;
2617 };
2618
2619 static void
2620 coro_aio_callback (pTHX_ CV *cv)
2621 {
2622 dXSARGS;
2623 AV *state = (AV *)GENSUB_ARG;
2624 SV *coro = av_pop (state);
2625 SV *data_sv = newSV (sizeof (struct io_state));
2626
2627 av_extend (state, items - 1);
2628
2629 sv_upgrade (data_sv, SVt_PV);
2630 SvCUR_set (data_sv, sizeof (struct io_state));
2631 SvPOK_only (data_sv);
2632
2633 {
2634 struct io_state *data = (struct io_state *)SvPVX (data_sv);
2635
2636 data->errorno = errno;
2637 data->laststype = PL_laststype;
2638 data->laststatval = PL_laststatval;
2639 data->statcache = PL_statcache;
2640 }
2641
2642 /* now build the result vector out of all the parameters and the data_sv */
2643 {
2644 int i;
2645
2646 for (i = 0; i < items; ++i)
2647 av_push (state, SvREFCNT_inc_NN (ST (i)));
2648 }
2649
2650 av_push (state, data_sv);
2651
2652 api_ready (aTHX_ coro);
2653 SvREFCNT_dec (coro);
2654 SvREFCNT_dec ((AV *)state);
2655 }
2656
2657 static int
2658 slf_check_aio_req (pTHX_ struct CoroSLF *frame)
2659 {
2660 AV *state = (AV *)frame->data;
2661
2662 /* if we are about to throw, return early */
2663 /* this does not cancel the aio request, but at least */
2664 /* it quickly returns */
2665 if (CORO_THROW)
2666 return 0;
2667
2668 /* one element that is an RV? repeat! */
2669 if (AvFILLp (state) == 0 && SvROK (AvARRAY (state)[0]))
2670 return 1;
2671
2672 /* restore status */
2673 {
2674 SV *data_sv = av_pop (state);
2675 struct io_state *data = (struct io_state *)SvPVX (data_sv);
2676
2677 errno = data->errorno;
2678 PL_laststype = data->laststype;
2679 PL_laststatval = data->laststatval;
2680 PL_statcache = data->statcache;
2681
2682 SvREFCNT_dec (data_sv);
2683 }
2684
2685 /* push result values */
2686 {
2687 dSP;
2688 int i;
2689
2690 EXTEND (SP, AvFILLp (state) + 1);
2691 for (i = 0; i <= AvFILLp (state); ++i)
2692 PUSHs (sv_2mortal (SvREFCNT_inc_NN (AvARRAY (state)[i])));
2693
2694 PUTBACK;
2695 }
2696
2697 return 0;
2698 }
2699
2700 static void
2701 slf_init_aio_req (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2702 {
2703 AV *state = (AV *)sv_2mortal ((SV *)newAV ());
2704 SV *coro_hv = SvRV (coro_current);
2705 struct coro *coro = SvSTATE_hv (coro_hv);
2706
2707 /* put our coroutine id on the state arg */
2708 av_push (state, SvREFCNT_inc_NN (coro_hv));
2709
2710 /* first see whether we have a non-zero priority and set it as AIO prio */
2711 if (coro->prio)
2712 {
2713 dSP;
2714
2715 static SV *prio_cv;
2716 static SV *prio_sv;
2717
2718 if (expect_false (!prio_cv))
2719 {
2720 prio_cv = (SV *)get_cv ("IO::AIO::aioreq_pri", 0);
2721 prio_sv = newSViv (0);
2722 }
2723
2724 PUSHMARK (SP);
2725 sv_setiv (prio_sv, coro->prio);
2726 XPUSHs (prio_sv);
2727
2728 PUTBACK;
2729 call_sv (prio_cv, G_VOID | G_DISCARD);
2730 }
2731
2732 /* now call the original request */
2733 {
2734 dSP;
2735 CV *req = (CV *)CORO_MAGIC_NN ((SV *)cv, CORO_MAGIC_type_aio)->mg_obj;
2736 int i;
2737
2738 PUSHMARK (SP);
2739
2740 /* first push all args to the stack */
2741 EXTEND (SP, items + 1);
2742
2743 for (i = 0; i < items; ++i)
2744 PUSHs (arg [i]);
2745
2746 /* now push the callback closure */
2747 PUSHs (sv_2mortal (gensub (aTHX_ coro_aio_callback, (void *)SvREFCNT_inc_NN ((SV *)state))));
2748
2749 /* now call the AIO function - we assume our request is uncancelable */
2750 PUTBACK;
2751 call_sv ((SV *)req, G_VOID | G_DISCARD);
2752 }
2753
2754 /* now that the requets is going, we loop toll we have a result */
2755 frame->data = (void *)state;
2756 frame->prepare = prepare_schedule;
2757 frame->check = slf_check_aio_req;
2758 }
2759
2760 static void
2761 coro_aio_req_xs (pTHX_ CV *cv)
2762 {
2763 dXSARGS;
2764
2765 CORO_EXECUTE_SLF_XS (slf_init_aio_req);
2766
2767 XSRETURN_EMPTY;
2768 }
2769
2770 /*****************************************************************************/
2771
2772 #if CORO_CLONE
2773 # include "clone.c"
2774 #endif
2775
2776 MODULE = Coro::State PACKAGE = Coro::State PREFIX = api_
2777
2778 PROTOTYPES: DISABLE
2779
2780 BOOT:
2781 {
2782 #ifdef USE_ITHREADS
2783 # if CORO_PTHREAD
2784 coro_thx = PERL_GET_CONTEXT;
2785 # endif
2786 #endif
2787 BOOT_PAGESIZE;
2788
2789 cctx_current = cctx_new_empty ();
2790
2791 irsgv = gv_fetchpv ("/" , GV_ADD|GV_NOTQUAL, SVt_PV);
2792 stdoutgv = gv_fetchpv ("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
2793
2794 orig_sigelem_get = PL_vtbl_sigelem.svt_get; PL_vtbl_sigelem.svt_get = coro_sigelem_get;
2795 orig_sigelem_set = PL_vtbl_sigelem.svt_set; PL_vtbl_sigelem.svt_set = coro_sigelem_set;
2796 orig_sigelem_clr = PL_vtbl_sigelem.svt_clear; PL_vtbl_sigelem.svt_clear = coro_sigelem_clr;
2797
2798 hv_sig = coro_get_hv (aTHX_ "SIG", TRUE);
2799 rv_diehook = newRV_inc ((SV *)gv_fetchpv ("Coro::State::diehook" , 0, SVt_PVCV));
2800 rv_warnhook = newRV_inc ((SV *)gv_fetchpv ("Coro::State::warnhook", 0, SVt_PVCV));
2801
2802 coro_state_stash = gv_stashpv ("Coro::State", TRUE);
2803
2804 newCONSTSUB (coro_state_stash, "CC_TRACE" , newSViv (CC_TRACE));
2805 newCONSTSUB (coro_state_stash, "CC_TRACE_SUB" , newSViv (CC_TRACE_SUB));
2806 newCONSTSUB (coro_state_stash, "CC_TRACE_LINE", newSViv (CC_TRACE_LINE));
2807 newCONSTSUB (coro_state_stash, "CC_TRACE_ALL" , newSViv (CC_TRACE_ALL));
2808
2809 main_mainstack = PL_mainstack;
2810 main_top_env = PL_top_env;
2811
2812 while (main_top_env->je_prev)
2813 main_top_env = main_top_env->je_prev;
2814
2815 {
2816 SV *slf = sv_2mortal (newSViv (PTR2IV (pp_slf)));
2817
2818 if (!PL_custom_op_names) PL_custom_op_names = newHV ();
2819 hv_store_ent (PL_custom_op_names, slf, newSVpv ("coro_slf", 0), 0);
2820
2821 if (!PL_custom_op_descs) PL_custom_op_descs = newHV ();
2822 hv_store_ent (PL_custom_op_descs, slf, newSVpv ("coro schedule like function", 0), 0);
2823 }
2824
2825 coroapi.ver = CORO_API_VERSION;
2826 coroapi.rev = CORO_API_REVISION;
2827
2828 coroapi.transfer = api_transfer;
2829
2830 coroapi.sv_state = SvSTATE_;
2831 coroapi.execute_slf = api_execute_slf;
2832 coroapi.prepare_nop = prepare_nop;
2833 coroapi.prepare_schedule = prepare_schedule;
2834 coroapi.prepare_cede = prepare_cede;
2835 coroapi.prepare_cede_notself = prepare_cede_notself;
2836
2837 {
2838 SV **svp = hv_fetch (PL_modglobal, "Time::NVtime", 12, 0);
2839
2840 if (!svp) croak ("Time::HiRes is required");
2841 if (!SvIOK (*svp)) croak ("Time::NVtime isn't a function pointer");
2842
2843 nvtime = INT2PTR (double (*)(), SvIV (*svp));
2844 }
2845
2846 assert (("PRIO_NORMAL must be 0", !PRIO_NORMAL));
2847 }
2848
2849 SV *
2850 new (char *klass, ...)
2851 ALIAS:
2852 Coro::new = 1
2853 CODE:
2854 {
2855 struct coro *coro;
2856 MAGIC *mg;
2857 HV *hv;
2858 CV *cb;
2859 int i;
2860
2861 if (items > 1)
2862 {
2863 cb = coro_sv_2cv (aTHX_ ST (1));
2864
2865 if (!ix)
2866 {
2867 if (CvISXSUB (cb))
2868 croak ("Coro::State doesn't support XS functions as coroutine start, caught");
2869
2870 if (!CvROOT (cb))
2871 croak ("Coro::State doesn't support autoloaded or undefined functions as coroutine start, caught");
2872 }
2873 }
2874
2875 Newz (0, coro, 1, struct coro);
2876 coro->args = newAV ();
2877 coro->flags = CF_NEW;
2878
2879 if (coro_first) coro_first->prev = coro;
2880 coro->next = coro_first;
2881 coro_first = coro;
2882
2883 coro->hv = hv = newHV ();
2884 mg = sv_magicext ((SV *)hv, 0, CORO_MAGIC_type_state, &coro_state_vtbl, (char *)coro, 0);
2885 mg->mg_flags |= MGf_DUP;
2886 RETVAL = sv_bless (newRV_noinc ((SV *)hv), gv_stashpv (klass, 1));
2887
2888 if (items > 1)
2889 {
2890 av_extend (coro->args, items - 1 + ix - 1);
2891
2892 if (ix)
2893 {
2894 av_push (coro->args, SvREFCNT_inc_NN ((SV *)cb));
2895 cb = cv_coro_run;
2896 }
2897
2898 coro->startcv = (CV *)SvREFCNT_inc_NN ((SV *)cb);
2899
2900 for (i = 2; i < items; i++)
2901 av_push (coro->args, newSVsv (ST (i)));
2902 }
2903 }
2904 OUTPUT:
2905 RETVAL
2906
2907 void
2908 transfer (...)
2909 PROTOTYPE: $$
2910 CODE:
2911 CORO_EXECUTE_SLF_XS (slf_init_transfer);
2912
2913 bool
2914 _destroy (SV *coro_sv)
2915 CODE:
2916 RETVAL = coro_state_destroy (aTHX_ SvSTATE (coro_sv));
2917 OUTPUT:
2918 RETVAL
2919
2920 void
2921 _exit (int code)
2922 PROTOTYPE: $
2923 CODE:
2924 _exit (code);
2925
2926 SV *
2927 clone (Coro::State coro)
2928 CODE:
2929 {
2930 #if CORO_CLONE
2931 struct coro *ncoro = coro_clone (aTHX_ coro);
2932 MAGIC *mg;
2933 /* TODO: too much duplication */
2934 ncoro->hv = newHV ();
2935 mg = sv_magicext ((SV *)ncoro->hv, 0, CORO_MAGIC_type_state, &coro_state_vtbl, (char *)ncoro, 0);
2936 mg->mg_flags |= MGf_DUP;
2937 RETVAL = sv_bless (newRV_noinc ((SV *)ncoro->hv), SvSTASH (coro->hv));
2938 #else
2939 croak ("Coro::State->clone has not been configured into this installation of Coro, realised");
2940 #endif
2941 }
2942 OUTPUT:
2943 RETVAL
2944
2945 int
2946 cctx_stacksize (int new_stacksize = 0)
2947 PROTOTYPE: ;$
2948 CODE:
2949 RETVAL = cctx_stacksize;
2950 if (new_stacksize)
2951 {
2952 cctx_stacksize = new_stacksize;
2953 ++cctx_gen;
2954 }
2955 OUTPUT:
2956 RETVAL
2957
2958 int
2959 cctx_max_idle (int max_idle = 0)
2960 PROTOTYPE: ;$
2961 CODE:
2962 RETVAL = cctx_max_idle;
2963 if (max_idle > 1)
2964 cctx_max_idle = max_idle;
2965 OUTPUT:
2966 RETVAL
2967
2968 int
2969 cctx_count ()
2970 PROTOTYPE:
2971 CODE:
2972 RETVAL = cctx_count;
2973 OUTPUT:
2974 RETVAL
2975
2976 int
2977 cctx_idle ()
2978 PROTOTYPE:
2979 CODE:
2980 RETVAL = cctx_idle;
2981 OUTPUT:
2982 RETVAL
2983
2984 void
2985 list ()
2986 PROTOTYPE:
2987 PPCODE:
2988 {
2989 struct coro *coro;
2990 for (coro = coro_first; coro; coro = coro->next)
2991 if (coro->hv)
2992 XPUSHs (sv_2mortal (newRV_inc ((SV *)coro->hv)));
2993 }
2994
2995 void
2996 call (Coro::State coro, SV *coderef)
2997 ALIAS:
2998 eval = 1
2999 CODE:
3000 {
3001 if (coro->mainstack && ((coro->flags & CF_RUNNING) || coro->slot))
3002 {
3003 struct coro temp;
3004
3005 if (!(coro->flags & CF_RUNNING))
3006 {
3007 PUTBACK;
3008 save_perl (aTHX_ &temp);
3009 load_perl (aTHX_ coro);
3010 }
3011
3012 {
3013 dSP;
3014 ENTER;
3015 SAVETMPS;
3016 PUTBACK;
3017 PUSHSTACK;
3018 PUSHMARK (SP);
3019
3020 if (ix)
3021 eval_sv (coderef, 0);
3022 else
3023 call_sv (coderef, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
3024
3025 POPSTACK;
3026 SPAGAIN;
3027 FREETMPS;
3028 LEAVE;
3029 PUTBACK;
3030 }
3031
3032 if (!(coro->flags & CF_RUNNING))
3033 {
3034 save_perl (aTHX_ coro);
3035 load_perl (aTHX_ &temp);
3036 SPAGAIN;
3037 }
3038 }
3039 }
3040
3041 SV *
3042 is_ready (Coro::State coro)
3043 PROTOTYPE: $
3044 ALIAS:
3045 is_ready = CF_READY
3046 is_running = CF_RUNNING
3047 is_new = CF_NEW
3048 is_destroyed = CF_DESTROYED
3049 CODE:
3050 RETVAL = boolSV (coro->flags & ix);
3051 OUTPUT:
3052 RETVAL
3053
3054 void
3055 throw (Coro::State self, SV *throw = &PL_sv_undef)
3056 PROTOTYPE: $;$
3057 CODE:
3058 {
3059 struct coro *current = SvSTATE_current;
3060 SV **throwp = self == current ? &CORO_THROW : &self->except;
3061 SvREFCNT_dec (*throwp);
3062 *throwp = SvOK (throw) ? newSVsv (throw) : 0;
3063 }
3064
3065 void
3066 api_trace (SV *coro, int flags = CC_TRACE | CC_TRACE_SUB)
3067 PROTOTYPE: $;$
3068 C_ARGS: aTHX_ coro, flags
3069
3070 SV *
3071 has_cctx (Coro::State coro)
3072 PROTOTYPE: $
3073 CODE:
3074 /* maybe manage the running flag differently */
3075 RETVAL = boolSV (!!coro->cctx || (coro->flags & CF_RUNNING));
3076 OUTPUT:
3077 RETVAL
3078
3079 int
3080 is_traced (Coro::State coro)
3081 PROTOTYPE: $
3082 CODE:
3083 RETVAL = (coro->cctx ? coro->cctx->flags : 0) & CC_TRACE_ALL;
3084 OUTPUT:
3085 RETVAL
3086
3087 UV
3088 rss (Coro::State coro)
3089 PROTOTYPE: $
3090 ALIAS:
3091 usecount = 1
3092 CODE:
3093 switch (ix)
3094 {
3095 case 0: RETVAL = coro_rss (aTHX_ coro); break;
3096 case 1: RETVAL = coro->usecount; break;
3097 }
3098 OUTPUT:
3099 RETVAL
3100
3101 void
3102 force_cctx ()
3103 PROTOTYPE:
3104 CODE:
3105 cctx_current->idle_sp = 0;
3106
3107 void
3108 swap_defsv (Coro::State self)
3109 PROTOTYPE: $
3110 ALIAS:
3111 swap_defav = 1
3112 CODE:
3113 if (!self->slot)
3114 croak ("cannot swap state with coroutine that has no saved state,");
3115 else
3116 {
3117 SV **src = ix ? (SV **)&GvAV (PL_defgv) : &GvSV (PL_defgv);
3118 SV **dst = ix ? (SV **)&self->slot->defav : (SV **)&self->slot->defsv;
3119
3120 SV *tmp = *src; *src = *dst; *dst = tmp;
3121 }
3122
3123
3124 MODULE = Coro::State PACKAGE = Coro
3125
3126 BOOT:
3127 {
3128 int i;
3129
3130 sv_pool_rss = coro_get_sv (aTHX_ "Coro::POOL_RSS" , TRUE);
3131 sv_pool_size = coro_get_sv (aTHX_ "Coro::POOL_SIZE" , TRUE);
3132 cv_coro_run = get_cv ( "Coro::_coro_run" , GV_ADD);
3133 cv_coro_terminate = get_cv ( "Coro::terminate" , GV_ADD);
3134 coro_current = coro_get_sv (aTHX_ "Coro::current" , FALSE); SvREADONLY_on (coro_current);
3135 av_async_pool = coro_get_av (aTHX_ "Coro::async_pool", TRUE);
3136 av_destroy = coro_get_av (aTHX_ "Coro::destroy" , TRUE);
3137 sv_manager = coro_get_sv (aTHX_ "Coro::manager" , TRUE);
3138 sv_idle = coro_get_sv (aTHX_ "Coro::idle" , TRUE);
3139
3140 sv_async_pool_idle = newSVpv ("[async pool idle]", 0); SvREADONLY_on (sv_async_pool_idle);
3141 sv_Coro = newSVpv ("Coro", 0); SvREADONLY_on (sv_Coro);
3142 cv_pool_handler = get_cv ("Coro::pool_handler", GV_ADD); SvREADONLY_on (cv_pool_handler);
3143 cv_coro_state_new = get_cv ("Coro::State::new", 0); SvREADONLY_on (cv_coro_state_new);
3144
3145 coro_stash = gv_stashpv ("Coro", TRUE);
3146
3147 newCONSTSUB (coro_stash, "PRIO_MAX", newSViv (PRIO_MAX));
3148 newCONSTSUB (coro_stash, "PRIO_HIGH", newSViv (PRIO_HIGH));
3149 newCONSTSUB (coro_stash, "PRIO_NORMAL", newSViv (PRIO_NORMAL));
3150 newCONSTSUB (coro_stash, "PRIO_LOW", newSViv (PRIO_LOW));
3151 newCONSTSUB (coro_stash, "PRIO_IDLE", newSViv (PRIO_IDLE));
3152 newCONSTSUB (coro_stash, "PRIO_MIN", newSViv (PRIO_MIN));
3153
3154 for (i = PRIO_MAX - PRIO_MIN + 1; i--; )
3155 coro_ready[i] = newAV ();
3156
3157 {
3158 SV *sv = coro_get_sv (aTHX_ "Coro::API", TRUE);
3159
3160 coroapi.schedule = api_schedule;
3161 coroapi.schedule_to = api_schedule_to;
3162 coroapi.cede = api_cede;
3163 coroapi.cede_notself = api_cede_notself;
3164 coroapi.ready = api_ready;
3165 coroapi.is_ready = api_is_ready;
3166 coroapi.nready = coro_nready;
3167 coroapi.current = coro_current;
3168
3169 /*GCoroAPI = &coroapi;*/
3170 sv_setiv (sv, (IV)&coroapi);
3171 SvREADONLY_on (sv);
3172 }
3173 }
3174
3175 void
3176 terminate (...)
3177 CODE:
3178 CORO_EXECUTE_SLF_XS (slf_init_terminate);
3179
3180 void
3181 schedule (...)
3182 CODE:
3183 CORO_EXECUTE_SLF_XS (slf_init_schedule);
3184
3185 void
3186 schedule_to (...)
3187 CODE:
3188 CORO_EXECUTE_SLF_XS (slf_init_schedule_to);
3189
3190 void
3191 cede_to (...)
3192 CODE:
3193 CORO_EXECUTE_SLF_XS (slf_init_cede_to);
3194
3195 void
3196 cede (...)
3197 CODE:
3198 CORO_EXECUTE_SLF_XS (slf_init_cede);
3199
3200 void
3201 cede_notself (...)
3202 CODE:
3203 CORO_EXECUTE_SLF_XS (slf_init_cede_notself);
3204
3205 void
3206 _cancel (Coro::State self)
3207 CODE:
3208 coro_state_destroy (aTHX_ self);
3209 coro_call_on_destroy (aTHX_ self);
3210
3211 void
3212 _set_current (SV *current)
3213 PROTOTYPE: $
3214 CODE:
3215 SvREFCNT_dec (SvRV (coro_current));
3216 SvRV_set (coro_current, SvREFCNT_inc_NN (SvRV (current)));
3217
3218 void
3219 _set_readyhook (SV *hook)
3220 PROTOTYPE: $
3221 CODE:
3222 SvREFCNT_dec (coro_readyhook);
3223 coro_readyhook = SvOK (hook) ? newSVsv (hook) : 0;
3224
3225 int
3226 prio (Coro::State coro, int newprio = 0)
3227 PROTOTYPE: $;$
3228 ALIAS:
3229 nice = 1
3230 CODE:
3231 {
3232 RETVAL = coro->prio;
3233
3234 if (items > 1)
3235 {
3236 if (ix)
3237 newprio = coro->prio - newprio;
3238
3239 if (newprio < PRIO_MIN) newprio = PRIO_MIN;
3240 if (newprio > PRIO_MAX) newprio = PRIO_MAX;
3241
3242 coro->prio = newprio;
3243 }
3244 }
3245 OUTPUT:
3246 RETVAL
3247
3248 SV *
3249 ready (SV *self)
3250 PROTOTYPE: $
3251 CODE:
3252 RETVAL = boolSV (api_ready (aTHX_ self));
3253 OUTPUT:
3254 RETVAL
3255
3256 int
3257 nready (...)
3258 PROTOTYPE:
3259 CODE:
3260 RETVAL = coro_nready;
3261 OUTPUT:
3262 RETVAL
3263
3264 void
3265 _pool_handler (...)
3266 CODE:
3267 CORO_EXECUTE_SLF_XS (slf_init_pool_handler);
3268
3269 void
3270 async_pool (SV *cv, ...)
3271 PROTOTYPE: &@
3272 PPCODE:
3273 {
3274 HV *hv = (HV *)av_pop (av_async_pool);
3275 AV *av = newAV ();
3276 SV *cb = ST (0);
3277 int i;
3278
3279 av_extend (av, items - 2);
3280 for (i = 1; i < items; ++i)
3281 av_push (av, SvREFCNT_inc_NN (ST (i)));
3282
3283 if ((SV *)hv == &PL_sv_undef)
3284 {
3285 PUSHMARK (SP);
3286 EXTEND (SP, 2);
3287 PUSHs (sv_Coro);
3288 PUSHs ((SV *)cv_pool_handler);
3289 PUTBACK;
3290 call_sv ((SV *)cv_coro_state_new, G_SCALAR);
3291 SPAGAIN;
3292
3293 hv = (HV *)SvREFCNT_inc_NN (SvRV (POPs));
3294 }
3295
3296 {
3297 struct coro *coro = SvSTATE_hv (hv);
3298
3299 assert (!coro->invoke_cb);
3300 assert (!coro->invoke_av);
3301 coro->invoke_cb = SvREFCNT_inc (cb);
3302 coro->invoke_av = av;
3303 }
3304
3305 api_ready (aTHX_ (SV *)hv);
3306
3307 if (GIMME_V != G_VOID)
3308 XPUSHs (sv_2mortal (newRV_noinc ((SV *)hv)));
3309 else
3310 SvREFCNT_dec (hv);
3311 }
3312
3313 SV *
3314 rouse_cb ()
3315 PROTOTYPE:
3316 CODE:
3317 RETVAL = coro_new_rouse_cb (aTHX);
3318 OUTPUT:
3319 RETVAL
3320
3321 void
3322 rouse_wait (...)
3323 PROTOTYPE: ;$
3324 PPCODE:
3325 CORO_EXECUTE_SLF_XS (slf_init_rouse_wait);
3326
3327
3328 MODULE = Coro::State PACKAGE = PerlIO::cede
3329
3330 BOOT:
3331 PerlIO_define_layer (aTHX_ &PerlIO_cede);
3332
3333
3334 MODULE = Coro::State PACKAGE = Coro::Semaphore
3335
3336 SV *
3337 new (SV *klass, SV *count = 0)
3338 CODE:
3339 RETVAL = sv_bless (
3340 coro_waitarray_new (aTHX_ count && SvOK (count) ? SvIV (count) : 1),
3341 GvSTASH (CvGV (cv))
3342 );
3343 OUTPUT:
3344 RETVAL
3345
3346 # helper for Coro::Channel
3347 SV *
3348 _alloc (int count)
3349 CODE:
3350 RETVAL = coro_waitarray_new (aTHX_ count);
3351 OUTPUT:
3352 RETVAL
3353
3354 SV *
3355 count (SV *self)
3356 CODE:
3357 RETVAL = newSVsv (AvARRAY ((AV *)SvRV (self))[0]);
3358 OUTPUT:
3359 RETVAL
3360
3361 void
3362 up (SV *self, int adjust = 1)
3363 ALIAS:
3364 adjust = 1
3365 CODE:
3366 coro_semaphore_adjust (aTHX_ (AV *)SvRV (self), ix ? adjust : 1);
3367
3368 void
3369 down (...)
3370 CODE:
3371 CORO_EXECUTE_SLF_XS (slf_init_semaphore_down);
3372
3373 void
3374 wait (...)
3375 CODE:
3376 CORO_EXECUTE_SLF_XS (slf_init_semaphore_wait);
3377
3378 void
3379 try (SV *self)
3380 PPCODE:
3381 {
3382 AV *av = (AV *)SvRV (self);
3383 SV *count_sv = AvARRAY (av)[0];
3384 IV count = SvIVX (count_sv);
3385
3386 if (count > 0)
3387 {
3388 --count;
3389 SvIVX (count_sv) = count;
3390 XSRETURN_YES;
3391 }
3392 else
3393 XSRETURN_NO;
3394 }
3395
3396 void
3397 waiters (SV *self)
3398 PPCODE:
3399 {
3400 AV *av = (AV *)SvRV (self);
3401 int wcount = AvFILLp (av) + 1 - 1;
3402
3403 if (GIMME_V == G_SCALAR)
3404 XPUSHs (sv_2mortal (newSViv (wcount)));
3405 else
3406 {
3407 int i;
3408 EXTEND (SP, wcount);
3409 for (i = 1; i <= wcount; ++i)
3410 PUSHs (sv_2mortal (newRV_inc (AvARRAY (av)[i])));
3411 }
3412 }
3413
3414 MODULE = Coro::State PACKAGE = Coro::Signal
3415
3416 SV *
3417 new (SV *klass)
3418 CODE:
3419 RETVAL = sv_bless (
3420 coro_waitarray_new (aTHX_ 0),
3421 GvSTASH (CvGV (cv))
3422 );
3423 OUTPUT:
3424 RETVAL
3425
3426 void
3427 wait (...)
3428 CODE:
3429 CORO_EXECUTE_SLF_XS (slf_init_signal_wait);
3430
3431 void
3432 broadcast (SV *self)
3433 CODE:
3434 {
3435 AV *av = (AV *)SvRV (self);
3436 coro_signal_wake (aTHX_ av, AvFILLp (av));
3437 }
3438
3439 void
3440 send (SV *self)
3441 CODE:
3442 {
3443 AV *av = (AV *)SvRV (self);
3444
3445 if (AvFILLp (av))
3446 coro_signal_wake (aTHX_ av, 1);
3447 else
3448 SvIVX (AvARRAY (av)[0]) = 1; /* remember the signal */
3449 }
3450
3451 IV
3452 awaited (SV *self)
3453 CODE:
3454 RETVAL = AvFILLp ((AV *)SvRV (self)) + 1 - 1;
3455 OUTPUT:
3456 RETVAL
3457
3458
3459 MODULE = Coro::State PACKAGE = Coro::AnyEvent
3460
3461 BOOT:
3462 sv_activity = coro_get_sv (aTHX_ "Coro::AnyEvent::ACTIVITY", TRUE);
3463
3464 void
3465 _schedule (...)
3466 CODE:
3467 {
3468 static int incede;
3469
3470 api_cede_notself (aTHX);
3471
3472 ++incede;
3473 while (coro_nready >= incede && api_cede (aTHX))
3474 ;
3475
3476 sv_setsv (sv_activity, &PL_sv_undef);
3477 if (coro_nready >= incede)
3478 {
3479 PUSHMARK (SP);
3480 PUTBACK;
3481 call_pv ("Coro::AnyEvent::_activity", G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
3482 }
3483
3484 --incede;
3485 }
3486
3487
3488 MODULE = Coro::State PACKAGE = Coro::AIO
3489
3490 void
3491 _register (char *target, char *proto, SV *req)
3492 CODE:
3493 {
3494 CV *req_cv = coro_sv_2cv (aTHX_ req);
3495 /* newXSproto doesn't return the CV on 5.8 */
3496 CV *slf_cv = newXS (target, coro_aio_req_xs, __FILE__);
3497 sv_setpv ((SV *)slf_cv, proto);
3498 sv_magicext ((SV *)slf_cv, (SV *)req_cv, CORO_MAGIC_type_aio, 0, 0, 0);
3499 }
3500