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