This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix READONLY hashes:
[perl5.git] / scope.c
1 /*    scope.c
2  *
3  *    Copyright (c) 1991-2001, 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 void
258 Perl_save_gp(pTHX_ GV *gv, I32 empty)
259 {
260     SSCHECK(6);
261     SSPUSHIV((IV)SvLEN(gv));
262     SvLEN(gv) = 0; /* forget that anything was allocated here */
263     SSPUSHIV((IV)SvCUR(gv));
264     SSPUSHPTR(SvPVX(gv));
265     SvPOK_off(gv);
266     SSPUSHPTR(SvREFCNT_inc(gv));
267     SSPUSHPTR(GvGP(gv));
268     SSPUSHINT(SAVEt_GP);
269
270     if (empty) {
271         register GP *gp;
272
273         Newz(602, gp, 1, GP);
274
275         if (GvCVu(gv))
276             PL_sub_generation++;        /* taking a method out of circulation */
277         if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
278             gp->gp_io = newIO();
279             IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
280         }
281         GvGP(gv) = gp_ref(gp);
282         GvSV(gv) = NEWSV(72,0);
283         GvLINE(gv) = CopLINE(PL_curcop);
284         GvFILE(gv) = CopFILE(PL_curcop) ? CopFILE(PL_curcop) : "";
285         GvEGV(gv) = gv;
286     }
287     else {
288         gp_ref(GvGP(gv));
289         GvINTRO_on(gv);
290     }
291 }
292
293 AV *
294 Perl_save_ary(pTHX_ GV *gv)
295 {
296     AV *oav = GvAVn(gv);
297     AV *av;
298
299     if (!AvREAL(oav) && AvREIFY(oav))
300         av_reify(oav);
301     SSCHECK(3);
302     SSPUSHPTR(gv);
303     SSPUSHPTR(oav);
304     SSPUSHINT(SAVEt_AV);
305
306     GvAV(gv) = Null(AV*);
307     av = GvAVn(gv);
308     if (SvMAGIC(oav)) {
309         SvMAGIC(av) = SvMAGIC(oav);
310         SvFLAGS((SV*)av) |= SvMAGICAL(oav);
311         SvMAGICAL_off(oav);
312         SvMAGIC(oav) = 0;
313         PL_localizing = 1;
314         SvSETMAGIC((SV*)av);
315         PL_localizing = 0;
316     }
317     return av;
318 }
319
320 HV *
321 Perl_save_hash(pTHX_ GV *gv)
322 {
323     HV *ohv, *hv;
324
325     SSCHECK(3);
326     SSPUSHPTR(gv);
327     SSPUSHPTR(ohv = GvHVn(gv));
328     SSPUSHINT(SAVEt_HV);
329
330     GvHV(gv) = Null(HV*);
331     hv = GvHVn(gv);
332     if (SvMAGIC(ohv)) {
333         SvMAGIC(hv) = SvMAGIC(ohv);
334         SvFLAGS((SV*)hv) |= SvMAGICAL(ohv);
335         SvMAGICAL_off(ohv);
336         SvMAGIC(ohv) = 0;
337         PL_localizing = 1;
338         SvSETMAGIC((SV*)hv);
339         PL_localizing = 0;
340     }
341     return hv;
342 }
343
344 void
345 Perl_save_item(pTHX_ register SV *item)
346 {
347     register SV *sv = NEWSV(0,0);
348
349     sv_setsv(sv,item);
350     SSCHECK(3);
351     SSPUSHPTR(item);            /* remember the pointer */
352     SSPUSHPTR(sv);              /* remember the value */
353     SSPUSHINT(SAVEt_ITEM);
354 }
355
356 void
357 Perl_save_int(pTHX_ int *intp)
358 {
359     SSCHECK(3);
360     SSPUSHINT(*intp);
361     SSPUSHPTR(intp);
362     SSPUSHINT(SAVEt_INT);
363 }
364
365 void
366 Perl_save_long(pTHX_ long int *longp)
367 {
368     SSCHECK(3);
369     SSPUSHLONG(*longp);
370     SSPUSHPTR(longp);
371     SSPUSHINT(SAVEt_LONG);
372 }
373
374 void
375 Perl_save_I32(pTHX_ I32 *intp)
376 {
377     SSCHECK(3);
378     SSPUSHINT(*intp);
379     SSPUSHPTR(intp);
380     SSPUSHINT(SAVEt_I32);
381 }
382
383 void
384 Perl_save_I16(pTHX_ I16 *intp)
385 {
386     SSCHECK(3);
387     SSPUSHINT(*intp);
388     SSPUSHPTR(intp);
389     SSPUSHINT(SAVEt_I16);
390 }
391
392 void
393 Perl_save_I8(pTHX_ I8 *bytep)
394 {
395     SSCHECK(3);
396     SSPUSHINT(*bytep);
397     SSPUSHPTR(bytep);
398     SSPUSHINT(SAVEt_I8);
399 }
400
401 void
402 Perl_save_iv(pTHX_ IV *ivp)
403 {
404     SSCHECK(3);
405     SSPUSHIV(*ivp);
406     SSPUSHPTR(ivp);
407     SSPUSHINT(SAVEt_IV);
408 }
409
410 /* Cannot use save_sptr() to store a char* since the SV** cast will
411  * force word-alignment and we'll miss the pointer.
412  */
413 void
414 Perl_save_pptr(pTHX_ char **pptr)
415 {
416     SSCHECK(3);
417     SSPUSHPTR(*pptr);
418     SSPUSHPTR(pptr);
419     SSPUSHINT(SAVEt_PPTR);
420 }
421
422 void
423 Perl_save_vptr(pTHX_ void *ptr)
424 {
425     SSCHECK(3);
426     SSPUSHPTR(*(char**)ptr);
427     SSPUSHPTR(ptr);
428     SSPUSHINT(SAVEt_VPTR);
429 }
430
431 void
432 Perl_save_sptr(pTHX_ SV **sptr)
433 {
434     SSCHECK(3);
435     SSPUSHPTR(*sptr);
436     SSPUSHPTR(sptr);
437     SSPUSHINT(SAVEt_SPTR);
438 }
439
440 void
441 Perl_save_padsv(pTHX_ PADOFFSET off)
442 {
443     SSCHECK(4);
444     SSPUSHPTR(PL_curpad[off]);
445     SSPUSHPTR(PL_curpad);
446     SSPUSHLONG((long)off);
447     SSPUSHINT(SAVEt_PADSV);
448 }
449
450 SV **
451 Perl_save_threadsv(pTHX_ PADOFFSET i)
452 {
453 #ifdef USE_5005THREADS
454     SV **svp = &THREADSV(i);    /* XXX Change to save by offset */
455     DEBUG_S(PerlIO_printf(Perl_debug_log, "save_threadsv %"UVuf": %p %p:%s\n",
456                           (UV)i, svp, *svp, SvPEEK(*svp)));
457     save_svref(svp);
458     return svp;
459 #else
460     Perl_croak(aTHX_ "panic: save_threadsv called in non-threaded perl");
461     return 0;
462 #endif /* USE_5005THREADS */
463 }
464
465 void
466 Perl_save_nogv(pTHX_ GV *gv)
467 {
468     SSCHECK(2);
469     SSPUSHPTR(gv);
470     SSPUSHINT(SAVEt_NSTAB);
471 }
472
473 void
474 Perl_save_hptr(pTHX_ HV **hptr)
475 {
476     SSCHECK(3);
477     SSPUSHPTR(*hptr);
478     SSPUSHPTR(hptr);
479     SSPUSHINT(SAVEt_HPTR);
480 }
481
482 void
483 Perl_save_aptr(pTHX_ AV **aptr)
484 {
485     SSCHECK(3);
486     SSPUSHPTR(*aptr);
487     SSPUSHPTR(aptr);
488     SSPUSHINT(SAVEt_APTR);
489 }
490
491 void
492 Perl_save_freesv(pTHX_ SV *sv)
493 {
494     SSCHECK(2);
495     SSPUSHPTR(sv);
496     SSPUSHINT(SAVEt_FREESV);
497 }
498
499 void
500 Perl_save_mortalizesv(pTHX_ SV *sv)
501 {
502     SSCHECK(2);
503     SSPUSHPTR(sv);
504     SSPUSHINT(SAVEt_MORTALIZESV);
505 }
506
507 void
508 Perl_save_freeop(pTHX_ OP *o)
509 {
510     SSCHECK(2);
511     SSPUSHPTR(o);
512     SSPUSHINT(SAVEt_FREEOP);
513 }
514
515 void
516 Perl_save_freepv(pTHX_ char *pv)
517 {
518     SSCHECK(2);
519     SSPUSHPTR(pv);
520     SSPUSHINT(SAVEt_FREEPV);
521 }
522
523 void
524 Perl_save_clearsv(pTHX_ SV **svp)
525 {
526     SSCHECK(2);
527     SSPUSHLONG((long)(svp-PL_curpad));
528     SSPUSHINT(SAVEt_CLEARSV);
529 }
530
531 void
532 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
533 {
534     SSCHECK(4);
535     SSPUSHINT(klen);
536     SSPUSHPTR(key);
537     SSPUSHPTR(SvREFCNT_inc(hv));
538     SSPUSHINT(SAVEt_DELETE);
539 }
540
541 void
542 Perl_save_list(pTHX_ register SV **sarg, I32 maxsarg)
543 {
544     register SV *sv;
545     register I32 i;
546
547     for (i = 1; i <= maxsarg; i++) {
548         sv = NEWSV(0,0);
549         sv_setsv(sv,sarg[i]);
550         SSCHECK(3);
551         SSPUSHPTR(sarg[i]);             /* remember the pointer */
552         SSPUSHPTR(sv);                  /* remember the value */
553         SSPUSHINT(SAVEt_ITEM);
554     }
555 }
556
557 void
558 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
559 {
560     SSCHECK(3);
561     SSPUSHDPTR(f);
562     SSPUSHPTR(p);
563     SSPUSHINT(SAVEt_DESTRUCTOR);
564 }
565
566 void
567 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
568 {
569     SSCHECK(3);
570     SSPUSHDXPTR(f);
571     SSPUSHPTR(p);
572     SSPUSHINT(SAVEt_DESTRUCTOR_X);
573 }
574
575 void
576 Perl_save_aelem(pTHX_ AV *av, I32 idx, SV **sptr)
577 {
578     SSCHECK(4);
579     SSPUSHPTR(SvREFCNT_inc(av));
580     SSPUSHINT(idx);
581     SSPUSHPTR(SvREFCNT_inc(*sptr));
582     SSPUSHINT(SAVEt_AELEM);
583     save_scalar_at(sptr);
584 }
585
586 void
587 Perl_save_helem(pTHX_ HV *hv, SV *key, SV **sptr)
588 {
589     SSCHECK(4);
590     SSPUSHPTR(SvREFCNT_inc(hv));
591     SSPUSHPTR(SvREFCNT_inc(key));
592     SSPUSHPTR(SvREFCNT_inc(*sptr));
593     SSPUSHINT(SAVEt_HELEM);
594     save_scalar_at(sptr);
595 }
596
597 void
598 Perl_save_op(pTHX)
599 {
600     SSCHECK(2);
601     SSPUSHPTR(PL_op);
602     SSPUSHINT(SAVEt_OP);
603 }
604
605 I32
606 Perl_save_alloc(pTHX_ I32 size, I32 pad)
607 {
608     register I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
609                                 - (char*)PL_savestack);
610     register I32 elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
611
612     /* SSCHECK may not be good enough */
613     while (PL_savestack_ix + elems + 2 > PL_savestack_max)
614         savestack_grow();
615
616     PL_savestack_ix += elems;
617     SSPUSHINT(elems);
618     SSPUSHINT(SAVEt_ALLOC);
619     return start;
620 }
621
622 void
623 Perl_leave_scope(pTHX_ I32 base)
624 {
625     register SV *sv;
626     register SV *value;
627     register GV *gv;
628     register AV *av;
629     register HV *hv;
630     register void* ptr;
631     register char* str;
632     I32 i;
633
634     if (base < -1)
635         Perl_croak(aTHX_ "panic: corrupt saved stack index");
636     while (PL_savestack_ix > base) {
637         switch (SSPOPINT) {
638         case SAVEt_ITEM:                        /* normal string */
639             value = (SV*)SSPOPPTR;
640             sv = (SV*)SSPOPPTR;
641             sv_replace(sv,value);
642             PL_localizing = 2;
643             SvSETMAGIC(sv);
644             PL_localizing = 0;
645             break;
646         case SAVEt_SV:                          /* scalar reference */
647             value = (SV*)SSPOPPTR;
648             gv = (GV*)SSPOPPTR;
649             ptr = &GvSV(gv);
650             SvREFCNT_dec(gv);
651             goto restore_sv;
652         case SAVEt_GENERIC_PVREF:               /* generic pv */
653             str = (char*)SSPOPPTR;
654             ptr = SSPOPPTR;
655             if (*(char**)ptr != str) {
656                 Safefree(*(char**)ptr);
657                 *(char**)ptr = str;
658             }
659             break;
660         case SAVEt_GENERIC_SVREF:               /* generic sv */
661             value = (SV*)SSPOPPTR;
662             ptr = SSPOPPTR;
663             sv = *(SV**)ptr;
664             *(SV**)ptr = value;
665             SvREFCNT_dec(sv);
666             SvREFCNT_dec(value);
667             break;
668         case SAVEt_SVREF:                       /* scalar reference */
669             value = (SV*)SSPOPPTR;
670             ptr = SSPOPPTR;
671         restore_sv:
672             sv = *(SV**)ptr;
673             DEBUG_S(PerlIO_printf(Perl_debug_log,
674                                   "restore svref: %p %p:%s -> %p:%s\n",
675                                   ptr, sv, SvPEEK(sv), value, SvPEEK(value)));
676             if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv) &&
677                 SvTYPE(sv) != SVt_PVGV)
678             {
679                 (void)SvUPGRADE(value, SvTYPE(sv));
680                 SvMAGIC(value) = SvMAGIC(sv);
681                 SvFLAGS(value) |= SvMAGICAL(sv);
682                 SvMAGICAL_off(sv);
683                 SvMAGIC(sv) = 0;
684             }
685             /* XXX This branch is pretty bogus.  This code irretrievably
686              * clears(!) the magic on the SV (either to avoid further
687              * croaking that might ensue when the SvSETMAGIC() below is
688              * called, or to avoid two different SVs pointing at the same
689              * SvMAGIC()).  This needs a total rethink.  --GSAR */
690             else if (SvTYPE(value) >= SVt_PVMG && SvMAGIC(value) &&
691                      SvTYPE(value) != SVt_PVGV)
692             {
693                 SvFLAGS(value) |= (SvFLAGS(value) &
694                                   (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
695                 SvMAGICAL_off(value);
696                 /* XXX this is a leak when we get here because the
697                  * mg_get() in save_scalar_at() croaked */
698                 SvMAGIC(value) = 0;
699             }
700             SvREFCNT_dec(sv);
701             *(SV**)ptr = value;
702             PL_localizing = 2;
703             SvSETMAGIC(value);
704             PL_localizing = 0;
705             SvREFCNT_dec(value);
706             break;
707         case SAVEt_AV:                          /* array reference */
708             av = (AV*)SSPOPPTR;
709             gv = (GV*)SSPOPPTR;
710             if (GvAV(gv)) {
711                 AV *goner = GvAV(gv);
712                 SvMAGIC(av) = SvMAGIC(goner);
713                 SvFLAGS((SV*)av) |= SvMAGICAL(goner);
714                 SvMAGICAL_off(goner);
715                 SvMAGIC(goner) = 0;
716                 SvREFCNT_dec(goner);
717             }
718             GvAV(gv) = av;
719             if (SvMAGICAL(av)) {
720                 PL_localizing = 2;
721                 SvSETMAGIC((SV*)av);
722                 PL_localizing = 0;
723             }
724             break;
725         case SAVEt_HV:                          /* hash reference */
726             hv = (HV*)SSPOPPTR;
727             gv = (GV*)SSPOPPTR;
728             if (GvHV(gv)) {
729                 HV *goner = GvHV(gv);
730                 SvMAGIC(hv) = SvMAGIC(goner);
731                 SvFLAGS(hv) |= SvMAGICAL(goner);
732                 SvMAGICAL_off(goner);
733                 SvMAGIC(goner) = 0;
734                 SvREFCNT_dec(goner);
735             }
736             GvHV(gv) = hv;
737             if (SvMAGICAL(hv)) {
738                 PL_localizing = 2;
739                 SvSETMAGIC((SV*)hv);
740                 PL_localizing = 0;
741             }
742             break;
743         case SAVEt_INT:                         /* int reference */
744             ptr = SSPOPPTR;
745             *(int*)ptr = (int)SSPOPINT;
746             break;
747         case SAVEt_LONG:                        /* long reference */
748             ptr = SSPOPPTR;
749             *(long*)ptr = (long)SSPOPLONG;
750             break;
751         case SAVEt_I32:                         /* I32 reference */
752             ptr = SSPOPPTR;
753             *(I32*)ptr = (I32)SSPOPINT;
754             break;
755         case SAVEt_I16:                         /* I16 reference */
756             ptr = SSPOPPTR;
757             *(I16*)ptr = (I16)SSPOPINT;
758             break;
759         case SAVEt_I8:                          /* I8 reference */
760             ptr = SSPOPPTR;
761             *(I8*)ptr = (I8)SSPOPINT;
762             break;
763         case SAVEt_IV:                          /* IV reference */
764             ptr = SSPOPPTR;
765             *(IV*)ptr = (IV)SSPOPIV;
766             break;
767         case SAVEt_SPTR:                        /* SV* reference */
768             ptr = SSPOPPTR;
769             *(SV**)ptr = (SV*)SSPOPPTR;
770             break;
771         case SAVEt_VPTR:                        /* random* reference */
772         case SAVEt_PPTR:                        /* char* reference */
773             ptr = SSPOPPTR;
774             *(char**)ptr = (char*)SSPOPPTR;
775             break;
776         case SAVEt_HPTR:                        /* HV* reference */
777             ptr = SSPOPPTR;
778             *(HV**)ptr = (HV*)SSPOPPTR;
779             break;
780         case SAVEt_APTR:                        /* AV* reference */
781             ptr = SSPOPPTR;
782             *(AV**)ptr = (AV*)SSPOPPTR;
783             break;
784         case SAVEt_NSTAB:
785             gv = (GV*)SSPOPPTR;
786             (void)sv_clear((SV*)gv);
787             break;
788         case SAVEt_GP:                          /* scalar reference */
789             ptr = SSPOPPTR;
790             gv = (GV*)SSPOPPTR;
791             if (SvPVX(gv) && SvLEN(gv) > 0) {
792                 Safefree(SvPVX(gv));
793             }
794             SvPVX(gv) = (char *)SSPOPPTR;
795             SvCUR(gv) = (STRLEN)SSPOPIV;
796             SvLEN(gv) = (STRLEN)SSPOPIV;
797             gp_free(gv);
798             GvGP(gv) = (GP*)ptr;
799             if (GvCVu(gv))
800                 PL_sub_generation++;  /* putting a method back into circulation */
801             SvREFCNT_dec(gv);
802             break;
803         case SAVEt_FREESV:
804             ptr = SSPOPPTR;
805             SvREFCNT_dec((SV*)ptr);
806             break;
807         case SAVEt_MORTALIZESV:
808             ptr = SSPOPPTR;
809             sv_2mortal((SV*)ptr);
810             break;
811         case SAVEt_FREEOP:
812             ptr = SSPOPPTR;
813             if (PL_comppad)
814                 PL_curpad = AvARRAY(PL_comppad);
815             op_free((OP*)ptr);
816             break;
817         case SAVEt_FREEPV:
818             ptr = SSPOPPTR;
819             Safefree((char*)ptr);
820             break;
821         case SAVEt_CLEARSV:
822             ptr = (void*)&PL_curpad[SSPOPLONG];
823             sv = *(SV**)ptr;
824             /* Can clear pad variable in place? */
825             if (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) {
826                 /*
827                  * if a my variable that was made readonly is going out of
828                  * scope, we want to remove the readonlyness so that it can
829                  * go out of scope quietly
830                  */
831                 if (SvPADMY(sv) && !SvFAKE(sv))
832                     SvREADONLY_off(sv);
833
834                 if (SvTHINKFIRST(sv))
835                     sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF);
836                 if (SvMAGICAL(sv))
837                     mg_free(sv);
838
839                 switch (SvTYPE(sv)) {
840                 case SVt_NULL:
841                     break;
842                 case SVt_PVAV:
843                     av_clear((AV*)sv);
844                     break;
845                 case SVt_PVHV:
846                     hv_clear((HV*)sv);
847                     break;
848                 case SVt_PVCV:
849                     Perl_croak(aTHX_ "panic: leave_scope pad code");
850                 case SVt_RV:
851                 case SVt_IV:
852                 case SVt_NV:
853                     (void)SvOK_off(sv);
854                     break;
855                 default:
856                     (void)SvOK_off(sv);
857                     (void)SvOOK_off(sv);
858                     break;
859                 }
860             }
861             else {      /* Someone has a claim on this, so abandon it. */
862                 U32 padflags = SvFLAGS(sv) & (SVs_PADBUSY|SVs_PADMY|SVs_PADTMP);
863                 switch (SvTYPE(sv)) {   /* Console ourselves with a new value */
864                 case SVt_PVAV:  *(SV**)ptr = (SV*)newAV();      break;
865                 case SVt_PVHV:  *(SV**)ptr = (SV*)newHV();      break;
866                 default:        *(SV**)ptr = NEWSV(0,0);        break;
867                 }
868                 SvREFCNT_dec(sv);       /* Cast current value to the winds. */
869                 SvFLAGS(*(SV**)ptr) |= padflags; /* preserve pad nature */
870             }
871             break;
872         case SAVEt_DELETE:
873             ptr = SSPOPPTR;
874             hv = (HV*)ptr;
875             ptr = SSPOPPTR;
876             (void)hv_delete(hv, (char*)ptr, (U32)SSPOPINT, G_DISCARD);
877             SvREFCNT_dec(hv);
878             Safefree(ptr);
879             break;
880         case SAVEt_DESTRUCTOR:
881             ptr = SSPOPPTR;
882             (*SSPOPDPTR)(ptr);
883             break;
884         case SAVEt_DESTRUCTOR_X:
885             ptr = SSPOPPTR;
886             (*SSPOPDXPTR)(aTHX_ ptr);
887             break;
888         case SAVEt_REGCONTEXT:
889         case SAVEt_ALLOC:
890             i = SSPOPINT;
891             PL_savestack_ix -= i;       /* regexp must have croaked */
892             break;
893         case SAVEt_STACK_POS:           /* Position on Perl stack */
894             i = SSPOPINT;
895             PL_stack_sp = PL_stack_base + i;
896             break;
897         case SAVEt_AELEM:               /* array element */
898             value = (SV*)SSPOPPTR;
899             i = SSPOPINT;
900             av = (AV*)SSPOPPTR;
901             ptr = av_fetch(av,i,1);
902             if (ptr) {
903                 sv = *(SV**)ptr;
904                 if (sv && sv != &PL_sv_undef) {
905                     if (SvTIED_mg((SV*)av, PERL_MAGIC_tied))
906                         (void)SvREFCNT_inc(sv);
907                     SvREFCNT_dec(av);
908                     goto restore_sv;
909                 }
910             }
911             SvREFCNT_dec(av);
912             SvREFCNT_dec(value);
913             break;
914         case SAVEt_HELEM:               /* hash element */
915             value = (SV*)SSPOPPTR;
916             sv = (SV*)SSPOPPTR;
917             hv = (HV*)SSPOPPTR;
918             ptr = hv_fetch_ent(hv, sv, 1, 0);
919             if (ptr) {
920                 SV *oval = HeVAL((HE*)ptr);
921                 if (oval && oval != &PL_sv_undef) {
922                     ptr = &HeVAL((HE*)ptr);
923                     if (SvTIED_mg((SV*)hv, PERL_MAGIC_tied))
924                         (void)SvREFCNT_inc(*(SV**)ptr);
925                     SvREFCNT_dec(hv);
926                     SvREFCNT_dec(sv);
927                     goto restore_sv;
928                 }
929             }
930             SvREFCNT_dec(hv);
931             SvREFCNT_dec(sv);
932             SvREFCNT_dec(value);
933             break;
934         case SAVEt_OP:
935             PL_op = (OP*)SSPOPPTR;
936             break;
937         case SAVEt_HINTS:
938             *(I32*)&PL_hints = (I32)SSPOPINT;
939             break;
940         case SAVEt_COMPPAD:
941             PL_comppad = (AV*)SSPOPPTR;
942             if (PL_comppad)
943                 PL_curpad = AvARRAY(PL_comppad);
944             else
945                 PL_curpad = Null(SV**);
946             break;
947         case SAVEt_PADSV:
948             {
949                 PADOFFSET off = (PADOFFSET)SSPOPLONG;
950                 ptr = SSPOPPTR;
951                 if (ptr)
952                     ((SV**)ptr)[off] = (SV*)SSPOPPTR;
953             }
954             break;
955         default:
956             Perl_croak(aTHX_ "panic: leave_scope inconsistency");
957         }
958     }
959 }
960
961 void
962 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
963 {
964 #ifdef DEBUGGING
965     PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
966     if (CxTYPE(cx) != CXt_SUBST) {
967         PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
968         PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
969                       PTR2UV(cx->blk_oldcop));
970         PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
971         PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
972         PerlIO_printf(Perl_debug_log, "BLK_OLDRETSP = %ld\n", (long)cx->blk_oldretsp);
973         PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
974                       PTR2UV(cx->blk_oldpm));
975         PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", cx->blk_gimme ? "LIST" : "SCALAR");
976     }
977     switch (CxTYPE(cx)) {
978     case CXt_NULL:
979     case CXt_BLOCK:
980         break;
981     case CXt_FORMAT:
982         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
983                 PTR2UV(cx->blk_sub.cv));
984         PerlIO_printf(Perl_debug_log, "BLK_SUB.GV = 0x%"UVxf"\n",
985                 PTR2UV(cx->blk_sub.gv));
986         PerlIO_printf(Perl_debug_log, "BLK_SUB.DFOUTGV = 0x%"UVxf"\n",
987                 PTR2UV(cx->blk_sub.dfoutgv));
988         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
989                 (int)cx->blk_sub.hasargs);
990         break;
991     case CXt_SUB:
992         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
993                 PTR2UV(cx->blk_sub.cv));
994         PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
995                 (long)cx->blk_sub.olddepth);
996         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
997                 (int)cx->blk_sub.hasargs);
998         PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n",
999                 (int)cx->blk_sub.lval);
1000         break;
1001     case CXt_EVAL:
1002         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1003                 (long)cx->blk_eval.old_in_eval);
1004         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1005                 PL_op_name[cx->blk_eval.old_op_type],
1006                 PL_op_desc[cx->blk_eval.old_op_type]);
1007         if (cx->blk_eval.old_namesv)
1008             PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1009                           SvPVX(cx->blk_eval.old_namesv));
1010         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1011                 PTR2UV(cx->blk_eval.old_eval_root));
1012         break;
1013
1014     case CXt_LOOP:
1015         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n",
1016                 cx->blk_loop.label);
1017         PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
1018                 (long)cx->blk_loop.resetsp);
1019         PerlIO_printf(Perl_debug_log, "BLK_LOOP.REDO_OP = 0x%"UVxf"\n",
1020                 PTR2UV(cx->blk_loop.redo_op));
1021         PerlIO_printf(Perl_debug_log, "BLK_LOOP.NEXT_OP = 0x%"UVxf"\n",
1022                 PTR2UV(cx->blk_loop.next_op));
1023         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LAST_OP = 0x%"UVxf"\n",
1024                 PTR2UV(cx->blk_loop.last_op));
1025         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1026                 (long)cx->blk_loop.iterix);
1027         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1028                 PTR2UV(cx->blk_loop.iterary));
1029         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1030                 PTR2UV(CxITERVAR(cx)));
1031         if (CxITERVAR(cx))
1032             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERSAVE = 0x%"UVxf"\n",
1033                 PTR2UV(cx->blk_loop.itersave));
1034         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERLVAL = 0x%"UVxf"\n",
1035                 PTR2UV(cx->blk_loop.iterlval));
1036         break;
1037
1038     case CXt_SUBST:
1039         PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1040                 (long)cx->sb_iters);
1041         PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1042                 (long)cx->sb_maxiters);
1043         PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1044                 (long)cx->sb_rflags);
1045         PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1046                 (long)cx->sb_once);
1047         PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1048                 cx->sb_orig);
1049         PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1050                 PTR2UV(cx->sb_dstr));
1051         PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1052                 PTR2UV(cx->sb_targ));
1053         PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1054                 PTR2UV(cx->sb_s));
1055         PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1056                 PTR2UV(cx->sb_m));
1057         PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1058                 PTR2UV(cx->sb_strend));
1059         PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1060                 PTR2UV(cx->sb_rxres));
1061         break;
1062     }
1063 #endif  /* DEBUGGING */
1064 }