This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
clean up leave_scope()
[perl5.git] / scope.c
1 /*    scope.c
2  *
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
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  *
9  */
10
11 /*
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"]
16  */
17
18 /* This file contains functions to manipulate several of Perl's stacks;
19  * in particular it contains code to push various types of things onto
20  * the savestack, then to pop them off and perform the correct restorative
21  * action for each one. This corresponds to the cleanup Perl does at
22  * each scope exit.
23  */
24
25 #include "EXTERN.h"
26 #define PERL_IN_SCOPE_C
27 #include "perl.h"
28
29 SV**
30 Perl_stack_grow(pTHX_ SV **sp, SV **p, SSize_t n)
31 {
32     SSize_t extra;
33     SSize_t current = (p - PL_stack_base);
34
35     PERL_ARGS_ASSERT_STACK_GROW;
36
37     if (UNLIKELY(n < 0))
38         Perl_croak(aTHX_
39             "panic: stack_grow() negative count (%"IVdf")", (IV)n);
40
41     PL_stack_sp = sp;
42     extra =
43 #ifdef STRESS_REALLOC
44         1;
45 #else
46         128;
47 #endif
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);
58     return PL_stack_sp;
59 }
60
61 #ifndef STRESS_REALLOC
62 #define GROW(old) ((old) * 3 / 2)
63 #else
64 #define GROW(old) ((old) + 1)
65 #endif
66
67 PERL_SI *
68 Perl_new_stackinfo(pTHX_ I32 stitems, I32 cxitems)
69 {
70     PERL_SI *si;
71     Newx(si, 1, PERL_SI);
72     si->si_stack = newAV();
73     AvREAL_off(si->si_stack);
74     av_extend(si->si_stack, stitems > 0 ? stitems-1 : 0);
75     AvALLOC(si->si_stack)[0] = &PL_sv_undef;
76     AvFILLp(si->si_stack) = 0;
77     si->si_prev = 0;
78     si->si_next = 0;
79     si->si_cxmax = cxitems - 1;
80     si->si_cxix = -1;
81     si->si_type = PERLSI_UNDEF;
82     Newx(si->si_cxstack, cxitems, PERL_CONTEXT);
83     /* Without any kind of initialising CX_PUSHSUBST()
84      * in pp_subst() will read uninitialised heap. */
85     PoisonNew(si->si_cxstack, cxitems, PERL_CONTEXT);
86     return si;
87 }
88
89 I32
90 Perl_cxinc(pTHX)
91 {
92     const IV old_max = cxstack_max;
93     cxstack_max = GROW(cxstack_max);
94     Renew(cxstack, cxstack_max + 1, PERL_CONTEXT);
95     /* Without any kind of initialising deep enough recursion
96      * will end up reading uninitialised PERL_CONTEXTs. */
97     PoisonNew(cxstack + old_max + 1, cxstack_max - old_max, PERL_CONTEXT);
98     return cxstack_ix + 1;
99 }
100
101 void
102 Perl_push_scope(pTHX)
103 {
104     if (UNLIKELY(PL_scopestack_ix == PL_scopestack_max)) {
105         PL_scopestack_max = GROW(PL_scopestack_max);
106         Renew(PL_scopestack, PL_scopestack_max, I32);
107 #ifdef DEBUGGING
108         Renew(PL_scopestack_name, PL_scopestack_max, const char*);
109 #endif
110     }
111 #ifdef DEBUGGING
112     PL_scopestack_name[PL_scopestack_ix] = "unknown";
113 #endif
114     PL_scopestack[PL_scopestack_ix++] = PL_savestack_ix;
115
116 }
117
118 void
119 Perl_pop_scope(pTHX)
120 {
121     const I32 oldsave = PL_scopestack[--PL_scopestack_ix];
122     LEAVE_SCOPE(oldsave);
123 }
124
125 I32 *
126 Perl_markstack_grow(pTHX)
127 {
128     const I32 oldmax = PL_markstack_max - PL_markstack;
129     const I32 newmax = GROW(oldmax);
130
131     Renew(PL_markstack, newmax, I32);
132     PL_markstack_max = PL_markstack + newmax;
133     PL_markstack_ptr = PL_markstack + oldmax;
134     DEBUG_s(DEBUG_v(PerlIO_printf(Perl_debug_log,
135             "MARK grow %p %"IVdf" by %"IVdf"\n",
136             PL_markstack_ptr, (IV)*PL_markstack_ptr, (IV)oldmax)));
137     return PL_markstack_ptr;
138 }
139
140 void
141 Perl_savestack_grow(pTHX)
142 {
143 #ifdef STRESS_REALLOC
144     PL_savestack_max += SS_MAXPUSH;
145 #else
146     PL_savestack_max = GROW(PL_savestack_max);
147 #endif
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);
151 }
152
153 void
154 Perl_savestack_grow_cnt(pTHX_ I32 need)
155 {
156     PL_savestack_max = PL_savestack_ix + need;
157     /* Note that we allocate SS_MAXPUSH slots higher than ss_max
158      * so that SS_ADD_END(), SSGROW() etc can do a simper check */
159     Renew(PL_savestack, PL_savestack_max + SS_MAXPUSH, ANY);
160 }
161
162 #undef GROW
163
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
181 SSize_t
182 Perl_tmps_grow_p(pTHX_ SSize_t ix)
183 {
184     SSize_t extend_to = ix;
185 #ifndef STRESS_REALLOC
186     if (ix - PL_tmps_max < 128)
187         extend_to += (PL_tmps_max < 512) ? 128 : 512;
188 #endif
189     PL_tmps_max = extend_to + 1;
190     Renew(PL_tmps_stack, PL_tmps_max, SV*);
191     return ix;
192 }
193
194
195 void
196 Perl_free_tmps(pTHX)
197 {
198     /* XXX should tmps_floor live in cxstack? */
199     const SSize_t myfloor = PL_tmps_floor;
200     while (PL_tmps_ix > myfloor) {      /* clean up after last statement */
201         SV* const sv = PL_tmps_stack[PL_tmps_ix--];
202 #ifdef PERL_POISON
203         PoisonWith(PL_tmps_stack + PL_tmps_ix + 1, 1, SV *, 0xAB);
204 #endif
205         if (LIKELY(sv)) {
206             SvTEMP_off(sv);
207             SvREFCNT_dec_NN(sv);                /* note, can modify tmps_ix!!! */
208         }
209     }
210 }
211
212 STATIC SV *
213 S_save_scalar_at(pTHX_ SV **sptr, const U32 flags)
214 {
215     SV * osv;
216     SV *sv;
217
218     PERL_ARGS_ASSERT_SAVE_SCALAR_AT;
219
220     osv = *sptr;
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));
227     }
228
229     return sv;
230 }
231
232 void
233 Perl_save_pushptrptr(pTHX_ void *const ptr1, void *const ptr2, const int type)
234 {
235     dSS_ADD;
236     SS_ADD_PTR(ptr1);
237     SS_ADD_PTR(ptr2);
238     SS_ADD_UV(type);
239     SS_ADD_END(3);
240 }
241
242 SV *
243 Perl_save_scalar(pTHX_ GV *gv)
244 {
245     SV ** const sptr = &GvSVn(gv);
246
247     PERL_ARGS_ASSERT_SAVE_SCALAR;
248
249     if (UNLIKELY(SvGMAGICAL(*sptr))) {
250         PL_localizing = 1;
251         (void)mg_get(*sptr);
252         PL_localizing = 0;
253     }
254     save_pushptrptr(SvREFCNT_inc_simple(gv), SvREFCNT_inc(*sptr), SAVEt_SV);
255     return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
256 }
257
258 /* Like save_sptr(), but also SvREFCNT_dec()s the new value.  Can be used to
259  * restore a global SV to its prior contents, freeing new value. */
260 void
261 Perl_save_generic_svref(pTHX_ SV **sptr)
262 {
263     PERL_ARGS_ASSERT_SAVE_GENERIC_SVREF;
264
265     save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_GENERIC_SVREF);
266 }
267
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. */
271 void
272 Perl_save_generic_pvref(pTHX_ char **str)
273 {
274     PERL_ARGS_ASSERT_SAVE_GENERIC_PVREF;
275
276     save_pushptrptr(*str, str, SAVEt_GENERIC_PVREF);
277 }
278
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. */
282 void
283 Perl_save_shared_pvref(pTHX_ char **str)
284 {
285     PERL_ARGS_ASSERT_SAVE_SHARED_PVREF;
286
287     save_pushptrptr(str, *str, SAVEt_SHARED_PVREF);
288 }
289
290 /* set the SvFLAGS specified by mask to the values in val */
291
292 void
293 Perl_save_set_svflags(pTHX_ SV* sv, U32 mask, U32 val)
294 {
295     dSS_ADD;
296
297     PERL_ARGS_ASSERT_SAVE_SET_SVFLAGS;
298
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);
304 }
305
306 /*
307 =for apidoc save_gp
308
309 Saves the current GP of gv on the save stack to be restored on scope exit.
310
311 If empty is true, replace the GP with a new GP.
312
313 If empty is false, mark gv with GVf_INTRO so the next reference
314 assigned is localized, which is how C< local *foo = $someref; > works.
315
316 =cut
317 */
318
319 void
320 Perl_save_gp(pTHX_ GV *gv, I32 empty)
321 {
322     PERL_ARGS_ASSERT_SAVE_GP;
323
324     save_pushptrptr(SvREFCNT_inc(gv), GvGP(gv), SAVEt_GP);
325
326     if (empty) {
327         GP *gp = Perl_newGP(aTHX_ gv);
328         HV * const stash = GvSTASH(gv);
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         }
338         if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
339             gp->gp_io = newIO();
340             IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
341         }
342         GvGP_set(gv,gp);
343         if (isa_changed) mro_isa_changed_in(stash);
344     }
345     else {
346         gp_ref(GvGP(gv));
347         GvINTRO_on(gv);
348     }
349 }
350
351 AV *
352 Perl_save_ary(pTHX_ GV *gv)
353 {
354     AV * const oav = GvAVn(gv);
355     AV *av;
356
357     PERL_ARGS_ASSERT_SAVE_ARY;
358
359     if (UNLIKELY(!AvREAL(oav) && AvREIFY(oav)))
360         av_reify(oav);
361     save_pushptrptr(SvREFCNT_inc_simple_NN(gv), oav, SAVEt_AV);
362
363     GvAV(gv) = NULL;
364     av = GvAVn(gv);
365     if (UNLIKELY(SvMAGIC(oav)))
366         mg_localize(MUTABLE_SV(oav), MUTABLE_SV(av), TRUE);
367     return av;
368 }
369
370 HV *
371 Perl_save_hash(pTHX_ GV *gv)
372 {
373     HV *ohv, *hv;
374
375     PERL_ARGS_ASSERT_SAVE_HASH;
376
377     save_pushptrptr(
378         SvREFCNT_inc_simple_NN(gv), (ohv = GvHVn(gv)), SAVEt_HV
379     );
380
381     GvHV(gv) = NULL;
382     hv = GvHVn(gv);
383     if (UNLIKELY(SvMAGIC(ohv)))
384         mg_localize(MUTABLE_SV(ohv), MUTABLE_SV(hv), TRUE);
385     return hv;
386 }
387
388 void
389 Perl_save_item(pTHX_ SV *item)
390 {
391     SV * const sv = newSVsv(item);
392
393     PERL_ARGS_ASSERT_SAVE_ITEM;
394
395     save_pushptrptr(item, /* remember the pointer */
396                     sv,   /* remember the value */
397                     SAVEt_ITEM);
398 }
399
400 void
401 Perl_save_bool(pTHX_ bool *boolp)
402 {
403     dSS_ADD;
404
405     PERL_ARGS_ASSERT_SAVE_BOOL;
406
407     SS_ADD_PTR(boolp);
408     SS_ADD_UV(SAVEt_BOOL | (*boolp << 8));
409     SS_ADD_END(2);
410 }
411
412 void
413 Perl_save_pushi32ptr(pTHX_ const I32 i, void *const ptr, const int type)
414 {
415     dSS_ADD;
416
417     SS_ADD_INT(i);
418     SS_ADD_PTR(ptr);
419     SS_ADD_UV(type);
420     SS_ADD_END(3);
421 }
422
423 void
424 Perl_save_int(pTHX_ int *intp)
425 {
426     const int i = *intp;
427     UV type = ((UV)((UV)i << SAVE_TIGHT_SHIFT) | SAVEt_INT_SMALL);
428     int size = 2;
429     dSS_ADD;
430
431     PERL_ARGS_ASSERT_SAVE_INT;
432
433     if (UNLIKELY((int)(type >> SAVE_TIGHT_SHIFT) != i)) {
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);
441 }
442
443 void
444 Perl_save_I8(pTHX_ I8 *bytep)
445 {
446     dSS_ADD;
447
448     PERL_ARGS_ASSERT_SAVE_I8;
449
450     SS_ADD_PTR(bytep);
451     SS_ADD_UV(SAVEt_I8 | ((UV)*bytep << 8));
452     SS_ADD_END(2);
453 }
454
455 void
456 Perl_save_I16(pTHX_ I16 *intp)
457 {
458     dSS_ADD;
459
460     PERL_ARGS_ASSERT_SAVE_I16;
461
462     SS_ADD_PTR(intp);
463     SS_ADD_UV(SAVEt_I16 | ((UV)*intp << 8));
464     SS_ADD_END(2);
465 }
466
467 void
468 Perl_save_I32(pTHX_ I32 *intp)
469 {
470     const I32 i = *intp;
471     UV type = ((I32)((U32)i << SAVE_TIGHT_SHIFT) | SAVEt_I32_SMALL);
472     int size = 2;
473     dSS_ADD;
474
475     PERL_ARGS_ASSERT_SAVE_I32;
476
477     if (UNLIKELY((I32)(type >> SAVE_TIGHT_SHIFT) != i)) {
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);
485 }
486
487 void
488 Perl_save_strlen(pTHX_ STRLEN *ptr)
489 {
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
500 void
501 Perl_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
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  */
514 void
515 Perl_save_pptr(pTHX_ char **pptr)
516 {
517     PERL_ARGS_ASSERT_SAVE_PPTR;
518
519     save_pushptrptr(*pptr, pptr, SAVEt_PPTR);
520 }
521
522 void
523 Perl_save_vptr(pTHX_ void *ptr)
524 {
525     PERL_ARGS_ASSERT_SAVE_VPTR;
526
527     save_pushptrptr(*(char**)ptr, ptr, SAVEt_VPTR);
528 }
529
530 void
531 Perl_save_sptr(pTHX_ SV **sptr)
532 {
533     PERL_ARGS_ASSERT_SAVE_SPTR;
534
535     save_pushptrptr(*sptr, sptr, SAVEt_SPTR);
536 }
537
538 void
539 Perl_save_padsv_and_mortalize(pTHX_ PADOFFSET off)
540 {
541     dSS_ADD;
542
543     ASSERT_CURPAD_ACTIVE("save_padsv");
544     SS_ADD_PTR(SvREFCNT_inc_simple_NN(PL_curpad[off]));
545     SS_ADD_PTR(PL_comppad);
546     SS_ADD_UV((UV)off);
547     SS_ADD_UV(SAVEt_PADSV_AND_MORTALIZE);
548     SS_ADD_END(4);
549 }
550
551 void
552 Perl_save_hptr(pTHX_ HV **hptr)
553 {
554     PERL_ARGS_ASSERT_SAVE_HPTR;
555
556     save_pushptrptr(*hptr, hptr, SAVEt_HPTR);
557 }
558
559 void
560 Perl_save_aptr(pTHX_ AV **aptr)
561 {
562     PERL_ARGS_ASSERT_SAVE_APTR;
563
564     save_pushptrptr(*aptr, aptr, SAVEt_APTR);
565 }
566
567 void
568 Perl_save_pushptr(pTHX_ void *const ptr, const int type)
569 {
570     dSS_ADD;
571     SS_ADD_PTR(ptr);
572     SS_ADD_UV(type);
573     SS_ADD_END(2);
574 }
575
576 void
577 Perl_save_clearsv(pTHX_ SV **svp)
578 {
579     const UV offset = svp - PL_curpad;
580     const UV offset_shifted = offset << SAVE_TIGHT_SHIFT;
581
582     PERL_ARGS_ASSERT_SAVE_CLEARSV;
583
584     ASSERT_CURPAD_ACTIVE("save_clearsv");
585     SvPADSTALE_off(*svp); /* mark lexical as active */
586     if (UNLIKELY((offset_shifted >> SAVE_TIGHT_SHIFT) != offset)) {
587         Perl_croak(aTHX_ "panic: pad offset %"UVuf" out of range (%p-%p)",
588                    offset, svp, PL_curpad);
589     }
590
591     {
592         dSS_ADD;
593         SS_ADD_UV(offset_shifted | SAVEt_CLEARSV);
594         SS_ADD_END(1);
595     }
596 }
597
598 void
599 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
600 {
601     PERL_ARGS_ASSERT_SAVE_DELETE;
602
603     save_pushptri32ptr(key, klen, SvREFCNT_inc_simple(hv), SAVEt_DELETE);
604 }
605
606 void
607 Perl_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
621 void
622 Perl_save_adelete(pTHX_ AV *av, SSize_t key)
623 {
624     dSS_ADD;
625
626     PERL_ARGS_ASSERT_SAVE_ADELETE;
627
628     SvREFCNT_inc_void(av);
629     SS_ADD_UV(key);
630     SS_ADD_PTR(av);
631     SS_ADD_IV(SAVEt_ADELETE);
632     SS_ADD_END(3);
633 }
634
635 void
636 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
637 {
638     dSS_ADD;
639     PERL_ARGS_ASSERT_SAVE_DESTRUCTOR;
640
641     SS_ADD_DPTR(f);
642     SS_ADD_PTR(p);
643     SS_ADD_UV(SAVEt_DESTRUCTOR);
644     SS_ADD_END(3);
645 }
646
647 void
648 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
649 {
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);
656 }
657
658 void
659 Perl_save_hints(pTHX)
660 {
661     COPHH *save_cophh = cophh_copy(CopHINTHASH_get(&PL_compiling));
662     if (PL_hints & HINT_LOCALIZE_HH) {
663         HV *oldhh = GvHV(PL_hintgv);
664         save_pushptri32ptr(oldhh, PL_hints, save_cophh, SAVEt_HINTS);
665         GvHV(PL_hintgv) = NULL; /* in case copying dies */
666         GvHV(PL_hintgv) = hv_copy_hints_hv(oldhh);
667     } else {
668         save_pushi32ptr(PL_hints, save_cophh, SAVEt_HINTS);
669     }
670 }
671
672 static void
673 S_save_pushptri32ptr(pTHX_ void *const ptr1, const I32 i, void *const ptr2,
674                         const int type)
675 {
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);
682 }
683
684 void
685 Perl_save_aelem_flags(pTHX_ AV *av, SSize_t idx, SV **sptr,
686                             const U32 flags)
687 {
688     dSS_ADD;
689     SV *sv;
690
691     PERL_ARGS_ASSERT_SAVE_AELEM_FLAGS;
692
693     SvGETMAGIC(*sptr);
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);
699     /* The array needs to hold a reference count on its new element, so it
700        must be AvREAL. */
701     if (UNLIKELY(!AvREAL(av) && AvREIFY(av)))
702         av_reify(av);
703     save_scalar_at(sptr, flags); /* XXX - FIXME - see #60360 */
704     if (flags & SAVEf_KEEPOLDELEM)
705         return;
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 */
711     if (UNLIKELY(SvTIED_mg((const SV *)av, PERL_MAGIC_tied)))
712         sv_2mortal(sv);
713 }
714
715 void
716 Perl_save_helem_flags(pTHX_ HV *hv, SV *key, SV **sptr, const U32 flags)
717 {
718     SV *sv;
719
720     PERL_ARGS_ASSERT_SAVE_HELEM_FLAGS;
721
722     SvGETMAGIC(*sptr);
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     }
731     save_scalar_at(sptr, flags);
732     if (flags & SAVEf_KEEPOLDELEM)
733         return;
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 */
739     if (UNLIKELY(SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)))
740         sv_2mortal(sv);
741 }
742
743 SV*
744 Perl_save_svref(pTHX_ SV **sptr)
745 {
746     PERL_ARGS_ASSERT_SAVE_SVREF;
747
748     SvGETMAGIC(*sptr);
749     save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_SVREF);
750     return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
751 }
752
753
754 void
755 Perl_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
765 I32
766 Perl_save_alloc(pTHX_ I32 size, I32 pad)
767 {
768     const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
769                           - (char*)PL_savestack);
770     const UV elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
771     const UV elems_shifted = elems << SAVE_TIGHT_SHIFT;
772
773     if (UNLIKELY((elems_shifted >> SAVE_TIGHT_SHIFT) != elems))
774         Perl_croak(aTHX_
775             "panic: save_alloc elems %"UVuf" out of range (%"IVdf"-%"IVdf")",
776                    elems, (IV)size, (IV)pad);
777
778     SSGROW(elems + 1);
779
780     PL_savestack_ix += elems;
781     SSPUSHUV(SAVEt_ALLOC | elems_shifted);
782     return start;
783 }
784
785
786 static U8 arg_counts[] = {
787     0, /* SAVEt_ALLOC              */
788     0, /* SAVEt_CLEARPADRANGE      */
789     0, /* SAVEt_CLEARSV            */
790     0, /* SAVEt_REGCONTEXT         */
791     1, /* SAVEt_TMPSFLOOR          */
792     1, /* SAVEt_BOOL               */
793     1, /* SAVEt_COMPILE_WARNINGS   */
794     1, /* SAVEt_COMPPAD            */
795     1, /* SAVEt_FREECOPHH          */
796     1, /* SAVEt_FREEOP             */
797     1, /* SAVEt_FREEPV             */
798     1, /* SAVEt_FREESV             */
799     1, /* SAVEt_I16                */
800     1, /* SAVEt_I32_SMALL          */
801     1, /* SAVEt_I8                 */
802     1, /* SAVEt_INT_SMALL          */
803     1, /* SAVEt_MORTALIZESV        */
804     1, /* SAVEt_NSTAB              */
805     1, /* SAVEt_OP                 */
806     1, /* SAVEt_PARSER             */
807     1, /* SAVEt_STACK_POS          */
808     1, /* SAVEt_READONLY_OFF       */
809     1, /* SAVEt_FREEPADNAME        */
810     2, /* SAVEt_AV                 */
811     2, /* SAVEt_DESTRUCTOR         */
812     2, /* SAVEt_DESTRUCTOR_X       */
813     2, /* SAVEt_GENERIC_PVREF      */
814     2, /* SAVEt_GENERIC_SVREF      */
815     2, /* SAVEt_GP                 */
816     2, /* SAVEt_GVSV               */
817     2, /* SAVEt_HINTS              */
818     2, /* SAVEt_HPTR               */
819     2, /* SAVEt_HV                 */
820     2, /* SAVEt_I32                */
821     2, /* SAVEt_INT                */
822     2, /* SAVEt_ITEM               */
823     2, /* SAVEt_IV                 */
824     2, /* SAVEt_LONG               */
825     2, /* SAVEt_PPTR               */
826     2, /* SAVEt_SAVESWITCHSTACK    */
827     2, /* SAVEt_SHARED_PVREF       */
828     2, /* SAVEt_SPTR               */
829     2, /* SAVEt_STRLEN             */
830     2, /* SAVEt_SV                 */
831     2, /* SAVEt_SVREF              */
832     2, /* SAVEt_VPTR               */
833     2, /* SAVEt_ADELETE            */
834     2, /* SAVEt_APTR               */
835     3, /* SAVEt_HELEM              */
836     3, /* SAVEt_PADSV_AND_MORTALIZE*/
837     3, /* SAVEt_SET_SVFLAGS        */
838     3, /* SAVEt_GVSLOT             */
839     3, /* SAVEt_AELEM              */
840     3  /* SAVEt_DELETE             */
841 };
842
843
844 void
845 Perl_leave_scope(pTHX_ I32 base)
846 {
847     /* Localise the effects of the TAINT_NOT inside the loop.  */
848     bool was = TAINT_get;
849
850     if (UNLIKELY(base < -1))
851         Perl_croak(aTHX_ "panic: corrupt saved stack index %ld", (long) base);
852     DEBUG_l(Perl_deb(aTHX_ "savestack: releasing items %ld -> %ld\n",
853                         (long)PL_savestack_ix, (long)base));
854     while (PL_savestack_ix > base) {
855         UV uv;
856         U8 type;
857         SV **svp;
858         I32 i;
859         ANY *ap; /* arg pointer */
860         ANY a0, a1, a2; /* up to 3 args */
861
862         TAINT_NOT;
863
864         {
865             U8  argcount;
866             I32 ix = PL_savestack_ix - 1;
867
868             ap = &PL_savestack[ix];
869             uv = ap->any_uv;
870             type = (U8)uv & SAVE_MASK;
871             argcount = arg_counts[type];
872             PL_savestack_ix = ix - argcount;
873             ap -= argcount;
874         }
875
876         switch (type) {
877         case SAVEt_ITEM:                        /* normal string */
878             a0 = ap[0]; a1 = ap[1];
879             sv_replace(a0.any_sv, a1.any_sv);
880             if (UNLIKELY(SvSMAGICAL(a0.any_sv))) {
881                 PL_localizing = 2;
882                 mg_set(a0.any_sv);
883                 PL_localizing = 0;
884             }
885             break;
886
887             /* This would be a mathom, but Perl_save_svref() calls a static
888                function, S_save_scalar_at(), so has to stay in this file.  */
889         case SAVEt_SVREF:                       /* scalar reference */
890             a0 = ap[0]; a1 = ap[1];
891             svp = a0.any_svp;
892             a0.any_sv = NULL; /* what to refcnt_dec */
893             goto restore_sv;
894
895         case SAVEt_SV:                          /* scalar reference */
896             a0 = ap[0]; a1 = ap[1];
897             svp = &GvSV(a0.any_gv);
898         restore_sv:
899         {
900             /* do *svp = a1 and free a0 */
901             SV * const sv = *svp;
902             *svp = a1.any_sv;
903             SvREFCNT_dec(sv);
904             if (UNLIKELY(SvSMAGICAL(a1.any_sv))) {
905                 /* mg_set could die, skipping the freeing of a0 and
906                  * a1; Ensure that they're always freed in that case */
907                 dSS_ADD;
908                 SS_ADD_PTR(a1.any_sv);
909                 SS_ADD_UV(SAVEt_FREESV);
910                 SS_ADD_PTR(a0.any_sv);
911                 SS_ADD_UV(SAVEt_FREESV);
912                 SS_ADD_END(4);
913                 PL_localizing = 2;
914                 mg_set(a1.any_sv);
915                 PL_localizing = 0;
916                 break;
917             }
918             SvREFCNT_dec_NN(a1.any_sv);
919             SvREFCNT_dec(a0.any_sv);
920             break;
921         }
922
923         case SAVEt_GENERIC_PVREF:               /* generic pv */
924             a0 = ap[0]; a1 = ap[1];
925             if (*a1.any_pvp != a0.any_pv) {
926                 Safefree(*a1.any_pvp);
927                 *a1.any_pvp = a0.any_pv;
928             }
929             break;
930
931         case SAVEt_SHARED_PVREF:                /* shared pv */
932             a0 = ap[0]; a1 = ap[1];
933             if (*a0.any_pvp != a1.any_pv) {
934 #ifdef NETWARE
935                 PerlMem_free(*a0.any_pvp);
936 #else
937                 PerlMemShared_free(*a0.any_pvp);
938 #endif
939                 *a0.any_pvp = a1.any_pv;
940             }
941             break;
942
943         case SAVEt_GVSV:                        /* scalar slot in GV */
944             a0 = ap[0]; a1 = ap[1];
945             svp = &GvSV(a0.any_gv);
946             goto restore_svp;
947
948         case SAVEt_GENERIC_SVREF:               /* generic sv */
949             a0 = ap[0]; a1 = ap[1];
950             svp = a0.any_svp;
951         restore_svp:
952         {
953             /* do *svp = a1 */
954             SV * const sv = *svp;
955             *svp = a1.any_sv;
956             SvREFCNT_dec(sv);
957             SvREFCNT_dec(a1.any_sv);
958             break;
959         }
960
961         case SAVEt_GVSLOT:                      /* any slot in GV */
962         {
963             HV * hv;
964             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
965             hv = GvSTASH(a0.any_gv);
966             svp = a1.any_svp;
967             if (hv && HvENAME(hv) && (
968                     (a2.any_sv && SvTYPE(a2.any_sv) == SVt_PVCV)
969                  || (*svp && SvTYPE(*svp) == SVt_PVCV)
970                ))
971             {
972                 if ((char *)svp < (char *)GvGP(a0.any_gv)
973                  || (char *)svp > (char *)GvGP(a0.any_gv) + sizeof(struct gp)
974                  || GvREFCNT(a0.any_gv) > 2) /* "> 2" to ignore savestack's ref */
975                     PL_sub_generation++;
976                 else mro_method_changed_in(hv);
977             }
978             a1.any_sv = a2.any_sv;
979             goto restore_svp;
980         }
981
982         case SAVEt_AV:                          /* array reference */
983             a0 = ap[0]; a1 = ap[1];
984             SvREFCNT_dec(GvAV(a0.any_gv));
985             GvAV(a0.any_gv) = a1.any_av;
986           avhv_common:
987             if (UNLIKELY(SvSMAGICAL(a1.any_sv))) {
988                 /* mg_set might die, so make sure a0 isn't leaked */
989                 dSS_ADD;
990                 SS_ADD_PTR(a0.any_sv);
991                 SS_ADD_UV(SAVEt_FREESV);
992                 SS_ADD_END(2);
993                 PL_localizing = 2;
994                 mg_set(a1.any_sv);
995                 PL_localizing = 0;
996                 break;
997             }
998             SvREFCNT_dec_NN(a0.any_sv);
999             break;
1000
1001         case SAVEt_HV:                          /* hash reference */
1002             a0 = ap[0]; a1 = ap[1];
1003             SvREFCNT_dec(GvHV(a0.any_gv));
1004             GvHV(a0.any_gv) = a1.any_hv;
1005             goto avhv_common;
1006
1007         case SAVEt_INT_SMALL:
1008             a0 = ap[0];
1009             *(int*)a0.any_ptr = (int)(uv >> SAVE_TIGHT_SHIFT);
1010             break;
1011
1012         case SAVEt_INT:                         /* int reference */
1013             a0 = ap[0]; a1 = ap[1];
1014             *(int*)a1.any_ptr = (int)a0.any_i32;
1015             break;
1016
1017         case SAVEt_STRLEN:                      /* STRLEN/size_t ref */
1018             a0 = ap[0]; a1 = ap[1];
1019             *(STRLEN*)a1.any_ptr = (STRLEN)a0.any_iv;
1020             break;
1021
1022         case SAVEt_TMPSFLOOR:                   /* restore PL_tmps_floor */
1023             a0 = ap[0];
1024             PL_tmps_floor = (SSize_t)a0.any_iv;
1025             break;
1026
1027         case SAVEt_BOOL:                        /* bool reference */
1028             a0 = ap[0];
1029             *(bool*)a0.any_ptr = cBOOL(uv >> 8);
1030 #ifdef NO_TAINT_SUPPORT
1031             PERL_UNUSED_VAR(was);
1032 #else
1033             if (UNLIKELY(a0.any_ptr == &(TAINT_get))) {
1034                 /* If we don't update <was>, to reflect what was saved on the
1035                  * stack for PL_tainted, then we will overwrite this attempt to
1036                  * restore it when we exit this routine.  Note that this won't
1037                  * work if this value was saved in a wider-than necessary type,
1038                  * such as I32 */
1039                 was = *(bool*)a0.any_ptr;
1040             }
1041 #endif
1042             break;
1043
1044         case SAVEt_I32_SMALL:
1045             a0 = ap[0];
1046             *(I32*)a0.any_ptr = (I32)(uv >> SAVE_TIGHT_SHIFT);
1047             break;
1048
1049         case SAVEt_I32:                         /* I32 reference */
1050             a0 = ap[0]; a1 = ap[1];
1051 #ifdef PERL_DEBUG_READONLY_OPS
1052             if (*(I32*)a1.any_ptr != a0.any_i32)
1053 #endif
1054                 *(I32*)a1.any_ptr = a0.any_i32;
1055             break;
1056
1057         case SAVEt_SPTR:                        /* SV* reference */
1058             a0 = ap[0]; a1 = ap[1];
1059             *a1.any_svp= a0.any_sv;
1060             break;
1061
1062         case SAVEt_VPTR:                        /* random* reference */
1063         case SAVEt_PPTR:                        /* char* reference */
1064             a0 = ap[0]; a1 = ap[1];
1065             *a1.any_pvp = a0.any_pv;
1066             break;
1067
1068         case SAVEt_HPTR:                        /* HV* reference */
1069             a0 = ap[0]; a1 = ap[1];
1070             *(HV**)a1.any_ptr = a0.any_hv;
1071             break;
1072
1073         case SAVEt_APTR:                        /* AV* reference */
1074             a0 = ap[0]; a1 = ap[1];
1075             *(AV**)a1.any_ptr = a0.any_av;
1076             break;
1077
1078         case SAVEt_GP:                          /* scalar reference */
1079         {
1080             HV *hv;
1081             bool had_method;
1082
1083             a0 = ap[0]; a1 = ap[1];
1084             /* possibly taking a method out of circulation */   
1085             had_method = !!GvCVu(a0.any_gv);
1086             gp_free(a0.any_gv);
1087             GvGP_set(a0.any_gv, (GP*)a1.any_ptr);
1088             if ((hv=GvSTASH(a0.any_gv)) && HvENAME_get(hv)) {
1089                 if (   GvNAMELEN(a0.any_gv) == 3
1090                     && strnEQ(GvNAME(a0.any_gv), "ISA", 3)
1091                 )
1092                     mro_isa_changed_in(hv);
1093                 else if (had_method || GvCVu(a0.any_gv))
1094                     /* putting a method back into circulation ("local")*/       
1095                     gv_method_changed(a0.any_gv);
1096             }
1097             SvREFCNT_dec_NN(a0.any_gv);
1098             break;
1099         }
1100
1101         case SAVEt_FREESV:
1102             a0 = ap[0];
1103             SvREFCNT_dec(a0.any_sv);
1104             break;
1105
1106         case SAVEt_FREEPADNAME:
1107             a0 = ap[0];
1108             PadnameREFCNT_dec((PADNAME *)a0.any_ptr);
1109             break;
1110
1111         case SAVEt_FREECOPHH:
1112             a0 = ap[0];
1113             cophh_free((COPHH *)a0.any_ptr);
1114             break;
1115
1116         case SAVEt_MORTALIZESV:
1117             a0 = ap[0];
1118             sv_2mortal(a0.any_sv);
1119             break;
1120
1121         case SAVEt_FREEOP:
1122             a0 = ap[0];
1123             ASSERT_CURPAD_LEGAL("SAVEt_FREEOP");
1124             op_free((OP*)a0.any_ptr);
1125             break;
1126
1127         case SAVEt_FREEPV:
1128             a0 = ap[0];
1129             Safefree(a0.any_ptr);
1130             break;
1131
1132         case SAVEt_CLEARPADRANGE:
1133             i = (I32)((uv >> SAVE_TIGHT_SHIFT) & OPpPADRANGE_COUNTMASK);
1134             svp = &PL_curpad[uv >>
1135                     (OPpPADRANGE_COUNTSHIFT + SAVE_TIGHT_SHIFT)] + i - 1;
1136             goto clearsv;
1137         case SAVEt_CLEARSV:
1138             svp = &PL_curpad[uv >> SAVE_TIGHT_SHIFT];
1139             i = 1;
1140           clearsv:
1141             for (; i; i--, svp--) {
1142                 SV *sv = *svp;
1143
1144                 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1145              "Pad 0x%"UVxf"[0x%"UVxf"] clearsv: %ld sv=0x%"UVxf"<%"IVdf"> %s\n",
1146                     PTR2UV(PL_comppad), PTR2UV(PL_curpad),
1147                     (long)(svp-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
1148                     (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
1149                 ));
1150
1151                 /* Can clear pad variable in place? */
1152                 if (SvREFCNT(sv) == 1 && !SvOBJECT(sv)) {
1153
1154                     /* these flags are the union of all the relevant flags
1155                      * in the individual conditions within */
1156                     if (UNLIKELY(SvFLAGS(sv) & (
1157                             SVf_READONLY|SVf_PROTECT /*for SvREADONLY_off*/
1158                           | (SVs_GMG|SVs_SMG|SVs_RMG) /* SvMAGICAL() */
1159                           | SVf_OOK
1160                           | SVf_THINKFIRST)))
1161                     {
1162                         /* if a my variable that was made readonly is
1163                          * going out of scope, we want to remove the
1164                          * readonlyness so that it can go out of scope
1165                          * quietly
1166                          */
1167                         if (SvREADONLY(sv))
1168                             SvREADONLY_off(sv);
1169
1170                         if (SvOOK(sv)) { /* OOK or HvAUX */
1171                             if (SvTYPE(sv) == SVt_PVHV)
1172                                 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
1173                             else
1174                                 sv_backoff(sv);
1175                         }
1176
1177                         if (SvMAGICAL(sv)) {
1178                             /* note that backrefs (either in HvAUX or magic)
1179                              * must be removed before other magic */
1180                             sv_unmagic(sv, PERL_MAGIC_backref);
1181                             if (SvTYPE(sv) != SVt_PVCV)
1182                                 mg_free(sv);
1183                         }
1184                         if (SvTHINKFIRST(sv))
1185                             sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF
1186                                                      |SV_COW_DROP_PV);
1187
1188                     }
1189                     switch (SvTYPE(sv)) {
1190                     case SVt_NULL:
1191                         break;
1192                     case SVt_PVAV:
1193                         av_clear(MUTABLE_AV(sv));
1194                         break;
1195                     case SVt_PVHV:
1196                         hv_clear(MUTABLE_HV(sv));
1197                         break;
1198                     case SVt_PVCV:
1199                     {
1200                         HEK *hek =
1201                               CvNAMED(sv)
1202                                 ? CvNAME_HEK((CV *)sv)
1203                                 : GvNAME_HEK(CvGV(sv));
1204                         assert(hek);
1205                         (void)share_hek_hek(hek);
1206                         cv_undef((CV *)sv);
1207                         CvNAME_HEK_set(sv, hek);
1208                         CvLEXICAL_on(sv);
1209                         break;
1210                     }
1211                     default:
1212                         /* This looks odd, but these two macros are for use in
1213                            expressions and finish with a trailing comma, so
1214                            adding a ; after them would be wrong. */
1215                         assert_not_ROK(sv)
1216                         assert_not_glob(sv)
1217                         SvFLAGS(sv) &=~ (SVf_OK|SVf_IVisUV|SVf_UTF8);
1218                         break;
1219                     }
1220                     SvPADTMP_off(sv);
1221                     SvPADSTALE_on(sv); /* mark as no longer live */
1222                 }
1223                 else {  /* Someone has a claim on this, so abandon it. */
1224                     switch (SvTYPE(sv)) {       /* Console ourselves with a new value */
1225                     case SVt_PVAV:      *svp = MUTABLE_SV(newAV());     break;
1226                     case SVt_PVHV:      *svp = MUTABLE_SV(newHV());     break;
1227                     case SVt_PVCV:
1228                     {
1229                         HEK * const hek = CvNAMED(sv)
1230                                              ? CvNAME_HEK((CV *)sv)
1231                                              : GvNAME_HEK(CvGV(sv));
1232
1233                         /* Create a stub */
1234                         *svp = newSV_type(SVt_PVCV);
1235
1236                         /* Share name */
1237                         CvNAME_HEK_set(*svp,
1238                                        share_hek_hek(hek));
1239                         CvLEXICAL_on(*svp);
1240                         break;
1241                     }
1242                     default:    *svp = newSV(0);                break;
1243                     }
1244                     SvREFCNT_dec_NN(sv); /* Cast current value to the winds. */
1245                     /* preserve pad nature, but also mark as not live
1246                      * for any closure capturing */
1247                     SvFLAGS(*svp) |= SVs_PADSTALE;
1248                 }
1249             }
1250             break;
1251
1252         case SAVEt_DELETE:
1253             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1254             (void)hv_delete(a2.any_hv, a0.any_pv, a1.any_i32, G_DISCARD);
1255             SvREFCNT_dec(a2.any_hv);
1256             Safefree(a0.any_ptr);
1257             break;
1258
1259         case SAVEt_ADELETE:
1260             a0 = ap[0]; a1 = ap[1];
1261             (void)av_delete(a1.any_av, a0.any_iv, G_DISCARD);
1262             SvREFCNT_dec(a1.any_av);
1263             break;
1264
1265         case SAVEt_DESTRUCTOR_X:
1266             a0 = ap[0]; a1 = ap[1];
1267             (*a0.any_dxptr)(aTHX_ a1.any_ptr);
1268             break;
1269
1270         case SAVEt_REGCONTEXT:
1271             /* regexp must have croaked */
1272         case SAVEt_ALLOC:
1273             PL_savestack_ix -= uv >> SAVE_TIGHT_SHIFT;
1274             break;
1275
1276         case SAVEt_STACK_POS:           /* Position on Perl stack */
1277             a0 = ap[0];
1278             PL_stack_sp = PL_stack_base + a0.any_i32;
1279             break;
1280
1281         case SAVEt_AELEM:               /* array element */
1282             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1283             svp = av_fetch(a0.any_av, a1.any_iv, 1);
1284             if (UNLIKELY(!AvREAL(a0.any_av) && AvREIFY(a0.any_av))) /* undo reify guard */
1285                 SvREFCNT_dec(a2.any_sv);
1286             if (LIKELY(svp)) {
1287                 SV * const sv = *svp;
1288                 if (LIKELY(sv && sv != &PL_sv_undef)) {
1289                     if (UNLIKELY(SvTIED_mg((const SV *)a0.any_av, PERL_MAGIC_tied)))
1290                         SvREFCNT_inc_void_NN(sv);
1291                     a1.any_sv = a2.any_sv;
1292                     goto restore_sv;
1293                 }
1294             }
1295             SvREFCNT_dec(a0.any_av);
1296             SvREFCNT_dec(a2.any_sv);
1297             break;
1298
1299         case SAVEt_HELEM:               /* hash element */
1300         {
1301             HE *he;
1302
1303             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1304             he = hv_fetch_ent(a0.any_hv, a1.any_sv, 1, 0);
1305             SvREFCNT_dec(a1.any_sv);
1306             if (LIKELY(he)) {
1307                 const SV * const oval = HeVAL(he);
1308                 if (LIKELY(oval && oval != &PL_sv_undef)) {
1309                     svp = &HeVAL(he);
1310                     if (UNLIKELY(SvTIED_mg((const SV *)a0.any_hv, PERL_MAGIC_tied)))
1311                         SvREFCNT_inc_void(*svp);
1312                     a1.any_sv = a2.any_sv;
1313                     goto restore_sv;
1314                 }
1315             }
1316             SvREFCNT_dec(a0.any_hv);
1317             SvREFCNT_dec(a2.any_sv);
1318             break;
1319         }
1320         case SAVEt_OP:
1321             a0 = ap[0];
1322             PL_op = (OP*)a0.any_ptr;
1323             break;
1324
1325         case SAVEt_HINTS:
1326             a0 = ap[0]; a1 = ap[1];
1327             if ((PL_hints & HINT_LOCALIZE_HH)) {
1328               while (GvHV(PL_hintgv)) {
1329                 HV *hv = GvHV(PL_hintgv);
1330                 GvHV(PL_hintgv) = NULL;
1331                 SvREFCNT_dec(MUTABLE_SV(hv));
1332               }
1333             }
1334             cophh_free(CopHINTHASH_get(&PL_compiling));
1335             CopHINTHASH_set(&PL_compiling, (COPHH*)a1.any_ptr);
1336             *(I32*)&PL_hints = a0.any_i32;
1337             if (PL_hints & HINT_LOCALIZE_HH) {
1338                 SvREFCNT_dec(MUTABLE_SV(GvHV(PL_hintgv)));
1339                 GvHV(PL_hintgv) = MUTABLE_HV(SSPOPPTR);
1340             }
1341             if (!GvHV(PL_hintgv)) {
1342                 /* Need to add a new one manually, else rv2hv can
1343                    add one via GvHVn and it won't have the magic set.  */
1344                 HV *const hv = newHV();
1345                 hv_magic(hv, NULL, PERL_MAGIC_hints);
1346                 GvHV(PL_hintgv) = hv;
1347             }
1348             assert(GvHV(PL_hintgv));
1349             break;
1350
1351         case SAVEt_COMPPAD:
1352             a0 = ap[0];
1353             PL_comppad = (PAD*)a0.any_ptr;
1354             if (LIKELY(PL_comppad))
1355                 PL_curpad = AvARRAY(PL_comppad);
1356             else
1357                 PL_curpad = NULL;
1358             break;
1359
1360         case SAVEt_PADSV_AND_MORTALIZE:
1361             {
1362                 SV **svp;
1363
1364                 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1365                 assert (a1.any_ptr);
1366                 svp = AvARRAY((PAD*)a1.any_ptr) + (PADOFFSET)a2.any_uv;
1367                 /* This mortalizing used to be done by CX_POOPLOOP() via
1368                    itersave.  But as we have all the information here, we
1369                    can do it here, save even having to have itersave in
1370                    the struct.
1371                    */
1372                 sv_2mortal(*svp);
1373                 *svp = a0.any_sv;
1374             }
1375             break;
1376
1377         case SAVEt_SAVESWITCHSTACK:
1378             {
1379                 dSP;
1380
1381                 a0 = ap[0]; a1 = ap[1];
1382                 SWITCHSTACK(a1.any_av, a0.any_av);
1383                 PL_curstackinfo->si_stack = a0.any_av;
1384             }
1385             break;
1386
1387         case SAVEt_SET_SVFLAGS:
1388             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1389             SvFLAGS(a0.any_sv) &= ~(a1.any_u32);
1390             SvFLAGS(a0.any_sv) |= a2.any_u32;
1391             break;
1392
1393             /* These are only saved in mathoms.c */
1394         case SAVEt_NSTAB:
1395             a0 = ap[0];
1396             (void)sv_clear(a0.any_sv);
1397             break;
1398
1399         case SAVEt_LONG:                        /* long reference */
1400             a0 = ap[0]; a1 = ap[1];
1401             *(long*)a1.any_ptr = a0.any_long;
1402             break;
1403
1404         case SAVEt_IV:                          /* IV reference */
1405             a0 = ap[0]; a1 = ap[1];
1406             *(IV*)a1.any_ptr = a0.any_iv;
1407             break;
1408
1409         case SAVEt_I16:                         /* I16 reference */
1410             a0 = ap[0];
1411             *(I16*)a0.any_ptr = (I16)(uv >> 8);
1412             break;
1413
1414         case SAVEt_I8:                          /* I8 reference */
1415             a0 = ap[0];
1416             *(I8*)a0.any_ptr = (I8)(uv >> 8);
1417             break;
1418
1419         case SAVEt_DESTRUCTOR:
1420             a0 = ap[0]; a1 = ap[1];
1421             (*a0.any_dptr)(a1.any_ptr);
1422             break;
1423
1424         case SAVEt_COMPILE_WARNINGS:
1425             a0 = ap[0];
1426             if (!specialWARN(PL_compiling.cop_warnings))
1427                 PerlMemShared_free(PL_compiling.cop_warnings);
1428             PL_compiling.cop_warnings = (STRLEN*)a0.any_ptr;
1429             break;
1430
1431         case SAVEt_PARSER:
1432             a0 = ap[0];
1433             parser_free((yy_parser *)a0.any_ptr);
1434             break;
1435
1436         case SAVEt_READONLY_OFF:
1437             a0 = ap[0];
1438             SvREADONLY_off(a0.any_sv);
1439             break;
1440
1441         default:
1442             Perl_croak(aTHX_ "panic: leave_scope inconsistency %u", type);
1443         }
1444     }
1445
1446     TAINT_set(was);
1447 }
1448
1449 void
1450 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1451 {
1452     PERL_ARGS_ASSERT_CX_DUMP;
1453
1454 #ifdef DEBUGGING
1455     PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1456     if (CxTYPE(cx) != CXt_SUBST) {
1457         const char *gimme_text;
1458         PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1459         PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
1460                       PTR2UV(cx->blk_oldcop));
1461         PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1462         PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1463         PerlIO_printf(Perl_debug_log, "BLK_OLDSAVEIX = %ld\n", (long)cx->blk_oldsaveix);
1464         PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
1465                       PTR2UV(cx->blk_oldpm));
1466         switch (cx->blk_gimme) {
1467             case G_VOID:
1468                 gimme_text = "VOID";
1469                 break;
1470             case G_SCALAR:
1471                 gimme_text = "SCALAR";
1472                 break;
1473             case G_ARRAY:
1474                 gimme_text = "LIST";
1475                 break;
1476             default:
1477                 gimme_text = "UNKNOWN";
1478                 break;
1479         }
1480         PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", gimme_text);
1481     }
1482     switch (CxTYPE(cx)) {
1483     case CXt_NULL:
1484     case CXt_BLOCK:
1485         break;
1486     case CXt_FORMAT:
1487         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.CV = 0x%"UVxf"\n",
1488                 PTR2UV(cx->blk_format.cv));
1489         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.GV = 0x%"UVxf"\n",
1490                 PTR2UV(cx->blk_format.gv));
1491         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.DFOUTGV = 0x%"UVxf"\n",
1492                 PTR2UV(cx->blk_format.dfoutgv));
1493         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.HASARGS = %d\n",
1494                       (int)CxHASARGS(cx));
1495         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.RETOP = 0x%"UVxf"\n",
1496                 PTR2UV(cx->blk_format.retop));
1497         break;
1498     case CXt_SUB:
1499         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1500                 PTR2UV(cx->blk_sub.cv));
1501         PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1502                 (long)cx->blk_sub.olddepth);
1503         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1504                 (int)CxHASARGS(cx));
1505         PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n", (int)CxLVAL(cx));
1506         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1507                 PTR2UV(cx->blk_sub.retop));
1508         break;
1509     case CXt_EVAL:
1510         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1511                 (long)CxOLD_IN_EVAL(cx));
1512         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1513                 PL_op_name[CxOLD_OP_TYPE(cx)],
1514                 PL_op_desc[CxOLD_OP_TYPE(cx)]);
1515         if (cx->blk_eval.old_namesv)
1516             PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1517                           SvPVX_const(cx->blk_eval.old_namesv));
1518         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1519                 PTR2UV(cx->blk_eval.old_eval_root));
1520         PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%"UVxf"\n",
1521                 PTR2UV(cx->blk_eval.retop));
1522         break;
1523
1524     case CXt_LOOP_PLAIN:
1525     case CXt_LOOP_LAZYIV:
1526     case CXt_LOOP_LAZYSV:
1527     case CXt_LOOP_LIST:
1528     case CXt_LOOP_ARY:
1529         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n", CxLABEL(cx));
1530         PerlIO_printf(Perl_debug_log, "BLK_LOOP.MY_OP = 0x%"UVxf"\n",
1531                 PTR2UV(cx->blk_loop.my_op));
1532         if (CxTYPE(cx) != CXt_LOOP_PLAIN) {
1533             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1534                     PTR2UV(CxITERVAR(cx)));
1535             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERSAVE = 0x%"UVxf"\n",
1536                     PTR2UV(cx->blk_loop.itersave));
1537             /* XXX: not accurate for LAZYSV/IV/LIST */
1538             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1539                     PTR2UV(cx->blk_loop.state_u.ary.ary));
1540             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1541                     (long)cx->blk_loop.state_u.ary.ix);
1542         }
1543         break;
1544
1545     case CXt_SUBST:
1546         PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1547                 (long)cx->sb_iters);
1548         PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1549                 (long)cx->sb_maxiters);
1550         PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1551                 (long)cx->sb_rflags);
1552         PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1553                 (long)CxONCE(cx));
1554         PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1555                 cx->sb_orig);
1556         PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1557                 PTR2UV(cx->sb_dstr));
1558         PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1559                 PTR2UV(cx->sb_targ));
1560         PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1561                 PTR2UV(cx->sb_s));
1562         PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1563                 PTR2UV(cx->sb_m));
1564         PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1565                 PTR2UV(cx->sb_strend));
1566         PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1567                 PTR2UV(cx->sb_rxres));
1568         break;
1569     }
1570 #else
1571     PERL_UNUSED_CONTEXT;
1572     PERL_UNUSED_ARG(cx);
1573 #endif  /* DEBUGGING */
1574 }
1575
1576 /*
1577  * ex: set ts=8 sts=4 sw=4 et:
1578  */