1 /* This file is part of the Scope::Upper Perl module.
2 * See http://search.cpan.org/dist/Scope-Upper/ */
4 #define PERL_NO_GET_CONTEXT
9 #define __PACKAGE__ "Scope::Upper"
15 /* --- Compatibility ------------------------------------------------------- */
25 #ifndef PERL_UNUSED_VAR
26 # define PERL_UNUSED_VAR(V)
30 # define STMT_START do
34 # define STMT_END while (0)
38 # define SU_D(X) STMT_START X STMT_END
44 # define Newx(v, n, c) New(0, v, n, c)
49 # define SU_POISON(D, N, T) PoisonNew((D), (N), T)
50 # elif defined(Poison)
51 # define SU_POISON(D, N, T) Poison((D), (N), T)
55 # define SU_POISON(D, N, T) NOOP
59 # define SvPV_const(S, L) SvPV(S, L)
62 #ifndef SvPV_nolen_const
63 # define SvPV_nolen_const(S) SvPV_nolen(S)
66 #ifndef SvREFCNT_inc_simple_void
67 # define SvREFCNT_inc_simple_void(sv) SvREFCNT_inc(sv)
71 # define GvCV_set(G, C) (GvCV(G) = (C))
75 # define CvGV_set(C, G) (CvGV(C) = (G))
79 # define CxHASARGS(C) ((C)->blk_sub.hasargs)
83 # define HvNAME_get(H) HvNAME(H)
86 #ifndef gv_fetchpvn_flags
87 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
91 # define cv_clone(P) Perl_cv_clone(aTHX_ (P))
94 #ifndef PERL_MAGIC_tied
95 # define PERL_MAGIC_tied 'P'
98 #ifndef PERL_MAGIC_env
99 # define PERL_MAGIC_env 'E'
102 #ifndef NEGATIVE_INDICES_VAR
103 # define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
106 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
107 #define SU_HAS_PERL_EXACT(R, V, S) ((PERL_REVISION == (R)) && (PERL_VERSION == (V)) && (PERL_SUBVERSION == (S)))
109 /* --- Threads and multiplicity -------------------------------------------- */
111 #ifndef SU_MULTIPLICITY
112 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
113 # define SU_MULTIPLICITY 1
115 # define SU_MULTIPLICITY 0
118 #if SU_MULTIPLICITY && !defined(tTHX)
119 # define tTHX PerlInterpreter*
122 #if SU_MULTIPLICITY && defined(USE_ITHREADS) && defined(dMY_CXT) && defined(MY_CXT) && defined(START_MY_CXT) && defined(MY_CXT_INIT) && (defined(MY_CXT_CLONE) || defined(dMY_CXT_SV))
123 # define SU_THREADSAFE 1
124 # ifndef MY_CXT_CLONE
125 # define MY_CXT_CLONE \
127 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
128 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
129 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
132 # define SU_THREADSAFE 0
134 # define dMY_CXT dNOOP
136 # define MY_CXT su_globaldata
138 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
140 # define MY_CXT_INIT NOOP
142 # define MY_CXT_CLONE NOOP
145 /* --- unwind() global storage --------------------------------------------- */
155 /* --- uplevel() data tokens and global storage ---------------------------- */
165 PERL_SI *old_curstackinfo;
176 STATIC su_uplevel_ud *su_uplevel_ud_new(pTHX) {
177 #define su_uplevel_ud_new() su_uplevel_ud_new(aTHX)
181 Newx(sud, 1, su_uplevel_ud);
184 Newx(si, 1, PERL_SI);
185 si->si_stack = newAV();
186 AvREAL_off(si->si_stack);
187 si->si_cxstack = NULL;
195 STATIC void su_uplevel_ud_delete(pTHX_ su_uplevel_ud *sud) {
196 #define su_uplevel_ud_delete(S) su_uplevel_ud_delete(aTHX_ (S))
197 PERL_SI *si = sud->si;
199 Safefree(si->si_cxstack);
200 SvREFCNT_dec(si->si_stack);
210 } su_uplevel_storage;
212 #ifndef SU_UPLEVEL_STORAGE_SIZE
213 # define SU_UPLEVEL_STORAGE_SIZE 4
216 /* --- Global data --------------------------------------------------------- */
218 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
221 char *stack_placeholder;
222 su_unwind_storage unwind_storage;
223 su_uplevel_storage uplevel_storage;
228 /* --- Stack manipulations ------------------------------------------------- */
230 #define SU_SAVE_PLACEHOLDER() save_pptr(&MY_CXT.stack_placeholder)
232 #define SU_SAVE_DESTRUCTOR_SIZE 3
233 #define SU_SAVE_PLACEHOLDER_SIZE 3
235 #define SU_SAVE_SCALAR_SIZE 3
237 #define SU_SAVE_ARY_SIZE 3
238 #define SU_SAVE_AELEM_SIZE 4
240 # define SU_SAVE_ADELETE_SIZE 3
242 # define SU_SAVE_ADELETE_SIZE SU_SAVE_DESTRUCTOR_SIZE
244 #if SU_SAVE_AELEM_SIZE < SU_SAVE_ADELETE_SIZE
245 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_ADELETE_SIZE
247 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_AELEM_SIZE
250 #define SU_SAVE_HASH_SIZE 3
251 #define SU_SAVE_HELEM_SIZE 4
252 #define SU_SAVE_HDELETE_SIZE 4
253 #if SU_SAVE_HELEM_SIZE < SU_SAVE_HDELETE_SIZE
254 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HDELETE_SIZE
256 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HELEM_SIZE
259 #define SU_SAVE_GVCV_SIZE SU_SAVE_DESTRUCTOR_SIZE
261 #if !SU_HAS_PERL(5, 8, 9)
262 # define SU_SAVE_GP_SIZE 6
263 #elif !SU_HAS_PERL(5, 13, 0) || (SU_RELEASE && SU_HAS_PERL_EXACT(5, 13, 0))
264 # define SU_SAVE_GP_SIZE 3
265 #elif !SU_HAS_PERL(5, 13, 8)
266 # define SU_SAVE_GP_SIZE 4
268 # define SU_SAVE_GP_SIZE 3
271 #ifndef SvCANEXISTDELETE
272 # define SvCANEXISTDELETE(sv) \
274 || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied)) \
275 && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
276 && gv_fetchmethod_autoload(stash, "EXISTS", TRUE) \
277 && gv_fetchmethod_autoload(stash, "DELETE", TRUE) \
282 /* ... Saving array elements ............................................... */
284 STATIC I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
285 #define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
291 /* Added by MJD in perl-5.8.1 with 6f12eb6d2a1dfaf441504d869b27d2e40ef4966a */
292 #if SU_HAS_PERL(5, 8, 1)
293 if (SvRMAGICAL(av)) {
294 const MAGIC * const tied_magic = mg_find((SV *) av, PERL_MAGIC_tied);
296 SV * const * const negative_indices_glob =
297 hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
298 NEGATIVE_INDICES_VAR, 16, 0);
299 if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
305 idx = key + av_len(av) + 1;
319 STATIC void su_adelete(pTHX_ void *ud_) {
320 su_ud_adelete *ud = (su_ud_adelete *) ud_;
322 av_delete(ud->av, ud->idx, G_DISCARD);
323 SvREFCNT_dec(ud->av);
328 STATIC void su_save_adelete(pTHX_ AV *av, I32 idx) {
329 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
332 Newx(ud, 1, su_ud_adelete);
335 SvREFCNT_inc_simple_void(av);
337 SAVEDESTRUCTOR_X(su_adelete, ud);
340 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
342 #endif /* SAVEADELETE */
344 STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
345 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
352 idx = su_av_key2idx(av, SvIV(key));
354 if (SvCANEXISTDELETE(av))
355 preeminent = av_exists(av, idx);
357 svp = av_fetch(av, idx, 1);
358 if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
361 save_aelem(av, idx, svp);
363 SAVEADELETE(av, idx);
365 if (val) { /* local $x[$idx] = $val; */
366 SvSetMagicSV(*svp, val);
367 } else { /* local $x[$idx]; delete $x[$idx]; */
368 av_delete(av, idx, G_DISCARD);
372 /* ... Saving hash elements ................................................ */
374 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
375 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
382 if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
383 preeminent = hv_exists_ent(hv, keysv, 0);
385 he = hv_fetch_ent(hv, keysv, 1, 0);
386 svp = he ? &HeVAL(he) : NULL;
387 if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
389 if (HvNAME_get(hv) && isGV(*svp)) {
390 save_gp((GV *) *svp, 0);
395 save_helem(hv, keysv, svp);
398 const char * const key = SvPV_const(keysv, keylen);
399 SAVEDELETE(hv, savepvn(key, keylen),
400 SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
403 if (val) { /* local $x{$keysv} = $val; */
404 SvSetMagicSV(*svp, val);
405 } else { /* local $x{$keysv}; delete $x{$keysv}; */
406 (void)hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
410 /* ... Saving code slots from a glob ....................................... */
412 #if !SU_HAS_PERL(5, 10, 0) && !defined(mro_method_changed_in)
413 # define mro_method_changed_in(G) PL_sub_generation++
421 STATIC void su_restore_gvcv(pTHX_ void *ud_) {
422 su_save_gvcv_ud *ud = ud_;
425 GvCV_set(gv, ud->old_cv);
427 mro_method_changed_in(GvSTASH(gv));
432 STATIC void su_save_gvcv(pTHX_ GV *gv) {
433 #define su_save_gvcv(G) su_save_gvcv(aTHX_ (G))
436 Newx(ud, 1, su_save_gvcv_ud);
438 ud->old_cv = GvCV(gv);
442 mro_method_changed_in(GvSTASH(gv));
444 SAVEDESTRUCTOR_X(su_restore_gvcv, ud);
447 /* --- Actions ------------------------------------------------------------- */
453 void (*handler)(pTHX_ void *);
456 #define SU_UD_DEPTH(U) (((su_ud_common *) (U))->depth)
457 #define SU_UD_PAD(U) (((su_ud_common *) (U))->pad)
458 #define SU_UD_ORIGIN(U) (((su_ud_common *) (U))->origin)
459 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
461 #define SU_UD_FREE(U) STMT_START { \
462 if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
466 /* ... Reap ................................................................ */
473 STATIC void su_call(pTHX_ void *ud_) {
474 su_ud_reap *ud = (su_ud_reap *) ud_;
475 #if SU_HAS_PERL(5, 9, 5)
476 PERL_CONTEXT saved_cx;
483 PerlIO_printf(Perl_debug_log,
484 "%p: @@@ call\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
485 ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
494 /* If the recently popped context isn't saved there, it will be overwritten by
495 * the sub scope from call_sv, although it's still needed in our caller. */
497 #if SU_HAS_PERL(5, 9, 5)
498 if (cxstack_ix < cxstack_max)
499 cxix = cxstack_ix + 1;
501 cxix = Perl_cxinc(aTHX);
502 saved_cx = cxstack[cxix];
505 call_sv(ud->cb, G_VOID);
507 #if SU_HAS_PERL(5, 9, 5)
508 cxstack[cxix] = saved_cx;
516 SvREFCNT_dec(ud->cb);
520 STATIC void su_reap(pTHX_ void *ud) {
521 #define su_reap(U) su_reap(aTHX_ (U))
523 PerlIO_printf(Perl_debug_log,
524 "%p: === reap\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
525 ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
528 SAVEDESTRUCTOR_X(su_call, ud);
531 /* ... Localize & localize array/hash element .............................. */
541 #define SU_UD_LOCALIZE_FREE(U) STMT_START { \
542 SvREFCNT_dec((U)->elem); \
543 SvREFCNT_dec((U)->val); \
544 SvREFCNT_dec((U)->sv); \
548 STATIC I32 su_ud_localize_init(pTHX_ su_ud_localize *ud, SV *sv, SV *val, SV *elem) {
549 #define su_ud_localize_init(UD, S, V, E) su_ud_localize_init(aTHX_ (UD), (S), (V), (E))
554 SvREFCNT_inc_simple_void(sv);
556 if (SvTYPE(sv) >= SVt_PVGV) {
557 if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
559 } else { /* local *x = \$val; */
560 t = SvTYPE(SvRV(val));
563 } else if (SvROK(sv)) {
564 croak("Invalid %s reference as the localization target",
565 sv_reftype(SvRV(sv), 0));
568 const char *p = SvPV_const(sv, len), *s;
569 for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
575 case '$': t = SVt_PV; break;
576 case '@': t = SVt_PVAV; break;
577 case '%': t = SVt_PVHV; break;
578 case '&': t = SVt_PVCV; break;
579 case '*': t = SVt_PVGV; break;
584 } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
585 if (SvROK(val) && !sv_isobject(val)) {
586 t = SvTYPE(SvRV(val));
598 size = elem ? SU_SAVE_AELEM_OR_ADELETE_SIZE
603 size = elem ? SU_SAVE_HELEM_OR_HDELETE_SIZE
608 size = SU_SAVE_GP_SIZE;
612 size = SU_SAVE_GVCV_SIZE;
616 size = SU_SAVE_SCALAR_SIZE;
619 /* When deref is set, val isn't NULL */
622 ud->val = val ? newSVsv(deref ? SvRV(val) : val) : NULL;
623 ud->elem = SvREFCNT_inc(elem);
629 STATIC void su_localize(pTHX_ void *ud_) {
630 #define su_localize(U) su_localize(aTHX_ (U))
631 su_ud_localize *ud = (su_ud_localize *) ud_;
638 if (SvTYPE(sv) >= SVt_PVGV) {
642 gv = gv_fetchsv(sv, GV_ADDMULTI, t);
645 const char *name = SvPV_const(sv, len);
646 gv = gv_fetchpvn_flags(name, len, GV_ADDMULTI, t);
653 PerlIO_printf(Perl_debug_log, "%p: === localize a %s\n",ud, sv_reftype(z, 0));
654 PerlIO_printf(Perl_debug_log,
655 "%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
656 ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
660 /* Inspired from Alias.pm */
664 su_save_aelem(GvAV(gv), elem, val);
671 su_save_helem(GvHV(gv), elem, val);
677 save_gp(gv, 1); /* hide previous entry in symtab */
683 gv = (GV *) save_scalar(gv);
688 SvSetMagicSV((SV *) gv, val);
691 SU_UD_LOCALIZE_FREE(ud);
694 /* --- Pop a context back -------------------------------------------------- */
698 # define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
700 # define SU_CXNAME "XXX"
704 STATIC void su_pop(pTHX_ void *ud) {
705 #define su_pop(U) su_pop(aTHX_ (U))
706 I32 depth, base, mark, *origin;
707 depth = SU_UD_DEPTH(ud);
710 PerlIO_printf(Perl_debug_log,
712 "%p: leave scope at depth=%2d scope_ix=%2d cur_top=%2d cur_base=%2d\n",
714 ud, depth, PL_scopestack_ix,PL_savestack_ix,PL_scopestack[PL_scopestack_ix])
717 origin = SU_UD_ORIGIN(ud);
718 mark = origin[depth];
719 base = origin[depth - 1];
721 SU_D(PerlIO_printf(Perl_debug_log,
722 "%p: original scope was %*c top=%2d base=%2d\n",
723 ud, 24, ' ', mark, base));
726 SU_D(PerlIO_printf(Perl_debug_log, "%p: clear leftovers\n", ud));
727 PL_savestack_ix = mark;
730 PL_savestack_ix = base;
732 SU_UD_DEPTH(ud) = --depth;
737 if ((pad = SU_UD_PAD(ud))) {
740 SU_D(PerlIO_printf(Perl_debug_log,
741 "%p: push a pad slot at depth=%2d scope_ix=%2d save_ix=%2d\n",
742 ud, depth, PL_scopestack_ix, PL_savestack_ix));
743 SU_SAVE_PLACEHOLDER();
747 SU_D(PerlIO_printf(Perl_debug_log,
748 "%p: push destructor at depth=%2d scope_ix=%2d save_ix=%2d\n",
749 ud, depth, PL_scopestack_ix, PL_savestack_ix));
750 SAVEDESTRUCTOR_X(su_pop, ud);
752 SU_UD_HANDLER(ud)(aTHX_ ud);
755 SU_D(PerlIO_printf(Perl_debug_log,
756 "%p: --- end pop: cur_top=%2d == cur_base=%2d\n",
757 ud, PL_savestack_ix, PL_scopestack[PL_scopestack_ix]));
760 /* --- Initialize the stack and the action userdata ------------------------ */
762 STATIC I32 su_init(pTHX_ void *ud, I32 cxix, I32 size) {
763 #define su_init(U, C, S) su_init(aTHX_ (U), (C), (S))
764 I32 i, depth = 1, pad, offset, *origin;
766 SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
768 if (size <= SU_SAVE_DESTRUCTOR_SIZE)
771 I32 extra = size - SU_SAVE_DESTRUCTOR_SIZE;
772 pad = extra / SU_SAVE_PLACEHOLDER_SIZE;
773 if (extra % SU_SAVE_PLACEHOLDER_SIZE)
776 offset = SU_SAVE_DESTRUCTOR_SIZE + SU_SAVE_PLACEHOLDER_SIZE * pad;
778 SU_D(PerlIO_printf(Perl_debug_log, "%p: size=%d pad=%d offset=%d\n",
779 ud, size, pad, offset));
781 for (i = cxstack_ix; i > cxix; --i) {
782 PERL_CONTEXT *cx = cxstack + i;
783 switch (CxTYPE(cx)) {
784 #if SU_HAS_PERL(5, 10, 0)
786 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is block\n", ud, i));
787 /* Given and when blocks are actually followed by a simple block, so skip
789 if (cxix > 0) { /* Implies i > 0 */
790 PERL_CONTEXT *next = cx - 1;
791 if (CxTYPE(next) == CXt_GIVEN || CxTYPE(next) == CXt_WHEN)
797 #if SU_HAS_PERL(5, 11, 0)
800 case CXt_LOOP_LAZYSV:
801 case CXt_LOOP_LAZYIV:
805 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
809 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is other\n", ud, i));
814 SU_D(PerlIO_printf(Perl_debug_log, "%p: going down to depth %d\n", ud, depth));
816 Newx(origin, depth + 1, I32);
817 origin[0] = PL_scopestack[PL_scopestack_ix - depth];
818 PL_scopestack[PL_scopestack_ix - depth] += size;
819 for (i = depth - 1; i >= 1; --i) {
820 I32 j = PL_scopestack_ix - i;
821 origin[depth - i] = PL_scopestack[j];
822 PL_scopestack[j] += offset;
824 origin[depth] = PL_savestack_ix;
826 SU_UD_ORIGIN(ud) = origin;
827 SU_UD_DEPTH(ud) = depth;
830 /* Make sure the first destructor fires by pushing enough fake slots on the
832 if (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
833 <= PL_scopestack[PL_scopestack_ix - 1]) {
836 SU_D(PerlIO_printf(Perl_debug_log,
837 "%p: push a fake slot at scope_ix=%2d save_ix=%2d\n",
838 ud, PL_scopestack_ix, PL_savestack_ix));
839 SU_SAVE_PLACEHOLDER();
840 } while (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
841 <= PL_scopestack[PL_scopestack_ix - 1]);
843 SU_D(PerlIO_printf(Perl_debug_log,
844 "%p: push first destructor at scope_ix=%2d save_ix=%2d\n",
845 ud, PL_scopestack_ix, PL_savestack_ix));
846 SAVEDESTRUCTOR_X(su_pop, ud);
849 for (i = 0; i <= depth; ++i) {
850 I32 j = PL_scopestack_ix - i;
851 PerlIO_printf(Perl_debug_log,
852 "%p: depth=%2d scope_ix=%2d saved_floor=%2d new_floor=%2d\n",
853 ud, i, j, origin[depth - i],
854 i == 0 ? PL_savestack_ix : PL_scopestack[j]);
861 /* --- Unwind stack -------------------------------------------------------- */
863 STATIC void su_unwind(pTHX_ void *ud_) {
865 I32 cxix = MY_CXT.unwind_storage.cxix;
866 I32 items = MY_CXT.unwind_storage.items - 1;
867 SV **savesp = MY_CXT.unwind_storage.savesp;
870 PERL_UNUSED_VAR(ud_);
873 PL_stack_sp = savesp;
875 if (cxstack_ix > cxix)
882 mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
883 *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
887 PerlIO_printf(Perl_debug_log,
888 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
890 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
891 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
894 PL_op = (OP *) &(MY_CXT.unwind_storage.return_op);
895 PL_op = PL_op->op_ppaddr(aTHX);
897 *PL_markstack_ptr = mark;
899 MY_CXT.unwind_storage.proxy_op.op_next = PL_op;
900 PL_op = &(MY_CXT.unwind_storage.proxy_op);
903 /* --- Uplevel ------------------------------------------------------------- */
905 #ifndef OP_GIMME_REVERSE
906 STATIC U8 su_op_gimme_reverse(U8 gimme) {
909 return OPf_WANT_VOID;
911 return OPf_WANT_LIST;
916 return OPf_WANT_SCALAR;
918 #define OP_GIMME_REVERSE(G) su_op_gimme_reverse(G)
921 #define SU_UPLEVEL_SAVE(f, t) STMT_START { sud->old_##f = PL_##f; PL_##f = (t); } STMT_END
922 #define SU_UPLEVEL_RESTORE(f) STMT_START { PL_##f = sud->old_##f; } STMT_END
924 STATIC su_uplevel_ud *su_uplevel_storage_new(pTHX) {
925 #define su_uplevel_storage_new() su_uplevel_storage_new(aTHX)
929 sud = MY_CXT.uplevel_storage.root;
931 MY_CXT.uplevel_storage.root = sud->next;
932 MY_CXT.uplevel_storage.count--;
934 sud = su_uplevel_ud_new();
940 STATIC void su_uplevel_storage_delete(pTHX_ su_uplevel_ud *sud) {
941 #define su_uplevel_storage_delete(S) su_uplevel_storage_delete(aTHX_ (S))
944 if (MY_CXT.uplevel_storage.count >= SU_UPLEVEL_STORAGE_SIZE) {
945 su_uplevel_ud_delete(sud);
947 sud->next = MY_CXT.uplevel_storage.root;
948 MY_CXT.uplevel_storage.root = sud;
949 MY_CXT.uplevel_storage.count++;
953 #define SU_HAS_EXT_MAGIC SU_HAS_PERL(5, 8, 0)
957 STATIC int su_uplevel_restore_free(pTHX_ SV *sv, MAGIC *mg) {
958 su_uplevel_storage_delete((su_uplevel_ud *) mg->mg_ptr);
963 STATIC MGVTBL su_uplevel_restore_vtbl = {
968 su_uplevel_restore_free
971 #endif /* SU_HAS_EXT_MAGIC */
973 STATIC void su_uplevel_restore(pTHX_ void *sus_) {
974 su_uplevel_ud *sud = sus_;
975 PERL_SI *cur = sud->old_curstackinfo;
976 PERL_SI *si = sud->si;
978 /* When we reach this place, POPSUB has already been called (with our fake
979 * argarray). GvAV(PL_defgv) points to the savearray (that is, what @_ was
980 * before uplevel). argarray is either the fake AV we created in su_uplevel()
981 * or some empty replacement POPSUB creates when @_ is reified. In both cases
982 * we have to destroy it before the context stack is swapped back to its
984 SvREFCNT_dec(cxstack[sud->cxix].blk_sub.argarray);
986 CATCH_SET(sud->old_catch);
988 SvREFCNT_dec(sud->cloned_cv);
990 SU_UPLEVEL_RESTORE(op);
992 /* stack_grow() wants PL_curstack so restore the old stack first */
993 if (PL_curstackinfo == si) {
994 PL_curstack = cur->si_stack;
995 if (sud->old_mainstack)
996 SU_UPLEVEL_RESTORE(mainstack);
997 SU_UPLEVEL_RESTORE(curstackinfo);
1000 CV *target_cv = sud->target;
1003 /* When we die, the depth of the target CV is not updated because of the
1004 * stack switcheroo. So we have to look at all the frames between the
1005 * uplevel call and the catch block to count how many call frames to the
1006 * target CV were skipped. */
1007 for (i = cur->si_cxix; i > sud->cxix; i--) {
1008 register const PERL_CONTEXT *cx = cxstack + i;
1010 if (CxTYPE(cx) == CXt_SUB) {
1011 if (cx->blk_sub.cv == target_cv)
1016 /* If we died, the replacement stack was already unwinded to the first
1017 * eval frame, and all the contexts down there were popped. We don't have
1018 * to pop manually any context of the original stack, because they must
1019 * have been in the replacement stack as well (since the second was copied
1020 * from the first). Thus we only have to make sure the original stack index
1021 * points to the context just below the first eval scope under the target
1023 for (; i >= 0; i--) {
1024 register const PERL_CONTEXT *cx = cxstack + i;
1026 switch (CxTYPE(cx)) {
1028 if (cx->blk_sub.cv == target_cv)
1040 CvDEPTH(target_cv) = sud->old_depth - levels;
1041 PL_curstackinfo->si_cxix = i - 1;
1043 #if !SU_HAS_PERL(5, 13, 1)
1044 /* Since $@ was maybe localized between the target frame and the uplevel
1045 * call, we forcefully flush the save stack to get rid of it and then
1046 * reset $@ to its proper value. Note that the the call to
1047 * su_uplevel_restore() must happen before the "reset $@" item of the save
1048 * stack is processed, as uplevel was called after the localization.
1049 * Andrew's changes to how $@ was handled, which were mainly integrated
1050 * between perl 5.13.0 and 5.13.1, fixed this. */
1051 if (ERRSV && SvTRUE(ERRSV)) {
1052 register const PERL_CONTEXT *cx = cxstack + i; /* This is the eval scope */
1053 SV *errsv = SvREFCNT_inc(ERRSV);
1054 PL_scopestack_ix = cx->blk_oldscopesp;
1055 leave_scope(PL_scopestack[PL_scopestack_ix]);
1056 sv_setsv(ERRSV, errsv);
1057 SvREFCNT_dec(errsv);
1063 SU_UPLEVEL_RESTORE(curcop);
1065 SvREFCNT_dec(sud->target);
1067 PL_stack_base = AvARRAY(cur->si_stack);
1068 PL_stack_sp = PL_stack_base + AvFILLp(cur->si_stack);
1069 PL_stack_max = PL_stack_base + AvMAX(cur->si_stack);
1071 /* When an exception is thrown from the uplevel'd subroutine,
1072 * su_uplevel_restore() may be called by the LEAVE in die_unwind() (renamed
1073 * die_where() in more recent perls), which has the sad habit of keeping a
1074 * pointer to the current context frame across this call. This means that we
1075 * can't free the temporary context stack we used for the uplevel call right
1076 * now, or that pointer upwards would point to garbage. */
1077 #if SU_HAS_PERL(5, 13, 7)
1078 /* This issue has been fixed in perl with commit 8f89e5a9, which was made
1079 * public in perl 5.13.7. */
1080 su_uplevel_storage_delete(sud);
1081 #elif SU_HAS_EXT_MAGIC
1082 /* If 'ext' magic is available, we work around this by attaching the state
1083 * data to a scalar that will be freed "soon". */
1085 SV *sv = sv_newmortal();
1087 sv_magicext(sv, NULL, PERL_MAGIC_ext, &su_uplevel_restore_vtbl,
1088 (const char *) sud, 0);
1091 /* Otherwise, we just enqueue it back in the global storage list. */
1095 sud->next = MY_CXT.uplevel_storage.root;
1096 MY_CXT.uplevel_storage.root = sud;
1097 MY_CXT.uplevel_storage.count++;
1104 STATIC CV *su_cv_clone(pTHX_ CV *old_cv) {
1105 #define su_cv_clone(C) su_cv_clone(aTHX_ (C))
1108 /* Starting from commit b5c19bd7 (first made public with perl 5.9.0),
1109 * cv_clone() has an assert that checks whether CvDEPTH(CvOUTSIDE(proto)) > 0.
1110 * If this perl has DEBUGGING enabled, we have to fool cv_clone() with a
1112 #if defined(DEBUGGING) && SU_HAS_PERL(5, 9, 0)
1114 CV *outside = CvOUTSIDE(old_cv);
1116 if (outside && CvCLONE(outside) && !CvCLONED(outside))
1117 outside = find_runcv(NULL);
1118 old_depth = CvDEPTH(outside);
1120 CvDEPTH(outside) = 1;
1123 new_cv = cv_clone(old_cv);
1125 #if defined(DEBUGGING) && SU_HAS_PERL(5, 9, 0)
1126 CvDEPTH(outside) = old_depth;
1129 /* Still from commit b5c19bd7, cv_clone() is no longer able to clone named
1130 * subs propery. With this commit, pad_findlex() stores the parent index of a
1131 * fake pad entry in the NV slot of the corresponding pad name SV, but only
1132 * for anonymous subs (since named subs aren't supposed to be cloned in pure
1133 * Perl land). To fix this, we just manually relink the new fake pad entries
1135 * For some reason perl 5.8 crashes too without this, supposedly because of
1136 * other closure bugs. Hence we enable it everywhere. */
1137 if (!CvCLONE(old_cv)) {
1138 const AV *old_padname = (const AV *) AvARRAY(CvPADLIST(old_cv))[0];
1139 AV *old_pad = (AV *) AvARRAY(CvPADLIST(old_cv))[1];
1140 AV *new_pad = (AV *) AvARRAY(CvPADLIST(new_cv))[1];
1141 const SV **old_aryname = (const SV **) AvARRAY(old_padname);
1142 SV **old_ary = AvARRAY(old_pad);
1143 SV **new_ary = AvARRAY(new_pad);
1144 I32 fname = AvFILLp(old_padname);
1145 I32 fpad = AvFILLp(old_pad);
1148 for (ix = fpad; ix > 0; ix--) {
1149 const SV *namesv = (ix <= fname) ? old_aryname[ix] : NULL;
1151 if (namesv && namesv != &PL_sv_undef && SvFAKE(namesv)) {
1152 SvREFCNT_dec(new_ary[ix]);
1153 new_ary[ix] = SvREFCNT_inc(old_ary[ix]);
1161 STATIC I32 su_uplevel(pTHX_ CV *cv, I32 cxix, I32 args) {
1162 #define su_uplevel(C, I, A) su_uplevel(aTHX_ (C), (I), (A))
1164 const PERL_CONTEXT *cx = cxstack + cxix;
1166 PERL_SI *cur = PL_curstackinfo;
1172 I32 old_mark, new_mark;
1179 /* Make PL_stack_sp point just before the CV. */
1180 PL_stack_sp -= args + 1;
1181 old_mark = AvFILLp(PL_curstack) = PL_stack_sp - PL_stack_base;
1184 sud = su_uplevel_storage_new();
1189 SAVEDESTRUCTOR_X(su_uplevel_restore, sud);
1191 si->si_type = cur->si_type;
1193 si->si_prev = cur->si_prev;
1195 /* Allocate enough space for all the elements of the original stack up to the
1196 * target context, plus the forthcoming arguments. */
1197 new_mark = cx->blk_oldsp;
1198 av_extend(si->si_stack, new_mark + 1 + args + 1);
1199 Copy(PL_curstack, AvARRAY(si->si_stack), new_mark + 1, SV *);
1200 AvFILLp(si->si_stack) = new_mark;
1201 SU_POISON(AvARRAY(si->si_stack) + new_mark + 1, args + 1, SV *);
1203 /* Specialized SWITCHSTACK() */
1204 PL_stack_base = AvARRAY(si->si_stack);
1205 old_stack_sp = PL_stack_sp;
1206 PL_stack_sp = PL_stack_base + AvFILLp(si->si_stack);
1207 PL_stack_max = PL_stack_base + AvMAX(si->si_stack);
1211 si->si_markoff = cx->blk_oldmarksp;
1214 /* Copy the context stack up to the context just below the target. */
1215 si->si_cxix = (cxix < 0) ? -1 : (cxix - 1);
1216 if (si->si_cxmax < cxix) {
1217 /* The max size must be at least two so that GROW(max) = (max*3)/2 > max */
1218 si->si_cxmax = (cxix < 4) ? 4 : cxix;
1219 Renew(si->si_cxstack, si->si_cxmax + 1, PERL_CONTEXT);
1221 Copy(cur->si_cxstack, si->si_cxstack, cxix, PERL_CONTEXT);
1222 SU_POISON(si->si_cxstack + cxix, si->si_cxmax + 1 - cxix, PERL_CONTEXT);
1224 target_cv = cx->blk_sub.cv;
1225 sud->target = (CV *) SvREFCNT_inc(target_cv);
1226 sud->old_depth = CvDEPTH(target_cv);
1228 /* blk_oldcop is essentially needed for caller() and stack traces. It has no
1229 * run-time implication, since PL_curcop will be overwritten as soon as we
1230 * enter a sub (a sub starts by a nextstate/dbstate). Hence it's safe to just
1231 * make it point to the blk_oldcop for the target frame, so that caller()
1232 * reports the right file name, line number and lexical hints. */
1233 SU_UPLEVEL_SAVE(curcop, cx->blk_oldcop);
1234 /* Don't reset PL_markstack_ptr, or we would overwrite the mark stack below
1235 * this point. Don't reset PL_curpm either, we want the most recent matches. */
1237 SU_UPLEVEL_SAVE(curstackinfo, si);
1238 /* If those two are equal, we need to fool POPSTACK_TO() */
1239 if (PL_mainstack == PL_curstack)
1240 SU_UPLEVEL_SAVE(mainstack, si->si_stack);
1242 sud->old_mainstack = NULL;
1243 PL_curstack = si->si_stack;
1245 cv = su_cv_clone(cv);
1246 sud->cloned_cv = cv;
1247 CvGV_set(cv, CvGV(target_cv));
1250 /* Both SP and old_stack_sp point just before the CV. */
1251 Copy(old_stack_sp + 2, SP + 1, args, SV *);
1256 Zero(&sub_op, 1, UNOP);
1257 sub_op.op_type = OP_ENTERSUB;
1258 sub_op.op_next = NULL;
1259 sub_op.op_flags = OP_GIMME_REVERSE(gimme) | OPf_STACKED;
1261 sub_op.op_flags |= OPpENTERSUB_DB;
1263 SU_UPLEVEL_SAVE(op, (OP *) &sub_op);
1265 sud->old_catch = CATCH_GET;
1268 if (PL_op = PL_ppaddr[OP_ENTERSUB](aTHX)) {
1269 if (CxHASARGS(cx) && cx->blk_sub.argarray) {
1270 /* The call to pp_entersub() has saved the current @_ (in XS terms,
1271 * GvAV(PL_defgv)) in the savearray member, and has created a new argarray
1272 * with what we put on the stack. But we want to fake up the same arguments
1273 * as the ones in use at the context we uplevel to, so we replace the
1274 * argarray with an unreal copy of the original @_. */
1277 av_extend(av, AvMAX(cx->blk_sub.argarray));
1278 AvFILLp(av) = AvFILLp(cx->blk_sub.argarray);
1279 Copy(AvARRAY(cx->blk_sub.argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
1280 cxstack[cxix].blk_sub.argarray = av;
1282 SvREFCNT_inc(cxstack[cxix].blk_sub.argarray);
1287 ret = PL_stack_sp - (PL_stack_base + new_mark);
1295 AV *old_stack = sud->old_curstackinfo->si_stack;
1297 if (old_mark + ret > AvMAX(old_stack)) {
1298 /* Specialized EXTEND(old_sp, ret) */
1299 av_extend(old_stack, old_mark + ret + 1);
1300 old_stack_sp = AvARRAY(old_stack) + old_mark;
1303 Copy(PL_stack_sp - ret + 1, old_stack_sp + 1, ret, SV *);
1305 AvFILLp(old_stack) += ret;
1315 /* --- Interpreter setup/teardown ------------------------------------------ */
1317 STATIC void su_teardown(pTHX_ void *param) {
1318 su_uplevel_ud *cur, *prev;
1321 cur = MY_CXT.uplevel_storage.root;
1323 su_uplevel_ud *prev;
1327 su_uplevel_ud_delete(prev);
1334 STATIC void su_setup(pTHX) {
1335 #define su_setup() su_setup(aTHX)
1338 MY_CXT.stack_placeholder = NULL;
1340 /* NewOp() calls calloc() which just zeroes the memory with memset(). */
1341 Zero(&(MY_CXT.unwind_storage.return_op), 1, LISTOP);
1342 MY_CXT.unwind_storage.return_op.op_type = OP_RETURN;
1343 MY_CXT.unwind_storage.return_op.op_ppaddr = PL_ppaddr[OP_RETURN];
1345 Zero(&(MY_CXT.unwind_storage.proxy_op), 1, OP);
1346 MY_CXT.unwind_storage.proxy_op.op_type = OP_STUB;
1347 MY_CXT.unwind_storage.proxy_op.op_ppaddr = NULL;
1349 MY_CXT.uplevel_storage.root = NULL;
1350 MY_CXT.uplevel_storage.count = 0;
1352 call_atexit(su_teardown, NULL);
1357 /* --- XS ------------------------------------------------------------------ */
1359 #if SU_HAS_PERL(5, 8, 9)
1360 # define SU_SKIP_DB_MAX 2
1362 # define SU_SKIP_DB_MAX 3
1365 /* Skip context sequences of 1 to SU_SKIP_DB_MAX (included) block contexts
1366 * followed by a DB sub */
1368 #define SU_SKIP_DB(C) \
1371 PERL_CONTEXT *base = cxstack; \
1372 PERL_CONTEXT *cx = base + (C); \
1373 while (cx >= base && (C) > skipped && CxTYPE(cx) == CXt_BLOCK) \
1375 if (cx >= base && (C) > skipped) { \
1376 switch (CxTYPE(cx)) { \
1378 if (skipped <= SU_SKIP_DB_MAX && cx->blk_sub.cv == GvCV(PL_DBsub)) \
1379 (C) -= skipped + 1; \
1387 #define SU_GET_CONTEXT(A, B) \
1396 else if (cxix > cxstack_ix) \
1397 cxix = cxstack_ix; \
1400 cxix = cxstack_ix; \
1406 #define SU_GET_LEVEL(A, B) \
1412 level = SvIV(lsv); \
1419 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
1421 XS(XS_Scope__Upper_unwind) {
1430 PERL_UNUSED_VAR(cv); /* -W */
1431 PERL_UNUSED_VAR(ax); /* -Wall */
1433 SU_GET_CONTEXT(0, items - 1);
1435 PERL_CONTEXT *cx = cxstack + cxix;
1436 switch (CxTYPE(cx)) {
1438 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
1442 MY_CXT.unwind_storage.cxix = cxix;
1443 MY_CXT.unwind_storage.items = items;
1444 /* pp_entersub will want to sanitize the stack after returning from there
1445 * Screw that, we're insane */
1446 if (GIMME_V == G_SCALAR) {
1447 MY_CXT.unwind_storage.savesp = PL_stack_sp;
1448 /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
1449 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
1451 MY_CXT.unwind_storage.savesp = NULL;
1453 SAVEDESTRUCTOR_X(su_unwind, NULL);
1458 } while (--cxix >= 0);
1459 croak("Can't return outside a subroutine");
1462 MODULE = Scope::Upper PACKAGE = Scope::Upper
1470 stash = gv_stashpv(__PACKAGE__, 1);
1471 newCONSTSUB(stash, "TOP", newSViv(0));
1472 newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(SU_THREADSAFE));
1474 newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
1487 MY_CXT.uplevel_storage.root = NULL;
1488 MY_CXT.uplevel_storage.count = 0;
1492 #endif /* SU_THREADSAFE */
1498 I32 cxix = cxstack_ix;
1502 RETVAL = newSViv(cxix);
1512 SU_GET_CONTEXT(0, 0);
1517 RETVAL = newSViv(cxix);
1527 SU_GET_CONTEXT(0, 0);
1528 for (; cxix >= 0; --cxix) {
1529 PERL_CONTEXT *cx = cxstack + cxix;
1530 switch (CxTYPE(cx)) {
1534 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
1536 ST(0) = sv_2mortal(newSViv(cxix));
1548 SU_GET_CONTEXT(0, 0);
1549 for (; cxix >= 0; --cxix) {
1550 PERL_CONTEXT *cx = cxstack + cxix;
1551 switch (CxTYPE(cx)) {
1555 ST(0) = sv_2mortal(newSViv(cxix));
1582 ST(0) = sv_2mortal(newSViv(cxix));
1592 for (cxix = cxstack_ix; cxix > 0; --cxix) {
1593 PERL_CONTEXT *cx = cxstack + cxix;
1594 switch (CxTYPE(cx)) {
1596 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
1606 ST(0) = sv_2mortal(newSViv(cxix));
1615 SU_GET_CONTEXT(0, 0);
1617 PERL_CONTEXT *cx = cxstack + cxix--;
1618 switch (CxTYPE(cx)) {
1622 I32 gimme = cx->blk_gimme;
1624 case G_VOID: XSRETURN_UNDEF; break;
1625 case G_SCALAR: XSRETURN_NO; break;
1626 case G_ARRAY: XSRETURN_YES; break;
1641 SU_GET_CONTEXT(1, 1);
1642 Newx(ud, 1, su_ud_reap);
1643 SU_UD_ORIGIN(ud) = NULL;
1644 SU_UD_HANDLER(ud) = su_reap;
1645 ud->cb = newSVsv(hook);
1646 su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
1649 localize(SV *sv, SV *val, ...)
1656 SU_GET_CONTEXT(2, 2);
1657 Newx(ud, 1, su_ud_localize);
1658 SU_UD_ORIGIN(ud) = NULL;
1659 SU_UD_HANDLER(ud) = su_localize;
1660 size = su_ud_localize_init(ud, sv, val, NULL);
1661 su_init(ud, cxix, size);
1664 localize_elem(SV *sv, SV *elem, SV *val, ...)
1671 if (SvTYPE(sv) >= SVt_PVGV)
1672 croak("Can't infer the element localization type from a glob and the value");
1673 SU_GET_CONTEXT(3, 3);
1674 Newx(ud, 1, su_ud_localize);
1675 SU_UD_ORIGIN(ud) = NULL;
1676 SU_UD_HANDLER(ud) = su_localize;
1677 size = su_ud_localize_init(ud, sv, val, elem);
1678 if (ud->type != SVt_PVAV && ud->type != SVt_PVHV) {
1679 SU_UD_LOCALIZE_FREE(ud);
1680 croak("Can't localize an element of something that isn't an array or a hash");
1682 su_init(ud, cxix, size);
1685 localize_delete(SV *sv, SV *elem, ...)
1692 SU_GET_CONTEXT(2, 2);
1693 Newx(ud, 1, su_ud_localize);
1694 SU_UD_ORIGIN(ud) = NULL;
1695 SU_UD_HANDLER(ud) = su_localize;
1696 size = su_ud_localize_init(ud, sv, NULL, elem);
1697 su_init(ud, cxix, size);
1700 uplevel(SV *code, ...)
1703 I32 cxix, ret, args = 0;
1707 if (SvTYPE(code) < SVt_PVCV)
1708 croak("First argument to uplevel must be a code reference");
1709 SU_GET_CONTEXT(1, items - 1);
1711 PERL_CONTEXT *cx = cxstack + cxix;
1712 switch (CxTYPE(cx)) {
1714 croak("Can't uplevel to an eval frame");
1716 croak("Can't uplevel to a format frame");
1718 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
1724 ret = su_uplevel((CV *) code, cxix, args);
1729 } while (--cxix >= 0);
1730 croak("Can't uplevel outside a subroutine");