This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
FAQ sync
[perl5.git] / scope.c
1 /*    scope.c
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 2004, 2005, 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     I32 oldsave = PL_scopestack[--PL_scopestack_ix];
94     LEAVE_SCOPE(oldsave);
95 }
96
97 void
98 Perl_markstack_grow(pTHX)
99 {
100     I32 oldmax = PL_markstack_max - PL_markstack;
101     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     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             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     return 0;
470 }
471
472 void
473 Perl_save_nogv(pTHX_ GV *gv)
474 {
475     SSCHECK(2);
476     SSPUSHPTR(gv);
477     SSPUSHINT(SAVEt_NSTAB);
478 }
479
480 void
481 Perl_save_hptr(pTHX_ HV **hptr)
482 {
483     SSCHECK(3);
484     SSPUSHPTR(*hptr);
485     SSPUSHPTR(hptr);
486     SSPUSHINT(SAVEt_HPTR);
487 }
488
489 void
490 Perl_save_aptr(pTHX_ AV **aptr)
491 {
492     SSCHECK(3);
493     SSPUSHPTR(*aptr);
494     SSPUSHPTR(aptr);
495     SSPUSHINT(SAVEt_APTR);
496 }
497
498 void
499 Perl_save_freesv(pTHX_ SV *sv)
500 {
501     SSCHECK(2);
502     SSPUSHPTR(sv);
503     SSPUSHINT(SAVEt_FREESV);
504 }
505
506 void
507 Perl_save_mortalizesv(pTHX_ SV *sv)
508 {
509     SSCHECK(2);
510     SSPUSHPTR(sv);
511     SSPUSHINT(SAVEt_MORTALIZESV);
512 }
513
514 void
515 Perl_save_freeop(pTHX_ OP *o)
516 {
517     SSCHECK(2);
518     SSPUSHPTR(o);
519     SSPUSHINT(SAVEt_FREEOP);
520 }
521
522 void
523 Perl_save_freepv(pTHX_ char *pv)
524 {
525     SSCHECK(2);
526     SSPUSHPTR(pv);
527     SSPUSHINT(SAVEt_FREEPV);
528 }
529
530 void
531 Perl_save_clearsv(pTHX_ SV **svp)
532 {
533     ASSERT_CURPAD_ACTIVE("save_clearsv");
534     SSCHECK(2);
535     SSPUSHLONG((long)(svp-PL_curpad));
536     SSPUSHINT(SAVEt_CLEARSV);
537     SvPADSTALE_off(*svp); /* mark lexical as active */
538 }
539
540 void
541 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
542 {
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     register SV *sv;
554     register I32 i;
555
556     for (i = 1; i <= maxsarg; i++) {
557         sv = NEWSV(0,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     SSCHECK(3);
570     SSPUSHDPTR(f);
571     SSPUSHPTR(p);
572     SSPUSHINT(SAVEt_DESTRUCTOR);
573 }
574
575 void
576 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
577 {
578     SSCHECK(3);
579     SSPUSHDXPTR(f);
580     SSPUSHPTR(p);
581     SSPUSHINT(SAVEt_DESTRUCTOR_X);
582 }
583
584 void
585 Perl_save_aelem(pTHX_ AV *av, I32 idx, SV **sptr)
586 {
587     SV *sv;
588     SSCHECK(4);
589     SSPUSHPTR(SvREFCNT_inc(av));
590     SSPUSHINT(idx);
591     SSPUSHPTR(SvREFCNT_inc(*sptr));
592     SSPUSHINT(SAVEt_AELEM);
593     /* if it gets reified later, the restore will have the wrong refcnt */
594     if (!AvREAL(av) && AvREIFY(av))
595         SvREFCNT_inc(*sptr);
596     save_scalar_at(sptr);
597     sv = *sptr;
598     /* If we're localizing a tied array element, this new sv
599      * won't actually be stored in the array - so it won't get
600      * reaped when the localize ends. Ensure it gets reaped by
601      * mortifying it instead. DAPM */
602     if (SvTIED_mg(sv, PERL_MAGIC_tiedelem))
603         sv_2mortal(sv);
604 }
605
606 void
607 Perl_save_helem(pTHX_ HV *hv, SV *key, SV **sptr)
608 {
609     SV *sv;
610     SSCHECK(4);
611     SSPUSHPTR(SvREFCNT_inc(hv));
612     SSPUSHPTR(SvREFCNT_inc(key));
613     SSPUSHPTR(SvREFCNT_inc(*sptr));
614     SSPUSHINT(SAVEt_HELEM);
615     save_scalar_at(sptr);
616     sv = *sptr;
617     /* If we're localizing a tied hash element, this new sv
618      * won't actually be stored in the hash - so it won't get
619      * reaped when the localize ends. Ensure it gets reaped by
620      * mortifying it instead. DAPM */
621     if (SvTIED_mg(sv, PERL_MAGIC_tiedelem))
622         sv_2mortal(sv);
623 }
624
625 void
626 Perl_save_op(pTHX)
627 {
628     SSCHECK(2);
629     SSPUSHPTR(PL_op);
630     SSPUSHINT(SAVEt_OP);
631 }
632
633 I32
634 Perl_save_alloc(pTHX_ I32 size, I32 pad)
635 {
636     register I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
637                                 - (char*)PL_savestack);
638     register I32 elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
639
640     /* SSCHECK may not be good enough */
641     while (PL_savestack_ix + elems + 2 > PL_savestack_max)
642         savestack_grow();
643
644     PL_savestack_ix += elems;
645     SSPUSHINT(elems);
646     SSPUSHINT(SAVEt_ALLOC);
647     return start;
648 }
649
650 void
651 Perl_leave_scope(pTHX_ I32 base)
652 {
653     register SV *sv;
654     register SV *value;
655     register GV *gv;
656     register AV *av;
657     register HV *hv;
658     register void* ptr;
659     register char* str;
660     I32 i;
661
662     if (base < -1)
663         Perl_croak(aTHX_ "panic: corrupt saved stack index");
664     while (PL_savestack_ix > base) {
665         switch (SSPOPINT) {
666         case SAVEt_ITEM:                        /* normal string */
667             value = (SV*)SSPOPPTR;
668             sv = (SV*)SSPOPPTR;
669             sv_replace(sv,value);
670             PL_localizing = 2;
671             SvSETMAGIC(sv);
672             PL_localizing = 0;
673             break;
674         case SAVEt_SV:                          /* scalar reference */
675             value = (SV*)SSPOPPTR;
676             gv = (GV*)SSPOPPTR;
677             ptr = &GvSV(gv);
678             av = (AV*)gv; /* what to refcnt_dec */
679             goto restore_sv;
680         case SAVEt_GENERIC_PVREF:               /* generic pv */
681             str = (char*)SSPOPPTR;
682             ptr = SSPOPPTR;
683             if (*(char**)ptr != str) {
684                 Safefree(*(char**)ptr);
685                 *(char**)ptr = str;
686             }
687             break;
688         case SAVEt_SHARED_PVREF:                /* shared pv */
689             str = (char*)SSPOPPTR;
690             ptr = SSPOPPTR;
691             if (*(char**)ptr != str) {
692 #ifdef NETWARE
693                 PerlMem_free(*(char**)ptr);
694 #else
695                 PerlMemShared_free(*(char**)ptr);
696 #endif
697                 *(char**)ptr = str;
698             }
699             break;
700         case SAVEt_GENERIC_SVREF:               /* generic sv */
701             value = (SV*)SSPOPPTR;
702             ptr = SSPOPPTR;
703             sv = *(SV**)ptr;
704             *(SV**)ptr = value;
705             SvREFCNT_dec(sv);
706             SvREFCNT_dec(value);
707             break;
708         case SAVEt_SVREF:                       /* scalar reference */
709             value = (SV*)SSPOPPTR;
710             ptr = SSPOPPTR;
711             av = Nullav; /* what to refcnt_dec */
712         restore_sv:
713             sv = *(SV**)ptr;
714             DEBUG_S(PerlIO_printf(Perl_debug_log,
715                                   "restore svref: %p %p:%s -> %p:%s\n",
716                                   ptr, sv, SvPEEK(sv), value, SvPEEK(value)));
717             if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv) &&
718                 SvTYPE(sv) != SVt_PVGV)
719             {
720                 (void)SvUPGRADE(value, SvTYPE(sv));
721                 SvMAGIC(value) = SvMAGIC(sv);
722                 SvFLAGS(value) |= SvMAGICAL(sv);
723                 SvMAGICAL_off(sv);
724                 SvMAGIC(sv) = 0;
725             }
726             /* XXX This branch is pretty bogus.  This code irretrievably
727              * clears(!) the magic on the SV (either to avoid further
728              * croaking that might ensue when the SvSETMAGIC() below is
729              * called, or to avoid two different SVs pointing at the same
730              * SvMAGIC()).  This needs a total rethink.  --GSAR */
731             else if (SvTYPE(value) >= SVt_PVMG && SvMAGIC(value) &&
732                      SvTYPE(value) != SVt_PVGV)
733             {
734                 SvFLAGS(value) |= (SvFLAGS(value) &
735                                   (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
736                 SvMAGICAL_off(value);
737                 /* XXX this is a leak when we get here because the
738                  * mg_get() in save_scalar_at() croaked */
739                 SvMAGIC(value) = 0;
740             }
741             *(SV**)ptr = value;
742             SvREFCNT_dec(sv);
743             PL_localizing = 2;
744             SvSETMAGIC(value);
745             PL_localizing = 0;
746             SvREFCNT_dec(value);
747             if (av) /* actually an av, hv or gv */
748                 SvREFCNT_dec(av);
749             break;
750         case SAVEt_AV:                          /* array reference */
751             av = (AV*)SSPOPPTR;
752             gv = (GV*)SSPOPPTR;
753             if (GvAV(gv)) {
754                 AV *goner = GvAV(gv);
755                 SvMAGIC(av) = SvMAGIC(goner);
756                 SvFLAGS((SV*)av) |= SvMAGICAL(goner);
757                 SvMAGICAL_off(goner);
758                 SvMAGIC(goner) = 0;
759                 SvREFCNT_dec(goner);
760             }
761             GvAV(gv) = av;
762             if (SvMAGICAL(av)) {
763                 PL_localizing = 2;
764                 SvSETMAGIC((SV*)av);
765                 PL_localizing = 0;
766             }
767             break;
768         case SAVEt_HV:                          /* hash reference */
769             hv = (HV*)SSPOPPTR;
770             gv = (GV*)SSPOPPTR;
771             if (GvHV(gv)) {
772                 HV *goner = GvHV(gv);
773                 SvMAGIC(hv) = SvMAGIC(goner);
774                 SvFLAGS(hv) |= SvMAGICAL(goner);
775                 SvMAGICAL_off(goner);
776                 SvMAGIC(goner) = 0;
777                 SvREFCNT_dec(goner);
778             }
779             GvHV(gv) = hv;
780             if (SvMAGICAL(hv)) {
781                 PL_localizing = 2;
782                 SvSETMAGIC((SV*)hv);
783                 PL_localizing = 0;
784             }
785             break;
786         case SAVEt_INT:                         /* int reference */
787             ptr = SSPOPPTR;
788             *(int*)ptr = (int)SSPOPINT;
789             break;
790         case SAVEt_LONG:                        /* long reference */
791             ptr = SSPOPPTR;
792             *(long*)ptr = (long)SSPOPLONG;
793             break;
794         case SAVEt_BOOL:                        /* bool reference */
795             ptr = SSPOPPTR;
796             *(bool*)ptr = (bool)SSPOPBOOL;
797             break;
798         case SAVEt_I32:                         /* I32 reference */
799             ptr = SSPOPPTR;
800             *(I32*)ptr = (I32)SSPOPINT;
801             break;
802         case SAVEt_I16:                         /* I16 reference */
803             ptr = SSPOPPTR;
804             *(I16*)ptr = (I16)SSPOPINT;
805             break;
806         case SAVEt_I8:                          /* I8 reference */
807             ptr = SSPOPPTR;
808             *(I8*)ptr = (I8)SSPOPINT;
809             break;
810         case SAVEt_IV:                          /* IV reference */
811             ptr = SSPOPPTR;
812             *(IV*)ptr = (IV)SSPOPIV;
813             break;
814         case SAVEt_SPTR:                        /* SV* reference */
815             ptr = SSPOPPTR;
816             *(SV**)ptr = (SV*)SSPOPPTR;
817             break;
818         case SAVEt_VPTR:                        /* random* reference */
819         case SAVEt_PPTR:                        /* char* reference */
820             ptr = SSPOPPTR;
821             *(char**)ptr = (char*)SSPOPPTR;
822             break;
823         case SAVEt_HPTR:                        /* HV* reference */
824             ptr = SSPOPPTR;
825             *(HV**)ptr = (HV*)SSPOPPTR;
826             break;
827         case SAVEt_APTR:                        /* AV* reference */
828             ptr = SSPOPPTR;
829             *(AV**)ptr = (AV*)SSPOPPTR;
830             break;
831         case SAVEt_NSTAB:
832             gv = (GV*)SSPOPPTR;
833             (void)sv_clear((SV*)gv);
834             break;
835         case SAVEt_GP:                          /* scalar reference */
836             ptr = SSPOPPTR;
837             gv = (GV*)SSPOPPTR;
838             if (SvPVX(gv) && SvLEN(gv) > 0) {
839                 Safefree(SvPVX(gv));
840             }
841             SvPVX(gv) = (char *)SSPOPPTR;
842             SvCUR(gv) = (STRLEN)SSPOPIV;
843             SvLEN(gv) = (STRLEN)SSPOPIV;
844             gp_free(gv);
845             GvGP(gv) = (GP*)ptr;
846             if (GvCVu(gv))
847                 PL_sub_generation++;  /* putting a method back into circulation */
848             SvREFCNT_dec(gv);
849             break;
850         case SAVEt_FREESV:
851             ptr = SSPOPPTR;
852             SvREFCNT_dec((SV*)ptr);
853             break;
854         case SAVEt_MORTALIZESV:
855             ptr = SSPOPPTR;
856             sv_2mortal((SV*)ptr);
857             break;
858         case SAVEt_FREEOP:
859             ptr = SSPOPPTR;
860             ASSERT_CURPAD_LEGAL("SAVEt_FREEOP"); /* XXX DAPM tmp */
861             op_free((OP*)ptr);
862             break;
863         case SAVEt_FREEPV:
864             ptr = SSPOPPTR;
865             Safefree((char*)ptr);
866             break;
867         case SAVEt_CLEARSV:
868             ptr = (void*)&PL_curpad[SSPOPLONG];
869             sv = *(SV**)ptr;
870
871             DEBUG_Xv(PerlIO_printf(Perl_debug_log,
872              "Pad 0x%"UVxf"[0x%"UVxf"] clearsv: %ld sv=0x%"UVxf"<%"IVdf"> %s\n",
873                 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
874                 (long)((SV **)ptr-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
875                 (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
876             ));
877
878             /* Can clear pad variable in place? */
879             if (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) {
880                 /*
881                  * if a my variable that was made readonly is going out of
882                  * scope, we want to remove the readonlyness so that it can
883                  * go out of scope quietly
884                  */
885                 if (SvPADMY(sv) && !SvFAKE(sv))
886                     SvREADONLY_off(sv);
887
888                 if (SvTHINKFIRST(sv))
889                     sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF);
890                 if (SvMAGICAL(sv))
891                     mg_free(sv);
892
893                 switch (SvTYPE(sv)) {
894                 case SVt_NULL:
895                     break;
896                 case SVt_PVAV:
897                     av_clear((AV*)sv);
898                     break;
899                 case SVt_PVHV:
900                     hv_clear((HV*)sv);
901                     break;
902                 case SVt_PVCV:
903                     Perl_croak(aTHX_ "panic: leave_scope pad code");
904                 default:
905                     SvOK_off(sv);
906                     break;
907                 }
908                 SvPADSTALE_on(sv); /* mark as no longer live */
909             }
910             else {      /* Someone has a claim on this, so abandon it. */
911                 U32 padflags = SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP);
912                 switch (SvTYPE(sv)) {   /* Console ourselves with a new value */
913                 case SVt_PVAV:  *(SV**)ptr = (SV*)newAV();      break;
914                 case SVt_PVHV:  *(SV**)ptr = (SV*)newHV();      break;
915                 default:        *(SV**)ptr = NEWSV(0,0);        break;
916                 }
917                 SvREFCNT_dec(sv);       /* Cast current value to the winds. */
918                 /* preserve pad nature, but also mark as not live
919                  * for any closure capturing */
920                 SvFLAGS(*(SV**)ptr) |= padflags | SVs_PADSTALE;
921             }
922             break;
923         case SAVEt_DELETE:
924             ptr = SSPOPPTR;
925             hv = (HV*)ptr;
926             ptr = SSPOPPTR;
927             (void)hv_delete(hv, (char*)ptr, (U32)SSPOPINT, G_DISCARD);
928             SvREFCNT_dec(hv);
929             Safefree(ptr);
930             break;
931         case SAVEt_DESTRUCTOR:
932             ptr = SSPOPPTR;
933             (*SSPOPDPTR)(ptr);
934             break;
935         case SAVEt_DESTRUCTOR_X:
936             ptr = SSPOPPTR;
937             (*SSPOPDXPTR)(aTHX_ ptr);
938             break;
939         case SAVEt_REGCONTEXT:
940         case SAVEt_ALLOC:
941             i = SSPOPINT;
942             PL_savestack_ix -= i;       /* regexp must have croaked */
943             break;
944         case SAVEt_STACK_POS:           /* Position on Perl stack */
945             i = SSPOPINT;
946             PL_stack_sp = PL_stack_base + i;
947             break;
948         case SAVEt_AELEM:               /* array element */
949             value = (SV*)SSPOPPTR;
950             i = SSPOPINT;
951             av = (AV*)SSPOPPTR;
952             if (!AvREAL(av) && AvREIFY(av)) /* undo reify guard */
953                 SvREFCNT_dec(value);
954             ptr = av_fetch(av,i,1);
955             if (ptr) {
956                 sv = *(SV**)ptr;
957                 if (sv && sv != &PL_sv_undef) {
958                     if (SvTIED_mg((SV*)av, PERL_MAGIC_tied))
959                         (void)SvREFCNT_inc(sv);
960                     goto restore_sv;
961                 }
962             }
963             SvREFCNT_dec(av);
964             SvREFCNT_dec(value);
965             break;
966         case SAVEt_HELEM:               /* hash element */
967             value = (SV*)SSPOPPTR;
968             sv = (SV*)SSPOPPTR;
969             hv = (HV*)SSPOPPTR;
970             ptr = hv_fetch_ent(hv, sv, 1, 0);
971             if (ptr) {
972                 SV *oval = HeVAL((HE*)ptr);
973                 if (oval && oval != &PL_sv_undef) {
974                     ptr = &HeVAL((HE*)ptr);
975                     if (SvTIED_mg((SV*)hv, PERL_MAGIC_tied))
976                         (void)SvREFCNT_inc(*(SV**)ptr);
977                     SvREFCNT_dec(sv);
978                     av = (AV*)hv; /* what to refcnt_dec */
979                     goto restore_sv;
980                 }
981             }
982             SvREFCNT_dec(hv);
983             SvREFCNT_dec(sv);
984             SvREFCNT_dec(value);
985             break;
986         case SAVEt_OP:
987             PL_op = (OP*)SSPOPPTR;
988             break;
989         case SAVEt_HINTS:
990             if ((PL_hints & HINT_LOCALIZE_HH) && GvHV(PL_hintgv)) {
991                 SvREFCNT_dec((SV*)GvHV(PL_hintgv));
992                 GvHV(PL_hintgv) = NULL;
993             }
994             *(I32*)&PL_hints = (I32)SSPOPINT;
995             if (PL_hints & HINT_LOCALIZE_HH) {
996                 SvREFCNT_dec((SV*)GvHV(PL_hintgv));
997                 GvHV(PL_hintgv) = (HV*)SSPOPPTR;
998             }
999                     
1000             break;
1001         case SAVEt_COMPPAD:
1002             PL_comppad = (PAD*)SSPOPPTR;
1003             if (PL_comppad)
1004                 PL_curpad = AvARRAY(PL_comppad);
1005             else
1006                 PL_curpad = Null(SV**);
1007             break;
1008         case SAVEt_PADSV:
1009             {
1010                 PADOFFSET off = (PADOFFSET)SSPOPLONG;
1011                 ptr = SSPOPPTR;
1012                 if (ptr)
1013                     AvARRAY((PAD*)ptr)[off] = (SV*)SSPOPPTR;
1014             }
1015             break;
1016         case SAVEt_SAVESWITCHSTACK:
1017             {
1018                 dSP;
1019                 AV* t = (AV*)SSPOPPTR;
1020                 AV* f = (AV*)SSPOPPTR;
1021                 SWITCHSTACK(t,f);
1022                 PL_curstackinfo->si_stack = f;
1023             }
1024             break;
1025         case SAVEt_SET_SVFLAGS:
1026             {
1027                 U32 val  = (U32)SSPOPINT;
1028                 U32 mask = (U32)SSPOPINT;
1029                 sv = (SV*)SSPOPPTR;
1030                 SvFLAGS(sv) &= ~mask;
1031                 SvFLAGS(sv) |= val;
1032             }
1033             break;
1034         default:
1035             Perl_croak(aTHX_ "panic: leave_scope inconsistency");
1036         }
1037     }
1038 }
1039
1040 void
1041 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1042 {
1043 #ifdef DEBUGGING
1044     PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1045     if (CxTYPE(cx) != CXt_SUBST) {
1046         PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1047         PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
1048                       PTR2UV(cx->blk_oldcop));
1049         PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1050         PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1051         PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
1052                       PTR2UV(cx->blk_oldpm));
1053         PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", cx->blk_gimme ? "LIST" : "SCALAR");
1054     }
1055     switch (CxTYPE(cx)) {
1056     case CXt_NULL:
1057     case CXt_BLOCK:
1058         break;
1059     case CXt_FORMAT:
1060         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1061                 PTR2UV(cx->blk_sub.cv));
1062         PerlIO_printf(Perl_debug_log, "BLK_SUB.GV = 0x%"UVxf"\n",
1063                 PTR2UV(cx->blk_sub.gv));
1064         PerlIO_printf(Perl_debug_log, "BLK_SUB.DFOUTGV = 0x%"UVxf"\n",
1065                 PTR2UV(cx->blk_sub.dfoutgv));
1066         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1067                 (int)cx->blk_sub.hasargs);
1068         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1069                 PTR2UV(cx->blk_sub.retop));
1070         break;
1071     case CXt_SUB:
1072         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1073                 PTR2UV(cx->blk_sub.cv));
1074         PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1075                 (long)cx->blk_sub.olddepth);
1076         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1077                 (int)cx->blk_sub.hasargs);
1078         PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n",
1079                 (int)cx->blk_sub.lval);
1080         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1081                 PTR2UV(cx->blk_sub.retop));
1082         break;
1083     case CXt_EVAL:
1084         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1085                 (long)cx->blk_eval.old_in_eval);
1086         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1087                 PL_op_name[cx->blk_eval.old_op_type],
1088                 PL_op_desc[cx->blk_eval.old_op_type]);
1089         if (cx->blk_eval.old_namesv)
1090             PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1091                           SvPVX(cx->blk_eval.old_namesv));
1092         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1093                 PTR2UV(cx->blk_eval.old_eval_root));
1094         PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%"UVxf"\n",
1095                 PTR2UV(cx->blk_eval.retop));
1096         break;
1097
1098     case CXt_LOOP:
1099         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n",
1100                 cx->blk_loop.label);
1101         PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
1102                 (long)cx->blk_loop.resetsp);
1103         PerlIO_printf(Perl_debug_log, "BLK_LOOP.REDO_OP = 0x%"UVxf"\n",
1104                 PTR2UV(cx->blk_loop.redo_op));
1105         PerlIO_printf(Perl_debug_log, "BLK_LOOP.NEXT_OP = 0x%"UVxf"\n",
1106                 PTR2UV(cx->blk_loop.next_op));
1107         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LAST_OP = 0x%"UVxf"\n",
1108                 PTR2UV(cx->blk_loop.last_op));
1109         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1110                 (long)cx->blk_loop.iterix);
1111         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1112                 PTR2UV(cx->blk_loop.iterary));
1113         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1114                 PTR2UV(CxITERVAR(cx)));
1115         if (CxITERVAR(cx))
1116             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERSAVE = 0x%"UVxf"\n",
1117                 PTR2UV(cx->blk_loop.itersave));
1118         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERLVAL = 0x%"UVxf"\n",
1119                 PTR2UV(cx->blk_loop.iterlval));
1120         break;
1121
1122     case CXt_SUBST:
1123         PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1124                 (long)cx->sb_iters);
1125         PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1126                 (long)cx->sb_maxiters);
1127         PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1128                 (long)cx->sb_rflags);
1129         PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1130                 (long)cx->sb_once);
1131         PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1132                 cx->sb_orig);
1133         PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1134                 PTR2UV(cx->sb_dstr));
1135         PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1136                 PTR2UV(cx->sb_targ));
1137         PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1138                 PTR2UV(cx->sb_s));
1139         PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1140                 PTR2UV(cx->sb_m));
1141         PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1142                 PTR2UV(cx->sb_strend));
1143         PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1144                 PTR2UV(cx->sb_rxres));
1145         break;
1146     }
1147 #endif  /* DEBUGGING */
1148 }
1149
1150 /*
1151  * Local variables:
1152  * c-indentation-style: bsd
1153  * c-basic-offset: 4
1154  * indent-tabs-mode: t
1155  * End:
1156  *
1157  * vim: shiftwidth=4:
1158 */