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