Revert "re_intuit_start(): rename some local vars"
[perl.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_CONCAT:
1953             if ((o->op_flags & OPf_STACKED) &&
1954                     !(o->op_private & OPpCONCAT_NESTED))
1955                 break;
1956             goto func_ops;
1957         case OP_SUBSTR:
1958             if (o->op_private == 4)
1959                 break;
1960             /* FALLTHROUGH */
1961         case OP_WANTARRAY:
1962         case OP_GV:
1963         case OP_SMARTMATCH:
1964         case OP_AV2ARYLEN:
1965         case OP_REF:
1966         case OP_REFGEN:
1967         case OP_SREFGEN:
1968         case OP_DEFINED:
1969         case OP_HEX:
1970         case OP_OCT:
1971         case OP_LENGTH:
1972         case OP_VEC:
1973         case OP_INDEX:
1974         case OP_RINDEX:
1975         case OP_SPRINTF:
1976         case OP_KVASLICE:
1977         case OP_KVHSLICE:
1978         case OP_UNPACK:
1979         case OP_PACK:
1980         case OP_JOIN:
1981         case OP_LSLICE:
1982         case OP_ANONLIST:
1983         case OP_ANONHASH:
1984         case OP_SORT:
1985         case OP_REVERSE:
1986         case OP_RANGE:
1987         case OP_FLIP:
1988         case OP_FLOP:
1989         case OP_CALLER:
1990         case OP_FILENO:
1991         case OP_EOF:
1992         case OP_TELL:
1993         case OP_GETSOCKNAME:
1994         case OP_GETPEERNAME:
1995         case OP_READLINK:
1996         case OP_TELLDIR:
1997         case OP_GETPPID:
1998         case OP_GETPGRP:
1999         case OP_GETPRIORITY:
2000         case OP_TIME:
2001         case OP_TMS:
2002         case OP_LOCALTIME:
2003         case OP_GMTIME:
2004         case OP_GHBYNAME:
2005         case OP_GHBYADDR:
2006         case OP_GHOSTENT:
2007         case OP_GNBYNAME:
2008         case OP_GNBYADDR:
2009         case OP_GNETENT:
2010         case OP_GPBYNAME:
2011         case OP_GPBYNUMBER:
2012         case OP_GPROTOENT:
2013         case OP_GSBYNAME:
2014         case OP_GSBYPORT:
2015         case OP_GSERVENT:
2016         case OP_GPWNAM:
2017         case OP_GPWUID:
2018         case OP_GGRNAM:
2019         case OP_GGRGID:
2020         case OP_GETLOGIN:
2021         case OP_PROTOTYPE:
2022         case OP_RUNCV:
2023         func_ops:
2024             useless = OP_DESC(o);
2025             break;
2026
2027         case OP_GVSV:
2028         case OP_PADSV:
2029         case OP_PADAV:
2030         case OP_PADHV:
2031         case OP_PADANY:
2032         case OP_AELEM:
2033         case OP_AELEMFAST:
2034         case OP_AELEMFAST_LEX:
2035         case OP_ASLICE:
2036         case OP_HELEM:
2037         case OP_HSLICE:
2038             if (!(o->op_private & (OPpLVAL_INTRO|OPpOUR_INTRO)))
2039                 /* Otherwise it's "Useless use of grep iterator" */
2040                 useless = OP_DESC(o);
2041             break;
2042
2043         case OP_SPLIT:
2044             if (!(o->op_private & OPpSPLIT_ASSIGN))
2045                 useless = OP_DESC(o);
2046             break;
2047
2048         case OP_NOT:
2049             kid = cUNOPo->op_first;
2050             if (kid->op_type != OP_MATCH && kid->op_type != OP_SUBST &&
2051                 kid->op_type != OP_TRANS && kid->op_type != OP_TRANSR) {
2052                 goto func_ops;
2053             }
2054             useless = "negative pattern binding (!~)";
2055             break;
2056
2057         case OP_SUBST:
2058             if (cPMOPo->op_pmflags & PMf_NONDESTRUCT)
2059                 useless = "non-destructive substitution (s///r)";
2060             break;
2061
2062         case OP_TRANSR:
2063             useless = "non-destructive transliteration (tr///r)";
2064             break;
2065
2066         case OP_RV2GV:
2067         case OP_RV2SV:
2068         case OP_RV2AV:
2069         case OP_RV2HV:
2070             if (!(o->op_private & (OPpLVAL_INTRO|OPpOUR_INTRO)) &&
2071                 (!OpHAS_SIBLING(o) || OpSIBLING(o)->op_type != OP_READLINE))
2072                 useless = "a variable";
2073             break;
2074
2075         case OP_CONST:
2076             sv = cSVOPo_sv;
2077             if (cSVOPo->op_private & OPpCONST_STRICT)
2078                 no_bareword_allowed(o);
2079             else {
2080                 if (ckWARN(WARN_VOID)) {
2081                     NV nv;
2082                     /* don't warn on optimised away booleans, eg
2083                      * use constant Foo, 5; Foo || print; */
2084                     if (cSVOPo->op_private & OPpCONST_SHORTCIRCUIT)
2085                         useless = NULL;
2086                     /* the constants 0 and 1 are permitted as they are
2087                        conventionally used as dummies in constructs like
2088                        1 while some_condition_with_side_effects;  */
2089                     else if (SvNIOK(sv) && ((nv = SvNV(sv)) == 0.0 || nv == 1.0))
2090                         useless = NULL;
2091                     else if (SvPOK(sv)) {
2092                         SV * const dsv = newSVpvs("");
2093                         useless_sv
2094                             = Perl_newSVpvf(aTHX_
2095                                             "a constant (%s)",
2096                                             pv_pretty(dsv, SvPVX_const(sv),
2097                                                       SvCUR(sv), 32, NULL, NULL,
2098                                                       PERL_PV_PRETTY_DUMP
2099                                                       | PERL_PV_ESCAPE_NOCLEAR
2100                                                       | PERL_PV_ESCAPE_UNI_DETECT));
2101                         SvREFCNT_dec_NN(dsv);
2102                     }
2103                     else if (SvOK(sv)) {
2104                         useless_sv = Perl_newSVpvf(aTHX_ "a constant (%" SVf ")", SVfARG(sv));
2105                     }
2106                     else
2107                         useless = "a constant (undef)";
2108                 }
2109             }
2110             op_null(o);         /* don't execute or even remember it */
2111             break;
2112
2113         case OP_POSTINC:
2114             OpTYPE_set(o, OP_PREINC);  /* pre-increment is faster */
2115             break;
2116
2117         case OP_POSTDEC:
2118             OpTYPE_set(o, OP_PREDEC);  /* pre-decrement is faster */
2119             break;
2120
2121         case OP_I_POSTINC:
2122             OpTYPE_set(o, OP_I_PREINC);        /* pre-increment is faster */
2123             break;
2124
2125         case OP_I_POSTDEC:
2126             OpTYPE_set(o, OP_I_PREDEC);        /* pre-decrement is faster */
2127             break;
2128
2129         case OP_SASSIGN: {
2130             OP *rv2gv;
2131             UNOP *refgen, *rv2cv;
2132             LISTOP *exlist;
2133
2134             if ((o->op_private & ~OPpASSIGN_BACKWARDS) != 2)
2135                 break;
2136
2137             rv2gv = ((BINOP *)o)->op_last;
2138             if (!rv2gv || rv2gv->op_type != OP_RV2GV)
2139                 break;
2140
2141             refgen = (UNOP *)((BINOP *)o)->op_first;
2142
2143             if (!refgen || (refgen->op_type != OP_REFGEN
2144                             && refgen->op_type != OP_SREFGEN))
2145                 break;
2146
2147             exlist = (LISTOP *)refgen->op_first;
2148             if (!exlist || exlist->op_type != OP_NULL
2149                 || exlist->op_targ != OP_LIST)
2150                 break;
2151
2152             if (exlist->op_first->op_type != OP_PUSHMARK
2153                 && exlist->op_first != exlist->op_last)
2154                 break;
2155
2156             rv2cv = (UNOP*)exlist->op_last;
2157
2158             if (rv2cv->op_type != OP_RV2CV)
2159                 break;
2160
2161             assert ((rv2gv->op_private & OPpDONT_INIT_GV) == 0);
2162             assert ((o->op_private & OPpASSIGN_CV_TO_GV) == 0);
2163             assert ((rv2cv->op_private & OPpMAY_RETURN_CONSTANT) == 0);
2164
2165             o->op_private |= OPpASSIGN_CV_TO_GV;
2166             rv2gv->op_private |= OPpDONT_INIT_GV;
2167             rv2cv->op_private |= OPpMAY_RETURN_CONSTANT;
2168
2169             break;
2170         }
2171
2172         case OP_AASSIGN: {
2173             inplace_aassign(o);
2174             break;
2175         }
2176
2177         case OP_OR:
2178         case OP_AND:
2179             kid = cLOGOPo->op_first;
2180             if (kid->op_type == OP_NOT
2181                 && (kid->op_flags & OPf_KIDS)) {
2182                 if (o->op_type == OP_AND) {
2183                     OpTYPE_set(o, OP_OR);
2184                 } else {
2185                     OpTYPE_set(o, OP_AND);
2186                 }
2187                 op_null(kid);
2188             }
2189             /* FALLTHROUGH */
2190
2191         case OP_DOR:
2192         case OP_COND_EXPR:
2193         case OP_ENTERGIVEN:
2194         case OP_ENTERWHEN:
2195             for (kid = OpSIBLING(cUNOPo->op_first); kid; kid = OpSIBLING(kid))
2196                 if (!(kid->op_flags & OPf_KIDS))
2197                     scalarvoid(kid);
2198                 else
2199                     DEFER_OP(kid);
2200         break;
2201
2202         case OP_NULL:
2203             if (o->op_flags & OPf_STACKED)
2204                 break;
2205             /* FALLTHROUGH */
2206         case OP_NEXTSTATE:
2207         case OP_DBSTATE:
2208         case OP_ENTERTRY:
2209         case OP_ENTER:
2210             if (!(o->op_flags & OPf_KIDS))
2211                 break;
2212             /* FALLTHROUGH */
2213         case OP_SCOPE:
2214         case OP_LEAVE:
2215         case OP_LEAVETRY:
2216         case OP_LEAVELOOP:
2217         case OP_LINESEQ:
2218         case OP_LEAVEGIVEN:
2219         case OP_LEAVEWHEN:
2220         kids:
2221             for (kid = cLISTOPo->op_first; kid; kid = OpSIBLING(kid))
2222                 if (!(kid->op_flags & OPf_KIDS))
2223                     scalarvoid(kid);
2224                 else
2225                     DEFER_OP(kid);
2226             break;
2227         case OP_LIST:
2228             /* If the first kid after pushmark is something that the padrange
2229                optimisation would reject, then null the list and the pushmark.
2230             */
2231             if ((kid = cLISTOPo->op_first)->op_type == OP_PUSHMARK
2232                 && (  !(kid = OpSIBLING(kid))
2233                       || (  kid->op_type != OP_PADSV
2234                             && kid->op_type != OP_PADAV
2235                             && kid->op_type != OP_PADHV)
2236                       || kid->op_private & ~OPpLVAL_INTRO
2237                       || !(kid = OpSIBLING(kid))
2238                       || (  kid->op_type != OP_PADSV
2239                             && kid->op_type != OP_PADAV
2240                             && kid->op_type != OP_PADHV)
2241                       || kid->op_private & ~OPpLVAL_INTRO)
2242             ) {
2243                 op_null(cUNOPo->op_first); /* NULL the pushmark */
2244                 op_null(o); /* NULL the list */
2245             }
2246             goto kids;
2247         case OP_ENTEREVAL:
2248             scalarkids(o);
2249             break;
2250         case OP_SCALAR:
2251             scalar(o);
2252             break;
2253         }
2254
2255         if (useless_sv) {
2256             /* mortalise it, in case warnings are fatal.  */
2257             Perl_ck_warner(aTHX_ packWARN(WARN_VOID),
2258                            "Useless use of %" SVf " in void context",
2259                            SVfARG(sv_2mortal(useless_sv)));
2260         }
2261         else if (useless) {
2262             Perl_ck_warner(aTHX_ packWARN(WARN_VOID),
2263                            "Useless use of %s in void context",
2264                            useless);
2265         }
2266     } while ( (o = POP_DEFERRED_OP()) );
2267
2268     Safefree(defer_stack);
2269
2270     return arg;
2271 }
2272
2273 static OP *
2274 S_listkids(pTHX_ OP *o)
2275 {
2276     if (o && o->op_flags & OPf_KIDS) {
2277         OP *kid;
2278         for (kid = cLISTOPo->op_first; kid; kid = OpSIBLING(kid))
2279             list(kid);
2280     }
2281     return o;
2282 }
2283
2284 OP *
2285 Perl_list(pTHX_ OP *o)
2286 {
2287     OP *kid;
2288
2289     /* assumes no premature commitment */
2290     if (!o || (o->op_flags & OPf_WANT)
2291          || (PL_parser && PL_parser->error_count)
2292          || o->op_type == OP_RETURN)
2293     {
2294         return o;
2295     }
2296
2297     if ((o->op_private & OPpTARGET_MY)
2298         && (PL_opargs[o->op_type] & OA_TARGLEX))/* OPp share the meaning */
2299     {
2300         return o;                               /* As if inside SASSIGN */
2301     }
2302
2303     o->op_flags = (o->op_flags & ~OPf_WANT) | OPf_WANT_LIST;
2304
2305     switch (o->op_type) {
2306     case OP_FLOP:
2307         list(cBINOPo->op_first);
2308         break;
2309     case OP_REPEAT:
2310         if (o->op_private & OPpREPEAT_DOLIST
2311          && !(o->op_flags & OPf_STACKED))
2312         {
2313             list(cBINOPo->op_first);
2314             kid = cBINOPo->op_last;
2315             if (kid->op_type == OP_CONST && SvIOK(kSVOP_sv)
2316              && SvIVX(kSVOP_sv) == 1)
2317             {
2318                 op_null(o); /* repeat */
2319                 op_null(cUNOPx(cBINOPo->op_first)->op_first);/* pushmark */
2320                 /* const (rhs): */
2321                 op_free(op_sibling_splice(o, cBINOPo->op_first, 1, NULL));
2322             }
2323         }
2324         break;
2325     case OP_OR:
2326     case OP_AND:
2327     case OP_COND_EXPR:
2328         for (kid = OpSIBLING(cUNOPo->op_first); kid; kid = OpSIBLING(kid))
2329             list(kid);
2330         break;
2331     default:
2332     case OP_MATCH:
2333     case OP_QR:
2334     case OP_SUBST:
2335     case OP_NULL:
2336         if (!(o->op_flags & OPf_KIDS))
2337             break;
2338         if (!o->op_next && cUNOPo->op_first->op_type == OP_FLOP) {
2339             list(cBINOPo->op_first);
2340             return gen_constant_list(o);
2341         }
2342         listkids(o);
2343         break;
2344     case OP_LIST:
2345         listkids(o);
2346         if (cLISTOPo->op_first->op_type == OP_PUSHMARK) {
2347             op_null(cUNOPo->op_first); /* NULL the pushmark */
2348             op_null(o); /* NULL the list */
2349         }
2350         break;
2351     case OP_LEAVE:
2352     case OP_LEAVETRY:
2353         kid = cLISTOPo->op_first;
2354         list(kid);
2355         kid = OpSIBLING(kid);
2356     do_kids:
2357         while (kid) {
2358             OP *sib = OpSIBLING(kid);
2359             if (sib && kid->op_type != OP_LEAVEWHEN)
2360                 scalarvoid(kid);
2361             else
2362                 list(kid);
2363             kid = sib;
2364         }
2365         PL_curcop = &PL_compiling;
2366         break;
2367     case OP_SCOPE:
2368     case OP_LINESEQ:
2369         kid = cLISTOPo->op_first;
2370         goto do_kids;
2371     }
2372     return o;
2373 }
2374
2375 static OP *
2376 S_scalarseq(pTHX_ OP *o)
2377 {
2378     if (o) {
2379         const OPCODE type = o->op_type;
2380
2381         if (type == OP_LINESEQ || type == OP_SCOPE ||
2382             type == OP_LEAVE || type == OP_LEAVETRY)
2383         {
2384             OP *kid, *sib;
2385             for (kid = cLISTOPo->op_first; kid; kid = sib) {
2386                 if ((sib = OpSIBLING(kid))
2387                  && (  OpHAS_SIBLING(sib) || sib->op_type != OP_NULL
2388                     || (  sib->op_targ != OP_NEXTSTATE
2389                        && sib->op_targ != OP_DBSTATE  )))
2390                 {
2391                     scalarvoid(kid);
2392                 }
2393             }
2394             PL_curcop = &PL_compiling;
2395         }
2396         o->op_flags &= ~OPf_PARENS;
2397         if (PL_hints & HINT_BLOCK_SCOPE)
2398             o->op_flags |= OPf_PARENS;
2399     }
2400     else
2401         o = newOP(OP_STUB, 0);
2402     return o;
2403 }
2404
2405 STATIC OP *
2406 S_modkids(pTHX_ OP *o, I32 type)
2407 {
2408     if (o && o->op_flags & OPf_KIDS) {
2409         OP *kid;
2410         for (kid = cLISTOPo->op_first; kid; kid = OpSIBLING(kid))
2411             op_lvalue(kid, type);
2412     }
2413     return o;
2414 }
2415
2416
2417 /* for a helem/hslice/kvslice, if its a fixed hash, croak on invalid
2418  * const fields. Also, convert CONST keys to HEK-in-SVs.
2419  * rop is the op that retrieves the hash;
2420  * key_op is the first key
2421  */
2422
2423 STATIC void
2424 S_check_hash_fields_and_hekify(pTHX_ UNOP *rop, SVOP *key_op)
2425 {
2426     PADNAME *lexname;
2427     GV **fields;
2428     bool check_fields;
2429
2430     /* find the padsv corresponding to $lex->{} or @{$lex}{} */
2431     if (rop) {
2432         if (rop->op_first->op_type == OP_PADSV)
2433             /* @$hash{qw(keys here)} */
2434             rop = (UNOP*)rop->op_first;
2435         else {
2436             /* @{$hash}{qw(keys here)} */
2437             if (rop->op_first->op_type == OP_SCOPE
2438                 && cLISTOPx(rop->op_first)->op_last->op_type == OP_PADSV)
2439                 {
2440                     rop = (UNOP*)cLISTOPx(rop->op_first)->op_last;
2441                 }
2442             else
2443                 rop = NULL;
2444         }
2445     }
2446
2447     lexname = NULL; /* just to silence compiler warnings */
2448     fields  = NULL; /* just to silence compiler warnings */
2449
2450     check_fields =
2451             rop
2452          && (lexname = padnamelist_fetch(PL_comppad_name, rop->op_targ),
2453              SvPAD_TYPED(lexname))
2454          && (fields = (GV**)hv_fetchs(PadnameTYPE(lexname), "FIELDS", FALSE))
2455          && isGV(*fields) && GvHV(*fields);
2456
2457     for (; key_op; key_op = (SVOP*)OpSIBLING(key_op)) {
2458         SV **svp, *sv;
2459         if (key_op->op_type != OP_CONST)
2460             continue;
2461         svp = cSVOPx_svp(key_op);
2462
2463         /* make sure it's not a bareword under strict subs */
2464         if (key_op->op_private & OPpCONST_BARE &&
2465             key_op->op_private & OPpCONST_STRICT)
2466         {
2467             no_bareword_allowed((OP*)key_op);
2468         }
2469
2470         /* Make the CONST have a shared SV */
2471         if (   !SvIsCOW_shared_hash(sv = *svp)
2472             && SvTYPE(sv) < SVt_PVMG
2473             && SvOK(sv)
2474             && !SvROK(sv))
2475         {
2476             SSize_t keylen;
2477             const char * const key = SvPV_const(sv, *(STRLEN*)&keylen);
2478             SV *nsv = newSVpvn_share(key, SvUTF8(sv) ? -keylen : keylen, 0);
2479             SvREFCNT_dec_NN(sv);
2480             *svp = nsv;
2481         }
2482
2483         if (   check_fields
2484             && !hv_fetch_ent(GvHV(*fields), *svp, FALSE, 0))
2485         {
2486             Perl_croak(aTHX_ "No such class field \"%" SVf "\" "
2487                         "in variable %" PNf " of type %" HEKf,
2488                         SVfARG(*svp), PNfARG(lexname),
2489                         HEKfARG(HvNAME_HEK(PadnameTYPE(lexname))));
2490         }
2491     }
2492 }
2493
2494 /* info returned by S_sprintf_is_multiconcatable() */
2495
2496 struct sprintf_ismc_info {
2497     SSize_t nargs;    /* num of args to sprintf (not including the format) */
2498     char  *start;     /* start of raw format string */
2499     char  *end;       /* bytes after end of raw format string */
2500     STRLEN total_len; /* total length (in bytes) of format string, not
2501                          including '%s' and  half of '%%' */
2502     STRLEN variant;   /* number of bytes by which total_len_p would grow
2503                          if upgraded to utf8 */
2504     bool   utf8;      /* whether the format is utf8 */
2505 };
2506
2507
2508 /* is the OP_SPRINTF o suitable for converting into a multiconcat op?
2509  * i.e. its format argument is a const string with only '%s' and '%%'
2510  * formats, and the number of args is known, e.g.
2511  *    sprintf "a=%s f=%s", $a[0], scalar(f());
2512  * but not
2513  *    sprintf "i=%d a=%s f=%s", $i, @a, f();
2514  *
2515  * If successful, the sprintf_ismc_info struct pointed to by info will be
2516  * populated.
2517  */
2518
2519 STATIC bool
2520 S_sprintf_is_multiconcatable(pTHX_ OP *o,struct sprintf_ismc_info *info)
2521 {
2522     OP    *pm, *constop, *kid;
2523     SV    *sv;
2524     char  *s, *e, *p;
2525     SSize_t nargs, nformats;
2526     STRLEN cur, total_len, variant;
2527     bool   utf8;
2528
2529     /* if sprintf's behaviour changes, die here so that someone
2530      * can decide whether to enhance this function or skip optimising
2531      * under those new circumstances */
2532     assert(!(o->op_flags & OPf_STACKED));
2533     assert(!(PL_opargs[OP_SPRINTF] & OA_TARGLEX));
2534     assert(!(o->op_private & ~OPpARG4_MASK));
2535
2536     pm = cUNOPo->op_first;
2537     if (pm->op_type != OP_PUSHMARK) /* weird coreargs stuff */
2538         return FALSE;
2539     constop = OpSIBLING(pm);
2540     if (!constop || constop->op_type != OP_CONST)
2541         return FALSE;
2542     sv = cSVOPx_sv(constop);
2543     if (SvMAGICAL(sv) || !SvPOK(sv))
2544         return FALSE;
2545
2546     s = SvPV(sv, cur);
2547     e = s + cur;
2548
2549     /* Scan format for %% and %s and work out how many %s there are.
2550      * Abandon if other format types are found.
2551      */
2552
2553     nformats  = 0;
2554     total_len = 0;
2555     variant   = 0;
2556
2557     for (p = s; p < e; p++) {
2558         if (*p != '%') {
2559             total_len++;
2560             if (!UTF8_IS_INVARIANT(*p))
2561                 variant++;
2562             continue;
2563         }
2564         p++;
2565         if (p >= e)
2566             return FALSE; /* lone % at end gives "Invalid conversion" */
2567         if (*p == '%')
2568             total_len++;
2569         else if (*p == 's')
2570             nformats++;
2571         else
2572             return FALSE;
2573     }
2574
2575     if (!nformats || nformats > PERL_MULTICONCAT_MAXARG)
2576         return FALSE;
2577
2578     utf8 = cBOOL(SvUTF8(sv));
2579     if (utf8)
2580         variant = 0;
2581
2582     /* scan args; they must all be in scalar cxt */
2583
2584     nargs = 0;
2585     kid = OpSIBLING(constop);
2586
2587     while (kid) {
2588         if ((kid->op_flags & OPf_WANT) != OPf_WANT_SCALAR)
2589             return FALSE;
2590         nargs++;
2591         kid = OpSIBLING(kid);
2592     }
2593
2594     if (nargs != nformats)
2595         return FALSE; /* e.g. sprintf("%s%s", $a); */
2596
2597
2598     info->nargs      = nargs;
2599     info->start      = s;
2600     info->end        = e;
2601     info->total_len  = total_len;
2602     info->variant    = variant;
2603     info->utf8       = utf8;
2604
2605     return TRUE;
2606 }
2607
2608
2609
2610 /* S_maybe_multiconcat():
2611  *
2612  * given an OP_STRINGIFY, OP_SASSIGN, OP_CONCAT or OP_SPRINTF op, possibly
2613  * convert it (and its children) into an OP_MULTICONCAT. See the code
2614  * comments just before pp_multiconcat() for the full details of what
2615  * OP_MULTICONCAT supports.
2616  *
2617  * Basically we're looking for an optree with a chain of OP_CONCATS down
2618  * the LHS (or an OP_SPRINTF), with possibly an OP_SASSIGN, and/or
2619  * OP_STRINGIFY, and/or OP_CONCAT acting as '.=' at its head, e.g.
2620  *
2621  *      $x = "$a$b-$c"
2622  *
2623  *  looks like
2624  *
2625  *      SASSIGN
2626  *         |
2627  *      STRINGIFY   -- PADSV[$x]
2628  *         |
2629  *         |
2630  *      ex-PUSHMARK -- CONCAT/S
2631  *                        |
2632  *                     CONCAT/S  -- PADSV[$d]
2633  *                        |
2634  *                     CONCAT    -- CONST["-"]
2635  *                        |
2636  *                     PADSV[$a] -- PADSV[$b]
2637  *
2638  * Note that at this stage the OP_SASSIGN may have already been optimised
2639  * away with OPpTARGET_MY set on the OP_STRINGIFY or OP_CONCAT.
2640  */
2641
2642 STATIC void
2643 S_maybe_multiconcat(pTHX_ OP *o)
2644 {
2645     OP *lastkidop;   /* the right-most of any kids unshifted onto o */
2646     OP *topop;       /* the top-most op in the concat tree (often equals o,
2647                         unless there are assign/stringify ops above it */
2648     OP *parentop;    /* the parent op of topop (or itself if no parent) */
2649     OP *targmyop;    /* the op (if any) with the OPpTARGET_MY flag */
2650     OP *targetop;    /* the op corresponding to target=... or target.=... */
2651     OP *stringop;    /* the OP_STRINGIFY op, if any */
2652     OP *nextop;      /* used for recreating the op_next chain without consts */
2653     OP *kid;         /* general-purpose op pointer */
2654     UNOP_AUX_item *aux;
2655     UNOP_AUX_item *lenp;
2656     char *const_str, *p;
2657     struct sprintf_ismc_info sprintf_info;
2658
2659                      /* store info about each arg in args[];
2660                       * toparg is the highest used slot; argp is a general
2661                       * pointer to args[] slots */
2662     struct {
2663         void *p;      /* initially points to const sv (or null for op);
2664                          later, set to SvPV(constsv), with ... */
2665         STRLEN len;   /* ... len set to SvPV(..., len) */
2666     } *argp, *toparg, args[PERL_MULTICONCAT_MAXARG*2 + 1];
2667
2668     SSize_t nargs  = 0;
2669     SSize_t nconst = 0;
2670     STRLEN variant;
2671     bool utf8 = FALSE;
2672     bool kid_is_last = FALSE; /* most args will be the RHS kid of a concat op;
2673                                  the last-processed arg will the LHS of one,
2674                                  as args are processed in reverse order */
2675     U8   stacked_last = 0;   /* whether the last seen concat op was STACKED */
2676     STRLEN total_len  = 0;   /* sum of the lengths of the const segments */
2677     U8 flags          = 0;   /* what will become the op_flags and ... */
2678     U8 private_flags  = 0;   /* ... op_private of the multiconcat op */
2679     bool is_sprintf = FALSE; /* we're optimising an sprintf */
2680     bool is_targable  = FALSE; /* targetop is an OPpTARGET_MY candidate */
2681
2682     /* -----------------------------------------------------------------
2683      * Phase 1:
2684      *
2685      * Examine the optree non-destructively to determine whether it's
2686      * suitable to be converted into an OP_MULTICONCAT. Accumulate
2687      * information about the optree in args[].
2688      */
2689
2690     argp     = args;
2691     targmyop = NULL;
2692     targetop = NULL;
2693     stringop = NULL;
2694     topop    = o;
2695     parentop = o;
2696
2697     assert(   o->op_type == OP_SASSIGN
2698            || o->op_type == OP_CONCAT
2699            || o->op_type == OP_SPRINTF
2700            || o->op_type == OP_STRINGIFY);
2701
2702     Zero(&sprintf_info, 1, struct sprintf_ismc_info);
2703
2704     /* first see if, at the top of the tree, there is an assign,
2705      * append and/or stringify */
2706
2707     if (topop->op_type == OP_SASSIGN) {
2708         /* expr = ..... */
2709         if (o->op_ppaddr != PL_ppaddr[OP_SASSIGN])
2710             return;
2711         if (o->op_private & (OPpASSIGN_BACKWARDS|OPpASSIGN_CV_TO_GV))
2712             return;
2713         assert(!(o->op_private & ~OPpARG2_MASK)); /* barf on unknown flags */
2714
2715         parentop = topop;
2716         topop = cBINOPo->op_first;
2717         targetop = OpSIBLING(topop);
2718         if (!targetop) /* probably some sort of syntax error */
2719             return;
2720     }
2721     else if (   topop->op_type == OP_CONCAT
2722              && (topop->op_flags & OPf_STACKED)
2723              && (cUNOPo->op_first->op_flags & OPf_MOD)
2724              && (!(topop->op_private & OPpCONCAT_NESTED))
2725             )
2726     {
2727         /* expr .= ..... */
2728
2729         /* OPpTARGET_MY shouldn't be able to be set here. If it is,
2730          * decide what to do about it */
2731         assert(!(o->op_private & OPpTARGET_MY));
2732
2733         /* barf on unknown flags */
2734         assert(!(o->op_private & ~(OPpARG2_MASK|OPpTARGET_MY)));
2735         private_flags |= OPpMULTICONCAT_APPEND;
2736         targetop = cBINOPo->op_first;
2737         parentop = topop;
2738         topop    = OpSIBLING(targetop);
2739
2740         /* $x .= <FOO> gets optimised to rcatline instead */
2741         if (topop->op_type == OP_READLINE)
2742             return;
2743     }
2744
2745     if (targetop) {
2746         /* Can targetop (the LHS) if it's a padsv, be be optimised
2747          * away and use OPpTARGET_MY instead?
2748          */
2749         if (    (targetop->op_type == OP_PADSV)
2750             && !(targetop->op_private & OPpDEREF)
2751             && !(targetop->op_private & OPpPAD_STATE)
2752                /* we don't support 'my $x .= ...' */
2753             && (   o->op_type == OP_SASSIGN
2754                 || !(targetop->op_private & OPpLVAL_INTRO))
2755         )
2756             is_targable = TRUE;
2757     }
2758
2759     if (topop->op_type == OP_STRINGIFY) {
2760         if (topop->op_ppaddr != PL_ppaddr[OP_STRINGIFY])
2761             return;
2762         stringop = topop;
2763
2764         /* barf on unknown flags */
2765         assert(!(o->op_private & ~(OPpARG4_MASK|OPpTARGET_MY)));
2766
2767         if ((topop->op_private & OPpTARGET_MY)) {
2768             if (o->op_type == OP_SASSIGN)
2769                 return; /* can't have two assigns */
2770             targmyop = topop;
2771         }
2772
2773         private_flags |= OPpMULTICONCAT_STRINGIFY;
2774         parentop = topop;
2775         topop = cBINOPx(topop)->op_first;
2776         assert(OP_TYPE_IS_OR_WAS_NN(topop, OP_PUSHMARK));
2777         topop = OpSIBLING(topop);
2778     }
2779
2780     if (topop->op_type == OP_SPRINTF) {
2781         if (topop->op_ppaddr != PL_ppaddr[OP_SPRINTF])
2782             return;
2783         if (S_sprintf_is_multiconcatable(aTHX_ topop, &sprintf_info)) {
2784             nargs     = sprintf_info.nargs;
2785             total_len = sprintf_info.total_len;
2786             variant   = sprintf_info.variant;
2787             utf8      = sprintf_info.utf8;
2788             is_sprintf = TRUE;
2789             private_flags |= OPpMULTICONCAT_FAKE;
2790             toparg = argp;
2791             /* we have an sprintf op rather than a concat optree.
2792              * Skip most of the code below which is associated with
2793              * processing that optree. We also skip phase 2, determining
2794              * whether its cost effective to optimise, since for sprintf,
2795              * multiconcat is *always* faster */
2796             goto create_aux;
2797         }
2798         /* note that even if the sprintf itself isn't multiconcatable,
2799          * the expression as a whole may be, e.g. in
2800          *    $x .= sprintf("%d",...)
2801          * the sprintf op will be left as-is, but the concat/S op may
2802          * be upgraded to multiconcat
2803          */
2804     }
2805     else if (topop->op_type == OP_CONCAT) {
2806         if (topop->op_ppaddr != PL_ppaddr[OP_CONCAT])
2807             return;
2808
2809         if ((topop->op_private & OPpTARGET_MY)) {
2810             if (o->op_type == OP_SASSIGN || targmyop)
2811                 return; /* can't have two assigns */
2812             targmyop = topop;
2813         }
2814     }
2815
2816     /* Is it safe to convert a sassign/stringify/concat op into
2817      * a multiconcat? */
2818     assert((PL_opargs[OP_SASSIGN]   & OA_CLASS_MASK) == OA_BINOP);
2819     assert((PL_opargs[OP_CONCAT]    & OA_CLASS_MASK) == OA_BINOP);
2820     assert((PL_opargs[OP_STRINGIFY] & OA_CLASS_MASK) == OA_LISTOP);
2821     assert((PL_opargs[OP_SPRINTF]   & OA_CLASS_MASK) == OA_LISTOP);
2822     STATIC_ASSERT_STMT(   STRUCT_OFFSET(BINOP,    op_last)
2823                        == STRUCT_OFFSET(UNOP_AUX, op_aux));
2824     STATIC_ASSERT_STMT(   STRUCT_OFFSET(LISTOP,   op_last)
2825                        == STRUCT_OFFSET(UNOP_AUX, op_aux));
2826
2827     /* Now scan the down the tree looking for a series of
2828      * CONCAT/OPf_STACKED ops on the LHS (with the last one not
2829      * stacked). For example this tree:
2830      *
2831      *     |
2832      *   CONCAT/STACKED
2833      *     |
2834      *   CONCAT/STACKED -- EXPR5
2835      *     |
2836      *   CONCAT/STACKED -- EXPR4
2837      *     |
2838      *   CONCAT -- EXPR3
2839      *     |
2840      *   EXPR1  -- EXPR2
2841      *
2842      * corresponds to an expression like
2843      *
2844      *   (EXPR1 . EXPR2 . EXPR3 . EXPR4 . EXPR5)
2845      *
2846      * Record info about each EXPR in args[]: in particular, whether it is
2847      * a stringifiable OP_CONST and if so what the const sv is.
2848      *
2849      * The reason why the last concat can't be STACKED is the difference
2850      * between
2851      *
2852      *    ((($a .= $a) .= $a) .= $a) .= $a
2853      *
2854      * and
2855      *    $a . $a . $a . $a . $a
2856      *
2857      * The main difference between the optrees for those two constructs
2858      * is the presence of the last STACKED. As well as modifying $a,
2859      * the former sees the changed $a between each concat, so if $s is
2860      * initially 'a', the first returns 'a' x 16, while the latter returns
2861      * 'a' x 5. And pp_multiconcat can't handle that kind of thing.
2862      */
2863
2864     kid = topop;
2865
2866     for (;;) {
2867         OP *argop;
2868         SV *sv;
2869         bool last = FALSE;
2870
2871         if (    kid->op_type == OP_CONCAT
2872             && !kid_is_last
2873         ) {
2874             OP *k1, *k2;
2875             k1 = cUNOPx(kid)->op_first;
2876             k2 = OpSIBLING(k1);
2877             /* shouldn't happen except maybe after compile err? */
2878             if (!k2)
2879                 return;
2880
2881             /* avoid turning (A . B . ($lex = C) ...)  into  (A . B . C ...) */
2882             if (kid->op_private & OPpTARGET_MY)
2883                 kid_is_last = TRUE;
2884
2885             stacked_last = (kid->op_flags & OPf_STACKED);
2886             if (!stacked_last)
2887                 kid_is_last = TRUE;
2888
2889             kid   = k1;
2890             argop = k2;
2891         }
2892         else {
2893             argop = kid;
2894             last = TRUE;
2895         }
2896
2897         if (   nargs              >  PERL_MULTICONCAT_MAXARG        - 2
2898             || (argp - args + 1)  > (PERL_MULTICONCAT_MAXARG*2 + 1) - 2)
2899         {
2900             /* At least two spare slots are needed to decompose both
2901              * concat args. If there are no slots left, continue to
2902              * examine the rest of the optree, but don't push new values
2903              * on args[]. If the optree as a whole is legal for conversion
2904              * (in particular that the last concat isn't STACKED), then
2905              * the first PERL_MULTICONCAT_MAXARG elements of the optree
2906              * can be converted into an OP_MULTICONCAT now, with the first
2907              * child of that op being the remainder of the optree -
2908              * which may itself later be converted to a multiconcat op
2909              * too.
2910              */
2911             if (last) {
2912                 /* the last arg is the rest of the optree */
2913                 argp++->p = NULL;
2914                 nargs++;
2915             }
2916         }
2917         else if (   argop->op_type == OP_CONST
2918             && ((sv = cSVOPx_sv(argop)))
2919             /* defer stringification until runtime of 'constant'
2920              * things that might stringify variantly, e.g. the radix
2921              * point of NVs, or overloaded RVs */
2922             && (SvPOK(sv) || SvIOK(sv))
2923             && (!SvGMAGICAL(sv))
2924         ) {
2925             argp++->p = sv;
2926             utf8   |= cBOOL(SvUTF8(sv));
2927             nconst++;
2928         }
2929         else {
2930             argp++->p = NULL;
2931             nargs++;
2932         }
2933
2934         if (last)
2935             break;
2936     }
2937
2938     toparg = argp - 1;
2939
2940     if (stacked_last)
2941         return; /* we don't support ((A.=B).=C)...) */
2942
2943     /* look for two adjacent consts and don't fold them together:
2944      *     $o . "a" . "b"
2945      * should do
2946      *     $o->concat("a")->concat("b")
2947      * rather than
2948      *     $o->concat("ab")
2949      * (but $o .=  "a" . "b" should still fold)
2950      */
2951     {
2952         bool seen_nonconst = FALSE;
2953         for (argp = toparg; argp >= args; argp--) {
2954             if (argp->p == NULL) {
2955                 seen_nonconst = TRUE;
2956                 continue;
2957             }
2958             if (!seen_nonconst)
2959                 continue;
2960             if (argp[1].p) {
2961                 /* both previous and current arg were constants;
2962                  * leave the current OP_CONST as-is */
2963                 argp->p = NULL;
2964                 nconst--;
2965                 nargs++;
2966             }
2967         }
2968     }
2969
2970     /* -----------------------------------------------------------------
2971      * Phase 2:
2972      *
2973      * At this point we have determined that the optree *can* be converted
2974      * into a multiconcat. Having gathered all the evidence, we now decide
2975      * whether it *should*.
2976      */
2977
2978
2979     /* we need at least one concat action, e.g.:
2980      *
2981      *  Y . Z
2982      *  X = Y . Z
2983      *  X .= Y
2984      *
2985      * otherwise we could be doing something like $x = "foo", which
2986      * if treated as as a concat, would fail to COW.
2987      */
2988     if (nargs + nconst + cBOOL(private_flags & OPpMULTICONCAT_APPEND) < 2)
2989         return;
2990
2991     /* Benchmarking seems to indicate that we gain if:
2992      * * we optimise at least two actions into a single multiconcat
2993      *    (e.g concat+concat, sassign+concat);
2994      * * or if we can eliminate at least 1 OP_CONST;
2995      * * or if we can eliminate a padsv via OPpTARGET_MY
2996      */
2997
2998     if (
2999            /* eliminated at least one OP_CONST */
3000            nconst >= 1
3001            /* eliminated an OP_SASSIGN */
3002         || o->op_type == OP_SASSIGN
3003            /* eliminated an OP_PADSV */
3004         || (!targmyop && is_targable)
3005     )
3006         /* definitely a net gain to optimise */
3007         goto optimise;
3008
3009     /* ... if not, what else? */
3010
3011     /* special-case '$lex1 = expr . $lex1' (where expr isn't lex1):
3012      * multiconcat is faster (due to not creating a temporary copy of
3013      * $lex1), whereas for a general $lex1 = $lex2 . $lex3, concat is
3014      * faster.
3015      */
3016     if (   nconst == 0
3017          && nargs == 2
3018          && targmyop
3019          && topop->op_type == OP_CONCAT
3020     ) {
3021         PADOFFSET t = targmyop->op_targ;
3022         OP *k1 = cBINOPx(topop)->op_first;
3023         OP *k2 = cBINOPx(topop)->op_last;
3024         if (   k2->op_type == OP_PADSV
3025             && k2->op_targ == t
3026             && (   k1->op_type != OP_PADSV
3027                 || k1->op_targ != t)
3028         )
3029             goto optimise;
3030     }
3031
3032     /* need at least two concats */
3033     if (nargs + nconst + cBOOL(private_flags & OPpMULTICONCAT_APPEND) < 3)
3034         return;
3035
3036
3037
3038     /* -----------------------------------------------------------------
3039      * Phase 3:
3040      *
3041      * At this point the optree has been verified as ok to be optimised
3042      * into an OP_MULTICONCAT. Now start changing things.
3043      */
3044
3045    optimise:
3046
3047     /* stringify all const args and determine utf8ness */
3048
3049     variant = 0;
3050     for (argp = args; argp <= toparg; argp++) {
3051         SV *sv = (SV*)argp->p;
3052         if (!sv)
3053             continue; /* not a const op */
3054         if (utf8 && !SvUTF8(sv))
3055             sv_utf8_upgrade_nomg(sv);
3056         argp->p = SvPV_nomg(sv, argp->len);
3057         total_len += argp->len;
3058         
3059         /* see if any strings would grow if converted to utf8 */
3060         if (!utf8) {
3061             char *p    = (char*)argp->p;
3062             STRLEN len = argp->len;
3063             while (len--) {
3064                 U8 c = *p++;
3065                 if (!UTF8_IS_INVARIANT(c))
3066                     variant++;
3067             }
3068         }
3069     }
3070
3071     /* create and populate aux struct */
3072
3073   create_aux:
3074
3075     aux = (UNOP_AUX_item*)PerlMemShared_malloc(
3076                     sizeof(UNOP_AUX_item)
3077                     *  (
3078                            PERL_MULTICONCAT_HEADER_SIZE
3079                          + ((nargs + 1) * (variant ? 2 : 1))
3080                         )
3081                     );
3082     const_str = (char *)PerlMemShared_malloc(total_len ? total_len : 1);
3083
3084     /* Extract all the non-const expressions from the concat tree then
3085      * dispose of the old tree, e.g. convert the tree from this:
3086      *
3087      *  o => SASSIGN
3088      *         |
3089      *       STRINGIFY   -- TARGET
3090      *         |
3091      *       ex-PUSHMARK -- CONCAT
3092      *                        |
3093      *                      CONCAT -- EXPR5
3094      *                        |
3095      *                      CONCAT -- EXPR4
3096      *                        |
3097      *                      CONCAT -- EXPR3
3098      *                        |
3099      *                      EXPR1  -- EXPR2
3100      *
3101      *
3102      * to:
3103      *
3104      *  o => MULTICONCAT
3105      *         |
3106      *       ex-PUSHMARK -- EXPR1 -- EXPR2 -- EXPR3 -- EXPR4 -- EXPR5 -- TARGET
3107      *
3108      * except that if EXPRi is an OP_CONST, it's discarded.
3109      *
3110      * During the conversion process, EXPR ops are stripped from the tree
3111      * and unshifted onto o. Finally, any of o's remaining original
3112      * childen are discarded and o is converted into an OP_MULTICONCAT.
3113      *
3114      * In this middle of this, o may contain both: unshifted args on the
3115      * left, and some remaining original args on the right. lastkidop
3116      * is set to point to the right-most unshifted arg to delineate
3117      * between the two sets.
3118      */
3119
3120
3121     if (is_sprintf) {
3122         /* create a copy of the format with the %'s removed, and record
3123          * the sizes of the const string segments in the aux struct */
3124         char *q, *oldq;
3125         lenp = aux + PERL_MULTICONCAT_IX_LENGTHS;
3126
3127         p    = sprintf_info.start;
3128         q    = const_str;
3129         oldq = q;
3130         for (; p < sprintf_info.end; p++) {
3131             if (*p == '%') {
3132                 p++;
3133                 if (*p != '%') {
3134                     (lenp++)->ssize = q - oldq;
3135                     oldq = q;
3136                     continue;
3137                 }
3138             }
3139             *q++ = *p;
3140         }
3141         lenp->ssize = q - oldq;
3142         assert((STRLEN)(q - const_str) == total_len);
3143
3144         /* Attach all the args (i.e. the kids of the sprintf) to o (which
3145          * may or may not be topop) The pushmark and const ops need to be
3146          * kept in case they're an op_next entry point.
3147          */
3148         lastkidop = cLISTOPx(topop)->op_last;
3149         kid = cUNOPx(topop)->op_first; /* pushmark */
3150         op_null(kid);
3151         op_null(OpSIBLING(kid));       /* const */
3152         if (o != topop) {
3153             kid = op_sibling_splice(topop, NULL, -1, NULL); /* cut all args */
3154             op_sibling_splice(o, NULL, 0, kid); /* and attach to o */
3155             lastkidop->op_next = o;
3156         }
3157     }
3158     else {
3159         p = const_str;
3160         lenp = aux + PERL_MULTICONCAT_IX_LENGTHS;
3161
3162         lenp->ssize = -1;
3163
3164         /* Concatenate all const strings into const_str.
3165          * Note that args[] contains the RHS args in reverse order, so
3166          * we scan args[] from top to bottom to get constant strings
3167          * in L-R order
3168          */
3169         for (argp = toparg; argp >= args; argp--) {
3170             if (!argp->p)
3171                 /* not a const op */
3172                 (++lenp)->ssize = -1;
3173             else {
3174                 STRLEN l = argp->len;
3175                 Copy(argp->p, p, l, char);
3176                 p += l;
3177                 if (lenp->ssize == -1)
3178                     lenp->ssize = l;
3179                 else
3180                     lenp->ssize += l;
3181             }
3182         }
3183
3184         kid = topop;
3185         nextop = o;
3186         lastkidop = NULL;
3187
3188         for (argp = args; argp <= toparg; argp++) {
3189             /* only keep non-const args, except keep the first-in-next-chain
3190              * arg no matter what it is (but nulled if OP_CONST), because it
3191              * may be the entry point to this subtree from the previous
3192              * op_next.
3193              */
3194             bool last = (argp == toparg);
3195             OP *prev;
3196
3197             /* set prev to the sibling *before* the arg to be cut out,
3198              * e.g.:
3199              *
3200              *         |
3201              * kid=  CONST
3202              *         |
3203              * prev= CONST -- EXPR
3204              *         |
3205              */
3206             if (argp == args && kid->op_type != OP_CONCAT) {
3207                 /* in e.g. '$x . = f(1)' there's no RHS concat tree
3208                  * so the expression to be cut isn't kid->op_last but
3209                  * kid itself */
3210                 OP *o1, *o2;
3211                 /* find the op before kid */
3212                 o1 = NULL;
3213                 o2 = cUNOPx(parentop)->op_first;
3214                 while (o2 && o2 != kid) {
3215                     o1 = o2;
3216                     o2 = OpSIBLING(o2);
3217                 }
3218                 assert(o2 == kid);
3219                 prev = o1;
3220                 kid  = parentop;
3221             }
3222             else if (kid == o && lastkidop)
3223                 prev = last ? lastkidop : OpSIBLING(lastkidop);
3224             else
3225                 prev = last ? NULL : cUNOPx(kid)->op_first;
3226
3227             if (!argp->p || last) {
3228                 /* cut RH op */
3229                 OP *aop = op_sibling_splice(kid, prev, 1, NULL);
3230                 /* and unshift to front of o */
3231                 op_sibling_splice(o, NULL, 0, aop);
3232                 /* record the right-most op added to o: later we will
3233                  * free anything to the right of it */
3234                 if (!lastkidop)
3235                     lastkidop = aop;
3236                 aop->op_next = nextop;
3237                 if (last) {
3238                     if (argp->p)
3239                         /* null the const at start of op_next chain */
3240                         op_null(aop);
3241                 }
3242                 else if (prev)
3243                     nextop = prev->op_next;
3244             }
3245
3246             /* the last two arguments are both attached to the same concat op */
3247             if (argp < toparg - 1)
3248                 kid = prev;
3249         }
3250     }
3251
3252     /* Populate the aux struct */
3253
3254     aux[PERL_MULTICONCAT_IX_NARGS].ssize     = nargs;
3255     aux[PERL_MULTICONCAT_IX_PLAIN_PV].pv    = utf8 ? NULL : const_str;
3256     aux[PERL_MULTICONCAT_IX_PLAIN_LEN].ssize = utf8 ?    0 : total_len;
3257     aux[PERL_MULTICONCAT_IX_UTF8_PV].pv     = const_str;
3258     aux[PERL_MULTICONCAT_IX_UTF8_LEN].ssize  = total_len;
3259
3260     /* if variant > 0, calculate a variant const string and lengths where
3261      * the utf8 version of the string will take 'variant' more bytes than
3262      * the plain one. */
3263
3264     if (variant) {
3265         char              *p = const_str;
3266         STRLEN          ulen = total_len + variant;
3267         UNOP_AUX_item  *lens = aux + PERL_MULTICONCAT_IX_LENGTHS;
3268         UNOP_AUX_item *ulens = lens + (nargs + 1);
3269         char             *up = (char*)PerlMemShared_malloc(ulen);
3270         SSize_t            n;
3271
3272         aux[PERL_MULTICONCAT_IX_UTF8_PV].pv    = up;
3273         aux[PERL_MULTICONCAT_IX_UTF8_LEN].ssize = ulen;
3274
3275         for (n = 0; n < (nargs + 1); n++) {
3276             SSize_t i;
3277             char * orig_up = up;
3278             for (i = (lens++)->ssize; i > 0; i--) {
3279                 U8 c = *p++;
3280                 append_utf8_from_native_byte(c, (U8**)&up);
3281             }
3282             (ulens++)->ssize = (i < 0) ? i : up - orig_up;
3283         }
3284     }
3285
3286     if (stringop) {
3287         /* if there was a top(ish)-level OP_STRINGIFY, we need to keep
3288          * that op's first child - an ex-PUSHMARK - because the op_next of
3289          * the previous op may point to it (i.e. it's the entry point for
3290          * the o optree)
3291          */
3292         OP *pmop =
3293             (stringop == o)
3294                 ? op_sibling_splice(o, lastkidop, 1, NULL)
3295                 : op_sibling_splice(stringop, NULL, 1, NULL);
3296         assert(OP_TYPE_IS_OR_WAS_NN(pmop, OP_PUSHMARK));
3297         op_sibling_splice(o, NULL, 0, pmop);
3298         if (!lastkidop)
3299             lastkidop = pmop;
3300     }
3301
3302     /* Optimise 
3303      *    target  = A.B.C...
3304      *    target .= A.B.C...
3305      */
3306
3307     if (targetop) {
3308         assert(!targmyop);
3309
3310         if (o->op_type == OP_SASSIGN) {
3311             /* Move the target subtree from being the last of o's children
3312              * to being the last of o's preserved children.
3313              * Note the difference between 'target = ...' and 'target .= ...':
3314              * for the former, target is executed last; for the latter,
3315              * first.
3316              */
3317             kid = OpSIBLING(lastkidop);
3318             op_sibling_splice(o, kid, 1, NULL); /* cut target op */
3319             op_sibling_splice(o, lastkidop, 0, targetop); /* and paste */
3320             lastkidop->op_next = kid->op_next;
3321             lastkidop = targetop;
3322         }
3323         else {
3324             /* Move the target subtree from being the first of o's
3325              * original children to being the first of *all* o's children.
3326              */
3327             if (lastkidop) {
3328                 op_sibling_splice(o, lastkidop, 1, NULL); /* cut target op */
3329                 op_sibling_splice(o, NULL, 0, targetop);  /* and paste*/
3330             }
3331             else {
3332                 /* if the RHS of .= doesn't contain a concat (e.g.
3333                  * $x .= "foo"), it gets missed by the "strip ops from the
3334                  * tree and add to o" loop earlier */
3335                 assert(topop->op_type != OP_CONCAT);
3336                 if (stringop) {
3337                     /* in e.g. $x .= "$y", move the $y expression
3338                      * from being a child of OP_STRINGIFY to being the
3339                      * second child of the OP_CONCAT
3340                      */
3341                     assert(cUNOPx(stringop)->op_first == topop);
3342                     op_sibling_splice(stringop, NULL, 1, NULL);
3343                     op_sibling_splice(o, cUNOPo->op_first, 0, topop);
3344                 }
3345                 assert(topop == OpSIBLING(cBINOPo->op_first));
3346                 if (toparg->p)
3347                     op_null(topop);
3348                 lastkidop = topop;
3349             }
3350         }
3351
3352         if (is_targable) {
3353             /* optimise
3354              *  my $lex  = A.B.C...
3355              *     $lex  = A.B.C...
3356              *     $lex .= A.B.C...
3357              * The original padsv op is kept but nulled in case it's the
3358              * entry point for the optree (which it will be for
3359              * '$lex .=  ... '
3360              */
3361             private_flags |= OPpTARGET_MY;
3362             private_flags |= (targetop->op_private & OPpLVAL_INTRO);
3363             o->op_targ = targetop->op_targ;
3364             targetop->op_targ = 0;
3365             op_null(targetop);
3366         }
3367         else
3368             flags |= OPf_STACKED;
3369     }
3370     else if (targmyop) {
3371         private_flags |= OPpTARGET_MY;
3372         if (o != targmyop) {
3373             o->op_targ = targmyop->op_targ;
3374             targmyop->op_targ = 0;
3375         }
3376     }
3377
3378     /* detach the emaciated husk of the sprintf/concat optree and free it */
3379     for (;;) {
3380         kid = op_sibling_splice(o, lastkidop, 1, NULL);
3381         if (!kid)
3382             break;
3383         op_free(kid);
3384     }
3385
3386     /* and convert o into a multiconcat */
3387
3388     o->op_flags        = (flags|OPf_KIDS|stacked_last
3389                          |(o->op_flags & (OPf_WANT|OPf_PARENS)));
3390     o->op_private      = private_flags;
3391     o->op_type         = OP_MULTICONCAT;
3392     o->op_ppaddr       = PL_ppaddr[OP_MULTICONCAT];
3393     cUNOP_AUXo->op_aux = aux;
3394 }
3395
3396
3397 /* do all the final processing on an optree (e.g. running the peephole
3398  * optimiser on it), then attach it to cv (if cv is non-null)
3399  */
3400
3401 static void
3402 S_process_optree(pTHX_ CV *cv, OP *optree, OP* start)
3403 {
3404     OP **startp;
3405
3406     /* XXX for some reason, evals, require and main optrees are
3407      * never attached to their CV; instead they just hang off
3408      * PL_main_root + PL_main_start or PL_eval_root + PL_eval_start
3409      * and get manually freed when appropriate */
3410     if (cv)
3411         startp = &CvSTART(cv);
3412     else
3413         startp = PL_in_eval? &PL_eval_start : &PL_main_start;
3414
3415     *startp = start;
3416     optree->op_private |= OPpREFCOUNTED;
3417     OpREFCNT_set(optree, 1);
3418     optimize_optree(optree);
3419     CALL_PEEP(*startp);
3420     finalize_optree(optree);
3421     S_prune_chain_head(startp);
3422
3423     if (cv) {
3424         /* now that optimizer has done its work, adjust pad values */
3425         pad_tidy(optree->op_type == OP_LEAVEWRITE ? padtidy_FORMAT
3426                  : CvCLONE(cv) ? padtidy_SUBCLONE : padtidy_SUB);
3427     }
3428 }
3429
3430
3431 /*
3432 =for apidoc optimize_optree
3433
3434 This function applies some optimisations to the optree in top-down order.
3435 It is called before the peephole optimizer, which processes ops in
3436 execution order. Note that finalize_optree() also does a top-down scan,
3437 but is called *after* the peephole optimizer.
3438
3439 =cut
3440 */
3441
3442 void
3443 Perl_optimize_optree(pTHX_ OP* o)
3444 {
3445     PERL_ARGS_ASSERT_OPTIMIZE_OPTREE;
3446
3447     ENTER;
3448     SAVEVPTR(PL_curcop);
3449
3450     optimize_op(o);
3451
3452     LEAVE;
3453 }
3454
3455
3456 /* helper for optimize_optree() which optimises on op then recurses
3457  * to optimise any children.
3458  */
3459
3460 STATIC void
3461 S_optimize_op(pTHX_ OP* o)
3462 {
3463     OP *kid;
3464
3465     PERL_ARGS_ASSERT_OPTIMIZE_OP;
3466     assert(o->op_type != OP_FREED);
3467
3468     switch (o->op_type) {
3469     case OP_NEXTSTATE:
3470     case OP_DBSTATE:
3471         PL_curcop = ((COP*)o);          /* for warnings */
3472         break;
3473
3474
3475     case OP_CONCAT:
3476     case OP_SASSIGN:
3477     case OP_STRINGIFY:
3478     case OP_SPRINTF:
3479         S_maybe_multiconcat(aTHX_ o);
3480         break;
3481
3482     case OP_SUBST:
3483         if (cPMOPo->op_pmreplrootu.op_pmreplroot)
3484             optimize_op(cPMOPo->op_pmreplrootu.op_pmreplroot);
3485         break;
3486
3487     default:
3488         break;
3489     }
3490
3491     if (!(o->op_flags & OPf_KIDS))
3492         return;
3493
3494     for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid))
3495         optimize_op(kid);
3496 }
3497
3498
3499 /*
3500 =for apidoc finalize_optree
3501
3502 This function finalizes the optree.  Should be called directly after
3503 the complete optree is built.  It does some additional
3504 checking which can't be done in the normal C<ck_>xxx functions and makes
3505 the tree thread-safe.
3506
3507 =cut
3508 */
3509 void
3510 Perl_finalize_optree(pTHX_ OP* o)
3511 {
3512     PERL_ARGS_ASSERT_FINALIZE_OPTREE;
3513
3514     ENTER;
3515     SAVEVPTR(PL_curcop);
3516
3517     finalize_op(o);
3518
3519     LEAVE;
3520 }
3521
3522 #ifdef USE_ITHREADS
3523 /* Relocate sv to the pad for thread safety.
3524  * Despite being a "constant", the SV is written to,
3525  * for reference counts, sv_upgrade() etc. */
3526 PERL_STATIC_INLINE void
3527 S_op_relocate_sv(pTHX_ SV** svp, PADOFFSET* targp)
3528 {
3529     PADOFFSET ix;
3530     PERL_ARGS_ASSERT_OP_RELOCATE_SV;
3531     if (!*svp) return;
3532     ix = pad_alloc(OP_CONST, SVf_READONLY);
3533     SvREFCNT_dec(PAD_SVl(ix));
3534     PAD_SETSV(ix, *svp);
3535     /* XXX I don't know how this isn't readonly already. */
3536     if (!SvIsCOW(PAD_SVl(ix))) SvREADONLY_on(PAD_SVl(ix));
3537     *svp = NULL;
3538     *targp = ix;
3539 }
3540 #endif
3541
3542
3543 STATIC void
3544 S_finalize_op(pTHX_ OP* o)
3545 {
3546     PERL_ARGS_ASSERT_FINALIZE_OP;
3547
3548     assert(o->op_type != OP_FREED);
3549
3550     switch (o->op_type) {
3551     case OP_NEXTSTATE:
3552     case OP_DBSTATE:
3553         PL_curcop = ((COP*)o);          /* for warnings */
3554         break;
3555     case OP_EXEC:
3556         if (OpHAS_SIBLING(o)) {
3557             OP *sib = OpSIBLING(o);
3558             if ((  sib->op_type == OP_NEXTSTATE || sib->op_type == OP_DBSTATE)
3559                 && ckWARN(WARN_EXEC)
3560                 && OpHAS_SIBLING(sib))
3561             {
3562                     const OPCODE type = OpSIBLING(sib)->op_type;
3563                     if (type != OP_EXIT && type != OP_WARN && type != OP_DIE) {
3564                         const line_t oldline = CopLINE(PL_curcop);
3565                         CopLINE_set(PL_curcop, CopLINE((COP*)sib));
3566                         Perl_warner(aTHX_ packWARN(WARN_EXEC),
3567                             "Statement unlikely to be reached");
3568                         Perl_warner(aTHX_ packWARN(WARN_EXEC),
3569                             "\t(Maybe you meant system() when you said exec()?)\n");
3570                         CopLINE_set(PL_curcop, oldline);
3571                     }
3572             }
3573         }
3574         break;
3575
3576     case OP_GV:
3577         if ((o->op_private & OPpEARLY_CV) && ckWARN(WARN_PROTOTYPE)) {
3578             GV * const gv = cGVOPo_gv;
3579             if (SvTYPE(gv) == SVt_PVGV && GvCV(gv) && SvPVX_const(GvCV(gv))) {
3580                 /* XXX could check prototype here instead of just carping */
3581                 SV * const sv = sv_newmortal();
3582                 gv_efullname3(sv, gv, NULL);
3583                 Perl_warner(aTHX_ packWARN(WARN_PROTOTYPE),
3584                     "%" SVf "() called too early to check prototype",
3585                     SVfARG(sv));
3586             }
3587         }
3588         break;
3589
3590     case OP_CONST:
3591         if (cSVOPo->op_private & OPpCONST_STRICT)
3592             no_bareword_allowed(o);
3593 #ifdef USE_ITHREADS
3594         /* FALLTHROUGH */
3595     case OP_HINTSEVAL:
3596         op_relocate_sv(&cSVOPo->op_sv, &o->op_targ);
3597 #endif
3598         break;
3599
3600 #ifdef USE_ITHREADS
3601     /* Relocate all the METHOP's SVs to the pad for thread safety. */
3602     case OP_METHOD_NAMED:
3603     case OP_METHOD_SUPER:
3604     case OP_METHOD_REDIR:
3605     case OP_METHOD_REDIR_SUPER:
3606         op_relocate_sv(&cMETHOPx(o)->op_u.op_meth_sv, &o->op_targ);
3607         break;
3608 #endif
3609
3610     case OP_HELEM: {
3611         UNOP *rop;
3612         SVOP *key_op;
3613         OP *kid;
3614
3615         if ((key_op = cSVOPx(((BINOP*)o)->op_last))->op_type != OP_CONST)
3616             break;
3617
3618         rop = (UNOP*)((BINOP*)o)->op_first;
3619
3620         goto check_keys;
3621
3622     case OP_HSLICE:
3623         S_scalar_slice_warning(aTHX_ o);
3624         /* FALLTHROUGH */
3625
3626     case OP_KVHSLICE:
3627         kid = OpSIBLING(cLISTOPo->op_first);
3628         if (/* I bet there's always a pushmark... */
3629             OP_TYPE_ISNT_AND_WASNT_NN(kid, OP_LIST)
3630             && OP_TYPE_ISNT_NN(kid, OP_CONST))
3631         {
3632             break;
3633         }
3634
3635         key_op = (SVOP*)(kid->op_type == OP_CONST
3636                                 ? kid
3637                                 : OpSIBLING(kLISTOP->op_first));
3638
3639         rop = (UNOP*)((LISTOP*)o)->op_last;
3640
3641       check_keys:       
3642         if (o->op_private & OPpLVAL_INTRO || rop->op_type != OP_RV2HV)
3643             rop = NULL;
3644         S_check_hash_fields_and_hekify(aTHX_ rop, key_op);
3645         break;
3646     }
3647     case OP_NULL:
3648         if (o->op_targ != OP_HSLICE && o->op_targ != OP_ASLICE)
3649             break;
3650         /* FALLTHROUGH */
3651     case OP_ASLICE:
3652         S_scalar_slice_warning(aTHX_ o);
3653         break;
3654
3655     case OP_SUBST: {
3656         if (cPMOPo->op_pmreplrootu.op_pmreplroot)
3657             finalize_op(cPMOPo->op_pmreplrootu.op_pmreplroot);
3658         break;
3659     }
3660     default:
3661         break;
3662     }
3663
3664     if (o->op_flags & OPf_KIDS) {
3665         OP *kid;
3666
3667 #ifdef DEBUGGING
3668         /* check that op_last points to the last sibling, and that
3669          * the last op_sibling/op_sibparent field points back to the
3670          * parent, and that the only ops with KIDS are those which are
3671          * entitled to them */
3672         U32 type = o->op_type;
3673         U32 family;
3674         bool has_last;
3675
3676         if (type == OP_NULL) {
3677             type = o->op_targ;
3678             /* ck_glob creates a null UNOP with ex-type GLOB
3679              * (which is a list op. So pretend it wasn't a listop */
3680             if (type == OP_GLOB)
3681                 type = OP_NULL;
3682         }
3683         family = PL_opargs[type] & OA_CLASS_MASK;
3684
3685         has_last = (   family == OA_BINOP
3686                     || family == OA_LISTOP
3687                     || family == OA_PMOP
3688                     || family == OA_LOOP
3689                    );
3690         assert(  has_last /* has op_first and op_last, or ...
3691               ... has (or may have) op_first: */
3692               || family == OA_UNOP
3693               || family == OA_UNOP_AUX
3694               || family == OA_LOGOP
3695               || family == OA_BASEOP_OR_UNOP
3696               || family == OA_FILESTATOP
3697               || family == OA_LOOPEXOP
3698               || family == OA_METHOP
3699               || type == OP_CUSTOM
3700               || type == OP_NULL /* new_logop does this */
3701               );
3702
3703         for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid)) {
3704 #  ifdef PERL_OP_PARENT
3705             if (!OpHAS_SIBLING(kid)) {
3706                 if (has_last)
3707                     assert(kid == cLISTOPo->op_last);
3708                 assert(kid->op_sibparent == o);
3709             }
3710 #  else
3711             if (has_last && !OpHAS_SIBLING(kid))
3712                 assert(kid == cLISTOPo->op_last);
3713 #  endif
3714         }
3715 #endif
3716
3717         for (kid = cUNOPo->op_first; kid; kid = OpSIBLING(kid))
3718             finalize_op(kid);
3719     }
3720 }
3721
3722 /*
3723 =for apidoc Amx|OP *|op_lvalue|OP *o|I32 type
3724
3725 Propagate lvalue ("modifiable") context to an op and its children.
3726 C<type> represents the context type, roughly based on the type of op that
3727 would do the modifying, although C<local()> is represented by C<OP_NULL>,
3728 because it has no op type of its own (it is signalled by a flag on
3729 the lvalue op).
3730
3731 This function detects things that can't be modified, such as C<$x+1>, and
3732 generates errors for them.  For example, C<$x+1 = 2> would cause it to be
3733 called with an op of type C<OP_ADD> and a C<type> argument of C<OP_SASSIGN>.
3734
3735 It also flags things that need to behave specially in an lvalue context,
3736 such as C<$$x = 5> which might have to vivify a reference in C<$x>.
3737
3738 =cut
3739 */
3740
3741 static void
3742 S_mark_padname_lvalue(pTHX_ PADNAME *pn)
3743 {
3744     CV *cv = PL_compcv;
3745     PadnameLVALUE_on(pn);
3746     while (PadnameOUTER(pn) && PARENT_PAD_INDEX(pn)) {
3747         cv = CvOUTSIDE(cv);
3748         /* RT #127786: cv can be NULL due to an eval within the DB package
3749          * called from an anon sub - anon subs don't have CvOUTSIDE() set
3750          * unless they contain an eval, but calling eval within DB
3751          * pretends the eval was done in the caller's scope.
3752          */
3753         if (!cv)
3754             break;
3755         assert(CvPADLIST(cv));
3756         pn =
3757            PadlistNAMESARRAY(CvPADLIST(cv))[PARENT_PAD_INDEX(pn)];
3758         assert(PadnameLEN(pn));
3759         PadnameLVALUE_on(pn);
3760     }
3761 }
3762
3763 static bool
3764 S_vivifies(const OPCODE type)
3765 {
3766     switch(type) {
3767     case OP_RV2AV:     case   OP_ASLICE:
3768     case OP_RV2HV:     case OP_KVASLICE:
3769     case OP_RV2SV:     case   OP_HSLICE:
3770     case OP_AELEMFAST: case OP_KVHSLICE:
3771     case OP_HELEM:
3772     case OP_AELEM:
3773         return 1;
3774     }
3775     return 0;
3776 }
3777
3778 static void
3779 S_lvref(pTHX_ OP *o, I32 type)
3780 {
3781     dVAR;
3782     OP *kid;
3783     switch (o->op_type) {
3784     case OP_COND_EXPR:
3785         for (kid = OpSIBLING(cUNOPo->op_first); kid;
3786              kid = OpSIBLING(kid))
3787             S_lvref(aTHX_ kid, type);
3788         /* FALLTHROUGH */
3789     case OP_PUSHMARK:
3790         return;
3791     case OP_RV2AV:
3792         if (cUNOPo->op_first->op_type != OP_GV) goto badref;
3793         o->op_flags |= OPf_STACKED;
3794         if (o->op_flags & OPf_PARENS) {
3795             if (o->op_private & OPpLVAL_INTRO) {
3796                  yyerror(Perl_form(aTHX_ "Can't modify reference to "
3797                       "localized parenthesized array in list assignment"));
3798                 return;
3799             }
3800           slurpy:
3801             OpTYPE_set(o, OP_LVAVREF);
3802             o->op_private &= OPpLVAL_INTRO|OPpPAD_STATE;
3803             o->op_flags |= OPf_MOD|OPf_REF;
3804             return;
3805         }
3806         o->op_private |= OPpLVREF_AV;
3807         goto checkgv;
3808     case OP_RV2CV:
3809         kid = cUNOPo->op_first;
3810         if (kid->op_type == OP_NULL)
3811             kid = cUNOPx(OpSIBLING(kUNOP->op_first))
3812                 ->op_first;
3813         o->op_private = OPpLVREF_CV;
3814         if (kid->op_type == OP_GV)
3815             o->op_flags |= OPf_STACKED;
3816         else if (kid->op_type == OP_PADCV) {
3817             o->op_targ = kid->op_targ;
3818             kid->op_targ = 0;
3819             op_free(cUNOPo->op_first);
3820             cUNOPo->op_first = NULL;
3821             o->op_flags &=~ OPf_KIDS;
3822         }
3823         else goto badref;
3824         break;
3825     case OP_RV2HV:
3826         if (o->op_flags & OPf_PARENS) {
3827           parenhash:
3828             yyerror(Perl_form(aTHX_ "Can't modify reference to "
3829                                  "parenthesized hash in list assignment"));
3830                 return;
3831         }
3832         o->op_private |= OPpLVREF_HV;
3833         /* FALLTHROUGH */
3834     case OP_RV2SV:
3835       checkgv:
3836         if (cUNOPo->op_first->op_type != OP_GV) goto badref;
3837         o->op_flags |= OPf_STACKED;
3838         break;
3839     case OP_PADHV:
3840         if (o->op_flags & OPf_PARENS) goto parenhash;
3841         o->op_private |= OPpLVREF_HV;
3842         /* FALLTHROUGH */
3843     case OP_PADSV:
3844         PAD_COMPNAME_GEN_set(o->op_targ, PERL_INT_MAX);
3845         break;
3846     case OP_PADAV:
3847         PAD_COMPNAME_GEN_set(o->op_targ, PERL_INT_MAX);
3848         if (o->op_flags & OPf_PARENS) goto slurpy;
3849         o->op_private |= OPpLVREF_AV;
3850         break;
3851     case OP_AELEM:
3852     case OP_HELEM:
3853         o->op_private |= OPpLVREF_ELEM;
3854         o->op_flags   |= OPf_STACKED;
3855         break;
3856     case OP_ASLICE:
3857     case OP_HSLICE:
3858         OpTYPE_set(o, OP_LVREFSLICE);
3859         o->op_private &= OPpLVAL_INTRO;
3860         return;
3861     case OP_NULL:
3862         if (o->op_flags & OPf_SPECIAL)          /* do BLOCK */
3863             goto badref;
3864         else if (!(o->op_flags & OPf_KIDS))
3865             return;
3866         if (o->op_targ != OP_LIST) {
3867             S_lvref(aTHX_ cBINOPo->op_first, type);
3868             return;
3869         }
3870         /* FALLTHROUGH */
3871     case OP_LIST:
3872         for (kid = cLISTOPo->op_first; kid; kid = OpSIBLING(kid)) {
3873             assert((kid->op_flags & OPf_WANT) != OPf_WANT_VOID);
3874             S_lvref(aTHX_ kid, type);
3875         }
3876         return;
3877     case OP_STUB:
3878         if (o->op_flags & OPf_PARENS)
3879             return;
3880         /* FALLTHROUGH */
3881     default:
3882       badref:
3883         /* diag_listed_as: Can't modify reference to %s in %s assignment */
3884         yyerror(Perl_form(aTHX_ "Can't modify reference to %s in %s",
3885                      o->op_type == OP_NULL && o->op_flags & OPf_SPECIAL
3886                       ? "do block"
3887                       : OP_DESC(o),
3888                      PL_op_desc[type]));
3889         return;
3890     }
3891     OpTYPE_set(o, OP_LVREF);
3892     o->op_private &=
3893         OPpLVAL_INTRO|OPpLVREF_ELEM|OPpLVREF_TYPE|OPpPAD_STATE;
3894     if (type == OP_ENTERLOOP)
3895         o->op_private |= OPpLVREF_ITER;
3896 }
3897
3898 PERL_STATIC_INLINE bool
3899 S_potential_mod_type(I32 type)
3900 {
3901     /* Types that only potentially result in modification.  */
3902     return type == OP_GREPSTART || type == OP_ENTERSUB
3903         || type == OP_REFGEN    || type == OP_LEAVESUBLV;
3904 }
3905
3906 OP *
3907 Perl_op_lvalue_flags(pTHX_ OP *o, I32 type, U32 flags)
3908 {
3909     dVAR;
3910     OP *kid;
3911     /* -1 = error on localize, 0 = ignore localize, 1 = ok to localize */
3912     int localize = -1;
3913
3914     if (!o || (PL_parser && PL_parser->error_count))
3915         return o;
3916
3917     if ((o->op_private & OPpTARGET_MY)
3918         && (PL_opargs[o->op_type] & OA_TARGLEX))/* OPp share the meaning */
3919     {
3920         return o;
3921     }
3922
3923     assert( (o->op_flags & OPf_WANT) != OPf_WANT_VOID );
3924
3925     if (type == OP_PRTF || type == OP_SPRINTF) type = OP_ENTERSUB;
3926
3927     switch (o->op_type) {
3928     case OP_UNDEF:
3929         PL_modcount++;
3930         return o;
3931     case OP_STUB:
3932         if ((o->op_flags & OPf_PARENS))
3933             break;
3934         goto nomod;
3935     case OP_ENTERSUB:
3936         if ((type == OP_UNDEF || type == OP_REFGEN || type == OP_LOCK) &&
3937             !(o->op_flags & OPf_STACKED)) {
3938             OpTYPE_set(o, OP_RV2CV);            /* entersub => rv2cv */
3939             assert(cUNOPo->op_first->op_type == OP_NULL);
3940             op_null(((LISTOP*)cUNOPo->op_first)->op_first);/* disable pushmark */
3941             break;
3942         }
3943         else {                          /* lvalue subroutine call */
3944             o->op_private |= OPpLVAL_INTRO;
3945             PL_modcount = RETURN_UNLIMITED_NUMBER;
3946             if (S_potential_mod_type(type)) {
3947                 o->op_private |= OPpENTERSUB_INARGS;
3948                 break;
3949             }
3950             else {                      /* Compile-time error message: */
3951                 OP *kid = cUNOPo->op_first;
3952                 CV *cv;
3953                 GV *gv;
3954                 SV *namesv;
3955
3956                 if (kid->op_type != OP_PUSHMARK) {
3957                     if (kid->op_type != OP_NULL || kid->op_targ != OP_LIST)
3958                         Perl_croak(aTHX_
3959                                 "panic: unexpected lvalue entersub "
3960                                 "args: type/targ %ld:%" UVuf,
3961                                 (long)kid->op_type, (UV)kid->op_targ);
3962                     kid = kLISTOP->op_first;
3963                 }
3964                 while (OpHAS_SIBLING(kid))
3965                     kid = OpSIBLING(kid);
3966                 if (!(kid->op_type == OP_NULL && kid->op_targ == OP_RV2CV)) {
3967                     break;      /* Postpone until runtime */
3968                 }
3969
3970                 kid = kUNOP->op_first;
3971                 if (kid->op_type == OP_NULL && kid->op_targ == OP_RV2SV)
3972                     kid = kUNOP->op_first;
3973                 if (kid->op_type == OP_NULL)
3974                     Perl_croak(aTHX_
3975                                "Unexpected constant lvalue entersub "
3976                                "entry via type/targ %ld:%" UVuf,
3977                                (long)kid->op_type, (UV)kid->op_targ);
3978                 if (kid->op_type != OP_GV) {
3979                     break;
3980                 }
3981
3982                 gv = kGVOP_gv;
3983                 cv = isGV(gv)
3984                     ? GvCV(gv)
3985                     : SvROK(gv) && SvTYPE(SvRV(gv)) == SVt_PVCV
3986                         ? MUTABLE_CV(SvRV(gv))
3987                         : NULL;
3988                 if (!cv)
3989                     break;
3990                 if (CvLVALUE(cv))
3991                     break;
3992                 if (flags & OP_LVALUE_NO_CROAK)
3993                     return NULL;
3994
3995                 namesv = cv_name(cv, NULL, 0);
3996                 yyerror_pv(Perl_form(aTHX_ "Can't modify non-lvalue "
3997                                      "subroutine call of &%" SVf " in %s",
3998                                      SVfARG(namesv), PL_op_desc[type]),
3999                            SvUTF8(namesv));
4000                 return o;
4001             }
4002         }
4003         /* FALLTHROUGH */
4004     default:
4005       nomod:
4006         if (flags & OP_LVALUE_NO_CROAK) return NULL;
4007         /* grep, foreach, subcalls, refgen */
4008         if (S_potential_mod_type(type))
4009             break;
4010         yyerror(Perl_form(aTHX_ "Can't modify %s in %s",
4011                      (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL)
4012                       ? "do block"
4013                       : OP_DESC(o)),
4014                      type ? PL_op_desc[type] : "local"));
4015         return o;
4016
4017     case OP_PREINC:
4018     case OP_PREDEC:
4019     case OP_POW:
4020     case OP_MULTIPLY:
4021     case OP_DIVIDE:
4022     case OP_MODULO:
4023     case OP_ADD:
4024     case OP_SUBTRACT:
4025     case OP_CONCAT:
4026     case OP_LEFT_SHIFT:
4027     case OP_RIGHT_SHIFT:
4028     case OP_BIT_AND:
4029     case OP_BIT_XOR:
4030     case OP_BIT_OR:
4031     case OP_I_MULTIPLY:
4032     case OP_I_DIVIDE:
4033     case OP_I_MODULO:
4034     case OP_I_ADD:
4035     case OP_I_SUBTRACT:
4036         if (!(o->op_flags & OPf_STACKED))
4037             goto nomod;
4038         PL_modcount++;
4039         break;
4040
4041     case OP_REPEAT:
4042         if (o->op_flags & OPf_STACKED) {
4043             PL_modcount++;
4044             break;
4045         }
4046         if (!(o->op_private & OPpREPEAT_DOLIST))
4047             goto nomod;
4048         else {
4049             const I32 mods = PL_modcount;
4050             modkids(cBINOPo->op_first, type);
4051             if (type != OP_AASSIGN)
4052                 goto nomod;
4053             kid = cBINOPo->op_last;
4054             if (kid->op_type == OP_CONST && SvIOK(kSVOP_sv)) {
4055                 const IV iv = SvIV(kSVOP_sv);
4056                 if (PL_modcount != RETURN_UNLIMITED_NUMBER)
4057                     PL_modcount =
4058                         mods + (PL_modcount - mods) * (iv < 0 ? 0 : iv);
4059             }
4060             else
4061                 PL_modcount = RETURN_UNLIMITED_NUMBER;
4062         }
4063         break;
4064
4065     case OP_COND_EXPR:
4066         localize = 1;
4067         for (kid = OpSIBLING(cUNOPo->op_first); kid; kid = OpSIBLING(kid))
4068             op_lvalue(kid, type);
4069         break;
4070
4071     case OP_RV2AV:
4072     case OP_RV2HV:
4073         if (type == OP_REFGEN && o->op_flags & OPf_PARENS) {
4074            PL_modcount = RETURN_UNLIMITED_NUMBER;
4075             return o;           /* Treat \(@foo) like ordinary list. */
4076         }
4077         /* FALLTHROUGH */
4078     case OP_RV2GV:
4079         if (scalar_mod_type(o, type))
4080             goto nomod;
4081         ref(cUNOPo->op_first, o->op_type);
4082         /* FALLTHROUGH */
4083     case OP_ASLICE:
4084     case OP_HSLICE:
4085         localize = 1;
4086         /* FALLTHROUGH */
4087     case OP_AASSIGN:
4088         /* Do not apply the lvsub flag for rv2[ah]v in scalar context.  */
4089         if (type == OP_LEAVESUBLV && (
4090                 (o->op_type != OP_RV2AV && o->op_type != OP_RV2HV)
4091              || (o->op_flags & OPf_WANT) != OPf_WANT_SCALAR
4092            ))
4093             o->op_private |= OPpMAYBE_LVSUB;
4094         /* FALLTHROUGH */
4095     case OP_NEXTSTATE:
4096     case OP_DBSTATE:
4097        PL_modcount = RETURN_UNLIMITED_NUMBER;
4098         break;
4099     case OP_KVHSLICE:
4100     case OP_KVASLICE:
4101     case OP_AKEYS:
4102         if (type == OP_LEAVESUBLV)
4103             o->op_private |= OPpMAYBE_LVSUB;
4104         goto nomod;
4105     case OP_AVHVSWITCH:
4106         if (type == OP_LEAVESUBLV
4107          && (o->op_private & OPpAVHVSWITCH_MASK) + OP_EACH == OP_KEYS)
4108             o->op_private |= OPpMAYBE_LVSUB;
4109         goto nomod;
4110     case OP_AV2ARYLEN:
4111         PL_hints |= HINT_BLOCK_SCOPE;
4112         if (type == OP_LEAVESUBLV)
4113             o->op_private |= OPpMAYBE_LVSUB;
4114         PL_modcount++;
4115         break;
4116     case OP_RV2SV:
4117         ref(cUNOPo->op_first, o->op_type);
4118         localize = 1;
4119         /* FALLTHROUGH */
4120     case OP_GV:
4121         PL_hints |= HINT_BLOCK_SCOPE;
4122         /* FALLTHROUGH */
4123     case OP_SASSIGN:
4124     case OP_ANDASSIGN:
4125     case OP_ORASSIGN:
4126     case OP_DORASSIGN:
4127         PL_modcount++;
4128         break;
4129
4130     case OP_AELEMFAST:
4131     case OP_AELEMFAST_LEX:
4132         localize = -1;
4133         PL_modcount++;
4134         break;
4135
4136     case OP_PADAV:
4137     case OP_PADHV:
4138        PL_modcount = RETURN_UNLIMITED_NUMBER;
4139         if (type == OP_REFGEN && o->op_flags & OPf_PARENS)
4140             return o;           /* Treat \(@foo) like ordinary list. */
4141         if (scalar_mod_type(o, type))
4142             goto nomod;
4143         if ((o->op_flags & OPf_WANT) != OPf_WANT_SCALAR
4144           && type == OP_LEAVESUBLV)
4145             o->op_private |= OPpMAYBE_LVSUB;
4146         /* FALLTHROUGH */
4147     case OP_PADSV:
4148         PL_modcount++;
4149         if (!type) /* local() */
4150             Perl_croak(aTHX_ "Can't localize lexical variable %" PNf,
4151                               PNfARG(PAD_COMPNAME(o->op_targ)));
4152         if (!(o->op_private & OPpLVAL_INTRO)
4153          || (  type != OP_SASSIGN && type != OP_AASSIGN
4154             && PadnameIsSTATE(PAD_COMPNAME_SV(o->op_targ))  ))
4155             S_mark_padname_lvalue(aTHX_ PAD_COMPNAME_SV(o->op_targ));
4156         break;
4157
4158     case OP_PUSHMARK:
4159         localize = 0;
4160         break;
4161
4162     case OP_KEYS:
4163         if (type != OP_LEAVESUBLV && !scalar_mod_type(NULL, type))
4164             goto nomod;
4165         goto lvalue_func;
4166     case OP_SUBSTR:
4167         if (o->op_private == 4) /* don't allow 4 arg substr as lvalue */
4168             goto nomod;
4169         /* FALLTHROUGH */
4170     case OP_POS:
4171     case OP_VEC:
4172       lvalue_func:
4173         if (type == OP_LEAVESUBLV)
4174             o->op_private |= OPpMAYBE_LVSUB;
4175         if (o->op_flags & OPf_KIDS && OpHAS_SIBLING(cBINOPo->op_first)) {
4176             /* substr and vec */
4177             /* If this op is in merely potential (non-fatal) modifiable
4178                context, then apply OP_ENTERSUB context to
4179                the kid op (to avoid croaking).  Other-
4180                wise pass this op’s own type so the correct op is mentioned
4181                in error messages.  */
4182             op_lvalue(OpSIBLING(cBINOPo->op_first),
4183                       S_potential_mod_type(type)
4184                         ? (I32)OP_ENTERSUB
4185                         : o->op_type);
4186         }
4187         break;
4188
4189     case OP_AELEM:
4190     case OP_HELEM:
4191         ref(cBINOPo->op_first, o->op_type);
4192         if (type == OP_ENTERSUB &&
4193              !(o->op_private & (OPpLVAL_INTRO | OPpDEREF)))
4194             o->op_private |= OPpLVAL_DEFER;
4195         if (type == OP_LEAVESUBLV)
4196             o->op_private |= OPpMAYBE_LVSUB;
4197         localize = 1;
4198         PL_modcount++;
4199         break;
4200
4201     case OP_LEAVE:
4202     case OP_LEAVELOOP:
4203         o->op_private |= OPpLVALUE;
4204         /* FALLTHROUGH */
4205     case OP_SCOPE:
4206     case OP_ENTER:
4207     case OP_LINESEQ:
4208         localize = 0;
4209         if (o->op_flags & OPf_KIDS)
4210             op_lvalue(cLISTOPo->op_last, type);
4211         break;
4212
4213     case OP_NULL:
4214         localize = 0;
4215         if (o->op_flags & OPf_SPECIAL)          /* do BLOCK */
4216             goto nomod;
4217         else if (!(o->op_flags & OPf_KIDS))
4218             break;
4219
4220         if (o->op_targ != OP_LIST) {
4221             OP *sib = OpSIBLING(cLISTOPo->op_first);
4222             /* OP_TRANS and OP_TRANSR with argument have a weird optree
4223              * that looks like
4224              *
4225              *   null
4226              *      arg
4227              *      trans
4228              *
4229              * compared with things like OP_MATCH which have the argument
4230              * as a child:
4231              *
4232              *   match
4233              *      arg
4234              *
4235              * so handle specially to correctly get "Can't modify" croaks etc
4236              */
4237
4238             if (sib && (sib->op_type == OP_TRANS || sib->op_type == OP_TRANSR))
4239             {
4240                 /* this should trigger a "Can't modify transliteration" err */
4241                 op_lvalue(sib, type);
4242             }
4243             op_lvalue(cBINOPo->op_first, type);
4244             break;
4245         }
4246         /* FALLTHROUGH */
4247     case OP_LIST:
4248         localize = 0;
4249         for (kid = cLISTOPo->op_first; kid; kid = OpSIBLING(kid))
4250             /* elements might be in void context because the list is
4251                in scalar context or because they are attribute sub calls */
4252             if ( (kid->op_flags & OPf_WANT) != OPf_WANT_VOID )
4253                 op_lvalue(kid, type);
4254         break;
4255
4256     case OP_COREARGS:
4257         return o;
4258
4259     case OP_AND:
4260     case OP_OR:
4261         if (type == OP_LEAVESUBLV
4262          || !S_vivifies(cLOGOPo->op_first->op_type))
4263             op_lvalue(cLOGOPo->op_first, type);
4264         if (type == OP_LEAVESUBLV
4265          || !S_vivifies(OpSIBLING(cLOGOPo->op_first)->op_type))
4266             op_lvalue(OpSIBLING(cLOGOPo->op_first), type);
4267         goto nomod;
4268
4269     case OP_SREFGEN:
4270         if (type == OP_NULL) { /* local */
4271           local_refgen:
4272             if (!FEATURE_MYREF_IS_ENABLED)
4273                 Perl_croak(aTHX_ "The experimental declared_refs "
4274                                  "feature is not enabled");
4275             Perl_ck_warner_d(aTHX_
4276                      packWARN(WARN_EXPERIMENTAL__DECLARED_REFS),
4277                     "Declaring references is experimental");
4278             op_lvalue(cUNOPo->op_first, OP_NULL);
4279             return o;
4280         }
4281         if (type != OP_AASSIGN && type != OP_SASSIGN
4282          && type != OP_ENTERLOOP)
4283             goto nomod;
4284         /* Don’t bother applying lvalue context to the ex-list.  */
4285         kid = cUNOPx(cUNOPo->op_first)->op_first;
4286         assert (!OpHAS_SIBLING(kid));
4287         goto kid_2lvref;
4288     case OP_REFGEN:
4289         if (type == OP_NULL) /* local */
4290             goto local_refgen;
4291         if (type != OP_AASSIGN) goto nomod;
4292         kid = cUNOPo->op_first;
4293       kid_2lvref:
4294         {
4295             const U8 ec = PL_parser ? PL_parser->error_count : 0;
4296             S_lvref(aTHX_ kid, type);
4297             if (!PL_parser || PL_parser->error_count == ec) {
4298                 if (!FEATURE_REFALIASING_IS_ENABLED)
4299                     Perl_croak(aTHX_
4300                        "Experimental aliasing via reference not enabled");
4301                 Perl_ck_warner_d(aTHX_
4302                                  packWARN(WARN_EXPERIMENTAL__REFALIASING),
4303                                 "Aliasing via reference is experimental");
4304             }
4305         }
4306         if (o->op_type == OP_REFGEN)
4307             op_null(cUNOPx(cUNOPo->op_first)->op_first); /* pushmark */
4308         op_null(o);
4309         return o;
4310
4311     case OP_SPLIT:
4312         if ((o->op_private & OPpSPLIT_ASSIGN)) {
4313             /* This is actually @array = split.  */
4314             PL_modcount = RETURN_UNLIMITED_NUMBER;
4315             break;
4316         }
4317         goto nomod;
4318
4319     case OP_SCALAR:
4320         op_lvalue(cUNOPo->op_first, OP_ENTERSUB);
4321         goto nomod;
4322     }
4323
4324     /* [20011101.069 (#7861)] File test operators interpret OPf_REF to mean that
4325        their argument is a filehandle; thus \stat(".") should not set
4326        it. AMS 20011102 */
4327     if (type == OP_REFGEN &&
4328         PL_check[o->op_type] == Perl_ck_ftst)
4329         return o;
4330
4331     if (type != OP_LEAVESUBLV)
4332         o->op_flags |= OPf_MOD;
4333
4334     if (type == OP_AASSIGN || type == OP_SASSIGN)
4335         o->op_flags |= OPf_SPECIAL
4336                       |(o->op_type == OP_ENTERSUB ? 0 : OPf_REF);
4337     else if (!type) { /* local() */
4338         switch (localize) {
4339         case 1:
4340             o->op_private |= OPpLVAL_INTRO;
4341             o->op_flags &= ~OPf_SPECIAL;
4342             PL_hints |= HINT_BLOCK_SCOPE;
4343             break;
4344         case 0:
4345             break;
4346         case -1:
4347             Perl_ck_warner(aTHX_ packWARN(WARN_SYNTAX),
4348                            "Useless localization of %s", OP_DESC(o));
4349         }
4350     }
4351     else if (type != OP_GREPSTART && type != OP_ENTERSUB
4352              && type != OP_LEAVESUBLV && o->op_type != OP_ENTERSUB)
4353         o->op_flags |= OPf_REF;
4354     return o;
4355 }
4356
4357 STATIC bool
4358 S_scalar_mod_type(const OP *o, I32 type)
4359 {
4360     switch (type) {
4361     case OP_POS:
4362     case OP_SASSIGN:
4363         if (o && o->op_type == OP_RV2GV)
4364             return FALSE;
4365         /* FALLTHROUGH */
4366     case OP_PREINC:
4367     case OP_PREDEC:
4368     case OP_POSTINC:
4369     case OP_POSTDEC:
4370     case OP_I_PREINC:
4371     case OP_I_PREDEC:
4372     case OP_I_POSTINC:
4373     case OP_I_POSTDEC:
4374     case OP_POW:
4375     case OP_MULTIPLY:
4376     case OP_DIVIDE:
4377     case OP_MODULO:
4378     case OP_REPEAT:
4379     case OP_ADD:
4380     case OP_SUBTRACT:
4381     case OP_I_MULTIPLY:
4382     case OP_I_DIVIDE:
4383     case OP_I_MODULO:
4384     case OP_I_ADD:
4385     case OP_I_SUBTRACT:
4386     case OP_LEFT_SHIFT:
4387     case OP_RIGHT_SHIFT:
4388     case OP_BIT_AND:
4389     case OP_BIT_XOR:
4390     case OP_BIT_OR:
4391     case OP_NBIT_AND:
4392     case OP_NBIT_XOR:
4393     case OP_NBIT_OR:
4394     case OP_SBIT_AND:
4395     case OP_SBIT_XOR:
4396     case OP_SBIT_OR:
4397     case OP_CONCAT:
4398     case OP_SUBST:
4399     case OP_TRANS:
4400     case OP_TRANSR:
4401     case OP_READ:
4402     case OP_SYSREAD:
4403     case OP_RECV:
4404     case OP_ANDASSIGN:
4405     case OP_ORASSIGN:
4406     case OP_DORASSIGN:
4407     case OP_VEC:
4408     case OP_SUBSTR:
4409         return TRUE;
4410     default:
4411         return FALSE;
4412     }
4413 }
4414
4415 STATIC bool
4416 S_is_handle_constructor(const OP *o, I32 numargs)
4417 {
4418     PERL_ARGS_ASSERT_IS_HANDLE_CONSTRUCTOR;
4419
4420     switch (o->op_type) {
4421     case OP_PIPE_OP:
4422     case OP_SOCKPAIR:
4423         if (numargs == 2)
4424             return TRUE;
4425         /* FALLTHROUGH */
4426     case OP_SYSOPEN:
4427     case OP_OPEN:
4428     case OP_SELECT:             /* XXX c.f. SelectSaver.pm */
4429     case OP_SOCKET:
4430     case OP_OPEN_DIR:
4431     case OP_ACCEPT:
4432         if (numargs == 1)
4433             return TRUE;
4434         /* FALLTHROUGH */
4435     default:
4436         return FALSE;
4437     }
4438 }
4439
4440 static OP *
4441 S_refkids(pTHX_ OP *o, I32 type)
4442 {
4443     if (o && o->op_flags & OPf_KIDS) {
4444         OP *kid;
4445         for (kid = cLISTOPo->op_first; kid; kid = OpSIBLING(kid))
4446             ref(kid, type);
4447     }
4448     return o;
4449 }
4450
4451 OP *
4452 Perl_doref(pTHX_ OP *o, I32 type, bool set_op_ref)
4453 {
4454     dVAR;
4455     OP *kid;
4456
4457     PERL_ARGS_ASSERT_DOREF;
4458
4459     if (PL_parser && PL_parser->error_count)
4460         return o;
4461
4462     switch (o->op_type) {
4463     case OP_ENTERSUB:
4464         if ((type == OP_EXISTS || type == OP_DEFINED) &&
4465             !(o->op_flags & OPf_STACKED)) {
4466             OpTYPE_set(o, OP_RV2CV);             /* entersub => rv2cv */
4467             assert(cUNOPo->op_first->op_type == OP_NULL);
4468             op_null(((LISTOP*)cUNOPo->op_first)->op_first);     /* disable pushmark */
4469             o->op_flags |= OPf_SPECIAL;
4470         }
4471         else if (type == OP_RV2SV || type == OP_RV2AV || type == OP_RV2HV){
4472             o->op_private |= (type == OP_RV2AV ? OPpDEREF_AV
4473                               : type == OP_RV2HV ? OPpDEREF_HV
4474                               : OPpDEREF_SV);
4475             o->op_flags |= OPf_MOD;
4476         }
4477
4478         break;
4479
4480     case OP_COND_EXPR:
4481         for (kid = OpSIBLING(cUNOPo->op_first); kid; kid = OpSIBLING(kid))
4482             doref(kid, type, set_op_ref);
4483         break;
4484     case OP_RV2SV:
4485         if (type == OP_DEFINED)
4486             o->op_flags |= OPf_SPECIAL;         /* don't create GV */
4487         doref(cUNOPo->op_first, o->op_type, set_op_ref);
4488         /* FALLTHROUGH */
4489     case OP_PADSV:
4490         if (type == OP_RV2SV || type == OP_RV2AV || type == OP_RV2HV) {
4491             o->op_private |= (type == OP_RV2AV ? OPpDEREF_AV
4492                               : type == OP_RV2HV ? OPpDEREF_HV
4493                               : OPpDEREF_SV);
4494             o->op_flags |= OPf_MOD;
4495         }
4496         break;
4497
4498     case OP_RV2AV:
4499     case OP_RV2HV:
4500         if (set_op_ref)
4501             o->op_flags |= OPf_REF;
4502         /* FALLTHROUGH */
4503     case OP_RV2GV:
4504         if (type == OP_DEFINED)
4505             o->op_flags |= OPf_SPECIAL;         /* don't create GV */
4506         doref(cUNOPo->op_first, o->op_type, set_op_ref);
4507         break;
4508
4509     case OP_PADAV:
4510     case OP_PADHV:
4511         if (set_op_ref)
4512             o->op_flags |= OPf_REF;
4513         break;
4514
4515     case OP_SCALAR:
4516     case OP_NULL:
4517         if (!(o->op_flags & OPf_KIDS) || type == OP_DEFINED)
4518             break;
4519         doref(cBINOPo->op_first, type, set_op_ref);
4520         break;
4521     case OP_AELEM:
4522     case OP_HELEM:
4523         doref(cBINOPo->op_first, o->op_type, set_op_ref);
4524         if (type == OP_RV2SV || type == OP_RV2AV || type == OP_RV2HV) {
4525             o->op_private |= (type == OP_RV2AV ? OPpDEREF_AV
4526                               : type == OP_RV2HV ? OPpDEREF_HV
4527                               : OPpDEREF_SV);
4528             o->op_flags |= OPf_MOD;
4529         }
4530         break;
4531
4532     case OP_SCOPE:
4533     case OP_LEAVE:
4534         set_op_ref = FALSE;
4535         /* FALLTHROUGH */
4536     case OP_ENTER:
4537     case OP_LIST:
4538         if (!(o->op_flags & OPf_KIDS))
4539             break;
4540         doref(cLISTOPo->op_last, type, set_op_ref);
4541         break;
4542     default:
4543         break;
4544     }
4545     return scalar(o);
4546
4547 }
4548
4549 STATIC OP *
4550 S_dup_attrlist(pTHX_ OP *o)
4551 {
4552     OP *rop;
4553
4554     PERL_ARGS_ASSERT_DUP_ATTRLIST;
4555
4556     /* An attrlist is either a simple OP_CONST or an OP_LIST with kids,
4557      * where the first kid is OP_PUSHMARK and the remaining ones
4558      * are OP_CONST.  We need to push the OP_CONST values.
4559      */
4560     if (o->op_type == OP_CONST)
4561         rop = newSVOP(OP_CONST, o->op_flags, SvREFCNT_inc_NN(cSVOPo->op_sv));
4562     else {
4563         assert((o->op_type == OP_LIST) && (o->op_flags & OPf_KIDS));
4564         rop = NULL;
4565         for (o = cLISTOPo->op_first; o; o = OpSIBLING(o)) {
4566             if (o->op_type == OP_CONST)
4567                 rop = op_append_elem(OP_LIST, rop,
4568                                   newSVOP(OP_CONST, o->op_flags,
4569                                           SvREFCNT_inc_NN(cSVOPo->op_sv)));
4570         }
4571     }
4572     return rop;
4573 }
4574
4575 STATIC void
4576 S_apply_attrs(pTHX_ HV *stash, SV *target, OP *attrs)
4577 {
4578     PERL_ARGS_ASSERT_APPLY_ATTRS;
4579     {
4580         SV * const stashsv = newSVhek(HvNAME_HEK(stash));
4581
4582         /* fake up C<use attributes $pkg,$rv,@attrs> */
4583
4584 #define ATTRSMODULE "attributes"
4585 #define ATTRSMODULE_PM "attributes.pm"
4586
4587         Perl_load_module(
4588           aTHX_ PERL_LOADMOD_IMPORT_OPS,
4589           newSVpvs(ATTRSMODULE),
4590           NULL,
4591           op_prepend_elem(OP_LIST,
4592                           newSVOP(OP_CONST, 0, stashsv),
4593                           op_prepend_elem(OP_LIST,
4594                                           newSVOP(OP_CONST, 0,
4595                                                   newRV(target)),
4596                                           dup_attrlist(attrs))));
4597     }
4598 }
4599
4600 STATIC void
4601 S_apply_attrs_my(pTHX_ HV *stash, OP *target, OP *attrs, OP **imopsp)
4602 {
4603     OP *pack, *imop, *arg;
4604     SV *meth, *stashsv, **svp;
4605
4606     PERL_ARGS_ASSERT_APPLY_ATTRS_MY;
4607
4608     if (!attrs)
4609         return;
4610
4611     assert(target->op_type == OP_PADSV ||
4612            target->op_type == OP_PADHV ||
4613            target->op_type == OP_PADAV);
4614
4615     /* Ensure that attributes.pm is loaded. */
4616     /* Don't force the C<use> if we don't need it. */
4617     svp = hv_fetchs(GvHVn(PL_incgv), ATTRSMODULE_PM, FALSE);
4618     if (svp && *svp != &PL_sv_undef)
4619         NOOP;   /* already in %INC */
4620     else
4621         Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT,
4622                                newSVpvs(ATTRSMODULE), NULL);
4623
4624     /* Need package name for method call. */
4625     pack = newSVOP(OP_CONST, 0, newSVpvs(ATTRSMODULE));
4626
4627     /* Build up the real arg-list. */
4628     stashsv = newSVhek(HvNAME_HEK(stash));
4629
4630     arg = newOP(OP_PADSV, 0);
4631     arg->op_targ = target->op_targ;
4632     arg = op_prepend_elem(OP_LIST,
4633                        newSVOP(OP_CONST, 0, stashsv),
4634                        op_prepend_elem(OP_LIST,
4635                                     newUNOP(OP_REFGEN, 0,
4636                                             arg),
4637                                     dup_attrlist(attrs)));
4638
4639     /* Fake up a method call to import */
4640     meth = newSVpvs_share("import");
4641     imop = op_convert_list(OP_ENTERSUB, OPf_STACKED|OPf_SPECIAL|OPf_WANT_VOID,
4642                    op_append_elem(OP_LIST,
4643                                op_prepend_elem(OP_LIST, pack, arg),
4644                                newMETHOP_named(OP_METHOD_NAMED, 0, meth)));
4645
4646     /* Combine the ops. */
4647     *imopsp = op_append_elem(OP_LIST, *imopsp, imop);
4648 }
4649
4650 /*
4651 =notfor apidoc apply_attrs_string
4652
4653 Attempts to apply a list of attributes specified by the C<attrstr> and
4654 C<len> arguments to the subroutine identified by the C<cv> argument which
4655 is expected to be associated with the package identified by the C<stashpv>
4656 argument (see L<attributes>).  It gets this wrong, though, in that it
4657 does not correctly identify the boundaries of the individual attribute
4658 specifications within C<attrstr>.  This is not really intended for the
4659 public API, but has to be listed here for systems such as AIX which
4660 need an explicit export list for symbols.  (It's called from XS code
4661 in support of the C<ATTRS:> keyword from F<xsubpp>.)  Patches to fix it
4662 to respect attribute syntax properly would be welcome.
4663
4664 =cut
4665 */
4666
4667 void
4668 Perl_apply_attrs_string(pTHX_ const char *stashpv, CV *cv,
4669                         const char *attrstr, STRLEN len)
4670 {
4671     OP *attrs = NULL;
4672
4673     PERL_ARGS_ASSERT_APPLY_ATTRS_STRING;
4674
4675     if (!len) {
4676         len = strlen(attrstr);
4677     }
4678
4679     while (len) {
4680         for (; isSPACE(*attrstr) && len; --len, ++attrstr) ;
4681         if (len) {
4682             const char * const sstr = attrstr;
4683             for (; !isSPACE(*attrstr) && len; --len, ++attrstr) ;
4684             attrs = op_append_elem(OP_LIST, attrs,
4685                                 newSVOP(OP_CONST, 0,
4686                                         newSVpvn(sstr, attrstr-sstr)));
4687         }
4688     }
4689
4690     Perl_load_module(aTHX_ PERL_LOADMOD_IMPORT_OPS,
4691                      newSVpvs(ATTRSMODULE),
4692                      NULL, op_prepend_elem(OP_LIST,
4693                                   newSVOP(OP_CONST, 0, newSVpv(stashpv,0)),
4694                                   op_prepend_elem(OP_LIST,
4695                                                newSVOP(OP_CONST, 0,
4696                                                        newRV(MUTABLE_SV(cv))),
4697                                                attrs)));
4698 }
4699
4700 STATIC void
4701 S_move_proto_attr(pTHX_ OP **proto, OP **attrs, const GV * name,
4702                         bool curstash)
4703 {
4704     OP *new_proto = NULL;
4705     STRLEN pvlen;
4706     char *pv;
4707     OP *o;
4708
4709     PERL_ARGS_ASSERT_MOVE_PROTO_ATTR;
4710
4711     if (!*attrs)
4712         return;
4713
4714     o = *attrs;
4715     if (o->op_type == OP_CONST) {
4716         pv = SvPV(cSVOPo_sv, pvlen);
4717         if (memBEGINs(pv, pvlen, "prototype(")) {
4718             SV * const tmpsv = newSVpvn_flags(pv + 10, pvlen - 11, SvUTF8(cSVOPo_sv));
4719             SV ** const tmpo = cSVOPx_svp(o);
4720             SvREFCNT_dec(cSVOPo_sv);
4721             *tmpo = tmpsv;
4722             new_proto = o;
4723             *attrs = NULL;
4724         }
4725     } else if (o->op_type == OP_LIST) {
4726         OP * lasto;
4727         assert(o->op_flags & OPf_KIDS);
4728         lasto = cLISTOPo->op_first;
4729         assert(lasto->op_type == OP_PUSHMARK);
4730         for (o = OpSIBLING(lasto); o; o = OpSIBLING(o)) {
4731             if (o->op_type == OP_CONST) {
4732                 pv = SvPV(cSVOPo_sv, pvlen);
4733                 if (memBEGINs(pv, pvlen, "prototype(")) {
4734                     SV * const tmpsv = newSVpvn_flags(pv + 10, pvlen - 11, SvUTF8(cSVOPo_sv));
4735                     SV ** const tmpo = cSVOPx_svp(o);
4736                     SvREFCNT_dec(cSVOPo_sv);
4737                     *tmpo = tmpsv;
4738                     if (new_proto && ckWARN(WARN_MISC)) {
4739                         STRLEN new_len;
4740                         const char * newp = SvPV(cSVOPo_sv, new_len);
4741                         Perl_warner(aTHX_ packWARN(WARN_MISC),
4742                             "Attribute prototype(%" UTF8f ") discards earlier prototype attribute in same sub",
4743                             UTF8fARG(SvUTF8(cSVOPo_sv), new_len, newp));
4744                         op_free(new_proto);
4745                     }
4746                     else if (new_proto)
4747                         op_free(new_proto);
4748                     new_proto = o;
4749                     /* excise new_proto from the list */
4750                     op_sibling_splice(*attrs, lasto, 1, NULL);
4751                     o = lasto;
4752                     continue;
4753                 }
4754             }
4755             lasto = o;
4756         }
4757         /* If the list is now just the PUSHMARK, scrap the whole thing; otherwise attributes.xs
4758            would get pulled in with no real need */
4759         if (!OpHAS_SIBLING(cLISTOPx(*attrs)->op_first)) {
4760             op_free(*attrs);
4761             *attrs = NULL;
4762         }
4763     }
4764
4765     if (new_proto) {
4766         SV *svname;
4767         if (isGV(name)) {
4768             svname = sv_newmortal();
4769             gv_efullname3(svname, name, NULL);