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