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 if (flags & SAVEf_KEEPOLDELEM)
216 sv = (*sptr = newSV(0));
217 if (SvTYPE(osv) >= SVt_PVMG && SvMAGIC(osv))
218 mg_localize(osv, sv, cBOOL(flags & SAVEf_SETMAGIC));
225 Perl_save_pushptrptr(pTHX_ void *const ptr1, void *const ptr2, const int type)
235 Perl_save_scalar(pTHX_ GV *gv)
237 SV ** const sptr = &GvSVn(gv);
239 PERL_ARGS_ASSERT_SAVE_SCALAR;
241 if (UNLIKELY(SvGMAGICAL(*sptr))) {
246 save_pushptrptr(SvREFCNT_inc_simple(gv), SvREFCNT_inc(*sptr), SAVEt_SV);
247 return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
250 /* Like save_sptr(), but also SvREFCNT_dec()s the new value. Can be used to
251 * restore a global SV to its prior contents, freeing new value. */
253 Perl_save_generic_svref(pTHX_ SV **sptr)
255 PERL_ARGS_ASSERT_SAVE_GENERIC_SVREF;
257 save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_GENERIC_SVREF);
260 /* Like save_pptr(), but also Safefree()s the new value if it is different
261 * from the old one. Can be used to restore a global char* to its prior
262 * contents, freeing new value. */
264 Perl_save_generic_pvref(pTHX_ char **str)
266 PERL_ARGS_ASSERT_SAVE_GENERIC_PVREF;
268 save_pushptrptr(*str, str, SAVEt_GENERIC_PVREF);
271 /* Like save_generic_pvref(), but uses PerlMemShared_free() rather than Safefree().
272 * Can be used to restore a shared global char* to its prior
273 * contents, freeing new value. */
275 Perl_save_shared_pvref(pTHX_ char **str)
277 PERL_ARGS_ASSERT_SAVE_SHARED_PVREF;
279 save_pushptrptr(str, *str, SAVEt_SHARED_PVREF);
282 /* set the SvFLAGS specified by mask to the values in val */
285 Perl_save_set_svflags(pTHX_ SV* sv, U32 mask, U32 val)
289 PERL_ARGS_ASSERT_SAVE_SET_SVFLAGS;
294 SS_ADD_UV(SAVEt_SET_SVFLAGS);
301 Saves the current GP of gv on the save stack to be restored on scope exit.
303 If empty is true, replace the GP with a new GP.
305 If empty is false, mark gv with GVf_INTRO so the next reference
306 assigned is localized, which is how C< local *foo = $someref; > works.
312 Perl_save_gp(pTHX_ GV *gv, I32 empty)
314 PERL_ARGS_ASSERT_SAVE_GP;
316 save_pushptrptr(SvREFCNT_inc(gv), GvGP(gv), SAVEt_GP);
319 GP *gp = Perl_newGP(aTHX_ gv);
320 HV * const stash = GvSTASH(gv);
321 bool isa_changed = 0;
323 if (stash && HvENAME(stash)) {
324 if (GvNAMELEN(gv) == 3 && strnEQ(GvNAME(gv), "ISA", 3))
327 /* taking a method out of circulation ("local")*/
328 mro_method_changed_in(stash);
330 if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
332 IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
335 if (isa_changed) mro_isa_changed_in(stash);
344 Perl_save_ary(pTHX_ GV *gv)
346 AV * const oav = GvAVn(gv);
349 PERL_ARGS_ASSERT_SAVE_ARY;
351 if (UNLIKELY(!AvREAL(oav) && AvREIFY(oav)))
353 save_pushptrptr(SvREFCNT_inc_simple_NN(gv), oav, SAVEt_AV);
357 if (UNLIKELY(SvMAGIC(oav)))
358 mg_localize(MUTABLE_SV(oav), MUTABLE_SV(av), TRUE);
363 Perl_save_hash(pTHX_ GV *gv)
367 PERL_ARGS_ASSERT_SAVE_HASH;
370 SvREFCNT_inc_simple_NN(gv), (ohv = GvHVn(gv)), SAVEt_HV
375 if (UNLIKELY(SvMAGIC(ohv)))
376 mg_localize(MUTABLE_SV(ohv), MUTABLE_SV(hv), TRUE);
381 Perl_save_item(pTHX_ SV *item)
383 SV * const sv = newSVsv(item);
385 PERL_ARGS_ASSERT_SAVE_ITEM;
387 save_pushptrptr(item, /* remember the pointer */
388 sv, /* remember the value */
393 Perl_save_bool(pTHX_ bool *boolp)
397 PERL_ARGS_ASSERT_SAVE_BOOL;
400 SS_ADD_UV(SAVEt_BOOL | (*boolp << 8));
405 Perl_save_pushi32ptr(pTHX_ const I32 i, void *const ptr, const int type)
416 Perl_save_int(pTHX_ int *intp)
419 UV type = ((UV)((UV)i << SAVE_TIGHT_SHIFT) | SAVEt_INT_SMALL);
423 PERL_ARGS_ASSERT_SAVE_INT;
425 if (UNLIKELY((int)(type >> SAVE_TIGHT_SHIFT) != i)) {
436 Perl_save_I8(pTHX_ I8 *bytep)
440 PERL_ARGS_ASSERT_SAVE_I8;
443 SS_ADD_UV(SAVEt_I8 | ((UV)*bytep << 8));
448 Perl_save_I16(pTHX_ I16 *intp)
452 PERL_ARGS_ASSERT_SAVE_I16;
455 SS_ADD_UV(SAVEt_I16 | ((UV)*intp << 8));
460 Perl_save_I32(pTHX_ I32 *intp)
463 UV type = ((I32)((U32)i << SAVE_TIGHT_SHIFT) | SAVEt_I32_SMALL);
467 PERL_ARGS_ASSERT_SAVE_I32;
469 if (UNLIKELY((I32)(type >> SAVE_TIGHT_SHIFT) != i)) {
480 Perl_save_strlen(pTHX_ STRLEN *ptr)
484 PERL_ARGS_ASSERT_SAVE_STRLEN;
488 SS_ADD_UV(SAVEt_STRLEN);
492 /* Cannot use save_sptr() to store a char* since the SV** cast will
493 * force word-alignment and we'll miss the pointer.
496 Perl_save_pptr(pTHX_ char **pptr)
498 PERL_ARGS_ASSERT_SAVE_PPTR;
500 save_pushptrptr(*pptr, pptr, SAVEt_PPTR);
504 Perl_save_vptr(pTHX_ void *ptr)
506 PERL_ARGS_ASSERT_SAVE_VPTR;
508 save_pushptrptr(*(char**)ptr, ptr, SAVEt_VPTR);
512 Perl_save_sptr(pTHX_ SV **sptr)
514 PERL_ARGS_ASSERT_SAVE_SPTR;
516 save_pushptrptr(*sptr, sptr, SAVEt_SPTR);
520 Perl_save_padsv_and_mortalize(pTHX_ PADOFFSET off)
524 ASSERT_CURPAD_ACTIVE("save_padsv");
525 SS_ADD_PTR(SvREFCNT_inc_simple_NN(PL_curpad[off]));
526 SS_ADD_PTR(PL_comppad);
528 SS_ADD_UV(SAVEt_PADSV_AND_MORTALIZE);
533 Perl_save_hptr(pTHX_ HV **hptr)
535 PERL_ARGS_ASSERT_SAVE_HPTR;
537 save_pushptrptr(*hptr, hptr, SAVEt_HPTR);
541 Perl_save_aptr(pTHX_ AV **aptr)
543 PERL_ARGS_ASSERT_SAVE_APTR;
545 save_pushptrptr(*aptr, aptr, SAVEt_APTR);
549 Perl_save_pushptr(pTHX_ void *const ptr, const int type)
558 Perl_save_clearsv(pTHX_ SV **svp)
560 const UV offset = svp - PL_curpad;
561 const UV offset_shifted = offset << SAVE_TIGHT_SHIFT;
563 PERL_ARGS_ASSERT_SAVE_CLEARSV;
565 ASSERT_CURPAD_ACTIVE("save_clearsv");
566 SvPADSTALE_off(*svp); /* mark lexical as active */
567 if (UNLIKELY((offset_shifted >> SAVE_TIGHT_SHIFT) != offset)) {
568 Perl_croak(aTHX_ "panic: pad offset %"UVuf" out of range (%p-%p)",
569 offset, svp, PL_curpad);
574 SS_ADD_UV(offset_shifted | SAVEt_CLEARSV);
580 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
582 PERL_ARGS_ASSERT_SAVE_DELETE;
584 save_pushptri32ptr(key, klen, SvREFCNT_inc_simple(hv), SAVEt_DELETE);
588 Perl_save_hdelete(pTHX_ HV *hv, SV *keysv)
594 PERL_ARGS_ASSERT_SAVE_HDELETE;
596 key = SvPV_const(keysv, len);
597 klen = SvUTF8(keysv) ? -(I32)len : (I32)len;
598 SvREFCNT_inc_simple_void_NN(hv);
599 save_pushptri32ptr(savepvn(key, len), klen, hv, SAVEt_DELETE);
603 Perl_save_adelete(pTHX_ AV *av, SSize_t key)
607 PERL_ARGS_ASSERT_SAVE_ADELETE;
609 SvREFCNT_inc_void(av);
612 SS_ADD_IV(SAVEt_ADELETE);
617 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
620 PERL_ARGS_ASSERT_SAVE_DESTRUCTOR;
624 SS_ADD_UV(SAVEt_DESTRUCTOR);
629 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
635 SS_ADD_UV(SAVEt_DESTRUCTOR_X);
640 Perl_save_hints(pTHX)
642 COPHH *save_cophh = cophh_copy(CopHINTHASH_get(&PL_compiling));
643 if (PL_hints & HINT_LOCALIZE_HH) {
644 HV *oldhh = GvHV(PL_hintgv);
645 save_pushptri32ptr(oldhh, PL_hints, save_cophh, SAVEt_HINTS);
646 GvHV(PL_hintgv) = NULL; /* in case copying dies */
647 GvHV(PL_hintgv) = hv_copy_hints_hv(oldhh);
649 save_pushi32ptr(PL_hints, save_cophh, SAVEt_HINTS);
654 S_save_pushptri32ptr(pTHX_ void *const ptr1, const I32 i, void *const ptr2,
666 Perl_save_aelem_flags(pTHX_ AV *av, SSize_t idx, SV **sptr,
672 PERL_ARGS_ASSERT_SAVE_AELEM_FLAGS;
675 SS_ADD_PTR(SvREFCNT_inc_simple(av));
677 SS_ADD_PTR(SvREFCNT_inc(*sptr));
678 SS_ADD_UV(SAVEt_AELEM);
680 /* The array needs to hold a reference count on its new element, so it
682 if (UNLIKELY(!AvREAL(av) && AvREIFY(av)))
684 save_scalar_at(sptr, flags); /* XXX - FIXME - see #60360 */
685 if (flags & SAVEf_KEEPOLDELEM)
688 /* If we're localizing a tied array element, this new sv
689 * won't actually be stored in the array - so it won't get
690 * reaped when the localize ends. Ensure it gets reaped by
691 * mortifying it instead. DAPM */
692 if (UNLIKELY(SvTIED_mg((const SV *)av, PERL_MAGIC_tied)))
697 Perl_save_helem_flags(pTHX_ HV *hv, SV *key, SV **sptr, const U32 flags)
701 PERL_ARGS_ASSERT_SAVE_HELEM_FLAGS;
706 SS_ADD_PTR(SvREFCNT_inc_simple(hv));
707 SS_ADD_PTR(newSVsv(key));
708 SS_ADD_PTR(SvREFCNT_inc(*sptr));
709 SS_ADD_UV(SAVEt_HELEM);
712 save_scalar_at(sptr, flags);
713 if (flags & SAVEf_KEEPOLDELEM)
716 /* If we're localizing a tied hash element, this new sv
717 * won't actually be stored in the hash - so it won't get
718 * reaped when the localize ends. Ensure it gets reaped by
719 * mortifying it instead. DAPM */
720 if (UNLIKELY(SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)))
725 Perl_save_svref(pTHX_ SV **sptr)
727 PERL_ARGS_ASSERT_SAVE_SVREF;
730 save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_SVREF);
731 return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
735 Perl_save_alloc(pTHX_ I32 size, I32 pad)
737 const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
738 - (char*)PL_savestack);
739 const UV elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
740 const UV elems_shifted = elems << SAVE_TIGHT_SHIFT;
742 if (UNLIKELY((elems_shifted >> SAVE_TIGHT_SHIFT) != elems))
744 "panic: save_alloc elems %"UVuf" out of range (%"IVdf"-%"IVdf")",
745 elems, (IV)size, (IV)pad);
749 PL_savestack_ix += elems;
750 SSPUSHUV(SAVEt_ALLOC | elems_shifted);
756 #define ARG0_SV MUTABLE_SV(arg0.any_ptr)
757 #define ARG0_AV MUTABLE_AV(arg0.any_ptr)
758 #define ARG0_HV MUTABLE_HV(arg0.any_ptr)
759 #define ARG0_PTR arg0.any_ptr
760 #define ARG0_PV (char*)(arg0.any_ptr)
761 #define ARG0_PVP (char**)(arg0.any_ptr)
762 #define ARG0_I32 (arg0.any_i32)
764 #define ARG1_SV MUTABLE_SV(arg1.any_ptr)
765 #define ARG1_AV MUTABLE_AV(arg1.any_ptr)
766 #define ARG1_GV MUTABLE_GV(arg1.any_ptr)
767 #define ARG1_SVP (SV**)(arg1.any_ptr)
768 #define ARG1_PVP (char**)(arg1.any_ptr)
769 #define ARG1_PTR arg1.any_ptr
770 #define ARG1_PV (char*)(arg1.any_ptr)
771 #define ARG1_I32 (arg1.any_i32)
773 #define ARG2_SV MUTABLE_SV(arg2.any_ptr)
774 #define ARG2_AV MUTABLE_AV(arg2.any_ptr)
775 #define ARG2_HV MUTABLE_HV(arg2.any_ptr)
776 #define ARG2_GV MUTABLE_GV(arg2.any_ptr)
777 #define ARG2_PV (char*)(arg2.any_ptr)
780 Perl_leave_scope(pTHX_ I32 base)
782 /* Localise the effects of the TAINT_NOT inside the loop. */
783 bool was = TAINT_get;
788 ANY arg0, arg1, arg2;
790 /* these initialisations are logically unnecessary, but they shut up
791 * spurious 'may be used uninitialized' compiler warnings */
796 if (UNLIKELY(base < -1))
797 Perl_croak(aTHX_ "panic: corrupt saved stack index %ld", (long) base);
798 DEBUG_l(Perl_deb(aTHX_ "savestack: releasing items %ld -> %ld\n",
799 (long)PL_savestack_ix, (long)base));
800 while (PL_savestack_ix > base) {
810 I32 ix = PL_savestack_ix - 1;
811 ANY *p = &PL_savestack[ix];
813 type = (U8)uv & SAVE_MASK;
814 if (type > SAVEt_ARG0_MAX) {
817 if (type > SAVEt_ARG1_MAX) {
819 if (type > SAVEt_ARG2_MAX) {
825 PL_savestack_ix = ix;
829 case SAVEt_ITEM: /* normal string */
830 sv_replace(ARG1_SV, ARG0_SV);
831 if (UNLIKELY(SvSMAGICAL(ARG1_SV))) {
838 /* This would be a mathom, but Perl_save_svref() calls a static
839 function, S_save_scalar_at(), so has to stay in this file. */
840 case SAVEt_SVREF: /* scalar reference */
842 refsv = NULL; /* what to refcnt_dec */
845 case SAVEt_SV: /* scalar reference */
846 svp = &GvSV(ARG1_GV);
847 refsv = ARG1_SV; /* what to refcnt_dec */
850 SV * const sv = *svp;
853 if (UNLIKELY(SvSMAGICAL(ARG0_SV))) {
854 /* mg_set could die, skipping the freeing of ARG0_SV and
855 * refsv; Ensure that they're always freed in that case */
858 SS_ADD_UV(SAVEt_FREESV);
860 SS_ADD_UV(SAVEt_FREESV);
867 SvREFCNT_dec_NN(ARG0_SV);
871 case SAVEt_GENERIC_PVREF: /* generic pv */
872 if (*ARG0_PVP != ARG1_PV) {
877 case SAVEt_SHARED_PVREF: /* shared pv */
878 if (*ARG1_PVP != ARG0_PV) {
880 PerlMem_free(*ARG1_PVP);
882 PerlMemShared_free(*ARG1_PVP);
887 case SAVEt_GVSV: /* scalar slot in GV */
888 svp = &GvSV(ARG1_GV);
890 case SAVEt_GENERIC_SVREF: /* generic sv */
894 SV * const sv = *svp;
897 SvREFCNT_dec(ARG0_SV);
900 case SAVEt_GVSLOT: /* any slot in GV */
902 HV *const hv = GvSTASH(ARG2_GV);
904 if (hv && HvENAME(hv) && (
905 (ARG0_SV && SvTYPE(ARG0_SV) == SVt_PVCV)
906 || (*svp && SvTYPE(*svp) == SVt_PVCV)
909 if ((char *)svp < (char *)GvGP(ARG2_GV)
910 || (char *)svp > (char *)GvGP(ARG2_GV) + sizeof(struct gp)
911 || GvREFCNT(ARG2_GV) > 2) /* "> 2" to ignore savestack's ref */
913 else mro_method_changed_in(hv);
917 case SAVEt_AV: /* array reference */
918 SvREFCNT_dec(GvAV(ARG1_GV));
919 GvAV(ARG1_GV) = ARG0_AV;
921 if (UNLIKELY(SvSMAGICAL(ARG0_SV))) {
922 /* mg_set might die, so make sure ARG1 isn't leaked */
925 SS_ADD_UV(SAVEt_FREESV);
932 SvREFCNT_dec_NN(ARG1_GV);
934 case SAVEt_HV: /* hash reference */
935 SvREFCNT_dec(GvHV(ARG1_GV));
936 GvHV(ARG1_GV) = ARG0_HV;
939 case SAVEt_INT_SMALL:
940 *(int*)ARG0_PTR = (int)(uv >> SAVE_TIGHT_SHIFT);
942 case SAVEt_INT: /* int reference */
943 *(int*)ARG0_PTR = (int)ARG1_I32;
945 case SAVEt_STRLEN: /* STRLEN/size_t ref */
946 *(STRLEN*)ARG0_PTR = (STRLEN)arg1.any_iv;
948 case SAVEt_BOOL: /* bool reference */
949 *(bool*)ARG0_PTR = cBOOL(uv >> 8);
950 #ifdef NO_TAINT_SUPPORT
951 PERL_UNUSED_VAR(was);
953 if (UNLIKELY(ARG0_PTR == &(TAINT_get))) {
954 /* If we don't update <was>, to reflect what was saved on the
955 * stack for PL_tainted, then we will overwrite this attempt to
956 * restore it when we exit this routine. Note that this won't
957 * work if this value was saved in a wider-than necessary type,
959 was = *(bool*)ARG0_PTR;
963 case SAVEt_I32_SMALL:
964 *(I32*)ARG0_PTR = (I32)(uv >> SAVE_TIGHT_SHIFT);
966 case SAVEt_I32: /* I32 reference */
967 #ifdef PERL_DEBUG_READONLY_OPS
968 if (*(I32*)ARG0_PTR != ARG1_I32)
970 *(I32*)ARG0_PTR = ARG1_I32;
972 case SAVEt_SPTR: /* SV* reference */
973 *(SV**)(ARG0_PTR)= ARG1_SV;
975 case SAVEt_VPTR: /* random* reference */
976 case SAVEt_PPTR: /* char* reference */
979 case SAVEt_HPTR: /* HV* reference */
980 *(HV**)ARG0_PTR = MUTABLE_HV(ARG1_PTR);
982 case SAVEt_APTR: /* AV* reference */
983 *(AV**)ARG0_PTR = ARG1_AV;
985 case SAVEt_GP: /* scalar reference */
988 /* possibly taking a method out of circulation */
989 const bool had_method = !!GvCVu(ARG1_GV);
991 GvGP_set(ARG1_GV, (GP*)ARG0_PTR);
992 if ((hv=GvSTASH(ARG1_GV)) && HvENAME_get(hv)) {
993 if ( GvNAMELEN(ARG1_GV) == 3
994 && strnEQ(GvNAME(ARG1_GV), "ISA", 3)
996 mro_isa_changed_in(hv);
997 else if (had_method || GvCVu(ARG1_GV))
998 /* putting a method back into circulation ("local")*/
999 gv_method_changed(ARG1_GV);
1001 SvREFCNT_dec_NN(ARG1_GV);
1005 SvREFCNT_dec(ARG0_SV);
1007 case SAVEt_FREEPADNAME:
1008 PadnameREFCNT_dec((PADNAME *)ARG0_PTR);
1010 case SAVEt_FREECOPHH:
1011 cophh_free((COPHH *)ARG0_PTR);
1013 case SAVEt_MORTALIZESV:
1014 sv_2mortal(ARG0_SV);
1017 ASSERT_CURPAD_LEGAL("SAVEt_FREEOP");
1018 op_free((OP*)ARG0_PTR);
1024 case SAVEt_CLEARPADRANGE:
1025 i = (I32)((uv >> SAVE_TIGHT_SHIFT) & OPpPADRANGE_COUNTMASK);
1026 svp = &PL_curpad[uv >>
1027 (OPpPADRANGE_COUNTSHIFT + SAVE_TIGHT_SHIFT)] + i - 1;
1030 svp = &PL_curpad[uv >> SAVE_TIGHT_SHIFT];
1033 for (; i; i--, svp--) {
1036 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1037 "Pad 0x%"UVxf"[0x%"UVxf"] clearsv: %ld sv=0x%"UVxf"<%"IVdf"> %s\n",
1038 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
1039 (long)(svp-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
1040 (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
1043 /* Can clear pad variable in place? */
1044 if (SvREFCNT(sv) == 1 && !SvOBJECT(sv)) {
1046 /* these flags are the union of all the relevant flags
1047 * in the individual conditions within */
1048 if (UNLIKELY(SvFLAGS(sv) & (
1049 SVf_READONLY|SVf_PROTECT /*for SvREADONLY_off*/
1050 | (SVs_GMG|SVs_SMG|SVs_RMG) /* SvMAGICAL() */
1054 /* if a my variable that was made readonly is
1055 * going out of scope, we want to remove the
1056 * readonlyness so that it can go out of scope
1062 if (SvOOK(sv)) { /* OOK or HvAUX */
1063 if (SvTYPE(sv) == SVt_PVHV)
1064 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
1069 if (SvMAGICAL(sv)) {
1070 /* note that backrefs (either in HvAUX or magic)
1071 * must be removed before other magic */
1072 sv_unmagic(sv, PERL_MAGIC_backref);
1073 if (SvTYPE(sv) != SVt_PVCV)
1076 if (SvTHINKFIRST(sv))
1077 sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF
1081 switch (SvTYPE(sv)) {
1085 av_clear(MUTABLE_AV(sv));
1088 hv_clear(MUTABLE_HV(sv));
1094 ? CvNAME_HEK((CV *)sv)
1095 : GvNAME_HEK(CvGV(sv));
1097 (void)share_hek_hek(hek);
1099 CvNAME_HEK_set(sv, hek);
1104 /* This looks odd, but these two macros are for use in
1105 expressions and finish with a trailing comma, so
1106 adding a ; after them would be wrong. */
1109 SvFLAGS(sv) &=~ (SVf_OK|SVf_IVisUV|SVf_UTF8);
1113 SvPADSTALE_on(sv); /* mark as no longer live */
1115 else { /* Someone has a claim on this, so abandon it. */
1116 switch (SvTYPE(sv)) { /* Console ourselves with a new value */
1117 case SVt_PVAV: *svp = MUTABLE_SV(newAV()); break;
1118 case SVt_PVHV: *svp = MUTABLE_SV(newHV()); break;
1121 HEK * const hek = CvNAMED(sv)
1122 ? CvNAME_HEK((CV *)sv)
1123 : GvNAME_HEK(CvGV(sv));
1126 *svp = newSV_type(SVt_PVCV);
1129 CvNAME_HEK_set(*svp,
1130 share_hek_hek(hek));
1134 default: *svp = newSV(0); break;
1136 SvREFCNT_dec_NN(sv); /* Cast current value to the winds. */
1137 /* preserve pad nature, but also mark as not live
1138 * for any closure capturing */
1139 SvFLAGS(*svp) |= SVs_PADSTALE;
1144 (void)hv_delete(ARG0_HV, ARG2_PV, ARG1_I32, G_DISCARD);
1145 SvREFCNT_dec(ARG0_HV);
1146 Safefree(arg2.any_ptr);
1149 (void)av_delete(ARG0_AV, arg1.any_iv, G_DISCARD);
1150 SvREFCNT_dec(ARG0_AV);
1152 case SAVEt_DESTRUCTOR_X:
1153 (*arg1.any_dxptr)(aTHX_ ARG0_PTR);
1155 case SAVEt_REGCONTEXT:
1156 /* regexp must have croaked */
1158 PL_savestack_ix -= uv >> SAVE_TIGHT_SHIFT;
1160 case SAVEt_STACK_POS: /* Position on Perl stack */
1161 PL_stack_sp = PL_stack_base + arg0.any_i32;
1163 case SAVEt_AELEM: /* array element */
1164 svp = av_fetch(ARG2_AV, arg1.any_iv, 1);
1165 if (UNLIKELY(!AvREAL(ARG2_AV) && AvREIFY(ARG2_AV))) /* undo reify guard */
1166 SvREFCNT_dec(ARG0_SV);
1168 SV * const sv = *svp;
1169 if (LIKELY(sv && sv != &PL_sv_undef)) {
1170 if (UNLIKELY(SvTIED_mg((const SV *)ARG2_AV, PERL_MAGIC_tied)))
1171 SvREFCNT_inc_void_NN(sv);
1176 SvREFCNT_dec(ARG2_AV);
1177 SvREFCNT_dec(ARG0_SV);
1179 case SAVEt_HELEM: /* hash element */
1181 HE * const he = hv_fetch_ent(ARG2_HV, ARG1_SV, 1, 0);
1182 SvREFCNT_dec(ARG1_SV);
1184 const SV * const oval = HeVAL(he);
1185 if (LIKELY(oval && oval != &PL_sv_undef)) {
1187 if (UNLIKELY(SvTIED_mg((const SV *)ARG2_HV, PERL_MAGIC_tied)))
1188 SvREFCNT_inc_void(*svp);
1189 refsv = ARG2_SV; /* what to refcnt_dec */
1193 SvREFCNT_dec(ARG2_HV);
1194 SvREFCNT_dec(ARG0_SV);
1198 PL_op = (OP*)ARG0_PTR;
1201 if ((PL_hints & HINT_LOCALIZE_HH)) {
1202 while (GvHV(PL_hintgv)) {
1203 HV *hv = GvHV(PL_hintgv);
1204 GvHV(PL_hintgv) = NULL;
1205 SvREFCNT_dec(MUTABLE_SV(hv));
1208 cophh_free(CopHINTHASH_get(&PL_compiling));
1209 CopHINTHASH_set(&PL_compiling, (COPHH*)ARG0_PTR);
1210 *(I32*)&PL_hints = ARG1_I32;
1211 if (PL_hints & HINT_LOCALIZE_HH) {
1212 SvREFCNT_dec(MUTABLE_SV(GvHV(PL_hintgv)));
1213 GvHV(PL_hintgv) = MUTABLE_HV(SSPOPPTR);
1215 if (!GvHV(PL_hintgv)) {
1216 /* Need to add a new one manually, else rv2hv can
1217 add one via GvHVn and it won't have the magic set. */
1218 HV *const hv = newHV();
1219 hv_magic(hv, NULL, PERL_MAGIC_hints);
1220 GvHV(PL_hintgv) = hv;
1222 assert(GvHV(PL_hintgv));
1225 PL_comppad = (PAD*)ARG0_PTR;
1226 if (LIKELY(PL_comppad))
1227 PL_curpad = AvARRAY(PL_comppad);
1231 case SAVEt_PADSV_AND_MORTALIZE:
1235 svp = AvARRAY((PAD*)ARG1_PTR) + (PADOFFSET)arg0.any_uv;
1236 /* This mortalizing used to be done by POPLOOP() via itersave.
1237 But as we have all the information here, we can do it here,
1238 save even having to have itersave in the struct. */
1243 case SAVEt_SAVESWITCHSTACK:
1246 SWITCHSTACK(ARG0_AV, ARG1_AV);
1247 PL_curstackinfo->si_stack = ARG1_AV;
1250 case SAVEt_SET_SVFLAGS:
1251 SvFLAGS(ARG2_SV) &= ~((U32)ARG1_I32);
1252 SvFLAGS(ARG2_SV) |= (U32)ARG0_I32;
1255 /* These are only saved in mathoms.c */
1257 (void)sv_clear(ARG0_SV);
1259 case SAVEt_LONG: /* long reference */
1260 *(long*)ARG0_PTR = arg1.any_long;
1262 case SAVEt_IV: /* IV reference */
1263 *(IV*)ARG0_PTR = arg1.any_iv;
1266 case SAVEt_I16: /* I16 reference */
1267 *(I16*)ARG0_PTR = (I16)(uv >> 8);
1269 case SAVEt_I8: /* I8 reference */
1270 *(I8*)ARG0_PTR = (I8)(uv >> 8);
1272 case SAVEt_DESTRUCTOR:
1273 (*arg1.any_dptr)(ARG0_PTR);
1275 case SAVEt_COMPILE_WARNINGS:
1276 if (!specialWARN(PL_compiling.cop_warnings))
1277 PerlMemShared_free(PL_compiling.cop_warnings);
1279 PL_compiling.cop_warnings = (STRLEN*)ARG0_PTR;
1282 parser_free((yy_parser *) ARG0_PTR);
1284 case SAVEt_READONLY_OFF:
1285 SvREADONLY_off(ARG0_SV);
1288 Perl_croak(aTHX_ "panic: leave_scope inconsistency %u", type);
1296 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1298 PERL_ARGS_ASSERT_CX_DUMP;
1301 PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1302 if (CxTYPE(cx) != CXt_SUBST) {
1303 const char *gimme_text;
1304 PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1305 PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
1306 PTR2UV(cx->blk_oldcop));
1307 PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1308 PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1309 PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
1310 PTR2UV(cx->blk_oldpm));
1311 switch (cx->blk_gimme) {
1313 gimme_text = "VOID";
1316 gimme_text = "SCALAR";
1319 gimme_text = "LIST";
1322 gimme_text = "UNKNOWN";
1325 PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", gimme_text);
1327 switch (CxTYPE(cx)) {
1332 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.CV = 0x%"UVxf"\n",
1333 PTR2UV(cx->blk_format.cv));
1334 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.GV = 0x%"UVxf"\n",
1335 PTR2UV(cx->blk_format.gv));
1336 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.DFOUTGV = 0x%"UVxf"\n",
1337 PTR2UV(cx->blk_format.dfoutgv));
1338 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.HASARGS = %d\n",
1339 (int)CxHASARGS(cx));
1340 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.RETOP = 0x%"UVxf"\n",
1341 PTR2UV(cx->blk_format.retop));
1344 PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1345 PTR2UV(cx->blk_sub.cv));
1346 PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1347 (long)cx->blk_sub.olddepth);
1348 PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1349 (int)CxHASARGS(cx));
1350 PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n", (int)CxLVAL(cx));
1351 PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1352 PTR2UV(cx->blk_sub.retop));
1355 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1356 (long)CxOLD_IN_EVAL(cx));
1357 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1358 PL_op_name[CxOLD_OP_TYPE(cx)],
1359 PL_op_desc[CxOLD_OP_TYPE(cx)]);
1360 if (cx->blk_eval.old_namesv)
1361 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1362 SvPVX_const(cx->blk_eval.old_namesv));
1363 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1364 PTR2UV(cx->blk_eval.old_eval_root));
1365 PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%"UVxf"\n",
1366 PTR2UV(cx->blk_eval.retop));
1369 case CXt_LOOP_LAZYIV:
1370 case CXt_LOOP_LAZYSV:
1372 case CXt_LOOP_PLAIN:
1373 PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n", CxLABEL(cx));
1374 PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
1375 (long)cx->blk_loop.resetsp);
1376 PerlIO_printf(Perl_debug_log, "BLK_LOOP.MY_OP = 0x%"UVxf"\n",
1377 PTR2UV(cx->blk_loop.my_op));
1378 /* XXX: not accurate for LAZYSV/IV */
1379 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1380 PTR2UV(cx->blk_loop.state_u.ary.ary));
1381 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1382 (long)cx->blk_loop.state_u.ary.ix);
1383 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1384 PTR2UV(CxITERVAR(cx)));
1388 PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1389 (long)cx->sb_iters);
1390 PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1391 (long)cx->sb_maxiters);
1392 PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1393 (long)cx->sb_rflags);
1394 PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1396 PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1398 PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1399 PTR2UV(cx->sb_dstr));
1400 PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1401 PTR2UV(cx->sb_targ));
1402 PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1404 PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1406 PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1407 PTR2UV(cx->sb_strend));
1408 PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1409 PTR2UV(cx->sb_rxres));
1413 PERL_UNUSED_CONTEXT;
1414 PERL_UNUSED_ARG(cx);
1415 #endif /* DEBUGGING */
1419 * ex: set ts=8 sts=4 sw=4 et: