op.h

   1 /*    op.h
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
   4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10
  11 /*
  12  * The fields of BASEOP are:
  13  *      op_next         Pointer to next ppcode to execute after this one.
  14  *                      (Top level pre-grafted op points to first op,
  15  *                      but this is replaced when op is grafted in, when
  16  *                      this op will point to the real next op, and the new
  17  *                      parent takes over role of remembering starting op.)
  18  *      op_sibparent    Pointer to the op's next sibling, or to the parent
  19  *                      if there are no more siblings.
  20  *      op_ppaddr       Pointer to current ppcode's function.
  21  *      op_targ         An index into the current pad, identifying an SV
  22  *                      that is typically used to store the OP's result
  23  *                      (such as a lexical variable, or a SVs_PADTMP
  24  *                      temporary intermediate value).
  25  *      op_type         The type of the operation.
  26  *      op_opt          Whether or not the op has been optimised by the
  27  *                      peephole optimiser.
  28  *      op_slabbed      allocated via opslab
  29  *      op_static       tell op_free() to skip PerlMemShared_free(), when
  30  *                      !op_slabbed.
  31  *      op_savefree     on savestack via SAVEFREEOP
  32  *      op_folded       Result/remainder of a constant fold operation.
  33  *      op_moresib      this op is not the last sibling
  34  *      op_spare        One spare bit
  35  *      op_flags        Flags common to all operations.  See OPf_* below.
  36  *      op_private      Flags peculiar to a particular operation (BUT,
  37  *                      by default, set to the number of children until
  38  *                      the operation is privatized by a check routine,
  39  *                      which may or may not check number of children).
  40  */
  41 #include "op_reg_common.h"
  42
  43 #define OPCODE U16
  44
  45 typedef PERL_BITFIELD16 Optype;
  46
  47 #ifdef BASEOP_DEFINITION
  48 #define BASEOP BASEOP_DEFINITION
  49 #else
  50 #define BASEOP                          \
  51     OP*         op_next;                \
  52     OP*         op_sibparent;           \
  53     OP*         (*op_ppaddr)(pTHX);     \
  54     PADOFFSET   op_targ;                \
  55     PERL_BITFIELD16 op_type:9;          \
  56     PERL_BITFIELD16 op_opt:1;           \
  57     PERL_BITFIELD16 op_slabbed:1;       \
  58     PERL_BITFIELD16 op_savefree:1;      \
  59     PERL_BITFIELD16 op_static:1;        \
  60     PERL_BITFIELD16 op_folded:1;        \
  61     PERL_BITFIELD16 op_moresib:1;       \
  62     PERL_BITFIELD16 op_spare:1;         \
  63     U8          op_flags;               \
  64     U8          op_private;
  65 #endif
  66
  67 #define OpTYPE_set(o,type)                      \
  68     STMT_START {                                \
  69         OP *o_ = (OP *)o;                       \
  70         OPCODE type_ = type;                    \
  71         o_->op_type = type_;                    \
  72         o_->op_ppaddr = PL_ppaddr[type_];       \
  73     } STMT_END
  74
  75 /* If op_type:9 is changed to :10, also change cx_pusheval()
  76    Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
  77    then all the other bit-fields before/after it should change their
  78    types too to let VC pack them into the same 4 byte integer.*/
  79
  80 /* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
  81 #define OP_GIMME(op,dfl) \
  82         (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
  83
  84 #define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
  85
  86 /*
  87 =for apidoc_section $callback
  88
  89 =for apidoc Amn|U32|GIMME_V
  90 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
  91 C<G_SCALAR> or C<G_LIST> for void, scalar or list context,
  92 respectively.  See L<perlcall> for a usage example.
  93
  94 =for apidoc AmnD|U32|GIMME
  95 A backward-compatible version of C<GIMME_V> which can only return
  96 C<G_SCALAR> or C<G_LIST>; in a void context, it returns C<G_SCALAR>.
  97 Deprecated.  Use C<GIMME_V> instead.
  98
  99 =cut
 100 */
 101
 102 #define GIMME_V         Perl_gimme_V(aTHX)
 103
 104 /* Public flags */
 105
 106 #define OPf_WANT        3       /* Mask for "want" bits: */
 107 #define  OPf_WANT_VOID   1      /*   Want nothing */
 108 #define  OPf_WANT_SCALAR 2      /*   Want single value */
 109 #define  OPf_WANT_LIST   3      /*   Want list of any length */
 110 #define OPf_KIDS        4       /* There is a firstborn child. */
 111 #define OPf_PARENS      8       /* This operator was parenthesized. */
 112                                 /*  (Or block needs explicit scope entry.) */
 113 #define OPf_REF         16      /* Certified reference. */
 114                                 /*  (Return container, not containee). */
 115 #define OPf_MOD         32      /* Will modify (lvalue). */
 116
 117 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
 118                                 /*   Indicates mutator-variant of op for those
 119                                  *     ops which support them, e.g. $x += 1
 120                                  */
 121
 122 #define OPf_SPECIAL     128     /* Do something weird for this op: */
 123                                 /*  On local LVAL, don't init local value. */
 124                                 /*  On OP_SORT, subroutine is inlined. */
 125                                 /*  On OP_NOT, inversion was implicit. */
 126                                 /*  On OP_LEAVE, don't restore curpm, e.g.
 127                                  *      /(...)/ while ...>;  */
 128                                 /*  On truncate, we truncate filehandle */
 129                                 /*  On control verbs, we saw no label */
 130                                 /*  On flipflop, we saw ... instead of .. */
 131                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
 132                                 /*  On OP_CHDIR, handle (or bare parens) */
 133                                 /*  On OP_NULL, saw a "do". */
 134                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
 135                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
 136                                 /*  On regcomp, "use re 'eval'" was in scope */
 137                                 /*  On RV2[ACGHS]V, don't create GV--in
 138                                     defined()*/
 139                                 /*  On OP_DBSTATE, indicates breakpoint
 140                                  *    (runtime property) */
 141                                 /*  On OP_REQUIRE, was seen as CORE::require */
 142                                 /*  On OP_(ENTER|LEAVE)WHEN, there's
 143                                     no condition */
 144                                 /*  On OP_SMARTMATCH, an implicit smartmatch */
 145                                 /*  On OP_ANONHASH and OP_ANONLIST, create a
 146                                     reference to the new anon hash or array */
 147                                 /*  On OP_HELEM, OP_MULTIDEREF and OP_HSLICE,
 148                                     localization will be followed by assignment,
 149                                     so do not wipe the target if it is special
 150                                     (e.g. a glob or a magic SV) */
 151                                 /*  On OP_MATCH, OP_SUBST & OP_TRANS, the
 152                                     operand of a logical or conditional
 153                                     that was optimised away, so it should
 154                                     not be bound via =~ */
 155                                 /*  On OP_CONST, from a constant CV */
 156                                 /*  On OP_GLOB, two meanings:
 157                                     - Before ck_glob, called as CORE::glob
 158                                     - After ck_glob, use Perl glob function
 159                                  */
 160                                 /*  On OP_PADRANGE, push @_ */
 161                                 /*  On OP_DUMP, has no label */
 162                                 /*  On OP_UNSTACK, in a C-style for loop */
 163                                 /*  On OP_READLINE, it's for <<>>, not <> */
 164 /* There is no room in op_flags for this one, so it has its own bit-
 165    field member (op_folded) instead.  The flag is only used to tell
 166    op_convert_list to set op_folded.  */
 167 #define OPf_FOLDED      (1<<16)
 168
 169 /* old names; don't use in new code, but don't break them, either */
 170 #define OPf_LIST        OPf_WANT_LIST
 171 #define OPf_KNOW        OPf_WANT
 172
 173 #if !defined(PERL_CORE) && !defined(PERL_EXT)
 174 #  define GIMME \
 175           (PL_op->op_flags & OPf_WANT                                   \
 176            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
 177               ? G_LIST                                                  \
 178               : G_SCALAR)                                               \
 179            : dowantarray())
 180 #endif
 181
 182
 183 /* NOTE: OPp* flags are now auto-generated and defined in opcode.h,
 184  *       from data in regen/op_private */
 185
 186
 187 #define OPpTRANS_ALL    (OPpTRANS_USE_SVOP|OPpTRANS_CAN_FORCE_UTF8|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
 188 #define OPpTRANS_FROM_UTF   OPpTRANS_USE_SVOP
 189 #define OPpTRANS_TO_UTF     OPpTRANS_CAN_FORCE_UTF8
 190
 191
 192 /* Mask for OP_ENTERSUB flags, the absence of which must be propagated
 193  in dynamic context */
 194 #define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
 195
 196
 197 /* things that can be elements of op_aux */
 198 typedef union {
 199     PADOFFSET pad_offset;
 200     SV        *sv;
 201     IV        iv;
 202     UV        uv;
 203     char      *pv;
 204     SSize_t   ssize;
 205 } UNOP_AUX_item;
 206
 207 #ifdef USE_ITHREADS
 208 #  define UNOP_AUX_item_sv(item) PAD_SVl((item)->pad_offset);
 209 #else
 210 #  define UNOP_AUX_item_sv(item) ((item)->sv);
 211 #endif
 212
 213
 214
 215
 216 struct op {
 217     BASEOP
 218 };
 219
 220 struct unop {
 221     BASEOP
 222     OP *        op_first;
 223 };
 224
 225 struct unop_aux {
 226     BASEOP
 227     OP            *op_first;
 228     UNOP_AUX_item *op_aux;
 229 };
 230
 231 struct binop {
 232     BASEOP
 233     OP *        op_first;
 234     OP *        op_last;
 235 };
 236
 237 struct logop {
 238     BASEOP
 239     OP *        op_first;
 240
 241     /* Note that op->op_other is the *next* op in execution order of the
 242      * alternate branch, not the root of the subtree. I.e. imagine it being
 243      * called ->op_otherfirst.
 244      * To find the structural subtree root (what could be called
 245      * ->op_otherroot), use OpSIBLING of ->op_first  */
 246     OP *        op_other;
 247 };
 248
 249 struct listop {
 250     BASEOP
 251     OP *        op_first;
 252     OP *        op_last;
 253 };
 254
 255 struct methop {
 256     BASEOP
 257     union {
 258         /* op_u.op_first *must* be aligned the same as the op_first
 259          * field of the other op types */
 260         OP* op_first;   /* optree for method name */
 261         SV* op_meth_sv; /* static method name */
 262     } op_u;
 263 #ifdef USE_ITHREADS
 264     PADOFFSET op_rclass_targ; /* pad index for redirect class */
 265 #else
 266     SV*       op_rclass_sv;   /* static redirect class $o->A::meth() */
 267 #endif
 268 };
 269
 270 struct pmop {
 271     BASEOP
 272     OP *        op_first;
 273     OP *        op_last;
 274 #ifdef USE_ITHREADS
 275     PADOFFSET   op_pmoffset;
 276 #else
 277     REGEXP *    op_pmregexp;            /* compiled expression */
 278 #endif
 279     U32         op_pmflags;
 280     union {
 281         OP *    op_pmreplroot;          /* For OP_SUBST */
 282         PADOFFSET op_pmtargetoff;       /* For OP_SPLIT lex ary or thr GV */
 283         GV *    op_pmtargetgv;          /* For OP_SPLIT non-threaded GV */
 284     }   op_pmreplrootu;
 285     union {
 286         OP *    op_pmreplstart; /* Only used in OP_SUBST */
 287 #ifdef USE_ITHREADS
 288         PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
 289 #else
 290         HV *    op_pmstash;
 291 #endif
 292     }           op_pmstashstartu;
 293     OP *        op_code_list;   /* list of (?{}) code blocks */
 294 };
 295
 296 #ifdef USE_ITHREADS
 297 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
 298                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
 299 /* The assignment is just to enforce type safety (or at least get a warning).
 300  */
 301 /* With first class regexps not via a reference one needs to assign
 302    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
 303    is cheaper. I guess we could allow NULL, but the check above would get
 304    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
 305 /* BEWARE - something that calls this macro passes (r) which has a side
 306    effect.  */
 307 #define PM_SETRE(o,r)   STMT_START {                                    \
 308                             REGEXP *const _pm_setre = (r);              \
 309                             assert(_pm_setre);                          \
 310                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
 311                         } STMT_END
 312 #else
 313 #define PM_GETRE(o)     ((o)->op_pmregexp)
 314 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
 315 #endif
 316
 317 /* Currently these PMf flags occupy a single 32-bit word.  Not all bits are
 318  * currently used.  The lower bits are shared with their corresponding RXf flag
 319  * bits, up to but not including _RXf_PMf_SHIFT_NEXT.  The unused bits
 320  * immediately follow; finally the used Pmf-only (unshared) bits, so that the
 321  * highest bit in the word is used.  This gathers all the unused bits as a pool
 322  * in the middle, like so: 11111111111111110000001111111111
 323  * where the '1's represent used bits, and the '0's unused.  This design allows
 324  * us to allocate off one end of the pool if we need to add a shared bit, and
 325  * off the other end if we need a non-shared bit, without disturbing the other
 326  * bits.  This maximizes the likelihood of being able to change things without
 327  * breaking binary compatibility.
 328  *
 329  * To add shared bits, do so in op_reg_common.h.  This should change
 330  * _RXf_PMf_SHIFT_NEXT so that things won't compile.  Then come to regexp.h and
 331  * op.h and adjust the constant adders in the definitions of PMf_BASE_SHIFT and
 332  * Pmf_BASE_SHIFT down by the number of shared bits you added.  That's it.
 333  * Things should be binary compatible.  But if either of these gets to having
 334  * to subtract rather than add, leave at 0 and adjust all the entries below
 335  * that are in terms of this according.  But if the first one of those is
 336  * already PMf_BASE_SHIFT+0, there are no bits left, and a redesign is in
 337  * order.
 338  *
 339  * To remove unshared bits, just delete its entry.  If you're where breaking
 340  * binary compatibility is ok to do, you might want to adjust things to move
 341  * the newly opened space so that it gets absorbed into the common pool.
 342  *
 343  * To add unshared bits, first use up any gaps in the middle.  Otherwise,
 344  * allocate off the low end until you get to PMf_BASE_SHIFT+0.  If that isn't
 345  * enough, move PMf_BASE_SHIFT down (if possible) and add the new bit at the
 346  * other end instead; this preserves binary compatibility. */
 347 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+2)
 348
 349 /* Set by the parser if it discovers an error, so the regex shouldn't be
 350  * compiled */
 351 #define PMf_HAS_ERROR   (1U<<(PMf_BASE_SHIFT+3))
 352
 353 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
 354 #define PMf_RETAINT     (1U<<(PMf_BASE_SHIFT+4))
 355
 356 /* match successfully only once per reset, with related flag RXf_USED in
 357  * re->extflags holding state.  This is used only for ?? matches, and only on
 358  * OP_MATCH and OP_QR */
 359 #define PMf_ONCE        (1U<<(PMf_BASE_SHIFT+5))
 360
 361 /* PMf_ONCE, i.e. ?pat?, has matched successfully.  Not used under threading. */
 362 #define PMf_USED        (1U<<(PMf_BASE_SHIFT+6))
 363
 364 /* subst replacement is constant */
 365 #define PMf_CONST       (1U<<(PMf_BASE_SHIFT+7))
 366
 367 /* keep 1st runtime pattern forever */
 368 #define PMf_KEEP        (1U<<(PMf_BASE_SHIFT+8))
 369
 370 #define PMf_GLOBAL      (1U<<(PMf_BASE_SHIFT+9)) /* pattern had a g modifier */
 371
 372 /* don't reset pos() if //g fails */
 373 #define PMf_CONTINUE    (1U<<(PMf_BASE_SHIFT+10))
 374
 375 /* evaluating replacement as expr */
 376 #define PMf_EVAL        (1U<<(PMf_BASE_SHIFT+11))
 377
 378 /* Return substituted string instead of modifying it. */
 379 #define PMf_NONDESTRUCT (1U<<(PMf_BASE_SHIFT+12))
 380
 381 /* the pattern has a CV attached (currently only under qr/...(?{}).../) */
 382 #define PMf_HAS_CV      (1U<<(PMf_BASE_SHIFT+13))
 383
 384 /* op_code_list is private; don't free it etc. It may well point to
 385  * code within another sub, with different pad etc */
 386 #define PMf_CODELIST_PRIVATE    (1U<<(PMf_BASE_SHIFT+14))
 387
 388 /* the PMOP is a QR (we should be able to detect that from the op type,
 389  * but the regex compilation API passes just the pm flags, not the op
 390  * itself */
 391 #define PMf_IS_QR       (1U<<(PMf_BASE_SHIFT+15))
 392 #define PMf_USE_RE_EVAL (1U<<(PMf_BASE_SHIFT+16)) /* use re'eval' in scope */
 393
 394 /* Means that this is a subpattern being compiled while processing a \p{}
 395  * wildcard.  This isn't called from op.c, but it is passed as a pm flag. */
 396 #define PMf_WILDCARD    (1U<<(PMf_BASE_SHIFT+17))
 397
 398 /* See comments at the beginning of these defines about adding bits.  The
 399  * highest bit position should be used, so that if PMf_BASE_SHIFT gets
 400  * increased, the #error below will be triggered so that you will be reminded
 401  * to adjust things at the other end to keep the bit positions unchanged */
 402 #if PMf_BASE_SHIFT+17 > 31
 403 #   error Too many PMf_ bits used.  See above and regnodes.h for any spare in middle
 404 #endif
 405
 406 #ifdef USE_ITHREADS
 407
 408 #  define PmopSTASH(o)         ((o)->op_pmflags & PMf_ONCE                         \
 409                                 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff]   \
 410                                 : NULL)
 411 #  define PmopSTASH_set(o,hv)   \
 412         (assert_((o)->op_pmflags & PMf_ONCE)                            \
 413          (o)->op_pmstashstartu.op_pmstashoff =                          \
 414             (hv) ? alloccopstash(hv) : 0)
 415 #else
 416 #  define PmopSTASH(o)                                                  \
 417     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
 418 #  if defined (DEBUGGING) && defined(PERL_USE_GCC_BRACE_GROUPS)
 419 #    define PmopSTASH_set(o,hv)         ({                              \
 420         assert((o)->op_pmflags & PMf_ONCE);                             \
 421         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
 422     })
 423 #  else
 424 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
 425 #  endif
 426 #endif
 427 #define PmopSTASHPV(o)  (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
 428    /* op_pmstashstartu.op_pmstash is not refcounted */
 429 #define PmopSTASHPV_set(o,pv)   PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
 430
 431 struct svop {
 432     BASEOP
 433     SV *        op_sv;
 434 };
 435
 436 struct padop {
 437     BASEOP
 438     PADOFFSET   op_padix;
 439 };
 440
 441 struct pvop {
 442     BASEOP
 443     char *      op_pv;
 444 };
 445
 446 struct loop {
 447     BASEOP
 448     OP *        op_first;
 449     OP *        op_last;
 450     OP *        op_redoop;
 451     OP *        op_nextop;
 452     OP *        op_lastop;
 453 };
 454
 455 #define cUNOPx(o)       ((UNOP*)(o))
 456 #define cUNOP_AUXx(o)   ((UNOP_AUX*)(o))
 457 #define cBINOPx(o)      ((BINOP*)(o))
 458 #define cLISTOPx(o)     ((LISTOP*)(o))
 459 #define cLOGOPx(o)      ((LOGOP*)(o))
 460 #define cPMOPx(o)       ((PMOP*)(o))
 461 #define cSVOPx(o)       ((SVOP*)(o))
 462 #define cPADOPx(o)      ((PADOP*)(o))
 463 #define cPVOPx(o)       ((PVOP*)(o))
 464 #define cCOPx(o)        ((COP*)(o))
 465 #define cLOOPx(o)       ((LOOP*)(o))
 466 #define cMETHOPx(o)     ((METHOP*)(o))
 467
 468 #define cUNOP           cUNOPx(PL_op)
 469 #define cUNOP_AUX       cUNOP_AUXx(PL_op)
 470 #define cBINOP          cBINOPx(PL_op)
 471 #define cLISTOP         cLISTOPx(PL_op)
 472 #define cLOGOP          cLOGOPx(PL_op)
 473 #define cPMOP           cPMOPx(PL_op)
 474 #define cSVOP           cSVOPx(PL_op)
 475 #define cPADOP          cPADOPx(PL_op)
 476 #define cPVOP           cPVOPx(PL_op)
 477 #define cCOP            cCOPx(PL_op)
 478 #define cLOOP           cLOOPx(PL_op)
 479 #define cMETHOP         cMETHOPx(PL_op)
 480
 481 #define cUNOPo          cUNOPx(o)
 482 #define cUNOP_AUXo      cUNOP_AUXx(o)
 483 #define cBINOPo         cBINOPx(o)
 484 #define cLISTOPo        cLISTOPx(o)
 485 #define cLOGOPo         cLOGOPx(o)
 486 #define cPMOPo          cPMOPx(o)
 487 #define cSVOPo          cSVOPx(o)
 488 #define cPADOPo         cPADOPx(o)
 489 #define cPVOPo          cPVOPx(o)
 490 #define cCOPo           cCOPx(o)
 491 #define cLOOPo          cLOOPx(o)
 492 #define cMETHOPo        cMETHOPx(o)
 493
 494 #define kUNOP           cUNOPx(kid)
 495 #define kUNOP_AUX       cUNOP_AUXx(kid)
 496 #define kBINOP          cBINOPx(kid)
 497 #define kLISTOP         cLISTOPx(kid)
 498 #define kLOGOP          cLOGOPx(kid)
 499 #define kPMOP           cPMOPx(kid)
 500 #define kSVOP           cSVOPx(kid)
 501 #define kPADOP          cPADOPx(kid)
 502 #define kPVOP           cPVOPx(kid)
 503 #define kCOP            cCOPx(kid)
 504 #define kLOOP           cLOOPx(kid)
 505 #define kMETHOP         cMETHOPx(kid)
 506
 507
 508 typedef enum {
 509     OPclass_NULL,     /*  0 */
 510     OPclass_BASEOP,   /*  1 */
 511     OPclass_UNOP,     /*  2 */
 512     OPclass_BINOP,    /*  3 */
 513     OPclass_LOGOP,    /*  4 */
 514     OPclass_LISTOP,   /*  5 */
 515     OPclass_PMOP,     /*  6 */
 516     OPclass_SVOP,     /*  7 */
 517     OPclass_PADOP,    /*  8 */
 518     OPclass_PVOP,     /*  9 */
 519     OPclass_LOOP,     /* 10 */
 520     OPclass_COP,      /* 11 */
 521     OPclass_METHOP,   /* 12 */
 522     OPclass_UNOP_AUX  /* 13 */
 523 } OPclass;
 524
 525
 526 #ifdef USE_ITHREADS
 527 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
 528 #  ifndef PERL_CORE
 529 #    define     IS_PADGV(v)     (v && isGV(v))
 530 #    define     IS_PADCONST(v) \
 531         (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
 532 #  endif
 533 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
 534                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
 535 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
 536                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
 537 #  define       cMETHOPx_meth(v) (cMETHOPx(v)->op_u.op_meth_sv \
 538                                   ? cMETHOPx(v)->op_u.op_meth_sv : PAD_SVl((v)->op_targ))
 539 #  define       cMETHOPx_rclass(v) PAD_SVl(cMETHOPx(v)->op_rclass_targ)
 540 #else
 541 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
 542 #  ifndef PERL_CORE
 543 #    define     IS_PADGV(v)     FALSE
 544 #    define     IS_PADCONST(v)  FALSE
 545 #  endif
 546 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
 547 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
 548 #  define       cMETHOPx_meth(v)   (cMETHOPx(v)->op_u.op_meth_sv)
 549 #  define       cMETHOPx_rclass(v) (cMETHOPx(v)->op_rclass_sv)
 550 #endif
 551
 552 #define cMETHOP_meth            cMETHOPx_meth(PL_op)
 553 #define cMETHOP_rclass          cMETHOPx_rclass(PL_op)
 554
 555 #define cMETHOPo_meth           cMETHOPx_meth(o)
 556 #define cMETHOPo_rclass         cMETHOPx_rclass(o)
 557
 558 #define cGVOP_gv                cGVOPx_gv(PL_op)
 559 #define cGVOPo_gv               cGVOPx_gv(o)
 560 #define kGVOP_gv                cGVOPx_gv(kid)
 561 #define cSVOP_sv                cSVOPx_sv(PL_op)
 562 #define cSVOPo_sv               cSVOPx_sv(o)
 563 #define kSVOP_sv                cSVOPx_sv(kid)
 564
 565 #ifndef PERL_CORE
 566 #  define Nullop ((OP*)NULL)
 567 #endif
 568
 569 /* Lowest byte of PL_opargs */
 570 #define OA_MARK 1
 571 #define OA_FOLDCONST 2
 572 #define OA_RETSCALAR 4
 573 #define OA_TARGET 8
 574 #define OA_TARGLEX 16
 575 #define OA_OTHERINT 32
 576 #define OA_DANGEROUS 64
 577 #define OA_DEFGV 128
 578
 579 /* The next 4 bits (8..11) encode op class information */
 580 #define OCSHIFT 8
 581
 582 #define OA_CLASS_MASK (15 << OCSHIFT)
 583
 584 #define OA_BASEOP (0 << OCSHIFT)
 585 #define OA_UNOP (1 << OCSHIFT)
 586 #define OA_BINOP (2 << OCSHIFT)
 587 #define OA_LOGOP (3 << OCSHIFT)
 588 #define OA_LISTOP (4 << OCSHIFT)
 589 #define OA_PMOP (5 << OCSHIFT)
 590 #define OA_SVOP (6 << OCSHIFT)
 591 #define OA_PADOP (7 << OCSHIFT)
 592 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
 593 #define OA_LOOP (9 << OCSHIFT)
 594 #define OA_COP (10 << OCSHIFT)
 595 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
 596 #define OA_FILESTATOP (12 << OCSHIFT)
 597 #define OA_LOOPEXOP (13 << OCSHIFT)
 598 #define OA_METHOP (14 << OCSHIFT)
 599 #define OA_UNOP_AUX (15 << OCSHIFT)
 600
 601 /* Each remaining nybble of PL_opargs (i.e. bits 12..15, 16..19 etc)
 602  * encode the type for each arg */
 603 #define OASHIFT 12
 604
 605 #define OA_SCALAR 1
 606 #define OA_LIST 2
 607 #define OA_AVREF 3
 608 #define OA_HVREF 4
 609 #define OA_CVREF 5
 610 #define OA_FILEREF 6
 611 #define OA_SCALARREF 7
 612 #define OA_OPTIONAL 8
 613
 614 /* Op_REFCNT is a reference count at the head of each op tree: needed
 615  * since the tree is shared between threads, and between cloned closure
 616  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
 617  * this count.
 618  * The same mutex is used to protect the refcounts of the reg_trie_data
 619  * and reg_ac_data structures, which are shared between duplicated
 620  * regexes.
 621  */
 622
 623 #ifdef USE_ITHREADS
 624 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
 625 #  ifdef PERL_CORE
 626 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
 627 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
 628 #  else     /* Subject non-core uses to clang thread safety analysis */
 629 #    define OP_REFCNT_LOCK              op_refcnt_lock()
 630 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
 631 #  endif
 632 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
 633 #else
 634 #  define OP_REFCNT_INIT                NOOP
 635 #  define OP_REFCNT_LOCK                NOOP
 636 #  define OP_REFCNT_UNLOCK              NOOP
 637 #  define OP_REFCNT_TERM                NOOP
 638 #endif
 639
 640 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
 641 #ifdef PERL_DEBUG_READONLY_OPS
 642 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
 643 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
 644 #else
 645 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
 646 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
 647 #endif
 648
 649 /* flags used by Perl_load_module() */
 650 #define PERL_LOADMOD_DENY               0x1     /* no Module */
 651 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
 652 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* import arguments
 653                                                    are passed as a sin-
 654                                                    gle op tree, not a
 655                                                    list of SVs */
 656
 657 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
 658 #define ref(o, type) doref(o, type, TRUE)
 659 #endif
 660
 661
 662 /* translation table attached to OP_TRANS/OP_TRANSR ops */
 663
 664 typedef struct {
 665     Size_t size; /* number of entries in map[], not including final slot */
 666     short map[1]; /* Unwarranted chumminess */
 667 } OPtrans_map;
 668
 669
 670 /*
 671 =for apidoc_section $optree_manipulation
 672
 673 =for apidoc Am|OP*|LINKLIST|OP *o
 674 Given the root of an optree, link the tree in execution order using the
 675 C<op_next> pointers and return the first op executed.  If this has
 676 already been done, it will not be redone, and C<< o->op_next >> will be
 677 returned.  If C<< o->op_next >> is not already set, C<o> should be at
 678 least an C<UNOP>.
 679
 680 =cut
 681 */
 682
 683 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
 684
 685 /* no longer used anywhere in core */
 686 #ifndef PERL_CORE
 687 #define cv_ckproto(cv, gv, p) \
 688    cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
 689 #endif
 690
 691 #ifdef PERL_CORE
 692 #  define my(o) my_attrs((o), NULL)
 693 #endif
 694
 695 #ifdef USE_REENTRANT_API
 696 #include "reentr.h"
 697 #endif
 698
 699 #define NewOp(m,var,c,type)     \
 700         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
 701 #define NewOpSz(m,var,size)     \
 702         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
 703 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
 704
 705 /*
 706  * The per-CV op slabs consist of a header (the opslab struct) and a bunch
 707  * of space for allocating op slots, each of which consists of two pointers
 708  * followed by an op.  The first pointer points to the next op slot.  The
 709  * second points to the slab.  At the end of the slab is a null pointer,
 710  * so that slot->opslot_next - slot can be used to determine the size
 711  * of the op.
 712  *
 713  * Each CV can have multiple slabs; opslab_next points to the next slab, to
 714  * form a chain.  All bookkeeping is done on the first slab, which is where
 715  * all the op slots point.
 716  *
 717  * Freed ops are marked as freed and attached to the freed chain
 718  * via op_next pointers.
 719  *
 720  * When there is more than one slab, the second slab in the slab chain is
 721  * assumed to be the one with free space available.  It is used when allo-
 722  * cating an op if there are no freed ops available or big enough.
 723  */
 724
 725 #ifdef PERL_CORE
 726 struct opslot {
 727     U16         opslot_size;        /* size of this slot (in pointers) */
 728     U16         opslot_offset;      /* offset from start of slab (in ptr units) */
 729     OP          opslot_op;              /* the op itself */
 730 };
 731
 732 struct opslab {
 733     OPSLAB *    opslab_next;            /* next slab */
 734     OPSLAB *    opslab_head;            /* first slab in chain */
 735     OP **       opslab_freed;           /* array of sized chains of freed ops (head only)*/
 736     size_t      opslab_refcnt;          /* number of ops (head slab only) */
 737     U16         opslab_freed_size;      /* allocated size of opslab_freed */
 738     U16         opslab_size;            /* size of slab in pointers,
 739                                            including header */
 740     U16         opslab_free_space;      /* space available in this slab
 741                                            for allocating new ops (in ptr
 742                                            units) */
 743 # ifdef PERL_DEBUG_READONLY_OPS
 744     bool        opslab_readonly;
 745 # endif
 746     OPSLOT      opslab_slots;           /* slots begin here */
 747 };
 748
 749 # define OPSLOT_HEADER          STRUCT_OFFSET(OPSLOT, opslot_op)
 750 # define OpSLOT(o)              (assert_(o->op_slabbed) \
 751                                  (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
 752
 753 /* the slab that owns this op */
 754 # define OpMySLAB(o) \
 755     ((OPSLAB*)((char *)((I32**)OpSLOT(o) - OpSLOT(o)->opslot_offset)-STRUCT_OFFSET(struct opslab, opslab_slots)))
 756 /* the first (head) opslab of the chain in which this op is allocated */
 757 # define OpSLAB(o) \
 758     (OpMySLAB(o)->opslab_head)
 759 /* calculate the slot given the owner slab and an offset */
 760 #define OpSLOToff(slab, offset) \
 761     ((OPSLOT*)(((I32 **)&(slab)->opslab_slots)+(offset)))
 762
 763 # define OpslabREFCNT_dec(slab)      \
 764         (((slab)->opslab_refcnt == 1) \
 765          ? opslab_free_nopad(slab)     \
 766          : (void)--(slab)->opslab_refcnt)
 767   /* Variant that does not null out the pads */
 768 # define OpslabREFCNT_dec_padok(slab) \
 769         (((slab)->opslab_refcnt == 1)  \
 770          ? opslab_free(slab)            \
 771          : (void)--(slab)->opslab_refcnt)
 772 #endif
 773
 774 struct block_hooks {
 775     U32     bhk_flags;
 776     void    (*bhk_start)        (pTHX_ int full);
 777     void    (*bhk_pre_end)      (pTHX_ OP **seq);
 778     void    (*bhk_post_end)     (pTHX_ OP **seq);
 779     void    (*bhk_eval)         (pTHX_ OP *const saveop);
 780 };
 781
 782 /*
 783 =for apidoc_section $scope
 784
 785 =for apidoc mx|U32|BhkFLAGS|BHK *hk
 786 Return the BHK's flags.
 787
 788 =for apidoc mxu|void *|BhkENTRY|BHK *hk|token which
 789 Return an entry from the BHK structure.  C<which> is a preprocessor token
 790 indicating which entry to return.  If the appropriate flag is not set
 791 this will return C<NULL>.  The type of the return value depends on which
 792 entry you ask for.
 793
 794 =for apidoc Amxu|void|BhkENTRY_set|BHK *hk|token which|void *ptr
 795 Set an entry in the BHK structure, and set the flags to indicate it is
 796 valid.  C<which> is a preprocessing token indicating which entry to set.
 797 The type of C<ptr> depends on the entry.
 798
 799 =for apidoc Amxu|void|BhkDISABLE|BHK *hk|token which
 800 Temporarily disable an entry in this BHK structure, by clearing the
 801 appropriate flag.  C<which> is a preprocessor token indicating which
 802 entry to disable.
 803
 804 =for apidoc Amxu|void|BhkENABLE|BHK *hk|token which
 805 Re-enable an entry in this BHK structure, by setting the appropriate
 806 flag.  C<which> is a preprocessor token indicating which entry to enable.
 807 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
 808 pointer.
 809
 810 =for apidoc mxu|void|CALL_BLOCK_HOOKS|token which|arg
 811 Call all the registered block hooks for type C<which>.  C<which> is a
 812 preprocessing token; the type of C<arg> depends on C<which>.
 813
 814 =cut
 815 */
 816
 817 #define BhkFLAGS(hk)            ((hk)->bhk_flags)
 818
 819 #define BHKf_bhk_start      0x01
 820 #define BHKf_bhk_pre_end    0x02
 821 #define BHKf_bhk_post_end   0x04
 822 #define BHKf_bhk_eval       0x08
 823
 824 #define BhkENTRY(hk, which) \
 825     ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
 826
 827 #define BhkENABLE(hk, which) \
 828     STMT_START { \
 829         BhkFLAGS(hk) |= BHKf_ ## which; \
 830         assert(BhkENTRY(hk, which)); \
 831     } STMT_END
 832
 833 #define BhkDISABLE(hk, which) \
 834     STMT_START { \
 835         BhkFLAGS(hk) &= ~(BHKf_ ## which); \
 836     } STMT_END
 837
 838 #define BhkENTRY_set(hk, which, ptr) \
 839     STMT_START { \
 840         (hk)->which = ptr; \
 841         BhkENABLE(hk, which); \
 842     } STMT_END
 843
 844 #define CALL_BLOCK_HOOKS(which, arg) \
 845     STMT_START { \
 846         if (PL_blockhooks) { \
 847             SSize_t i; \
 848             for (i = av_top_index(PL_blockhooks); i >= 0; i--) { \
 849                 SV *sv = AvARRAY(PL_blockhooks)[i]; \
 850                 BHK *hk; \
 851                 \
 852                 assert(SvIOK(sv)); \
 853                 if (SvUOK(sv)) \
 854                     hk = INT2PTR(BHK *, SvUVX(sv)); \
 855                 else \
 856                     hk = INT2PTR(BHK *, SvIVX(sv)); \
 857                 \
 858                 if (BhkENTRY(hk, which)) \
 859                     BhkENTRY(hk, which)(aTHX_ arg); \
 860             } \
 861         } \
 862     } STMT_END
 863
 864 /* flags for rv2cv_op_cv */
 865
 866 #define RV2CVOPCV_MARK_EARLY     0x00000001
 867 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
 868 #define RV2CVOPCV_RETURN_STUB    0x00000004
 869 #if defined(PERL_CORE) || defined(PERL_EXT) /* behaviour of this flag is subject to change: */
 870 # define RV2CVOPCV_MAYBE_NAME_GV  0x00000008
 871 #endif
 872 #define RV2CVOPCV_FLAG_MASK      0x0000000f /* all of the above */
 873
 874 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
 875
 876 /* flags for op_lvalue_flags */
 877
 878 #define OP_LVALUE_NO_CROAK 1
 879
 880 /*
 881 =for apidoc_section $custom
 882
 883 =for apidoc Am|U32|XopFLAGS|XOP *xop
 884 Return the XOP's flags.
 885
 886 =for apidoc Amu||XopENTRY|XOP *xop|token which
 887 Return a member of the XOP structure.  C<which> is a cpp token
 888 indicating which entry to return.  If the member is not set
 889 this will return a default value.  The return type depends
 890 on C<which>.  This macro evaluates its arguments more than
 891 once.  If you are using C<Perl_custom_op_xop> to retrieve a
 892 C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead.
 893
 894 =for apidoc Amu||XopENTRYCUSTOM|const OP *o|token which
 895 Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more
 896 efficient.  The C<which> parameter is identical to L</XopENTRY>.
 897
 898 =for apidoc Amu|void|XopENTRY_set|XOP *xop|token which|value
 899 Set a member of the XOP structure.  C<which> is a cpp token
 900 indicating which entry to set.  See L<perlguts/"Custom Operators">
 901 for details about the available members and how
 902 they are used.  This macro evaluates its argument
 903 more than once.
 904
 905 =for apidoc Amu|void|XopDISABLE|XOP *xop|token which
 906 Temporarily disable a member of the XOP, by clearing the appropriate flag.
 907
 908 =for apidoc Amu|void|XopENABLE|XOP *xop|token which
 909 Reenable a member of the XOP which has been disabled.
 910
 911 =cut
 912 */
 913
 914 struct custom_op {
 915     U32             xop_flags;
 916     const char     *xop_name;
 917     const char     *xop_desc;
 918     U32             xop_class;
 919     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
 920 };
 921
 922 /* return value of Perl_custom_op_get_field, similar to void * then casting but
 923    the U32 doesn't need truncation on 64 bit platforms in the caller, also
 924    for easier macro writing */
 925 typedef union {
 926     const char     *xop_name;
 927     const char     *xop_desc;
 928     U32             xop_class;
 929     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
 930     XOP            *xop_ptr;
 931 } XOPRETANY;
 932
 933 #define XopFLAGS(xop) ((xop)->xop_flags)
 934
 935 #define XOPf_xop_name   0x01
 936 #define XOPf_xop_desc   0x02
 937 #define XOPf_xop_class  0x04
 938 #define XOPf_xop_peep   0x08
 939
 940 /* used by Perl_custom_op_get_field for option checking */
 941 typedef enum {
 942     XOPe_xop_ptr = 0, /* just get the XOP *, don't look inside it */
 943     XOPe_xop_name = XOPf_xop_name,
 944     XOPe_xop_desc = XOPf_xop_desc,
 945     XOPe_xop_class = XOPf_xop_class,
 946     XOPe_xop_peep = XOPf_xop_peep
 947 } xop_flags_enum;
 948
 949 #define XOPd_xop_name   PL_op_name[OP_CUSTOM]
 950 #define XOPd_xop_desc   PL_op_desc[OP_CUSTOM]
 951 #define XOPd_xop_class  OA_BASEOP
 952 #define XOPd_xop_peep   ((Perl_cpeep_t)0)
 953
 954 #define XopENTRY_set(xop, which, to) \
 955     STMT_START { \
 956         (xop)->which = (to); \
 957         (xop)->xop_flags |= XOPf_ ## which; \
 958     } STMT_END
 959
 960 #define XopENTRY(xop, which) \
 961     ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
 962
 963 #define XopENTRYCUSTOM(o, which) \
 964     (Perl_custom_op_get_field(aTHX_ o, XOPe_ ## which).which)
 965
 966 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
 967 #define XopENABLE(xop, which) \
 968     STMT_START { \
 969         (xop)->xop_flags |= XOPf_ ## which; \
 970         assert(XopENTRY(xop, which)); \
 971     } STMT_END
 972
 973 #define Perl_custom_op_xop(x) \
 974     (Perl_custom_op_get_field(x, XOPe_xop_ptr).xop_ptr)
 975
 976 /*
 977 =for apidoc_section $optree_manipulation
 978
 979 =for apidoc Am|const char *|OP_NAME|OP *o
 980 Return the name of the provided OP.  For core ops this looks up the name
 981 from the op_type; for custom ops from the op_ppaddr.
 982
 983 =for apidoc Am|const char *|OP_DESC|OP *o
 984 Return a short description of the provided OP.
 985
 986 =for apidoc Am|U32|OP_CLASS|OP *o
 987 Return the class of the provided OP: that is, which of the *OP
 988 structures it uses.  For core ops this currently gets the information out
 989 of C<PL_opargs>, which does not always accurately reflect the type used;
 990 in v5.26 onwards, see also the function C<L</op_class>> which can do a better
 991 job of determining the used type.
 992
 993 For custom ops the type is returned from the registration, and it is up
 994 to the registree to ensure it is accurate.  The value returned will be
 995 one of the C<OA_>* constants from F<op.h>.
 996
 997 =for apidoc Am|bool|OP_TYPE_IS|OP *o|Optype type
 998 Returns true if the given OP is not a C<NULL> pointer
 999 and if it is of the given type.
1000
1001 The negation of this macro, C<OP_TYPE_ISNT> is also available
1002 as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide
1003 the NULL pointer check.
1004
1005 =for apidoc Am|bool|OP_TYPE_IS_OR_WAS|OP *o|Optype type
1006 Returns true if the given OP is not a NULL pointer and
1007 if it is of the given type or used to be before being
1008 replaced by an OP of type OP_NULL.
1009
1010 The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT>
1011 is also available as well as C<OP_TYPE_IS_OR_WAS_NN>
1012 and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide
1013 the C<NULL> pointer check.
1014
1015 =for apidoc Am|bool|OpHAS_SIBLING|OP *o
1016 Returns true if C<o> has a sibling
1017
1018 =for apidoc Am|OP*|OpSIBLING|OP *o
1019 Returns the sibling of C<o>, or C<NULL> if there is no sibling
1020
1021 =for apidoc Am|void|OpMORESIB_set|OP *o|OP *sib
1022 Sets the sibling of C<o> to the non-zero value C<sib>. See also C<L</OpLASTSIB_set>>
1023 and C<L</OpMAYBESIB_set>>. For a higher-level interface, see
1024 C<L</op_sibling_splice>>.
1025
1026 =for apidoc Am|void|OpLASTSIB_set|OP *o|OP *parent
1027 Marks C<o> as having no further siblings and marks
1028 o as having the specified parent. See also C<L</OpMORESIB_set>> and
1029 C<OpMAYBESIB_set>. For a higher-level interface, see
1030 C<L</op_sibling_splice>>.
1031
1032 =for apidoc Am|void|OpMAYBESIB_set|OP *o|OP *sib|OP *parent
1033 Conditionally does C<OpMORESIB_set> or C<OpLASTSIB_set> depending on whether
1034 C<sib> is non-null. For a higher-level interface, see C<L</op_sibling_splice>>.
1035
1036 =cut
1037 */
1038
1039 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
1040                     ? XopENTRYCUSTOM(o, xop_name) \
1041                     : PL_op_name[(o)->op_type])
1042 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
1043                     ? XopENTRYCUSTOM(o, xop_desc) \
1044                     : PL_op_desc[(o)->op_type])
1045 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
1046                      ? XopENTRYCUSTOM(o, xop_class) \
1047                      : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
1048
1049 #define OP_TYPE_IS(o, type) ((o) && (o)->op_type == (type))
1050 #define OP_TYPE_IS_NN(o, type) ((o)->op_type == (type))
1051 #define OP_TYPE_ISNT(o, type) ((o) && (o)->op_type != (type))
1052 #define OP_TYPE_ISNT_NN(o, type) ((o)->op_type != (type))
1053
1054 #define OP_TYPE_IS_OR_WAS_NN(o, type) \
1055     ( ((o)->op_type == OP_NULL \
1056        ? (o)->op_targ \
1057        : (o)->op_type) \
1058       == (type) )
1059
1060 #define OP_TYPE_IS_OR_WAS(o, type) \
1061     ( (o) && OP_TYPE_IS_OR_WAS_NN(o, type) )
1062
1063 #define OP_TYPE_ISNT_AND_WASNT_NN(o, type) \
1064     ( ((o)->op_type == OP_NULL \
1065        ? (o)->op_targ \
1066        : (o)->op_type) \
1067       != (type) )
1068
1069 #define OP_TYPE_ISNT_AND_WASNT(o, type) \
1070     ( (o) && OP_TYPE_ISNT_AND_WASNT_NN(o, type) )
1071
1072 /* should match anything that uses ck_ftst in regen/opcodes */
1073 #define OP_IS_STAT(op) (OP_IS_FILETEST(op) || (op) == OP_LSTAT || (op) == OP_STAT)
1074
1075 #define OpHAS_SIBLING(o)        (cBOOL((o)->op_moresib))
1076 #define OpSIBLING(o)            (0 + (o)->op_moresib ? (o)->op_sibparent : NULL)
1077 #define OpMORESIB_set(o, sib) ((o)->op_moresib = 1, (o)->op_sibparent = (sib))
1078 #define OpLASTSIB_set(o, parent) \
1079     ((o)->op_moresib = 0, (o)->op_sibparent = (parent))
1080 #define OpMAYBESIB_set(o, sib, parent) \
1081     ((o)->op_sibparent = ((o)->op_moresib = cBOOL(sib)) ? (sib) : (parent))
1082
1083 #if !defined(PERL_CORE) && !defined(PERL_EXT)
1084 /* for backwards compatibility only */
1085 #  define OP_SIBLING(o)         OpSIBLING(o)
1086 #endif
1087
1088 #define newATTRSUB(f, o, p, a, b) Perl_newATTRSUB_x(aTHX_  f, o, p, a, b, FALSE)
1089 #define newSUB(f, o, p, b)      newATTRSUB((f), (o), (p), NULL, (b))
1090
1091 #ifdef USE_ITHREADS
1092 #  define OP_CHECK_MUTEX_INIT           MUTEX_INIT(&PL_check_mutex)
1093 #  define OP_CHECK_MUTEX_LOCK           MUTEX_LOCK(&PL_check_mutex)
1094 #  define OP_CHECK_MUTEX_UNLOCK         MUTEX_UNLOCK(&PL_check_mutex)
1095 #  define OP_CHECK_MUTEX_TERM           MUTEX_DESTROY(&PL_check_mutex)
1096 #else
1097 #  define OP_CHECK_MUTEX_INIT           NOOP
1098 #  define OP_CHECK_MUTEX_LOCK           NOOP
1099 #  define OP_CHECK_MUTEX_UNLOCK         NOOP
1100 #  define OP_CHECK_MUTEX_TERM           NOOP
1101 #endif
1102
1103
1104 /* Stuff for OP_MULTDEREF/pp_multideref. */
1105
1106 /* actions */
1107
1108 /* Load another word of actions/flag bits. Must be 0 */
1109 #define MDEREF_reload                       0
1110
1111 #define MDEREF_AV_pop_rv2av_aelem           1
1112 #define MDEREF_AV_gvsv_vivify_rv2av_aelem   2
1113 #define MDEREF_AV_padsv_vivify_rv2av_aelem  3
1114 #define MDEREF_AV_vivify_rv2av_aelem        4
1115 #define MDEREF_AV_padav_aelem               5
1116 #define MDEREF_AV_gvav_aelem                6
1117
1118 #define MDEREF_HV_pop_rv2hv_helem           8
1119 #define MDEREF_HV_gvsv_vivify_rv2hv_helem   9
1120 #define MDEREF_HV_padsv_vivify_rv2hv_helem 10
1121 #define MDEREF_HV_vivify_rv2hv_helem       11
1122 #define MDEREF_HV_padhv_helem              12
1123 #define MDEREF_HV_gvhv_helem               13
1124
1125 #define MDEREF_ACTION_MASK                0xf
1126
1127 /* key / index type */
1128
1129 #define MDEREF_INDEX_none   0x00 /* run external ops to generate index */
1130 #define MDEREF_INDEX_const  0x10 /* index is const PV/UV */
1131 #define MDEREF_INDEX_padsv  0x20 /* index is lexical var */
1132 #define MDEREF_INDEX_gvsv   0x30 /* index is GV */
1133
1134 #define MDEREF_INDEX_MASK   0x30
1135
1136 /* bit flags */
1137
1138 #define MDEREF_FLAG_last    0x40 /* the last [ah]elem; PL_op flags apply */
1139
1140 #define MDEREF_MASK         0x7F
1141 #define MDEREF_SHIFT           7
1142
1143 #if defined(PERL_IN_DOOP_C) || defined(PERL_IN_PP_C)
1144 #   define FATAL_ABOVE_FF_MSG                                       \
1145       "Use of strings with code points over 0xFF as arguments to "  \
1146       "%s operator is not allowed"
1147 #endif
1148 #if defined(PERL_IN_OP_C) || defined(PERL_IN_DOOP_C) || defined(PERL_IN_PERL_C)
1149 #  define TR_UNMAPPED           (UV)-1
1150 #  define TR_DELETE             (UV)-2
1151 #  define TR_R_EMPTY            (UV)-3  /* rhs (replacement) is empty */
1152 #  define TR_OOB                (UV)-4  /* Something that isn't one of the others */
1153 #  define TR_SPECIAL_HANDLING   TR_DELETE /* Can occupy same value */
1154 #  define TR_UNLISTED           TR_UNMAPPED /* A synonym whose name is clearer
1155                                                at times */
1156 #endif
1157 #if defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
1158 #define RANGE_INDICATOR  ILLEGAL_UTF8_BYTE
1159 #endif
1160
1161 /* stuff for OP_ARGCHECK */
1162
1163 struct op_argcheck_aux {
1164     UV   params;     /* number of positional parameters */
1165     UV   opt_params; /* number of optional positional parameters */
1166     char slurpy;     /* presence of slurpy: may be '\0', '@' or '%' */
1167 };
1168
1169
1170 /*
1171  * ex: set ts=8 sts=4 sw=4 et:
1172  */