scope.c

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