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_spare        Two spare bits
  28  *      op_flags        Flags common to all operations.  See OPf_* below.
  29  *      op_private      Flags peculiar to a particular operation (BUT,
  30  *                      by default, set to the number of children until
  31  *                      the operation is privatized by a check routine,
  32  *                      which may or may not check number of children).
  33  */
  34 #include "op_reg_common.h"
  35
  36 #define OPCODE U16
  37
  38 typedef PERL_BITFIELD16 Optype;
  39
  40 #ifdef BASEOP_DEFINITION
  41 #define BASEOP BASEOP_DEFINITION
  42 #else
  43 #define BASEOP                          \
  44     OP*         op_next;                \
  45     OP*         op_sibling;             \
  46     OP*         (*op_ppaddr)(pTHX);     \
  47     PADOFFSET   op_targ;                \
  48     PERL_BITFIELD16 op_type:9;          \
  49     PERL_BITFIELD16 op_opt:1;           \
  50     PERL_BITFIELD16 op_slabbed:1;       \
  51     PERL_BITFIELD16 op_savefree:1;      \
  52     PERL_BITFIELD16 op_static:1;        \
  53     PERL_BITFIELD16 op_folded:1;        \
  54     PERL_BITFIELD16 op_spare:2;         \
  55     U8          op_flags;               \
  56     U8          op_private;
  57 #endif
  58
  59 /* If op_type:9 is changed to :10, also change PUSHEVAL in cop.h.
  60    Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
  61    then all the other bit-fields before/after it should change their
  62    types too to let VC pack them into the same 4 byte integer.*/
  63
  64 /* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
  65 #define OP_GIMME(op,dfl) \
  66         (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
  67
  68 #define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
  69
  70 /*
  71 =head1 "Gimme" Values
  72
  73 =for apidoc Amn|U32|GIMME_V
  74 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
  75 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
  76 respectively.  See L<perlcall> for a usage example.
  77
  78 =for apidoc Amn|U32|GIMME
  79 A backward-compatible version of C<GIMME_V> which can only return
  80 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
  81 Deprecated.  Use C<GIMME_V> instead.
  82
  83 =cut
  84 */
  85
  86 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
  87
  88 /* Public flags */
  89
  90 #define OPf_WANT        3       /* Mask for "want" bits: */
  91 #define  OPf_WANT_VOID   1      /*   Want nothing */
  92 #define  OPf_WANT_SCALAR 2      /*   Want single value */
  93 #define  OPf_WANT_LIST   3      /*   Want list of any length */
  94 #define OPf_KIDS        4       /* There is a firstborn child. */
  95 #define OPf_PARENS      8       /* This operator was parenthesized. */
  96                                 /*  (Or block needs explicit scope entry.) */
  97 #define OPf_REF         16      /* Certified reference. */
  98                                 /*  (Return container, not containee). */
  99 #define OPf_MOD         32      /* Will modify (lvalue). */
 100 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
 101 #define OPf_SPECIAL     128     /* Do something weird for this op: */
 102                                 /*  On local LVAL, don't init local value. */
 103                                 /*  On OP_SORT, subroutine is inlined. */
 104                                 /*  On OP_NOT, inversion was implicit. */
 105                                 /*  On OP_LEAVE, don't restore curpm. */
 106                                 /*  On truncate, we truncate filehandle */
 107                                 /*  On control verbs, we saw no label */
 108                                 /*  On flipflop, we saw ... instead of .. */
 109                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
 110                                 /*  On OP_ENTERSUB || OP_NULL, saw a "do". */
 111                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
 112                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
 113                                 /*  On pushre, rx is used as part of split, e.g. split " " */
 114                                 /*  On regcomp, "use re 'eval'" was in scope */
 115                                 /*  On OP_READLINE, was <$filehandle> */
 116                                 /*  On RV2[ACGHS]V, don't create GV--in
 117                                     defined()*/
 118                                 /*  On OP_DBSTATE, indicates breakpoint
 119                                  *    (runtime property) */
 120                                 /*  On OP_REQUIRE, was seen as CORE::require */
 121                                 /*  On OP_(ENTER|LEAVE)WHEN, there's
 122                                     no condition */
 123                                 /*  On OP_SMARTMATCH, an implicit smartmatch */
 124                                 /*  On OP_ANONHASH and OP_ANONLIST, create a
 125                                     reference to the new anon hash or array */
 126                                 /*  On OP_HELEM and OP_HSLICE, localization will be followed
 127                                     by assignment, so do not wipe the target if it is special
 128                                     (e.g. a glob or a magic SV) */
 129                                 /*  On OP_MATCH, OP_SUBST & OP_TRANS, the
 130                                     operand of a logical or conditional
 131                                     that was optimised away, so it should
 132                                     not be bound via =~ */
 133                                 /*  On OP_CONST, from a constant CV */
 134                                 /*  On OP_GLOB, two meanings:
 135                                     - Before ck_glob, called as CORE::glob
 136                                     - After ck_glob, use Perl glob function
 137                                  */
 138                                 /*  On OP_PADRANGE, push @_ */
 139                                 /*  On OP_DUMP, has no label */
 140
 141 /* old names; don't use in new code, but don't break them, either */
 142 #define OPf_LIST        OPf_WANT_LIST
 143 #define OPf_KNOW        OPf_WANT
 144
 145 #define GIMME \
 146           (PL_op->op_flags & OPf_WANT                                   \
 147            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
 148               ? G_ARRAY                                                 \
 149               : G_SCALAR)                                               \
 150            : dowantarray())
 151
 152 /* Lower bits of op_private often carry the number of arguments, as
 153  * set by newBINOP, newUNOP and ck_fun */
 154
 155 /* NOTE: OP_NEXTSTATE and OP_DBSTATE (i.e. COPs) carry NATIVE_HINTS
 156  * in op_private */
 157
 158 /* Private for lvalues */
 159 #define OPpLVAL_INTRO   128     /* Lvalue must be localized or lvalue sub */
 160
 161 /* Private for OPs with TARGLEX */
 162   /* (lower bits may carry MAXARG) */
 163 #define OPpTARGET_MY            16      /* Target is PADMY. */
 164
 165 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
 166 #define OPpREFCOUNTED           64      /* op_targ carries a refcount */
 167
 168 /* Private for OP_LEAVE and OP_LEAVELOOP */
 169 #define OPpLVALUE               128     /* Do not copy return value */
 170
 171 /* Private for OP_AASSIGN */
 172 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
 173
 174 /* Private for OP_SASSIGN */
 175 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
 176 #define OPpASSIGN_CV_TO_GV      128     /* Possible optimisation for constants. */
 177
 178 /* Private for OP_MATCH and OP_SUBST{,CONT} */
 179 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
 180
 181 /* Private for OP_TRANS */
 182 #define OPpTRANS_FROM_UTF       1
 183 #define OPpTRANS_TO_UTF         2
 184 #define OPpTRANS_IDENTICAL      4       /* right side is same as left */
 185 #define OPpTRANS_SQUASH         8
 186     /* 16 is used for OPpTARGET_MY */
 187 #define OPpTRANS_COMPLEMENT     32
 188 #define OPpTRANS_GROWS          64
 189 #define OPpTRANS_DELETE         128
 190 #define OPpTRANS_ALL    (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
 191
 192 /* Private for OP_REPEAT */
 193 #define OPpREPEAT_DOLIST        64      /* List replication. */
 194
 195 /* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
 196 #define OPpDEREF                (32|64) /* autovivify: Want ref to something: */
 197 #define OPpDEREF_AV             32      /*   Want ref to AV. */
 198 #define OPpDEREF_HV             64      /*   Want ref to HV. */
 199 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
 200
 201 /* OP_ENTERSUB and OP_RV2CV flags
 202
 203 Flags are set on entersub and rv2cv in three phases:
 204   parser  - the parser passes the flag to the op constructor
 205   check   - the check routine called by the op constructor sets the flag
 206   context - application of scalar/ref/lvalue context applies the flag
 207
 208 In the third stage, an entersub op might turn into an rv2cv op (undef &foo,
 209 \&foo, lock &foo, exists &foo, defined &foo).  The two places where that
 210 happens (op_lvalue_flags and doref in op.c) need to make sure the flags do
 211 not conflict.  Flags applied in the context phase are only set when there
 212 is no conversion of op type.
 213
 214   bit  entersub flag       phase   rv2cv flag             phase
 215   ---  -------------       -----   ----------             -----
 216     1  OPpENTERSUB_INARGS  context OPpMAY_RETURN_CONSTANT context
 217     2  HINT_STRICT_REFS    check   HINT_STRICT_REFS       check
 218     4  OPpENTERSUB_HASTARG check
 219     8                              OPpENTERSUB_AMPER      parser
 220    16  OPpENTERSUB_DB      check
 221    32  OPpDEREF_AV         context
 222    64  OPpDEREF_HV         context
 223   128  OPpLVAL_INTRO       context OPpENTERSUB_NOPAREN    parser
 224
 225 */
 226
 227   /* OP_ENTERSUB only */
 228 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
 229 #define OPpENTERSUB_HASTARG     4       /* Called from OP tree. */
 230 #define OPpENTERSUB_INARGS      1       /* Lval used as arg to a sub. */
 231 /* used by OPpDEREF             (32|64) */
 232 /* used by HINT_STRICT_REFS     2          */
 233   /* Mask for OP_ENTERSUB flags, the absence of which must be propagated
 234      in dynamic context */
 235 #define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
 236
 237   /* OP_RV2CV only */
 238 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
 239 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
 240 #define OPpMAY_RETURN_CONSTANT  1       /* If a constant sub, return the constant */
 241
 242   /* OP_GV only */
 243 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
 244   /* OP_?ELEM only */
 245 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
 246   /* OP_RV2[AH]V OP_[AH]SLICE */
 247 #define OPpSLICEWARNING         4       /* warn about @hash{$scalar} */
 248   /* OP_RV2[SAH]V, OP_GVSV, OP_ENTERITER only */
 249 #define OPpOUR_INTRO            16      /* Variable was in an our() */
 250   /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM, OP_[AH]SLICE OP_AV2ARYLEN,
 251      OP_R?KEYS, OP_SUBSTR, OP_POS, OP_VEC */
 252 #define OPpMAYBE_LVSUB          8       /* We might be an lvalue to return */
 253   /* OP_RV2HV and OP_PADHV */
 254 #define OPpTRUEBOOL             32      /* %hash in (%hash || $foo) in
 255                                            void context */
 256 #define OPpMAYBE_TRUEBOOL       64      /* %hash in (%hash || $foo) where
 257                                            cx is not known till run time */
 258
 259   /* OP_SUBSTR only */
 260 #define OPpSUBSTR_REPL_FIRST    16      /* 1st arg is replacement string */
 261
 262   /* OP_PADSV only */
 263 #define OPpPAD_STATE            16      /* is a "state" pad */
 264   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
 265
 266   /* OP_PADRANGE only */
 267   /* bit 7 is OPpLVAL_INTRO */
 268 #define OPpPADRANGE_COUNTMASK   127     /* bits 6..0 hold target range, */
 269 #define OPpPADRANGE_COUNTSHIFT  7       /* 7 bits in total */
 270
 271   /* OP_RV2GV only */
 272 #define OPpDONT_INIT_GV         4       /* Call gv_fetchpv with GV_NOINIT */
 273 /* (Therefore will return whatever is currently in the symbol table, not
 274    guaranteed to be a PVGV)  */
 275 #define OPpALLOW_FAKE           16      /* OK to return fake glob */
 276
 277 /* Private for OP_ENTERITER and OP_ITER */
 278 #define OPpITER_REVERSED        4       /* for (reverse ...) */
 279 #define OPpITER_DEF             8       /* for $_ or for my $_ */
 280
 281 /* Private for OP_CONST */
 282 #define OPpCONST_NOVER          2       /* no 6; */
 283 #define OPpCONST_SHORTCIRCUIT   4       /* eg the constant 5 in (5 || foo) */
 284 #define OPpCONST_STRICT         8       /* bareword subject to strict 'subs' */
 285 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
 286 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
 287
 288 /* Private for OP_FLIP/FLOP */
 289 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
 290
 291 /* Private for OP_LIST */
 292 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
 293
 294 /* Private for OP_DELETE */
 295 #define OPpSLICE                64      /* Operating on a list of keys */
 296 /* Also OPpLVAL_INTRO (128) */
 297
 298 /* Private for OP_EXISTS */
 299 #define OPpEXISTS_SUB           64      /* Checking for &sub, not {} or [].  */
 300
 301 /* Private for OP_SORT */
 302 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
 303 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
 304 #define OPpSORT_REVERSE         4       /* Reversed sort */
 305 #define OPpSORT_INPLACE         8       /* sort in-place; eg @a = sort @a */
 306 #define OPpSORT_DESCEND         16      /* Descending sort */
 307 #define OPpSORT_QSORT           32      /* Use quicksort (not mergesort) */
 308 #define OPpSORT_STABLE          64      /* Use a stable algorithm */
 309
 310 /* Private for OP_REVERSE */
 311 #define OPpREVERSE_INPLACE      8       /* reverse in-place (@a = reverse @a) */
 312
 313 /* Private for OP_OPEN and OP_BACKTICK */
 314 #define OPpOPEN_IN_RAW          16      /* binmode(F,":raw") on input fh */
 315 #define OPpOPEN_IN_CRLF         32      /* binmode(F,":crlf") on input fh */
 316 #define OPpOPEN_OUT_RAW         64      /* binmode(F,":raw") on output fh */
 317 #define OPpOPEN_OUT_CRLF        128     /* binmode(F,":crlf") on output fh */
 318
 319 /* Private for COPs */
 320 #define OPpHUSH_VMSISH          32      /* hush DCL exit msg vmsish mode*/
 321 /* Note: Used for NATIVE_HINTS (shifted from the values in PL_hints),
 322          currently defined by vms/vmsish.h:
 323                                 64
 324                                 128
 325  */
 326
 327 /* Private for OP_FTXXX */
 328 #define OPpFT_ACCESS            2       /* use filetest 'access' */
 329 #define OPpFT_STACKED           4       /* stacked filetest, as "-f" in "-f -x $f" */
 330 #define OPpFT_STACKING          8       /* stacking filetest, as "-x" in "-f -x $f" */
 331 #define OPpFT_AFTER_t           16      /* previous op was -t */
 332
 333 /* Private for OP_(MAP|GREP)(WHILE|START) */
 334 #define OPpGREP_LEX             2       /* iterate over lexical $_ */
 335
 336 /* Private for OP_ENTEREVAL */
 337 #define OPpEVAL_HAS_HH          2       /* Does it have a copy of %^H */
 338 #define OPpEVAL_UNICODE         4
 339 #define OPpEVAL_BYTES           8
 340 #define OPpEVAL_COPHH           16      /* Construct %^H from cop hints */
 341 #define OPpEVAL_RE_REPARSING    32      /* eval_sv(..., G_RE_REPARSING) */
 342
 343 /* Private for OP_CALLER, OP_WANTARRAY and OP_RUNCV */
 344 #define OPpOFFBYONE             128     /* Treat caller(1) as caller(2) */
 345
 346 /* Private for OP_COREARGS */
 347 /* These must not conflict with OPpDONT_INIT_GV or OPpALLOW_FAKE.
 348    See pp.c:S_rv2gv. */
 349 #define OPpCOREARGS_DEREF1      1       /* Arg 1 is a handle constructor */
 350 #define OPpCOREARGS_DEREF2      2       /* Arg 2 is a handle constructor */
 351 #define OPpCOREARGS_SCALARMOD   64      /* \$ rather than \[$@%*] */
 352 #define OPpCOREARGS_PUSHMARK    128     /* Call pp_pushmark */
 353
 354 /* Private for OP_(LAST|REDO|NEXT|GOTO|DUMP) */
 355 #define OPpPV_IS_UTF8           128     /* label is in UTF8 */
 356
 357 /* Private for OP_SPLIT */
 358 #define OPpSPLIT_IMPLIM         128     /* implicit limit */
 359
 360 struct op {
 361     BASEOP
 362 };
 363
 364 struct unop {
 365     BASEOP
 366     OP *        op_first;
 367 };
 368
 369 struct binop {
 370     BASEOP
 371     OP *        op_first;
 372     OP *        op_last;
 373 };
 374
 375 struct logop {
 376     BASEOP
 377     OP *        op_first;
 378     OP *        op_other;
 379 };
 380
 381 struct listop {
 382     BASEOP
 383     OP *        op_first;
 384     OP *        op_last;
 385 };
 386
 387 struct pmop {
 388     BASEOP
 389     OP *        op_first;
 390     OP *        op_last;
 391 #ifdef USE_ITHREADS
 392     PADOFFSET   op_pmoffset;
 393 #else
 394     REGEXP *    op_pmregexp;            /* compiled expression */
 395 #endif
 396     U32         op_pmflags;
 397     union {
 398         OP *    op_pmreplroot;          /* For OP_SUBST */
 399 #ifdef USE_ITHREADS
 400         PADOFFSET  op_pmtargetoff;      /* For OP_PUSHRE */
 401 #else
 402         GV *    op_pmtargetgv;
 403 #endif
 404     }   op_pmreplrootu;
 405     union {
 406         OP *    op_pmreplstart; /* Only used in OP_SUBST */
 407 #ifdef USE_ITHREADS
 408         PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
 409 #else
 410         HV *    op_pmstash;
 411 #endif
 412     }           op_pmstashstartu;
 413     OP *        op_code_list;   /* list of (?{}) code blocks */
 414 };
 415
 416 #ifdef USE_ITHREADS
 417 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
 418                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
 419 /* The assignment is just to enforce type safety (or at least get a warning).
 420  */
 421 /* With first class regexps not via a reference one needs to assign
 422    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
 423    is cheaper. I guess we could allow NULL, but the check above would get
 424    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
 425 /* BEWARE - something that calls this macro passes (r) which has a side
 426    effect.  */
 427 #define PM_SETRE(o,r)   STMT_START {                                    \
 428                             REGEXP *const _pm_setre = (r);              \
 429                             assert(_pm_setre);                          \
 430                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
 431                         } STMT_END
 432 #else
 433 #define PM_GETRE(o)     ((o)->op_pmregexp)
 434 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
 435 #endif
 436
 437 /* Leave some space, so future bit allocations can go either in the shared or
 438  * unshared area without affecting binary compatibility */
 439 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+6)
 440
 441 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
 442 #define PMf_RETAINT     (1<<(PMf_BASE_SHIFT+0))
 443
 444 /* match successfully only once per reset, with related flag RXf_USED in
 445  * re->extflags holding state.  This is used only for ?? matches, and only on
 446  * OP_MATCH and OP_QR */
 447 #define PMf_ONCE        (1<<(PMf_BASE_SHIFT+1))
 448
 449 /* PMf_ONCE, i.e. ?pat?, has matched successfully.  Not used under threading. */
 450 #define PMf_USED        (1<<(PMf_BASE_SHIFT+3))
 451
 452 /* subst replacement is constant */
 453 #define PMf_CONST       (1<<(PMf_BASE_SHIFT+4))
 454
 455 /* keep 1st runtime pattern forever */
 456 #define PMf_KEEP        (1<<(PMf_BASE_SHIFT+5))
 457
 458 #define PMf_GLOBAL      (1<<(PMf_BASE_SHIFT+6)) /* pattern had a g modifier */
 459
 460 /* don't reset pos() if //g fails */
 461 #define PMf_CONTINUE    (1<<(PMf_BASE_SHIFT+7))
 462
 463 /* evaluating replacement as expr */
 464 #define PMf_EVAL        (1<<(PMf_BASE_SHIFT+8))
 465
 466 /* Return substituted string instead of modifying it. */
 467 #define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+9))
 468
 469 /* the pattern has a CV attached (currently only under qr/...(?{}).../) */
 470 #define PMf_HAS_CV      (1<<(PMf_BASE_SHIFT+10))
 471
 472 /* op_code_list is private; don't free it etc. It may well point to
 473  * code within another sub, with different pad etc */
 474 #define PMf_CODELIST_PRIVATE    (1<<(PMf_BASE_SHIFT+11))
 475
 476 /* the PMOP is a QR (we should be able to detect that from the op type,
 477  * but the regex compilation API passes just the pm flags, not the op
 478  * itself */
 479 #define PMf_IS_QR       (1<<(PMf_BASE_SHIFT+12))
 480 #define PMf_USE_RE_EVAL (1<<(PMf_BASE_SHIFT+13)) /* use re'eval' in scope */
 481
 482 #if PMf_BASE_SHIFT+13 > 31
 483 #   error Too many PMf_ bits used.  See above and regnodes.h for any spare in middle
 484 #endif
 485
 486 #ifdef USE_ITHREADS
 487
 488 #  define PmopSTASH(o)         ((o)->op_pmflags & PMf_ONCE                         \
 489                                 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff]   \
 490                                 : NULL)
 491 #  define PmopSTASH_set(o,hv)   \
 492         (assert_((o)->op_pmflags & PMf_ONCE)                            \
 493          (o)->op_pmstashstartu.op_pmstashoff =                          \
 494             (hv) ? alloccopstash(hv) : 0)
 495 #else
 496 #  define PmopSTASH(o)                                                  \
 497     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
 498 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 499 #    define PmopSTASH_set(o,hv)         ({                              \
 500         assert((o)->op_pmflags & PMf_ONCE);                             \
 501         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
 502     })
 503 #  else
 504 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
 505 #  endif
 506 #endif
 507 #define PmopSTASHPV(o)  (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
 508    /* op_pmstashstartu.op_pmstash is not refcounted */
 509 #define PmopSTASHPV_set(o,pv)   PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
 510
 511 struct svop {
 512     BASEOP
 513     SV *        op_sv;
 514 };
 515
 516 struct padop {
 517     BASEOP
 518     PADOFFSET   op_padix;
 519 };
 520
 521 struct pvop {
 522     BASEOP
 523     char *      op_pv;
 524 };
 525
 526 struct loop {
 527     BASEOP
 528     OP *        op_first;
 529     OP *        op_last;
 530     OP *        op_redoop;
 531     OP *        op_nextop;
 532     OP *        op_lastop;
 533 };
 534
 535 #define cUNOPx(o)       ((UNOP*)o)
 536 #define cBINOPx(o)      ((BINOP*)o)
 537 #define cLISTOPx(o)     ((LISTOP*)o)
 538 #define cLOGOPx(o)      ((LOGOP*)o)
 539 #define cPMOPx(o)       ((PMOP*)o)
 540 #define cSVOPx(o)       ((SVOP*)o)
 541 #define cPADOPx(o)      ((PADOP*)o)
 542 #define cPVOPx(o)       ((PVOP*)o)
 543 #define cCOPx(o)        ((COP*)o)
 544 #define cLOOPx(o)       ((LOOP*)o)
 545
 546 #define cUNOP           cUNOPx(PL_op)
 547 #define cBINOP          cBINOPx(PL_op)
 548 #define cLISTOP         cLISTOPx(PL_op)
 549 #define cLOGOP          cLOGOPx(PL_op)
 550 #define cPMOP           cPMOPx(PL_op)
 551 #define cSVOP           cSVOPx(PL_op)
 552 #define cPADOP          cPADOPx(PL_op)
 553 #define cPVOP           cPVOPx(PL_op)
 554 #define cCOP            cCOPx(PL_op)
 555 #define cLOOP           cLOOPx(PL_op)
 556
 557 #define cUNOPo          cUNOPx(o)
 558 #define cBINOPo         cBINOPx(o)
 559 #define cLISTOPo        cLISTOPx(o)
 560 #define cLOGOPo         cLOGOPx(o)
 561 #define cPMOPo          cPMOPx(o)
 562 #define cSVOPo          cSVOPx(o)
 563 #define cPADOPo         cPADOPx(o)
 564 #define cPVOPo          cPVOPx(o)
 565 #define cCOPo           cCOPx(o)
 566 #define cLOOPo          cLOOPx(o)
 567
 568 #define kUNOP           cUNOPx(kid)
 569 #define kBINOP          cBINOPx(kid)
 570 #define kLISTOP         cLISTOPx(kid)
 571 #define kLOGOP          cLOGOPx(kid)
 572 #define kPMOP           cPMOPx(kid)
 573 #define kSVOP           cSVOPx(kid)
 574 #define kPADOP          cPADOPx(kid)
 575 #define kPVOP           cPVOPx(kid)
 576 #define kCOP            cCOPx(kid)
 577 #define kLOOP           cLOOPx(kid)
 578
 579
 580 #ifdef USE_ITHREADS
 581 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
 582 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
 583                                  && GvIN_PAD(v))
 584 #  define       IS_PADCONST(v) \
 585         (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
 586 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
 587                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
 588 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
 589                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
 590 #else
 591 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
 592 #  define       IS_PADGV(v)     FALSE
 593 #  define       IS_PADCONST(v)  FALSE
 594 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
 595 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
 596 #endif
 597
 598 #define cGVOP_gv                cGVOPx_gv(PL_op)
 599 #define cGVOPo_gv               cGVOPx_gv(o)
 600 #define kGVOP_gv                cGVOPx_gv(kid)
 601 #define cSVOP_sv                cSVOPx_sv(PL_op)
 602 #define cSVOPo_sv               cSVOPx_sv(o)
 603 #define kSVOP_sv                cSVOPx_sv(kid)
 604
 605 #ifndef PERL_CORE
 606 #  define Nullop ((OP*)NULL)
 607 #endif
 608
 609 /* Lowest byte of PL_opargs */
 610 #define OA_MARK 1
 611 #define OA_FOLDCONST 2
 612 #define OA_RETSCALAR 4
 613 #define OA_TARGET 8
 614 #define OA_TARGLEX 16
 615 #define OA_OTHERINT 32
 616 #define OA_DANGEROUS 64
 617 #define OA_DEFGV 128
 618
 619 /* The next 4 bits encode op class information */
 620 #define OCSHIFT 8
 621
 622 #define OA_CLASS_MASK (15 << OCSHIFT)
 623
 624 #define OA_BASEOP (0 << OCSHIFT)
 625 #define OA_UNOP (1 << OCSHIFT)
 626 #define OA_BINOP (2 << OCSHIFT)
 627 #define OA_LOGOP (3 << OCSHIFT)
 628 #define OA_LISTOP (4 << OCSHIFT)
 629 #define OA_PMOP (5 << OCSHIFT)
 630 #define OA_SVOP (6 << OCSHIFT)
 631 #define OA_PADOP (7 << OCSHIFT)
 632 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
 633 #define OA_LOOP (9 << OCSHIFT)
 634 #define OA_COP (10 << OCSHIFT)
 635 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
 636 #define OA_FILESTATOP (12 << OCSHIFT)
 637 #define OA_LOOPEXOP (13 << OCSHIFT)
 638
 639 #define OASHIFT 12
 640
 641 /* Remaining nybbles of PL_opargs */
 642 #define OA_SCALAR 1
 643 #define OA_LIST 2
 644 #define OA_AVREF 3
 645 #define OA_HVREF 4
 646 #define OA_CVREF 5
 647 #define OA_FILEREF 6
 648 #define OA_SCALARREF 7
 649 #define OA_OPTIONAL 8
 650
 651 /* Op_REFCNT is a reference count at the head of each op tree: needed
 652  * since the tree is shared between threads, and between cloned closure
 653  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
 654  * this count.
 655  * The same mutex is used to protect the refcounts of the reg_trie_data
 656  * and reg_ac_data structures, which are shared between duplicated
 657  * regexes.
 658  */
 659
 660 #ifdef USE_ITHREADS
 661 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
 662 #  ifdef PERL_CORE
 663 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
 664 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
 665 #  else
 666 #    define OP_REFCNT_LOCK              op_refcnt_lock()
 667 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
 668 #  endif
 669 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
 670 #else
 671 #  define OP_REFCNT_INIT                NOOP
 672 #  define OP_REFCNT_LOCK                NOOP
 673 #  define OP_REFCNT_UNLOCK              NOOP
 674 #  define OP_REFCNT_TERM                NOOP
 675 #endif
 676
 677 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
 678 #ifdef PERL_DEBUG_READONLY_OPS
 679 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
 680 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
 681 #else
 682 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
 683 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
 684 #endif
 685
 686 /* flags used by Perl_load_module() */
 687 #define PERL_LOADMOD_DENY               0x1     /* no Module */
 688 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
 689 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* use Module (...) */
 690
 691 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
 692 #define ref(o, type) doref(o, type, TRUE)
 693 #endif
 694
 695 /*
 696 =head1 Optree Manipulation Functions
 697
 698 =for apidoc Am|OP*|LINKLIST|OP *o
 699 Given the root of an optree, link the tree in execution order using the
 700 C<op_next> pointers and return the first op executed.  If this has
 701 already been done, it will not be redone, and C<< o->op_next >> will be
 702 returned.  If C<< o->op_next >> is not already set, I<o> should be at
 703 least an C<UNOP>.
 704
 705 =cut
 706 */
 707
 708 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
 709
 710 /* no longer used anywhere in core */
 711 #ifndef PERL_CORE
 712 #define cv_ckproto(cv, gv, p) \
 713    cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
 714 #endif
 715
 716 #ifdef PERL_CORE
 717 #  define my(o) my_attrs((o), NULL)
 718 #endif
 719
 720 #ifdef USE_REENTRANT_API
 721 #include "reentr.h"
 722 #endif
 723
 724 #define NewOp(m,var,c,type)     \
 725         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
 726 #define NewOpSz(m,var,size)     \
 727         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
 728 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
 729
 730 /*
 731  * The per-CV op slabs consist of a header (the opslab struct) and a bunch
 732  * of space for allocating op slots, each of which consists of two pointers
 733  * followed by an op.  The first pointer points to the next op slot.  The
 734  * second points to the slab.  At the end of the slab is a null pointer,
 735  * so that slot->opslot_next - slot can be used to determine the size
 736  * of the op.
 737  *
 738  * Each CV can have multiple slabs; opslab_next points to the next slab, to
 739  * form a chain.  All bookkeeping is done on the first slab, which is where
 740  * all the op slots point.
 741  *
 742  * Freed ops are marked as freed and attached to the freed chain
 743  * via op_next pointers.
 744  *
 745  * When there is more than one slab, the second slab in the slab chain is
 746  * assumed to be the one with free space available.  It is used when allo-
 747  * cating an op if there are no freed ops available or big enough.
 748  */
 749
 750 #ifdef PERL_CORE
 751 struct opslot {
 752     /* keep opslot_next first */
 753     OPSLOT *    opslot_next;            /* next slot */
 754     OPSLAB *    opslot_slab;            /* owner */
 755     OP          opslot_op;              /* the op itself */
 756 };
 757
 758 struct opslab {
 759     OPSLOT *    opslab_first;           /* first op in this slab */
 760     OPSLAB *    opslab_next;            /* next slab */
 761     OP *        opslab_freed;           /* chain of freed ops */
 762     size_t      opslab_refcnt;          /* number of ops */
 763 # ifdef PERL_DEBUG_READONLY_OPS
 764     U16         opslab_size;            /* size of slab in pointers */
 765     bool        opslab_readonly;
 766 # endif
 767     OPSLOT      opslab_slots;           /* slots begin here */
 768 };
 769
 770 # define OPSLOT_HEADER          STRUCT_OFFSET(OPSLOT, opslot_op)
 771 # define OPSLOT_HEADER_P        (OPSLOT_HEADER/sizeof(I32 *))
 772 # define OpSLOT(o)              (assert_(o->op_slabbed) \
 773                                  (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
 774 # define OpSLAB(o)              OpSLOT(o)->opslot_slab
 775 # define OpslabREFCNT_dec(slab)      \
 776         (((slab)->opslab_refcnt == 1) \
 777          ? opslab_free_nopad(slab)     \
 778          : (void)--(slab)->opslab_refcnt)
 779   /* Variant that does not null out the pads */
 780 # define OpslabREFCNT_dec_padok(slab) \
 781         (((slab)->opslab_refcnt == 1)  \
 782          ? opslab_free(slab)            \
 783          : (void)--(slab)->opslab_refcnt)
 784 #endif
 785
 786 struct block_hooks {
 787     U32     bhk_flags;
 788     void    (*bhk_start)        (pTHX_ int full);
 789     void    (*bhk_pre_end)      (pTHX_ OP **seq);
 790     void    (*bhk_post_end)     (pTHX_ OP **seq);
 791     void    (*bhk_eval)         (pTHX_ OP *const saveop);
 792 };
 793
 794 /*
 795 =head1 Compile-time scope hooks
 796
 797 =for apidoc mx|U32|BhkFLAGS|BHK *hk
 798 Return the BHK's flags.
 799
 800 =for apidoc mx|void *|BhkENTRY|BHK *hk|which
 801 Return an entry from the BHK structure.  I<which> is a preprocessor token
 802 indicating which entry to return.  If the appropriate flag is not set
 803 this will return NULL.  The type of the return value depends on which
 804 entry you ask for.
 805
 806 =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
 807 Set an entry in the BHK structure, and set the flags to indicate it is
 808 valid.  I<which> is a preprocessing token indicating which entry to set.
 809 The type of I<ptr> depends on the entry.
 810
 811 =for apidoc Amx|void|BhkDISABLE|BHK *hk|which
 812 Temporarily disable an entry in this BHK structure, by clearing the
 813 appropriate flag.  I<which> is a preprocessor token indicating which
 814 entry to disable.
 815
 816 =for apidoc Amx|void|BhkENABLE|BHK *hk|which
 817 Re-enable an entry in this BHK structure, by setting the appropriate
 818 flag.  I<which> is a preprocessor token indicating which entry to enable.
 819 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
 820 pointer.
 821
 822 =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
 823 Call all the registered block hooks for type I<which>.  I<which> is a
 824 preprocessing token; the type of I<arg> depends on I<which>.
 825
 826 =cut
 827 */
 828
 829 #define BhkFLAGS(hk)            ((hk)->bhk_flags)
 830
 831 #define BHKf_bhk_start      0x01
 832 #define BHKf_bhk_pre_end    0x02
 833 #define BHKf_bhk_post_end   0x04
 834 #define BHKf_bhk_eval       0x08
 835
 836 #define BhkENTRY(hk, which) \
 837     ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
 838
 839 #define BhkENABLE(hk, which) \
 840     STMT_START { \
 841         BhkFLAGS(hk) |= BHKf_ ## which; \
 842         assert(BhkENTRY(hk, which)); \
 843     } STMT_END
 844
 845 #define BhkDISABLE(hk, which) \
 846     STMT_START { \
 847         BhkFLAGS(hk) &= ~(BHKf_ ## which); \
 848     } STMT_END
 849
 850 #define BhkENTRY_set(hk, which, ptr) \
 851     STMT_START { \
 852         (hk)->which = ptr; \
 853         BhkENABLE(hk, which); \
 854     } STMT_END
 855
 856 #define CALL_BLOCK_HOOKS(which, arg) \
 857     STMT_START { \
 858         if (PL_blockhooks) { \
 859             SSize_t i; \
 860             for (i = av_tindex(PL_blockhooks); i >= 0; i--) { \
 861                 SV *sv = AvARRAY(PL_blockhooks)[i]; \
 862                 BHK *hk; \
 863                 \
 864                 assert(SvIOK(sv)); \
 865                 if (SvUOK(sv)) \
 866                     hk = INT2PTR(BHK *, SvUVX(sv)); \
 867                 else \
 868                     hk = INT2PTR(BHK *, SvIVX(sv)); \
 869                 \
 870                 if (BhkENTRY(hk, which)) \
 871                     BhkENTRY(hk, which)(aTHX_ arg); \
 872             } \
 873         } \
 874     } STMT_END
 875
 876 /* flags for rv2cv_op_cv */
 877
 878 #define RV2CVOPCV_MARK_EARLY     0x00000001
 879 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
 880
 881 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
 882
 883 /* flags for op_lvalue_flags */
 884
 885 #define OP_LVALUE_NO_CROAK 1
 886
 887 /*
 888 =head1 Custom Operators
 889
 890 =for apidoc Am|U32|XopFLAGS|XOP *xop
 891 Return the XOP's flags.
 892
 893 =for apidoc Am||XopENTRY|XOP *xop|which
 894 Return a member of the XOP structure.  I<which> is a cpp token
 895 indicating which entry to return.  If the member is not set
 896 this will return a default value.  The return type depends
 897 on I<which>.  This macro evaluates its arguments more than
 898 once.  If you are using C<Perl_custom_op_xop> to retreive a
 899 C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead.
 900
 901 =for apidoc Am||XopENTRYCUSTOM|const OP *o|which
 902 Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more
 903 efficient.  The I<which> parameter is identical to L</XopENTRY>.
 904
 905 =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
 906 Set a member of the XOP structure.  I<which> is a cpp token
 907 indicating which entry to set.  See L<perlguts/"Custom Operators">
 908 for details about the available members and how
 909 they are used.  This macro evaluates its argument
 910 more than once.
 911
 912 =for apidoc Am|void|XopDISABLE|XOP *xop|which
 913 Temporarily disable a member of the XOP, by clearing the appropriate flag.
 914
 915 =for apidoc Am|void|XopENABLE|XOP *xop|which
 916 Reenable a member of the XOP which has been disabled.
 917
 918 =cut
 919 */
 920
 921 struct custom_op {
 922     U32             xop_flags;
 923     const char     *xop_name;
 924     const char     *xop_desc;
 925     U32             xop_class;
 926     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
 927 };
 928
 929 /* return value of Perl_custom_op_get_field, similar to void * then casting but
 930    the U32 doesn't need truncation on 64 bit platforms in the caller, also
 931    for easier macro writing */
 932 typedef union {
 933     const char     *xop_name;
 934     const char     *xop_desc;
 935     U32             xop_class;
 936     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
 937     XOP            *xop_ptr;
 938 } XOPRETANY;
 939
 940 #define XopFLAGS(xop) ((xop)->xop_flags)
 941
 942 #define XOPf_xop_name   0x01
 943 #define XOPf_xop_desc   0x02
 944 #define XOPf_xop_class  0x04
 945 #define XOPf_xop_peep   0x08
 946
 947 /* used by Perl_custom_op_get_field for option checking */
 948 typedef enum {
 949     XOPe_xop_ptr = 0, /* just get the XOP *, don't look inside it */
 950     XOPe_xop_name = XOPf_xop_name,
 951     XOPe_xop_desc = XOPf_xop_desc,
 952     XOPe_xop_class = XOPf_xop_class,
 953     XOPe_xop_peep = XOPf_xop_peep
 954 } xop_flags_enum;
 955
 956 #define XOPd_xop_name   PL_op_name[OP_CUSTOM]
 957 #define XOPd_xop_desc   PL_op_desc[OP_CUSTOM]
 958 #define XOPd_xop_class  OA_BASEOP
 959 #define XOPd_xop_peep   ((Perl_cpeep_t)0)
 960
 961 #define XopENTRY_set(xop, which, to) \
 962     STMT_START { \
 963         (xop)->which = (to); \
 964         (xop)->xop_flags |= XOPf_ ## which; \
 965     } STMT_END
 966
 967 #define XopENTRY(xop, which) \
 968     ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
 969
 970 #define XopENTRYCUSTOM(o, which) \
 971     (Perl_custom_op_get_field(aTHX_ o, XOPe_ ## which).which)
 972
 973 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
 974 #define XopENABLE(xop, which) \
 975     STMT_START { \
 976         (xop)->xop_flags |= XOPf_ ## which; \
 977         assert(XopENTRY(xop, which)); \
 978     } STMT_END
 979
 980 #define Perl_custom_op_xop(x) \
 981     (Perl_custom_op_get_field(x, XOPe_xop_ptr).xop_ptr)
 982
 983 /*
 984 =head1 Optree Manipulation Functions
 985
 986 =for apidoc Am|const char *|OP_NAME|OP *o
 987 Return the name of the provided OP.  For core ops this looks up the name
 988 from the op_type; for custom ops from the op_ppaddr.
 989
 990 =for apidoc Am|const char *|OP_DESC|OP *o
 991 Return a short description of the provided OP.
 992
 993 =for apidoc Am|U32|OP_CLASS|OP *o
 994 Return the class of the provided OP: that is, which of the *OP
 995 structures it uses.  For core ops this currently gets the information out
 996 of PL_opargs, which does not always accurately reflect the type used.
 997 For custom ops the type is returned from the registration, and it is up
 998 to the registree to ensure it is accurate.  The value returned will be
 999 one of the OA_* constants from op.h.
1000
1001 =for apidoc Am|bool|OP_TYPE_IS|OP *o, Optype type
1002 Returns true if the given OP is not a NULL pointer
1003 and if it is of the given type.
1004
1005 The negation of this macro, C<OP_TYPE_ISNT> is also available
1006 as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide
1007 the NULL pointer check.
1008
1009 =for apidoc Am|bool|OP_TYPE_IS_OR_WAS|OP *o, Optype type
1010 Returns true if the given OP is not a NULL pointer and
1011 if it is of the given type or used to be before being
1012 replaced by an OP of type OP_NULL.
1013
1014 The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT>
1015 is also available as well as C<OP_TYPE_IS_OR_WAS_NN>
1016 and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide
1017 the NULL pointer check.
1018
1019 =cut
1020 */
1021
1022 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
1023                     ? XopENTRYCUSTOM(o, xop_name) \
1024                     : PL_op_name[(o)->op_type])
1025 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
1026                     ? XopENTRYCUSTOM(o, xop_desc) \
1027                     : PL_op_desc[(o)->op_type])
1028 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
1029                      ? XopENTRYCUSTOM(o, xop_class) \
1030                      : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
1031
1032 #define OP_TYPE_IS(o, type) ((o) && (o)->op_type == (type))
1033 #define OP_TYPE_IS_NN(o, type) ((o)->op_type == (type))
1034 #define OP_TYPE_ISNT(o, type) ((o) && (o)->op_type != (type))
1035 #define OP_TYPE_ISNT_NN(o, type) ((o)->op_type != (type))
1036
1037 #define OP_TYPE_IS_OR_WAS_NN(o, type) \
1038     ( ((o)->op_type == OP_NULL \
1039        ? (o)->op_targ \
1040        : (o)->op_type) \
1041       == (type) )
1042
1043 #define OP_TYPE_IS_OR_WAS(o, type) \
1044     ( (o) && OP_TYPE_IS_OR_WAS_NN(o, type) )
1045
1046 #define OP_TYPE_ISNT_AND_WASNT_NN(o, type) \
1047     ( ((o)->op_type == OP_NULL \
1048        ? (o)->op_targ \
1049        : (o)->op_type) \
1050       != (type) )
1051
1052 #define OP_TYPE_ISNT_AND_WASNT(o, type) \
1053     ( (o) && OP_TYPE_ISNT_AND_WASNT_NN(o, type) )
1054
1055 #define newATTRSUB(f, o, p, a, b) Perl_newATTRSUB_x(aTHX_  f, o, p, a, b, FALSE)
1056 #define newSUB(f, o, p, b)      newATTRSUB((f), (o), (p), NULL, (b))
1057
1058 /*
1059 =head1 Hook manipulation
1060 */
1061
1062 #ifdef USE_ITHREADS
1063 #  define OP_CHECK_MUTEX_INIT           MUTEX_INIT(&PL_check_mutex)
1064 #  define OP_CHECK_MUTEX_LOCK           MUTEX_LOCK(&PL_check_mutex)
1065 #  define OP_CHECK_MUTEX_UNLOCK         MUTEX_UNLOCK(&PL_check_mutex)
1066 #  define OP_CHECK_MUTEX_TERM           MUTEX_DESTROY(&PL_check_mutex)
1067 #else
1068 #  define OP_CHECK_MUTEX_INIT           NOOP
1069 #  define OP_CHECK_MUTEX_LOCK           NOOP
1070 #  define OP_CHECK_MUTEX_UNLOCK         NOOP
1071 #  define OP_CHECK_MUTEX_TERM           NOOP
1072 #endif
1073
1074 /*
1075  * Local variables:
1076  * c-indentation-style: bsd
1077  * c-basic-offset: 4
1078  * indent-tabs-mode: nil
1079  * End:
1080  *
1081  * ex: set ts=8 sts=4 sw=4 et:
1082  */