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