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