op.h

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