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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines