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 ------------------------------------------------------- */
30 # define MUTABLE_SV(S) ((SV *) (S))
34 # define MUTABLE_AV(A) ((AV *) (A))
38 # define MUTABLE_CV(C) ((CV *) (C))
41 #ifndef PERL_UNUSED_VAR
42 # define PERL_UNUSED_VAR(V)
46 # define STMT_START do
50 # define STMT_END while (0)
54 # define SU_D(X) STMT_START X STMT_END
60 # define Newx(v, n, c) New(0, v, n, c)
65 # define SU_POISON(D, N, T) PoisonNew((D), (N), T)
66 # elif defined(Poison)
67 # define SU_POISON(D, N, T) Poison((D), (N), T)
71 # define SU_POISON(D, N, T) NOOP
75 STATIC SV *su_newSV_type(pTHX_ svtype t) {
80 # define newSV_type(T) su_newSV_type(aTHX_ (T))
84 # define SvPV_const(S, L) SvPV(S, L)
88 # define SvPVX_const(S) SvPVX(S)
91 #ifndef SvPV_nolen_const
92 # define SvPV_nolen_const(S) SvPV_nolen(S)
95 #ifndef SvREFCNT_inc_simple_void
96 # define SvREFCNT_inc_simple_void(sv) ((void) SvREFCNT_inc(sv))
100 # define mPUSHi(I) PUSHs(sv_2mortal(newSViv(I)))
104 # define GvCV_set(G, C) (GvCV(G) = (C))
108 # define CvGV_set(C, G) (CvGV(C) = (G))
112 # define CvSTASH_set(C, S) (CvSTASH(C) = (S))
116 # define CvISXSUB(C) CvXSUB(C)
120 # define CxHASARGS(C) ((C)->blk_sub.hasargs)
124 # define HvNAME_get(H) HvNAME(H)
127 #ifndef gv_fetchpvn_flags
128 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
131 #ifndef PERL_MAGIC_tied
132 # define PERL_MAGIC_tied 'P'
135 #ifndef PERL_MAGIC_env
136 # define PERL_MAGIC_env 'E'
139 #ifndef NEGATIVE_INDICES_VAR
140 # define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
143 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
144 #define SU_HAS_PERL_EXACT(R, V, S) ((PERL_REVISION == (R)) && (PERL_VERSION == (V)) && (PERL_SUBVERSION == (S)))
146 /* --- Threads and multiplicity -------------------------------------------- */
148 #ifndef SU_MULTIPLICITY
149 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
150 # define SU_MULTIPLICITY 1
152 # define SU_MULTIPLICITY 0
155 #if SU_MULTIPLICITY && !defined(tTHX)
156 # define tTHX PerlInterpreter*
159 #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))
160 # define SU_THREADSAFE 1
161 # ifndef MY_CXT_CLONE
162 # define MY_CXT_CLONE \
164 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
165 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
166 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
169 # define SU_THREADSAFE 0
171 # define dMY_CXT dNOOP
173 # define MY_CXT su_globaldata
175 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
177 # define MY_CXT_INIT NOOP
179 # define MY_CXT_CLONE NOOP
182 /* --- Unique context ID global storage ------------------------------------ */
184 /* ... Sequence ID counter ................................................. */
191 STATIC su_uv_array su_uid_seq_counter;
195 STATIC perl_mutex su_uid_seq_counter_mutex;
197 #define SU_LOCK(M) MUTEX_LOCK(M)
198 #define SU_UNLOCK(M) MUTEX_UNLOCK(M)
200 #else /* USE_ITHREADS */
205 #endif /* !USE_ITHREADS */
207 STATIC UV su_uid_seq_next(pTHX_ UV depth) {
208 #define su_uid_seq_next(D) su_uid_seq_next(aTHX_ (D))
212 SU_LOCK(&su_uid_seq_counter_mutex);
214 seqs = su_uid_seq_counter.seqs;
216 if (depth >= su_uid_seq_counter.size) {
219 seqs = PerlMemShared_realloc(seqs, (depth + 1) * sizeof(UV));
220 for (i = su_uid_seq_counter.size; i <= depth; ++i)
223 su_uid_seq_counter.seqs = seqs;
224 su_uid_seq_counter.size = depth + 1;
229 SU_UNLOCK(&su_uid_seq_counter_mutex);
234 /* ... UID storage ......................................................... */
241 #define SU_UID_ACTIVE 1
243 STATIC UV su_uid_depth(pTHX_ I32 cxix) {
244 #define su_uid_depth(I) su_uid_depth(aTHX_ (I))
249 for (si = PL_curstackinfo->si_prev; si; si = si->si_prev)
250 depth += si->si_cxix + 1;
261 STATIC void su_uid_storage_dup(pTHX_ su_uid_storage *new_cxt, const su_uid_storage *old_cxt, UV max_depth) {
262 #define su_uid_storage_dup(N, O, D) su_uid_storage_dup(aTHX_ (N), (O), (D))
263 su_uid **old_map = old_cxt->map;
266 su_uid **new_map = new_cxt->map;
267 STRLEN old_used = old_cxt->used;
268 STRLEN old_alloc = old_cxt->alloc;
269 STRLEN new_used, new_alloc;
272 new_used = max_depth < old_used ? max_depth : old_used;
273 new_cxt->used = new_used;
275 if (new_used <= new_cxt->alloc)
276 new_alloc = new_cxt->alloc;
278 new_alloc = new_used;
279 Renew(new_map, new_alloc, su_uid *);
280 for (i = new_cxt->alloc; i < new_alloc; ++i)
282 new_cxt->map = new_map;
283 new_cxt->alloc = new_alloc;
286 for (i = 0; i < new_alloc; ++i) {
287 su_uid *new_uid = new_map[i];
289 if (i < new_used) { /* => i < max_depth && i < old_used */
290 su_uid *old_uid = old_map[i];
292 if (old_uid && (old_uid->flags & SU_UID_ACTIVE)) {
294 Newx(new_uid, 1, su_uid);
295 new_map[i] = new_uid;
303 new_uid->flags &= ~SU_UID_ACTIVE;
310 /* --- unwind() global storage --------------------------------------------- */
320 /* --- uplevel() data tokens and global storage ---------------------------- */
322 #define SU_UPLEVEL_HIJACKS_RUNOPS SU_HAS_PERL(5, 8, 0)
327 su_uid_storage tmp_uid_storage;
328 su_uid_storage old_uid_storage;
339 PERL_SI *old_curstackinfo;
345 #if SU_UPLEVEL_HIJACKS_RUNOPS
346 runops_proc_t old_runops;
353 STATIC su_uplevel_ud *su_uplevel_ud_new(pTHX) {
354 #define su_uplevel_ud_new() su_uplevel_ud_new(aTHX)
358 Newx(sud, 1, su_uplevel_ud);
361 sud->tmp_uid_storage.map = NULL;
362 sud->tmp_uid_storage.used = 0;
363 sud->tmp_uid_storage.alloc = 0;
365 Newx(si, 1, PERL_SI);
366 si->si_stack = newAV();
367 AvREAL_off(si->si_stack);
368 si->si_cxstack = NULL;
376 STATIC void su_uplevel_ud_delete(pTHX_ su_uplevel_ud *sud) {
377 #define su_uplevel_ud_delete(S) su_uplevel_ud_delete(aTHX_ (S))
378 PERL_SI *si = sud->si;
380 Safefree(si->si_cxstack);
381 SvREFCNT_dec(si->si_stack);
384 if (sud->tmp_uid_storage.map) {
385 su_uid **map = sud->tmp_uid_storage.map;
386 STRLEN alloc = sud->tmp_uid_storage.alloc;
389 for (i = 0; i < alloc; ++i)
404 } su_uplevel_storage;
406 #ifndef SU_UPLEVEL_STORAGE_SIZE
407 # define SU_UPLEVEL_STORAGE_SIZE 4
410 /* --- Global data --------------------------------------------------------- */
412 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
415 char *stack_placeholder;
416 su_unwind_storage unwind_storage;
417 su_uplevel_storage uplevel_storage;
418 su_uid_storage uid_storage;
423 /* --- Stack manipulations ------------------------------------------------- */
425 #define SU_SAVE_PLACEHOLDER() save_pptr(&MY_CXT.stack_placeholder)
427 #define SU_SAVE_DESTRUCTOR_SIZE 3
428 #define SU_SAVE_PLACEHOLDER_SIZE 3
430 #define SU_SAVE_SCALAR_SIZE 3
432 #define SU_SAVE_ARY_SIZE 3
433 #define SU_SAVE_AELEM_SIZE 4
435 # define SU_SAVE_ADELETE_SIZE 3
437 # define SU_SAVE_ADELETE_SIZE SU_SAVE_DESTRUCTOR_SIZE
439 #if SU_SAVE_AELEM_SIZE < SU_SAVE_ADELETE_SIZE
440 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_ADELETE_SIZE
442 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_AELEM_SIZE
445 #define SU_SAVE_HASH_SIZE 3
446 #define SU_SAVE_HELEM_SIZE 4
447 #define SU_SAVE_HDELETE_SIZE 4
448 #if SU_SAVE_HELEM_SIZE < SU_SAVE_HDELETE_SIZE
449 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HDELETE_SIZE
451 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HELEM_SIZE
454 #define SU_SAVE_GVCV_SIZE SU_SAVE_DESTRUCTOR_SIZE
456 #if !SU_HAS_PERL(5, 8, 9)
457 # define SU_SAVE_GP_SIZE 6
458 #elif !SU_HAS_PERL(5, 13, 0) || (SU_RELEASE && SU_HAS_PERL_EXACT(5, 13, 0))
459 # define SU_SAVE_GP_SIZE 3
460 #elif !SU_HAS_PERL(5, 13, 8)
461 # define SU_SAVE_GP_SIZE 4
463 # define SU_SAVE_GP_SIZE 3
466 #ifndef SvCANEXISTDELETE
467 # define SvCANEXISTDELETE(sv) \
469 || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied)) \
470 && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
471 && gv_fetchmethod_autoload(stash, "EXISTS", TRUE) \
472 && gv_fetchmethod_autoload(stash, "DELETE", TRUE) \
477 /* ... Saving array elements ............................................... */
479 STATIC I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
480 #define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
486 /* Added by MJD in perl-5.8.1 with 6f12eb6d2a1dfaf441504d869b27d2e40ef4966a */
487 #if SU_HAS_PERL(5, 8, 1)
488 if (SvRMAGICAL(av)) {
489 const MAGIC * const tied_magic = mg_find((SV *) av, PERL_MAGIC_tied);
491 SV * const * const negative_indices_glob =
492 hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
493 NEGATIVE_INDICES_VAR, 16, 0);
494 if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
500 idx = key + av_len(av) + 1;
514 STATIC void su_adelete(pTHX_ void *ud_) {
515 su_ud_adelete *ud = (su_ud_adelete *) ud_;
517 av_delete(ud->av, ud->idx, G_DISCARD);
518 SvREFCNT_dec(ud->av);
523 STATIC void su_save_adelete(pTHX_ AV *av, I32 idx) {
524 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
527 Newx(ud, 1, su_ud_adelete);
530 SvREFCNT_inc_simple_void(av);
532 SAVEDESTRUCTOR_X(su_adelete, ud);
535 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
537 #endif /* SAVEADELETE */
539 STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
540 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
547 idx = su_av_key2idx(av, SvIV(key));
549 if (SvCANEXISTDELETE(av))
550 preeminent = av_exists(av, idx);
552 svp = av_fetch(av, idx, 1);
553 if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
556 save_aelem(av, idx, svp);
558 SAVEADELETE(av, idx);
560 if (val) { /* local $x[$idx] = $val; */
561 SvSetMagicSV(*svp, val);
562 } else { /* local $x[$idx]; delete $x[$idx]; */
563 av_delete(av, idx, G_DISCARD);
567 /* ... Saving hash elements ................................................ */
569 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
570 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
577 if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
578 preeminent = hv_exists_ent(hv, keysv, 0);
580 he = hv_fetch_ent(hv, keysv, 1, 0);
581 svp = he ? &HeVAL(he) : NULL;
582 if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
584 if (HvNAME_get(hv) && isGV(*svp)) {
585 save_gp((GV *) *svp, 0);
590 save_helem(hv, keysv, svp);
593 const char * const key = SvPV_const(keysv, keylen);
594 SAVEDELETE(hv, savepvn(key, keylen),
595 SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
598 if (val) { /* local $x{$keysv} = $val; */
599 SvSetMagicSV(*svp, val);
600 } else { /* local $x{$keysv}; delete $x{$keysv}; */
601 (void)hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
605 /* ... Saving code slots from a glob ....................................... */
607 #if !SU_HAS_PERL(5, 10, 0) && !defined(mro_method_changed_in)
608 # define mro_method_changed_in(G) PL_sub_generation++
616 STATIC void su_restore_gvcv(pTHX_ void *ud_) {
617 su_save_gvcv_ud *ud = ud_;
620 GvCV_set(gv, ud->old_cv);
622 mro_method_changed_in(GvSTASH(gv));
627 STATIC void su_save_gvcv(pTHX_ GV *gv) {
628 #define su_save_gvcv(G) su_save_gvcv(aTHX_ (G))
631 Newx(ud, 1, su_save_gvcv_ud);
633 ud->old_cv = GvCV(gv);
637 mro_method_changed_in(GvSTASH(gv));
639 SAVEDESTRUCTOR_X(su_restore_gvcv, ud);
642 /* --- Actions ------------------------------------------------------------- */
648 void (*handler)(pTHX_ void *);
651 #define SU_UD_DEPTH(U) (((su_ud_common *) (U))->depth)
652 #define SU_UD_PAD(U) (((su_ud_common *) (U))->pad)
653 #define SU_UD_ORIGIN(U) (((su_ud_common *) (U))->origin)
654 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
656 #define SU_UD_FREE(U) STMT_START { \
657 if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
661 /* ... Reap ................................................................ */
668 STATIC void su_call(pTHX_ void *ud_) {
669 su_ud_reap *ud = (su_ud_reap *) ud_;
670 #if SU_HAS_PERL(5, 9, 5)
671 PERL_CONTEXT saved_cx;
678 PerlIO_printf(Perl_debug_log,
679 "%p: @@@ call\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
680 ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
689 /* If the recently popped context isn't saved there, it will be overwritten by
690 * the sub scope from call_sv, although it's still needed in our caller. */
692 #if SU_HAS_PERL(5, 9, 5)
693 if (cxstack_ix < cxstack_max)
694 cxix = cxstack_ix + 1;
696 cxix = Perl_cxinc(aTHX);
697 saved_cx = cxstack[cxix];
700 call_sv(ud->cb, G_VOID);
702 #if SU_HAS_PERL(5, 9, 5)
703 cxstack[cxix] = saved_cx;
711 SvREFCNT_dec(ud->cb);
715 STATIC void su_reap(pTHX_ void *ud) {
716 #define su_reap(U) su_reap(aTHX_ (U))
718 PerlIO_printf(Perl_debug_log,
719 "%p: === reap\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
720 ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
723 SAVEDESTRUCTOR_X(su_call, ud);
726 /* ... Localize & localize array/hash element .............................. */
736 #define SU_UD_LOCALIZE_FREE(U) STMT_START { \
737 SvREFCNT_dec((U)->elem); \
738 SvREFCNT_dec((U)->val); \
739 SvREFCNT_dec((U)->sv); \
743 STATIC I32 su_ud_localize_init(pTHX_ su_ud_localize *ud, SV *sv, SV *val, SV *elem) {
744 #define su_ud_localize_init(UD, S, V, E) su_ud_localize_init(aTHX_ (UD), (S), (V), (E))
749 SvREFCNT_inc_simple_void(sv);
751 if (SvTYPE(sv) >= SVt_PVGV) {
752 if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
754 } else { /* local *x = \$val; */
755 t = SvTYPE(SvRV(val));
758 } else if (SvROK(sv)) {
759 croak("Invalid %s reference as the localization target",
760 sv_reftype(SvRV(sv), 0));
763 const char *p = SvPV_const(sv, len), *s;
764 for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
770 case '$': t = SVt_PV; break;
771 case '@': t = SVt_PVAV; break;
772 case '%': t = SVt_PVHV; break;
773 case '&': t = SVt_PVCV; break;
774 case '*': t = SVt_PVGV; break;
779 } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
780 if (SvROK(val) && !sv_isobject(val)) {
781 t = SvTYPE(SvRV(val));
793 size = elem ? SU_SAVE_AELEM_OR_ADELETE_SIZE
798 size = elem ? SU_SAVE_HELEM_OR_HDELETE_SIZE
803 size = SU_SAVE_GP_SIZE;
807 size = SU_SAVE_GVCV_SIZE;
811 size = SU_SAVE_SCALAR_SIZE;
814 /* When deref is set, val isn't NULL */
817 ud->val = val ? newSVsv(deref ? SvRV(val) : val) : NULL;
818 ud->elem = SvREFCNT_inc(elem);
824 STATIC void su_localize(pTHX_ void *ud_) {
825 #define su_localize(U) su_localize(aTHX_ (U))
826 su_ud_localize *ud = (su_ud_localize *) ud_;
833 if (SvTYPE(sv) >= SVt_PVGV) {
837 gv = gv_fetchsv(sv, GV_ADDMULTI, t);
840 const char *name = SvPV_const(sv, len);
841 gv = gv_fetchpvn_flags(name, len, GV_ADDMULTI, t);
848 PerlIO_printf(Perl_debug_log, "%p: === localize a %s\n",ud, sv_reftype(z, 0));
849 PerlIO_printf(Perl_debug_log,
850 "%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
851 ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
855 /* Inspired from Alias.pm */
859 su_save_aelem(GvAV(gv), elem, val);
866 su_save_helem(GvHV(gv), elem, val);
872 save_gp(gv, 1); /* hide previous entry in symtab */
878 gv = (GV *) save_scalar(gv);
883 SvSetMagicSV((SV *) gv, val);
886 SU_UD_LOCALIZE_FREE(ud);
889 /* --- Pop a context back -------------------------------------------------- */
893 # define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
895 # define SU_CXNAME "XXX"
899 STATIC void su_pop(pTHX_ void *ud) {
900 #define su_pop(U) su_pop(aTHX_ (U))
901 I32 depth, base, mark, *origin;
902 depth = SU_UD_DEPTH(ud);
905 PerlIO_printf(Perl_debug_log,
907 "%p: leave scope at depth=%2d scope_ix=%2d cur_top=%2d cur_base=%2d\n",
909 ud, depth, PL_scopestack_ix,PL_savestack_ix,PL_scopestack[PL_scopestack_ix])
912 origin = SU_UD_ORIGIN(ud);
913 mark = origin[depth];
914 base = origin[depth - 1];
916 SU_D(PerlIO_printf(Perl_debug_log,
917 "%p: original scope was %*c top=%2d base=%2d\n",
918 ud, 24, ' ', mark, base));
921 SU_D(PerlIO_printf(Perl_debug_log, "%p: clear leftovers\n", ud));
922 PL_savestack_ix = mark;
925 PL_savestack_ix = base;
927 SU_UD_DEPTH(ud) = --depth;
932 if ((pad = SU_UD_PAD(ud))) {
935 SU_D(PerlIO_printf(Perl_debug_log,
936 "%p: push a pad slot at depth=%2d scope_ix=%2d save_ix=%2d\n",
937 ud, depth, PL_scopestack_ix, PL_savestack_ix));
938 SU_SAVE_PLACEHOLDER();
942 SU_D(PerlIO_printf(Perl_debug_log,
943 "%p: push destructor at depth=%2d scope_ix=%2d save_ix=%2d\n",
944 ud, depth, PL_scopestack_ix, PL_savestack_ix));
945 SAVEDESTRUCTOR_X(su_pop, ud);
947 SU_UD_HANDLER(ud)(aTHX_ ud);
950 SU_D(PerlIO_printf(Perl_debug_log,
951 "%p: --- end pop: cur_top=%2d == cur_base=%2d\n",
952 ud, PL_savestack_ix, PL_scopestack[PL_scopestack_ix]));
955 /* --- Initialize the stack and the action userdata ------------------------ */
957 STATIC I32 su_init(pTHX_ void *ud, I32 cxix, I32 size) {
958 #define su_init(U, C, S) su_init(aTHX_ (U), (C), (S))
959 I32 i, depth = 1, pad, offset, *origin;
961 SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
963 if (size <= SU_SAVE_DESTRUCTOR_SIZE)
966 I32 extra = size - SU_SAVE_DESTRUCTOR_SIZE;
967 pad = extra / SU_SAVE_PLACEHOLDER_SIZE;
968 if (extra % SU_SAVE_PLACEHOLDER_SIZE)
971 offset = SU_SAVE_DESTRUCTOR_SIZE + SU_SAVE_PLACEHOLDER_SIZE * pad;
973 SU_D(PerlIO_printf(Perl_debug_log, "%p: size=%d pad=%d offset=%d\n",
974 ud, size, pad, offset));
976 for (i = cxstack_ix; i > cxix; --i) {
977 PERL_CONTEXT *cx = cxstack + i;
978 switch (CxTYPE(cx)) {
979 #if SU_HAS_PERL(5, 10, 0)
981 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is block\n", ud, i));
982 /* Given and when blocks are actually followed by a simple block, so skip
984 if (cxix > 0) { /* Implies i > 0 */
985 PERL_CONTEXT *next = cx - 1;
986 if (CxTYPE(next) == CXt_GIVEN || CxTYPE(next) == CXt_WHEN)
992 #if SU_HAS_PERL(5, 11, 0)
995 case CXt_LOOP_LAZYSV:
996 case CXt_LOOP_LAZYIV:
1000 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
1004 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is other\n", ud, i));
1009 SU_D(PerlIO_printf(Perl_debug_log, "%p: going down to depth %d\n", ud, depth));
1011 Newx(origin, depth + 1, I32);
1012 origin[0] = PL_scopestack[PL_scopestack_ix - depth];
1013 PL_scopestack[PL_scopestack_ix - depth] += size;
1014 for (i = depth - 1; i >= 1; --i) {
1015 I32 j = PL_scopestack_ix - i;
1016 origin[depth - i] = PL_scopestack[j];
1017 PL_scopestack[j] += offset;
1019 origin[depth] = PL_savestack_ix;
1021 SU_UD_ORIGIN(ud) = origin;
1022 SU_UD_DEPTH(ud) = depth;
1023 SU_UD_PAD(ud) = pad;
1025 /* Make sure the first destructor fires by pushing enough fake slots on the
1027 if (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
1028 <= PL_scopestack[PL_scopestack_ix - 1]) {
1031 SU_D(PerlIO_printf(Perl_debug_log,
1032 "%p: push a fake slot at scope_ix=%2d save_ix=%2d\n",
1033 ud, PL_scopestack_ix, PL_savestack_ix));
1034 SU_SAVE_PLACEHOLDER();
1035 } while (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
1036 <= PL_scopestack[PL_scopestack_ix - 1]);
1038 SU_D(PerlIO_printf(Perl_debug_log,
1039 "%p: push first destructor at scope_ix=%2d save_ix=%2d\n",
1040 ud, PL_scopestack_ix, PL_savestack_ix));
1041 SAVEDESTRUCTOR_X(su_pop, ud);
1044 for (i = 0; i <= depth; ++i) {
1045 I32 j = PL_scopestack_ix - i;
1046 PerlIO_printf(Perl_debug_log,
1047 "%p: depth=%2d scope_ix=%2d saved_floor=%2d new_floor=%2d\n",
1048 ud, i, j, origin[depth - i],
1049 i == 0 ? PL_savestack_ix : PL_scopestack[j]);
1056 /* --- Unwind stack -------------------------------------------------------- */
1058 STATIC void su_unwind(pTHX_ void *ud_) {
1060 I32 cxix = MY_CXT.unwind_storage.cxix;
1061 I32 items = MY_CXT.unwind_storage.items - 1;
1062 SV **savesp = MY_CXT.unwind_storage.savesp;
1065 PERL_UNUSED_VAR(ud_);
1068 PL_stack_sp = savesp;
1070 if (cxstack_ix > cxix)
1073 /* Hide the level */
1077 mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
1078 *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
1081 I32 gimme = GIMME_V;
1082 PerlIO_printf(Perl_debug_log,
1083 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
1085 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
1086 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
1089 PL_op = (OP *) &(MY_CXT.unwind_storage.return_op);
1090 PL_op = PL_op->op_ppaddr(aTHX);
1092 *PL_markstack_ptr = mark;
1094 MY_CXT.unwind_storage.proxy_op.op_next = PL_op;
1095 PL_op = &(MY_CXT.unwind_storage.proxy_op);
1098 /* --- Uplevel ------------------------------------------------------------- */
1100 #ifndef OP_GIMME_REVERSE
1101 STATIC U8 su_op_gimme_reverse(U8 gimme) {
1104 return OPf_WANT_VOID;
1106 return OPf_WANT_LIST;
1111 return OPf_WANT_SCALAR;
1113 #define OP_GIMME_REVERSE(G) su_op_gimme_reverse(G)
1116 #define SU_UPLEVEL_SAVE(f, t) STMT_START { sud->old_##f = PL_##f; PL_##f = (t); } STMT_END
1117 #define SU_UPLEVEL_RESTORE(f) STMT_START { PL_##f = sud->old_##f; } STMT_END
1119 STATIC su_uplevel_ud *su_uplevel_storage_new(pTHX_ I32 cxix) {
1120 #define su_uplevel_storage_new(I) su_uplevel_storage_new(aTHX_ (I))
1125 sud = MY_CXT.uplevel_storage.root;
1127 MY_CXT.uplevel_storage.root = sud->next;
1128 MY_CXT.uplevel_storage.count--;
1130 sud = su_uplevel_ud_new();
1133 sud->next = MY_CXT.uplevel_storage.top;
1134 MY_CXT.uplevel_storage.top = sud;
1136 depth = su_uid_depth(cxix);
1137 su_uid_storage_dup(&sud->tmp_uid_storage, &MY_CXT.uid_storage, depth);
1138 sud->old_uid_storage = MY_CXT.uid_storage;
1139 MY_CXT.uid_storage = sud->tmp_uid_storage;
1144 STATIC void su_uplevel_storage_delete(pTHX_ su_uplevel_ud *sud) {
1145 #define su_uplevel_storage_delete(S) su_uplevel_storage_delete(aTHX_ (S))
1148 sud->tmp_uid_storage = MY_CXT.uid_storage;
1149 MY_CXT.uid_storage = sud->old_uid_storage;
1153 map = sud->tmp_uid_storage.map;
1154 alloc = sud->tmp_uid_storage.alloc;
1155 for (i = 0; i < alloc; ++i) {
1157 map[i]->flags &= SU_UID_ACTIVE;
1160 MY_CXT.uplevel_storage.top = sud->next;
1162 if (MY_CXT.uplevel_storage.count >= SU_UPLEVEL_STORAGE_SIZE) {
1163 su_uplevel_ud_delete(sud);
1165 sud->next = MY_CXT.uplevel_storage.root;
1166 MY_CXT.uplevel_storage.root = sud;
1167 MY_CXT.uplevel_storage.count++;
1171 STATIC int su_uplevel_goto_static(const OP *o) {
1172 for (; o; o = o->op_sibling) {
1173 /* goto ops are unops with kids. */
1174 if (!(o->op_flags & OPf_KIDS))
1177 switch (o->op_type) {
1180 /* Don't care about gotos inside eval, as they are forbidden at run time. */
1185 if (su_uplevel_goto_static(cUNOPo->op_first))
1194 #if SU_UPLEVEL_HIJACKS_RUNOPS
1196 STATIC int su_uplevel_goto_runops(pTHX) {
1197 #define su_uplevel_goto_runops() su_uplevel_goto_runops(aTHX)
1203 if (op->op_type == OP_GOTO) {
1204 AV *argarray = NULL;
1207 for (cxix = cxstack_ix; cxix >= 0; --cxix) {
1208 const PERL_CONTEXT *cx = cxstack + cxix;
1210 switch (CxTYPE(cx)) {
1212 if (CxHASARGS(cx)) {
1213 argarray = cx->blk_sub.argarray;
1229 if (MY_CXT.uplevel_storage.top->cxix == cxix) {
1230 AV *args = GvAV(PL_defgv);
1231 I32 items = AvFILLp(args);
1233 av_extend(argarray, items);
1234 Copy(AvARRAY(args), AvARRAY(argarray), items + 1, SV *);
1235 AvFILLp(argarray) = items;
1240 PL_op = op = op->op_ppaddr(aTHX);
1242 #if !SU_HAS_PERL(5, 13, 0)
1252 #endif /* SU_UPLEVEL_HIJACKS_RUNOPS */
1254 #define su_at_underscore(C) AvARRAY(AvARRAY(CvPADLIST(C))[CvDEPTH(C)])[0]
1256 STATIC void su_uplevel_restore(pTHX_ void *sus_) {
1257 su_uplevel_ud *sud = sus_;
1258 PERL_SI *cur = sud->old_curstackinfo;
1259 PERL_SI *si = sud->si;
1261 #if SU_UPLEVEL_HIJACKS_RUNOPS
1262 if (PL_runops == su_uplevel_goto_runops)
1263 PL_runops = sud->old_runops;
1266 if (sud->callback) {
1267 PERL_CONTEXT *cx = cxstack + sud->cxix;
1268 AV *argarray = MUTABLE_AV(su_at_underscore(sud->callback));
1270 /* We have to fix the pad entry for @_ in the original callback because it
1271 * may have been reified. */
1272 if (AvREAL(argarray)) {
1273 const I32 fill = AvFILLp(argarray);
1274 SvREFCNT_dec(argarray);
1276 AvREAL_off(argarray);
1277 AvREIFY_on(argarray);
1278 av_extend(argarray, fill);
1279 su_at_underscore(sud->callback) = MUTABLE_SV(argarray);
1281 CLEAR_ARGARRAY(argarray);
1284 /* If the old cv member is our renamed CV, it means that this place has been
1285 * reached without a goto() happening, and the old argarray member is
1286 * actually our fake argarray. Destroy it properly in that case. */
1287 if (cx->blk_sub.cv == sud->renamed) {
1288 SvREFCNT_dec(cx->blk_sub.argarray);
1289 cx->blk_sub.argarray = argarray;
1292 CvDEPTH(sud->callback)--;
1293 SvREFCNT_dec(sud->callback);
1296 /* Free the renamed CV. We must do it ourselves so that we can force the
1297 * depth to be 0, or perl would complain about it being "still in use".
1298 * But we *know* that it cannot be so. */
1300 CvDEPTH(sud->renamed) = 0;
1301 CvPADLIST(sud->renamed) = NULL;
1302 SvREFCNT_dec(sud->renamed);
1305 CATCH_SET(sud->old_catch);
1307 SU_UPLEVEL_RESTORE(op);
1309 /* stack_grow() wants PL_curstack so restore the old stack first */
1310 if (PL_curstackinfo == si) {
1311 PL_curstack = cur->si_stack;
1312 if (sud->old_mainstack)
1313 SU_UPLEVEL_RESTORE(mainstack);
1314 SU_UPLEVEL_RESTORE(curstackinfo);
1317 CV *target = sud->target;
1320 /* When we die, the depth of the target CV is not updated because of the
1321 * stack switcheroo. So we have to look at all the frames between the
1322 * uplevel call and the catch block to count how many call frames to the
1323 * target CV were skipped. */
1324 for (i = cur->si_cxix; i > sud->cxix; i--) {
1325 register const PERL_CONTEXT *cx = cxstack + i;
1327 if (CxTYPE(cx) == CXt_SUB) {
1328 if (cx->blk_sub.cv == target)
1333 /* If we died, the replacement stack was already unwinded to the first
1334 * eval frame, and all the contexts down there were popped. We don't have
1335 * to pop manually any context of the original stack, because they must
1336 * have been in the replacement stack as well (since the second was copied
1337 * from the first). Thus we only have to make sure the original stack index
1338 * points to the context just below the first eval scope under the target
1340 for (; i >= 0; i--) {
1341 register const PERL_CONTEXT *cx = cxstack + i;
1343 switch (CxTYPE(cx)) {
1345 if (cx->blk_sub.cv == target)
1357 CvDEPTH(target) = sud->target_depth - levels;
1358 PL_curstackinfo->si_cxix = i - 1;
1360 #if !SU_HAS_PERL(5, 13, 1)
1361 /* Since $@ was maybe localized between the target frame and the uplevel
1362 * call, we forcefully flush the save stack to get rid of it and then
1363 * reset $@ to its proper value. Note that the the call to
1364 * su_uplevel_restore() must happen before the "reset $@" item of the save
1365 * stack is processed, as uplevel was called after the localization.
1366 * Andrew's changes to how $@ was handled, which were mainly integrated
1367 * between perl 5.13.0 and 5.13.1, fixed this. */
1368 if (ERRSV && SvTRUE(ERRSV)) {
1369 register const PERL_CONTEXT *cx = cxstack + i; /* This is the eval scope */
1370 SV *errsv = SvREFCNT_inc(ERRSV);
1371 PL_scopestack_ix = cx->blk_oldscopesp;
1372 leave_scope(PL_scopestack[PL_scopestack_ix]);
1373 sv_setsv(ERRSV, errsv);
1374 SvREFCNT_dec(errsv);
1380 SU_UPLEVEL_RESTORE(curcop);
1382 SvREFCNT_dec(sud->target);
1384 PL_stack_base = AvARRAY(cur->si_stack);
1385 PL_stack_sp = PL_stack_base + AvFILLp(cur->si_stack);
1386 PL_stack_max = PL_stack_base + AvMAX(cur->si_stack);
1388 /* When an exception is thrown from the uplevel'd subroutine,
1389 * su_uplevel_restore() may be called by the LEAVE in die_unwind() (renamed
1390 * die_where() in more recent perls), which has the sad habit of keeping a
1391 * pointer to the current context frame across this call. This means that we
1392 * can't free the temporary context stack we used for the uplevel call right
1393 * now, or that pointer upwards would point to garbage. */
1394 #if SU_HAS_PERL(5, 13, 7)
1395 /* This issue has been fixed in perl with commit 8f89e5a9, which was made
1396 * public in perl 5.13.7. */
1397 su_uplevel_storage_delete(sud);
1399 /* Otherwise, we just enqueue it back in the global storage list. */
1403 sud->tmp_uid_storage = MY_CXT.uid_storage;
1404 MY_CXT.uid_storage = sud->old_uid_storage;
1406 MY_CXT.uplevel_storage.top = sud->next;
1407 sud->next = MY_CXT.uplevel_storage.root;
1408 MY_CXT.uplevel_storage.root = sud;
1409 MY_CXT.uplevel_storage.count++;
1416 STATIC CV *su_cv_clone(pTHX_ CV *proto, GV *gv) {
1417 #define su_cv_clone(P, G) su_cv_clone(aTHX_ (P), (G))
1421 cv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
1423 CvFLAGS(cv) = CvFLAGS(proto);
1425 CvFLAGS(cv) &= ~CVf_CVGV_RC;
1427 CvDEPTH(cv) = CvDEPTH(proto);
1429 CvFILE(cv) = CvISXSUB(proto) ? CvFILE(proto) : savepv(CvFILE(proto));
1431 CvFILE(cv) = CvFILE(proto);
1435 CvSTASH_set(cv, CvSTASH(proto));
1436 /* Commit 4c74a7df, publicized with perl 5.13.3, began to add backrefs to
1437 * stashes. CvSTASH_set() started to do it as well with commit c68d95645
1438 * (which was part of perl 5.13.7). */
1439 #if SU_HAS_PERL(5, 13, 3) && !SU_HAS_PERL(5, 13, 7)
1441 Perl_sv_add_backref(aTHX_ CvSTASH(proto), MUTABLE_SV(cv));
1444 if (CvISXSUB(proto)) {
1445 CvXSUB(cv) = CvXSUB(proto);
1446 CvXSUBANY(cv) = CvXSUBANY(proto);
1449 CvROOT(cv) = OpREFCNT_inc(CvROOT(proto));
1451 CvSTART(cv) = CvSTART(proto);
1453 CvOUTSIDE(cv) = CvOUTSIDE(proto);
1454 #ifdef CVf_WEAKOUTSIDE
1455 if (!(CvFLAGS(proto) & CVf_WEAKOUTSIDE))
1457 SvREFCNT_inc_simple_void(CvOUTSIDE(cv));
1458 CvPADLIST(cv) = CvPADLIST(proto);
1459 #ifdef CvOUTSIDE_SEQ
1460 CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1464 sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
1474 STATIC I32 su_uplevel(pTHX_ CV *callback, I32 cxix, I32 args) {
1475 #define su_uplevel(C, I, A) su_uplevel(aTHX_ (C), (I), (A))
1477 const PERL_CONTEXT *cx = cxstack + cxix;
1479 PERL_SI *cur = PL_curstackinfo;
1485 I32 old_mark, new_mark;
1492 /* Make PL_stack_sp point just before the CV. */
1493 PL_stack_sp -= args + 1;
1494 old_mark = AvFILLp(PL_curstack) = PL_stack_sp - PL_stack_base;
1497 sud = su_uplevel_storage_new(cxix);
1501 sud->callback = NULL;
1502 sud->renamed = NULL;
1503 SAVEDESTRUCTOR_X(su_uplevel_restore, sud);
1507 si->si_type = cur->si_type;
1509 si->si_prev = cur->si_prev;
1511 si->si_markoff = cx->blk_oldmarksp;
1514 /* Allocate enough space for all the elements of the original stack up to the
1515 * target context, plus the forthcoming arguments. */
1516 new_mark = cx->blk_oldsp;
1517 av_extend(si->si_stack, new_mark + 1 + args + 1);
1518 Copy(PL_curstack, AvARRAY(si->si_stack), new_mark + 1, SV *);
1519 AvFILLp(si->si_stack) = new_mark;
1520 SU_POISON(AvARRAY(si->si_stack) + new_mark + 1, args + 1, SV *);
1522 /* Specialized SWITCHSTACK() */
1523 PL_stack_base = AvARRAY(si->si_stack);
1524 old_stack_sp = PL_stack_sp;
1525 PL_stack_sp = PL_stack_base + AvFILLp(si->si_stack);
1526 PL_stack_max = PL_stack_base + AvMAX(si->si_stack);
1529 /* Copy the context stack up to the context just below the target. */
1530 si->si_cxix = (cxix < 0) ? -1 : (cxix - 1);
1531 if (si->si_cxmax < cxix) {
1532 /* The max size must be at least two so that GROW(max) = (max*3)/2 > max */
1533 si->si_cxmax = (cxix < 4) ? 4 : cxix;
1534 Renew(si->si_cxstack, si->si_cxmax + 1, PERL_CONTEXT);
1536 Copy(cur->si_cxstack, si->si_cxstack, cxix, PERL_CONTEXT);
1537 SU_POISON(si->si_cxstack + cxix, si->si_cxmax + 1 - cxix, PERL_CONTEXT);
1539 target = cx->blk_sub.cv;
1540 sud->target = (CV *) SvREFCNT_inc(target);
1541 sud->target_depth = CvDEPTH(target);
1543 /* blk_oldcop is essentially needed for caller() and stack traces. It has no
1544 * run-time implication, since PL_curcop will be overwritten as soon as we
1545 * enter a sub (a sub starts by a nextstate/dbstate). Hence it's safe to just
1546 * make it point to the blk_oldcop for the target frame, so that caller()
1547 * reports the right file name, line number and lexical hints. */
1548 SU_UPLEVEL_SAVE(curcop, cx->blk_oldcop);
1549 /* Don't reset PL_markstack_ptr, or we would overwrite the mark stack below
1550 * this point. Don't reset PL_curpm either, we want the most recent matches. */
1552 SU_UPLEVEL_SAVE(curstackinfo, si);
1553 /* If those two are equal, we need to fool POPSTACK_TO() */
1554 if (PL_mainstack == PL_curstack)
1555 SU_UPLEVEL_SAVE(mainstack, si->si_stack);
1557 sud->old_mainstack = NULL;
1558 PL_curstack = si->si_stack;
1560 renamed = su_cv_clone(callback, CvGV(target));
1561 sud->renamed = renamed;
1564 /* Both SP and old_stack_sp point just before the CV. */
1565 Copy(old_stack_sp + 2, SP + 1, args, SV *);
1567 PUSHs((SV *) renamed);
1570 Zero(&sub_op, 1, UNOP);
1571 sub_op.op_type = OP_ENTERSUB;
1572 sub_op.op_next = NULL;
1573 sub_op.op_flags = OP_GIMME_REVERSE(gimme) | OPf_STACKED;
1575 sub_op.op_flags |= OPpENTERSUB_DB;
1577 SU_UPLEVEL_SAVE(op, (OP *) &sub_op);
1579 #if SU_UPLEVEL_HIJACKS_RUNOPS
1580 sud->old_runops = PL_runops;
1583 sud->old_catch = CATCH_GET;
1586 if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX))) {
1587 PERL_CONTEXT *sub_cx = cxstack + cxstack_ix;
1589 /* If pp_entersub() returns a non-null OP, it means that the callback is not
1592 sud->callback = MUTABLE_CV(SvREFCNT_inc(callback));
1593 CvDEPTH(callback)++;
1595 if (CxHASARGS(cx) && cx->blk_sub.argarray) {
1596 /* The call to pp_entersub() has saved the current @_ (in XS terms,
1597 * GvAV(PL_defgv)) in the savearray member, and has created a new argarray
1598 * with what we put on the stack. But we want to fake up the same arguments
1599 * as the ones in use at the context we uplevel to, so we replace the
1600 * argarray with an unreal copy of the original @_. */
1604 av_extend(av, AvMAX(cx->blk_sub.argarray));
1605 AvFILLp(av) = AvFILLp(cx->blk_sub.argarray);
1606 Copy(AvARRAY(cx->blk_sub.argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
1607 sub_cx->blk_sub.argarray = av;
1609 SvREFCNT_inc_simple_void(sub_cx->blk_sub.argarray);
1612 if (su_uplevel_goto_static(CvROOT(renamed))) {
1613 #if SU_UPLEVEL_HIJACKS_RUNOPS
1614 if (PL_runops != PL_runops_std) {
1615 if (PL_runops == PL_runops_dbg) {
1617 croak("uplevel() can't execute code that calls goto when debugging flags are set");
1618 } else if (PL_runops != su_uplevel_goto_runops)
1619 croak("uplevel() can't execute code that calls goto with a custom runloop");
1622 PL_runops = su_uplevel_goto_runops;
1623 #else /* SU_UPLEVEL_HIJACKS_RUNOPS */
1624 croak("uplevel() can't execute code that calls goto before perl 5.8");
1625 #endif /* !SU_UPLEVEL_HIJACKS_RUNOPS */
1633 ret = PL_stack_sp - (PL_stack_base + new_mark);
1635 AV *old_stack = sud->old_curstackinfo->si_stack;
1637 if (old_mark + ret > AvMAX(old_stack)) {
1638 /* Specialized EXTEND(old_sp, ret) */
1639 av_extend(old_stack, old_mark + ret + 1);
1640 old_stack_sp = AvARRAY(old_stack) + old_mark;
1643 Copy(PL_stack_sp - ret + 1, old_stack_sp + 1, ret, SV *);
1645 AvFILLp(old_stack) += ret;
1653 /* --- Unique context ID --------------------------------------------------- */
1655 STATIC su_uid *su_uid_storage_fetch(pTHX_ UV depth) {
1656 #define su_uid_storage_fetch(D) su_uid_storage_fetch(aTHX_ (D))
1661 map = MY_CXT.uid_storage.map;
1662 alloc = MY_CXT.uid_storage.alloc;
1664 if (depth >= alloc) {
1667 Renew(map, depth + 1, su_uid *);
1668 for (i = alloc; i <= depth; ++i)
1671 MY_CXT.uid_storage.map = map;
1672 MY_CXT.uid_storage.alloc = depth + 1;
1678 Newx(uid, 1, su_uid);
1684 if (depth >= MY_CXT.uid_storage.used)
1685 MY_CXT.uid_storage.used = depth + 1;
1690 STATIC int su_uid_storage_check(pTHX_ UV depth, UV seq) {
1691 #define su_uid_storage_check(D, S) su_uid_storage_check(aTHX_ (D), (S))
1695 if (depth >= MY_CXT.uid_storage.used)
1698 uid = MY_CXT.uid_storage.map[depth];
1700 return uid && (uid->seq == seq) && (uid->flags & SU_UID_ACTIVE);
1703 STATIC void su_uid_drop(pTHX_ void *ud_) {
1706 uid->flags &= ~SU_UID_ACTIVE;
1709 STATIC void su_uid_bump(pTHX_ void *ud_) {
1710 su_ud_reap *ud = ud_;
1712 SAVEDESTRUCTOR_X(su_uid_drop, ud->cb);
1715 STATIC SV *su_uid_get(pTHX_ I32 cxix) {
1716 #define su_uid_get(I) su_uid_get(aTHX_ (I))
1721 depth = su_uid_depth(cxix);
1722 uid = su_uid_storage_fetch(depth);
1724 if (!(uid->flags & SU_UID_ACTIVE)) {
1727 uid->seq = su_uid_seq_next(depth);
1728 uid->flags |= SU_UID_ACTIVE;
1730 Newx(ud, 1, su_ud_reap);
1731 SU_UD_ORIGIN(ud) = NULL;
1732 SU_UD_HANDLER(ud) = su_uid_bump;
1733 ud->cb = (SV *) uid;
1734 su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
1737 uid_sv = sv_newmortal();
1738 sv_setpvf(uid_sv, "%"UVuf"-%"UVuf, depth, uid->seq);
1744 #define su_grok_number(S, L, VP) grok_number((S), (L), (VP))
1746 #else /* grok_number */
1748 #define IS_NUMBER_IN_UV 0x1
1750 STATIC int su_grok_number(pTHX_ const char *s, STRLEN len, UV *valuep) {
1751 #define su_grok_number(S, L, VP) su_grok_number(aTHX_ (S), (L), (VP))
1755 /* This crude check should be good enough for a fallback implementation.
1756 * Better be too strict than too lax. */
1757 for (i = 0; i < len; ++i) {
1762 tmpsv = sv_newmortal();
1763 sv_setpvn(tmpsv, s, len);
1764 *valuep = sv_2uv(tmpsv);
1766 return IS_NUMBER_IN_UV;
1769 #endif /* !grok_number */
1771 STATIC int su_uid_validate(pTHX_ SV *uid) {
1772 #define su_uid_validate(U) su_uid_validate(aTHX_ (U))
1778 s = SvPV_const(uid, len);
1780 while (p < len && s[p] != '-')
1783 croak("UID contains only one part");
1785 type = su_grok_number(s, p, &depth);
1786 if (type != IS_NUMBER_IN_UV)
1787 croak("First UID part is not an unsigned integer");
1789 ++p; /* Skip '-'. As we used to have p < len, len - (p + 1) >= 0. */
1791 type = su_grok_number(s + p, len - p, &seq);
1792 if (type != IS_NUMBER_IN_UV)
1793 croak("Second UID part is not an unsigned integer");
1795 return su_uid_storage_check(depth, seq);
1798 /* --- Interpreter setup/teardown ------------------------------------------ */
1800 STATIC void su_teardown(pTHX_ void *param) {
1805 map = MY_CXT.uid_storage.map;
1808 for (i = 0; i < MY_CXT.uid_storage.used; ++i)
1813 cur = MY_CXT.uplevel_storage.root;
1815 su_uplevel_ud *prev;
1819 su_uplevel_ud_delete(prev);
1826 STATIC void su_setup(pTHX) {
1827 #define su_setup() su_setup(aTHX)
1830 MY_CXT.stack_placeholder = NULL;
1832 /* NewOp() calls calloc() which just zeroes the memory with memset(). */
1833 Zero(&(MY_CXT.unwind_storage.return_op), 1, LISTOP);
1834 MY_CXT.unwind_storage.return_op.op_type = OP_RETURN;
1835 MY_CXT.unwind_storage.return_op.op_ppaddr = PL_ppaddr[OP_RETURN];
1837 Zero(&(MY_CXT.unwind_storage.proxy_op), 1, OP);
1838 MY_CXT.unwind_storage.proxy_op.op_type = OP_STUB;
1839 MY_CXT.unwind_storage.proxy_op.op_ppaddr = NULL;
1841 MY_CXT.uplevel_storage.top = NULL;
1842 MY_CXT.uplevel_storage.root = NULL;
1843 MY_CXT.uplevel_storage.count = 0;
1845 MY_CXT.uid_storage.map = NULL;
1846 MY_CXT.uid_storage.used = 0;
1847 MY_CXT.uid_storage.alloc = 0;
1849 call_atexit(su_teardown, NULL);
1854 /* --- XS ------------------------------------------------------------------ */
1856 #if SU_HAS_PERL(5, 8, 9)
1857 # define SU_SKIP_DB_MAX 2
1859 # define SU_SKIP_DB_MAX 3
1862 /* Skip context sequences of 1 to SU_SKIP_DB_MAX (included) block contexts
1863 * followed by a DB sub */
1865 #define SU_SKIP_DB(C) \
1868 PERL_CONTEXT *base = cxstack; \
1869 PERL_CONTEXT *cx = base + (C); \
1870 while (cx >= base && (C) > skipped && CxTYPE(cx) == CXt_BLOCK) \
1872 if (cx >= base && (C) > skipped) { \
1873 switch (CxTYPE(cx)) { \
1875 if (skipped <= SU_SKIP_DB_MAX && cx->blk_sub.cv == GvCV(PL_DBsub)) \
1876 (C) -= skipped + 1; \
1884 #define SU_GET_CONTEXT(A, B) \
1893 else if (cxix > cxstack_ix) \
1894 cxix = cxstack_ix; \
1897 cxix = cxstack_ix; \
1903 #define SU_GET_LEVEL(A, B) \
1909 level = SvIV(lsv); \
1916 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
1918 XS(XS_Scope__Upper_unwind) {
1927 PERL_UNUSED_VAR(cv); /* -W */
1928 PERL_UNUSED_VAR(ax); /* -Wall */
1930 SU_GET_CONTEXT(0, items - 1);
1932 PERL_CONTEXT *cx = cxstack + cxix;
1933 switch (CxTYPE(cx)) {
1935 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
1939 MY_CXT.unwind_storage.cxix = cxix;
1940 MY_CXT.unwind_storage.items = items;
1941 /* pp_entersub will want to sanitize the stack after returning from there
1942 * Screw that, we're insane */
1943 if (GIMME_V == G_SCALAR) {
1944 MY_CXT.unwind_storage.savesp = PL_stack_sp;
1945 /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
1946 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
1948 MY_CXT.unwind_storage.savesp = NULL;
1950 SAVEDESTRUCTOR_X(su_unwind, NULL);
1955 } while (--cxix >= 0);
1956 croak("Can't return outside a subroutine");
1959 MODULE = Scope::Upper PACKAGE = Scope::Upper
1967 MUTEX_INIT(&su_uid_seq_counter_mutex);
1969 su_uid_seq_counter.seqs = NULL;
1970 su_uid_seq_counter.size = 0;
1972 stash = gv_stashpv(__PACKAGE__, 1);
1973 newCONSTSUB(stash, "TOP", newSViv(0));
1974 newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(SU_THREADSAFE));
1976 newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
1987 su_uid_storage new_cxt;
1994 su_uid_storage_dup(&new_cxt, &MY_CXT.uid_storage, MY_CXT.uid_storage.used);
1998 MY_CXT.uplevel_storage.top = NULL;
1999 MY_CXT.uplevel_storage.root = NULL;
2000 MY_CXT.uplevel_storage.count = 0;
2001 MY_CXT.uid_storage = new_cxt;
2005 #endif /* SU_THREADSAFE */
2011 I32 cxix = cxstack_ix;
2025 SU_GET_CONTEXT(0, 0);
2040 SU_GET_CONTEXT(0, 0);
2042 for (; cxix >= 0; --cxix) {
2043 PERL_CONTEXT *cx = cxstack + cxix;
2044 switch (CxTYPE(cx)) {
2048 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2062 SU_GET_CONTEXT(0, 0);
2064 for (; cxix >= 0; --cxix) {
2065 PERL_CONTEXT *cx = cxstack + cxix;
2066 switch (CxTYPE(cx)) {
2108 for (cxix = cxstack_ix; cxix > 0; --cxix) {
2109 PERL_CONTEXT *cx = cxstack + cxix;
2110 switch (CxTYPE(cx)) {
2112 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2132 SU_GET_CONTEXT(0, 0);
2135 PERL_CONTEXT *cx = cxstack + cxix--;
2136 switch (CxTYPE(cx)) {
2140 I32 gimme = cx->blk_gimme;
2142 case G_VOID: XSRETURN_UNDEF; break;
2143 case G_SCALAR: XSRETURN_NO; break;
2144 case G_ARRAY: XSRETURN_YES; break;
2159 SU_GET_CONTEXT(1, 1);
2160 Newx(ud, 1, su_ud_reap);
2161 SU_UD_ORIGIN(ud) = NULL;
2162 SU_UD_HANDLER(ud) = su_reap;
2163 ud->cb = newSVsv(hook);
2164 su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
2167 localize(SV *sv, SV *val, ...)
2174 SU_GET_CONTEXT(2, 2);
2175 Newx(ud, 1, su_ud_localize);
2176 SU_UD_ORIGIN(ud) = NULL;
2177 SU_UD_HANDLER(ud) = su_localize;
2178 size = su_ud_localize_init(ud, sv, val, NULL);
2179 su_init(ud, cxix, size);
2182 localize_elem(SV *sv, SV *elem, SV *val, ...)
2189 if (SvTYPE(sv) >= SVt_PVGV)
2190 croak("Can't infer the element localization type from a glob and the value");
2191 SU_GET_CONTEXT(3, 3);
2192 Newx(ud, 1, su_ud_localize);
2193 SU_UD_ORIGIN(ud) = NULL;
2194 SU_UD_HANDLER(ud) = su_localize;
2195 size = su_ud_localize_init(ud, sv, val, elem);
2196 if (ud->type != SVt_PVAV && ud->type != SVt_PVHV) {
2197 SU_UD_LOCALIZE_FREE(ud);
2198 croak("Can't localize an element of something that isn't an array or a hash");
2200 su_init(ud, cxix, size);
2203 localize_delete(SV *sv, SV *elem, ...)
2210 SU_GET_CONTEXT(2, 2);
2211 Newx(ud, 1, su_ud_localize);
2212 SU_UD_ORIGIN(ud) = NULL;
2213 SU_UD_HANDLER(ud) = su_localize;
2214 size = su_ud_localize_init(ud, sv, NULL, elem);
2215 su_init(ud, cxix, size);
2218 uplevel(SV *code, ...)
2221 I32 cxix, ret, args = 0;
2225 if (SvTYPE(code) < SVt_PVCV)
2226 croak("First argument to uplevel must be a code reference");
2227 SU_GET_CONTEXT(1, items - 1);
2229 PERL_CONTEXT *cx = cxstack + cxix;
2230 switch (CxTYPE(cx)) {
2232 croak("Can't uplevel to an eval frame");
2234 croak("Can't uplevel to a format frame");
2236 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2242 /* su_uplevel() takes care of extending the stack if needed. */
2243 ret = su_uplevel((CV *) code, cxix, args);
2248 } while (--cxix >= 0);
2249 croak("Can't uplevel outside a subroutine");
2258 SU_GET_CONTEXT(0, 0);
2259 uid = su_uid_get(cxix);
2265 validate_uid(SV *uid)
2270 ret = su_uid_validate(uid) ? &PL_sv_yes : &PL_sv_no;