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