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