scope.c

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