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.106 by root, Mon Nov 27 02:08:55 2006 UTC vs.
Revision 1.334 by root, Fri Nov 28 23:30:55 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines