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