This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Known test failures updates.
[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     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 }
597
598 void
599 Perl_save_helem(pTHX_ HV *hv, SV *key, SV **sptr)
600 {
601     SSCHECK(4);
602     SSPUSHPTR(SvREFCNT_inc(hv));
603     SSPUSHPTR(SvREFCNT_inc(key));
604     SSPUSHPTR(SvREFCNT_inc(*sptr));
605     SSPUSHINT(SAVEt_HELEM);
606     save_scalar_at(sptr);
607 }
608
609 void
610 Perl_save_op(pTHX)
611 {
612     SSCHECK(2);
613     SSPUSHPTR(PL_op);
614     SSPUSHINT(SAVEt_OP);
615 }
616
617 I32
618 Perl_save_alloc(pTHX_ I32 size, I32 pad)
619 {
620     register I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
621                                 - (char*)PL_savestack);
622     register I32 elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
623
624     /* SSCHECK may not be good enough */
625     while (PL_savestack_ix + elems + 2 > PL_savestack_max)
626         savestack_grow();
627
628     PL_savestack_ix += elems;
629     SSPUSHINT(elems);
630     SSPUSHINT(SAVEt_ALLOC);
631     return start;
632 }
633
634 void
635 Perl_leave_scope(pTHX_ I32 base)
636 {
637     register SV *sv;
638     register SV *value;
639     register GV *gv;
640     register AV *av;
641     register HV *hv;
642     register void* ptr;
643     register char* str;
644     I32 i;
645
646     if (base < -1)
647         Perl_croak(aTHX_ "panic: corrupt saved stack index");
648     while (PL_savestack_ix > base) {
649         switch (SSPOPINT) {
650         case SAVEt_ITEM:                        /* normal string */
651             value = (SV*)SSPOPPTR;
652             sv = (SV*)SSPOPPTR;
653             sv_replace(sv,value);
654             PL_localizing = 2;
655             SvSETMAGIC(sv);
656             PL_localizing = 0;
657             break;
658         case SAVEt_SV:                          /* scalar reference */
659             value = (SV*)SSPOPPTR;
660             gv = (GV*)SSPOPPTR;
661             ptr = &GvSV(gv);
662             SvREFCNT_dec(gv);
663             goto restore_sv;
664         case SAVEt_GENERIC_PVREF:               /* generic pv */
665             str = (char*)SSPOPPTR;
666             ptr = SSPOPPTR;
667             if (*(char**)ptr != str) {
668                 Safefree(*(char**)ptr);
669                 *(char**)ptr = str;
670             }
671             break;
672         case SAVEt_SHARED_PVREF:                /* shared pv */
673             str = (char*)SSPOPPTR;
674             ptr = SSPOPPTR;
675             if (*(char**)ptr != str) {
676                 PerlMemShared_free(*(char**)ptr);
677                 *(char**)ptr = str;
678             }
679             break;
680         case SAVEt_GENERIC_SVREF:               /* generic sv */
681             value = (SV*)SSPOPPTR;
682             ptr = SSPOPPTR;
683             sv = *(SV**)ptr;
684             *(SV**)ptr = value;
685             SvREFCNT_dec(sv);
686             SvREFCNT_dec(value);
687             break;
688         case SAVEt_SVREF:                       /* scalar reference */
689             value = (SV*)SSPOPPTR;
690             ptr = SSPOPPTR;
691         restore_sv:
692             sv = *(SV**)ptr;
693             DEBUG_S(PerlIO_printf(Perl_debug_log,
694                                   "restore svref: %p %p:%s -> %p:%s\n",
695                                   ptr, sv, SvPEEK(sv), value, SvPEEK(value)));
696             if (SvTYPE(sv) >= SVt_PVMG && SvMAGIC(sv) &&
697                 SvTYPE(sv) != SVt_PVGV)
698             {
699                 (void)SvUPGRADE(value, SvTYPE(sv));
700                 SvMAGIC(value) = SvMAGIC(sv);
701                 SvFLAGS(value) |= SvMAGICAL(sv);
702                 SvMAGICAL_off(sv);
703                 SvMAGIC(sv) = 0;
704             }
705             /* XXX This branch is pretty bogus.  This code irretrievably
706              * clears(!) the magic on the SV (either to avoid further
707              * croaking that might ensue when the SvSETMAGIC() below is
708              * called, or to avoid two different SVs pointing at the same
709              * SvMAGIC()).  This needs a total rethink.  --GSAR */
710             else if (SvTYPE(value) >= SVt_PVMG && SvMAGIC(value) &&
711                      SvTYPE(value) != SVt_PVGV)
712             {
713                 SvFLAGS(value) |= (SvFLAGS(value) &
714                                   (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
715                 SvMAGICAL_off(value);
716                 /* XXX this is a leak when we get here because the
717                  * mg_get() in save_scalar_at() croaked */
718                 SvMAGIC(value) = 0;
719             }
720             SvREFCNT_dec(sv);
721             *(SV**)ptr = value;
722             PL_localizing = 2;
723             SvSETMAGIC(value);
724             PL_localizing = 0;
725             SvREFCNT_dec(value);
726             break;
727         case SAVEt_AV:                          /* array reference */
728             av = (AV*)SSPOPPTR;
729             gv = (GV*)SSPOPPTR;
730             if (GvAV(gv)) {
731                 AV *goner = GvAV(gv);
732                 SvMAGIC(av) = SvMAGIC(goner);
733                 SvFLAGS((SV*)av) |= SvMAGICAL(goner);
734                 SvMAGICAL_off(goner);
735                 SvMAGIC(goner) = 0;
736                 SvREFCNT_dec(goner);
737             }
738             GvAV(gv) = av;
739             if (SvMAGICAL(av)) {
740                 PL_localizing = 2;
741                 SvSETMAGIC((SV*)av);
742                 PL_localizing = 0;
743             }
744             break;
745         case SAVEt_HV:                          /* hash reference */
746             hv = (HV*)SSPOPPTR;
747             gv = (GV*)SSPOPPTR;
748             if (GvHV(gv)) {
749                 HV *goner = GvHV(gv);
750                 SvMAGIC(hv) = SvMAGIC(goner);
751                 SvFLAGS(hv) |= SvMAGICAL(goner);
752                 SvMAGICAL_off(goner);
753                 SvMAGIC(goner) = 0;
754                 SvREFCNT_dec(goner);
755             }
756             GvHV(gv) = hv;
757             if (SvMAGICAL(hv)) {
758                 PL_localizing = 2;
759                 SvSETMAGIC((SV*)hv);
760                 PL_localizing = 0;
761             }
762             break;
763         case SAVEt_INT:                         /* int reference */
764             ptr = SSPOPPTR;
765             *(int*)ptr = (int)SSPOPINT;
766             break;
767         case SAVEt_LONG:                        /* long reference */
768             ptr = SSPOPPTR;
769             *(long*)ptr = (long)SSPOPLONG;
770             break;
771         case SAVEt_I32:                         /* I32 reference */
772             ptr = SSPOPPTR;
773             *(I32*)ptr = (I32)SSPOPINT;
774             break;
775         case SAVEt_I16:                         /* I16 reference */
776             ptr = SSPOPPTR;
777             *(I16*)ptr = (I16)SSPOPINT;
778             break;
779         case SAVEt_I8:                          /* I8 reference */
780             ptr = SSPOPPTR;
781             *(I8*)ptr = (I8)SSPOPINT;
782             break;
783         case SAVEt_IV:                          /* IV reference */
784             ptr = SSPOPPTR;
785             *(IV*)ptr = (IV)SSPOPIV;
786             break;
787         case SAVEt_SPTR:                        /* SV* reference */
788             ptr = SSPOPPTR;
789             *(SV**)ptr = (SV*)SSPOPPTR;
790             break;
791         case SAVEt_VPTR:                        /* random* reference */
792         case SAVEt_PPTR:                        /* char* reference */
793             ptr = SSPOPPTR;
794             *(char**)ptr = (char*)SSPOPPTR;
795             break;
796         case SAVEt_HPTR:                        /* HV* reference */
797             ptr = SSPOPPTR;
798             *(HV**)ptr = (HV*)SSPOPPTR;
799             break;
800         case SAVEt_APTR:                        /* AV* reference */
801             ptr = SSPOPPTR;
802             *(AV**)ptr = (AV*)SSPOPPTR;
803             break;
804         case SAVEt_NSTAB:
805             gv = (GV*)SSPOPPTR;
806             (void)sv_clear((SV*)gv);
807             break;
808         case SAVEt_GP:                          /* scalar reference */
809             ptr = SSPOPPTR;
810             gv = (GV*)SSPOPPTR;
811             if (SvPVX(gv) && SvLEN(gv) > 0) {
812                 Safefree(SvPVX(gv));
813             }
814             SvPVX(gv) = (char *)SSPOPPTR;
815             SvCUR(gv) = (STRLEN)SSPOPIV;
816             SvLEN(gv) = (STRLEN)SSPOPIV;
817             gp_free(gv);
818             GvGP(gv) = (GP*)ptr;
819             if (GvCVu(gv))
820                 PL_sub_generation++;  /* putting a method back into circulation */
821             SvREFCNT_dec(gv);
822             break;
823         case SAVEt_FREESV:
824             ptr = SSPOPPTR;
825             SvREFCNT_dec((SV*)ptr);
826             break;
827         case SAVEt_MORTALIZESV:
828             ptr = SSPOPPTR;
829             sv_2mortal((SV*)ptr);
830             break;
831         case SAVEt_FREEOP:
832             ptr = SSPOPPTR;
833             if (PL_comppad)
834                 PL_curpad = AvARRAY(PL_comppad);
835             op_free((OP*)ptr);
836             break;
837         case SAVEt_FREEPV:
838             ptr = SSPOPPTR;
839             Safefree((char*)ptr);
840             break;
841         case SAVEt_CLEARSV:
842             ptr = (void*)&PL_curpad[SSPOPLONG];
843             sv = *(SV**)ptr;
844             /* Can clear pad variable in place? */
845             if (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) {
846                 /*
847                  * if a my variable that was made readonly is going out of
848                  * scope, we want to remove the readonlyness so that it can
849                  * go out of scope quietly
850                  */
851                 if (SvPADMY(sv) && !SvFAKE(sv))
852                     SvREADONLY_off(sv);
853
854                 if (SvTHINKFIRST(sv))
855                     sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF);
856                 if (SvMAGICAL(sv))
857                     mg_free(sv);
858
859                 switch (SvTYPE(sv)) {
860                 case SVt_NULL:
861                     break;
862                 case SVt_PVAV:
863                     av_clear((AV*)sv);
864                     break;
865                 case SVt_PVHV:
866                     hv_clear((HV*)sv);
867                     break;
868                 case SVt_PVCV:
869                     Perl_croak(aTHX_ "panic: leave_scope pad code");
870                 case SVt_RV:
871                 case SVt_IV:
872                 case SVt_NV:
873                     (void)SvOK_off(sv);
874                     break;
875                 default:
876                     (void)SvOK_off(sv);
877                     (void)SvOOK_off(sv);
878                     break;
879                 }
880             }
881             else {      /* Someone has a claim on this, so abandon it. */
882                 U32 padflags = SvFLAGS(sv) & (SVs_PADBUSY|SVs_PADMY|SVs_PADTMP);
883                 switch (SvTYPE(sv)) {   /* Console ourselves with a new value */
884                 case SVt_PVAV:  *(SV**)ptr = (SV*)newAV();      break;
885                 case SVt_PVHV:  *(SV**)ptr = (SV*)newHV();      break;
886                 default:        *(SV**)ptr = NEWSV(0,0);        break;
887                 }
888                 SvREFCNT_dec(sv);       /* Cast current value to the winds. */
889                 SvFLAGS(*(SV**)ptr) |= padflags; /* preserve pad nature */
890             }
891             break;
892         case SAVEt_DELETE:
893             ptr = SSPOPPTR;
894             hv = (HV*)ptr;
895             ptr = SSPOPPTR;
896             (void)hv_delete(hv, (char*)ptr, (U32)SSPOPINT, G_DISCARD);
897             SvREFCNT_dec(hv);
898             Safefree(ptr);
899             break;
900         case SAVEt_DESTRUCTOR:
901             ptr = SSPOPPTR;
902             (*SSPOPDPTR)(ptr);
903             break;
904         case SAVEt_DESTRUCTOR_X:
905             ptr = SSPOPPTR;
906             (*SSPOPDXPTR)(aTHX_ ptr);
907             break;
908         case SAVEt_REGCONTEXT:
909         case SAVEt_ALLOC:
910             i = SSPOPINT;
911             PL_savestack_ix -= i;       /* regexp must have croaked */
912             break;
913         case SAVEt_STACK_POS:           /* Position on Perl stack */
914             i = SSPOPINT;
915             PL_stack_sp = PL_stack_base + i;
916             break;
917         case SAVEt_AELEM:               /* array element */
918             value = (SV*)SSPOPPTR;
919             i = SSPOPINT;
920             av = (AV*)SSPOPPTR;
921             ptr = av_fetch(av,i,1);
922             if (ptr) {
923                 sv = *(SV**)ptr;
924                 if (sv && sv != &PL_sv_undef) {
925                     if (SvTIED_mg((SV*)av, PERL_MAGIC_tied))
926                         (void)SvREFCNT_inc(sv);
927                     SvREFCNT_dec(av);
928                     goto restore_sv;
929                 }
930             }
931             SvREFCNT_dec(av);
932             SvREFCNT_dec(value);
933             break;
934         case SAVEt_HELEM:               /* hash element */
935             value = (SV*)SSPOPPTR;
936             sv = (SV*)SSPOPPTR;
937             hv = (HV*)SSPOPPTR;
938             ptr = hv_fetch_ent(hv, sv, 1, 0);
939             if (ptr) {
940                 SV *oval = HeVAL((HE*)ptr);
941                 if (oval && oval != &PL_sv_undef) {
942                     ptr = &HeVAL((HE*)ptr);
943                     if (SvTIED_mg((SV*)hv, PERL_MAGIC_tied))
944                         (void)SvREFCNT_inc(*(SV**)ptr);
945                     SvREFCNT_dec(hv);
946                     SvREFCNT_dec(sv);
947                     goto restore_sv;
948                 }
949             }
950             SvREFCNT_dec(hv);
951             SvREFCNT_dec(sv);
952             SvREFCNT_dec(value);
953             break;
954         case SAVEt_OP:
955             PL_op = (OP*)SSPOPPTR;
956             break;
957         case SAVEt_HINTS:
958             *(I32*)&PL_hints = (I32)SSPOPINT;
959             break;
960         case SAVEt_COMPPAD:
961             PL_comppad = (AV*)SSPOPPTR;
962             if (PL_comppad)
963                 PL_curpad = AvARRAY(PL_comppad);
964             else
965                 PL_curpad = Null(SV**);
966             break;
967         case SAVEt_PADSV:
968             {
969                 PADOFFSET off = (PADOFFSET)SSPOPLONG;
970                 ptr = SSPOPPTR;
971                 if (ptr)
972                     ((SV**)ptr)[off] = (SV*)SSPOPPTR;
973             }
974             break;
975         default:
976             Perl_croak(aTHX_ "panic: leave_scope inconsistency");
977         }
978     }
979 }
980
981 void
982 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
983 {
984 #ifdef DEBUGGING
985     PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
986     if (CxTYPE(cx) != CXt_SUBST) {
987         PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
988         PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
989                       PTR2UV(cx->blk_oldcop));
990         PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
991         PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
992         PerlIO_printf(Perl_debug_log, "BLK_OLDRETSP = %ld\n", (long)cx->blk_oldretsp);
993         PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
994                       PTR2UV(cx->blk_oldpm));
995         PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", cx->blk_gimme ? "LIST" : "SCALAR");
996     }
997     switch (CxTYPE(cx)) {
998     case CXt_NULL:
999     case CXt_BLOCK:
1000         break;
1001     case CXt_FORMAT:
1002         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1003                 PTR2UV(cx->blk_sub.cv));
1004         PerlIO_printf(Perl_debug_log, "BLK_SUB.GV = 0x%"UVxf"\n",
1005                 PTR2UV(cx->blk_sub.gv));
1006         PerlIO_printf(Perl_debug_log, "BLK_SUB.DFOUTGV = 0x%"UVxf"\n",
1007                 PTR2UV(cx->blk_sub.dfoutgv));
1008         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1009                 (int)cx->blk_sub.hasargs);
1010         break;
1011     case CXt_SUB:
1012         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1013                 PTR2UV(cx->blk_sub.cv));
1014         PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1015                 (long)cx->blk_sub.olddepth);
1016         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1017                 (int)cx->blk_sub.hasargs);
1018         PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n",
1019                 (int)cx->blk_sub.lval);
1020         break;
1021     case CXt_EVAL:
1022         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1023                 (long)cx->blk_eval.old_in_eval);
1024         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1025                 PL_op_name[cx->blk_eval.old_op_type],
1026                 PL_op_desc[cx->blk_eval.old_op_type]);
1027         if (cx->blk_eval.old_namesv)
1028             PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1029                           SvPVX(cx->blk_eval.old_namesv));
1030         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1031                 PTR2UV(cx->blk_eval.old_eval_root));
1032         break;
1033
1034     case CXt_LOOP:
1035         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n",
1036                 cx->blk_loop.label);
1037         PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
1038                 (long)cx->blk_loop.resetsp);
1039         PerlIO_printf(Perl_debug_log, "BLK_LOOP.REDO_OP = 0x%"UVxf"\n",
1040                 PTR2UV(cx->blk_loop.redo_op));
1041         PerlIO_printf(Perl_debug_log, "BLK_LOOP.NEXT_OP = 0x%"UVxf"\n",
1042                 PTR2UV(cx->blk_loop.next_op));
1043         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LAST_OP = 0x%"UVxf"\n",
1044                 PTR2UV(cx->blk_loop.last_op));
1045         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1046                 (long)cx->blk_loop.iterix);
1047         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1048                 PTR2UV(cx->blk_loop.iterary));
1049         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1050                 PTR2UV(CxITERVAR(cx)));
1051         if (CxITERVAR(cx))
1052             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERSAVE = 0x%"UVxf"\n",
1053                 PTR2UV(cx->blk_loop.itersave));
1054         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERLVAL = 0x%"UVxf"\n",
1055                 PTR2UV(cx->blk_loop.iterlval));
1056         break;
1057
1058     case CXt_SUBST:
1059         PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1060                 (long)cx->sb_iters);
1061         PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1062                 (long)cx->sb_maxiters);
1063         PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1064                 (long)cx->sb_rflags);
1065         PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1066                 (long)cx->sb_once);
1067         PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1068                 cx->sb_orig);
1069         PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1070                 PTR2UV(cx->sb_dstr));
1071         PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1072                 PTR2UV(cx->sb_targ));
1073         PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1074                 PTR2UV(cx->sb_s));
1075         PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1076                 PTR2UV(cx->sb_m));
1077         PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1078                 PTR2UV(cx->sb_strend));
1079         PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1080                 PTR2UV(cx->sb_rxres));
1081         break;
1082     }
1083 #endif  /* DEBUGGING */
1084 }