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
 233   /* OP_SUBSTR only */
 234 #define OPpSUBSTR_REPL_FIRST    16      /* 1st arg is replacement string */
 235
 236   /* OP_PADSV only */
 237 #define OPpPAD_STATE            16      /* is a "state" pad */
 238   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
 239
 240   /* OP_RV2GV only */
 241 #define OPpDONT_INIT_GV         4       /* Call gv_fetchpv with GV_NOINIT */
 242 /* (Therefore will return whatever is currently in the symbol table, not
 243    guaranteed to be a PVGV)  */
 244
 245 /* Private for OP_ENTERITER and OP_ITER */
 246 #define OPpITER_REVERSED        4       /* for (reverse ...) */
 247 #define OPpITER_DEF             8       /* for $_ or for my $_ */
 248
 249 /* Private for OP_CONST */
 250 #define OPpCONST_NOVER          2       /* no 6; */
 251 #define OPpCONST_SHORTCIRCUIT   4       /* eg the constant 5 in (5 || foo) */
 252 #define OPpCONST_STRICT         8       /* bareword subject to strict 'subs' */
 253 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
 254 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
 255 #define OPpCONST_WARNING        128     /* Was a $^W translated to constant. */
 256
 257 /* Private for OP_FLIP/FLOP */
 258 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
 259
 260 /* Private for OP_LIST */
 261 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
 262
 263 /* Private for OP_DELETE */
 264 #define OPpSLICE                64      /* Operating on a list of keys */
 265 /* Also OPpLVAL_INTRO (128) */
 266
 267 /* Private for OP_EXISTS */
 268 #define OPpEXISTS_SUB           64      /* Checking for &sub, not {} or [].  */
 269
 270 /* Private for OP_SORT */
 271 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
 272 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
 273 #define OPpSORT_REVERSE         4       /* Reversed sort */
 274 #define OPpSORT_INPLACE         8       /* sort in-place; eg @a = sort @a */
 275 #define OPpSORT_DESCEND         16      /* Descending sort */
 276 #define OPpSORT_QSORT           32      /* Use quicksort (not mergesort) */
 277 #define OPpSORT_STABLE          64      /* Use a stable algorithm */
 278
 279 /* Private for OP_REVERSE */
 280 #define OPpREVERSE_INPLACE      8       /* reverse in-place (@a = reverse @a) */
 281
 282 /* Private for OP_OPEN and OP_BACKTICK */
 283 #define OPpOPEN_IN_RAW          16      /* binmode(F,":raw") on input fh */
 284 #define OPpOPEN_IN_CRLF         32      /* binmode(F,":crlf") on input fh */
 285 #define OPpOPEN_OUT_RAW         64      /* binmode(F,":raw") on output fh */
 286 #define OPpOPEN_OUT_CRLF        128     /* binmode(F,":crlf") on output fh */
 287
 288 /* Private for OP_EXIT, HUSH also for OP_DIE */
 289 #define OPpHUSH_VMSISH          64      /* hush DCL exit msg vmsish mode*/
 290 #define OPpEXIT_VMSISH          128     /* exit(0) vs. exit(1) vmsish mode*/
 291
 292 /* Private for OP_FTXXX */
 293 #define OPpFT_ACCESS            2       /* use filetest 'access' */
 294 #define OPpFT_STACKED           4       /* stacked filetest, as "-f" in "-f -x $f" */
 295 #define OPpFT_STACKING          8       /* stacking filetest, as "-x" in "-f -x $f" */
 296
 297 /* Private for OP_(MAP|GREP)(WHILE|START) */
 298 #define OPpGREP_LEX             2       /* iterate over lexical $_ */
 299
 300 /* Private for OP_ENTEREVAL */
 301 #define OPpEVAL_HAS_HH          2       /* Does it have a copy of %^H */
 302 #define OPpEVAL_UNICODE         4
 303 #define OPpEVAL_BYTES           8
 304 #define OPpEVAL_COPHH           16      /* Construct %^H from cop hints */
 305
 306 /* Private for OP_CALLER, OP_WANTARRAY and OP_RUNCV */
 307 #define OPpOFFBYONE             128     /* Treat caller(1) as caller(2) */
 308
 309 /* Private for OP_COREARGS */
 310 /* These must not conflict with OPpDONT_INIT_GV.  See pp.c:S_rv2gv. */
 311 #define OPpCOREARGS_DEREF1      1       /* Arg 1 is a handle constructor */
 312 #define OPpCOREARGS_DEREF2      2       /* Arg 2 is a handle constructor */
 313 #define OPpCOREARGS_SCALARMOD   64      /* \$ rather than \[$@%*] */
 314 #define OPpCOREARGS_PUSHMARK    128     /* Call pp_pushmark */
 315
 316 struct op {
 317     BASEOP
 318 };
 319
 320 struct unop {
 321     BASEOP
 322     OP *        op_first;
 323 };
 324
 325 struct binop {
 326     BASEOP
 327     OP *        op_first;
 328     OP *        op_last;
 329 };
 330
 331 struct logop {
 332     BASEOP
 333     OP *        op_first;
 334     OP *        op_other;
 335 };
 336
 337 struct listop {
 338     BASEOP
 339     OP *        op_first;
 340     OP *        op_last;
 341 };
 342
 343 struct pmop {
 344     BASEOP
 345     OP *        op_first;
 346     OP *        op_last;
 347 #ifdef USE_ITHREADS
 348     IV          op_pmoffset;
 349 #else
 350     REGEXP *    op_pmregexp;            /* compiled expression */
 351 #endif
 352     U32         op_pmflags;
 353     union {
 354         OP *    op_pmreplroot;          /* For OP_SUBST */
 355 #ifdef USE_ITHREADS
 356         PADOFFSET  op_pmtargetoff;      /* For OP_PUSHRE */
 357 #else
 358         GV *    op_pmtargetgv;
 359 #endif
 360     }   op_pmreplrootu;
 361     union {
 362         OP *    op_pmreplstart; /* Only used in OP_SUBST */
 363 #ifdef USE_ITHREADS
 364         struct {
 365             char *      op_pmstashpv;   /* Only used in OP_MATCH, with PMf_ONCE set */
 366             U32     op_pmstashflags;  /* currently only SVf_UTF8 or 0 */
 367         } op_pmstashthr;
 368 #else
 369         HV *    op_pmstash;
 370 #endif
 371     }           op_pmstashstartu;
 372 };
 373
 374 #ifdef USE_ITHREADS
 375 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
 376                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
 377 /* The assignment is just to enforce type safety (or at least get a warning).
 378  */
 379 /* With first class regexps not via a reference one needs to assign
 380    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
 381    is cheaper. I guess we could allow NULL, but the check above would get
 382    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
 383 /* BEWARE - something that calls this macro passes (r) which has a side
 384    effect.  */
 385 #define PM_SETRE(o,r)   STMT_START {                                    \
 386                             REGEXP *const _pm_setre = (r);              \
 387                             assert(_pm_setre);                          \
 388                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
 389                         } STMT_END
 390 #else
 391 #define PM_GETRE(o)     ((o)->op_pmregexp)
 392 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
 393 #endif
 394
 395 /* Leave some space, so future bit allocations can go either in the shared or
 396  * unshared area without affecting binary compatibility */
 397 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+6)
 398
 399 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
 400 #define PMf_RETAINT     (1<<(PMf_BASE_SHIFT+0))
 401
 402 /* match successfully only once per reset, with related flag RXf_USED in
 403  * re->extflags holding state.  This is used only for ?? matches, and only on
 404  * OP_MATCH and OP_QR */
 405 #define PMf_ONCE        (1<<(PMf_BASE_SHIFT+1))
 406
 407 /* replacement contains variables */
 408 #define PMf_MAYBE_CONST (1<<(PMf_BASE_SHIFT+2))
 409
 410 /* PMf_ONCE has matched successfully.  Not used under threading. */
 411 #define PMf_USED        (1<<(PMf_BASE_SHIFT+3))
 412
 413 /* subst replacement is constant */
 414 #define PMf_CONST       (1<<(PMf_BASE_SHIFT+4))
 415
 416 /* keep 1st runtime pattern forever */
 417 #define PMf_KEEP        (1<<(PMf_BASE_SHIFT+5))
 418
 419 #define PMf_GLOBAL      (1<<(PMf_BASE_SHIFT+6)) /* pattern had a g modifier */
 420
 421 /* don't reset pos() if //g fails */
 422 #define PMf_CONTINUE    (1<<(PMf_BASE_SHIFT+7))
 423
 424 /* evaluating replacement as expr */
 425 #define PMf_EVAL        (1<<(PMf_BASE_SHIFT+8))
 426
 427 /* Return substituted string instead of modifying it. */
 428 #define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+9))
 429
 430 #if PMf_BASE_SHIFT+9 > 31
 431 #   error Too many PMf_ bits used.  See above and regnodes.h for any spare in middle
 432 #endif
 433
 434 #ifdef USE_ITHREADS
 435
 436 #  define PmopSTASHPV(o)                                                \
 437     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstashthr.op_pmstashpv : NULL)
 438 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 439 #    define PmopSTASHPV_set(o,pv)       ({                              \
 440         assert((o)->op_pmflags & PMf_ONCE);                             \
 441         ((o)->op_pmstashstartu.op_pmstashthr.op_pmstashpv = savesharedpv(pv));  \
 442     })
 443 #  else
 444 #    define PmopSTASHPV_set(o,pv)                                       \
 445     ((o)->op_pmstashstartu.op_pmstashthr.op_pmstashpv = savesharedpv(pv))
 446 #  endif
 447 #  define PmopSTASH_flags(o)           ((o)->op_pmstashstartu.op_pmstashthr.op_pmstashflags)
 448 #  define PmopSTASH_flags_set(o,flags) ((o)->op_pmstashstartu.op_pmstashthr.op_pmstashflags = flags)
 449 #  define PmopSTASH(o)         (PmopSTASHPV(o)                                     \
 450                                 ? gv_stashpv((o)->op_pmstashstartu.op_pmstashthr.op_pmstashpv,   \
 451                                             GV_ADD | PmopSTASH_flags(o)) : NULL)
 452 #  define PmopSTASH_set(o,hv)  (PmopSTASHPV_set(o, (hv) ? HvNAME_get(hv) : NULL), \
 453                                 PmopSTASH_flags_set(o,                            \
 454                                             ((hv) && HvNAME_HEK(hv) &&           \
 455                                                         HvNAMEUTF8(hv))           \
 456                                                 ? SVf_UTF8                        \
 457                                                 : 0))
 458 #  define PmopSTASH_free(o)     PerlMemShared_free(PmopSTASHPV(o))
 459
 460 #else
 461 #  define PmopSTASH(o)                                                  \
 462     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
 463 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 464 #    define PmopSTASH_set(o,hv)         ({                              \
 465         assert((o)->op_pmflags & PMf_ONCE);                             \
 466         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
 467     })
 468 #  else
 469 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
 470 #  endif
 471 #  define PmopSTASHPV(o)        (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
 472    /* op_pmstashstartu.op_pmstash is not refcounted */
 473 #  define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
 474 /* Note that if this becomes non-empty, then S_forget_pmop in op.c will need
 475    changing */
 476 #  define PmopSTASH_free(o)
 477 #endif
 478
 479 struct svop {
 480     BASEOP
 481     SV *        op_sv;
 482 };
 483
 484 struct padop {
 485     BASEOP
 486     PADOFFSET   op_padix;
 487 };
 488
 489 struct pvop {
 490     BASEOP
 491     char *      op_pv;
 492 };
 493
 494 struct loop {
 495     BASEOP
 496     OP *        op_first;
 497     OP *        op_last;
 498     OP *        op_redoop;
 499     OP *        op_nextop;
 500     OP *        op_lastop;
 501 };
 502
 503 #define cUNOPx(o)       ((UNOP*)o)
 504 #define cBINOPx(o)      ((BINOP*)o)
 505 #define cLISTOPx(o)     ((LISTOP*)o)
 506 #define cLOGOPx(o)      ((LOGOP*)o)
 507 #define cPMOPx(o)       ((PMOP*)o)
 508 #define cSVOPx(o)       ((SVOP*)o)
 509 #define cPADOPx(o)      ((PADOP*)o)
 510 #define cPVOPx(o)       ((PVOP*)o)
 511 #define cCOPx(o)        ((COP*)o)
 512 #define cLOOPx(o)       ((LOOP*)o)
 513
 514 #define cUNOP           cUNOPx(PL_op)
 515 #define cBINOP          cBINOPx(PL_op)
 516 #define cLISTOP         cLISTOPx(PL_op)
 517 #define cLOGOP          cLOGOPx(PL_op)
 518 #define cPMOP           cPMOPx(PL_op)
 519 #define cSVOP           cSVOPx(PL_op)
 520 #define cPADOP          cPADOPx(PL_op)
 521 #define cPVOP           cPVOPx(PL_op)
 522 #define cCOP            cCOPx(PL_op)
 523 #define cLOOP           cLOOPx(PL_op)
 524
 525 #define cUNOPo          cUNOPx(o)
 526 #define cBINOPo         cBINOPx(o)
 527 #define cLISTOPo        cLISTOPx(o)
 528 #define cLOGOPo         cLOGOPx(o)
 529 #define cPMOPo          cPMOPx(o)
 530 #define cSVOPo          cSVOPx(o)
 531 #define cPADOPo         cPADOPx(o)
 532 #define cPVOPo          cPVOPx(o)
 533 #define cCOPo           cCOPx(o)
 534 #define cLOOPo          cLOOPx(o)
 535
 536 #define kUNOP           cUNOPx(kid)
 537 #define kBINOP          cBINOPx(kid)
 538 #define kLISTOP         cLISTOPx(kid)
 539 #define kLOGOP          cLOGOPx(kid)
 540 #define kPMOP           cPMOPx(kid)
 541 #define kSVOP           cSVOPx(kid)
 542 #define kPADOP          cPADOPx(kid)
 543 #define kPVOP           cPVOPx(kid)
 544 #define kCOP            cCOPx(kid)
 545 #define kLOOP           cLOOPx(kid)
 546
 547
 548 #ifdef USE_ITHREADS
 549 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
 550 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
 551                                  && GvIN_PAD(v))
 552 #  define       IS_PADCONST(v)  (v && SvREADONLY(v))
 553 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
 554                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
 555 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
 556                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
 557 #else
 558 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
 559 #  define       IS_PADGV(v)     FALSE
 560 #  define       IS_PADCONST(v)  FALSE
 561 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
 562 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
 563 #endif
 564
 565 #define cGVOP_gv                cGVOPx_gv(PL_op)
 566 #define cGVOPo_gv               cGVOPx_gv(o)
 567 #define kGVOP_gv                cGVOPx_gv(kid)
 568 #define cSVOP_sv                cSVOPx_sv(PL_op)
 569 #define cSVOPo_sv               cSVOPx_sv(o)
 570 #define kSVOP_sv                cSVOPx_sv(kid)
 571
 572 #ifndef PERL_CORE
 573 #  define Nullop ((OP*)NULL)
 574 #endif
 575
 576 /* Lowest byte of PL_opargs */
 577 #define OA_MARK 1
 578 #define OA_FOLDCONST 2
 579 #define OA_RETSCALAR 4
 580 #define OA_TARGET 8
 581 #define OA_TARGLEX 16
 582 #define OA_OTHERINT 32
 583 #define OA_DANGEROUS 64
 584 #define OA_DEFGV 128
 585
 586 /* The next 4 bits encode op class information */
 587 #define OCSHIFT 8
 588
 589 #define OA_CLASS_MASK (15 << OCSHIFT)
 590
 591 #define OA_BASEOP (0 << OCSHIFT)
 592 #define OA_UNOP (1 << OCSHIFT)
 593 #define OA_BINOP (2 << OCSHIFT)
 594 #define OA_LOGOP (3 << OCSHIFT)
 595 #define OA_LISTOP (4 << OCSHIFT)
 596 #define OA_PMOP (5 << OCSHIFT)
 597 #define OA_SVOP (6 << OCSHIFT)
 598 #define OA_PADOP (7 << OCSHIFT)
 599 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
 600 #define OA_LOOP (9 << OCSHIFT)
 601 #define OA_COP (10 << OCSHIFT)
 602 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
 603 #define OA_FILESTATOP (12 << OCSHIFT)
 604 #define OA_LOOPEXOP (13 << OCSHIFT)
 605
 606 #define OASHIFT 12
 607
 608 /* Remaining nybbles of PL_opargs */
 609 #define OA_SCALAR 1
 610 #define OA_LIST 2
 611 #define OA_AVREF 3
 612 #define OA_HVREF 4
 613 #define OA_CVREF 5
 614 #define OA_FILEREF 6
 615 #define OA_SCALARREF 7
 616 #define OA_OPTIONAL 8
 617
 618 /* Op_REFCNT is a reference count at the head of each op tree: needed
 619  * since the tree is shared between threads, and between cloned closure
 620  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
 621  * this count.
 622  * The same mutex is used to protect the refcounts of the reg_trie_data
 623  * and reg_ac_data structures, which are shared between duplicated
 624  * regexes.
 625  */
 626
 627 #ifdef USE_ITHREADS
 628 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
 629 #  ifdef PERL_CORE
 630 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
 631 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
 632 #  else
 633 #    define OP_REFCNT_LOCK              op_refcnt_lock()
 634 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
 635 #  endif
 636 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
 637 #else
 638 #  define OP_REFCNT_INIT                NOOP
 639 #  define OP_REFCNT_LOCK                NOOP
 640 #  define OP_REFCNT_UNLOCK              NOOP
 641 #  define OP_REFCNT_TERM                NOOP
 642 #endif
 643
 644 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
 645 #ifdef PERL_DEBUG_READONLY_OPS
 646 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
 647 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
 648 #else
 649 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
 650 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
 651 #endif
 652
 653 /* flags used by Perl_load_module() */
 654 #define PERL_LOADMOD_DENY               0x1     /* no Module */
 655 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
 656 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* use Module (...) */
 657
 658 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
 659 #define ref(o, type) doref(o, type, TRUE)
 660 #endif
 661
 662 /*
 663 =head1 Optree Manipulation Functions
 664
 665 =for apidoc Am|OP*|LINKLIST|OP *o
 666 Given the root of an optree, link the tree in execution order using the
 667 C<op_next> pointers and return the first op executed. If this has
 668 already been done, it will not be redone, and C<< o->op_next >> will be
 669 returned. If C<< o->op_next >> is not already set, I<o> should be at
 670 least an C<UNOP>.
 671
 672 =cut
 673 */
 674
 675 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
 676
 677 /* no longer used anywhere in core */
 678 #ifndef PERL_CORE
 679 #define cv_ckproto(cv, gv, p) \
 680    cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
 681 #endif
 682
 683 #ifdef PERL_CORE
 684 #  define my(o) my_attrs((o), NULL)
 685 #endif
 686
 687 #ifdef USE_REENTRANT_API
 688 #include "reentr.h"
 689 #endif
 690
 691 #if defined(PL_OP_SLAB_ALLOC)
 692 #define NewOp(m,var,c,type)     \
 693         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
 694 #define NewOpSz(m,var,size)     \
 695         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
 696 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
 697 #else
 698 #define NewOp(m, var, c, type)  \
 699         (var = (MEM_WRAP_CHECK_(c,type) \
 700          (type*)PerlMemShared_calloc(c, sizeof(type))))
 701 #define NewOpSz(m, var, size)   \
 702         (var = (OP*)PerlMemShared_calloc(1, size))
 703 #define FreeOp(p) PerlMemShared_free(p)
 704 #endif
 705
 706 struct block_hooks {
 707     U32     bhk_flags;
 708     void    (*bhk_start)        (pTHX_ int full);
 709     void    (*bhk_pre_end)      (pTHX_ OP **seq);
 710     void    (*bhk_post_end)     (pTHX_ OP **seq);
 711     void    (*bhk_eval)         (pTHX_ OP *const saveop);
 712 };
 713
 714 /*
 715 =head1 Compile-time scope hooks
 716
 717 =for apidoc mx|U32|BhkFLAGS|BHK *hk
 718 Return the BHK's flags.
 719
 720 =for apidoc mx|void *|BhkENTRY|BHK *hk|which
 721 Return an entry from the BHK structure. I<which> is a preprocessor token
 722 indicating which entry to return. If the appropriate flag is not set
 723 this will return NULL. The type of the return value depends on which
 724 entry you ask for.
 725
 726 =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
 727 Set an entry in the BHK structure, and set the flags to indicate it is
 728 valid. I<which> is a preprocessing token indicating which entry to set.
 729 The type of I<ptr> depends on the entry.
 730
 731 =for apidoc Amx|void|BhkDISABLE|BHK *hk|which
 732 Temporarily disable an entry in this BHK structure, by clearing the
 733 appropriate flag. I<which> is a preprocessor token indicating which
 734 entry to disable.
 735
 736 =for apidoc Amx|void|BhkENABLE|BHK *hk|which
 737 Re-enable an entry in this BHK structure, by setting the appropriate
 738 flag. I<which> is a preprocessor token indicating which entry to enable.
 739 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
 740 pointer.
 741
 742 =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
 743 Call all the registered block hooks for type I<which>. I<which> is a
 744 preprocessing token; the type of I<arg> depends on I<which>.
 745
 746 =cut
 747 */
 748
 749 #define BhkFLAGS(hk)            ((hk)->bhk_flags)
 750
 751 #define BHKf_bhk_start      0x01
 752 #define BHKf_bhk_pre_end    0x02
 753 #define BHKf_bhk_post_end   0x04
 754 #define BHKf_bhk_eval       0x08
 755
 756 #define BhkENTRY(hk, which) \
 757     ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
 758
 759 #define BhkENABLE(hk, which) \
 760     STMT_START { \
 761         BhkFLAGS(hk) |= BHKf_ ## which; \
 762         assert(BhkENTRY(hk, which)); \
 763     } STMT_END
 764
 765 #define BhkDISABLE(hk, which) \
 766     STMT_START { \
 767         BhkFLAGS(hk) &= ~(BHKf_ ## which); \
 768     } STMT_END
 769
 770 #define BhkENTRY_set(hk, which, ptr) \
 771     STMT_START { \
 772         (hk)->which = ptr; \
 773         BhkENABLE(hk, which); \
 774     } STMT_END
 775
 776 #define CALL_BLOCK_HOOKS(which, arg) \
 777     STMT_START { \
 778         if (PL_blockhooks) { \
 779             I32 i; \
 780             for (i = av_len(PL_blockhooks); i >= 0; i--) { \
 781                 SV *sv = AvARRAY(PL_blockhooks)[i]; \
 782                 BHK *hk; \
 783                 \
 784                 assert(SvIOK(sv)); \
 785                 if (SvUOK(sv)) \
 786                     hk = INT2PTR(BHK *, SvUVX(sv)); \
 787                 else \
 788                     hk = INT2PTR(BHK *, SvIVX(sv)); \
 789                 \
 790                 if (BhkENTRY(hk, which)) \
 791                     BhkENTRY(hk, which)(aTHX_ arg); \
 792             } \
 793         } \
 794     } STMT_END
 795
 796 /* flags for rv2cv_op_cv */
 797
 798 #define RV2CVOPCV_MARK_EARLY     0x00000001
 799 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
 800
 801 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
 802
 803 /* flags for op_lvalue_flags */
 804
 805 #define OP_LVALUE_NO_CROAK 1
 806
 807 /*
 808 =head1 Custom Operators
 809
 810 =for apidoc Am|U32|XopFLAGS|XOP *xop
 811 Return the XOP's flags.
 812
 813 =for apidoc Am||XopENTRY|XOP *xop|which
 814 Return a member of the XOP structure. I<which> is a cpp token indicating
 815 which entry to return. If the member is not set this will return a
 816 default value. The return type depends on I<which>.
 817
 818 =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
 819 Set a member of the XOP structure. I<which> is a cpp token indicating
 820 which entry to set. See L<perlguts/"Custom Operators"> for details about
 821 the available members and how they are used.
 822
 823 =for apidoc Am|void|XopDISABLE|XOP *xop|which
 824 Temporarily disable a member of the XOP, by clearing the appropriate flag.
 825
 826 =for apidoc Am|void|XopENABLE|XOP *xop|which
 827 Reenable a member of the XOP which has been disabled.
 828
 829 =cut
 830 */
 831
 832 struct custom_op {
 833     U32             xop_flags;
 834     const char     *xop_name;
 835     const char     *xop_desc;
 836     U32             xop_class;
 837     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
 838 };
 839
 840 #define XopFLAGS(xop) ((xop)->xop_flags)
 841
 842 #define XOPf_xop_name   0x01
 843 #define XOPf_xop_desc   0x02
 844 #define XOPf_xop_class  0x04
 845 #define XOPf_xop_peep   0x08
 846
 847 #define XOPd_xop_name   PL_op_name[OP_CUSTOM]
 848 #define XOPd_xop_desc   PL_op_desc[OP_CUSTOM]
 849 #define XOPd_xop_class  OA_BASEOP
 850 #define XOPd_xop_peep   ((Perl_cpeep_t)0)
 851
 852 #define XopENTRY_set(xop, which, to) \
 853     STMT_START { \
 854         (xop)->which = (to); \
 855         (xop)->xop_flags |= XOPf_ ## which; \
 856     } STMT_END
 857
 858 #define XopENTRY(xop, which) \
 859     ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
 860
 861 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
 862 #define XopENABLE(xop, which) \
 863     STMT_START { \
 864         (xop)->xop_flags |= XOPf_ ## which; \
 865         assert(XopENTRY(xop, which)); \
 866     } STMT_END
 867
 868 /*
 869 =head1 Optree Manipulation Functions
 870
 871 =for apidoc Am|const char *|OP_NAME|OP *o
 872 Return the name of the provided OP. For core ops this looks up the name
 873 from the op_type; for custom ops from the op_ppaddr.
 874
 875 =for apidoc Am|const char *|OP_DESC|OP *o
 876 Return a short description of the provided OP.
 877
 878 =for apidoc Am|U32|OP_CLASS|OP *o
 879 Return the class of the provided OP: that is, which of the *OP
 880 structures it uses. For core ops this currently gets the information out
 881 of PL_opargs, which does not always accurately reflect the type used.
 882 For custom ops the type is returned from the registration, and it is up
 883 to the registree to ensure it is accurate. The value returned will be
 884 one of the OA_* constants from op.h.
 885
 886 =cut
 887 */
 888
 889 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
 890                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_name) \
 891                     : PL_op_name[(o)->op_type])
 892 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
 893                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_desc) \
 894                     : PL_op_desc[(o)->op_type])
 895 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
 896                      ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_class) \
 897                      : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
 898
 899 #define newSUB(f, o, p, b)      Perl_newATTRSUB(aTHX_ (f), (o), (p), NULL, (b))
 900
 901 #ifdef PERL_MAD
 902 #  define MAD_NULL 1
 903 #  define MAD_PV 2
 904 #  define MAD_OP 3
 905 #  define MAD_SV 4
 906
 907 struct madprop {
 908     MADPROP* mad_next;
 909     void *mad_val;
 910     U32 mad_vlen;
 911 /*    short mad_count; */
 912     char mad_key;
 913     char mad_type;
 914 };
 915
 916 struct token {
 917     I32 tk_type;
 918     YYSTYPE tk_lval;
 919     MADPROP* tk_mad;
 920 };
 921 #endif
 922
 923 /*
 924  * Values that can be held by mad_key :
 925  * ^       unfilled head spot
 926  * ,       literal ,
 927  * ;       literal ; (blank if implicit ; at end of block)
 928  * :       literal : from ?: or attr list
 929  * +       unary +
 930  * ?       literal ? from ?:
 931  * (       literal (
 932  * )       literal )
 933  * [       literal [
 934  * ]       literal ]
 935  * {       literal {
 936  * }       literal }
 937  * @       literal @ sigil
 938  * $       literal $ sigil
 939  * *       literal * sigil
 940  * !       use is source filtered
 941  * &       & or sub
 942  * #       whitespace/comment following ; or }
 943  * #       $# sigil
 944  * 1       1st ; from for(;;)
 945  * 1       retired protasis
 946  * 2       2nd ; from for(;;)
 947  * 2       retired apodosis
 948  * 3       C-style for list
 949  * a       sub or var attributes
 950  * a       non-method arrow operator
 951  * A       method arrow operator
 952  * A       use import args
 953  * b       format block
 954  * B       retired stub block
 955  * C       constant conditional op
 956  * d       declarator
 957  * D       do block
 958  * e       unreached "else" (see C)
 959  * e       expression producing E
 960  * E       tr/E/R/, /E/
 961  * f       folded constant op
 962  * F       peg op for format
 963  * g       op was forced to be a word
 964  * i       if/unless modifier
 965  * I       if/elsif/unless statement
 966  * k       local declarator
 967  * K       retired kid op
 968  * l       last index of array ($#foo)
 969  * L       label
 970  * m       modifier on regex
 971  * n       sub or format name
 972  * o       current operator/declarator name
 973  * o       else/continue
 974  * O       generic optimized op
 975  * p       peg to hold extra whitespace at statement level
 976  * P       peg op for package declaration
 977  * q       opening quote
 978  * =       quoted material
 979  * Q       closing quote
 980  * Q       optimized qw//
 981  * r       expression producing R
 982  * R       tr/E/R/ s/E/R/
 983  * s       sub signature
 984  * S       use import stub (no import)
 985  * S       retired sort block
 986  * t       unreached "then" (see C)
 987  * U       use import op
 988  * v       private sv of for loop
 989  * V       use version
 990  * w       while/until modifier
 991  * W       while/for statement
 992  * x       optimized qw
 993  * X       random thing
 994  * _       whitespace/comments preceding anything else
 995  * ~       =~ operator
 996  */
 997
 998 /*
 999  * Local variables:
1000  * c-indentation-style: bsd
1001  * c-basic-offset: 4
1002  * indent-tabs-mode: t
1003  * End:
1004  *
1005  * ex: set ts=8 sts=4 sw=4 noet:
1006  */