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