ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro/State.xs
Revision: 1.465
Committed: Sat Jun 25 19:04:04 2016 UTC (7 years, 10 months ago) by root
Branch: MAIN
CVS Tags: rel-6_51
Changes since 1.464: +1 -1 lines
Log Message:
6.51

File Contents

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