This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
b6b876b39270389798a817d649633513e3610489
[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, 2007 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     PoisonNew(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     PoisonNew(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     if (SvTYPE(osv) >= SVt_PVMG && SvMAGIC(osv) && SvTYPE(osv) != SVt_PVGV) {
169         if (SvGMAGICAL(osv)) {
170             const bool oldtainted = PL_tainted;
171             SvFLAGS(osv) |= (SvFLAGS(osv) &
172                (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
173             PL_tainted = oldtainted;
174         }
175         mg_localize(osv, sv);
176     }
177     return sv;
178 }
179
180 SV *
181 Perl_save_scalar(pTHX_ GV *gv)
182 {
183     dVAR;
184     SV ** const sptr = &GvSVn(gv);
185 #ifdef PERL_MAD
186     if (PL_formfeed && *sptr == PL_formfeed)
187         abort();
188 #endif
189     PL_localizing = 1;
190     SvGETMAGIC(*sptr);
191     PL_localizing = 0;
192     SSCHECK(3);
193     SSPUSHPTR(SvREFCNT_inc_simple(gv));
194     SSPUSHPTR(SvREFCNT_inc(*sptr));
195     SSPUSHINT(SAVEt_SV);
196     return save_scalar_at(sptr);
197 }
198
199 /* Like save_sptr(), but also SvREFCNT_dec()s the new value.  Can be used to
200  * restore a global SV to its prior contents, freeing new value. */
201 void
202 Perl_save_generic_svref(pTHX_ SV **sptr)
203 {
204     dVAR;
205 #ifdef PERL_MAD
206     if (PL_formfeed && *sptr == PL_formfeed)
207         abort();
208 #endif
209     SSCHECK(3);
210     SSPUSHPTR(sptr);
211     SSPUSHPTR(SvREFCNT_inc(*sptr));
212     SSPUSHINT(SAVEt_GENERIC_SVREF);
213 }
214
215 /* Like save_pptr(), but also Safefree()s the new value if it is different
216  * from the old one.  Can be used to restore a global char* to its prior
217  * contents, freeing new value. */
218 void
219 Perl_save_generic_pvref(pTHX_ char **str)
220 {
221     dVAR;
222     SSCHECK(3);
223     SSPUSHPTR(*str);
224     SSPUSHPTR(str);
225     SSPUSHINT(SAVEt_GENERIC_PVREF);
226 }
227
228 /* Like save_generic_pvref(), but uses PerlMemShared_free() rather than Safefree().
229  * Can be used to restore a shared global char* to its prior
230  * contents, freeing new value. */
231 void
232 Perl_save_shared_pvref(pTHX_ char **str)
233 {
234     dVAR;
235     SSCHECK(3);
236     SSPUSHPTR(str);
237     SSPUSHPTR(*str);
238     SSPUSHINT(SAVEt_SHARED_PVREF);
239 }
240
241 /* set the SvFLAGS specified by mask to the values in val */
242
243 void
244 Perl_save_set_svflags(pTHX_ SV* sv, U32 mask, U32 val)
245 {
246     dVAR;
247     SSCHECK(4);
248     SSPUSHPTR(sv);
249     SSPUSHINT(mask);
250     SSPUSHINT(val);
251     SSPUSHINT(SAVEt_SET_SVFLAGS);
252 }
253
254 void
255 Perl_save_gp(pTHX_ GV *gv, I32 empty)
256 {
257     dVAR;
258     SSGROW(3);
259     SSPUSHPTR(SvREFCNT_inc(gv));
260     SSPUSHPTR(GvGP(gv));
261     SSPUSHINT(SAVEt_GP);
262
263     if (empty) {
264         GP *gp = Perl_newGP(aTHX_ gv);
265
266         if (GvCVu(gv))
267             PL_sub_generation++;        /* taking a method out of circulation */
268         if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
269             gp->gp_io = newIO();
270             IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
271         }
272         GvGP(gv) = gp;
273     }
274     else {
275         gp_ref(GvGP(gv));
276         GvINTRO_on(gv);
277     }
278 }
279
280 AV *
281 Perl_save_ary(pTHX_ GV *gv)
282 {
283     dVAR;
284     AV * const oav = GvAVn(gv);
285     AV *av;
286
287     if (!AvREAL(oav) && AvREIFY(oav))
288         av_reify(oav);
289     SSCHECK(3);
290     SSPUSHPTR(gv);
291     SSPUSHPTR(oav);
292     SSPUSHINT(SAVEt_AV);
293
294     GvAV(gv) = NULL;
295     av = GvAVn(gv);
296     if (SvMAGIC(oav))
297         mg_localize((SV*)oav, (SV*)av);
298     return av;
299 }
300
301 HV *
302 Perl_save_hash(pTHX_ GV *gv)
303 {
304     dVAR;
305     HV *ohv, *hv;
306
307     SSCHECK(3);
308     SSPUSHPTR(gv);
309     SSPUSHPTR(ohv = GvHVn(gv));
310     SSPUSHINT(SAVEt_HV);
311
312     GvHV(gv) = NULL;
313     hv = GvHVn(gv);
314     if (SvMAGIC(ohv))
315         mg_localize((SV*)ohv, (SV*)hv);
316     return hv;
317 }
318
319 void
320 Perl_save_item(pTHX_ register SV *item)
321 {
322     dVAR;
323     register SV * const sv = newSVsv(item);
324
325 #ifdef PERL_MAD
326     if (PL_formfeed && item == PL_formfeed)
327         abort();
328 #endif
329
330     SSCHECK(3);
331     SSPUSHPTR(item);            /* remember the pointer */
332     SSPUSHPTR(sv);              /* remember the value */
333     SSPUSHINT(SAVEt_ITEM);
334 }
335
336 void
337 Perl_save_int(pTHX_ int *intp)
338 {
339     dVAR;
340     SSCHECK(3);
341     SSPUSHINT(*intp);
342     SSPUSHPTR(intp);
343     SSPUSHINT(SAVEt_INT);
344 }
345
346 void
347 Perl_save_bool(pTHX_ bool *boolp)
348 {
349     dVAR;
350     SSCHECK(3);
351     SSPUSHBOOL(*boolp);
352     SSPUSHPTR(boolp);
353     SSPUSHINT(SAVEt_BOOL);
354 }
355
356 void
357 Perl_save_I8(pTHX_ I8 *bytep)
358 {
359     dVAR;
360     SSCHECK(3);
361     SSPUSHINT(*bytep);
362     SSPUSHPTR(bytep);
363     SSPUSHINT(SAVEt_I8);
364 }
365
366 void
367 Perl_save_I32(pTHX_ I32 *intp)
368 {
369     dVAR;
370     SSCHECK(3);
371     SSPUSHINT(*intp);
372     SSPUSHPTR(intp);
373     SSPUSHINT(SAVEt_I32);
374 }
375
376 /* Cannot use save_sptr() to store a char* since the SV** cast will
377  * force word-alignment and we'll miss the pointer.
378  */
379 void
380 Perl_save_pptr(pTHX_ char **pptr)
381 {
382     dVAR;
383     SSCHECK(3);
384     SSPUSHPTR(*pptr);
385     SSPUSHPTR(pptr);
386     SSPUSHINT(SAVEt_PPTR);
387 }
388
389 void
390 Perl_save_vptr(pTHX_ void *ptr)
391 {
392     dVAR;
393     SSCHECK(3);
394     SSPUSHPTR(*(char**)ptr);
395     SSPUSHPTR(ptr);
396     SSPUSHINT(SAVEt_VPTR);
397 }
398
399 void
400 Perl_save_sptr(pTHX_ SV **sptr)
401 {
402     dVAR;
403     SSCHECK(3);
404     SSPUSHPTR(*sptr);
405     SSPUSHPTR(sptr);
406     SSPUSHINT(SAVEt_SPTR);
407 }
408
409 void
410 Perl_save_padsv(pTHX_ PADOFFSET off)
411 {
412     dVAR;
413     SSCHECK(4);
414     ASSERT_CURPAD_ACTIVE("save_padsv");
415     SSPUSHPTR(PL_curpad[off]);
416     SSPUSHPTR(PL_comppad);
417     SSPUSHLONG((long)off);
418     SSPUSHINT(SAVEt_PADSV);
419 }
420
421 void
422 Perl_save_hptr(pTHX_ HV **hptr)
423 {
424     dVAR;
425     SSCHECK(3);
426     SSPUSHPTR(*hptr);
427     SSPUSHPTR(hptr);
428     SSPUSHINT(SAVEt_HPTR);
429 }
430
431 void
432 Perl_save_aptr(pTHX_ AV **aptr)
433 {
434     dVAR;
435     SSCHECK(3);
436     SSPUSHPTR(*aptr);
437     SSPUSHPTR(aptr);
438     SSPUSHINT(SAVEt_APTR);
439 }
440
441 void
442 Perl_save_freesv(pTHX_ SV *sv)
443 {
444     dVAR;
445     SSCHECK(2);
446     SSPUSHPTR(sv);
447     SSPUSHINT(SAVEt_FREESV);
448 }
449
450 void
451 Perl_save_mortalizesv(pTHX_ SV *sv)
452 {
453     dVAR;
454     SSCHECK(2);
455     SSPUSHPTR(sv);
456     SSPUSHINT(SAVEt_MORTALIZESV);
457 }
458
459 void
460 Perl_save_freeop(pTHX_ OP *o)
461 {
462     dVAR;
463     SSCHECK(2);
464     SSPUSHPTR(o);
465     SSPUSHINT(SAVEt_FREEOP);
466 }
467
468 void
469 Perl_save_freepv(pTHX_ char *pv)
470 {
471     dVAR;
472     SSCHECK(2);
473     SSPUSHPTR(pv);
474     SSPUSHINT(SAVEt_FREEPV);
475 }
476
477 void
478 Perl_save_clearsv(pTHX_ SV **svp)
479 {
480     dVAR;
481     ASSERT_CURPAD_ACTIVE("save_clearsv");
482     SSCHECK(2);
483     SSPUSHLONG((long)(svp-PL_curpad));
484     SSPUSHINT(SAVEt_CLEARSV);
485     SvPADSTALE_off(*svp); /* mark lexical as active */
486 }
487
488 void
489 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
490 {
491     dVAR;
492     SSCHECK(4);
493     SSPUSHINT(klen);
494     SSPUSHPTR(key);
495     SSPUSHPTR(SvREFCNT_inc_simple(hv));
496     SSPUSHINT(SAVEt_DELETE);
497 }
498
499 void
500 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
501 {
502     dVAR;
503     SSCHECK(3);
504     SSPUSHDPTR(f);
505     SSPUSHPTR(p);
506     SSPUSHINT(SAVEt_DESTRUCTOR);
507 }
508
509 void
510 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
511 {
512     dVAR;
513     SSCHECK(3);
514     SSPUSHDXPTR(f);
515     SSPUSHPTR(p);
516     SSPUSHINT(SAVEt_DESTRUCTOR_X);
517 }
518
519 void
520 Perl_save_aelem(pTHX_ AV *av, I32 idx, SV **sptr)
521 {
522     dVAR;
523     SV *sv;
524     SvGETMAGIC(*sptr);
525     SSCHECK(4);
526     SSPUSHPTR(SvREFCNT_inc_simple(av));
527     SSPUSHINT(idx);
528     SSPUSHPTR(SvREFCNT_inc(*sptr));
529     SSPUSHINT(SAVEt_AELEM);
530     /* if it gets reified later, the restore will have the wrong refcnt */
531     if (!AvREAL(av) && AvREIFY(av))
532         SvREFCNT_inc_void(*sptr);
533     save_scalar_at(sptr);
534     sv = *sptr;
535     /* If we're localizing a tied array element, this new sv
536      * won't actually be stored in the array - so it won't get
537      * reaped when the localize ends. Ensure it gets reaped by
538      * mortifying it instead. DAPM */
539     if (SvTIED_mg(sv, PERL_MAGIC_tiedelem))
540         sv_2mortal(sv);
541 }
542
543 void
544 Perl_save_helem(pTHX_ HV *hv, SV *key, SV **sptr)
545 {
546     dVAR;
547     SV *sv;
548     SvGETMAGIC(*sptr);
549     SSCHECK(4);
550     SSPUSHPTR(SvREFCNT_inc_simple(hv));
551     SSPUSHPTR(SvREFCNT_inc_simple(key));
552     SSPUSHPTR(SvREFCNT_inc(*sptr));
553     SSPUSHINT(SAVEt_HELEM);
554     save_scalar_at(sptr);
555     sv = *sptr;
556     /* If we're localizing a tied hash element, this new sv
557      * won't actually be stored in the hash - so it won't get
558      * reaped when the localize ends. Ensure it gets reaped by
559      * mortifying it instead. DAPM */
560     if (SvTIED_mg(sv, PERL_MAGIC_tiedelem))
561         sv_2mortal(sv);
562 }
563
564 SV*
565 Perl_save_svref(pTHX_ SV **sptr)
566 {
567     dVAR;
568 #ifdef PERL_MAD
569     if (PL_formfeed && *sptr == PL_formfeed)
570         abort();
571 #endif
572     SvGETMAGIC(*sptr);
573     SSCHECK(3);
574     SSPUSHPTR(sptr);
575     SSPUSHPTR(SvREFCNT_inc(*sptr));
576     SSPUSHINT(SAVEt_SVREF);
577     return save_scalar_at(sptr);
578 }
579
580 void
581 Perl_save_op(pTHX)
582 {
583     dVAR;
584     SSCHECK(2);
585     SSPUSHPTR(PL_op);
586     SSPUSHINT(SAVEt_OP);
587 }
588
589 I32
590 Perl_save_alloc(pTHX_ I32 size, I32 pad)
591 {
592     dVAR;
593     register const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
594                                 - (char*)PL_savestack);
595     register const I32 elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
596
597     SSGROW(elems + 2);
598
599     PL_savestack_ix += elems;
600     SSPUSHINT(elems);
601     SSPUSHINT(SAVEt_ALLOC);
602     return start;
603 }
604
605 void
606 Perl_leave_scope(pTHX_ I32 base)
607 {
608     dVAR;
609     register SV *sv;
610     register SV *value;
611     register GV *gv;
612     register AV *av;
613     register HV *hv;
614     void* ptr;
615     register char* str;
616     I32 i;
617
618     if (base < -1)
619         Perl_croak(aTHX_ "panic: corrupt saved stack index");
620     while (PL_savestack_ix > base) {
621         switch (SSPOPINT) {
622         case SAVEt_ITEM:                        /* normal string */
623             value = (SV*)SSPOPPTR;
624             sv = (SV*)SSPOPPTR;
625             sv_replace(sv,value);
626             PL_localizing = 2;
627             SvSETMAGIC(sv);
628             PL_localizing = 0;
629             break;
630         case SAVEt_SV:                          /* scalar reference */
631             value = (SV*)SSPOPPTR;
632             gv = (GV*)SSPOPPTR;
633             ptr = &GvSV(gv);
634             av = (AV*)gv; /* what to refcnt_dec */
635         restore_sv:
636             sv = *(SV**)ptr;
637             DEBUG_S(PerlIO_printf(Perl_debug_log,
638                                   "restore svref: %p %p:%s -> %p:%s\n",
639                                   (void*)ptr, (void*)sv, SvPEEK(sv),
640                                   (void*)value, SvPEEK(value)));
641             *(SV**)ptr = value;
642             SvREFCNT_dec(sv);
643             PL_localizing = 2;
644             SvSETMAGIC(value);
645             PL_localizing = 0;
646             SvREFCNT_dec(value);
647             if (av) /* actually an av, hv or gv */
648                 SvREFCNT_dec(av);
649             break;
650         case SAVEt_GENERIC_PVREF:               /* generic pv */
651             ptr = SSPOPPTR;
652             str = (char*)SSPOPPTR;
653             if (*(char**)ptr != str) {
654                 Safefree(*(char**)ptr);
655                 *(char**)ptr = str;
656             }
657             break;
658         case SAVEt_SHARED_PVREF:                /* shared pv */
659             str = (char*)SSPOPPTR;
660             ptr = SSPOPPTR;
661             if (*(char**)ptr != str) {
662 #ifdef NETWARE
663                 PerlMem_free(*(char**)ptr);
664 #else
665                 PerlMemShared_free(*(char**)ptr);
666 #endif
667                 *(char**)ptr = str;
668             }
669             break;
670         case SAVEt_GENERIC_SVREF:               /* generic sv */
671             value = (SV*)SSPOPPTR;
672             ptr = SSPOPPTR;
673             sv = *(SV**)ptr;
674             *(SV**)ptr = value;
675             SvREFCNT_dec(sv);
676             SvREFCNT_dec(value);
677             break;
678         case SAVEt_AV:                          /* array reference */
679             av = (AV*)SSPOPPTR;
680             gv = (GV*)SSPOPPTR;
681             if (GvAV(gv)) {
682                 AV * const goner = GvAV(gv);
683                 /* FIXME - this is a temporary hack until we work out what
684                    the correct behaviour for magic should be.  */
685                 sv_unmagic((SV*)goner, PERL_MAGIC_arylen_p);
686                 SvMAGIC_set(av, SvMAGIC(goner));
687                 SvFLAGS((SV*)av) |= SvMAGICAL(goner);
688                 SvMAGICAL_off(goner);
689                 SvMAGIC_set(goner, NULL);
690                 SvREFCNT_dec(goner);
691             }
692             GvAV(gv) = av;
693             if (SvMAGICAL(av)) {
694                 PL_localizing = 2;
695                 SvSETMAGIC((SV*)av);
696                 PL_localizing = 0;
697             }
698             break;
699         case SAVEt_HV:                          /* hash reference */
700             hv = (HV*)SSPOPPTR;
701             gv = (GV*)SSPOPPTR;
702             if (GvHV(gv)) {
703                 HV * const goner = GvHV(gv);
704                 SvMAGIC_set(hv, SvMAGIC(goner));
705                 SvFLAGS(hv) |= SvMAGICAL(goner);
706                 SvMAGICAL_off(goner);
707                 SvMAGIC_set(goner, NULL);
708                 SvREFCNT_dec(goner);
709             }
710             GvHV(gv) = hv;
711             if (SvMAGICAL(hv)) {
712                 PL_localizing = 2;
713                 SvSETMAGIC((SV*)hv);
714                 PL_localizing = 0;
715             }
716             break;
717         case SAVEt_INT:                         /* int reference */
718             ptr = SSPOPPTR;
719             *(int*)ptr = (int)SSPOPINT;
720             break;
721         case SAVEt_BOOL:                        /* bool reference */
722             ptr = SSPOPPTR;
723             *(bool*)ptr = (bool)SSPOPBOOL;
724             break;
725         case SAVEt_I32:                         /* I32 reference */
726             ptr = SSPOPPTR;
727             *(I32*)ptr = (I32)SSPOPINT;
728             break;
729         case SAVEt_SPTR:                        /* SV* reference */
730             ptr = SSPOPPTR;
731             *(SV**)ptr = (SV*)SSPOPPTR;
732             break;
733         case SAVEt_VPTR:                        /* random* reference */
734         case SAVEt_PPTR:                        /* char* reference */
735             ptr = SSPOPPTR;
736             *(char**)ptr = (char*)SSPOPPTR;
737             break;
738         case SAVEt_HPTR:                        /* HV* reference */
739             ptr = SSPOPPTR;
740             *(HV**)ptr = (HV*)SSPOPPTR;
741             break;
742         case SAVEt_APTR:                        /* AV* reference */
743             ptr = SSPOPPTR;
744             *(AV**)ptr = (AV*)SSPOPPTR;
745             break;
746         case SAVEt_GP:                          /* scalar reference */
747             ptr = SSPOPPTR;
748             gv = (GV*)SSPOPPTR;
749             gp_free(gv);
750             GvGP(gv) = (GP*)ptr;
751             if (GvCVu(gv))
752                 PL_sub_generation++;  /* putting a method back into circulation */
753             SvREFCNT_dec(gv);
754             break;
755         case SAVEt_FREESV:
756             ptr = SSPOPPTR;
757             SvREFCNT_dec((SV*)ptr);
758             break;
759         case SAVEt_MORTALIZESV:
760             ptr = SSPOPPTR;
761             sv_2mortal((SV*)ptr);
762             break;
763         case SAVEt_FREEOP:
764             ptr = SSPOPPTR;
765             ASSERT_CURPAD_LEGAL("SAVEt_FREEOP"); /* XXX DAPM tmp */
766             op_free((OP*)ptr);
767             break;
768         case SAVEt_FREEPV:
769             ptr = SSPOPPTR;
770             Safefree(ptr);
771             break;
772         case SAVEt_CLEARSV:
773             ptr = (void*)&PL_curpad[SSPOPLONG];
774             sv = *(SV**)ptr;
775
776             DEBUG_Xv(PerlIO_printf(Perl_debug_log,
777              "Pad 0x%"UVxf"[0x%"UVxf"] clearsv: %ld sv=0x%"UVxf"<%"IVdf"> %s\n",
778                 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
779                 (long)((SV **)ptr-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
780                 (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
781             ));
782
783             /* Can clear pad variable in place? */
784             if (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) {
785                 /*
786                  * if a my variable that was made readonly is going out of
787                  * scope, we want to remove the readonlyness so that it can
788                  * go out of scope quietly
789                  */
790                 if (SvPADMY(sv) && !SvFAKE(sv))
791                     SvREADONLY_off(sv);
792
793                 if (SvTHINKFIRST(sv))
794                     sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF);
795                 if (SvMAGICAL(sv))
796                     mg_free(sv);
797
798                 switch (SvTYPE(sv)) {
799                 case SVt_NULL:
800                     break;
801                 case SVt_PVAV:
802                     av_clear((AV*)sv);
803                     break;
804                 case SVt_PVHV:
805                     hv_clear((HV*)sv);
806                     break;
807                 case SVt_PVCV:
808                     Perl_croak(aTHX_ "panic: leave_scope pad code");
809                 default:
810                     SvOK_off(sv);
811                     break;
812                 }
813                 SvPADSTALE_on(sv); /* mark as no longer live */
814             }
815             else {      /* Someone has a claim on this, so abandon it. */
816                 const U32 padflags = SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP);
817                 switch (SvTYPE(sv)) {   /* Console ourselves with a new value */
818                 case SVt_PVAV:  *(SV**)ptr = (SV*)newAV();      break;
819                 case SVt_PVHV:  *(SV**)ptr = (SV*)newHV();      break;
820                 default:        *(SV**)ptr = newSV(0);          break;
821                 }
822                 SvREFCNT_dec(sv);       /* Cast current value to the winds. */
823                 /* preserve pad nature, but also mark as not live
824                  * for any closure capturing */
825                 SvFLAGS(*(SV**)ptr) |= padflags | SVs_PADSTALE;
826             }
827             break;
828         case SAVEt_DELETE:
829             ptr = SSPOPPTR;
830             hv = (HV*)ptr;
831             ptr = SSPOPPTR;
832             (void)hv_delete(hv, (char*)ptr, (I32)SSPOPINT, G_DISCARD);
833             SvREFCNT_dec(hv);
834             Safefree(ptr);
835             break;
836         case SAVEt_DESTRUCTOR_X:
837             ptr = SSPOPPTR;
838             (*SSPOPDXPTR)(aTHX_ ptr);
839             break;
840         case SAVEt_REGCONTEXT:
841         case SAVEt_ALLOC:
842             i = SSPOPINT;
843             PL_savestack_ix -= i;       /* regexp must have croaked */
844             break;
845         case SAVEt_STACK_POS:           /* Position on Perl stack */
846             i = SSPOPINT;
847             PL_stack_sp = PL_stack_base + i;
848             break;
849         case SAVEt_STACK_CXPOS:         /* blk_oldsp on context stack */
850             i = SSPOPINT;
851             cxstack[i].blk_oldsp = SSPOPINT;
852             break;
853         case SAVEt_AELEM:               /* array element */
854             value = (SV*)SSPOPPTR;
855             i = SSPOPINT;
856             av = (AV*)SSPOPPTR;
857             ptr = av_fetch(av,i,1);
858             if (!AvREAL(av) && AvREIFY(av)) /* undo reify guard */
859                 SvREFCNT_dec(value);
860             if (ptr) {
861                 sv = *(SV**)ptr;
862                 if (sv && sv != &PL_sv_undef) {
863                     if (SvTIED_mg((SV*)av, PERL_MAGIC_tied))
864                         SvREFCNT_inc_void_NN(sv);
865                     goto restore_sv;
866                 }
867             }
868             SvREFCNT_dec(av);
869             SvREFCNT_dec(value);
870             break;
871         case SAVEt_HELEM:               /* hash element */
872             value = (SV*)SSPOPPTR;
873             sv = (SV*)SSPOPPTR;
874             hv = (HV*)SSPOPPTR;
875             ptr = hv_fetch_ent(hv, sv, 1, 0);
876             if (ptr) {
877                 const SV * const oval = HeVAL((HE*)ptr);
878                 if (oval && oval != &PL_sv_undef) {
879                     ptr = &HeVAL((HE*)ptr);
880                     if (SvTIED_mg((SV*)hv, PERL_MAGIC_tied))
881                         SvREFCNT_inc_void(*(SV**)ptr);
882                     SvREFCNT_dec(sv);
883                     av = (AV*)hv; /* what to refcnt_dec */
884                     goto restore_sv;
885                 }
886             }
887             SvREFCNT_dec(hv);
888             SvREFCNT_dec(sv);
889             SvREFCNT_dec(value);
890             break;
891         case SAVEt_OP:
892             PL_op = (OP*)SSPOPPTR;
893             break;
894         case SAVEt_HINTS:
895             if ((PL_hints & HINT_LOCALIZE_HH) && GvHV(PL_hintgv)) {
896                 SvREFCNT_dec((SV*)GvHV(PL_hintgv));
897                 GvHV(PL_hintgv) = NULL;
898             }
899             *(I32*)&PL_hints = (I32)SSPOPINT;
900             Perl_refcounted_he_free(aTHX_ PL_compiling.cop_hints_hash);
901             PL_compiling.cop_hints_hash = (struct refcounted_he *) SSPOPPTR;
902             if (PL_hints & HINT_LOCALIZE_HH) {
903                 SvREFCNT_dec((SV*)GvHV(PL_hintgv));
904                 GvHV(PL_hintgv) = (HV*)SSPOPPTR;
905                 assert(GvHV(PL_hintgv));
906             } else if (!GvHV(PL_hintgv)) {
907                 /* Need to add a new one manually, else gv_fetchpv() can
908                    add one in this code:
909                    
910                    if (SvTYPE(gv) == SVt_PVGV) {
911                        if (add) {
912                        GvMULTI_on(gv);
913                        gv_init_sv(gv, sv_type);
914                        if (*name=='!' && sv_type == SVt_PVHV && len==1)
915                            require_errno(gv);
916                        }
917                        return gv;
918                    }
919
920                    and it won't have the magic set.  */
921
922                 HV *const hv = newHV();
923                 hv_magic(hv, NULL, PERL_MAGIC_hints);
924                 GvHV(PL_hintgv) = hv;
925             }
926             assert(GvHV(PL_hintgv));
927             break;
928         case SAVEt_COMPPAD:
929             PL_comppad = (PAD*)SSPOPPTR;
930             if (PL_comppad)
931                 PL_curpad = AvARRAY(PL_comppad);
932             else
933                 PL_curpad = NULL;
934             break;
935         case SAVEt_PADSV:
936             {
937                 const PADOFFSET off = (PADOFFSET)SSPOPLONG;
938                 ptr = SSPOPPTR;
939                 if (ptr)
940                     AvARRAY((PAD*)ptr)[off] = (SV*)SSPOPPTR;
941             }
942             break;
943         case SAVEt_SAVESWITCHSTACK:
944             {
945                 dSP;
946                 AV* const t = (AV*)SSPOPPTR;
947                 AV* const f = (AV*)SSPOPPTR;
948                 SWITCHSTACK(t,f);
949                 PL_curstackinfo->si_stack = f;
950             }
951             break;
952         case SAVEt_SET_SVFLAGS:
953             {
954                 const U32 val  = (U32)SSPOPINT;
955                 const U32 mask = (U32)SSPOPINT;
956                 sv = (SV*)SSPOPPTR;
957                 SvFLAGS(sv) &= ~mask;
958                 SvFLAGS(sv) |= val;
959             }
960             break;
961             /* These are only saved in mathoms.c */
962         case SAVEt_SVREF:                       /* scalar reference */
963             value = (SV*)SSPOPPTR;
964             ptr = SSPOPPTR;
965             av = NULL; /* what to refcnt_dec */
966             goto restore_sv;
967         case SAVEt_LONG:                        /* long reference */
968             ptr = SSPOPPTR;
969             *(long*)ptr = (long)SSPOPLONG;
970             break;
971         case SAVEt_I16:                         /* I16 reference */
972             ptr = SSPOPPTR;
973             *(I16*)ptr = (I16)SSPOPINT;
974             break;
975         case SAVEt_I8:                          /* I8 reference */
976             ptr = SSPOPPTR;
977             *(I8*)ptr = (I8)SSPOPINT;
978             break;
979         case SAVEt_IV:                          /* IV reference */
980             ptr = SSPOPPTR;
981             *(IV*)ptr = (IV)SSPOPIV;
982             break;
983         case SAVEt_NSTAB:
984             gv = (GV*)SSPOPPTR;
985             (void)sv_clear((SV*)gv);
986             break;
987         case SAVEt_DESTRUCTOR:
988             ptr = SSPOPPTR;
989             (*SSPOPDPTR)(ptr);
990             break;
991         case SAVEt_COP_ARYBASE:
992             ptr = SSPOPPTR;
993             i = SSPOPINT;
994             CopARYBASE_set((COP *)ptr, i);
995             break;
996         case SAVEt_COMPILE_WARNINGS:
997             ptr = SSPOPPTR;
998
999             if (!specialWARN(PL_compiling.cop_warnings))
1000                 PerlMemShared_free(PL_compiling.cop_warnings);
1001
1002             PL_compiling.cop_warnings = (STRLEN*)ptr;
1003             break;
1004         case SAVEt_RE_STATE:
1005             {
1006                 const struct re_save_state *const state
1007                     = (struct re_save_state *)
1008                     (PL_savestack + PL_savestack_ix
1009                      - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
1010                 PL_savestack_ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
1011
1012                 if (PL_reg_start_tmp != state->re_state_reg_start_tmp) {
1013                     Safefree(PL_reg_start_tmp);
1014                 }
1015                 if (PL_reg_poscache != state->re_state_reg_poscache) {
1016                     Safefree(PL_reg_poscache);
1017                 }
1018                 Copy(state, &PL_reg_state, 1, struct re_save_state);
1019             }
1020             break;
1021         case SAVEt_PARSER:
1022             ptr = SSPOPPTR;
1023             parser_free((yy_parser *) ptr);
1024             break;
1025         default:
1026             Perl_croak(aTHX_ "panic: leave_scope inconsistency");
1027         }
1028     }
1029 }
1030
1031 void
1032 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1033 {
1034     dVAR;
1035 #ifdef DEBUGGING
1036     PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1037     if (CxTYPE(cx) != CXt_SUBST) {
1038         PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1039         PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
1040                       PTR2UV(cx->blk_oldcop));
1041         PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1042         PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1043         PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
1044                       PTR2UV(cx->blk_oldpm));
1045         PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", cx->blk_gimme ? "LIST" : "SCALAR");
1046     }
1047     switch (CxTYPE(cx)) {
1048     case CXt_NULL:
1049     case CXt_BLOCK:
1050         break;
1051     case CXt_FORMAT:
1052         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1053                 PTR2UV(cx->blk_sub.cv));
1054         PerlIO_printf(Perl_debug_log, "BLK_SUB.GV = 0x%"UVxf"\n",
1055                 PTR2UV(cx->blk_sub.gv));
1056         PerlIO_printf(Perl_debug_log, "BLK_SUB.DFOUTGV = 0x%"UVxf"\n",
1057                 PTR2UV(cx->blk_sub.dfoutgv));
1058         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1059                 (int)cx->blk_sub.hasargs);
1060         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1061                 PTR2UV(cx->blk_sub.retop));
1062         break;
1063     case CXt_SUB:
1064         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1065                 PTR2UV(cx->blk_sub.cv));
1066         PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1067                 (long)cx->blk_sub.olddepth);
1068         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1069                 (int)cx->blk_sub.hasargs);
1070         PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n",
1071                 (int)cx->blk_sub.lval);
1072         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1073                 PTR2UV(cx->blk_sub.retop));
1074         break;
1075     case CXt_EVAL:
1076         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1077                 (long)cx->blk_eval.old_in_eval);
1078         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1079                 PL_op_name[cx->blk_eval.old_op_type],
1080                 PL_op_desc[cx->blk_eval.old_op_type]);
1081         if (cx->blk_eval.old_namesv)
1082             PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1083                           SvPVX_const(cx->blk_eval.old_namesv));
1084         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1085                 PTR2UV(cx->blk_eval.old_eval_root));
1086         PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%"UVxf"\n",
1087                 PTR2UV(cx->blk_eval.retop));
1088         break;
1089
1090     case CXt_LOOP:
1091         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n",
1092                 cx->blk_loop.label);
1093         PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
1094                 (long)cx->blk_loop.resetsp);
1095         PerlIO_printf(Perl_debug_log, "BLK_LOOP.MY_OP = 0x%"UVxf"\n",
1096                 PTR2UV(cx->blk_loop.my_op));
1097         PerlIO_printf(Perl_debug_log, "BLK_LOOP.NEXT_OP = 0x%"UVxf"\n",
1098                 PTR2UV(CX_LOOP_NEXTOP_GET(cx)));
1099         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1100                 (long)cx->blk_loop.iterix);
1101         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1102                 PTR2UV(cx->blk_loop.iterary));
1103         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1104                 PTR2UV(CxITERVAR(cx)));
1105         if (CxITERVAR(cx))
1106             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERSAVE = 0x%"UVxf"\n",
1107                 PTR2UV(cx->blk_loop.itersave));
1108         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERLVAL = 0x%"UVxf"\n",
1109                 PTR2UV(cx->blk_loop.iterlval));
1110         break;
1111
1112     case CXt_SUBST:
1113         PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1114                 (long)cx->sb_iters);
1115         PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1116                 (long)cx->sb_maxiters);
1117         PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1118                 (long)cx->sb_rflags);
1119         PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1120                 (long)cx->sb_once);
1121         PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1122                 cx->sb_orig);
1123         PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1124                 PTR2UV(cx->sb_dstr));
1125         PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1126                 PTR2UV(cx->sb_targ));
1127         PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1128                 PTR2UV(cx->sb_s));
1129         PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1130                 PTR2UV(cx->sb_m));
1131         PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1132                 PTR2UV(cx->sb_strend));
1133         PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1134                 PTR2UV(cx->sb_rxres));
1135         break;
1136     }
1137 #else
1138     PERL_UNUSED_CONTEXT;
1139     PERL_UNUSED_ARG(cx);
1140 #endif  /* DEBUGGING */
1141 }
1142
1143 /*
1144  * Local variables:
1145  * c-indentation-style: bsd
1146  * c-basic-offset: 4
1147  * indent-tabs-mode: t
1148  * End:
1149  *
1150  * ex: set ts=8 sts=4 sw=4 noet:
1151  */