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 =for apidoc save_gp
 317
 318 Saves the current GP of gv on the save stack to be restored on scope exit.
 319
 320 If empty is true, replace the GP with a new GP.
 321
 322 If empty is false, mark gv with GVf_INTRO so the next reference
 323 assigned is localized, which is how C< local *foo = $someref; > works.
 324
 325 =cut
 326 */
 327
 328 void
 329 Perl_save_gp(pTHX_ GV *gv, I32 empty)
 330 {
 331     PERL_ARGS_ASSERT_SAVE_GP;
 332
 333     save_pushptrptr(SvREFCNT_inc(gv), GvGP(gv), SAVEt_GP);
 334
 335     if (empty) {
 336         GP *gp = Perl_newGP(aTHX_ gv);
 337         HV * const stash = GvSTASH(gv);
 338         bool isa_changed = 0;
 339
 340         if (stash && HvENAME(stash)) {
 341             if (GvNAMELEN(gv) == 3 && strnEQ(GvNAME(gv), "ISA", 3))
 342                 isa_changed = TRUE;
 343             else if (GvCVu(gv))
 344                 /* taking a method out of circulation ("local")*/
 345                 mro_method_changed_in(stash);
 346         }
 347         if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
 348             gp->gp_io = newIO();
 349             IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
 350         }
 351         GvGP_set(gv,gp);
 352         if (isa_changed) mro_isa_changed_in(stash);
 353     }
 354     else {
 355         gp_ref(GvGP(gv));
 356         GvINTRO_on(gv);
 357     }
 358 }
 359
 360 AV *
 361 Perl_save_ary(pTHX_ GV *gv)
 362 {
 363     AV * const oav = GvAVn(gv);
 364     AV *av;
 365
 366     PERL_ARGS_ASSERT_SAVE_ARY;
 367
 368     if (UNLIKELY(!AvREAL(oav) && AvREIFY(oav)))
 369         av_reify(oav);
 370     save_pushptrptr(SvREFCNT_inc_simple_NN(gv), oav, SAVEt_AV);
 371
 372     GvAV(gv) = NULL;
 373     av = GvAVn(gv);
 374     if (UNLIKELY(SvMAGIC(oav)))
 375         mg_localize(MUTABLE_SV(oav), MUTABLE_SV(av), TRUE);
 376     return av;
 377 }
 378
 379 HV *
 380 Perl_save_hash(pTHX_ GV *gv)
 381 {
 382     HV *ohv, *hv;
 383
 384     PERL_ARGS_ASSERT_SAVE_HASH;
 385
 386     save_pushptrptr(
 387         SvREFCNT_inc_simple_NN(gv), (ohv = GvHVn(gv)), SAVEt_HV
 388     );
 389
 390     GvHV(gv) = NULL;
 391     hv = GvHVn(gv);
 392     if (UNLIKELY(SvMAGIC(ohv)))
 393         mg_localize(MUTABLE_SV(ohv), MUTABLE_SV(hv), TRUE);
 394     return hv;
 395 }
 396
 397 void
 398 Perl_save_item(pTHX_ SV *item)
 399 {
 400     SV * const sv = newSVsv(item);
 401
 402     PERL_ARGS_ASSERT_SAVE_ITEM;
 403
 404     save_pushptrptr(item, /* remember the pointer */
 405                     sv,   /* remember the value */
 406                     SAVEt_ITEM);
 407 }
 408
 409 void
 410 Perl_save_bool(pTHX_ bool *boolp)
 411 {
 412     dSS_ADD;
 413
 414     PERL_ARGS_ASSERT_SAVE_BOOL;
 415
 416     SS_ADD_PTR(boolp);
 417     SS_ADD_UV(SAVEt_BOOL | (*boolp << 8));
 418     SS_ADD_END(2);
 419 }
 420
 421 void
 422 Perl_save_pushi32ptr(pTHX_ const I32 i, void *const ptr, const int type)
 423 {
 424     dSS_ADD;
 425
 426     SS_ADD_INT(i);
 427     SS_ADD_PTR(ptr);
 428     SS_ADD_UV(type);
 429     SS_ADD_END(3);
 430 }
 431
 432 void
 433 Perl_save_int(pTHX_ int *intp)
 434 {
 435     const int i = *intp;
 436     UV type = ((UV)((UV)i << SAVE_TIGHT_SHIFT) | SAVEt_INT_SMALL);
 437     int size = 2;
 438     dSS_ADD;
 439
 440     PERL_ARGS_ASSERT_SAVE_INT;
 441
 442     if (UNLIKELY((int)(type >> SAVE_TIGHT_SHIFT) != i)) {
 443         SS_ADD_INT(i);
 444         type = SAVEt_INT;
 445         size++;
 446     }
 447     SS_ADD_PTR(intp);
 448     SS_ADD_UV(type);
 449     SS_ADD_END(size);
 450 }
 451
 452 void
 453 Perl_save_I8(pTHX_ I8 *bytep)
 454 {
 455     dSS_ADD;
 456
 457     PERL_ARGS_ASSERT_SAVE_I8;
 458
 459     SS_ADD_PTR(bytep);
 460     SS_ADD_UV(SAVEt_I8 | ((UV)*bytep << 8));
 461     SS_ADD_END(2);
 462 }
 463
 464 void
 465 Perl_save_I16(pTHX_ I16 *intp)
 466 {
 467     dSS_ADD;
 468
 469     PERL_ARGS_ASSERT_SAVE_I16;
 470
 471     SS_ADD_PTR(intp);
 472     SS_ADD_UV(SAVEt_I16 | ((UV)*intp << 8));
 473     SS_ADD_END(2);
 474 }
 475
 476 void
 477 Perl_save_I32(pTHX_ I32 *intp)
 478 {
 479     const I32 i = *intp;
 480     UV type = ((I32)((U32)i << SAVE_TIGHT_SHIFT) | SAVEt_I32_SMALL);
 481     int size = 2;
 482     dSS_ADD;
 483
 484     PERL_ARGS_ASSERT_SAVE_I32;
 485
 486     if (UNLIKELY((I32)(type >> SAVE_TIGHT_SHIFT) != i)) {
 487         SS_ADD_INT(i);
 488         type = SAVEt_I32;
 489         size++;
 490     }
 491     SS_ADD_PTR(intp);
 492     SS_ADD_UV(type);
 493     SS_ADD_END(size);
 494 }
 495
 496 void
 497 Perl_save_strlen(pTHX_ STRLEN *ptr)
 498 {
 499     dSS_ADD;
 500
 501     PERL_ARGS_ASSERT_SAVE_STRLEN;
 502
 503     SS_ADD_IV(*ptr);
 504     SS_ADD_PTR(ptr);
 505     SS_ADD_UV(SAVEt_STRLEN);
 506     SS_ADD_END(3);
 507 }
 508
 509 void
 510 Perl_save_iv(pTHX_ IV *ivp)
 511 {
 512     PERL_ARGS_ASSERT_SAVE_IV;
 513
 514     SSCHECK(3);
 515     SSPUSHIV(*ivp);
 516     SSPUSHPTR(ivp);
 517     SSPUSHUV(SAVEt_IV);
 518 }
 519
 520 /* Cannot use save_sptr() to store a char* since the SV** cast will
 521  * force word-alignment and we'll miss the pointer.
 522  */
 523 void
 524 Perl_save_pptr(pTHX_ char **pptr)
 525 {
 526     PERL_ARGS_ASSERT_SAVE_PPTR;
 527
 528     save_pushptrptr(*pptr, pptr, SAVEt_PPTR);
 529 }
 530
 531 void
 532 Perl_save_vptr(pTHX_ void *ptr)
 533 {
 534     PERL_ARGS_ASSERT_SAVE_VPTR;
 535
 536     save_pushptrptr(*(char**)ptr, ptr, SAVEt_VPTR);
 537 }
 538
 539 void
 540 Perl_save_sptr(pTHX_ SV **sptr)
 541 {
 542     PERL_ARGS_ASSERT_SAVE_SPTR;
 543
 544     save_pushptrptr(*sptr, sptr, SAVEt_SPTR);
 545 }
 546
 547 void
 548 Perl_save_padsv_and_mortalize(pTHX_ PADOFFSET off)
 549 {
 550     dSS_ADD;
 551
 552     ASSERT_CURPAD_ACTIVE("save_padsv");
 553     SS_ADD_PTR(SvREFCNT_inc_simple_NN(PL_curpad[off]));
 554     SS_ADD_PTR(PL_comppad);
 555     SS_ADD_UV((UV)off);
 556     SS_ADD_UV(SAVEt_PADSV_AND_MORTALIZE);
 557     SS_ADD_END(4);
 558 }
 559
 560 void
 561 Perl_save_hptr(pTHX_ HV **hptr)
 562 {
 563     PERL_ARGS_ASSERT_SAVE_HPTR;
 564
 565     save_pushptrptr(*hptr, hptr, SAVEt_HPTR);
 566 }
 567
 568 void
 569 Perl_save_aptr(pTHX_ AV **aptr)
 570 {
 571     PERL_ARGS_ASSERT_SAVE_APTR;
 572
 573     save_pushptrptr(*aptr, aptr, SAVEt_APTR);
 574 }
 575
 576 void
 577 Perl_save_pushptr(pTHX_ void *const ptr, const int type)
 578 {
 579     dSS_ADD;
 580     SS_ADD_PTR(ptr);
 581     SS_ADD_UV(type);
 582     SS_ADD_END(2);
 583 }
 584
 585 void
 586 Perl_save_clearsv(pTHX_ SV **svp)
 587 {
 588     const UV offset = svp - PL_curpad;
 589     const UV offset_shifted = offset << SAVE_TIGHT_SHIFT;
 590
 591     PERL_ARGS_ASSERT_SAVE_CLEARSV;
 592
 593     ASSERT_CURPAD_ACTIVE("save_clearsv");
 594     SvPADSTALE_off(*svp); /* mark lexical as active */
 595     if (UNLIKELY((offset_shifted >> SAVE_TIGHT_SHIFT) != offset)) {
 596         Perl_croak(aTHX_ "panic: pad offset %" UVuf " out of range (%p-%p)",
 597                    offset, svp, PL_curpad);
 598     }
 599
 600     {
 601         dSS_ADD;
 602         SS_ADD_UV(offset_shifted | SAVEt_CLEARSV);
 603         SS_ADD_END(1);
 604     }
 605 }
 606
 607 void
 608 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
 609 {
 610     PERL_ARGS_ASSERT_SAVE_DELETE;
 611
 612     save_pushptri32ptr(key, klen, SvREFCNT_inc_simple(hv), SAVEt_DELETE);
 613 }
 614
 615 void
 616 Perl_save_hdelete(pTHX_ HV *hv, SV *keysv)
 617 {
 618     STRLEN len;
 619     I32 klen;
 620     const char *key;
 621
 622     PERL_ARGS_ASSERT_SAVE_HDELETE;
 623
 624     key  = SvPV_const(keysv, len);
 625     klen = SvUTF8(keysv) ? -(I32)len : (I32)len;
 626     SvREFCNT_inc_simple_void_NN(hv);
 627     save_pushptri32ptr(savepvn(key, len), klen, hv, SAVEt_DELETE);
 628 }
 629
 630 void
 631 Perl_save_adelete(pTHX_ AV *av, SSize_t key)
 632 {
 633     dSS_ADD;
 634
 635     PERL_ARGS_ASSERT_SAVE_ADELETE;
 636
 637     SvREFCNT_inc_void(av);
 638     SS_ADD_UV(key);
 639     SS_ADD_PTR(av);
 640     SS_ADD_IV(SAVEt_ADELETE);
 641     SS_ADD_END(3);
 642 }
 643
 644 void
 645 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
 646 {
 647     dSS_ADD;
 648     PERL_ARGS_ASSERT_SAVE_DESTRUCTOR;
 649
 650     SS_ADD_DPTR(f);
 651     SS_ADD_PTR(p);
 652     SS_ADD_UV(SAVEt_DESTRUCTOR);
 653     SS_ADD_END(3);
 654 }
 655
 656 void
 657 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
 658 {
 659     dSS_ADD;
 660
 661     SS_ADD_DXPTR(f);
 662     SS_ADD_PTR(p);
 663     SS_ADD_UV(SAVEt_DESTRUCTOR_X);
 664     SS_ADD_END(3);
 665 }
 666
 667 void
 668 Perl_save_hints(pTHX)
 669 {
 670     COPHH *save_cophh = cophh_copy(CopHINTHASH_get(&PL_compiling));
 671     if (PL_hints & HINT_LOCALIZE_HH) {
 672         HV *oldhh = GvHV(PL_hintgv);
 673         save_pushptri32ptr(oldhh, PL_hints, save_cophh, SAVEt_HINTS);
 674         GvHV(PL_hintgv) = NULL; /* in case copying dies */
 675         GvHV(PL_hintgv) = hv_copy_hints_hv(oldhh);
 676     } else {
 677         save_pushi32ptr(PL_hints, save_cophh, SAVEt_HINTS);
 678     }
 679 }
 680
 681 static void
 682 S_save_pushptri32ptr(pTHX_ void *const ptr1, const I32 i, void *const ptr2,
 683                         const int type)
 684 {
 685     dSS_ADD;
 686     SS_ADD_PTR(ptr1);
 687     SS_ADD_INT(i);
 688     SS_ADD_PTR(ptr2);
 689     SS_ADD_UV(type);
 690     SS_ADD_END(4);
 691 }
 692
 693 void
 694 Perl_save_aelem_flags(pTHX_ AV *av, SSize_t idx, SV **sptr,
 695                             const U32 flags)
 696 {
 697     dSS_ADD;
 698     SV *sv;
 699
 700     PERL_ARGS_ASSERT_SAVE_AELEM_FLAGS;
 701
 702     SvGETMAGIC(*sptr);
 703     SS_ADD_PTR(SvREFCNT_inc_simple(av));
 704     SS_ADD_IV(idx);
 705     SS_ADD_PTR(SvREFCNT_inc(*sptr));
 706     SS_ADD_UV(SAVEt_AELEM);
 707     SS_ADD_END(4);
 708     /* The array needs to hold a reference count on its new element, so it
 709        must be AvREAL. */
 710     if (UNLIKELY(!AvREAL(av) && AvREIFY(av)))
 711         av_reify(av);
 712     save_scalar_at(sptr, flags); /* XXX - FIXME - see #60360 */
 713     if (flags & SAVEf_KEEPOLDELEM)
 714         return;
 715     sv = *sptr;
 716     /* If we're localizing a tied array element, this new sv
 717      * won't actually be stored in the array - so it won't get
 718      * reaped when the localize ends. Ensure it gets reaped by
 719      * mortifying it instead. DAPM */
 720     if (UNLIKELY(SvTIED_mg((const SV *)av, PERL_MAGIC_tied)))
 721         sv_2mortal(sv);
 722 }
 723
 724 void
 725 Perl_save_helem_flags(pTHX_ HV *hv, SV *key, SV **sptr, const U32 flags)
 726 {
 727     SV *sv;
 728
 729     PERL_ARGS_ASSERT_SAVE_HELEM_FLAGS;
 730
 731     SvGETMAGIC(*sptr);
 732     {
 733         dSS_ADD;
 734         SS_ADD_PTR(SvREFCNT_inc_simple(hv));
 735         SS_ADD_PTR(newSVsv(key));
 736         SS_ADD_PTR(SvREFCNT_inc(*sptr));
 737         SS_ADD_UV(SAVEt_HELEM);
 738         SS_ADD_END(4);
 739     }
 740     save_scalar_at(sptr, flags);
 741     if (flags & SAVEf_KEEPOLDELEM)
 742         return;
 743     sv = *sptr;
 744     /* If we're localizing a tied hash element, this new sv
 745      * won't actually be stored in the hash - so it won't get
 746      * reaped when the localize ends. Ensure it gets reaped by
 747      * mortifying it instead. DAPM */
 748     if (UNLIKELY(SvTIED_mg((const SV *)hv, PERL_MAGIC_tied)))
 749         sv_2mortal(sv);
 750 }
 751
 752 SV*
 753 Perl_save_svref(pTHX_ SV **sptr)
 754 {
 755     PERL_ARGS_ASSERT_SAVE_SVREF;
 756
 757     SvGETMAGIC(*sptr);
 758     save_pushptrptr(sptr, SvREFCNT_inc(*sptr), SAVEt_SVREF);
 759     return save_scalar_at(sptr, SAVEf_SETMAGIC); /* XXX - FIXME - see #60360 */
 760 }
 761
 762
 763 void
 764 Perl_savetmps(pTHX)
 765 {
 766     dSS_ADD;
 767     SS_ADD_IV(PL_tmps_floor);
 768     PL_tmps_floor = PL_tmps_ix;
 769     SS_ADD_UV(SAVEt_TMPSFLOOR);
 770     SS_ADD_END(2);
 771 }
 772
 773
 774 I32
 775 Perl_save_alloc(pTHX_ I32 size, I32 pad)
 776 {
 777     const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
 778                           - (char*)PL_savestack);
 779     const UV elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
 780     const UV elems_shifted = elems << SAVE_TIGHT_SHIFT;
 781
 782     if (UNLIKELY((elems_shifted >> SAVE_TIGHT_SHIFT) != elems))
 783         Perl_croak(aTHX_
 784             "panic: save_alloc elems %" UVuf " out of range (%" IVdf "-%" IVdf ")",
 785                    elems, (IV)size, (IV)pad);
 786
 787     SSGROW(elems + 1);
 788
 789     PL_savestack_ix += elems;
 790     SSPUSHUV(SAVEt_ALLOC | elems_shifted);
 791     return start;
 792 }
 793
 794
 795 static const U8 arg_counts[] = {
 796     0, /* SAVEt_ALLOC              */
 797     0, /* SAVEt_CLEARPADRANGE      */
 798     0, /* SAVEt_CLEARSV            */
 799     0, /* SAVEt_REGCONTEXT         */
 800     1, /* SAVEt_TMPSFLOOR          */
 801     1, /* SAVEt_BOOL               */
 802     1, /* SAVEt_COMPILE_WARNINGS   */
 803     1, /* SAVEt_COMPPAD            */
 804     1, /* SAVEt_FREECOPHH          */
 805     1, /* SAVEt_FREEOP             */
 806     1, /* SAVEt_FREEPV             */
 807     1, /* SAVEt_FREESV             */
 808     1, /* SAVEt_I16                */
 809     1, /* SAVEt_I32_SMALL          */
 810     1, /* SAVEt_I8                 */
 811     1, /* SAVEt_INT_SMALL          */
 812     1, /* SAVEt_MORTALIZESV        */
 813     1, /* SAVEt_NSTAB              */
 814     1, /* SAVEt_OP                 */
 815     1, /* SAVEt_PARSER             */
 816     1, /* SAVEt_STACK_POS          */
 817     1, /* SAVEt_READONLY_OFF       */
 818     1, /* SAVEt_FREEPADNAME        */
 819     2, /* SAVEt_AV                 */
 820     2, /* SAVEt_DESTRUCTOR         */
 821     2, /* SAVEt_DESTRUCTOR_X       */
 822     2, /* SAVEt_GENERIC_PVREF      */
 823     2, /* SAVEt_GENERIC_SVREF      */
 824     2, /* SAVEt_GP                 */
 825     2, /* SAVEt_GVSV               */
 826     2, /* SAVEt_HINTS              */
 827     2, /* SAVEt_HPTR               */
 828     2, /* SAVEt_HV                 */
 829     2, /* SAVEt_I32                */
 830     2, /* SAVEt_INT                */
 831     2, /* SAVEt_ITEM               */
 832     2, /* SAVEt_IV                 */
 833     2, /* SAVEt_LONG               */
 834     2, /* SAVEt_PPTR               */
 835     2, /* SAVEt_SAVESWITCHSTACK    */
 836     2, /* SAVEt_SHARED_PVREF       */
 837     2, /* SAVEt_SPTR               */
 838     2, /* SAVEt_STRLEN             */
 839     2, /* SAVEt_SV                 */
 840     2, /* SAVEt_SVREF              */
 841     2, /* SAVEt_VPTR               */
 842     2, /* SAVEt_ADELETE            */
 843     2, /* SAVEt_APTR               */
 844     3, /* SAVEt_HELEM              */
 845     3, /* SAVEt_PADSV_AND_MORTALIZE*/
 846     3, /* SAVEt_SET_SVFLAGS        */
 847     3, /* SAVEt_GVSLOT             */
 848     3, /* SAVEt_AELEM              */
 849     3  /* SAVEt_DELETE             */
 850 };
 851
 852
 853 void
 854 Perl_leave_scope(pTHX_ I32 base)
 855 {
 856     /* Localise the effects of the TAINT_NOT inside the loop.  */
 857     bool was = TAINT_get;
 858
 859     if (UNLIKELY(base < -1))
 860         Perl_croak(aTHX_ "panic: corrupt saved stack index %ld", (long) base);
 861     DEBUG_l(Perl_deb(aTHX_ "savestack: releasing items %ld -> %ld\n",
 862                         (long)PL_savestack_ix, (long)base));
 863     while (PL_savestack_ix > base) {
 864         UV uv;
 865         U8 type;
 866         ANY *ap; /* arg pointer */
 867         ANY a0, a1, a2; /* up to 3 args */
 868
 869         TAINT_NOT;
 870
 871         {
 872             U8  argcount;
 873             I32 ix = PL_savestack_ix - 1;
 874
 875             ap = &PL_savestack[ix];
 876             uv = ap->any_uv;
 877             type = (U8)uv & SAVE_MASK;
 878             argcount = arg_counts[type];
 879             PL_savestack_ix = ix - argcount;
 880             ap -= argcount;
 881         }
 882
 883         switch (type) {
 884         case SAVEt_ITEM:                        /* normal string */
 885             a0 = ap[0]; a1 = ap[1];
 886             sv_replace(a0.any_sv, a1.any_sv);
 887             if (UNLIKELY(SvSMAGICAL(a0.any_sv))) {
 888                 PL_localizing = 2;
 889                 mg_set(a0.any_sv);
 890                 PL_localizing = 0;
 891             }
 892             break;
 893
 894             /* This would be a mathom, but Perl_save_svref() calls a static
 895                function, S_save_scalar_at(), so has to stay in this file.  */
 896         case SAVEt_SVREF:                       /* scalar reference */
 897             a0 = ap[0]; a1 = ap[1];
 898             a2.any_svp = a0.any_svp;
 899             a0.any_sv = NULL; /* what to refcnt_dec */
 900             goto restore_sv;
 901
 902         case SAVEt_SV:                          /* scalar reference */
 903             a0 = ap[0]; a1 = ap[1];
 904             a2.any_svp = &GvSV(a0.any_gv);
 905         restore_sv:
 906         {
 907             /* do *a2.any_svp = a1 and free a0 */
 908             SV * const sv = *a2.any_svp;
 909             *a2.any_svp = a1.any_sv;
 910             SvREFCNT_dec(sv);
 911             if (UNLIKELY(SvSMAGICAL(a1.any_sv))) {
 912                 /* mg_set could die, skipping the freeing of a0 and
 913                  * a1; Ensure that they're always freed in that case */
 914                 dSS_ADD;
 915                 SS_ADD_PTR(a1.any_sv);
 916                 SS_ADD_UV(SAVEt_FREESV);
 917                 SS_ADD_PTR(a0.any_sv);
 918                 SS_ADD_UV(SAVEt_FREESV);
 919                 SS_ADD_END(4);
 920                 PL_localizing = 2;
 921                 mg_set(a1.any_sv);
 922                 PL_localizing = 0;
 923                 break;
 924             }
 925             SvREFCNT_dec_NN(a1.any_sv);
 926             SvREFCNT_dec(a0.any_sv);
 927             break;
 928         }
 929
 930         case SAVEt_GENERIC_PVREF:               /* generic pv */
 931             a0 = ap[0]; a1 = ap[1];
 932             if (*a1.any_pvp != a0.any_pv) {
 933                 Safefree(*a1.any_pvp);
 934                 *a1.any_pvp = a0.any_pv;
 935             }
 936             break;
 937
 938         case SAVEt_SHARED_PVREF:                /* shared pv */
 939             a0 = ap[0]; a1 = ap[1];
 940             if (*a0.any_pvp != a1.any_pv) {
 941 #ifdef NETWARE
 942                 PerlMem_free(*a0.any_pvp);
 943 #else
 944                 PerlMemShared_free(*a0.any_pvp);
 945 #endif
 946                 *a0.any_pvp = a1.any_pv;
 947             }
 948             break;
 949
 950         case SAVEt_GVSV:                        /* scalar slot in GV */
 951             a0 = ap[0]; a1 = ap[1];
 952             a0.any_svp = &GvSV(a0.any_gv);
 953             goto restore_svp;
 954
 955         case SAVEt_GENERIC_SVREF:               /* generic sv */
 956             a0 = ap[0]; a1 = ap[1];
 957         restore_svp:
 958         {
 959             /* do *a0.any_svp = a1 */
 960             SV * const sv = *a0.any_svp;
 961             *a0.any_svp = a1.any_sv;
 962             SvREFCNT_dec(sv);
 963             SvREFCNT_dec(a1.any_sv);
 964             break;
 965         }
 966
 967         case SAVEt_GVSLOT:                      /* any slot in GV */
 968         {
 969             HV * hv;
 970             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
 971             hv = GvSTASH(a0.any_gv);
 972             if (hv && HvENAME(hv) && (
 973                     (a2.any_sv && SvTYPE(a2.any_sv) == SVt_PVCV)
 974                  || (*a1.any_svp && SvTYPE(*a1.any_svp) == SVt_PVCV)
 975                ))
 976             {
 977                 if ((char *)a1.any_svp < (char *)GvGP(a0.any_gv)
 978                  || (char *)a1.any_svp > (char *)GvGP(a0.any_gv) + sizeof(struct gp)
 979                  || GvREFCNT(a0.any_gv) > 2) /* "> 2" to ignore savestack's ref */
 980                     PL_sub_generation++;
 981                 else mro_method_changed_in(hv);
 982             }
 983             a0.any_svp = a1.any_svp;
 984             a1.any_sv  = a2.any_sv;
 985             goto restore_svp;
 986         }
 987
 988         case SAVEt_AV:                          /* array reference */
 989             a0 = ap[0]; a1 = ap[1];
 990             SvREFCNT_dec(GvAV(a0.any_gv));
 991             GvAV(a0.any_gv) = a1.any_av;
 992           avhv_common:
 993             if (UNLIKELY(SvSMAGICAL(a1.any_sv))) {
 994                 /* mg_set might die, so make sure a0 isn't leaked */
 995                 dSS_ADD;
 996                 SS_ADD_PTR(a0.any_sv);
 997                 SS_ADD_UV(SAVEt_FREESV);
 998                 SS_ADD_END(2);
 999                 PL_localizing = 2;
1000                 mg_set(a1.any_sv);
1001                 PL_localizing = 0;
1002                 break;
1003             }
1004             SvREFCNT_dec_NN(a0.any_sv);
1005             break;
1006
1007         case SAVEt_HV:                          /* hash reference */
1008             a0 = ap[0]; a1 = ap[1];
1009             SvREFCNT_dec(GvHV(a0.any_gv));
1010             GvHV(a0.any_gv) = a1.any_hv;
1011             goto avhv_common;
1012
1013         case SAVEt_INT_SMALL:
1014             a0 = ap[0];
1015             *(int*)a0.any_ptr = (int)(uv >> SAVE_TIGHT_SHIFT);
1016             break;
1017
1018         case SAVEt_INT:                         /* int reference */
1019             a0 = ap[0]; a1 = ap[1];
1020             *(int*)a1.any_ptr = (int)a0.any_i32;
1021             break;
1022
1023         case SAVEt_STRLEN:                      /* STRLEN/size_t ref */
1024             a0 = ap[0]; a1 = ap[1];
1025             *(STRLEN*)a1.any_ptr = (STRLEN)a0.any_iv;
1026             break;
1027
1028         case SAVEt_TMPSFLOOR:                   /* restore PL_tmps_floor */
1029             a0 = ap[0];
1030             PL_tmps_floor = (SSize_t)a0.any_iv;
1031             break;
1032
1033         case SAVEt_BOOL:                        /* bool reference */
1034             a0 = ap[0];
1035             *(bool*)a0.any_ptr = cBOOL(uv >> 8);
1036 #ifdef NO_TAINT_SUPPORT
1037             PERL_UNUSED_VAR(was);
1038 #else
1039             if (UNLIKELY(a0.any_ptr == &(TAINT_get))) {
1040                 /* If we don't update <was>, to reflect what was saved on the
1041                  * stack for PL_tainted, then we will overwrite this attempt to
1042                  * restore it when we exit this routine.  Note that this won't
1043                  * work if this value was saved in a wider-than necessary type,
1044                  * such as I32 */
1045                 was = *(bool*)a0.any_ptr;
1046             }
1047 #endif
1048             break;
1049
1050         case SAVEt_I32_SMALL:
1051             a0 = ap[0];
1052             *(I32*)a0.any_ptr = (I32)(uv >> SAVE_TIGHT_SHIFT);
1053             break;
1054
1055         case SAVEt_I32:                         /* I32 reference */
1056             a0 = ap[0]; a1 = ap[1];
1057 #ifdef PERL_DEBUG_READONLY_OPS
1058             if (*(I32*)a1.any_ptr != a0.any_i32)
1059 #endif
1060                 *(I32*)a1.any_ptr = a0.any_i32;
1061             break;
1062
1063         case SAVEt_SPTR:                        /* SV* reference */
1064         case SAVEt_VPTR:                        /* random* reference */
1065         case SAVEt_PPTR:                        /* char* reference */
1066         case SAVEt_HPTR:                        /* HV* reference */
1067         case SAVEt_APTR:                        /* AV* reference */
1068             a0 = ap[0]; a1 = ap[1];
1069             *a1.any_svp= a0.any_sv;
1070             break;
1071
1072         case SAVEt_GP:                          /* scalar reference */
1073         {
1074             HV *hv;
1075             bool had_method;
1076
1077             a0 = ap[0]; a1 = ap[1];
1078             /* possibly taking a method out of circulation */
1079             had_method = !!GvCVu(a0.any_gv);
1080             gp_free(a0.any_gv);
1081             GvGP_set(a0.any_gv, (GP*)a1.any_ptr);
1082             if ((hv=GvSTASH(a0.any_gv)) && HvENAME_get(hv)) {
1083                 if (   GvNAMELEN(a0.any_gv) == 3
1084                     && strnEQ(GvNAME(a0.any_gv), "ISA", 3)
1085                 )
1086                     mro_isa_changed_in(hv);
1087                 else if (had_method || GvCVu(a0.any_gv))
1088                     /* putting a method back into circulation ("local")*/
1089                     gv_method_changed(a0.any_gv);
1090             }
1091             SvREFCNT_dec_NN(a0.any_gv);
1092             break;
1093         }
1094
1095         case SAVEt_FREESV:
1096             a0 = ap[0];
1097             SvREFCNT_dec(a0.any_sv);
1098             break;
1099
1100         case SAVEt_FREEPADNAME:
1101             a0 = ap[0];
1102             PadnameREFCNT_dec((PADNAME *)a0.any_ptr);
1103             break;
1104
1105         case SAVEt_FREECOPHH:
1106             a0 = ap[0];
1107             cophh_free((COPHH *)a0.any_ptr);
1108             break;
1109
1110         case SAVEt_MORTALIZESV:
1111             a0 = ap[0];
1112             sv_2mortal(a0.any_sv);
1113             break;
1114
1115         case SAVEt_FREEOP:
1116             a0 = ap[0];
1117             ASSERT_CURPAD_LEGAL("SAVEt_FREEOP");
1118             op_free(a0.any_op);
1119             break;
1120
1121         case SAVEt_FREEPV:
1122             a0 = ap[0];
1123             Safefree(a0.any_ptr);
1124             break;
1125
1126         case SAVEt_CLEARPADRANGE:
1127         {
1128             I32 i;
1129             SV **svp;
1130             i = (I32)((uv >> SAVE_TIGHT_SHIFT) & OPpPADRANGE_COUNTMASK);
1131             svp = &PL_curpad[uv >>
1132                     (OPpPADRANGE_COUNTSHIFT + SAVE_TIGHT_SHIFT)] + i - 1;
1133             goto clearsv;
1134         case SAVEt_CLEARSV:
1135             svp = &PL_curpad[uv >> SAVE_TIGHT_SHIFT];
1136             i = 1;
1137           clearsv:
1138             for (; i; i--, svp--) {
1139                 SV *sv = *svp;
1140
1141                 DEBUG_Xv(PerlIO_printf(Perl_debug_log,
1142              "Pad 0x%" UVxf "[0x%" UVxf "] clearsv: %ld sv=0x%" UVxf "<%" IVdf "> %s\n",
1143                     PTR2UV(PL_comppad), PTR2UV(PL_curpad),
1144                     (long)(svp-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
1145                     (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
1146                 ));
1147
1148                 /* Can clear pad variable in place? */
1149                 if (SvREFCNT(sv) == 1 && !SvOBJECT(sv)) {
1150
1151                     /* these flags are the union of all the relevant flags
1152                      * in the individual conditions within */
1153                     if (UNLIKELY(SvFLAGS(sv) & (
1154                             SVf_READONLY|SVf_PROTECT /*for SvREADONLY_off*/
1155                           | (SVs_GMG|SVs_SMG|SVs_RMG) /* SvMAGICAL() */
1156                           | SVf_OOK
1157                           | SVf_THINKFIRST)))
1158                     {
1159                         /* if a my variable that was made readonly is
1160                          * going out of scope, we want to remove the
1161                          * readonlyness so that it can go out of scope
1162                          * quietly
1163                          */
1164                         if (SvREADONLY(sv))
1165                             SvREADONLY_off(sv);
1166
1167                         if (SvOOK(sv)) { /* OOK or HvAUX */
1168                             if (SvTYPE(sv) == SVt_PVHV)
1169                                 Perl_hv_kill_backrefs(aTHX_ MUTABLE_HV(sv));
1170                             else
1171                                 sv_backoff(sv);
1172                         }
1173
1174                         if (SvMAGICAL(sv)) {
1175                             /* note that backrefs (either in HvAUX or magic)
1176                              * must be removed before other magic */
1177                             sv_unmagic(sv, PERL_MAGIC_backref);
1178                             if (SvTYPE(sv) != SVt_PVCV)
1179                                 mg_free(sv);
1180                         }
1181                         if (SvTHINKFIRST(sv))
1182                             sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF
1183                                                      |SV_COW_DROP_PV);
1184
1185                     }
1186                     switch (SvTYPE(sv)) {
1187                     case SVt_NULL:
1188                         break;
1189                     case SVt_PVAV:
1190                         av_clear(MUTABLE_AV(sv));
1191                         break;
1192                     case SVt_PVHV:
1193                         hv_clear(MUTABLE_HV(sv));
1194                         break;
1195                     case SVt_PVCV:
1196                     {
1197                         HEK *hek =
1198                               CvNAMED(sv)
1199                                 ? CvNAME_HEK((CV *)sv)
1200                                 : GvNAME_HEK(CvGV(sv));
1201                         assert(hek);
1202                         (void)share_hek_hek(hek);
1203                         cv_undef((CV *)sv);
1204                         CvNAME_HEK_set(sv, hek);
1205                         CvLEXICAL_on(sv);
1206                         break;
1207                     }
1208                     default:
1209                         /* This looks odd, but these two macros are for use in
1210                            expressions and finish with a trailing comma, so
1211                            adding a ; after them would be wrong. */
1212                         assert_not_ROK(sv)
1213                         assert_not_glob(sv)
1214                         SvFLAGS(sv) &=~ (SVf_OK|SVf_IVisUV|SVf_UTF8);
1215                         break;
1216                     }
1217                     SvPADTMP_off(sv);
1218                     SvPADSTALE_on(sv); /* mark as no longer live */
1219                 }
1220                 else {  /* Someone has a claim on this, so abandon it. */
1221                     switch (SvTYPE(sv)) {       /* Console ourselves with a new value */
1222                     case SVt_PVAV:      *svp = MUTABLE_SV(newAV());     break;
1223                     case SVt_PVHV:      *svp = MUTABLE_SV(newHV());     break;
1224                     case SVt_PVCV:
1225                     {
1226                         HEK * const hek = CvNAMED(sv)
1227                                              ? CvNAME_HEK((CV *)sv)
1228                                              : GvNAME_HEK(CvGV(sv));
1229
1230                         /* Create a stub */
1231                         *svp = newSV_type(SVt_PVCV);
1232
1233                         /* Share name */
1234                         CvNAME_HEK_set(*svp,
1235                                        share_hek_hek(hek));
1236                         CvLEXICAL_on(*svp);
1237                         break;
1238                     }
1239                     default:    *svp = newSV(0);                break;
1240                     }
1241                     SvREFCNT_dec_NN(sv); /* Cast current value to the winds. */
1242                     /* preserve pad nature, but also mark as not live
1243                      * for any closure capturing */
1244                     SvFLAGS(*svp) |= SVs_PADSTALE;
1245                 }
1246             }
1247             break;
1248         }
1249
1250         case SAVEt_DELETE:
1251             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1252             (void)hv_delete(a2.any_hv, a0.any_pv, a1.any_i32, G_DISCARD);
1253             SvREFCNT_dec(a2.any_hv);
1254             Safefree(a0.any_ptr);
1255             break;
1256
1257         case SAVEt_ADELETE:
1258             a0 = ap[0]; a1 = ap[1];
1259             (void)av_delete(a1.any_av, a0.any_iv, G_DISCARD);
1260             SvREFCNT_dec(a1.any_av);
1261             break;
1262
1263         case SAVEt_DESTRUCTOR_X:
1264             a0 = ap[0]; a1 = ap[1];
1265             (*a0.any_dxptr)(aTHX_ a1.any_ptr);
1266             break;
1267
1268         case SAVEt_REGCONTEXT:
1269             /* regexp must have croaked */
1270         case SAVEt_ALLOC:
1271             PL_savestack_ix -= uv >> SAVE_TIGHT_SHIFT;
1272             break;
1273
1274         case SAVEt_STACK_POS:           /* Position on Perl stack */
1275             a0 = ap[0];
1276             PL_stack_sp = PL_stack_base + a0.any_i32;
1277             break;
1278
1279         case SAVEt_AELEM:               /* array element */
1280         {
1281             SV **svp;
1282             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1283             svp = av_fetch(a0.any_av, a1.any_iv, 1);
1284             if (UNLIKELY(!AvREAL(a0.any_av) && AvREIFY(a0.any_av))) /* undo reify guard */
1285                 SvREFCNT_dec(a2.any_sv);
1286             if (LIKELY(svp)) {
1287                 SV * const sv = *svp;
1288                 if (LIKELY(sv && sv != &PL_sv_undef)) {
1289                     if (UNLIKELY(SvTIED_mg((const SV *)a0.any_av, PERL_MAGIC_tied)))
1290                         SvREFCNT_inc_void_NN(sv);
1291                     a1.any_sv  = a2.any_sv;
1292                     a2.any_svp = svp;
1293                     goto restore_sv;
1294                 }
1295             }
1296             SvREFCNT_dec(a0.any_av);
1297             SvREFCNT_dec(a2.any_sv);
1298             break;
1299         }
1300
1301         case SAVEt_HELEM:               /* hash element */
1302         {
1303             HE *he;
1304
1305             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1306             he = hv_fetch_ent(a0.any_hv, a1.any_sv, 1, 0);
1307             SvREFCNT_dec(a1.any_sv);
1308             if (LIKELY(he)) {
1309                 const SV * const oval = HeVAL(he);
1310                 if (LIKELY(oval && oval != &PL_sv_undef)) {
1311                     SV **svp = &HeVAL(he);
1312                     if (UNLIKELY(SvTIED_mg((const SV *)a0.any_hv, PERL_MAGIC_tied)))
1313                         SvREFCNT_inc_void(*svp);
1314                     a1.any_sv  = a2.any_sv;
1315                     a2.any_svp = svp;
1316                     goto restore_sv;
1317                 }
1318             }
1319             SvREFCNT_dec(a0.any_hv);
1320             SvREFCNT_dec(a2.any_sv);
1321             break;
1322         }
1323
1324         case SAVEt_OP:
1325             a0 = ap[0];
1326             PL_op = (OP*)a0.any_ptr;
1327             break;
1328
1329         case SAVEt_HINTS:
1330             a0 = ap[0]; a1 = ap[1];
1331             if ((PL_hints & HINT_LOCALIZE_HH)) {
1332               while (GvHV(PL_hintgv)) {
1333                 HV *hv = GvHV(PL_hintgv);
1334                 GvHV(PL_hintgv) = NULL;
1335                 SvREFCNT_dec(MUTABLE_SV(hv));
1336               }
1337             }
1338             cophh_free(CopHINTHASH_get(&PL_compiling));
1339             CopHINTHASH_set(&PL_compiling, (COPHH*)a1.any_ptr);
1340             *(I32*)&PL_hints = a0.any_i32;
1341             if (PL_hints & HINT_LOCALIZE_HH) {
1342                 SvREFCNT_dec(MUTABLE_SV(GvHV(PL_hintgv)));
1343                 GvHV(PL_hintgv) = MUTABLE_HV(SSPOPPTR);
1344             }
1345             if (!GvHV(PL_hintgv)) {
1346                 /* Need to add a new one manually, else rv2hv can
1347                    add one via GvHVn and it won't have the magic set.  */
1348                 HV *const hv = newHV();
1349                 hv_magic(hv, NULL, PERL_MAGIC_hints);
1350                 GvHV(PL_hintgv) = hv;
1351             }
1352             assert(GvHV(PL_hintgv));
1353             break;
1354
1355         case SAVEt_COMPPAD:
1356             a0 = ap[0];
1357             PL_comppad = (PAD*)a0.any_ptr;
1358             if (LIKELY(PL_comppad))
1359                 PL_curpad = AvARRAY(PL_comppad);
1360             else
1361                 PL_curpad = NULL;
1362             break;
1363
1364         case SAVEt_PADSV_AND_MORTALIZE:
1365             {
1366                 SV **svp;
1367
1368                 a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1369                 assert (a1.any_ptr);
1370                 svp = AvARRAY((PAD*)a1.any_ptr) + (PADOFFSET)a2.any_uv;
1371                 /* This mortalizing used to be done by CX_POOPLOOP() via
1372                    itersave.  But as we have all the information here, we
1373                    can do it here, save even having to have itersave in
1374                    the struct.
1375                    */
1376                 sv_2mortal(*svp);
1377                 *svp = a0.any_sv;
1378             }
1379             break;
1380
1381         case SAVEt_SAVESWITCHSTACK:
1382             {
1383                 dSP;
1384
1385                 a0 = ap[0]; a1 = ap[1];
1386                 SWITCHSTACK(a1.any_av, a0.any_av);
1387                 PL_curstackinfo->si_stack = a0.any_av;
1388             }
1389             break;
1390
1391         case SAVEt_SET_SVFLAGS:
1392             a0 = ap[0]; a1 = ap[1]; a2 = ap[2];
1393             SvFLAGS(a0.any_sv) &= ~(a1.any_u32);
1394             SvFLAGS(a0.any_sv) |= a2.any_u32;
1395             break;
1396
1397             /* These are only saved in mathoms.c */
1398         case SAVEt_NSTAB:
1399             a0 = ap[0];
1400             (void)sv_clear(a0.any_sv);
1401             break;
1402
1403         case SAVEt_LONG:                        /* long reference */
1404             a0 = ap[0]; a1 = ap[1];
1405             *(long*)a1.any_ptr = a0.any_long;
1406             break;
1407
1408         case SAVEt_IV:                          /* IV reference */
1409             a0 = ap[0]; a1 = ap[1];
1410             *(IV*)a1.any_ptr = a0.any_iv;
1411             break;
1412
1413         case SAVEt_I16:                         /* I16 reference */
1414             a0 = ap[0];
1415             *(I16*)a0.any_ptr = (I16)(uv >> 8);
1416             break;
1417
1418         case SAVEt_I8:                          /* I8 reference */
1419             a0 = ap[0];
1420             *(I8*)a0.any_ptr = (I8)(uv >> 8);
1421             break;
1422
1423         case SAVEt_DESTRUCTOR:
1424             a0 = ap[0]; a1 = ap[1];
1425             (*a0.any_dptr)(a1.any_ptr);
1426             break;
1427
1428         case SAVEt_COMPILE_WARNINGS:
1429             a0 = ap[0];
1430             if (!specialWARN(PL_compiling.cop_warnings))
1431                 PerlMemShared_free(PL_compiling.cop_warnings);
1432             PL_compiling.cop_warnings = (STRLEN*)a0.any_ptr;
1433             break;
1434
1435         case SAVEt_PARSER:
1436             a0 = ap[0];
1437             parser_free((yy_parser *)a0.any_ptr);
1438             break;
1439
1440         case SAVEt_READONLY_OFF:
1441             a0 = ap[0];
1442             SvREADONLY_off(a0.any_sv);
1443             break;
1444
1445         default:
1446             Perl_croak(aTHX_ "panic: leave_scope inconsistency %u",
1447                     (U8)uv & SAVE_MASK);
1448         }
1449     }
1450
1451     TAINT_set(was);
1452 }
1453
1454 void
1455 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1456 {
1457     PERL_ARGS_ASSERT_CX_DUMP;
1458
1459 #ifdef DEBUGGING
1460     PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1461     if (CxTYPE(cx) != CXt_SUBST) {
1462         const char *gimme_text;
1463         PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1464         PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%" UVxf "\n",
1465                       PTR2UV(cx->blk_oldcop));
1466         PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1467         PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1468         PerlIO_printf(Perl_debug_log, "BLK_OLDSAVEIX = %ld\n", (long)cx->blk_oldsaveix);
1469         PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%" UVxf "\n",
1470                       PTR2UV(cx->blk_oldpm));
1471         switch (cx->blk_gimme) {
1472             case G_VOID:
1473                 gimme_text = "VOID";
1474                 break;
1475             case G_SCALAR:
1476                 gimme_text = "SCALAR";
1477                 break;
1478             case G_ARRAY:
1479                 gimme_text = "LIST";
1480                 break;
1481             default:
1482                 gimme_text = "UNKNOWN";
1483                 break;
1484         }
1485         PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", gimme_text);
1486     }
1487     switch (CxTYPE(cx)) {
1488     case CXt_NULL:
1489     case CXt_BLOCK:
1490         break;
1491     case CXt_FORMAT:
1492         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.CV = 0x%" UVxf "\n",
1493                 PTR2UV(cx->blk_format.cv));
1494         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.GV = 0x%" UVxf "\n",
1495                 PTR2UV(cx->blk_format.gv));
1496         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.DFOUTGV = 0x%" UVxf "\n",
1497                 PTR2UV(cx->blk_format.dfoutgv));
1498         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.HASARGS = %d\n",
1499                       (int)CxHASARGS(cx));
1500         PerlIO_printf(Perl_debug_log, "BLK_FORMAT.RETOP = 0x%" UVxf "\n",
1501                 PTR2UV(cx->blk_format.retop));
1502         break;
1503     case CXt_SUB:
1504         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%" UVxf "\n",
1505                 PTR2UV(cx->blk_sub.cv));
1506         PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1507                 (long)cx->blk_sub.olddepth);
1508         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1509                 (int)CxHASARGS(cx));
1510         PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n", (int)CxLVAL(cx));
1511         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%" UVxf "\n",
1512                 PTR2UV(cx->blk_sub.retop));
1513         break;
1514     case CXt_EVAL:
1515         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1516                 (long)CxOLD_IN_EVAL(cx));
1517         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1518                 PL_op_name[CxOLD_OP_TYPE(cx)],
1519                 PL_op_desc[CxOLD_OP_TYPE(cx)]);
1520         if (cx->blk_eval.old_namesv)
1521             PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1522                           SvPVX_const(cx->blk_eval.old_namesv));
1523         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%" UVxf "\n",
1524                 PTR2UV(cx->blk_eval.old_eval_root));
1525         PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%" UVxf "\n",
1526                 PTR2UV(cx->blk_eval.retop));
1527         break;
1528
1529     case CXt_LOOP_PLAIN:
1530     case CXt_LOOP_LAZYIV:
1531     case CXt_LOOP_LAZYSV:
1532     case CXt_LOOP_LIST:
1533     case CXt_LOOP_ARY:
1534         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n", CxLABEL(cx));
1535         PerlIO_printf(Perl_debug_log, "BLK_LOOP.MY_OP = 0x%" UVxf "\n",
1536                 PTR2UV(cx->blk_loop.my_op));
1537         if (CxTYPE(cx) != CXt_LOOP_PLAIN) {
1538             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%" UVxf "\n",
1539                     PTR2UV(CxITERVAR(cx)));
1540             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERSAVE = 0x%" UVxf "\n",
1541                     PTR2UV(cx->blk_loop.itersave));
1542             /* XXX: not accurate for LAZYSV/IV/LIST */
1543             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%" UVxf "\n",
1544                     PTR2UV(cx->blk_loop.state_u.ary.ary));
1545             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1546                     (long)cx->blk_loop.state_u.ary.ix);
1547         }
1548         break;
1549
1550     case CXt_SUBST:
1551         PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1552                 (long)cx->sb_iters);
1553         PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1554                 (long)cx->sb_maxiters);
1555         PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1556                 (long)cx->sb_rflags);
1557         PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1558                 (long)CxONCE(cx));
1559         PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1560                 cx->sb_orig);
1561         PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%" UVxf "\n",
1562                 PTR2UV(cx->sb_dstr));
1563         PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%" UVxf "\n",
1564                 PTR2UV(cx->sb_targ));
1565         PerlIO_printf(Perl_debug_log, "SB_S = 0x%" UVxf "\n",
1566                 PTR2UV(cx->sb_s));
1567         PerlIO_printf(Perl_debug_log, "SB_M = 0x%" UVxf "\n",
1568                 PTR2UV(cx->sb_m));
1569         PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%" UVxf "\n",
1570                 PTR2UV(cx->sb_strend));
1571         PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%" UVxf "\n",
1572                 PTR2UV(cx->sb_rxres));
1573         break;
1574     }
1575 #else
1576     PERL_UNUSED_CONTEXT;
1577     PERL_UNUSED_ARG(cx);
1578 #endif  /* DEBUGGING */
1579 }
1580
1581 /*
1582  * ex: set ts=8 sts=4 sw=4 et:
1583  */