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