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