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.206 by root, Tue Oct 9 15:45:26 2007 UTC vs.
Revision 1.401 by root, Mon May 16 22:08:24 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines