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 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 PL_savestack_max = GROW(PL_savestack_max) + 4;
144 Renew(PL_savestack, PL_savestack_max, ANY);
148 Perl_savestack_grow_cnt(pTHX_ I32 need)
150 PL_savestack_max = PL_savestack_ix + need;
151 Renew(PL_savestack, PL_savestack_max, ANY);
156 /* The original function was called Perl_tmps_grow and was removed from public
157 API, Perl_tmps_grow_p is the replacement and it used in public macros but
160 Perl_tmps_grow_p takes a proposed ix. A proposed ix is PL_tmps_ix + extend_by,
161 where the result of (PL_tmps_ix + extend_by) is >= PL_tmps_max
162 Upon return, PL_tmps_stack[ix] will be a valid address. For machine code
163 optimization and register usage reasons, the proposed ix passed into
164 tmps_grow is returned to the caller which the caller can then use to write
165 an SV * to PL_tmps_stack[ix]. If the caller was using tmps_grow in
166 pre-extend mode (EXTEND_MORTAL macro), then it ignores the return value of
167 tmps_grow. Note, tmps_grow DOES NOT write ix to PL_tmps_ix, the caller
168 must assign ix or ret val of tmps_grow to PL_temps_ix themselves if that is
169 appropriate. The assignment to PL_temps_ix can happen before or after
170 tmps_grow call since tmps_grow doesn't look at PL_tmps_ix.
174 Perl_tmps_grow_p(pTHX_ SSize_t ix)
176 SSize_t extend_to = ix;
177 #ifndef STRESS_REALLOC
178 if (ix - PL_tmps_max < 128)
179 extend_to += (PL_tmps_max < 512) ? 128 : 512;
181 PL_tmps_max = extend_to + 1;
182 Renew(PL_tmps_stack, PL_tmps_max, SV*);
190 /* XXX should tmps_floor live in cxstack? */
191 const SSize_t myfloor = PL_tmps_floor;
192 while (PL_tmps_ix > myfloor) { /* clean up after last statement */
193 SV* const sv = PL_tmps_stack[PL_tmps_ix--];
195 PoisonWith(PL_tmps_stack + PL_tmps_ix + 1, 1, SV *, 0xAB);
197 if (LIKELY(sv && sv != &PL_sv_undef)) {
199 SvREFCNT_dec_NN(sv); /* note, can modify tmps_ix!!! */
205 S_save_scalar_at(pTHX_ SV **sptr, const U32 flags)
210 PERL_ARGS_ASSERT_SAVE_SCALAR_AT;
213 sv = (flags & SAVEf_KEEPOLDELEM) ? osv : (*sptr = newSV(0));
215 if (SvTYPE(osv) >= SVt_PVMG && SvMAGIC(osv)) {
216 if (SvGMAGICAL(osv)) {
217 SvFLAGS(osv) |= (SvFLAGS(osv) &
218 (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
220 if (!(flags & SAVEf_KEEPOLDELEM))
221 mg_localize(osv, sv, cBOOL(flags & SAVEf_SETMAGIC));
228 Perl_save_pushptrptr(pTHX_ void *const ptr1, void *const ptr2, const int type)
238 Perl_save_scalar(pTHX_ GV *gv)
240 SV ** const sptr = &GvSVn(gv);
242 PERL_ARGS_ASSERT_SAVE_SCALAR;
244 if (UNLIKELY(SvGMAGICAL(*sptr))) {
249 save_pushptrptr(SvREFCNT_inc_simple(gv), SvREFCNT_inc(*sptr), SAVEt_SV);
250 return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
253 /* Like save_sptr(), but also SvREFCNT_dec()s the new value. Can be used to
254 * restore a global SV to its prior contents, freeing new value. */
256 Perl_save_generic_svref(pTHX_ SV **sptr)
258 PERL_ARGS_ASSERT_SAVE_GENERIC_SVREF;
260 save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_GENERIC_SVREF);
263 /* Like save_pptr(), but also Safefree()s the new value if it is different
264 * from the old one. Can be used to restore a global char* to its prior
265 * contents, freeing new value. */
267 Perl_save_generic_pvref(pTHX_ char **str)
269 PERL_ARGS_ASSERT_SAVE_GENERIC_PVREF;
271 save_pushptrptr(*str, str, SAVEt_GENERIC_PVREF);
274 /* Like save_generic_pvref(), but uses PerlMemShared_free() rather than Safefree().
275 * Can be used to restore a shared global char* to its prior
276 * contents, freeing new value. */
278 Perl_save_shared_pvref(pTHX_ char **str)
280 PERL_ARGS_ASSERT_SAVE_SHARED_PVREF;
282 save_pushptrptr(str, *str, SAVEt_SHARED_PVREF);
285 /* set the SvFLAGS specified by mask to the values in val */
288 Perl_save_set_svflags(pTHX_ SV* sv, U32 mask, U32 val)
292 PERL_ARGS_ASSERT_SAVE_SET_SVFLAGS;
297 SS_ADD_UV(SAVEt_SET_SVFLAGS);
304 Saves the current GP of gv on the save stack to be restored on scope exit.
306 If empty is true, replace the GP with a new GP.
308 If empty is false, mark gv with GVf_INTRO so the next reference
309 assigned is localized, which is how C< local *foo = $someref; > works.
315 Perl_save_gp(pTHX_ GV *gv, I32 empty)
317 PERL_ARGS_ASSERT_SAVE_GP;
319 save_pushptrptr(SvREFCNT_inc(gv), GvGP(gv), SAVEt_GP);
322 GP *gp = Perl_newGP(aTHX_ gv);
323 HV * const stash = GvSTASH(gv);
324 bool isa_changed = 0;
326 if (stash && HvENAME(stash)) {
327 if (GvNAMELEN(gv) == 3 && strnEQ(GvNAME(gv), "ISA", 3))
330 /* taking a method out of circulation ("local")*/
331 mro_method_changed_in(stash);
333 if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
335 IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
338 if (isa_changed) mro_isa_changed_in(stash);
347 Perl_save_ary(pTHX_ GV *gv)
349 AV * const oav = GvAVn(gv);
352 PERL_ARGS_ASSERT_SAVE_ARY;
354 if (UNLIKELY(!AvREAL(oav) && AvREIFY(oav)))
356 save_pushptrptr(SvREFCNT_inc_simple_NN(gv), oav, SAVEt_AV);
360 if (UNLIKELY(SvMAGIC(oav)))
361 mg_localize(MUTABLE_SV(oav), MUTABLE_SV(av), TRUE);
366 Perl_save_hash(pTHX_ GV *gv)
370 PERL_ARGS_ASSERT_SAVE_HASH;
373 SvREFCNT_inc_simple_NN(gv), (ohv = GvHVn(gv)), SAVEt_HV
378 if (UNLIKELY(SvMAGIC(ohv)))
379 mg_localize(MUTABLE_SV(ohv), MUTABLE_SV(hv), TRUE);
384 Perl_save_item(pTHX_ SV *item)
386 SV * const sv = newSVsv(item);
388 PERL_ARGS_ASSERT_SAVE_ITEM;
390 save_pushptrptr(item, /* remember the pointer */
391 sv, /* remember the value */
396 Perl_save_bool(pTHX_ bool *boolp)
400 PERL_ARGS_ASSERT_SAVE_BOOL;
403 SS_ADD_UV(SAVEt_BOOL | (*boolp << 8));
408 Perl_save_pushi32ptr(pTHX_ const I32 i, void *const ptr, const int type)
419 Perl_save_int(pTHX_ int *intp)
422 UV type = ((UV)((UV)i << SAVE_TIGHT_SHIFT) | SAVEt_INT_SMALL);
426 PERL_ARGS_ASSERT_SAVE_INT;
428 if (UNLIKELY((int)(type >> SAVE_TIGHT_SHIFT) != i)) {
439 Perl_save_I8(pTHX_ I8 *bytep)
443 PERL_ARGS_ASSERT_SAVE_I8;
446 SS_ADD_UV(SAVEt_I8 | ((UV)*bytep << 8));
451 Perl_save_I16(pTHX_ I16 *intp)
455 PERL_ARGS_ASSERT_SAVE_I16;
458 SS_ADD_UV(SAVEt_I16 | ((UV)*intp << 8));
463 Perl_save_I32(pTHX_ I32 *intp)
466 UV type = ((I32)((U32)i << SAVE_TIGHT_SHIFT) | SAVEt_I32_SMALL);
470 PERL_ARGS_ASSERT_SAVE_I32;
472 if (UNLIKELY((I32)(type >> SAVE_TIGHT_SHIFT) != i)) {
483 Perl_save_strlen(pTHX_ STRLEN *ptr)
487 PERL_ARGS_ASSERT_SAVE_STRLEN;
491 SS_ADD_UV(SAVEt_STRLEN);
495 /* Cannot use save_sptr() to store a char* since the SV** cast will
496 * force word-alignment and we'll miss the pointer.
499 Perl_save_pptr(pTHX_ char **pptr)
501 PERL_ARGS_ASSERT_SAVE_PPTR;
503 save_pushptrptr(*pptr, pptr, SAVEt_PPTR);
507 Perl_save_vptr(pTHX_ void *ptr)
509 PERL_ARGS_ASSERT_SAVE_VPTR;
511 save_pushptrptr(*(char**)ptr, ptr, SAVEt_VPTR);
515 Perl_save_sptr(pTHX_ SV **sptr)
517 PERL_ARGS_ASSERT_SAVE_SPTR;
519 save_pushptrptr(*sptr, sptr, SAVEt_SPTR);
523 Perl_save_padsv_and_mortalize(pTHX_ PADOFFSET off)
527 ASSERT_CURPAD_ACTIVE("save_padsv");
528 SS_ADD_PTR(SvREFCNT_inc_simple_NN(PL_curpad[off]));
529 SS_ADD_PTR(PL_comppad);
531 SS_ADD_UV(SAVEt_PADSV_AND_MORTALIZE);
536 Perl_save_hptr(pTHX_ HV **hptr)
538 PERL_ARGS_ASSERT_SAVE_HPTR;
540 save_pushptrptr(*hptr, hptr, SAVEt_HPTR);
544 Perl_save_aptr(pTHX_ AV **aptr)
546 PERL_ARGS_ASSERT_SAVE_APTR;
548 save_pushptrptr(*aptr, aptr, SAVEt_APTR);
552 Perl_save_pushptr(pTHX_ void *const ptr, const int type)
561 Perl_save_clearsv(pTHX_ SV **svp)
563 const UV offset = svp - PL_curpad;
564 const UV offset_shifted = offset << SAVE_TIGHT_SHIFT;
566 PERL_ARGS_ASSERT_SAVE_CLEARSV;
568 ASSERT_CURPAD_ACTIVE("save_clearsv");
569 SvPADSTALE_off(*svp); /* mark lexical as active */
570 if (UNLIKELY((offset_shifted >> SAVE_TIGHT_SHIFT) != offset)) {
571 Perl_croak(aTHX_ "panic: pad offset %"UVuf" out of range (%p-%p)",
572 offset, svp, PL_curpad);
577 SS_ADD_UV(offset_shifted | SAVEt_CLEARSV);
583 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
585 PERL_ARGS_ASSERT_SAVE_DELETE;
587 save_pushptri32ptr(key, klen, SvREFCNT_inc_simple(hv), SAVEt_DELETE);
591 Perl_save_hdelete(pTHX_ HV *hv, SV *keysv)
597 PERL_ARGS_ASSERT_SAVE_HDELETE;
599 key = SvPV_const(keysv, len);
600 klen = SvUTF8(keysv) ? -(I32)len : (I32)len;
601 SvREFCNT_inc_simple_void_NN(hv);
602 save_pushptri32ptr(savepvn(key, len), klen, hv, SAVEt_DELETE);
606 Perl_save_adelete(pTHX_ AV *av, SSize_t key)
610 PERL_ARGS_ASSERT_SAVE_ADELETE;
612 SvREFCNT_inc_void(av);
615 SS_ADD_IV(SAVEt_ADELETE);
620 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
623 PERL_ARGS_ASSERT_SAVE_DESTRUCTOR;
627 SS_ADD_UV(SAVEt_DESTRUCTOR);
632 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
638 SS_ADD_UV(SAVEt_DESTRUCTOR_X);
643 Perl_save_hints(pTHX)
645 COPHH *save_cophh = cophh_copy(CopHINTHASH_get(&PL_compiling));
646 if (PL_hints & HINT_LOCALIZE_HH) {
647 HV *oldhh = GvHV(PL_hintgv);
648 save_pushptri32ptr(oldhh, PL_hints, save_cophh, SAVEt_HINTS);
649 GvHV(PL_hintgv) = NULL; /* in case copying dies */
650 GvHV(PL_hintgv) = hv_copy_hints_hv(oldhh);
652 save_pushi32ptr(PL_hints, save_cophh, SAVEt_HINTS);
657 S_save_pushptri32ptr(pTHX_ void *const ptr1, const I32 i, void *const ptr2,
669 Perl_save_aelem_flags(pTHX_ AV *av, SSize_t idx, SV **sptr,
675 PERL_ARGS_ASSERT_SAVE_AELEM_FLAGS;
678 SS_ADD_PTR(SvREFCNT_inc_simple(av));
680 SS_ADD_PTR(SvREFCNT_inc(*sptr));
681 SS_ADD_UV(SAVEt_AELEM);
683 /* The array needs to hold a reference count on its new element, so it
685 if (UNLIKELY(!AvREAL(av) && AvREIFY(av)))
687 save_scalar_at(sptr, flags); /* XXX - FIXME - see #60360 */
688 if (flags & SAVEf_KEEPOLDELEM)
691 /* If we're localizing a tied array element, this new sv
692 * won't actually be stored in the array - so it won't get
693 * reaped when the localize ends. Ensure it gets reaped by
694 * mortifying it instead. DAPM */
695 if (UNLIKELY(SvTIED_mg((const SV *)av, PERL_MAGIC_tied)))
700 Perl_save_helem_flags(pTHX_ HV *hv, SV *key, SV **sptr, const U32 flags)
704 PERL_ARGS_ASSERT_SAVE_HELEM_FLAGS;
709 SS_ADD_PTR(SvREFCNT_inc_simple(hv));
710 SS_ADD_PTR(newSVsv(key));
711 SS_ADD_PTR(SvREFCNT_inc(*sptr));
712 SS_ADD_UV(SAVEt_HELEM);
715 save_scalar_at(sptr, flags);
716 if (flags & SAVEf_KEEPOLDELEM)
719 /* If we're localizing a tied hash element, this new sv
720 * won't actually be stored in the hash - so it won't get
721 * reaped when the localize ends. Ensure it gets reaped by
722 * mortifying it instead. DAPM */
723 if (UNLIKELY(SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)))
728 Perl_save_svref(pTHX_ SV **sptr)
730 PERL_ARGS_ASSERT_SAVE_SVREF;
733 save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_SVREF);
734 return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
738 Perl_save_alloc(pTHX_ I32 size, I32 pad)
740 const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
741 - (char*)PL_savestack);
742 const UV elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
743 const UV elems_shifted = elems << SAVE_TIGHT_SHIFT;
745 if (UNLIKELY((elems_shifted >> SAVE_TIGHT_SHIFT) != elems))
747 "panic: save_alloc elems %"UVuf" out of range (%"IVdf"-%"IVdf")",
748 elems, (IV)size, (IV)pad);
752 PL_savestack_ix += elems;
753 SSPUSHUV(SAVEt_ALLOC | elems_shifted);
759 #define ARG0_SV MUTABLE_SV(arg0.any_ptr)
760 #define ARG0_AV MUTABLE_AV(arg0.any_ptr)
761 #define ARG0_HV MUTABLE_HV(arg0.any_ptr)
762 #define ARG0_PTR arg0.any_ptr
763 #define ARG0_PV (char*)(arg0.any_ptr)
764 #define ARG0_PVP (char**)(arg0.any_ptr)
765 #define ARG0_I32 (arg0.any_i32)
767 #define ARG1_SV MUTABLE_SV(arg1.any_ptr)
768 #define ARG1_AV MUTABLE_AV(arg1.any_ptr)
769 #define ARG1_GV MUTABLE_GV(arg1.any_ptr)
770 #define ARG1_SVP (SV**)(arg1.any_ptr)
771 #define ARG1_PVP (char**)(arg1.any_ptr)
772 #define ARG1_PTR arg1.any_ptr
773 #define ARG1_PV (char*)(arg1.any_ptr)
774 #define ARG1_I32 (arg1.any_i32)
776 #define ARG2_SV MUTABLE_SV(arg2.any_ptr)
777 #define ARG2_AV MUTABLE_AV(arg2.any_ptr)
778 #define ARG2_HV MUTABLE_HV(arg2.any_ptr)
779 #define ARG2_GV MUTABLE_GV(arg2.any_ptr)
780 #define ARG2_PV (char*)(arg2.any_ptr)
783 Perl_leave_scope(pTHX_ I32 base)
785 /* Localise the effects of the TAINT_NOT inside the loop. */
786 bool was = TAINT_get;
791 ANY arg0, arg1, arg2;
793 /* these initialisations are logically unnecessary, but they shut up
794 * spurious 'may be used uninitialized' compiler warnings */
799 if (UNLIKELY(base < -1))
800 Perl_croak(aTHX_ "panic: corrupt saved stack index %ld", (long) base);
801 DEBUG_l(Perl_deb(aTHX_ "savestack: releasing items %ld -> %ld\n",
802 (long)PL_savestack_ix, (long)base));
803 while (PL_savestack_ix > base) {
813 I32 ix = PL_savestack_ix - 1;
814 ANY *p = &PL_savestack[ix];
816 type = (U8)uv & SAVE_MASK;
817 if (type > SAVEt_ARG0_MAX) {
820 if (type > SAVEt_ARG1_MAX) {
822 if (type > SAVEt_ARG2_MAX) {
828 PL_savestack_ix = ix;
832 case SAVEt_ITEM: /* normal string */
833 sv_replace(ARG1_SV, ARG0_SV);
834 if (UNLIKELY(SvSMAGICAL(ARG1_SV))) {
841 /* This would be a mathom, but Perl_save_svref() calls a static
842 function, S_save_scalar_at(), so has to stay in this file. */
843 case SAVEt_SVREF: /* scalar reference */
845 refsv = NULL; /* what to refcnt_dec */
848 case SAVEt_SV: /* scalar reference */
849 svp = &GvSV(ARG1_GV);
850 refsv = ARG1_SV; /* what to refcnt_dec */
853 SV * const sv = *svp;
856 if (UNLIKELY(SvSMAGICAL(ARG0_SV))) {
857 /* mg_set could die, skipping the freeing of ARG0_SV and
858 * refsv; Ensure that they're always freed in that case */
861 SS_ADD_UV(SAVEt_FREESV);
863 SS_ADD_UV(SAVEt_FREESV);
870 SvREFCNT_dec_NN(ARG0_SV);
874 case SAVEt_GENERIC_PVREF: /* generic pv */
875 if (*ARG0_PVP != ARG1_PV) {
880 case SAVEt_SHARED_PVREF: /* shared pv */
881 if (*ARG1_PVP != ARG0_PV) {
883 PerlMem_free(*ARG1_PVP);
885 PerlMemShared_free(*ARG1_PVP);
890 case SAVEt_GVSV: /* scalar slot in GV */
891 svp = &GvSV(ARG1_GV);
893 case SAVEt_GENERIC_SVREF: /* generic sv */
897 SV * const sv = *svp;
900 SvREFCNT_dec(ARG0_SV);
903 case SAVEt_GVSLOT: /* any slot in GV */
905 HV *const hv = GvSTASH(ARG2_GV);
907 if (hv && HvENAME(hv) && (
908 (ARG0_SV && SvTYPE(ARG0_SV) == SVt_PVCV)
909 || (*svp && SvTYPE(*svp) == SVt_PVCV)
912 if ((char *)svp < (char *)GvGP(ARG2_GV)
913 || (char *)svp > (char *)GvGP(ARG2_GV) + sizeof(struct gp)
914 || GvREFCNT(ARG2_GV) > 2) /* "> 2" to ignore savestack's ref */
916 else mro_method_changed_in(hv);
920 case SAVEt_AV: /* array reference */
921 SvREFCNT_dec(GvAV(ARG1_GV));
922 GvAV(ARG1_GV) = ARG0_AV;
924 if (UNLIKELY(SvSMAGICAL(ARG0_SV))) {
925 /* mg_set might die, so make sure ARG1 isn't leaked */
928 SS_ADD_UV(SAVEt_FREESV);
935 SvREFCNT_dec_NN(ARG1_GV);
937 case SAVEt_HV: /* hash reference */
938 SvREFCNT_dec(GvHV(ARG1_GV));
939 GvHV(ARG1_GV) = ARG0_HV;
942 case SAVEt_INT_SMALL:
943 *(int*)ARG0_PTR = (int)(uv >> SAVE_TIGHT_SHIFT);
945 case SAVEt_INT: /* int reference */
946 *(int*)ARG0_PTR = (int)ARG1_I32;
948 case SAVEt_STRLEN: /* STRLEN/size_t ref */
949 *(STRLEN*)ARG0_PTR = (STRLEN)arg1.any_iv;
951 case SAVEt_BOOL: /* bool reference */
952 *(bool*)ARG0_PTR = cBOOL(uv >> 8);
953 #ifdef NO_TAINT_SUPPORT
954 PERL_UNUSED_VAR(was);
956 if (UNLIKELY(ARG0_PTR == &(TAINT_get))) {
957 /* If we don't update <was>, to reflect what was saved on the
958 * stack for PL_tainted, then we will overwrite this attempt to
959 * restore it when we exit this routine. Note that this won't
960 * work if this value was saved in a wider-than necessary type,
962 was = *(bool*)ARG0_PTR;
966 case SAVEt_I32_SMALL:
967 *(I32*)ARG0_PTR = (I32)(uv >> SAVE_TIGHT_SHIFT);
969 case SAVEt_I32: /* I32 reference */
970 #ifdef PERL_DEBUG_READONLY_OPS
971 if (*(I32*)ARG0_PTR != ARG1_I32)
973 *(I32*)ARG0_PTR = ARG1_I32;
975 case SAVEt_SPTR: /* SV* reference */
976 *(SV**)(ARG0_PTR)= ARG1_SV;
978 case SAVEt_VPTR: /* random* reference */
979 case SAVEt_PPTR: /* char* reference */
982 case SAVEt_HPTR: /* HV* reference */
983 *(HV**)ARG0_PTR = MUTABLE_HV(ARG1_PTR);
985 case SAVEt_APTR: /* AV* reference */
986 *(AV**)ARG0_PTR = ARG1_AV;
988 case SAVEt_GP: /* scalar reference */
991 /* possibly taking a method out of circulation */
992 const bool had_method = !!GvCVu(ARG1_GV);
994 GvGP_set(ARG1_GV, (GP*)ARG0_PTR);
995 if ((hv=GvSTASH(ARG1_GV)) && HvENAME_get(hv)) {
996 if ( GvNAMELEN(ARG1_GV) == 3
997 && strnEQ(GvNAME(ARG1_GV), "ISA", 3)
999 mro_isa_changed_in(hv);
1000 else if (had_method || GvCVu(ARG1_GV))
1001 /* putting a method back into circulation ("local")*/
1002 gv_method_changed(ARG1_GV);
1004 SvREFCNT_dec_NN(ARG1_GV);
1008 SvREFCNT_dec(ARG0_SV);
1010 case SAVEt_FREEPADNAME:
1011 PadnameREFCNT_dec((PADNAME *)ARG0_PTR);
1013 case SAVEt_FREECOPHH:
1014 cophh_free((COPHH *)ARG0_PTR);
1016 case SAVEt_MORTALIZESV:
1017 sv_2mortal(ARG0_SV);
1020 ASSERT_CURPAD_LEGAL("SAVEt_FREEOP");
1021 op_free((OP*)ARG0_PTR);
1027 case SAVEt_CLEARPADRANGE:
1028 i = (I32)((uv >> SAVE_TIGHT_SHIFT) & OPpPADRANGE_COUNTMASK);
1029 svp = &PL_curpad[uv >>
1030 (OPpPADRANGE_COUNTSHIFT + SAVE_TIGHT_SHIFT)] + i - 1;
1033 svp = &PL_curpad[uv >> SAVE_TIGHT_SHIFT];
1036 for (; i; i--, svp--) {
1039 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1040 "Pad 0x%"UVxf"[0x%"UVxf"] clearsv: %ld sv=0x%"UVxf"<%"IVdf"> %s\n",
1041 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
1042 (long)(svp-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
1043 (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
1046 /* Can clear pad variable in place? */
1047 if (SvREFCNT(sv) == 1 && !SvOBJECT(sv)) {
1049 /* these flags are the union of all the relevant flags
1050 * in the individual conditions within */
1051 if (UNLIKELY(SvFLAGS(sv) & (
1052 SVf_READONLY|SVf_PROTECT /*for SvREADONLY_off*/
1053 | (SVs_GMG|SVs_SMG|SVs_RMG) /* SvMAGICAL() */
1057 /* if a my variable that was made readonly is
1058 * going out of scope, we want to remove the
1059 * readonlyness so that it can go out of scope
1065 if (SvOOK(sv)) { /* OOK or HvAUX */
1066 if (SvTYPE(sv) == SVt_PVHV)
1067 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
1072 if (SvMAGICAL(sv)) {
1073 /* note that backrefs (either in HvAUX or magic)
1074 * must be removed before other magic */
1075 sv_unmagic(sv, PERL_MAGIC_backref);
1076 if (SvTYPE(sv) != SVt_PVCV)
1079 if (SvTHINKFIRST(sv))
1080 sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF
1084 switch (SvTYPE(sv)) {
1088 av_clear(MUTABLE_AV(sv));
1091 hv_clear(MUTABLE_HV(sv));
1097 ? CvNAME_HEK((CV *)sv)
1098 : GvNAME_HEK(CvGV(sv));
1100 (void)share_hek_hek(hek);
1102 CvNAME_HEK_set(sv, hek);
1107 /* This looks odd, but these two macros are for use in
1108 expressions and finish with a trailing comma, so
1109 adding a ; after them would be wrong. */
1112 SvFLAGS(sv) &=~ (SVf_OK|SVf_IVisUV|SVf_UTF8);
1116 SvPADSTALE_on(sv); /* mark as no longer live */
1118 else { /* Someone has a claim on this, so abandon it. */
1119 switch (SvTYPE(sv)) { /* Console ourselves with a new value */
1120 case SVt_PVAV: *svp = MUTABLE_SV(newAV()); break;
1121 case SVt_PVHV: *svp = MUTABLE_SV(newHV()); break;
1124 HEK * const hek = CvNAMED(sv)
1125 ? CvNAME_HEK((CV *)sv)
1126 : GvNAME_HEK(CvGV(sv));
1129 *svp = newSV_type(SVt_PVCV);
1132 CvNAME_HEK_set(*svp,
1133 share_hek_hek(hek));
1137 default: *svp = newSV(0); break;
1139 SvREFCNT_dec_NN(sv); /* Cast current value to the winds. */
1140 /* preserve pad nature, but also mark as not live
1141 * for any closure capturing */
1142 SvFLAGS(*svp) |= SVs_PADSTALE;
1147 (void)hv_delete(ARG0_HV, ARG2_PV, ARG1_I32, G_DISCARD);
1148 SvREFCNT_dec(ARG0_HV);
1149 Safefree(arg2.any_ptr);
1152 (void)av_delete(ARG0_AV, arg1.any_iv, G_DISCARD);
1153 SvREFCNT_dec(ARG0_AV);
1155 case SAVEt_DESTRUCTOR_X:
1156 (*arg1.any_dxptr)(aTHX_ ARG0_PTR);
1158 case SAVEt_REGCONTEXT:
1159 /* regexp must have croaked */
1161 PL_savestack_ix -= uv >> SAVE_TIGHT_SHIFT;
1163 case SAVEt_STACK_POS: /* Position on Perl stack */
1164 PL_stack_sp = PL_stack_base + arg0.any_i32;
1166 case SAVEt_AELEM: /* array element */
1167 svp = av_fetch(ARG2_AV, arg1.any_iv, 1);
1168 if (UNLIKELY(!AvREAL(ARG2_AV) && AvREIFY(ARG2_AV))) /* undo reify guard */
1169 SvREFCNT_dec(ARG0_SV);
1171 SV * const sv = *svp;
1172 if (LIKELY(sv && sv != &PL_sv_undef)) {
1173 if (UNLIKELY(SvTIED_mg((const SV *)ARG2_AV, PERL_MAGIC_tied)))
1174 SvREFCNT_inc_void_NN(sv);
1179 SvREFCNT_dec(ARG2_AV);
1180 SvREFCNT_dec(ARG0_SV);
1182 case SAVEt_HELEM: /* hash element */
1184 HE * const he = hv_fetch_ent(ARG2_HV, ARG1_SV, 1, 0);
1185 SvREFCNT_dec(ARG1_SV);
1187 const SV * const oval = HeVAL(he);
1188 if (LIKELY(oval && oval != &PL_sv_undef)) {
1190 if (UNLIKELY(SvTIED_mg((const SV *)ARG2_HV, PERL_MAGIC_tied)))
1191 SvREFCNT_inc_void(*svp);
1192 refsv = ARG2_SV; /* what to refcnt_dec */
1196 SvREFCNT_dec(ARG2_HV);
1197 SvREFCNT_dec(ARG0_SV);
1201 PL_op = (OP*)ARG0_PTR;
1204 if ((PL_hints & HINT_LOCALIZE_HH)) {
1205 while (GvHV(PL_hintgv)) {
1206 HV *hv = GvHV(PL_hintgv);
1207 GvHV(PL_hintgv) = NULL;
1208 SvREFCNT_dec(MUTABLE_SV(hv));
1211 cophh_free(CopHINTHASH_get(&PL_compiling));
1212 CopHINTHASH_set(&PL_compiling, (COPHH*)ARG0_PTR);
1213 *(I32*)&PL_hints = ARG1_I32;
1214 if (PL_hints & HINT_LOCALIZE_HH) {
1215 SvREFCNT_dec(MUTABLE_SV(GvHV(PL_hintgv)));
1216 GvHV(PL_hintgv) = MUTABLE_HV(SSPOPPTR);
1218 if (!GvHV(PL_hintgv)) {
1219 /* Need to add a new one manually, else rv2hv can
1220 add one via GvHVn and it won't have the magic set. */
1221 HV *const hv = newHV();
1222 hv_magic(hv, NULL, PERL_MAGIC_hints);
1223 GvHV(PL_hintgv) = hv;
1225 assert(GvHV(PL_hintgv));
1228 PL_comppad = (PAD*)ARG0_PTR;
1229 if (LIKELY(PL_comppad))
1230 PL_curpad = AvARRAY(PL_comppad);
1234 case SAVEt_PADSV_AND_MORTALIZE:
1238 svp = AvARRAY((PAD*)ARG1_PTR) + (PADOFFSET)arg0.any_uv;
1239 /* This mortalizing used to be done by POPLOOP() via itersave.
1240 But as we have all the information here, we can do it here,
1241 save even having to have itersave in the struct. */
1246 case SAVEt_SAVESWITCHSTACK:
1249 SWITCHSTACK(ARG0_AV, ARG1_AV);
1250 PL_curstackinfo->si_stack = ARG1_AV;
1253 case SAVEt_SET_SVFLAGS:
1254 SvFLAGS(ARG2_SV) &= ~((U32)ARG1_I32);
1255 SvFLAGS(ARG2_SV) |= (U32)ARG0_I32;
1258 /* These are only saved in mathoms.c */
1260 (void)sv_clear(ARG0_SV);
1262 case SAVEt_LONG: /* long reference */
1263 *(long*)ARG0_PTR = arg1.any_long;
1265 case SAVEt_IV: /* IV reference */
1266 *(IV*)ARG0_PTR = arg1.any_iv;
1269 case SAVEt_I16: /* I16 reference */
1270 *(I16*)ARG0_PTR = (I16)(uv >> 8);
1272 case SAVEt_I8: /* I8 reference */
1273 *(I8*)ARG0_PTR = (I8)(uv >> 8);
1275 case SAVEt_DESTRUCTOR:
1276 (*arg1.any_dptr)(ARG0_PTR);
1278 case SAVEt_COMPILE_WARNINGS:
1279 if (!specialWARN(PL_compiling.cop_warnings))
1280 PerlMemShared_free(PL_compiling.cop_warnings);
1282 PL_compiling.cop_warnings = (STRLEN*)ARG0_PTR;
1285 parser_free((yy_parser *) ARG0_PTR);
1287 case SAVEt_READONLY_OFF:
1288 SvREADONLY_off(ARG0_SV);
1291 Perl_croak(aTHX_ "panic: leave_scope inconsistency %u", type);
1299 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1301 PERL_ARGS_ASSERT_CX_DUMP;
1304 PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1305 if (CxTYPE(cx) != CXt_SUBST) {
1306 const char *gimme_text;
1307 PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1308 PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
1309 PTR2UV(cx->blk_oldcop));
1310 PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1311 PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1312 PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
1313 PTR2UV(cx->blk_oldpm));
1314 switch (cx->blk_gimme) {
1316 gimme_text = "VOID";
1319 gimme_text = "SCALAR";
1322 gimme_text = "LIST";
1325 gimme_text = "UNKNOWN";
1328 PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", gimme_text);
1330 switch (CxTYPE(cx)) {
1335 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.CV = 0x%"UVxf"\n",
1336 PTR2UV(cx->blk_format.cv));
1337 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.GV = 0x%"UVxf"\n",
1338 PTR2UV(cx->blk_format.gv));
1339 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.DFOUTGV = 0x%"UVxf"\n",
1340 PTR2UV(cx->blk_format.dfoutgv));
1341 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.HASARGS = %d\n",
1342 (int)CxHASARGS(cx));
1343 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.RETOP = 0x%"UVxf"\n",
1344 PTR2UV(cx->blk_format.retop));
1347 PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1348 PTR2UV(cx->blk_sub.cv));
1349 PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1350 (long)cx->blk_sub.olddepth);
1351 PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1352 (int)CxHASARGS(cx));
1353 PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n", (int)CxLVAL(cx));
1354 PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1355 PTR2UV(cx->blk_sub.retop));
1358 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1359 (long)CxOLD_IN_EVAL(cx));
1360 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1361 PL_op_name[CxOLD_OP_TYPE(cx)],
1362 PL_op_desc[CxOLD_OP_TYPE(cx)]);
1363 if (cx->blk_eval.old_namesv)
1364 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1365 SvPVX_const(cx->blk_eval.old_namesv));
1366 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1367 PTR2UV(cx->blk_eval.old_eval_root));
1368 PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%"UVxf"\n",
1369 PTR2UV(cx->blk_eval.retop));
1372 case CXt_LOOP_LAZYIV:
1373 case CXt_LOOP_LAZYSV:
1375 case CXt_LOOP_PLAIN:
1376 PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n", CxLABEL(cx));
1377 PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
1378 (long)cx->blk_loop.resetsp);
1379 PerlIO_printf(Perl_debug_log, "BLK_LOOP.MY_OP = 0x%"UVxf"\n",
1380 PTR2UV(cx->blk_loop.my_op));
1381 /* XXX: not accurate for LAZYSV/IV */
1382 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1383 PTR2UV(cx->blk_loop.state_u.ary.ary));
1384 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1385 (long)cx->blk_loop.state_u.ary.ix);
1386 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1387 PTR2UV(CxITERVAR(cx)));
1391 PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1392 (long)cx->sb_iters);
1393 PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1394 (long)cx->sb_maxiters);
1395 PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1396 (long)cx->sb_rflags);
1397 PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1399 PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1401 PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1402 PTR2UV(cx->sb_dstr));
1403 PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1404 PTR2UV(cx->sb_targ));
1405 PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1407 PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1409 PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1410 PTR2UV(cx->sb_strend));
1411 PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1412 PTR2UV(cx->sb_rxres));
1416 PERL_UNUSED_CONTEXT;
1417 PERL_UNUSED_ARG(cx);
1418 #endif /* DEBUGGING */
1422 * ex: set ts=8 sts=4 sw=4 et: