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