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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines