scope.c

   1 /*    scope.c
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 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
  16 /* This file contains functions to manipulate several of Perl's stacks;
  17  * in particular it contains code to push various types of things onto
  18  * the savestack, then to pop them off and perform the correct restorative
  19  * action for each one. This corresponds to the cleanup Perl does at
  20  * each scope exit.
  21  */
  22
  23 #include "EXTERN.h"
  24 #define PERL_IN_SCOPE_C
  25 #include "perl.h"
  26
  27 SV**
  28 Perl_stack_grow(pTHX_ SV **sp, SV **p, int n)
  29 {
  30     dVAR;
  31     PL_stack_sp = sp;
  32 #ifndef STRESS_REALLOC
  33     av_extend(PL_curstack, (p - PL_stack_base) + (n) + 128);
  34 #else
  35     av_extend(PL_curstack, (p - PL_stack_base) + (n) + 1);
  36 #endif
  37     return PL_stack_sp;
  38 }
  39
  40 #ifndef STRESS_REALLOC
  41 #define GROW(old) ((old) * 3 / 2)
  42 #else
  43 #define GROW(old) ((old) + 1)
  44 #endif
  45
  46 PERL_SI *
  47 Perl_new_stackinfo(pTHX_ I32 stitems, I32 cxitems)
  48 {
  49     dVAR;
  50     PERL_SI *si;
  51     Newx(si, 1, PERL_SI);
  52     si->si_stack = newAV();
  53     AvREAL_off(si->si_stack);
  54     av_extend(si->si_stack, stitems > 0 ? stitems-1 : 0);
  55     AvALLOC(si->si_stack)[0] = &PL_sv_undef;
  56     AvFILLp(si->si_stack) = 0;
  57     si->si_prev = 0;
  58     si->si_next = 0;
  59     si->si_cxmax = cxitems - 1;
  60     si->si_cxix = -1;
  61     si->si_type = PERLSI_UNDEF;
  62     Newx(si->si_cxstack, cxitems, PERL_CONTEXT);
  63     /* Without any kind of initialising PUSHSUBST()
  64      * in pp_subst() will read uninitialised heap. */
  65     PoisonNew(si->si_cxstack, cxitems, PERL_CONTEXT);
  66     return si;
  67 }
  68
  69 I32
  70 Perl_cxinc(pTHX)
  71 {
  72     dVAR;
  73     const IV old_max = cxstack_max;
  74     cxstack_max = GROW(cxstack_max);
  75     Renew(cxstack, cxstack_max + 1, PERL_CONTEXT);      /* XXX should fix CXINC macro */
  76     /* Without any kind of initialising deep enough recursion
  77      * will end up reading uninitialised PERL_CONTEXTs. */
  78     PoisonNew(cxstack + old_max + 1, cxstack_max - old_max, PERL_CONTEXT);
  79     return cxstack_ix + 1;
  80 }
  81
  82 void
  83 Perl_push_scope(pTHX)
  84 {
  85     dVAR;
  86     if (PL_scopestack_ix == PL_scopestack_max) {
  87         PL_scopestack_max = GROW(PL_scopestack_max);
  88         Renew(PL_scopestack, PL_scopestack_max, I32);
  89     }
  90     PL_scopestack[PL_scopestack_ix++] = PL_savestack_ix;
  91
  92 }
  93
  94 void
  95 Perl_pop_scope(pTHX)
  96 {
  97     dVAR;
  98     const I32 oldsave = PL_scopestack[--PL_scopestack_ix];
  99     LEAVE_SCOPE(oldsave);
 100 }
 101
 102 void
 103 Perl_markstack_grow(pTHX)
 104 {
 105     dVAR;
 106     const I32 oldmax = PL_markstack_max - PL_markstack;
 107     const I32 newmax = GROW(oldmax);
 108
 109     Renew(PL_markstack, newmax, I32);
 110     PL_markstack_ptr = PL_markstack + oldmax;
 111     PL_markstack_max = PL_markstack + newmax;
 112 }
 113
 114 void
 115 Perl_savestack_grow(pTHX)
 116 {
 117     dVAR;
 118     PL_savestack_max = GROW(PL_savestack_max) + 4;
 119     Renew(PL_savestack, PL_savestack_max, ANY);
 120 }
 121
 122 void
 123 Perl_savestack_grow_cnt(pTHX_ I32 need)
 124 {
 125     dVAR;
 126     PL_savestack_max = PL_savestack_ix + need;
 127     Renew(PL_savestack, PL_savestack_max, ANY);
 128 }
 129
 130 #undef GROW
 131
 132 void
 133 Perl_tmps_grow(pTHX_ I32 n)
 134 {
 135     dVAR;
 136 #ifndef STRESS_REALLOC
 137     if (n < 128)
 138         n = (PL_tmps_max < 512) ? 128 : 512;
 139 #endif
 140     PL_tmps_max = PL_tmps_ix + n + 1;
 141     Renew(PL_tmps_stack, PL_tmps_max, SV*);
 142 }
 143
 144
 145 void
 146 Perl_free_tmps(pTHX)
 147 {
 148     dVAR;
 149     /* XXX should tmps_floor live in cxstack? */
 150     const I32 myfloor = PL_tmps_floor;
 151     while (PL_tmps_ix > myfloor) {      /* clean up after last statement */
 152         SV* const sv = PL_tmps_stack[PL_tmps_ix];
 153         PL_tmps_stack[PL_tmps_ix--] = NULL;
 154         if (sv && sv != &PL_sv_undef) {
 155             SvTEMP_off(sv);
 156             SvREFCNT_dec(sv);           /* note, can modify tmps_ix!!! */
 157         }
 158     }
 159 }
 160
 161 STATIC SV *
 162 S_save_scalar_at(pTHX_ SV **sptr)
 163 {
 164     dVAR;
 165     SV * const osv = *sptr;
 166     register SV * const sv = *sptr = newSV(0);
 167
 168     if (SvTYPE(osv) >= SVt_PVMG && SvMAGIC(osv) && SvTYPE(osv) != SVt_PVGV) {
 169         if (SvGMAGICAL(osv)) {
 170             const bool oldtainted = PL_tainted;
 171             SvFLAGS(osv) |= (SvFLAGS(osv) &
 172                (SVp_IOK|SVp_NOK|SVp_POK)) >> PRIVSHIFT;
 173             PL_tainted = oldtainted;
 174         }
 175         mg_localize(osv, sv);
 176     }
 177     return sv;
 178 }
 179
 180 SV *
 181 Perl_save_scalar(pTHX_ GV *gv)
 182 {
 183     dVAR;
 184     SV ** const sptr = &GvSVn(gv);
 185     PL_localizing = 1;
 186     SvGETMAGIC(*sptr);
 187     PL_localizing = 0;
 188     SSCHECK(3);
 189     SSPUSHPTR(SvREFCNT_inc_simple(gv));
 190     SSPUSHPTR(SvREFCNT_inc(*sptr));
 191     SSPUSHINT(SAVEt_SV);
 192     return save_scalar_at(sptr);
 193 }
 194
 195 /* Like save_sptr(), but also SvREFCNT_dec()s the new value.  Can be used to
 196  * restore a global SV to its prior contents, freeing new value. */
 197 void
 198 Perl_save_generic_svref(pTHX_ SV **sptr)
 199 {
 200     dVAR;
 201     SSCHECK(3);
 202     SSPUSHPTR(sptr);
 203     SSPUSHPTR(SvREFCNT_inc(*sptr));
 204     SSPUSHINT(SAVEt_GENERIC_SVREF);
 205 }
 206
 207 /* Like save_pptr(), but also Safefree()s the new value if it is different
 208  * from the old one.  Can be used to restore a global char* to its prior
 209  * contents, freeing new value. */
 210 void
 211 Perl_save_generic_pvref(pTHX_ char **str)
 212 {
 213     dVAR;
 214     SSCHECK(3);
 215     SSPUSHPTR(*str);
 216     SSPUSHPTR(str);
 217     SSPUSHINT(SAVEt_GENERIC_PVREF);
 218 }
 219
 220 /* Like save_generic_pvref(), but uses PerlMemShared_free() rather than Safefree().
 221  * Can be used to restore a shared global char* to its prior
 222  * contents, freeing new value. */
 223 void
 224 Perl_save_shared_pvref(pTHX_ char **str)
 225 {
 226     dVAR;
 227     SSCHECK(3);
 228     SSPUSHPTR(str);
 229     SSPUSHPTR(*str);
 230     SSPUSHINT(SAVEt_SHARED_PVREF);
 231 }
 232
 233 /* set the SvFLAGS specified by mask to the values in val */
 234
 235 void
 236 Perl_save_set_svflags(pTHX_ SV* sv, U32 mask, U32 val)
 237 {
 238     dVAR;
 239     SSCHECK(4);
 240     SSPUSHPTR(sv);
 241     SSPUSHINT(mask);
 242     SSPUSHINT(val);
 243     SSPUSHINT(SAVEt_SET_SVFLAGS);
 244 }
 245
 246 void
 247 Perl_save_gp(pTHX_ GV *gv, I32 empty)
 248 {
 249     dVAR;
 250     SSGROW(3);
 251     SSPUSHPTR(SvREFCNT_inc(gv));
 252     SSPUSHPTR(GvGP(gv));
 253     SSPUSHINT(SAVEt_GP);
 254
 255     if (empty) {
 256         GP *gp = Perl_newGP(aTHX_ gv);
 257
 258         if (GvCVu(gv))
 259             mro_method_changed_in(GvSTASH(gv)); /* taking a method out of circulation ("local")*/
 260         if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
 261             gp->gp_io = newIO();
 262             IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
 263         }
 264         GvGP(gv) = gp;
 265     }
 266     else {
 267         gp_ref(GvGP(gv));
 268         GvINTRO_on(gv);
 269     }
 270 }
 271
 272 AV *
 273 Perl_save_ary(pTHX_ GV *gv)
 274 {
 275     dVAR;
 276     AV * const oav = GvAVn(gv);
 277     AV *av;
 278
 279     if (!AvREAL(oav) && AvREIFY(oav))
 280         av_reify(oav);
 281     SSCHECK(3);
 282     SSPUSHPTR(gv);
 283     SSPUSHPTR(oav);
 284     SSPUSHINT(SAVEt_AV);
 285
 286     GvAV(gv) = NULL;
 287     av = GvAVn(gv);
 288     if (SvMAGIC(oav))
 289         mg_localize((SV*)oav, (SV*)av);
 290     return av;
 291 }
 292
 293 HV *
 294 Perl_save_hash(pTHX_ GV *gv)
 295 {
 296     dVAR;
 297     HV *ohv, *hv;
 298
 299     SSCHECK(3);
 300     SSPUSHPTR(gv);
 301     SSPUSHPTR(ohv = GvHVn(gv));
 302     SSPUSHINT(SAVEt_HV);
 303
 304     GvHV(gv) = NULL;
 305     hv = GvHVn(gv);
 306     if (SvMAGIC(ohv))
 307         mg_localize((SV*)ohv, (SV*)hv);
 308     return hv;
 309 }
 310
 311 void
 312 Perl_save_item(pTHX_ register SV *item)
 313 {
 314     dVAR;
 315     register SV * const sv = newSVsv(item);
 316
 317     SSCHECK(3);
 318     SSPUSHPTR(item);            /* remember the pointer */
 319     SSPUSHPTR(sv);              /* remember the value */
 320     SSPUSHINT(SAVEt_ITEM);
 321 }
 322
 323 void
 324 Perl_save_int(pTHX_ int *intp)
 325 {
 326     dVAR;
 327     SSCHECK(3);
 328     SSPUSHINT(*intp);
 329     SSPUSHPTR(intp);
 330     SSPUSHINT(SAVEt_INT);
 331 }
 332
 333 void
 334 Perl_save_bool(pTHX_ bool *boolp)
 335 {
 336     dVAR;
 337     SSCHECK(3);
 338     SSPUSHBOOL(*boolp);
 339     SSPUSHPTR(boolp);
 340     SSPUSHINT(SAVEt_BOOL);
 341 }
 342
 343 void
 344 Perl_save_I8(pTHX_ I8 *bytep)
 345 {
 346     dVAR;
 347     SSCHECK(3);
 348     SSPUSHINT(*bytep);
 349     SSPUSHPTR(bytep);
 350     SSPUSHINT(SAVEt_I8);
 351 }
 352
 353 void
 354 Perl_save_I16(pTHX_ I16 *intp)
 355 {
 356     dVAR;
 357     SSCHECK(3);
 358     SSPUSHINT(*intp);
 359     SSPUSHPTR(intp);
 360     SSPUSHINT(SAVEt_I16);
 361 }
 362
 363 void
 364 Perl_save_I32(pTHX_ I32 *intp)
 365 {
 366     dVAR;
 367     SSCHECK(3);
 368     SSPUSHINT(*intp);
 369     SSPUSHPTR(intp);
 370     SSPUSHINT(SAVEt_I32);
 371 }
 372
 373 /* Cannot use save_sptr() to store a char* since the SV** cast will
 374  * force word-alignment and we'll miss the pointer.
 375  */
 376 void
 377 Perl_save_pptr(pTHX_ char **pptr)
 378 {
 379     dVAR;
 380     SSCHECK(3);
 381     SSPUSHPTR(*pptr);
 382     SSPUSHPTR(pptr);
 383     SSPUSHINT(SAVEt_PPTR);
 384 }
 385
 386 void
 387 Perl_save_vptr(pTHX_ void *ptr)
 388 {
 389     dVAR;
 390     SSCHECK(3);
 391     SSPUSHPTR(*(char**)ptr);
 392     SSPUSHPTR(ptr);
 393     SSPUSHINT(SAVEt_VPTR);
 394 }
 395
 396 void
 397 Perl_save_sptr(pTHX_ SV **sptr)
 398 {
 399     dVAR;
 400     SSCHECK(3);
 401     SSPUSHPTR(*sptr);
 402     SSPUSHPTR(sptr);
 403     SSPUSHINT(SAVEt_SPTR);
 404 }
 405
 406 void
 407 Perl_save_padsv(pTHX_ PADOFFSET off)
 408 {
 409     dVAR;
 410     SSCHECK(4);
 411     ASSERT_CURPAD_ACTIVE("save_padsv");
 412     SSPUSHPTR(PL_curpad[off]);
 413     SSPUSHPTR(PL_comppad);
 414     SSPUSHLONG((long)off);
 415     SSPUSHINT(SAVEt_PADSV);
 416 }
 417
 418 void
 419 Perl_save_hptr(pTHX_ HV **hptr)
 420 {
 421     dVAR;
 422     SSCHECK(3);
 423     SSPUSHPTR(*hptr);
 424     SSPUSHPTR(hptr);
 425     SSPUSHINT(SAVEt_HPTR);
 426 }
 427
 428 void
 429 Perl_save_aptr(pTHX_ AV **aptr)
 430 {
 431     dVAR;
 432     SSCHECK(3);
 433     SSPUSHPTR(*aptr);
 434     SSPUSHPTR(aptr);
 435     SSPUSHINT(SAVEt_APTR);
 436 }
 437
 438 void
 439 Perl_save_freesv(pTHX_ SV *sv)
 440 {
 441     dVAR;
 442     SSCHECK(2);
 443     SSPUSHPTR(sv);
 444     SSPUSHINT(SAVEt_FREESV);
 445 }
 446
 447 void
 448 Perl_save_mortalizesv(pTHX_ SV *sv)
 449 {
 450     dVAR;
 451     SSCHECK(2);
 452     SSPUSHPTR(sv);
 453     SSPUSHINT(SAVEt_MORTALIZESV);
 454 }
 455
 456 void
 457 Perl_save_freeop(pTHX_ OP *o)
 458 {
 459     dVAR;
 460     SSCHECK(2);
 461     SSPUSHPTR(o);
 462     SSPUSHINT(SAVEt_FREEOP);
 463 }
 464
 465 void
 466 Perl_save_freepv(pTHX_ char *pv)
 467 {
 468     dVAR;
 469     SSCHECK(2);
 470     SSPUSHPTR(pv);
 471     SSPUSHINT(SAVEt_FREEPV);
 472 }
 473
 474 void
 475 Perl_save_clearsv(pTHX_ SV **svp)
 476 {
 477     dVAR;
 478     ASSERT_CURPAD_ACTIVE("save_clearsv");
 479     SSCHECK(2);
 480     SSPUSHLONG((long)(svp-PL_curpad));
 481     SSPUSHINT(SAVEt_CLEARSV);
 482     SvPADSTALE_off(*svp); /* mark lexical as active */
 483 }
 484
 485 void
 486 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
 487 {
 488     dVAR;
 489     SSCHECK(4);
 490     SSPUSHINT(klen);
 491     SSPUSHPTR(key);
 492     SSPUSHPTR(SvREFCNT_inc_simple(hv));
 493     SSPUSHINT(SAVEt_DELETE);
 494 }
 495
 496 void
 497 Perl_save_destructor(pTHX_ DESTRUCTORFUNC_NOCONTEXT_t f, void* p)
 498 {
 499     dVAR;
 500     SSCHECK(3);
 501     SSPUSHDPTR(f);
 502     SSPUSHPTR(p);
 503     SSPUSHINT(SAVEt_DESTRUCTOR);
 504 }
 505
 506 void
 507 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
 508 {
 509     dVAR;
 510     SSCHECK(3);
 511     SSPUSHDXPTR(f);
 512     SSPUSHPTR(p);
 513     SSPUSHINT(SAVEt_DESTRUCTOR_X);
 514 }
 515
 516 void
 517 Perl_save_aelem(pTHX_ AV *av, I32 idx, SV **sptr)
 518 {
 519     dVAR;
 520     SV *sv;
 521     SvGETMAGIC(*sptr);
 522     SSCHECK(4);
 523     SSPUSHPTR(SvREFCNT_inc_simple(av));
 524     SSPUSHINT(idx);
 525     SSPUSHPTR(SvREFCNT_inc(*sptr));
 526     SSPUSHINT(SAVEt_AELEM);
 527     /* if it gets reified later, the restore will have the wrong refcnt */
 528     if (!AvREAL(av) && AvREIFY(av))
 529         SvREFCNT_inc_void(*sptr);
 530     save_scalar_at(sptr);
 531     sv = *sptr;
 532     /* If we're localizing a tied array element, this new sv
 533      * won't actually be stored in the array - so it won't get
 534      * reaped when the localize ends. Ensure it gets reaped by
 535      * mortifying it instead. DAPM */
 536     if (SvTIED_mg(sv, PERL_MAGIC_tiedelem))
 537         sv_2mortal(sv);
 538 }
 539
 540 void
 541 Perl_save_helem(pTHX_ HV *hv, SV *key, SV **sptr)
 542 {
 543     dVAR;
 544     SV *sv;
 545     SvGETMAGIC(*sptr);
 546     SSCHECK(4);
 547     SSPUSHPTR(SvREFCNT_inc_simple(hv));
 548     SSPUSHPTR(SvREFCNT_inc_simple(key));
 549     SSPUSHPTR(SvREFCNT_inc(*sptr));
 550     SSPUSHINT(SAVEt_HELEM);
 551     save_scalar_at(sptr);
 552     sv = *sptr;
 553     /* If we're localizing a tied hash element, this new sv
 554      * won't actually be stored in the hash - so it won't get
 555      * reaped when the localize ends. Ensure it gets reaped by
 556      * mortifying it instead. DAPM */
 557     if (SvTIED_mg(sv, PERL_MAGIC_tiedelem))
 558         sv_2mortal(sv);
 559 }
 560
 561 SV*
 562 Perl_save_svref(pTHX_ SV **sptr)
 563 {
 564     dVAR;
 565     SvGETMAGIC(*sptr);
 566     SSCHECK(3);
 567     SSPUSHPTR(sptr);
 568     SSPUSHPTR(SvREFCNT_inc(*sptr));
 569     SSPUSHINT(SAVEt_SVREF);
 570     return save_scalar_at(sptr);
 571 }
 572
 573 void
 574 Perl_save_op(pTHX)
 575 {
 576     dVAR;
 577     SSCHECK(2);
 578     SSPUSHPTR(PL_op);
 579     SSPUSHINT(SAVEt_OP);
 580 }
 581
 582 I32
 583 Perl_save_alloc(pTHX_ I32 size, I32 pad)
 584 {
 585     dVAR;
 586     register const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
 587                                 - (char*)PL_savestack);
 588     register const I32 elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
 589
 590     SSGROW(elems + 2);
 591
 592     PL_savestack_ix += elems;
 593     SSPUSHINT(elems);
 594     SSPUSHINT(SAVEt_ALLOC);
 595     return start;
 596 }
 597
 598 void
 599 Perl_leave_scope(pTHX_ I32 base)
 600 {
 601     dVAR;
 602     register SV *sv;
 603     register SV *value;
 604     register GV *gv;
 605     register AV *av;
 606     register HV *hv;
 607     void* ptr;
 608     register char* str;
 609     I32 i;
 610
 611     if (base < -1)
 612         Perl_croak(aTHX_ "panic: corrupt saved stack index");
 613     while (PL_savestack_ix > base) {
 614         switch (SSPOPINT) {
 615         case SAVEt_ITEM:                        /* normal string */
 616             value = (SV*)SSPOPPTR;
 617             sv = (SV*)SSPOPPTR;
 618             sv_replace(sv,value);
 619             PL_localizing = 2;
 620             SvSETMAGIC(sv);
 621             PL_localizing = 0;
 622             break;
 623         case SAVEt_SV:                          /* scalar reference */
 624             value = (SV*)SSPOPPTR;
 625             gv = (GV*)SSPOPPTR;
 626             ptr = &GvSV(gv);
 627             av = (AV*)gv; /* what to refcnt_dec */
 628         restore_sv:
 629             sv = *(SV**)ptr;
 630             DEBUG_S(PerlIO_printf(Perl_debug_log,
 631                                   "restore svref: %p %p:%s -> %p:%s\n",
 632                                   (void*)ptr, (void*)sv, SvPEEK(sv),
 633                                   (void*)value, SvPEEK(value)));
 634             *(SV**)ptr = value;
 635             SvREFCNT_dec(sv);
 636             PL_localizing = 2;
 637             SvSETMAGIC(value);
 638             PL_localizing = 0;
 639             SvREFCNT_dec(value);
 640             if (av) /* actually an av, hv or gv */
 641                 SvREFCNT_dec(av);
 642             break;
 643         case SAVEt_GENERIC_PVREF:               /* generic pv */
 644             ptr = SSPOPPTR;
 645             str = (char*)SSPOPPTR;
 646             if (*(char**)ptr != str) {
 647                 Safefree(*(char**)ptr);
 648                 *(char**)ptr = str;
 649             }
 650             break;
 651         case SAVEt_SHARED_PVREF:                /* shared pv */
 652             str = (char*)SSPOPPTR;
 653             ptr = SSPOPPTR;
 654             if (*(char**)ptr != str) {
 655 #ifdef NETWARE
 656                 PerlMem_free(*(char**)ptr);
 657 #else
 658                 PerlMemShared_free(*(char**)ptr);
 659 #endif
 660                 *(char**)ptr = str;
 661             }
 662             break;
 663         case SAVEt_GENERIC_SVREF:               /* generic sv */
 664             value = (SV*)SSPOPPTR;
 665             ptr = SSPOPPTR;
 666             sv = *(SV**)ptr;
 667             *(SV**)ptr = value;
 668             SvREFCNT_dec(sv);
 669             SvREFCNT_dec(value);
 670             break;
 671         case SAVEt_AV:                          /* array reference */
 672             av = (AV*)SSPOPPTR;
 673             gv = (GV*)SSPOPPTR;
 674             if (GvAV(gv)) {
 675                 AV * const goner = GvAV(gv);
 676                 /* FIXME - this is a temporary hack until we work out what
 677                    the correct behaviour for magic should be.  */
 678                 sv_unmagic((SV*)goner, PERL_MAGIC_arylen_p);
 679                 SvMAGIC_set(av, SvMAGIC(goner));
 680                 SvFLAGS((SV*)av) |= SvMAGICAL(goner);
 681                 SvMAGICAL_off(goner);
 682                 SvMAGIC_set(goner, NULL);
 683                 SvREFCNT_dec(goner);
 684             }
 685             GvAV(gv) = av;
 686             if (SvMAGICAL(av)) {
 687                 PL_localizing = 2;
 688                 SvSETMAGIC((SV*)av);
 689                 PL_localizing = 0;
 690             }
 691             break;
 692         case SAVEt_HV:                          /* hash reference */
 693             hv = (HV*)SSPOPPTR;
 694             gv = (GV*)SSPOPPTR;
 695             if (GvHV(gv)) {
 696                 HV * const goner = GvHV(gv);
 697                 SvMAGIC_set(hv, SvMAGIC(goner));
 698                 SvFLAGS(hv) |= SvMAGICAL(goner);
 699                 SvMAGICAL_off(goner);
 700                 SvMAGIC_set(goner, NULL);
 701                 SvREFCNT_dec(goner);
 702             }
 703             GvHV(gv) = hv;
 704             if (SvMAGICAL(hv)) {
 705                 PL_localizing = 2;
 706                 SvSETMAGIC((SV*)hv);
 707                 PL_localizing = 0;
 708             }
 709             break;
 710         case SAVEt_INT:                         /* int reference */
 711             ptr = SSPOPPTR;
 712             *(int*)ptr = (int)SSPOPINT;
 713             break;
 714         case SAVEt_BOOL:                        /* bool reference */
 715             ptr = SSPOPPTR;
 716             *(bool*)ptr = (bool)SSPOPBOOL;
 717             break;
 718         case SAVEt_I32:                         /* I32 reference */
 719             ptr = SSPOPPTR;
 720 #ifdef PERL_DEBUG_READONLY_OPS
 721             {
 722                 const I32 val = SSPOPINT;
 723                 if (*(I32*)ptr != val)
 724                     *(I32*)ptr = val;
 725             }
 726 #else
 727             *(I32*)ptr = (I32)SSPOPINT;
 728 #endif
 729             break;
 730         case SAVEt_SPTR:                        /* SV* reference */
 731             ptr = SSPOPPTR;
 732             *(SV**)ptr = (SV*)SSPOPPTR;
 733             break;
 734         case SAVEt_VPTR:                        /* random* reference */
 735         case SAVEt_PPTR:                        /* char* reference */
 736             ptr = SSPOPPTR;
 737             *(char**)ptr = (char*)SSPOPPTR;
 738             break;
 739         case SAVEt_HPTR:                        /* HV* reference */
 740             ptr = SSPOPPTR;
 741             *(HV**)ptr = (HV*)SSPOPPTR;
 742             break;
 743         case SAVEt_APTR:                        /* AV* reference */
 744             ptr = SSPOPPTR;
 745             *(AV**)ptr = (AV*)SSPOPPTR;
 746             break;
 747         case SAVEt_GP:                          /* scalar reference */
 748             ptr = SSPOPPTR;
 749             gv = (GV*)SSPOPPTR;
 750             gp_free(gv);
 751             GvGP(gv) = (GP*)ptr;
 752             /* putting a method back into circulation ("local")*/
 753             if (GvCVu(gv) && (hv=GvSTASH(gv)) && HvNAME_get(hv))
 754                 mro_method_changed_in(hv);
 755             SvREFCNT_dec(gv);
 756             break;
 757         case SAVEt_FREESV:
 758             ptr = SSPOPPTR;
 759             SvREFCNT_dec((SV*)ptr);
 760             break;
 761         case SAVEt_MORTALIZESV:
 762             ptr = SSPOPPTR;
 763             sv_2mortal((SV*)ptr);
 764             break;
 765         case SAVEt_FREEOP:
 766             ptr = SSPOPPTR;
 767             ASSERT_CURPAD_LEGAL("SAVEt_FREEOP"); /* XXX DAPM tmp */
 768             op_free((OP*)ptr);
 769             break;
 770         case SAVEt_FREEPV:
 771             ptr = SSPOPPTR;
 772             Safefree(ptr);
 773             break;
 774         case SAVEt_CLEARSV:
 775             ptr = (void*)&PL_curpad[SSPOPLONG];
 776             sv = *(SV**)ptr;
 777
 778             DEBUG_Xv(PerlIO_printf(Perl_debug_log,
 779              "Pad 0x%"UVxf"[0x%"UVxf"] clearsv: %ld sv=0x%"UVxf"<%"IVdf"> %s\n",
 780                 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
 781                 (long)((SV **)ptr-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
 782                 (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
 783             ));
 784
 785             /* Can clear pad variable in place? */
 786             if (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) {
 787                 /*
 788                  * if a my variable that was made readonly is going out of
 789                  * scope, we want to remove the readonlyness so that it can
 790                  * go out of scope quietly
 791                  */
 792                 if (SvPADMY(sv) && !SvFAKE(sv))
 793                     SvREADONLY_off(sv);
 794
 795                 if (SvTHINKFIRST(sv))
 796                     sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF);
 797                 if (SvMAGICAL(sv))
 798                     mg_free(sv);
 799
 800                 switch (SvTYPE(sv)) {
 801                 case SVt_NULL:
 802                     break;
 803                 case SVt_PVAV:
 804                     av_clear((AV*)sv);
 805                     break;
 806                 case SVt_PVHV:
 807                     hv_clear((HV*)sv);
 808                     break;
 809                 case SVt_PVCV:
 810                     Perl_croak(aTHX_ "panic: leave_scope pad code");
 811                 default:
 812                     SvOK_off(sv);
 813                     break;
 814                 }
 815                 SvPADSTALE_on(sv); /* mark as no longer live */
 816             }
 817             else {      /* Someone has a claim on this, so abandon it. */
 818                 const U32 padflags = SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP);
 819                 switch (SvTYPE(sv)) {   /* Console ourselves with a new value */
 820                 case SVt_PVAV:  *(SV**)ptr = (SV*)newAV();      break;
 821                 case SVt_PVHV:  *(SV**)ptr = (SV*)newHV();      break;
 822                 default:        *(SV**)ptr = newSV(0);          break;
 823                 }
 824                 SvREFCNT_dec(sv);       /* Cast current value to the winds. */
 825                 /* preserve pad nature, but also mark as not live
 826                  * for any closure capturing */
 827                 SvFLAGS(*(SV**)ptr) |= padflags | SVs_PADSTALE;
 828             }
 829             break;
 830         case SAVEt_DELETE:
 831             ptr = SSPOPPTR;
 832             hv = (HV*)ptr;
 833             ptr = SSPOPPTR;
 834             (void)hv_delete(hv, (char*)ptr, (I32)SSPOPINT, G_DISCARD);
 835             SvREFCNT_dec(hv);
 836             Safefree(ptr);
 837             break;
 838         case SAVEt_DESTRUCTOR_X:
 839             ptr = SSPOPPTR;
 840             (*SSPOPDXPTR)(aTHX_ ptr);
 841             break;
 842         case SAVEt_REGCONTEXT:
 843         case SAVEt_ALLOC:
 844             i = SSPOPINT;
 845             PL_savestack_ix -= i;       /* regexp must have croaked */
 846             break;
 847         case SAVEt_STACK_POS:           /* Position on Perl stack */
 848             i = SSPOPINT;
 849             PL_stack_sp = PL_stack_base + i;
 850             break;
 851         case SAVEt_STACK_CXPOS:         /* blk_oldsp on context stack */
 852             i = SSPOPINT;
 853             cxstack[i].blk_oldsp = SSPOPINT;
 854             break;
 855         case SAVEt_AELEM:               /* array element */
 856             value = (SV*)SSPOPPTR;
 857             i = SSPOPINT;
 858             av = (AV*)SSPOPPTR;
 859             ptr = av_fetch(av,i,1);
 860             if (!AvREAL(av) && AvREIFY(av)) /* undo reify guard */
 861                 SvREFCNT_dec(value);
 862             if (ptr) {
 863                 sv = *(SV**)ptr;
 864                 if (sv && sv != &PL_sv_undef) {
 865                     if (SvTIED_mg((SV*)av, PERL_MAGIC_tied))
 866                         SvREFCNT_inc_void_NN(sv);
 867                     goto restore_sv;
 868                 }
 869             }
 870             SvREFCNT_dec(av);
 871             SvREFCNT_dec(value);
 872             break;
 873         case SAVEt_HELEM:               /* hash element */
 874             value = (SV*)SSPOPPTR;
 875             sv = (SV*)SSPOPPTR;
 876             hv = (HV*)SSPOPPTR;
 877             ptr = hv_fetch_ent(hv, sv, 1, 0);
 878             if (ptr) {
 879                 const SV * const oval = HeVAL((HE*)ptr);
 880                 if (oval && oval != &PL_sv_undef) {
 881                     ptr = &HeVAL((HE*)ptr);
 882                     if (SvTIED_mg((SV*)hv, PERL_MAGIC_tied))
 883                         SvREFCNT_inc_void(*(SV**)ptr);
 884                     SvREFCNT_dec(sv);
 885                     av = (AV*)hv; /* what to refcnt_dec */
 886                     goto restore_sv;
 887                 }
 888             }
 889             SvREFCNT_dec(hv);
 890             SvREFCNT_dec(sv);
 891             SvREFCNT_dec(value);
 892             break;
 893         case SAVEt_OP:
 894             PL_op = (OP*)SSPOPPTR;
 895             break;
 896         case SAVEt_HINTS:
 897             if ((PL_hints & HINT_LOCALIZE_HH) && GvHV(PL_hintgv)) {
 898                 SvREFCNT_dec((SV*)GvHV(PL_hintgv));
 899                 GvHV(PL_hintgv) = NULL;
 900             }
 901             *(I32*)&PL_hints = (I32)SSPOPINT;
 902             Perl_refcounted_he_free(aTHX_ PL_compiling.cop_hints_hash);
 903             PL_compiling.cop_hints_hash = (struct refcounted_he *) SSPOPPTR;
 904             if (PL_hints & HINT_LOCALIZE_HH) {
 905                 SvREFCNT_dec((SV*)GvHV(PL_hintgv));
 906                 GvHV(PL_hintgv) = (HV*)SSPOPPTR;
 907                 assert(GvHV(PL_hintgv));
 908             } else if (!GvHV(PL_hintgv)) {
 909                 /* Need to add a new one manually, else gv_fetchpv() can
 910                    add one in this code:
 911
 912                    if (SvTYPE(gv) == SVt_PVGV) {
 913                        if (add) {
 914                        GvMULTI_on(gv);
 915                        gv_init_sv(gv, sv_type);
 916                        if (*name=='!' && sv_type == SVt_PVHV && len==1)
 917                            require_errno(gv);
 918                        }
 919                        return gv;
 920                    }
 921
 922                    and it won't have the magic set.  */
 923
 924                 HV *const hv = newHV();
 925                 hv_magic(hv, NULL, PERL_MAGIC_hints);
 926                 GvHV(PL_hintgv) = hv;
 927             }
 928             assert(GvHV(PL_hintgv));
 929             break;
 930         case SAVEt_COMPPAD:
 931             PL_comppad = (PAD*)SSPOPPTR;
 932             if (PL_comppad)
 933                 PL_curpad = AvARRAY(PL_comppad);
 934             else
 935                 PL_curpad = NULL;
 936             break;
 937         case SAVEt_PADSV:
 938             {
 939                 const PADOFFSET off = (PADOFFSET)SSPOPLONG;
 940                 ptr = SSPOPPTR;
 941                 if (ptr)
 942                     AvARRAY((PAD*)ptr)[off] = (SV*)SSPOPPTR;
 943             }
 944             break;
 945         case SAVEt_SAVESWITCHSTACK:
 946             {
 947                 dSP;
 948                 AV* const t = (AV*)SSPOPPTR;
 949                 AV* const f = (AV*)SSPOPPTR;
 950                 SWITCHSTACK(t,f);
 951                 PL_curstackinfo->si_stack = f;
 952             }
 953             break;
 954         case SAVEt_SET_SVFLAGS:
 955             {
 956                 const U32 val  = (U32)SSPOPINT;
 957                 const U32 mask = (U32)SSPOPINT;
 958                 sv = (SV*)SSPOPPTR;
 959                 SvFLAGS(sv) &= ~mask;
 960                 SvFLAGS(sv) |= val;
 961             }
 962             break;
 963             /* These are only saved in mathoms.c */
 964         case SAVEt_SVREF:                       /* scalar reference */
 965             value = (SV*)SSPOPPTR;
 966             ptr = SSPOPPTR;
 967             av = NULL; /* what to refcnt_dec */
 968             goto restore_sv;
 969         case SAVEt_LONG:                        /* long reference */
 970             ptr = SSPOPPTR;
 971             *(long*)ptr = (long)SSPOPLONG;
 972             break;
 973         case SAVEt_I16:                         /* I16 reference */
 974             ptr = SSPOPPTR;
 975             *(I16*)ptr = (I16)SSPOPINT;
 976             break;
 977         case SAVEt_I8:                          /* I8 reference */
 978             ptr = SSPOPPTR;
 979             *(I8*)ptr = (I8)SSPOPINT;
 980             break;
 981         case SAVEt_IV:                          /* IV reference */
 982             ptr = SSPOPPTR;
 983             *(IV*)ptr = (IV)SSPOPIV;
 984             break;
 985         case SAVEt_NSTAB:
 986             gv = (GV*)SSPOPPTR;
 987             (void)sv_clear((SV*)gv);
 988             break;
 989         case SAVEt_DESTRUCTOR:
 990             ptr = SSPOPPTR;
 991             (*SSPOPDPTR)(ptr);
 992             break;
 993         case SAVEt_COP_ARYBASE:
 994             ptr = SSPOPPTR;
 995             i = SSPOPINT;
 996             CopARYBASE_set((COP *)ptr, i);
 997             break;
 998         case SAVEt_COMPILE_WARNINGS:
 999             ptr = SSPOPPTR;
1000
1001             if (!specialWARN(PL_compiling.cop_warnings))
1002                 PerlMemShared_free(PL_compiling.cop_warnings);
1003
1004             PL_compiling.cop_warnings = (STRLEN*)ptr;
1005             break;
1006         case SAVEt_RE_STATE:
1007             {
1008                 const struct re_save_state *const state
1009                     = (struct re_save_state *)
1010                     (PL_savestack + PL_savestack_ix
1011                      - SAVESTACK_ALLOC_FOR_RE_SAVE_STATE);
1012                 PL_savestack_ix -= SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
1013
1014                 if (PL_reg_start_tmp != state->re_state_reg_start_tmp) {
1015                     Safefree(PL_reg_start_tmp);
1016                 }
1017                 if (PL_reg_poscache != state->re_state_reg_poscache) {
1018                     Safefree(PL_reg_poscache);
1019                 }
1020                 Copy(state, &PL_reg_state, 1, struct re_save_state);
1021             }
1022             break;
1023         case SAVEt_PARSER:
1024             ptr = SSPOPPTR;
1025             parser_free((yy_parser *) ptr);
1026             break;
1027         default:
1028             Perl_croak(aTHX_ "panic: leave_scope inconsistency");
1029         }
1030     }
1031 }
1032
1033 void
1034 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
1035 {
1036     dVAR;
1037 #ifdef DEBUGGING
1038     PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
1039     if (CxTYPE(cx) != CXt_SUBST) {
1040         PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
1041         PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
1042                       PTR2UV(cx->blk_oldcop));
1043         PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
1044         PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
1045         PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
1046                       PTR2UV(cx->blk_oldpm));
1047         PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", cx->blk_gimme ? "LIST" : "SCALAR");
1048     }
1049     switch (CxTYPE(cx)) {
1050     case CXt_NULL:
1051     case CXt_BLOCK:
1052         break;
1053     case CXt_FORMAT:
1054         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1055                 PTR2UV(cx->blk_sub.cv));
1056         PerlIO_printf(Perl_debug_log, "BLK_SUB.GV = 0x%"UVxf"\n",
1057                 PTR2UV(cx->blk_sub.gv));
1058         PerlIO_printf(Perl_debug_log, "BLK_SUB.DFOUTGV = 0x%"UVxf"\n",
1059                 PTR2UV(cx->blk_sub.dfoutgv));
1060         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1061                 (int)cx->blk_sub.hasargs);
1062         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1063                 PTR2UV(cx->blk_sub.retop));
1064         break;
1065     case CXt_SUB:
1066         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
1067                 PTR2UV(cx->blk_sub.cv));
1068         PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
1069                 (long)cx->blk_sub.olddepth);
1070         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
1071                 (int)cx->blk_sub.hasargs);
1072         PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n",
1073                 (int)cx->blk_sub.lval);
1074         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
1075                 PTR2UV(cx->blk_sub.retop));
1076         break;
1077     case CXt_EVAL:
1078         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
1079                 (long)cx->blk_eval.old_in_eval);
1080         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
1081                 PL_op_name[cx->blk_eval.old_op_type],
1082                 PL_op_desc[cx->blk_eval.old_op_type]);
1083         if (cx->blk_eval.old_namesv)
1084             PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
1085                           SvPVX_const(cx->blk_eval.old_namesv));
1086         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
1087                 PTR2UV(cx->blk_eval.old_eval_root));
1088         PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%"UVxf"\n",
1089                 PTR2UV(cx->blk_eval.retop));
1090         break;
1091
1092     case CXt_LOOP:
1093         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n",
1094                 cx->blk_loop.label);
1095         PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
1096                 (long)cx->blk_loop.resetsp);
1097         PerlIO_printf(Perl_debug_log, "BLK_LOOP.MY_OP = 0x%"UVxf"\n",
1098                 PTR2UV(cx->blk_loop.my_op));
1099         PerlIO_printf(Perl_debug_log, "BLK_LOOP.NEXT_OP = 0x%"UVxf"\n",
1100                 PTR2UV(CX_LOOP_NEXTOP_GET(cx)));
1101         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1102                 (long)cx->blk_loop.iterix);
1103         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1104                 PTR2UV(cx->blk_loop.iterary));
1105         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1106                 PTR2UV(CxITERVAR(cx)));
1107         if (CxITERVAR(cx))
1108             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERSAVE = 0x%"UVxf"\n",
1109                 PTR2UV(cx->blk_loop.itersave));
1110         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERLVAL = 0x%"UVxf"\n",
1111                 PTR2UV(cx->blk_loop.iterlval));
1112         break;
1113
1114     case CXt_SUBST:
1115         PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1116                 (long)cx->sb_iters);
1117         PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1118                 (long)cx->sb_maxiters);
1119         PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1120                 (long)cx->sb_rflags);
1121         PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1122                 (long)cx->sb_once);
1123         PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1124                 cx->sb_orig);
1125         PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1126                 PTR2UV(cx->sb_dstr));
1127         PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1128                 PTR2UV(cx->sb_targ));
1129         PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1130                 PTR2UV(cx->sb_s));
1131         PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1132                 PTR2UV(cx->sb_m));
1133         PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1134                 PTR2UV(cx->sb_strend));
1135         PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1136                 PTR2UV(cx->sb_rxres));
1137         break;
1138     }
1139 #else
1140     PERL_UNUSED_CONTEXT;
1141     PERL_UNUSED_ARG(cx);
1142 #endif  /* DEBUGGING */
1143 }
1144
1145 /*
1146  * Local variables:
1147  * c-indentation-style: bsd
1148  * c-basic-offset: 4
1149  * indent-tabs-mode: t
1150  * End:
1151  *
1152  * ex: set ts=8 sts=4 sw=4 noet:
1153  */