3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 * 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
12 * For the fashion of Minas Tirith was such that it was built on seven
15 * [p.751 of _The Lord of the Rings_, V/i: "Minas Tirith"]
18 /* This file contains functions to manipulate several of Perl's stacks;
19 * in particular it contains code to push various types of things onto
20 * the savestack, then to pop them off and perform the correct restorative
21 * action for each one. This corresponds to the cleanup Perl does at
26 #define PERL_IN_SCOPE_C
30 Perl_stack_grow(pTHX_ SV **sp, SV **p, SSize_t n)
32 PERL_ARGS_ASSERT_STACK_GROW;
35 #ifndef STRESS_REALLOC
36 av_extend(PL_curstack, (p - PL_stack_base) + (n) + 128);
38 av_extend(PL_curstack, (p - PL_stack_base) + (n) + 1);
43 #ifndef STRESS_REALLOC
44 #define GROW(old) ((old) * 3 / 2)
46 #define GROW(old) ((old) + 1)
50 Perl_new_stackinfo(pTHX_ I32 stitems, I32 cxitems)
54 si->si_stack = newAV();
55 AvREAL_off(si->si_stack);
56 av_extend(si->si_stack, stitems > 0 ? stitems-1 : 0);
57 AvALLOC(si->si_stack)[0] = &PL_sv_undef;
58 AvFILLp(si->si_stack) = 0;
61 si->si_cxmax = cxitems - 1;
63 si->si_type = PERLSI_UNDEF;
64 Newx(si->si_cxstack, cxitems, PERL_CONTEXT);
65 /* Without any kind of initialising PUSHSUBST()
66 * in pp_subst() will read uninitialised heap. */
67 PoisonNew(si->si_cxstack, cxitems, PERL_CONTEXT);
74 const IV old_max = cxstack_max;
75 cxstack_max = GROW(cxstack_max);
76 Renew(cxstack, cxstack_max + 1, PERL_CONTEXT);
77 /* Without any kind of initialising deep enough recursion
78 * will end up reading uninitialised PERL_CONTEXTs. */
79 PoisonNew(cxstack + old_max + 1, cxstack_max - old_max, PERL_CONTEXT);
80 return cxstack_ix + 1;
86 if (UNLIKELY(PL_scopestack_ix == PL_scopestack_max)) {
87 PL_scopestack_max = GROW(PL_scopestack_max);
88 Renew(PL_scopestack, PL_scopestack_max, I32);
90 Renew(PL_scopestack_name, PL_scopestack_max, const char*);
94 PL_scopestack_name[PL_scopestack_ix] = "unknown";
96 PL_scopestack[PL_scopestack_ix++] = PL_savestack_ix;
103 const I32 oldsave = PL_scopestack[--PL_scopestack_ix];
104 LEAVE_SCOPE(oldsave);
108 Perl_markstack_grow(pTHX)
110 const I32 oldmax = PL_markstack_max - PL_markstack;
111 const I32 newmax = GROW(oldmax);
113 Renew(PL_markstack, newmax, I32);
114 PL_markstack_max = PL_markstack + newmax;
115 PL_markstack_ptr = PL_markstack + oldmax;
116 return PL_markstack_ptr;
120 Perl_savestack_grow(pTHX)
122 PL_savestack_max = GROW(PL_savestack_max) + 4;
123 Renew(PL_savestack, PL_savestack_max, ANY);
127 Perl_savestack_grow_cnt(pTHX_ I32 need)
129 PL_savestack_max = PL_savestack_ix + need;
130 Renew(PL_savestack, PL_savestack_max, ANY);
135 /* The original function was called Perl_tmps_grow and was removed from public
136 API, Perl_tmps_grow_p is the replacement and it used in public macros but
139 Perl_tmps_grow_p takes a proposed ix. A proposed ix is PL_tmps_ix + extend_by,
140 where the result of (PL_tmps_ix + extend_by) is >= PL_tmps_max
141 Upon return, PL_tmps_stack[ix] will be a valid address. For machine code
142 optimization and register usage reasons, the proposed ix passed into
143 tmps_grow is returned to the caller which the caller can then use to write
144 an SV * to PL_tmps_stack[ix]. If the caller was using tmps_grow in
145 pre-extend mode (EXTEND_MORTAL macro), then it ignores the return value of
146 tmps_grow. Note, tmps_grow DOES NOT write ix to PL_tmps_ix, the caller
147 must assign ix or ret val of tmps_grow to PL_temps_ix themselves if that is
148 appropriate. The assignment to PL_temps_ix can happen before or after
149 tmps_grow call since tmps_grow doesn't look at PL_tmps_ix.
153 Perl_tmps_grow_p(pTHX_ SSize_t ix)
155 SSize_t extend_to = ix;
156 #ifndef STRESS_REALLOC
157 if (ix - PL_tmps_max < 128)
158 extend_to += (PL_tmps_max < 512) ? 128 : 512;
160 PL_tmps_max = extend_to + 1;
161 Renew(PL_tmps_stack, PL_tmps_max, SV*);
169 /* XXX should tmps_floor live in cxstack? */
170 const SSize_t myfloor = PL_tmps_floor;
171 while (PL_tmps_ix > myfloor) { /* clean up after last statement */
172 SV* const sv = PL_tmps_stack[PL_tmps_ix--];
174 PoisonWith(PL_tmps_stack + PL_tmps_ix + 1, 1, SV *, 0xAB);
176 if (LIKELY(sv && sv != &PL_sv_undef)) {
178 SvREFCNT_dec_NN(sv); /* note, can modify tmps_ix!!! */
184 S_save_scalar_at(pTHX_ SV **sptr, const U32 flags)
189 PERL_ARGS_ASSERT_SAVE_SCALAR_AT;
192 sv = (flags & SAVEf_KEEPOLDELEM) ? osv : (*sptr = newSV(0));
194 if (SvTYPE(osv) >= SVt_PVMG && SvMAGIC(osv)) {
195 if (SvGMAGICAL(osv)) {
196 SvFLAGS(osv) |= (SvFLAGS(osv) &
197 (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
199 if (!(flags & SAVEf_KEEPOLDELEM))
200 mg_localize(osv, sv, cBOOL(flags & SAVEf_SETMAGIC));
207 Perl_save_pushptrptr(pTHX_ void *const ptr1, void *const ptr2, const int type)
217 Perl_save_scalar(pTHX_ GV *gv)
219 SV ** const sptr = &GvSVn(gv);
221 PERL_ARGS_ASSERT_SAVE_SCALAR;
223 if (UNLIKELY(SvGMAGICAL(*sptr))) {
228 save_pushptrptr(SvREFCNT_inc_simple(gv), SvREFCNT_inc(*sptr), SAVEt_SV);
229 return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
232 /* Like save_sptr(), but also SvREFCNT_dec()s the new value. Can be used to
233 * restore a global SV to its prior contents, freeing new value. */
235 Perl_save_generic_svref(pTHX_ SV **sptr)
237 PERL_ARGS_ASSERT_SAVE_GENERIC_SVREF;
239 save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_GENERIC_SVREF);
242 /* Like save_pptr(), but also Safefree()s the new value if it is different
243 * from the old one. Can be used to restore a global char* to its prior
244 * contents, freeing new value. */
246 Perl_save_generic_pvref(pTHX_ char **str)
248 PERL_ARGS_ASSERT_SAVE_GENERIC_PVREF;
250 save_pushptrptr(*str, str, SAVEt_GENERIC_PVREF);
253 /* Like save_generic_pvref(), but uses PerlMemShared_free() rather than Safefree().
254 * Can be used to restore a shared global char* to its prior
255 * contents, freeing new value. */
257 Perl_save_shared_pvref(pTHX_ char **str)
259 PERL_ARGS_ASSERT_SAVE_SHARED_PVREF;
261 save_pushptrptr(str, *str, SAVEt_SHARED_PVREF);
264 /* set the SvFLAGS specified by mask to the values in val */
267 Perl_save_set_svflags(pTHX_ SV* sv, U32 mask, U32 val)
271 PERL_ARGS_ASSERT_SAVE_SET_SVFLAGS;
276 SS_ADD_UV(SAVEt_SET_SVFLAGS);
281 Perl_save_gp(pTHX_ GV *gv, I32 empty)
283 PERL_ARGS_ASSERT_SAVE_GP;
285 save_pushptrptr(SvREFCNT_inc(gv), GvGP(gv), SAVEt_GP);
288 GP *gp = Perl_newGP(aTHX_ gv);
289 HV * const stash = GvSTASH(gv);
290 bool isa_changed = 0;
292 if (stash && HvENAME(stash)) {
293 if (GvNAMELEN(gv) == 3 && strnEQ(GvNAME(gv), "ISA", 3))
296 /* taking a method out of circulation ("local")*/
297 mro_method_changed_in(stash);
299 if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
301 IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
304 if (isa_changed) mro_isa_changed_in(stash);
313 Perl_save_ary(pTHX_ GV *gv)
315 AV * const oav = GvAVn(gv);
318 PERL_ARGS_ASSERT_SAVE_ARY;
320 if (UNLIKELY(!AvREAL(oav) && AvREIFY(oav)))
322 save_pushptrptr(SvREFCNT_inc_simple_NN(gv), oav, SAVEt_AV);
326 if (UNLIKELY(SvMAGIC(oav)))
327 mg_localize(MUTABLE_SV(oav), MUTABLE_SV(av), TRUE);
332 Perl_save_hash(pTHX_ GV *gv)
336 PERL_ARGS_ASSERT_SAVE_HASH;
339 SvREFCNT_inc_simple_NN(gv), (ohv = GvHVn(gv)), SAVEt_HV
344 if (UNLIKELY(SvMAGIC(ohv)))
345 mg_localize(MUTABLE_SV(ohv), MUTABLE_SV(hv), TRUE);
350 Perl_save_item(pTHX_ SV *item)
352 SV * const sv = newSVsv(item);
354 PERL_ARGS_ASSERT_SAVE_ITEM;
356 save_pushptrptr(item, /* remember the pointer */
357 sv, /* remember the value */
362 Perl_save_bool(pTHX_ bool *boolp)
366 PERL_ARGS_ASSERT_SAVE_BOOL;
369 SS_ADD_UV(SAVEt_BOOL | (*boolp << 8));
374 Perl_save_pushi32ptr(pTHX_ const I32 i, void *const ptr, const int type)
385 Perl_save_int(pTHX_ int *intp)
388 UV type = ((UV)((UV)i << SAVE_TIGHT_SHIFT) | SAVEt_INT_SMALL);
392 PERL_ARGS_ASSERT_SAVE_INT;
394 if (UNLIKELY((int)(type >> SAVE_TIGHT_SHIFT) != i)) {
405 Perl_save_I8(pTHX_ I8 *bytep)
409 PERL_ARGS_ASSERT_SAVE_I8;
412 SS_ADD_UV(SAVEt_I8 | ((UV)*bytep << 8));
417 Perl_save_I16(pTHX_ I16 *intp)
421 PERL_ARGS_ASSERT_SAVE_I16;
424 SS_ADD_UV(SAVEt_I16 | ((UV)*intp << 8));
429 Perl_save_I32(pTHX_ I32 *intp)
432 UV type = ((I32)((U32)i << SAVE_TIGHT_SHIFT) | SAVEt_I32_SMALL);
436 PERL_ARGS_ASSERT_SAVE_I32;
438 if (UNLIKELY((I32)(type >> SAVE_TIGHT_SHIFT) != i)) {
449 Perl_save_strlen(pTHX_ STRLEN *ptr)
453 PERL_ARGS_ASSERT_SAVE_STRLEN;
457 SS_ADD_UV(SAVEt_STRLEN);
461 /* Cannot use save_sptr() to store a char* since the SV** cast will
462 * force word-alignment and we'll miss the pointer.
465 Perl_save_pptr(pTHX_ char **pptr)
467 PERL_ARGS_ASSERT_SAVE_PPTR;
469 save_pushptrptr(*pptr, pptr, SAVEt_PPTR);
473 Perl_save_vptr(pTHX_ void *ptr)
475 PERL_ARGS_ASSERT_SAVE_VPTR;
477 save_pushptrptr(*(char**)ptr, ptr, SAVEt_VPTR);
481 Perl_save_sptr(pTHX_ SV **sptr)
483 PERL_ARGS_ASSERT_SAVE_SPTR;
485 save_pushptrptr(*sptr, sptr, SAVEt_SPTR);
489 Perl_save_padsv_and_mortalize(pTHX_ PADOFFSET off)
493 ASSERT_CURPAD_ACTIVE("save_padsv");
494 SS_ADD_PTR(SvREFCNT_inc_simple_NN(PL_curpad[off]));
495 SS_ADD_PTR(PL_comppad);
497 SS_ADD_UV(SAVEt_PADSV_AND_MORTALIZE);
502 Perl_save_hptr(pTHX_ HV **hptr)
504 PERL_ARGS_ASSERT_SAVE_HPTR;
506 save_pushptrptr(*hptr, hptr, SAVEt_HPTR);
510 Perl_save_aptr(pTHX_ AV **aptr)
512 PERL_ARGS_ASSERT_SAVE_APTR;
514 save_pushptrptr(*aptr, aptr, SAVEt_APTR);
518 Perl_save_pushptr(pTHX_ void *const ptr, const int type)
527 Perl_save_clearsv(pTHX_ SV **svp)
529 const UV offset = svp - PL_curpad;
530 const UV offset_shifted = offset << SAVE_TIGHT_SHIFT;
532 PERL_ARGS_ASSERT_SAVE_CLEARSV;
534 ASSERT_CURPAD_ACTIVE("save_clearsv");
535 SvPADSTALE_off(*svp); /* mark lexical as active */
536 if (UNLIKELY((offset_shifted >> SAVE_TIGHT_SHIFT) != offset)) {
537 Perl_croak(aTHX_ "panic: pad offset %"UVuf" out of range (%p-%p)",
538 offset, svp, PL_curpad);
543 SS_ADD_UV(offset_shifted | SAVEt_CLEARSV);
549 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
551 PERL_ARGS_ASSERT_SAVE_DELETE;
553 save_pushptri32ptr(key, klen, SvREFCNT_inc_simple(hv), SAVEt_DELETE);
557 Perl_save_hdelete(pTHX_ HV *hv, SV *keysv)
563 PERL_ARGS_ASSERT_SAVE_HDELETE;
565 key = SvPV_const(keysv, len);
566 klen = SvUTF8(keysv) ? -(I32)len : (I32)len;
567 SvREFCNT_inc_simple_void_NN(hv);
568 save_pushptri32ptr(savepvn(key, len), klen, hv, SAVEt_DELETE);
572 Perl_save_adelete(pTHX_ AV *av, SSize_t key)
576 PERL_ARGS_ASSERT_SAVE_ADELETE;
578 SvREFCNT_inc_void(av);
581 SS_ADD_IV(SAVEt_ADELETE);
586 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
589 PERL_ARGS_ASSERT_SAVE_DESTRUCTOR;
593 SS_ADD_UV(SAVEt_DESTRUCTOR);
598 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
604 SS_ADD_UV(SAVEt_DESTRUCTOR_X);
609 Perl_save_hints(pTHX)
611 COPHH *save_cophh = cophh_copy(CopHINTHASH_get(&PL_compiling));
612 if (PL_hints & HINT_LOCALIZE_HH) {
613 HV *oldhh = GvHV(PL_hintgv);
614 save_pushptri32ptr(oldhh, PL_hints, save_cophh, SAVEt_HINTS);
615 GvHV(PL_hintgv) = NULL; /* in case copying dies */
616 GvHV(PL_hintgv) = hv_copy_hints_hv(oldhh);
618 save_pushi32ptr(PL_hints, save_cophh, SAVEt_HINTS);
623 S_save_pushptri32ptr(pTHX_ void *const ptr1, const I32 i, void *const ptr2,
635 Perl_save_aelem_flags(pTHX_ AV *av, SSize_t idx, SV **sptr,
641 PERL_ARGS_ASSERT_SAVE_AELEM_FLAGS;
644 SS_ADD_PTR(SvREFCNT_inc_simple(av));
646 SS_ADD_PTR(SvREFCNT_inc(*sptr));
647 SS_ADD_UV(SAVEt_AELEM);
649 /* The array needs to hold a reference count on its new element, so it
651 if (UNLIKELY(!AvREAL(av) && AvREIFY(av)))
653 save_scalar_at(sptr, flags); /* XXX - FIXME - see #60360 */
654 if (flags & SAVEf_KEEPOLDELEM)
657 /* If we're localizing a tied array element, this new sv
658 * won't actually be stored in the array - so it won't get
659 * reaped when the localize ends. Ensure it gets reaped by
660 * mortifying it instead. DAPM */
661 if (UNLIKELY(SvTIED_mg((const SV *)av, PERL_MAGIC_tied)))
666 Perl_save_helem_flags(pTHX_ HV *hv, SV *key, SV **sptr, const U32 flags)
670 PERL_ARGS_ASSERT_SAVE_HELEM_FLAGS;
675 SS_ADD_PTR(SvREFCNT_inc_simple(hv));
676 SS_ADD_PTR(newSVsv(key));
677 SS_ADD_PTR(SvREFCNT_inc(*sptr));
678 SS_ADD_UV(SAVEt_HELEM);
681 save_scalar_at(sptr, flags);
682 if (flags & SAVEf_KEEPOLDELEM)
685 /* If we're localizing a tied hash element, this new sv
686 * won't actually be stored in the hash - so it won't get
687 * reaped when the localize ends. Ensure it gets reaped by
688 * mortifying it instead. DAPM */
689 if (UNLIKELY(SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)))
694 Perl_save_svref(pTHX_ SV **sptr)
696 PERL_ARGS_ASSERT_SAVE_SVREF;
699 save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_SVREF);
700 return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
704 Perl_save_alloc(pTHX_ I32 size, I32 pad)
706 const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
707 - (char*)PL_savestack);
708 const UV elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
709 const UV elems_shifted = elems << SAVE_TIGHT_SHIFT;
711 if (UNLIKELY((elems_shifted >> SAVE_TIGHT_SHIFT) != elems))
713 "panic: save_alloc elems %"UVuf" out of range (%"IVdf"-%"IVdf")",
714 elems, (IV)size, (IV)pad);
718 PL_savestack_ix += elems;
719 SSPUSHUV(SAVEt_ALLOC | elems_shifted);
725 #define ARG0_SV MUTABLE_SV(arg0.any_ptr)
726 #define ARG0_AV MUTABLE_AV(arg0.any_ptr)
727 #define ARG0_HV MUTABLE_HV(arg0.any_ptr)
728 #define ARG0_PTR arg0.any_ptr
729 #define ARG0_PV (char*)(arg0.any_ptr)
730 #define ARG0_PVP (char**)(arg0.any_ptr)
731 #define ARG0_I32 (arg0.any_i32)
733 #define ARG1_SV MUTABLE_SV(arg1.any_ptr)
734 #define ARG1_AV MUTABLE_AV(arg1.any_ptr)
735 #define ARG1_GV MUTABLE_GV(arg1.any_ptr)
736 #define ARG1_SVP (SV**)(arg1.any_ptr)
737 #define ARG1_PVP (char**)(arg1.any_ptr)
738 #define ARG1_PTR arg1.any_ptr
739 #define ARG1_PV (char*)(arg1.any_ptr)
740 #define ARG1_I32 (arg1.any_i32)
742 #define ARG2_SV MUTABLE_SV(arg2.any_ptr)
743 #define ARG2_AV MUTABLE_AV(arg2.any_ptr)
744 #define ARG2_HV MUTABLE_HV(arg2.any_ptr)
745 #define ARG2_GV MUTABLE_GV(arg2.any_ptr)
746 #define ARG2_PV (char*)(arg2.any_ptr)
749 Perl_leave_scope(pTHX_ I32 base)
751 /* Localise the effects of the TAINT_NOT inside the loop. */
752 bool was = TAINT_get;
757 ANY arg0, arg1, arg2;
759 /* these initialisations are logically unnecessary, but they shut up
760 * spurious 'may be used uninitialized' compiler warnings */
765 if (UNLIKELY(base < -1))
766 Perl_croak(aTHX_ "panic: corrupt saved stack index %ld", (long) base);
767 DEBUG_l(Perl_deb(aTHX_ "savestack: releasing items %ld -> %ld\n",
768 (long)PL_savestack_ix, (long)base));
769 while (PL_savestack_ix > base) {
779 I32 ix = PL_savestack_ix - 1;
780 ANY *p = &PL_savestack[ix];
782 type = (U8)uv & SAVE_MASK;
783 if (type > SAVEt_ARG0_MAX) {
786 if (type > SAVEt_ARG1_MAX) {
788 if (type > SAVEt_ARG2_MAX) {
794 PL_savestack_ix = ix;
798 case SAVEt_ITEM: /* normal string */
799 sv_replace(ARG1_SV, ARG0_SV);
800 if (UNLIKELY(SvSMAGICAL(ARG1_SV))) {
807 /* This would be a mathom, but Perl_save_svref() calls a static
808 function, S_save_scalar_at(), so has to stay in this file. */
809 case SAVEt_SVREF: /* scalar reference */
811 refsv = NULL; /* what to refcnt_dec */
814 case SAVEt_SV: /* scalar reference */
815 svp = &GvSV(ARG1_GV);
816 refsv = ARG1_SV; /* what to refcnt_dec */
819 SV * const sv = *svp;
822 if (UNLIKELY(SvSMAGICAL(ARG0_SV))) {
827 SvREFCNT_dec_NN(ARG0_SV);
831 case SAVEt_GENERIC_PVREF: /* generic pv */
832 if (*ARG0_PVP != ARG1_PV) {
837 case SAVEt_SHARED_PVREF: /* shared pv */
838 if (*ARG1_PVP != ARG0_PV) {
840 PerlMem_free(*ARG1_PVP);
842 PerlMemShared_free(*ARG1_PVP);
847 case SAVEt_GVSV: /* scalar slot in GV */
848 svp = &GvSV(ARG1_GV);
850 case SAVEt_GENERIC_SVREF: /* generic sv */
854 SV * const sv = *svp;
857 SvREFCNT_dec(ARG0_SV);
860 case SAVEt_GVSLOT: /* any slot in GV */
862 HV *const hv = GvSTASH(ARG2_GV);
864 if (hv && HvENAME(hv) && (
865 (ARG0_SV && SvTYPE(ARG0_SV) == SVt_PVCV)
866 || (*svp && SvTYPE(*svp) == SVt_PVCV)
869 if ((char *)svp < (char *)GvGP(ARG2_GV)
870 || (char *)svp > (char *)GvGP(ARG2_GV) + sizeof(struct gp)
871 || GvREFCNT(ARG2_GV) > 2) /* "> 2" to ignore savestack's ref */
873 else mro_method_changed_in(hv);
877 case SAVEt_AV: /* array reference */
878 SvREFCNT_dec(GvAV(ARG1_GV));
879 GvAV(ARG1_GV) = ARG0_AV;
880 if (UNLIKELY(SvSMAGICAL(ARG0_SV))) {
885 SvREFCNT_dec_NN(ARG1_GV);
887 case SAVEt_HV: /* hash reference */
888 SvREFCNT_dec(GvHV(ARG1_GV));
889 GvHV(ARG1_GV) = ARG0_HV;
890 if (UNLIKELY(SvSMAGICAL(ARG0_SV))) {
895 SvREFCNT_dec_NN(ARG1_GV);
897 case SAVEt_INT_SMALL:
898 *(int*)ARG0_PTR = (int)(uv >> SAVE_TIGHT_SHIFT);
900 case SAVEt_INT: /* int reference */
901 *(int*)ARG0_PTR = (int)ARG1_I32;
903 case SAVEt_STRLEN: /* STRLEN/size_t ref */
904 *(STRLEN*)ARG0_PTR = (STRLEN)arg1.any_iv;
906 case SAVEt_BOOL: /* bool reference */
907 *(bool*)ARG0_PTR = cBOOL(uv >> 8);
908 #ifdef NO_TAINT_SUPPORT
909 PERL_UNUSED_VAR(was);
911 if (UNLIKELY(ARG0_PTR == &(TAINT_get))) {
912 /* If we don't update <was>, to reflect what was saved on the
913 * stack for PL_tainted, then we will overwrite this attempt to
914 * restore it when we exit this routine. Note that this won't
915 * work if this value was saved in a wider-than necessary type,
917 was = *(bool*)ARG0_PTR;
921 case SAVEt_I32_SMALL:
922 *(I32*)ARG0_PTR = (I32)(uv >> SAVE_TIGHT_SHIFT);
924 case SAVEt_I32: /* I32 reference */
925 #ifdef PERL_DEBUG_READONLY_OPS
926 if (*(I32*)ARG0_PTR != ARG1_I32)
928 *(I32*)ARG0_PTR = ARG1_I32;
930 case SAVEt_SPTR: /* SV* reference */
931 *(SV**)(ARG0_PTR)= ARG1_SV;
933 case SAVEt_VPTR: /* random* reference */
934 case SAVEt_PPTR: /* char* reference */
937 case SAVEt_HPTR: /* HV* reference */
938 *(HV**)ARG0_PTR = MUTABLE_HV(ARG1_PTR);
940 case SAVEt_APTR: /* AV* reference */
941 *(AV**)ARG0_PTR = ARG1_AV;
943 case SAVEt_GP: /* scalar reference */
946 /* possibly taking a method out of circulation */
947 const bool had_method = !!GvCVu(ARG1_GV);
949 GvGP_set(ARG1_GV, (GP*)ARG0_PTR);
950 if ((hv=GvSTASH(ARG1_GV)) && HvENAME_get(hv)) {
951 if ( GvNAMELEN(ARG1_GV) == 3
952 && strnEQ(GvNAME(ARG1_GV), "ISA", 3)
954 mro_isa_changed_in(hv);
955 else if (had_method || GvCVu(ARG1_GV))
956 /* putting a method back into circulation ("local")*/
957 gv_method_changed(ARG1_GV);
959 SvREFCNT_dec_NN(ARG1_GV);
963 SvREFCNT_dec(ARG0_SV);
965 case SAVEt_FREEPADNAME:
966 PadnameREFCNT_dec((PADNAME *)ARG0_PTR);
968 case SAVEt_FREECOPHH:
969 cophh_free((COPHH *)ARG0_PTR);
971 case SAVEt_MORTALIZESV:
975 ASSERT_CURPAD_LEGAL("SAVEt_FREEOP");
976 op_free((OP*)ARG0_PTR);
982 case SAVEt_CLEARPADRANGE:
983 i = (I32)((uv >> SAVE_TIGHT_SHIFT) & OPpPADRANGE_COUNTMASK);
984 svp = &PL_curpad[uv >>
985 (OPpPADRANGE_COUNTSHIFT + SAVE_TIGHT_SHIFT)] + i - 1;
988 svp = &PL_curpad[uv >> SAVE_TIGHT_SHIFT];
991 for (; i; i--, svp--) {
994 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
995 "Pad 0x%"UVxf"[0x%"UVxf"] clearsv: %ld sv=0x%"UVxf"<%"IVdf"> %s\n",
996 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
997 (long)(svp-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
998 (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
1001 /* Can clear pad variable in place? */
1002 if (SvREFCNT(sv) == 1 && !SvOBJECT(sv)) {
1004 /* these flags are the union of all the relevant flags
1005 * in the individual conditions within */
1006 if (UNLIKELY(SvFLAGS(sv) & (
1007 SVf_READONLY|SVf_PROTECT /*for SvREADONLY_off*/
1008 | (SVs_GMG|SVs_SMG|SVs_RMG) /* SvMAGICAL() */
1012 /* if a my variable that was made readonly is
1013 * going out of scope, we want to remove the
1014 * readonlyness so that it can go out of scope
1020 if (SvOOK(sv)) { /* OOK or HvAUX */
1021 if (SvTYPE(sv) == SVt_PVHV)
1022 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
1027 if (SvMAGICAL(sv)) {
1028 /* note that backrefs (either in HvAUX or magic)
1029 * must be removed before other magic */
1030 sv_unmagic(sv, PERL_MAGIC_backref);
1031 if (SvTYPE(sv) != SVt_PVCV)
1034 if (SvTHINKFIRST(sv))
1035 sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF
1039 switch (SvTYPE(sv)) {
1043 av_clear(MUTABLE_AV(sv));
1046 hv_clear(MUTABLE_HV(sv));
1052 ? CvNAME_HEK((CV *)sv)
1053 : GvNAME_HEK(CvGV(sv));
1055 (void)share_hek_hek(hek);
1057 CvNAME_HEK_set(sv, hek);
1062 /* This looks odd, but these two macros are for use in
1063 expressions and finish with a trailing comma, so
1064 adding a ; after them would be wrong. */
1067 SvFLAGS(sv) &=~ (SVf_OK|SVf_IVisUV|SVf_UTF8);
1071 SvPADSTALE_on(sv); /* mark as no longer live */
1073 else { /* Someone has a claim on this, so abandon it. */
1074 switch (SvTYPE(sv)) { /* Console ourselves with a new value */
1075 case SVt_PVAV: *svp = MUTABLE_SV(newAV()); break;
1076 case SVt_PVHV: *svp = MUTABLE_SV(newHV()); break;
1079 HEK * const hek = CvNAMED(sv)
1080 ? CvNAME_HEK((CV *)sv)
1081 : GvNAME_HEK(CvGV(sv));
1084 *svp = newSV_type(SVt_PVCV);
1087 CvNAME_HEK_set(*svp,
1088 share_hek_hek(hek));
1092 default: *svp = newSV(0); break;
1094 SvREFCNT_dec_NN(sv); /* Cast current value to the winds. */
1095 /* preserve pad nature, but also mark as not live
1096 * for any closure capturing */
1097 SvFLAGS(*svp) |= SVs_PADSTALE;
1102 (void)hv_delete(ARG0_HV, ARG2_PV, ARG1_I32, G_DISCARD);
1103 SvREFCNT_dec(ARG0_HV);
1104 Safefree(arg2.any_ptr);
1107 (void)av_delete(ARG0_AV, arg1.any_iv, G_DISCARD);
1108 SvREFCNT_dec(ARG0_AV);
1110 case SAVEt_DESTRUCTOR_X:
1111 (*arg1.any_dxptr)(aTHX_ ARG0_PTR);
1113 case SAVEt_REGCONTEXT:
1114 /* regexp must have croaked */
1116 PL_savestack_ix -= uv >> SAVE_TIGHT_SHIFT;
1118 case SAVEt_STACK_POS: /* Position on Perl stack */
1119 PL_stack_sp = PL_stack_base + arg0.any_i32;
1121 case SAVEt_AELEM: /* array element */
1122 svp = av_fetch(ARG2_AV, arg1.any_iv, 1);
1123 if (UNLIKELY(!AvREAL(ARG2_AV) && AvREIFY(ARG2_AV))) /* undo reify guard */
1124 SvREFCNT_dec(ARG0_SV);
1126 SV * const sv = *svp;
1127 if (LIKELY(sv && sv != &PL_sv_undef)) {
1128 if (UNLIKELY(SvTIED_mg((const SV *)ARG2_AV, PERL_MAGIC_tied)))
1129 SvREFCNT_inc_void_NN(sv);
1134 SvREFCNT_dec(ARG2_AV);
1135 SvREFCNT_dec(ARG0_SV);
1137 case SAVEt_HELEM: /* hash element */
1139 HE * const he = hv_fetch_ent(ARG2_HV, ARG1_SV, 1, 0);
1140 SvREFCNT_dec(ARG1_SV);
1142 const SV * const oval = HeVAL(he);
1143 if (LIKELY(oval && oval != &PL_sv_undef)) {
1145 if (UNLIKELY(SvTIED_mg((const SV *)ARG2_HV, PERL_MAGIC_tied)))
1146 SvREFCNT_inc_void(*svp);
1147 refsv = ARG2_SV; /* what to refcnt_dec */
1151 SvREFCNT_dec(ARG2_HV);
1152 SvREFCNT_dec(ARG0_SV);
1156 PL_op = (OP*)ARG0_PTR;
1159 if ((PL_hints & HINT_LOCALIZE_HH)) {
1160 while (GvHV(PL_hintgv)) {
1161 HV *hv = GvHV(PL_hintgv);
1162 GvHV(PL_hintgv) = NULL;
1163 SvREFCNT_dec(MUTABLE_SV(hv));
1166 cophh_free(CopHINTHASH_get(&PL_compiling));
1167 CopHINTHASH_set(&PL_compiling, (COPHH*)ARG0_PTR);
1168 *(I32*)&PL_hints = ARG1_I32;
1169 if (PL_hints & HINT_LOCALIZE_HH) {
1170 SvREFCNT_dec(MUTABLE_SV(GvHV(PL_hintgv)));
1171 GvHV(PL_hintgv) = MUTABLE_HV(SSPOPPTR);
1173 if (!GvHV(PL_hintgv)) {
1174 /* Need to add a new one manually, else rv2hv can
1175 add one via GvHVn and it won't have the magic set. */
1176 HV *const hv = newHV();
1177 hv_magic(hv, NULL, PERL_MAGIC_hints);
1178 GvHV(PL_hintgv) = hv;
1180 assert(GvHV(PL_hintgv));
1183 PL_comppad = (PAD*)ARG0_PTR;
1184 if (LIKELY(PL_comppad))
1185 PL_curpad = AvARRAY(PL_comppad);
1189 case SAVEt_PADSV_AND_MORTALIZE:
1193 svp = AvARRAY((PAD*)ARG1_PTR) + (PADOFFSET)arg0.any_uv;
1194 /* This mortalizing used to be done by POPLOOP() via itersave.
1195 But as we have all the information here, we can do it here,
1196 save even having to have itersave in the struct. */
1201 case SAVEt_SAVESWITCHSTACK:
1204 SWITCHSTACK(ARG0_AV, ARG1_AV);
1205 PL_curstackinfo->si_stack = ARG1_AV;
1208 case SAVEt_SET_SVFLAGS:
1209 SvFLAGS(ARG2_SV) &= ~((U32)ARG1_I32);
1210 SvFLAGS(ARG2_SV) |= (U32)ARG0_I32;
1213 /* These are only saved in mathoms.c */
1215 (void)sv_clear(ARG0_SV);
1217 case SAVEt_LONG: /* long reference */
1218 *(long*)ARG0_PTR = arg1.any_long;
1220 case SAVEt_IV: /* IV reference */
1221 *(IV*)ARG0_PTR = arg1.any_iv;
1224 case SAVEt_I16: /* I16 reference */
1225 *(I16*)ARG0_PTR = (I16)(uv >> 8);
1227 case SAVEt_I8: /* I8 reference */
1228 *(I8*)ARG0_PTR = (I8)(uv >> 8);
1230 case SAVEt_DESTRUCTOR:
1231 (*arg1.any_dptr)(ARG0_PTR);
1233 case SAVEt_COMPILE_WARNINGS:
1234 if (!specialWARN(PL_compiling.cop_warnings))
1235 PerlMemShared_free(PL_compiling.cop_warnings);
1237 PL_compiling.cop_warnings = (STRLEN*)ARG0_PTR;
1240 parser_free((yy_parser *) ARG0_PTR);
1242 case SAVEt_READONLY_OFF:
1243 SvREADONLY_off(ARG0_SV);
1246 Perl_croak(aTHX_ "panic: leave_scope inconsistency %u", type);
1254 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1256 PERL_ARGS_ASSERT_CX_DUMP;
1259 PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1260 if (CxTYPE(cx) != CXt_SUBST) {
1261 const char *gimme_text;
1262 PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1263 PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
1264 PTR2UV(cx->blk_oldcop));
1265 PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1266 PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1267 PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
1268 PTR2UV(cx->blk_oldpm));
1269 switch (cx->blk_gimme) {
1271 gimme_text = "VOID";
1274 gimme_text = "SCALAR";
1277 gimme_text = "LIST";
1280 gimme_text = "UNKNOWN";
1283 PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", gimme_text);
1285 switch (CxTYPE(cx)) {
1290 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.CV = 0x%"UVxf"\n",
1291 PTR2UV(cx->blk_format.cv));
1292 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.GV = 0x%"UVxf"\n",
1293 PTR2UV(cx->blk_format.gv));
1294 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.DFOUTGV = 0x%"UVxf"\n",
1295 PTR2UV(cx->blk_format.dfoutgv));
1296 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.HASARGS = %d\n",
1297 (int)CxHASARGS(cx));
1298 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.RETOP = 0x%"UVxf"\n",
1299 PTR2UV(cx->blk_format.retop));
1302 PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1303 PTR2UV(cx->blk_sub.cv));
1304 PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1305 (long)cx->blk_sub.olddepth);
1306 PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1307 (int)CxHASARGS(cx));
1308 PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n", (int)CxLVAL(cx));
1309 PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1310 PTR2UV(cx->blk_sub.retop));
1313 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1314 (long)CxOLD_IN_EVAL(cx));
1315 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1316 PL_op_name[CxOLD_OP_TYPE(cx)],
1317 PL_op_desc[CxOLD_OP_TYPE(cx)]);
1318 if (cx->blk_eval.old_namesv)
1319 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1320 SvPVX_const(cx->blk_eval.old_namesv));
1321 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1322 PTR2UV(cx->blk_eval.old_eval_root));
1323 PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%"UVxf"\n",
1324 PTR2UV(cx->blk_eval.retop));
1327 case CXt_LOOP_LAZYIV:
1328 case CXt_LOOP_LAZYSV:
1330 case CXt_LOOP_PLAIN:
1331 PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n", CxLABEL(cx));
1332 PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
1333 (long)cx->blk_loop.resetsp);
1334 PerlIO_printf(Perl_debug_log, "BLK_LOOP.MY_OP = 0x%"UVxf"\n",
1335 PTR2UV(cx->blk_loop.my_op));
1336 /* XXX: not accurate for LAZYSV/IV */
1337 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1338 PTR2UV(cx->blk_loop.state_u.ary.ary));
1339 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1340 (long)cx->blk_loop.state_u.ary.ix);
1341 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1342 PTR2UV(CxITERVAR(cx)));
1346 PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1347 (long)cx->sb_iters);
1348 PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1349 (long)cx->sb_maxiters);
1350 PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1351 (long)cx->sb_rflags);
1352 PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1354 PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1356 PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1357 PTR2UV(cx->sb_dstr));
1358 PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1359 PTR2UV(cx->sb_targ));
1360 PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1362 PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1364 PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1365 PTR2UV(cx->sb_strend));
1366 PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1367 PTR2UV(cx->sb_rxres));
1371 PERL_UNUSED_CONTEXT;
1372 PERL_UNUSED_ARG(cx);
1373 #endif /* DEBUGGING */
1377 * ex: set ts=8 sts=4 sw=4 et: