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