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

Diff Legend

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