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 /* --- XS helpers ---------------------------------------------------------- */
11 #define XSH_PACKAGE "Scope::Upper"
15 #include "xsh/debug.h"
17 /* --- Compatibility ------------------------------------------------------- */
19 /* perl 5.23.8 onwards has a revamped context system */
20 #define SU_HAS_NEW_CXT XSH_HAS_PERL(5, 23, 8)
27 # define MUTABLE_SV(S) ((SV *) (S))
31 # define MUTABLE_AV(A) ((AV *) (A))
35 # define MUTABLE_CV(C) ((CV *) (C))
38 #ifndef PERL_UNUSED_VAR
39 # define PERL_UNUSED_VAR(V)
43 # define Newx(v, n, c) New(0, v, n, c)
48 # define SU_POISON(D, N, T) PoisonNew((D), (N), T)
49 # elif defined(Poison)
50 # define SU_POISON(D, N, T) Poison((D), (N), T)
54 # define SU_POISON(D, N, T) NOOP
58 static SV *su_newSV_type(pTHX_ svtype t) {
63 # define newSV_type(T) su_newSV_type(aTHX_ (T))
67 # define su_newmortal_pvn(S, L) newSVpvn_flags((S), (L), SVs_TEMP)
69 # define su_newmortal_pvn(S, L) sv_2mortal(newSVpvn((S), (L)))
71 #define su_newmortal_pvs(S) su_newmortal_pvn((S), sizeof(S)-1)
74 # define SvPV_const(S, L) SvPV(S, L)
78 # define SvPVX_const(S) SvPVX(S)
81 #ifndef SvPV_nolen_const
82 # define SvPV_nolen_const(S) SvPV_nolen(S)
85 #ifndef SvREFCNT_inc_simple_void
86 # define SvREFCNT_inc_simple_void(sv) ((void) SvREFCNT_inc(sv))
90 # define mPUSHi(I) PUSHs(sv_2mortal(newSViv(I)))
94 # define GvCV_set(G, C) (GvCV(G) = (C))
98 # define CvGV_set(C, G) (CvGV(C) = (G))
102 # define CvSTASH_set(C, S) (CvSTASH(C) = (S))
106 # define CvISXSUB(C) CvXSUB(C)
110 # define PadlistARRAY(P) AvARRAY(P)
111 # define PadARRAY(P) AvARRAY(P)
115 # define CxHASARGS(C) ((C)->blk_sub.hasargs)
120 # define CxGIMME(C) ((C)->blk_gimme & G_WANT)
122 # define CxGIMME(C) ((C)->blk_gimme)
126 #ifndef CxOLD_OP_TYPE
127 # define CxOLD_OP_TYPE(C) (C)->blk_eval.old_op_type
131 # define OutCopFILE(C) CopFILE(C)
134 #ifndef OutCopFILE_len
135 # define OutCopFILE_len(C) strlen(OutCopFILE(C))
139 # define CopHINTS_get(C) ((I32) (C)->op_private & HINT_PRIVATE_MASK)
142 #ifndef CopHINTHASH_get
143 # define CopHINTHASH_get(C) (C)->cop_hints_hash
147 # define COPHH struct refcounted_he
148 # define cophh_2hv(H, F) Perl_refcounted_he_chain_2hv(aTHX_ (H))
152 # define HvNAME_get(H) HvNAME(H)
156 # define HvNAMELEN(H) strlen(HvNAME(H))
159 #ifndef gv_fetchpvn_flags
160 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
164 # define hv_fetchs(H, K, L) hv_fetch((H), (K), sizeof(K)-1, (L))
167 #ifndef OP_GIMME_REVERSE
168 static U8 su_op_gimme_reverse(U8 gimme) {
171 return OPf_WANT_VOID;
173 return OPf_WANT_LIST;
178 return OPf_WANT_SCALAR;
180 #define OP_GIMME_REVERSE(G) su_op_gimme_reverse(G)
185 # define OpSIBLING(O) OP_SIBLING(O)
187 # define OpSIBLING(O) ((O)->op_sibling)
191 #ifndef PERL_MAGIC_tied
192 # define PERL_MAGIC_tied 'P'
195 #ifndef PERL_MAGIC_env
196 # define PERL_MAGIC_env 'E'
199 #ifndef NEGATIVE_INDICES_VAR
200 # define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
203 /* --- Error messages ------------------------------------------------------ */
205 static const char su_stack_smash[] = "Cannot target a scope outside of the current stack";
206 static const char su_no_such_target[] = "No targetable %s scope in the current stack";
208 /* --- Unique context ID global storage ------------------------------------ */
210 /* ... Sequence ID counter ................................................. */
217 static su_uv_array su_uid_seq_counter;
221 static perl_mutex su_uid_seq_counter_mutex;
223 #endif /* USE_ITHREADS */
225 static UV su_uid_seq_next(pTHX_ UV depth) {
226 #define su_uid_seq_next(D) su_uid_seq_next(aTHX_ (D))
230 XSH_LOCK(&su_uid_seq_counter_mutex);
232 seqs = su_uid_seq_counter.seqs;
234 if (depth >= su_uid_seq_counter.size) {
237 seqs = PerlMemShared_realloc(seqs, (depth + 1) * sizeof(UV));
238 for (i = su_uid_seq_counter.size; i <= depth; ++i)
241 su_uid_seq_counter.seqs = seqs;
242 su_uid_seq_counter.size = depth + 1;
247 XSH_UNLOCK(&su_uid_seq_counter_mutex);
252 /* ... UID storage ......................................................... */
259 #define SU_UID_ACTIVE 1
261 static UV su_uid_depth(pTHX_ I32 cxix) {
262 #define su_uid_depth(I) su_uid_depth(aTHX_ (I))
267 for (si = PL_curstackinfo->si_prev; si; si = si->si_prev)
268 depth += si->si_cxix + 1;
279 static void su_uid_storage_dup(pTHX_ su_uid_storage *new_cxt, const su_uid_storage *old_cxt, UV max_depth) {
280 #define su_uid_storage_dup(N, O, D) su_uid_storage_dup(aTHX_ (N), (O), (D))
281 su_uid *old_map = old_cxt->map;
284 su_uid *new_map = new_cxt->map;
285 STRLEN old_used = old_cxt->used;
286 STRLEN new_used, new_alloc;
289 new_used = max_depth < old_used ? max_depth : old_used;
290 new_cxt->used = new_used;
292 if (new_used <= new_cxt->alloc) {
293 new_alloc = new_cxt->alloc;
295 new_alloc = new_used;
296 Renew(new_map, new_alloc, su_uid);
297 new_cxt->map = new_map;
298 new_cxt->alloc = new_alloc;
301 for (i = 0; i < new_alloc; ++i) {
302 su_uid *new_uid = new_map + i;
304 if (i < new_used) { /* => i < max_depth && i < old_used */
305 su_uid *old_uid = old_map + i;
307 if (old_uid && (old_uid->flags & SU_UID_ACTIVE)) {
321 /* --- unwind() global storage --------------------------------------------- */
331 /* --- yield() global storage ---------------------------------------------- */
341 /* --- uplevel() data tokens and global storage ---------------------------- */
343 #define SU_UPLEVEL_HIJACKS_RUNOPS XSH_HAS_PERL(5, 8, 0)
348 su_uid_storage tmp_uid_storage;
349 su_uid_storage old_uid_storage;
357 U8 *cxtypes; /* array of saved context types */
358 I32 gap; /* how many contexts have temporarily CXt_NULLed out*/
359 AV* argarray; /* the PL_curpad[0] of the uplevel sub */
364 PERL_SI *old_curstackinfo;
373 #if SU_UPLEVEL_HIJACKS_RUNOPS
374 runops_proc_t old_runops;
379 /* used to flag a context stack entry whose type has been temporarily
380 * set to CXt_NULL. It relies on perl not using this value for real
383 # define CXp_SU_UPLEVEL_NULLED 0x20
386 static su_uplevel_ud *su_uplevel_ud_new(pTHX) {
387 #define su_uplevel_ud_new() su_uplevel_ud_new(aTHX)
391 Newx(sud, 1, su_uplevel_ud);
394 sud->tmp_uid_storage.map = NULL;
395 sud->tmp_uid_storage.used = 0;
396 sud->tmp_uid_storage.alloc = 0;
399 Newx(si, 1, PERL_SI);
400 si->si_stack = newAV();
401 AvREAL_off(si->si_stack);
402 si->si_cxstack = NULL;
411 static void su_uplevel_ud_delete(pTHX_ su_uplevel_ud *sud) {
412 #define su_uplevel_ud_delete(S) su_uplevel_ud_delete(aTHX_ (S))
415 PERL_SI *si = sud->si;
417 Safefree(si->si_cxstack);
418 SvREFCNT_dec(si->si_stack);
422 Safefree(sud->tmp_uid_storage.map);
433 } su_uplevel_storage;
435 #ifndef SU_UPLEVEL_STORAGE_SIZE
436 # define SU_UPLEVEL_STORAGE_SIZE 4
439 /* --- Global data --------------------------------------------------------- */
442 su_unwind_storage unwind_storage;
443 su_yield_storage yield_storage;
444 su_uplevel_storage uplevel_storage;
445 su_uid_storage uid_storage;
448 #define XSH_THREADS_USER_CONTEXT 1
449 #define XSH_THREADS_USER_CLONE_NEEDS_DUP 0
450 #define XSH_THREADS_COMPILE_TIME_PROTECTION 0
454 static void xsh_user_clone(pTHX_ const xsh_user_cxt_t *old_cxt, xsh_user_cxt_t *new_cxt) {
455 new_cxt->uplevel_storage.top = NULL;
456 new_cxt->uplevel_storage.root = NULL;
457 new_cxt->uplevel_storage.count = 0;
458 new_cxt->uid_storage.map = NULL;
459 new_cxt->uid_storage.used = 0;
460 new_cxt->uid_storage.alloc = 0;
462 su_uid_storage_dup(&new_cxt->uid_storage, &old_cxt->uid_storage,
463 old_cxt->uid_storage.used);
468 #endif /* XSH_THREADSAFE */
470 #include "xsh/threads.h"
472 /* --- Stack manipulations ------------------------------------------------- */
474 /* how many slots on the save stack various save types take up */
476 #define SU_SAVE_DESTRUCTOR_SIZE 3 /* SAVEt_DESTRUCTOR_X */
477 #define SU_SAVE_SCALAR_SIZE 3 /* SAVEt_SV */
478 #define SU_SAVE_ARY_SIZE 3 /* SAVEt_AV */
479 #define SU_SAVE_AELEM_SIZE 4 /* SAVEt_AELEM */
480 #define SU_SAVE_HASH_SIZE 3 /* SAVEt_HV */
481 #define SU_SAVE_HELEM_SIZE 4 /* SAVEt_HELEM */
482 #define SU_SAVE_HDELETE_SIZE 4 /* SAVEt_DELETE */
484 #define SU_SAVE_GVCV_SIZE SU_SAVE_DESTRUCTOR_SIZE
486 /* the overhead of save_alloc() but not including any elements,
487 * of which there must be at least 1 */
488 #if XSH_HAS_PERL(5, 14, 0)
489 # define SU_SAVE_ALLOC_SIZE 1 /* SAVEt_ALLOC */
491 # define SU_SAVE_ALLOC_SIZE 2 /* SAVEt_ALLOC */
495 # define SU_SAVE_ADELETE_SIZE 3 /* SAVEt_ADELETE */
497 # define SU_SAVE_ADELETE_SIZE SU_SAVE_DESTRUCTOR_SIZE
500 /* (NB: it was 4 between 5.13.1 and 5.13.7) */
501 #if XSH_HAS_PERL(5, 8, 9)
502 # define SU_SAVE_GP_SIZE 3 /* SAVEt_GP */
504 # define SU_SAVE_GP_SIZE 6 /* SAVEt_GP */
507 /* sometimes we don't know in advance whether we're saving or deleting
508 * an array/hash element. So include enough room for a variable-sized
509 * save_alloc() to pad it to a fixed size.
512 #if SU_SAVE_AELEM_SIZE < SU_SAVE_ADELETE_SIZE
513 # define SU_SAVE_AELEM_OR_ADELETE_SIZE \
514 (SU_SAVE_ADELETE_SIZE + SU_SAVE_ALLOC_SIZE + 1)
515 #elif SU_SAVE_AELEM_SIZE > SU_SAVE_ADELETE_SIZE
516 # define SU_SAVE_AELEM_OR_ADELETE_SIZE \
517 (SU_SAVE_AELEM_SIZE + SU_SAVE_ALLOC_SIZE + 1)
519 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_AELEM_SIZE
522 #if SU_SAVE_HELEM_SIZE < SU_SAVE_HDELETE_SIZE
523 # define SU_SAVE_HELEM_OR_HDELETE_SIZE \
524 (SU_SAVE_HDELETE_SIZE + SU_SAVE_ALLOC_SIZE + 1)
525 #elif SU_SAVE_HELEM_SIZE > SU_SAVE_HDELETE_SIZE
526 # define SU_SAVE_HELEM_OR_HDELETE_SIZE \
527 (SU_SAVE_HELEM_SIZE + SU_SAVE_ALLOC_SIZE + 1)
529 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HELEM_SIZE
532 #ifndef SvCANEXISTDELETE
533 # define SvCANEXISTDELETE(sv) \
535 || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied)) \
536 && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
537 && gv_fetchmethod_autoload(stash, "EXISTS", TRUE) \
538 && gv_fetchmethod_autoload(stash, "DELETE", TRUE) \
543 /* ... Saving array elements ............................................... */
545 static I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
546 #define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
552 /* Added by MJD in perl-5.8.1 with 6f12eb6d2a1dfaf441504d869b27d2e40ef4966a */
553 #if XSH_HAS_PERL(5, 8, 1)
554 if (SvRMAGICAL(av)) {
555 const MAGIC * const tied_magic = mg_find((SV *) av, PERL_MAGIC_tied);
557 SV * const * const negative_indices_glob = hv_fetch(
558 SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
559 NEGATIVE_INDICES_VAR, sizeof(NEGATIVE_INDICES_VAR)-1, 0
561 if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
567 idx = key + av_len(av) + 1;
581 static void su_adelete(pTHX_ void *ud_) {
582 su_ud_adelete *ud = (su_ud_adelete *) ud_;
584 av_delete(ud->av, ud->idx, G_DISCARD);
585 SvREFCNT_dec(ud->av);
590 static void su_save_adelete(pTHX_ AV *av, I32 idx) {
591 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
594 Newx(ud, 1, su_ud_adelete);
597 SvREFCNT_inc_simple_void(av);
599 SAVEDESTRUCTOR_X(su_adelete, ud);
602 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
604 #endif /* SAVEADELETE */
606 static void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
607 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
614 idx = su_av_key2idx(av, SvIV(key));
616 if (SvCANEXISTDELETE(av))
617 preeminent = av_exists(av, idx);
619 svp = av_fetch(av, idx, 1);
620 if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
623 save_aelem(av, idx, svp);
625 SAVEADELETE(av, idx);
627 if (val) { /* local $x[$idx] = $val; */
628 SvSetMagicSV(*svp, val);
629 } else { /* local $x[$idx]; delete $x[$idx]; */
630 av_delete(av, idx, G_DISCARD);
634 /* ... Saving hash elements ................................................ */
636 static void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
637 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
644 if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
645 preeminent = hv_exists_ent(hv, keysv, 0);
647 he = hv_fetch_ent(hv, keysv, 1, 0);
648 svp = he ? &HeVAL(he) : NULL;
649 if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
651 if (HvNAME_get(hv) && isGV(*svp)) {
652 save_gp((GV *) *svp, 0);
657 save_helem(hv, keysv, svp);
660 const char * const key = SvPV_const(keysv, keylen);
661 SAVEDELETE(hv, savepvn(key, keylen),
662 SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
665 if (val) { /* local $x{$keysv} = $val; */
666 SvSetMagicSV(*svp, val);
667 } else { /* local $x{$keysv}; delete $x{$keysv}; */
668 (void)hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
672 /* ... Saving code slots from a glob ....................................... */
674 #if !XSH_HAS_PERL(5, 10, 0) && !defined(mro_method_changed_in)
675 # define mro_method_changed_in(G) PL_sub_generation++
683 static void su_restore_gvcv(pTHX_ void *ud_) {
684 su_save_gvcv_ud *ud = ud_;
687 GvCV_set(gv, ud->old_cv);
689 mro_method_changed_in(GvSTASH(gv));
694 static void su_save_gvcv(pTHX_ GV *gv) {
695 #define su_save_gvcv(G) su_save_gvcv(aTHX_ (G))
698 Newx(ud, 1, su_save_gvcv_ud);
700 ud->old_cv = GvCV(gv);
704 mro_method_changed_in(GvSTASH(gv));
706 SAVEDESTRUCTOR_X(su_restore_gvcv, ud);
709 /* --- Actions ------------------------------------------------------------- */
712 I32 orig_ix; /* original savestack_ix */
713 I32 offset; /* how much we bumped this savestack index */
721 su_ud_origin_elem *origin;
724 #define SU_UD_TYPE(U) (((su_ud_common *) (U))->type)
725 #define SU_UD_PRIVATE(U) (((su_ud_common *) (U))->private)
726 #define SU_UD_DEPTH(U) (((su_ud_common *) (U))->depth)
727 #define SU_UD_ORIGIN(U) (((su_ud_common *) (U))->origin)
729 #define SU_UD_TYPE_REAP 0
730 #define SU_UD_TYPE_LOCALIZE 1
731 #define SU_UD_TYPE_UID 2
733 #define SU_UD_FREE(U) STMT_START { \
734 if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
738 /* ... Reap ................................................................ */
740 #define SU_SAVE_LAST_CX (!XSH_HAS_PERL(5, 8, 4) || (XSH_HAS_PERL(5, 9, 5) && !XSH_HAS_PERL(5, 14, 0)) || XSH_HAS_PERL(5, 15, 0))
747 #define SU_UD_REAP_CB(U) (((su_ud_reap *) (U))->cb)
749 static void su_call(pTHX_ SV *cb) {
752 PERL_CONTEXT saved_cx;
753 #endif /* SU_SAVE_LAST_CX */
757 XSH_D(xsh_debug_log("@@@ call scope_ix=%2d save_ix=%2d\n",
758 PL_scopestack_ix, PL_savestack_ix));
767 /* If the recently popped context isn't saved there, it will be overwritten by
768 * the sub scope from call_sv, although it's still needed in our caller. */
769 cxix = (cxstack_ix < cxstack_max) ? (cxstack_ix + 1) : Perl_cxinc(aTHX);
770 saved_cx = cxstack[cxix];
771 #endif /* SU_SAVE_LAST_CX */
776 cxstack[cxix] = saved_cx;
777 #endif /* SU_SAVE_LAST_CX */
789 /* ... Localize & localize array/hash element .............................. */
798 #define SU_UD_LOCALIZE_SV(U) (((su_ud_localize *) (U))->sv)
799 #define SU_UD_LOCALIZE_VAL(U) (((su_ud_localize *) (U))->val)
800 #define SU_UD_LOCALIZE_ELEM(U) (((su_ud_localize *) (U))->elem)
802 #define SU_UD_LOCALIZE_FREE(U) STMT_START { \
803 SvREFCNT_dec(SU_UD_LOCALIZE_ELEM(U)); \
804 SvREFCNT_dec(SU_UD_LOCALIZE_VAL(U)); \
805 SvREFCNT_dec(SU_UD_LOCALIZE_SV(U)); \
809 static I32 su_ud_localize_init(pTHX_ su_ud_localize *ud, SV *sv, SV *val, SV *elem) {
810 #define su_ud_localize_init(UD, S, V, E) su_ud_localize_init(aTHX_ (UD), (S), (V), (E))
815 SvREFCNT_inc_simple_void(sv);
817 if (SvTYPE(sv) >= SVt_PVGV) {
818 if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
820 } else { /* local *x = \$val; */
821 t = SvTYPE(SvRV(val));
824 } else if (SvROK(sv)) {
825 croak("Invalid %s reference as the localization target",
826 sv_reftype(SvRV(sv), 0));
829 const char *p = SvPV_const(sv, len), *s;
830 for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
836 case '$': t = SVt_PV; break;
837 case '@': t = SVt_PVAV; break;
838 case '%': t = SVt_PVHV; break;
839 case '&': t = SVt_PVCV; break;
840 case '*': t = SVt_PVGV; break;
845 } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
846 if (SvROK(val) && !sv_isobject(val)) {
847 t = SvTYPE(SvRV(val));
859 size = elem ? SU_SAVE_AELEM_OR_ADELETE_SIZE
864 size = elem ? SU_SAVE_HELEM_OR_HDELETE_SIZE
869 size = SU_SAVE_GP_SIZE;
873 size = SU_SAVE_GVCV_SIZE;
877 size = SU_SAVE_SCALAR_SIZE;
880 /* When deref is set, val isn't NULL */
882 SU_UD_PRIVATE(ud) = t;
885 ud->val = val ? newSVsv(deref ? SvRV(val) : val) : NULL;
886 ud->elem = SvREFCNT_inc(elem);
891 static void su_localize(pTHX_ void *ud_) {
892 #define su_localize(U) su_localize(aTHX_ (U))
893 su_ud_localize *ud = (su_ud_localize *) ud_;
897 svtype t = SU_UD_PRIVATE(ud);
900 if (SvTYPE(sv) >= SVt_PVGV) {
903 /* new perl context implementation frees savestack *before* restoring
904 * PL_curcop. Temporarily restore it prematurely to make gv_fetch*
905 * looks up unqualified var names in the caller's package */
907 COP *old_cop = PL_curcop;
908 PL_curcop = CX_CUR()->blk_oldcop;
912 gv = gv_fetchsv(sv, GV_ADDMULTI, t);
916 const char *name = SvPV_const(sv, len);
917 gv = gv_fetchpvn_flags(name, len, GV_ADDMULTI, t);
922 CX_CUR()->blk_oldcop = old_cop;
929 xsh_debug_log("%p: === localize a %s\n", ud, sv_reftype(z, 0));
930 xsh_debug_log("%p: depth=%2d scope_ix=%2d save_ix=%2d\n",
931 ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix);
935 /* Inspired from Alias.pm */
939 su_save_aelem(GvAV(gv), elem, val);
947 su_save_helem(GvHV(gv), elem, val);
954 save_gp(gv, 1); /* hide previous entry in symtab */
960 gv = (GV *) save_scalar(gv);
965 SvSetMagicSV((SV *) gv, val);
970 /* ... Unique context ID ................................................... */
972 /* We must pass the index because XSH_CXT.uid_storage might be reallocated
973 * between the UID fetch and the invalidation at the end of scope. */
980 static void su_uid_drop(pTHX_ void *ud_) {
984 XSH_CXT.uid_storage.map[ud->idx].flags &= ~SU_UID_ACTIVE;
991 /* --- Pop a context back -------------------------------------------------- */
994 # define SU_CX_TYPENAME(T) PL_block_type[(T)]
996 # if XSH_HAS_PERL(5, 23, 8)
997 static const char *su_block_type[] = {
1012 # elif XSH_HAS_PERL(5, 11, 0)
1013 static const char *su_block_type[] = {
1027 # elif XSH_HAS_PERL(5, 10, 0)
1028 static const char *su_block_type[] = {
1040 static const char *su_block_type[] = {
1050 # define SU_CX_TYPENAME(T) su_block_type[(T)]
1053 #define SU_CXNAME(C) SU_CX_TYPENAME(CxTYPE(C))
1057 /* for debugging. These indicate how many ENTERs each context type
1058 * does before the PUSHBLOCK */
1060 static const int su_cxt_enter_count[] = {
1061 # if XSH_HAS_PERL(5, 23, 8)
1062 0 /* context pushes no longer do ENTERs */
1063 # elif XSH_HAS_PERL(5, 11, 0)
1064 /* NULL WHEN BLOCK GIVEN LOOP_FOR LOOP_PLAIN LOOP_LAZYSV
1065 * LOOP_LAZYIV SUB FORMAT EVAL SUBST */
1066 0, 1, 1, 1, 2, 2, 2, 2, 1, 1, 1, 0
1067 # elif XSH_HAS_PERL(5, 10, 0)
1068 /* NULL SUB EVAL LOOP SUBST BLOCK FORMAT WHEN GIVEN */
1069 0, 1, 1, 2, 0, 1, 1, 1, 1
1071 /* NULL SUB EVAL LOOP SUBST BLOCK FORMAT */
1076 #endif /* XSH_DEBUG */
1078 /* push at least 'size' slots worth of padding onto the savestack */
1080 static void su_ss_push_padding(pTHX_ void *ud, I32 size) {
1081 #define su_ss_push_padding(U, S) su_ss_push_padding(aTHX_ (U), (S))
1085 if (size < SU_SAVE_ALLOC_SIZE + 1) /* minimum possible SAVEt_ALLOC */
1086 size = SU_SAVE_ALLOC_SIZE + 1;
1088 XSH_D(xsh_debug_log(
1089 "%p: push %2d padding at save_ix=%d\n",
1090 ud, size, PL_savestack_ix));
1092 save_alloc((size - SU_SAVE_ALLOC_SIZE) * sizeof(*PL_savestack), 0);
1097 static void su_pop(pTHX_ void *ud);
1099 /* push an su_pop destructor onto the savestack with suitable padding.
1100 * first indicates that this is the first push of a destructor */
1102 static void su_ss_push_destructor(pTHX_ void *ud, I32 depth, bool first) {
1103 #define su_ss_push_destructor(U, D, F) su_ss_push_destructor(aTHX_ (U), (D), (F))
1104 su_ud_origin_elem *origin = SU_UD_ORIGIN(ud);
1106 assert(first || origin[depth+1].orig_ix == PL_savestack_ix);
1108 su_ss_push_padding(ud,
1109 (origin[depth].orig_ix + origin[depth].offset) - PL_savestack_ix);
1111 XSH_D(xsh_debug_log(
1112 "%p: push destructor at save_ix=%d depth=%d scope_ix=%d\n",
1113 ud, PL_savestack_ix, depth, PL_scopestack_ix));
1115 SAVEDESTRUCTOR_X(su_pop, ud);
1118 PL_savestack_ix <= origin[depth+1].orig_ix + origin[depth+1].offset);
1123 /* this is called during each leave_scope() via SAVEDESTRUCTOR_X */
1125 static void su_pop(pTHX_ void *ud) {
1126 #define su_pop(U) su_pop(aTHX_ (U))
1127 I32 depth, base, mark;
1128 su_ud_origin_elem *origin;
1130 depth = SU_UD_DEPTH(ud);
1131 origin = SU_UD_ORIGIN(ud);
1133 XSH_D(xsh_debug_log("%p: ### su_pop: depth=%d\n", ud, depth));
1136 mark = PL_savestack_ix;
1137 base = origin[depth].orig_ix;
1139 XSH_D(xsh_debug_log("%p: residual savestack frame is %d(+%d)..%d\n",
1140 ud, base, origin[depth].offset, mark));
1143 XSH_D(xsh_debug_log("%p: clear leftovers at %d..%d\n", ud, base, mark));
1146 assert(PL_savestack_ix == base);
1148 SU_UD_DEPTH(ud) = depth;
1151 su_ss_push_destructor(ud, depth-1, 0);
1153 I32 offset = origin[0].offset; /* grab value before origin is freed */
1154 switch (SU_UD_TYPE(ud)) {
1155 case SU_UD_TYPE_REAP: {
1157 xsh_debug_log("%p: === reap\n%p: depth=%d scope_ix=%d save_ix=%d\n",
1158 ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix)
1160 SAVEDESTRUCTOR_X(su_call, SU_UD_REAP_CB(ud));
1164 case SU_UD_TYPE_LOCALIZE:
1166 SU_UD_LOCALIZE_FREE(ud);
1168 case SU_UD_TYPE_UID:
1169 SAVEDESTRUCTOR_X(su_uid_drop, ud);
1172 /* perl 5.23.8 onwards is very fussy about the return from leave_scope()
1173 * leaving PL_savestack_ix where it expects it to be */
1174 if (PL_savestack_ix < base + offset) {
1175 I32 gap = (base + offset) - PL_savestack_ix;
1176 assert(gap >= SU_SAVE_ALLOC_SIZE + 1);
1177 su_ss_push_padding(ud, gap);
1179 assert(PL_savestack_ix == base + offset);
1182 XSH_D(xsh_debug_log("%p: end pop: ss_ix=%d\n", ud, PL_savestack_ix));
1185 /* --- Initialize the stack and the action userdata ------------------------ */
1187 static void su_init(pTHX_ void *ud, I32 cxix, I32 size) {
1188 #define su_init(U, C, S) su_init(aTHX_ (U), (C), (S))
1189 su_ud_origin_elem *origin;
1191 I32 cur_cx_ix, cur_scope_ix;
1193 XSH_D(xsh_debug_log("%p: ### su_init(cxix=%d, size=%d)\n", ud, cxix, size));
1195 depth = PL_scopestack_ix - cxstack[cxix].blk_oldscopesp;
1197 depth += (cxstack_ix - cxix); /* each context frame holds 1 scope */
1199 XSH_D(xsh_debug_log(
1200 "%p: going down by depth=%d with scope_ix=%d save_ix=%d\n",
1201 ud, depth, PL_scopestack_ix, PL_savestack_ix));
1203 /* Artificially increase the position of each savestack frame boundary
1204 * to make space to squeeze in a 'size' sized entry (first one) or a
1205 * SU_SAVE_DESTRUCTOR_SIZE sized entry (higher ones). In addition, make
1206 * sure that each boundary is higher than the previous, so that *every*
1207 * scope exit triggers a call to leave_scope(). Each scope exit will call
1208 * the su_pop() destructor, which is responsible for: freeing any
1209 * savestack entries below the artificially raised floor; then pushing a
1210 * new destructor in that space. On the final pop, the "real" savestack
1211 * action is pushed rather than another destructor.
1213 * On older perls, savestack frame boundaries are specified by a range of
1214 * scopestack entries (one per ENTER). Each scope entry typically does
1215 * one or two ENTERs followed by a PUSHBLOCK. Thus the
1216 * cx->blku_oldscopesp field set by the PUSHBLOCK points to the next free
1217 * slot, which is one above the last of the ENTERs. In the debugging
1218 * output we indicate that by bracketing the ENTERs directly preceding
1219 * that context push with dashes, e.g.:
1221 * 13b98d8: ------------------
1222 * 13b98d8: ENTER origin[0] scope[3] savestack=3+3
1223 * 13b98d8: ENTER origin[1] scope[4] savestack=9+3
1224 * 13b98d8: cx=1 LOOP_LAZYIV
1225 * 13b98d8: ------------------
1227 * In addition to context stack pushes, other activities can push ENTERs
1228 * too, such as grep expr and XS sub calls.
1230 * For newer perls (SU_HAS_NEW_CXT), a context push no longer does any
1231 * ENTERs; instead the old savestack position is stored in the new
1232 * cx->blk_oldsaveix field; thus this field specifies an additional
1233 * savestack frame boundary point in addition to the scopestack entries,
1234 * and will also need adjusting.
1236 * We record the original and modified position of each boundary in the
1239 * The passed cxix argument represents the scope we wish to inject into;
1240 * we have to adjust all the savestack frame boundaries above (but not
1241 * including) that context.
1244 Newx(origin, depth, su_ud_origin_elem);
1247 cur_scope_ix = cxstack[cxix].blk_oldscopesp;
1250 XSH_D(xsh_debug_log("%p: cx=%-2d %-11s\n",
1251 ud, cur_cx_ix, SU_CXNAME(cxstack+cur_cx_ix)));
1255 for (i = 0; cur_scope_ix < PL_scopestack_ix; i++) {
1261 if (cur_cx_ix <= cxstack_ix
1262 && cur_scope_ix == cxstack[cur_cx_ix].blk_oldscopesp)
1263 ixp = &(cxstack[cur_cx_ix++].blk_oldsaveix);
1265 ixp = &PL_scopestack[cur_scope_ix++]; /* an ENTER pushed after cur context */
1270 if (cur_cx_ix <= cxstack_ix) {
1271 if (cur_scope_ix == cxstack[cur_cx_ix].blk_oldscopesp) {
1272 xsh_debug_log("%p: cx=%-2d %s\n%p: ------------------\n",
1273 ud, cur_cx_ix, SU_CXNAME(cxstack+cur_cx_ix), ud);
1276 else if (cur_scope_ix + su_cxt_enter_count[CxTYPE(cxstack+cur_cx_ix)]
1277 == cxstack[cur_cx_ix].blk_oldscopesp)
1278 xsh_debug_log("%p: ------------------\n", ud);
1282 ixp = &PL_scopestack[cur_scope_ix++];
1289 /* we have three constraints to satisfy:
1290 * 1) Each adjusted offset must be at least SU_SAVE_DESTRUCTOR_SIZE
1291 * above its unadjusted boundary, so that there is space to inject a
1292 * destructor into the outer scope.
1293 * 2) Each adjusted boundary must be at least SU_SAVE_DESTRUCTOR_SIZE
1294 * higher than the previous adjusted boundary, so that a new
1295 * destructor can be added below the Nth adjusted frame boundary,
1296 * but be within the (N-1)th adjusted frame and so be triggered on
1297 * the next scope exit;
1298 * 3) If the adjustment needs to be greater than SU_SAVE_DESTRUCTOR_SIZE,
1299 * then it should be greater by an amount of at least the minimum
1300 * pad side, so a destructor and padding can be pushed.
1303 offset = SU_SAVE_DESTRUCTOR_SIZE; /* rule 1 */
1304 pad = (origin[i-1].orig_ix + origin[i-1].offset) + offset
1306 if (pad > 0) { /* rule 2 */
1307 if (pad < SU_SAVE_ALLOC_SIZE + 1) /* rule 3 */
1308 pad = SU_SAVE_ALLOC_SIZE + 1;
1313 origin[i].offset = offset;
1314 origin[i].orig_ix = *ixp;
1319 if (ixp == &PL_scopestack[cur_scope_ix-1])
1321 "%p: ENTER origin[%d] scope[%d] savestack=%d+%d\n",
1322 ud, i, cur_scope_ix, origin[i].orig_ix, origin[i].offset);
1325 "%p: cx=%-2d %-11s origin[%d] scope[%d] savestack=%d+%d\n",
1326 ud, cur_cx_ix-1, SU_CXNAME(cxstack+cur_cx_ix-1),
1327 i, cur_scope_ix, origin[i].orig_ix, origin[i].offset);
1330 XSH_D(xsh_debug_log(
1331 "%p: ENTER origin[%d] scope[%d] savestack=%d+%d\n",
1332 ud, i, cur_scope_ix, origin[i].orig_ix, origin[i].offset));
1339 SU_UD_DEPTH(ud) = depth;
1340 SU_UD_ORIGIN(ud) = origin;
1342 su_ss_push_destructor(ud, depth-1, 1);
1345 /* --- Unwind stack -------------------------------------------------------- */
1347 static void su_unwind(pTHX_ void *ud_) {
1349 I32 cxix = XSH_CXT.unwind_storage.cxix;
1350 I32 items = XSH_CXT.unwind_storage.items;
1353 PERL_UNUSED_VAR(ud_);
1355 PL_stack_sp = XSH_CXT.unwind_storage.savesp;
1356 #if XSH_HAS_PERL(5, 19, 4)
1359 SV **sp = PL_stack_sp;
1360 for (i = -items + 1; i <= 0; ++i)
1362 sv_2mortal(SvREFCNT_inc(sp[i]));
1366 if (cxstack_ix > cxix)
1369 mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
1370 PUSHMARK(PL_stack_sp - items);
1373 I32 gimme = GIMME_V;
1374 xsh_debug_log("%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
1376 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
1377 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
1380 PL_op = (OP *) &(XSH_CXT.unwind_storage.return_op);
1381 PL_op = PL_op->op_ppaddr(aTHX);
1383 *PL_markstack_ptr = mark;
1385 XSH_CXT.unwind_storage.proxy_op.op_next = PL_op;
1386 PL_op = &(XSH_CXT.unwind_storage.proxy_op);
1389 /* --- Yield --------------------------------------------------------------- */
1391 #if XSH_HAS_PERL(5, 10, 0)
1392 # define SU_RETOP_SUB(C) ((C)->blk_sub.retop)
1393 # define SU_RETOP_EVAL(C) ((C)->blk_eval.retop)
1394 # define SU_RETOP_LOOP(C) ((C)->blk_loop.my_op->op_lastop->op_next)
1395 # define SU_RETOP_GIVEN(C) ((C)->blk_givwhen.leave_op->op_next)
1397 # define SU_RETOP_SUB(C) ((C)->blk_oldretsp > 0 ? PL_retstack[(C)->blk_oldretsp - 1] : NULL)
1398 # define SU_RETOP_EVAL(C) SU_RETOP_SUB(C)
1399 # define SU_RETOP_LOOP(C) ((C)->blk_loop.last_op->op_next)
1402 static void su_yield(pTHX_ void *ud_) {
1405 const char *which = ud_;
1406 I32 cxix = XSH_CXT.yield_storage.cxix;
1407 I32 items = XSH_CXT.yield_storage.items;
1408 opcode type = OP_NULL;
1412 cx = cxstack + cxix;
1413 switch (CxTYPE(cx)) {
1415 I32 i, cur = cxstack_ix, n = 1;
1417 /* Is this actually a given/when block? This may occur only when yield was
1418 * called with HERE (or nothing) as the context. */
1419 #if XSH_HAS_PERL(5, 10, 0)
1421 PERL_CONTEXT *prev = cx - 1;
1422 U8 prev_type = CxTYPE(prev);
1423 if ((prev_type == CXt_GIVEN || prev_type == CXt_WHEN)
1424 && (prev->blk_oldcop == cx->blk_oldcop)) {
1427 if (prev_type == CXt_GIVEN)
1436 /* Bare blocks (that appear as do { ... } blocks, map { ... } blocks or
1437 * constant folded blcoks) don't need to save the op to return to anywhere
1438 * since 'last' isn't supposed to work inside them. So we climb higher in
1439 * the context stack until we reach a context that has a return op (i.e. a
1440 * sub, an eval, a format or a real loop), recording how many blocks we
1441 * crossed. Then we follow the op_next chain until we get to the leave op
1442 * that closes the original block, which we are assured to reach since
1443 * everything is static (the blocks we have crossed cannot be evals or
1444 * subroutine calls). */
1445 for (i = cxix + 1; i <= cur; ++i) {
1446 PERL_CONTEXT *cx2 = cxstack + i;
1447 switch (CxTYPE(cx2)) {
1453 o = SU_RETOP_SUB(cx2);
1456 o = SU_RETOP_EVAL(cx2);
1458 #if XSH_HAS_PERL(5, 11, 0)
1459 # if XSH_HAS_PERL(5, 23, 8)
1465 case CXt_LOOP_PLAIN:
1466 case CXt_LOOP_LAZYSV:
1467 case CXt_LOOP_LAZYIV:
1471 o = SU_RETOP_LOOP(cx2);
1480 /* We may find other enter/leave blocks on our way to the matching leave.
1481 * Make sure the depth is incremented/decremented appropriately. */
1482 if (o->op_type == OP_ENTER) {
1484 } else if (o->op_type == OP_LEAVE) {
1498 next = SU_RETOP_SUB(cx);
1501 type = CxTRYBLOCK(cx) ? OP_LEAVETRY : OP_LEAVEEVAL;
1502 next = SU_RETOP_EVAL(cx);
1504 #if XSH_HAS_PERL(5, 11, 0)
1505 # if XSH_HAS_PERL(5, 23, 8)
1511 case CXt_LOOP_PLAIN:
1512 case CXt_LOOP_LAZYSV:
1513 case CXt_LOOP_LAZYIV:
1517 type = OP_LEAVELOOP;
1518 next = SU_RETOP_LOOP(cx);
1520 #if XSH_HAS_PERL(5, 10, 0)
1523 type = OP_LEAVEGIVEN;
1524 next = SU_RETOP_GIVEN(cx);
1528 #if XSH_HAS_PERL(5, 15, 1)
1529 type = OP_LEAVEWHEN;
1532 flags |= OPf_SPECIAL;
1538 croak("%s() can't target a substitution context", which);
1541 croak("%s() doesn't know how to leave a %s context",
1542 which, SU_CXNAME(cxstack + cxix));
1546 PL_stack_sp = XSH_CXT.yield_storage.savesp;
1547 #if XSH_HAS_PERL(5, 19, 4)
1550 SV **sp = PL_stack_sp;
1551 for (i = -items + 1; i <= 0; ++i)
1553 sv_2mortal(SvREFCNT_inc(sp[i]));
1557 if (cxstack_ix > cxix)
1560 /* Copy the arguments passed to yield() where the leave op expects to find
1563 Move(PL_stack_sp - items + 1, PL_stack_base + cx->blk_oldsp + 1, items, SV *);
1564 PL_stack_sp = PL_stack_base + cx->blk_oldsp + items;
1566 flags |= OP_GIMME_REVERSE(cx->blk_gimme);
1568 XSH_CXT.yield_storage.leave_op.op_type = type;
1569 XSH_CXT.yield_storage.leave_op.op_ppaddr = PL_ppaddr[type];
1570 XSH_CXT.yield_storage.leave_op.op_flags = flags;
1571 XSH_CXT.yield_storage.leave_op.op_next = next;
1573 PL_op = (OP *) &(XSH_CXT.yield_storage.leave_op);
1574 PL_op = PL_op->op_ppaddr(aTHX);
1576 XSH_CXT.yield_storage.proxy_op.op_next = PL_op;
1577 PL_op = &(XSH_CXT.yield_storage.proxy_op);
1580 /* --- Uplevel ------------------------------------------------------------- */
1582 #define SU_UPLEVEL_SAVE(f, t) STMT_START { sud->old_##f = PL_##f; PL_##f = (t); } STMT_END
1583 #define SU_UPLEVEL_RESTORE(f) STMT_START { PL_##f = sud->old_##f; } STMT_END
1585 static su_uplevel_ud *su_uplevel_storage_new(pTHX_ I32 cxix) {
1586 #define su_uplevel_storage_new(I) su_uplevel_storage_new(aTHX_ (I))
1591 sud = XSH_CXT.uplevel_storage.root;
1593 XSH_CXT.uplevel_storage.root = sud->next;
1594 XSH_CXT.uplevel_storage.count--;
1596 sud = su_uplevel_ud_new();
1599 sud->next = XSH_CXT.uplevel_storage.top;
1600 XSH_CXT.uplevel_storage.top = sud;
1602 depth = su_uid_depth(cxix);
1603 su_uid_storage_dup(&sud->tmp_uid_storage, &XSH_CXT.uid_storage, depth);
1604 sud->old_uid_storage = XSH_CXT.uid_storage;
1605 XSH_CXT.uid_storage = sud->tmp_uid_storage;
1610 #if XSH_HAS_PERL(5, 13, 7)
1612 static void su_uplevel_storage_delete(pTHX_ su_uplevel_ud *sud) {
1613 #define su_uplevel_storage_delete(S) su_uplevel_storage_delete(aTHX_ (S))
1616 sud->tmp_uid_storage = XSH_CXT.uid_storage;
1617 XSH_CXT.uid_storage = sud->old_uid_storage;
1621 map = sud->tmp_uid_storage.map;
1622 alloc = sud->tmp_uid_storage.alloc;
1623 for (i = 0; i < alloc; ++i)
1624 map[i].flags &= ~SU_UID_ACTIVE;
1626 XSH_CXT.uplevel_storage.top = sud->next;
1628 if (XSH_CXT.uplevel_storage.count >= SU_UPLEVEL_STORAGE_SIZE) {
1629 su_uplevel_ud_delete(sud);
1631 sud->next = XSH_CXT.uplevel_storage.root;
1632 XSH_CXT.uplevel_storage.root = sud;
1633 XSH_CXT.uplevel_storage.count++;
1639 static int su_uplevel_goto_static(const OP *o) {
1640 for (; o; o = OpSIBLING(o)) {
1641 /* goto ops are unops with kids. */
1642 if (!(o->op_flags & OPf_KIDS))
1645 switch (o->op_type) {
1648 /* Don't care about gotos inside eval, as they are forbidden at run time. */
1653 if (su_uplevel_goto_static(((const UNOP *) o)->op_first))
1662 #if !SU_HAS_NEW_CXT && SU_UPLEVEL_HIJACKS_RUNOPS
1664 static int su_uplevel_goto_runops(pTHX) {
1665 #define su_uplevel_goto_runops() su_uplevel_goto_runops(aTHX)
1671 if (op->op_type == OP_GOTO) {
1672 AV *argarray = NULL;
1675 for (cxix = cxstack_ix; cxix >= 0; --cxix) {
1676 const PERL_CONTEXT *cx = cxstack + cxix;
1678 switch (CxTYPE(cx)) {
1680 if (CxHASARGS(cx)) {
1681 argarray = cx->blk_sub.argarray;
1697 if (XSH_CXT.uplevel_storage.top->cxix == cxix) {
1698 AV *args = GvAV(PL_defgv);
1699 I32 items = AvFILLp(args);
1701 av_extend(argarray, items);
1702 Copy(AvARRAY(args), AvARRAY(argarray), items + 1, SV *);
1703 AvFILLp(argarray) = items;
1708 PL_op = op = op->op_ppaddr(aTHX);
1710 #if !XSH_HAS_PERL(5, 13, 0)
1720 #endif /* SU_UPLEVEL_HIJACKS_RUNOPS */
1722 #define su_at_underscore(C) PadARRAY(PadlistARRAY(CvPADLIST(C))[CvDEPTH(C)])[0]
1726 static void su_uplevel_restore_new(pTHX_ void *sus_) {
1727 su_uplevel_ud *sud = sus_;
1730 U8 *saved_cxtypes = sud->cxtypes;
1732 for (i = 0; i < sud->gap; i++) {
1733 PERL_CONTEXT *cx = cxstack + sud->cxix + i;
1734 XSH_D(xsh_debug_log("su_uplevel_restore: i=%d cxix=%d type %s => %s\n",
1735 i, cx-cxstack, SU_CX_TYPENAME(CxTYPE(cx)),
1736 SU_CX_TYPENAME(saved_cxtypes[i] & CXTYPEMASK)));
1737 cx->cx_type = saved_cxtypes[i];
1739 Safefree(saved_cxtypes);
1741 /* renamed is a copy of callback, but they share the same CvPADLIST.
1742 * At this point any calls to renamed should have exited so that its
1743 * depth is back to that of of callback. At this point its safe to free
1744 * renamed, then undo the extra ref count that was ensuring that callback
1747 assert(sud->renamed);
1748 assert(sud->callback);
1750 CvDEPTH(sud->callback)--;
1751 assert(CvDEPTH(sud->callback) == CvDEPTH(sud->renamed));
1752 if (!CvISXSUB(sud->renamed)) {
1753 CvDEPTH(sud->renamed) = 0;
1754 CvPADLIST(sud->renamed) = NULL;
1756 SvREFCNT_dec(sud->renamed);
1757 SvREFCNT_dec(sud->callback);
1759 SU_UPLEVEL_RESTORE(curcop);
1761 su_uplevel_storage_delete(sud);
1768 /* 5.23.7 and earlier */
1770 static void su_uplevel_restore_old(pTHX_ void *sus_) {
1771 su_uplevel_ud *sud = sus_;
1772 PERL_SI *cur = sud->old_curstackinfo;
1773 PERL_SI *si = sud->si;
1775 #if SU_UPLEVEL_HIJACKS_RUNOPS
1776 if (PL_runops == su_uplevel_goto_runops)
1777 PL_runops = sud->old_runops;
1780 if (sud->callback) {
1781 PERL_CONTEXT *cx = cxstack + sud->cxix;
1782 AV *argarray = MUTABLE_AV(su_at_underscore(sud->callback));
1784 /* We have to fix the pad entry for @_ in the original callback because it
1785 * may have been reified. */
1786 if (AvREAL(argarray)) {
1787 const I32 fill = AvFILLp(argarray);
1788 SvREFCNT_dec(argarray);
1790 AvREAL_off(argarray);
1791 AvREIFY_on(argarray);
1792 av_extend(argarray, fill);
1793 su_at_underscore(sud->callback) = MUTABLE_SV(argarray);
1795 CLEAR_ARGARRAY(argarray);
1798 /* If the old cv member is our renamed CV, it means that this place has been
1799 * reached without a goto() happening, and the old argarray member is
1800 * actually our fake argarray. Destroy it properly in that case. */
1801 if (cx->blk_sub.cv == sud->renamed) {
1802 SvREFCNT_dec(cx->blk_sub.argarray);
1803 cx->blk_sub.argarray = argarray;
1806 CvDEPTH(sud->callback)--;
1807 SvREFCNT_dec(sud->callback);
1810 /* Free the renamed CV. We must do it ourselves so that we can force the
1811 * depth to be 0, or perl would complain about it being "still in use".
1812 * But we *know* that it cannot be so. */
1814 if (!CvISXSUB(sud->renamed)) {
1815 CvDEPTH(sud->renamed) = 0;
1816 CvPADLIST(sud->renamed) = NULL;
1818 SvREFCNT_dec(sud->renamed);
1821 CATCH_SET(sud->old_catch);
1823 SU_UPLEVEL_RESTORE(op);
1825 /* stack_grow() wants PL_curstack so restore the old stack first */
1826 if (PL_curstackinfo == si) {
1827 PL_curstack = cur->si_stack;
1828 if (sud->old_mainstack)
1829 SU_UPLEVEL_RESTORE(mainstack);
1830 SU_UPLEVEL_RESTORE(curstackinfo);
1833 CV *target = sud->target;
1836 /* When we die, the depth of the target CV is not updated because of the
1837 * stack switcheroo. So we have to look at all the frames between the
1838 * uplevel call and the catch block to count how many call frames to the
1839 * target CV were skipped. */
1840 for (i = cur->si_cxix; i > sud->cxix; i--) {
1841 register const PERL_CONTEXT *cx = cxstack + i;
1843 if (CxTYPE(cx) == CXt_SUB) {
1844 if (cx->blk_sub.cv == target)
1849 /* If we died, the replacement stack was already unwinded to the first
1850 * eval frame, and all the contexts down there were popped. We don't have
1851 * to pop manually any context of the original stack, because they must
1852 * have been in the replacement stack as well (since the second was copied
1853 * from the first). Thus we only have to make sure the original stack index
1854 * points to the context just below the first eval scope under the target
1856 for (; i >= 0; i--) {
1857 register const PERL_CONTEXT *cx = cxstack + i;
1859 switch (CxTYPE(cx)) {
1861 if (cx->blk_sub.cv == target)
1873 CvDEPTH(target) = sud->target_depth - levels;
1874 PL_curstackinfo->si_cxix = i - 1;
1876 #if !XSH_HAS_PERL(5, 13, 1)
1877 /* Since $@ was maybe localized between the target frame and the uplevel
1878 * call, we forcefully flush the save stack to get rid of it and then
1879 * reset $@ to its proper value. Note that the the call to
1880 * su_uplevel_restore() must happen before the "reset $@" item of the save
1881 * stack is processed, as uplevel was called after the localization.
1882 * Andrew's changes to how $@ was handled, which were mainly integrated
1883 * between perl 5.13.0 and 5.13.1, fixed this. */
1884 if (ERRSV && SvTRUE(ERRSV)) {
1885 register const PERL_CONTEXT *cx = cxstack + i; /* This is the eval scope */
1886 SV *errsv = SvREFCNT_inc(ERRSV);
1887 PL_scopestack_ix = cx->blk_oldscopesp;
1888 leave_scope(PL_scopestack[PL_scopestack_ix]);
1889 sv_setsv(ERRSV, errsv);
1890 SvREFCNT_dec(errsv);
1896 SU_UPLEVEL_RESTORE(curcop);
1898 SvREFCNT_dec(sud->target);
1900 PL_stack_base = AvARRAY(cur->si_stack);
1901 PL_stack_sp = PL_stack_base + AvFILLp(cur->si_stack);
1902 PL_stack_max = PL_stack_base + AvMAX(cur->si_stack);
1904 /* When an exception is thrown from the uplevel'd subroutine,
1905 * su_uplevel_restore() may be called by the LEAVE in die_unwind() (renamed
1906 * die_where() in more recent perls), which has the sad habit of keeping a
1907 * pointer to the current context frame across this call. This means that we
1908 * can't free the temporary context stack we used for the uplevel call right
1909 * now, or that pointer upwards would point to garbage. */
1910 #if XSH_HAS_PERL(5, 13, 7)
1911 /* This issue has been fixed in perl with commit 8f89e5a9, which was made
1912 * public in perl 5.13.7. */
1913 su_uplevel_storage_delete(sud);
1915 /* Otherwise, we just enqueue it back in the global storage list. */
1919 sud->tmp_uid_storage = XSH_CXT.uid_storage;
1920 XSH_CXT.uid_storage = sud->old_uid_storage;
1922 XSH_CXT.uplevel_storage.top = sud->next;
1923 sud->next = XSH_CXT.uplevel_storage.root;
1924 XSH_CXT.uplevel_storage.root = sud;
1925 XSH_CXT.uplevel_storage.count++;
1934 static CV *su_cv_clone(pTHX_ CV *proto, GV *gv) {
1935 #define su_cv_clone(P, G) su_cv_clone(aTHX_ (P), (G))
1939 cv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
1941 CvFLAGS(cv) = CvFLAGS(proto);
1943 CvFLAGS(cv) &= ~CVf_CVGV_RC;
1945 CvDEPTH(cv) = CvDEPTH(proto);
1947 CvFILE(cv) = CvISXSUB(proto) ? CvFILE(proto) : savepv(CvFILE(proto));
1949 CvFILE(cv) = CvFILE(proto);
1953 #if SU_RELEASE && XSH_HAS_PERL_EXACT(5, 21, 4)
1956 CvSTASH_set(cv, CvSTASH(proto));
1957 /* Commit 4c74a7df, publicized with perl 5.13.3, began to add backrefs to
1958 * stashes. CvSTASH_set() started to do it as well with commit c68d95645
1959 * (which was part of perl 5.13.7). */
1960 #if XSH_HAS_PERL(5, 13, 3) && !XSH_HAS_PERL(5, 13, 7)
1962 Perl_sv_add_backref(aTHX_ CvSTASH(proto), MUTABLE_SV(cv));
1965 if (CvISXSUB(proto)) {
1966 CvXSUB(cv) = CvXSUB(proto);
1967 CvXSUBANY(cv) = CvXSUBANY(proto);
1970 CvROOT(cv) = OpREFCNT_inc(CvROOT(proto));
1972 CvSTART(cv) = CvSTART(proto);
1973 CvPADLIST(cv) = CvPADLIST(proto);
1975 CvOUTSIDE(cv) = CvOUTSIDE(proto);
1976 #ifdef CVf_WEAKOUTSIDE
1977 if (!(CvFLAGS(proto) & CVf_WEAKOUTSIDE))
1979 SvREFCNT_inc_simple_void(CvOUTSIDE(cv));
1980 #ifdef CvOUTSIDE_SEQ
1981 CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1985 sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
1997 /* this one-shot runops "loop" is designed to be called just before
1998 * execution of the first op following an uplevel()'s entersub. It gets a
1999 * chance to fix up the args as seen by caller(), before immediately
2000 * falling through to the previous runops loop. Note that pp_entersub is
2001 * called directly by call_sv() rather than being called from a runops
2005 static int su_uplevel_runops_hook_entersub(pTHX) {
2008 su_uplevel_ud *sud = XSH_CXT.uplevel_storage.top;
2010 /* Create a new array containing a copy of the original sub's call args,
2011 * then stick it in PL_curpad[0] of the current running sub so that
2012 * thay will be seen by caller().
2015 if (sud->argarray) {
2019 av_extend(av, AvMAX(sud->argarray));
2020 AvFILLp(av) = AvFILLp(sud->argarray);
2021 Copy(AvARRAY(sud->argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
2023 /* should be referenced by PL_curpad[0] and *_ */
2024 assert(SvREFCNT(PL_curpad[0]) > 1);
2025 SvREFCNT_dec(PL_curpad[0]);
2027 PL_curpad[0] = (SV *) av;
2030 /* undo the temporary runops hook and fall through to a real runops loop. */
2031 assert(sud->old_runops != su_uplevel_runops_hook_entersub);
2032 PL_runops = sud->old_runops;
2039 static I32 su_uplevel_new(pTHX_ CV *callback, I32 cxix, I32 args) {
2040 #define su_uplevel_new(CB, CX, A) su_uplevel_new(aTHX_ (CB), (CX), (A))
2045 CV *base_cv = cxstack[cxix].blk_sub.cv;
2048 assert(CxTYPE(&cxstack[cxix]) == CXt_SUB);
2054 /* At this point SP points to the top arg.
2055 * Shuffle the args down by one, eliminating the CV slot */
2056 Move(SP - args + 1, SP - args, args, SV *);
2058 PUSHMARK(SP - args);
2061 sud = su_uplevel_storage_new(cxix);
2064 sud->callback = (CV *) SvREFCNT_inc_simple(callback);
2065 sud->renamed = NULL;
2066 sud->gap = cxstack_ix - cxix + 1;
2067 sud->argarray = NULL;
2069 Newx(saved_cxtypes, sud->gap, U8);
2070 sud->cxtypes = saved_cxtypes;
2072 SAVEDESTRUCTOR_X(su_uplevel_restore_new, sud);
2073 SU_UPLEVEL_SAVE(curcop, cxstack[cxix].blk_oldcop);
2075 /* temporarily change the type of any contexts to NULL, so they're
2076 * invisible to caller() etc. */
2077 for (i = 0; i < sud->gap; i++) {
2078 PERL_CONTEXT *cx = cxstack + cxix + i;
2079 saved_cxtypes[i] = cx->cx_type; /* save type and flags */
2080 XSH_D(xsh_debug_log("su_uplevel: i=%d cxix=%d type %-11s => %s\n",
2081 i, cx-cxstack, SU_CX_TYPENAME(CxTYPE(cx)), SU_CX_TYPENAME(CXt_NULL)));
2082 cx->cx_type = (CXt_NULL | CXp_SU_UPLEVEL_NULLED);
2085 /* create a copy of the callback with a doctored name (as seen by
2086 * caller). It shares the padlist with callback */
2087 sud->renamed = su_cv_clone(callback, CvGV(base_cv));
2088 sud->old_runops = PL_runops;
2090 if (!CvISXSUB(sud->renamed) && CxHASARGS(&cxstack[cxix])) {
2091 sud->argarray = (AV *) su_at_underscore(base_cv);
2092 assert(PL_runops != su_uplevel_runops_hook_entersub);
2093 /* set up a one-shot runops hook so that we can fake up the
2094 * args as seen by caller() on return from pp_entersub */
2095 PL_runops = su_uplevel_runops_hook_entersub;
2098 CvDEPTH(callback)++; /* match what CvDEPTH(sud->renamed) is about to become */
2100 ret = call_sv((SV *) sud->renamed, gimme);
2109 static I32 su_uplevel_old(pTHX_ CV *callback, I32 cxix, I32 args) {
2110 #define su_uplevel_old(CB, CX, A) su_uplevel_old(aTHX_ (CB), (CX), (A))
2112 const PERL_CONTEXT *cx = cxstack + cxix;
2114 PERL_SI *cur = PL_curstackinfo;
2120 I32 old_mark, new_mark;
2127 /* Make PL_stack_sp point just before the CV. */
2128 PL_stack_sp -= args + 1;
2129 old_mark = AvFILLp(PL_curstack) = PL_stack_sp - PL_stack_base;
2132 sud = su_uplevel_storage_new(cxix);
2136 sud->callback = NULL;
2137 sud->renamed = NULL;
2138 SAVEDESTRUCTOR_X(su_uplevel_restore_old, sud);
2142 si->si_type = cur->si_type;
2144 si->si_prev = cur->si_prev;
2146 si->si_markoff = cx->blk_oldmarksp;
2149 /* Allocate enough space for all the elements of the original stack up to the
2150 * target context, plus the forthcoming arguments. */
2151 new_mark = cx->blk_oldsp;
2152 av_extend(si->si_stack, new_mark + 1 + args + 1);
2153 Copy(AvARRAY(PL_curstack), AvARRAY(si->si_stack), new_mark + 1, SV *);
2154 AvFILLp(si->si_stack) = new_mark;
2155 SU_POISON(AvARRAY(si->si_stack) + new_mark + 1, args + 1, SV *);
2157 /* Specialized SWITCHSTACK() */
2158 PL_stack_base = AvARRAY(si->si_stack);
2159 old_stack_sp = PL_stack_sp;
2160 PL_stack_sp = PL_stack_base + AvFILLp(si->si_stack);
2161 PL_stack_max = PL_stack_base + AvMAX(si->si_stack);
2164 /* Copy the context stack up to the context just below the target. */
2165 si->si_cxix = (cxix < 0) ? -1 : (cxix - 1);
2166 if (si->si_cxmax < cxix) {
2167 /* The max size must be at least two so that GROW(max) = (max*3)/2 > max */
2168 si->si_cxmax = (cxix < 4) ? 4 : cxix;
2169 Renew(si->si_cxstack, si->si_cxmax + 1, PERL_CONTEXT);
2171 Copy(cur->si_cxstack, si->si_cxstack, cxix, PERL_CONTEXT);
2172 SU_POISON(si->si_cxstack + cxix, si->si_cxmax + 1 - cxix, PERL_CONTEXT);
2174 target = cx->blk_sub.cv;
2175 sud->target = (CV *) SvREFCNT_inc(target);
2176 sud->target_depth = CvDEPTH(target);
2178 /* blk_oldcop is essentially needed for caller() and stack traces. It has no
2179 * run-time implication, since PL_curcop will be overwritten as soon as we
2180 * enter a sub (a sub starts by a nextstate/dbstate). Hence it's safe to just
2181 * make it point to the blk_oldcop for the target frame, so that caller()
2182 * reports the right file name, line number and lexical hints. */
2183 SU_UPLEVEL_SAVE(curcop, cx->blk_oldcop);
2184 /* Don't reset PL_markstack_ptr, or we would overwrite the mark stack below
2185 * this point. Don't reset PL_curpm either, we want the most recent matches. */
2187 SU_UPLEVEL_SAVE(curstackinfo, si);
2188 /* If those two are equal, we need to fool POPSTACK_TO() */
2189 if (PL_mainstack == PL_curstack)
2190 SU_UPLEVEL_SAVE(mainstack, si->si_stack);
2192 sud->old_mainstack = NULL;
2193 PL_curstack = si->si_stack;
2195 renamed = su_cv_clone(callback, CvGV(target));
2196 sud->renamed = renamed;
2199 /* Both SP and old_stack_sp point just before the CV. */
2200 Copy(old_stack_sp + 2, SP + 1, args, SV *);
2202 PUSHs((SV *) renamed);
2205 Zero(&sub_op, 1, UNOP);
2206 sub_op.op_type = OP_ENTERSUB;
2207 sub_op.op_next = NULL;
2208 sub_op.op_flags = OP_GIMME_REVERSE(gimme) | OPf_STACKED;
2210 sub_op.op_flags |= OPpENTERSUB_DB;
2212 SU_UPLEVEL_SAVE(op, (OP *) &sub_op);
2214 #if SU_UPLEVEL_HIJACKS_RUNOPS
2215 sud->old_runops = PL_runops;
2218 sud->old_catch = CATCH_GET;
2221 if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX))) {
2222 PERL_CONTEXT *sub_cx = cxstack + cxstack_ix;
2223 AV *argarray = cx->blk_sub.argarray;
2225 /* If pp_entersub() returns a non-null OP, it means that the callback is not
2228 sud->callback = MUTABLE_CV(SvREFCNT_inc(callback));
2229 CvDEPTH(callback)++;
2231 if (CxHASARGS(cx) && argarray) {
2232 /* The call to pp_entersub() has saved the current @_ (in XS terms,
2233 * GvAV(PL_defgv)) in the savearray member, and has created a new argarray
2234 * with what we put on the stack. But we want to fake up the same arguments
2235 * as the ones in use at the context we uplevel to, so we replace the
2236 * argarray with an unreal copy of the original @_. */
2240 av_extend(av, AvMAX(argarray));
2241 AvFILLp(av) = AvFILLp(argarray);
2242 Copy(AvARRAY(argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
2243 sub_cx->blk_sub.argarray = av;
2245 SvREFCNT_inc_simple_void(sub_cx->blk_sub.argarray);
2248 if (su_uplevel_goto_static(CvROOT(renamed))) {
2249 #if SU_UPLEVEL_HIJACKS_RUNOPS
2250 if (PL_runops != PL_runops_std) {
2251 if (PL_runops == PL_runops_dbg) {
2253 croak("uplevel() can't execute code that calls goto when debugging flags are set");
2254 } else if (PL_runops != su_uplevel_goto_runops)
2255 croak("uplevel() can't execute code that calls goto with a custom runloop");
2258 PL_runops = su_uplevel_goto_runops;
2259 #else /* SU_UPLEVEL_HIJACKS_RUNOPS */
2260 croak("uplevel() can't execute code that calls goto before perl 5.8");
2261 #endif /* !SU_UPLEVEL_HIJACKS_RUNOPS */
2269 ret = PL_stack_sp - (PL_stack_base + new_mark);
2271 AV *old_stack = sud->old_curstackinfo->si_stack;
2273 if (old_mark + ret > AvMAX(old_stack)) {
2274 /* Specialized EXTEND(old_sp, ret) */
2275 av_extend(old_stack, old_mark + ret + 1);
2276 old_stack_sp = AvARRAY(old_stack) + old_mark;
2279 Copy(PL_stack_sp - ret + 1, old_stack_sp + 1, ret, SV *);
2281 AvFILLp(old_stack) += ret;
2291 /* --- Unique context ID --------------------------------------------------- */
2293 static su_uid *su_uid_storage_fetch(pTHX_ UV depth) {
2294 #define su_uid_storage_fetch(D) su_uid_storage_fetch(aTHX_ (D))
2299 map = XSH_CXT.uid_storage.map;
2300 alloc = XSH_CXT.uid_storage.alloc;
2302 if (depth >= alloc) {
2305 Renew(map, depth + 1, su_uid);
2306 for (i = alloc; i <= depth; ++i) {
2311 XSH_CXT.uid_storage.map = map;
2312 XSH_CXT.uid_storage.alloc = depth + 1;
2315 if (depth >= XSH_CXT.uid_storage.used)
2316 XSH_CXT.uid_storage.used = depth + 1;
2321 static int su_uid_storage_check(pTHX_ UV depth, UV seq) {
2322 #define su_uid_storage_check(D, S) su_uid_storage_check(aTHX_ (D), (S))
2326 if (depth >= XSH_CXT.uid_storage.used)
2329 uid = XSH_CXT.uid_storage.map + depth;
2331 return (uid->seq == seq) && (uid->flags & SU_UID_ACTIVE);
2334 static SV *su_uid_get(pTHX_ I32 cxix) {
2335 #define su_uid_get(I) su_uid_get(aTHX_ (I))
2340 depth = su_uid_depth(cxix);
2341 uid = su_uid_storage_fetch(depth);
2343 if (!(uid->flags & SU_UID_ACTIVE)) {
2346 uid->seq = su_uid_seq_next(depth);
2347 uid->flags |= SU_UID_ACTIVE;
2349 Newx(ud, 1, su_ud_uid);
2350 SU_UD_TYPE(ud) = SU_UD_TYPE_UID;
2352 su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
2355 uid_sv = sv_newmortal();
2356 sv_setpvf(uid_sv, "%"UVuf"-%"UVuf, depth, uid->seq);
2363 #define su_grok_number(S, L, VP) grok_number((S), (L), (VP))
2365 #else /* grok_number */
2367 #define IS_NUMBER_IN_UV 0x1
2369 static int su_grok_number(pTHX_ const char *s, STRLEN len, UV *valuep) {
2370 #define su_grok_number(S, L, VP) su_grok_number(aTHX_ (S), (L), (VP))
2374 /* This crude check should be good enough for a fallback implementation.
2375 * Better be too strict than too lax. */
2376 for (i = 0; i < len; ++i) {
2381 tmpsv = sv_newmortal();
2382 sv_setpvn(tmpsv, s, len);
2383 *valuep = sv_2uv(tmpsv);
2385 return IS_NUMBER_IN_UV;
2388 #endif /* !grok_number */
2390 static int su_uid_validate(pTHX_ SV *uid) {
2391 #define su_uid_validate(U) su_uid_validate(aTHX_ (U))
2397 s = SvPV_const(uid, len);
2399 while (p < len && s[p] != '-')
2402 croak("UID contains only one part");
2404 type = su_grok_number(s, p, &depth);
2405 if (type != IS_NUMBER_IN_UV)
2406 croak("First UID part is not an unsigned integer");
2408 ++p; /* Skip '-'. As we used to have p < len, len - (p + 1) >= 0. */
2410 type = su_grok_number(s + p, len - p, &seq);
2411 if (type != IS_NUMBER_IN_UV)
2412 croak("Second UID part is not an unsigned integer");
2414 return su_uid_storage_check(depth, seq);
2417 /* --- Context operations -------------------------------------------------- */
2419 /* Remove sequences of BLOCKs having DB for stash, followed by a SUB context
2420 * for the debugger callback. */
2422 static I32 su_context_skip_db(pTHX_ I32 cxix) {
2423 #define su_context_skip_db(C) su_context_skip_db(aTHX_ (C))
2429 for (i = cxix; i > 0; --i) {
2430 PERL_CONTEXT *cx = cxstack + i;
2432 switch (CxTYPE(cx)) {
2433 #if XSH_HAS_PERL(5, 17, 1)
2434 case CXt_LOOP_PLAIN:
2437 if (cx->blk_oldcop && CopSTASH(cx->blk_oldcop) == GvSTASH(PL_DBgv))
2441 if (cx->blk_sub.cv == GvCV(PL_DBsub)) {
2458 /* convert a physical context stack index into the logical equivalent:
2459 * one that ignores all the context frames hidden by uplevel().
2460 * Perl-level functions use logical args (e.g. UP takes an optional logical
2461 * value and returns a logical value), while we use and store *real*
2462 * values internally.
2465 static I32 su_context_real2logical(pTHX_ I32 cxix) {
2466 # define su_context_real2logical(C) su_context_real2logical(aTHX_ (C))
2470 for (i = 0; i <= cxix; i++) {
2472 if (cx->cx_type == (CXt_NULL | CXp_SU_UPLEVEL_NULLED))
2476 XSH_D(xsh_debug_log("su_context_real2logical: %d => %d\n", cxix, cxix - gaps));
2481 /* convert a logical context stack index (one that ignores all the context
2482 * frames hidden by uplevel) into the physical equivalent
2485 static I32 su_context_logical2real(pTHX_ I32 cxix) {
2486 # define su_context_logical2real(C) su_context_logical2real(aTHX_ (C))
2490 for (i = 0; i <= cxstack_ix; i++) {
2491 PERL_CONTEXT *cx = cxstack + i;
2492 if (cx->cx_type != (CXt_NULL | CXp_SU_UPLEVEL_NULLED))
2498 XSH_D(xsh_debug_log("su_context_logical2real: %d => %d\n", cxix, i));
2507 # define su_context_real2logical(C) (C)
2508 # define su_context_logical2real(C) (C)
2511 static I32 su_context_normalize_up(pTHX_ I32 cxix) {
2512 #define su_context_normalize_up(C) su_context_normalize_up(aTHX_ (C))
2518 cx = cxstack + cxix;
2519 if (CxTYPE(cx) == CXt_BLOCK) {
2520 PERL_CONTEXT *prev = cx - 1;
2522 switch (CxTYPE(prev)) {
2523 #if XSH_HAS_PERL(5, 10, 0)
2527 #if XSH_HAS_PERL(5, 11, 0)
2528 /* That's the only subcategory that can cause an extra BLOCK context */
2529 case CXt_LOOP_PLAIN:
2533 if (cx->blk_oldcop == prev->blk_oldcop)
2537 if (cx->blk_oldcop && OpSIBLING(cx->blk_oldcop)
2538 && OpSIBLING(cx->blk_oldcop)->op_type == OP_SUBST)
2547 static I32 su_context_normalize_down(pTHX_ I32 cxix) {
2548 #define su_context_normalize_down(C) su_context_normalize_down(aTHX_ (C))
2551 if (cxix >= cxstack_ix)
2554 next = cxstack + cxix + 1;
2555 if (CxTYPE(next) == CXt_BLOCK) {
2556 PERL_CONTEXT *cx = next - 1;
2558 switch (CxTYPE(cx)) {
2559 #if XSH_HAS_PERL(5, 10, 0)
2563 #if XSH_HAS_PERL(5, 11, 0)
2564 /* That's the only subcategory that can cause an extra BLOCK context */
2565 case CXt_LOOP_PLAIN:
2569 if (cx->blk_oldcop == next->blk_oldcop)
2573 if (next->blk_oldcop && OpSIBLING(next->blk_oldcop)
2574 && OpSIBLING(next->blk_oldcop)->op_type == OP_SUBST)
2583 #define su_context_here() su_context_normalize_up(su_context_skip_db(cxstack_ix))
2585 static I32 su_context_gimme(pTHX_ I32 cxix) {
2586 #define su_context_gimme(C) su_context_gimme(aTHX_ (C))
2589 for (i = cxix; i >= 0; --i) {
2590 PERL_CONTEXT *cx = cxstack + i;
2592 switch (CxTYPE(cx)) {
2593 /* gimme is always G_ARRAY for loop contexts. */
2594 #if XSH_HAS_PERL(5, 11, 0)
2595 # if XSH_HAS_PERL(5, 23, 8)
2601 case CXt_LOOP_PLAIN:
2602 case CXt_LOOP_LAZYSV:
2603 case CXt_LOOP_LAZYIV:
2608 const COP *cop = cx->blk_oldcop;
2609 if (cop && OpSIBLING(cop)) {
2610 switch (OpSIBLING(cop)->op_flags & OPf_WANT) {
2613 case OPf_WANT_SCALAR:
2632 /* --- Module setup/teardown ----------------------------------------------- */
2634 static void xsh_user_global_setup(pTHX) {
2637 MUTEX_INIT(&su_uid_seq_counter_mutex);
2639 XSH_LOCK(&su_uid_seq_counter_mutex);
2640 su_uid_seq_counter.seqs = NULL;
2641 su_uid_seq_counter.size = 0;
2642 XSH_UNLOCK(&su_uid_seq_counter_mutex);
2644 stash = gv_stashpv(XSH_PACKAGE, 1);
2645 newCONSTSUB(stash, "TOP", newSViv(0));
2646 newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(XSH_THREADSAFE));
2651 static void xsh_user_local_setup(pTHX_ xsh_user_cxt_t *cxt) {
2653 /* NewOp() calls calloc() which just zeroes the memory with memset(). */
2654 Zero(&(cxt->unwind_storage.return_op), 1, LISTOP);
2655 cxt->unwind_storage.return_op.op_type = OP_RETURN;
2656 cxt->unwind_storage.return_op.op_ppaddr = PL_ppaddr[OP_RETURN];
2658 Zero(&(cxt->unwind_storage.proxy_op), 1, OP);
2659 cxt->unwind_storage.proxy_op.op_type = OP_STUB;
2660 cxt->unwind_storage.proxy_op.op_ppaddr = NULL;
2662 Zero(&(cxt->yield_storage.leave_op), 1, UNOP);
2663 cxt->yield_storage.leave_op.op_type = OP_STUB;
2664 cxt->yield_storage.leave_op.op_ppaddr = NULL;
2666 Zero(&(cxt->yield_storage.proxy_op), 1, OP);
2667 cxt->yield_storage.proxy_op.op_type = OP_STUB;
2668 cxt->yield_storage.proxy_op.op_ppaddr = NULL;
2670 cxt->uplevel_storage.top = NULL;
2671 cxt->uplevel_storage.root = NULL;
2672 cxt->uplevel_storage.count = 0;
2674 cxt->uid_storage.map = NULL;
2675 cxt->uid_storage.used = 0;
2676 cxt->uid_storage.alloc = 0;
2681 static void xsh_user_local_teardown(pTHX_ xsh_user_cxt_t *cxt) {
2684 Safefree(cxt->uid_storage.map);
2686 cur = cxt->uplevel_storage.root;
2688 su_uplevel_ud *prev;
2692 su_uplevel_ud_delete(prev);
2699 static void xsh_user_global_teardown(pTHX) {
2700 XSH_LOCK(&su_uid_seq_counter_mutex);
2701 PerlMemShared_free(su_uid_seq_counter.seqs);
2702 su_uid_seq_counter.size = 0;
2703 XSH_UNLOCK(&su_uid_seq_counter_mutex);
2705 MUTEX_DESTROY(&su_uid_seq_counter_mutex);
2710 /* --- XS ------------------------------------------------------------------ */
2712 /* D is real; B is logical. Returns real. */
2714 #define SU_GET_CONTEXT(A, B, D) \
2723 else if (cxix > cxstack_ix) \
2725 cxix = su_context_logical2real(cxix); \
2732 #define SU_GET_LEVEL(A, B) \
2738 level = SvIV(lsv); \
2745 #if XSH_HAS_PERL(5, 10, 0)
2746 # define SU_INFO_COUNT 11
2748 # define SU_INFO_COUNT 10
2751 XS(XS_Scope__Upper_unwind) {
2760 PERL_UNUSED_VAR(cv); /* -W */
2761 PERL_UNUSED_VAR(ax); /* -Wall */
2763 SU_GET_CONTEXT(0, items - 1, cxstack_ix);
2765 PERL_CONTEXT *cx = cxstack + cxix;
2766 switch (CxTYPE(cx)) {
2768 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2772 XSH_CXT.unwind_storage.cxix = cxix;
2773 XSH_CXT.unwind_storage.items = items;
2774 XSH_CXT.unwind_storage.savesp = PL_stack_sp;
2776 XSH_CXT.unwind_storage.items--;
2777 XSH_CXT.unwind_storage.savesp--;
2779 /* pp_entersub will want to sanitize the stack after returning from there
2780 * Screw that, we're insane!
2781 * dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
2782 if (GIMME_V == G_SCALAR)
2783 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2784 SAVEDESTRUCTOR_X(su_unwind, NULL);
2789 } while (--cxix >= 0);
2790 croak("Can't return outside a subroutine");
2793 static const char su_yield_name[] = "yield";
2795 XS(XS_Scope__Upper_yield) {
2804 PERL_UNUSED_VAR(cv); /* -W */
2805 PERL_UNUSED_VAR(ax); /* -Wall */
2807 SU_GET_CONTEXT(0, items - 1, su_context_here());
2808 XSH_CXT.yield_storage.cxix = cxix;
2809 XSH_CXT.yield_storage.items = items;
2810 XSH_CXT.yield_storage.savesp = PL_stack_sp;
2812 XSH_CXT.yield_storage.items--;
2813 XSH_CXT.yield_storage.savesp--;
2815 /* See XS_Scope__Upper_unwind */
2816 if (GIMME_V == G_SCALAR)
2817 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2818 SAVEDESTRUCTOR_X(su_yield, su_yield_name);
2822 static const char su_leave_name[] = "leave";
2824 XS(XS_Scope__Upper_leave) {
2832 PERL_UNUSED_VAR(cv); /* -W */
2833 PERL_UNUSED_VAR(ax); /* -Wall */
2835 XSH_CXT.yield_storage.cxix = su_context_here();
2836 XSH_CXT.yield_storage.items = items;
2837 XSH_CXT.yield_storage.savesp = PL_stack_sp;
2838 /* See XS_Scope__Upper_unwind */
2839 if (GIMME_V == G_SCALAR)
2840 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2842 SAVEDESTRUCTOR_X(su_yield, su_leave_name);
2847 MODULE = Scope::Upper PACKAGE = Scope::Upper
2854 newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
2855 newXSproto("Scope::Upper::yield", XS_Scope__Upper_yield, file, NULL);
2856 newXSproto("Scope::Upper::leave", XS_Scope__Upper_leave, file, NULL);
2868 #endif /* XSH_THREADSAFE */
2876 cxix = su_context_real2logical(su_context_here());
2887 SU_GET_CONTEXT(0, 0, su_context_here());
2890 cxix = su_context_skip_db(cxix);
2891 cxix = su_context_normalize_up(cxix);
2892 cxix = su_context_real2logical(cxix);
2894 warn(su_stack_smash);
2906 SU_GET_CONTEXT(0, 0, cxstack_ix);
2908 for (; cxix >= 0; --cxix) {
2909 PERL_CONTEXT *cx = cxstack + cxix;
2910 switch (CxTYPE(cx)) {
2914 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2916 cxix = su_context_real2logical(cxix);
2921 warn(su_no_such_target, "subroutine");
2930 SU_GET_CONTEXT(0, 0, cxstack_ix);
2932 for (; cxix >= 0; --cxix) {
2933 PERL_CONTEXT *cx = cxstack + cxix;
2934 switch (CxTYPE(cx)) {
2938 cxix = su_context_real2logical(cxix);
2943 warn(su_no_such_target, "eval");
2953 cxix = su_context_here();
2954 while (--level >= 0) {
2956 warn(su_stack_smash);
2960 cxix = su_context_skip_db(cxix);
2961 cxix = su_context_normalize_up(cxix);
2962 cxix = su_context_real2logical(cxix);
2975 for (cxix = cxstack_ix; cxix > 0; --cxix) {
2976 PERL_CONTEXT *cx = cxstack + cxix;
2977 switch (CxTYPE(cx)) {
2979 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2990 warn(su_stack_smash);
2992 cxix = su_context_real2logical(cxix);
3002 SU_GET_CONTEXT(0, 0, cxstack_ix);
3005 PERL_CONTEXT *cx = cxstack + cxix--;
3006 switch (CxTYPE(cx)) {
3008 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
3012 I32 gimme = cx->blk_gimme;
3014 case G_VOID: XSRETURN_UNDEF; break;
3015 case G_SCALAR: XSRETURN_NO; break;
3016 case G_ARRAY: XSRETURN_YES; break;
3029 const PERL_CONTEXT *cx, *dbcx;
3032 SU_GET_CONTEXT(0, 0, su_context_skip_db(cxstack_ix));
3033 cxix = su_context_normalize_up(cxix);
3034 cx = cxstack + cxix;
3036 if (PL_DBsub && cxix && (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT)) {
3037 I32 i = su_context_skip_db(cxix - 1) + 1;
3038 if (i < cxix && CxTYPE(cxstack + i) == CXt_SUB)
3041 cop = cx->blk_oldcop;
3042 EXTEND(SP, SU_INFO_COUNT);
3045 HV *stash = CopSTASH(cop);
3047 PUSHs(su_newmortal_pvn(HvNAME(stash), HvNAMELEN(stash)));
3049 PUSHs(&PL_sv_undef);
3052 PUSHs(su_newmortal_pvn(OutCopFILE(cop), OutCopFILE_len(cop)));
3054 mPUSHi(CopLINE(cop));
3055 /* subroutine (3) and has_args (4) */
3056 switch (CxTYPE(cx)) {
3059 GV *cvgv = CvGV(dbcx->blk_sub.cv);
3060 if (cvgv && isGV(cvgv)) {
3061 SV *sv = sv_newmortal();
3062 gv_efullname3(sv, cvgv, NULL);
3065 PUSHs(su_newmortal_pvs("(unknown)"));
3074 PUSHs(su_newmortal_pvs("(eval)"));
3078 PUSHs(&PL_sv_undef);
3079 PUSHs(&PL_sv_undef);
3082 switch (su_context_gimme(cxix)) {
3089 default: /* G_VOID */
3090 PUSHs(&PL_sv_undef);
3093 /* eval text (6) and is_require (7) */
3094 switch (CxTYPE(cx)) {
3096 if (CxOLD_OP_TYPE(cx) == OP_ENTEREVAL) {
3098 #if XSH_HAS_PERL(5, 17, 4)
3099 PUSHs(newSVpvn_flags(SvPVX(cx->blk_eval.cur_text),
3100 SvCUR(cx->blk_eval.cur_text)-2,
3101 SvUTF8(cx->blk_eval.cur_text)|SVs_TEMP));
3103 PUSHs(cx->blk_eval.cur_text);
3107 } else if (cx->blk_eval.old_namesv) {
3109 PUSHs(sv_mortalcopy(cx->blk_eval.old_namesv));
3115 /* Anything else including eval BLOCK */
3116 PUSHs(&PL_sv_undef);
3117 PUSHs(&PL_sv_undef);
3121 mPUSHi(CopHINTS_get(cop));
3125 #if XSH_HAS_PERL(5, 9, 4)
3126 STRLEN *old_warnings = cop->cop_warnings;
3128 SV *old_warnings = cop->cop_warnings;
3130 if (old_warnings == pWARN_STD) {
3131 if (PL_dowarn & G_WARN_ON)
3132 goto context_info_warnings_on;
3134 #if XSH_HAS_PERL(5, 17, 4)
3135 mask = &PL_sv_undef;
3137 goto context_info_warnings_off;
3139 } else if (old_warnings == pWARN_NONE) {
3140 #if !XSH_HAS_PERL(5, 17, 4)
3141 context_info_warnings_off:
3143 mask = su_newmortal_pvn(WARN_NONEstring, WARNsize);
3144 } else if (old_warnings == pWARN_ALL) {
3146 context_info_warnings_on:
3147 #if XSH_HAS_PERL(5, 8, 7)
3148 bits = get_hv("warnings::Bits", 0);
3150 SV **bits_all = hv_fetchs(bits, "all", FALSE);
3152 mask = sv_mortalcopy(*bits_all);
3156 mask = su_newmortal_pvn(WARN_ALLstring, WARNsize);
3158 #if XSH_HAS_PERL(5, 9, 4)
3159 mask = su_newmortal_pvn((char *) (old_warnings + 1), old_warnings[0]);
3161 mask = sv_mortalcopy(old_warnings);
3166 #if XSH_HAS_PERL(5, 10, 0)
3167 /* hints hash (10) */
3169 COPHH *hints_hash = CopHINTHASH_get(cop);
3171 SV *rhv = sv_2mortal(newRV_noinc((SV *) cophh_2hv(hints_hash, 0)));
3174 PUSHs(&PL_sv_undef);
3178 XSRETURN(SU_INFO_COUNT);
3187 SU_GET_CONTEXT(1, 1, su_context_skip_db(cxstack_ix));
3188 cxix = su_context_normalize_down(cxix);
3189 Newx(ud, 1, su_ud_reap);
3190 SU_UD_TYPE(ud) = SU_UD_TYPE_REAP;
3191 ud->cb = (SvROK(hook) && SvTYPE(SvRV(hook)) >= SVt_PVCV)
3192 ? SvRV(hook) : hook;
3193 SvREFCNT_inc_simple_void(ud->cb);
3194 su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
3197 localize(SV *sv, SV *val, ...)
3204 SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
3205 cxix = su_context_normalize_down(cxix);
3206 Newx(ud, 1, su_ud_localize);
3207 SU_UD_TYPE(ud) = SU_UD_TYPE_LOCALIZE;
3208 size = su_ud_localize_init(ud, sv, val, NULL);
3209 su_init(ud, cxix, size);
3212 localize_elem(SV *sv, SV *elem, SV *val, ...)
3219 if (SvTYPE(sv) >= SVt_PVGV)
3220 croak("Can't infer the element localization type from a glob and the value");
3221 SU_GET_CONTEXT(3, 3, su_context_skip_db(cxstack_ix));
3222 cxix = su_context_normalize_down(cxix);
3223 Newx(ud, 1, su_ud_localize);
3224 /* Initialize SU_UD_ORIGIN(ud) in case SU_UD_LOCALIZE_FREE(ud) needs it */
3225 SU_UD_ORIGIN(ud) = NULL;
3226 SU_UD_TYPE(ud) = SU_UD_TYPE_LOCALIZE;
3227 size = su_ud_localize_init(ud, sv, val, elem);
3228 if (SU_UD_PRIVATE(ud) != SVt_PVAV && SU_UD_PRIVATE(ud) != SVt_PVHV) {
3229 SU_UD_LOCALIZE_FREE(ud);
3230 croak("Can't localize an element of something that isn't an array or a hash");
3232 su_init(ud, cxix, size);
3235 localize_delete(SV *sv, SV *elem, ...)
3242 SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
3243 cxix = su_context_normalize_down(cxix);
3244 Newx(ud, 1, su_ud_localize);
3245 SU_UD_TYPE(ud) = SU_UD_TYPE_LOCALIZE;
3246 size = su_ud_localize_init(ud, sv, NULL, elem);
3247 su_init(ud, cxix, size);
3250 uplevel(SV *code, ...)
3253 I32 cxix, ret, args = 0;
3257 if (SvTYPE(code) < SVt_PVCV)
3258 croak("First argument to uplevel must be a code reference");
3259 SU_GET_CONTEXT(1, items - 1, cxstack_ix);
3261 PERL_CONTEXT *cx = cxstack + cxix;
3262 switch (CxTYPE(cx)) {
3264 croak("Can't uplevel to an eval frame");
3266 croak("Can't uplevel to a format frame");
3268 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
3274 /* su_uplevel() takes care of extending the stack if needed. */
3276 ret = su_uplevel_new((CV *) code, cxix, args);
3278 ret = su_uplevel_old((CV *) code, cxix, args);
3284 } while (--cxix >= 0);
3285 croak("Can't uplevel outside a subroutine");
3294 SU_GET_CONTEXT(0, 0, su_context_here());
3295 uid = su_uid_get(cxix);
3301 validate_uid(SV *uid)
3306 ret = su_uid_validate(uid) ? &PL_sv_yes : &PL_sv_no;