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