e058433294f7f6d2d77383e9dab32828eb6eb4f4
[perl.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, int n)
31 {
32     dVAR;
33
34     PERL_ARGS_ASSERT_STACK_GROW;
35
36     PL_stack_sp = sp;
37 #ifndef STRESS_REALLOC
38     av_extend(PL_curstack, (p - PL_stack_base) + (n) + 128);
39 #else
40     av_extend(PL_curstack, (p - PL_stack_base) + (n) + 1);
41 #endif
42     return PL_stack_sp;
43 }
44
45 #ifndef STRESS_REALLOC
46 #define GROW(old) ((old) * 3 / 2)
47 #else
48 #define GROW(old) ((old) + 1)
49 #endif
50
51 PERL_SI *
52 Perl_new_stackinfo(pTHX_ I32 stitems, I32 cxitems)
53 {
54     dVAR;
55     PERL_SI *si;
56     Newx(si, 1, PERL_SI);
57     si->si_stack = newAV();
58     AvREAL_off(si->si_stack);
59     av_extend(si->si_stack, stitems > 0 ? stitems-1 : 0);
60     AvALLOC(si->si_stack)[0] = &PL_sv_undef;
61     AvFILLp(si->si_stack) = 0;
62     si->si_prev = 0;
63     si->si_next = 0;
64     si->si_cxmax = cxitems - 1;
65     si->si_cxix = -1;
66     si->si_type = PERLSI_UNDEF;
67     Newx(si->si_cxstack, cxitems, PERL_CONTEXT);
68     /* Without any kind of initialising PUSHSUBST()
69      * in pp_subst() will read uninitialised heap. */
70     PoisonNew(si->si_cxstack, cxitems, PERL_CONTEXT);
71     return si;
72 }
73
74 I32
75 Perl_cxinc(pTHX)
76 {
77     dVAR;
78     const IV old_max = cxstack_max;
79     cxstack_max = GROW(cxstack_max);
80     Renew(cxstack, cxstack_max + 1, PERL_CONTEXT);      /* XXX should fix CXINC macro */
81     /* Without any kind of initialising deep enough recursion
82      * will end up reading uninitialised PERL_CONTEXTs. */
83     PoisonNew(cxstack + old_max + 1, cxstack_max - old_max, PERL_CONTEXT);
84     return cxstack_ix + 1;
85 }
86
87 void
88 Perl_push_scope(pTHX)
89 {
90     dVAR;
91     if (PL_scopestack_ix == PL_scopestack_max) {
92         PL_scopestack_max = GROW(PL_scopestack_max);
93         Renew(PL_scopestack, PL_scopestack_max, I32);
94     }
95     PL_scopestack[PL_scopestack_ix++] = PL_savestack_ix;
96
97 }
98
99 void
100 Perl_pop_scope(pTHX)
101 {
102     dVAR;
103     const I32 oldsave = PL_scopestack[--PL_scopestack_ix];
104     LEAVE_SCOPE(oldsave);
105 }
106
107 void
108 Perl_markstack_grow(pTHX)
109 {
110     dVAR;
111     const I32 oldmax = PL_markstack_max - PL_markstack;
112     const I32 newmax = GROW(oldmax);
113
114     Renew(PL_markstack, newmax, I32);
115     PL_markstack_ptr = PL_markstack + oldmax;
116     PL_markstack_max = PL_markstack + newmax;
117 }
118
119 void
120 Perl_savestack_grow(pTHX)
121 {
122     dVAR;
123     PL_savestack_max = GROW(PL_savestack_max) + 4;
124     Renew(PL_savestack, PL_savestack_max, ANY);
125 }
126
127 void
128 Perl_savestack_grow_cnt(pTHX_ I32 need)
129 {
130     dVAR;
131     PL_savestack_max = PL_savestack_ix + need;
132     Renew(PL_savestack, PL_savestack_max, ANY);
133 }
134
135 #undef GROW
136
137 void
138 Perl_tmps_grow(pTHX_ I32 n)
139 {
140     dVAR;
141 #ifndef STRESS_REALLOC
142     if (n < 128)
143         n = (PL_tmps_max < 512) ? 128 : 512;
144 #endif
145     PL_tmps_max = PL_tmps_ix + n + 1;
146     Renew(PL_tmps_stack, PL_tmps_max, SV*);
147 }
148
149
150 void
151 Perl_free_tmps(pTHX)
152 {
153     dVAR;
154     /* XXX should tmps_floor live in cxstack? */
155     const I32 myfloor = PL_tmps_floor;
156     while (PL_tmps_ix > myfloor) {      /* clean up after last statement */
157         SV* const sv = PL_tmps_stack[PL_tmps_ix];
158         PL_tmps_stack[PL_tmps_ix--] = NULL;
159         if (sv && sv != &PL_sv_undef) {
160             SvTEMP_off(sv);
161             SvREFCNT_dec(sv);           /* note, can modify tmps_ix!!! */
162         }
163     }
164 }
165
166 STATIC SV *
167 S_save_scalar_at(pTHX_ SV **sptr)
168 {
169     dVAR;
170     SV * const osv = *sptr;
171     register SV * const sv = *sptr = newSV(0);
172
173     PERL_ARGS_ASSERT_SAVE_SCALAR_AT;
174
175     if (SvTYPE(osv) >= SVt_PVMG && SvMAGIC(osv) && SvTYPE(osv) != SVt_PVGV) {
176         if (SvGMAGICAL(osv)) {
177             const bool oldtainted = PL_tainted;
178             SvFLAGS(osv) |= (SvFLAGS(osv) &
179                (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
180             PL_tainted = oldtainted;
181         }
182         mg_localize(osv, sv);
183     }
184     return sv;
185 }
186
187 void
188 Perl_save_pushptrptr(pTHX_ void *const ptr1, void *const ptr2, const int type)
189 {
190     dVAR;
191     SSCHECK(3);
192     SSPUSHPTR(ptr1);
193     SSPUSHPTR(ptr2);
194     SSPUSHINT(type);
195 }
196
197 SV *
198 Perl_save_scalar(pTHX_ GV *gv)
199 {
200     dVAR;
201     SV ** const sptr = &GvSVn(gv);
202
203     PERL_ARGS_ASSERT_SAVE_SCALAR;
204
205     PL_localizing = 1;
206     SvGETMAGIC(*sptr);
207     PL_localizing = 0;
208     save_pushptrptr(SvREFCNT_inc_simple(gv), SvREFCNT_inc(*sptr), SAVEt_SV);
209     return save_scalar_at(sptr);
210 }
211
212 /* Like save_sptr(), but also SvREFCNT_dec()s the new value.  Can be used to
213  * restore a global SV to its prior contents, freeing new value. */
214 void
215 Perl_save_generic_svref(pTHX_ SV **sptr)
216 {
217     dVAR;
218
219     PERL_ARGS_ASSERT_SAVE_GENERIC_SVREF;
220
221     save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_GENERIC_SVREF);
222 }
223
224 /* Like save_pptr(), but also Safefree()s the new value if it is different
225  * from the old one.  Can be used to restore a global char* to its prior
226  * contents, freeing new value. */
227 void
228 Perl_save_generic_pvref(pTHX_ char **str)
229 {
230     dVAR;
231
232     PERL_ARGS_ASSERT_SAVE_GENERIC_PVREF;
233
234     save_pushptrptr(*str, str, SAVEt_GENERIC_PVREF);
235 }
236
237 /* Like save_generic_pvref(), but uses PerlMemShared_free() rather than Safefree().
238  * Can be used to restore a shared global char* to its prior
239  * contents, freeing new value. */
240 void
241 Perl_save_shared_pvref(pTHX_ char **str)
242 {
243     dVAR;
244
245     PERL_ARGS_ASSERT_SAVE_SHARED_PVREF;
246
247     save_pushptrptr(str, *str, SAVEt_SHARED_PVREF);
248 }
249
250 /* set the SvFLAGS specified by mask to the values in val */
251
252 void
253 Perl_save_set_svflags(pTHX_ SV* sv, U32 mask, U32 val)
254 {
255     dVAR;
256
257     PERL_ARGS_ASSERT_SAVE_SET_SVFLAGS;
258
259     SSCHECK(4);
260     SSPUSHPTR(sv);
261     SSPUSHINT(mask);
262     SSPUSHINT(val);
263     SSPUSHINT(SAVEt_SET_SVFLAGS);
264 }
265
266 void
267 Perl_save_gp(pTHX_ GV *gv, I32 empty)
268 {
269     dVAR;
270
271     PERL_ARGS_ASSERT_SAVE_GP;
272
273     save_pushptrptr(SvREFCNT_inc(gv), GvGP(gv), SAVEt_GP);
274
275     if (empty) {
276         GP *gp = Perl_newGP(aTHX_ gv);
277
278         if (GvCVu(gv))
279             mro_method_changed_in(GvSTASH(gv)); /* taking a method out of circulation ("local")*/
280         if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
281             gp->gp_io = newIO();
282             IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
283         }
284 #ifdef PERL_DONT_CREATE_GVSV
285         if (gv == PL_errgv) {
286             /* We could scatter this logic everywhere by changing the
287                definition of ERRSV from GvSV() to GvSVn(), but it seems more
288                efficient to do this check once here.  */
289             gp->gp_sv = newSV(0);
290         }
291 #endif
292         GvGP(gv) = gp;
293     }
294     else {
295         gp_ref(GvGP(gv));
296         GvINTRO_on(gv);
297     }
298 }
299
300 AV *
301 Perl_save_ary(pTHX_ GV *gv)
302 {
303     dVAR;
304     AV * const oav = GvAVn(gv);
305     AV *av;
306
307     PERL_ARGS_ASSERT_SAVE_ARY;
308
309     if (!AvREAL(oav) && AvREIFY(oav))
310         av_reify(oav);
311     save_pushptrptr(gv, oav, SAVEt_AV);
312
313     GvAV(gv) = NULL;
314     av = GvAVn(gv);
315     if (SvMAGIC(oav))
316         mg_localize(MUTABLE_SV(oav), MUTABLE_SV(av));
317     return av;
318 }
319
320 HV *
321 Perl_save_hash(pTHX_ GV *gv)
322 {
323     dVAR;
324     HV *ohv, *hv;
325
326     PERL_ARGS_ASSERT_SAVE_HASH;
327
328     save_pushptrptr(gv, (ohv = GvHVn(gv)), SAVEt_HV);
329
330     GvHV(gv) = NULL;
331     hv = GvHVn(gv);
332     if (SvMAGIC(ohv))
333         mg_localize(MUTABLE_SV(ohv), MUTABLE_SV(hv));
334     return hv;
335 }
336
337 void
338 Perl_save_item(pTHX_ register SV *item)
339 {
340     dVAR;
341     register SV * const sv = newSVsv(item);
342
343     PERL_ARGS_ASSERT_SAVE_ITEM;
344
345     save_pushptrptr(item, /* remember the pointer */
346                     sv,   /* remember the value */
347                     SAVEt_ITEM);
348 }
349
350 void
351 Perl_save_bool(pTHX_ bool *boolp)
352 {
353     dVAR;
354
355     PERL_ARGS_ASSERT_SAVE_BOOL;
356
357     SSCHECK(3);
358     SSPUSHBOOL(*boolp);
359     SSPUSHPTR(boolp);
360     SSPUSHINT(SAVEt_BOOL);
361 }
362
363 void
364 Perl_save_pushi32ptr(pTHX_ const I32 i, void *const ptr, const int type)
365 {
366     dVAR;
367     SSCHECK(3);
368     SSPUSHINT(i);
369     SSPUSHPTR(ptr);
370     SSPUSHINT(type);
371 }
372
373 void
374 Perl_save_int(pTHX_ int *intp)
375 {
376     dVAR;
377
378     PERL_ARGS_ASSERT_SAVE_INT;
379
380     save_pushi32ptr(*intp, intp, SAVEt_INT);
381 }
382
383 void
384 Perl_save_I8(pTHX_ I8 *bytep)
385 {
386     dVAR;
387
388     PERL_ARGS_ASSERT_SAVE_I8;
389
390     save_pushi32ptr(*bytep, bytep, SAVEt_I8);
391 }
392
393 void
394 Perl_save_I16(pTHX_ I16 *intp)
395 {
396     dVAR;
397
398     PERL_ARGS_ASSERT_SAVE_I16;
399
400     save_pushi32ptr(*intp, intp, SAVEt_I16);
401 }
402
403 void
404 Perl_save_I32(pTHX_ I32 *intp)
405 {
406     dVAR;
407
408     PERL_ARGS_ASSERT_SAVE_I32;
409
410     save_pushi32ptr(*intp, intp, SAVEt_I32);
411 }
412
413 /* Cannot use save_sptr() to store a char* since the SV** cast will
414  * force word-alignment and we'll miss the pointer.
415  */
416 void
417 Perl_save_pptr(pTHX_ char **pptr)
418 {
419     dVAR;
420
421     PERL_ARGS_ASSERT_SAVE_PPTR;
422
423     save_pushptrptr(*pptr, pptr, SAVEt_PPTR);
424 }
425
426 void
427 Perl_save_vptr(pTHX_ void *ptr)
428 {
429     dVAR;
430
431     PERL_ARGS_ASSERT_SAVE_VPTR;
432
433     save_pushptrptr(*(char**)ptr, ptr, SAVEt_VPTR);
434 }
435
436 void
437 Perl_save_sptr(pTHX_ SV **sptr)
438 {
439     dVAR;
440
441     PERL_ARGS_ASSERT_SAVE_SPTR;
442
443     save_pushptrptr(*sptr, sptr, SAVEt_SPTR);
444 }
445
446 void
447 Perl_save_padsv_and_mortalize(pTHX_ PADOFFSET off)
448 {
449     dVAR;
450     SSCHECK(4);
451     ASSERT_CURPAD_ACTIVE("save_padsv");
452     SSPUSHPTR(SvREFCNT_inc_simple_NN(PL_curpad[off]));
453     SSPUSHPTR(PL_comppad);
454     SSPUSHLONG((long)off);
455     SSPUSHINT(SAVEt_PADSV_AND_MORTALIZE);
456 }
457
458 void
459 Perl_save_hptr(pTHX_ HV **hptr)
460 {
461     dVAR;
462
463     PERL_ARGS_ASSERT_SAVE_HPTR;
464
465     save_pushptrptr(*hptr, hptr, SAVEt_HPTR);
466 }
467
468 void
469 Perl_save_aptr(pTHX_ AV **aptr)
470 {
471     dVAR;
472
473     PERL_ARGS_ASSERT_SAVE_APTR;
474
475     save_pushptrptr(*aptr, aptr, SAVEt_APTR);
476 }
477
478 void
479 Perl_save_pushptr(pTHX_ void *const ptr, const int type)
480 {
481     dVAR;
482     SSCHECK(2);
483     SSPUSHPTR(ptr);
484     SSPUSHINT(type);
485 }
486
487 void
488 Perl_save_clearsv(pTHX_ SV **svp)
489 {
490     dVAR;
491
492     PERL_ARGS_ASSERT_SAVE_CLEARSV;
493
494     ASSERT_CURPAD_ACTIVE("save_clearsv");
495     SSCHECK(2);
496     SSPUSHLONG((long)(svp-PL_curpad));
497     SSPUSHINT(SAVEt_CLEARSV);
498     SvPADSTALE_off(*svp); /* mark lexical as active */
499 }
500
501 void
502 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
503 {
504     dVAR;
505
506     PERL_ARGS_ASSERT_SAVE_DELETE;
507
508     SSCHECK(4);
509     SSPUSHINT(klen);
510     SSPUSHPTR(key);
511     SSPUSHPTR(SvREFCNT_inc_simple(hv));
512     SSPUSHINT(SAVEt_DELETE);
513 }
514
515 void
516 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
517 {
518     dVAR;
519
520     PERL_ARGS_ASSERT_SAVE_DESTRUCTOR;
521
522     SSCHECK(3);
523     SSPUSHDPTR(f);
524     SSPUSHPTR(p);
525     SSPUSHINT(SAVEt_DESTRUCTOR);
526 }
527
528 void
529 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
530 {
531     dVAR;
532     SSCHECK(3);
533     SSPUSHDXPTR(f);
534     SSPUSHPTR(p);
535     SSPUSHINT(SAVEt_DESTRUCTOR_X);
536 }
537
538 void
539 Perl_save_aelem(pTHX_ AV *av, I32 idx, SV **sptr)
540 {
541     dVAR;
542     SV *sv;
543
544     PERL_ARGS_ASSERT_SAVE_AELEM;
545
546     SvGETMAGIC(*sptr);
547     SSCHECK(4);
548     SSPUSHPTR(SvREFCNT_inc_simple(av));
549     SSPUSHINT(idx);
550     SSPUSHPTR(SvREFCNT_inc(*sptr));
551     SSPUSHINT(SAVEt_AELEM);
552     /* if it gets reified later, the restore will have the wrong refcnt */
553     if (!AvREAL(av) && AvREIFY(av))
554         SvREFCNT_inc_void(*sptr);
555     save_scalar_at(sptr);
556     sv = *sptr;
557     /* If we're localizing a tied array element, this new sv
558      * won't actually be stored in the array - so it won't get
559      * reaped when the localize ends. Ensure it gets reaped by
560      * mortifying it instead. DAPM */
561     if (SvTIED_mg(sv, PERL_MAGIC_tiedelem))
562         sv_2mortal(sv);
563 }
564
565 void
566 Perl_save_helem(pTHX_ HV *hv, SV *key, SV **sptr)
567 {
568     dVAR;
569     SV *sv;
570
571     PERL_ARGS_ASSERT_SAVE_HELEM;
572
573     SvGETMAGIC(*sptr);
574     SSCHECK(4);
575     SSPUSHPTR(SvREFCNT_inc_simple(hv));
576     SSPUSHPTR(newSVsv(key));
577     SSPUSHPTR(SvREFCNT_inc(*sptr));
578     SSPUSHINT(SAVEt_HELEM);
579     save_scalar_at(sptr);
580     sv = *sptr;
581     /* If we're localizing a tied hash element, this new sv
582      * won't actually be stored in the hash - so it won't get
583      * reaped when the localize ends. Ensure it gets reaped by
584      * mortifying it instead. DAPM */
585     if (SvTIED_mg(sv, PERL_MAGIC_tiedelem))
586         sv_2mortal(sv);
587 }
588
589 SV*
590 Perl_save_svref(pTHX_ SV **sptr)
591 {
592     dVAR;
593
594     PERL_ARGS_ASSERT_SAVE_SVREF;
595
596     SvGETMAGIC(*sptr);
597     save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_SVREF);
598     return save_scalar_at(sptr);
599 }
600
601 I32
602 Perl_save_alloc(pTHX_ I32 size, I32 pad)
603 {
604     dVAR;
605     register const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
606                                 - (char*)PL_savestack);
607     register const I32 elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
608
609     SSGROW(elems + 2);
610
611     PL_savestack_ix += elems;
612     SSPUSHINT(elems);
613     SSPUSHINT(SAVEt_ALLOC);
614     return start;
615 }
616
617 void
618 Perl_leave_scope(pTHX_ I32 base)
619 {
620     dVAR;
621     register SV *sv;
622     register SV *value;
623     register GV *gv;
624     register AV *av;
625     register HV *hv;
626     void* ptr;
627     register char* str;
628     I32 i;
629     /* Localise the effects of the TAINT_NOT inside the loop.  */
630     const bool was = PL_tainted;
631
632     if (base < -1)
633         Perl_croak(aTHX_ "panic: corrupt saved stack index");
634     while (PL_savestack_ix > base) {
635         TAINT_NOT;
636
637         switch (SSPOPINT) {
638         case SAVEt_ITEM:                        /* normal string */
639             value = MUTABLE_SV(SSPOPPTR);
640             sv = MUTABLE_SV(SSPOPPTR);
641             sv_replace(sv,value);
642             PL_localizing = 2;
643             SvSETMAGIC(sv);
644             PL_localizing = 0;
645             break;
646         case SAVEt_SV:                          /* scalar reference */
647             value = MUTABLE_SV(SSPOPPTR);
648             gv = MUTABLE_GV(SSPOPPTR);
649             ptr = &GvSV(gv);
650             av = MUTABLE_AV(gv); /* what to refcnt_dec */
651         restore_sv:
652             sv = *(SV**)ptr;
653             DEBUG_S(PerlIO_printf(Perl_debug_log,
654                                   "restore svref: %p %p:%s -> %p:%s\n",
655                                   (void*)ptr, (void*)sv, SvPEEK(sv),
656                                   (void*)value, SvPEEK(value)));
657             *(SV**)ptr = value;
658             SvREFCNT_dec(sv);
659             PL_localizing = 2;
660             SvSETMAGIC(value);
661             PL_localizing = 0;
662             SvREFCNT_dec(value);
663             if (av) /* actually an av, hv or gv */
664                 SvREFCNT_dec(av);
665             break;
666         case SAVEt_GENERIC_PVREF:               /* generic pv */
667             ptr = SSPOPPTR;
668             str = (char*)SSPOPPTR;
669             if (*(char**)ptr != str) {
670                 Safefree(*(char**)ptr);
671                 *(char**)ptr = str;
672             }
673             break;
674         case SAVEt_SHARED_PVREF:                /* shared pv */
675             str = (char*)SSPOPPTR;
676             ptr = SSPOPPTR;
677             if (*(char**)ptr != str) {
678 #ifdef NETWARE
679                 PerlMem_free(*(char**)ptr);
680 #else
681                 PerlMemShared_free(*(char**)ptr);
682 #endif
683                 *(char**)ptr = str;
684             }
685             break;
686         case SAVEt_GENERIC_SVREF:               /* generic sv */
687             value = MUTABLE_SV(SSPOPPTR);
688             ptr = SSPOPPTR;
689             sv = *(SV**)ptr;
690             *(SV**)ptr = value;
691             SvREFCNT_dec(sv);
692             SvREFCNT_dec(value);
693             break;
694         case SAVEt_AV:                          /* array reference */
695             av = MUTABLE_AV(SSPOPPTR);
696             gv = MUTABLE_GV(SSPOPPTR);
697             if (GvAV(gv)) {
698                 SvREFCNT_dec(GvAV(gv));
699             }
700             GvAV(gv) = av;
701             if (SvMAGICAL(av)) {
702                 PL_localizing = 2;
703                 SvSETMAGIC(MUTABLE_SV(av));
704                 PL_localizing = 0;
705             }
706             break;
707         case SAVEt_HV:                          /* hash reference */
708             hv = MUTABLE_HV(SSPOPPTR);
709             gv = MUTABLE_GV(SSPOPPTR);
710             if (GvHV(gv)) {
711                 SvREFCNT_dec(GvHV(gv));
712             }
713             GvHV(gv) = hv;
714             if (SvMAGICAL(hv)) {
715                 PL_localizing = 2;
716                 SvSETMAGIC(MUTABLE_SV(hv));
717                 PL_localizing = 0;
718             }
719             break;
720         case SAVEt_INT:                         /* int reference */
721             ptr = SSPOPPTR;
722             *(int*)ptr = (int)SSPOPINT;
723             break;
724         case SAVEt_BOOL:                        /* bool reference */
725             ptr = SSPOPPTR;
726             *(bool*)ptr = (bool)SSPOPBOOL;
727             break;
728         case SAVEt_I32:                         /* I32 reference */
729             ptr = SSPOPPTR;
730 #ifdef PERL_DEBUG_READONLY_OPS
731             {
732                 const I32 val = SSPOPINT;
733                 if (*(I32*)ptr != val)
734                     *(I32*)ptr = val;
735             }
736 #else
737             *(I32*)ptr = (I32)SSPOPINT;
738 #endif
739             break;
740         case SAVEt_SPTR:                        /* SV* reference */
741             ptr = SSPOPPTR;
742             *(SV**)ptr = MUTABLE_SV(SSPOPPTR);
743             break;
744         case SAVEt_VPTR:                        /* random* reference */
745         case SAVEt_PPTR:                        /* char* reference */
746             ptr = SSPOPPTR;
747             *(char**)ptr = (char*)SSPOPPTR;
748             break;
749         case SAVEt_HPTR:                        /* HV* reference */
750             ptr = SSPOPPTR;
751             *(HV**)ptr = MUTABLE_HV(SSPOPPTR);
752             break;
753         case SAVEt_APTR:                        /* AV* reference */
754             ptr = SSPOPPTR;
755             *(AV**)ptr = MUTABLE_AV(SSPOPPTR);
756             break;
757         case SAVEt_GP:                          /* scalar reference */
758             ptr = SSPOPPTR;
759             gv = MUTABLE_GV(SSPOPPTR);
760             gp_free(gv);
761             GvGP(gv) = (GP*)ptr;
762             /* putting a method back into circulation ("local")*/
763             if (GvCVu(gv) && (hv=GvSTASH(gv)) && HvNAME_get(hv))
764                 mro_method_changed_in(hv);
765             SvREFCNT_dec(gv);
766             break;
767         case SAVEt_FREESV:
768             ptr = SSPOPPTR;
769             SvREFCNT_dec(MUTABLE_SV(ptr));
770             break;
771         case SAVEt_MORTALIZESV:
772             ptr = SSPOPPTR;
773             sv_2mortal(MUTABLE_SV(ptr));
774             break;
775         case SAVEt_FREEOP:
776             ptr = SSPOPPTR;
777             ASSERT_CURPAD_LEGAL("SAVEt_FREEOP"); /* XXX DAPM tmp */
778             op_free((OP*)ptr);
779             break;
780         case SAVEt_FREEPV:
781             ptr = SSPOPPTR;
782             Safefree(ptr);
783             break;
784         case SAVEt_CLEARSV:
785             ptr = (void*)&PL_curpad[SSPOPLONG];
786             sv = *(SV**)ptr;
787
788             DEBUG_Xv(PerlIO_printf(Perl_debug_log,
789              "Pad 0x%"UVxf"[0x%"UVxf"] clearsv: %ld sv=0x%"UVxf"<%"IVdf"> %s\n",
790                 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
791                 (long)((SV **)ptr-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
792                 (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
793             ));
794
795             /* Can clear pad variable in place? */
796             if (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) {
797                 /*
798                  * if a my variable that was made readonly is going out of
799                  * scope, we want to remove the readonlyness so that it can
800                  * go out of scope quietly
801                  */
802                 if (SvPADMY(sv) && !SvFAKE(sv))
803                     SvREADONLY_off(sv);
804
805                 if (SvTHINKFIRST(sv))
806                     sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF);
807                 if (SvMAGICAL(sv))
808                     mg_free(sv);
809
810                 switch (SvTYPE(sv)) {
811                 case SVt_NULL:
812                     break;
813                 case SVt_PVAV:
814                     av_clear(MUTABLE_AV(sv));
815                     break;
816                 case SVt_PVHV:
817                     hv_clear(MUTABLE_HV(sv));
818                     break;
819                 case SVt_PVCV:
820                     Perl_croak(aTHX_ "panic: leave_scope pad code");
821                 default:
822                     SvOK_off(sv);
823                     break;
824                 }
825                 SvPADSTALE_on(sv); /* mark as no longer live */
826             }
827             else {      /* Someone has a claim on this, so abandon it. */
828                 const U32 padflags = SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP);
829                 switch (SvTYPE(sv)) {   /* Console ourselves with a new value */
830                 case SVt_PVAV:  *(SV**)ptr = MUTABLE_SV(newAV());       break;
831                 case SVt_PVHV:  *(SV**)ptr = MUTABLE_SV(newHV());       break;
832                 default:        *(SV**)ptr = newSV(0);          break;
833                 }
834                 SvREFCNT_dec(sv);       /* Cast current value to the winds. */
835                 /* preserve pad nature, but also mark as not live
836                  * for any closure capturing */
837                 SvFLAGS(*(SV**)ptr) |= padflags | SVs_PADSTALE;
838             }
839             break;
840         case SAVEt_DELETE:
841             ptr = SSPOPPTR;
842             hv = MUTABLE_HV(ptr);
843             ptr = SSPOPPTR;
844             (void)hv_delete(hv, (char*)ptr, (I32)SSPOPINT, G_DISCARD);
845             SvREFCNT_dec(hv);
846             Safefree(ptr);
847             break;
848         case SAVEt_DESTRUCTOR_X:
849             ptr = SSPOPPTR;
850             (*SSPOPDXPTR)(aTHX_ ptr);
851             break;
852         case SAVEt_REGCONTEXT:
853         case SAVEt_ALLOC:
854             i = SSPOPINT;
855             PL_savestack_ix -= i;       /* regexp must have croaked */
856             break;
857         case SAVEt_STACK_POS:           /* Position on Perl stack */
858             i = SSPOPINT;
859             PL_stack_sp = PL_stack_base + i;
860             break;
861         case SAVEt_STACK_CXPOS:         /* blk_oldsp on context stack */
862             i = SSPOPINT;
863             cxstack[i].blk_oldsp = SSPOPINT;
864             break;
865         case SAVEt_AELEM:               /* array element */
866             value = MUTABLE_SV(SSPOPPTR);
867             i = SSPOPINT;
868             av = MUTABLE_AV(SSPOPPTR);
869             ptr = av_fetch(av,i,1);
870             if (!AvREAL(av) && AvREIFY(av)) /* undo reify guard */
871                 SvREFCNT_dec(value);
872             if (ptr) {
873                 sv = *(SV**)ptr;
874                 if (sv && sv != &PL_sv_undef) {
875                     if (SvTIED_mg((const SV *)av, PERL_MAGIC_tied))
876                         SvREFCNT_inc_void_NN(sv);
877                     goto restore_sv;
878                 }
879             }
880             SvREFCNT_dec(av);
881             SvREFCNT_dec(value);
882             break;
883         case SAVEt_HELEM:               /* hash element */
884             value = MUTABLE_SV(SSPOPPTR);
885             sv = MUTABLE_SV(SSPOPPTR);
886             hv = MUTABLE_HV(SSPOPPTR);
887             ptr = hv_fetch_ent(hv, sv, 1, 0);
888             SvREFCNT_dec(sv);
889             if (ptr) {
890                 const SV * const oval = HeVAL((HE*)ptr);
891                 if (oval && oval != &PL_sv_undef) {
892                     ptr = &HeVAL((HE*)ptr);
893                     if (SvTIED_mg((const SV *)hv, PERL_MAGIC_tied))
894                         SvREFCNT_inc_void(*(SV**)ptr);
895                     av = MUTABLE_AV(hv); /* what to refcnt_dec */
896                     goto restore_sv;
897                 }
898             }
899             SvREFCNT_dec(hv);
900             SvREFCNT_dec(value);
901             break;
902         case SAVEt_OP:
903             PL_op = (OP*)SSPOPPTR;
904             break;
905         case SAVEt_HINTS:
906             if ((PL_hints & HINT_LOCALIZE_HH) && GvHV(PL_hintgv)) {
907                 SvREFCNT_dec(MUTABLE_SV(GvHV(PL_hintgv)));
908                 GvHV(PL_hintgv) = NULL;
909             }
910             *(I32*)&PL_hints = (I32)SSPOPINT;
911             Perl_refcounted_he_free(aTHX_ PL_compiling.cop_hints_hash);
912             PL_compiling.cop_hints_hash = (struct refcounted_he *) SSPOPPTR;
913             if (PL_hints & HINT_LOCALIZE_HH) {
914                 SvREFCNT_dec(MUTABLE_SV(GvHV(PL_hintgv)));
915                 GvHV(PL_hintgv) = MUTABLE_HV(SSPOPPTR);
916                 assert(GvHV(PL_hintgv));
917             } else if (!GvHV(PL_hintgv)) {
918                 /* Need to add a new one manually, else gv_fetchpv() can
919                    add one in this code:
920                    
921                    if (SvTYPE(gv) == SVt_PVGV) {
922                        if (add) {
923                        GvMULTI_on(gv);
924                        gv_init_sv(gv, sv_type);
925                        if (*name=='!' && sv_type == SVt_PVHV && len==1)
926                            require_errno(gv);
927                        }
928                        return gv;
929                    }
930
931                    and it won't have the magic set.  */
932
933                 HV *const hv = newHV();
934                 hv_magic(hv, NULL, PERL_MAGIC_hints);
935                 GvHV(PL_hintgv) = hv;
936             }
937             assert(GvHV(PL_hintgv));
938             break;
939         case SAVEt_COMPPAD:
940             PL_comppad = (PAD*)SSPOPPTR;
941             if (PL_comppad)
942                 PL_curpad = AvARRAY(PL_comppad);
943             else
944                 PL_curpad = NULL;
945             break;
946         case SAVEt_PADSV_AND_MORTALIZE:
947             {
948                 const PADOFFSET off = (PADOFFSET)SSPOPLONG;
949                 SV **svp;
950                 ptr = SSPOPPTR;
951                 assert (ptr);
952                 svp = AvARRAY((PAD*)ptr) + off;
953                 /* This mortalizing used to be done by POPLOOP() via itersave.
954                    But as we have all the information here, we can do it here,
955                    save even having to have itersave in the struct.  */
956                 sv_2mortal(*svp);
957                 *svp = MUTABLE_SV(SSPOPPTR);
958             }
959             break;
960         case SAVEt_SAVESWITCHSTACK:
961             {
962                 dSP;
963                 AV *const t = MUTABLE_AV(SSPOPPTR);
964                 AV *const f = MUTABLE_AV(SSPOPPTR);
965                 SWITCHSTACK(t,f);
966                 PL_curstackinfo->si_stack = f;
967             }
968             break;
969         case SAVEt_SET_SVFLAGS:
970             {
971                 const U32 val  = (U32)SSPOPINT;
972                 const U32 mask = (U32)SSPOPINT;
973                 sv = MUTABLE_SV(SSPOPPTR);
974                 SvFLAGS(sv) &= ~mask;
975                 SvFLAGS(sv) |= val;
976             }
977             break;
978
979             /* This would be a mathom, but Perl_save_svref() calls a static
980                function, S_save_scalar_at(), so has to stay in this file.  */
981         case SAVEt_SVREF:                       /* scalar reference */
982             value = MUTABLE_SV(SSPOPPTR);
983             ptr = SSPOPPTR;
984             av = NULL; /* what to refcnt_dec */
985             goto restore_sv;
986
987             /* These are only saved in mathoms.c */
988         case SAVEt_NSTAB:
989             gv = MUTABLE_GV(SSPOPPTR);
990             (void)sv_clear(MUTABLE_SV(gv));
991             break;
992         case SAVEt_LONG:                        /* long reference */
993             ptr = SSPOPPTR;
994             *(long*)ptr = (long)SSPOPLONG;
995             break;
996         case SAVEt_IV:                          /* IV reference */
997             ptr = SSPOPPTR;
998             *(IV*)ptr = (IV)SSPOPIV;
999             break;
1000
1001             /* This case is rendered redundant by the integration of change
1002                33078. See the comment near Perl_save_padsv().  */
1003         case SAVEt_PADSV:
1004             {
1005                 const PADOFFSET off = (PADOFFSET)SSPOPLONG;
1006                 ptr = SSPOPPTR;
1007                 if (ptr)
1008                     AvARRAY((PAD*)ptr)[off] = (SV*)SSPOPPTR;
1009                 else {
1010                   /* Can we ever get here?
1011                      POPs must balance PUSHes.  */
1012                     (void) SSPOPPTR;
1013                 }
1014             }
1015             break;
1016         case SAVEt_I16:                         /* I16 reference */
1017             ptr = SSPOPPTR;
1018             *(I16*)ptr = (I16)SSPOPINT;
1019             break;
1020         case SAVEt_I8:                          /* I8 reference */
1021             ptr = SSPOPPTR;
1022             *(I8*)ptr = (I8)SSPOPINT;
1023             break;
1024         case SAVEt_DESTRUCTOR:
1025             ptr = SSPOPPTR;
1026             (*SSPOPDPTR)(ptr);
1027             break;
1028         case SAVEt_COP_ARYBASE:
1029             ptr = SSPOPPTR;
1030             i = SSPOPINT;
1031             CopARYBASE_set((COP *)ptr, i);
1032             break;
1033         case SAVEt_COMPILE_WARNINGS:
1034             ptr = SSPOPPTR;
1035
1036             if (!specialWARN(PL_compiling.cop_warnings))
1037                 PerlMemShared_free(PL_compiling.cop_warnings);
1038
1039             PL_compiling.cop_warnings = (STRLEN*)ptr;
1040             break;
1041         case SAVEt_RE_STATE:
1042             {
1043                 const struct re_save_state *const state
1044                     = (struct re_save_state *)
1045                     (PL_savestack + PL_savestack_ix
1046                      - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
1047                 PL_savestack_ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
1048
1049                 if (PL_reg_start_tmp != state->re_state_reg_start_tmp) {
1050                     Safefree(PL_reg_start_tmp);
1051                 }
1052                 if (PL_reg_poscache != state->re_state_reg_poscache) {
1053                     Safefree(PL_reg_poscache);
1054                 }
1055                 Copy(state, &PL_reg_state, 1, struct re_save_state);
1056             }
1057             break;
1058         case SAVEt_PARSER:
1059             ptr = SSPOPPTR;
1060             parser_free((yy_parser *) ptr);
1061             break;
1062         default:
1063             Perl_croak(aTHX_ "panic: leave_scope inconsistency");
1064         }
1065     }
1066
1067     PL_tainted = was;
1068 }
1069
1070 void
1071 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1072 {
1073     dVAR;
1074
1075     PERL_ARGS_ASSERT_CX_DUMP;
1076
1077 #ifdef DEBUGGING
1078     PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1079     if (CxTYPE(cx) != CXt_SUBST) {
1080         PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1081         PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
1082                       PTR2UV(cx->blk_oldcop));
1083         PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1084         PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1085         PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
1086                       PTR2UV(cx->blk_oldpm));
1087         PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", cx->blk_gimme ? "LIST" : "SCALAR");
1088     }
1089     switch (CxTYPE(cx)) {
1090     case CXt_NULL:
1091     case CXt_BLOCK:
1092         break;
1093     case CXt_FORMAT:
1094         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1095                 PTR2UV(cx->blk_sub.cv));
1096         PerlIO_printf(Perl_debug_log, "BLK_SUB.GV = 0x%"UVxf"\n",
1097                 PTR2UV(cx->blk_sub.gv));
1098         PerlIO_printf(Perl_debug_log, "BLK_SUB.DFOUTGV = 0x%"UVxf"\n",
1099                 PTR2UV(cx->blk_sub.dfoutgv));
1100         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1101                       (int)CxHASARGS(cx));
1102         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1103                 PTR2UV(cx->blk_sub.retop));
1104         break;
1105     case CXt_SUB:
1106         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1107                 PTR2UV(cx->blk_sub.cv));
1108         PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1109                 (long)cx->blk_sub.olddepth);
1110         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1111                 (int)CxHASARGS(cx));
1112         PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n", (int)CxLVAL(cx));
1113         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1114                 PTR2UV(cx->blk_sub.retop));
1115         break;
1116     case CXt_EVAL:
1117         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1118                 (long)CxOLD_IN_EVAL(cx));
1119         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1120                 PL_op_name[CxOLD_OP_TYPE(cx)],
1121                 PL_op_desc[CxOLD_OP_TYPE(cx)]);
1122         if (cx->blk_eval.old_namesv)
1123             PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1124                           SvPVX_const(cx->blk_eval.old_namesv));
1125         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1126                 PTR2UV(cx->blk_eval.old_eval_root));
1127         PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%"UVxf"\n",
1128                 PTR2UV(cx->blk_eval.retop));
1129         break;
1130
1131     case CXt_LOOP:
1132         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n", CxLABEL(cx));
1133         PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
1134                 (long)cx->blk_loop.resetsp);
1135         PerlIO_printf(Perl_debug_log, "BLK_LOOP.MY_OP = 0x%"UVxf"\n",
1136                 PTR2UV(cx->blk_loop.my_op));
1137         PerlIO_printf(Perl_debug_log, "BLK_LOOP.NEXT_OP = 0x%"UVxf"\n",
1138                 PTR2UV(CX_LOOP_NEXTOP_GET(cx)));
1139         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1140                 (long)cx->blk_loop.iterix);
1141         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1142                 PTR2UV(cx->blk_loop.iterary));
1143         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1144                 PTR2UV(CxITERVAR(cx)));
1145         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERLVAL = 0x%"UVxf"\n",
1146                 PTR2UV(cx->blk_loop.iterlval));
1147         break;
1148
1149     case CXt_SUBST:
1150         PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1151                 (long)cx->sb_iters);
1152         PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1153                 (long)cx->sb_maxiters);
1154         PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1155                 (long)cx->sb_rflags);
1156         PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1157                 (long)CxONCE(cx));
1158         PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1159                 cx->sb_orig);
1160         PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1161                 PTR2UV(cx->sb_dstr));
1162         PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1163                 PTR2UV(cx->sb_targ));
1164         PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1165                 PTR2UV(cx->sb_s));
1166         PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1167                 PTR2UV(cx->sb_m));
1168         PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1169                 PTR2UV(cx->sb_strend));
1170         PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1171                 PTR2UV(cx->sb_rxres));
1172         break;
1173     }
1174 #else
1175     PERL_UNUSED_CONTEXT;
1176     PERL_UNUSED_ARG(cx);
1177 #endif  /* DEBUGGING */
1178 }
1179
1180 /* This is rendered a mathom by the integration of change 33078. However, until
1181    we have versioned mathom logic in mathoms.c, we can't move it there for
1182    5.10.1, as other code in production may have linked to it.  */
1183
1184 void
1185 Perl_save_padsv(pTHX_ PADOFFSET off)
1186 {
1187     dVAR;
1188     SSCHECK(4);
1189     ASSERT_CURPAD_ACTIVE("save_padsv");
1190     SSPUSHPTR(PL_curpad[off]);
1191     SSPUSHPTR(PL_comppad);
1192     SSPUSHLONG((long)off);
1193     SSPUSHINT(SAVEt_PADSV);
1194 }
1195
1196 /*
1197  * Local variables:
1198  * c-indentation-style: bsd
1199  * c-basic-offset: 4
1200  * indent-tabs-mode: t
1201  * End:
1202  *
1203  * ex: set ts=8 sts=4 sw=4 noet:
1204  */