scope.c

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