ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Coro/Coro/State.xs
(Generate patch)

Comparing Coro/Coro/State.xs (file contents):
Revision 1.1 by root, Sat Jul 14 22:14:21 2001 UTC vs.
Revision 1.141 by root, Mon Jan 22 18:45:17 2007 UTC

1#include "libcoro/coro.c"
2
1#include "EXTERN.h" 3#include "EXTERN.h"
2#include "perl.h" 4#include "perl.h"
3#include "XSUB.h" 5#include "XSUB.h"
4 6
7#include "patchlevel.h"
8
9#include <stdio.h>
10#include <errno.h>
11#include <assert.h>
12
13#ifdef HAVE_MMAP
14# include <unistd.h>
15# include <sys/mman.h>
16# ifndef MAP_ANONYMOUS
17# ifdef MAP_ANON
18# define MAP_ANONYMOUS MAP_ANON
19# else
20# undef HAVE_MMAP
21# endif
22# endif
23# include <limits.h>
24# ifndef PAGESIZE
25# define PAGESIZE pagesize
26# define BOOT_PAGESIZE pagesize = sysconf (_SC_PAGESIZE)
27static long pagesize;
28# else
29# define BOOT_PAGESIZE (void)0
30# endif
31#else
32# define PAGESIZE 0
33# define BOOT_PAGESIZE (void)0
34#endif
35
36#if USE_VALGRIND
37# include <valgrind/valgrind.h>
38# define REGISTER_STACK(cctx,start,end) (cctx)->valgrind_id = VALGRIND_STACK_REGISTER ((start), (end))
39#else
40# define REGISTER_STACK(cctx,start,end)
41#endif
42
43/* the maximum number of idle cctx that will be pooled */
44#define MAX_IDLE_CCTX 8
45
46#define PERL_VERSION_ATLEAST(a,b,c) \
47 (PERL_REVISION > (a) \
48 || (PERL_REVISION == (a) \
49 && (PERL_VERSION > (b) \
50 || (PERL_VERSION == (b) && PERLSUBVERSION >= (c)))))
51
52#if !PERL_VERSION_ATLEAST (5,6,0)
53# ifndef PL_ppaddr
54# define PL_ppaddr ppaddr
55# endif
56# ifndef call_sv
57# define call_sv perl_call_sv
58# endif
59# ifndef get_sv
60# define get_sv perl_get_sv
61# endif
62# ifndef get_cv
63# define get_cv perl_get_cv
64# endif
65# ifndef IS_PADGV
66# define IS_PADGV(v) 0
67# endif
68# ifndef IS_PADCONST
69# define IS_PADCONST(v) 0
70# endif
71#endif
72
73/* 5.8.7 */
74#ifndef SvRV_set
75# define SvRV_set(s,v) SvRV(s) = (v)
76#endif
77
78#if !__i386 && !__x86_64 && !__powerpc && !__m68k && !__alpha && !__mips && !__sparc64
79# undef STACKGUARD
80#endif
81
82#ifndef STACKGUARD
83# define STACKGUARD 0
84#endif
85
86/* prefer perl internal functions over our own? */
87#ifndef PREFER_PERL_FUNCTIONS
88# define PREFER_PERL_FUNCTIONS 0
89#endif
90
91/* The next macro should declare a variable stacklevel that contains and approximation
92 * to the current C stack pointer. Its property is that it changes with each call
93 * and should be unique. */
94#define dSTACKLEVEL int stacklevel
95#define STACKLEVEL ((void *)&stacklevel)
96
97#define IN_DESTRUCT (PL_main_cv == Nullcv)
98
99#if __GNUC__ >= 3
100# define attribute(x) __attribute__(x)
101# define BARRIER __asm__ __volatile__ ("" : : : "memory")
102#else
103# define attribute(x)
104# define BARRIER
105#endif
106
107#define NOINLINE attribute ((noinline))
108
109#include "CoroAPI.h"
110
111#ifdef USE_ITHREADS
112static perl_mutex coro_mutex;
113# define LOCK do { MUTEX_LOCK (&coro_mutex); } while (0)
114# define UNLOCK do { MUTEX_UNLOCK (&coro_mutex); } while (0)
115#else
116# define LOCK (void)0
117# define UNLOCK (void)0
118#endif
119
120/* helper storage struct for Coro::AIO */
121struct io_state
122{
123 int errorno;
124 I32 laststype;
125 int laststatval;
126 Stat_t statcache;
127};
128
129static struct CoroAPI coroapi;
130static AV *main_mainstack; /* used to differentiate between $main and others */
131static HV *coro_state_stash, *coro_stash;
132static SV *coro_mortal; /* will be freed after next transfer */
133
134static struct coro_cctx *cctx_first;
135static int cctx_count, cctx_idle;
136
137/* this is a structure representing a c-level coroutine */
138typedef struct coro_cctx {
139 struct coro_cctx *next;
140
141 /* the stack */
142 void *sptr;
143 ssize_t ssize; /* positive == mmap, otherwise malloc */
144
145 /* cpu state */
146 void *idle_sp; /* sp of top-level transfer/schedule/cede call */
147 JMPENV *idle_te; /* same as idle_sp, but for top_env, TODO: remove once stable */
148 JMPENV *top_env;
149 coro_context cctx;
150
151 int inuse;
152
153#if USE_VALGRIND
154 int valgrind_id;
155#endif
156} coro_cctx;
157
158enum {
159 CF_RUNNING = 0x0001, /* coroutine is running */
160 CF_READY = 0x0002, /* coroutine is ready */
161 CF_NEW = 0x0004, /* has never been switched to */
162 CF_DESTROYED = 0x0008, /* coroutine data has been freed */
163};
164
165/* this is a structure representing a perl-level coroutine */
5struct coro { 166struct coro {
6 U8 dowarn; 167 /* the c coroutine allocated to this perl coroutine, if any */
168 coro_cctx *cctx;
169
170 /* data associated with this coroutine (initial args) */
171 AV *args;
172 int refcnt;
173 int save; /* CORO_SAVE flags */
174 int flags; /* CF_ flags */
175
176 /* optionally saved, might be zero */
177 AV *defav; /* @_ */
178 SV *defsv; /* $_ */
179 SV *errsv; /* $@ */
180 SV *irssv; /* $/ */
181 SV *irssv_sv; /* real $/ cache */
7 182
8 PERL_SI *curstackinfo; 183#define VAR(name,type) type name;
9 AV *curstack; 184# include "state.h"
10 AV *mainstack; 185#undef VAR
11 SV **stack_sp;
12 OP *op;
13 SV **curpad;
14 SV **stack_base;
15 SV **stack_max;
16 SV **tmps_stack;
17 I32 tmps_floor;
18 I32 tmps_ix;
19 I32 tmps_max;
20 I32 *markstack;
21 I32 *markstack_ptr;
22 I32 *markstack_max;
23 I32 *scopestack;
24 I32 scopestack_ix;
25 I32 scopestack_max;
26 ANY *savestack;
27 I32 savestack_ix;
28 I32 savestack_max;
29 OP **retstack;
30 I32 retstack_ix;
31 I32 retstack_max;
32 COP *curcop;
33 186
34 SV *proc; 187 /* coro process data */
188 int prio;
35}; 189};
36 190
37typedef struct coro *Coro__State; 191typedef struct coro *Coro__State;
38typedef struct coro *Coro__State_or_hashref; 192typedef struct coro *Coro__State_or_hashref;
39 193
40#define SAVE(c) \ 194/** Coro ********************************************************************/
41 c->dowarn = PL_dowarn; \ 195
42 c->curstackinfo = PL_curstackinfo; \ 196#define PRIO_MAX 3
43 c->curstack = PL_curstack; \ 197#define PRIO_HIGH 1
44 c->mainstack = PL_mainstack; \ 198#define PRIO_NORMAL 0
45 c->stack_sp = PL_stack_sp; \ 199#define PRIO_LOW -1
46 c->op = PL_op; \ 200#define PRIO_IDLE -3
47 c->curpad = PL_curpad; \ 201#define PRIO_MIN -4
202
203/* for Coro.pm */
204static SV *coro_current;
205static AV *coro_ready [PRIO_MAX-PRIO_MIN+1];
206static int coro_nready;
207
208/** lowlevel stuff **********************************************************/
209
210static AV *
211coro_clone_padlist (CV *cv)
212{
213 AV *padlist = CvPADLIST (cv);
214 AV *newpadlist, *newpad;
215
216 newpadlist = newAV ();
217 AvREAL_off (newpadlist);
218#if PERL_VERSION_ATLEAST (5,9,0)
219 Perl_pad_push (aTHX_ padlist, AvFILLp (padlist) + 1);
220#else
221 Perl_pad_push (aTHX_ padlist, AvFILLp (padlist) + 1, 1);
222#endif
223 newpad = (AV *)AvARRAY (padlist)[AvFILLp (padlist)];
224 --AvFILLp (padlist);
225
226 av_store (newpadlist, 0, SvREFCNT_inc (*av_fetch (padlist, 0, FALSE)));
227 av_store (newpadlist, 1, (SV *)newpad);
228
229 return newpadlist;
230}
231
232static void
233free_padlist (AV *padlist)
234{
235 /* may be during global destruction */
236 if (SvREFCNT (padlist))
237 {
238 I32 i = AvFILLp (padlist);
239 while (i >= 0)
240 {
241 SV **svp = av_fetch (padlist, i--, FALSE);
242 if (svp)
243 {
244 SV *sv;
245 while (&PL_sv_undef != (sv = av_pop ((AV *)*svp)))
246 SvREFCNT_dec (sv);
247
248 SvREFCNT_dec (*svp);
249 }
250 }
251
252 SvREFCNT_dec ((SV*)padlist);
253 }
254}
255
256static int
257coro_cv_free (pTHX_ SV *sv, MAGIC *mg)
258{
259 AV *padlist;
260 AV *av = (AV *)mg->mg_obj;
261
262 /* casting is fun. */
263 while (&PL_sv_undef != (SV *)(padlist = (AV *)av_pop (av)))
264 free_padlist (padlist);
265
266 SvREFCNT_dec (av);
267
268 return 0;
269}
270
271#define PERL_MAGIC_coro PERL_MAGIC_ext
272
273static MGVTBL vtbl_coro = {0, 0, 0, 0, coro_cv_free};
274
275#define CORO_MAGIC(cv) \
276 SvMAGIC (cv) \
277 ? SvMAGIC (cv)->mg_type == PERL_MAGIC_coro \
278 ? SvMAGIC (cv) \
279 : mg_find ((SV *)cv, PERL_MAGIC_coro) \
280 : 0
281
282/* the next two functions merely cache the padlists */
283static void
284get_padlist (CV *cv)
285{
286 MAGIC *mg = CORO_MAGIC (cv);
287 AV *av;
288
289 if (mg && AvFILLp ((av = (AV *)mg->mg_obj)) >= 0)
290 CvPADLIST (cv) = (AV *)AvARRAY (av)[AvFILLp (av)--];
291 else
292 {
293#if PREFER_PERL_FUNCTIONS
294 /* this is probably cleaner, but also slower? */
295 CV *cp = Perl_cv_clone (cv);
296 CvPADLIST (cv) = CvPADLIST (cp);
297 CvPADLIST (cp) = 0;
298 SvREFCNT_dec (cp);
299#else
300 CvPADLIST (cv) = coro_clone_padlist (cv);
301#endif
302 }
303}
304
305static void
306put_padlist (CV *cv)
307{
308 MAGIC *mg = CORO_MAGIC (cv);
309 AV *av;
310
311 if (!mg)
312 {
313 sv_magic ((SV *)cv, 0, PERL_MAGIC_coro, 0, 0);
314 mg = mg_find ((SV *)cv, PERL_MAGIC_coro);
315 mg->mg_virtual = &vtbl_coro;
316 mg->mg_obj = (SV *)newAV ();
317 }
318
319 av = (AV *)mg->mg_obj;
320
321 if (AvFILLp (av) >= AvMAX (av))
322 av_extend (av, AvMAX (av) + 1);
323
324 AvARRAY (av)[++AvFILLp (av)] = (SV *)CvPADLIST (cv);
325}
326
327/** load & save, init *******************************************************/
328
329#define SB do {
330#define SE } while (0)
331
332#define REPLACE_SV(sv,val) SB SvREFCNT_dec (sv); (sv) = (val); (val) = 0; SE
333
334static void
335load_perl (Coro__State c)
336{
337#define VAR(name,type) PL_ ## name = c->name;
338# include "state.h"
339#undef VAR
340
341 if (c->defav) REPLACE_SV (GvAV (PL_defgv), c->defav);
342 if (c->defsv) REPLACE_SV (DEFSV , c->defsv);
343 if (c->errsv) REPLACE_SV (ERRSV , c->errsv);
344 if (c->irssv)
345 {
346 if (c->irssv == PL_rs || sv_eq (PL_rs, c->irssv))
347 SvREFCNT_dec (c->irssv);
348 else
349 {
350 REPLACE_SV (PL_rs, c->irssv);
351 if (!c->irssv_sv) c->irssv_sv = get_sv ("/", 0);
352 sv_setsv (c->irssv_sv, PL_rs);
353 }
354 }
355
356 {
357 dSP;
358 CV *cv;
359
360 /* now do the ugly restore mess */
361 while ((cv = (CV *)POPs))
362 {
363 put_padlist (cv); /* mark this padlist as available */
364 CvDEPTH (cv) = PTR2IV (POPs);
365 CvPADLIST (cv) = (AV *)POPs;
366 }
367
368 PUTBACK;
369 }
370}
371
372static void
373save_perl (Coro__State c)
374{
375 {
376 dSP;
377 I32 cxix = cxstack_ix;
378 PERL_CONTEXT *ccstk = cxstack;
379 PERL_SI *top_si = PL_curstackinfo;
380
381 /*
382 * the worst thing you can imagine happens first - we have to save
383 * (and reinitialize) all cv's in the whole callchain :(
384 */
385
386 EXTEND (SP, 3 + 1);
387 PUSHs (Nullsv);
388 /* this loop was inspired by pp_caller */
389 for (;;)
390 {
391 while (cxix >= 0)
392 {
393 PERL_CONTEXT *cx = &ccstk[cxix--];
394
395 if (CxTYPE (cx) == CXt_SUB)
396 {
397 CV *cv = cx->blk_sub.cv;
398
399 if (CvDEPTH (cv))
400 {
401 EXTEND (SP, 3);
402 PUSHs ((SV *)CvPADLIST (cv));
403 PUSHs (INT2PTR (SV *, CvDEPTH (cv)));
404 PUSHs ((SV *)cv);
405
406 CvDEPTH (cv) = 0;
407 get_padlist (cv);
408 }
409 }
410 }
411
412 if (top_si->si_type == PERLSI_MAIN)
413 break;
414
415 top_si = top_si->si_prev;
416 ccstk = top_si->si_cxstack;
417 cxix = top_si->si_cxix;
418 }
419
420 PUTBACK;
421 }
422
423 c->defav = c->save & CORO_SAVE_DEFAV ? (AV *)SvREFCNT_inc (GvAV (PL_defgv)) : 0;
424 c->defsv = c->save & CORO_SAVE_DEFSV ? SvREFCNT_inc (DEFSV) : 0;
425 c->errsv = c->save & CORO_SAVE_ERRSV ? SvREFCNT_inc (ERRSV) : 0;
426 c->irssv = c->save & CORO_SAVE_IRSSV ? SvREFCNT_inc (PL_rs) : 0;
427
428#define VAR(name,type)c->name = PL_ ## name;
429# include "state.h"
430#undef VAR
431}
432
433/*
434 * allocate various perl stacks. This is an exact copy
435 * of perl.c:init_stacks, except that it uses less memory
436 * on the (sometimes correct) assumption that coroutines do
437 * not usually need a lot of stackspace.
438 */
439#if PREFER_PERL_FUNCTIONS
440# define coro_init_stacks init_stacks
441#else
442static void
443coro_init_stacks ()
444{
445 PL_curstackinfo = new_stackinfo(128, 1024/sizeof(PERL_CONTEXT));
446 PL_curstackinfo->si_type = PERLSI_MAIN;
447 PL_curstack = PL_curstackinfo->si_stack;
448 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
449
450 PL_stack_base = AvARRAY(PL_curstack);
48 c->stack_base = PL_stack_base; \ 451 PL_stack_sp = PL_stack_base;
49 c->stack_max = PL_stack_max; \ 452 PL_stack_max = PL_stack_base + AvMAX(PL_curstack);
50 c->tmps_stack = PL_tmps_stack; \
51 c->tmps_floor = PL_tmps_floor; \
52 c->tmps_ix = PL_tmps_ix; \
53 c->tmps_max = PL_tmps_max; \
54 c->markstack = PL_markstack; \
55 c->markstack_ptr = PL_markstack_ptr; \
56 c->markstack_max = PL_markstack_max; \
57 c->scopestack = PL_scopestack; \
58 c->scopestack_ix = PL_scopestack_ix; \
59 c->scopestack_max = PL_scopestack_max;\
60 c->savestack = PL_savestack; \
61 c->savestack_ix = PL_savestack_ix; \
62 c->savestack_max = PL_savestack_max; \
63 c->retstack = PL_retstack; \
64 c->retstack_ix = PL_retstack_ix; \
65 c->retstack_max = PL_retstack_max; \
66 c->curcop = PL_curcop;
67 453
68#define LOAD(c) \ 454 New(50,PL_tmps_stack,128,SV*);
69 PL_dowarn = c->dowarn; \ 455 PL_tmps_floor = -1;
70 PL_curstackinfo = c->curstackinfo; \ 456 PL_tmps_ix = -1;
71 PL_curstack = c->curstack; \ 457 PL_tmps_max = 128;
72 PL_mainstack = c->mainstack; \ 458
73 PL_stack_sp = c->stack_sp; \ 459 New(54,PL_markstack,32,I32);
74 PL_op = c->op; \
75 PL_curpad = c->curpad; \
76 PL_stack_base = c->stack_base; \
77 PL_stack_max = c->stack_max; \
78 PL_tmps_stack = c->tmps_stack; \
79 PL_tmps_floor = c->tmps_floor; \
80 PL_tmps_ix = c->tmps_ix; \
81 PL_tmps_max = c->tmps_max; \
82 PL_markstack = c->markstack; \
83 PL_markstack_ptr = c->markstack_ptr; \ 460 PL_markstack_ptr = PL_markstack;
84 PL_markstack_max = c->markstack_max; \ 461 PL_markstack_max = PL_markstack + 32;
85 PL_scopestack = c->scopestack; \
86 PL_scopestack_ix = c->scopestack_ix; \
87 PL_scopestack_max = c->scopestack_max;\
88 PL_savestack = c->savestack; \
89 PL_savestack_ix = c->savestack_ix; \
90 PL_savestack_max = c->savestack_max; \
91 PL_retstack = c->retstack; \
92 PL_retstack_ix = c->retstack_ix; \
93 PL_retstack_max = c->retstack_max; \
94 PL_curcop = c->curcop;
95 462
96/* this is an EXACT copy of S_nuke_stacks in perl.c, which is unfortunately static */ 463#ifdef SET_MARK_OFFSET
97STATIC void 464 SET_MARK_OFFSET;
98S_nuke_stacks(pTHX) 465#endif
466
467 New(54,PL_scopestack,32,I32);
468 PL_scopestack_ix = 0;
469 PL_scopestack_max = 32;
470
471 New(54,PL_savestack,64,ANY);
472 PL_savestack_ix = 0;
473 PL_savestack_max = 64;
474
475#if !PERL_VERSION_ATLEAST (5,9,0)
476 New(54,PL_retstack,16,OP*);
477 PL_retstack_ix = 0;
478 PL_retstack_max = 16;
479#endif
480}
481#endif
482
483/*
484 * destroy the stacks, the callchain etc...
485 */
486static void
487coro_destroy_stacks ()
99{ 488{
489 if (!IN_DESTRUCT)
490 {
491 /* restore all saved variables and stuff */
492 LEAVE_SCOPE (0);
493 assert (PL_tmps_floor == -1);
494
495 /* free all temporaries */
496 FREETMPS;
497 assert (PL_tmps_ix == -1);
498
499 /* unwind all extra stacks */
500 POPSTACK_TO (PL_mainstack);
501
502 /* unwind main stack */
503 dounwind (-1);
504 }
505
100 while (PL_curstackinfo->si_next) 506 while (PL_curstackinfo->si_next)
101 PL_curstackinfo = PL_curstackinfo->si_next; 507 PL_curstackinfo = PL_curstackinfo->si_next;
508
102 while (PL_curstackinfo) { 509 while (PL_curstackinfo)
510 {
103 PERL_SI *p = PL_curstackinfo->si_prev; 511 PERL_SI *p = PL_curstackinfo->si_prev;
104 /* curstackinfo->si_stack got nuked by sv_free_arenas() */ 512
513 if (!IN_DESTRUCT)
514 SvREFCNT_dec (PL_curstackinfo->si_stack);
515
105 Safefree(PL_curstackinfo->si_cxstack); 516 Safefree (PL_curstackinfo->si_cxstack);
106 Safefree(PL_curstackinfo); 517 Safefree (PL_curstackinfo);
107 PL_curstackinfo = p; 518 PL_curstackinfo = p;
108 } 519 }
520
109 Safefree(PL_tmps_stack); 521 Safefree (PL_tmps_stack);
110 Safefree(PL_markstack); 522 Safefree (PL_markstack);
111 Safefree(PL_scopestack); 523 Safefree (PL_scopestack);
112 Safefree(PL_savestack); 524 Safefree (PL_savestack);
525#if !PERL_VERSION_ATLEAST (5,9,0)
113 Safefree(PL_retstack); 526 Safefree (PL_retstack);
527#endif
114} 528}
115 529
530/** coroutine stack handling ************************************************/
531
532static void
533setup_coro (struct coro *coro)
534{
535 /*
536 * emulate part of the perl startup here.
537 */
538
539 coro_init_stacks ();
540
541 PL_curcop = &PL_compiling;
542 PL_in_eval = EVAL_NULL;
543 PL_curpm = 0;
544 PL_localizing = 0;
545 PL_dirty = 0;
546 PL_restartop = 0;
547
548 {
549 dSP;
550 LOGOP myop;
551
552 SvREFCNT_dec (GvAV (PL_defgv));
553 GvAV (PL_defgv) = coro->args; coro->args = 0;
554
555 Zero (&myop, 1, LOGOP);
556 myop.op_next = Nullop;
557 myop.op_flags = OPf_WANT_VOID;
558
559 PUSHMARK (SP);
560 XPUSHs ((SV *)get_cv ("Coro::State::_coro_init", FALSE));
561 PUTBACK;
562 PL_op = (OP *)&myop;
563 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX);
564 SPAGAIN;
565 }
566
567 ENTER; /* necessary e.g. for dounwind */
568}
569
570static void
571free_coro_mortal ()
572{
573 if (coro_mortal)
574 {
575 SvREFCNT_dec (coro_mortal);
576 coro_mortal = 0;
577 }
578}
579
580/* inject a fake call to Coro::State::_cctx_init into the execution */
581static void NOINLINE
582prepare_cctx (coro_cctx *cctx)
583{
584 dSP;
585 LOGOP myop;
586
587 Zero (&myop, 1, LOGOP);
588 myop.op_next = PL_op;
589 myop.op_flags = OPf_WANT_VOID | OPf_STACKED;
590
591 PUSHMARK (SP);
592 EXTEND (SP, 2);
593 PUSHs (sv_2mortal (newSViv (PTR2IV (cctx))));
594 PUSHs ((SV *)get_cv ("Coro::State::_cctx_init", FALSE));
595 PUTBACK;
596 PL_op = (OP *)&myop;
597 PL_op = PL_ppaddr[OP_ENTERSUB](aTHX);
598 SPAGAIN;
599}
600
601static void
602coro_run (void *arg)
603{
604 /* coro_run is the alternative tail of transfer(), so unlock here. */
605 UNLOCK;
606
607 /*
608 * this is a _very_ stripped down perl interpreter ;)
609 */
610 PL_top_env = &PL_start_env;
611
612 /* inject call to cctx_init */
613 prepare_cctx ((coro_cctx *)arg);
614
615 /* somebody will hit me for both perl_run and PL_restartop */
616 PL_restartop = PL_op;
617 perl_run (PL_curinterp);
618
619 fputs ("FATAL: C coroutine fell over the edge of the world, aborting. Did you call exit in a coroutine?\n", stderr);
620 abort ();
621}
622
623static coro_cctx *
624cctx_new ()
625{
626 coro_cctx *cctx;
627
628 ++cctx_count;
629
630 Newz (0, cctx, 1, coro_cctx);
631
632#if HAVE_MMAP
633
634 cctx->ssize = ((STACKSIZE * sizeof (long) + PAGESIZE - 1) / PAGESIZE + STACKGUARD) * PAGESIZE;
635 /* mmap supposedly does allocate-on-write for us */
636 cctx->sptr = mmap (0, cctx->ssize, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, 0, 0);
637
638 if (cctx->sptr != (void *)-1)
639 {
640# if STACKGUARD
641 mprotect (cctx->sptr, STACKGUARD * PAGESIZE, PROT_NONE);
642# endif
643 REGISTER_STACK (
644 cctx,
645 STACKGUARD * PAGESIZE + (char *)cctx->sptr,
646 cctx->ssize + (char *)cctx->sptr
647 );
648
649 coro_create (&cctx->cctx, coro_run, (void *)cctx, cctx->sptr, cctx->ssize);
650 }
651 else
652#endif
653 {
654 cctx->ssize = -STACKSIZE * (long)sizeof (long);
655 New (0, cctx->sptr, STACKSIZE, long);
656
657 if (!cctx->sptr)
658 {
659 perror ("FATAL: unable to allocate stack for coroutine");
660 _exit (EXIT_FAILURE);
661 }
662
663 REGISTER_STACK (
664 cctx,
665 (char *)cctx->sptr,
666 (char *)cctx->sptr - cctx->ssize
667 );
668
669 coro_create (&cctx->cctx, coro_run, (void *)cctx, cctx->sptr, -cctx->ssize);
670 }
671
672 return cctx;
673}
674
675static void
676cctx_destroy (coro_cctx *cctx)
677{
678 if (!cctx)
679 return;
680
681 --cctx_count;
682
683#if USE_VALGRIND
684 VALGRIND_STACK_DEREGISTER (cctx->valgrind_id);
685#endif
686
687#if HAVE_MMAP
688 if (cctx->ssize > 0)
689 munmap (cctx->sptr, cctx->ssize);
690 else
691#endif
692 Safefree (cctx->sptr);
693
694 Safefree (cctx);
695}
696
697static coro_cctx *
698cctx_get ()
699{
700 coro_cctx *cctx;
701
702 if (cctx_first)
703 {
704 cctx = cctx_first;
705 cctx_first = cctx->next;
706 --cctx_idle;
707 }
708 else
709 {
710 cctx = cctx_new ();
711 PL_op = PL_op->op_next;
712 }
713
714 return cctx;
715}
716
717static void
718cctx_put (coro_cctx *cctx)
719{
720 /* free another cctx if overlimit */
721 if (cctx_idle >= MAX_IDLE_CCTX)
722 {
723 coro_cctx *first = cctx_first;
724 cctx_first = first->next;
725 --cctx_idle;
726
727 assert (!first->inuse);
728 cctx_destroy (first);
729 }
730
731 ++cctx_idle;
732 cctx->next = cctx_first;
733 cctx_first = cctx;
734}
735
736/** coroutine switching *****************************************************/
737
738/* never call directly, always through the coro_state_transfer global variable */
739static void NOINLINE
740transfer (struct coro *prev, struct coro *next)
741{
742 dSTACKLEVEL;
743
744 /* sometimes transfer is only called to set idle_sp */
745 if (!next)
746 {
747 ((coro_cctx *)prev)->idle_sp = STACKLEVEL;
748 assert (((coro_cctx *)prev)->idle_te = PL_top_env); /* just for the side-effect when asserts are enabled */
749 }
750 else if (prev != next)
751 {
752 coro_cctx *prev__cctx;
753
754 if (prev->flags & CF_NEW)
755 {
756 /* create a new empty context */
757 Newz (0, prev->cctx, 1, coro_cctx);
758 prev->cctx->inuse = 1;
759 prev->flags &= ~CF_NEW;
760 prev->flags |= CF_RUNNING;
761 }
762
763 /*TODO: must not croak here */
764 if (!prev->flags & CF_RUNNING)
765 croak ("Coro::State::transfer called with non-running prev Coro::State, but can only transfer from running states");
766
767 if (next->flags & CF_RUNNING)
768 croak ("Coro::State::transfer called with running next Coro::State, but can only transfer to inactive states");
769
770 if (next->flags & CF_DESTROYED)
771 croak ("Coro::State::transfer called with destroyed next Coro::State, but can only transfer to inactive states");
772
773 prev->flags &= ~CF_RUNNING;
774 next->flags |= CF_RUNNING;
775
776 LOCK;
777
778 if (next->flags & CF_NEW)
779 {
780 /* need to start coroutine */
781 next->flags &= ~CF_NEW;
782 /* first get rid of the old state */
783 save_perl (prev);
784 /* setup coroutine call */
785 setup_coro (next);
786 /* need a new stack */
787 assert (!next->cctx);
788 }
789 else
790 {
791 /* coroutine already started */
792 save_perl (prev);
793 load_perl (next);
794 }
795
796 prev__cctx = prev->cctx;
797
798 /* possibly "free" the cctx */
799 if (prev__cctx->idle_sp == STACKLEVEL)
800 {
801 /* I assume that STACKLEVEL is a stronger indicator than PL_top_env changes */
802 assert (("ERROR: current top_env must equal previous top_env", PL_top_env == prev__cctx->idle_te));
803
804 prev->cctx = 0;
805
806 cctx_put (prev__cctx);
807 prev__cctx->inuse = 0;
808 }
809
810 if (!next->cctx)
811 {
812 next->cctx = cctx_get ();
813 assert (!next->cctx->inuse);
814 next->cctx->inuse = 1;
815 }
816
817 if (prev__cctx != next->cctx)
818 {
819 prev__cctx->top_env = PL_top_env;
820 PL_top_env = next->cctx->top_env;
821 coro_transfer (&prev__cctx->cctx, &next->cctx->cctx);
822 }
823
824 free_coro_mortal ();
825 UNLOCK;
826 }
827}
828
829struct transfer_args
830{
831 struct coro *prev, *next;
832};
833
834#define TRANSFER(ta) transfer ((ta).prev, (ta).next)
835
836/** high level stuff ********************************************************/
837
838static int
839coro_state_destroy (struct coro *coro)
840{
841 if (coro->flags & CF_DESTROYED)
842 return 0;
843
844 coro->flags |= CF_DESTROYED;
845
846 if (coro->flags & CF_READY)
847 {
848 /* reduce nready, as destroying a ready coro effectively unreadies it */
849 /* alternative: look through all ready queues and remove the coro */
850 LOCK;
851 --coro_nready;
852 UNLOCK;
853 }
854 else
855 coro->flags |= CF_READY; /* make sure it is NOT put into the readyqueue */
856
857 if (coro->mainstack && coro->mainstack != main_mainstack)
858 {
859 struct coro temp;
860
861 assert (!(coro->flags & CF_RUNNING));
862
863 Zero (&temp, 1, struct coro);
864 temp.save = CORO_SAVE_ALL;
865
866 if (coro->flags & CF_RUNNING)
867 croak ("FATAL: tried to destroy currently running coroutine");
868
869 save_perl (&temp);
870 load_perl (coro);
871
872 coro_destroy_stacks ();
873
874 load_perl (&temp); /* this will get rid of defsv etc.. */
875
876 coro->mainstack = 0;
877 }
878
879 cctx_destroy (coro->cctx);
880 SvREFCNT_dec (coro->args);
881
882 return 1;
883}
884
885static int
886coro_state_free (pTHX_ SV *sv, MAGIC *mg)
887{
888 struct coro *coro = (struct coro *)mg->mg_ptr;
889 mg->mg_ptr = 0;
890
891 if (--coro->refcnt < 0)
892 {
893 coro_state_destroy (coro);
894 Safefree (coro);
895 }
896
897 return 0;
898}
899
900static int
901coro_state_dup (pTHX_ MAGIC *mg, CLONE_PARAMS *params)
902{
903 struct coro *coro = (struct coro *)mg->mg_ptr;
904
905 ++coro->refcnt;
906
907 return 0;
908}
909
910static MGVTBL coro_state_vtbl = {
911 0, 0, 0, 0,
912 coro_state_free,
913 0,
914#ifdef MGf_DUP
915 coro_state_dup,
916#else
917# define MGf_DUP 0
918#endif
919};
920
921static struct coro *
922SvSTATE (SV *coro)
923{
924 HV *stash;
925 MAGIC *mg;
926
927 if (SvROK (coro))
928 coro = SvRV (coro);
929
930 stash = SvSTASH (coro);
931 if (stash != coro_stash && stash != coro_state_stash)
932 {
933 /* very slow, but rare, check */
934 if (!sv_derived_from (sv_2mortal (newRV_inc (coro)), "Coro::State"))
935 croak ("Coro::State object required");
936 }
937
938 mg = SvMAGIC (coro);
939 assert (mg->mg_type == PERL_MAGIC_ext);
940 return (struct coro *)mg->mg_ptr;
941}
942
943static void
944prepare_transfer (struct transfer_args *ta, SV *prev_sv, SV *next_sv)
945{
946 ta->prev = SvSTATE (prev_sv);
947 ta->next = SvSTATE (next_sv);
948}
949
950static void
951api_transfer (SV *prev_sv, SV *next_sv)
952{
953 struct transfer_args ta;
954
955 prepare_transfer (&ta, prev_sv, next_sv);
956 TRANSFER (ta);
957}
958
959static int
960api_save (SV *coro_sv, int new_save)
961{
962 struct coro *coro = SvSTATE (coro_sv);
963 int old_save = coro->save;
964
965 if (new_save >= 0)
966 coro->save = new_save;
967
968 return old_save;
969}
970
971/** Coro ********************************************************************/
972
973static void
974coro_enq (SV *coro_sv)
975{
976 av_push (coro_ready [SvSTATE (coro_sv)->prio - PRIO_MIN], coro_sv);
977}
978
979static SV *
980coro_deq (int min_prio)
981{
982 int prio = PRIO_MAX - PRIO_MIN;
983
984 min_prio -= PRIO_MIN;
985 if (min_prio < 0)
986 min_prio = 0;
987
988 for (prio = PRIO_MAX - PRIO_MIN + 1; --prio >= min_prio; )
989 if (AvFILLp (coro_ready [prio]) >= 0)
990 return av_shift (coro_ready [prio]);
991
992 return 0;
993}
994
995static int
996api_ready (SV *coro_sv)
997{
998 struct coro *coro;
999
1000 if (SvROK (coro_sv))
1001 coro_sv = SvRV (coro_sv);
1002
1003 coro = SvSTATE (coro_sv);
1004
1005 if (coro->flags & CF_READY)
1006 return 0;
1007
1008 coro->flags |= CF_READY;
1009
1010 LOCK;
1011 coro_enq (SvREFCNT_inc (coro_sv));
1012 ++coro_nready;
1013 UNLOCK;
1014
1015 return 1;
1016}
1017
1018static int
1019api_is_ready (SV *coro_sv)
1020{
1021 return !!(SvSTATE (coro_sv)->flags & CF_READY);
1022}
1023
1024static void
1025prepare_schedule (struct transfer_args *ta)
1026{
1027 SV *prev_sv, *next_sv;
1028
1029 for (;;)
1030 {
1031 LOCK;
1032 next_sv = coro_deq (PRIO_MIN);
1033
1034 /* nothing to schedule: call the idle handler */
1035 if (!next_sv)
1036 {
1037 dSP;
1038 UNLOCK;
1039
1040 ENTER;
1041 SAVETMPS;
1042
1043 PUSHMARK (SP);
1044 PUTBACK;
1045 call_sv (get_sv ("Coro::idle", FALSE), G_DISCARD);
1046
1047 FREETMPS;
1048 LEAVE;
1049 continue;
1050 }
1051
1052 ta->next = SvSTATE (next_sv);
1053
1054 /* cannot transfer to destroyed coros, skip and look for next */
1055 if (ta->next->flags & CF_DESTROYED)
1056 {
1057 UNLOCK;
1058 SvREFCNT_dec (next_sv);
1059 /* coro_nready is already taken care of by destroy */
1060 continue;
1061 }
1062
1063 --coro_nready;
1064 UNLOCK;
1065 break;
1066 }
1067
1068 /* free this only after the transfer */
1069 prev_sv = SvRV (coro_current);
1070 SvRV_set (coro_current, next_sv);
1071 ta->prev = SvSTATE (prev_sv);
1072
1073 assert (ta->next->flags & CF_READY);
1074 ta->next->flags &= ~CF_READY;
1075
1076 LOCK;
1077 free_coro_mortal ();
1078 coro_mortal = prev_sv;
1079 UNLOCK;
1080}
1081
1082static void
1083prepare_cede (struct transfer_args *ta)
1084{
1085 api_ready (coro_current);
1086 prepare_schedule (ta);
1087}
1088
1089static int
1090prepare_cede_notself (struct transfer_args *ta)
1091{
1092 if (coro_nready)
1093 {
1094 SV *prev = SvRV (coro_current);
1095 prepare_schedule (ta);
1096 api_ready (prev);
1097 return 1;
1098 }
1099 else
1100 return 0;
1101}
1102
1103static void
1104api_schedule (void)
1105{
1106 struct transfer_args ta;
1107
1108 prepare_schedule (&ta);
1109 TRANSFER (ta);
1110}
1111
1112static int
1113api_cede (void)
1114{
1115 struct transfer_args ta;
1116
1117 prepare_cede (&ta);
1118
1119 if (ta.prev != ta.next)
1120 {
1121 TRANSFER (ta);
1122 return 1;
1123 }
1124 else
1125 return 0;
1126}
1127
1128static int
1129api_cede_notself (void)
1130{
1131 struct transfer_args ta;
1132
1133 if (prepare_cede_notself (&ta))
1134 {
1135 TRANSFER (ta);
1136 return 1;
1137 }
1138 else
1139 return 0;
1140}
1141
116MODULE = Coro::State PACKAGE = Coro::State 1142MODULE = Coro::State PACKAGE = Coro::State
117 1143
118PROTOTYPES: ENABLE 1144PROTOTYPES: DISABLE
119 1145
120Coro::State 1146BOOT:
121newprocess(proc) 1147{
122 SV * proc 1148#ifdef USE_ITHREADS
123 PROTOTYPE: & 1149 MUTEX_INIT (&coro_mutex);
1150#endif
1151 BOOT_PAGESIZE;
1152
1153 coro_state_stash = gv_stashpv ("Coro::State", TRUE);
1154
1155 newCONSTSUB (coro_state_stash, "SAVE_DEFAV", newSViv (CORO_SAVE_DEFAV));
1156 newCONSTSUB (coro_state_stash, "SAVE_DEFSV", newSViv (CORO_SAVE_DEFSV));
1157 newCONSTSUB (coro_state_stash, "SAVE_ERRSV", newSViv (CORO_SAVE_ERRSV));
1158 newCONSTSUB (coro_state_stash, "SAVE_IRSSV", newSViv (CORO_SAVE_IRSSV));
1159 newCONSTSUB (coro_state_stash, "SAVE_ALL", newSViv (CORO_SAVE_ALL));
1160
1161 main_mainstack = PL_mainstack;
1162
1163 coroapi.ver = CORO_API_VERSION;
1164 coroapi.transfer = api_transfer;
1165
1166 assert (("PRIO_NORMAL must be 0", !PRIO_NORMAL));
1167}
1168
1169SV *
1170new (char *klass, ...)
124 CODE: 1171 CODE:
125 Coro__State coro; 1172{
126 1173 struct coro *coro;
1174 HV *hv;
1175 int i;
1176
127 New (0, coro, 1, struct coro); 1177 Newz (0, coro, 1, struct coro);
1178 coro->args = newAV ();
1179 coro->save = CORO_SAVE_ALL;
1180 coro->flags = CF_NEW;
128 1181
129 coro->mainstack = 0; /* actual work is done inside transfer */ 1182 hv = newHV ();
130 coro->proc = SvREFCNT_inc (proc); 1183 sv_magicext ((SV *)hv, 0, PERL_MAGIC_ext, &coro_state_vtbl, (char *)coro, 0)->mg_flags |= MGf_DUP;
1184 RETVAL = sv_bless (newRV_noinc ((SV *)hv), gv_stashpv (klass, 1));
131 1185
132 RETVAL = coro; 1186 for (i = 1; i < items; i++)
1187 av_push (coro->args, newSVsv (ST (i)));
1188}
133 OUTPUT: 1189 OUTPUT:
134 RETVAL 1190 RETVAL
135 1191
1192int
1193save (SV *coro, int new_save = -1)
1194 CODE:
1195 RETVAL = api_save (coro, new_save);
1196 OUTPUT:
1197 RETVAL
1198
136void 1199void
137transfer(prev,next) 1200_set_stacklevel (...)
138 Coro::State_or_hashref prev 1201 ALIAS:
139 Coro::State_or_hashref next 1202 Coro::State::transfer = 1
1203 Coro::schedule = 2
1204 Coro::cede = 3
1205 Coro::cede_notself = 4
140 CODE: 1206 CODE:
1207{
1208 struct transfer_args ta;
141 1209
142 PUTBACK; 1210 switch (ix)
143 SAVE (prev);
144
145 /*
146 * this could be done in newprocess which would to
147 * extremely elegant and fast (just PUTBACK/SAVE/LOAD/SPAGAIN)
148 * code here, but lazy allocation of stacks has also
149 * some virtues and the overhead of the if() is nil.
150 */
151 if (next->mainstack)
152 { 1211 {
153 LOAD (next); 1212 case 0:
154 next->mainstack = 0; /* unnecessary but much cleaner */ 1213 ta.prev = (struct coro *)INT2PTR (coro_cctx *, SvIV (ST (0)));
155 SPAGAIN; 1214 ta.next = 0;
1215 break;
1216
1217 case 1:
1218 if (items != 2)
1219 croak ("Coro::State::transfer (prev,next) expects two arguments, not %d", items);
1220
1221 prepare_transfer (&ta, ST (0), ST (1));
1222 break;
1223
1224 case 2:
1225 prepare_schedule (&ta);
1226 break;
1227
1228 case 3:
1229 prepare_cede (&ta);
1230 break;
1231
1232 case 4:
1233 if (!prepare_cede_notself (&ta))
1234 XSRETURN_EMPTY;
1235
1236 break;
156 } 1237 }
1238
1239 BARRIER;
1240 TRANSFER (ta);
1241
1242 if (GIMME_V != G_VOID && ta.next != ta.prev)
1243 XSRETURN_YES;
1244}
1245
1246bool
1247_destroy (SV *coro_sv)
1248 CODE:
1249 RETVAL = coro_state_destroy (SvSTATE (coro_sv));
1250 OUTPUT:
1251 RETVAL
1252
1253void
1254_exit (code)
1255 int code
1256 PROTOTYPE: $
1257 CODE:
1258 _exit (code);
1259
1260int
1261cctx_count ()
1262 CODE:
1263 RETVAL = cctx_count;
1264 OUTPUT:
1265 RETVAL
1266
1267int
1268cctx_idle ()
1269 CODE:
1270 RETVAL = cctx_idle;
1271 OUTPUT:
1272 RETVAL
1273
1274MODULE = Coro::State PACKAGE = Coro
1275
1276BOOT:
1277{
1278 int i;
1279
1280 coro_stash = gv_stashpv ("Coro", TRUE);
1281
1282 newCONSTSUB (coro_stash, "PRIO_MAX", newSViv (PRIO_MAX));
1283 newCONSTSUB (coro_stash, "PRIO_HIGH", newSViv (PRIO_HIGH));
1284 newCONSTSUB (coro_stash, "PRIO_NORMAL", newSViv (PRIO_NORMAL));
1285 newCONSTSUB (coro_stash, "PRIO_LOW", newSViv (PRIO_LOW));
1286 newCONSTSUB (coro_stash, "PRIO_IDLE", newSViv (PRIO_IDLE));
1287 newCONSTSUB (coro_stash, "PRIO_MIN", newSViv (PRIO_MIN));
1288
1289 coro_current = get_sv ("Coro::current", FALSE);
1290 SvREADONLY_on (coro_current);
1291
1292 for (i = PRIO_MAX - PRIO_MIN + 1; i--; )
1293 coro_ready[i] = newAV ();
1294
157 else 1295 {
1296 SV *sv = perl_get_sv("Coro::API", 1);
1297
1298 coroapi.schedule = api_schedule;
1299 coroapi.save = api_save;
1300 coroapi.cede = api_cede;
1301 coroapi.cede_notself = api_cede_notself;
1302 coroapi.ready = api_ready;
1303 coroapi.is_ready = api_is_ready;
1304 coroapi.nready = &coro_nready;
1305 coroapi.current = coro_current;
1306
1307 GCoroAPI = &coroapi;
1308 sv_setiv (sv, (IV)&coroapi);
1309 SvREADONLY_on (sv);
1310 }
1311}
1312
1313void
1314_set_current (SV *current)
1315 PROTOTYPE: $
1316 CODE:
1317 SvREFCNT_dec (SvRV (coro_current));
1318 SvRV_set (coro_current, SvREFCNT_inc (SvRV (current)));
1319
1320int
1321prio (Coro::State coro, int newprio = 0)
1322 ALIAS:
1323 nice = 1
1324 CODE:
1325{
1326 RETVAL = coro->prio;
1327
1328 if (items > 1)
158 { 1329 {
159 /*
160 * emulate part of the perl startup here.
161 */
162 UNOP myop;
163
164 init_stacks ();
165 PL_op = (OP *)&myop;
166 /*PL_curcop = 0;*/
167
168 SPAGAIN;
169 Zero(&myop, 1, UNOP);
170 myop.op_next = Nullop;
171 myop.op_flags = OPf_WANT_VOID;
172
173 EXTEND (SP,1);
174 PUSHs (next->proc);
175 1330 if (ix)
176 PUTBACK; 1331 newprio = coro->prio - newprio;
177 /*
178 * the next line is slightly wrong, as PL_op->op_next
179 * is actually being executed so we skip the first op
180 * that doens't matter, though, since it is only
181 * pp_nextstate and we never return...
182 */
183 PL_op = Perl_pp_entersub(aTHX);
184 SPAGAIN;
185 1332
186 ENTER; 1333 if (newprio < PRIO_MIN) newprio = PRIO_MIN;
1334 if (newprio > PRIO_MAX) newprio = PRIO_MAX;
1335
1336 coro->prio = newprio;
187 } 1337 }
1338}
1339 OUTPUT:
1340 RETVAL
1341
1342SV *
1343ready (SV *self)
1344 PROTOTYPE: $
1345 CODE:
1346 RETVAL = boolSV (api_ready (self));
1347 OUTPUT:
1348 RETVAL
1349
1350SV *
1351is_ready (SV *self)
1352 PROTOTYPE: $
1353 CODE:
1354 RETVAL = boolSV (api_is_ready (self));
1355 OUTPUT:
1356 RETVAL
1357
1358int
1359nready (...)
1360 PROTOTYPE:
1361 CODE:
1362 RETVAL = coro_nready;
1363 OUTPUT:
1364 RETVAL
1365
1366MODULE = Coro::State PACKAGE = Coro::AIO
1367
1368SV *
1369_get_state ()
1370 CODE:
1371{
1372 struct io_state *data;
1373
1374 RETVAL = newSV (sizeof (struct io_state));
1375 data = (struct io_state *)SvPVX (RETVAL);
1376 SvCUR_set (RETVAL, sizeof (struct io_state));
1377 SvPOK_only (RETVAL);
1378
1379 data->errorno = errno;
1380 data->laststype = PL_laststype;
1381 data->laststatval = PL_laststatval;
1382 data->statcache = PL_statcache;
1383}
1384 OUTPUT:
1385 RETVAL
188 1386
189void 1387void
190DESTROY(coro) 1388_set_state (char *data_)
191 Coro::State coro 1389 PROTOTYPE: $
192 CODE: 1390 CODE:
1391{
1392 struct io_state *data = (void *)data_;
193 1393
194 if (coro->mainstack) 1394 errno = data->errorno;
195 { 1395 PL_laststype = data->laststype;
196 struct coro temp; 1396 PL_laststatval = data->laststatval;
1397 PL_statcache = data->statcache;
1398}
197 1399
198 PUTBACK;
199 SAVE((&temp));
200 LOAD(coro);
201
202 S_nuke_stacks ();
203
204 LOAD((&temp));
205 SPAGAIN;
206 }
207
208 SvREFCNT_dec (coro->proc);
209 Safefree (coro);
210
211

Diff Legend

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