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)
33 SSize_t current = (p - PL_stack_base);
35 PERL_ARGS_ASSERT_STACK_GROW;
39 "panic: stack_grow() negative count (%" IVdf ")", (IV)n);
48 /* If the total might wrap, panic instead. This is really testing
49 * that (current + n + extra < SSize_t_MAX), but done in a way that
51 if (UNLIKELY( current > SSize_t_MAX - extra
52 || current + extra > SSize_t_MAX - n
54 /* diag_listed_as: Out of memory during %s extend */
55 Perl_croak(aTHX_ "Out of memory during stack extend");
57 av_extend(PL_curstack, current + n + extra);
61 #ifndef STRESS_REALLOC
62 #define GROW(old) ((old) * 3 / 2)
64 #define GROW(old) ((old) + 1)
68 Perl_new_stackinfo(pTHX_ I32 stitems, I32 cxitems)
72 si->si_stack = newAV();
73 AvREAL_off(si->si_stack);
74 av_extend(si->si_stack, stitems > 0 ? stitems-1 : 0);
75 AvALLOC(si->si_stack)[0] = &PL_sv_undef;
76 AvFILLp(si->si_stack) = 0;
79 si->si_cxmax = cxitems - 1;
81 si->si_type = PERLSI_UNDEF;
82 Newx(si->si_cxstack, cxitems, PERL_CONTEXT);
83 /* Without any kind of initialising CX_PUSHSUBST()
84 * in pp_subst() will read uninitialised heap. */
85 PoisonNew(si->si_cxstack, cxitems, PERL_CONTEXT);
92 const IV old_max = cxstack_max;
93 const IV new_max = GROW(cxstack_max);
94 Renew(cxstack, new_max + 1, PERL_CONTEXT);
95 cxstack_max = new_max;
96 /* Without any kind of initialising deep enough recursion
97 * will end up reading uninitialised PERL_CONTEXTs. */
98 PoisonNew(cxstack + old_max + 1, new_max - old_max, PERL_CONTEXT);
99 return cxstack_ix + 1;
103 Perl_push_scope(pTHX)
105 if (UNLIKELY(PL_scopestack_ix == PL_scopestack_max)) {
106 const IV new_max = GROW(PL_scopestack_max);
107 Renew(PL_scopestack, new_max, I32);
109 Renew(PL_scopestack_name, new_max, const char*);
111 PL_scopestack_max = new_max;
114 PL_scopestack_name[PL_scopestack_ix] = "unknown";
116 PL_scopestack[PL_scopestack_ix++] = PL_savestack_ix;
123 const I32 oldsave = PL_scopestack[--PL_scopestack_ix];
124 LEAVE_SCOPE(oldsave);
128 Perl_markstack_grow(pTHX)
130 const I32 oldmax = PL_markstack_max - PL_markstack;
131 const I32 newmax = GROW(oldmax);
133 Renew(PL_markstack, newmax, I32);
134 PL_markstack_max = PL_markstack + newmax;
135 PL_markstack_ptr = PL_markstack + oldmax;
136 DEBUG_s(DEBUG_v(PerlIO_printf(Perl_debug_log,
137 "MARK grow %p %" IVdf " by %" IVdf "\n",
138 PL_markstack_ptr, (IV)*PL_markstack_ptr, (IV)oldmax)));
139 return PL_markstack_ptr;
143 Perl_savestack_grow(pTHX)
146 #ifdef STRESS_REALLOC
147 new_max = PL_savestack_max + SS_MAXPUSH;
149 new_max = GROW(PL_savestack_max);
151 /* Note that we allocate SS_MAXPUSH slots higher than ss_max
152 * so that SS_ADD_END(), SSGROW() etc can do a simper check */
153 Renew(PL_savestack, new_max + SS_MAXPUSH, ANY);
154 PL_savestack_max = new_max;
158 Perl_savestack_grow_cnt(pTHX_ I32 need)
160 const IV new_max = PL_savestack_ix + need;
161 /* Note that we allocate SS_MAXPUSH slots higher than ss_max
162 * so that SS_ADD_END(), SSGROW() etc can do a simper check */
163 Renew(PL_savestack, new_max + SS_MAXPUSH, ANY);
164 PL_savestack_max = new_max;
169 /* The original function was called Perl_tmps_grow and was removed from public
170 API, Perl_tmps_grow_p is the replacement and it used in public macros but
173 Perl_tmps_grow_p takes a proposed ix. A proposed ix is PL_tmps_ix + extend_by,
174 where the result of (PL_tmps_ix + extend_by) is >= PL_tmps_max
175 Upon return, PL_tmps_stack[ix] will be a valid address. For machine code
176 optimization and register usage reasons, the proposed ix passed into
177 tmps_grow is returned to the caller which the caller can then use to write
178 an SV * to PL_tmps_stack[ix]. If the caller was using tmps_grow in
179 pre-extend mode (EXTEND_MORTAL macro), then it ignores the return value of
180 tmps_grow. Note, tmps_grow DOES NOT write ix to PL_tmps_ix, the caller
181 must assign ix or ret val of tmps_grow to PL_temps_ix themselves if that is
182 appropriate. The assignment to PL_temps_ix can happen before or after
183 tmps_grow call since tmps_grow doesn't look at PL_tmps_ix.
187 Perl_tmps_grow_p(pTHX_ SSize_t ix)
189 SSize_t extend_to = ix;
190 #ifndef STRESS_REALLOC
191 if (ix - PL_tmps_max < 128)
192 extend_to += (PL_tmps_max < 512) ? 128 : 512;
194 Renew(PL_tmps_stack, extend_to + 1, SV*);
195 PL_tmps_max = extend_to + 1;
203 /* XXX should tmps_floor live in cxstack? */
204 const SSize_t myfloor = PL_tmps_floor;
205 while (PL_tmps_ix > myfloor) { /* clean up after last statement */
206 SV* const sv = PL_tmps_stack[PL_tmps_ix--];
208 PoisonWith(PL_tmps_stack + PL_tmps_ix + 1, 1, SV *, 0xAB);
212 SvREFCNT_dec_NN(sv); /* note, can modify tmps_ix!!! */
218 S_save_scalar_at(pTHX_ SV **sptr, const U32 flags)
223 PERL_ARGS_ASSERT_SAVE_SCALAR_AT;
226 if (flags & SAVEf_KEEPOLDELEM)
229 sv = (*sptr = newSV(0));
230 if (SvTYPE(osv) >= SVt_PVMG && SvMAGIC(osv))
231 mg_localize(osv, sv, cBOOL(flags & SAVEf_SETMAGIC));
238 Perl_save_pushptrptr(pTHX_ void *const ptr1, void *const ptr2, const int type)
248 Perl_save_scalar(pTHX_ GV *gv)
250 SV ** const sptr = &GvSVn(gv);
252 PERL_ARGS_ASSERT_SAVE_SCALAR;
254 if (UNLIKELY(SvGMAGICAL(*sptr))) {
259 save_pushptrptr(SvREFCNT_inc_simple(gv), SvREFCNT_inc(*sptr), SAVEt_SV);
260 return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
263 /* Like save_sptr(), but also SvREFCNT_dec()s the new value. Can be used to
264 * restore a global SV to its prior contents, freeing new value. */
266 Perl_save_generic_svref(pTHX_ SV **sptr)
268 PERL_ARGS_ASSERT_SAVE_GENERIC_SVREF;
270 save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_GENERIC_SVREF);
273 /* Like save_pptr(), but also Safefree()s the new value if it is different
274 * from the old one. Can be used to restore a global char* to its prior
275 * contents, freeing new value. */
277 Perl_save_generic_pvref(pTHX_ char **str)
279 PERL_ARGS_ASSERT_SAVE_GENERIC_PVREF;
281 save_pushptrptr(*str, str, SAVEt_GENERIC_PVREF);
284 /* Like save_generic_pvref(), but uses PerlMemShared_free() rather than Safefree().
285 * Can be used to restore a shared global char* to its prior
286 * contents, freeing new value. */
288 Perl_save_shared_pvref(pTHX_ char **str)
290 PERL_ARGS_ASSERT_SAVE_SHARED_PVREF;
292 save_pushptrptr(str, *str, SAVEt_SHARED_PVREF);
295 /* set the SvFLAGS specified by mask to the values in val */
298 Perl_save_set_svflags(pTHX_ SV* sv, U32 mask, U32 val)
302 PERL_ARGS_ASSERT_SAVE_SET_SVFLAGS;
307 SS_ADD_UV(SAVEt_SET_SVFLAGS);
314 Saves the current GP of gv on the save stack to be restored on scope exit.
316 If empty is true, replace the GP with a new GP.
318 If empty is false, mark gv with GVf_INTRO so the next reference
319 assigned is localized, which is how C< local *foo = $someref; > works.
325 Perl_save_gp(pTHX_ GV *gv, I32 empty)
327 PERL_ARGS_ASSERT_SAVE_GP;
329 save_pushptrptr(SvREFCNT_inc(gv), GvGP(gv), SAVEt_GP);
332 GP *gp = Perl_newGP(aTHX_ gv);
333 HV * const stash = GvSTASH(gv);
334 bool isa_changed = 0;
336 if (stash && HvENAME(stash)) {
337 if (GvNAMELEN(gv) == 3 && strnEQ(GvNAME(gv), "ISA", 3))
340 /* taking a method out of circulation ("local")*/
341 mro_method_changed_in(stash);
343 if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
345 IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
348 if (isa_changed) mro_isa_changed_in(stash);
357 Perl_save_ary(pTHX_ GV *gv)
359 AV * const oav = GvAVn(gv);
362 PERL_ARGS_ASSERT_SAVE_ARY;
364 if (UNLIKELY(!AvREAL(oav) && AvREIFY(oav)))
366 save_pushptrptr(SvREFCNT_inc_simple_NN(gv), oav, SAVEt_AV);
370 if (UNLIKELY(SvMAGIC(oav)))
371 mg_localize(MUTABLE_SV(oav), MUTABLE_SV(av), TRUE);
376 Perl_save_hash(pTHX_ GV *gv)
380 PERL_ARGS_ASSERT_SAVE_HASH;
383 SvREFCNT_inc_simple_NN(gv), (ohv = GvHVn(gv)), SAVEt_HV
388 if (UNLIKELY(SvMAGIC(ohv)))
389 mg_localize(MUTABLE_SV(ohv), MUTABLE_SV(hv), TRUE);
394 Perl_save_item(pTHX_ SV *item)
396 SV * const sv = newSVsv(item);
398 PERL_ARGS_ASSERT_SAVE_ITEM;
400 save_pushptrptr(item, /* remember the pointer */
401 sv, /* remember the value */
406 Perl_save_bool(pTHX_ bool *boolp)
410 PERL_ARGS_ASSERT_SAVE_BOOL;
413 SS_ADD_UV(SAVEt_BOOL | (*boolp << 8));
418 Perl_save_pushi32ptr(pTHX_ const I32 i, void *const ptr, const int type)
429 Perl_save_int(pTHX_ int *intp)
432 UV type = ((UV)((UV)i << SAVE_TIGHT_SHIFT) | SAVEt_INT_SMALL);
436 PERL_ARGS_ASSERT_SAVE_INT;
438 if (UNLIKELY((int)(type >> SAVE_TIGHT_SHIFT) != i)) {
449 Perl_save_I8(pTHX_ I8 *bytep)
453 PERL_ARGS_ASSERT_SAVE_I8;
456 SS_ADD_UV(SAVEt_I8 | ((UV)*bytep << 8));
461 Perl_save_I16(pTHX_ I16 *intp)
465 PERL_ARGS_ASSERT_SAVE_I16;
468 SS_ADD_UV(SAVEt_I16 | ((UV)*intp << 8));
473 Perl_save_I32(pTHX_ I32 *intp)
476 UV type = ((I32)((U32)i << SAVE_TIGHT_SHIFT) | SAVEt_I32_SMALL);
480 PERL_ARGS_ASSERT_SAVE_I32;
482 if (UNLIKELY((I32)(type >> SAVE_TIGHT_SHIFT) != i)) {
493 Perl_save_strlen(pTHX_ STRLEN *ptr)
497 PERL_ARGS_ASSERT_SAVE_STRLEN;
501 SS_ADD_UV(SAVEt_STRLEN);
506 Perl_save_iv(pTHX_ IV *ivp)
508 PERL_ARGS_ASSERT_SAVE_IV;
516 /* Cannot use save_sptr() to store a char* since the SV** cast will
517 * force word-alignment and we'll miss the pointer.
520 Perl_save_pptr(pTHX_ char **pptr)
522 PERL_ARGS_ASSERT_SAVE_PPTR;
524 save_pushptrptr(*pptr, pptr, SAVEt_PPTR);
528 Perl_save_vptr(pTHX_ void *ptr)
530 PERL_ARGS_ASSERT_SAVE_VPTR;
532 save_pushptrptr(*(char**)ptr, ptr, SAVEt_VPTR);
536 Perl_save_sptr(pTHX_ SV **sptr)
538 PERL_ARGS_ASSERT_SAVE_SPTR;
540 save_pushptrptr(*sptr, sptr, SAVEt_SPTR);
544 Perl_save_padsv_and_mortalize(pTHX_ PADOFFSET off)
548 ASSERT_CURPAD_ACTIVE("save_padsv");
549 SS_ADD_PTR(SvREFCNT_inc_simple_NN(PL_curpad[off]));
550 SS_ADD_PTR(PL_comppad);
552 SS_ADD_UV(SAVEt_PADSV_AND_MORTALIZE);
557 Perl_save_hptr(pTHX_ HV **hptr)
559 PERL_ARGS_ASSERT_SAVE_HPTR;
561 save_pushptrptr(*hptr, hptr, SAVEt_HPTR);
565 Perl_save_aptr(pTHX_ AV **aptr)
567 PERL_ARGS_ASSERT_SAVE_APTR;
569 save_pushptrptr(*aptr, aptr, SAVEt_APTR);
573 Perl_save_pushptr(pTHX_ void *const ptr, const int type)
582 Perl_save_clearsv(pTHX_ SV **svp)
584 const UV offset = svp - PL_curpad;
585 const UV offset_shifted = offset << SAVE_TIGHT_SHIFT;
587 PERL_ARGS_ASSERT_SAVE_CLEARSV;
589 ASSERT_CURPAD_ACTIVE("save_clearsv");
590 SvPADSTALE_off(*svp); /* mark lexical as active */
591 if (UNLIKELY((offset_shifted >> SAVE_TIGHT_SHIFT) != offset)) {
592 Perl_croak(aTHX_ "panic: pad offset %" UVuf " out of range (%p-%p)",
593 offset, svp, PL_curpad);
598 SS_ADD_UV(offset_shifted | SAVEt_CLEARSV);
604 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
606 PERL_ARGS_ASSERT_SAVE_DELETE;
608 save_pushptri32ptr(key, klen, SvREFCNT_inc_simple(hv), SAVEt_DELETE);
612 Perl_save_hdelete(pTHX_ HV *hv, SV *keysv)
618 PERL_ARGS_ASSERT_SAVE_HDELETE;
620 key = SvPV_const(keysv, len);
621 klen = SvUTF8(keysv) ? -(I32)len : (I32)len;
622 SvREFCNT_inc_simple_void_NN(hv);
623 save_pushptri32ptr(savepvn(key, len), klen, hv, SAVEt_DELETE);
627 Perl_save_adelete(pTHX_ AV *av, SSize_t key)
631 PERL_ARGS_ASSERT_SAVE_ADELETE;
633 SvREFCNT_inc_void(av);
636 SS_ADD_IV(SAVEt_ADELETE);
641 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
644 PERL_ARGS_ASSERT_SAVE_DESTRUCTOR;
648 SS_ADD_UV(SAVEt_DESTRUCTOR);
653 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
659 SS_ADD_UV(SAVEt_DESTRUCTOR_X);
664 Perl_save_hints(pTHX)
666 COPHH *save_cophh = cophh_copy(CopHINTHASH_get(&PL_compiling));
667 if (PL_hints & HINT_LOCALIZE_HH) {
668 HV *oldhh = GvHV(PL_hintgv);
669 save_pushptri32ptr(oldhh, PL_hints, save_cophh, SAVEt_HINTS);
670 GvHV(PL_hintgv) = NULL; /* in case copying dies */
671 GvHV(PL_hintgv) = hv_copy_hints_hv(oldhh);
673 save_pushi32ptr(PL_hints, save_cophh, SAVEt_HINTS);
678 S_save_pushptri32ptr(pTHX_ void *const ptr1, const I32 i, void *const ptr2,
690 Perl_save_aelem_flags(pTHX_ AV *av, SSize_t idx, SV **sptr,
696 PERL_ARGS_ASSERT_SAVE_AELEM_FLAGS;
699 SS_ADD_PTR(SvREFCNT_inc_simple(av));
701 SS_ADD_PTR(SvREFCNT_inc(*sptr));
702 SS_ADD_UV(SAVEt_AELEM);
704 /* The array needs to hold a reference count on its new element, so it
706 if (UNLIKELY(!AvREAL(av) && AvREIFY(av)))
708 save_scalar_at(sptr, flags); /* XXX - FIXME - see #60360 */
709 if (flags & SAVEf_KEEPOLDELEM)
712 /* If we're localizing a tied array element, this new sv
713 * won't actually be stored in the array - so it won't get
714 * reaped when the localize ends. Ensure it gets reaped by
715 * mortifying it instead. DAPM */
716 if (UNLIKELY(SvTIED_mg((const SV *)av, PERL_MAGIC_tied)))
721 Perl_save_helem_flags(pTHX_ HV *hv, SV *key, SV **sptr, const U32 flags)
725 PERL_ARGS_ASSERT_SAVE_HELEM_FLAGS;
730 SS_ADD_PTR(SvREFCNT_inc_simple(hv));
731 SS_ADD_PTR(newSVsv(key));
732 SS_ADD_PTR(SvREFCNT_inc(*sptr));
733 SS_ADD_UV(SAVEt_HELEM);
736 save_scalar_at(sptr, flags);
737 if (flags & SAVEf_KEEPOLDELEM)
740 /* If we're localizing a tied hash element, this new sv
741 * won't actually be stored in the hash - so it won't get
742 * reaped when the localize ends. Ensure it gets reaped by
743 * mortifying it instead. DAPM */
744 if (UNLIKELY(SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)))
749 Perl_save_svref(pTHX_ SV **sptr)
751 PERL_ARGS_ASSERT_SAVE_SVREF;
754 save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_SVREF);
755 return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
763 SS_ADD_IV(PL_tmps_floor);
764 PL_tmps_floor = PL_tmps_ix;
765 SS_ADD_UV(SAVEt_TMPSFLOOR);
771 Perl_save_alloc(pTHX_ I32 size, I32 pad)
773 const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
774 - (char*)PL_savestack);
775 const UV elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
776 const UV elems_shifted = elems << SAVE_TIGHT_SHIFT;
778 if (UNLIKELY((elems_shifted >> SAVE_TIGHT_SHIFT) != elems))
780 "panic: save_alloc elems %" UVuf " out of range (%" IVdf "-%" IVdf ")",
781 elems, (IV)size, (IV)pad);
785 PL_savestack_ix += elems;
786 SSPUSHUV(SAVEt_ALLOC | elems_shifted);
791 static const U8 arg_counts[] = {
793 0, /* SAVEt_CLEARPADRANGE */
794 0, /* SAVEt_CLEARSV */
795 0, /* SAVEt_REGCONTEXT */
796 1, /* SAVEt_TMPSFLOOR */
798 1, /* SAVEt_COMPILE_WARNINGS */
799 1, /* SAVEt_COMPPAD */
800 1, /* SAVEt_FREECOPHH */
801 1, /* SAVEt_FREEOP */
802 1, /* SAVEt_FREEPV */
803 1, /* SAVEt_FREESV */
805 1, /* SAVEt_I32_SMALL */
807 1, /* SAVEt_INT_SMALL */
808 1, /* SAVEt_MORTALIZESV */
811 1, /* SAVEt_PARSER */
812 1, /* SAVEt_STACK_POS */
813 1, /* SAVEt_READONLY_OFF */
814 1, /* SAVEt_FREEPADNAME */
816 2, /* SAVEt_DESTRUCTOR */
817 2, /* SAVEt_DESTRUCTOR_X */
818 2, /* SAVEt_GENERIC_PVREF */
819 2, /* SAVEt_GENERIC_SVREF */
831 2, /* SAVEt_SAVESWITCHSTACK */
832 2, /* SAVEt_SHARED_PVREF */
834 2, /* SAVEt_STRLEN */
838 2, /* SAVEt_ADELETE */
841 3, /* SAVEt_PADSV_AND_MORTALIZE*/
842 3, /* SAVEt_SET_SVFLAGS */
843 3, /* SAVEt_GVSLOT */
850 Perl_leave_scope(pTHX_ I32 base)
852 /* Localise the effects of the TAINT_NOT inside the loop. */
853 bool was = TAINT_get;
855 if (UNLIKELY(base < -1))
856 Perl_croak(aTHX_ "panic: corrupt saved stack index %ld", (long) base);
857 DEBUG_l(Perl_deb(aTHX_ "savestack: releasing items %ld -> %ld\n",
858 (long)PL_savestack_ix, (long)base));
859 while (PL_savestack_ix > base) {
862 ANY *ap; /* arg pointer */
863 ANY a0, a1, a2; /* up to 3 args */
869 I32 ix = PL_savestack_ix - 1;
871 ap = &PL_savestack[ix];
873 type = (U8)uv & SAVE_MASK;
874 argcount = arg_counts[type];
875 PL_savestack_ix = ix - argcount;
880 case SAVEt_ITEM: /* normal string */
881 a0 = ap[0]; a1 = ap[1];
882 sv_replace(a0.any_sv, a1.any_sv);
883 if (UNLIKELY(SvSMAGICAL(a0.any_sv))) {
890 /* This would be a mathom, but Perl_save_svref() calls a static
891 function, S_save_scalar_at(), so has to stay in this file. */
892 case SAVEt_SVREF: /* scalar reference */
893 a0 = ap[0]; a1 = ap[1];
894 a2.any_svp = a0.any_svp;
895 a0.any_sv = NULL; /* what to refcnt_dec */
898 case SAVEt_SV: /* scalar reference */
899 a0 = ap[0]; a1 = ap[1];
900 a2.any_svp = &GvSV(a0.any_gv);
903 /* do *a2.any_svp = a1 and free a0 */
904 SV * const sv = *a2.any_svp;
905 *a2.any_svp = a1.any_sv;
907 if (UNLIKELY(SvSMAGICAL(a1.any_sv))) {
908 /* mg_set could die, skipping the freeing of a0 and
909 * a1; Ensure that they're always freed in that case */
911 SS_ADD_PTR(a1.any_sv);
912 SS_ADD_UV(SAVEt_FREESV);
913 SS_ADD_PTR(a0.any_sv);
914 SS_ADD_UV(SAVEt_FREESV);
921 SvREFCNT_dec_NN(a1.any_sv);
922 SvREFCNT_dec(a0.any_sv);
926 case SAVEt_GENERIC_PVREF: /* generic pv */
927 a0 = ap[0]; a1 = ap[1];
928 if (*a1.any_pvp != a0.any_pv) {
929 Safefree(*a1.any_pvp);
930 *a1.any_pvp = a0.any_pv;
934 case SAVEt_SHARED_PVREF: /* shared pv */
935 a0 = ap[0]; a1 = ap[1];
936 if (*a0.any_pvp != a1.any_pv) {
938 PerlMem_free(*a0.any_pvp);
940 PerlMemShared_free(*a0.any_pvp);
942 *a0.any_pvp = a1.any_pv;
946 case SAVEt_GVSV: /* scalar slot in GV */
947 a0 = ap[0]; a1 = ap[1];
948 a0.any_svp = &GvSV(a0.any_gv);
951 case SAVEt_GENERIC_SVREF: /* generic sv */
952 a0 = ap[0]; a1 = ap[1];
955 /* do *a0.any_svp = a1 */
956 SV * const sv = *a0.any_svp;
957 *a0.any_svp = a1.any_sv;
959 SvREFCNT_dec(a1.any_sv);
963 case SAVEt_GVSLOT: /* any slot in GV */
966 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
967 hv = GvSTASH(a0.any_gv);
968 if (hv && HvENAME(hv) && (
969 (a2.any_sv && SvTYPE(a2.any_sv) == SVt_PVCV)
970 || (*a1.any_svp && SvTYPE(*a1.any_svp) == SVt_PVCV)
973 if ((char *)a1.any_svp < (char *)GvGP(a0.any_gv)
974 || (char *)a1.any_svp > (char *)GvGP(a0.any_gv) + sizeof(struct gp)
975 || GvREFCNT(a0.any_gv) > 2) /* "> 2" to ignore savestack's ref */
977 else mro_method_changed_in(hv);
979 a0.any_svp = a1.any_svp;
980 a1.any_sv = a2.any_sv;
984 case SAVEt_AV: /* array reference */
985 a0 = ap[0]; a1 = ap[1];
986 SvREFCNT_dec(GvAV(a0.any_gv));
987 GvAV(a0.any_gv) = a1.any_av;
989 if (UNLIKELY(SvSMAGICAL(a1.any_sv))) {
990 /* mg_set might die, so make sure a0 isn't leaked */
992 SS_ADD_PTR(a0.any_sv);
993 SS_ADD_UV(SAVEt_FREESV);
1000 SvREFCNT_dec_NN(a0.any_sv);
1003 case SAVEt_HV: /* hash reference */
1004 a0 = ap[0]; a1 = ap[1];
1005 SvREFCNT_dec(GvHV(a0.any_gv));
1006 GvHV(a0.any_gv) = a1.any_hv;
1009 case SAVEt_INT_SMALL:
1011 *(int*)a0.any_ptr = (int)(uv >> SAVE_TIGHT_SHIFT);
1014 case SAVEt_INT: /* int reference */
1015 a0 = ap[0]; a1 = ap[1];
1016 *(int*)a1.any_ptr = (int)a0.any_i32;
1019 case SAVEt_STRLEN: /* STRLEN/size_t ref */
1020 a0 = ap[0]; a1 = ap[1];
1021 *(STRLEN*)a1.any_ptr = (STRLEN)a0.any_iv;
1024 case SAVEt_TMPSFLOOR: /* restore PL_tmps_floor */
1026 PL_tmps_floor = (SSize_t)a0.any_iv;
1029 case SAVEt_BOOL: /* bool reference */
1031 *(bool*)a0.any_ptr = cBOOL(uv >> 8);
1032 #ifdef NO_TAINT_SUPPORT
1033 PERL_UNUSED_VAR(was);
1035 if (UNLIKELY(a0.any_ptr == &(TAINT_get))) {
1036 /* If we don't update <was>, to reflect what was saved on the
1037 * stack for PL_tainted, then we will overwrite this attempt to
1038 * restore it when we exit this routine. Note that this won't
1039 * work if this value was saved in a wider-than necessary type,
1041 was = *(bool*)a0.any_ptr;
1046 case SAVEt_I32_SMALL:
1048 *(I32*)a0.any_ptr = (I32)(uv >> SAVE_TIGHT_SHIFT);
1051 case SAVEt_I32: /* I32 reference */
1052 a0 = ap[0]; a1 = ap[1];
1053 #ifdef PERL_DEBUG_READONLY_OPS
1054 if (*(I32*)a1.any_ptr != a0.any_i32)
1056 *(I32*)a1.any_ptr = a0.any_i32;
1059 case SAVEt_SPTR: /* SV* reference */
1060 case SAVEt_VPTR: /* random* reference */
1061 case SAVEt_PPTR: /* char* reference */
1062 case SAVEt_HPTR: /* HV* reference */
1063 case SAVEt_APTR: /* AV* reference */
1064 a0 = ap[0]; a1 = ap[1];
1065 *a1.any_svp= a0.any_sv;
1068 case SAVEt_GP: /* scalar reference */
1073 a0 = ap[0]; a1 = ap[1];
1074 /* possibly taking a method out of circulation */
1075 had_method = !!GvCVu(a0.any_gv);
1077 GvGP_set(a0.any_gv, (GP*)a1.any_ptr);
1078 if ((hv=GvSTASH(a0.any_gv)) && HvENAME_get(hv)) {
1079 if ( GvNAMELEN(a0.any_gv) == 3
1080 && strnEQ(GvNAME(a0.any_gv), "ISA", 3)
1082 mro_isa_changed_in(hv);
1083 else if (had_method || GvCVu(a0.any_gv))
1084 /* putting a method back into circulation ("local")*/
1085 gv_method_changed(a0.any_gv);
1087 SvREFCNT_dec_NN(a0.any_gv);
1093 SvREFCNT_dec(a0.any_sv);
1096 case SAVEt_FREEPADNAME:
1098 PadnameREFCNT_dec((PADNAME *)a0.any_ptr);
1101 case SAVEt_FREECOPHH:
1103 cophh_free((COPHH *)a0.any_ptr);
1106 case SAVEt_MORTALIZESV:
1108 sv_2mortal(a0.any_sv);
1113 ASSERT_CURPAD_LEGAL("SAVEt_FREEOP");
1119 Safefree(a0.any_ptr);
1122 case SAVEt_CLEARPADRANGE:
1126 i = (I32)((uv >> SAVE_TIGHT_SHIFT) & OPpPADRANGE_COUNTMASK);
1127 svp = &PL_curpad[uv >>
1128 (OPpPADRANGE_COUNTSHIFT + SAVE_TIGHT_SHIFT)] + i - 1;
1131 svp = &PL_curpad[uv >> SAVE_TIGHT_SHIFT];
1134 for (; i; i--, svp--) {
1137 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1138 "Pad 0x%" UVxf "[0x%" UVxf "] clearsv: %ld sv=0x%" UVxf "<%" IVdf "> %s\n",
1139 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
1140 (long)(svp-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
1141 (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
1144 /* Can clear pad variable in place? */
1145 if (SvREFCNT(sv) == 1 && !SvOBJECT(sv)) {
1147 /* these flags are the union of all the relevant flags
1148 * in the individual conditions within */
1149 if (UNLIKELY(SvFLAGS(sv) & (
1150 SVf_READONLY|SVf_PROTECT /*for SvREADONLY_off*/
1151 | (SVs_GMG|SVs_SMG|SVs_RMG) /* SvMAGICAL() */
1155 /* if a my variable that was made readonly is
1156 * going out of scope, we want to remove the
1157 * readonlyness so that it can go out of scope
1163 if (SvOOK(sv)) { /* OOK or HvAUX */
1164 if (SvTYPE(sv) == SVt_PVHV)
1165 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
1170 if (SvMAGICAL(sv)) {
1171 /* note that backrefs (either in HvAUX or magic)
1172 * must be removed before other magic */
1173 sv_unmagic(sv, PERL_MAGIC_backref);
1174 if (SvTYPE(sv) != SVt_PVCV)
1177 if (SvTHINKFIRST(sv))
1178 sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF
1182 switch (SvTYPE(sv)) {
1186 av_clear(MUTABLE_AV(sv));
1189 hv_clear(MUTABLE_HV(sv));
1195 ? CvNAME_HEK((CV *)sv)
1196 : GvNAME_HEK(CvGV(sv));
1198 (void)share_hek_hek(hek);
1200 CvNAME_HEK_set(sv, hek);
1205 /* This looks odd, but these two macros are for use in
1206 expressions and finish with a trailing comma, so
1207 adding a ; after them would be wrong. */
1210 SvFLAGS(sv) &=~ (SVf_OK|SVf_IVisUV|SVf_UTF8);
1214 SvPADSTALE_on(sv); /* mark as no longer live */
1216 else { /* Someone has a claim on this, so abandon it. */
1217 switch (SvTYPE(sv)) { /* Console ourselves with a new value */
1218 case SVt_PVAV: *svp = MUTABLE_SV(newAV()); break;
1219 case SVt_PVHV: *svp = MUTABLE_SV(newHV()); break;
1222 HEK * const hek = CvNAMED(sv)
1223 ? CvNAME_HEK((CV *)sv)
1224 : GvNAME_HEK(CvGV(sv));
1227 *svp = newSV_type(SVt_PVCV);
1230 CvNAME_HEK_set(*svp,
1231 share_hek_hek(hek));
1235 default: *svp = newSV(0); break;
1237 SvREFCNT_dec_NN(sv); /* Cast current value to the winds. */
1238 /* preserve pad nature, but also mark as not live
1239 * for any closure capturing */
1240 SvFLAGS(*svp) |= SVs_PADSTALE;
1247 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1248 (void)hv_delete(a2.any_hv, a0.any_pv, a1.any_i32, G_DISCARD);
1249 SvREFCNT_dec(a2.any_hv);
1250 Safefree(a0.any_ptr);
1254 a0 = ap[0]; a1 = ap[1];
1255 (void)av_delete(a1.any_av, a0.any_iv, G_DISCARD);
1256 SvREFCNT_dec(a1.any_av);
1259 case SAVEt_DESTRUCTOR_X:
1260 a0 = ap[0]; a1 = ap[1];
1261 (*a0.any_dxptr)(aTHX_ a1.any_ptr);
1264 case SAVEt_REGCONTEXT:
1265 /* regexp must have croaked */
1267 PL_savestack_ix -= uv >> SAVE_TIGHT_SHIFT;
1270 case SAVEt_STACK_POS: /* Position on Perl stack */
1272 PL_stack_sp = PL_stack_base + a0.any_i32;
1275 case SAVEt_AELEM: /* array element */
1278 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1279 svp = av_fetch(a0.any_av, a1.any_iv, 1);
1280 if (UNLIKELY(!AvREAL(a0.any_av) && AvREIFY(a0.any_av))) /* undo reify guard */
1281 SvREFCNT_dec(a2.any_sv);
1283 SV * const sv = *svp;
1284 if (LIKELY(sv && sv != &PL_sv_undef)) {
1285 if (UNLIKELY(SvTIED_mg((const SV *)a0.any_av, PERL_MAGIC_tied)))
1286 SvREFCNT_inc_void_NN(sv);
1287 a1.any_sv = a2.any_sv;
1292 SvREFCNT_dec(a0.any_av);
1293 SvREFCNT_dec(a2.any_sv);
1297 case SAVEt_HELEM: /* hash element */
1301 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1302 he = hv_fetch_ent(a0.any_hv, a1.any_sv, 1, 0);
1303 SvREFCNT_dec(a1.any_sv);
1305 const SV * const oval = HeVAL(he);
1306 if (LIKELY(oval && oval != &PL_sv_undef)) {
1307 SV **svp = &HeVAL(he);
1308 if (UNLIKELY(SvTIED_mg((const SV *)a0.any_hv, PERL_MAGIC_tied)))
1309 SvREFCNT_inc_void(*svp);
1310 a1.any_sv = a2.any_sv;
1315 SvREFCNT_dec(a0.any_hv);
1316 SvREFCNT_dec(a2.any_sv);
1322 PL_op = (OP*)a0.any_ptr;
1326 a0 = ap[0]; a1 = ap[1];
1327 if ((PL_hints & HINT_LOCALIZE_HH)) {
1328 while (GvHV(PL_hintgv)) {
1329 HV *hv = GvHV(PL_hintgv);
1330 GvHV(PL_hintgv) = NULL;
1331 SvREFCNT_dec(MUTABLE_SV(hv));
1334 cophh_free(CopHINTHASH_get(&PL_compiling));
1335 CopHINTHASH_set(&PL_compiling, (COPHH*)a1.any_ptr);
1336 *(I32*)&PL_hints = a0.any_i32;
1337 if (PL_hints & HINT_LOCALIZE_HH) {
1338 SvREFCNT_dec(MUTABLE_SV(GvHV(PL_hintgv)));
1339 GvHV(PL_hintgv) = MUTABLE_HV(SSPOPPTR);
1341 if (!GvHV(PL_hintgv)) {
1342 /* Need to add a new one manually, else rv2hv can
1343 add one via GvHVn and it won't have the magic set. */
1344 HV *const hv = newHV();
1345 hv_magic(hv, NULL, PERL_MAGIC_hints);
1346 GvHV(PL_hintgv) = hv;
1348 assert(GvHV(PL_hintgv));
1353 PL_comppad = (PAD*)a0.any_ptr;
1354 if (LIKELY(PL_comppad))
1355 PL_curpad = AvARRAY(PL_comppad);
1360 case SAVEt_PADSV_AND_MORTALIZE:
1364 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1365 assert (a1.any_ptr);
1366 svp = AvARRAY((PAD*)a1.any_ptr) + (PADOFFSET)a2.any_uv;
1367 /* This mortalizing used to be done by CX_POOPLOOP() via
1368 itersave. But as we have all the information here, we
1369 can do it here, save even having to have itersave in
1377 case SAVEt_SAVESWITCHSTACK:
1381 a0 = ap[0]; a1 = ap[1];
1382 SWITCHSTACK(a1.any_av, a0.any_av);
1383 PL_curstackinfo->si_stack = a0.any_av;
1387 case SAVEt_SET_SVFLAGS:
1388 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1389 SvFLAGS(a0.any_sv) &= ~(a1.any_u32);
1390 SvFLAGS(a0.any_sv) |= a2.any_u32;
1393 /* These are only saved in mathoms.c */
1396 (void)sv_clear(a0.any_sv);
1399 case SAVEt_LONG: /* long reference */
1400 a0 = ap[0]; a1 = ap[1];
1401 *(long*)a1.any_ptr = a0.any_long;
1404 case SAVEt_IV: /* IV reference */
1405 a0 = ap[0]; a1 = ap[1];
1406 *(IV*)a1.any_ptr = a0.any_iv;
1409 case SAVEt_I16: /* I16 reference */
1411 *(I16*)a0.any_ptr = (I16)(uv >> 8);
1414 case SAVEt_I8: /* I8 reference */
1416 *(I8*)a0.any_ptr = (I8)(uv >> 8);
1419 case SAVEt_DESTRUCTOR:
1420 a0 = ap[0]; a1 = ap[1];
1421 (*a0.any_dptr)(a1.any_ptr);
1424 case SAVEt_COMPILE_WARNINGS:
1426 if (!specialWARN(PL_compiling.cop_warnings))
1427 PerlMemShared_free(PL_compiling.cop_warnings);
1428 PL_compiling.cop_warnings = (STRLEN*)a0.any_ptr;
1433 parser_free((yy_parser *)a0.any_ptr);
1436 case SAVEt_READONLY_OFF:
1438 SvREADONLY_off(a0.any_sv);
1442 Perl_croak(aTHX_ "panic: leave_scope inconsistency %u",
1443 (U8)uv & SAVE_MASK);
1451 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1453 PERL_ARGS_ASSERT_CX_DUMP;
1456 PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1457 if (CxTYPE(cx) != CXt_SUBST) {
1458 const char *gimme_text;
1459 PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1460 PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%" UVxf "\n",
1461 PTR2UV(cx->blk_oldcop));
1462 PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1463 PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1464 PerlIO_printf(Perl_debug_log, "BLK_OLDSAVEIX = %ld\n", (long)cx->blk_oldsaveix);
1465 PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%" UVxf "\n",
1466 PTR2UV(cx->blk_oldpm));
1467 switch (cx->blk_gimme) {
1469 gimme_text = "VOID";
1472 gimme_text = "SCALAR";
1475 gimme_text = "LIST";
1478 gimme_text = "UNKNOWN";
1481 PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", gimme_text);
1483 switch (CxTYPE(cx)) {
1488 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.CV = 0x%" UVxf "\n",
1489 PTR2UV(cx->blk_format.cv));
1490 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.GV = 0x%" UVxf "\n",
1491 PTR2UV(cx->blk_format.gv));
1492 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.DFOUTGV = 0x%" UVxf "\n",
1493 PTR2UV(cx->blk_format.dfoutgv));
1494 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.HASARGS = %d\n",
1495 (int)CxHASARGS(cx));
1496 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.RETOP = 0x%" UVxf "\n",
1497 PTR2UV(cx->blk_format.retop));
1500 PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%" UVxf "\n",
1501 PTR2UV(cx->blk_sub.cv));
1502 PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1503 (long)cx->blk_sub.olddepth);
1504 PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1505 (int)CxHASARGS(cx));
1506 PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n", (int)CxLVAL(cx));
1507 PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%" UVxf "\n",
1508 PTR2UV(cx->blk_sub.retop));
1511 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1512 (long)CxOLD_IN_EVAL(cx));
1513 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1514 PL_op_name[CxOLD_OP_TYPE(cx)],
1515 PL_op_desc[CxOLD_OP_TYPE(cx)]);
1516 if (cx->blk_eval.old_namesv)
1517 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1518 SvPVX_const(cx->blk_eval.old_namesv));
1519 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%" UVxf "\n",
1520 PTR2UV(cx->blk_eval.old_eval_root));
1521 PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%" UVxf "\n",
1522 PTR2UV(cx->blk_eval.retop));
1525 case CXt_LOOP_PLAIN:
1526 case CXt_LOOP_LAZYIV:
1527 case CXt_LOOP_LAZYSV:
1530 PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n", CxLABEL(cx));
1531 PerlIO_printf(Perl_debug_log, "BLK_LOOP.MY_OP = 0x%" UVxf "\n",
1532 PTR2UV(cx->blk_loop.my_op));
1533 if (CxTYPE(cx) != CXt_LOOP_PLAIN) {
1534 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%" UVxf "\n",
1535 PTR2UV(CxITERVAR(cx)));
1536 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERSAVE = 0x%" UVxf "\n",
1537 PTR2UV(cx->blk_loop.itersave));
1538 /* XXX: not accurate for LAZYSV/IV/LIST */
1539 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%" UVxf "\n",
1540 PTR2UV(cx->blk_loop.state_u.ary.ary));
1541 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1542 (long)cx->blk_loop.state_u.ary.ix);
1547 PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1548 (long)cx->sb_iters);
1549 PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1550 (long)cx->sb_maxiters);
1551 PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1552 (long)cx->sb_rflags);
1553 PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1555 PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1557 PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%" UVxf "\n",
1558 PTR2UV(cx->sb_dstr));
1559 PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%" UVxf "\n",
1560 PTR2UV(cx->sb_targ));
1561 PerlIO_printf(Perl_debug_log, "SB_S = 0x%" UVxf "\n",
1563 PerlIO_printf(Perl_debug_log, "SB_M = 0x%" UVxf "\n",
1565 PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%" UVxf "\n",
1566 PTR2UV(cx->sb_strend));
1567 PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%" UVxf "\n",
1568 PTR2UV(cx->sb_rxres));
1572 PERL_UNUSED_CONTEXT;
1573 PERL_UNUSED_ARG(cx);
1574 #endif /* DEBUGGING */
1578 * ex: set ts=8 sts=4 sw=4 et: