This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
change "when" keyword to "whereso"
[perl5.git] / op.c
1 #line 2 "op.c"
2 /*    op.c
3  *
4  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
5  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
6  *
7  *    You may distribute under the terms of either the GNU General Public
8  *    License or the Artistic License, as specified in the README file.
9  *
10  */
11
12 /*
13  * 'You see: Mr. Drogo, he married poor Miss Primula Brandybuck.  She was
14  *  our Mr. Bilbo's first cousin on the mother's side (her mother being the
15  *  youngest of the Old Took's daughters); and Mr. Drogo was his second
16  *  cousin.  So Mr. Frodo is his first *and* second cousin, once removed
17  *  either way, as the saying is, if you follow me.'       --the Gaffer
18  *
19  *     [p.23 of _The Lord of the Rings_, I/i: "A Long-Expected Party"]
20  */
21
22 /* This file contains the functions that create, manipulate and optimize
23  * the OP structures that hold a compiled perl program.
24  *
25  * Note that during the build of miniperl, a temporary copy of this file
26  * is made, called opmini.c.
27  *
28  * A Perl program is compiled into a tree of OP nodes. Each op contains:
29  *  * structural OP pointers to its children and siblings (op_sibling,
30  *    op_first etc) that define the tree structure;
31  *  * execution order OP pointers (op_next, plus sometimes op_other,
32  *    op_lastop  etc) that define the execution sequence plus variants;
33  *  * a pointer to the C "pp" function that would execute the op;
34  *  * any data specific to that op.
35  * For example, an OP_CONST op points to the pp_const() function and to an
36  * SV containing the constant value. When pp_const() is executed, its job
37  * is to push that SV onto the stack.
38  *
39  * OPs are mainly created by the newFOO() functions, which are mainly
40  * called from the parser (in perly.y) as the code is parsed. For example
41  * the Perl code $a + $b * $c would cause the equivalent of the following
42  * to be called (oversimplifying a bit):
43  *
44  *  newBINOP(OP_ADD, flags,
45  *      newSVREF($a),
46  *      newBINOP(OP_MULTIPLY, flags, newSVREF($b), newSVREF($c))
47  *  )
48  *
49  * As the parser reduces low-level rules, it creates little op subtrees;
50  * as higher-level rules are resolved, these subtrees get joined together
51  * as branches on a bigger subtree, until eventually a top-level rule like
52  * a subroutine definition is reduced, at which point there is one large
53  * parse tree left.
54  *
55  * The execution order pointers (op_next) are generated as the subtrees
56  * are joined together. Consider this sub-expression: A*B + C/D: at the
57  * point when it's just been parsed, the op tree looks like:
58  *
59  *   [+]
60  *    |
61  *   [*]------[/]
62  *    |        |
63  *    A---B    C---D
64  *
65  * with the intended execution order being:
66  *
67  *   [PREV] => A => B => [*] => C => D => [/] =>  [+] => [NEXT]
68  *
69  * At this point all the nodes' op_next pointers will have been set,
70  * except that:
71  *    * we don't know what the [NEXT] node will be yet;
72  *    * we don't know what the [PREV] node will be yet, but when it gets
73  *      created and needs its op_next set, it needs to be set to point to
74  *      A, which is non-obvious.
75  * To handle both those cases, we temporarily set the top node's
76  * op_next to point to the first node to be executed in this subtree (A in
77  * this case). This means that initially a subtree's op_next chain,
78  * starting from the top node, will visit each node in execution sequence
79  * then point back at the top node.
80  * When we embed this subtree in a larger tree, its top op_next is used
81  * to get the start node, then is set to point to its new neighbour.
82  * For example the two separate [*],A,B and [/],C,D subtrees would
83  * initially have had:
84  *   [*] => A;  A => B;  B => [*]
85  * and
86  *   [/] => C;  C => D;  D => [/]
87  * When these two subtrees were joined together to make the [+] subtree,
88  * [+]'s op_next was set to [*]'s op_next, i.e. A; then [*]'s op_next was
89  * set to point to [/]'s op_next, i.e. C.
90  *
91  * This op_next linking is done by the LINKLIST() macro and its underlying
92  * op_linklist() function. Given a top-level op, if its op_next is
93  * non-null, it's already been linked, so leave it. Otherwise link it with
94  * its children as described above, possibly recursively if any of the
95  * children have a null op_next.
96  *
97  * In summary: given a subtree, its top-level node's op_next will either
98  * be:
99  *   NULL: the subtree hasn't been LINKLIST()ed yet;
100  *   fake: points to the start op for this subtree;
101  *   real: once the subtree has been embedded into a larger tree
102  */
103
104 /*
105
106 Here's an older description from Larry.
107
108 Perl's compiler is essentially a 3-pass compiler with interleaved phases:
109
110     A bottom-up pass
111     A top-down pass
112     An execution-order pass
113
114 The bottom-up pass is represented by all the "newOP" routines and
115 the ck_ routines.  The bottom-upness is actually driven by yacc.
116 So at the point that a ck_ routine fires, we have no idea what the
117 context is, either upward in the syntax tree, or either forward or
118 backward in the execution order.  (The bottom-up parser builds that
119 part of the execution order it knows about, but if you follow the "next"
120 links around, you'll find it's actually a closed loop through the
121 top level node.)
122
123 Whenever the bottom-up parser gets to a node that supplies context to
124 its components, it invokes that portion of the top-down pass that applies
125 to that part of the subtree (and marks the top node as processed, so
126 if a node further up supplies context, it doesn't have to take the
127 plunge again).  As a particular subcase of this, as the new node is
128 built, it takes all the closed execution loops of its subcomponents
129 and links them into a new closed loop for the higher level node.  But
130 it's still not the real execution order.
131
132 The actual execution order is not known till we get a grammar reduction
133 to a top-level unit like a subroutine or file that will be called by
134 "name" rather than via a "next" pointer.  At that point, we can call
135 into peep() to do that code's portion of the 3rd pass.  It has to be
136 recursive, but it's recursive on basic blocks, not on tree nodes.
137 */
138
139 /* To implement user lexical pragmas, there needs to be a way at run time to
140    get the compile time state of %^H for that block.  Storing %^H in every
141    block (or even COP) would be very expensive, so a different approach is
142    taken.  The (running) state of %^H is serialised into a tree of HE-like
143    structs.  Stores into %^H are chained onto the current leaf as a struct
144    refcounted_he * with the key and the value.  Deletes from %^H are saved
145    with a value of PL_sv_placeholder.  The state of %^H at any point can be
146    turned back into a regular HV by walking back up the tree from that point's
147    leaf, ignoring any key you've already seen (placeholder or not), storing
148    the rest into the HV structure, then removing the placeholders. Hence
149    memory is only used to store the %^H deltas from the enclosing COP, rather
150    than the entire %^H on each COP.
151
152    To cause actions on %^H to write out the serialisation records, it has
153    magic type 'H'. This magic (itself) does nothing, but its presence causes
154    the values to gain magic type 'h', which has entries for set and clear.
155    C<Perl_magic_sethint> updates C<PL_compiling.cop_hints_hash> with a store
156    record, with deletes written by C<Perl_magic_clearhint>. C<SAVEHINTS>
157    saves the current C<PL_compiling.cop_hints_hash> on the save stack, so that
158    it will be correctly restored when any inner compiling scope is exited.
159 */
160
161 #include "EXTERN.h"
162 #define PERL_IN_OP_C
163 #include "perl.h"
164 #include "keywords.h"
165 #include "feature.h"
166 #include "regcomp.h"
167
168 #define CALL_PEEP(o) PL_peepp(aTHX_ o)
169 #define CALL_RPEEP(o) PL_rpeepp(aTHX_ o)
170 #define CALL_OPFREEHOOK(o) if (PL_opfreehook) PL_opfreehook(aTHX_ o)
171
172 static const char array_passed_to_stat[] = "Array passed to stat will be coerced to a scalar";
173
174 /* Used to avoid recursion through the op tree in scalarvoid() and
175    op_free()
176 */
177
178 #define DEFERRED_OP_STEP 100
179 #define DEFER_OP(o) \
180   STMT_START { \
181     if (UNLIKELY(defer_ix == (defer_stack_alloc-1))) {    \
182         defer_stack_alloc += DEFERRED_OP_STEP; \
183         assert(defer_stack_alloc > 0); \
184         Renew(defer_stack, defer_stack_alloc, OP *); \
185     } \
186     defer_stack[++defer_ix] = o; \
187   } STMT_END
188
189 #define POP_DEFERRED_OP() (defer_ix >= 0 ? defer_stack[defer_ix--] : (OP *)NULL)
190
191 /* remove any leading "empty" ops from the op_next chain whose first
192  * node's address is stored in op_p. Store the updated address of the
193  * first node in op_p.
194  */
195
196 STATIC void
197 S_prune_chain_head(OP** op_p)
198 {
199     while (*op_p
200         && (   (*op_p)->op_type == OP_NULL
201             || (*op_p)->op_type == OP_SCOPE
202             || (*op_p)->op_type == OP_SCALAR
203             || (*op_p)->op_type == OP_LINESEQ)
204     )
205         *op_p = (*op_p)->op_next;
206 }
207
208
209 /* See the explanatory comments above struct opslab in op.h. */
210
211 #ifdef PERL_DEBUG_READONLY_OPS
212 #  define PERL_SLAB_SIZE 128
213 #  define PERL_MAX_SLAB_SIZE 4096
214 #  include <sys/mman.h>
215 #endif
216
217 #ifndef PERL_SLAB_SIZE
218 #  define PERL_SLAB_SIZE 64
219 #endif
220 #ifndef PERL_MAX_SLAB_SIZE
221 #  define PERL_MAX_SLAB_SIZE 2048
222 #endif
223
224 /* rounds up to nearest pointer */
225 #define SIZE_TO_PSIZE(x)        (((x) + sizeof(I32 *) - 1)/sizeof(I32 *))
226 #define DIFF(o,p)               ((size_t)((I32 **)(p) - (I32**)(o)))
227
228 static OPSLAB *
229 S_new_slab(pTHX_ size_t sz)
230 {
231 #ifdef PERL_DEBUG_READONLY_OPS
232     OPSLAB *slab = (OPSLAB *) mmap(0, sz * sizeof(I32 *),
233                                    PROT_READ|PROT_WRITE,
234                                    MAP_ANON|MAP_PRIVATE, -1, 0);
235     DEBUG_m(PerlIO_printf(Perl_debug_log, "mapped %lu at %p\n",
236                           (unsigned long) sz, slab));
237     if (slab == MAP_FAILED) {
238         perror("mmap failed");
239         abort();
240     }
241     slab->opslab_size = (U16)sz;
242 #else
243     OPSLAB *slab = (OPSLAB *)PerlMemShared_calloc(sz, sizeof(I32 *));
244 #endif
245 #ifndef WIN32
246     /* The context is unused in non-Windows */
247     PERL_UNUSED_CONTEXT;
248 #endif
249     slab->opslab_first = (OPSLOT *)((I32 **)slab + sz - 1);
250     return slab;
251 }
252
253 /* requires double parens and aTHX_ */
254 #define DEBUG_S_warn(args)                                             \
255     DEBUG_S(                                                            \
256         PerlIO_printf(Perl_debug_log, "%s", SvPVx_nolen(Perl_mess args)) \
257     )
258
259 void *
260 Perl_Slab_Alloc(pTHX_ size_t sz)
261 {
262     OPSLAB *slab;
263     OPSLAB *slab2;
264     OPSLOT *slot;
265     OP *o;
266     size_t opsz, space;
267
268     /* We only allocate ops from the slab during subroutine compilation.
269        We find the slab via PL_compcv, hence that must be non-NULL. It could
270        also be pointing to a subroutine which is now fully set up (CvROOT()
271        pointing to the top of the optree for that sub), or a subroutine
272        which isn't using the slab allocator. If our sanity checks aren't met,
273        don't use a slab, but allocate the OP directly from the heap.  */
274     if (!PL_compcv || CvROOT(PL_compcv)
275      || (CvSTART(PL_compcv) && !CvSLABBED(PL_compcv)))
276     {
277         o = (OP*)PerlMemShared_calloc(1, sz);
278         goto gotit;
279     }
280
281     /* While the subroutine is under construction, the slabs are accessed via
282        CvSTART(), to avoid needing to expand PVCV by one pointer for something
283        unneeded at runtime. Once a subroutine is constructed, the slabs are
284        accessed via CvROOT(). So if CvSTART() is NULL, no slab has been
285        allocated yet.  See the commit message for 8be227ab5eaa23f2 for more
286        details.  */
287     if (!CvSTART(PL_compcv)) {
288         CvSTART(PL_compcv) =
289             (OP *)(slab = S_new_slab(aTHX_ PERL_SLAB_SIZE));
290         CvSLABBED_on(PL_compcv);
291         slab->opslab_refcnt = 2; /* one for the CV; one for the new OP */
292     }
293     else ++(slab = (OPSLAB *)CvSTART(PL_compcv))->opslab_refcnt;
294
295     opsz = SIZE_TO_PSIZE(sz);
296     sz = opsz + OPSLOT_HEADER_P;
297
298     /* The slabs maintain a free list of OPs. In particular, constant folding
299        will free up OPs, so it makes sense to re-use them where possible. A
300        freed up slot is used in preference to a new allocation.  */
301     if (slab->opslab_freed) {
302         OP **too = &slab->opslab_freed;
303         o = *too;
304         DEBUG_S_warn((aTHX_ "found free op at %p, slab %p", (void*)o, (void*)slab));
305         while (o && DIFF(OpSLOT(o), OpSLOT(o)->opslot_next) < sz) {
306             DEBUG_S_warn((aTHX_ "Alas! too small"));
307             o = *(too = &o->op_next);
308             if (o) { DEBUG_S_warn((aTHX_ "found another free op at %p", (void*)o)); }
309         }
310         if (o) {
311             *too = o->op_next;
312             Zero(o, opsz, I32 *);
313             o->op_slabbed = 1;
314             goto gotit;
315         }
316     }
317
318 #define INIT_OPSLOT \
319             slot->opslot_slab = slab;                   \
320             slot->opslot_next = slab2->opslab_first;    \
321             slab2->opslab_first = slot;                 \
322             o = &slot->opslot_op;                       \
323             o->op_slabbed = 1
324
325     /* The partially-filled slab is next in the chain. */
326     slab2 = slab->opslab_next ? slab->opslab_next : slab;
327     if ((space = DIFF(&slab2->opslab_slots, slab2->opslab_first)) < sz) {
328         /* Remaining space is too small. */
329
330         /* If we can fit a BASEOP, add it to the free chain, so as not
331            to waste it. */
332         if (space >= SIZE_TO_PSIZE(sizeof(OP)) + OPSLOT_HEADER_P) {
333             slot = &slab2->opslab_slots;
334             INIT_OPSLOT;
335             o->op_type = OP_FREED;
336             o->op_next = slab->opslab_freed;
337             slab->opslab_freed = o;
338         }
339
340         /* Create a new slab.  Make this one twice as big. */
341         slot = slab2->opslab_first;
342         while (slot->opslot_next) slot = slot->opslot_next;
343         slab2 = S_new_slab(aTHX_
344                             (DIFF(slab2, slot)+1)*2 > PERL_MAX_SLAB_SIZE
345                                         ? PERL_MAX_SLAB_SIZE
346                                         : (DIFF(slab2, slot)+1)*2);
347         slab2->opslab_next = slab->opslab_next;
348         slab->opslab_next = slab2;
349     }
350     assert(DIFF(&slab2->opslab_slots, slab2->opslab_first) >= sz);
351
352     /* Create a new op slot */
353     slot = (OPSLOT *)((I32 **)slab2->opslab_first - sz);
354     assert(slot >= &slab2->opslab_slots);
355     if (DIFF(&slab2->opslab_slots, slot)
356          < SIZE_TO_PSIZE(sizeof(OP)) + OPSLOT_HEADER_P)
357         slot = &slab2->opslab_slots;
358     INIT_OPSLOT;
359     DEBUG_S_warn((aTHX_ "allocating op at %p, slab %p", (void*)o, (void*)slab));
360
361   gotit:
362 #ifdef PERL_OP_PARENT
363     /* moresib == 0, op_sibling == 0 implies a solitary unattached op */
364     assert(!o->op_moresib);
365     assert(!o->op_sibparent);
366 #endif
367
368     return (void *)o;
369 }
370
371 #undef INIT_OPSLOT
372
373 #ifdef PERL_DEBUG_READONLY_OPS
374 void
375 Perl_Slab_to_ro(pTHX_ OPSLAB *slab)
376 {
377     PERL_ARGS_ASSERT_SLAB_TO_RO;
378
379     if (slab->opslab_readonly) return;
380     slab->opslab_readonly = 1;
381     for (; slab; slab = slab->opslab_next) {
382         /*DEBUG_U(PerlIO_printf(Perl_debug_log,"mprotect ->ro %lu at %p\n",
383                               (unsigned long) slab->opslab_size, slab));*/
384         if (mprotect(slab, slab->opslab_size * sizeof(I32 *), PROT_READ))
385             Perl_warn(aTHX_ "mprotect for %p %lu failed with %d", slab,
386                              (unsigned long)slab->opslab_size, errno);
387     }
388 }
389
390 void
391 Perl_Slab_to_rw(pTHX_ OPSLAB *const slab)
392 {
393     OPSLAB *slab2;
394
395     PERL_ARGS_ASSERT_SLAB_TO_RW;
396
397     if (!slab->opslab_readonly) return;
398     slab2 = slab;
399     for (; slab2; slab2 = slab2->opslab_next) {
400         /*DEBUG_U(PerlIO_printf(Perl_debug_log,"mprotect ->rw %lu at %p\n",
401                               (unsigned long) size, slab2));*/
402         if (mprotect((void *)slab2, slab2->opslab_size * sizeof(I32 *),
403                      PROT_READ|PROT_WRITE)) {
404             Perl_warn(aTHX_ "mprotect RW for %p %lu failed with %d", slab,
405                              (unsigned long)slab2->opslab_size, errno);
406         }
407     }
408     slab->opslab_readonly = 0;
409 }
410
411 #else
412 #  define Slab_to_rw(op)    NOOP
413 #endif
414
415 /* This cannot possibly be right, but it was copied from the old slab
416    allocator, to which it was originally added, without explanation, in
417    commit 083fcd5. */
418 #ifdef NETWARE
419 #    define PerlMemShared PerlMem
420 #endif
421
422 /* make freed ops die if they're inadvertently executed */
423 #ifdef DEBUGGING
424 static OP *
425 S_pp_freed(pTHX)
426 {
427     DIE(aTHX_ "panic: freed op 0x%p called\n", PL_op);
428 }
429 #endif
430
431 void
432 Perl_Slab_Free(pTHX_ void *op)
433 {
434     OP * const o = (OP *)op;
435     OPSLAB *slab;
436
437     PERL_ARGS_ASSERT_SLAB_FREE;
438
439 #ifdef DEBUGGING
440     o->op_ppaddr = S_pp_freed;
441 #endif
442
443     if (!o->op_slabbed) {
444         if (!o->op_static)
445             PerlMemShared_free(op);
446         return;
447     }
448
449     slab = OpSLAB(o);
450     /* If this op is already freed, our refcount will get screwy. */
451     assert(o->op_type != OP_FREED);
452     o->op_type = OP_FREED;
453     o->op_next = slab->opslab_freed;
454     slab->opslab_freed = o;
455     DEBUG_S_warn((aTHX_ "free op at %p, recorded in slab %p", (void*)o, (void*)slab));
456     OpslabREFCNT_dec_padok(slab);
457 }
458
459 void
460 Perl_opslab_free_nopad(pTHX_ OPSLAB *slab)
461 {
462     const bool havepad = !!PL_comppad;
463     PERL_ARGS_ASSERT_OPSLAB_FREE_NOPAD;
464     if (havepad) {
465         ENTER;
466         PAD_SAVE_SETNULLPAD();
467     }
468     opslab_free(slab);
469     if (havepad) LEAVE;
470 }
471
472 void
473 Perl_opslab_free(pTHX_ OPSLAB *slab)
474 {
475     OPSLAB *slab2;
476     PERL_ARGS_ASSERT_OPSLAB_FREE;
477     PERL_UNUSED_CONTEXT;
478     DEBUG_S_warn((aTHX_ "freeing slab %p", (void*)slab));
479     assert(slab->opslab_refcnt == 1);
480     do {
481         slab2 = slab->opslab_next;
482 #ifdef DEBUGGING
483         slab->opslab_refcnt = ~(size_t)0;
484 #endif
485 #ifdef PERL_DEBUG_READONLY_OPS
486         DEBUG_m(PerlIO_printf(Perl_debug_log, "Deallocate slab at %p\n",
487                                                (void*)slab));
488         if (munmap(slab, slab->opslab_size * sizeof(I32 *))) {
489             perror("munmap failed");
490             abort();
491         }
492 #else
493         PerlMemShared_free(slab);
494 #endif
495         slab = slab2;
496     } while (slab);
497 }
498
499 void
500 Perl_opslab_force_free(pTHX_ OPSLAB *slab)
501 {
502     OPSLAB *slab2;
503 #ifdef DEBUGGING
504     size_t savestack_count = 0;
505 #endif
506     PERL_ARGS_ASSERT_OPSLAB_FORCE_FREE;
507     slab2 = slab;
508     do {
509         OPSLOT *slot;
510         for (slot = slab2->opslab_first;
511              slot->opslot_next;
512              slot = slot->opslot_next) {
513             if (slot->opslot_op.op_type != OP_FREED
514              && !(slot->opslot_op.op_savefree
515 #ifdef DEBUGGING
516                   && ++savestack_count
517 #endif
518                  )
519             ) {
520                 assert(slot->opslot_op.op_slabbed);
521                 op_free(&slot->opslot_op);
522                 if (slab->opslab_refcnt == 1) goto free;
523             }
524         }
525     } while ((slab2 = slab2->opslab_next));
526     /* > 1 because the CV still holds a reference count. */
527     if (slab->opslab_refcnt > 1) { /* still referenced by the savestack */
528 #ifdef DEBUGGING
529         assert(savestack_count == slab->opslab_refcnt-1);
530 #endif
531         /* Remove the CV’s reference count. */
532         slab->opslab_refcnt--;
533         return;
534     }
535    free:
536     opslab_free(slab);
537 }
538
539 #ifdef PERL_DEBUG_READONLY_OPS
540 OP *
541 Perl_op_refcnt_inc(pTHX_ OP *o)
542 {
543     if(o) {
544         OPSLAB *const slab = o->op_slabbed ? OpSLAB(o) : NULL;
545         if (slab && slab->opslab_readonly) {
546             Slab_to_rw(slab);
547             ++o->op_targ;
548             Slab_to_ro(slab);
549         } else {
550             ++o->op_targ;
551         }
552     }
553     return o;
554
555 }
556
557 PADOFFSET
558 Perl_op_refcnt_dec(pTHX_ OP *o)
559 {
560     PADOFFSET result;
561     OPSLAB *const slab = o->op_slabbed ? OpSLAB(o) : NULL;
562
563     PERL_ARGS_ASSERT_OP_REFCNT_DEC;
564
565     if (slab && slab->opslab_readonly) {
566         Slab_to_rw(slab);
567         result = --o->op_targ;
568         Slab_to_ro(slab);
569     } else {
570         result = --o->op_targ;
571     }
572     return result;
573 }
574 #endif
575 /*
576  * In the following definition, the ", (OP*)0" is just to make the compiler
577  * think the expression is of the right type: croak actually does a Siglongjmp.
578  */
579 #define CHECKOP(type,o) \
580     ((PL_op_mask && PL_op_mask[type])                           \
581      ? ( op_free((OP*)o),                                       \
582          Perl_croak(aTHX_ "'%s' trapped by operation mask", PL_op_desc[type]),  \
583          (OP*)0 )                                               \
584      : PL_check[type](aTHX_ (OP*)o))
585
586 #define RETURN_UNLIMITED_NUMBER (PERL_INT_MAX / 2)
587
588 #define OpTYPE_set(o,type) \
589     STMT_START {                                \
590         o->op_type = (OPCODE)type;              \
591         o->op_ppaddr = PL_ppaddr[type];         \
592     } STMT_END
593
594 STATIC OP *
595 S_no_fh_allowed(pTHX_ OP *o)
596 {
597     PERL_ARGS_ASSERT_NO_FH_ALLOWED;
598
599     yyerror(Perl_form(aTHX_ "Missing comma after first argument to %s function",
600                  OP_DESC(o)));
601     return o;
602 }
603
604 STATIC OP *
605 S_too_few_arguments_pv(pTHX_ OP *o, const char* name, U32 flags)
606 {
607     PERL_ARGS_ASSERT_TOO_FEW_ARGUMENTS_PV;
608     yyerror_pv(Perl_form(aTHX_ "Not enough arguments for %s", name), flags);
609     return o;
610 }
611  
612 STATIC OP *
613 S_too_many_arguments_pv(pTHX_ OP *o, const char *name, U32 flags)
614 {
615     PERL_ARGS_ASSERT_TOO_MANY_ARGUMENTS_PV;
616
617     yyerror_pv(Perl_form(aTHX_ "Too many arguments for %s", name), flags);
618     return o;
619 }
620
621 STATIC void
622 S_bad_type_pv(pTHX_ I32 n, const char *t, const OP *o, const OP *kid)
623 {
624     PERL_ARGS_ASSERT_BAD_TYPE_PV;
625
626     yyerror_pv(Perl_form(aTHX_ "Type of arg %d to %s must be %s (not %s)",
627                  (int)n, PL_op_desc[(o)->op_type], t, OP_DESC(kid)), 0);
628 }
629
630 /* remove flags var, its unused in all callers, move to to right end since gv
631   and kid are always the same */
632 STATIC void
633 S_bad_type_gv(pTHX_ I32 n, GV *gv, const OP *kid, const char *t)
634 {
635     SV * const namesv = cv_name((CV *)gv, NULL, 0);
636     PERL_ARGS_ASSERT_BAD_TYPE_GV;
637  
638     yyerror_pv(Perl_form(aTHX_ "Type of arg %d to %" SVf " must be %s (not %s)",
639                  (int)n, SVfARG(namesv), t, OP_DESC(kid)), SvUTF8(namesv));
640 }
641
642 STATIC void
643 S_no_bareword_allowed(pTHX_ OP *o)
644 {
645     PERL_ARGS_ASSERT_NO_BAREWORD_ALLOWED;
646
647     qerror(Perl_mess(aTHX_
648                      "Bareword \"%" SVf "\" not allowed while \"strict subs\" in use",
649                      SVfARG(cSVOPo_sv)));
650     o->op_private &= ~OPpCONST_STRICT; /* prevent warning twice about the same OP */
651 }
652
653 /* "register" allocation */
654
655 PADOFFSET
656 Perl_allocmy(pTHX_ const char *const name, const STRLEN len, const U32 flags)
657 {
658     PADOFFSET off;
659     const bool is_our = (PL_parser->in_my == KEY_our);
660
661     PERL_ARGS_ASSERT_ALLOCMY;
662
663     if (flags & ~SVf_UTF8)
664         Perl_croak(aTHX_ "panic: allocmy illegal flag bits 0x%" UVxf,
665                    (UV)flags);
666
667     /* complain about "my $<special_var>" etc etc */
668     if (   len
669         && !(  is_our
670             || isALPHA(name[1])
671             || (   (flags & SVf_UTF8)
672                 && isIDFIRST_utf8_safe((U8 *)name+1, name + len))
673             || (name[1] == '_' && len > 2)))
674     {
675         if (!(flags & SVf_UTF8 && UTF8_IS_START(name[1]))
676          && isASCII(name[1])
677          && (!isPRINT(name[1]) || strchr("\t\n\r\f", name[1]))) {
678             /* diag_listed_as: Can't use global %s in "%s" */
679             yyerror(Perl_form(aTHX_ "Can't use global %c^%c%.*s in \"%s\"",
680                               name[0], toCTRL(name[1]), (int)(len - 2), name + 2,
681                               PL_parser->in_my == KEY_state ? "state" : "my"));
682         } else {
683             yyerror_pv(Perl_form(aTHX_ "Can't use global %.*s in \"%s\"", (int) len, name,
684                               PL_parser->in_my == KEY_state ? "state" : "my"), flags & SVf_UTF8);
685         }
686     }
687
688     /* allocate a spare slot and store the name in that slot */
689
690     off = pad_add_name_pvn(name, len,
691                        (is_our ? padadd_OUR :
692                         PL_parser->in_my == KEY_state ? padadd_STATE : 0),
693                     PL_parser->in_my_stash,
694                     (is_our
695                         /* $_ is always in main::, even with our */
696                         ? (PL_curstash && !memEQs(name,len,"$_")
697                             ? PL_curstash
698                             : PL_defstash)
699                         : NULL
700                     )
701     );
702     /* anon sub prototypes contains state vars should always be cloned,
703      * otherwise the state var would be shared between anon subs */
704
705     if (PL_parser->in_my == KEY_state && CvANON(PL_compcv))
706         CvCLONE_on(PL_compcv);
707
708     return off;
709 }
710
711 /*
712 =head1 Optree Manipulation Functions
713
714 =for apidoc alloccopstash
715
716 Available only under threaded builds, this function allocates an entry in
717 C<PL_stashpad> for the stash passed to it.
718
719 =cut
720 */
721
722 #ifdef USE_ITHREADS
723 PADOFFSET
724 Perl_alloccopstash(pTHX_ HV *hv)
725 {
726     PADOFFSET off = 0, o = 1;
727     bool found_slot = FALSE;
728
729     PERL_ARGS_ASSERT_ALLOCCOPSTASH;
730
731     if (PL_stashpad[PL_stashpadix] == hv) return PL_stashpadix;
732
733     for (; o < PL_stashpadmax; ++o) {
734         if (PL_stashpad[o] == hv) return PL_stashpadix = o;
735         if (!PL_stashpad[o] || SvTYPE(PL_stashpad[o]) != SVt_PVHV)
736             found_slot = TRUE, off = o;
737     }
738     if (!found_slot) {
739         Renew(PL_stashpad, PL_stashpadmax + 10, HV *);
740         Zero(PL_stashpad + PL_stashpadmax, 10, HV *);
741         off = PL_stashpadmax;
742         PL_stashpadmax += 10;
743     }
744
745     PL_stashpad[PL_stashpadix = off] = hv;
746     return off;
747 }
748 #endif
749
750 /* free the body of an op without examining its contents.
751  * Always use this rather than FreeOp directly */
752
753 static void
754 S_op_destroy(pTHX_ OP *o)
755 {
756     FreeOp(o);
757 }
758
759 /* Destructor */
760
761 /*
762 =for apidoc Am|void|op_free|OP *o
763
764 Free an op.  Only use this when an op is no longer linked to from any
765 optree.
766
767 =cut
768 */
769
770 void
771 Perl_op_free(pTHX_ OP *o)
772 {
773     dVAR;
774     OPCODE type;
775     SSize_t defer_ix = -1;
776     SSize_t defer_stack_alloc = 0;
777     OP **defer_stack = NULL;
778
779     do {
780
781         /* Though ops may be freed twice, freeing the op after its slab is a
782            big no-no. */
783         assert(!o || !o->op_slabbed || OpSLAB(o)->opslab_refcnt != ~(size_t)0);
784         /* During the forced freeing of ops after compilation failure, kidops
785            may be freed before their parents. */
786         if (!o || o->op_type == OP_FREED)
787             continue;
788
789         type = o->op_type;
790
791         /* an op should only ever acquire op_private flags that we know about.
792          * If this fails, you may need to fix something in regen/op_private.
793          * Don't bother testing if:
794          *   * the op_ppaddr doesn't match the op; someone may have
795          *     overridden the op and be doing strange things with it;
796          *   * we've errored, as op flags are often left in an
797          *     inconsistent state then. Note that an error when
798          *     compiling the main program leaves PL_parser NULL, so
799          *     we can't spot faults in the main code, only
800          *     evaled/required code */
801 #ifdef DEBUGGING
802         if (   o->op_ppaddr == PL_ppaddr[o->op_type]
803             && PL_parser
804             && !PL_parser->error_count)
805         {
806             assert(!(o->op_private & ~PL_op_private_valid[type]));
807         }
808 #endif
809
810         if (o->op_private & OPpREFCOUNTED) {
811             switch (type) {
812             case OP_LEAVESUB:
813             case OP_LEAVESUBLV:
814             case OP_LEAVEEVAL:
815             case OP_LEAVE:
816             case OP_SCOPE:
817             case OP_LEAVEWRITE:
818                 {
819                 PADOFFSET refcnt;
820                 OP_REFCNT_LOCK;
821                 refcnt = OpREFCNT_dec(o);
822                 OP_REFCNT_UNLOCK;
823                 if (refcnt) {
824                     /* Need to find and remove any pattern match ops from the list
825                        we maintain for reset().  */
826                     find_and_forget_pmops(o);
827                     continue;
828                 }
829                 }
830                 break;
831             default:
832                 break;
833             }
834         }
835
836         /* Call the op_free hook if it has been set. Do it now so that it's called
837          * at the right time for refcounted ops, but still before all of the kids
838          * are freed. */
839         CALL_OPFREEHOOK(o);
840
841         if (o->op_flags & OPf_KIDS) {
842             OP *kid, *nextkid;
843             for (kid = cUNOPo->op_first; kid; kid = nextkid) {
844                 nextkid = OpSIBLING(kid); /* Get before next freeing kid */
845                 if (!kid || kid->op_type == OP_FREED)
846                     /* During the forced freeing of ops after
847                        compilation failure, kidops may be freed before
848                        their parents. */
849                     continue;
850                 if (!(kid->op_flags & OPf_KIDS))
851                     /* If it has no kids, just free it now */
852                     op_free(kid);
853                 else
854                     DEFER_OP(kid);
855             }
856         }
857         if (type == OP_NULL)
858             type = (OPCODE)o->op_targ;
859
860         if (o->op_slabbed)
861             Slab_to_rw(OpSLAB(o));
862
863         /* COP* is not cleared by op_clear() so that we may track line
864          * numbers etc even after null() */
865         if (type == OP_NEXTSTATE || type == OP_DBSTATE) {
866             cop_free((COP*)o);
867         }
868
869         op_clear(o);
870         FreeOp(o);
871         if (PL_op == o)
872             PL_op = NULL;
873     } while ( (o = POP_DEFERRED_OP()) );
874
875     Safefree(defer_stack);
876 }
877
878 /* S_op_clear_gv(): free a GV attached to an OP */
879
880 STATIC
881 #ifdef USE_ITHREADS
882 void S_op_clear_gv(pTHX_ OP *o, PADOFFSET *ixp)
883 #else
884 void S_op_clear_gv(pTHX_ OP *o, SV**svp)
885 #endif
886 {
887
888     GV *gv = (o->op_type == OP_GV || o->op_type == OP_GVSV
889             || o->op_type == OP_MULTIDEREF)
890 #ifdef USE_ITHREADS
891                 && PL_curpad
892                 ? ((GV*)PAD_SVl(*ixp)) : NULL;
893 #else
894                 ? (GV*)(*svp) : NULL;
895 #endif
896     /* It's possible during global destruction that the GV is freed
897        before the optree. Whilst the SvREFCNT_inc is happy to bump from
898        0 to 1 on a freed SV, the corresponding SvREFCNT_dec from 1 to 0
899        will trigger an assertion failure, because the entry to sv_clear
900        checks that the scalar is not already freed.  A check of for
901        !SvIS_FREED(gv) turns out to be invalid, because during global
902        destruction the reference count can be forced down to zero
903        (with SVf_BREAK set).  In which case raising to 1 and then
904        dropping to 0 triggers cleanup before it should happen.  I
905        *think* that this might actually be a general, systematic,
906        weakness of the whole idea of SVf_BREAK, in that code *is*
907        allowed to raise and lower references during global destruction,
908        so any *valid* code that happens to do this during global
909        destruction might well trigger premature cleanup.  */
910     bool still_valid = gv && SvREFCNT(gv);
911
912     if (still_valid)
913         SvREFCNT_inc_simple_void(gv);
914 #ifdef USE_ITHREADS
915     if (*ixp > 0) {
916         pad_swipe(*ixp, TRUE);
917         *ixp = 0;
918     }
919 #else
920     SvREFCNT_dec(*svp);
921     *svp = NULL;
922 #endif
923     if (still_valid) {
924         int try_downgrade = SvREFCNT(gv) == 2;
925         SvREFCNT_dec_NN(gv);
926         if (try_downgrade)
927             gv_try_downgrade(gv);
928     }
929 }
930
931
932 void
933 Perl_op_clear(pTHX_ OP *o)
934 {
935
936     dVAR;
937
938     PERL_ARGS_ASSERT_OP_CLEAR;
939
940     switch (o->op_type) {
941     case OP_NULL:       /* Was holding old type, if any. */
942         /* FALLTHROUGH */
943     case OP_ENTERTRY:
944     case OP_ENTEREVAL:  /* Was holding hints. */
945     case OP_ARGDEFELEM: /* Was holding signature index. */
946         o->op_targ = 0;
947         break;
948     default:
949         if (!(o->op_flags & OPf_REF)
950             || (PL_check[o->op_type] != Perl_ck_ftst))
951             break;
952         /* FALLTHROUGH */
953     case OP_GVSV:
954     case OP_GV:
955     case OP_AELEMFAST:
956 #ifdef USE_ITHREADS
957             S_op_clear_gv(aTHX_ o, &(cPADOPx(o)->op_padix));
958 #else
959             S_op_clear_gv(aTHX_ o, &(cSVOPx(o)->op_sv));
960 #endif
961         break;
962     case OP_METHOD_REDIR:
963     case OP_METHOD_REDIR_SUPER:
964 #ifdef USE_ITHREADS
965         if (cMETHOPx(o)->op_rclass_targ) {
966             pad_swipe(cMETHOPx(o)->op_rclass_targ, 1);
967             cMETHOPx(o)->op_rclass_targ = 0;
968         }
969 #else
970         SvREFCNT_dec(cMETHOPx(o)->op_rclass_sv);
971         cMETHOPx(o)->op_rclass_sv = NULL;
972 #endif
973         /* FALLTHROUGH */
974     case OP_METHOD_NAMED:
975     case OP_METHOD_SUPER:
976         SvREFCNT_dec(cMETHOPx(o)->op_u.op_meth_sv);
977         cMETHOPx(o)->op_u.op_meth_sv = NULL;
978 #ifdef USE_ITHREADS
979         if (o->op_targ) {
980             pad_swipe(o->op_targ, 1);
981             o->op_targ = 0;
982         }
983 #endif
984         break;
985     case OP_CONST:
986     case OP_HINTSEVAL:
987         SvREFCNT_dec(cSVOPo->op_sv);
988         cSVOPo->op_sv = NULL;
989 #ifdef USE_ITHREADS
990         /** Bug #15654
991           Even if op_clear does a pad_free for the target of the op,
992           pad_free doesn't actually remove the sv that exists in the pad;
993           instead it lives on. This results in that it could be reused as 
994           a target later on when the pad was reallocated.
995         **/
996         if(o->op_targ) {
997           pad_swipe(o->op_targ,1);
998           o->op_targ = 0;
999         }
1000 #endif
1001         break;
1002     case OP_DUMP:
1003     case OP_GOTO:
1004     case OP_NEXT:
1005     case OP_LAST:
1006     case OP_REDO:
1007         if (o->op_flags & (OPf_SPECIAL|OPf_STACKED|OPf_KIDS))
1008             break;
1009         /* FALLTHROUGH */
1010     case OP_TRANS:
1011     case OP_TRANSR:
1012         if (   (o->op_type == OP_TRANS || o->op_type == OP_TRANSR)
1013             && (o->op_private & (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF)))
1014         {
1015 #ifdef USE_ITHREADS
1016             if (cPADOPo->op_padix > 0) {
1017                 pad_swipe(cPADOPo->op_padix, TRUE);
1018                 cPADOPo->op_padix = 0;
1019             }
1020 #else
1021             SvREFCNT_dec(cSVOPo->op_sv);
1022             cSVOPo->op_sv = NULL;
1023 #endif
1024         }
1025         else {
1026             PerlMemShared_free(cPVOPo->op_pv);
1027             cPVOPo->op_pv = NULL;
1028         }
1029         break;
1030     case OP_SUBST:
1031         op_free(cPMOPo->op_pmreplrootu.op_pmreplroot);
1032         goto clear_pmop;
1033
1034     case OP_SPLIT:
1035         if (     (o->op_private & OPpSPLIT_ASSIGN) /* @array  = split */
1036             && !(o->op_flags & OPf_STACKED))       /* @{expr} = split */
1037         {
1038             if (o->op_private & OPpSPLIT_LEX)
1039                 pad_free(cPMOPo->op_pmreplrootu.op_pmtargetoff);
1040             else
1041 #ifdef USE_ITHREADS
1042                 pad_swipe(cPMOPo->op_pmreplrootu.op_pmtargetoff, TRUE);
1043 #else
1044                 SvREFCNT_dec(MUTABLE_SV(cPMOPo->op_pmreplrootu.op_pmtargetgv));
1045 #endif
1046         }
1047         /* FALLTHROUGH */
1048     case OP_MATCH:
1049     case OP_QR:
1050     clear_pmop:
1051         if (!(cPMOPo->op_pmflags & PMf_CODELIST_PRIVATE))
1052             op_free(cPMOPo->op_code_list);
1053         cPMOPo->op_code_list = NULL;
1054         forget_pmop(cPMOPo);
1055         cPMOPo->op_pmreplrootu.op_pmreplroot = NULL;
1056         /* we use the same protection as the "SAFE" version of the PM_ macros
1057          * here since sv_clean_all might release some PMOPs
1058          * after PL_regex_padav has been cleared
1059          * and the clearing of PL_regex_padav needs to
1060          * happen before sv_clean_all
1061          */
1062 #ifdef USE_ITHREADS
1063         if(PL_regex_pad) {        /* We could be in destruction */
1064             const IV offset = (cPMOPo)->op_pmoffset;
1065             ReREFCNT_dec(PM_GETRE(cPMOPo));
1066             PL_regex_pad[offset] = &PL_sv_undef;
1067             sv_catpvn_nomg(PL_regex_pad[0], (const char *)&offset,
1068                            sizeof(offset));
1069         }
1070 #else
1071         ReREFCNT_dec(PM_GETRE(cPMOPo));
1072         PM_SETRE(cPMOPo, NULL);
1073 #endif
1074
1075         break;
1076
1077     case OP_ARGCHECK:
1078         PerlMemShared_free(cUNOP_AUXo->op_aux);
1079         break;
1080
1081     case OP_MULTICONCAT:
1082         {
1083             UNOP_AUX_item *aux = cUNOP_AUXo->op_aux;
1084             /* aux[PERL_MULTICONCAT_IX_PLAIN_PV] and/or
1085              * aux[PERL_MULTICONCAT_IX_UTF8_PV] point to plain and/or
1086              * utf8 shared strings */
1087             char *p1 = aux[PERL_MULTICONCAT_IX_PLAIN_PV].pv;
1088             char *p2 = aux[PERL_MULTICONCAT_IX_UTF8_PV].pv;
1089             if (p1)
1090                 PerlMemShared_free(p1);
1091             if (p2 && p1 != p2)
1092                 PerlMemShared_free(p2);
1093             PerlMemShared_free(aux);
1094         }
1095         break;
1096
1097     case OP_MULTIDEREF:
1098         {
1099             UNOP_AUX_item *items = cUNOP_AUXo->op_aux;
1100             UV actions = items->uv;
1101             bool last = 0;
1102             bool is_hash = FALSE;
1103
1104             while (!last) {
1105                 switch (actions & MDEREF_ACTION_MASK) {
1106
1107                 case MDEREF_reload:
1108                     actions = (++items)->uv;
1109                     continue;
1110
1111                 case MDEREF_HV_padhv_helem:
1112                     is_hash = TRUE;
1113                     /* FALLTHROUGH */
1114                 case MDEREF_AV_padav_aelem:
1115                     pad_free((++items)->pad_offset);
1116                     goto do_elem;
1117
1118                 case MDEREF_HV_gvhv_helem:
1119                     is_hash = TRUE;
1120                     /* FALLTHROUGH */
1121                 case MDEREF_AV_gvav_aelem:
1122 #ifdef USE_ITHREADS
1123                     S_op_clear_gv(aTHX_ o, &((++items)->pad_offset));
1124 #else
1125                     S_op_clear_gv(aTHX_ o, &((++items)->sv));
1126 #endif
1127                     goto do_elem;
1128
1129                 case MDEREF_HV_gvsv_vivify_rv2hv_helem:
1130                     is_hash = TRUE;
1131                     /* FALLTHROUGH */
1132                 case MDEREF_AV_gvsv_vivify_rv2av_aelem:
1133 #ifdef USE_ITHREADS
1134                     S_op_clear_gv(aTHX_ o, &((++items)->pad_offset));
1135 #else
1136                     S_op_clear_gv(aTHX_ o, &((++items)->sv));
1137 #endif
1138                     goto do_vivify_rv2xv_elem;
1139
1140                 case MDEREF_HV_padsv_vivify_rv2hv_helem:
1141                     is_hash = TRUE;
1142                     /* FALLTHROUGH */
1143                 case MDEREF_AV_padsv_vivify_rv2av_aelem:
1144                     pad_free((++items)->pad_offset);
1145                     goto do_vivify_rv2xv_elem;
1146
1147                 case MDEREF_HV_pop_rv2hv_helem:
1148                 case MDEREF_HV_vivify_rv2hv_helem:
1149                     is_hash = TRUE;
1150                     /* FALLTHROUGH */
1151                 do_vivify_rv2xv_elem:
1152                 case MDEREF_AV_pop_rv2av_aelem:
1153                 case MDEREF_AV_vivify_rv2av_aelem:
1154                 do_elem:
1155                     switch (actions & MDEREF_INDEX_MASK) {
1156                     case MDEREF_INDEX_none:
1157                         last = 1;
1158                         break;
1159                     case MDEREF_INDEX_const:
1160                         if (is_hash) {
1161 #ifdef USE_ITHREADS
1162                             /* see RT #15654 */
1163                             pad_swipe((++items)->pad_offset, 1);
1164 #else
1165                             SvREFCNT_dec((++items)->sv);
1166 #endif
1167                         }
1168                         else
1169                             items++;
1170                         break;
1171                     case MDEREF_INDEX_padsv:
1172                         pad_free((++items)->pad_offset);
1173                         break;
1174                     case MDEREF_INDEX_gvsv:
1175 #ifdef USE_ITHREADS
1176                         S_op_clear_gv(aTHX_ o, &((++items)->pad_offset));
1177 #else
1178                         S_op_clear_gv(aTHX_ o, &((++items)->sv));
1179 #endif
1180                         break;
1181                     }
1182
1183                     if (actions & MDEREF_FLAG_last)
1184                         last = 1;
1185                     is_hash = FALSE;
1186
1187                     break;
1188
1189                 default:
1190                     assert(0);
1191                     last = 1;
1192                     break;
1193
1194                 } /* switch */
1195
1196                 actions >>= MDEREF_SHIFT;
1197             } /* while */
1198
1199             /* start of malloc is at op_aux[-1], where the length is
1200              * stored */
1201             PerlMemShared_free(cUNOP_AUXo->op_aux - 1);
1202         }
1203         break;
1204     }
1205
1206     if (o->op_targ > 0) {
1207         pad_free(o->op_targ);
1208         o->op_targ = 0;
1209     }
1210 }
1211
1212 STATIC void
1213 S_cop_free(pTHX_ COP* cop)
1214 {
1215     PERL_ARGS_ASSERT_COP_FREE;
1216
1217     CopFILE_free(cop);
1218     if (! specialWARN(cop->cop_warnings))
1219         PerlMemShared_free(cop->cop_warnings);
1220     cophh_free(CopHINTHASH_get(cop));
1221     if (PL_curcop == cop)
1222        PL_curcop = NULL;
1223 }
1224
1225 STATIC void
1226 S_forget_pmop(pTHX_ PMOP *const o
1227               )
1228 {
1229     HV * const pmstash = PmopSTASH(o);
1230
1231     PERL_ARGS_ASSERT_FORGET_PMOP;
1232
1233     if (pmstash && !SvIS_FREED(pmstash) && SvMAGICAL(pmstash)) {
1234         MAGIC * const mg = mg_find((const SV *)pmstash, PERL_MAGIC_symtab);
1235         if (mg) {
1236             PMOP **const array = (PMOP**) mg->mg_ptr;
1237             U32 count = mg->mg_len / sizeof(PMOP**);
1238             U32 i = count;
1239
1240             while (i--) {
1241                 if (array[i] == o) {
1242                     /* Found it. Move the entry at the end to overwrite it.  */
1243                     array[i] = array[--count];
1244                     mg->mg_len = count * sizeof(PMOP**);
1245                     /* Could realloc smaller at this point always, but probably
1246                        not worth it. Probably worth free()ing if we're the
1247                        last.  */
1248                     if(!count) {
1249                         Safefree(mg->mg_ptr);
1250                         mg->mg_ptr = NULL;
1251                     }
1252                     break;
1253                 }
1254             }
1255         }
1256     }
1257     if (PL_curpm == o) 
1258         PL_curpm = NULL;
1259 }
1260
1261 STATIC void
1262 S_find_and_forget_pmops(pTHX_ OP *o)
1263 {
1264     PERL_ARGS_ASSERT_FIND_AND_FORGET_PMOPS;
1265
1266     if (o->op_flags & OPf_KIDS) {
1267         OP *kid = cUNOPo->op_first;
1268         while (kid) {
1269             switch (kid->op_type) {
1270             case OP_SUBST:
1271             case OP_SPLIT:
1272             case OP_MATCH:
1273             case OP_QR:
1274                 forget_pmop((PMOP*)kid);
1275             }
1276             find_and_forget_pmops(kid);
1277             kid = OpSIBLING(kid);
1278         }
1279     }
1280 }
1281
1282 /*
1283 =for apidoc Am|void|op_null|OP *o
1284
1285 Neutralizes an op when it is no longer needed, but is still linked to from
1286 other ops.
1287
1288 =cut
1289 */
1290
1291 void
1292 Perl_op_null(pTHX_ OP *o)
1293 {
1294     dVAR;
1295
1296     PERL_ARGS_ASSERT_OP_NULL;
1297
1298     if (o->op_type == OP_NULL)
1299         return;
1300     op_clear(o);
1301     o->op_targ = o->op_type;
1302     OpTYPE_set(o, OP_NULL);
1303 }
1304
1305 void
1306 Perl_op_refcnt_lock(pTHX)
1307   PERL_TSA_ACQUIRE(PL_op_mutex)
1308 {
1309 #ifdef USE_ITHREADS
1310     dVAR;
1311 #endif
1312     PERL_UNUSED_CONTEXT;
1313     OP_REFCNT_LOCK;
1314 }
1315
1316 void
1317 Perl_op_refcnt_unlock(pTHX)
1318   PERL_TSA_RELEASE(PL_op_mutex)
1319 {
1320 #ifdef USE_ITHREADS
1321     dVAR;
1322 #endif
1323     PERL_UNUSED_CONTEXT;
1324     OP_REFCNT_UNLOCK;
1325 }
1326
1327
1328 /*
1329 =for apidoc op_sibling_splice
1330
1331 A general function for editing the structure of an existing chain of
1332 op_sibling nodes.  By analogy with the perl-level C<splice()> function, allows
1333 you to delete zero or more sequential nodes, replacing them with zero or
1334 more different nodes.  Performs the necessary op_first/op_last
1335 housekeeping on the parent node and op_sibling manipulation on the
1336 children.  The last deleted node will be marked as as the last node by
1337 updating the op_sibling/op_sibparent or op_moresib field as appropriate.
1338
1339 Note that op_next is not manipulated, and nodes are not freed; that is the
1340 responsibility of the caller.  It also won't create a new list op for an
1341 empty list etc; use higher-level functions like op_append_elem() for that.
1342
1343 C<parent> is the parent node of the sibling chain. It may passed as C<NULL> if
1344 the splicing doesn't affect the first or last op in the chain.
1345
1346 C<start> is the node preceding the first node to be spliced.  Node(s)
1347 following it will be deleted, and ops will be inserted after it.  If it is
1348 C<NULL>, the first node onwards is deleted, and nodes are inserted at the
1349 beginning.
1350
1351 C<del_count> is the number of nodes to delete.  If zero, no nodes are deleted.
1352 If -1 or greater than or equal to the number of remaining kids, all
1353 remaining kids are deleted.
1354
1355 C<insert> is the first of a chain of nodes to be inserted in place of the nodes.
1356 If C<NULL>, no nodes are inserted.
1357
1358 The head of the chain of deleted ops is returned, or C<NULL> if no ops were
1359 deleted.
1360
1361 For example:
1362
1363     action                    before      after         returns
1364     ------                    -----       -----         -------
1365
1366                               P           P
1367     splice(P, A, 2, X-Y-Z)    |           |             B-C
1368                               A-B-C-D     A-X-Y-Z-D
1369
1370                               P           P
1371     splice(P, NULL, 1, X-Y)   |           |             A
1372                               A-B-C-D     X-Y-B-C-D
1373
1374                               P           P
1375     splice(P, NULL, 3, NULL)  |           |             A-B-C
1376                               A-B-C-D     D
1377
1378                               P           P
1379     splice(P, B, 0, X-Y)      |           |             NULL
1380                               A-B-C-D     A-B-X-Y-C-D
1381
1382
1383 For lower-level direct manipulation of C<op_sibparent> and C<op_moresib>,
1384 see C<L</OpMORESIB_set>>, C<L</OpLASTSIB_set>>, C<L</OpMAYBESIB_set>>.
1385
1386 =cut
1387 */
1388
1389 OP *
1390 Perl_op_sibling_splice(OP *parent, OP *start, int del_count, OP* insert)
1391 {
1392     OP *first;
1393     OP *rest;
1394     OP *last_del = NULL;
1395     OP *last_ins = NULL;
1396
1397     if (start)
1398         first = OpSIBLING(start);
1399     else if (!parent)
1400         goto no_parent;
1401     else
1402         first = cLISTOPx(parent)->op_first;
1403
1404     assert(del_count >= -1);
1405
1406     if (del_count && first) {
1407         last_del = first;
1408         while (--del_count && OpHAS_SIBLING(last_del))
1409             last_del = OpSIBLING(last_del);
1410         rest = OpSIBLING(last_del);
1411         OpLASTSIB_set(last_del, NULL);
1412     }
1413     else
1414         rest = first;
1415
1416     if (insert) {
1417         last_ins = insert;
1418         while (OpHAS_SIBLING(last_ins))
1419             last_ins = OpSIBLING(last_ins);
1420         OpMAYBESIB_set(last_ins, rest, NULL);
1421     }
1422     else
1423         insert = rest;
1424
1425     if (start) {
1426         OpMAYBESIB_set(start, insert, NULL);
1427     }
1428     else {
1429         if (!parent)
1430             goto no_parent;
1431         cLISTOPx(parent)->op_first = insert;
1432         if (insert)
1433             parent->op_flags |= OPf_KIDS;
1434         else
1435             parent->op_flags &= ~OPf_KIDS;
1436     }
1437
1438     if (!rest) {
1439         /* update op_last etc */
1440         U32 type;
1441         OP *lastop;
1442
1443         if (!parent)
1444             goto no_parent;
1445
1446         /* ought to use OP_CLASS(parent) here, but that can't handle
1447          * ex-foo OP_NULL ops. Also note that XopENTRYCUSTOM() can't
1448          * either */
1449         type = parent->op_type;
1450         if (type == OP_CUSTOM) {
1451             dTHX;
1452             type = XopENTRYCUSTOM(parent, xop_class);
1453         }
1454         else {
1455             if (type == OP_NULL)
1456                 type = parent->op_targ;
1457             type = PL_opargs[type] & OA_CLASS_MASK;
1458         }
1459
1460         lastop = last_ins ? last_ins : start ? start : NULL;
1461         if (   type == OA_BINOP
1462             || type == OA_LISTOP
1463             || type == OA_PMOP
1464             || type == OA_LOOP
1465         )
1466             cLISTOPx(parent)->op_last = lastop;
1467
1468         if (lastop)
1469             OpLASTSIB_set(lastop, parent);
1470     }
1471     return last_del ? first : NULL;
1472
1473   no_parent:
1474     Perl_croak_nocontext("panic: op_sibling_splice(): NULL parent");
1475 }
1476
1477
1478 #ifdef PERL_OP_PARENT
1479
1480 /*
1481 =for apidoc op_parent
1482
1483 Returns the parent OP of C<o>, if it has a parent. Returns C<NULL> otherwise.
1484 This function is only available on perls built with C<-DPERL_OP_PARENT>.
1485
1486 =cut
1487 */
1488
1489 OP *
1490 Perl_op_parent(OP *o)
1491 {
1492     PERL_ARGS_ASSERT_OP_PARENT;
1493     while (OpHAS_SIBLING(o))
1494         o = OpSIBLING(o);
1495     return o->op_sibparent;
1496 }
1497
1498 #endif
1499
1500
1501 /* replace the sibling following start with a new UNOP, which becomes
1502  * the parent of the original sibling; e.g.
1503  *
1504  *  op_sibling_newUNOP(P, A, unop-args...)
1505  *
1506  *  P              P
1507  *  |      becomes |
1508  *  A-B-C          A-U-C
1509  *                   |
1510  *                   B
1511  *
1512  * where U is the new UNOP.
1513  *
1514  * parent and start args are the same as for op_sibling_splice();
1515  * type and flags args are as newUNOP().
1516  *
1517  * Returns the new UNOP.
1518  */
1519
1520 STATIC OP *
1521 S_op_sibling_newUNOP(pTHX_ OP *parent, OP *start, I32 type, I32 flags)
1522 {
1523     OP *kid, *newop;
1524
1525     kid = op_sibling_splice(parent, start, 1, NULL);
1526     newop = newUNOP(type, flags, kid);
1527     op_sibling_splice(parent, start, 0, newop);
1528     return newop;
1529 }
1530
1531
1532 /* lowest-level newLOGOP-style function - just allocates and populates
1533  * the struct. Higher-level stuff should be done by S_new_logop() /
1534  * newLOGOP(). This function exists mainly to avoid op_first assignment
1535  * being spread throughout this file.
1536  */
1537
1538 LOGOP *
1539 Perl_alloc_LOGOP(pTHX_ I32 type, OP *first, OP* other)
1540 {
1541     dVAR;
1542     LOGOP *logop;
1543     OP *kid = first;
1544     NewOp(1101, logop, 1, LOGOP);
1545     OpTYPE_set(logop, type);
1546     logop->op_first = first;
1547     logop->op_other = other;
1548     logop->op_flags = OPf_KIDS;
1549     while (kid && OpHAS_SIBLING(kid))
1550         kid = OpSIBLING(kid);
1551     if (kid)
1552         OpLASTSIB_set(kid, (OP*)logop);
1553     return logop;
1554 }
1555
1556
1557 /* Contextualizers */
1558
1559 /*
1560 =for apidoc Am|OP *|op_contextualize|OP *o|I32 context
1561
1562 Applies a syntactic context to an op tree representing an expression.
1563 C<o> is the op tree, and C<context> must be C<G_SCALAR>, C<G_ARRAY>,
1564 or C<G_VOID> to specify the context to apply.  The modified op tree
1565 is returned.
1566
1567 =cut
1568 */
1569
1570 OP *
1571 Perl_op_contextualize(pTHX_ OP *o, I32 context)
1572 {
1573     PERL_ARGS_ASSERT_OP_CONTEXTUALIZE;
1574     switch (context) {
1575         case G_SCALAR: return scalar(o);
1576         case G_ARRAY:  return list(o);
1577         case G_VOID:   return scalarvoid(o);
1578         default:
1579             Perl_croak(aTHX_ "panic: op_contextualize bad context %ld",
1580                        (long) context);
1581     }
1582 }
1583
1584 /*
1585
1586 =for apidoc Am|OP*|op_linklist|OP *o
1587 This function is the implementation of the L</LINKLIST> macro.  It should
1588 not be called directly.
1589
1590 =cut
1591 */
1592
1593 OP *
1594 Perl_op_linklist(pTHX_ OP *o)
1595 {
1596     OP *first;
1597
1598     PERL_ARGS_ASSERT_OP_LINKLIST;
1599
1600     if (o->op_next)
1601         return o->op_next;
1602
1603     /* establish postfix order */
1604     first = cUNOPo->op_first;
1605     if (first) {
1606         OP *kid;
1607         o->op_next = LINKLIST(first);
1608         kid = first;
1609         for (;;) {
1610             OP *sibl = OpSIBLING(kid);
1611             if (sibl) {
1612                 kid->op_next = LINKLIST(sibl);
1613                 kid = sibl;
1614             } else {
1615                 kid->op_next = o;
1616                 break;
1617             }
1618         }
1619     }
1620     else
1621         o->op_next = o;
1622
1623     return o->op_next;
1624 }
1625
1626 static OP *
1627 S_scalarkids(pTHX_ OP *o)
1628 {
1629     if (o && o->op_flags & OPf_KIDS) {
1630         OP *kid;
1631         for (kid = cLISTOPo->op_first; kid; kid = OpSIBLING(kid))
1632             scalar(kid);
1633     }
1634     return o;
1635 }
1636
1637 STATIC OP *
1638 S_scalarboolean(pTHX_ OP *o)
1639 {
1640     PERL_ARGS_ASSERT_SCALARBOOLEAN;
1641
1642     if ((o->op_type == OP_SASSIGN && cBINOPo->op_first->op_type == OP_CONST &&
1643          !(cBINOPo->op_first->op_flags & OPf_SPECIAL)) ||
1644         (o->op_type == OP_NOT     && cUNOPo->op_first->op_type == OP_SASSIGN &&
1645          cBINOPx(cUNOPo->op_first)->op_first->op_type == OP_CONST &&
1646          !(cBINOPx(cUNOPo->op_first)->op_first->op_flags & OPf_SPECIAL))) {
1647         if (ckWARN(WARN_SYNTAX)) {
1648             const line_t oldline = CopLINE(PL_curcop);
1649
1650             if (PL_parser && PL_parser->copline != NOLINE) {
1651                 /* This ensures that warnings are reported at the first line
1652                    of the conditional, not the last.  */
1653                 CopLINE_set(PL_curcop, PL_parser->copline);
1654             }
1655             Perl_warner(aTHX_ packWARN(WARN_SYNTAX), "Found = in conditional, should be ==");
1656             CopLINE_set(PL_curcop, oldline);
1657         }
1658     }
1659     return scalar(o);
1660 }
1661
1662 static SV *
1663 S_op_varname_subscript(pTHX_ const OP *o, int subscript_type)
1664 {
1665     assert(o);
1666     assert(o->op_type == OP_PADAV || o->op_type == OP_RV2AV ||
1667            o->op_type == OP_PADHV || o->op_type == OP_RV2HV);
1668     {
1669         const char funny  = o->op_type == OP_PADAV
1670                          || o->op_type == OP_RV2AV ? '@' : '%';
1671         if (o->op_type == OP_RV2AV || o->op_type == OP_RV2HV) {
1672             GV *gv;
1673             if (cUNOPo->op_first->op_type != OP_GV
1674              || !(gv = cGVOPx_gv(cUNOPo->op_first)))
1675                 return NULL;
1676             return varname(gv, funny, 0, NULL, 0, subscript_type);
1677         }
1678         return
1679             varname(MUTABLE_GV(PL_compcv), funny, o->op_targ, NULL, 0, subscript_type);
1680     }
1681 }
1682
1683 static SV *
1684 S_op_varname(pTHX_ const OP *o)
1685 {
1686     return S_op_varname_subscript(aTHX_ o, 1);
1687 }
1688
1689 static void
1690 S_op_pretty(pTHX_ const OP *o, SV **retsv, const char **retpv)
1691 { /* or not so pretty :-) */
1692     if (o->op_type == OP_CONST) {
1693         *retsv = cSVOPo_sv;
1694         if (SvPOK(*retsv)) {
1695             SV *sv = *retsv;
1696             *retsv = sv_newmortal();
1697             pv_pretty(*retsv, SvPVX_const(sv), SvCUR(sv), 32, NULL, NULL,
1698                       PERL_PV_PRETTY_DUMP |PERL_PV_ESCAPE_UNI_DETECT);
1699         }
1700         else if (!SvOK(*retsv))
1701             *retpv = "undef";
1702     }
1703     else *retpv = "...";
1704 }
1705
1706 static void
1707 S_scalar_slice_warning(pTHX_ const OP *o)
1708 {
1709     OP *kid;
1710     const bool h = o->op_type == OP_HSLICE
1711                 || (o->op_type == OP_NULL && o->op_targ == OP_HSLICE);
1712     const char lbrack =
1713         h ? '{' : '[';
1714     const char rbrack =
1715         h ? '}' : ']';
1716     SV *name;
1717     SV *keysv = NULL; /* just to silence compiler warnings */
1718     const char *key = NULL;
1719
1720     if (!(o->op_private & OPpSLICEWARNING))
1721         return;
1722     if (PL_parser && PL_parser->error_count)
1723         /* This warning can be nonsensical when there is a syntax error. */
1724         return;
1725
1726     kid = cLISTOPo->op_first;
1727     kid = OpSIBLING(kid); /* get past pushmark */
1728     /* weed out false positives: any ops that can return lists */
1729     switch (kid->op_type) {
1730     case OP_BACKTICK:
1731     case OP_GLOB:
1732     case OP_READLINE:
1733     case OP_MATCH:
1734     case OP_RV2AV:
1735     case OP_EACH:
1736     case OP_VALUES:
1737     case OP_KEYS:
1738     case OP_SPLIT:
1739     case OP_LIST:
1740     case OP_SORT:
1741     case OP_REVERSE:
1742     case OP_ENTERSUB:
1743     case OP_CALLER:
1744     case OP_LSTAT:
1745     case OP_STAT:
1746     case OP_READDIR:
1747     case OP_SYSTEM:
1748     case OP_TMS:
1749     case OP_LOCALTIME:
1750     case OP_GMTIME:
1751     case OP_ENTEREVAL:
1752         return;
1753     }
1754
1755     /* Don't warn if we have a nulled list either. */
1756     if (kid->op_type == OP_NULL && kid->op_targ == OP_LIST)
1757         return;
1758
1759     assert(OpSIBLING(kid));
1760     name = S_op_varname(aTHX_ OpSIBLING(kid));
1761     if (!name) /* XS module fiddling with the op tree */
1762         return;
1763     S_op_pretty(aTHX_ kid, &keysv, &key);
1764     assert(SvPOK(name));
1765     sv_chop(name,SvPVX(name)+1);
1766     if (key)
1767        /* diag_listed_as: Scalar value @%s[%s] better written as $%s[%s] */
1768         Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
1769                    "Scalar value @%" SVf "%c%s%c better written as $%" SVf
1770                    "%c%s%c",
1771                     SVfARG(name), lbrack, key, rbrack, SVfARG(name),
1772                     lbrack, key, rbrack);
1773     else
1774        /* diag_listed_as: Scalar value @%s[%s] better written as $%s[%s] */
1775         Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
1776                    "Scalar value @%" SVf "%c%" SVf "%c better written as $%"
1777                     SVf "%c%" SVf "%c",
1778                     SVfARG(name), lbrack, SVfARG(keysv), rbrack,
1779                     SVfARG(name), lbrack, SVfARG(keysv), rbrack);
1780 }
1781
1782 OP *
1783 Perl_scalar(pTHX_ OP *o)
1784 {
1785     OP *kid;
1786
1787     /* assumes no premature commitment */
1788     if (!o || (PL_parser && PL_parser->error_count)
1789          || (o->op_flags & OPf_WANT)
1790          || o->op_type == OP_RETURN)
1791     {
1792         return o;
1793     }
1794
1795     o->op_flags = (o->op_flags & ~OPf_WANT) | OPf_WANT_SCALAR;
1796
1797     switch (o->op_type) {
1798     case OP_REPEAT:
1799         scalar(cBINOPo->op_first);
1800         if (o->op_private & OPpREPEAT_DOLIST) {
1801             kid = cLISTOPx(cUNOPo->op_first)->op_first;
1802             assert(kid->op_type == OP_PUSHMARK);
1803             if (OpHAS_SIBLING(kid) && !OpHAS_SIBLING(OpSIBLING(kid))) {
1804                 op_null(cLISTOPx(cUNOPo->op_first)->op_first);
1805                 o->op_private &=~ OPpREPEAT_DOLIST;
1806             }
1807         }
1808         break;
1809     case OP_OR:
1810     case OP_AND:
1811     case OP_COND_EXPR:
1812         for (kid = OpSIBLING(cUNOPo->op_first); kid; kid = OpSIBLING(kid))
1813             scalar(kid);
1814         break;
1815         /* FALLTHROUGH */
1816     case OP_SPLIT:
1817     case OP_MATCH:
1818     case OP_QR:
1819     case OP_SUBST:
1820     case OP_NULL:
1821     default:
1822         if (o->op_flags & OPf_KIDS) {
1823             for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid))
1824                 scalar(kid);
1825         }
1826         break;
1827     case OP_LEAVE:
1828     case OP_LEAVETRY:
1829         kid = cLISTOPo->op_first;
1830         scalar(kid);
1831         kid = OpSIBLING(kid);
1832     do_kids:
1833         while (kid) {
1834             OP *sib = OpSIBLING(kid);
1835             if (sib && kid->op_type != OP_LEAVEWHEN
1836              && (  OpHAS_SIBLING(sib) || sib->op_type != OP_NULL
1837                 || (  sib->op_targ != OP_NEXTSTATE
1838                    && sib->op_targ != OP_DBSTATE  )))
1839                 scalarvoid(kid);
1840             else
1841                 scalar(kid);
1842             kid = sib;
1843         }
1844         PL_curcop = &PL_compiling;
1845         break;
1846     case OP_SCOPE:
1847     case OP_LINESEQ:
1848     case OP_LIST:
1849         kid = cLISTOPo->op_first;
1850         goto do_kids;
1851     case OP_SORT:
1852         Perl_ck_warner(aTHX_ packWARN(WARN_VOID), "Useless use of sort in scalar context");
1853         break;
1854     case OP_KVHSLICE:
1855     case OP_KVASLICE:
1856     {
1857         /* Warn about scalar context */
1858         const char lbrack = o->op_type == OP_KVHSLICE ? '{' : '[';
1859         const char rbrack = o->op_type == OP_KVHSLICE ? '}' : ']';
1860         SV *name;
1861         SV *keysv;
1862         const char *key = NULL;
1863
1864         /* This warning can be nonsensical when there is a syntax error. */
1865         if (PL_parser && PL_parser->error_count)
1866             break;
1867
1868         if (!ckWARN(WARN_SYNTAX)) break;
1869
1870         kid = cLISTOPo->op_first;
1871         kid = OpSIBLING(kid); /* get past pushmark */
1872         assert(OpSIBLING(kid));
1873         name = S_op_varname(aTHX_ OpSIBLING(kid));
1874         if (!name) /* XS module fiddling with the op tree */
1875             break;
1876         S_op_pretty(aTHX_ kid, &keysv, &key);
1877         assert(SvPOK(name));
1878         sv_chop(name,SvPVX(name)+1);
1879         if (key)
1880   /* diag_listed_as: %%s[%s] in scalar context better written as $%s[%s] */
1881             Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
1882                        "%%%" SVf "%c%s%c in scalar context better written "
1883                        "as $%" SVf "%c%s%c",
1884                         SVfARG(name), lbrack, key, rbrack, SVfARG(name),
1885                         lbrack, key, rbrack);
1886         else
1887   /* diag_listed_as: %%s[%s] in scalar context better written as $%s[%s] */
1888             Perl_warner(aTHX_ packWARN(WARN_SYNTAX),
1889                        "%%%" SVf "%c%" SVf "%c in scalar context better "
1890                        "written as $%" SVf "%c%" SVf "%c",
1891                         SVfARG(name), lbrack, SVfARG(keysv), rbrack,
1892                         SVfARG(name), lbrack, SVfARG(keysv), rbrack);
1893     }
1894     }
1895     return o;
1896 }
1897
1898 OP *
1899 Perl_scalarvoid(pTHX_ OP *arg)
1900 {
1901     dVAR;
1902     OP *kid;
1903     SV* sv;
1904     SSize_t defer_stack_alloc = 0;
1905     SSize_t defer_ix = -1;
1906     OP **defer_stack = NULL;
1907     OP *o = arg;
1908
1909     PERL_ARGS_ASSERT_SCALARVOID;
1910
1911     do {
1912         U8 want;
1913         SV *useless_sv = NULL;
1914         const char* useless = NULL;
1915
1916         if (o->op_type == OP_NEXTSTATE
1917             || o->op_type == OP_DBSTATE
1918             || (o->op_type == OP_NULL && (o->op_targ == OP_NEXTSTATE
1919                                           || o->op_targ == OP_DBSTATE)))
1920             PL_curcop = (COP*)o;                /* for warning below */
1921
1922         /* assumes no premature commitment */
1923         want = o->op_flags & OPf_WANT;
1924         if ((want && want != OPf_WANT_SCALAR)
1925             || (PL_parser && PL_parser->error_count)
1926             || o->op_type == OP_RETURN || o->op_type == OP_REQUIRE || o->op_type == OP_LEAVEWHEN)
1927         {
1928             continue;
1929         }
1930
1931         if ((o->op_private & OPpTARGET_MY)
1932             && (PL_opargs[o->op_type] & OA_TARGLEX))/* OPp share the meaning */
1933         {
1934             /* newASSIGNOP has already applied scalar context, which we
1935                leave, as if this op is inside SASSIGN.  */
1936             continue;
1937         }
1938
1939         o->op_flags = (o->op_flags & ~OPf_WANT) | OPf_WANT_VOID;
1940
1941         switch (o->op_type) {
1942         default:
1943             if (!(PL_opargs[o->op_type] & OA_FOLDCONST))
1944                 break;
1945             /* FALLTHROUGH */
1946         case OP_REPEAT:
1947             if (o->op_flags & OPf_STACKED)
1948                 break;
1949             if (o->op_type == OP_REPEAT)
1950                 scalar(cBINOPo->op_first);
1951             goto func_ops;
1952         case OP_SUBSTR:
1953             if (o->op_private == 4)
1954                 break;
1955             /* FALLTHROUGH */
1956         case OP_WANTARRAY:
1957         case OP_GV:
1958         case OP_SMARTMATCH:
1959         case OP_AV2ARYLEN:
1960         case OP_REF:
1961         case OP_REFGEN:
1962         case OP_SREFGEN:
1963         case OP_DEFINED:
1964         case OP_HEX:
1965         case OP_OCT:
1966         case OP_LENGTH:
1967         case OP_VEC:
1968         case OP_INDEX:
1969         case OP_RINDEX:
1970         case OP_SPRINTF:
1971         case OP_KVASLICE:
1972         case OP_KVHSLICE:
1973         case OP_UNPACK:
1974         case OP_PACK:
1975         case OP_JOIN:
1976         case OP_LSLICE:
1977         case OP_ANONLIST:
1978         case OP_ANONHASH:
1979         case OP_SORT:
1980         case OP_REVERSE:
1981         case OP_RANGE:
1982         case OP_FLIP:
1983         case OP_FLOP:
1984         case OP_CALLER:
1985         case OP_FILENO:
1986         case OP_EOF:
1987         case OP_TELL:
1988         case OP_GETSOCKNAME:
1989         case OP_GETPEERNAME:
1990         case OP_READLINK:
1991         case OP_TELLDIR:
1992         case OP_GETPPID:
1993         case OP_GETPGRP:
1994         case OP_GETPRIORITY:
1995         case OP_TIME:
1996         case OP_TMS:
1997         case OP_LOCALTIME:
1998         case OP_GMTIME:
1999         case OP_GHBYNAME:
2000         case OP_GHBYADDR:
2001         case OP_GHOSTENT:
2002         case OP_GNBYNAME:
2003         case OP_GNBYADDR:
2004         case OP_GNETENT:
2005         case OP_GPBYNAME:
2006         case OP_GPBYNUMBER:
2007         case OP_GPROTOENT:
2008         case OP_GSBYNAME:
2009         case OP_GSBYPORT:
2010         case OP_GSERVENT:
2011         case OP_GPWNAM:
2012         case OP_GPWUID:
2013         case OP_GGRNAM:
2014         case OP_GGRGID:
2015         case OP_GETLOGIN:
2016         case OP_PROTOTYPE:
2017         case OP_RUNCV:
2018         func_ops:
2019             useless = OP_DESC(o);
2020             break;
2021
2022         case OP_GVSV:
2023         case OP_PADSV:
2024         case OP_PADAV:
2025         case OP_PADHV:
2026         case OP_PADANY:
2027         case OP_AELEM:
2028         case OP_AELEMFAST:
2029         case OP_AELEMFAST_LEX:
2030         case OP_ASLICE:
2031         case OP_HELEM:
2032         case OP_HSLICE:
2033             if (!(o->op_private & (OPpLVAL_INTRO|OPpOUR_INTRO)))
2034                 /* Otherwise it's "Useless use of grep iterator" */
2035                 useless = OP_DESC(o);
2036             break;
2037
2038         case OP_SPLIT:
2039             if (!(o->op_private & OPpSPLIT_ASSIGN))
2040                 useless = OP_DESC(o);
2041             break;
2042
2043         case OP_NOT:
2044             kid = cUNOPo->op_first;
2045             if (kid->op_type != OP_MATCH && kid->op_type != OP_SUBST &&
2046                 kid->op_type != OP_TRANS && kid->op_type != OP_TRANSR) {
2047                 goto func_ops;
2048             }
2049             useless = "negative pattern binding (!~)";
2050             break;
2051
2052         case OP_SUBST:
2053             if (cPMOPo->op_pmflags & PMf_NONDESTRUCT)
2054                 useless = "non-destructive substitution (s///r)";
2055             break;
2056
2057         case OP_TRANSR:
2058             useless = "non-destructive transliteration (tr///r)";
2059             break;
2060
2061         case OP_RV2GV:
2062         case OP_RV2SV:
2063         case OP_RV2AV:
2064         case OP_RV2HV:
2065             if (!(o->op_private & (OPpLVAL_INTRO|OPpOUR_INTRO)) &&
2066                 (!OpHAS_SIBLING(o) || OpSIBLING(o)->op_type != OP_READLINE))
2067                 useless = "a variable";
2068             break;
2069
2070         case OP_CONST:
2071             sv = cSVOPo_sv;
2072             if (cSVOPo->op_private & OPpCONST_STRICT)
2073                 no_bareword_allowed(o);
2074             else {
2075                 if (ckWARN(WARN_VOID)) {
2076                     NV nv;
2077                     /* don't warn on optimised away booleans, eg
2078                      * use constant Foo, 5; Foo || print; */
2079                     if (cSVOPo->op_private & OPpCONST_SHORTCIRCUIT)
2080                         useless = NULL;
2081                     /* the constants 0 and 1 are permitted as they are
2082                        conventionally used as dummies in constructs like
2083                        1 while some_condition_with_side_effects;  */
2084                     else if (SvNIOK(sv) && ((nv = SvNV(sv)) == 0.0 || nv == 1.0))
2085                         useless = NULL;
2086                     else if (SvPOK(sv)) {
2087                         SV * const dsv = newSVpvs("");
2088                         useless_sv
2089                             = Perl_newSVpvf(aTHX_
2090                                             "a constant (%s)",
2091                                             pv_pretty(dsv, SvPVX_const(sv),
2092                                                       SvCUR(sv), 32, NULL, NULL,
2093                                                       PERL_PV_PRETTY_DUMP
2094                                                       | PERL_PV_ESCAPE_NOCLEAR
2095                                                       | PERL_PV_ESCAPE_UNI_DETECT));
2096                         SvREFCNT_dec_NN(dsv);
2097                     }
2098                     else if (SvOK(sv)) {
2099                         useless_sv = Perl_newSVpvf(aTHX_ "a constant (%" SVf ")", SVfARG(sv));
2100                     }
2101                     else
2102                         useless = "a constant (undef)";
2103                 }
2104             }
2105             op_null(o);         /* don't execute or even remember it */
2106             break;
2107
2108         case OP_POSTINC:
2109             OpTYPE_set(o, OP_PREINC);  /* pre-increment is faster */
2110             break;
2111
2112         case OP_POSTDEC:
2113             OpTYPE_set(o, OP_PREDEC);  /* pre-decrement is faster */
2114             break;
2115
2116         case OP_I_POSTINC:
2117             OpTYPE_set(o, OP_I_PREINC);        /* pre-increment is faster */
2118             break;
2119
2120         case OP_I_POSTDEC:
2121             OpTYPE_set(o, OP_I_PREDEC);        /* pre-decrement is faster */
2122             break;
2123
2124         case OP_SASSIGN: {
2125             OP *rv2gv;
2126             UNOP *refgen, *rv2cv;
2127             LISTOP *exlist;
2128
2129             if ((o->op_private & ~OPpASSIGN_BACKWARDS) != 2)
2130                 break;
2131
2132             rv2gv = ((BINOP *)o)->op_last;
2133             if (!rv2gv || rv2gv->op_type != OP_RV2GV)
2134                 break;
2135
2136             refgen = (UNOP *)((BINOP *)o)->op_first;
2137
2138             if (!refgen || (refgen->op_type != OP_REFGEN
2139                             && refgen->op_type != OP_SREFGEN))
2140                 break;
2141
2142             exlist = (LISTOP *)refgen->op_first;
2143             if (!exlist || exlist->op_type != OP_NULL
2144                 || exlist->op_targ != OP_LIST)
2145                 break;
2146
2147             if (exlist->op_first->op_type != OP_PUSHMARK
2148                 && exlist->op_first != exlist->op_last)
2149                 break;
2150
2151             rv2cv = (UNOP*)exlist->op_last;
2152
2153             if (rv2cv->op_type != OP_RV2CV)
2154                 break;
2155
2156             assert ((rv2gv->op_private & OPpDONT_INIT_GV) == 0);
2157             assert ((o->op_private & OPpASSIGN_CV_TO_GV) == 0);
2158             assert ((rv2cv->op_private & OPpMAY_RETURN_CONSTANT) == 0);
2159
2160             o->op_private |= OPpASSIGN_CV_TO_GV;
2161             rv2gv->op_private |= OPpDONT_INIT_GV;
2162             rv2cv->op_private |= OPpMAY_RETURN_CONSTANT;
2163
2164             break;
2165         }
2166
2167         case OP_AASSIGN: {
2168             inplace_aassign(o);
2169             break;
2170         }
2171
2172         case OP_OR:
2173         case OP_AND:
2174             kid = cLOGOPo->op_first;
2175             if (kid->op_type == OP_NOT
2176                 && (kid->op_flags & OPf_KIDS)) {
2177                 if (o->op_type == OP_AND) {
2178                     OpTYPE_set(o, OP_OR);
2179                 } else {
2180                     OpTYPE_set(o, OP_AND);
2181                 }
2182                 op_null(kid);
2183             }
2184             /* FALLTHROUGH */
2185
2186         case OP_DOR:
2187         case OP_COND_EXPR:
2188         case OP_ENTERGIVEN:
2189         case OP_ENTERWHEN:
2190             for (kid = OpSIBLING(cUNOPo->op_first); kid; kid = OpSIBLING(kid))
2191                 if (!(kid->op_flags & OPf_KIDS))
2192                     scalarvoid(kid);
2193                 else
2194                     DEFER_OP(kid);
2195         break;
2196
2197         case OP_NULL:
2198             if (o->op_flags & OPf_STACKED)
2199                 break;
2200             /* FALLTHROUGH */
2201         case OP_NEXTSTATE:
2202         case OP_DBSTATE:
2203         case OP_ENTERTRY:
2204         case OP_ENTER:
2205             if (!(o->op_flags & OPf_KIDS))
2206                 break;
2207             /* FALLTHROUGH */
2208         case OP_SCOPE:
2209         case OP_LEAVE:
2210         case OP_LEAVETRY:
2211         case OP_LEAVELOOP:
2212         case OP_LINESEQ:
2213         case OP_LEAVEWHEN:
2214         kids:
2215             for (kid = cLISTOPo->op_first; kid; kid = OpSIBLING(kid))
2216                 if (!(kid->op_flags & OPf_KIDS))
2217                     scalarvoid(kid);
2218                 else
2219                     DEFER_OP(kid);
2220             break;
2221         case OP_LIST:
2222             /* If the first kid after pushmark is something that the padrange
2223                optimisation would reject, then null the list and the pushmark.
2224             */
2225             if ((kid = cLISTOPo->op_first)->op_type == OP_PUSHMARK
2226                 && (  !(kid = OpSIBLING(kid))
2227                       || (  kid->op_type != OP_PADSV
2228                             && kid->op_type != OP_PADAV
2229                             && kid->op_type != OP_PADHV)
2230                       || kid->op_private & ~OPpLVAL_INTRO
2231                       || !(kid = OpSIBLING(kid))
2232                       || (  kid->op_type != OP_PADSV
2233                             && kid->op_type != OP_PADAV
2234                             && kid->op_type != OP_PADHV)
2235                       || kid->op_private & ~OPpLVAL_INTRO)
2236             ) {
2237                 op_null(cUNOPo->op_first); /* NULL the pushmark */
2238                 op_null(o); /* NULL the list */
2239             }
2240             goto kids;
2241         case OP_ENTEREVAL:
2242             scalarkids(o);
2243             break;
2244         case OP_SCALAR:
2245             scalar(o);
2246             break;
2247         }
2248
2249         if (useless_sv) {
2250             /* mortalise it, in case warnings are fatal.  */
2251             Perl_ck_warner(aTHX_ packWARN(WARN_VOID),
2252                            "Useless use of %" SVf " in void context",
2253                            SVfARG(sv_2mortal(useless_sv)));
2254         }
2255         else if (useless) {
2256             Perl_ck_warner(aTHX_ packWARN(WARN_VOID),
2257                            "Useless use of %s in void context",
2258                            useless);
2259         }
2260     } while ( (o = POP_DEFERRED_OP()) );
2261
2262     Safefree(defer_stack);
2263
2264     return arg;
2265 }
2266
2267 static OP *
2268 S_listkids(pTHX_ OP *o)
2269 {
2270     if (o && o->op_flags & OPf_KIDS) {
2271         OP *kid;
2272         for (kid = cLISTOPo->op_first; kid; kid = OpSIBLING(kid))
2273             list(kid);
2274     }
2275     return o;
2276 }
2277
2278 OP *
2279 Perl_list(pTHX_ OP *o)
2280 {
2281     OP *kid;
2282
2283     /* assumes no premature commitment */
2284     if (!o || (o->op_flags & OPf_WANT)
2285          || (PL_parser && PL_parser->error_count)
2286          || o->op_type == OP_RETURN)
2287     {
2288         return o;
2289     }
2290
2291     if ((o->op_private & OPpTARGET_MY)
2292         && (PL_opargs[o->op_type] & OA_TARGLEX))/* OPp share the meaning */
2293     {
2294         return o;                               /* As if inside SASSIGN */
2295     }
2296
2297     o->op_flags = (o->op_flags & ~OPf_WANT) | OPf_WANT_LIST;
2298
2299     switch (o->op_type) {
2300     case OP_FLOP:
2301         list(cBINOPo->op_first);
2302         break;
2303     case OP_REPEAT:
2304         if (o->op_private & OPpREPEAT_DOLIST
2305          && !(o->op_flags & OPf_STACKED))
2306         {
2307             list(cBINOPo->op_first);
2308             kid = cBINOPo->op_last;
2309             if (kid->op_type == OP_CONST && SvIOK(kSVOP_sv)
2310              && SvIVX(kSVOP_sv) == 1)
2311             {
2312                 op_null(o); /* repeat */
2313                 op_null(cUNOPx(cBINOPo->op_first)->op_first);/* pushmark */
2314                 /* const (rhs): */
2315                 op_free(op_sibling_splice(o, cBINOPo->op_first, 1, NULL));
2316             }
2317         }
2318         break;
2319     case OP_OR:
2320     case OP_AND:
2321     case OP_COND_EXPR:
2322         for (kid = OpSIBLING(cUNOPo->op_first); kid; kid = OpSIBLING(kid))
2323             list(kid);
2324         break;
2325     default:
2326     case OP_MATCH:
2327     case OP_QR:
2328     case OP_SUBST:
2329     case OP_NULL:
2330         if (!(o->op_flags & OPf_KIDS))
2331             break;
2332         if (!o->op_next && cUNOPo->op_first->op_type == OP_FLOP) {
2333             list(cBINOPo->op_first);
2334             return gen_constant_list(o);
2335         }
2336         listkids(o);
2337         break;
2338     case OP_LIST:
2339         listkids(o);
2340         if (cLISTOPo->op_first->op_type == OP_PUSHMARK) {
2341             op_null(cUNOPo->op_first); /* NULL the pushmark */
2342             op_null(o); /* NULL the list */
2343         }
2344         break;
2345     case OP_LEAVE:
2346     case OP_LEAVETRY:
2347         kid = cLISTOPo->op_first;
2348         list(kid);
2349         kid = OpSIBLING(kid);
2350     do_kids:
2351         while (kid) {
2352             OP *sib = OpSIBLING(kid);
2353             if (sib && kid->op_type != OP_LEAVEWHEN)
2354                 scalarvoid(kid);
2355             else
2356                 list(kid);
2357             kid = sib;
2358         }
2359         PL_curcop = &PL_compiling;
2360         break;
2361     case OP_SCOPE:
2362     case OP_LINESEQ:
2363         kid = cLISTOPo->op_first;
2364         goto do_kids;
2365     }
2366     return o;
2367 }
2368
2369 static OP *
2370 S_scalarseq(pTHX_ OP *o)
2371 {
2372     if (o) {
2373         const OPCODE type = o->op_type;
2374
2375         if (type == OP_LINESEQ || type == OP_SCOPE ||
2376             type == OP_LEAVE || type == OP_LEAVETRY)
2377         {
2378             OP *kid, *sib;
2379             for (kid = cLISTOPo->op_first; kid; kid = sib) {
2380                 if ((sib = OpSIBLING(kid))
2381                  && (  OpHAS_SIBLING(sib) || sib->op_type != OP_NULL
2382                     || (  sib->op_targ != OP_NEXTSTATE
2383                        && sib->op_targ != OP_DBSTATE  )))
2384                 {
2385                     scalarvoid(kid);
2386                 }
2387             }
2388             PL_curcop = &PL_compiling;
2389         }
2390         o->op_flags &= ~OPf_PARENS;
2391         if (PL_hints & HINT_BLOCK_SCOPE)
2392             o->op_flags |= OPf_PARENS;
2393     }
2394     else
2395         o = newOP(OP_STUB, 0);
2396     return o;
2397 }
2398
2399 STATIC OP *
2400 S_modkids(pTHX_ OP *o, I32 type)
2401 {
2402     if (o && o->op_flags & OPf_KIDS) {
2403         OP *kid;
2404         for (kid = cLISTOPo->op_first; kid; kid = OpSIBLING(kid))
2405             op_lvalue(kid, type);
2406     }
2407     return o;
2408 }
2409
2410
2411 /* for a helem/hslice/kvslice, if its a fixed hash, croak on invalid
2412  * const fields. Also, convert CONST keys to HEK-in-SVs.
2413  * rop is the op that retrieves the hash;
2414  * key_op is the first key
2415  */
2416
2417 STATIC void
2418 S_check_hash_fields_and_hekify(pTHX_ UNOP *rop, SVOP *key_op)
2419 {
2420     PADNAME *lexname;
2421     GV **fields;
2422     bool check_fields;
2423
2424     /* find the padsv corresponding to $lex->{} or @{$lex}{} */
2425     if (rop) {
2426         if (rop->op_first->op_type == OP_PADSV)
2427             /* @$hash{qw(keys here)} */
2428             rop = (UNOP*)rop->op_first;
2429         else {
2430             /* @{$hash}{qw(keys here)} */
2431             if (rop->op_first->op_type == OP_SCOPE
2432                 && cLISTOPx(rop->op_first)->op_last->op_type == OP_PADSV)
2433                 {
2434                     rop = (UNOP*)cLISTOPx(rop->op_first)->op_last;
2435                 }
2436             else
2437                 rop = NULL;
2438         }
2439     }
2440
2441     lexname = NULL; /* just to silence compiler warnings */
2442     fields  = NULL; /* just to silence compiler warnings */
2443
2444     check_fields =
2445             rop
2446          && (lexname = padnamelist_fetch(PL_comppad_name, rop->op_targ),
2447              SvPAD_TYPED(lexname))
2448          && (fields = (GV**)hv_fetchs(PadnameTYPE(lexname), "FIELDS", FALSE))
2449          && isGV(*fields) && GvHV(*fields);
2450
2451     for (; key_op; key_op = (SVOP*)OpSIBLING(key_op)) {
2452         SV **svp, *sv;
2453         if (key_op->op_type != OP_CONST)
2454             continue;
2455         svp = cSVOPx_svp(key_op);
2456
2457         /* make sure it's not a bareword under strict subs */
2458         if (key_op->op_private & OPpCONST_BARE &&
2459             key_op->op_private & OPpCONST_STRICT)
2460         {
2461             no_bareword_allowed((OP*)key_op);
2462         }
2463
2464         /* Make the CONST have a shared SV */
2465         if (   !SvIsCOW_shared_hash(sv = *svp)
2466             && SvTYPE(sv) < SVt_PVMG
2467             && SvOK(sv)
2468             && !SvROK(sv))
2469         {
2470             SSize_t keylen;
2471             const char * const key = SvPV_const(sv, *(STRLEN*)&keylen);
2472             SV *nsv = newSVpvn_share(key, SvUTF8(sv) ? -keylen : keylen, 0);
2473             SvREFCNT_dec_NN(sv);
2474             *svp = nsv;
2475         }
2476
2477         if (   check_fields
2478             && !hv_fetch_ent(GvHV(*fields), *svp, FALSE, 0))
2479         {
2480             Perl_croak(aTHX_ "No such class field \"%" SVf "\" "
2481                         "in variable %" PNf " of type %" HEKf,
2482                         SVfARG(*svp), PNfARG(lexname),
2483                         HEKfARG(HvNAME_HEK(PadnameTYPE(lexname))));
2484         }
2485     }
2486 }
2487
2488 /* info returned by S_sprintf_is_multiconcatable() */
2489
2490 struct sprintf_ismc_info {
2491     SSize_t nargs;    /* num of args to sprintf (not including the format) */
2492     char  *start;     /* start of raw format string */
2493     char  *end;       /* bytes after end of raw format string */
2494     STRLEN total_len; /* total length (in bytes) of format string, not
2495                          including '%s' and  half of '%%' */
2496     STRLEN variant;   /* number of bytes by which total_len_p would grow
2497                          if upgraded to utf8 */
2498     bool   utf8;      /* whether the format is utf8 */
2499 };
2500
2501
2502 /* is the OP_SPRINTF o suitable for converting into a multiconcat op?
2503  * i.e. its format argument is a const string with only '%s' and '%%'
2504  * formats, and the number of args is known, e.g.
2505  *    sprintf "a=%s f=%s", $a[0], scalar(f());
2506  * but not
2507  *    sprintf "i=%d a=%s f=%s", $i, @a, f();
2508  *
2509  * If successful, the sprintf_ismc_info struct pointed to by info will be
2510  * populated.
2511  */
2512
2513 STATIC bool
2514 S_sprintf_is_multiconcatable(pTHX_ OP *o,struct sprintf_ismc_info *info)
2515 {
2516     OP    *pm, *constop, *kid;
2517     SV    *sv;
2518     char  *s, *e, *p;
2519     SSize_t nargs, nformats;
2520     STRLEN cur, total_len, variant;
2521     bool   utf8;
2522
2523     /* if sprintf's behaviour changes, die here so that someone
2524      * can decide whether to enhance this function or skip optimising
2525      * under those new circumstances */
2526     assert(!(o->op_flags & OPf_STACKED));
2527     assert(!(PL_opargs[OP_SPRINTF] & OA_TARGLEX));
2528     assert(!(o->op_private & ~OPpARG4_MASK));
2529
2530     pm = cUNOPo->op_first;
2531     if (pm->op_type != OP_PUSHMARK) /* weird coreargs stuff */
2532         return FALSE;
2533     constop = OpSIBLING(pm);
2534     if (!constop || constop->op_type != OP_CONST)
2535         return FALSE;
2536     sv = cSVOPx_sv(constop);
2537     if (SvMAGICAL(sv) || !SvPOK(sv))
2538         return FALSE;
2539
2540     s = SvPV(sv, cur);
2541     e = s + cur;
2542
2543     /* Scan format for %% and %s and work out how many %s there are.
2544      * Abandon if other format types are found.
2545      */
2546
2547     nformats  = 0;
2548     total_len = 0;
2549     variant   = 0;
2550
2551     for (p = s; p < e; p++) {
2552         if (*p != '%') {
2553             total_len++;
2554             if (!UTF8_IS_INVARIANT(*p))
2555                 variant++;
2556             continue;
2557         }
2558         p++;
2559         if (p >= e)
2560             return FALSE; /* lone % at end gives "Invalid conversion" */
2561         if (*p == '%')
2562             total_len++;
2563         else if (*p == 's')
2564             nformats++;
2565         else
2566             return FALSE;
2567     }
2568
2569     if (!nformats || nformats > PERL_MULTICONCAT_MAXARG)
2570         return FALSE;
2571
2572     utf8 = cBOOL(SvUTF8(sv));
2573     if (utf8)
2574         variant = 0;
2575
2576     /* scan args; they must all be in scalar cxt */
2577
2578     nargs = 0;
2579     kid = OpSIBLING(constop);
2580
2581     while (kid) {
2582         if ((kid->op_flags & OPf_WANT) != OPf_WANT_SCALAR)
2583             return FALSE;
2584         nargs++;
2585         kid = OpSIBLING(kid);
2586     }
2587
2588     if (nargs != nformats)
2589         return FALSE; /* e.g. sprintf("%s%s", $a); */
2590
2591
2592     info->nargs      = nargs;
2593     info->start      = s;
2594     info->end        = e;
2595     info->total_len  = total_len;
2596     info->variant    = variant;
2597     info->utf8       = utf8;
2598
2599     return TRUE;
2600 }
2601
2602
2603
2604 /* S_maybe_multiconcat():
2605  *
2606  * given an OP_STRINGIFY, OP_SASSIGN, OP_CONCAT or OP_SPRINTF op, possibly
2607  * convert it (and its children) into an OP_MULTICONCAT. See the code
2608  * comments just before pp_multiconcat() for the full details of what
2609  * OP_MULTICONCAT supports.
2610  *
2611  * Basically we're looking for an optree with a chain of OP_CONCATS down
2612  * the LHS (or an OP_SPRINTF), with possibly an OP_SASSIGN, and/or
2613  * OP_STRINGIFY, and/or OP_CONCAT acting as '.=' at its head, e.g.
2614  *
2615  *      $x = "$a$b-$c"
2616  *
2617  *  looks like
2618  *
2619  *      SASSIGN
2620  *         |
2621  *      STRINGIFY   -- PADSV[$x]
2622  *         |
2623  *         |
2624  *      ex-PUSHMARK -- CONCAT/S
2625  *                        |
2626  *                     CONCAT/S  -- PADSV[$d]
2627  *                        |
2628  *                     CONCAT    -- CONST["-"]
2629  *                        |
2630  *                     PADSV[$a] -- PADSV[$b]
2631  *
2632  * Note that at this stage the OP_SASSIGN may have already been optimised
2633  * away with OPpTARGET_MY set on the OP_STRINGIFY or OP_CONCAT.
2634  */
2635
2636 STATIC void
2637 S_maybe_multiconcat(pTHX_ OP *o)
2638 {
2639     OP *lastkidop;   /* the right-most of any kids unshifted onto o */
2640     OP *topop;       /* the top-most op in the concat tree (often equals o,
2641                         unless there are assign/stringify ops above it */
2642     OP *parentop;    /* the parent op of topop (or itself if no parent) */
2643     OP *targmyop;    /* the op (if any) with the OPpTARGET_MY flag */
2644     OP *targetop;    /* the op corresponding to target=... or target.=... */
2645     OP *stringop;    /* the OP_STRINGIFY op, if any */
2646     OP *nextop;      /* used for recreating the op_next chain without consts */
2647     OP *kid;         /* general-purpose op pointer */
2648     UNOP_AUX_item *aux;
2649     UNOP_AUX_item *lenp;
2650     char *const_str, *p;
2651     struct sprintf_ismc_info sprintf_info;
2652
2653                      /* store info about each arg in args[];
2654                       * toparg is the highest used slot; argp is a general
2655                       * pointer to args[] slots */
2656     struct {
2657         void *p;      /* initially points to const sv (or null for op);
2658                          later, set to SvPV(constsv), with ... */
2659         STRLEN len;   /* ... len set to SvPV(..., len) */
2660     } *argp, *toparg, args[PERL_MULTICONCAT_MAXARG*2 + 1];
2661
2662     SSize_t nargs  = 0;
2663     SSize_t nconst = 0;
2664     STRLEN variant;
2665     bool utf8 = FALSE;
2666     bool kid_is_last = FALSE; /* most args will be the RHS kid of a concat op;
2667                                  the last-processed arg will the LHS of one,
2668                                  as args are processed in reverse order */
2669     U8   stacked_last = 0;   /* whether the last seen concat op was STACKED */
2670     STRLEN total_len  = 0;   /* sum of the lengths of the const segments */
2671     U8 flags          = 0;   /* what will become the op_flags and ... */
2672     U8 private_flags  = 0;   /* ... op_private of the multiconcat op */
2673     bool is_sprintf = FALSE; /* we're optimising an sprintf */
2674     bool is_targable  = FALSE; /* targetop is an OPpTARGET_MY candidate */
2675
2676     /* -----------------------------------------------------------------
2677      * Phase 1:
2678      *
2679      * Examine the optree non-destructively to determine whether it's
2680      * suitable to be converted into an OP_MULTICONCAT. Accumulate
2681      * information about the optree in args[].
2682      */
2683
2684     argp     = args;
2685     targmyop = NULL;
2686     targetop = NULL;
2687     stringop = NULL;
2688     topop    = o;
2689     parentop = o;
2690
2691     assert(   o->op_type == OP_SASSIGN
2692            || o->op_type == OP_CONCAT
2693            || o->op_type == OP_SPRINTF
2694            || o->op_type == OP_STRINGIFY);
2695
2696     /* first see if, at the top of the tree, there is an assign,
2697      * append and/or stringify */
2698
2699     if (topop->op_type == OP_SASSIGN) {
2700         /* expr = ..... */
2701         if (o->op_ppaddr != PL_ppaddr[OP_SASSIGN])
2702             return;
2703         if (o->op_private & (OPpASSIGN_BACKWARDS|OPpASSIGN_CV_TO_GV))
2704             return;
2705         assert(!(o->op_private & ~OPpARG2_MASK)); /* barf on unknown flags */
2706
2707         parentop = topop;
2708         topop = cBINOPo->op_first;
2709         targetop = OpSIBLING(topop);
2710         if (!targetop) /* probably some sort of syntax error */
2711             return;
2712     }
2713     else if (   topop->op_type == OP_CONCAT
2714              && (topop->op_flags & OPf_STACKED)
2715              && (cUNOPo->op_first->op_flags & OPf_MOD))
2716     {
2717         /* expr .= ..... */
2718
2719         /* OPpTARGET_MY shouldn't be able to be set here. If it is,
2720          * decide what to do about it */
2721         assert(!(o->op_private & OPpTARGET_MY));
2722
2723         /* barf on unknown flags */
2724         assert(!(o->op_private & ~(OPpARG2_MASK|OPpTARGET_MY)));
2725         private_flags |= OPpMULTICONCAT_APPEND;
2726         targetop = cBINOPo->op_first;
2727         parentop = topop;
2728         topop    = OpSIBLING(targetop);
2729
2730         /* $x .= <FOO> gets optimised to rcatline instead */
2731         if (topop->op_type == OP_READLINE)
2732             return;
2733     }
2734
2735     if (targetop) {
2736         /* Can targetop (the LHS) if it's a padsv, be be optimised
2737          * away and use OPpTARGET_MY instead?
2738          */
2739         if (    (targetop->op_type == OP_PADSV)
2740             && !(targetop->op_private & OPpDEREF)
2741             && !(targetop->op_private & OPpPAD_STATE)
2742                /* we don't support 'my $x .= ...' */
2743             && (   o->op_type == OP_SASSIGN
2744                 || !(targetop->op_private & OPpLVAL_INTRO))
2745         )
2746             is_targable = TRUE;
2747     }
2748
2749     if (topop->op_type == OP_STRINGIFY) {
2750         if (topop->op_ppaddr != PL_ppaddr[OP_STRINGIFY])
2751             return;
2752         stringop = topop;
2753
2754         /* barf on unknown flags */
2755         assert(!(o->op_private & ~(OPpARG4_MASK|OPpTARGET_MY)));
2756
2757         if ((topop->op_private & OPpTARGET_MY)) {
2758             if (o->op_type == OP_SASSIGN)
2759                 return; /* can't have two assigns */
2760             targmyop = topop;
2761         }
2762
2763         private_flags |= OPpMULTICONCAT_STRINGIFY;
2764         parentop = topop;
2765         topop = cBINOPx(topop)->op_first;
2766         assert(OP_TYPE_IS_OR_WAS_NN(topop, OP_PUSHMARK));
2767         topop = OpSIBLING(topop);
2768     }
2769
2770     if (topop->op_type == OP_SPRINTF) {
2771         if (topop->op_ppaddr != PL_ppaddr[OP_SPRINTF])
2772             return;
2773         if (S_sprintf_is_multiconcatable(aTHX_ topop, &sprintf_info)) {
2774             nargs     = sprintf_info.nargs;
2775             total_len = sprintf_info.total_len;
2776             variant   = sprintf_info.variant;
2777             utf8      = sprintf_info.utf8;
2778             is_sprintf = TRUE;
2779             private_flags |= OPpMULTICONCAT_FAKE;
2780             toparg = argp;
2781             /* we have an sprintf op rather than a concat optree.
2782              * Skip most of the code below which is associated with
2783              * processing that optree. We also skip phase 2, determining
2784              * whether its cost effective to optimise, since for sprintf,
2785              * multiconcat is *always* faster */
2786             goto create_aux;
2787         }
2788         /* note that even if the sprintf itself isn't multiconcatable,
2789          * the expression as a whole may be, e.g. in
2790          *    $x .= sprintf("%d",...)
2791          * the sprintf op will be left as-is, but the concat/S op may
2792          * be upgraded to multiconcat
2793          */
2794     }
2795     else if (topop->op_type == OP_CONCAT) {
2796         if (topop->op_ppaddr != PL_ppaddr[OP_CONCAT])
2797             return;
2798
2799         if ((topop->op_private & OPpTARGET_MY)) {
2800             if (o->op_type == OP_SASSIGN || targmyop)
2801                 return; /* can't have two assigns */
2802             targmyop = topop;
2803         }
2804     }
2805
2806     /* Is it safe to convert a sassign/stringify/concat op into
2807      * a multiconcat? */
2808     assert((PL_opargs[OP_SASSIGN]   & OA_CLASS_MASK) == OA_BINOP);
2809     assert((PL_opargs[OP_CONCAT]    & OA_CLASS_MASK) == OA_BINOP);
2810     assert((PL_opargs[OP_STRINGIFY] & OA_CLASS_MASK) == OA_LISTOP);
2811     assert((PL_opargs[OP_SPRINTF]   & OA_CLASS_MASK) == OA_LISTOP);
2812     STATIC_ASSERT_STMT(   STRUCT_OFFSET(BINOP,    op_last)
2813                        == STRUCT_OFFSET(UNOP_AUX, op_aux));
2814     STATIC_ASSERT_STMT(   STRUCT_OFFSET(LISTOP,   op_last)
2815                        == STRUCT_OFFSET(UNOP_AUX, op_aux));
2816
2817     /* Now scan the down the tree looking for a series of
2818      * CONCAT/OPf_STACKED ops on the LHS (with the last one not
2819      * stacked). For example this tree:
2820      *
2821      *     |
2822      *   CONCAT/STACKED
2823      *     |
2824      *   CONCAT/STACKED -- EXPR5
2825      *     |
2826      *   CONCAT/STACKED -- EXPR4
2827      *     |
2828      *   CONCAT -- EXPR3
2829      *     |
2830      *   EXPR1  -- EXPR2
2831      *
2832      * corresponds to an expression like
2833      *
2834      *   (EXPR1 . EXPR2 . EXPR3 . EXPR4 . EXPR5)
2835      *
2836      * Record info about each EXPR in args[]: in particular, whether it is
2837      * a stringifiable OP_CONST and if so what the const sv is.
2838      *
2839      * The reason why the last concat can't be STACKED is the difference
2840      * between
2841      *
2842      *    ((($a .= $a) .= $a) .= $a) .= $a
2843      *
2844      * and
2845      *    $a . $a . $a . $a . $a
2846      *
2847      * The main difference between the optrees for those two constructs
2848      * is the presence of the last STACKED. As well as modifying $a,
2849      * the former sees the changed $a between each concat, so if $s is
2850      * initially 'a', the first returns 'a' x 16, while the latter returns
2851      * 'a' x 5. And pp_multiconcat can't handle that kind of thing.
2852      */
2853
2854     kid = topop;
2855
2856     for (;;) {
2857         OP *argop;
2858         SV *sv;
2859         bool last = FALSE;
2860
2861         if (    kid->op_type == OP_CONCAT
2862             && !kid_is_last
2863         ) {
2864             OP *k1, *k2;
2865             k1 = cUNOPx(kid)->op_first;
2866             k2 = OpSIBLING(k1);
2867             /* shouldn't happen except maybe after compile err? */
2868             if (!k2)
2869                 return;
2870
2871             /* avoid turning (A . B . ($lex = C) ...)  into  (A . B . C ...) */
2872             if (kid->op_private & OPpTARGET_MY)
2873                 kid_is_last = TRUE;
2874
2875             stacked_last = (kid->op_flags & OPf_STACKED);
2876             if (!stacked_last)
2877                 kid_is_last = TRUE;
2878
2879             kid   = k1;
2880             argop = k2;
2881         }
2882         else {
2883             argop = kid;
2884             last = TRUE;
2885         }
2886
2887         if (   nargs              >  PERL_MULTICONCAT_MAXARG        - 2
2888             || (argp - args + 1)  > (PERL_MULTICONCAT_MAXARG*2 + 1) - 2)
2889         {
2890             /* At least two spare slots are needed to decompose both
2891              * concat args. If there are no slots left, continue to
2892              * examine the rest of the optree, but don't push new values
2893              * on args[]. If the optree as a whole is legal for conversion
2894              * (in particular that the last concat isn't STACKED), then
2895              * the first PERL_MULTICONCAT_MAXARG elements of the optree
2896              * can be converted into an OP_MULTICONCAT now, with the first
2897              * child of that op being the remainder of the optree -
2898              * which may itself later be converted to a multiconcat op
2899              * too.
2900              */
2901             if (last) {
2902                 /* the last arg is the rest of the optree */
2903                 argp++->p = NULL;
2904                 nargs++;
2905             }
2906         }
2907         else if (   argop->op_type == OP_CONST
2908             && ((sv = cSVOPx_sv(argop)))
2909             /* defer stringification until runtime of 'constant'
2910              * things that might stringify variantly, e.g. the radix
2911              * point of NVs, or overloaded RVs */
2912             && (SvPOK(sv) || SvIOK(sv))
2913             && (!SvGMAGICAL(sv))
2914         ) {
2915             argp++->p = sv;
2916             utf8   |= cBOOL(SvUTF8(sv));
2917             nconst++;
2918         }
2919         else {
2920             argp++->p = NULL;
2921             nargs++;
2922         }
2923
2924         if (last)
2925             break;
2926     }
2927
2928     toparg = argp - 1;
2929
2930     if (stacked_last)
2931         return; /* we don't support ((A.=B).=C)...) */
2932
2933     /* -----------------------------------------------------------------
2934      * Phase 2:
2935      *
2936      * At this point we have determined that the optree *can* be converted
2937      * into a multiconcat. Having gathered all the evidence, we now decide
2938      * whether it *should*.
2939      */
2940
2941
2942     /* we need at least one concat action, e.g.:
2943      *
2944      *  Y . Z
2945      *  X = Y . Z
2946      *  X .= Y
2947      *
2948      * otherwise we could be doing something like $x = "foo", which
2949      * if treated as as a concat, would fail to COW.
2950      */
2951     if (nargs + nconst + cBOOL(private_flags & OPpMULTICONCAT_APPEND) < 2)
2952         return;
2953
2954     /* Benchmarking seems to indicate that we gain if:
2955      * * we optimise at least two actions into a single multiconcat
2956      *    (e.g concat+concat, sassign+concat);
2957      * * or if we can eliminate at least 1 OP_CONST;
2958      * * or if we can eliminate a padsv via OPpTARGET_MY
2959      */
2960
2961     if (
2962            /* eliminated at least one OP_CONST */
2963            nconst >= 1
2964            /* eliminated an OP_SASSIGN */
2965         || o->op_type == OP_SASSIGN
2966            /* eliminated an OP_PADSV */
2967         || (!targmyop && is_targable)
2968     )
2969         /* definitely a net gain to optimise */
2970         goto optimise;
2971
2972     /* ... if not, what else? */
2973
2974     /* special-case '$lex1 = expr . $lex1' (where expr isn't lex1):
2975      * multiconcat is faster (due to not creating a temporary copy of
2976      * $lex1), whereas for a general $lex1 = $lex2 . $lex3, concat is
2977      * faster.
2978      */
2979     if (   nconst == 0
2980          && nargs == 2
2981          && targmyop
2982          && topop->op_type == OP_CONCAT
2983     ) {
2984         PADOFFSET t = targmyop->op_targ;
2985         OP *k1 = cBINOPx(topop)->op_first;
2986         OP *k2 = cBINOPx(topop)->op_last;
2987         if (   k2->op_type == OP_PADSV
2988             && k2->op_targ == t
2989             && (   k1->op_type != OP_PADSV
2990                 || k1->op_targ != t)
2991         )
2992             goto optimise;
2993     }
2994
2995     /* need at least two concats */
2996     if (nargs + nconst + cBOOL(private_flags & OPpMULTICONCAT_APPEND) < 3)
2997         return;
2998
2999
3000
3001     /* -----------------------------------------------------------------
3002      * Phase 3:
3003      *
3004      * At this point the optree has been verified as ok to be optimised
3005      * into an OP_MULTICONCAT. Now start changing things.
3006      */
3007
3008    optimise:
3009
3010     /* stringify all const args and determine utf8ness */
3011
3012     variant = 0;
3013     for (argp = args; argp <= toparg; argp++) {
3014         SV *sv = (SV*)argp->p;
3015         if (!sv)
3016             continue; /* not a const op */
3017         if (utf8 && !SvUTF8(sv))
3018             sv_utf8_upgrade_nomg(sv);
3019         argp->p = SvPV_nomg(sv, argp->len);
3020         total_len += argp->len;
3021         
3022         /* see if any strings would grow if converted to utf8 */
3023         if (!utf8) {
3024             char *p    = (char*)argp->p;
3025             STRLEN len = argp->len;
3026             while (len--) {
3027                 U8 c = *p++;
3028                 if (!UTF8_IS_INVARIANT(c))
3029                     variant++;
3030             }
3031         }
3032     }
3033
3034     /* create and populate aux struct */
3035
3036   create_aux:
3037
3038     aux = (UNOP_AUX_item*)PerlMemShared_malloc(
3039                     sizeof(UNOP_AUX_item)
3040                     *  (
3041                            PERL_MULTICONCAT_HEADER_SIZE
3042                          + ((nargs + 1) * (variant ? 2 : 1))
3043                         )
3044                     );
3045     const_str = (char *)PerlMemShared_malloc(total_len ? total_len : 1);
3046
3047     /* Extract all the non-const expressions from the concat tree then
3048      * dispose of the old tree, e.g. convert the tree from this:
3049      *
3050      *  o => SASSIGN
3051      *         |
3052      *       STRINGIFY   -- TARGET
3053      *         |
3054      *       ex-PUSHMARK -- CONCAT
3055      *                        |
3056      *                      CONCAT -- EXPR5
3057      *                        |
3058      *                      CONCAT -- EXPR4
3059      *                        |
3060      *                      CONCAT -- EXPR3
3061      *                        |
3062      *                      EXPR1  -- EXPR2
3063      *
3064      *
3065      * to:
3066      *
3067      *  o => MULTICONCAT
3068      *         |
3069      *       ex-PUSHMARK -- EXPR1 -- EXPR2 -- EXPR3 -- EXPR4 -- EXPR5 -- TARGET
3070      *
3071      * except that if EXPRi is an OP_CONST, it's discarded.
3072      *
3073      * During the conversion process, EXPR ops are stripped from the tree
3074      * and unshifted onto o. Finally, any of o's remaining original
3075      * childen are discarded and o is converted into an OP_MULTICONCAT.
3076      *
3077      * In this middle of this, o may contain both: unshifted args on the
3078      * left, and some remaining original args on the right. lastkidop
3079      * is set to point to the right-most unshifted arg to delineate
3080      * between the two sets.
3081      */
3082
3083
3084     if (is_sprintf) {
3085         /* create a copy of the format with the %'s removed, and record
3086          * the sizes of the const string segments in the aux struct */
3087         char *q, *oldq;
3088         lenp = aux + PERL_MULTICONCAT_IX_LENGTHS;
3089
3090         p    = sprintf_info.start;
3091         q    = const_str;
3092         oldq = q;
3093         for (; p < sprintf_info.end; p++) {
3094             if (*p == '%') {
3095                 p++;
3096                 if (*p != '%') {
3097                     (lenp++)->ssize = q - oldq;
3098                     oldq = q;
3099                     continue;
3100                 }
3101             }
3102             *q++ = *p;
3103         }
3104         lenp->ssize = q - oldq;
3105         assert((STRLEN)(q - const_str) == total_len);
3106
3107         /* Attach all the args (i.e. the kids of the sprintf) to o (which
3108          * may or may not be topop) The pushmark and const ops need to be
3109          * kept in case they're an op_next entry point.
3110          */
3111         lastkidop = cLISTOPx(topop)->op_last;
3112         kid = cUNOPx(topop)->op_first; /* pushmark */
3113         op_null(kid);
3114         op_null(OpSIBLING(kid));       /* const */
3115         if (o != topop) {
3116             kid = op_sibling_splice(topop, NULL, -1, NULL); /* cut all args */
3117             op_sibling_splice(o, NULL, 0, kid); /* and attach to o */
3118             lastkidop->op_next = o;
3119         }
3120     }
3121     else {
3122         p = const_str;
3123         lenp = aux + PERL_MULTICONCAT_IX_LENGTHS;
3124
3125         lenp->ssize = -1;
3126
3127         /* Concatenate all const strings into const_str.
3128          * Note that args[] contains the RHS args in reverse order, so
3129          * we scan args[] from top to bottom to get constant strings
3130          * in L-R order
3131          */
3132         for (argp = toparg; argp >= args; argp--) {
3133             if (!argp->p)
3134                 /* not a const op */
3135                 (++lenp)->ssize = -1;
3136             else {
3137                 STRLEN l = argp->len;
3138                 Copy(argp->p, p, l, char);
3139                 p += l;
3140                 if (lenp->ssize == -1)
3141                     lenp->ssize = l;
3142                 else
3143                     lenp->ssize += l;
3144             }
3145         }
3146
3147         kid = topop;
3148         nextop = o;
3149         lastkidop = NULL;
3150
3151         for (argp = args; argp <= toparg; argp++) {
3152             /* only keep non-const args, except keep the first-in-next-chain
3153              * arg no matter what it is (but nulled if OP_CONST), because it
3154              * may be the entry point to this subtree from the previous
3155              * op_next.
3156              */
3157             bool last = (argp == toparg);
3158             OP *prev;
3159
3160             /* set prev to the sibling *before* the arg to be cut out,
3161              * e.g.:
3162              *
3163              *         |
3164              * kid=  CONST
3165              *         |
3166              * prev= CONST -- EXPR
3167              *         |
3168              */
3169             if (argp == args && kid->op_type != OP_CONCAT) {
3170                 /* in e.g. '$x . = f(1)' there's no RHS concat tree
3171                  * so the expression to be cut isn't kid->op_last but
3172                  * kid itself */
3173                 OP *o1, *o2;
3174                 /* find the op before kid */
3175                 o1 = NULL;
3176                 o2 = cUNOPx(parentop)->op_first;
3177                 while (o2 && o2 != kid) {
3178                     o1 = o2;
3179                     o2 = OpSIBLING(o2);
3180                 }
3181                 assert(o2 == kid);
3182                 prev = o1;
3183                 kid  = parentop;
3184             }
3185             else if (kid == o && lastkidop)
3186                 prev = last ? lastkidop : OpSIBLING(lastkidop);
3187             else
3188                 prev = last ? NULL : cUNOPx(kid)->op_first;
3189
3190             if (!argp->p || last) {
3191                 /* cut RH op */
3192                 OP *aop = op_sibling_splice(kid, prev, 1, NULL);
3193                 /* and unshift to front of o */
3194                 op_sibling_splice(o, NULL, 0, aop);
3195                 /* record the right-most op added to o: later we will
3196                  * free anything to the right of it */
3197                 if (!lastkidop)
3198                     lastkidop = aop;
3199                 aop->op_next = nextop;
3200                 if (last) {
3201                     if (argp->p)
3202                         /* null the const at start of op_next chain */
3203                         op_null(aop);
3204                 }
3205                 else if (prev)
3206                     nextop = prev->op_next;
3207             }
3208
3209             /* the last two arguments are both attached to the same concat op */
3210             if (argp < toparg - 1)
3211                 kid = prev;
3212         }
3213     }
3214
3215     /* Populate the aux struct */
3216
3217     aux[PERL_MULTICONCAT_IX_NARGS].ssize     = nargs;
3218     aux[PERL_MULTICONCAT_IX_PLAIN_PV].pv    = utf8 ? NULL : const_str;
3219     aux[PERL_MULTICONCAT_IX_PLAIN_LEN].ssize = utf8 ?    0 : total_len;
3220     aux[PERL_MULTICONCAT_IX_UTF8_PV].pv     = const_str;
3221     aux[PERL_MULTICONCAT_IX_UTF8_LEN].ssize  = total_len;
3222
3223     /* if variant > 0, calculate a variant const string and lengths where
3224      * the utf8 version of the string will take 'variant' more bytes than
3225      * the plain one. */
3226
3227     if (variant) {
3228         char              *p = const_str;
3229         STRLEN          ulen = total_len + variant;
3230         UNOP_AUX_item  *lens = aux + PERL_MULTICONCAT_IX_LENGTHS;
3231         UNOP_AUX_item *ulens = lens + (nargs + 1);
3232         char             *up = (char*)PerlMemShared_malloc(ulen);
3233         SSize_t            n;
3234
3235         aux[PERL_MULTICONCAT_IX_UTF8_PV].pv    = up;
3236         aux[PERL_MULTICONCAT_IX_UTF8_LEN].ssize = ulen;
3237
3238         for (n = 0; n < (nargs + 1); n++) {
3239             SSize_t i;
3240             char * orig_up = up;
3241             for (i = (lens++)->ssize; i > 0; i--) {
3242                 U8 c = *p++;
3243                 append_utf8_from_native_byte(c, (U8**)&up);
3244             }
3245             (ulens++)->ssize = (i < 0) ? i : up - orig_up;
3246         }
3247     }
3248
3249     if (stringop) {
3250         /* if there was a top(ish)-level OP_STRINGIFY, we need to keep
3251          * that op's first child - an ex-PUSHMARK - because the op_next of
3252          * the previous op may point to it (i.e. it's the entry point for
3253          * the o optree)
3254          */
3255         OP *pmop =
3256             (stringop == o)
3257                 ? op_sibling_splice(o, lastkidop, 1, NULL)
3258                 : op_sibling_splice(stringop, NULL, 1, NULL);
3259         assert(OP_TYPE_IS_OR_WAS_NN(pmop, OP_PUSHMARK));
3260         op_sibling_splice(o, NULL, 0, pmop);
3261         if (!lastkidop)
3262             lastkidop = pmop;
3263     }
3264
3265     /* Optimise 
3266      *    target  = A.B.C...
3267      *    target .= A.B.C...
3268      */
3269
3270     if (targetop) {
3271         assert(!targmyop);
3272
3273         if (o->op_type == OP_SASSIGN) {
3274             /* Move the target subtree from being the last of o's children
3275              * to being the last of o's preserved children.
3276              * Note the difference between 'target = ...' and 'target .= ...':
3277              * for the former, target is executed last; for the latter,
3278              * first.
3279              */
3280             kid = OpSIBLING(lastkidop);
3281             op_sibling_splice(o, kid, 1, NULL); /* cut target op */
3282             op_sibling_splice(o, lastkidop, 0, targetop); /* and paste */
3283             lastkidop->op_next = kid->op_next;
3284             lastkidop = targetop;
3285         }
3286         else {
3287             /* Move the target subtree from being the first of o's
3288              * original children to being the first of *all* o's children.
3289              */
3290             if (lastkidop) {
3291                 op_sibling_splice(o, lastkidop, 1, NULL); /* cut target op */
3292                 op_sibling_splice(o, NULL, 0, targetop);  /* and paste*/
3293             }
3294             else {
3295                 /* if the RHS of .= doesn't contain a concat (e.g.
3296                  * $x .= "foo"), it gets missed by the "strip ops from the
3297                  * tree and add to o" loop earlier */
3298                 assert(topop->op_type != OP_CONCAT);
3299                 if (stringop) {
3300                     /* in e.g. $x .= "$y", move the $y expression
3301                      * from being a child of OP_STRINGIFY to being the
3302                      * second child of the OP_CONCAT
3303                      */
3304                     assert(cUNOPx(stringop)->op_first == topop);
3305                     op_sibling_splice(stringop, NULL, 1, NULL);
3306                     op_sibling_splice(o, cUNOPo->op_first, 0, topop);
3307                 }
3308                 assert(topop == OpSIBLING(cBINOPo->op_first));
3309                 if (toparg->p)
3310                     op_null(topop);
3311                 lastkidop = topop;
3312             }
3313         }
3314
3315         if (is_targable) {
3316             /* optimise
3317              *  my $lex  = A.B.C...
3318              *     $lex  = A.B.C...
3319              *     $lex .= A.B.C...
3320              * The original padsv op is kept but nulled in case it's the
3321              * entry point for the optree (which it will be for
3322              * '$lex .=  ... '
3323              */
3324             private_flags |= OPpTARGET_MY;
3325             private_flags |= (targetop->op_private & OPpLVAL_INTRO);
3326             o->op_targ = targetop->op_targ;
3327             targetop->op_targ = 0;
3328             op_null(targetop);
3329         }
3330         else
3331             flags |= OPf_STACKED;
3332     }
3333     else if (targmyop) {
3334         private_flags |= OPpTARGET_MY;
3335         if (o != targmyop) {
3336             o->op_targ = targmyop->op_targ;
3337             targmyop->op_targ = 0;
3338         }
3339     }
3340
3341     /* detach the emaciated husk of the sprintf/concat optree and free it */
3342     for (;;) {
3343         kid = op_sibling_splice(o, lastkidop, 1, NULL);
3344         if (!kid)
3345             break;
3346         op_free(kid);
3347     }
3348
3349     /* and convert o into a multiconcat */
3350
3351     o->op_flags        = (flags|OPf_KIDS|stacked_last
3352                          |(o->op_flags & (OPf_WANT|OPf_PARENS)));
3353     o->op_private      = private_flags;
3354     o->op_type         = OP_MULTICONCAT;
3355     o->op_ppaddr       = PL_ppaddr[OP_MULTICONCAT];
3356     cUNOP_AUXo->op_aux = aux;
3357 }
3358
3359
3360 /* do all the final processing on an optree (e.g. running the peephole
3361  * optimiser on it), then attach it to cv (if cv is non-null)
3362  */
3363
3364 static void
3365 S_process_optree(pTHX_ CV *cv, OP *optree, OP* start)
3366 {
3367     OP **startp;
3368
3369     /* XXX for some reason, evals, require and main optrees are
3370      * never attached to their CV; instead they just hang off
3371      * PL_main_root + PL_main_start or PL_eval_root + PL_eval_start
3372      * and get manually freed when appropriate */
3373     if (cv)
3374         startp = &CvSTART(cv);
3375     else
3376         startp = PL_in_eval? &PL_eval_start : &PL_main_start;
3377
3378     *startp = start;
3379     optree->op_private |= OPpREFCOUNTED;
3380     OpREFCNT_set(optree, 1);
3381     optimize_optree(optree);
3382     CALL_PEEP(*startp);
3383     finalize_optree(optree);
3384     S_prune_chain_head(startp);
3385
3386     if (cv) {
3387         /* now that optimizer has done its work, adjust pad values */
3388         pad_tidy(optree->op_type == OP_LEAVEWRITE ? padtidy_FORMAT
3389                  : CvCLONE(cv) ? padtidy_SUBCLONE : padtidy_SUB);
3390     }
3391 }
3392
3393
3394 /*
3395 =for apidoc optimize_optree
3396
3397 This function applies some optimisations to the optree in top-down order.
3398 It is called before the peephole optimizer, which processes ops in
3399 execution order. Note that finalize_optree() also does a top-down scan,
3400 but is called *after* the peephole optimizer.
3401
3402 =cut
3403 */
3404
3405 void
3406 Perl_optimize_optree(pTHX_ OP* o)
3407 {
3408     PERL_ARGS_ASSERT_OPTIMIZE_OPTREE;
3409
3410     ENTER;
3411     SAVEVPTR(PL_curcop);
3412
3413     optimize_op(o);
3414
3415     LEAVE;
3416 }
3417
3418
3419 /* helper for optimize_optree() which optimises on op then recurses
3420  * to optimise any children.
3421  */
3422
3423 STATIC void
3424 S_optimize_op(pTHX_ OP* o)
3425 {
3426     OP *kid;
3427
3428     PERL_ARGS_ASSERT_OPTIMIZE_OP;
3429     assert(o->op_type != OP_FREED);
3430
3431     switch (o->op_type) {
3432     case OP_NEXTSTATE:
3433     case OP_DBSTATE:
3434         PL_curcop = ((COP*)o);          /* for warnings */
3435         break;
3436
3437
3438     case OP_CONCAT:
3439     case OP_SASSIGN:
3440     case OP_STRINGIFY:
3441     case OP_SPRINTF:
3442         S_maybe_multiconcat(aTHX_ o);
3443         break;
3444
3445     case OP_SUBST:
3446         if (cPMOPo->op_pmreplrootu.op_pmreplroot)
3447             optimize_op(cPMOPo->op_pmreplrootu.op_pmreplroot);
3448         break;
3449
3450     default:
3451         break;
3452     }
3453
3454     if (!(o->op_flags & OPf_KIDS))
3455         return;
3456
3457     for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid))
3458         optimize_op(kid);
3459 }
3460
3461
3462 /*
3463 =for apidoc finalize_optree
3464
3465 This function finalizes the optree.  Should be called directly after
3466 the complete optree is built.  It does some additional
3467 checking which can't be done in the normal C<ck_>xxx functions and makes
3468 the tree thread-safe.
3469
3470 =cut
3471 */
3472 void
3473 Perl_finalize_optree(pTHX_ OP* o)
3474 {
3475     PERL_ARGS_ASSERT_FINALIZE_OPTREE;
3476
3477     ENTER;
3478     SAVEVPTR(PL_curcop);
3479
3480     finalize_op(o);
3481
3482     LEAVE;
3483 }
3484
3485 #ifdef USE_ITHREADS
3486 /* Relocate sv to the pad for thread safety.
3487  * Despite being a "constant", the SV is written to,
3488  * for reference counts, sv_upgrade() etc. */
3489 PERL_STATIC_INLINE void
3490 S_op_relocate_sv(pTHX_ SV** svp, PADOFFSET* targp)
3491 {
3492     PADOFFSET ix;
3493     PERL_ARGS_ASSERT_OP_RELOCATE_SV;
3494     if (!*svp) return;
3495     ix = pad_alloc(OP_CONST, SVf_READONLY);
3496     SvREFCNT_dec(PAD_SVl(ix));
3497     PAD_SETSV(ix, *svp);
3498     /* XXX I don't know how this isn't readonly already. */
3499     if (!SvIsCOW(PAD_SVl(ix))) SvREADONLY_on(PAD_SVl(ix));
3500     *svp = NULL;
3501     *targp = ix;
3502 }
3503 #endif
3504
3505
3506 STATIC void
3507 S_finalize_op(pTHX_ OP* o)
3508 {
3509     PERL_ARGS_ASSERT_FINALIZE_OP;
3510
3511     assert(o->op_type != OP_FREED);
3512
3513     switch (o->op_type) {
3514     case OP_NEXTSTATE:
3515     case OP_DBSTATE:
3516         PL_curcop = ((COP*)o);          /* for warnings */
3517         break;
3518     case OP_EXEC:
3519         if (OpHAS_SIBLING(o)) {
3520             OP *sib = OpSIBLING(o);
3521             if ((  sib->op_type == OP_NEXTSTATE || sib->op_type == OP_DBSTATE)
3522                 && ckWARN(WARN_EXEC)
3523                 && OpHAS_SIBLING(sib))
3524             {
3525                     const OPCODE type = OpSIBLING(sib)->op_type;
3526                     if (type != OP_EXIT && type != OP_WARN && type != OP_DIE) {
3527                         const line_t oldline = CopLINE(PL_curcop);
3528                         CopLINE_set(PL_curcop, CopLINE((COP*)sib));
3529                         Perl_warner(aTHX_ packWARN(WARN_EXEC),
3530                             "Statement unlikely to be reached");
3531                         Perl_warner(aTHX_ packWARN(WARN_EXEC),
3532                             "\t(Maybe you meant system() when you said exec()?)\n");
3533                         CopLINE_set(PL_curcop, oldline);
3534                     }
3535             }
3536         }
3537         break;
3538
3539     case OP_GV:
3540         if ((o->op_private & OPpEARLY_CV) && ckWARN(WARN_PROTOTYPE)) {
3541             GV * const gv = cGVOPo_gv;
3542             if (SvTYPE(gv) == SVt_PVGV && GvCV(gv) && SvPVX_const(GvCV(gv))) {
3543                 /* XXX could check prototype here instead of just carping */
3544                 SV * const sv = sv_newmortal();
3545                 gv_efullname3(sv, gv, NULL);
3546                 Perl_warner(aTHX_ packWARN(WARN_PROTOTYPE),
3547                     "%" SVf "() called too early to check prototype",
3548                     SVfARG(sv));
3549             }
3550         }
3551         break;
3552
3553     case OP_CONST:
3554         if (cSVOPo->op_private & OPpCONST_STRICT)
3555             no_bareword_allowed(o);
3556 #ifdef USE_ITHREADS
3557         /* FALLTHROUGH */
3558     case OP_HINTSEVAL:
3559         op_relocate_sv(&cSVOPo->op_sv, &o->op_targ);
3560 #endif
3561         break;
3562
3563 #ifdef USE_ITHREADS
3564     /* Relocate all the METHOP's SVs to the pad for thread safety. */
3565     case OP_METHOD_NAMED:
3566     case OP_METHOD_SUPER:
3567     case OP_METHOD_REDIR:
3568     case OP_METHOD_REDIR_SUPER:
3569         op_relocate_sv(&cMETHOPx(o)->op_u.op_meth_sv, &o->op_targ);
3570         break;
3571 #endif
3572
3573     case OP_HELEM: {
3574         UNOP *rop;
3575         SVOP *key_op;
3576         OP *kid;
3577
3578         if ((key_op = cSVOPx(((BINOP*)o)->op_last))->op_type != OP_CONST)
3579             break;
3580
3581         rop = (UNOP*)((BINOP*)o)->op_first;
3582
3583         goto check_keys;
3584
3585     case OP_HSLICE:
3586         S_scalar_slice_warning(aTHX_ o);
3587         /* FALLTHROUGH */
3588
3589     case OP_KVHSLICE:
3590         kid = OpSIBLING(cLISTOPo->op_first);
3591         if (/* I bet there's always a pushmark... */
3592             OP_TYPE_ISNT_AND_WASNT_NN(kid, OP_LIST)
3593             && OP_TYPE_ISNT_NN(kid, OP_CONST))
3594         {
3595             break;
3596         }
3597
3598         key_op = (SVOP*)(kid->op_type == OP_CONST
3599                                 ? kid
3600                                 : OpSIBLING(kLISTOP->op_first));
3601
3602         rop = (UNOP*)((LISTOP*)o)->op_last;
3603
3604       check_keys:       
3605         if (o->op_private & OPpLVAL_INTRO || rop->op_type != OP_RV2HV)
3606             rop = NULL;
3607         S_check_hash_fields_and_hekify(aTHX_ rop, key_op);
3608         break;
3609     }
3610     case OP_NULL:
3611         if (o->op_targ != OP_HSLICE && o->op_targ != OP_ASLICE)
3612             break;
3613         /* FALLTHROUGH */
3614     case OP_ASLICE:
3615         S_scalar_slice_warning(aTHX_ o);
3616         break;
3617
3618     case OP_SUBST: {
3619         if (cPMOPo->op_pmreplrootu.op_pmreplroot)
3620             finalize_op(cPMOPo->op_pmreplrootu.op_pmreplroot);
3621         break;
3622     }
3623     default:
3624         break;
3625     }
3626
3627     if (o->op_flags & OPf_KIDS) {
3628         OP *kid;
3629
3630 #ifdef DEBUGGING
3631         /* check that op_last points to the last sibling, and that
3632          * the last op_sibling/op_sibparent field points back to the
3633          * parent, and that the only ops with KIDS are those which are
3634          * entitled to them */
3635         U32 type = o->op_type;
3636         U32 family;
3637         bool has_last;
3638
3639         if (type == OP_NULL) {
3640             type = o->op_targ;
3641             /* ck_glob creates a null UNOP with ex-type GLOB
3642              * (which is a list op. So pretend it wasn't a listop */
3643             if (type == OP_GLOB)
3644                 type = OP_NULL;
3645         }
3646         family = PL_opargs[type] & OA_CLASS_MASK;
3647
3648         has_last = (   family == OA_BINOP
3649                     || family == OA_LISTOP
3650                     || family == OA_PMOP
3651                     || family == OA_LOOP
3652                    );
3653         assert(  has_last /* has op_first and op_last, or ...
3654               ... has (or may have) op_first: */
3655               || family == OA_UNOP
3656               || family == OA_UNOP_AUX
3657               || family == OA_LOGOP
3658               || family == OA_BASEOP_OR_UNOP
3659               || family == OA_FILESTATOP
3660               || family == OA_LOOPEXOP
3661               || family == OA_METHOP
3662               || type == OP_CUSTOM
3663               || type == OP_NULL /* new_logop does this */
3664               );
3665
3666         for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
3667 #  ifdef PERL_OP_PARENT
3668             if (!OpHAS_SIBLING(kid)) {
3669                 if (has_last)
3670                     assert(kid == cLISTOPo->op_last);
3671                 assert(kid->op_sibparent == o);
3672             }
3673 #  else
3674             if (has_last && !OpHAS_SIBLING(kid))
3675                 assert(kid == cLISTOPo->op_last);
3676 #  endif
3677         }
3678 #endif
3679
3680         for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid))
3681             finalize_op(kid);
3682     }
3683 }
3684
3685 /*
3686 =for apidoc Amx|OP *|op_lvalue|OP *o|I32 type
3687
3688 Propagate lvalue ("modifiable") context to an op and its children.
3689 C<type> represents the context type, roughly based on the type of op that
3690 would do the modifying, although C<local()> is represented by C<OP_NULL>,
3691 because it has no op type of its own (it is signalled by a flag on
3692 the lvalue op).
3693
3694 This function detects things that can't be modified, such as C<$x+1>, and
3695 generates errors for them.  For example, C<$x+1 = 2> would cause it to be
3696 called with an op of type C<OP_ADD> and a C<type> argument of C<OP_SASSIGN>.
3697
3698 It also flags things that need to behave specially in an lvalue context,
3699 such as C<$$x = 5> which might have to vivify a reference in C<$x>.
3700
3701 =cut
3702 */
3703
3704 static void
3705 S_mark_padname_lvalue(pTHX_ PADNAME *pn)
3706 {
3707     CV *cv = PL_compcv;
3708     PadnameLVALUE_on(pn);
3709     while (PadnameOUTER(pn) && PARENT_PAD_INDEX(pn)) {
3710         cv = CvOUTSIDE(cv);
3711         /* RT #127786: cv can be NULL due to an eval within the DB package
3712          * called from an anon sub - anon subs don't have CvOUTSIDE() set
3713          * unless they contain an eval, but calling eval within DB
3714          * pretends the eval was done in the caller's scope.
3715          */
3716         if (!cv)
3717             break;
3718         assert(CvPADLIST(cv));
3719         pn =
3720            PadlistNAMESARRAY(CvPADLIST(cv))[PARENT_PAD_INDEX(pn)];
3721         assert(PadnameLEN(pn));
3722         PadnameLVALUE_on(pn);
3723     }
3724 }
3725
3726 static bool
3727 S_vivifies(const OPCODE type)
3728 {
3729     switch(type) {
3730     case OP_RV2AV:     case   OP_ASLICE:
3731     case OP_RV2HV:     case OP_KVASLICE:
3732     case OP_RV2SV:     case   OP_HSLICE:
3733     case OP_AELEMFAST: case OP_KVHSLICE:
3734     case OP_HELEM:
3735     case OP_AELEM:
3736         return 1;
3737     }
3738     return 0;
3739 }
3740
3741 static void
3742 S_lvref(pTHX_ OP *o, I32 type)
3743 {
3744     dVAR;
3745     OP *kid;
3746     switch (o->op_type) {
3747     case OP_COND_EXPR:
3748         for (kid = OpSIBLING(cUNOPo->op_first); kid;
3749              kid = OpSIBLING(kid))
3750             S_lvref(aTHX_ kid, type);
3751         /* FALLTHROUGH */
3752     case OP_PUSHMARK:
3753         return;
3754     case OP_RV2AV:
3755         if (cUNOPo->op_first->op_type != OP_GV) goto badref;
3756         o->op_flags |= OPf_STACKED;
3757         if (o->op_flags & OPf_PARENS) {
3758             if (o->op_private & OPpLVAL_INTRO) {
3759                  yyerror(Perl_form(aTHX_ "Can't modify reference to "
3760                       "localized parenthesized array in list assignment"));
3761                 return;
3762             }
3763           slurpy:
3764             OpTYPE_set(o, OP_LVAVREF);
3765             o->op_private &= OPpLVAL_INTRO|OPpPAD_STATE;
3766             o->op_flags |= OPf_MOD|OPf_REF;
3767             return;
3768         }
3769         o->op_private |= OPpLVREF_AV;
3770         goto checkgv;
3771     case OP_RV2CV:
3772         kid = cUNOPo->op_first;
3773         if (kid->op_type == OP_NULL)
3774             kid = cUNOPx(OpSIBLING(kUNOP->op_first))
3775                 ->op_first;
3776         o->op_private = OPpLVREF_CV;
3777         if (kid->op_type == OP_GV)
3778             o->op_flags |= OPf_STACKED;
3779         else if (kid->op_type == OP_PADCV) {
3780             o->op_targ = kid->op_targ;
3781             kid->op_targ = 0;
3782             op_free(cUNOPo->op_first);
3783             cUNOPo->op_first = NULL;
3784             o->op_flags &=~ OPf_KIDS;
3785         }
3786         else goto badref;
3787         break;
3788     case OP_RV2HV:
3789         if (o->op_flags & OPf_PARENS) {
3790           parenhash:
3791             yyerror(Perl_form(aTHX_ "Can't modify reference to "
3792                                  "parenthesized hash in list assignment"));
3793                 return;
3794         }
3795         o->op_private |= OPpLVREF_HV;
3796         /* FALLTHROUGH */
3797     case OP_RV2SV:
3798       checkgv:
3799         if (cUNOPo->op_first->op_type != OP_GV) goto badref;
3800         o->op_flags |= OPf_STACKED;
3801         break;
3802     case OP_PADHV:
3803         if (o->op_flags & OPf_PARENS) goto parenhash;
3804         o->op_private |= OPpLVREF_HV;
3805         /* FALLTHROUGH */
3806     case OP_PADSV:
3807         PAD_COMPNAME_GEN_set(o->op_targ, PERL_INT_MAX);
3808         break;
3809     case OP_PADAV:
3810         PAD_COMPNAME_GEN_set(o->op_targ, PERL_INT_MAX);
3811         if (o->op_flags & OPf_PARENS) goto slurpy;
3812         o->op_private |= OPpLVREF_AV;
3813         break;
3814     case OP_AELEM:
3815     case OP_HELEM:
3816         o->op_private |= OPpLVREF_ELEM;
3817         o->op_flags   |= OPf_STACKED;
3818         break;
3819     case OP_ASLICE:
3820     case OP_HSLICE:
3821         OpTYPE_set(o, OP_LVREFSLICE);
3822         o->op_private &= OPpLVAL_INTRO;
3823         return;
3824     case OP_NULL:
3825         if (o->op_flags & OPf_SPECIAL)          /* do BLOCK */
3826             goto badref;
3827         else if (!(o->op_flags & OPf_KIDS))
3828             return;
3829         if (o->op_targ != OP_LIST) {
3830             S_lvref(aTHX_ cBINOPo->op_first, type);
3831             return;
3832         }
3833         /* FALLTHROUGH */
3834     case OP_LIST:
3835         for (kid = cLISTOPo->op_first; kid; kid = OpSIBLING(kid)) {
3836             assert((kid->op_flags & OPf_WANT) != OPf_WANT_VOID);
3837             S_lvref(aTHX_ kid, type);
3838         }
3839         return;
3840     case OP_STUB:
3841         if (o->op_flags & OPf_PARENS)
3842             return;
3843         /* FALLTHROUGH */
3844     default:
3845       badref:
3846         /* diag_listed_as: Can't modify reference to %s in %s assignment */
3847         yyerror(Perl_form(aTHX_ "Can't modify reference to %s in %s",
3848                      o->op_type == OP_NULL && o->op_flags & OPf_SPECIAL
3849                       ? "do block"
3850                       : OP_DESC(o),
3851                      PL_op_desc[type]));
3852         return;
3853     }
3854     OpTYPE_set(o, OP_LVREF);
3855     o->op_private &=
3856         OPpLVAL_INTRO|OPpLVREF_ELEM|OPpLVREF_TYPE|OPpPAD_STATE;
3857     if (type == OP_ENTERLOOP)
3858         o->op_private |= OPpLVREF_ITER;
3859 }
3860
3861 PERL_STATIC_INLINE bool
3862 S_potential_mod_type(I32 type)
3863 {
3864     /* Types that only potentially result in modification.  */
3865     return type == OP_GREPSTART || type == OP_ENTERSUB
3866         || type == OP_REFGEN    || type == OP_LEAVESUBLV;
3867 }
3868
3869 OP *
3870 Perl_op_lvalue_flags(pTHX_ OP *o, I32 type, U32 flags)
3871 {
3872     dVAR;
3873     OP *kid;
3874     /* -1 = error on localize, 0 = ignore localize, 1 = ok to localize */
3875     int localize = -1;
3876
3877     if (!o || (PL_parser && PL_parser->error_count))
3878         return o;
3879
3880     if ((o->op_private & OPpTARGET_MY)
3881         && (PL_opargs[o->op_type] & OA_TARGLEX))/* OPp share the meaning */
3882     {
3883         return o;
3884     }
3885
3886     assert( (o->op_flags & OPf_WANT) != OPf_WANT_VOID );
3887
3888     if (type == OP_PRTF || type == OP_SPRINTF) type = OP_ENTERSUB;
3889
3890     switch (o->op_type) {
3891     case OP_UNDEF:
3892         PL_modcount++;
3893         return o;
3894     case OP_STUB:
3895         if ((o->op_flags & OPf_PARENS))
3896             break;
3897         goto nomod;
3898     case OP_ENTERSUB:
3899         if ((type == OP_UNDEF || type == OP_REFGEN || type == OP_LOCK) &&
3900             !(o->op_flags & OPf_STACKED)) {
3901             OpTYPE_set(o, OP_RV2CV);            /* entersub => rv2cv */
3902             assert(cUNOPo->op_first->op_type == OP_NULL);
3903             op_null(((LISTOP*)cUNOPo->op_first)->op_first);/* disable pushmark */
3904             break;
3905         }
3906         else {                          /* lvalue subroutine call */
3907             o->op_private |= OPpLVAL_INTRO;
3908             PL_modcount = RETURN_UNLIMITED_NUMBER;
3909             if (S_potential_mod_type(type)) {
3910                 o->op_private |= OPpENTERSUB_INARGS;
3911                 break;
3912             }
3913             else {                      /* Compile-time error message: */
3914                 OP *kid = cUNOPo->op_first;
3915                 CV *cv;
3916                 GV *gv;
3917                 SV *namesv;
3918
3919                 if (kid->op_type != OP_PUSHMARK) {
3920                     if (kid->op_type != OP_NULL || kid->op_targ != OP_LIST)
3921                         Perl_croak(aTHX_
3922                                 "panic: unexpected lvalue entersub "
3923                                 "args: type/targ %ld:%" UVuf,
3924                                 (long)kid->op_type, (UV)kid->op_targ);
3925                     kid = kLISTOP->op_first;
3926                 }
3927                 while (OpHAS_SIBLING(kid))
3928                     kid = OpSIBLING(kid);
3929                 if (!(kid->op_type == OP_NULL && kid->op_targ == OP_RV2CV)) {
3930                     break;      /* Postpone until runtime */
3931                 }
3932
3933                 kid = kUNOP->op_first;
3934                 if (kid->op_type == OP_NULL && kid->op_targ == OP_RV2SV)
3935                     kid = kUNOP->op_first;
3936                 if (kid->op_type == OP_NULL)
3937                     Perl_croak(aTHX_
3938                                "Unexpected constant lvalue entersub "
3939                                "entry via type/targ %ld:%" UVuf,
3940                                (long)kid->op_type, (UV)kid->op_targ);
3941                 if (kid->op_type != OP_GV) {
3942                     break;
3943                 }
3944
3945                 gv = kGVOP_gv;
3946                 cv = isGV(gv)
3947                     ? GvCV(gv)
3948                     : SvROK(gv) && SvTYPE(SvRV(gv)) == SVt_PVCV
3949                         ? MUTABLE_CV(SvRV(gv))
3950                         : NULL;
3951                 if (!cv)
3952                     break;
3953                 if (CvLVALUE(cv))
3954                     break;
3955                 if (flags & OP_LVALUE_NO_CROAK)
3956                     return NULL;
3957
3958                 namesv = cv_name(cv, NULL, 0);
3959                 yyerror_pv(Perl_form(aTHX_ "Can't modify non-lvalue "
3960                                      "subroutine call of &%" SVf " in %s",
3961                                      SVfARG(namesv), PL_op_desc[type]),
3962                            SvUTF8(namesv));
3963                 return o;
3964             }
3965         }
3966         /* FALLTHROUGH */
3967     default:
3968       nomod:
3969         if (flags & OP_LVALUE_NO_CROAK) return NULL;
3970         /* grep, foreach, subcalls, refgen */
3971         if (S_potential_mod_type(type))
3972             break;
3973         yyerror(Perl_form(aTHX_ "Can't modify %s in %s",
3974                      (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL)
3975                       ? "do block"
3976                       : OP_DESC(o)),
3977                      type ? PL_op_desc[type] : "local"));
3978         return o;
3979
3980     case OP_PREINC:
3981     case OP_PREDEC:
3982     case OP_POW:
3983     case OP_MULTIPLY:
3984     case OP_DIVIDE:
3985     case OP_MODULO:
3986     case OP_ADD:
3987     case OP_SUBTRACT:
3988     case OP_CONCAT:
3989     case OP_LEFT_SHIFT:
3990     case OP_RIGHT_SHIFT:
3991     case OP_BIT_AND:
3992     case OP_BIT_XOR:
3993     case OP_BIT_OR:
3994     case OP_I_MULTIPLY:
3995     case OP_I_DIVIDE:
3996     case OP_I_MODULO:
3997     case OP_I_ADD:
3998     case OP_I_SUBTRACT:
3999         if (!(o->op_flags & OPf_STACKED))
4000             goto nomod;
4001         PL_modcount++;
4002         break;
4003
4004     case OP_REPEAT:
4005         if (o->op_flags & OPf_STACKED) {
4006             PL_modcount++;
4007             break;
4008         }
4009         if (!(o->op_private & OPpREPEAT_DOLIST))
4010             goto nomod;
4011         else {
4012             const I32 mods = PL_modcount;
4013             modkids(cBINOPo->op_first, type);
4014             if (type != OP_AASSIGN)
4015                 goto nomod;
4016             kid = cBINOPo->op_last;
4017             if (kid->op_type == OP_CONST && SvIOK(kSVOP_sv)) {
4018                 const IV iv = SvIV(kSVOP_sv);
4019                 if (PL_modcount != RETURN_UNLIMITED_NUMBER)
4020                     PL_modcount =
4021                         mods + (PL_modcount - mods) * (iv < 0 ? 0 : iv);
4022             }
4023             else
4024                 PL_modcount = RETURN_UNLIMITED_NUMBER;
4025         }
4026         break;
4027
4028     case OP_COND_EXPR:
4029         localize = 1;
4030         for (kid = OpSIBLING(cUNOPo->op_first); kid; kid = OpSIBLING(kid))
4031             op_lvalue(kid, type);
4032         break;
4033
4034     case OP_RV2AV:
4035     case OP_RV2HV:
4036         if (type == OP_REFGEN && o->op_flags & OPf_PARENS) {
4037            PL_modcount = RETURN_UNLIMITED_NUMBER;
4038             return o;           /* Treat \(@foo) like ordinary list. */
4039         }
4040         /* FALLTHROUGH */
4041     case OP_RV2GV:
4042         if (scalar_mod_type(o, type))
4043             goto nomod;
4044         ref(cUNOPo->op_first, o->op_type);
4045         /* FALLTHROUGH */
4046     case OP_ASLICE:
4047     case OP_HSLICE:
4048         localize = 1;
4049         /* FALLTHROUGH */
4050     case OP_AASSIGN:
4051         /* Do not apply the lvsub flag for rv2[ah]v in scalar context.  */
4052         if (type == OP_LEAVESUBLV && (
4053                 (o->op_type != OP_RV2AV && o->op_type != OP_RV2HV)
4054              || (o->op_flags & OPf_WANT) != OPf_WANT_SCALAR
4055            ))
4056             o->op_private |= OPpMAYBE_LVSUB;
4057         /* FALLTHROUGH */
4058     case OP_NEXTSTATE:
4059     case OP_DBSTATE:
4060        PL_modcount = RETURN_UNLIMITED_NUMBER;
4061         break;
4062     case OP_KVHSLICE:
4063     case OP_KVASLICE:
4064     case OP_AKEYS:
4065         if (type == OP_LEAVESUBLV)
4066             o->op_private |= OPpMAYBE_LVSUB;
4067         goto nomod;
4068     case OP_AVHVSWITCH:
4069         if (type == OP_LEAVESUBLV
4070          && (o->op_private & OPpAVHVSWITCH_MASK) + OP_EACH == OP_KEYS)
4071             o->op_private |= OPpMAYBE_LVSUB;
4072         goto nomod;
4073     case OP_AV2ARYLEN:
4074         PL_hints |= HINT_BLOCK_SCOPE;
4075         if (type == OP_LEAVESUBLV)
4076             o->op_private |= OPpMAYBE_LVSUB;
4077         PL_modcount++;
4078         break;
4079     case OP_RV2SV:
4080         ref(cUNOPo->op_first, o->op_type);
4081         localize = 1;
4082         /* FALLTHROUGH */
4083     case OP_GV:
4084         PL_hints |= HINT_BLOCK_SCOPE;
4085         /* FALLTHROUGH */
4086     case OP_SASSIGN:
4087     case OP_ANDASSIGN:
4088     case OP_ORASSIGN:
4089     case OP_DORASSIGN:
4090         PL_modcount++;
4091         break;
4092
4093     case OP_AELEMFAST:
4094     case OP_AELEMFAST_LEX:
4095         localize = -1;
4096         PL_modcount++;
4097         break;
4098
4099     case OP_PADAV:
4100     case OP_PADHV:
4101        PL_modcount = RETURN_UNLIMITED_NUMBER;
4102         if (type == OP_REFGEN && o->op_flags & OPf_PARENS)
4103             return o;           /* Treat \(@foo) like ordinary list. */
4104         if (scalar_mod_type(o, type))
4105             goto nomod;
4106         if ((o->op_flags & OPf_WANT) != OPf_WANT_SCALAR
4107           && type == OP_LEAVESUBLV)
4108             o->op_private |= OPpMAYBE_LVSUB;
4109         /* FALLTHROUGH */
4110     case OP_PADSV:
4111         PL_modcount++;
4112         if (!type) /* local() */
4113             Perl_croak(aTHX_ "Can't localize lexical variable %" PNf,
4114                               PNfARG(PAD_COMPNAME(o->op_targ)));
4115         if (!(o->op_private & OPpLVAL_INTRO)
4116          || (  type != OP_SASSIGN && type != OP_AASSIGN
4117             && PadnameIsSTATE(PAD_COMPNAME_SV(o->op_targ))  ))
4118             S_mark_padname_lvalue(aTHX_ PAD_COMPNAME_SV(o->op_targ));
4119         break;
4120
4121     case OP_PUSHMARK:
4122         localize = 0;
4123         break;
4124
4125     case OP_KEYS:
4126         if (type != OP_LEAVESUBLV && !scalar_mod_type(NULL, type))
4127             goto nomod;
4128         goto lvalue_func;
4129     case OP_SUBSTR:
4130         if (o->op_private == 4) /* don't allow 4 arg substr as lvalue */
4131             goto nomod;
4132         /* FALLTHROUGH */
4133     case OP_POS:
4134     case OP_VEC:
4135       lvalue_func:
4136         if (type == OP_LEAVESUBLV)
4137             o->op_private |= OPpMAYBE_LVSUB;
4138         if (o->op_flags & OPf_KIDS && OpHAS_SIBLING(cBINOPo->op_first)) {
4139             /* substr and vec */
4140             /* If this op is in merely potential (non-fatal) modifiable
4141                context, then apply OP_ENTERSUB context to
4142                the kid op (to avoid croaking).  Other-
4143                wise pass this op’s own type so the correct op is mentioned
4144                in error messages.  */
4145             op_lvalue(OpSIBLING(cBINOPo->op_first),
4146                       S_potential_mod_type(type)
4147                         ? (I32)OP_ENTERSUB
4148                         : o->op_type);
4149         }
4150         break;
4151
4152     case OP_AELEM:
4153     case OP_HELEM:
4154         ref(cBINOPo->op_first, o->op_type);
4155         if (type == OP_ENTERSUB &&
4156              !(o->op_private & (OPpLVAL_INTRO | OPpDEREF)))
4157             o->op_private |= OPpLVAL_DEFER;
4158         if (type == OP_LEAVESUBLV)
4159             o->op_private |= OPpMAYBE_LVSUB;
4160         localize = 1;
4161         PL_modcount++;
4162         break;
4163
4164     case OP_LEAVE:
4165     case OP_LEAVELOOP:
4166         o->op_private |= OPpLVALUE;
4167         /* FALLTHROUGH */
4168     case OP_SCOPE:
4169     case OP_ENTER:
4170     case OP_LINESEQ:
4171         localize = 0;
4172         if (o->op_flags & OPf_KIDS)
4173             op_lvalue(cLISTOPo->op_last, type);
4174         break;
4175
4176     case OP_NULL:
4177         localize = 0;
4178         if (o->op_flags & OPf_SPECIAL)          /* do BLOCK */
4179             goto nomod;
4180         else if (!(o->op_flags & OPf_KIDS))
4181             break;
4182
4183         if (o->op_targ != OP_LIST) {
4184             OP *sib = OpSIBLING(cLISTOPo->op_first);
4185             /* OP_TRANS and OP_TRANSR with argument have a weird optree
4186              * that looks like
4187              *
4188              *   null
4189              *      arg
4190              *      trans
4191              *
4192              * compared with things like OP_MATCH which have the argument
4193              * as a child:
4194              *
4195              *   match
4196              *      arg
4197              *
4198              * so handle specially to correctly get "Can't modify" croaks etc
4199              */
4200
4201             if (sib && (sib->op_type == OP_TRANS || sib->op_type == OP_TRANSR))
4202             {
4203                 /* this should trigger a "Can't modify transliteration" err */
4204                 op_lvalue(sib, type);
4205             }
4206             op_lvalue(cBINOPo->op_first, type);
4207             break;
4208         }
4209         /* FALLTHROUGH */
4210     case OP_LIST:
4211         localize = 0;
4212         for (kid = cLISTOPo->op_first; kid; kid = OpSIBLING(kid))
4213             /* elements might be in void context because the list is
4214                in scalar context or because they are attribute sub calls */
4215             if ( (kid->op_flags & OPf_WANT) != OPf_WANT_VOID )
4216                 op_lvalue(kid, type);
4217         break;
4218
4219     case OP_COREARGS:
4220         return o;
4221
4222     case OP_AND:
4223     case OP_OR:
4224         if (type == OP_LEAVESUBLV
4225          || !S_vivifies(cLOGOPo->op_first->op_type))
4226             op_lvalue(cLOGOPo->op_first, type);
4227         if (type == OP_LEAVESUBLV
4228          || !S_vivifies(OpSIBLING(cLOGOPo->op_first)->op_type))
4229             op_lvalue(OpSIBLING(cLOGOPo->op_first), type);
4230         goto nomod;
4231
4232     case OP_SREFGEN:
4233         if (type == OP_NULL) { /* local */
4234           local_refgen:
4235             if (!FEATURE_MYREF_IS_ENABLED)
4236                 Perl_croak(aTHX_ "The experimental declared_refs "
4237                                  "feature is not enabled");
4238             Perl_ck_warner_d(aTHX_
4239                      packWARN(WARN_EXPERIMENTAL__DECLARED_REFS),
4240                     "Declaring references is experimental");
4241             op_lvalue(cUNOPo->op_first, OP_NULL);
4242             return o;
4243         }
4244         if (type != OP_AASSIGN && type != OP_SASSIGN
4245          && type != OP_ENTERLOOP)
4246             goto nomod;
4247         /* Don’t bother applying lvalue context to the ex-list.  */
4248         kid = cUNOPx(cUNOPo->op_first)->op_first;
4249         assert (!OpHAS_SIBLING(kid));
4250         goto kid_2lvref;
4251     case OP_REFGEN:
4252         if (type == OP_NULL) /* local */
4253             goto local_refgen;
4254         if (type != OP_AASSIGN) goto nomod;
4255         kid = cUNOPo->op_first;
4256       kid_2lvref:
4257         {
4258             const U8 ec = PL_parser ? PL_parser->error_count : 0;
4259             S_lvref(aTHX_ kid, type);
4260             if (!PL_parser || PL_parser->error_count == ec) {
4261                 if (!FEATURE_REFALIASING_IS_ENABLED)
4262                     Perl_croak(aTHX_
4263                        "Experimental aliasing via reference not enabled");
4264                 Perl_ck_warner_d(aTHX_
4265                                  packWARN(WARN_EXPERIMENTAL__REFALIASING),
4266                                 "Aliasing via reference is experimental");
4267             }
4268         }
4269         if (o->op_type == OP_REFGEN)
4270             op_null(cUNOPx(cUNOPo->op_first)->op_first); /* pushmark */
4271         op_null(o);
4272         return o;
4273
4274     case OP_SPLIT:
4275         if ((o->op_private & OPpSPLIT_ASSIGN)) {
4276             /* This is actually @array = split.  */
4277             PL_modcount = RETURN_UNLIMITED_NUMBER;
4278             break;
4279         }
4280         goto nomod;
4281
4282     case OP_SCALAR:
4283         op_lvalue(cUNOPo->op_first, OP_ENTERSUB);
4284         goto nomod;
4285     }
4286
4287     /* [20011101.069 (#7861)] File test operators interpret OPf_REF to mean that
4288        their argument is a filehandle; thus \stat(".") should not set
4289        it. AMS 20011102 */
4290     if (type == OP_REFGEN &&
4291         PL_check[o->op_type] == Perl_ck_ftst)
4292         return o;
4293
4294     if (type != OP_LEAVESUBLV)
4295         o->op_flags |= OPf_MOD;
4296
4297     if (type == OP_AASSIGN || type == OP_SASSIGN)
4298         o->op_flags |= OPf_SPECIAL
4299                       |(o->op_type == OP_ENTERSUB ? 0 : OPf_REF);
4300     else if (!type) { /* local() */
4301         switch (localize) {
4302         case 1:
4303             o->op_private |= OPpLVAL_INTRO;
4304             o->op_flags &= ~OPf_SPECIAL;
4305             PL_hints |= HINT_BLOCK_SCOPE;
4306             break;
4307         case 0:
4308             break;
4309         case -1:
4310             Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX),
4311                            "Useless localization of %s", OP_DESC(o));
4312         }
4313     }
4314     else if (type != OP_GREPSTART && type != OP_ENTERSUB
4315              && type != OP_LEAVESUBLV && o->op_type != OP_ENTERSUB)
4316         o->op_flags |= OPf_REF;
4317     return o;
4318 }
4319
4320 STATIC bool
4321 S_scalar_mod_type(const OP *o, I32 type)
4322 {
4323     switch (type) {
4324     case OP_POS:
4325     case OP_SASSIGN:
4326         if (o && o->op_type == OP_RV2GV)
4327             return FALSE;
4328         /* FALLTHROUGH */
4329     case OP_PREINC:
4330     case OP_PREDEC:
4331     case OP_POSTINC:
4332     case OP_POSTDEC:
4333     case OP_I_PREINC:
4334     case OP_I_PREDEC:
4335     case OP_I_POSTINC:
4336     case OP_I_POSTDEC:
4337     case OP_POW:
4338     case OP_MULTIPLY:
4339     case OP_DIVIDE:
4340     case OP_MODULO:
4341     case OP_REPEAT:
4342     case OP_ADD:
4343     case OP_SUBTRACT:
4344     case OP_I_MULTIPLY:
4345     case OP_I_DIVIDE:
4346     case OP_I_MODULO:
4347     case OP_I_ADD:
4348     case OP_I_SUBTRACT:
4349     case OP_LEFT_SHIFT:
4350     case OP_RIGHT_SHIFT:
4351     case OP_BIT_AND:
4352     case OP_BIT_XOR:
4353     case OP_BIT_OR:
4354     case OP_NBIT_AND:
4355     case OP_NBIT_XOR:
4356     case OP_NBIT_OR:
4357     case OP_SBIT_AND:
4358     case OP_SBIT_XOR:
4359     case OP_SBIT_OR:
4360     case OP_CONCAT:
4361     case OP_SUBST:
4362     case OP_TRANS:
4363     case OP_TRANSR:
4364     case OP_READ:
4365     case OP_SYSREAD:
4366     case OP_RECV:
4367     case OP_ANDASSIGN:
4368     case OP_ORASSIGN:
4369     case OP_DORASSIGN:
4370     case OP_VEC:
4371     case OP_SUBSTR:
4372         return TRUE;
4373     default:
4374         return FALSE;
4375     }
4376 }
4377
4378 STATIC bool
4379 S_is_handle_constructor(const OP *o, I32 numargs)
4380 {
4381     PERL_ARGS_ASSERT_IS_HANDLE_CONSTRUCTOR;
4382
4383     switch (o->op_type) {
4384     case OP_PIPE_OP:
4385     case OP_SOCKPAIR:
4386         if (numargs == 2)
4387             return TRUE;
4388         /* FALLTHROUGH */
4389     case OP_SYSOPEN:
4390     case OP_OPEN:
4391     case OP_SELECT:             /* XXX c.f. SelectSaver.pm */
4392     case OP_SOCKET:
4393     case OP_OPEN_DIR:
4394     case OP_ACCEPT:
4395         if (numargs == 1)
4396             return TRUE;
4397         /* FALLTHROUGH */
4398     default:
4399         return FALSE;
4400     }
4401 }
4402
4403 static OP *
4404 S_refkids(pTHX_ OP *o, I32 type)
4405 {
4406     if (o && o->op_flags & OPf_KIDS) {
4407         OP *kid;
4408         for (kid = cLISTOPo->op_first; kid; kid = OpSIBLING(kid))
4409             ref(kid, type);
4410     }
4411     return o;
4412 }
4413
4414 OP *
4415 Perl_doref(pTHX_ OP *o, I32 type, bool set_op_ref)
4416 {
4417     dVAR;
4418     OP *kid;
4419
4420     PERL_ARGS_ASSERT_DOREF;
4421
4422     if (PL_parser && PL_parser->error_count)
4423         return o;
4424
4425     switch (o->op_type) {
4426     case OP_ENTERSUB:
4427         if ((type == OP_EXISTS || type == OP_DEFINED) &&
4428             !(o->op_flags & OPf_STACKED)) {
4429             OpTYPE_set(o, OP_RV2CV);             /* entersub => rv2cv */
4430             assert(cUNOPo->op_first->op_type == OP_NULL);
4431             op_null(((LISTOP*)cUNOPo->op_first)->op_first);     /* disable pushmark */
4432             o->op_flags |= OPf_SPECIAL;
4433         }
4434         else if (type == OP_RV2SV || type == OP_RV2AV || type == OP_RV2HV){
4435             o->op_private |= (type == OP_RV2AV ? OPpDEREF_AV
4436                               : type == OP_RV2HV ? OPpDEREF_HV
4437                               : OPpDEREF_SV);
4438             o->op_flags |= OPf_MOD;
4439         }
4440
4441         break;
4442
4443     case OP_COND_EXPR:
4444         for (kid = OpSIBLING(cUNOPo->op_first); kid; kid = OpSIBLING(kid))
4445             doref(kid, type, set_op_ref);
4446         break;
4447     case OP_RV2SV:
4448         if (type == OP_DEFINED)
4449             o->op_flags |= OPf_SPECIAL;         /* don't create GV */
4450         doref(cUNOPo->op_first, o->op_type, set_op_ref);
4451         /* FALLTHROUGH */
4452     case OP_PADSV:
4453         if (type == OP_RV2SV || type == OP_RV2AV || type == OP_RV2HV) {
4454             o->op_private |= (type == OP_RV2AV ? OPpDEREF_AV
4455                               : type == OP_RV2HV ? OPpDEREF_HV
4456                               : OPpDEREF_SV);
4457             o->op_flags |= OPf_MOD;
4458         }
4459         break;
4460
4461     case OP_RV2AV:
4462     case OP_RV2HV:
4463         if (set_op_ref)
4464             o->op_flags |= OPf_REF;
4465         /* FALLTHROUGH */
4466     case OP_RV2GV:
4467         if (type == OP_DEFINED)
4468             o->op_flags |= OPf_SPECIAL;         /* don't create GV */
4469         doref(cUNOPo->op_first, o->op_type, set_op_ref);
4470         break;
4471
4472     case OP_PADAV:
4473     case OP_PADHV:
4474         if (set_op_ref)
4475             o->op_flags |= OPf_REF;
4476         break;
4477
4478     case OP_SCALAR:
4479     case OP_NULL:
4480         if (!(o->op_flags & OPf_KIDS) || type == OP_DEFINED)
4481             break;
4482         doref(cBINOPo->op_first, type, set_op_ref);
4483         break;
4484     case OP_AELEM:
4485     case OP_HELEM:
4486         doref(cBINOPo->op_first, o->op_type, set_op_ref);
4487         if (type == OP_RV2SV || type == OP_RV2AV || type == OP_RV2HV) {
4488             o->op_private |= (type == OP_RV2AV ? OPpDEREF_AV
4489                               : type == OP_RV2HV ? OPpDEREF_HV
4490                               : OPpDEREF_SV);
4491             o->op_flags |= OPf_MOD;
4492         }
4493         break;
4494
4495     case OP_SCOPE:
4496     case OP_LEAVE:
4497         set_op_ref = FALSE;
4498         /* FALLTHROUGH */
4499     case OP_ENTER:
4500     case OP_LIST:
4501         if (!(o->op_flags & OPf_KIDS))
4502             break;
4503         doref(cLISTOPo->op_last, type, set_op_ref);
4504         break;
4505     default:
4506         break;
4507     }
4508     return scalar(o);
4509
4510 }
4511
4512 STATIC OP *
4513 S_dup_attrlist(pTHX_ OP *o)
4514 {
4515     OP *rop;
4516
4517     PERL_ARGS_ASSERT_DUP_ATTRLIST;
4518
4519     /* An attrlist is either a simple OP_CONST or an OP_LIST with kids,
4520      * where the first kid is OP_PUSHMARK and the remaining ones
4521      * are OP_CONST.  We need to push the OP_CONST values.
4522      */
4523     if (o->op_type == OP_CONST)
4524         rop = newSVOP(OP_CONST, o->op_flags, SvREFCNT_inc_NN(cSVOPo->op_sv));
4525     else {
4526         assert((o->op_type == OP_LIST) && (o->op_flags & OPf_KIDS));
4527         rop = NULL;
4528         for (o = cLISTOPo->op_first; o; o = OpSIBLING(o)) {
4529             if (o->op_type == OP_CONST)
4530                 rop = op_append_elem(OP_LIST, rop,
4531                                   newSVOP(OP_CONST, o->op_flags,
4532                                           SvREFCNT_inc_NN(cSVOPo->op_sv)));
4533         }
4534     }
4535     return rop;
4536 }
4537
4538 STATIC void
4539 S_apply_attrs(pTHX_ HV *stash, SV *target, OP *attrs)
4540 {
4541     PERL_ARGS_ASSERT_APPLY_ATTRS;
4542     {
4543         SV * const stashsv = newSVhek(HvNAME_HEK(stash));
4544
4545         /* fake up C<use attributes $pkg,$rv,@attrs> */
4546
4547 #define ATTRSMODULE "attributes"
4548 #define ATTRSMODULE_PM "attributes.pm"
4549
4550         Perl_load_module(
4551           aTHX_ PERL_LOADMOD_IMPORT_OPS,
4552           newSVpvs(ATTRSMODULE),
4553           NULL,
4554           op_prepend_elem(OP_LIST,
4555                           newSVOP(OP_CONST, 0, stashsv),
4556                           op_prepend_elem(OP_LIST,
4557                                           newSVOP(OP_CONST, 0,
4558                                                   newRV(target)),
4559                                           dup_attrlist(attrs))));
4560     }
4561 }
4562
4563 STATIC void
4564 S_apply_attrs_my(pTHX_ HV *stash, OP *target, OP *attrs, OP **imopsp)
4565 {
4566     OP *pack, *imop, *arg;
4567     SV *meth, *stashsv, **svp;
4568
4569     PERL_ARGS_ASSERT_APPLY_ATTRS_MY;
4570
4571     if (!attrs)
4572         return;
4573
4574     assert(target->op_type == OP_PADSV ||
4575            target->op_type == OP_PADHV ||
4576            target->op_type == OP_PADAV);
4577
4578     /* Ensure that attributes.pm is loaded. */
4579     /* Don't force the C<use> if we don't need it. */
4580     svp = hv_fetchs(GvHVn(PL_incgv), ATTRSMODULE_PM, FALSE);
4581     if (svp && *svp != &PL_sv_undef)
4582         NOOP;   /* already in %INC */
4583     else
4584         Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT,
4585                                newSVpvs(ATTRSMODULE), NULL);
4586
4587     /* Need package name for method call. */
4588     pack = newSVOP(OP_CONST, 0, newSVpvs(ATTRSMODULE));
4589
4590     /* Build up the real arg-list. */
4591     stashsv = newSVhek(HvNAME_HEK(stash));
4592
4593     arg = newOP(OP_PADSV, 0);
4594     arg->op_targ = target->op_targ;
4595     arg = op_prepend_elem(OP_LIST,
4596                        newSVOP(OP_CONST, 0, stashsv),
4597                        op_prepend_elem(OP_LIST,
4598                                     newUNOP(OP_REFGEN, 0,
4599                                             arg),
4600                                     dup_attrlist(attrs)));
4601
4602     /* Fake up a method call to import */
4603     meth = newSVpvs_share("import");
4604     imop = op_convert_list(OP_ENTERSUB, OPf_STACKED|OPf_SPECIAL|OPf_WANT_VOID,
4605                    op_append_elem(OP_LIST,
4606                                op_prepend_elem(OP_LIST, pack, arg),
4607                                newMETHOP_named(OP_METHOD_NAMED, 0, meth)));
4608
4609     /* Combine the ops. */
4610     *imopsp = op_append_elem(OP_LIST, *imopsp, imop);
4611 }
4612
4613 /*
4614 =notfor apidoc apply_attrs_string
4615
4616 Attempts to apply a list of attributes specified by the C<attrstr> and
4617 C<len> arguments to the subroutine identified by the C<cv> argument which
4618 is expected to be associated with the package identified by the C<stashpv>
4619 argument (see L<attributes>).  It gets this wrong, though, in that it
4620 does not correctly identify the boundaries of the individual attribute
4621 specifications within C<attrstr>.  This is not really intended for the
4622 public API, but has to be listed here for systems such as AIX which
4623 need an explicit export list for symbols.  (It's called from XS code
4624 in support of the C<ATTRS:> keyword from F<xsubpp>.)  Patches to fix it
4625 to respect attribute syntax properly would be welcome.
4626
4627 =cut
4628 */
4629
4630 void
4631 Perl_apply_attrs_string(pTHX_ const char *stashpv, CV *cv,
4632                         const char *attrstr, STRLEN len)
4633 {
4634     OP *attrs = NULL;
4635
4636     PERL_ARGS_ASSERT_APPLY_ATTRS_STRING;
4637
4638     if (!len) {
4639         len = strlen(attrstr);
4640     }
4641
4642     while (len) {
4643         for (; isSPACE(*attrstr) && len; --len, ++attrstr) ;
4644         if (len) {
4645             const char * const sstr = attrstr;
4646             for (; !isSPACE(*attrstr) && len; --len, ++attrstr) ;
4647             attrs = op_append_elem(OP_LIST, attrs,
4648                                 newSVOP(OP_CONST, 0,
4649                                         newSVpvn(sstr, attrstr-sstr)));
4650         }
4651     }
4652
4653     Perl_load_module(aTHX_ PERL_LOADMOD_IMPORT_OPS,
4654                      newSVpvs(ATTRSMODULE),
4655                      NULL, op_prepend_elem(OP_LIST,
4656                                   newSVOP(OP_CONST, 0, newSVpv(stashpv,0)),
4657                                   op_prepend_elem(OP_LIST,
4658                                                newSVOP(OP_CONST, 0,
4659                                                        newRV(MUTABLE_SV(cv))),
4660                                                attrs)));
4661 }
4662
4663 STATIC void
4664 S_move_proto_attr(pTHX_ OP **proto, OP **attrs, const GV * name,
4665                         bool curstash)
4666 {
4667     OP *new_proto = NULL;
4668     STRLEN pvlen;
4669     char *pv;
4670     OP *o;
4671
4672     PERL_ARGS_ASSERT_MOVE_PROTO_ATTR;
4673
4674     if (!*attrs)
4675         return;
4676
4677     o = *attrs;
4678     if (o->op_type == OP_CONST) {
4679         pv = SvPV(cSVOPo_sv, pvlen);
4680         if (memBEGINs(pv, pvlen, "prototype(")) {
4681             SV * const tmpsv = newSVpvn_flags(pv + 10, pvlen - 11, SvUTF8(cSVOPo_sv));
4682             SV ** const tmpo = cSVOPx_svp(o);
4683             SvREFCNT_dec(cSVOPo_sv);
4684             *tmpo = tmpsv;
4685             new_proto = o;
4686             *attrs = NULL;
4687         }
4688     } else if (o->op_type == OP_LIST) {
4689         OP * lasto;
4690         assert(o->op_flags & OPf_KIDS);
4691         lasto = cLISTOPo->op_first;
4692         assert(lasto->op_type == OP_PUSHMARK);
4693         for (o = OpSIBLING(lasto); o; o = OpSIBLING(o)) {
4694             if (o->op_type == OP_CONST) {
4695                 pv = SvPV(cSVOPo_sv, pvlen);
4696                 if (memBEGINs(pv, pvlen, "prototype(")) {
4697                     SV * const tmpsv = newSVpvn_flags(pv + 10, pvlen - 11, SvUTF8(cSVOPo_sv));
4698                     SV ** const tmpo = cSVOPx_svp(o);
4699                     SvREFCNT_dec(cSVOPo_sv);
4700                     *tmpo = tmpsv;
4701                     if (new_proto && ckWARN(WARN_MISC)) {
4702                         STRLEN new_len;
4703                         const char * newp = SvPV(cSVOPo_sv, new_len);
4704                         Perl_warner(aTHX_ packWARN(WARN_MISC),
4705                             "Attribute prototype(%" UTF8f ") discards earlier prototype attribute in same sub",
4706                             UTF8fARG(SvUTF8(cSVOPo_sv), new_len, newp));
4707                         op_free(new_proto);
4708                     }
4709                     else if (new_proto)
4710                         op_free(new_proto);
4711                     new_proto = o;
4712                     /* excise new_proto from the list */
4713                     op_sibling_splice(*attrs, lasto, 1, NULL);
4714                     o = lasto;
4715                     continue;
4716                 }
4717             }
4718             lasto = o;
4719         }
4720         /* If the list is now just the PUSHMARK, scrap the whole thing; otherwise attributes.xs
4721            would get pulled in with no real need */
4722         if (!OpHAS_SIBLING(cLISTOPx(*attrs)->op_first)) {
4723             op_free(*attrs);
4724             *attrs = NULL;
4725         }
4726     }
4727
4728     if (new_proto) {
4729         SV *svname;
4730         if (isGV(name)) {
4731             svname = sv_newmortal();
4732             gv_efullname3(svname, name, NULL);
4733         }
4734         else if (SvPOK(name) && *SvPVX((SV *)name) == '&')
4735             svname = newSVpvn_flags(SvPVX((SV *)name)+1, SvCUR(name)-1, SvUTF8(name)|SVs_TEMP);
4736         else
4737             svname = (SV *)name;
4738         if (ckWARN(WARN_ILLEGALPROTO))
4739             (void)validate_proto(svname, cSVOPx_sv(new_proto), TRUE,
4740                                  curstash);
4741         if (*proto && ckWARN(WARN_PROTOTYPE)) {
4742             STRLEN old_len, new_len;
4743             const char * oldp = SvPV(cSVOPx_sv(*proto), old_len);
4744             const char * newp = SvPV(cSVOPx_sv(new_proto), new_len);
4745
4746             if (curstash && svname == (SV *)name
4747              && !memchr(SvPVX(svname), ':', SvCUR(svname))) {