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