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