--- Coro/Coro/State.xs 2006/11/27 01:33:30 1.103 +++ Coro/Coro/State.xs 2008/04/05 22:29:54 1.227 @@ -1,11 +1,52 @@ #include "libcoro/coro.c" +#define PERL_NO_GET_CONTEXT +#define PERL_EXT + #include "EXTERN.h" #include "perl.h" #include "XSUB.h" #include "patchlevel.h" +#include +#include +#include +#include /* portable stdint.h */ + +#ifdef HAVE_MMAP +# include +# include +# ifndef MAP_ANONYMOUS +# ifdef MAP_ANON +# define MAP_ANONYMOUS MAP_ANON +# else +# undef HAVE_MMAP +# endif +# endif +# include +# ifndef PAGESIZE +# define PAGESIZE pagesize +# define BOOT_PAGESIZE pagesize = sysconf (_SC_PAGESIZE) +static long pagesize; +# else +# define BOOT_PAGESIZE (void)0 +# endif +#else +# define PAGESIZE 0 +# define BOOT_PAGESIZE (void)0 +#endif + +#if CORO_USE_VALGRIND +# include +# define REGISTER_STACK(cctx,start,end) (cctx)->valgrind_id = VALGRIND_STACK_REGISTER ((start), (end)) +#else +# define REGISTER_STACK(cctx,start,end) +#endif + +/* the maximum number of idle cctx that will be pooled */ +#define MAX_IDLE_CCTX 8 + #define PERL_VERSION_ATLEAST(a,b,c) \ (PERL_REVISION > (a) \ || (PERL_REVISION == (a) \ @@ -33,57 +74,61 @@ # endif #endif -#include -#include +/* 5.8.8 */ +#ifndef GV_NOTQUAL +# define GV_NOTQUAL 0 +#endif +#ifndef newSV +# define newSV(l) NEWSV(0,l) +#endif + +/* 5.11 */ +#ifndef CxHASARGS +# define CxHASARGS(cx) (cx)->blk_sub.hasargs +#endif + +/* 5.8.7 */ +#ifndef SvRV_set +# define SvRV_set(s,v) SvRV(s) = (v) +#endif #if !__i386 && !__x86_64 && !__powerpc && !__m68k && !__alpha && !__mips && !__sparc64 -# undef STACKGUARD +# undef CORO_STACKGUARD #endif -#ifndef STACKGUARD -# define STACKGUARD 0 +#ifndef CORO_STACKGUARD +# define CORO_STACKGUARD 0 #endif -#ifdef HAVE_MMAP -# include -# include -# ifndef MAP_ANONYMOUS -# ifdef MAP_ANON -# define MAP_ANONYMOUS MAP_ANON -# else -# undef HAVE_MMAP -# endif -# endif -# include -# ifndef PAGESIZE -# define PAGESIZE pagesize -# define BOOT_PAGESIZE pagesize = sysconf (_SC_PAGESIZE) -static long pagesize; -# else -# define BOOT_PAGESIZE -# endif +/* prefer perl internal functions over our own? */ +#ifndef CORO_PREFER_PERL_FUNCTIONS +# define CORO_PREFER_PERL_FUNCTIONS 0 #endif -/* The next macro should declare a variable stacklevel that contains and approximation - * to the current C stack pointer. Its property is that it changes with each call - * and should be unique. */ -#define dSTACKLEVEL int stacklevel +/* The next macros try to return the current stack pointer, in an as + * portable way as possible. */ +#define dSTACKLEVEL volatile char stacklevel #define STACKLEVEL ((void *)&stacklevel) #define IN_DESTRUCT (PL_main_cv == Nullcv) #if __GNUC__ >= 3 # define attribute(x) __attribute__(x) +# define BARRIER __asm__ __volatile__ ("" : : : "memory") +# define expect(expr,value) __builtin_expect ((expr),(value)) #else # define attribute(x) +# define BARRIER +# define expect(expr,value) (expr) #endif +#define expect_false(expr) expect ((expr) != 0, 0) +#define expect_true(expr) expect ((expr) != 0, 1) + #define NOINLINE attribute ((noinline)) #include "CoroAPI.h" -#define TRANSFER_SET_STACKLEVEL 0x8bfbfbfb /* magic cookie */ - #ifdef USE_ITHREADS static perl_mutex coro_mutex; # define LOCK do { MUTEX_LOCK (&coro_mutex); } while (0) @@ -93,82 +138,165 @@ # define UNLOCK (void)0 #endif +/* helper storage struct for Coro::AIO */ +struct io_state +{ + int errorno; + I32 laststype; + int laststatval; + Stat_t statcache; +}; + +static size_t coro_stacksize = CORO_STACKSIZE; static struct CoroAPI coroapi; static AV *main_mainstack; /* used to differentiate between $main and others */ +static JMPENV *main_top_env; static HV *coro_state_stash, *coro_stash; -static SV *coro_mortal; /* will be freed after next transfer */ +static volatile SV *coro_mortal; /* will be freed after next transfer */ + +static GV *irsgv; /* $/ */ +static GV *stdoutgv; /* *STDOUT */ +static SV *rv_diehook; +static SV *rv_warnhook; +static HV *hv_sig; /* %SIG */ + +/* async_pool helper stuff */ +static SV *sv_pool_rss; +static SV *sv_pool_size; +static AV *av_async_pool; + +static struct coro_cctx *cctx_first; +static int cctx_count, cctx_idle; + +enum { + CC_MAPPED = 0x01, + CC_NOREUSE = 0x02, /* throw this away after tracing */ + CC_TRACE = 0x04, + CC_TRACE_SUB = 0x08, /* trace sub calls */ + CC_TRACE_LINE = 0x10, /* trace each statement */ + CC_TRACE_ALL = CC_TRACE_SUB | CC_TRACE_LINE, +}; /* this is a structure representing a c-level coroutine */ -typedef struct coro_stack { - struct coro_stack *next; +typedef struct coro_cctx { + struct coro_cctx *next; /* the stack */ void *sptr; - long ssize; /* positive == mmap, otherwise malloc */ + size_t ssize; /* cpu state */ - void *idle_sp; /* sp of top-level transfer/schedule/cede call */ + void *idle_sp; /* sp of top-level transfer/schedule/cede call */ + JMPENV *idle_te; /* same as idle_sp, but for top_env, TODO: remove once stable */ JMPENV *top_env; coro_context cctx; -} coro_stack; -/* this is a structure representing a perl-level coroutine */ -struct coro { - /* the c coroutine allocated to this perl coroutine, if any */ - coro_stack *stack; +#if CORO_USE_VALGRIND + int valgrind_id; +#endif + unsigned char flags; +} coro_cctx; - /* data associated with this coroutine (initial args) */ - AV *args; - int refcnt; +enum { + CF_RUNNING = 0x0001, /* coroutine is running */ + CF_READY = 0x0002, /* coroutine is ready */ + CF_NEW = 0x0004, /* has never been switched to */ + CF_DESTROYED = 0x0008, /* coroutine data has been freed */ +}; - /* optionally saved, might be zero */ - AV *defav; +/* the structure where most of the perl state is stored, overlaid on the cxstack */ +typedef struct { SV *defsv; + AV *defav; SV *errsv; - - /* saved global state not related to stacks */ - U8 dowarn; - I32 in_eval; - - /* the stacks and related info (callchain etc..) */ - PERL_SI *curstackinfo; - AV *curstack; + SV *irsgv; +#define VAR(name,type) type name; +# include "state.h" +#undef VAR +} perl_slots; + +#define SLOT_COUNT ((sizeof (perl_slots) + sizeof (PERL_CONTEXT) - 1) / sizeof (PERL_CONTEXT)) + +/* this is a structure representing a perl-level coroutine */ +struct coro { + /* the c coroutine allocated to this perl coroutine, if any */ + coro_cctx *cctx; + + /* process data */ AV *mainstack; - SV **stack_sp; - OP *op; - SV **curpad; - AV *comppad; - CV *compcv; - SV **stack_base; - SV **stack_max; - SV **tmps_stack; - I32 tmps_floor; - I32 tmps_ix; - I32 tmps_max; - I32 *markstack; - I32 *markstack_ptr; - I32 *markstack_max; - I32 *scopestack; - I32 scopestack_ix; - I32 scopestack_max; - ANY *savestack; - I32 savestack_ix; - I32 savestack_max; - OP **retstack; - I32 retstack_ix; - I32 retstack_max; - PMOP *curpm; - COP *curcop; + perl_slots *slot; /* basically the saved sp */ + + AV *args; /* data associated with this coroutine (initial args) */ + int refcnt; /* coroutines are refcounted, yes */ + int flags; /* CF_ flags */ + HV *hv; /* the perl hash associated with this coro, if any */ + + /* statistics */ + int usecount; /* number of transfers to this coro */ /* coro process data */ int prio; + SV *throw; /* exception to be thrown */ + + /* async_pool */ + SV *saved_deffh; + + /* linked list */ + struct coro *next, *prev; }; typedef struct coro *Coro__State; typedef struct coro *Coro__State_or_hashref; +/** Coro ********************************************************************/ + +#define PRIO_MAX 3 +#define PRIO_HIGH 1 +#define PRIO_NORMAL 0 +#define PRIO_LOW -1 +#define PRIO_IDLE -3 +#define PRIO_MIN -4 + +/* for Coro.pm */ +static SV *coro_current; +static AV *coro_ready [PRIO_MAX-PRIO_MIN+1]; +static int coro_nready; +static struct coro *coro_first; + +/** lowlevel stuff **********************************************************/ + +static SV * +coro_get_sv (pTHX_ const char *name, int create) +{ +#if PERL_VERSION_ATLEAST (5,9,0) + /* silence stupid and wrong 5.10 warning that I am unable to switch off */ + get_sv (name, create); +#endif + return get_sv (name, create); +} + static AV * -coro_clone_padlist (CV *cv) +coro_get_av (pTHX_ const char *name, int create) +{ +#if PERL_VERSION_ATLEAST (5,9,0) + /* silence stupid and wrong 5.10 warning that I am unable to switch off */ + get_av (name, create); +#endif + return get_av (name, create); +} + +static HV * +coro_get_hv (pTHX_ const char *name, int create) +{ +#if PERL_VERSION_ATLEAST (5,9,0) + /* silence stupid and wrong 5.10 warning that I am unable to switch off */ + get_hv (name, create); +#endif + return get_hv (name, create); +} + +static AV * +coro_clone_padlist (pTHX_ CV *cv) { AV *padlist = CvPADLIST (cv); AV *newpadlist, *newpad; @@ -190,7 +318,7 @@ } static void -free_padlist (AV *padlist) +free_padlist (pTHX_ AV *padlist) { /* may be during global destruction */ if (SvREFCNT (padlist)) @@ -221,120 +349,125 @@ /* casting is fun. */ while (&PL_sv_undef != (SV *)(padlist = (AV *)av_pop (av))) - free_padlist (padlist); - - SvREFCNT_dec (av); + free_padlist (aTHX_ padlist); return 0; } -#define PERL_MAGIC_coro PERL_MAGIC_ext +#define CORO_MAGIC_type_cv PERL_MAGIC_ext +#define CORO_MAGIC_type_state PERL_MAGIC_ext -static MGVTBL vtbl_coro = {0, 0, 0, 0, coro_cv_free}; +static MGVTBL coro_cv_vtbl = { + 0, 0, 0, 0, + coro_cv_free +}; + +#define CORO_MAGIC(sv,type) \ + SvMAGIC (sv) \ + ? SvMAGIC (sv)->mg_type == type \ + ? SvMAGIC (sv) \ + : mg_find (sv, type) \ + : 0 + +#define CORO_MAGIC_cv(cv) CORO_MAGIC (((SV *)(cv)), CORO_MAGIC_type_cv) +#define CORO_MAGIC_state(sv) CORO_MAGIC (((SV *)(sv)), CORO_MAGIC_type_state) + +static struct coro * +SvSTATE_ (pTHX_ SV *coro) +{ + HV *stash; + MAGIC *mg; + + if (SvROK (coro)) + coro = SvRV (coro); + + if (expect_false (SvTYPE (coro) != SVt_PVHV)) + croak ("Coro::State object required"); + + stash = SvSTASH (coro); + if (expect_false (stash != coro_stash && stash != coro_state_stash)) + { + /* very slow, but rare, check */ + if (!sv_derived_from (sv_2mortal (newRV_inc (coro)), "Coro::State")) + croak ("Coro::State object required"); + } + + mg = CORO_MAGIC_state (coro); + return (struct coro *)mg->mg_ptr; +} + +#define SvSTATE(sv) SvSTATE_ (aTHX_ (sv)) /* the next two functions merely cache the padlists */ static void -get_padlist (CV *cv) +get_padlist (pTHX_ CV *cv) { - MAGIC *mg = mg_find ((SV *)cv, PERL_MAGIC_coro); + MAGIC *mg = CORO_MAGIC_cv (cv); + AV *av; - if (mg && AvFILLp ((AV *)mg->mg_obj) >= 0) - CvPADLIST (cv) = (AV *)av_pop ((AV *)mg->mg_obj); + if (expect_true (mg && AvFILLp ((av = (AV *)mg->mg_obj)) >= 0)) + CvPADLIST (cv) = (AV *)AvARRAY (av)[AvFILLp (av)--]; else { -#if 0 +#if CORO_PREFER_PERL_FUNCTIONS /* this is probably cleaner, but also slower? */ CV *cp = Perl_cv_clone (cv); CvPADLIST (cv) = CvPADLIST (cp); CvPADLIST (cp) = 0; SvREFCNT_dec (cp); #else - CvPADLIST (cv) = coro_clone_padlist (cv); + CvPADLIST (cv) = coro_clone_padlist (aTHX_ cv); #endif } } static void -put_padlist (CV *cv) +put_padlist (pTHX_ CV *cv) { - MAGIC *mg = mg_find ((SV *)cv, PERL_MAGIC_coro); + MAGIC *mg = CORO_MAGIC_cv (cv); + AV *av; - if (!mg) - { - sv_magic ((SV *)cv, 0, PERL_MAGIC_coro, 0, 0); - mg = mg_find ((SV *)cv, PERL_MAGIC_coro); - mg->mg_virtual = &vtbl_coro; - mg->mg_obj = (SV *)newAV (); - } + if (expect_false (!mg)) + mg = sv_magicext ((SV *)cv, (SV *)newAV (), CORO_MAGIC_type_cv, &coro_cv_vtbl, 0, 0); - av_push ((AV *)mg->mg_obj, (SV *)CvPADLIST (cv)); -} + av = (AV *)mg->mg_obj; -#define SB do { -#define SE } while (0) + if (expect_false (AvFILLp (av) >= AvMAX (av))) + av_extend (av, AvMAX (av) + 1); -#define LOAD(state) load_state((state)); -#define SAVE(state,flags) save_state((state),(flags)); + AvARRAY (av)[++AvFILLp (av)] = (SV *)CvPADLIST (cv); +} -#define REPLACE_SV(sv,val) SB SvREFCNT_dec(sv); (sv) = (val); (val) = 0; SE +/** load & save, init *******************************************************/ static void -load_state(Coro__State c) +load_perl (pTHX_ Coro__State c) { - PL_dowarn = c->dowarn; - PL_in_eval = c->in_eval; + perl_slots *slot = c->slot; + c->slot = 0; - PL_curstackinfo = c->curstackinfo; - PL_curstack = c->curstack; PL_mainstack = c->mainstack; - PL_stack_sp = c->stack_sp; - PL_op = c->op; - PL_curpad = c->curpad; - PL_comppad = c->comppad; - PL_compcv = c->compcv; - PL_stack_base = c->stack_base; - PL_stack_max = c->stack_max; - PL_tmps_stack = c->tmps_stack; - PL_tmps_floor = c->tmps_floor; - PL_tmps_ix = c->tmps_ix; - PL_tmps_max = c->tmps_max; - PL_markstack = c->markstack; - PL_markstack_ptr = c->markstack_ptr; - PL_markstack_max = c->markstack_max; - PL_scopestack = c->scopestack; - PL_scopestack_ix = c->scopestack_ix; - PL_scopestack_max = c->scopestack_max; - PL_savestack = c->savestack; - PL_savestack_ix = c->savestack_ix; - PL_savestack_max = c->savestack_max; -#if !PERL_VERSION_ATLEAST (5,9,0) - PL_retstack = c->retstack; - PL_retstack_ix = c->retstack_ix; - PL_retstack_max = c->retstack_max; -#endif - PL_curpm = c->curpm; - PL_curcop = c->curcop; - - if (c->defav) REPLACE_SV (GvAV (PL_defgv), c->defav); - if (c->defsv) REPLACE_SV (DEFSV , c->defsv); - if (c->errsv) REPLACE_SV (ERRSV , c->errsv); + + GvSV (PL_defgv) = slot->defsv; + GvAV (PL_defgv) = slot->defav; + GvSV (PL_errgv) = slot->errsv; + GvSV (irsgv) = slot->irsgv; + + #define VAR(name,type) PL_ ## name = slot->name; + # include "state.h" + #undef VAR { dSP; + CV *cv; /* now do the ugly restore mess */ - while ((cv = (CV *)POPs)) + while (expect_true (cv = (CV *)POPs)) { - AV *padlist = (AV *)POPs; - - if (padlist) - { - put_padlist (cv); /* mark this padlist as available */ - CvPADLIST(cv) = padlist; - } - - ++CvDEPTH(cv); + put_padlist (aTHX_ cv); /* mark this padlist as available */ + CvDEPTH (cv) = PTR2IV (POPs); + CvPADLIST (cv) = (AV *)POPs; } PUTBACK; @@ -342,7 +475,7 @@ } static void -save_state(Coro__State c, int flags) +save_perl (pTHX_ Coro__State c) { { dSP; @@ -355,92 +488,68 @@ * (and reinitialize) all cv's in the whole callchain :( */ - PUSHs (Nullsv); + XPUSHs (Nullsv); /* this loop was inspired by pp_caller */ for (;;) { - while (cxix >= 0) + while (expect_true (cxix >= 0)) { PERL_CONTEXT *cx = &ccstk[cxix--]; - if (CxTYPE(cx) == CXt_SUB) + if (expect_true (CxTYPE (cx) == CXt_SUB || CxTYPE (cx) == CXt_FORMAT)) { CV *cv = cx->blk_sub.cv; - if (CvDEPTH(cv)) - { - EXTEND (SP, CvDEPTH(cv)*2); - - while (--CvDEPTH(cv)) - { - /* this tells the restore code to increment CvDEPTH */ - PUSHs (Nullsv); - PUSHs ((SV *)cv); - } - PUSHs ((SV *)CvPADLIST(cv)); + if (expect_true (CvDEPTH (cv))) + { + EXTEND (SP, 3); + PUSHs ((SV *)CvPADLIST (cv)); + PUSHs (INT2PTR (SV *, CvDEPTH (cv))); PUSHs ((SV *)cv); - get_padlist (cv); + CvDEPTH (cv) = 0; + get_padlist (aTHX_ cv); } } -#ifdef CXt_FORMAT - else if (CxTYPE(cx) == CXt_FORMAT) - { - /* I never used formats, so how should I know how these are implemented? */ - /* my bold guess is as a simple, plain sub... */ - croak ("CXt_FORMAT not yet handled. Don't switch coroutines from within formats"); - } -#endif } - if (top_si->si_type == PERLSI_MAIN) + if (expect_true (top_si->si_type == PERLSI_MAIN)) break; top_si = top_si->si_prev; - ccstk = top_si->si_cxstack; - cxix = top_si->si_cxix; + ccstk = top_si->si_cxstack; + cxix = top_si->si_cxix; } PUTBACK; } - c->defav = flags & TRANSFER_SAVE_DEFAV ? (AV *)SvREFCNT_inc (GvAV (PL_defgv)) : 0; - c->defsv = flags & TRANSFER_SAVE_DEFSV ? SvREFCNT_inc (DEFSV) : 0; - c->errsv = flags & TRANSFER_SAVE_ERRSV ? SvREFCNT_inc (ERRSV) : 0; - - c->dowarn = PL_dowarn; - c->in_eval = PL_in_eval; + /* allocate some space on the context stack for our purposes */ + /* we manually unroll here, as usually 2 slots is enough */ + if (SLOT_COUNT >= 1) CXINC; + if (SLOT_COUNT >= 2) CXINC; + if (SLOT_COUNT >= 3) CXINC; + { + int i; + for (i = 3; i < SLOT_COUNT; ++i) + CXINC; + } + cxstack_ix -= SLOT_COUNT; /* undo allocation */ - c->curstackinfo = PL_curstackinfo; - c->curstack = PL_curstack; c->mainstack = PL_mainstack; - c->stack_sp = PL_stack_sp; - c->op = PL_op; - c->curpad = PL_curpad; - c->comppad = PL_comppad; - c->compcv = PL_compcv; - c->stack_base = PL_stack_base; - c->stack_max = PL_stack_max; - c->tmps_stack = PL_tmps_stack; - c->tmps_floor = PL_tmps_floor; - c->tmps_ix = PL_tmps_ix; - c->tmps_max = PL_tmps_max; - c->markstack = PL_markstack; - c->markstack_ptr = PL_markstack_ptr; - c->markstack_max = PL_markstack_max; - c->scopestack = PL_scopestack; - c->scopestack_ix = PL_scopestack_ix; - c->scopestack_max = PL_scopestack_max; - c->savestack = PL_savestack; - c->savestack_ix = PL_savestack_ix; - c->savestack_max = PL_savestack_max; -#if !PERL_VERSION_ATLEAST (5,9,0) - c->retstack = PL_retstack; - c->retstack_ix = PL_retstack_ix; - c->retstack_max = PL_retstack_max; -#endif - c->curpm = PL_curpm; - c->curcop = PL_curcop; + + { + perl_slots *slot = c->slot = (perl_slots *)(cxstack + cxstack_ix + 1); + + slot->defav = GvAV (PL_defgv); + slot->defsv = DEFSV; + slot->errsv = ERRSV; + slot->irsgv = GvSV (irsgv); + + #define VAR(name,type) slot->name = PL_ ## name; + # include "state.h" + #undef VAR + } } /* @@ -449,10 +558,13 @@ * on the (sometimes correct) assumption that coroutines do * not usually need a lot of stackspace. */ +#if CORO_PREFER_PERL_FUNCTIONS +# define coro_init_stacks init_stacks +#else static void -coro_init_stacks () +coro_init_stacks (pTHX) { - PL_curstackinfo = new_stackinfo(96, 1024/sizeof(PERL_CONTEXT) - 1); + PL_curstackinfo = new_stackinfo(32, 8); PL_curstackinfo->si_type = PERLSI_MAIN; PL_curstack = PL_curstackinfo->si_stack; PL_mainstack = PL_curstack; /* remember in case we switch stacks */ @@ -461,10 +573,10 @@ PL_stack_sp = PL_stack_base; PL_stack_max = PL_stack_base + AvMAX(PL_curstack); - New(50,PL_tmps_stack,96,SV*); + New(50,PL_tmps_stack,32,SV*); PL_tmps_floor = -1; PL_tmps_ix = -1; - PL_tmps_max = 96; + PL_tmps_max = 32; New(54,PL_markstack,16,I32); PL_markstack_ptr = PL_markstack; @@ -474,38 +586,28 @@ SET_MARK_OFFSET; #endif - New(54,PL_scopestack,16,I32); + New(54,PL_scopestack,8,I32); PL_scopestack_ix = 0; - PL_scopestack_max = 16; + PL_scopestack_max = 8; - New(54,PL_savestack,96,ANY); + New(54,PL_savestack,24,ANY); PL_savestack_ix = 0; - PL_savestack_max = 96; + PL_savestack_max = 24; #if !PERL_VERSION_ATLEAST (5,9,0) - New(54,PL_retstack,8,OP*); + New(54,PL_retstack,4,OP*); PL_retstack_ix = 0; - PL_retstack_max = 8; + PL_retstack_max = 4; #endif } +#endif /* * destroy the stacks, the callchain etc... */ static void -coro_destroy_stacks() +coro_destroy_stacks (pTHX) { - if (!IN_DESTRUCT) - { - /* is this ugly, I ask? */ - LEAVE_SCOPE (0); - - /* sure it is, but more important: is it correct?? :/ */ - FREETMPS; - - /*POPSTACK_TO (PL_mainstack);*//*D*//*use*/ - } - while (PL_curstackinfo->si_next) PL_curstackinfo = PL_curstackinfo->si_next; @@ -513,17 +615,8 @@ { PERL_SI *p = PL_curstackinfo->si_prev; - { /*D*//*remove*/ - dSP; - SWITCHSTACK (PL_curstack, PL_curstackinfo->si_stack); - PUTBACK; /* possibly superfluous */ - } - if (!IN_DESTRUCT) - { - dounwind (-1);/*D*//*remove*/ - SvREFCNT_dec (PL_curstackinfo->si_stack); - } + SvREFCNT_dec (PL_curstackinfo->si_stack); Safefree (PL_curstackinfo->si_cxstack); Safefree (PL_curstackinfo); @@ -539,283 +632,680 @@ #endif } +static size_t +coro_rss (pTHX_ struct coro *coro) +{ + size_t rss = sizeof (*coro); + + if (coro->mainstack) + { + perl_slots tmp_slot; + perl_slots *slot; + + if (coro->flags & CF_RUNNING) + { + slot = &tmp_slot; + + #define VAR(name,type) slot->name = PL_ ## name; + # include "state.h" + #undef VAR + } + else + slot = coro->slot; + + rss += sizeof (slot->curstackinfo); + rss += (slot->curstackinfo->si_cxmax + 1) * sizeof (PERL_CONTEXT); + rss += sizeof (SV) + sizeof (struct xpvav) + (1 + AvMAX (slot->curstack)) * sizeof (SV *); + rss += slot->tmps_max * sizeof (SV *); + rss += (slot->markstack_max - slot->markstack_ptr) * sizeof (I32); + rss += slot->scopestack_max * sizeof (I32); + rss += slot->savestack_max * sizeof (ANY); + +#if !PERL_VERSION_ATLEAST (5,9,0) + rss += slot->retstack_max * sizeof (OP *); +#endif + } + + return rss; +} + +/** coroutine stack handling ************************************************/ + +static int (*orig_sigelem_get) (pTHX_ SV *sv, MAGIC *mg); +static int (*orig_sigelem_set) (pTHX_ SV *sv, MAGIC *mg); + +/* + * This overrides the default magic get method of %SIG elements. + * The original one doesn't provide for reading back of PL_diehook/PL_warnhook + * and instead of tryign to save and restore the hash elements, we just provide + * readback here. + * We only do this when the hook is != 0, as they are often set to 0 temporarily, + * not expecting this to actually change the hook. This is a potential problem + * when a schedule happens then, but we ignore this. + */ +static int +coro_sigelem_get (pTHX_ SV *sv, MAGIC *mg) +{ + const char *s = MgPV_nolen_const (mg); + + if (*s == '_') + { + if (strEQ (s, "__DIE__" ) && PL_diehook ) return sv_setsv (sv, PL_diehook ), 0; + if (strEQ (s, "__WARN__") && PL_warnhook) return sv_setsv (sv, PL_warnhook), 0; + } + + return orig_sigelem_get ? orig_sigelem_get (aTHX_ sv, mg) : 0; +} + +static int +coro_sigelem_set (pTHX_ SV *sv, MAGIC *mg) +{ + const char *s = MgPV_nolen_const (mg); + + if (*s == '_') + { + SV **svp = 0; + + if (strEQ (s, "__DIE__" )) svp = &PL_diehook; + if (strEQ (s, "__WARN__")) svp = &PL_warnhook; + + if (svp) + { + SV *old = *svp; + *svp = newSVsv (sv); + SvREFCNT_dec (old); + return; + } + } + + return orig_sigelem_set ? orig_sigelem_set (aTHX_ sv, mg) : 0; +} + static void -setup_coro (struct coro *coro) +coro_setup (pTHX_ struct coro *coro) { /* * emulate part of the perl startup here. */ + coro_init_stacks (aTHX); - coro_init_stacks (); - - PL_curcop = 0; - PL_in_eval = 0; - PL_curpm = 0; + PL_runops = RUNOPS_DEFAULT; + PL_curcop = &PL_compiling; + PL_in_eval = EVAL_NULL; + PL_comppad = 0; + PL_curpm = 0; + PL_curpad = 0; + PL_localizing = 0; + PL_dirty = 0; + PL_restartop = 0; + + /* recreate the die/warn hooks */ + PL_diehook = 0; SvSetMagicSV (*hv_fetch (hv_sig, "__DIE__" , sizeof ("__DIE__" ) - 1, 1), rv_diehook ); + PL_warnhook = 0; SvSetMagicSV (*hv_fetch (hv_sig, "__WARN__", sizeof ("__WARN__") - 1, 1), rv_warnhook); + + GvSV (PL_defgv) = newSV (0); + GvAV (PL_defgv) = coro->args; coro->args = 0; + GvSV (PL_errgv) = newSV (0); + GvSV (irsgv) = newSVpvn ("\n", 1); sv_magic (GvSV (irsgv), (SV *)irsgv, PERL_MAGIC_sv, "/", 0); + PL_rs = newSVsv (GvSV (irsgv)); + PL_defoutgv = (GV *)SvREFCNT_inc (stdoutgv); { dSP; LOGOP myop; - /* I have no idea why this is needed, but it is */ - PUSHMARK (SP); - - SvREFCNT_dec (GvAV (PL_defgv)); - GvAV (PL_defgv) = coro->args; coro->args = 0; - Zero (&myop, 1, LOGOP); myop.op_next = Nullop; myop.op_flags = OPf_WANT_VOID; - PL_op = (OP *)&myop; - PUSHMARK (SP); - XPUSHs ((SV *)get_cv ("Coro::State::coro_init", FALSE)); + XPUSHs (sv_2mortal (av_shift (GvAV (PL_defgv)))); PUTBACK; + PL_op = (OP *)&myop; PL_op = PL_ppaddr[OP_ENTERSUB](aTHX); SPAGAIN; - - ENTER; /* necessary e.g. for dounwind */ } + + /* this newly created coroutine might be run on an existing cctx which most + * likely was suspended in set_stacklevel, called from entersub. + * set_stacklevl doesn't do anything on return, but entersub does LEAVE, + * so we ENTER here for symmetry + */ + ENTER; +} + +static void +coro_destroy (pTHX_ struct coro *coro) +{ + if (!IN_DESTRUCT) + { + /* restore all saved variables and stuff */ + LEAVE_SCOPE (0); + assert (PL_tmps_floor == -1); + + /* free all temporaries */ + FREETMPS; + assert (PL_tmps_ix == -1); + + /* unwind all extra stacks */ + POPSTACK_TO (PL_mainstack); + + /* unwind main stack */ + dounwind (-1); + } + + SvREFCNT_dec (GvSV (PL_defgv)); + SvREFCNT_dec (GvAV (PL_defgv)); + SvREFCNT_dec (GvSV (PL_errgv)); + SvREFCNT_dec (PL_defoutgv); + SvREFCNT_dec (PL_rs); + SvREFCNT_dec (GvSV (irsgv)); + + SvREFCNT_dec (PL_diehook); + SvREFCNT_dec (PL_warnhook); + + SvREFCNT_dec (coro->saved_deffh); + SvREFCNT_dec (coro->throw); + + coro_destroy_stacks (aTHX); } static void -free_coro_mortal () +free_coro_mortal (pTHX) { - if (coro_mortal) + if (expect_true (coro_mortal)) { SvREFCNT_dec (coro_mortal); coro_mortal = 0; } } +static int +runops_trace (pTHX) +{ + COP *oldcop = 0; + int oldcxix = -2; + struct coro *coro = SvSTATE (coro_current); /* trace cctx is tied to specific coro */ + coro_cctx *cctx = coro->cctx; + + while ((PL_op = CALL_FPTR (PL_op->op_ppaddr) (aTHX))) + { + PERL_ASYNC_CHECK (); + + if (cctx->flags & CC_TRACE_ALL) + { + if (PL_op->op_type == OP_LEAVESUB && cctx->flags & CC_TRACE_SUB) + { + PERL_CONTEXT *cx = &cxstack[cxstack_ix]; + SV **bot, **top; + AV *av = newAV (); /* return values */ + SV **cb; + dSP; + + GV *gv = CvGV (cx->blk_sub.cv); + SV *fullname = sv_2mortal (newSV (0)); + if (isGV (gv)) + gv_efullname3 (fullname, gv, 0); + + bot = PL_stack_base + cx->blk_oldsp + 1; + top = cx->blk_gimme == G_ARRAY ? SP + 1 + : cx->blk_gimme == G_SCALAR ? bot + 1 + : bot; + + av_extend (av, top - bot); + while (bot < top) + av_push (av, SvREFCNT_inc (*bot++)); + + PL_runops = RUNOPS_DEFAULT; + ENTER; + SAVETMPS; + EXTEND (SP, 3); + PUSHMARK (SP); + PUSHs (&PL_sv_no); + PUSHs (fullname); + PUSHs (sv_2mortal (newRV_noinc ((SV *)av))); + PUTBACK; + cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_sub_cb", sizeof ("_trace_sub_cb") - 1, 0); + if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD); + SPAGAIN; + FREETMPS; + LEAVE; + PL_runops = runops_trace; + } + + if (oldcop != PL_curcop) + { + oldcop = PL_curcop; + + if (PL_curcop != &PL_compiling) + { + SV **cb; + + if (oldcxix != cxstack_ix && cctx->flags & CC_TRACE_SUB) + { + PERL_CONTEXT *cx = &cxstack[cxstack_ix]; + + if (CxTYPE (cx) == CXt_SUB && oldcxix < cxstack_ix) + { + runops_proc_t old_runops = PL_runops; + dSP; + GV *gv = CvGV (cx->blk_sub.cv); + SV *fullname = sv_2mortal (newSV (0)); + + if (isGV (gv)) + gv_efullname3 (fullname, gv, 0); + + PL_runops = RUNOPS_DEFAULT; + ENTER; + SAVETMPS; + EXTEND (SP, 3); + PUSHMARK (SP); + PUSHs (&PL_sv_yes); + PUSHs (fullname); + PUSHs (CxHASARGS (cx) ? sv_2mortal (newRV_inc ((SV *)cx->blk_sub.argarray)) : &PL_sv_undef); + PUTBACK; + cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_sub_cb", sizeof ("_trace_sub_cb") - 1, 0); + if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD); + SPAGAIN; + FREETMPS; + LEAVE; + PL_runops = runops_trace; + } + + oldcxix = cxstack_ix; + } + + if (cctx->flags & CC_TRACE_LINE) + { + dSP; + + PL_runops = RUNOPS_DEFAULT; + ENTER; + SAVETMPS; + EXTEND (SP, 3); + PL_runops = RUNOPS_DEFAULT; + PUSHMARK (SP); + PUSHs (sv_2mortal (newSVpv (OutCopFILE (oldcop), 0))); + PUSHs (sv_2mortal (newSViv (CopLINE (oldcop)))); + PUTBACK; + cb = hv_fetch ((HV *)SvRV (coro_current), "_trace_line_cb", sizeof ("_trace_line_cb") - 1, 0); + if (cb) call_sv (*cb, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD); + SPAGAIN; + FREETMPS; + LEAVE; + PL_runops = runops_trace; + } + } + } + } + } + + TAINT_NOT; + return 0; +} + +/* inject a fake call to Coro::State::_cctx_init into the execution */ +/* _cctx_init should be careful, as it could be called at almost any time */ +/* during execution of a perl program */ static void NOINLINE -prepare_cctx (coro_stack *cctx) +cctx_prepare (pTHX_ coro_cctx *cctx) { dSP; LOGOP myop; + PL_top_env = &PL_start_env; + + if (cctx->flags & CC_TRACE) + PL_runops = runops_trace; + Zero (&myop, 1, LOGOP); myop.op_next = PL_op; - myop.op_flags = OPf_WANT_VOID; - - sv_setiv (get_sv ("Coro::State::cctx_stack", FALSE), PTR2IV (cctx)); + myop.op_flags = OPf_WANT_VOID | OPf_STACKED; PUSHMARK (SP); - XPUSHs ((SV *)get_cv ("Coro::State::cctx_init", FALSE)); + EXTEND (SP, 2); + PUSHs (sv_2mortal (newSViv (PTR2IV (cctx)))); + PUSHs ((SV *)get_cv ("Coro::State::_cctx_init", FALSE)); PUTBACK; - PL_restartop = PL_ppaddr[OP_ENTERSUB](aTHX); + PL_op = (OP *)&myop; + PL_op = PL_ppaddr[OP_ENTERSUB](aTHX); SPAGAIN; } +/* + * this is a _very_ stripped down perl interpreter ;) + */ static void -coro_run (void *arg) +cctx_run (void *arg) { - /* coro_run is the alternative epilogue of transfer() */ + dTHX; + + /* cctx_run is the alternative tail of transfer(), so unlock here. */ UNLOCK; - /* - * this is a _very_ stripped down perl interpreter ;) - */ - PL_top_env = &PL_start_env; - /* inject call to cctx_init */ - prepare_cctx ((coro_stack *)arg); + /* we now skip the entersub that lead to transfer() */ + PL_op = PL_op->op_next; - /* somebody will hit me for both perl_run and PL_restartop */ + /* inject a fake subroutine call to cctx_init */ + cctx_prepare (aTHX_ (coro_cctx *)arg); + + /* somebody or something will hit me for both perl_run and PL_restartop */ + PL_restartop = PL_op; perl_run (PL_curinterp); - fputs ("FATAL: C coroutine fell over the edge of the world, aborting.\n", stderr); - abort (); + /* + * If perl-run returns we assume exit() was being called or the coro + * fell off the end, which seems to be the only valid (non-bug) + * reason for perl_run to return. We try to exit by jumping to the + * bootstrap-time "top" top_env, as we cannot restore the "main" + * coroutine as Coro has no such concept + */ + PL_top_env = main_top_env; + JMPENV_JUMP (2); /* I do not feel well about the hardcoded 2 at all */ } -static coro_stack * -stack_new () +static coro_cctx * +cctx_new () { - coro_stack *stack; + coro_cctx *cctx; + void *stack_start; + size_t stack_size; - New (0, stack, 1, coro_stack); + ++cctx_count; -#if HAVE_MMAP + Newz (0, cctx, 1, coro_cctx); - stack->ssize = ((STACKSIZE * sizeof (long) + PAGESIZE - 1) / PAGESIZE + STACKGUARD) * PAGESIZE; - /* mmap suppsedly does allocate-on-write for us */ - stack->sptr = mmap (0, stack->ssize, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, 0, 0); +#if HAVE_MMAP + cctx->ssize = ((coro_stacksize * sizeof (long) + PAGESIZE - 1) / PAGESIZE + CORO_STACKGUARD) * PAGESIZE; + /* mmap supposedly does allocate-on-write for us */ + cctx->sptr = mmap (0, cctx->ssize, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS, 0, 0); - if (stack->sptr == (void *)-1) + if (cctx->sptr != (void *)-1) { - perror ("FATAL: unable to mmap stack for coroutine"); - _exit (EXIT_FAILURE); - } - -# if STACKGUARD - mprotect (stack->sptr, STACKGUARD * PAGESIZE, PROT_NONE); +# if CORO_STACKGUARD + mprotect (cctx->sptr, CORO_STACKGUARD * PAGESIZE, PROT_NONE); # endif + stack_start = CORO_STACKGUARD * PAGESIZE + (char *)cctx->sptr; + stack_size = cctx->ssize - CORO_STACKGUARD * PAGESIZE; + cctx->flags |= CC_MAPPED; + } + else +#endif + { + cctx->ssize = coro_stacksize * (long)sizeof (long); + New (0, cctx->sptr, coro_stacksize, long); -#else - - stack->ssize = STACKSIZE * (long)sizeof (long); - New (0, stack->sptr, STACKSIZE, long); + if (!cctx->sptr) + { + perror ("FATAL: unable to allocate stack for coroutine"); + _exit (EXIT_FAILURE); + } - if (!stack->sptr) - { - perror (stderr, "FATAL: unable to malloc stack for coroutine"); - _exit (EXIT_FAILURE); + stack_start = cctx->sptr; + stack_size = cctx->ssize; } -#endif - - coro_create (&stack->cctx, coro_run, (void *)stack, stack->sptr, stack->ssize); + REGISTER_STACK (cctx, (char *)stack_start, (char *)stack_start + stack_size); + coro_create (&cctx->cctx, cctx_run, (void *)cctx, stack_start, stack_size); - return stack; + return cctx; } static void -stack_free (coro_stack *stack) +cctx_destroy (coro_cctx *cctx) { - if (!stack) + if (!cctx) return; + --cctx_count; + +#if CORO_USE_VALGRIND + VALGRIND_STACK_DEREGISTER (cctx->valgrind_id); +#endif + #if HAVE_MMAP - munmap (stack->sptr, stack->ssize); -#else - Safefree (stack->sptr); + if (cctx->flags & CC_MAPPED) + munmap (cctx->sptr, cctx->ssize); + else #endif + Safefree (cctx->sptr); - Safefree (stack); + Safefree (cctx); } -static coro_stack *stack_first; -static int cctx_count, cctx_idle; +/* wether this cctx should be destructed */ +#define CCTX_EXPIRED(cctx) ((cctx)->ssize < coro_stacksize || ((cctx)->flags & CC_NOREUSE)) -static coro_stack * -stack_get () +static coro_cctx * +cctx_get (pTHX) { - coro_stack *stack; - - if (stack_first) + while (expect_true (cctx_first)) { + coro_cctx *cctx = cctx_first; + cctx_first = cctx->next; --cctx_idle; - stack = stack_first; - stack_first = stack->next; + + if (expect_true (!CCTX_EXPIRED (cctx))) + return cctx; + + cctx_destroy (cctx); } - else - { - ++cctx_count; - stack = stack_new (); - PL_op = PL_op->op_next; - } - return stack; + return cctx_new (); } static void -stack_put (coro_stack *stack) +cctx_put (coro_cctx *cctx) { + /* free another cctx if overlimit */ + if (expect_false (cctx_idle >= MAX_IDLE_CCTX)) + { + coro_cctx *first = cctx_first; + cctx_first = first->next; + --cctx_idle; + + cctx_destroy (first); + } + ++cctx_idle; - stack->next = stack_first; - stack_first = stack; + cctx->next = cctx_first; + cctx_first = cctx; +} + +/** coroutine switching *****************************************************/ + +static void +transfer_check (pTHX_ struct coro *prev, struct coro *next) +{ + if (expect_true (prev != next)) + { + if (expect_false (!(prev->flags & (CF_RUNNING | CF_NEW)))) + croak ("Coro::State::transfer called with non-running/new prev Coro::State, but can only transfer from running or new states"); + + if (expect_false (next->flags & CF_RUNNING)) + croak ("Coro::State::transfer called with running next Coro::State, but can only transfer to inactive states"); + + if (expect_false (next->flags & CF_DESTROYED)) + croak ("Coro::State::transfer called with destroyed next Coro::State, but can only transfer to inactive states"); + + if ( +#if PERL_VERSION_ATLEAST (5,9,0) + expect_false (PL_parser && PL_parser->lex_state != LEX_NOTPARSING) +#else + expect_false (PL_lex_state != LEX_NOTPARSING) +#endif + ) + croak ("Coro::State::transfer called while parsing, but this is not supported"); + } } -/* never call directly, always through the coro_state_transfer global variable */ +/* always use the TRANSFER macro */ static void NOINLINE -transfer (struct coro *prev, struct coro *next, int flags) +transfer (pTHX_ struct coro *prev, struct coro *next, int force_cctx) { dSTACKLEVEL; + static volatile int has_throw; /* sometimes transfer is only called to set idle_sp */ - if (flags == TRANSFER_SET_STACKLEVEL) - ((coro_stack *)prev)->idle_sp = STACKLEVEL; - else if (prev != next) + if (expect_false (!next)) { - coro_stack *prev__stack; - - LOCK; + ((coro_cctx *)prev)->idle_sp = STACKLEVEL; + assert (((coro_cctx *)prev)->idle_te = PL_top_env); /* just for the side-effect when asserts are enabled */ + } + else if (expect_true (prev != next)) + { + coro_cctx *prev__cctx; - if (next->mainstack) + if (expect_false (prev->flags & CF_NEW)) { - /* coroutine already started */ - SAVE (prev, flags); - LOAD (next); + /* create a new empty context */ + Newz (0, prev->cctx, 1, coro_cctx); + prev->flags &= ~CF_NEW; + prev->flags |= CF_RUNNING; } - else + + prev->flags &= ~CF_RUNNING; + next->flags |= CF_RUNNING; + + LOCK; + + /* first get rid of the old state */ + save_perl (aTHX_ prev); + + if (expect_false (next->flags & CF_NEW)) { /* need to start coroutine */ - /* first get rid of the old state */ - SAVE (prev, -1); + next->flags &= ~CF_NEW; /* setup coroutine call */ - setup_coro (next); - /* need a stack */ - next->stack = 0; + coro_setup (aTHX_ next); } + else + load_perl (aTHX_ next); - if (!prev->stack) - /* create a new empty context */ - Newz (0, prev->stack, 1, coro_stack); - - prev__stack = prev->stack; + prev__cctx = prev->cctx; - /* possibly "free" the stack */ - if (prev__stack->idle_sp == STACKLEVEL) + /* possibly "free" the cctx */ + if (expect_true ( + prev__cctx->idle_sp == STACKLEVEL + && !(prev__cctx->flags & CC_TRACE) + && !force_cctx + )) { - stack_put (prev__stack); - prev->stack = 0; + /* I assume that STACKLEVEL is a stronger indicator than PL_top_env changes */ + assert (("ERROR: current top_env must equal previous top_env", PL_top_env == prev__cctx->idle_te)); + + prev->cctx = 0; + + /* if the cctx is about to be destroyed we need to make sure we won't see it in cctx_get */ + /* without this the next cctx_get might destroy the prev__cctx while still in use */ + if (expect_false (CCTX_EXPIRED (prev__cctx))) + if (!next->cctx) + next->cctx = cctx_get (aTHX); + + cctx_put (prev__cctx); } - if (!next->stack) - next->stack = stack_get (); + ++next->usecount; + + if (expect_true (!next->cctx)) + next->cctx = cctx_get (aTHX); + + has_throw = !!next->throw; - if (prev__stack != next->stack) + if (expect_false (prev__cctx != next->cctx)) { - prev__stack->top_env = PL_top_env; - PL_top_env = next->stack->top_env; - coro_transfer (&prev__stack->cctx, &next->stack->cctx); + prev__cctx->top_env = PL_top_env; + PL_top_env = next->cctx->top_env; + coro_transfer (&prev__cctx->cctx, &next->cctx->cctx); } - free_coro_mortal (); - + free_coro_mortal (aTHX); UNLOCK; + + if (expect_false (has_throw)) + { + struct coro *coro = SvSTATE (coro_current); + + if (coro->throw) + { + SV *exception = coro->throw; + coro->throw = 0; + sv_setsv (ERRSV, exception); + croak (0); + } + } } } struct transfer_args { struct coro *prev, *next; - int flags; }; -#define TRANSFER(ta) transfer ((ta).prev, (ta).next, (ta).flags) +#define TRANSFER(ta, force_cctx) transfer (aTHX_ (ta).prev, (ta).next, (force_cctx)) +#define TRANSFER_CHECK(ta) transfer_check (aTHX_ (ta).prev, (ta).next) -static void -coro_state_destroy (struct coro *coro) +/** high level stuff ********************************************************/ + +static int +coro_state_destroy (pTHX_ struct coro *coro) { - if (coro->refcnt--) - return; + if (coro->flags & CF_DESTROYED) + return 0; + + coro->flags |= CF_DESTROYED; + + if (coro->flags & CF_READY) + { + /* reduce nready, as destroying a ready coro effectively unreadies it */ + /* alternative: look through all ready queues and remove the coro */ + LOCK; + --coro_nready; + UNLOCK; + } + else + coro->flags |= CF_READY; /* make sure it is NOT put into the readyqueue */ if (coro->mainstack && coro->mainstack != main_mainstack) { struct coro temp; - SAVE ((&temp), TRANSFER_SAVE_ALL); - LOAD (coro); + if (coro->flags & CF_RUNNING) + croak ("FATAL: tried to destroy currently running coroutine"); + + save_perl (aTHX_ &temp); + load_perl (aTHX_ coro); - coro_destroy_stacks (); + coro_destroy (aTHX_ coro); - LOAD ((&temp)); /* this will get rid of defsv etc.. */ + load_perl (aTHX_ &temp); - coro->mainstack = 0; + coro->slot = 0; } - stack_free (coro->stack); + cctx_destroy (coro->cctx); SvREFCNT_dec (coro->args); - Safefree (coro); + + if (coro->next) coro->next->prev = coro->prev; + if (coro->prev) coro->prev->next = coro->next; + if (coro == coro_first) coro_first = coro->next; + + return 1; } static int -coro_state_clear (pTHX_ SV *sv, MAGIC *mg) +coro_state_free (pTHX_ SV *sv, MAGIC *mg) { struct coro *coro = (struct coro *)mg->mg_ptr; mg->mg_ptr = 0; - coro_state_destroy (coro); + coro->hv = 0; + + if (--coro->refcnt < 0) + { + coro_state_destroy (aTHX_ coro); + Safefree (coro); + } return 0; } @@ -832,7 +1322,7 @@ static MGVTBL coro_state_vtbl = { 0, 0, 0, 0, - coro_state_clear, + coro_state_free, 0, #ifdef MGf_DUP coro_state_dup, @@ -841,159 +1331,153 @@ #endif }; -static struct coro * -SvSTATE (SV *coro) -{ - HV *stash; - MAGIC *mg; - - if (SvROK (coro)) - coro = SvRV (coro); - - stash = SvSTASH (coro); - if (stash != coro_stash && stash != coro_state_stash) - { - /* very slow, but rare, check */ - if (!sv_derived_from (sv_2mortal (newRV_inc (coro)), "Coro::State")) - croak ("Coro::State object required"); - } - - mg = SvMAGIC (coro); - assert (mg->mg_type == PERL_MAGIC_ext); - return (struct coro *)mg->mg_ptr; -} - static void -prepare_transfer (struct transfer_args *ta, SV *prev, SV *next, int flags) +prepare_transfer (pTHX_ struct transfer_args *ta, SV *prev_sv, SV *next_sv) { - ta->prev = SvSTATE (prev); - ta->next = SvSTATE (next); - ta->flags = flags; + ta->prev = SvSTATE (prev_sv); + ta->next = SvSTATE (next_sv); + TRANSFER_CHECK (*ta); } static void -api_transfer (SV *prev, SV *next, int flags) +api_transfer (SV *prev_sv, SV *next_sv) { dTHX; struct transfer_args ta; - prepare_transfer (&ta, prev, next, flags); - TRANSFER (ta); + prepare_transfer (aTHX_ &ta, prev_sv, next_sv); + TRANSFER (ta, 1); } /** Coro ********************************************************************/ -#define PRIO_MAX 3 -#define PRIO_HIGH 1 -#define PRIO_NORMAL 0 -#define PRIO_LOW -1 -#define PRIO_IDLE -3 -#define PRIO_MIN -4 - -/* for Coro.pm */ -static GV *coro_current, *coro_idle; -static AV *coro_ready [PRIO_MAX-PRIO_MIN+1]; -static int coro_nready; - static void -coro_enq (SV *sv) +coro_enq (pTHX_ SV *coro_sv) { - int prio; - - if (SvTYPE (sv) != SVt_PVHV) - croak ("Coro::ready tried to enqueue something that is not a coroutine"); - - prio = SvSTATE (sv)->prio; - - av_push (coro_ready [prio - PRIO_MIN], sv); - coro_nready++; + av_push (coro_ready [SvSTATE (coro_sv)->prio - PRIO_MIN], coro_sv); } static SV * -coro_deq (int min_prio) +coro_deq (pTHX) { - int prio = PRIO_MAX - PRIO_MIN; - - min_prio -= PRIO_MIN; - if (min_prio < 0) - min_prio = 0; + int prio; - for (prio = PRIO_MAX - PRIO_MIN + 1; --prio >= min_prio; ) + for (prio = PRIO_MAX - PRIO_MIN + 1; --prio >= 0; ) if (AvFILLp (coro_ready [prio]) >= 0) - { - coro_nready--; - return av_shift (coro_ready [prio]); - } + return av_shift (coro_ready [prio]); return 0; } -static void -api_ready (SV *coro) +static int +api_ready (SV *coro_sv) { dTHX; + struct coro *coro; - if (SvROK (coro)) - coro = SvRV (coro); + if (SvROK (coro_sv)) + coro_sv = SvRV (coro_sv); + + coro = SvSTATE (coro_sv); + + if (coro->flags & CF_READY) + return 0; + + coro->flags |= CF_READY; LOCK; - coro_enq (SvREFCNT_inc (coro)); + coro_enq (aTHX_ SvREFCNT_inc (coro_sv)); + ++coro_nready; UNLOCK; + + return 1; } -static void -prepare_schedule (struct transfer_args *ta) +static int +api_is_ready (SV *coro_sv) { - SV *current, *prev, *next; + dTHX; + return !!(SvSTATE (coro_sv)->flags & CF_READY); +} - current = GvSV (coro_current); +static void +prepare_schedule (pTHX_ struct transfer_args *ta) +{ + SV *prev_sv, *next_sv; for (;;) { LOCK; - next = coro_deq (PRIO_MIN); - UNLOCK; + next_sv = coro_deq (aTHX); - if (next) - break; + /* nothing to schedule: call the idle handler */ + if (expect_false (!next_sv)) + { + dSP; + UNLOCK; - { - dSP; + ENTER; + SAVETMPS; - ENTER; - SAVETMPS; + PUSHMARK (SP); + PUTBACK; + call_sv (get_sv ("Coro::idle", FALSE), G_DISCARD); + SPAGAIN; + + FREETMPS; + LEAVE; + continue; + } - PUSHMARK (SP); - PUTBACK; - call_sv (GvSV (coro_idle), G_DISCARD); + ta->next = SvSTATE (next_sv); - FREETMPS; - LEAVE; - } - } + /* cannot transfer to destroyed coros, skip and look for next */ + if (expect_false (ta->next->flags & CF_DESTROYED)) + { + UNLOCK; + SvREFCNT_dec (next_sv); + /* coro_nready is already taken care of by destroy */ + continue; + } - prev = SvRV (current); - SvRV (current) = next; + --coro_nready; + UNLOCK; + break; + } /* free this only after the transfer */ + prev_sv = SvRV (coro_current); + ta->prev = SvSTATE (prev_sv); + TRANSFER_CHECK (*ta); + assert (ta->next->flags & CF_READY); + ta->next->flags &= ~CF_READY; + SvRV_set (coro_current, next_sv); + LOCK; - free_coro_mortal (); + free_coro_mortal (aTHX); + coro_mortal = prev_sv; UNLOCK; - coro_mortal = prev; - - ta->prev = SvSTATE (prev); - ta->next = SvSTATE (next); - ta->flags = TRANSFER_SAVE_ALL; } static void -prepare_cede (struct transfer_args *ta) +prepare_cede (pTHX_ struct transfer_args *ta) { - LOCK; - coro_enq (SvREFCNT_inc (SvRV (GvSV (coro_current)))); - UNLOCK; + api_ready (coro_current); + prepare_schedule (aTHX_ ta); +} - prepare_schedule (ta); +static int +prepare_cede_notself (pTHX_ struct transfer_args *ta) +{ + if (coro_nready) + { + SV *prev = SvRV (coro_current); + prepare_schedule (aTHX_ ta); + api_ready (prev); + return 1; + } + else + return 0; } static void @@ -1002,21 +1486,69 @@ dTHX; struct transfer_args ta; - prepare_schedule (&ta); - TRANSFER (ta); + prepare_schedule (aTHX_ &ta); + TRANSFER (ta, 1); } -static void +static int api_cede (void) { dTHX; struct transfer_args ta; - prepare_cede (&ta); - TRANSFER (ta); + prepare_cede (aTHX_ &ta); + + if (expect_true (ta.prev != ta.next)) + { + TRANSFER (ta, 1); + return 1; + } + else + return 0; +} + +static int +api_cede_notself (void) +{ + dTHX; + struct transfer_args ta; + + if (prepare_cede_notself (aTHX_ &ta)) + { + TRANSFER (ta, 1); + return 1; + } + else + return 0; +} + +static void +api_trace (SV *coro_sv, int flags) +{ + dTHX; + struct coro *coro = SvSTATE (coro_sv); + + if (flags & CC_TRACE) + { + if (!coro->cctx) + coro->cctx = cctx_new (); + else if (!(coro->cctx->flags & CC_TRACE)) + croak ("cannot enable tracing on coroutine with custom stack"); + + coro->cctx->flags |= CC_NOREUSE | (flags & (CC_TRACE | CC_TRACE_ALL)); + } + else if (coro->cctx && coro->cctx->flags & CC_TRACE) + { + coro->cctx->flags &= ~(CC_TRACE | CC_TRACE_ALL); + + if (coro->flags & CF_RUNNING) + PL_runops = RUNOPS_DEFAULT; + else + coro->slot->runops = RUNOPS_DEFAULT; + } } -MODULE = Coro::State PACKAGE = Coro::State +MODULE = Coro::State PACKAGE = Coro::State PREFIX = api_ PROTOTYPES: DISABLE @@ -1027,15 +1559,33 @@ #endif BOOT_PAGESIZE; + irsgv = gv_fetchpv ("/" , GV_ADD|GV_NOTQUAL, SVt_PV); + stdoutgv = gv_fetchpv ("STDOUT", GV_ADD|GV_NOTQUAL, SVt_PVIO); + + orig_sigelem_get = PL_vtbl_sigelem.svt_get; + PL_vtbl_sigelem.svt_get = coro_sigelem_get; + orig_sigelem_set = PL_vtbl_sigelem.svt_set; + PL_vtbl_sigelem.svt_set = coro_sigelem_set; + + hv_sig = coro_get_hv (aTHX_ "SIG", TRUE); + rv_diehook = newRV_inc ((SV *)gv_fetchpv ("Coro::State::diehook" , 0, SVt_PVCV)); + rv_warnhook = newRV_inc ((SV *)gv_fetchpv ("Coro::State::warnhook", 0, SVt_PVCV)); + coro_state_stash = gv_stashpv ("Coro::State", TRUE); - newCONSTSUB (coro_state_stash, "SAVE_DEFAV", newSViv (TRANSFER_SAVE_DEFAV)); - newCONSTSUB (coro_state_stash, "SAVE_DEFSV", newSViv (TRANSFER_SAVE_DEFSV)); - newCONSTSUB (coro_state_stash, "SAVE_ERRSV", newSViv (TRANSFER_SAVE_ERRSV)); + newCONSTSUB (coro_state_stash, "CC_TRACE" , newSViv (CC_TRACE)); + newCONSTSUB (coro_state_stash, "CC_TRACE_SUB" , newSViv (CC_TRACE_SUB)); + newCONSTSUB (coro_state_stash, "CC_TRACE_LINE", newSViv (CC_TRACE_LINE)); + newCONSTSUB (coro_state_stash, "CC_TRACE_ALL" , newSViv (CC_TRACE_ALL)); main_mainstack = PL_mainstack; + main_top_env = PL_top_env; + + while (main_top_env->je_prev) + main_top_env = main_top_env->je_prev; coroapi.ver = CORO_API_VERSION; + coroapi.rev = CORO_API_REVISION; coroapi.transfer = api_transfer; assert (("PRIO_NORMAL must be 0", !PRIO_NORMAL)); @@ -1046,108 +1596,226 @@ CODE: { struct coro *coro; + MAGIC *mg; HV *hv; int i; Newz (0, coro, 1, struct coro); - coro->args = newAV (); + coro->args = newAV (); + coro->flags = CF_NEW; - hv = newHV (); - sv_magicext ((SV *)hv, 0, PERL_MAGIC_ext, &coro_state_vtbl, (char *)coro, 0)->mg_flags |= MGf_DUP; + if (coro_first) coro_first->prev = coro; + coro->next = coro_first; + coro_first = coro; + + coro->hv = hv = newHV (); + mg = sv_magicext ((SV *)hv, 0, CORO_MAGIC_type_state, &coro_state_vtbl, (char *)coro, 0); + mg->mg_flags |= MGf_DUP; RETVAL = sv_bless (newRV_noinc ((SV *)hv), gv_stashpv (klass, 1)); + av_extend (coro->args, items - 1); for (i = 1; i < items; i++) av_push (coro->args, newSVsv (ST (i))); - - /*coro->mainstack = 0; *//*actual work is done inside transfer */ - /*coro->stack = 0;*/ } OUTPUT: RETVAL +# these not obviously related functions are all rolled into the same xs +# function to increase chances that they all will call transfer with the same +# stack offset void _set_stacklevel (...) ALIAS: Coro::State::transfer = 1 Coro::schedule = 2 Coro::cede = 3 - Coro::Cont::yield = 4 + Coro::cede_notself = 4 CODE: { struct transfer_args ta; + PUTBACK; switch (ix) { case 0: - ta.prev = (struct coro *)INT2PTR (coro_stack *, SvIV (ST (0))); + ta.prev = (struct coro *)INT2PTR (coro_cctx *, SvIV (ST (0))); ta.next = 0; - ta.flags = TRANSFER_SET_STACKLEVEL; break; case 1: - if (items != 3) - croak ("Coro::State::transfer(prev,next,flags) expects three arguments, not %d", items); + if (items != 2) + croak ("Coro::State::transfer (prev,next) expects two arguments, not %d", items); - prepare_transfer (&ta, ST (0), ST (1), SvIV (ST (2))); + prepare_transfer (aTHX_ &ta, ST (0), ST (1)); break; case 2: - prepare_schedule (&ta); + prepare_schedule (aTHX_ &ta); break; case 3: - prepare_cede (&ta); + prepare_cede (aTHX_ &ta); break; case 4: - { - SV *yieldstack; - SV *sv; - AV *defav = GvAV (PL_defgv); - - yieldstack = *hv_fetch ( - (HV *)SvRV (GvSV (coro_current)), - "yieldstack", sizeof ("yieldstack") - 1, - 0 - ); - - /* set up @_ -- ugly */ - av_clear (defav); - av_fill (defav, items - 1); - while (items--) - av_store (defav, items, SvREFCNT_inc (ST(items))); - - sv = av_pop ((AV *)SvRV (yieldstack)); - ta.prev = SvSTATE (*av_fetch ((AV *)SvRV (sv), 0, 0)); - ta.next = SvSTATE (*av_fetch ((AV *)SvRV (sv), 1, 0)); - ta.flags = 0; - SvREFCNT_dec (sv); - } - break; + if (!prepare_cede_notself (aTHX_ &ta)) + XSRETURN_EMPTY; + break; } + SPAGAIN; - TRANSFER (ta); + BARRIER; + PUTBACK; + TRANSFER (ta, 0); + SPAGAIN; /* might be the sp of a different coroutine now */ + /* be extra careful not to ever do anything after TRANSFER */ } +bool +_destroy (SV *coro_sv) + CODE: + RETVAL = coro_state_destroy (aTHX_ SvSTATE (coro_sv)); + OUTPUT: + RETVAL + void -_clone_state_from (SV *dst, SV *src) +_exit (code) + int code + PROTOTYPE: $ + CODE: + _exit (code); + +int +cctx_stacksize (int new_stacksize = 0) CODE: + RETVAL = coro_stacksize; + if (new_stacksize) + coro_stacksize = new_stacksize; + OUTPUT: + RETVAL + +int +cctx_count () + CODE: + RETVAL = cctx_count; + OUTPUT: + RETVAL + +int +cctx_idle () + CODE: + RETVAL = cctx_idle; + OUTPUT: + RETVAL + +void +list () + PPCODE: { - struct coro *coro_src = SvSTATE (src); + struct coro *coro; + for (coro = coro_first; coro; coro = coro->next) + if (coro->hv) + XPUSHs (sv_2mortal (newRV_inc ((SV *)coro->hv))); +} - sv_unmagic (SvRV (dst), PERL_MAGIC_ext); +void +call (Coro::State coro, SV *coderef) + ALIAS: + eval = 1 + CODE: +{ + if (coro->mainstack) + { + struct coro temp; + + if (!(coro->flags & CF_RUNNING)) + { + PUTBACK; + save_perl (aTHX_ &temp); + load_perl (aTHX_ coro); + } - ++coro_src->refcnt; - sv_magicext (SvRV (dst), 0, PERL_MAGIC_ext, &coro_state_vtbl, (char *)coro_src, 0)->mg_flags |= MGf_DUP; + { + dSP; + ENTER; + SAVETMPS; + PUTBACK; + PUSHSTACK; + PUSHMARK (SP); + + if (ix) + eval_sv (coderef, 0); + else + call_sv (coderef, G_KEEPERR | G_EVAL | G_VOID | G_DISCARD); + + POPSTACK; + SPAGAIN; + FREETMPS; + LEAVE; + PUTBACK; + } + + if (!(coro->flags & CF_RUNNING)) + { + save_perl (aTHX_ coro); + load_perl (aTHX_ &temp); + SPAGAIN; + } + } } +SV * +is_ready (Coro::State coro) + PROTOTYPE: $ + ALIAS: + is_ready = CF_READY + is_running = CF_RUNNING + is_new = CF_NEW + is_destroyed = CF_DESTROYED + CODE: + RETVAL = boolSV (coro->flags & ix); + OUTPUT: + RETVAL + void -_exit (code) - int code +api_trace (SV *coro, int flags = CC_TRACE | CC_TRACE_SUB) + +SV * +has_stack (Coro::State coro) PROTOTYPE: $ CODE: - _exit (code); + RETVAL = boolSV (!!coro->cctx); + OUTPUT: + RETVAL + +int +is_traced (Coro::State coro) + PROTOTYPE: $ + CODE: + RETVAL = (coro->cctx ? coro->cctx->flags : 0) & CC_TRACE_ALL; + OUTPUT: + RETVAL + +IV +rss (Coro::State coro) + PROTOTYPE: $ + ALIAS: + usecount = 1 + CODE: + switch (ix) + { + case 0: RETVAL = coro_rss (aTHX_ coro); break; + case 1: RETVAL = coro->usecount; break; + } + OUTPUT: + RETVAL + +void +force_cctx () + CODE: + struct coro *coro = SvSTATE (coro_current); + coro->cctx->idle_sp = 0; MODULE = Coro::State PACKAGE = Coro @@ -1155,7 +1823,14 @@ { int i; - coro_stash = gv_stashpv ("Coro", TRUE); + sv_pool_rss = coro_get_sv (aTHX_ "Coro::POOL_RSS" , TRUE); + sv_pool_size = coro_get_sv (aTHX_ "Coro::POOL_SIZE" , TRUE); + av_async_pool = coro_get_av (aTHX_ "Coro::async_pool", TRUE); + + coro_current = coro_get_sv (aTHX_ "Coro::current", FALSE); + SvREADONLY_on (coro_current); + + coro_stash = gv_stashpv ("Coro", TRUE); newCONSTSUB (coro_stash, "PRIO_MAX", newSViv (PRIO_MAX)); newCONSTSUB (coro_stash, "PRIO_HIGH", newSViv (PRIO_HIGH)); @@ -1164,20 +1839,20 @@ newCONSTSUB (coro_stash, "PRIO_IDLE", newSViv (PRIO_IDLE)); newCONSTSUB (coro_stash, "PRIO_MIN", newSViv (PRIO_MIN)); - coro_current = gv_fetchpv ("Coro::current", TRUE, SVt_PV); - coro_idle = gv_fetchpv ("Coro::idle" , TRUE, SVt_PV); - for (i = PRIO_MAX - PRIO_MIN + 1; i--; ) coro_ready[i] = newAV (); { - SV *sv = perl_get_sv("Coro::API", 1); + SV *sv = perl_get_sv ("Coro::API", TRUE); + perl_get_sv ("Coro::API", TRUE); /* silence 5.10 warning */ - coroapi.schedule = api_schedule; - coroapi.cede = api_cede; - coroapi.ready = api_ready; - coroapi.nready = &coro_nready; - coroapi.current = coro_current; + coroapi.schedule = api_schedule; + coroapi.cede = api_cede; + coroapi.cede_notself = api_cede_notself; + coroapi.ready = api_ready; + coroapi.is_ready = api_is_ready; + coroapi.nready = &coro_nready; + coroapi.current = coro_current; GCoroAPI = &coroapi; sv_setiv (sv, (IV)&coroapi); @@ -1185,6 +1860,13 @@ } } +void +_set_current (SV *current) + PROTOTYPE: $ + CODE: + SvREFCNT_dec (SvRV (coro_current)); + SvRV_set (coro_current, SvREFCNT_inc (SvRV (current))); + int prio (Coro::State coro, int newprio = 0) ALIAS: @@ -1196,7 +1878,7 @@ if (items > 1) { if (ix) - newprio += coro->prio; + newprio = coro->prio - newprio; if (newprio < PRIO_MIN) newprio = PRIO_MIN; if (newprio > PRIO_MAX) newprio = PRIO_MAX; @@ -1204,12 +1886,16 @@ coro->prio = newprio; } } + OUTPUT: + RETVAL -void +SV * ready (SV *self) PROTOTYPE: $ CODE: - api_ready (self); + RETVAL = boolSV (api_ready (self)); + OUTPUT: + RETVAL int nready (...) @@ -1219,25 +1905,116 @@ OUTPUT: RETVAL +void +throw (Coro::State self, SV *throw = &PL_sv_undef) + PROTOTYPE: $;$ + CODE: + SvREFCNT_dec (self->throw); + self->throw = SvOK (throw) ? newSVsv (throw) : 0; + +void +swap_defsv (Coro::State self) + PROTOTYPE: $ + ALIAS: + swap_defav = 1 + CODE: + if (!self->slot) + croak ("cannot swap state with coroutine that has no saved state"); + else + { + SV **src = ix ? (SV **)&GvAV (PL_defgv) : &GvSV (PL_defgv); + SV **dst = ix ? (SV **)&self->slot->defav : (SV **)&self->slot->defsv; + + SV *tmp = *src; *src = *dst; *dst = tmp; + } + +# for async_pool speedup +void +_pool_1 (SV *cb) + CODE: +{ + struct coro *coro = SvSTATE (coro_current); + HV *hv = (HV *)SvRV (coro_current); + AV *defav = GvAV (PL_defgv); + SV *invoke = hv_delete (hv, "_invoke", sizeof ("_invoke") - 1, 0); + AV *invoke_av; + int i, len; + + if (!invoke) + { + SvREFCNT_dec (PL_diehook); PL_diehook = 0; + croak ("\3async_pool terminate\2\n"); + } + + SvREFCNT_dec (coro->saved_deffh); + coro->saved_deffh = SvREFCNT_inc ((SV *)PL_defoutgv); + + hv_store (hv, "desc", sizeof ("desc") - 1, + newSVpvn ("[async_pool]", sizeof ("[async_pool]") - 1), 0); + + invoke_av = (AV *)SvRV (invoke); + len = av_len (invoke_av); + + sv_setsv (cb, AvARRAY (invoke_av)[0]); + + if (len > 0) + { + av_fill (defav, len - 1); + for (i = 0; i < len; ++i) + av_store (defav, i, SvREFCNT_inc (AvARRAY (invoke_av)[i + 1])); + } + + SvREFCNT_dec (invoke); +} + +void +_pool_2 (SV *cb) + CODE: +{ + struct coro *coro = SvSTATE (coro_current); + + sv_setsv (cb, &PL_sv_undef); + + SvREFCNT_dec ((SV *)PL_defoutgv); PL_defoutgv = (GV *)coro->saved_deffh; + coro->saved_deffh = 0; + + if (coro_rss (aTHX_ coro) > SvIV (sv_pool_rss) + || av_len (av_async_pool) + 1 >= SvIV (sv_pool_size)) + { + SvREFCNT_dec (PL_diehook); PL_diehook = 0; + croak ("\3async_pool terminate\2\n"); + } + + av_clear (GvAV (PL_defgv)); + hv_store ((HV *)SvRV (coro_current), "desc", sizeof ("desc") - 1, + newSVpvn ("[async_pool idle]", sizeof ("[async_pool idle]") - 1), 0); + + coro->prio = 0; + + if (coro->cctx && (coro->cctx->flags & CC_TRACE)) + api_trace (coro_current, 0); + + av_push (av_async_pool, newSVsv (coro_current)); +} + + MODULE = Coro::State PACKAGE = Coro::AIO SV * _get_state () CODE: { - struct { - int errorno; - int laststype; - int laststatval; - Stat_t statcache; - } data; - - data.errorno = errno; - data.laststype = PL_laststype; - data.laststatval = PL_laststatval; - data.statcache = PL_statcache; + struct io_state *data; - RETVAL = newSVpvn ((char *)&data, sizeof data); + RETVAL = newSV (sizeof (struct io_state)); + data = (struct io_state *)SvPVX (RETVAL); + SvCUR_set (RETVAL, sizeof (struct io_state)); + SvPOK_only (RETVAL); + + data->errorno = errno; + data->laststype = PL_laststype; + data->laststatval = PL_laststatval; + data->statcache = PL_statcache; } OUTPUT: RETVAL @@ -1247,15 +2024,11 @@ PROTOTYPE: $ CODE: { - struct { - int errorno; - int laststype; - int laststatval; - Stat_t statcache; - } *data = (void *)data_; + struct io_state *data = (void *)data_; - errno = data->errorno; - PL_laststype = data->laststype; + errno = data->errorno; + PL_laststype = data->laststype; PL_laststatval = data->laststatval; - PL_statcache = data->statcache; + PL_statcache = data->statcache; } +