op.h

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