pp_hot.c

   1 /*    pp_hot.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  * Then he heard Merry change the note, and up went the Horn-cry of Buckland,
  13  * shaking the air.
  14  *
  15  *                  Awake!  Awake!  Fear, Fire, Foes!  Awake!
  16  *                               Fire, Foes!  Awake!
  17  *
  18  *     [p.1007 of _The Lord of the Rings_, VI/viii: "The Scouring of the Shire"]
  19  */
  20
  21 /* This file contains 'hot' pp ("push/pop") functions that
  22  * execute the opcodes that make up a perl program. A typical pp function
  23  * expects to find its arguments on the stack, and usually pushes its
  24  * results onto the stack, hence the 'pp' terminology. Each OP structure
  25  * contains a pointer to the relevant pp_foo() function.
  26  *
  27  * By 'hot', we mean common ops whose execution speed is critical.
  28  * By gathering them together into a single file, we encourage
  29  * CPU cache hits on hot code. Also it could be taken as a warning not to
  30  * change any code in this file unless you're sure it won't affect
  31  * performance.
  32  */
  33
  34 #include "EXTERN.h"
  35 #define PERL_IN_PP_HOT_C
  36 #include "perl.h"
  37
  38 /* Hot code. */
  39
  40 PP(pp_const)
  41 {
  42     dSP;
  43     XPUSHs(cSVOP_sv);
  44     RETURN;
  45 }
  46
  47 PP(pp_nextstate)
  48 {
  49     PL_curcop = (COP*)PL_op;
  50     TAINT_NOT;          /* Each statement is presumed innocent */
  51     PL_stack_sp = PL_stack_base + CX_CUR()->blk_oldsp;
  52     FREETMPS;
  53     PERL_ASYNC_CHECK();
  54     return NORMAL;
  55 }
  56
  57 PP(pp_gvsv)
  58 {
  59     dSP;
  60     EXTEND(SP,1);
  61     if (UNLIKELY(PL_op->op_private & OPpLVAL_INTRO))
  62         PUSHs(save_scalar(cGVOP_gv));
  63     else
  64         PUSHs(GvSVn(cGVOP_gv));
  65     RETURN;
  66 }
  67
  68
  69 /* also used for: pp_lineseq() pp_regcmaybe() pp_scalar() pp_scope() */
  70
  71 PP(pp_null)
  72 {
  73     return NORMAL;
  74 }
  75
  76 /* This is sometimes called directly by pp_coreargs, pp_grepstart and
  77    amagic_call. */
  78 PP(pp_pushmark)
  79 {
  80     PUSHMARK(PL_stack_sp);
  81     return NORMAL;
  82 }
  83
  84 PP(pp_stringify)
  85 {
  86     dSP; dTARGET;
  87     SV * const sv = TOPs;
  88     SETs(TARG);
  89     sv_copypv(TARG, sv);
  90     SvSETMAGIC(TARG);
  91     /* no PUTBACK, SETs doesn't inc/dec SP */
  92     return NORMAL;
  93 }
  94
  95 PP(pp_gv)
  96 {
  97     dSP;
  98     XPUSHs(MUTABLE_SV(cGVOP_gv));
  99     RETURN;
 100 }
 101
 102
 103 /* also used for: pp_andassign() */
 104
 105 PP(pp_and)
 106 {
 107     PERL_ASYNC_CHECK();
 108     {
 109         /* SP is not used to remove a variable that is saved across the
 110           sv_2bool_flags call in SvTRUE_NN, if a RISC/CISC or low/high machine
 111           register or load/store vs direct mem ops macro is introduced, this
 112           should be a define block between direct PL_stack_sp and dSP operations,
 113           presently, using PL_stack_sp is bias towards CISC cpus */
 114         SV * const sv = *PL_stack_sp;
 115         if (!SvTRUE_NN(sv))
 116             return NORMAL;
 117         else {
 118             if (PL_op->op_type == OP_AND)
 119                 --PL_stack_sp;
 120             return cLOGOP->op_other;
 121         }
 122     }
 123 }
 124
 125 PP(pp_sassign)
 126 {
 127     dSP;
 128     /* sassign keeps its args in the optree traditionally backwards.
 129        So we pop them differently.
 130     */
 131     SV *left = POPs; SV *right = TOPs;
 132
 133     if (PL_op->op_private & OPpASSIGN_BACKWARDS) { /* {or,and,dor}assign */
 134         SV * const temp = left;
 135         left = right; right = temp;
 136     }
 137     assert(TAINTING_get || !TAINT_get);
 138     if (UNLIKELY(TAINT_get) && !SvTAINTED(right))
 139         TAINT_NOT;
 140     if (UNLIKELY(PL_op->op_private & OPpASSIGN_CV_TO_GV)) {
 141         /* *foo =\&bar */
 142         SV * const cv = SvRV(right);
 143         const U32 cv_type = SvTYPE(cv);
 144         const bool is_gv = isGV_with_GP(left);
 145         const bool got_coderef = cv_type == SVt_PVCV || cv_type == SVt_PVFM;
 146
 147         if (!got_coderef) {
 148             assert(SvROK(cv));
 149         }
 150
 151         /* Can do the optimisation if left (LVALUE) is not a typeglob,
 152            right (RVALUE) is a reference to something, and we're in void
 153            context. */
 154         if (!got_coderef && !is_gv && GIMME_V == G_VOID) {
 155             /* Is the target symbol table currently empty?  */
 156             GV * const gv = gv_fetchsv_nomg(left, GV_NOINIT, SVt_PVGV);
 157             if (SvTYPE(gv) != SVt_PVGV && !SvOK(gv)) {
 158                 /* Good. Create a new proxy constant subroutine in the target.
 159                    The gv becomes a(nother) reference to the constant.  */
 160                 SV *const value = SvRV(cv);
 161
 162                 SvUPGRADE(MUTABLE_SV(gv), SVt_IV);
 163                 SvPCS_IMPORTED_on(gv);
 164                 SvRV_set(gv, value);
 165                 SvREFCNT_inc_simple_void(value);
 166                 SETs(left);
 167                 RETURN;
 168             }
 169         }
 170
 171         /* Need to fix things up.  */
 172         if (!is_gv) {
 173             /* Need to fix GV.  */
 174             left = MUTABLE_SV(gv_fetchsv_nomg(left,GV_ADD, SVt_PVGV));
 175         }
 176
 177         if (!got_coderef) {
 178             /* We've been returned a constant rather than a full subroutine,
 179                but they expect a subroutine reference to apply.  */
 180             if (SvROK(cv)) {
 181                 ENTER_with_name("sassign_coderef");
 182                 SvREFCNT_inc_void(SvRV(cv));
 183                 /* newCONSTSUB takes a reference count on the passed in SV
 184                    from us.  We set the name to NULL, otherwise we get into
 185                    all sorts of fun as the reference to our new sub is
 186                    donated to the GV that we're about to assign to.
 187                 */
 188                 SvRV_set(right, MUTABLE_SV(newCONSTSUB(GvSTASH(left), NULL,
 189                                                       SvRV(cv))));
 190                 SvREFCNT_dec_NN(cv);
 191                 LEAVE_with_name("sassign_coderef");
 192             } else {
 193                 /* What can happen for the corner case *{"BONK"} = \&{"BONK"};
 194                    is that
 195                    First:   ops for \&{"BONK"}; return us the constant in the
 196                             symbol table
 197                    Second:  ops for *{"BONK"} cause that symbol table entry
 198                             (and our reference to it) to be upgraded from RV
 199                             to typeblob)
 200                    Thirdly: We get here. cv is actually PVGV now, and its
 201                             GvCV() is actually the subroutine we're looking for
 202
 203                    So change the reference so that it points to the subroutine
 204                    of that typeglob, as that's what they were after all along.
 205                 */
 206                 GV *const upgraded = MUTABLE_GV(cv);
 207                 CV *const source = GvCV(upgraded);
 208
 209                 assert(source);
 210                 assert(CvFLAGS(source) & CVf_CONST);
 211
 212                 SvREFCNT_inc_simple_void_NN(source);
 213                 SvREFCNT_dec_NN(upgraded);
 214                 SvRV_set(right, MUTABLE_SV(source));
 215             }
 216         }
 217
 218     }
 219     if (
 220       UNLIKELY(SvTEMP(left)) && !SvSMAGICAL(left) && SvREFCNT(left) == 1 &&
 221       (!isGV_with_GP(left) || SvFAKE(left)) && ckWARN(WARN_MISC)
 222     )
 223         Perl_warner(aTHX_
 224             packWARN(WARN_MISC), "Useless assignment to a temporary"
 225         );
 226     SvSetMagicSV(left, right);
 227     SETs(left);
 228     RETURN;
 229 }
 230
 231 PP(pp_cond_expr)
 232 {
 233     dSP;
 234     PERL_ASYNC_CHECK();
 235     if (SvTRUEx(POPs))
 236         RETURNOP(cLOGOP->op_other);
 237     else
 238         RETURNOP(cLOGOP->op_next);
 239 }
 240
 241 PP(pp_unstack)
 242 {
 243     PERL_CONTEXT *cx;
 244     PERL_ASYNC_CHECK();
 245     TAINT_NOT;          /* Each statement is presumed innocent */
 246     cx  = CX_CUR();
 247     PL_stack_sp = PL_stack_base + cx->blk_oldsp;
 248     FREETMPS;
 249     if (!(PL_op->op_flags & OPf_SPECIAL)) {
 250         assert(CxTYPE(cx) == CXt_BLOCK || CxTYPE_is_LOOP(cx));
 251         CX_LEAVE_SCOPE(cx);
 252     }
 253     return NORMAL;
 254 }
 255
 256 PP(pp_concat)
 257 {
 258   dSP; dATARGET; tryAMAGICbin_MG(concat_amg, AMGf_assign);
 259   {
 260     dPOPTOPssrl;
 261     bool lbyte;
 262     STRLEN rlen;
 263     const char *rpv = NULL;
 264     bool rbyte = FALSE;
 265     bool rcopied = FALSE;
 266
 267     if (TARG == right && right != left) { /* $r = $l.$r */
 268         rpv = SvPV_nomg_const(right, rlen);
 269         rbyte = !DO_UTF8(right);
 270         right = newSVpvn_flags(rpv, rlen, SVs_TEMP);
 271         rpv = SvPV_const(right, rlen);  /* no point setting UTF-8 here */
 272         rcopied = TRUE;
 273     }
 274
 275     if (TARG != left) { /* not $l .= $r */
 276         STRLEN llen;
 277         const char* const lpv = SvPV_nomg_const(left, llen);
 278         lbyte = !DO_UTF8(left);
 279         sv_setpvn(TARG, lpv, llen);
 280         if (!lbyte)
 281             SvUTF8_on(TARG);
 282         else
 283             SvUTF8_off(TARG);
 284     }
 285     else { /* $l .= $r   and   left == TARG */
 286         if (!SvOK(left)) {
 287             if ((left == right                          /* $l .= $l */
 288                  || (PL_op->op_private & OPpTARGET_MY)) /* $l = $l . $r */
 289                 && ckWARN(WARN_UNINITIALIZED)
 290                 )
 291                 report_uninit(left);
 292             sv_setpvs(left, "");
 293         }
 294         else {
 295             SvPV_force_nomg_nolen(left);
 296         }
 297         lbyte = !DO_UTF8(left);
 298         if (IN_BYTES)
 299             SvUTF8_off(left);
 300     }
 301
 302     if (!rcopied) {
 303         rpv = SvPV_nomg_const(right, rlen);
 304         rbyte = !DO_UTF8(right);
 305     }
 306     if (lbyte != rbyte) {
 307         if (lbyte)
 308             sv_utf8_upgrade_nomg(TARG);
 309         else {
 310             if (!rcopied)
 311                 right = newSVpvn_flags(rpv, rlen, SVs_TEMP);
 312             sv_utf8_upgrade_nomg(right);
 313             rpv = SvPV_nomg_const(right, rlen);
 314         }
 315     }
 316     sv_catpvn_nomg(TARG, rpv, rlen);
 317
 318     SETTARG;
 319     RETURN;
 320   }
 321 }
 322
 323 /* push the elements of av onto the stack.
 324  * XXX Note that padav has similar code but without the mg_get().
 325  * I suspect that the mg_get is no longer needed, but while padav
 326  * differs, it can't share this function */
 327
 328 STATIC void
 329 S_pushav(pTHX_ AV* const av)
 330 {
 331     dSP;
 332     const SSize_t maxarg = AvFILL(av) + 1;
 333     EXTEND(SP, maxarg);
 334     if (UNLIKELY(SvRMAGICAL(av))) {
 335         PADOFFSET i;
 336         for (i=0; i < (PADOFFSET)maxarg; i++) {
 337             SV ** const svp = av_fetch(av, i, FALSE);
 338             /* See note in pp_helem, and bug id #27839 */
 339             SP[i+1] = svp
 340                 ? SvGMAGICAL(*svp) ? (mg_get(*svp), *svp) : *svp
 341                 : &PL_sv_undef;
 342         }
 343     }
 344     else {
 345         PADOFFSET i;
 346         for (i=0; i < (PADOFFSET)maxarg; i++) {
 347             SV * const sv = AvARRAY(av)[i];
 348             SP[i+1] = LIKELY(sv) ? sv : &PL_sv_undef;
 349         }
 350     }
 351     SP += maxarg;
 352     PUTBACK;
 353 }
 354
 355
 356 /* ($lex1,@lex2,...)   or my ($lex1,@lex2,...)  */
 357
 358 PP(pp_padrange)
 359 {
 360     dSP;
 361     PADOFFSET base = PL_op->op_targ;
 362     int count = (int)(PL_op->op_private) & OPpPADRANGE_COUNTMASK;
 363     int i;
 364     if (PL_op->op_flags & OPf_SPECIAL) {
 365         /* fake the RHS of my ($x,$y,..) = @_ */
 366         PUSHMARK(SP);
 367         S_pushav(aTHX_ GvAVn(PL_defgv));
 368         SPAGAIN;
 369     }
 370
 371     /* note, this is only skipped for compile-time-known void cxt */
 372     if ((PL_op->op_flags & OPf_WANT) != OPf_WANT_VOID) {
 373         EXTEND(SP, count);
 374         PUSHMARK(SP);
 375         for (i = 0; i <count; i++)
 376             *++SP = PAD_SV(base+i);
 377     }
 378     if (PL_op->op_private & OPpLVAL_INTRO) {
 379         SV **svp = &(PAD_SVl(base));
 380         const UV payload = (UV)(
 381                       (base << (OPpPADRANGE_COUNTSHIFT + SAVE_TIGHT_SHIFT))
 382                     | (count << SAVE_TIGHT_SHIFT)
 383                     | SAVEt_CLEARPADRANGE);
 384         STATIC_ASSERT_STMT(OPpPADRANGE_COUNTMASK + 1 == (1 << OPpPADRANGE_COUNTSHIFT));
 385         assert((payload >> (OPpPADRANGE_COUNTSHIFT+SAVE_TIGHT_SHIFT))
 386                 == (Size_t)base);
 387         {
 388             dSS_ADD;
 389             SS_ADD_UV(payload);
 390             SS_ADD_END(1);
 391         }
 392
 393         for (i = 0; i <count; i++)
 394             SvPADSTALE_off(*svp++); /* mark lexical as active */
 395     }
 396     RETURN;
 397 }
 398
 399
 400 PP(pp_padsv)
 401 {
 402     dSP;
 403     EXTEND(SP, 1);
 404     {
 405         OP * const op = PL_op;
 406         /* access PL_curpad once */
 407         SV ** const padentry = &(PAD_SVl(op->op_targ));
 408         {
 409             dTARG;
 410             TARG = *padentry;
 411             PUSHs(TARG);
 412             PUTBACK; /* no pop/push after this, TOPs ok */
 413         }
 414         if (op->op_flags & OPf_MOD) {
 415             if (op->op_private & OPpLVAL_INTRO)
 416                 if (!(op->op_private & OPpPAD_STATE))
 417                     save_clearsv(padentry);
 418             if (op->op_private & OPpDEREF) {
 419                 /* TOPs is equivalent to TARG here.  Using TOPs (SP) rather
 420                    than TARG reduces the scope of TARG, so it does not
 421                    span the call to save_clearsv, resulting in smaller
 422                    machine code. */
 423                 TOPs = vivify_ref(TOPs, op->op_private & OPpDEREF);
 424             }
 425         }
 426         return op->op_next;
 427     }
 428 }
 429
 430 PP(pp_readline)
 431 {
 432     dSP;
 433     if (TOPs) {
 434         SvGETMAGIC(TOPs);
 435         tryAMAGICunTARGETlist(iter_amg, 0);
 436         PL_last_in_gv = MUTABLE_GV(*PL_stack_sp--);
 437     }
 438     else PL_last_in_gv = PL_argvgv, PL_stack_sp--;
 439     if (!isGV_with_GP(PL_last_in_gv)) {
 440         if (SvROK(PL_last_in_gv) && isGV_with_GP(SvRV(PL_last_in_gv)))
 441             PL_last_in_gv = MUTABLE_GV(SvRV(PL_last_in_gv));
 442         else {
 443             dSP;
 444             XPUSHs(MUTABLE_SV(PL_last_in_gv));
 445             PUTBACK;
 446             Perl_pp_rv2gv(aTHX);
 447             PL_last_in_gv = MUTABLE_GV(*PL_stack_sp--);
 448             if (PL_last_in_gv == (GV *)&PL_sv_undef)
 449                 PL_last_in_gv = NULL;
 450             else
 451                 assert(isGV_with_GP(PL_last_in_gv));
 452         }
 453     }
 454     return do_readline();
 455 }
 456
 457 PP(pp_eq)
 458 {
 459     dSP;
 460     SV *left, *right;
 461
 462     tryAMAGICbin_MG(eq_amg, AMGf_set|AMGf_numeric);
 463     right = POPs;
 464     left  = TOPs;
 465     SETs(boolSV(
 466         (SvIOK_notUV(left) && SvIOK_notUV(right))
 467         ? (SvIVX(left) == SvIVX(right))
 468         : ( do_ncmp(left, right) == 0)
 469     ));
 470     RETURN;
 471 }
 472
 473
 474 /* also used for: pp_i_preinc() */
 475
 476 PP(pp_preinc)
 477 {
 478     SV *sv = *PL_stack_sp;
 479
 480     if (LIKELY(((sv->sv_flags &
 481                         (SVf_THINKFIRST|SVs_GMG|SVf_IVisUV|
 482                          SVf_IOK|SVf_NOK|SVf_POK|SVp_NOK|SVp_POK|SVf_ROK))
 483                 == SVf_IOK))
 484         && SvIVX(sv) != IV_MAX)
 485     {
 486         SvIV_set(sv, SvIVX(sv) + 1);
 487     }
 488     else /* Do all the PERL_PRESERVE_IVUV and hard cases in sv_inc */
 489         sv_inc(sv);
 490     SvSETMAGIC(sv);
 491     return NORMAL;
 492 }
 493
 494
 495 /* also used for: pp_i_predec() */
 496
 497 PP(pp_predec)
 498 {
 499     SV *sv = *PL_stack_sp;
 500
 501     if (LIKELY(((sv->sv_flags &
 502                         (SVf_THINKFIRST|SVs_GMG|SVf_IVisUV|
 503                          SVf_IOK|SVf_NOK|SVf_POK|SVp_NOK|SVp_POK|SVf_ROK))
 504                 == SVf_IOK))
 505         && SvIVX(sv) != IV_MIN)
 506     {
 507         SvIV_set(sv, SvIVX(sv) - 1);
 508     }
 509     else /* Do all the PERL_PRESERVE_IVUV and hard cases  in sv_dec */
 510         sv_dec(sv);
 511     SvSETMAGIC(sv);
 512     return NORMAL;
 513 }
 514
 515
 516 /* also used for: pp_orassign() */
 517
 518 PP(pp_or)
 519 {
 520     dSP;
 521     PERL_ASYNC_CHECK();
 522     if (SvTRUE(TOPs))
 523         RETURN;
 524     else {
 525         if (PL_op->op_type == OP_OR)
 526             --SP;
 527         RETURNOP(cLOGOP->op_other);
 528     }
 529 }
 530
 531
 532 /* also used for: pp_dor() pp_dorassign() */
 533
 534 PP(pp_defined)
 535 {
 536     dSP;
 537     SV* sv;
 538     bool defined;
 539     const int op_type = PL_op->op_type;
 540     const bool is_dor = (op_type == OP_DOR || op_type == OP_DORASSIGN);
 541
 542     if (is_dor) {
 543         PERL_ASYNC_CHECK();
 544         sv = TOPs;
 545         if (UNLIKELY(!sv || !SvANY(sv))) {
 546             if (op_type == OP_DOR)
 547                 --SP;
 548             RETURNOP(cLOGOP->op_other);
 549         }
 550     }
 551     else {
 552         /* OP_DEFINED */
 553         sv = POPs;
 554         if (UNLIKELY(!sv || !SvANY(sv)))
 555             RETPUSHNO;
 556     }
 557
 558     defined = FALSE;
 559     switch (SvTYPE(sv)) {
 560     case SVt_PVAV:
 561         if (AvMAX(sv) >= 0 || SvGMAGICAL(sv) || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
 562             defined = TRUE;
 563         break;
 564     case SVt_PVHV:
 565         if (HvARRAY(sv) || SvGMAGICAL(sv) || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
 566             defined = TRUE;
 567         break;
 568     case SVt_PVCV:
 569         if (CvROOT(sv) || CvXSUB(sv))
 570             defined = TRUE;
 571         break;
 572     default:
 573         SvGETMAGIC(sv);
 574         if (SvOK(sv))
 575             defined = TRUE;
 576         break;
 577     }
 578
 579     if (is_dor) {
 580         if(defined)
 581             RETURN;
 582         if(op_type == OP_DOR)
 583             --SP;
 584         RETURNOP(cLOGOP->op_other);
 585     }
 586     /* assuming OP_DEFINED */
 587     if(defined)
 588         RETPUSHYES;
 589     RETPUSHNO;
 590 }
 591
 592
 593
 594 PP(pp_add)
 595 {
 596     dSP; dATARGET; bool useleft; SV *svl, *svr;
 597
 598     tryAMAGICbin_MG(add_amg, AMGf_assign|AMGf_numeric);
 599     svr = TOPs;
 600     svl = TOPm1s;
 601
 602 #ifdef PERL_PRESERVE_IVUV
 603
 604     /* special-case some simple common cases */
 605     if (!((svl->sv_flags|svr->sv_flags) & (SVf_IVisUV|SVs_GMG))) {
 606         IV il, ir;
 607         U32 flags = (svl->sv_flags & svr->sv_flags);
 608         if (flags & SVf_IOK) {
 609             /* both args are simple IVs */
 610             UV topl, topr;
 611             il = SvIVX(svl);
 612             ir = SvIVX(svr);
 613           do_iv:
 614             topl = ((UV)il) >> (UVSIZE * 8 - 2);
 615             topr = ((UV)ir) >> (UVSIZE * 8 - 2);
 616
 617             /* if both are in a range that can't under/overflow, do a
 618              * simple integer add: if the top of both numbers
 619              * are 00  or 11, then it's safe */
 620             if (!( ((topl+1) | (topr+1)) & 2)) {
 621                 SP--;
 622                 TARGi(il + ir, 0); /* args not GMG, so can't be tainted */
 623                 SETs(TARG);
 624                 RETURN;
 625             }
 626             goto generic;
 627         }
 628         else if (flags & SVf_NOK) {
 629             /* both args are NVs */
 630             NV nl = SvNVX(svl);
 631             NV nr = SvNVX(svr);
 632
 633             if (
 634 #if defined(NAN_COMPARE_BROKEN) && defined(Perl_isnan)
 635                 !Perl_isnan(nl) && nl == (NV)(il = (IV)nl)
 636                 && !Perl_isnan(nr) && nr == (NV)(ir = (IV)nr)
 637 #else
 638                 nl == (NV)(il = (IV)nl) && nr == (NV)(ir = (IV)nr)
 639 #endif
 640                 )
 641                 /* nothing was lost by converting to IVs */
 642                 goto do_iv;
 643             SP--;
 644             TARGn(nl + nr, 0); /* args not GMG, so can't be tainted */
 645             SETs(TARG);
 646             RETURN;
 647         }
 648     }
 649
 650   generic:
 651
 652     useleft = USE_LEFT(svl);
 653     /* We must see if we can perform the addition with integers if possible,
 654        as the integer code detects overflow while the NV code doesn't.
 655        If either argument hasn't had a numeric conversion yet attempt to get
 656        the IV. It's important to do this now, rather than just assuming that
 657        it's not IOK as a PV of "9223372036854775806" may not take well to NV
 658        addition, and an SV which is NOK, NV=6.0 ought to be coerced to
 659        integer in case the second argument is IV=9223372036854775806
 660        We can (now) rely on sv_2iv to do the right thing, only setting the
 661        public IOK flag if the value in the NV (or PV) slot is truly integer.
 662
 663        A side effect is that this also aggressively prefers integer maths over
 664        fp maths for integer values.
 665
 666        How to detect overflow?
 667
 668        C 99 section 6.2.6.1 says
 669
 670        The range of nonnegative values of a signed integer type is a subrange
 671        of the corresponding unsigned integer type, and the representation of
 672        the same value in each type is the same. A computation involving
 673        unsigned operands can never overflow, because a result that cannot be
 674        represented by the resulting unsigned integer type is reduced modulo
 675        the number that is one greater than the largest value that can be
 676        represented by the resulting type.
 677
 678        (the 9th paragraph)
 679
 680        which I read as "unsigned ints wrap."
 681
 682        signed integer overflow seems to be classed as "exception condition"
 683
 684        If an exceptional condition occurs during the evaluation of an
 685        expression (that is, if the result is not mathematically defined or not
 686        in the range of representable values for its type), the behavior is
 687        undefined.
 688
 689        (6.5, the 5th paragraph)
 690
 691        I had assumed that on 2s complement machines signed arithmetic would
 692        wrap, hence coded pp_add and pp_subtract on the assumption that
 693        everything perl builds on would be happy.  After much wailing and
 694        gnashing of teeth it would seem that irix64 knows its ANSI spec well,
 695        knows that it doesn't need to, and doesn't.  Bah.  Anyway, the all-
 696        unsigned code below is actually shorter than the old code. :-)
 697     */
 698
 699     if (SvIV_please_nomg(svr)) {
 700         /* Unless the left argument is integer in range we are going to have to
 701            use NV maths. Hence only attempt to coerce the right argument if
 702            we know the left is integer.  */
 703         UV auv = 0;
 704         bool auvok = FALSE;
 705         bool a_valid = 0;
 706
 707         if (!useleft) {
 708             auv = 0;
 709             a_valid = auvok = 1;
 710             /* left operand is undef, treat as zero. + 0 is identity,
 711                Could SETi or SETu right now, but space optimise by not adding
 712                lots of code to speed up what is probably a rarish case.  */
 713         } else {
 714             /* Left operand is defined, so is it IV? */
 715             if (SvIV_please_nomg(svl)) {
 716                 if ((auvok = SvUOK(svl)))
 717                     auv = SvUVX(svl);
 718                 else {
 719                     const IV aiv = SvIVX(svl);
 720                     if (aiv >= 0) {
 721                         auv = aiv;
 722                         auvok = 1;      /* Now acting as a sign flag.  */
 723                     } else {
 724                         auv = (aiv == IV_MIN) ? (UV)aiv : (UV)(-aiv);
 725                     }
 726                 }
 727                 a_valid = 1;
 728             }
 729         }
 730         if (a_valid) {
 731             bool result_good = 0;
 732             UV result;
 733             UV buv;
 734             bool buvok = SvUOK(svr);
 735
 736             if (buvok)
 737                 buv = SvUVX(svr);
 738             else {
 739                 const IV biv = SvIVX(svr);
 740                 if (biv >= 0) {
 741                     buv = biv;
 742                     buvok = 1;
 743                 } else
 744                     buv = (biv == IV_MIN) ? (UV)biv : (UV)(-biv);
 745             }
 746             /* ?uvok if value is >= 0. basically, flagged as UV if it's +ve,
 747                else "IV" now, independent of how it came in.
 748                if a, b represents positive, A, B negative, a maps to -A etc
 749                a + b =>  (a + b)
 750                A + b => -(a - b)
 751                a + B =>  (a - b)
 752                A + B => -(a + b)
 753                all UV maths. negate result if A negative.
 754                add if signs same, subtract if signs differ. */
 755
 756             if (auvok ^ buvok) {
 757                 /* Signs differ.  */
 758                 if (auv >= buv) {
 759                     result = auv - buv;
 760                     /* Must get smaller */
 761                     if (result <= auv)
 762                         result_good = 1;
 763                 } else {
 764                     result = buv - auv;
 765                     if (result <= buv) {
 766                         /* result really should be -(auv-buv). as its negation
 767                            of true value, need to swap our result flag  */
 768                         auvok = !auvok;
 769                         result_good = 1;
 770                     }
 771                 }
 772             } else {
 773                 /* Signs same */
 774                 result = auv + buv;
 775                 if (result >= auv)
 776                     result_good = 1;
 777             }
 778             if (result_good) {
 779                 SP--;
 780                 if (auvok)
 781                     SETu( result );
 782                 else {
 783                     /* Negate result */
 784                     if (result <= (UV)IV_MIN)
 785                         SETi(result == (UV)IV_MIN
 786                                 ? IV_MIN : -(IV)result);
 787                     else {
 788                         /* result valid, but out of range for IV.  */
 789                         SETn( -(NV)result );
 790                     }
 791                 }
 792                 RETURN;
 793             } /* Overflow, drop through to NVs.  */
 794         }
 795     }
 796
 797 #else
 798     useleft = USE_LEFT(svl);
 799 #endif
 800
 801     {
 802         NV value = SvNV_nomg(svr);
 803         (void)POPs;
 804         if (!useleft) {
 805             /* left operand is undef, treat as zero. + 0.0 is identity. */
 806             SETn(value);
 807             RETURN;
 808         }
 809         SETn( value + SvNV_nomg(svl) );
 810         RETURN;
 811     }
 812 }
 813
 814
 815 /* also used for: pp_aelemfast_lex() */
 816
 817 PP(pp_aelemfast)
 818 {
 819     dSP;
 820     AV * const av = PL_op->op_type == OP_AELEMFAST_LEX
 821         ? MUTABLE_AV(PAD_SV(PL_op->op_targ)) : GvAVn(cGVOP_gv);
 822     const U32 lval = PL_op->op_flags & OPf_MOD;
 823     const I8 key   = (I8)PL_op->op_private;
 824     SV** svp;
 825     SV *sv;
 826
 827     assert(SvTYPE(av) == SVt_PVAV);
 828
 829     EXTEND(SP, 1);
 830
 831     /* inlined av_fetch() for simple cases ... */
 832     if (!SvRMAGICAL(av) && key >= 0 && key <= AvFILLp(av)) {
 833         sv = AvARRAY(av)[key];
 834         if (sv) {
 835             PUSHs(sv);
 836             RETURN;
 837         }
 838     }
 839
 840     /* ... else do it the hard way */
 841     svp = av_fetch(av, key, lval);
 842     sv = (svp ? *svp : &PL_sv_undef);
 843
 844     if (UNLIKELY(!svp && lval))
 845         DIE(aTHX_ PL_no_aelem, (int)key);
 846
 847     if (!lval && SvRMAGICAL(av) && SvGMAGICAL(sv)) /* see note in pp_helem() */
 848         mg_get(sv);
 849     PUSHs(sv);
 850     RETURN;
 851 }
 852
 853 PP(pp_join)
 854 {
 855     dSP; dMARK; dTARGET;
 856     MARK++;
 857     do_join(TARG, *MARK, MARK, SP);
 858     SP = MARK;
 859     SETs(TARG);
 860     RETURN;
 861 }
 862
 863 /* Oversized hot code. */
 864
 865 /* also used for: pp_say() */
 866
 867 PP(pp_print)
 868 {
 869     dSP; dMARK; dORIGMARK;
 870     PerlIO *fp;
 871     MAGIC *mg;
 872     GV * const gv
 873         = (PL_op->op_flags & OPf_STACKED) ? MUTABLE_GV(*++MARK) : PL_defoutgv;
 874     IO *io = GvIO(gv);
 875
 876     if (io
 877         && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
 878     {
 879       had_magic:
 880         if (MARK == ORIGMARK) {
 881             /* If using default handle then we need to make space to
 882              * pass object as 1st arg, so move other args up ...
 883              */
 884             MEXTEND(SP, 1);
 885             ++MARK;
 886             Move(MARK, MARK + 1, (SP - MARK) + 1, SV*);
 887             ++SP;
 888         }
 889         return Perl_tied_method(aTHX_ SV_CONST(PRINT), mark - 1, MUTABLE_SV(io),
 890                                 mg,
 891                                 (G_SCALAR | TIED_METHOD_ARGUMENTS_ON_STACK
 892                                  | (PL_op->op_type == OP_SAY
 893                                     ? TIED_METHOD_SAY : 0)), sp - mark);
 894     }
 895     if (!io) {
 896         if ( gv && GvEGVx(gv) && (io = GvIO(GvEGV(gv)))
 897             && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
 898             goto had_magic;
 899         report_evil_fh(gv);
 900         SETERRNO(EBADF,RMS_IFI);
 901         goto just_say_no;
 902     }
 903     else if (!(fp = IoOFP(io))) {
 904         if (IoIFP(io))
 905             report_wrongway_fh(gv, '<');
 906         else
 907             report_evil_fh(gv);
 908         SETERRNO(EBADF,IoIFP(io)?RMS_FAC:RMS_IFI);
 909         goto just_say_no;
 910     }
 911     else {
 912         SV * const ofs = GvSV(PL_ofsgv); /* $, */
 913         MARK++;
 914         if (ofs && (SvGMAGICAL(ofs) || SvOK(ofs))) {
 915             while (MARK <= SP) {
 916                 if (!do_print(*MARK, fp))
 917                     break;
 918                 MARK++;
 919                 if (MARK <= SP) {
 920                     /* don't use 'ofs' here - it may be invalidated by magic callbacks */
 921                     if (!do_print(GvSV(PL_ofsgv), fp)) {
 922                         MARK--;
 923                         break;
 924                     }
 925                 }
 926             }
 927         }
 928         else {
 929             while (MARK <= SP) {
 930                 if (!do_print(*MARK, fp))
 931                     break;
 932                 MARK++;
 933             }
 934         }
 935         if (MARK <= SP)
 936             goto just_say_no;
 937         else {
 938             if (PL_op->op_type == OP_SAY) {
 939                 if (PerlIO_write(fp, "\n", 1) == 0 || PerlIO_error(fp))
 940                     goto just_say_no;
 941             }
 942             else if (PL_ors_sv && SvOK(PL_ors_sv))
 943                 if (!do_print(PL_ors_sv, fp)) /* $\ */
 944                     goto just_say_no;
 945
 946             if (IoFLAGS(io) & IOf_FLUSH)
 947                 if (PerlIO_flush(fp) == EOF)
 948                     goto just_say_no;
 949         }
 950     }
 951     SP = ORIGMARK;
 952     XPUSHs(&PL_sv_yes);
 953     RETURN;
 954
 955   just_say_no:
 956     SP = ORIGMARK;
 957     XPUSHs(&PL_sv_undef);
 958     RETURN;
 959 }
 960
 961
 962 /* also used for: pp_rv2hv() */
 963 /* also called directly by pp_lvavref */
 964
 965 PP(pp_rv2av)
 966 {
 967     dSP; dTOPss;
 968     const U8 gimme = GIMME_V;
 969     static const char an_array[] = "an ARRAY";
 970     static const char a_hash[] = "a HASH";
 971     const bool is_pp_rv2av = PL_op->op_type == OP_RV2AV
 972                           || PL_op->op_type == OP_LVAVREF;
 973     const svtype type = is_pp_rv2av ? SVt_PVAV : SVt_PVHV;
 974
 975     SvGETMAGIC(sv);
 976     if (SvROK(sv)) {
 977         if (UNLIKELY(SvAMAGIC(sv))) {
 978             sv = amagic_deref_call(sv, is_pp_rv2av ? to_av_amg : to_hv_amg);
 979         }
 980         sv = SvRV(sv);
 981         if (UNLIKELY(SvTYPE(sv) != type))
 982             /* diag_listed_as: Not an ARRAY reference */
 983             DIE(aTHX_ "Not %s reference", is_pp_rv2av ? an_array : a_hash);
 984         else if (UNLIKELY(PL_op->op_flags & OPf_MOD
 985                 && PL_op->op_private & OPpLVAL_INTRO))
 986             Perl_croak(aTHX_ "%s", PL_no_localize_ref);
 987     }
 988     else if (UNLIKELY(SvTYPE(sv) != type)) {
 989             GV *gv;
 990
 991             if (!isGV_with_GP(sv)) {
 992                 gv = Perl_softref2xv(aTHX_ sv, is_pp_rv2av ? an_array : a_hash,
 993                                      type, &sp);
 994                 if (!gv)
 995                     RETURN;
 996             }
 997             else {
 998                 gv = MUTABLE_GV(sv);
 999             }
1000             sv = is_pp_rv2av ? MUTABLE_SV(GvAVn(gv)) : MUTABLE_SV(GvHVn(gv));
1001             if (PL_op->op_private & OPpLVAL_INTRO)
1002                 sv = is_pp_rv2av ? MUTABLE_SV(save_ary(gv)) : MUTABLE_SV(save_hash(gv));
1003     }
1004     if (PL_op->op_flags & OPf_REF) {
1005                 SETs(sv);
1006                 RETURN;
1007     }
1008     else if (UNLIKELY(PL_op->op_private & OPpMAYBE_LVSUB)) {
1009               const I32 flags = is_lvalue_sub();
1010               if (flags && !(flags & OPpENTERSUB_INARGS)) {
1011                 if (gimme != G_ARRAY)
1012                     goto croak_cant_return;
1013                 SETs(sv);
1014                 RETURN;
1015               }
1016     }
1017
1018     if (is_pp_rv2av) {
1019         AV *const av = MUTABLE_AV(sv);
1020         /* The guts of pp_rv2av  */
1021         if (gimme == G_ARRAY) {
1022             SP--;
1023             PUTBACK;
1024             S_pushav(aTHX_ av);
1025             SPAGAIN;
1026         }
1027         else if (gimme == G_SCALAR) {
1028             dTARGET;
1029             const SSize_t maxarg = AvFILL(av) + 1;
1030             SETi(maxarg);
1031         }
1032     } else {
1033         /* The guts of pp_rv2hv  */
1034         if (gimme == G_ARRAY) { /* array wanted */
1035             *PL_stack_sp = sv;
1036             return Perl_do_kv(aTHX);
1037         }
1038         else if ((PL_op->op_private & OPpTRUEBOOL
1039               || (  PL_op->op_private & OPpMAYBE_TRUEBOOL
1040                  && block_gimme() == G_VOID  ))
1041               && (!SvRMAGICAL(sv) || !mg_find(sv, PERL_MAGIC_tied)))
1042             SETs(HvUSEDKEYS(sv) ? &PL_sv_yes : sv_2mortal(newSViv(0)));
1043         else if (gimme == G_SCALAR) {
1044             dTARG;
1045             TARG = Perl_hv_scalar(aTHX_ MUTABLE_HV(sv));
1046             SETTARG;
1047         }
1048     }
1049     RETURN;
1050
1051  croak_cant_return:
1052     Perl_croak(aTHX_ "Can't return %s to lvalue scalar context",
1053                is_pp_rv2av ? "array" : "hash");
1054     RETURN;
1055 }
1056
1057 STATIC void
1058 S_do_oddball(pTHX_ SV **oddkey, SV **firstkey)
1059 {
1060     PERL_ARGS_ASSERT_DO_ODDBALL;
1061
1062     if (*oddkey) {
1063         if (ckWARN(WARN_MISC)) {
1064             const char *err;
1065             if (oddkey == firstkey &&
1066                 SvROK(*oddkey) &&
1067                 (SvTYPE(SvRV(*oddkey)) == SVt_PVAV ||
1068                  SvTYPE(SvRV(*oddkey)) == SVt_PVHV))
1069             {
1070                 err = "Reference found where even-sized list expected";
1071             }
1072             else
1073                 err = "Odd number of elements in hash assignment";
1074             Perl_warner(aTHX_ packWARN(WARN_MISC), "%s", err);
1075         }
1076
1077     }
1078 }
1079
1080
1081 /* Do a mark and sweep with the SVf_BREAK flag to detect elements which
1082  * are common to both the LHS and RHS of an aassign, and replace them
1083  * with copies. All these copies are made before the actual list assign is
1084  * done.
1085  *
1086  * For example in ($a,$b) = ($b,$a), assigning the value of the first RHS
1087  * element ($b) to the first LH element ($a), modifies $a; when the
1088  * second assignment is done, the second RH element now has the wrong
1089  * value. So we initially replace the RHS with ($b, mortalcopy($a)).
1090  * Note that we don't need to make a mortal copy of $b.
1091  *
1092  * The algorithm below works by, for every RHS element, mark the
1093  * corresponding LHS target element with SVf_BREAK. Then if the RHS
1094  * element is found with SVf_BREAK set, it means it would have been
1095  * modified, so make a copy.
1096  * Note that by scanning both LHS and RHS in lockstep, we avoid
1097  * unnecessary copies (like $b above) compared with a naive
1098  * "mark all LHS; copy all marked RHS; unmark all LHS".
1099  *
1100  * If the LHS element is a 'my' declaration' and has a refcount of 1, then
1101  * it can't be common and can be skipped.
1102  *
1103  * On DEBUGGING builds it takes an extra boolean, fake. If true, it means
1104  * that we thought we didn't need to call S_aassign_copy_common(), but we
1105  * have anyway for sanity checking. If we find we need to copy, then panic.
1106  */
1107
1108 PERL_STATIC_INLINE void
1109 S_aassign_copy_common(pTHX_ SV **firstlelem, SV **lastlelem,
1110         SV **firstrelem, SV **lastrelem
1111 #ifdef DEBUGGING
1112         , bool fake
1113 #endif
1114 )
1115 {
1116     dVAR;
1117     SV **relem;
1118     SV **lelem;
1119     SSize_t lcount = lastlelem - firstlelem + 1;
1120     bool marked = FALSE; /* have we marked any LHS with SVf_BREAK ? */
1121     bool const do_rc1 = cBOOL(PL_op->op_private & OPpASSIGN_COMMON_RC1);
1122     bool copy_all = FALSE;
1123
1124     assert(!PL_in_clean_all); /* SVf_BREAK not already in use */
1125     assert(firstlelem < lastlelem); /* at least 2 LH elements */
1126     assert(firstrelem < lastrelem); /* at least 2 RH elements */
1127
1128
1129     lelem = firstlelem;
1130     /* we never have to copy the first RH element; it can't be corrupted
1131      * by assigning something to the corresponding first LH element.
1132      * So this scan does in a loop: mark LHS[N]; test RHS[N+1]
1133      */
1134     relem = firstrelem + 1;
1135
1136     for (; relem <= lastrelem; relem++) {
1137         SV *svr;
1138
1139         /* mark next LH element */
1140
1141         if (--lcount >= 0) {
1142             SV *svl = *lelem++;
1143
1144             if (UNLIKELY(!svl)) {/* skip AV alias marker */
1145                 assert (lelem <= lastlelem);
1146                 svl = *lelem++;
1147                 lcount--;
1148             }
1149
1150             assert(svl);
1151             if (SvSMAGICAL(svl)) {
1152                 copy_all = TRUE;
1153             }
1154             if (SvTYPE(svl) == SVt_PVAV || SvTYPE(svl) == SVt_PVHV) {
1155                 if (!marked)
1156                     return;
1157                 /* this LH element will consume all further args;
1158                  * no need to mark any further LH elements (if any).
1159                  * But we still need to scan any remaining RHS elements;
1160                  * set lcount negative to distinguish from  lcount == 0,
1161                  * so the loop condition continues being true
1162                  */
1163                 lcount = -1;
1164                 lelem--; /* no need to unmark this element */
1165             }
1166             else if (!(do_rc1 && SvREFCNT(svl) == 1) && svl != &PL_sv_undef) {
1167                 assert(!SvIMMORTAL(svl));
1168                 SvFLAGS(svl) |= SVf_BREAK;
1169                 marked = TRUE;
1170             }
1171             else if (!marked) {
1172                 /* don't check RH element if no SVf_BREAK flags set yet */
1173                 if (!lcount)
1174                     break;
1175                 continue;
1176             }
1177         }
1178
1179         /* see if corresponding RH element needs copying */
1180
1181         assert(marked);
1182         svr = *relem;
1183         assert(svr);
1184
1185         if (UNLIKELY(SvFLAGS(svr) & (SVf_BREAK|SVs_GMG) || copy_all)) {
1186
1187 #ifdef DEBUGGING
1188             if (fake) {
1189                 /* op_dump(PL_op); */
1190                 Perl_croak(aTHX_
1191                     "panic: aassign skipped needed copy of common RH elem %"
1192                         UVuf, (UV)(relem - firstrelem));
1193             }
1194 #endif
1195
1196             TAINT_NOT;  /* Each item is independent */
1197
1198             /* Dear TODO test in t/op/sort.t, I love you.
1199                (It's relying on a panic, not a "semi-panic" from newSVsv()
1200                and then an assertion failure below.)  */
1201             if (UNLIKELY(SvIS_FREED(svr))) {
1202                 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p",
1203                            (void*)svr);
1204             }
1205             /* avoid break flag while copying; otherwise COW etc
1206              * disabled... */
1207             SvFLAGS(svr) &= ~SVf_BREAK;
1208             /* Not newSVsv(), as it does not allow copy-on-write,
1209                resulting in wasteful copies.
1210                Also, we use SV_NOSTEAL in case the SV is used more than
1211                once, e.g.  (...) = (f())[0,0]
1212                Where the same SV appears twice on the RHS without a ref
1213                count bump.  (Although I suspect that the SV won't be
1214                stealable here anyway - DAPM).
1215                */
1216             *relem = sv_mortalcopy_flags(svr,
1217                                 SV_GMAGIC|SV_DO_COW_SVSETSV|SV_NOSTEAL);
1218             /* ... but restore afterwards in case it's needed again,
1219              * e.g. ($a,$b,$c) = (1,$a,$a)
1220              */
1221             SvFLAGS(svr) |= SVf_BREAK;
1222         }
1223
1224         if (!lcount)
1225             break;
1226     }
1227
1228     if (!marked)
1229         return;
1230
1231     /*unmark LHS */
1232
1233     while (lelem > firstlelem) {
1234         SV * const svl = *(--lelem);
1235         if (svl)
1236             SvFLAGS(svl) &= ~SVf_BREAK;
1237     }
1238 }
1239
1240
1241
1242 PP(pp_aassign)
1243 {
1244     dVAR; dSP;
1245     SV **lastlelem = PL_stack_sp;
1246     SV **lastrelem = PL_stack_base + POPMARK;
1247     SV **firstrelem = PL_stack_base + POPMARK + 1;
1248     SV **firstlelem = lastrelem + 1;
1249
1250     SV **relem;
1251     SV **lelem;
1252
1253     SV *sv;
1254     AV *ary;
1255
1256     U8 gimme;
1257     HV *hash;
1258     SSize_t i;
1259     int magic;
1260     U32 lval;
1261     /* PL_delaymagic is restored by JUMPENV_POP on dieing, so we
1262      * only need to save locally, not on the save stack */
1263     U16 old_delaymagic = PL_delaymagic;
1264 #ifdef DEBUGGING
1265     bool fake = 0;
1266 #endif
1267
1268     PL_delaymagic = DM_DELAY;           /* catch simultaneous items */
1269
1270     /* If there's a common identifier on both sides we have to take
1271      * special care that assigning the identifier on the left doesn't
1272      * clobber a value on the right that's used later in the list.
1273      */
1274
1275     /* at least 2 LH and RH elements, or commonality isn't an issue */
1276     if (firstlelem < lastlelem && firstrelem < lastrelem) {
1277         for (relem = firstrelem+1; relem <= lastrelem; relem++) {
1278             if (SvGMAGICAL(*relem))
1279                 goto do_scan;
1280         }
1281         for (lelem = firstlelem; lelem <= lastlelem; lelem++) {
1282             if (*lelem && SvSMAGICAL(*lelem))
1283                 goto do_scan;
1284         }
1285         if ( PL_op->op_private & (OPpASSIGN_COMMON_SCALAR|OPpASSIGN_COMMON_RC1) ) {
1286             if (PL_op->op_private & OPpASSIGN_COMMON_RC1) {
1287                 /* skip the scan if all scalars have a ref count of 1 */
1288                 for (lelem = firstlelem; lelem <= lastlelem; lelem++) {
1289                     sv = *lelem;
1290                     if (!sv || SvREFCNT(sv) == 1)
1291                         continue;
1292                     if (SvTYPE(sv) != SVt_PVAV && SvTYPE(sv) != SVt_PVAV)
1293                         goto do_scan;
1294                     break;
1295                 }
1296             }
1297             else {
1298             do_scan:
1299                 S_aassign_copy_common(aTHX_
1300                                       firstlelem, lastlelem, firstrelem, lastrelem
1301 #ifdef DEBUGGING
1302                     , fake
1303 #endif
1304                 );
1305             }
1306         }
1307     }
1308 #ifdef DEBUGGING
1309     else {
1310         /* on debugging builds, do the scan even if we've concluded we
1311          * don't need to, then panic if we find commonality. Note that the
1312          * scanner assumes at least 2 elements */
1313         if (firstlelem < lastlelem && firstrelem < lastrelem) {
1314             fake = 1;
1315             goto do_scan;
1316         }
1317     }
1318 #endif
1319
1320     gimme = GIMME_V;
1321     lval = (gimme == G_ARRAY) ? (PL_op->op_flags & OPf_MOD || LVRET) : 0;
1322
1323     relem = firstrelem;
1324     lelem = firstlelem;
1325     ary = NULL;
1326     hash = NULL;
1327
1328     while (LIKELY(lelem <= lastlelem)) {
1329         bool alias = FALSE;
1330         TAINT_NOT;              /* Each item stands on its own, taintwise. */
1331         sv = *lelem++;
1332         if (UNLIKELY(!sv)) {
1333             alias = TRUE;
1334             sv = *lelem++;
1335             ASSUME(SvTYPE(sv) == SVt_PVAV);
1336         }
1337         switch (SvTYPE(sv)) {
1338         case SVt_PVAV: {
1339             bool already_copied = FALSE;
1340             ary = MUTABLE_AV(sv);
1341             magic = SvMAGICAL(ary) != 0;
1342             ENTER;
1343             SAVEFREESV(SvREFCNT_inc_simple_NN(sv));
1344
1345             /* We need to clear ary. The is a danger that if we do this,
1346              * elements on the RHS may be prematurely freed, e.g.
1347              *   @a = ($a[0]);
1348              * In the case of possible commonality, make a copy of each
1349              * RHS SV *before* clearing the array, and add a reference
1350              * from the tmps stack, so that it doesn't leak on death.
1351              * Otherwise, make a copy of each RHS SV only as we're storing
1352              * it into the array - that way we don't have to worry about
1353              * it being leaked if we die, but don't incur the cost of
1354              * mortalising everything.
1355              */
1356
1357             if (   (PL_op->op_private & OPpASSIGN_COMMON_AGG)
1358                 && (relem <= lastrelem)
1359                 && (magic || AvFILL(ary) != -1))
1360             {
1361                 SV **svp;
1362                 EXTEND_MORTAL(lastrelem - relem + 1);
1363                 for (svp = relem; svp <= lastrelem; svp++) {
1364                     /* see comment in S_aassign_copy_common about SV_NOSTEAL */
1365                     *svp = sv_mortalcopy_flags(*svp,
1366                             SV_GMAGIC|SV_DO_COW_SVSETSV|SV_NOSTEAL);
1367                     TAINT_NOT;
1368                 }
1369                 already_copied = TRUE;
1370             }
1371
1372             av_clear(ary);
1373             if (relem <= lastrelem)
1374                 av_extend(ary, lastrelem - relem);
1375
1376             i = 0;
1377             while (relem <= lastrelem) {        /* gobble up all the rest */
1378                 SV **didstore;
1379                 if (LIKELY(!alias)) {
1380                     if (already_copied)
1381                         sv = *relem;
1382                     else {
1383                         if (LIKELY(*relem))
1384                             /* before newSV, in case it dies */
1385                             SvGETMAGIC(*relem);
1386                         sv = newSV(0);
1387                         /* see comment in S_aassign_copy_common about
1388                          * SV_NOSTEAL */
1389                         sv_setsv_flags(sv, *relem,
1390                                     (SV_DO_COW_SVSETSV|SV_NOSTEAL));
1391                         *relem = sv;
1392                     }
1393                 }
1394                 else {
1395                     if (!already_copied)
1396                         SvGETMAGIC(*relem);
1397                     if (!SvROK(*relem))
1398                         DIE(aTHX_ "Assigned value is not a reference");
1399                     if (SvTYPE(SvRV(*relem)) > SVt_PVLV)
1400                    /* diag_listed_as: Assigned value is not %s reference */
1401                         DIE(aTHX_
1402                            "Assigned value is not a SCALAR reference");
1403                     if (lval && !already_copied)
1404                         *relem = sv_mortalcopy(*relem);
1405                     /* XXX else check for weak refs?  */
1406                     sv = SvREFCNT_inc_NN(SvRV(*relem));
1407                 }
1408                 relem++;
1409                 if (already_copied)
1410                     SvREFCNT_inc_simple_void_NN(sv); /* undo mortal free */
1411                 didstore = av_store(ary,i++,sv);
1412                 if (magic) {
1413                     if (!didstore)
1414                         sv_2mortal(sv);
1415                     if (SvSMAGICAL(sv))
1416                         mg_set(sv);
1417                 }
1418                 TAINT_NOT;
1419             }
1420             if (UNLIKELY(PL_delaymagic & DM_ARRAY_ISA))
1421                 SvSETMAGIC(MUTABLE_SV(ary));
1422             LEAVE;
1423             break;
1424         }
1425
1426         case SVt_PVHV: {                                /* normal hash */
1427                 SV *tmpstr;
1428                 int odd;
1429                 int duplicates = 0;
1430                 SV** topelem = relem;
1431                 SV **firsthashrelem = relem;
1432                 bool already_copied = FALSE;
1433
1434                 hash = MUTABLE_HV(sv);
1435                 magic = SvMAGICAL(hash) != 0;
1436
1437                 odd = ((lastrelem - firsthashrelem)&1)? 0 : 1;
1438                 if (UNLIKELY(odd)) {
1439                     do_oddball(lastrelem, firsthashrelem);
1440                     /* we have firstlelem to reuse, it's not needed anymore
1441                      */
1442                     *(lastrelem+1) = &PL_sv_undef;
1443                 }
1444
1445                 ENTER;
1446                 SAVEFREESV(SvREFCNT_inc_simple_NN(sv));
1447
1448                 /* We need to clear hash. The is a danger that if we do this,
1449                  * elements on the RHS may be prematurely freed, e.g.
1450                  *   %h = (foo => $h{bar});
1451                  * In the case of possible commonality, make a copy of each
1452                  * RHS SV *before* clearing the hash, and add a reference
1453                  * from the tmps stack, so that it doesn't leak on death.
1454                  */
1455
1456                 if (   (PL_op->op_private & OPpASSIGN_COMMON_AGG)
1457                     && (relem <= lastrelem)
1458                     && (magic || HvUSEDKEYS(hash)))
1459                 {
1460                     SV **svp;
1461                     EXTEND_MORTAL(lastrelem - relem + 1);
1462                     for (svp = relem; svp <= lastrelem; svp++) {
1463                         *svp = sv_mortalcopy_flags(*svp,
1464                                 SV_GMAGIC|SV_DO_COW_SVSETSV|SV_NOSTEAL);
1465                         TAINT_NOT;
1466                     }
1467                     already_copied = TRUE;
1468                 }
1469
1470                 hv_clear(hash);
1471
1472                 while (LIKELY(relem < lastrelem+odd)) { /* gobble up all the rest */
1473                     HE *didstore;
1474                     assert(*relem);
1475                     /* Copy the key if aassign is called in lvalue context,
1476                        to avoid having the next op modify our rhs.  Copy
1477                        it also if it is gmagical, lest it make the
1478                        hv_store_ent call below croak, leaking the value. */
1479                     sv = (lval || SvGMAGICAL(*relem)) && !already_copied
1480                          ? sv_mortalcopy(*relem)
1481                          : *relem;
1482                     relem++;
1483                     assert(*relem);
1484                     if (already_copied)
1485                         tmpstr = *relem++;
1486                     else {
1487                         SvGETMAGIC(*relem);
1488                         tmpstr = newSV(0);
1489                         sv_setsv_nomg(tmpstr,*relem++); /* value */
1490                     }
1491
1492                     if (gimme == G_ARRAY) {
1493                         if (hv_exists_ent(hash, sv, 0))
1494                             /* key overwrites an existing entry */
1495                             duplicates += 2;
1496                         else {
1497                             /* copy element back: possibly to an earlier
1498                              * stack location if we encountered dups earlier,
1499                              * possibly to a later stack location if odd */
1500                             *topelem++ = sv;
1501                             *topelem++ = tmpstr;
1502                         }
1503                     }
1504                     if (already_copied)
1505                         SvREFCNT_inc_simple_void_NN(tmpstr); /* undo mortal free */
1506                     didstore = hv_store_ent(hash,sv,tmpstr,0);
1507                     if (magic) {
1508                         if (!didstore) sv_2mortal(tmpstr);
1509                         SvSETMAGIC(tmpstr);
1510                     }
1511                     TAINT_NOT;
1512                 }
1513                 LEAVE;
1514                 if (duplicates && gimme == G_ARRAY) {
1515                     /* at this point we have removed the duplicate key/value
1516                      * pairs from the stack, but the remaining values may be
1517                      * wrong; i.e. with (a 1 a 2 b 3) on the stack we've removed
1518                      * the (a 2), but the stack now probably contains
1519                      * (a <freed> b 3), because { hv_save(a,1); hv_save(a,2) }
1520                      * obliterates the earlier key. So refresh all values. */
1521                     lastrelem -= duplicates;
1522                     relem = firsthashrelem;
1523                     while (relem < lastrelem+odd) {
1524                         HE *he;
1525                         he = hv_fetch_ent(hash, *relem++, 0, 0);
1526                         *relem++ = (he ? HeVAL(he) : &PL_sv_undef);
1527                     }
1528                 }
1529                 if (odd && gimme == G_ARRAY) lastrelem++;
1530             }
1531             break;
1532         default:
1533             if (SvIMMORTAL(sv)) {
1534                 if (relem <= lastrelem)
1535                     relem++;
1536                 break;
1537             }
1538             if (relem <= lastrelem) {
1539                 if (UNLIKELY(
1540                   SvTEMP(sv) && !SvSMAGICAL(sv) && SvREFCNT(sv) == 1 &&
1541                   (!isGV_with_GP(sv) || SvFAKE(sv)) && ckWARN(WARN_MISC)
1542                 ))
1543                     Perl_warner(aTHX_
1544                        packWARN(WARN_MISC),
1545                       "Useless assignment to a temporary"
1546                     );
1547                 sv_setsv(sv, *relem);
1548                 *(relem++) = sv;
1549             }
1550             else
1551                 sv_setsv(sv, &PL_sv_undef);
1552             SvSETMAGIC(sv);
1553             break;
1554         }
1555     }
1556     if (UNLIKELY(PL_delaymagic & ~DM_DELAY)) {
1557         /* Will be used to set PL_tainting below */
1558         Uid_t tmp_uid  = PerlProc_getuid();
1559         Uid_t tmp_euid = PerlProc_geteuid();
1560         Gid_t tmp_gid  = PerlProc_getgid();
1561         Gid_t tmp_egid = PerlProc_getegid();
1562
1563         /* XXX $> et al currently silently ignore failures */
1564         if (PL_delaymagic & DM_UID) {
1565 #ifdef HAS_SETRESUID
1566             PERL_UNUSED_RESULT(
1567                setresuid((PL_delaymagic & DM_RUID) ? PL_delaymagic_uid  : (Uid_t)-1,
1568                          (PL_delaymagic & DM_EUID) ? PL_delaymagic_euid : (Uid_t)-1,
1569                          (Uid_t)-1));
1570 #else
1571 #  ifdef HAS_SETREUID
1572             PERL_UNUSED_RESULT(
1573                 setreuid((PL_delaymagic & DM_RUID) ? PL_delaymagic_uid  : (Uid_t)-1,
1574                          (PL_delaymagic & DM_EUID) ? PL_delaymagic_euid : (Uid_t)-1));
1575 #  else
1576 #    ifdef HAS_SETRUID
1577             if ((PL_delaymagic & DM_UID) == DM_RUID) {
1578                 PERL_UNUSED_RESULT(setruid(PL_delaymagic_uid));
1579                 PL_delaymagic &= ~DM_RUID;
1580             }
1581 #    endif /* HAS_SETRUID */
1582 #    ifdef HAS_SETEUID
1583             if ((PL_delaymagic & DM_UID) == DM_EUID) {
1584                 PERL_UNUSED_RESULT(seteuid(PL_delaymagic_euid));
1585                 PL_delaymagic &= ~DM_EUID;
1586             }
1587 #    endif /* HAS_SETEUID */
1588             if (PL_delaymagic & DM_UID) {
1589                 if (PL_delaymagic_uid != PL_delaymagic_euid)
1590                     DIE(aTHX_ "No setreuid available");
1591                 PERL_UNUSED_RESULT(PerlProc_setuid(PL_delaymagic_uid));
1592             }
1593 #  endif /* HAS_SETREUID */
1594 #endif /* HAS_SETRESUID */
1595
1596             tmp_uid  = PerlProc_getuid();
1597             tmp_euid = PerlProc_geteuid();
1598         }
1599         /* XXX $> et al currently silently ignore failures */
1600         if (PL_delaymagic & DM_GID) {
1601 #ifdef HAS_SETRESGID
1602             PERL_UNUSED_RESULT(
1603                 setresgid((PL_delaymagic & DM_RGID) ? PL_delaymagic_gid  : (Gid_t)-1,
1604                           (PL_delaymagic & DM_EGID) ? PL_delaymagic_egid : (Gid_t)-1,
1605                           (Gid_t)-1));
1606 #else
1607 #  ifdef HAS_SETREGID
1608             PERL_UNUSED_RESULT(
1609                 setregid((PL_delaymagic & DM_RGID) ? PL_delaymagic_gid  : (Gid_t)-1,
1610                          (PL_delaymagic & DM_EGID) ? PL_delaymagic_egid : (Gid_t)-1));
1611 #  else
1612 #    ifdef HAS_SETRGID
1613             if ((PL_delaymagic & DM_GID) == DM_RGID) {
1614                 PERL_UNUSED_RESULT(setrgid(PL_delaymagic_gid));
1615                 PL_delaymagic &= ~DM_RGID;
1616             }
1617 #    endif /* HAS_SETRGID */
1618 #    ifdef HAS_SETEGID
1619             if ((PL_delaymagic & DM_GID) == DM_EGID) {
1620                 PERL_UNUSED_RESULT(setegid(PL_delaymagic_egid));
1621                 PL_delaymagic &= ~DM_EGID;
1622             }
1623 #    endif /* HAS_SETEGID */
1624             if (PL_delaymagic & DM_GID) {
1625                 if (PL_delaymagic_gid != PL_delaymagic_egid)
1626                     DIE(aTHX_ "No setregid available");
1627                 PERL_UNUSED_RESULT(PerlProc_setgid(PL_delaymagic_gid));
1628             }
1629 #  endif /* HAS_SETREGID */
1630 #endif /* HAS_SETRESGID */
1631
1632             tmp_gid  = PerlProc_getgid();
1633             tmp_egid = PerlProc_getegid();
1634         }
1635         TAINTING_set( TAINTING_get | (tmp_uid && (tmp_euid != tmp_uid || tmp_egid != tmp_gid)) );
1636 #ifdef NO_TAINT_SUPPORT
1637         PERL_UNUSED_VAR(tmp_uid);
1638         PERL_UNUSED_VAR(tmp_euid);
1639         PERL_UNUSED_VAR(tmp_gid);
1640         PERL_UNUSED_VAR(tmp_egid);
1641 #endif
1642     }
1643     PL_delaymagic = old_delaymagic;
1644
1645     if (gimme == G_VOID)
1646         SP = firstrelem - 1;
1647     else if (gimme == G_SCALAR) {
1648         dTARGET;
1649         SP = firstrelem;
1650         SETi(lastrelem - firstrelem + 1);
1651     }
1652     else {
1653         if (ary || hash)
1654             /* note that in this case *firstlelem may have been overwritten
1655                by sv_undef in the odd hash case */
1656             SP = lastrelem;
1657         else {
1658             SP = firstrelem + (lastlelem - firstlelem);
1659             lelem = firstlelem + (relem - firstrelem);
1660             while (relem <= SP)
1661                 *relem++ = (lelem <= lastlelem) ? *lelem++ : &PL_sv_undef;
1662         }
1663     }
1664
1665     RETURN;
1666 }
1667
1668 PP(pp_qr)
1669 {
1670     dSP;
1671     PMOP * const pm = cPMOP;
1672     REGEXP * rx = PM_GETRE(pm);
1673     SV * const pkg = rx ? CALLREG_PACKAGE(rx) : NULL;
1674     SV * const rv = sv_newmortal();
1675     CV **cvp;
1676     CV *cv;
1677
1678     SvUPGRADE(rv, SVt_IV);
1679     /* For a subroutine describing itself as "This is a hacky workaround" I'm
1680        loathe to use it here, but it seems to be the right fix. Or close.
1681        The key part appears to be that it's essential for pp_qr to return a new
1682        object (SV), which implies that there needs to be an effective way to
1683        generate a new SV from the existing SV that is pre-compiled in the
1684        optree.  */
1685     SvRV_set(rv, MUTABLE_SV(reg_temp_copy(NULL, rx)));
1686     SvROK_on(rv);
1687
1688     cvp = &( ReANY((REGEXP *)SvRV(rv))->qr_anoncv);
1689     if (UNLIKELY((cv = *cvp) && CvCLONE(*cvp))) {
1690         *cvp = cv_clone(cv);
1691         SvREFCNT_dec_NN(cv);
1692     }
1693
1694     if (pkg) {
1695         HV *const stash = gv_stashsv(pkg, GV_ADD);
1696         SvREFCNT_dec_NN(pkg);
1697         (void)sv_bless(rv, stash);
1698     }
1699
1700     if (UNLIKELY(RX_ISTAINTED(rx))) {
1701         SvTAINTED_on(rv);
1702         SvTAINTED_on(SvRV(rv));
1703     }
1704     XPUSHs(rv);
1705     RETURN;
1706 }
1707
1708 PP(pp_match)
1709 {
1710     dSP; dTARG;
1711     PMOP *pm = cPMOP;
1712     PMOP *dynpm = pm;
1713     const char *s;
1714     const char *strend;
1715     SSize_t curpos = 0; /* initial pos() or current $+[0] */
1716     I32 global;
1717     U8 r_flags = 0;
1718     const char *truebase;                       /* Start of string  */
1719     REGEXP *rx = PM_GETRE(pm);
1720     bool rxtainted;
1721     const U8 gimme = GIMME_V;
1722     STRLEN len;
1723     const I32 oldsave = PL_savestack_ix;
1724     I32 had_zerolen = 0;
1725     MAGIC *mg = NULL;
1726
1727     if (PL_op->op_flags & OPf_STACKED)
1728         TARG = POPs;
1729     else if (ARGTARG)
1730         GETTARGET;
1731     else {
1732         TARG = DEFSV;
1733         EXTEND(SP,1);
1734     }
1735
1736     PUTBACK;                            /* EVAL blocks need stack_sp. */
1737     /* Skip get-magic if this is a qr// clone, because regcomp has
1738        already done it. */
1739     truebase = ReANY(rx)->mother_re
1740          ? SvPV_nomg_const(TARG, len)
1741          : SvPV_const(TARG, len);
1742     if (!truebase)
1743         DIE(aTHX_ "panic: pp_match");
1744     strend = truebase + len;
1745     rxtainted = (RX_ISTAINTED(rx) ||
1746                  (TAINT_get && (pm->op_pmflags & PMf_RETAINT)));
1747     TAINT_NOT;
1748
1749     /* We need to know this in case we fail out early - pos() must be reset */
1750     global = dynpm->op_pmflags & PMf_GLOBAL;
1751
1752     /* PMdf_USED is set after a ?? matches once */
1753     if (
1754 #ifdef USE_ITHREADS
1755         SvREADONLY(PL_regex_pad[pm->op_pmoffset])
1756 #else
1757         pm->op_pmflags & PMf_USED
1758 #endif
1759     ) {
1760         DEBUG_r(PerlIO_printf(Perl_debug_log, "?? already matched once"));
1761         goto nope;
1762     }
1763
1764     /* empty pattern special-cased to use last successful pattern if
1765        possible, except for qr// */
1766     if (!ReANY(rx)->mother_re && !RX_PRELEN(rx)
1767      && PL_curpm) {
1768         pm = PL_curpm;
1769         rx = PM_GETRE(pm);
1770     }
1771
1772     if (RX_MINLEN(rx) >= 0 && (STRLEN)RX_MINLEN(rx) > len) {
1773         DEBUG_r(PerlIO_printf(Perl_debug_log, "String shorter than min possible regex match (%"
1774                                               UVuf" < %"IVdf")\n",
1775                                               (UV)len, (IV)RX_MINLEN(rx)));
1776         goto nope;
1777     }
1778
1779     /* get pos() if //g */
1780     if (global) {
1781         mg = mg_find_mglob(TARG);
1782         if (mg && mg->mg_len >= 0) {
1783             curpos = MgBYTEPOS(mg, TARG, truebase, len);
1784             /* last time pos() was set, it was zero-length match */
1785             if (mg->mg_flags & MGf_MINMATCH)
1786                 had_zerolen = 1;
1787         }
1788     }
1789
1790 #ifdef PERL_SAWAMPERSAND
1791     if (       RX_NPARENS(rx)
1792             || PL_sawampersand
1793             || (RX_EXTFLAGS(rx) & (RXf_EVAL_SEEN|RXf_PMf_KEEPCOPY))
1794             || (dynpm->op_pmflags & PMf_KEEPCOPY)
1795     )
1796 #endif
1797     {
1798         r_flags |= (REXEC_COPY_STR|REXEC_COPY_SKIP_PRE);
1799         /* in @a =~ /(.)/g, we iterate multiple times, but copy the buffer
1800          * only on the first iteration. Therefore we need to copy $' as well
1801          * as $&, to make the rest of the string available for captures in
1802          * subsequent iterations */
1803         if (! (global && gimme == G_ARRAY))
1804             r_flags |= REXEC_COPY_SKIP_POST;
1805     };
1806 #ifdef PERL_SAWAMPERSAND
1807     if (dynpm->op_pmflags & PMf_KEEPCOPY)
1808         /* handle KEEPCOPY in pmop but not rx, eg $r=qr/a/; /$r/p */
1809         r_flags &= ~(REXEC_COPY_SKIP_PRE|REXEC_COPY_SKIP_POST);
1810 #endif
1811
1812     s = truebase;
1813
1814   play_it_again:
1815     if (global)
1816         s = truebase + curpos;
1817
1818     if (!CALLREGEXEC(rx, (char*)s, (char *)strend, (char*)truebase,
1819                      had_zerolen, TARG, NULL, r_flags))
1820         goto nope;
1821
1822     PL_curpm = pm;
1823     if (dynpm->op_pmflags & PMf_ONCE)
1824 #ifdef USE_ITHREADS
1825         SvREADONLY_on(PL_regex_pad[dynpm->op_pmoffset]);
1826 #else
1827         dynpm->op_pmflags |= PMf_USED;
1828 #endif
1829
1830     if (rxtainted)
1831         RX_MATCH_TAINTED_on(rx);
1832     TAINT_IF(RX_MATCH_TAINTED(rx));
1833
1834     /* update pos */
1835
1836     if (global && (gimme != G_ARRAY || (dynpm->op_pmflags & PMf_CONTINUE))) {
1837         if (!mg)
1838             mg = sv_magicext_mglob(TARG);
1839         MgBYTEPOS_set(mg, TARG, truebase, RX_OFFS(rx)[0].end);
1840         if (RX_ZERO_LEN(rx))
1841             mg->mg_flags |= MGf_MINMATCH;
1842         else
1843             mg->mg_flags &= ~MGf_MINMATCH;
1844     }
1845
1846     if ((!RX_NPARENS(rx) && !global) || gimme != G_ARRAY) {
1847         LEAVE_SCOPE(oldsave);
1848         RETPUSHYES;
1849     }
1850
1851     /* push captures on stack */
1852
1853     {
1854         const I32 nparens = RX_NPARENS(rx);
1855         I32 i = (global && !nparens) ? 1 : 0;
1856
1857         SPAGAIN;                        /* EVAL blocks could move the stack. */
1858         EXTEND(SP, nparens + i);
1859         EXTEND_MORTAL(nparens + i);
1860         for (i = !i; i <= nparens; i++) {
1861             PUSHs(sv_newmortal());
1862             if (LIKELY((RX_OFFS(rx)[i].start != -1)
1863                      && RX_OFFS(rx)[i].end   != -1 ))
1864             {
1865                 const I32 len = RX_OFFS(rx)[i].end - RX_OFFS(rx)[i].start;
1866                 const char * const s = RX_OFFS(rx)[i].start + truebase;
1867                 if (UNLIKELY(RX_OFFS(rx)[i].end < 0 || RX_OFFS(rx)[i].start < 0
1868                         || len < 0 || len > strend - s))
1869                     DIE(aTHX_ "panic: pp_match start/end pointers, i=%ld, "
1870                         "start=%ld, end=%ld, s=%p, strend=%p, len=%"UVuf,
1871                         (long) i, (long) RX_OFFS(rx)[i].start,
1872                         (long)RX_OFFS(rx)[i].end, s, strend, (UV) len);
1873                 sv_setpvn(*SP, s, len);
1874                 if (DO_UTF8(TARG) && is_utf8_string((U8*)s, len))
1875                     SvUTF8_on(*SP);
1876             }
1877         }
1878         if (global) {
1879             curpos = (UV)RX_OFFS(rx)[0].end;
1880             had_zerolen = RX_ZERO_LEN(rx);
1881             PUTBACK;                    /* EVAL blocks may use stack */
1882             r_flags |= REXEC_IGNOREPOS | REXEC_NOT_FIRST;
1883             goto play_it_again;
1884         }
1885         LEAVE_SCOPE(oldsave);
1886         RETURN;
1887     }
1888     NOT_REACHED; /* NOTREACHED */
1889
1890   nope:
1891     if (global && !(dynpm->op_pmflags & PMf_CONTINUE)) {
1892         if (!mg)
1893             mg = mg_find_mglob(TARG);
1894         if (mg)
1895             mg->mg_len = -1;
1896     }
1897     LEAVE_SCOPE(oldsave);
1898     if (gimme == G_ARRAY)
1899         RETURN;
1900     RETPUSHNO;
1901 }
1902
1903 OP *
1904 Perl_do_readline(pTHX)
1905 {
1906     dSP; dTARGETSTACKED;
1907     SV *sv;
1908     STRLEN tmplen = 0;
1909     STRLEN offset;
1910     PerlIO *fp;
1911     IO * const io = GvIO(PL_last_in_gv);
1912     const I32 type = PL_op->op_type;
1913     const U8 gimme = GIMME_V;
1914
1915     if (io) {
1916         const MAGIC *const mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar);
1917         if (mg) {
1918             Perl_tied_method(aTHX_ SV_CONST(READLINE), SP, MUTABLE_SV(io), mg, gimme, 0);
1919             if (gimme == G_SCALAR) {
1920                 SPAGAIN;
1921                 SvSetSV_nosteal(TARG, TOPs);
1922                 SETTARG;
1923             }
1924             return NORMAL;
1925         }
1926     }
1927     fp = NULL;
1928     if (io) {
1929         fp = IoIFP(io);
1930         if (!fp) {
1931             if (IoFLAGS(io) & IOf_ARGV) {
1932                 if (IoFLAGS(io) & IOf_START) {
1933                     IoLINES(io) = 0;
1934                     if (av_tindex(GvAVn(PL_last_in_gv)) < 0) {
1935                         IoFLAGS(io) &= ~IOf_START;
1936                         do_open6(PL_last_in_gv, "-", 1, NULL, NULL, 0);
1937                         SvTAINTED_off(GvSVn(PL_last_in_gv)); /* previous tainting irrelevant */
1938                         sv_setpvs(GvSVn(PL_last_in_gv), "-");
1939                         SvSETMAGIC(GvSV(PL_last_in_gv));
1940                         fp = IoIFP(io);
1941                         goto have_fp;
1942                     }
1943                 }
1944                 fp = nextargv(PL_last_in_gv, PL_op->op_flags & OPf_SPECIAL);
1945                 if (!fp) { /* Note: fp != IoIFP(io) */
1946                     (void)do_close(PL_last_in_gv, FALSE); /* now it does*/
1947                 }
1948             }
1949             else if (type == OP_GLOB)
1950                 fp = Perl_start_glob(aTHX_ POPs, io);
1951         }
1952         else if (type == OP_GLOB)
1953             SP--;
1954         else if (IoTYPE(io) == IoTYPE_WRONLY) {
1955             report_wrongway_fh(PL_last_in_gv, '>');
1956         }
1957     }
1958     if (!fp) {
1959         if ((!io || !(IoFLAGS(io) & IOf_START))
1960             && ckWARN(WARN_CLOSED)
1961             && type != OP_GLOB)
1962         {
1963             report_evil_fh(PL_last_in_gv);
1964         }
1965         if (gimme == G_SCALAR) {
1966             /* undef TARG, and push that undefined value */
1967             if (type != OP_RCATLINE) {
1968                 sv_setsv(TARG,NULL);
1969             }
1970             PUSHTARG;
1971         }
1972         RETURN;
1973     }
1974   have_fp:
1975     if (gimme == G_SCALAR) {
1976         sv = TARG;
1977         if (type == OP_RCATLINE && SvGMAGICAL(sv))
1978             mg_get(sv);
1979         if (SvROK(sv)) {
1980             if (type == OP_RCATLINE)
1981                 SvPV_force_nomg_nolen(sv);
1982             else
1983                 sv_unref(sv);
1984         }
1985         else if (isGV_with_GP(sv)) {
1986             SvPV_force_nomg_nolen(sv);
1987         }
1988         SvUPGRADE(sv, SVt_PV);
1989         tmplen = SvLEN(sv);     /* remember if already alloced */
1990         if (!tmplen && !SvREADONLY(sv) && !SvIsCOW(sv)) {
1991             /* try short-buffering it. Please update t/op/readline.t
1992              * if you change the growth length.
1993              */
1994             Sv_Grow(sv, 80);
1995         }
1996         offset = 0;
1997         if (type == OP_RCATLINE && SvOK(sv)) {
1998             if (!SvPOK(sv)) {
1999                 SvPV_force_nomg_nolen(sv);
2000             }
2001             offset = SvCUR(sv);
2002         }
2003     }
2004     else {
2005         sv = sv_2mortal(newSV(80));
2006         offset = 0;
2007     }
2008
2009     /* This should not be marked tainted if the fp is marked clean */
2010 #define MAYBE_TAINT_LINE(io, sv) \
2011     if (!(IoFLAGS(io) & IOf_UNTAINT)) { \
2012         TAINT;                          \
2013         SvTAINTED_on(sv);               \
2014     }
2015
2016 /* delay EOF state for a snarfed empty file */
2017 #define SNARF_EOF(gimme,rs,io,sv) \
2018     (gimme != G_SCALAR || SvCUR(sv)                                     \
2019      || (IoFLAGS(io) & IOf_NOLINE) || !RsSNARF(rs))
2020
2021     for (;;) {
2022         PUTBACK;
2023         if (!sv_gets(sv, fp, offset)
2024             && (type == OP_GLOB
2025                 || SNARF_EOF(gimme, PL_rs, io, sv)
2026                 || PerlIO_error(fp)))
2027         {
2028             PerlIO_clearerr(fp);
2029             if (IoFLAGS(io) & IOf_ARGV) {
2030                 fp = nextargv(PL_last_in_gv, PL_op->op_flags & OPf_SPECIAL);
2031                 if (fp)
2032                     continue;
2033                 (void)do_close(PL_last_in_gv, FALSE);
2034             }
2035             else if (type == OP_GLOB) {
2036                 if (!do_close(PL_last_in_gv, FALSE)) {
2037                     Perl_ck_warner(aTHX_ packWARN(WARN_GLOB),
2038                                    "glob failed (child exited with status %d%s)",
2039                                    (int)(STATUS_CURRENT >> 8),
2040                                    (STATUS_CURRENT & 0x80) ? ", core dumped" : "");
2041                 }
2042             }
2043             if (gimme == G_SCALAR) {
2044                 if (type != OP_RCATLINE) {
2045                     SV_CHECK_THINKFIRST_COW_DROP(TARG);
2046                     SvOK_off(TARG);
2047                 }
2048                 SPAGAIN;
2049                 PUSHTARG;
2050             }
2051             MAYBE_TAINT_LINE(io, sv);
2052             RETURN;
2053         }
2054         MAYBE_TAINT_LINE(io, sv);
2055         IoLINES(io)++;
2056         IoFLAGS(io) |= IOf_NOLINE;
2057         SvSETMAGIC(sv);
2058         SPAGAIN;
2059         XPUSHs(sv);
2060         if (type == OP_GLOB) {
2061             const char *t1;
2062             Stat_t statbuf;
2063
2064             if (SvCUR(sv) > 0 && SvCUR(PL_rs) > 0) {
2065                 char * const tmps = SvEND(sv) - 1;
2066                 if (*tmps == *SvPVX_const(PL_rs)) {
2067                     *tmps = '\0';
2068                     SvCUR_set(sv, SvCUR(sv) - 1);
2069                 }
2070             }
2071             for (t1 = SvPVX_const(sv); *t1; t1++)
2072 #ifdef __VMS
2073                 if (strchr("*%?", *t1))
2074 #else
2075                 if (strchr("$&*(){}[]'\";\\|?<>~`", *t1))
2076 #endif
2077                         break;
2078             if (*t1 && PerlLIO_lstat(SvPVX_const(sv), &statbuf) < 0) {
2079                 (void)POPs;             /* Unmatched wildcard?  Chuck it... */
2080                 continue;
2081             }
2082         } else if (SvUTF8(sv)) { /* OP_READLINE, OP_RCATLINE */
2083              if (ckWARN(WARN_UTF8)) {
2084                 const U8 * const s = (const U8*)SvPVX_const(sv) + offset;
2085                 const STRLEN len = SvCUR(sv) - offset;
2086                 const U8 *f;
2087
2088                 if (!is_utf8_string_loc(s, len, &f))
2089                     /* Emulate :encoding(utf8) warning in the same case. */
2090                     Perl_warner(aTHX_ packWARN(WARN_UTF8),
2091                                 "utf8 \"\\x%02X\" does not map to Unicode",
2092                                 f < (U8*)SvEND(sv) ? *f : 0);
2093              }
2094         }
2095         if (gimme == G_ARRAY) {
2096             if (SvLEN(sv) - SvCUR(sv) > 20) {
2097                 SvPV_shrink_to_cur(sv);
2098             }
2099             sv = sv_2mortal(newSV(80));
2100             continue;
2101         }
2102         else if (gimme == G_SCALAR && !tmplen && SvLEN(sv) - SvCUR(sv) > 80) {
2103             /* try to reclaim a bit of scalar space (only on 1st alloc) */
2104             const STRLEN new_len
2105                 = SvCUR(sv) < 60 ? 80 : SvCUR(sv)+40; /* allow some slop */
2106             SvPV_renew(sv, new_len);
2107         }
2108         RETURN;
2109     }
2110 }
2111
2112 PP(pp_helem)
2113 {
2114     dSP;
2115     HE* he;
2116     SV **svp;
2117     SV * const keysv = POPs;
2118     HV * const hv = MUTABLE_HV(POPs);
2119     const U32 lval = PL_op->op_flags & OPf_MOD || LVRET;
2120     const U32 defer = PL_op->op_private & OPpLVAL_DEFER;
2121     SV *sv;
2122     const bool localizing = PL_op->op_private & OPpLVAL_INTRO;
2123     bool preeminent = TRUE;
2124
2125     if (SvTYPE(hv) != SVt_PVHV)
2126         RETPUSHUNDEF;
2127
2128     if (localizing) {
2129         MAGIC *mg;
2130         HV *stash;
2131
2132         /* If we can determine whether the element exist,
2133          * Try to preserve the existenceness of a tied hash
2134          * element by using EXISTS and DELETE if possible.
2135          * Fallback to FETCH and STORE otherwise. */
2136         if (SvCANEXISTDELETE(hv))
2137             preeminent = hv_exists_ent(hv, keysv, 0);
2138     }
2139
2140     he = hv_fetch_ent(hv, keysv, lval && !defer, 0);
2141     svp = he ? &HeVAL(he) : NULL;
2142     if (lval) {
2143         if (!svp || !*svp || *svp == &PL_sv_undef) {
2144             SV* lv;
2145             SV* key2;
2146             if (!defer) {
2147                 DIE(aTHX_ PL_no_helem_sv, SVfARG(keysv));
2148             }
2149             lv = sv_newmortal();
2150             sv_upgrade(lv, SVt_PVLV);
2151             LvTYPE(lv) = 'y';
2152             sv_magic(lv, key2 = newSVsv(keysv), PERL_MAGIC_defelem, NULL, 0);
2153             SvREFCNT_dec_NN(key2);      /* sv_magic() increments refcount */
2154             LvTARG(lv) = SvREFCNT_inc_simple_NN(hv);
2155             LvTARGLEN(lv) = 1;
2156             PUSHs(lv);
2157             RETURN;
2158         }
2159         if (localizing) {
2160             if (HvNAME_get(hv) && isGV(*svp))
2161                 save_gp(MUTABLE_GV(*svp), !(PL_op->op_flags & OPf_SPECIAL));
2162             else if (preeminent)
2163                 save_helem_flags(hv, keysv, svp,
2164                      (PL_op->op_flags & OPf_SPECIAL) ? 0 : SAVEf_SETMAGIC);
2165             else
2166                 SAVEHDELETE(hv, keysv);
2167         }
2168         else if (PL_op->op_private & OPpDEREF) {
2169             PUSHs(vivify_ref(*svp, PL_op->op_private & OPpDEREF));
2170             RETURN;
2171         }
2172     }
2173     sv = (svp && *svp ? *svp : &PL_sv_undef);
2174     /* Originally this did a conditional C<sv = sv_mortalcopy(sv)>; this
2175      * was to make C<local $tied{foo} = $tied{foo}> possible.
2176      * However, it seems no longer to be needed for that purpose, and
2177      * introduced a new bug: stuff like C<while ($hash{taintedval} =~ /.../g>
2178      * would loop endlessly since the pos magic is getting set on the
2179      * mortal copy and lost. However, the copy has the effect of
2180      * triggering the get magic, and losing it altogether made things like
2181      * c<$tied{foo};> in void context no longer do get magic, which some
2182      * code relied on. Also, delayed triggering of magic on @+ and friends
2183      * meant the original regex may be out of scope by now. So as a
2184      * compromise, do the get magic here. (The MGf_GSKIP flag will stop it
2185      * being called too many times). */
2186     if (!lval && SvRMAGICAL(hv) && SvGMAGICAL(sv))
2187         mg_get(sv);
2188     PUSHs(sv);
2189     RETURN;
2190 }
2191
2192
2193 /* a stripped-down version of Perl_softref2xv() for use by
2194  * pp_multideref(), which doesn't use PL_op->op_flags */
2195
2196 STATIC GV *
2197 S_softref2xv_lite(pTHX_ SV *const sv, const char *const what,
2198                 const svtype type)
2199 {
2200     if (PL_op->op_private & HINT_STRICT_REFS) {
2201         if (SvOK(sv))
2202             Perl_die(aTHX_ PL_no_symref_sv, sv,
2203                      (SvPOKp(sv) && SvCUR(sv)>32 ? "..." : ""), what);
2204         else
2205             Perl_die(aTHX_ PL_no_usym, what);
2206     }
2207     if (!SvOK(sv))
2208         Perl_die(aTHX_ PL_no_usym, what);
2209     return gv_fetchsv_nomg(sv, GV_ADD, type);
2210 }
2211
2212
2213 /* Handle one or more aggregate derefs and array/hash indexings, e.g.
2214  * $h->{foo}  or  $a[0]{$key}[$i]  or  f()->[1]
2215  *
2216  * op_aux points to an array of unions of UV / IV / SV* / PADOFFSET.
2217  * Each of these either contains a set of actions, or an argument, such as
2218  * an IV to use as an array index, or a lexical var to retrieve.
2219  * Several actions re stored per UV; we keep shifting new actions off the
2220  * one UV, and only reload when it becomes zero.
2221  */
2222
2223 PP(pp_multideref)
2224 {
2225     SV *sv = NULL; /* init to avoid spurious 'may be used uninitialized' */
2226     UNOP_AUX_item *items = cUNOP_AUXx(PL_op)->op_aux;
2227     UV actions = items->uv;
2228
2229     assert(actions);
2230     /* this tells find_uninit_var() where we're up to */
2231     PL_multideref_pc = items;
2232
2233     while (1) {
2234         /* there are three main classes of action; the first retrieve
2235          * the initial AV or HV from a variable or the stack; the second
2236          * does the equivalent of an unrolled (/DREFAV, rv2av, aelem),
2237          * the third an unrolled (/DREFHV, rv2hv, helem).
2238          */
2239         switch (actions & MDEREF_ACTION_MASK) {
2240
2241         case MDEREF_reload:
2242             actions = (++items)->uv;
2243             continue;
2244
2245         case MDEREF_AV_padav_aelem:                 /* $lex[...] */
2246             sv = PAD_SVl((++items)->pad_offset);
2247             goto do_AV_aelem;
2248
2249         case MDEREF_AV_gvav_aelem:                  /* $pkg[...] */
2250             sv = UNOP_AUX_item_sv(++items);
2251             assert(isGV_with_GP(sv));
2252             sv = (SV*)GvAVn((GV*)sv);
2253             goto do_AV_aelem;
2254
2255         case MDEREF_AV_pop_rv2av_aelem:             /* expr->[...] */
2256             {
2257                 dSP;
2258                 sv = POPs;
2259                 PUTBACK;
2260                 goto do_AV_rv2av_aelem;
2261             }
2262
2263         case MDEREF_AV_gvsv_vivify_rv2av_aelem:     /* $pkg->[...] */
2264             sv = UNOP_AUX_item_sv(++items);
2265             assert(isGV_with_GP(sv));
2266             sv = GvSVn((GV*)sv);
2267             goto do_AV_vivify_rv2av_aelem;
2268
2269         case MDEREF_AV_padsv_vivify_rv2av_aelem:     /* $lex->[...] */
2270             sv = PAD_SVl((++items)->pad_offset);
2271             /* FALLTHROUGH */
2272
2273         do_AV_vivify_rv2av_aelem:
2274         case MDEREF_AV_vivify_rv2av_aelem:           /* vivify, ->[...] */
2275             /* this is the OPpDEREF action normally found at the end of
2276              * ops like aelem, helem, rv2sv */
2277             sv = vivify_ref(sv, OPpDEREF_AV);
2278             /* FALLTHROUGH */
2279
2280         do_AV_rv2av_aelem:
2281             /* this is basically a copy of pp_rv2av when it just has the
2282              * sKR/1 flags */
2283             SvGETMAGIC(sv);
2284             if (LIKELY(SvROK(sv))) {
2285                 if (UNLIKELY(SvAMAGIC(sv))) {
2286                     sv = amagic_deref_call(sv, to_av_amg);
2287                 }
2288                 sv = SvRV(sv);
2289                 if (UNLIKELY(SvTYPE(sv) != SVt_PVAV))
2290                     DIE(aTHX_ "Not an ARRAY reference");
2291             }
2292             else if (SvTYPE(sv) != SVt_PVAV) {
2293                 if (!isGV_with_GP(sv))
2294                     sv = (SV*)S_softref2xv_lite(aTHX_ sv, "an ARRAY", SVt_PVAV);
2295                 sv = MUTABLE_SV(GvAVn((GV*)sv));
2296             }
2297             /* FALLTHROUGH */
2298
2299         do_AV_aelem:
2300             {
2301                 /* retrieve the key; this may be either a lexical or package
2302                  * var (whose index/ptr is stored as an item) or a signed
2303                  * integer constant stored as an item.
2304                  */
2305                 SV *elemsv;
2306                 IV elem = 0; /* to shut up stupid compiler warnings */
2307
2308
2309                 assert(SvTYPE(sv) == SVt_PVAV);
2310
2311                 switch (actions & MDEREF_INDEX_MASK) {
2312                 case MDEREF_INDEX_none:
2313                     goto finish;
2314                 case MDEREF_INDEX_const:
2315                     elem  = (++items)->iv;
2316                     break;
2317                 case MDEREF_INDEX_padsv:
2318                     elemsv = PAD_SVl((++items)->pad_offset);
2319                     goto check_elem;
2320                 case MDEREF_INDEX_gvsv:
2321                     elemsv = UNOP_AUX_item_sv(++items);
2322                     assert(isGV_with_GP(elemsv));
2323                     elemsv = GvSVn((GV*)elemsv);
2324                 check_elem:
2325                     if (UNLIKELY(SvROK(elemsv) && !SvGAMAGIC(elemsv)
2326                                             && ckWARN(WARN_MISC)))
2327                         Perl_warner(aTHX_ packWARN(WARN_MISC),
2328                                 "Use of reference \"%"SVf"\" as array index",
2329                                 SVfARG(elemsv));
2330                     /* the only time that S_find_uninit_var() needs this
2331                      * is to determine which index value triggered the
2332                      * undef warning. So just update it here. Note that
2333                      * since we don't save and restore this var (e.g. for
2334                      * tie or overload execution), its value will be
2335                      * meaningless apart from just here */
2336                     PL_multideref_pc = items;
2337                     elem = SvIV(elemsv);
2338                     break;
2339                 }
2340
2341
2342                 /* this is basically a copy of pp_aelem with OPpDEREF skipped */
2343
2344                 if (!(actions & MDEREF_FLAG_last)) {
2345                     SV** svp = av_fetch((AV*)sv, elem, 1);
2346                     if (!svp || ! (sv=*svp))
2347                         DIE(aTHX_ PL_no_aelem, elem);
2348                     break;
2349                 }
2350
2351                 if (PL_op->op_private &
2352                     (OPpMULTIDEREF_EXISTS|OPpMULTIDEREF_DELETE))
2353                 {
2354                     if (PL_op->op_private & OPpMULTIDEREF_EXISTS) {
2355                         sv = av_exists((AV*)sv, elem) ? &PL_sv_yes : &PL_sv_no;
2356                     }
2357                     else {
2358                         I32 discard = (GIMME_V == G_VOID) ? G_DISCARD : 0;
2359                         sv = av_delete((AV*)sv, elem, discard);
2360                         if (discard)
2361                             return NORMAL;
2362                         if (!sv)
2363                             sv = &PL_sv_undef;
2364                     }
2365                 }
2366                 else {
2367                     const U32 lval = PL_op->op_flags & OPf_MOD || LVRET;
2368                     const U32 defer = PL_op->op_private & OPpLVAL_DEFER;
2369                     const bool localizing = PL_op->op_private & OPpLVAL_INTRO;
2370                     bool preeminent = TRUE;
2371                     AV *const av = (AV*)sv;
2372                     SV** svp;
2373
2374                     if (UNLIKELY(localizing)) {
2375                         MAGIC *mg;
2376                         HV *stash;
2377
2378                         /* If we can determine whether the element exist,
2379                          * Try to preserve the existenceness of a tied array
2380                          * element by using EXISTS and DELETE if possible.
2381                          * Fallback to FETCH and STORE otherwise. */
2382                         if (SvCANEXISTDELETE(av))
2383                             preeminent = av_exists(av, elem);
2384                     }
2385
2386                     svp = av_fetch(av, elem, lval && !defer);
2387
2388                     if (lval) {
2389                         if (!svp || !(sv = *svp)) {
2390                             IV len;
2391                             if (!defer)
2392                                 DIE(aTHX_ PL_no_aelem, elem);
2393                             len = av_tindex(av);
2394                             sv = sv_2mortal(newSVavdefelem(av,
2395                             /* Resolve a negative index now, unless it points
2396                              * before the beginning of the array, in which
2397                              * case record it for error reporting in
2398                              * magic_setdefelem. */
2399                                 elem < 0 && len + elem >= 0
2400                                     ? len + elem : elem, 1));
2401                         }
2402                         else {
2403                             if (UNLIKELY(localizing)) {
2404                                 if (preeminent) {
2405                                     save_aelem(av, elem, svp);
2406                                     sv = *svp; /* may have changed */
2407                                 }
2408                                 else
2409                                     SAVEADELETE(av, elem);
2410                             }
2411                         }
2412                     }
2413                     else {
2414                         sv = (svp ? *svp : &PL_sv_undef);
2415                         /* see note in pp_helem() */
2416                         if (SvRMAGICAL(av) && SvGMAGICAL(sv))
2417                             mg_get(sv);
2418                     }
2419                 }
2420
2421             }
2422           finish:
2423             {
2424                 dSP;
2425                 XPUSHs(sv);
2426                 RETURN;
2427             }
2428             /* NOTREACHED */
2429
2430
2431
2432
2433         case MDEREF_HV_padhv_helem:                 /* $lex{...} */
2434             sv = PAD_SVl((++items)->pad_offset);
2435             goto do_HV_helem;
2436
2437         case MDEREF_HV_gvhv_helem:                  /* $pkg{...} */
2438             sv = UNOP_AUX_item_sv(++items);
2439             assert(isGV_with_GP(sv));
2440             sv = (SV*)GvHVn((GV*)sv);
2441             goto do_HV_helem;
2442
2443         case MDEREF_HV_pop_rv2hv_helem:             /* expr->{...} */
2444             {
2445                 dSP;
2446                 sv = POPs;
2447                 PUTBACK;
2448                 goto do_HV_rv2hv_helem;
2449             }
2450
2451         case MDEREF_HV_gvsv_vivify_rv2hv_helem:     /* $pkg->{...} */
2452             sv = UNOP_AUX_item_sv(++items);
2453             assert(isGV_with_GP(sv));
2454             sv = GvSVn((GV*)sv);
2455             goto do_HV_vivify_rv2hv_helem;
2456
2457         case MDEREF_HV_padsv_vivify_rv2hv_helem:    /* $lex->{...} */
2458             sv = PAD_SVl((++items)->pad_offset);
2459             /* FALLTHROUGH */
2460
2461         do_HV_vivify_rv2hv_helem:
2462         case MDEREF_HV_vivify_rv2hv_helem:           /* vivify, ->{...} */
2463             /* this is the OPpDEREF action normally found at the end of
2464              * ops like aelem, helem, rv2sv */
2465             sv = vivify_ref(sv, OPpDEREF_HV);
2466             /* FALLTHROUGH */
2467
2468         do_HV_rv2hv_helem:
2469             /* this is basically a copy of pp_rv2hv when it just has the
2470              * sKR/1 flags (and pp_rv2hv is aliased to pp_rv2av) */
2471
2472             SvGETMAGIC(sv);
2473             if (LIKELY(SvROK(sv))) {
2474                 if (UNLIKELY(SvAMAGIC(sv))) {
2475                     sv = amagic_deref_call(sv, to_hv_amg);
2476                 }
2477                 sv = SvRV(sv);
2478                 if (UNLIKELY(SvTYPE(sv) != SVt_PVHV))
2479                     DIE(aTHX_ "Not a HASH reference");
2480             }
2481             else if (SvTYPE(sv) != SVt_PVHV) {
2482                 if (!isGV_with_GP(sv))
2483                     sv = (SV*)S_softref2xv_lite(aTHX_ sv, "a HASH", SVt_PVHV);
2484                 sv = MUTABLE_SV(GvHVn((GV*)sv));
2485             }
2486             /* FALLTHROUGH */
2487
2488         do_HV_helem:
2489             {
2490                 /* retrieve the key; this may be either a lexical / package
2491                  * var or a string constant, whose index/ptr is stored as an
2492                  * item
2493                  */
2494                 SV *keysv = NULL; /* to shut up stupid compiler warnings */
2495
2496                 assert(SvTYPE(sv) == SVt_PVHV);
2497
2498                 switch (actions & MDEREF_INDEX_MASK) {
2499                 case MDEREF_INDEX_none:
2500                     goto finish;
2501
2502                 case MDEREF_INDEX_const:
2503                     keysv = UNOP_AUX_item_sv(++items);
2504                     break;
2505
2506                 case MDEREF_INDEX_padsv:
2507                     keysv = PAD_SVl((++items)->pad_offset);
2508                     break;
2509
2510                 case MDEREF_INDEX_gvsv:
2511                     keysv = UNOP_AUX_item_sv(++items);
2512                     keysv = GvSVn((GV*)keysv);
2513                     break;
2514                 }
2515
2516                 /* see comment above about setting this var */
2517                 PL_multideref_pc = items;
2518
2519
2520                 /* ensure that candidate CONSTs have been HEKified */
2521                 assert(   ((actions & MDEREF_INDEX_MASK) != MDEREF_INDEX_const)
2522                        || SvTYPE(keysv) >= SVt_PVMG
2523                        || !SvOK(keysv)
2524                        || SvROK(keysv)
2525                        || SvIsCOW_shared_hash(keysv));
2526
2527                 /* this is basically a copy of pp_helem with OPpDEREF skipped */
2528
2529                 if (!(actions & MDEREF_FLAG_last)) {
2530                     HE *he = hv_fetch_ent((HV*)sv, keysv, 1, 0);
2531                     if (!he || !(sv=HeVAL(he)) || sv == &PL_sv_undef)
2532                         DIE(aTHX_ PL_no_helem_sv, SVfARG(keysv));
2533                     break;
2534                 }
2535
2536                 if (PL_op->op_private &
2537                     (OPpMULTIDEREF_EXISTS|OPpMULTIDEREF_DELETE))
2538                 {
2539                     if (PL_op->op_private & OPpMULTIDEREF_EXISTS) {
2540                         sv = hv_exists_ent((HV*)sv, keysv, 0)
2541                                                 ? &PL_sv_yes : &PL_sv_no;
2542                     }
2543                     else {
2544                         I32 discard = (GIMME_V == G_VOID) ? G_DISCARD : 0;
2545                         sv = hv_delete_ent((HV*)sv, keysv, discard, 0);
2546                         if (discard)
2547                             return NORMAL;
2548                         if (!sv)
2549                             sv = &PL_sv_undef;
2550                     }
2551                 }
2552                 else {
2553                     const U32 lval = PL_op->op_flags & OPf_MOD || LVRET;
2554                     const U32 defer = PL_op->op_private & OPpLVAL_DEFER;
2555                     const bool localizing = PL_op->op_private & OPpLVAL_INTRO;
2556                     bool preeminent = TRUE;
2557                     SV **svp;
2558                     HV * const hv = (HV*)sv;
2559                     HE* he;
2560
2561                     if (UNLIKELY(localizing)) {
2562                         MAGIC *mg;
2563                         HV *stash;
2564
2565                         /* If we can determine whether the element exist,
2566                          * Try to preserve the existenceness of a tied hash
2567                          * element by using EXISTS and DELETE if possible.
2568                          * Fallback to FETCH and STORE otherwise. */
2569                         if (SvCANEXISTDELETE(hv))
2570                             preeminent = hv_exists_ent(hv, keysv, 0);
2571                     }
2572
2573                     he = hv_fetch_ent(hv, keysv, lval && !defer, 0);
2574                     svp = he ? &HeVAL(he) : NULL;
2575
2576
2577                     if (lval) {
2578                         if (!svp || !(sv = *svp) || sv == &PL_sv_undef) {
2579                             SV* lv;
2580                             SV* key2;
2581                             if (!defer)
2582                                 DIE(aTHX_ PL_no_helem_sv, SVfARG(keysv));
2583                             lv = sv_newmortal();
2584                             sv_upgrade(lv, SVt_PVLV);
2585                             LvTYPE(lv) = 'y';
2586                             sv_magic(lv, key2 = newSVsv(keysv),
2587                                                 PERL_MAGIC_defelem, NULL, 0);
2588                             /* sv_magic() increments refcount */
2589                             SvREFCNT_dec_NN(key2);
2590                             LvTARG(lv) = SvREFCNT_inc_simple_NN(hv);
2591                             LvTARGLEN(lv) = 1;
2592                             sv = lv;
2593                         }
2594                         else {
2595                             if (localizing) {
2596                                 if (HvNAME_get(hv) && isGV(sv))
2597                                     save_gp(MUTABLE_GV(sv),
2598                                         !(PL_op->op_flags & OPf_SPECIAL));
2599                                 else if (preeminent) {
2600                                     save_helem_flags(hv, keysv, svp,
2601                                          (PL_op->op_flags & OPf_SPECIAL)
2602                                             ? 0 : SAVEf_SETMAGIC);
2603                                     sv = *svp; /* may have changed */
2604                                 }
2605                                 else
2606                                     SAVEHDELETE(hv, keysv);
2607                             }
2608                         }
2609                     }
2610                     else {
2611                         sv = (svp && *svp ? *svp : &PL_sv_undef);
2612                         /* see note in pp_helem() */
2613                         if (SvRMAGICAL(hv) && SvGMAGICAL(sv))
2614                             mg_get(sv);
2615                     }
2616                 }
2617                 goto finish;
2618             }
2619
2620         } /* switch */
2621
2622         actions >>= MDEREF_SHIFT;
2623     } /* while */
2624     /* NOTREACHED */
2625 }
2626
2627
2628 PP(pp_iter)
2629 {
2630     PERL_CONTEXT *cx;
2631     SV *oldsv;
2632     SV **itersvp;
2633     SV *retsv;
2634
2635     SV *sv;
2636     AV *av;
2637     IV ix;
2638     IV inc;
2639
2640     cx = CX_CUR();
2641     itersvp = CxITERVAR(cx);
2642     assert(itersvp);
2643
2644     switch (CxTYPE(cx)) {
2645
2646     case CXt_LOOP_LAZYSV: /* string increment */
2647     {
2648         SV* cur = cx->blk_loop.state_u.lazysv.cur;
2649         SV *end = cx->blk_loop.state_u.lazysv.end;
2650         /* If the maximum is !SvOK(), pp_enteriter substitutes PL_sv_no.
2651            It has SvPVX of "" and SvCUR of 0, which is what we want.  */
2652         STRLEN maxlen = 0;
2653         const char *max = SvPV_const(end, maxlen);
2654         if (UNLIKELY(SvNIOK(cur) || SvCUR(cur) > maxlen))
2655             goto retno;
2656
2657         oldsv = *itersvp;
2658         /* NB: on the first iteration, oldsv will have a ref count of at
2659          * least 2 (one extra from blk_loop.itersave), so the GV or pad
2660          * slot will get localised; on subsequent iterations the RC==1
2661          * optimisation may kick in and the SV will be reused. */
2662          if (oldsv && LIKELY(SvREFCNT(oldsv) == 1 && !SvMAGICAL(oldsv))) {
2663             /* safe to reuse old SV */
2664             sv_setsv(oldsv, cur);
2665         }
2666         else
2667         {
2668             /* we need a fresh SV every time so that loop body sees a
2669              * completely new SV for closures/references to work as
2670              * they used to */
2671             *itersvp = newSVsv(cur);
2672             SvREFCNT_dec(oldsv);
2673         }
2674         if (strEQ(SvPVX_const(cur), max))
2675             sv_setiv(cur, 0); /* terminate next time */
2676         else
2677             sv_inc(cur);
2678         break;
2679     }
2680
2681     case CXt_LOOP_LAZYIV: /* integer increment */
2682     {
2683         IV cur = cx->blk_loop.state_u.lazyiv.cur;
2684         if (UNLIKELY(cur > cx->blk_loop.state_u.lazyiv.end))
2685             goto retno;
2686
2687         oldsv = *itersvp;
2688         /* see NB comment above */
2689         if (oldsv && LIKELY(SvREFCNT(oldsv) == 1 && !SvMAGICAL(oldsv))) {
2690             /* safe to reuse old SV */
2691
2692             if (    (SvFLAGS(oldsv) & (SVTYPEMASK|SVf_THINKFIRST|SVf_IVisUV))
2693                  == SVt_IV)
2694             {
2695                 /* Cheap SvIOK_only().
2696                  * Assert that flags which SvIOK_only() would test or
2697                  * clear can't be set, because we're SVt_IV */
2698                 assert(!(SvFLAGS(oldsv) &
2699                     (SVf_OOK|SVf_UTF8|(SVf_OK & ~(SVf_IOK|SVp_IOK)))));
2700                 SvFLAGS(oldsv) |= (SVf_IOK|SVp_IOK);
2701                 /* SvIV_set() where sv_any points to head */
2702                 oldsv->sv_u.svu_iv = cur;
2703
2704             }
2705             else
2706                 sv_setiv(oldsv, cur);
2707         }
2708         else
2709         {
2710             /* we need a fresh SV every time so that loop body sees a
2711              * completely new SV for closures/references to work as they
2712              * used to */
2713             *itersvp = newSViv(cur);
2714             SvREFCNT_dec(oldsv);
2715         }
2716
2717         if (UNLIKELY(cur == IV_MAX)) {
2718             /* Handle end of range at IV_MAX */
2719             cx->blk_loop.state_u.lazyiv.end = IV_MIN;
2720         } else
2721             ++cx->blk_loop.state_u.lazyiv.cur;
2722         break;
2723     }
2724
2725     case CXt_LOOP_LIST: /* for (1,2,3) */
2726
2727         assert(OPpITER_REVERSED == 2); /* so inc becomes -1 or 1 */
2728         inc = 1 - (PL_op->op_private & OPpITER_REVERSED);
2729         ix = (cx->blk_loop.state_u.stack.ix += inc);
2730         if (UNLIKELY(inc > 0
2731                         ? ix > cx->blk_oldsp
2732                         : ix <= cx->blk_loop.state_u.stack.basesp)
2733         )
2734             goto retno;
2735
2736         sv = PL_stack_base[ix];
2737         av = NULL;
2738         goto loop_ary_common;
2739
2740     case CXt_LOOP_ARY: /* for (@ary) */
2741
2742         av = cx->blk_loop.state_u.ary.ary;
2743         inc = 1 - (PL_op->op_private & OPpITER_REVERSED);
2744         ix = (cx->blk_loop.state_u.ary.ix += inc);
2745         if (UNLIKELY(inc > 0
2746                         ? ix > AvFILL(av)
2747                         : ix < 0)
2748         )
2749             goto retno;
2750
2751         if (UNLIKELY(SvRMAGICAL(av))) {
2752             SV * const * const svp = av_fetch(av, ix, FALSE);
2753             sv = svp ? *svp : NULL;
2754         }
2755         else {
2756             sv = AvARRAY(av)[ix];
2757         }
2758
2759       loop_ary_common:
2760
2761         if (UNLIKELY(cx->cx_type & CXp_FOR_LVREF)) {
2762             SvSetMagicSV(*itersvp, sv);
2763             break;
2764         }
2765
2766         if (LIKELY(sv)) {
2767             if (UNLIKELY(SvIS_FREED(sv))) {
2768                 *itersvp = NULL;
2769                 Perl_croak(aTHX_ "Use of freed value in iteration");
2770             }
2771             if (SvPADTMP(sv)) {
2772                 sv = newSVsv(sv);
2773             }
2774             else {
2775                 SvTEMP_off(sv);
2776                 SvREFCNT_inc_simple_void_NN(sv);
2777             }
2778         }
2779         else if (av) {
2780             sv = newSVavdefelem(av, ix, 0);
2781         }
2782         else
2783             sv = &PL_sv_undef;
2784
2785         oldsv = *itersvp;
2786         *itersvp = sv;
2787         SvREFCNT_dec(oldsv);
2788         break;
2789
2790     default:
2791         DIE(aTHX_ "panic: pp_iter, type=%u", CxTYPE(cx));
2792     }
2793
2794     retsv = &PL_sv_yes;
2795     if (0) {
2796       retno:
2797         retsv = &PL_sv_no;
2798     }
2799     /* pp_enteriter should have pre-extended the stack */
2800     assert(PL_stack_sp < PL_stack_max);
2801     *++PL_stack_sp =retsv;
2802
2803     return PL_op->op_next;
2804 }
2805
2806 /*
2807 A description of how taint works in pattern matching and substitution.
2808
2809 This is all conditional on NO_TAINT_SUPPORT not being defined. Under
2810 NO_TAINT_SUPPORT, taint-related operations should become no-ops.
2811
2812 While the pattern is being assembled/concatenated and then compiled,
2813 PL_tainted will get set (via TAINT_set) if any component of the pattern
2814 is tainted, e.g. /.*$tainted/.  At the end of pattern compilation,
2815 the RXf_TAINTED flag is set on the pattern if PL_tainted is set (via
2816 TAINT_get).  It will also be set if any component of the pattern matches
2817 based on locale-dependent behavior.
2818
2819 When the pattern is copied, e.g. $r = qr/..../, the SV holding the ref to
2820 the pattern is marked as tainted. This means that subsequent usage, such
2821 as /x$r/, will set PL_tainted using TAINT_set, and thus RXf_TAINTED,
2822 on the new pattern too.
2823
2824 RXf_TAINTED_SEEN is used post-execution by the get magic code
2825 of $1 et al to indicate whether the returned value should be tainted.
2826 It is the responsibility of the caller of the pattern (i.e. pp_match,
2827 pp_subst etc) to set this flag for any other circumstances where $1 needs
2828 to be tainted.
2829
2830 The taint behaviour of pp_subst (and pp_substcont) is quite complex.
2831
2832 There are three possible sources of taint
2833     * the source string
2834     * the pattern (both compile- and run-time, RXf_TAINTED / RXf_TAINTED_SEEN)
2835     * the replacement string (or expression under /e)
2836
2837 There are four destinations of taint and they are affected by the sources
2838 according to the rules below:
2839
2840     * the return value (not including /r):
2841         tainted by the source string and pattern, but only for the
2842         number-of-iterations case; boolean returns aren't tainted;
2843     * the modified string (or modified copy under /r):
2844         tainted by the source string, pattern, and replacement strings;
2845     * $1 et al:
2846         tainted by the pattern, and under 'use re "taint"', by the source
2847         string too;
2848     * PL_taint - i.e. whether subsequent code (e.g. in a /e block) is tainted:
2849         should always be unset before executing subsequent code.
2850
2851 The overall action of pp_subst is:
2852
2853     * at the start, set bits in rxtainted indicating the taint status of
2854         the various sources.
2855
2856     * After each pattern execution, update the SUBST_TAINT_PAT bit in
2857         rxtainted if RXf_TAINTED_SEEN has been set, to indicate that the
2858         pattern has subsequently become tainted via locale ops.
2859
2860     * If control is being passed to pp_substcont to execute a /e block,
2861         save rxtainted in the CXt_SUBST block, for future use by
2862         pp_substcont.
2863
2864     * Whenever control is being returned to perl code (either by falling
2865         off the "end" of pp_subst/pp_substcont, or by entering a /e block),
2866         use the flag bits in rxtainted to make all the appropriate types of
2867         destination taint visible; e.g. set RXf_TAINTED_SEEN so that $1
2868         et al will appear tainted.
2869
2870 pp_match is just a simpler version of the above.
2871
2872 */
2873
2874 PP(pp_subst)
2875 {
2876     dSP; dTARG;
2877     PMOP *pm = cPMOP;
2878     PMOP *rpm = pm;
2879     char *s;
2880     char *strend;
2881     const char *c;
2882     STRLEN clen;
2883     SSize_t iters = 0;
2884     SSize_t maxiters;
2885     bool once;
2886     U8 rxtainted = 0; /* holds various SUBST_TAINT_* flag bits.
2887                         See "how taint works" above */
2888     char *orig;
2889     U8 r_flags;
2890     REGEXP *rx = PM_GETRE(pm);
2891     STRLEN len;
2892     int force_on_match = 0;
2893     const I32 oldsave = PL_savestack_ix;
2894     STRLEN slen;
2895     bool doutf8 = FALSE; /* whether replacement is in utf8 */
2896 #ifdef PERL_ANY_COW
2897     bool was_cow;
2898 #endif
2899     SV *nsv = NULL;
2900     /* known replacement string? */
2901     SV *dstr = (pm->op_pmflags & PMf_CONST) ? POPs : NULL;
2902
2903     PERL_ASYNC_CHECK();
2904
2905     if (PL_op->op_flags & OPf_STACKED)
2906         TARG = POPs;
2907     else if (ARGTARG)
2908         GETTARGET;
2909     else {
2910         TARG = DEFSV;
2911         EXTEND(SP,1);
2912     }
2913
2914     SvGETMAGIC(TARG); /* must come before cow check */
2915 #ifdef PERL_ANY_COW
2916     /* note that a string might get converted to COW during matching */
2917     was_cow = cBOOL(SvIsCOW(TARG));
2918 #endif
2919     if (!(rpm->op_pmflags & PMf_NONDESTRUCT)) {
2920 #ifndef PERL_ANY_COW
2921         if (SvIsCOW(TARG))
2922             sv_force_normal_flags(TARG,0);
2923 #endif
2924         if ((SvREADONLY(TARG)
2925                 || ( ((SvTYPE(TARG) == SVt_PVGV && isGV_with_GP(TARG))
2926                       || SvTYPE(TARG) > SVt_PVLV)
2927                      && !(SvTYPE(TARG) == SVt_PVGV && SvFAKE(TARG)))))
2928             Perl_croak_no_modify();
2929     }
2930     PUTBACK;
2931
2932     orig = SvPV_nomg(TARG, len);
2933     /* note we don't (yet) force the var into being a string; if we fail
2934      * to match, we leave as-is; on successful match however, we *will*
2935      * coerce into a string, then repeat the match */
2936     if (!SvPOKp(TARG) || SvTYPE(TARG) == SVt_PVGV || SvVOK(TARG))
2937         force_on_match = 1;
2938
2939     /* only replace once? */
2940     once = !(rpm->op_pmflags & PMf_GLOBAL);
2941
2942     /* See "how taint works" above */
2943     if (TAINTING_get) {
2944         rxtainted  = (
2945             (SvTAINTED(TARG) ? SUBST_TAINT_STR : 0)
2946           | (RX_ISTAINTED(rx) ? SUBST_TAINT_PAT : 0)
2947           | ((pm->op_pmflags & PMf_RETAINT) ? SUBST_TAINT_RETAINT : 0)
2948           | ((once && !(rpm->op_pmflags & PMf_NONDESTRUCT))
2949                 ? SUBST_TAINT_BOOLRET : 0));
2950         TAINT_NOT;
2951     }
2952
2953   force_it:
2954     if (!pm || !orig)
2955         DIE(aTHX_ "panic: pp_subst, pm=%p, orig=%p", pm, orig);
2956
2957     strend = orig + len;
2958     slen = DO_UTF8(TARG) ? utf8_length((U8*)orig, (U8*)strend) : len;
2959     maxiters = 2 * slen + 10;   /* We can match twice at each
2960                                    position, once with zero-length,
2961                                    second time with non-zero. */
2962
2963     if (!RX_PRELEN(rx) && PL_curpm
2964      && !ReANY(rx)->mother_re) {
2965         pm = PL_curpm;
2966         rx = PM_GETRE(pm);
2967     }
2968
2969 #ifdef PERL_SAWAMPERSAND
2970     r_flags = (    RX_NPARENS(rx)
2971                 || PL_sawampersand
2972                 || (RX_EXTFLAGS(rx) & (RXf_EVAL_SEEN|RXf_PMf_KEEPCOPY))
2973                 || (rpm->op_pmflags & PMf_KEEPCOPY)
2974               )
2975           ? REXEC_COPY_STR
2976           : 0;
2977 #else
2978     r_flags = REXEC_COPY_STR;
2979 #endif
2980
2981     if (!CALLREGEXEC(rx, orig, strend, orig, 0, TARG, NULL, r_flags))
2982     {
2983         SPAGAIN;
2984         PUSHs(rpm->op_pmflags & PMf_NONDESTRUCT ? TARG : &PL_sv_no);
2985         LEAVE_SCOPE(oldsave);
2986         RETURN;
2987     }
2988     PL_curpm = pm;
2989
2990     /* known replacement string? */
2991     if (dstr) {
2992         /* replacement needing upgrading? */
2993         if (DO_UTF8(TARG) && !doutf8) {
2994              nsv = sv_newmortal();
2995              SvSetSV(nsv, dstr);
2996              sv_utf8_upgrade(nsv);
2997              c = SvPV_const(nsv, clen);
2998              doutf8 = TRUE;
2999         }
3000         else {
3001             c = SvPV_const(dstr, clen);
3002             doutf8 = DO_UTF8(dstr);
3003         }
3004
3005         if (SvTAINTED(dstr))
3006             rxtainted |= SUBST_TAINT_REPL;
3007     }
3008     else {
3009         c = NULL;
3010         doutf8 = FALSE;
3011     }
3012
3013     /* can do inplace substitution? */
3014     if (c
3015 #ifdef PERL_ANY_COW
3016         && !was_cow
3017 #endif
3018         && (I32)clen <= RX_MINLENRET(rx)
3019         && (  once
3020            || !(r_flags & REXEC_COPY_STR)
3021            || (!SvGMAGICAL(dstr) && !(RX_EXTFLAGS(rx) & RXf_EVAL_SEEN))
3022            )
3023         && !(RX_EXTFLAGS(rx) & RXf_NO_INPLACE_SUBST)
3024         && (!doutf8 || SvUTF8(TARG))
3025         && !(rpm->op_pmflags & PMf_NONDESTRUCT))
3026     {
3027
3028 #ifdef PERL_ANY_COW
3029         /* string might have got converted to COW since we set was_cow */
3030         if (SvIsCOW(TARG)) {
3031           if (!force_on_match)
3032             goto have_a_cow;
3033           assert(SvVOK(TARG));
3034         }
3035 #endif
3036         if (force_on_match) {
3037             /* redo the first match, this time with the orig var
3038              * forced into being a string */
3039             force_on_match = 0;
3040             orig = SvPV_force_nomg(TARG, len);
3041             goto force_it;
3042         }
3043
3044         if (once) {
3045             char *d, *m;
3046             if (RX_MATCH_TAINTED(rx)) /* run time pattern taint, eg locale */
3047                 rxtainted |= SUBST_TAINT_PAT;
3048             m = orig + RX_OFFS(rx)[0].start;
3049             d = orig + RX_OFFS(rx)[0].end;
3050             s = orig;
3051             if (m - s > strend - d) {  /* faster to shorten from end */
3052                 I32 i;
3053                 if (clen) {
3054                     Copy(c, m, clen, char);
3055                     m += clen;
3056                 }
3057                 i = strend - d;
3058                 if (i > 0) {
3059                     Move(d, m, i, char);
3060                     m += i;
3061                 }
3062                 *m = '\0';
3063                 SvCUR_set(TARG, m - s);
3064             }
3065             else {      /* faster from front */
3066                 I32 i = m - s;
3067                 d -= clen;
3068                 if (i > 0)
3069                     Move(s, d - i, i, char);
3070                 sv_chop(TARG, d-i);
3071                 if (clen)
3072                     Copy(c, d, clen, char);
3073             }
3074             SPAGAIN;
3075             PUSHs(&PL_sv_yes);
3076         }
3077         else {
3078             char *d, *m;
3079             d = s = RX_OFFS(rx)[0].start + orig;
3080             do {
3081                 I32 i;
3082                 if (UNLIKELY(iters++ > maxiters))
3083                     DIE(aTHX_ "Substitution loop");
3084                 if (UNLIKELY(RX_MATCH_TAINTED(rx))) /* run time pattern taint, eg locale */
3085                     rxtainted |= SUBST_TAINT_PAT;
3086                 m = RX_OFFS(rx)[0].start + orig;
3087                 if ((i = m - s)) {
3088                     if (s != d)
3089                         Move(s, d, i, char);
3090                     d += i;
3091                 }
3092                 if (clen) {
3093                     Copy(c, d, clen, char);
3094                     d += clen;
3095                 }
3096                 s = RX_OFFS(rx)[0].end + orig;
3097             } while (CALLREGEXEC(rx, s, strend, orig,
3098                                  s == m, /* don't match same null twice */
3099                                  TARG, NULL,
3100                      REXEC_NOT_FIRST|REXEC_IGNOREPOS|REXEC_FAIL_ON_UNDERFLOW));
3101             if (s != d) {
3102                 I32 i = strend - s;
3103                 SvCUR_set(TARG, d - SvPVX_const(TARG) + i);
3104                 Move(s, d, i+1, char);          /* include the NUL */
3105             }
3106             SPAGAIN;
3107             mPUSHi(iters);
3108         }
3109     }
3110     else {
3111         bool first;
3112         char *m;
3113         SV *repl;
3114         if (force_on_match) {
3115             /* redo the first match, this time with the orig var
3116              * forced into being a string */
3117             force_on_match = 0;
3118             if (rpm->op_pmflags & PMf_NONDESTRUCT) {
3119                 /* I feel that it should be possible to avoid this mortal copy
3120                    given that the code below copies into a new destination.
3121                    However, I suspect it isn't worth the complexity of
3122                    unravelling the C<goto force_it> for the small number of
3123                    cases where it would be viable to drop into the copy code. */
3124                 TARG = sv_2mortal(newSVsv(TARG));
3125             }
3126             orig = SvPV_force_nomg(TARG, len);
3127             goto force_it;
3128         }
3129 #ifdef PERL_ANY_COW
3130       have_a_cow:
3131 #endif
3132         if (RX_MATCH_TAINTED(rx)) /* run time pattern taint, eg locale */
3133             rxtainted |= SUBST_TAINT_PAT;
3134         repl = dstr;
3135         s = RX_OFFS(rx)[0].start + orig;
3136         dstr = newSVpvn_flags(orig, s-orig,
3137                     SVs_TEMP | (DO_UTF8(TARG) ? SVf_UTF8 : 0));
3138         if (!c) {
3139             PERL_CONTEXT *cx;
3140             SPAGAIN;
3141             m = orig;
3142             /* note that a whole bunch of local vars are saved here for
3143              * use by pp_substcont: here's a list of them in case you're
3144              * searching for places in this sub that uses a particular var:
3145              * iters maxiters r_flags oldsave rxtainted orig dstr targ
3146              * s m strend rx once */
3147             CX_PUSHSUBST(cx);
3148             RETURNOP(cPMOP->op_pmreplrootu.op_pmreplroot);
3149         }
3150         first = TRUE;
3151         do {
3152             if (UNLIKELY(iters++ > maxiters))
3153                 DIE(aTHX_ "Substitution loop");
3154             if (UNLIKELY(RX_MATCH_TAINTED(rx)))
3155                 rxtainted |= SUBST_TAINT_PAT;
3156             if (RX_MATCH_COPIED(rx) && RX_SUBBEG(rx) != orig) {
3157                 char *old_s    = s;
3158                 char *old_orig = orig;
3159                 assert(RX_SUBOFFSET(rx) == 0);
3160
3161                 orig = RX_SUBBEG(rx);
3162                 s = orig + (old_s - old_orig);
3163                 strend = s + (strend - old_s);
3164             }
3165             m = RX_OFFS(rx)[0].start + orig;
3166             sv_catpvn_nomg_maybeutf8(dstr, s, m - s, DO_UTF8(TARG));
3167             s = RX_OFFS(rx)[0].end + orig;
3168             if (first) {
3169                 /* replacement already stringified */
3170               if (clen)
3171                 sv_catpvn_nomg_maybeutf8(dstr, c, clen, doutf8);
3172               first = FALSE;
3173             }
3174             else {
3175                 sv_catsv(dstr, repl);
3176                 if (UNLIKELY(SvTAINTED(repl)))
3177                     rxtainted |= SUBST_TAINT_REPL;
3178             }
3179             if (once)
3180                 break;
3181         } while (CALLREGEXEC(rx, s, strend, orig,
3182                              s == m,    /* Yields minend of 0 or 1 */
3183                              TARG, NULL,
3184                     REXEC_NOT_FIRST|REXEC_IGNOREPOS|REXEC_FAIL_ON_UNDERFLOW));
3185         assert(strend >= s);
3186         sv_catpvn_nomg_maybeutf8(dstr, s, strend - s, DO_UTF8(TARG));
3187
3188         if (rpm->op_pmflags & PMf_NONDESTRUCT) {
3189             /* From here on down we're using the copy, and leaving the original
3190                untouched.  */
3191             TARG = dstr;
3192             SPAGAIN;
3193             PUSHs(dstr);
3194         } else {
3195 #ifdef PERL_ANY_COW
3196             /* The match may make the string COW. If so, brilliant, because
3197                that's just saved us one malloc, copy and free - the regexp has
3198                donated the old buffer, and we malloc an entirely new one, rather
3199                than the regexp malloc()ing a buffer and copying our original,
3200                only for us to throw it away here during the substitution.  */
3201             if (SvIsCOW(TARG)) {
3202                 sv_force_normal_flags(TARG, SV_COW_DROP_PV);
3203             } else
3204 #endif
3205             {
3206                 SvPV_free(TARG);
3207             }
3208             SvPV_set(TARG, SvPVX(dstr));
3209             SvCUR_set(TARG, SvCUR(dstr));
3210             SvLEN_set(TARG, SvLEN(dstr));
3211             SvFLAGS(TARG) |= SvUTF8(dstr);
3212             SvPV_set(dstr, NULL);
3213
3214             SPAGAIN;
3215             mPUSHi(iters);
3216         }
3217     }
3218
3219     if (!(rpm->op_pmflags & PMf_NONDESTRUCT)) {
3220         (void)SvPOK_only_UTF8(TARG);
3221     }
3222
3223     /* See "how taint works" above */
3224     if (TAINTING_get) {
3225         if ((rxtainted & SUBST_TAINT_PAT) ||
3226             ((rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_RETAINT)) ==
3227                                 (SUBST_TAINT_STR|SUBST_TAINT_RETAINT))
3228         )
3229             (RX_MATCH_TAINTED_on(rx)); /* taint $1 et al */
3230
3231         if (!(rxtainted & SUBST_TAINT_BOOLRET)
3232             && (rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_PAT))
3233         )
3234             SvTAINTED_on(TOPs);  /* taint return value */
3235         else
3236             SvTAINTED_off(TOPs);  /* may have got tainted earlier */
3237
3238         /* needed for mg_set below */
3239         TAINT_set(
3240           cBOOL(rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_PAT|SUBST_TAINT_REPL))
3241         );
3242         SvTAINT(TARG);
3243     }
3244     SvSETMAGIC(TARG); /* PL_tainted must be correctly set for this mg_set */
3245     TAINT_NOT;
3246     LEAVE_SCOPE(oldsave);
3247     RETURN;
3248 }
3249
3250 PP(pp_grepwhile)
3251 {
3252     dSP;
3253
3254     if (SvTRUEx(POPs))
3255         PL_stack_base[PL_markstack_ptr[-1]++] = PL_stack_base[*PL_markstack_ptr];
3256     ++*PL_markstack_ptr;
3257     FREETMPS;
3258     LEAVE_with_name("grep_item");                                       /* exit inner scope */
3259
3260     /* All done yet? */
3261     if (UNLIKELY(PL_stack_base + *PL_markstack_ptr > SP)) {
3262         I32 items;
3263         const U8 gimme = GIMME_V;
3264
3265         LEAVE_with_name("grep");                                        /* exit outer scope */
3266         (void)POPMARK;                          /* pop src */
3267         items = --*PL_markstack_ptr - PL_markstack_ptr[-1];
3268         (void)POPMARK;                          /* pop dst */
3269         SP = PL_stack_base + POPMARK;           /* pop original mark */
3270         if (gimme == G_SCALAR) {
3271                 dTARGET;
3272                 XPUSHi(items);
3273         }
3274         else if (gimme == G_ARRAY)
3275             SP += items;
3276         RETURN;
3277     }
3278     else {
3279         SV *src;
3280
3281         ENTER_with_name("grep_item");                                   /* enter inner scope */
3282         SAVEVPTR(PL_curpm);
3283
3284         src = PL_stack_base[TOPMARK];
3285         if (SvPADTMP(src)) {
3286             src = PL_stack_base[TOPMARK] = sv_mortalcopy(src);
3287             PL_tmps_floor++;
3288         }
3289         SvTEMP_off(src);
3290         DEFSV_set(src);
3291
3292         RETURNOP(cLOGOP->op_other);
3293     }
3294 }
3295
3296 /* leave_adjust_stacks():
3297  *
3298  * Process a scope's return args (in the range from_sp+1 .. PL_stack_sp),
3299  * positioning them at to_sp+1 onwards, and do the equivalent of a
3300  * FREEMPS and TAINT_NOT.
3301  *
3302  * Not intended to be called in void context.
3303  *
3304  * When leaving a sub, eval, do{} or other scope, the things that need
3305  * doing to process the return args are:
3306  *    * in scalar context, only return the last arg (or PL_sv_undef if none);
3307  *    * for the types of return that return copies of their args (such
3308  *      as rvalue sub return), make a mortal copy of every return arg,
3309  *      except where we can optimise the copy away without it being
3310  *      semantically visible;
3311  *    * make sure that the arg isn't prematurely freed; in the case of an
3312  *      arg not copied, this may involve mortalising it. For example, in
3313  *      C<sub f { my $x = ...; $x }>, $x would be freed when we do
3314  *      CX_LEAVE_SCOPE(cx) unless it's protected or copied.
3315  *
3316  * What condition to use when deciding whether to pass the arg through
3317  * or make a copy, is determined by the 'pass' arg; its valid values are:
3318  *   0: rvalue sub/eval exit
3319  *   1: other rvalue scope exit
3320  *   2: :lvalue sub exit in rvalue context
3321  *   3: :lvalue sub exit in lvalue context and other lvalue scope exits
3322  *
3323  * There is a big issue with doing a FREETMPS. We would like to free any
3324  * temps created by the last statement which the sub executed, rather than
3325  * leaving them for the caller. In a situation where a sub call isn't
3326  * soon followed by a nextstate (e.g. nested recursive calls, a la
3327  * fibonacci()), temps can accumulate, causing memory and performance
3328  * issues.
3329  *
3330  * On the other hand, we don't want to free any TEMPs which are keeping
3331  * alive any return args that we skipped copying; nor do we wish to undo
3332  * any mortalising done here.
3333  *
3334  * The solution is to split the temps stack frame into two, with a cut
3335  * point delineating the two halves. We arrange that by the end of this
3336  * function, all the temps stack frame entries we wish to keep are in the
3337  * range  PL_tmps_floor+1.. tmps_base-1, while the ones to free now are in
3338  * the range  tmps_base .. PL_tmps_ix.  During the course of this
3339  * function, tmps_base starts off as PL_tmps_floor+1, then increases
3340  * whenever we find or create a temp that we know should be kept. In
3341  * general the stuff above tmps_base is undecided until we reach the end,
3342  * and we may need a sort stage for that.
3343  *
3344  * To determine whether a TEMP is keeping a return arg alive, every
3345  * arg that is kept rather than copied and which has the SvTEMP flag
3346  * set, has the flag temporarily unset, to mark it. At the end we scan
3347  * the temps stack frame above the cut for entries without SvTEMP and
3348  * keep them, while turning SvTEMP on again. Note that if we die before
3349  * the SvTEMPs flags are set again, its safe: at worst, subsequent use of
3350  * those SVs may be slightly less efficient.
3351  *
3352  * In practice various optimisations for some common cases mean we can
3353  * avoid most of the scanning and swapping about with the temps stack.
3354  */
3355
3356 void
3357 Perl_leave_adjust_stacks(pTHX_ SV **from_sp, SV **to_sp, U8 gimme, int pass)
3358 {
3359     dVAR;
3360     dSP;
3361     SSize_t tmps_base; /* lowest index into tmps stack that needs freeing now */
3362     SSize_t nargs;
3363
3364     PERL_ARGS_ASSERT_LEAVE_ADJUST_STACKS;
3365
3366     TAINT_NOT;
3367
3368     if (gimme == G_ARRAY) {
3369         nargs = SP - from_sp;
3370         from_sp++;
3371     }
3372     else {
3373         assert(gimme == G_SCALAR);
3374         if (UNLIKELY(from_sp >= SP)) {
3375             /* no return args */
3376             assert(from_sp == SP);
3377             EXTEND(SP, 1);
3378             *++SP = &PL_sv_undef;
3379             to_sp = SP;
3380             nargs   = 0;
3381         }
3382         else {
3383             from_sp = SP;
3384             nargs   = 1;
3385         }
3386     }
3387
3388     /* common code for G_SCALAR and G_ARRAY */
3389
3390     tmps_base = PL_tmps_floor + 1;
3391
3392     assert(nargs >= 0);
3393     if (nargs) {
3394         /* pointer version of tmps_base. Not safe across temp stack
3395          * reallocs. */
3396         SV **tmps_basep;
3397
3398         EXTEND_MORTAL(nargs); /* one big extend for worst-case scenario */
3399         tmps_basep = PL_tmps_stack + tmps_base;
3400
3401         /* process each return arg */
3402
3403         do {
3404             SV *sv = *from_sp++;
3405
3406             assert(PL_tmps_ix + nargs < PL_tmps_max);
3407 #ifdef DEBUGGING
3408             /* PADTMPs with container set magic shouldn't appear in the
3409              * wild. This assert is more important for pp_leavesublv(),
3410              * but by testing for it here, we're more likely to catch
3411              * bad cases (what with :lvalue subs not being widely
3412              * deployed). The two issues are that for something like
3413              *     sub :lvalue { $tied{foo} }
3414              * or
3415              *     sub :lvalue { substr($foo,1,2) }
3416              * pp_leavesublv() will croak if the sub returns a PADTMP,
3417              * and currently functions like pp_substr() return a mortal
3418              * rather than using their PADTMP when returning a PVLV.
3419              * This is because the PVLV will hold a ref to $foo,
3420              * so $foo would get delayed in being freed while
3421              * the PADTMP SV remained in the PAD.
3422              * So if this assert fails it means either:
3423              *  1) there is pp code similar to pp_substr that is
3424              *     returning a PADTMP instead of a mortal, and probably
3425              *     needs fixing, or
3426              *  2) pp_leavesublv is making unwarranted assumptions
3427              *     about always croaking on a PADTMP
3428              */
3429             if (SvPADTMP(sv) && SvSMAGICAL(sv)) {
3430                 MAGIC *mg;
3431                 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
3432                     assert(PERL_MAGIC_TYPE_IS_VALUE_MAGIC(mg->mg_type));
3433                 }
3434             }
3435 #endif
3436
3437             if (
3438                pass == 0 ? (SvTEMP(sv) && !SvMAGICAL(sv) && SvREFCNT(sv) == 1)
3439              : pass == 1 ? ((SvTEMP(sv) || SvPADTMP(sv)) && !SvMAGICAL(sv) && SvREFCNT(sv) == 1)
3440              : pass == 2 ? (!SvPADTMP(sv))
3441              : 1)
3442             {
3443                 /* pass through: skip copy for logic or optimisation
3444                  * reasons; instead mortalise it, except that ... */
3445                 *++to_sp = sv;
3446
3447                 if (SvTEMP(sv)) {
3448                     /* ... since this SV is an SvTEMP , we don't need to
3449                      * re-mortalise it; instead we just need to ensure
3450                      * that its existing entry in the temps stack frame
3451                      * ends up below the cut and so avoids being freed
3452                      * this time round. We mark it as needing to be kept
3453                      * by temporarily unsetting SvTEMP; then at the end,
3454                      * we shuffle any !SvTEMP entries on the tmps stack
3455                      * back below the cut.
3456                      * However, there's a significant chance that there's
3457                      * a 1:1 correspondence between the first few (or all)
3458                      * elements in the return args stack frame and those
3459                      * in the temps stack frame; e,g.:
3460                      *      sub f { ....; map {...} .... },
3461                      * or if we're exiting multiple scopes and one of the
3462                      * inner scopes has already made mortal copies of each
3463                      * return arg.
3464                      *
3465                      * If so, this arg sv will correspond to the next item
3466                      * on the tmps stack above the cut, and so can be kept
3467                      * merely by moving the cut boundary up one, rather
3468                      * than messing with SvTEMP.  If all args are 1:1 then
3469                      * we can avoid the sorting stage below completely.
3470                      *
3471                      * If there are no items above the cut on the tmps
3472                      * stack, then the SvTEMP must comne from an item
3473                      * below the cut, so there's nothing to do.
3474                      */
3475                     if (tmps_basep <= &PL_tmps_stack[PL_tmps_ix]) {
3476                         if (sv == *tmps_basep)
3477                             tmps_basep++;
3478                         else
3479                             SvTEMP_off(sv);
3480                     }
3481                 }
3482                 else if (!SvPADTMP(sv)) {
3483                     /* mortalise arg to avoid it being freed during save
3484                      * stack unwinding. Pad tmps don't need mortalising as
3485                      * they're never freed. This is the equivalent of
3486                      * sv_2mortal(SvREFCNT_inc(sv)), except that:
3487                      *  * it assumes that the temps stack has already been
3488                      *    extended;
3489                      *  * it puts the new item at the cut rather than at
3490                      *    ++PL_tmps_ix, moving the previous occupant there
3491                      *    instead.
3492                      */
3493                     if (!SvIMMORTAL(sv)) {
3494                         SvREFCNT_inc_simple_void_NN(sv);
3495                         SvTEMP_on(sv);
3496                         /* Note that if there's nothing above the cut,
3497                          * this copies the garbage one slot above
3498                          * PL_tmps_ix onto itself. This is harmless (the
3499                          * stack's already been extended), but might in
3500                          * theory trigger warnings from tools like ASan
3501                          */
3502                         PL_tmps_stack[++PL_tmps_ix] = *tmps_basep;
3503                         *tmps_basep++ = sv;
3504                     }
3505                 }
3506             }
3507             else {
3508                 /* Make a mortal copy of the SV.
3509                  * The following code is the equivalent of sv_mortalcopy()
3510                  * except that:
3511                  *  * it assumes the temps stack has already been extended;
3512                  *  * it optimises the copying for some simple SV types;
3513                  *  * it puts the new item at the cut rather than at
3514                  *    ++PL_tmps_ix, moving the previous occupant there
3515                  *    instead.
3516                  */
3517                 SV *newsv = newSV(0);
3518
3519                 PL_tmps_stack[++PL_tmps_ix] = *tmps_basep;
3520                 /* put it on the tmps stack early so it gets freed if we die */
3521                 *tmps_basep++ = newsv;
3522                 *++to_sp = newsv;
3523
3524                 if (SvTYPE(sv) <= SVt_IV) {
3525                     /* arg must be one of undef, IV/UV, or RV: skip
3526                      * sv_setsv_flags() and do the copy directly */
3527                     U32 dstflags;
3528                     U32 srcflags = SvFLAGS(sv);
3529
3530                     assert(!SvGMAGICAL(sv));
3531                     if (srcflags & (SVf_IOK|SVf_ROK)) {
3532                         SET_SVANY_FOR_BODYLESS_IV(newsv);
3533
3534                         if (srcflags & SVf_ROK) {
3535                             newsv->sv_u.svu_rv = SvREFCNT_inc(SvRV(sv));
3536                             /* SV type plus flags */
3537                             dstflags = (SVt_IV|SVf_ROK|SVs_TEMP);
3538                         }
3539                         else {
3540                             /* both src and dst are <= SVt_IV, so sv_any
3541                              * points to the head; so access the heads
3542                              * directly rather than going via sv_any.
3543                              */
3544                             assert(    &(sv->sv_u.svu_iv)
3545                                     == &(((XPVIV*) SvANY(sv))->xiv_iv));
3546                             assert(    &(newsv->sv_u.svu_iv)
3547                                     == &(((XPVIV*) SvANY(newsv))->xiv_iv));
3548                             newsv->sv_u.svu_iv = sv->sv_u.svu_iv;
3549                             /* SV type plus flags */
3550                             dstflags = (SVt_IV|SVf_IOK|SVp_IOK|SVs_TEMP
3551                                             |(srcflags & SVf_IVisUV));
3552                         }
3553                     }
3554                     else {
3555                         assert(!(srcflags & SVf_OK));
3556                         dstflags = (SVt_NULL|SVs_TEMP); /* SV type plus flags */
3557                     }
3558                     SvFLAGS(newsv) = dstflags;
3559
3560                 }
3561                 else {
3562                     /* do the full sv_setsv() */
3563                     SSize_t old_base;
3564
3565                     SvTEMP_on(newsv);
3566                     old_base = tmps_basep - PL_tmps_stack;
3567                     SvGETMAGIC(sv);
3568                     sv_setsv_flags(newsv, sv, SV_DO_COW_SVSETSV);
3569                     /* the mg_get or sv_setsv might have created new temps
3570                      * or realloced the tmps stack; regrow and reload */
3571                     EXTEND_MORTAL(nargs);
3572                     tmps_basep = PL_tmps_stack + old_base;
3573                     TAINT_NOT;  /* Each item is independent */
3574                 }
3575
3576             }
3577         } while (--nargs);
3578
3579         /* If there are any temps left above the cut, we need to sort
3580          * them into those to keep and those to free. The only ones to
3581          * keep are those for which we've temporarily unset SvTEMP.
3582          * Work inwards from the two ends at tmps_basep .. PL_tmps_ix,
3583          * swapping pairs as necessary. Stop when we meet in the middle.
3584          */
3585         {
3586             SV **top = PL_tmps_stack + PL_tmps_ix;
3587             while (tmps_basep <= top) {
3588                 SV *sv = *top;
3589                 if (SvTEMP(sv))
3590                     top--;
3591                 else {
3592                     SvTEMP_on(sv);
3593                     *top = *tmps_basep;
3594                     *tmps_basep = sv;
3595                     tmps_basep++;
3596                 }
3597             }
3598         }
3599
3600         tmps_base = tmps_basep - PL_tmps_stack;
3601     }
3602
3603     PL_stack_sp = to_sp;
3604
3605     /* unrolled FREETMPS() but using tmps_base-1 rather than PL_tmps_floor */
3606     while (PL_tmps_ix >= tmps_base) {
3607         SV* const sv = PL_tmps_stack[PL_tmps_ix--];
3608 #ifdef PERL_POISON
3609         PoisonWith(PL_tmps_stack + PL_tmps_ix + 1, 1, SV *, 0xAB);
3610 #endif
3611         if (LIKELY(sv)) {
3612             SvTEMP_off(sv);
3613             SvREFCNT_dec_NN(sv); /* note, can modify tmps_ix!!! */
3614         }
3615     }
3616 }
3617
3618
3619 /* also tail-called by pp_return */
3620
3621 PP(pp_leavesub)
3622 {
3623     U8 gimme;
3624     PERL_CONTEXT *cx;
3625     SV **oldsp;
3626     OP *retop;
3627
3628     cx = CX_CUR();
3629     assert(CxTYPE(cx) == CXt_SUB);
3630
3631     if (CxMULTICALL(cx)) {
3632         /* entry zero of a stack is always PL_sv_undef, which
3633          * simplifies converting a '()' return into undef in scalar context */
3634         assert(PL_stack_sp > PL_stack_base || *PL_stack_base == &PL_sv_undef);
3635         return 0;
3636     }
3637
3638     gimme = cx->blk_gimme;
3639     oldsp = PL_stack_base + cx->blk_oldsp; /* last arg of previous frame */
3640
3641     if (gimme == G_VOID)
3642         PL_stack_sp = oldsp;
3643     else
3644         leave_adjust_stacks(oldsp, oldsp, gimme, 0);
3645
3646     CX_LEAVE_SCOPE(cx);
3647     cx_popsub(cx);      /* Stack values are safe: release CV and @_ ... */
3648     cx_popblock(cx);
3649     retop = cx->blk_sub.retop;
3650     CX_POP(cx);
3651
3652     return retop;
3653 }
3654
3655
3656 /* clear (if possible) or abandon the current @_. If 'abandon' is true,
3657  * forces an abandon */
3658
3659 void
3660 Perl_clear_defarray(pTHX_ AV* av, bool abandon)
3661 {
3662     const SSize_t fill = AvFILLp(av);
3663
3664     PERL_ARGS_ASSERT_CLEAR_DEFARRAY;
3665
3666     if (LIKELY(!abandon && SvREFCNT(av) == 1 && !SvMAGICAL(av))) {
3667         av_clear(av);
3668         AvREIFY_only(av);
3669     }
3670     else {
3671         AV *newav = newAV();
3672         av_extend(newav, fill);
3673         AvREIFY_only(newav);
3674         PAD_SVl(0) = MUTABLE_SV(newav);
3675         SvREFCNT_dec_NN(av);
3676     }
3677 }
3678
3679
3680 PP(pp_entersub)
3681 {
3682     dSP; dPOPss;
3683     GV *gv;
3684     CV *cv;
3685     PERL_CONTEXT *cx;
3686     I32 old_savestack_ix;
3687
3688     if (UNLIKELY(!sv))
3689         goto do_die;
3690
3691     /* Locate the CV to call:
3692      * - most common case: RV->CV: f(), $ref->():
3693      *   note that if a sub is compiled before its caller is compiled,
3694      *   the stash entry will be a ref to a CV, rather than being a GV.
3695      * - second most common case: CV: $ref->method()
3696      */
3697
3698     /* a non-magic-RV -> CV ? */
3699     if (LIKELY( (SvFLAGS(sv) & (SVf_ROK|SVs_GMG)) == SVf_ROK)) {
3700         cv = MUTABLE_CV(SvRV(sv));
3701         if (UNLIKELY(SvOBJECT(cv))) /* might be overloaded */
3702             goto do_ref;
3703     }
3704     else
3705         cv = MUTABLE_CV(sv);
3706
3707     /* a CV ? */
3708     if (UNLIKELY(SvTYPE(cv) != SVt_PVCV)) {
3709         /* handle all the weird cases */
3710         switch (SvTYPE(sv)) {
3711         case SVt_PVLV:
3712             if (!isGV_with_GP(sv))
3713                 goto do_default;
3714             /* FALLTHROUGH */
3715         case SVt_PVGV:
3716             cv = GvCVu((const GV *)sv);
3717             if (UNLIKELY(!cv)) {
3718                 HV *stash;
3719                 cv = sv_2cv(sv, &stash, &gv, 0);
3720                 if (!cv) {
3721                     old_savestack_ix = PL_savestack_ix;
3722                     goto try_autoload;
3723                 }
3724             }
3725             break;
3726
3727         default:
3728           do_default:
3729             SvGETMAGIC(sv);
3730             if (SvROK(sv)) {
3731               do_ref:
3732                 if (UNLIKELY(SvAMAGIC(sv))) {
3733                     sv = amagic_deref_call(sv, to_cv_amg);
3734                     /* Don't SPAGAIN here.  */
3735                 }
3736             }
3737             else {
3738                 const char *sym;
3739                 STRLEN len;
3740                 if (UNLIKELY(!SvOK(sv)))
3741                     DIE(aTHX_ PL_no_usym, "a subroutine");
3742
3743                 if (UNLIKELY(sv == &PL_sv_yes)) { /* unfound import, ignore */
3744                     if (PL_op->op_flags & OPf_STACKED) /* hasargs */
3745                         SP = PL_stack_base + POPMARK;
3746                     else
3747                         (void)POPMARK;
3748                     if (GIMME_V == G_SCALAR)
3749                         PUSHs(&PL_sv_undef);
3750                     RETURN;
3751                 }
3752
3753                 sym = SvPV_nomg_const(sv, len);
3754                 if (PL_op->op_private & HINT_STRICT_REFS)
3755                     DIE(aTHX_ "Can't use string (\"%" SVf32 "\"%s) as a subroutine ref while \"strict refs\" in use", sv, len>32 ? "..." : "");
3756                 cv = get_cvn_flags(sym, len, GV_ADD|SvUTF8(sv));
3757                 break;
3758             }
3759             cv = MUTABLE_CV(SvRV(sv));
3760             if (LIKELY(SvTYPE(cv) == SVt_PVCV))
3761                 break;
3762             /* FALLTHROUGH */
3763         case SVt_PVHV:
3764         case SVt_PVAV:
3765           do_die:
3766             DIE(aTHX_ "Not a CODE reference");
3767         }
3768     }
3769
3770     /* At this point we want to save PL_savestack_ix, either by doing a
3771      * cx_pushsub(), or for XS, doing an ENTER. But we don't yet know the final
3772      * CV we will be using (so we don't know whether its XS, so we can't
3773      * cx_pushsub() or ENTER yet), and determining cv may itself push stuff on
3774      * the save stack. So remember where we are currently on the save
3775      * stack, and later update the CX or scopestack entry accordingly. */
3776     old_savestack_ix = PL_savestack_ix;
3777
3778     /* these two fields are in a union. If they ever become separate,
3779      * we have to test for both of them being null below */
3780     assert(cv);
3781     assert((void*)&CvROOT(cv) == (void*)&CvXSUB(cv));
3782     while (UNLIKELY(!CvROOT(cv))) {
3783         GV* autogv;
3784         SV* sub_name;
3785
3786         /* anonymous or undef'd function leaves us no recourse */
3787         if (CvLEXICAL(cv) && CvHASGV(cv))
3788             DIE(aTHX_ "Undefined subroutine &%"SVf" called",
3789                        SVfARG(cv_name(cv, NULL, 0)));
3790         if (CvANON(cv) || !CvHASGV(cv)) {
3791             DIE(aTHX_ "Undefined subroutine called");
3792         }
3793
3794         /* autoloaded stub? */
3795         if (cv != GvCV(gv = CvGV(cv))) {
3796             cv = GvCV(gv);
3797         }
3798         /* should call AUTOLOAD now? */
3799         else {
3800           try_autoload:
3801             autogv = gv_autoload_pvn(GvSTASH(gv), GvNAME(gv), GvNAMELEN(gv),
3802                                      (GvNAMEUTF8(gv) ? SVf_UTF8 : 0)
3803                                     |(PL_op->op_flags & OPf_REF
3804                                        ? GV_AUTOLOAD_ISMETHOD
3805                                        : 0));
3806             cv = autogv ? GvCV(autogv) : NULL;
3807         }
3808         if (!cv) {
3809             sub_name = sv_newmortal();
3810             gv_efullname3(sub_name, gv, NULL);
3811             DIE(aTHX_ "Undefined subroutine &%"SVf" called", SVfARG(sub_name));
3812         }
3813     }
3814
3815     /* unrolled "CvCLONE(cv) && ! CvCLONED(cv)" */
3816     if (UNLIKELY((CvFLAGS(cv) & (CVf_CLONE|CVf_CLONED)) == CVf_CLONE))
3817         DIE(aTHX_ "Closure prototype called");
3818
3819     if (UNLIKELY((PL_op->op_private & OPpENTERSUB_DB) && GvCV(PL_DBsub)
3820             && !CvNODEBUG(cv)))
3821     {
3822          Perl_get_db_sub(aTHX_ &sv, cv);
3823          if (CvISXSUB(cv))
3824              PL_curcopdb = PL_curcop;
3825          if (CvLVALUE(cv)) {
3826              /* check for lsub that handles lvalue subroutines */
3827              cv = GvCV(gv_fetchpvs("DB::lsub", GV_ADDMULTI, SVt_PVCV));
3828              /* if lsub not found then fall back to DB::sub */
3829              if (!cv) cv = GvCV(PL_DBsub);
3830          } else {
3831              cv = GvCV(PL_DBsub);
3832          }
3833
3834         if (!cv || (!CvXSUB(cv) && !CvSTART(cv)))
3835             DIE(aTHX_ "No DB::sub routine defined");
3836     }
3837
3838     if (!(CvISXSUB(cv))) {
3839         /* This path taken at least 75% of the time   */
3840         dMARK;
3841         PADLIST *padlist;
3842         I32 depth;
3843         bool hasargs;
3844         U8 gimme;
3845
3846         /* keep PADTMP args alive throughout the call (we need to do this
3847          * because @_ isn't refcounted). Note that we create the mortals
3848          * in the caller's tmps frame, so they won't be freed until after
3849          * we return from the sub.
3850          */
3851         {
3852             SV **svp = MARK;
3853             while (svp < SP) {
3854                 SV *sv = *++svp;
3855                 if (!sv)
3856                     continue;
3857                 if (SvPADTMP(sv))
3858                     *svp = sv = sv_mortalcopy(sv);
3859                 SvTEMP_off(sv);
3860             }
3861         }
3862
3863         gimme = GIMME_V;
3864         cx = cx_pushblock(CXt_SUB, gimme, MARK, old_savestack_ix);
3865         hasargs = cBOOL(PL_op->op_flags & OPf_STACKED);
3866         cx_pushsub(cx, cv, PL_op->op_next, hasargs);
3867
3868         padlist = CvPADLIST(cv);
3869         if (UNLIKELY((depth = ++CvDEPTH(cv)) >= 2))
3870             pad_push(padlist, depth);
3871         PAD_SET_CUR_NOSAVE(padlist, depth);
3872         if (LIKELY(hasargs)) {
3873             AV *const av = MUTABLE_AV(PAD_SVl(0));
3874             SSize_t items;
3875             AV **defavp;
3876
3877             defavp = &GvAV(PL_defgv);
3878             cx->blk_sub.savearray = *defavp;
3879             *defavp = MUTABLE_AV(SvREFCNT_inc_simple_NN(av));
3880
3881             /* it's the responsibility of whoever leaves a sub to ensure
3882              * that a clean, empty AV is left in pad[0]. This is normally
3883              * done by cx_popsub() */
3884             assert(!AvREAL(av) && AvFILLp(av) == -1);
3885
3886             items = SP - MARK;
3887             if (UNLIKELY(items - 1 > AvMAX(av))) {
3888                 SV **ary = AvALLOC(av);
3889                 AvMAX(av) = items - 1;
3890                 Renew(ary, items, SV*);
3891                 AvALLOC(av) = ary;
3892                 AvARRAY(av) = ary;
3893             }
3894
3895             Copy(MARK+1,AvARRAY(av),items,SV*);
3896             AvFILLp(av) = items - 1;
3897         }
3898         if (UNLIKELY((cx->blk_u16 & OPpENTERSUB_LVAL_MASK) == OPpLVAL_INTRO &&
3899             !CvLVALUE(cv)))
3900             DIE(aTHX_ "Can't modify non-lvalue subroutine call of &%"SVf,
3901                 SVfARG(cv_name(cv, NULL, 0)));
3902         /* warning must come *after* we fully set up the context
3903          * stuff so that __WARN__ handlers can safely dounwind()
3904          * if they want to
3905          */
3906         if (UNLIKELY(depth == PERL_SUB_DEPTH_WARN
3907                 && ckWARN(WARN_RECURSION)
3908                 && !(PERLDB_SUB && cv == GvCV(PL_DBsub))))
3909             sub_crush_depth(cv);
3910         RETURNOP(CvSTART(cv));
3911     }
3912     else {
3913         SSize_t markix = TOPMARK;
3914         bool is_scalar;
3915
3916         ENTER;
3917         /* pretend we did the ENTER earlier */
3918         PL_scopestack[PL_scopestack_ix - 1] = old_savestack_ix;
3919
3920         SAVETMPS;
3921         PUTBACK;
3922
3923         if (UNLIKELY(((PL_op->op_private
3924                & CX_PUSHSUB_GET_LVALUE_MASK(Perl_is_lvalue_sub)
3925              ) & OPpENTERSUB_LVAL_MASK) == OPpLVAL_INTRO &&
3926             !CvLVALUE(cv)))
3927             DIE(aTHX_ "Can't modify non-lvalue subroutine call of &%"SVf,
3928                 SVfARG(cv_name(cv, NULL, 0)));
3929
3930         if (UNLIKELY(!(PL_op->op_flags & OPf_STACKED) && GvAV(PL_defgv))) {
3931             /* Need to copy @_ to stack. Alternative may be to
3932              * switch stack to @_, and copy return values
3933              * back. This would allow popping @_ in XSUB, e.g.. XXXX */
3934             AV * const av = GvAV(PL_defgv);
3935             const SSize_t items = AvFILL(av) + 1;
3936
3937             if (items) {
3938                 SSize_t i = 0;
3939                 const bool m = cBOOL(SvRMAGICAL(av));
3940                 /* Mark is at the end of the stack. */
3941                 EXTEND(SP, items);
3942                 for (; i < items; ++i)
3943                 {
3944                     SV *sv;
3945                     if (m) {
3946                         SV ** const svp = av_fetch(av, i, 0);
3947                         sv = svp ? *svp : NULL;
3948                     }
3949                     else sv = AvARRAY(av)[i];
3950                     if (sv) SP[i+1] = sv;
3951                     else {
3952                         SP[i+1] = newSVavdefelem(av, i, 1);
3953                     }
3954                 }
3955                 SP += items;
3956                 PUTBACK ;
3957             }
3958         }
3959         else {
3960             SV **mark = PL_stack_base + markix;
3961             SSize_t items = SP - mark;
3962             while (items--) {
3963                 mark++;
3964                 if (*mark && SvPADTMP(*mark)) {
3965                     *mark = sv_mortalcopy(*mark);
3966                 }
3967             }
3968         }
3969         /* We assume first XSUB in &DB::sub is the called one. */
3970         if (UNLIKELY(PL_curcopdb)) {
3971             SAVEVPTR(PL_curcop);
3972             PL_curcop = PL_curcopdb;
3973             PL_curcopdb = NULL;
3974         }
3975         /* Do we need to open block here? XXXX */
3976
3977         /* calculate gimme here as PL_op might get changed and then not
3978          * restored until the LEAVE further down */
3979         is_scalar = (GIMME_V == G_SCALAR);
3980
3981         /* CvXSUB(cv) must not be NULL because newXS() refuses NULL xsub address */
3982         assert(CvXSUB(cv));
3983         CvXSUB(cv)(aTHX_ cv);
3984
3985         /* Enforce some sanity in scalar context. */
3986         if (is_scalar) {
3987             SV **svp = PL_stack_base + markix + 1;
3988             if (svp != PL_stack_sp) {
3989                 *svp = svp > PL_stack_sp ? &PL_sv_undef : *PL_stack_sp;
3990                 PL_stack_sp = svp;
3991             }
3992         }
3993         LEAVE;
3994         return NORMAL;
3995     }
3996 }
3997
3998 void
3999 Perl_sub_crush_depth(pTHX_ CV *cv)
4000 {
4001     PERL_ARGS_ASSERT_SUB_CRUSH_DEPTH;
4002
4003     if (CvANON(cv))
4004         Perl_warner(aTHX_ packWARN(WARN_RECURSION), "Deep recursion on anonymous subroutine");
4005     else {
4006         Perl_warner(aTHX_ packWARN(WARN_RECURSION), "Deep recursion on subroutine \"%"SVf"\"",
4007                     SVfARG(cv_name(cv,NULL,0)));
4008     }
4009 }
4010
4011
4012
4013 /* like croak, but report in context of caller */
4014
4015 void
4016 Perl_croak_caller(const char *pat, ...)
4017 {
4018     dTHX;
4019     va_list args;
4020     const PERL_CONTEXT *cx = caller_cx(0, NULL);
4021
4022     /* make error appear at call site */
4023     assert(cx);
4024     PL_curcop = cx->blk_oldcop;
4025
4026     va_start(args, pat);
4027     vcroak(pat, &args);
4028     NOT_REACHED; /* NOTREACHED */
4029     va_end(args);
4030 }
4031
4032
4033 PP(pp_aelem)
4034 {
4035     dSP;
4036     SV** svp;
4037     SV* const elemsv = POPs;
4038     IV elem = SvIV(elemsv);
4039     AV *const av = MUTABLE_AV(POPs);
4040     const U32 lval = PL_op->op_flags & OPf_MOD || LVRET;
4041     const U32 defer = PL_op->op_private & OPpLVAL_DEFER;
4042     const bool localizing = PL_op->op_private & OPpLVAL_INTRO;
4043     bool preeminent = TRUE;
4044     SV *sv;
4045
4046     if (UNLIKELY(SvROK(elemsv) && !SvGAMAGIC(elemsv) && ckWARN(WARN_MISC)))
4047         Perl_warner(aTHX_ packWARN(WARN_MISC),
4048                     "Use of reference \"%"SVf"\" as array index",
4049                     SVfARG(elemsv));
4050     if (UNLIKELY(SvTYPE(av) != SVt_PVAV))
4051         RETPUSHUNDEF;
4052
4053     if (UNLIKELY(localizing)) {
4054         MAGIC *mg;
4055         HV *stash;
4056
4057         /* If we can determine whether the element exist,
4058          * Try to preserve the existenceness of a tied array
4059          * element by using EXISTS and DELETE if possible.
4060          * Fallback to FETCH and STORE otherwise. */
4061         if (SvCANEXISTDELETE(av))
4062             preeminent = av_exists(av, elem);
4063     }
4064
4065     svp = av_fetch(av, elem, lval && !defer);
4066     if (lval) {
4067 #ifdef PERL_MALLOC_WRAP
4068          if (SvUOK(elemsv)) {
4069               const UV uv = SvUV(elemsv);
4070               elem = uv > IV_MAX ? IV_MAX : uv;
4071          }
4072          else if (SvNOK(elemsv))
4073               elem = (IV)SvNV(elemsv);
4074          if (elem > 0) {
4075               static const char oom_array_extend[] =
4076                 "Out of memory during array extend"; /* Duplicated in av.c */
4077               MEM_WRAP_CHECK_1(elem,SV*,oom_array_extend);
4078          }
4079 #endif
4080         if (!svp || !*svp) {
4081             IV len;
4082             if (!defer)
4083                 DIE(aTHX_ PL_no_aelem, elem);
4084             len = av_tindex(av);
4085             mPUSHs(newSVavdefelem(av,
4086             /* Resolve a negative index now, unless it points before the
4087                beginning of the array, in which case record it for error
4088                reporting in magic_setdefelem. */
4089                 elem < 0 && len + elem >= 0 ? len + elem : elem,
4090                 1));
4091             RETURN;
4092         }
4093         if (UNLIKELY(localizing)) {
4094             if (preeminent)
4095                 save_aelem(av, elem, svp);
4096             else
4097                 SAVEADELETE(av, elem);
4098         }
4099         else if (PL_op->op_private & OPpDEREF) {
4100             PUSHs(vivify_ref(*svp, PL_op->op_private & OPpDEREF));
4101             RETURN;
4102         }
4103     }
4104     sv = (svp ? *svp : &PL_sv_undef);
4105     if (!lval && SvRMAGICAL(av) && SvGMAGICAL(sv)) /* see note in pp_helem() */
4106         mg_get(sv);
4107     PUSHs(sv);
4108     RETURN;
4109 }
4110
4111 SV*
4112 Perl_vivify_ref(pTHX_ SV *sv, U32 to_what)
4113 {
4114     PERL_ARGS_ASSERT_VIVIFY_REF;
4115
4116     SvGETMAGIC(sv);
4117     if (!SvOK(sv)) {
4118         if (SvREADONLY(sv))
4119             Perl_croak_no_modify();
4120         prepare_SV_for_RV(sv);
4121         switch (to_what) {
4122         case OPpDEREF_SV:
4123             SvRV_set(sv, newSV(0));
4124             break;
4125         case OPpDEREF_AV:
4126             SvRV_set(sv, MUTABLE_SV(newAV()));
4127             break;
4128         case OPpDEREF_HV:
4129             SvRV_set(sv, MUTABLE_SV(newHV()));
4130             break;
4131         }
4132         SvROK_on(sv);
4133         SvSETMAGIC(sv);
4134         SvGETMAGIC(sv);
4135     }
4136     if (SvGMAGICAL(sv)) {
4137         /* copy the sv without magic to prevent magic from being
4138            executed twice */
4139         SV* msv = sv_newmortal();
4140         sv_setsv_nomg(msv, sv);
4141         return msv;
4142     }
4143     return sv;
4144 }
4145
4146 PERL_STATIC_INLINE HV *
4147 S_opmethod_stash(pTHX_ SV* meth)
4148 {
4149     SV* ob;
4150     HV* stash;
4151
4152     SV* const sv = PL_stack_base + TOPMARK == PL_stack_sp
4153         ? (Perl_croak(aTHX_ "Can't call method \"%"SVf"\" without a "
4154                             "package or object reference", SVfARG(meth)),
4155            (SV *)NULL)
4156         : *(PL_stack_base + TOPMARK + 1);
4157
4158     PERL_ARGS_ASSERT_OPMETHOD_STASH;
4159
4160     if (UNLIKELY(!sv))
4161        undefined:
4162         Perl_croak(aTHX_ "Can't call method \"%"SVf"\" on an undefined value",
4163                    SVfARG(meth));
4164
4165     if (UNLIKELY(SvGMAGICAL(sv))) mg_get(sv);
4166     else if (SvIsCOW_shared_hash(sv)) { /* MyClass->meth() */
4167         stash = gv_stashsv(sv, GV_CACHE_ONLY);
4168         if (stash) return stash;
4169     }
4170
4171     if (SvROK(sv))
4172         ob = MUTABLE_SV(SvRV(sv));
4173     else if (!SvOK(sv)) goto undefined;
4174     else if (isGV_with_GP(sv)) {
4175         if (!GvIO(sv))
4176             Perl_croak(aTHX_ "Can't call method \"%"SVf"\" "
4177                              "without a package or object reference",
4178                               SVfARG(meth));
4179         ob = sv;
4180         if (SvTYPE(ob) == SVt_PVLV && LvTYPE(ob) == 'y') {
4181             assert(!LvTARGLEN(ob));
4182             ob = LvTARG(ob);
4183             assert(ob);
4184         }
4185         *(PL_stack_base + TOPMARK + 1) = sv_2mortal(newRV(ob));
4186     }
4187     else {
4188         /* this isn't a reference */
4189         GV* iogv;
4190         STRLEN packlen;
4191         const char * const packname = SvPV_nomg_const(sv, packlen);
4192         const U32 packname_utf8 = SvUTF8(sv);
4193         stash = gv_stashpvn(packname, packlen, packname_utf8 | GV_CACHE_ONLY);
4194         if (stash) return stash;
4195
4196         if (!(iogv = gv_fetchpvn_flags(
4197                 packname, packlen, packname_utf8, SVt_PVIO
4198              )) ||
4199             !(ob=MUTABLE_SV(GvIO(iogv))))
4200         {
4201             /* this isn't the name of a filehandle either */
4202             if (!packlen)
4203             {
4204                 Perl_croak(aTHX_ "Can't call method \"%"SVf"\" "
4205                                  "without a package or object reference",
4206                                   SVfARG(meth));
4207             }
4208             /* assume it's a package name */
4209             stash = gv_stashpvn(packname, packlen, packname_utf8);
4210             if (stash) return stash;
4211             else return MUTABLE_HV(sv);
4212         }
4213         /* it _is_ a filehandle name -- replace with a reference */
4214         *(PL_stack_base + TOPMARK + 1) = sv_2mortal(newRV(MUTABLE_SV(iogv)));
4215     }
4216
4217     /* if we got here, ob should be an object or a glob */
4218     if (!ob || !(SvOBJECT(ob)
4219                  || (isGV_with_GP(ob)
4220                      && (ob = MUTABLE_SV(GvIO((const GV *)ob)))
4221                      && SvOBJECT(ob))))
4222     {
4223         Perl_croak(aTHX_ "Can't call method \"%"SVf"\" on unblessed reference",
4224                    SVfARG((SvSCREAM(meth) && strEQ(SvPV_nolen_const(meth),"isa"))
4225                                         ? newSVpvs_flags("DOES", SVs_TEMP)
4226                                         : meth));
4227     }
4228
4229     return SvSTASH(ob);
4230 }
4231
4232 PP(pp_method)
4233 {
4234     dSP;
4235     GV* gv;
4236     HV* stash;
4237     SV* const meth = TOPs;
4238
4239     if (SvROK(meth)) {
4240         SV* const rmeth = SvRV(meth);
4241         if (SvTYPE(rmeth) == SVt_PVCV) {
4242             SETs(rmeth);
4243             RETURN;
4244         }
4245     }
4246
4247     stash = opmethod_stash(meth);
4248
4249     gv = gv_fetchmethod_sv_flags(stash, meth, GV_AUTOLOAD|GV_CROAK);
4250     assert(gv);
4251
4252     SETs(isGV(gv) ? MUTABLE_SV(GvCV(gv)) : MUTABLE_SV(gv));
4253     RETURN;
4254 }
4255
4256 #define METHOD_CHECK_CACHE(stash,cache,meth)                            \
4257     const HE* const he = hv_fetch_ent(cache, meth, 0, 0);               \
4258     if (he) {                                                           \
4259         gv = MUTABLE_GV(HeVAL(he));                                     \
4260         if (isGV(gv) && GvCV(gv) && (!GvCVGEN(gv) || GvCVGEN(gv)        \
4261              == (PL_sub_generation + HvMROMETA(stash)->cache_gen)))     \
4262         {                                                               \
4263             XPUSHs(MUTABLE_SV(GvCV(gv)));                               \
4264             RETURN;                                                     \
4265         }                                                               \
4266     }                                                                   \
4267
4268 PP(pp_method_named)
4269 {
4270     dSP;
4271     GV* gv;
4272     SV* const meth = cMETHOPx_meth(PL_op);
4273     HV* const stash = opmethod_stash(meth);
4274
4275     if (LIKELY(SvTYPE(stash) == SVt_PVHV)) {
4276         METHOD_CHECK_CACHE(stash, stash, meth);
4277     }
4278
4279     gv = gv_fetchmethod_sv_flags(stash, meth, GV_AUTOLOAD|GV_CROAK);
4280     assert(gv);
4281
4282     XPUSHs(isGV(gv) ? MUTABLE_SV(GvCV(gv)) : MUTABLE_SV(gv));
4283     RETURN;
4284 }
4285
4286 PP(pp_method_super)
4287 {
4288     dSP;
4289     GV* gv;
4290     HV* cache;
4291     SV* const meth = cMETHOPx_meth(PL_op);
4292     HV* const stash = CopSTASH(PL_curcop);
4293     /* Actually, SUPER doesn't need real object's (or class') stash at all,
4294      * as it uses CopSTASH. However, we must ensure that object(class) is
4295      * correct (this check is done by S_opmethod_stash) */
4296     opmethod_stash(meth);
4297
4298     if ((cache = HvMROMETA(stash)->super)) {
4299         METHOD_CHECK_CACHE(stash, cache, meth);
4300     }
4301
4302     gv = gv_fetchmethod_sv_flags(stash, meth, GV_AUTOLOAD|GV_CROAK|GV_SUPER);
4303     assert(gv);
4304
4305     XPUSHs(isGV(gv) ? MUTABLE_SV(GvCV(gv)) : MUTABLE_SV(gv));
4306     RETURN;
4307 }
4308
4309 PP(pp_method_redir)
4310 {
4311     dSP;
4312     GV* gv;
4313     SV* const meth = cMETHOPx_meth(PL_op);
4314     HV* stash = gv_stashsv(cMETHOPx_rclass(PL_op), 0);
4315     opmethod_stash(meth); /* not used but needed for error checks */
4316
4317     if (stash) { METHOD_CHECK_CACHE(stash, stash, meth); }
4318     else stash = MUTABLE_HV(cMETHOPx_rclass(PL_op));
4319
4320     gv = gv_fetchmethod_sv_flags(stash, meth, GV_AUTOLOAD|GV_CROAK);
4321     assert(gv);
4322
4323     XPUSHs(isGV(gv) ? MUTABLE_SV(GvCV(gv)) : MUTABLE_SV(gv));
4324     RETURN;
4325 }
4326
4327 PP(pp_method_redir_super)
4328 {
4329     dSP;
4330     GV* gv;
4331     HV* cache;
4332     SV* const meth = cMETHOPx_meth(PL_op);
4333     HV* stash = gv_stashsv(cMETHOPx_rclass(PL_op), 0);
4334     opmethod_stash(meth); /* not used but needed for error checks */
4335
4336     if (UNLIKELY(!stash)) stash = MUTABLE_HV(cMETHOPx_rclass(PL_op));
4337     else if ((cache = HvMROMETA(stash)->super)) {
4338          METHOD_CHECK_CACHE(stash, cache, meth);
4339     }
4340
4341     gv = gv_fetchmethod_sv_flags(stash, meth, GV_AUTOLOAD|GV_CROAK|GV_SUPER);
4342     assert(gv);
4343
4344     XPUSHs(isGV(gv) ? MUTABLE_SV(GvCV(gv)) : MUTABLE_SV(gv));
4345     RETURN;
4346 }
4347
4348 /*
4349  * ex: set ts=8 sts=4 sw=4 et:
4350  */