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