toke.c:S_parse_opt_lexvar: Don’t use null terminator
[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, SSize_t n)
31 {
32     PERL_ARGS_ASSERT_STACK_GROW;
33
34     PL_stack_sp = sp;
35 #ifndef STRESS_REALLOC
36     av_extend(PL_curstack, (p - PL_stack_base) + (n) + 128);
37 #else
38     av_extend(PL_curstack, (p - PL_stack_base) + (n) + 1);
39 #endif
40     return PL_stack_sp;
41 }
42
43 #ifndef STRESS_REALLOC
44 #define GROW(old) ((old) * 3 / 2)
45 #else
46 #define GROW(old) ((old) + 1)
47 #endif
48
49 PERL_SI *
50 Perl_new_stackinfo(pTHX_ I32 stitems, I32 cxitems)
51 {
52     PERL_SI *si;
53     Newx(si, 1, PERL_SI);
54     si->si_stack = newAV();
55     AvREAL_off(si->si_stack);
56     av_extend(si->si_stack, stitems > 0 ? stitems-1 : 0);
57     AvALLOC(si->si_stack)[0] = &PL_sv_undef;
58     AvFILLp(si->si_stack) = 0;
59     si->si_prev = 0;
60     si->si_next = 0;
61     si->si_cxmax = cxitems - 1;
62     si->si_cxix = -1;
63     si->si_type = PERLSI_UNDEF;
64     Newx(si->si_cxstack, cxitems, PERL_CONTEXT);
65     /* Without any kind of initialising PUSHSUBST()
66      * in pp_subst() will read uninitialised heap. */
67     PoisonNew(si->si_cxstack, cxitems, PERL_CONTEXT);
68     return si;
69 }
70
71 I32
72 Perl_cxinc(pTHX)
73 {
74     const IV old_max = cxstack_max;
75     cxstack_max = GROW(cxstack_max);
76     Renew(cxstack, cxstack_max + 1, PERL_CONTEXT);
77     /* Without any kind of initialising deep enough recursion
78      * will end up reading uninitialised PERL_CONTEXTs. */
79     PoisonNew(cxstack + old_max + 1, cxstack_max - old_max, PERL_CONTEXT);
80     return cxstack_ix + 1;
81 }
82
83 void
84 Perl_push_scope(pTHX)
85 {
86     if (UNLIKELY(PL_scopestack_ix == PL_scopestack_max)) {
87         PL_scopestack_max = GROW(PL_scopestack_max);
88         Renew(PL_scopestack, PL_scopestack_max, I32);
89 #ifdef DEBUGGING
90         Renew(PL_scopestack_name, PL_scopestack_max, const char*);
91 #endif
92     }
93 #ifdef DEBUGGING
94     PL_scopestack_name[PL_scopestack_ix] = "unknown";
95 #endif
96     PL_scopestack[PL_scopestack_ix++] = PL_savestack_ix;
97
98 }
99
100 void
101 Perl_pop_scope(pTHX)
102 {
103     const I32 oldsave = PL_scopestack[--PL_scopestack_ix];
104     LEAVE_SCOPE(oldsave);
105 }
106
107 I32 *
108 Perl_markstack_grow(pTHX)
109 {
110     const I32 oldmax = PL_markstack_max - PL_markstack;
111     const I32 newmax = GROW(oldmax);
112
113     Renew(PL_markstack, newmax, I32);
114     PL_markstack_max = PL_markstack + newmax;
115     PL_markstack_ptr = PL_markstack + oldmax;
116     return PL_markstack_ptr;
117 }
118
119 void
120 Perl_savestack_grow(pTHX)
121 {
122     PL_savestack_max = GROW(PL_savestack_max) + 4;
123     Renew(PL_savestack, PL_savestack_max, ANY);
124 }
125
126 void
127 Perl_savestack_grow_cnt(pTHX_ I32 need)
128 {
129     PL_savestack_max = PL_savestack_ix + need;
130     Renew(PL_savestack, PL_savestack_max, ANY);
131 }
132
133 #undef GROW
134
135 void
136 Perl_tmps_grow(pTHX_ SSize_t n)
137 {
138 #ifndef STRESS_REALLOC
139     if (n < 128)
140         n = (PL_tmps_max < 512) ? 128 : 512;
141 #endif
142     PL_tmps_max = PL_tmps_ix + n + 1;
143     Renew(PL_tmps_stack, PL_tmps_max, SV*);
144 }
145
146
147 void
148 Perl_free_tmps(pTHX)
149 {
150     /* XXX should tmps_floor live in cxstack? */
151     const SSize_t myfloor = PL_tmps_floor;
152     while (PL_tmps_ix > myfloor) {      /* clean up after last statement */
153         SV* const sv = PL_tmps_stack[PL_tmps_ix--];
154 #ifdef PERL_POISON
155         PoisonWith(PL_tmps_stack + PL_tmps_ix + 1, 1, SV *, 0xAB);
156 #endif
157         if (LIKELY(sv && sv != &PL_sv_undef)) {
158             SvTEMP_off(sv);
159             SvREFCNT_dec_NN(sv);                /* note, can modify tmps_ix!!! */
160         }
161     }
162 }
163
164 STATIC SV *
165 S_save_scalar_at(pTHX_ SV **sptr, const U32 flags)
166 {
167     SV * osv;
168     SV *sv;
169
170     PERL_ARGS_ASSERT_SAVE_SCALAR_AT;
171
172     osv = *sptr;
173     sv  = (flags & SAVEf_KEEPOLDELEM) ? osv : (*sptr = newSV(0));
174
175     if (SvTYPE(osv) >= SVt_PVMG && SvMAGIC(osv)) {
176         if (SvGMAGICAL(osv)) {
177             SvFLAGS(osv) |= (SvFLAGS(osv) &
178                (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
179         }
180         if (!(flags & SAVEf_KEEPOLDELEM))
181             mg_localize(osv, sv, cBOOL(flags & SAVEf_SETMAGIC));
182     }
183
184     return sv;
185 }
186
187 void
188 Perl_save_pushptrptr(pTHX_ void *const ptr1, void *const ptr2, const int type)
189 {
190     dSS_ADD;
191     SS_ADD_PTR(ptr1);
192     SS_ADD_PTR(ptr2);
193     SS_ADD_UV(type);
194     SS_ADD_END(3);
195 }
196
197 SV *
198 Perl_save_scalar(pTHX_ GV *gv)
199 {
200     SV ** const sptr = &GvSVn(gv);
201
202     PERL_ARGS_ASSERT_SAVE_SCALAR;
203
204     if (UNLIKELY(SvGMAGICAL(*sptr))) {
205         PL_localizing = 1;
206         (void)mg_get(*sptr);
207         PL_localizing = 0;
208     }
209     save_pushptrptr(SvREFCNT_inc_simple(gv), SvREFCNT_inc(*sptr), SAVEt_SV);
210     return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
211 }
212
213 /* Like save_sptr(), but also SvREFCNT_dec()s the new value.  Can be used to
214  * restore a global SV to its prior contents, freeing new value. */
215 void
216 Perl_save_generic_svref(pTHX_ SV **sptr)
217 {
218     PERL_ARGS_ASSERT_SAVE_GENERIC_SVREF;
219
220     save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_GENERIC_SVREF);
221 }
222
223 /* Like save_pptr(), but also Safefree()s the new value if it is different
224  * from the old one.  Can be used to restore a global char* to its prior
225  * contents, freeing new value. */
226 void
227 Perl_save_generic_pvref(pTHX_ char **str)
228 {
229     PERL_ARGS_ASSERT_SAVE_GENERIC_PVREF;
230
231     save_pushptrptr(*str, str, SAVEt_GENERIC_PVREF);
232 }
233
234 /* Like save_generic_pvref(), but uses PerlMemShared_free() rather than Safefree().
235  * Can be used to restore a shared global char* to its prior
236  * contents, freeing new value. */
237 void
238 Perl_save_shared_pvref(pTHX_ char **str)
239 {
240     PERL_ARGS_ASSERT_SAVE_SHARED_PVREF;
241
242     save_pushptrptr(str, *str, SAVEt_SHARED_PVREF);
243 }
244
245 /* set the SvFLAGS specified by mask to the values in val */
246
247 void
248 Perl_save_set_svflags(pTHX_ SV* sv, U32 mask, U32 val)
249 {
250     dSS_ADD;
251
252     PERL_ARGS_ASSERT_SAVE_SET_SVFLAGS;
253
254     SS_ADD_PTR(sv);
255     SS_ADD_INT(mask);
256     SS_ADD_INT(val);
257     SS_ADD_UV(SAVEt_SET_SVFLAGS);
258     SS_ADD_END(4);
259 }
260
261 void
262 Perl_save_gp(pTHX_ GV *gv, I32 empty)
263 {
264     PERL_ARGS_ASSERT_SAVE_GP;
265
266     save_pushptrptr(SvREFCNT_inc(gv), GvGP(gv), SAVEt_GP);
267
268     if (empty) {
269         GP *gp = Perl_newGP(aTHX_ gv);
270         HV * const stash = GvSTASH(gv);
271         bool isa_changed = 0;
272
273         if (stash && HvENAME(stash)) {
274             if (GvNAMELEN(gv) == 3 && strnEQ(GvNAME(gv), "ISA", 3))
275                 isa_changed = TRUE;
276             else if (GvCVu(gv))
277                 /* taking a method out of circulation ("local")*/
278                 mro_method_changed_in(stash);
279         }
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         GvGP_set(gv,gp);
285         if (isa_changed) mro_isa_changed_in(stash);
286     }
287     else {
288         gp_ref(GvGP(gv));
289         GvINTRO_on(gv);
290     }
291 }
292
293 AV *
294 Perl_save_ary(pTHX_ GV *gv)
295 {
296     AV * const oav = GvAVn(gv);
297     AV *av;
298
299     PERL_ARGS_ASSERT_SAVE_ARY;
300
301     if (UNLIKELY(!AvREAL(oav) && AvREIFY(oav)))
302         av_reify(oav);
303     save_pushptrptr(SvREFCNT_inc_simple_NN(gv), oav, SAVEt_AV);
304
305     GvAV(gv) = NULL;
306     av = GvAVn(gv);
307     if (UNLIKELY(SvMAGIC(oav)))
308         mg_localize(MUTABLE_SV(oav), MUTABLE_SV(av), TRUE);
309     return av;
310 }
311
312 HV *
313 Perl_save_hash(pTHX_ GV *gv)
314 {
315     HV *ohv, *hv;
316
317     PERL_ARGS_ASSERT_SAVE_HASH;
318
319     save_pushptrptr(
320         SvREFCNT_inc_simple_NN(gv), (ohv = GvHVn(gv)), SAVEt_HV
321     );
322
323     GvHV(gv) = NULL;
324     hv = GvHVn(gv);
325     if (UNLIKELY(SvMAGIC(ohv)))
326         mg_localize(MUTABLE_SV(ohv), MUTABLE_SV(hv), TRUE);
327     return hv;
328 }
329
330 void
331 Perl_save_item(pTHX_ SV *item)
332 {
333     SV * const sv = newSVsv(item);
334
335     PERL_ARGS_ASSERT_SAVE_ITEM;
336
337     save_pushptrptr(item, /* remember the pointer */
338                     sv,   /* remember the value */
339                     SAVEt_ITEM);
340 }
341
342 void
343 Perl_save_bool(pTHX_ bool *boolp)
344 {
345     dSS_ADD;
346
347     PERL_ARGS_ASSERT_SAVE_BOOL;
348
349     SS_ADD_PTR(boolp);
350     SS_ADD_UV(SAVEt_BOOL | (*boolp << 8));
351     SS_ADD_END(2);
352 }
353
354 void
355 Perl_save_pushi32ptr(pTHX_ const I32 i, void *const ptr, const int type)
356 {
357     dSS_ADD;
358
359     SS_ADD_INT(i);
360     SS_ADD_PTR(ptr);
361     SS_ADD_UV(type);
362     SS_ADD_END(3);
363 }
364
365 void
366 Perl_save_int(pTHX_ int *intp)
367 {
368     const int i = *intp;
369     UV type = ((UV)((UV)i << SAVE_TIGHT_SHIFT) | SAVEt_INT_SMALL);
370     int size = 2;
371     dSS_ADD;
372
373     PERL_ARGS_ASSERT_SAVE_INT;
374
375     if (UNLIKELY((int)(type >> SAVE_TIGHT_SHIFT) != i)) {
376         SS_ADD_INT(i);
377         type = SAVEt_INT;
378         size++;
379     }
380     SS_ADD_PTR(intp);
381     SS_ADD_UV(type);
382     SS_ADD_END(size);
383 }
384
385 void
386 Perl_save_I8(pTHX_ I8 *bytep)
387 {
388     dSS_ADD;
389
390     PERL_ARGS_ASSERT_SAVE_I8;
391
392     SS_ADD_PTR(bytep);
393     SS_ADD_UV(SAVEt_I8 | ((UV)*bytep << 8));
394     SS_ADD_END(2);
395 }
396
397 void
398 Perl_save_I16(pTHX_ I16 *intp)
399 {
400     dSS_ADD;
401
402     PERL_ARGS_ASSERT_SAVE_I16;
403
404     SS_ADD_PTR(intp);
405     SS_ADD_UV(SAVEt_I16 | ((UV)*intp << 8));
406     SS_ADD_END(2);
407 }
408
409 void
410 Perl_save_I32(pTHX_ I32 *intp)
411 {
412     const I32 i = *intp;
413     UV type = ((I32)((U32)i << SAVE_TIGHT_SHIFT) | SAVEt_I32_SMALL);
414     int size = 2;
415     dSS_ADD;
416
417     PERL_ARGS_ASSERT_SAVE_I32;
418
419     if (UNLIKELY((I32)(type >> SAVE_TIGHT_SHIFT) != i)) {
420         SS_ADD_INT(i);
421         type = SAVEt_I32;
422         size++;
423     }
424     SS_ADD_PTR(intp);
425     SS_ADD_UV(type);
426     SS_ADD_END(size);
427 }
428
429 void
430 Perl_save_strlen(pTHX_ STRLEN *ptr)
431 {
432     dSS_ADD;
433
434     PERL_ARGS_ASSERT_SAVE_STRLEN;
435
436     SS_ADD_IV(*ptr);
437     SS_ADD_PTR(ptr);
438     SS_ADD_UV(SAVEt_STRLEN);
439     SS_ADD_END(3);
440 }
441
442 /* Cannot use save_sptr() to store a char* since the SV** cast will
443  * force word-alignment and we'll miss the pointer.
444  */
445 void
446 Perl_save_pptr(pTHX_ char **pptr)
447 {
448     PERL_ARGS_ASSERT_SAVE_PPTR;
449
450     save_pushptrptr(*pptr, pptr, SAVEt_PPTR);
451 }
452
453 void
454 Perl_save_vptr(pTHX_ void *ptr)
455 {
456     PERL_ARGS_ASSERT_SAVE_VPTR;
457
458     save_pushptrptr(*(char**)ptr, ptr, SAVEt_VPTR);
459 }
460
461 void
462 Perl_save_sptr(pTHX_ SV **sptr)
463 {
464     PERL_ARGS_ASSERT_SAVE_SPTR;
465
466     save_pushptrptr(*sptr, sptr, SAVEt_SPTR);
467 }
468
469 void
470 Perl_save_padsv_and_mortalize(pTHX_ PADOFFSET off)
471 {
472     dSS_ADD;
473
474     ASSERT_CURPAD_ACTIVE("save_padsv");
475     SS_ADD_PTR(SvREFCNT_inc_simple_NN(PL_curpad[off]));
476     SS_ADD_PTR(PL_comppad);
477     SS_ADD_UV((UV)off);
478     SS_ADD_UV(SAVEt_PADSV_AND_MORTALIZE);
479     SS_ADD_END(4);
480 }
481
482 void
483 Perl_save_hptr(pTHX_ HV **hptr)
484 {
485     PERL_ARGS_ASSERT_SAVE_HPTR;
486
487     save_pushptrptr(*hptr, hptr, SAVEt_HPTR);
488 }
489
490 void
491 Perl_save_aptr(pTHX_ AV **aptr)
492 {
493     PERL_ARGS_ASSERT_SAVE_APTR;
494
495     save_pushptrptr(*aptr, aptr, SAVEt_APTR);
496 }
497
498 void
499 Perl_save_pushptr(pTHX_ void *const ptr, const int type)
500 {
501     dSS_ADD;
502     SS_ADD_PTR(ptr);
503     SS_ADD_UV(type);
504     SS_ADD_END(2);
505 }
506
507 void
508 Perl_save_clearsv(pTHX_ SV **svp)
509 {
510     const UV offset = svp - PL_curpad;
511     const UV offset_shifted = offset << SAVE_TIGHT_SHIFT;
512
513     PERL_ARGS_ASSERT_SAVE_CLEARSV;
514
515     ASSERT_CURPAD_ACTIVE("save_clearsv");
516     SvPADSTALE_off(*svp); /* mark lexical as active */
517     if (UNLIKELY((offset_shifted >> SAVE_TIGHT_SHIFT) != offset)) {
518         Perl_croak(aTHX_ "panic: pad offset %"UVuf" out of range (%p-%p)",
519                    offset, svp, PL_curpad);
520     }
521
522     {
523         dSS_ADD;
524         SS_ADD_UV(offset_shifted | SAVEt_CLEARSV);
525         SS_ADD_END(1);
526     }
527 }
528
529 void
530 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
531 {
532     PERL_ARGS_ASSERT_SAVE_DELETE;
533
534     save_pushptri32ptr(key, klen, SvREFCNT_inc_simple(hv), SAVEt_DELETE);
535 }
536
537 void
538 Perl_save_hdelete(pTHX_ HV *hv, SV *keysv)
539 {
540     STRLEN len;
541     I32 klen;
542     const char *key;
543
544     PERL_ARGS_ASSERT_SAVE_HDELETE;
545
546     key  = SvPV_const(keysv, len);
547     klen = SvUTF8(keysv) ? -(I32)len : (I32)len;
548     SvREFCNT_inc_simple_void_NN(hv);
549     save_pushptri32ptr(savepvn(key, len), klen, hv, SAVEt_DELETE);
550 }
551
552 void
553 Perl_save_adelete(pTHX_ AV *av, SSize_t key)
554 {
555     dSS_ADD;
556
557     PERL_ARGS_ASSERT_SAVE_ADELETE;
558
559     SvREFCNT_inc_void(av);
560     SS_ADD_UV(key);
561     SS_ADD_PTR(av);
562     SS_ADD_IV(SAVEt_ADELETE);
563     SS_ADD_END(3);
564 }
565
566 void
567 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
568 {
569     dSS_ADD;
570     PERL_ARGS_ASSERT_SAVE_DESTRUCTOR;
571
572     SS_ADD_DPTR(f);
573     SS_ADD_PTR(p);
574     SS_ADD_UV(SAVEt_DESTRUCTOR);
575     SS_ADD_END(3);
576 }
577
578 void
579 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
580 {
581     dSS_ADD;
582
583     SS_ADD_DXPTR(f);
584     SS_ADD_PTR(p);
585     SS_ADD_UV(SAVEt_DESTRUCTOR_X);
586     SS_ADD_END(3);
587 }
588
589 void
590 Perl_save_hints(pTHX)
591 {
592     COPHH *save_cophh = cophh_copy(CopHINTHASH_get(&PL_compiling));
593     if (PL_hints & HINT_LOCALIZE_HH) {
594         HV *oldhh = GvHV(PL_hintgv);
595         save_pushptri32ptr(oldhh, PL_hints, save_cophh, SAVEt_HINTS);
596         GvHV(PL_hintgv) = NULL; /* in case copying dies */
597         GvHV(PL_hintgv) = hv_copy_hints_hv(oldhh);
598     } else {
599         save_pushi32ptr(PL_hints, save_cophh, SAVEt_HINTS);
600     }
601 }
602
603 static void
604 S_save_pushptri32ptr(pTHX_ void *const ptr1, const I32 i, void *const ptr2,
605                         const int type)
606 {
607     dSS_ADD;
608     SS_ADD_PTR(ptr1);
609     SS_ADD_INT(i);
610     SS_ADD_PTR(ptr2);
611     SS_ADD_UV(type);
612     SS_ADD_END(4);
613 }
614
615 void
616 Perl_save_aelem_flags(pTHX_ AV *av, SSize_t idx, SV **sptr,
617                             const U32 flags)
618 {
619     dSS_ADD;
620     SV *sv;
621
622     PERL_ARGS_ASSERT_SAVE_AELEM_FLAGS;
623
624     SvGETMAGIC(*sptr);
625     SS_ADD_PTR(SvREFCNT_inc_simple(av));
626     SS_ADD_IV(idx);
627     SS_ADD_PTR(SvREFCNT_inc(*sptr));
628     SS_ADD_UV(SAVEt_AELEM);
629     SS_ADD_END(4);
630     /* The array needs to hold a reference count on its new element, so it
631        must be AvREAL. */
632     if (UNLIKELY(!AvREAL(av) && AvREIFY(av)))
633         av_reify(av);
634     save_scalar_at(sptr, flags); /* XXX - FIXME - see #60360 */
635     if (flags & SAVEf_KEEPOLDELEM)
636         return;
637     sv = *sptr;
638     /* If we're localizing a tied array element, this new sv
639      * won't actually be stored in the array - so it won't get
640      * reaped when the localize ends. Ensure it gets reaped by
641      * mortifying it instead. DAPM */
642     if (UNLIKELY(SvTIED_mg((const SV *)av, PERL_MAGIC_tied)))
643         sv_2mortal(sv);
644 }
645
646 void
647 Perl_save_helem_flags(pTHX_ HV *hv, SV *key, SV **sptr, const U32 flags)
648 {
649     SV *sv;
650
651     PERL_ARGS_ASSERT_SAVE_HELEM_FLAGS;
652
653     SvGETMAGIC(*sptr);
654     {
655         dSS_ADD;
656         SS_ADD_PTR(SvREFCNT_inc_simple(hv));
657         SS_ADD_PTR(newSVsv(key));
658         SS_ADD_PTR(SvREFCNT_inc(*sptr));
659         SS_ADD_UV(SAVEt_HELEM);
660         SS_ADD_END(4);
661     }
662     save_scalar_at(sptr, flags);
663     if (flags & SAVEf_KEEPOLDELEM)
664         return;
665     sv = *sptr;
666     /* If we're localizing a tied hash element, this new sv
667      * won't actually be stored in the hash - so it won't get
668      * reaped when the localize ends. Ensure it gets reaped by
669      * mortifying it instead. DAPM */
670     if (UNLIKELY(SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)))
671         sv_2mortal(sv);
672 }
673
674 SV*
675 Perl_save_svref(pTHX_ SV **sptr)
676 {
677     PERL_ARGS_ASSERT_SAVE_SVREF;
678
679     SvGETMAGIC(*sptr);
680     save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_SVREF);
681     return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
682 }
683
684 I32
685 Perl_save_alloc(pTHX_ I32 size, I32 pad)
686 {
687     const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
688                           - (char*)PL_savestack);
689     const UV elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
690     const UV elems_shifted = elems << SAVE_TIGHT_SHIFT;
691
692     if (UNLIKELY((elems_shifted >> SAVE_TIGHT_SHIFT) != elems))
693         Perl_croak(aTHX_
694             "panic: save_alloc elems %"UVuf" out of range (%"IVdf"-%"IVdf")",
695                    elems, (IV)size, (IV)pad);
696
697     SSGROW(elems + 1);
698
699     PL_savestack_ix += elems;
700     SSPUSHUV(SAVEt_ALLOC | elems_shifted);
701     return start;
702 }
703
704 void
705 Perl_save_aliased_sv(pTHX_ GV *gv)
706 {
707     dSS_ADD;
708     PERL_ARGS_ASSERT_SAVE_ALIASED_SV;
709     SS_ADD_PTR(gp_ref(GvGP(gv)));
710     SS_ADD_UV(SAVEt_GP_ALIASED_SV | cBOOL(GvALIASED_SV(gv)) << 8);
711     SS_ADD_END(2);
712 }
713
714
715
716 #define ARG0_SV  MUTABLE_SV(arg0.any_ptr)
717 #define ARG0_AV  MUTABLE_AV(arg0.any_ptr)
718 #define ARG0_HV  MUTABLE_HV(arg0.any_ptr)
719 #define ARG0_PTR arg0.any_ptr
720 #define ARG0_PV  (char*)(arg0.any_ptr)
721 #define ARG0_PVP (char**)(arg0.any_ptr)
722 #define ARG0_I32 (arg0.any_i32)
723
724 #define ARG1_SV  MUTABLE_SV(arg1.any_ptr)
725 #define ARG1_AV  MUTABLE_AV(arg1.any_ptr)
726 #define ARG1_GV  MUTABLE_GV(arg1.any_ptr)
727 #define ARG1_SVP (SV**)(arg1.any_ptr)
728 #define ARG1_PVP (char**)(arg1.any_ptr)
729 #define ARG1_PTR arg1.any_ptr
730 #define ARG1_PV  (char*)(arg1.any_ptr)
731 #define ARG1_I32 (arg1.any_i32)
732
733 #define ARG2_SV  MUTABLE_SV(arg2.any_ptr)
734 #define ARG2_AV  MUTABLE_AV(arg2.any_ptr)
735 #define ARG2_HV  MUTABLE_HV(arg2.any_ptr)
736 #define ARG2_GV  MUTABLE_GV(arg2.any_ptr)
737 #define ARG2_PV  (char*)(arg2.any_ptr)
738
739 void
740 Perl_leave_scope(pTHX_ I32 base)
741 {
742     /* Localise the effects of the TAINT_NOT inside the loop.  */
743     bool was = TAINT_get;
744
745     ANY arg0, arg1, arg2;
746
747     /* these initialisations are logically unnecessary, but they shut up
748      * spurious 'may be used uninitialized' compiler warnings */
749     arg0.any_ptr = NULL;
750     arg1.any_ptr = NULL;
751     arg2.any_ptr = NULL;
752
753     if (UNLIKELY(base < -1))
754         Perl_croak(aTHX_ "panic: corrupt saved stack index %ld", (long) base);
755     DEBUG_l(Perl_deb(aTHX_ "savestack: releasing items %ld -> %ld\n",
756                         (long)PL_savestack_ix, (long)base));
757     while (PL_savestack_ix > base) {
758         UV uv;
759         U8 type;
760
761         SV *refsv;
762         SV **svp;
763
764         TAINT_NOT;
765
766         {
767             I32 ix = PL_savestack_ix - 1;
768             ANY *p = &PL_savestack[ix];
769             uv = p->any_uv;
770             type = (U8)uv & SAVE_MASK;
771             if (type > SAVEt_ARG0_MAX) {
772                 ANY *p0 = p;
773                 arg0 = *--p;
774                 if (type > SAVEt_ARG1_MAX) {
775                     arg1 = *--p;
776                     if (type > SAVEt_ARG2_MAX) {
777                         arg2 = *--p;
778                     }
779                 }
780                 ix -= (p0 - p);
781             }
782             PL_savestack_ix = ix;
783         }
784
785         switch (type) {
786         case SAVEt_ITEM:                        /* normal string */
787             sv_replace(ARG1_SV, ARG0_SV);
788             if (UNLIKELY(SvSMAGICAL(ARG1_SV))) {
789                 PL_localizing = 2;
790                 mg_set(ARG1_SV);
791                 PL_localizing = 0;
792             }
793             break;
794
795             /* This would be a mathom, but Perl_save_svref() calls a static
796                function, S_save_scalar_at(), so has to stay in this file.  */
797         case SAVEt_SVREF:                       /* scalar reference */
798             svp = ARG1_SVP;
799             refsv = NULL; /* what to refcnt_dec */
800             goto restore_sv;
801
802         case SAVEt_SV:                          /* scalar reference */
803             svp = &GvSV(ARG1_GV);
804             refsv = ARG1_SV; /* what to refcnt_dec */
805         restore_sv:
806         {
807             SV * const sv = *svp;
808             *svp = ARG0_SV;
809             SvREFCNT_dec(sv);
810             if (UNLIKELY(SvSMAGICAL(ARG0_SV))) {
811                 PL_localizing = 2;
812                 mg_set(ARG0_SV);
813                 PL_localizing = 0;
814             }
815             SvREFCNT_dec_NN(ARG0_SV);
816             SvREFCNT_dec(refsv);
817             break;
818         }
819         case SAVEt_GENERIC_PVREF:               /* generic pv */
820             if (*ARG0_PVP != ARG1_PV) {
821                 Safefree(*ARG0_PVP);
822                 *ARG0_PVP = ARG1_PV;
823             }
824             break;
825         case SAVEt_SHARED_PVREF:                /* shared pv */
826             if (*ARG1_PVP != ARG0_PV) {
827 #ifdef NETWARE
828                 PerlMem_free(*ARG1_PVP);
829 #else
830                 PerlMemShared_free(*ARG1_PVP);
831 #endif
832                 *ARG1_PVP = ARG0_PV;
833             }
834             break;
835         case SAVEt_GVSV:                        /* scalar slot in GV */
836             svp = &GvSV(ARG1_GV);
837             goto restore_svp;
838         case SAVEt_GENERIC_SVREF:               /* generic sv */
839             svp = ARG1_SVP;
840         restore_svp:
841         {
842             SV * const sv = *svp;
843             *svp = ARG0_SV;
844             SvREFCNT_dec(sv);
845             SvREFCNT_dec(ARG0_SV);
846             break;
847         }
848         case SAVEt_GVSLOT:                      /* any slot in GV */
849         {
850             HV *const hv = GvSTASH(ARG2_GV);
851             svp = ARG1_SVP;
852             if (hv && HvENAME(hv) && (
853                     (ARG0_SV && SvTYPE(ARG0_SV) == SVt_PVCV)
854                  || (*svp && SvTYPE(*svp) == SVt_PVCV)
855                ))
856             {
857                 if ((char *)svp < (char *)GvGP(ARG2_GV)
858                  || (char *)svp > (char *)GvGP(ARG2_GV) + sizeof(struct gp)
859                  || GvREFCNT(ARG2_GV) > 2) /* "> 2" to ignore savestack's ref */
860                     PL_sub_generation++;
861                 else mro_method_changed_in(hv);
862             }
863             goto restore_svp;
864         }
865         case SAVEt_AV:                          /* array reference */
866             SvREFCNT_dec(GvAV(ARG1_GV));
867             GvAV(ARG1_GV) = ARG0_AV;
868             if (UNLIKELY(SvSMAGICAL(ARG0_SV))) {
869                 PL_localizing = 2;
870                 mg_set(ARG0_SV);
871                 PL_localizing = 0;
872             }
873             SvREFCNT_dec_NN(ARG1_GV);
874             break;
875         case SAVEt_HV:                          /* hash reference */
876             SvREFCNT_dec(GvHV(ARG1_GV));
877             GvHV(ARG1_GV) = ARG0_HV;
878             if (UNLIKELY(SvSMAGICAL(ARG0_SV))) {
879                 PL_localizing = 2;
880                 mg_set(ARG0_SV);
881                 PL_localizing = 0;
882             }
883             SvREFCNT_dec_NN(ARG1_GV);
884             break;
885         case SAVEt_INT_SMALL:
886             *(int*)ARG0_PTR = (int)(uv >> SAVE_TIGHT_SHIFT);
887             break;
888         case SAVEt_INT:                         /* int reference */
889             *(int*)ARG0_PTR = (int)ARG1_I32;
890             break;
891         case SAVEt_STRLEN:                      /* STRLEN/size_t ref */
892             *(STRLEN*)ARG0_PTR = (STRLEN)arg1.any_iv;
893             break;
894         case SAVEt_BOOL:                        /* bool reference */
895             *(bool*)ARG0_PTR = cBOOL(uv >> 8);
896 #ifdef NO_TAINT_SUPPORT
897             PERL_UNUSED_VAR(was);
898 #else
899             if (UNLIKELY(ARG0_PTR == &(TAINT_get))) {
900                 /* If we don't update <was>, to reflect what was saved on the
901                  * stack for PL_tainted, then we will overwrite this attempt to
902                  * restore it when we exit this routine.  Note that this won't
903                  * work if this value was saved in a wider-than necessary type,
904                  * such as I32 */
905                 was = *(bool*)ARG0_PTR;
906             }
907 #endif
908             break;
909         case SAVEt_I32_SMALL:
910             *(I32*)ARG0_PTR = (I32)(uv >> SAVE_TIGHT_SHIFT);
911             break;
912         case SAVEt_I32:                         /* I32 reference */
913 #ifdef PERL_DEBUG_READONLY_OPS
914             if (*(I32*)ARG0_PTR != ARG1_I32)
915 #endif
916                 *(I32*)ARG0_PTR = ARG1_I32;
917             break;
918         case SAVEt_SPTR:                        /* SV* reference */
919             *(SV**)(ARG0_PTR)= ARG1_SV;
920             break;
921         case SAVEt_VPTR:                        /* random* reference */
922         case SAVEt_PPTR:                        /* char* reference */
923             *ARG0_PVP = ARG1_PV;
924             break;
925         case SAVEt_HPTR:                        /* HV* reference */
926             *(HV**)ARG0_PTR = MUTABLE_HV(ARG1_PTR);
927             break;
928         case SAVEt_APTR:                        /* AV* reference */
929             *(AV**)ARG0_PTR = ARG1_AV;
930             break;
931         case SAVEt_GP:                          /* scalar reference */
932         {
933             HV *hv;
934             /* possibly taking a method out of circulation */   
935             const bool had_method = !!GvCVu(ARG1_GV);
936             gp_free(ARG1_GV);
937             GvGP_set(ARG1_GV, (GP*)ARG0_PTR);
938             if ((hv=GvSTASH(ARG1_GV)) && HvENAME_get(hv)) {
939                 if (   GvNAMELEN(ARG1_GV) == 3
940                     && strnEQ(GvNAME(ARG1_GV), "ISA", 3)
941                 )
942                     mro_isa_changed_in(hv);
943                 else if (had_method || GvCVu(ARG1_GV))
944                     /* putting a method back into circulation ("local")*/       
945                     gv_method_changed(ARG1_GV);
946             }
947             SvREFCNT_dec_NN(ARG1_GV);
948             break;
949         }
950         case SAVEt_FREESV:
951             SvREFCNT_dec(ARG0_SV);
952             break;
953         case SAVEt_FREECOPHH:
954             cophh_free((COPHH *)ARG0_PTR);
955             break;
956         case SAVEt_MORTALIZESV:
957             sv_2mortal(ARG0_SV);
958             break;
959         case SAVEt_FREEOP:
960             ASSERT_CURPAD_LEGAL("SAVEt_FREEOP");
961             op_free((OP*)ARG0_PTR);
962             break;
963         case SAVEt_FREEPV:
964             Safefree(ARG0_PTR);
965             break;
966
967         {
968           SV **svp;
969           I32 i;
970           SV *sv;
971
972         case SAVEt_CLEARPADRANGE:
973             i = (I32)((uv >> SAVE_TIGHT_SHIFT) & OPpPADRANGE_COUNTMASK);
974             svp = &PL_curpad[uv >>
975                     (OPpPADRANGE_COUNTSHIFT + SAVE_TIGHT_SHIFT)] + i - 1;
976             goto clearsv;
977         case SAVEt_CLEARSV:
978             svp = &PL_curpad[uv >> SAVE_TIGHT_SHIFT];
979             i = 1;
980           clearsv:
981             for (; i; i--, svp--) {
982                 sv = *svp;
983
984                 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
985              "Pad 0x%"UVxf"[0x%"UVxf"] clearsv: %ld sv=0x%"UVxf"<%"IVdf"> %s\n",
986                     PTR2UV(PL_comppad), PTR2UV(PL_curpad),
987                     (long)(svp-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
988                     (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
989                 ));
990
991                 assert(SvPADMY(sv));
992
993                 /* Can clear pad variable in place? */
994                 if (SvREFCNT(sv) == 1 && !SvOBJECT(sv)) {
995
996                     /* these flags are the union of all the relevant flags
997                      * in the individual conditions within */
998                     if (UNLIKELY(SvFLAGS(sv) & (
999                             SVf_READONLY|SVf_PROTECT /*for SvREADONLY_off*/
1000                           | (SVs_GMG|SVs_SMG|SVs_RMG) /* SvMAGICAL() */
1001                           | SVf_OOK
1002                           | SVf_THINKFIRST)))
1003                     {
1004                         /* if a my variable that was made readonly is
1005                          * going out of scope, we want to remove the
1006                          * readonlyness so that it can go out of scope
1007                          * quietly
1008                          */
1009                         if (SvREADONLY(sv))
1010                             SvREADONLY_off(sv);
1011
1012                         if (SvOOK(sv)) { /* OOK or HvAUX */
1013                             if (SvTYPE(sv) == SVt_PVHV)
1014                                 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
1015                             else
1016                                 sv_backoff(sv);
1017                         }
1018
1019                         if (SvMAGICAL(sv)) {
1020                             /* note that backrefs (either in HvAUX or magic)
1021                              * must be removed before other magic */
1022                             sv_unmagic(sv, PERL_MAGIC_backref);
1023                             if (SvTYPE(sv) != SVt_PVCV)
1024                                 mg_free(sv);
1025                         }
1026                         if (SvTHINKFIRST(sv))
1027                             sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF
1028                                                      |SV_COW_DROP_PV);
1029
1030                     }
1031                     switch (SvTYPE(sv)) {
1032                     case SVt_NULL:
1033                         break;
1034                     case SVt_PVAV:
1035                         av_clear(MUTABLE_AV(sv));
1036                         break;
1037                     case SVt_PVHV:
1038                         hv_clear(MUTABLE_HV(sv));
1039                         break;
1040                     case SVt_PVCV:
1041                     {
1042                         HEK *hek =
1043                               CvNAMED(sv)
1044                                 ? CvNAME_HEK((CV *)sv)
1045                                 : GvNAME_HEK(CvGV(sv));
1046                         assert(hek);
1047                         (void)share_hek_hek(hek);
1048                         cv_undef((CV *)sv);
1049                         CvNAME_HEK_set(sv, hek);
1050                         CvLEXICAL_on(sv);
1051                         break;
1052                     }
1053                     default:
1054                         /* This looks odd, but these two macros are for use in
1055                            expressions and finish with a trailing comma, so
1056                            adding a ; after them would be wrong. */
1057                         assert_not_ROK(sv)
1058                         assert_not_glob(sv)
1059                         SvFLAGS(sv) &=~ (SVf_OK|SVf_IVisUV|SVf_UTF8);
1060                         break;
1061                     }
1062                     SvPADSTALE_on(sv); /* mark as no longer live */
1063                 }
1064                 else {  /* Someone has a claim on this, so abandon it. */
1065                     assert(!(SvFLAGS(sv) & SVs_PADTMP));
1066                     switch (SvTYPE(sv)) {       /* Console ourselves with a new value */
1067                     case SVt_PVAV:      *svp = MUTABLE_SV(newAV());     break;
1068                     case SVt_PVHV:      *svp = MUTABLE_SV(newHV());     break;
1069                     case SVt_PVCV:
1070                     {
1071                         HEK * const hek = CvNAMED(sv)
1072                                              ? CvNAME_HEK((CV *)sv)
1073                                              : GvNAME_HEK(CvGV(sv));
1074
1075                         /* Create a stub */
1076                         *svp = newSV_type(SVt_PVCV);
1077
1078                         /* Share name */
1079                         CvNAME_HEK_set(*svp,
1080                                        share_hek_hek(hek));
1081                         CvLEXICAL_on(*svp);
1082                         break;
1083                     }
1084                     default:    *svp = newSV(0);                break;
1085                     }
1086                     SvREFCNT_dec_NN(sv); /* Cast current value to the winds. */
1087                     /* preserve pad nature, but also mark as not live
1088                      * for any closure capturing */
1089                     SvFLAGS(*svp) |= SVs_PADSTALE;
1090                 }
1091             }
1092             break;
1093         }
1094         case SAVEt_DELETE:
1095             (void)hv_delete(ARG0_HV, ARG2_PV, ARG1_I32, G_DISCARD);
1096             SvREFCNT_dec(ARG0_HV);
1097             Safefree(arg2.any_ptr);
1098             break;
1099         case SAVEt_ADELETE:
1100             (void)av_delete(ARG0_AV, arg1.any_iv, G_DISCARD);
1101             SvREFCNT_dec(ARG0_AV);
1102             break;
1103         case SAVEt_DESTRUCTOR_X:
1104             (*arg1.any_dxptr)(aTHX_ ARG0_PTR);
1105             break;
1106         case SAVEt_REGCONTEXT:
1107             /* regexp must have croaked */
1108         case SAVEt_ALLOC:
1109             PL_savestack_ix -= uv >> SAVE_TIGHT_SHIFT;
1110             break;
1111         case SAVEt_STACK_POS:           /* Position on Perl stack */
1112             PL_stack_sp = PL_stack_base + arg0.any_i32;
1113             break;
1114         case SAVEt_AELEM:               /* array element */
1115             svp = av_fetch(ARG2_AV, arg1.any_iv, 1);
1116             if (UNLIKELY(!AvREAL(ARG2_AV) && AvREIFY(ARG2_AV))) /* undo reify guard */
1117                 SvREFCNT_dec(ARG0_SV);
1118             if (LIKELY(svp)) {
1119                 SV * const sv = *svp;
1120                 if (LIKELY(sv && sv != &PL_sv_undef)) {
1121                     if (UNLIKELY(SvTIED_mg((const SV *)ARG2_AV, PERL_MAGIC_tied)))
1122                         SvREFCNT_inc_void_NN(sv);
1123                     refsv = ARG2_SV;
1124                     goto restore_sv;
1125                 }
1126             }
1127             SvREFCNT_dec(ARG2_AV);
1128             SvREFCNT_dec(ARG0_SV);
1129             break;
1130         case SAVEt_HELEM:               /* hash element */
1131         {
1132             HE * const he = hv_fetch_ent(ARG2_HV, ARG1_SV, 1, 0);
1133             SvREFCNT_dec(ARG1_SV);
1134             if (LIKELY(he)) {
1135                 const SV * const oval = HeVAL(he);
1136                 if (LIKELY(oval && oval != &PL_sv_undef)) {
1137                     svp = &HeVAL(he);
1138                     if (UNLIKELY(SvTIED_mg((const SV *)ARG2_HV, PERL_MAGIC_tied)))
1139                         SvREFCNT_inc_void(*svp);
1140                     refsv = ARG2_SV; /* what to refcnt_dec */
1141                     goto restore_sv;
1142                 }
1143             }
1144             SvREFCNT_dec(ARG2_HV);
1145             SvREFCNT_dec(ARG0_SV);
1146             break;
1147         }
1148         case SAVEt_OP:
1149             PL_op = (OP*)ARG0_PTR;
1150             break;
1151         case SAVEt_HINTS:
1152             if ((PL_hints & HINT_LOCALIZE_HH)) {
1153               while (GvHV(PL_hintgv)) {
1154                 HV *hv = GvHV(PL_hintgv);
1155                 GvHV(PL_hintgv) = NULL;
1156                 SvREFCNT_dec(MUTABLE_SV(hv));
1157               }
1158             }
1159             cophh_free(CopHINTHASH_get(&PL_compiling));
1160             CopHINTHASH_set(&PL_compiling, (COPHH*)ARG0_PTR);
1161             *(I32*)&PL_hints = ARG1_I32;
1162             if (PL_hints & HINT_LOCALIZE_HH) {
1163                 SvREFCNT_dec(MUTABLE_SV(GvHV(PL_hintgv)));
1164                 GvHV(PL_hintgv) = MUTABLE_HV(SSPOPPTR);
1165             }
1166             if (!GvHV(PL_hintgv)) {
1167                 /* Need to add a new one manually, else rv2hv can
1168                    add one via GvHVn and it won't have the magic set.  */
1169                 HV *const hv = newHV();
1170                 hv_magic(hv, NULL, PERL_MAGIC_hints);
1171                 GvHV(PL_hintgv) = hv;
1172             }
1173             assert(GvHV(PL_hintgv));
1174             break;
1175         case SAVEt_COMPPAD:
1176             PL_comppad = (PAD*)ARG0_PTR;
1177             if (LIKELY(PL_comppad))
1178                 PL_curpad = AvARRAY(PL_comppad);
1179             else
1180                 PL_curpad = NULL;
1181             break;
1182         case SAVEt_PADSV_AND_MORTALIZE:
1183             {
1184                 SV **svp;
1185                 assert (ARG1_PTR);
1186                 svp = AvARRAY((PAD*)ARG1_PTR) + (PADOFFSET)arg0.any_uv;
1187                 /* This mortalizing used to be done by POPLOOP() via itersave.
1188                    But as we have all the information here, we can do it here,
1189                    save even having to have itersave in the struct.  */
1190                 sv_2mortal(*svp);
1191                 *svp = ARG2_SV;
1192             }
1193             break;
1194         case SAVEt_SAVESWITCHSTACK:
1195             {
1196                 dSP;
1197                 SWITCHSTACK(ARG0_AV, ARG1_AV);
1198                 PL_curstackinfo->si_stack = ARG1_AV;
1199             }
1200             break;
1201         case SAVEt_SET_SVFLAGS:
1202             SvFLAGS(ARG2_SV) &= ~((U32)ARG1_I32);
1203             SvFLAGS(ARG2_SV) |= (U32)ARG0_I32;
1204             break;
1205
1206             /* These are only saved in mathoms.c */
1207         case SAVEt_NSTAB:
1208             (void)sv_clear(ARG0_SV);
1209             break;
1210         case SAVEt_LONG:                        /* long reference */
1211             *(long*)ARG0_PTR = arg1.any_long;
1212             break;
1213         case SAVEt_IV:                          /* IV reference */
1214             *(IV*)ARG0_PTR = arg1.any_iv;
1215             break;
1216
1217         case SAVEt_I16:                         /* I16 reference */
1218             *(I16*)ARG0_PTR = (I16)(uv >> 8);
1219             break;
1220         case SAVEt_I8:                          /* I8 reference */
1221             *(I8*)ARG0_PTR = (I8)(uv >> 8);
1222             break;
1223         case SAVEt_DESTRUCTOR:
1224             (*arg1.any_dptr)(ARG0_PTR);
1225             break;
1226         case SAVEt_COMPILE_WARNINGS:
1227             if (!specialWARN(PL_compiling.cop_warnings))
1228                 PerlMemShared_free(PL_compiling.cop_warnings);
1229
1230             PL_compiling.cop_warnings = (STRLEN*)ARG0_PTR;
1231             break;
1232         case SAVEt_PARSER:
1233             parser_free((yy_parser *) ARG0_PTR);
1234             break;
1235         case SAVEt_READONLY_OFF:
1236             SvREADONLY_off(ARG0_SV);
1237             break;
1238         case SAVEt_GP_ALIASED_SV: {
1239             /* The GP may have been abandoned, leaving the savestack with
1240                the only remaining reference to it.  */
1241             GP * const gp = (GP *)ARG0_PTR;
1242             if (gp->gp_refcnt == 1) {
1243                 GV * const gv = (GV *)sv_2mortal(newSV_type(SVt_PVGV));
1244                 isGV_with_GP_on(gv);
1245                 GvGP_set(gv,gp);
1246                 gp_free(gv);
1247                 isGV_with_GP_off(gv);
1248             }
1249             else {
1250                 gp->gp_refcnt--;
1251                 if (uv >> 8) gp->gp_flags |=  GPf_ALIASED_SV;
1252                 else         gp->gp_flags &= ~GPf_ALIASED_SV;
1253             }
1254             break;
1255         }
1256         default:
1257             Perl_croak(aTHX_ "panic: leave_scope inconsistency %u", type);
1258         }
1259     }
1260
1261     TAINT_set(was);
1262 }
1263
1264 void
1265 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1266 {
1267     PERL_ARGS_ASSERT_CX_DUMP;
1268
1269 #ifdef DEBUGGING
1270     PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1271     if (CxTYPE(cx) != CXt_SUBST) {
1272         const char *gimme_text;
1273         PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1274         PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
1275                       PTR2UV(cx->blk_oldcop));
1276         PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1277         PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1278         PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
1279                       PTR2UV(cx->blk_oldpm));
1280         switch (cx->blk_gimme) {
1281             case G_VOID:
1282                 gimme_text = "VOID";
1283                 break;
1284             case G_SCALAR:
1285                 gimme_text = "SCALAR";
1286                 break;
1287             case G_ARRAY:
1288                 gimme_text = "LIST";
1289                 break;
1290             default:
1291                 gimme_text = "UNKNOWN";
1292                 break;
1293         }
1294         PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", gimme_text);
1295     }
1296     switch (CxTYPE(cx)) {
1297     case CXt_NULL:
1298     case CXt_BLOCK:
1299         break;
1300     case CXt_FORMAT:
1301         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.CV = 0x%"UVxf"\n",
1302                 PTR2UV(cx->blk_format.cv));
1303         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.GV = 0x%"UVxf"\n",
1304                 PTR2UV(cx->blk_format.gv));
1305         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.DFOUTGV = 0x%"UVxf"\n",
1306                 PTR2UV(cx->blk_format.dfoutgv));
1307         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.HASARGS = %d\n",
1308                       (int)CxHASARGS(cx));
1309         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.RETOP = 0x%"UVxf"\n",
1310                 PTR2UV(cx->blk_format.retop));
1311         break;
1312     case CXt_SUB:
1313         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1314                 PTR2UV(cx->blk_sub.cv));
1315         PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1316                 (long)cx->blk_sub.olddepth);
1317         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1318                 (int)CxHASARGS(cx));
1319         PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n", (int)CxLVAL(cx));
1320         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1321                 PTR2UV(cx->blk_sub.retop));
1322         break;
1323     case CXt_EVAL:
1324         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1325                 (long)CxOLD_IN_EVAL(cx));
1326         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1327                 PL_op_name[CxOLD_OP_TYPE(cx)],
1328                 PL_op_desc[CxOLD_OP_TYPE(cx)]);
1329         if (cx->blk_eval.old_namesv)
1330             PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1331                           SvPVX_const(cx->blk_eval.old_namesv));
1332         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1333                 PTR2UV(cx->blk_eval.old_eval_root));
1334         PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%"UVxf"\n",
1335                 PTR2UV(cx->blk_eval.retop));
1336         break;
1337
1338     case CXt_LOOP_LAZYIV:
1339     case CXt_LOOP_LAZYSV:
1340     case CXt_LOOP_FOR:
1341     case CXt_LOOP_PLAIN:
1342         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n", CxLABEL(cx));
1343         PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
1344                 (long)cx->blk_loop.resetsp);
1345         PerlIO_printf(Perl_debug_log, "BLK_LOOP.MY_OP = 0x%"UVxf"\n",
1346                 PTR2UV(cx->blk_loop.my_op));
1347         /* XXX: not accurate for LAZYSV/IV */
1348         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1349                 PTR2UV(cx->blk_loop.state_u.ary.ary));
1350         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1351                 (long)cx->blk_loop.state_u.ary.ix);
1352         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1353                 PTR2UV(CxITERVAR(cx)));
1354         break;
1355
1356     case CXt_SUBST:
1357         PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1358                 (long)cx->sb_iters);
1359         PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1360                 (long)cx->sb_maxiters);
1361         PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1362                 (long)cx->sb_rflags);
1363         PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1364                 (long)CxONCE(cx));
1365         PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1366                 cx->sb_orig);
1367         PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1368                 PTR2UV(cx->sb_dstr));
1369         PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1370                 PTR2UV(cx->sb_targ));
1371         PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1372                 PTR2UV(cx->sb_s));
1373         PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1374                 PTR2UV(cx->sb_m));
1375         PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1376                 PTR2UV(cx->sb_strend));
1377         PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1378                 PTR2UV(cx->sb_rxres));
1379         break;
1380     }
1381 #else
1382     PERL_UNUSED_CONTEXT;
1383     PERL_UNUSED_ARG(cx);
1384 #endif  /* DEBUGGING */
1385 }
1386
1387 /*
1388  * Local variables:
1389  * c-indentation-style: bsd
1390  * c-basic-offset: 4
1391  * indent-tabs-mode: nil
1392  * End:
1393  *
1394  * ex: set ts=8 sts=4 sw=4 et:
1395  */