scope.c

   1 /*    scope.c
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
   4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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  *     [p.751 of _The Lord of the Rings_, V/i: "Minas Tirith"]
  16  */
  17
  18 /* This file contains functions to manipulate several of Perl's stacks;
  19  * in particular it contains code to push various types of things onto
  20  * the savestack, then to pop them off and perform the correct restorative
  21  * action for each one. This corresponds to the cleanup Perl does at
  22  * each scope exit.
  23  */
  24
  25 #include "EXTERN.h"
  26 #define PERL_IN_SCOPE_C
  27 #include "perl.h"
  28
  29 SV**
  30 Perl_stack_grow(pTHX_ SV **sp, SV **p, SSize_t n)
  31 {
  32     SSize_t extra;
  33     SSize_t current = (p - PL_stack_base);
  34
  35     PERL_ARGS_ASSERT_STACK_GROW;
  36
  37     if (UNLIKELY(n < 0))
  38         Perl_croak(aTHX_
  39             "panic: stack_grow() negative count (%" IVdf ")", (IV)n);
  40
  41     PL_stack_sp = sp;
  42     extra =
  43 #ifdef STRESS_REALLOC
  44         1;
  45 #else
  46         128;
  47 #endif
  48     /* If the total might wrap, panic instead. This is really testing
  49      * that (current + n + extra < SSize_t_MAX), but done in a way that
  50      * can't wrap */
  51     if (UNLIKELY(   current         > SSize_t_MAX - extra
  52                  || current + extra > SSize_t_MAX - n
  53     ))
  54         /* diag_listed_as: Out of memory during %s extend */
  55         Perl_croak(aTHX_ "Out of memory during stack extend");
  56
  57     av_extend(PL_curstack, current + n + extra);
  58 #ifdef DEBUGGING
  59         PL_curstackinfo->si_stack_hwm = current + n + extra;
  60 #endif
  61
  62     return PL_stack_sp;
  63 }
  64
  65 #ifndef STRESS_REALLOC
  66 #define GROW(old) ((old) * 3 / 2)
  67 #else
  68 #define GROW(old) ((old) + 1)
  69 #endif
  70
  71 PERL_SI *
  72 Perl_new_stackinfo(pTHX_ I32 stitems, I32 cxitems)
  73 {
  74     PERL_SI *si;
  75     Newx(si, 1, PERL_SI);
  76     si->si_stack = newAV();
  77     AvREAL_off(si->si_stack);
  78     av_extend(si->si_stack, stitems > 0 ? stitems-1 : 0);
  79     AvALLOC(si->si_stack)[0] = &PL_sv_undef;
  80     AvFILLp(si->si_stack) = 0;
  81     si->si_prev = 0;
  82     si->si_next = 0;
  83     si->si_cxmax = cxitems - 1;
  84     si->si_cxix = -1;
  85     si->si_type = PERLSI_UNDEF;
  86     Newx(si->si_cxstack, cxitems, PERL_CONTEXT);
  87     /* Without any kind of initialising CX_PUSHSUBST()
  88      * in pp_subst() will read uninitialised heap. */
  89     PoisonNew(si->si_cxstack, cxitems, PERL_CONTEXT);
  90     return si;
  91 }
  92
  93 I32
  94 Perl_cxinc(pTHX)
  95 {
  96     const IV old_max = cxstack_max;
  97     const IV new_max = GROW(cxstack_max);
  98     Renew(cxstack, new_max + 1, PERL_CONTEXT);
  99     cxstack_max = new_max;
 100     /* Without any kind of initialising deep enough recursion
 101      * will end up reading uninitialised PERL_CONTEXTs. */
 102     PoisonNew(cxstack + old_max + 1, new_max - old_max, PERL_CONTEXT);
 103     return cxstack_ix + 1;
 104 }
 105
 106 void
 107 Perl_push_scope(pTHX)
 108 {
 109     if (UNLIKELY(PL_scopestack_ix == PL_scopestack_max)) {
 110         const IV new_max = GROW(PL_scopestack_max);
 111         Renew(PL_scopestack, new_max, I32);
 112 #ifdef DEBUGGING
 113         Renew(PL_scopestack_name, new_max, const char*);
 114 #endif
 115         PL_scopestack_max = new_max;
 116     }
 117 #ifdef DEBUGGING
 118     PL_scopestack_name[PL_scopestack_ix] = "unknown";
 119 #endif
 120     PL_scopestack[PL_scopestack_ix++] = PL_savestack_ix;
 121
 122 }
 123
 124 void
 125 Perl_pop_scope(pTHX)
 126 {
 127     const I32 oldsave = PL_scopestack[--PL_scopestack_ix];
 128     LEAVE_SCOPE(oldsave);
 129 }
 130
 131 I32 *
 132 Perl_markstack_grow(pTHX)
 133 {
 134     const I32 oldmax = PL_markstack_max - PL_markstack;
 135     const I32 newmax = GROW(oldmax);
 136
 137     Renew(PL_markstack, newmax, I32);
 138     PL_markstack_max = PL_markstack + newmax;
 139     PL_markstack_ptr = PL_markstack + oldmax;
 140     DEBUG_s(DEBUG_v(PerlIO_printf(Perl_debug_log,
 141             "MARK grow %p %" IVdf " by %" IVdf "\n",
 142             PL_markstack_ptr, (IV)*PL_markstack_ptr, (IV)oldmax)));
 143     return PL_markstack_ptr;
 144 }
 145
 146 void
 147 Perl_savestack_grow(pTHX)
 148 {
 149     IV new_max;
 150 #ifdef STRESS_REALLOC
 151     new_max = PL_savestack_max + SS_MAXPUSH;
 152 #else
 153     new_max = GROW(PL_savestack_max);
 154 #endif
 155     /* Note that we allocate SS_MAXPUSH slots higher than ss_max
 156      * so that SS_ADD_END(), SSGROW() etc can do a simper check */
 157     Renew(PL_savestack, new_max + SS_MAXPUSH, ANY);
 158     PL_savestack_max = new_max;
 159 }
 160
 161 void
 162 Perl_savestack_grow_cnt(pTHX_ I32 need)
 163 {
 164     const IV new_max = PL_savestack_ix + need;
 165     /* Note that we allocate SS_MAXPUSH slots higher than ss_max
 166      * so that SS_ADD_END(), SSGROW() etc can do a simper check */
 167     Renew(PL_savestack, new_max + SS_MAXPUSH, ANY);
 168     PL_savestack_max = new_max;
 169 }
 170
 171 #undef GROW
 172
 173 /*  The original function was called Perl_tmps_grow and was removed from public
 174     API, Perl_tmps_grow_p is the replacement and it used in public macros but
 175     isn't public itself.
 176
 177     Perl_tmps_grow_p takes a proposed ix. A proposed ix is PL_tmps_ix + extend_by,
 178     where the result of (PL_tmps_ix + extend_by) is >= PL_tmps_max
 179     Upon return, PL_tmps_stack[ix] will be a valid address. For machine code
 180     optimization and register usage reasons, the proposed ix passed into
 181     tmps_grow is returned to the caller which the caller can then use to write
 182     an SV * to PL_tmps_stack[ix]. If the caller was using tmps_grow in
 183     pre-extend mode (EXTEND_MORTAL macro), then it ignores the return value of
 184     tmps_grow. Note, tmps_grow DOES NOT write ix to PL_tmps_ix, the caller
 185     must assign ix or ret val of tmps_grow to PL_temps_ix themselves if that is
 186     appropriate. The assignment to PL_temps_ix can happen before or after
 187     tmps_grow call since tmps_grow doesn't look at PL_tmps_ix.
 188  */
 189
 190 SSize_t
 191 Perl_tmps_grow_p(pTHX_ SSize_t ix)
 192 {
 193     SSize_t extend_to = ix;
 194 #ifndef STRESS_REALLOC
 195     if (ix - PL_tmps_max < 128)
 196         extend_to += (PL_tmps_max < 512) ? 128 : 512;
 197 #endif
 198     Renew(PL_tmps_stack, extend_to + 1, SV*);
 199     PL_tmps_max = extend_to + 1;
 200     return ix;
 201 }
 202
 203
 204 void
 205 Perl_free_tmps(pTHX)
 206 {
 207     /* XXX should tmps_floor live in cxstack? */
 208     const SSize_t myfloor = PL_tmps_floor;
 209     while (PL_tmps_ix > myfloor) {      /* clean up after last statement */
 210         SV* const sv = PL_tmps_stack[PL_tmps_ix--];
 211 #ifdef PERL_POISON
 212         PoisonWith(PL_tmps_stack + PL_tmps_ix + 1, 1, SV *, 0xAB);
 213 #endif
 214         if (LIKELY(sv)) {
 215             SvTEMP_off(sv);
 216             SvREFCNT_dec_NN(sv);                /* note, can modify tmps_ix!!! */
 217         }
 218     }
 219 }
 220
 221 STATIC SV *
 222 S_save_scalar_at(pTHX_ SV **sptr, const U32 flags)
 223 {
 224     SV * osv;
 225     SV *sv;
 226
 227     PERL_ARGS_ASSERT_SAVE_SCALAR_AT;
 228
 229     osv = *sptr;
 230     if (flags & SAVEf_KEEPOLDELEM)
 231         sv = osv;
 232     else {
 233         sv  = (*sptr = newSV(0));
 234         if (SvTYPE(osv) >= SVt_PVMG && SvMAGIC(osv))
 235             mg_localize(osv, sv, cBOOL(flags & SAVEf_SETMAGIC));
 236     }
 237
 238     return sv;
 239 }
 240
 241 void
 242 Perl_save_pushptrptr(pTHX_ void *const ptr1, void *const ptr2, const int type)
 243 {
 244     dSS_ADD;
 245     SS_ADD_PTR(ptr1);
 246     SS_ADD_PTR(ptr2);
 247     SS_ADD_UV(type);
 248     SS_ADD_END(3);
 249 }
 250
 251 SV *
 252 Perl_save_scalar(pTHX_ GV *gv)
 253 {
 254     SV ** const sptr = &GvSVn(gv);
 255
 256     PERL_ARGS_ASSERT_SAVE_SCALAR;
 257
 258     if (UNLIKELY(SvGMAGICAL(*sptr))) {
 259         PL_localizing = 1;
 260         (void)mg_get(*sptr);
 261         PL_localizing = 0;
 262     }
 263     save_pushptrptr(SvREFCNT_inc_simple(gv), SvREFCNT_inc(*sptr), SAVEt_SV);
 264     return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
 265 }
 266
 267 /* Like save_sptr(), but also SvREFCNT_dec()s the new value.  Can be used to
 268  * restore a global SV to its prior contents, freeing new value. */
 269 void
 270 Perl_save_generic_svref(pTHX_ SV **sptr)
 271 {
 272     PERL_ARGS_ASSERT_SAVE_GENERIC_SVREF;
 273
 274     save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_GENERIC_SVREF);
 275 }
 276
 277 /* Like save_pptr(), but also Safefree()s the new value if it is different
 278  * from the old one.  Can be used to restore a global char* to its prior
 279  * contents, freeing new value. */
 280 void
 281 Perl_save_generic_pvref(pTHX_ char **str)
 282 {
 283     PERL_ARGS_ASSERT_SAVE_GENERIC_PVREF;
 284
 285     save_pushptrptr(*str, str, SAVEt_GENERIC_PVREF);
 286 }
 287
 288 /* Like save_generic_pvref(), but uses PerlMemShared_free() rather than Safefree().
 289  * Can be used to restore a shared global char* to its prior
 290  * contents, freeing new value. */
 291 void
 292 Perl_save_shared_pvref(pTHX_ char **str)
 293 {
 294     PERL_ARGS_ASSERT_SAVE_SHARED_PVREF;
 295
 296     save_pushptrptr(str, *str, SAVEt_SHARED_PVREF);
 297 }
 298
 299 /* set the SvFLAGS specified by mask to the values in val */
 300
 301 void
 302 Perl_save_set_svflags(pTHX_ SV* sv, U32 mask, U32 val)
 303 {
 304     dSS_ADD;
 305
 306     PERL_ARGS_ASSERT_SAVE_SET_SVFLAGS;
 307
 308     SS_ADD_PTR(sv);
 309     SS_ADD_INT(mask);
 310     SS_ADD_INT(val);
 311     SS_ADD_UV(SAVEt_SET_SVFLAGS);
 312     SS_ADD_END(4);
 313 }
 314
 315 /*
 316
 317 =head1 GV Functions
 318
 319 =for apidoc save_gp
 320
 321 Saves the current GP of gv on the save stack to be restored on scope exit.
 322
 323 If empty is true, replace the GP with a new GP.
 324
 325 If empty is false, mark gv with GVf_INTRO so the next reference
 326 assigned is localized, which is how C< local *foo = $someref; > works.
 327
 328 =cut
 329 */
 330
 331 void
 332 Perl_save_gp(pTHX_ GV *gv, I32 empty)
 333 {
 334     PERL_ARGS_ASSERT_SAVE_GP;
 335
 336     /* XXX For now, we just upgrade any coderef in the stash to a full GV
 337            during localisation.  Maybe at some point we could make localis-
 338            ation work without needing the upgrade.  (In which case our
 339            callers should probably call a different function, not save_gp.)
 340      */
 341     if (!isGV(gv)) {
 342         assert(isGV_or_RVCV(gv));
 343         (void)CvGV(SvRV((SV *)gv)); /* CvGV does the upgrade */
 344         assert(isGV(gv));
 345     }
 346
 347     save_pushptrptr(SvREFCNT_inc(gv), GvGP(gv), SAVEt_GP);
 348
 349     if (empty) {
 350         GP *gp = Perl_newGP(aTHX_ gv);
 351         HV * const stash = GvSTASH(gv);
 352         bool isa_changed = 0;
 353
 354         if (stash && HvENAME(stash)) {
 355             if (memEQs(GvNAME(gv), GvNAMELEN(gv), "ISA"))
 356                 isa_changed = TRUE;
 357             else if (GvCVu(gv))
 358                 /* taking a method out of circulation ("local")*/
 359                 mro_method_changed_in(stash);
 360         }
 361         if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
 362             gp->gp_io = newIO();
 363             IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
 364         }
 365         GvGP_set(gv,gp);
 366         if (isa_changed) mro_isa_changed_in(stash);
 367     }
 368     else {
 369         gp_ref(GvGP(gv));
 370         GvINTRO_on(gv);
 371     }
 372 }
 373
 374 AV *
 375 Perl_save_ary(pTHX_ GV *gv)
 376 {
 377     AV * const oav = GvAVn(gv);
 378     AV *av;
 379
 380     PERL_ARGS_ASSERT_SAVE_ARY;
 381
 382     if (UNLIKELY(!AvREAL(oav) && AvREIFY(oav)))
 383         av_reify(oav);
 384     save_pushptrptr(SvREFCNT_inc_simple_NN(gv), oav, SAVEt_AV);
 385
 386     GvAV(gv) = NULL;
 387     av = GvAVn(gv);
 388     if (UNLIKELY(SvMAGIC(oav)))
 389         mg_localize(MUTABLE_SV(oav), MUTABLE_SV(av), TRUE);
 390     return av;
 391 }
 392
 393 HV *
 394 Perl_save_hash(pTHX_ GV *gv)
 395 {
 396     HV *ohv, *hv;
 397
 398     PERL_ARGS_ASSERT_SAVE_HASH;
 399
 400     save_pushptrptr(
 401         SvREFCNT_inc_simple_NN(gv), (ohv = GvHVn(gv)), SAVEt_HV
 402     );
 403
 404     GvHV(gv) = NULL;
 405     hv = GvHVn(gv);
 406     if (UNLIKELY(SvMAGIC(ohv)))
 407         mg_localize(MUTABLE_SV(ohv), MUTABLE_SV(hv), TRUE);
 408     return hv;
 409 }
 410
 411 void
 412 Perl_save_item(pTHX_ SV *item)
 413 {
 414     SV * const sv = newSVsv(item);
 415
 416     PERL_ARGS_ASSERT_SAVE_ITEM;
 417
 418     save_pushptrptr(item, /* remember the pointer */
 419                     sv,   /* remember the value */
 420                     SAVEt_ITEM);
 421 }
 422
 423 void
 424 Perl_save_bool(pTHX_ bool *boolp)
 425 {
 426     dSS_ADD;
 427
 428     PERL_ARGS_ASSERT_SAVE_BOOL;
 429
 430     SS_ADD_PTR(boolp);
 431     SS_ADD_UV(SAVEt_BOOL | (*boolp << 8));
 432     SS_ADD_END(2);
 433 }
 434
 435 void
 436 Perl_save_pushi32ptr(pTHX_ const I32 i, void *const ptr, const int type)
 437 {
 438     dSS_ADD;
 439
 440     SS_ADD_INT(i);
 441     SS_ADD_PTR(ptr);
 442     SS_ADD_UV(type);
 443     SS_ADD_END(3);
 444 }
 445
 446 void
 447 Perl_save_int(pTHX_ int *intp)
 448 {
 449     const int i = *intp;
 450     UV type = ((UV)((UV)i << SAVE_TIGHT_SHIFT) | SAVEt_INT_SMALL);
 451     int size = 2;
 452     dSS_ADD;
 453
 454     PERL_ARGS_ASSERT_SAVE_INT;
 455
 456     if (UNLIKELY((int)(type >> SAVE_TIGHT_SHIFT) != i)) {
 457         SS_ADD_INT(i);
 458         type = SAVEt_INT;
 459         size++;
 460     }
 461     SS_ADD_PTR(intp);
 462     SS_ADD_UV(type);
 463     SS_ADD_END(size);
 464 }
 465
 466 void
 467 Perl_save_I8(pTHX_ I8 *bytep)
 468 {
 469     dSS_ADD;
 470
 471     PERL_ARGS_ASSERT_SAVE_I8;
 472
 473     SS_ADD_PTR(bytep);
 474     SS_ADD_UV(SAVEt_I8 | ((UV)*bytep << 8));
 475     SS_ADD_END(2);
 476 }
 477
 478 void
 479 Perl_save_I16(pTHX_ I16 *intp)
 480 {
 481     dSS_ADD;
 482
 483     PERL_ARGS_ASSERT_SAVE_I16;
 484
 485     SS_ADD_PTR(intp);
 486     SS_ADD_UV(SAVEt_I16 | ((UV)*intp << 8));
 487     SS_ADD_END(2);
 488 }
 489
 490 void
 491 Perl_save_I32(pTHX_ I32 *intp)
 492 {
 493     const I32 i = *intp;
 494     UV type = ((I32)((U32)i << SAVE_TIGHT_SHIFT) | SAVEt_I32_SMALL);
 495     int size = 2;
 496     dSS_ADD;
 497
 498     PERL_ARGS_ASSERT_SAVE_I32;
 499
 500     if (UNLIKELY((I32)(type >> SAVE_TIGHT_SHIFT) != i)) {
 501         SS_ADD_INT(i);
 502         type = SAVEt_I32;
 503         size++;
 504     }
 505     SS_ADD_PTR(intp);
 506     SS_ADD_UV(type);
 507     SS_ADD_END(size);
 508 }
 509
 510 void
 511 Perl_save_strlen(pTHX_ STRLEN *ptr)
 512 {
 513     dSS_ADD;
 514
 515     PERL_ARGS_ASSERT_SAVE_STRLEN;
 516
 517     SS_ADD_IV(*ptr);
 518     SS_ADD_PTR(ptr);
 519     SS_ADD_UV(SAVEt_STRLEN);
 520     SS_ADD_END(3);
 521 }
 522
 523 void
 524 Perl_save_iv(pTHX_ IV *ivp)
 525 {
 526     PERL_ARGS_ASSERT_SAVE_IV;
 527
 528     SSCHECK(3);
 529     SSPUSHIV(*ivp);
 530     SSPUSHPTR(ivp);
 531     SSPUSHUV(SAVEt_IV);
 532 }
 533
 534 /* Cannot use save_sptr() to store a char* since the SV** cast will
 535  * force word-alignment and we'll miss the pointer.
 536  */
 537 void
 538 Perl_save_pptr(pTHX_ char **pptr)
 539 {
 540     PERL_ARGS_ASSERT_SAVE_PPTR;
 541
 542     save_pushptrptr(*pptr, pptr, SAVEt_PPTR);
 543 }
 544
 545 void
 546 Perl_save_vptr(pTHX_ void *ptr)
 547 {
 548     PERL_ARGS_ASSERT_SAVE_VPTR;
 549
 550     save_pushptrptr(*(char**)ptr, ptr, SAVEt_VPTR);
 551 }
 552
 553 void
 554 Perl_save_sptr(pTHX_ SV **sptr)
 555 {
 556     PERL_ARGS_ASSERT_SAVE_SPTR;
 557
 558     save_pushptrptr(*sptr, sptr, SAVEt_SPTR);
 559 }
 560
 561 void
 562 Perl_save_padsv_and_mortalize(pTHX_ PADOFFSET off)
 563 {
 564     dSS_ADD;
 565
 566     ASSERT_CURPAD_ACTIVE("save_padsv");
 567     SS_ADD_PTR(SvREFCNT_inc_simple_NN(PL_curpad[off]));
 568     SS_ADD_PTR(PL_comppad);
 569     SS_ADD_UV((UV)off);
 570     SS_ADD_UV(SAVEt_PADSV_AND_MORTALIZE);
 571     SS_ADD_END(4);
 572 }
 573
 574 void
 575 Perl_save_hptr(pTHX_ HV **hptr)
 576 {
 577     PERL_ARGS_ASSERT_SAVE_HPTR;
 578
 579     save_pushptrptr(*hptr, hptr, SAVEt_HPTR);
 580 }
 581
 582 void
 583 Perl_save_aptr(pTHX_ AV **aptr)
 584 {
 585     PERL_ARGS_ASSERT_SAVE_APTR;
 586
 587     save_pushptrptr(*aptr, aptr, SAVEt_APTR);
 588 }
 589
 590 void
 591 Perl_save_pushptr(pTHX_ void *const ptr, const int type)
 592 {
 593     dSS_ADD;
 594     SS_ADD_PTR(ptr);
 595     SS_ADD_UV(type);
 596     SS_ADD_END(2);
 597 }
 598
 599 void
 600 Perl_save_clearsv(pTHX_ SV **svp)
 601 {
 602     const UV offset = svp - PL_curpad;
 603     const UV offset_shifted = offset << SAVE_TIGHT_SHIFT;
 604
 605     PERL_ARGS_ASSERT_SAVE_CLEARSV;
 606
 607     ASSERT_CURPAD_ACTIVE("save_clearsv");
 608     SvPADSTALE_off(*svp); /* mark lexical as active */
 609     if (UNLIKELY((offset_shifted >> SAVE_TIGHT_SHIFT) != offset)) {
 610         Perl_croak(aTHX_ "panic: pad offset %" UVuf " out of range (%p-%p)",
 611                    offset, svp, PL_curpad);
 612     }
 613
 614     {
 615         dSS_ADD;
 616         SS_ADD_UV(offset_shifted | SAVEt_CLEARSV);
 617         SS_ADD_END(1);
 618     }
 619 }
 620
 621 void
 622 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
 623 {
 624     PERL_ARGS_ASSERT_SAVE_DELETE;
 625
 626     save_pushptri32ptr(key, klen, SvREFCNT_inc_simple(hv), SAVEt_DELETE);
 627 }
 628
 629 void
 630 Perl_save_hdelete(pTHX_ HV *hv, SV *keysv)
 631 {
 632     STRLEN len;
 633     I32 klen;
 634     const char *key;
 635
 636     PERL_ARGS_ASSERT_SAVE_HDELETE;
 637
 638     key  = SvPV_const(keysv, len);
 639     klen = SvUTF8(keysv) ? -(I32)len : (I32)len;
 640     SvREFCNT_inc_simple_void_NN(hv);
 641     save_pushptri32ptr(savepvn(key, len), klen, hv, SAVEt_DELETE);
 642 }
 643
 644 void
 645 Perl_save_adelete(pTHX_ AV *av, SSize_t key)
 646 {
 647     dSS_ADD;
 648
 649     PERL_ARGS_ASSERT_SAVE_ADELETE;
 650
 651     SvREFCNT_inc_void(av);
 652     SS_ADD_UV(key);
 653     SS_ADD_PTR(av);
 654     SS_ADD_IV(SAVEt_ADELETE);
 655     SS_ADD_END(3);
 656 }
 657
 658 void
 659 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
 660 {
 661     dSS_ADD;
 662     PERL_ARGS_ASSERT_SAVE_DESTRUCTOR;
 663
 664     SS_ADD_DPTR(f);
 665     SS_ADD_PTR(p);
 666     SS_ADD_UV(SAVEt_DESTRUCTOR);
 667     SS_ADD_END(3);
 668 }
 669
 670 void
 671 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
 672 {
 673     dSS_ADD;
 674
 675     SS_ADD_DXPTR(f);
 676     SS_ADD_PTR(p);
 677     SS_ADD_UV(SAVEt_DESTRUCTOR_X);
 678     SS_ADD_END(3);
 679 }
 680
 681 void
 682 Perl_save_hints(pTHX)
 683 {
 684     COPHH *save_cophh = cophh_copy(CopHINTHASH_get(&PL_compiling));
 685     if (PL_hints & HINT_LOCALIZE_HH) {
 686         HV *oldhh = GvHV(PL_hintgv);
 687         save_pushptri32ptr(oldhh, PL_hints, save_cophh, SAVEt_HINTS);
 688         GvHV(PL_hintgv) = NULL; /* in case copying dies */
 689         GvHV(PL_hintgv) = hv_copy_hints_hv(oldhh);
 690     } else {
 691         save_pushi32ptr(PL_hints, save_cophh, SAVEt_HINTS);
 692     }
 693 }
 694
 695 static void
 696 S_save_pushptri32ptr(pTHX_ void *const ptr1, const I32 i, void *const ptr2,
 697                         const int type)
 698 {
 699     dSS_ADD;
 700     SS_ADD_PTR(ptr1);
 701     SS_ADD_INT(i);
 702     SS_ADD_PTR(ptr2);
 703     SS_ADD_UV(type);
 704     SS_ADD_END(4);
 705 }
 706
 707 void
 708 Perl_save_aelem_flags(pTHX_ AV *av, SSize_t idx, SV **sptr,
 709                             const U32 flags)
 710 {
 711     dSS_ADD;
 712     SV *sv;
 713
 714     PERL_ARGS_ASSERT_SAVE_AELEM_FLAGS;
 715
 716     SvGETMAGIC(*sptr);
 717     SS_ADD_PTR(SvREFCNT_inc_simple(av));
 718     SS_ADD_IV(idx);
 719     SS_ADD_PTR(SvREFCNT_inc(*sptr));
 720     SS_ADD_UV(SAVEt_AELEM);
 721     SS_ADD_END(4);
 722     /* The array needs to hold a reference count on its new element, so it
 723        must be AvREAL. */
 724     if (UNLIKELY(!AvREAL(av) && AvREIFY(av)))
 725         av_reify(av);
 726     save_scalar_at(sptr, flags); /* XXX - FIXME - see #60360 */
 727     if (flags & SAVEf_KEEPOLDELEM)
 728         return;
 729     sv = *sptr;
 730     /* If we're localizing a tied array element, this new sv
 731      * won't actually be stored in the array - so it won't get
 732      * reaped when the localize ends. Ensure it gets reaped by
 733      * mortifying it instead. DAPM */
 734     if (UNLIKELY(SvTIED_mg((const SV *)av, PERL_MAGIC_tied)))
 735         sv_2mortal(sv);
 736 }
 737
 738 void
 739 Perl_save_helem_flags(pTHX_ HV *hv, SV *key, SV **sptr, const U32 flags)
 740 {
 741     SV *sv;
 742
 743     PERL_ARGS_ASSERT_SAVE_HELEM_FLAGS;
 744
 745     SvGETMAGIC(*sptr);
 746     {
 747         dSS_ADD;
 748         SS_ADD_PTR(SvREFCNT_inc_simple(hv));
 749         SS_ADD_PTR(newSVsv(key));
 750         SS_ADD_PTR(SvREFCNT_inc(*sptr));
 751         SS_ADD_UV(SAVEt_HELEM);
 752         SS_ADD_END(4);
 753     }
 754     save_scalar_at(sptr, flags);
 755     if (flags & SAVEf_KEEPOLDELEM)
 756         return;
 757     sv = *sptr;
 758     /* If we're localizing a tied hash element, this new sv
 759      * won't actually be stored in the hash - so it won't get
 760      * reaped when the localize ends. Ensure it gets reaped by
 761      * mortifying it instead. DAPM */
 762     if (UNLIKELY(SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)))
 763         sv_2mortal(sv);
 764 }
 765
 766 SV*
 767 Perl_save_svref(pTHX_ SV **sptr)
 768 {
 769     PERL_ARGS_ASSERT_SAVE_SVREF;
 770
 771     SvGETMAGIC(*sptr);
 772     save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_SVREF);
 773     return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
 774 }
 775
 776
 777 void
 778 Perl_savetmps(pTHX)
 779 {
 780     dSS_ADD;
 781     SS_ADD_IV(PL_tmps_floor);
 782     PL_tmps_floor = PL_tmps_ix;
 783     SS_ADD_UV(SAVEt_TMPSFLOOR);
 784     SS_ADD_END(2);
 785 }
 786
 787
 788 I32
 789 Perl_save_alloc(pTHX_ I32 size, I32 pad)
 790 {
 791     const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
 792                           - (char*)PL_savestack);
 793     const UV elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
 794     const UV elems_shifted = elems << SAVE_TIGHT_SHIFT;
 795
 796     if (UNLIKELY((elems_shifted >> SAVE_TIGHT_SHIFT) != elems))
 797         Perl_croak(aTHX_
 798             "panic: save_alloc elems %" UVuf " out of range (%" IVdf "-%" IVdf ")",
 799                    elems, (IV)size, (IV)pad);
 800
 801     SSGROW(elems + 1);
 802
 803     PL_savestack_ix += elems;
 804     SSPUSHUV(SAVEt_ALLOC | elems_shifted);
 805     return start;
 806 }
 807
 808
 809 static const U8 arg_counts[] = {
 810     0, /* SAVEt_ALLOC              */
 811     0, /* SAVEt_CLEARPADRANGE      */
 812     0, /* SAVEt_CLEARSV            */
 813     0, /* SAVEt_REGCONTEXT         */
 814     1, /* SAVEt_TMPSFLOOR          */
 815     1, /* SAVEt_BOOL               */
 816     1, /* SAVEt_COMPILE_WARNINGS   */
 817     1, /* SAVEt_COMPPAD            */
 818     1, /* SAVEt_FREECOPHH          */
 819     1, /* SAVEt_FREEOP             */
 820     1, /* SAVEt_FREEPV             */
 821     1, /* SAVEt_FREESV             */
 822     1, /* SAVEt_I16                */
 823     1, /* SAVEt_I32_SMALL          */
 824     1, /* SAVEt_I8                 */
 825     1, /* SAVEt_INT_SMALL          */
 826     1, /* SAVEt_MORTALIZESV        */
 827     1, /* SAVEt_NSTAB              */
 828     1, /* SAVEt_OP                 */
 829     1, /* SAVEt_PARSER             */
 830     1, /* SAVEt_STACK_POS          */
 831     1, /* SAVEt_READONLY_OFF       */
 832     1, /* SAVEt_FREEPADNAME        */
 833     2, /* SAVEt_AV                 */
 834     2, /* SAVEt_DESTRUCTOR         */
 835     2, /* SAVEt_DESTRUCTOR_X       */
 836     2, /* SAVEt_GENERIC_PVREF      */
 837     2, /* SAVEt_GENERIC_SVREF      */
 838     2, /* SAVEt_GP                 */
 839     2, /* SAVEt_GVSV               */
 840     2, /* SAVEt_HINTS              */
 841     2, /* SAVEt_HPTR               */
 842     2, /* SAVEt_HV                 */
 843     2, /* SAVEt_I32                */
 844     2, /* SAVEt_INT                */
 845     2, /* SAVEt_ITEM               */
 846     2, /* SAVEt_IV                 */
 847     2, /* SAVEt_LONG               */
 848     2, /* SAVEt_PPTR               */
 849     2, /* SAVEt_SAVESWITCHSTACK    */
 850     2, /* SAVEt_SHARED_PVREF       */
 851     2, /* SAVEt_SPTR               */
 852     2, /* SAVEt_STRLEN             */
 853     2, /* SAVEt_SV                 */
 854     2, /* SAVEt_SVREF              */
 855     2, /* SAVEt_VPTR               */
 856     2, /* SAVEt_ADELETE            */
 857     2, /* SAVEt_APTR               */
 858     3, /* SAVEt_HELEM              */
 859     3, /* SAVEt_PADSV_AND_MORTALIZE*/
 860     3, /* SAVEt_SET_SVFLAGS        */
 861     3, /* SAVEt_GVSLOT             */
 862     3, /* SAVEt_AELEM              */
 863     3  /* SAVEt_DELETE             */
 864 };
 865
 866
 867 void
 868 Perl_leave_scope(pTHX_ I32 base)
 869 {
 870     /* Localise the effects of the TAINT_NOT inside the loop.  */
 871     bool was = TAINT_get;
 872
 873     if (UNLIKELY(base < -1))
 874         Perl_croak(aTHX_ "panic: corrupt saved stack index %ld", (long) base);
 875     DEBUG_l(Perl_deb(aTHX_ "savestack: releasing items %ld -> %ld\n",
 876                         (long)PL_savestack_ix, (long)base));
 877     while (PL_savestack_ix > base) {
 878         UV uv;
 879         U8 type;
 880         ANY *ap; /* arg pointer */
 881         ANY a0, a1, a2; /* up to 3 args */
 882
 883         TAINT_NOT;
 884
 885         {
 886             U8  argcount;
 887             I32 ix = PL_savestack_ix - 1;
 888
 889             ap = &PL_savestack[ix];
 890             uv = ap->any_uv;
 891             type = (U8)uv & SAVE_MASK;
 892             argcount = arg_counts[type];
 893             PL_savestack_ix = ix - argcount;
 894             ap -= argcount;
 895         }
 896
 897         switch (type) {
 898         case SAVEt_ITEM:                        /* normal string */
 899             a0 = ap[0]; a1 = ap[1];
 900             sv_replace(a0.any_sv, a1.any_sv);
 901             if (UNLIKELY(SvSMAGICAL(a0.any_sv))) {
 902                 PL_localizing = 2;
 903                 mg_set(a0.any_sv);
 904                 PL_localizing = 0;
 905             }
 906             break;
 907
 908             /* This would be a mathom, but Perl_save_svref() calls a static
 909                function, S_save_scalar_at(), so has to stay in this file.  */
 910         case SAVEt_SVREF:                       /* scalar reference */
 911             a0 = ap[0]; a1 = ap[1];
 912             a2.any_svp = a0.any_svp;
 913             a0.any_sv = NULL; /* what to refcnt_dec */
 914             goto restore_sv;
 915
 916         case SAVEt_SV:                          /* scalar reference */
 917             a0 = ap[0]; a1 = ap[1];
 918             a2.any_svp = &GvSV(a0.any_gv);
 919         restore_sv:
 920         {
 921             /* do *a2.any_svp = a1 and free a0 */
 922             SV * const sv = *a2.any_svp;
 923             *a2.any_svp = a1.any_sv;
 924             SvREFCNT_dec(sv);
 925             if (UNLIKELY(SvSMAGICAL(a1.any_sv))) {
 926                 /* mg_set could die, skipping the freeing of a0 and
 927                  * a1; Ensure that they're always freed in that case */
 928                 dSS_ADD;
 929                 SS_ADD_PTR(a1.any_sv);
 930                 SS_ADD_UV(SAVEt_FREESV);
 931                 SS_ADD_PTR(a0.any_sv);
 932                 SS_ADD_UV(SAVEt_FREESV);
 933                 SS_ADD_END(4);
 934                 PL_localizing = 2;
 935                 mg_set(a1.any_sv);
 936                 PL_localizing = 0;
 937                 break;
 938             }
 939             SvREFCNT_dec_NN(a1.any_sv);
 940             SvREFCNT_dec(a0.any_sv);
 941             break;
 942         }
 943
 944         case SAVEt_GENERIC_PVREF:               /* generic pv */
 945             a0 = ap[0]; a1 = ap[1];
 946             if (*a1.any_pvp != a0.any_pv) {
 947                 Safefree(*a1.any_pvp);
 948                 *a1.any_pvp = a0.any_pv;
 949             }
 950             break;
 951
 952         case SAVEt_SHARED_PVREF:                /* shared pv */
 953             a0 = ap[0]; a1 = ap[1];
 954             if (*a0.any_pvp != a1.any_pv) {
 955 #ifdef NETWARE
 956                 PerlMem_free(*a0.any_pvp);
 957 #else
 958                 PerlMemShared_free(*a0.any_pvp);
 959 #endif
 960                 *a0.any_pvp = a1.any_pv;
 961             }
 962             break;
 963
 964         case SAVEt_GVSV:                        /* scalar slot in GV */
 965             a0 = ap[0]; a1 = ap[1];
 966             a0.any_svp = &GvSV(a0.any_gv);
 967             goto restore_svp;
 968
 969         case SAVEt_GENERIC_SVREF:               /* generic sv */
 970             a0 = ap[0]; a1 = ap[1];
 971         restore_svp:
 972         {
 973             /* do *a0.any_svp = a1 */
 974             SV * const sv = *a0.any_svp;
 975             *a0.any_svp = a1.any_sv;
 976             SvREFCNT_dec(sv);
 977             SvREFCNT_dec(a1.any_sv);
 978             break;
 979         }
 980
 981         case SAVEt_GVSLOT:                      /* any slot in GV */
 982         {
 983             HV * hv;
 984             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
 985             hv = GvSTASH(a0.any_gv);
 986             if (hv && HvENAME(hv) && (
 987                     (a2.any_sv && SvTYPE(a2.any_sv) == SVt_PVCV)
 988                  || (*a1.any_svp && SvTYPE(*a1.any_svp) == SVt_PVCV)
 989                ))
 990             {
 991                 if ((char *)a1.any_svp < (char *)GvGP(a0.any_gv)
 992                  || (char *)a1.any_svp > (char *)GvGP(a0.any_gv) + sizeof(struct gp)
 993                  || GvREFCNT(a0.any_gv) > 2) /* "> 2" to ignore savestack's ref */
 994                     PL_sub_generation++;
 995                 else mro_method_changed_in(hv);
 996             }
 997             a0.any_svp = a1.any_svp;
 998             a1.any_sv  = a2.any_sv;
 999             goto restore_svp;
1000         }
1001
1002         case SAVEt_AV:                          /* array reference */
1003             a0 = ap[0]; a1 = ap[1];
1004             SvREFCNT_dec(GvAV(a0.any_gv));
1005             GvAV(a0.any_gv) = a1.any_av;
1006           avhv_common:
1007             if (UNLIKELY(SvSMAGICAL(a1.any_sv))) {
1008                 /* mg_set might die, so make sure a0 isn't leaked */
1009                 dSS_ADD;
1010                 SS_ADD_PTR(a0.any_sv);
1011                 SS_ADD_UV(SAVEt_FREESV);
1012                 SS_ADD_END(2);
1013                 PL_localizing = 2;
1014                 mg_set(a1.any_sv);
1015                 PL_localizing = 0;
1016                 break;
1017             }
1018             SvREFCNT_dec_NN(a0.any_sv);
1019             break;
1020
1021         case SAVEt_HV:                          /* hash reference */
1022             a0 = ap[0]; a1 = ap[1];
1023             SvREFCNT_dec(GvHV(a0.any_gv));
1024             GvHV(a0.any_gv) = a1.any_hv;
1025             goto avhv_common;
1026
1027         case SAVEt_INT_SMALL:
1028             a0 = ap[0];
1029             *(int*)a0.any_ptr = (int)(uv >> SAVE_TIGHT_SHIFT);
1030             break;
1031
1032         case SAVEt_INT:                         /* int reference */
1033             a0 = ap[0]; a1 = ap[1];
1034             *(int*)a1.any_ptr = (int)a0.any_i32;
1035             break;
1036
1037         case SAVEt_STRLEN:                      /* STRLEN/size_t ref */
1038             a0 = ap[0]; a1 = ap[1];
1039             *(STRLEN*)a1.any_ptr = (STRLEN)a0.any_iv;
1040             break;
1041
1042         case SAVEt_TMPSFLOOR:                   /* restore PL_tmps_floor */
1043             a0 = ap[0];
1044             PL_tmps_floor = (SSize_t)a0.any_iv;
1045             break;
1046
1047         case SAVEt_BOOL:                        /* bool reference */
1048             a0 = ap[0];
1049             *(bool*)a0.any_ptr = cBOOL(uv >> 8);
1050 #ifdef NO_TAINT_SUPPORT
1051             PERL_UNUSED_VAR(was);
1052 #else
1053             if (UNLIKELY(a0.any_ptr == &(TAINT_get))) {
1054                 /* If we don't update <was>, to reflect what was saved on the
1055                  * stack for PL_tainted, then we will overwrite this attempt to
1056                  * restore it when we exit this routine.  Note that this won't
1057                  * work if this value was saved in a wider-than necessary type,
1058                  * such as I32 */
1059                 was = *(bool*)a0.any_ptr;
1060             }
1061 #endif
1062             break;
1063
1064         case SAVEt_I32_SMALL:
1065             a0 = ap[0];
1066             *(I32*)a0.any_ptr = (I32)(uv >> SAVE_TIGHT_SHIFT);
1067             break;
1068
1069         case SAVEt_I32:                         /* I32 reference */
1070             a0 = ap[0]; a1 = ap[1];
1071 #ifdef PERL_DEBUG_READONLY_OPS
1072             if (*(I32*)a1.any_ptr != a0.any_i32)
1073 #endif
1074                 *(I32*)a1.any_ptr = a0.any_i32;
1075             break;
1076
1077         case SAVEt_SPTR:                        /* SV* reference */
1078         case SAVEt_VPTR:                        /* random* reference */
1079         case SAVEt_PPTR:                        /* char* reference */
1080         case SAVEt_HPTR:                        /* HV* reference */
1081         case SAVEt_APTR:                        /* AV* reference */
1082             a0 = ap[0]; a1 = ap[1];
1083             *a1.any_svp= a0.any_sv;
1084             break;
1085
1086         case SAVEt_GP:                          /* scalar reference */
1087         {
1088             HV *hv;
1089             bool had_method;
1090
1091             a0 = ap[0]; a1 = ap[1];
1092             /* possibly taking a method out of circulation */
1093             had_method = !!GvCVu(a0.any_gv);
1094             gp_free(a0.any_gv);
1095             GvGP_set(a0.any_gv, (GP*)a1.any_ptr);
1096             if ((hv=GvSTASH(a0.any_gv)) && HvENAME_get(hv)) {
1097                 if (memEQs(GvNAME(a0.any_gv), GvNAMELEN(a0.any_gv), "ISA"))
1098                     mro_isa_changed_in(hv);
1099                 else if (had_method || GvCVu(a0.any_gv))
1100                     /* putting a method back into circulation ("local")*/
1101                     gv_method_changed(a0.any_gv);
1102             }
1103             SvREFCNT_dec_NN(a0.any_gv);
1104             break;
1105         }
1106
1107         case SAVEt_FREESV:
1108             a0 = ap[0];
1109             SvREFCNT_dec(a0.any_sv);
1110             break;
1111
1112         case SAVEt_FREEPADNAME:
1113             a0 = ap[0];
1114             PadnameREFCNT_dec((PADNAME *)a0.any_ptr);
1115             break;
1116
1117         case SAVEt_FREECOPHH:
1118             a0 = ap[0];
1119             cophh_free((COPHH *)a0.any_ptr);
1120             break;
1121
1122         case SAVEt_MORTALIZESV:
1123             a0 = ap[0];
1124             sv_2mortal(a0.any_sv);
1125             break;
1126
1127         case SAVEt_FREEOP:
1128             a0 = ap[0];
1129             ASSERT_CURPAD_LEGAL("SAVEt_FREEOP");
1130             op_free(a0.any_op);
1131             break;
1132
1133         case SAVEt_FREEPV:
1134             a0 = ap[0];
1135             Safefree(a0.any_ptr);
1136             break;
1137
1138         case SAVEt_CLEARPADRANGE:
1139         {
1140             I32 i;
1141             SV **svp;
1142             i = (I32)((uv >> SAVE_TIGHT_SHIFT) & OPpPADRANGE_COUNTMASK);
1143             svp = &PL_curpad[uv >>
1144                     (OPpPADRANGE_COUNTSHIFT + SAVE_TIGHT_SHIFT)] + i - 1;
1145             goto clearsv;
1146         case SAVEt_CLEARSV:
1147             svp = &PL_curpad[uv >> SAVE_TIGHT_SHIFT];
1148             i = 1;
1149           clearsv:
1150             for (; i; i--, svp--) {
1151                 SV *sv = *svp;
1152
1153                 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1154              "Pad 0x%" UVxf "[0x%" UVxf "] clearsv: %ld sv=0x%" UVxf "<%" IVdf "> %s\n",
1155                     PTR2UV(PL_comppad), PTR2UV(PL_curpad),
1156                     (long)(svp-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
1157                     (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
1158                 ));
1159
1160                 /* Can clear pad variable in place? */
1161                 if (SvREFCNT(sv) == 1 && !SvOBJECT(sv)) {
1162
1163                     /* these flags are the union of all the relevant flags
1164                      * in the individual conditions within */
1165                     if (UNLIKELY(SvFLAGS(sv) & (
1166                             SVf_READONLY|SVf_PROTECT /*for SvREADONLY_off*/
1167                           | (SVs_GMG|SVs_SMG|SVs_RMG) /* SvMAGICAL() */
1168                           | SVf_OOK
1169                           | SVf_THINKFIRST)))
1170                     {
1171                         /* if a my variable that was made readonly is
1172                          * going out of scope, we want to remove the
1173                          * readonlyness so that it can go out of scope
1174                          * quietly
1175                          */
1176                         if (SvREADONLY(sv))
1177                             SvREADONLY_off(sv);
1178
1179                         if (SvOOK(sv)) { /* OOK or HvAUX */
1180                             if (SvTYPE(sv) == SVt_PVHV)
1181                                 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
1182                             else
1183                                 sv_backoff(sv);
1184                         }
1185
1186                         if (SvMAGICAL(sv)) {
1187                             /* note that backrefs (either in HvAUX or magic)
1188                              * must be removed before other magic */
1189                             sv_unmagic(sv, PERL_MAGIC_backref);
1190                             if (SvTYPE(sv) != SVt_PVCV)
1191                                 mg_free(sv);
1192                         }
1193                         if (SvTHINKFIRST(sv))
1194                             sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF
1195                                                      |SV_COW_DROP_PV);
1196
1197                     }
1198                     switch (SvTYPE(sv)) {
1199                     case SVt_NULL:
1200                         break;
1201                     case SVt_PVAV:
1202                         av_clear(MUTABLE_AV(sv));
1203                         break;
1204                     case SVt_PVHV:
1205                         hv_clear(MUTABLE_HV(sv));
1206                         break;
1207                     case SVt_PVCV:
1208                     {
1209                         HEK *hek = CvGvNAME_HEK(sv);
1210                         assert(hek);
1211                         (void)share_hek_hek(hek);
1212                         cv_undef((CV *)sv);
1213                         CvNAME_HEK_set(sv, hek);
1214                         CvLEXICAL_on(sv);
1215                         break;
1216                     }
1217                     default:
1218                         /* This looks odd, but these two macros are for use in
1219                            expressions and finish with a trailing comma, so
1220                            adding a ; after them would be wrong. */
1221                         assert_not_ROK(sv)
1222                         assert_not_glob(sv)
1223                         SvFLAGS(sv) &=~ (SVf_OK|SVf_IVisUV|SVf_UTF8);
1224                         break;
1225                     }
1226                     SvPADTMP_off(sv);
1227                     SvPADSTALE_on(sv); /* mark as no longer live */
1228                 }
1229                 else {  /* Someone has a claim on this, so abandon it. */
1230                     switch (SvTYPE(sv)) {       /* Console ourselves with a new value */
1231                     case SVt_PVAV:      *svp = MUTABLE_SV(newAV());     break;
1232                     case SVt_PVHV:      *svp = MUTABLE_SV(newHV());     break;
1233                     case SVt_PVCV:
1234                     {
1235                         HEK * const hek = CvGvNAME_HEK(sv);
1236
1237                         /* Create a stub */
1238                         *svp = newSV_type(SVt_PVCV);
1239
1240                         /* Share name */
1241                         CvNAME_HEK_set(*svp,
1242                                        share_hek_hek(hek));
1243                         CvLEXICAL_on(*svp);
1244                         break;
1245                     }
1246                     default:    *svp = newSV(0);                break;
1247                     }
1248                     SvREFCNT_dec_NN(sv); /* Cast current value to the winds. */
1249                     /* preserve pad nature, but also mark as not live
1250                      * for any closure capturing */
1251                     SvFLAGS(*svp) |= SVs_PADSTALE;
1252                 }
1253             }
1254             break;
1255         }
1256
1257         case SAVEt_DELETE:
1258             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1259             /* hv_delete could die, so free the key and SvREFCNT_dec the
1260              * hv by pushing new save actions
1261              */
1262             /* ap[0] is the key */
1263             ap[1].any_uv = SAVEt_FREEPV; /* was len */
1264             /* ap[2] is the hv */
1265             ap[3].any_uv = SAVEt_FREESV; /* was SAVEt_DELETE */
1266             PL_savestack_ix += 4;
1267             (void)hv_delete(a2.any_hv, a0.any_pv, a1.any_i32, G_DISCARD);
1268             break;
1269
1270         case SAVEt_ADELETE:
1271             a0 = ap[0]; a1 = ap[1];
1272             /* av_delete could die, so SvREFCNT_dec the av by pushing a
1273              * new save action
1274              */
1275             ap[0].any_av = a1.any_av;
1276             ap[1].any_uv = SAVEt_FREESV;
1277             PL_savestack_ix += 2;
1278             (void)av_delete(a1.any_av, a0.any_iv, G_DISCARD);
1279             break;
1280
1281         case SAVEt_DESTRUCTOR_X:
1282             a0 = ap[0]; a1 = ap[1];
1283             (*a0.any_dxptr)(aTHX_ a1.any_ptr);
1284             break;
1285
1286         case SAVEt_REGCONTEXT:
1287             /* regexp must have croaked */
1288         case SAVEt_ALLOC:
1289             PL_savestack_ix -= uv >> SAVE_TIGHT_SHIFT;
1290             break;
1291
1292         case SAVEt_STACK_POS:           /* Position on Perl stack */
1293             a0 = ap[0];
1294             PL_stack_sp = PL_stack_base + a0.any_i32;
1295             break;
1296
1297         case SAVEt_AELEM:               /* array element */
1298         {
1299             SV **svp;
1300             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1301             svp = av_fetch(a0.any_av, a1.any_iv, 1);
1302             if (UNLIKELY(!AvREAL(a0.any_av) && AvREIFY(a0.any_av))) /* undo reify guard */
1303                 SvREFCNT_dec(a2.any_sv);
1304             if (LIKELY(svp)) {
1305                 SV * const sv = *svp;
1306                 if (LIKELY(sv && sv != &PL_sv_undef)) {
1307                     if (UNLIKELY(SvTIED_mg((const SV *)a0.any_av, PERL_MAGIC_tied)))
1308                         SvREFCNT_inc_void_NN(sv);
1309                     a1.any_sv  = a2.any_sv;
1310                     a2.any_svp = svp;
1311                     goto restore_sv;
1312                 }
1313             }
1314             SvREFCNT_dec(a0.any_av);
1315             SvREFCNT_dec(a2.any_sv);
1316             break;
1317         }
1318
1319         case SAVEt_HELEM:               /* hash element */
1320         {
1321             HE *he;
1322
1323             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1324             he = hv_fetch_ent(a0.any_hv, a1.any_sv, 1, 0);
1325             SvREFCNT_dec(a1.any_sv);
1326             if (LIKELY(he)) {
1327                 const SV * const oval = HeVAL(he);
1328                 if (LIKELY(oval && oval != &PL_sv_undef)) {
1329                     SV **svp = &HeVAL(he);
1330                     if (UNLIKELY(SvTIED_mg((const SV *)a0.any_hv, PERL_MAGIC_tied)))
1331                         SvREFCNT_inc_void(*svp);
1332                     a1.any_sv  = a2.any_sv;
1333                     a2.any_svp = svp;
1334                     goto restore_sv;
1335                 }
1336             }
1337             SvREFCNT_dec(a0.any_hv);
1338             SvREFCNT_dec(a2.any_sv);
1339             break;
1340         }
1341
1342         case SAVEt_OP:
1343             a0 = ap[0];
1344             PL_op = (OP*)a0.any_ptr;
1345             break;
1346
1347         case SAVEt_HINTS:
1348             a0 = ap[0]; a1 = ap[1];
1349             if ((PL_hints & HINT_LOCALIZE_HH)) {
1350               while (GvHV(PL_hintgv)) {
1351                 HV *hv = GvHV(PL_hintgv);
1352                 GvHV(PL_hintgv) = NULL;
1353                 SvREFCNT_dec(MUTABLE_SV(hv));
1354               }
1355             }
1356             cophh_free(CopHINTHASH_get(&PL_compiling));
1357             CopHINTHASH_set(&PL_compiling, (COPHH*)a1.any_ptr);
1358             *(I32*)&PL_hints = a0.any_i32;
1359             if (PL_hints & HINT_LOCALIZE_HH) {
1360                 SvREFCNT_dec(MUTABLE_SV(GvHV(PL_hintgv)));
1361                 GvHV(PL_hintgv) = MUTABLE_HV(SSPOPPTR);
1362             }
1363             if (!GvHV(PL_hintgv)) {
1364                 /* Need to add a new one manually, else rv2hv can
1365                    add one via GvHVn and it won't have the magic set.  */
1366                 HV *const hv = newHV();
1367                 hv_magic(hv, NULL, PERL_MAGIC_hints);
1368                 GvHV(PL_hintgv) = hv;
1369             }
1370             assert(GvHV(PL_hintgv));
1371             break;
1372
1373         case SAVEt_COMPPAD:
1374             a0 = ap[0];
1375             PL_comppad = (PAD*)a0.any_ptr;
1376             if (LIKELY(PL_comppad))
1377                 PL_curpad = AvARRAY(PL_comppad);
1378             else
1379                 PL_curpad = NULL;
1380             break;
1381
1382         case SAVEt_PADSV_AND_MORTALIZE:
1383             {
1384                 SV **svp;
1385
1386                 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1387                 assert (a1.any_ptr);
1388                 svp = AvARRAY((PAD*)a1.any_ptr) + (PADOFFSET)a2.any_uv;
1389                 /* This mortalizing used to be done by CX_POOPLOOP() via
1390                    itersave.  But as we have all the information here, we
1391                    can do it here, save even having to have itersave in
1392                    the struct.
1393                    */
1394                 sv_2mortal(*svp);
1395                 *svp = a0.any_sv;
1396             }
1397             break;
1398
1399         case SAVEt_SAVESWITCHSTACK:
1400             {
1401                 dSP;
1402
1403                 a0 = ap[0]; a1 = ap[1];
1404                 SWITCHSTACK(a1.any_av, a0.any_av);
1405                 PL_curstackinfo->si_stack = a0.any_av;
1406             }
1407             break;
1408
1409         case SAVEt_SET_SVFLAGS:
1410             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1411             SvFLAGS(a0.any_sv) &= ~(a1.any_u32);
1412             SvFLAGS(a0.any_sv) |= a2.any_u32;
1413             break;
1414
1415             /* These are only saved in mathoms.c */
1416         case SAVEt_NSTAB:
1417             a0 = ap[0];
1418             (void)sv_clear(a0.any_sv);
1419             break;
1420
1421         case SAVEt_LONG:                        /* long reference */
1422             a0 = ap[0]; a1 = ap[1];
1423             *(long*)a1.any_ptr = a0.any_long;
1424             break;
1425
1426         case SAVEt_IV:                          /* IV reference */
1427             a0 = ap[0]; a1 = ap[1];
1428             *(IV*)a1.any_ptr = a0.any_iv;
1429             break;
1430
1431         case SAVEt_I16:                         /* I16 reference */
1432             a0 = ap[0];
1433             *(I16*)a0.any_ptr = (I16)(uv >> 8);
1434             break;
1435
1436         case SAVEt_I8:                          /* I8 reference */
1437             a0 = ap[0];
1438             *(I8*)a0.any_ptr = (I8)(uv >> 8);
1439             break;
1440
1441         case SAVEt_DESTRUCTOR:
1442             a0 = ap[0]; a1 = ap[1];
1443             (*a0.any_dptr)(a1.any_ptr);
1444             break;
1445
1446         case SAVEt_COMPILE_WARNINGS:
1447             a0 = ap[0];
1448             if (!specialWARN(PL_compiling.cop_warnings))
1449                 PerlMemShared_free(PL_compiling.cop_warnings);
1450             PL_compiling.cop_warnings = (STRLEN*)a0.any_ptr;
1451             break;
1452
1453         case SAVEt_PARSER:
1454             a0 = ap[0];
1455             parser_free((yy_parser *)a0.any_ptr);
1456             break;
1457
1458         case SAVEt_READONLY_OFF:
1459             a0 = ap[0];
1460             SvREADONLY_off(a0.any_sv);
1461             break;
1462
1463         default:
1464             Perl_croak(aTHX_ "panic: leave_scope inconsistency %u",
1465                     (U8)uv & SAVE_MASK);
1466         }
1467     }
1468
1469     TAINT_set(was);
1470 }
1471
1472 void
1473 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1474 {
1475     PERL_ARGS_ASSERT_CX_DUMP;
1476
1477 #ifdef DEBUGGING
1478     PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1479     if (CxTYPE(cx) != CXt_SUBST) {
1480         const char *gimme_text;
1481         PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1482         PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%" UVxf "\n",
1483                       PTR2UV(cx->blk_oldcop));
1484         PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1485         PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1486         PerlIO_printf(Perl_debug_log, "BLK_OLDSAVEIX = %ld\n", (long)cx->blk_oldsaveix);
1487         PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%" UVxf "\n",
1488                       PTR2UV(cx->blk_oldpm));
1489         switch (cx->blk_gimme) {
1490             case G_VOID:
1491                 gimme_text = "VOID";
1492                 break;
1493             case G_SCALAR:
1494                 gimme_text = "SCALAR";
1495                 break;
1496             case G_ARRAY:
1497                 gimme_text = "LIST";
1498                 break;
1499             default:
1500                 gimme_text = "UNKNOWN";
1501                 break;
1502         }
1503         PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", gimme_text);
1504     }
1505     switch (CxTYPE(cx)) {
1506     case CXt_NULL:
1507     case CXt_BLOCK:
1508         break;
1509     case CXt_FORMAT:
1510         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.CV = 0x%" UVxf "\n",
1511                 PTR2UV(cx->blk_format.cv));
1512         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.GV = 0x%" UVxf "\n",
1513                 PTR2UV(cx->blk_format.gv));
1514         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.DFOUTGV = 0x%" UVxf "\n",
1515                 PTR2UV(cx->blk_format.dfoutgv));
1516         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.HASARGS = %d\n",
1517                       (int)CxHASARGS(cx));
1518         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.RETOP = 0x%" UVxf "\n",
1519                 PTR2UV(cx->blk_format.retop));
1520         break;
1521     case CXt_SUB:
1522         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%" UVxf "\n",
1523                 PTR2UV(cx->blk_sub.cv));
1524         PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1525                 (long)cx->blk_sub.olddepth);
1526         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1527                 (int)CxHASARGS(cx));
1528         PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n", (int)CxLVAL(cx));
1529         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%" UVxf "\n",
1530                 PTR2UV(cx->blk_sub.retop));
1531         break;
1532     case CXt_EVAL:
1533         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1534                 (long)CxOLD_IN_EVAL(cx));
1535         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1536                 PL_op_name[CxOLD_OP_TYPE(cx)],
1537                 PL_op_desc[CxOLD_OP_TYPE(cx)]);
1538         if (cx->blk_eval.old_namesv)
1539             PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1540                           SvPVX_const(cx->blk_eval.old_namesv));
1541         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%" UVxf "\n",
1542                 PTR2UV(cx->blk_eval.old_eval_root));
1543         PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%" UVxf "\n",
1544                 PTR2UV(cx->blk_eval.retop));
1545         break;
1546
1547     case CXt_LOOP_PLAIN:
1548     case CXt_LOOP_LAZYIV:
1549     case CXt_LOOP_LAZYSV:
1550     case CXt_LOOP_LIST:
1551     case CXt_LOOP_ARY:
1552         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n", CxLABEL(cx));
1553         PerlIO_printf(Perl_debug_log, "BLK_LOOP.MY_OP = 0x%" UVxf "\n",
1554                 PTR2UV(cx->blk_loop.my_op));
1555         if (CxTYPE(cx) != CXt_LOOP_PLAIN) {
1556             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%" UVxf "\n",
1557                     PTR2UV(CxITERVAR(cx)));
1558             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERSAVE = 0x%" UVxf "\n",
1559                     PTR2UV(cx->blk_loop.itersave));
1560         }
1561         if (CxTYPE(cx) == CXt_LOOP_ARY) {
1562             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%" UVxf "\n",
1563                     PTR2UV(cx->blk_loop.state_u.ary.ary));
1564             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1565                     (long)cx->blk_loop.state_u.ary.ix);
1566         }
1567         break;
1568
1569     case CXt_SUBST:
1570         PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1571                 (long)cx->sb_iters);
1572         PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1573                 (long)cx->sb_maxiters);
1574         PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1575                 (long)cx->sb_rflags);
1576         PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1577                 (long)CxONCE(cx));
1578         PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1579                 cx->sb_orig);
1580         PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%" UVxf "\n",
1581                 PTR2UV(cx->sb_dstr));
1582         PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%" UVxf "\n",
1583                 PTR2UV(cx->sb_targ));
1584         PerlIO_printf(Perl_debug_log, "SB_S = 0x%" UVxf "\n",
1585                 PTR2UV(cx->sb_s));
1586         PerlIO_printf(Perl_debug_log, "SB_M = 0x%" UVxf "\n",
1587                 PTR2UV(cx->sb_m));
1588         PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%" UVxf "\n",
1589                 PTR2UV(cx->sb_strend));
1590         PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%" UVxf "\n",
1591                 PTR2UV(cx->sb_rxres));
1592         break;
1593     }
1594 #else
1595     PERL_UNUSED_CONTEXT;
1596     PERL_UNUSED_ARG(cx);
1597 #endif  /* DEBUGGING */
1598 }
1599
1600 /*
1601  * ex: set ts=8 sts=4 sw=4 et:
1602  */