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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines