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