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