scope.c

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