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