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.209 by root, Wed Oct 10 02:58:17 2007 UTC vs.
Revision 1.398 by root, Sat May 7 14:11:10 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines