op.h

   1 /*    op.h
   2  *
   3  *    Copyright (c) 1991-2003, Larry Wall
   4  *
   5  *    You may distribute under the terms of either the GNU General Public
   6  *    License or the Artistic License, as specified in the README file.
   7  *
   8  */
   9
  10 /*
  11  * The fields of BASEOP are:
  12  *      op_next         Pointer to next ppcode to execute after this one.
  13  *                      (Top level pre-grafted op points to first op,
  14  *                      but this is replaced when op is grafted in, when
  15  *                      this op will point to the real next op, and the new
  16  *                      parent takes over role of remembering starting op.)
  17  *      op_ppaddr       Pointer to current ppcode's function.
  18  *      op_type         The type of the operation.
  19  *      op_flags        Flags common to all operations.  See OPf_* below.
  20  *      op_private      Flags peculiar to a particular operation (BUT,
  21  *                      by default, set to the number of children until
  22  *                      the operation is privatized by a check routine,
  23  *                      which may or may not check number of children).
  24  */
  25
  26 #ifdef DEBUGGING_OPS
  27 #define OPCODE opcode
  28 #else
  29 #define OPCODE U16
  30 #endif
  31
  32 #ifdef BASEOP_DEFINITION
  33 #define BASEOP BASEOP_DEFINITION
  34 #else
  35 #define BASEOP                          \
  36     OP*         op_next;                \
  37     OP*         op_sibling;             \
  38     OP*         (CPERLscope(*op_ppaddr))(pTHX);         \
  39     PADOFFSET   op_targ;                \
  40     OPCODE      op_type;                \
  41     U16         op_seq;                 \
  42     U8          op_flags;               \
  43     U8          op_private;
  44 #endif
  45
  46 #define OP_GIMME(op,dfl) \
  47         (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID   ? G_VOID   : \
  48          ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
  49          ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST   ? G_ARRAY   : \
  50          dfl)
  51
  52 /*
  53 =head1 "Gimme" Values
  54
  55 =for apidoc Amn|U32|GIMME_V
  56 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
  57 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
  58 respectively.
  59
  60 =for apidoc Amn|U32|GIMME
  61 A backward-compatible version of C<GIMME_V> which can only return
  62 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
  63 Deprecated.  Use C<GIMME_V> instead.
  64
  65 =cut
  66 */
  67
  68 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
  69
  70 /* Public flags */
  71
  72 #define OPf_WANT        3       /* Mask for "want" bits: */
  73 #define  OPf_WANT_VOID   1      /*   Want nothing */
  74 #define  OPf_WANT_SCALAR 2      /*   Want single value */
  75 #define  OPf_WANT_LIST   3      /*   Want list of any length */
  76 #define OPf_KIDS        4       /* There is a firstborn child. */
  77 #define OPf_PARENS      8       /* This operator was parenthesized. */
  78                                 /*  (Or block needs explicit scope entry.) */
  79 #define OPf_REF         16      /* Certified reference. */
  80                                 /*  (Return container, not containee). */
  81 #define OPf_MOD         32      /* Will modify (lvalue). */
  82 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
  83 #define OPf_SPECIAL     128     /* Do something weird for this op: */
  84                                 /*  On local LVAL, don't init local value. */
  85                                 /*  On OP_SORT, subroutine is inlined. */
  86                                 /*  On OP_NOT, inversion was implicit. */
  87                                 /*  On OP_LEAVE, don't restore curpm. */
  88                                 /*  On truncate, we truncate filehandle */
  89                                 /*  On control verbs, we saw no label */
  90                                 /*  On flipflop, we saw ... instead of .. */
  91                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
  92                                 /*  On OP_ENTERSUB || OP_NULL, saw a "do". */
  93                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
  94                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
  95                                 /*  On OP_ENTERITER, loop var is per-thread */
  96                                 /*  On pushre, re is /\s+/ imp. by split " " */
  97                                 /*  On regcomp, "use re 'eval'" was in scope */
  98                                 /*  On OP_READLINE, was <$filehandle> */
  99                                 /*  On RV2[SG]V, don't create GV--in defined()*/
 100                                 /*  On OP_DBSTATE, indicates breakpoint
 101                                  *    (runtime property) */
 102
 103 /* old names; don't use in new code, but don't break them, either */
 104 #define OPf_LIST        OPf_WANT_LIST
 105 #define OPf_KNOW        OPf_WANT
 106
 107 #define GIMME \
 108           (PL_op->op_flags & OPf_WANT                                   \
 109            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
 110               ? G_ARRAY                                                 \
 111               : G_SCALAR)                                               \
 112            : dowantarray())
 113
 114 /* NOTE: OP_NEXTSTATE, OP_DBSTATE, and OP_SETSTATE (i.e. COPs) carry lower
 115  * bits of PL_hints in op_private */
 116
 117 /* Private for lvalues */
 118 #define OPpLVAL_INTRO   128     /* Lvalue must be localized or lvalue sub */
 119
 120 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
 121 #define OPpREFCOUNTED           64      /* op_targ carries a refcount */
 122
 123 /* Private for OP_AASSIGN */
 124 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
 125
 126 /* Private for OP_SASSIGN */
 127 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
 128
 129 /* Private for OP_MATCH and OP_SUBST{,CONST} */
 130 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
 131
 132 /* Private for OP_TRANS */
 133 #define OPpTRANS_FROM_UTF       1
 134 #define OPpTRANS_TO_UTF         2
 135 #define OPpTRANS_IDENTICAL      4       /* right side is same as left */
 136 #define OPpTRANS_SQUASH         8
 137 #define OPpTRANS_DELETE         16
 138 #define OPpTRANS_COMPLEMENT     32
 139 #define OPpTRANS_GROWS          64
 140
 141 /* Private for OP_REPEAT */
 142 #define OPpREPEAT_DOLIST        64      /* List replication. */
 143
 144 /* Private for OP_RV2?V, OP_?ELEM */
 145 #define OPpDEREF                (32|64) /* Want ref to something: */
 146 #define OPpDEREF_AV             32      /*   Want ref to AV. */
 147 #define OPpDEREF_HV             64      /*   Want ref to HV. */
 148 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
 149   /* OP_ENTERSUB only */
 150 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
 151 #define OPpENTERSUB_HASTARG     32      /* Called from OP tree. */
 152 #define OPpENTERSUB_NOMOD       64      /* Immune to mod() for :attrlist. */
 153   /* OP_RV2CV only */
 154 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
 155 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
 156 #define OPpENTERSUB_INARGS      4       /* Lval used as arg to a sub. */
 157   /* OP_GV only */
 158 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
 159   /* OP_?ELEM only */
 160 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
 161   /* OP_RV2?V, OP_GVSV only */
 162 #define OPpOUR_INTRO            16      /* Variable was in an our() */
 163   /* OP_RV2[AH]V, OP_PAD[AH]V, OP_[AH]ELEM */
 164 #define OPpMAYBE_LVSUB          8       /* We might be an lvalue to return */
 165   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
 166
 167 /* Private for OPs with TARGLEX */
 168   /* (lower bits may carry MAXARG) */
 169 #define OPpTARGET_MY            16      /* Target is PADMY. */
 170
 171 /* Private for OP_CONST */
 172 #define OPpCONST_STRICT         8       /* bearword subject to strict 'subs' */
 173 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
 174 #define OPpCONST_ARYBASE        32      /* Was a $[ translated to constant. */
 175 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
 176 #define OPpCONST_WARNING        128     /* Was a $^W translated to constant. */
 177
 178 /* Private for OP_FLIP/FLOP */
 179 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
 180
 181 /* Private for OP_LIST */
 182 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
 183
 184 /* Private for OP_DELETE */
 185 #define OPpSLICE                64      /* Operating on a list of keys */
 186
 187 /* Private for OP_EXISTS */
 188 #define OPpEXISTS_SUB           64      /* Checking for &sub, not {} or [].  */
 189
 190 /* Private for OP_SORT */
 191 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
 192 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
 193 #define OPpSORT_REVERSE         4       /* Descending sort */
 194 /* Private for OP_THREADSV */
 195 #define OPpDONE_SVREF           64      /* Been through newSVREF once */
 196
 197 /* Private for OP_OPEN and OP_BACKTICK */
 198 #define OPpOPEN_IN_RAW          16      /* binmode(F,":raw") on input fh */
 199 #define OPpOPEN_IN_CRLF         32      /* binmode(F,":crlf") on input fh */
 200 #define OPpOPEN_OUT_RAW         64      /* binmode(F,":raw") on output fh */
 201 #define OPpOPEN_OUT_CRLF        128     /* binmode(F,":crlf") on output fh */
 202
 203 /* Private for OP_EXIT, HUSH also for OP_DIE */
 204 #define OPpHUSH_VMSISH          64      /* hush DCL exit msg vmsish mode*/
 205 #define OPpEXIT_VMSISH          128     /* exit(0) vs. exit(1) vmsish mode*/
 206
 207 struct op {
 208     BASEOP
 209 };
 210
 211 struct unop {
 212     BASEOP
 213     OP *        op_first;
 214 };
 215
 216 struct binop {
 217     BASEOP
 218     OP *        op_first;
 219     OP *        op_last;
 220 };
 221
 222 struct logop {
 223     BASEOP
 224     OP *        op_first;
 225     OP *        op_other;
 226 };
 227
 228 struct listop {
 229     BASEOP
 230     OP *        op_first;
 231     OP *        op_last;
 232 };
 233
 234 struct pmop {
 235     BASEOP
 236     OP *        op_first;
 237     OP *        op_last;
 238     OP *        op_pmreplroot;
 239     OP *        op_pmreplstart;
 240     PMOP *      op_pmnext;              /* list of all scanpats */
 241 #ifdef USE_ITHREADS
 242     IV          op_pmoffset;
 243 #else
 244     REGEXP *    op_pmregexp;            /* compiled expression */
 245 #endif
 246     U32         op_pmflags;
 247     U32         op_pmpermflags;
 248     U8          op_pmdynflags;
 249 #ifdef USE_ITHREADS
 250     char *      op_pmstashpv;
 251 #else
 252     HV *        op_pmstash;
 253 #endif
 254 };
 255
 256 #ifdef USE_ITHREADS
 257 #define PM_GETRE(o)     (INT2PTR(REGEXP*,SvIVX(PL_regex_pad[(o)->op_pmoffset])))
 258 #define PM_SETRE(o,r)   STMT_START { SV* sv = PL_regex_pad[(o)->op_pmoffset]; sv_setiv(sv, PTR2IV(r)); } STMT_END
 259 #define PM_GETRE_SAFE(o) (PL_regex_pad ? PM_GETRE(o) : (REGEXP*)0)
 260 #define PM_SETRE_SAFE(o,r) if (PL_regex_pad) PM_SETRE(o,r)
 261 #else
 262 #define PM_GETRE(o)     ((o)->op_pmregexp)
 263 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
 264 #define PM_GETRE_SAFE PM_GETRE
 265 #define PM_SETRE_SAFE PM_SETRE
 266 #endif
 267
 268 #define PMdf_USED       0x01            /* pm has been used once already */
 269 #define PMdf_TAINTED    0x02            /* pm compiled from tainted pattern */
 270 #define PMdf_UTF8       0x04            /* pm compiled from utf8 data */
 271 #define PMdf_DYN_UTF8   0x08
 272
 273 #define PMdf_CMP_UTF8   (PMdf_UTF8|PMdf_DYN_UTF8)
 274
 275 #define PMf_RETAINT     0x0001          /* taint $1 etc. if target tainted */
 276 #define PMf_ONCE        0x0002          /* use pattern only once per reset */
 277 #define PMf_UNUSED      0x0004          /* free for use */
 278 #define PMf_MAYBE_CONST 0x0008          /* replacement contains variables */
 279 #define PMf_SKIPWHITE   0x0010          /* skip leading whitespace for split */
 280 #define PMf_WHITE       0x0020          /* pattern is \s+ */
 281 #define PMf_CONST       0x0040          /* subst replacement is constant */
 282 #define PMf_KEEP        0x0080          /* keep 1st runtime pattern forever */
 283 #define PMf_GLOBAL      0x0100          /* pattern had a g modifier */
 284 #define PMf_CONTINUE    0x0200          /* don't reset pos() if //g fails */
 285 #define PMf_EVAL        0x0400          /* evaluating replacement as expr */
 286 #define PMf_LOCALE      0x0800          /* use locale for character types */
 287 #define PMf_MULTILINE   0x1000          /* assume multiple lines */
 288 #define PMf_SINGLELINE  0x2000          /* assume single line */
 289 #define PMf_FOLD        0x4000          /* case insensitivity */
 290 #define PMf_EXTENDED    0x8000          /* chuck embedded whitespace */
 291
 292 /* mask of bits stored in regexp->reganch */
 293 #define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED)
 294
 295 #ifdef USE_ITHREADS
 296
 297 #  define PmopSTASHPV(o)        ((o)->op_pmstashpv)
 298 #  define PmopSTASHPV_set(o,pv) (PmopSTASHPV(o) = savesharedpv(pv))
 299 #  define PmopSTASH(o)          (PmopSTASHPV(o) \
 300                                  ? gv_stashpv(PmopSTASHPV(o),GV_ADD) : Nullhv)
 301 #  define PmopSTASH_set(o,hv)   PmopSTASHPV_set(o, ((hv) ? HvNAME(hv) : Nullch))
 302 #  define PmopSTASH_free(o)     PerlMemShared_free(PmopSTASHPV(o))
 303
 304 #else
 305 #  define PmopSTASH(o)          ((o)->op_pmstash)
 306 #  define PmopSTASH_set(o,hv)   ((o)->op_pmstash = (hv))
 307 #  define PmopSTASHPV(o)        (PmopSTASH(o) ? HvNAME(PmopSTASH(o)) : Nullch)
 308    /* op_pmstash is not refcounted */
 309 #  define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
 310 #  define PmopSTASH_free(o)
 311 #endif
 312
 313 struct svop {
 314     BASEOP
 315     SV *        op_sv;
 316 };
 317
 318 struct padop {
 319     BASEOP
 320     PADOFFSET   op_padix;
 321 };
 322
 323 struct pvop {
 324     BASEOP
 325     char *      op_pv;
 326 };
 327
 328 struct loop {
 329     BASEOP
 330     OP *        op_first;
 331     OP *        op_last;
 332     OP *        op_redoop;
 333     OP *        op_nextop;
 334     OP *        op_lastop;
 335 };
 336
 337 #define cUNOPx(o)       ((UNOP*)o)
 338 #define cBINOPx(o)      ((BINOP*)o)
 339 #define cLISTOPx(o)     ((LISTOP*)o)
 340 #define cLOGOPx(o)      ((LOGOP*)o)
 341 #define cPMOPx(o)       ((PMOP*)o)
 342 #define cSVOPx(o)       ((SVOP*)o)
 343 #define cPADOPx(o)      ((PADOP*)o)
 344 #define cPVOPx(o)       ((PVOP*)o)
 345 #define cCOPx(o)        ((COP*)o)
 346 #define cLOOPx(o)       ((LOOP*)o)
 347
 348 #define cUNOP           cUNOPx(PL_op)
 349 #define cBINOP          cBINOPx(PL_op)
 350 #define cLISTOP         cLISTOPx(PL_op)
 351 #define cLOGOP          cLOGOPx(PL_op)
 352 #define cPMOP           cPMOPx(PL_op)
 353 #define cSVOP           cSVOPx(PL_op)
 354 #define cPADOP          cPADOPx(PL_op)
 355 #define cPVOP           cPVOPx(PL_op)
 356 #define cCOP            cCOPx(PL_op)
 357 #define cLOOP           cLOOPx(PL_op)
 358
 359 #define cUNOPo          cUNOPx(o)
 360 #define cBINOPo         cBINOPx(o)
 361 #define cLISTOPo        cLISTOPx(o)
 362 #define cLOGOPo         cLOGOPx(o)
 363 #define cPMOPo          cPMOPx(o)
 364 #define cSVOPo          cSVOPx(o)
 365 #define cPADOPo         cPADOPx(o)
 366 #define cPVOPo          cPVOPx(o)
 367 #define cCOPo           cCOPx(o)
 368 #define cLOOPo          cLOOPx(o)
 369
 370 #define kUNOP           cUNOPx(kid)
 371 #define kBINOP          cBINOPx(kid)
 372 #define kLISTOP         cLISTOPx(kid)
 373 #define kLOGOP          cLOGOPx(kid)
 374 #define kPMOP           cPMOPx(kid)
 375 #define kSVOP           cSVOPx(kid)
 376 #define kPADOP          cPADOPx(kid)
 377 #define kPVOP           cPVOPx(kid)
 378 #define kCOP            cCOPx(kid)
 379 #define kLOOP           cLOOPx(kid)
 380
 381
 382 #ifdef USE_ITHREADS
 383 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
 384 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && GvIN_PAD(v))
 385 #  define       IS_PADCONST(v)  (v && SvREADONLY(v))
 386 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
 387                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
 388 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
 389                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
 390 #else
 391 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
 392 #  define       IS_PADGV(v)     FALSE
 393 #  define       IS_PADCONST(v)  FALSE
 394 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
 395 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
 396 #endif
 397
 398 #define cGVOP_gv                cGVOPx_gv(PL_op)
 399 #define cGVOPo_gv               cGVOPx_gv(o)
 400 #define kGVOP_gv                cGVOPx_gv(kid)
 401 #define cSVOP_sv                cSVOPx_sv(PL_op)
 402 #define cSVOPo_sv               cSVOPx_sv(o)
 403 #define kSVOP_sv                cSVOPx_sv(kid)
 404
 405 #define Nullop Null(OP*)
 406
 407 /* Lowest byte-and-a-bit of PL_opargs */
 408 #define OA_MARK 1
 409 #define OA_FOLDCONST 2
 410 #define OA_RETSCALAR 4
 411 #define OA_TARGET 8
 412 #define OA_RETINTEGER 16
 413 #define OA_OTHERINT 32
 414 #define OA_DANGEROUS 64
 415 #define OA_DEFGV 128
 416 #define OA_TARGLEX 256
 417
 418 /* The next 4 bits encode op class information */
 419 #define OCSHIFT 9
 420
 421 #define OA_CLASS_MASK (15 << OCSHIFT)
 422
 423 #define OA_BASEOP (0 << OCSHIFT)
 424 #define OA_UNOP (1 << OCSHIFT)
 425 #define OA_BINOP (2 << OCSHIFT)
 426 #define OA_LOGOP (3 << OCSHIFT)
 427 #define OA_LISTOP (4 << OCSHIFT)
 428 #define OA_PMOP (5 << OCSHIFT)
 429 #define OA_SVOP (6 << OCSHIFT)
 430 #define OA_PADOP (7 << OCSHIFT)
 431 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
 432 #define OA_LOOP (9 << OCSHIFT)
 433 #define OA_COP (10 << OCSHIFT)
 434 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
 435 #define OA_FILESTATOP (12 << OCSHIFT)
 436 #define OA_LOOPEXOP (13 << OCSHIFT)
 437
 438 #define OASHIFT 13
 439
 440 /* Remaining nybbles of PL_opargs */
 441 #define OA_SCALAR 1
 442 #define OA_LIST 2
 443 #define OA_AVREF 3
 444 #define OA_HVREF 4
 445 #define OA_CVREF 5
 446 #define OA_FILEREF 6
 447 #define OA_SCALARREF 7
 448 #define OA_OPTIONAL 8
 449
 450 #ifdef USE_ITHREADS
 451 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
 452 #  define OP_REFCNT_LOCK                MUTEX_LOCK(&PL_op_mutex)
 453 #  define OP_REFCNT_UNLOCK              MUTEX_UNLOCK(&PL_op_mutex)
 454 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
 455 #else
 456 #  define OP_REFCNT_INIT                NOOP
 457 #  define OP_REFCNT_LOCK                NOOP
 458 #  define OP_REFCNT_UNLOCK              NOOP
 459 #  define OP_REFCNT_TERM                NOOP
 460 #endif
 461
 462 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
 463 #define OpREFCNT_inc(o)                 ((o) ? (++(o)->op_targ, (o)) : Nullop)
 464 #define OpREFCNT_dec(o)                 (--(o)->op_targ)
 465
 466 /* flags used by Perl_load_module() */
 467 #define PERL_LOADMOD_DENY               0x1
 468 #define PERL_LOADMOD_NOIMPORT           0x2
 469 #define PERL_LOADMOD_IMPORT_OPS         0x4
 470
 471 #ifdef USE_REENTRANT_API
 472 #include "reentr.h"
 473 #endif
 474