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