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(su_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 su_debug_log("%p: === localize a %s\n",ud, sv_reftype(z, 0));
930 su_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))
1084 if (size < SU_SAVE_ALLOC_SIZE + 1) /* minimum possible SAVEt_ALLOC */
1085 size = SU_SAVE_ALLOC_SIZE + 1;
1087 "%p: push %2d padding at save_ix=%d\n",
1088 ud, size, PL_savestack_ix));
1089 save_alloc((size - SU_SAVE_ALLOC_SIZE)*sizeof(*PL_savestack), 0);
1092 static void su_pop(pTHX_ void *ud);
1094 /* push an su_pop destructor onto the savestack with suitable padding.
1095 * first indicates that this is the first push of a destructor */
1097 static void su_ss_push_destructor(pTHX_ void *ud, I32 depth, bool first) {
1098 #define su_ss_push_destructor(U, D, F) su_ss_push_destructor(aTHX_ (U), (D), (F))
1099 su_ud_origin_elem *origin = SU_UD_ORIGIN(ud);
1101 assert(first || origin[depth+1].orig_ix == PL_savestack_ix);
1102 su_ss_push_padding(ud,
1103 (origin[depth].orig_ix + origin[depth].offset) - PL_savestack_ix);
1105 "%p: push destructor at save_ix=%d depth=%d scope_ix=%d\n",
1106 ud, PL_savestack_ix, depth, PL_scopestack_ix));
1107 SAVEDESTRUCTOR_X(su_pop, ud);
1109 PL_savestack_ix <= origin[depth+1].orig_ix + origin[depth+1].offset);
1112 /* this is called during each leave_scope() via SAVEDESTRUCTOR_X */
1114 static void su_pop(pTHX_ void *ud) {
1115 #define su_pop(U) su_pop(aTHX_ (U))
1116 I32 depth, base, mark;
1117 su_ud_origin_elem *origin;
1119 depth = SU_UD_DEPTH(ud);
1120 origin = SU_UD_ORIGIN(ud);
1122 XSH_D(su_debug_log( "%p: ### su_pop: depth=%d\n", ud, depth));
1125 mark = PL_savestack_ix;
1126 base = origin[depth].orig_ix;
1128 XSH_D(su_debug_log("%p: residual savestack frame is %d(+%d)..%d\n",
1129 ud, base, origin[depth].offset, mark));
1132 XSH_D(su_debug_log("%p: clear leftovers at %d..%d\n", ud, base, mark));
1135 assert(PL_savestack_ix == base);
1137 SU_UD_DEPTH(ud) = depth;
1140 su_ss_push_destructor(ud, depth-1, 0);
1142 I32 offset = origin[0].offset; /* grab value before origin is freed */
1143 switch (SU_UD_TYPE(ud)) {
1144 case SU_UD_TYPE_REAP: {
1145 XSH_D(su_debug_log("%p: === reap\n%p: depth=%d scope_ix=%d save_ix=%d\n",
1146 ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix));
1147 SAVEDESTRUCTOR_X(su_call, SU_UD_REAP_CB(ud));
1151 case SU_UD_TYPE_LOCALIZE:
1153 SU_UD_LOCALIZE_FREE(ud);
1155 case SU_UD_TYPE_UID:
1156 SAVEDESTRUCTOR_X(su_uid_drop, ud);
1159 /* perl 5.23.8 onwards is very fussy about the return from leave_scope()
1160 * leaving PL_savestack_ix where it expects it to be */
1161 if (PL_savestack_ix < base + offset) {
1162 I32 gap = (base + offset) - PL_savestack_ix;
1163 assert(gap >= SU_SAVE_ALLOC_SIZE + 1);
1164 su_ss_push_padding(ud, gap);
1166 assert(PL_savestack_ix == base + offset);
1169 XSH_D(su_debug_log("%p: end pop: ss_ix=%d\n", ud, PL_savestack_ix));
1172 /* --- Initialize the stack and the action userdata ------------------------ */
1174 static void su_init(pTHX_ void *ud, I32 cxix, I32 size) {
1175 #define su_init(U, C, S) su_init(aTHX_ (U), (C), (S))
1177 su_ud_origin_elem *origin;
1181 XSH_D(su_debug_log("%p: ### su_init(cxix=%d, size=%d)\n", ud, cxix, size));
1183 depth = PL_scopestack_ix - cxstack[cxix].blk_oldscopesp;
1185 depth += (cxstack_ix - cxix); /* each context frame holds 1 scope */
1188 "%p: going down by depth=%d with scope_ix=%d save_ix=%d\n",
1189 ud, depth, PL_scopestack_ix, PL_savestack_ix));
1191 /* Artificially increase the position of each savestack frame boundary
1192 * to make space to squeeze in a 'size' sized entry (first one) or a
1193 * SU_SAVE_DESTRUCTOR_SIZE sized entry (higher ones). In addition, make
1194 * sure that each boundary is higher than the previous, so that *every*
1195 * scope exit triggers a call to leave_scope(). Each scope exit will call
1196 * the su_pop() destructor, which is responsible for: freeing any
1197 * savestack entries below the artificially raised floor; then pushing a
1198 * new destructor in that space. On the final pop, the "real" savestack
1199 * action is pushed rather than another destructor.
1201 * On older perls, savestack frame boundaries are specified by a range of
1202 * scopestack entries (one per ENTER). Each scope entry typically does
1203 * one or two ENTERs followed by a PUSHBLOCK. Thus the
1204 * cx->blku_oldscopesp field set by the PUSHBLOCK points to the next free
1205 * slot, which is one above the last of the ENTERs. In the debugging
1206 * output we indicate that by bracketing the ENTERs directly preceding
1207 * that context push with dashes, e.g.:
1209 * 13b98d8: ------------------
1210 * 13b98d8: ENTER origin[0] scope[3] savestack=3+3
1211 * 13b98d8: ENTER origin[1] scope[4] savestack=9+3
1212 * 13b98d8: cx=1 LOOP_LAZYIV
1213 * 13b98d8: ------------------
1215 * In addition to context stack pushes, other activities can push ENTERs
1216 * too, such as grep expr and XS sub calls.
1218 * For newer perls (SU_HAS_NEW_CXT), a context push no longer does any
1219 * ENTERs; instead the old savestack position is stored in the new
1220 * cx->blk_oldsaveix field; thus this field specifies an additional
1221 * savestack frame boundary point in addition to the scopestack entries,
1222 * and will also need adjusting.
1224 * We record the original and modified position of each boundary in the
1227 * The passed cxix argument represents the scope we wish to inject into;
1228 * we have to adjust all the savestack frame boundaries above (but not
1229 * including) that context.
1232 Newx(origin, depth, su_ud_origin_elem);
1235 cur_scope_ix = cxstack[cxix].blk_oldscopesp;
1237 XSH_D(su_debug_log("%p: cx=%-2d %-11s\n",
1238 ud, cur_cx_ix, SU_CXNAME(cxstack+cur_cx_ix)));
1242 for (i = 0; cur_scope_ix < PL_scopestack_ix; i++) {
1248 if ( cur_cx_ix <= cxstack_ix
1249 && cur_scope_ix == cxstack[cur_cx_ix].blk_oldscopesp
1251 ixp = &(cxstack[cur_cx_ix++].blk_oldsaveix);
1253 ixp = &PL_scopestack[cur_scope_ix++]; /* an ENTER pushed after cur context */
1258 if (cur_cx_ix <= cxstack_ix) {
1259 if (cur_scope_ix == cxstack[cur_cx_ix].blk_oldscopesp) {
1261 "%p: cx=%-2d %s\n%p: ------------------\n",
1262 ud, cur_cx_ix, SU_CXNAME(cxstack+cur_cx_ix), ud);
1265 else if (cur_scope_ix + su_cxt_enter_count[CxTYPE(cxstack+cur_cx_ix)]
1266 == cxstack[cur_cx_ix].blk_oldscopesp)
1267 su_debug_log("%p: ------------------\n", ud);
1270 ixp = &PL_scopestack[cur_scope_ix++];
1277 /* we have three constraints to satisfy:
1278 * 1) Each adjusted offset must be at least SU_SAVE_DESTRUCTOR_SIZE
1279 * above its unadjusted boundary, so that there is space to inject a
1280 * destructor into the outer scope.
1281 * 2) Each adjusted boundary must be at least SU_SAVE_DESTRUCTOR_SIZE
1282 * higher than the previous adjusted boundary, so that a new
1283 * destructor can be added below the Nth adjusted frame boundary,
1284 * but be within the (N-1)th adjusted frame and so be triggered on
1285 * the next scope exit;
1286 * 3) If the adjustment needs to be greater than SU_SAVE_DESTRUCTOR_SIZE,
1287 * then it should be greater by an amount of at least the minimum
1288 * pad side, so a destructor and padding can be pushed.
1291 offset = SU_SAVE_DESTRUCTOR_SIZE; /* rule 1 */
1292 pad = (origin[i-1].orig_ix + origin[i-1].offset) + offset - (*ixp + offset);
1293 if (pad > 0) { /* rule 2 */
1294 if (pad < SU_SAVE_ALLOC_SIZE + 1) /* rule 3 */
1295 pad = SU_SAVE_ALLOC_SIZE + 1;
1300 origin[i].offset = offset;
1301 origin[i].orig_ix = *ixp;
1306 if (ixp == &PL_scopestack[cur_scope_ix-1])
1308 "%p: ENTER origin[%d] scope[%d] savestack=%d+%d\n",
1309 ud, i, cur_scope_ix, origin[i].orig_ix, origin[i].offset);
1312 "%p: cx=%-2d %-11s origin[%d] scope[%d] savestack=%d+%d\n",
1313 ud, cur_cx_ix-1, SU_CXNAME(cxstack+cur_cx_ix-1),
1314 i, cur_scope_ix, origin[i].orig_ix, origin[i].offset);
1318 "%p: ENTER origin[%d] scope[%d] savestack=%d+%d\n",
1319 ud, i, cur_scope_ix, origin[i].orig_ix, origin[i].offset));
1326 SU_UD_DEPTH(ud) = depth;
1327 SU_UD_ORIGIN(ud) = origin;
1329 su_ss_push_destructor(ud, depth-1, 1);
1332 /* --- Unwind stack -------------------------------------------------------- */
1334 static void su_unwind(pTHX_ void *ud_) {
1336 I32 cxix = XSH_CXT.unwind_storage.cxix;
1337 I32 items = XSH_CXT.unwind_storage.items;
1340 PERL_UNUSED_VAR(ud_);
1342 PL_stack_sp = XSH_CXT.unwind_storage.savesp;
1343 #if XSH_HAS_PERL(5, 19, 4)
1346 SV **sp = PL_stack_sp;
1347 for (i = -items + 1; i <= 0; ++i)
1349 sv_2mortal(SvREFCNT_inc(sp[i]));
1353 if (cxstack_ix > cxix)
1356 mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
1357 PUSHMARK(PL_stack_sp - items);
1360 I32 gimme = GIMME_V;
1361 su_debug_log("%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
1363 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
1364 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
1367 PL_op = (OP *) &(XSH_CXT.unwind_storage.return_op);
1368 PL_op = PL_op->op_ppaddr(aTHX);
1370 *PL_markstack_ptr = mark;
1372 XSH_CXT.unwind_storage.proxy_op.op_next = PL_op;
1373 PL_op = &(XSH_CXT.unwind_storage.proxy_op);
1376 /* --- Yield --------------------------------------------------------------- */
1378 #if XSH_HAS_PERL(5, 10, 0)
1379 # define SU_RETOP_SUB(C) ((C)->blk_sub.retop)
1380 # define SU_RETOP_EVAL(C) ((C)->blk_eval.retop)
1381 # define SU_RETOP_LOOP(C) ((C)->blk_loop.my_op->op_lastop->op_next)
1382 # define SU_RETOP_GIVEN(C) ((C)->blk_givwhen.leave_op->op_next)
1384 # define SU_RETOP_SUB(C) ((C)->blk_oldretsp > 0 ? PL_retstack[(C)->blk_oldretsp - 1] : NULL)
1385 # define SU_RETOP_EVAL(C) SU_RETOP_SUB(C)
1386 # define SU_RETOP_LOOP(C) ((C)->blk_loop.last_op->op_next)
1389 static void su_yield(pTHX_ void *ud_) {
1392 const char *which = ud_;
1393 I32 cxix = XSH_CXT.yield_storage.cxix;
1394 I32 items = XSH_CXT.yield_storage.items;
1395 opcode type = OP_NULL;
1399 PERL_UNUSED_VAR(ud_);
1401 cx = cxstack + cxix;
1402 switch (CxTYPE(cx)) {
1404 I32 i, cur = cxstack_ix, n = 1;
1406 /* Is this actually a given/when block? This may occur only when yield was
1407 * called with HERE (or nothing) as the context. */
1408 #if XSH_HAS_PERL(5, 10, 0)
1410 PERL_CONTEXT *prev = cx - 1;
1411 U8 prev_type = CxTYPE(prev);
1412 if ((prev_type == CXt_GIVEN || prev_type == CXt_WHEN)
1413 && (prev->blk_oldcop == cx->blk_oldcop)) {
1416 if (prev_type == CXt_GIVEN)
1425 /* Bare blocks (that appear as do { ... } blocks, map { ... } blocks or
1426 * constant folded blcoks) don't need to save the op to return to anywhere
1427 * since 'last' isn't supposed to work inside them. So we climb higher in
1428 * the context stack until we reach a context that has a return op (i.e. a
1429 * sub, an eval, a format or a real loop), recording how many blocks we
1430 * crossed. Then we follow the op_next chain until we get to the leave op
1431 * that closes the original block, which we are assured to reach since
1432 * everything is static (the blocks we have crossed cannot be evals or
1433 * subroutine calls). */
1434 for (i = cxix + 1; i <= cur; ++i) {
1435 PERL_CONTEXT *cx2 = cxstack + i;
1436 switch (CxTYPE(cx2)) {
1442 o = SU_RETOP_SUB(cx2);
1445 o = SU_RETOP_EVAL(cx2);
1447 #if XSH_HAS_PERL(5, 11, 0)
1448 # if XSH_HAS_PERL(5, 23, 8)
1454 case CXt_LOOP_PLAIN:
1455 case CXt_LOOP_LAZYSV:
1456 case CXt_LOOP_LAZYIV:
1460 o = SU_RETOP_LOOP(cx2);
1469 /* We may find other enter/leave blocks on our way to the matching leave.
1470 * Make sure the depth is incremented/decremented appropriately. */
1471 if (o->op_type == OP_ENTER) {
1473 } else if (o->op_type == OP_LEAVE) {
1487 next = SU_RETOP_SUB(cx);
1490 type = CxTRYBLOCK(cx) ? OP_LEAVETRY : OP_LEAVEEVAL;
1491 next = SU_RETOP_EVAL(cx);
1493 #if XSH_HAS_PERL(5, 11, 0)
1494 # if XSH_HAS_PERL(5, 23, 8)
1500 case CXt_LOOP_PLAIN:
1501 case CXt_LOOP_LAZYSV:
1502 case CXt_LOOP_LAZYIV:
1506 type = OP_LEAVELOOP;
1507 next = SU_RETOP_LOOP(cx);
1509 #if XSH_HAS_PERL(5, 10, 0)
1512 type = OP_LEAVEGIVEN;
1513 next = SU_RETOP_GIVEN(cx);
1517 #if XSH_HAS_PERL(5, 15, 1)
1518 type = OP_LEAVEWHEN;
1521 flags |= OPf_SPECIAL;
1527 croak("%s() can't target a substitution context", which);
1530 croak("%s() doesn't know how to leave a %s context",
1531 which, SU_CXNAME(cxstack + cxix));
1535 PL_stack_sp = XSH_CXT.yield_storage.savesp;
1536 #if XSH_HAS_PERL(5, 19, 4)
1539 SV **sp = PL_stack_sp;
1540 for (i = -items + 1; i <= 0; ++i)
1542 sv_2mortal(SvREFCNT_inc(sp[i]));
1546 if (cxstack_ix > cxix)
1549 /* Copy the arguments passed to yield() where the leave op expects to find
1552 Move(PL_stack_sp - items + 1, PL_stack_base + cx->blk_oldsp + 1, items, SV *);
1553 PL_stack_sp = PL_stack_base + cx->blk_oldsp + items;
1555 flags |= OP_GIMME_REVERSE(cx->blk_gimme);
1557 XSH_CXT.yield_storage.leave_op.op_type = type;
1558 XSH_CXT.yield_storage.leave_op.op_ppaddr = PL_ppaddr[type];
1559 XSH_CXT.yield_storage.leave_op.op_flags = flags;
1560 XSH_CXT.yield_storage.leave_op.op_next = next;
1562 PL_op = (OP *) &(XSH_CXT.yield_storage.leave_op);
1563 PL_op = PL_op->op_ppaddr(aTHX);
1565 XSH_CXT.yield_storage.proxy_op.op_next = PL_op;
1566 PL_op = &(XSH_CXT.yield_storage.proxy_op);
1569 /* --- Uplevel ------------------------------------------------------------- */
1571 #define SU_UPLEVEL_SAVE(f, t) STMT_START { sud->old_##f = PL_##f; PL_##f = (t); } STMT_END
1572 #define SU_UPLEVEL_RESTORE(f) STMT_START { PL_##f = sud->old_##f; } STMT_END
1574 static su_uplevel_ud *su_uplevel_storage_new(pTHX_ I32 cxix) {
1575 #define su_uplevel_storage_new(I) su_uplevel_storage_new(aTHX_ (I))
1580 sud = XSH_CXT.uplevel_storage.root;
1582 XSH_CXT.uplevel_storage.root = sud->next;
1583 XSH_CXT.uplevel_storage.count--;
1585 sud = su_uplevel_ud_new();
1588 sud->next = XSH_CXT.uplevel_storage.top;
1589 XSH_CXT.uplevel_storage.top = sud;
1591 depth = su_uid_depth(cxix);
1592 su_uid_storage_dup(&sud->tmp_uid_storage, &XSH_CXT.uid_storage, depth);
1593 sud->old_uid_storage = XSH_CXT.uid_storage;
1594 XSH_CXT.uid_storage = sud->tmp_uid_storage;
1599 #if XSH_HAS_PERL(5, 13, 7)
1601 static void su_uplevel_storage_delete(pTHX_ su_uplevel_ud *sud) {
1602 #define su_uplevel_storage_delete(S) su_uplevel_storage_delete(aTHX_ (S))
1605 sud->tmp_uid_storage = XSH_CXT.uid_storage;
1606 XSH_CXT.uid_storage = sud->old_uid_storage;
1610 map = sud->tmp_uid_storage.map;
1611 alloc = sud->tmp_uid_storage.alloc;
1612 for (i = 0; i < alloc; ++i)
1613 map[i].flags &= ~SU_UID_ACTIVE;
1615 XSH_CXT.uplevel_storage.top = sud->next;
1617 if (XSH_CXT.uplevel_storage.count >= SU_UPLEVEL_STORAGE_SIZE) {
1618 su_uplevel_ud_delete(sud);
1620 sud->next = XSH_CXT.uplevel_storage.root;
1621 XSH_CXT.uplevel_storage.root = sud;
1622 XSH_CXT.uplevel_storage.count++;
1628 static int su_uplevel_goto_static(const OP *o) {
1629 for (; o; o = OpSIBLING(o)) {
1630 /* goto ops are unops with kids. */
1631 if (!(o->op_flags & OPf_KIDS))
1634 switch (o->op_type) {
1637 /* Don't care about gotos inside eval, as they are forbidden at run time. */
1642 if (su_uplevel_goto_static(((const UNOP *) o)->op_first))
1651 #if !SU_HAS_NEW_CXT && SU_UPLEVEL_HIJACKS_RUNOPS
1653 static int su_uplevel_goto_runops(pTHX) {
1654 #define su_uplevel_goto_runops() su_uplevel_goto_runops(aTHX)
1660 if (op->op_type == OP_GOTO) {
1661 AV *argarray = NULL;
1664 for (cxix = cxstack_ix; cxix >= 0; --cxix) {
1665 const PERL_CONTEXT *cx = cxstack + cxix;
1667 switch (CxTYPE(cx)) {
1669 if (CxHASARGS(cx)) {
1670 argarray = cx->blk_sub.argarray;
1686 if (XSH_CXT.uplevel_storage.top->cxix == cxix) {
1687 AV *args = GvAV(PL_defgv);
1688 I32 items = AvFILLp(args);
1690 av_extend(argarray, items);
1691 Copy(AvARRAY(args), AvARRAY(argarray), items + 1, SV *);
1692 AvFILLp(argarray) = items;
1697 PL_op = op = op->op_ppaddr(aTHX);
1699 #if !XSH_HAS_PERL(5, 13, 0)
1709 #endif /* SU_UPLEVEL_HIJACKS_RUNOPS */
1711 #define su_at_underscore(C) PadARRAY(PadlistARRAY(CvPADLIST(C))[CvDEPTH(C)])[0]
1715 static void su_uplevel_restore_new(pTHX_ void *sus_) {
1716 su_uplevel_ud *sud = sus_;
1719 U8 *saved_cxtypes = sud->cxtypes;
1721 for (i = 0; i < sud->gap; i++) {
1722 PERL_CONTEXT *cx = cxstack + sud->cxix + i;
1723 XSH_D(su_debug_log("su_uplevel_restore: i=%d cxix=%d type %s => %s\n",
1724 i, cx-cxstack, SU_CX_TYPENAME(CxTYPE(cx)),
1725 SU_CX_TYPENAME(saved_cxtypes[i] & CXTYPEMASK)));
1726 cx->cx_type = saved_cxtypes[i];
1728 Safefree(saved_cxtypes);
1730 /* renamed is a copy of callback, but they share the same CvPADLIST.
1731 * At this point any calls to renamed should have exited so that its
1732 * depth is back to that of of callback. At this point its safe to free
1733 * renamed, then undo the extra ref count that was ensuring that callback
1736 assert(sud->renamed);
1737 assert(sud->callback);
1739 CvDEPTH(sud->callback)--;
1740 assert(CvDEPTH(sud->callback) == CvDEPTH(sud->renamed));
1741 if (!CvISXSUB(sud->renamed)) {
1742 CvDEPTH(sud->renamed) = 0;
1743 CvPADLIST(sud->renamed) = NULL;
1745 SvREFCNT_dec(sud->renamed);
1746 SvREFCNT_dec(sud->callback);
1748 SU_UPLEVEL_RESTORE(curcop);
1750 su_uplevel_storage_delete(sud);
1757 /* 5.23.7 and earlier */
1759 static void su_uplevel_restore_old(pTHX_ void *sus_) {
1760 su_uplevel_ud *sud = sus_;
1761 PERL_SI *cur = sud->old_curstackinfo;
1762 PERL_SI *si = sud->si;
1764 #if SU_UPLEVEL_HIJACKS_RUNOPS
1765 if (PL_runops == su_uplevel_goto_runops)
1766 PL_runops = sud->old_runops;
1769 if (sud->callback) {
1770 PERL_CONTEXT *cx = cxstack + sud->cxix;
1771 AV *argarray = MUTABLE_AV(su_at_underscore(sud->callback));
1773 /* We have to fix the pad entry for @_ in the original callback because it
1774 * may have been reified. */
1775 if (AvREAL(argarray)) {
1776 const I32 fill = AvFILLp(argarray);
1777 SvREFCNT_dec(argarray);
1779 AvREAL_off(argarray);
1780 AvREIFY_on(argarray);
1781 av_extend(argarray, fill);
1782 su_at_underscore(sud->callback) = MUTABLE_SV(argarray);
1784 CLEAR_ARGARRAY(argarray);
1787 /* If the old cv member is our renamed CV, it means that this place has been
1788 * reached without a goto() happening, and the old argarray member is
1789 * actually our fake argarray. Destroy it properly in that case. */
1790 if (cx->blk_sub.cv == sud->renamed) {
1791 SvREFCNT_dec(cx->blk_sub.argarray);
1792 cx->blk_sub.argarray = argarray;
1795 CvDEPTH(sud->callback)--;
1796 SvREFCNT_dec(sud->callback);
1799 /* Free the renamed CV. We must do it ourselves so that we can force the
1800 * depth to be 0, or perl would complain about it being "still in use".
1801 * But we *know* that it cannot be so. */
1803 if (!CvISXSUB(sud->renamed)) {
1804 CvDEPTH(sud->renamed) = 0;
1805 CvPADLIST(sud->renamed) = NULL;
1807 SvREFCNT_dec(sud->renamed);
1810 CATCH_SET(sud->old_catch);
1812 SU_UPLEVEL_RESTORE(op);
1814 /* stack_grow() wants PL_curstack so restore the old stack first */
1815 if (PL_curstackinfo == si) {
1816 PL_curstack = cur->si_stack;
1817 if (sud->old_mainstack)
1818 SU_UPLEVEL_RESTORE(mainstack);
1819 SU_UPLEVEL_RESTORE(curstackinfo);
1822 CV *target = sud->target;
1825 /* When we die, the depth of the target CV is not updated because of the
1826 * stack switcheroo. So we have to look at all the frames between the
1827 * uplevel call and the catch block to count how many call frames to the
1828 * target CV were skipped. */
1829 for (i = cur->si_cxix; i > sud->cxix; i--) {
1830 register const PERL_CONTEXT *cx = cxstack + i;
1832 if (CxTYPE(cx) == CXt_SUB) {
1833 if (cx->blk_sub.cv == target)
1838 /* If we died, the replacement stack was already unwinded to the first
1839 * eval frame, and all the contexts down there were popped. We don't have
1840 * to pop manually any context of the original stack, because they must
1841 * have been in the replacement stack as well (since the second was copied
1842 * from the first). Thus we only have to make sure the original stack index
1843 * points to the context just below the first eval scope under the target
1845 for (; i >= 0; i--) {
1846 register const PERL_CONTEXT *cx = cxstack + i;
1848 switch (CxTYPE(cx)) {
1850 if (cx->blk_sub.cv == target)
1862 CvDEPTH(target) = sud->target_depth - levels;
1863 PL_curstackinfo->si_cxix = i - 1;
1865 #if !XSH_HAS_PERL(5, 13, 1)
1866 /* Since $@ was maybe localized between the target frame and the uplevel
1867 * call, we forcefully flush the save stack to get rid of it and then
1868 * reset $@ to its proper value. Note that the the call to
1869 * su_uplevel_restore() must happen before the "reset $@" item of the save
1870 * stack is processed, as uplevel was called after the localization.
1871 * Andrew's changes to how $@ was handled, which were mainly integrated
1872 * between perl 5.13.0 and 5.13.1, fixed this. */
1873 if (ERRSV && SvTRUE(ERRSV)) {
1874 register const PERL_CONTEXT *cx = cxstack + i; /* This is the eval scope */
1875 SV *errsv = SvREFCNT_inc(ERRSV);
1876 PL_scopestack_ix = cx->blk_oldscopesp;
1877 leave_scope(PL_scopestack[PL_scopestack_ix]);
1878 sv_setsv(ERRSV, errsv);
1879 SvREFCNT_dec(errsv);
1885 SU_UPLEVEL_RESTORE(curcop);
1887 SvREFCNT_dec(sud->target);
1889 PL_stack_base = AvARRAY(cur->si_stack);
1890 PL_stack_sp = PL_stack_base + AvFILLp(cur->si_stack);
1891 PL_stack_max = PL_stack_base + AvMAX(cur->si_stack);
1893 /* When an exception is thrown from the uplevel'd subroutine,
1894 * su_uplevel_restore() may be called by the LEAVE in die_unwind() (renamed
1895 * die_where() in more recent perls), which has the sad habit of keeping a
1896 * pointer to the current context frame across this call. This means that we
1897 * can't free the temporary context stack we used for the uplevel call right
1898 * now, or that pointer upwards would point to garbage. */
1899 #if XSH_HAS_PERL(5, 13, 7)
1900 /* This issue has been fixed in perl with commit 8f89e5a9, which was made
1901 * public in perl 5.13.7. */
1902 su_uplevel_storage_delete(sud);
1904 /* Otherwise, we just enqueue it back in the global storage list. */
1908 sud->tmp_uid_storage = XSH_CXT.uid_storage;
1909 XSH_CXT.uid_storage = sud->old_uid_storage;
1911 XSH_CXT.uplevel_storage.top = sud->next;
1912 sud->next = XSH_CXT.uplevel_storage.root;
1913 XSH_CXT.uplevel_storage.root = sud;
1914 XSH_CXT.uplevel_storage.count++;
1923 static CV *su_cv_clone(pTHX_ CV *proto, GV *gv) {
1924 #define su_cv_clone(P, G) su_cv_clone(aTHX_ (P), (G))
1928 cv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
1930 CvFLAGS(cv) = CvFLAGS(proto);
1932 CvFLAGS(cv) &= ~CVf_CVGV_RC;
1934 CvDEPTH(cv) = CvDEPTH(proto);
1936 CvFILE(cv) = CvISXSUB(proto) ? CvFILE(proto) : savepv(CvFILE(proto));
1938 CvFILE(cv) = CvFILE(proto);
1942 #if SU_RELEASE && XSH_HAS_PERL_EXACT(5, 21, 4)
1945 CvSTASH_set(cv, CvSTASH(proto));
1946 /* Commit 4c74a7df, publicized with perl 5.13.3, began to add backrefs to
1947 * stashes. CvSTASH_set() started to do it as well with commit c68d95645
1948 * (which was part of perl 5.13.7). */
1949 #if XSH_HAS_PERL(5, 13, 3) && !XSH_HAS_PERL(5, 13, 7)
1951 Perl_sv_add_backref(aTHX_ CvSTASH(proto), MUTABLE_SV(cv));
1954 if (CvISXSUB(proto)) {
1955 CvXSUB(cv) = CvXSUB(proto);
1956 CvXSUBANY(cv) = CvXSUBANY(proto);
1959 CvROOT(cv) = OpREFCNT_inc(CvROOT(proto));
1961 CvSTART(cv) = CvSTART(proto);
1962 CvPADLIST(cv) = CvPADLIST(proto);
1964 CvOUTSIDE(cv) = CvOUTSIDE(proto);
1965 #ifdef CVf_WEAKOUTSIDE
1966 if (!(CvFLAGS(proto) & CVf_WEAKOUTSIDE))
1968 SvREFCNT_inc_simple_void(CvOUTSIDE(cv));
1969 #ifdef CvOUTSIDE_SEQ
1970 CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1974 sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
1986 /* this one-shot runops "loop" is designed to be called just before
1987 * execution of the first op following an uplevel()'s entersub. It gets a
1988 * chance to fix up the args as seen by caller(), before immediately
1989 * falling through to the previous runops loop. Note that pp_entersub is
1990 * called directly by call_sv() rather than being called from a runops
1994 static int su_uplevel_runops_hook_entersub(pTHX) {
1997 su_uplevel_ud *sud = XSH_CXT.uplevel_storage.top;
1999 /* Create a new array containing a copy of the original sub's call args,
2000 * then stick it in PL_curpad[0] of the current running sub so that
2001 * thay will be seen by caller().
2004 if (sud->argarray) {
2008 av_extend(av, AvMAX(sud->argarray));
2009 AvFILLp(av) = AvFILLp(sud->argarray);
2010 Copy(AvARRAY(sud->argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
2012 /* should be referenced by PL_curpad[0] and *_ */
2013 assert(SvREFCNT(PL_curpad[0]) > 1);
2014 SvREFCNT_dec(PL_curpad[0]);
2016 PL_curpad[0] = (SV*)av;
2019 /* undo the temporary runops hook and fall through to a real runops loop. */
2020 assert(sud->old_runops != su_uplevel_runops_hook_entersub);
2021 PL_runops = sud->old_runops;
2026 static I32 su_uplevel_new(pTHX_ CV *callback, I32 cxix, I32 args) {
2027 #define su_uplevel_new(CB, CX, A) su_uplevel_new(aTHX_ (CB), (CX), (A))
2032 CV *base_cv = cxstack[cxix].blk_sub.cv;
2035 assert(CxTYPE(&cxstack[cxix]) == CXt_SUB);
2041 /* At this point SP points to the top arg.
2042 * Shuffle the args down by one, eliminating the CV slot */
2043 Move(SP - args + 1, SP - args, args, SV*);
2045 PUSHMARK(SP - args);
2048 sud = su_uplevel_storage_new(cxix);
2051 sud->callback = (CV*)SvREFCNT_inc_simple(callback);
2052 sud->renamed = NULL;
2053 sud->gap = cxstack_ix - cxix + 1;
2054 sud->argarray = NULL;
2056 Newx(saved_cxtypes, sud->gap, U8);
2057 sud->cxtypes = saved_cxtypes;
2059 SAVEDESTRUCTOR_X(su_uplevel_restore_new, sud);
2060 SU_UPLEVEL_SAVE(curcop, cxstack[cxix].blk_oldcop);
2062 /* temporarily change the type of any contexts to NULL, so they're
2063 * invisible to caller() etc. */
2064 for (i = 0; i < sud->gap; i++) {
2065 PERL_CONTEXT *cx = cxstack + cxix + i;
2066 saved_cxtypes[i] = cx->cx_type; /* save type and flags */
2067 XSH_D(su_debug_log("su_uplevel: i=%d cxix=%d type %-11s => %s\n",
2068 i, cx-cxstack, SU_CX_TYPENAME(CxTYPE(cx)), SU_CX_TYPENAME(CXt_NULL)));
2069 cx->cx_type = (CXt_NULL | CXp_SU_UPLEVEL_NULLED);
2072 /* create a copy of the callback with a doctored name (as seen by
2073 * caller). It shares the padlist with callback */
2074 sud->renamed = su_cv_clone(callback, CvGV(base_cv));
2075 sud->old_runops = PL_runops;
2077 if (!CvISXSUB(sud->renamed) && CxHASARGS(&cxstack[cxix])) {
2078 sud->argarray = (AV*)su_at_underscore(base_cv);
2079 assert(PL_runops != su_uplevel_runops_hook_entersub);
2080 /* set up a one-shot runops hook so that we can fake up the
2081 * args as seen by caller() on return from pp_entersub */
2082 PL_runops = su_uplevel_runops_hook_entersub;
2085 CvDEPTH(callback)++; /* match what CvDEPTH(sud->renamed) is about to become */
2087 ret = call_sv((SV*)sud->renamed, gimme);
2096 static I32 su_uplevel_old(pTHX_ CV *callback, I32 cxix, I32 args) {
2097 #define su_uplevel_old(CB, CX, A) su_uplevel_old(aTHX_ (CB), (CX), (A))
2099 const PERL_CONTEXT *cx = cxstack + cxix;
2101 PERL_SI *cur = PL_curstackinfo;
2107 I32 old_mark, new_mark;
2114 /* Make PL_stack_sp point just before the CV. */
2115 PL_stack_sp -= args + 1;
2116 old_mark = AvFILLp(PL_curstack) = PL_stack_sp - PL_stack_base;
2119 sud = su_uplevel_storage_new(cxix);
2123 sud->callback = NULL;
2124 sud->renamed = NULL;
2125 SAVEDESTRUCTOR_X(su_uplevel_restore_old, sud);
2129 si->si_type = cur->si_type;
2131 si->si_prev = cur->si_prev;
2133 si->si_markoff = cx->blk_oldmarksp;
2136 /* Allocate enough space for all the elements of the original stack up to the
2137 * target context, plus the forthcoming arguments. */
2138 new_mark = cx->blk_oldsp;
2139 av_extend(si->si_stack, new_mark + 1 + args + 1);
2140 Copy(AvARRAY(PL_curstack), AvARRAY(si->si_stack), new_mark + 1, SV *);
2141 AvFILLp(si->si_stack) = new_mark;
2142 SU_POISON(AvARRAY(si->si_stack) + new_mark + 1, args + 1, SV *);
2144 /* Specialized SWITCHSTACK() */
2145 PL_stack_base = AvARRAY(si->si_stack);
2146 old_stack_sp = PL_stack_sp;
2147 PL_stack_sp = PL_stack_base + AvFILLp(si->si_stack);
2148 PL_stack_max = PL_stack_base + AvMAX(si->si_stack);
2151 /* Copy the context stack up to the context just below the target. */
2152 si->si_cxix = (cxix < 0) ? -1 : (cxix - 1);
2153 if (si->si_cxmax < cxix) {
2154 /* The max size must be at least two so that GROW(max) = (max*3)/2 > max */
2155 si->si_cxmax = (cxix < 4) ? 4 : cxix;
2156 Renew(si->si_cxstack, si->si_cxmax + 1, PERL_CONTEXT);
2158 Copy(cur->si_cxstack, si->si_cxstack, cxix, PERL_CONTEXT);
2159 SU_POISON(si->si_cxstack + cxix, si->si_cxmax + 1 - cxix, PERL_CONTEXT);
2161 target = cx->blk_sub.cv;
2162 sud->target = (CV *) SvREFCNT_inc(target);
2163 sud->target_depth = CvDEPTH(target);
2165 /* blk_oldcop is essentially needed for caller() and stack traces. It has no
2166 * run-time implication, since PL_curcop will be overwritten as soon as we
2167 * enter a sub (a sub starts by a nextstate/dbstate). Hence it's safe to just
2168 * make it point to the blk_oldcop for the target frame, so that caller()
2169 * reports the right file name, line number and lexical hints. */
2170 SU_UPLEVEL_SAVE(curcop, cx->blk_oldcop);
2171 /* Don't reset PL_markstack_ptr, or we would overwrite the mark stack below
2172 * this point. Don't reset PL_curpm either, we want the most recent matches. */
2174 SU_UPLEVEL_SAVE(curstackinfo, si);
2175 /* If those two are equal, we need to fool POPSTACK_TO() */
2176 if (PL_mainstack == PL_curstack)
2177 SU_UPLEVEL_SAVE(mainstack, si->si_stack);
2179 sud->old_mainstack = NULL;
2180 PL_curstack = si->si_stack;
2182 renamed = su_cv_clone(callback, CvGV(target));
2183 sud->renamed = renamed;
2186 /* Both SP and old_stack_sp point just before the CV. */
2187 Copy(old_stack_sp + 2, SP + 1, args, SV *);
2189 PUSHs((SV *) renamed);
2192 Zero(&sub_op, 1, UNOP);
2193 sub_op.op_type = OP_ENTERSUB;
2194 sub_op.op_next = NULL;
2195 sub_op.op_flags = OP_GIMME_REVERSE(gimme) | OPf_STACKED;
2197 sub_op.op_flags |= OPpENTERSUB_DB;
2199 SU_UPLEVEL_SAVE(op, (OP *) &sub_op);
2201 #if SU_UPLEVEL_HIJACKS_RUNOPS
2202 sud->old_runops = PL_runops;
2205 sud->old_catch = CATCH_GET;
2208 if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX))) {
2209 PERL_CONTEXT *sub_cx = cxstack + cxstack_ix;
2210 AV *argarray = cx->blk_sub.argarray;
2212 /* If pp_entersub() returns a non-null OP, it means that the callback is not
2215 sud->callback = MUTABLE_CV(SvREFCNT_inc(callback));
2216 CvDEPTH(callback)++;
2218 if (CxHASARGS(cx) && argarray) {
2219 /* The call to pp_entersub() has saved the current @_ (in XS terms,
2220 * GvAV(PL_defgv)) in the savearray member, and has created a new argarray
2221 * with what we put on the stack. But we want to fake up the same arguments
2222 * as the ones in use at the context we uplevel to, so we replace the
2223 * argarray with an unreal copy of the original @_. */
2227 av_extend(av, AvMAX(argarray));
2228 AvFILLp(av) = AvFILLp(argarray);
2229 Copy(AvARRAY(argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
2230 sub_cx->blk_sub.argarray = av;
2232 SvREFCNT_inc_simple_void(sub_cx->blk_sub.argarray);
2235 if (su_uplevel_goto_static(CvROOT(renamed))) {
2236 #if SU_UPLEVEL_HIJACKS_RUNOPS
2237 if (PL_runops != PL_runops_std) {
2238 if (PL_runops == PL_runops_dbg) {
2240 croak("uplevel() can't execute code that calls goto when debugging flags are set");
2241 } else if (PL_runops != su_uplevel_goto_runops)
2242 croak("uplevel() can't execute code that calls goto with a custom runloop");
2245 PL_runops = su_uplevel_goto_runops;
2246 #else /* SU_UPLEVEL_HIJACKS_RUNOPS */
2247 croak("uplevel() can't execute code that calls goto before perl 5.8");
2248 #endif /* !SU_UPLEVEL_HIJACKS_RUNOPS */
2256 ret = PL_stack_sp - (PL_stack_base + new_mark);
2258 AV *old_stack = sud->old_curstackinfo->si_stack;
2260 if (old_mark + ret > AvMAX(old_stack)) {
2261 /* Specialized EXTEND(old_sp, ret) */
2262 av_extend(old_stack, old_mark + ret + 1);
2263 old_stack_sp = AvARRAY(old_stack) + old_mark;
2266 Copy(PL_stack_sp - ret + 1, old_stack_sp + 1, ret, SV *);
2268 AvFILLp(old_stack) += ret;
2278 /* --- Unique context ID --------------------------------------------------- */
2280 static su_uid *su_uid_storage_fetch(pTHX_ UV depth) {
2281 #define su_uid_storage_fetch(D) su_uid_storage_fetch(aTHX_ (D))
2286 map = XSH_CXT.uid_storage.map;
2287 alloc = XSH_CXT.uid_storage.alloc;
2289 if (depth >= alloc) {
2292 Renew(map, depth + 1, su_uid);
2293 for (i = alloc; i <= depth; ++i) {
2298 XSH_CXT.uid_storage.map = map;
2299 XSH_CXT.uid_storage.alloc = depth + 1;
2302 if (depth >= XSH_CXT.uid_storage.used)
2303 XSH_CXT.uid_storage.used = depth + 1;
2308 static int su_uid_storage_check(pTHX_ UV depth, UV seq) {
2309 #define su_uid_storage_check(D, S) su_uid_storage_check(aTHX_ (D), (S))
2313 if (depth >= XSH_CXT.uid_storage.used)
2316 uid = XSH_CXT.uid_storage.map + depth;
2318 return (uid->seq == seq) && (uid->flags & SU_UID_ACTIVE);
2321 static SV *su_uid_get(pTHX_ I32 cxix) {
2322 #define su_uid_get(I) su_uid_get(aTHX_ (I))
2327 depth = su_uid_depth(cxix);
2328 uid = su_uid_storage_fetch(depth);
2330 if (!(uid->flags & SU_UID_ACTIVE)) {
2333 uid->seq = su_uid_seq_next(depth);
2334 uid->flags |= SU_UID_ACTIVE;
2336 Newx(ud, 1, su_ud_uid);
2337 SU_UD_TYPE(ud) = SU_UD_TYPE_UID;
2339 su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
2342 uid_sv = sv_newmortal();
2343 sv_setpvf(uid_sv, "%"UVuf"-%"UVuf, depth, uid->seq);
2350 #define su_grok_number(S, L, VP) grok_number((S), (L), (VP))
2352 #else /* grok_number */
2354 #define IS_NUMBER_IN_UV 0x1
2356 static int su_grok_number(pTHX_ const char *s, STRLEN len, UV *valuep) {
2357 #define su_grok_number(S, L, VP) su_grok_number(aTHX_ (S), (L), (VP))
2361 /* This crude check should be good enough for a fallback implementation.
2362 * Better be too strict than too lax. */
2363 for (i = 0; i < len; ++i) {
2368 tmpsv = sv_newmortal();
2369 sv_setpvn(tmpsv, s, len);
2370 *valuep = sv_2uv(tmpsv);
2372 return IS_NUMBER_IN_UV;
2375 #endif /* !grok_number */
2377 static int su_uid_validate(pTHX_ SV *uid) {
2378 #define su_uid_validate(U) su_uid_validate(aTHX_ (U))
2384 s = SvPV_const(uid, len);
2386 while (p < len && s[p] != '-')
2389 croak("UID contains only one part");
2391 type = su_grok_number(s, p, &depth);
2392 if (type != IS_NUMBER_IN_UV)
2393 croak("First UID part is not an unsigned integer");
2395 ++p; /* Skip '-'. As we used to have p < len, len - (p + 1) >= 0. */
2397 type = su_grok_number(s + p, len - p, &seq);
2398 if (type != IS_NUMBER_IN_UV)
2399 croak("Second UID part is not an unsigned integer");
2401 return su_uid_storage_check(depth, seq);
2404 /* --- Context operations -------------------------------------------------- */
2406 /* Remove sequences of BLOCKs having DB for stash, followed by a SUB context
2407 * for the debugger callback. */
2409 static I32 su_context_skip_db(pTHX_ I32 cxix) {
2410 #define su_context_skip_db(C) su_context_skip_db(aTHX_ (C))
2416 for (i = cxix; i > 0; --i) {
2417 PERL_CONTEXT *cx = cxstack + i;
2419 switch (CxTYPE(cx)) {
2420 #if XSH_HAS_PERL(5, 17, 1)
2421 case CXt_LOOP_PLAIN:
2424 if (cx->blk_oldcop && CopSTASH(cx->blk_oldcop) == GvSTASH(PL_DBgv))
2428 if (cx->blk_sub.cv == GvCV(PL_DBsub)) {
2445 /* convert a physical context stack index into the logical equivalent:
2446 * one that ignores all the context frames hidden by uplevel().
2447 * Perl-level functions use logical args (e.g. UP takes an optional logical
2448 * value and returns a logical value), while we use and store *real*
2449 * values internally.
2452 static I32 su_context_real2logical(pTHX_ I32 cxix) {
2453 # define su_context_real2logical(C) su_context_real2logical(aTHX_ (C))
2457 for (i = 0; i <= cxix; i++) {
2459 if (cx->cx_type == (CXt_NULL | CXp_SU_UPLEVEL_NULLED))
2462 XSH_D(su_debug_log("su_context_real2logical: %d => %d\n", cxix, cxix - gaps));
2466 /* convert a logical context stack index (one that ignores all the context
2467 * frames hidden by uplevel) into the physical equivalent
2470 static I32 su_context_logical2real(pTHX_ I32 cxix) {
2471 # define su_context_logical2real(C) su_context_logical2real(aTHX_ (C))
2475 for (i = 0; i <= cxstack_ix; i++) {
2476 PERL_CONTEXT *cx = cxstack + i;
2477 if (cx->cx_type != (CXt_NULL | CXp_SU_UPLEVEL_NULLED))
2482 XSH_D(su_debug_log("su_context_logical2real: %d => %d\n", cxix, i));
2489 # define su_context_real2logical(C) (C)
2490 # define su_context_logical2real(C) (C)
2493 static I32 su_context_normalize_up(pTHX_ I32 cxix) {
2494 #define su_context_normalize_up(C) su_context_normalize_up(aTHX_ (C))
2500 cx = cxstack + cxix;
2501 if (CxTYPE(cx) == CXt_BLOCK) {
2502 PERL_CONTEXT *prev = cx - 1;
2504 switch (CxTYPE(prev)) {
2505 #if XSH_HAS_PERL(5, 10, 0)
2509 #if XSH_HAS_PERL(5, 11, 0)
2510 /* That's the only subcategory that can cause an extra BLOCK context */
2511 case CXt_LOOP_PLAIN:
2515 if (cx->blk_oldcop == prev->blk_oldcop)
2519 if (cx->blk_oldcop && OpSIBLING(cx->blk_oldcop)
2520 && OpSIBLING(cx->blk_oldcop)->op_type == OP_SUBST)
2529 static I32 su_context_normalize_down(pTHX_ I32 cxix) {
2530 #define su_context_normalize_down(C) su_context_normalize_down(aTHX_ (C))
2533 if (cxix >= cxstack_ix)
2536 next = cxstack + cxix + 1;
2537 if (CxTYPE(next) == CXt_BLOCK) {
2538 PERL_CONTEXT *cx = next - 1;
2540 switch (CxTYPE(cx)) {
2541 #if XSH_HAS_PERL(5, 10, 0)
2545 #if XSH_HAS_PERL(5, 11, 0)
2546 /* That's the only subcategory that can cause an extra BLOCK context */
2547 case CXt_LOOP_PLAIN:
2551 if (cx->blk_oldcop == next->blk_oldcop)
2555 if (next->blk_oldcop && OpSIBLING(next->blk_oldcop)
2556 && OpSIBLING(next->blk_oldcop)->op_type == OP_SUBST)
2565 #define su_context_here() su_context_normalize_up(su_context_skip_db(cxstack_ix))
2567 static I32 su_context_gimme(pTHX_ I32 cxix) {
2568 #define su_context_gimme(C) su_context_gimme(aTHX_ (C))
2571 for (i = cxix; i >= 0; --i) {
2572 PERL_CONTEXT *cx = cxstack + i;
2574 switch (CxTYPE(cx)) {
2575 /* gimme is always G_ARRAY for loop contexts. */
2576 #if XSH_HAS_PERL(5, 11, 0)
2577 # if XSH_HAS_PERL(5, 23, 8)
2583 case CXt_LOOP_PLAIN:
2584 case CXt_LOOP_LAZYSV:
2585 case CXt_LOOP_LAZYIV:
2590 const COP *cop = cx->blk_oldcop;
2591 if (cop && OpSIBLING(cop)) {
2592 switch (OpSIBLING(cop)->op_flags & OPf_WANT) {
2595 case OPf_WANT_SCALAR:
2614 /* --- Module setup/teardown ----------------------------------------------- */
2616 static void xsh_user_global_setup(pTHX) {
2619 MUTEX_INIT(&su_uid_seq_counter_mutex);
2621 XSH_LOCK(&su_uid_seq_counter_mutex);
2622 su_uid_seq_counter.seqs = NULL;
2623 su_uid_seq_counter.size = 0;
2624 XSH_UNLOCK(&su_uid_seq_counter_mutex);
2626 stash = gv_stashpv(XSH_PACKAGE, 1);
2627 newCONSTSUB(stash, "TOP", newSViv(0));
2628 newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(XSH_THREADSAFE));
2633 static void xsh_user_local_setup(pTHX_ xsh_user_cxt_t *cxt) {
2635 /* NewOp() calls calloc() which just zeroes the memory with memset(). */
2636 Zero(&(cxt->unwind_storage.return_op), 1, LISTOP);
2637 cxt->unwind_storage.return_op.op_type = OP_RETURN;
2638 cxt->unwind_storage.return_op.op_ppaddr = PL_ppaddr[OP_RETURN];
2640 Zero(&(cxt->unwind_storage.proxy_op), 1, OP);
2641 cxt->unwind_storage.proxy_op.op_type = OP_STUB;
2642 cxt->unwind_storage.proxy_op.op_ppaddr = NULL;
2644 Zero(&(cxt->yield_storage.leave_op), 1, UNOP);
2645 cxt->yield_storage.leave_op.op_type = OP_STUB;
2646 cxt->yield_storage.leave_op.op_ppaddr = NULL;
2648 Zero(&(cxt->yield_storage.proxy_op), 1, OP);
2649 cxt->yield_storage.proxy_op.op_type = OP_STUB;
2650 cxt->yield_storage.proxy_op.op_ppaddr = NULL;
2652 cxt->uplevel_storage.top = NULL;
2653 cxt->uplevel_storage.root = NULL;
2654 cxt->uplevel_storage.count = 0;
2656 cxt->uid_storage.map = NULL;
2657 cxt->uid_storage.used = 0;
2658 cxt->uid_storage.alloc = 0;
2663 static void xsh_user_local_teardown(pTHX_ xsh_user_cxt_t *cxt) {
2666 Safefree(cxt->uid_storage.map);
2668 cur = cxt->uplevel_storage.root;
2670 su_uplevel_ud *prev;
2674 su_uplevel_ud_delete(prev);
2681 static void xsh_user_global_teardown(pTHX) {
2682 XSH_LOCK(&su_uid_seq_counter_mutex);
2683 PerlMemShared_free(su_uid_seq_counter.seqs);
2684 su_uid_seq_counter.size = 0;
2685 XSH_UNLOCK(&su_uid_seq_counter_mutex);
2687 MUTEX_DESTROY(&su_uid_seq_counter_mutex);
2692 /* --- XS ------------------------------------------------------------------ */
2694 /* D is real; B is logical. Returns real. */
2696 #define SU_GET_CONTEXT(A, B, D) \
2705 else if (cxix > cxstack_ix) \
2707 cxix = su_context_logical2real(cxix); \
2714 #define SU_GET_LEVEL(A, B) \
2720 level = SvIV(lsv); \
2727 #if XSH_HAS_PERL(5, 10, 0)
2728 # define SU_INFO_COUNT 11
2730 # define SU_INFO_COUNT 10
2733 XS(XS_Scope__Upper_unwind) {
2742 PERL_UNUSED_VAR(cv); /* -W */
2743 PERL_UNUSED_VAR(ax); /* -Wall */
2745 SU_GET_CONTEXT(0, items - 1, cxstack_ix);
2747 PERL_CONTEXT *cx = cxstack + cxix;
2748 switch (CxTYPE(cx)) {
2750 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2754 XSH_CXT.unwind_storage.cxix = cxix;
2755 XSH_CXT.unwind_storage.items = items;
2756 XSH_CXT.unwind_storage.savesp = PL_stack_sp;
2758 XSH_CXT.unwind_storage.items--;
2759 XSH_CXT.unwind_storage.savesp--;
2761 /* pp_entersub will want to sanitize the stack after returning from there
2762 * Screw that, we're insane!
2763 * dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
2764 if (GIMME_V == G_SCALAR)
2765 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2766 SAVEDESTRUCTOR_X(su_unwind, NULL);
2771 } while (--cxix >= 0);
2772 croak("Can't return outside a subroutine");
2775 static const char su_yield_name[] = "yield";
2777 XS(XS_Scope__Upper_yield) {
2786 PERL_UNUSED_VAR(cv); /* -W */
2787 PERL_UNUSED_VAR(ax); /* -Wall */
2789 SU_GET_CONTEXT(0, items - 1, su_context_here());
2790 XSH_CXT.yield_storage.cxix = cxix;
2791 XSH_CXT.yield_storage.items = items;
2792 XSH_CXT.yield_storage.savesp = PL_stack_sp;
2794 XSH_CXT.yield_storage.items--;
2795 XSH_CXT.yield_storage.savesp--;
2797 /* See XS_Scope__Upper_unwind */
2798 if (GIMME_V == G_SCALAR)
2799 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2800 SAVEDESTRUCTOR_X(su_yield, su_yield_name);
2804 static const char su_leave_name[] = "leave";
2806 XS(XS_Scope__Upper_leave) {
2814 PERL_UNUSED_VAR(cv); /* -W */
2815 PERL_UNUSED_VAR(ax); /* -Wall */
2817 XSH_CXT.yield_storage.cxix = su_context_here();
2818 XSH_CXT.yield_storage.items = items;
2819 XSH_CXT.yield_storage.savesp = PL_stack_sp;
2820 /* See XS_Scope__Upper_unwind */
2821 if (GIMME_V == G_SCALAR)
2822 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2823 SAVEDESTRUCTOR_X(su_yield, su_leave_name);
2827 MODULE = Scope::Upper PACKAGE = Scope::Upper
2834 newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
2835 newXSproto("Scope::Upper::yield", XS_Scope__Upper_yield, file, NULL);
2836 newXSproto("Scope::Upper::leave", XS_Scope__Upper_leave, file, NULL);
2848 #endif /* XSH_THREADSAFE */
2856 cxix = su_context_real2logical(su_context_here());
2867 SU_GET_CONTEXT(0, 0, su_context_here());
2870 cxix = su_context_skip_db(cxix);
2871 cxix = su_context_normalize_up(cxix);
2872 cxix = su_context_real2logical(cxix);
2874 warn(su_stack_smash);
2886 SU_GET_CONTEXT(0, 0, cxstack_ix);
2888 for (; cxix >= 0; --cxix) {
2889 PERL_CONTEXT *cx = cxstack + cxix;
2890 switch (CxTYPE(cx)) {
2894 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2896 cxix = su_context_real2logical(cxix);
2901 warn(su_no_such_target, "subroutine");
2910 SU_GET_CONTEXT(0, 0, cxstack_ix);
2912 for (; cxix >= 0; --cxix) {
2913 PERL_CONTEXT *cx = cxstack + cxix;
2914 switch (CxTYPE(cx)) {
2918 cxix = su_context_real2logical(cxix);
2923 warn(su_no_such_target, "eval");
2933 cxix = su_context_here();
2934 while (--level >= 0) {
2936 warn(su_stack_smash);
2940 cxix = su_context_skip_db(cxix);
2941 cxix = su_context_normalize_up(cxix);
2942 cxix = su_context_real2logical(cxix);
2955 for (cxix = cxstack_ix; cxix > 0; --cxix) {
2956 PERL_CONTEXT *cx = cxstack + cxix;
2957 switch (CxTYPE(cx)) {
2959 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2970 warn(su_stack_smash);
2972 cxix = su_context_real2logical(cxix);
2982 SU_GET_CONTEXT(0, 0, cxstack_ix);
2985 PERL_CONTEXT *cx = cxstack + cxix--;
2986 switch (CxTYPE(cx)) {
2988 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2992 I32 gimme = cx->blk_gimme;
2994 case G_VOID: XSRETURN_UNDEF; break;
2995 case G_SCALAR: XSRETURN_NO; break;
2996 case G_ARRAY: XSRETURN_YES; break;
3009 const PERL_CONTEXT *cx, *dbcx;
3012 SU_GET_CONTEXT(0, 0, su_context_skip_db(cxstack_ix));
3013 cxix = su_context_normalize_up(cxix);
3014 cx = cxstack + cxix;
3016 if (PL_DBsub && cxix && (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT)) {
3017 I32 i = su_context_skip_db(cxix - 1) + 1;
3018 if (i < cxix && CxTYPE(cxstack + i) == CXt_SUB)
3021 cop = cx->blk_oldcop;
3022 EXTEND(SP, SU_INFO_COUNT);
3025 HV *stash = CopSTASH(cop);
3027 PUSHs(su_newmortal_pvn(HvNAME(stash), HvNAMELEN(stash)));
3029 PUSHs(&PL_sv_undef);
3032 PUSHs(su_newmortal_pvn(OutCopFILE(cop), OutCopFILE_len(cop)));
3034 mPUSHi(CopLINE(cop));
3035 /* subroutine (3) and has_args (4) */
3036 switch (CxTYPE(cx)) {
3039 GV *cvgv = CvGV(dbcx->blk_sub.cv);
3040 if (cvgv && isGV(cvgv)) {
3041 SV *sv = sv_newmortal();
3042 gv_efullname3(sv, cvgv, NULL);
3045 PUSHs(su_newmortal_pvs("(unknown)"));
3054 PUSHs(su_newmortal_pvs("(eval)"));
3058 PUSHs(&PL_sv_undef);
3059 PUSHs(&PL_sv_undef);
3062 switch (su_context_gimme(cxix)) {
3069 default: /* G_VOID */
3070 PUSHs(&PL_sv_undef);
3073 /* eval text (6) and is_require (7) */
3074 switch (CxTYPE(cx)) {
3076 if (CxOLD_OP_TYPE(cx) == OP_ENTEREVAL) {
3078 #if XSH_HAS_PERL(5, 17, 4)
3079 PUSHs(newSVpvn_flags(SvPVX(cx->blk_eval.cur_text),
3080 SvCUR(cx->blk_eval.cur_text)-2,
3081 SvUTF8(cx->blk_eval.cur_text)|SVs_TEMP));
3083 PUSHs(cx->blk_eval.cur_text);
3087 } else if (cx->blk_eval.old_namesv) {
3089 PUSHs(sv_mortalcopy(cx->blk_eval.old_namesv));
3095 /* Anything else including eval BLOCK */
3096 PUSHs(&PL_sv_undef);
3097 PUSHs(&PL_sv_undef);
3101 mPUSHi(CopHINTS_get(cop));
3105 #if XSH_HAS_PERL(5, 9, 4)
3106 STRLEN *old_warnings = cop->cop_warnings;
3108 SV *old_warnings = cop->cop_warnings;
3110 if (old_warnings == pWARN_STD) {
3111 if (PL_dowarn & G_WARN_ON)
3112 goto context_info_warnings_on;
3114 #if XSH_HAS_PERL(5, 17, 4)
3115 mask = &PL_sv_undef;
3117 goto context_info_warnings_off;
3119 } else if (old_warnings == pWARN_NONE) {
3120 #if !XSH_HAS_PERL(5, 17, 4)
3121 context_info_warnings_off:
3123 mask = su_newmortal_pvn(WARN_NONEstring, WARNsize);
3124 } else if (old_warnings == pWARN_ALL) {
3126 context_info_warnings_on:
3127 #if XSH_HAS_PERL(5, 8, 7)
3128 bits = get_hv("warnings::Bits", 0);
3130 SV **bits_all = hv_fetchs(bits, "all", FALSE);
3132 mask = sv_mortalcopy(*bits_all);
3136 mask = su_newmortal_pvn(WARN_ALLstring, WARNsize);
3138 #if XSH_HAS_PERL(5, 9, 4)
3139 mask = su_newmortal_pvn((char *) (old_warnings + 1), old_warnings[0]);
3141 mask = sv_mortalcopy(old_warnings);
3146 #if XSH_HAS_PERL(5, 10, 0)
3147 /* hints hash (10) */
3149 COPHH *hints_hash = CopHINTHASH_get(cop);
3151 SV *rhv = sv_2mortal(newRV_noinc((SV *) cophh_2hv(hints_hash, 0)));
3154 PUSHs(&PL_sv_undef);
3158 XSRETURN(SU_INFO_COUNT);
3167 SU_GET_CONTEXT(1, 1, su_context_skip_db(cxstack_ix));
3168 cxix = su_context_normalize_down(cxix);
3169 Newx(ud, 1, su_ud_reap);
3170 SU_UD_TYPE(ud) = SU_UD_TYPE_REAP;
3171 ud->cb = (SvROK(hook) && SvTYPE(SvRV(hook)) >= SVt_PVCV)
3172 ? SvRV(hook) : hook;
3173 SvREFCNT_inc_simple_void(ud->cb);
3174 su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
3177 localize(SV *sv, SV *val, ...)
3184 SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
3185 cxix = su_context_normalize_down(cxix);
3186 Newx(ud, 1, su_ud_localize);
3187 SU_UD_TYPE(ud) = SU_UD_TYPE_LOCALIZE;
3188 size = su_ud_localize_init(ud, sv, val, NULL);
3189 su_init(ud, cxix, size);
3192 localize_elem(SV *sv, SV *elem, SV *val, ...)
3199 if (SvTYPE(sv) >= SVt_PVGV)
3200 croak("Can't infer the element localization type from a glob and the value");
3201 SU_GET_CONTEXT(3, 3, su_context_skip_db(cxstack_ix));
3202 cxix = su_context_normalize_down(cxix);
3203 Newx(ud, 1, su_ud_localize);
3204 /* Initialize SU_UD_ORIGIN(ud) in case SU_UD_LOCALIZE_FREE(ud) needs it */
3205 SU_UD_ORIGIN(ud) = NULL;
3206 SU_UD_TYPE(ud) = SU_UD_TYPE_LOCALIZE;
3207 size = su_ud_localize_init(ud, sv, val, elem);
3208 if (SU_UD_PRIVATE(ud) != SVt_PVAV && SU_UD_PRIVATE(ud) != SVt_PVHV) {
3209 SU_UD_LOCALIZE_FREE(ud);
3210 croak("Can't localize an element of something that isn't an array or a hash");
3212 su_init(ud, cxix, size);
3215 localize_delete(SV *sv, SV *elem, ...)
3222 SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
3223 cxix = su_context_normalize_down(cxix);
3224 Newx(ud, 1, su_ud_localize);
3225 SU_UD_TYPE(ud) = SU_UD_TYPE_LOCALIZE;
3226 size = su_ud_localize_init(ud, sv, NULL, elem);
3227 su_init(ud, cxix, size);
3230 uplevel(SV *code, ...)
3233 I32 cxix, ret, args = 0;
3237 if (SvTYPE(code) < SVt_PVCV)
3238 croak("First argument to uplevel must be a code reference");
3239 SU_GET_CONTEXT(1, items - 1, cxstack_ix);
3241 PERL_CONTEXT *cx = cxstack + cxix;
3242 switch (CxTYPE(cx)) {
3244 croak("Can't uplevel to an eval frame");
3246 croak("Can't uplevel to a format frame");
3248 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
3254 /* su_uplevel() takes care of extending the stack if needed. */
3256 ret = su_uplevel_new((CV *) code, cxix, args);
3258 ret = su_uplevel_old((CV *) code, cxix, args);
3264 } while (--cxix >= 0);
3265 croak("Can't uplevel outside a subroutine");
3274 SU_GET_CONTEXT(0, 0, su_context_here());
3275 uid = su_uid_get(cxix);
3281 validate_uid(SV *uid)
3286 ret = su_uid_validate(uid) ? &PL_sv_yes : &PL_sv_no;