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