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

Diff Legend

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