ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro/State.xs
(Generate patch)

Comparing Coro/Coro/State.xs (file contents):
Revision 1.3 by root, Tue Jul 17 00:24:15 2001 UTC vs.
Revision 1.370 by root, Thu Aug 20 21:38:51 2009 UTC

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines