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, use Perl glob function */
 147
 148 /* old names; don't use in new code, but don't break them, either */
 149 #define OPf_LIST        OPf_WANT_LIST
 150 #define OPf_KNOW        OPf_WANT
 151
 152 #define GIMME \
 153           (PL_op->op_flags & OPf_WANT                                   \
 154            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
 155               ? G_ARRAY                                                 \
 156               : G_SCALAR)                                               \
 157            : dowantarray())
 158
 159 /* Lower bits of op_private often carry the number of arguments, as
 160  * set by newBINOP, newUNOP and ck_fun */
 161
 162 /* NOTE: OP_NEXTSTATE and OP_DBSTATE (i.e. COPs) carry lower
 163  * bits of PL_hints in op_private */
 164
 165 /* Private for lvalues */
 166 #define OPpLVAL_INTRO   128     /* Lvalue must be localized or lvalue sub */
 167
 168 /* Private for OPs with TARGLEX */
 169   /* (lower bits may carry MAXARG) */
 170 #define OPpTARGET_MY            16      /* Target is PADMY. */
 171
 172 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
 173 #define OPpREFCOUNTED           64      /* op_targ carries a refcount */
 174
 175 /* Private for OP_AASSIGN */
 176 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
 177
 178 /* Private for OP_SASSIGN */
 179 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
 180 #define OPpASSIGN_CV_TO_GV      128     /* Possible optimisation for constants. */
 181
 182 /* Private for OP_MATCH and OP_SUBST{,CONST} */
 183 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
 184
 185 /* Private for OP_TRANS */
 186 #define OPpTRANS_FROM_UTF       1
 187 #define OPpTRANS_TO_UTF         2
 188 #define OPpTRANS_IDENTICAL      4       /* right side is same as left */
 189 #define OPpTRANS_SQUASH         8
 190     /* 16 is used for OPpTARGET_MY */
 191 #define OPpTRANS_COMPLEMENT     32
 192 #define OPpTRANS_GROWS          64
 193 #define OPpTRANS_DELETE         128
 194 #define OPpTRANS_ALL    (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
 195
 196 /* Private for OP_REPEAT */
 197 #define OPpREPEAT_DOLIST        64      /* List replication. */
 198
 199 /* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
 200 #define OPpDEREF                (32|64) /* autovivify: Want ref to something: */
 201 #define OPpDEREF_AV             32      /*   Want ref to AV. */
 202 #define OPpDEREF_HV             64      /*   Want ref to HV. */
 203 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
 204 /* Private for OP_RV2SV, OP_RV2AV, OP_RV2AV */
 205 #define OPpDEREFed              4       /* prev op was OPpDEREF */
 206
 207   /* OP_ENTERSUB only */
 208 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
 209 #define OPpENTERSUB_HASTARG     32      /* Called from OP tree. */
 210 #define OPpENTERSUB_INARGS      4       /* Lval used as arg to a sub. */
 211 #define OPpENTERSUB_DEREF       1       /* Lval call that autovivifies. */
 212 /* used by HINT_STRICT_SUBS     2          */
 213   /* Mask for OP_ENTERSUB flags, the absence of which must be propagated
 214      in dynamic context */
 215 #define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
 216
 217   /* OP_RV2CV only */
 218 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
 219 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
 220 #define OPpMAY_RETURN_CONSTANT  1       /* If a constant sub, return the constant */
 221
 222   /* OP_GV only */
 223 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
 224   /* OP_?ELEM only */
 225 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
 226   /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
 227 #define OPpOUR_INTRO            16      /* Variable was in an our() */
 228   /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM, OP_[AH]SLICE OP_AV2ARYLEN,
 229      OP_R?KEYS, OP_SUBSTR, OP_POS, OP_VEC */
 230 #define OPpMAYBE_LVSUB          8       /* We might be an lvalue to return */
 231   /* OP_PADSV only */
 232 #define OPpPAD_STATE            16      /* is a "state" pad */
 233   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
 234
 235   /* OP_RV2GV only */
 236 #define OPpDONT_INIT_GV         4       /* Call gv_fetchpv with GV_NOINIT */
 237 /* (Therefore will return whatever is currently in the symbol table, not
 238    guaranteed to be a PVGV)  */
 239
 240 /* Private for OP_ENTERITER and OP_ITER */
 241 #define OPpITER_REVERSED        4       /* for (reverse ...) */
 242 #define OPpITER_DEF             8       /* for $_ or for my $_ */
 243
 244 /* Private for OP_CONST */
 245 #define OPpCONST_NOVER          2       /* no 6; */
 246 #define OPpCONST_SHORTCIRCUIT   4       /* eg the constant 5 in (5 || foo) */
 247 #define OPpCONST_STRICT         8       /* bareword subject to strict 'subs' */
 248 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
 249 #define OPpCONST_ARYBASE        32      /* Was a $[ translated to constant. */
 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 struct op {
 303     BASEOP
 304 };
 305
 306 struct unop {
 307     BASEOP
 308     OP *        op_first;
 309 };
 310
 311 struct binop {
 312     BASEOP
 313     OP *        op_first;
 314     OP *        op_last;
 315 };
 316
 317 struct logop {
 318     BASEOP
 319     OP *        op_first;
 320     OP *        op_other;
 321 };
 322
 323 struct listop {
 324     BASEOP
 325     OP *        op_first;
 326     OP *        op_last;
 327 };
 328
 329 struct pmop {
 330     BASEOP
 331     OP *        op_first;
 332     OP *        op_last;
 333 #ifdef USE_ITHREADS
 334     IV          op_pmoffset;
 335 #else
 336     REGEXP *    op_pmregexp;            /* compiled expression */
 337 #endif
 338     U32         op_pmflags;
 339     union {
 340         OP *    op_pmreplroot;          /* For OP_SUBST */
 341 #ifdef USE_ITHREADS
 342         PADOFFSET  op_pmtargetoff;      /* For OP_PUSHRE */
 343 #else
 344         GV *    op_pmtargetgv;
 345 #endif
 346     }   op_pmreplrootu;
 347     union {
 348         OP *    op_pmreplstart; /* Only used in OP_SUBST */
 349 #ifdef USE_ITHREADS
 350         char *  op_pmstashpv;   /* Only used in OP_MATCH, with PMf_ONCE set */
 351 #else
 352         HV *    op_pmstash;
 353 #endif
 354     }           op_pmstashstartu;
 355 };
 356
 357 #ifdef USE_ITHREADS
 358 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
 359                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
 360 /* The assignment is just to enforce type safety (or at least get a warning).
 361  */
 362 /* With first class regexps not via a reference one needs to assign
 363    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
 364    is cheaper. I guess we could allow NULL, but the check above would get
 365    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
 366 /* BEWARE - something that calls this macro passes (r) which has a side
 367    effect.  */
 368 #define PM_SETRE(o,r)   STMT_START {                                    \
 369                             REGEXP *const _pm_setre = (r);              \
 370                             assert(_pm_setre);                          \
 371                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
 372                         } STMT_END
 373 #else
 374 #define PM_GETRE(o)     ((o)->op_pmregexp)
 375 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
 376 #endif
 377
 378 /* Leave some space, so future bit allocations can go either in the shared or
 379  * unshared area without affecting binary compatibility */
 380 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+6)
 381
 382 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
 383 #define PMf_RETAINT     (1<<(PMf_BASE_SHIFT+0))
 384
 385 /* match successfully only once per reset, with related flag RXf_USED in
 386  * re->extflags holding state.  This is used only for ?? matches, and only on
 387  * OP_MATCH and OP_QR */
 388 #define PMf_ONCE        (1<<(PMf_BASE_SHIFT+1))
 389
 390 /* replacement contains variables */
 391 #define PMf_MAYBE_CONST (1<<(PMf_BASE_SHIFT+2))
 392
 393 /* PMf_ONCE has matched successfully.  Not used under threading. */
 394 #define PMf_USED        (1<<(PMf_BASE_SHIFT+3))
 395
 396 /* subst replacement is constant */
 397 #define PMf_CONST       (1<<(PMf_BASE_SHIFT+4))
 398
 399 /* keep 1st runtime pattern forever */
 400 #define PMf_KEEP        (1<<(PMf_BASE_SHIFT+5))
 401
 402 #define PMf_GLOBAL      (1<<(PMf_BASE_SHIFT+6)) /* pattern had a g modifier */
 403
 404 /* don't reset pos() if //g fails */
 405 #define PMf_CONTINUE    (1<<(PMf_BASE_SHIFT+7))
 406
 407 /* evaluating replacement as expr */
 408 #define PMf_EVAL        (1<<(PMf_BASE_SHIFT+8))
 409
 410 /* Return substituted string instead of modifying it. */
 411 #define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+9))
 412
 413 #if PMf_BASE_SHIFT+9 > 31
 414 #   error Too many PMf_ bits used.  See above and regnodes.h for any spare in middle
 415 #endif
 416
 417 #ifdef USE_ITHREADS
 418
 419 #  define PmopSTASHPV(o)                                                \
 420     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstashpv : NULL)
 421 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 422 #    define PmopSTASHPV_set(o,pv)       ({                              \
 423         assert((o)->op_pmflags & PMf_ONCE);                             \
 424         ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv));        \
 425     })
 426 #  else
 427 #    define PmopSTASHPV_set(o,pv)                                       \
 428     ((o)->op_pmstashstartu.op_pmstashpv = savesharedpv(pv))
 429 #  endif
 430 #  define PmopSTASH(o)          (PmopSTASHPV(o) \
 431                                  ? gv_stashpv((o)->op_pmstashstartu.op_pmstashpv,GV_ADD) : NULL)
 432 #  define PmopSTASH_set(o,hv)   PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : NULL))
 433 #  define PmopSTASH_free(o)     PerlMemShared_free(PmopSTASHPV(o))
 434
 435 #else
 436 #  define PmopSTASH(o)                                                  \
 437     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
 438 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 439 #    define PmopSTASH_set(o,hv)         ({                              \
 440         assert((o)->op_pmflags & PMf_ONCE);                             \
 441         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
 442     })
 443 #  else
 444 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
 445 #  endif
 446 #  define PmopSTASHPV(o)        (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
 447    /* op_pmstashstartu.op_pmstash is not refcounted */
 448 #  define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
 449 /* Note that if this becomes non-empty, then S_forget_pmop in op.c will need
 450    changing */
 451 #  define PmopSTASH_free(o)
 452 #endif
 453
 454 struct svop {
 455     BASEOP
 456     SV *        op_sv;
 457 };
 458
 459 struct padop {
 460     BASEOP
 461     PADOFFSET   op_padix;
 462 };
 463
 464 struct pvop {
 465     BASEOP
 466     char *      op_pv;
 467 };
 468
 469 struct loop {
 470     BASEOP
 471     OP *        op_first;
 472     OP *        op_last;
 473     OP *        op_redoop;
 474     OP *        op_nextop;
 475     OP *        op_lastop;
 476 };
 477
 478 #define cUNOPx(o)       ((UNOP*)o)
 479 #define cBINOPx(o)      ((BINOP*)o)
 480 #define cLISTOPx(o)     ((LISTOP*)o)
 481 #define cLOGOPx(o)      ((LOGOP*)o)
 482 #define cPMOPx(o)       ((PMOP*)o)
 483 #define cSVOPx(o)       ((SVOP*)o)
 484 #define cPADOPx(o)      ((PADOP*)o)
 485 #define cPVOPx(o)       ((PVOP*)o)
 486 #define cCOPx(o)        ((COP*)o)
 487 #define cLOOPx(o)       ((LOOP*)o)
 488
 489 #define cUNOP           cUNOPx(PL_op)
 490 #define cBINOP          cBINOPx(PL_op)
 491 #define cLISTOP         cLISTOPx(PL_op)
 492 #define cLOGOP          cLOGOPx(PL_op)
 493 #define cPMOP           cPMOPx(PL_op)
 494 #define cSVOP           cSVOPx(PL_op)
 495 #define cPADOP          cPADOPx(PL_op)
 496 #define cPVOP           cPVOPx(PL_op)
 497 #define cCOP            cCOPx(PL_op)
 498 #define cLOOP           cLOOPx(PL_op)
 499
 500 #define cUNOPo          cUNOPx(o)
 501 #define cBINOPo         cBINOPx(o)
 502 #define cLISTOPo        cLISTOPx(o)
 503 #define cLOGOPo         cLOGOPx(o)
 504 #define cPMOPo          cPMOPx(o)
 505 #define cSVOPo          cSVOPx(o)
 506 #define cPADOPo         cPADOPx(o)
 507 #define cPVOPo          cPVOPx(o)
 508 #define cCOPo           cCOPx(o)
 509 #define cLOOPo          cLOOPx(o)
 510
 511 #define kUNOP           cUNOPx(kid)
 512 #define kBINOP          cBINOPx(kid)
 513 #define kLISTOP         cLISTOPx(kid)
 514 #define kLOGOP          cLOGOPx(kid)
 515 #define kPMOP           cPMOPx(kid)
 516 #define kSVOP           cSVOPx(kid)
 517 #define kPADOP          cPADOPx(kid)
 518 #define kPVOP           cPVOPx(kid)
 519 #define kCOP            cCOPx(kid)
 520 #define kLOOP           cLOOPx(kid)
 521
 522
 523 #ifdef USE_ITHREADS
 524 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
 525 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
 526                                  && GvIN_PAD(v))
 527 #  define       IS_PADCONST(v)  (v && SvREADONLY(v))
 528 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
 529                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
 530 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
 531                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
 532 #else
 533 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
 534 #  define       IS_PADGV(v)     FALSE
 535 #  define       IS_PADCONST(v)  FALSE
 536 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
 537 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
 538 #endif
 539
 540 #define cGVOP_gv                cGVOPx_gv(PL_op)
 541 #define cGVOPo_gv               cGVOPx_gv(o)
 542 #define kGVOP_gv                cGVOPx_gv(kid)
 543 #define cSVOP_sv                cSVOPx_sv(PL_op)
 544 #define cSVOPo_sv               cSVOPx_sv(o)
 545 #define kSVOP_sv                cSVOPx_sv(kid)
 546
 547 #ifndef PERL_CORE
 548 #  define Nullop ((OP*)NULL)
 549 #endif
 550
 551 /* Lowest byte of PL_opargs */
 552 #define OA_MARK 1
 553 #define OA_FOLDCONST 2
 554 #define OA_RETSCALAR 4
 555 #define OA_TARGET 8
 556 #define OA_TARGLEX 16
 557 #define OA_OTHERINT 32
 558 #define OA_DANGEROUS 64
 559 #define OA_DEFGV 128
 560
 561 /* The next 4 bits encode op class information */
 562 #define OCSHIFT 8
 563
 564 #define OA_CLASS_MASK (15 << OCSHIFT)
 565
 566 #define OA_BASEOP (0 << OCSHIFT)
 567 #define OA_UNOP (1 << OCSHIFT)
 568 #define OA_BINOP (2 << OCSHIFT)
 569 #define OA_LOGOP (3 << OCSHIFT)
 570 #define OA_LISTOP (4 << OCSHIFT)
 571 #define OA_PMOP (5 << OCSHIFT)
 572 #define OA_SVOP (6 << OCSHIFT)
 573 #define OA_PADOP (7 << OCSHIFT)
 574 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
 575 #define OA_LOOP (9 << OCSHIFT)
 576 #define OA_COP (10 << OCSHIFT)
 577 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
 578 #define OA_FILESTATOP (12 << OCSHIFT)
 579 #define OA_LOOPEXOP (13 << OCSHIFT)
 580
 581 #define OASHIFT 12
 582
 583 /* Remaining nybbles of PL_opargs */
 584 #define OA_SCALAR 1
 585 #define OA_LIST 2
 586 #define OA_AVREF 3
 587 #define OA_HVREF 4
 588 #define OA_CVREF 5
 589 #define OA_FILEREF 6
 590 #define OA_SCALARREF 7
 591 #define OA_OPTIONAL 8
 592
 593 /* Op_REFCNT is a reference count at the head of each op tree: needed
 594  * since the tree is shared between threads, and between cloned closure
 595  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
 596  * this count.
 597  * The same mutex is used to protect the refcounts of the reg_trie_data
 598  * and reg_ac_data structures, which are shared between duplicated
 599  * regexes.
 600  */
 601
 602 #ifdef USE_ITHREADS
 603 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
 604 #  ifdef PERL_CORE
 605 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
 606 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
 607 #  else
 608 #    define OP_REFCNT_LOCK              op_refcnt_lock()
 609 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
 610 #  endif
 611 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
 612 #else
 613 #  define OP_REFCNT_INIT                NOOP
 614 #  define OP_REFCNT_LOCK                NOOP
 615 #  define OP_REFCNT_UNLOCK              NOOP
 616 #  define OP_REFCNT_TERM                NOOP
 617 #endif
 618
 619 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
 620 #ifdef PERL_DEBUG_READONLY_OPS
 621 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
 622 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
 623 #else
 624 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
 625 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
 626 #endif
 627
 628 /* flags used by Perl_load_module() */
 629 #define PERL_LOADMOD_DENY               0x1     /* no Module */
 630 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
 631 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* use Module (...) */
 632
 633 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
 634 #define ref(o, type) doref(o, type, TRUE)
 635 #endif
 636
 637 /*
 638 =head1 Optree Manipulation Functions
 639
 640 =for apidoc Am|OP*|LINKLIST|OP *o
 641 Given the root of an optree, link the tree in execution order using the
 642 C<op_next> pointers and return the first op executed. If this has
 643 already been done, it will not be redone, and C<< o->op_next >> will be
 644 returned. If C<< o->op_next >> is not already set, I<o> should be at
 645 least an C<UNOP>.
 646
 647 =cut
 648 */
 649
 650 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
 651
 652 /* no longer used anywhere in core */
 653 #ifndef PERL_CORE
 654 #define cv_ckproto(cv, gv, p) \
 655    cv_ckproto_len((cv), (gv), (p), (p) ? strlen(p) : 0)
 656 #endif
 657
 658 #ifdef PERL_CORE
 659 #  define my(o) my_attrs((o), NULL)
 660 #endif
 661
 662 #ifdef USE_REENTRANT_API
 663 #include "reentr.h"
 664 #endif
 665
 666 #if defined(PL_OP_SLAB_ALLOC)
 667 #define NewOp(m,var,c,type)     \
 668         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
 669 #define NewOpSz(m,var,size)     \
 670         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
 671 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
 672 #else
 673 #define NewOp(m, var, c, type)  \
 674         (var = (MEM_WRAP_CHECK_(c,type) \
 675          (type*)PerlMemShared_calloc(c, sizeof(type))))
 676 #define NewOpSz(m, var, size)   \
 677         (var = (OP*)PerlMemShared_calloc(1, size))
 678 #define FreeOp(p) PerlMemShared_free(p)
 679 #endif
 680
 681 struct block_hooks {
 682     U32     bhk_flags;
 683     void    (*bhk_start)        (pTHX_ int full);
 684     void    (*bhk_pre_end)      (pTHX_ OP **seq);
 685     void    (*bhk_post_end)     (pTHX_ OP **seq);
 686     void    (*bhk_eval)         (pTHX_ OP *const saveop);
 687 };
 688
 689 /*
 690 =head1 Compile-time scope hooks
 691
 692 =for apidoc mx|U32|BhkFLAGS|BHK *hk
 693 Return the BHK's flags.
 694
 695 =for apidoc mx|void *|BhkENTRY|BHK *hk|which
 696 Return an entry from the BHK structure. I<which> is a preprocessor token
 697 indicating which entry to return. If the appropriate flag is not set
 698 this will return NULL. The type of the return value depends on which
 699 entry you ask for.
 700
 701 =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
 702 Set an entry in the BHK structure, and set the flags to indicate it is
 703 valid. I<which> is a preprocessing token indicating which entry to set.
 704 The type of I<ptr> depends on the entry.
 705
 706 =for apidoc Amx|void|BhkDISABLE|BHK *hk|which
 707 Temporarily disable an entry in this BHK structure, by clearing the
 708 appropriate flag. I<which> is a preprocessor token indicating which
 709 entry to disable.
 710
 711 =for apidoc Amx|void|BhkENABLE|BHK *hk|which
 712 Re-enable an entry in this BHK structure, by setting the appropriate
 713 flag. I<which> is a preprocessor token indicating which entry to enable.
 714 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
 715 pointer.
 716
 717 =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
 718 Call all the registered block hooks for type I<which>. I<which> is a
 719 preprocessing token; the type of I<arg> depends on I<which>.
 720
 721 =cut
 722 */
 723
 724 #define BhkFLAGS(hk)            ((hk)->bhk_flags)
 725
 726 #define BHKf_bhk_start      0x01
 727 #define BHKf_bhk_pre_end    0x02
 728 #define BHKf_bhk_post_end   0x04
 729 #define BHKf_bhk_eval       0x08
 730
 731 #define BhkENTRY(hk, which) \
 732     ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
 733
 734 #define BhkENABLE(hk, which) \
 735     STMT_START { \
 736         BhkFLAGS(hk) |= BHKf_ ## which; \
 737         assert(BhkENTRY(hk, which)); \
 738     } STMT_END
 739
 740 #define BhkDISABLE(hk, which) \
 741     STMT_START { \
 742         BhkFLAGS(hk) &= ~(BHKf_ ## which); \
 743     } STMT_END
 744
 745 #define BhkENTRY_set(hk, which, ptr) \
 746     STMT_START { \
 747         (hk)->which = ptr; \
 748         BhkENABLE(hk, which); \
 749     } STMT_END
 750
 751 #define CALL_BLOCK_HOOKS(which, arg) \
 752     STMT_START { \
 753         if (PL_blockhooks) { \
 754             I32 i; \
 755             for (i = av_len(PL_blockhooks); i >= 0; i--) { \
 756                 SV *sv = AvARRAY(PL_blockhooks)[i]; \
 757                 BHK *hk; \
 758                 \
 759                 assert(SvIOK(sv)); \
 760                 if (SvUOK(sv)) \
 761                     hk = INT2PTR(BHK *, SvUVX(sv)); \
 762                 else \
 763                     hk = INT2PTR(BHK *, SvIVX(sv)); \
 764                 \
 765                 if (BhkENTRY(hk, which)) \
 766                     BhkENTRY(hk, which)(aTHX_ arg); \
 767             } \
 768         } \
 769     } STMT_END
 770
 771 /* flags for rv2cv_op_cv */
 772
 773 #define RV2CVOPCV_MARK_EARLY     0x00000001
 774 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
 775
 776 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
 777
 778 /* flags for op_lvalue_flags */
 779
 780 #define OP_LVALUE_NO_CROAK 1
 781
 782 /*
 783 =head1 Custom Operators
 784
 785 =for apidoc Am|U32|XopFLAGS|XOP *xop
 786 Return the XOP's flags.
 787
 788 =for apidoc Am||XopENTRY|XOP *xop|which
 789 Return a member of the XOP structure. I<which> is a cpp token indicating
 790 which entry to return. If the member is not set this will return a
 791 default value. The return type depends on I<which>.
 792
 793 =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
 794 Set a member of the XOP structure. I<which> is a cpp token indicating
 795 which entry to set. See L<perlguts/"Custom Operators"> for details about
 796 the available members and how they are used.
 797
 798 =for apidoc Am|void|XopDISABLE|XOP *xop|which
 799 Temporarily disable a member of the XOP, by clearing the appropriate flag.
 800
 801 =for apidoc Am|void|XopENABLE|XOP *xop|which
 802 Reenable a member of the XOP which has been disabled.
 803
 804 =cut
 805 */
 806
 807 struct custom_op {
 808     U32             xop_flags;
 809     const char     *xop_name;
 810     const char     *xop_desc;
 811     U32             xop_class;
 812     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
 813 };
 814
 815 #define XopFLAGS(xop) ((xop)->xop_flags)
 816
 817 #define XOPf_xop_name   0x01
 818 #define XOPf_xop_desc   0x02
 819 #define XOPf_xop_class  0x04
 820 #define XOPf_xop_peep   0x08
 821
 822 #define XOPd_xop_name   PL_op_name[OP_CUSTOM]
 823 #define XOPd_xop_desc   PL_op_desc[OP_CUSTOM]
 824 #define XOPd_xop_class  OA_BASEOP
 825 #define XOPd_xop_peep   ((Perl_cpeep_t)0)
 826
 827 #define XopENTRY_set(xop, which, to) \
 828     STMT_START { \
 829         (xop)->which = (to); \
 830         (xop)->xop_flags |= XOPf_ ## which; \
 831     } STMT_END
 832
 833 #define XopENTRY(xop, which) \
 834     ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
 835
 836 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
 837 #define XopENABLE(xop, which) \
 838     STMT_START { \
 839         (xop)->xop_flags |= XOPf_ ## which; \
 840         assert(XopENTRY(xop, which)); \
 841     } STMT_END
 842
 843 /*
 844 =head1 Optree Manipulation Functions
 845
 846 =for apidoc Am|const char *|OP_NAME|OP *o
 847 Return the name of the provided OP. For core ops this looks up the name
 848 from the op_type; for custom ops from the op_ppaddr.
 849
 850 =for apidoc Am|const char *|OP_DESC|OP *o
 851 Return a short description of the provided OP.
 852
 853 =for apidoc Am|U32|OP_CLASS|OP *o
 854 Return the class of the provided OP: that is, which of the *OP
 855 structures it uses. For core ops this currently gets the information out
 856 of PL_opargs, which does not always accurately reflect the type used.
 857 For custom ops the type is returned from the registration, and it is up
 858 to the registree to ensure it is accurate. The value returned will be
 859 one of the OA_* constants from op.h.
 860
 861 =cut
 862 */
 863
 864 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
 865                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_name) \
 866                     : PL_op_name[(o)->op_type])
 867 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
 868                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_desc) \
 869                     : PL_op_desc[(o)->op_type])
 870 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
 871                      ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_class) \
 872                      : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
 873
 874 #define newSUB(f, o, p, b)      Perl_newATTRSUB(aTHX_ (f), (o), (p), NULL, (b))
 875
 876 #ifdef PERL_MAD
 877 #  define MAD_NULL 1
 878 #  define MAD_PV 2
 879 #  define MAD_OP 3
 880 #  define MAD_SV 4
 881
 882 struct madprop {
 883     MADPROP* mad_next;
 884     void *mad_val;
 885     U32 mad_vlen;
 886 /*    short mad_count; */
 887     char mad_key;
 888     char mad_type;
 889 };
 890
 891 struct token {
 892     I32 tk_type;
 893     YYSTYPE tk_lval;
 894     MADPROP* tk_mad;
 895 };
 896 #endif
 897
 898 /*
 899  * Values that can be held by mad_key :
 900  * ^       unfilled head spot
 901  * ,       literal ,
 902  * ;       literal ; (blank if implicit ; at end of block)
 903  * :       literal : from ?: or attr list
 904  * +       unary +
 905  * ?       literal ? from ?:
 906  * (       literal (
 907  * )       literal )
 908  * [       literal [
 909  * ]       literal ]
 910  * {       literal {
 911  * }       literal }
 912  * @       literal @ sigil
 913  * $       literal $ sigil
 914  * *       literal * sigil
 915  * !       use is source filtered
 916  * &       & or sub
 917  * #       whitespace/comment following ; or }
 918  * #       $# sigil
 919  * 1       1st ; from for(;;)
 920  * 1       retired protasis
 921  * 2       2nd ; from for(;;)
 922  * 2       retired apodosis
 923  * 3       C-style for list
 924  * a       sub or var attributes
 925  * a       non-method arrow operator
 926  * A       method arrow operator
 927  * A       use import args
 928  * b       format block
 929  * B       retired stub block
 930  * C       constant conditional op
 931  * d       declarator
 932  * D       do block
 933  * e       unreached "else" (see C)
 934  * e       expression producing E
 935  * E       tr/E/R/, /E/
 936  * f       folded constant op
 937  * F       peg op for format
 938  * g       op was forced to be a word
 939  * i       if/unless modifier
 940  * I       if/elsif/unless statement
 941  * k       local declarator
 942  * K       retired kid op
 943  * l       last index of array ($#foo)
 944  * L       label
 945  * m       modifier on regex
 946  * n       sub or format name
 947  * o       current operator/declarator name
 948  * o       else/continue
 949  * O       generic optimized op
 950  * p       peg to hold extra whitespace at statement level
 951  * P       peg op for package declaration
 952  * q       opening quote
 953  * =       quoted material
 954  * Q       closing quote
 955  * Q       optimized qw//
 956  * r       expression producing R
 957  * R       tr/E/R/ s/E/R/
 958  * s       sub signature
 959  * S       use import stub (no import)
 960  * S       retired sort block
 961  * t       unreached "then" (see C)
 962  * U       use import op
 963  * v       private sv of for loop
 964  * V       use version
 965  * w       while/until modifier
 966  * W       while/for statement
 967  * x       optimized qw
 968  * X       random thing
 969  * _       whitespace/comments preceding anything else
 970  * ~       =~ operator
 971  */
 972
 973 /*
 974  * Local variables:
 975  * c-indentation-style: bsd
 976  * c-basic-offset: 4
 977  * indent-tabs-mode: t
 978  * End:
 979  *
 980  * ex: set ts=8 sts=4 sw=4 noet:
 981  */