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.383 by root, Sun Feb 13 04:39:16 2011 UTC vs.
Revision 1.396 by root, Fri May 6 18:01:13 2011 UTC

21 21
22#ifndef SVs_PADSTALE 22#ifndef SVs_PADSTALE
23# define SVs_PADSTALE 0 23# define SVs_PADSTALE 0
24#endif 24#endif
25 25
26#ifdef WIN32 26#if defined(_WIN32)
27# undef HAS_GETTIMEOFDAY
27# undef setjmp 28# undef setjmp
28# undef longjmp 29# undef longjmp
29# undef _exit 30# undef _exit
30# define setjmp _setjmp /* deep magic */ 31# define setjmp _setjmp /* deep magic */
31#else 32#else
195 int valgrind_id; 196 int valgrind_id;
196#endif 197#endif
197 unsigned char flags; 198 unsigned char flags;
198} coro_cctx; 199} coro_cctx;
199 200
200coro_cctx *cctx_current; /* the currently running cctx */ 201static coro_cctx *cctx_current; /* the currently running cctx */
201 202
202/*****************************************************************************/ 203/*****************************************************************************/
203 204
204enum { 205enum {
205 CF_RUNNING = 0x0001, /* coroutine is running */ 206 CF_RUNNING = 0x0001, /* coroutine is running */
206 CF_READY = 0x0002, /* coroutine is ready */ 207 CF_READY = 0x0002, /* coroutine is ready */
207 CF_NEW = 0x0004, /* has never been switched to */ 208 CF_NEW = 0x0004, /* has never been switched to */
208 CF_DESTROYED = 0x0008, /* coroutine data has been freed */ 209 CF_DESTROYED = 0x0008, /* coroutine data has been freed */
209 CF_SUSPENDED = 0x0010, /* coroutine can't be scheduled */ 210 CF_SUSPENDED = 0x0010, /* coroutine can't be scheduled */
211 CF_NOCANCEL = 0x0020, /* cannot cancel, set slf_frame.data to 1 (hackish) */
210}; 212};
211 213
212/* the structure where most of the perl state is stored, overlaid on the cxstack */ 214/* the structure where most of the perl state is stored, overlaid on the cxstack */
213typedef struct 215typedef struct
214{ 216{
240 CV *startcv; /* the CV to execute */ 242 CV *startcv; /* the CV to execute */
241 AV *args; /* data associated with this coroutine (initial args) */ 243 AV *args; /* data associated with this coroutine (initial args) */
242 int refcnt; /* coroutines are refcounted, yes */ 244 int refcnt; /* coroutines are refcounted, yes */
243 int flags; /* CF_ flags */ 245 int flags; /* CF_ flags */
244 HV *hv; /* the perl hash associated with this coro, if any */ 246 HV *hv; /* the perl hash associated with this coro, if any */
245 void (*on_destroy)(pTHX_ struct coro *coro); 247 void (*on_destroy)(pTHX_ struct coro *coro); /* for temporary use by xs in critical sections */
246 248
247 /* statistics */ 249 /* statistics */
248 int usecount; /* number of transfers to this coro */ 250 int usecount; /* number of transfers to this coro */
249 251
250 /* coro process data */ 252 /* coro process data */
274typedef struct coro *Coro__State; 276typedef struct coro *Coro__State;
275typedef struct coro *Coro__State_or_hashref; 277typedef struct coro *Coro__State_or_hashref;
276 278
277/* the following variables are effectively part of the perl context */ 279/* the following variables are effectively part of the perl context */
278/* and get copied between struct coro and these variables */ 280/* and get copied between struct coro and these variables */
279/* the mainr easonw e don't support windows process emulation */ 281/* the main reason we don't support windows process emulation */
280static struct CoroSLF slf_frame; /* the current slf frame */ 282static struct CoroSLF slf_frame; /* the current slf frame */
281 283
282/** Coro ********************************************************************/ 284/** Coro ********************************************************************/
283 285
284#define CORO_PRIO_MAX 3 286#define CORO_PRIO_MAX 3
313 /* entersub is an UNOP, select a LISTOP... keep your fingers crossed */ 315 /* entersub is an UNOP, select a LISTOP... keep your fingers crossed */
314 PL_op->op_flags |= OPf_STACKED; 316 PL_op->op_flags |= OPf_STACKED;
315 PL_op->op_private = 0; 317 PL_op->op_private = 0;
316 return PL_ppaddr [OP_ENTERSUB](aTHX); 318 return PL_ppaddr [OP_ENTERSUB](aTHX);
317} 319}
320
321/** time stuff **************************************************************/
322
323#ifdef HAS_GETTIMEOFDAY
324
325static void
326coro_u2time (pTHX_ UV ret[2])
327{
328 struct timeval tv;
329 gettimeofday (&tv, 0);
330
331 ret [0] = tv.tv_sec;
332 ret [1] = tv.tv_usec;
333}
334
335static double
336coro_nvtime ()
337{
338 struct timeval tv;
339 gettimeofday (&tv, 0);
340
341 return tv.tv_sec + tv.tv_usec * 1e-6;
342}
343
344static void
345time_init (pTHX)
346{
347 nvtime = coro_nvtime;
348 u2time = coro_u2time;
349}
350
351#else
352
353static void
354time_init (pTHX)
355{
356 SV **svp;
357
358 require_pv ("Time/HiRes.pm");
359
360 svp = hv_fetch (PL_modglobal, "Time::NVtime", 12, 0);
361
362 if (!svp) croak ("Time::HiRes is required, but missing. Caught");
363 if (!SvIOK (*svp)) croak ("Time::NVtime isn't a function pointer. Caught");
364
365 nvtime = INT2PTR (double (*)(), SvIV (*svp));
366
367 svp = hv_fetch (PL_modglobal, "Time::U2time", 12, 0);
368 u2time = INT2PTR (void (*)(pTHX_ UV ret[2]), SvIV (*svp));
369}
370
371#endif
318 372
319/** lowlevel stuff **********************************************************/ 373/** lowlevel stuff **********************************************************/
320 374
321static SV * 375static SV *
322coro_get_sv (pTHX_ const char *name, int create) 376coro_get_sv (pTHX_ const char *name, int create)
586 SvFLAGS (a) = (SvFLAGS (a) & keep) | (SvFLAGS (b ) & ~keep); 640 SvFLAGS (a) = (SvFLAGS (a) & keep) | (SvFLAGS (b ) & ~keep);
587 SvFLAGS (b) = (SvFLAGS (b) & keep) | (SvFLAGS (&tmp) & ~keep); 641 SvFLAGS (b) = (SvFLAGS (b) & keep) | (SvFLAGS (&tmp) & ~keep);
588 642
589#if PERL_VERSION_ATLEAST (5,10,0) 643#if PERL_VERSION_ATLEAST (5,10,0)
590 /* perl 5.10 complicates this _quite_ a bit, but it also is 644 /* perl 5.10 complicates this _quite_ a bit, but it also is
591 * is much faster, so no quarrels here. alternatively, we could 645 * much faster, so no quarrels here. alternatively, we could
592 * sv_upgrade to avoid this. 646 * sv_upgrade to avoid this.
593 */ 647 */
594 { 648 {
595 /* swap sv_u */ 649 /* swap sv_u */
596 tmp.sv_u = a->sv_u; a->sv_u = b->sv_u; b->sv_u = tmp.sv_u; 650 tmp.sv_u = a->sv_u; a->sv_u = b->sv_u; b->sv_u = tmp.sv_u;
1105 struct coro *current = SvSTATE_current; 1159 struct coro *current = SvSTATE_current;
1106 1160
1107 assert (("FATAL: tried to destroy currently running coroutine", coro->mainstack != PL_mainstack)); 1161 assert (("FATAL: tried to destroy currently running coroutine", coro->mainstack != PL_mainstack));
1108 1162
1109 save_perl (aTHX_ current); 1163 save_perl (aTHX_ current);
1164 SvRV_set (coro_current, (SV *)coro->hv); /* this will cause acroak in transfer_check */
1110 load_perl (aTHX_ coro); 1165 load_perl (aTHX_ coro);
1111 1166
1112 coro_unwind_stacks (aTHX); 1167 coro_unwind_stacks (aTHX);
1113 coro_destruct_stacks (aTHX); 1168 coro_destruct_stacks (aTHX);
1114 1169
1125 svf [6] = (SV *)GvHV (PL_hintgv); 1180 svf [6] = (SV *)GvHV (PL_hintgv);
1126 svf [7] = PL_diehook; 1181 svf [7] = PL_diehook;
1127 svf [8] = PL_warnhook; 1182 svf [8] = PL_warnhook;
1128 assert (9 == sizeof (svf) / sizeof (*svf)); 1183 assert (9 == sizeof (svf) / sizeof (*svf));
1129 1184
1185 SvRV_set (coro_current, (SV *)current->hv);
1130 load_perl (aTHX_ current); 1186 load_perl (aTHX_ current);
1131 } 1187 }
1132 1188
1133 { 1189 {
1134 unsigned int i; 1190 unsigned int i;
1443cctx_destroy (coro_cctx *cctx) 1499cctx_destroy (coro_cctx *cctx)
1444{ 1500{
1445 if (!cctx) 1501 if (!cctx)
1446 return; 1502 return;
1447 1503
1448 assert (("FATAL: tried to destroy current cctx", cctx != cctx_current));//D temporary? 1504 assert (("FATAL: tried to destroy current cctx", cctx != cctx_current));
1449 1505
1450 --cctx_count; 1506 --cctx_count;
1451 coro_destroy (&cctx->cctx); 1507 coro_destroy (&cctx->cctx);
1452 1508
1453 /* coro_transfer creates new, empty cctx's */ 1509 /* coro_transfer creates new, empty cctx's */
1612#define TRANSFER(ta, force_cctx) transfer (aTHX_ (ta).prev, (ta).next, (force_cctx)) 1668#define TRANSFER(ta, force_cctx) transfer (aTHX_ (ta).prev, (ta).next, (force_cctx))
1613#define TRANSFER_CHECK(ta) transfer_check (aTHX_ (ta).prev, (ta).next) 1669#define TRANSFER_CHECK(ta) transfer_check (aTHX_ (ta).prev, (ta).next)
1614 1670
1615/** high level stuff ********************************************************/ 1671/** high level stuff ********************************************************/
1616 1672
1617static int 1673static void
1618coro_state_destroy (pTHX_ struct coro *coro) 1674coro_state_destroy (pTHX_ struct coro *coro)
1619{ 1675{
1620 if (coro->flags & CF_DESTROYED) 1676 if (coro->flags & CF_DESTROYED)
1621 return 0; 1677 return;
1622 1678
1679 /* this callback is reserved for slf functions needing to do cleanup */
1623 if (coro->on_destroy && !PL_dirty) 1680 if (coro->on_destroy && !PL_dirty)
1624 coro->on_destroy (aTHX_ coro); 1681 coro->on_destroy (aTHX_ coro);
1682
1683 /*
1684 * The on_destroy above most likely is from an SLF call.
1685 * Since by definition the SLF call will not finish when we destroy
1686 * the coro, we will have to force-finish it here, otherwise
1687 * cleanup functions cannot call SLF functions.
1688 */
1689 coro->slf_frame.prepare = 0;
1625 1690
1626 coro->flags |= CF_DESTROYED; 1691 coro->flags |= CF_DESTROYED;
1627 1692
1628 if (coro->flags & CF_READY) 1693 if (coro->flags & CF_READY)
1629 { 1694 {
1647 cctx_destroy (coro->cctx); 1712 cctx_destroy (coro->cctx);
1648 SvREFCNT_dec (coro->startcv); 1713 SvREFCNT_dec (coro->startcv);
1649 SvREFCNT_dec (coro->args); 1714 SvREFCNT_dec (coro->args);
1650 SvREFCNT_dec (coro->swap_sv); 1715 SvREFCNT_dec (coro->swap_sv);
1651 SvREFCNT_dec (CORO_THROW); 1716 SvREFCNT_dec (CORO_THROW);
1652
1653 return 1;
1654} 1717}
1655 1718
1656static int 1719static int
1657coro_state_free (pTHX_ SV *sv, MAGIC *mg) 1720coro_state_free (pTHX_ SV *sv, MAGIC *mg)
1658{ 1721{
1955 2018
1956static void 2019static void
1957coro_call_on_destroy (pTHX_ struct coro *coro) 2020coro_call_on_destroy (pTHX_ struct coro *coro)
1958{ 2021{
1959 SV **on_destroyp = hv_fetch (coro->hv, "_on_destroy", sizeof ("_on_destroy") - 1, 0); 2022 SV **on_destroyp = hv_fetch (coro->hv, "_on_destroy", sizeof ("_on_destroy") - 1, 0);
1960 SV **statusp = hv_fetch (coro->hv, "_status", sizeof ("_status") - 1, 0);
1961 2023
1962 if (on_destroyp) 2024 if (on_destroyp)
1963 { 2025 {
1964 AV *on_destroy = (AV *)SvRV (*on_destroyp); 2026 SV **statusp = hv_fetch (coro->hv, "_status", sizeof ("_status") - 1, 0);
2027 AV *on_destroy = sv_2mortal (SvREFCNT_inc ((AV *)SvRV (*on_destroyp)));
2028 AV *status = statusp ? sv_2mortal (SvREFCNT_inc ((AV *)SvRV (*statusp))) : 0;
1965 2029
1966 while (AvFILLp (on_destroy) >= 0) 2030 while (AvFILLp (on_destroy) >= 0)
1967 { 2031 {
1968 dSP; /* don't disturb outer sp */ 2032 dSP; /* don't disturb outer sp */
1969 SV *cb = av_pop (on_destroy); 2033 SV *cb = av_pop (on_destroy);
1971 PUSHMARK (SP); 2035 PUSHMARK (SP);
1972 2036
1973 if (statusp) 2037 if (statusp)
1974 { 2038 {
1975 int i; 2039 int i;
1976 AV *status = (AV *)SvRV (*statusp);
1977 EXTEND (SP, AvFILLp (status) + 1); 2040 EXTEND (SP, AvFILLp (status) + 1);
1978 2041
1979 for (i = 0; i <= AvFILLp (status); ++i) 2042 for (i = 0; i <= AvFILLp (status); ++i)
1980 PUSHs (AvARRAY (status)[i]); 2043 PUSHs (AvARRAY (status)[i]);
1981 } 2044 }
1985 } 2048 }
1986 } 2049 }
1987} 2050}
1988 2051
1989static void 2052static void
1990slf_init_terminate (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items) 2053coro_set_status (HV *coro_hv, SV **arg, int items)
1991{ 2054{
1992 int i;
1993 HV *hv = (HV *)SvRV (coro_current);
1994 AV *av = newAV (); 2055 AV *av = newAV ();
1995 2056
1996 /* items are actually not so common, so optimise for this case */ 2057 /* items are actually not so common, so optimise for this case */
1997 if (items) 2058 if (items)
1998 { 2059 {
2060 int i;
2061
1999 av_extend (av, items - 1); 2062 av_extend (av, items - 1);
2000 2063
2001 for (i = 0; i < items; ++i) 2064 for (i = 0; i < items; ++i)
2002 av_push (av, SvREFCNT_inc_NN (arg [i])); 2065 av_push (av, SvREFCNT_inc_NN (arg [i]));
2003 } 2066 }
2004 2067
2005 hv_store (hv, "_status", sizeof ("_status") - 1, newRV_noinc ((SV *)av), 0); 2068 hv_store (coro_hv, "_status", sizeof ("_status") - 1, newRV_noinc ((SV *)av), 0);
2069}
2006 2070
2071static void
2072slf_init_terminate_cancel_common (pTHX_ struct CoroSLF *frame, HV *coro_hv)
2073{
2007 av_push (av_destroy, (SV *)newRV_inc ((SV *)hv)); /* RVinc for perl */ 2074 av_push (av_destroy, (SV *)newRV_inc ((SV *)coro_hv)); /* RVinc for perl */
2008 api_ready (aTHX_ sv_manager); 2075 api_ready (aTHX_ sv_manager);
2009 2076
2010 frame->prepare = prepare_schedule; 2077 frame->prepare = prepare_schedule;
2011 frame->check = slf_check_repeat; 2078 frame->check = slf_check_repeat;
2012 2079
2013 /* as a minor optimisation, we could unwind all stacks here */ 2080 /* as a minor optimisation, we could unwind all stacks here */
2014 /* but that puts extra pressure on pp_slf, and is not worth much */ 2081 /* but that puts extra pressure on pp_slf, and is not worth much */
2015 /*coro_unwind_stacks (aTHX);*/ 2082 /*coro_unwind_stacks (aTHX);*/
2083}
2084
2085static void
2086slf_init_terminate (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2087{
2088 HV *coro_hv = (HV *)SvRV (coro_current);
2089
2090 coro_set_status (coro_hv, arg, items);
2091 slf_init_terminate_cancel_common (frame, coro_hv);
2092}
2093
2094static void
2095slf_init_cancel (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2096{
2097 HV *coro_hv;
2098 struct coro *coro;
2099
2100 if (items <= 0)
2101 croak ("Coro::cancel called without coro object,");
2102
2103 coro = SvSTATE (arg [0]);
2104 coro_hv = coro->hv;
2105
2106 coro_set_status (coro_hv, arg + 1, items - 1);
2107
2108 if (expect_false (coro->flags & CF_NOCANCEL))
2109 {
2110 /* coro currently busy cancelling something, so just notify it */
2111 coro->slf_frame.data = (void *)coro;
2112
2113 frame->prepare = prepare_nop;
2114 frame->check = slf_check_nop;
2115 }
2116 else if (coro_hv == (HV *)SvRV (coro_current))
2117 {
2118 /* cancelling the current coro is allowed, and equals terminate */
2119 slf_init_terminate_cancel_common (frame, coro_hv);
2120 }
2121 else
2122 {
2123 struct coro *self = SvSTATE_current;
2124
2125 /* otherwise we cancel directly, purely for speed reasons
2126 * unfortunately, this requires some magic trickery, as
2127 * somebody else could cancel us, so we have to fight the cancellation.
2128 * this is ugly, and hopefully fully worth the extra speed.
2129 * besides, I can't get the slow-but-safe version working...
2130 */
2131 slf_frame.data = 0;
2132 self->flags |= CF_NOCANCEL;
2133
2134 coro_state_destroy (aTHX_ coro);
2135 coro_call_on_destroy (aTHX_ coro);
2136
2137 self->flags &= ~CF_NOCANCEL;
2138
2139 if (slf_frame.data)
2140 {
2141 /* while we were busy we have been cancelled, so terminate */
2142 slf_init_terminate_cancel_common (frame, self->hv);
2143 }
2144 else
2145 {
2146 frame->prepare = prepare_nop;
2147 frame->check = slf_check_nop;
2148 }
2149 }
2016} 2150}
2017 2151
2018/*****************************************************************************/ 2152/*****************************************************************************/
2019/* async pool handler */ 2153/* async pool handler */
2020 2154
3109 coroapi.prepare_nop = prepare_nop; 3243 coroapi.prepare_nop = prepare_nop;
3110 coroapi.prepare_schedule = prepare_schedule; 3244 coroapi.prepare_schedule = prepare_schedule;
3111 coroapi.prepare_cede = prepare_cede; 3245 coroapi.prepare_cede = prepare_cede;
3112 coroapi.prepare_cede_notself = prepare_cede_notself; 3246 coroapi.prepare_cede_notself = prepare_cede_notself;
3113 3247
3114 { 3248 time_init (aTHX);
3115 SV **svp = hv_fetch (PL_modglobal, "Time::NVtime", 12, 0);
3116
3117 if (!svp) croak ("Time::HiRes is required");
3118 if (!SvIOK (*svp)) croak ("Time::NVtime isn't a function pointer");
3119
3120 nvtime = INT2PTR (double (*)(), SvIV (*svp));
3121
3122 svp = hv_fetch (PL_modglobal, "Time::U2time", 12, 0);
3123 u2time = INT2PTR (void (*)(pTHX_ UV ret[2]), SvIV (*svp));
3124 }
3125 3249
3126 assert (("PRIO_NORMAL must be 0", !CORO_PRIO_NORMAL)); 3250 assert (("PRIO_NORMAL must be 0", !CORO_PRIO_NORMAL));
3127} 3251}
3128 3252
3129SV * 3253SV *
3138void 3262void
3139transfer (...) 3263transfer (...)
3140 PROTOTYPE: $$ 3264 PROTOTYPE: $$
3141 CODE: 3265 CODE:
3142 CORO_EXECUTE_SLF_XS (slf_init_transfer); 3266 CORO_EXECUTE_SLF_XS (slf_init_transfer);
3143
3144bool
3145_destroy (SV *coro_sv)
3146 CODE:
3147 RETVAL = coro_state_destroy (aTHX_ SvSTATE (coro_sv));
3148 OUTPUT:
3149 RETVAL
3150 3267
3151void 3268void
3152_exit (int code) 3269_exit (int code)
3153 PROTOTYPE: $ 3270 PROTOTYPE: $
3154 CODE: 3271 CODE:
3230 CODE: 3347 CODE:
3231{ 3348{
3232 if (coro->mainstack && ((coro->flags & CF_RUNNING) || coro->slot)) 3349 if (coro->mainstack && ((coro->flags & CF_RUNNING) || coro->slot))
3233 { 3350 {
3234 struct coro *current = SvSTATE_current; 3351 struct coro *current = SvSTATE_current;
3352 struct CoroSLF slf_save;
3235 3353
3236 if (current != coro) 3354 if (current != coro)
3237 { 3355 {
3238 PUTBACK; 3356 PUTBACK;
3239 save_perl (aTHX_ current); 3357 save_perl (aTHX_ current);
3240 load_perl (aTHX_ coro); 3358 load_perl (aTHX_ coro);
3359 /* the coro is most likely in an active SLF call.
3360 * while not strictly required (the code we execute is
3361 * not allowed to call any SLF functions), it's cleaner
3362 * to reinitialise the slf_frame and restore it later.
3363 * This might one day allow us to actually do SLF calls
3364 * from code executed here.
3365 */
3366 slf_save = slf_frame;
3367 slf_frame.prepare = 0;
3241 SPAGAIN; 3368 SPAGAIN;
3242 } 3369 }
3243 3370
3244 PUSHSTACK; 3371 PUSHSTACK;
3245 3372
3255 SPAGAIN; 3382 SPAGAIN;
3256 3383
3257 if (current != coro) 3384 if (current != coro)
3258 { 3385 {
3259 PUTBACK; 3386 PUTBACK;
3387 slf_frame = slf_save;
3260 save_perl (aTHX_ coro); 3388 save_perl (aTHX_ coro);
3261 load_perl (aTHX_ current); 3389 load_perl (aTHX_ current);
3262 SPAGAIN; 3390 SPAGAIN;
3263 } 3391 }
3264 } 3392 }
3350 3478
3351void 3479void
3352cancel (Coro::State self) 3480cancel (Coro::State self)
3353 CODE: 3481 CODE:
3354 coro_state_destroy (aTHX_ self); 3482 coro_state_destroy (aTHX_ self);
3355 coro_call_on_destroy (aTHX_ self); /* actually only for Coro objects */
3356
3357 3483
3358SV * 3484SV *
3359enable_times (int enabled = enable_times) 3485enable_times (int enabled = enable_times)
3360 CODE: 3486 CODE:
3361{ 3487{
3466 api_ready (aTHX_ RETVAL); 3592 api_ready (aTHX_ RETVAL);
3467 OUTPUT: 3593 OUTPUT:
3468 RETVAL 3594 RETVAL
3469 3595
3470void 3596void
3597_destroy (Coro::State coro)
3598 CODE:
3599 /* used by the manager thread */
3600 coro_state_destroy (aTHX_ coro);
3601 coro_call_on_destroy (aTHX_ coro);
3602
3603void
3471terminate (...) 3604terminate (...)
3472 CODE: 3605 CODE:
3473 CORO_EXECUTE_SLF_XS (slf_init_terminate); 3606 CORO_EXECUTE_SLF_XS (slf_init_terminate);
3607
3608void
3609cancel (...)
3610 CODE:
3611 CORO_EXECUTE_SLF_XS (slf_init_cancel);
3474 3612
3475void 3613void
3476schedule (...) 3614schedule (...)
3477 CODE: 3615 CODE:
3478 CORO_EXECUTE_SLF_XS (slf_init_schedule); 3616 CORO_EXECUTE_SLF_XS (slf_init_schedule);

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines