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.389 by root, Fri Mar 4 16:41:21 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines