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
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.
12 * Then he heard Merry change the note, and up went the Horn-cry of Buckland,
15 * Awake! Awake! Fear, Fire, Foes! Awake!
18 * [p.1007 of _The Lord of the Rings_, VI/viii: "The Scouring of the Shire"]
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.
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
35 #define PERL_IN_PP_HOT_C
50 PL_curcop = (COP*)PL_op;
51 TAINT_NOT; /* Each statement is presumed innocent */
52 PL_stack_sp = PL_stack_base + CX_CUR()->blk_oldsp;
62 if (UNLIKELY(PL_op->op_private & OPpLVAL_INTRO))
63 PUSHs(save_scalar(cGVOP_gv));
65 PUSHs(GvSVn(cGVOP_gv));
70 /* also used for: pp_lineseq() pp_regcmaybe() pp_scalar() pp_scope() */
77 /* This is sometimes called directly by pp_coreargs, pp_grepstart and
81 PUSHMARK(PL_stack_sp);
92 /* no PUTBACK, SETs doesn't inc/dec SP */
99 XPUSHs(MUTABLE_SV(cGVOP_gv));
104 /* also used for: pp_andassign() */
110 /* SP is not used to remove a variable that is saved across the
111 sv_2bool_flags call in SvTRUE_NN, if a RISC/CISC or low/high machine
112 register or load/store vs direct mem ops macro is introduced, this
113 should be a define block between direct PL_stack_sp and dSP operations,
114 presently, using PL_stack_sp is bias towards CISC cpus */
115 SV * const sv = *PL_stack_sp;
119 if (PL_op->op_type == OP_AND)
121 return cLOGOP->op_other;
129 /* sassign keeps its args in the optree traditionally backwards.
130 So we pop them differently.
132 SV *left = POPs; SV *right = TOPs;
134 if (PL_op->op_private & OPpASSIGN_BACKWARDS) { /* {or,and,dor}assign */
135 SV * const temp = left;
136 left = right; right = temp;
138 assert(TAINTING_get || !TAINT_get);
139 if (UNLIKELY(TAINT_get) && !SvTAINTED(right))
141 if (UNLIKELY(PL_op->op_private & OPpASSIGN_CV_TO_GV)) {
143 SV * const cv = SvRV(right);
144 const U32 cv_type = SvTYPE(cv);
145 const bool is_gv = isGV_with_GP(left);
146 const bool got_coderef = cv_type == SVt_PVCV || cv_type == SVt_PVFM;
152 /* Can do the optimisation if left (LVALUE) is not a typeglob,
153 right (RVALUE) is a reference to something, and we're in void
155 if (!got_coderef && !is_gv && GIMME_V == G_VOID) {
156 /* Is the target symbol table currently empty? */
157 GV * const gv = gv_fetchsv_nomg(left, GV_NOINIT, SVt_PVGV);
158 if (SvTYPE(gv) != SVt_PVGV && !SvOK(gv)) {
159 /* Good. Create a new proxy constant subroutine in the target.
160 The gv becomes a(nother) reference to the constant. */
161 SV *const value = SvRV(cv);
163 SvUPGRADE(MUTABLE_SV(gv), SVt_IV);
164 SvPCS_IMPORTED_on(gv);
166 SvREFCNT_inc_simple_void(value);
172 /* Need to fix things up. */
174 /* Need to fix GV. */
175 left = MUTABLE_SV(gv_fetchsv_nomg(left,GV_ADD, SVt_PVGV));
179 /* We've been returned a constant rather than a full subroutine,
180 but they expect a subroutine reference to apply. */
182 ENTER_with_name("sassign_coderef");
183 SvREFCNT_inc_void(SvRV(cv));
184 /* newCONSTSUB takes a reference count on the passed in SV
185 from us. We set the name to NULL, otherwise we get into
186 all sorts of fun as the reference to our new sub is
187 donated to the GV that we're about to assign to.
189 SvRV_set(right, MUTABLE_SV(newCONSTSUB(GvSTASH(left), NULL,
192 LEAVE_with_name("sassign_coderef");
194 /* What can happen for the corner case *{"BONK"} = \&{"BONK"};
196 First: ops for \&{"BONK"}; return us the constant in the
198 Second: ops for *{"BONK"} cause that symbol table entry
199 (and our reference to it) to be upgraded from RV
201 Thirdly: We get here. cv is actually PVGV now, and its
202 GvCV() is actually the subroutine we're looking for
204 So change the reference so that it points to the subroutine
205 of that typeglob, as that's what they were after all along.
207 GV *const upgraded = MUTABLE_GV(cv);
208 CV *const source = GvCV(upgraded);
211 assert(CvFLAGS(source) & CVf_CONST);
213 SvREFCNT_inc_simple_void_NN(source);
214 SvREFCNT_dec_NN(upgraded);
215 SvRV_set(right, MUTABLE_SV(source));
221 UNLIKELY(SvTEMP(left)) && !SvSMAGICAL(left) && SvREFCNT(left) == 1 &&
222 (!isGV_with_GP(left) || SvFAKE(left)) && ckWARN(WARN_MISC)
225 packWARN(WARN_MISC), "Useless assignment to a temporary"
227 SvSetMagicSV(left, right);
239 RETURNOP(SvTRUE_NN(sv) ? cLOGOP->op_other : cLOGOP->op_next);
246 TAINT_NOT; /* Each statement is presumed innocent */
248 PL_stack_sp = PL_stack_base + cx->blk_oldsp;
250 if (!(PL_op->op_flags & OPf_SPECIAL)) {
251 assert(CxTYPE(cx) == CXt_BLOCK || CxTYPE_is_LOOP(cx));
258 /* The main body of pp_concat, not including the magic/overload and
260 * It does targ = left . right.
261 * Moved into a separate function so that pp_multiconcat() can use it
265 PERL_STATIC_INLINE void
266 S_do_concat(pTHX_ SV *left, SV *right, SV *targ, U8 targmy)
270 const char *rpv = NULL;
272 bool rcopied = FALSE;
274 if (TARG == right && right != left) { /* $r = $l.$r */
275 rpv = SvPV_nomg_const(right, rlen);
276 rbyte = !DO_UTF8(right);
277 right = newSVpvn_flags(rpv, rlen, SVs_TEMP);
278 rpv = SvPV_const(right, rlen); /* no point setting UTF-8 here */
282 if (TARG != left) { /* not $l .= $r */
284 const char* const lpv = SvPV_nomg_const(left, llen);
285 lbyte = !DO_UTF8(left);
286 sv_setpvn(TARG, lpv, llen);
292 else { /* $l .= $r and left == TARG */
294 if ((left == right /* $l .= $l */
295 || targmy) /* $l = $l . $r */
296 && ckWARN(WARN_UNINITIALIZED)
302 SvPV_force_nomg_nolen(left);
304 lbyte = !DO_UTF8(left);
310 rpv = SvPV_nomg_const(right, rlen);
311 rbyte = !DO_UTF8(right);
313 if (lbyte != rbyte) {
315 sv_utf8_upgrade_nomg(TARG);
318 right = newSVpvn_flags(rpv, rlen, SVs_TEMP);
319 sv_utf8_upgrade_nomg(right);
320 rpv = SvPV_nomg_const(right, rlen);
323 sv_catpvn_nomg(TARG, rpv, rlen);
330 dSP; dATARGET; tryAMAGICbin_MG(concat_amg, AMGf_assign);
333 S_do_concat(aTHX_ left, right, targ, PL_op->op_private & OPpTARGET_MY);
342 Concatenate one or more args, possibly interleaved with constant string
343 segments. The result may be assigned to, or appended to, a variable or
346 Several op_flags and/or op_private bits indicate what the target is, and
347 whether it's appended to. Valid permutations are:
349 - (PADTMP) = (A.B.C....)
350 OPpTARGET_MY $lex = (A.B.C....)
351 OPpTARGET_MY,OPpLVAL_INTRO my $lex = (A.B.C....)
352 OPpTARGET_MY,OPpMULTICONCAT_APPEND $lex .= (A.B.C....)
353 OPf_STACKED expr = (A.B.C....)
354 OPf_STACKED,OPpMULTICONCAT_APPEND expr .= (A.B.C....)
356 Other combinations like (A.B).(C.D) are not optimised into a multiconcat
357 op, as it's too hard to get the correct ordering of ties, overload etc.
361 OPpMULTICONCAT_FAKE: not a real concat, instead an optimised
362 sprintf "...%s...". Don't call '.'
363 overloading: only use '""' overloading.
365 OPpMULTICONCAT_STRINGIFY: the RHS was of the form
366 "...$a...$b..." rather than
367 "..." . $a . "..." . $b . "..."
369 An OP_MULTICONCAT is of type UNOP_AUX. The fixed slots of the aux array are
370 defined with PERL_MULTICONCAT_IX_FOO constants, where:
373 FOO index description
374 -------- ----- ----------------------------------
375 NARGS 0 number of arguments
376 PLAIN_PV 1 non-utf8 constant string
377 PLAIN_LEN 2 non-utf8 constant string length
378 UTF8_PV 3 utf8 constant string
379 UTF8_LEN 4 utf8 constant string length
380 LENGTHS 5 first of nargs+1 const segment lengths
382 The idea is that a general string concatenation will have a fixed (known
383 at compile time) number of variable args, interspersed with constant
384 strings, e.g. "a=$a b=$b\n"
386 All the constant string segments "a=", " b=" and "\n" are stored as a
387 single string "a= b=\n", pointed to from the PLAIN_PV/UTF8_PV slot, along
388 with a series of segment lengths: e.g. 2,3,1. In the case where the
389 constant string is plain but has a different utf8 representation, both
390 variants are stored, and two sets of (nargs+1) segments lengths are stored
391 in the slots beginning at PERL_MULTICONCAT_IX_LENGTHS.
393 A segment length of -1 indicates that there is no constant string at that
394 point; this distinguishes between e.g. ($a . $b) and ($a . "" . $b), which
395 have differing overloading behaviour.
402 SV *targ; /* The SV to be assigned or appended to */
403 char *targ_pv; /* where within SvPVX(targ) we're writing to */
404 STRLEN targ_len; /* SvCUR(targ) */
405 SV **toparg; /* the highest arg position on the stack */
406 UNOP_AUX_item *aux; /* PL_op->op_aux buffer */
407 UNOP_AUX_item *const_lens; /* the segment length array part of aux */
408 const char *const_pv; /* the current segment of the const string buf */
409 SSize_t nargs; /* how many args were expected */
410 SSize_t stack_adj; /* how much to adjust SP on return */
411 STRLEN grow; /* final size of destination string (targ) */
412 UV targ_count; /* how many times targ has appeared on the RHS */
413 bool is_append; /* OPpMULTICONCAT_APPEND flag is set */
414 bool slow_concat; /* args too complex for quick concat */
415 U32 dst_utf8; /* the result will be utf8 (indicate this with
416 SVf_UTF8 in a U32, rather than using bool,
417 for ease of testing and setting) */
418 /* for each arg, holds the result of an SvPV() call */
419 struct multiconcat_svpv {
423 *targ_chain, /* chain of slots where targ has appeared on RHS */
424 *svpv_p, /* ptr for looping through svpv_buf */
425 *svpv_base, /* first slot (may be greater than svpv_buf), */
426 *svpv_end, /* and slot after highest result so far, of: */
427 svpv_buf[PERL_MULTICONCAT_MAXARG]; /* buf for storing SvPV() results */
429 aux = cUNOP_AUXx(PL_op)->op_aux;
430 stack_adj = nargs = aux[PERL_MULTICONCAT_IX_NARGS].ssize;
431 is_append = cBOOL(PL_op->op_private & OPpMULTICONCAT_APPEND);
433 /* get targ from the stack or pad */
435 if (PL_op->op_flags & OPf_STACKED) {
437 /* for 'expr .= ...', expr is the bottom item on the stack */
442 /* for 'expr = ...', expr is the top item on the stack */
446 SV **svp = &(PAD_SVl(PL_op->op_targ));
448 if (PL_op->op_private & OPpLVAL_INTRO) {
449 assert(PL_op->op_private & OPpTARGET_MY);
453 /* $lex .= "const" doesn't cause anything to be pushed */
459 grow = 1; /* allow for '\0' at minimum */
464 /* only utf8 variants of the const strings? */
465 dst_utf8 = aux[PERL_MULTICONCAT_IX_PLAIN_PV].pv ? 0 : SVf_UTF8;
468 /* --------------------------------------------------------------
471 * stringify (i.e. SvPV()) every arg and store the resultant pv/len/utf8
472 * triplets in svpv_buf[]. Also increment 'grow' by the args' lengths.
474 * utf8 is indicated by storing a negative length.
476 * Where an arg is actually targ, the stringification is deferred:
477 * the length is set to 0, and the slot is added to targ_chain.
479 * If a magic, overloaded, or otherwise weird arg is found, which
480 * might have side effects when stringified, the loop is abandoned and
481 * we goto a code block where a more basic 'emulate calling
482 * pp_cpncat() on each arg in turn' is done.
485 for (; SP <= toparg; SP++, svpv_end++) {
490 assert(svpv_end - svpv_buf < PERL_MULTICONCAT_MAXARG);
494 /* this if/else chain is arranged so that common/simple cases
495 * take few conditionals */
497 if (LIKELY((SvFLAGS(sv) & (SVs_GMG|SVf_ROK|SVf_POK)) == SVf_POK)) {
498 /* common case: sv is a simple non-magical PV */
500 /* targ appears on RHS.
501 * Delay storing PV pointer; instead, add slot to targ_chain
502 * so it can be populated later, after targ has been grown and
503 * we know its final SvPVX() address.
506 svpv_end->len = 0; /* zerojng here means we can skip
507 updating later if targ_len == 0 */
508 svpv_end->pv = (char*)targ_chain;
509 targ_chain = svpv_end;
515 svpv_end->pv = SvPVX(sv);
517 else if (UNLIKELY(SvFLAGS(sv) & (SVs_GMG|SVf_ROK)))
518 /* may have side effects: tie, overload etc.
519 * Abandon 'stringify everything first' and handle
520 * args in strict order. Note that already-stringified args
521 * will be reprocessed, which is safe because the each first
522 * stringification would have been idempotent.
525 else if (SvNIOK(sv)) {
528 /* stringify general valid scalar */
529 svpv_end->pv = sv_2pv_flags(sv, &len, 0);
531 else if (!SvOK(sv)) {
532 if (ckWARN(WARN_UNINITIALIZED))
533 /* an undef value in the presence of warnings may trigger
540 goto do_magical; /* something weird */
542 utf8 = (SvFLAGS(sv) & SVf_UTF8);
544 ASSUME(len < SSize_t_MAX);
545 svpv_end->len = utf8 ? -(SSize_t)len : (SSize_t)len;
549 /* --------------------------------------------------------------
554 * if targ appears on the RHS or is appended to, force stringify it;
555 * otherwise set it to "". Then set targ_len.
559 /* abandon quick route if using targ might have side effects */
560 if (UNLIKELY(SvFLAGS(targ) & (SVs_GMG|SVf_ROK)))
566 SvPV_force_nomg_nolen(targ);
567 targ_utf8 = SvFLAGS(targ) & SVf_UTF8;
568 if (UNLIKELY(dst_utf8 & ~targ_utf8)) {
569 if (LIKELY(!IN_BYTES))
570 sv_utf8_upgrade_nomg(targ);
573 dst_utf8 |= targ_utf8;
575 targ_len = SvCUR(targ);
576 grow += targ_len * (targ_count + is_append);
579 else if (ckWARN(WARN_UNINITIALIZED))
580 /* warning might have side effects */
582 /* the undef targ will be silently SvPVCLEAR()ed below */
584 else if (UNLIKELY(SvTYPE(targ) >= SVt_REGEXP)) {
585 /* Assigning to some weird LHS type. Don't force the LHS to be an
586 * empty string; instead, do things 'long hand' by using the
587 * overload code path, which concats to a TEMP sv and does
588 * sv_catsv() calls rather than COPY()s. This ensures that even
589 * bizarre code like this doesn't break or crash:
591 * (which makes the 'F' typeglob an alias to the
592 * '*main::F*main::F' typeglob).
597 /* targ was found on RHS.
598 * Force stringify it, using the same code as the append branch
599 * above, except that we don't need the magic/overload/undef
600 * checks as these will already have been done in the phase 1
605 /* unrolled SvPVCLEAR() - mostly: no need to grow or set SvCUR() to 0;
606 * those will be done later. */
607 SV_CHECK_THINKFIRST_COW_DROP(targ);
608 SvUPGRADE(targ, SVt_PV);
609 SvFLAGS(targ) &= ~(SVf_OK|SVf_IVisUV|SVf_UTF8);
610 SvFLAGS(targ) |= (SVf_POK|SVp_POK|dst_utf8);
614 /* --------------------------------------------------------------
617 * UTF-8 tweaks and grow targ:
619 * Now that we know the length and utf8-ness of both the targ and
620 * args, grow targ to the size needed to accumulate all the args, based
621 * on whether targ appears on the RHS, whether we're appending, and
622 * whether any non-utf8 args expand in size if converted to utf8.
624 * For the latter, if dst_utf8 we scan non-utf8 args looking for
625 * variant chars, and adjust the svpv->len value of those args to the
626 * utf8 size and negate it to flag them. At the same time we un-negate
627 * the lens of any utf8 args since after this phase we no longer care
628 * whether an arg is utf8 or not.
630 * Finally, initialise const_lens and const_pv based on utf8ness.
631 * Note that there are 3 permutations:
633 * * If the constant string is invariant whether utf8 or not (e.g. "abc"),
634 * then aux[PERL_MULTICONCAT_IX_PLAIN_PV/LEN] are the same as
635 * aux[PERL_MULTICONCAT_IX_UTF8_PV/LEN] and there is one set of
638 * * If the string is fully utf8, e.g. "\x{100}", then
639 * aux[PERL_MULTICONCAT_IX_PLAIN_PV/LEN] == (NULL,0) and there is
640 * one set of segment lengths.
642 * * If the string has different plain and utf8 representations
643 * (e.g. "\x80"), then aux[PERL_MULTICONCAT_IX_PLAIN_PV/LEN]]
644 * holds the plain rep, while aux[PERL_MULTICONCAT_IX_UTF8_PV/LEN]
645 * holds the utf8 rep, and there are 2 sets of segment lengths,
646 * with the utf8 set following after the plain set.
648 * On entry to this section the (pv,len) pairs in svpv_buf have the
649 * following meanings:
650 * (pv, len) a plain string
651 * (pv, -len) a utf8 string
652 * (NULL, 0) left-most targ \ linked together R-to-L
653 * (next, 0) other targ / in targ_chain
656 /* turn off utf8 handling if 'use bytes' is in scope */
657 if (UNLIKELY(dst_utf8 && IN_BYTES)) {
660 /* undo all the negative lengths which flag utf8-ness */
661 for (svpv_p = svpv_buf; svpv_p < svpv_end; svpv_p++) {
662 SSize_t len = svpv_p->len;
668 /* grow += total of lengths of constant string segments */
671 len = aux[dst_utf8 ? PERL_MULTICONCAT_IX_UTF8_LEN
672 : PERL_MULTICONCAT_IX_PLAIN_LEN].ssize;
673 slow_concat = cBOOL(len);
677 const_lens = aux + PERL_MULTICONCAT_IX_LENGTHS;
680 const_pv = aux[PERL_MULTICONCAT_IX_UTF8_PV].pv;
681 if ( aux[PERL_MULTICONCAT_IX_PLAIN_PV].pv
682 && const_pv != aux[PERL_MULTICONCAT_IX_PLAIN_PV].pv)
683 /* separate sets of lengths for plain and utf8 */
684 const_lens += nargs + 1;
686 /* If the result is utf8 but some of the args aren't,
687 * calculate how much extra growth is needed for all the chars
688 * which will expand to two utf8 bytes.
689 * Also, if the growth is non-zero, negate the length to indicate
690 * that this is a variant string. Conversely, un-negate the
691 * length on utf8 args (which was only needed to flag non-utf8
692 * args in this loop */
693 for (svpv_p = svpv_buf; svpv_p < svpv_end; svpv_p++) {
702 extra = variant_under_utf8_count((U8 *) svpv_p->pv,
703 (U8 *) svpv_p->pv + len);
704 if (UNLIKELY(extra)) {
706 /* -ve len indicates special handling */
707 svpv_p->len = -(len + extra);
713 const_pv = aux[PERL_MULTICONCAT_IX_PLAIN_PV].pv;
715 /* unrolled SvGROW(), except don't check for SVf_IsCOW, which should
716 * already have been dropped */
717 assert(!SvIsCOW(targ));
718 targ_pv = (SvLEN(targ) < (grow) ? sv_grow(targ,grow) : SvPVX(targ));
721 /* --------------------------------------------------------------
724 * Now that targ has been grown, we know the final address of the targ
725 * PVX, if needed. Preserve / move targ contents if appending or if
726 * targ appears on RHS.
728 * Also update svpv_buf slots in targ_chain.
730 * Don't bother with any of this if the target length is zero:
731 * targ_len is set to zero unless we're appending or targ appears on
732 * RHS. And even if it is, we can optimise by skipping this chunk of
733 * code for zero targ_len. In the latter case, we don't need to update
734 * the slots in targ_chain with the (zero length) target string, since
735 * we set the len in such slots to 0 earlier, and since the Copy() is
736 * skipped on zero length, it doesn't matter what svpv_p->pv contains.
738 * On entry to this section the (pv,len) pairs in svpv_buf have the
739 * following meanings:
740 * (pv, len) a pure-plain or utf8 string
741 * (pv, -(len+extra)) a plain string which will expand by 'extra'
742 * bytes when converted to utf8
743 * (NULL, 0) left-most targ \ linked together R-to-L
744 * (next, 0) other targ / in targ_chain
746 * On exit, the targ contents will have been moved to the
747 * earliest place they are needed (e.g. $x = "abc$x" will shift them
748 * 3 bytes, while $x .= ... will leave them at the beginning);
749 * and dst_pv will point to the location within SvPVX(targ) where the
750 * next arg should be copied.
753 svpv_base = svpv_buf;
756 struct multiconcat_svpv *tc_stop;
757 char *targ_buf = targ_pv; /* ptr to original targ string */
759 assert(is_append || targ_count);
766 /* The targ appears on RHS, e.g. '$t = $a . $t . $t'.
767 * Move the current contents of targ to the first
768 * position where it's needed, and use that as the src buffer
769 * for any further uses (such as the second RHS $t above).
770 * In calculating the first position, we need to sum the
771 * lengths of all consts and args before that.
774 UNOP_AUX_item *lens = const_lens;
775 /* length of first const string segment */
776 STRLEN offset = lens->ssize > 0 ? lens->ssize : 0;
784 break; /* the first targ argument */
785 /* add lengths of the next arg and const string segment */
787 if (len < 0) /* variant args have this */
789 offset += (STRLEN)len;
790 len = (++lens)->ssize;
791 offset += (len >= 0) ? (STRLEN)len : 0;
793 /* all args and consts so far are empty; update
794 * the start position for the concat later */
799 assert(svpv_p < svpv_end);
804 Move(targ_pv, targ_buf, targ_len, char);
805 /* a negative length implies don't Copy(), but do increment */
806 svpv_p->len = -((SSize_t)targ_len);
810 /* skip the first targ copy */
816 /* Don't populate the first targ slot in the loop below; it's
817 * either not used because we advanced svpv_base beyond it, or
818 * we already stored the special -targ_len value in it
823 /* populate slots in svpv_buf representing targ on RHS */
824 while (targ_chain != tc_stop) {
825 struct multiconcat_svpv *p = targ_chain;
826 targ_chain = (struct multiconcat_svpv *)(p->pv);
828 p->len = (SSize_t)targ_len;
833 /* --------------------------------------------------------------
836 * Append all the args in svpv_buf, plus the const strings, to targ.
838 * On entry to this section the (pv,len) pairs in svpv_buf have the
839 * following meanings:
840 * (pv, len) a pure-plain or utf8 string (which may be targ)
841 * (pv, -(len+extra)) a plain string which will expand by 'extra'
842 * bytes when converted to utf8
843 * (0, -len) left-most targ, whose content has already
844 * been copied. Just advance targ_pv by len.
847 /* If there are no constant strings and no special case args
848 * (svpv_p->len < 0), use a simpler, more efficient concat loop
851 for (svpv_p = svpv_base; svpv_p < svpv_end; svpv_p++) {
852 SSize_t len = svpv_p->len;
855 Copy(svpv_p->pv, targ_pv, len, char);
858 const_lens += (svpv_end - svpv_base + 1);
861 /* Note that we iterate the loop nargs+1 times: to append nargs
862 * arguments and nargs+1 constant strings. For example, "-$a-$b-"
864 svpv_p = svpv_base - 1;
867 SSize_t len = (const_lens++)->ssize;
869 /* append next const string segment */
871 Copy(const_pv, targ_pv, len, char);
876 if (++svpv_p == svpv_end)
879 /* append next arg */
882 if (LIKELY(len > 0)) {
883 Copy(svpv_p->pv, targ_pv, len, char);
886 else if (UNLIKELY(len < 0)) {
887 /* negative length indicates two special cases */
888 const char *p = svpv_p->pv;
891 /* copy plain-but-variant pv to a utf8 targ */
892 char * end_pv = targ_pv + len;
894 while (targ_pv < end_pv) {
896 append_utf8_from_native_byte(c, (U8**)&targ_pv);
900 /* arg is already-copied targ */
908 SvCUR_set(targ, targ_pv - SvPVX(targ));
909 assert(grow >= SvCUR(targ) + 1);
910 assert(SvLEN(targ) >= SvCUR(targ) + 1);
912 /* --------------------------------------------------------------
923 /* --------------------------------------------------------------
926 * We only get here if any of the args (or targ too in the case of
927 * append) have something which might cause side effects, such
928 * as magic, overload, or an undef value in the presence of warnings.
929 * In that case, any earlier attempt to stringify the args will have
930 * been abandoned, and we come here instead.
932 * Here, we concat each arg in turn the old-fashioned way: essentially
933 * emulating pp_concat() in a loop. This means that all the weird edge
934 * cases will be handled correctly, if not necessarily speedily.
936 * Note that some args may already have been stringified - those are
937 * processed again, which is safe, since only args without side-effects
938 * were stringified earlier.
950 const char *cpv = aux[PERL_MULTICONCAT_IX_PLAIN_PV].pv;
951 UNOP_AUX_item *lens = aux + PERL_MULTICONCAT_IX_LENGTHS;
952 Size_t arg_count = 0; /* how many args have been processed */
955 cpv = aux[PERL_MULTICONCAT_IX_UTF8_PV].pv;
959 svp = toparg - nargs + 1;
963 * plus possible nargs+1 consts,
964 * plus, if appending, a final targ in an extra last iteration
968 for (i = 0; i <= n; i++) {
971 /* if necessary, stringify the final RHS result in
972 * something like $targ .= "$a$b$c" - simulating
976 && (PL_op->op_private &OPpMULTICONCAT_STRINGIFY)
978 /* extra conditions for backwards compatibility:
979 * probably incorrect, but keep the existing behaviour
980 * for now. The rules are:
981 * $x = "$ov" single arg: stringify;
982 * $x = "$ov$y" multiple args: don't stringify,
983 * $lex = "$ov$y$z" except TARGMY with at least 2 concats
988 && (PL_op->op_private & OPpTARGET_MY)
989 && !(PL_op->op_private & OPpLVAL_INTRO)
994 SV *tmp = sv_newmortal();
995 sv_copypv(tmp, left);
1000 /* do one extra iteration to handle $targ in $targ .= ... */
1001 if (i == n && !is_append)
1004 /* get the next arg SV or regen the next const SV */
1005 len = lens[i >> 1].ssize;
1007 /* handle the final targ .= (....) */
1012 right = svp[(i >> 1)];
1014 continue; /* no const in this position */
1016 right = newSVpvn_flags(cpv, len, (utf8 | SVs_TEMP));
1022 if (arg_count <= 1) {
1024 continue; /* need at least two SVs to concat together */
1027 if (arg_count == 2 && i < n) {
1028 /* for the first concat, create a mortal acting like the
1029 * padtmp from OP_CONST. In later iterations this will
1031 nexttarg = sv_newmortal();
1039 /* Handle possible overloading.
1040 * This is basically an unrolled
1041 * tryAMAGICbin_MG(concat_amg, AMGf_assign);
1043 * Perl_try_amagic_bin()
1044 * call, but using left and right rather than SP[-1], SP[0],
1045 * and not relying on OPf_STACKED implying .=
1048 if ((SvFLAGS(left)|SvFLAGS(right)) & (SVf_ROK|SVs_GMG)) {
1053 if ((SvAMAGIC(left) || SvAMAGIC(right))
1054 /* sprintf doesn't do concat overloading,
1055 * but allow for $x .= sprintf(...)
1057 && ( !(PL_op->op_private & OPpMULTICONCAT_FAKE)
1061 SV * const tmpsv = amagic_call(left, right, concat_amg,
1062 (nextappend ? AMGf_assign: 0));
1064 /* NB: tryAMAGICbin_MG() includes an OPpTARGET_MY test
1065 * here, which isn't needed as any implicit
1066 * assign done under OPpTARGET_MY is done after
1069 sv_setsv(left, tmpsv);
1078 /* if both args are the same magical value, make one a copy */
1079 if (left == right && SvGMAGICAL(left)) {
1080 left = sv_newmortal();
1081 /* Print the uninitialized warning now, so it includes the
1084 if (ckWARN(WARN_UNINITIALIZED))
1085 report_uninit(right);
1086 sv_setsv_flags(left, &PL_sv_no, 0);
1089 sv_setsv_flags(left, right, 0);
1094 /* nexttarg = left . right */
1095 S_do_concat(aTHX_ left, right, nexttarg, 0);
1099 SP = toparg - stack_adj + 1;
1101 /* Return the result of all RHS concats, unless this op includes
1102 * an assign ($lex = x.y.z or expr = x.y.z), in which case copy
1103 * to target (which will be $lex or expr).
1104 * If we are appending, targ will already have been appended to in
1107 && ( (PL_op->op_flags & OPf_STACKED)
1108 || (PL_op->op_private & OPpTARGET_MY))
1110 sv_setsv(targ, left);
1121 /* push the elements of av onto the stack.
1122 * Returns PL_op->op_next to allow tail-call optimisation of its callers */
1125 S_pushav(pTHX_ AV* const av)
1128 const SSize_t maxarg = AvFILL(av) + 1;
1130 if (UNLIKELY(SvRMAGICAL(av))) {
1132 for (i=0; i < (PADOFFSET)maxarg; i++) {
1133 SV ** const svp = av_fetch(av, i, FALSE);
1134 SP[i+1] = LIKELY(svp)
1136 : UNLIKELY(PL_op->op_flags & OPf_MOD)
1143 for (i=0; i < (PADOFFSET)maxarg; i++) {
1144 SV *sv = AvARRAY(av)[i];
1145 SP[i+1] = LIKELY(sv)
1147 : UNLIKELY(PL_op->op_flags & OPf_MOD)
1158 /* ($lex1,@lex2,...) or my ($lex1,@lex2,...) */
1163 PADOFFSET base = PL_op->op_targ;
1164 int count = (int)(PL_op->op_private) & OPpPADRANGE_COUNTMASK;
1165 if (PL_op->op_flags & OPf_SPECIAL) {
1166 /* fake the RHS of my ($x,$y,..) = @_ */
1168 (void)S_pushav(aTHX_ GvAVn(PL_defgv));
1172 /* note, this is only skipped for compile-time-known void cxt */
1173 if ((PL_op->op_flags & OPf_WANT) != OPf_WANT_VOID) {
1178 for (i = 0; i <count; i++)
1179 *++SP = PAD_SV(base+i);
1181 if (PL_op->op_private & OPpLVAL_INTRO) {
1182 SV **svp = &(PAD_SVl(base));
1183 const UV payload = (UV)(
1184 (base << (OPpPADRANGE_COUNTSHIFT + SAVE_TIGHT_SHIFT))
1185 | (count << SAVE_TIGHT_SHIFT)
1186 | SAVEt_CLEARPADRANGE);
1189 STATIC_ASSERT_STMT(OPpPADRANGE_COUNTMASK + 1 == (1 << OPpPADRANGE_COUNTSHIFT));
1190 assert((payload >> (OPpPADRANGE_COUNTSHIFT+SAVE_TIGHT_SHIFT))
1198 for (i = 0; i <count; i++)
1199 SvPADSTALE_off(*svp++); /* mark lexical as active */
1210 OP * const op = PL_op;
1211 /* access PL_curpad once */
1212 SV ** const padentry = &(PAD_SVl(op->op_targ));
1217 PUTBACK; /* no pop/push after this, TOPs ok */
1219 if (op->op_flags & OPf_MOD) {
1220 if (op->op_private & OPpLVAL_INTRO)
1221 if (!(op->op_private & OPpPAD_STATE))
1222 save_clearsv(padentry);
1223 if (op->op_private & OPpDEREF) {
1224 /* TOPs is equivalent to TARG here. Using TOPs (SP) rather
1225 than TARG reduces the scope of TARG, so it does not
1226 span the call to save_clearsv, resulting in smaller
1228 TOPs = vivify_ref(TOPs, op->op_private & OPpDEREF);
1238 /* pp_coreargs pushes a NULL to indicate no args passed to
1239 * CORE::readline() */
1242 tryAMAGICunTARGETlist(iter_amg, 0);
1243 PL_last_in_gv = MUTABLE_GV(*PL_stack_sp--);
1245 else PL_last_in_gv = PL_argvgv, PL_stack_sp--;
1246 if (!isGV_with_GP(PL_last_in_gv)) {
1247 if (SvROK(PL_last_in_gv) && isGV_with_GP(SvRV(PL_last_in_gv)))
1248 PL_last_in_gv = MUTABLE_GV(SvRV(PL_last_in_gv));
1251 XPUSHs(MUTABLE_SV(PL_last_in_gv));
1253 Perl_pp_rv2gv(aTHX);
1254 PL_last_in_gv = MUTABLE_GV(*PL_stack_sp--);
1255 assert((SV*)PL_last_in_gv == &PL_sv_undef || isGV_with_GP(PL_last_in_gv));
1258 return do_readline();
1265 U32 flags_and, flags_or;
1267 tryAMAGICbin_MG(eq_amg, AMGf_numeric);
1270 flags_and = SvFLAGS(left) & SvFLAGS(right);
1271 flags_or = SvFLAGS(left) | SvFLAGS(right);
1274 ( (flags_and & SVf_IOK) && ((flags_or & SVf_IVisUV) ==0 ) )
1275 ? (SvIVX(left) == SvIVX(right))
1276 : (flags_and & SVf_NOK)
1277 ? (SvNVX(left) == SvNVX(right))
1278 : ( do_ncmp(left, right) == 0)
1284 /* also used for: pp_i_preinc() */
1288 SV *sv = *PL_stack_sp;
1290 if (LIKELY(((sv->sv_flags &
1291 (SVf_THINKFIRST|SVs_GMG|SVf_IVisUV|
1292 SVf_IOK|SVf_NOK|SVf_POK|SVp_NOK|SVp_POK|SVf_ROK))
1294 && SvIVX(sv) != IV_MAX)
1296 SvIV_set(sv, SvIVX(sv) + 1);
1298 else /* Do all the PERL_PRESERVE_IVUV and hard cases in sv_inc */
1305 /* also used for: pp_i_predec() */
1309 SV *sv = *PL_stack_sp;
1311 if (LIKELY(((sv->sv_flags &
1312 (SVf_THINKFIRST|SVs_GMG|SVf_IVisUV|
1313 SVf_IOK|SVf_NOK|SVf_POK|SVp_NOK|SVp_POK|SVf_ROK))
1315 && SvIVX(sv) != IV_MIN)
1317 SvIV_set(sv, SvIVX(sv) - 1);
1319 else /* Do all the PERL_PRESERVE_IVUV and hard cases in sv_dec */
1326 /* also used for: pp_orassign() */
1337 if (PL_op->op_type == OP_OR)
1339 RETURNOP(cLOGOP->op_other);
1344 /* also used for: pp_dor() pp_dorassign() */
1351 const int op_type = PL_op->op_type;
1352 const bool is_dor = (op_type == OP_DOR || op_type == OP_DORASSIGN);
1357 if (UNLIKELY(!sv || !SvANY(sv))) {
1358 if (op_type == OP_DOR)
1360 RETURNOP(cLOGOP->op_other);
1366 if (UNLIKELY(!sv || !SvANY(sv)))
1371 switch (SvTYPE(sv)) {
1373 if (AvMAX(sv) >= 0 || SvGMAGICAL(sv) || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
1377 if (HvARRAY(sv) || SvGMAGICAL(sv) || (SvRMAGICAL(sv) && mg_find(sv, PERL_MAGIC_tied)))
1381 if (CvROOT(sv) || CvXSUB(sv))
1394 if(op_type == OP_DOR)
1396 RETURNOP(cLOGOP->op_other);
1398 /* assuming OP_DEFINED */
1408 dSP; dATARGET; bool useleft; SV *svl, *svr;
1410 tryAMAGICbin_MG(add_amg, AMGf_assign|AMGf_numeric);
1414 #ifdef PERL_PRESERVE_IVUV
1416 /* special-case some simple common cases */
1417 if (!((svl->sv_flags|svr->sv_flags) & (SVf_IVisUV|SVs_GMG))) {
1419 U32 flags = (svl->sv_flags & svr->sv_flags);
1420 if (flags & SVf_IOK) {
1421 /* both args are simple IVs */
1426 topl = ((UV)il) >> (UVSIZE * 8 - 2);
1427 topr = ((UV)ir) >> (UVSIZE * 8 - 2);
1429 /* if both are in a range that can't under/overflow, do a
1430 * simple integer add: if the top of both numbers
1431 * are 00 or 11, then it's safe */
1432 if (!( ((topl+1) | (topr+1)) & 2)) {
1434 TARGi(il + ir, 0); /* args not GMG, so can't be tainted */
1440 else if (flags & SVf_NOK) {
1441 /* both args are NVs */
1445 if (lossless_NV_to_IV(nl, &il) && lossless_NV_to_IV(nr, &ir)) {
1446 /* nothing was lost by converting to IVs */
1450 TARGn(nl + nr, 0); /* args not GMG, so can't be tainted */
1458 useleft = USE_LEFT(svl);
1459 /* We must see if we can perform the addition with integers if possible,
1460 as the integer code detects overflow while the NV code doesn't.
1461 If either argument hasn't had a numeric conversion yet attempt to get
1462 the IV. It's important to do this now, rather than just assuming that
1463 it's not IOK as a PV of "9223372036854775806" may not take well to NV
1464 addition, and an SV which is NOK, NV=6.0 ought to be coerced to
1465 integer in case the second argument is IV=9223372036854775806
1466 We can (now) rely on sv_2iv to do the right thing, only setting the
1467 public IOK flag if the value in the NV (or PV) slot is truly integer.
1469 A side effect is that this also aggressively prefers integer maths over
1470 fp maths for integer values.
1472 How to detect overflow?
1474 C 99 section 6.2.6.1 says
1476 The range of nonnegative values of a signed integer type is a subrange
1477 of the corresponding unsigned integer type, and the representation of
1478 the same value in each type is the same. A computation involving
1479 unsigned operands can never overflow, because a result that cannot be
1480 represented by the resulting unsigned integer type is reduced modulo
1481 the number that is one greater than the largest value that can be
1482 represented by the resulting type.
1486 which I read as "unsigned ints wrap."
1488 signed integer overflow seems to be classed as "exception condition"
1490 If an exceptional condition occurs during the evaluation of an
1491 expression (that is, if the result is not mathematically defined or not
1492 in the range of representable values for its type), the behavior is
1495 (6.5, the 5th paragraph)
1497 I had assumed that on 2s complement machines signed arithmetic would
1498 wrap, hence coded pp_add and pp_subtract on the assumption that
1499 everything perl builds on would be happy. After much wailing and
1500 gnashing of teeth it would seem that irix64 knows its ANSI spec well,
1501 knows that it doesn't need to, and doesn't. Bah. Anyway, the all-
1502 unsigned code below is actually shorter than the old code. :-)
1505 if (SvIV_please_nomg(svr)) {
1506 /* Unless the left argument is integer in range we are going to have to
1507 use NV maths. Hence only attempt to coerce the right argument if
1508 we know the left is integer. */
1515 a_valid = auvok = 1;
1516 /* left operand is undef, treat as zero. + 0 is identity,
1517 Could SETi or SETu right now, but space optimise by not adding
1518 lots of code to speed up what is probably a rarish case. */
1520 /* Left operand is defined, so is it IV? */
1521 if (SvIV_please_nomg(svl)) {
1522 if ((auvok = SvUOK(svl)))
1525 const IV aiv = SvIVX(svl);
1528 auvok = 1; /* Now acting as a sign flag. */
1530 /* Using 0- here and later to silence bogus warning
1532 auv = (UV) (0 - (UV) aiv);
1539 bool result_good = 0;
1542 bool buvok = SvUOK(svr);
1547 const IV biv = SvIVX(svr);
1552 buv = (UV) (0 - (UV) biv);
1554 /* ?uvok if value is >= 0. basically, flagged as UV if it's +ve,
1555 else "IV" now, independent of how it came in.
1556 if a, b represents positive, A, B negative, a maps to -A etc
1561 all UV maths. negate result if A negative.
1562 add if signs same, subtract if signs differ. */
1564 if (auvok ^ buvok) {
1568 /* Must get smaller */
1573 if (result <= buv) {
1574 /* result really should be -(auv-buv). as its negation
1575 of true value, need to swap our result flag */
1592 if (result <= (UV)IV_MIN)
1593 SETi(result == (UV)IV_MIN
1594 ? IV_MIN : -(IV)result);
1596 /* result valid, but out of range for IV. */
1597 SETn( -(NV)result );
1601 } /* Overflow, drop through to NVs. */
1606 useleft = USE_LEFT(svl);
1610 NV value = SvNV_nomg(svr);
1613 /* left operand is undef, treat as zero. + 0.0 is identity. */
1617 SETn( value + SvNV_nomg(svl) );
1623 /* also used for: pp_aelemfast_lex() */
1628 AV * const av = PL_op->op_type == OP_AELEMFAST_LEX
1629 ? MUTABLE_AV(PAD_SV(PL_op->op_targ)) : GvAVn(cGVOP_gv);
1630 const U32 lval = PL_op->op_flags & OPf_MOD;
1631 const I8 key = (I8)PL_op->op_private;
1635 assert(SvTYPE(av) == SVt_PVAV);
1639 /* inlined av_fetch() for simple cases ... */
1640 if (!SvRMAGICAL(av) && key >= 0 && key <= AvFILLp(av)) {
1641 sv = AvARRAY(av)[key];
1648 /* ... else do it the hard way */
1649 svp = av_fetch(av, key, lval);
1650 sv = (svp ? *svp : &PL_sv_undef);
1652 if (UNLIKELY(!svp && lval))
1653 DIE(aTHX_ PL_no_aelem, (int)key);
1655 if (!lval && SvRMAGICAL(av) && SvGMAGICAL(sv)) /* see note in pp_helem() */
1663 dSP; dMARK; dTARGET;
1665 do_join(TARG, *MARK, MARK, SP);
1671 /* Oversized hot code. */
1673 /* also used for: pp_say() */
1677 dSP; dMARK; dORIGMARK;
1681 = (PL_op->op_flags & OPf_STACKED) ? MUTABLE_GV(*++MARK) : PL_defoutgv;
1685 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1688 if (MARK == ORIGMARK) {
1689 /* If using default handle then we need to make space to
1690 * pass object as 1st arg, so move other args up ...
1694 Move(MARK, MARK + 1, (SP - MARK) + 1, SV*);
1697 return Perl_tied_method(aTHX_ SV_CONST(PRINT), mark - 1, MUTABLE_SV(io),
1699 (G_SCALAR | TIED_METHOD_ARGUMENTS_ON_STACK
1700 | (PL_op->op_type == OP_SAY
1701 ? TIED_METHOD_SAY : 0)), sp - mark);
1704 if ( gv && GvEGVx(gv) && (io = GvIO(GvEGV(gv)))
1705 && (mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar)))
1708 SETERRNO(EBADF,RMS_IFI);
1711 else if (!(fp = IoOFP(io))) {
1713 report_wrongway_fh(gv, '<');
1716 SETERRNO(EBADF,IoIFP(io)?RMS_FAC:RMS_IFI);
1720 SV * const ofs = GvSV(PL_ofsgv); /* $, */
1722 if (ofs && (SvGMAGICAL(ofs) || SvOK(ofs))) {
1723 while (MARK <= SP) {
1724 if (!do_print(*MARK, fp))
1728 /* don't use 'ofs' here - it may be invalidated by magic callbacks */
1729 if (!do_print(GvSV(PL_ofsgv), fp)) {
1737 while (MARK <= SP) {
1738 if (!do_print(*MARK, fp))
1746 if (PL_op->op_type == OP_SAY) {
1747 if (PerlIO_write(fp, "\n", 1) == 0 || PerlIO_error(fp))
1750 else if (PL_ors_sv && SvOK(PL_ors_sv))
1751 if (!do_print(PL_ors_sv, fp)) /* $\ */
1754 if (IoFLAGS(io) & IOf_FLUSH)
1755 if (PerlIO_flush(fp) == EOF)
1765 XPUSHs(&PL_sv_undef);
1770 /* do the common parts of pp_padhv() and pp_rv2hv()
1771 * It assumes the caller has done EXTEND(SP, 1) or equivalent.
1772 * 'is_keys' indicates the OPpPADHV_ISKEYS/OPpRV2HV_ISKEYS flag is set.
1773 * 'has_targ' indicates that the op has a target - this should
1774 * be a compile-time constant so that the code can constant-folded as
1778 PERL_STATIC_INLINE OP*
1779 S_padhv_rv2hv_common(pTHX_ HV *hv, U8 gimme, bool is_keys, bool has_targ)
1788 assert(PL_op->op_type == OP_PADHV || PL_op->op_type == OP_RV2HV);
1790 if (gimme == G_ARRAY) {
1796 /* 'keys %h' masquerading as '%h': reset iterator */
1797 (void)hv_iterinit(hv);
1799 if (gimme == G_VOID)
1802 is_bool = ( PL_op->op_private & OPpTRUEBOOL
1803 || ( PL_op->op_private & OPpMAYBE_TRUEBOOL
1804 && block_gimme() == G_VOID));
1805 is_tied = SvRMAGICAL(hv) && (mg = mg_find(MUTABLE_SV(hv), PERL_MAGIC_tied));
1807 if (UNLIKELY(is_tied)) {
1808 if (is_keys && !is_bool) {
1810 while (hv_iternext(hv))
1815 sv = magic_scalarpack(hv, mg);
1822 sv = i ? &PL_sv_yes : &PL_sv_zero;
1834 /* parent op should be an unused OP_KEYS whose targ we can
1839 assert(!OpHAS_SIBLING(PL_op));
1840 k = PL_op->op_sibparent;
1841 assert(k->op_type == OP_KEYS);
1842 TARG = PAD_SV(k->op_targ);
1855 /* This is also called directly by pp_lvavref. */
1860 assert(SvTYPE(TARG) == SVt_PVAV);
1861 if (UNLIKELY( PL_op->op_private & OPpLVAL_INTRO ))
1862 if (LIKELY( !(PL_op->op_private & OPpPAD_STATE) ))
1863 SAVECLEARSV(PAD_SVl(PL_op->op_targ));
1866 if (PL_op->op_flags & OPf_REF) {
1870 else if (PL_op->op_private & OPpMAYBE_LVSUB) {
1871 const I32 flags = is_lvalue_sub();
1872 if (flags && !(flags & OPpENTERSUB_INARGS)) {
1873 if (GIMME_V == G_SCALAR)
1874 /* diag_listed_as: Can't return %s to lvalue scalar context */
1875 Perl_croak(aTHX_ "Can't return array to lvalue scalar context");
1882 if (gimme == G_ARRAY)
1883 return S_pushav(aTHX_ (AV*)TARG);
1885 if (gimme == G_SCALAR) {
1886 const SSize_t maxarg = AvFILL(MUTABLE_AV(TARG)) + 1;
1889 else if (PL_op->op_private & OPpTRUEBOOL)
1903 assert(SvTYPE(TARG) == SVt_PVHV);
1904 if (UNLIKELY( PL_op->op_private & OPpLVAL_INTRO ))
1905 if (LIKELY( !(PL_op->op_private & OPpPAD_STATE) ))
1906 SAVECLEARSV(PAD_SVl(PL_op->op_targ));
1910 if (PL_op->op_flags & OPf_REF) {
1914 else if (PL_op->op_private & OPpMAYBE_LVSUB) {
1915 const I32 flags = is_lvalue_sub();
1916 if (flags && !(flags & OPpENTERSUB_INARGS)) {
1917 if (GIMME_V == G_SCALAR)
1918 /* diag_listed_as: Can't return %s to lvalue scalar context */
1919 Perl_croak(aTHX_ "Can't return hash to lvalue scalar context");
1927 return S_padhv_rv2hv_common(aTHX_ (HV*)TARG, gimme,
1928 cBOOL(PL_op->op_private & OPpPADHV_ISKEYS),
1933 /* also used for: pp_rv2hv() */
1934 /* also called directly by pp_lvavref */
1939 const U8 gimme = GIMME_V;
1940 static const char an_array[] = "an ARRAY";
1941 static const char a_hash[] = "a HASH";
1942 const bool is_pp_rv2av = PL_op->op_type == OP_RV2AV
1943 || PL_op->op_type == OP_LVAVREF;
1944 const svtype type = is_pp_rv2av ? SVt_PVAV : SVt_PVHV;
1948 if (UNLIKELY(SvAMAGIC(sv))) {
1949 sv = amagic_deref_call(sv, is_pp_rv2av ? to_av_amg : to_hv_amg);
1952 if (UNLIKELY(SvTYPE(sv) != type))
1953 /* diag_listed_as: Not an ARRAY reference */
1954 DIE(aTHX_ "Not %s reference", is_pp_rv2av ? an_array : a_hash);
1955 else if (UNLIKELY(PL_op->op_flags & OPf_MOD
1956 && PL_op->op_private & OPpLVAL_INTRO))
1957 Perl_croak(aTHX_ "%s", PL_no_localize_ref);
1959 else if (UNLIKELY(SvTYPE(sv) != type)) {
1962 if (!isGV_with_GP(sv)) {
1963 gv = Perl_softref2xv(aTHX_ sv, is_pp_rv2av ? an_array : a_hash,
1969 gv = MUTABLE_GV(sv);
1971 sv = is_pp_rv2av ? MUTABLE_SV(GvAVn(gv)) : MUTABLE_SV(GvHVn(gv));
1972 if (PL_op->op_private & OPpLVAL_INTRO)
1973 sv = is_pp_rv2av ? MUTABLE_SV(save_ary(gv)) : MUTABLE_SV(save_hash(gv));
1975 if (PL_op->op_flags & OPf_REF) {
1979 else if (UNLIKELY(PL_op->op_private & OPpMAYBE_LVSUB)) {
1980 const I32 flags = is_lvalue_sub();
1981 if (flags && !(flags & OPpENTERSUB_INARGS)) {
1982 if (gimme != G_ARRAY)
1983 goto croak_cant_return;
1990 AV *const av = MUTABLE_AV(sv);
1992 if (gimme == G_ARRAY) {
1995 return S_pushav(aTHX_ av);
1998 if (gimme == G_SCALAR) {
1999 const SSize_t maxarg = AvFILL(av) + 1;
2000 if (PL_op->op_private & OPpTRUEBOOL)
2001 SETs(maxarg ? &PL_sv_yes : &PL_sv_zero);
2010 return S_padhv_rv2hv_common(aTHX_ (HV*)sv, gimme,
2011 cBOOL(PL_op->op_private & OPpRV2HV_ISKEYS),
2017 Perl_croak(aTHX_ "Can't return %s to lvalue scalar context",
2018 is_pp_rv2av ? "array" : "hash");
2023 S_do_oddball(pTHX_ SV **oddkey, SV **firstkey)
2025 PERL_ARGS_ASSERT_DO_ODDBALL;
2028 if (ckWARN(WARN_MISC)) {
2030 if (oddkey == firstkey &&
2032 (SvTYPE(SvRV(*oddkey)) == SVt_PVAV ||
2033 SvTYPE(SvRV(*oddkey)) == SVt_PVHV))
2035 err = "Reference found where even-sized list expected";
2038 err = "Odd number of elements in hash assignment";
2039 Perl_warner(aTHX_ packWARN(WARN_MISC), "%s", err);
2046 /* Do a mark and sweep with the SVf_BREAK flag to detect elements which
2047 * are common to both the LHS and RHS of an aassign, and replace them
2048 * with copies. All these copies are made before the actual list assign is
2051 * For example in ($a,$b) = ($b,$a), assigning the value of the first RHS
2052 * element ($b) to the first LH element ($a), modifies $a; when the
2053 * second assignment is done, the second RH element now has the wrong
2054 * value. So we initially replace the RHS with ($b, mortalcopy($a)).
2055 * Note that we don't need to make a mortal copy of $b.
2057 * The algorithm below works by, for every RHS element, mark the
2058 * corresponding LHS target element with SVf_BREAK. Then if the RHS
2059 * element is found with SVf_BREAK set, it means it would have been
2060 * modified, so make a copy.
2061 * Note that by scanning both LHS and RHS in lockstep, we avoid
2062 * unnecessary copies (like $b above) compared with a naive
2063 * "mark all LHS; copy all marked RHS; unmark all LHS".
2065 * If the LHS element is a 'my' declaration' and has a refcount of 1, then
2066 * it can't be common and can be skipped.
2068 * On DEBUGGING builds it takes an extra boolean, fake. If true, it means
2069 * that we thought we didn't need to call S_aassign_copy_common(), but we
2070 * have anyway for sanity checking. If we find we need to copy, then panic.
2073 PERL_STATIC_INLINE void
2074 S_aassign_copy_common(pTHX_ SV **firstlelem, SV **lastlelem,
2075 SV **firstrelem, SV **lastrelem
2083 SSize_t lcount = lastlelem - firstlelem + 1;
2084 bool marked = FALSE; /* have we marked any LHS with SVf_BREAK ? */
2085 bool const do_rc1 = cBOOL(PL_op->op_private & OPpASSIGN_COMMON_RC1);
2086 bool copy_all = FALSE;
2088 assert(!PL_in_clean_all); /* SVf_BREAK not already in use */
2089 assert(firstlelem < lastlelem); /* at least 2 LH elements */
2090 assert(firstrelem < lastrelem); /* at least 2 RH elements */
2094 /* we never have to copy the first RH element; it can't be corrupted
2095 * by assigning something to the corresponding first LH element.
2096 * So this scan does in a loop: mark LHS[N]; test RHS[N+1]
2098 relem = firstrelem + 1;
2100 for (; relem <= lastrelem; relem++) {
2103 /* mark next LH element */
2105 if (--lcount >= 0) {
2108 if (UNLIKELY(!svl)) {/* skip AV alias marker */
2109 assert (lelem <= lastlelem);
2115 if (SvSMAGICAL(svl)) {
2118 if (SvTYPE(svl) == SVt_PVAV || SvTYPE(svl) == SVt_PVHV) {
2121 /* this LH element will consume all further args;
2122 * no need to mark any further LH elements (if any).
2123 * But we still need to scan any remaining RHS elements;
2124 * set lcount negative to distinguish from lcount == 0,
2125 * so the loop condition continues being true
2128 lelem--; /* no need to unmark this element */
2130 else if (!(do_rc1 && SvREFCNT(svl) == 1) && !SvIMMORTAL(svl)) {
2131 SvFLAGS(svl) |= SVf_BREAK;
2135 /* don't check RH element if no SVf_BREAK flags set yet */
2142 /* see if corresponding RH element needs copying */
2148 if (UNLIKELY(SvFLAGS(svr) & (SVf_BREAK|SVs_GMG) || copy_all)) {
2149 U32 brk = (SvFLAGS(svr) & SVf_BREAK);
2153 /* op_dump(PL_op); */
2155 "panic: aassign skipped needed copy of common RH elem %"
2156 UVuf, (UV)(relem - firstrelem));
2160 TAINT_NOT; /* Each item is independent */
2162 /* Dear TODO test in t/op/sort.t, I love you.
2163 (It's relying on a panic, not a "semi-panic" from newSVsv()
2164 and then an assertion failure below.) */
2165 if (UNLIKELY(SvIS_FREED(svr))) {
2166 Perl_croak(aTHX_ "panic: attempt to copy freed scalar %p",
2169 /* avoid break flag while copying; otherwise COW etc
2171 SvFLAGS(svr) &= ~SVf_BREAK;
2172 /* Not newSVsv(), as it does not allow copy-on-write,
2173 resulting in wasteful copies.
2174 Also, we use SV_NOSTEAL in case the SV is used more than
2175 once, e.g. (...) = (f())[0,0]
2176 Where the same SV appears twice on the RHS without a ref
2177 count bump. (Although I suspect that the SV won't be
2178 stealable here anyway - DAPM).
2180 *relem = sv_mortalcopy_flags(svr,
2181 SV_GMAGIC|SV_DO_COW_SVSETSV|SV_NOSTEAL);
2182 /* ... but restore afterwards in case it's needed again,
2183 * e.g. ($a,$b,$c) = (1,$a,$a)
2185 SvFLAGS(svr) |= brk;
2197 while (lelem > firstlelem) {
2198 SV * const svl = *(--lelem);
2200 SvFLAGS(svl) &= ~SVf_BREAK;
2209 SV **lastlelem = PL_stack_sp;
2210 SV **lastrelem = PL_stack_base + POPMARK;
2211 SV **firstrelem = PL_stack_base + POPMARK + 1;
2212 SV **firstlelem = lastrelem + 1;
2217 /* PL_delaymagic is restored by JUMPENV_POP on dieing, so we
2218 * only need to save locally, not on the save stack */
2219 U16 old_delaymagic = PL_delaymagic;
2224 PL_delaymagic = DM_DELAY; /* catch simultaneous items */
2226 /* If there's a common identifier on both sides we have to take
2227 * special care that assigning the identifier on the left doesn't
2228 * clobber a value on the right that's used later in the list.
2231 /* at least 2 LH and RH elements, or commonality isn't an issue */
2232 if (firstlelem < lastlelem && firstrelem < lastrelem) {
2233 for (relem = firstrelem+1; relem <= lastrelem; relem++) {
2234 if (SvGMAGICAL(*relem))
2237 for (lelem = firstlelem; lelem <= lastlelem; lelem++) {
2238 if (*lelem && SvSMAGICAL(*lelem))
2241 if ( PL_op->op_private & (OPpASSIGN_COMMON_SCALAR|OPpASSIGN_COMMON_RC1) ) {
2242 if (PL_op->op_private & OPpASSIGN_COMMON_RC1) {
2243 /* skip the scan if all scalars have a ref count of 1 */
2244 for (lelem = firstlelem; lelem <= lastlelem; lelem++) {
2246 if (!sv || SvREFCNT(sv) == 1)
2248 if (SvTYPE(sv) != SVt_PVAV && SvTYPE(sv) != SVt_PVAV)
2255 S_aassign_copy_common(aTHX_
2256 firstlelem, lastlelem, firstrelem, lastrelem
2266 /* on debugging builds, do the scan even if we've concluded we
2267 * don't need to, then panic if we find commonality. Note that the
2268 * scanner assumes at least 2 elements */
2269 if (firstlelem < lastlelem && firstrelem < lastrelem) {
2280 if (relem > lastrelem)
2283 /* first lelem loop while there are still relems */
2284 while (LIKELY(lelem <= lastlelem)) {
2288 TAINT_NOT; /* Each item stands on its own, taintwise. */
2290 assert(relem <= lastrelem);
2291 if (UNLIKELY(!lsv)) {
2294 ASSUME(SvTYPE(lsv) == SVt_PVAV);
2297 switch (SvTYPE(lsv)) {
2302 SSize_t nelems = lastrelem - relem + 1;
2303 AV *ary = MUTABLE_AV(lsv);
2305 /* Assigning to an aggregate is tricky. First there is the
2306 * issue of commonality, e.g. @a = ($a[0]). Since the
2307 * stack isn't refcounted, clearing @a prior to storing
2308 * elements will free $a[0]. Similarly with
2309 * sub FETCH { $status[$_[1]] } @status = @tied[0,1];
2311 * The way to avoid these issues is to make the copy of each
2312 * SV (and we normally store a *copy* in the array) *before*
2313 * clearing the array. But this has a problem in that
2314 * if the code croaks during copying, the not-yet-stored copies
2315 * could leak. One way to avoid this is to make all the copies
2316 * mortal, but that's quite expensive.
2318 * The current solution to these issues is to use a chunk
2319 * of the tmps stack as a temporary refcounted-stack. SVs
2320 * will be put on there during processing to avoid leaks,
2321 * but will be removed again before the end of this block,
2322 * so free_tmps() is never normally called. Also, the
2323 * sv_refcnt of the SVs doesn't have to be manipulated, since
2324 * the ownership of 1 reference count is transferred directly
2325 * from the tmps stack to the AV when the SV is stored.
2327 * We disarm slots in the temps stack by storing PL_sv_undef
2328 * there: it doesn't matter if that SV's refcount is
2329 * repeatedly decremented during a croak. But usually this is
2330 * only an interim measure. By the end of this code block
2331 * we try where possible to not leave any PL_sv_undef's on the
2332 * tmps stack e.g. by shuffling newer entries down.
2334 * There is one case where we don't copy: non-magical
2335 * SvTEMP(sv)'s with a ref count of 1. The only owner of these
2336 * is on the tmps stack, so its safe to directly steal the SV
2337 * rather than copying. This is common in things like function
2338 * returns, map etc, which all return a list of such SVs.
2340 * Note however something like @a = (f())[0,0], where there is
2341 * a danger of the same SV being shared: this avoided because
2342 * when the SV is stored as $a[0], its ref count gets bumped,
2343 * so the RC==1 test fails and the second element is copied
2346 * We also use one slot in the tmps stack to hold an extra
2347 * ref to the array, to ensure it doesn't get prematurely
2348 * freed. Again, this is removed before the end of this block.
2350 * Note that OPpASSIGN_COMMON_AGG is used to flag a possible
2351 * @a = ($a[0]) case, but the current implementation uses the
2352 * same algorithm regardless, so ignores that flag. (It *is*
2353 * used in the hash branch below, however).
2356 /* Reserve slots for ary, plus the elems we're about to copy,
2357 * then protect ary and temporarily void the remaining slots
2358 * with &PL_sv_undef */
2359 EXTEND_MORTAL(nelems + 1);
2360 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple_NN(ary);
2361 tmps_base = PL_tmps_ix + 1;
2362 for (i = 0; i < nelems; i++)
2363 PL_tmps_stack[tmps_base + i] = &PL_sv_undef;
2364 PL_tmps_ix += nelems;
2366 /* Make a copy of each RHS elem and save on the tmps_stack
2367 * (or pass through where we can optimise away the copy) */
2369 if (UNLIKELY(alias)) {
2370 U32 lval = (gimme == G_ARRAY)
2371 ? (PL_op->op_flags & OPf_MOD || LVRET) : 0;
2372 for (svp = relem; svp <= lastrelem; svp++) {
2377 DIE(aTHX_ "Assigned value is not a reference");
2378 if (SvTYPE(SvRV(rsv)) > SVt_PVLV)
2379 /* diag_listed_as: Assigned value is not %s reference */
2381 "Assigned value is not a SCALAR reference");
2383 *svp = rsv = sv_mortalcopy(rsv);
2384 /* XXX else check for weak refs? */
2385 rsv = SvREFCNT_inc_NN(SvRV(rsv));
2386 assert(tmps_base <= PL_tmps_max);
2387 PL_tmps_stack[tmps_base++] = rsv;
2391 for (svp = relem; svp <= lastrelem; svp++) {
2394 if (SvTEMP(rsv) && !SvGMAGICAL(rsv) && SvREFCNT(rsv) == 1) {
2395 /* can skip the copy */
2396 SvREFCNT_inc_simple_void_NN(rsv);
2401 /* do get before newSV, in case it dies and leaks */
2404 /* see comment in S_aassign_copy_common about
2406 sv_setsv_flags(nsv, rsv,
2407 (SV_DO_COW_SVSETSV|SV_NOSTEAL));
2411 assert(tmps_base <= PL_tmps_max);
2412 PL_tmps_stack[tmps_base++] = rsv;
2416 if (SvRMAGICAL(ary) || AvFILLp(ary) >= 0) /* may be non-empty */
2419 /* store in the array, the SVs that are in the tmps stack */
2421 tmps_base -= nelems;
2423 if (SvMAGICAL(ary) || SvREADONLY(ary) || !AvREAL(ary)) {
2424 /* for arrays we can't cheat with, use the official API */
2425 av_extend(ary, nelems - 1);
2426 for (i = 0; i < nelems; i++) {
2427 SV **svp = &(PL_tmps_stack[tmps_base + i]);
2429 /* A tied store won't take ownership of rsv, so keep
2430 * the 1 refcnt on the tmps stack; otherwise disarm
2431 * the tmps stack entry */
2432 if (av_store(ary, i, rsv))
2433 *svp = &PL_sv_undef;
2434 /* av_store() may have added set magic to rsv */;
2437 /* disarm ary refcount: see comments below about leak */
2438 PL_tmps_stack[tmps_base - 1] = &PL_sv_undef;
2441 /* directly access/set the guts of the AV */
2442 SSize_t fill = nelems - 1;
2443 if (fill > AvMAX(ary))
2444 av_extend_guts(ary, fill, &AvMAX(ary), &AvALLOC(ary),
2446 AvFILLp(ary) = fill;
2447 Copy(&(PL_tmps_stack[tmps_base]), AvARRAY(ary), nelems, SV*);
2448 /* Quietly remove all the SVs from the tmps stack slots,
2449 * since ary has now taken ownership of the refcnt.
2450 * Also remove ary: which will now leak if we die before
2451 * the SvREFCNT_dec_NN(ary) below */
2452 if (UNLIKELY(PL_tmps_ix >= tmps_base + nelems))
2453 Move(&PL_tmps_stack[tmps_base + nelems],
2454 &PL_tmps_stack[tmps_base - 1],
2455 PL_tmps_ix - (tmps_base + nelems) + 1,
2457 PL_tmps_ix -= (nelems + 1);
2460 if (UNLIKELY(PL_delaymagic & DM_ARRAY_ISA))
2461 /* its assumed @ISA set magic can't die and leak ary */
2462 SvSETMAGIC(MUTABLE_SV(ary));
2463 SvREFCNT_dec_NN(ary);
2465 relem = lastrelem + 1;
2469 case SVt_PVHV: { /* normal hash */
2475 SSize_t nelems = lastrelem - relem + 1;
2476 HV *hash = MUTABLE_HV(lsv);
2478 if (UNLIKELY(nelems & 1)) {
2479 do_oddball(lastrelem, relem);
2480 /* we have firstlelem to reuse, it's not needed any more */
2481 *++lastrelem = &PL_sv_undef;
2485 /* See the SVt_PVAV branch above for a long description of
2486 * how the following all works. The main difference for hashes
2487 * is that we treat keys and values separately (and have
2488 * separate loops for them): as for arrays, values are always
2489 * copied (except for the SvTEMP optimisation), since they
2490 * need to be stored in the hash; while keys are only
2491 * processed where they might get prematurely freed or
2494 /* tmps stack slots:
2495 * * reserve a slot for the hash keepalive;
2496 * * reserve slots for the hash values we're about to copy;
2497 * * preallocate for the keys we'll possibly copy or refcount bump
2499 * then protect hash and temporarily void the remaining
2500 * value slots with &PL_sv_undef */
2501 EXTEND_MORTAL(nelems + 1);
2503 /* convert to number of key/value pairs */
2506 PL_tmps_stack[++PL_tmps_ix] = SvREFCNT_inc_simple_NN(hash);
2507 tmps_base = PL_tmps_ix + 1;
2508 for (i = 0; i < nelems; i++)
2509 PL_tmps_stack[tmps_base + i] = &PL_sv_undef;
2510 PL_tmps_ix += nelems;
2512 /* Make a copy of each RHS hash value and save on the tmps_stack
2513 * (or pass through where we can optimise away the copy) */
2515 for (svp = relem + 1; svp <= lastrelem; svp += 2) {
2518 if (SvTEMP(rsv) && !SvGMAGICAL(rsv) && SvREFCNT(rsv) == 1) {
2519 /* can skip the copy */
2520 SvREFCNT_inc_simple_void_NN(rsv);
2525 /* do get before newSV, in case it dies and leaks */
2528 /* see comment in S_aassign_copy_common about
2530 sv_setsv_flags(nsv, rsv,
2531 (SV_DO_COW_SVSETSV|SV_NOSTEAL));
2535 assert(tmps_base <= PL_tmps_max);
2536 PL_tmps_stack[tmps_base++] = rsv;
2538 tmps_base -= nelems;
2541 /* possibly protect keys */
2543 if (UNLIKELY(gimme == G_ARRAY)) {
2545 * @a = ((%h = ($$r, 1)), $r = "x");
2546 * $_++ for %h = (1,2,3,4);
2548 EXTEND_MORTAL(nelems);
2549 for (svp = relem; svp <= lastrelem; svp += 2)
2550 *svp = sv_mortalcopy_flags(*svp,
2551 SV_GMAGIC|SV_DO_COW_SVSETSV|SV_NOSTEAL);
2553 else if (PL_op->op_private & OPpASSIGN_COMMON_AGG) {
2554 /* for possible commonality, e.g.
2556 * avoid premature freeing RHS keys by mortalising
2558 * For a magic element, make a copy so that its magic is
2559 * called *before* the hash is emptied (which may affect
2560 * a tied value for example).
2561 * In theory we should check for magic keys in all
2562 * cases, not just under OPpASSIGN_COMMON_AGG, but in
2563 * practice, !OPpASSIGN_COMMON_AGG implies only
2564 * constants or padtmps on the RHS.
2566 EXTEND_MORTAL(nelems);
2567 for (svp = relem; svp <= lastrelem; svp += 2) {
2569 if (UNLIKELY(SvGMAGICAL(rsv))) {
2571 *svp = sv_mortalcopy_flags(*svp,
2572 SV_GMAGIC|SV_DO_COW_SVSETSV|SV_NOSTEAL);
2573 /* allow other branch to continue pushing
2574 * onto tmps stack without checking each time */
2575 n = (lastrelem - relem) >> 1;
2579 PL_tmps_stack[++PL_tmps_ix] =
2580 SvREFCNT_inc_simple_NN(rsv);
2584 if (SvRMAGICAL(hash) || HvUSEDKEYS(hash))
2587 /* now assign the keys and values to the hash */
2591 if (UNLIKELY(gimme == G_ARRAY)) {
2592 /* @a = (%h = (...)) etc */
2594 SV **topelem = relem;
2596 for (i = 0, svp = relem; svp <= lastrelem; i++, svp++) {
2599 /* remove duplicates from list we return */
2600 if (!hv_exists_ent(hash, key, 0)) {
2601 /* copy key back: possibly to an earlier
2602 * stack location if we encountered dups earlier,
2603 * The values will be updated later
2608 /* A tied store won't take ownership of val, so keep
2609 * the 1 refcnt on the tmps stack; otherwise disarm
2610 * the tmps stack entry */
2611 if (hv_store_ent(hash, key, val, 0))
2612 PL_tmps_stack[tmps_base + i] = &PL_sv_undef;
2615 /* hv_store_ent() may have added set magic to val */;
2618 if (topelem < svp) {
2619 /* at this point we have removed the duplicate key/value
2620 * pairs from the stack, but the remaining values may be
2621 * wrong; i.e. with (a 1 a 2 b 3) on the stack we've removed
2622 * the (a 2), but the stack now probably contains
2623 * (a <freed> b 3), because { hv_save(a,1); hv_save(a,2) }
2624 * obliterates the earlier key. So refresh all values. */
2625 lastrelem = topelem - 1;
2626 while (relem < lastrelem) {
2628 he = hv_fetch_ent(hash, *relem++, 0, 0);
2629 *relem++ = (he ? HeVAL(he) : &PL_sv_undef);
2635 for (i = 0, svp = relem; svp <= lastrelem; i++, svp++) {
2638 if (hv_store_ent(hash, key, val, 0))
2639 PL_tmps_stack[tmps_base + i] = &PL_sv_undef;
2642 /* hv_store_ent() may have added set magic to val */;
2648 /* there are still some 'live' recounts on the tmps stack
2649 * - usually caused by storing into a tied hash. So let
2650 * free_tmps() do the proper but slow job later.
2651 * Just disarm hash refcount: see comments below about leak
2653 PL_tmps_stack[tmps_base - 1] = &PL_sv_undef;
2656 /* Quietly remove all the SVs from the tmps stack slots,
2657 * since hash has now taken ownership of the refcnt.
2658 * Also remove hash: which will now leak if we die before
2659 * the SvREFCNT_dec_NN(hash) below */
2660 if (UNLIKELY(PL_tmps_ix >= tmps_base + nelems))
2661 Move(&PL_tmps_stack[tmps_base + nelems],
2662 &PL_tmps_stack[tmps_base - 1],
2663 PL_tmps_ix - (tmps_base + nelems) + 1,
2665 PL_tmps_ix -= (nelems + 1);
2668 SvREFCNT_dec_NN(hash);
2670 relem = lastrelem + 1;
2675 if (!SvIMMORTAL(lsv)) {
2679 SvTEMP(lsv) && !SvSMAGICAL(lsv) && SvREFCNT(lsv) == 1 &&
2680 (!isGV_with_GP(lsv) || SvFAKE(lsv)) && ckWARN(WARN_MISC)
2683 packWARN(WARN_MISC),
2684 "Useless assignment to a temporary"
2687 /* avoid freeing $$lsv if it might be needed for further
2688 * elements, e.g. ($ref, $foo) = (1, $$ref) */
2690 && ( ((ref = SvRV(lsv)), SvREFCNT(ref)) == 1)
2691 && lelem <= lastlelem
2694 SvREFCNT_inc_simple_void_NN(ref);
2695 /* an unrolled sv_2mortal */
2697 if (UNLIKELY(ix >= PL_tmps_max))
2698 /* speculatively grow enough to cover other
2700 (void)tmps_grow_p(ix + (lastlelem - lelem));
2701 PL_tmps_stack[ix] = ref;
2704 sv_setsv(lsv, *relem);
2708 if (++relem > lastrelem)
2717 /* simplified lelem loop for when there are no relems left */
2718 while (LIKELY(lelem <= lastlelem)) {
2721 TAINT_NOT; /* Each item stands on its own, taintwise. */
2723 if (UNLIKELY(!lsv)) {
2725 ASSUME(SvTYPE(lsv) == SVt_PVAV);
2728 switch (SvTYPE(lsv)) {
2730 if (SvRMAGICAL(lsv) || AvFILLp((SV*)lsv) >= 0) {
2732 if (UNLIKELY(PL_delaymagic & DM_ARRAY_ISA))
2738 if (SvRMAGICAL(lsv) || HvUSEDKEYS((HV*)lsv))
2743 if (!SvIMMORTAL(lsv)) {
2752 TAINT_NOT; /* result of list assign isn't tainted */
2754 if (UNLIKELY(PL_delaymagic & ~DM_DELAY)) {
2755 /* Will be used to set PL_tainting below */
2756 Uid_t tmp_uid = PerlProc_getuid();
2757 Uid_t tmp_euid = PerlProc_geteuid();
2758 Gid_t tmp_gid = PerlProc_getgid();
2759 Gid_t tmp_egid = PerlProc_getegid();
2761 /* XXX $> et al currently silently ignore failures */
2762 if (PL_delaymagic & DM_UID) {
2763 #ifdef HAS_SETRESUID
2765 setresuid((PL_delaymagic & DM_RUID) ? PL_delaymagic_uid : (Uid_t)-1,
2766 (PL_delaymagic & DM_EUID) ? PL_delaymagic_euid : (Uid_t)-1,
2768 #elif defined(HAS_SETREUID)
2770 setreuid((PL_delaymagic & DM_RUID) ? PL_delaymagic_uid : (Uid_t)-1,
2771 (PL_delaymagic & DM_EUID) ? PL_delaymagic_euid : (Uid_t)-1));
2774 if ((PL_delaymagic & DM_UID) == DM_RUID) {
2775 PERL_UNUSED_RESULT(setruid(PL_delaymagic_uid));
2776 PL_delaymagic &= ~DM_RUID;
2778 # endif /* HAS_SETRUID */
2780 if ((PL_delaymagic & DM_UID) == DM_EUID) {
2781 PERL_UNUSED_RESULT(seteuid(PL_delaymagic_euid));
2782 PL_delaymagic &= ~DM_EUID;
2784 # endif /* HAS_SETEUID */
2785 if (PL_delaymagic & DM_UID) {
2786 if (PL_delaymagic_uid != PL_delaymagic_euid)
2787 DIE(aTHX_ "No setreuid available");
2788 PERL_UNUSED_RESULT(PerlProc_setuid(PL_delaymagic_uid));
2790 #endif /* HAS_SETRESUID */
2792 tmp_uid = PerlProc_getuid();
2793 tmp_euid = PerlProc_geteuid();
2795 /* XXX $> et al currently silently ignore failures */
2796 if (PL_delaymagic & DM_GID) {
2797 #ifdef HAS_SETRESGID
2799 setresgid((PL_delaymagic & DM_RGID) ? PL_delaymagic_gid : (Gid_t)-1,
2800 (PL_delaymagic & DM_EGID) ? PL_delaymagic_egid : (Gid_t)-1,
2802 #elif defined(HAS_SETREGID)
2804 setregid((PL_delaymagic & DM_RGID) ? PL_delaymagic_gid : (Gid_t)-1,
2805 (PL_delaymagic & DM_EGID) ? PL_delaymagic_egid : (Gid_t)-1));
2808 if ((PL_delaymagic & DM_GID) == DM_RGID) {
2809 PERL_UNUSED_RESULT(setrgid(PL_delaymagic_gid));
2810 PL_delaymagic &= ~DM_RGID;
2812 # endif /* HAS_SETRGID */
2814 if ((PL_delaymagic & DM_GID) == DM_EGID) {
2815 PERL_UNUSED_RESULT(setegid(PL_delaymagic_egid));
2816 PL_delaymagic &= ~DM_EGID;
2818 # endif /* HAS_SETEGID */
2819 if (PL_delaymagic & DM_GID) {
2820 if (PL_delaymagic_gid != PL_delaymagic_egid)
2821 DIE(aTHX_ "No setregid available");
2822 PERL_UNUSED_RESULT(PerlProc_setgid(PL_delaymagic_gid));
2824 #endif /* HAS_SETRESGID */
2826 tmp_gid = PerlProc_getgid();
2827 tmp_egid = PerlProc_getegid();
2829 TAINTING_set( TAINTING_get | (tmp_uid && (tmp_euid != tmp_uid || tmp_egid != tmp_gid)) );
2830 #ifdef NO_TAINT_SUPPORT
2831 PERL_UNUSED_VAR(tmp_uid);
2832 PERL_UNUSED_VAR(tmp_euid);
2833 PERL_UNUSED_VAR(tmp_gid);
2834 PERL_UNUSED_VAR(tmp_egid);
2837 PL_delaymagic = old_delaymagic;
2839 if (gimme == G_VOID)
2840 SP = firstrelem - 1;
2841 else if (gimme == G_SCALAR) {
2844 if (PL_op->op_private & OPpASSIGN_TRUEBOOL)
2845 SETs((firstlelem - firstrelem) ? &PL_sv_yes : &PL_sv_zero);
2848 SETi(firstlelem - firstrelem);
2860 PMOP * const pm = cPMOP;
2861 REGEXP * rx = PM_GETRE(pm);
2862 regexp *prog = ReANY(rx);
2863 SV * const pkg = RXp_ENGINE(prog)->qr_package(aTHX_ (rx));
2864 SV * const rv = sv_newmortal();
2868 SvUPGRADE(rv, SVt_IV);
2869 /* For a subroutine describing itself as "This is a hacky workaround" I'm
2870 loathe to use it here, but it seems to be the right fix. Or close.
2871 The key part appears to be that it's essential for pp_qr to return a new
2872 object (SV), which implies that there needs to be an effective way to
2873 generate a new SV from the existing SV that is pre-compiled in the
2875 SvRV_set(rv, MUTABLE_SV(reg_temp_copy(NULL, rx)));
2878 cvp = &( ReANY((REGEXP *)SvRV(rv))->qr_anoncv);
2879 if (UNLIKELY((cv = *cvp) && CvCLONE(*cvp))) {
2880 *cvp = cv_clone(cv);
2881 SvREFCNT_dec_NN(cv);
2885 HV *const stash = gv_stashsv(pkg, GV_ADD);
2886 SvREFCNT_dec_NN(pkg);
2887 (void)sv_bless(rv, stash);
2890 if (UNLIKELY(RXp_ISTAINTED(prog))) {
2892 SvTAINTED_on(SvRV(rv));
2899 S_are_we_in_Debug_EXECUTE_r(pTHX)
2901 /* Given a 'use re' is in effect, does it ask for outputting execution
2904 * This is separated from the sole place it's called, an inline function,
2905 * because it is the large-ish slow portion of the function */
2907 DECLARE_AND_GET_RE_DEBUG_FLAGS_NON_REGEX;
2909 return cBOOL(RE_DEBUG_FLAG(RE_DEBUG_EXECUTE_MASK));
2912 PERL_STATIC_INLINE bool
2913 S_should_we_output_Debug_r(pTHX_ regexp *prog)
2915 PERL_ARGS_ASSERT_SHOULD_WE_OUTPUT_DEBUG_R;
2917 /* pp_match can output regex debugging info. This function returns a
2918 * boolean as to whether or not it should.
2920 * Under -Dr, it should. Any reasonable compiler will optimize this bit of
2921 * code away on non-debugging builds. */
2922 if (UNLIKELY(DEBUG_r_TEST)) {
2926 /* If the regex engine is using the non-debugging execution routine, then
2927 * no debugging should be output. Same if the field is NULL that pluggable
2928 * engines are not supposed to fill. */
2929 if ( LIKELY(prog->engine->exec == &Perl_regexec_flags)
2930 || UNLIKELY(prog->engine->op_comp == NULL))
2935 /* Otherwise have to check */
2936 return S_are_we_in_Debug_EXECUTE_r(aTHX);
2946 SSize_t curpos = 0; /* initial pos() or current $+[0] */
2949 const char *truebase; /* Start of string */
2950 REGEXP *rx = PM_GETRE(pm);
2951 regexp *prog = ReANY(rx);
2953 const U8 gimme = GIMME_V;
2955 const I32 oldsave = PL_savestack_ix;
2956 I32 had_zerolen = 0;
2959 if (PL_op->op_flags & OPf_STACKED)
2970 PUTBACK; /* EVAL blocks need stack_sp. */
2971 /* Skip get-magic if this is a qr// clone, because regcomp has
2973 truebase = prog->mother_re
2974 ? SvPV_nomg_const(TARG, len)
2975 : SvPV_const(TARG, len);
2977 DIE(aTHX_ "panic: pp_match");
2978 strend = truebase + len;
2979 rxtainted = (RXp_ISTAINTED(prog) ||
2980 (TAINT_get && (pm->op_pmflags & PMf_RETAINT)));
2983 /* We need to know this in case we fail out early - pos() must be reset */
2984 global = dynpm->op_pmflags & PMf_GLOBAL;
2986 /* PMdf_USED is set after a ?? matches once */
2989 SvREADONLY(PL_regex_pad[pm->op_pmoffset])
2991 pm->op_pmflags & PMf_USED
2994 if (UNLIKELY(should_we_output_Debug_r(prog))) {
2995 PerlIO_printf(Perl_debug_log, "?? already matched once");
3000 /* handle the empty pattern */
3001 if (!RX_PRELEN(rx) && PL_curpm && !prog->mother_re) {
3002 if (PL_curpm == PL_reg_curpm) {
3003 if (PL_curpm_under) {
3004 if (PL_curpm_under == PL_reg_curpm) {
3005 Perl_croak(aTHX_ "Infinite recursion via empty pattern");
3007 pm = PL_curpm_under;
3017 if (RXp_MINLEN(prog) >= 0 && (STRLEN)RXp_MINLEN(prog) > len) {
3018 if (UNLIKELY(should_we_output_Debug_r(prog))) {
3019 PerlIO_printf(Perl_debug_log,
3020 "String shorter than min possible regex match (%zd < %zd)\n",
3021 len, RXp_MINLEN(prog));
3026 /* get pos() if //g */
3028 mg = mg_find_mglob(TARG);
3029 if (mg && mg->mg_len >= 0) {
3030 curpos = MgBYTEPOS(mg, TARG, truebase, len);
3031 /* last time pos() was set, it was zero-length match */
3032 if (mg->mg_flags & MGf_MINMATCH)
3037 #ifdef PERL_SAWAMPERSAND
3038 if ( RXp_NPARENS(prog)
3040 || (RXp_EXTFLAGS(prog) & (RXf_EVAL_SEEN|RXf_PMf_KEEPCOPY))
3041 || (dynpm->op_pmflags & PMf_KEEPCOPY)
3045 r_flags |= (REXEC_COPY_STR|REXEC_COPY_SKIP_PRE);
3046 /* in @a =~ /(.)/g, we iterate multiple times, but copy the buffer
3047 * only on the first iteration. Therefore we need to copy $' as well
3048 * as $&, to make the rest of the string available for captures in
3049 * subsequent iterations */
3050 if (! (global && gimme == G_ARRAY))
3051 r_flags |= REXEC_COPY_SKIP_POST;
3053 #ifdef PERL_SAWAMPERSAND
3054 if (dynpm->op_pmflags & PMf_KEEPCOPY)
3055 /* handle KEEPCOPY in pmop but not rx, eg $r=qr/a/; /$r/p */
3056 r_flags &= ~(REXEC_COPY_SKIP_PRE|REXEC_COPY_SKIP_POST);
3063 s = truebase + curpos;
3065 if (!CALLREGEXEC(rx, (char*)s, (char *)strend, (char*)truebase,
3066 had_zerolen, TARG, NULL, r_flags))
3070 if (dynpm->op_pmflags & PMf_ONCE)
3072 SvREADONLY_on(PL_regex_pad[dynpm->op_pmoffset]);
3074 dynpm->op_pmflags |= PMf_USED;
3078 RXp_MATCH_TAINTED_on(prog);
3079 TAINT_IF(RXp_MATCH_TAINTED(prog));
3083 if (global && (gimme != G_ARRAY || (dynpm->op_pmflags & PMf_CONTINUE))) {
3085 mg = sv_magicext_mglob(TARG);
3086 MgBYTEPOS_set(mg, TARG, truebase, RXp_OFFS(prog)[0].end);
3087 if (RXp_ZERO_LEN(prog))
3088 mg->mg_flags |= MGf_MINMATCH;
3090 mg->mg_flags &= ~MGf_MINMATCH;
3093 if ((!RXp_NPARENS(prog) && !global) || gimme != G_ARRAY) {
3094 LEAVE_SCOPE(oldsave);
3098 /* push captures on stack */
3101 const I32 nparens = RXp_NPARENS(prog);
3102 I32 i = (global && !nparens) ? 1 : 0;
3104 SPAGAIN; /* EVAL blocks could move the stack. */
3105 EXTEND(SP, nparens + i);
3106 EXTEND_MORTAL(nparens + i);
3107 for (i = !i; i <= nparens; i++) {
3108 PUSHs(sv_newmortal());
3109 if (LIKELY((RXp_OFFS(prog)[i].start != -1)
3110 && RXp_OFFS(prog)[i].end != -1 ))
3112 const I32 len = RXp_OFFS(prog)[i].end - RXp_OFFS(prog)[i].start;
3113 const char * const s = RXp_OFFS(prog)[i].start + truebase;
3114 if (UNLIKELY( RXp_OFFS(prog)[i].end < 0
3115 || RXp_OFFS(prog)[i].start < 0
3117 || len > strend - s)
3119 DIE(aTHX_ "panic: pp_match start/end pointers, i=%ld, "
3120 "start=%ld, end=%ld, s=%p, strend=%p, len=%" UVuf,
3121 (long) i, (long) RXp_OFFS(prog)[i].start,
3122 (long)RXp_OFFS(prog)[i].end, s, strend, (UV) len);
3123 sv_setpvn(*SP, s, len);
3124 if (DO_UTF8(TARG) && is_utf8_string((U8*)s, len))
3129 curpos = (UV)RXp_OFFS(prog)[0].end;
3130 had_zerolen = RXp_ZERO_LEN(prog);
3131 PUTBACK; /* EVAL blocks may use stack */
3132 r_flags |= REXEC_IGNOREPOS | REXEC_NOT_FIRST;
3135 LEAVE_SCOPE(oldsave);
3138 NOT_REACHED; /* NOTREACHED */
3141 if (global && !(dynpm->op_pmflags & PMf_CONTINUE)) {
3143 mg = mg_find_mglob(TARG);
3147 LEAVE_SCOPE(oldsave);
3148 if (gimme == G_ARRAY)
3154 Perl_do_readline(pTHX)
3156 dSP; dTARGETSTACKED;
3161 IO * const io = GvIO(PL_last_in_gv);
3162 const I32 type = PL_op->op_type;
3163 const U8 gimme = GIMME_V;
3166 const MAGIC *const mg = SvTIED_mg((const SV *)io, PERL_MAGIC_tiedscalar);
3168 Perl_tied_method(aTHX_ SV_CONST(READLINE), SP, MUTABLE_SV(io), mg, gimme, 0);
3169 if (gimme == G_SCALAR) {
3171 SvSetSV_nosteal(TARG, TOPs);
3181 if (IoFLAGS(io) & IOf_ARGV) {
3182 if (IoFLAGS(io) & IOf_START) {
3184 if (av_count(GvAVn(PL_last_in_gv)) == 0) {
3185 IoFLAGS(io) &= ~IOf_START;
3186 do_open6(PL_last_in_gv, "-", 1, NULL, NULL, 0);
3187 SvTAINTED_off(GvSVn(PL_last_in_gv)); /* previous tainting irrelevant */
3188 sv_setpvs(GvSVn(PL_last_in_gv), "-");
3189 SvSETMAGIC(GvSV(PL_last_in_gv));
3194 fp = nextargv(PL_last_in_gv, PL_op->op_flags & OPf_SPECIAL);
3195 if (!fp) { /* Note: fp != IoIFP(io) */
3196 (void)do_close(PL_last_in_gv, FALSE); /* now it does*/
3199 else if (type == OP_GLOB)
3200 fp = Perl_start_glob(aTHX_ POPs, io);
3202 else if (type == OP_GLOB)
3204 else if (IoTYPE(io) == IoTYPE_WRONLY) {
3205 report_wrongway_fh(PL_last_in_gv, '>');
3209 if ((!io || !(IoFLAGS(io) & IOf_START))
3210 && ckWARN(WARN_CLOSED)
3213 report_evil_fh(PL_last_in_gv);
3215 if (gimme == G_SCALAR) {
3216 /* undef TARG, and push that undefined value */
3217 if (type != OP_RCATLINE) {
3225 if (gimme == G_SCALAR) {
3227 if (type == OP_RCATLINE && SvGMAGICAL(sv))
3230 if (type == OP_RCATLINE)
3231 SvPV_force_nomg_nolen(sv);
3235 else if (isGV_with_GP(sv)) {
3236 SvPV_force_nomg_nolen(sv);
3238 SvUPGRADE(sv, SVt_PV);
3239 tmplen = SvLEN(sv); /* remember if already alloced */
3240 if (!tmplen && !SvREADONLY(sv) && !SvIsCOW(sv)) {
3241 /* try short-buffering it. Please update t/op/readline.t
3242 * if you change the growth length.
3247 if (type == OP_RCATLINE && SvOK(sv)) {
3249 SvPV_force_nomg_nolen(sv);
3255 sv = sv_2mortal(newSV(80));
3259 /* This should not be marked tainted if the fp is marked clean */
3260 #define MAYBE_TAINT_LINE(io, sv) \
3261 if (!(IoFLAGS(io) & IOf_UNTAINT)) { \
3266 /* delay EOF state for a snarfed empty file */
3267 #define SNARF_EOF(gimme,rs,io,sv) \
3268 (gimme != G_SCALAR || SvCUR(sv) \
3269 || (IoFLAGS(io) & IOf_NOLINE) || !RsSNARF(rs))
3273 if (!sv_gets(sv, fp, offset)
3275 || SNARF_EOF(gimme, PL_rs, io, sv)
3276 || PerlIO_error(fp)))
3278 PerlIO_clearerr(fp);
3279 if (IoFLAGS(io) & IOf_ARGV) {
3280 fp = nextargv(PL_last_in_gv, PL_op->op_flags & OPf_SPECIAL);
3283 (void)do_close(PL_last_in_gv, FALSE);
3285 else if (type == OP_GLOB) {
3286 if (!do_close(PL_last_in_gv, FALSE)) {
3287 Perl_ck_warner(aTHX_ packWARN(WARN_GLOB),
3288 "glob failed (child exited with status %d%s)",
3289 (int)(STATUS_CURRENT >> 8),
3290 (STATUS_CURRENT & 0x80) ? ", core dumped" : "");
3293 if (gimme == G_SCALAR) {
3294 if (type != OP_RCATLINE) {
3295 SV_CHECK_THINKFIRST_COW_DROP(TARG);
3301 MAYBE_TAINT_LINE(io, sv);
3304 MAYBE_TAINT_LINE(io, sv);
3306 IoFLAGS(io) |= IOf_NOLINE;
3310 if (type == OP_GLOB) {
3314 if (SvCUR(sv) > 0 && SvCUR(PL_rs) > 0) {
3315 char * const tmps = SvEND(sv) - 1;
3316 if (*tmps == *SvPVX_const(PL_rs)) {
3318 SvCUR_set(sv, SvCUR(sv) - 1);
3321 for (t1 = SvPVX_const(sv); *t1; t1++)
3323 if (memCHRs("*%?", *t1))
3325 if (memCHRs("$&*(){}[]'\";\\|?<>~`", *t1))
3328 if (*t1 && PerlLIO_lstat(SvPVX_const(sv), &statbuf) < 0) {
3329 (void)POPs; /* Unmatched wildcard? Chuck it... */
3332 } else if (SvUTF8(sv)) { /* OP_READLINE, OP_RCATLINE */
3333 if (ckWARN(WARN_UTF8)) {
3334 const U8 * const s = (const U8*)SvPVX_const(sv) + offset;
3335 const STRLEN len = SvCUR(sv) - offset;
3338 if (!is_utf8_string_loc(s, len, &f))
3339 /* Emulate :encoding(utf8) warning in the same case. */
3340 Perl_warner(aTHX_ packWARN(WARN_UTF8),
3341 "utf8 \"\\x%02X\" does not map to Unicode",
3342 f < (U8*)SvEND(sv) ? *f : 0);
3345 if (gimme == G_ARRAY) {
3346 if (SvLEN(sv) - SvCUR(sv) > 20) {
3347 SvPV_shrink_to_cur(sv);
3349 sv = sv_2mortal(newSV(80));
3352 else if (gimme == G_SCALAR && !tmplen && SvLEN(sv) - SvCUR(sv) > 80) {
3353 /* try to reclaim a bit of scalar space (only on 1st alloc) */
3354 const STRLEN new_len
3355 = SvCUR(sv) < 60 ? 80 : SvCUR(sv)+40; /* allow some slop */
3356 SvPV_renew(sv, new_len);
3367 SV * const keysv = POPs;
3368 HV * const hv = MUTABLE_HV(POPs);
3369 const U32 lval = PL_op->op_flags & OPf_MOD || LVRET;
3370 const U32 defer = PL_op->op_private & OPpLVAL_DEFER;
3372 const bool localizing = PL_op->op_private & OPpLVAL_INTRO;
3373 bool preeminent = TRUE;
3375 if (SvTYPE(hv) != SVt_PVHV)
3382 /* If we can determine whether the element exist,
3383 * Try to preserve the existenceness of a tied hash
3384 * element by using EXISTS and DELETE if possible.
3385 * Fallback to FETCH and STORE otherwise. */
3386 if (SvCANEXISTDELETE(hv))
3387 preeminent = hv_exists_ent(hv, keysv, 0);
3390 he = hv_fetch_ent(hv, keysv, lval && !defer, 0);
3391 svp = he ? &HeVAL(he) : NULL;
3393 if (!svp || !*svp || *svp == &PL_sv_undef) {
3397 DIE(aTHX_ PL_no_helem_sv, SVfARG(keysv));
3399 lv = sv_newmortal();
3400 sv_upgrade(lv, SVt_PVLV);
3402 sv_magic(lv, key2 = newSVsv(keysv), PERL_MAGIC_defelem, NULL, 0);
3403 SvREFCNT_dec_NN(key2); /* sv_magic() increments refcount */
3404 LvTARG(lv) = SvREFCNT_inc_simple_NN(hv);
3410 if (HvNAME_get(hv) && isGV_or_RVCV(*svp))
3411 save_gp(MUTABLE_GV(*svp), !(PL_op->op_flags & OPf_SPECIAL));
3412 else if (preeminent)
3413 save_helem_flags(hv, keysv, svp,
3414 (PL_op->op_flags & OPf_SPECIAL) ? 0 : SAVEf_SETMAGIC);
3416 SAVEHDELETE(hv, keysv);
3418 else if (PL_op->op_private & OPpDEREF) {
3419 PUSHs(vivify_ref(*svp, PL_op->op_private & OPpDEREF));
3423 sv = (svp && *svp ? *svp : &PL_sv_undef);
3424 /* Originally this did a conditional C<sv = sv_mortalcopy(sv)>; this
3425 * was to make C<local $tied{foo} = $tied{foo}> possible.
3426 * However, it seems no longer to be needed for that purpose, and
3427 * introduced a new bug: stuff like C<while ($hash{taintedval} =~ /.../g>
3428 * would loop endlessly since the pos magic is getting set on the
3429 * mortal copy and lost. However, the copy has the effect of
3430 * triggering the get magic, and losing it altogether made things like
3431 * c<$tied{foo};> in void context no longer do get magic, which some
3432 * code relied on. Also, delayed triggering of magic on @+ and friends
3433 * meant the original regex may be out of scope by now. So as a
3434 * compromise, do the get magic here. (The MGf_GSKIP flag will stop it
3435 * being called too many times). */
3436 if (!lval && SvRMAGICAL(hv) && SvGMAGICAL(sv))
3443 /* a stripped-down version of Perl_softref2xv() for use by
3444 * pp_multideref(), which doesn't use PL_op->op_flags */
3447 S_softref2xv_lite(pTHX_ SV *const sv, const char *const what,
3450 if (PL_op->op_private & HINT_STRICT_REFS) {
3452 Perl_die(aTHX_ PL_no_symref_sv, sv,
3453 (SvPOKp(sv) && SvCUR(sv)>32 ? "..." : ""), what);
3455 Perl_die(aTHX_ PL_no_usym, what);
3458 Perl_die(aTHX_ PL_no_usym, what);
3459 return gv_fetchsv_nomg(sv, GV_ADD, type);
3463 /* Handle one or more aggregate derefs and array/hash indexings, e.g.
3464 * $h->{foo} or $a[0]{$key}[$i] or f()->[1]
3466 * op_aux points to an array of unions of UV / IV / SV* / PADOFFSET.
3467 * Each of these either contains a set of actions, or an argument, such as
3468 * an IV to use as an array index, or a lexical var to retrieve.
3469 * Several actions re stored per UV; we keep shifting new actions off the
3470 * one UV, and only reload when it becomes zero.
3475 SV *sv = NULL; /* init to avoid spurious 'may be used uninitialized' */
3476 UNOP_AUX_item *items = cUNOP_AUXx(PL_op)->op_aux;
3477 UV actions = items->uv;
3480 /* this tells find_uninit_var() where we're up to */
3481 PL_multideref_pc = items;
3484 /* there are three main classes of action; the first retrieve
3485 * the initial AV or HV from a variable or the stack; the second
3486 * does the equivalent of an unrolled (/DREFAV, rv2av, aelem),
3487 * the third an unrolled (/DREFHV, rv2hv, helem).
3489 switch (actions & MDEREF_ACTION_MASK) {
3492 actions = (++items)->uv;
3495 case MDEREF_AV_padav_aelem: /* $lex[...] */
3496 sv = PAD_SVl((++items)->pad_offset);
3499 case MDEREF_AV_gvav_aelem: /* $pkg[...] */
3500 sv = UNOP_AUX_item_sv(++items);
3501 assert(isGV_with_GP(sv));
3502 sv = (SV*)GvAVn((GV*)sv);
3505 case MDEREF_AV_pop_rv2av_aelem: /* expr->[...] */
3510 goto do_AV_rv2av_aelem;
3513 case MDEREF_AV_gvsv_vivify_rv2av_aelem: /* $pkg->[...] */
3514 sv = UNOP_AUX_item_sv(++items);
3515 assert(isGV_with_GP(sv));
3516 sv = GvSVn((GV*)sv);
3517 goto do_AV_vivify_rv2av_aelem;
3519 case MDEREF_AV_padsv_vivify_rv2av_aelem: /* $lex->[...] */
3520 sv = PAD_SVl((++items)->pad_offset);
3523 do_AV_vivify_rv2av_aelem:
3524 case MDEREF_AV_vivify_rv2av_aelem: /* vivify, ->[...] */
3525 /* this is the OPpDEREF action normally found at the end of
3526 * ops like aelem, helem, rv2sv */
3527 sv = vivify_ref(sv, OPpDEREF_AV);
3531 /* this is basically a copy of pp_rv2av when it just has the
3534 if (LIKELY(SvROK(sv))) {
3535 if (UNLIKELY(SvAMAGIC(sv))) {
3536 sv = amagic_deref_call(sv, to_av_amg);
3539 if (UNLIKELY(SvTYPE(sv) != SVt_PVAV))
3540 DIE(aTHX_ "Not an ARRAY reference");
3542 else if (SvTYPE(sv) != SVt_PVAV) {
3543 if (!isGV_with_GP(sv))
3544 sv = (SV*)S_softref2xv_lite(aTHX_ sv, "an ARRAY", SVt_PVAV);
3545 sv = MUTABLE_SV(GvAVn((GV*)sv));
3551 /* retrieve the key; this may be either a lexical or package
3552 * var (whose index/ptr is stored as an item) or a signed
3553 * integer constant stored as an item.
3556 IV elem = 0; /* to shut up stupid compiler warnings */
3559 assert(SvTYPE(sv) == SVt_PVAV);
3561 switch (actions & MDEREF_INDEX_MASK) {
3562 case MDEREF_INDEX_none:
3564 case MDEREF_INDEX_const:
3565 elem = (++items)->iv;
3567 case MDEREF_INDEX_padsv:
3568 elemsv = PAD_SVl((++items)->pad_offset);
3570 case MDEREF_INDEX_gvsv:
3571 elemsv = UNOP_AUX_item_sv(++items);
3572 assert(isGV_with_GP(elemsv));
3573 elemsv = GvSVn((GV*)elemsv);
3575 if (UNLIKELY(SvROK(elemsv) && !SvGAMAGIC(elemsv)
3576 && ckWARN(WARN_MISC)))
3577 Perl_warner(aTHX_ packWARN(WARN_MISC),
3578 "Use of reference \"%" SVf "\" as array index",
3580 /* the only time that S_find_uninit_var() needs this
3581 * is to determine which index value triggered the
3582 * undef warning. So just update it here. Note that
3583 * since we don't save and restore this var (e.g. for
3584 * tie or overload execution), its value will be
3585 * meaningless apart from just here */
3586 PL_multideref_pc = items;
3587 elem = SvIV(elemsv);
3592 /* this is basically a copy of pp_aelem with OPpDEREF skipped */
3594 if (!(actions & MDEREF_FLAG_last)) {
3595 SV** svp = av_fetch((AV*)sv, elem, 1);
3596 if (!svp || ! (sv=*svp))
3597 DIE(aTHX_ PL_no_aelem, elem);
3601 if (PL_op->op_private &
3602 (OPpMULTIDEREF_EXISTS|OPpMULTIDEREF_DELETE))
3604 if (PL_op->op_private & OPpMULTIDEREF_EXISTS) {
3605 sv = av_exists((AV*)sv, elem) ? &PL_sv_yes : &PL_sv_no;
3608 I32 discard = (GIMME_V == G_VOID) ? G_DISCARD : 0;
3609 sv = av_delete((AV*)sv, elem, discard);
3617 const U32 lval = PL_op->op_flags & OPf_MOD || LVRET;
3618 const U32 defer = PL_op->op_private & OPpLVAL_DEFER;
3619 const bool localizing = PL_op->op_private & OPpLVAL_INTRO;
3620 bool preeminent = TRUE;
3621 AV *const av = (AV*)sv;
3624 if (UNLIKELY(localizing)) {
3628 /* If we can determine whether the element exist,
3629 * Try to preserve the existenceness of a tied array
3630 * element by using EXISTS and DELETE if possible.
3631 * Fallback to FETCH and STORE otherwise. */
3632 if (SvCANEXISTDELETE(av))
3633 preeminent = av_exists(av, elem);
3636 svp = av_fetch(av, elem, lval && !defer);
3639 if (!svp || !(sv = *svp)) {
3642 DIE(aTHX_ PL_no_aelem, elem);
3643 len = av_top_index(av);
3644 /* Resolve a negative index that falls within
3645 * the array. Leave it negative it if falls
3646 * outside the array. */
3647 if (elem < 0 && len + elem >= 0)
3649 if (elem >= 0 && elem <= len)
3650 /* Falls within the array. */
3651 sv = av_nonelem(av,elem);
3653 /* Falls outside the array. If it is neg-
3654 ative, magic_setdefelem will use the
3655 index for error reporting. */
3656 sv = sv_2mortal(newSVavdefelem(av,elem,1));
3659 if (UNLIKELY(localizing)) {
3661 save_aelem(av, elem, svp);
3662 sv = *svp; /* may have changed */
3665 SAVEADELETE(av, elem);
3670 sv = (svp ? *svp : &PL_sv_undef);
3671 /* see note in pp_helem() */
3672 if (SvRMAGICAL(av) && SvGMAGICAL(sv))
3689 case MDEREF_HV_padhv_helem: /* $lex{...} */
3690 sv = PAD_SVl((++items)->pad_offset);
3693 case MDEREF_HV_gvhv_helem: /* $pkg{...} */
3694 sv = UNOP_AUX_item_sv(++items);
3695 assert(isGV_with_GP(sv));
3696 sv = (SV*)GvHVn((GV*)sv);
3699 case MDEREF_HV_pop_rv2hv_helem: /* expr->{...} */
3704 goto do_HV_rv2hv_helem;
3707 case MDEREF_HV_gvsv_vivify_rv2hv_helem: /* $pkg->{...} */
3708 sv = UNOP_AUX_item_sv(++items);
3709 assert(isGV_with_GP(sv));
3710 sv = GvSVn((GV*)sv);
3711 goto do_HV_vivify_rv2hv_helem;
3713 case MDEREF_HV_padsv_vivify_rv2hv_helem: /* $lex->{...} */
3714 sv = PAD_SVl((++items)->pad_offset);
3717 do_HV_vivify_rv2hv_helem:
3718 case MDEREF_HV_vivify_rv2hv_helem: /* vivify, ->{...} */
3719 /* this is the OPpDEREF action normally found at the end of
3720 * ops like aelem, helem, rv2sv */
3721 sv = vivify_ref(sv, OPpDEREF_HV);
3725 /* this is basically a copy of pp_rv2hv when it just has the
3726 * sKR/1 flags (and pp_rv2hv is aliased to pp_rv2av) */
3729 if (LIKELY(SvROK(sv))) {
3730 if (UNLIKELY(SvAMAGIC(sv))) {
3731 sv = amagic_deref_call(sv, to_hv_amg);
3734 if (UNLIKELY(SvTYPE(sv) != SVt_PVHV))
3735 DIE(aTHX_ "Not a HASH reference");
3737 else if (SvTYPE(sv) != SVt_PVHV) {
3738 if (!isGV_with_GP(sv))
3739 sv = (SV*)S_softref2xv_lite(aTHX_ sv, "a HASH", SVt_PVHV);
3740 sv = MUTABLE_SV(GvHVn((GV*)sv));
3746 /* retrieve the key; this may be either a lexical / package
3747 * var or a string constant, whose index/ptr is stored as an
3750 SV *keysv = NULL; /* to shut up stupid compiler warnings */
3752 assert(SvTYPE(sv) == SVt_PVHV);
3754 switch (actions & MDEREF_INDEX_MASK) {
3755 case MDEREF_INDEX_none:
3758 case MDEREF_INDEX_const:
3759 keysv = UNOP_AUX_item_sv(++items);
3762 case MDEREF_INDEX_padsv:
3763 keysv = PAD_SVl((++items)->pad_offset);
3766 case MDEREF_INDEX_gvsv:
3767 keysv = UNOP_AUX_item_sv(++items);
3768 keysv = GvSVn((GV*)keysv);
3772 /* see comment above about setting this var */
3773 PL_multideref_pc = items;
3776 /* ensure that candidate CONSTs have been HEKified */
3777 assert( ((actions & MDEREF_INDEX_MASK) != MDEREF_INDEX_const)
3778 || SvTYPE(keysv) >= SVt_PVMG
3781 || SvIsCOW_shared_hash(keysv));
3783 /* this is basically a copy of pp_helem with OPpDEREF skipped */
3785 if (!(actions & MDEREF_FLAG_last)) {
3786 HE *he = hv_fetch_ent((HV*)sv, keysv, 1, 0);
3787 if (!he || !(sv=HeVAL(he)) || sv == &PL_sv_undef)
3788 DIE(aTHX_ PL_no_helem_sv, SVfARG(keysv));
3792 if (PL_op->op_private &
3793 (OPpMULTIDEREF_EXISTS|OPpMULTIDEREF_DELETE))
3795 if (PL_op->op_private & OPpMULTIDEREF_EXISTS) {
3796 sv = hv_exists_ent((HV*)sv, keysv, 0)
3797 ? &PL_sv_yes : &PL_sv_no;
3800 I32 discard = (GIMME_V == G_VOID) ? G_DISCARD : 0;
3801 sv = hv_delete_ent((HV*)sv, keysv, discard, 0);
3809 const U32 lval = PL_op->op_flags & OPf_MOD || LVRET;
3810 const U32 defer = PL_op->op_private & OPpLVAL_DEFER;
3811 const bool localizing = PL_op->op_private & OPpLVAL_INTRO;
3812 bool preeminent = TRUE;
3814 HV * const hv = (HV*)sv;
3817 if (UNLIKELY(localizing)) {
3821 /* If we can determine whether the element exist,
3822 * Try to preserve the existenceness of a tied hash
3823 * element by using EXISTS and DELETE if possible.
3824 * Fallback to FETCH and STORE otherwise. */
3825 if (SvCANEXISTDELETE(hv))
3826 preeminent = hv_exists_ent(hv, keysv, 0);
3829 he = hv_fetch_ent(hv, keysv, lval && !defer, 0);
3830 svp = he ? &HeVAL(he) : NULL;
3834 if (!svp || !(sv = *svp) || sv == &PL_sv_undef) {
3838 DIE(aTHX_ PL_no_helem_sv, SVfARG(keysv));
3839 lv = sv_newmortal();
3840 sv_upgrade(lv, SVt_PVLV);
3842 sv_magic(lv, key2 = newSVsv(keysv),
3843 PERL_MAGIC_defelem, NULL, 0);
3844 /* sv_magic() increments refcount */
3845 SvREFCNT_dec_NN(key2);
3846 LvTARG(lv) = SvREFCNT_inc_simple_NN(hv);
3852 if (HvNAME_get(hv) && isGV_or_RVCV(sv))
3853 save_gp(MUTABLE_GV(sv),
3854 !(PL_op->op_flags & OPf_SPECIAL));
3855 else if (preeminent) {
3856 save_helem_flags(hv, keysv, svp,
3857 (PL_op->op_flags & OPf_SPECIAL)
3858 ? 0 : SAVEf_SETMAGIC);
3859 sv = *svp; /* may have changed */
3862 SAVEHDELETE(hv, keysv);
3867 sv = (svp && *svp ? *svp : &PL_sv_undef);
3868 /* see note in pp_helem() */
3869 if (SvRMAGICAL(hv) && SvGMAGICAL(sv))
3878 actions >>= MDEREF_SHIFT;
3896 itersvp = CxITERVAR(cx);
3899 switch (CxTYPE(cx)) {
3901 case CXt_LOOP_LAZYSV: /* string increment */
3903 SV* cur = cx->blk_loop.state_u.lazysv.cur;
3904 SV *end = cx->blk_loop.state_u.lazysv.end;
3905 /* If the maximum is !SvOK(), pp_enteriter substitutes PL_sv_no.
3906 It has SvPVX of "" and SvCUR of 0, which is what we want. */
3908 const char *max = SvPV_const(end, maxlen);
3909 if (DO_UTF8(end) && IN_UNI_8_BIT)
3910 maxlen = sv_len_utf8_nomg(end);
3911 if (UNLIKELY(SvNIOK(cur) || SvCUR(cur) > maxlen))
3915 /* NB: on the first iteration, oldsv will have a ref count of at
3916 * least 2 (one extra from blk_loop.itersave), so the GV or pad
3917 * slot will get localised; on subsequent iterations the RC==1
3918 * optimisation may kick in and the SV will be reused. */
3919 if (oldsv && LIKELY(SvREFCNT(oldsv) == 1 && !SvMAGICAL(oldsv))) {
3920 /* safe to reuse old SV */
3921 sv_setsv(oldsv, cur);
3925 /* we need a fresh SV every time so that loop body sees a
3926 * completely new SV for closures/references to work as
3928 *itersvp = newSVsv(cur);
3929 SvREFCNT_dec(oldsv);
3931 if (strEQ(SvPVX_const(cur), max))
3932 sv_setiv(cur, 0); /* terminate next time */
3938 case CXt_LOOP_LAZYIV: /* integer increment */
3940 IV cur = cx->blk_loop.state_u.lazyiv.cur;
3941 if (UNLIKELY(cur > cx->blk_loop.state_u.lazyiv.end))
3945 /* see NB comment above */
3946 if (oldsv && LIKELY(SvREFCNT(oldsv) == 1 && !SvMAGICAL(oldsv))) {
3947 /* safe to reuse old SV */
3949 if ( (SvFLAGS(oldsv) & (SVTYPEMASK|SVf_THINKFIRST|SVf_IVisUV))
3952 /* Cheap SvIOK_only().
3953 * Assert that flags which SvIOK_only() would test or
3954 * clear can't be set, because we're SVt_IV */
3955 assert(!(SvFLAGS(oldsv) &
3956 (SVf_OOK|SVf_UTF8|(SVf_OK & ~(SVf_IOK|SVp_IOK)))));
3957 SvFLAGS(oldsv) |= (SVf_IOK|SVp_IOK);
3958 /* SvIV_set() where sv_any points to head */
3959 oldsv->sv_u.svu_iv = cur;
3963 sv_setiv(oldsv, cur);
3967 /* we need a fresh SV every time so that loop body sees a
3968 * completely new SV for closures/references to work as they
3970 *itersvp = newSViv(cur);
3971 SvREFCNT_dec(oldsv);
3974 if (UNLIKELY(cur == IV_MAX)) {
3975 /* Handle end of range at IV_MAX */
3976 cx->blk_loop.state_u.lazyiv.end = IV_MIN;
3978 ++cx->blk_loop.state_u.lazyiv.cur;
3982 case CXt_LOOP_LIST: /* for (1,2,3) */
3984 assert(OPpITER_REVERSED == 2); /* so inc becomes -1 or 1 */
3985 inc = (IV)1 - (IV)(PL_op->op_private & OPpITER_REVERSED);
3986 ix = (cx->blk_loop.state_u.stack.ix += inc);
3987 if (UNLIKELY(inc > 0
3988 ? ix > cx->blk_oldsp
3989 : ix <= cx->blk_loop.state_u.stack.basesp)
3993 sv = PL_stack_base[ix];
3995 goto loop_ary_common;
3997 case CXt_LOOP_ARY: /* for (@ary) */
3999 av = cx->blk_loop.state_u.ary.ary;
4000 inc = (IV)1 - (IV)(PL_op->op_private & OPpITER_REVERSED);
4001 ix = (cx->blk_loop.state_u.ary.ix += inc);
4002 if (UNLIKELY(inc > 0
4008 if (UNLIKELY(SvRMAGICAL(av))) {
4009 SV * const * const svp = av_fetch(av, ix, FALSE);
4010 sv = svp ? *svp : NULL;
4013 sv = AvARRAY(av)[ix];
4018 if (UNLIKELY(cx->cx_type & CXp_FOR_LVREF)) {
4019 SvSetMagicSV(*itersvp, sv);
4024 if (UNLIKELY(SvIS_FREED(sv))) {
4026 Perl_croak(aTHX_ "Use of freed value in iteration");
4033 SvREFCNT_inc_simple_void_NN(sv);
4037 sv = newSVavdefelem(av, ix, 0);
4044 SvREFCNT_dec(oldsv);
4048 DIE(aTHX_ "panic: pp_iter, type=%u", CxTYPE(cx));
4051 /* Try to bypass pushing &PL_sv_yes and calling pp_and(); instead
4052 * jump straight to the AND op's op_other */
4053 assert(PL_op->op_next->op_type == OP_AND);
4054 if (PL_op->op_next->op_ppaddr == Perl_pp_and) {
4055 return cLOGOPx(PL_op->op_next)->op_other;
4058 /* An XS module has replaced the op_ppaddr, so fall back to the slow,
4060 /* pp_enteriter should have pre-extended the stack */
4061 EXTEND_SKIP(PL_stack_sp, 1);
4062 *++PL_stack_sp = &PL_sv_yes;
4063 return PL_op->op_next;
4067 /* Try to bypass pushing &PL_sv_no and calling pp_and(); instead
4068 * jump straight to the AND op's op_next */
4069 assert(PL_op->op_next->op_type == OP_AND);
4070 /* pp_enteriter should have pre-extended the stack */
4071 EXTEND_SKIP(PL_stack_sp, 1);
4072 /* we only need this for the rare case where the OP_AND isn't
4073 * in void context, e.g. $x = do { for (..) {...} };
4074 * (or for when an XS module has replaced the op_ppaddr)
4075 * but it's cheaper to just push it rather than testing first
4077 *++PL_stack_sp = &PL_sv_no;
4078 if (PL_op->op_next->op_ppaddr == Perl_pp_and) {
4079 return PL_op->op_next->op_next;
4082 /* An XS module has replaced the op_ppaddr, so fall back to the slow,
4084 return PL_op->op_next;
4090 A description of how taint works in pattern matching and substitution.
4092 This is all conditional on NO_TAINT_SUPPORT not being defined. Under
4093 NO_TAINT_SUPPORT, taint-related operations should become no-ops.
4095 While the pattern is being assembled/concatenated and then compiled,
4096 PL_tainted will get set (via TAINT_set) if any component of the pattern
4097 is tainted, e.g. /.*$tainted/. At the end of pattern compilation,
4098 the RXf_TAINTED flag is set on the pattern if PL_tainted is set (via
4099 TAINT_get). It will also be set if any component of the pattern matches
4100 based on locale-dependent behavior.
4102 When the pattern is copied, e.g. $r = qr/..../, the SV holding the ref to
4103 the pattern is marked as tainted. This means that subsequent usage, such
4104 as /x$r/, will set PL_tainted using TAINT_set, and thus RXf_TAINTED,
4105 on the new pattern too.
4107 RXf_TAINTED_SEEN is used post-execution by the get magic code
4108 of $1 et al to indicate whether the returned value should be tainted.
4109 It is the responsibility of the caller of the pattern (i.e. pp_match,
4110 pp_subst etc) to set this flag for any other circumstances where $1 needs
4113 The taint behaviour of pp_subst (and pp_substcont) is quite complex.
4115 There are three possible sources of taint
4117 * the pattern (both compile- and run-time, RXf_TAINTED / RXf_TAINTED_SEEN)
4118 * the replacement string (or expression under /e)
4120 There are four destinations of taint and they are affected by the sources
4121 according to the rules below:
4123 * the return value (not including /r):
4124 tainted by the source string and pattern, but only for the
4125 number-of-iterations case; boolean returns aren't tainted;
4126 * the modified string (or modified copy under /r):
4127 tainted by the source string, pattern, and replacement strings;
4129 tainted by the pattern, and under 'use re "taint"', by the source
4131 * PL_taint - i.e. whether subsequent code (e.g. in a /e block) is tainted:
4132 should always be unset before executing subsequent code.
4134 The overall action of pp_subst is:
4136 * at the start, set bits in rxtainted indicating the taint status of
4137 the various sources.
4139 * After each pattern execution, update the SUBST_TAINT_PAT bit in
4140 rxtainted if RXf_TAINTED_SEEN has been set, to indicate that the
4141 pattern has subsequently become tainted via locale ops.
4143 * If control is being passed to pp_substcont to execute a /e block,
4144 save rxtainted in the CXt_SUBST block, for future use by
4147 * Whenever control is being returned to perl code (either by falling
4148 off the "end" of pp_subst/pp_substcont, or by entering a /e block),
4149 use the flag bits in rxtainted to make all the appropriate types of
4150 destination taint visible; e.g. set RXf_TAINTED_SEEN so that $1
4151 et al will appear tainted.
4153 pp_match is just a simpler version of the above.
4169 U8 rxtainted = 0; /* holds various SUBST_TAINT_* flag bits.
4170 See "how taint works" above */
4173 REGEXP *rx = PM_GETRE(pm);
4174 regexp *prog = ReANY(rx);
4176 int force_on_match = 0;
4177 const I32 oldsave = PL_savestack_ix;
4179 bool doutf8 = FALSE; /* whether replacement is in utf8 */
4184 /* known replacement string? */
4185 SV *dstr = (pm->op_pmflags & PMf_CONST) ? POPs : NULL;
4189 if (PL_op->op_flags & OPf_STACKED)
4200 SvGETMAGIC(TARG); /* must come before cow check */
4202 /* note that a string might get converted to COW during matching */
4203 was_cow = cBOOL(SvIsCOW(TARG));
4205 if (!(rpm->op_pmflags & PMf_NONDESTRUCT)) {
4206 #ifndef PERL_ANY_COW
4208 sv_force_normal_flags(TARG,0);
4210 if ((SvREADONLY(TARG)
4211 || ( ((SvTYPE(TARG) == SVt_PVGV && isGV_with_GP(TARG))
4212 || SvTYPE(TARG) > SVt_PVLV)
4213 && !(SvTYPE(TARG) == SVt_PVGV && SvFAKE(TARG)))))
4214 Perl_croak_no_modify();
4218 orig = SvPV_nomg(TARG, len);
4219 /* note we don't (yet) force the var into being a string; if we fail
4220 * to match, we leave as-is; on successful match however, we *will*
4221 * coerce into a string, then repeat the match */
4222 if (!SvPOKp(TARG) || SvTYPE(TARG) == SVt_PVGV || SvVOK(TARG))
4225 /* only replace once? */
4226 once = !(rpm->op_pmflags & PMf_GLOBAL);
4228 /* See "how taint works" above */
4231 (SvTAINTED(TARG) ? SUBST_TAINT_STR : 0)
4232 | (RXp_ISTAINTED(prog) ? SUBST_TAINT_PAT : 0)
4233 | ((pm->op_pmflags & PMf_RETAINT) ? SUBST_TAINT_RETAINT : 0)
4234 | (( (once && !(rpm->op_pmflags & PMf_NONDESTRUCT))
4235 || (PL_op->op_private & OPpTRUEBOOL)) ? SUBST_TAINT_BOOLRET : 0));
4241 DIE(aTHX_ "panic: pp_subst, pm=%p, orig=%p", pm, orig);
4243 strend = orig + len;
4244 slen = DO_UTF8(TARG) ? utf8_length((U8*)orig, (U8*)strend) : len;
4245 maxiters = 2 * slen + 10; /* We can match twice at each
4246 position, once with zero-length,
4247 second time with non-zero. */
4249 /* handle the empty pattern */
4250 if (!RX_PRELEN(rx) && PL_curpm && !prog->mother_re) {
4251 if (PL_curpm == PL_reg_curpm) {
4252 if (PL_curpm_under) {
4253 if (PL_curpm_under == PL_reg_curpm) {
4254 Perl_croak(aTHX_ "Infinite recursion via empty pattern");
4256 pm = PL_curpm_under;
4266 #ifdef PERL_SAWAMPERSAND
4267 r_flags = ( RXp_NPARENS(prog)
4269 || (RXp_EXTFLAGS(prog) & (RXf_EVAL_SEEN|RXf_PMf_KEEPCOPY))
4270 || (rpm->op_pmflags & PMf_KEEPCOPY)
4275 r_flags = REXEC_COPY_STR;
4278 if (!CALLREGEXEC(rx, orig, strend, orig, 0, TARG, NULL, r_flags))
4281 PUSHs(rpm->op_pmflags & PMf_NONDESTRUCT ? TARG : &PL_sv_no);
4282 LEAVE_SCOPE(oldsave);
4287 /* known replacement string? */
4289 /* replacement needing upgrading? */
4290 if (DO_UTF8(TARG) && !doutf8) {
4291 nsv = sv_newmortal();
4293 sv_utf8_upgrade(nsv);
4294 c = SvPV_const(nsv, clen);
4298 c = SvPV_const(dstr, clen);
4299 doutf8 = DO_UTF8(dstr);
4302 if (UNLIKELY(TAINT_get))
4303 rxtainted |= SUBST_TAINT_REPL;
4310 /* can do inplace substitution? */
4315 && (I32)clen <= RXp_MINLENRET(prog)
4317 || !(r_flags & REXEC_COPY_STR)
4318 || (!SvGMAGICAL(dstr) && !(RXp_EXTFLAGS(prog) & RXf_EVAL_SEEN))
4320 && !(RXp_EXTFLAGS(prog) & RXf_NO_INPLACE_SUBST)
4321 && (!doutf8 || SvUTF8(TARG))
4322 && !(rpm->op_pmflags & PMf_NONDESTRUCT))
4326 /* string might have got converted to COW since we set was_cow */
4327 if (SvIsCOW(TARG)) {
4328 if (!force_on_match)
4330 assert(SvVOK(TARG));
4333 if (force_on_match) {
4334 /* redo the first match, this time with the orig var
4335 * forced into being a string */
4337 orig = SvPV_force_nomg(TARG, len);
4343 if (RXp_MATCH_TAINTED(prog)) /* run time pattern taint, eg locale */
4344 rxtainted |= SUBST_TAINT_PAT;
4345 m = orig + RXp_OFFS(prog)[0].start;
4346 d = orig + RXp_OFFS(prog)[0].end;
4348 if (m - s > strend - d) { /* faster to shorten from end */
4351 Copy(c, m, clen, char);
4356 Move(d, m, i, char);
4360 SvCUR_set(TARG, m - s);
4362 else { /* faster from front */
4366 Move(s, d - i, i, char);
4369 Copy(c, d, clen, char);
4376 d = s = RXp_OFFS(prog)[0].start + orig;
4379 if (UNLIKELY(iters++ > maxiters))
4380 DIE(aTHX_ "Substitution loop");
4381 /* run time pattern taint, eg locale */
4382 if (UNLIKELY(RXp_MATCH_TAINTED(prog)))
4383 rxtainted |= SUBST_TAINT_PAT;
4384 m = RXp_OFFS(prog)[0].start + orig;
4387 Move(s, d, i, char);
4391 Copy(c, d, clen, char);
4394 s = RXp_OFFS(prog)[0].end + orig;
4395 } while (CALLREGEXEC(rx, s, strend, orig,
4396 s == m, /* don't match same null twice */
4398 REXEC_NOT_FIRST|REXEC_IGNOREPOS|REXEC_FAIL_ON_UNDERFLOW));
4401 SvCUR_set(TARG, d - SvPVX_const(TARG) + i);
4402 Move(s, d, i+1, char); /* include the NUL */
4406 if (PL_op->op_private & OPpTRUEBOOL)
4416 if (force_on_match) {
4417 /* redo the first match, this time with the orig var
4418 * forced into being a string */
4420 if (rpm->op_pmflags & PMf_NONDESTRUCT) {
4421 /* I feel that it should be possible to avoid this mortal copy
4422 given that the code below copies into a new destination.
4423 However, I suspect it isn't worth the complexity of
4424 unravelling the C<goto force_it> for the small number of
4425 cases where it would be viable to drop into the copy code. */
4426 TARG = sv_2mortal(newSVsv(TARG));
4428 orig = SvPV_force_nomg(TARG, len);
4434 if (RXp_MATCH_TAINTED(prog)) /* run time pattern taint, eg locale */
4435 rxtainted |= SUBST_TAINT_PAT;
4437 s = RXp_OFFS(prog)[0].start + orig;
4438 dstr = newSVpvn_flags(orig, s-orig,
4439 SVs_TEMP | (DO_UTF8(TARG) ? SVf_UTF8 : 0));
4444 /* note that a whole bunch of local vars are saved here for
4445 * use by pp_substcont: here's a list of them in case you're
4446 * searching for places in this sub that uses a particular var:
4447 * iters maxiters r_flags oldsave rxtainted orig dstr targ
4448 * s m strend rx once */
4450 RETURNOP(cPMOP->op_pmreplrootu.op_pmreplroot);
4454 if (UNLIKELY(iters++ > maxiters))
4455 DIE(aTHX_ "Substitution loop");
4456 if (UNLIKELY(RXp_MATCH_TAINTED(prog)))
4457 rxtainted |= SUBST_TAINT_PAT;
4458 if (RXp_MATCH_COPIED(prog) && RXp_SUBBEG(prog) != orig) {
4460 char *old_orig = orig;
4461 assert(RXp_SUBOFFSET(prog) == 0);
4463 orig = RXp_SUBBEG(prog);
4464 s = orig + (old_s - old_orig);
4465 strend = s + (strend - old_s);
4467 m = RXp_OFFS(prog)[0].start + orig;
4468 sv_catpvn_nomg_maybeutf8(dstr, s, m - s, DO_UTF8(TARG));
4469 s = RXp_OFFS(prog)[0].end + orig;
4471 /* replacement already stringified */
4473 sv_catpvn_nomg_maybeutf8(dstr, c, clen, doutf8);
4477 sv_catsv(dstr, repl);
4481 } while (CALLREGEXEC(rx, s, strend, orig,
4482 s == m, /* Yields minend of 0 or 1 */
4484 REXEC_NOT_FIRST|REXEC_IGNOREPOS|REXEC_FAIL_ON_UNDERFLOW));
4485 assert(strend >= s);
4486 sv_catpvn_nomg_maybeutf8(dstr, s, strend - s, DO_UTF8(TARG));
4488 if (rpm->op_pmflags & PMf_NONDESTRUCT) {
4489 /* From here on down we're using the copy, and leaving the original
4496 /* The match may make the string COW. If so, brilliant, because
4497 that's just saved us one malloc, copy and free - the regexp has
4498 donated the old buffer, and we malloc an entirely new one, rather
4499 than the regexp malloc()ing a buffer and copying our original,
4500 only for us to throw it away here during the substitution. */
4501 if (SvIsCOW(TARG)) {
4502 sv_force_normal_flags(TARG, SV_COW_DROP_PV);
4508 SvPV_set(TARG, SvPVX(dstr));
4509 SvCUR_set(TARG, SvCUR(dstr));
4510 SvLEN_set(TARG, SvLEN(dstr));
4511 SvFLAGS(TARG) |= SvUTF8(dstr);
4512 SvPV_set(dstr, NULL);
4515 if (PL_op->op_private & OPpTRUEBOOL)
4522 if (!(rpm->op_pmflags & PMf_NONDESTRUCT)) {
4523 (void)SvPOK_only_UTF8(TARG);
4526 /* See "how taint works" above */
4528 if ((rxtainted & SUBST_TAINT_PAT) ||
4529 ((rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_RETAINT)) ==
4530 (SUBST_TAINT_STR|SUBST_TAINT_RETAINT))
4532 (RXp_MATCH_TAINTED_on(prog)); /* taint $1 et al */
4534 if (!(rxtainted & SUBST_TAINT_BOOLRET)
4535 && (rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_PAT))
4537 SvTAINTED_on(TOPs); /* taint return value */
4539 SvTAINTED_off(TOPs); /* may have got tainted earlier */
4541 /* needed for mg_set below */
4543 cBOOL(rxtainted & (SUBST_TAINT_STR|SUBST_TAINT_PAT|SUBST_TAINT_REPL))
4547 SvSETMAGIC(TARG); /* PL_tainted must be correctly set for this mg_set */
4549 LEAVE_SCOPE(oldsave);
4559 PL_stack_base[PL_markstack_ptr[-1]++] = PL_stack_base[*PL_markstack_ptr];
4560 ++*PL_markstack_ptr;
4562 LEAVE_with_name("grep_item"); /* exit inner scope */
4565 if (UNLIKELY(PL_stack_base + *PL_markstack_ptr > SP)) {
4567 const U8 gimme = GIMME_V;
4569 LEAVE_with_name("grep"); /* exit outer scope */
4570 (void)POPMARK; /* pop src */
4571 items = --*PL_markstack_ptr - PL_markstack_ptr[-1];
4572 (void)POPMARK; /* pop dst */
4573 SP = PL_stack_base + POPMARK; /* pop original mark */
4574 if (gimme == G_SCALAR) {
4575 if (PL_op->op_private & OPpTRUEBOOL)
4576 PUSHs(items ? &PL_sv_yes : &PL_sv_zero);
4582 else if (gimme == G_ARRAY)
4589 ENTER_with_name("grep_item"); /* enter inner scope */
4592 src = PL_stack_base[TOPMARK];
4593 if (SvPADTMP(src)) {
4594 src = PL_stack_base[TOPMARK] = sv_mortalcopy(src);
4600 RETURNOP(cLOGOP->op_other);
4604 /* leave_adjust_stacks():
4606 * Process a scope's return args (in the range from_sp+1 .. PL_stack_sp),
4607 * positioning them at to_sp+1 onwards, and do the equivalent of a
4608 * FREEMPS and TAINT_NOT.
4610 * Not intended to be called in void context.
4612 * When leaving a sub, eval, do{} or other scope, the things that need
4613 * doing to process the return args are:
4614 * * in scalar context, only return the last arg (or PL_sv_undef if none);
4615 * * for the types of return that return copies of their args (such
4616 * as rvalue sub return), make a mortal copy of every return arg,
4617 * except where we can optimise the copy away without it being
4618 * semantically visible;
4619 * * make sure that the arg isn't prematurely freed; in the case of an
4620 * arg not copied, this may involve mortalising it. For example, in
4621 * C<sub f { my $x = ...; $x }>, $x would be freed when we do
4622 * CX_LEAVE_SCOPE(cx) unless it's protected or copied.
4624 * What condition to use when deciding whether to pass the arg through
4625 * or make a copy, is determined by the 'pass' arg; its valid values are:
4626 * 0: rvalue sub/eval exit
4627 * 1: other rvalue scope exit
4628 * 2: :lvalue sub exit in rvalue context
4629 * 3: :lvalue sub exit in lvalue context and other lvalue scope exits
4631 * There is a big issue with doing a FREETMPS. We would like to free any
4632 * temps created by the last statement which the sub executed, rather than
4633 * leaving them for the caller. In a situation where a sub call isn't
4634 * soon followed by a nextstate (e.g. nested recursive calls, a la
4635 * fibonacci()), temps can accumulate, causing memory and performance
4638 * On the other hand, we don't want to free any TEMPs which are keeping
4639 * alive any return args that we skipped copying; nor do we wish to undo
4640 * any mortalising done here.
4642 * The solution is to split the temps stack frame into two, with a cut
4643 * point delineating the two halves. We arrange that by the end of this
4644 * function, all the temps stack frame entries we wish to keep are in the
4645 * range PL_tmps_floor+1.. tmps_base-1, while the ones to free now are in
4646 * the range tmps_base .. PL_tmps_ix. During the course of this
4647 * function, tmps_base starts off as PL_tmps_floor+1, then increases
4648 * whenever we find or create a temp that we know should be kept. In
4649 * general the stuff above tmps_base is undecided until we reach the end,
4650 * and we may need a sort stage for that.
4652 * To determine whether a TEMP is keeping a return arg alive, every
4653 * arg that is kept rather than copied and which has the SvTEMP flag
4654 * set, has the flag temporarily unset, to mark it. At the end we scan
4655 * the temps stack frame above the cut for entries without SvTEMP and
4656 * keep them, while turning SvTEMP on again. Note that if we die before
4657 * the SvTEMPs flags are set again, its safe: at worst, subsequent use of
4658 * those SVs may be slightly less efficient.
4660 * In practice various optimisations for some common cases mean we can
4661 * avoid most of the scanning and swapping about with the temps stack.
4665 Perl_leave_adjust_stacks(pTHX_ SV **from_sp, SV **to_sp, U8 gimme, int pass)
4668 SSize_t tmps_base; /* lowest index into tmps stack that needs freeing now */
4671 PERL_ARGS_ASSERT_LEAVE_ADJUST_STACKS;
4675 if (gimme == G_ARRAY) {
4676 nargs = SP - from_sp;
4680 assert(gimme == G_SCALAR);
4681 if (UNLIKELY(from_sp >= SP)) {
4682 /* no return args */
4683 assert(from_sp == SP);
4685 *++SP = &PL_sv_undef;
4695 /* common code for G_SCALAR and G_ARRAY */
4697 tmps_base = PL_tmps_floor + 1;
4701 /* pointer version of tmps_base. Not safe across temp stack
4705 EXTEND_MORTAL(nargs); /* one big extend for worst-case scenario */
4706 tmps_basep = PL_tmps_stack + tmps_base;
4708 /* process each return arg */
4711 SV *sv = *from_sp++;
4713 assert(PL_tmps_ix + nargs < PL_tmps_max);
4715 /* PADTMPs with container set magic shouldn't appear in the
4716 * wild. This assert is more important for pp_leavesublv(),
4717 * but by testing for it here, we're more likely to catch
4718 * bad cases (what with :lvalue subs not being widely
4719 * deployed). The two issues are that for something like
4720 * sub :lvalue { $tied{foo} }
4722 * sub :lvalue { substr($foo,1,2) }
4723 * pp_leavesublv() will croak if the sub returns a PADTMP,
4724 * and currently functions like pp_substr() return a mortal
4725 * rather than using their PADTMP when returning a PVLV.
4726 * This is because the PVLV will hold a ref to $foo,
4727 * so $foo would get delayed in being freed while
4728 * the PADTMP SV remained in the PAD.
4729 * So if this assert fails it means either:
4730 * 1) there is pp code similar to pp_substr that is
4731 * returning a PADTMP instead of a mortal, and probably
4733 * 2) pp_leavesublv is making unwarranted assumptions
4734 * about always croaking on a PADTMP
4736 if (SvPADTMP(sv) && SvSMAGICAL(sv)) {
4738 for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
4739 assert(PERL_MAGIC_TYPE_IS_VALUE_MAGIC(mg->mg_type));
4745 pass == 0 ? (SvTEMP(sv) && !SvMAGICAL(sv) && SvREFCNT(sv) == 1)
4746 : pass == 1 ? ((SvTEMP(sv) || SvPADTMP(sv)) && !SvMAGICAL(sv) && SvREFCNT(sv) == 1)
4747 : pass == 2 ? (!SvPADTMP(sv))
4750 /* pass through: skip copy for logic or optimisation
4751 * reasons; instead mortalise it, except that ... */
4755 /* ... since this SV is an SvTEMP , we don't need to
4756 * re-mortalise it; instead we just need to ensure
4757 * that its existing entry in the temps stack frame
4758 * ends up below the cut and so avoids being freed
4759 * this time round. We mark it as needing to be kept
4760 * by temporarily unsetting SvTEMP; then at the end,
4761 * we shuffle any !SvTEMP entries on the tmps stack
4762 * back below the cut.
4763 * However, there's a significant chance that there's
4764 * a 1:1 correspondence between the first few (or all)
4765 * elements in the return args stack frame and those
4766 * in the temps stack frame; e,g.:
4767 * sub f { ....; map {...} .... },
4768 * or if we're exiting multiple scopes and one of the
4769 * inner scopes has already made mortal copies of each
4772 * If so, this arg sv will correspond to the next item
4773 * on the tmps stack above the cut, and so can be kept
4774 * merely by moving the cut boundary up one, rather
4775 * than messing with SvTEMP. If all args are 1:1 then
4776 * we can avoid the sorting stage below completely.
4778 * If there are no items above the cut on the tmps
4779 * stack, then the SvTEMP must comne from an item
4780 * below the cut, so there's nothing to do.
4782 if (tmps_basep <= &PL_tmps_stack[PL_tmps_ix]) {
4783 if (sv == *tmps_basep)
4789 else if (!SvPADTMP(sv)) {
4790 /* mortalise arg to avoid it being freed during save
4791 * stack unwinding. Pad tmps don't need mortalising as
4792 * they're never freed. This is the equivalent of
4793 * sv_2mortal(SvREFCNT_inc(sv)), except that:
4794 * * it assumes that the temps stack has already been
4796 * * it puts the new item at the cut rather than at
4797 * ++PL_tmps_ix, moving the previous occupant there
4800 if (!SvIMMORTAL(sv)) {
4801 SvREFCNT_inc_simple_void_NN(sv);
4803 /* Note that if there's nothing above the cut,
4804 * this copies the garbage one slot above
4805 * PL_tmps_ix onto itself. This is harmless (the
4806 * stack's already been extended), but might in
4807 * theory trigger warnings from tools like ASan
4809 PL_tmps_stack[++PL_tmps_ix] = *tmps_basep;
4815 /* Make a mortal copy of the SV.
4816 * The following code is the equivalent of sv_mortalcopy()
4818 * * it assumes the temps stack has already been extended;
4819 * * it optimises the copying for some simple SV types;
4820 * * it puts the new item at the cut rather than at
4821 * ++PL_tmps_ix, moving the previous occupant there
4824 SV *newsv = newSV(0);
4826 PL_tmps_stack[++PL_tmps_ix] = *tmps_basep;
4827 /* put it on the tmps stack early so it gets freed if we die */
4828 *tmps_basep++ = newsv;
4831 if (SvTYPE(sv) <= SVt_IV) {
4832 /* arg must be one of undef, IV/UV, or RV: skip
4833 * sv_setsv_flags() and do the copy directly */
4835 U32 srcflags = SvFLAGS(sv);
4837 assert(!SvGMAGICAL(sv));
4838 if (srcflags & (SVf_IOK|SVf_ROK)) {
4839 SET_SVANY_FOR_BODYLESS_IV(newsv);
4841 if (srcflags & SVf_ROK) {
4842 newsv->sv_u.svu_rv = SvREFCNT_inc(SvRV(sv));
4843 /* SV type plus flags */
4844 dstflags = (SVt_IV|SVf_ROK|SVs_TEMP);
4847 /* both src and dst are <= SVt_IV, so sv_any
4848 * points to the head; so access the heads
4849 * directly rather than going via sv_any.
4851 assert( &(sv->sv_u.svu_iv)
4852 == &(((XPVIV*) SvANY(sv))->xiv_iv));
4853 assert( &(newsv->sv_u.svu_iv)
4854 == &(((XPVIV*) SvANY(newsv))->xiv_iv));
4855 newsv->sv_u.svu_iv = sv->sv_u.svu_iv;
4856 /* SV type plus flags */
4857 dstflags = (SVt_IV|SVf_IOK|SVp_IOK|SVs_TEMP
4858 |(srcflags & SVf_IVisUV));
4862 assert(!(srcflags & SVf_OK));
4863 dstflags = (SVt_NULL|SVs_TEMP); /* SV type plus flags */
4865 SvFLAGS(newsv) = dstflags;
4869 /* do the full sv_setsv() */
4873 old_base = tmps_basep - PL_tmps_stack;
4875 sv_setsv_flags(newsv, sv, SV_DO_COW_SVSETSV);
4876 /* the mg_get or sv_setsv might have created new temps
4877 * or realloced the tmps stack; regrow and reload */
4878 EXTEND_MORTAL(nargs);
4879 tmps_basep = PL_tmps_stack + old_base;
4880 TAINT_NOT; /* Each item is independent */
4886 /* If there are any temps left above the cut, we need to sort
4887 * them into those to keep and those to free. The only ones to
4888 * keep are those for which we've temporarily unset SvTEMP.
4889 * Work inwards from the two ends at tmps_basep .. PL_tmps_ix,
4890 * swapping pairs as necessary. Stop when we meet in the middle.
4893 SV **top = PL_tmps_stack + PL_tmps_ix;
4894 while (tmps_basep <= top) {
4907 tmps_base = tmps_basep - PL_tmps_stack;
4910 PL_stack_sp = to_sp;
4912 /* unrolled FREETMPS() but using tmps_base-1 rather than PL_tmps_floor */
4913 while (PL_tmps_ix >= tmps_base) {
4914 SV* const sv = PL_tmps_stack[PL_tmps_ix--];
4916 PoisonWith(PL_tmps_stack + PL_tmps_ix + 1, 1, SV *, 0xAB);
4920 SvREFCNT_dec_NN(sv); /* note, can modify tmps_ix!!! */
4926 /* also tail-called by pp_return */
4936 assert(CxTYPE(cx) == CXt_SUB);
4938 if (CxMULTICALL(cx)) {
4939 /* entry zero of a stack is always PL_sv_undef, which
4940 * simplifies converting a '()' return into undef in scalar context */
4941 assert(PL_stack_sp > PL_stack_base || *PL_stack_base == &PL_sv_undef);
4945 gimme = cx->blk_gimme;
4946 oldsp = PL_stack_base + cx->blk_oldsp; /* last arg of previous frame */
4948 if (gimme == G_VOID)
4949 PL_stack_sp = oldsp;
4951 leave_adjust_stacks(oldsp, oldsp, gimme, 0);
4954 cx_popsub(cx); /* Stack values are safe: release CV and @_ ... */
4956 retop = cx->blk_sub.retop;
4963 /* clear (if possible) or abandon the current @_. If 'abandon' is true,
4964 * forces an abandon */
4967 Perl_clear_defarray(pTHX_ AV* av, bool abandon)
4969 const SSize_t fill = AvFILLp(av);
4971 PERL_ARGS_ASSERT_CLEAR_DEFARRAY;
4973 if (LIKELY(!abandon && SvREFCNT(av) == 1 && !SvMAGICAL(av))) {
4978 AV *newav = newAV();
4979 av_extend(newav, fill);
4980 AvREIFY_only(newav);
4981 PAD_SVl(0) = MUTABLE_SV(newav);
4982 SvREFCNT_dec_NN(av);
4993 I32 old_savestack_ix;
4998 /* Locate the CV to call:
4999 * - most common case: RV->CV: f(), $ref->():
5000 * note that if a sub is compiled before its caller is compiled,
5001 * the stash entry will be a ref to a CV, rather than being a GV.
5002 * - second most common case: CV: $ref->method()
5005 /* a non-magic-RV -> CV ? */
5006 if (LIKELY( (SvFLAGS(sv) & (SVf_ROK|SVs_GMG)) == SVf_ROK)) {
5007 cv = MUTABLE_CV(SvRV(sv));
5008 if (UNLIKELY(SvOBJECT(cv))) /* might be overloaded */
5012 cv = MUTABLE_CV(sv);
5015 if (UNLIKELY(SvTYPE(cv) != SVt_PVCV)) {
5016 /* handle all the weird cases */
5017 switch (SvTYPE(sv)) {
5019 if (!isGV_with_GP(sv))
5023 cv = GvCVu((const GV *)sv);
5024 if (UNLIKELY(!cv)) {
5026 cv = sv_2cv(sv, &stash, &gv, 0);
5028 old_savestack_ix = PL_savestack_ix;
5039 if (UNLIKELY(SvAMAGIC(sv))) {
5040 sv = amagic_deref_call(sv, to_cv_amg);
5041 /* Don't SPAGAIN here. */
5047 if (UNLIKELY(!SvOK(sv)))
5048 DIE(aTHX_ PL_no_usym, "a subroutine");
5050 sym = SvPV_nomg_const(sv, len);
5051 if (PL_op->op_private & HINT_STRICT_REFS)
5052 DIE(aTHX_ "Can't use string (\"%" SVf32 "\"%s) as a subroutine ref while \"strict refs\" in use", sv, len>32 ? "..." : "");
5053 cv = get_cvn_flags(sym, len, GV_ADD|SvUTF8(sv));
5056 cv = MUTABLE_CV(SvRV(sv));
5057 if (LIKELY(SvTYPE(cv) == SVt_PVCV))
5063 DIE(aTHX_ "Not a CODE reference");
5067 /* At this point we want to save PL_savestack_ix, either by doing a
5068 * cx_pushsub(), or for XS, doing an ENTER. But we don't yet know the final
5069 * CV we will be using (so we don't know whether its XS, so we can't
5070 * cx_pushsub() or ENTER yet), and determining cv may itself push stuff on
5071 * the save stack. So remember where we are currently on the save
5072 * stack, and later update the CX or scopestack entry accordingly. */
5073 old_savestack_ix = PL_savestack_ix;
5075 /* these two fields are in a union. If they ever become separate,
5076 * we have to test for both of them being null below */
5078 assert((void*)&CvROOT(cv) == (void*)&CvXSUB(cv));
5079 while (UNLIKELY(!CvROOT(cv))) {
5083 /* anonymous or undef'd function leaves us no recourse */
5084 if (CvLEXICAL(cv) && CvHASGV(cv))
5085 DIE(aTHX_ "Undefined subroutine &%" SVf " called",
5086 SVfARG(cv_name(cv, NULL, 0)));
5087 if (CvANON(cv) || !CvHASGV(cv)) {
5088 DIE(aTHX_ "Undefined subroutine called");
5091 /* autoloaded stub? */
5092 if (cv != GvCV(gv = CvGV(cv))) {
5095 /* should call AUTOLOAD now? */
5098 autogv = gv_autoload_pvn(GvSTASH(gv), GvNAME(gv), GvNAMELEN(gv),
5099 (GvNAMEUTF8(gv) ? SVf_UTF8 : 0)
5100 |(PL_op->op_flags & OPf_REF
5101 ? GV_AUTOLOAD_ISMETHOD
5103 cv = autogv ? GvCV(autogv) : NULL;
5106 sub_name = sv_newmortal();
5107 gv_efullname3(sub_name, gv, NULL);
5108 DIE(aTHX_ "Undefined subroutine &%" SVf " called", SVfARG(sub_name));
5112 /* unrolled "CvCLONE(cv) && ! CvCLONED(cv)" */
5113 if (UNLIKELY((CvFLAGS(cv) & (CVf_CLONE|CVf_CLONED)) == CVf_CLONE))
5114 DIE(aTHX_ "Closure prototype called");
5116 if (UNLIKELY((PL_op->op_private & OPpENTERSUB_DB) && GvCV(PL_DBsub)
5119 Perl_get_db_sub(aTHX_ &sv, cv);
5121 PL_curcopdb = PL_curcop;
5123 /* check for lsub that handles lvalue subroutines */
5124 cv = GvCV(gv_fetchpvs("DB::lsub", GV_ADDMULTI, SVt_PVCV));
5125 /* if lsub not found then fall back to DB::sub */
5126 if (!cv) cv = GvCV(PL_DBsub);
5128 cv = GvCV(PL_DBsub);
5131 if (!cv || (!CvXSUB(cv) && !CvSTART(cv)))
5132 DIE(aTHX_ "No DB::sub routine defined");
5135 if (!(CvISXSUB(cv))) {
5136 /* This path taken at least 75% of the time */
5143 /* keep PADTMP args alive throughout the call (we need to do this
5144 * because @_ isn't refcounted). Note that we create the mortals
5145 * in the caller's tmps frame, so they won't be freed until after
5146 * we return from the sub.
5155 *svp = sv = sv_mortalcopy(sv);
5161 cx = cx_pushblock(CXt_SUB, gimme, MARK, old_savestack_ix);
5162 hasargs = cBOOL(PL_op->op_flags & OPf_STACKED);
5163 cx_pushsub(cx, cv, PL_op->op_next, hasargs);
5165 padlist = CvPADLIST(cv);
5166 if (UNLIKELY((depth = ++CvDEPTH(cv)) >= 2))
5167 pad_push(padlist, depth);
5168 PAD_SET_CUR_NOSAVE(padlist, depth);
5169 if (LIKELY(hasargs)) {
5170 AV *const av = MUTABLE_AV(PAD_SVl(0));
5174 defavp = &GvAV(PL_defgv);
5175 cx->blk_sub.savearray = *defavp;
5176 *defavp = MUTABLE_AV(SvREFCNT_inc_simple_NN(av));
5178 /* it's the responsibility of whoever leaves a sub to ensure
5179 * that a clean, empty AV is left in pad[0]. This is normally
5180 * done by cx_popsub() */
5181 assert(!AvREAL(av) && AvFILLp(av) == -1);
5184 if (UNLIKELY(items - 1 > AvMAX(av))) {
5185 SV **ary = AvALLOC(av);
5186 Renew(ary, items, SV*);
5187 AvMAX(av) = items - 1;
5193 Copy(MARK+1,AvARRAY(av),items,SV*);
5194 AvFILLp(av) = items - 1;
5196 if (UNLIKELY((cx->blk_u16 & OPpENTERSUB_LVAL_MASK) == OPpLVAL_INTRO &&
5198 DIE(aTHX_ "Can't modify non-lvalue subroutine call of &%" SVf,
5199 SVfARG(cv_name(cv, NULL, 0)));
5200 /* warning must come *after* we fully set up the context
5201 * stuff so that __WARN__ handlers can safely dounwind()
5204 if (UNLIKELY(depth == PERL_SUB_DEPTH_WARN
5205 && ckWARN(WARN_RECURSION)
5206 && !(PERLDB_SUB && cv == GvCV(PL_DBsub))))
5207 sub_crush_depth(cv);
5208 RETURNOP(CvSTART(cv));
5211 SSize_t markix = TOPMARK;
5215 /* pretend we did the ENTER earlier */
5216 PL_scopestack[PL_scopestack_ix - 1] = old_savestack_ix;
5221 if (UNLIKELY(((PL_op->op_private
5222 & CX_PUSHSUB_GET_LVALUE_MASK(Perl_is_lvalue_sub)
5223 ) & OPpENTERSUB_LVAL_MASK) == OPpLVAL_INTRO &&
5225 DIE(aTHX_ "Can't modify non-lvalue subroutine call of &%" SVf,
5226 SVfARG(cv_name(cv, NULL, 0)));
5228 if (UNLIKELY(!(PL_op->op_flags & OPf_STACKED) && GvAV(PL_defgv))) {
5229 /* Need to copy @_ to stack. Alternative may be to
5230 * switch stack to @_, and copy return values
5231 * back. This would allow popping @_ in XSUB, e.g.. XXXX */
5232 AV * const av = GvAV(PL_defgv);
5233 const SSize_t items = AvFILL(av) + 1;
5237 const bool m = cBOOL(SvRMAGICAL(av));
5238 /* Mark is at the end of the stack. */
5240 for (; i < items; ++i)
5244 SV ** const svp = av_fetch(av, i, 0);
5245 sv = svp ? *svp : NULL;
5247 else sv = AvARRAY(av)[i];
5248 if (sv) SP[i+1] = sv;
5250 SP[i+1] = av_nonelem(av, i);
5258 SV **mark = PL_stack_base + markix;
5259 SSize_t items = SP - mark;
5262 if (*mark && SvPADTMP(*mark)) {
5263 *mark = sv_mortalcopy(*mark);
5267 /* We assume first XSUB in &DB::sub is the called one. */
5268 if (UNLIKELY(PL_curcopdb)) {
5269 SAVEVPTR(PL_curcop);
5270 PL_curcop = PL_curcopdb;
5273 /* Do we need to open block here? XXXX */
5275 /* calculate gimme here as PL_op might get changed and then not
5276 * restored until the LEAVE further down */
5277 is_scalar = (GIMME_V == G_SCALAR);
5279 /* CvXSUB(cv) must not be NULL because newXS() refuses NULL xsub address */
5281 CvXSUB(cv)(aTHX_ cv);
5283 #if defined DEBUGGING && !defined DEBUGGING_RE_ONLY
5284 /* This duplicates the check done in runops_debug(), but provides more
5285 * information in the common case of the fault being with an XSUB.
5287 * It should also catch an XSUB pushing more than it extends
5288 * in scalar context.
5290 if (PL_curstackinfo->si_stack_hwm < PL_stack_sp - PL_stack_base)
5291 Perl_croak_nocontext(
5292 "panic: XSUB %s::%s (%s) failed to extend arg stack: "
5293 "base=%p, sp=%p, hwm=%p\n",
5294 HvNAME(GvSTASH(CvGV(cv))), GvNAME(CvGV(cv)), CvFILE(cv),
5295 PL_stack_base, PL_stack_sp,
5296 PL_stack_base + PL_curstackinfo->si_stack_hwm);
5298 /* Enforce some sanity in scalar context. */
5300 SV **svp = PL_stack_base + markix + 1;
5301 if (svp != PL_stack_sp) {
5302 *svp = svp > PL_stack_sp ? &PL_sv_undef : *PL_stack_sp;
5312 Perl_sub_crush_depth(pTHX_ CV *cv)
5314 PERL_ARGS_ASSERT_SUB_CRUSH_DEPTH;
5317 Perl_warner(aTHX_ packWARN(WARN_RECURSION), "Deep recursion on anonymous subroutine");
5319 Perl_warner(aTHX_ packWARN(WARN_RECURSION), "Deep recursion on subroutine \"%" SVf "\"",
5320 SVfARG(cv_name(cv,NULL,0)));
5326 /* like croak, but report in context of caller */
5329 Perl_croak_caller(const char *pat, ...)
5333 const PERL_CONTEXT *cx = caller_cx(0, NULL);
5335 /* make error appear at call site */
5337 PL_curcop = cx->blk_oldcop;
5339 va_start(args, pat);
5341 NOT_REACHED; /* NOTREACHED */
5350 SV* const elemsv = POPs;
5351 IV elem = SvIV(elemsv);
5352 AV *const av = MUTABLE_AV(POPs);
5353 const U32 lval = PL_op->op_flags & OPf_MOD || LVRET;
5354 const U32 defer = PL_op->op_private & OPpLVAL_DEFER;
5355 const bool localizing = PL_op->op_private & OPpLVAL_INTRO;
5356 bool preeminent = TRUE;
5359 if (UNLIKELY(SvROK(elemsv) && !SvGAMAGIC(elemsv) && ckWARN(WARN_MISC)))
5360 Perl_warner(aTHX_ packWARN(WARN_MISC),
5361 "Use of reference \"%" SVf "\" as array index",
5363 if (UNLIKELY(SvTYPE(av) != SVt_PVAV))
5366 if (UNLIKELY(localizing)) {
5370 /* If we can determine whether the element exist,
5371 * Try to preserve the existenceness of a tied array
5372 * element by using EXISTS and DELETE if possible.
5373 * Fallback to FETCH and STORE otherwise. */
5374 if (SvCANEXISTDELETE(av))
5375 preeminent = av_exists(av, elem);
5378 svp = av_fetch(av, elem, lval && !defer);
5380 #ifdef PERL_MALLOC_WRAP
5381 if (SvUOK(elemsv)) {
5382 const UV uv = SvUV(elemsv);
5383 elem = uv > IV_MAX ? IV_MAX : uv;
5385 else if (SvNOK(elemsv))
5386 elem = (IV)SvNV(elemsv);
5388 MEM_WRAP_CHECK_s(elem,SV*,"Out of memory during array extend");
5391 if (!svp || !*svp) {
5394 DIE(aTHX_ PL_no_aelem, elem);
5395 len = av_top_index(av);
5396 /* Resolve a negative index that falls within the array. Leave
5397 it negative it if falls outside the array. */
5398 if (elem < 0 && len + elem >= 0)
5400 if (elem >= 0 && elem <= len)
5401 /* Falls within the array. */
5402 PUSHs(av_nonelem(av,elem));
5404 /* Falls outside the array. If it is negative,
5405 magic_setdefelem will use the index for error reporting.
5407 mPUSHs(newSVavdefelem(av, elem, 1));
5410 if (UNLIKELY(localizing)) {
5412 save_aelem(av, elem, svp);
5414 SAVEADELETE(av, elem);
5416 else if (PL_op->op_private & OPpDEREF) {
5417 PUSHs(vivify_ref(*svp, PL_op->op_private & OPpDEREF));
5421 sv = (svp ? *svp : &PL_sv_undef);
5422 if (!lval && SvRMAGICAL(av) && SvGMAGICAL(sv)) /* see note in pp_helem() */
5429 Perl_vivify_ref(pTHX_ SV *sv, U32 to_what)
5431 PERL_ARGS_ASSERT_VIVIFY_REF;
5436 Perl_croak_no_modify();
5437 prepare_SV_for_RV(sv);
5440 SvRV_set(sv, newSV(0));
5443 SvRV_set(sv, MUTABLE_SV(newAV()));
5446 SvRV_set(sv, MUTABLE_SV(newHV()));
5453 if (SvGMAGICAL(sv)) {
5454 /* copy the sv without magic to prevent magic from being
5456 SV* msv = sv_newmortal();
5457 sv_setsv_nomg(msv, sv);
5463 PERL_STATIC_INLINE HV *
5464 S_opmethod_stash(pTHX_ SV* meth)
5469 SV* const sv = PL_stack_base + TOPMARK == PL_stack_sp
5470 ? (Perl_croak(aTHX_ "Can't call method \"%" SVf "\" without a "
5471 "package or object reference", SVfARG(meth)),
5473 : *(PL_stack_base + TOPMARK + 1);
5475 PERL_ARGS_ASSERT_OPMETHOD_STASH;
5479 Perl_croak(aTHX_ "Can't call method \"%" SVf "\" on an undefined value",
5482 if (UNLIKELY(SvGMAGICAL(sv))) mg_get(sv);
5483 else if (SvIsCOW_shared_hash(sv)) { /* MyClass->meth() */
5484 stash = gv_stashsv(sv, GV_CACHE_ONLY);
5485 if (stash) return stash;
5489 ob = MUTABLE_SV(SvRV(sv));
5490 else if (!SvOK(sv)) goto undefined;
5491 else if (isGV_with_GP(sv)) {
5493 Perl_croak(aTHX_ "Can't call method \"%" SVf "\" "
5494 "without a package or object reference",
5497 if (SvTYPE(ob) == SVt_PVLV && LvTYPE(ob) == 'y') {
5498 assert(!LvTARGLEN(ob));
5502 *(PL_stack_base + TOPMARK + 1) = sv_2mortal(newRV(ob));
5505 /* this isn't a reference */
5508 const char * const packname = SvPV_nomg_const(sv, packlen);
5509 const U32 packname_utf8 = SvUTF8(sv);
5510 stash = gv_stashpvn(packname, packlen, packname_utf8 | GV_CACHE_ONLY);
5511 if (stash) return stash;
5513 if (!(iogv = gv_fetchpvn_flags(
5514 packname, packlen, packname_utf8, SVt_PVIO
5516 !(ob=MUTABLE_SV(GvIO(iogv))))
5518 /* this isn't the name of a filehandle either */
5521 Perl_croak(aTHX_ "Can't call method \"%" SVf "\" "
5522 "without a package or object reference",
5525 /* assume it's a package name */
5526 stash = gv_stashpvn(packname, packlen, packname_utf8);
5527 if (stash) return stash;
5528 else return MUTABLE_HV(sv);
5530 /* it _is_ a filehandle name -- replace with a reference */
5531 *(PL_stack_base + TOPMARK + 1) = sv_2mortal(newRV(MUTABLE_SV(iogv)));
5534 /* if we got here, ob should be an object or a glob */
5535 if (!ob || !(SvOBJECT(ob)
5536 || (isGV_with_GP(ob)
5537 && (ob = MUTABLE_SV(GvIO((const GV *)ob)))
5540 Perl_croak(aTHX_ "Can't call method \"%" SVf "\" on unblessed reference",
5541 SVfARG((SvPOK(meth) && SvPVX(meth) == PL_isa_DOES)
5542 ? newSVpvs_flags("DOES", SVs_TEMP)
5554 SV* const meth = TOPs;
5557 SV* const rmeth = SvRV(meth);
5558 if (SvTYPE(rmeth) == SVt_PVCV) {
5564 stash = opmethod_stash(meth);
5566 gv = gv_fetchmethod_sv_flags(stash, meth, GV_AUTOLOAD|GV_CROAK);
5569 SETs(isGV(gv) ? MUTABLE_SV(GvCV(gv)) : MUTABLE_SV(gv));
5573 #define METHOD_CHECK_CACHE(stash,cache,meth) \
5574 const HE* const he = hv_fetch_ent(cache, meth, 0, 0); \
5576 gv = MUTABLE_GV(HeVAL(he)); \
5577 if (isGV(gv) && GvCV(gv) && (!GvCVGEN(gv) || GvCVGEN(gv) \
5578 == (PL_sub_generation + HvMROMETA(stash)->cache_gen))) \
5580 XPUSHs(MUTABLE_SV(GvCV(gv))); \
5589 SV* const meth = cMETHOPx_meth(PL_op);
5590 HV* const stash = opmethod_stash(meth);
5592 if (LIKELY(SvTYPE(stash) == SVt_PVHV)) {
5593 METHOD_CHECK_CACHE(stash, stash, meth);
5596 gv = gv_fetchmethod_sv_flags(stash, meth, GV_AUTOLOAD|GV_CROAK);
5599 XPUSHs(isGV(gv) ? MUTABLE_SV(GvCV(gv)) : MUTABLE_SV(gv));
5608 SV* const meth = cMETHOPx_meth(PL_op);
5609 HV* const stash = CopSTASH(PL_curcop);
5610 /* Actually, SUPER doesn't need real object's (or class') stash at all,
5611 * as it uses CopSTASH. However, we must ensure that object(class) is
5612 * correct (this check is done by S_opmethod_stash) */
5613 opmethod_stash(meth);
5615 if ((cache = HvMROMETA(stash)->super)) {
5616 METHOD_CHECK_CACHE(stash, cache, meth);
5619 gv = gv_fetchmethod_sv_flags(stash, meth, GV_AUTOLOAD|GV_CROAK|GV_SUPER);
5622 XPUSHs(isGV(gv) ? MUTABLE_SV(GvCV(gv)) : MUTABLE_SV(gv));
5630 SV* const meth = cMETHOPx_meth(PL_op);
5631 HV* stash = gv_stashsv(cMETHOPx_rclass(PL_op), 0);
5632 opmethod_stash(meth); /* not used but needed for error checks */
5634 if (stash) { METHOD_CHECK_CACHE(stash, stash, meth); }
5635 else stash = MUTABLE_HV(cMETHOPx_rclass(PL_op));
5637 gv = gv_fetchmethod_sv_flags(stash, meth, GV_AUTOLOAD|GV_CROAK);
5640 XPUSHs(isGV(gv) ? MUTABLE_SV(GvCV(gv)) : MUTABLE_SV(gv));
5644 PP(pp_method_redir_super)
5649 SV* const meth = cMETHOPx_meth(PL_op);
5650 HV* stash = gv_stashsv(cMETHOPx_rclass(PL_op), 0);
5651 opmethod_stash(meth); /* not used but needed for error checks */
5653 if (UNLIKELY(!stash)) stash = MUTABLE_HV(cMETHOPx_rclass(PL_op));
5654 else if ((cache = HvMROMETA(stash)->super)) {
5655 METHOD_CHECK_CACHE(stash, cache, meth);
5658 gv = gv_fetchmethod_sv_flags(stash, meth, GV_AUTOLOAD|GV_CROAK|GV_SUPER);
5661 XPUSHs(isGV(gv) ? MUTABLE_SV(GvCV(gv)) : MUTABLE_SV(gv));
5666 * ex: set ts=8 sts=4 sw=4 et: