ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro/State.xs
Revision: 1.278
Committed: Sun Nov 16 07:09:28 2008 UTC (15 years, 6 months ago) by root
Branch: MAIN
Changes since 1.277: +24 -66 lines
Log Message:
simpler than I thought

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