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