ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro/State.xs
Revision: 1.317
Committed: Thu Nov 20 06:28:52 2008 UTC (15 years, 6 months ago) by root
Branch: MAIN
Changes since 1.316: +67 -18 lines
Log Message:
cede_to/schedule_to

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