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