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 PadlistARRAY(P) AvARRAY(P)
121 # define PadARRAY(P) AvARRAY(P)
125 # define CxHASARGS(C) ((C)->blk_sub.hasargs)
129 # define HvNAME_get(H) HvNAME(H)
132 #ifndef gv_fetchpvn_flags
133 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
136 #ifndef OP_GIMME_REVERSE
137 STATIC U8 su_op_gimme_reverse(U8 gimme) {
140 return OPf_WANT_VOID;
142 return OPf_WANT_LIST;
147 return OPf_WANT_SCALAR;
149 #define OP_GIMME_REVERSE(G) su_op_gimme_reverse(G)
152 #ifndef PERL_MAGIC_tied
153 # define PERL_MAGIC_tied 'P'
156 #ifndef PERL_MAGIC_env
157 # define PERL_MAGIC_env 'E'
160 #ifndef NEGATIVE_INDICES_VAR
161 # define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
164 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
165 #define SU_HAS_PERL_EXACT(R, V, S) ((PERL_REVISION == (R)) && (PERL_VERSION == (V)) && (PERL_SUBVERSION == (S)))
167 /* --- Threads and multiplicity -------------------------------------------- */
169 #ifndef SU_MULTIPLICITY
170 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
171 # define SU_MULTIPLICITY 1
173 # define SU_MULTIPLICITY 0
176 #if SU_MULTIPLICITY && !defined(tTHX)
177 # define tTHX PerlInterpreter*
180 #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))
181 # define SU_THREADSAFE 1
182 # ifndef MY_CXT_CLONE
183 # define MY_CXT_CLONE \
185 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
186 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
187 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
190 # define SU_THREADSAFE 0
192 # define dMY_CXT dNOOP
194 # define MY_CXT su_globaldata
196 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
198 # define MY_CXT_INIT NOOP
200 # define MY_CXT_CLONE NOOP
203 /* --- Unique context ID global storage ------------------------------------ */
205 /* ... Sequence ID counter ................................................. */
212 STATIC su_uv_array su_uid_seq_counter;
216 STATIC perl_mutex su_uid_seq_counter_mutex;
218 #define SU_LOCK(M) MUTEX_LOCK(M)
219 #define SU_UNLOCK(M) MUTEX_UNLOCK(M)
221 #else /* USE_ITHREADS */
226 #endif /* !USE_ITHREADS */
228 STATIC UV su_uid_seq_next(pTHX_ UV depth) {
229 #define su_uid_seq_next(D) su_uid_seq_next(aTHX_ (D))
233 SU_LOCK(&su_uid_seq_counter_mutex);
235 seqs = su_uid_seq_counter.seqs;
237 if (depth >= su_uid_seq_counter.size) {
240 seqs = PerlMemShared_realloc(seqs, (depth + 1) * sizeof(UV));
241 for (i = su_uid_seq_counter.size; i <= depth; ++i)
244 su_uid_seq_counter.seqs = seqs;
245 su_uid_seq_counter.size = depth + 1;
250 SU_UNLOCK(&su_uid_seq_counter_mutex);
255 /* ... UID storage ......................................................... */
262 #define SU_UID_ACTIVE 1
264 STATIC UV su_uid_depth(pTHX_ I32 cxix) {
265 #define su_uid_depth(I) su_uid_depth(aTHX_ (I))
270 for (si = PL_curstackinfo->si_prev; si; si = si->si_prev)
271 depth += si->si_cxix + 1;
282 STATIC void su_uid_storage_dup(pTHX_ su_uid_storage *new_cxt, const su_uid_storage *old_cxt, UV max_depth) {
283 #define su_uid_storage_dup(N, O, D) su_uid_storage_dup(aTHX_ (N), (O), (D))
284 su_uid **old_map = old_cxt->map;
287 su_uid **new_map = new_cxt->map;
288 STRLEN old_used = old_cxt->used;
289 STRLEN new_used, new_alloc;
292 new_used = max_depth < old_used ? max_depth : old_used;
293 new_cxt->used = new_used;
295 if (new_used <= new_cxt->alloc)
296 new_alloc = new_cxt->alloc;
298 new_alloc = new_used;
299 Renew(new_map, new_alloc, su_uid *);
300 for (i = new_cxt->alloc; i < new_alloc; ++i)
302 new_cxt->map = new_map;
303 new_cxt->alloc = new_alloc;
306 for (i = 0; i < new_alloc; ++i) {
307 su_uid *new_uid = new_map[i];
309 if (i < new_used) { /* => i < max_depth && i < old_used */
310 su_uid *old_uid = old_map[i];
312 if (old_uid && (old_uid->flags & SU_UID_ACTIVE)) {
314 Newx(new_uid, 1, su_uid);
315 new_map[i] = new_uid;
323 new_uid->flags &= ~SU_UID_ACTIVE;
330 /* --- unwind() global storage --------------------------------------------- */
340 /* --- uplevel() data tokens and global storage ---------------------------- */
342 #define SU_UPLEVEL_HIJACKS_RUNOPS SU_HAS_PERL(5, 8, 0)
347 su_uid_storage tmp_uid_storage;
348 su_uid_storage old_uid_storage;
359 PERL_SI *old_curstackinfo;
365 #if SU_UPLEVEL_HIJACKS_RUNOPS
366 runops_proc_t old_runops;
373 STATIC su_uplevel_ud *su_uplevel_ud_new(pTHX) {
374 #define su_uplevel_ud_new() su_uplevel_ud_new(aTHX)
378 Newx(sud, 1, su_uplevel_ud);
381 sud->tmp_uid_storage.map = NULL;
382 sud->tmp_uid_storage.used = 0;
383 sud->tmp_uid_storage.alloc = 0;
385 Newx(si, 1, PERL_SI);
386 si->si_stack = newAV();
387 AvREAL_off(si->si_stack);
388 si->si_cxstack = NULL;
396 STATIC void su_uplevel_ud_delete(pTHX_ su_uplevel_ud *sud) {
397 #define su_uplevel_ud_delete(S) su_uplevel_ud_delete(aTHX_ (S))
398 PERL_SI *si = sud->si;
400 Safefree(si->si_cxstack);
401 SvREFCNT_dec(si->si_stack);
404 if (sud->tmp_uid_storage.map) {
405 su_uid **map = sud->tmp_uid_storage.map;
406 STRLEN alloc = sud->tmp_uid_storage.alloc;
409 for (i = 0; i < alloc; ++i)
424 } su_uplevel_storage;
426 #ifndef SU_UPLEVEL_STORAGE_SIZE
427 # define SU_UPLEVEL_STORAGE_SIZE 4
430 /* --- Global data --------------------------------------------------------- */
432 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
435 char *stack_placeholder;
436 su_unwind_storage unwind_storage;
437 su_uplevel_storage uplevel_storage;
438 su_uid_storage uid_storage;
443 /* --- Stack manipulations ------------------------------------------------- */
445 #define SU_SAVE_PLACEHOLDER() save_pptr(&MY_CXT.stack_placeholder)
447 #define SU_SAVE_DESTRUCTOR_SIZE 3
448 #define SU_SAVE_PLACEHOLDER_SIZE 3
450 #define SU_SAVE_SCALAR_SIZE 3
452 #define SU_SAVE_ARY_SIZE 3
453 #define SU_SAVE_AELEM_SIZE 4
455 # define SU_SAVE_ADELETE_SIZE 3
457 # define SU_SAVE_ADELETE_SIZE SU_SAVE_DESTRUCTOR_SIZE
459 #if SU_SAVE_AELEM_SIZE < SU_SAVE_ADELETE_SIZE
460 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_ADELETE_SIZE
462 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_AELEM_SIZE
465 #define SU_SAVE_HASH_SIZE 3
466 #define SU_SAVE_HELEM_SIZE 4
467 #define SU_SAVE_HDELETE_SIZE 4
468 #if SU_SAVE_HELEM_SIZE < SU_SAVE_HDELETE_SIZE
469 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HDELETE_SIZE
471 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HELEM_SIZE
474 #define SU_SAVE_GVCV_SIZE SU_SAVE_DESTRUCTOR_SIZE
476 #if !SU_HAS_PERL(5, 8, 9)
477 # define SU_SAVE_GP_SIZE 6
478 #elif !SU_HAS_PERL(5, 13, 0) || (SU_RELEASE && SU_HAS_PERL_EXACT(5, 13, 0))
479 # define SU_SAVE_GP_SIZE 3
480 #elif !SU_HAS_PERL(5, 13, 8)
481 # define SU_SAVE_GP_SIZE 4
483 # define SU_SAVE_GP_SIZE 3
486 #ifndef SvCANEXISTDELETE
487 # define SvCANEXISTDELETE(sv) \
489 || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied)) \
490 && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
491 && gv_fetchmethod_autoload(stash, "EXISTS", TRUE) \
492 && gv_fetchmethod_autoload(stash, "DELETE", TRUE) \
497 /* ... Saving array elements ............................................... */
499 STATIC I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
500 #define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
506 /* Added by MJD in perl-5.8.1 with 6f12eb6d2a1dfaf441504d869b27d2e40ef4966a */
507 #if SU_HAS_PERL(5, 8, 1)
508 if (SvRMAGICAL(av)) {
509 const MAGIC * const tied_magic = mg_find((SV *) av, PERL_MAGIC_tied);
511 SV * const * const negative_indices_glob =
512 hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
513 NEGATIVE_INDICES_VAR, 16, 0);
514 if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
520 idx = key + av_len(av) + 1;
534 STATIC void su_adelete(pTHX_ void *ud_) {
535 su_ud_adelete *ud = (su_ud_adelete *) ud_;
537 av_delete(ud->av, ud->idx, G_DISCARD);
538 SvREFCNT_dec(ud->av);
543 STATIC void su_save_adelete(pTHX_ AV *av, I32 idx) {
544 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
547 Newx(ud, 1, su_ud_adelete);
550 SvREFCNT_inc_simple_void(av);
552 SAVEDESTRUCTOR_X(su_adelete, ud);
555 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
557 #endif /* SAVEADELETE */
559 STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
560 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
567 idx = su_av_key2idx(av, SvIV(key));
569 if (SvCANEXISTDELETE(av))
570 preeminent = av_exists(av, idx);
572 svp = av_fetch(av, idx, 1);
573 if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
576 save_aelem(av, idx, svp);
578 SAVEADELETE(av, idx);
580 if (val) { /* local $x[$idx] = $val; */
581 SvSetMagicSV(*svp, val);
582 } else { /* local $x[$idx]; delete $x[$idx]; */
583 av_delete(av, idx, G_DISCARD);
587 /* ... Saving hash elements ................................................ */
589 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
590 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
597 if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
598 preeminent = hv_exists_ent(hv, keysv, 0);
600 he = hv_fetch_ent(hv, keysv, 1, 0);
601 svp = he ? &HeVAL(he) : NULL;
602 if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
604 if (HvNAME_get(hv) && isGV(*svp)) {
605 save_gp((GV *) *svp, 0);
610 save_helem(hv, keysv, svp);
613 const char * const key = SvPV_const(keysv, keylen);
614 SAVEDELETE(hv, savepvn(key, keylen),
615 SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
618 if (val) { /* local $x{$keysv} = $val; */
619 SvSetMagicSV(*svp, val);
620 } else { /* local $x{$keysv}; delete $x{$keysv}; */
621 (void)hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
625 /* ... Saving code slots from a glob ....................................... */
627 #if !SU_HAS_PERL(5, 10, 0) && !defined(mro_method_changed_in)
628 # define mro_method_changed_in(G) PL_sub_generation++
636 STATIC void su_restore_gvcv(pTHX_ void *ud_) {
637 su_save_gvcv_ud *ud = ud_;
640 GvCV_set(gv, ud->old_cv);
642 mro_method_changed_in(GvSTASH(gv));
647 STATIC void su_save_gvcv(pTHX_ GV *gv) {
648 #define su_save_gvcv(G) su_save_gvcv(aTHX_ (G))
651 Newx(ud, 1, su_save_gvcv_ud);
653 ud->old_cv = GvCV(gv);
657 mro_method_changed_in(GvSTASH(gv));
659 SAVEDESTRUCTOR_X(su_restore_gvcv, ud);
662 /* --- Actions ------------------------------------------------------------- */
668 void (*handler)(pTHX_ void *);
671 #define SU_UD_DEPTH(U) (((su_ud_common *) (U))->depth)
672 #define SU_UD_PAD(U) (((su_ud_common *) (U))->pad)
673 #define SU_UD_ORIGIN(U) (((su_ud_common *) (U))->origin)
674 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
676 #define SU_UD_FREE(U) STMT_START { \
677 if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
681 /* ... Reap ................................................................ */
683 #define SU_SAVE_LAST_CX (!SU_HAS_PERL(5, 8, 4) || (SU_HAS_PERL(5, 9, 5) && !SU_HAS_PERL(5, 14, 0)) || SU_HAS_PERL(5, 15, 0))
690 STATIC void su_call(pTHX_ void *ud_) {
691 su_ud_reap *ud = (su_ud_reap *) ud_;
694 PERL_CONTEXT saved_cx;
695 #endif /* SU_SAVE_LAST_CX */
700 PerlIO_printf(Perl_debug_log,
701 "%p: @@@ call\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
702 ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
712 /* If the recently popped context isn't saved there, it will be overwritten by
713 * the sub scope from call_sv, although it's still needed in our caller. */
714 cxix = (cxstack_ix < cxstack_max) ? (cxstack_ix + 1) : Perl_cxinc(aTHX);
715 saved_cx = cxstack[cxix];
716 #endif /* SU_SAVE_LAST_CX */
718 call_sv(ud->cb, G_VOID);
721 cxstack[cxix] = saved_cx;
722 #endif /* SU_SAVE_LAST_CX */
729 SvREFCNT_dec(ud->cb);
733 STATIC void su_reap(pTHX_ void *ud) {
734 #define su_reap(U) su_reap(aTHX_ (U))
736 PerlIO_printf(Perl_debug_log,
737 "%p: === reap\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
738 ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
741 SAVEDESTRUCTOR_X(su_call, ud);
744 /* ... Localize & localize array/hash element .............................. */
754 #define SU_UD_LOCALIZE_FREE(U) STMT_START { \
755 SvREFCNT_dec((U)->elem); \
756 SvREFCNT_dec((U)->val); \
757 SvREFCNT_dec((U)->sv); \
761 STATIC I32 su_ud_localize_init(pTHX_ su_ud_localize *ud, SV *sv, SV *val, SV *elem) {
762 #define su_ud_localize_init(UD, S, V, E) su_ud_localize_init(aTHX_ (UD), (S), (V), (E))
767 SvREFCNT_inc_simple_void(sv);
769 if (SvTYPE(sv) >= SVt_PVGV) {
770 if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
772 } else { /* local *x = \$val; */
773 t = SvTYPE(SvRV(val));
776 } else if (SvROK(sv)) {
777 croak("Invalid %s reference as the localization target",
778 sv_reftype(SvRV(sv), 0));
781 const char *p = SvPV_const(sv, len), *s;
782 for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
788 case '$': t = SVt_PV; break;
789 case '@': t = SVt_PVAV; break;
790 case '%': t = SVt_PVHV; break;
791 case '&': t = SVt_PVCV; break;
792 case '*': t = SVt_PVGV; break;
797 } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
798 if (SvROK(val) && !sv_isobject(val)) {
799 t = SvTYPE(SvRV(val));
811 size = elem ? SU_SAVE_AELEM_OR_ADELETE_SIZE
816 size = elem ? SU_SAVE_HELEM_OR_HDELETE_SIZE
821 size = SU_SAVE_GP_SIZE;
825 size = SU_SAVE_GVCV_SIZE;
829 size = SU_SAVE_SCALAR_SIZE;
832 /* When deref is set, val isn't NULL */
835 ud->val = val ? newSVsv(deref ? SvRV(val) : val) : NULL;
836 ud->elem = SvREFCNT_inc(elem);
842 STATIC void su_localize(pTHX_ void *ud_) {
843 #define su_localize(U) su_localize(aTHX_ (U))
844 su_ud_localize *ud = (su_ud_localize *) ud_;
851 if (SvTYPE(sv) >= SVt_PVGV) {
855 gv = gv_fetchsv(sv, GV_ADDMULTI, t);
858 const char *name = SvPV_const(sv, len);
859 gv = gv_fetchpvn_flags(name, len, GV_ADDMULTI, t);
866 PerlIO_printf(Perl_debug_log, "%p: === localize a %s\n",ud, sv_reftype(z, 0));
867 PerlIO_printf(Perl_debug_log,
868 "%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
869 ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
873 /* Inspired from Alias.pm */
877 su_save_aelem(GvAV(gv), elem, val);
884 su_save_helem(GvHV(gv), elem, val);
890 save_gp(gv, 1); /* hide previous entry in symtab */
896 gv = (GV *) save_scalar(gv);
901 SvSetMagicSV((SV *) gv, val);
904 SU_UD_LOCALIZE_FREE(ud);
907 /* --- Pop a context back -------------------------------------------------- */
911 # define SU_CXNAME(C) PL_block_type[CxTYPE(C)]
913 # define SU_CXNAME(C) "XXX"
917 STATIC void su_pop(pTHX_ void *ud) {
918 #define su_pop(U) su_pop(aTHX_ (U))
919 I32 depth, base, mark, *origin;
920 depth = SU_UD_DEPTH(ud);
923 PerlIO_printf(Perl_debug_log,
925 "%p: leave scope at depth=%2d scope_ix=%2d cur_top=%2d cur_base=%2d\n",
926 ud, SU_CXNAME(cxstack + cxstack_ix),
927 ud, depth, PL_scopestack_ix,PL_savestack_ix,PL_scopestack[PL_scopestack_ix])
930 origin = SU_UD_ORIGIN(ud);
931 mark = origin[depth];
932 base = origin[depth - 1];
934 SU_D(PerlIO_printf(Perl_debug_log,
935 "%p: original scope was %*c top=%2d base=%2d\n",
936 ud, 24, ' ', mark, base));
939 SU_D(PerlIO_printf(Perl_debug_log, "%p: clear leftovers\n", ud));
940 PL_savestack_ix = mark;
943 PL_savestack_ix = base;
945 SU_UD_DEPTH(ud) = --depth;
950 if ((pad = SU_UD_PAD(ud))) {
953 SU_D(PerlIO_printf(Perl_debug_log,
954 "%p: push a pad slot at depth=%2d scope_ix=%2d save_ix=%2d\n",
955 ud, depth, PL_scopestack_ix, PL_savestack_ix));
956 SU_SAVE_PLACEHOLDER();
960 SU_D(PerlIO_printf(Perl_debug_log,
961 "%p: push destructor at depth=%2d scope_ix=%2d save_ix=%2d\n",
962 ud, depth, PL_scopestack_ix, PL_savestack_ix));
963 SAVEDESTRUCTOR_X(su_pop, ud);
965 SU_UD_HANDLER(ud)(aTHX_ ud);
968 SU_D(PerlIO_printf(Perl_debug_log,
969 "%p: --- end pop: cur_top=%2d == cur_base=%2d\n",
970 ud, PL_savestack_ix, PL_scopestack[PL_scopestack_ix]));
973 /* --- Initialize the stack and the action userdata ------------------------ */
975 STATIC I32 su_init(pTHX_ void *ud, I32 cxix, I32 size) {
976 #define su_init(U, C, S) su_init(aTHX_ (U), (C), (S))
977 I32 i, depth = 1, pad, offset, *origin;
979 SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
981 if (size <= SU_SAVE_DESTRUCTOR_SIZE)
984 I32 extra = size - SU_SAVE_DESTRUCTOR_SIZE;
985 pad = extra / SU_SAVE_PLACEHOLDER_SIZE;
986 if (extra % SU_SAVE_PLACEHOLDER_SIZE)
989 offset = SU_SAVE_DESTRUCTOR_SIZE + SU_SAVE_PLACEHOLDER_SIZE * pad;
991 SU_D(PerlIO_printf(Perl_debug_log, "%p: size=%d pad=%d offset=%d\n",
992 ud, size, pad, offset));
994 for (i = cxstack_ix; i > cxix; --i) {
995 PERL_CONTEXT *cx = cxstack + i;
996 switch (CxTYPE(cx)) {
997 #if SU_HAS_PERL(5, 11, 0)
1000 case CXt_LOOP_LAZYSV:
1001 case CXt_LOOP_LAZYIV:
1005 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
1009 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is other\n", ud, i));
1014 SU_D(PerlIO_printf(Perl_debug_log, "%p: going down to depth %d\n", ud, depth));
1016 Newx(origin, depth + 1, I32);
1017 origin[0] = PL_scopestack[PL_scopestack_ix - depth];
1018 PL_scopestack[PL_scopestack_ix - depth] += size;
1019 for (i = depth - 1; i >= 1; --i) {
1020 I32 j = PL_scopestack_ix - i;
1021 origin[depth - i] = PL_scopestack[j];
1022 PL_scopestack[j] += offset;
1024 origin[depth] = PL_savestack_ix;
1026 SU_UD_ORIGIN(ud) = origin;
1027 SU_UD_DEPTH(ud) = depth;
1028 SU_UD_PAD(ud) = pad;
1030 /* Make sure the first destructor fires by pushing enough fake slots on the
1032 if (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
1033 <= PL_scopestack[PL_scopestack_ix - 1]) {
1036 SU_D(PerlIO_printf(Perl_debug_log,
1037 "%p: push a fake slot at scope_ix=%2d save_ix=%2d\n",
1038 ud, PL_scopestack_ix, PL_savestack_ix));
1039 SU_SAVE_PLACEHOLDER();
1040 } while (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
1041 <= PL_scopestack[PL_scopestack_ix - 1]);
1043 SU_D(PerlIO_printf(Perl_debug_log,
1044 "%p: push first destructor at scope_ix=%2d save_ix=%2d\n",
1045 ud, PL_scopestack_ix, PL_savestack_ix));
1046 SAVEDESTRUCTOR_X(su_pop, ud);
1049 for (i = 0; i <= depth; ++i) {
1050 I32 j = PL_scopestack_ix - i;
1051 PerlIO_printf(Perl_debug_log,
1052 "%p: depth=%2d scope_ix=%2d saved_floor=%2d new_floor=%2d\n",
1053 ud, i, j, origin[depth - i],
1054 i == 0 ? PL_savestack_ix : PL_scopestack[j]);
1061 /* --- Unwind stack -------------------------------------------------------- */
1063 STATIC void su_unwind(pTHX_ void *ud_) {
1065 I32 cxix = MY_CXT.unwind_storage.cxix;
1066 I32 items = MY_CXT.unwind_storage.items - 1;
1067 SV **savesp = MY_CXT.unwind_storage.savesp;
1070 PERL_UNUSED_VAR(ud_);
1073 PL_stack_sp = savesp;
1075 if (cxstack_ix > cxix)
1078 /* Hide the level */
1082 mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
1083 *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
1086 I32 gimme = GIMME_V;
1087 PerlIO_printf(Perl_debug_log,
1088 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
1090 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
1091 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
1094 PL_op = (OP *) &(MY_CXT.unwind_storage.return_op);
1095 PL_op = PL_op->op_ppaddr(aTHX);
1097 *PL_markstack_ptr = mark;
1099 MY_CXT.unwind_storage.proxy_op.op_next = PL_op;
1100 PL_op = &(MY_CXT.unwind_storage.proxy_op);
1103 /* --- Uplevel ------------------------------------------------------------- */
1105 #define SU_UPLEVEL_SAVE(f, t) STMT_START { sud->old_##f = PL_##f; PL_##f = (t); } STMT_END
1106 #define SU_UPLEVEL_RESTORE(f) STMT_START { PL_##f = sud->old_##f; } STMT_END
1108 STATIC su_uplevel_ud *su_uplevel_storage_new(pTHX_ I32 cxix) {
1109 #define su_uplevel_storage_new(I) su_uplevel_storage_new(aTHX_ (I))
1114 sud = MY_CXT.uplevel_storage.root;
1116 MY_CXT.uplevel_storage.root = sud->next;
1117 MY_CXT.uplevel_storage.count--;
1119 sud = su_uplevel_ud_new();
1122 sud->next = MY_CXT.uplevel_storage.top;
1123 MY_CXT.uplevel_storage.top = sud;
1125 depth = su_uid_depth(cxix);
1126 su_uid_storage_dup(&sud->tmp_uid_storage, &MY_CXT.uid_storage, depth);
1127 sud->old_uid_storage = MY_CXT.uid_storage;
1128 MY_CXT.uid_storage = sud->tmp_uid_storage;
1133 STATIC void su_uplevel_storage_delete(pTHX_ su_uplevel_ud *sud) {
1134 #define su_uplevel_storage_delete(S) su_uplevel_storage_delete(aTHX_ (S))
1137 sud->tmp_uid_storage = MY_CXT.uid_storage;
1138 MY_CXT.uid_storage = sud->old_uid_storage;
1142 map = sud->tmp_uid_storage.map;
1143 alloc = sud->tmp_uid_storage.alloc;
1144 for (i = 0; i < alloc; ++i) {
1146 map[i]->flags &= SU_UID_ACTIVE;
1149 MY_CXT.uplevel_storage.top = sud->next;
1151 if (MY_CXT.uplevel_storage.count >= SU_UPLEVEL_STORAGE_SIZE) {
1152 su_uplevel_ud_delete(sud);
1154 sud->next = MY_CXT.uplevel_storage.root;
1155 MY_CXT.uplevel_storage.root = sud;
1156 MY_CXT.uplevel_storage.count++;
1160 STATIC int su_uplevel_goto_static(const OP *o) {
1161 for (; o; o = o->op_sibling) {
1162 /* goto ops are unops with kids. */
1163 if (!(o->op_flags & OPf_KIDS))
1166 switch (o->op_type) {
1169 /* Don't care about gotos inside eval, as they are forbidden at run time. */
1174 if (su_uplevel_goto_static(((const UNOP *) o)->op_first))
1183 #if SU_UPLEVEL_HIJACKS_RUNOPS
1185 STATIC int su_uplevel_goto_runops(pTHX) {
1186 #define su_uplevel_goto_runops() su_uplevel_goto_runops(aTHX)
1192 if (op->op_type == OP_GOTO) {
1193 AV *argarray = NULL;
1196 for (cxix = cxstack_ix; cxix >= 0; --cxix) {
1197 const PERL_CONTEXT *cx = cxstack + cxix;
1199 switch (CxTYPE(cx)) {
1201 if (CxHASARGS(cx)) {
1202 argarray = cx->blk_sub.argarray;
1218 if (MY_CXT.uplevel_storage.top->cxix == cxix) {
1219 AV *args = GvAV(PL_defgv);
1220 I32 items = AvFILLp(args);
1222 av_extend(argarray, items);
1223 Copy(AvARRAY(args), AvARRAY(argarray), items + 1, SV *);
1224 AvFILLp(argarray) = items;
1229 PL_op = op = op->op_ppaddr(aTHX);
1231 #if !SU_HAS_PERL(5, 13, 0)
1241 #endif /* SU_UPLEVEL_HIJACKS_RUNOPS */
1243 #define su_at_underscore(C) PadARRAY(PadlistARRAY(CvPADLIST(C))[CvDEPTH(C)])[0]
1245 STATIC void su_uplevel_restore(pTHX_ void *sus_) {
1246 su_uplevel_ud *sud = sus_;
1247 PERL_SI *cur = sud->old_curstackinfo;
1248 PERL_SI *si = sud->si;
1250 #if SU_UPLEVEL_HIJACKS_RUNOPS
1251 if (PL_runops == su_uplevel_goto_runops)
1252 PL_runops = sud->old_runops;
1255 if (sud->callback) {
1256 PERL_CONTEXT *cx = cxstack + sud->cxix;
1257 AV *argarray = MUTABLE_AV(su_at_underscore(sud->callback));
1259 /* We have to fix the pad entry for @_ in the original callback because it
1260 * may have been reified. */
1261 if (AvREAL(argarray)) {
1262 const I32 fill = AvFILLp(argarray);
1263 SvREFCNT_dec(argarray);
1265 AvREAL_off(argarray);
1266 AvREIFY_on(argarray);
1267 av_extend(argarray, fill);
1268 su_at_underscore(sud->callback) = MUTABLE_SV(argarray);
1270 CLEAR_ARGARRAY(argarray);
1273 /* If the old cv member is our renamed CV, it means that this place has been
1274 * reached without a goto() happening, and the old argarray member is
1275 * actually our fake argarray. Destroy it properly in that case. */
1276 if (cx->blk_sub.cv == sud->renamed) {
1277 SvREFCNT_dec(cx->blk_sub.argarray);
1278 cx->blk_sub.argarray = argarray;
1281 CvDEPTH(sud->callback)--;
1282 SvREFCNT_dec(sud->callback);
1285 /* Free the renamed CV. We must do it ourselves so that we can force the
1286 * depth to be 0, or perl would complain about it being "still in use".
1287 * But we *know* that it cannot be so. */
1289 CvDEPTH(sud->renamed) = 0;
1290 CvPADLIST(sud->renamed) = NULL;
1291 SvREFCNT_dec(sud->renamed);
1294 CATCH_SET(sud->old_catch);
1296 SU_UPLEVEL_RESTORE(op);
1298 /* stack_grow() wants PL_curstack so restore the old stack first */
1299 if (PL_curstackinfo == si) {
1300 PL_curstack = cur->si_stack;
1301 if (sud->old_mainstack)
1302 SU_UPLEVEL_RESTORE(mainstack);
1303 SU_UPLEVEL_RESTORE(curstackinfo);
1306 CV *target = sud->target;
1309 /* When we die, the depth of the target CV is not updated because of the
1310 * stack switcheroo. So we have to look at all the frames between the
1311 * uplevel call and the catch block to count how many call frames to the
1312 * target CV were skipped. */
1313 for (i = cur->si_cxix; i > sud->cxix; i--) {
1314 register const PERL_CONTEXT *cx = cxstack + i;
1316 if (CxTYPE(cx) == CXt_SUB) {
1317 if (cx->blk_sub.cv == target)
1322 /* If we died, the replacement stack was already unwinded to the first
1323 * eval frame, and all the contexts down there were popped. We don't have
1324 * to pop manually any context of the original stack, because they must
1325 * have been in the replacement stack as well (since the second was copied
1326 * from the first). Thus we only have to make sure the original stack index
1327 * points to the context just below the first eval scope under the target
1329 for (; i >= 0; i--) {
1330 register const PERL_CONTEXT *cx = cxstack + i;
1332 switch (CxTYPE(cx)) {
1334 if (cx->blk_sub.cv == target)
1346 CvDEPTH(target) = sud->target_depth - levels;
1347 PL_curstackinfo->si_cxix = i - 1;
1349 #if !SU_HAS_PERL(5, 13, 1)
1350 /* Since $@ was maybe localized between the target frame and the uplevel
1351 * call, we forcefully flush the save stack to get rid of it and then
1352 * reset $@ to its proper value. Note that the the call to
1353 * su_uplevel_restore() must happen before the "reset $@" item of the save
1354 * stack is processed, as uplevel was called after the localization.
1355 * Andrew's changes to how $@ was handled, which were mainly integrated
1356 * between perl 5.13.0 and 5.13.1, fixed this. */
1357 if (ERRSV && SvTRUE(ERRSV)) {
1358 register const PERL_CONTEXT *cx = cxstack + i; /* This is the eval scope */
1359 SV *errsv = SvREFCNT_inc(ERRSV);
1360 PL_scopestack_ix = cx->blk_oldscopesp;
1361 leave_scope(PL_scopestack[PL_scopestack_ix]);
1362 sv_setsv(ERRSV, errsv);
1363 SvREFCNT_dec(errsv);
1369 SU_UPLEVEL_RESTORE(curcop);
1371 SvREFCNT_dec(sud->target);
1373 PL_stack_base = AvARRAY(cur->si_stack);
1374 PL_stack_sp = PL_stack_base + AvFILLp(cur->si_stack);
1375 PL_stack_max = PL_stack_base + AvMAX(cur->si_stack);
1377 /* When an exception is thrown from the uplevel'd subroutine,
1378 * su_uplevel_restore() may be called by the LEAVE in die_unwind() (renamed
1379 * die_where() in more recent perls), which has the sad habit of keeping a
1380 * pointer to the current context frame across this call. This means that we
1381 * can't free the temporary context stack we used for the uplevel call right
1382 * now, or that pointer upwards would point to garbage. */
1383 #if SU_HAS_PERL(5, 13, 7)
1384 /* This issue has been fixed in perl with commit 8f89e5a9, which was made
1385 * public in perl 5.13.7. */
1386 su_uplevel_storage_delete(sud);
1388 /* Otherwise, we just enqueue it back in the global storage list. */
1392 sud->tmp_uid_storage = MY_CXT.uid_storage;
1393 MY_CXT.uid_storage = sud->old_uid_storage;
1395 MY_CXT.uplevel_storage.top = sud->next;
1396 sud->next = MY_CXT.uplevel_storage.root;
1397 MY_CXT.uplevel_storage.root = sud;
1398 MY_CXT.uplevel_storage.count++;
1405 STATIC CV *su_cv_clone(pTHX_ CV *proto, GV *gv) {
1406 #define su_cv_clone(P, G) su_cv_clone(aTHX_ (P), (G))
1410 cv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
1412 CvFLAGS(cv) = CvFLAGS(proto);
1414 CvFLAGS(cv) &= ~CVf_CVGV_RC;
1416 CvDEPTH(cv) = CvDEPTH(proto);
1418 CvFILE(cv) = CvISXSUB(proto) ? CvFILE(proto) : savepv(CvFILE(proto));
1420 CvFILE(cv) = CvFILE(proto);
1424 CvSTASH_set(cv, CvSTASH(proto));
1425 /* Commit 4c74a7df, publicized with perl 5.13.3, began to add backrefs to
1426 * stashes. CvSTASH_set() started to do it as well with commit c68d95645
1427 * (which was part of perl 5.13.7). */
1428 #if SU_HAS_PERL(5, 13, 3) && !SU_HAS_PERL(5, 13, 7)
1430 Perl_sv_add_backref(aTHX_ CvSTASH(proto), MUTABLE_SV(cv));
1433 if (CvISXSUB(proto)) {
1434 CvXSUB(cv) = CvXSUB(proto);
1435 CvXSUBANY(cv) = CvXSUBANY(proto);
1438 CvROOT(cv) = OpREFCNT_inc(CvROOT(proto));
1440 CvSTART(cv) = CvSTART(proto);
1442 CvOUTSIDE(cv) = CvOUTSIDE(proto);
1443 #ifdef CVf_WEAKOUTSIDE
1444 if (!(CvFLAGS(proto) & CVf_WEAKOUTSIDE))
1446 SvREFCNT_inc_simple_void(CvOUTSIDE(cv));
1447 CvPADLIST(cv) = CvPADLIST(proto);
1448 #ifdef CvOUTSIDE_SEQ
1449 CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1453 sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
1463 STATIC I32 su_uplevel(pTHX_ CV *callback, I32 cxix, I32 args) {
1464 #define su_uplevel(C, I, A) su_uplevel(aTHX_ (C), (I), (A))
1466 const PERL_CONTEXT *cx = cxstack + cxix;
1468 PERL_SI *cur = PL_curstackinfo;
1474 I32 old_mark, new_mark;
1481 /* Make PL_stack_sp point just before the CV. */
1482 PL_stack_sp -= args + 1;
1483 old_mark = AvFILLp(PL_curstack) = PL_stack_sp - PL_stack_base;
1486 sud = su_uplevel_storage_new(cxix);
1490 sud->callback = NULL;
1491 sud->renamed = NULL;
1492 SAVEDESTRUCTOR_X(su_uplevel_restore, sud);
1496 si->si_type = cur->si_type;
1498 si->si_prev = cur->si_prev;
1500 si->si_markoff = cx->blk_oldmarksp;
1503 /* Allocate enough space for all the elements of the original stack up to the
1504 * target context, plus the forthcoming arguments. */
1505 new_mark = cx->blk_oldsp;
1506 av_extend(si->si_stack, new_mark + 1 + args + 1);
1507 Copy(PL_curstack, AvARRAY(si->si_stack), new_mark + 1, SV *);
1508 AvFILLp(si->si_stack) = new_mark;
1509 SU_POISON(AvARRAY(si->si_stack) + new_mark + 1, args + 1, SV *);
1511 /* Specialized SWITCHSTACK() */
1512 PL_stack_base = AvARRAY(si->si_stack);
1513 old_stack_sp = PL_stack_sp;
1514 PL_stack_sp = PL_stack_base + AvFILLp(si->si_stack);
1515 PL_stack_max = PL_stack_base + AvMAX(si->si_stack);
1518 /* Copy the context stack up to the context just below the target. */
1519 si->si_cxix = (cxix < 0) ? -1 : (cxix - 1);
1520 if (si->si_cxmax < cxix) {
1521 /* The max size must be at least two so that GROW(max) = (max*3)/2 > max */
1522 si->si_cxmax = (cxix < 4) ? 4 : cxix;
1523 Renew(si->si_cxstack, si->si_cxmax + 1, PERL_CONTEXT);
1525 Copy(cur->si_cxstack, si->si_cxstack, cxix, PERL_CONTEXT);
1526 SU_POISON(si->si_cxstack + cxix, si->si_cxmax + 1 - cxix, PERL_CONTEXT);
1528 target = cx->blk_sub.cv;
1529 sud->target = (CV *) SvREFCNT_inc(target);
1530 sud->target_depth = CvDEPTH(target);
1532 /* blk_oldcop is essentially needed for caller() and stack traces. It has no
1533 * run-time implication, since PL_curcop will be overwritten as soon as we
1534 * enter a sub (a sub starts by a nextstate/dbstate). Hence it's safe to just
1535 * make it point to the blk_oldcop for the target frame, so that caller()
1536 * reports the right file name, line number and lexical hints. */
1537 SU_UPLEVEL_SAVE(curcop, cx->blk_oldcop);
1538 /* Don't reset PL_markstack_ptr, or we would overwrite the mark stack below
1539 * this point. Don't reset PL_curpm either, we want the most recent matches. */
1541 SU_UPLEVEL_SAVE(curstackinfo, si);
1542 /* If those two are equal, we need to fool POPSTACK_TO() */
1543 if (PL_mainstack == PL_curstack)
1544 SU_UPLEVEL_SAVE(mainstack, si->si_stack);
1546 sud->old_mainstack = NULL;
1547 PL_curstack = si->si_stack;
1549 renamed = su_cv_clone(callback, CvGV(target));
1550 sud->renamed = renamed;
1553 /* Both SP and old_stack_sp point just before the CV. */
1554 Copy(old_stack_sp + 2, SP + 1, args, SV *);
1556 PUSHs((SV *) renamed);
1559 Zero(&sub_op, 1, UNOP);
1560 sub_op.op_type = OP_ENTERSUB;
1561 sub_op.op_next = NULL;
1562 sub_op.op_flags = OP_GIMME_REVERSE(gimme) | OPf_STACKED;
1564 sub_op.op_flags |= OPpENTERSUB_DB;
1566 SU_UPLEVEL_SAVE(op, (OP *) &sub_op);
1568 #if SU_UPLEVEL_HIJACKS_RUNOPS
1569 sud->old_runops = PL_runops;
1572 sud->old_catch = CATCH_GET;
1575 if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX))) {
1576 PERL_CONTEXT *sub_cx = cxstack + cxstack_ix;
1578 /* If pp_entersub() returns a non-null OP, it means that the callback is not
1581 sud->callback = MUTABLE_CV(SvREFCNT_inc(callback));
1582 CvDEPTH(callback)++;
1584 if (CxHASARGS(cx) && cx->blk_sub.argarray) {
1585 /* The call to pp_entersub() has saved the current @_ (in XS terms,
1586 * GvAV(PL_defgv)) in the savearray member, and has created a new argarray
1587 * with what we put on the stack. But we want to fake up the same arguments
1588 * as the ones in use at the context we uplevel to, so we replace the
1589 * argarray with an unreal copy of the original @_. */
1593 av_extend(av, AvMAX(cx->blk_sub.argarray));
1594 AvFILLp(av) = AvFILLp(cx->blk_sub.argarray);
1595 Copy(AvARRAY(cx->blk_sub.argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
1596 sub_cx->blk_sub.argarray = av;
1598 SvREFCNT_inc_simple_void(sub_cx->blk_sub.argarray);
1601 if (su_uplevel_goto_static(CvROOT(renamed))) {
1602 #if SU_UPLEVEL_HIJACKS_RUNOPS
1603 if (PL_runops != PL_runops_std) {
1604 if (PL_runops == PL_runops_dbg) {
1606 croak("uplevel() can't execute code that calls goto when debugging flags are set");
1607 } else if (PL_runops != su_uplevel_goto_runops)
1608 croak("uplevel() can't execute code that calls goto with a custom runloop");
1611 PL_runops = su_uplevel_goto_runops;
1612 #else /* SU_UPLEVEL_HIJACKS_RUNOPS */
1613 croak("uplevel() can't execute code that calls goto before perl 5.8");
1614 #endif /* !SU_UPLEVEL_HIJACKS_RUNOPS */
1622 ret = PL_stack_sp - (PL_stack_base + new_mark);
1624 AV *old_stack = sud->old_curstackinfo->si_stack;
1626 if (old_mark + ret > AvMAX(old_stack)) {
1627 /* Specialized EXTEND(old_sp, ret) */
1628 av_extend(old_stack, old_mark + ret + 1);
1629 old_stack_sp = AvARRAY(old_stack) + old_mark;
1632 Copy(PL_stack_sp - ret + 1, old_stack_sp + 1, ret, SV *);
1634 AvFILLp(old_stack) += ret;
1642 /* --- Unique context ID --------------------------------------------------- */
1644 STATIC su_uid *su_uid_storage_fetch(pTHX_ UV depth) {
1645 #define su_uid_storage_fetch(D) su_uid_storage_fetch(aTHX_ (D))
1650 map = MY_CXT.uid_storage.map;
1651 alloc = MY_CXT.uid_storage.alloc;
1653 if (depth >= alloc) {
1656 Renew(map, depth + 1, su_uid *);
1657 for (i = alloc; i <= depth; ++i)
1660 MY_CXT.uid_storage.map = map;
1661 MY_CXT.uid_storage.alloc = depth + 1;
1667 Newx(uid, 1, su_uid);
1673 if (depth >= MY_CXT.uid_storage.used)
1674 MY_CXT.uid_storage.used = depth + 1;
1679 STATIC int su_uid_storage_check(pTHX_ UV depth, UV seq) {
1680 #define su_uid_storage_check(D, S) su_uid_storage_check(aTHX_ (D), (S))
1684 if (depth >= MY_CXT.uid_storage.used)
1687 uid = MY_CXT.uid_storage.map[depth];
1689 return uid && (uid->seq == seq) && (uid->flags & SU_UID_ACTIVE);
1692 STATIC void su_uid_drop(pTHX_ void *ud_) {
1695 uid->flags &= ~SU_UID_ACTIVE;
1698 STATIC void su_uid_bump(pTHX_ void *ud_) {
1699 su_ud_reap *ud = ud_;
1701 SAVEDESTRUCTOR_X(su_uid_drop, ud->cb);
1704 STATIC SV *su_uid_get(pTHX_ I32 cxix) {
1705 #define su_uid_get(I) su_uid_get(aTHX_ (I))
1710 depth = su_uid_depth(cxix);
1711 uid = su_uid_storage_fetch(depth);
1713 if (!(uid->flags & SU_UID_ACTIVE)) {
1716 uid->seq = su_uid_seq_next(depth);
1717 uid->flags |= SU_UID_ACTIVE;
1719 Newx(ud, 1, su_ud_reap);
1720 SU_UD_ORIGIN(ud) = NULL;
1721 SU_UD_HANDLER(ud) = su_uid_bump;
1722 ud->cb = (SV *) uid;
1723 su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
1726 uid_sv = sv_newmortal();
1727 sv_setpvf(uid_sv, "%"UVuf"-%"UVuf, depth, uid->seq);
1733 #define su_grok_number(S, L, VP) grok_number((S), (L), (VP))
1735 #else /* grok_number */
1737 #define IS_NUMBER_IN_UV 0x1
1739 STATIC int su_grok_number(pTHX_ const char *s, STRLEN len, UV *valuep) {
1740 #define su_grok_number(S, L, VP) su_grok_number(aTHX_ (S), (L), (VP))
1744 /* This crude check should be good enough for a fallback implementation.
1745 * Better be too strict than too lax. */
1746 for (i = 0; i < len; ++i) {
1751 tmpsv = sv_newmortal();
1752 sv_setpvn(tmpsv, s, len);
1753 *valuep = sv_2uv(tmpsv);
1755 return IS_NUMBER_IN_UV;
1758 #endif /* !grok_number */
1760 STATIC int su_uid_validate(pTHX_ SV *uid) {
1761 #define su_uid_validate(U) su_uid_validate(aTHX_ (U))
1767 s = SvPV_const(uid, len);
1769 while (p < len && s[p] != '-')
1772 croak("UID contains only one part");
1774 type = su_grok_number(s, p, &depth);
1775 if (type != IS_NUMBER_IN_UV)
1776 croak("First UID part is not an unsigned integer");
1778 ++p; /* Skip '-'. As we used to have p < len, len - (p + 1) >= 0. */
1780 type = su_grok_number(s + p, len - p, &seq);
1781 if (type != IS_NUMBER_IN_UV)
1782 croak("Second UID part is not an unsigned integer");
1784 return su_uid_storage_check(depth, seq);
1787 /* --- Context operations -------------------------------------------------- */
1789 /* Remove sequences of BLOCKs having DB for stash, followed by a SUB context
1790 * for the debugger callback. */
1792 STATIC I32 su_context_skip_db(pTHX_ I32 cxix) {
1793 #define su_context_skip_db(C) su_context_skip_db(aTHX_ (C))
1799 for (i = cxix; i > 0; --i) {
1800 PERL_CONTEXT *cx = cxstack + i;
1802 switch (CxTYPE(cx)) {
1804 if (cx->blk_oldcop && CopSTASH(cx->blk_oldcop) == GvSTASH(PL_DBgv))
1808 if (cx->blk_sub.cv == GvCV(PL_DBsub)) {
1824 STATIC I32 su_context_normalize_up(pTHX_ I32 cxix) {
1825 #define su_context_normalize_up(C) su_context_normalize_up(aTHX_ (C))
1831 cx = cxstack + cxix;
1832 if (CxTYPE(cx) == CXt_BLOCK) {
1833 PERL_CONTEXT *prev = cx - 1;
1835 switch (CxTYPE(prev)) {
1836 #if SU_HAS_PERL(5, 10, 0)
1840 #if SU_HAS_PERL(5, 11, 0)
1841 /* That's the only subcategory that can cause an extra BLOCK context */
1842 case CXt_LOOP_PLAIN:
1846 if (cx->blk_oldcop == prev->blk_oldcop)
1850 if (cx->blk_oldcop && cx->blk_oldcop->op_sibling
1851 && cx->blk_oldcop->op_sibling->op_type == OP_SUBST)
1860 STATIC I32 su_context_normalize_down(pTHX_ I32 cxix) {
1861 #define su_context_normalize_down(C) su_context_normalize_down(aTHX_ (C))
1864 if (cxix >= cxstack_ix)
1867 next = cxstack + cxix + 1;
1868 if (CxTYPE(next) == CXt_BLOCK) {
1869 PERL_CONTEXT *cx = next - 1;
1871 switch (CxTYPE(cx)) {
1872 #if SU_HAS_PERL(5, 10, 0)
1876 #if SU_HAS_PERL(5, 11, 0)
1877 /* That's the only subcategory that can cause an extra BLOCK context */
1878 case CXt_LOOP_PLAIN:
1882 if (cx->blk_oldcop == next->blk_oldcop)
1886 if (next->blk_oldcop && next->blk_oldcop->op_sibling
1887 && next->blk_oldcop->op_sibling->op_type == OP_SUBST)
1896 #define su_context_here() su_context_normalize_up(su_context_skip_db(cxstack_ix))
1898 /* --- Interpreter setup/teardown ------------------------------------------ */
1900 STATIC void su_teardown(pTHX_ void *param) {
1905 map = MY_CXT.uid_storage.map;
1908 for (i = 0; i < MY_CXT.uid_storage.used; ++i)
1913 cur = MY_CXT.uplevel_storage.root;
1915 su_uplevel_ud *prev;
1919 su_uplevel_ud_delete(prev);
1926 STATIC void su_setup(pTHX) {
1927 #define su_setup() su_setup(aTHX)
1930 MY_CXT.stack_placeholder = NULL;
1932 /* NewOp() calls calloc() which just zeroes the memory with memset(). */
1933 Zero(&(MY_CXT.unwind_storage.return_op), 1, LISTOP);
1934 MY_CXT.unwind_storage.return_op.op_type = OP_RETURN;
1935 MY_CXT.unwind_storage.return_op.op_ppaddr = PL_ppaddr[OP_RETURN];
1937 Zero(&(MY_CXT.unwind_storage.proxy_op), 1, OP);
1938 MY_CXT.unwind_storage.proxy_op.op_type = OP_STUB;
1939 MY_CXT.unwind_storage.proxy_op.op_ppaddr = NULL;
1941 MY_CXT.uplevel_storage.top = NULL;
1942 MY_CXT.uplevel_storage.root = NULL;
1943 MY_CXT.uplevel_storage.count = 0;
1945 MY_CXT.uid_storage.map = NULL;
1946 MY_CXT.uid_storage.used = 0;
1947 MY_CXT.uid_storage.alloc = 0;
1949 call_atexit(su_teardown, NULL);
1954 /* --- XS ------------------------------------------------------------------ */
1956 #define SU_GET_CONTEXT(A, B, D) \
1965 else if (cxix > cxstack_ix) \
1973 #define SU_GET_LEVEL(A, B) \
1979 level = SvIV(lsv); \
1986 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
1988 XS(XS_Scope__Upper_unwind) {
1997 PERL_UNUSED_VAR(cv); /* -W */
1998 PERL_UNUSED_VAR(ax); /* -Wall */
2000 SU_GET_CONTEXT(0, items - 1, cxstack_ix);
2002 PERL_CONTEXT *cx = cxstack + cxix;
2003 switch (CxTYPE(cx)) {
2005 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2009 MY_CXT.unwind_storage.cxix = cxix;
2010 MY_CXT.unwind_storage.items = items;
2011 /* pp_entersub will want to sanitize the stack after returning from there
2012 * Screw that, we're insane */
2013 if (GIMME_V == G_SCALAR) {
2014 MY_CXT.unwind_storage.savesp = PL_stack_sp;
2015 /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
2016 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2018 MY_CXT.unwind_storage.savesp = NULL;
2020 SAVEDESTRUCTOR_X(su_unwind, NULL);
2025 } while (--cxix >= 0);
2026 croak("Can't return outside a subroutine");
2029 MODULE = Scope::Upper PACKAGE = Scope::Upper
2037 MUTEX_INIT(&su_uid_seq_counter_mutex);
2039 su_uid_seq_counter.seqs = NULL;
2040 su_uid_seq_counter.size = 0;
2042 stash = gv_stashpv(__PACKAGE__, 1);
2043 newCONSTSUB(stash, "TOP", newSViv(0));
2044 newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(SU_THREADSAFE));
2046 newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
2057 su_uid_storage new_cxt;
2064 su_uid_storage_dup(&new_cxt, &MY_CXT.uid_storage, MY_CXT.uid_storage.used);
2068 MY_CXT.uplevel_storage.top = NULL;
2069 MY_CXT.uplevel_storage.root = NULL;
2070 MY_CXT.uplevel_storage.count = 0;
2071 MY_CXT.uid_storage = new_cxt;
2075 #endif /* SU_THREADSAFE */
2083 cxix = su_context_here();
2094 SU_GET_CONTEXT(0, 0, su_context_here());
2097 cxix = su_context_skip_db(cxix);
2098 cxix = su_context_normalize_up(cxix);
2110 SU_GET_CONTEXT(0, 0, cxstack_ix);
2112 for (; cxix >= 0; --cxix) {
2113 PERL_CONTEXT *cx = cxstack + cxix;
2114 switch (CxTYPE(cx)) {
2118 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2132 SU_GET_CONTEXT(0, 0, cxstack_ix);
2134 for (; cxix >= 0; --cxix) {
2135 PERL_CONTEXT *cx = cxstack + cxix;
2136 switch (CxTYPE(cx)) {
2153 cxix = su_context_here();
2154 while (--level >= 0) {
2158 cxix = su_context_skip_db(cxix);
2159 cxix = su_context_normalize_up(cxix);
2172 for (cxix = cxstack_ix; cxix > 0; --cxix) {
2173 PERL_CONTEXT *cx = cxstack + cxix;
2174 switch (CxTYPE(cx)) {
2176 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2196 SU_GET_CONTEXT(0, 0, cxstack_ix);
2199 PERL_CONTEXT *cx = cxstack + cxix--;
2200 switch (CxTYPE(cx)) {
2202 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2206 I32 gimme = cx->blk_gimme;
2208 case G_VOID: XSRETURN_UNDEF; break;
2209 case G_SCALAR: XSRETURN_NO; break;
2210 case G_ARRAY: XSRETURN_YES; break;
2225 SU_GET_CONTEXT(1, 1, su_context_skip_db(cxstack_ix));
2226 cxix = su_context_normalize_down(cxix);
2227 Newx(ud, 1, su_ud_reap);
2228 SU_UD_ORIGIN(ud) = NULL;
2229 SU_UD_HANDLER(ud) = su_reap;
2230 ud->cb = newSVsv(hook);
2231 su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
2234 localize(SV *sv, SV *val, ...)
2241 SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
2242 cxix = su_context_normalize_down(cxix);
2243 Newx(ud, 1, su_ud_localize);
2244 SU_UD_ORIGIN(ud) = NULL;
2245 SU_UD_HANDLER(ud) = su_localize;
2246 size = su_ud_localize_init(ud, sv, val, NULL);
2247 su_init(ud, cxix, size);
2250 localize_elem(SV *sv, SV *elem, SV *val, ...)
2257 if (SvTYPE(sv) >= SVt_PVGV)
2258 croak("Can't infer the element localization type from a glob and the value");
2259 SU_GET_CONTEXT(3, 3, su_context_skip_db(cxstack_ix));
2260 cxix = su_context_normalize_down(cxix);
2261 Newx(ud, 1, su_ud_localize);
2262 SU_UD_ORIGIN(ud) = NULL;
2263 SU_UD_HANDLER(ud) = su_localize;
2264 size = su_ud_localize_init(ud, sv, val, elem);
2265 if (ud->type != SVt_PVAV && ud->type != SVt_PVHV) {
2266 SU_UD_LOCALIZE_FREE(ud);
2267 croak("Can't localize an element of something that isn't an array or a hash");
2269 su_init(ud, cxix, size);
2272 localize_delete(SV *sv, SV *elem, ...)
2279 SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
2280 cxix = su_context_normalize_down(cxix);
2281 Newx(ud, 1, su_ud_localize);
2282 SU_UD_ORIGIN(ud) = NULL;
2283 SU_UD_HANDLER(ud) = su_localize;
2284 size = su_ud_localize_init(ud, sv, NULL, elem);
2285 su_init(ud, cxix, size);
2288 uplevel(SV *code, ...)
2291 I32 cxix, ret, args = 0;
2295 if (SvTYPE(code) < SVt_PVCV)
2296 croak("First argument to uplevel must be a code reference");
2297 SU_GET_CONTEXT(1, items - 1, cxstack_ix);
2299 PERL_CONTEXT *cx = cxstack + cxix;
2300 switch (CxTYPE(cx)) {
2302 croak("Can't uplevel to an eval frame");
2304 croak("Can't uplevel to a format frame");
2306 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2312 /* su_uplevel() takes care of extending the stack if needed. */
2313 ret = su_uplevel((CV *) code, cxix, args);
2318 } while (--cxix >= 0);
2319 croak("Can't uplevel outside a subroutine");
2328 SU_GET_CONTEXT(0, 0, su_context_here());
2329 uid = su_uid_get(cxix);
2335 validate_uid(SV *uid)
2340 ret = su_uid_validate(uid) ? &PL_sv_yes : &PL_sv_no;