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 cxstack_max = GROW(cxstack_max);
94 Renew(cxstack, cxstack_max + 1, PERL_CONTEXT);
95 /* Without any kind of initialising deep enough recursion
96 * will end up reading uninitialised PERL_CONTEXTs. */
97 PoisonNew(cxstack + old_max + 1, cxstack_max - old_max, PERL_CONTEXT);
98 return cxstack_ix + 1;
102 Perl_push_scope(pTHX)
104 if (UNLIKELY(PL_scopestack_ix == PL_scopestack_max)) {
105 PL_scopestack_max = GROW(PL_scopestack_max);
106 Renew(PL_scopestack, PL_scopestack_max, I32);
108 Renew(PL_scopestack_name, PL_scopestack_max, const char*);
112 PL_scopestack_name[PL_scopestack_ix] = "unknown";
114 PL_scopestack[PL_scopestack_ix++] = PL_savestack_ix;
121 const I32 oldsave = PL_scopestack[--PL_scopestack_ix];
122 LEAVE_SCOPE(oldsave);
126 Perl_markstack_grow(pTHX)
128 const I32 oldmax = PL_markstack_max - PL_markstack;
129 const I32 newmax = GROW(oldmax);
131 Renew(PL_markstack, newmax, I32);
132 PL_markstack_max = PL_markstack + newmax;
133 PL_markstack_ptr = PL_markstack + oldmax;
134 DEBUG_s(DEBUG_v(PerlIO_printf(Perl_debug_log,
135 "MARK grow %p %"IVdf" by %"IVdf"\n",
136 PL_markstack_ptr, (IV)*PL_markstack_ptr, (IV)oldmax)));
137 return PL_markstack_ptr;
141 Perl_savestack_grow(pTHX)
143 #ifdef STRESS_REALLOC
144 PL_savestack_max += SS_MAXPUSH;
146 PL_savestack_max = GROW(PL_savestack_max);
148 /* Note that we allocate SS_MAXPUSH slots higher than ss_max
149 * so that SS_ADD_END(), SSGROW() etc can do a simper check */
150 Renew(PL_savestack, PL_savestack_max + SS_MAXPUSH, ANY);
154 Perl_savestack_grow_cnt(pTHX_ I32 need)
156 PL_savestack_max = PL_savestack_ix + need;
157 /* Note that we allocate SS_MAXPUSH slots higher than ss_max
158 * so that SS_ADD_END(), SSGROW() etc can do a simper check */
159 Renew(PL_savestack, PL_savestack_max + SS_MAXPUSH, ANY);
164 /* The original function was called Perl_tmps_grow and was removed from public
165 API, Perl_tmps_grow_p is the replacement and it used in public macros but
168 Perl_tmps_grow_p takes a proposed ix. A proposed ix is PL_tmps_ix + extend_by,
169 where the result of (PL_tmps_ix + extend_by) is >= PL_tmps_max
170 Upon return, PL_tmps_stack[ix] will be a valid address. For machine code
171 optimization and register usage reasons, the proposed ix passed into
172 tmps_grow is returned to the caller which the caller can then use to write
173 an SV * to PL_tmps_stack[ix]. If the caller was using tmps_grow in
174 pre-extend mode (EXTEND_MORTAL macro), then it ignores the return value of
175 tmps_grow. Note, tmps_grow DOES NOT write ix to PL_tmps_ix, the caller
176 must assign ix or ret val of tmps_grow to PL_temps_ix themselves if that is
177 appropriate. The assignment to PL_temps_ix can happen before or after
178 tmps_grow call since tmps_grow doesn't look at PL_tmps_ix.
182 Perl_tmps_grow_p(pTHX_ SSize_t ix)
184 SSize_t extend_to = ix;
185 #ifndef STRESS_REALLOC
186 if (ix - PL_tmps_max < 128)
187 extend_to += (PL_tmps_max < 512) ? 128 : 512;
189 PL_tmps_max = extend_to + 1;
190 Renew(PL_tmps_stack, PL_tmps_max, SV*);
198 /* XXX should tmps_floor live in cxstack? */
199 const SSize_t myfloor = PL_tmps_floor;
200 while (PL_tmps_ix > myfloor) { /* clean up after last statement */
201 SV* const sv = PL_tmps_stack[PL_tmps_ix--];
203 PoisonWith(PL_tmps_stack + PL_tmps_ix + 1, 1, SV *, 0xAB);
207 SvREFCNT_dec_NN(sv); /* note, can modify tmps_ix!!! */
213 S_save_scalar_at(pTHX_ SV **sptr, const U32 flags)
218 PERL_ARGS_ASSERT_SAVE_SCALAR_AT;
221 if (flags & SAVEf_KEEPOLDELEM)
224 sv = (*sptr = newSV(0));
225 if (SvTYPE(osv) >= SVt_PVMG && SvMAGIC(osv))
226 mg_localize(osv, sv, cBOOL(flags & SAVEf_SETMAGIC));
233 Perl_save_pushptrptr(pTHX_ void *const ptr1, void *const ptr2, const int type)
243 Perl_save_scalar(pTHX_ GV *gv)
245 SV ** const sptr = &GvSVn(gv);
247 PERL_ARGS_ASSERT_SAVE_SCALAR;
249 if (UNLIKELY(SvGMAGICAL(*sptr))) {
254 save_pushptrptr(SvREFCNT_inc_simple(gv), SvREFCNT_inc(*sptr), SAVEt_SV);
255 return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
258 /* Like save_sptr(), but also SvREFCNT_dec()s the new value. Can be used to
259 * restore a global SV to its prior contents, freeing new value. */
261 Perl_save_generic_svref(pTHX_ SV **sptr)
263 PERL_ARGS_ASSERT_SAVE_GENERIC_SVREF;
265 save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_GENERIC_SVREF);
268 /* Like save_pptr(), but also Safefree()s the new value if it is different
269 * from the old one. Can be used to restore a global char* to its prior
270 * contents, freeing new value. */
272 Perl_save_generic_pvref(pTHX_ char **str)
274 PERL_ARGS_ASSERT_SAVE_GENERIC_PVREF;
276 save_pushptrptr(*str, str, SAVEt_GENERIC_PVREF);
279 /* Like save_generic_pvref(), but uses PerlMemShared_free() rather than Safefree().
280 * Can be used to restore a shared global char* to its prior
281 * contents, freeing new value. */
283 Perl_save_shared_pvref(pTHX_ char **str)
285 PERL_ARGS_ASSERT_SAVE_SHARED_PVREF;
287 save_pushptrptr(str, *str, SAVEt_SHARED_PVREF);
290 /* set the SvFLAGS specified by mask to the values in val */
293 Perl_save_set_svflags(pTHX_ SV* sv, U32 mask, U32 val)
297 PERL_ARGS_ASSERT_SAVE_SET_SVFLAGS;
302 SS_ADD_UV(SAVEt_SET_SVFLAGS);
309 Saves the current GP of gv on the save stack to be restored on scope exit.
311 If empty is true, replace the GP with a new GP.
313 If empty is false, mark gv with GVf_INTRO so the next reference
314 assigned is localized, which is how C< local *foo = $someref; > works.
320 Perl_save_gp(pTHX_ GV *gv, I32 empty)
322 PERL_ARGS_ASSERT_SAVE_GP;
324 save_pushptrptr(SvREFCNT_inc(gv), GvGP(gv), SAVEt_GP);
327 GP *gp = Perl_newGP(aTHX_ gv);
328 HV * const stash = GvSTASH(gv);
329 bool isa_changed = 0;
331 if (stash && HvENAME(stash)) {
332 if (GvNAMELEN(gv) == 3 && strnEQ(GvNAME(gv), "ISA", 3))
335 /* taking a method out of circulation ("local")*/
336 mro_method_changed_in(stash);
338 if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
340 IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
343 if (isa_changed) mro_isa_changed_in(stash);
352 Perl_save_ary(pTHX_ GV *gv)
354 AV * const oav = GvAVn(gv);
357 PERL_ARGS_ASSERT_SAVE_ARY;
359 if (UNLIKELY(!AvREAL(oav) && AvREIFY(oav)))
361 save_pushptrptr(SvREFCNT_inc_simple_NN(gv), oav, SAVEt_AV);
365 if (UNLIKELY(SvMAGIC(oav)))
366 mg_localize(MUTABLE_SV(oav), MUTABLE_SV(av), TRUE);
371 Perl_save_hash(pTHX_ GV *gv)
375 PERL_ARGS_ASSERT_SAVE_HASH;
378 SvREFCNT_inc_simple_NN(gv), (ohv = GvHVn(gv)), SAVEt_HV
383 if (UNLIKELY(SvMAGIC(ohv)))
384 mg_localize(MUTABLE_SV(ohv), MUTABLE_SV(hv), TRUE);
389 Perl_save_item(pTHX_ SV *item)
391 SV * const sv = newSVsv(item);
393 PERL_ARGS_ASSERT_SAVE_ITEM;
395 save_pushptrptr(item, /* remember the pointer */
396 sv, /* remember the value */
401 Perl_save_bool(pTHX_ bool *boolp)
405 PERL_ARGS_ASSERT_SAVE_BOOL;
408 SS_ADD_UV(SAVEt_BOOL | (*boolp << 8));
413 Perl_save_pushi32ptr(pTHX_ const I32 i, void *const ptr, const int type)
424 Perl_save_int(pTHX_ int *intp)
427 UV type = ((UV)((UV)i << SAVE_TIGHT_SHIFT) | SAVEt_INT_SMALL);
431 PERL_ARGS_ASSERT_SAVE_INT;
433 if (UNLIKELY((int)(type >> SAVE_TIGHT_SHIFT) != i)) {
444 Perl_save_I8(pTHX_ I8 *bytep)
448 PERL_ARGS_ASSERT_SAVE_I8;
451 SS_ADD_UV(SAVEt_I8 | ((UV)*bytep << 8));
456 Perl_save_I16(pTHX_ I16 *intp)
460 PERL_ARGS_ASSERT_SAVE_I16;
463 SS_ADD_UV(SAVEt_I16 | ((UV)*intp << 8));
468 Perl_save_I32(pTHX_ I32 *intp)
471 UV type = ((I32)((U32)i << SAVE_TIGHT_SHIFT) | SAVEt_I32_SMALL);
475 PERL_ARGS_ASSERT_SAVE_I32;
477 if (UNLIKELY((I32)(type >> SAVE_TIGHT_SHIFT) != i)) {
488 Perl_save_strlen(pTHX_ STRLEN *ptr)
492 PERL_ARGS_ASSERT_SAVE_STRLEN;
496 SS_ADD_UV(SAVEt_STRLEN);
501 Perl_save_iv(pTHX_ IV *ivp)
503 PERL_ARGS_ASSERT_SAVE_IV;
511 /* Cannot use save_sptr() to store a char* since the SV** cast will
512 * force word-alignment and we'll miss the pointer.
515 Perl_save_pptr(pTHX_ char **pptr)
517 PERL_ARGS_ASSERT_SAVE_PPTR;
519 save_pushptrptr(*pptr, pptr, SAVEt_PPTR);
523 Perl_save_vptr(pTHX_ void *ptr)
525 PERL_ARGS_ASSERT_SAVE_VPTR;
527 save_pushptrptr(*(char**)ptr, ptr, SAVEt_VPTR);
531 Perl_save_sptr(pTHX_ SV **sptr)
533 PERL_ARGS_ASSERT_SAVE_SPTR;
535 save_pushptrptr(*sptr, sptr, SAVEt_SPTR);
539 Perl_save_padsv_and_mortalize(pTHX_ PADOFFSET off)
543 ASSERT_CURPAD_ACTIVE("save_padsv");
544 SS_ADD_PTR(SvREFCNT_inc_simple_NN(PL_curpad[off]));
545 SS_ADD_PTR(PL_comppad);
547 SS_ADD_UV(SAVEt_PADSV_AND_MORTALIZE);
552 Perl_save_hptr(pTHX_ HV **hptr)
554 PERL_ARGS_ASSERT_SAVE_HPTR;
556 save_pushptrptr(*hptr, hptr, SAVEt_HPTR);
560 Perl_save_aptr(pTHX_ AV **aptr)
562 PERL_ARGS_ASSERT_SAVE_APTR;
564 save_pushptrptr(*aptr, aptr, SAVEt_APTR);
568 Perl_save_pushptr(pTHX_ void *const ptr, const int type)
577 Perl_save_clearsv(pTHX_ SV **svp)
579 const UV offset = svp - PL_curpad;
580 const UV offset_shifted = offset << SAVE_TIGHT_SHIFT;
582 PERL_ARGS_ASSERT_SAVE_CLEARSV;
584 ASSERT_CURPAD_ACTIVE("save_clearsv");
585 SvPADSTALE_off(*svp); /* mark lexical as active */
586 if (UNLIKELY((offset_shifted >> SAVE_TIGHT_SHIFT) != offset)) {
587 Perl_croak(aTHX_ "panic: pad offset %"UVuf" out of range (%p-%p)",
588 offset, svp, PL_curpad);
593 SS_ADD_UV(offset_shifted | SAVEt_CLEARSV);
599 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
601 PERL_ARGS_ASSERT_SAVE_DELETE;
603 save_pushptri32ptr(key, klen, SvREFCNT_inc_simple(hv), SAVEt_DELETE);
607 Perl_save_hdelete(pTHX_ HV *hv, SV *keysv)
613 PERL_ARGS_ASSERT_SAVE_HDELETE;
615 key = SvPV_const(keysv, len);
616 klen = SvUTF8(keysv) ? -(I32)len : (I32)len;
617 SvREFCNT_inc_simple_void_NN(hv);
618 save_pushptri32ptr(savepvn(key, len), klen, hv, SAVEt_DELETE);
622 Perl_save_adelete(pTHX_ AV *av, SSize_t key)
626 PERL_ARGS_ASSERT_SAVE_ADELETE;
628 SvREFCNT_inc_void(av);
631 SS_ADD_IV(SAVEt_ADELETE);
636 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
639 PERL_ARGS_ASSERT_SAVE_DESTRUCTOR;
643 SS_ADD_UV(SAVEt_DESTRUCTOR);
648 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
654 SS_ADD_UV(SAVEt_DESTRUCTOR_X);
659 Perl_save_hints(pTHX)
661 COPHH *save_cophh = cophh_copy(CopHINTHASH_get(&PL_compiling));
662 if (PL_hints & HINT_LOCALIZE_HH) {
663 HV *oldhh = GvHV(PL_hintgv);
664 save_pushptri32ptr(oldhh, PL_hints, save_cophh, SAVEt_HINTS);
665 GvHV(PL_hintgv) = NULL; /* in case copying dies */
666 GvHV(PL_hintgv) = hv_copy_hints_hv(oldhh);
668 save_pushi32ptr(PL_hints, save_cophh, SAVEt_HINTS);
673 S_save_pushptri32ptr(pTHX_ void *const ptr1, const I32 i, void *const ptr2,
685 Perl_save_aelem_flags(pTHX_ AV *av, SSize_t idx, SV **sptr,
691 PERL_ARGS_ASSERT_SAVE_AELEM_FLAGS;
694 SS_ADD_PTR(SvREFCNT_inc_simple(av));
696 SS_ADD_PTR(SvREFCNT_inc(*sptr));
697 SS_ADD_UV(SAVEt_AELEM);
699 /* The array needs to hold a reference count on its new element, so it
701 if (UNLIKELY(!AvREAL(av) && AvREIFY(av)))
703 save_scalar_at(sptr, flags); /* XXX - FIXME - see #60360 */
704 if (flags & SAVEf_KEEPOLDELEM)
707 /* If we're localizing a tied array element, this new sv
708 * won't actually be stored in the array - so it won't get
709 * reaped when the localize ends. Ensure it gets reaped by
710 * mortifying it instead. DAPM */
711 if (UNLIKELY(SvTIED_mg((const SV *)av, PERL_MAGIC_tied)))
716 Perl_save_helem_flags(pTHX_ HV *hv, SV *key, SV **sptr, const U32 flags)
720 PERL_ARGS_ASSERT_SAVE_HELEM_FLAGS;
725 SS_ADD_PTR(SvREFCNT_inc_simple(hv));
726 SS_ADD_PTR(newSVsv(key));
727 SS_ADD_PTR(SvREFCNT_inc(*sptr));
728 SS_ADD_UV(SAVEt_HELEM);
731 save_scalar_at(sptr, flags);
732 if (flags & SAVEf_KEEPOLDELEM)
735 /* If we're localizing a tied hash element, this new sv
736 * won't actually be stored in the hash - so it won't get
737 * reaped when the localize ends. Ensure it gets reaped by
738 * mortifying it instead. DAPM */
739 if (UNLIKELY(SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)))
744 Perl_save_svref(pTHX_ SV **sptr)
746 PERL_ARGS_ASSERT_SAVE_SVREF;
749 save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_SVREF);
750 return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
758 SS_ADD_IV(PL_tmps_floor);
759 PL_tmps_floor = PL_tmps_ix;
760 SS_ADD_UV(SAVEt_TMPSFLOOR);
766 Perl_save_alloc(pTHX_ I32 size, I32 pad)
768 const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
769 - (char*)PL_savestack);
770 const UV elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
771 const UV elems_shifted = elems << SAVE_TIGHT_SHIFT;
773 if (UNLIKELY((elems_shifted >> SAVE_TIGHT_SHIFT) != elems))
775 "panic: save_alloc elems %"UVuf" out of range (%"IVdf"-%"IVdf")",
776 elems, (IV)size, (IV)pad);
780 PL_savestack_ix += elems;
781 SSPUSHUV(SAVEt_ALLOC | elems_shifted);
786 static U8 arg_counts[] = {
788 0, /* SAVEt_CLEARPADRANGE */
789 0, /* SAVEt_CLEARSV */
790 0, /* SAVEt_REGCONTEXT */
791 1, /* SAVEt_TMPSFLOOR */
793 1, /* SAVEt_COMPILE_WARNINGS */
794 1, /* SAVEt_COMPPAD */
795 1, /* SAVEt_FREECOPHH */
796 1, /* SAVEt_FREEOP */
797 1, /* SAVEt_FREEPV */
798 1, /* SAVEt_FREESV */
800 1, /* SAVEt_I32_SMALL */
802 1, /* SAVEt_INT_SMALL */
803 1, /* SAVEt_MORTALIZESV */
806 1, /* SAVEt_PARSER */
807 1, /* SAVEt_STACK_POS */
808 1, /* SAVEt_READONLY_OFF */
809 1, /* SAVEt_FREEPADNAME */
811 2, /* SAVEt_DESTRUCTOR */
812 2, /* SAVEt_DESTRUCTOR_X */
813 2, /* SAVEt_GENERIC_PVREF */
814 2, /* SAVEt_GENERIC_SVREF */
826 2, /* SAVEt_SAVESWITCHSTACK */
827 2, /* SAVEt_SHARED_PVREF */
829 2, /* SAVEt_STRLEN */
833 2, /* SAVEt_ADELETE */
836 3, /* SAVEt_PADSV_AND_MORTALIZE*/
837 3, /* SAVEt_SET_SVFLAGS */
838 3, /* SAVEt_GVSLOT */
845 Perl_leave_scope(pTHX_ I32 base)
847 /* Localise the effects of the TAINT_NOT inside the loop. */
848 bool was = TAINT_get;
850 if (UNLIKELY(base < -1))
851 Perl_croak(aTHX_ "panic: corrupt saved stack index %ld", (long) base);
852 DEBUG_l(Perl_deb(aTHX_ "savestack: releasing items %ld -> %ld\n",
853 (long)PL_savestack_ix, (long)base));
854 while (PL_savestack_ix > base) {
857 ANY *ap; /* arg pointer */
858 ANY a0, a1, a2; /* up to 3 args */
864 I32 ix = PL_savestack_ix - 1;
866 ap = &PL_savestack[ix];
868 type = (U8)uv & SAVE_MASK;
869 argcount = arg_counts[type];
870 PL_savestack_ix = ix - argcount;
875 case SAVEt_ITEM: /* normal string */
876 a0 = ap[0]; a1 = ap[1];
877 sv_replace(a0.any_sv, a1.any_sv);
878 if (UNLIKELY(SvSMAGICAL(a0.any_sv))) {
885 /* This would be a mathom, but Perl_save_svref() calls a static
886 function, S_save_scalar_at(), so has to stay in this file. */
887 case SAVEt_SVREF: /* scalar reference */
888 a0 = ap[0]; a1 = ap[1];
889 a2.any_svp = a0.any_svp;
890 a0.any_sv = NULL; /* what to refcnt_dec */
893 case SAVEt_SV: /* scalar reference */
894 a0 = ap[0]; a1 = ap[1];
895 a2.any_svp = &GvSV(a0.any_gv);
898 /* do *a2.any_svp = a1 and free a0 */
899 SV * const sv = *a2.any_svp;
900 *a2.any_svp = a1.any_sv;
902 if (UNLIKELY(SvSMAGICAL(a1.any_sv))) {
903 /* mg_set could die, skipping the freeing of a0 and
904 * a1; Ensure that they're always freed in that case */
906 SS_ADD_PTR(a1.any_sv);
907 SS_ADD_UV(SAVEt_FREESV);
908 SS_ADD_PTR(a0.any_sv);
909 SS_ADD_UV(SAVEt_FREESV);
916 SvREFCNT_dec_NN(a1.any_sv);
917 SvREFCNT_dec(a0.any_sv);
921 case SAVEt_GENERIC_PVREF: /* generic pv */
922 a0 = ap[0]; a1 = ap[1];
923 if (*a1.any_pvp != a0.any_pv) {
924 Safefree(*a1.any_pvp);
925 *a1.any_pvp = a0.any_pv;
929 case SAVEt_SHARED_PVREF: /* shared pv */
930 a0 = ap[0]; a1 = ap[1];
931 if (*a0.any_pvp != a1.any_pv) {
933 PerlMem_free(*a0.any_pvp);
935 PerlMemShared_free(*a0.any_pvp);
937 *a0.any_pvp = a1.any_pv;
941 case SAVEt_GVSV: /* scalar slot in GV */
942 a0 = ap[0]; a1 = ap[1];
943 a0.any_svp = &GvSV(a0.any_gv);
946 case SAVEt_GENERIC_SVREF: /* generic sv */
947 a0 = ap[0]; a1 = ap[1];
950 /* do *a0.any_svp = a1 */
951 SV * const sv = *a0.any_svp;
952 *a0.any_svp = a1.any_sv;
954 SvREFCNT_dec(a1.any_sv);
958 case SAVEt_GVSLOT: /* any slot in GV */
961 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
962 hv = GvSTASH(a0.any_gv);
963 if (hv && HvENAME(hv) && (
964 (a2.any_sv && SvTYPE(a2.any_sv) == SVt_PVCV)
965 || (*a1.any_svp && SvTYPE(*a1.any_svp) == SVt_PVCV)
968 if ((char *)a1.any_svp < (char *)GvGP(a0.any_gv)
969 || (char *)a1.any_svp > (char *)GvGP(a0.any_gv) + sizeof(struct gp)
970 || GvREFCNT(a0.any_gv) > 2) /* "> 2" to ignore savestack's ref */
972 else mro_method_changed_in(hv);
974 a0.any_svp = a1.any_svp;
975 a1.any_sv = a2.any_sv;
979 case SAVEt_AV: /* array reference */
980 a0 = ap[0]; a1 = ap[1];
981 SvREFCNT_dec(GvAV(a0.any_gv));
982 GvAV(a0.any_gv) = a1.any_av;
984 if (UNLIKELY(SvSMAGICAL(a1.any_sv))) {
985 /* mg_set might die, so make sure a0 isn't leaked */
987 SS_ADD_PTR(a0.any_sv);
988 SS_ADD_UV(SAVEt_FREESV);
995 SvREFCNT_dec_NN(a0.any_sv);
998 case SAVEt_HV: /* hash reference */
999 a0 = ap[0]; a1 = ap[1];
1000 SvREFCNT_dec(GvHV(a0.any_gv));
1001 GvHV(a0.any_gv) = a1.any_hv;
1004 case SAVEt_INT_SMALL:
1006 *(int*)a0.any_ptr = (int)(uv >> SAVE_TIGHT_SHIFT);
1009 case SAVEt_INT: /* int reference */
1010 a0 = ap[0]; a1 = ap[1];
1011 *(int*)a1.any_ptr = (int)a0.any_i32;
1014 case SAVEt_STRLEN: /* STRLEN/size_t ref */
1015 a0 = ap[0]; a1 = ap[1];
1016 *(STRLEN*)a1.any_ptr = (STRLEN)a0.any_iv;
1019 case SAVEt_TMPSFLOOR: /* restore PL_tmps_floor */
1021 PL_tmps_floor = (SSize_t)a0.any_iv;
1024 case SAVEt_BOOL: /* bool reference */
1026 *(bool*)a0.any_ptr = cBOOL(uv >> 8);
1027 #ifdef NO_TAINT_SUPPORT
1028 PERL_UNUSED_VAR(was);
1030 if (UNLIKELY(a0.any_ptr == &(TAINT_get))) {
1031 /* If we don't update <was>, to reflect what was saved on the
1032 * stack for PL_tainted, then we will overwrite this attempt to
1033 * restore it when we exit this routine. Note that this won't
1034 * work if this value was saved in a wider-than necessary type,
1036 was = *(bool*)a0.any_ptr;
1041 case SAVEt_I32_SMALL:
1043 *(I32*)a0.any_ptr = (I32)(uv >> SAVE_TIGHT_SHIFT);
1046 case SAVEt_I32: /* I32 reference */
1047 a0 = ap[0]; a1 = ap[1];
1048 #ifdef PERL_DEBUG_READONLY_OPS
1049 if (*(I32*)a1.any_ptr != a0.any_i32)
1051 *(I32*)a1.any_ptr = a0.any_i32;
1054 case SAVEt_SPTR: /* SV* reference */
1055 case SAVEt_VPTR: /* random* reference */
1056 case SAVEt_PPTR: /* char* reference */
1057 case SAVEt_HPTR: /* HV* reference */
1058 case SAVEt_APTR: /* AV* reference */
1059 a0 = ap[0]; a1 = ap[1];
1060 *a1.any_svp= a0.any_sv;
1063 case SAVEt_GP: /* scalar reference */
1068 a0 = ap[0]; a1 = ap[1];
1069 /* possibly taking a method out of circulation */
1070 had_method = !!GvCVu(a0.any_gv);
1072 GvGP_set(a0.any_gv, (GP*)a1.any_ptr);
1073 if ((hv=GvSTASH(a0.any_gv)) && HvENAME_get(hv)) {
1074 if ( GvNAMELEN(a0.any_gv) == 3
1075 && strnEQ(GvNAME(a0.any_gv), "ISA", 3)
1077 mro_isa_changed_in(hv);
1078 else if (had_method || GvCVu(a0.any_gv))
1079 /* putting a method back into circulation ("local")*/
1080 gv_method_changed(a0.any_gv);
1082 SvREFCNT_dec_NN(a0.any_gv);
1088 SvREFCNT_dec(a0.any_sv);
1091 case SAVEt_FREEPADNAME:
1093 PadnameREFCNT_dec((PADNAME *)a0.any_ptr);
1096 case SAVEt_FREECOPHH:
1098 cophh_free((COPHH *)a0.any_ptr);
1101 case SAVEt_MORTALIZESV:
1103 sv_2mortal(a0.any_sv);
1108 ASSERT_CURPAD_LEGAL("SAVEt_FREEOP");
1114 Safefree(a0.any_ptr);
1117 case SAVEt_CLEARPADRANGE:
1121 i = (I32)((uv >> SAVE_TIGHT_SHIFT) & OPpPADRANGE_COUNTMASK);
1122 svp = &PL_curpad[uv >>
1123 (OPpPADRANGE_COUNTSHIFT + SAVE_TIGHT_SHIFT)] + i - 1;
1126 svp = &PL_curpad[uv >> SAVE_TIGHT_SHIFT];
1129 for (; i; i--, svp--) {
1132 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1133 "Pad 0x%"UVxf"[0x%"UVxf"] clearsv: %ld sv=0x%"UVxf"<%"IVdf"> %s\n",
1134 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
1135 (long)(svp-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
1136 (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
1139 /* Can clear pad variable in place? */
1140 if (SvREFCNT(sv) == 1 && !SvOBJECT(sv)) {
1142 /* these flags are the union of all the relevant flags
1143 * in the individual conditions within */
1144 if (UNLIKELY(SvFLAGS(sv) & (
1145 SVf_READONLY|SVf_PROTECT /*for SvREADONLY_off*/
1146 | (SVs_GMG|SVs_SMG|SVs_RMG) /* SvMAGICAL() */
1150 /* if a my variable that was made readonly is
1151 * going out of scope, we want to remove the
1152 * readonlyness so that it can go out of scope
1158 if (SvOOK(sv)) { /* OOK or HvAUX */
1159 if (SvTYPE(sv) == SVt_PVHV)
1160 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
1165 if (SvMAGICAL(sv)) {
1166 /* note that backrefs (either in HvAUX or magic)
1167 * must be removed before other magic */
1168 sv_unmagic(sv, PERL_MAGIC_backref);
1169 if (SvTYPE(sv) != SVt_PVCV)
1172 if (SvTHINKFIRST(sv))
1173 sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF
1177 switch (SvTYPE(sv)) {
1181 av_clear(MUTABLE_AV(sv));
1184 hv_clear(MUTABLE_HV(sv));
1190 ? CvNAME_HEK((CV *)sv)
1191 : GvNAME_HEK(CvGV(sv));
1193 (void)share_hek_hek(hek);
1195 CvNAME_HEK_set(sv, hek);
1200 /* This looks odd, but these two macros are for use in
1201 expressions and finish with a trailing comma, so
1202 adding a ; after them would be wrong. */
1205 SvFLAGS(sv) &=~ (SVf_OK|SVf_IVisUV|SVf_UTF8);
1209 SvPADSTALE_on(sv); /* mark as no longer live */
1211 else { /* Someone has a claim on this, so abandon it. */
1212 switch (SvTYPE(sv)) { /* Console ourselves with a new value */
1213 case SVt_PVAV: *svp = MUTABLE_SV(newAV()); break;
1214 case SVt_PVHV: *svp = MUTABLE_SV(newHV()); break;
1217 HEK * const hek = CvNAMED(sv)
1218 ? CvNAME_HEK((CV *)sv)
1219 : GvNAME_HEK(CvGV(sv));
1222 *svp = newSV_type(SVt_PVCV);
1225 CvNAME_HEK_set(*svp,
1226 share_hek_hek(hek));
1230 default: *svp = newSV(0); break;
1232 SvREFCNT_dec_NN(sv); /* Cast current value to the winds. */
1233 /* preserve pad nature, but also mark as not live
1234 * for any closure capturing */
1235 SvFLAGS(*svp) |= SVs_PADSTALE;
1242 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1243 (void)hv_delete(a2.any_hv, a0.any_pv, a1.any_i32, G_DISCARD);
1244 SvREFCNT_dec(a2.any_hv);
1245 Safefree(a0.any_ptr);
1249 a0 = ap[0]; a1 = ap[1];
1250 (void)av_delete(a1.any_av, a0.any_iv, G_DISCARD);
1251 SvREFCNT_dec(a1.any_av);
1254 case SAVEt_DESTRUCTOR_X:
1255 a0 = ap[0]; a1 = ap[1];
1256 (*a0.any_dxptr)(aTHX_ a1.any_ptr);
1259 case SAVEt_REGCONTEXT:
1260 /* regexp must have croaked */
1262 PL_savestack_ix -= uv >> SAVE_TIGHT_SHIFT;
1265 case SAVEt_STACK_POS: /* Position on Perl stack */
1267 PL_stack_sp = PL_stack_base + a0.any_i32;
1270 case SAVEt_AELEM: /* array element */
1273 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1274 svp = av_fetch(a0.any_av, a1.any_iv, 1);
1275 if (UNLIKELY(!AvREAL(a0.any_av) && AvREIFY(a0.any_av))) /* undo reify guard */
1276 SvREFCNT_dec(a2.any_sv);
1278 SV * const sv = *svp;
1279 if (LIKELY(sv && sv != &PL_sv_undef)) {
1280 if (UNLIKELY(SvTIED_mg((const SV *)a0.any_av, PERL_MAGIC_tied)))
1281 SvREFCNT_inc_void_NN(sv);
1282 a1.any_sv = a2.any_sv;
1287 SvREFCNT_dec(a0.any_av);
1288 SvREFCNT_dec(a2.any_sv);
1292 case SAVEt_HELEM: /* hash element */
1296 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1297 he = hv_fetch_ent(a0.any_hv, a1.any_sv, 1, 0);
1298 SvREFCNT_dec(a1.any_sv);
1300 const SV * const oval = HeVAL(he);
1301 if (LIKELY(oval && oval != &PL_sv_undef)) {
1302 SV **svp = &HeVAL(he);
1303 if (UNLIKELY(SvTIED_mg((const SV *)a0.any_hv, PERL_MAGIC_tied)))
1304 SvREFCNT_inc_void(*svp);
1305 a1.any_sv = a2.any_sv;
1310 SvREFCNT_dec(a0.any_hv);
1311 SvREFCNT_dec(a2.any_sv);
1317 PL_op = (OP*)a0.any_ptr;
1321 a0 = ap[0]; a1 = ap[1];
1322 if ((PL_hints & HINT_LOCALIZE_HH)) {
1323 while (GvHV(PL_hintgv)) {
1324 HV *hv = GvHV(PL_hintgv);
1325 GvHV(PL_hintgv) = NULL;
1326 SvREFCNT_dec(MUTABLE_SV(hv));
1329 cophh_free(CopHINTHASH_get(&PL_compiling));
1330 CopHINTHASH_set(&PL_compiling, (COPHH*)a1.any_ptr);
1331 *(I32*)&PL_hints = a0.any_i32;
1332 if (PL_hints & HINT_LOCALIZE_HH) {
1333 SvREFCNT_dec(MUTABLE_SV(GvHV(PL_hintgv)));
1334 GvHV(PL_hintgv) = MUTABLE_HV(SSPOPPTR);
1336 if (!GvHV(PL_hintgv)) {
1337 /* Need to add a new one manually, else rv2hv can
1338 add one via GvHVn and it won't have the magic set. */
1339 HV *const hv = newHV();
1340 hv_magic(hv, NULL, PERL_MAGIC_hints);
1341 GvHV(PL_hintgv) = hv;
1343 assert(GvHV(PL_hintgv));
1348 PL_comppad = (PAD*)a0.any_ptr;
1349 if (LIKELY(PL_comppad))
1350 PL_curpad = AvARRAY(PL_comppad);
1355 case SAVEt_PADSV_AND_MORTALIZE:
1359 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1360 assert (a1.any_ptr);
1361 svp = AvARRAY((PAD*)a1.any_ptr) + (PADOFFSET)a2.any_uv;
1362 /* This mortalizing used to be done by CX_POOPLOOP() via
1363 itersave. But as we have all the information here, we
1364 can do it here, save even having to have itersave in
1372 case SAVEt_SAVESWITCHSTACK:
1376 a0 = ap[0]; a1 = ap[1];
1377 SWITCHSTACK(a1.any_av, a0.any_av);
1378 PL_curstackinfo->si_stack = a0.any_av;
1382 case SAVEt_SET_SVFLAGS:
1383 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1384 SvFLAGS(a0.any_sv) &= ~(a1.any_u32);
1385 SvFLAGS(a0.any_sv) |= a2.any_u32;
1388 /* These are only saved in mathoms.c */
1391 (void)sv_clear(a0.any_sv);
1394 case SAVEt_LONG: /* long reference */
1395 a0 = ap[0]; a1 = ap[1];
1396 *(long*)a1.any_ptr = a0.any_long;
1399 case SAVEt_IV: /* IV reference */
1400 a0 = ap[0]; a1 = ap[1];
1401 *(IV*)a1.any_ptr = a0.any_iv;
1404 case SAVEt_I16: /* I16 reference */
1406 *(I16*)a0.any_ptr = (I16)(uv >> 8);
1409 case SAVEt_I8: /* I8 reference */
1411 *(I8*)a0.any_ptr = (I8)(uv >> 8);
1414 case SAVEt_DESTRUCTOR:
1415 a0 = ap[0]; a1 = ap[1];
1416 (*a0.any_dptr)(a1.any_ptr);
1419 case SAVEt_COMPILE_WARNINGS:
1421 if (!specialWARN(PL_compiling.cop_warnings))
1422 PerlMemShared_free(PL_compiling.cop_warnings);
1423 PL_compiling.cop_warnings = (STRLEN*)a0.any_ptr;
1428 parser_free((yy_parser *)a0.any_ptr);
1431 case SAVEt_READONLY_OFF:
1433 SvREADONLY_off(a0.any_sv);
1437 Perl_croak(aTHX_ "panic: leave_scope inconsistency %u",
1438 (U8)uv & SAVE_MASK);
1446 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1448 PERL_ARGS_ASSERT_CX_DUMP;
1451 PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1452 if (CxTYPE(cx) != CXt_SUBST) {
1453 const char *gimme_text;
1454 PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1455 PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
1456 PTR2UV(cx->blk_oldcop));
1457 PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1458 PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1459 PerlIO_printf(Perl_debug_log, "BLK_OLDSAVEIX = %ld\n", (long)cx->blk_oldsaveix);
1460 PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
1461 PTR2UV(cx->blk_oldpm));
1462 switch (cx->blk_gimme) {
1464 gimme_text = "VOID";
1467 gimme_text = "SCALAR";
1470 gimme_text = "LIST";
1473 gimme_text = "UNKNOWN";
1476 PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", gimme_text);
1478 switch (CxTYPE(cx)) {
1483 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.CV = 0x%"UVxf"\n",
1484 PTR2UV(cx->blk_format.cv));
1485 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.GV = 0x%"UVxf"\n",
1486 PTR2UV(cx->blk_format.gv));
1487 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.DFOUTGV = 0x%"UVxf"\n",
1488 PTR2UV(cx->blk_format.dfoutgv));
1489 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.HASARGS = %d\n",
1490 (int)CxHASARGS(cx));
1491 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.RETOP = 0x%"UVxf"\n",
1492 PTR2UV(cx->blk_format.retop));
1495 PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1496 PTR2UV(cx->blk_sub.cv));
1497 PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1498 (long)cx->blk_sub.olddepth);
1499 PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1500 (int)CxHASARGS(cx));
1501 PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n", (int)CxLVAL(cx));
1502 PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1503 PTR2UV(cx->blk_sub.retop));
1506 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1507 (long)CxOLD_IN_EVAL(cx));
1508 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1509 PL_op_name[CxOLD_OP_TYPE(cx)],
1510 PL_op_desc[CxOLD_OP_TYPE(cx)]);
1511 if (cx->blk_eval.old_namesv)
1512 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1513 SvPVX_const(cx->blk_eval.old_namesv));
1514 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1515 PTR2UV(cx->blk_eval.old_eval_root));
1516 PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%"UVxf"\n",
1517 PTR2UV(cx->blk_eval.retop));
1520 case CXt_LOOP_PLAIN:
1521 case CXt_LOOP_LAZYIV:
1522 case CXt_LOOP_LAZYSV:
1525 PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n", CxLABEL(cx));
1526 PerlIO_printf(Perl_debug_log, "BLK_LOOP.MY_OP = 0x%"UVxf"\n",
1527 PTR2UV(cx->blk_loop.my_op));
1528 if (CxTYPE(cx) != CXt_LOOP_PLAIN) {
1529 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1530 PTR2UV(CxITERVAR(cx)));
1531 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERSAVE = 0x%"UVxf"\n",
1532 PTR2UV(cx->blk_loop.itersave));
1533 /* XXX: not accurate for LAZYSV/IV/LIST */
1534 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1535 PTR2UV(cx->blk_loop.state_u.ary.ary));
1536 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1537 (long)cx->blk_loop.state_u.ary.ix);
1542 PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1543 (long)cx->sb_iters);
1544 PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1545 (long)cx->sb_maxiters);
1546 PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1547 (long)cx->sb_rflags);
1548 PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1550 PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1552 PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1553 PTR2UV(cx->sb_dstr));
1554 PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1555 PTR2UV(cx->sb_targ));
1556 PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1558 PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1560 PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1561 PTR2UV(cx->sb_strend));
1562 PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1563 PTR2UV(cx->sb_rxres));
1567 PERL_UNUSED_CONTEXT;
1568 PERL_UNUSED_ARG(cx);
1569 #endif /* DEBUGGING */
1573 * ex: set ts=8 sts=4 sw=4 et: