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