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.125 by root, Mon Dec 11 20:54:45 2006 UTC vs.
Revision 1.477 by root, Sat Feb 29 21:40:22 2020 UTC

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

Diff Legend

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