ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro/State.xs
Revision: 1.323
Committed: Sat Nov 22 06:03:10 2008 UTC (15 years, 5 months ago) by root
Branch: MAIN
Changes since 1.322: +7 -8 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 #include "libcoro/coro.c"
2
3 #define PERL_NO_GET_CONTEXT
4 #define PERL_EXT
5
6 #include "EXTERN.h"
7 #include "perl.h"
8 #include "XSUB.h"
9 #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
977 while ((PL_op = CALL_FPTR (PL_op->op_ppaddr) (aTHX)))
978 {
979 PERL_ASYNC_CHECK ();
980
981 if (cctx_current->flags & CC_TRACE_ALL)
982 {
983 if (PL_op->op_type == OP_LEAVESUB && cctx_current->flags & CC_TRACE_SUB)
984 {
985 PERL_CONTEXT *cx = &cxstack[cxstack_ix];
986 SV **bot, **top;
987 AV *av = newAV (); /* return values */
988 SV **cb;
989 dSP;
990
991 GV *gv = CvGV (cx->blk_sub.cv);
992 SV *fullname = sv_2mortal (newSV (0));
993 if (isGV (gv))
994 gv_efullname3 (fullname, gv, 0);
995
996 bot = PL_stack_base + cx->blk_oldsp + 1;
997 top = cx->blk_gimme == G_ARRAY ? SP + 1
998 : cx->blk_gimme == G_SCALAR ? bot + 1
999 : bot;
1000
1001 av_extend (av, top - bot);
1002 while (bot < top)
1003 av_push (av, SvREFCNT_inc_NN (*bot++));
1004
1005 PL_runops = RUNOPS_DEFAULT;
1006 ENTER;
1007 SAVETMPS;
1008 EXTEND (SP, 3);
1009 PUSHMARK (SP);
1010 PUSHs (&PL_sv_no);
1011 PUSHs (fullname);
1012 PUSHs (sv_2mortal (newRV_noinc ((SV *)av)));
1013 PUTBACK;
1014 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_sub_cb", sizeof ("_trace_sub_cb") - 1, 0);
1015 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
1016 SPAGAIN;
1017 FREETMPS;
1018 LEAVE;
1019 PL_runops = runops_trace;
1020 }
1021
1022 if (oldcop != PL_curcop)
1023 {
1024 oldcop = PL_curcop;
1025
1026 if (PL_curcop != &PL_compiling)
1027 {
1028 SV **cb;
1029
1030 if (oldcxix != cxstack_ix && cctx_current->flags & CC_TRACE_SUB)
1031 {
1032 PERL_CONTEXT *cx = &cxstack[cxstack_ix];
1033
1034 if (CxTYPE (cx) == CXt_SUB && oldcxix < cxstack_ix)
1035 {
1036 dSP;
1037 GV *gv = CvGV (cx->blk_sub.cv);
1038 SV *fullname = sv_2mortal (newSV (0));
1039
1040 if (isGV (gv))
1041 gv_efullname3 (fullname, gv, 0);
1042
1043 PL_runops = RUNOPS_DEFAULT;
1044 ENTER;
1045 SAVETMPS;
1046 EXTEND (SP, 3);
1047 PUSHMARK (SP);
1048 PUSHs (&PL_sv_yes);
1049 PUSHs (fullname);
1050 PUSHs (CxHASARGS (cx) ? sv_2mortal (newRV_inc ((SV *)cx->blk_sub.argarray)) : &PL_sv_undef);
1051 PUTBACK;
1052 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_sub_cb", sizeof ("_trace_sub_cb") - 1, 0);
1053 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
1054 SPAGAIN;
1055 FREETMPS;
1056 LEAVE;
1057 PL_runops = runops_trace;
1058 }
1059
1060 oldcxix = cxstack_ix;
1061 }
1062
1063 if (cctx_current->flags & CC_TRACE_LINE)
1064 {
1065 dSP;
1066
1067 PL_runops = RUNOPS_DEFAULT;
1068 ENTER;
1069 SAVETMPS;
1070 EXTEND (SP, 3);
1071 PL_runops = RUNOPS_DEFAULT;
1072 PUSHMARK (SP);
1073 PUSHs (sv_2mortal (newSVpv (OutCopFILE (oldcop), 0)));
1074 PUSHs (sv_2mortal (newSViv (CopLINE (oldcop))));
1075 PUTBACK;
1076 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_line_cb", sizeof ("_trace_line_cb") - 1, 0);
1077 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
1078 SPAGAIN;
1079 FREETMPS;
1080 LEAVE;
1081 PL_runops = runops_trace;
1082 }
1083 }
1084 }
1085 }
1086 }
1087
1088 TAINT_NOT;
1089 return 0;
1090 }
1091
1092 static struct CoroSLF cctx_ssl_frame;
1093
1094 static void
1095 slf_prepare_set_stacklevel (pTHX_ struct coro_transfer_args *ta)
1096 {
1097 ta->prev = 0;
1098 }
1099
1100 static int
1101 slf_check_set_stacklevel (pTHX_ struct CoroSLF *frame)
1102 {
1103 *frame = cctx_ssl_frame;
1104
1105 return frame->check (aTHX_ frame); /* execute the restored frame - there must be one */
1106 }
1107
1108 /* initialises PL_top_env and injects a pseudo-slf-call to set the stacklevel */
1109 static void NOINLINE
1110 cctx_prepare (pTHX)
1111 {
1112 PL_top_env = &PL_start_env;
1113
1114 if (cctx_current->flags & CC_TRACE)
1115 PL_runops = runops_trace;
1116
1117 /* we already must be executing an SLF op, there is no other valid way
1118 * that can lead to creation of a new cctx */
1119 assert (("FATAL: can't prepare slf-less cctx in Coro module (please report)",
1120 slf_frame.prepare && PL_op->op_ppaddr == pp_slf));
1121
1122 /* we must emulate leaving pp_slf, which is done inside slf_check_set_stacklevel */
1123 cctx_ssl_frame = slf_frame;
1124
1125 slf_frame.prepare = slf_prepare_set_stacklevel;
1126 slf_frame.check = slf_check_set_stacklevel;
1127 }
1128
1129 /* the tail of transfer: execute stuff we can only do after a transfer */
1130 INLINE void
1131 transfer_tail (pTHX)
1132 {
1133 free_coro_mortal (aTHX);
1134 }
1135
1136 /*
1137 * this is a _very_ stripped down perl interpreter ;)
1138 */
1139 static void
1140 cctx_run (void *arg)
1141 {
1142 #ifdef USE_ITHREADS
1143 # if CORO_PTHREAD
1144 PERL_SET_CONTEXT (coro_thx);
1145 # endif
1146 #endif
1147 {
1148 dTHX;
1149
1150 /* normally we would need to skip the entersub here */
1151 /* not doing so will re-execute it, which is exactly what we want */
1152 /* PL_nop = PL_nop->op_next */
1153
1154 /* inject a fake subroutine call to cctx_init */
1155 cctx_prepare (aTHX);
1156
1157 /* cctx_run is the alternative tail of transfer() */
1158 transfer_tail (aTHX);
1159
1160 /* somebody or something will hit me for both perl_run and PL_restartop */
1161 PL_restartop = PL_op;
1162 perl_run (PL_curinterp);
1163 /*
1164 * Unfortunately, there is no way to get at the return values of the
1165 * coro body here, as perl_run destroys these
1166 */
1167
1168 /*
1169 * If perl-run returns we assume exit() was being called or the coro
1170 * fell off the end, which seems to be the only valid (non-bug)
1171 * reason for perl_run to return. We try to exit by jumping to the
1172 * bootstrap-time "top" top_env, as we cannot restore the "main"
1173 * coroutine as Coro has no such concept
1174 */
1175 PL_top_env = main_top_env;
1176 JMPENV_JUMP (2); /* I do not feel well about the hardcoded 2 at all */
1177 }
1178 }
1179
1180 static coro_cctx *
1181 cctx_new ()
1182 {
1183 coro_cctx *cctx;
1184
1185 ++cctx_count;
1186 New (0, cctx, 1, coro_cctx);
1187
1188 cctx->gen = cctx_gen;
1189 cctx->flags = 0;
1190 cctx->idle_sp = 0; /* can be accessed by transfer between cctx_run and set_stacklevel, on throw */
1191
1192 return cctx;
1193 }
1194
1195 /* create a new cctx only suitable as source */
1196 static coro_cctx *
1197 cctx_new_empty ()
1198 {
1199 coro_cctx *cctx = cctx_new ();
1200
1201 cctx->sptr = 0;
1202 coro_create (&cctx->cctx, 0, 0, 0, 0);
1203
1204 return cctx;
1205 }
1206
1207 /* create a new cctx suitable as destination/running a perl interpreter */
1208 static coro_cctx *
1209 cctx_new_run ()
1210 {
1211 coro_cctx *cctx = cctx_new ();
1212 void *stack_start;
1213 size_t stack_size;
1214
1215 #if HAVE_MMAP
1216 cctx->ssize = ((cctx_stacksize * sizeof (long) + PAGESIZE - 1) / PAGESIZE + CORO_STACKGUARD) * PAGESIZE;
1217 /* mmap supposedly does allocate-on-write for us */
1218 cctx->sptr = mmap (0, cctx->ssize, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, 0, 0);
1219
1220 if (cctx->sptr != (void *)-1)
1221 {
1222 #if CORO_STACKGUARD
1223 mprotect (cctx->sptr, CORO_STACKGUARD * PAGESIZE, PROT_NONE);
1224 #endif
1225 stack_start = (char *)cctx->sptr + CORO_STACKGUARD * PAGESIZE;
1226 stack_size = cctx->ssize - CORO_STACKGUARD * PAGESIZE;
1227 cctx->flags |= CC_MAPPED;
1228 }
1229 else
1230 #endif
1231 {
1232 cctx->ssize = cctx_stacksize * (long)sizeof (long);
1233 New (0, cctx->sptr, cctx_stacksize, long);
1234
1235 if (!cctx->sptr)
1236 {
1237 perror ("FATAL: unable to allocate stack for coroutine, exiting.");
1238 _exit (EXIT_FAILURE);
1239 }
1240
1241 stack_start = cctx->sptr;
1242 stack_size = cctx->ssize;
1243 }
1244
1245 #if CORO_USE_VALGRIND
1246 cctx->valgrind_id = VALGRIND_STACK_REGISTER ((char *)stack_start, (char *)stack_start + stack_size);
1247 #endif
1248
1249 coro_create (&cctx->cctx, cctx_run, (void *)cctx, stack_start, stack_size);
1250
1251 return cctx;
1252 }
1253
1254 static void
1255 cctx_destroy (coro_cctx *cctx)
1256 {
1257 if (!cctx)
1258 return;
1259
1260 assert (cctx != cctx_current);//D temporary
1261
1262 --cctx_count;
1263 coro_destroy (&cctx->cctx);
1264
1265 /* coro_transfer creates new, empty cctx's */
1266 if (cctx->sptr)
1267 {
1268 #if CORO_USE_VALGRIND
1269 VALGRIND_STACK_DEREGISTER (cctx->valgrind_id);
1270 #endif
1271
1272 #if HAVE_MMAP
1273 if (cctx->flags & CC_MAPPED)
1274 munmap (cctx->sptr, cctx->ssize);
1275 else
1276 #endif
1277 Safefree (cctx->sptr);
1278 }
1279
1280 Safefree (cctx);
1281 }
1282
1283 /* wether this cctx should be destructed */
1284 #define CCTX_EXPIRED(cctx) ((cctx)->gen != cctx_gen || ((cctx)->flags & CC_NOREUSE))
1285
1286 static coro_cctx *
1287 cctx_get (pTHX)
1288 {
1289 while (expect_true (cctx_first))
1290 {
1291 coro_cctx *cctx = cctx_first;
1292 cctx_first = cctx->next;
1293 --cctx_idle;
1294
1295 if (expect_true (!CCTX_EXPIRED (cctx)))
1296 return cctx;
1297
1298 cctx_destroy (cctx);
1299 }
1300
1301 return cctx_new_run ();
1302 }
1303
1304 static void
1305 cctx_put (coro_cctx *cctx)
1306 {
1307 assert (("FATAL: cctx_put called on non-initialised cctx in Coro (please report)", cctx->sptr));
1308
1309 /* free another cctx if overlimit */
1310 if (expect_false (cctx_idle >= cctx_max_idle))
1311 {
1312 coro_cctx *first = cctx_first;
1313 cctx_first = first->next;
1314 --cctx_idle;
1315
1316 cctx_destroy (first);
1317 }
1318
1319 ++cctx_idle;
1320 cctx->next = cctx_first;
1321 cctx_first = cctx;
1322 }
1323
1324 /** coroutine switching *****************************************************/
1325
1326 static void
1327 transfer_check (pTHX_ struct coro *prev, struct coro *next)
1328 {
1329 /* TODO: throwing up here is considered harmful */
1330
1331 if (expect_true (prev != next))
1332 {
1333 if (expect_false (!(prev->flags & (CF_RUNNING | CF_NEW))))
1334 croak ("Coro::State::transfer called with non-running/new prev Coro::State, but can only transfer from running or new states,");
1335
1336 if (expect_false (next->flags & CF_RUNNING))
1337 croak ("Coro::State::transfer called with running next Coro::State, but can only transfer to inactive states,");
1338
1339 if (expect_false (next->flags & CF_DESTROYED))
1340 croak ("Coro::State::transfer called with destroyed next Coro::State, but can only transfer to inactive states,");
1341
1342 #if !PERL_VERSION_ATLEAST (5,10,0)
1343 if (expect_false (PL_lex_state != LEX_NOTPARSING))
1344 croak ("Coro::State::transfer called while parsing, but this is not supported in your perl version,");
1345 #endif
1346 }
1347 }
1348
1349 /* always use the TRANSFER macro */
1350 static void NOINLINE /* noinline so we have a fixed stackframe */
1351 transfer (pTHX_ struct coro *prev, struct coro *next, int force_cctx)
1352 {
1353 dSTACKLEVEL;
1354
1355 /* sometimes transfer is only called to set idle_sp */
1356 if (expect_false (!prev))
1357 {
1358 cctx_current->idle_sp = STACKLEVEL;
1359 assert (cctx_current->idle_te = PL_top_env); /* just for the side-effect when asserts are enabled */
1360 }
1361 else if (expect_true (prev != next))
1362 {
1363 coro_cctx *cctx_prev;
1364
1365 if (expect_false (prev->flags & CF_NEW))
1366 {
1367 /* create a new empty/source context */
1368 prev->flags &= ~CF_NEW;
1369 prev->flags |= CF_RUNNING;
1370 }
1371
1372 prev->flags &= ~CF_RUNNING;
1373 next->flags |= CF_RUNNING;
1374
1375 /* first get rid of the old state */
1376 save_perl (aTHX_ prev);
1377
1378 if (expect_false (next->flags & CF_NEW))
1379 {
1380 /* need to start coroutine */
1381 next->flags &= ~CF_NEW;
1382 /* setup coroutine call */
1383 coro_setup (aTHX_ next);
1384 }
1385 else
1386 load_perl (aTHX_ next);
1387
1388 /* possibly untie and reuse the cctx */
1389 if (expect_true (
1390 cctx_current->idle_sp == STACKLEVEL
1391 && !(cctx_current->flags & CC_TRACE)
1392 && !force_cctx
1393 ))
1394 {
1395 /* I assume that stacklevel is a stronger indicator than PL_top_env changes */
1396 assert (("FATAL: current top_env must equal previous top_env in Coro (please report)", PL_top_env == cctx_current->idle_te));
1397
1398 /* if the cctx is about to be destroyed we need to make sure we won't see it in cctx_get */
1399 /* without this the next cctx_get might destroy the prev__cctx while still in use */
1400 if (expect_false (CCTX_EXPIRED (cctx_current)))
1401 if (!next->cctx)
1402 next->cctx = cctx_get (aTHX);
1403
1404 cctx_put (cctx_current);
1405 assert (!prev->cctx);//D temporary
1406 }
1407 else
1408 prev->cctx = cctx_current;
1409
1410 ++next->usecount;
1411
1412 cctx_prev = cctx_current;
1413 cctx_current = expect_false (next->cctx) ? next->cctx : cctx_get (aTHX);
1414
1415 next->cctx = 0;
1416
1417 if (expect_false (cctx_prev != cctx_current))
1418 {
1419 cctx_prev->top_env = PL_top_env;
1420 PL_top_env = cctx_current->top_env;
1421 coro_transfer (&cctx_prev->cctx, &cctx_current->cctx);
1422 }
1423
1424 transfer_tail (aTHX);
1425 }
1426 }
1427
1428 #define TRANSFER(ta, force_cctx) transfer (aTHX_ (ta).prev, (ta).next, (force_cctx))
1429 #define TRANSFER_CHECK(ta) transfer_check (aTHX_ (ta).prev, (ta).next)
1430
1431 /** high level stuff ********************************************************/
1432
1433 static int
1434 coro_state_destroy (pTHX_ struct coro *coro)
1435 {
1436 if (coro->flags & CF_DESTROYED)
1437 return 0;
1438
1439 if (coro->on_destroy)
1440 coro->on_destroy (aTHX_ coro);
1441
1442 coro->flags |= CF_DESTROYED;
1443
1444 if (coro->flags & CF_READY)
1445 {
1446 /* reduce nready, as destroying a ready coro effectively unreadies it */
1447 /* alternative: look through all ready queues and remove the coro */
1448 --coro_nready;
1449 }
1450 else
1451 coro->flags |= CF_READY; /* make sure it is NOT put into the readyqueue */
1452
1453 if (coro->mainstack && coro->mainstack != main_mainstack)
1454 {
1455 struct coro temp;
1456
1457 assert (("FATAL: tried to destroy currently running coroutine (please report)", !(coro->flags & CF_RUNNING)));
1458
1459 save_perl (aTHX_ &temp);
1460 load_perl (aTHX_ coro);
1461
1462 coro_destruct (aTHX_ coro);
1463
1464 load_perl (aTHX_ &temp);
1465
1466 coro->slot = 0;
1467 }
1468
1469 cctx_destroy (coro->cctx);
1470 SvREFCNT_dec (coro->startcv);
1471 SvREFCNT_dec (coro->args);
1472 SvREFCNT_dec (CORO_THROW);
1473
1474 if (coro->next) coro->next->prev = coro->prev;
1475 if (coro->prev) coro->prev->next = coro->next;
1476 if (coro == coro_first) coro_first = coro->next;
1477
1478 return 1;
1479 }
1480
1481 static int
1482 coro_state_free (pTHX_ SV *sv, MAGIC *mg)
1483 {
1484 struct coro *coro = (struct coro *)mg->mg_ptr;
1485 mg->mg_ptr = 0;
1486
1487 coro->hv = 0;
1488
1489 if (--coro->refcnt < 0)
1490 {
1491 coro_state_destroy (aTHX_ coro);
1492 Safefree (coro);
1493 }
1494
1495 return 0;
1496 }
1497
1498 static int
1499 coro_state_dup (pTHX_ MAGIC *mg, CLONE_PARAMS *params)
1500 {
1501 struct coro *coro = (struct coro *)mg->mg_ptr;
1502
1503 ++coro->refcnt;
1504
1505 return 0;
1506 }
1507
1508 static MGVTBL coro_state_vtbl = {
1509 0, 0, 0, 0,
1510 coro_state_free,
1511 0,
1512 #ifdef MGf_DUP
1513 coro_state_dup,
1514 #else
1515 # define MGf_DUP 0
1516 #endif
1517 };
1518
1519 static void
1520 prepare_transfer (pTHX_ struct coro_transfer_args *ta, SV *prev_sv, SV *next_sv)
1521 {
1522 ta->prev = SvSTATE (prev_sv);
1523 ta->next = SvSTATE (next_sv);
1524 TRANSFER_CHECK (*ta);
1525 }
1526
1527 static void
1528 api_transfer (pTHX_ SV *prev_sv, SV *next_sv)
1529 {
1530 struct coro_transfer_args ta;
1531
1532 prepare_transfer (aTHX_ &ta, prev_sv, next_sv);
1533 TRANSFER (ta, 1);
1534 }
1535
1536 /*****************************************************************************/
1537 /* gensub: simple closure generation utility */
1538
1539 #define GENSUB_ARG CvXSUBANY (cv).any_ptr
1540
1541 /* create a closure from XS, returns a code reference */
1542 /* the arg can be accessed via GENSUB_ARG from the callback */
1543 /* the callback must use dXSARGS/XSRETURN */
1544 static SV *
1545 gensub (pTHX_ void (*xsub)(pTHX_ CV *), void *arg)
1546 {
1547 CV *cv = (CV *)newSV (0);
1548
1549 sv_upgrade ((SV *)cv, SVt_PVCV);
1550
1551 CvANON_on (cv);
1552 CvISXSUB_on (cv);
1553 CvXSUB (cv) = xsub;
1554 GENSUB_ARG = arg;
1555
1556 return newRV_noinc ((SV *)cv);
1557 }
1558
1559 /** Coro ********************************************************************/
1560
1561 INLINE void
1562 coro_enq (pTHX_ struct coro *coro)
1563 {
1564 av_push (coro_ready [coro->prio - PRIO_MIN], SvREFCNT_inc_NN (coro->hv));
1565 }
1566
1567 INLINE SV *
1568 coro_deq (pTHX)
1569 {
1570 int prio;
1571
1572 for (prio = PRIO_MAX - PRIO_MIN + 1; --prio >= 0; )
1573 if (AvFILLp (coro_ready [prio]) >= 0)
1574 return av_shift (coro_ready [prio]);
1575
1576 return 0;
1577 }
1578
1579 static int
1580 api_ready (pTHX_ SV *coro_sv)
1581 {
1582 struct coro *coro;
1583 SV *sv_hook;
1584 void (*xs_hook)(void);
1585
1586 if (SvROK (coro_sv))
1587 coro_sv = SvRV (coro_sv);
1588
1589 coro = SvSTATE (coro_sv);
1590
1591 if (coro->flags & CF_READY)
1592 return 0;
1593
1594 coro->flags |= CF_READY;
1595
1596 sv_hook = coro_nready ? 0 : coro_readyhook;
1597 xs_hook = coro_nready ? 0 : coroapi.readyhook;
1598
1599 coro_enq (aTHX_ coro);
1600 ++coro_nready;
1601
1602 if (sv_hook)
1603 {
1604 dSP;
1605
1606 ENTER;
1607 SAVETMPS;
1608
1609 PUSHMARK (SP);
1610 PUTBACK;
1611 call_sv (sv_hook, G_VOID | G_DISCARD);
1612
1613 FREETMPS;
1614 LEAVE;
1615 }
1616
1617 if (xs_hook)
1618 xs_hook ();
1619
1620 return 1;
1621 }
1622
1623 static int
1624 api_is_ready (pTHX_ SV *coro_sv)
1625 {
1626 return !!(SvSTATE (coro_sv)->flags & CF_READY);
1627 }
1628
1629 /* expects to own a reference to next->hv */
1630 INLINE void
1631 prepare_schedule_to (pTHX_ struct coro_transfer_args *ta, struct coro *next)
1632 {
1633 SV *prev_sv = SvRV (coro_current);
1634
1635 ta->prev = SvSTATE_hv (prev_sv);
1636 ta->next = next;
1637
1638 TRANSFER_CHECK (*ta);
1639
1640 SvRV_set (coro_current, (SV *)next->hv);
1641
1642 free_coro_mortal (aTHX);
1643 coro_mortal = prev_sv;
1644 }
1645
1646 static void
1647 prepare_schedule (pTHX_ struct coro_transfer_args *ta)
1648 {
1649 for (;;)
1650 {
1651 SV *next_sv = coro_deq (aTHX);
1652
1653 if (expect_true (next_sv))
1654 {
1655 struct coro *next = SvSTATE_hv (next_sv);
1656
1657 /* cannot transfer to destroyed coros, skip and look for next */
1658 if (expect_false (next->flags & CF_DESTROYED))
1659 SvREFCNT_dec (next_sv); /* coro_nready has already been taken care of by destroy */
1660 else
1661 {
1662 next->flags &= ~CF_READY;
1663 --coro_nready;
1664
1665 prepare_schedule_to (aTHX_ ta, next);
1666 break;
1667 }
1668 }
1669 else
1670 {
1671 /* nothing to schedule: call the idle handler */
1672 dSP;
1673
1674 ENTER;
1675 SAVETMPS;
1676
1677 PUSHMARK (SP);
1678 PUTBACK;
1679 call_sv (get_sv ("Coro::idle", FALSE), G_VOID | G_DISCARD);
1680
1681 FREETMPS;
1682 LEAVE;
1683 }
1684 }
1685 }
1686
1687 INLINE void
1688 prepare_cede (pTHX_ struct coro_transfer_args *ta)
1689 {
1690 api_ready (aTHX_ coro_current);
1691 prepare_schedule (aTHX_ ta);
1692 }
1693
1694 INLINE void
1695 prepare_cede_notself (pTHX_ struct coro_transfer_args *ta)
1696 {
1697 SV *prev = SvRV (coro_current);
1698
1699 if (coro_nready)
1700 {
1701 prepare_schedule (aTHX_ ta);
1702 api_ready (aTHX_ prev);
1703 }
1704 else
1705 prepare_nop (aTHX_ ta);
1706 }
1707
1708 static void
1709 api_schedule (pTHX)
1710 {
1711 struct coro_transfer_args ta;
1712
1713 prepare_schedule (aTHX_ &ta);
1714 TRANSFER (ta, 1);
1715 }
1716
1717 static void
1718 api_schedule_to (pTHX_ SV *coro_sv)
1719 {
1720 struct coro_transfer_args ta;
1721 struct coro *next = SvSTATE (coro_sv);
1722
1723 SvREFCNT_inc_NN (coro_sv);
1724 prepare_schedule_to (aTHX_ &ta, next);
1725 }
1726
1727 static int
1728 api_cede (pTHX)
1729 {
1730 struct coro_transfer_args ta;
1731
1732 prepare_cede (aTHX_ &ta);
1733
1734 if (expect_true (ta.prev != ta.next))
1735 {
1736 TRANSFER (ta, 1);
1737 return 1;
1738 }
1739 else
1740 return 0;
1741 }
1742
1743 static int
1744 api_cede_notself (pTHX)
1745 {
1746 if (coro_nready)
1747 {
1748 struct coro_transfer_args ta;
1749
1750 prepare_cede_notself (aTHX_ &ta);
1751 TRANSFER (ta, 1);
1752 return 1;
1753 }
1754 else
1755 return 0;
1756 }
1757
1758 static void
1759 api_trace (pTHX_ SV *coro_sv, int flags)
1760 {
1761 struct coro *coro = SvSTATE (coro_sv);
1762
1763 if (flags & CC_TRACE)
1764 {
1765 if (!coro->cctx)
1766 coro->cctx = cctx_new_run ();
1767 else if (!(coro->cctx->flags & CC_TRACE))
1768 croak ("cannot enable tracing on coroutine with custom stack,");
1769
1770 coro->cctx->flags |= CC_NOREUSE | (flags & (CC_TRACE | CC_TRACE_ALL));
1771 }
1772 else if (coro->cctx && coro->cctx->flags & CC_TRACE)
1773 {
1774 coro->cctx->flags &= ~(CC_TRACE | CC_TRACE_ALL);
1775
1776 if (coro->flags & CF_RUNNING)
1777 PL_runops = RUNOPS_DEFAULT;
1778 else
1779 coro->slot->runops = RUNOPS_DEFAULT;
1780 }
1781 }
1782
1783 static void
1784 coro_call_on_destroy (pTHX_ struct coro *coro)
1785 {
1786 SV **on_destroyp = hv_fetch (coro->hv, "_on_destroy", sizeof ("_on_destroy") - 1, 0);
1787 SV **statusp = hv_fetch (coro->hv, "_status", sizeof ("_status") - 1, 0);
1788
1789 if (on_destroyp)
1790 {
1791 AV *on_destroy = (AV *)SvRV (*on_destroyp);
1792
1793 while (AvFILLp (on_destroy) >= 0)
1794 {
1795 dSP; /* don't disturb outer sp */
1796 SV *cb = av_pop (on_destroy);
1797
1798 PUSHMARK (SP);
1799
1800 if (statusp)
1801 {
1802 int i;
1803 AV *status = (AV *)SvRV (*statusp);
1804 EXTEND (SP, AvFILLp (status) + 1);
1805
1806 for (i = 0; i <= AvFILLp (status); ++i)
1807 PUSHs (AvARRAY (status)[i]);
1808 }
1809
1810 PUTBACK;
1811 call_sv (sv_2mortal (cb), G_VOID | G_DISCARD);
1812 }
1813 }
1814 }
1815
1816 static void
1817 slf_init_terminate (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
1818 {
1819 int i;
1820 HV *hv = (HV *)SvRV (coro_current);
1821 AV *av = newAV ();
1822
1823 av_extend (av, items - 1);
1824 for (i = 0; i < items; ++i)
1825 av_push (av, SvREFCNT_inc_NN (arg [i]));
1826
1827 hv_store (hv, "_status", sizeof ("_status") - 1, newRV_noinc ((SV *)av), 0);
1828
1829 av_push (av_destroy, (SV *)newRV_inc ((SV *)hv)); /* RVinc for perl */
1830 api_ready (aTHX_ sv_manager);
1831
1832 frame->prepare = prepare_schedule;
1833 frame->check = slf_check_repeat;
1834 }
1835
1836 /*****************************************************************************/
1837 /* async pool handler */
1838
1839 static int
1840 slf_check_pool_handler (pTHX_ struct CoroSLF *frame)
1841 {
1842 HV *hv = (HV *)SvRV (coro_current);
1843 struct coro *coro = (struct coro *)frame->data;
1844
1845 if (!coro->invoke_cb)
1846 return 1; /* loop till we have invoke */
1847 else
1848 {
1849 hv_store (hv, "desc", sizeof ("desc") - 1,
1850 newSVpvn ("[async_pool]", sizeof ("[async_pool]") - 1), 0);
1851
1852 coro->saved_deffh = SvREFCNT_inc_NN ((SV *)PL_defoutgv);
1853
1854 {
1855 dSP;
1856 XPUSHs (sv_2mortal (coro->invoke_cb)); coro->invoke_cb = 0;
1857 PUTBACK;
1858 }
1859
1860 SvREFCNT_dec (GvAV (PL_defgv));
1861 GvAV (PL_defgv) = coro->invoke_av;
1862 coro->invoke_av = 0;
1863
1864 return 0;
1865 }
1866 }
1867
1868 static void
1869 slf_init_pool_handler (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
1870 {
1871 HV *hv = (HV *)SvRV (coro_current);
1872 struct coro *coro = SvSTATE_hv ((SV *)hv);
1873
1874 if (expect_true (coro->saved_deffh))
1875 {
1876 /* subsequent iteration */
1877 SvREFCNT_dec ((SV *)PL_defoutgv); PL_defoutgv = (GV *)coro->saved_deffh;
1878 coro->saved_deffh = 0;
1879
1880 if (coro_rss (aTHX_ coro) > SvUV (sv_pool_rss)
1881 || av_len (av_async_pool) + 1 >= SvIV (sv_pool_size))
1882 {
1883 coro->invoke_cb = SvREFCNT_inc_NN ((SV *)cv_coro_terminate);
1884 coro->invoke_av = newAV ();
1885
1886 frame->prepare = prepare_nop;
1887 }
1888 else
1889 {
1890 av_clear (GvAV (PL_defgv));
1891 hv_store (hv, "desc", sizeof ("desc") - 1, SvREFCNT_inc_NN (sv_async_pool_idle), 0);
1892
1893 coro->prio = 0;
1894
1895 if (coro->cctx && (coro->cctx->flags & CC_TRACE))
1896 api_trace (aTHX_ coro_current, 0);
1897
1898 frame->prepare = prepare_schedule;
1899 av_push (av_async_pool, SvREFCNT_inc (hv));
1900 }
1901 }
1902 else
1903 {
1904 /* first iteration, simply fall through */
1905 frame->prepare = prepare_nop;
1906 }
1907
1908 frame->check = slf_check_pool_handler;
1909 frame->data = (void *)coro;
1910 }
1911
1912 /*****************************************************************************/
1913 /* rouse callback */
1914
1915 #define CORO_MAGIC_type_rouse PERL_MAGIC_ext
1916
1917 static void
1918 coro_rouse_callback (pTHX_ CV *cv)
1919 {
1920 dXSARGS;
1921 SV *data = (SV *)GENSUB_ARG;
1922
1923 if (SvTYPE (SvRV (data)) != SVt_PVAV)
1924 {
1925 /* first call, set args */
1926 AV *av = newAV ();
1927 SV *coro = SvRV (data);
1928
1929 SvRV_set (data, (SV *)av);
1930 api_ready (aTHX_ coro);
1931 SvREFCNT_dec (coro);
1932
1933 /* better take a full copy of the arguments */
1934 while (items--)
1935 av_store (av, items, newSVsv (ST (items)));
1936 }
1937
1938 XSRETURN_EMPTY;
1939 }
1940
1941 static int
1942 slf_check_rouse_wait (pTHX_ struct CoroSLF *frame)
1943 {
1944 SV *data = (SV *)frame->data;
1945
1946 if (CORO_THROW)
1947 return 0;
1948
1949 if (SvTYPE (SvRV (data)) != SVt_PVAV)
1950 return 1;
1951
1952 /* now push all results on the stack */
1953 {
1954 dSP;
1955 AV *av = (AV *)SvRV (data);
1956 int i;
1957
1958 EXTEND (SP, AvFILLp (av) + 1);
1959 for (i = 0; i <= AvFILLp (av); ++i)
1960 PUSHs (sv_2mortal (AvARRAY (av)[i]));
1961
1962 /* we have stolen the elements, so ste length to zero and free */
1963 AvFILLp (av) = -1;
1964 av_undef (av);
1965
1966 PUTBACK;
1967 }
1968
1969 return 0;
1970 }
1971
1972 static void
1973 slf_init_rouse_wait (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
1974 {
1975 SV *cb;
1976
1977 if (items)
1978 cb = arg [0];
1979 else
1980 {
1981 struct coro *coro = SvSTATE_current;
1982
1983 if (!coro->rouse_cb)
1984 croak ("Coro::rouse_wait called without rouse callback, and no default rouse callback found either,");
1985
1986 cb = sv_2mortal (coro->rouse_cb);
1987 coro->rouse_cb = 0;
1988 }
1989
1990 if (!SvROK (cb)
1991 || SvTYPE (SvRV (cb)) != SVt_PVCV
1992 || CvXSUB ((CV *)SvRV (cb)) != coro_rouse_callback)
1993 croak ("Coro::rouse_wait called with illegal callback argument,");
1994
1995 {
1996 CV *cv = (CV *)SvRV (cb); /* for GENSUB_ARG */
1997 SV *data = (SV *)GENSUB_ARG;
1998
1999 frame->data = (void *)data;
2000 frame->prepare = SvTYPE (SvRV (data)) == SVt_PVAV ? prepare_nop : prepare_schedule;
2001 frame->check = slf_check_rouse_wait;
2002 }
2003 }
2004
2005 static SV *
2006 coro_new_rouse_cb (pTHX)
2007 {
2008 HV *hv = (HV *)SvRV (coro_current);
2009 struct coro *coro = SvSTATE_hv (hv);
2010 SV *data = newRV_inc ((SV *)hv);
2011 SV *cb = gensub (aTHX_ coro_rouse_callback, (void *)data);
2012
2013 sv_magicext (SvRV (cb), data, CORO_MAGIC_type_rouse, 0, 0, 0);
2014 SvREFCNT_dec (data); /* magicext increases the refcount */
2015
2016 SvREFCNT_dec (coro->rouse_cb);
2017 coro->rouse_cb = SvREFCNT_inc_NN (cb);
2018
2019 return cb;
2020 }
2021
2022 /*****************************************************************************/
2023 /* schedule-like-function opcode (SLF) */
2024
2025 static UNOP slf_restore; /* restore stack as entersub did, for first-re-run */
2026 static const CV *slf_cv;
2027 static SV **slf_argv;
2028 static int slf_argc, slf_arga; /* count, allocated */
2029 static I32 slf_ax; /* top of stack, for restore */
2030
2031 /* this restores the stack in the case we patched the entersub, to */
2032 /* recreate the stack frame as perl will on following calls */
2033 /* since entersub cleared the stack */
2034 static OP *
2035 pp_restore (pTHX)
2036 {
2037 int i;
2038 SV **SP = PL_stack_base + slf_ax;
2039
2040 PUSHMARK (SP);
2041
2042 EXTEND (SP, slf_argc + 1);
2043
2044 for (i = 0; i < slf_argc; ++i)
2045 PUSHs (sv_2mortal (slf_argv [i]));
2046
2047 PUSHs ((SV *)CvGV (slf_cv));
2048
2049 RETURNOP (slf_restore.op_first);
2050 }
2051
2052 static void
2053 slf_prepare_transfer (pTHX_ struct coro_transfer_args *ta)
2054 {
2055 SV **arg = (SV **)slf_frame.data;
2056
2057 prepare_transfer (aTHX_ ta, arg [0], arg [1]);
2058 }
2059
2060 static void
2061 slf_init_transfer (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2062 {
2063 if (items != 2)
2064 croak ("Coro::State::transfer (prev, next) expects two arguments, not %d,", items);
2065
2066 frame->prepare = slf_prepare_transfer;
2067 frame->check = slf_check_nop;
2068 frame->data = (void *)arg; /* let's hope it will stay valid */
2069 }
2070
2071 static void
2072 slf_init_schedule (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2073 {
2074 frame->prepare = prepare_schedule;
2075 frame->check = slf_check_nop;
2076 }
2077
2078 static void
2079 slf_prepare_schedule_to (pTHX_ struct coro_transfer_args *ta)
2080 {
2081 struct coro *next = (struct coro *)slf_frame.data;
2082
2083 SvREFCNT_inc_NN (next->hv);
2084 prepare_schedule_to (aTHX_ ta, next);
2085 }
2086
2087 static void
2088 slf_init_schedule_to (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2089 {
2090 if (!items)
2091 croak ("Coro::schedule_to expects a coroutine argument, caught");
2092
2093 frame->data = (void *)SvSTATE (arg [0]);
2094 frame->prepare = slf_prepare_schedule_to;
2095 frame->check = slf_check_nop;
2096 }
2097
2098 static void
2099 slf_init_cede_to (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2100 {
2101 api_ready (aTHX_ SvRV (coro_current));
2102
2103 slf_init_schedule_to (aTHX_ frame, cv, arg, items);
2104 }
2105
2106 static void
2107 slf_init_cede (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2108 {
2109 frame->prepare = prepare_cede;
2110 frame->check = slf_check_nop;
2111 }
2112
2113 static void
2114 slf_init_cede_notself (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2115 {
2116 frame->prepare = prepare_cede_notself;
2117 frame->check = slf_check_nop;
2118 }
2119
2120 /*
2121 * these not obviously related functions are all rolled into one
2122 * function to increase chances that they all will call transfer with the same
2123 * stack offset
2124 * SLF stands for "schedule-like-function".
2125 */
2126 static OP *
2127 pp_slf (pTHX)
2128 {
2129 I32 checkmark; /* mark SP to see how many elements check has pushed */
2130
2131 /* set up the slf frame, unless it has already been set-up */
2132 /* the latter happens when a new coro has been started */
2133 /* or when a new cctx was attached to an existing coroutine */
2134 if (expect_true (!slf_frame.prepare))
2135 {
2136 /* first iteration */
2137 dSP;
2138 SV **arg = PL_stack_base + TOPMARK + 1;
2139 int items = SP - arg; /* args without function object */
2140 SV *gv = *sp;
2141
2142 /* do a quick consistency check on the "function" object, and if it isn't */
2143 /* for us, divert to the real entersub */
2144 if (SvTYPE (gv) != SVt_PVGV
2145 || !GvCV (gv)
2146 || !(CvFLAGS (GvCV (gv)) & CVf_SLF))
2147 return PL_ppaddr[OP_ENTERSUB](aTHX);
2148
2149 if (!(PL_op->op_flags & OPf_STACKED))
2150 {
2151 /* ampersand-form of call, use @_ instead of stack */
2152 AV *av = GvAV (PL_defgv);
2153 arg = AvARRAY (av);
2154 items = AvFILLp (av) + 1;
2155 }
2156
2157 /* now call the init function, which needs to set up slf_frame */
2158 ((coro_slf_cb)CvXSUBANY (GvCV (gv)).any_ptr)
2159 (aTHX_ &slf_frame, GvCV (gv), arg, items);
2160
2161 /* pop args */
2162 SP = PL_stack_base + POPMARK;
2163
2164 PUTBACK;
2165 }
2166
2167 /* now that we have a slf_frame, interpret it! */
2168 /* we use a callback system not to make the code needlessly */
2169 /* complicated, but so we can run multiple perl coros from one cctx */
2170
2171 do
2172 {
2173 struct coro_transfer_args ta;
2174
2175 slf_frame.prepare (aTHX_ &ta);
2176 TRANSFER (ta, 0);
2177
2178 checkmark = PL_stack_sp - PL_stack_base;
2179 }
2180 while (slf_frame.check (aTHX_ &slf_frame));
2181
2182 slf_frame.prepare = 0; /* invalidate the frame, we are done processing it */
2183
2184 /* exception handling */
2185 if (expect_false (CORO_THROW))
2186 {
2187 SV *exception = sv_2mortal (CORO_THROW);
2188
2189 CORO_THROW = 0;
2190 sv_setsv (ERRSV, exception);
2191 croak (0);
2192 }
2193
2194 /* return value handling - mostly like entersub */
2195 /* make sure we put something on the stack in scalar context */
2196 if (GIMME_V == G_SCALAR)
2197 {
2198 dSP;
2199 SV **bot = PL_stack_base + checkmark;
2200
2201 if (sp == bot) /* too few, push undef */
2202 bot [1] = &PL_sv_undef;
2203 else if (sp != bot + 1) /* too many, take last one */
2204 bot [1] = *sp;
2205
2206 SP = bot + 1;
2207
2208 PUTBACK;
2209 }
2210
2211 return NORMAL;
2212 }
2213
2214 static void
2215 api_execute_slf (pTHX_ CV *cv, coro_slf_cb init_cb, I32 ax)
2216 {
2217 int i;
2218 SV **arg = PL_stack_base + ax;
2219 int items = PL_stack_sp - arg + 1;
2220
2221 assert (("FATAL: SLF call with illegal CV value", !CvANON (cv)));
2222
2223 if (PL_op->op_ppaddr != PL_ppaddr [OP_ENTERSUB]
2224 && PL_op->op_ppaddr != pp_slf)
2225 croak ("FATAL: Coro SLF calls can only be made normally, not via goto or any other means, caught");
2226
2227 CvFLAGS (cv) |= CVf_SLF;
2228 CvXSUBANY (cv).any_ptr = (void *)init_cb;
2229 slf_cv = cv;
2230
2231 /* we patch the op, and then re-run the whole call */
2232 /* we have to put the same argument on the stack for this to work */
2233 /* and this will be done by pp_restore */
2234 slf_restore.op_next = (OP *)&slf_restore;
2235 slf_restore.op_type = OP_CUSTOM;
2236 slf_restore.op_ppaddr = pp_restore;
2237 slf_restore.op_first = PL_op;
2238
2239 slf_ax = ax - 1; /* undo the ax++ inside dAXMARK */
2240
2241 if (PL_op->op_flags & OPf_STACKED)
2242 {
2243 if (items > slf_arga)
2244 {
2245 slf_arga = items;
2246 free (slf_argv);
2247 slf_argv = malloc (slf_arga * sizeof (SV *));
2248 }
2249
2250 slf_argc = items;
2251
2252 for (i = 0; i < items; ++i)
2253 slf_argv [i] = SvREFCNT_inc (arg [i]);
2254 }
2255 else
2256 slf_argc = 0;
2257
2258 PL_op->op_ppaddr = pp_slf;
2259 /*PL_op->op_type = OP_CUSTOM; /* we do behave like entersub still */
2260
2261 PL_op = (OP *)&slf_restore;
2262 }
2263
2264 /*****************************************************************************/
2265 /* PerlIO::cede */
2266
2267 typedef struct
2268 {
2269 PerlIOBuf base;
2270 NV next, every;
2271 } PerlIOCede;
2272
2273 static IV
2274 PerlIOCede_pushed (pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2275 {
2276 PerlIOCede *self = PerlIOSelf (f, PerlIOCede);
2277
2278 self->every = SvCUR (arg) ? SvNV (arg) : 0.01;
2279 self->next = nvtime () + self->every;
2280
2281 return PerlIOBuf_pushed (aTHX_ f, mode, Nullsv, tab);
2282 }
2283
2284 static SV *
2285 PerlIOCede_getarg (pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
2286 {
2287 PerlIOCede *self = PerlIOSelf (f, PerlIOCede);
2288
2289 return newSVnv (self->every);
2290 }
2291
2292 static IV
2293 PerlIOCede_flush (pTHX_ PerlIO *f)
2294 {
2295 PerlIOCede *self = PerlIOSelf (f, PerlIOCede);
2296 double now = nvtime ();
2297
2298 if (now >= self->next)
2299 {
2300 api_cede (aTHX);
2301 self->next = now + self->every;
2302 }
2303
2304 return PerlIOBuf_flush (aTHX_ f);
2305 }
2306
2307 static PerlIO_funcs PerlIO_cede =
2308 {
2309 sizeof(PerlIO_funcs),
2310 "cede",
2311 sizeof(PerlIOCede),
2312 PERLIO_K_DESTRUCT | PERLIO_K_RAW,
2313 PerlIOCede_pushed,
2314 PerlIOBuf_popped,
2315 PerlIOBuf_open,
2316 PerlIOBase_binmode,
2317 PerlIOCede_getarg,
2318 PerlIOBase_fileno,
2319 PerlIOBuf_dup,
2320 PerlIOBuf_read,
2321 PerlIOBuf_unread,
2322 PerlIOBuf_write,
2323 PerlIOBuf_seek,
2324 PerlIOBuf_tell,
2325 PerlIOBuf_close,
2326 PerlIOCede_flush,
2327 PerlIOBuf_fill,
2328 PerlIOBase_eof,
2329 PerlIOBase_error,
2330 PerlIOBase_clearerr,
2331 PerlIOBase_setlinebuf,
2332 PerlIOBuf_get_base,
2333 PerlIOBuf_bufsiz,
2334 PerlIOBuf_get_ptr,
2335 PerlIOBuf_get_cnt,
2336 PerlIOBuf_set_ptrcnt,
2337 };
2338
2339 /*****************************************************************************/
2340 /* Coro::Semaphore & Coro::Signal */
2341
2342 static SV *
2343 coro_waitarray_new (pTHX_ int count)
2344 {
2345 /* a semaphore contains a counter IV in $sem->[0] and any waiters after that */
2346 AV *av = newAV ();
2347 SV **ary;
2348
2349 /* unfortunately, building manually saves memory */
2350 Newx (ary, 2, SV *);
2351 AvALLOC (av) = ary;
2352 /*AvARRAY (av) = ary;*/
2353 SvPVX ((SV *)av) = (char *)ary; /* 5.8.8 needs this syntax instead of AvARRAY = ary */
2354 AvMAX (av) = 1;
2355 AvFILLp (av) = 0;
2356 ary [0] = newSViv (count);
2357
2358 return newRV_noinc ((SV *)av);
2359 }
2360
2361 /* semaphore */
2362
2363 static void
2364 coro_semaphore_adjust (pTHX_ AV *av, IV adjust)
2365 {
2366 SV *count_sv = AvARRAY (av)[0];
2367 IV count = SvIVX (count_sv);
2368
2369 count += adjust;
2370 SvIVX (count_sv) = count;
2371
2372 /* now wake up as many waiters as are expected to lock */
2373 while (count > 0 && AvFILLp (av) > 0)
2374 {
2375 SV *cb;
2376
2377 /* swap first two elements so we can shift a waiter */
2378 AvARRAY (av)[0] = AvARRAY (av)[1];
2379 AvARRAY (av)[1] = count_sv;
2380 cb = av_shift (av);
2381
2382 if (SvOBJECT (cb))
2383 {
2384 api_ready (aTHX_ cb);
2385 --count;
2386 }
2387 else if (SvTYPE (cb) == SVt_PVCV)
2388 {
2389 dSP;
2390 PUSHMARK (SP);
2391 XPUSHs (sv_2mortal (newRV_inc ((SV *)av)));
2392 PUTBACK;
2393 call_sv (cb, G_VOID | G_DISCARD | G_EVAL | G_KEEPERR);
2394 }
2395
2396 SvREFCNT_dec (cb);
2397 }
2398 }
2399
2400 static void
2401 coro_semaphore_on_destroy (pTHX_ struct coro *coro)
2402 {
2403 /* call $sem->adjust (0) to possibly wake up some other waiters */
2404 coro_semaphore_adjust (aTHX_ (AV *)coro->slf_frame.data, 0);
2405 }
2406
2407 static int
2408 slf_check_semaphore_down_or_wait (pTHX_ struct CoroSLF *frame, int acquire)
2409 {
2410 AV *av = (AV *)frame->data;
2411 SV *count_sv = AvARRAY (av)[0];
2412
2413 /* if we are about to throw, don't actually acquire the lock, just throw */
2414 if (CORO_THROW)
2415 return 0;
2416 else if (SvIVX (count_sv) > 0)
2417 {
2418 SvSTATE_current->on_destroy = 0;
2419
2420 if (acquire)
2421 SvIVX (count_sv) = SvIVX (count_sv) - 1;
2422 else
2423 coro_semaphore_adjust (aTHX_ av, 0);
2424
2425 return 0;
2426 }
2427 else
2428 {
2429 int i;
2430 /* if we were woken up but can't down, we look through the whole */
2431 /* waiters list and only add us if we aren't in there already */
2432 /* this avoids some degenerate memory usage cases */
2433
2434 for (i = 1; i <= AvFILLp (av); ++i)
2435 if (AvARRAY (av)[i] == SvRV (coro_current))
2436 return 1;
2437
2438 av_push (av, SvREFCNT_inc (SvRV (coro_current)));
2439 return 1;
2440 }
2441 }
2442
2443 static int
2444 slf_check_semaphore_down (pTHX_ struct CoroSLF *frame)
2445 {
2446 return slf_check_semaphore_down_or_wait (aTHX_ frame, 1);
2447 }
2448
2449 static int
2450 slf_check_semaphore_wait (pTHX_ struct CoroSLF *frame)
2451 {
2452 return slf_check_semaphore_down_or_wait (aTHX_ frame, 0);
2453 }
2454
2455 static void
2456 slf_init_semaphore_down_or_wait (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2457 {
2458 AV *av = (AV *)SvRV (arg [0]);
2459
2460 if (SvIVX (AvARRAY (av)[0]) > 0)
2461 {
2462 frame->data = (void *)av;
2463 frame->prepare = prepare_nop;
2464 }
2465 else
2466 {
2467 av_push (av, SvREFCNT_inc (SvRV (coro_current)));
2468
2469 frame->data = (void *)sv_2mortal (SvREFCNT_inc ((SV *)av));
2470 frame->prepare = prepare_schedule;
2471
2472 /* to avoid race conditions when a woken-up coro gets terminated */
2473 /* we arrange for a temporary on_destroy that calls adjust (0) */
2474 SvSTATE_current->on_destroy = coro_semaphore_on_destroy;
2475 }
2476 }
2477
2478 static void
2479 slf_init_semaphore_down (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2480 {
2481 slf_init_semaphore_down_or_wait (aTHX_ frame, cv, arg, items);
2482 frame->check = slf_check_semaphore_down;
2483 }
2484
2485 static void
2486 slf_init_semaphore_wait (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2487 {
2488 if (items >= 2)
2489 {
2490 /* callback form */
2491 AV *av = (AV *)SvRV (arg [0]);
2492 CV *cb_cv = coro_sv_2cv (aTHX_ arg [1]);
2493
2494 av_push (av, (SV *)SvREFCNT_inc_NN (cb_cv));
2495
2496 if (SvIVX (AvARRAY (av)[0]) > 0)
2497 coro_semaphore_adjust (aTHX_ av, 0);
2498
2499 frame->prepare = prepare_nop;
2500 frame->check = slf_check_nop;
2501 }
2502 else
2503 {
2504 slf_init_semaphore_down_or_wait (aTHX_ frame, cv, arg, items);
2505 frame->check = slf_check_semaphore_wait;
2506 }
2507 }
2508
2509 /* signal */
2510
2511 static void
2512 coro_signal_wake (pTHX_ AV *av, int count)
2513 {
2514 SvIVX (AvARRAY (av)[0]) = 0;
2515
2516 /* now signal count waiters */
2517 while (count > 0 && AvFILLp (av) > 0)
2518 {
2519 SV *cb;
2520
2521 /* swap first two elements so we can shift a waiter */
2522 cb = AvARRAY (av)[0];
2523 AvARRAY (av)[0] = AvARRAY (av)[1];
2524 AvARRAY (av)[1] = cb;
2525
2526 cb = av_shift (av);
2527
2528 api_ready (aTHX_ cb);
2529 sv_setiv (cb, 0); /* signal waiter */
2530 SvREFCNT_dec (cb);
2531
2532 --count;
2533 }
2534 }
2535
2536 static int
2537 slf_check_signal_wait (pTHX_ struct CoroSLF *frame)
2538 {
2539 /* if we are about to throw, also stop waiting */
2540 return SvROK ((SV *)frame->data) && !CORO_THROW;
2541 }
2542
2543 static void
2544 slf_init_signal_wait (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2545 {
2546 AV *av = (AV *)SvRV (arg [0]);
2547
2548 if (SvIVX (AvARRAY (av)[0]))
2549 {
2550 SvIVX (AvARRAY (av)[0]) = 0;
2551 frame->prepare = prepare_nop;
2552 frame->check = slf_check_nop;
2553 }
2554 else
2555 {
2556 SV *waiter = newRV_inc (SvRV (coro_current)); /* owned by signal av */
2557
2558 av_push (av, waiter);
2559
2560 frame->data = (void *)sv_2mortal (SvREFCNT_inc_NN (waiter)); /* owned by process */
2561 frame->prepare = prepare_schedule;
2562 frame->check = slf_check_signal_wait;
2563 }
2564 }
2565
2566 /*****************************************************************************/
2567 /* Coro::AIO */
2568
2569 #define CORO_MAGIC_type_aio PERL_MAGIC_ext
2570
2571 /* helper storage struct */
2572 struct io_state
2573 {
2574 int errorno;
2575 I32 laststype; /* U16 in 5.10.0 */
2576 int laststatval;
2577 Stat_t statcache;
2578 };
2579
2580 static void
2581 coro_aio_callback (pTHX_ CV *cv)
2582 {
2583 dXSARGS;
2584 AV *state = (AV *)GENSUB_ARG;
2585 SV *coro = av_pop (state);
2586 SV *data_sv = newSV (sizeof (struct io_state));
2587
2588 av_extend (state, items - 1);
2589
2590 sv_upgrade (data_sv, SVt_PV);
2591 SvCUR_set (data_sv, sizeof (struct io_state));
2592 SvPOK_only (data_sv);
2593
2594 {
2595 struct io_state *data = (struct io_state *)SvPVX (data_sv);
2596
2597 data->errorno = errno;
2598 data->laststype = PL_laststype;
2599 data->laststatval = PL_laststatval;
2600 data->statcache = PL_statcache;
2601 }
2602
2603 /* now build the result vector out of all the parameters and the data_sv */
2604 {
2605 int i;
2606
2607 for (i = 0; i < items; ++i)
2608 av_push (state, SvREFCNT_inc_NN (ST (i)));
2609 }
2610
2611 av_push (state, data_sv);
2612
2613 api_ready (aTHX_ coro);
2614 SvREFCNT_dec (coro);
2615 SvREFCNT_dec ((AV *)state);
2616 }
2617
2618 static int
2619 slf_check_aio_req (pTHX_ struct CoroSLF *frame)
2620 {
2621 AV *state = (AV *)frame->data;
2622
2623 /* if we are about to throw, return early */
2624 /* this does not cancel the aio request, but at least */
2625 /* it quickly returns */
2626 if (CORO_THROW)
2627 return 0;
2628
2629 /* one element that is an RV? repeat! */
2630 if (AvFILLp (state) == 0 && SvROK (AvARRAY (state)[0]))
2631 return 1;
2632
2633 /* restore status */
2634 {
2635 SV *data_sv = av_pop (state);
2636 struct io_state *data = (struct io_state *)SvPVX (data_sv);
2637
2638 errno = data->errorno;
2639 PL_laststype = data->laststype;
2640 PL_laststatval = data->laststatval;
2641 PL_statcache = data->statcache;
2642
2643 SvREFCNT_dec (data_sv);
2644 }
2645
2646 /* push result values */
2647 {
2648 dSP;
2649 int i;
2650
2651 EXTEND (SP, AvFILLp (state) + 1);
2652 for (i = 0; i <= AvFILLp (state); ++i)
2653 PUSHs (sv_2mortal (SvREFCNT_inc_NN (AvARRAY (state)[i])));
2654
2655 PUTBACK;
2656 }
2657
2658 return 0;
2659 }
2660
2661 static void
2662 slf_init_aio_req (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2663 {
2664 AV *state = (AV *)sv_2mortal ((SV *)newAV ());
2665 SV *coro_hv = SvRV (coro_current);
2666 struct coro *coro = SvSTATE_hv (coro_hv);
2667
2668 /* put our coroutine id on the state arg */
2669 av_push (state, SvREFCNT_inc_NN (coro_hv));
2670
2671 /* first see whether we have a non-zero priority and set it as AIO prio */
2672 if (coro->prio)
2673 {
2674 dSP;
2675
2676 static SV *prio_cv;
2677 static SV *prio_sv;
2678
2679 if (expect_false (!prio_cv))
2680 {
2681 prio_cv = (SV *)get_cv ("IO::AIO::aioreq_pri", 0);
2682 prio_sv = newSViv (0);
2683 }
2684
2685 PUSHMARK (SP);
2686 sv_setiv (prio_sv, coro->prio);
2687 XPUSHs (prio_sv);
2688
2689 PUTBACK;
2690 call_sv (prio_cv, G_VOID | G_DISCARD);
2691 }
2692
2693 /* now call the original request */
2694 {
2695 dSP;
2696 CV *req = (CV *)CORO_MAGIC_NN ((SV *)cv, CORO_MAGIC_type_aio)->mg_obj;
2697 int i;
2698
2699 PUSHMARK (SP);
2700
2701 /* first push all args to the stack */
2702 EXTEND (SP, items + 1);
2703
2704 for (i = 0; i < items; ++i)
2705 PUSHs (arg [i]);
2706
2707 /* now push the callback closure */
2708 PUSHs (sv_2mortal (gensub (aTHX_ coro_aio_callback, (void *)SvREFCNT_inc_NN ((SV *)state))));
2709
2710 /* now call the AIO function - we assume our request is uncancelable */
2711 PUTBACK;
2712 call_sv ((SV *)req, G_VOID | G_DISCARD);
2713 }
2714
2715 /* now that the requets is going, we loop toll we have a result */
2716 frame->data = (void *)state;
2717 frame->prepare = prepare_schedule;
2718 frame->check = slf_check_aio_req;
2719 }
2720
2721 static void
2722 coro_aio_req_xs (pTHX_ CV *cv)
2723 {
2724 dXSARGS;
2725
2726 CORO_EXECUTE_SLF_XS (slf_init_aio_req);
2727
2728 XSRETURN_EMPTY;
2729 }
2730
2731 /*****************************************************************************/
2732
2733 #if CORO_CLONE
2734 # include "clone.c"
2735 #endif
2736
2737 MODULE = Coro::State PACKAGE = Coro::State PREFIX = api_
2738
2739 PROTOTYPES: DISABLE
2740
2741 BOOT:
2742 {
2743 #ifdef USE_ITHREADS
2744 # if CORO_PTHREAD
2745 coro_thx = PERL_GET_CONTEXT;
2746 # endif
2747 #endif
2748 BOOT_PAGESIZE;
2749
2750 cctx_current = cctx_new_empty ();
2751
2752 irsgv = gv_fetchpv ("/" , GV_ADD|GV_NOTQUAL, SVt_PV);
2753 stdoutgv = gv_fetchpv ("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
2754
2755 orig_sigelem_get = PL_vtbl_sigelem.svt_get; PL_vtbl_sigelem.svt_get = coro_sigelem_get;
2756 orig_sigelem_set = PL_vtbl_sigelem.svt_set; PL_vtbl_sigelem.svt_set = coro_sigelem_set;
2757 orig_sigelem_clr = PL_vtbl_sigelem.svt_clear; PL_vtbl_sigelem.svt_clear = coro_sigelem_clr;
2758
2759 hv_sig = coro_get_hv (aTHX_ "SIG", TRUE);
2760 rv_diehook = newRV_inc ((SV *)gv_fetchpv ("Coro::State::diehook" , 0, SVt_PVCV));
2761 rv_warnhook = newRV_inc ((SV *)gv_fetchpv ("Coro::State::warnhook", 0, SVt_PVCV));
2762
2763 coro_state_stash = gv_stashpv ("Coro::State", TRUE);
2764
2765 newCONSTSUB (coro_state_stash, "CC_TRACE" , newSViv (CC_TRACE));
2766 newCONSTSUB (coro_state_stash, "CC_TRACE_SUB" , newSViv (CC_TRACE_SUB));
2767 newCONSTSUB (coro_state_stash, "CC_TRACE_LINE", newSViv (CC_TRACE_LINE));
2768 newCONSTSUB (coro_state_stash, "CC_TRACE_ALL" , newSViv (CC_TRACE_ALL));
2769
2770 main_mainstack = PL_mainstack;
2771 main_top_env = PL_top_env;
2772
2773 while (main_top_env->je_prev)
2774 main_top_env = main_top_env->je_prev;
2775
2776 {
2777 SV *slf = sv_2mortal (newSViv (PTR2IV (pp_slf)));
2778
2779 if (!PL_custom_op_names) PL_custom_op_names = newHV ();
2780 hv_store_ent (PL_custom_op_names, slf, newSVpv ("coro_slf", 0), 0);
2781
2782 if (!PL_custom_op_descs) PL_custom_op_descs = newHV ();
2783 hv_store_ent (PL_custom_op_descs, slf, newSVpv ("coro schedule like function", 0), 0);
2784 }
2785
2786 coroapi.ver = CORO_API_VERSION;
2787 coroapi.rev = CORO_API_REVISION;
2788
2789 coroapi.transfer = api_transfer;
2790
2791 coroapi.sv_state = SvSTATE_;
2792 coroapi.execute_slf = api_execute_slf;
2793 coroapi.prepare_nop = prepare_nop;
2794 coroapi.prepare_schedule = prepare_schedule;
2795 coroapi.prepare_cede = prepare_cede;
2796 coroapi.prepare_cede_notself = prepare_cede_notself;
2797
2798 {
2799 SV **svp = hv_fetch (PL_modglobal, "Time::NVtime", 12, 0);
2800
2801 if (!svp) croak ("Time::HiRes is required");
2802 if (!SvIOK (*svp)) croak ("Time::NVtime isn't a function pointer");
2803
2804 nvtime = INT2PTR (double (*)(), SvIV (*svp));
2805 }
2806
2807 assert (("PRIO_NORMAL must be 0", !PRIO_NORMAL));
2808 }
2809
2810 SV *
2811 new (char *klass, ...)
2812 ALIAS:
2813 Coro::new = 1
2814 CODE:
2815 {
2816 struct coro *coro;
2817 MAGIC *mg;
2818 HV *hv;
2819 CV *cb;
2820 int i;
2821
2822 if (items > 1)
2823 {
2824 cb = coro_sv_2cv (aTHX_ ST (1));
2825
2826 if (!ix)
2827 {
2828 if (CvISXSUB (cb))
2829 croak ("Coro::State doesn't support XS functions as coroutine start, caught");
2830
2831 if (!CvROOT (cb))
2832 croak ("Coro::State doesn't support autoloaded or undefined functions as coroutine start, caught");
2833 }
2834 }
2835
2836 Newz (0, coro, 1, struct coro);
2837 coro->args = newAV ();
2838 coro->flags = CF_NEW;
2839
2840 if (coro_first) coro_first->prev = coro;
2841 coro->next = coro_first;
2842 coro_first = coro;
2843
2844 coro->hv = hv = newHV ();
2845 mg = sv_magicext ((SV *)hv, 0, CORO_MAGIC_type_state, &coro_state_vtbl, (char *)coro, 0);
2846 mg->mg_flags |= MGf_DUP;
2847 RETVAL = sv_bless (newRV_noinc ((SV *)hv), gv_stashpv (klass, 1));
2848
2849 if (items > 1)
2850 {
2851 av_extend (coro->args, items - 1 + ix - 1);
2852
2853 if (ix)
2854 {
2855 av_push (coro->args, SvREFCNT_inc_NN ((SV *)cb));
2856 cb = cv_coro_run;
2857 }
2858
2859 coro->startcv = (CV *)SvREFCNT_inc_NN ((SV *)cb);
2860
2861 for (i = 2; i < items; i++)
2862 av_push (coro->args, newSVsv (ST (i)));
2863 }
2864 }
2865 OUTPUT:
2866 RETVAL
2867
2868 void
2869 transfer (...)
2870 PROTOTYPE: $$
2871 CODE:
2872 CORO_EXECUTE_SLF_XS (slf_init_transfer);
2873
2874 bool
2875 _destroy (SV *coro_sv)
2876 CODE:
2877 RETVAL = coro_state_destroy (aTHX_ SvSTATE (coro_sv));
2878 OUTPUT:
2879 RETVAL
2880
2881 void
2882 _exit (int code)
2883 PROTOTYPE: $
2884 CODE:
2885 _exit (code);
2886
2887 SV *
2888 clone (Coro::State coro)
2889 CODE:
2890 {
2891 #if CORO_CLONE
2892 struct coro *ncoro = coro_clone (coro);
2893 MAGIC *mg;
2894 /* TODO: too much duplication */
2895 ncoro->hv = newHV ();
2896 mg = sv_magicext ((SV *)ncoro->hv, 0, CORO_MAGIC_type_state, &coro_state_vtbl, (char *)ncoro, 0);
2897 mg->mg_flags |= MGf_DUP;
2898 RETVAL = sv_bless (newRV_noinc ((SV *)ncoro->hv), SvSTASH (coro->hv));
2899 #else
2900 croak ("Coro::State->clone has not been configured into this installation of Coro, realised");
2901 #endif
2902 }
2903 OUTPUT:
2904 RETVAL
2905
2906 int
2907 cctx_stacksize (int new_stacksize = 0)
2908 PROTOTYPE: ;$
2909 CODE:
2910 RETVAL = cctx_stacksize;
2911 if (new_stacksize)
2912 {
2913 cctx_stacksize = new_stacksize;
2914 ++cctx_gen;
2915 }
2916 OUTPUT:
2917 RETVAL
2918
2919 int
2920 cctx_max_idle (int max_idle = 0)
2921 PROTOTYPE: ;$
2922 CODE:
2923 RETVAL = cctx_max_idle;
2924 if (max_idle > 1)
2925 cctx_max_idle = max_idle;
2926 OUTPUT:
2927 RETVAL
2928
2929 int
2930 cctx_count ()
2931 PROTOTYPE:
2932 CODE:
2933 RETVAL = cctx_count;
2934 OUTPUT:
2935 RETVAL
2936
2937 int
2938 cctx_idle ()
2939 PROTOTYPE:
2940 CODE:
2941 RETVAL = cctx_idle;
2942 OUTPUT:
2943 RETVAL
2944
2945 void
2946 list ()
2947 PROTOTYPE:
2948 PPCODE:
2949 {
2950 struct coro *coro;
2951 for (coro = coro_first; coro; coro = coro->next)
2952 if (coro->hv)
2953 XPUSHs (sv_2mortal (newRV_inc ((SV *)coro->hv)));
2954 }
2955
2956 void
2957 call (Coro::State coro, SV *coderef)
2958 ALIAS:
2959 eval = 1
2960 CODE:
2961 {
2962 if (coro->mainstack && ((coro->flags & CF_RUNNING) || coro->slot))
2963 {
2964 struct coro temp;
2965
2966 if (!(coro->flags & CF_RUNNING))
2967 {
2968 PUTBACK;
2969 save_perl (aTHX_ &temp);
2970 load_perl (aTHX_ coro);
2971 }
2972
2973 {
2974 dSP;
2975 ENTER;
2976 SAVETMPS;
2977 PUTBACK;
2978 PUSHSTACK;
2979 PUSHMARK (SP);
2980
2981 if (ix)
2982 eval_sv (coderef, 0);
2983 else
2984 call_sv (coderef, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
2985
2986 POPSTACK;
2987 SPAGAIN;
2988 FREETMPS;
2989 LEAVE;
2990 PUTBACK;
2991 }
2992
2993 if (!(coro->flags & CF_RUNNING))
2994 {
2995 save_perl (aTHX_ coro);
2996 load_perl (aTHX_ &temp);
2997 SPAGAIN;
2998 }
2999 }
3000 }
3001
3002 SV *
3003 is_ready (Coro::State coro)
3004 PROTOTYPE: $
3005 ALIAS:
3006 is_ready = CF_READY
3007 is_running = CF_RUNNING
3008 is_new = CF_NEW
3009 is_destroyed = CF_DESTROYED
3010 CODE:
3011 RETVAL = boolSV (coro->flags & ix);
3012 OUTPUT:
3013 RETVAL
3014
3015 void
3016 throw (Coro::State self, SV *throw = &PL_sv_undef)
3017 PROTOTYPE: $;$
3018 CODE:
3019 {
3020 struct coro *current = SvSTATE_current;
3021 SV **throwp = self == current ? &CORO_THROW : &self->except;
3022 SvREFCNT_dec (*throwp);
3023 *throwp = SvOK (throw) ? newSVsv (throw) : 0;
3024 }
3025
3026 void
3027 api_trace (SV *coro, int flags = CC_TRACE | CC_TRACE_SUB)
3028 PROTOTYPE: $;$
3029 C_ARGS: aTHX_ coro, flags
3030
3031 SV *
3032 has_cctx (Coro::State coro)
3033 PROTOTYPE: $
3034 CODE:
3035 /* maybe manage the running flag differently */
3036 RETVAL = boolSV (!!coro->cctx || (coro->flags & CF_RUNNING));
3037 OUTPUT:
3038 RETVAL
3039
3040 int
3041 is_traced (Coro::State coro)
3042 PROTOTYPE: $
3043 CODE:
3044 RETVAL = (coro->cctx ? coro->cctx->flags : 0) & CC_TRACE_ALL;
3045 OUTPUT:
3046 RETVAL
3047
3048 UV
3049 rss (Coro::State coro)
3050 PROTOTYPE: $
3051 ALIAS:
3052 usecount = 1
3053 CODE:
3054 switch (ix)
3055 {
3056 case 0: RETVAL = coro_rss (aTHX_ coro); break;
3057 case 1: RETVAL = coro->usecount; break;
3058 }
3059 OUTPUT:
3060 RETVAL
3061
3062 void
3063 force_cctx ()
3064 PROTOTYPE:
3065 CODE:
3066 cctx_current->idle_sp = 0;
3067
3068 void
3069 swap_defsv (Coro::State self)
3070 PROTOTYPE: $
3071 ALIAS:
3072 swap_defav = 1
3073 CODE:
3074 if (!self->slot)
3075 croak ("cannot swap state with coroutine that has no saved state,");
3076 else
3077 {
3078 SV **src = ix ? (SV **)&GvAV (PL_defgv) : &GvSV (PL_defgv);
3079 SV **dst = ix ? (SV **)&self->slot->defav : (SV **)&self->slot->defsv;
3080
3081 SV *tmp = *src; *src = *dst; *dst = tmp;
3082 }
3083
3084
3085 MODULE = Coro::State PACKAGE = Coro
3086
3087 BOOT:
3088 {
3089 int i;
3090
3091 sv_pool_rss = coro_get_sv (aTHX_ "Coro::POOL_RSS" , TRUE);
3092 sv_pool_size = coro_get_sv (aTHX_ "Coro::POOL_SIZE" , TRUE);
3093 cv_coro_run = get_cv ( "Coro::_terminate", GV_ADD);
3094 cv_coro_terminate = get_cv ( "Coro::terminate" , GV_ADD);
3095 coro_current = coro_get_sv (aTHX_ "Coro::current" , FALSE); SvREADONLY_on (coro_current);
3096 av_async_pool = coro_get_av (aTHX_ "Coro::async_pool", TRUE);
3097 av_destroy = coro_get_av (aTHX_ "Coro::destroy" , TRUE);
3098 sv_manager = coro_get_sv (aTHX_ "Coro::manager" , TRUE);
3099
3100 sv_async_pool_idle = newSVpv ("[async pool idle]", 0); SvREADONLY_on (sv_async_pool_idle);
3101 sv_Coro = newSVpv ("Coro", 0); SvREADONLY_on (sv_Coro);
3102 cv_pool_handler = get_cv ("Coro::pool_handler", GV_ADD); SvREADONLY_on (cv_pool_handler);
3103 cv_coro_state_new = get_cv ("Coro::State::new", 0); SvREADONLY_on (cv_coro_state_new);
3104
3105 coro_stash = gv_stashpv ("Coro", TRUE);
3106
3107 newCONSTSUB (coro_stash, "PRIO_MAX", newSViv (PRIO_MAX));
3108 newCONSTSUB (coro_stash, "PRIO_HIGH", newSViv (PRIO_HIGH));
3109 newCONSTSUB (coro_stash, "PRIO_NORMAL", newSViv (PRIO_NORMAL));
3110 newCONSTSUB (coro_stash, "PRIO_LOW", newSViv (PRIO_LOW));
3111 newCONSTSUB (coro_stash, "PRIO_IDLE", newSViv (PRIO_IDLE));
3112 newCONSTSUB (coro_stash, "PRIO_MIN", newSViv (PRIO_MIN));
3113
3114 for (i = PRIO_MAX - PRIO_MIN + 1; i--; )
3115 coro_ready[i] = newAV ();
3116
3117 {
3118 SV *sv = coro_get_sv (aTHX_ "Coro::API", TRUE);
3119
3120 coroapi.schedule = api_schedule;
3121 coroapi.schedule_to = api_schedule_to;
3122 coroapi.cede = api_cede;
3123 coroapi.cede_notself = api_cede_notself;
3124 coroapi.ready = api_ready;
3125 coroapi.is_ready = api_is_ready;
3126 coroapi.nready = coro_nready;
3127 coroapi.current = coro_current;
3128
3129 /*GCoroAPI = &coroapi;*/
3130 sv_setiv (sv, (IV)&coroapi);
3131 SvREADONLY_on (sv);
3132 }
3133 }
3134
3135 void
3136 terminate (...)
3137 CODE:
3138 CORO_EXECUTE_SLF_XS (slf_init_terminate);
3139
3140 void
3141 schedule (...)
3142 CODE:
3143 CORO_EXECUTE_SLF_XS (slf_init_schedule);
3144
3145 void
3146 schedule_to (...)
3147 CODE:
3148 CORO_EXECUTE_SLF_XS (slf_init_schedule_to);
3149
3150 void
3151 cede_to (...)
3152 CODE:
3153 CORO_EXECUTE_SLF_XS (slf_init_cede_to);
3154
3155 void
3156 cede (...)
3157 CODE:
3158 CORO_EXECUTE_SLF_XS (slf_init_cede);
3159
3160 void
3161 cede_notself (...)
3162 CODE:
3163 CORO_EXECUTE_SLF_XS (slf_init_cede_notself);
3164
3165 void
3166 _cancel (Coro::State self)
3167 CODE:
3168 coro_state_destroy (aTHX_ self);
3169 coro_call_on_destroy (aTHX_ self);
3170
3171 void
3172 _set_current (SV *current)
3173 PROTOTYPE: $
3174 CODE:
3175 SvREFCNT_dec (SvRV (coro_current));
3176 SvRV_set (coro_current, SvREFCNT_inc_NN (SvRV (current)));
3177
3178 void
3179 _set_readyhook (SV *hook)
3180 PROTOTYPE: $
3181 CODE:
3182 SvREFCNT_dec (coro_readyhook);
3183 coro_readyhook = SvOK (hook) ? newSVsv (hook) : 0;
3184
3185 int
3186 prio (Coro::State coro, int newprio = 0)
3187 PROTOTYPE: $;$
3188 ALIAS:
3189 nice = 1
3190 CODE:
3191 {
3192 RETVAL = coro->prio;
3193
3194 if (items > 1)
3195 {
3196 if (ix)
3197 newprio = coro->prio - newprio;
3198
3199 if (newprio < PRIO_MIN) newprio = PRIO_MIN;
3200 if (newprio > PRIO_MAX) newprio = PRIO_MAX;
3201
3202 coro->prio = newprio;
3203 }
3204 }
3205 OUTPUT:
3206 RETVAL
3207
3208 SV *
3209 ready (SV *self)
3210 PROTOTYPE: $
3211 CODE:
3212 RETVAL = boolSV (api_ready (aTHX_ self));
3213 OUTPUT:
3214 RETVAL
3215
3216 int
3217 nready (...)
3218 PROTOTYPE:
3219 CODE:
3220 RETVAL = coro_nready;
3221 OUTPUT:
3222 RETVAL
3223
3224 void
3225 _pool_handler (...)
3226 CODE:
3227 CORO_EXECUTE_SLF_XS (slf_init_pool_handler);
3228
3229 void
3230 async_pool (SV *cv, ...)
3231 PROTOTYPE: &@
3232 PPCODE:
3233 {
3234 HV *hv = (HV *)av_pop (av_async_pool);
3235 AV *av = newAV ();
3236 SV *cb = ST (0);
3237 int i;
3238
3239 av_extend (av, items - 2);
3240 for (i = 1; i < items; ++i)
3241 av_push (av, SvREFCNT_inc_NN (ST (i)));
3242
3243 if ((SV *)hv == &PL_sv_undef)
3244 {
3245 PUSHMARK (SP);
3246 EXTEND (SP, 2);
3247 PUSHs (sv_Coro);
3248 PUSHs ((SV *)cv_pool_handler);
3249 PUTBACK;
3250 call_sv ((SV *)cv_coro_state_new, G_SCALAR);
3251 SPAGAIN;
3252
3253 hv = (HV *)SvREFCNT_inc_NN (SvRV (POPs));
3254 }
3255
3256 {
3257 struct coro *coro = SvSTATE_hv (hv);
3258
3259 assert (!coro->invoke_cb);
3260 assert (!coro->invoke_av);
3261 coro->invoke_cb = SvREFCNT_inc (cb);
3262 coro->invoke_av = av;
3263 }
3264
3265 api_ready (aTHX_ (SV *)hv);
3266
3267 if (GIMME_V != G_VOID)
3268 XPUSHs (sv_2mortal (newRV_noinc ((SV *)hv)));
3269 else
3270 SvREFCNT_dec (hv);
3271 }
3272
3273 SV *
3274 rouse_cb ()
3275 PROTOTYPE:
3276 CODE:
3277 RETVAL = coro_new_rouse_cb (aTHX);
3278 OUTPUT:
3279 RETVAL
3280
3281 void
3282 rouse_wait (...)
3283 PROTOTYPE: ;$
3284 PPCODE:
3285 CORO_EXECUTE_SLF_XS (slf_init_rouse_wait);
3286
3287
3288 MODULE = Coro::State PACKAGE = PerlIO::cede
3289
3290 BOOT:
3291 PerlIO_define_layer (aTHX_ &PerlIO_cede);
3292
3293
3294 MODULE = Coro::State PACKAGE = Coro::Semaphore
3295
3296 SV *
3297 new (SV *klass, SV *count = 0)
3298 CODE:
3299 RETVAL = sv_bless (
3300 coro_waitarray_new (aTHX_ count && SvOK (count) ? SvIV (count) : 1),
3301 GvSTASH (CvGV (cv))
3302 );
3303 OUTPUT:
3304 RETVAL
3305
3306 # helper for Coro::Channel
3307 SV *
3308 _alloc (int count)
3309 CODE:
3310 RETVAL = coro_waitarray_new (aTHX_ count);
3311 OUTPUT:
3312 RETVAL
3313
3314 SV *
3315 count (SV *self)
3316 CODE:
3317 RETVAL = newSVsv (AvARRAY ((AV *)SvRV (self))[0]);
3318 OUTPUT:
3319 RETVAL
3320
3321 void
3322 up (SV *self, int adjust = 1)
3323 ALIAS:
3324 adjust = 1
3325 CODE:
3326 coro_semaphore_adjust (aTHX_ (AV *)SvRV (self), ix ? adjust : 1);
3327
3328 void
3329 down (...)
3330 CODE:
3331 CORO_EXECUTE_SLF_XS (slf_init_semaphore_down);
3332
3333 void
3334 wait (...)
3335 CODE:
3336 CORO_EXECUTE_SLF_XS (slf_init_semaphore_wait);
3337
3338 void
3339 try (SV *self)
3340 PPCODE:
3341 {
3342 AV *av = (AV *)SvRV (self);
3343 SV *count_sv = AvARRAY (av)[0];
3344 IV count = SvIVX (count_sv);
3345
3346 if (count > 0)
3347 {
3348 --count;
3349 SvIVX (count_sv) = count;
3350 XSRETURN_YES;
3351 }
3352 else
3353 XSRETURN_NO;
3354 }
3355
3356 void
3357 waiters (SV *self)
3358 PPCODE:
3359 {
3360 AV *av = (AV *)SvRV (self);
3361 int wcount = AvFILLp (av) + 1 - 1;
3362
3363 if (GIMME_V == G_SCALAR)
3364 XPUSHs (sv_2mortal (newSViv (wcount)));
3365 else
3366 {
3367 int i;
3368 EXTEND (SP, wcount);
3369 for (i = 1; i <= wcount; ++i)
3370 PUSHs (sv_2mortal (newRV_inc (AvARRAY (av)[i])));
3371 }
3372 }
3373
3374 MODULE = Coro::State PACKAGE = Coro::Signal
3375
3376 SV *
3377 new (SV *klass)
3378 CODE:
3379 RETVAL = sv_bless (
3380 coro_waitarray_new (aTHX_ 0),
3381 GvSTASH (CvGV (cv))
3382 );
3383 OUTPUT:
3384 RETVAL
3385
3386 void
3387 wait (...)
3388 CODE:
3389 CORO_EXECUTE_SLF_XS (slf_init_signal_wait);
3390
3391 void
3392 broadcast (SV *self)
3393 CODE:
3394 {
3395 AV *av = (AV *)SvRV (self);
3396 coro_signal_wake (aTHX_ av, AvFILLp (av));
3397 }
3398
3399 void
3400 send (SV *self)
3401 CODE:
3402 {
3403 AV *av = (AV *)SvRV (self);
3404
3405 if (AvFILLp (av))
3406 coro_signal_wake (aTHX_ av, 1);
3407 else
3408 SvIVX (AvARRAY (av)[0]) = 1; /* remember the signal */
3409 }
3410
3411 IV
3412 awaited (SV *self)
3413 CODE:
3414 RETVAL = AvFILLp ((AV *)SvRV (self)) + 1 - 1;
3415 OUTPUT:
3416 RETVAL
3417
3418
3419 MODULE = Coro::State PACKAGE = Coro::AnyEvent
3420
3421 BOOT:
3422 sv_activity = coro_get_sv (aTHX_ "Coro::AnyEvent::ACTIVITY", TRUE);
3423
3424 void
3425 _schedule (...)
3426 CODE:
3427 {
3428 static int incede;
3429
3430 api_cede_notself (aTHX);
3431
3432 ++incede;
3433 while (coro_nready >= incede && api_cede (aTHX))
3434 ;
3435
3436 sv_setsv (sv_activity, &PL_sv_undef);
3437 if (coro_nready >= incede)
3438 {
3439 PUSHMARK (SP);
3440 PUTBACK;
3441 call_pv ("Coro::AnyEvent::_activity", G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
3442 }
3443
3444 --incede;
3445 }
3446
3447
3448 MODULE = Coro::State PACKAGE = Coro::AIO
3449
3450 void
3451 _register (char *target, char *proto, SV *req)
3452 CODE:
3453 {
3454 CV *req_cv = coro_sv_2cv (aTHX_ req);
3455 /* newXSproto doesn't return the CV on 5.8 */
3456 CV *slf_cv = newXS (target, coro_aio_req_xs, __FILE__);
3457 sv_setpv ((SV *)slf_cv, proto);
3458 sv_magicext ((SV *)slf_cv, (SV *)req_cv, CORO_MAGIC_type_aio, 0, 0, 0);
3459 }
3460