Can now count the patches committed with --thanks-applied.
[perl.git] / scope.c
1 /*    scope.c
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 2004, 2005, 2006, 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
16 /* This file contains functions to manipulate several of Perl's stacks;
17  * in particular it contains code to push various types of things onto
18  * the savestack, then to pop them off and perform the correct restorative
19  * action for each one. This corresponds to the cleanup Perl does at
20  * each scope exit.
21  */
22
23 #include "EXTERN.h"
24 #define PERL_IN_SCOPE_C
25 #include "perl.h"
26
27 SV**
28 Perl_stack_grow(pTHX_ SV **sp, SV **p, int n)
29 {
30     dVAR;
31     PL_stack_sp = sp;
32 #ifndef STRESS_REALLOC
33     av_extend(PL_curstack, (p - PL_stack_base) + (n) + 128);
34 #else
35     av_extend(PL_curstack, (p - PL_stack_base) + (n) + 1);
36 #endif
37     return PL_stack_sp;
38 }
39
40 #ifndef STRESS_REALLOC
41 #define GROW(old) ((old) * 3 / 2)
42 #else
43 #define GROW(old) ((old) + 1)
44 #endif
45
46 PERL_SI *
47 Perl_new_stackinfo(pTHX_ I32 stitems, I32 cxitems)
48 {
49     dVAR;
50     PERL_SI *si;
51     Newx(si, 1, PERL_SI);
52     si->si_stack = newAV();
53     AvREAL_off(si->si_stack);
54     av_extend(si->si_stack, stitems > 0 ? stitems-1 : 0);
55     AvALLOC(si->si_stack)[0] = &PL_sv_undef;
56     AvFILLp(si->si_stack) = 0;
57     si->si_prev = 0;
58     si->si_next = 0;
59     si->si_cxmax = cxitems - 1;
60     si->si_cxix = -1;
61     si->si_type = PERLSI_UNDEF;
62     Newx(si->si_cxstack, cxitems, PERL_CONTEXT);
63     /* Without any kind of initialising PUSHSUBST()
64      * in pp_subst() will read uninitialised heap. */
65     Poison(si->si_cxstack, cxitems, PERL_CONTEXT);
66     return si;
67 }
68
69 I32
70 Perl_cxinc(pTHX)
71 {
72     dVAR;
73     const IV old_max = cxstack_max;
74     cxstack_max = GROW(cxstack_max);
75     Renew(cxstack, cxstack_max + 1, PERL_CONTEXT);      /* XXX should fix CXINC macro */
76     /* Without any kind of initialising deep enough recursion
77      * will end up reading uninitialised PERL_CONTEXTs. */
78     Poison(cxstack + old_max + 1, cxstack_max - old_max, PERL_CONTEXT);
79     return cxstack_ix + 1;
80 }
81
82 void
83 Perl_push_scope(pTHX)
84 {
85     dVAR;
86     if (PL_scopestack_ix == PL_scopestack_max) {
87         PL_scopestack_max = GROW(PL_scopestack_max);
88         Renew(PL_scopestack, PL_scopestack_max, I32);
89     }
90     PL_scopestack[PL_scopestack_ix++] = PL_savestack_ix;
91
92 }
93
94 void
95 Perl_pop_scope(pTHX)
96 {
97     dVAR;
98     const I32 oldsave = PL_scopestack[--PL_scopestack_ix];
99     LEAVE_SCOPE(oldsave);
100 }
101
102 void
103 Perl_markstack_grow(pTHX)
104 {
105     dVAR;
106     const I32 oldmax = PL_markstack_max - PL_markstack;
107     const I32 newmax = GROW(oldmax);
108
109     Renew(PL_markstack, newmax, I32);
110     PL_markstack_ptr = PL_markstack + oldmax;
111     PL_markstack_max = PL_markstack + newmax;
112 }
113
114 void
115 Perl_savestack_grow(pTHX)
116 {
117     dVAR;
118     PL_savestack_max = GROW(PL_savestack_max) + 4;
119     Renew(PL_savestack, PL_savestack_max, ANY);
120 }
121
122 void
123 Perl_savestack_grow_cnt(pTHX_ I32 need)
124 {
125     dVAR;
126     PL_savestack_max = PL_savestack_ix + need;
127     Renew(PL_savestack, PL_savestack_max, ANY);
128 }
129
130 #undef GROW
131
132 void
133 Perl_tmps_grow(pTHX_ I32 n)
134 {
135     dVAR;
136 #ifndef STRESS_REALLOC
137     if (n < 128)
138         n = (PL_tmps_max < 512) ? 128 : 512;
139 #endif
140     PL_tmps_max = PL_tmps_ix + n + 1;
141     Renew(PL_tmps_stack, PL_tmps_max, SV*);
142 }
143
144
145 void
146 Perl_free_tmps(pTHX)
147 {
148     dVAR;
149     /* XXX should tmps_floor live in cxstack? */
150     const I32 myfloor = PL_tmps_floor;
151     while (PL_tmps_ix > myfloor) {      /* clean up after last statement */
152         SV* const sv = PL_tmps_stack[PL_tmps_ix];
153         PL_tmps_stack[PL_tmps_ix--] = Nullsv;
154         if (sv && sv != &PL_sv_undef) {
155             SvTEMP_off(sv);
156             SvREFCNT_dec(sv);           /* note, can modify tmps_ix!!! */
157         }
158     }
159 }
160
161 STATIC SV *
162 S_save_scalar_at(pTHX_ SV **sptr)
163 {
164     dVAR;
165     SV * const osv = *sptr;
166     register SV * const sv = *sptr = NEWSV(0,0);
167
168     if (SvTYPE(osv) >= SVt_PVMG && SvMAGIC(osv) && SvTYPE(osv) != SVt_PVGV) {
169         if (SvGMAGICAL(osv)) {
170             const bool oldtainted = PL_tainted;
171             SvFLAGS(osv) |= (SvFLAGS(osv) &
172                (SVp_NOK|SVp_POK)) >> PRIVSHIFT;
173             PL_tainted = oldtainted;
174         }
175         mg_localize(osv, sv);
176     }
177     return sv;
178 }
179
180 SV *
181 Perl_save_scalar(pTHX_ GV *gv)
182 {
183     dVAR;
184     SV ** const sptr = &GvSV(gv);
185     PL_localizing = 1;
186     SvGETMAGIC(*sptr);
187     PL_localizing = 0;
188     SSCHECK(3);
189     SSPUSHPTR(SvREFCNT_inc(gv));
190     SSPUSHPTR(SvREFCNT_inc(*sptr));
191     SSPUSHINT(SAVEt_SV);
192     return save_scalar_at(sptr);
193 }
194
195 SV*
196 Perl_save_svref(pTHX_ SV **sptr)
197 {
198     dVAR;
199     SvGETMAGIC(*sptr);
200     SSCHECK(3);
201     SSPUSHPTR(sptr);
202     SSPUSHPTR(SvREFCNT_inc(*sptr));
203     SSPUSHINT(SAVEt_SVREF);
204     return save_scalar_at(sptr);
205 }
206
207 /* Like save_sptr(), but also SvREFCNT_dec()s the new value.  Can be used to
208  * restore a global SV to its prior contents, freeing new value. */
209 void
210 Perl_save_generic_svref(pTHX_ SV **sptr)
211 {
212     dVAR;
213     SSCHECK(3);
214     SSPUSHPTR(sptr);
215     SSPUSHPTR(SvREFCNT_inc(*sptr));
216     SSPUSHINT(SAVEt_GENERIC_SVREF);
217 }
218
219 /* Like save_pptr(), but also Safefree()s the new value if it is different
220  * from the old one.  Can be used to restore a global char* to its prior
221  * contents, freeing new value. */
222 void
223 Perl_save_generic_pvref(pTHX_ char **str)
224 {
225     dVAR;
226     SSCHECK(3);
227     SSPUSHPTR(str);
228     SSPUSHPTR(*str);
229     SSPUSHINT(SAVEt_GENERIC_PVREF);
230 }
231
232 /* Like save_generic_pvref(), but uses PerlMemShared_free() rather than Safefree().
233  * Can be used to restore a shared global char* to its prior
234  * contents, freeing new value. */
235 void
236 Perl_save_shared_pvref(pTHX_ char **str)
237 {
238     dVAR;
239     SSCHECK(3);
240     SSPUSHPTR(str);
241     SSPUSHPTR(*str);
242     SSPUSHINT(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     dVAR;
251     SSCHECK(4);
252     SSPUSHPTR(sv);
253     SSPUSHINT(mask);
254     SSPUSHINT(val);
255     SSPUSHINT(SAVEt_SET_SVFLAGS);
256 }
257
258 void
259 Perl_save_gp(pTHX_ GV *gv, I32 empty)
260 {
261     dVAR;
262     SSGROW(6);
263     SSPUSHIV((IV)SvLEN(gv));
264     SvLEN_set(gv, 0); /* forget that anything was allocated here */
265     SSPUSHIV((IV)SvCUR(gv));
266     SSPUSHPTR(SvPVX_const(gv));
267     SvPOK_off(gv);
268     SSPUSHPTR(SvREFCNT_inc(gv));
269     SSPUSHPTR(GvGP(gv));
270     SSPUSHINT(SAVEt_GP);
271
272     if (empty) {
273         register GP *gp;
274
275         Newxz(gp, 1, GP);
276
277         if (GvCVu(gv))
278             PL_sub_generation++;        /* taking a method out of circulation */
279         if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
280             gp->gp_io = newIO();
281             IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
282         }
283         GvGP(gv) = gp_ref(gp);
284         GvSV(gv) = NEWSV(72,0);
285         GvLINE(gv) = CopLINE(PL_curcop);
286         /* XXX Ideally this cast would be replaced with a change to const char*
287            in the struct.  */
288         GvFILE(gv) = CopFILE(PL_curcop) ? CopFILE(PL_curcop) : (char *) "";
289         GvEGV(gv) = gv;
290     }
291     else {
292         gp_ref(GvGP(gv));
293         GvINTRO_on(gv);
294     }
295 }
296
297 AV *
298 Perl_save_ary(pTHX_ GV *gv)
299 {
300     dVAR;
301     AV * const oav = GvAVn(gv);
302     AV *av;
303
304     if (!AvREAL(oav) && AvREIFY(oav))
305         av_reify(oav);
306     SSCHECK(3);
307     SSPUSHPTR(gv);
308     SSPUSHPTR(oav);
309     SSPUSHINT(SAVEt_AV);
310
311     GvAV(gv) = Null(AV*);
312     av = GvAVn(gv);
313     if (SvMAGIC(oav))
314         mg_localize((SV*)oav, (SV*)av);
315     return av;
316 }
317
318 HV *
319 Perl_save_hash(pTHX_ GV *gv)
320 {
321     dVAR;
322     HV *ohv, *hv;
323
324     SSCHECK(3);
325     SSPUSHPTR(gv);
326     SSPUSHPTR(ohv = GvHVn(gv));
327     SSPUSHINT(SAVEt_HV);
328
329     GvHV(gv) = Null(HV*);
330     hv = GvHVn(gv);
331     if (SvMAGIC(ohv))
332         mg_localize((SV*)ohv, (SV*)hv);
333     return hv;
334 }
335
336 void
337 Perl_save_item(pTHX_ register SV *item)
338 {
339     dVAR;
340     register SV * const sv = newSVsv(item);
341
342     SSCHECK(3);
343     SSPUSHPTR(item);            /* remember the pointer */
344     SSPUSHPTR(sv);              /* remember the value */
345     SSPUSHINT(SAVEt_ITEM);
346 }
347
348 void
349 Perl_save_int(pTHX_ int *intp)
350 {
351     dVAR;
352     SSCHECK(3);
353     SSPUSHINT(*intp);
354     SSPUSHPTR(intp);
355     SSPUSHINT(SAVEt_INT);
356 }
357
358 void
359 Perl_save_long(pTHX_ long int *longp)
360 {
361     dVAR;
362     SSCHECK(3);
363     SSPUSHLONG(*longp);
364     SSPUSHPTR(longp);
365     SSPUSHINT(SAVEt_LONG);
366 }
367
368 void
369 Perl_save_bool(pTHX_ bool *boolp)
370 {
371     dVAR;
372     SSCHECK(3);
373     SSPUSHBOOL(*boolp);
374     SSPUSHPTR(boolp);
375     SSPUSHINT(SAVEt_BOOL);
376 }
377
378 void
379 Perl_save_I32(pTHX_ I32 *intp)
380 {
381     dVAR;
382     SSCHECK(3);
383     SSPUSHINT(*intp);
384     SSPUSHPTR(intp);
385     SSPUSHINT(SAVEt_I32);
386 }
387
388 void
389 Perl_save_I16(pTHX_ I16 *intp)
390 {
391     dVAR;
392     SSCHECK(3);
393     SSPUSHINT(*intp);
394     SSPUSHPTR(intp);
395     SSPUSHINT(SAVEt_I16);
396 }
397
398 void
399 Perl_save_I8(pTHX_ I8 *bytep)
400 {
401     dVAR;
402     SSCHECK(3);
403     SSPUSHINT(*bytep);
404     SSPUSHPTR(bytep);
405     SSPUSHINT(SAVEt_I8);
406 }
407
408 void
409 Perl_save_iv(pTHX_ IV *ivp)
410 {
411     dVAR;
412     SSCHECK(3);
413     SSPUSHIV(*ivp);
414     SSPUSHPTR(ivp);
415     SSPUSHINT(SAVEt_IV);
416 }
417
418 /* Cannot use save_sptr() to store a char* since the SV** cast will
419  * force word-alignment and we'll miss the pointer.
420  */
421 void
422 Perl_save_pptr(pTHX_ char **pptr)
423 {
424     dVAR;
425     SSCHECK(3);
426     SSPUSHPTR(*pptr);
427     SSPUSHPTR(pptr);
428     SSPUSHINT(SAVEt_PPTR);
429 }
430
431 void
432 Perl_save_vptr(pTHX_ void *ptr)
433 {
434     dVAR;
435     SSCHECK(3);
436     SSPUSHPTR(*(char**)ptr);
437     SSPUSHPTR(ptr);
438     SSPUSHINT(SAVEt_VPTR);
439 }
440
441 void
442 Perl_save_sptr(pTHX_ SV **sptr)
443 {
444     dVAR;
445     SSCHECK(3);
446     SSPUSHPTR(*sptr);
447     SSPUSHPTR(sptr);
448     SSPUSHINT(SAVEt_SPTR);
449 }
450
451 void
452 Perl_save_padsv(pTHX_ PADOFFSET off)
453 {
454     dVAR;
455     SSCHECK(4);
456     ASSERT_CURPAD_ACTIVE("save_padsv");
457     SSPUSHPTR(PL_curpad[off]);
458     SSPUSHPTR(PL_comppad);
459     SSPUSHLONG((long)off);
460     SSPUSHINT(SAVEt_PADSV);
461 }
462
463 SV **
464 Perl_save_threadsv(pTHX_ PADOFFSET i)
465 {
466     dVAR;
467     Perl_croak(aTHX_ "panic: save_threadsv called in non-threaded perl");
468     PERL_UNUSED_ARG(i);
469     NORETURN_FUNCTION_END;
470 }
471
472 void
473 Perl_save_nogv(pTHX_ GV *gv)
474 {
475     dVAR;
476     SSCHECK(2);
477     SSPUSHPTR(gv);
478     SSPUSHINT(SAVEt_NSTAB);
479 }
480
481 void
482 Perl_save_hptr(pTHX_ HV **hptr)
483 {
484     dVAR;
485     SSCHECK(3);
486     SSPUSHPTR(*hptr);
487     SSPUSHPTR(hptr);
488     SSPUSHINT(SAVEt_HPTR);
489 }
490
491 void
492 Perl_save_aptr(pTHX_ AV **aptr)
493 {
494     dVAR;
495     SSCHECK(3);
496     SSPUSHPTR(*aptr);
497     SSPUSHPTR(aptr);
498     SSPUSHINT(SAVEt_APTR);
499 }
500
501 void
502 Perl_save_freesv(pTHX_ SV *sv)
503 {
504     dVAR;
505     SSCHECK(2);
506     SSPUSHPTR(sv);
507     SSPUSHINT(SAVEt_FREESV);
508 }
509
510 void
511 Perl_save_mortalizesv(pTHX_ SV *sv)
512 {
513     dVAR;
514     SSCHECK(2);
515     SSPUSHPTR(sv);
516     SSPUSHINT(SAVEt_MORTALIZESV);
517 }
518
519 void
520 Perl_save_freeop(pTHX_ OP *o)
521 {
522     dVAR;
523     SSCHECK(2);
524     SSPUSHPTR(o);
525     SSPUSHINT(SAVEt_FREEOP);
526 }
527
528 void
529 Perl_save_freepv(pTHX_ char *pv)
530 {
531     dVAR;
532     SSCHECK(2);
533     SSPUSHPTR(pv);
534     SSPUSHINT(SAVEt_FREEPV);
535 }
536
537 void
538 Perl_save_clearsv(pTHX_ SV **svp)
539 {
540     dVAR;
541     ASSERT_CURPAD_ACTIVE("save_clearsv");
542     SSCHECK(2);
543     SSPUSHLONG((long)(svp-PL_curpad));
544     SSPUSHINT(SAVEt_CLEARSV);
545     SvPADSTALE_off(*svp); /* mark lexical as active */
546 }
547
548 void
549 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
550 {
551     dVAR;
552     SSCHECK(4);
553     SSPUSHINT(klen);
554     SSPUSHPTR(key);
555     SSPUSHPTR(SvREFCNT_inc(hv));
556     SSPUSHINT(SAVEt_DELETE);
557 }
558
559 void
560 Perl_save_list(pTHX_ register SV **sarg, I32 maxsarg)
561 {
562     dVAR;
563     register I32 i;
564
565     for (i = 1; i <= maxsarg; i++) {
566         register SV * const sv = NEWSV(0,0);
567         sv_setsv(sv,sarg[i]);
568         SSCHECK(3);
569         SSPUSHPTR(sarg[i]);             /* remember the pointer */
570         SSPUSHPTR(sv);                  /* remember the value */
571         SSPUSHINT(SAVEt_ITEM);
572     }
573 }
574
575 void
576 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
577 {
578     dVAR;
579     SSCHECK(3);
580     SSPUSHDPTR(f);
581     SSPUSHPTR(p);
582     SSPUSHINT(SAVEt_DESTRUCTOR);
583 }
584
585 void
586 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
587 {
588     dVAR;
589     SSCHECK(3);
590     SSPUSHDXPTR(f);
591     SSPUSHPTR(p);
592     SSPUSHINT(SAVEt_DESTRUCTOR_X);
593 }
594
595 void
596 Perl_save_aelem(pTHX_ const AV *av, I32 idx, SV **sptr)
597 {
598     dVAR;
599     SV *sv;
600     SvGETMAGIC(*sptr);
601     SSCHECK(4);
602     SSPUSHPTR(SvREFCNT_inc(av));
603     SSPUSHINT(idx);
604     SSPUSHPTR(SvREFCNT_inc(*sptr));
605     SSPUSHINT(SAVEt_AELEM);
606     /* if it gets reified later, the restore will have the wrong refcnt */
607     if (!AvREAL(av) && AvREIFY(av))
608         (void)SvREFCNT_inc(*sptr);
609     save_scalar_at(sptr);
610     sv = *sptr;
611     /* If we're localizing a tied array element, this new sv
612      * won't actually be stored in the array - so it won't get
613      * reaped when the localize ends. Ensure it gets reaped by
614      * mortifying it instead. DAPM */
615     if (SvTIED_mg(sv, PERL_MAGIC_tiedelem))
616         sv_2mortal(sv);
617 }
618
619 void
620 Perl_save_helem(pTHX_ HV *hv, SV *key, SV **sptr)
621 {
622     dVAR;
623     SV *sv;
624     SvGETMAGIC(*sptr);
625     SSCHECK(4);
626     SSPUSHPTR(SvREFCNT_inc(hv));
627     SSPUSHPTR(SvREFCNT_inc(key));
628     SSPUSHPTR(SvREFCNT_inc(*sptr));
629     SSPUSHINT(SAVEt_HELEM);
630     save_scalar_at(sptr);
631     sv = *sptr;
632     /* If we're localizing a tied hash element, this new sv
633      * won't actually be stored in the hash - so it won't get
634      * reaped when the localize ends. Ensure it gets reaped by
635      * mortifying it instead. DAPM */
636     if (SvTIED_mg(sv, PERL_MAGIC_tiedelem))
637         sv_2mortal(sv);
638 }
639
640 void
641 Perl_save_op(pTHX)
642 {
643     dVAR;
644     SSCHECK(2);
645     SSPUSHPTR(PL_op);
646     SSPUSHINT(SAVEt_OP);
647 }
648
649 I32
650 Perl_save_alloc(pTHX_ I32 size, I32 pad)
651 {
652     dVAR;
653     register const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
654                                 - (char*)PL_savestack);
655     register const I32 elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
656
657     /* SSCHECK may not be good enough */
658     while (PL_savestack_ix + elems + 2 > PL_savestack_max)
659         savestack_grow();
660
661     PL_savestack_ix += elems;
662     SSPUSHINT(elems);
663     SSPUSHINT(SAVEt_ALLOC);
664     return start;
665 }
666
667 void
668 Perl_leave_scope(pTHX_ I32 base)
669 {
670     dVAR;
671     register SV *sv;
672     register SV *value;
673     register GV *gv;
674     register AV *av;
675     register HV *hv;
676     void* ptr;
677     register char* str;
678     I32 i;
679
680     if (base < -1)
681         Perl_croak(aTHX_ "panic: corrupt saved stack index");
682     while (PL_savestack_ix > base) {
683         switch (SSPOPINT) {
684         case SAVEt_ITEM:                        /* normal string */
685             value = (SV*)SSPOPPTR;
686             sv = (SV*)SSPOPPTR;
687             sv_replace(sv,value);
688             PL_localizing = 2;
689             SvSETMAGIC(sv);
690             PL_localizing = 0;
691             break;
692         case SAVEt_SV:                          /* scalar reference */
693             value = (SV*)SSPOPPTR;
694             gv = (GV*)SSPOPPTR;
695             ptr = &GvSV(gv);
696             av = (AV*)gv; /* what to refcnt_dec */
697             goto restore_sv;
698         case SAVEt_GENERIC_PVREF:               /* generic pv */
699             str = (char*)SSPOPPTR;
700             ptr = SSPOPPTR;
701             if (*(char**)ptr != str) {
702                 Safefree(*(char**)ptr);
703                 *(char**)ptr = str;
704             }
705             break;
706         case SAVEt_SHARED_PVREF:                /* shared pv */
707             str = (char*)SSPOPPTR;
708             ptr = SSPOPPTR;
709             if (*(char**)ptr != str) {
710 #ifdef NETWARE
711                 PerlMem_free(*(char**)ptr);
712 #else
713                 PerlMemShared_free(*(char**)ptr);
714 #endif
715                 *(char**)ptr = str;
716             }
717             break;
718         case SAVEt_GENERIC_SVREF:               /* generic sv */
719             value = (SV*)SSPOPPTR;
720             ptr = SSPOPPTR;
721             sv = *(SV**)ptr;
722             *(SV**)ptr = value;
723             SvREFCNT_dec(sv);
724             SvREFCNT_dec(value);
725             break;
726         case SAVEt_SVREF:                       /* scalar reference */
727             value = (SV*)SSPOPPTR;
728             ptr = SSPOPPTR;
729             av = NULL; /* what to refcnt_dec */
730         restore_sv:
731             sv = *(SV**)ptr;
732             DEBUG_S(PerlIO_printf(Perl_debug_log,
733                                   "restore svref: %p %p:%s -> %p:%s\n",
734                                   ptr, sv, SvPEEK(sv), value, SvPEEK(value)));
735             *(SV**)ptr = value;
736             SvREFCNT_dec(sv);
737             PL_localizing = 2;
738             SvSETMAGIC(value);
739             PL_localizing = 0;
740             SvREFCNT_dec(value);
741             if (av) /* actually an av, hv or gv */
742                 SvREFCNT_dec(av);
743             break;
744         case SAVEt_AV:                          /* array reference */
745             av = (AV*)SSPOPPTR;
746             gv = (GV*)SSPOPPTR;
747             if (GvAV(gv)) {
748                 AV * const goner = GvAV(gv);
749                 /* FIXME - this is a temporary hack until we work out what
750                    the correct behaviour for magic should be.  */
751                 sv_unmagic((SV*)goner, PERL_MAGIC_arylen_p);
752                 SvMAGIC_set(av, SvMAGIC(goner));
753                 SvFLAGS((SV*)av) |= SvMAGICAL(goner);
754                 SvMAGICAL_off(goner);
755                 SvMAGIC_set(goner, NULL);
756                 SvREFCNT_dec(goner);
757             }
758             GvAV(gv) = av;
759             if (SvMAGICAL(av)) {
760                 PL_localizing = 2;
761                 SvSETMAGIC((SV*)av);
762                 PL_localizing = 0;
763             }
764             break;
765         case SAVEt_HV:                          /* hash reference */
766             hv = (HV*)SSPOPPTR;
767             gv = (GV*)SSPOPPTR;
768             if (GvHV(gv)) {
769                 HV * const goner = GvHV(gv);
770                 SvMAGIC_set(hv, SvMAGIC(goner));
771                 SvFLAGS(hv) |= SvMAGICAL(goner);
772                 SvMAGICAL_off(goner);
773                 SvMAGIC_set(goner, NULL);
774                 SvREFCNT_dec(goner);
775             }
776             GvHV(gv) = hv;
777             if (SvMAGICAL(hv)) {
778                 PL_localizing = 2;
779                 SvSETMAGIC((SV*)hv);
780                 PL_localizing = 0;
781             }
782             break;
783         case SAVEt_INT:                         /* int reference */
784             ptr = SSPOPPTR;
785             *(int*)ptr = (int)SSPOPINT;
786             break;
787         case SAVEt_LONG:                        /* long reference */
788             ptr = SSPOPPTR;
789             *(long*)ptr = (long)SSPOPLONG;
790             break;
791         case SAVEt_BOOL:                        /* bool reference */
792             ptr = SSPOPPTR;
793             *(bool*)ptr = (bool)SSPOPBOOL;
794             break;
795         case SAVEt_I32:                         /* I32 reference */
796             ptr = SSPOPPTR;
797             *(I32*)ptr = (I32)SSPOPINT;
798             break;
799         case SAVEt_I16:                         /* I16 reference */
800             ptr = SSPOPPTR;
801             *(I16*)ptr = (I16)SSPOPINT;
802             break;
803         case SAVEt_I8:                          /* I8 reference */
804             ptr = SSPOPPTR;
805             *(I8*)ptr = (I8)SSPOPINT;
806             break;
807         case SAVEt_IV:                          /* IV reference */
808             ptr = SSPOPPTR;
809             *(IV*)ptr = (IV)SSPOPIV;
810             break;
811         case SAVEt_SPTR:                        /* SV* reference */
812             ptr = SSPOPPTR;
813             *(SV**)ptr = (SV*)SSPOPPTR;
814             break;
815         case SAVEt_VPTR:                        /* random* reference */
816         case SAVEt_PPTR:                        /* char* reference */
817             ptr = SSPOPPTR;
818             *(char**)ptr = (char*)SSPOPPTR;
819             break;
820         case SAVEt_HPTR:                        /* HV* reference */
821             ptr = SSPOPPTR;
822             *(HV**)ptr = (HV*)SSPOPPTR;
823             break;
824         case SAVEt_APTR:                        /* AV* reference */
825             ptr = SSPOPPTR;
826             *(AV**)ptr = (AV*)SSPOPPTR;
827             break;
828         case SAVEt_NSTAB:
829             gv = (GV*)SSPOPPTR;
830             (void)sv_clear((SV*)gv);
831             break;
832         case SAVEt_GP:                          /* scalar reference */
833             ptr = SSPOPPTR;
834             gv = (GV*)SSPOPPTR;
835             if (SvPVX_const(gv) && SvLEN(gv) > 0) {
836                 Safefree(SvPVX_mutable(gv));
837             }
838             SvPV_set(gv, (char *)SSPOPPTR);
839             SvCUR_set(gv, (STRLEN)SSPOPIV);
840             SvLEN_set(gv, (STRLEN)SSPOPIV);
841             gp_free(gv);
842             GvGP(gv) = (GP*)ptr;
843             if (GvCVu(gv))
844                 PL_sub_generation++;  /* putting a method back into circulation */
845             SvREFCNT_dec(gv);
846             break;
847         case SAVEt_FREESV:
848             ptr = SSPOPPTR;
849             SvREFCNT_dec((SV*)ptr);
850             break;
851         case SAVEt_MORTALIZESV:
852             ptr = SSPOPPTR;
853             sv_2mortal((SV*)ptr);
854             break;
855         case SAVEt_FREEOP:
856             ptr = SSPOPPTR;
857             ASSERT_CURPAD_LEGAL("SAVEt_FREEOP"); /* XXX DAPM tmp */
858             op_free((OP*)ptr);
859             break;
860         case SAVEt_FREEPV:
861             ptr = SSPOPPTR;
862             Safefree(ptr);
863             break;
864         case SAVEt_CLEARSV:
865             ptr = (void*)&PL_curpad[SSPOPLONG];
866             sv = *(SV**)ptr;
867
868             DEBUG_Xv(PerlIO_printf(Perl_debug_log,
869              "Pad 0x%"UVxf"[0x%"UVxf"] clearsv: %ld sv=0x%"UVxf"<%"IVdf"> %s\n",
870                 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
871                 (long)((SV **)ptr-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
872                 (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
873             ));
874
875             /* Can clear pad variable in place? */
876             if (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) {
877                 /*
878                  * if a my variable that was made readonly is going out of
879                  * scope, we want to remove the readonlyness so that it can
880                  * go out of scope quietly
881                  */
882                 if (SvPADMY(sv) && !SvFAKE(sv))
883                     SvREADONLY_off(sv);
884
885                 if (SvTHINKFIRST(sv))
886                     sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF);
887                 if (SvMAGICAL(sv))
888                     mg_free(sv);
889
890                 switch (SvTYPE(sv)) {
891                 case SVt_NULL:
892                     break;
893                 case SVt_PVAV:
894                     av_clear((AV*)sv);
895                     break;
896                 case SVt_PVHV:
897                     hv_clear((HV*)sv);
898                     break;
899                 case SVt_PVCV:
900                     Perl_croak(aTHX_ "panic: leave_scope pad code");
901                 default:
902                     SvOK_off(sv);
903                     break;
904                 }
905                 SvPADSTALE_on(sv); /* mark as no longer live */
906             }
907             else {      /* Someone has a claim on this, so abandon it. */
908                 const U32 padflags = SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP);
909                 switch (SvTYPE(sv)) {   /* Console ourselves with a new value */
910                 case SVt_PVAV:  *(SV**)ptr = (SV*)newAV();      break;
911                 case SVt_PVHV:  *(SV**)ptr = (SV*)newHV();      break;
912                 default:        *(SV**)ptr = NEWSV(0,0);        break;
913                 }
914                 SvREFCNT_dec(sv);       /* Cast current value to the winds. */
915                 /* preserve pad nature, but also mark as not live
916                  * for any closure capturing */
917                 SvFLAGS(*(SV**)ptr) |= padflags | SVs_PADSTALE;
918             }
919             break;
920         case SAVEt_DELETE:
921             ptr = SSPOPPTR;
922             hv = (HV*)ptr;
923             ptr = SSPOPPTR;
924             (void)hv_delete(hv, (char*)ptr, (U32)SSPOPINT, G_DISCARD);
925             SvREFCNT_dec(hv);
926             Safefree(ptr);
927             break;
928         case SAVEt_DESTRUCTOR:
929             ptr = SSPOPPTR;
930             (*SSPOPDPTR)(ptr);
931             break;
932         case SAVEt_DESTRUCTOR_X:
933             ptr = SSPOPPTR;
934             (*SSPOPDXPTR)(aTHX_ ptr);
935             break;
936         case SAVEt_REGCONTEXT:
937         case SAVEt_ALLOC:
938             i = SSPOPINT;
939             PL_savestack_ix -= i;       /* regexp must have croaked */
940             break;
941         case SAVEt_STACK_POS:           /* Position on Perl stack */
942             i = SSPOPINT;
943             PL_stack_sp = PL_stack_base + i;
944             break;
945         case SAVEt_AELEM:               /* array element */
946             value = (SV*)SSPOPPTR;
947             i = SSPOPINT;
948             av = (AV*)SSPOPPTR;
949             if (!AvREAL(av) && AvREIFY(av)) /* undo reify guard */
950                 SvREFCNT_dec(value);
951             ptr = av_fetch(av,i,1);
952             if (ptr) {
953                 sv = *(SV**)ptr;
954                 if (sv && sv != &PL_sv_undef) {
955                     if (SvTIED_mg((SV*)av, PERL_MAGIC_tied))
956                         (void)SvREFCNT_inc(sv);
957                     goto restore_sv;
958                 }
959             }
960             SvREFCNT_dec(av);
961             SvREFCNT_dec(value);
962             break;
963         case SAVEt_HELEM:               /* hash element */
964             value = (SV*)SSPOPPTR;
965             sv = (SV*)SSPOPPTR;
966             hv = (HV*)SSPOPPTR;
967             ptr = hv_fetch_ent(hv, sv, 1, 0);
968             if (ptr) {
969                 const SV * const oval = HeVAL((HE*)ptr);
970                 if (oval && oval != &PL_sv_undef) {
971                     ptr = &HeVAL((HE*)ptr);
972                     if (SvTIED_mg((SV*)hv, PERL_MAGIC_tied))
973                         (void)SvREFCNT_inc(*(SV**)ptr);
974                     SvREFCNT_dec(sv);
975                     av = (AV*)hv; /* what to refcnt_dec */
976                     goto restore_sv;
977                 }
978             }
979             SvREFCNT_dec(hv);
980             SvREFCNT_dec(sv);
981             SvREFCNT_dec(value);
982             break;
983         case SAVEt_OP:
984             PL_op = (OP*)SSPOPPTR;
985             break;
986         case SAVEt_HINTS:
987             if ((PL_hints & HINT_LOCALIZE_HH) && GvHV(PL_hintgv)) {
988                 SvREFCNT_dec((SV*)GvHV(PL_hintgv));
989                 GvHV(PL_hintgv) = NULL;
990             }
991             *(I32*)&PL_hints = (I32)SSPOPINT;
992             if (PL_hints & HINT_LOCALIZE_HH) {
993                 SvREFCNT_dec((SV*)GvHV(PL_hintgv));
994                 GvHV(PL_hintgv) = (HV*)SSPOPPTR;
995             }
996                     
997             break;
998         case SAVEt_COMPPAD:
999             PL_comppad = (PAD*)SSPOPPTR;
1000             if (PL_comppad)
1001                 PL_curpad = AvARRAY(PL_comppad);
1002             else
1003                 PL_curpad = Null(SV**);
1004             break;
1005         case SAVEt_PADSV:
1006             {
1007                 const PADOFFSET off = (PADOFFSET)SSPOPLONG;
1008                 ptr = SSPOPPTR;
1009                 if (ptr)
1010                     AvARRAY((PAD*)ptr)[off] = (SV*)SSPOPPTR;
1011             }
1012             break;
1013         case SAVEt_SAVESWITCHSTACK:
1014             {
1015                 dSP;
1016                 AV* const t = (AV*)SSPOPPTR;
1017                 AV* const f = (AV*)SSPOPPTR;
1018                 SWITCHSTACK(t,f);
1019                 PL_curstackinfo->si_stack = f;
1020             }
1021             break;
1022         case SAVEt_SET_SVFLAGS:
1023             {
1024                 const U32 val  = (U32)SSPOPINT;
1025                 const U32 mask = (U32)SSPOPINT;
1026                 sv = (SV*)SSPOPPTR;
1027                 SvFLAGS(sv) &= ~mask;
1028                 SvFLAGS(sv) |= val;
1029             }
1030             break;
1031         default:
1032             Perl_croak(aTHX_ "panic: leave_scope inconsistency");
1033         }
1034     }
1035 }
1036
1037 void
1038 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1039 {
1040     dVAR;
1041 #ifdef DEBUGGING
1042     PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1043     if (CxTYPE(cx) != CXt_SUBST) {
1044         PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1045         PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
1046                       PTR2UV(cx->blk_oldcop));
1047         PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1048         PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1049         PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
1050                       PTR2UV(cx->blk_oldpm));
1051         PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", cx->blk_gimme ? "LIST" : "SCALAR");
1052     }
1053     switch (CxTYPE(cx)) {
1054     case CXt_NULL:
1055     case CXt_BLOCK:
1056         break;
1057     case CXt_FORMAT:
1058         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1059                 PTR2UV(cx->blk_sub.cv));
1060         PerlIO_printf(Perl_debug_log, "BLK_SUB.GV = 0x%"UVxf"\n",
1061                 PTR2UV(cx->blk_sub.gv));
1062         PerlIO_printf(Perl_debug_log, "BLK_SUB.DFOUTGV = 0x%"UVxf"\n",
1063                 PTR2UV(cx->blk_sub.dfoutgv));
1064         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1065                 (int)cx->blk_sub.hasargs);
1066         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1067                 PTR2UV(cx->blk_sub.retop));
1068         break;
1069     case CXt_SUB:
1070         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1071                 PTR2UV(cx->blk_sub.cv));
1072         PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1073                 (long)cx->blk_sub.olddepth);
1074         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1075                 (int)cx->blk_sub.hasargs);
1076         PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n",
1077                 (int)cx->blk_sub.lval);
1078         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1079                 PTR2UV(cx->blk_sub.retop));
1080         break;
1081     case CXt_EVAL:
1082         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1083                 (long)cx->blk_eval.old_in_eval);
1084         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1085                 PL_op_name[cx->blk_eval.old_op_type],
1086                 PL_op_desc[cx->blk_eval.old_op_type]);
1087         if (cx->blk_eval.old_namesv)
1088             PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1089                           SvPVX_const(cx->blk_eval.old_namesv));
1090         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1091                 PTR2UV(cx->blk_eval.old_eval_root));
1092         PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%"UVxf"\n",
1093                 PTR2UV(cx->blk_eval.retop));
1094         break;
1095
1096     case CXt_LOOP:
1097         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n",
1098                 cx->blk_loop.label);
1099         PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
1100                 (long)cx->blk_loop.resetsp);
1101         PerlIO_printf(Perl_debug_log, "BLK_LOOP.REDO_OP = 0x%"UVxf"\n",
1102                 PTR2UV(cx->blk_loop.redo_op));
1103         PerlIO_printf(Perl_debug_log, "BLK_LOOP.NEXT_OP = 0x%"UVxf"\n",
1104                 PTR2UV(cx->blk_loop.next_op));
1105         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LAST_OP = 0x%"UVxf"\n",
1106                 PTR2UV(cx->blk_loop.last_op));
1107         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1108                 (long)cx->blk_loop.iterix);
1109         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1110                 PTR2UV(cx->blk_loop.iterary));
1111         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1112                 PTR2UV(CxITERVAR(cx)));
1113         if (CxITERVAR(cx))
1114             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERSAVE = 0x%"UVxf"\n",
1115                 PTR2UV(cx->blk_loop.itersave));
1116         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERLVAL = 0x%"UVxf"\n",
1117                 PTR2UV(cx->blk_loop.iterlval));
1118         break;
1119
1120     case CXt_SUBST:
1121         PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1122                 (long)cx->sb_iters);
1123         PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1124                 (long)cx->sb_maxiters);
1125         PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1126                 (long)cx->sb_rflags);
1127         PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1128                 (long)cx->sb_once);
1129         PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1130                 cx->sb_orig);
1131         PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1132                 PTR2UV(cx->sb_dstr));
1133         PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1134                 PTR2UV(cx->sb_targ));
1135         PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1136                 PTR2UV(cx->sb_s));
1137         PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1138                 PTR2UV(cx->sb_m));
1139         PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1140                 PTR2UV(cx->sb_strend));
1141         PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1142                 PTR2UV(cx->sb_rxres));
1143         break;
1144     }
1145 #else
1146     PERL_UNUSED_ARG(cx);
1147 #endif  /* DEBUGGING */
1148 }
1149
1150 /*
1151  * Local variables:
1152  * c-indentation-style: bsd
1153  * c-basic-offset: 4
1154  * indent-tabs-mode: t
1155  * End:
1156  *
1157  * ex: set ts=8 sts=4 sw=4 noet:
1158  */