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