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