op.h

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