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.397 by root, Fri May 6 21:15:17 2011 UTC vs.
Revision 1.403 by root, Sun May 22 20:13:33 2011 UTC

13#include "XSUB.h" 13#include "XSUB.h"
14#include "perliol.h" 14#include "perliol.h"
15 15
16#include "schmorp.h" 16#include "schmorp.h"
17 17
18#include <stddef.h>
18#include <stdio.h> 19#include <stdio.h>
19#include <errno.h> 20#include <errno.h>
20#include <assert.h> 21#include <assert.h>
21 22
22#ifndef SVs_PADSTALE 23#ifndef SVs_PADSTALE
166static char times_valid; 167static char times_valid;
167 168
168static struct coro_cctx *cctx_first; 169static struct coro_cctx *cctx_first;
169static int cctx_count, cctx_idle; 170static int cctx_count, cctx_idle;
170 171
171enum { 172enum
173{
172 CC_MAPPED = 0x01, 174 CC_MAPPED = 0x01,
173 CC_NOREUSE = 0x02, /* throw this away after tracing */ 175 CC_NOREUSE = 0x02, /* throw this away after tracing */
174 CC_TRACE = 0x04, 176 CC_TRACE = 0x04,
175 CC_TRACE_SUB = 0x08, /* trace sub calls */ 177 CC_TRACE_SUB = 0x08, /* trace sub calls */
176 CC_TRACE_LINE = 0x10, /* trace each statement */ 178 CC_TRACE_LINE = 0x10, /* trace each statement */
201 203
202static coro_cctx *cctx_current; /* the currently running cctx */ 204static coro_cctx *cctx_current; /* the currently running cctx */
203 205
204/*****************************************************************************/ 206/*****************************************************************************/
205 207
208static MGVTBL coro_state_vtbl;
209
206enum { 210enum
211{
207 CF_RUNNING = 0x0001, /* coroutine is running */ 212 CF_RUNNING = 0x0001, /* coroutine is running */
208 CF_READY = 0x0002, /* coroutine is ready */ 213 CF_READY = 0x0002, /* coroutine is ready */
209 CF_NEW = 0x0004, /* has never been switched to */ 214 CF_NEW = 0x0004, /* has never been switched to */
210 CF_DESTROYED = 0x0008, /* coroutine data has been freed */ 215 CF_ZOMBIE = 0x0008, /* coroutine data has been freed */
211 CF_SUSPENDED = 0x0010, /* coroutine can't be scheduled */ 216 CF_SUSPENDED = 0x0010, /* coroutine can't be scheduled */
212 CF_NOCANCEL = 0x0020, /* cannot cancel, set slf_frame.data to 1 (hackish) */ 217 CF_NOCANCEL = 0x0020, /* cannot cancel, set slf_frame.data to 1 (hackish) */
213}; 218};
214 219
215/* the structure where most of the perl state is stored, overlaid on the cxstack */ 220/* the structure where most of the perl state is stored, overlaid on the cxstack */
223#define VAR(name,type) type name; 228#define VAR(name,type) type name;
224# include "state.h" 229# include "state.h"
225#undef VAR 230#undef VAR
226} perl_slots; 231} perl_slots;
227 232
233// how many context stack entries do we need for perl_slots
228#define SLOT_COUNT ((sizeof (perl_slots) + sizeof (PERL_CONTEXT) - 1) / sizeof (PERL_CONTEXT)) 234#define SLOT_COUNT ((sizeof (perl_slots) + sizeof (PERL_CONTEXT) - 1) / sizeof (PERL_CONTEXT))
229 235
230/* this is a structure representing a perl-level coroutine */ 236/* this is a structure representing a perl-level coroutine */
231struct coro { 237struct coro
238{
232 /* the C coroutine allocated to this perl coroutine, if any */ 239 /* the C coroutine allocated to this perl coroutine, if any */
233 coro_cctx *cctx; 240 coro_cctx *cctx;
234 241
235 /* ready queue */ 242 /* ready queue */
236 struct coro *next_ready; 243 struct coro *next_ready;
238 /* state data */ 245 /* state data */
239 struct CoroSLF slf_frame; /* saved slf frame */ 246 struct CoroSLF slf_frame; /* saved slf frame */
240 AV *mainstack; 247 AV *mainstack;
241 perl_slots *slot; /* basically the saved sp */ 248 perl_slots *slot; /* basically the saved sp */
242 249
243 CV *startcv; /* the CV to execute */ 250 CV *startcv; /* the CV to execute */
244 AV *args; /* data associated with this coroutine (initial args) */ 251 AV *args; /* data associated with this coroutine (initial args) */
245 int refcnt; /* coroutines are refcounted, yes */
246 int flags; /* CF_ flags */ 252 int flags; /* CF_ flags */
247 HV *hv; /* the perl hash associated with this coro, if any */ 253 HV *hv; /* the perl hash associated with this coro, if any */
248 254
249 /* statistics */ 255 /* statistics */
250 int usecount; /* number of transfers to this coro */ 256 int usecount; /* number of transfers to this coro */
251 257
252 /* coro process data */ 258 /* coro process data */
253 int prio; 259 int prio;
254 SV *except; /* exception to be thrown */ 260 SV *except; /* exception to be thrown */
255 SV *rouse_cb; 261 SV *rouse_cb; /* last rouse callback */
262 AV *on_destroy; /* callbacks or coros to notify on destroy */
263 AV *status; /* the exit status list */
256 264
257 /* async_pool */ 265 /* async_pool */
258 SV *saved_deffh; 266 SV *saved_deffh;
259 SV *invoke_cb; 267 SV *invoke_cb;
260 AV *invoke_av; 268 AV *invoke_av;
466 : 0) 474 : 0)
467 475
468#define CORO_MAGIC_cv(cv) CORO_MAGIC (((SV *)(cv)), CORO_MAGIC_type_cv) 476#define CORO_MAGIC_cv(cv) CORO_MAGIC (((SV *)(cv)), CORO_MAGIC_type_cv)
469#define CORO_MAGIC_state(sv) CORO_MAGIC_NN (((SV *)(sv)), CORO_MAGIC_type_state) 477#define CORO_MAGIC_state(sv) CORO_MAGIC_NN (((SV *)(sv)), CORO_MAGIC_type_state)
470 478
479INLINE MAGIC *
480SvSTATEhv_p (pTHX_ SV *coro)
481{
482 MAGIC *mg;
483
484 if (expect_true (
485 SvTYPE (coro) == SVt_PVHV
486 && (mg = CORO_MAGIC_state (coro))
487 && mg->mg_virtual == &coro_state_vtbl
488 ))
489 return mg;
490
491 return 0;
492}
493
471INLINE struct coro * 494INLINE struct coro *
472SvSTATE_ (pTHX_ SV *coro) 495SvSTATE_ (pTHX_ SV *coro)
473{ 496{
474 HV *stash;
475 MAGIC *mg; 497 MAGIC *mg;
476 498
477 if (SvROK (coro)) 499 if (SvROK (coro))
478 coro = SvRV (coro); 500 coro = SvRV (coro);
479 501
480 if (expect_false (SvTYPE (coro) != SVt_PVHV)) 502 mg = SvSTATEhv_p (aTHX_ coro);
503 if (!mg)
481 croak ("Coro::State object required"); 504 croak ("Coro::State object required");
482 505
483 stash = SvSTASH (coro);
484 if (expect_false (stash != coro_stash && stash != coro_state_stash))
485 {
486 /* very slow, but rare, check */
487 if (!sv_derived_from (sv_2mortal (newRV_inc (coro)), "Coro::State"))
488 croak ("Coro::State object required");
489 }
490
491 mg = CORO_MAGIC_state (coro);
492 return (struct coro *)mg->mg_ptr; 506 return (struct coro *)mg->mg_ptr;
493} 507}
494 508
495#define SvSTATE(sv) SvSTATE_ (aTHX_ (sv)) 509#define SvSTATE(sv) SvSTATE_ (aTHX_ (sv))
496 510
798 812
799 PUTBACK; 813 PUTBACK;
800 } 814 }
801 815
802 /* allocate some space on the context stack for our purposes */ 816 /* allocate some space on the context stack for our purposes */
803 /* we manually unroll here, as usually 2 slots is enough */ 817 if (expect_false (cxstack_ix + SLOT_COUNT >= cxstack_max))
804 if (SLOT_COUNT >= 1) CXINC;
805 if (SLOT_COUNT >= 2) CXINC;
806 if (SLOT_COUNT >= 3) CXINC;
807 { 818 {
808 unsigned int i; 819 unsigned int i;
820
809 for (i = 3; i < SLOT_COUNT; ++i) 821 for (i = 0; i < SLOT_COUNT; ++i)
810 CXINC; 822 CXINC;
811 } 823
812 cxstack_ix -= SLOT_COUNT; /* undo allocation */ 824 cxstack_ix -= SLOT_COUNT; /* undo allocation */
825 }
813 826
814 c->mainstack = PL_mainstack; 827 c->mainstack = PL_mainstack;
815 828
816 { 829 {
817 perl_slots *slot = c->slot = (perl_slots *)(cxstack + cxstack_ix + 1); 830 perl_slots *slot = c->slot = (perl_slots *)(cxstack + cxstack_ix + 1);
838# define coro_init_stacks(thx) init_stacks () 851# define coro_init_stacks(thx) init_stacks ()
839#else 852#else
840static void 853static void
841coro_init_stacks (pTHX) 854coro_init_stacks (pTHX)
842{ 855{
843 PL_curstackinfo = new_stackinfo(32, 8); 856 PL_curstackinfo = new_stackinfo(32, 4 + SLOT_COUNT); /* 3 is minimum due to perl rounding down in scope.c:GROW() */
844 PL_curstackinfo->si_type = PERLSI_MAIN; 857 PL_curstackinfo->si_type = PERLSI_MAIN;
845 PL_curstack = PL_curstackinfo->si_stack; 858 PL_curstack = PL_curstackinfo->si_stack;
846 PL_mainstack = PL_curstack; /* remember in case we switch stacks */ 859 PL_mainstack = PL_curstack; /* remember in case we switch stacks */
847 860
848 PL_stack_base = AvARRAY(PL_curstack); 861 PL_stack_base = AvARRAY(PL_curstack);
955#endif 968#endif
956 969
957/* 970/*
958 * This overrides the default magic get method of %SIG elements. 971 * This overrides the default magic get method of %SIG elements.
959 * The original one doesn't provide for reading back of PL_diehook/PL_warnhook 972 * The original one doesn't provide for reading back of PL_diehook/PL_warnhook
960 * and instead of trying to save and restore the hash elements, we just provide 973 * and instead of trying to save and restore the hash elements (extremely slow),
961 * readback here. 974 * we just provide our own readback here.
962 */ 975 */
963static int 976static int
964coro_sigelem_get (pTHX_ SV *sv, MAGIC *mg) 977coro_sigelem_get (pTHX_ SV *sv, MAGIC *mg)
965{ 978{
966 const char *s = MgPV_nolen_const (mg); 979 const char *s = MgPV_nolen_const (mg);
1074 PL_parser = 0; 1087 PL_parser = 0;
1075#endif 1088#endif
1076 PL_hints = 0; 1089 PL_hints = 0;
1077 1090
1078 /* recreate the die/warn hooks */ 1091 /* recreate the die/warn hooks */
1079 PL_diehook = 0; SvSetMagicSV (*hv_fetch (hv_sig, "__DIE__" , sizeof ("__DIE__" ) - 1, 1), rv_diehook ); 1092 PL_diehook = SvREFCNT_inc (rv_diehook);
1080 PL_warnhook = 0; SvSetMagicSV (*hv_fetch (hv_sig, "__WARN__", sizeof ("__WARN__") - 1, 1), rv_warnhook); 1093 PL_warnhook = SvREFCNT_inc (rv_warnhook);
1081 1094
1082 GvSV (PL_defgv) = newSV (0); 1095 GvSV (PL_defgv) = newSV (0);
1083 GvAV (PL_defgv) = coro->args; coro->args = 0; 1096 GvAV (PL_defgv) = coro->args; coro->args = 0;
1084 GvSV (PL_errgv) = newSV (0); 1097 GvSV (PL_errgv) = newSV (0);
1085 GvSV (irsgv) = newSVpvn ("\n", 1); sv_magic (GvSV (irsgv), (SV *)irsgv, PERL_MAGIC_sv, "/", 0); 1098 GvSV (irsgv) = newSVpvn ("\n", 1); sv_magic (GvSV (irsgv), (SV *)irsgv, PERL_MAGIC_sv, "/", 0);
1106 /* this newly created coroutine might be run on an existing cctx which most 1119 /* this newly created coroutine might be run on an existing cctx which most
1107 * likely was suspended in pp_slf, so we have to emulate entering pp_slf here. 1120 * likely was suspended in pp_slf, so we have to emulate entering pp_slf here.
1108 */ 1121 */
1109 slf_frame.prepare = prepare_nop; /* provide a nop function for an eventual pp_slf */ 1122 slf_frame.prepare = prepare_nop; /* provide a nop function for an eventual pp_slf */
1110 slf_frame.check = slf_check_nop; /* signal pp_slf to not repeat */ 1123 slf_frame.check = slf_check_nop; /* signal pp_slf to not repeat */
1124 slf_frame.destroy = 0;
1111 1125
1112 /* and we have to provide the pp_slf op in any case, so pp_slf can skip it */ 1126 /* and we have to provide the pp_slf op in any case, so pp_slf can skip it */
1113 init_perl_op.op_next = PL_op; 1127 init_perl_op.op_next = PL_op;
1114 init_perl_op.op_type = OP_ENTERSUB; 1128 init_perl_op.op_type = OP_ENTERSUB;
1115 init_perl_op.op_ppaddr = pp_slf; 1129 init_perl_op.op_ppaddr = pp_slf;
1167 SvRV_set (coro_current, (SV *)coro->hv); 1181 SvRV_set (coro_current, (SV *)coro->hv);
1168 1182
1169 load_perl (aTHX_ coro); 1183 load_perl (aTHX_ coro);
1170 1184
1171 coro_unwind_stacks (aTHX); 1185 coro_unwind_stacks (aTHX);
1172 coro_destruct_stacks (aTHX);
1173 1186
1174 /* restore swapped sv's */ 1187 /* restore swapped sv's */
1175 SWAP_SVS (coro); 1188 SWAP_SVS (coro);
1189
1190 coro_destruct_stacks (aTHX);
1176 1191
1177 // now save some sv's to be free'd later 1192 // now save some sv's to be free'd later
1178 svf [0] = GvSV (PL_defgv); 1193 svf [0] = GvSV (PL_defgv);
1179 svf [1] = (SV *)GvAV (PL_defgv); 1194 svf [1] = (SV *)GvAV (PL_defgv);
1180 svf [2] = GvSV (PL_errgv); 1195 svf [2] = GvSV (PL_errgv);
1207INLINE void 1222INLINE void
1208free_coro_mortal (pTHX) 1223free_coro_mortal (pTHX)
1209{ 1224{
1210 if (expect_true (coro_mortal)) 1225 if (expect_true (coro_mortal))
1211 { 1226 {
1212 SvREFCNT_dec (coro_mortal); 1227 SvREFCNT_dec ((SV *)coro_mortal);
1213 coro_mortal = 0; 1228 coro_mortal = 0;
1214 } 1229 }
1215} 1230}
1216 1231
1217static int 1232static int
1580 if (expect_true (prev != next)) 1595 if (expect_true (prev != next))
1581 { 1596 {
1582 if (expect_false (!(prev->flags & (CF_RUNNING | CF_NEW)))) 1597 if (expect_false (!(prev->flags & (CF_RUNNING | CF_NEW))))
1583 croak ("Coro::State::transfer called with a blocked prev Coro::State, but can only transfer from running or new states,"); 1598 croak ("Coro::State::transfer called with a blocked prev Coro::State, but can only transfer from running or new states,");
1584 1599
1585 if (expect_false (next->flags & (CF_RUNNING | CF_DESTROYED | CF_SUSPENDED))) 1600 if (expect_false (next->flags & (CF_RUNNING | CF_ZOMBIE | CF_SUSPENDED)))
1586 croak ("Coro::State::transfer called with running, destroyed or suspended next Coro::State, but can only transfer to inactive states,"); 1601 croak ("Coro::State::transfer called with running, destroyed or suspended next Coro::State, but can only transfer to inactive states,");
1587 1602
1588#if !PERL_VERSION_ATLEAST (5,10,0) 1603#if !PERL_VERSION_ATLEAST (5,10,0)
1589 if (expect_false (PL_lex_state != LEX_NOTPARSING)) 1604 if (expect_false (PL_lex_state != LEX_NOTPARSING))
1590 croak ("Coro::State::transfer called while parsing, but this is not supported in your perl version,"); 1605 croak ("Coro::State::transfer called while parsing, but this is not supported in your perl version,");
1673#define TRANSFER(ta, force_cctx) transfer (aTHX_ (ta).prev, (ta).next, (force_cctx)) 1688#define TRANSFER(ta, force_cctx) transfer (aTHX_ (ta).prev, (ta).next, (force_cctx))
1674#define TRANSFER_CHECK(ta) transfer_check (aTHX_ (ta).prev, (ta).next) 1689#define TRANSFER_CHECK(ta) transfer_check (aTHX_ (ta).prev, (ta).next)
1675 1690
1676/** high level stuff ********************************************************/ 1691/** high level stuff ********************************************************/
1677 1692
1693/* this function is actually Coro, not Coro::State, but we call it from here */
1694/* because it is convenient - but it hasn't been declared yet for that reason */
1695static void
1696coro_call_on_destroy (pTHX_ struct coro *coro);
1697
1678static void 1698static void
1679coro_state_destroy (pTHX_ struct coro *coro) 1699coro_state_destroy (pTHX_ struct coro *coro)
1680{ 1700{
1681 if (coro->flags & CF_DESTROYED) 1701 if (coro->flags & CF_ZOMBIE)
1682 return; 1702 return;
1683 1703
1684 slf_destroy (aTHX_ coro); 1704 slf_destroy (aTHX_ coro);
1685 1705
1686 coro->flags |= CF_DESTROYED; 1706 coro->flags |= CF_ZOMBIE;
1687 1707
1688 if (coro->flags & CF_READY) 1708 if (coro->flags & CF_READY)
1689 { 1709 {
1690 /* reduce nready, as destroying a ready coro effectively unreadies it */ 1710 /* reduce nready, as destroying a ready coro effectively unreadies it */
1691 /* alternative: look through all ready queues and remove the coro */ 1711 /* alternative: look through all ready queues and remove the coro */
1692 --coro_nready; 1712 --coro_nready;
1693 } 1713 }
1694 else 1714 else
1695 coro->flags |= CF_READY; /* make sure it is NOT put into the readyqueue */ 1715 coro->flags |= CF_READY; /* make sure it is NOT put into the readyqueue */
1716
1717 if (coro->next) coro->next->prev = coro->prev;
1718 if (coro->prev) coro->prev->next = coro->next;
1719 if (coro == coro_first) coro_first = coro->next;
1696 1720
1697 if (coro->mainstack 1721 if (coro->mainstack
1698 && coro->mainstack != main_mainstack 1722 && coro->mainstack != main_mainstack
1699 && coro->slot 1723 && coro->slot
1700 && !PL_dirty) 1724 && !PL_dirty)
1701 destroy_perl (aTHX_ coro); 1725 destroy_perl (aTHX_ coro);
1702 1726
1703 if (coro->next) coro->next->prev = coro->prev;
1704 if (coro->prev) coro->prev->next = coro->next;
1705 if (coro == coro_first) coro_first = coro->next;
1706
1707 cctx_destroy (coro->cctx); 1727 cctx_destroy (coro->cctx);
1708 SvREFCNT_dec (coro->startcv); 1728 SvREFCNT_dec (coro->startcv);
1709 SvREFCNT_dec (coro->args); 1729 SvREFCNT_dec (coro->args);
1710 SvREFCNT_dec (coro->swap_sv); 1730 SvREFCNT_dec (coro->swap_sv);
1711 SvREFCNT_dec (CORO_THROW); 1731 SvREFCNT_dec (CORO_THROW);
1732
1733 coro_call_on_destroy (aTHX_ coro);
1734
1735 /* more destruction mayhem in coro_state_free */
1712} 1736}
1713 1737
1714static int 1738static int
1715coro_state_free (pTHX_ SV *sv, MAGIC *mg) 1739coro_state_free (pTHX_ SV *sv, MAGIC *mg)
1716{ 1740{
1717 struct coro *coro = (struct coro *)mg->mg_ptr; 1741 struct coro *coro = (struct coro *)mg->mg_ptr;
1718 mg->mg_ptr = 0; 1742 mg->mg_ptr = 0;
1719 1743
1720 coro->hv = 0;
1721
1722 if (--coro->refcnt < 0)
1723 {
1724 coro_state_destroy (aTHX_ coro); 1744 coro_state_destroy (aTHX_ coro);
1745 SvREFCNT_dec (coro->on_destroy);
1746 SvREFCNT_dec (coro->status);
1747
1725 Safefree (coro); 1748 Safefree (coro);
1726 }
1727 1749
1728 return 0; 1750 return 0;
1729} 1751}
1730 1752
1731static int 1753static int
1732coro_state_dup (pTHX_ MAGIC *mg, CLONE_PARAMS *params) 1754coro_state_dup (pTHX_ MAGIC *mg, CLONE_PARAMS *params)
1733{ 1755{
1734 struct coro *coro = (struct coro *)mg->mg_ptr; 1756 /* called when perl clones the current process the slow way (windows process emulation) */
1735 1757 /* WE SIMply nuke the pointers in the copy, causing perl to croak */
1736 ++coro->refcnt; 1758 mg->mg_ptr = 0;
1759 mg->mg_virtual = 0;
1737 1760
1738 return 0; 1761 return 0;
1739} 1762}
1740 1763
1741static MGVTBL coro_state_vtbl = { 1764static MGVTBL coro_state_vtbl = {
1867 struct coro *next = coro_deq (aTHX); 1890 struct coro *next = coro_deq (aTHX);
1868 1891
1869 if (expect_true (next)) 1892 if (expect_true (next))
1870 { 1893 {
1871 /* cannot transfer to destroyed coros, skip and look for next */ 1894 /* cannot transfer to destroyed coros, skip and look for next */
1872 if (expect_false (next->flags & (CF_DESTROYED | CF_SUSPENDED))) 1895 if (expect_false (next->flags & (CF_ZOMBIE | CF_SUSPENDED)))
1873 SvREFCNT_dec (next->hv); /* coro_nready has already been taken care of by destroy */ 1896 SvREFCNT_dec (next->hv); /* coro_nready has already been taken care of by destroy */
1874 else 1897 else
1875 { 1898 {
1876 next->flags &= ~CF_READY; 1899 next->flags &= ~CF_READY;
1877 --coro_nready; 1900 --coro_nready;
2010 coro->slot->runops = RUNOPS_DEFAULT; 2033 coro->slot->runops = RUNOPS_DEFAULT;
2011 } 2034 }
2012} 2035}
2013 2036
2014static void 2037static void
2038coro_push_av (pTHX_ AV *av, I32 gimme_v)
2039{
2040 if (AvFILLp (av) >= 0 && gimme_v != G_VOID)
2041 {
2042 dSP;
2043
2044 if (gimme_v == G_SCALAR)
2045 XPUSHs (AvARRAY (av)[AvFILLp (av)]);
2046 else
2047 {
2048 int i;
2049 EXTEND (SP, AvFILLp (av) + 1);
2050
2051 for (i = 0; i <= AvFILLp (av); ++i)
2052 PUSHs (AvARRAY (av)[i]);
2053 }
2054
2055 PUTBACK;
2056 }
2057}
2058
2059static void
2060coro_push_on_destroy (pTHX_ struct coro *coro, SV *cb)
2061{
2062 if (!coro->on_destroy)
2063 coro->on_destroy = newAV ();
2064
2065 av_push (coro->on_destroy, cb);
2066}
2067
2068static void
2069slf_destroy_join (pTHX_ struct CoroSLF *frame)
2070{
2071 SvREFCNT_dec ((SV *)((struct coro *)frame->data)->hv);
2072}
2073
2074static int
2075slf_check_join (pTHX_ struct CoroSLF *frame)
2076{
2077 struct coro *coro = (struct coro *)frame->data;
2078
2079 if (!coro->status)
2080 return 1;
2081
2082 frame->destroy = 0;
2083
2084 coro_push_av (aTHX_ coro->status, GIMME_V);
2085
2086 SvREFCNT_dec ((SV *)coro->hv);
2087
2088 return 0;
2089}
2090
2091static void
2092slf_init_join (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2093{
2094 struct coro *coro = SvSTATE (items > 0 ? arg [0] : &PL_sv_undef);
2095
2096 if (items > 1)
2097 croak ("join called with too many arguments");
2098
2099 if (coro->status)
2100 frame->prepare = prepare_nop;
2101 else
2102 {
2103 coro_push_on_destroy (aTHX_ coro, SvREFCNT_inc_NN (SvRV (coro_current)));
2104 frame->prepare = prepare_schedule;
2105 }
2106
2107 frame->check = slf_check_join;
2108 frame->destroy = slf_destroy_join;
2109 frame->data = (void *)coro;
2110 SvREFCNT_inc (coro->hv);
2111}
2112
2113static void
2015coro_call_on_destroy (pTHX_ struct coro *coro) 2114coro_call_on_destroy (pTHX_ struct coro *coro)
2016{ 2115{
2017 SV **on_destroyp = hv_fetch (coro->hv, "_on_destroy", sizeof ("_on_destroy") - 1, 0); 2116 AV *od = coro->on_destroy;
2018 2117
2019 if (on_destroyp) 2118 if (!od)
2020 { 2119 return;
2021 SV **statusp = hv_fetch (coro->hv, "_status", sizeof ("_status") - 1, 0);
2022 AV *on_destroy = sv_2mortal (SvREFCNT_inc ((AV *)SvRV (*on_destroyp)));
2023 AV *status = statusp ? sv_2mortal (SvREFCNT_inc ((AV *)SvRV (*statusp))) : 0;
2024 2120
2025 while (AvFILLp (on_destroy) >= 0) 2121 while (AvFILLp (od) >= 0)
2122 {
2123 SV *cb = sv_2mortal (av_pop (od));
2124
2125 /* coro hv's (and only hv's at the moment) are supported as well */
2126 if (SvSTATEhv_p (aTHX_ cb))
2127 api_ready (aTHX_ cb);
2128 else
2026 { 2129 {
2027 dSP; /* don't disturb outer sp */ 2130 dSP; /* don't disturb outer sp */
2028 SV *cb = av_pop (on_destroy);
2029
2030 PUSHMARK (SP); 2131 PUSHMARK (SP);
2031 2132
2032 if (statusp) 2133 if (coro->status)
2033 { 2134 {
2034 int i; 2135 PUTBACK;
2035 EXTEND (SP, AvFILLp (status) + 1); 2136 coro_push_av (aTHX_ coro->status, G_ARRAY);
2036 2137 SPAGAIN;
2037 for (i = 0; i <= AvFILLp (status); ++i)
2038 PUSHs (AvARRAY (status)[i]);
2039 } 2138 }
2040 2139
2041 PUTBACK; 2140 PUTBACK;
2042 call_sv (sv_2mortal (cb), G_VOID | G_DISCARD); 2141 call_sv (cb, G_VOID | G_DISCARD);
2043 } 2142 }
2044 } 2143 }
2045} 2144}
2046 2145
2047static void 2146static void
2048coro_set_status (HV *coro_hv, SV **arg, int items) 2147coro_set_status (pTHX_ struct coro *coro, SV **arg, int items)
2049{ 2148{
2050 AV *av = newAV (); 2149 AV *av;
2150
2151 if (coro->status)
2152 {
2153 av = coro->status;
2154 av_clear (av);
2155 }
2156 else
2157 av = coro->status = newAV ();
2051 2158
2052 /* items are actually not so common, so optimise for this case */ 2159 /* items are actually not so common, so optimise for this case */
2053 if (items) 2160 if (items)
2054 { 2161 {
2055 int i; 2162 int i;
2057 av_extend (av, items - 1); 2164 av_extend (av, items - 1);
2058 2165
2059 for (i = 0; i < items; ++i) 2166 for (i = 0; i < items; ++i)
2060 av_push (av, SvREFCNT_inc_NN (arg [i])); 2167 av_push (av, SvREFCNT_inc_NN (arg [i]));
2061 } 2168 }
2062
2063 hv_store (coro_hv, "_status", sizeof ("_status") - 1, newRV_noinc ((SV *)av), 0);
2064} 2169}
2065 2170
2066static void 2171static void
2067slf_init_terminate_cancel_common (pTHX_ struct CoroSLF *frame, HV *coro_hv) 2172slf_init_terminate_cancel_common (pTHX_ struct CoroSLF *frame, HV *coro_hv)
2068{ 2173{
2080static void 2185static void
2081slf_init_terminate (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items) 2186slf_init_terminate (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2082{ 2187{
2083 HV *coro_hv = (HV *)SvRV (coro_current); 2188 HV *coro_hv = (HV *)SvRV (coro_current);
2084 2189
2085 coro_set_status (coro_hv, arg, items); 2190 coro_set_status (aTHX_ SvSTATE ((SV *)coro_hv), arg, items);
2086 slf_init_terminate_cancel_common (frame, coro_hv); 2191 slf_init_terminate_cancel_common (aTHX_ frame, coro_hv);
2087} 2192}
2088 2193
2089static void 2194static void
2090slf_init_cancel (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items) 2195slf_init_cancel (pTHX_ struct CoroSLF *frame, CV *cv, SV **arg, int items)
2091{ 2196{
2096 croak ("Coro::cancel called without coro object,"); 2201 croak ("Coro::cancel called without coro object,");
2097 2202
2098 coro = SvSTATE (arg [0]); 2203 coro = SvSTATE (arg [0]);
2099 coro_hv = coro->hv; 2204 coro_hv = coro->hv;
2100 2205
2101 coro_set_status (coro_hv, arg + 1, items - 1); 2206 coro_set_status (aTHX_ coro, arg + 1, items - 1);
2102 2207
2103 if (expect_false (coro->flags & CF_NOCANCEL)) 2208 if (expect_false (coro->flags & CF_NOCANCEL))
2104 { 2209 {
2105 /* coro currently busy cancelling something, so just notify it */ 2210 /* coro currently busy cancelling something, so just notify it */
2106 coro->slf_frame.data = (void *)coro; 2211 coro->slf_frame.data = (void *)coro;
2109 frame->check = slf_check_nop; 2214 frame->check = slf_check_nop;
2110 } 2215 }
2111 else if (coro_hv == (HV *)SvRV (coro_current)) 2216 else if (coro_hv == (HV *)SvRV (coro_current))
2112 { 2217 {
2113 /* cancelling the current coro is allowed, and equals terminate */ 2218 /* cancelling the current coro is allowed, and equals terminate */
2114 slf_init_terminate_cancel_common (frame, coro_hv); 2219 slf_init_terminate_cancel_common (aTHX_ frame, coro_hv);
2115 } 2220 }
2116 else 2221 else
2117 { 2222 {
2118 struct coro *self = SvSTATE_current; 2223 struct coro *self = SvSTATE_current;
2119 2224
2123 * this is ugly, and hopefully fully worth the extra speed. 2228 * this is ugly, and hopefully fully worth the extra speed.
2124 * besides, I can't get the slow-but-safe version working... 2229 * besides, I can't get the slow-but-safe version working...
2125 */ 2230 */
2126 slf_frame.data = 0; 2231 slf_frame.data = 0;
2127 self->flags |= CF_NOCANCEL; 2232 self->flags |= CF_NOCANCEL;
2128
2129 coro_state_destroy (aTHX_ coro); 2233 coro_state_destroy (aTHX_ coro);
2130 coro_call_on_destroy (aTHX_ coro);
2131
2132 self->flags &= ~CF_NOCANCEL; 2234 self->flags &= ~CF_NOCANCEL;
2133 2235
2134 if (slf_frame.data) 2236 if (slf_frame.data)
2135 { 2237 {
2136 /* while we were busy we have been cancelled, so terminate */ 2238 /* while we were busy we have been cancelled, so terminate */
2137 slf_init_terminate_cancel_common (frame, self->hv); 2239 slf_init_terminate_cancel_common (aTHX_ frame, self->hv);
2138 } 2240 }
2139 else 2241 else
2140 { 2242 {
2141 frame->prepare = prepare_nop; 2243 frame->prepare = prepare_nop;
2142 frame->check = slf_check_nop; 2244 frame->check = slf_check_nop;
2146 2248
2147static int 2249static int
2148slf_check_safe_cancel (pTHX_ struct CoroSLF *frame) 2250slf_check_safe_cancel (pTHX_ struct CoroSLF *frame)
2149{ 2251{
2150 frame->prepare = 0; 2252 frame->prepare = 0;
2151 coro_unwind_stacks (); 2253 coro_unwind_stacks (aTHX);
2152 2254
2153 slf_init_terminate_cancel_common (aTHX_ frame, (HV *)SvRV (coro_current)); 2255 slf_init_terminate_cancel_common (aTHX_ frame, (HV *)SvRV (coro_current));
2154 2256
2155 return 1; 2257 return 1;
2156} 2258}
2161 if (coro->cctx) 2263 if (coro->cctx)
2162 croak ("coro inside C callback, unable to cancel at this time, caught"); 2264 croak ("coro inside C callback, unable to cancel at this time, caught");
2163 2265
2164 if (coro->flags & CF_NEW) 2266 if (coro->flags & CF_NEW)
2165 { 2267 {
2166 coro_set_status (coro->hv, arg, items); 2268 coro_set_status (aTHX_ coro, arg, items);
2167 coro_state_destroy (aTHX_ coro); 2269 coro_state_destroy (aTHX_ coro);
2168 coro_call_on_destroy (aTHX_ coro);
2169 } 2270 }
2170 else 2271 else
2171 { 2272 {
2172 if (!coro->slf_frame.prepare) 2273 if (!coro->slf_frame.prepare)
2173 croak ("coro outside an SLF function, unable to cancel at this time, caught"); 2274 croak ("coro outside an SLF function, unable to cancel at this time, caught");
2174 2275
2175 slf_destroy (coro); 2276 slf_destroy (aTHX_ coro);
2176 2277
2177 coro_set_status (coro->hv, arg, items); 2278 coro_set_status (aTHX_ coro, arg, items);
2178 coro->slf_frame.prepare = prepare_nop; 2279 coro->slf_frame.prepare = prepare_nop;
2179 coro->slf_frame.check = slf_check_safe_cancel; 2280 coro->slf_frame.check = slf_check_safe_cancel;
2180 2281
2181 api_ready (aTHX_ coro->hv); 2282 api_ready (aTHX_ (SV *)coro->hv);
2182 } 2283 }
2183 2284
2184 return 1; 2285 return 1;
2185} 2286}
2186 2287
2471static void 2572static void
2472slf_destroy (pTHX_ struct coro *coro) 2573slf_destroy (pTHX_ struct coro *coro)
2473{ 2574{
2474 /* this callback is reserved for slf functions needing to do cleanup */ 2575 /* this callback is reserved for slf functions needing to do cleanup */
2475 if (coro->slf_frame.destroy && coro->slf_frame.prepare && !PL_dirty) 2576 if (coro->slf_frame.destroy && coro->slf_frame.prepare && !PL_dirty)
2476 coro->slf_frame.destroy (aTHX_ coro); 2577 coro->slf_frame.destroy (aTHX_ &coro->slf_frame);
2477 2578
2478 /* 2579 /*
2479 * The on_destroy above most likely is from an SLF call. 2580 * The on_destroy above most likely is from an SLF call.
2480 * Since by definition the SLF call will not finish when we destroy 2581 * Since by definition the SLF call will not finish when we destroy
2481 * the coro, we will have to force-finish it here, otherwise 2582 * the coro, we will have to force-finish it here, otherwise
2558 croak (0); 2659 croak (0);
2559 } 2660 }
2560 2661
2561 /* return value handling - mostly like entersub */ 2662 /* return value handling - mostly like entersub */
2562 /* make sure we put something on the stack in scalar context */ 2663 /* make sure we put something on the stack in scalar context */
2563 if (GIMME_V == G_SCALAR) 2664 if (GIMME_V == G_SCALAR
2665 && expect_false (PL_stack_sp != PL_stack_base + checkmark + 1))
2564 { 2666 {
2565 dSP; 2667 dSP;
2566 SV **bot = PL_stack_base + checkmark; 2668 SV **bot = PL_stack_base + checkmark;
2567 2669
2568 if (sp == bot) /* too few, push undef */ 2670 if (sp == bot) /* too few, push undef */
2569 bot [1] = &PL_sv_undef; 2671 bot [1] = &PL_sv_undef;
2570 else if (sp != bot + 1) /* too many, take last one */ 2672 else /* too many, take last one */
2571 bot [1] = *sp; 2673 bot [1] = *sp;
2572 2674
2573 SP = bot + 1; 2675 SP = bot + 1;
2574 2676
2575 PUTBACK; 2677 PUTBACK;
2815 SvREFCNT_dec (cb); 2917 SvREFCNT_dec (cb);
2816 } 2918 }
2817} 2919}
2818 2920
2819static void 2921static void
2820coro_semaphore_destroy (pTHX_ struct coro *coro) 2922coro_semaphore_destroy (pTHX_ struct CoroSLF *frame)
2821{ 2923{
2822 /* call $sem->adjust (0) to possibly wake up some other waiters */ 2924 /* call $sem->adjust (0) to possibly wake up some other waiters */
2823 coro_semaphore_adjust (aTHX_ (AV *)coro->slf_frame.data, 0); 2925 coro_semaphore_adjust (aTHX_ (AV *)frame->data, 0);
2824} 2926}
2825 2927
2826static int 2928static int
2827slf_check_semaphore_down_or_wait (pTHX_ struct CoroSLF *frame, int acquire) 2929slf_check_semaphore_down_or_wait (pTHX_ struct CoroSLF *frame, int acquire)
2828{ 2930{
2829 AV *av = (AV *)frame->data; 2931 AV *av = (AV *)frame->data;
2830 SV *count_sv = AvARRAY (av)[0]; 2932 SV *count_sv = AvARRAY (av)[0];
2933 SV *coro_hv = SvRV (coro_current);
2831 2934
2832 /* if we are about to throw, don't actually acquire the lock, just throw */ 2935 /* if we are about to throw, don't actually acquire the lock, just throw */
2833 if (CORO_THROW) 2936 if (CORO_THROW)
2834 return 0; 2937 return 0;
2835 else if (SvIVX (count_sv) > 0) 2938 else if (SvIVX (count_sv) > 0)
2847 { 2950 {
2848 int i; 2951 int i;
2849 /* if we were woken up but can't down, we look through the whole */ 2952 /* if we were woken up but can't down, we look through the whole */
2850 /* waiters list and only add us if we aren't in there already */ 2953 /* waiters list and only add us if we aren't in there already */
2851 /* this avoids some degenerate memory usage cases */ 2954 /* this avoids some degenerate memory usage cases */
2852 2955 for (i = AvFILLp (av); i > 0; --i) // i > 0 is not an off-by-one bug
2853 for (i = 1; i <= AvFILLp (av); ++i)
2854 if (AvARRAY (av)[i] == SvRV (coro_current)) 2956 if (AvARRAY (av)[i] == coro_hv)
2855 return 1; 2957 return 1;
2856 2958
2857 av_push (av, SvREFCNT_inc (SvRV (coro_current))); 2959 av_push (av, SvREFCNT_inc (coro_hv));
2858 return 1; 2960 return 1;
2859 } 2961 }
2860} 2962}
2861 2963
2862static int 2964static int
3446 PROTOTYPE: $ 3548 PROTOTYPE: $
3447 ALIAS: 3549 ALIAS:
3448 is_ready = CF_READY 3550 is_ready = CF_READY
3449 is_running = CF_RUNNING 3551 is_running = CF_RUNNING
3450 is_new = CF_NEW 3552 is_new = CF_NEW
3451 is_destroyed = CF_DESTROYED 3553 is_destroyed = CF_ZOMBIE
3554 is_zombie = CF_ZOMBIE
3452 is_suspended = CF_SUSPENDED 3555 is_suspended = CF_SUSPENDED
3453 CODE: 3556 CODE:
3454 RETVAL = boolSV (coro->flags & ix); 3557 RETVAL = boolSV (coro->flags & ix);
3455 OUTPUT: 3558 OUTPUT:
3456 RETVAL 3559 RETVAL
3644void 3747void
3645_destroy (Coro::State coro) 3748_destroy (Coro::State coro)
3646 CODE: 3749 CODE:
3647 /* used by the manager thread */ 3750 /* used by the manager thread */
3648 coro_state_destroy (aTHX_ coro); 3751 coro_state_destroy (aTHX_ coro);
3752
3753void
3754on_destroy (Coro::State coro, SV *cb)
3755 CODE:
3649 coro_call_on_destroy (aTHX_ coro); 3756 coro_push_on_destroy (aTHX_ coro, newSVsv (cb));
3757
3758void
3759join (...)
3760 CODE:
3761 CORO_EXECUTE_SLF_XS (slf_init_join);
3650 3762
3651void 3763void
3652terminate (...) 3764terminate (...)
3653 CODE: 3765 CODE:
3654 CORO_EXECUTE_SLF_XS (slf_init_terminate); 3766 CORO_EXECUTE_SLF_XS (slf_init_terminate);

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines