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.143 by root, Wed Feb 28 11:43:03 2007 UTC vs.
Revision 1.463 by root, Wed Jun 22 20:37:27 2016 UTC

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

Diff Legend

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