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