This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Re: [PATCH scope.c] Re: local($tied->{foo}) leaks
[perl5.git] / scope.c
1 /*    scope.c
2  *
3  *    Copyright (c) 1991-2002, Larry Wall
4  *
5  *    You may distribute under the terms of either the GNU General Public
6  *    License or the Artistic License, as specified in the README file.
7  *
8  */
9
10 /*
11  * "For the fashion of Minas Tirith was such that it was built on seven
12  * levels..."
13  */
14
15 #include "EXTERN.h"
16 #define PERL_IN_SCOPE_C
17 #include "perl.h"
18
19 #if defined(PERL_FLEXIBLE_EXCEPTIONS)
20 void *
21 Perl_default_protect(pTHX_ volatile JMPENV *pcur_env, int *excpt,
22                      protect_body_t body, ...)
23 {
24     void *ret;
25     va_list args;
26     va_start(args, body);
27     ret = vdefault_protect(pcur_env, excpt, body, &args);
28     va_end(args);
29     return ret;
30 }
31
32 void *
33 Perl_vdefault_protect(pTHX_ volatile JMPENV *pcur_env, int *excpt,
34                       protect_body_t body, va_list *args)
35 {
36     int ex;
37     void *ret;
38
39     JMPENV_PUSH(ex);
40     if (ex)
41         ret = NULL;
42     else
43         ret = CALL_FPTR(body)(aTHX_ *args);
44     *excpt = ex;
45     JMPENV_POP;
46     return ret;
47 }
48 #endif
49
50 SV**
51 Perl_stack_grow(pTHX_ SV **sp, SV **p, int n)
52 {
53     PL_stack_sp = sp;
54 #ifndef STRESS_REALLOC
55     av_extend(PL_curstack, (p - PL_stack_base) + (n) + 128);
56 #else
57     av_extend(PL_curstack, (p - PL_stack_base) + (n) + 1);
58 #endif
59     return PL_stack_sp;
60 }
61
62 #ifndef STRESS_REALLOC
63 #define GROW(old) ((old) * 3 / 2)
64 #else
65 #define GROW(old) ((old) + 1)
66 #endif
67
68 PERL_SI *
69 Perl_new_stackinfo(pTHX_ I32 stitems, I32 cxitems)
70 {
71     PERL_SI *si;
72     New(56, si, 1, PERL_SI);
73     si->si_stack = newAV();
74     AvREAL_off(si->si_stack);
75     av_extend(si->si_stack, stitems > 0 ? stitems-1 : 0);
76     AvALLOC(si->si_stack)[0] = &PL_sv_undef;
77     AvFILLp(si->si_stack) = 0;
78     si->si_prev = 0;
79     si->si_next = 0;
80     si->si_cxmax = cxitems - 1;
81     si->si_cxix = -1;
82     si->si_type = PERLSI_UNDEF;
83     New(56, si->si_cxstack, cxitems, PERL_CONTEXT);
84     return si;
85 }
86
87 I32
88 Perl_cxinc(pTHX)
89 {
90     cxstack_max = GROW(cxstack_max);
91     Renew(cxstack, cxstack_max + 1, PERL_CONTEXT);      /* XXX should fix CXINC macro */
92     return cxstack_ix + 1;
93 }
94
95 void
96 Perl_push_return(pTHX_ OP *retop)
97 {
98     if (PL_retstack_ix == PL_retstack_max) {
99         PL_retstack_max = GROW(PL_retstack_max);
100         Renew(PL_retstack, PL_retstack_max, OP*);
101     }
102     PL_retstack[PL_retstack_ix++] = retop;
103 }
104
105 OP *
106 Perl_pop_return(pTHX)
107 {
108     if (PL_retstack_ix > 0)
109         return PL_retstack[--PL_retstack_ix];
110     else
111         return Nullop;
112 }
113
114 void
115 Perl_push_scope(pTHX)
116 {
117     if (PL_scopestack_ix == PL_scopestack_max) {
118         PL_scopestack_max = GROW(PL_scopestack_max);
119         Renew(PL_scopestack, PL_scopestack_max, I32);
120     }
121     PL_scopestack[PL_scopestack_ix++] = PL_savestack_ix;
122
123 }
124
125 void
126 Perl_pop_scope(pTHX)
127 {
128     I32 oldsave = PL_scopestack[--PL_scopestack_ix];
129     LEAVE_SCOPE(oldsave);
130 }
131
132 void
133 Perl_markstack_grow(pTHX)
134 {
135     I32 oldmax = PL_markstack_max - PL_markstack;
136     I32 newmax = GROW(oldmax);
137
138     Renew(PL_markstack, newmax, I32);
139     PL_markstack_ptr = PL_markstack + oldmax;
140     PL_markstack_max = PL_markstack + newmax;
141 }
142
143 void
144 Perl_savestack_grow(pTHX)
145 {
146     PL_savestack_max = GROW(PL_savestack_max) + 4;
147     Renew(PL_savestack, PL_savestack_max, ANY);
148 }
149
150 #undef GROW
151
152 void
153 Perl_tmps_grow(pTHX_ I32 n)
154 {
155 #ifndef STRESS_REALLOC
156     if (n < 128)
157         n = (PL_tmps_max < 512) ? 128 : 512;
158 #endif
159     PL_tmps_max = PL_tmps_ix + n + 1;
160     Renew(PL_tmps_stack, PL_tmps_max, SV*);
161 }
162
163
164 void
165 Perl_free_tmps(pTHX)
166 {
167     /* XXX should tmps_floor live in cxstack? */
168     I32 myfloor = PL_tmps_floor;
169     while (PL_tmps_ix > myfloor) {      /* clean up after last statement */
170         SV* sv = PL_tmps_stack[PL_tmps_ix];
171         PL_tmps_stack[PL_tmps_ix--] = Nullsv;
172         if (sv && sv != &PL_sv_undef) {
173             SvTEMP_off(sv);
174             SvREFCNT_dec(sv);           /* note, can modify tmps_ix!!! */
175         }
176     }
177 }
178
179 STATIC SV *
180 S_save_scalar_at(pTHX_ SV **sptr)
181 {
182     register SV *sv;
183     SV *osv = *sptr;
184
185     sv = *sptr = NEWSV(0,0);
186     if (SvTYPE(osv) >= SVt_PVMG && SvMAGIC(osv) && SvTYPE(osv) != SVt_PVGV) {
187         sv_upgrade(sv, SvTYPE(osv));
188         if (SvGMAGICAL(osv)) {
189             MAGIC* mg;
190             bool oldtainted = PL_tainted;
191             mg_get(osv);                /* note, can croak! */
192             if (PL_tainting && PL_tainted &&
193                         (mg = mg_find(osv, PERL_MAGIC_taint))) {
194                 SAVESPTR(mg->mg_obj);
195                 mg->mg_obj = osv;
196             }
197             SvFLAGS(osv) |= (SvFLAGS(osv) &
198                (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
199             PL_tainted = oldtainted;
200         }
201         SvMAGIC(sv) = SvMAGIC(osv);
202         SvFLAGS(sv) |= SvMAGICAL(osv);
203         /* XXX SvMAGIC() is *shared* between osv and sv.  This can
204          * lead to coredumps when both SVs are destroyed without one
205          * of their SvMAGIC() slots being NULLed. */
206         PL_localizing = 1;
207         SvSETMAGIC(sv);
208         PL_localizing = 0;
209     }
210     return sv;
211 }
212
213 SV *
214 Perl_save_scalar(pTHX_ GV *gv)
215 {
216     SV **sptr = &GvSV(gv);
217     SSCHECK(3);
218     SSPUSHPTR(SvREFCNT_inc(gv));
219     SSPUSHPTR(SvREFCNT_inc(*sptr));
220     SSPUSHINT(SAVEt_SV);
221     return save_scalar_at(sptr);
222 }
223
224 SV*
225 Perl_save_svref(pTHX_ SV **sptr)
226 {
227     SSCHECK(3);
228     SSPUSHPTR(sptr);
229     SSPUSHPTR(SvREFCNT_inc(*sptr));
230     SSPUSHINT(SAVEt_SVREF);
231     return save_scalar_at(sptr);
232 }
233
234 /* Like save_sptr(), but also SvREFCNT_dec()s the new value.  Can be used to
235  * restore a global SV to its prior contents, freeing new value. */
236 void
237 Perl_save_generic_svref(pTHX_ SV **sptr)
238 {
239     SSCHECK(3);
240     SSPUSHPTR(sptr);
241     SSPUSHPTR(SvREFCNT_inc(*sptr));
242     SSPUSHINT(SAVEt_GENERIC_SVREF);
243 }
244
245 /* Like save_pptr(), but also Safefree()s the new value if it is different
246  * from the old one.  Can be used to restore a global char* to its prior
247  * contents, freeing new value. */
248 void
249 Perl_save_generic_pvref(pTHX_ char **str)
250 {
251     SSCHECK(3);
252     SSPUSHPTR(str);
253     SSPUSHPTR(*str);
254     SSPUSHINT(SAVEt_GENERIC_PVREF);
255 }
256
257 /* Like save_generic_pvref(), but uses PerlMemShared_free() rather than Safefree().
258  * Can be used to restore a shared global char* to its prior
259  * contents, freeing new value. */
260 void
261 Perl_save_shared_pvref(pTHX_ char **str)
262 {
263     SSCHECK(3);
264     SSPUSHPTR(str);
265     SSPUSHPTR(*str);
266     SSPUSHINT(SAVEt_SHARED_PVREF);
267 }
268
269 void
270 Perl_save_gp(pTHX_ GV *gv, I32 empty)
271 {
272     SSCHECK(6);
273     SSPUSHIV((IV)SvLEN(gv));
274     SvLEN(gv) = 0; /* forget that anything was allocated here */
275     SSPUSHIV((IV)SvCUR(gv));
276     SSPUSHPTR(SvPVX(gv));
277     SvPOK_off(gv);
278     SSPUSHPTR(SvREFCNT_inc(gv));
279     SSPUSHPTR(GvGP(gv));
280     SSPUSHINT(SAVEt_GP);
281
282     if (empty) {
283         register GP *gp;
284
285         Newz(602, gp, 1, GP);
286
287         if (GvCVu(gv))
288             PL_sub_generation++;        /* taking a method out of circulation */
289         if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
290             gp->gp_io = newIO();
291             IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
292         }
293         GvGP(gv) = gp_ref(gp);
294         GvSV(gv) = NEWSV(72,0);
295         GvLINE(gv) = CopLINE(PL_curcop);
296         GvFILE(gv) = CopFILE(PL_curcop) ? CopFILE(PL_curcop) : "";
297         GvEGV(gv) = gv;
298     }
299     else {
300         gp_ref(GvGP(gv));
301         GvINTRO_on(gv);
302     }
303 }
304
305 AV *
306 Perl_save_ary(pTHX_ GV *gv)
307 {
308     AV *oav = GvAVn(gv);
309     AV *av;
310
311     if (!AvREAL(oav) && AvREIFY(oav))
312         av_reify(oav);
313     SSCHECK(3);
314     SSPUSHPTR(gv);
315     SSPUSHPTR(oav);
316     SSPUSHINT(SAVEt_AV);
317
318     GvAV(gv) = Null(AV*);
319     av = GvAVn(gv);
320     if (SvMAGIC(oav)) {
321         SvMAGIC(av) = SvMAGIC(oav);
322         SvFLAGS((SV*)av) |= SvMAGICAL(oav);
323         SvMAGICAL_off(oav);
324         SvMAGIC(oav) = 0;
325         PL_localizing = 1;
326         SvSETMAGIC((SV*)av);
327         PL_localizing = 0;
328     }
329     return av;
330 }
331
332 HV *
333 Perl_save_hash(pTHX_ GV *gv)
334 {
335     HV *ohv, *hv;
336
337     SSCHECK(3);
338     SSPUSHPTR(gv);
339     SSPUSHPTR(ohv = GvHVn(gv));
340     SSPUSHINT(SAVEt_HV);
341
342     GvHV(gv) = Null(HV*);
343     hv = GvHVn(gv);
344     if (SvMAGIC(ohv)) {
345         SvMAGIC(hv) = SvMAGIC(ohv);
346         SvFLAGS((SV*)hv) |= SvMAGICAL(ohv);
347         SvMAGICAL_off(ohv);
348         SvMAGIC(ohv) = 0;
349         PL_localizing = 1;
350         SvSETMAGIC((SV*)hv);
351         PL_localizing = 0;
352     }
353     return hv;
354 }
355
356 void
357 Perl_save_item(pTHX_ register SV *item)
358 {
359     register SV *sv = NEWSV(0,0);
360
361     sv_setsv(sv,item);
362     SSCHECK(3);
363     SSPUSHPTR(item);            /* remember the pointer */
364     SSPUSHPTR(sv);              /* remember the value */
365     SSPUSHINT(SAVEt_ITEM);
366 }
367
368 void
369 Perl_save_int(pTHX_ int *intp)
370 {
371     SSCHECK(3);
372     SSPUSHINT(*intp);
373     SSPUSHPTR(intp);
374     SSPUSHINT(SAVEt_INT);
375 }
376
377 void
378 Perl_save_long(pTHX_ long int *longp)
379 {
380     SSCHECK(3);
381     SSPUSHLONG(*longp);
382     SSPUSHPTR(longp);
383     SSPUSHINT(SAVEt_LONG);
384 }
385
386 void
387 Perl_save_I32(pTHX_ I32 *intp)
388 {
389     SSCHECK(3);
390     SSPUSHINT(*intp);
391     SSPUSHPTR(intp);
392     SSPUSHINT(SAVEt_I32);
393 }
394
395 void
396 Perl_save_I16(pTHX_ I16 *intp)
397 {
398     SSCHECK(3);
399     SSPUSHINT(*intp);
400     SSPUSHPTR(intp);
401     SSPUSHINT(SAVEt_I16);
402 }
403
404 void
405 Perl_save_I8(pTHX_ I8 *bytep)
406 {
407     SSCHECK(3);
408     SSPUSHINT(*bytep);
409     SSPUSHPTR(bytep);
410     SSPUSHINT(SAVEt_I8);
411 }
412
413 void
414 Perl_save_iv(pTHX_ IV *ivp)
415 {
416     SSCHECK(3);
417     SSPUSHIV(*ivp);
418     SSPUSHPTR(ivp);
419     SSPUSHINT(SAVEt_IV);
420 }
421
422 /* Cannot use save_sptr() to store a char* since the SV** cast will
423  * force word-alignment and we'll miss the pointer.
424  */
425 void
426 Perl_save_pptr(pTHX_ char **pptr)
427 {
428     SSCHECK(3);
429     SSPUSHPTR(*pptr);
430     SSPUSHPTR(pptr);
431     SSPUSHINT(SAVEt_PPTR);
432 }
433
434 void
435 Perl_save_vptr(pTHX_ void *ptr)
436 {
437     SSCHECK(3);
438     SSPUSHPTR(*(char**)ptr);
439     SSPUSHPTR(ptr);
440     SSPUSHINT(SAVEt_VPTR);
441 }
442
443 void
444 Perl_save_sptr(pTHX_ SV **sptr)
445 {
446     SSCHECK(3);
447     SSPUSHPTR(*sptr);
448     SSPUSHPTR(sptr);
449     SSPUSHINT(SAVEt_SPTR);
450 }
451
452 void
453 Perl_save_padsv(pTHX_ PADOFFSET off)
454 {
455     SSCHECK(4);
456     SSPUSHPTR(PL_curpad[off]);
457     SSPUSHPTR(PL_curpad);
458     SSPUSHLONG((long)off);
459     SSPUSHINT(SAVEt_PADSV);
460 }
461
462 SV **
463 Perl_save_threadsv(pTHX_ PADOFFSET i)
464 {
465 #ifdef USE_5005THREADS
466     SV **svp = &THREADSV(i);    /* XXX Change to save by offset */
467     DEBUG_S(PerlIO_printf(Perl_debug_log, "save_threadsv %"UVuf": %p %p:%s\n",
468                           (UV)i, svp, *svp, SvPEEK(*svp)));
469     save_svref(svp);
470     return svp;
471 #else
472     Perl_croak(aTHX_ "panic: save_threadsv called in non-threaded perl");
473     return 0;
474 #endif /* USE_5005THREADS */
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     SSCHECK(2);
539     SSPUSHLONG((long)(svp-PL_curpad));
540     SSPUSHINT(SAVEt_CLEARSV);
541 }
542
543 void
544 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
545 {
546     SSCHECK(4);
547     SSPUSHINT(klen);
548     SSPUSHPTR(key);
549     SSPUSHPTR(SvREFCNT_inc(hv));
550     SSPUSHINT(SAVEt_DELETE);
551 }
552
553 void
554 Perl_save_list(pTHX_ register SV **sarg, I32 maxsarg)
555 {
556     register SV *sv;
557     register I32 i;
558
559     for (i = 1; i <= maxsarg; i++) {
560         sv = NEWSV(0,0);
561         sv_setsv(sv,sarg[i]);
562         SSCHECK(3);
563         SSPUSHPTR(sarg[i]);             /* remember the pointer */
564         SSPUSHPTR(sv);                  /* remember the value */
565         SSPUSHINT(SAVEt_ITEM);
566     }
567 }
568
569 void
570 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
571 {
572     SSCHECK(3);
573     SSPUSHDPTR(f);
574     SSPUSHPTR(p);
575     SSPUSHINT(SAVEt_DESTRUCTOR);
576 }
577
578 void
579 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
580 {
581     SSCHECK(3);
582     SSPUSHDXPTR(f);
583     SSPUSHPTR(p);
584     SSPUSHINT(SAVEt_DESTRUCTOR_X);
585 }
586
587 void
588 Perl_save_aelem(pTHX_ AV *av, I32 idx, SV **sptr)
589 {
590     SV *sv;
591     SSCHECK(4);
592     SSPUSHPTR(SvREFCNT_inc(av));
593     SSPUSHINT(idx);
594     SSPUSHPTR(SvREFCNT_inc(*sptr));
595     SSPUSHINT(SAVEt_AELEM);
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             SvREFCNT_dec(gv);
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         restore_sv:
712             sv = *(SV**)ptr;
713             DEBUG_S(PerlIO_printf(Perl_debug_log,
714                                   "restore svref: %p %p:%s -> %p:%s\n",
715                                   ptr, sv, SvPEEK(sv), value, SvPEEK(value)));
716             if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv) &&
717                 SvTYPE(sv) != SVt_PVGV)
718             {
719                 (void)SvUPGRADE(value, SvTYPE(sv));
720                 SvMAGIC(value) = SvMAGIC(sv);
721                 SvFLAGS(value) |= SvMAGICAL(sv);
722                 SvMAGICAL_off(sv);
723                 SvMAGIC(sv) = 0;
724             }
725             /* XXX This branch is pretty bogus.  This code irretrievably
726              * clears(!) the magic on the SV (either to avoid further
727              * croaking that might ensue when the SvSETMAGIC() below is
728              * called, or to avoid two different SVs pointing at the same
729              * SvMAGIC()).  This needs a total rethink.  --GSAR */
730             else if (SvTYPE(value) >= SVt_PVMG && SvMAGIC(value) &&
731                      SvTYPE(value) != SVt_PVGV)
732             {
733                 SvFLAGS(value) |= (SvFLAGS(value) &
734                                   (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
735                 SvMAGICAL_off(value);
736                 /* XXX this is a leak when we get here because the
737                  * mg_get() in save_scalar_at() croaked */
738                 SvMAGIC(value) = 0;
739             }
740             SvREFCNT_dec(sv);
741             *(SV**)ptr = value;
742             PL_localizing = 2;
743             SvSETMAGIC(value);
744             PL_localizing = 0;
745             SvREFCNT_dec(value);
746             break;
747         case SAVEt_AV:                          /* array reference */
748             av = (AV*)SSPOPPTR;
749             gv = (GV*)SSPOPPTR;
750             if (GvAV(gv)) {
751                 AV *goner = GvAV(gv);
752                 SvMAGIC(av) = SvMAGIC(goner);
753                 SvFLAGS((SV*)av) |= SvMAGICAL(goner);
754                 SvMAGICAL_off(goner);
755                 SvMAGIC(goner) = 0;
756                 SvREFCNT_dec(goner);
757             }
758             GvAV(gv) = av;
759             if (SvMAGICAL(av)) {
760                 PL_localizing = 2;
761                 SvSETMAGIC((SV*)av);
762                 PL_localizing = 0;
763             }
764             break;
765         case SAVEt_HV:                          /* hash reference */
766             hv = (HV*)SSPOPPTR;
767             gv = (GV*)SSPOPPTR;
768             if (GvHV(gv)) {
769                 HV *goner = GvHV(gv);
770                 SvMAGIC(hv) = SvMAGIC(goner);
771                 SvFLAGS(hv) |= SvMAGICAL(goner);
772                 SvMAGICAL_off(goner);
773                 SvMAGIC(goner) = 0;
774                 SvREFCNT_dec(goner);
775             }
776             GvHV(gv) = hv;
777             if (SvMAGICAL(hv)) {
778                 PL_localizing = 2;
779                 SvSETMAGIC((SV*)hv);
780                 PL_localizing = 0;
781             }
782             break;
783         case SAVEt_INT:                         /* int reference */
784             ptr = SSPOPPTR;
785             *(int*)ptr = (int)SSPOPINT;
786             break;
787         case SAVEt_LONG:                        /* long reference */
788             ptr = SSPOPPTR;
789             *(long*)ptr = (long)SSPOPLONG;
790             break;
791         case SAVEt_I32:                         /* I32 reference */
792             ptr = SSPOPPTR;
793             *(I32*)ptr = (I32)SSPOPINT;
794             break;
795         case SAVEt_I16:                         /* I16 reference */
796             ptr = SSPOPPTR;
797             *(I16*)ptr = (I16)SSPOPINT;
798             break;
799         case SAVEt_I8:                          /* I8 reference */
800             ptr = SSPOPPTR;
801             *(I8*)ptr = (I8)SSPOPINT;
802             break;
803         case SAVEt_IV:                          /* IV reference */
804             ptr = SSPOPPTR;
805             *(IV*)ptr = (IV)SSPOPIV;
806             break;
807         case SAVEt_SPTR:                        /* SV* reference */
808             ptr = SSPOPPTR;
809             *(SV**)ptr = (SV*)SSPOPPTR;
810             break;
811         case SAVEt_VPTR:                        /* random* reference */
812         case SAVEt_PPTR:                        /* char* reference */
813             ptr = SSPOPPTR;
814             *(char**)ptr = (char*)SSPOPPTR;
815             break;
816         case SAVEt_HPTR:                        /* HV* reference */
817             ptr = SSPOPPTR;
818             *(HV**)ptr = (HV*)SSPOPPTR;
819             break;
820         case SAVEt_APTR:                        /* AV* reference */
821             ptr = SSPOPPTR;
822             *(AV**)ptr = (AV*)SSPOPPTR;
823             break;
824         case SAVEt_NSTAB:
825             gv = (GV*)SSPOPPTR;
826             (void)sv_clear((SV*)gv);
827             break;
828         case SAVEt_GP:                          /* scalar reference */
829             ptr = SSPOPPTR;
830             gv = (GV*)SSPOPPTR;
831             if (SvPVX(gv) && SvLEN(gv) > 0) {
832                 Safefree(SvPVX(gv));
833             }
834             SvPVX(gv) = (char *)SSPOPPTR;
835             SvCUR(gv) = (STRLEN)SSPOPIV;
836             SvLEN(gv) = (STRLEN)SSPOPIV;
837             gp_free(gv);
838             GvGP(gv) = (GP*)ptr;
839             if (GvCVu(gv))
840                 PL_sub_generation++;  /* putting a method back into circulation */
841             SvREFCNT_dec(gv);
842             break;
843         case SAVEt_FREESV:
844             ptr = SSPOPPTR;
845             SvREFCNT_dec((SV*)ptr);
846             break;
847         case SAVEt_MORTALIZESV:
848             ptr = SSPOPPTR;
849             sv_2mortal((SV*)ptr);
850             break;
851         case SAVEt_FREEOP:
852             ptr = SSPOPPTR;
853             if (PL_comppad)
854                 PL_curpad = AvARRAY(PL_comppad);
855             op_free((OP*)ptr);
856             break;
857         case SAVEt_FREEPV:
858             ptr = SSPOPPTR;
859             Safefree((char*)ptr);
860             break;
861         case SAVEt_CLEARSV:
862             ptr = (void*)&PL_curpad[SSPOPLONG];
863             sv = *(SV**)ptr;
864             /* Can clear pad variable in place? */
865             if (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) {
866                 /*
867                  * if a my variable that was made readonly is going out of
868                  * scope, we want to remove the readonlyness so that it can
869                  * go out of scope quietly
870                  */
871                 if (SvPADMY(sv) && !SvFAKE(sv))
872                     SvREADONLY_off(sv);
873
874                 if (SvTHINKFIRST(sv))
875                     sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF);
876                 if (SvMAGICAL(sv))
877                     mg_free(sv);
878
879                 switch (SvTYPE(sv)) {
880                 case SVt_NULL:
881                     break;
882                 case SVt_PVAV:
883                     av_clear((AV*)sv);
884                     break;
885                 case SVt_PVHV:
886                     hv_clear((HV*)sv);
887                     break;
888                 case SVt_PVCV:
889                     Perl_croak(aTHX_ "panic: leave_scope pad code");
890                 case SVt_RV:
891                 case SVt_IV:
892                 case SVt_NV:
893                     (void)SvOK_off(sv);
894                     break;
895                 default:
896                     (void)SvOK_off(sv);
897                     (void)SvOOK_off(sv);
898                     break;
899                 }
900             }
901             else {      /* Someone has a claim on this, so abandon it. */
902                 U32 padflags = SvFLAGS(sv) & (SVs_PADBUSY|SVs_PADMY|SVs_PADTMP);
903                 switch (SvTYPE(sv)) {   /* Console ourselves with a new value */
904                 case SVt_PVAV:  *(SV**)ptr = (SV*)newAV();      break;
905                 case SVt_PVHV:  *(SV**)ptr = (SV*)newHV();      break;
906                 default:        *(SV**)ptr = NEWSV(0,0);        break;
907                 }
908                 SvREFCNT_dec(sv);       /* Cast current value to the winds. */
909                 SvFLAGS(*(SV**)ptr) |= padflags; /* preserve pad nature */
910             }
911             break;
912         case SAVEt_DELETE:
913             ptr = SSPOPPTR;
914             hv = (HV*)ptr;
915             ptr = SSPOPPTR;
916             (void)hv_delete(hv, (char*)ptr, (U32)SSPOPINT, G_DISCARD);
917             SvREFCNT_dec(hv);
918             Safefree(ptr);
919             break;
920         case SAVEt_DESTRUCTOR:
921             ptr = SSPOPPTR;
922             (*SSPOPDPTR)(ptr);
923             break;
924         case SAVEt_DESTRUCTOR_X:
925             ptr = SSPOPPTR;
926             (*SSPOPDXPTR)(aTHX_ ptr);
927             break;
928         case SAVEt_REGCONTEXT:
929         case SAVEt_ALLOC:
930             i = SSPOPINT;
931             PL_savestack_ix -= i;       /* regexp must have croaked */
932             break;
933         case SAVEt_STACK_POS:           /* Position on Perl stack */
934             i = SSPOPINT;
935             PL_stack_sp = PL_stack_base + i;
936             break;
937         case SAVEt_AELEM:               /* array element */
938             value = (SV*)SSPOPPTR;
939             i = SSPOPINT;
940             av = (AV*)SSPOPPTR;
941             ptr = av_fetch(av,i,1);
942             if (ptr) {
943                 sv = *(SV**)ptr;
944                 if (sv && sv != &PL_sv_undef) {
945                     if (SvTIED_mg((SV*)av, PERL_MAGIC_tied))
946                         (void)SvREFCNT_inc(sv);
947                     SvREFCNT_dec(av);
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                 SV *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(hv);
966                     SvREFCNT_dec(sv);
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             break;
984         case SAVEt_COMPPAD:
985             PL_comppad = (AV*)SSPOPPTR;
986             if (PL_comppad)
987                 PL_curpad = AvARRAY(PL_comppad);
988             else
989                 PL_curpad = Null(SV**);
990             break;
991         case SAVEt_PADSV:
992             {
993                 PADOFFSET off = (PADOFFSET)SSPOPLONG;
994                 ptr = SSPOPPTR;
995                 if (ptr)
996                     ((SV**)ptr)[off] = (SV*)SSPOPPTR;
997             }
998             break;
999         default:
1000             Perl_croak(aTHX_ "panic: leave_scope inconsistency");
1001         }
1002     }
1003 }
1004
1005 void
1006 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1007 {
1008 #ifdef DEBUGGING
1009     PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1010     if (CxTYPE(cx) != CXt_SUBST) {
1011         PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1012         PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
1013                       PTR2UV(cx->blk_oldcop));
1014         PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1015         PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1016         PerlIO_printf(Perl_debug_log, "BLK_OLDRETSP = %ld\n", (long)cx->blk_oldretsp);
1017         PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
1018                       PTR2UV(cx->blk_oldpm));
1019         PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", cx->blk_gimme ? "LIST" : "SCALAR");
1020     }
1021     switch (CxTYPE(cx)) {
1022     case CXt_NULL:
1023     case CXt_BLOCK:
1024         break;
1025     case CXt_FORMAT:
1026         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1027                 PTR2UV(cx->blk_sub.cv));
1028         PerlIO_printf(Perl_debug_log, "BLK_SUB.GV = 0x%"UVxf"\n",
1029                 PTR2UV(cx->blk_sub.gv));
1030         PerlIO_printf(Perl_debug_log, "BLK_SUB.DFOUTGV = 0x%"UVxf"\n",
1031                 PTR2UV(cx->blk_sub.dfoutgv));
1032         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1033                 (int)cx->blk_sub.hasargs);
1034         break;
1035     case CXt_SUB:
1036         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1037                 PTR2UV(cx->blk_sub.cv));
1038         PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1039                 (long)cx->blk_sub.olddepth);
1040         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1041                 (int)cx->blk_sub.hasargs);
1042         PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n",
1043                 (int)cx->blk_sub.lval);
1044         break;
1045     case CXt_EVAL:
1046         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1047                 (long)cx->blk_eval.old_in_eval);
1048         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1049                 PL_op_name[cx->blk_eval.old_op_type],
1050                 PL_op_desc[cx->blk_eval.old_op_type]);
1051         if (cx->blk_eval.old_namesv)
1052             PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1053                           SvPVX(cx->blk_eval.old_namesv));
1054         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1055                 PTR2UV(cx->blk_eval.old_eval_root));
1056         break;
1057
1058     case CXt_LOOP:
1059         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n",
1060                 cx->blk_loop.label);
1061         PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
1062                 (long)cx->blk_loop.resetsp);
1063         PerlIO_printf(Perl_debug_log, "BLK_LOOP.REDO_OP = 0x%"UVxf"\n",
1064                 PTR2UV(cx->blk_loop.redo_op));
1065         PerlIO_printf(Perl_debug_log, "BLK_LOOP.NEXT_OP = 0x%"UVxf"\n",
1066                 PTR2UV(cx->blk_loop.next_op));
1067         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LAST_OP = 0x%"UVxf"\n",
1068                 PTR2UV(cx->blk_loop.last_op));
1069         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1070                 (long)cx->blk_loop.iterix);
1071         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1072                 PTR2UV(cx->blk_loop.iterary));
1073         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1074                 PTR2UV(CxITERVAR(cx)));
1075         if (CxITERVAR(cx))
1076             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERSAVE = 0x%"UVxf"\n",
1077                 PTR2UV(cx->blk_loop.itersave));
1078         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERLVAL = 0x%"UVxf"\n",
1079                 PTR2UV(cx->blk_loop.iterlval));
1080         break;
1081
1082     case CXt_SUBST:
1083         PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1084                 (long)cx->sb_iters);
1085         PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1086                 (long)cx->sb_maxiters);
1087         PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1088                 (long)cx->sb_rflags);
1089         PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1090                 (long)cx->sb_once);
1091         PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1092                 cx->sb_orig);
1093         PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1094                 PTR2UV(cx->sb_dstr));
1095         PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1096                 PTR2UV(cx->sb_targ));
1097         PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1098                 PTR2UV(cx->sb_s));
1099         PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1100                 PTR2UV(cx->sb_m));
1101         PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1102                 PTR2UV(cx->sb_strend));
1103         PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1104                 PTR2UV(cx->sb_rxres));
1105         break;
1106     }
1107 #endif  /* DEBUGGING */
1108 }