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