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