scope.c

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