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