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