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