This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
rpeep(): silence compiler warning
[perl5.git] / scope.c
CommitLineData
a0d0e21e 1/* scope.c
79072805 2 *
1129b882
NC
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
79072805
LW
5 *
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.
8 *
a0d0e21e
LW
9 */
10
11/*
4ac71550
TC
12 * For the fashion of Minas Tirith was such that it was built on seven
13 * levels...
14 *
15 * [p.751 of _The Lord of the Rings_, V/i: "Minas Tirith"]
79072805
LW
16 */
17
ddfa107c 18/* This file contains functions to manipulate several of Perl's stacks;
166f8a29
DM
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
22 * each scope exit.
23 */
24
79072805 25#include "EXTERN.h"
864dbfa3 26#define PERL_IN_SCOPE_C
79072805
LW
27#include "perl.h"
28
a0d0e21e 29SV**
fc16c392 30Perl_stack_grow(pTHX_ SV **sp, SV **p, SSize_t n)
a0d0e21e 31{
402d079e
DM
32 SSize_t extra;
33 SSize_t current = (p - PL_stack_base);
34
7918f24d
NC
35 PERL_ARGS_ASSERT_STACK_GROW;
36
402d079e 37 if (UNLIKELY(n < 0))
6768377c
DM
38 Perl_croak(aTHX_
39 "panic: stack_grow() negative count (%"IVdf")", (IV)n);
40
3280af22 41 PL_stack_sp = sp;
402d079e
DM
42 extra =
43#ifdef STRESS_REALLOC
44 1;
2ce36478 45#else
402d079e 46 128;
2ce36478 47#endif
402d079e
DM
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
50 * can't wrap */
51 if (UNLIKELY( current > SSize_t_MAX - extra
52 || current + extra > SSize_t_MAX - n
53 ))
54 /* diag_listed_as: Out of memory during %s extend */
55 Perl_croak(aTHX_ "Out of memory during stack extend");
56
57 av_extend(PL_curstack, current + n + extra);
3280af22 58 return PL_stack_sp;
a0d0e21e
LW
59}
60
2ce36478
SM
61#ifndef STRESS_REALLOC
62#define GROW(old) ((old) * 3 / 2)
63#else
64#define GROW(old) ((old) + 1)
65#endif
66
e336de0d 67PERL_SI *
864dbfa3 68Perl_new_stackinfo(pTHX_ I32 stitems, I32 cxitems)
e336de0d
GS
69{
70 PERL_SI *si;
a02a5408 71 Newx(si, 1, PERL_SI);
e336de0d
GS
72 si->si_stack = newAV();
73 AvREAL_off(si->si_stack);
74 av_extend(si->si_stack, stitems > 0 ? stitems-1 : 0);
3280af22 75 AvALLOC(si->si_stack)[0] = &PL_sv_undef;
e336de0d
GS
76 AvFILLp(si->si_stack) = 0;
77 si->si_prev = 0;
78 si->si_next = 0;
79 si->si_cxmax = cxitems - 1;
80 si->si_cxix = -1;
e788e7d3 81 si->si_type = PERLSI_UNDEF;
a02a5408 82 Newx(si->si_cxstack, cxitems, PERL_CONTEXT);
9965345d
JH
83 /* Without any kind of initialising PUSHSUBST()
84 * in pp_subst() will read uninitialised heap. */
7e337ee0 85 PoisonNew(si->si_cxstack, cxitems, PERL_CONTEXT);
e336de0d
GS
86 return si;
87}
88
79072805 89I32
864dbfa3 90Perl_cxinc(pTHX)
79072805 91{
a3b680e6 92 const IV old_max = cxstack_max;
2ce36478 93 cxstack_max = GROW(cxstack_max);
401a9b14 94 Renew(cxstack, cxstack_max + 1, PERL_CONTEXT);
9965345d
JH
95 /* Without any kind of initialising deep enough recursion
96 * will end up reading uninitialised PERL_CONTEXTs. */
109bf713 97 PoisonNew(cxstack + old_max + 1, cxstack_max - old_max, PERL_CONTEXT);
79072805
LW
98 return cxstack_ix + 1;
99}
100
79072805 101void
864dbfa3 102Perl_push_scope(pTHX)
79072805 103{
5d9574c1 104 if (UNLIKELY(PL_scopestack_ix == PL_scopestack_max)) {
3280af22
NIS
105 PL_scopestack_max = GROW(PL_scopestack_max);
106 Renew(PL_scopestack, PL_scopestack_max, I32);
d343c3ef
GG
107#ifdef DEBUGGING
108 Renew(PL_scopestack_name, PL_scopestack_max, const char*);
520bb150 109#endif
79072805 110 }
d343c3ef
GG
111#ifdef DEBUGGING
112 PL_scopestack_name[PL_scopestack_ix] = "unknown";
113#endif
3280af22 114 PL_scopestack[PL_scopestack_ix++] = PL_savestack_ix;
79072805
LW
115
116}
117
118void
864dbfa3 119Perl_pop_scope(pTHX)
79072805 120{
35a4481c 121 const I32 oldsave = PL_scopestack[--PL_scopestack_ix];
8990e307 122 LEAVE_SCOPE(oldsave);
79072805
LW
123}
124
ba5248fc 125I32 *
864dbfa3 126Perl_markstack_grow(pTHX)
a0d0e21e 127{
35a4481c
AL
128 const I32 oldmax = PL_markstack_max - PL_markstack;
129 const I32 newmax = GROW(oldmax);
a0d0e21e 130
3280af22 131 Renew(PL_markstack, newmax, I32);
3280af22 132 PL_markstack_max = PL_markstack + newmax;
ba5248fc 133 PL_markstack_ptr = PL_markstack + oldmax;
6cae08a8
RU
134 DEBUG_s(PerlIO_printf(Perl_debug_log, "MARK grow %p %d by %d\n",
135 PL_markstack_ptr, *PL_markstack_ptr, oldmax));
ba5248fc 136 return PL_markstack_ptr;
a0d0e21e
LW
137}
138
139void
864dbfa3 140Perl_savestack_grow(pTHX)
79072805 141{
8aacddc1 142 PL_savestack_max = GROW(PL_savestack_max) + 4;
3280af22 143 Renew(PL_savestack, PL_savestack_max, ANY);
79072805
LW
144}
145
4b3c1a47
AE
146void
147Perl_savestack_grow_cnt(pTHX_ I32 need)
148{
149 PL_savestack_max = PL_savestack_ix + need;
150 Renew(PL_savestack, PL_savestack_max, ANY);
151}
152
2ce36478
SM
153#undef GROW
154
a953aca5
DD
155/* The original function was called Perl_tmps_grow and was removed from public
156 API, Perl_tmps_grow_p is the replacement and it used in public macros but
157 isn't public itself.
158
159 Perl_tmps_grow_p takes a proposed ix. A proposed ix is PL_tmps_ix + extend_by,
160 where the result of (PL_tmps_ix + extend_by) is >= PL_tmps_max
161 Upon return, PL_tmps_stack[ix] will be a valid address. For machine code
162 optimization and register usage reasons, the proposed ix passed into
163 tmps_grow is returned to the caller which the caller can then use to write
164 an SV * to PL_tmps_stack[ix]. If the caller was using tmps_grow in
165 pre-extend mode (EXTEND_MORTAL macro), then it ignores the return value of
166 tmps_grow. Note, tmps_grow DOES NOT write ix to PL_tmps_ix, the caller
167 must assign ix or ret val of tmps_grow to PL_temps_ix themselves if that is
168 appropriate. The assignment to PL_temps_ix can happen before or after
169 tmps_grow call since tmps_grow doesn't look at PL_tmps_ix.
170 */
171
172SSize_t
173Perl_tmps_grow_p(pTHX_ SSize_t ix)
677b06e3 174{
a953aca5 175 SSize_t extend_to = ix;
677b06e3 176#ifndef STRESS_REALLOC
a953aca5
DD
177 if (ix - PL_tmps_max < 128)
178 extend_to += (PL_tmps_max < 512) ? 128 : 512;
677b06e3 179#endif
a953aca5 180 PL_tmps_max = extend_to + 1;
677b06e3 181 Renew(PL_tmps_stack, PL_tmps_max, SV*);
a953aca5 182 return ix;
677b06e3
GS
183}
184
185
186void
864dbfa3 187Perl_free_tmps(pTHX)
79072805
LW
188{
189 /* XXX should tmps_floor live in cxstack? */
e8eb279c 190 const SSize_t myfloor = PL_tmps_floor;
3280af22 191 while (PL_tmps_ix > myfloor) { /* clean up after last statement */
22ade07d 192 SV* const sv = PL_tmps_stack[PL_tmps_ix--];
72581b5b
VP
193#ifdef PERL_POISON
194 PoisonWith(PL_tmps_stack + PL_tmps_ix + 1, 1, SV *, 0xAB);
22ade07d 195#endif
5d9574c1 196 if (LIKELY(sv && sv != &PL_sv_undef)) {
463ee0b2 197 SvTEMP_off(sv);
4a9a56a7 198 SvREFCNT_dec_NN(sv); /* note, can modify tmps_ix!!! */
463ee0b2 199 }
79072805
LW
200 }
201}
202
76e3520e 203STATIC SV *
af7df257 204S_save_scalar_at(pTHX_ SV **sptr, const U32 flags)
79072805 205{
75d34a09 206 SV * osv;
eb578fdb 207 SV *sv;
79072805 208
7918f24d
NC
209 PERL_ARGS_ASSERT_SAVE_SCALAR_AT;
210
75d34a09
VP
211 osv = *sptr;
212 sv = (flags & SAVEf_KEEPOLDELEM) ? osv : (*sptr = newSV(0));
213
f1f99dc1 214 if (SvTYPE(osv) >= SVt_PVMG && SvMAGIC(osv)) {
a0d0e21e 215 if (SvGMAGICAL(osv)) {
a0d0e21e 216 SvFLAGS(osv) |= (SvFLAGS(osv) &
c268c2a6 217 (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
a0d0e21e 218 }
75d34a09 219 if (!(flags & SAVEf_KEEPOLDELEM))
2dcac756 220 mg_localize(osv, sv, cBOOL(flags & SAVEf_SETMAGIC));
79072805 221 }
75d34a09 222
79072805
LW
223 return sv;
224}
225
dfcd3de5
NC
226void
227Perl_save_pushptrptr(pTHX_ void *const ptr1, void *const ptr2, const int type)
e22024d3 228{
a3444cc5
DM
229 dSS_ADD;
230 SS_ADD_PTR(ptr1);
231 SS_ADD_PTR(ptr2);
232 SS_ADD_UV(type);
233 SS_ADD_END(3);
e22024d3
NC
234}
235
7a4c00b4 236SV *
864dbfa3 237Perl_save_scalar(pTHX_ GV *gv)
7a4c00b4 238{
13c59d41 239 SV ** const sptr = &GvSVn(gv);
7918f24d
NC
240
241 PERL_ARGS_ASSERT_SAVE_SCALAR;
242
13c59d41 243 if (UNLIKELY(SvGMAGICAL(*sptr))) {
b492a59e 244 PL_localizing = 1;
13c59d41 245 (void)mg_get(*sptr);
b492a59e
DM
246 PL_localizing = 0;
247 }
13c59d41
MH
248 save_pushptrptr(SvREFCNT_inc_simple(gv), SvREFCNT_inc(*sptr), SAVEt_SV);
249 return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
7a4c00b4
PP
250}
251
f4dd75d9 252/* Like save_sptr(), but also SvREFCNT_dec()s the new value. Can be used to
b9d12d37
GS
253 * restore a global SV to its prior contents, freeing new value. */
254void
864dbfa3 255Perl_save_generic_svref(pTHX_ SV **sptr)
b9d12d37 256{
7918f24d
NC
257 PERL_ARGS_ASSERT_SAVE_GENERIC_SVREF;
258
e22024d3 259 save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_GENERIC_SVREF);
b9d12d37
GS
260}
261
f4dd75d9
GS
262/* Like save_pptr(), but also Safefree()s the new value if it is different
263 * from the old one. Can be used to restore a global char* to its prior
264 * contents, freeing new value. */
265void
266Perl_save_generic_pvref(pTHX_ char **str)
267{
7918f24d
NC
268 PERL_ARGS_ASSERT_SAVE_GENERIC_PVREF;
269
e22024d3 270 save_pushptrptr(*str, str, SAVEt_GENERIC_PVREF);
f4dd75d9
GS
271}
272
05ec9bb3
NIS
273/* Like save_generic_pvref(), but uses PerlMemShared_free() rather than Safefree().
274 * Can be used to restore a shared global char* to its prior
275 * contents, freeing new value. */
276void
277Perl_save_shared_pvref(pTHX_ char **str)
278{
7918f24d
NC
279 PERL_ARGS_ASSERT_SAVE_SHARED_PVREF;
280
e22024d3 281 save_pushptrptr(str, *str, SAVEt_SHARED_PVREF);
05ec9bb3
NIS
282}
283
14f338dc
DM
284/* set the SvFLAGS specified by mask to the values in val */
285
286void
287Perl_save_set_svflags(pTHX_ SV* sv, U32 mask, U32 val)
288{
a3444cc5 289 dSS_ADD;
7918f24d
NC
290
291 PERL_ARGS_ASSERT_SAVE_SET_SVFLAGS;
292
a3444cc5
DM
293 SS_ADD_PTR(sv);
294 SS_ADD_INT(mask);
295 SS_ADD_INT(val);
296 SS_ADD_UV(SAVEt_SET_SVFLAGS);
297 SS_ADD_END(4);
14f338dc
DM
298}
299
79072805 300void
864dbfa3 301Perl_save_gp(pTHX_ GV *gv, I32 empty)
79072805 302{
7918f24d
NC
303 PERL_ARGS_ASSERT_SAVE_GP;
304
10507e11 305 save_pushptrptr(SvREFCNT_inc(gv), GvGP(gv), SAVEt_GP);
79072805 306
5f05dabc 307 if (empty) {
12816592 308 GP *gp = Perl_newGP(aTHX_ gv);
959f7ad7 309 HV * const stash = GvSTASH(gv);
3d460042
FC
310 bool isa_changed = 0;
311
312 if (stash && HvENAME(stash)) {
313 if (GvNAMELEN(gv) == 3 && strnEQ(GvNAME(gv), "ISA", 3))
314 isa_changed = TRUE;
315 else if (GvCVu(gv))
316 /* taking a method out of circulation ("local")*/
317 mro_method_changed_in(stash);
318 }
146174a9
CB
319 if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
320 gp->gp_io = newIO();
321 IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
322 }
c43ae56f 323 GvGP_set(gv,gp);
3d460042 324 if (isa_changed) mro_isa_changed_in(stash);
5f05dabc
PP
325 }
326 else {
44a8e56a 327 gp_ref(GvGP(gv));
5f05dabc
PP
328 GvINTRO_on(gv);
329 }
79072805 330}
79072805 331
79072805 332AV *
864dbfa3 333Perl_save_ary(pTHX_ GV *gv)
79072805 334{
901017d6 335 AV * const oav = GvAVn(gv);
67a38de0 336 AV *av;
fb73857a 337
7918f24d
NC
338 PERL_ARGS_ASSERT_SAVE_ARY;
339
5d9574c1 340 if (UNLIKELY(!AvREAL(oav) && AvREIFY(oav)))
67a38de0 341 av_reify(oav);
01433346 342 save_pushptrptr(SvREFCNT_inc_simple_NN(gv), oav, SAVEt_AV);
79072805 343
4608196e 344 GvAV(gv) = NULL;
fb73857a 345 av = GvAVn(gv);
5d9574c1 346 if (UNLIKELY(SvMAGIC(oav)))
9711599e 347 mg_localize(MUTABLE_SV(oav), MUTABLE_SV(av), TRUE);
fb73857a 348 return av;
79072805
LW
349}
350
351HV *
864dbfa3 352Perl_save_hash(pTHX_ GV *gv)
79072805 353{
fb73857a
PP
354 HV *ohv, *hv;
355
7918f24d
NC
356 PERL_ARGS_ASSERT_SAVE_HASH;
357
01433346
FC
358 save_pushptrptr(
359 SvREFCNT_inc_simple_NN(gv), (ohv = GvHVn(gv)), SAVEt_HV
360 );
79072805 361
4608196e 362 GvHV(gv) = NULL;
fb73857a 363 hv = GvHVn(gv);
5d9574c1 364 if (UNLIKELY(SvMAGIC(ohv)))
9711599e 365 mg_localize(MUTABLE_SV(ohv), MUTABLE_SV(hv), TRUE);
fb73857a 366 return hv;
79072805
LW
367}
368
369void
5aaab254 370Perl_save_item(pTHX_ SV *item)
79072805 371{
eb578fdb 372 SV * const sv = newSVsv(item);
79072805 373
7918f24d
NC
374 PERL_ARGS_ASSERT_SAVE_ITEM;
375
e22024d3
NC
376 save_pushptrptr(item, /* remember the pointer */
377 sv, /* remember the value */
378 SAVEt_ITEM);
79072805
LW
379}
380
381void
1409bc06 382Perl_save_bool(pTHX_ bool *boolp)
79072805 383{
a3444cc5 384 dSS_ADD;
7918f24d 385
1409bc06 386 PERL_ARGS_ASSERT_SAVE_BOOL;
7918f24d 387
a3444cc5
DM
388 SS_ADD_PTR(boolp);
389 SS_ADD_UV(SAVEt_BOOL | (*boolp << 8));
390 SS_ADD_END(2);
1409bc06
NC
391}
392
7623d426
NC
393void
394Perl_save_pushi32ptr(pTHX_ const I32 i, void *const ptr, const int type)
1409bc06 395{
a3444cc5
DM
396 dSS_ADD;
397
398 SS_ADD_INT(i);
399 SS_ADD_PTR(ptr);
400 SS_ADD_UV(type);
401 SS_ADD_END(3);
79072805
LW
402}
403
404void
1409bc06 405Perl_save_int(pTHX_ int *intp)
9febdf04 406{
d172696c 407 const int i = *intp;
9b139d09 408 UV type = ((UV)((UV)i << SAVE_TIGHT_SHIFT) | SAVEt_INT_SMALL);
d172696c
DM
409 int size = 2;
410 dSS_ADD;
7918f24d 411
1409bc06 412 PERL_ARGS_ASSERT_SAVE_INT;
7918f24d 413
5d9574c1 414 if (UNLIKELY((int)(type >> SAVE_TIGHT_SHIFT) != i)) {
d172696c
DM
415 SS_ADD_INT(i);
416 type = SAVEt_INT;
417 size++;
418 }
419 SS_ADD_PTR(intp);
420 SS_ADD_UV(type);
421 SS_ADD_END(size);
9febdf04
RH
422}
423
424void
58188858
RGS
425Perl_save_I8(pTHX_ I8 *bytep)
426{
a3444cc5 427 dSS_ADD;
7918f24d
NC
428
429 PERL_ARGS_ASSERT_SAVE_I8;
430
a3444cc5
DM
431 SS_ADD_PTR(bytep);
432 SS_ADD_UV(SAVEt_I8 | ((UV)*bytep << 8));
433 SS_ADD_END(2);
58188858
RGS
434}
435
436void
87a84751
JH
437Perl_save_I16(pTHX_ I16 *intp)
438{
a3444cc5 439 dSS_ADD;
7918f24d
NC
440
441 PERL_ARGS_ASSERT_SAVE_I16;
442
a3444cc5
DM
443 SS_ADD_PTR(intp);
444 SS_ADD_UV(SAVEt_I16 | ((UV)*intp << 8));
445 SS_ADD_END(2);
87a84751
JH
446}
447
448void
864dbfa3 449Perl_save_I32(pTHX_ I32 *intp)
79072805 450{
d172696c 451 const I32 i = *intp;
9b139d09 452 UV type = ((I32)((U32)i << SAVE_TIGHT_SHIFT) | SAVEt_I32_SMALL);
d172696c
DM
453 int size = 2;
454 dSS_ADD;
7918f24d
NC
455
456 PERL_ARGS_ASSERT_SAVE_I32;
457
5d9574c1 458 if (UNLIKELY((I32)(type >> SAVE_TIGHT_SHIFT) != i)) {
d172696c
DM
459 SS_ADD_INT(i);
460 type = SAVEt_I32;
461 size++;
462 }
463 SS_ADD_PTR(intp);
464 SS_ADD_UV(type);
465 SS_ADD_END(size);
79072805
LW
466}
467
e8eb279c
FC
468void
469Perl_save_strlen(pTHX_ STRLEN *ptr)
470{
e8eb279c
FC
471 dSS_ADD;
472
473 PERL_ARGS_ASSERT_SAVE_STRLEN;
474
475 SS_ADD_IV(*ptr);
476 SS_ADD_PTR(ptr);
477 SS_ADD_UV(SAVEt_STRLEN);
478 SS_ADD_END(3);
479}
480
85e6fe83
LW
481/* Cannot use save_sptr() to store a char* since the SV** cast will
482 * force word-alignment and we'll miss the pointer.
483 */
484void
864dbfa3 485Perl_save_pptr(pTHX_ char **pptr)
85e6fe83 486{
7918f24d
NC
487 PERL_ARGS_ASSERT_SAVE_PPTR;
488
e22024d3 489 save_pushptrptr(*pptr, pptr, SAVEt_PPTR);
85e6fe83
LW
490}
491
79072805 492void
146174a9
CB
493Perl_save_vptr(pTHX_ void *ptr)
494{
7918f24d
NC
495 PERL_ARGS_ASSERT_SAVE_VPTR;
496
e22024d3 497 save_pushptrptr(*(char**)ptr, ptr, SAVEt_VPTR);
146174a9
CB
498}
499
500void
864dbfa3 501Perl_save_sptr(pTHX_ SV **sptr)
79072805 502{
7918f24d
NC
503 PERL_ARGS_ASSERT_SAVE_SPTR;
504
e22024d3 505 save_pushptrptr(*sptr, sptr, SAVEt_SPTR);
79072805
LW
506}
507
c3564e5c 508void
09edbca0 509Perl_save_padsv_and_mortalize(pTHX_ PADOFFSET off)
c3564e5c 510{
a3444cc5
DM
511 dSS_ADD;
512
f3548bdc 513 ASSERT_CURPAD_ACTIVE("save_padsv");
a3444cc5
DM
514 SS_ADD_PTR(SvREFCNT_inc_simple_NN(PL_curpad[off]));
515 SS_ADD_PTR(PL_comppad);
03dba561 516 SS_ADD_UV((UV)off);
a3444cc5
DM
517 SS_ADD_UV(SAVEt_PADSV_AND_MORTALIZE);
518 SS_ADD_END(4);
c3564e5c
GS
519}
520
79072805 521void
864dbfa3 522Perl_save_hptr(pTHX_ HV **hptr)
79072805 523{
7918f24d
NC
524 PERL_ARGS_ASSERT_SAVE_HPTR;
525
e22024d3 526 save_pushptrptr(*hptr, hptr, SAVEt_HPTR);
79072805
LW
527}
528
529void
864dbfa3 530Perl_save_aptr(pTHX_ AV **aptr)
79072805 531{
7918f24d
NC
532 PERL_ARGS_ASSERT_SAVE_APTR;
533
e22024d3 534 save_pushptrptr(*aptr, aptr, SAVEt_APTR);
79072805
LW
535}
536
537void
2fd8beea 538Perl_save_pushptr(pTHX_ void *const ptr, const int type)
8990e307 539{
a3444cc5
DM
540 dSS_ADD;
541 SS_ADD_PTR(ptr);
542 SS_ADD_UV(type);
543 SS_ADD_END(2);
8990e307
LW
544}
545
546void
864dbfa3 547Perl_save_clearsv(pTHX_ SV **svp)
8990e307 548{
cdcdfc56
NC
549 const UV offset = svp - PL_curpad;
550 const UV offset_shifted = offset << SAVE_TIGHT_SHIFT;
7918f24d
NC
551
552 PERL_ARGS_ASSERT_SAVE_CLEARSV;
553
f3548bdc 554 ASSERT_CURPAD_ACTIVE("save_clearsv");
623e28c6 555 SvPADSTALE_off(*svp); /* mark lexical as active */
5d9574c1 556 if (UNLIKELY((offset_shifted >> SAVE_TIGHT_SHIFT) != offset)) {
cdcdfc56
NC
557 Perl_croak(aTHX_ "panic: pad offset %"UVuf" out of range (%p-%p)",
558 offset, svp, PL_curpad);
a3444cc5 559 }
cdcdfc56 560
a3444cc5
DM
561 {
562 dSS_ADD;
563 SS_ADD_UV(offset_shifted | SAVEt_CLEARSV);
564 SS_ADD_END(1);
565 }
8990e307
LW
566}
567
568void
864dbfa3 569Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
8990e307 570{
7918f24d
NC
571 PERL_ARGS_ASSERT_SAVE_DELETE;
572
85a721ca 573 save_pushptri32ptr(key, klen, SvREFCNT_inc_simple(hv), SAVEt_DELETE);
8990e307
LW
574}
575
576void
af097752
VP
577Perl_save_hdelete(pTHX_ HV *hv, SV *keysv)
578{
579 STRLEN len;
580 I32 klen;
581 const char *key;
582
583 PERL_ARGS_ASSERT_SAVE_HDELETE;
584
585 key = SvPV_const(keysv, len);
586 klen = SvUTF8(keysv) ? -(I32)len : (I32)len;
587 SvREFCNT_inc_simple_void_NN(hv);
588 save_pushptri32ptr(savepvn(key, len), klen, hv, SAVEt_DELETE);
589}
590
591void
c70927a6 592Perl_save_adelete(pTHX_ AV *av, SSize_t key)
c68ec7a9 593{
c70927a6 594 dSS_ADD;
c68ec7a9
VP
595
596 PERL_ARGS_ASSERT_SAVE_ADELETE;
597
598 SvREFCNT_inc_void(av);
c70927a6
FC
599 SS_ADD_UV(key);
600 SS_ADD_PTR(av);
601 SS_ADD_IV(SAVEt_ADELETE);
602 SS_ADD_END(3);
c68ec7a9
VP
603}
604
605void
12ab1f58
JH
606Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
607{
a3444cc5 608 dSS_ADD;
7918f24d
NC
609 PERL_ARGS_ASSERT_SAVE_DESTRUCTOR;
610
a3444cc5
DM
611 SS_ADD_DPTR(f);
612 SS_ADD_PTR(p);
613 SS_ADD_UV(SAVEt_DESTRUCTOR);
614 SS_ADD_END(3);
12ab1f58
JH
615}
616
617void
146174a9
CB
618Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
619{
a3444cc5
DM
620 dSS_ADD;
621
622 SS_ADD_DXPTR(f);
623 SS_ADD_PTR(p);
624 SS_ADD_UV(SAVEt_DESTRUCTOR_X);
625 SS_ADD_END(3);
146174a9
CB
626}
627
628void
da8315f8
NC
629Perl_save_hints(pTHX)
630{
20439bc7 631 COPHH *save_cophh = cophh_copy(CopHINTHASH_get(&PL_compiling));
da8315f8 632 if (PL_hints & HINT_LOCALIZE_HH) {
52c7aca6
FC
633 HV *oldhh = GvHV(PL_hintgv);
634 save_pushptri32ptr(oldhh, PL_hints, save_cophh, SAVEt_HINTS);
635 GvHV(PL_hintgv) = NULL; /* in case copying dies */
636 GvHV(PL_hintgv) = hv_copy_hints_hv(oldhh);
be84297e 637 } else {
20439bc7 638 save_pushi32ptr(PL_hints, save_cophh, SAVEt_HINTS);
da8315f8 639 }
be84297e
NC
640}
641
642static void
643S_save_pushptri32ptr(pTHX_ void *const ptr1, const I32 i, void *const ptr2,
644 const int type)
645{
a3444cc5
DM
646 dSS_ADD;
647 SS_ADD_PTR(ptr1);
648 SS_ADD_INT(i);
649 SS_ADD_PTR(ptr2);
650 SS_ADD_UV(type);
651 SS_ADD_END(4);
da8315f8
NC
652}
653
654void
c70927a6
FC
655Perl_save_aelem_flags(pTHX_ AV *av, SSize_t idx, SV **sptr,
656 const U32 flags)
4e4c362e 657{
20b7effb 658 dSS_ADD;
bfc4de9f 659 SV *sv;
7918f24d 660
91d1c79f 661 PERL_ARGS_ASSERT_SAVE_AELEM_FLAGS;
7918f24d 662
0cbee0a4 663 SvGETMAGIC(*sptr);
c70927a6
FC
664 SS_ADD_PTR(SvREFCNT_inc_simple(av));
665 SS_ADD_IV(idx);
666 SS_ADD_PTR(SvREFCNT_inc(*sptr));
667 SS_ADD_UV(SAVEt_AELEM);
668 SS_ADD_END(4);
1cdc9186
FC
669 /* The array needs to hold a reference count on its new element, so it
670 must be AvREAL. */
5d9574c1 671 if (UNLIKELY(!AvREAL(av) && AvREIFY(av)))
1cdc9186 672 av_reify(av);
91d1c79f 673 save_scalar_at(sptr, flags); /* XXX - FIXME - see #60360 */
75d34a09
VP
674 if (flags & SAVEf_KEEPOLDELEM)
675 return;
bfc4de9f
DM
676 sv = *sptr;
677 /* If we're localizing a tied array element, this new sv
678 * won't actually be stored in the array - so it won't get
679 * reaped when the localize ends. Ensure it gets reaped by
680 * mortifying it instead. DAPM */
5d9574c1 681 if (UNLIKELY(SvTIED_mg((const SV *)av, PERL_MAGIC_tied)))
bfc4de9f 682 sv_2mortal(sv);
4e4c362e
GS
683}
684
685void
af7df257 686Perl_save_helem_flags(pTHX_ HV *hv, SV *key, SV **sptr, const U32 flags)
4e4c362e 687{
bfc4de9f 688 SV *sv;
7918f24d 689
af7df257 690 PERL_ARGS_ASSERT_SAVE_HELEM_FLAGS;
7918f24d 691
0cbee0a4 692 SvGETMAGIC(*sptr);
a3444cc5
DM
693 {
694 dSS_ADD;
695 SS_ADD_PTR(SvREFCNT_inc_simple(hv));
696 SS_ADD_PTR(newSVsv(key));
697 SS_ADD_PTR(SvREFCNT_inc(*sptr));
698 SS_ADD_UV(SAVEt_HELEM);
699 SS_ADD_END(4);
700 }
af7df257 701 save_scalar_at(sptr, flags);
75d34a09
VP
702 if (flags & SAVEf_KEEPOLDELEM)
703 return;
bfc4de9f
DM
704 sv = *sptr;
705 /* If we're localizing a tied hash element, this new sv
706 * won't actually be stored in the hash - so it won't get
707 * reaped when the localize ends. Ensure it gets reaped by
708 * mortifying it instead. DAPM */
5d9574c1 709 if (UNLIKELY(SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)))
bfc4de9f 710 sv_2mortal(sv);
4e4c362e
GS
711}
712
2053acbf
NC
713SV*
714Perl_save_svref(pTHX_ SV **sptr)
715{
7918f24d
NC
716 PERL_ARGS_ASSERT_SAVE_SVREF;
717
2053acbf 718 SvGETMAGIC(*sptr);
e22024d3 719 save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_SVREF);
af7df257 720 return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
2053acbf
NC
721}
722
455ece5e 723I32
864dbfa3 724Perl_save_alloc(pTHX_ I32 size, I32 pad)
455ece5e 725{
eb578fdb
KW
726 const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
727 - (char*)PL_savestack);
1be36ce0
NC
728 const UV elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
729 const UV elems_shifted = elems << SAVE_TIGHT_SHIFT;
455ece5e 730
5d9574c1 731 if (UNLIKELY((elems_shifted >> SAVE_TIGHT_SHIFT) != elems))
93a641ae
DM
732 Perl_croak(aTHX_
733 "panic: save_alloc elems %"UVuf" out of range (%"IVdf"-%"IVdf")",
734 elems, (IV)size, (IV)pad);
1be36ce0
NC
735
736 SSGROW(elems + 1);
455ece5e
AD
737
738 PL_savestack_ix += elems;
1be36ce0 739 SSPUSHUV(SAVEt_ALLOC | elems_shifted);
455ece5e
AD
740 return start;
741}
742
03dba561
DM
743
744
745#define ARG0_SV MUTABLE_SV(arg0.any_ptr)
746#define ARG0_AV MUTABLE_AV(arg0.any_ptr)
747#define ARG0_HV MUTABLE_HV(arg0.any_ptr)
748#define ARG0_PTR arg0.any_ptr
749#define ARG0_PV (char*)(arg0.any_ptr)
750#define ARG0_PVP (char**)(arg0.any_ptr)
751#define ARG0_I32 (arg0.any_i32)
752
753#define ARG1_SV MUTABLE_SV(arg1.any_ptr)
754#define ARG1_AV MUTABLE_AV(arg1.any_ptr)
755#define ARG1_GV MUTABLE_GV(arg1.any_ptr)
756#define ARG1_SVP (SV**)(arg1.any_ptr)
757#define ARG1_PVP (char**)(arg1.any_ptr)
758#define ARG1_PTR arg1.any_ptr
759#define ARG1_PV (char*)(arg1.any_ptr)
760#define ARG1_I32 (arg1.any_i32)
761
762#define ARG2_SV MUTABLE_SV(arg2.any_ptr)
763#define ARG2_AV MUTABLE_AV(arg2.any_ptr)
764#define ARG2_HV MUTABLE_HV(arg2.any_ptr)
765#define ARG2_GV MUTABLE_GV(arg2.any_ptr)
766#define ARG2_PV (char*)(arg2.any_ptr)
767
462e5cf6 768void
864dbfa3 769Perl_leave_scope(pTHX_ I32 base)
79072805 770{
302c0c93 771 /* Localise the effects of the TAINT_NOT inside the loop. */
284167a5 772 bool was = TAINT_get;
79072805 773
51418c6a
JH
774 I32 i;
775 SV *sv;
776
03dba561
DM
777 ANY arg0, arg1, arg2;
778
779 /* these initialisations are logically unnecessary, but they shut up
780 * spurious 'may be used uninitialized' compiler warnings */
781 arg0.any_ptr = NULL;
782 arg1.any_ptr = NULL;
783 arg2.any_ptr = NULL;
784
5d9574c1 785 if (UNLIKELY(base < -1))
5637ef5b 786 Perl_croak(aTHX_ "panic: corrupt saved stack index %ld", (long) base);
1c98cc53
DM
787 DEBUG_l(Perl_deb(aTHX_ "savestack: releasing items %ld -> %ld\n",
788 (long)PL_savestack_ix, (long)base));
3280af22 789 while (PL_savestack_ix > base) {
03dba561
DM
790 UV uv;
791 U8 type;
792
793 SV *refsv;
794 SV **svp;
795
c6ae7647
NC
796 TAINT_NOT;
797
03dba561
DM
798 {
799 I32 ix = PL_savestack_ix - 1;
800 ANY *p = &PL_savestack[ix];
801 uv = p->any_uv;
802 type = (U8)uv & SAVE_MASK;
803 if (type > SAVEt_ARG0_MAX) {
804 ANY *p0 = p;
805 arg0 = *--p;
806 if (type > SAVEt_ARG1_MAX) {
807 arg1 = *--p;
808 if (type > SAVEt_ARG2_MAX) {
809 arg2 = *--p;
810 }
811 }
812 ix -= (p0 - p);
813 }
814 PL_savestack_ix = ix;
815 }
816
c6bf6a65 817 switch (type) {
79072805 818 case SAVEt_ITEM: /* normal string */
03dba561 819 sv_replace(ARG1_SV, ARG0_SV);
5d9574c1 820 if (UNLIKELY(SvSMAGICAL(ARG1_SV))) {
b492a59e
DM
821 PL_localizing = 2;
822 mg_set(ARG1_SV);
823 PL_localizing = 0;
824 }
79072805 825 break;
03dba561
DM
826
827 /* This would be a mathom, but Perl_save_svref() calls a static
828 function, S_save_scalar_at(), so has to stay in this file. */
829 case SAVEt_SVREF: /* scalar reference */
830 svp = ARG1_SVP;
831 refsv = NULL; /* what to refcnt_dec */
832 goto restore_sv;
833
8aacddc1 834 case SAVEt_SV: /* scalar reference */
03dba561
DM
835 svp = &GvSV(ARG1_GV);
836 refsv = ARG1_SV; /* what to refcnt_dec */
2053acbf 837 restore_sv:
03dba561
DM
838 {
839 SV * const sv = *svp;
840 *svp = ARG0_SV;
2053acbf 841 SvREFCNT_dec(sv);
5d9574c1 842 if (UNLIKELY(SvSMAGICAL(ARG0_SV))) {
b492a59e
DM
843 PL_localizing = 2;
844 mg_set(ARG0_SV);
845 PL_localizing = 0;
846 }
4a9a56a7 847 SvREFCNT_dec_NN(ARG0_SV);
03dba561 848 SvREFCNT_dec(refsv);
2053acbf 849 break;
03dba561 850 }
8aacddc1 851 case SAVEt_GENERIC_PVREF: /* generic pv */
03dba561
DM
852 if (*ARG0_PVP != ARG1_PV) {
853 Safefree(*ARG0_PVP);
854 *ARG0_PVP = ARG1_PV;
f4dd75d9
GS
855 }
856 break;
05ec9bb3 857 case SAVEt_SHARED_PVREF: /* shared pv */
03dba561 858 if (*ARG1_PVP != ARG0_PV) {
5e54c26f 859#ifdef NETWARE
03dba561 860 PerlMem_free(*ARG1_PVP);
5e54c26f 861#else
03dba561 862 PerlMemShared_free(*ARG1_PVP);
5e54c26f 863#endif
03dba561 864 *ARG1_PVP = ARG0_PV;
05ec9bb3
NIS
865 }
866 break;
f83b46a0 867 case SAVEt_GVSV: /* scalar slot in GV */
03dba561 868 svp = &GvSV(ARG1_GV);
f83b46a0 869 goto restore_svp;
8aacddc1 870 case SAVEt_GENERIC_SVREF: /* generic sv */
03dba561 871 svp = ARG1_SVP;
f83b46a0 872 restore_svp:
03dba561
DM
873 {
874 SV * const sv = *svp;
875 *svp = ARG0_SV;
f4dd75d9 876 SvREFCNT_dec(sv);
03dba561 877 SvREFCNT_dec(ARG0_SV);
b9d12d37 878 break;
03dba561 879 }
db9306af 880 case SAVEt_GVSLOT: /* any slot in GV */
03dba561
DM
881 {
882 HV *const hv = GvSTASH(ARG2_GV);
883 svp = ARG1_SVP;
db9306af 884 if (hv && HvENAME(hv) && (
03dba561
DM
885 (ARG0_SV && SvTYPE(ARG0_SV) == SVt_PVCV)
886 || (*svp && SvTYPE(*svp) == SVt_PVCV)
db9306af
FC
887 ))
888 {
03dba561
DM
889 if ((char *)svp < (char *)GvGP(ARG2_GV)
890 || (char *)svp > (char *)GvGP(ARG2_GV) + sizeof(struct gp)
a3d47e0d 891 || GvREFCNT(ARG2_GV) > 2) /* "> 2" to ignore savestack's ref */
db9306af
FC
892 PL_sub_generation++;
893 else mro_method_changed_in(hv);
894 }
895 goto restore_svp;
03dba561 896 }
8aacddc1 897 case SAVEt_AV: /* array reference */
03dba561
DM
898 SvREFCNT_dec(GvAV(ARG1_GV));
899 GvAV(ARG1_GV) = ARG0_AV;
5d9574c1 900 if (UNLIKELY(SvSMAGICAL(ARG0_SV))) {
b492a59e
DM
901 PL_localizing = 2;
902 mg_set(ARG0_SV);
903 PL_localizing = 0;
904 }
4a9a56a7 905 SvREFCNT_dec_NN(ARG1_GV);
8aacddc1
NIS
906 break;
907 case SAVEt_HV: /* hash reference */
03dba561
DM
908 SvREFCNT_dec(GvHV(ARG1_GV));
909 GvHV(ARG1_GV) = ARG0_HV;
5d9574c1 910 if (UNLIKELY(SvSMAGICAL(ARG0_SV))) {
b492a59e
DM
911 PL_localizing = 2;
912 mg_set(ARG0_SV);
913 PL_localizing = 0;
914 }
4a9a56a7 915 SvREFCNT_dec_NN(ARG1_GV);
8aacddc1 916 break;
994d373a 917 case SAVEt_INT_SMALL:
03dba561 918 *(int*)ARG0_PTR = (int)(uv >> SAVE_TIGHT_SHIFT);
994d373a 919 break;
79072805 920 case SAVEt_INT: /* int reference */
03dba561 921 *(int*)ARG0_PTR = (int)ARG1_I32;
79072805 922 break;
e8eb279c
FC
923 case SAVEt_STRLEN: /* STRLEN/size_t ref */
924 *(STRLEN*)ARG0_PTR = (STRLEN)arg1.any_iv;
925 break;
9febdf04 926 case SAVEt_BOOL: /* bool reference */
03dba561 927 *(bool*)ARG0_PTR = cBOOL(uv >> 8);
9a9b5ec9
DM
928#ifdef NO_TAINT_SUPPORT
929 PERL_UNUSED_VAR(was);
930#else
5d9574c1 931 if (UNLIKELY(ARG0_PTR == &(TAINT_get))) {
b6f93e7a
KW
932 /* If we don't update <was>, to reflect what was saved on the
933 * stack for PL_tainted, then we will overwrite this attempt to
934 * restore it when we exit this routine. Note that this won't
935 * work if this value was saved in a wider-than necessary type,
936 * such as I32 */
03dba561 937 was = *(bool*)ARG0_PTR;
b6f93e7a 938 }
284167a5 939#endif
9febdf04 940 break;
89abef21 941 case SAVEt_I32_SMALL:
03dba561 942 *(I32*)ARG0_PTR = (I32)(uv >> SAVE_TIGHT_SHIFT);
89abef21 943 break;
79072805 944 case SAVEt_I32: /* I32 reference */
3235b7a3 945#ifdef PERL_DEBUG_READONLY_OPS
03dba561 946 if (*(I32*)ARG0_PTR != ARG1_I32)
3235b7a3 947#endif
03dba561 948 *(I32*)ARG0_PTR = ARG1_I32;
79072805
LW
949 break;
950 case SAVEt_SPTR: /* SV* reference */
03dba561 951 *(SV**)(ARG0_PTR)= ARG1_SV;
79072805 952 break;
146174a9 953 case SAVEt_VPTR: /* random* reference */
85e6fe83 954 case SAVEt_PPTR: /* char* reference */
03dba561 955 *ARG0_PVP = ARG1_PV;
85e6fe83 956 break;
79072805 957 case SAVEt_HPTR: /* HV* reference */
03dba561 958 *(HV**)ARG0_PTR = MUTABLE_HV(ARG1_PTR);
79072805
LW
959 break;
960 case SAVEt_APTR: /* AV* reference */
03dba561 961 *(AV**)ARG0_PTR = ARG1_AV;
79072805 962 break;
fb73857a 963 case SAVEt_GP: /* scalar reference */
03dba561
DM
964 {
965 HV *hv;
966 /* possibly taking a method out of circulation */
967 const bool had_method = !!GvCVu(ARG1_GV);
968 gp_free(ARG1_GV);
969 GvGP_set(ARG1_GV, (GP*)ARG0_PTR);
970 if ((hv=GvSTASH(ARG1_GV)) && HvENAME_get(hv)) {
971 if ( GvNAMELEN(ARG1_GV) == 3
972 && strnEQ(GvNAME(ARG1_GV), "ISA", 3)
973 )
974 mro_isa_changed_in(hv);
975 else if (had_method || GvCVu(ARG1_GV))
976 /* putting a method back into circulation ("local")*/
977 gv_method_changed(ARG1_GV);
3d460042 978 }
4a9a56a7 979 SvREFCNT_dec_NN(ARG1_GV);
8aacddc1 980 break;
03dba561 981 }
8990e307 982 case SAVEt_FREESV:
03dba561 983 SvREFCNT_dec(ARG0_SV);
8990e307 984 break;
0f94cb1f
FC
985 case SAVEt_FREEPADNAME:
986 PadnameREFCNT_dec((PADNAME *)ARG0_PTR);
987 break;
3987a177 988 case SAVEt_FREECOPHH:
03dba561 989 cophh_free((COPHH *)ARG0_PTR);
3987a177 990 break;
26d9b02f 991 case SAVEt_MORTALIZESV:
03dba561 992 sv_2mortal(ARG0_SV);
26d9b02f 993 break;
8990e307 994 case SAVEt_FREEOP:
5e5ba94b 995 ASSERT_CURPAD_LEGAL("SAVEt_FREEOP");
03dba561 996 op_free((OP*)ARG0_PTR);
8990e307
LW
997 break;
998 case SAVEt_FREEPV:
03dba561 999 Safefree(ARG0_PTR);
8990e307 1000 break;
4e09461c 1001
4e09461c
DM
1002 case SAVEt_CLEARPADRANGE:
1003 i = (I32)((uv >> SAVE_TIGHT_SHIFT) & OPpPADRANGE_COUNTMASK);
1004 svp = &PL_curpad[uv >>
1005 (OPpPADRANGE_COUNTSHIFT + SAVE_TIGHT_SHIFT)] + i - 1;
1006 goto clearsv;
8990e307 1007 case SAVEt_CLEARSV:
4e09461c
DM
1008 svp = &PL_curpad[uv >> SAVE_TIGHT_SHIFT];
1009 i = 1;
1010 clearsv:
1011 for (; i; i--, svp--) {
528ad060
DM
1012 sv = *svp;
1013
1014 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1015 "Pad 0x%"UVxf"[0x%"UVxf"] clearsv: %ld sv=0x%"UVxf"<%"IVdf"> %s\n",
1016 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
1017 (long)(svp-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
1018 (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
1019 ));
1020
1021 /* Can clear pad variable in place? */
9af15990 1022 if (SvREFCNT(sv) == 1 && !SvOBJECT(sv)) {
a07f0bef 1023
a07f0bef
DM
1024 /* these flags are the union of all the relevant flags
1025 * in the individual conditions within */
1026 if (UNLIKELY(SvFLAGS(sv) & (
a623f893 1027 SVf_READONLY|SVf_PROTECT /*for SvREADONLY_off*/
a07f0bef 1028 | (SVs_GMG|SVs_SMG|SVs_RMG) /* SvMAGICAL() */
7532eaae 1029 | SVf_OOK
a07f0bef
DM
1030 | SVf_THINKFIRST)))
1031 {
7500fc82
DM
1032 /* if a my variable that was made readonly is
1033 * going out of scope, we want to remove the
1034 * readonlyness so that it can go out of scope
1035 * quietly
1036 */
57c404c9 1037 if (SvREADONLY(sv))
7500fc82
DM
1038 SvREADONLY_off(sv);
1039
7532eaae
DM
1040 if (SvOOK(sv)) { /* OOK or HvAUX */
1041 if (SvTYPE(sv) == SVt_PVHV)
1042 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
1043 else
1044 sv_backoff(sv);
1045 }
1046
7500fc82 1047 if (SvMAGICAL(sv)) {
7532eaae
DM
1048 /* note that backrefs (either in HvAUX or magic)
1049 * must be removed before other magic */
7500fc82
DM
1050 sv_unmagic(sv, PERL_MAGIC_backref);
1051 if (SvTYPE(sv) != SVt_PVCV)
1052 mg_free(sv);
1053 }
1054 if (SvTHINKFIRST(sv))
1055 sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF
1056 |SV_COW_DROP_PV);
528ad060 1057
a07f0bef 1058 }
528ad060
DM
1059 switch (SvTYPE(sv)) {
1060 case SVt_NULL:
1061 break;
1062 case SVt_PVAV:
1063 av_clear(MUTABLE_AV(sv));
1064 break;
1065 case SVt_PVHV:
1066 hv_clear(MUTABLE_HV(sv));
1067 break;
1068 case SVt_PVCV:
1069 {
db5cc3ee 1070 HEK *hek =
db5cc3ee 1071 CvNAMED(sv)
9c98a81f
FC
1072 ? CvNAME_HEK((CV *)sv)
1073 : GvNAME_HEK(CvGV(sv));
528ad060 1074 assert(hek);
6110d17a 1075 (void)share_hek_hek(hek);
528ad060
DM
1076 cv_undef((CV *)sv);
1077 CvNAME_HEK_set(sv, hek);
f3feca7a 1078 CvLEXICAL_on(sv);
528ad060
DM
1079 break;
1080 }
1081 default:
c79d0076
NC
1082 /* This looks odd, but these two macros are for use in
1083 expressions and finish with a trailing comma, so
1084 adding a ; after them would be wrong. */
1085 assert_not_ROK(sv)
1086 assert_not_glob(sv)
5c85b638 1087 SvFLAGS(sv) &=~ (SVf_OK|SVf_IVisUV|SVf_UTF8);
528ad060
DM
1088 break;
1089 }
82e85a9c 1090 SvPADTMP_off(sv);
528ad060
DM
1091 SvPADSTALE_on(sv); /* mark as no longer live */
1092 }
1093 else { /* Someone has a claim on this, so abandon it. */
528ad060
DM
1094 switch (SvTYPE(sv)) { /* Console ourselves with a new value */
1095 case SVt_PVAV: *svp = MUTABLE_SV(newAV()); break;
1096 case SVt_PVHV: *svp = MUTABLE_SV(newHV()); break;
1097 case SVt_PVCV:
1098 {
9c98a81f
FC
1099 HEK * const hek = CvNAMED(sv)
1100 ? CvNAME_HEK((CV *)sv)
1101 : GvNAME_HEK(CvGV(sv));
1102
528ad060
DM
1103 /* Create a stub */
1104 *svp = newSV_type(SVt_PVCV);
1105
1106 /* Share name */
528ad060 1107 CvNAME_HEK_set(*svp,
9c98a81f 1108 share_hek_hek(hek));
f3feca7a 1109 CvLEXICAL_on(*svp);
528ad060
DM
1110 break;
1111 }
1112 default: *svp = newSV(0); break;
1113 }
4a9a56a7 1114 SvREFCNT_dec_NN(sv); /* Cast current value to the winds. */
528ad060
DM
1115 /* preserve pad nature, but also mark as not live
1116 * for any closure capturing */
145bf8ee 1117 SvFLAGS(*svp) |= SVs_PADSTALE;
528ad060 1118 }
4e09461c 1119 }
8990e307
LW
1120 break;
1121 case SAVEt_DELETE:
03dba561
DM
1122 (void)hv_delete(ARG0_HV, ARG2_PV, ARG1_I32, G_DISCARD);
1123 SvREFCNT_dec(ARG0_HV);
1124 Safefree(arg2.any_ptr);
8990e307 1125 break;
c68ec7a9 1126 case SAVEt_ADELETE:
c70927a6 1127 (void)av_delete(ARG0_AV, arg1.any_iv, G_DISCARD);
03dba561 1128 SvREFCNT_dec(ARG0_AV);
c68ec7a9 1129 break;
146174a9 1130 case SAVEt_DESTRUCTOR_X:
03dba561 1131 (*arg1.any_dxptr)(aTHX_ ARG0_PTR);
a0d0e21e
LW
1132 break;
1133 case SAVEt_REGCONTEXT:
e0fa7e2b 1134 /* regexp must have croaked */
455ece5e 1135 case SAVEt_ALLOC:
1be36ce0 1136 PL_savestack_ix -= uv >> SAVE_TIGHT_SHIFT;
a0d0e21e 1137 break;
55497cff 1138 case SAVEt_STACK_POS: /* Position on Perl stack */
03dba561 1139 PL_stack_sp = PL_stack_base + arg0.any_i32;
55497cff 1140 break;
161b7d16 1141 case SAVEt_AELEM: /* array element */
c70927a6 1142 svp = av_fetch(ARG2_AV, arg1.any_iv, 1);
5d9574c1 1143 if (UNLIKELY(!AvREAL(ARG2_AV) && AvREIFY(ARG2_AV))) /* undo reify guard */
03dba561 1144 SvREFCNT_dec(ARG0_SV);
5d9574c1 1145 if (LIKELY(svp)) {
03dba561 1146 SV * const sv = *svp;
5d9574c1
DM
1147 if (LIKELY(sv && sv != &PL_sv_undef)) {
1148 if (UNLIKELY(SvTIED_mg((const SV *)ARG2_AV, PERL_MAGIC_tied)))
b37c2d43 1149 SvREFCNT_inc_void_NN(sv);
03dba561 1150 refsv = ARG2_SV;
4e4c362e
GS
1151 goto restore_sv;
1152 }
1153 }
03dba561
DM
1154 SvREFCNT_dec(ARG2_AV);
1155 SvREFCNT_dec(ARG0_SV);
4e4c362e 1156 break;
161b7d16 1157 case SAVEt_HELEM: /* hash element */
03dba561
DM
1158 {
1159 HE * const he = hv_fetch_ent(ARG2_HV, ARG1_SV, 1, 0);
1160 SvREFCNT_dec(ARG1_SV);
5d9574c1 1161 if (LIKELY(he)) {
03dba561 1162 const SV * const oval = HeVAL(he);
5d9574c1 1163 if (LIKELY(oval && oval != &PL_sv_undef)) {
03dba561 1164 svp = &HeVAL(he);
5d9574c1 1165 if (UNLIKELY(SvTIED_mg((const SV *)ARG2_HV, PERL_MAGIC_tied)))
03dba561
DM
1166 SvREFCNT_inc_void(*svp);
1167 refsv = ARG2_SV; /* what to refcnt_dec */
4e4c362e
GS
1168 goto restore_sv;
1169 }
1170 }
03dba561
DM
1171 SvREFCNT_dec(ARG2_HV);
1172 SvREFCNT_dec(ARG0_SV);
4e4c362e 1173 break;
03dba561 1174 }
462e5cf6 1175 case SAVEt_OP:
03dba561 1176 PL_op = (OP*)ARG0_PTR;
462e5cf6 1177 break;
25eaa213 1178 case SAVEt_HINTS:
3607ca02
FC
1179 if ((PL_hints & HINT_LOCALIZE_HH)) {
1180 while (GvHV(PL_hintgv)) {
2653c1e3 1181 HV *hv = GvHV(PL_hintgv);
045ac317 1182 GvHV(PL_hintgv) = NULL;
2653c1e3 1183 SvREFCNT_dec(MUTABLE_SV(hv));
3607ca02 1184 }
045ac317 1185 }
20439bc7 1186 cophh_free(CopHINTHASH_get(&PL_compiling));
03dba561
DM
1187 CopHINTHASH_set(&PL_compiling, (COPHH*)ARG0_PTR);
1188 *(I32*)&PL_hints = ARG1_I32;
dfa41748 1189 if (PL_hints & HINT_LOCALIZE_HH) {
ad64d0ec 1190 SvREFCNT_dec(MUTABLE_SV(GvHV(PL_hintgv)));
85fbaab2 1191 GvHV(PL_hintgv) = MUTABLE_HV(SSPOPPTR);
2653c1e3
DM
1192 }
1193 if (!GvHV(PL_hintgv)) {
a3fb8386
FC
1194 /* Need to add a new one manually, else rv2hv can
1195 add one via GvHVn and it won't have the magic set. */
5b9c0671
NC
1196 HV *const hv = newHV();
1197 hv_magic(hv, NULL, PERL_MAGIC_hints);
1198 GvHV(PL_hintgv) = hv;
dfa41748 1199 }
5b9c0671 1200 assert(GvHV(PL_hintgv));
b3ac6de7 1201 break;
cb50131a 1202 case SAVEt_COMPPAD:
03dba561 1203 PL_comppad = (PAD*)ARG0_PTR;
5d9574c1 1204 if (LIKELY(PL_comppad))
cb50131a
CB
1205 PL_curpad = AvARRAY(PL_comppad);
1206 else
4608196e 1207 PL_curpad = NULL;
cb50131a 1208 break;
09edbca0 1209 case SAVEt_PADSV_AND_MORTALIZE:
c3564e5c 1210 {
09edbca0 1211 SV **svp;
03dba561
DM
1212 assert (ARG1_PTR);
1213 svp = AvARRAY((PAD*)ARG1_PTR) + (PADOFFSET)arg0.any_uv;
09edbca0
NC
1214 /* This mortalizing used to be done by POPLOOP() via itersave.
1215 But as we have all the information here, we can do it here,
1216 save even having to have itersave in the struct. */
1217 sv_2mortal(*svp);
03dba561 1218 *svp = ARG2_SV;
c3564e5c
GS
1219 }
1220 break;
8b7059b1
DM
1221 case SAVEt_SAVESWITCHSTACK:
1222 {
1223 dSP;
03dba561
DM
1224 SWITCHSTACK(ARG0_AV, ARG1_AV);
1225 PL_curstackinfo->si_stack = ARG1_AV;
8b7059b1
DM
1226 }
1227 break;
14f338dc 1228 case SAVEt_SET_SVFLAGS:
03dba561
DM
1229 SvFLAGS(ARG2_SV) &= ~((U32)ARG1_I32);
1230 SvFLAGS(ARG2_SV) |= (U32)ARG0_I32;
14f338dc 1231 break;
95e06916 1232
95e06916
NC
1233 /* These are only saved in mathoms.c */
1234 case SAVEt_NSTAB:
03dba561 1235 (void)sv_clear(ARG0_SV);
95e06916 1236 break;
2053acbf 1237 case SAVEt_LONG: /* long reference */
03dba561 1238 *(long*)ARG0_PTR = arg1.any_long;
2053acbf 1239 break;
95e06916 1240 case SAVEt_IV: /* IV reference */
03dba561 1241 *(IV*)ARG0_PTR = arg1.any_iv;
95e06916
NC
1242 break;
1243
2053acbf 1244 case SAVEt_I16: /* I16 reference */
03dba561 1245 *(I16*)ARG0_PTR = (I16)(uv >> 8);
2053acbf
NC
1246 break;
1247 case SAVEt_I8: /* I8 reference */
03dba561 1248 *(I8*)ARG0_PTR = (I8)(uv >> 8);
2053acbf 1249 break;
2053acbf 1250 case SAVEt_DESTRUCTOR:
03dba561 1251 (*arg1.any_dptr)(ARG0_PTR);
2053acbf 1252 break;
68da3b2f 1253 case SAVEt_COMPILE_WARNINGS:
68da3b2f
NC
1254 if (!specialWARN(PL_compiling.cop_warnings))
1255 PerlMemShared_free(PL_compiling.cop_warnings);
72dc9ed5 1256
03dba561 1257 PL_compiling.cop_warnings = (STRLEN*)ARG0_PTR;
72dc9ed5 1258 break;
7c197c94 1259 case SAVEt_PARSER:
03dba561 1260 parser_free((yy_parser *) ARG0_PTR);
7c197c94 1261 break;
20d5dc23
FC
1262 case SAVEt_READONLY_OFF:
1263 SvREADONLY_off(ARG0_SV);
1264 break;
79072805 1265 default:
5637ef5b 1266 Perl_croak(aTHX_ "panic: leave_scope inconsistency %u", type);
79072805
LW
1267 }
1268 }
302c0c93 1269
284167a5 1270 TAINT_set(was);
79072805 1271}
8990e307 1272
8990e307 1273void
864dbfa3 1274Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
8990e307 1275{
7918f24d
NC
1276 PERL_ARGS_ASSERT_CX_DUMP;
1277
35ff7856 1278#ifdef DEBUGGING
22c35a8c 1279 PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
6b35e009 1280 if (CxTYPE(cx) != CXt_SUBST) {
e8d9e9d0 1281 const char *gimme_text;
760ac839 1282 PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
146174a9
CB
1283 PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
1284 PTR2UV(cx->blk_oldcop));
760ac839
LW
1285 PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1286 PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
146174a9
CB
1287 PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
1288 PTR2UV(cx->blk_oldpm));
e8d9e9d0
VP
1289 switch (cx->blk_gimme) {
1290 case G_VOID:
1291 gimme_text = "VOID";
1292 break;
1293 case G_SCALAR:
1294 gimme_text = "SCALAR";
1295 break;
1296 case G_ARRAY:
1297 gimme_text = "LIST";
1298 break;
1299 default:
1300 gimme_text = "UNKNOWN";
1301 break;
1302 }
1303 PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", gimme_text);
8990e307 1304 }
6b35e009 1305 switch (CxTYPE(cx)) {
8990e307
LW
1306 case CXt_NULL:
1307 case CXt_BLOCK:
1308 break;
146174a9 1309 case CXt_FORMAT:
f9c764c5
NC
1310 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.CV = 0x%"UVxf"\n",
1311 PTR2UV(cx->blk_format.cv));
1312 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.GV = 0x%"UVxf"\n",
1313 PTR2UV(cx->blk_format.gv));
1314 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.DFOUTGV = 0x%"UVxf"\n",
1315 PTR2UV(cx->blk_format.dfoutgv));
1316 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.HASARGS = %d\n",
bafb2adc 1317 (int)CxHASARGS(cx));
f9c764c5
NC
1318 PerlIO_printf(Perl_debug_log, "BLK_FORMAT.RETOP = 0x%"UVxf"\n",
1319 PTR2UV(cx->blk_format.retop));
146174a9 1320 break;
8990e307 1321 case CXt_SUB:
146174a9
CB
1322 PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1323 PTR2UV(cx->blk_sub.cv));
760ac839 1324 PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
8990e307 1325 (long)cx->blk_sub.olddepth);
760ac839 1326 PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
bafb2adc
NC
1327 (int)CxHASARGS(cx));
1328 PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n", (int)CxLVAL(cx));
f39bc417
DM
1329 PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1330 PTR2UV(cx->blk_sub.retop));
8990e307
LW
1331 break;
1332 case CXt_EVAL:
760ac839 1333 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
85a64632 1334 (long)CxOLD_IN_EVAL(cx));
760ac839 1335 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
85a64632
NC
1336 PL_op_name[CxOLD_OP_TYPE(cx)],
1337 PL_op_desc[CxOLD_OP_TYPE(cx)]);
0f79a09d
GS
1338 if (cx->blk_eval.old_namesv)
1339 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
aa07b2f6 1340 SvPVX_const(cx->blk_eval.old_namesv));
146174a9
CB
1341 PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1342 PTR2UV(cx->blk_eval.old_eval_root));
f39bc417
DM
1343 PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%"UVxf"\n",
1344 PTR2UV(cx->blk_eval.retop));
8990e307
LW
1345 break;
1346
c6fdafd0 1347 case CXt_LOOP_LAZYIV:
d01136d6 1348 case CXt_LOOP_LAZYSV:
3b719c58
NC
1349 case CXt_LOOP_FOR:
1350 case CXt_LOOP_PLAIN:
0cbdab38 1351 PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n", CxLABEL(cx));
760ac839 1352 PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
8990e307 1353 (long)cx->blk_loop.resetsp);
022eaa24
NC
1354 PerlIO_printf(Perl_debug_log, "BLK_LOOP.MY_OP = 0x%"UVxf"\n",
1355 PTR2UV(cx->blk_loop.my_op));
d01136d6 1356 /* XXX: not accurate for LAZYSV/IV */
146174a9 1357 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
d01136d6
BS
1358 PTR2UV(cx->blk_loop.state_u.ary.ary));
1359 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1360 (long)cx->blk_loop.state_u.ary.ix);
146174a9
CB
1361 PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1362 PTR2UV(CxITERVAR(cx)));
8990e307
LW
1363 break;
1364
1365 case CXt_SUBST:
760ac839 1366 PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
8990e307 1367 (long)cx->sb_iters);
760ac839 1368 PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
8990e307 1369 (long)cx->sb_maxiters);
35ef4773
GS
1370 PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1371 (long)cx->sb_rflags);
760ac839 1372 PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
c5bed6a7 1373 (long)CxONCE(cx));
760ac839 1374 PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
8990e307 1375 cx->sb_orig);
146174a9
CB
1376 PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1377 PTR2UV(cx->sb_dstr));
1378 PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1379 PTR2UV(cx->sb_targ));
1380 PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1381 PTR2UV(cx->sb_s));
1382 PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1383 PTR2UV(cx->sb_m));
1384 PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1385 PTR2UV(cx->sb_strend));
1386 PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1387 PTR2UV(cx->sb_rxres));
8990e307
LW
1388 break;
1389 }
65e66c80 1390#else
96a5add6 1391 PERL_UNUSED_CONTEXT;
65e66c80 1392 PERL_UNUSED_ARG(cx);
17c3b450 1393#endif /* DEBUGGING */
35ff7856 1394}
241d1a3b
NC
1395
1396/*
14d04a33 1397 * ex: set ts=8 sts=4 sw=4 et:
37442d52 1398 */