ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro/State.xs
Revision: 1.286
Committed: Mon Nov 17 04:19:49 2008 UTC (15 years, 6 months ago) by root
Branch: MAIN
Changes since 1.285: +13 -8 lines
Log Message:
any argn

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