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 #if XSH_HAS_PERL(5, 23, 8)
21 # define SU_HAS_NEW_CXT
29 # define MUTABLE_SV(S) ((SV *) (S))
33 # define MUTABLE_AV(A) ((AV *) (A))
37 # define MUTABLE_CV(C) ((CV *) (C))
40 #ifndef PERL_UNUSED_VAR
41 # define PERL_UNUSED_VAR(V)
45 # define Newx(v, n, c) New(0, v, n, c)
50 # define SU_POISON(D, N, T) PoisonNew((D), (N), T)
51 # elif defined(Poison)
52 # define SU_POISON(D, N, T) Poison((D), (N), T)
56 # define SU_POISON(D, N, T) NOOP
60 static SV *su_newSV_type(pTHX_ svtype t) {
65 # define newSV_type(T) su_newSV_type(aTHX_ (T))
69 # define su_newmortal_pvn(S, L) newSVpvn_flags((S), (L), SVs_TEMP)
71 # define su_newmortal_pvn(S, L) sv_2mortal(newSVpvn((S), (L)))
73 #define su_newmortal_pvs(S) su_newmortal_pvn((S), sizeof(S)-1)
76 # define SvPV_const(S, L) SvPV(S, L)
80 # define SvPVX_const(S) SvPVX(S)
83 #ifndef SvPV_nolen_const
84 # define SvPV_nolen_const(S) SvPV_nolen(S)
87 #ifndef SvREFCNT_inc_simple_void
88 # define SvREFCNT_inc_simple_void(sv) ((void) SvREFCNT_inc(sv))
92 # define mPUSHi(I) PUSHs(sv_2mortal(newSViv(I)))
96 # define GvCV_set(G, C) (GvCV(G) = (C))
100 # define CvGV_set(C, G) (CvGV(C) = (G))
104 # define CvSTASH_set(C, S) (CvSTASH(C) = (S))
108 # define CvISXSUB(C) CvXSUB(C)
112 # define PadlistARRAY(P) AvARRAY(P)
113 # define PadARRAY(P) AvARRAY(P)
117 # define CxHASARGS(C) ((C)->blk_sub.hasargs)
122 # define CxGIMME(C) ((C)->blk_gimme & G_WANT)
124 # define CxGIMME(C) ((C)->blk_gimme)
128 #ifndef CxOLD_OP_TYPE
129 # define CxOLD_OP_TYPE(C) (C)->blk_eval.old_op_type
133 # define OutCopFILE(C) CopFILE(C)
136 #ifndef OutCopFILE_len
137 # define OutCopFILE_len(C) strlen(OutCopFILE(C))
141 # define CopHINTS_get(C) ((I32) (C)->op_private & HINT_PRIVATE_MASK)
144 #ifndef CopHINTHASH_get
145 # define CopHINTHASH_get(C) (C)->cop_hints_hash
149 # define COPHH struct refcounted_he
150 # define cophh_2hv(H, F) Perl_refcounted_he_chain_2hv(aTHX_ (H))
154 # define HvNAME_get(H) HvNAME(H)
158 # define HvNAMELEN(H) strlen(HvNAME(H))
161 #ifndef gv_fetchpvn_flags
162 # define gv_fetchpvn_flags(A, B, C, D) gv_fetchpv((A), (C), (D))
166 # define hv_fetchs(H, K, L) hv_fetch((H), (K), sizeof(K)-1, (L))
169 #ifndef OP_GIMME_REVERSE
170 static U8 su_op_gimme_reverse(U8 gimme) {
173 return OPf_WANT_VOID;
175 return OPf_WANT_LIST;
180 return OPf_WANT_SCALAR;
182 #define OP_GIMME_REVERSE(G) su_op_gimme_reverse(G)
187 # define OpSIBLING(O) OP_SIBLING(O)
189 # define OpSIBLING(O) ((O)->op_sibling)
193 #ifndef PERL_MAGIC_tied
194 # define PERL_MAGIC_tied 'P'
197 #ifndef PERL_MAGIC_env
198 # define PERL_MAGIC_env 'E'
201 #ifndef NEGATIVE_INDICES_VAR
202 # define NEGATIVE_INDICES_VAR "NEGATIVE_INDICES"
205 /* --- Error messages ------------------------------------------------------ */
207 static const char su_stack_smash[] = "Cannot target a scope outside of the current stack";
208 static const char su_no_such_target[] = "No targetable %s scope in the current stack";
210 /* --- Unique context ID global storage ------------------------------------ */
212 /* ... Sequence ID counter ................................................. */
219 static su_uv_array su_uid_seq_counter;
223 static perl_mutex su_uid_seq_counter_mutex;
225 #endif /* USE_ITHREADS */
227 static UV su_uid_seq_next(pTHX_ UV depth) {
228 #define su_uid_seq_next(D) su_uid_seq_next(aTHX_ (D))
232 XSH_LOCK(&su_uid_seq_counter_mutex);
234 seqs = su_uid_seq_counter.seqs;
236 if (depth >= su_uid_seq_counter.size) {
239 seqs = PerlMemShared_realloc(seqs, (depth + 1) * sizeof(UV));
240 for (i = su_uid_seq_counter.size; i <= depth; ++i)
243 su_uid_seq_counter.seqs = seqs;
244 su_uid_seq_counter.size = depth + 1;
249 XSH_UNLOCK(&su_uid_seq_counter_mutex);
254 /* ... UID storage ......................................................... */
261 #define SU_UID_ACTIVE 1
263 static UV su_uid_depth(pTHX_ I32 cxix) {
264 #define su_uid_depth(I) su_uid_depth(aTHX_ (I))
269 for (si = PL_curstackinfo->si_prev; si; si = si->si_prev)
270 depth += si->si_cxix + 1;
281 static void su_uid_storage_dup(pTHX_ su_uid_storage *new_cxt, const su_uid_storage *old_cxt, UV max_depth) {
282 #define su_uid_storage_dup(N, O, D) su_uid_storage_dup(aTHX_ (N), (O), (D))
283 su_uid *old_map = old_cxt->map;
286 su_uid *new_map = new_cxt->map;
287 STRLEN old_used = old_cxt->used;
288 STRLEN new_used, new_alloc;
291 new_used = max_depth < old_used ? max_depth : old_used;
292 new_cxt->used = new_used;
294 if (new_used <= new_cxt->alloc) {
295 new_alloc = new_cxt->alloc;
297 new_alloc = new_used;
298 Renew(new_map, new_alloc, su_uid);
299 new_cxt->map = new_map;
300 new_cxt->alloc = new_alloc;
303 for (i = 0; i < new_alloc; ++i) {
304 su_uid *new_uid = new_map + i;
306 if (i < new_used) { /* => i < max_depth && i < old_used */
307 su_uid *old_uid = old_map + i;
309 if (old_uid && (old_uid->flags & SU_UID_ACTIVE)) {
323 /* --- unwind() global storage --------------------------------------------- */
333 /* --- yield() global storage ---------------------------------------------- */
343 /* --- uplevel() data tokens and global storage ---------------------------- */
345 #define SU_UPLEVEL_HIJACKS_RUNOPS XSH_HAS_PERL(5, 8, 0)
350 su_uid_storage tmp_uid_storage;
351 su_uid_storage old_uid_storage;
358 #ifdef SU_HAS_NEW_CXT
359 U8 *cxtypes; /* array of saved context types */
360 I32 gap; /* how many contexts have temporarily CXt_NULLed out*/
361 AV* argarray; /* the PL_curpad[0] of the uplevel sub */
366 PERL_SI *old_curstackinfo;
375 #if SU_UPLEVEL_HIJACKS_RUNOPS
376 runops_proc_t old_runops;
380 #ifdef SU_HAS_NEW_CXT
381 /* used to flag a context stack entry whose type has been temporarily
382 * set to CXt_NULL. It relies on perl not using this value for real
385 # define CXp_SU_UPLEVEL_NULLED 0x20
388 static su_uplevel_ud *su_uplevel_ud_new(pTHX) {
389 #define su_uplevel_ud_new() su_uplevel_ud_new(aTHX)
393 Newx(sud, 1, su_uplevel_ud);
396 sud->tmp_uid_storage.map = NULL;
397 sud->tmp_uid_storage.used = 0;
398 sud->tmp_uid_storage.alloc = 0;
400 #ifndef SU_HAS_NEW_CXT
401 Newx(si, 1, PERL_SI);
402 si->si_stack = newAV();
403 AvREAL_off(si->si_stack);
404 si->si_cxstack = NULL;
413 static void su_uplevel_ud_delete(pTHX_ su_uplevel_ud *sud) {
414 #define su_uplevel_ud_delete(S) su_uplevel_ud_delete(aTHX_ (S))
416 #ifndef SU_HAS_NEW_CXT
417 PERL_SI *si = sud->si;
419 Safefree(si->si_cxstack);
420 SvREFCNT_dec(si->si_stack);
424 Safefree(sud->tmp_uid_storage.map);
435 } su_uplevel_storage;
437 #ifndef SU_UPLEVEL_STORAGE_SIZE
438 # define SU_UPLEVEL_STORAGE_SIZE 4
441 /* --- Global data --------------------------------------------------------- */
444 su_unwind_storage unwind_storage;
445 su_yield_storage yield_storage;
446 su_uplevel_storage uplevel_storage;
447 su_uid_storage uid_storage;
450 #define XSH_THREADS_USER_CONTEXT 1
451 #define XSH_THREADS_USER_CLONE_NEEDS_DUP 0
452 #define XSH_THREADS_COMPILE_TIME_PROTECTION 0
456 static void xsh_user_clone(pTHX_ const xsh_user_cxt_t *old_cxt, xsh_user_cxt_t *new_cxt) {
457 new_cxt->uplevel_storage.top = NULL;
458 new_cxt->uplevel_storage.root = NULL;
459 new_cxt->uplevel_storage.count = 0;
460 new_cxt->uid_storage.map = NULL;
461 new_cxt->uid_storage.used = 0;
462 new_cxt->uid_storage.alloc = 0;
464 su_uid_storage_dup(&new_cxt->uid_storage, &old_cxt->uid_storage,
465 old_cxt->uid_storage.used);
470 #endif /* XSH_THREADSAFE */
472 #include "xsh/threads.h"
474 /* --- Stack manipulations ------------------------------------------------- */
476 /* how many slots on the save stack various save types take up */
478 #define SU_SAVE_DESTRUCTOR_SIZE 3 /* SAVEt_DESTRUCTOR_X */
479 #define SU_SAVE_SCALAR_SIZE 3 /* SAVEt_SV */
480 #define SU_SAVE_ARY_SIZE 3 /* SAVEt_AV */
481 #define SU_SAVE_AELEM_SIZE 4 /* SAVEt_AELEM */
482 #define SU_SAVE_HASH_SIZE 3 /* SAVEt_HV */
483 #define SU_SAVE_HELEM_SIZE 4 /* SAVEt_HELEM */
484 #define SU_SAVE_HDELETE_SIZE 4 /* SAVEt_DELETE */
486 #define SU_SAVE_GVCV_SIZE SU_SAVE_DESTRUCTOR_SIZE
488 /* the overhead of save_alloc() but not including any elements,
489 * of which there must be at least 1 */
490 #if XSH_HAS_PERL(5, 14, 0)
491 # define SU_SAVE_ALLOC_SIZE 1 /* SAVEt_ALLOC */
493 # define SU_SAVE_ALLOC_SIZE 2 /* SAVEt_ALLOC */
497 # define SU_SAVE_ADELETE_SIZE 3 /* SAVEt_ADELETE */
499 # define SU_SAVE_ADELETE_SIZE SU_SAVE_DESTRUCTOR_SIZE
502 /* (NB: it was 4 between 5.13.1 and 5.13.7) */
503 #if XSH_HAS_PERL(5, 8, 9)
504 # define SU_SAVE_GP_SIZE 3 /* SAVEt_GP */
506 # define SU_SAVE_GP_SIZE 6 /* SAVEt_GP */
509 /* sometimes we don't know in advance whether we're saving or deleting
510 * an array/hash element. So include enough room for a variable-sized
511 * save_alloc() to pad it to a fixed size.
514 #if SU_SAVE_AELEM_SIZE < SU_SAVE_ADELETE_SIZE
515 # define SU_SAVE_AELEM_OR_ADELETE_SIZE \
516 (SU_SAVE_ADELETE_SIZE + SU_SAVE_ALLOC_SIZE + 1)
517 #elif SU_SAVE_AELEM_SIZE > SU_SAVE_ADELETE_SIZE
518 # define SU_SAVE_AELEM_OR_ADELETE_SIZE \
519 (SU_SAVE_AELEM_SIZE + SU_SAVE_ALLOC_SIZE + 1)
521 # define SU_SAVE_AELEM_OR_ADELETE_SIZE SU_SAVE_AELEM_SIZE
524 #if SU_SAVE_HELEM_SIZE < SU_SAVE_HDELETE_SIZE
525 # define SU_SAVE_HELEM_OR_HDELETE_SIZE \
526 (SU_SAVE_HDELETE_SIZE + SU_SAVE_ALLOC_SIZE + 1)
527 #elif SU_SAVE_HELEM_SIZE > SU_SAVE_HDELETE_SIZE
528 # define SU_SAVE_HELEM_OR_HDELETE_SIZE \
529 (SU_SAVE_HELEM_SIZE + SU_SAVE_ALLOC_SIZE + 1)
531 # define SU_SAVE_HELEM_OR_HDELETE_SIZE SU_SAVE_HELEM_SIZE
534 #ifndef SvCANEXISTDELETE
535 # define SvCANEXISTDELETE(sv) \
537 || ((mg = mg_find((SV *) sv, PERL_MAGIC_tied)) \
538 && (stash = SvSTASH(SvRV(SvTIED_obj((SV *) sv, mg)))) \
539 && gv_fetchmethod_autoload(stash, "EXISTS", TRUE) \
540 && gv_fetchmethod_autoload(stash, "DELETE", TRUE) \
545 /* ... Saving array elements ............................................... */
547 static I32 su_av_key2idx(pTHX_ AV *av, I32 key) {
548 #define su_av_key2idx(A, K) su_av_key2idx(aTHX_ (A), (K))
554 /* Added by MJD in perl-5.8.1 with 6f12eb6d2a1dfaf441504d869b27d2e40ef4966a */
555 #if XSH_HAS_PERL(5, 8, 1)
556 if (SvRMAGICAL(av)) {
557 const MAGIC * const tied_magic = mg_find((SV *) av, PERL_MAGIC_tied);
559 SV * const * const negative_indices_glob = hv_fetch(
560 SvSTASH(SvRV(SvTIED_obj((SV *) (av), tied_magic))),
561 NEGATIVE_INDICES_VAR, sizeof(NEGATIVE_INDICES_VAR)-1, 0
563 if (negative_indices_glob && SvTRUE(GvSV(*negative_indices_glob)))
569 idx = key + av_len(av) + 1;
583 static void su_adelete(pTHX_ void *ud_) {
584 su_ud_adelete *ud = (su_ud_adelete *) ud_;
586 av_delete(ud->av, ud->idx, G_DISCARD);
587 SvREFCNT_dec(ud->av);
592 static void su_save_adelete(pTHX_ AV *av, I32 idx) {
593 #define su_save_adelete(A, K) su_save_adelete(aTHX_ (A), (K))
596 Newx(ud, 1, su_ud_adelete);
599 SvREFCNT_inc_simple_void(av);
601 SAVEDESTRUCTOR_X(su_adelete, ud);
604 #define SAVEADELETE(A, K) su_save_adelete((A), (K))
606 #endif /* SAVEADELETE */
608 static void su_save_aelem(pTHX_ AV *av, SV *key, SV *val) {
609 #define su_save_aelem(A, K, V) su_save_aelem(aTHX_ (A), (K), (V))
616 idx = su_av_key2idx(av, SvIV(key));
618 if (SvCANEXISTDELETE(av))
619 preeminent = av_exists(av, idx);
621 svp = av_fetch(av, idx, 1);
622 if (!svp || *svp == &PL_sv_undef) croak(PL_no_aelem, idx);
625 save_aelem(av, idx, svp);
627 SAVEADELETE(av, idx);
629 if (val) { /* local $x[$idx] = $val; */
630 SvSetMagicSV(*svp, val);
631 } else { /* local $x[$idx]; delete $x[$idx]; */
632 av_delete(av, idx, G_DISCARD);
636 /* ... Saving hash elements ................................................ */
638 static void su_save_helem(pTHX_ HV *hv, SV *keysv, SV *val) {
639 #define su_save_helem(H, K, V) su_save_helem(aTHX_ (H), (K), (V))
646 if (SvCANEXISTDELETE(hv) || mg_find((SV *) hv, PERL_MAGIC_env))
647 preeminent = hv_exists_ent(hv, keysv, 0);
649 he = hv_fetch_ent(hv, keysv, 1, 0);
650 svp = he ? &HeVAL(he) : NULL;
651 if (!svp || *svp == &PL_sv_undef) croak("Modification of non-creatable hash value attempted, subscript \"%s\"", SvPV_nolen_const(*svp));
653 if (HvNAME_get(hv) && isGV(*svp)) {
654 save_gp((GV *) *svp, 0);
659 save_helem(hv, keysv, svp);
662 const char * const key = SvPV_const(keysv, keylen);
663 SAVEDELETE(hv, savepvn(key, keylen),
664 SvUTF8(keysv) ? -(I32)keylen : (I32)keylen);
667 if (val) { /* local $x{$keysv} = $val; */
668 SvSetMagicSV(*svp, val);
669 } else { /* local $x{$keysv}; delete $x{$keysv}; */
670 (void)hv_delete_ent(hv, keysv, G_DISCARD, HeHASH(he));
674 /* ... Saving code slots from a glob ....................................... */
676 #if !XSH_HAS_PERL(5, 10, 0) && !defined(mro_method_changed_in)
677 # define mro_method_changed_in(G) PL_sub_generation++
685 static void su_restore_gvcv(pTHX_ void *ud_) {
686 su_save_gvcv_ud *ud = ud_;
689 GvCV_set(gv, ud->old_cv);
691 mro_method_changed_in(GvSTASH(gv));
696 static void su_save_gvcv(pTHX_ GV *gv) {
697 #define su_save_gvcv(G) su_save_gvcv(aTHX_ (G))
700 Newx(ud, 1, su_save_gvcv_ud);
702 ud->old_cv = GvCV(gv);
706 mro_method_changed_in(GvSTASH(gv));
708 SAVEDESTRUCTOR_X(su_restore_gvcv, ud);
711 /* --- Actions ------------------------------------------------------------- */
714 I32 orig_ix; /* original savestack_ix */
715 I32 offset; /* how much we bumped this savestack index */
723 su_ud_origin_elem *origin;
726 #define SU_UD_TYPE(U) (((su_ud_common *) (U))->type)
727 #define SU_UD_PRIVATE(U) (((su_ud_common *) (U))->private)
728 #define SU_UD_DEPTH(U) (((su_ud_common *) (U))->depth)
729 #define SU_UD_ORIGIN(U) (((su_ud_common *) (U))->origin)
731 #define SU_UD_TYPE_REAP 0
732 #define SU_UD_TYPE_LOCALIZE 1
733 #define SU_UD_TYPE_UID 2
735 #define SU_UD_FREE(U) STMT_START { \
736 if (SU_UD_ORIGIN(U)) Safefree(SU_UD_ORIGIN(U)); \
740 /* ... Reap ................................................................ */
742 #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))
749 #define SU_UD_REAP_CB(U) (((su_ud_reap *) (U))->cb)
751 static void su_call(pTHX_ SV *cb) {
754 PERL_CONTEXT saved_cx;
755 #endif /* SU_SAVE_LAST_CX */
759 XSH_D(su_debug_log("@@@ call scope_ix=%2d save_ix=%2d\n",
760 PL_scopestack_ix, PL_savestack_ix));
769 /* If the recently popped context isn't saved there, it will be overwritten by
770 * the sub scope from call_sv, although it's still needed in our caller. */
771 cxix = (cxstack_ix < cxstack_max) ? (cxstack_ix + 1) : Perl_cxinc(aTHX);
772 saved_cx = cxstack[cxix];
773 #endif /* SU_SAVE_LAST_CX */
778 cxstack[cxix] = saved_cx;
779 #endif /* SU_SAVE_LAST_CX */
791 /* ... Localize & localize array/hash element .............................. */
800 #define SU_UD_LOCALIZE_SV(U) (((su_ud_localize *) (U))->sv)
801 #define SU_UD_LOCALIZE_VAL(U) (((su_ud_localize *) (U))->val)
802 #define SU_UD_LOCALIZE_ELEM(U) (((su_ud_localize *) (U))->elem)
804 #define SU_UD_LOCALIZE_FREE(U) STMT_START { \
805 SvREFCNT_dec(SU_UD_LOCALIZE_ELEM(U)); \
806 SvREFCNT_dec(SU_UD_LOCALIZE_VAL(U)); \
807 SvREFCNT_dec(SU_UD_LOCALIZE_SV(U)); \
811 static I32 su_ud_localize_init(pTHX_ su_ud_localize *ud, SV *sv, SV *val, SV *elem) {
812 #define su_ud_localize_init(UD, S, V, E) su_ud_localize_init(aTHX_ (UD), (S), (V), (E))
817 SvREFCNT_inc_simple_void(sv);
819 if (SvTYPE(sv) >= SVt_PVGV) {
820 if (!val || !SvROK(val)) { /* local *x; or local *x = $val; */
822 } else { /* local *x = \$val; */
823 t = SvTYPE(SvRV(val));
826 } else if (SvROK(sv)) {
827 croak("Invalid %s reference as the localization target",
828 sv_reftype(SvRV(sv), 0));
831 const char *p = SvPV_const(sv, len), *s;
832 for (s = p, l = len; l > 0 && isSPACE(*s); ++s, --l) { }
838 case '$': t = SVt_PV; break;
839 case '@': t = SVt_PVAV; break;
840 case '%': t = SVt_PVHV; break;
841 case '&': t = SVt_PVCV; break;
842 case '*': t = SVt_PVGV; break;
847 } else if (val) { /* t == SVt_NULL, type can't be inferred from the sigil */
848 if (SvROK(val) && !sv_isobject(val)) {
849 t = SvTYPE(SvRV(val));
861 size = elem ? SU_SAVE_AELEM_OR_ADELETE_SIZE
866 size = elem ? SU_SAVE_HELEM_OR_HDELETE_SIZE
871 size = SU_SAVE_GP_SIZE;
875 size = SU_SAVE_GVCV_SIZE;
879 size = SU_SAVE_SCALAR_SIZE;
882 /* When deref is set, val isn't NULL */
884 SU_UD_PRIVATE(ud) = t;
887 ud->val = val ? newSVsv(deref ? SvRV(val) : val) : NULL;
888 ud->elem = SvREFCNT_inc(elem);
893 static void su_localize(pTHX_ void *ud_) {
894 #define su_localize(U) su_localize(aTHX_ (U))
895 su_ud_localize *ud = (su_ud_localize *) ud_;
899 svtype t = SU_UD_PRIVATE(ud);
902 if (SvTYPE(sv) >= SVt_PVGV) {
906 /* new perl context implementation frees savestack *before* restoring
907 * PL_curcop. Temporarily restore it prematurely to make gv_fetch*
908 * looks up unqualified var names in the caller's package */
909 #ifdef SU_HAS_NEW_CXT
910 COP *old_cop = PL_curcop;
911 PL_curcop = CX_CUR()->blk_oldcop;
915 gv = gv_fetchsv(sv, GV_ADDMULTI, t);
918 const char *name = SvPV_const(sv, len);
919 gv = gv_fetchpvn_flags(name, len, GV_ADDMULTI, t);
921 #ifdef SU_HAS_NEW_CXT
922 CX_CUR()->blk_oldcop = PL_curcop;
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);
946 su_save_helem(GvHV(gv), elem, val);
952 save_gp(gv, 1); /* hide previous entry in symtab */
958 gv = (GV *) save_scalar(gv);
963 SvSetMagicSV((SV *) gv, val);
968 /* ... Unique context ID ................................................... */
970 /* We must pass the index because XSH_CXT.uid_storage might be reallocated
971 * between the UID fetch and the invalidation at the end of scope. */
978 static void su_uid_drop(pTHX_ void *ud_) {
982 XSH_CXT.uid_storage.map[ud->idx].flags &= ~SU_UID_ACTIVE;
989 /* --- Pop a context back -------------------------------------------------- */
992 # define SU_CX_TYPENAME(T) PL_block_type[(T)]
994 # if XSH_HAS_PERL(5, 23, 8)
995 static const char *su_block_type[] = {
1010 # elif XSH_HAS_PERL(5, 11, 0)
1011 static const char *su_block_type[] = {
1025 # elif XSH_HAS_PERL(5, 10, 0)
1026 static const char *su_block_type[] = {
1038 static const char *su_block_type[] = {
1048 # define SU_CX_TYPENAME(T) su_block_type[(T)]
1051 #define SU_CXNAME(C) SU_CX_TYPENAME(CxTYPE(C))
1053 /* for debugging. These indicate how many ENTERs each context type
1054 * does before the PUSHBLOCK */
1056 static const int su_cxt_enter_count[] = {
1057 # if XSH_HAS_PERL(5, 23, 8)
1058 0 /* context pushes no longer do ENTERs */
1059 # elif XSH_HAS_PERL(5, 11, 0)
1060 /* NULL WHEN BLOCK GIVEN LOOP_FOR LOOP_PLAIN LOOP_LAZYSV
1061 * LOOP_LAZYIV SUB FORMAT EVAL SUBST */
1062 0, 1, 1, 1, 2, 2, 2, 2, 1, 1, 1, 0
1063 # elif XSH_HAS_PERL(5, 10, 0)
1064 /* NULL SUB EVAL LOOP SUBST BLOCK FORMAT WHEN GIVEN */
1065 0, 1, 1, 2, 0, 1, 1, 1, 1
1067 /* NULL SUB EVAL LOOP SUBST BLOCK FORMAT */
1072 /* push at least 'size' slots worth of padding onto the savestack */
1074 static void su_ss_push_padding(pTHX_ void *ud, I32 size) {
1077 if (size < SU_SAVE_ALLOC_SIZE + 1) /* minimum possible SAVEt_ALLOC */
1078 size = SU_SAVE_ALLOC_SIZE + 1;
1080 "%p: push %2d padding at save_ix=%d\n",
1081 ud, size, PL_savestack_ix));
1082 save_alloc((size - SU_SAVE_ALLOC_SIZE)*sizeof(*PL_savestack), 0);
1085 static void su_pop(pTHX_ void *ud);
1087 /* push an su_pop destructor onto the savestack with suitable padding.
1088 * first indicates that this is the first push of a destructor */
1090 static void su_ss_push_destructor(pTHX_ void *ud, I32 depth, bool first) {
1091 su_ud_origin_elem *origin = SU_UD_ORIGIN(ud);
1094 assert(first || origin[depth+1].orig_ix == PL_savestack_ix);
1095 su_ss_push_padding(aTHX_ ud,
1096 (origin[depth].orig_ix + origin[depth].offset) - PL_savestack_ix);
1098 "%p: push destructor at save_ix=%d depth=%d scope_ix=%d\n",
1099 ud, PL_savestack_ix, depth, PL_scopestack_ix));
1100 SAVEDESTRUCTOR_X(su_pop, ud);
1102 PL_savestack_ix <= origin[depth+1].orig_ix + origin[depth+1].offset);
1105 /* this is called during each leave_scope() via SAVEDESTRUCTOR_X */
1107 static void su_pop(pTHX_ void *ud) {
1108 #define su_pop(U) su_pop(aTHX_ (U))
1109 I32 depth, base, mark;
1110 su_ud_origin_elem *origin;
1112 depth = SU_UD_DEPTH(ud);
1113 origin = SU_UD_ORIGIN(ud);
1115 XSH_D(su_debug_log( "%p: ### su_pop: depth=%d\n", ud, depth));
1118 mark = PL_savestack_ix;
1119 base = origin[depth].orig_ix;
1121 XSH_D(su_debug_log("%p: residual savestack frame is %d(+%d)..%d\n",
1122 ud, base, origin[depth].offset, mark));
1125 XSH_D(su_debug_log("%p: clear leftovers at %d..%d\n", ud, base, mark));
1128 assert(PL_savestack_ix == base);
1130 SU_UD_DEPTH(ud) = depth;
1133 su_ss_push_destructor(aTHX_ ud, depth-1, 0);
1135 I32 offset = origin[0].offset; /* grab value before origin is freed */
1136 switch (SU_UD_TYPE(ud)) {
1137 case SU_UD_TYPE_REAP: {
1138 XSH_D(su_debug_log("%p: === reap\n%p: depth=%d scope_ix=%d save_ix=%d\n",
1139 ud, ud, SU_UD_DEPTH(ud), PL_scopestack_ix, PL_savestack_ix));
1140 SAVEDESTRUCTOR_X(su_call, SU_UD_REAP_CB(ud));
1144 case SU_UD_TYPE_LOCALIZE:
1146 SU_UD_LOCALIZE_FREE(ud);
1148 case SU_UD_TYPE_UID:
1149 SAVEDESTRUCTOR_X(su_uid_drop, ud);
1152 /* perl 5.23.8 onwards is very fussy about the return from leave_scope()
1153 * leaving PL_savestack_ix where it expects it to be */
1154 if (PL_savestack_ix < base + offset) {
1155 I32 gap = (base + offset) - PL_savestack_ix;
1156 assert(gap >= SU_SAVE_ALLOC_SIZE + 1);
1157 su_ss_push_padding(aTHX_ ud, gap);
1159 assert(PL_savestack_ix == base + offset);
1162 XSH_D(su_debug_log("%p: end pop: ss_ix=%d\n", ud, PL_savestack_ix));
1165 /* --- Initialize the stack and the action userdata ------------------------ */
1167 static void su_init(pTHX_ void *ud, I32 cxix, I32 size) {
1168 #define su_init(U, C, S) su_init(aTHX_ (U), (C), (S))
1170 su_ud_origin_elem *origin;
1174 XSH_D(su_debug_log("%p: ### su_init(cxix=%d, size=%d)\n", ud, cxix, size));
1176 depth = PL_scopestack_ix - cxstack[cxix].blk_oldscopesp;
1177 #ifdef SU_HAS_NEW_CXT
1178 depth += (cxstack_ix - cxix); /* each context frame holds 1 scope */
1181 "%p: going down by depth=%d with scope_ix=%d save_ix=%d\n",
1182 ud, depth, PL_scopestack_ix, PL_savestack_ix));
1184 /* Artificially increase the position of each savestack frame boundary
1185 * to make space to squeeze in a 'size' sized entry (first one) or a
1186 * SU_SAVE_DESTRUCTOR_SIZE sized entry (higher ones). In addition, make
1187 * sure that each boundary is higher than the previous, so that *every*
1188 * scope exit triggers a call to leave_scope(). Each scope exit will call
1189 * the su_pop() destructor, which is responsible for: freeing any
1190 * savestack entries below the artificially raised floor; then pushing a
1191 * new destructor in that space. On the final pop, the "real" savestack
1192 * action is pushed rather than another destructor.
1194 * On older perls, savestack frame boundaries are specified by a range of
1195 * scopestack entries (one per ENTER). Each scope entry typically does
1196 * one or two ENTERs followed by a PUSHBLOCK. Thus the
1197 * cx->blku_oldscopesp field set by the PUSHBLOCK points to the next free
1198 * slot, which is one above the last of the ENTERs. In the debugging
1199 * output we indicate that by bracketing the ENTERs directly preceding
1200 * that context push with dashes, e.g.:
1202 * 13b98d8: ------------------
1203 * 13b98d8: ENTER origin[0] scope[3] savestack=3+3
1204 * 13b98d8: ENTER origin[1] scope[4] savestack=9+3
1205 * 13b98d8: cx=1 LOOP_LAZYIV
1206 * 13b98d8: ------------------
1208 * In addition to context stack pushes, other activities can push ENTERs
1209 * too, such as grep expr and XS sub calls.
1211 * For newer perls (SU_HAS_NEW_CXT), a context push no longer does any
1212 * ENTERs; instead the old savestack position is stored in the new
1213 * cx->blk_oldsaveix field; thus this field specifies an additional
1214 * savestack frame boundary point in addition to the scopestack entries,
1215 * and will also need adjusting.
1217 * We record the original and modified position of each boundary in the
1220 * The passed cxix argument represents the scope we wish to inject into;
1221 * we have to adjust all the savestack frame boundaries above (but not
1222 * including) that context.
1225 Newx(origin, depth, su_ud_origin_elem);
1228 cur_scope_ix = cxstack[cxix].blk_oldscopesp;
1229 #ifdef SU_HAS_NEW_CXT
1230 XSH_D(su_debug_log("%p: cx=%-2d %-11s\n",
1231 ud, cur_cx_ix, SU_CXNAME(cxstack+cur_cx_ix)));
1235 for (i = 0; cur_scope_ix < PL_scopestack_ix; i++) {
1239 #ifdef SU_HAS_NEW_CXT
1241 if ( cur_cx_ix <= cxstack_ix
1242 && cur_scope_ix == cxstack[cur_cx_ix].blk_oldscopesp
1244 ixp = &(cxstack[cur_cx_ix++].blk_oldsaveix);
1246 ixp = &PL_scopestack[cur_scope_ix++]; /* an ENTER pushed after cur context */
1251 if (cur_cx_ix <= cxstack_ix) {
1252 if (cur_scope_ix == cxstack[cur_cx_ix].blk_oldscopesp) {
1254 "%p: cx=%-2d %s\n%p: ------------------\n",
1255 ud, cur_cx_ix, SU_CXNAME(cxstack+cur_cx_ix), ud);
1258 else if (cur_scope_ix + su_cxt_enter_count[CxTYPE(cxstack+cur_cx_ix)]
1259 == cxstack[cur_cx_ix].blk_oldscopesp)
1260 su_debug_log("%p: ------------------\n", ud);
1263 ixp = &PL_scopestack[cur_scope_ix++];
1270 /* we have three constraints to satisfy:
1271 * 1) Each adjusted offset must be at least SU_SAVE_DESTRUCTOR_SIZE
1272 * above its unadjusted boundary, so that there is space to inject a
1273 * destructor into the outer scope.
1274 * 2) Each adjusted boundary must be at least SU_SAVE_DESTRUCTOR_SIZE
1275 * higher than the previous adjusted boundary, so that a new
1276 * destructor can be added below the Nth adjusted frame boundary,
1277 * but be within the (N-1)th adjusted frame and so be triggered on
1278 * the next scope exit;
1279 * 3) If the adjustment needs to be greater than SU_SAVE_DESTRUCTOR_SIZE,
1280 * then it should be greater by an amount of at least the minimum
1281 * pad side, so a destructor and padding can be pushed.
1284 offset = SU_SAVE_DESTRUCTOR_SIZE; /* rule 1 */
1285 pad = (origin[i-1].orig_ix + origin[i-1].offset) + offset - (*ixp + offset);
1286 if (pad > 0) { /* rule 2 */
1287 if (pad < SU_SAVE_ALLOC_SIZE + 1) /* rule 3 */
1288 pad = SU_SAVE_ALLOC_SIZE + 1;
1293 origin[i].offset = offset;
1294 origin[i].orig_ix = *ixp;
1297 #ifdef SU_HAS_NEW_CXT
1299 if (ixp == &PL_scopestack[cur_scope_ix-1])
1301 "%p: ENTER origin[%d] scope[%d] savestack=%d+%d\n",
1302 ud, i, cur_scope_ix, origin[i].orig_ix, origin[i].offset);
1305 "%p: cx=%-2d %-11s origin[%d] scope[%d] savestack=%d+%d\n",
1306 ud, cur_cx_ix-1, SU_CXNAME(cxstack+cur_cx_ix-1),
1307 i, cur_scope_ix, origin[i].orig_ix, origin[i].offset);
1311 "%p: ENTER origin[%d] scope[%d] savestack=%d+%d\n",
1312 ud, i, cur_scope_ix, origin[i].orig_ix, origin[i].offset));
1319 SU_UD_DEPTH(ud) = depth;
1320 SU_UD_ORIGIN(ud) = origin;
1322 su_ss_push_destructor(aTHX_ ud, depth-1, 1);
1325 /* --- Unwind stack -------------------------------------------------------- */
1327 static void su_unwind(pTHX_ void *ud_) {
1329 I32 cxix = XSH_CXT.unwind_storage.cxix;
1330 I32 items = XSH_CXT.unwind_storage.items;
1333 PERL_UNUSED_VAR(ud_);
1335 PL_stack_sp = XSH_CXT.unwind_storage.savesp;
1336 #if XSH_HAS_PERL(5, 19, 4)
1339 SV **sp = PL_stack_sp;
1340 for (i = -items + 1; i <= 0; ++i)
1342 sv_2mortal(SvREFCNT_inc(sp[i]));
1346 if (cxstack_ix > cxix)
1349 mark = PL_markstack[cxstack[cxix].blk_oldmarksp];
1350 PUSHMARK(PL_stack_sp - items);
1353 I32 gimme = GIMME_V;
1354 su_debug_log("%p: cx=%d gimme=%s items=%d sp=%d oldmark=%d mark=%d\n",
1356 gimme == G_VOID ? "void" : gimme == G_ARRAY ? "list" : "scalar",
1357 items, PL_stack_sp - PL_stack_base, *PL_markstack_ptr, mark);
1360 PL_op = (OP *) &(XSH_CXT.unwind_storage.return_op);
1361 PL_op = PL_op->op_ppaddr(aTHX);
1363 *PL_markstack_ptr = mark;
1365 XSH_CXT.unwind_storage.proxy_op.op_next = PL_op;
1366 PL_op = &(XSH_CXT.unwind_storage.proxy_op);
1369 /* --- Yield --------------------------------------------------------------- */
1371 #if XSH_HAS_PERL(5, 10, 0)
1372 # define SU_RETOP_SUB(C) ((C)->blk_sub.retop)
1373 # define SU_RETOP_EVAL(C) ((C)->blk_eval.retop)
1374 # define SU_RETOP_LOOP(C) ((C)->blk_loop.my_op->op_lastop->op_next)
1375 # define SU_RETOP_GIVEN(C) ((C)->blk_givwhen.leave_op->op_next)
1377 # define SU_RETOP_SUB(C) ((C)->blk_oldretsp > 0 ? PL_retstack[(C)->blk_oldretsp - 1] : NULL)
1378 # define SU_RETOP_EVAL(C) SU_RETOP_SUB(C)
1379 # define SU_RETOP_LOOP(C) ((C)->blk_loop.last_op->op_next)
1382 static void su_yield(pTHX_ void *ud_) {
1385 const char *which = ud_;
1386 I32 cxix = XSH_CXT.yield_storage.cxix;
1387 I32 items = XSH_CXT.yield_storage.items;
1388 opcode type = OP_NULL;
1392 PERL_UNUSED_VAR(ud_);
1394 cx = cxstack + cxix;
1395 switch (CxTYPE(cx)) {
1397 I32 i, cur = cxstack_ix, n = 1;
1399 /* Is this actually a given/when block? This may occur only when yield was
1400 * called with HERE (or nothing) as the context. */
1401 #if XSH_HAS_PERL(5, 10, 0)
1403 PERL_CONTEXT *prev = cx - 1;
1404 U8 prev_type = CxTYPE(prev);
1405 if ((prev_type == CXt_GIVEN || prev_type == CXt_WHEN)
1406 && (prev->blk_oldcop == cx->blk_oldcop)) {
1409 if (prev_type == CXt_GIVEN)
1418 /* Bare blocks (that appear as do { ... } blocks, map { ... } blocks or
1419 * constant folded blcoks) don't need to save the op to return to anywhere
1420 * since 'last' isn't supposed to work inside them. So we climb higher in
1421 * the context stack until we reach a context that has a return op (i.e. a
1422 * sub, an eval, a format or a real loop), recording how many blocks we
1423 * crossed. Then we follow the op_next chain until we get to the leave op
1424 * that closes the original block, which we are assured to reach since
1425 * everything is static (the blocks we have crossed cannot be evals or
1426 * subroutine calls). */
1427 for (i = cxix + 1; i <= cur; ++i) {
1428 PERL_CONTEXT *cx2 = cxstack + i;
1429 switch (CxTYPE(cx2)) {
1435 o = SU_RETOP_SUB(cx2);
1438 o = SU_RETOP_EVAL(cx2);
1440 #if XSH_HAS_PERL(5, 11, 0)
1441 # if XSH_HAS_PERL(5, 23, 8)
1447 case CXt_LOOP_PLAIN:
1448 case CXt_LOOP_LAZYSV:
1449 case CXt_LOOP_LAZYIV:
1453 o = SU_RETOP_LOOP(cx2);
1462 /* We may find other enter/leave blocks on our way to the matching leave.
1463 * Make sure the depth is incremented/decremented appropriately. */
1464 if (o->op_type == OP_ENTER) {
1466 } else if (o->op_type == OP_LEAVE) {
1480 next = SU_RETOP_SUB(cx);
1483 type = CxTRYBLOCK(cx) ? OP_LEAVETRY : OP_LEAVEEVAL;
1484 next = SU_RETOP_EVAL(cx);
1486 #if XSH_HAS_PERL(5, 11, 0)
1487 # if XSH_HAS_PERL(5, 23, 8)
1493 case CXt_LOOP_PLAIN:
1494 case CXt_LOOP_LAZYSV:
1495 case CXt_LOOP_LAZYIV:
1499 type = OP_LEAVELOOP;
1500 next = SU_RETOP_LOOP(cx);
1502 #if XSH_HAS_PERL(5, 10, 0)
1505 type = OP_LEAVEGIVEN;
1506 next = SU_RETOP_GIVEN(cx);
1510 #if XSH_HAS_PERL(5, 15, 1)
1511 type = OP_LEAVEWHEN;
1514 flags |= OPf_SPECIAL;
1520 croak("%s() can't target a substitution context", which);
1523 croak("%s() doesn't know how to leave a %s context",
1524 which, SU_CXNAME(cxstack + cxix));
1528 PL_stack_sp = XSH_CXT.yield_storage.savesp;
1529 #if XSH_HAS_PERL(5, 19, 4)
1532 SV **sp = PL_stack_sp;
1533 for (i = -items + 1; i <= 0; ++i)
1535 sv_2mortal(SvREFCNT_inc(sp[i]));
1539 if (cxstack_ix > cxix)
1542 /* Copy the arguments passed to yield() where the leave op expects to find
1545 Move(PL_stack_sp - items + 1, PL_stack_base + cx->blk_oldsp + 1, items, SV *);
1546 PL_stack_sp = PL_stack_base + cx->blk_oldsp + items;
1548 flags |= OP_GIMME_REVERSE(cx->blk_gimme);
1550 XSH_CXT.yield_storage.leave_op.op_type = type;
1551 XSH_CXT.yield_storage.leave_op.op_ppaddr = PL_ppaddr[type];
1552 XSH_CXT.yield_storage.leave_op.op_flags = flags;
1553 XSH_CXT.yield_storage.leave_op.op_next = next;
1555 PL_op = (OP *) &(XSH_CXT.yield_storage.leave_op);
1556 PL_op = PL_op->op_ppaddr(aTHX);
1558 XSH_CXT.yield_storage.proxy_op.op_next = PL_op;
1559 PL_op = &(XSH_CXT.yield_storage.proxy_op);
1562 /* --- Uplevel ------------------------------------------------------------- */
1564 #define SU_UPLEVEL_SAVE(f, t) STMT_START { sud->old_##f = PL_##f; PL_##f = (t); } STMT_END
1565 #define SU_UPLEVEL_RESTORE(f) STMT_START { PL_##f = sud->old_##f; } STMT_END
1567 static su_uplevel_ud *su_uplevel_storage_new(pTHX_ I32 cxix) {
1568 #define su_uplevel_storage_new(I) su_uplevel_storage_new(aTHX_ (I))
1573 sud = XSH_CXT.uplevel_storage.root;
1575 XSH_CXT.uplevel_storage.root = sud->next;
1576 XSH_CXT.uplevel_storage.count--;
1578 sud = su_uplevel_ud_new();
1581 sud->next = XSH_CXT.uplevel_storage.top;
1582 XSH_CXT.uplevel_storage.top = sud;
1584 depth = su_uid_depth(cxix);
1585 su_uid_storage_dup(&sud->tmp_uid_storage, &XSH_CXT.uid_storage, depth);
1586 sud->old_uid_storage = XSH_CXT.uid_storage;
1587 XSH_CXT.uid_storage = sud->tmp_uid_storage;
1592 #if XSH_HAS_PERL(5, 13, 7)
1594 static void su_uplevel_storage_delete(pTHX_ su_uplevel_ud *sud) {
1595 #define su_uplevel_storage_delete(S) su_uplevel_storage_delete(aTHX_ (S))
1598 sud->tmp_uid_storage = XSH_CXT.uid_storage;
1599 XSH_CXT.uid_storage = sud->old_uid_storage;
1603 map = sud->tmp_uid_storage.map;
1604 alloc = sud->tmp_uid_storage.alloc;
1605 for (i = 0; i < alloc; ++i)
1606 map[i].flags &= ~SU_UID_ACTIVE;
1608 XSH_CXT.uplevel_storage.top = sud->next;
1610 if (XSH_CXT.uplevel_storage.count >= SU_UPLEVEL_STORAGE_SIZE) {
1611 su_uplevel_ud_delete(sud);
1613 sud->next = XSH_CXT.uplevel_storage.root;
1614 XSH_CXT.uplevel_storage.root = sud;
1615 XSH_CXT.uplevel_storage.count++;
1621 static int su_uplevel_goto_static(const OP *o) {
1622 for (; o; o = OpSIBLING(o)) {
1623 /* goto ops are unops with kids. */
1624 if (!(o->op_flags & OPf_KIDS))
1627 switch (o->op_type) {
1630 /* Don't care about gotos inside eval, as they are forbidden at run time. */
1635 if (su_uplevel_goto_static(((const UNOP *) o)->op_first))
1644 #if !defined(SU_HAS_NEW_CXT) && SU_UPLEVEL_HIJACKS_RUNOPS
1646 static int su_uplevel_goto_runops(pTHX) {
1647 #define su_uplevel_goto_runops() su_uplevel_goto_runops(aTHX)
1653 if (op->op_type == OP_GOTO) {
1654 AV *argarray = NULL;
1657 for (cxix = cxstack_ix; cxix >= 0; --cxix) {
1658 const PERL_CONTEXT *cx = cxstack + cxix;
1660 switch (CxTYPE(cx)) {
1662 if (CxHASARGS(cx)) {
1663 argarray = cx->blk_sub.argarray;
1679 if (XSH_CXT.uplevel_storage.top->cxix == cxix) {
1680 AV *args = GvAV(PL_defgv);
1681 I32 items = AvFILLp(args);
1683 av_extend(argarray, items);
1684 Copy(AvARRAY(args), AvARRAY(argarray), items + 1, SV *);
1685 AvFILLp(argarray) = items;
1690 PL_op = op = op->op_ppaddr(aTHX);
1692 #if !XSH_HAS_PERL(5, 13, 0)
1702 #endif /* SU_UPLEVEL_HIJACKS_RUNOPS */
1704 #define su_at_underscore(C) PadARRAY(PadlistARRAY(CvPADLIST(C))[CvDEPTH(C)])[0]
1706 #ifdef SU_HAS_NEW_CXT
1708 static void su_uplevel_restore_new(pTHX_ void *sus_) {
1709 su_uplevel_ud *sud = sus_;
1712 U8 *saved_cxtypes = sud->cxtypes;
1714 for (i = 0; i < sud->gap; i++) {
1715 PERL_CONTEXT *cx = cxstack + sud->cxix + i;
1716 XSH_D(su_debug_log("su_uplevel_restore: i=%d cxix=%d type %s => %s\n",
1717 i, cx-cxstack, SU_CX_TYPENAME(CxTYPE(cx)),
1718 SU_CX_TYPENAME(saved_cxtypes[i] & CXTYPEMASK)));
1719 cx->cx_type = saved_cxtypes[i];
1721 Safefree(saved_cxtypes);
1723 /* renamed is a copy of callback, but they share the same CvPADLIST.
1724 * At this point any calls to renamed should have exited so that its
1725 * depth is back to that of of callback. At this point its safe to free
1726 * renamed, then undo the extra ref count that was ensuring that callback
1729 assert(sud->renamed);
1730 assert(sud->callback);
1732 CvDEPTH(sud->callback)--;
1733 assert(CvDEPTH(sud->callback) == CvDEPTH(sud->renamed));
1734 if (!CvISXSUB(sud->renamed)) {
1735 CvDEPTH(sud->renamed) = 0;
1736 CvPADLIST(sud->renamed) = NULL;
1738 SvREFCNT_dec(sud->renamed);
1739 SvREFCNT_dec(sud->callback);
1741 SU_UPLEVEL_RESTORE(curcop);
1743 su_uplevel_storage_delete(sud);
1750 /* 5.23.7 and earlier */
1752 static void su_uplevel_restore_old(pTHX_ void *sus_) {
1753 su_uplevel_ud *sud = sus_;
1754 PERL_SI *cur = sud->old_curstackinfo;
1755 PERL_SI *si = sud->si;
1757 #if SU_UPLEVEL_HIJACKS_RUNOPS
1758 if (PL_runops == su_uplevel_goto_runops)
1759 PL_runops = sud->old_runops;
1762 if (sud->callback) {
1763 PERL_CONTEXT *cx = cxstack + sud->cxix;
1764 AV *argarray = MUTABLE_AV(su_at_underscore(sud->callback));
1766 /* We have to fix the pad entry for @_ in the original callback because it
1767 * may have been reified. */
1768 if (AvREAL(argarray)) {
1769 const I32 fill = AvFILLp(argarray);
1770 SvREFCNT_dec(argarray);
1772 AvREAL_off(argarray);
1773 AvREIFY_on(argarray);
1774 av_extend(argarray, fill);
1775 su_at_underscore(sud->callback) = MUTABLE_SV(argarray);
1777 CLEAR_ARGARRAY(argarray);
1780 /* If the old cv member is our renamed CV, it means that this place has been
1781 * reached without a goto() happening, and the old argarray member is
1782 * actually our fake argarray. Destroy it properly in that case. */
1783 if (cx->blk_sub.cv == sud->renamed) {
1784 SvREFCNT_dec(cx->blk_sub.argarray);
1785 cx->blk_sub.argarray = argarray;
1788 CvDEPTH(sud->callback)--;
1789 SvREFCNT_dec(sud->callback);
1792 /* Free the renamed CV. We must do it ourselves so that we can force the
1793 * depth to be 0, or perl would complain about it being "still in use".
1794 * But we *know* that it cannot be so. */
1796 if (!CvISXSUB(sud->renamed)) {
1797 CvDEPTH(sud->renamed) = 0;
1798 CvPADLIST(sud->renamed) = NULL;
1800 SvREFCNT_dec(sud->renamed);
1803 CATCH_SET(sud->old_catch);
1805 SU_UPLEVEL_RESTORE(op);
1807 /* stack_grow() wants PL_curstack so restore the old stack first */
1808 if (PL_curstackinfo == si) {
1809 PL_curstack = cur->si_stack;
1810 if (sud->old_mainstack)
1811 SU_UPLEVEL_RESTORE(mainstack);
1812 SU_UPLEVEL_RESTORE(curstackinfo);
1815 CV *target = sud->target;
1818 /* When we die, the depth of the target CV is not updated because of the
1819 * stack switcheroo. So we have to look at all the frames between the
1820 * uplevel call and the catch block to count how many call frames to the
1821 * target CV were skipped. */
1822 for (i = cur->si_cxix; i > sud->cxix; i--) {
1823 register const PERL_CONTEXT *cx = cxstack + i;
1825 if (CxTYPE(cx) == CXt_SUB) {
1826 if (cx->blk_sub.cv == target)
1831 /* If we died, the replacement stack was already unwinded to the first
1832 * eval frame, and all the contexts down there were popped. We don't have
1833 * to pop manually any context of the original stack, because they must
1834 * have been in the replacement stack as well (since the second was copied
1835 * from the first). Thus we only have to make sure the original stack index
1836 * points to the context just below the first eval scope under the target
1838 for (; i >= 0; i--) {
1839 register const PERL_CONTEXT *cx = cxstack + i;
1841 switch (CxTYPE(cx)) {
1843 if (cx->blk_sub.cv == target)
1855 CvDEPTH(target) = sud->target_depth - levels;
1856 PL_curstackinfo->si_cxix = i - 1;
1858 #if !XSH_HAS_PERL(5, 13, 1)
1859 /* Since $@ was maybe localized between the target frame and the uplevel
1860 * call, we forcefully flush the save stack to get rid of it and then
1861 * reset $@ to its proper value. Note that the the call to
1862 * su_uplevel_restore() must happen before the "reset $@" item of the save
1863 * stack is processed, as uplevel was called after the localization.
1864 * Andrew's changes to how $@ was handled, which were mainly integrated
1865 * between perl 5.13.0 and 5.13.1, fixed this. */
1866 if (ERRSV && SvTRUE(ERRSV)) {
1867 register const PERL_CONTEXT *cx = cxstack + i; /* This is the eval scope */
1868 SV *errsv = SvREFCNT_inc(ERRSV);
1869 PL_scopestack_ix = cx->blk_oldscopesp;
1870 leave_scope(PL_scopestack[PL_scopestack_ix]);
1871 sv_setsv(ERRSV, errsv);
1872 SvREFCNT_dec(errsv);
1878 SU_UPLEVEL_RESTORE(curcop);
1880 SvREFCNT_dec(sud->target);
1882 PL_stack_base = AvARRAY(cur->si_stack);
1883 PL_stack_sp = PL_stack_base + AvFILLp(cur->si_stack);
1884 PL_stack_max = PL_stack_base + AvMAX(cur->si_stack);
1886 /* When an exception is thrown from the uplevel'd subroutine,
1887 * su_uplevel_restore() may be called by the LEAVE in die_unwind() (renamed
1888 * die_where() in more recent perls), which has the sad habit of keeping a
1889 * pointer to the current context frame across this call. This means that we
1890 * can't free the temporary context stack we used for the uplevel call right
1891 * now, or that pointer upwards would point to garbage. */
1892 #if XSH_HAS_PERL(5, 13, 7)
1893 /* This issue has been fixed in perl with commit 8f89e5a9, which was made
1894 * public in perl 5.13.7. */
1895 su_uplevel_storage_delete(sud);
1897 /* Otherwise, we just enqueue it back in the global storage list. */
1901 sud->tmp_uid_storage = XSH_CXT.uid_storage;
1902 XSH_CXT.uid_storage = sud->old_uid_storage;
1904 XSH_CXT.uplevel_storage.top = sud->next;
1905 sud->next = XSH_CXT.uplevel_storage.root;
1906 XSH_CXT.uplevel_storage.root = sud;
1907 XSH_CXT.uplevel_storage.count++;
1916 static CV *su_cv_clone(pTHX_ CV *proto, GV *gv) {
1917 #define su_cv_clone(P, G) su_cv_clone(aTHX_ (P), (G))
1921 cv = MUTABLE_CV(newSV_type(SvTYPE(proto)));
1923 CvFLAGS(cv) = CvFLAGS(proto);
1925 CvFLAGS(cv) &= ~CVf_CVGV_RC;
1927 CvDEPTH(cv) = CvDEPTH(proto);
1929 CvFILE(cv) = CvISXSUB(proto) ? CvFILE(proto) : savepv(CvFILE(proto));
1931 CvFILE(cv) = CvFILE(proto);
1935 #if SU_RELEASE && XSH_HAS_PERL_EXACT(5, 21, 4)
1938 CvSTASH_set(cv, CvSTASH(proto));
1939 /* Commit 4c74a7df, publicized with perl 5.13.3, began to add backrefs to
1940 * stashes. CvSTASH_set() started to do it as well with commit c68d95645
1941 * (which was part of perl 5.13.7). */
1942 #if XSH_HAS_PERL(5, 13, 3) && !XSH_HAS_PERL(5, 13, 7)
1944 Perl_sv_add_backref(aTHX_ CvSTASH(proto), MUTABLE_SV(cv));
1947 if (CvISXSUB(proto)) {
1948 CvXSUB(cv) = CvXSUB(proto);
1949 CvXSUBANY(cv) = CvXSUBANY(proto);
1952 CvROOT(cv) = OpREFCNT_inc(CvROOT(proto));
1954 CvSTART(cv) = CvSTART(proto);
1955 CvPADLIST(cv) = CvPADLIST(proto);
1957 CvOUTSIDE(cv) = CvOUTSIDE(proto);
1958 #ifdef CVf_WEAKOUTSIDE
1959 if (!(CvFLAGS(proto) & CVf_WEAKOUTSIDE))
1961 SvREFCNT_inc_simple_void(CvOUTSIDE(cv));
1962 #ifdef CvOUTSIDE_SEQ
1963 CvOUTSIDE_SEQ(cv) = CvOUTSIDE_SEQ(proto);
1967 sv_setpvn(MUTABLE_SV(cv), SvPVX_const(proto), SvCUR(proto));
1977 #ifdef SU_HAS_NEW_CXT
1979 /* this one-shot runops "loop" is designed to be called just before
1980 * execution of the first op following an uplevel()'s entersub. It gets a
1981 * chance to fix up the args as seen by caller(), before immediately
1982 * falling through to the previous runops loop. Note that pp_entersub is
1983 * called directly by call_sv() rather than being called from a runops
1987 static int su_uplevel_runops_hook_entersub(pTHX) {
1990 su_uplevel_ud *sud = XSH_CXT.uplevel_storage.top;
1992 /* Create a new array containing a copy of the original sub's call args,
1993 * then stick it in PL_curpad[0] of the current running sub so that
1994 * thay will be seen by caller().
1997 if (sud->argarray) {
2001 av_extend(av, AvMAX(sud->argarray));
2002 AvFILLp(av) = AvFILLp(sud->argarray);
2003 Copy(AvARRAY(sud->argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
2005 /* should be referenced by PL_curpad[0] and *_ */
2006 assert(SvREFCNT(PL_curpad[0]) > 1);
2007 SvREFCNT_dec(PL_curpad[0]);
2009 PL_curpad[0] = (SV*)av;
2012 /* undo the temporary runops hook and fall through to a real runops loop. */
2013 assert(sud->old_runops != su_uplevel_runops_hook_entersub);
2014 PL_runops = sud->old_runops;
2019 static I32 su_uplevel_new(pTHX_ CV *callback, I32 cxix, I32 args) {
2024 CV *base_cv = cxstack[cxix].blk_sub.cv;
2027 assert(CxTYPE(&cxstack[cxix]) == CXt_SUB);
2033 /* At this point SP points to the top arg.
2034 * Shuffle the args down by one, eliminating the CV slot */
2035 Move(SP - args + 1, SP - args, args, SV*);
2037 PUSHMARK(SP - args);
2040 sud = su_uplevel_storage_new(cxix);
2043 sud->callback = (CV*)SvREFCNT_inc_simple(callback);
2044 sud->renamed = NULL;
2045 sud->gap = cxstack_ix - cxix + 1;
2046 sud->argarray = NULL;
2048 Newx(saved_cxtypes, sud->gap, U8);
2049 sud->cxtypes = saved_cxtypes;
2051 SAVEDESTRUCTOR_X(su_uplevel_restore_new, sud);
2052 SU_UPLEVEL_SAVE(curcop, cxstack[cxix].blk_oldcop);
2054 /* temporarily change the type of any contexts to NULL, so they're
2055 * invisible to caller() etc. */
2056 for (i = 0; i < sud->gap; i++) {
2057 PERL_CONTEXT *cx = cxstack + cxix + i;
2058 saved_cxtypes[i] = cx->cx_type; /* save type and flags */
2059 XSH_D(su_debug_log("su_uplevel: i=%d cxix=%d type %-11s => %s\n",
2060 i, cx-cxstack, SU_CX_TYPENAME(CxTYPE(cx)), SU_CX_TYPENAME(CXt_NULL)));
2061 cx->cx_type = (CXt_NULL | CXp_SU_UPLEVEL_NULLED);
2064 /* create a copy of the callback with a doctored name (as seen by
2065 * caller). It shares the padlist with callback */
2066 sud->renamed = su_cv_clone(callback, CvGV(base_cv));
2067 sud->old_runops = PL_runops;
2069 if (!CvISXSUB(sud->renamed) && CxHASARGS(&cxstack[cxix])) {
2070 sud->argarray = (AV*)su_at_underscore(base_cv);
2071 assert(PL_runops != su_uplevel_runops_hook_entersub);
2072 /* set up a one-shot runops hook so that we can fake up the
2073 * args as seen by caller() on return from pp_entersub */
2074 PL_runops = su_uplevel_runops_hook_entersub;
2077 CvDEPTH(callback)++; /* match what CvDEPTH(sud->renamed) is about to become */
2079 ret = call_sv((SV*)sud->renamed, gimme);
2088 static I32 su_uplevel_old(pTHX_ CV *callback, I32 cxix, I32 args) {
2090 const PERL_CONTEXT *cx = cxstack + cxix;
2092 PERL_SI *cur = PL_curstackinfo;
2098 I32 old_mark, new_mark;
2105 /* Make PL_stack_sp point just before the CV. */
2106 PL_stack_sp -= args + 1;
2107 old_mark = AvFILLp(PL_curstack) = PL_stack_sp - PL_stack_base;
2110 sud = su_uplevel_storage_new(cxix);
2114 sud->callback = NULL;
2115 sud->renamed = NULL;
2116 SAVEDESTRUCTOR_X(su_uplevel_restore_old, sud);
2120 si->si_type = cur->si_type;
2122 si->si_prev = cur->si_prev;
2124 si->si_markoff = cx->blk_oldmarksp;
2127 /* Allocate enough space for all the elements of the original stack up to the
2128 * target context, plus the forthcoming arguments. */
2129 new_mark = cx->blk_oldsp;
2130 av_extend(si->si_stack, new_mark + 1 + args + 1);
2131 Copy(AvARRAY(PL_curstack), AvARRAY(si->si_stack), new_mark + 1, SV *);
2132 AvFILLp(si->si_stack) = new_mark;
2133 SU_POISON(AvARRAY(si->si_stack) + new_mark + 1, args + 1, SV *);
2135 /* Specialized SWITCHSTACK() */
2136 PL_stack_base = AvARRAY(si->si_stack);
2137 old_stack_sp = PL_stack_sp;
2138 PL_stack_sp = PL_stack_base + AvFILLp(si->si_stack);
2139 PL_stack_max = PL_stack_base + AvMAX(si->si_stack);
2142 /* Copy the context stack up to the context just below the target. */
2143 si->si_cxix = (cxix < 0) ? -1 : (cxix - 1);
2144 if (si->si_cxmax < cxix) {
2145 /* The max size must be at least two so that GROW(max) = (max*3)/2 > max */
2146 si->si_cxmax = (cxix < 4) ? 4 : cxix;
2147 Renew(si->si_cxstack, si->si_cxmax + 1, PERL_CONTEXT);
2149 Copy(cur->si_cxstack, si->si_cxstack, cxix, PERL_CONTEXT);
2150 SU_POISON(si->si_cxstack + cxix, si->si_cxmax + 1 - cxix, PERL_CONTEXT);
2152 target = cx->blk_sub.cv;
2153 sud->target = (CV *) SvREFCNT_inc(target);
2154 sud->target_depth = CvDEPTH(target);
2156 /* blk_oldcop is essentially needed for caller() and stack traces. It has no
2157 * run-time implication, since PL_curcop will be overwritten as soon as we
2158 * enter a sub (a sub starts by a nextstate/dbstate). Hence it's safe to just
2159 * make it point to the blk_oldcop for the target frame, so that caller()
2160 * reports the right file name, line number and lexical hints. */
2161 SU_UPLEVEL_SAVE(curcop, cx->blk_oldcop);
2162 /* Don't reset PL_markstack_ptr, or we would overwrite the mark stack below
2163 * this point. Don't reset PL_curpm either, we want the most recent matches. */
2165 SU_UPLEVEL_SAVE(curstackinfo, si);
2166 /* If those two are equal, we need to fool POPSTACK_TO() */
2167 if (PL_mainstack == PL_curstack)
2168 SU_UPLEVEL_SAVE(mainstack, si->si_stack);
2170 sud->old_mainstack = NULL;
2171 PL_curstack = si->si_stack;
2173 renamed = su_cv_clone(callback, CvGV(target));
2174 sud->renamed = renamed;
2177 /* Both SP and old_stack_sp point just before the CV. */
2178 Copy(old_stack_sp + 2, SP + 1, args, SV *);
2180 PUSHs((SV *) renamed);
2183 Zero(&sub_op, 1, UNOP);
2184 sub_op.op_type = OP_ENTERSUB;
2185 sub_op.op_next = NULL;
2186 sub_op.op_flags = OP_GIMME_REVERSE(gimme) | OPf_STACKED;
2188 sub_op.op_flags |= OPpENTERSUB_DB;
2190 SU_UPLEVEL_SAVE(op, (OP *) &sub_op);
2192 #if SU_UPLEVEL_HIJACKS_RUNOPS
2193 sud->old_runops = PL_runops;
2196 sud->old_catch = CATCH_GET;
2199 if ((PL_op = PL_ppaddr[OP_ENTERSUB](aTHX))) {
2200 PERL_CONTEXT *sub_cx = cxstack + cxstack_ix;
2201 AV *argarray = cx->blk_sub.argarray;
2203 /* If pp_entersub() returns a non-null OP, it means that the callback is not
2206 sud->callback = MUTABLE_CV(SvREFCNT_inc(callback));
2207 CvDEPTH(callback)++;
2209 if (CxHASARGS(cx) && argarray) {
2210 /* The call to pp_entersub() has saved the current @_ (in XS terms,
2211 * GvAV(PL_defgv)) in the savearray member, and has created a new argarray
2212 * with what we put on the stack. But we want to fake up the same arguments
2213 * as the ones in use at the context we uplevel to, so we replace the
2214 * argarray with an unreal copy of the original @_. */
2218 av_extend(av, AvMAX(argarray));
2219 AvFILLp(av) = AvFILLp(argarray);
2220 Copy(AvARRAY(argarray), AvARRAY(av), AvFILLp(av) + 1, SV *);
2221 sub_cx->blk_sub.argarray = av;
2223 SvREFCNT_inc_simple_void(sub_cx->blk_sub.argarray);
2226 if (su_uplevel_goto_static(CvROOT(renamed))) {
2227 #if SU_UPLEVEL_HIJACKS_RUNOPS
2228 if (PL_runops != PL_runops_std) {
2229 if (PL_runops == PL_runops_dbg) {
2231 croak("uplevel() can't execute code that calls goto when debugging flags are set");
2232 } else if (PL_runops != su_uplevel_goto_runops)
2233 croak("uplevel() can't execute code that calls goto with a custom runloop");
2236 PL_runops = su_uplevel_goto_runops;
2237 #else /* SU_UPLEVEL_HIJACKS_RUNOPS */
2238 croak("uplevel() can't execute code that calls goto before perl 5.8");
2239 #endif /* !SU_UPLEVEL_HIJACKS_RUNOPS */
2247 ret = PL_stack_sp - (PL_stack_base + new_mark);
2249 AV *old_stack = sud->old_curstackinfo->si_stack;
2251 if (old_mark + ret > AvMAX(old_stack)) {
2252 /* Specialized EXTEND(old_sp, ret) */
2253 av_extend(old_stack, old_mark + ret + 1);
2254 old_stack_sp = AvARRAY(old_stack) + old_mark;
2257 Copy(PL_stack_sp - ret + 1, old_stack_sp + 1, ret, SV *);
2259 AvFILLp(old_stack) += ret;
2269 /* --- Unique context ID --------------------------------------------------- */
2271 static su_uid *su_uid_storage_fetch(pTHX_ UV depth) {
2272 #define su_uid_storage_fetch(D) su_uid_storage_fetch(aTHX_ (D))
2277 map = XSH_CXT.uid_storage.map;
2278 alloc = XSH_CXT.uid_storage.alloc;
2280 if (depth >= alloc) {
2283 Renew(map, depth + 1, su_uid);
2284 for (i = alloc; i <= depth; ++i) {
2289 XSH_CXT.uid_storage.map = map;
2290 XSH_CXT.uid_storage.alloc = depth + 1;
2293 if (depth >= XSH_CXT.uid_storage.used)
2294 XSH_CXT.uid_storage.used = depth + 1;
2299 static int su_uid_storage_check(pTHX_ UV depth, UV seq) {
2300 #define su_uid_storage_check(D, S) su_uid_storage_check(aTHX_ (D), (S))
2304 if (depth >= XSH_CXT.uid_storage.used)
2307 uid = XSH_CXT.uid_storage.map + depth;
2309 return (uid->seq == seq) && (uid->flags & SU_UID_ACTIVE);
2312 static SV *su_uid_get(pTHX_ I32 cxix) {
2313 #define su_uid_get(I) su_uid_get(aTHX_ (I))
2318 depth = su_uid_depth(cxix);
2319 uid = su_uid_storage_fetch(depth);
2321 if (!(uid->flags & SU_UID_ACTIVE)) {
2324 uid->seq = su_uid_seq_next(depth);
2325 uid->flags |= SU_UID_ACTIVE;
2327 Newx(ud, 1, su_ud_uid);
2328 SU_UD_TYPE(ud) = SU_UD_TYPE_UID;
2330 su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
2333 uid_sv = sv_newmortal();
2334 sv_setpvf(uid_sv, "%"UVuf"-%"UVuf, depth, uid->seq);
2341 #define su_grok_number(S, L, VP) grok_number((S), (L), (VP))
2343 #else /* grok_number */
2345 #define IS_NUMBER_IN_UV 0x1
2347 static int su_grok_number(pTHX_ const char *s, STRLEN len, UV *valuep) {
2348 #define su_grok_number(S, L, VP) su_grok_number(aTHX_ (S), (L), (VP))
2352 /* This crude check should be good enough for a fallback implementation.
2353 * Better be too strict than too lax. */
2354 for (i = 0; i < len; ++i) {
2359 tmpsv = sv_newmortal();
2360 sv_setpvn(tmpsv, s, len);
2361 *valuep = sv_2uv(tmpsv);
2363 return IS_NUMBER_IN_UV;
2366 #endif /* !grok_number */
2368 static int su_uid_validate(pTHX_ SV *uid) {
2369 #define su_uid_validate(U) su_uid_validate(aTHX_ (U))
2375 s = SvPV_const(uid, len);
2377 while (p < len && s[p] != '-')
2380 croak("UID contains only one part");
2382 type = su_grok_number(s, p, &depth);
2383 if (type != IS_NUMBER_IN_UV)
2384 croak("First UID part is not an unsigned integer");
2386 ++p; /* Skip '-'. As we used to have p < len, len - (p + 1) >= 0. */
2388 type = su_grok_number(s + p, len - p, &seq);
2389 if (type != IS_NUMBER_IN_UV)
2390 croak("Second UID part is not an unsigned integer");
2392 return su_uid_storage_check(depth, seq);
2395 /* --- Context operations -------------------------------------------------- */
2397 /* Remove sequences of BLOCKs having DB for stash, followed by a SUB context
2398 * for the debugger callback. */
2400 static I32 su_context_skip_db(pTHX_ I32 cxix) {
2401 #define su_context_skip_db(C) su_context_skip_db(aTHX_ (C))
2407 for (i = cxix; i > 0; --i) {
2408 PERL_CONTEXT *cx = cxstack + i;
2410 switch (CxTYPE(cx)) {
2411 #if XSH_HAS_PERL(5, 17, 1)
2412 case CXt_LOOP_PLAIN:
2415 if (cx->blk_oldcop && CopSTASH(cx->blk_oldcop) == GvSTASH(PL_DBgv))
2419 if (cx->blk_sub.cv == GvCV(PL_DBsub)) {
2434 #ifdef SU_HAS_NEW_CXT
2436 /* convert a physical context stack index into the logical equivalent:
2437 * one that ignores all the context frames hidden by uplevel().
2438 * Perl-level functions use logical args (e.g. UP takes an optional logical
2439 * value and returns a logical value), while we use and store *real*
2440 * values internally.
2443 static I32 su_context_real2logical(pTHX_ I32 cxix) {
2444 # define su_context_real2logical(C) su_context_real2logical(aTHX_ (C))
2448 for (i = 0; i <= cxix; i++) {
2450 if (cx->cx_type == (CXt_NULL | CXp_SU_UPLEVEL_NULLED))
2453 XSH_D(su_debug_log("su_context_real2logical: %d => %d\n", cxix, cxix - gaps));
2457 /* convert a logical context stack index (one that ignores all the context
2458 * frames hidden by uplevel) into the physical equivalent
2461 static I32 su_context_logical2real(pTHX_ I32 cxix) {
2462 # define su_context_logical2real(C) su_context_logical2real(aTHX_ (C))
2466 for (i = 0; i <= cxstack_ix; i++) {
2467 PERL_CONTEXT *cx = cxstack + i;
2468 if (cx->cx_type != (CXt_NULL | CXp_SU_UPLEVEL_NULLED))
2473 XSH_D(su_debug_log("su_context_logical2real: %d => %d\n", cxix, i));
2480 # define su_context_real2logical(C) (C)
2481 # define su_context_logical2real(C) (C)
2484 static I32 su_context_normalize_up(pTHX_ I32 cxix) {
2485 #define su_context_normalize_up(C) su_context_normalize_up(aTHX_ (C))
2491 cx = cxstack + cxix;
2492 if (CxTYPE(cx) == CXt_BLOCK) {
2493 PERL_CONTEXT *prev = cx - 1;
2495 switch (CxTYPE(prev)) {
2496 #if XSH_HAS_PERL(5, 10, 0)
2500 #if XSH_HAS_PERL(5, 11, 0)
2501 /* That's the only subcategory that can cause an extra BLOCK context */
2502 case CXt_LOOP_PLAIN:
2506 if (cx->blk_oldcop == prev->blk_oldcop)
2510 if (cx->blk_oldcop && OpSIBLING(cx->blk_oldcop)
2511 && OpSIBLING(cx->blk_oldcop)->op_type == OP_SUBST)
2520 static I32 su_context_normalize_down(pTHX_ I32 cxix) {
2521 #define su_context_normalize_down(C) su_context_normalize_down(aTHX_ (C))
2524 if (cxix >= cxstack_ix)
2527 next = cxstack + cxix + 1;
2528 if (CxTYPE(next) == CXt_BLOCK) {
2529 PERL_CONTEXT *cx = next - 1;
2531 switch (CxTYPE(cx)) {
2532 #if XSH_HAS_PERL(5, 10, 0)
2536 #if XSH_HAS_PERL(5, 11, 0)
2537 /* That's the only subcategory that can cause an extra BLOCK context */
2538 case CXt_LOOP_PLAIN:
2542 if (cx->blk_oldcop == next->blk_oldcop)
2546 if (next->blk_oldcop && OpSIBLING(next->blk_oldcop)
2547 && OpSIBLING(next->blk_oldcop)->op_type == OP_SUBST)
2556 #define su_context_here() su_context_normalize_up(su_context_skip_db(cxstack_ix))
2558 static I32 su_context_gimme(pTHX_ I32 cxix) {
2559 #define su_context_gimme(C) su_context_gimme(aTHX_ (C))
2562 for (i = cxix; i >= 0; --i) {
2563 PERL_CONTEXT *cx = cxstack + i;
2565 switch (CxTYPE(cx)) {
2566 /* gimme is always G_ARRAY for loop contexts. */
2567 #if XSH_HAS_PERL(5, 11, 0)
2568 # if XSH_HAS_PERL(5, 23, 8)
2574 case CXt_LOOP_PLAIN:
2575 case CXt_LOOP_LAZYSV:
2576 case CXt_LOOP_LAZYIV:
2581 const COP *cop = cx->blk_oldcop;
2582 if (cop && OpSIBLING(cop)) {
2583 switch (OpSIBLING(cop)->op_flags & OPf_WANT) {
2586 case OPf_WANT_SCALAR:
2605 /* --- Module setup/teardown ----------------------------------------------- */
2607 static void xsh_user_global_setup(pTHX) {
2610 MUTEX_INIT(&su_uid_seq_counter_mutex);
2612 XSH_LOCK(&su_uid_seq_counter_mutex);
2613 su_uid_seq_counter.seqs = NULL;
2614 su_uid_seq_counter.size = 0;
2615 XSH_UNLOCK(&su_uid_seq_counter_mutex);
2617 stash = gv_stashpv(XSH_PACKAGE, 1);
2618 newCONSTSUB(stash, "TOP", newSViv(0));
2619 newCONSTSUB(stash, "SU_THREADSAFE", newSVuv(XSH_THREADSAFE));
2624 static void xsh_user_local_setup(pTHX_ xsh_user_cxt_t *cxt) {
2626 /* NewOp() calls calloc() which just zeroes the memory with memset(). */
2627 Zero(&(cxt->unwind_storage.return_op), 1, LISTOP);
2628 cxt->unwind_storage.return_op.op_type = OP_RETURN;
2629 cxt->unwind_storage.return_op.op_ppaddr = PL_ppaddr[OP_RETURN];
2631 Zero(&(cxt->unwind_storage.proxy_op), 1, OP);
2632 cxt->unwind_storage.proxy_op.op_type = OP_STUB;
2633 cxt->unwind_storage.proxy_op.op_ppaddr = NULL;
2635 Zero(&(cxt->yield_storage.leave_op), 1, UNOP);
2636 cxt->yield_storage.leave_op.op_type = OP_STUB;
2637 cxt->yield_storage.leave_op.op_ppaddr = NULL;
2639 Zero(&(cxt->yield_storage.proxy_op), 1, OP);
2640 cxt->yield_storage.proxy_op.op_type = OP_STUB;
2641 cxt->yield_storage.proxy_op.op_ppaddr = NULL;
2643 cxt->uplevel_storage.top = NULL;
2644 cxt->uplevel_storage.root = NULL;
2645 cxt->uplevel_storage.count = 0;
2647 cxt->uid_storage.map = NULL;
2648 cxt->uid_storage.used = 0;
2649 cxt->uid_storage.alloc = 0;
2654 static void xsh_user_local_teardown(pTHX_ xsh_user_cxt_t *cxt) {
2657 Safefree(cxt->uid_storage.map);
2659 cur = cxt->uplevel_storage.root;
2661 su_uplevel_ud *prev;
2665 su_uplevel_ud_delete(prev);
2672 static void xsh_user_global_teardown(pTHX) {
2673 XSH_LOCK(&su_uid_seq_counter_mutex);
2674 PerlMemShared_free(su_uid_seq_counter.seqs);
2675 su_uid_seq_counter.size = 0;
2676 XSH_UNLOCK(&su_uid_seq_counter_mutex);
2678 MUTEX_DESTROY(&su_uid_seq_counter_mutex);
2683 /* --- XS ------------------------------------------------------------------ */
2685 /* D is real; B is logical. Returns real. */
2687 #define SU_GET_CONTEXT(A, B, D) \
2696 else if (cxix > cxstack_ix) \
2698 cxix = su_context_logical2real(cxix); \
2705 #define SU_GET_LEVEL(A, B) \
2711 level = SvIV(lsv); \
2718 #if XSH_HAS_PERL(5, 10, 0)
2719 # define SU_INFO_COUNT 11
2721 # define SU_INFO_COUNT 10
2724 XS(XS_Scope__Upper_unwind) {
2733 PERL_UNUSED_VAR(cv); /* -W */
2734 PERL_UNUSED_VAR(ax); /* -Wall */
2736 SU_GET_CONTEXT(0, items - 1, cxstack_ix);
2738 PERL_CONTEXT *cx = cxstack + cxix;
2739 switch (CxTYPE(cx)) {
2741 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2745 XSH_CXT.unwind_storage.cxix = cxix;
2746 XSH_CXT.unwind_storage.items = items;
2747 XSH_CXT.unwind_storage.savesp = PL_stack_sp;
2749 XSH_CXT.unwind_storage.items--;
2750 XSH_CXT.unwind_storage.savesp--;
2752 /* pp_entersub will want to sanitize the stack after returning from there
2753 * Screw that, we're insane!
2754 * dXSARGS calls POPMARK, so we need to match PL_markstack_ptr[1] */
2755 if (GIMME_V == G_SCALAR)
2756 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2757 SAVEDESTRUCTOR_X(su_unwind, NULL);
2762 } while (--cxix >= 0);
2763 croak("Can't return outside a subroutine");
2766 static const char su_yield_name[] = "yield";
2768 XS(XS_Scope__Upper_yield) {
2777 PERL_UNUSED_VAR(cv); /* -W */
2778 PERL_UNUSED_VAR(ax); /* -Wall */
2780 SU_GET_CONTEXT(0, items - 1, su_context_here());
2781 XSH_CXT.yield_storage.cxix = cxix;
2782 XSH_CXT.yield_storage.items = items;
2783 XSH_CXT.yield_storage.savesp = PL_stack_sp;
2785 XSH_CXT.yield_storage.items--;
2786 XSH_CXT.yield_storage.savesp--;
2788 /* See XS_Scope__Upper_unwind */
2789 if (GIMME_V == G_SCALAR)
2790 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2791 SAVEDESTRUCTOR_X(su_yield, su_yield_name);
2795 static const char su_leave_name[] = "leave";
2797 XS(XS_Scope__Upper_leave) {
2805 PERL_UNUSED_VAR(cv); /* -W */
2806 PERL_UNUSED_VAR(ax); /* -Wall */
2808 XSH_CXT.yield_storage.cxix = su_context_here();
2809 XSH_CXT.yield_storage.items = items;
2810 XSH_CXT.yield_storage.savesp = PL_stack_sp;
2811 /* See XS_Scope__Upper_unwind */
2812 if (GIMME_V == G_SCALAR)
2813 PL_stack_sp = PL_stack_base + PL_markstack_ptr[1] + 1;
2814 SAVEDESTRUCTOR_X(su_yield, su_leave_name);
2818 MODULE = Scope::Upper PACKAGE = Scope::Upper
2825 newXSproto("Scope::Upper::unwind", XS_Scope__Upper_unwind, file, NULL);
2826 newXSproto("Scope::Upper::yield", XS_Scope__Upper_yield, file, NULL);
2827 newXSproto("Scope::Upper::leave", XS_Scope__Upper_leave, file, NULL);
2839 #endif /* XSH_THREADSAFE */
2847 cxix = su_context_real2logical(su_context_here());
2858 SU_GET_CONTEXT(0, 0, su_context_here());
2861 cxix = su_context_skip_db(cxix);
2862 cxix = su_context_normalize_up(cxix);
2863 cxix = su_context_real2logical(cxix);
2865 warn(su_stack_smash);
2877 SU_GET_CONTEXT(0, 0, cxstack_ix);
2879 for (; cxix >= 0; --cxix) {
2880 PERL_CONTEXT *cx = cxstack + cxix;
2881 switch (CxTYPE(cx)) {
2885 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2887 cxix = su_context_real2logical(cxix);
2892 warn(su_no_such_target, "subroutine");
2901 SU_GET_CONTEXT(0, 0, cxstack_ix);
2903 for (; cxix >= 0; --cxix) {
2904 PERL_CONTEXT *cx = cxstack + cxix;
2905 switch (CxTYPE(cx)) {
2909 cxix = su_context_real2logical(cxix);
2914 warn(su_no_such_target, "eval");
2924 cxix = su_context_here();
2925 while (--level >= 0) {
2927 warn(su_stack_smash);
2931 cxix = su_context_skip_db(cxix);
2932 cxix = su_context_normalize_up(cxix);
2933 cxix = su_context_real2logical(cxix);
2946 for (cxix = cxstack_ix; cxix > 0; --cxix) {
2947 PERL_CONTEXT *cx = cxstack + cxix;
2948 switch (CxTYPE(cx)) {
2950 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2961 warn(su_stack_smash);
2963 cxix = su_context_real2logical(cxix);
2973 SU_GET_CONTEXT(0, 0, cxstack_ix);
2976 PERL_CONTEXT *cx = cxstack + cxix--;
2977 switch (CxTYPE(cx)) {
2979 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
2983 I32 gimme = cx->blk_gimme;
2985 case G_VOID: XSRETURN_UNDEF; break;
2986 case G_SCALAR: XSRETURN_NO; break;
2987 case G_ARRAY: XSRETURN_YES; break;
3000 const PERL_CONTEXT *cx, *dbcx;
3003 SU_GET_CONTEXT(0, 0, su_context_skip_db(cxstack_ix));
3004 cxix = su_context_normalize_up(cxix);
3005 cx = cxstack + cxix;
3007 if (PL_DBsub && cxix && (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT)) {
3008 I32 i = su_context_skip_db(cxix - 1) + 1;
3009 if (i < cxix && CxTYPE(cxstack + i) == CXt_SUB)
3012 cop = cx->blk_oldcop;
3013 EXTEND(SP, SU_INFO_COUNT);
3016 HV *stash = CopSTASH(cop);
3018 PUSHs(su_newmortal_pvn(HvNAME(stash), HvNAMELEN(stash)));
3020 PUSHs(&PL_sv_undef);
3023 PUSHs(su_newmortal_pvn(OutCopFILE(cop), OutCopFILE_len(cop)));
3025 mPUSHi(CopLINE(cop));
3026 /* subroutine (3) and has_args (4) */
3027 switch (CxTYPE(cx)) {
3030 GV *cvgv = CvGV(dbcx->blk_sub.cv);
3031 if (cvgv && isGV(cvgv)) {
3032 SV *sv = sv_newmortal();
3033 gv_efullname3(sv, cvgv, NULL);
3036 PUSHs(su_newmortal_pvs("(unknown)"));
3045 PUSHs(su_newmortal_pvs("(eval)"));
3049 PUSHs(&PL_sv_undef);
3050 PUSHs(&PL_sv_undef);
3053 switch (su_context_gimme(cxix)) {
3060 default: /* G_VOID */
3061 PUSHs(&PL_sv_undef);
3064 /* eval text (6) and is_require (7) */
3065 switch (CxTYPE(cx)) {
3067 if (CxOLD_OP_TYPE(cx) == OP_ENTEREVAL) {
3069 #if XSH_HAS_PERL(5, 17, 4)
3070 PUSHs(newSVpvn_flags(SvPVX(cx->blk_eval.cur_text),
3071 SvCUR(cx->blk_eval.cur_text)-2,
3072 SvUTF8(cx->blk_eval.cur_text)|SVs_TEMP));
3074 PUSHs(cx->blk_eval.cur_text);
3078 } else if (cx->blk_eval.old_namesv) {
3080 PUSHs(sv_mortalcopy(cx->blk_eval.old_namesv));
3086 /* Anything else including eval BLOCK */
3087 PUSHs(&PL_sv_undef);
3088 PUSHs(&PL_sv_undef);
3092 mPUSHi(CopHINTS_get(cop));
3096 #if XSH_HAS_PERL(5, 9, 4)
3097 STRLEN *old_warnings = cop->cop_warnings;
3099 SV *old_warnings = cop->cop_warnings;
3101 if (old_warnings == pWARN_STD) {
3102 if (PL_dowarn & G_WARN_ON)
3103 goto context_info_warnings_on;
3105 #if XSH_HAS_PERL(5, 17, 4)
3106 mask = &PL_sv_undef;
3108 goto context_info_warnings_off;
3110 } else if (old_warnings == pWARN_NONE) {
3111 #if !XSH_HAS_PERL(5, 17, 4)
3112 context_info_warnings_off:
3114 mask = su_newmortal_pvn(WARN_NONEstring, WARNsize);
3115 } else if (old_warnings == pWARN_ALL) {
3117 context_info_warnings_on:
3118 #if XSH_HAS_PERL(5, 8, 7)
3119 bits = get_hv("warnings::Bits", 0);
3121 SV **bits_all = hv_fetchs(bits, "all", FALSE);
3123 mask = sv_mortalcopy(*bits_all);
3127 mask = su_newmortal_pvn(WARN_ALLstring, WARNsize);
3129 #if XSH_HAS_PERL(5, 9, 4)
3130 mask = su_newmortal_pvn((char *) (old_warnings + 1), old_warnings[0]);
3132 mask = sv_mortalcopy(old_warnings);
3137 #if XSH_HAS_PERL(5, 10, 0)
3138 /* hints hash (10) */
3140 COPHH *hints_hash = CopHINTHASH_get(cop);
3142 SV *rhv = sv_2mortal(newRV_noinc((SV *) cophh_2hv(hints_hash, 0)));
3145 PUSHs(&PL_sv_undef);
3149 XSRETURN(SU_INFO_COUNT);
3158 SU_GET_CONTEXT(1, 1, su_context_skip_db(cxstack_ix));
3159 cxix = su_context_normalize_down(cxix);
3160 Newx(ud, 1, su_ud_reap);
3161 SU_UD_TYPE(ud) = SU_UD_TYPE_REAP;
3162 ud->cb = (SvROK(hook) && SvTYPE(SvRV(hook)) >= SVt_PVCV)
3163 ? SvRV(hook) : hook;
3164 SvREFCNT_inc_simple_void(ud->cb);
3165 su_init(ud, cxix, SU_SAVE_DESTRUCTOR_SIZE);
3168 localize(SV *sv, SV *val, ...)
3175 SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
3176 cxix = su_context_normalize_down(cxix);
3177 Newx(ud, 1, su_ud_localize);
3178 SU_UD_TYPE(ud) = SU_UD_TYPE_LOCALIZE;
3179 size = su_ud_localize_init(ud, sv, val, NULL);
3180 su_init(ud, cxix, size);
3183 localize_elem(SV *sv, SV *elem, SV *val, ...)
3190 if (SvTYPE(sv) >= SVt_PVGV)
3191 croak("Can't infer the element localization type from a glob and the value");
3192 SU_GET_CONTEXT(3, 3, su_context_skip_db(cxstack_ix));
3193 cxix = su_context_normalize_down(cxix);
3194 Newx(ud, 1, su_ud_localize);
3195 /* Initialize SU_UD_ORIGIN(ud) in case SU_UD_LOCALIZE_FREE(ud) needs it */
3196 SU_UD_ORIGIN(ud) = NULL;
3197 SU_UD_TYPE(ud) = SU_UD_TYPE_LOCALIZE;
3198 size = su_ud_localize_init(ud, sv, val, elem);
3199 if (SU_UD_PRIVATE(ud) != SVt_PVAV && SU_UD_PRIVATE(ud) != SVt_PVHV) {
3200 SU_UD_LOCALIZE_FREE(ud);
3201 croak("Can't localize an element of something that isn't an array or a hash");
3203 su_init(ud, cxix, size);
3206 localize_delete(SV *sv, SV *elem, ...)
3213 SU_GET_CONTEXT(2, 2, su_context_skip_db(cxstack_ix));
3214 cxix = su_context_normalize_down(cxix);
3215 Newx(ud, 1, su_ud_localize);
3216 SU_UD_TYPE(ud) = SU_UD_TYPE_LOCALIZE;
3217 size = su_ud_localize_init(ud, sv, NULL, elem);
3218 su_init(ud, cxix, size);
3221 uplevel(SV *code, ...)
3224 I32 cxix, ret, args = 0;
3228 if (SvTYPE(code) < SVt_PVCV)
3229 croak("First argument to uplevel must be a code reference");
3230 SU_GET_CONTEXT(1, items - 1, cxstack_ix);
3232 PERL_CONTEXT *cx = cxstack + cxix;
3233 switch (CxTYPE(cx)) {
3235 croak("Can't uplevel to an eval frame");
3237 croak("Can't uplevel to a format frame");
3239 if (PL_DBsub && cx->blk_sub.cv == GvCV(PL_DBsub))
3245 /* su_uplevel() takes care of extending the stack if needed. */
3246 #ifdef SU_HAS_NEW_CXT
3247 ret = su_uplevel_new(aTHX_ (CV *) code, cxix, args);
3249 ret = su_uplevel_old(aTHX_ (CV *) code, cxix, args);
3255 } while (--cxix >= 0);
3256 croak("Can't uplevel outside a subroutine");
3265 SU_GET_CONTEXT(0, 0, su_context_here());
3266 uid = su_uid_get(cxix);
3272 validate_uid(SV *uid)
3277 ret = su_uid_validate(uid) ? &PL_sv_yes : &PL_sv_no;