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