ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro/State.xs
Revision: 1.408
Committed: Sat Jun 11 16:58:40 2011 UTC (12 years, 11 months ago) by root
Branch: MAIN
Changes since 1.407: +1 -1 lines
Log Message:
*** empty log message ***

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