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.194 by root, Sat Oct 6 00:08:04 2007 UTC vs.
Revision 1.432 by root, Wed May 8 00:44:44 2013 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines