pp_ctl.c

   1 /*    pp_ctl.c
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
   4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 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  *      Now far ahead the Road has gone,
  13  *          And I must follow, if I can,
  14  *      Pursuing it with eager feet,
  15  *          Until it joins some larger way
  16  *      Where many paths and errands meet.
  17  *          And whither then?  I cannot say.
  18  *
  19  *     [Bilbo on p.35 of _The Lord of the Rings_, I/i: "A Long-Expected Party"]
  20  */
  21
  22 /* This file contains control-oriented pp ("push/pop") functions that
  23  * execute the opcodes that make up a perl program. A typical pp function
  24  * expects to find its arguments on the stack, and usually pushes its
  25  * results onto the stack, hence the 'pp' terminology. Each OP structure
  26  * contains a pointer to the relevant pp_foo() function.
  27  *
  28  * Control-oriented means things like pp_enteriter() and pp_next(), which
  29  * alter the flow of control of the program.
  30  */
  31
  32
  33 #include "EXTERN.h"
  34 #define PERL_IN_PP_CTL_C
  35 #include "perl.h"
  36
  37 #define DOCATCH(o) ((CATCH_GET == TRUE) ? docatch(o) : (o))
  38
  39 #define dopoptosub(plop)        dopoptosub_at(cxstack, (plop))
  40
  41 PP(pp_wantarray)
  42 {
  43     dSP;
  44     I32 cxix;
  45     const PERL_CONTEXT *cx;
  46     EXTEND(SP, 1);
  47
  48     if (PL_op->op_private & OPpOFFBYONE) {
  49         if (!(cx = caller_cx(1,NULL))) RETPUSHUNDEF;
  50     }
  51     else {
  52       cxix = dopoptosub(cxstack_ix);
  53       if (cxix < 0)
  54         RETPUSHUNDEF;
  55       cx = &cxstack[cxix];
  56     }
  57
  58     switch (cx->blk_gimme) {
  59     case G_ARRAY:
  60         RETPUSHYES;
  61     case G_SCALAR:
  62         RETPUSHNO;
  63     default:
  64         RETPUSHUNDEF;
  65     }
  66 }
  67
  68 PP(pp_regcreset)
  69 {
  70     TAINT_NOT;
  71     return NORMAL;
  72 }
  73
  74 PP(pp_regcomp)
  75 {
  76     dSP;
  77     PMOP *pm = (PMOP*)cLOGOP->op_other;
  78     SV **args;
  79     int nargs;
  80     REGEXP *re = NULL;
  81     REGEXP *new_re;
  82     const regexp_engine *eng;
  83     bool is_bare_re= FALSE;
  84
  85     if (PL_op->op_flags & OPf_STACKED) {
  86         dMARK;
  87         nargs = SP - MARK;
  88         args  = ++MARK;
  89     }
  90     else {
  91         nargs = 1;
  92         args  = SP;
  93     }
  94
  95     /* prevent recompiling under /o and ithreads. */
  96 #if defined(USE_ITHREADS)
  97     if (pm->op_pmflags & PMf_KEEP && PM_GETRE(pm)) {
  98         SP = args-1;
  99         RETURN;
 100     }
 101 #endif
 102
 103     re = PM_GETRE(pm);
 104     assert (re != (REGEXP*) &PL_sv_undef);
 105     eng = re ? RX_ENGINE(re) : current_re_engine();
 106
 107     /*
 108      In the below logic: these are basically the same - check if this regcomp is part of a split.
 109
 110     (PL_op->op_pmflags & PMf_split )
 111     (PL_op->op_next->op_type == OP_PUSHRE)
 112
 113     We could add a new mask for this and copy the PMf_split, if we did
 114     some bit definition fiddling first.
 115
 116     For now we leave this
 117     */
 118
 119     new_re = (eng->op_comp
 120                     ? eng->op_comp
 121                     : &Perl_re_op_compile
 122             )(aTHX_ args, nargs, pm->op_code_list, eng, re,
 123                 &is_bare_re,
 124                 (pm->op_pmflags & RXf_PMf_FLAGCOPYMASK),
 125                 pm->op_pmflags |
 126                     (PL_op->op_flags & OPf_SPECIAL ? PMf_USE_RE_EVAL : 0));
 127
 128     if (pm->op_pmflags & PMf_HAS_CV)
 129         ReANY(new_re)->qr_anoncv
 130                         = (CV*) SvREFCNT_inc(PAD_SV(PL_op->op_targ));
 131
 132     if (is_bare_re) {
 133         REGEXP *tmp;
 134         /* The match's LHS's get-magic might need to access this op's regexp
 135            (e.g. $' =~ /$re/ while foo; see bug 70764).  So we must call
 136            get-magic now before we replace the regexp. Hopefully this hack can
 137            be replaced with the approach described at
 138            http://www.nntp.perl.org/group/perl.perl5.porters/2007/03/msg122415.html
 139            some day. */
 140         if (pm->op_type == OP_MATCH) {
 141             SV *lhs;
 142             const bool was_tainted = TAINT_get;
 143             if (pm->op_flags & OPf_STACKED)
 144                 lhs = args[-1];
 145             else if (pm->op_targ)
 146                 lhs = PAD_SV(pm->op_targ);
 147             else lhs = DEFSV;
 148             SvGETMAGIC(lhs);
 149             /* Restore the previous value of PL_tainted (which may have been
 150                modified by get-magic), to avoid incorrectly setting the
 151                RXf_TAINTED flag with RX_TAINT_on further down. */
 152             TAINT_set(was_tainted);
 153 #ifdef NO_TAINT_SUPPORT
 154             PERL_UNUSED_VAR(was_tainted);
 155 #endif
 156         }
 157         tmp = reg_temp_copy(NULL, new_re);
 158         ReREFCNT_dec(new_re);
 159         new_re = tmp;
 160     }
 161
 162     if (re != new_re) {
 163         ReREFCNT_dec(re);
 164         PM_SETRE(pm, new_re);
 165     }
 166
 167
 168     assert(TAINTING_get || !TAINT_get);
 169     if (TAINT_get) {
 170         SvTAINTED_on((SV*)new_re);
 171         RX_TAINT_on(new_re);
 172     }
 173
 174 #if !defined(USE_ITHREADS)
 175     /* can't change the optree at runtime either */
 176     /* PMf_KEEP is handled differently under threads to avoid these problems */
 177     if (!RX_PRELEN(PM_GETRE(pm)) && PL_curpm)
 178         pm = PL_curpm;
 179     if (pm->op_pmflags & PMf_KEEP) {
 180         pm->op_private &= ~OPpRUNTIME;  /* no point compiling again */
 181         cLOGOP->op_first->op_next = PL_op->op_next;
 182     }
 183 #endif
 184
 185     SP = args-1;
 186     RETURN;
 187 }
 188
 189
 190 PP(pp_substcont)
 191 {
 192     dSP;
 193     PERL_CONTEXT *cx = CX_CUR();
 194     PMOP * const pm = (PMOP*) cLOGOP->op_other;
 195     SV * const dstr = cx->sb_dstr;
 196     char *s = cx->sb_s;
 197     char *m = cx->sb_m;
 198     char *orig = cx->sb_orig;
 199     REGEXP * const rx = cx->sb_rx;
 200     SV *nsv = NULL;
 201     REGEXP *old = PM_GETRE(pm);
 202
 203     PERL_ASYNC_CHECK();
 204
 205     if(old != rx) {
 206         if(old)
 207             ReREFCNT_dec(old);
 208         PM_SETRE(pm,ReREFCNT_inc(rx));
 209     }
 210
 211     rxres_restore(&cx->sb_rxres, rx);
 212
 213     if (cx->sb_iters++) {
 214         const SSize_t saviters = cx->sb_iters;
 215         if (cx->sb_iters > cx->sb_maxiters)
 216             DIE(aTHX_ "Substitution loop");
 217
 218         SvGETMAGIC(TOPs); /* possibly clear taint on $1 etc: #67962 */
 219
 220         /* See "how taint works" above pp_subst() */
 221         if (SvTAINTED(TOPs))
 222             cx->sb_rxtainted |= SUBST_TAINT_REPL;
 223         sv_catsv_nomg(dstr, POPs);
 224         if (CxONCE(cx) || s < orig ||
 225                 !CALLREGEXEC(rx, s, cx->sb_strend, orig,
 226                              (s == m), cx->sb_targ, NULL,
 227                     (REXEC_IGNOREPOS|REXEC_NOT_FIRST|REXEC_FAIL_ON_UNDERFLOW)))
 228         {
 229             SV *targ = cx->sb_targ;
 230
 231             assert(cx->sb_strend >= s);
 232             if(cx->sb_strend > s) {
 233                  if (DO_UTF8(dstr) && !SvUTF8(targ))
 234                       sv_catpvn_nomg_utf8_upgrade(dstr, s, cx->sb_strend - s, nsv);
 235                  else
 236                       sv_catpvn_nomg(dstr, s, cx->sb_strend - s);
 237             }
 238             if (RX_MATCH_TAINTED(rx)) /* run time pattern taint, eg locale */
 239                 cx->sb_rxtainted |= SUBST_TAINT_PAT;
 240
 241             if (pm->op_pmflags & PMf_NONDESTRUCT) {
 242                 PUSHs(dstr);
 243                 /* From here on down we're using the copy, and leaving the
 244                    original untouched.  */
 245                 targ = dstr;
 246             }
 247             else {
 248                 SV_CHECK_THINKFIRST_COW_DROP(targ);
 249                 if (isGV(targ)) Perl_croak_no_modify();
 250                 SvPV_free(targ);
 251                 SvPV_set(targ, SvPVX(dstr));
 252                 SvCUR_set(targ, SvCUR(dstr));
 253                 SvLEN_set(targ, SvLEN(dstr));
 254                 if (DO_UTF8(dstr))
 255                     SvUTF8_on(targ);
 256                 SvPV_set(dstr, NULL);
 257
 258                 PL_tainted = 0;
 259                 mPUSHi(saviters - 1);
 260
 261                 (void)SvPOK_only_UTF8(targ);
 262             }
 263
 264             /* update the taint state of various various variables in
 265              * preparation for final exit.
 266              * See "how taint works" above pp_subst() */
 267             if (TAINTING_get) {
 268                 if ((cx->sb_rxtainted & SUBST_TAINT_PAT) ||
 269                     ((cx->sb_rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_RETAINT))
 270                                     == (SUBST_TAINT_STR|SUBST_TAINT_RETAINT))
 271                 )
 272                     (RX_MATCH_TAINTED_on(rx)); /* taint $1 et al */
 273
 274                 if (!(cx->sb_rxtainted & SUBST_TAINT_BOOLRET)
 275                     && (cx->sb_rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_PAT))
 276                 )
 277                     SvTAINTED_on(TOPs);  /* taint return value */
 278                 /* needed for mg_set below */
 279                 TAINT_set(
 280                     cBOOL(cx->sb_rxtainted &
 281                           (SUBST_TAINT_STR|SUBST_TAINT_PAT|SUBST_TAINT_REPL))
 282                 );
 283                 SvTAINT(TARG);
 284             }
 285             /* PL_tainted must be correctly set for this mg_set */
 286             SvSETMAGIC(TARG);
 287             TAINT_NOT;
 288
 289             CX_LEAVE_SCOPE(cx);
 290             CX_POPSUBST(cx);
 291             CX_POP(cx);
 292
 293             PERL_ASYNC_CHECK();
 294             RETURNOP(pm->op_next);
 295             NOT_REACHED; /* NOTREACHED */
 296         }
 297         cx->sb_iters = saviters;
 298     }
 299     if (RX_MATCH_COPIED(rx) && RX_SUBBEG(rx) != orig) {
 300         m = s;
 301         s = orig;
 302         assert(!RX_SUBOFFSET(rx));
 303         cx->sb_orig = orig = RX_SUBBEG(rx);
 304         s = orig + (m - s);
 305         cx->sb_strend = s + (cx->sb_strend - m);
 306     }
 307     cx->sb_m = m = RX_OFFS(rx)[0].start + orig;
 308     if (m > s) {
 309         if (DO_UTF8(dstr) && !SvUTF8(cx->sb_targ))
 310             sv_catpvn_nomg_utf8_upgrade(dstr, s, m - s, nsv);
 311         else
 312             sv_catpvn_nomg(dstr, s, m-s);
 313     }
 314     cx->sb_s = RX_OFFS(rx)[0].end + orig;
 315     { /* Update the pos() information. */
 316         SV * const sv
 317             = (pm->op_pmflags & PMf_NONDESTRUCT) ? cx->sb_dstr : cx->sb_targ;
 318         MAGIC *mg;
 319
 320         /* the string being matched against may no longer be a string,
 321          * e.g. $_=0; s/.../$_++/ge */
 322
 323         if (!SvPOK(sv))
 324             SvPV_force_nomg_nolen(sv);
 325
 326         if (!(mg = mg_find_mglob(sv))) {
 327             mg = sv_magicext_mglob(sv);
 328         }
 329         MgBYTEPOS_set(mg, sv, SvPVX(sv), m - orig);
 330     }
 331     if (old != rx)
 332         (void)ReREFCNT_inc(rx);
 333     /* update the taint state of various various variables in preparation
 334      * for calling the code block.
 335      * See "how taint works" above pp_subst() */
 336     if (TAINTING_get) {
 337         if (RX_MATCH_TAINTED(rx)) /* run time pattern taint, eg locale */
 338             cx->sb_rxtainted |= SUBST_TAINT_PAT;
 339
 340         if ((cx->sb_rxtainted & SUBST_TAINT_PAT) ||
 341             ((cx->sb_rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_RETAINT))
 342                             == (SUBST_TAINT_STR|SUBST_TAINT_RETAINT))
 343         )
 344             (RX_MATCH_TAINTED_on(rx)); /* taint $1 et al */
 345
 346         if (cx->sb_iters > 1 && (cx->sb_rxtainted &
 347                         (SUBST_TAINT_STR|SUBST_TAINT_PAT|SUBST_TAINT_REPL)))
 348             SvTAINTED_on((pm->op_pmflags & PMf_NONDESTRUCT)
 349                          ? cx->sb_dstr : cx->sb_targ);
 350         TAINT_NOT;
 351     }
 352     rxres_save(&cx->sb_rxres, rx);
 353     PL_curpm = pm;
 354     RETURNOP(pm->op_pmstashstartu.op_pmreplstart);
 355 }
 356
 357 void
 358 Perl_rxres_save(pTHX_ void **rsp, REGEXP *rx)
 359 {
 360     UV *p = (UV*)*rsp;
 361     U32 i;
 362
 363     PERL_ARGS_ASSERT_RXRES_SAVE;
 364     PERL_UNUSED_CONTEXT;
 365
 366     if (!p || p[1] < RX_NPARENS(rx)) {
 367 #ifdef PERL_ANY_COW
 368         i = 7 + (RX_NPARENS(rx)+1) * 2;
 369 #else
 370         i = 6 + (RX_NPARENS(rx)+1) * 2;
 371 #endif
 372         if (!p)
 373             Newx(p, i, UV);
 374         else
 375             Renew(p, i, UV);
 376         *rsp = (void*)p;
 377     }
 378
 379     /* what (if anything) to free on croak */
 380     *p++ = PTR2UV(RX_MATCH_COPIED(rx) ? RX_SUBBEG(rx) : NULL);
 381     RX_MATCH_COPIED_off(rx);
 382     *p++ = RX_NPARENS(rx);
 383
 384 #ifdef PERL_ANY_COW
 385     *p++ = PTR2UV(RX_SAVED_COPY(rx));
 386     RX_SAVED_COPY(rx) = NULL;
 387 #endif
 388
 389     *p++ = PTR2UV(RX_SUBBEG(rx));
 390     *p++ = (UV)RX_SUBLEN(rx);
 391     *p++ = (UV)RX_SUBOFFSET(rx);
 392     *p++ = (UV)RX_SUBCOFFSET(rx);
 393     for (i = 0; i <= RX_NPARENS(rx); ++i) {
 394         *p++ = (UV)RX_OFFS(rx)[i].start;
 395         *p++ = (UV)RX_OFFS(rx)[i].end;
 396     }
 397 }
 398
 399 static void
 400 S_rxres_restore(pTHX_ void **rsp, REGEXP *rx)
 401 {
 402     UV *p = (UV*)*rsp;
 403     U32 i;
 404
 405     PERL_ARGS_ASSERT_RXRES_RESTORE;
 406     PERL_UNUSED_CONTEXT;
 407
 408     RX_MATCH_COPY_FREE(rx);
 409     RX_MATCH_COPIED_set(rx, *p);
 410     *p++ = 0;
 411     RX_NPARENS(rx) = *p++;
 412
 413 #ifdef PERL_ANY_COW
 414     if (RX_SAVED_COPY(rx))
 415         SvREFCNT_dec (RX_SAVED_COPY(rx));
 416     RX_SAVED_COPY(rx) = INT2PTR(SV*,*p);
 417     *p++ = 0;
 418 #endif
 419
 420     RX_SUBBEG(rx) = INT2PTR(char*,*p++);
 421     RX_SUBLEN(rx) = (I32)(*p++);
 422     RX_SUBOFFSET(rx) = (I32)*p++;
 423     RX_SUBCOFFSET(rx) = (I32)*p++;
 424     for (i = 0; i <= RX_NPARENS(rx); ++i) {
 425         RX_OFFS(rx)[i].start = (I32)(*p++);
 426         RX_OFFS(rx)[i].end = (I32)(*p++);
 427     }
 428 }
 429
 430 static void
 431 S_rxres_free(pTHX_ void **rsp)
 432 {
 433     UV * const p = (UV*)*rsp;
 434
 435     PERL_ARGS_ASSERT_RXRES_FREE;
 436     PERL_UNUSED_CONTEXT;
 437
 438     if (p) {
 439         void *tmp = INT2PTR(char*,*p);
 440 #ifdef PERL_POISON
 441 #ifdef PERL_ANY_COW
 442         U32 i = 9 + p[1] * 2;
 443 #else
 444         U32 i = 8 + p[1] * 2;
 445 #endif
 446 #endif
 447
 448 #ifdef PERL_ANY_COW
 449         SvREFCNT_dec (INT2PTR(SV*,p[2]));
 450 #endif
 451 #ifdef PERL_POISON
 452         PoisonFree(p, i, sizeof(UV));
 453 #endif
 454
 455         Safefree(tmp);
 456         Safefree(p);
 457         *rsp = NULL;
 458     }
 459 }
 460
 461 #define FORM_NUM_BLANK (1<<30)
 462 #define FORM_NUM_POINT (1<<29)
 463
 464 PP(pp_formline)
 465 {
 466     dSP; dMARK; dORIGMARK;
 467     SV * const tmpForm = *++MARK;
 468     SV *formsv;             /* contains text of original format */
 469     U32 *fpc;       /* format ops program counter */
 470     char *t;        /* current append position in target string */
 471     const char *f;          /* current position in format string */
 472     I32 arg;
 473     SV *sv = NULL; /* current item */
 474     const char *item = NULL;/* string value of current item */
 475     I32 itemsize  = 0;      /* length (chars) of item, possibly truncated */
 476     I32 itembytes = 0;      /* as itemsize, but length in bytes */
 477     I32 fieldsize = 0;      /* width of current field */
 478     I32 lines = 0;          /* number of lines that have been output */
 479     bool chopspace = (strchr(PL_chopset, ' ') != NULL); /* does $: have space */
 480     const char *chophere = NULL; /* where to chop current item */
 481     STRLEN linemark = 0;    /* pos of start of line in output */
 482     NV value;
 483     bool gotsome = FALSE;   /* seen at least one non-blank item on this line */
 484     STRLEN len;             /* length of current sv */
 485     STRLEN linemax;         /* estimate of output size in bytes */
 486     bool item_is_utf8 = FALSE;
 487     bool targ_is_utf8 = FALSE;
 488     const char *fmt;
 489     MAGIC *mg = NULL;
 490     U8 *source;             /* source of bytes to append */
 491     STRLEN to_copy;         /* how may bytes to append */
 492     char trans;             /* what chars to translate */
 493
 494     mg = doparseform(tmpForm);
 495
 496     fpc = (U32*)mg->mg_ptr;
 497     /* the actual string the format was compiled from.
 498      * with overload etc, this may not match tmpForm */
 499     formsv = mg->mg_obj;
 500
 501
 502     SvPV_force(PL_formtarget, len);
 503     if (SvTAINTED(tmpForm) || SvTAINTED(formsv))
 504         SvTAINTED_on(PL_formtarget);
 505     if (DO_UTF8(PL_formtarget))
 506         targ_is_utf8 = TRUE;
 507     linemax = (SvCUR(formsv) * (IN_BYTES ? 1 : 3) + 1);
 508     t = SvGROW(PL_formtarget, len + linemax + 1);
 509     /* XXX from now onwards, SvCUR(PL_formtarget) is invalid */
 510     t += len;
 511     f = SvPV_const(formsv, len);
 512
 513     for (;;) {
 514         DEBUG_f( {
 515             const char *name = "???";
 516             arg = -1;
 517             switch (*fpc) {
 518             case FF_LITERAL:    arg = fpc[1]; name = "LITERAL"; break;
 519             case FF_BLANK:      arg = fpc[1]; name = "BLANK";   break;
 520             case FF_SKIP:       arg = fpc[1]; name = "SKIP";    break;
 521             case FF_FETCH:      arg = fpc[1]; name = "FETCH";   break;
 522             case FF_DECIMAL:    arg = fpc[1]; name = "DECIMAL"; break;
 523
 524             case FF_CHECKNL:    name = "CHECKNL";       break;
 525             case FF_CHECKCHOP:  name = "CHECKCHOP";     break;
 526             case FF_SPACE:      name = "SPACE";         break;
 527             case FF_HALFSPACE:  name = "HALFSPACE";     break;
 528             case FF_ITEM:       name = "ITEM";          break;
 529             case FF_CHOP:       name = "CHOP";          break;
 530             case FF_LINEGLOB:   name = "LINEGLOB";      break;
 531             case FF_NEWLINE:    name = "NEWLINE";       break;
 532             case FF_MORE:       name = "MORE";          break;
 533             case FF_LINEMARK:   name = "LINEMARK";      break;
 534             case FF_END:        name = "END";           break;
 535             case FF_0DECIMAL:   name = "0DECIMAL";      break;
 536             case FF_LINESNGL:   name = "LINESNGL";      break;
 537             }
 538             if (arg >= 0)
 539                 PerlIO_printf(Perl_debug_log, "%-16s%ld\n", name, (long) arg);
 540             else
 541                 PerlIO_printf(Perl_debug_log, "%-16s\n", name);
 542         } );
 543         switch (*fpc++) {
 544         case FF_LINEMARK: /* start (or end) of a line */
 545             linemark = t - SvPVX(PL_formtarget);
 546             lines++;
 547             gotsome = FALSE;
 548             break;
 549
 550         case FF_LITERAL: /* append <arg> literal chars */
 551             to_copy = *fpc++;
 552             source = (U8 *)f;
 553             f += to_copy;
 554             trans = '~';
 555             item_is_utf8 = targ_is_utf8 ? !!DO_UTF8(formsv) : !!SvUTF8(formsv);
 556             goto append;
 557
 558         case FF_SKIP: /* skip <arg> chars in format */
 559             f += *fpc++;
 560             break;
 561
 562         case FF_FETCH: /* get next item and set field size to <arg> */
 563             arg = *fpc++;
 564             f += arg;
 565             fieldsize = arg;
 566
 567             if (MARK < SP)
 568                 sv = *++MARK;
 569             else {
 570                 sv = &PL_sv_no;
 571                 Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX), "Not enough format arguments");
 572             }
 573             if (SvTAINTED(sv))
 574                 SvTAINTED_on(PL_formtarget);
 575             break;
 576
 577         case FF_CHECKNL: /* find max len of item (up to \n) that fits field */
 578             {
 579                 const char *s = item = SvPV_const(sv, len);
 580                 const char *send = s + len;
 581
 582                 itemsize = 0;
 583                 item_is_utf8 = DO_UTF8(sv);
 584                 while (s < send) {
 585                     if (!isCNTRL(*s))
 586                         gotsome = TRUE;
 587                     else if (*s == '\n')
 588                         break;
 589
 590                     if (item_is_utf8)
 591                         s += UTF8SKIP(s);
 592                     else
 593                         s++;
 594                     itemsize++;
 595                     if (itemsize == fieldsize)
 596                         break;
 597                 }
 598                 itembytes = s - item;
 599                 chophere = s;
 600                 break;
 601             }
 602
 603         case FF_CHECKCHOP: /* like CHECKNL, but up to highest split point */
 604             {
 605                 const char *s = item = SvPV_const(sv, len);
 606                 const char *send = s + len;
 607                 I32 size = 0;
 608
 609                 chophere = NULL;
 610                 item_is_utf8 = DO_UTF8(sv);
 611                 while (s < send) {
 612                     /* look for a legal split position */
 613                     if (isSPACE(*s)) {
 614                         if (*s == '\r') {
 615                             chophere = s;
 616                             itemsize = size;
 617                             break;
 618                         }
 619                         if (chopspace) {
 620                             /* provisional split point */
 621                             chophere = s;
 622                             itemsize = size;
 623                         }
 624                         /* we delay testing fieldsize until after we've
 625                          * processed the possible split char directly
 626                          * following the last field char; so if fieldsize=3
 627                          * and item="a b cdef", we consume "a b", not "a".
 628                          * Ditto further down.
 629                          */
 630                         if (size == fieldsize)
 631                             break;
 632                     }
 633                     else {
 634                         if (strchr(PL_chopset, *s)) {
 635                             /* provisional split point */
 636                             /* for a non-space split char, we include
 637                              * the split char; hence the '+1' */
 638                             chophere = s + 1;
 639                             itemsize = size;
 640                         }
 641                         if (size == fieldsize)
 642                             break;
 643                         if (!isCNTRL(*s))
 644                             gotsome = TRUE;
 645                     }
 646
 647                     if (item_is_utf8)
 648                         s += UTF8SKIP(s);
 649                     else
 650                         s++;
 651                     size++;
 652                 }
 653                 if (!chophere || s == send) {
 654                     chophere = s;
 655                     itemsize = size;
 656                 }
 657                 itembytes = chophere - item;
 658
 659                 break;
 660             }
 661
 662         case FF_SPACE: /* append padding space (diff of field, item size) */
 663             arg = fieldsize - itemsize;
 664             if (arg) {
 665                 fieldsize -= arg;
 666                 while (arg-- > 0)
 667                     *t++ = ' ';
 668             }
 669             break;
 670
 671         case FF_HALFSPACE: /* like FF_SPACE, but only append half as many */
 672             arg = fieldsize - itemsize;
 673             if (arg) {
 674                 arg /= 2;
 675                 fieldsize -= arg;
 676                 while (arg-- > 0)
 677                     *t++ = ' ';
 678             }
 679             break;
 680
 681         case FF_ITEM: /* append a text item, while blanking ctrl chars */
 682             to_copy = itembytes;
 683             source = (U8 *)item;
 684             trans = 1;
 685             goto append;
 686
 687         case FF_CHOP: /* (for ^*) chop the current item */
 688             if (sv != &PL_sv_no) {
 689                 const char *s = chophere;
 690                 if (chopspace) {
 691                     while (isSPACE(*s))
 692                         s++;
 693                 }
 694                 if (SvPOKp(sv))
 695                     sv_chop(sv,s);
 696                 else
 697                     /* tied, overloaded or similar strangeness.
 698                      * Do it the hard way */
 699                     sv_setpvn(sv, s, len - (s-item));
 700                 SvSETMAGIC(sv);
 701                 break;
 702             }
 703
 704         case FF_LINESNGL: /* process ^*  */
 705             chopspace = 0;
 706             /* FALLTHROUGH */
 707
 708         case FF_LINEGLOB: /* process @*  */
 709             {
 710                 const bool oneline = fpc[-1] == FF_LINESNGL;
 711                 const char *s = item = SvPV_const(sv, len);
 712                 const char *const send = s + len;
 713
 714                 item_is_utf8 = DO_UTF8(sv);
 715                 chophere = s + len;
 716                 if (!len)
 717                     break;
 718                 trans = 0;
 719                 gotsome = TRUE;
 720                 source = (U8 *) s;
 721                 to_copy = len;
 722                 while (s < send) {
 723                     if (*s++ == '\n') {
 724                         if (oneline) {
 725                             to_copy = s - item - 1;
 726                             chophere = s;
 727                             break;
 728                         } else {
 729                             if (s == send) {
 730                                 to_copy--;
 731                             } else
 732                                 lines++;
 733                         }
 734                     }
 735                 }
 736             }
 737
 738         append:
 739             /* append to_copy bytes from source to PL_formstring.
 740              * item_is_utf8 implies source is utf8.
 741              * if trans, translate certain characters during the copy */
 742             {
 743                 U8 *tmp = NULL;
 744                 STRLEN grow = 0;
 745
 746                 SvCUR_set(PL_formtarget,
 747                           t - SvPVX_const(PL_formtarget));
 748
 749                 if (targ_is_utf8 && !item_is_utf8) {
 750                     source = tmp = bytes_to_utf8(source, &to_copy);
 751                 } else {
 752                     if (item_is_utf8 && !targ_is_utf8) {
 753                         U8 *s;
 754                         /* Upgrade targ to UTF8, and then we reduce it to
 755                            a problem we have a simple solution for.
 756                            Don't need get magic.  */
 757                         sv_utf8_upgrade_nomg(PL_formtarget);
 758                         targ_is_utf8 = TRUE;
 759                         /* re-calculate linemark */
 760                         s = (U8*)SvPVX(PL_formtarget);
 761                         /* the bytes we initially allocated to append the
 762                          * whole line may have been gobbled up during the
 763                          * upgrade, so allocate a whole new line's worth
 764                          * for safety */
 765                         grow = linemax;
 766                         while (linemark--)
 767                             s += UTF8SKIP(s);
 768                         linemark = s - (U8*)SvPVX(PL_formtarget);
 769                     }
 770                     /* Easy. They agree.  */
 771                     assert (item_is_utf8 == targ_is_utf8);
 772                 }
 773                 if (!trans)
 774                     /* @* and ^* are the only things that can exceed
 775                      * the linemax, so grow by the output size, plus
 776                      * a whole new form's worth in case of any further
 777                      * output */
 778                     grow = linemax + to_copy;
 779                 if (grow)
 780                     SvGROW(PL_formtarget, SvCUR(PL_formtarget) + grow + 1);
 781                 t = SvPVX(PL_formtarget) + SvCUR(PL_formtarget);
 782
 783                 Copy(source, t, to_copy, char);
 784                 if (trans) {
 785                     /* blank out ~ or control chars, depending on trans.
 786                      * works on bytes not chars, so relies on not
 787                      * matching utf8 continuation bytes */
 788                     U8 *s = (U8*)t;
 789                     U8 *send = s + to_copy;
 790                     while (s < send) {
 791                         const int ch = *s;
 792                         if (trans == '~' ? (ch == '~') : isCNTRL(ch))
 793                             *s = ' ';
 794                         s++;
 795                     }
 796                 }
 797
 798                 t += to_copy;
 799                 SvCUR_set(PL_formtarget, SvCUR(PL_formtarget) + to_copy);
 800                 if (tmp)
 801                     Safefree(tmp);
 802                 break;
 803             }
 804
 805         case FF_0DECIMAL: /* like FF_DECIMAL but for 0### */
 806             arg = *fpc++;
 807             fmt = (const char *)
 808                 ((arg & FORM_NUM_POINT) ? "%#0*.*" NVff : "%0*.*" NVff);
 809             goto ff_dec;
 810
 811         case FF_DECIMAL: /* do @##, ^##, where <arg>=(precision|flags) */
 812             arg = *fpc++;
 813             fmt = (const char *)
 814                 ((arg & FORM_NUM_POINT) ? "%#*.*" NVff : "%*.*" NVff);
 815         ff_dec:
 816             /* If the field is marked with ^ and the value is undefined,
 817                blank it out. */
 818             if ((arg & FORM_NUM_BLANK) && !SvOK(sv)) {
 819                 arg = fieldsize;
 820                 while (arg--)
 821                     *t++ = ' ';
 822                 break;
 823             }
 824             gotsome = TRUE;
 825             value = SvNV(sv);
 826             /* overflow evidence */
 827             if (num_overflow(value, fieldsize, arg)) {
 828                 arg = fieldsize;
 829                 while (arg--)
 830                     *t++ = '#';
 831                 break;
 832             }
 833             /* Formats aren't yet marked for locales, so assume "yes". */
 834             {
 835                 Size_t max = SvLEN(PL_formtarget) - (t - SvPVX(PL_formtarget));
 836                 int len;
 837                 DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
 838                 STORE_LC_NUMERIC_SET_TO_NEEDED();
 839                 arg &= ~(FORM_NUM_POINT|FORM_NUM_BLANK);
 840 #ifdef USE_QUADMATH
 841                 {
 842                     const char* qfmt = quadmath_format_single(fmt);
 843                     int len;
 844                     if (!qfmt)
 845                         Perl_croak_nocontext("panic: quadmath invalid format \"%s\"", fmt);
 846                     len = quadmath_snprintf(t, max, qfmt, (int) fieldsize, (int) arg, value);
 847                     if (len == -1)
 848                         Perl_croak_nocontext("panic: quadmath_snprintf failed, format \"%s\"", qfmt);
 849                     if (qfmt != fmt)
 850                         Safefree(fmt);
 851                 }
 852 #else
 853                 /* we generate fmt ourselves so it is safe */
 854                 GCC_DIAG_IGNORE(-Wformat-nonliteral);
 855                 len = my_snprintf(t, max, fmt, (int) fieldsize, (int) arg, value);
 856                 GCC_DIAG_RESTORE;
 857 #endif
 858                 PERL_MY_SNPRINTF_POST_GUARD(len, max);
 859                 RESTORE_LC_NUMERIC();
 860             }
 861             t += fieldsize;
 862             break;
 863
 864         case FF_NEWLINE: /* delete trailing spaces, then append \n */
 865             f++;
 866             while (t-- > (SvPVX(PL_formtarget) + linemark) && *t == ' ') ;
 867             t++;
 868             *t++ = '\n';
 869             break;
 870
 871         case FF_BLANK: /* for arg==0: do '~'; for arg>0 : do '~~' */
 872             arg = *fpc++;
 873             if (gotsome) {
 874                 if (arg) {              /* repeat until fields exhausted? */
 875                     fpc--;
 876                     goto end;
 877                 }
 878             }
 879             else {
 880                 t = SvPVX(PL_formtarget) + linemark;
 881                 lines--;
 882             }
 883             break;
 884
 885         case FF_MORE: /* replace long end of string with '...' */
 886             {
 887                 const char *s = chophere;
 888                 const char *send = item + len;
 889                 if (chopspace) {
 890                     while (isSPACE(*s) && (s < send))
 891                         s++;
 892                 }
 893                 if (s < send) {
 894                     char *s1;
 895                     arg = fieldsize - itemsize;
 896                     if (arg) {
 897                         fieldsize -= arg;
 898                         while (arg-- > 0)
 899                             *t++ = ' ';
 900                     }
 901                     s1 = t - 3;
 902                     if (strnEQ(s1,"   ",3)) {
 903                         while (s1 > SvPVX_const(PL_formtarget) && isSPACE(s1[-1]))
 904                             s1--;
 905                     }
 906                     *s1++ = '.';
 907                     *s1++ = '.';
 908                     *s1++ = '.';
 909                 }
 910                 break;
 911             }
 912
 913         case FF_END: /* tidy up, then return */
 914         end:
 915             assert(t < SvPVX_const(PL_formtarget) + SvLEN(PL_formtarget));
 916             *t = '\0';
 917             SvCUR_set(PL_formtarget, t - SvPVX_const(PL_formtarget));
 918             if (targ_is_utf8)
 919                 SvUTF8_on(PL_formtarget);
 920             FmLINES(PL_formtarget) += lines;
 921             SP = ORIGMARK;
 922             if (fpc[-1] == FF_BLANK)
 923                 RETURNOP(cLISTOP->op_first);
 924             else
 925                 RETPUSHYES;
 926         }
 927     }
 928 }
 929
 930 PP(pp_grepstart)
 931 {
 932     dSP;
 933     SV *src;
 934
 935     if (PL_stack_base + TOPMARK == SP) {
 936         (void)POPMARK;
 937         if (GIMME_V == G_SCALAR)
 938             mXPUSHi(0);
 939         RETURNOP(PL_op->op_next->op_next);
 940     }
 941     PL_stack_sp = PL_stack_base + TOPMARK + 1;
 942     Perl_pp_pushmark(aTHX);                             /* push dst */
 943     Perl_pp_pushmark(aTHX);                             /* push src */
 944     ENTER_with_name("grep");                                    /* enter outer scope */
 945
 946     SAVETMPS;
 947     SAVE_DEFSV;
 948     ENTER_with_name("grep_item");                                       /* enter inner scope */
 949     SAVEVPTR(PL_curpm);
 950
 951     src = PL_stack_base[TOPMARK];
 952     if (SvPADTMP(src)) {
 953         src = PL_stack_base[TOPMARK] = sv_mortalcopy(src);
 954         PL_tmps_floor++;
 955     }
 956     SvTEMP_off(src);
 957     DEFSV_set(src);
 958
 959     PUTBACK;
 960     if (PL_op->op_type == OP_MAPSTART)
 961         Perl_pp_pushmark(aTHX);                 /* push top */
 962     return ((LOGOP*)PL_op->op_next)->op_other;
 963 }
 964
 965 PP(pp_mapwhile)
 966 {
 967     dSP;
 968     const U8 gimme = GIMME_V;
 969     I32 items = (SP - PL_stack_base) - TOPMARK; /* how many new items */
 970     I32 count;
 971     I32 shift;
 972     SV** src;
 973     SV** dst;
 974
 975     /* first, move source pointer to the next item in the source list */
 976     ++PL_markstack_ptr[-1];
 977
 978     /* if there are new items, push them into the destination list */
 979     if (items && gimme != G_VOID) {
 980         /* might need to make room back there first */
 981         if (items > PL_markstack_ptr[-1] - PL_markstack_ptr[-2]) {
 982             /* XXX this implementation is very pessimal because the stack
 983              * is repeatedly extended for every set of items.  Is possible
 984              * to do this without any stack extension or copying at all
 985              * by maintaining a separate list over which the map iterates
 986              * (like foreach does). --gsar */
 987
 988             /* everything in the stack after the destination list moves
 989              * towards the end the stack by the amount of room needed */
 990             shift = items - (PL_markstack_ptr[-1] - PL_markstack_ptr[-2]);
 991
 992             /* items to shift up (accounting for the moved source pointer) */
 993             count = (SP - PL_stack_base) - (PL_markstack_ptr[-1] - 1);
 994
 995             /* This optimization is by Ben Tilly and it does
 996              * things differently from what Sarathy (gsar)
 997              * is describing.  The downside of this optimization is
 998              * that leaves "holes" (uninitialized and hopefully unused areas)
 999              * to the Perl stack, but on the other hand this
1000              * shouldn't be a problem.  If Sarathy's idea gets
1001              * implemented, this optimization should become
1002              * irrelevant.  --jhi */
1003             if (shift < count)
1004                 shift = count; /* Avoid shifting too often --Ben Tilly */
1005
1006             EXTEND(SP,shift);
1007             src = SP;
1008             dst = (SP += shift);
1009             PL_markstack_ptr[-1] += shift;
1010             *PL_markstack_ptr += shift;
1011             while (count--)
1012                 *dst-- = *src--;
1013         }
1014         /* copy the new items down to the destination list */
1015         dst = PL_stack_base + (PL_markstack_ptr[-2] += items) - 1;
1016         if (gimme == G_ARRAY) {
1017             /* add returned items to the collection (making mortal copies
1018              * if necessary), then clear the current temps stack frame
1019              * *except* for those items. We do this splicing the items
1020              * into the start of the tmps frame (so some items may be on
1021              * the tmps stack twice), then moving PL_tmps_floor above
1022              * them, then freeing the frame. That way, the only tmps that
1023              * accumulate over iterations are the return values for map.
1024              * We have to do to this way so that everything gets correctly
1025              * freed if we die during the map.
1026              */
1027             I32 tmpsbase;
1028             I32 i = items;
1029             /* make space for the slice */
1030             EXTEND_MORTAL(items);
1031             tmpsbase = PL_tmps_floor + 1;
1032             Move(PL_tmps_stack + tmpsbase,
1033                  PL_tmps_stack + tmpsbase + items,
1034                  PL_tmps_ix - PL_tmps_floor,
1035                  SV*);
1036             PL_tmps_ix += items;
1037
1038             while (i-- > 0) {
1039                 SV *sv = POPs;
1040                 if (!SvTEMP(sv))
1041                     sv = sv_mortalcopy(sv);
1042                 *dst-- = sv;
1043                 PL_tmps_stack[tmpsbase++] = SvREFCNT_inc_simple(sv);
1044             }
1045             /* clear the stack frame except for the items */
1046             PL_tmps_floor += items;
1047             FREETMPS;
1048             /* FREETMPS may have cleared the TEMP flag on some of the items */
1049             i = items;
1050             while (i-- > 0)
1051                 SvTEMP_on(PL_tmps_stack[--tmpsbase]);
1052         }
1053         else {
1054             /* scalar context: we don't care about which values map returns
1055              * (we use undef here). And so we certainly don't want to do mortal
1056              * copies of meaningless values. */
1057             while (items-- > 0) {
1058                 (void)POPs;
1059                 *dst-- = &PL_sv_undef;
1060             }
1061             FREETMPS;
1062         }
1063     }
1064     else {
1065         FREETMPS;
1066     }
1067     LEAVE_with_name("grep_item");                                       /* exit inner scope */
1068
1069     /* All done yet? */
1070     if (PL_markstack_ptr[-1] > TOPMARK) {
1071
1072         (void)POPMARK;                          /* pop top */
1073         LEAVE_with_name("grep");                                        /* exit outer scope */
1074         (void)POPMARK;                          /* pop src */
1075         items = --*PL_markstack_ptr - PL_markstack_ptr[-1];
1076         (void)POPMARK;                          /* pop dst */
1077         SP = PL_stack_base + POPMARK;           /* pop original mark */
1078         if (gimme == G_SCALAR) {
1079                 dTARGET;
1080                 XPUSHi(items);
1081         }
1082         else if (gimme == G_ARRAY)
1083             SP += items;
1084         RETURN;
1085     }
1086     else {
1087         SV *src;
1088
1089         ENTER_with_name("grep_item");                                   /* enter inner scope */
1090         SAVEVPTR(PL_curpm);
1091
1092         /* set $_ to the new source item */
1093         src = PL_stack_base[PL_markstack_ptr[-1]];
1094         if (SvPADTMP(src)) {
1095             src = sv_mortalcopy(src);
1096         }
1097         SvTEMP_off(src);
1098         DEFSV_set(src);
1099
1100         RETURNOP(cLOGOP->op_other);
1101     }
1102 }
1103
1104 /* Range stuff. */
1105
1106 PP(pp_range)
1107 {
1108     if (GIMME_V == G_ARRAY)
1109         return NORMAL;
1110     if (SvTRUEx(PAD_SV(PL_op->op_targ)))
1111         return cLOGOP->op_other;
1112     else
1113         return NORMAL;
1114 }
1115
1116 PP(pp_flip)
1117 {
1118     dSP;
1119
1120     if (GIMME_V == G_ARRAY) {
1121         RETURNOP(((LOGOP*)cUNOP->op_first)->op_other);
1122     }
1123     else {
1124         dTOPss;
1125         SV * const targ = PAD_SV(PL_op->op_targ);
1126         int flip = 0;
1127
1128         if (PL_op->op_private & OPpFLIP_LINENUM) {
1129             if (GvIO(PL_last_in_gv)) {
1130                 flip = SvIV(sv) == (IV)IoLINES(GvIOp(PL_last_in_gv));
1131             }
1132             else {
1133                 GV * const gv = gv_fetchpvs(".", GV_ADD|GV_NOTQUAL, SVt_PV);
1134                 if (gv && GvSV(gv))
1135                     flip = SvIV(sv) == SvIV(GvSV(gv));
1136             }
1137         } else {
1138             flip = SvTRUE(sv);
1139         }
1140         if (flip) {
1141             sv_setiv(PAD_SV(cUNOP->op_first->op_targ), 1);
1142             if (PL_op->op_flags & OPf_SPECIAL) {
1143                 sv_setiv(targ, 1);
1144                 SETs(targ);
1145                 RETURN;
1146             }
1147             else {
1148                 sv_setiv(targ, 0);
1149                 SP--;
1150                 RETURNOP(((LOGOP*)cUNOP->op_first)->op_other);
1151             }
1152         }
1153         sv_setpvs(TARG, "");
1154         SETs(targ);
1155         RETURN;
1156     }
1157 }
1158
1159 /* This code tries to decide if "$left .. $right" should use the
1160    magical string increment, or if the range is numeric (we make
1161    an exception for .."0" [#18165]). AMS 20021031. */
1162
1163 #define RANGE_IS_NUMERIC(left,right) ( \
1164         SvNIOKp(left)  || (SvOK(left)  && !SvPOKp(left))  || \
1165         SvNIOKp(right) || (SvOK(right) && !SvPOKp(right)) || \
1166         (((!SvOK(left) && SvOK(right)) || ((!SvOK(left) || \
1167           looks_like_number(left)) && SvPOKp(left) && *SvPVX_const(left) != '0')) \
1168          && (!SvOK(right) || looks_like_number(right))))
1169
1170 PP(pp_flop)
1171 {
1172     dSP;
1173
1174     if (GIMME_V == G_ARRAY) {
1175         dPOPPOPssrl;
1176
1177         SvGETMAGIC(left);
1178         SvGETMAGIC(right);
1179
1180         if (RANGE_IS_NUMERIC(left,right)) {
1181             IV i, j, n;
1182             if ((SvOK(left) && !SvIOK(left) && SvNV_nomg(left) < IV_MIN) ||
1183                 (SvOK(right) && (SvIOK(right)
1184                                  ? SvIsUV(right) && SvUV(right) > IV_MAX
1185                                  : SvNV_nomg(right) > IV_MAX)))
1186                 DIE(aTHX_ "Range iterator outside integer range");
1187             i = SvIV_nomg(left);
1188             j = SvIV_nomg(right);
1189             if (j >= i) {
1190                 /* Dance carefully around signed max. */
1191                 bool overflow = (i <= 0 && j > SSize_t_MAX + i - 1);
1192                 if (!overflow) {
1193                     n = j - i + 1;
1194                     /* The wraparound of signed integers is undefined
1195                      * behavior, but here we aim for count >=1, and
1196                      * negative count is just wrong. */
1197                     if (n < 1
1198 #if IVSIZE > Size_t_size
1199                         || n > SSize_t_MAX
1200 #endif
1201                         )
1202                         overflow = TRUE;
1203                 }
1204                 if (overflow)
1205                     Perl_croak(aTHX_ "Out of memory during list extend");
1206                 EXTEND_MORTAL(n);
1207                 EXTEND(SP, n);
1208             }
1209             else
1210                 n = 0;
1211             while (n--) {
1212                 SV * const sv = sv_2mortal(newSViv(i));
1213                 PUSHs(sv);
1214                 if (n) /* avoid incrementing above IV_MAX */
1215                     i++;
1216             }
1217         }
1218         else {
1219             STRLEN len, llen;
1220             const char * const lpv = SvPV_nomg_const(left, llen);
1221             const char * const tmps = SvPV_nomg_const(right, len);
1222
1223             SV *sv = newSVpvn_flags(lpv, llen, SvUTF8(left)|SVs_TEMP);
1224             while (!SvNIOKp(sv) && SvCUR(sv) <= len) {
1225                 XPUSHs(sv);
1226                 if (strEQ(SvPVX_const(sv),tmps))
1227                     break;
1228                 sv = sv_2mortal(newSVsv(sv));
1229                 sv_inc(sv);
1230             }
1231         }
1232     }
1233     else {
1234         dTOPss;
1235         SV * const targ = PAD_SV(cUNOP->op_first->op_targ);
1236         int flop = 0;
1237         sv_inc(targ);
1238
1239         if (PL_op->op_private & OPpFLIP_LINENUM) {
1240             if (GvIO(PL_last_in_gv)) {
1241                 flop = SvIV(sv) == (IV)IoLINES(GvIOp(PL_last_in_gv));
1242             }
1243             else {
1244                 GV * const gv = gv_fetchpvs(".", GV_ADD|GV_NOTQUAL, SVt_PV);
1245                 if (gv && GvSV(gv)) flop = SvIV(sv) == SvIV(GvSV(gv));
1246             }
1247         }
1248         else {
1249             flop = SvTRUE(sv);
1250         }
1251
1252         if (flop) {
1253             sv_setiv(PAD_SV(((UNOP*)cUNOP->op_first)->op_first->op_targ), 0);
1254             sv_catpvs(targ, "E0");
1255         }
1256         SETs(targ);
1257     }
1258
1259     RETURN;
1260 }
1261
1262 /* Control. */
1263
1264 static const char * const context_name[] = {
1265     "pseudo-block",
1266     NULL, /* CXt_WHEN never actually needs "block" */
1267     NULL, /* CXt_BLOCK never actually needs "block" */
1268     NULL, /* CXt_GIVEN never actually needs "block" */
1269     NULL, /* CXt_LOOP_PLAIN never actually needs "loop" */
1270     NULL, /* CXt_LOOP_LAZYIV never actually needs "loop" */
1271     NULL, /* CXt_LOOP_LAZYSV never actually needs "loop" */
1272     NULL, /* CXt_LOOP_LIST never actually needs "loop" */
1273     NULL, /* CXt_LOOP_ARY never actually needs "loop" */
1274     "subroutine",
1275     "format",
1276     "eval",
1277     "substitution",
1278 };
1279
1280 STATIC I32
1281 S_dopoptolabel(pTHX_ const char *label, STRLEN len, U32 flags)
1282 {
1283     I32 i;
1284
1285     PERL_ARGS_ASSERT_DOPOPTOLABEL;
1286
1287     for (i = cxstack_ix; i >= 0; i--) {
1288         const PERL_CONTEXT * const cx = &cxstack[i];
1289         switch (CxTYPE(cx)) {
1290         case CXt_SUBST:
1291         case CXt_SUB:
1292         case CXt_FORMAT:
1293         case CXt_EVAL:
1294         case CXt_NULL:
1295             /* diag_listed_as: Exiting subroutine via %s */
1296             Perl_ck_warner(aTHX_ packWARN(WARN_EXITING), "Exiting %s via %s",
1297                            context_name[CxTYPE(cx)], OP_NAME(PL_op));
1298             if (CxTYPE(cx) == CXt_NULL) /* sort BLOCK */
1299                 return -1;
1300             break;
1301         case CXt_LOOP_PLAIN:
1302         case CXt_LOOP_LAZYIV:
1303         case CXt_LOOP_LAZYSV:
1304         case CXt_LOOP_LIST:
1305         case CXt_LOOP_ARY:
1306           {
1307             STRLEN cx_label_len = 0;
1308             U32 cx_label_flags = 0;
1309             const char *cx_label = CxLABEL_len_flags(cx, &cx_label_len, &cx_label_flags);
1310             if (!cx_label || !(
1311                     ( (cx_label_flags & SVf_UTF8) != (flags & SVf_UTF8) ) ?
1312                         (flags & SVf_UTF8)
1313                             ? (bytes_cmp_utf8(
1314                                         (const U8*)cx_label, cx_label_len,
1315                                         (const U8*)label, len) == 0)
1316                             : (bytes_cmp_utf8(
1317                                         (const U8*)label, len,
1318                                         (const U8*)cx_label, cx_label_len) == 0)
1319                     : (len == cx_label_len && ((cx_label == label)
1320                                     || memEQ(cx_label, label, len))) )) {
1321                 DEBUG_l(Perl_deb(aTHX_ "(poptolabel(): skipping label at cx=%ld %s)\n",
1322                         (long)i, cx_label));
1323                 continue;
1324             }
1325             DEBUG_l( Perl_deb(aTHX_ "(poptolabel(): found label at cx=%ld %s)\n", (long)i, label));
1326             return i;
1327           }
1328         }
1329     }
1330     return i;
1331 }
1332
1333
1334
1335 U8
1336 Perl_dowantarray(pTHX)
1337 {
1338     const U8 gimme = block_gimme();
1339     return (gimme == G_VOID) ? G_SCALAR : gimme;
1340 }
1341
1342 U8
1343 Perl_block_gimme(pTHX)
1344 {
1345     const I32 cxix = dopoptosub(cxstack_ix);
1346     U8 gimme;
1347     if (cxix < 0)
1348         return G_VOID;
1349
1350     gimme = (cxstack[cxix].blk_gimme & G_WANT);
1351     if (!gimme)
1352         Perl_croak(aTHX_ "panic: bad gimme: %d\n", gimme);
1353     return gimme;
1354 }
1355
1356
1357 I32
1358 Perl_is_lvalue_sub(pTHX)
1359 {
1360     const I32 cxix = dopoptosub(cxstack_ix);
1361     assert(cxix >= 0);  /* We should only be called from inside subs */
1362
1363     if (CxLVAL(cxstack + cxix) && CvLVALUE(cxstack[cxix].blk_sub.cv))
1364         return CxLVAL(cxstack + cxix);
1365     else
1366         return 0;
1367 }
1368
1369 /* only used by cx_pushsub() */
1370 I32
1371 Perl_was_lvalue_sub(pTHX)
1372 {
1373     const I32 cxix = dopoptosub(cxstack_ix-1);
1374     assert(cxix >= 0);  /* We should only be called from inside subs */
1375
1376     if (CxLVAL(cxstack + cxix) && CvLVALUE(cxstack[cxix].blk_sub.cv))
1377         return CxLVAL(cxstack + cxix);
1378     else
1379         return 0;
1380 }
1381
1382 STATIC I32
1383 S_dopoptosub_at(pTHX_ const PERL_CONTEXT *cxstk, I32 startingblock)
1384 {
1385     I32 i;
1386
1387     PERL_ARGS_ASSERT_DOPOPTOSUB_AT;
1388 #ifndef DEBUGGING
1389     PERL_UNUSED_CONTEXT;
1390 #endif
1391
1392     for (i = startingblock; i >= 0; i--) {
1393         const PERL_CONTEXT * const cx = &cxstk[i];
1394         switch (CxTYPE(cx)) {
1395         default:
1396             continue;
1397         case CXt_SUB:
1398             /* in sub foo { /(?{...})/ }, foo ends up on the CX stack
1399              * twice; the first for the normal foo() call, and the second
1400              * for a faked up re-entry into the sub to execute the
1401              * code block. Hide this faked entry from the world. */
1402             if (cx->cx_type & CXp_SUB_RE_FAKE)
1403                 continue;
1404             /* FALLTHROUGH */
1405         case CXt_EVAL:
1406         case CXt_FORMAT:
1407             DEBUG_l( Perl_deb(aTHX_ "(dopoptosub_at(): found sub at cx=%ld)\n", (long)i));
1408             return i;
1409         }
1410     }
1411     return i;
1412 }
1413
1414 STATIC I32
1415 S_dopoptoeval(pTHX_ I32 startingblock)
1416 {
1417     I32 i;
1418     for (i = startingblock; i >= 0; i--) {
1419         const PERL_CONTEXT *cx = &cxstack[i];
1420         switch (CxTYPE(cx)) {
1421         default:
1422             continue;
1423         case CXt_EVAL:
1424             DEBUG_l( Perl_deb(aTHX_ "(dopoptoeval(): found eval at cx=%ld)\n", (long)i));
1425             return i;
1426         }
1427     }
1428     return i;
1429 }
1430
1431 STATIC I32
1432 S_dopoptoloop(pTHX_ I32 startingblock)
1433 {
1434     I32 i;
1435     for (i = startingblock; i >= 0; i--) {
1436         const PERL_CONTEXT * const cx = &cxstack[i];
1437         switch (CxTYPE(cx)) {
1438         case CXt_SUBST:
1439         case CXt_SUB:
1440         case CXt_FORMAT:
1441         case CXt_EVAL:
1442         case CXt_NULL:
1443             /* diag_listed_as: Exiting subroutine via %s */
1444             Perl_ck_warner(aTHX_ packWARN(WARN_EXITING), "Exiting %s via %s",
1445                            context_name[CxTYPE(cx)], OP_NAME(PL_op));
1446             if ((CxTYPE(cx)) == CXt_NULL) /* sort BLOCK */
1447                 return -1;
1448             break;
1449         case CXt_LOOP_PLAIN:
1450         case CXt_LOOP_LAZYIV:
1451         case CXt_LOOP_LAZYSV:
1452         case CXt_LOOP_LIST:
1453         case CXt_LOOP_ARY:
1454             DEBUG_l( Perl_deb(aTHX_ "(dopoptoloop(): found loop at cx=%ld)\n", (long)i));
1455             return i;
1456         }
1457     }
1458     return i;
1459 }
1460
1461 /* find the next GIVEN or FOR (with implicit $_) loop context block */
1462
1463 STATIC I32
1464 S_dopoptogivenfor(pTHX_ I32 startingblock)
1465 {
1466     I32 i;
1467     for (i = startingblock; i >= 0; i--) {
1468         const PERL_CONTEXT *cx = &cxstack[i];
1469         switch (CxTYPE(cx)) {
1470         default:
1471             continue;
1472         case CXt_GIVEN:
1473             DEBUG_l( Perl_deb(aTHX_ "(dopoptogivenfor(): found given at cx=%ld)\n", (long)i));
1474             return i;
1475         case CXt_LOOP_PLAIN:
1476             assert(!(cx->cx_type & CXp_FOR_DEF));
1477             break;
1478         case CXt_LOOP_LAZYIV:
1479         case CXt_LOOP_LAZYSV:
1480         case CXt_LOOP_LIST:
1481         case CXt_LOOP_ARY:
1482             if (cx->cx_type & CXp_FOR_DEF) {
1483                 DEBUG_l( Perl_deb(aTHX_ "(dopoptogivenfor(): found foreach at cx=%ld)\n", (long)i));
1484                 return i;
1485             }
1486         }
1487     }
1488     return i;
1489 }
1490
1491 STATIC I32
1492 S_dopoptowhen(pTHX_ I32 startingblock)
1493 {
1494     I32 i;
1495     for (i = startingblock; i >= 0; i--) {
1496         const PERL_CONTEXT *cx = &cxstack[i];
1497         switch (CxTYPE(cx)) {
1498         default:
1499             continue;
1500         case CXt_WHEN:
1501             DEBUG_l( Perl_deb(aTHX_ "(dopoptowhen(): found when at cx=%ld)\n", (long)i));
1502             return i;
1503         }
1504     }
1505     return i;
1506 }
1507
1508 /* dounwind(): pop all contexts above (but not including) cxix.
1509  * Note that it clears the savestack frame associated with each popped
1510  * context entry, but doesn't free any temps.
1511  * It does a cx_popblock() of the last frame that it pops, and leaves
1512  * cxstack_ix equal to cxix.
1513  */
1514
1515 void
1516 Perl_dounwind(pTHX_ I32 cxix)
1517 {
1518     if (!PL_curstackinfo) /* can happen if die during thread cloning */
1519         return;
1520
1521     while (cxstack_ix > cxix) {
1522         PERL_CONTEXT *cx = CX_CUR();
1523
1524         CX_DEBUG(cx, "UNWIND");
1525         /* Note: we don't need to restore the base context info till the end. */
1526
1527         CX_LEAVE_SCOPE(cx);
1528
1529         switch (CxTYPE(cx)) {
1530         case CXt_SUBST:
1531             CX_POPSUBST(cx);
1532             break;
1533         case CXt_SUB:
1534             cx_popsub(cx);
1535             break;
1536         case CXt_EVAL:
1537             cx_popeval(cx);
1538             break;
1539         case CXt_LOOP_PLAIN:
1540         case CXt_LOOP_LAZYIV:
1541         case CXt_LOOP_LAZYSV:
1542         case CXt_LOOP_LIST:
1543         case CXt_LOOP_ARY:
1544             cx_poploop(cx);
1545             break;
1546         case CXt_WHEN:
1547             cx_popwhen(cx);
1548             break;
1549         case CXt_GIVEN:
1550             cx_popgiven(cx);
1551             break;
1552         case CXt_BLOCK:
1553         case CXt_NULL:
1554             /* these two don't have a POPFOO() */
1555             break;
1556         case CXt_FORMAT:
1557             cx_popformat(cx);
1558             break;
1559         }
1560         if (cxstack_ix == cxix + 1) {
1561             cx_popblock(cx);
1562         }
1563         cxstack_ix--;
1564     }
1565
1566 }
1567
1568 void
1569 Perl_qerror(pTHX_ SV *err)
1570 {
1571     PERL_ARGS_ASSERT_QERROR;
1572
1573     if (PL_in_eval) {
1574         if (PL_in_eval & EVAL_KEEPERR) {
1575                 Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "\t(in cleanup) %"SVf,
1576                                                     SVfARG(err));
1577         }
1578         else
1579             sv_catsv(ERRSV, err);
1580     }
1581     else if (PL_errors)
1582         sv_catsv(PL_errors, err);
1583     else
1584         Perl_warn(aTHX_ "%"SVf, SVfARG(err));
1585     if (PL_parser)
1586         ++PL_parser->error_count;
1587 }
1588
1589
1590
1591 /* undef or delete the $INC{namesv} entry, then croak.
1592  * require0 indicates that the require didn't return a true value */
1593
1594 static void
1595 S_undo_inc_then_croak(pTHX_ SV *namesv, SV *err, bool require0)
1596 {
1597     const char *fmt;
1598     HV *inc_hv = GvHVn(PL_incgv);
1599     I32  klen  = SvUTF8(namesv) ? -(I32)SvCUR(namesv) : (I32)SvCUR(namesv);
1600     const char *key = SvPVX_const(namesv);
1601
1602     if (require0) {
1603         (void)hv_delete(inc_hv, key, klen, G_DISCARD);
1604         fmt = "%"SVf" did not return a true value";
1605         err = namesv;
1606     }
1607     else {
1608         (void)hv_store(inc_hv, key, klen, &PL_sv_undef, 0);
1609         fmt = "%"SVf"Compilation failed in require";
1610         err = err ? err : newSVpvs_flags("Unknown error\n", SVs_TEMP);
1611     }
1612
1613     Perl_croak(aTHX_ fmt, SVfARG(err));
1614 }
1615
1616
1617 void
1618 Perl_die_unwind(pTHX_ SV *msv)
1619 {
1620     SV *exceptsv = sv_mortalcopy(msv);
1621     U8 in_eval = PL_in_eval;
1622     PERL_ARGS_ASSERT_DIE_UNWIND;
1623
1624     if (in_eval) {
1625         I32 cxix;
1626
1627         /*
1628          * Historically, perl used to set ERRSV ($@) early in the die
1629          * process and rely on it not getting clobbered during unwinding.
1630          * That sucked, because it was liable to get clobbered, so the
1631          * setting of ERRSV used to emit the exception from eval{} has
1632          * been moved to much later, after unwinding (see just before
1633          * JMPENV_JUMP below).  However, some modules were relying on the
1634          * early setting, by examining $@ during unwinding to use it as
1635          * a flag indicating whether the current unwinding was caused by
1636          * an exception.  It was never a reliable flag for that purpose,
1637          * being totally open to false positives even without actual
1638          * clobberage, but was useful enough for production code to
1639          * semantically rely on it.
1640          *
1641          * We'd like to have a proper introspective interface that
1642          * explicitly describes the reason for whatever unwinding
1643          * operations are currently in progress, so that those modules
1644          * work reliably and $@ isn't further overloaded.  But we don't
1645          * have one yet.  In its absence, as a stopgap measure, ERRSV is
1646          * now *additionally* set here, before unwinding, to serve as the
1647          * (unreliable) flag that it used to.
1648          *
1649          * This behaviour is temporary, and should be removed when a
1650          * proper way to detect exceptional unwinding has been developed.
1651          * As of 2010-12, the authors of modules relying on the hack
1652          * are aware of the issue, because the modules failed on
1653          * perls 5.13.{1..7} which had late setting of $@ without this
1654          * early-setting hack.
1655          */
1656         if (!(in_eval & EVAL_KEEPERR)) {
1657             SvTEMP_off(exceptsv);
1658             sv_setsv(ERRSV, exceptsv);
1659         }
1660
1661         if (in_eval & EVAL_KEEPERR) {
1662             Perl_ck_warner(aTHX_ packWARN(WARN_MISC), "\t(in cleanup) %"SVf,
1663                            SVfARG(exceptsv));
1664         }
1665
1666         while ((cxix = dopoptoeval(cxstack_ix)) < 0
1667                && PL_curstackinfo->si_prev)
1668         {
1669             dounwind(-1);
1670             POPSTACK;
1671         }
1672
1673         if (cxix >= 0) {
1674             SV *namesv = NULL;
1675             PERL_CONTEXT *cx;
1676             SV **oldsp;
1677             U8 gimme;
1678             JMPENV *restartjmpenv;
1679             OP *restartop;
1680
1681             if (cxix < cxstack_ix)
1682                 dounwind(cxix);
1683
1684             cx = CX_CUR();
1685             assert(CxTYPE(cx) == CXt_EVAL);
1686
1687             /* return false to the caller of eval */
1688             oldsp = PL_stack_base + cx->blk_oldsp;
1689             gimme = cx->blk_gimme;
1690             if (gimme == G_SCALAR)
1691                 *++oldsp = &PL_sv_undef;
1692             PL_stack_sp = oldsp;
1693
1694             CX_LEAVE_SCOPE(cx);
1695             cx_popeval(cx);
1696             cx_popblock(cx);
1697             restartjmpenv = cx->blk_eval.cur_top_env;
1698             restartop = cx->blk_eval.retop;
1699             if (CxOLD_OP_TYPE(cx) == OP_REQUIRE)
1700                 namesv = cx->blk_eval.old_namesv;
1701             CX_POP(cx);
1702
1703             if (namesv) {
1704                 /* note that unlike pp_entereval, pp_require isn't
1705                  * supposed to trap errors. So now that we've popped the
1706                  * EVAL that pp_require pushed, process the error message
1707                  * and rethrow the error */
1708                 S_undo_inc_then_croak(aTHX_ namesv, exceptsv, FALSE);
1709                 NOT_REACHED; /* NOTREACHED */
1710             }
1711
1712             if (!(in_eval & EVAL_KEEPERR))
1713                 sv_setsv(ERRSV, exceptsv);
1714             PL_restartjmpenv = restartjmpenv;
1715             PL_restartop = restartop;
1716             JMPENV_JUMP(3);
1717             NOT_REACHED; /* NOTREACHED */
1718         }
1719     }
1720
1721     write_to_stderr(exceptsv);
1722     my_failure_exit();
1723     NOT_REACHED; /* NOTREACHED */
1724 }
1725
1726 PP(pp_xor)
1727 {
1728     dSP; dPOPTOPssrl;
1729     if (SvTRUE(left) != SvTRUE(right))
1730         RETSETYES;
1731     else
1732         RETSETNO;
1733 }
1734
1735 /*
1736
1737 =head1 CV Manipulation Functions
1738
1739 =for apidoc caller_cx
1740
1741 The XSUB-writer's equivalent of L<caller()|perlfunc/caller>.  The
1742 returned C<PERL_CONTEXT> structure can be interrogated to find all the
1743 information returned to Perl by C<caller>.  Note that XSUBs don't get a
1744 stack frame, so C<caller_cx(0, NULL)> will return information for the
1745 immediately-surrounding Perl code.
1746
1747 This function skips over the automatic calls to C<&DB::sub> made on the
1748 behalf of the debugger.  If the stack frame requested was a sub called by
1749 C<DB::sub>, the return value will be the frame for the call to
1750 C<DB::sub>, since that has the correct line number/etc. for the call
1751 site.  If I<dbcxp> is non-C<NULL>, it will be set to a pointer to the
1752 frame for the sub call itself.
1753
1754 =cut
1755 */
1756
1757 const PERL_CONTEXT *
1758 Perl_caller_cx(pTHX_ I32 count, const PERL_CONTEXT **dbcxp)
1759 {
1760     I32 cxix = dopoptosub(cxstack_ix);
1761     const PERL_CONTEXT *cx;
1762     const PERL_CONTEXT *ccstack = cxstack;
1763     const PERL_SI *top_si = PL_curstackinfo;
1764
1765     for (;;) {
1766         /* we may be in a higher stacklevel, so dig down deeper */
1767         while (cxix < 0 && top_si->si_type != PERLSI_MAIN) {
1768             top_si = top_si->si_prev;
1769             ccstack = top_si->si_cxstack;
1770             cxix = dopoptosub_at(ccstack, top_si->si_cxix);
1771         }
1772         if (cxix < 0)
1773             return NULL;
1774         /* caller() should not report the automatic calls to &DB::sub */
1775         if (PL_DBsub && GvCV(PL_DBsub) && cxix >= 0 &&
1776                 ccstack[cxix].blk_sub.cv == GvCV(PL_DBsub))
1777             count++;
1778         if (!count--)
1779             break;
1780         cxix = dopoptosub_at(ccstack, cxix - 1);
1781     }
1782
1783     cx = &ccstack[cxix];
1784     if (dbcxp) *dbcxp = cx;
1785
1786     if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT) {
1787         const I32 dbcxix = dopoptosub_at(ccstack, cxix - 1);
1788         /* We expect that ccstack[dbcxix] is CXt_SUB, anyway, the
1789            field below is defined for any cx. */
1790         /* caller() should not report the automatic calls to &DB::sub */
1791         if (PL_DBsub && GvCV(PL_DBsub) && dbcxix >= 0 && ccstack[dbcxix].blk_sub.cv == GvCV(PL_DBsub))
1792             cx = &ccstack[dbcxix];
1793     }
1794
1795     return cx;
1796 }
1797
1798 PP(pp_caller)
1799 {
1800     dSP;
1801     const PERL_CONTEXT *cx;
1802     const PERL_CONTEXT *dbcx;
1803     U8 gimme = GIMME_V;
1804     const HEK *stash_hek;
1805     I32 count = 0;
1806     bool has_arg = MAXARG && TOPs;
1807     const COP *lcop;
1808
1809     if (MAXARG) {
1810       if (has_arg)
1811         count = POPi;
1812       else (void)POPs;
1813     }
1814
1815     cx = caller_cx(count + !!(PL_op->op_private & OPpOFFBYONE), &dbcx);
1816     if (!cx) {
1817         if (gimme != G_ARRAY) {
1818             EXTEND(SP, 1);
1819             RETPUSHUNDEF;
1820         }
1821         RETURN;
1822     }
1823
1824     CX_DEBUG(cx, "CALLER");
1825     assert(CopSTASH(cx->blk_oldcop));
1826     stash_hek = SvTYPE(CopSTASH(cx->blk_oldcop)) == SVt_PVHV
1827       ? HvNAME_HEK((HV*)CopSTASH(cx->blk_oldcop))
1828       : NULL;
1829     if (gimme != G_ARRAY) {
1830         EXTEND(SP, 1);
1831         if (!stash_hek)
1832             PUSHs(&PL_sv_undef);
1833         else {
1834             dTARGET;
1835             sv_sethek(TARG, stash_hek);
1836             PUSHs(TARG);
1837         }
1838         RETURN;
1839     }
1840
1841     EXTEND(SP, 11);
1842
1843     if (!stash_hek)
1844         PUSHs(&PL_sv_undef);
1845     else {
1846         dTARGET;
1847         sv_sethek(TARG, stash_hek);
1848         PUSHTARG;
1849     }
1850     mPUSHs(newSVpv(OutCopFILE(cx->blk_oldcop), 0));
1851     lcop = closest_cop(cx->blk_oldcop, OpSIBLING(cx->blk_oldcop),
1852                        cx->blk_sub.retop, TRUE);
1853     if (!lcop)
1854         lcop = cx->blk_oldcop;
1855     mPUSHu(CopLINE(lcop));
1856     if (!has_arg)
1857         RETURN;
1858     if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT) {
1859         /* So is ccstack[dbcxix]. */
1860         if (CvHASGV(dbcx->blk_sub.cv)) {
1861             PUSHs(cv_name(dbcx->blk_sub.cv, 0, 0));
1862             PUSHs(boolSV(CxHASARGS(cx)));
1863         }
1864         else {
1865             PUSHs(newSVpvs_flags("(unknown)", SVs_TEMP));
1866             PUSHs(boolSV(CxHASARGS(cx)));
1867         }
1868     }
1869     else {
1870         PUSHs(newSVpvs_flags("(eval)", SVs_TEMP));
1871         mPUSHi(0);
1872     }
1873     gimme = cx->blk_gimme;
1874     if (gimme == G_VOID)
1875         PUSHs(&PL_sv_undef);
1876     else
1877         PUSHs(boolSV((gimme & G_WANT) == G_ARRAY));
1878     if (CxTYPE(cx) == CXt_EVAL) {
1879         /* eval STRING */
1880         if (CxOLD_OP_TYPE(cx) == OP_ENTEREVAL) {
1881             SV *cur_text = cx->blk_eval.cur_text;
1882             if (SvCUR(cur_text) >= 2) {
1883                 PUSHs(newSVpvn_flags(SvPVX(cur_text), SvCUR(cur_text)-2,
1884                                      SvUTF8(cur_text)|SVs_TEMP));
1885             }
1886             else {
1887                 /* I think this is will always be "", but be sure */
1888                 PUSHs(sv_2mortal(newSVsv(cur_text)));
1889             }
1890
1891             PUSHs(&PL_sv_no);
1892         }
1893         /* require */
1894         else if (cx->blk_eval.old_namesv) {
1895             mPUSHs(newSVsv(cx->blk_eval.old_namesv));
1896             PUSHs(&PL_sv_yes);
1897         }
1898         /* eval BLOCK (try blocks have old_namesv == 0) */
1899         else {
1900             PUSHs(&PL_sv_undef);
1901             PUSHs(&PL_sv_undef);
1902         }
1903     }
1904     else {
1905         PUSHs(&PL_sv_undef);
1906         PUSHs(&PL_sv_undef);
1907     }
1908     if (CxTYPE(cx) == CXt_SUB && CxHASARGS(cx)
1909         && CopSTASH_eq(PL_curcop, PL_debstash))
1910     {
1911         /* slot 0 of the pad contains the original @_ */
1912         AV * const ary = MUTABLE_AV(AvARRAY(MUTABLE_AV(
1913                             PadlistARRAY(CvPADLIST(cx->blk_sub.cv))[
1914                                 cx->blk_sub.olddepth+1]))[0]);
1915         const SSize_t off = AvARRAY(ary) - AvALLOC(ary);
1916
1917         Perl_init_dbargs(aTHX);
1918
1919         if (AvMAX(PL_dbargs) < AvFILLp(ary) + off)
1920             av_extend(PL_dbargs, AvFILLp(ary) + off);
1921         Copy(AvALLOC(ary), AvARRAY(PL_dbargs), AvFILLp(ary) + 1 + off, SV*);
1922         AvFILLp(PL_dbargs) = AvFILLp(ary) + off;
1923     }
1924     mPUSHi(CopHINTS_get(cx->blk_oldcop));
1925     {
1926         SV * mask ;
1927         STRLEN * const old_warnings = cx->blk_oldcop->cop_warnings ;
1928
1929         if  (old_warnings == pWARN_NONE)
1930             mask = newSVpvn(WARN_NONEstring, WARNsize) ;
1931         else if (old_warnings == pWARN_STD && (PL_dowarn & G_WARN_ON) == 0)
1932             mask = &PL_sv_undef ;
1933         else if (old_warnings == pWARN_ALL ||
1934                   (old_warnings == pWARN_STD && PL_dowarn & G_WARN_ON)) {
1935             /* Get the bit mask for $warnings::Bits{all}, because
1936              * it could have been extended by warnings::register */
1937             SV **bits_all;
1938             HV * const bits = get_hv("warnings::Bits", 0);
1939             if (bits && (bits_all=hv_fetchs(bits, "all", FALSE))) {
1940                 mask = newSVsv(*bits_all);
1941             }
1942             else {
1943                 mask = newSVpvn(WARN_ALLstring, WARNsize) ;
1944             }
1945         }
1946         else
1947             mask = newSVpvn((char *) (old_warnings + 1), old_warnings[0]);
1948         mPUSHs(mask);
1949     }
1950
1951     PUSHs(cx->blk_oldcop->cop_hints_hash ?
1952           sv_2mortal(newRV_noinc(MUTABLE_SV(cop_hints_2hv(cx->blk_oldcop, 0))))
1953           : &PL_sv_undef);
1954     RETURN;
1955 }
1956
1957 PP(pp_reset)
1958 {
1959     dSP;
1960     const char * tmps;
1961     STRLEN len = 0;
1962     if (MAXARG < 1 || (!TOPs && !POPs))
1963         tmps = NULL, len = 0;
1964     else
1965         tmps = SvPVx_const(POPs, len);
1966     sv_resetpvn(tmps, len, CopSTASH(PL_curcop));
1967     PUSHs(&PL_sv_yes);
1968     RETURN;
1969 }
1970
1971 /* like pp_nextstate, but used instead when the debugger is active */
1972
1973 PP(pp_dbstate)
1974 {
1975     PL_curcop = (COP*)PL_op;
1976     TAINT_NOT;          /* Each statement is presumed innocent */
1977     PL_stack_sp = PL_stack_base + CX_CUR()->blk_oldsp;
1978     FREETMPS;
1979
1980     PERL_ASYNC_CHECK();
1981
1982     if (PL_op->op_flags & OPf_SPECIAL /* breakpoint */
1983             || PL_DBsingle_iv || PL_DBsignal_iv || PL_DBtrace_iv)
1984     {
1985         dSP;
1986         PERL_CONTEXT *cx;
1987         const U8 gimme = G_ARRAY;
1988         GV * const gv = PL_DBgv;
1989         CV * cv = NULL;
1990
1991         if (gv && isGV_with_GP(gv))
1992             cv = GvCV(gv);
1993
1994         if (!cv || (!CvROOT(cv) && !CvXSUB(cv)))
1995             DIE(aTHX_ "No DB::DB routine defined");
1996
1997         if (CvDEPTH(cv) >= 1 && !(PL_debug & DEBUG_DB_RECURSE_FLAG))
1998             /* don't do recursive DB::DB call */
1999             return NORMAL;
2000
2001         if (CvISXSUB(cv)) {
2002             ENTER;
2003             SAVEI32(PL_debug);
2004             PL_debug = 0;
2005             SAVESTACK_POS();
2006             SAVETMPS;
2007             PUSHMARK(SP);
2008             (void)(*CvXSUB(cv))(aTHX_ cv);
2009             FREETMPS;
2010             LEAVE;
2011             return NORMAL;
2012         }
2013         else {
2014             cx = cx_pushblock(CXt_SUB, gimme, SP, PL_savestack_ix);
2015             cx_pushsub(cx, cv, PL_op->op_next, 0);
2016             /* OP_DBSTATE's op_private holds hint bits rather than
2017              * the lvalue-ish flags seen in OP_ENTERSUB. So cancel
2018              * any CxLVAL() flags that have now been mis-calculated */
2019             cx->blk_u16 = 0;
2020
2021             SAVEI32(PL_debug);
2022             PL_debug = 0;
2023             SAVESTACK_POS();
2024             CvDEPTH(cv)++;
2025             if (CvDEPTH(cv) >= 2)
2026                 pad_push(CvPADLIST(cv), CvDEPTH(cv));
2027             PAD_SET_CUR_NOSAVE(CvPADLIST(cv), CvDEPTH(cv));
2028             RETURNOP(CvSTART(cv));
2029         }
2030     }
2031     else
2032         return NORMAL;
2033 }
2034
2035
2036 PP(pp_enter)
2037 {
2038     dSP;
2039     U8 gimme = GIMME_V;
2040
2041     (void)cx_pushblock(CXt_BLOCK, gimme, SP, PL_savestack_ix);
2042
2043     RETURN;
2044 }
2045
2046 PP(pp_leave)
2047 {
2048     PERL_CONTEXT *cx;
2049     SV **oldsp;
2050     U8 gimme;
2051
2052     cx = CX_CUR();
2053     assert(CxTYPE(cx) == CXt_BLOCK);
2054
2055     if (PL_op->op_flags & OPf_SPECIAL)
2056         cx->blk_oldpm = PL_curpm; /* fake block should preserve $1 et al */
2057
2058     oldsp = PL_stack_base + cx->blk_oldsp;
2059     gimme = cx->blk_gimme;
2060
2061     if (gimme == G_VOID)
2062         PL_stack_sp = oldsp;
2063     else
2064         leave_adjust_stacks(oldsp, oldsp, gimme,
2065                                 PL_op->op_private & OPpLVALUE ? 3 : 1);
2066
2067     CX_LEAVE_SCOPE(cx);
2068     cx_popblock(cx);
2069     CX_POP(cx);
2070
2071     return NORMAL;
2072 }
2073
2074 static bool
2075 S_outside_integer(pTHX_ SV *sv)
2076 {
2077   if (SvOK(sv)) {
2078     const NV nv = SvNV_nomg(sv);
2079     if (Perl_isinfnan(nv))
2080       return TRUE;
2081 #ifdef NV_PRESERVES_UV
2082     if (nv < (NV)IV_MIN || nv > (NV)IV_MAX)
2083       return TRUE;
2084 #else
2085     if (nv <= (NV)IV_MIN)
2086       return TRUE;
2087     if ((nv > 0) &&
2088         ((nv > (NV)UV_MAX ||
2089           SvUV_nomg(sv) > (UV)IV_MAX)))
2090       return TRUE;
2091 #endif
2092   }
2093   return FALSE;
2094 }
2095
2096 PP(pp_enteriter)
2097 {
2098     dSP; dMARK;
2099     PERL_CONTEXT *cx;
2100     const U8 gimme = GIMME_V;
2101     void *itervarp; /* GV or pad slot of the iteration variable */
2102     SV   *itersave; /* the old var in the iterator var slot */
2103     U8 cxflags = 0;
2104
2105     if (PL_op->op_targ) {                        /* "my" variable */
2106         itervarp = &PAD_SVl(PL_op->op_targ);
2107         itersave = *(SV**)itervarp;
2108         assert(itersave);
2109         if (PL_op->op_private & OPpLVAL_INTRO) {        /* for my $x (...) */
2110             /* the SV currently in the pad slot is never live during
2111              * iteration (the slot is always aliased to one of the items)
2112              * so it's always stale */
2113             SvPADSTALE_on(itersave);
2114         }
2115         SvREFCNT_inc_simple_void_NN(itersave);
2116         cxflags = CXp_FOR_PAD;
2117     }
2118     else {
2119         SV * const sv = POPs;
2120         itervarp = (void *)sv;
2121         if (LIKELY(isGV(sv))) {         /* symbol table variable */
2122             itersave = GvSV(sv);
2123             SvREFCNT_inc_simple_void(itersave);
2124             cxflags = CXp_FOR_GV;
2125             if (PL_op->op_private & OPpITER_DEF)
2126                 cxflags |= CXp_FOR_DEF;
2127         }
2128         else {                          /* LV ref: for \$foo (...) */
2129             assert(SvTYPE(sv) == SVt_PVMG);
2130             assert(SvMAGIC(sv));
2131             assert(SvMAGIC(sv)->mg_type == PERL_MAGIC_lvref);
2132             itersave = NULL;
2133             cxflags = CXp_FOR_LVREF;
2134         }
2135     }
2136     /* OPpITER_DEF (implicit $_) should only occur with a GV iter var */
2137     assert((cxflags & CXp_FOR_GV) || !(PL_op->op_private & OPpITER_DEF));
2138
2139     /* Note that this context is initially set as CXt_NULL. Further on
2140      * down it's changed to one of the CXt_LOOP_*. Before it's changed,
2141      * there mustn't be anything in the blk_loop substruct that requires
2142      * freeing or undoing, in case we die in the meantime. And vice-versa.
2143      */
2144     cx = cx_pushblock(cxflags, gimme, MARK, PL_savestack_ix);
2145     cx_pushloop_for(cx, itervarp, itersave);
2146
2147     if (PL_op->op_flags & OPf_STACKED) {
2148         /* OPf_STACKED implies either a single array: for(@), with a
2149          * single AV on the stack, or a range: for (1..5), with 1 and 5 on
2150          * the stack */
2151         SV *maybe_ary = POPs;
2152         if (SvTYPE(maybe_ary) != SVt_PVAV) {
2153             /* range */
2154             dPOPss;
2155             SV * const right = maybe_ary;
2156             if (UNLIKELY(cxflags & CXp_FOR_LVREF))
2157                 DIE(aTHX_ "Assigned value is not a reference");
2158             SvGETMAGIC(sv);
2159             SvGETMAGIC(right);
2160             if (RANGE_IS_NUMERIC(sv,right)) {
2161                 cx->cx_type |= CXt_LOOP_LAZYIV;
2162                 if (S_outside_integer(aTHX_ sv) ||
2163                     S_outside_integer(aTHX_ right))
2164                     DIE(aTHX_ "Range iterator outside integer range");
2165                 cx->blk_loop.state_u.lazyiv.cur = SvIV_nomg(sv);
2166                 cx->blk_loop.state_u.lazyiv.end = SvIV_nomg(right);
2167             }
2168             else {
2169                 cx->cx_type |= CXt_LOOP_LAZYSV;
2170                 cx->blk_loop.state_u.lazysv.cur = newSVsv(sv);
2171                 cx->blk_loop.state_u.lazysv.end = right;
2172                 SvREFCNT_inc_simple_void_NN(right);
2173                 (void) SvPV_force_nolen(cx->blk_loop.state_u.lazysv.cur);
2174                 /* This will do the upgrade to SVt_PV, and warn if the value
2175                    is uninitialised.  */
2176                 (void) SvPV_nolen_const(right);
2177                 /* Doing this avoids a check every time in pp_iter in pp_hot.c
2178                    to replace !SvOK() with a pointer to "".  */
2179                 if (!SvOK(right)) {
2180                     SvREFCNT_dec(right);
2181                     cx->blk_loop.state_u.lazysv.end = &PL_sv_no;
2182                 }
2183             }
2184         }
2185         else /* SvTYPE(maybe_ary) == SVt_PVAV */ {
2186             /* for (@array) {} */
2187             cx->cx_type |= CXt_LOOP_ARY;
2188             cx->blk_loop.state_u.ary.ary = MUTABLE_AV(maybe_ary);
2189             SvREFCNT_inc_simple_void_NN(maybe_ary);
2190             cx->blk_loop.state_u.ary.ix =
2191                 (PL_op->op_private & OPpITER_REVERSED) ?
2192                 AvFILL(cx->blk_loop.state_u.ary.ary) + 1 :
2193                 -1;
2194         }
2195         /* EXTEND(SP, 1) not needed in this branch because we just did POPs */
2196     }
2197     else { /* iterating over items on the stack */
2198         cx->cx_type |= CXt_LOOP_LIST;
2199         cx->blk_oldsp = SP - PL_stack_base;
2200         cx->blk_loop.state_u.stack.basesp = MARK - PL_stack_base;
2201         cx->blk_loop.state_u.stack.ix =
2202             (PL_op->op_private & OPpITER_REVERSED)
2203                 ? cx->blk_oldsp + 1
2204                 : cx->blk_loop.state_u.stack.basesp;
2205         /* pre-extend stack so pp_iter doesn't have to check every time
2206          * it pushes yes/no */
2207         EXTEND(SP, 1);
2208     }
2209
2210     RETURN;
2211 }
2212
2213 PP(pp_enterloop)
2214 {
2215     dSP;
2216     PERL_CONTEXT *cx;
2217     const U8 gimme = GIMME_V;
2218
2219     cx = cx_pushblock(CXt_LOOP_PLAIN, gimme, SP, PL_savestack_ix);
2220     cx_pushloop_plain(cx);
2221
2222     RETURN;
2223 }
2224
2225 PP(pp_leaveloop)
2226 {
2227     PERL_CONTEXT *cx;
2228     U8 gimme;
2229     SV **oldsp;
2230     SV **mark;
2231
2232     cx = CX_CUR();
2233     assert(CxTYPE_is_LOOP(cx));
2234     mark = PL_stack_base + cx->blk_oldsp;
2235     oldsp = CxTYPE(cx) == CXt_LOOP_LIST
2236                 ? PL_stack_base + cx->blk_loop.state_u.stack.basesp
2237                 : mark;
2238     gimme = cx->blk_gimme;
2239
2240     if (gimme == G_VOID)
2241         PL_stack_sp = oldsp;
2242     else
2243         leave_adjust_stacks(MARK, oldsp, gimme,
2244                                 PL_op->op_private & OPpLVALUE ? 3 : 1);
2245
2246     CX_LEAVE_SCOPE(cx);
2247     cx_poploop(cx);     /* Stack values are safe: release loop vars ... */
2248     cx_popblock(cx);
2249     CX_POP(cx);
2250
2251     return NORMAL;
2252 }
2253
2254
2255 /* This duplicates most of pp_leavesub, but with additional code to handle
2256  * return args in lvalue context. It was forked from pp_leavesub to
2257  * avoid slowing down that function any further.
2258  *
2259  * Any changes made to this function may need to be copied to pp_leavesub
2260  * and vice-versa.
2261  */
2262
2263 PP(pp_leavesublv)
2264 {
2265     U8 gimme;
2266     PERL_CONTEXT *cx;
2267     SV **oldsp;
2268     OP *retop;
2269
2270     cx = CX_CUR();
2271     assert(CxTYPE(cx) == CXt_SUB);
2272
2273     if (CxMULTICALL(cx)) {
2274         /* entry zero of a stack is always PL_sv_undef, which
2275          * simplifies converting a '()' return into undef in scalar context */
2276         assert(PL_stack_sp > PL_stack_base || *PL_stack_base == &PL_sv_undef);
2277         return 0;
2278     }
2279
2280     gimme = cx->blk_gimme;
2281     oldsp = PL_stack_base + cx->blk_oldsp; /* last arg of previous frame */
2282
2283     if (gimme == G_VOID)
2284         PL_stack_sp = oldsp;
2285     else {
2286         U8   lval    = CxLVAL(cx);
2287         bool is_lval = (lval && !(lval & OPpENTERSUB_INARGS));
2288         const char *what = NULL;
2289
2290         if (gimme == G_SCALAR) {
2291             if (is_lval) {
2292                 /* check for bad return arg */
2293                 if (oldsp < PL_stack_sp) {
2294                     SV *sv = *PL_stack_sp;
2295                     if ((SvPADTMP(sv) || SvREADONLY(sv))) {
2296                         what =
2297                             SvREADONLY(sv) ? (sv == &PL_sv_undef) ? "undef"
2298                             : "a readonly value" : "a temporary";
2299                     }
2300                     else goto ok;
2301                 }
2302                 else {
2303                     /* sub:lvalue{} will take us here. */
2304                     what = "undef";
2305                 }
2306               croak:
2307                 Perl_croak(aTHX_
2308                           "Can't return %s from lvalue subroutine", what);
2309             }
2310
2311           ok:
2312             leave_adjust_stacks(oldsp, oldsp, gimme, is_lval ? 3 : 2);
2313
2314             if (lval & OPpDEREF) {
2315                 /* lval_sub()->{...} and similar */
2316                 dSP;
2317                 SvGETMAGIC(TOPs);
2318                 if (!SvOK(TOPs)) {
2319                     TOPs = vivify_ref(TOPs, CxLVAL(cx) & OPpDEREF);
2320                 }
2321                 PUTBACK;
2322             }
2323         }
2324         else {
2325             assert(gimme == G_ARRAY);
2326             assert (!(lval & OPpDEREF));
2327
2328             if (is_lval) {
2329                 /* scan for bad return args */
2330                 SV **p;
2331                 for (p = PL_stack_sp; p > oldsp; p--) {
2332                     SV *sv = *p;
2333                     /* the PL_sv_undef exception is to allow things like
2334                      * this to work, where PL_sv_undef acts as 'skip'
2335                      * placeholder on the LHS of list assigns:
2336                      *    sub foo :lvalue { undef }
2337                      *    ($a, undef, foo(), $b) = 1..4;
2338                      */
2339                     if (sv != &PL_sv_undef && (SvPADTMP(sv) || SvREADONLY(sv)))
2340                     {
2341                         /* Might be flattened array after $#array =  */
2342                         what = SvREADONLY(sv)
2343                                 ? "a readonly value" : "a temporary";
2344                         goto croak;
2345                     }
2346                 }
2347             }
2348
2349             leave_adjust_stacks(oldsp, oldsp, gimme, is_lval ? 3 : 2);
2350         }
2351     }
2352
2353     CX_LEAVE_SCOPE(cx);
2354     cx_popsub(cx);      /* Stack values are safe: release CV and @_ ... */
2355     cx_popblock(cx);
2356     retop =  cx->blk_sub.retop;
2357     CX_POP(cx);
2358
2359     return retop;
2360 }
2361
2362
2363 PP(pp_return)
2364 {
2365     dSP; dMARK;
2366     PERL_CONTEXT *cx;
2367     const I32 cxix = dopoptosub(cxstack_ix);
2368
2369     assert(cxstack_ix >= 0);
2370     if (cxix < cxstack_ix) {
2371         if (cxix < 0) {
2372             if (!(       PL_curstackinfo->si_type == PERLSI_SORT
2373                   || (   PL_curstackinfo->si_type == PERLSI_MULTICALL
2374                       && (cxstack[0].cx_type & CXp_SUB_RE_FAKE))
2375                  )
2376             )
2377                 DIE(aTHX_ "Can't return outside a subroutine");
2378             /* We must be in:
2379              *  a sort block, which is a CXt_NULL not a CXt_SUB;
2380              *  or a /(?{...})/ block.
2381              * Handle specially. */
2382             assert(CxTYPE(&cxstack[0]) == CXt_NULL
2383                     || (   CxTYPE(&cxstack[0]) == CXt_SUB
2384                         && (cxstack[0].cx_type & CXp_SUB_RE_FAKE)));
2385             if (cxstack_ix > 0) {
2386                 /* See comment below about context popping. Since we know
2387                  * we're scalar and not lvalue, we can preserve the return
2388                  * value in a simpler fashion than there. */
2389                 SV *sv = *SP;
2390                 assert(cxstack[0].blk_gimme == G_SCALAR);
2391                 if (   (sp != PL_stack_base)
2392                     && !(SvFLAGS(sv) & (SVs_TEMP|SVs_PADTMP))
2393                 )
2394                     *SP = sv_mortalcopy(sv);
2395                 dounwind(0);
2396             }
2397             /* caller responsible for popping cxstack[0] */
2398             return 0;
2399         }
2400
2401         /* There are contexts that need popping. Doing this may free the
2402          * return value(s), so preserve them first, e.g. popping the plain
2403          * loop here would free $x:
2404          *     sub f {  { my $x = 1; return $x } }
2405          * We may also need to shift the args down; for example,
2406          *    for (1,2) { return 3,4 }
2407          * leaves 1,2,3,4 on the stack. Both these actions can be done by
2408          * leave_adjust_stacks().  By calling it with and lvalue "pass
2409          * all" action, we just bump the ref count and mortalise the args
2410          * that need it, do a FREETMPS.  The "scan the args and maybe copy
2411          * them" process will be repeated by whoever we tail-call (e.g.
2412          * pp_leaveeval), where any copying etc will be done. That is to
2413          * say, in this code path two scans of the args will be done; the
2414          * first just shifts and preserves; the second is the "real" arg
2415          * processing, based on the type of return.
2416          */
2417         cx = &cxstack[cxix];
2418         PUTBACK;
2419         if (cx->blk_gimme != G_VOID)
2420             leave_adjust_stacks(MARK, PL_stack_base + cx->blk_oldsp,
2421                     cx->blk_gimme,
2422                     CxTYPE(cx) == CXt_SUB && CvLVALUE(cx->blk_sub.cv)
2423                         ? 3 : 0);
2424         SPAGAIN;
2425         dounwind(cxix);
2426         cx = &cxstack[cxix]; /* CX stack may have been realloced */
2427     }
2428     else {
2429         /* Like in the branch above, we need to handle any extra junk on
2430          * the stack. But because we're not also popping extra contexts, we
2431          * don't have to worry about prematurely freeing args. So we just
2432          * need to do the bare minimum to handle junk, and leave the main
2433          * arg processing in the function we tail call, e.g. pp_leavesub.
2434          * In list context we have to splice out the junk; in scalar
2435          * context we can leave as-is (pp_leavesub will later return the
2436          * top stack element). But for an  empty arg list, e.g.
2437          *    for (1,2) { return }
2438          * we need to set sp = oldsp so that pp_leavesub knows to push
2439          * &PL_sv_undef onto the stack.
2440          */
2441         SV **oldsp;
2442         cx = &cxstack[cxix];
2443         oldsp = PL_stack_base + cx->blk_oldsp;
2444         if (oldsp != MARK) {
2445             SSize_t nargs = SP - MARK;
2446             if (nargs) {
2447                 if (cx->blk_gimme == G_ARRAY) {
2448                     /* shift return args to base of call stack frame */
2449                     Move(MARK + 1, oldsp + 1, nargs, SV*);
2450                     PL_stack_sp  = oldsp + nargs;
2451                 }
2452             }
2453             else
2454                 PL_stack_sp  = oldsp;
2455         }
2456     }
2457
2458     /* fall through to a normal exit */
2459     switch (CxTYPE(cx)) {
2460     case CXt_EVAL:
2461         return CxTRYBLOCK(cx)
2462             ? Perl_pp_leavetry(aTHX)
2463             : Perl_pp_leaveeval(aTHX);
2464     case CXt_SUB:
2465         return CvLVALUE(cx->blk_sub.cv)
2466             ? Perl_pp_leavesublv(aTHX)
2467             : Perl_pp_leavesub(aTHX);
2468     case CXt_FORMAT:
2469         return Perl_pp_leavewrite(aTHX);
2470     default:
2471         DIE(aTHX_ "panic: return, type=%u", (unsigned) CxTYPE(cx));
2472     }
2473 }
2474
2475 /* find the enclosing loop or labelled loop and dounwind() back to it. */
2476
2477 static PERL_CONTEXT *
2478 S_unwind_loop(pTHX)
2479 {
2480     I32 cxix;
2481     if (PL_op->op_flags & OPf_SPECIAL) {
2482         cxix = dopoptoloop(cxstack_ix);
2483         if (cxix < 0)
2484             /* diag_listed_as: Can't "last" outside a loop block */
2485             Perl_croak(aTHX_ "Can't \"%s\" outside a loop block",
2486                 OP_NAME(PL_op));
2487     }
2488     else {
2489         dSP;
2490         STRLEN label_len;
2491         const char * const label =
2492             PL_op->op_flags & OPf_STACKED
2493                 ? SvPV(TOPs,label_len)
2494                 : (label_len = strlen(cPVOP->op_pv), cPVOP->op_pv);
2495         const U32 label_flags =
2496             PL_op->op_flags & OPf_STACKED
2497                 ? SvUTF8(POPs)
2498                 : (cPVOP->op_private & OPpPV_IS_UTF8) ? SVf_UTF8 : 0;
2499         PUTBACK;
2500         cxix = dopoptolabel(label, label_len, label_flags);
2501         if (cxix < 0)
2502             /* diag_listed_as: Label not found for "last %s" */
2503             Perl_croak(aTHX_ "Label not found for \"%s %"SVf"\"",
2504                                        OP_NAME(PL_op),
2505                                        SVfARG(PL_op->op_flags & OPf_STACKED
2506                                               && !SvGMAGICAL(TOPp1s)
2507                                               ? TOPp1s
2508                                               : newSVpvn_flags(label,
2509                                                     label_len,
2510                                                     label_flags | SVs_TEMP)));
2511     }
2512     if (cxix < cxstack_ix)
2513         dounwind(cxix);
2514     return &cxstack[cxix];
2515 }
2516
2517
2518 PP(pp_last)
2519 {
2520     PERL_CONTEXT *cx;
2521     OP* nextop;
2522
2523     cx = S_unwind_loop(aTHX);
2524
2525     assert(CxTYPE_is_LOOP(cx));
2526     PL_stack_sp = PL_stack_base
2527                 + (CxTYPE(cx) == CXt_LOOP_LIST
2528                     ?  cx->blk_loop.state_u.stack.basesp
2529                     : cx->blk_oldsp
2530                 );
2531
2532     TAINT_NOT;
2533
2534     /* Stack values are safe: */
2535     CX_LEAVE_SCOPE(cx);
2536     cx_poploop(cx);     /* release loop vars ... */
2537     cx_popblock(cx);
2538     nextop = cx->blk_loop.my_op->op_lastop->op_next;
2539     CX_POP(cx);
2540
2541     return nextop;
2542 }
2543
2544 PP(pp_next)
2545 {
2546     PERL_CONTEXT *cx;
2547
2548     /* if not a bare 'next' in the main scope, search for it */
2549     cx = CX_CUR();
2550     if (!((PL_op->op_flags & OPf_SPECIAL) && CxTYPE_is_LOOP(cx)))
2551         cx = S_unwind_loop(aTHX);
2552
2553     cx_topblock(cx);
2554     PL_curcop = cx->blk_oldcop;
2555     PERL_ASYNC_CHECK();
2556     return (cx)->blk_loop.my_op->op_nextop;
2557 }
2558
2559 PP(pp_redo)
2560 {
2561     PERL_CONTEXT *cx = S_unwind_loop(aTHX);
2562     OP* redo_op = cx->blk_loop.my_op->op_redoop;
2563
2564     if (redo_op->op_type == OP_ENTER) {
2565         /* pop one less context to avoid $x being freed in while (my $x..) */
2566         cxstack_ix++;
2567         cx = CX_CUR();
2568         assert(CxTYPE(cx) == CXt_BLOCK);
2569         redo_op = redo_op->op_next;
2570     }
2571
2572     FREETMPS;
2573     CX_LEAVE_SCOPE(cx);
2574     cx_topblock(cx);
2575     PL_curcop = cx->blk_oldcop;
2576     PERL_ASYNC_CHECK();
2577     return redo_op;
2578 }
2579
2580 STATIC OP *
2581 S_dofindlabel(pTHX_ OP *o, const char *label, STRLEN len, U32 flags, OP **opstack, OP **oplimit)
2582 {
2583     OP **ops = opstack;
2584     static const char* const too_deep = "Target of goto is too deeply nested";
2585
2586     PERL_ARGS_ASSERT_DOFINDLABEL;
2587
2588     if (ops >= oplimit)
2589         Perl_croak(aTHX_ "%s", too_deep);
2590     if (o->op_type == OP_LEAVE ||
2591         o->op_type == OP_SCOPE ||
2592         o->op_type == OP_LEAVELOOP ||
2593         o->op_type == OP_LEAVESUB ||
2594         o->op_type == OP_LEAVETRY)
2595     {
2596         *ops++ = cUNOPo->op_first;
2597         if (ops >= oplimit)
2598             Perl_croak(aTHX_ "%s", too_deep);
2599     }
2600     *ops = 0;
2601     if (o->op_flags & OPf_KIDS) {
2602         OP *kid;
2603         /* First try all the kids at this level, since that's likeliest. */
2604         for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
2605             if (kid->op_type == OP_NEXTSTATE || kid->op_type == OP_DBSTATE) {
2606                 STRLEN kid_label_len;
2607                 U32 kid_label_flags;
2608                 const char *kid_label = CopLABEL_len_flags(kCOP,
2609                                                     &kid_label_len, &kid_label_flags);
2610                 if (kid_label && (
2611                     ( (kid_label_flags & SVf_UTF8) != (flags & SVf_UTF8) ) ?
2612                         (flags & SVf_UTF8)
2613                             ? (bytes_cmp_utf8(
2614                                         (const U8*)kid_label, kid_label_len,
2615                                         (const U8*)label, len) == 0)
2616                             : (bytes_cmp_utf8(
2617                                         (const U8*)label, len,
2618                                         (const U8*)kid_label, kid_label_len) == 0)
2619                     : ( len == kid_label_len && ((kid_label == label)
2620                                     || memEQ(kid_label, label, len)))))
2621                     return kid;
2622             }
2623         }
2624         for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
2625             if (kid == PL_lastgotoprobe)
2626                 continue;
2627             if (kid->op_type == OP_NEXTSTATE || kid->op_type == OP_DBSTATE) {
2628                 if (ops == opstack)
2629                     *ops++ = kid;
2630                 else if (ops[-1]->op_type == OP_NEXTSTATE ||
2631                          ops[-1]->op_type == OP_DBSTATE)
2632                     ops[-1] = kid;
2633                 else
2634                     *ops++ = kid;
2635             }
2636             if ((o = dofindlabel(kid, label, len, flags, ops, oplimit)))
2637                 return o;
2638         }
2639     }
2640     *ops = 0;
2641     return 0;
2642 }
2643
2644
2645 /* also used for: pp_dump() */
2646
2647 PP(pp_goto)
2648 {
2649     dVAR; dSP;
2650     OP *retop = NULL;
2651     I32 ix;
2652     PERL_CONTEXT *cx;
2653 #define GOTO_DEPTH 64
2654     OP *enterops[GOTO_DEPTH];
2655     const char *label = NULL;
2656     STRLEN label_len = 0;
2657     U32 label_flags = 0;
2658     const bool do_dump = (PL_op->op_type == OP_DUMP);
2659     static const char* const must_have_label = "goto must have label";
2660
2661     if (PL_op->op_flags & OPf_STACKED) {
2662         /* goto EXPR  or  goto &foo */
2663
2664         SV * const sv = POPs;
2665         SvGETMAGIC(sv);
2666
2667         if (SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVCV) {
2668             /* This egregious kludge implements goto &subroutine */
2669             I32 cxix;
2670             PERL_CONTEXT *cx;
2671             CV *cv = MUTABLE_CV(SvRV(sv));
2672             AV *arg = GvAV(PL_defgv);
2673
2674             while (!CvROOT(cv) && !CvXSUB(cv)) {
2675                 const GV * const gv = CvGV(cv);
2676                 if (gv) {
2677                     GV *autogv;
2678                     SV *tmpstr;
2679                     /* autoloaded stub? */
2680                     if (cv != GvCV(gv) && (cv = GvCV(gv)))
2681                         continue;
2682                     autogv = gv_autoload_pvn(GvSTASH(gv), GvNAME(gv),
2683                                           GvNAMELEN(gv),
2684                                           GvNAMEUTF8(gv) ? SVf_UTF8 : 0);
2685                     if (autogv && (cv = GvCV(autogv)))
2686                         continue;
2687                     tmpstr = sv_newmortal();
2688                     gv_efullname3(tmpstr, gv, NULL);
2689                     DIE(aTHX_ "Goto undefined subroutine &%"SVf"", SVfARG(tmpstr));
2690                 }
2691                 DIE(aTHX_ "Goto undefined subroutine");
2692             }
2693
2694             cxix = dopoptosub(cxstack_ix);
2695             if (cxix < 0) {
2696                 DIE(aTHX_ "Can't goto subroutine outside a subroutine");
2697             }
2698             cx  = &cxstack[cxix];
2699             /* ban goto in eval: see <20050521150056.GC20213@iabyn.com> */
2700             if (CxTYPE(cx) == CXt_EVAL) {
2701                 if (CxREALEVAL(cx))
2702                 /* diag_listed_as: Can't goto subroutine from an eval-%s */
2703                     DIE(aTHX_ "Can't goto subroutine from an eval-string");
2704                 else
2705                 /* diag_listed_as: Can't goto subroutine from an eval-%s */
2706                     DIE(aTHX_ "Can't goto subroutine from an eval-block");
2707             }
2708             else if (CxMULTICALL(cx))
2709                 DIE(aTHX_ "Can't goto subroutine from a sort sub (or similar callback)");
2710
2711             /* First do some returnish stuff. */
2712
2713             SvREFCNT_inc_simple_void(cv); /* avoid premature free during unwind */
2714             FREETMPS;
2715             if (cxix < cxstack_ix) {
2716                 dounwind(cxix);
2717             }
2718             cx = CX_CUR();
2719             cx_topblock(cx);
2720             SPAGAIN;
2721
2722             /* protect @_ during save stack unwind. */
2723             if (arg)
2724                 SvREFCNT_inc_NN(sv_2mortal(MUTABLE_SV(arg)));
2725
2726             assert(PL_scopestack_ix == cx->blk_oldscopesp);
2727             CX_LEAVE_SCOPE(cx);
2728
2729             if (CxTYPE(cx) == CXt_SUB && CxHASARGS(cx)) {
2730                 /* this is part of cx_popsub_args() */
2731                 AV* av = MUTABLE_AV(PAD_SVl(0));
2732                 assert(AvARRAY(MUTABLE_AV(
2733                     PadlistARRAY(CvPADLIST(cx->blk_sub.cv))[
2734                             CvDEPTH(cx->blk_sub.cv)])) == PL_curpad);
2735
2736                 /* we are going to donate the current @_ from the old sub
2737                  * to the new sub. This first part of the donation puts a
2738                  * new empty AV in the pad[0] slot of the old sub,
2739                  * unless pad[0] and @_ differ (e.g. if the old sub did
2740                  * local *_ = []); in which case clear the old pad[0]
2741                  * array in the usual way */
2742                 if (av == arg || AvREAL(av))
2743                     clear_defarray(av, av == arg);
2744                 else CLEAR_ARGARRAY(av);
2745             }
2746
2747             /* don't restore PL_comppad here. It won't be needed if the
2748              * sub we're going to is non-XS, but restoring it early then
2749              * croaking (e.g. the "Goto undefined subroutine" below)
2750              * means the CX block gets processed again in dounwind,
2751              * but this time with the wrong PL_comppad */
2752
2753             /* A destructor called during LEAVE_SCOPE could have undefined
2754              * our precious cv.  See bug #99850. */
2755             if (!CvROOT(cv) && !CvXSUB(cv)) {
2756                 const GV * const gv = CvGV(cv);
2757                 if (gv) {
2758                     SV * const tmpstr = sv_newmortal();
2759                     gv_efullname3(tmpstr, gv, NULL);
2760                     DIE(aTHX_ "Goto undefined subroutine &%"SVf"",
2761                                SVfARG(tmpstr));
2762                 }
2763                 DIE(aTHX_ "Goto undefined subroutine");
2764             }
2765
2766             if (CxTYPE(cx) == CXt_SUB) {
2767                 CvDEPTH(cx->blk_sub.cv) = cx->blk_sub.olddepth;
2768                 SvREFCNT_dec_NN(cx->blk_sub.cv);
2769             }
2770
2771             /* Now do some callish stuff. */
2772             if (CvISXSUB(cv)) {
2773                 const SSize_t items = arg ? AvFILL(arg) + 1 : 0;
2774                 const bool m = arg ? cBOOL(SvRMAGICAL(arg)) : 0;
2775                 SV** mark;
2776
2777                 ENTER;
2778                 SAVETMPS;
2779                 SAVEFREESV(cv); /* later, undo the 'avoid premature free' hack */
2780
2781                 /* put GvAV(defgv) back onto stack */
2782                 if (items) {
2783                     EXTEND(SP, items+1); /* @_ could have been extended. */
2784                 }
2785                 mark = SP;
2786                 if (items) {
2787                     SSize_t index;
2788                     bool r = cBOOL(AvREAL(arg));
2789                     for (index=0; index<items; index++)
2790                     {
2791                         SV *sv;
2792                         if (m) {
2793                             SV ** const svp = av_fetch(arg, index, 0);
2794                             sv = svp ? *svp : NULL;
2795                         }
2796                         else sv = AvARRAY(arg)[index];
2797                         SP[index+1] = sv
2798                             ? r ? SvREFCNT_inc_NN(sv_2mortal(sv)) : sv
2799                             : sv_2mortal(newSVavdefelem(arg, index, 1));
2800                     }
2801                 }
2802                 SP += items;
2803                 if (CxTYPE(cx) == CXt_SUB && CxHASARGS(cx)) {
2804                     /* Restore old @_ */
2805                     CX_POP_SAVEARRAY(cx);
2806                 }
2807
2808                 retop = cx->blk_sub.retop;
2809                 PL_comppad = cx->blk_sub.prevcomppad;
2810                 PL_curpad = LIKELY(PL_comppad) ? AvARRAY(PL_comppad) : NULL;
2811
2812                 /* XS subs don't have a CXt_SUB, so pop it;
2813                  * this is a cx_popblock(), less all the stuff we already did
2814                  * for cx_topblock() earlier */
2815                 PL_curcop = cx->blk_oldcop;
2816                 CX_POP(cx);
2817
2818                 /* Push a mark for the start of arglist */
2819                 PUSHMARK(mark);
2820                 PUTBACK;
2821                 (void)(*CvXSUB(cv))(aTHX_ cv);
2822                 LEAVE;
2823                 goto _return;
2824             }
2825             else {
2826                 PADLIST * const padlist = CvPADLIST(cv);
2827
2828                 SAVEFREESV(cv); /* later, undo the 'avoid premature free' hack */
2829
2830                 /* partial unrolled cx_pushsub(): */
2831
2832                 cx->blk_sub.cv = cv;
2833                 cx->blk_sub.olddepth = CvDEPTH(cv);
2834
2835                 CvDEPTH(cv)++;
2836                 SvREFCNT_inc_simple_void_NN(cv);
2837                 if (CvDEPTH(cv) > 1) {
2838                     if (CvDEPTH(cv) == PERL_SUB_DEPTH_WARN && ckWARN(WARN_RECURSION))
2839                         sub_crush_depth(cv);
2840                     pad_push(padlist, CvDEPTH(cv));
2841                 }
2842                 PL_curcop = cx->blk_oldcop;
2843                 PAD_SET_CUR_NOSAVE(padlist, CvDEPTH(cv));
2844                 if (CxHASARGS(cx))
2845                 {
2846                     /* second half of donating @_ from the old sub to the
2847                      * new sub: abandon the original pad[0] AV in the
2848                      * new sub, and replace it with the donated @_.
2849                      * pad[0] takes ownership of the extra refcount
2850                      * we gave arg earlier */
2851                     if (arg) {
2852                         SvREFCNT_dec(PAD_SVl(0));
2853                         PAD_SVl(0) = (SV *)arg;
2854                         SvREFCNT_inc_simple_void_NN(arg);
2855                     }
2856
2857                     /* GvAV(PL_defgv) might have been modified on scope
2858                        exit, so point it at arg again. */
2859                     if (arg != GvAV(PL_defgv)) {
2860                         AV * const av = GvAV(PL_defgv);
2861                         GvAV(PL_defgv) = (AV *)SvREFCNT_inc_simple(arg);
2862                         SvREFCNT_dec(av);
2863                     }
2864                 }
2865
2866                 if (PERLDB_SUB) {       /* Checking curstash breaks DProf. */
2867                     Perl_get_db_sub(aTHX_ NULL, cv);
2868                     if (PERLDB_GOTO) {
2869                         CV * const gotocv = get_cvs("DB::goto", 0);
2870                         if (gotocv) {
2871                             PUSHMARK( PL_stack_sp );
2872                             call_sv(MUTABLE_SV(gotocv), G_SCALAR | G_NODEBUG);
2873                             PL_stack_sp--;
2874                         }
2875                     }
2876                 }
2877                 retop = CvSTART(cv);
2878                 goto putback_return;
2879             }
2880         }
2881         else {
2882             /* goto EXPR */
2883             label       = SvPV_nomg_const(sv, label_len);
2884             label_flags = SvUTF8(sv);
2885         }
2886     }
2887     else if (!(PL_op->op_flags & OPf_SPECIAL)) {
2888         /* goto LABEL  or  dump LABEL */
2889         label       = cPVOP->op_pv;
2890         label_flags = (cPVOP->op_private & OPpPV_IS_UTF8) ? SVf_UTF8 : 0;
2891         label_len   = strlen(label);
2892     }
2893     if (!(do_dump || label_len)) DIE(aTHX_ "%s", must_have_label);
2894
2895     PERL_ASYNC_CHECK();
2896
2897     if (label_len) {
2898         OP *gotoprobe = NULL;
2899         bool leaving_eval = FALSE;
2900         bool in_block = FALSE;
2901         PERL_CONTEXT *last_eval_cx = NULL;
2902
2903         /* find label */
2904
2905         PL_lastgotoprobe = NULL;
2906         *enterops = 0;
2907         for (ix = cxstack_ix; ix >= 0; ix--) {
2908             cx = &cxstack[ix];
2909             switch (CxTYPE(cx)) {
2910             case CXt_EVAL:
2911                 leaving_eval = TRUE;
2912                 if (!CxTRYBLOCK(cx)) {
2913                     gotoprobe = (last_eval_cx ?
2914                                 last_eval_cx->blk_eval.old_eval_root :
2915                                 PL_eval_root);
2916                     last_eval_cx = cx;
2917                     break;
2918                 }
2919                 /* else fall through */
2920             case CXt_LOOP_PLAIN:
2921             case CXt_LOOP_LAZYIV:
2922             case CXt_LOOP_LAZYSV:
2923             case CXt_LOOP_LIST:
2924             case CXt_LOOP_ARY:
2925             case CXt_GIVEN:
2926             case CXt_WHEN:
2927                 gotoprobe = OpSIBLING(cx->blk_oldcop);
2928                 break;
2929             case CXt_SUBST:
2930                 continue;
2931             case CXt_BLOCK:
2932                 if (ix) {
2933                     gotoprobe = OpSIBLING(cx->blk_oldcop);
2934                     in_block = TRUE;
2935                 } else
2936                     gotoprobe = PL_main_root;
2937                 break;
2938             case CXt_SUB:
2939                 if (CvDEPTH(cx->blk_sub.cv) && !CxMULTICALL(cx)) {
2940                     gotoprobe = CvROOT(cx->blk_sub.cv);
2941                     break;
2942                 }
2943                 /* FALLTHROUGH */
2944             case CXt_FORMAT:
2945             case CXt_NULL:
2946                 DIE(aTHX_ "Can't \"goto\" out of a pseudo block");
2947             default:
2948                 if (ix)
2949                     DIE(aTHX_ "panic: goto, type=%u, ix=%ld",
2950                         CxTYPE(cx), (long) ix);
2951                 gotoprobe = PL_main_root;
2952                 break;
2953             }
2954             if (gotoprobe) {
2955                 OP *sibl1, *sibl2;
2956
2957                 retop = dofindlabel(gotoprobe, label, label_len, label_flags,
2958                                     enterops, enterops + GOTO_DEPTH);
2959                 if (retop)
2960                     break;
2961                 if ( (sibl1 = OpSIBLING(gotoprobe)) &&
2962                      sibl1->op_type == OP_UNSTACK &&
2963                      (sibl2 = OpSIBLING(sibl1)))
2964                 {
2965                     retop = dofindlabel(sibl2,
2966                                         label, label_len, label_flags, enterops,
2967                                         enterops + GOTO_DEPTH);
2968                     if (retop)
2969                         break;
2970                 }
2971             }
2972             PL_lastgotoprobe = gotoprobe;
2973         }
2974         if (!retop)
2975             DIE(aTHX_ "Can't find label %"UTF8f,
2976                        UTF8fARG(label_flags, label_len, label));
2977
2978         /* if we're leaving an eval, check before we pop any frames
2979            that we're not going to punt, otherwise the error
2980            won't be caught */
2981
2982         if (leaving_eval && *enterops && enterops[1]) {
2983             I32 i;
2984             for (i = 1; enterops[i]; i++)
2985                 if (enterops[i]->op_type == OP_ENTERITER)
2986                     DIE(aTHX_ "Can't \"goto\" into the middle of a foreach loop");
2987         }
2988
2989         if (*enterops && enterops[1]) {
2990             I32 i = enterops[1]->op_type == OP_ENTER && in_block ? 2 : 1;
2991             if (enterops[i])
2992                 deprecate("\"goto\" to jump into a construct");
2993         }
2994
2995         /* pop unwanted frames */
2996
2997         if (ix < cxstack_ix) {
2998             if (ix < 0)
2999                 DIE(aTHX_ "panic: docatch: illegal ix=%ld", (long)ix);
3000             dounwind(ix);
3001             cx = CX_CUR();
3002             cx_topblock(cx);
3003         }
3004
3005         /* push wanted frames */
3006
3007         if (*enterops && enterops[1]) {
3008             OP * const oldop = PL_op;
3009             ix = enterops[1]->op_type == OP_ENTER && in_block ? 2 : 1;
3010             for (; enterops[ix]; ix++) {
3011                 PL_op = enterops[ix];
3012                 /* Eventually we may want to stack the needed arguments
3013                  * for each op.  For now, we punt on the hard ones. */
3014                 if (PL_op->op_type == OP_ENTERITER)
3015                     DIE(aTHX_ "Can't \"goto\" into the middle of a foreach loop");
3016                 PL_op->op_ppaddr(aTHX);
3017             }
3018             PL_op = oldop;
3019         }
3020     }
3021
3022     if (do_dump) {
3023 #ifdef VMS
3024         if (!retop) retop = PL_main_start;
3025 #endif
3026         PL_restartop = retop;
3027         PL_do_undump = TRUE;
3028
3029         my_unexec();
3030
3031         PL_restartop = 0;               /* hmm, must be GNU unexec().. */
3032         PL_do_undump = FALSE;
3033     }
3034
3035     putback_return:
3036     PL_stack_sp = sp;
3037     _return:
3038     PERL_ASYNC_CHECK();
3039     return retop;
3040 }
3041
3042 PP(pp_exit)
3043 {
3044     dSP;
3045     I32 anum;
3046
3047     if (MAXARG < 1)
3048         anum = 0;
3049     else if (!TOPs) {
3050         anum = 0; (void)POPs;
3051     }
3052     else {
3053         anum = SvIVx(POPs);
3054 #ifdef VMS
3055         if (anum == 1
3056          && SvTRUE(cop_hints_fetch_pvs(PL_curcop, "vmsish_exit", 0)))
3057             anum = 0;
3058         VMSISH_HUSHED  =
3059             VMSISH_HUSHED || (PL_curcop->op_private & OPpHUSH_VMSISH);
3060 #endif
3061     }
3062     PL_exit_flags |= PERL_EXIT_EXPECTED;
3063     my_exit(anum);
3064     PUSHs(&PL_sv_undef);
3065     RETURN;
3066 }
3067
3068 /* Eval. */
3069
3070 STATIC void
3071 S_save_lines(pTHX_ AV *array, SV *sv)
3072 {
3073     const char *s = SvPVX_const(sv);
3074     const char * const send = SvPVX_const(sv) + SvCUR(sv);
3075     I32 line = 1;
3076
3077     PERL_ARGS_ASSERT_SAVE_LINES;
3078
3079     while (s && s < send) {
3080         const char *t;
3081         SV * const tmpstr = newSV_type(SVt_PVMG);
3082
3083         t = (const char *)memchr(s, '\n', send - s);
3084         if (t)
3085             t++;
3086         else
3087             t = send;
3088
3089         sv_setpvn(tmpstr, s, t - s);
3090         av_store(array, line++, tmpstr);
3091         s = t;
3092     }
3093 }
3094
3095 /*
3096 =for apidoc docatch
3097
3098 Check for the cases 0 or 3 of cur_env.je_ret, only used inside an eval context.
3099
3100 0 is used as continue inside eval,
3101
3102 3 is used for a die caught by an inner eval - continue inner loop
3103
3104 See F<cop.h>: je_mustcatch, when set at any runlevel to TRUE, means eval ops must
3105 establish a local jmpenv to handle exception traps.
3106
3107 =cut
3108 */
3109 STATIC OP *
3110 S_docatch(pTHX_ OP *o)
3111 {
3112     int ret;
3113     OP * const oldop = PL_op;
3114     dJMPENV;
3115
3116 #ifdef DEBUGGING
3117     assert(CATCH_GET == TRUE);
3118 #endif
3119     PL_op = o;
3120
3121     JMPENV_PUSH(ret);
3122     switch (ret) {
3123     case 0:
3124         assert(cxstack_ix >= 0);
3125         assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3126         CX_CUR()->blk_eval.cur_top_env = PL_top_env;
3127  redo_body:
3128         CALLRUNOPS(aTHX);
3129         break;
3130     case 3:
3131         /* die caught by an inner eval - continue inner loop */
3132         if (PL_restartop && PL_restartjmpenv == PL_top_env) {
3133             PL_restartjmpenv = NULL;
3134             PL_op = PL_restartop;
3135             PL_restartop = 0;
3136             goto redo_body;
3137         }
3138         /* FALLTHROUGH */
3139     default:
3140         JMPENV_POP;
3141         PL_op = oldop;
3142         JMPENV_JUMP(ret);
3143         NOT_REACHED; /* NOTREACHED */
3144     }
3145     JMPENV_POP;
3146     PL_op = oldop;
3147     return NULL;
3148 }
3149
3150
3151 /*
3152 =for apidoc find_runcv
3153
3154 Locate the CV corresponding to the currently executing sub or eval.
3155 If C<db_seqp> is non_null, skip CVs that are in the DB package and populate
3156 C<*db_seqp> with the cop sequence number at the point that the DB:: code was
3157 entered.  (This allows debuggers to eval in the scope of the breakpoint
3158 rather than in the scope of the debugger itself.)
3159
3160 =cut
3161 */
3162
3163 CV*
3164 Perl_find_runcv(pTHX_ U32 *db_seqp)
3165 {
3166     return Perl_find_runcv_where(aTHX_ 0, 0, db_seqp);
3167 }
3168
3169 /* If this becomes part of the API, it might need a better name. */
3170 CV *
3171 Perl_find_runcv_where(pTHX_ U8 cond, IV arg, U32 *db_seqp)
3172 {
3173     PERL_SI      *si;
3174     int          level = 0;
3175
3176     if (db_seqp)
3177         *db_seqp =
3178             PL_curcop == &PL_compiling
3179                 ? PL_cop_seqmax
3180                 : PL_curcop->cop_seq;
3181
3182     for (si = PL_curstackinfo; si; si = si->si_prev) {
3183         I32 ix;
3184         for (ix = si->si_cxix; ix >= 0; ix--) {
3185             const PERL_CONTEXT *cx = &(si->si_cxstack[ix]);
3186             CV *cv = NULL;
3187             if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT) {
3188                 cv = cx->blk_sub.cv;
3189                 /* skip DB:: code */
3190                 if (db_seqp && PL_debstash && CvSTASH(cv) == PL_debstash) {
3191                     *db_seqp = cx->blk_oldcop->cop_seq;
3192                     continue;
3193                 }
3194                 if (cx->cx_type & CXp_SUB_RE)
3195                     continue;
3196             }
3197             else if (CxTYPE(cx) == CXt_EVAL && !CxTRYBLOCK(cx))
3198                 cv = cx->blk_eval.cv;
3199             if (cv) {
3200                 switch (cond) {
3201                 case FIND_RUNCV_padid_eq:
3202                     if (!CvPADLIST(cv)
3203                      || CvPADLIST(cv)->xpadl_id != (U32)arg)
3204                         continue;
3205                     return cv;
3206                 case FIND_RUNCV_level_eq:
3207                     if (level++ != arg) continue;
3208                     /* GERONIMO! */
3209                 default:
3210                     return cv;
3211                 }
3212             }
3213         }
3214     }
3215     return cond == FIND_RUNCV_padid_eq ? NULL : PL_main_cv;
3216 }
3217
3218
3219 /* Run yyparse() in a setjmp wrapper. Returns:
3220  *   0: yyparse() successful
3221  *   1: yyparse() failed
3222  *   3: yyparse() died
3223  */
3224 STATIC int
3225 S_try_yyparse(pTHX_ int gramtype)
3226 {
3227     int ret;
3228     dJMPENV;
3229
3230     assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3231     JMPENV_PUSH(ret);
3232     switch (ret) {
3233     case 0:
3234         ret = yyparse(gramtype) ? 1 : 0;
3235         break;
3236     case 3:
3237         break;
3238     default:
3239         JMPENV_POP;
3240         JMPENV_JUMP(ret);
3241         NOT_REACHED; /* NOTREACHED */
3242     }
3243     JMPENV_POP;
3244     return ret;
3245 }
3246
3247
3248 /* Compile a require/do or an eval ''.
3249  *
3250  * outside is the lexically enclosing CV (if any) that invoked us.
3251  * seq     is the current COP scope value.
3252  * hh      is the saved hints hash, if any.
3253  *
3254  * Returns a bool indicating whether the compile was successful; if so,
3255  * PL_eval_start contains the first op of the compiled code; otherwise,
3256  * pushes undef.
3257  *
3258  * This function is called from two places: pp_require and pp_entereval.
3259  * These can be distinguished by whether PL_op is entereval.
3260  */
3261
3262 STATIC bool
3263 S_doeval_compile(pTHX_ U8 gimme, CV* outside, U32 seq, HV *hh)
3264 {
3265     dSP;
3266     OP * const saveop = PL_op;
3267     bool clear_hints = saveop->op_type != OP_ENTEREVAL;
3268     COP * const oldcurcop = PL_curcop;
3269     bool in_require = (saveop->op_type == OP_REQUIRE);
3270     int yystatus;
3271     CV *evalcv;
3272
3273     PL_in_eval = (in_require
3274                   ? (EVAL_INREQUIRE | (PL_in_eval & EVAL_INEVAL))
3275                   : (EVAL_INEVAL |
3276                         ((PL_op->op_private & OPpEVAL_RE_REPARSING)
3277                             ? EVAL_RE_REPARSING : 0)));
3278
3279     PUSHMARK(SP);
3280
3281     evalcv = MUTABLE_CV(newSV_type(SVt_PVCV));
3282     CvEVAL_on(evalcv);
3283     assert(CxTYPE(CX_CUR()) == CXt_EVAL);
3284     CX_CUR()->blk_eval.cv = evalcv;
3285     CX_CUR()->blk_gimme = gimme;
3286
3287     CvOUTSIDE_SEQ(evalcv) = seq;
3288     CvOUTSIDE(evalcv) = MUTABLE_CV(SvREFCNT_inc_simple(outside));
3289
3290     /* set up a scratch pad */
3291
3292     CvPADLIST_set(evalcv, pad_new(padnew_SAVE));
3293     PL_op = NULL; /* avoid PL_op and PL_curpad referring to different CVs */
3294
3295
3296     SAVEMORTALIZESV(evalcv);    /* must remain until end of current statement */
3297
3298     /* make sure we compile in the right package */
3299
3300     if (CopSTASH_ne(PL_curcop, PL_curstash)) {
3301         SAVEGENERICSV(PL_curstash);
3302         PL_curstash = (HV *)CopSTASH(PL_curcop);
3303         if (SvTYPE(PL_curstash) != SVt_PVHV) PL_curstash = NULL;
3304         else SvREFCNT_inc_simple_void(PL_curstash);
3305     }
3306     /* XXX:ajgo do we really need to alloc an AV for begin/checkunit */
3307     SAVESPTR(PL_beginav);
3308     PL_beginav = newAV();
3309     SAVEFREESV(PL_beginav);
3310     SAVESPTR(PL_unitcheckav);
3311     PL_unitcheckav = newAV();
3312     SAVEFREESV(PL_unitcheckav);
3313
3314
3315     ENTER_with_name("evalcomp");
3316     SAVESPTR(PL_compcv);
3317     PL_compcv = evalcv;
3318
3319     /* try to compile it */
3320
3321     PL_eval_root = NULL;
3322     PL_curcop = &PL_compiling;
3323     if ((saveop->op_type != OP_REQUIRE) && (saveop->op_flags & OPf_SPECIAL))
3324         PL_in_eval |= EVAL_KEEPERR;
3325     else
3326         CLEAR_ERRSV();
3327
3328     SAVEHINTS();
3329     if (clear_hints) {
3330         PL_hints = 0;
3331         hv_clear(GvHV(PL_hintgv));
3332     }
3333     else {
3334         PL_hints = saveop->op_private & OPpEVAL_COPHH
3335                      ? oldcurcop->cop_hints : saveop->op_targ;
3336
3337         /* making 'use re eval' not be in scope when compiling the
3338          * qr/mabye_has_runtime_code_block/ ensures that we don't get
3339          * infinite recursion when S_has_runtime_code() gives a false
3340          * positive: the second time round, HINT_RE_EVAL isn't set so we
3341          * don't bother calling S_has_runtime_code() */
3342         if (PL_in_eval & EVAL_RE_REPARSING)
3343             PL_hints &= ~HINT_RE_EVAL;
3344
3345         if (hh) {
3346             /* SAVEHINTS created a new HV in PL_hintgv, which we need to GC */
3347             SvREFCNT_dec(GvHV(PL_hintgv));
3348             GvHV(PL_hintgv) = hh;
3349         }
3350     }
3351     SAVECOMPILEWARNINGS();
3352     if (clear_hints) {
3353         if (PL_dowarn & G_WARN_ALL_ON)
3354             PL_compiling.cop_warnings = pWARN_ALL ;
3355         else if (PL_dowarn & G_WARN_ALL_OFF)
3356             PL_compiling.cop_warnings = pWARN_NONE ;
3357         else
3358             PL_compiling.cop_warnings = pWARN_STD ;
3359     }
3360     else {
3361         PL_compiling.cop_warnings =
3362             DUP_WARNINGS(oldcurcop->cop_warnings);
3363         cophh_free(CopHINTHASH_get(&PL_compiling));
3364         if (Perl_cop_fetch_label(aTHX_ oldcurcop, NULL, NULL)) {
3365             /* The label, if present, is the first entry on the chain. So rather
3366                than writing a blank label in front of it (which involves an
3367                allocation), just use the next entry in the chain.  */
3368             PL_compiling.cop_hints_hash
3369                 = cophh_copy(oldcurcop->cop_hints_hash->refcounted_he_next);
3370             /* Check the assumption that this removed the label.  */
3371             assert(Perl_cop_fetch_label(aTHX_ &PL_compiling, NULL, NULL) == NULL);
3372         }
3373         else
3374             PL_compiling.cop_hints_hash = cophh_copy(oldcurcop->cop_hints_hash);
3375     }
3376
3377     CALL_BLOCK_HOOKS(bhk_eval, saveop);
3378
3379     /* note that yyparse() may raise an exception, e.g. C<BEGIN{die}>,
3380      * so honour CATCH_GET and trap it here if necessary */
3381
3382
3383     /* compile the code */
3384     yystatus = (!in_require && CATCH_GET) ? S_try_yyparse(aTHX_ GRAMPROG) : yyparse(GRAMPROG);
3385
3386     if (yystatus || PL_parser->error_count || !PL_eval_root) {
3387         SV *namesv = NULL; /* initialise  to avoid compiler warning */
3388         PERL_CONTEXT *cx;
3389         SV *errsv;
3390
3391         PL_op = saveop;
3392         /* note that if yystatus == 3, then the require/eval died during
3393          * compilation, so the EVAL CX block has already been popped, and
3394          * various vars restored */
3395         if (yystatus != 3) {
3396             if (PL_eval_root) {
3397                 op_free(PL_eval_root);
3398                 PL_eval_root = NULL;
3399             }
3400             SP = PL_stack_base + POPMARK;       /* pop original mark */
3401             cx = CX_CUR();
3402             CX_LEAVE_SCOPE(cx);
3403             cx_popeval(cx);
3404             cx_popblock(cx);
3405             if (in_require)
3406                 namesv = cx->blk_eval.old_namesv;
3407             CX_POP(cx);
3408         }
3409
3410         errsv = ERRSV;
3411         if (in_require) {
3412             if (yystatus == 3) {
3413                 cx = CX_CUR();
3414                 assert(CxTYPE(cx) == CXt_EVAL);
3415                 namesv = cx->blk_eval.old_namesv;
3416             }
3417             S_undo_inc_then_croak(aTHX_ namesv, errsv, FALSE);
3418             NOT_REACHED; /* NOTREACHED */
3419         }
3420
3421         if (!*(SvPV_nolen_const(errsv)))
3422             sv_setpvs(errsv, "Compilation error");
3423
3424         if (gimme != G_ARRAY) PUSHs(&PL_sv_undef);
3425         PUTBACK;
3426         return FALSE;
3427     }
3428
3429     /* Compilation successful. Now clean up */
3430
3431     LEAVE_with_name("evalcomp");
3432
3433     CopLINE_set(&PL_compiling, 0);
3434     SAVEFREEOP(PL_eval_root);
3435     cv_forget_slab(evalcv);
3436
3437     DEBUG_x(dump_eval());
3438
3439     /* Register with debugger: */
3440     if (PERLDB_INTER && saveop->op_type == OP_REQUIRE) {
3441         CV * const cv = get_cvs("DB::postponed", 0);
3442         if (cv) {
3443             dSP;
3444             PUSHMARK(SP);
3445             XPUSHs(MUTABLE_SV(CopFILEGV(&PL_compiling)));
3446             PUTBACK;
3447             call_sv(MUTABLE_SV(cv), G_DISCARD);
3448         }
3449     }
3450
3451     if (PL_unitcheckav) {
3452         OP *es = PL_eval_start;
3453         call_list(PL_scopestack_ix, PL_unitcheckav);
3454         PL_eval_start = es;
3455     }
3456
3457     CvDEPTH(evalcv) = 1;
3458     SP = PL_stack_base + POPMARK;               /* pop original mark */
3459     PL_op = saveop;                     /* The caller may need it. */
3460     PL_parser->lex_state = LEX_NOTPARSING;      /* $^S needs this. */
3461
3462     PUTBACK;
3463     return TRUE;
3464 }
3465
3466
3467 STATIC PerlIO *
3468 S_check_type_and_open(pTHX_ SV *name)
3469 {
3470     Stat_t st;
3471     STRLEN len;
3472     PerlIO * retio;
3473     const char *p = SvPV_const(name, len);
3474     int st_rc;
3475
3476     PERL_ARGS_ASSERT_CHECK_TYPE_AND_OPEN;
3477
3478     /* checking here captures a reasonable error message when
3479      * PERL_DISABLE_PMC is true, but when PMC checks are enabled, the
3480      * user gets a confusing message about looking for the .pmc file
3481      * rather than for the .pm file so do the check in S_doopen_pm when
3482      * PMC is on instead of here. S_doopen_pm calls this func.
3483      * This check prevents a \0 in @INC causing problems.
3484      */
3485 #ifdef PERL_DISABLE_PMC
3486     if (!IS_SAFE_PATHNAME(p, len, "require"))
3487         return NULL;
3488 #endif
3489
3490     /* on Win32 stat is expensive (it does an open() and close() twice and
3491        a couple other IO calls), the open will fail with a dir on its own with
3492        errno EACCES, so only do a stat to separate a dir from a real EACCES
3493        caused by user perms */
3494 #ifndef WIN32
3495     /* we use the value of errno later to see how stat() or open() failed.
3496      * We don't want it set if the stat succeeded but we still failed,
3497      * such as if the name exists, but is a directory */
3498     errno = 0;
3499
3500     st_rc = PerlLIO_stat(p, &st);
3501
3502     if (st_rc < 0 || S_ISDIR(st.st_mode) || S_ISBLK(st.st_mode)) {
3503         return NULL;
3504     }
3505 #endif
3506
3507     retio = PerlIO_openn(aTHX_ ":", PERL_SCRIPT_MODE, -1, 0, 0, NULL, 1, &name);
3508 #ifdef WIN32
3509     /* EACCES stops the INC search early in pp_require to implement
3510        feature RT #113422 */
3511     if(!retio && errno == EACCES) { /* exists but probably a directory */
3512         int eno;
3513         st_rc = PerlLIO_stat(p, &st);
3514         if (st_rc >= 0) {
3515             if(S_ISDIR(st.st_mode) || S_ISBLK(st.st_mode))
3516                 eno = 0;
3517             else
3518                 eno = EACCES;
3519             errno = eno;
3520         }
3521     }
3522 #endif
3523     return retio;
3524 }
3525
3526 #ifndef PERL_DISABLE_PMC
3527 STATIC PerlIO *
3528 S_doopen_pm(pTHX_ SV *name)
3529 {
3530     STRLEN namelen;
3531     const char *p = SvPV_const(name, namelen);
3532
3533     PERL_ARGS_ASSERT_DOOPEN_PM;
3534
3535     /* check the name before trying for the .pmc name to avoid the
3536      * warning referring to the .pmc which the user probably doesn't
3537      * know or care about
3538      */
3539     if (!IS_SAFE_PATHNAME(p, namelen, "require"))
3540         return NULL;
3541
3542     if (namelen > 3 && memEQs(p + namelen - 3, 3, ".pm")) {
3543         SV *const pmcsv = sv_newmortal();
3544         PerlIO * pmcio;
3545
3546         SvSetSV_nosteal(pmcsv,name);
3547         sv_catpvs(pmcsv, "c");
3548
3549         pmcio = check_type_and_open(pmcsv);
3550         if (pmcio)
3551             return pmcio;
3552     }
3553     return check_type_and_open(name);
3554 }
3555 #else
3556 #  define doopen_pm(name) check_type_and_open(name)
3557 #endif /* !PERL_DISABLE_PMC */
3558
3559 /* require doesn't search for absolute names, or when the name is
3560    explicitly relative the current directory */
3561 PERL_STATIC_INLINE bool
3562 S_path_is_searchable(const char *name)
3563 {
3564     PERL_ARGS_ASSERT_PATH_IS_SEARCHABLE;
3565
3566     if (PERL_FILE_IS_ABSOLUTE(name)
3567 #ifdef WIN32
3568         || (*name == '.' && ((name[1] == '/' ||
3569                              (name[1] == '.' && name[2] == '/'))
3570                          || (name[1] == '\\' ||
3571                              ( name[1] == '.' && name[2] == '\\')))
3572             )
3573 #else
3574         || (*name == '.' && (name[1] == '/' ||
3575                              (name[1] == '.' && name[2] == '/')))
3576 #endif
3577          )
3578     {
3579         return FALSE;
3580     }
3581     else
3582         return TRUE;
3583 }
3584
3585
3586 /* also used for: pp_dofile() */
3587
3588 PP(pp_require)
3589 {
3590     dSP;
3591     PERL_CONTEXT *cx;
3592     SV *sv;
3593     const char *name;
3594     STRLEN len;
3595     char * unixname;
3596     STRLEN unixlen;
3597 #ifdef VMS
3598     int vms_unixname = 0;
3599     char *unixdir;
3600 #endif
3601     const char *tryname = NULL;
3602     SV *namesv = NULL;
3603     const U8 gimme = GIMME_V;
3604     int filter_has_file = 0;
3605     PerlIO *tryrsfp = NULL;
3606     SV *filter_cache = NULL;
3607     SV *filter_state = NULL;
3608     SV *filter_sub = NULL;
3609     SV *hook_sv = NULL;
3610     OP *op;
3611     int saved_errno;
3612     bool path_searchable;
3613     I32 old_savestack_ix;
3614
3615     sv = POPs;
3616     SvGETMAGIC(sv);
3617     if ( (SvNIOKp(sv) || SvVOK(sv)) && PL_op->op_type != OP_DOFILE) {
3618         sv = sv_2mortal(new_version(sv));
3619         if (!Perl_sv_derived_from_pvn(aTHX_ PL_patchlevel, STR_WITH_LEN("version"), 0))
3620             upg_version(PL_patchlevel, TRUE);
3621         if (cUNOP->op_first->op_type == OP_CONST && cUNOP->op_first->op_private & OPpCONST_NOVER) {
3622             if ( vcmp(sv,PL_patchlevel) <= 0 )
3623                 DIE(aTHX_ "Perls since %"SVf" too modern--this is %"SVf", stopped",
3624                     SVfARG(sv_2mortal(vnormal(sv))),
3625                     SVfARG(sv_2mortal(vnormal(PL_patchlevel)))
3626                 );
3627         }
3628         else {
3629             if ( vcmp(sv,PL_patchlevel) > 0 ) {
3630                 I32 first = 0;
3631                 AV *lav;
3632                 SV * const req = SvRV(sv);
3633                 SV * const pv = *hv_fetchs(MUTABLE_HV(req), "original", FALSE);
3634
3635                 /* get the left hand term */
3636                 lav = MUTABLE_AV(SvRV(*hv_fetchs(MUTABLE_HV(req), "version", FALSE)));
3637
3638                 first  = SvIV(*av_fetch(lav,0,0));
3639                 if (   first > (int)PERL_REVISION    /* probably 'use 6.0' */
3640                     || hv_exists(MUTABLE_HV(req), "qv", 2 ) /* qv style */
3641                     || av_tindex(lav) > 1            /* FP with > 3 digits */
3642                     || strstr(SvPVX(pv),".0")        /* FP with leading 0 */
3643                    ) {
3644                     DIE(aTHX_ "Perl %"SVf" required--this is only "
3645                         "%"SVf", stopped",
3646                         SVfARG(sv_2mortal(vnormal(req))),
3647                         SVfARG(sv_2mortal(vnormal(PL_patchlevel)))
3648                     );
3649                 }
3650                 else { /* probably 'use 5.10' or 'use 5.8' */
3651                     SV *hintsv;
3652                     I32 second = 0;
3653
3654                     if (av_tindex(lav)>=1)
3655                         second = SvIV(*av_fetch(lav,1,0));
3656
3657                     second /= second >= 600  ? 100 : 10;
3658                     hintsv = Perl_newSVpvf(aTHX_ "v%d.%d.0",
3659                                            (int)first, (int)second);
3660                     upg_version(hintsv, TRUE);
3661
3662                     DIE(aTHX_ "Perl %"SVf" required (did you mean %"SVf"?)"
3663                         "--this is only %"SVf", stopped",
3664                         SVfARG(sv_2mortal(vnormal(req))),
3665                         SVfARG(sv_2mortal(vnormal(sv_2mortal(hintsv)))),
3666                         SVfARG(sv_2mortal(vnormal(PL_patchlevel)))
3667                     );
3668                 }
3669             }
3670         }
3671
3672         RETPUSHYES;
3673     }
3674     if (!SvOK(sv))
3675         DIE(aTHX_ "Missing or undefined argument to require");
3676     name = SvPV_nomg_const(sv, len);
3677     if (!(name && len > 0 && *name))
3678         DIE(aTHX_ "Missing or undefined argument to require");
3679
3680     if (!IS_SAFE_PATHNAME(name, len, "require")) {
3681         DIE(aTHX_ "Can't locate %s:   %s",
3682             pv_escape(newSVpvs_flags("",SVs_TEMP),SvPVX(sv),SvCUR(sv),
3683                       SvCUR(sv)*2,NULL, SvUTF8(sv)?PERL_PV_ESCAPE_UNI:0),
3684             Strerror(ENOENT));
3685     }
3686     TAINT_PROPER("require");
3687
3688     path_searchable = path_is_searchable(name);
3689
3690 #ifdef VMS
3691     /* The key in the %ENV hash is in the syntax of file passed as the argument
3692      * usually this is in UNIX format, but sometimes in VMS format, which
3693      * can result in a module being pulled in more than once.
3694      * To prevent this, the key must be stored in UNIX format if the VMS
3695      * name can be translated to UNIX.
3696      */
3697
3698     if ((unixname =
3699           tounixspec(name, SvPVX(sv_2mortal(newSVpv("", VMS_MAXRSS-1)))))
3700          != NULL) {
3701         unixlen = strlen(unixname);
3702         vms_unixname = 1;
3703     }
3704     else
3705 #endif
3706     {
3707         /* if not VMS or VMS name can not be translated to UNIX, pass it
3708          * through.
3709          */
3710         unixname = (char *) name;
3711         unixlen = len;
3712     }
3713     if (PL_op->op_type == OP_REQUIRE) {
3714         SV * const * const svp = hv_fetch(GvHVn(PL_incgv),
3715                                           unixname, unixlen, 0);
3716         if ( svp ) {
3717             if (*svp != &PL_sv_undef)
3718                 RETPUSHYES;
3719             else
3720                 DIE(aTHX_ "Attempt to reload %s aborted.\n"
3721                             "Compilation failed in require", unixname);
3722         }
3723     }
3724
3725     LOADING_FILE_PROBE(unixname);
3726
3727     /* prepare to compile file */
3728
3729     if (!path_searchable) {
3730         /* At this point, name is SvPVX(sv)  */
3731         tryname = name;
3732         tryrsfp = doopen_pm(sv);
3733     }
3734     if (!tryrsfp && !(errno == EACCES && !path_searchable)) {
3735         AV * const ar = GvAVn(PL_incgv);
3736         SSize_t i;
3737 #ifdef VMS
3738         if (vms_unixname)
3739 #endif
3740         {
3741             SV *nsv = sv;
3742             namesv = newSV_type(SVt_PV);
3743             for (i = 0; i <= AvFILL(ar); i++) {
3744                 SV * const dirsv = *av_fetch(ar, i, TRUE);
3745
3746                 SvGETMAGIC(dirsv);
3747                 if (SvROK(dirsv)) {
3748                     int count;
3749                     SV **svp;
3750                     SV *loader = dirsv;
3751
3752                     if (SvTYPE(SvRV(loader)) == SVt_PVAV
3753                         && !SvOBJECT(SvRV(loader)))
3754                     {
3755                         loader = *av_fetch(MUTABLE_AV(SvRV(loader)), 0, TRUE);
3756                         SvGETMAGIC(loader);
3757                     }
3758
3759                     Perl_sv_setpvf(aTHX_ namesv, "/loader/0x%"UVxf"/%s",
3760                                    PTR2UV(SvRV(dirsv)), name);
3761                     tryname = SvPVX_const(namesv);
3762                     tryrsfp = NULL;
3763
3764                     if (SvPADTMP(nsv)) {
3765                         nsv = sv_newmortal();
3766                         SvSetSV_nosteal(nsv,sv);
3767                     }
3768
3769                     ENTER_with_name("call_INC");
3770                     SAVETMPS;
3771                     EXTEND(SP, 2);
3772
3773                     PUSHMARK(SP);
3774                     PUSHs(dirsv);
3775                     PUSHs(nsv);
3776                     PUTBACK;
3777                     if (SvGMAGICAL(loader)) {
3778                         SV *l = sv_newmortal();
3779                         sv_setsv_nomg(l, loader);
3780                         loader = l;
3781                     }
3782                     if (sv_isobject(loader))
3783                         count = call_method("INC", G_ARRAY);
3784                     else
3785                         count = call_sv(loader, G_ARRAY);
3786                     SPAGAIN;
3787
3788                     if (count > 0) {
3789                         int i = 0;
3790                         SV *arg;
3791
3792                         SP -= count - 1;
3793                         arg = SP[i++];
3794
3795                         if (SvROK(arg) && (SvTYPE(SvRV(arg)) <= SVt_PVLV)
3796                             && !isGV_with_GP(SvRV(arg))) {
3797                             filter_cache = SvRV(arg);
3798
3799                             if (i < count) {
3800                                 arg = SP[i++];
3801                             }
3802                         }
3803
3804                         if (SvROK(arg) && isGV_with_GP(SvRV(arg))) {
3805                             arg = SvRV(arg);
3806                         }
3807
3808                         if (isGV_with_GP(arg)) {
3809                             IO * const io = GvIO((const GV *)arg);
3810
3811                             ++filter_has_file;
3812
3813                             if (io) {
3814                                 tryrsfp = IoIFP(io);
3815                                 if (IoOFP(io) && IoOFP(io) != IoIFP(io)) {
3816                                     PerlIO_close(IoOFP(io));
3817                                 }
3818                                 IoIFP(io) = NULL;
3819                                 IoOFP(io) = NULL;
3820                             }
3821
3822                             if (i < count) {
3823                                 arg = SP[i++];
3824                             }
3825                         }
3826
3827                         if (SvROK(arg) && SvTYPE(SvRV(arg)) == SVt_PVCV) {
3828                             filter_sub = arg;
3829                             SvREFCNT_inc_simple_void_NN(filter_sub);
3830
3831                             if (i < count) {
3832                                 filter_state = SP[i];
3833                                 SvREFCNT_inc_simple_void(filter_state);
3834                             }
3835                         }
3836
3837                         if (!tryrsfp && (filter_cache || filter_sub)) {
3838                             tryrsfp = PerlIO_open(BIT_BUCKET,
3839                                                   PERL_SCRIPT_MODE);
3840                         }
3841                         SP--;
3842                     }
3843
3844                     /* FREETMPS may free our filter_cache */
3845                     SvREFCNT_inc_simple_void(filter_cache);
3846
3847                     PUTBACK;
3848                     FREETMPS;
3849                     LEAVE_with_name("call_INC");
3850
3851                     /* Now re-mortalize it. */
3852                     sv_2mortal(filter_cache);
3853
3854                     /* Adjust file name if the hook has set an %INC entry.
3855                        This needs to happen after the FREETMPS above.  */
3856                     svp = hv_fetch(GvHVn(PL_incgv), name, len, 0);
3857                     if (svp)
3858                         tryname = SvPV_nolen_const(*svp);
3859
3860                     if (tryrsfp) {
3861                         hook_sv = dirsv;
3862                         break;
3863                     }
3864
3865                     filter_has_file = 0;
3866                     filter_cache = NULL;
3867                     if (filter_state) {
3868                         SvREFCNT_dec_NN(filter_state);
3869                         filter_state = NULL;
3870                     }
3871                     if (filter_sub) {
3872                         SvREFCNT_dec_NN(filter_sub);
3873                         filter_sub = NULL;
3874                     }
3875                 }
3876                 else {
3877                   if (path_searchable) {
3878                     const char *dir;
3879                     STRLEN dirlen;
3880
3881                     if (SvOK(dirsv)) {
3882                         dir = SvPV_nomg_const(dirsv, dirlen);
3883                     } else {
3884                         dir = "";
3885                         dirlen = 0;
3886                     }
3887
3888                     if (!IS_SAFE_SYSCALL(dir, dirlen, "@INC entry", "require"))
3889                         continue;
3890 #ifdef VMS
3891                     if ((unixdir =
3892                           tounixpath(dir, SvPVX(sv_2mortal(newSVpv("", VMS_MAXRSS-1)))))
3893                          == NULL)
3894                         continue;
3895                     sv_setpv(namesv, unixdir);
3896                     sv_catpv(namesv, unixname);
3897 #else
3898 #  ifdef __SYMBIAN32__
3899                     if (PL_origfilename[0] &&
3900                         PL_origfilename[1] == ':' &&
3901                         !(dir[0] && dir[1] == ':'))
3902                         Perl_sv_setpvf(aTHX_ namesv,
3903                                        "%c:%s\\%s",
3904                                        PL_origfilename[0],
3905                                        dir, name);
3906                     else
3907                         Perl_sv_setpvf(aTHX_ namesv,
3908                                        "%s\\%s",
3909                                        dir, name);
3910 #  else
3911                     /* The equivalent of
3912                        Perl_sv_setpvf(aTHX_ namesv, "%s/%s", dir, name);
3913                        but without the need to parse the format string, or
3914                        call strlen on either pointer, and with the correct
3915                        allocation up front.  */
3916                     {
3917                         char *tmp = SvGROW(namesv, dirlen + len + 2);
3918
3919                         memcpy(tmp, dir, dirlen);
3920                         tmp +=dirlen;
3921
3922                         /* Avoid '<dir>//<file>' */
3923                         if (!dirlen || *(tmp-1) != '/') {
3924                             *tmp++ = '/';
3925                         } else {
3926                             /* So SvCUR_set reports the correct length below */
3927                             dirlen--;
3928                         }
3929
3930                         /* name came from an SV, so it will have a '\0' at the
3931                            end that we can copy as part of this memcpy().  */
3932                         memcpy(tmp, name, len + 1);
3933
3934                         SvCUR_set(namesv, dirlen + len + 1);
3935                         SvPOK_on(namesv);
3936                     }
3937 #  endif
3938 #endif
3939                     TAINT_PROPER("require");
3940                     tryname = SvPVX_const(namesv);
3941                     tryrsfp = doopen_pm(namesv);
3942                     if (tryrsfp) {
3943                         if (tryname[0] == '.' && tryname[1] == '/') {
3944                             ++tryname;
3945                             while (*++tryname == '/') {}
3946                         }
3947                         break;
3948                     }
3949                     else if (errno == EMFILE || errno == EACCES) {
3950                         /* no point in trying other paths if out of handles;
3951                          * on the other hand, if we couldn't open one of the
3952                          * files, then going on with the search could lead to
3953                          * unexpected results; see perl #113422
3954                          */
3955                         break;
3956                     }
3957                   }
3958                 }
3959             }
3960         }
3961     }
3962     saved_errno = errno; /* sv_2mortal can realloc things */
3963     sv_2mortal(namesv);
3964     if (!tryrsfp) {
3965         if (PL_op->op_type == OP_REQUIRE) {
3966             if(saved_errno == EMFILE || saved_errno == EACCES) {
3967                 /* diag_listed_as: Can't locate %s */
3968                 DIE(aTHX_ "Can't locate %s:   %s: %s",
3969                     name, tryname, Strerror(saved_errno));
3970             } else {
3971                 if (namesv) {                   /* did we lookup @INC? */
3972                     AV * const ar = GvAVn(PL_incgv);
3973                     SSize_t i;
3974                     SV *const msg = newSVpvs_flags("", SVs_TEMP);
3975                     SV *const inc = newSVpvs_flags("", SVs_TEMP);
3976                     for (i = 0; i <= AvFILL(ar); i++) {
3977                         sv_catpvs(inc, " ");
3978                         sv_catsv(inc, *av_fetch(ar, i, TRUE));
3979                     }
3980                     if (len >= 4 && memEQ(name + len - 3, ".pm", 4)) {
3981                         const char *c, *e = name + len - 3;
3982                         sv_catpv(msg, " (you may need to install the ");
3983                         for (c = name; c < e; c++) {
3984                             if (*c == '/') {
3985                                 sv_catpvs(msg, "::");
3986                             }
3987                             else {
3988                                 sv_catpvn(msg, c, 1);
3989                             }
3990                         }
3991                         sv_catpv(msg, " module)");
3992                     }
3993                     else if (len >= 2 && memEQ(name + len - 2, ".h", 3)) {
3994                         sv_catpv(msg, " (change .h to .ph maybe?) (did you run h2ph?)");
3995                     }
3996                     else if (len >= 3 && memEQ(name + len - 3, ".ph", 4)) {
3997                         sv_catpv(msg, " (did you run h2ph?)");
3998                     }
3999
4000                     /* diag_listed_as: Can't locate %s */
4001                     DIE(aTHX_
4002                         "Can't locate %s in @INC%" SVf " (@INC contains:%" SVf ")",
4003                         name, msg, inc);
4004                 }
4005             }
4006             DIE(aTHX_ "Can't locate %s", name);
4007         }
4008
4009         CLEAR_ERRSV();
4010         RETPUSHUNDEF;
4011     }
4012     else
4013         SETERRNO(0, SS_NORMAL);
4014
4015     /* Assume success here to prevent recursive requirement. */
4016     /* name is never assigned to again, so len is still strlen(name)  */
4017     /* Check whether a hook in @INC has already filled %INC */
4018     if (!hook_sv) {
4019         (void)hv_store(GvHVn(PL_incgv),
4020                        unixname, unixlen, newSVpv(tryname,0),0);
4021     } else {
4022         SV** const svp = hv_fetch(GvHVn(PL_incgv), unixname, unixlen, 0);
4023         if (!svp)
4024             (void)hv_store(GvHVn(PL_incgv),
4025                            unixname, unixlen, SvREFCNT_inc_simple(hook_sv), 0 );
4026     }
4027
4028     old_savestack_ix = PL_savestack_ix;
4029     SAVECOPFILE_FREE(&PL_compiling);
4030     CopFILE_set(&PL_compiling, tryname);
4031     lex_start(NULL, tryrsfp, 0);
4032
4033     if (filter_sub || filter_cache) {
4034         /* We can use the SvPV of the filter PVIO itself as our cache, rather
4035            than hanging another SV from it. In turn, filter_add() optionally
4036            takes the SV to use as the filter (or creates a new SV if passed
4037            NULL), so simply pass in whatever value filter_cache has.  */
4038         SV * const fc = filter_cache ? newSV(0) : NULL;
4039         SV *datasv;
4040         if (fc) sv_copypv(fc, filter_cache);
4041         datasv = filter_add(S_run_user_filter, fc);
4042         IoLINES(datasv) = filter_has_file;
4043         IoTOP_GV(datasv) = MUTABLE_GV(filter_state);
4044         IoBOTTOM_GV(datasv) = MUTABLE_GV(filter_sub);
4045     }
4046
4047     /* switch to eval mode */
4048     cx = cx_pushblock(CXt_EVAL, gimme, SP, old_savestack_ix);
4049     cx_pusheval(cx, PL_op->op_next, newSVpv(name, 0));
4050
4051     SAVECOPLINE(&PL_compiling);
4052     CopLINE_set(&PL_compiling, 0);
4053
4054     PUTBACK;
4055
4056     if (doeval_compile(gimme, NULL, PL_curcop->cop_seq, NULL))
4057         op = DOCATCH(PL_eval_start);
4058     else
4059         op = PL_op->op_next;
4060
4061     LOADED_FILE_PROBE(unixname);
4062
4063     return op;
4064 }
4065
4066 /* This is a op added to hold the hints hash for
4067    pp_entereval. The hash can be modified by the code
4068    being eval'ed, so we return a copy instead. */
4069
4070 PP(pp_hintseval)
4071 {
4072     dSP;
4073     mXPUSHs(MUTABLE_SV(hv_copy_hints_hv(MUTABLE_HV(cSVOP_sv))));
4074     RETURN;
4075 }
4076
4077
4078 PP(pp_entereval)
4079 {
4080     dSP;
4081     PERL_CONTEXT *cx;
4082     SV *sv;
4083     const U8 gimme = GIMME_V;
4084     const U32 was = PL_breakable_sub_gen;
4085     char tbuf[TYPE_DIGITS(long) + 12];
4086     bool saved_delete = FALSE;
4087     char *tmpbuf = tbuf;
4088     STRLEN len;
4089     CV* runcv;
4090     U32 seq, lex_flags = 0;
4091     HV *saved_hh = NULL;
4092     const bool bytes = PL_op->op_private & OPpEVAL_BYTES;
4093     I32 old_savestack_ix;
4094
4095     if (PL_op->op_private & OPpEVAL_HAS_HH) {
4096         saved_hh = MUTABLE_HV(SvREFCNT_inc(POPs));
4097     }
4098     else if (PL_hints & HINT_LOCALIZE_HH || (
4099                 PL_op->op_private & OPpEVAL_COPHH
4100              && PL_curcop->cop_hints & HINT_LOCALIZE_HH
4101             )) {
4102         saved_hh = cop_hints_2hv(PL_curcop, 0);
4103         hv_magic(saved_hh, NULL, PERL_MAGIC_hints);
4104     }
4105     sv = POPs;
4106     if (!SvPOK(sv)) {
4107         /* make sure we've got a plain PV (no overload etc) before testing
4108          * for taint. Making a copy here is probably overkill, but better
4109          * safe than sorry */
4110         STRLEN len;
4111         const char * const p = SvPV_const(sv, len);
4112
4113         sv = newSVpvn_flags(p, len, SVs_TEMP | SvUTF8(sv));
4114         lex_flags |= LEX_START_COPIED;
4115
4116         if (bytes && SvUTF8(sv))
4117             SvPVbyte_force(sv, len);
4118     }
4119     else if (bytes && SvUTF8(sv)) {
4120         /* Don't modify someone else's scalar */
4121         STRLEN len;
4122         sv = newSVsv(sv);
4123         (void)sv_2mortal(sv);
4124         SvPVbyte_force(sv,len);
4125         lex_flags |= LEX_START_COPIED;
4126     }
4127
4128     TAINT_IF(SvTAINTED(sv));
4129     TAINT_PROPER("eval");
4130
4131     old_savestack_ix = PL_savestack_ix;
4132
4133     lex_start(sv, NULL, lex_flags | (PL_op->op_private & OPpEVAL_UNICODE
4134                            ? LEX_IGNORE_UTF8_HINTS
4135                            : bytes ? LEX_EVALBYTES : LEX_START_SAME_FILTER
4136                         )
4137              );
4138
4139     /* switch to eval mode */
4140
4141     if (PERLDB_NAMEEVAL && CopLINE(PL_curcop)) {
4142         SV * const temp_sv = sv_newmortal();
4143         Perl_sv_setpvf(aTHX_ temp_sv, "_<(eval %lu)[%s:%"IVdf"]",
4144                        (unsigned long)++PL_evalseq,
4145                        CopFILE(PL_curcop), (IV)CopLINE(PL_curcop));
4146         tmpbuf = SvPVX(temp_sv);
4147         len = SvCUR(temp_sv);
4148     }
4149     else
4150         len = my_snprintf(tmpbuf, sizeof(tbuf), "_<(eval %lu)", (unsigned long)++PL_evalseq);
4151     SAVECOPFILE_FREE(&PL_compiling);
4152     CopFILE_set(&PL_compiling, tmpbuf+2);
4153     SAVECOPLINE(&PL_compiling);
4154     CopLINE_set(&PL_compiling, 1);
4155     /* special case: an eval '' executed within the DB package gets lexically
4156      * placed in the first non-DB CV rather than the current CV - this
4157      * allows the debugger to execute code, find lexicals etc, in the
4158      * scope of the code being debugged. Passing &seq gets find_runcv
4159      * to do the dirty work for us */
4160     runcv = find_runcv(&seq);
4161
4162     cx = cx_pushblock((CXt_EVAL|CXp_REAL), gimme, SP, old_savestack_ix);
4163     cx_pusheval(cx, PL_op->op_next, NULL);
4164
4165     /* prepare to compile string */
4166
4167     if (PERLDB_LINE_OR_SAVESRC && PL_curstash != PL_debstash)
4168         save_lines(CopFILEAV(&PL_compiling), PL_parser->linestr);
4169     else {
4170         /* XXX For C<eval "...">s within BEGIN {} blocks, this ends up
4171            deleting the eval's FILEGV from the stash before gv_check() runs
4172            (i.e. before run-time proper). To work around the coredump that
4173            ensues, we always turn GvMULTI_on for any globals that were
4174            introduced within evals. See force_ident(). GSAR 96-10-12 */
4175         char *const safestr = savepvn(tmpbuf, len);
4176         SAVEDELETE(PL_defstash, safestr, len);
4177         saved_delete = TRUE;
4178     }
4179
4180     PUTBACK;
4181
4182     if (doeval_compile(gimme, runcv, seq, saved_hh)) {
4183         if (was != PL_breakable_sub_gen /* Some subs defined here. */
4184             ?  PERLDB_LINE_OR_SAVESRC
4185             :  PERLDB_SAVESRC_NOSUBS) {
4186             /* Retain the filegv we created.  */
4187         } else if (!saved_delete) {
4188             char *const safestr = savepvn(tmpbuf, len);
4189             SAVEDELETE(PL_defstash, safestr, len);
4190         }
4191         return DOCATCH(PL_eval_start);
4192     } else {
4193         /* We have already left the scope set up earlier thanks to the LEAVE
4194            in doeval_compile().  */
4195         if (was != PL_breakable_sub_gen /* Some subs defined here. */
4196             ?  PERLDB_LINE_OR_SAVESRC
4197             :  PERLDB_SAVESRC_INVALID) {
4198             /* Retain the filegv we created.  */
4199         } else if (!saved_delete) {
4200             (void)hv_delete(PL_defstash, tmpbuf, len, G_DISCARD);
4201         }
4202         return PL_op->op_next;
4203     }
4204 }
4205
4206 PP(pp_leaveeval)
4207 {
4208     SV **oldsp;
4209     U8 gimme;
4210     PERL_CONTEXT *cx;
4211     OP *retop;
4212     SV *namesv = NULL;
4213     CV *evalcv;
4214     /* grab this value before cx_popeval restores old PL_in_eval */
4215     bool keep = cBOOL(PL_in_eval & EVAL_KEEPERR);
4216
4217     PERL_ASYNC_CHECK();
4218
4219     cx = CX_CUR();
4220     assert(CxTYPE(cx) == CXt_EVAL);
4221
4222     oldsp = PL_stack_base + cx->blk_oldsp;
4223     gimme = cx->blk_gimme;
4224
4225     /* did require return a false value? */
4226     if (       CxOLD_OP_TYPE(cx) == OP_REQUIRE
4227             && !(gimme == G_SCALAR
4228                     ? SvTRUE(*PL_stack_sp)
4229                 : PL_stack_sp > oldsp)
4230     )
4231         namesv = cx->blk_eval.old_namesv;
4232
4233     if (gimme == G_VOID)
4234         PL_stack_sp = oldsp;
4235     else
4236         leave_adjust_stacks(oldsp, oldsp, gimme, 0);
4237
4238     /* the cx_popeval does a leavescope, which frees the optree associated
4239      * with eval, which if it frees the nextstate associated with
4240      * PL_curcop, sets PL_curcop to NULL. Which can mess up freeing a
4241      * regex when running under 'use re Debug' because it needs PL_curcop
4242      * to get the current hints. So restore it early.
4243      */
4244     PL_curcop = cx->blk_oldcop;
4245
4246     CX_LEAVE_SCOPE(cx);
4247     cx_popeval(cx);
4248     cx_popblock(cx);
4249     retop = cx->blk_eval.retop;
4250     evalcv = cx->blk_eval.cv;
4251     CX_POP(cx);
4252
4253 #ifdef DEBUGGING
4254     assert(CvDEPTH(evalcv) == 1);
4255 #endif
4256     CvDEPTH(evalcv) = 0;
4257
4258     if (namesv) { /* require returned false */
4259         /* Unassume the success we assumed earlier. */
4260         S_undo_inc_then_croak(aTHX_ namesv, NULL, TRUE);
4261         NOT_REACHED; /* NOTREACHED */
4262     }
4263
4264     if (!keep)
4265         CLEAR_ERRSV();
4266
4267     return retop;
4268 }
4269
4270 /* Common code for Perl_call_sv and Perl_fold_constants, put here to keep it
4271    close to the related Perl_create_eval_scope.  */
4272 void
4273 Perl_delete_eval_scope(pTHX)
4274 {
4275     PERL_CONTEXT *cx;
4276
4277     cx = CX_CUR();
4278     CX_LEAVE_SCOPE(cx);
4279     cx_popeval(cx);
4280     cx_popblock(cx);
4281     CX_POP(cx);
4282 }
4283
4284 /* Common-ish code salvaged from Perl_call_sv and pp_entertry, because it was
4285    also needed by Perl_fold_constants.  */
4286 void
4287 Perl_create_eval_scope(pTHX_ OP *retop, U32 flags)
4288 {
4289     PERL_CONTEXT *cx;
4290     const U8 gimme = GIMME_V;
4291
4292     cx = cx_pushblock((CXt_EVAL|CXp_TRYBLOCK), gimme,
4293                     PL_stack_sp, PL_savestack_ix);
4294     cx_pusheval(cx, retop, NULL);
4295
4296     PL_in_eval = EVAL_INEVAL;
4297     if (flags & G_KEEPERR)
4298         PL_in_eval |= EVAL_KEEPERR;
4299     else
4300         CLEAR_ERRSV();
4301     if (flags & G_FAKINGEVAL) {
4302         PL_eval_root = PL_op; /* Only needed so that goto works right. */
4303     }
4304 }
4305
4306 PP(pp_entertry)
4307 {
4308     create_eval_scope(cLOGOP->op_other->op_next, 0);
4309     return DOCATCH(PL_op->op_next);
4310 }
4311
4312 PP(pp_leavetry)
4313 {
4314     SV **oldsp;
4315     U8 gimme;
4316     PERL_CONTEXT *cx;
4317     OP *retop;
4318
4319     PERL_ASYNC_CHECK();
4320
4321     cx = CX_CUR();
4322     assert(CxTYPE(cx) == CXt_EVAL);
4323     oldsp = PL_stack_base + cx->blk_oldsp;
4324     gimme = cx->blk_gimme;
4325
4326     if (gimme == G_VOID)
4327         PL_stack_sp = oldsp;
4328     else
4329         leave_adjust_stacks(oldsp, oldsp, gimme, 1);
4330     CX_LEAVE_SCOPE(cx);
4331     cx_popeval(cx);
4332     cx_popblock(cx);
4333     retop = cx->blk_eval.retop;
4334     CX_POP(cx);
4335
4336     CLEAR_ERRSV();
4337     return retop;
4338 }
4339
4340 PP(pp_entergiven)
4341 {
4342     dSP;
4343     PERL_CONTEXT *cx;
4344     const U8 gimme = GIMME_V;
4345     SV *origsv = DEFSV;
4346     SV *newsv = POPs;
4347
4348     assert(!PL_op->op_targ); /* used to be set for lexical $_ */
4349     GvSV(PL_defgv) = SvREFCNT_inc(newsv);
4350
4351     cx = cx_pushblock(CXt_GIVEN, gimme, SP, PL_savestack_ix);
4352     cx_pushgiven(cx, origsv);
4353
4354     RETURN;
4355 }
4356
4357 PP(pp_leavegiven)
4358 {
4359     PERL_CONTEXT *cx;
4360     U8 gimme;
4361     SV **oldsp;
4362     PERL_UNUSED_CONTEXT;
4363
4364     cx = CX_CUR();
4365     assert(CxTYPE(cx) == CXt_GIVEN);
4366     oldsp = PL_stack_base + cx->blk_oldsp;
4367     gimme = cx->blk_gimme;
4368
4369     if (gimme == G_VOID)
4370         PL_stack_sp = oldsp;
4371     else
4372         leave_adjust_stacks(oldsp, oldsp, gimme, 1);
4373
4374     CX_LEAVE_SCOPE(cx);
4375     cx_popgiven(cx);
4376     cx_popblock(cx);
4377     CX_POP(cx);
4378
4379     return NORMAL;
4380 }
4381
4382 /* Helper routines used by pp_smartmatch */
4383 STATIC PMOP *
4384 S_make_matcher(pTHX_ REGEXP *re)
4385 {
4386     PMOP *matcher = (PMOP *) newPMOP(OP_MATCH, OPf_WANT_SCALAR | OPf_STACKED);
4387
4388     PERL_ARGS_ASSERT_MAKE_MATCHER;
4389
4390     PM_SETRE(matcher, ReREFCNT_inc(re));
4391
4392     SAVEFREEOP((OP *) matcher);
4393     ENTER_with_name("matcher"); SAVETMPS;
4394     SAVEOP();
4395     return matcher;
4396 }
4397
4398 STATIC bool
4399 S_matcher_matches_sv(pTHX_ PMOP *matcher, SV *sv)
4400 {
4401     dSP;
4402     bool result;
4403
4404     PERL_ARGS_ASSERT_MATCHER_MATCHES_SV;
4405
4406     PL_op = (OP *) matcher;
4407     XPUSHs(sv);
4408     PUTBACK;
4409     (void) Perl_pp_match(aTHX);
4410     SPAGAIN;
4411     result = SvTRUEx(POPs);
4412     PUTBACK;
4413
4414     return result;
4415 }
4416
4417 STATIC void
4418 S_destroy_matcher(pTHX_ PMOP *matcher)
4419 {
4420     PERL_ARGS_ASSERT_DESTROY_MATCHER;
4421     PERL_UNUSED_ARG(matcher);
4422
4423     FREETMPS;
4424     LEAVE_with_name("matcher");
4425 }
4426
4427 /* Do a smart match */
4428 PP(pp_smartmatch)
4429 {
4430     DEBUG_M(Perl_deb(aTHX_ "Starting smart match resolution\n"));
4431     return do_smartmatch(NULL, NULL, 0);
4432 }
4433
4434 /* This version of do_smartmatch() implements the
4435  * table of smart matches that is found in perlsyn.
4436  */
4437 STATIC OP *
4438 S_do_smartmatch(pTHX_ HV *seen_this, HV *seen_other, const bool copied)
4439 {
4440     dSP;
4441
4442     bool object_on_left = FALSE;
4443     SV *e = TOPs;       /* e is for 'expression' */
4444     SV *d = TOPm1s;     /* d is for 'default', as in PL_defgv */
4445
4446     /* Take care only to invoke mg_get() once for each argument.
4447      * Currently we do this by copying the SV if it's magical. */
4448     if (d) {
4449         if (!copied && SvGMAGICAL(d))
4450             d = sv_mortalcopy(d);
4451     }
4452     else
4453         d = &PL_sv_undef;
4454
4455     assert(e);
4456     if (SvGMAGICAL(e))
4457         e = sv_mortalcopy(e);
4458
4459     /* First of all, handle overload magic of the rightmost argument */
4460     if (SvAMAGIC(e)) {
4461         SV * tmpsv;
4462         DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-Object\n"));
4463         DEBUG_M(Perl_deb(aTHX_ "        attempting overload\n"));
4464
4465         tmpsv = amagic_call(d, e, smart_amg, AMGf_noleft);
4466         if (tmpsv) {
4467             SPAGAIN;
4468             (void)POPs;
4469             SETs(tmpsv);
4470             RETURN;
4471         }
4472         DEBUG_M(Perl_deb(aTHX_ "        failed to run overload method; continuing...\n"));
4473     }
4474
4475     SP -= 2;    /* Pop the values */
4476     PUTBACK;
4477
4478     /* ~~ undef */
4479     if (!SvOK(e)) {
4480         DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-undef\n"));
4481         if (SvOK(d))
4482             RETPUSHNO;
4483         else
4484             RETPUSHYES;
4485     }
4486
4487     if (SvROK(e) && SvOBJECT(SvRV(e)) && (SvTYPE(SvRV(e)) != SVt_REGEXP)) {
4488         DEBUG_M(Perl_deb(aTHX_ "    applying rule Any-Object\n"));
4489         Perl_croak(aTHX_ "Smart matching a non-overloaded object breaks encapsulation");
4490     }
4491     if (SvROK(d) && SvOBJECT(SvRV(d)) && (SvTYPE(SvRV(d)) != SVt_REGEXP))
4492         object_on_left = TRUE;
4493
4494     /* ~~ sub */
4495     if (SvROK(e) && SvTYPE(SvRV(e)) == SVt_PVCV) {
4496         I32 c;