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