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