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 PERL_MAGIC_tied
137 # define PERL_MAGIC_tied 'P'
140 #ifndef PERL_MAGIC_env
141 # define PERL_MAGIC_env 'E'
144 #ifndef NEGATIVE_INDICES_VAR
145 # define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
148 #define SU_HAS_PERL(R, V, S) (PERL_REVISION > (R) || (PERL_REVISION == (R) && (PERL_VERSION > (V) || (PERL_VERSION == (V) && (PERL_SUBVERSION >= (S))))))
149 #define SU_HAS_PERL_EXACT(R, V, S) ((PERL_REVISION == (R)) && (PERL_VERSION == (V)) && (PERL_SUBVERSION == (S)))
151 /* --- Threads and multiplicity -------------------------------------------- */
153 #ifndef SU_MULTIPLICITY
154 # if defined(MULTIPLICITY) || defined(PERL_IMPLICIT_CONTEXT)
155 # define SU_MULTIPLICITY 1
157 # define SU_MULTIPLICITY 0
160 #if SU_MULTIPLICITY && !defined(tTHX)
161 # define tTHX PerlInterpreter*
164 #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))
165 # define SU_THREADSAFE 1
166 # ifndef MY_CXT_CLONE
167 # define MY_CXT_CLONE \
169 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1)); \
170 Copy(INT2PTR(my_cxt_t*, SvUV(my_cxt_sv)), my_cxtp, 1, my_cxt_t); \
171 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
174 # define SU_THREADSAFE 0
176 # define dMY_CXT dNOOP
178 # define MY_CXT su_globaldata
180 # define START_MY_CXT STATIC my_cxt_t MY_CXT;
182 # define MY_CXT_INIT NOOP
184 # define MY_CXT_CLONE NOOP
187 /* --- Unique context ID global storage ------------------------------------ */
189 /* ... Sequence ID counter ................................................. */
196 STATIC su_uv_array su_uid_seq_counter;
200 STATIC perl_mutex su_uid_seq_counter_mutex;
202 #define SU_LOCK(M) MUTEX_LOCK(M)
203 #define SU_UNLOCK(M) MUTEX_UNLOCK(M)
205 #else /* USE_ITHREADS */
210 #endif /* !USE_ITHREADS */
212 STATIC UV su_uid_seq_next(pTHX_ UV depth) {
213 #define su_uid_seq_next(D) su_uid_seq_next(aTHX_ (D))
217 SU_LOCK(&su_uid_seq_counter_mutex);
219 seqs = su_uid_seq_counter.seqs;
221 if (depth >= su_uid_seq_counter.size) {
224 seqs = PerlMemShared_realloc(seqs, (depth + 1) * sizeof(UV));
225 for (i = su_uid_seq_counter.size; i <= depth; ++i)
228 su_uid_seq_counter.seqs = seqs;
229 su_uid_seq_counter.size = depth + 1;
234 SU_UNLOCK(&su_uid_seq_counter_mutex);
239 /* ... UID storage ......................................................... */
246 #define SU_UID_ACTIVE 1
248 STATIC UV su_uid_depth(pTHX_ I32 cxix) {
249 #define su_uid_depth(I) su_uid_depth(aTHX_ (I))
254 for (si = PL_curstackinfo->si_prev; si; si = si->si_prev)
255 depth += si->si_cxix + 1;
266 STATIC void su_uid_storage_dup(pTHX_ su_uid_storage *new_cxt, const su_uid_storage *old_cxt, UV max_depth) {
267 #define su_uid_storage_dup(N, O, D) su_uid_storage_dup(aTHX_ (N), (O), (D))
268 su_uid **old_map = old_cxt->map;
271 su_uid **new_map = new_cxt->map;
272 STRLEN old_used = old_cxt->used;
273 STRLEN old_alloc = old_cxt->alloc;
274 STRLEN new_used, new_alloc;
277 new_used = max_depth < old_used ? max_depth : old_used;
278 new_cxt->used = new_used;
280 if (new_used <= new_cxt->alloc)
281 new_alloc = new_cxt->alloc;
283 new_alloc = new_used;
284 Renew(new_map, new_alloc, su_uid *);
285 for (i = new_cxt->alloc; i < new_alloc; ++i)
287 new_cxt->map = new_map;
288 new_cxt->alloc = new_alloc;
291 for (i = 0; i < new_alloc; ++i) {
292 su_uid *new_uid = new_map[i];
294 if (i < new_used) { /* => i < max_depth && i < old_used */
295 su_uid *old_uid = old_map[i];
297 if (old_uid && (old_uid->flags & SU_UID_ACTIVE)) {
299 Newx(new_uid, 1, su_uid);
300 new_map[i] = new_uid;
308 new_uid->flags &= ~SU_UID_ACTIVE;
315 /* --- unwind() global storage --------------------------------------------- */
325 /* --- uplevel() data tokens and global storage ---------------------------- */
327 #define SU_UPLEVEL_HIJACKS_RUNOPS SU_HAS_PERL(5, 8, 0)
332 su_uid_storage tmp_uid_storage;
333 su_uid_storage old_uid_storage;
344 PERL_SI *old_curstackinfo;
350 #if SU_UPLEVEL_HIJACKS_RUNOPS
351 runops_proc_t old_runops;
358 STATIC su_uplevel_ud *su_uplevel_ud_new(pTHX) {
359 #define su_uplevel_ud_new() su_uplevel_ud_new(aTHX)
363 Newx(sud, 1, su_uplevel_ud);
366 sud->tmp_uid_storage.map = NULL;
367 sud->tmp_uid_storage.used = 0;
368 sud->tmp_uid_storage.alloc = 0;
370 Newx(si, 1, PERL_SI);
371 si->si_stack = newAV();
372 AvREAL_off(si->si_stack);
373 si->si_cxstack = NULL;
381 STATIC void su_uplevel_ud_delete(pTHX_ su_uplevel_ud *sud) {
382 #define su_uplevel_ud_delete(S) su_uplevel_ud_delete(aTHX_ (S))
383 PERL_SI *si = sud->si;
385 Safefree(si->si_cxstack);
386 SvREFCNT_dec(si->si_stack);
389 if (sud->tmp_uid_storage.map) {
390 su_uid **map = sud->tmp_uid_storage.map;
391 STRLEN alloc = sud->tmp_uid_storage.alloc;
394 for (i = 0; i < alloc; ++i)
409 } su_uplevel_storage;
411 #ifndef SU_UPLEVEL_STORAGE_SIZE
412 # define SU_UPLEVEL_STORAGE_SIZE 4
415 /* --- Global data --------------------------------------------------------- */
417 #define MY_CXT_KEY __PACKAGE__ "::_guts" XS_VERSION
420 char *stack_placeholder;
421 su_unwind_storage unwind_storage;
422 su_uplevel_storage uplevel_storage;
423 su_uid_storage uid_storage;
428 /* --- Stack manipulations ------------------------------------------------- */
430 #define SU_SAVE_PLACEHOLDER() save_pptr(&MY_CXT.stack_placeholder)
432 #define SU_SAVE_DESTRUCTOR_SIZE 3
433 #define SU_SAVE_PLACEHOLDER_SIZE 3
435 #define SU_SAVE_SCALAR_SIZE 3
437 #define SU_SAVE_ARY_SIZE 3
438 #define SU_SAVE_AELEM_SIZE 4
440 # define SU_SAVE_ADELETE_SIZE 3
442 # define SU_SAVE_ADELETE_SIZE SU_SAVE_DESTRUCTOR_SIZE
444 #if SU_SAVE_AELEM_SIZE < SU_SAVE_ADELETE_SIZE
445 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_ADELETE_SIZE
447 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_AELEM_SIZE
450 #define SU_SAVE_HASH_SIZE 3
451 #define SU_SAVE_HELEM_SIZE 4
452 #define SU_SAVE_HDELETE_SIZE 4
453 #if SU_SAVE_HELEM_SIZE < SU_SAVE_HDELETE_SIZE
454 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HDELETE_SIZE
456 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HELEM_SIZE
459 #define SU_SAVE_GVCV_SIZE SU_SAVE_DESTRUCTOR_SIZE
461 #if !SU_HAS_PERL(5, 8, 9)
462 # define SU_SAVE_GP_SIZE 6
463 #elif !SU_HAS_PERL(5, 13, 0) || (SU_RELEASE && SU_HAS_PERL_EXACT(5, 13, 0))
464 # define SU_SAVE_GP_SIZE 3
465 #elif !SU_HAS_PERL(5, 13, 8)
466 # define SU_SAVE_GP_SIZE 4
468 # define SU_SAVE_GP_SIZE 3
471 #ifndef SvCANEXISTDELETE
472 # define SvCANEXISTDELETE(sv) \
474 || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied)) \
475 && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
476 && gv_fetchmethod_autoload(stash, "EXISTS", TRUE) \
477 && gv_fetchmethod_autoload(stash, "DELETE", TRUE) \
482 /* ... Saving array elements ............................................... */
484 STATIC I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
485 #define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
491 /* Added by MJD in perl-5.8.1 with 6f12eb6d2a1dfaf441504d869b27d2e40ef4966a */
492 #if SU_HAS_PERL(5, 8, 1)
493 if (SvRMAGICAL(av)) {
494 const MAGIC * const tied_magic = mg_find((SV *) av, PERL_MAGIC_tied);
496 SV * const * const negative_indices_glob =
497 hv_fetch(SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
498 NEGATIVE_INDICES_VAR, 16, 0);
499 if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
505 idx = key + av_len(av) + 1;
519 STATIC void su_adelete(pTHX_ void *ud_) {
520 su_ud_adelete *ud = (su_ud_adelete *) ud_;
522 av_delete(ud->av, ud->idx, G_DISCARD);
523 SvREFCNT_dec(ud->av);
528 STATIC void su_save_adelete(pTHX_ AV *av, I32 idx) {
529 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
532 Newx(ud, 1, su_ud_adelete);
535 SvREFCNT_inc_simple_void(av);
537 SAVEDESTRUCTOR_X(su_adelete, ud);
540 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
542 #endif /* SAVEADELETE */
544 STATIC void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
545 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
552 idx = su_av_key2idx(av, SvIV(key));
554 if (SvCANEXISTDELETE(av))
555 preeminent = av_exists(av, idx);
557 svp = av_fetch(av, idx, 1);
558 if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
561 save_aelem(av, idx, svp);
563 SAVEADELETE(av, idx);
565 if (val) { /* local $x[$idx] = $val; */
566 SvSetMagicSV(*svp, val);
567 } else { /* local $x[$idx]; delete $x[$idx]; */
568 av_delete(av, idx, G_DISCARD);
572 /* ... Saving hash elements ................................................ */
574 STATIC void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
575 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
582 if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
583 preeminent = hv_exists_ent(hv, keysv, 0);
585 he = hv_fetch_ent(hv, keysv, 1, 0);
586 svp = he ? &HeVAL(he) : NULL;
587 if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
589 if (HvNAME_get(hv) && isGV(*svp)) {
590 save_gp((GV *) *svp, 0);
595 save_helem(hv, keysv, svp);
598 const char * const key = SvPV_const(keysv, keylen);
599 SAVEDELETE(hv, savepvn(key, keylen),
600 SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
603 if (val) { /* local $x{$keysv} = $val; */
604 SvSetMagicSV(*svp, val);
605 } else { /* local $x{$keysv}; delete $x{$keysv}; */
606 (void)hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
610 /* ... Saving code slots from a glob ....................................... */
612 #if !SU_HAS_PERL(5, 10, 0) && !defined(mro_method_changed_in)
613 # define mro_method_changed_in(G) PL_sub_generation++
621 STATIC void su_restore_gvcv(pTHX_ void *ud_) {
622 su_save_gvcv_ud *ud = ud_;
625 GvCV_set(gv, ud->old_cv);
627 mro_method_changed_in(GvSTASH(gv));
632 STATIC void su_save_gvcv(pTHX_ GV *gv) {
633 #define su_save_gvcv(G) su_save_gvcv(aTHX_ (G))
636 Newx(ud, 1, su_save_gvcv_ud);
638 ud->old_cv = GvCV(gv);
642 mro_method_changed_in(GvSTASH(gv));
644 SAVEDESTRUCTOR_X(su_restore_gvcv, ud);
647 /* --- Actions ------------------------------------------------------------- */
653 void (*handler)(pTHX_ void *);
656 #define SU_UD_DEPTH(U) (((su_ud_common *) (U))->depth)
657 #define SU_UD_PAD(U) (((su_ud_common *) (U))->pad)
658 #define SU_UD_ORIGIN(U) (((su_ud_common *) (U))->origin)
659 #define SU_UD_HANDLER(U) (((su_ud_common *) (U))->handler)
661 #define SU_UD_FREE(U) STMT_START { \
662 if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
666 /* ... Reap ................................................................ */
668 #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))
675 STATIC void su_call(pTHX_ void *ud_) {
676 su_ud_reap *ud = (su_ud_reap *) ud_;
679 PERL_CONTEXT saved_cx;
680 #endif /* SU_SAVE_LAST_CX */
685 PerlIO_printf(Perl_debug_log,
686 "%p: @@@ call\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
687 ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
697 /* If the recently popped context isn't saved there, it will be overwritten by
698 * the sub scope from call_sv, although it's still needed in our caller. */
699 cxix = (cxstack_ix < cxstack_max) ? (cxstack_ix + 1) : Perl_cxinc(aTHX);
700 saved_cx = cxstack[cxix];
701 #endif /* SU_SAVE_LAST_CX */
703 call_sv(ud->cb, G_VOID);
706 cxstack[cxix] = saved_cx;
707 #endif /* SU_SAVE_LAST_CX */
714 SvREFCNT_dec(ud->cb);
718 STATIC void su_reap(pTHX_ void *ud) {
719 #define su_reap(U) su_reap(aTHX_ (U))
721 PerlIO_printf(Perl_debug_log,
722 "%p: === reap\n%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
723 ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
726 SAVEDESTRUCTOR_X(su_call, ud);
729 /* ... Localize & localize array/hash element .............................. */
739 #define SU_UD_LOCALIZE_FREE(U) STMT_START { \
740 SvREFCNT_dec((U)->elem); \
741 SvREFCNT_dec((U)->val); \
742 SvREFCNT_dec((U)->sv); \
746 STATIC I32 su_ud_localize_init(pTHX_ su_ud_localize *ud, SV *sv, SV *val, SV *elem) {
747 #define su_ud_localize_init(UD, S, V, E) su_ud_localize_init(aTHX_ (UD), (S), (V), (E))
752 SvREFCNT_inc_simple_void(sv);
754 if (SvTYPE(sv) >= SVt_PVGV) {
755 if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
757 } else { /* local *x = \$val; */
758 t = SvTYPE(SvRV(val));
761 } else if (SvROK(sv)) {
762 croak("Invalid %s reference as the localization target",
763 sv_reftype(SvRV(sv), 0));
766 const char *p = SvPV_const(sv, len), *s;
767 for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
773 case '$': t = SVt_PV; break;
774 case '@': t = SVt_PVAV; break;
775 case '%': t = SVt_PVHV; break;
776 case '&': t = SVt_PVCV; break;
777 case '*': t = SVt_PVGV; break;
782 } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
783 if (SvROK(val) && !sv_isobject(val)) {
784 t = SvTYPE(SvRV(val));
796 size = elem ? SU_SAVE_AELEM_OR_ADELETE_SIZE
801 size = elem ? SU_SAVE_HELEM_OR_HDELETE_SIZE
806 size = SU_SAVE_GP_SIZE;
810 size = SU_SAVE_GVCV_SIZE;
814 size = SU_SAVE_SCALAR_SIZE;
817 /* When deref is set, val isn't NULL */
820 ud->val = val ? newSVsv(deref ? SvRV(val) : val) : NULL;
821 ud->elem = SvREFCNT_inc(elem);
827 STATIC void su_localize(pTHX_ void *ud_) {
828 #define su_localize(U) su_localize(aTHX_ (U))
829 su_ud_localize *ud = (su_ud_localize *) ud_;
836 if (SvTYPE(sv) >= SVt_PVGV) {
840 gv = gv_fetchsv(sv, GV_ADDMULTI, t);
843 const char *name = SvPV_const(sv, len);
844 gv = gv_fetchpvn_flags(name, len, GV_ADDMULTI, t);
851 PerlIO_printf(Perl_debug_log, "%p: === localize a %s\n",ud, sv_reftype(z, 0));
852 PerlIO_printf(Perl_debug_log,
853 "%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
854 ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
858 /* Inspired from Alias.pm */
862 su_save_aelem(GvAV(gv), elem, val);
869 su_save_helem(GvHV(gv), elem, val);
875 save_gp(gv, 1); /* hide previous entry in symtab */
881 gv = (GV *) save_scalar(gv);
886 SvSetMagicSV((SV *) gv, val);
889 SU_UD_LOCALIZE_FREE(ud);
892 /* --- Pop a context back -------------------------------------------------- */
896 # define SU_CXNAME PL_block_type[CxTYPE(&cxstack[cxstack_ix])]
898 # define SU_CXNAME "XXX"
902 STATIC void su_pop(pTHX_ void *ud) {
903 #define su_pop(U) su_pop(aTHX_ (U))
904 I32 depth, base, mark, *origin;
905 depth = SU_UD_DEPTH(ud);
908 PerlIO_printf(Perl_debug_log,
910 "%p: leave scope at depth=%2d scope_ix=%2d cur_top=%2d cur_base=%2d\n",
912 ud, depth, PL_scopestack_ix,PL_savestack_ix,PL_scopestack[PL_scopestack_ix])
915 origin = SU_UD_ORIGIN(ud);
916 mark = origin[depth];
917 base = origin[depth - 1];
919 SU_D(PerlIO_printf(Perl_debug_log,
920 "%p: original scope was %*c top=%2d base=%2d\n",
921 ud, 24, ' ', mark, base));
924 SU_D(PerlIO_printf(Perl_debug_log, "%p: clear leftovers\n", ud));
925 PL_savestack_ix = mark;
928 PL_savestack_ix = base;
930 SU_UD_DEPTH(ud) = --depth;
935 if ((pad = SU_UD_PAD(ud))) {
938 SU_D(PerlIO_printf(Perl_debug_log,
939 "%p: push a pad slot at depth=%2d scope_ix=%2d save_ix=%2d\n",
940 ud, depth, PL_scopestack_ix, PL_savestack_ix));
941 SU_SAVE_PLACEHOLDER();
945 SU_D(PerlIO_printf(Perl_debug_log,
946 "%p: push destructor at depth=%2d scope_ix=%2d save_ix=%2d\n",
947 ud, depth, PL_scopestack_ix, PL_savestack_ix));
948 SAVEDESTRUCTOR_X(su_pop, ud);
950 SU_UD_HANDLER(ud)(aTHX_ ud);
953 SU_D(PerlIO_printf(Perl_debug_log,
954 "%p: --- end pop: cur_top=%2d == cur_base=%2d\n",
955 ud, PL_savestack_ix, PL_scopestack[PL_scopestack_ix]));
958 /* --- Initialize the stack and the action userdata ------------------------ */
960 STATIC I32 su_init(pTHX_ void *ud, I32 cxix, I32 size) {
961 #define su_init(U, C, S) su_init(aTHX_ (U), (C), (S))
962 I32 i, depth = 1, pad, offset, *origin;
964 SU_D(PerlIO_printf(Perl_debug_log, "%p: ### init for cx %d\n", ud, cxix));
966 if (size <= SU_SAVE_DESTRUCTOR_SIZE)
969 I32 extra = size - SU_SAVE_DESTRUCTOR_SIZE;
970 pad = extra / SU_SAVE_PLACEHOLDER_SIZE;
971 if (extra % SU_SAVE_PLACEHOLDER_SIZE)
974 offset = SU_SAVE_DESTRUCTOR_SIZE + SU_SAVE_PLACEHOLDER_SIZE * pad;
976 SU_D(PerlIO_printf(Perl_debug_log, "%p: size=%d pad=%d offset=%d\n",
977 ud, size, pad, offset));
979 for (i = cxstack_ix; i > cxix; --i) {
980 PERL_CONTEXT *cx = cxstack + i;
981 switch (CxTYPE(cx)) {
982 #if SU_HAS_PERL(5, 10, 0)
984 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is block\n", ud, i));
985 /* Given and when blocks are actually followed by a simple block, so skip
987 if (cxix > 0) { /* Implies i > 0 */
988 PERL_CONTEXT *next = cx - 1;
989 if (CxTYPE(next) == CXt_GIVEN || CxTYPE(next) == CXt_WHEN)
995 #if SU_HAS_PERL(5, 11, 0)
998 case CXt_LOOP_LAZYSV:
999 case CXt_LOOP_LAZYIV:
1003 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is loop\n", ud, i));
1007 SU_D(PerlIO_printf(Perl_debug_log, "%p: cx %d is other\n", ud, i));
1012 SU_D(PerlIO_printf(Perl_debug_log, "%p: going down to depth %d\n", ud, depth));
1014 Newx(origin, depth + 1, I32);
1015 origin[0] = PL_scopestack[PL_scopestack_ix - depth];
1016 PL_scopestack[PL_scopestack_ix - depth] += size;
1017 for (i = depth - 1; i >= 1; --i) {
1018 I32 j = PL_scopestack_ix - i;
1019 origin[depth - i] = PL_scopestack[j];
1020 PL_scopestack[j] += offset;
1022 origin[depth] = PL_savestack_ix;
1024 SU_UD_ORIGIN(ud) = origin;
1025 SU_UD_DEPTH(ud) = depth;
1026 SU_UD_PAD(ud) = pad;
1028 /* Make sure the first destructor fires by pushing enough fake slots on the
1030 if (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
1031 <= PL_scopestack[PL_scopestack_ix - 1]) {
1034 SU_D(PerlIO_printf(Perl_debug_log,
1035 "%p: push a fake slot at scope_ix=%2d save_ix=%2d\n",
1036 ud, PL_scopestack_ix, PL_savestack_ix));
1037 SU_SAVE_PLACEHOLDER();
1038 } while (PL_savestack_ix + SU_SAVE_DESTRUCTOR_SIZE
1039 <= PL_scopestack[PL_scopestack_ix - 1]);
1041 SU_D(PerlIO_printf(Perl_debug_log,
1042 "%p: push first destructor at scope_ix=%2d save_ix=%2d\n",
1043 ud, PL_scopestack_ix, PL_savestack_ix));
1044 SAVEDESTRUCTOR_X(su_pop, ud);
1047 for (i = 0; i <= depth; ++i) {
1048 I32 j = PL_scopestack_ix - i;
1049 PerlIO_printf(Perl_debug_log,
1050 "%p: depth=%2d scope_ix=%2d saved_floor=%2d new_floor=%2d\n",
1051 ud, i, j, origin[depth - i],
1052 i == 0 ? PL_savestack_ix : PL_scopestack[j]);
1059 /* --- Unwind stack -------------------------------------------------------- */
1061 STATIC void su_unwind(pTHX_ void *ud_) {
1063 I32 cxix = MY_CXT.unwind_storage.cxix;
1064 I32 items = MY_CXT.unwind_storage.items - 1;
1065 SV **savesp = MY_CXT.unwind_storage.savesp;
1068 PERL_UNUSED_VAR(ud_);
1071 PL_stack_sp = savesp;
1073 if (cxstack_ix > cxix)
1076 /* Hide the level */
1080 mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
1081 *PL_markstack_ptr = PL_stack_sp - PL_stack_base - items;
1084 I32 gimme = GIMME_V;
1085 PerlIO_printf(Perl_debug_log,
1086 "%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
1088 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
1089 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
1092 PL_op = (OP *) &(MY_CXT.unwind_storage.return_op);
1093 PL_op = PL_op->op_ppaddr(aTHX);
1095 *PL_markstack_ptr = mark;
1097 MY_CXT.unwind_storage.proxy_op.op_next = PL_op;
1098 PL_op = &(MY_CXT.unwind_storage.proxy_op);
1101 /* --- Uplevel ------------------------------------------------------------- */
1103 #ifndef OP_GIMME_REVERSE
1104 STATIC U8 su_op_gimme_reverse(U8 gimme) {
1107 return OPf_WANT_VOID;
1109 return OPf_WANT_LIST;
1114 return OPf_WANT_SCALAR;
1116 #define OP_GIMME_REVERSE(G) su_op_gimme_reverse(G)
1119 #define SU_UPLEVEL_SAVE(f, t) STMT_START { sud->old_##f = PL_##f; PL_##f = (t); } STMT_END
1120 #define SU_UPLEVEL_RESTORE(f) STMT_START { PL_##f = sud->old_##f; } STMT_END
1122 STATIC su_uplevel_ud *su_uplevel_storage_new(pTHX_ I32 cxix) {
1123 #define su_uplevel_storage_new(I) su_uplevel_storage_new(aTHX_ (I))
1128 sud = MY_CXT.uplevel_storage.root;
1130 MY_CXT.uplevel_storage.root = sud->next;
1131 MY_CXT.uplevel_storage.count--;
1133 sud = su_uplevel_ud_new();
1136 sud->next = MY_CXT.uplevel_storage.top;
1137 MY_CXT.uplevel_storage.top = sud;
1139 depth = su_uid_depth(cxix);
1140 su_uid_storage_dup(&sud->tmp_uid_storage, &MY_CXT.uid_storage, depth);
1141 sud->old_uid_storage = MY_CXT.uid_storage;
1142 MY_CXT.uid_storage = sud->tmp_uid_storage;
1147 STATIC void su_uplevel_storage_delete(pTHX_ su_uplevel_ud *sud) {
1148 #define su_uplevel_storage_delete(S) su_uplevel_storage_delete(aTHX_ (S))
1151 sud->tmp_uid_storage = MY_CXT.uid_storage;
1152 MY_CXT.uid_storage = sud->old_uid_storage;
1156 map = sud->tmp_uid_storage.map;
1157 alloc = sud->tmp_uid_storage.alloc;
1158 for (i = 0; i < alloc; ++i) {
1160 map[i]->flags &= SU_UID_ACTIVE;
1163 MY_CXT.uplevel_storage.top = sud->next;
1165 if (MY_CXT.uplevel_storage.count >= SU_UPLEVEL_STORAGE_SIZE) {
1166 su_uplevel_ud_delete(sud);
1168 sud->next = MY_CXT.uplevel_storage.root;
1169 MY_CXT.uplevel_storage.root = sud;
1170 MY_CXT.uplevel_storage.count++;
1174 STATIC int su_uplevel_goto_static(const OP *o) {
1175 for (; o; o = o->op_sibling) {
1176 /* goto ops are unops with kids. */
1177 if (!(o->op_flags & OPf_KIDS))
1180 switch (o->op_type) {
1183 /* Don't care about gotos inside eval, as they are forbidden at run time. */
1188 if (su_uplevel_goto_static(cUNOPo->op_first))
1197 #if SU_UPLEVEL_HIJACKS_RUNOPS
1199 STATIC int su_uplevel_goto_runops(pTHX) {
1200 #define su_uplevel_goto_runops() su_uplevel_goto_runops(aTHX)
1206 if (op->op_type == OP_GOTO) {
1207 AV *argarray = NULL;
1210 for (cxix = cxstack_ix; cxix >= 0; --cxix) {
1211 const PERL_CONTEXT *cx = cxstack + cxix;
1213 switch (CxTYPE(cx)) {
1215 if (CxHASARGS(cx)) {
1216 argarray = cx->blk_sub.argarray;
1232 if (MY_CXT.uplevel_storage.top->cxix == cxix) {
1233 AV *args = GvAV(PL_defgv);
1234 I32 items = AvFILLp(args);
1236 av_extend(argarray, items);
1237 Copy(AvARRAY(args), AvARRAY(argarray), items + 1, SV *);
1238 AvFILLp(argarray) = items;
1243 PL_op = op = op->op_ppaddr(aTHX);
1245 #if !SU_HAS_PERL(5, 13, 0)
1255 #endif /* SU_UPLEVEL_HIJACKS_RUNOPS */
1257 #define su_at_underscore(C) PadARRAY(PadlistARRAY(CvPADLIST(C))[CvDEPTH(C)])[0]
1259 STATIC void su_uplevel_restore(pTHX_ void *sus_) {
1260 su_uplevel_ud *sud = sus_;
1261 PERL_SI *cur = sud->old_curstackinfo;
1262 PERL_SI *si = sud->si;
1264 #if SU_UPLEVEL_HIJACKS_RUNOPS
1265 if (PL_runops == su_uplevel_goto_runops)
1266 PL_runops = sud->old_runops;
1269 if (sud->callback) {
1270 PERL_CONTEXT *cx = cxstack + sud->cxix;
1271 AV *argarray = MUTABLE_AV(su_at_underscore(sud->callback));
1273 /* We have to fix the pad entry for @_ in the original callback because it
1274 * may have been reified. */
1275 if (AvREAL(argarray)) {
1276 const I32 fill = AvFILLp(argarray);
1277 SvREFCNT_dec(argarray);
1279 AvREAL_off(argarray);
1280 AvREIFY_on(argarray);
1281 av_extend(argarray, fill);
1282 su_at_underscore(sud->callback) = MUTABLE_SV(argarray);
1284 CLEAR_ARGARRAY(argarray);
1287 /* If the old cv member is our renamed CV, it means that this place has been
1288 * reached without a goto() happening, and the old argarray member is
1289 * actually our fake argarray. Destroy it properly in that case. */
1290 if (cx->blk_sub.cv == sud->renamed) {
1291 SvREFCNT_dec(cx->blk_sub.argarray);
1292 cx->blk_sub.argarray = argarray;
1295 CvDEPTH(sud->callback)--;
1296 SvREFCNT_dec(sud->callback);
1299 /* Free the renamed CV. We must do it ourselves so that we can force the
1300 * depth to be 0, or perl would complain about it being "still in use".
1301 * But we *know* that it cannot be so. */
1303 CvDEPTH(sud->renamed) = 0;
1304 CvPADLIST(sud->renamed) = NULL;
1305 SvREFCNT_dec(sud->renamed);
1308 CATCH_SET(sud->old_catch);
1310 SU_UPLEVEL_RESTORE(op);
1312 /* stack_grow() wants PL_curstack so restore the old stack first */
1313 if (PL_curstackinfo == si) {
1314 PL_curstack = cur->si_stack;
1315 if (sud->old_mainstack)
1316 SU_UPLEVEL_RESTORE(mainstack);
1317 SU_UPLEVEL_RESTORE(curstackinfo);
1320 CV *target = sud->target;
1323 /* When we die, the depth of the target CV is not updated because of the
1324 * stack switcheroo. So we have to look at all the frames between the
1325 * uplevel call and the catch block to count how many call frames to the
1326 * target CV were skipped. */
1327 for (i = cur->si_cxix; i > sud->cxix; i--) {
1328 register const PERL_CONTEXT *cx = cxstack + i;
1330 if (CxTYPE(cx) == CXt_SUB) {
1331 if (cx->blk_sub.cv == target)
1336 /* If we died, the replacement stack was already unwinded to the first
1337 * eval frame, and all the contexts down there were popped. We don't have
1338 * to pop manually any context of the original stack, because they must
1339 * have been in the replacement stack as well (since the second was copied
1340 * from the first). Thus we only have to make sure the original stack index
1341 * points to the context just below the first eval scope under the target
1343 for (; i >= 0; i--) {
1344 register const PERL_CONTEXT *cx = cxstack + i;
1346 switch (CxTYPE(cx)) {
1348 if (cx->blk_sub.cv == target)
1360 CvDEPTH(target) = sud->target_depth - levels;
1361 PL_curstackinfo->si_cxix = i - 1;
1363 #if !SU_HAS_PERL(5, 13, 1)
1364 /* Since $@ was maybe localized between the target frame and the uplevel
1365 * call, we forcefully flush the save stack to get rid of it and then
1366 * reset $@ to its proper value. Note that the the call to
1367 * su_uplevel_restore() must happen before the "reset $@" item of the save
1368 * stack is processed, as uplevel was called after the localization.
1369 * Andrew's changes to how $@ was handled, which were mainly integrated
1370 * between perl 5.13.0 and 5.13.1, fixed this. */
1371 if (ERRSV && SvTRUE(ERRSV)) {
1372 register const PERL_CONTEXT *cx = cxstack + i; /* This is the eval scope */
1373 SV *errsv = SvREFCNT_inc(ERRSV);
1374 PL_scopestack_ix = cx->blk_oldscopesp;
1375 leave_scope(PL_scopestack[PL_scopestack_ix]);
1376 sv_setsv(ERRSV, errsv);
1377 SvREFCNT_dec(errsv);
1383 SU_UPLEVEL_RESTORE(curcop);
1385 SvREFCNT_dec(sud->target);
1387 PL_stack_base = AvARRAY(cur->si_stack);
1388 PL_stack_sp = PL_stack_base + AvFILLp(cur->si_stack);
1389 PL_stack_max = PL_stack_base + AvMAX(cur->si_stack);
1391 /* When an exception is thrown from the uplevel'd subroutine,
1392 * su_uplevel_restore() may be called by the LEAVE in die_unwind() (renamed
1393 * die_where() in more recent perls), which has the sad habit of keeping a
1394 * pointer to the current context frame across this call. This means that we
1395 * can't free the temporary context stack we used for the uplevel call right
1396 * now, or that pointer upwards would point to garbage. */
1397 #if SU_HAS_PERL(5, 13, 7)
1398 /* This issue has been fixed in perl with commit 8f89e5a9, which was made
1399 * public in perl 5.13.7. */
1400 su_uplevel_storage_delete(sud);
1402 /* Otherwise, we just enqueue it back in the global storage list. */
1406 sud->tmp_uid_storage = MY_CXT.uid_storage;
1407 MY_CXT.uid_storage = sud->old_uid_storage;
1409 MY_CXT.uplevel_storage.top = sud->next;
1410 sud->next = MY_CXT.uplevel_storage.root;
1411 MY_CXT.uplevel_storage.root = sud;
1412 MY_CXT.uplevel_storage.count++;
1419 STATIC CV *su_cv_clone(pTHX_ CV *proto, GV *gv) {
1420 #define su_cv_clone(P, G) su_cv_clone(aTHX_ (P), (G))
1424 cv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
1426 CvFLAGS(cv) = CvFLAGS(proto);
1428 CvFLAGS(cv) &= ~CVf_CVGV_RC;
1430 CvDEPTH(cv) = CvDEPTH(proto);
1432 CvFILE(cv) = CvISXSUB(proto) ? CvFILE(proto) : savepv(CvFILE(proto));
1434 CvFILE(cv) = CvFILE(proto);
1438 CvSTASH_set(cv, CvSTASH(proto));
1439 /* Commit 4c74a7df, publicized with perl 5.13.3, began to add backrefs to
1440 * stashes. CvSTASH_set() started to do it as well with commit c68d95645
1441 * (which was part of perl 5.13.7). */
1442 #if SU_HAS_PERL(5, 13, 3) && !SU_HAS_PERL(5, 13, 7)
1444 Perl_sv_add_backref(aTHX_ CvSTASH(proto), MUTABLE_SV(cv));
1447 if (CvISXSUB(proto)) {
1448 CvXSUB(cv) = CvXSUB(proto);
1449 CvXSUBANY(cv) = CvXSUBANY(proto);
1452 CvROOT(cv) = OpREFCNT_inc(CvROOT(proto));
1454 CvSTART(cv) = CvSTART(proto);
1456 CvOUTSIDE(cv) = CvOUTSIDE(proto);
1457 #ifdef CVf_WEAKOUTSIDE
1458 if (!(CvFLAGS(proto) & CVf_WEAKOUTSIDE))
1460 SvREFCNT_inc_simple_void(CvOUTSIDE(cv));
1461 CvPADLIST(cv) = CvPADLIST(proto);
1462 #ifdef CvOUTSIDE_SEQ
1463 CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1467 sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
1477 STATIC I32 su_uplevel(pTHX_ CV *callback, I32 cxix, I32 args) {
1478 #define su_uplevel(C, I, A) su_uplevel(aTHX_ (C), (I), (A))
1480 const PERL_CONTEXT *cx = cxstack + cxix;
1482 PERL_SI *cur = PL_curstackinfo;
1488 I32 old_mark, new_mark;
1495 /* Make PL_stack_sp point just before the CV. */
1496 PL_stack_sp -= args + 1;
1497 old_mark = AvFILLp(PL_curstack) = PL_stack_sp - PL_stack_base;
1500 sud = su_uplevel_storage_new(cxix);
1504 sud->callback = NULL;
1505 sud->renamed = NULL;
1506 SAVEDESTRUCTOR_X(su_uplevel_restore, sud);
1510 si->si_type = cur->si_type;
1512 si->si_prev = cur->si_prev;
1514 si->si_markoff = cx->blk_oldmarksp;
1517 /* Allocate enough space for all the elements of the original stack up to the
1518 * target context, plus the forthcoming arguments. */
1519 new_mark = cx->blk_oldsp;
1520 av_extend(si->si_stack, new_mark + 1 + args + 1);
1521 Copy(PL_curstack, AvARRAY(si->si_stack), new_mark + 1, SV *);
1522 AvFILLp(si->si_stack) = new_mark;
1523 SU_POISON(AvARRAY(si->si_stack) + new_mark + 1, args + 1, SV *);
1525 /* Specialized SWITCHSTACK() */
1526 PL_stack_base = AvARRAY(si->si_stack);
1527 old_stack_sp = PL_stack_sp;
1528 PL_stack_sp = PL_stack_base + AvFILLp(si->si_stack);
1529 PL_stack_max = PL_stack_base + AvMAX(si->si_stack);
1532 /* Copy the context stack up to the context just below the target. */
1533 si->si_cxix = (cxix < 0) ? -1 : (cxix - 1);
1534 if (si->si_cxmax < cxix) {
1535 /* The max size must be at least two so that GROW(max) = (max*3)/2 > max */
1536 si->si_cxmax = (cxix < 4) ? 4 : cxix;
1537 Renew(si->si_cxstack, si->si_cxmax + 1, PERL_CONTEXT);
1539 Copy(cur->si_cxstack, si->si_cxstack, cxix, PERL_CONTEXT);
1540 SU_POISON(si->si_cxstack + cxix, si->si_cxmax + 1 - cxix, PERL_CONTEXT);
1542 target = cx->blk_sub.cv;
1543 sud->target = (CV *) SvREFCNT_inc(target);
1544 sud->target_depth = CvDEPTH(target);
1546 /* blk_oldcop is essentially needed for caller() and stack traces. It has no
1547 * run-time implication, since PL_curcop will be overwritten as soon as we
1548 * enter a sub (a sub starts by a nextstate/dbstate). Hence it's safe to just
1549 * make it point to the blk_oldcop for the target frame, so that caller()
1550 * reports the right file name, line number and lexical hints. */
1551 SU_UPLEVEL_SAVE(curcop, cx->blk_oldcop);
1552 /* Don't reset PL_markstack_ptr, or we would overwrite the mark stack below
1553 * this point. Don't reset PL_curpm either, we want the most recent matches. */
1555 SU_UPLEVEL_SAVE(curstackinfo, si);
1556 /* If those two are equal, we need to fool POPSTACK_TO() */
1557 if (PL_mainstack == PL_curstack)
1558 SU_UPLEVEL_SAVE(mainstack, si->si_stack);
1560 sud->old_mainstack = NULL;
1561 PL_curstack = si->si_stack;
1563 renamed = su_cv_clone(callback, CvGV(target));
1564 sud->renamed = renamed;
1567 /* Both SP and old_stack_sp point just before the CV. */
1568 Copy(old_stack_sp + 2, SP + 1, args, SV *);
1570 PUSHs((SV *) renamed);
1573 Zero(&sub_op, 1, UNOP);
1574 sub_op.op_type = OP_ENTERSUB;
1575 sub_op.op_next = NULL;
1576 sub_op.op_flags = OP_GIMME_REVERSE(gimme) | OPf_STACKED;
1578 sub_op.op_flags |= OPpENTERSUB_DB;
1580 SU_UPLEVEL_SAVE(op, (OP *) &sub_op);
1582 #if SU_UPLEVEL_HIJACKS_RUNOPS
1583 sud->old_runops = PL_runops;
1586 sud->old_catch = CATCH_GET;
1589 if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX))) {
1590 PERL_CONTEXT *sub_cx = cxstack + cxstack_ix;
1592 /* If pp_entersub() returns a non-null OP, it means that the callback is not
1595 sud->callback = MUTABLE_CV(SvREFCNT_inc(callback));
1596 CvDEPTH(callback)++;
1598 if (CxHASARGS(cx) && cx->blk_sub.argarray) {
1599 /* The call to pp_entersub() has saved the current @_ (in XS terms,
1600 * GvAV(PL_defgv)) in the savearray member, and has created a new argarray
1601 * with what we put on the stack. But we want to fake up the same arguments
1602 * as the ones in use at the context we uplevel to, so we replace the
1603 * argarray with an unreal copy of the original @_. */
1607 av_extend(av, AvMAX(cx->blk_sub.argarray));
1608 AvFILLp(av) = AvFILLp(cx->blk_sub.argarray);
1609 Copy(AvARRAY(cx->blk_sub.argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
1610 sub_cx->blk_sub.argarray = av;
1612 SvREFCNT_inc_simple_void(sub_cx->blk_sub.argarray);
1615 if (su_uplevel_goto_static(CvROOT(renamed))) {
1616 #if SU_UPLEVEL_HIJACKS_RUNOPS
1617 if (PL_runops != PL_runops_std) {
1618 if (PL_runops == PL_runops_dbg) {
1620 croak("uplevel() can't execute code that calls goto when debugging flags are set");
1621 } else if (PL_runops != su_uplevel_goto_runops)
1622 croak("uplevel() can't execute code that calls goto with a custom runloop");
1625 PL_runops = su_uplevel_goto_runops;
1626 #else /* SU_UPLEVEL_HIJACKS_RUNOPS */
1627 croak("uplevel() can't execute code that calls goto before perl 5.8");
1628 #endif /* !SU_UPLEVEL_HIJACKS_RUNOPS */
1636 ret = PL_stack_sp - (PL_stack_base + new_mark);
1638 AV *old_stack = sud->old_curstackinfo->si_stack;
1640 if (old_mark + ret > AvMAX(old_stack)) {
1641 /* Specialized EXTEND(old_sp, ret) */
1642 av_extend(old_stack, old_mark + ret + 1);
1643 old_stack_sp = AvARRAY(old_stack) + old_mark;
1646 Copy(PL_stack_sp - ret + 1, old_stack_sp + 1, ret, SV *);
1648 AvFILLp(old_stack) += ret;
1656 /* --- Unique context ID --------------------------------------------------- */
1658 STATIC su_uid *su_uid_storage_fetch(pTHX_ UV depth) {
1659 #define su_uid_storage_fetch(D) su_uid_storage_fetch(aTHX_ (D))
1664 map = MY_CXT.uid_storage.map;
1665 alloc = MY_CXT.uid_storage.alloc;
1667 if (depth >= alloc) {
1670 Renew(map, depth + 1, su_uid *);
1671 for (i = alloc; i <= depth; ++i)
1674 MY_CXT.uid_storage.map = map;
1675 MY_CXT.uid_storage.alloc = depth + 1;
1681 Newx(uid, 1, su_uid);
1687 if (depth >= MY_CXT.uid_storage.used)
1688 MY_CXT.uid_storage.used = depth + 1;
1693 STATIC int su_uid_storage_check(pTHX_ UV depth, UV seq) {
1694 #define su_uid_storage_check(D, S) su_uid_storage_check(aTHX_ (D), (S))
1698 if (depth >= MY_CXT.uid_storage.used)
1701 uid = MY_CXT.uid_storage.map[depth];
1703 return uid && (uid->seq == seq) && (uid->flags & SU_UID_ACTIVE);
1706 STATIC void su_uid_drop(pTHX_ void *ud_) {
1709 uid->flags &= ~SU_UID_ACTIVE;
1712 STATIC void su_uid_bump(pTHX_ void *ud_) {
1713 su_ud_reap *ud = ud_;
1715 SAVEDESTRUCTOR_X(su_uid_drop, ud->cb);
1718 STATIC SV *su_uid_get(pTHX_ I32 cxix) {
1719 #define su_uid_get(I) su_uid_get(aTHX_ (I))
1724 depth = su_uid_depth(cxix);
1725 uid = su_uid_storage_fetch(depth);
1727 if (!(uid->flags & SU_UID_ACTIVE)) {
1730 uid->seq = su_uid_seq_next(depth);
1731 uid->flags |= SU_UID_ACTIVE;
1733 Newx(ud, 1, su_ud_reap);
1734 SU_UD_ORIGIN(ud) = NULL;
1735 SU_UD_HANDLER(ud) = su_uid_bump;
1736 ud->cb = (SV *) uid;
1737 su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
1740 uid_sv = sv_newmortal();
1741 sv_setpvf(uid_sv, "%"UVuf"-%"UVuf, depth, uid->seq);
1747 #define su_grok_number(S, L, VP) grok_number((S), (L), (VP))
1749 #else /* grok_number */
1751 #define IS_NUMBER_IN_UV 0x1
1753 STATIC int su_grok_number(pTHX_ const char *s, STRLEN len, UV *valuep) {
1754 #define su_grok_number(S, L, VP) su_grok_number(aTHX_ (S), (L), (VP))
1758 /* This crude check should be good enough for a fallback implementation.
1759 * Better be too strict than too lax. */
1760 for (i = 0; i < len; ++i) {
1765 tmpsv = sv_newmortal();
1766 sv_setpvn(tmpsv, s, len);
1767 *valuep = sv_2uv(tmpsv);
1769 return IS_NUMBER_IN_UV;
1772 #endif /* !grok_number */
1774 STATIC int su_uid_validate(pTHX_ SV *uid) {
1775 #define su_uid_validate(U) su_uid_validate(aTHX_ (U))
1781 s = SvPV_const(uid, len);
1783 while (p < len && s[p] != '-')
1786 croak("UID contains only one part");
1788 type = su_grok_number(s, p, &depth);
1789 if (type != IS_NUMBER_IN_UV)
1790 croak("First UID part is not an unsigned integer");
1792 ++p; /* Skip '-'. As we used to have p < len, len - (p + 1) >= 0. */
1794 type = su_grok_number(s + p, len - p, &seq);
1795 if (type != IS_NUMBER_IN_UV)
1796 croak("Second UID part is not an unsigned integer");
1798 return su_uid_storage_check(depth, seq);
1801 /* --- Interpreter setup/teardown ------------------------------------------ */
1803 STATIC void su_teardown(pTHX_ void *param) {
1808 map = MY_CXT.uid_storage.map;
1811 for (i = 0; i < MY_CXT.uid_storage.used; ++i)
1816 cur = MY_CXT.uplevel_storage.root;
1818 su_uplevel_ud *prev;
1822 su_uplevel_ud_delete(prev);
1829 STATIC void su_setup(pTHX) {
1830 #define su_setup() su_setup(aTHX)
1833 MY_CXT.stack_placeholder = NULL;
1835 /* NewOp() calls calloc() which just zeroes the memory with memset(). */
1836 Zero(&(MY_CXT.unwind_storage.return_op), 1, LISTOP);
1837 MY_CXT.unwind_storage.return_op.op_type = OP_RETURN;
1838 MY_CXT.unwind_storage.return_op.op_ppaddr = PL_ppaddr[OP_RETURN];
1840 Zero(&(MY_CXT.unwind_storage.proxy_op), 1, OP);
1841 MY_CXT.unwind_storage.proxy_op.op_type = OP_STUB;
1842 MY_CXT.unwind_storage.proxy_op.op_ppaddr = NULL;
1844 MY_CXT.uplevel_storage.top = NULL;
1845 MY_CXT.uplevel_storage.root = NULL;
1846 MY_CXT.uplevel_storage.count = 0;
1848 MY_CXT.uid_storage.map = NULL;
1849 MY_CXT.uid_storage.used = 0;
1850 MY_CXT.uid_storage.alloc = 0;
1852 call_atexit(su_teardown, NULL);
1857 /* --- XS ------------------------------------------------------------------ */
1859 #if SU_HAS_PERL(5, 8, 9)
1860 # define SU_SKIP_DB_MAX 2
1862 # define SU_SKIP_DB_MAX 3
1865 /* Skip context sequences of 1 to SU_SKIP_DB_MAX (included) block contexts
1866 * followed by a DB sub */
1868 #define SU_SKIP_DB(C) \
1871 PERL_CONTEXT *base = cxstack; \
1872 PERL_CONTEXT *cx = base + (C); \
1873 while (cx >= base && (C) > skipped && CxTYPE(cx) == CXt_BLOCK) \
1875 if (cx >= base && (C) > skipped) { \
1876 switch (CxTYPE(cx)) { \
1878 if (skipped <= SU_SKIP_DB_MAX && cx->blk_sub.cv == GvCV(PL_DBsub)) \
1879 (C) -= skipped + 1; \
1887 #define SU_GET_CONTEXT(A, B) \
1896 else if (cxix > cxstack_ix) \
1897 cxix = cxstack_ix; \
1900 cxix = cxstack_ix; \
1906 #define SU_GET_LEVEL(A, B) \
1912 level = SvIV(lsv); \
1919 XS(XS_Scope__Upper_unwind); /* prototype to pass -Wmissing-prototypes */
1921 XS(XS_Scope__Upper_unwind) {
1930 PERL_UNUSED_VAR(cv); /* -W */
1931 PERL_UNUSED_VAR(ax); /* -Wall */
1933 SU_GET_CONTEXT(0, items - 1);
1935 PERL_CONTEXT *cx = cxstack + cxix;
1936 switch (CxTYPE(cx)) {
1938 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
1942 MY_CXT.unwind_storage.cxix = cxix;
1943 MY_CXT.unwind_storage.items = items;
1944 /* pp_entersub will want to sanitize the stack after returning from there
1945 * Screw that, we're insane */
1946 if (GIMME_V == G_SCALAR) {
1947 MY_CXT.unwind_storage.savesp = PL_stack_sp;
1948 /* dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
1949 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
1951 MY_CXT.unwind_storage.savesp = NULL;
1953 SAVEDESTRUCTOR_X(su_unwind, NULL);
1958 } while (--cxix >= 0);
1959 croak("Can't return outside a subroutine");
1962 MODULE = Scope::Upper PACKAGE = Scope::Upper
1970 MUTEX_INIT(&su_uid_seq_counter_mutex);
1972 su_uid_seq_counter.seqs = NULL;
1973 su_uid_seq_counter.size = 0;
1975 stash = gv_stashpv(__PACKAGE__, 1);
1976 newCONSTSUB(stash, "TOP", newSViv(0));
1977 newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(SU_THREADSAFE));
1979 newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
1990 su_uid_storage new_cxt;
1997 su_uid_storage_dup(&new_cxt, &MY_CXT.uid_storage, MY_CXT.uid_storage.used);
2001 MY_CXT.uplevel_storage.top = NULL;
2002 MY_CXT.uplevel_storage.root = NULL;
2003 MY_CXT.uplevel_storage.count = 0;
2004 MY_CXT.uid_storage = new_cxt;
2008 #endif /* SU_THREADSAFE */
2014 I32 cxix = cxstack_ix;
2028 SU_GET_CONTEXT(0, 0);
2043 SU_GET_CONTEXT(0, 0);
2045 for (; cxix >= 0; --cxix) {
2046 PERL_CONTEXT *cx = cxstack + cxix;
2047 switch (CxTYPE(cx)) {
2051 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2065 SU_GET_CONTEXT(0, 0);
2067 for (; cxix >= 0; --cxix) {
2068 PERL_CONTEXT *cx = cxstack + cxix;
2069 switch (CxTYPE(cx)) {
2111 for (cxix = cxstack_ix; cxix > 0; --cxix) {
2112 PERL_CONTEXT *cx = cxstack + cxix;
2113 switch (CxTYPE(cx)) {
2115 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2135 SU_GET_CONTEXT(0, 0);
2138 PERL_CONTEXT *cx = cxstack + cxix--;
2139 switch (CxTYPE(cx)) {
2143 I32 gimme = cx->blk_gimme;
2145 case G_VOID: XSRETURN_UNDEF; break;
2146 case G_SCALAR: XSRETURN_NO; break;
2147 case G_ARRAY: XSRETURN_YES; break;
2162 SU_GET_CONTEXT(1, 1);
2163 Newx(ud, 1, su_ud_reap);
2164 SU_UD_ORIGIN(ud) = NULL;
2165 SU_UD_HANDLER(ud) = su_reap;
2166 ud->cb = newSVsv(hook);
2167 su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
2170 localize(SV *sv, SV *val, ...)
2177 SU_GET_CONTEXT(2, 2);
2178 Newx(ud, 1, su_ud_localize);
2179 SU_UD_ORIGIN(ud) = NULL;
2180 SU_UD_HANDLER(ud) = su_localize;
2181 size = su_ud_localize_init(ud, sv, val, NULL);
2182 su_init(ud, cxix, size);
2185 localize_elem(SV *sv, SV *elem, SV *val, ...)
2192 if (SvTYPE(sv) >= SVt_PVGV)
2193 croak("Can't infer the element localization type from a glob and the value");
2194 SU_GET_CONTEXT(3, 3);
2195 Newx(ud, 1, su_ud_localize);
2196 SU_UD_ORIGIN(ud) = NULL;
2197 SU_UD_HANDLER(ud) = su_localize;
2198 size = su_ud_localize_init(ud, sv, val, elem);
2199 if (ud->type != SVt_PVAV && ud->type != SVt_PVHV) {
2200 SU_UD_LOCALIZE_FREE(ud);
2201 croak("Can't localize an element of something that isn't an array or a hash");
2203 su_init(ud, cxix, size);
2206 localize_delete(SV *sv, SV *elem, ...)
2213 SU_GET_CONTEXT(2, 2);
2214 Newx(ud, 1, su_ud_localize);
2215 SU_UD_ORIGIN(ud) = NULL;
2216 SU_UD_HANDLER(ud) = su_localize;
2217 size = su_ud_localize_init(ud, sv, NULL, elem);
2218 su_init(ud, cxix, size);
2221 uplevel(SV *code, ...)
2224 I32 cxix, ret, args = 0;
2228 if (SvTYPE(code) < SVt_PVCV)
2229 croak("First argument to uplevel must be a code reference");
2230 SU_GET_CONTEXT(1, items - 1);
2232 PERL_CONTEXT *cx = cxstack + cxix;
2233 switch (CxTYPE(cx)) {
2235 croak("Can't uplevel to an eval frame");
2237 croak("Can't uplevel to a format frame");
2239 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2245 /* su_uplevel() takes care of extending the stack if needed. */
2246 ret = su_uplevel((CV *) code, cxix, args);
2251 } while (--cxix >= 0);
2252 croak("Can't uplevel outside a subroutine");
2261 SU_GET_CONTEXT(0, 0);
2262 uid = su_uid_get(cxix);
2268 validate_uid(SV *uid)
2273 ret = su_uid_validate(uid) ? &PL_sv_yes : &PL_sv_no;