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