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