ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro/State.xs
Revision: 1.405
Committed: Sat Jun 11 13:01:26 2011 UTC (12 years, 11 months ago) by root
Branch: MAIN
Changes since 1.404: +103 -23 lines
Log Message:
jit, -ERRSV-DEFSV

File Contents

# Content
1 /* this works around a bug in mingw32 providing a non-working setjmp */
2 #define USE_NO_MINGW_SETJMP_TWO_ARGS
3
4 #define NDEBUG 1
5
6 #include "libcoro/coro.c"
7
8 #define PERL_NO_GET_CONTEXT
9 #define PERL_EXT
10
11 #include "EXTERN.h"
12 #include "perl.h"
13 #include "XSUB.h"
14 #include "perliol.h"
15
16 #include "schmorp.h"
17 #include "ecb.h"
18
19 #include <stddef.h>
20 #include <stdio.h>
21 #include <errno.h>
22 #include <assert.h>
23
24 #ifndef SVs_PADSTALE
25 # define SVs_PADSTALE 0
26 #endif
27
28 #if defined(_WIN32)
29 # undef HAS_GETTIMEOFDAY
30 # undef setjmp
31 # undef longjmp
32 # undef _exit
33 # define setjmp _setjmp /* deep magic */
34 #else
35 # include <inttypes.h> /* most portable stdint.h */
36 #endif
37
38 #ifdef HAVE_MMAP
39 # include <unistd.h>
40 # include <sys/mman.h>
41 # ifndef MAP_ANONYMOUS
42 # ifdef MAP_ANON
43 # define MAP_ANONYMOUS MAP_ANON
44 # else
45 # undef HAVE_MMAP
46 # endif
47 # endif
48 # include <limits.h>
49 # ifndef PAGESIZE
50 # define PAGESIZE pagesize
51 # define BOOT_PAGESIZE pagesize = sysconf (_SC_PAGESIZE)
52 static long pagesize;
53 # else
54 # define BOOT_PAGESIZE (void)0
55 # endif
56 #else
57 # define PAGESIZE 0
58 # define BOOT_PAGESIZE (void)0
59 #endif
60
61 #if CORO_USE_VALGRIND
62 # include <valgrind/valgrind.h>
63 #endif
64
65 /* the maximum number of idle cctx that will be pooled */
66 static int cctx_max_idle = 4;
67
68 #if !__i386 && !__x86_64 && !__powerpc && !__m68k && !__alpha && !__mips && !__sparc64
69 # undef CORO_STACKGUARD
70 #endif
71
72 #ifndef CORO_STACKGUARD
73 # define CORO_STACKGUARD 0
74 #endif
75
76 /* prefer perl internal functions over our own? */
77 #ifndef CORO_PREFER_PERL_FUNCTIONS
78 # define CORO_PREFER_PERL_FUNCTIONS 0
79 #endif
80
81 /* The next macros try to return the current stack pointer, in an as
82 * portable way as possible. */
83 #if __GNUC__ >= 4
84 # define dSTACKLEVEL int stacklevel_dummy
85 # define STACKLEVEL __builtin_frame_address (0)
86 #else
87 # define dSTACKLEVEL volatile void *stacklevel
88 # define STACKLEVEL ((void *)&stacklevel)
89 #endif
90
91 #define IN_DESTRUCT PL_dirty
92
93 #include "CoroAPI.h"
94 #define GCoroAPI (&coroapi) /* very sneaky */
95
96 #ifdef USE_ITHREADS
97 # if CORO_PTHREAD
98 static void *coro_thx;
99 # endif
100 #endif
101
102 /* used in state.h */
103 #define VAR(name,type) VARx(name, PL_ ## name, type)
104
105 #ifdef __linux
106 # include <time.h> /* for timespec */
107 # include <syscall.h> /* for SYS_* */
108 # ifdef SYS_clock_gettime
109 # define coro_clock_gettime(id, ts) syscall (SYS_clock_gettime, (id), (ts))
110 # define CORO_CLOCK_MONOTONIC 1
111 # define CORO_CLOCK_THREAD_CPUTIME_ID 3
112 # endif
113 #endif
114
115 static double (*nvtime)(); /* so why doesn't it take void? */
116 static void (*u2time)(pTHX_ UV ret[2]);
117
118 /* we hijack an hopefully unused CV flag for our purposes */
119 #define CVf_SLF 0x4000
120 static OP *pp_slf (pTHX);
121 static void slf_destroy (pTHX_ struct coro *coro);
122
123 static U32 cctx_gen;
124 static size_t cctx_stacksize = CORO_STACKSIZE;
125 static struct CoroAPI coroapi;
126 static AV *main_mainstack; /* used to differentiate between $main and others */
127 static JMPENV *main_top_env;
128 static HV *coro_state_stash, *coro_stash;
129 static volatile SV *coro_mortal; /* will be freed/thrown after next transfer */
130
131 static AV *av_destroy; /* destruction queue */
132 static SV *sv_manager; /* the manager coro */
133 static SV *sv_idle; /* $Coro::idle */
134
135 static GV *irsgv; /* $/ */
136 static GV *stdoutgv; /* *STDOUT */
137 static SV *rv_diehook;
138 static SV *rv_warnhook;
139 static HV *hv_sig; /* %SIG */
140
141 /* async_pool helper stuff */
142 static SV *sv_pool_rss;
143 static SV *sv_pool_size;
144 static SV *sv_async_pool_idle; /* description string */
145 static AV *av_async_pool; /* idle pool */
146 static SV *sv_Coro; /* class string */
147 static CV *cv_pool_handler;
148
149 /* Coro::AnyEvent */
150 static SV *sv_activity;
151
152 /* enable processtime/realtime profiling */
153 static char enable_times;
154 typedef U32 coro_ts[2];
155 static coro_ts time_real, time_cpu;
156 static char times_valid;
157
158 static struct coro_cctx *cctx_first;
159 static int cctx_count, cctx_idle;
160
161 enum
162 {
163 CC_MAPPED = 0x01,
164 CC_NOREUSE = 0x02, /* throw this away after tracing */
165 CC_TRACE = 0x04,
166 CC_TRACE_SUB = 0x08, /* trace sub calls */
167 CC_TRACE_LINE = 0x10, /* trace each statement */
168 CC_TRACE_ALL = CC_TRACE_SUB | CC_TRACE_LINE,
169 };
170
171 /* this is a structure representing a c-level coroutine */
172 typedef struct coro_cctx
173 {
174 struct coro_cctx *next;
175
176 /* the stack */
177 void *sptr;
178 size_t ssize;
179
180 /* cpu state */
181 void *idle_sp; /* sp of top-level transfer/schedule/cede call */
182 JMPENV *idle_te; /* same as idle_sp, but for top_env, TODO: remove once stable */
183 JMPENV *top_env;
184 coro_context cctx;
185
186 U32 gen;
187 #if CORO_USE_VALGRIND
188 int valgrind_id;
189 #endif
190 unsigned char flags;
191 } coro_cctx;
192
193 static coro_cctx *cctx_current; /* the currently running cctx */
194
195 /*****************************************************************************/
196
197 static MGVTBL coro_state_vtbl;
198
199 enum
200 {
201 CF_RUNNING = 0x0001, /* coroutine is running */
202 CF_READY = 0x0002, /* coroutine is ready */
203 CF_NEW = 0x0004, /* has never been switched to */
204 CF_ZOMBIE = 0x0008, /* coroutine data has been freed */
205 CF_SUSPENDED = 0x0010, /* coroutine can't be scheduled */
206 CF_NOCANCEL = 0x0020, /* cannot cancel, set slf_frame.data to 1 (hackish) */
207 };
208
209 /* the structure where most of the perl state is stored, overlaid on the cxstack */
210 typedef struct
211 {
212 #define VARx(name,expr,type) type name;
213 # include "state.h"
214 #undef VARx
215 } perl_slots;
216
217 // how many context stack entries do we need for perl_slots
218 #define SLOT_COUNT ((sizeof (perl_slots) + sizeof (PERL_CONTEXT) - 1) / sizeof (PERL_CONTEXT))
219
220 /* this is a structure representing a perl-level coroutine */
221 struct coro
222 {
223 /* the C coroutine allocated to this perl coroutine, if any */
224 coro_cctx *cctx;
225
226 /* ready queue */
227 struct coro *next_ready;
228
229 /* state data */
230 struct CoroSLF slf_frame; /* saved slf frame */
231 AV *mainstack;
232 perl_slots *slot; /* basically the saved sp */
233
234 CV *startcv; /* the CV to execute */
235 AV *args; /* data associated with this coroutine (initial args) */
236 int flags; /* CF_ flags */
237 HV *hv; /* the perl hash associated with this coro, if any */
238
239 /* statistics */
240 int usecount; /* number of transfers to this coro */
241
242 /* coro process data */
243 int prio;
244 SV *except; /* exception to be thrown */
245 SV *rouse_cb; /* last rouse callback */
246 AV *on_destroy; /* callbacks or coros to notify on destroy */
247 AV *status; /* the exit status list */
248
249 /* async_pool */
250 SV *saved_deffh;
251 SV *invoke_cb;
252 AV *invoke_av;
253
254 /* on_enter/on_leave */
255 AV *on_enter;
256 AV *on_leave;
257
258 /* swap_sv */
259 AV *swap_sv;
260
261 /* times */
262 coro_ts t_cpu, t_real;
263
264 /* linked list */
265 struct coro *next, *prev;
266 };
267
268 typedef struct coro *Coro__State;
269 typedef struct coro *Coro__State_or_hashref;
270
271 /* the following variables are effectively part of the perl context */
272 /* and get copied between struct coro and these variables */
273 /* the main reason we don't support windows process emulation */
274 static struct CoroSLF slf_frame; /* the current slf frame */
275
276 /** Coro ********************************************************************/
277
278 #define CORO_PRIO_MAX 3
279 #define CORO_PRIO_HIGH 1
280 #define CORO_PRIO_NORMAL 0
281 #define CORO_PRIO_LOW -1
282 #define CORO_PRIO_IDLE -3
283 #define CORO_PRIO_MIN -4
284
285 /* for Coro.pm */
286 static SV *coro_current;
287 static SV *coro_readyhook;
288 static struct coro *coro_ready [CORO_PRIO_MAX - CORO_PRIO_MIN + 1][2]; /* head|tail */
289 static CV *cv_coro_run;
290 static struct coro *coro_first;
291 #define coro_nready coroapi.nready
292
293 /** JIT *********************************************************************/
294
295 #if CORO_JIT
296 #ifndef CORO_JIT_TYPE
297 #if __linux && __amd64
298 #define CORO_JIT_TYPE "amd64-unix"
299 typedef void (*load_save_perl_slots_type)(perl_slots *);
300 #else
301 #undef CORO_JIT
302 #endif
303 #endif
304 #endif
305
306 #if CORO_JIT
307
308 static load_save_perl_slots_type load_perl_slots, save_perl_slots;
309
310 #endif
311
312 /** Coro::Select ************************************************************/
313
314 static OP *(*coro_old_pp_sselect) (pTHX);
315 static SV *coro_select_select;
316
317 /* horrible hack, but if it works... */
318 static OP *
319 coro_pp_sselect (pTHX)
320 {
321 dSP;
322 PUSHMARK (SP - 4); /* fake argument list */
323 XPUSHs (coro_select_select);
324 PUTBACK;
325
326 /* entersub is an UNOP, select a LISTOP... keep your fingers crossed */
327 PL_op->op_flags |= OPf_STACKED;
328 PL_op->op_private = 0;
329 return PL_ppaddr [OP_ENTERSUB](aTHX);
330 }
331
332 /** time stuff **************************************************************/
333
334 #ifdef HAS_GETTIMEOFDAY
335
336 ECB_INLINE void
337 coro_u2time (pTHX_ UV ret[2])
338 {
339 struct timeval tv;
340 gettimeofday (&tv, 0);
341
342 ret [0] = tv.tv_sec;
343 ret [1] = tv.tv_usec;
344 }
345
346 ECB_INLINE double
347 coro_nvtime ()
348 {
349 struct timeval tv;
350 gettimeofday (&tv, 0);
351
352 return tv.tv_sec + tv.tv_usec * 1e-6;
353 }
354
355 ECB_INLINE void
356 time_init (pTHX)
357 {
358 nvtime = coro_nvtime;
359 u2time = coro_u2time;
360 }
361
362 #else
363
364 ECB_INLINE void
365 time_init (pTHX)
366 {
367 SV **svp;
368
369 require_pv ("Time/HiRes.pm");
370
371 svp = hv_fetch (PL_modglobal, "Time::NVtime", 12, 0);
372
373 if (!svp) croak ("Time::HiRes is required, but missing. Caught");
374 if (!SvIOK (*svp)) croak ("Time::NVtime isn't a function pointer. Caught");
375
376 nvtime = INT2PTR (double (*)(), SvIV (*svp));
377
378 svp = hv_fetch (PL_modglobal, "Time::U2time", 12, 0);
379 u2time = INT2PTR (void (*)(pTHX_ UV ret[2]), SvIV (*svp));
380 }
381
382 #endif
383
384 /** lowlevel stuff **********************************************************/
385
386 static SV * ecb_noinline
387 coro_get_sv (pTHX_ const char *name, int create)
388 {
389 #if PERL_VERSION_ATLEAST (5,10,0)
390 /* silence stupid and wrong 5.10 warning that I am unable to switch off */
391 get_sv (name, create);
392 #endif
393 return get_sv (name, create);
394 }
395
396 static AV * ecb_noinline
397 coro_get_av (pTHX_ const char *name, int create)
398 {
399 #if PERL_VERSION_ATLEAST (5,10,0)
400 /* silence stupid and wrong 5.10 warning that I am unable to switch off */
401 get_av (name, create);
402 #endif
403 return get_av (name, create);
404 }
405
406 static HV * ecb_noinline
407 coro_get_hv (pTHX_ const char *name, int create)
408 {
409 #if PERL_VERSION_ATLEAST (5,10,0)
410 /* silence stupid and wrong 5.10 warning that I am unable to switch off */
411 get_hv (name, create);
412 #endif
413 return get_hv (name, create);
414 }
415
416 ECB_INLINE void
417 coro_times_update ()
418 {
419 #ifdef coro_clock_gettime
420 struct timespec ts;
421
422 ts.tv_sec = ts.tv_nsec = 0;
423 coro_clock_gettime (CORO_CLOCK_THREAD_CPUTIME_ID, &ts);
424 time_cpu [0] = ts.tv_sec; time_cpu [1] = ts.tv_nsec;
425
426 ts.tv_sec = ts.tv_nsec = 0;
427 coro_clock_gettime (CORO_CLOCK_MONOTONIC, &ts);
428 time_real [0] = ts.tv_sec; time_real [1] = ts.tv_nsec;
429 #else
430 dTHX;
431 UV tv[2];
432
433 u2time (aTHX_ tv);
434 time_real [0] = tv [0];
435 time_real [1] = tv [1] * 1000;
436 #endif
437 }
438
439 ECB_INLINE void
440 coro_times_add (struct coro *c)
441 {
442 c->t_real [1] += time_real [1];
443 if (c->t_real [1] > 1000000000) { c->t_real [1] -= 1000000000; ++c->t_real [0]; }
444 c->t_real [0] += time_real [0];
445
446 c->t_cpu [1] += time_cpu [1];
447 if (c->t_cpu [1] > 1000000000) { c->t_cpu [1] -= 1000000000; ++c->t_cpu [0]; }
448 c->t_cpu [0] += time_cpu [0];
449 }
450
451 ECB_INLINE void
452 coro_times_sub (struct coro *c)
453 {
454 if (c->t_real [1] < time_real [1]) { c->t_real [1] += 1000000000; --c->t_real [0]; }
455 c->t_real [1] -= time_real [1];
456 c->t_real [0] -= time_real [0];
457
458 if (c->t_cpu [1] < time_cpu [1]) { c->t_cpu [1] += 1000000000; --c->t_cpu [0]; }
459 c->t_cpu [1] -= time_cpu [1];
460 c->t_cpu [0] -= time_cpu [0];
461 }
462
463 /*****************************************************************************/
464 /* magic glue */
465
466 #define CORO_MAGIC_type_cv 26
467 #define CORO_MAGIC_type_state PERL_MAGIC_ext
468
469 #define CORO_MAGIC_NN(sv, type) \
470 (ecb_expect_true (SvMAGIC (sv)->mg_type == type) \
471 ? SvMAGIC (sv) \
472 : mg_find (sv, type))
473
474 #define CORO_MAGIC(sv, type) \
475 (ecb_expect_true (SvMAGIC (sv)) \
476 ? CORO_MAGIC_NN (sv, type) \
477 : 0)
478
479 #define CORO_MAGIC_cv(cv) CORO_MAGIC (((SV *)(cv)), CORO_MAGIC_type_cv)
480 #define CORO_MAGIC_state(sv) CORO_MAGIC_NN (((SV *)(sv)), CORO_MAGIC_type_state)
481
482 ECB_INLINE MAGIC *
483 SvSTATEhv_p (pTHX_ SV *coro)
484 {
485 MAGIC *mg;
486
487 if (ecb_expect_true (
488 SvTYPE (coro) == SVt_PVHV
489 && (mg = CORO_MAGIC_state (coro))
490 && mg->mg_virtual == &coro_state_vtbl
491 ))
492 return mg;
493
494 return 0;
495 }
496
497 ECB_INLINE struct coro *
498 SvSTATE_ (pTHX_ SV *coro)
499 {
500 MAGIC *mg;
501
502 if (SvROK (coro))
503 coro = SvRV (coro);
504
505 mg = SvSTATEhv_p (aTHX_ coro);
506 if (!mg)
507 croak ("Coro::State object required");
508
509 return (struct coro *)mg->mg_ptr;
510 }
511
512 #define SvSTATE(sv) SvSTATE_ (aTHX_ (sv))
513
514 /* faster than SvSTATE, but expects a coroutine hv */
515 #define SvSTATE_hv(hv) ((struct coro *)CORO_MAGIC_NN ((SV *)hv, CORO_MAGIC_type_state)->mg_ptr)
516 #define SvSTATE_current SvSTATE_hv (SvRV (coro_current))
517
518 /*****************************************************************************/
519 /* padlist management and caching */
520
521 ECB_INLINE AV *
522 coro_derive_padlist (pTHX_ CV *cv)
523 {
524 AV *padlist = CvPADLIST (cv);
525 AV *newpadlist, *newpad;
526
527 newpadlist = newAV ();
528 AvREAL_off (newpadlist);
529 #if PERL_VERSION_ATLEAST (5,10,0)
530 Perl_pad_push (aTHX_ padlist, AvFILLp (padlist) + 1);
531 #else
532 Perl_pad_push (aTHX_ padlist, AvFILLp (padlist) + 1, 1);
533 #endif
534 newpad = (AV *)AvARRAY (padlist)[AvFILLp (padlist)];
535 --AvFILLp (padlist);
536
537 av_store (newpadlist, 0, SvREFCNT_inc_NN (AvARRAY (padlist)[0]));
538 av_store (newpadlist, 1, (SV *)newpad);
539
540 return newpadlist;
541 }
542
543 ECB_INLINE void
544 free_padlist (pTHX_ AV *padlist)
545 {
546 /* may be during global destruction */
547 if (!IN_DESTRUCT)
548 {
549 I32 i = AvFILLp (padlist);
550
551 while (i > 0) /* special-case index 0 */
552 {
553 /* we try to be extra-careful here */
554 AV *av = (AV *)AvARRAY (padlist)[i--];
555 I32 j = AvFILLp (av);
556
557 while (j >= 0)
558 SvREFCNT_dec (AvARRAY (av)[j--]);
559
560 AvFILLp (av) = -1;
561 SvREFCNT_dec (av);
562 }
563
564 SvREFCNT_dec (AvARRAY (padlist)[0]);
565
566 AvFILLp (padlist) = -1;
567 SvREFCNT_dec ((SV*)padlist);
568 }
569 }
570
571 static int
572 coro_cv_free (pTHX_ SV *sv, MAGIC *mg)
573 {
574 AV *padlist;
575 AV *av = (AV *)mg->mg_obj;
576
577 /* perl manages to free our internal AV and _then_ call us */
578 if (IN_DESTRUCT)
579 return 0;
580
581 /* casting is fun. */
582 while (&PL_sv_undef != (SV *)(padlist = (AV *)av_pop (av)))
583 free_padlist (aTHX_ padlist);
584
585 SvREFCNT_dec (av); /* sv_magicext increased the refcount */
586
587 return 0;
588 }
589
590 static MGVTBL coro_cv_vtbl = {
591 0, 0, 0, 0,
592 coro_cv_free
593 };
594
595 /* the next two functions merely cache the padlists */
596 ECB_INLINE void
597 get_padlist (pTHX_ CV *cv)
598 {
599 MAGIC *mg = CORO_MAGIC_cv (cv);
600 AV *av;
601
602 if (ecb_expect_true (mg && AvFILLp ((av = (AV *)mg->mg_obj)) >= 0))
603 CvPADLIST (cv) = (AV *)AvARRAY (av)[AvFILLp (av)--];
604 else
605 {
606 #if CORO_PREFER_PERL_FUNCTIONS
607 /* this is probably cleaner? but also slower! */
608 /* in practise, it seems to be less stable */
609 CV *cp = Perl_cv_clone (aTHX_ cv);
610 CvPADLIST (cv) = CvPADLIST (cp);
611 CvPADLIST (cp) = 0;
612 SvREFCNT_dec (cp);
613 #else
614 CvPADLIST (cv) = coro_derive_padlist (aTHX_ cv);
615 #endif
616 }
617 }
618
619 ECB_INLINE void
620 put_padlist (pTHX_ CV *cv)
621 {
622 MAGIC *mg = CORO_MAGIC_cv (cv);
623 AV *av;
624
625 if (ecb_expect_false (!mg))
626 mg = sv_magicext ((SV *)cv, (SV *)newAV (), CORO_MAGIC_type_cv, &coro_cv_vtbl, 0, 0);
627
628 av = (AV *)mg->mg_obj;
629
630 if (ecb_expect_false (AvFILLp (av) >= AvMAX (av)))
631 av_extend (av, AvFILLp (av) + 1);
632
633 AvARRAY (av)[++AvFILLp (av)] = (SV *)CvPADLIST (cv);
634 }
635
636 /** load & save, init *******************************************************/
637
638 /* swap sv heads, at least logically */
639 static void
640 swap_svs (pTHX_ Coro__State c)
641 {
642 int i;
643
644 for (i = 0; i <= AvFILLp (c->swap_sv); )
645 {
646 SV *a = AvARRAY (c->swap_sv)[i++];
647 SV *b = AvARRAY (c->swap_sv)[i++];
648
649 const U32 keep = SVs_PADSTALE | SVs_PADTMP | SVs_PADMY; /* keep these flags */
650 SV tmp;
651
652 /* swap sv_any */
653 SvANY (&tmp) = SvANY (a); SvANY (a) = SvANY (b); SvANY (b) = SvANY (&tmp);
654
655 /* swap sv_flags */
656 SvFLAGS (&tmp) = SvFLAGS (a);
657 SvFLAGS (a) = (SvFLAGS (a) & keep) | (SvFLAGS (b ) & ~keep);
658 SvFLAGS (b) = (SvFLAGS (b) & keep) | (SvFLAGS (&tmp) & ~keep);
659
660 #if PERL_VERSION_ATLEAST (5,10,0)
661 /* perl 5.10 complicates this _quite_ a bit, but it also is
662 * much faster, so no quarrels here. alternatively, we could
663 * sv_upgrade to avoid this.
664 */
665 {
666 /* swap sv_u */
667 tmp.sv_u = a->sv_u; a->sv_u = b->sv_u; b->sv_u = tmp.sv_u;
668
669 /* if SvANY points to the head, we need to adjust the pointers,
670 * as the pointer for a still points to b, and maybe vice versa.
671 */
672 #define svany_in_head(type) \
673 (((1 << SVt_NULL) | (1 << SVt_BIND) | (1 << SVt_IV) | (1 << SVt_RV)) & (1 << (type)))
674
675 if (svany_in_head (SvTYPE (a)))
676 SvANY (a) = (void *)((PTRV)SvANY (a) - (PTRV)b + (PTRV)a);
677
678 if (svany_in_head (SvTYPE (b)))
679 SvANY (b) = (void *)((PTRV)SvANY (b) - (PTRV)a + (PTRV)b);
680 }
681 #endif
682 }
683 }
684
685 #define SWAP_SVS(coro) \
686 if (ecb_expect_false ((coro)->swap_sv)) \
687 swap_svs (aTHX_ (coro))
688
689 static void
690 on_enterleave_call (pTHX_ SV *cb);
691
692 static void
693 load_perl (pTHX_ Coro__State c)
694 {
695 perl_slots *slot = c->slot;
696 c->slot = 0;
697
698 PL_mainstack = c->mainstack;
699
700 #if CORO_JIT
701 load_perl_slots (slot);
702 #else
703 #define VARx(name,expr,type) expr = slot->name;
704 # include "state.h"
705 #undef VARx
706 #endif
707
708 {
709 dSP;
710
711 CV *cv;
712
713 /* now do the ugly restore mess */
714 while (ecb_expect_true (cv = (CV *)POPs))
715 {
716 put_padlist (aTHX_ cv); /* mark this padlist as available */
717 CvDEPTH (cv) = PTR2IV (POPs);
718 CvPADLIST (cv) = (AV *)POPs;
719 }
720
721 PUTBACK;
722 }
723
724 slf_frame = c->slf_frame;
725 CORO_THROW = c->except;
726
727 if (ecb_expect_false (enable_times))
728 {
729 if (ecb_expect_false (!times_valid))
730 coro_times_update ();
731
732 coro_times_sub (c);
733 }
734
735 if (ecb_expect_false (c->on_enter))
736 {
737 int i;
738
739 for (i = 0; i <= AvFILLp (c->on_enter); ++i)
740 on_enterleave_call (aTHX_ AvARRAY (c->on_enter)[i]);
741 }
742
743 SWAP_SVS (c);
744 }
745
746 static void
747 save_perl (pTHX_ Coro__State c)
748 {
749 SWAP_SVS (c);
750
751 if (ecb_expect_false (c->on_leave))
752 {
753 int i;
754
755 for (i = AvFILLp (c->on_leave); i >= 0; --i)
756 on_enterleave_call (aTHX_ AvARRAY (c->on_leave)[i]);
757 }
758
759 times_valid = 0;
760
761 if (ecb_expect_false (enable_times))
762 {
763 coro_times_update (); times_valid = 1;
764 coro_times_add (c);
765 }
766
767 c->except = CORO_THROW;
768 c->slf_frame = slf_frame;
769
770 {
771 dSP;
772 I32 cxix = cxstack_ix;
773 PERL_CONTEXT *ccstk = cxstack;
774 PERL_SI *top_si = PL_curstackinfo;
775
776 /*
777 * the worst thing you can imagine happens first - we have to save
778 * (and reinitialize) all cv's in the whole callchain :(
779 */
780
781 XPUSHs (Nullsv);
782 /* this loop was inspired by pp_caller */
783 for (;;)
784 {
785 while (ecb_expect_true (cxix >= 0))
786 {
787 PERL_CONTEXT *cx = &ccstk[cxix--];
788
789 if (ecb_expect_true (CxTYPE (cx) == CXt_SUB) || ecb_expect_false (CxTYPE (cx) == CXt_FORMAT))
790 {
791 CV *cv = cx->blk_sub.cv;
792
793 if (ecb_expect_true (CvDEPTH (cv)))
794 {
795 EXTEND (SP, 3);
796 PUSHs ((SV *)CvPADLIST (cv));
797 PUSHs (INT2PTR (SV *, (IV)CvDEPTH (cv)));
798 PUSHs ((SV *)cv);
799
800 CvDEPTH (cv) = 0;
801 get_padlist (aTHX_ cv);
802 }
803 }
804 }
805
806 if (ecb_expect_true (top_si->si_type == PERLSI_MAIN))
807 break;
808
809 top_si = top_si->si_prev;
810 ccstk = top_si->si_cxstack;
811 cxix = top_si->si_cxix;
812 }
813
814 PUTBACK;
815 }
816
817 /* allocate some space on the context stack for our purposes */
818 if (ecb_expect_false (cxstack_ix + SLOT_COUNT >= cxstack_max))
819 {
820 unsigned int i;
821
822 for (i = 0; i < SLOT_COUNT; ++i)
823 CXINC;
824
825 cxstack_ix -= SLOT_COUNT; /* undo allocation */
826 }
827
828 c->mainstack = PL_mainstack;
829
830 {
831 perl_slots *slot = c->slot = (perl_slots *)(cxstack + cxstack_ix + 1);
832
833 #if CORO_JIT
834 save_perl_slots (slot);
835 #else
836 #define VARx(name,expr,type) slot->name = expr;
837 # include "state.h"
838 #undef VARx
839 #endif
840 }
841 }
842
843 /*
844 * allocate various perl stacks. This is almost an exact copy
845 * of perl.c:init_stacks, except that it uses less memory
846 * on the (sometimes correct) assumption that coroutines do
847 * not usually need a lot of stackspace.
848 */
849 #if CORO_PREFER_PERL_FUNCTIONS
850 # define coro_init_stacks(thx) init_stacks ()
851 #else
852 static void
853 coro_init_stacks (pTHX)
854 {
855 PL_curstackinfo = new_stackinfo(32, 4 + SLOT_COUNT); /* 3 is minimum due to perl rounding down in scope.c:GROW() */
856 PL_curstackinfo->si_type = PERLSI_MAIN;
857 PL_curstack = PL_curstackinfo->si_stack;
858 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
859
860 PL_stack_base = AvARRAY(PL_curstack);
861 PL_stack_sp = PL_stack_base;
862 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
863
864 New(50,PL_tmps_stack,32,SV*);
865 PL_tmps_floor = -1;
866 PL_tmps_ix = -1;
867 PL_tmps_max = 32;
868
869 New(54,PL_markstack,16,I32);
870 PL_markstack_ptr = PL_markstack;
871 PL_markstack_max = PL_markstack + 16;
872
873 #ifdef SET_MARK_OFFSET
874 SET_MARK_OFFSET;
875 #endif
876
877 New(54,PL_scopestack,8,I32);
878 PL_scopestack_ix = 0;
879 PL_scopestack_max = 8;
880
881 New(54,PL_savestack,24,ANY);
882 PL_savestack_ix = 0;
883 PL_savestack_max = 24;
884
885 #if !PERL_VERSION_ATLEAST (5,10,0)
886 New(54,PL_retstack,4,OP*);
887 PL_retstack_ix = 0;
888 PL_retstack_max = 4;
889 #endif
890 }
891 #endif
892
893 /*
894 * destroy the stacks, the callchain etc...
895 */
896 static void
897 coro_destruct_stacks (pTHX)
898 {
899 while (PL_curstackinfo->si_next)
900 PL_curstackinfo = PL_curstackinfo->si_next;
901
902 while (PL_curstackinfo)
903 {
904 PERL_SI *p = PL_curstackinfo->si_prev;
905
906 if (!IN_DESTRUCT)
907 SvREFCNT_dec (PL_curstackinfo->si_stack);
908
909 Safefree (PL_curstackinfo->si_cxstack);
910 Safefree (PL_curstackinfo);
911 PL_curstackinfo = p;
912 }
913
914 Safefree (PL_tmps_stack);
915 Safefree (PL_markstack);
916 Safefree (PL_scopestack);
917 Safefree (PL_savestack);
918 #if !PERL_VERSION_ATLEAST (5,10,0)
919 Safefree (PL_retstack);
920 #endif
921 }
922
923 #define CORO_RSS \
924 rss += sizeof (SYM (curstackinfo)); \
925 rss += (SYM (curstackinfo->si_cxmax) + 1) * sizeof (PERL_CONTEXT); \
926 rss += sizeof (SV) + sizeof (struct xpvav) + (1 + AvMAX (SYM (curstack))) * sizeof (SV *); \
927 rss += SYM (tmps_max) * sizeof (SV *); \
928 rss += (SYM (markstack_max) - SYM (markstack_ptr)) * sizeof (I32); \
929 rss += SYM (scopestack_max) * sizeof (I32); \
930 rss += SYM (savestack_max) * sizeof (ANY);
931
932 static size_t
933 coro_rss (pTHX_ struct coro *coro)
934 {
935 size_t rss = sizeof (*coro);
936
937 if (coro->mainstack)
938 {
939 if (coro->flags & CF_RUNNING)
940 {
941 #define SYM(sym) PL_ ## sym
942 CORO_RSS;
943 #undef SYM
944 }
945 else
946 {
947 #define SYM(sym) coro->slot->sym
948 CORO_RSS;
949 #undef SYM
950 }
951 }
952
953 return rss;
954 }
955
956 /** coroutine stack handling ************************************************/
957
958 static int (*orig_sigelem_get) (pTHX_ SV *sv, MAGIC *mg);
959 static int (*orig_sigelem_set) (pTHX_ SV *sv, MAGIC *mg);
960 static int (*orig_sigelem_clr) (pTHX_ SV *sv, MAGIC *mg);
961
962 /* apparently < 5.8.8 */
963 #ifndef MgPV_nolen_const
964 #define MgPV_nolen_const(mg) (((((int)(mg)->mg_len)) == HEf_SVKEY) ? \
965 SvPV_nolen((SV*)((mg)->mg_ptr)) : \
966 (const char*)(mg)->mg_ptr)
967 #endif
968
969 /*
970 * This overrides the default magic get method of %SIG elements.
971 * The original one doesn't provide for reading back of PL_diehook/PL_warnhook
972 * and instead of trying to save and restore the hash elements (extremely slow),
973 * we just provide our own readback here.
974 */
975 static int ecb_cold
976 coro_sigelem_get (pTHX_ SV *sv, MAGIC *mg)
977 {
978 const char *s = MgPV_nolen_const (mg);
979
980 if (*s == '_')
981 {
982 SV **svp = 0;
983
984 if (strEQ (s, "__DIE__" )) svp = &PL_diehook;
985 if (strEQ (s, "__WARN__")) svp = &PL_warnhook;
986
987 if (svp)
988 {
989 sv_setsv (sv, *svp ? *svp : &PL_sv_undef);
990 return 0;
991 }
992 }
993
994 return orig_sigelem_get ? orig_sigelem_get (aTHX_ sv, mg) : 0;
995 }
996
997 static int ecb_cold
998 coro_sigelem_clr (pTHX_ SV *sv, MAGIC *mg)
999 {
1000 const char *s = MgPV_nolen_const (mg);
1001
1002 if (*s == '_')
1003 {
1004 SV **svp = 0;
1005
1006 if (strEQ (s, "__DIE__" )) svp = &PL_diehook;
1007 if (strEQ (s, "__WARN__")) svp = &PL_warnhook;
1008
1009 if (svp)
1010 {
1011 SV *old = *svp;
1012 *svp = 0;
1013 SvREFCNT_dec (old);
1014 return 0;
1015 }
1016 }
1017
1018 return orig_sigelem_clr ? orig_sigelem_clr (aTHX_ sv, mg) : 0;
1019 }
1020
1021 static int ecb_cold
1022 coro_sigelem_set (pTHX_ SV *sv, MAGIC *mg)
1023 {
1024 const char *s = MgPV_nolen_const (mg);
1025
1026 if (*s == '_')
1027 {
1028 SV **svp = 0;
1029
1030 if (strEQ (s, "__DIE__" )) svp = &PL_diehook;
1031 if (strEQ (s, "__WARN__")) svp = &PL_warnhook;
1032
1033 if (svp)
1034 {
1035 SV *old = *svp;
1036 *svp = SvOK (sv) ? newSVsv (sv) : 0;
1037 SvREFCNT_dec (old);
1038 return 0;
1039 }
1040 }
1041
1042 return orig_sigelem_set ? orig_sigelem_set (aTHX_ sv, mg) : 0;
1043 }
1044
1045 static void
1046 prepare_nop (pTHX_ struct coro_transfer_args *ta)
1047 {
1048 /* kind of mega-hacky, but works */
1049 ta->next = ta->prev = (struct coro *)ta;
1050 }
1051
1052 static int
1053 slf_check_nop (pTHX_ struct CoroSLF *frame)
1054 {
1055 return 0;
1056 }
1057
1058 static int
1059 slf_check_repeat (pTHX_ struct CoroSLF *frame)
1060 {
1061 return 1;
1062 }
1063
1064 static UNOP init_perl_op;
1065
1066 ecb_noinline static void /* noinline to keep it out of the transfer fast path */
1067 init_perl (pTHX_ struct coro *coro)
1068 {
1069 /*
1070 * emulate part of the perl startup here.
1071 */
1072 coro_init_stacks (aTHX);
1073
1074 PL_runops = RUNOPS_DEFAULT;
1075 PL_curcop = &PL_compiling;
1076 PL_in_eval = EVAL_NULL;
1077 PL_comppad = 0;
1078 PL_comppad_name = 0;
1079 PL_comppad_name_fill = 0;
1080 PL_comppad_name_floor = 0;
1081 PL_curpm = 0;
1082 PL_curpad = 0;
1083 PL_localizing = 0;
1084 PL_restartop = 0;
1085 #if PERL_VERSION_ATLEAST (5,10,0)
1086 PL_parser = 0;
1087 #endif
1088 PL_hints = 0;
1089
1090 /* recreate the die/warn hooks */
1091 PL_diehook = SvREFCNT_inc (rv_diehook);
1092 PL_warnhook = SvREFCNT_inc (rv_warnhook);
1093
1094 GvSV (PL_defgv) = newSV (0);
1095 GvAV (PL_defgv) = coro->args; coro->args = 0;
1096 GvSV (PL_errgv) = newSV (0);
1097 GvSV (irsgv) = newSVpvn ("\n", 1); sv_magic (GvSV (irsgv), (SV *)irsgv, PERL_MAGIC_sv, "/", 0);
1098 GvHV (PL_hintgv) = 0;
1099 PL_rs = newSVsv (GvSV (irsgv));
1100 PL_defoutgv = (GV *)SvREFCNT_inc_NN (stdoutgv);
1101
1102 {
1103 dSP;
1104 UNOP myop;
1105
1106 Zero (&myop, 1, UNOP);
1107 myop.op_next = Nullop;
1108 myop.op_type = OP_ENTERSUB;
1109 myop.op_flags = OPf_WANT_VOID;
1110
1111 PUSHMARK (SP);
1112 PUSHs ((SV *)coro->startcv);
1113 PUTBACK;
1114 PL_op = (OP *)&myop;
1115 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX);
1116 }
1117
1118 /* this newly created coroutine might be run on an existing cctx which most
1119 * likely was suspended in pp_slf, so we have to emulate entering pp_slf here.
1120 */
1121 slf_frame.prepare = prepare_nop; /* provide a nop function for an eventual pp_slf */
1122 slf_frame.check = slf_check_nop; /* signal pp_slf to not repeat */
1123 slf_frame.destroy = 0;
1124
1125 /* and we have to provide the pp_slf op in any case, so pp_slf can skip it */
1126 init_perl_op.op_next = PL_op;
1127 init_perl_op.op_type = OP_ENTERSUB;
1128 init_perl_op.op_ppaddr = pp_slf;
1129 /* no flags etc. required, as an init function won't be called */
1130
1131 PL_op = (OP *)&init_perl_op;
1132
1133 /* copy throw, in case it was set before init_perl */
1134 CORO_THROW = coro->except;
1135
1136 SWAP_SVS (coro);
1137
1138 if (ecb_expect_false (enable_times))
1139 {
1140 coro_times_update ();
1141 coro_times_sub (coro);
1142 }
1143 }
1144
1145 static void
1146 coro_unwind_stacks (pTHX)
1147 {
1148 if (!IN_DESTRUCT)
1149 {
1150 /* restore all saved variables and stuff */
1151 LEAVE_SCOPE (0);
1152 assert (PL_tmps_floor == -1);
1153
1154 /* free all temporaries */
1155 FREETMPS;
1156 assert (PL_tmps_ix == -1);
1157
1158 /* unwind all extra stacks */
1159 POPSTACK_TO (PL_mainstack);
1160
1161 /* unwind main stack */
1162 dounwind (-1);
1163 }
1164 }
1165
1166 static void
1167 destroy_perl (pTHX_ struct coro *coro)
1168 {
1169 SV *svf [9];
1170
1171 {
1172 SV *old_current = SvRV (coro_current);
1173 struct coro *current = SvSTATE (old_current);
1174
1175 assert (("FATAL: tried to destroy currently running coroutine", coro->mainstack != PL_mainstack));
1176
1177 save_perl (aTHX_ current);
1178
1179 /* this will cause transfer_check to croak on block*/
1180 SvRV_set (coro_current, (SV *)coro->hv);
1181
1182 load_perl (aTHX_ coro);
1183
1184 coro_unwind_stacks (aTHX);
1185
1186 /* restore swapped sv's */
1187 SWAP_SVS (coro);
1188
1189 coro_destruct_stacks (aTHX);
1190
1191 // now save some sv's to be free'd later
1192 svf [0] = GvSV (PL_defgv);
1193 svf [1] = (SV *)GvAV (PL_defgv);
1194 svf [2] = GvSV (PL_errgv);
1195 svf [3] = (SV *)PL_defoutgv;
1196 svf [4] = PL_rs;
1197 svf [5] = GvSV (irsgv);
1198 svf [6] = (SV *)GvHV (PL_hintgv);
1199 svf [7] = PL_diehook;
1200 svf [8] = PL_warnhook;
1201 assert (9 == sizeof (svf) / sizeof (*svf));
1202
1203 SvRV_set (coro_current, old_current);
1204
1205 load_perl (aTHX_ current);
1206 }
1207
1208 {
1209 unsigned int i;
1210
1211 for (i = 0; i < sizeof (svf) / sizeof (*svf); ++i)
1212 SvREFCNT_dec (svf [i]);
1213
1214 SvREFCNT_dec (coro->saved_deffh);
1215 SvREFCNT_dec (coro->rouse_cb);
1216 SvREFCNT_dec (coro->invoke_cb);
1217 SvREFCNT_dec (coro->invoke_av);
1218 }
1219 }
1220
1221 ECB_INLINE void
1222 free_coro_mortal (pTHX)
1223 {
1224 if (ecb_expect_true (coro_mortal))
1225 {
1226 SvREFCNT_dec ((SV *)coro_mortal);
1227 coro_mortal = 0;
1228 }
1229 }
1230
1231 static int
1232 runops_trace (pTHX)
1233 {
1234 COP *oldcop = 0;
1235 int oldcxix = -2;
1236
1237 while ((PL_op = CALL_FPTR (PL_op->op_ppaddr) (aTHX)))
1238 {
1239 PERL_ASYNC_CHECK ();
1240
1241 if (cctx_current->flags & CC_TRACE_ALL)
1242 {
1243 if (PL_op->op_type == OP_LEAVESUB && cctx_current->flags & CC_TRACE_SUB)
1244 {
1245 PERL_CONTEXT *cx = &cxstack[cxstack_ix];
1246 SV **bot, **top;
1247 AV *av = newAV (); /* return values */
1248 SV **cb;
1249 dSP;
1250
1251 GV *gv = CvGV (cx->blk_sub.cv);
1252 SV *fullname = sv_2mortal (newSV (0));
1253 if (isGV (gv))
1254 gv_efullname3 (fullname, gv, 0);
1255
1256 bot = PL_stack_base + cx->blk_oldsp + 1;
1257 top = cx->blk_gimme == G_ARRAY ? SP + 1
1258 : cx->blk_gimme == G_SCALAR ? bot + 1
1259 : bot;
1260
1261 av_extend (av, top - bot);
1262 while (bot < top)
1263 av_push (av, SvREFCNT_inc_NN (*bot++));
1264
1265 PL_runops = RUNOPS_DEFAULT;
1266 ENTER;
1267 SAVETMPS;
1268 EXTEND (SP, 3);
1269 PUSHMARK (SP);
1270 PUSHs (&PL_sv_no);
1271 PUSHs (fullname);
1272 PUSHs (sv_2mortal (newRV_noinc ((SV *)av)));
1273 PUTBACK;
1274 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_sub_cb", sizeof ("_trace_sub_cb") - 1, 0);
1275 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
1276 SPAGAIN;
1277 FREETMPS;
1278 LEAVE;
1279 PL_runops = runops_trace;
1280 }
1281
1282 if (oldcop != PL_curcop)
1283 {
1284 oldcop = PL_curcop;
1285
1286 if (PL_curcop != &PL_compiling)
1287 {
1288 SV **cb;
1289
1290 if (oldcxix != cxstack_ix && cctx_current->flags & CC_TRACE_SUB)
1291 {
1292 PERL_CONTEXT *cx = &cxstack[cxstack_ix];
1293
1294 if (CxTYPE (cx) == CXt_SUB && oldcxix < cxstack_ix)
1295 {
1296 dSP;
1297 GV *gv = CvGV (cx->blk_sub.cv);
1298 SV *fullname = sv_2mortal (newSV (0));
1299
1300 if (isGV (gv))
1301 gv_efullname3 (fullname, gv, 0);
1302
1303 PL_runops = RUNOPS_DEFAULT;
1304 ENTER;
1305 SAVETMPS;
1306 EXTEND (SP, 3);
1307 PUSHMARK (SP);
1308 PUSHs (&PL_sv_yes);
1309 PUSHs (fullname);
1310 PUSHs (CxHASARGS (cx) ? sv_2mortal (newRV_inc ((SV *)cx->blk_sub.argarray)) : &PL_sv_undef);
1311 PUTBACK;
1312 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_sub_cb", sizeof ("_trace_sub_cb") - 1, 0);
1313 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
1314 SPAGAIN;
1315 FREETMPS;
1316 LEAVE;
1317 PL_runops = runops_trace;
1318 }
1319
1320 oldcxix = cxstack_ix;
1321 }
1322
1323 if (cctx_current->flags & CC_TRACE_LINE)
1324 {
1325 dSP;
1326
1327 PL_runops = RUNOPS_DEFAULT;
1328 ENTER;
1329 SAVETMPS;
1330 EXTEND (SP, 3);
1331 PL_runops = RUNOPS_DEFAULT;
1332 PUSHMARK (SP);
1333 PUSHs (sv_2mortal (newSVpv (OutCopFILE (oldcop), 0)));
1334 PUSHs (sv_2mortal (newSViv (CopLINE (oldcop))));
1335 PUTBACK;
1336 cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_line_cb", sizeof ("_trace_line_cb") - 1, 0);
1337 if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
1338 SPAGAIN;
1339 FREETMPS;
1340 LEAVE;
1341 PL_runops = runops_trace;
1342 }
1343 }
1344 }
1345 }
1346 }
1347
1348 TAINT_NOT;
1349 return 0;
1350 }
1351
1352 static struct CoroSLF cctx_ssl_frame;
1353
1354 static void
1355 slf_prepare_set_stacklevel (pTHX_ struct coro_transfer_args *ta)
1356 {
1357 ta->prev = 0;
1358 }
1359
1360 static int
1361 slf_check_set_stacklevel (pTHX_ struct CoroSLF *frame)
1362 {
1363 *frame = cctx_ssl_frame;
1364
1365 return frame->check (aTHX_ frame); /* execute the restored frame - there must be one */
1366 }
1367
1368 /* initialises PL_top_env and injects a pseudo-slf-call to set the stacklevel */
1369 static void ecb_noinline
1370 cctx_prepare (pTHX)
1371 {
1372 PL_top_env = &PL_start_env;
1373
1374 if (cctx_current->flags & CC_TRACE)
1375 PL_runops = runops_trace;
1376
1377 /* we already must be executing an SLF op, there is no other valid way
1378 * that can lead to creation of a new cctx */
1379 assert (("FATAL: can't prepare slf-less cctx in Coro module (please report)",
1380 slf_frame.prepare && PL_op->op_ppaddr == pp_slf));
1381
1382 /* we must emulate leaving pp_slf, which is done inside slf_check_set_stacklevel */
1383 cctx_ssl_frame = slf_frame;
1384
1385 slf_frame.prepare = slf_prepare_set_stacklevel;
1386 slf_frame.check = slf_check_set_stacklevel;
1387 }
1388
1389 /* the tail of transfer: execute stuff we can only do after a transfer */
1390 ECB_INLINE void
1391 transfer_tail (pTHX)
1392 {
1393 free_coro_mortal (aTHX);
1394 }
1395
1396 /*
1397 * this is a _very_ stripped down perl interpreter ;)
1398 */
1399 static void
1400 cctx_run (void *arg)
1401 {
1402 #ifdef USE_ITHREADS
1403 # if CORO_PTHREAD
1404 PERL_SET_CONTEXT (coro_thx);
1405 # endif
1406 #endif
1407 {
1408 dTHX;
1409
1410 /* normally we would need to skip the entersub here */
1411 /* not doing so will re-execute it, which is exactly what we want */
1412 /* PL_nop = PL_nop->op_next */
1413
1414 /* inject a fake subroutine call to cctx_init */
1415 cctx_prepare (aTHX);
1416
1417 /* cctx_run is the alternative tail of transfer() */
1418 transfer_tail (aTHX);
1419
1420 /* somebody or something will hit me for both perl_run and PL_restartop */
1421 PL_restartop = PL_op;
1422 perl_run (PL_curinterp);
1423 /*
1424 * Unfortunately, there is no way to get at the return values of the
1425 * coro body here, as perl_run destroys these. Likewise, we cannot catch
1426 * runtime errors here, as this is just a random interpreter, not a thread.
1427 */
1428
1429 /*
1430 * If perl-run returns we assume exit() was being called or the coro
1431 * fell off the end, which seems to be the only valid (non-bug)
1432 * reason for perl_run to return. We try to exit by jumping to the
1433 * bootstrap-time "top" top_env, as we cannot restore the "main"
1434 * coroutine as Coro has no such concept.
1435 * This actually isn't valid with the pthread backend, but OSes requiring
1436 * that backend are too broken to do it in a standards-compliant way.
1437 */
1438 PL_top_env = main_top_env;
1439 JMPENV_JUMP (2); /* I do not feel well about the hardcoded 2 at all */
1440 }
1441 }
1442
1443 static coro_cctx *
1444 cctx_new ()
1445 {
1446 coro_cctx *cctx;
1447
1448 ++cctx_count;
1449 New (0, cctx, 1, coro_cctx);
1450
1451 cctx->gen = cctx_gen;
1452 cctx->flags = 0;
1453 cctx->idle_sp = 0; /* can be accessed by transfer between cctx_run and set_stacklevel, on throw */
1454
1455 return cctx;
1456 }
1457
1458 /* create a new cctx only suitable as source */
1459 static coro_cctx *
1460 cctx_new_empty ()
1461 {
1462 coro_cctx *cctx = cctx_new ();
1463
1464 cctx->sptr = 0;
1465 coro_create (&cctx->cctx, 0, 0, 0, 0);
1466
1467 return cctx;
1468 }
1469
1470 /* create a new cctx suitable as destination/running a perl interpreter */
1471 static coro_cctx *
1472 cctx_new_run ()
1473 {
1474 coro_cctx *cctx = cctx_new ();
1475 void *stack_start;
1476 size_t stack_size;
1477
1478 #if HAVE_MMAP
1479 cctx->ssize = ((cctx_stacksize * sizeof (long) + PAGESIZE - 1) / PAGESIZE + CORO_STACKGUARD) * PAGESIZE;
1480 /* mmap supposedly does allocate-on-write for us */
1481 cctx->sptr = mmap (0, cctx->ssize, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, 0, 0);
1482
1483 if (cctx->sptr != (void *)-1)
1484 {
1485 #if CORO_STACKGUARD
1486 mprotect (cctx->sptr, CORO_STACKGUARD * PAGESIZE, PROT_NONE);
1487 #endif
1488 stack_start = (char *)cctx->sptr + CORO_STACKGUARD * PAGESIZE;
1489 stack_size = cctx->ssize - CORO_STACKGUARD * PAGESIZE;
1490 cctx->flags |= CC_MAPPED;
1491 }
1492 else
1493 #endif
1494 {
1495 cctx->ssize = cctx_stacksize * (long)sizeof (long);
1496 New (0, cctx->sptr, cctx_stacksize, long);
1497
1498 if (!cctx->sptr)
1499 {
1500 perror ("FATAL: unable to allocate stack for coroutine, exiting.");
1501 _exit (EXIT_FAILURE);
1502 }
1503
1504 stack_start = cctx->sptr;
1505 stack_size = cctx->ssize;
1506 }
1507
1508 #if CORO_USE_VALGRIND
1509 cctx->valgrind_id = VALGRIND_STACK_REGISTER ((char *)stack_start, (char *)stack_start + stack_size);
1510 #endif
1511
1512 coro_create (&cctx->cctx, cctx_run, (void *)cctx, stack_start, stack_size);
1513
1514 return cctx;
1515 }
1516
1517 static void
1518 cctx_destroy (coro_cctx *cctx)
1519 {
1520 if (!cctx)
1521 return;
1522
1523 assert (("FATAL: tried to destroy current cctx", cctx != cctx_current));
1524
1525 --cctx_count;
1526 coro_destroy (&cctx->cctx);
1527
1528 /* coro_transfer creates new, empty cctx's */
1529 if (cctx->sptr)
1530 {
1531 #if CORO_USE_VALGRIND
1532 VALGRIND_STACK_DEREGISTER (cctx->valgrind_id);
1533 #endif
1534
1535 #if HAVE_MMAP
1536 if (cctx->flags & CC_MAPPED)
1537 munmap (cctx->sptr, cctx->ssize);
1538 else
1539 #endif
1540 Safefree (cctx->sptr);
1541 }
1542
1543 Safefree (cctx);
1544 }
1545
1546 /* wether this cctx should be destructed */
1547 #define CCTX_EXPIRED(cctx) ((cctx)->gen != cctx_gen || ((cctx)->flags & CC_NOREUSE))
1548
1549 static coro_cctx *
1550 cctx_get (pTHX)
1551 {
1552 while (ecb_expect_true (cctx_first))
1553 {
1554 coro_cctx *cctx = cctx_first;
1555 cctx_first = cctx->next;
1556 --cctx_idle;
1557
1558 if (ecb_expect_true (!CCTX_EXPIRED (cctx)))
1559 return cctx;
1560
1561 cctx_destroy (cctx);
1562 }
1563
1564 return cctx_new_run ();
1565 }
1566
1567 static void
1568 cctx_put (coro_cctx *cctx)
1569 {
1570 assert (("FATAL: cctx_put called on non-initialised cctx in Coro (please report)", cctx->sptr));
1571
1572 /* free another cctx if overlimit */
1573 if (ecb_expect_false (cctx_idle >= cctx_max_idle))
1574 {
1575 coro_cctx *first = cctx_first;
1576 cctx_first = first->next;
1577 --cctx_idle;
1578
1579 cctx_destroy (first);
1580 }
1581
1582 ++cctx_idle;
1583 cctx->next = cctx_first;
1584 cctx_first = cctx;
1585 }
1586
1587 /** coroutine switching *****************************************************/
1588
1589 static void
1590 transfer_check (pTHX_ struct coro *prev, struct coro *next)
1591 {
1592 /* TODO: throwing up here is considered harmful */
1593
1594 if (ecb_expect_true (prev != next))
1595 {
1596 if (ecb_expect_false (!(prev->flags & (CF_RUNNING | CF_NEW))))
1597 croak ("Coro::State::transfer called with a blocked prev Coro::State, but can only transfer from running or new states,");
1598
1599 if (ecb_expect_false (next->flags & (CF_RUNNING | CF_ZOMBIE | CF_SUSPENDED)))
1600 croak ("Coro::State::transfer called with running, destroyed or suspended next Coro::State, but can only transfer to inactive states,");
1601
1602 #if !PERL_VERSION_ATLEAST (5,10,0)
1603 if (ecb_expect_false (PL_lex_state != LEX_NOTPARSING))
1604 croak ("Coro::State::transfer called while parsing, but this is not supported in your perl version,");
1605 #endif
1606 }
1607 }
1608
1609 /* always use the TRANSFER macro */
1610 static void ecb_noinline /* noinline so we have a fixed stackframe */
1611 transfer (pTHX_ struct coro *prev, struct coro *next, int force_cctx)
1612 {
1613 dSTACKLEVEL;
1614
1615 /* sometimes transfer is only called to set idle_sp */
1616 if (ecb_expect_false (!prev))
1617 {
1618 cctx_current->idle_sp = STACKLEVEL;
1619 assert (cctx_current->idle_te = PL_top_env); /* just for the side-effect when asserts are enabled */
1620 }
1621 else if (ecb_expect_true (prev != next))
1622 {
1623 coro_cctx *cctx_prev;
1624
1625 if (ecb_expect_false (prev->flags & CF_NEW))
1626 {
1627 /* create a new empty/source context */
1628 prev->flags &= ~CF_NEW;
1629 prev->flags |= CF_RUNNING;
1630 }
1631
1632 prev->flags &= ~CF_RUNNING;
1633 next->flags |= CF_RUNNING;
1634
1635 /* first get rid of the old state */
1636 save_perl (aTHX_ prev);
1637
1638 if (ecb_expect_false (next->flags & CF_NEW))
1639 {
1640 /* need to start coroutine */
1641 next->flags &= ~CF_NEW;
1642 /* setup coroutine call */
1643 init_perl (aTHX_ next);
1644 }
1645 else
1646 load_perl (aTHX_ next);
1647
1648 /* possibly untie and reuse the cctx */
1649 if (ecb_expect_true (
1650 cctx_current->idle_sp == STACKLEVEL
1651 && !(cctx_current->flags & CC_TRACE)
1652 && !force_cctx
1653 ))
1654 {
1655 /* I assume that stacklevel is a stronger indicator than PL_top_env changes */
1656 assert (("FATAL: current top_env must equal previous top_env in Coro (please report)", PL_top_env == cctx_current->idle_te));
1657
1658 /* if the cctx is about to be destroyed we need to make sure we won't see it in cctx_get. */
1659 /* without this the next cctx_get might destroy the running cctx while still in use */
1660 if (ecb_expect_false (CCTX_EXPIRED (cctx_current)))
1661 if (ecb_expect_true (!next->cctx))
1662 next->cctx = cctx_get (aTHX);
1663
1664 cctx_put (cctx_current);
1665 }
1666 else
1667 prev->cctx = cctx_current;
1668
1669 ++next->usecount;
1670
1671 cctx_prev = cctx_current;
1672 cctx_current = ecb_expect_false (next->cctx) ? next->cctx : cctx_get (aTHX);
1673
1674 next->cctx = 0;
1675
1676 if (ecb_expect_false (cctx_prev != cctx_current))
1677 {
1678 cctx_prev->top_env = PL_top_env;
1679 PL_top_env = cctx_current->top_env;
1680 coro_transfer (&cctx_prev->cctx, &cctx_current->cctx);
1681 }
1682
1683 transfer_tail (aTHX);
1684 }
1685 }
1686
1687 #define TRANSFER(ta, force_cctx) transfer (aTHX_ (ta).prev, (ta).next, (force_cctx))
1688 #define TRANSFER_CHECK(ta) transfer_check (aTHX_ (ta).prev, (ta).next)
1689
1690 /** high level stuff ********************************************************/
1691
1692 /* this function is actually Coro, not Coro::State, but we call it from here */
1693 /* because it is convenient - but it hasn't been declared yet for that reason */
1694 static void
1695 coro_call_on_destroy (pTHX_ struct coro *coro);
1696
1697 static void
1698 coro_state_destroy (pTHX_ struct coro *coro)
1699 {
1700 if (coro->flags & CF_ZOMBIE)
1701 return;
1702
1703 slf_destroy (aTHX_ coro);
1704
1705 coro->flags |= CF_ZOMBIE;
1706
1707 if (coro->flags & CF_READY)
1708 {
1709 /* reduce nready, as destroying a ready coro effectively unreadies it */
1710 /* alternative: look through all ready queues and remove the coro */
1711 --coro_nready;
1712 }
1713 else
1714 coro->flags |= CF_READY; /* make sure it is NOT put into the readyqueue */
1715
1716 if (coro->next) coro->next->prev = coro->prev;
1717 if (coro->prev) coro->prev->next = coro->next;
1718 if (coro == coro_first) coro_first = coro->next;
1719
1720 if (coro->mainstack
1721 && coro->mainstack != main_mainstack
1722 && coro->slot
1723 && !PL_dirty)
1724 destroy_perl (aTHX_ coro);
1725
1726 cctx_destroy (coro->cctx);
1727 SvREFCNT_dec (coro->startcv);
1728 SvREFCNT_dec (coro->args);
1729 SvREFCNT_dec (coro->swap_sv);
1730 SvREFCNT_dec (CORO_THROW);
1731
1732 coro_call_on_destroy (aTHX_ coro);
1733
1734 /* more destruction mayhem in coro_state_free */
1735 }
1736
1737 static int
1738 coro_state_free (pTHX_ SV *sv, MAGIC *mg)
1739 {
1740 struct coro *coro = (struct coro *)mg->mg_ptr;
1741 mg->mg_ptr = 0;
1742
1743 coro_state_destroy (aTHX_ coro);
1744 SvREFCNT_dec (coro->on_destroy);
1745 SvREFCNT_dec (coro->status);
1746
1747 Safefree (coro);
1748
1749 return 0;
1750 }
1751
1752 static int ecb_cold
1753 coro_state_dup (pTHX_ MAGIC *mg, CLONE_PARAMS *params)
1754 {
1755 /* called when perl clones the current process the slow way (windows process emulation) */
1756 /* WE SIMply nuke the pointers in the copy, causing perl to croak */
1757 mg->mg_ptr = 0;
1758 mg->mg_virtual = 0;
1759
1760 return 0;
1761 }
1762
1763 static MGVTBL coro_state_vtbl = {
1764 0, 0, 0, 0,
1765 coro_state_free,
1766 0,
1767 #ifdef MGf_DUP
1768 coro_state_dup,
1769 #else
1770 # define MGf_DUP 0
1771 #endif
1772 };
1773
1774 static void
1775 prepare_transfer (pTHX_ struct coro_transfer_args *ta, SV *prev_sv, SV *next_sv)
1776 {
1777 ta->prev = SvSTATE (prev_sv);
1778 ta->next = SvSTATE (next_sv);
1779 TRANSFER_CHECK (*ta);
1780 }
1781
1782 static void
1783 api_transfer (pTHX_ SV *prev_sv, SV *next_sv)
1784 {
1785 struct coro_transfer_args ta;
1786
1787 prepare_transfer (aTHX_ &ta, prev_sv, next_sv);
1788 TRANSFER (ta, 1);
1789 }
1790
1791 /** Coro ********************************************************************/
1792
1793 ECB_INLINE void
1794 coro_enq (pTHX_ struct coro *coro)
1795 {
1796 struct coro **ready = coro_ready [coro->prio - CORO_PRIO_MIN];
1797
1798 SvREFCNT_inc_NN (coro->hv);
1799
1800 coro->next_ready = 0;
1801 *(ready [0] ? &ready [1]->next_ready : &ready [0]) = coro;
1802 ready [1] = coro;
1803 }
1804
1805 ECB_INLINE struct coro *
1806 coro_deq (pTHX)
1807 {
1808 int prio;
1809
1810 for (prio = CORO_PRIO_MAX - CORO_PRIO_MIN + 1; --prio >= 0; )
1811 {
1812 struct coro **ready = coro_ready [prio];
1813
1814 if (ready [0])
1815 {
1816 struct coro *coro = ready [0];
1817 ready [0] = coro->next_ready;
1818 return coro;
1819 }
1820 }
1821
1822 return 0;
1823 }
1824
1825 static void
1826 invoke_sv_ready_hook_helper (void)
1827 {
1828 dTHX;
1829 dSP;
1830
1831 ENTER;
1832 SAVETMPS;
1833
1834 PUSHMARK (SP);
1835 PUTBACK;
1836 call_sv (coro_readyhook, G_VOID | G_DISCARD);
1837
1838 FREETMPS;
1839 LEAVE;
1840 }
1841
1842 static int
1843 api_ready (pTHX_ SV *coro_sv)
1844 {
1845 struct coro *coro = SvSTATE (coro_sv);
1846
1847 if (coro->flags & CF_READY)
1848 return 0;
1849
1850 coro->flags |= CF_READY;
1851
1852 coro_enq (aTHX_ coro);
1853
1854 if (!coro_nready++)
1855 if (coroapi.readyhook)
1856 coroapi.readyhook ();
1857
1858 return 1;
1859 }
1860
1861 static int
1862 api_is_ready (pTHX_ SV *coro_sv)
1863 {
1864 return !!(SvSTATE (coro_sv)->flags & CF_READY);
1865 }
1866
1867 /* expects to own a reference to next->hv */
1868 ECB_INLINE void
1869 prepare_schedule_to (pTHX_ struct coro_transfer_args *ta, struct coro *next)
1870 {
1871 SV *prev_sv = SvRV (coro_current);
1872
1873 ta->prev = SvSTATE_hv (prev_sv);
1874 ta->next = next;
1875
1876 TRANSFER_CHECK (*ta);
1877
1878 SvRV_set (coro_current, (SV *)next->hv);
1879
1880 free_coro_mortal (aTHX);
1881 coro_mortal = prev_sv;
1882 }
1883
1884 static void
1885 prepare_schedule (pTHX_ struct coro_transfer_args *ta)
1886 {
1887 for (;;)
1888 {
1889 struct coro *next = coro_deq (aTHX);
1890
1891 if (ecb_expect_true (next))
1892 {
1893 /* cannot transfer to destroyed coros, skip and look for next */
1894 if (ecb_expect_false (next->flags & (CF_ZOMBIE | CF_SUSPENDED)))
1895 SvREFCNT_dec (next->hv); /* coro_nready has already been taken care of by destroy */
1896 else
1897 {
1898 next->flags &= ~CF_READY;
1899 --coro_nready;
1900
1901 prepare_schedule_to (aTHX_ ta, next);
1902 break;
1903 }
1904 }
1905 else
1906 {
1907 /* nothing to schedule: call the idle handler */
1908 if (SvROK (sv_idle)
1909 && SvOBJECT (SvRV (sv_idle)))
1910 {
1911 if (SvRV (sv_idle) == SvRV (coro_current))
1912 croak ("FATAL: $Coro::IDLE blocked itself - did you try to block inside an event loop callback? Caught");
1913
1914 ++coro_nready; /* hack so that api_ready doesn't invoke ready hook */
1915 api_ready (aTHX_ SvRV (sv_idle));
1916 --coro_nready;
1917 }
1918 else
1919 {
1920 /* TODO: deprecated, remove, cannot work reliably *//*D*/
1921 dSP;
1922
1923 ENTER;
1924 SAVETMPS;
1925
1926 PUSHMARK (SP);
1927 PUTBACK;
1928 call_sv (sv_idle, G_VOID | G_DISCARD);
1929
1930 FREETMPS;
1931 LEAVE;
1932 }
1933 }
1934 }
1935 }
1936
1937 ECB_INLINE void
1938 prepare_cede (pTHX_ struct coro_transfer_args *ta)
1939 {
1940 api_ready (aTHX_ coro_current);
1941 prepare_schedule (aTHX_ ta);
1942 }
1943
1944 ECB_INLINE void
1945 prepare_cede_notself (pTHX_ struct coro_transfer_args *ta)
1946 {
1947 SV *prev = SvRV (coro_current);
1948
1949 if (coro_nready)
1950 {
1951 prepare_schedule (aTHX_ ta);
1952 api_ready (aTHX_ prev);
1953 }
1954 else
1955 prepare_nop (aTHX_ ta);
1956 }
1957
1958 static void
1959 api_schedule (pTHX)
1960 {
1961 struct coro_transfer_args ta;
1962
1963 prepare_schedule (aTHX_ &ta);
1964 TRANSFER (ta, 1);
1965 }
1966
1967 static void
1968 api_schedule_to (pTHX_ SV *coro_sv)
1969 {
1970 struct coro_transfer_args ta;
1971 struct coro *next = SvSTATE (coro_sv);
1972
1973 SvREFCNT_inc_NN (coro_sv);
1974 prepare_schedule_to (aTHX_ &ta, next);
1975 }
1976
1977 static int
1978 api_cede (pTHX)
1979 {
1980 struct coro_transfer_args ta;
1981
1982 prepare_cede (aTHX_ &ta);
1983
1984 if (ecb_expect_true (ta.prev != ta.next))
1985 {
1986 TRANSFER (ta, 1);
1987 return 1;
1988 }
1989 else
1990 return 0;
1991 }
1992
1993 static int
1994 api_cede_notself (pTHX)
1995 {
1996 if (coro_nready)
1997 {
1998 struct coro_transfer_args ta;
1999
2000 prepare_cede_notself (aTHX_ &ta);
2001 TRANSFER (ta, 1);
2002 return 1;
2003 }
2004 else
2005 return 0;
2006 }
2007
2008 static void
2009 api_trace (pTHX_ SV *coro_sv, int flags)
2010 {
2011 struct coro *coro = SvSTATE (coro_sv);
2012
2013 if (coro->flags & CF_RUNNING)
2014 croak ("cannot enable tracing on a running coroutine, caught");
2015
2016 if (flags & CC_TRACE)
2017 {
2018 if (!coro->cctx)
2019 coro->cctx = cctx_new_run ();
2020 else if (!(coro->cctx->flags & CC_TRACE))
2021 croak ("cannot enable tracing on coroutine with custom stack, caught");
2022
2023 coro->cctx->flags |= CC_NOREUSE | (flags & (CC_TRACE | CC_TRACE_ALL));
2024 }
2025 else if (coro->cctx && coro->cctx->flags & CC_TRACE)
2026 {
2027 coro->cctx->flags &= ~(CC_TRACE | CC_TRACE_ALL);
2028
2029 if (coro->flags & CF_RUNNING)
2030 PL_runops = RUNOPS_DEFAULT;
2031 else
2032 coro->slot->runops = RUNOPS_DEFAULT;
2033 }
2034 }
2035
2036 static void
2037 coro_push_av (pTHX_ AV *av, I32 gimme_v)
2038 {
2039 if (AvFILLp (av) >= 0 && gimme_v != G_VOID)
2040 {
2041 dSP;
2042
2043 if (gimme_v == G_SCALAR)
2044 XPUSHs (AvARRAY (av)[AvFILLp (av)]);
2045 else
2046 {
2047 int i;
2048 EXTEND (SP, AvFILLp (av) + 1);
2049
2050 for (i = 0; i <= AvFILLp (av); ++i)
2051 PUSHs (AvARRAY (av)[i]);
2052 }
2053
2054 PUTBACK;
2055 }
2056 }
2057
2058 static void
2059 coro_push_on_destroy (pTHX_ struct coro *coro, SV *cb)
2060 {
2061 if (!coro->on_destroy)
2062 coro->on_destroy = newAV ();
2063
2064 av_push (coro->on_destroy, cb);
2065 }
2066
2067 static void
2068 slf_destroy_join (pTHX_ struct CoroSLF *frame)
2069 {
2070 SvREFCNT_dec ((SV *)((struct coro *)frame->data)->hv);
2071 }
2072
2073 static int
2074 slf_check_join (pTHX_ struct CoroSLF *frame)
2075 {
2076 struct coro *coro = (struct coro *)frame->data;
2077
2078 if (!coro->status)
2079 return 1;
2080
2081 frame->destroy = 0;
2082
2083 coro_push_av (aTHX_ coro->status, GIMME_V);
2084
2085 SvREFCNT_dec ((SV *)coro->hv);
2086
2087 return 0;
2088 }
2089
2090 static void
2091 slf_init_join (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2092 {
2093 struct coro *coro = SvSTATE (items > 0 ? arg [0] : &PL_sv_undef);
2094
2095 if (items > 1)
2096 croak ("join called with too many arguments");
2097
2098 if (coro->status)
2099 frame->prepare = prepare_nop;
2100 else
2101 {
2102 coro_push_on_destroy (aTHX_ coro, SvREFCNT_inc_NN (SvRV (coro_current)));
2103 frame->prepare = prepare_schedule;
2104 }
2105
2106 frame->check = slf_check_join;
2107 frame->destroy = slf_destroy_join;
2108 frame->data = (void *)coro;
2109 SvREFCNT_inc (coro->hv);
2110 }
2111
2112 static void
2113 coro_call_on_destroy (pTHX_ struct coro *coro)
2114 {
2115 AV *od = coro->on_destroy;
2116
2117 if (!od)
2118 return;
2119
2120 while (AvFILLp (od) >= 0)
2121 {
2122 SV *cb = sv_2mortal (av_pop (od));
2123
2124 /* coro hv's (and only hv's at the moment) are supported as well */
2125 if (SvSTATEhv_p (aTHX_ cb))
2126 api_ready (aTHX_ cb);
2127 else
2128 {
2129 dSP; /* don't disturb outer sp */
2130 PUSHMARK (SP);
2131
2132 if (coro->status)
2133 {
2134 PUTBACK;
2135 coro_push_av (aTHX_ coro->status, G_ARRAY);
2136 SPAGAIN;
2137 }
2138
2139 PUTBACK;
2140 call_sv (cb, G_VOID | G_DISCARD);
2141 }
2142 }
2143 }
2144
2145 static void
2146 coro_set_status (pTHX_ struct coro *coro, SV **arg, int items)
2147 {
2148 AV *av;
2149
2150 if (coro->status)
2151 {
2152 av = coro->status;
2153 av_clear (av);
2154 }
2155 else
2156 av = coro->status = newAV ();
2157
2158 /* items are actually not so common, so optimise for this case */
2159 if (items)
2160 {
2161 int i;
2162
2163 av_extend (av, items - 1);
2164
2165 for (i = 0; i < items; ++i)
2166 av_push (av, SvREFCNT_inc_NN (arg [i]));
2167 }
2168 }
2169
2170 static void
2171 slf_init_terminate_cancel_common (pTHX_ struct CoroSLF *frame, HV *coro_hv)
2172 {
2173 av_push (av_destroy, (SV *)newRV_inc ((SV *)coro_hv)); /* RVinc for perl */
2174 api_ready (aTHX_ sv_manager);
2175
2176 frame->prepare = prepare_schedule;
2177 frame->check = slf_check_repeat;
2178
2179 /* as a minor optimisation, we could unwind all stacks here */
2180 /* but that puts extra pressure on pp_slf, and is not worth much */
2181 /*coro_unwind_stacks (aTHX);*/
2182 }
2183
2184 static void
2185 slf_init_terminate (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2186 {
2187 HV *coro_hv = (HV *)SvRV (coro_current);
2188
2189 coro_set_status (aTHX_ SvSTATE ((SV *)coro_hv), arg, items);
2190 slf_init_terminate_cancel_common (aTHX_ frame, coro_hv);
2191 }
2192
2193 static void
2194 slf_init_cancel (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2195 {
2196 HV *coro_hv;
2197 struct coro *coro;
2198
2199 if (items <= 0)
2200 croak ("Coro::cancel called without coro object,");
2201
2202 coro = SvSTATE (arg [0]);
2203 coro_hv = coro->hv;
2204
2205 coro_set_status (aTHX_ coro, arg + 1, items - 1);
2206
2207 if (ecb_expect_false (coro->flags & CF_NOCANCEL))
2208 {
2209 /* coro currently busy cancelling something, so just notify it */
2210 coro->slf_frame.data = (void *)coro;
2211
2212 frame->prepare = prepare_nop;
2213 frame->check = slf_check_nop;
2214 }
2215 else if (coro_hv == (HV *)SvRV (coro_current))
2216 {
2217 /* cancelling the current coro is allowed, and equals terminate */
2218 slf_init_terminate_cancel_common (aTHX_ frame, coro_hv);
2219 }
2220 else
2221 {
2222 struct coro *self = SvSTATE_current;
2223
2224 /* otherwise we cancel directly, purely for speed reasons
2225 * unfortunately, this requires some magic trickery, as
2226 * somebody else could cancel us, so we have to fight the cancellation.
2227 * this is ugly, and hopefully fully worth the extra speed.
2228 * besides, I can't get the slow-but-safe version working...
2229 */
2230 slf_frame.data = 0;
2231 self->flags |= CF_NOCANCEL;
2232 coro_state_destroy (aTHX_ coro);
2233 self->flags &= ~CF_NOCANCEL;
2234
2235 if (slf_frame.data)
2236 {
2237 /* while we were busy we have been cancelled, so terminate */
2238 slf_init_terminate_cancel_common (aTHX_ frame, self->hv);
2239 }
2240 else
2241 {
2242 frame->prepare = prepare_nop;
2243 frame->check = slf_check_nop;
2244 }
2245 }
2246 }
2247
2248 static int
2249 slf_check_safe_cancel (pTHX_ struct CoroSLF *frame)
2250 {
2251 frame->prepare = 0;
2252 coro_unwind_stacks (aTHX);
2253
2254 slf_init_terminate_cancel_common (aTHX_ frame, (HV *)SvRV (coro_current));
2255
2256 return 1;
2257 }
2258
2259 static int
2260 safe_cancel (pTHX_ struct coro *coro, SV **arg, int items)
2261 {
2262 if (coro->cctx)
2263 croak ("coro inside C callback, unable to cancel at this time, caught");
2264
2265 if (coro->flags & CF_NEW)
2266 {
2267 coro_set_status (aTHX_ coro, arg, items);
2268 coro_state_destroy (aTHX_ coro);
2269 }
2270 else
2271 {
2272 if (!coro->slf_frame.prepare)
2273 croak ("coro outside an SLF function, unable to cancel at this time, caught");
2274
2275 slf_destroy (aTHX_ coro);
2276
2277 coro_set_status (aTHX_ coro, arg, items);
2278 coro->slf_frame.prepare = prepare_nop;
2279 coro->slf_frame.check = slf_check_safe_cancel;
2280
2281 api_ready (aTHX_ (SV *)coro->hv);
2282 }
2283
2284 return 1;
2285 }
2286
2287 /*****************************************************************************/
2288 /* async pool handler */
2289
2290 static int
2291 slf_check_pool_handler (pTHX_ struct CoroSLF *frame)
2292 {
2293 HV *hv = (HV *)SvRV (coro_current);
2294 struct coro *coro = (struct coro *)frame->data;
2295
2296 if (!coro->invoke_cb)
2297 return 1; /* loop till we have invoke */
2298 else
2299 {
2300 hv_store (hv, "desc", sizeof ("desc") - 1,
2301 newSVpvn ("[async_pool]", sizeof ("[async_pool]") - 1), 0);
2302
2303 coro->saved_deffh = SvREFCNT_inc_NN ((SV *)PL_defoutgv);
2304
2305 {
2306 dSP;
2307 XPUSHs (sv_2mortal (coro->invoke_cb)); coro->invoke_cb = 0;
2308 PUTBACK;
2309 }
2310
2311 SvREFCNT_dec (GvAV (PL_defgv));
2312 GvAV (PL_defgv) = coro->invoke_av;
2313 coro->invoke_av = 0;
2314
2315 return 0;
2316 }
2317 }
2318
2319 static void
2320 slf_init_pool_handler (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2321 {
2322 HV *hv = (HV *)SvRV (coro_current);
2323 struct coro *coro = SvSTATE_hv ((SV *)hv);
2324
2325 if (ecb_expect_true (coro->saved_deffh))
2326 {
2327 /* subsequent iteration */
2328 SvREFCNT_dec ((SV *)PL_defoutgv); PL_defoutgv = (GV *)coro->saved_deffh;
2329 coro->saved_deffh = 0;
2330
2331 if (coro_rss (aTHX_ coro) > SvUV (sv_pool_rss)
2332 || av_len (av_async_pool) + 1 >= SvIV (sv_pool_size))
2333 {
2334 slf_init_terminate_cancel_common (aTHX_ frame, hv);
2335 return;
2336 }
2337 else
2338 {
2339 av_clear (GvAV (PL_defgv));
2340 hv_store (hv, "desc", sizeof ("desc") - 1, SvREFCNT_inc_NN (sv_async_pool_idle), 0);
2341
2342 coro->prio = 0;
2343
2344 if (coro->cctx && (coro->cctx->flags & CC_TRACE))
2345 api_trace (aTHX_ coro_current, 0);
2346
2347 frame->prepare = prepare_schedule;
2348 av_push (av_async_pool, SvREFCNT_inc (hv));
2349 }
2350 }
2351 else
2352 {
2353 /* first iteration, simply fall through */
2354 frame->prepare = prepare_nop;
2355 }
2356
2357 frame->check = slf_check_pool_handler;
2358 frame->data = (void *)coro;
2359 }
2360
2361 /*****************************************************************************/
2362 /* rouse callback */
2363
2364 #define CORO_MAGIC_type_rouse PERL_MAGIC_ext
2365
2366 static void
2367 coro_rouse_callback (pTHX_ CV *cv)
2368 {
2369 dXSARGS;
2370 SV *data = (SV *)S_GENSUB_ARG;
2371
2372 if (SvTYPE (SvRV (data)) != SVt_PVAV)
2373 {
2374 /* first call, set args */
2375 SV *coro = SvRV (data);
2376 AV *av = newAV ();
2377
2378 SvRV_set (data, (SV *)av);
2379
2380 /* better take a full copy of the arguments */
2381 while (items--)
2382 av_store (av, items, newSVsv (ST (items)));
2383
2384 api_ready (aTHX_ coro);
2385 SvREFCNT_dec (coro);
2386 }
2387
2388 XSRETURN_EMPTY;
2389 }
2390
2391 static int
2392 slf_check_rouse_wait (pTHX_ struct CoroSLF *frame)
2393 {
2394 SV *data = (SV *)frame->data;
2395
2396 if (CORO_THROW)
2397 return 0;
2398
2399 if (SvTYPE (SvRV (data)) != SVt_PVAV)
2400 return 1;
2401
2402 /* now push all results on the stack */
2403 {
2404 dSP;
2405 AV *av = (AV *)SvRV (data);
2406 int i;
2407
2408 EXTEND (SP, AvFILLp (av) + 1);
2409 for (i = 0; i <= AvFILLp (av); ++i)
2410 PUSHs (sv_2mortal (AvARRAY (av)[i]));
2411
2412 /* we have stolen the elements, so set length to zero and free */
2413 AvFILLp (av) = -1;
2414 av_undef (av);
2415
2416 PUTBACK;
2417 }
2418
2419 return 0;
2420 }
2421
2422 static void
2423 slf_init_rouse_wait (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2424 {
2425 SV *cb;
2426
2427 if (items)
2428 cb = arg [0];
2429 else
2430 {
2431 struct coro *coro = SvSTATE_current;
2432
2433 if (!coro->rouse_cb)
2434 croak ("Coro::rouse_wait called without rouse callback, and no default rouse callback found either,");
2435
2436 cb = sv_2mortal (coro->rouse_cb);
2437 coro->rouse_cb = 0;
2438 }
2439
2440 if (!SvROK (cb)
2441 || SvTYPE (SvRV (cb)) != SVt_PVCV
2442 || CvXSUB ((CV *)SvRV (cb)) != coro_rouse_callback)
2443 croak ("Coro::rouse_wait called with illegal callback argument,");
2444
2445 {
2446 CV *cv = (CV *)SvRV (cb); /* for S_GENSUB_ARG */
2447 SV *data = (SV *)S_GENSUB_ARG;
2448
2449 frame->data = (void *)data;
2450 frame->prepare = SvTYPE (SvRV (data)) == SVt_PVAV ? prepare_nop : prepare_schedule;
2451 frame->check = slf_check_rouse_wait;
2452 }
2453 }
2454
2455 static SV *
2456 coro_new_rouse_cb (pTHX)
2457 {
2458 HV *hv = (HV *)SvRV (coro_current);
2459 struct coro *coro = SvSTATE_hv (hv);
2460 SV *data = newRV_inc ((SV *)hv);
2461 SV *cb = s_gensub (aTHX_ coro_rouse_callback, (void *)data);
2462
2463 sv_magicext (SvRV (cb), data, CORO_MAGIC_type_rouse, 0, 0, 0);
2464 SvREFCNT_dec (data); /* magicext increases the refcount */
2465
2466 SvREFCNT_dec (coro->rouse_cb);
2467 coro->rouse_cb = SvREFCNT_inc_NN (cb);
2468
2469 return cb;
2470 }
2471
2472 /*****************************************************************************/
2473 /* schedule-like-function opcode (SLF) */
2474
2475 static UNOP slf_restore; /* restore stack as entersub did, for first-re-run */
2476 static const CV *slf_cv;
2477 static SV **slf_argv;
2478 static int slf_argc, slf_arga; /* count, allocated */
2479 static I32 slf_ax; /* top of stack, for restore */
2480
2481 /* this restores the stack in the case we patched the entersub, to */
2482 /* recreate the stack frame as perl will on following calls */
2483 /* since entersub cleared the stack */
2484 static OP *
2485 pp_restore (pTHX)
2486 {
2487 int i;
2488 SV **SP = PL_stack_base + slf_ax;
2489
2490 PUSHMARK (SP);
2491
2492 EXTEND (SP, slf_argc + 1);
2493
2494 for (i = 0; i < slf_argc; ++i)
2495 PUSHs (sv_2mortal (slf_argv [i]));
2496
2497 PUSHs ((SV *)CvGV (slf_cv));
2498
2499 RETURNOP (slf_restore.op_first);
2500 }
2501
2502 static void
2503 slf_prepare_transfer (pTHX_ struct coro_transfer_args *ta)
2504 {
2505 SV **arg = (SV **)slf_frame.data;
2506
2507 prepare_transfer (aTHX_ ta, arg [0], arg [1]);
2508 }
2509
2510 static void
2511 slf_init_transfer (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2512 {
2513 if (items != 2)
2514 croak ("Coro::State::transfer (prev, next) expects two arguments, not %d,", items);
2515
2516 frame->prepare = slf_prepare_transfer;
2517 frame->check = slf_check_nop;
2518 frame->data = (void *)arg; /* let's hope it will stay valid */
2519 }
2520
2521 static void
2522 slf_init_schedule (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2523 {
2524 frame->prepare = prepare_schedule;
2525 frame->check = slf_check_nop;
2526 }
2527
2528 static void
2529 slf_prepare_schedule_to (pTHX_ struct coro_transfer_args *ta)
2530 {
2531 struct coro *next = (struct coro *)slf_frame.data;
2532
2533 SvREFCNT_inc_NN (next->hv);
2534 prepare_schedule_to (aTHX_ ta, next);
2535 }
2536
2537 static void
2538 slf_init_schedule_to (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2539 {
2540 if (!items)
2541 croak ("Coro::schedule_to expects a coroutine argument, caught");
2542
2543 frame->data = (void *)SvSTATE (arg [0]);
2544 frame->prepare = slf_prepare_schedule_to;
2545 frame->check = slf_check_nop;
2546 }
2547
2548 static void
2549 slf_init_cede_to (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2550 {
2551 api_ready (aTHX_ SvRV (coro_current));
2552
2553 slf_init_schedule_to (aTHX_ frame, cv, arg, items);
2554 }
2555
2556 static void
2557 slf_init_cede (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2558 {
2559 frame->prepare = prepare_cede;
2560 frame->check = slf_check_nop;
2561 }
2562
2563 static void
2564 slf_init_cede_notself (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2565 {
2566 frame->prepare = prepare_cede_notself;
2567 frame->check = slf_check_nop;
2568 }
2569
2570 /* "undo"/cancel a running slf call - used when cancelling a coro, mainly */
2571 static void
2572 slf_destroy (pTHX_ struct coro *coro)
2573 {
2574 /* this callback is reserved for slf functions needing to do cleanup */
2575 if (coro->slf_frame.destroy && coro->slf_frame.prepare && !PL_dirty)
2576 coro->slf_frame.destroy (aTHX_ &coro->slf_frame);
2577
2578 /*
2579 * The on_destroy above most likely is from an SLF call.
2580 * Since by definition the SLF call will not finish when we destroy
2581 * the coro, we will have to force-finish it here, otherwise
2582 * cleanup functions cannot call SLF functions.
2583 */
2584 coro->slf_frame.prepare = 0;
2585 }
2586
2587 /*
2588 * these not obviously related functions are all rolled into one
2589 * function to increase chances that they all will call transfer with the same
2590 * stack offset
2591 * SLF stands for "schedule-like-function".
2592 */
2593 static OP *
2594 pp_slf (pTHX)
2595 {
2596 I32 checkmark; /* mark SP to see how many elements check has pushed */
2597
2598 /* set up the slf frame, unless it has already been set-up */
2599 /* the latter happens when a new coro has been started */
2600 /* or when a new cctx was attached to an existing coroutine */
2601 if (ecb_expect_true (!slf_frame.prepare))
2602 {
2603 /* first iteration */
2604 dSP;
2605 SV **arg = PL_stack_base + TOPMARK + 1;
2606 int items = SP - arg; /* args without function object */
2607 SV *gv = *sp;
2608
2609 /* do a quick consistency check on the "function" object, and if it isn't */
2610 /* for us, divert to the real entersub */
2611 if (SvTYPE (gv) != SVt_PVGV
2612 || !GvCV (gv)
2613 || !(CvFLAGS (GvCV (gv)) & CVf_SLF))
2614 return PL_ppaddr[OP_ENTERSUB](aTHX);
2615
2616 if (!(PL_op->op_flags & OPf_STACKED))
2617 {
2618 /* ampersand-form of call, use @_ instead of stack */
2619 AV *av = GvAV (PL_defgv);
2620 arg = AvARRAY (av);
2621 items = AvFILLp (av) + 1;
2622 }
2623
2624 /* now call the init function, which needs to set up slf_frame */
2625 ((coro_slf_cb)CvXSUBANY (GvCV (gv)).any_ptr)
2626 (aTHX_ &slf_frame, GvCV (gv), arg, items);
2627
2628 /* pop args */
2629 SP = PL_stack_base + POPMARK;
2630
2631 PUTBACK;
2632 }
2633
2634 /* now that we have a slf_frame, interpret it! */
2635 /* we use a callback system not to make the code needlessly */
2636 /* complicated, but so we can run multiple perl coros from one cctx */
2637
2638 do
2639 {
2640 struct coro_transfer_args ta;
2641
2642 slf_frame.prepare (aTHX_ &ta);
2643 TRANSFER (ta, 0);
2644
2645 checkmark = PL_stack_sp - PL_stack_base;
2646 }
2647 while (slf_frame.check (aTHX_ &slf_frame));
2648
2649 slf_frame.prepare = 0; /* invalidate the frame, we are done processing it */
2650
2651 /* exception handling */
2652 if (ecb_expect_false (CORO_THROW))
2653 {
2654 SV *exception = sv_2mortal (CORO_THROW);
2655
2656 CORO_THROW = 0;
2657 sv_setsv (ERRSV, exception);
2658 croak (0);
2659 }
2660
2661 /* return value handling - mostly like entersub */
2662 /* make sure we put something on the stack in scalar context */
2663 if (GIMME_V == G_SCALAR
2664 && ecb_expect_false (PL_stack_sp != PL_stack_base + checkmark + 1))
2665 {
2666 dSP;
2667 SV **bot = PL_stack_base + checkmark;
2668
2669 if (sp == bot) /* too few, push undef */
2670 bot [1] = &PL_sv_undef;
2671 else /* too many, take last one */
2672 bot [1] = *sp;
2673
2674 SP = bot + 1;
2675
2676 PUTBACK;
2677 }
2678
2679 return NORMAL;
2680 }
2681
2682 static void
2683 api_execute_slf (pTHX_ CV *cv, coro_slf_cb init_cb, I32 ax)
2684 {
2685 int i;
2686 SV **arg = PL_stack_base + ax;
2687 int items = PL_stack_sp - arg + 1;
2688
2689 assert (("FATAL: SLF call with illegal CV value", !CvANON (cv)));
2690
2691 if (PL_op->op_ppaddr != PL_ppaddr [OP_ENTERSUB]
2692 && PL_op->op_ppaddr != pp_slf)
2693 croak ("FATAL: Coro SLF calls can only be made normally, not via goto or any other means, caught");
2694
2695 CvFLAGS (cv) |= CVf_SLF;
2696 CvXSUBANY (cv).any_ptr = (void *)init_cb;
2697 slf_cv = cv;
2698
2699 /* we patch the op, and then re-run the whole call */
2700 /* we have to put the same argument on the stack for this to work */
2701 /* and this will be done by pp_restore */
2702 slf_restore.op_next = (OP *)&slf_restore;
2703 slf_restore.op_type = OP_CUSTOM;
2704 slf_restore.op_ppaddr = pp_restore;
2705 slf_restore.op_first = PL_op;
2706
2707 slf_ax = ax - 1; /* undo the ax++ inside dAXMARK */
2708
2709 if (PL_op->op_flags & OPf_STACKED)
2710 {
2711 if (items > slf_arga)
2712 {
2713 slf_arga = items;
2714 Safefree (slf_argv);
2715 New (0, slf_argv, slf_arga, SV *);
2716 }
2717
2718 slf_argc = items;
2719
2720 for (i = 0; i < items; ++i)
2721 slf_argv [i] = SvREFCNT_inc (arg [i]);
2722 }
2723 else
2724 slf_argc = 0;
2725
2726 PL_op->op_ppaddr = pp_slf;
2727 /*PL_op->op_type = OP_CUSTOM; /* we do behave like entersub still */
2728
2729 PL_op = (OP *)&slf_restore;
2730 }
2731
2732 /*****************************************************************************/
2733 /* dynamic wind */
2734
2735 static void
2736 on_enterleave_call (pTHX_ SV *cb)
2737 {
2738 dSP;
2739
2740 PUSHSTACK;
2741
2742 PUSHMARK (SP);
2743 PUTBACK;
2744 call_sv (cb, G_VOID | G_DISCARD);
2745 SPAGAIN;
2746
2747 POPSTACK;
2748 }
2749
2750 static SV *
2751 coro_avp_pop_and_free (pTHX_ AV **avp)
2752 {
2753 AV *av = *avp;
2754 SV *res = av_pop (av);
2755
2756 if (AvFILLp (av) < 0)
2757 {
2758 *avp = 0;
2759 SvREFCNT_dec (av);
2760 }
2761
2762 return res;
2763 }
2764
2765 static void
2766 coro_pop_on_enter (pTHX_ void *coro)
2767 {
2768 SV *cb = coro_avp_pop_and_free (aTHX_ &((struct coro *)coro)->on_enter);
2769 SvREFCNT_dec (cb);
2770 }
2771
2772 static void
2773 coro_pop_on_leave (pTHX_ void *coro)
2774 {
2775 SV *cb = coro_avp_pop_and_free (aTHX_ &((struct coro *)coro)->on_leave);
2776 on_enterleave_call (aTHX_ sv_2mortal (cb));
2777 }
2778
2779 /*****************************************************************************/
2780 /* PerlIO::cede */
2781
2782 typedef struct
2783 {
2784 PerlIOBuf base;
2785 NV next, every;
2786 } PerlIOCede;
2787
2788 static IV ecb_cold
2789 PerlIOCede_pushed (pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2790 {
2791 PerlIOCede *self = PerlIOSelf (f, PerlIOCede);
2792
2793 self->every = SvCUR (arg) ? SvNV (arg) : 0.01;
2794 self->next = nvtime () + self->every;
2795
2796 return PerlIOBuf_pushed (aTHX_ f, mode, Nullsv, tab);
2797 }
2798
2799 static SV * ecb_cold
2800 PerlIOCede_getarg (pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
2801 {
2802 PerlIOCede *self = PerlIOSelf (f, PerlIOCede);
2803
2804 return newSVnv (self->every);
2805 }
2806
2807 static IV
2808 PerlIOCede_flush (pTHX_ PerlIO *f)
2809 {
2810 PerlIOCede *self = PerlIOSelf (f, PerlIOCede);
2811 double now = nvtime ();
2812
2813 if (now >= self->next)
2814 {
2815 api_cede (aTHX);
2816 self->next = now + self->every;
2817 }
2818
2819 return PerlIOBuf_flush (aTHX_ f);
2820 }
2821
2822 static PerlIO_funcs PerlIO_cede =
2823 {
2824 sizeof(PerlIO_funcs),
2825 "cede",
2826 sizeof(PerlIOCede),
2827 PERLIO_K_DESTRUCT | PERLIO_K_RAW,
2828 PerlIOCede_pushed,
2829 PerlIOBuf_popped,
2830 PerlIOBuf_open,
2831 PerlIOBase_binmode,
2832 PerlIOCede_getarg,
2833 PerlIOBase_fileno,
2834 PerlIOBuf_dup,
2835 PerlIOBuf_read,
2836 PerlIOBuf_unread,
2837 PerlIOBuf_write,
2838 PerlIOBuf_seek,
2839 PerlIOBuf_tell,
2840 PerlIOBuf_close,
2841 PerlIOCede_flush,
2842 PerlIOBuf_fill,
2843 PerlIOBase_eof,
2844 PerlIOBase_error,
2845 PerlIOBase_clearerr,
2846 PerlIOBase_setlinebuf,
2847 PerlIOBuf_get_base,
2848 PerlIOBuf_bufsiz,
2849 PerlIOBuf_get_ptr,
2850 PerlIOBuf_get_cnt,
2851 PerlIOBuf_set_ptrcnt,
2852 };
2853
2854 /*****************************************************************************/
2855 /* Coro::Semaphore & Coro::Signal */
2856
2857 static SV *
2858 coro_waitarray_new (pTHX_ int count)
2859 {
2860 /* a waitarray=semaphore contains a counter IV in $sem->[0] and any waiters after that */
2861 AV *av = newAV ();
2862 SV **ary;
2863
2864 /* unfortunately, building manually saves memory */
2865 Newx (ary, 2, SV *);
2866 AvALLOC (av) = ary;
2867 #if PERL_VERSION_ATLEAST (5,10,0)
2868 AvARRAY (av) = ary;
2869 #else
2870 /* 5.8.8 needs this syntax instead of AvARRAY = ary, yet */
2871 /* -DDEBUGGING flags this as a bug, despite it perfectly working */
2872 SvPVX ((SV *)av) = (char *)ary;
2873 #endif
2874 AvMAX (av) = 1;
2875 AvFILLp (av) = 0;
2876 ary [0] = newSViv (count);
2877
2878 return newRV_noinc ((SV *)av);
2879 }
2880
2881 /* semaphore */
2882
2883 static void
2884 coro_semaphore_adjust (pTHX_ AV *av, IV adjust)
2885 {
2886 SV *count_sv = AvARRAY (av)[0];
2887 IV count = SvIVX (count_sv);
2888
2889 count += adjust;
2890 SvIVX (count_sv) = count;
2891
2892 /* now wake up as many waiters as are expected to lock */
2893 while (count > 0 && AvFILLp (av) > 0)
2894 {
2895 SV *cb;
2896
2897 /* swap first two elements so we can shift a waiter */
2898 AvARRAY (av)[0] = AvARRAY (av)[1];
2899 AvARRAY (av)[1] = count_sv;
2900 cb = av_shift (av);
2901
2902 if (SvOBJECT (cb))
2903 {
2904 api_ready (aTHX_ cb);
2905 --count;
2906 }
2907 else if (SvTYPE (cb) == SVt_PVCV)
2908 {
2909 dSP;
2910 PUSHMARK (SP);
2911 XPUSHs (sv_2mortal (newRV_inc ((SV *)av)));
2912 PUTBACK;
2913 call_sv (cb, G_VOID | G_DISCARD | G_EVAL | G_KEEPERR);
2914 }
2915
2916 SvREFCNT_dec (cb);
2917 }
2918 }
2919
2920 static void
2921 coro_semaphore_destroy (pTHX_ struct CoroSLF *frame)
2922 {
2923 /* call $sem->adjust (0) to possibly wake up some other waiters */
2924 coro_semaphore_adjust (aTHX_ (AV *)frame->data, 0);
2925 }
2926
2927 static int
2928 slf_check_semaphore_down_or_wait (pTHX_ struct CoroSLF *frame, int acquire)
2929 {
2930 AV *av = (AV *)frame->data;
2931 SV *count_sv = AvARRAY (av)[0];
2932 SV *coro_hv = SvRV (coro_current);
2933
2934 /* if we are about to throw, don't actually acquire the lock, just throw */
2935 if (CORO_THROW)
2936 return 0;
2937 else if (SvIVX (count_sv) > 0)
2938 {
2939 frame->destroy = 0;
2940
2941 if (acquire)
2942 SvIVX (count_sv) = SvIVX (count_sv) - 1;
2943 else
2944 coro_semaphore_adjust (aTHX_ av, 0);
2945
2946 return 0;
2947 }
2948 else
2949 {
2950 int i;
2951 /* if we were woken up but can't down, we look through the whole */
2952 /* waiters list and only add us if we aren't in there already */
2953 /* this avoids some degenerate memory usage cases */
2954 for (i = AvFILLp (av); i > 0; --i) // i > 0 is not an off-by-one bug
2955 if (AvARRAY (av)[i] == coro_hv)
2956 return 1;
2957
2958 av_push (av, SvREFCNT_inc (coro_hv));
2959 return 1;
2960 }
2961 }
2962
2963 static int
2964 slf_check_semaphore_down (pTHX_ struct CoroSLF *frame)
2965 {
2966 return slf_check_semaphore_down_or_wait (aTHX_ frame, 1);
2967 }
2968
2969 static int
2970 slf_check_semaphore_wait (pTHX_ struct CoroSLF *frame)
2971 {
2972 return slf_check_semaphore_down_or_wait (aTHX_ frame, 0);
2973 }
2974
2975 static void
2976 slf_init_semaphore_down_or_wait (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2977 {
2978 AV *av = (AV *)SvRV (arg [0]);
2979
2980 if (SvIVX (AvARRAY (av)[0]) > 0)
2981 {
2982 frame->data = (void *)av;
2983 frame->prepare = prepare_nop;
2984 }
2985 else
2986 {
2987 av_push (av, SvREFCNT_inc (SvRV (coro_current)));
2988
2989 frame->data = (void *)sv_2mortal (SvREFCNT_inc ((SV *)av));
2990 frame->prepare = prepare_schedule;
2991 /* to avoid race conditions when a woken-up coro gets terminated */
2992 /* we arrange for a temporary on_destroy that calls adjust (0) */
2993 frame->destroy = coro_semaphore_destroy;
2994 }
2995 }
2996
2997 static void
2998 slf_init_semaphore_down (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2999 {
3000 slf_init_semaphore_down_or_wait (aTHX_ frame, cv, arg, items);
3001 frame->check = slf_check_semaphore_down;
3002 }
3003
3004 static void
3005 slf_init_semaphore_wait (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
3006 {
3007 if (items >= 2)
3008 {
3009 /* callback form */
3010 AV *av = (AV *)SvRV (arg [0]);
3011 SV *cb_cv = s_get_cv_croak (arg [1]);
3012
3013 av_push (av, SvREFCNT_inc_NN (cb_cv));
3014
3015 if (SvIVX (AvARRAY (av)[0]) > 0)
3016 coro_semaphore_adjust (aTHX_ av, 0);
3017
3018 frame->prepare = prepare_nop;
3019 frame->check = slf_check_nop;
3020 }
3021 else
3022 {
3023 slf_init_semaphore_down_or_wait (aTHX_ frame, cv, arg, items);
3024 frame->check = slf_check_semaphore_wait;
3025 }
3026 }
3027
3028 /* signal */
3029
3030 static void
3031 coro_signal_wake (pTHX_ AV *av, int count)
3032 {
3033 SvIVX (AvARRAY (av)[0]) = 0;
3034
3035 /* now signal count waiters */
3036 while (count > 0 && AvFILLp (av) > 0)
3037 {
3038 SV *cb;
3039
3040 /* swap first two elements so we can shift a waiter */
3041 cb = AvARRAY (av)[0];
3042 AvARRAY (av)[0] = AvARRAY (av)[1];
3043 AvARRAY (av)[1] = cb;
3044
3045 cb = av_shift (av);
3046
3047 if (SvTYPE (cb) == SVt_PVCV)
3048 {
3049 dSP;
3050 PUSHMARK (SP);
3051 XPUSHs (sv_2mortal (newRV_inc ((SV *)av)));
3052 PUTBACK;
3053 call_sv (cb, G_VOID | G_DISCARD | G_EVAL | G_KEEPERR);
3054 }
3055 else
3056 {
3057 api_ready (aTHX_ cb);
3058 sv_setiv (cb, 0); /* signal waiter */
3059 }
3060
3061 SvREFCNT_dec (cb);
3062
3063 --count;
3064 }
3065 }
3066
3067 static int
3068 slf_check_signal_wait (pTHX_ struct CoroSLF *frame)
3069 {
3070 /* if we are about to throw, also stop waiting */
3071 return SvROK ((SV *)frame->data) && !CORO_THROW;
3072 }
3073
3074 static void
3075 slf_init_signal_wait (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
3076 {
3077 AV *av = (AV *)SvRV (arg [0]);
3078
3079 if (items >= 2)
3080 {
3081 SV *cb_cv = s_get_cv_croak (arg [1]);
3082 av_push (av, SvREFCNT_inc_NN (cb_cv));
3083
3084 if (SvIVX (AvARRAY (av)[0]))
3085 coro_signal_wake (aTHX_ av, 1); /* must be the only waiter */
3086
3087 frame->prepare = prepare_nop;
3088 frame->check = slf_check_nop;
3089 }
3090 else if (SvIVX (AvARRAY (av)[0]))
3091 {
3092 SvIVX (AvARRAY (av)[0]) = 0;
3093 frame->prepare = prepare_nop;
3094 frame->check = slf_check_nop;
3095 }
3096 else
3097 {
3098 SV *waiter = newSVsv (coro_current); /* owned by signal av */
3099
3100 av_push (av, waiter);
3101
3102 frame->data = (void *)sv_2mortal (SvREFCNT_inc_NN (waiter)); /* owned by process */
3103 frame->prepare = prepare_schedule;
3104 frame->check = slf_check_signal_wait;
3105 }
3106 }
3107
3108 /*****************************************************************************/
3109 /* Coro::AIO */
3110
3111 #define CORO_MAGIC_type_aio PERL_MAGIC_ext
3112
3113 /* helper storage struct */
3114 struct io_state
3115 {
3116 int errorno;
3117 I32 laststype; /* U16 in 5.10.0 */
3118 int laststatval;
3119 Stat_t statcache;
3120 };
3121
3122 static void
3123 coro_aio_callback (pTHX_ CV *cv)
3124 {
3125 dXSARGS;
3126 AV *state = (AV *)S_GENSUB_ARG;
3127 SV *coro = av_pop (state);
3128 SV *data_sv = newSV (sizeof (struct io_state));
3129
3130 av_extend (state, items - 1);
3131
3132 sv_upgrade (data_sv, SVt_PV);
3133 SvCUR_set (data_sv, sizeof (struct io_state));
3134 SvPOK_only (data_sv);
3135
3136 {
3137 struct io_state *data = (struct io_state *)SvPVX (data_sv);
3138
3139 data->errorno = errno;
3140 data->laststype = PL_laststype;
3141 data->laststatval = PL_laststatval;
3142 data->statcache = PL_statcache;
3143 }
3144
3145 /* now build the result vector out of all the parameters and the data_sv */
3146 {
3147 int i;
3148
3149 for (i = 0; i < items; ++i)
3150 av_push (state, SvREFCNT_inc_NN (ST (i)));
3151 }
3152
3153 av_push (state, data_sv);
3154
3155 api_ready (aTHX_ coro);
3156 SvREFCNT_dec (coro);
3157 SvREFCNT_dec ((AV *)state);
3158 }
3159
3160 static int
3161 slf_check_aio_req (pTHX_ struct CoroSLF *frame)
3162 {
3163 AV *state = (AV *)frame->data;
3164
3165 /* if we are about to throw, return early */
3166 /* this does not cancel the aio request, but at least */
3167 /* it quickly returns */
3168 if (CORO_THROW)
3169 return 0;
3170
3171 /* one element that is an RV? repeat! */
3172 if (AvFILLp (state) == 0 && SvROK (AvARRAY (state)[0]))
3173 return 1;
3174
3175 /* restore status */
3176 {
3177 SV *data_sv = av_pop (state);
3178 struct io_state *data = (struct io_state *)SvPVX (data_sv);
3179
3180 errno = data->errorno;
3181 PL_laststype = data->laststype;
3182 PL_laststatval = data->laststatval;
3183 PL_statcache = data->statcache;
3184
3185 SvREFCNT_dec (data_sv);
3186 }
3187
3188 /* push result values */
3189 {
3190 dSP;
3191 int i;
3192
3193 EXTEND (SP, AvFILLp (state) + 1);
3194 for (i = 0; i <= AvFILLp (state); ++i)
3195 PUSHs (sv_2mortal (SvREFCNT_inc_NN (AvARRAY (state)[i])));
3196
3197 PUTBACK;
3198 }
3199
3200 return 0;
3201 }
3202
3203 static void
3204 slf_init_aio_req (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
3205 {
3206 AV *state = (AV *)sv_2mortal ((SV *)newAV ());
3207 SV *coro_hv = SvRV (coro_current);
3208 struct coro *coro = SvSTATE_hv (coro_hv);
3209
3210 /* put our coroutine id on the state arg */
3211 av_push (state, SvREFCNT_inc_NN (coro_hv));
3212
3213 /* first see whether we have a non-zero priority and set it as AIO prio */
3214 if (coro->prio)
3215 {
3216 dSP;
3217
3218 static SV *prio_cv;
3219 static SV *prio_sv;
3220
3221 if (ecb_expect_false (!prio_cv))
3222 {
3223 prio_cv = (SV *)get_cv ("IO::AIO::aioreq_pri", 0);
3224 prio_sv = newSViv (0);
3225 }
3226
3227 PUSHMARK (SP);
3228 sv_setiv (prio_sv, coro->prio);
3229 XPUSHs (prio_sv);
3230
3231 PUTBACK;
3232 call_sv (prio_cv, G_VOID | G_DISCARD);
3233 }
3234
3235 /* now call the original request */
3236 {
3237 dSP;
3238 CV *req = (CV *)CORO_MAGIC_NN ((SV *)cv, CORO_MAGIC_type_aio)->mg_obj;
3239 int i;
3240
3241 PUSHMARK (SP);
3242
3243 /* first push all args to the stack */
3244 EXTEND (SP, items + 1);
3245
3246 for (i = 0; i < items; ++i)
3247 PUSHs (arg [i]);
3248
3249 /* now push the callback closure */
3250 PUSHs (sv_2mortal (s_gensub (aTHX_ coro_aio_callback, (void *)SvREFCNT_inc_NN ((SV *)state))));
3251
3252 /* now call the AIO function - we assume our request is uncancelable */
3253 PUTBACK;
3254 call_sv ((SV *)req, G_VOID | G_DISCARD);
3255 }
3256
3257 /* now that the request is going, we loop till we have a result */
3258 frame->data = (void *)state;
3259 frame->prepare = prepare_schedule;
3260 frame->check = slf_check_aio_req;
3261 }
3262
3263 static void
3264 coro_aio_req_xs (pTHX_ CV *cv)
3265 {
3266 dXSARGS;
3267
3268 CORO_EXECUTE_SLF_XS (slf_init_aio_req);
3269
3270 XSRETURN_EMPTY;
3271 }
3272
3273 /*****************************************************************************/
3274
3275 #if CORO_CLONE
3276 # include "clone.c"
3277 #endif
3278
3279 /*****************************************************************************/
3280
3281 static SV *
3282 coro_new (pTHX_ HV *stash, SV **argv, int argc, int is_coro)
3283 {
3284 SV *coro_sv;
3285 struct coro *coro;
3286 MAGIC *mg;
3287 HV *hv;
3288 SV *cb;
3289 int i;
3290
3291 if (argc > 0)
3292 {
3293 cb = s_get_cv_croak (argv [0]);
3294
3295 if (!is_coro)
3296 {
3297 if (CvISXSUB (cb))
3298 croak ("Coro::State doesn't support XS functions as coroutine start, caught");
3299
3300 if (!CvROOT (cb))
3301 croak ("Coro::State doesn't support autoloaded or undefined functions as coroutine start, caught");
3302 }
3303 }
3304
3305 Newz (0, coro, 1, struct coro);
3306 coro->args = newAV ();
3307 coro->flags = CF_NEW;
3308
3309 if (coro_first) coro_first->prev = coro;
3310 coro->next = coro_first;
3311 coro_first = coro;
3312
3313 coro->hv = hv = newHV ();
3314 mg = sv_magicext ((SV *)hv, 0, CORO_MAGIC_type_state, &coro_state_vtbl, (char *)coro, 0);
3315 mg->mg_flags |= MGf_DUP;
3316 coro_sv = sv_bless (newRV_noinc ((SV *)hv), stash);
3317
3318 if (argc > 0)
3319 {
3320 av_extend (coro->args, argc + is_coro - 1);
3321
3322 if (is_coro)
3323 {
3324 av_push (coro->args, SvREFCNT_inc_NN ((SV *)cb));
3325 cb = (SV *)cv_coro_run;
3326 }
3327
3328 coro->startcv = (CV *)SvREFCNT_inc_NN ((SV *)cb);
3329
3330 for (i = 1; i < argc; i++)
3331 av_push (coro->args, newSVsv (argv [i]));
3332 }
3333
3334 return coro_sv;
3335 }
3336
3337 #ifndef __cplusplus
3338 ecb_cold XS(boot_Coro__State);
3339 #endif
3340
3341 #if CORO_JIT
3342
3343 static void ecb_noinline ecb_cold
3344 pushav_3uv (pTHX_ UV a, UV b, UV c)
3345 {
3346 dSP;
3347 AV *av = newAV ();
3348
3349 av_store (av, 2, newSVuv (c));
3350 av_store (av, 1, newSVuv (b));
3351 av_store (av, 0, newSVuv (a));
3352
3353 XPUSHs (sv_2mortal (newRV_noinc ((SV *)av)));
3354
3355 PUTBACK;
3356 }
3357
3358 static void ecb_noinline ecb_cold
3359 jit_init (pTHX)
3360 {
3361 dSP;
3362 SV *load, *save;
3363 char *map_base;
3364 char *load_ptr, *save_ptr;
3365 STRLEN load_len, save_len;
3366 int count;
3367
3368 PUSHMARK (SP);
3369 PUTBACK;
3370 #define VARx(name,expr,type) pushav_3uv (aTHX_ (UV)&(expr), offsetof (perl_slots, name), sizeof (type));
3371 # include "state.h"
3372 #undef VARx
3373 count = call_pv ("Coro::State::_jit", G_ARRAY);
3374 SPAGAIN;
3375
3376 save = POPs; save_ptr = SvPVbyte (save, save_len);
3377 load = POPs; load_ptr = SvPVbyte (load, load_len);
3378
3379 map_base = mmap (0, load_len + save_len + 16, PROT_EXEC | PROT_WRITE, MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
3380
3381 assert (("Coro: unable mmap jit code page, cannot continue.", map_base != (char *)MAP_FAILED));
3382
3383 load_perl_slots = (load_save_perl_slots_type)map_base;
3384 memcpy (map_base, load_ptr, load_len);
3385
3386 map_base += (load_len + 15) & ~15;
3387
3388 save_perl_slots = (load_save_perl_slots_type)map_base;
3389 memcpy (map_base, save_ptr, save_len);
3390 }
3391
3392 #endif
3393
3394 MODULE = Coro::State PACKAGE = Coro::State PREFIX = api_
3395
3396 PROTOTYPES: DISABLE
3397
3398 BOOT:
3399 {
3400 #ifdef USE_ITHREADS
3401 # if CORO_PTHREAD
3402 coro_thx = PERL_GET_CONTEXT;
3403 # endif
3404 #endif
3405 BOOT_PAGESIZE;
3406
3407 /* perl defines these to check for existance first, but why it doesn't */
3408 /* just create them one at init time is not clear to me, except for */
3409 /* programs trying to delete them, but... */
3410 /* anyway, we declare this as invalid and make sure they are initialised here */
3411 DEFSV;
3412 ERRSV;
3413
3414 cctx_current = cctx_new_empty ();
3415
3416 irsgv = gv_fetchpv ("/" , GV_ADD|GV_NOTQUAL, SVt_PV);
3417 stdoutgv = gv_fetchpv ("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO);
3418
3419 orig_sigelem_get = PL_vtbl_sigelem.svt_get; PL_vtbl_sigelem.svt_get = coro_sigelem_get;
3420 orig_sigelem_set = PL_vtbl_sigelem.svt_set; PL_vtbl_sigelem.svt_set = coro_sigelem_set;
3421 orig_sigelem_clr = PL_vtbl_sigelem.svt_clear; PL_vtbl_sigelem.svt_clear = coro_sigelem_clr;
3422
3423 hv_sig = coro_get_hv (aTHX_ "SIG", TRUE);
3424 rv_diehook = newRV_inc ((SV *)gv_fetchpv ("Coro::State::diehook" , 0, SVt_PVCV));
3425 rv_warnhook = newRV_inc ((SV *)gv_fetchpv ("Coro::State::warnhook", 0, SVt_PVCV));
3426
3427 coro_state_stash = gv_stashpv ("Coro::State", TRUE);
3428
3429 newCONSTSUB (coro_state_stash, "CC_TRACE" , newSViv (CC_TRACE));
3430 newCONSTSUB (coro_state_stash, "CC_TRACE_SUB" , newSViv (CC_TRACE_SUB));
3431 newCONSTSUB (coro_state_stash, "CC_TRACE_LINE", newSViv (CC_TRACE_LINE));
3432 newCONSTSUB (coro_state_stash, "CC_TRACE_ALL" , newSViv (CC_TRACE_ALL));
3433
3434 main_mainstack = PL_mainstack;
3435 main_top_env = PL_top_env;
3436
3437 while (main_top_env->je_prev)
3438 main_top_env = main_top_env->je_prev;
3439
3440 {
3441 SV *slf = sv_2mortal (newSViv (PTR2IV (pp_slf)));
3442
3443 if (!PL_custom_op_names) PL_custom_op_names = newHV ();
3444 hv_store_ent (PL_custom_op_names, slf, newSVpv ("coro_slf", 0), 0);
3445
3446 if (!PL_custom_op_descs) PL_custom_op_descs = newHV ();
3447 hv_store_ent (PL_custom_op_descs, slf, newSVpv ("coro schedule like function", 0), 0);
3448 }
3449
3450 coroapi.ver = CORO_API_VERSION;
3451 coroapi.rev = CORO_API_REVISION;
3452
3453 coroapi.transfer = api_transfer;
3454
3455 coroapi.sv_state = SvSTATE_;
3456 coroapi.execute_slf = api_execute_slf;
3457 coroapi.prepare_nop = prepare_nop;
3458 coroapi.prepare_schedule = prepare_schedule;
3459 coroapi.prepare_cede = prepare_cede;
3460 coroapi.prepare_cede_notself = prepare_cede_notself;
3461
3462 time_init (aTHX);
3463
3464 assert (("PRIO_NORMAL must be 0", !CORO_PRIO_NORMAL));
3465 #if CORO_JIT
3466 PUTBACK;
3467 require_pv ("Coro/jit-" CORO_JIT_TYPE ".pl");
3468 jit_init (aTHX);
3469 perl_eval_pv ("undef &Coro::State::_jit", 1);
3470 SPAGAIN;
3471 #endif
3472 }
3473
3474 SV *
3475 new (SV *klass, ...)
3476 ALIAS:
3477 Coro::new = 1
3478 CODE:
3479 RETVAL = coro_new (aTHX_ ix ? coro_stash : coro_state_stash, &ST (1), items - 1, ix);
3480 OUTPUT:
3481 RETVAL
3482
3483 void
3484 transfer (...)
3485 PROTOTYPE: $$
3486 CODE:
3487 CORO_EXECUTE_SLF_XS (slf_init_transfer);
3488
3489 void
3490 _exit (int code)
3491 PROTOTYPE: $
3492 CODE:
3493 _exit (code);
3494
3495 SV *
3496 clone (Coro::State coro)
3497 CODE:
3498 {
3499 #if CORO_CLONE
3500 struct coro *ncoro = coro_clone (aTHX_ coro);
3501 MAGIC *mg;
3502 /* TODO: too much duplication */
3503 ncoro->hv = newHV ();
3504 mg = sv_magicext ((SV *)ncoro->hv, 0, CORO_MAGIC_type_state, &coro_state_vtbl, (char *)ncoro, 0);
3505 mg->mg_flags |= MGf_DUP;
3506 RETVAL = sv_bless (newRV_noinc ((SV *)ncoro->hv), SvSTASH (coro->hv));
3507 #else
3508 croak ("Coro::State->clone has not been configured into this installation of Coro, realised");
3509 #endif
3510 }
3511 OUTPUT:
3512 RETVAL
3513
3514 int
3515 cctx_stacksize (int new_stacksize = 0)
3516 PROTOTYPE: ;$
3517 CODE:
3518 RETVAL = cctx_stacksize;
3519 if (new_stacksize)
3520 {
3521 cctx_stacksize = new_stacksize;
3522 ++cctx_gen;
3523 }
3524 OUTPUT:
3525 RETVAL
3526
3527 int
3528 cctx_max_idle (int max_idle = 0)
3529 PROTOTYPE: ;$
3530 CODE:
3531 RETVAL = cctx_max_idle;
3532 if (max_idle > 1)
3533 cctx_max_idle = max_idle;
3534 OUTPUT:
3535 RETVAL
3536
3537 int
3538 cctx_count ()
3539 PROTOTYPE:
3540 CODE:
3541 RETVAL = cctx_count;
3542 OUTPUT:
3543 RETVAL
3544
3545 int
3546 cctx_idle ()
3547 PROTOTYPE:
3548 CODE:
3549 RETVAL = cctx_idle;
3550 OUTPUT:
3551 RETVAL
3552
3553 void
3554 list ()
3555 PROTOTYPE:
3556 PPCODE:
3557 {
3558 struct coro *coro;
3559 for (coro = coro_first; coro; coro = coro->next)
3560 if (coro->hv)
3561 XPUSHs (sv_2mortal (newRV_inc ((SV *)coro->hv)));
3562 }
3563
3564 void
3565 call (Coro::State coro, SV *coderef)
3566 ALIAS:
3567 eval = 1
3568 CODE:
3569 {
3570 if (coro->mainstack && ((coro->flags & CF_RUNNING) || coro->slot))
3571 {
3572 struct coro *current = SvSTATE_current;
3573 struct CoroSLF slf_save;
3574
3575 if (current != coro)
3576 {
3577 PUTBACK;
3578 save_perl (aTHX_ current);
3579 load_perl (aTHX_ coro);
3580 /* the coro is most likely in an active SLF call.
3581 * while not strictly required (the code we execute is
3582 * not allowed to call any SLF functions), it's cleaner
3583 * to reinitialise the slf_frame and restore it later.
3584 * This might one day allow us to actually do SLF calls
3585 * from code executed here.
3586 */
3587 slf_save = slf_frame;
3588 slf_frame.prepare = 0;
3589 SPAGAIN;
3590 }
3591
3592 PUSHSTACK;
3593
3594 PUSHMARK (SP);
3595 PUTBACK;
3596
3597 if (ix)
3598 eval_sv (coderef, 0);
3599 else
3600 call_sv (coderef, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
3601
3602 POPSTACK;
3603 SPAGAIN;
3604
3605 if (current != coro)
3606 {
3607 PUTBACK;
3608 slf_frame = slf_save;
3609 save_perl (aTHX_ coro);
3610 load_perl (aTHX_ current);
3611 SPAGAIN;
3612 }
3613 }
3614 }
3615
3616 SV *
3617 is_ready (Coro::State coro)
3618 PROTOTYPE: $
3619 ALIAS:
3620 is_ready = CF_READY
3621 is_running = CF_RUNNING
3622 is_new = CF_NEW
3623 is_destroyed = CF_ZOMBIE
3624 is_zombie = CF_ZOMBIE
3625 is_suspended = CF_SUSPENDED
3626 CODE:
3627 RETVAL = boolSV (coro->flags & ix);
3628 OUTPUT:
3629 RETVAL
3630
3631 void
3632 throw (Coro::State self, SV *exception = &PL_sv_undef)
3633 PROTOTYPE: $;$
3634 CODE:
3635 {
3636 struct coro *current = SvSTATE_current;
3637 SV **exceptionp = self == current ? &CORO_THROW : &self->except;
3638 SvREFCNT_dec (*exceptionp);
3639 SvGETMAGIC (exception);
3640 *exceptionp = SvOK (exception) ? newSVsv (exception) : 0;
3641 }
3642
3643 void
3644 api_trace (SV *coro, int flags = CC_TRACE | CC_TRACE_SUB)
3645 PROTOTYPE: $;$
3646 C_ARGS: aTHX_ coro, flags
3647
3648 SV *
3649 has_cctx (Coro::State coro)
3650 PROTOTYPE: $
3651 CODE:
3652 /* maybe manage the running flag differently */
3653 RETVAL = boolSV (!!coro->cctx || (coro->flags & CF_RUNNING));
3654 OUTPUT:
3655 RETVAL
3656
3657 int
3658 is_traced (Coro::State coro)
3659 PROTOTYPE: $
3660 CODE:
3661 RETVAL = (coro->cctx ? coro->cctx->flags : 0) & CC_TRACE_ALL;
3662 OUTPUT:
3663 RETVAL
3664
3665 UV
3666 rss (Coro::State coro)
3667 PROTOTYPE: $
3668 ALIAS:
3669 usecount = 1
3670 CODE:
3671 switch (ix)
3672 {
3673 case 0: RETVAL = coro_rss (aTHX_ coro); break;
3674 case 1: RETVAL = coro->usecount; break;
3675 }
3676 OUTPUT:
3677 RETVAL
3678
3679 void
3680 force_cctx ()
3681 PROTOTYPE:
3682 CODE:
3683 cctx_current->idle_sp = 0;
3684
3685 void
3686 swap_defsv (Coro::State self)
3687 PROTOTYPE: $
3688 ALIAS:
3689 swap_defav = 1
3690 CODE:
3691 if (!self->slot)
3692 croak ("cannot swap state with coroutine that has no saved state,");
3693 else
3694 {
3695 SV **src = ix ? (SV **)&GvAV (PL_defgv) : &GvSV (PL_defgv);
3696 SV **dst = ix ? (SV **)&self->slot->defav : (SV **)&self->slot->defsv;
3697
3698 SV *tmp = *src; *src = *dst; *dst = tmp;
3699 }
3700
3701 void
3702 cancel (Coro::State self)
3703 CODE:
3704 coro_state_destroy (aTHX_ self);
3705
3706 SV *
3707 enable_times (int enabled = enable_times)
3708 CODE:
3709 {
3710 RETVAL = boolSV (enable_times);
3711
3712 if (enabled != enable_times)
3713 {
3714 enable_times = enabled;
3715
3716 coro_times_update ();
3717 (enabled ? coro_times_sub : coro_times_add)(SvSTATE (coro_current));
3718 }
3719 }
3720 OUTPUT:
3721 RETVAL
3722
3723 void
3724 times (Coro::State self)
3725 PPCODE:
3726 {
3727 struct coro *current = SvSTATE (coro_current);
3728
3729 if (ecb_expect_false (current == self))
3730 {
3731 coro_times_update ();
3732 coro_times_add (SvSTATE (coro_current));
3733 }
3734
3735 EXTEND (SP, 2);
3736 PUSHs (sv_2mortal (newSVnv (self->t_real [0] + self->t_real [1] * 1e-9)));
3737 PUSHs (sv_2mortal (newSVnv (self->t_cpu [0] + self->t_cpu [1] * 1e-9)));
3738
3739 if (ecb_expect_false (current == self))
3740 coro_times_sub (SvSTATE (coro_current));
3741 }
3742
3743 void
3744 swap_sv (Coro::State coro, SV *sv, SV *swapsv)
3745 CODE:
3746 {
3747 struct coro *current = SvSTATE_current;
3748
3749 if (current == coro)
3750 SWAP_SVS (current);
3751
3752 if (!coro->swap_sv)
3753 coro->swap_sv = newAV ();
3754
3755 av_push (coro->swap_sv, SvREFCNT_inc_NN (SvRV (sv )));
3756 av_push (coro->swap_sv, SvREFCNT_inc_NN (SvRV (swapsv)));
3757
3758 if (current == coro)
3759 SWAP_SVS (current);
3760 }
3761
3762
3763 MODULE = Coro::State PACKAGE = Coro
3764
3765 BOOT:
3766 {
3767 sv_pool_rss = coro_get_sv (aTHX_ "Coro::POOL_RSS" , TRUE);
3768 sv_pool_size = coro_get_sv (aTHX_ "Coro::POOL_SIZE" , TRUE);
3769 cv_coro_run = get_cv ( "Coro::_coro_run" , GV_ADD);
3770 coro_current = coro_get_sv (aTHX_ "Coro::current" , FALSE); SvREADONLY_on (coro_current);
3771 av_async_pool = coro_get_av (aTHX_ "Coro::async_pool", TRUE);
3772 av_destroy = coro_get_av (aTHX_ "Coro::destroy" , TRUE);
3773 sv_manager = coro_get_sv (aTHX_ "Coro::manager" , TRUE);
3774 sv_idle = coro_get_sv (aTHX_ "Coro::idle" , TRUE);
3775
3776 sv_async_pool_idle = newSVpv ("[async pool idle]", 0); SvREADONLY_on (sv_async_pool_idle);
3777 sv_Coro = newSVpv ("Coro", 0); SvREADONLY_on (sv_Coro);
3778 cv_pool_handler = get_cv ("Coro::pool_handler", GV_ADD); SvREADONLY_on (cv_pool_handler);
3779 CvNODEBUG_on (get_cv ("Coro::_pool_handler", 0)); /* work around a debugger bug */
3780
3781 coro_stash = gv_stashpv ("Coro", TRUE);
3782
3783 newCONSTSUB (coro_stash, "PRIO_MAX", newSViv (CORO_PRIO_MAX));
3784 newCONSTSUB (coro_stash, "PRIO_HIGH", newSViv (CORO_PRIO_HIGH));
3785 newCONSTSUB (coro_stash, "PRIO_NORMAL", newSViv (CORO_PRIO_NORMAL));
3786 newCONSTSUB (coro_stash, "PRIO_LOW", newSViv (CORO_PRIO_LOW));
3787 newCONSTSUB (coro_stash, "PRIO_IDLE", newSViv (CORO_PRIO_IDLE));
3788 newCONSTSUB (coro_stash, "PRIO_MIN", newSViv (CORO_PRIO_MIN));
3789
3790 {
3791 SV *sv = coro_get_sv (aTHX_ "Coro::API", TRUE);
3792
3793 coroapi.schedule = api_schedule;
3794 coroapi.schedule_to = api_schedule_to;
3795 coroapi.cede = api_cede;
3796 coroapi.cede_notself = api_cede_notself;
3797 coroapi.ready = api_ready;
3798 coroapi.is_ready = api_is_ready;
3799 coroapi.nready = coro_nready;
3800 coroapi.current = coro_current;
3801
3802 /*GCoroAPI = &coroapi;*/
3803 sv_setiv (sv, (IV)&coroapi);
3804 SvREADONLY_on (sv);
3805 }
3806 }
3807
3808 SV *
3809 async (...)
3810 PROTOTYPE: &@
3811 CODE:
3812 RETVAL = coro_new (aTHX_ coro_stash, &ST (0), items, 1);
3813 api_ready (aTHX_ RETVAL);
3814 OUTPUT:
3815 RETVAL
3816
3817 void
3818 _destroy (Coro::State coro)
3819 CODE:
3820 /* used by the manager thread */
3821 coro_state_destroy (aTHX_ coro);
3822
3823 void
3824 on_destroy (Coro::State coro, SV *cb)
3825 CODE:
3826 coro_push_on_destroy (aTHX_ coro, newSVsv (cb));
3827
3828 void
3829 join (...)
3830 CODE:
3831 CORO_EXECUTE_SLF_XS (slf_init_join);
3832
3833 void
3834 terminate (...)
3835 CODE:
3836 CORO_EXECUTE_SLF_XS (slf_init_terminate);
3837
3838 void
3839 cancel (...)
3840 CODE:
3841 CORO_EXECUTE_SLF_XS (slf_init_cancel);
3842
3843 int
3844 safe_cancel (Coro::State self, ...)
3845 C_ARGS: aTHX_ self, &ST (1), items - 1
3846
3847 void
3848 schedule (...)
3849 CODE:
3850 CORO_EXECUTE_SLF_XS (slf_init_schedule);
3851
3852 void
3853 schedule_to (...)
3854 CODE:
3855 CORO_EXECUTE_SLF_XS (slf_init_schedule_to);
3856
3857 void
3858 cede_to (...)
3859 CODE:
3860 CORO_EXECUTE_SLF_XS (slf_init_cede_to);
3861
3862 void
3863 cede (...)
3864 CODE:
3865 CORO_EXECUTE_SLF_XS (slf_init_cede);
3866
3867 void
3868 cede_notself (...)
3869 CODE:
3870 CORO_EXECUTE_SLF_XS (slf_init_cede_notself);
3871
3872 void
3873 _set_current (SV *current)
3874 PROTOTYPE: $
3875 CODE:
3876 SvREFCNT_dec (SvRV (coro_current));
3877 SvRV_set (coro_current, SvREFCNT_inc_NN (SvRV (current)));
3878
3879 void
3880 _set_readyhook (SV *hook)
3881 PROTOTYPE: $
3882 CODE:
3883 SvREFCNT_dec (coro_readyhook);
3884 SvGETMAGIC (hook);
3885 if (SvOK (hook))
3886 {
3887 coro_readyhook = newSVsv (hook);
3888 CORO_READYHOOK = invoke_sv_ready_hook_helper;
3889 }
3890 else
3891 {
3892 coro_readyhook = 0;
3893 CORO_READYHOOK = 0;
3894 }
3895
3896 int
3897 prio (Coro::State coro, int newprio = 0)
3898 PROTOTYPE: $;$
3899 ALIAS:
3900 nice = 1
3901 CODE:
3902 {
3903 RETVAL = coro->prio;
3904
3905 if (items > 1)
3906 {
3907 if (ix)
3908 newprio = coro->prio - newprio;
3909
3910 if (newprio < CORO_PRIO_MIN) newprio = CORO_PRIO_MIN;
3911 if (newprio > CORO_PRIO_MAX) newprio = CORO_PRIO_MAX;
3912
3913 coro->prio = newprio;
3914 }
3915 }
3916 OUTPUT:
3917 RETVAL
3918
3919 SV *
3920 ready (SV *self)
3921 PROTOTYPE: $
3922 CODE:
3923 RETVAL = boolSV (api_ready (aTHX_ self));
3924 OUTPUT:
3925 RETVAL
3926
3927 int
3928 nready (...)
3929 PROTOTYPE:
3930 CODE:
3931 RETVAL = coro_nready;
3932 OUTPUT:
3933 RETVAL
3934
3935 void
3936 suspend (Coro::State self)
3937 PROTOTYPE: $
3938 CODE:
3939 self->flags |= CF_SUSPENDED;
3940
3941 void
3942 resume (Coro::State self)
3943 PROTOTYPE: $
3944 CODE:
3945 self->flags &= ~CF_SUSPENDED;
3946
3947 void
3948 _pool_handler (...)
3949 CODE:
3950 CORO_EXECUTE_SLF_XS (slf_init_pool_handler);
3951
3952 void
3953 async_pool (SV *cv, ...)
3954 PROTOTYPE: &@
3955 PPCODE:
3956 {
3957 HV *hv = (HV *)av_pop (av_async_pool);
3958 AV *av = newAV ();
3959 SV *cb = ST (0);
3960 int i;
3961
3962 av_extend (av, items - 2);
3963 for (i = 1; i < items; ++i)
3964 av_push (av, SvREFCNT_inc_NN (ST (i)));
3965
3966 if ((SV *)hv == &PL_sv_undef)
3967 {
3968 SV *sv = coro_new (aTHX_ coro_stash, (SV **)&cv_pool_handler, 1, 1);
3969 hv = (HV *)SvREFCNT_inc_NN (SvRV (sv));
3970 SvREFCNT_dec (sv);
3971 }
3972
3973 {
3974 struct coro *coro = SvSTATE_hv (hv);
3975
3976 assert (!coro->invoke_cb);
3977 assert (!coro->invoke_av);
3978 coro->invoke_cb = SvREFCNT_inc (cb);
3979 coro->invoke_av = av;
3980 }
3981
3982 api_ready (aTHX_ (SV *)hv);
3983
3984 if (GIMME_V != G_VOID)
3985 XPUSHs (sv_2mortal (newRV_noinc ((SV *)hv)));
3986 else
3987 SvREFCNT_dec (hv);
3988 }
3989
3990 SV *
3991 rouse_cb ()
3992 PROTOTYPE:
3993 CODE:
3994 RETVAL = coro_new_rouse_cb (aTHX);
3995 OUTPUT:
3996 RETVAL
3997
3998 void
3999 rouse_wait (...)
4000 PROTOTYPE: ;$
4001 PPCODE:
4002 CORO_EXECUTE_SLF_XS (slf_init_rouse_wait);
4003
4004 void
4005 on_enter (SV *block)
4006 ALIAS:
4007 on_leave = 1
4008 PROTOTYPE: &
4009 CODE:
4010 {
4011 struct coro *coro = SvSTATE_current;
4012 AV **avp = ix ? &coro->on_leave : &coro->on_enter;
4013
4014 block = s_get_cv_croak (block);
4015
4016 if (!*avp)
4017 *avp = newAV ();
4018
4019 av_push (*avp, SvREFCNT_inc (block));
4020
4021 if (!ix)
4022 on_enterleave_call (aTHX_ block);
4023
4024 LEAVE; /* pp_entersub unfortunately forces an ENTER/LEAVE around XS calls */
4025 SAVEDESTRUCTOR_X (ix ? coro_pop_on_leave : coro_pop_on_enter, (void *)coro);
4026 ENTER; /* pp_entersub unfortunately forces an ENTER/LEAVE around XS calls */
4027 }
4028
4029
4030 MODULE = Coro::State PACKAGE = PerlIO::cede
4031
4032 BOOT:
4033 PerlIO_define_layer (aTHX_ &PerlIO_cede);
4034
4035
4036 MODULE = Coro::State PACKAGE = Coro::Semaphore
4037
4038 SV *
4039 new (SV *klass, SV *count = 0)
4040 CODE:
4041 {
4042 int semcnt = 1;
4043
4044 if (count)
4045 {
4046 SvGETMAGIC (count);
4047
4048 if (SvOK (count))
4049 semcnt = SvIV (count);
4050 }
4051
4052 RETVAL = sv_bless (
4053 coro_waitarray_new (aTHX_ semcnt),
4054 GvSTASH (CvGV (cv))
4055 );
4056 }
4057 OUTPUT:
4058 RETVAL
4059
4060 # helper for Coro::Channel and others
4061 SV *
4062 _alloc (int count)
4063 CODE:
4064 RETVAL = coro_waitarray_new (aTHX_ count);
4065 OUTPUT:
4066 RETVAL
4067
4068 SV *
4069 count (SV *self)
4070 CODE:
4071 RETVAL = newSVsv (AvARRAY ((AV *)SvRV (self))[0]);
4072 OUTPUT:
4073 RETVAL
4074
4075 void
4076 up (SV *self, int adjust = 1)
4077 ALIAS:
4078 adjust = 1
4079 CODE:
4080 coro_semaphore_adjust (aTHX_ (AV *)SvRV (self), ix ? adjust : 1);
4081
4082 void
4083 down (...)
4084 CODE:
4085 CORO_EXECUTE_SLF_XS (slf_init_semaphore_down);
4086
4087 void
4088 wait (...)
4089 CODE:
4090 CORO_EXECUTE_SLF_XS (slf_init_semaphore_wait);
4091
4092 void
4093 try (SV *self)
4094 PPCODE:
4095 {
4096 AV *av = (AV *)SvRV (self);
4097 SV *count_sv = AvARRAY (av)[0];
4098 IV count = SvIVX (count_sv);
4099
4100 if (count > 0)
4101 {
4102 --count;
4103 SvIVX (count_sv) = count;
4104 XSRETURN_YES;
4105 }
4106 else
4107 XSRETURN_NO;
4108 }
4109
4110 void
4111 waiters (SV *self)
4112 PPCODE:
4113 {
4114 AV *av = (AV *)SvRV (self);
4115 int wcount = AvFILLp (av) + 1 - 1;
4116
4117 if (GIMME_V == G_SCALAR)
4118 XPUSHs (sv_2mortal (newSViv (wcount)));
4119 else
4120 {
4121 int i;
4122 EXTEND (SP, wcount);
4123 for (i = 1; i <= wcount; ++i)
4124 PUSHs (sv_2mortal (newRV_inc (AvARRAY (av)[i])));
4125 }
4126 }
4127
4128 MODULE = Coro::State PACKAGE = Coro::SemaphoreSet
4129
4130 void
4131 _may_delete (SV *sem, int count, int extra_refs)
4132 PPCODE:
4133 {
4134 AV *av = (AV *)SvRV (sem);
4135
4136 if (SvREFCNT ((SV *)av) == 1 + extra_refs
4137 && AvFILLp (av) == 0 /* no waiters, just count */
4138 && SvIV (AvARRAY (av)[0]) == count)
4139 XSRETURN_YES;
4140
4141 XSRETURN_NO;
4142 }
4143
4144 MODULE = Coro::State PACKAGE = Coro::Signal
4145
4146 SV *
4147 new (SV *klass)
4148 CODE:
4149 RETVAL = sv_bless (
4150 coro_waitarray_new (aTHX_ 0),
4151 GvSTASH (CvGV (cv))
4152 );
4153 OUTPUT:
4154 RETVAL
4155
4156 void
4157 wait (...)
4158 CODE:
4159 CORO_EXECUTE_SLF_XS (slf_init_signal_wait);
4160
4161 void
4162 broadcast (SV *self)
4163 CODE:
4164 {
4165 AV *av = (AV *)SvRV (self);
4166 coro_signal_wake (aTHX_ av, AvFILLp (av));
4167 }
4168
4169 void
4170 send (SV *self)
4171 CODE:
4172 {
4173 AV *av = (AV *)SvRV (self);
4174
4175 if (AvFILLp (av))
4176 coro_signal_wake (aTHX_ av, 1);
4177 else
4178 SvIVX (AvARRAY (av)[0]) = 1; /* remember the signal */
4179 }
4180
4181 IV
4182 awaited (SV *self)
4183 CODE:
4184 RETVAL = AvFILLp ((AV *)SvRV (self)) + 1 - 1;
4185 OUTPUT:
4186 RETVAL
4187
4188
4189 MODULE = Coro::State PACKAGE = Coro::AnyEvent
4190
4191 BOOT:
4192 sv_activity = coro_get_sv (aTHX_ "Coro::AnyEvent::ACTIVITY", TRUE);
4193
4194 void
4195 _schedule (...)
4196 CODE:
4197 {
4198 static int incede;
4199
4200 api_cede_notself (aTHX);
4201
4202 ++incede;
4203 while (coro_nready >= incede && api_cede (aTHX))
4204 ;
4205
4206 sv_setsv (sv_activity, &PL_sv_undef);
4207 if (coro_nready >= incede)
4208 {
4209 PUSHMARK (SP);
4210 PUTBACK;
4211 call_pv ("Coro::AnyEvent::_activity", G_KEEPERR | G_EVAL | G_VOID | G_DISCARD);
4212 }
4213
4214 --incede;
4215 }
4216
4217
4218 MODULE = Coro::State PACKAGE = Coro::AIO
4219
4220 void
4221 _register (char *target, char *proto, SV *req)
4222 CODE:
4223 {
4224 SV *req_cv = s_get_cv_croak (req);
4225 /* newXSproto doesn't return the CV on 5.8 */
4226 CV *slf_cv = newXS (target, coro_aio_req_xs, __FILE__);
4227 sv_setpv ((SV *)slf_cv, proto);
4228 sv_magicext ((SV *)slf_cv, (SV *)req_cv, CORO_MAGIC_type_aio, 0, 0, 0);
4229 }
4230
4231 MODULE = Coro::State PACKAGE = Coro::Select
4232
4233 void
4234 patch_pp_sselect ()
4235 CODE:
4236 if (!coro_old_pp_sselect)
4237 {
4238 coro_select_select = (SV *)get_cv ("Coro::Select::select", 0);
4239 coro_old_pp_sselect = PL_ppaddr [OP_SSELECT];
4240 PL_ppaddr [OP_SSELECT] = coro_pp_sselect;
4241 }
4242
4243 void
4244 unpatch_pp_sselect ()
4245 CODE:
4246 if (coro_old_pp_sselect)
4247 {
4248 PL_ppaddr [OP_SSELECT] = coro_old_pp_sselect;
4249 coro_old_pp_sselect = 0;
4250 }
4251