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