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