add better pod and headers, and clean up some whitespace issues in the previous patches
[perl.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     save_pushptri32ptr(key, klen, SvREFCNT_inc_simple(hv), SAVEt_DELETE);
509 }
510
511 void
512 Perl_save_adelete(pTHX_ AV *av, I32 key)
513 {
514     dVAR;
515
516     PERL_ARGS_ASSERT_SAVE_ADELETE;
517
518     SvREFCNT_inc_void(av);
519     save_pushi32ptr(key, av, SAVEt_ADELETE);
520 }
521
522 void
523 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
524 {
525     dVAR;
526
527     PERL_ARGS_ASSERT_SAVE_DESTRUCTOR;
528
529     SSCHECK(3);
530     SSPUSHDPTR(f);
531     SSPUSHPTR(p);
532     SSPUSHINT(SAVEt_DESTRUCTOR);
533 }
534
535 void
536 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
537 {
538     dVAR;
539     SSCHECK(3);
540     SSPUSHDXPTR(f);
541     SSPUSHPTR(p);
542     SSPUSHINT(SAVEt_DESTRUCTOR_X);
543 }
544
545 void
546 Perl_save_hints(pTHX)
547 {
548     dVAR;
549     if (PL_compiling.cop_hints_hash) {
550         HINTS_REFCNT_LOCK;
551             PL_compiling.cop_hints_hash->refcounted_he_refcnt++;
552             HINTS_REFCNT_UNLOCK;
553     }
554     if (PL_hints & HINT_LOCALIZE_HH) {
555         save_pushptri32ptr(GvHV(PL_hintgv), PL_hints,
556                            PL_compiling.cop_hints_hash, SAVEt_HINTS);
557         GvHV(PL_hintgv) = Perl_hv_copy_hints_hv(aTHX_ GvHV(PL_hintgv));
558     } else {
559         save_pushi32ptr(PL_hints, PL_compiling.cop_hints_hash, SAVEt_HINTS);
560     }
561 }
562
563 static void
564 S_save_pushptri32ptr(pTHX_ void *const ptr1, const I32 i, void *const ptr2,
565                         const int type)
566 {
567     SSCHECK(4);
568     SSPUSHPTR(ptr1);
569     SSPUSHINT(i);
570     SSPUSHPTR(ptr2);
571     SSPUSHINT(type);
572 }
573
574 void
575 Perl_save_aelem(pTHX_ AV *av, I32 idx, SV **sptr)
576 {
577     dVAR;
578     SV *sv;
579
580     PERL_ARGS_ASSERT_SAVE_AELEM;
581
582     SvGETMAGIC(*sptr);
583     save_pushptri32ptr(SvREFCNT_inc_simple(av), idx, SvREFCNT_inc(*sptr),
584                        SAVEt_AELEM);
585     /* if it gets reified later, the restore will have the wrong refcnt */
586     if (!AvREAL(av) && AvREIFY(av))
587         SvREFCNT_inc_void(*sptr);
588     save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
589     sv = *sptr;
590     /* If we're localizing a tied array element, this new sv
591      * won't actually be stored in the array - so it won't get
592      * reaped when the localize ends. Ensure it gets reaped by
593      * mortifying it instead. DAPM */
594     if (SvTIED_mg(sv, PERL_MAGIC_tiedelem))
595         sv_2mortal(sv);
596 }
597
598 void
599 Perl_save_helem_flags(pTHX_ HV *hv, SV *key, SV **sptr, const U32 flags)
600 {
601     dVAR;
602     SV *sv;
603
604     PERL_ARGS_ASSERT_SAVE_HELEM_FLAGS;
605
606     SvGETMAGIC(*sptr);
607     SSCHECK(4);
608     SSPUSHPTR(SvREFCNT_inc_simple(hv));
609     SSPUSHPTR(newSVsv(key));
610     SSPUSHPTR(SvREFCNT_inc(*sptr));
611     SSPUSHINT(SAVEt_HELEM);
612     save_scalar_at(sptr, flags);
613     sv = *sptr;
614     /* If we're localizing a tied hash element, this new sv
615      * won't actually be stored in the hash - so it won't get
616      * reaped when the localize ends. Ensure it gets reaped by
617      * mortifying it instead. DAPM */
618     if (SvTIED_mg(sv, PERL_MAGIC_tiedelem))
619         sv_2mortal(sv);
620 }
621
622 SV*
623 Perl_save_svref(pTHX_ SV **sptr)
624 {
625     dVAR;
626
627     PERL_ARGS_ASSERT_SAVE_SVREF;
628
629     SvGETMAGIC(*sptr);
630     save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_SVREF);
631     return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
632 }
633
634 I32
635 Perl_save_alloc(pTHX_ I32 size, I32 pad)
636 {
637     dVAR;
638     register const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
639                                 - (char*)PL_savestack);
640     register const I32 elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
641
642     SSGROW(elems + 2);
643
644     PL_savestack_ix += elems;
645     SSPUSHINT(elems);
646     SSPUSHINT(SAVEt_ALLOC);
647     return start;
648 }
649
650 void
651 Perl_leave_scope(pTHX_ I32 base)
652 {
653     dVAR;
654     register SV *sv;
655     register SV *value;
656     register GV *gv;
657     register AV *av;
658     register HV *hv;
659     void* ptr;
660     register char* str;
661     I32 i;
662     /* Localise the effects of the TAINT_NOT inside the loop.  */
663     const bool was = PL_tainted;
664
665     if (base < -1)
666         Perl_croak(aTHX_ "panic: corrupt saved stack index");
667     while (PL_savestack_ix > base) {
668         TAINT_NOT;
669
670         switch (SSPOPINT) {
671         case SAVEt_ITEM:                        /* normal string */
672             value = MUTABLE_SV(SSPOPPTR);
673             sv = MUTABLE_SV(SSPOPPTR);
674             sv_replace(sv,value);
675             PL_localizing = 2;
676             SvSETMAGIC(sv);
677             PL_localizing = 0;
678             break;
679         case SAVEt_SV:                          /* scalar reference */
680             value = MUTABLE_SV(SSPOPPTR);
681             gv = MUTABLE_GV(SSPOPPTR);
682             ptr = &GvSV(gv);
683             av = MUTABLE_AV(gv); /* what to refcnt_dec */
684         restore_sv:
685             sv = *(SV**)ptr;
686             *(SV**)ptr = value;
687             SvREFCNT_dec(sv);
688             PL_localizing = 2;
689             SvSETMAGIC(value);
690             PL_localizing = 0;
691             SvREFCNT_dec(value);
692             if (av) /* actually an av, hv or gv */
693                 SvREFCNT_dec(av);
694             break;
695         case SAVEt_GENERIC_PVREF:               /* generic pv */
696             ptr = SSPOPPTR;
697             str = (char*)SSPOPPTR;
698             if (*(char**)ptr != str) {
699                 Safefree(*(char**)ptr);
700                 *(char**)ptr = str;
701             }
702             break;
703         case SAVEt_SHARED_PVREF:                /* shared pv */
704             str = (char*)SSPOPPTR;
705             ptr = SSPOPPTR;
706             if (*(char**)ptr != str) {
707 #ifdef NETWARE
708                 PerlMem_free(*(char**)ptr);
709 #else
710                 PerlMemShared_free(*(char**)ptr);
711 #endif
712                 *(char**)ptr = str;
713             }
714             break;
715         case SAVEt_GENERIC_SVREF:               /* generic sv */
716             value = MUTABLE_SV(SSPOPPTR);
717             ptr = SSPOPPTR;
718             sv = *(SV**)ptr;
719             *(SV**)ptr = value;
720             SvREFCNT_dec(sv);
721             SvREFCNT_dec(value);
722             break;
723         case SAVEt_AV:                          /* array reference */
724             av = MUTABLE_AV(SSPOPPTR);
725             gv = MUTABLE_GV(SSPOPPTR);
726             if (GvAV(gv)) {
727                 SvREFCNT_dec(GvAV(gv));
728             }
729             GvAV(gv) = av;
730             if (SvMAGICAL(av)) {
731                 PL_localizing = 2;
732                 SvSETMAGIC(MUTABLE_SV(av));
733                 PL_localizing = 0;
734             }
735             break;
736         case SAVEt_HV:                          /* hash reference */
737             hv = MUTABLE_HV(SSPOPPTR);
738             gv = MUTABLE_GV(SSPOPPTR);
739             if (GvHV(gv)) {
740                 SvREFCNT_dec(GvHV(gv));
741             }
742             GvHV(gv) = hv;
743             if (SvMAGICAL(hv)) {
744                 PL_localizing = 2;
745                 SvSETMAGIC(MUTABLE_SV(hv));
746                 PL_localizing = 0;
747             }
748             break;
749         case SAVEt_INT:                         /* int reference */
750             ptr = SSPOPPTR;
751             *(int*)ptr = (int)SSPOPINT;
752             break;
753         case SAVEt_BOOL:                        /* bool reference */
754             ptr = SSPOPPTR;
755             *(bool*)ptr = (bool)SSPOPBOOL;
756             break;
757         case SAVEt_I32:                         /* I32 reference */
758             ptr = SSPOPPTR;
759 #ifdef PERL_DEBUG_READONLY_OPS
760             {
761                 const I32 val = SSPOPINT;
762                 if (*(I32*)ptr != val)
763                     *(I32*)ptr = val;
764             }
765 #else
766             *(I32*)ptr = (I32)SSPOPINT;
767 #endif
768             break;
769         case SAVEt_SPTR:                        /* SV* reference */
770             ptr = SSPOPPTR;
771             *(SV**)ptr = MUTABLE_SV(SSPOPPTR);
772             break;
773         case SAVEt_VPTR:                        /* random* reference */
774         case SAVEt_PPTR:                        /* char* reference */
775             ptr = SSPOPPTR;
776             *(char**)ptr = (char*)SSPOPPTR;
777             break;
778         case SAVEt_HPTR:                        /* HV* reference */
779             ptr = SSPOPPTR;
780             *(HV**)ptr = MUTABLE_HV(SSPOPPTR);
781             break;
782         case SAVEt_APTR:                        /* AV* reference */
783             ptr = SSPOPPTR;
784             *(AV**)ptr = MUTABLE_AV(SSPOPPTR);
785             break;
786         case SAVEt_GP:                          /* scalar reference */
787             ptr = SSPOPPTR;
788             gv = MUTABLE_GV(SSPOPPTR);
789             gp_free(gv);
790             GvGP(gv) = (GP*)ptr;
791             /* putting a method back into circulation ("local")*/
792             if (GvCVu(gv) && (hv=GvSTASH(gv)) && HvNAME_get(hv))
793                 mro_method_changed_in(hv);
794             SvREFCNT_dec(gv);
795             break;
796         case SAVEt_FREESV:
797             ptr = SSPOPPTR;
798             SvREFCNT_dec(MUTABLE_SV(ptr));
799             break;
800         case SAVEt_MORTALIZESV:
801             ptr = SSPOPPTR;
802             sv_2mortal(MUTABLE_SV(ptr));
803             break;
804         case SAVEt_FREEOP:
805             ptr = SSPOPPTR;
806             ASSERT_CURPAD_LEGAL("SAVEt_FREEOP"); /* XXX DAPM tmp */
807             op_free((OP*)ptr);
808             break;
809         case SAVEt_FREEPV:
810             ptr = SSPOPPTR;
811             Safefree(ptr);
812             break;
813         case SAVEt_CLEARSV:
814             ptr = (void*)&PL_curpad[SSPOPLONG];
815             sv = *(SV**)ptr;
816
817             DEBUG_Xv(PerlIO_printf(Perl_debug_log,
818              "Pad 0x%"UVxf"[0x%"UVxf"] clearsv: %ld sv=0x%"UVxf"<%"IVdf"> %s\n",
819                 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
820                 (long)((SV **)ptr-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
821                 (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
822             ));
823
824             /* Can clear pad variable in place? */
825             if (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) {
826                 /*
827                  * if a my variable that was made readonly is going out of
828                  * scope, we want to remove the readonlyness so that it can
829                  * go out of scope quietly
830                  */
831                 if (SvPADMY(sv) && !SvFAKE(sv))
832                     SvREADONLY_off(sv);
833
834                 if (SvTHINKFIRST(sv))
835                     sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF);
836                 if (SvMAGICAL(sv))
837                     mg_free(sv);
838
839                 switch (SvTYPE(sv)) {
840                 case SVt_NULL:
841                     break;
842                 case SVt_PVAV:
843                     av_clear(MUTABLE_AV(sv));
844                     break;
845                 case SVt_PVHV:
846                     hv_clear(MUTABLE_HV(sv));
847                     break;
848                 case SVt_PVCV:
849                     Perl_croak(aTHX_ "panic: leave_scope pad code");
850                 default:
851                     SvOK_off(sv);
852                     break;
853                 }
854                 SvPADSTALE_on(sv); /* mark as no longer live */
855             }
856             else {      /* Someone has a claim on this, so abandon it. */
857                 const U32 padflags = SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP);
858                 switch (SvTYPE(sv)) {   /* Console ourselves with a new value */
859                 case SVt_PVAV:  *(SV**)ptr = MUTABLE_SV(newAV());       break;
860                 case SVt_PVHV:  *(SV**)ptr = MUTABLE_SV(newHV());       break;
861                 default:        *(SV**)ptr = newSV(0);          break;
862                 }
863                 SvREFCNT_dec(sv);       /* Cast current value to the winds. */
864                 /* preserve pad nature, but also mark as not live
865                  * for any closure capturing */
866                 SvFLAGS(*(SV**)ptr) |= padflags | SVs_PADSTALE;
867             }
868             break;
869         case SAVEt_DELETE:
870             ptr = SSPOPPTR;
871             hv = MUTABLE_HV(ptr);
872             i = SSPOPINT;
873             ptr = SSPOPPTR;
874             (void)hv_delete(hv, (char*)ptr, i, G_DISCARD);
875             SvREFCNT_dec(hv);
876             Safefree(ptr);
877             break;
878         case SAVEt_ADELETE:
879             ptr = SSPOPPTR;
880             av = MUTABLE_AV(ptr);
881             i = SSPOPINT;
882             (void)av_delete(av, i, G_DISCARD);
883             SvREFCNT_dec(av);
884             break;
885         case SAVEt_DESTRUCTOR_X:
886             ptr = SSPOPPTR;
887             (*SSPOPDXPTR)(aTHX_ ptr);
888             break;
889         case SAVEt_REGCONTEXT:
890         case SAVEt_ALLOC:
891             i = SSPOPINT;
892             PL_savestack_ix -= i;       /* regexp must have croaked */
893             break;
894         case SAVEt_STACK_POS:           /* Position on Perl stack */
895             i = SSPOPINT;
896             PL_stack_sp = PL_stack_base + i;
897             break;
898         case SAVEt_STACK_CXPOS:         /* blk_oldsp on context stack */
899             i = SSPOPINT;
900             cxstack[i].blk_oldsp = SSPOPINT;
901             break;
902         case SAVEt_AELEM:               /* array element */
903             value = MUTABLE_SV(SSPOPPTR);
904             i = SSPOPINT;
905             av = MUTABLE_AV(SSPOPPTR);
906             ptr = av_fetch(av,i,1);
907             if (!AvREAL(av) && AvREIFY(av)) /* undo reify guard */
908                 SvREFCNT_dec(value);
909             if (ptr) {
910                 sv = *(SV**)ptr;
911                 if (sv && sv != &PL_sv_undef) {
912                     if (SvTIED_mg((const SV *)av, PERL_MAGIC_tied))
913                         SvREFCNT_inc_void_NN(sv);
914                     goto restore_sv;
915                 }
916             }
917             SvREFCNT_dec(av);
918             SvREFCNT_dec(value);
919             break;
920         case SAVEt_HELEM:               /* hash element */
921             value = MUTABLE_SV(SSPOPPTR);
922             sv = MUTABLE_SV(SSPOPPTR);
923             hv = MUTABLE_HV(SSPOPPTR);
924             ptr = hv_fetch_ent(hv, sv, 1, 0);
925             SvREFCNT_dec(sv);
926             if (ptr) {
927                 const SV * const oval = HeVAL((HE*)ptr);
928                 if (oval && oval != &PL_sv_undef) {
929                     ptr = &HeVAL((HE*)ptr);
930                     if (SvTIED_mg((const SV *)hv, PERL_MAGIC_tied))
931                         SvREFCNT_inc_void(*(SV**)ptr);
932                     av = MUTABLE_AV(hv); /* what to refcnt_dec */
933                     goto restore_sv;
934                 }
935             }
936             SvREFCNT_dec(hv);
937             SvREFCNT_dec(value);
938             break;
939         case SAVEt_OP:
940             PL_op = (OP*)SSPOPPTR;
941             break;
942         case SAVEt_HINTS:
943             if ((PL_hints & HINT_LOCALIZE_HH) && GvHV(PL_hintgv)) {
944                 SvREFCNT_dec(MUTABLE_SV(GvHV(PL_hintgv)));
945                 GvHV(PL_hintgv) = NULL;
946             }
947             Perl_refcounted_he_free(aTHX_ PL_compiling.cop_hints_hash);
948             PL_compiling.cop_hints_hash = (struct refcounted_he *) SSPOPPTR;
949             *(I32*)&PL_hints = (I32)SSPOPINT;
950             if (PL_hints & HINT_LOCALIZE_HH) {
951                 SvREFCNT_dec(MUTABLE_SV(GvHV(PL_hintgv)));
952                 GvHV(PL_hintgv) = MUTABLE_HV(SSPOPPTR);
953                 assert(GvHV(PL_hintgv));
954             } else if (!GvHV(PL_hintgv)) {
955                 /* Need to add a new one manually, else gv_fetchpv() can
956                    add one in this code:
957                    
958                    if (SvTYPE(gv) == SVt_PVGV) {
959                        if (add) {
960                        GvMULTI_on(gv);
961                        gv_init_sv(gv, sv_type);
962                        if (*name=='!' && sv_type == SVt_PVHV && len==1)
963                            require_errno(gv);
964                        }
965                        return gv;
966                    }
967
968                    and it won't have the magic set.  */
969
970                 HV *const hv = newHV();
971                 hv_magic(hv, NULL, PERL_MAGIC_hints);
972                 GvHV(PL_hintgv) = hv;
973             }
974             assert(GvHV(PL_hintgv));
975             break;
976         case SAVEt_COMPPAD:
977             PL_comppad = (PAD*)SSPOPPTR;
978             if (PL_comppad)
979                 PL_curpad = AvARRAY(PL_comppad);
980             else
981                 PL_curpad = NULL;
982             break;
983         case SAVEt_PADSV_AND_MORTALIZE:
984             {
985                 const PADOFFSET off = (PADOFFSET)SSPOPLONG;
986                 SV **svp;
987                 ptr = SSPOPPTR;
988                 assert (ptr);
989                 svp = AvARRAY((PAD*)ptr) + off;
990                 /* This mortalizing used to be done by POPLOOP() via itersave.
991                    But as we have all the information here, we can do it here,
992                    save even having to have itersave in the struct.  */
993                 sv_2mortal(*svp);
994                 *svp = MUTABLE_SV(SSPOPPTR);
995             }
996             break;
997         case SAVEt_SAVESWITCHSTACK:
998             {
999                 dSP;
1000                 AV *const t = MUTABLE_AV(SSPOPPTR);
1001                 AV *const f = MUTABLE_AV(SSPOPPTR);
1002                 SWITCHSTACK(t,f);
1003                 PL_curstackinfo->si_stack = f;
1004             }
1005             break;
1006         case SAVEt_SET_SVFLAGS:
1007             {
1008                 const U32 val  = (U32)SSPOPINT;
1009                 const U32 mask = (U32)SSPOPINT;
1010                 sv = MUTABLE_SV(SSPOPPTR);
1011                 SvFLAGS(sv) &= ~mask;
1012                 SvFLAGS(sv) |= val;
1013             }
1014             break;
1015
1016             /* This would be a mathom, but Perl_save_svref() calls a static
1017                function, S_save_scalar_at(), so has to stay in this file.  */
1018         case SAVEt_SVREF:                       /* scalar reference */
1019             value = MUTABLE_SV(SSPOPPTR);
1020             ptr = SSPOPPTR;
1021             av = NULL; /* what to refcnt_dec */
1022             goto restore_sv;
1023
1024             /* These are only saved in mathoms.c */
1025         case SAVEt_NSTAB:
1026             gv = MUTABLE_GV(SSPOPPTR);
1027             (void)sv_clear(MUTABLE_SV(gv));
1028             break;
1029         case SAVEt_LONG:                        /* long reference */
1030             ptr = SSPOPPTR;
1031             *(long*)ptr = (long)SSPOPLONG;
1032             break;
1033         case SAVEt_IV:                          /* IV reference */
1034             ptr = SSPOPPTR;
1035             *(IV*)ptr = (IV)SSPOPIV;
1036             break;
1037
1038         case SAVEt_I16:                         /* I16 reference */
1039             ptr = SSPOPPTR;
1040             *(I16*)ptr = (I16)SSPOPINT;
1041             break;
1042         case SAVEt_I8:                          /* I8 reference */
1043             ptr = SSPOPPTR;
1044             *(I8*)ptr = (I8)SSPOPINT;
1045             break;
1046         case SAVEt_DESTRUCTOR:
1047             ptr = SSPOPPTR;
1048             (*SSPOPDPTR)(ptr);
1049             break;
1050         case SAVEt_COP_ARYBASE:
1051             ptr = SSPOPPTR;
1052             i = SSPOPINT;
1053             CopARYBASE_set((COP *)ptr, i);
1054             break;
1055         case SAVEt_COMPILE_WARNINGS:
1056             ptr = SSPOPPTR;
1057
1058             if (!specialWARN(PL_compiling.cop_warnings))
1059                 PerlMemShared_free(PL_compiling.cop_warnings);
1060
1061             PL_compiling.cop_warnings = (STRLEN*)ptr;
1062             break;
1063         case SAVEt_RE_STATE:
1064             {
1065                 const struct re_save_state *const state
1066                     = (struct re_save_state *)
1067                     (PL_savestack + PL_savestack_ix
1068                      - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
1069                 PL_savestack_ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
1070
1071                 if (PL_reg_start_tmp != state->re_state_reg_start_tmp) {
1072                     Safefree(PL_reg_start_tmp);
1073                 }
1074                 if (PL_reg_poscache != state->re_state_reg_poscache) {
1075                     Safefree(PL_reg_poscache);
1076                 }
1077                 Copy(state, &PL_reg_state, 1, struct re_save_state);
1078             }
1079             break;
1080         case SAVEt_PARSER:
1081             ptr = SSPOPPTR;
1082             parser_free((yy_parser *) ptr);
1083             break;
1084         default:
1085             Perl_croak(aTHX_ "panic: leave_scope inconsistency");
1086         }
1087     }
1088
1089     PL_tainted = was;
1090 }
1091
1092 void
1093 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1094 {
1095     dVAR;
1096
1097     PERL_ARGS_ASSERT_CX_DUMP;
1098
1099 #ifdef DEBUGGING
1100     PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1101     if (CxTYPE(cx) != CXt_SUBST) {
1102         PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1103         PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
1104                       PTR2UV(cx->blk_oldcop));
1105         PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1106         PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1107         PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
1108                       PTR2UV(cx->blk_oldpm));
1109         PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", cx->blk_gimme ? "LIST" : "SCALAR");
1110     }
1111     switch (CxTYPE(cx)) {
1112     case CXt_NULL:
1113     case CXt_BLOCK:
1114         break;
1115     case CXt_FORMAT:
1116         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.CV = 0x%"UVxf"\n",
1117                 PTR2UV(cx->blk_format.cv));
1118         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.GV = 0x%"UVxf"\n",
1119                 PTR2UV(cx->blk_format.gv));
1120         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.DFOUTGV = 0x%"UVxf"\n",
1121                 PTR2UV(cx->blk_format.dfoutgv));
1122         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.HASARGS = %d\n",
1123                       (int)CxHASARGS(cx));
1124         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.RETOP = 0x%"UVxf"\n",
1125                 PTR2UV(cx->blk_format.retop));
1126         break;
1127     case CXt_SUB:
1128         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1129                 PTR2UV(cx->blk_sub.cv));
1130         PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1131                 (long)cx->blk_sub.olddepth);
1132         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1133                 (int)CxHASARGS(cx));
1134         PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n", (int)CxLVAL(cx));
1135         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1136                 PTR2UV(cx->blk_sub.retop));
1137         break;
1138     case CXt_EVAL:
1139         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1140                 (long)CxOLD_IN_EVAL(cx));
1141         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1142                 PL_op_name[CxOLD_OP_TYPE(cx)],
1143                 PL_op_desc[CxOLD_OP_TYPE(cx)]);
1144         if (cx->blk_eval.old_namesv)
1145             PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1146                           SvPVX_const(cx->blk_eval.old_namesv));
1147         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1148                 PTR2UV(cx->blk_eval.old_eval_root));
1149         PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%"UVxf"\n",
1150                 PTR2UV(cx->blk_eval.retop));
1151         break;
1152
1153     case CXt_LOOP_LAZYIV:
1154     case CXt_LOOP_LAZYSV:
1155     case CXt_LOOP_FOR:
1156     case CXt_LOOP_PLAIN:
1157         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n", CxLABEL(cx));
1158         PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
1159                 (long)cx->blk_loop.resetsp);
1160         PerlIO_printf(Perl_debug_log, "BLK_LOOP.MY_OP = 0x%"UVxf"\n",
1161                 PTR2UV(cx->blk_loop.my_op));
1162         PerlIO_printf(Perl_debug_log, "BLK_LOOP.NEXT_OP = 0x%"UVxf"\n",
1163                 PTR2UV(CX_LOOP_NEXTOP_GET(cx)));
1164         /* XXX: not accurate for LAZYSV/IV */
1165         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1166                 PTR2UV(cx->blk_loop.state_u.ary.ary));
1167         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1168                 (long)cx->blk_loop.state_u.ary.ix);
1169         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1170                 PTR2UV(CxITERVAR(cx)));
1171         break;
1172
1173     case CXt_SUBST:
1174         PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1175                 (long)cx->sb_iters);
1176         PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1177                 (long)cx->sb_maxiters);
1178         PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1179                 (long)cx->sb_rflags);
1180         PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1181                 (long)CxONCE(cx));
1182         PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1183                 cx->sb_orig);
1184         PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1185                 PTR2UV(cx->sb_dstr));
1186         PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1187                 PTR2UV(cx->sb_targ));
1188         PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1189                 PTR2UV(cx->sb_s));
1190         PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1191                 PTR2UV(cx->sb_m));
1192         PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1193                 PTR2UV(cx->sb_strend));
1194         PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1195                 PTR2UV(cx->sb_rxres));
1196         break;
1197     }
1198 #else
1199     PERL_UNUSED_CONTEXT;
1200     PERL_UNUSED_ARG(cx);
1201 #endif  /* DEBUGGING */
1202 }
1203
1204 /*
1205  * Local variables:
1206  * c-indentation-style: bsd
1207  * c-basic-offset: 4
1208  * indent-tabs-mode: t
1209  * End:
1210  *
1211  * ex: set ts=8 sts=4 sw=4 noet:
1212  */