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