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, 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     Poison(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     Poison(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         register GP *gp;
 257
 258         Newxz(gp, 1, GP);
 259
 260         if (GvCVu(gv))
 261             PL_sub_generation++;        /* taking a method out of circulation */
 262         if (GvIOp(gv) && (IoFLAGS(GvIOp(gv)) & IOf_ARGV)) {
 263             gp->gp_io = newIO();
 264             IoFLAGS(gp->gp_io) |= IOf_ARGV|IOf_START;
 265         }
 266         GvGP(gv) = gp_ref(gp);
 267 #ifndef PERL_DONT_CREATE_GVSV
 268         GvSV(gv) = newSV(0);
 269 #endif
 270         GvLINE(gv) = CopLINE(PL_curcop);
 271         /* XXX Ideally this cast would be replaced with a change to const char*
 272            in the struct.  */
 273         GvFILE(gv) = CopFILE(PL_curcop) ? CopFILE(PL_curcop) : (char *) "";
 274         GvEGV(gv) = gv;
 275     }
 276     else {
 277         gp_ref(GvGP(gv));
 278         GvINTRO_on(gv);
 279     }
 280 }
 281
 282 AV *
 283 Perl_save_ary(pTHX_ GV *gv)
 284 {
 285     dVAR;
 286     AV * const oav = GvAVn(gv);
 287     AV *av;
 288
 289     if (!AvREAL(oav) && AvREIFY(oav))
 290         av_reify(oav);
 291     SSCHECK(3);
 292     SSPUSHPTR(gv);
 293     SSPUSHPTR(oav);
 294     SSPUSHINT(SAVEt_AV);
 295
 296     GvAV(gv) = NULL;
 297     av = GvAVn(gv);
 298     if (SvMAGIC(oav))
 299         mg_localize((SV*)oav, (SV*)av);
 300     return av;
 301 }
 302
 303 HV *
 304 Perl_save_hash(pTHX_ GV *gv)
 305 {
 306     dVAR;
 307     HV *ohv, *hv;
 308
 309     SSCHECK(3);
 310     SSPUSHPTR(gv);
 311     SSPUSHPTR(ohv = GvHVn(gv));
 312     SSPUSHINT(SAVEt_HV);
 313
 314     GvHV(gv) = NULL;
 315     hv = GvHVn(gv);
 316     if (SvMAGIC(ohv))
 317         mg_localize((SV*)ohv, (SV*)hv);
 318     return hv;
 319 }
 320
 321 void
 322 Perl_save_item(pTHX_ register SV *item)
 323 {
 324     dVAR;
 325     register SV * const sv = newSVsv(item);
 326
 327     SSCHECK(3);
 328     SSPUSHPTR(item);            /* remember the pointer */
 329     SSPUSHPTR(sv);              /* remember the value */
 330     SSPUSHINT(SAVEt_ITEM);
 331 }
 332
 333 void
 334 Perl_save_int(pTHX_ int *intp)
 335 {
 336     dVAR;
 337     SSCHECK(3);
 338     SSPUSHINT(*intp);
 339     SSPUSHPTR(intp);
 340     SSPUSHINT(SAVEt_INT);
 341 }
 342
 343 void
 344 Perl_save_bool(pTHX_ bool *boolp)
 345 {
 346     dVAR;
 347     SSCHECK(3);
 348     SSPUSHBOOL(*boolp);
 349     SSPUSHPTR(boolp);
 350     SSPUSHINT(SAVEt_BOOL);
 351 }
 352
 353 void
 354 Perl_save_I32(pTHX_ I32 *intp)
 355 {
 356     dVAR;
 357     SSCHECK(3);
 358     SSPUSHINT(*intp);
 359     SSPUSHPTR(intp);
 360     SSPUSHINT(SAVEt_I32);
 361 }
 362
 363 /* Cannot use save_sptr() to store a char* since the SV** cast will
 364  * force word-alignment and we'll miss the pointer.
 365  */
 366 void
 367 Perl_save_pptr(pTHX_ char **pptr)
 368 {
 369     dVAR;
 370     SSCHECK(3);
 371     SSPUSHPTR(*pptr);
 372     SSPUSHPTR(pptr);
 373     SSPUSHINT(SAVEt_PPTR);
 374 }
 375
 376 void
 377 Perl_save_vptr(pTHX_ void *ptr)
 378 {
 379     dVAR;
 380     SSCHECK(3);
 381     SSPUSHPTR(*(char**)ptr);
 382     SSPUSHPTR(ptr);
 383     SSPUSHINT(SAVEt_VPTR);
 384 }
 385
 386 void
 387 Perl_save_sptr(pTHX_ SV **sptr)
 388 {
 389     dVAR;
 390     SSCHECK(3);
 391     SSPUSHPTR(*sptr);
 392     SSPUSHPTR(sptr);
 393     SSPUSHINT(SAVEt_SPTR);
 394 }
 395
 396 void
 397 Perl_save_padsv(pTHX_ PADOFFSET off)
 398 {
 399     dVAR;
 400     SSCHECK(4);
 401     ASSERT_CURPAD_ACTIVE("save_padsv");
 402     SSPUSHPTR(PL_curpad[off]);
 403     SSPUSHPTR(PL_comppad);
 404     SSPUSHLONG((long)off);
 405     SSPUSHINT(SAVEt_PADSV);
 406 }
 407
 408 void
 409 Perl_save_hptr(pTHX_ HV **hptr)
 410 {
 411     dVAR;
 412     SSCHECK(3);
 413     SSPUSHPTR(*hptr);
 414     SSPUSHPTR(hptr);
 415     SSPUSHINT(SAVEt_HPTR);
 416 }
 417
 418 void
 419 Perl_save_aptr(pTHX_ AV **aptr)
 420 {
 421     dVAR;
 422     SSCHECK(3);
 423     SSPUSHPTR(*aptr);
 424     SSPUSHPTR(aptr);
 425     SSPUSHINT(SAVEt_APTR);
 426 }
 427
 428 void
 429 Perl_save_freesv(pTHX_ SV *sv)
 430 {
 431     dVAR;
 432     SSCHECK(2);
 433     SSPUSHPTR(sv);
 434     SSPUSHINT(SAVEt_FREESV);
 435 }
 436
 437 void
 438 Perl_save_mortalizesv(pTHX_ SV *sv)
 439 {
 440     dVAR;
 441     SSCHECK(2);
 442     SSPUSHPTR(sv);
 443     SSPUSHINT(SAVEt_MORTALIZESV);
 444 }
 445
 446 void
 447 Perl_save_freeop(pTHX_ OP *o)
 448 {
 449     dVAR;
 450     SSCHECK(2);
 451     SSPUSHPTR(o);
 452     SSPUSHINT(SAVEt_FREEOP);
 453 }
 454
 455 void
 456 Perl_save_freepv(pTHX_ char *pv)
 457 {
 458     dVAR;
 459     SSCHECK(2);
 460     SSPUSHPTR(pv);
 461     SSPUSHINT(SAVEt_FREEPV);
 462 }
 463
 464 void
 465 Perl_save_clearsv(pTHX_ SV **svp)
 466 {
 467     dVAR;
 468     ASSERT_CURPAD_ACTIVE("save_clearsv");
 469     SSCHECK(2);
 470     SSPUSHLONG((long)(svp-PL_curpad));
 471     SSPUSHINT(SAVEt_CLEARSV);
 472     SvPADSTALE_off(*svp); /* mark lexical as active */
 473 }
 474
 475 void
 476 Perl_save_delete(pTHX_ HV *hv, char *key, I32 klen)
 477 {
 478     dVAR;
 479     SSCHECK(4);
 480     SSPUSHINT(klen);
 481     SSPUSHPTR(key);
 482     SSPUSHPTR(SvREFCNT_inc_simple(hv));
 483     SSPUSHINT(SAVEt_DELETE);
 484 }
 485
 486 void
 487 Perl_save_destructor_x(pTHX_ DESTRUCTORFUNC_t f, void* p)
 488 {
 489     dVAR;
 490     SSCHECK(3);
 491     SSPUSHDXPTR(f);
 492     SSPUSHPTR(p);
 493     SSPUSHINT(SAVEt_DESTRUCTOR_X);
 494 }
 495
 496 void
 497 Perl_save_aelem(pTHX_ AV *av, I32 idx, SV **sptr)
 498 {
 499     dVAR;
 500     SV *sv;
 501     SvGETMAGIC(*sptr);
 502     SSCHECK(4);
 503     SSPUSHPTR(SvREFCNT_inc_simple(av));
 504     SSPUSHINT(idx);
 505     SSPUSHPTR(SvREFCNT_inc(*sptr));
 506     SSPUSHINT(SAVEt_AELEM);
 507     /* if it gets reified later, the restore will have the wrong refcnt */
 508     if (!AvREAL(av) && AvREIFY(av))
 509         SvREFCNT_inc_void(*sptr);
 510     save_scalar_at(sptr);
 511     sv = *sptr;
 512     /* If we're localizing a tied array element, this new sv
 513      * won't actually be stored in the array - so it won't get
 514      * reaped when the localize ends. Ensure it gets reaped by
 515      * mortifying it instead. DAPM */
 516     if (SvTIED_mg(sv, PERL_MAGIC_tiedelem))
 517         sv_2mortal(sv);
 518 }
 519
 520 void
 521 Perl_save_helem(pTHX_ HV *hv, SV *key, SV **sptr)
 522 {
 523     dVAR;
 524     SV *sv;
 525     SvGETMAGIC(*sptr);
 526     SSCHECK(4);
 527     SSPUSHPTR(SvREFCNT_inc_simple(hv));
 528     SSPUSHPTR(SvREFCNT_inc_simple(key));
 529     SSPUSHPTR(SvREFCNT_inc(*sptr));
 530     SSPUSHINT(SAVEt_HELEM);
 531     save_scalar_at(sptr);
 532     sv = *sptr;
 533     /* If we're localizing a tied hash element, this new sv
 534      * won't actually be stored in the hash - so it won't get
 535      * reaped when the localize ends. Ensure it gets reaped by
 536      * mortifying it instead. DAPM */
 537     if (SvTIED_mg(sv, PERL_MAGIC_tiedelem))
 538         sv_2mortal(sv);
 539 }
 540
 541 SV*
 542 Perl_save_svref(pTHX_ SV **sptr)
 543 {
 544     dVAR;
 545     SvGETMAGIC(*sptr);
 546     SSCHECK(3);
 547     SSPUSHPTR(sptr);
 548     SSPUSHPTR(SvREFCNT_inc(*sptr));
 549     SSPUSHINT(SAVEt_SVREF);
 550     return save_scalar_at(sptr);
 551 }
 552
 553 void
 554 Perl_save_op(pTHX)
 555 {
 556     dVAR;
 557     SSCHECK(2);
 558     SSPUSHPTR(PL_op);
 559     SSPUSHINT(SAVEt_OP);
 560 }
 561
 562 I32
 563 Perl_save_alloc(pTHX_ I32 size, I32 pad)
 564 {
 565     dVAR;
 566     register const I32 start = pad + ((char*)&PL_savestack[PL_savestack_ix]
 567                                 - (char*)PL_savestack);
 568     register const I32 elems = 1 + ((size + pad - 1) / sizeof(*PL_savestack));
 569
 570     /* SSCHECK may not be good enough */
 571     while (PL_savestack_ix + elems + 2 > PL_savestack_max)
 572         savestack_grow();
 573
 574     PL_savestack_ix += elems;
 575     SSPUSHINT(elems);
 576     SSPUSHINT(SAVEt_ALLOC);
 577     return start;
 578 }
 579
 580 void
 581 Perl_leave_scope(pTHX_ I32 base)
 582 {
 583     dVAR;
 584     register SV *sv;
 585     register SV *value;
 586     register GV *gv;
 587     register AV *av;
 588     register HV *hv;
 589     void* ptr;
 590     register char* str;
 591     I32 i;
 592
 593     if (base < -1)
 594         Perl_croak(aTHX_ "panic: corrupt saved stack index");
 595     while (PL_savestack_ix > base) {
 596         switch (SSPOPINT) {
 597         case SAVEt_ITEM:                        /* normal string */
 598             value = (SV*)SSPOPPTR;
 599             sv = (SV*)SSPOPPTR;
 600             sv_replace(sv,value);
 601             PL_localizing = 2;
 602             SvSETMAGIC(sv);
 603             PL_localizing = 0;
 604             break;
 605         case SAVEt_SV:                          /* scalar reference */
 606             value = (SV*)SSPOPPTR;
 607             gv = (GV*)SSPOPPTR;
 608             ptr = &GvSV(gv);
 609             av = (AV*)gv; /* what to refcnt_dec */
 610         restore_sv:
 611             sv = *(SV**)ptr;
 612             DEBUG_S(PerlIO_printf(Perl_debug_log,
 613                                   "restore svref: %p %p:%s -> %p:%s\n",
 614                                   ptr, sv, SvPEEK(sv), value, SvPEEK(value)));
 615             *(SV**)ptr = value;
 616             SvREFCNT_dec(sv);
 617             PL_localizing = 2;
 618             SvSETMAGIC(value);
 619             PL_localizing = 0;
 620             SvREFCNT_dec(value);
 621             if (av) /* actually an av, hv or gv */
 622                 SvREFCNT_dec(av);
 623             break;
 624         case SAVEt_GENERIC_PVREF:               /* generic pv */
 625             str = (char*)SSPOPPTR;
 626             ptr = SSPOPPTR;
 627             if (*(char**)ptr != str) {
 628                 Safefree(*(char**)ptr);
 629                 *(char**)ptr = str;
 630             }
 631             break;
 632         case SAVEt_SHARED_PVREF:                /* shared pv */
 633             str = (char*)SSPOPPTR;
 634             ptr = SSPOPPTR;
 635             if (*(char**)ptr != str) {
 636 #ifdef NETWARE
 637                 PerlMem_free(*(char**)ptr);
 638 #else
 639                 PerlMemShared_free(*(char**)ptr);
 640 #endif
 641                 *(char**)ptr = str;
 642             }
 643             break;
 644         case SAVEt_GENERIC_SVREF:               /* generic sv */
 645             value = (SV*)SSPOPPTR;
 646             ptr = SSPOPPTR;
 647             sv = *(SV**)ptr;
 648             *(SV**)ptr = value;
 649             SvREFCNT_dec(sv);
 650             SvREFCNT_dec(value);
 651             break;
 652         case SAVEt_AV:                          /* array reference */
 653             av = (AV*)SSPOPPTR;
 654             gv = (GV*)SSPOPPTR;
 655             if (GvAV(gv)) {
 656                 AV * const goner = GvAV(gv);
 657                 /* FIXME - this is a temporary hack until we work out what
 658                    the correct behaviour for magic should be.  */
 659                 sv_unmagic((SV*)goner, PERL_MAGIC_arylen_p);
 660                 SvMAGIC_set(av, SvMAGIC(goner));
 661                 SvFLAGS((SV*)av) |= SvMAGICAL(goner);
 662                 SvMAGICAL_off(goner);
 663                 SvMAGIC_set(goner, NULL);
 664                 SvREFCNT_dec(goner);
 665             }
 666             GvAV(gv) = av;
 667             if (SvMAGICAL(av)) {
 668                 PL_localizing = 2;
 669                 SvSETMAGIC((SV*)av);
 670                 PL_localizing = 0;
 671             }
 672             break;
 673         case SAVEt_HV:                          /* hash reference */
 674             hv = (HV*)SSPOPPTR;
 675             gv = (GV*)SSPOPPTR;
 676             if (GvHV(gv)) {
 677                 HV * const goner = GvHV(gv);
 678                 SvMAGIC_set(hv, SvMAGIC(goner));
 679                 SvFLAGS(hv) |= SvMAGICAL(goner);
 680                 SvMAGICAL_off(goner);
 681                 SvMAGIC_set(goner, NULL);
 682                 SvREFCNT_dec(goner);
 683             }
 684             GvHV(gv) = hv;
 685             if (SvMAGICAL(hv)) {
 686                 PL_localizing = 2;
 687                 SvSETMAGIC((SV*)hv);
 688                 PL_localizing = 0;
 689             }
 690             break;
 691         case SAVEt_INT:                         /* int reference */
 692             ptr = SSPOPPTR;
 693             *(int*)ptr = (int)SSPOPINT;
 694             break;
 695         case SAVEt_BOOL:                        /* bool reference */
 696             ptr = SSPOPPTR;
 697             *(bool*)ptr = (bool)SSPOPBOOL;
 698             break;
 699         case SAVEt_I32:                         /* I32 reference */
 700             ptr = SSPOPPTR;
 701             *(I32*)ptr = (I32)SSPOPINT;
 702             break;
 703         case SAVEt_SPTR:                        /* SV* reference */
 704             ptr = SSPOPPTR;
 705             *(SV**)ptr = (SV*)SSPOPPTR;
 706             break;
 707         case SAVEt_VPTR:                        /* random* reference */
 708         case SAVEt_PPTR:                        /* char* reference */
 709             ptr = SSPOPPTR;
 710             *(char**)ptr = (char*)SSPOPPTR;
 711             break;
 712         case SAVEt_HPTR:                        /* HV* reference */
 713             ptr = SSPOPPTR;
 714             *(HV**)ptr = (HV*)SSPOPPTR;
 715             break;
 716         case SAVEt_APTR:                        /* AV* reference */
 717             ptr = SSPOPPTR;
 718             *(AV**)ptr = (AV*)SSPOPPTR;
 719             break;
 720         case SAVEt_GP:                          /* scalar reference */
 721             ptr = SSPOPPTR;
 722             gv = (GV*)SSPOPPTR;
 723             gp_free(gv);
 724             GvGP(gv) = (GP*)ptr;
 725             if (GvCVu(gv))
 726                 PL_sub_generation++;  /* putting a method back into circulation */
 727             SvREFCNT_dec(gv);
 728             break;
 729         case SAVEt_FREESV:
 730             ptr = SSPOPPTR;
 731             SvREFCNT_dec((SV*)ptr);
 732             break;
 733         case SAVEt_MORTALIZESV:
 734             ptr = SSPOPPTR;
 735             sv_2mortal((SV*)ptr);
 736             break;
 737         case SAVEt_FREEOP:
 738             ptr = SSPOPPTR;
 739             ASSERT_CURPAD_LEGAL("SAVEt_FREEOP"); /* XXX DAPM tmp */
 740             op_free((OP*)ptr);
 741             break;
 742         case SAVEt_FREEPV:
 743             ptr = SSPOPPTR;
 744             Safefree(ptr);
 745             break;
 746         case SAVEt_CLEARSV:
 747             ptr = (void*)&PL_curpad[SSPOPLONG];
 748             sv = *(SV**)ptr;
 749
 750             DEBUG_Xv(PerlIO_printf(Perl_debug_log,
 751              "Pad 0x%"UVxf"[0x%"UVxf"] clearsv: %ld sv=0x%"UVxf"<%"IVdf"> %s\n",
 752                 PTR2UV(PL_comppad), PTR2UV(PL_curpad),
 753                 (long)((SV **)ptr-PL_curpad), PTR2UV(sv), (IV)SvREFCNT(sv),
 754                 (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) ? "clear" : "abandon"
 755             ));
 756
 757             /* Can clear pad variable in place? */
 758             if (SvREFCNT(sv) <= 1 && !SvOBJECT(sv)) {
 759                 /*
 760                  * if a my variable that was made readonly is going out of
 761                  * scope, we want to remove the readonlyness so that it can
 762                  * go out of scope quietly
 763                  */
 764                 if (SvPADMY(sv) && !SvFAKE(sv))
 765                     SvREADONLY_off(sv);
 766
 767                 if (SvTHINKFIRST(sv))
 768                     sv_force_normal_flags(sv, SV_IMMEDIATE_UNREF);
 769                 if (SvMAGICAL(sv))
 770                     mg_free(sv);
 771
 772                 switch (SvTYPE(sv)) {
 773                 case SVt_NULL:
 774                     break;
 775                 case SVt_PVAV:
 776                     av_clear((AV*)sv);
 777                     break;
 778                 case SVt_PVHV:
 779                     hv_clear((HV*)sv);
 780                     break;
 781                 case SVt_PVCV:
 782                     Perl_croak(aTHX_ "panic: leave_scope pad code");
 783                 default:
 784                     SvOK_off(sv);
 785                     break;
 786                 }
 787                 SvPADSTALE_on(sv); /* mark as no longer live */
 788             }
 789             else {      /* Someone has a claim on this, so abandon it. */
 790                 const U32 padflags = SvFLAGS(sv) & (SVs_PADMY|SVs_PADTMP);
 791                 switch (SvTYPE(sv)) {   /* Console ourselves with a new value */
 792                 case SVt_PVAV:  *(SV**)ptr = (SV*)newAV();      break;
 793                 case SVt_PVHV:  *(SV**)ptr = (SV*)newHV();      break;
 794                 default:        *(SV**)ptr = newSV(0);          break;
 795                 }
 796                 SvREFCNT_dec(sv);       /* Cast current value to the winds. */
 797                 /* preserve pad nature, but also mark as not live
 798                  * for any closure capturing */
 799                 SvFLAGS(*(SV**)ptr) |= padflags | SVs_PADSTALE;
 800             }
 801             break;
 802         case SAVEt_DELETE:
 803             ptr = SSPOPPTR;
 804             hv = (HV*)ptr;
 805             ptr = SSPOPPTR;
 806             (void)hv_delete(hv, (char*)ptr, (U32)SSPOPINT, G_DISCARD);
 807             SvREFCNT_dec(hv);
 808             Safefree(ptr);
 809             break;
 810         case SAVEt_DESTRUCTOR_X:
 811             ptr = SSPOPPTR;
 812             (*SSPOPDXPTR)(aTHX_ ptr);
 813             break;
 814         case SAVEt_REGCONTEXT:
 815         case SAVEt_ALLOC:
 816             i = SSPOPINT;
 817             PL_savestack_ix -= i;       /* regexp must have croaked */
 818             break;
 819         case SAVEt_STACK_POS:           /* Position on Perl stack */
 820             i = SSPOPINT;
 821             PL_stack_sp = PL_stack_base + i;
 822             break;
 823         case SAVEt_AELEM:               /* array element */
 824             value = (SV*)SSPOPPTR;
 825             i = SSPOPINT;
 826             av = (AV*)SSPOPPTR;
 827             if (!AvREAL(av) && AvREIFY(av)) /* undo reify guard */
 828                 SvREFCNT_dec(value);
 829             ptr = av_fetch(av,i,1);
 830             if (ptr) {
 831                 sv = *(SV**)ptr;
 832                 if (sv && sv != &PL_sv_undef) {
 833                     if (SvTIED_mg((SV*)av, PERL_MAGIC_tied))
 834                         SvREFCNT_inc_void_NN(sv);
 835                     goto restore_sv;
 836                 }
 837             }
 838             SvREFCNT_dec(av);
 839             SvREFCNT_dec(value);
 840             break;
 841         case SAVEt_HELEM:               /* hash element */
 842             value = (SV*)SSPOPPTR;
 843             sv = (SV*)SSPOPPTR;
 844             hv = (HV*)SSPOPPTR;
 845             ptr = hv_fetch_ent(hv, sv, 1, 0);
 846             if (ptr) {
 847                 const SV * const oval = HeVAL((HE*)ptr);
 848                 if (oval && oval != &PL_sv_undef) {
 849                     ptr = &HeVAL((HE*)ptr);
 850                     if (SvTIED_mg((SV*)hv, PERL_MAGIC_tied))
 851                         SvREFCNT_inc_void(*(SV**)ptr);
 852                     SvREFCNT_dec(sv);
 853                     av = (AV*)hv; /* what to refcnt_dec */
 854                     goto restore_sv;
 855                 }
 856             }
 857             SvREFCNT_dec(hv);
 858             SvREFCNT_dec(sv);
 859             SvREFCNT_dec(value);
 860             break;
 861         case SAVEt_OP:
 862             PL_op = (OP*)SSPOPPTR;
 863             break;
 864         case SAVEt_HINTS:
 865             if ((PL_hints & HINT_LOCALIZE_HH) && GvHV(PL_hintgv)) {
 866                 SvREFCNT_dec((SV*)GvHV(PL_hintgv));
 867                 GvHV(PL_hintgv) = NULL;
 868             }
 869             *(I32*)&PL_hints = (I32)SSPOPINT;
 870             if (PL_hints & HINT_LOCALIZE_HH) {
 871                 SvREFCNT_dec((SV*)GvHV(PL_hintgv));
 872                 GvHV(PL_hintgv) = (HV*)SSPOPPTR;
 873             }
 874
 875             break;
 876         case SAVEt_COMPPAD:
 877             PL_comppad = (PAD*)SSPOPPTR;
 878             if (PL_comppad)
 879                 PL_curpad = AvARRAY(PL_comppad);
 880             else
 881                 PL_curpad = NULL;
 882             break;
 883         case SAVEt_PADSV:
 884             {
 885                 const PADOFFSET off = (PADOFFSET)SSPOPLONG;
 886                 ptr = SSPOPPTR;
 887                 if (ptr)
 888                     AvARRAY((PAD*)ptr)[off] = (SV*)SSPOPPTR;
 889             }
 890             break;
 891         case SAVEt_SAVESWITCHSTACK:
 892             {
 893                 dSP;
 894                 AV* const t = (AV*)SSPOPPTR;
 895                 AV* const f = (AV*)SSPOPPTR;
 896                 SWITCHSTACK(t,f);
 897                 PL_curstackinfo->si_stack = f;
 898             }
 899             break;
 900         case SAVEt_SET_SVFLAGS:
 901             {
 902                 const U32 val  = (U32)SSPOPINT;
 903                 const U32 mask = (U32)SSPOPINT;
 904                 sv = (SV*)SSPOPPTR;
 905                 SvFLAGS(sv) &= ~mask;
 906                 SvFLAGS(sv) |= val;
 907             }
 908             break;
 909             /* These are only saved in mathoms.c */
 910         case SAVEt_SVREF:                       /* scalar reference */
 911             value = (SV*)SSPOPPTR;
 912             ptr = SSPOPPTR;
 913             av = NULL; /* what to refcnt_dec */
 914             goto restore_sv;
 915         case SAVEt_LONG:                        /* long reference */
 916             ptr = SSPOPPTR;
 917             *(long*)ptr = (long)SSPOPLONG;
 918             break;
 919         case SAVEt_I16:                         /* I16 reference */
 920             ptr = SSPOPPTR;
 921             *(I16*)ptr = (I16)SSPOPINT;
 922             break;
 923         case SAVEt_I8:                          /* I8 reference */
 924             ptr = SSPOPPTR;
 925             *(I8*)ptr = (I8)SSPOPINT;
 926             break;
 927         case SAVEt_IV:                          /* IV reference */
 928             ptr = SSPOPPTR;
 929             *(IV*)ptr = (IV)SSPOPIV;
 930             break;
 931         case SAVEt_NSTAB:
 932             gv = (GV*)SSPOPPTR;
 933             (void)sv_clear((SV*)gv);
 934             break;
 935         case SAVEt_DESTRUCTOR:
 936             ptr = SSPOPPTR;
 937             (*SSPOPDPTR)(ptr);
 938             break;
 939         default:
 940             Perl_croak(aTHX_ "panic: leave_scope inconsistency");
 941         }
 942     }
 943 }
 944
 945 void
 946 Perl_cx_dump(pTHX_ PERL_CONTEXT *cx)
 947 {
 948     dVAR;
 949 #ifdef DEBUGGING
 950     PerlIO_printf(Perl_debug_log, "CX %ld = %s\n", (long)(cx - cxstack), PL_block_type[CxTYPE(cx)]);
 951     if (CxTYPE(cx) != CXt_SUBST) {
 952         PerlIO_printf(Perl_debug_log, "BLK_OLDSP = %ld\n", (long)cx->blk_oldsp);
 953         PerlIO_printf(Perl_debug_log, "BLK_OLDCOP = 0x%"UVxf"\n",
 954                       PTR2UV(cx->blk_oldcop));
 955         PerlIO_printf(Perl_debug_log, "BLK_OLDMARKSP = %ld\n", (long)cx->blk_oldmarksp);
 956         PerlIO_printf(Perl_debug_log, "BLK_OLDSCOPESP = %ld\n", (long)cx->blk_oldscopesp);
 957         PerlIO_printf(Perl_debug_log, "BLK_OLDPM = 0x%"UVxf"\n",
 958                       PTR2UV(cx->blk_oldpm));
 959         PerlIO_printf(Perl_debug_log, "BLK_GIMME = %s\n", cx->blk_gimme ? "LIST" : "SCALAR");
 960     }
 961     switch (CxTYPE(cx)) {
 962     case CXt_NULL:
 963     case CXt_BLOCK:
 964         break;
 965     case CXt_FORMAT:
 966         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
 967                 PTR2UV(cx->blk_sub.cv));
 968         PerlIO_printf(Perl_debug_log, "BLK_SUB.GV = 0x%"UVxf"\n",
 969                 PTR2UV(cx->blk_sub.gv));
 970         PerlIO_printf(Perl_debug_log, "BLK_SUB.DFOUTGV = 0x%"UVxf"\n",
 971                 PTR2UV(cx->blk_sub.dfoutgv));
 972         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
 973                 (int)cx->blk_sub.hasargs);
 974         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
 975                 PTR2UV(cx->blk_sub.retop));
 976         break;
 977     case CXt_SUB:
 978         PerlIO_printf(Perl_debug_log, "BLK_SUB.CV = 0x%"UVxf"\n",
 979                 PTR2UV(cx->blk_sub.cv));
 980         PerlIO_printf(Perl_debug_log, "BLK_SUB.OLDDEPTH = %ld\n",
 981                 (long)cx->blk_sub.olddepth);
 982         PerlIO_printf(Perl_debug_log, "BLK_SUB.HASARGS = %d\n",
 983                 (int)cx->blk_sub.hasargs);
 984         PerlIO_printf(Perl_debug_log, "BLK_SUB.LVAL = %d\n",
 985                 (int)cx->blk_sub.lval);
 986         PerlIO_printf(Perl_debug_log, "BLK_SUB.RETOP = 0x%"UVxf"\n",
 987                 PTR2UV(cx->blk_sub.retop));
 988         break;
 989     case CXt_EVAL:
 990         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_IN_EVAL = %ld\n",
 991                 (long)cx->blk_eval.old_in_eval);
 992         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_OP_TYPE = %s (%s)\n",
 993                 PL_op_name[cx->blk_eval.old_op_type],
 994                 PL_op_desc[cx->blk_eval.old_op_type]);
 995         if (cx->blk_eval.old_namesv)
 996             PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_NAME = %s\n",
 997                           SvPVX_const(cx->blk_eval.old_namesv));
 998         PerlIO_printf(Perl_debug_log, "BLK_EVAL.OLD_EVAL_ROOT = 0x%"UVxf"\n",
 999                 PTR2UV(cx->blk_eval.old_eval_root));
1000         PerlIO_printf(Perl_debug_log, "BLK_EVAL.RETOP = 0x%"UVxf"\n",
1001                 PTR2UV(cx->blk_eval.retop));
1002         break;
1003
1004     case CXt_LOOP:
1005         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LABEL = %s\n",
1006                 cx->blk_loop.label);
1007         PerlIO_printf(Perl_debug_log, "BLK_LOOP.RESETSP = %ld\n",
1008                 (long)cx->blk_loop.resetsp);
1009         PerlIO_printf(Perl_debug_log, "BLK_LOOP.REDO_OP = 0x%"UVxf"\n",
1010                 PTR2UV(cx->blk_loop.redo_op));
1011         PerlIO_printf(Perl_debug_log, "BLK_LOOP.NEXT_OP = 0x%"UVxf"\n",
1012                 PTR2UV(cx->blk_loop.next_op));
1013         PerlIO_printf(Perl_debug_log, "BLK_LOOP.LAST_OP = 0x%"UVxf"\n",
1014                 PTR2UV(cx->blk_loop.last_op));
1015         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERIX = %ld\n",
1016                 (long)cx->blk_loop.iterix);
1017         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERARY = 0x%"UVxf"\n",
1018                 PTR2UV(cx->blk_loop.iterary));
1019         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERVAR = 0x%"UVxf"\n",
1020                 PTR2UV(CxITERVAR(cx)));
1021         if (CxITERVAR(cx))
1022             PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERSAVE = 0x%"UVxf"\n",
1023                 PTR2UV(cx->blk_loop.itersave));
1024         PerlIO_printf(Perl_debug_log, "BLK_LOOP.ITERLVAL = 0x%"UVxf"\n",
1025                 PTR2UV(cx->blk_loop.iterlval));
1026         break;
1027
1028     case CXt_SUBST:
1029         PerlIO_printf(Perl_debug_log, "SB_ITERS = %ld\n",
1030                 (long)cx->sb_iters);
1031         PerlIO_printf(Perl_debug_log, "SB_MAXITERS = %ld\n",
1032                 (long)cx->sb_maxiters);
1033         PerlIO_printf(Perl_debug_log, "SB_RFLAGS = %ld\n",
1034                 (long)cx->sb_rflags);
1035         PerlIO_printf(Perl_debug_log, "SB_ONCE = %ld\n",
1036                 (long)cx->sb_once);
1037         PerlIO_printf(Perl_debug_log, "SB_ORIG = %s\n",
1038                 cx->sb_orig);
1039         PerlIO_printf(Perl_debug_log, "SB_DSTR = 0x%"UVxf"\n",
1040                 PTR2UV(cx->sb_dstr));
1041         PerlIO_printf(Perl_debug_log, "SB_TARG = 0x%"UVxf"\n",
1042                 PTR2UV(cx->sb_targ));
1043         PerlIO_printf(Perl_debug_log, "SB_S = 0x%"UVxf"\n",
1044                 PTR2UV(cx->sb_s));
1045         PerlIO_printf(Perl_debug_log, "SB_M = 0x%"UVxf"\n",
1046                 PTR2UV(cx->sb_m));
1047         PerlIO_printf(Perl_debug_log, "SB_STREND = 0x%"UVxf"\n",
1048                 PTR2UV(cx->sb_strend));
1049         PerlIO_printf(Perl_debug_log, "SB_RXRES = 0x%"UVxf"\n",
1050                 PTR2UV(cx->sb_rxres));
1051         break;
1052     }
1053 #else
1054     PERL_UNUSED_CONTEXT;
1055     PERL_UNUSED_ARG(cx);
1056 #endif  /* DEBUGGING */
1057 }
1058
1059 /*
1060  * Local variables:
1061  * c-indentation-style: bsd
1062  * c-basic-offset: 4
1063  * indent-tabs-mode: t
1064  * End:
1065  *
1066  * ex: set ts=8 sts=4 sw=4 noet:
1067  */