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