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