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

Diff Legend

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