3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005 by Larry Wall and others
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.
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
22 * op_static Whether or not the op is statically defined.
23 * This flag is used by the B::C compiler backend
24 * and indicates that the op should not be freed.
25 * op_spare Five spare bits!
26 * op_flags Flags common to all operations. See OPf_* below.
27 * op_private Flags peculiar to a particular operation (BUT,
28 * by default, set to the number of children until
29 * the operation is privatized by a check routine,
30 * which may or may not check number of children).
39 #ifdef BASEOP_DEFINITION
40 #define BASEOP BASEOP_DEFINITION
45 OP* (CPERLscope(*op_ppaddr))(pTHX); \
49 unsigned op_static:1; \
50 unsigned op_spare:5; \
55 #define OP_GIMME(op,dfl) \
56 (((op)->op_flags & OPf_WANT) == OPf_WANT_VOID ? G_VOID : \
57 ((op)->op_flags & OPf_WANT) == OPf_WANT_SCALAR ? G_SCALAR : \
58 ((op)->op_flags & OPf_WANT) == OPf_WANT_LIST ? G_ARRAY : \
64 =for apidoc Amn|U32|GIMME_V
65 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
66 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
69 =for apidoc Amn|U32|GIMME
70 A backward-compatible version of C<GIMME_V> which can only return
71 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
72 Deprecated. Use C<GIMME_V> instead.
77 #define GIMME_V OP_GIMME(PL_op, block_gimme())
81 #define OPf_WANT 3 /* Mask for "want" bits: */
82 #define OPf_WANT_VOID 1 /* Want nothing */
83 #define OPf_WANT_SCALAR 2 /* Want single value */
84 #define OPf_WANT_LIST 3 /* Want list of any length */
85 #define OPf_KIDS 4 /* There is a firstborn child. */
86 #define OPf_PARENS 8 /* This operator was parenthesized. */
87 /* (Or block needs explicit scope entry.) */
88 #define OPf_REF 16 /* Certified reference. */
89 /* (Return container, not containee). */
90 #define OPf_MOD 32 /* Will modify (lvalue). */
91 #define OPf_STACKED 64 /* Some arg is arriving on the stack. */
92 #define OPf_SPECIAL 128 /* Do something weird for this op: */
93 /* On local LVAL, don't init local value. */
94 /* On OP_SORT, subroutine is inlined. */
95 /* On OP_NOT, inversion was implicit. */
96 /* On OP_LEAVE, don't restore curpm. */
97 /* On truncate, we truncate filehandle */
98 /* On control verbs, we saw no label */
99 /* On flipflop, we saw ... instead of .. */
100 /* On UNOPs, saw bare parens, e.g. eof(). */
101 /* On OP_ENTERSUB || OP_NULL, saw a "do". */
102 /* On OP_EXISTS, treat av as av, not avhv. */
103 /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
104 /* On OP_ENTERITER, loop var is per-thread */
105 /* On pushre, re is /\s+/ imp. by split " " */
106 /* On regcomp, "use re 'eval'" was in scope */
107 /* On OP_READLINE, was <$filehandle> */
108 /* On RV2[ACGHS]V, don't create GV--in
110 /* On OP_DBSTATE, indicates breakpoint
111 * (runtime property) */
112 /* On OP_AELEMFAST, indiciates pad var */
113 /* On OP_REQUIRE, was seen as CORE::require */
114 /* On OP_ENTERWHEN, there's no condition */
115 /* On OP_BREAK, an implicit break */
116 /* On OP_SMARTMATCH, an implicit smartmatch */
118 /* old names; don't use in new code, but don't break them, either */
119 #define OPf_LIST OPf_WANT_LIST
120 #define OPf_KNOW OPf_WANT
123 (PL_op->op_flags & OPf_WANT \
124 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
129 /* NOTE: OP_NEXTSTATE, OP_DBSTATE, and OP_SETSTATE (i.e. COPs) carry lower
130 * bits of PL_hints in op_private */
132 /* Private for lvalues */
133 #define OPpLVAL_INTRO 128 /* Lvalue must be localized or lvalue sub */
135 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
136 #define OPpREFCOUNTED 64 /* op_targ carries a refcount */
138 /* Private for OP_AASSIGN */
139 #define OPpASSIGN_COMMON 64 /* Left & right have syms in common. */
141 /* Private for OP_SASSIGN */
142 #define OPpASSIGN_BACKWARDS 64 /* Left & right switched. */
144 /* Private for OP_MATCH and OP_SUBST{,CONST} */
145 #define OPpRUNTIME 64 /* Pattern coming in on the stack */
147 /* Private for OP_TRANS */
148 #define OPpTRANS_FROM_UTF 1
149 #define OPpTRANS_TO_UTF 2
150 #define OPpTRANS_IDENTICAL 4 /* right side is same as left */
151 #define OPpTRANS_SQUASH 8
152 /* 16 is used for OPpTARGET_MY */
153 #define OPpTRANS_COMPLEMENT 32
154 #define OPpTRANS_GROWS 64
155 #define OPpTRANS_DELETE 128
156 #define OPpTRANS_ALL (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
158 /* Private for OP_REPEAT */
159 #define OPpREPEAT_DOLIST 64 /* List replication. */
161 /* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
162 #define OPpDEREF (32|64) /* autovivify: Want ref to something: */
163 #define OPpDEREF_AV 32 /* Want ref to AV. */
164 #define OPpDEREF_HV 64 /* Want ref to HV. */
165 #define OPpDEREF_SV (32|64) /* Want ref to SV. */
166 /* OP_ENTERSUB only */
167 #define OPpENTERSUB_DB 16 /* Debug subroutine. */
168 #define OPpENTERSUB_HASTARG 32 /* Called from OP tree. */
169 #define OPpENTERSUB_NOMOD 64 /* Immune to mod() for :attrlist. */
171 #define OPpENTERSUB_AMPER 8 /* Used & form to call. */
172 #define OPpENTERSUB_NOPAREN 128 /* bare sub call (without parens) */
173 #define OPpENTERSUB_INARGS 4 /* Lval used as arg to a sub. */
175 #define OPpEARLY_CV 32 /* foo() called before sub foo was parsed */
177 #define OPpLVAL_DEFER 16 /* Defer creation of array/hash elem */
178 /* OP_RV2?V, OP_GVSV, OP_ENTERITER only */
179 #define OPpOUR_INTRO 16 /* Variable was in an our() */
180 /* OP_RV2[AH]V, OP_PAD[AH]V, OP_[AH]ELEM */
181 #define OPpMAYBE_LVSUB 8 /* We might be an lvalue to return */
182 /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
184 /* Private for OPs with TARGLEX */
185 /* (lower bits may carry MAXARG) */
186 #define OPpTARGET_MY 16 /* Target is PADMY. */
188 /* Private for OP_ENTERITER and OP_ITER */
189 #define OPpITER_REVERSED 4 /* for (reverse ...) */
190 #define OPpITER_DEF 8 /* for $_ or for my $_ */
192 /* Private for OP_CONST */
193 #define OPpCONST_NOVER 2 /* no 6; */
194 #define OPpCONST_SHORTCIRCUIT 4 /* eg the constant 5 in (5 || foo) */
195 #define OPpCONST_STRICT 8 /* bearword subject to strict 'subs' */
196 #define OPpCONST_ENTERED 16 /* Has been entered as symbol. */
197 #define OPpCONST_ARYBASE 32 /* Was a $[ translated to constant. */
198 #define OPpCONST_BARE 64 /* Was a bare word (filehandle?). */
199 #define OPpCONST_WARNING 128 /* Was a $^W translated to constant. */
201 /* Private for OP_FLIP/FLOP */
202 #define OPpFLIP_LINENUM 64 /* Range arg potentially a line num. */
204 /* Private for OP_LIST */
205 #define OPpLIST_GUESSED 64 /* Guessed that pushmark was needed. */
207 /* Private for OP_DELETE */
208 #define OPpSLICE 64 /* Operating on a list of keys */
210 /* Private for OP_EXISTS */
211 #define OPpEXISTS_SUB 64 /* Checking for &sub, not {} or []. */
213 /* Private for OP_SORT */
214 #define OPpSORT_NUMERIC 1 /* Optimized away { $a <=> $b } */
215 #define OPpSORT_INTEGER 2 /* Ditto while under "use integer" */
216 #define OPpSORT_REVERSE 4 /* Reversed sort */
217 #define OPpSORT_INPLACE 8 /* sort in-place; eg @a = sort @a */
218 #define OPpSORT_DESCEND 16 /* Descending sort */
219 #define OPpSORT_QSORT 32 /* Use quicksort (not mergesort) */
220 #define OPpSORT_STABLE 64 /* Use a stable algorithm */
222 /* Private for OP_THREADSV */
223 #define OPpDONE_SVREF 64 /* Been through newSVREF once */
225 /* Private for OP_OPEN and OP_BACKTICK */
226 #define OPpOPEN_IN_RAW 16 /* binmode(F,":raw") on input fh */
227 #define OPpOPEN_IN_CRLF 32 /* binmode(F,":crlf") on input fh */
228 #define OPpOPEN_OUT_RAW 64 /* binmode(F,":raw") on output fh */
229 #define OPpOPEN_OUT_CRLF 128 /* binmode(F,":crlf") on output fh */
231 /* Private for OP_EXIT, HUSH also for OP_DIE */
232 #define OPpHUSH_VMSISH 64 /* hush DCL exit msg vmsish mode*/
233 #define OPpEXIT_VMSISH 128 /* exit(0) vs. exit(1) vmsish mode*/
235 /* Private for OP_FTXXX */
236 #define OPpFT_ACCESS 2 /* use filetest 'access' */
237 #define OPpFT_STACKED 4 /* stacked filetest, as in "-f -x $f" */
238 #define OP_IS_FILETEST_ACCESS(op) \
239 (((op)->op_type) == OP_FTRREAD || \
240 ((op)->op_type) == OP_FTRWRITE || \
241 ((op)->op_type) == OP_FTREXEC || \
242 ((op)->op_type) == OP_FTEREAD || \
243 ((op)->op_type) == OP_FTEWRITE || \
244 ((op)->op_type) == OP_FTEEXEC)
246 /* Private for OP_(MAP|GREP)(WHILE|START) */
247 #define OPpGREP_LEX 2 /* iterate over lexical $_ */
249 /* Private for OP_ENTEREVAL */
250 #define OPpEVAL_HAS_HH 2 /* Does it have a copy of %^H */
283 OP * op_pmreplroot; /* (type is really union {OP*,GV*,PADOFFSET}) */
285 PMOP * op_pmnext; /* list of all scanpats */
289 REGEXP * op_pmregexp; /* compiled expression */
302 #define PM_GETRE(o) (INT2PTR(REGEXP*,SvIVX(PL_regex_pad[(o)->op_pmoffset])))
303 #define PM_SETRE(o,r) STMT_START { \
304 SV* const sv = PL_regex_pad[(o)->op_pmoffset]; \
305 sv_setiv(sv, PTR2IV(r)); \
307 #define PM_GETRE_SAFE(o) (PL_regex_pad ? PM_GETRE(o) : (REGEXP*)0)
308 #define PM_SETRE_SAFE(o,r) if (PL_regex_pad) PM_SETRE(o,r)
310 #define PM_GETRE(o) ((o)->op_pmregexp)
311 #define PM_SETRE(o,r) ((o)->op_pmregexp = (r))
312 #define PM_GETRE_SAFE PM_GETRE
313 #define PM_SETRE_SAFE PM_SETRE
316 #define PMdf_USED 0x01 /* pm has been used once already */
317 #define PMdf_TAINTED 0x02 /* pm compiled from tainted pattern */
318 #define PMdf_UTF8 0x04 /* pm compiled from utf8 data */
319 #define PMdf_DYN_UTF8 0x08
321 #define PMdf_CMP_UTF8 (PMdf_UTF8|PMdf_DYN_UTF8)
323 #define PMf_RETAINT 0x0001 /* taint $1 etc. if target tainted */
324 #define PMf_ONCE 0x0002 /* use pattern only once per reset */
325 #define PMf_UNUSED 0x0004 /* free for use */
326 #define PMf_MAYBE_CONST 0x0008 /* replacement contains variables */
327 #define PMf_SKIPWHITE 0x0010 /* skip leading whitespace for split */
328 #define PMf_WHITE 0x0020 /* pattern is \s+ */
329 #define PMf_CONST 0x0040 /* subst replacement is constant */
330 #define PMf_KEEP 0x0080 /* keep 1st runtime pattern forever */
331 #define PMf_GLOBAL 0x0100 /* pattern had a g modifier */
332 #define PMf_CONTINUE 0x0200 /* don't reset pos() if //g fails */
333 #define PMf_EVAL 0x0400 /* evaluating replacement as expr */
334 #define PMf_LOCALE 0x0800 /* use locale for character types */
335 #define PMf_MULTILINE 0x1000 /* assume multiple lines */
336 #define PMf_SINGLELINE 0x2000 /* assume single line */
337 #define PMf_FOLD 0x4000 /* case insensitivity */
338 #define PMf_EXTENDED 0x8000 /* chuck embedded whitespace */
340 /* mask of bits stored in regexp->reganch */
341 #define PMf_COMPILETIME (PMf_MULTILINE|PMf_SINGLELINE|PMf_LOCALE|PMf_FOLD|PMf_EXTENDED)
345 # define PmopSTASHPV(o) ((o)->op_pmstashpv)
346 # define PmopSTASHPV_set(o,pv) (PmopSTASHPV(o) = savesharedpv(pv))
347 # define PmopSTASH(o) (PmopSTASHPV(o) \
348 ? gv_stashpv(PmopSTASHPV(o),GV_ADD) : NULL)
349 # define PmopSTASH_set(o,hv) PmopSTASHPV_set(o, ((hv) ? HvNAME_get(hv) : Nullch))
350 # define PmopSTASH_free(o) PerlMemShared_free(PmopSTASHPV(o))
353 # define PmopSTASH(o) ((o)->op_pmstash)
354 # define PmopSTASH_set(o,hv) ((o)->op_pmstash = (hv))
355 # define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : Nullch)
356 /* op_pmstash is not refcounted */
357 # define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
358 # define PmopSTASH_free(o)
385 #define cUNOPx(o) ((UNOP*)o)
386 #define cBINOPx(o) ((BINOP*)o)
387 #define cLISTOPx(o) ((LISTOP*)o)
388 #define cLOGOPx(o) ((LOGOP*)o)
389 #define cPMOPx(o) ((PMOP*)o)
390 #define cSVOPx(o) ((SVOP*)o)
391 #define cPADOPx(o) ((PADOP*)o)
392 #define cPVOPx(o) ((PVOP*)o)
393 #define cCOPx(o) ((COP*)o)
394 #define cLOOPx(o) ((LOOP*)o)
396 #define cUNOP cUNOPx(PL_op)
397 #define cBINOP cBINOPx(PL_op)
398 #define cLISTOP cLISTOPx(PL_op)
399 #define cLOGOP cLOGOPx(PL_op)
400 #define cPMOP cPMOPx(PL_op)
401 #define cSVOP cSVOPx(PL_op)
402 #define cPADOP cPADOPx(PL_op)
403 #define cPVOP cPVOPx(PL_op)
404 #define cCOP cCOPx(PL_op)
405 #define cLOOP cLOOPx(PL_op)
407 #define cUNOPo cUNOPx(o)
408 #define cBINOPo cBINOPx(o)
409 #define cLISTOPo cLISTOPx(o)
410 #define cLOGOPo cLOGOPx(o)
411 #define cPMOPo cPMOPx(o)
412 #define cSVOPo cSVOPx(o)
413 #define cPADOPo cPADOPx(o)
414 #define cPVOPo cPVOPx(o)
415 #define cCOPo cCOPx(o)
416 #define cLOOPo cLOOPx(o)
418 #define kUNOP cUNOPx(kid)
419 #define kBINOP cBINOPx(kid)
420 #define kLISTOP cLISTOPx(kid)
421 #define kLOGOP cLOGOPx(kid)
422 #define kPMOP cPMOPx(kid)
423 #define kSVOP cSVOPx(kid)
424 #define kPADOP cPADOPx(kid)
425 #define kPVOP cPVOPx(kid)
426 #define kCOP cCOPx(kid)
427 #define kLOOP cLOOPx(kid)
431 # define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
432 # define IS_PADGV(v) (v && SvTYPE(v) == SVt_PVGV && GvIN_PAD(v))
433 # define IS_PADCONST(v) (v && SvREADONLY(v))
434 # define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
435 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
436 # define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
437 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
439 # define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
440 # define IS_PADGV(v) FALSE
441 # define IS_PADCONST(v) FALSE
442 # define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
443 # define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
446 #define cGVOP_gv cGVOPx_gv(PL_op)
447 #define cGVOPo_gv cGVOPx_gv(o)
448 #define kGVOP_gv cGVOPx_gv(kid)
449 #define cSVOP_sv cSVOPx_sv(PL_op)
450 #define cSVOPo_sv cSVOPx_sv(o)
451 #define kSVOP_sv cSVOPx_sv(kid)
453 #define Nullop Null(OP*)
455 /* Lowest byte-and-a-bit of PL_opargs */
457 #define OA_FOLDCONST 2
458 #define OA_RETSCALAR 4
460 #define OA_RETINTEGER 16
461 #define OA_OTHERINT 32
462 #define OA_DANGEROUS 64
464 #define OA_TARGLEX 256
466 /* The next 4 bits encode op class information */
469 #define OA_CLASS_MASK (15 << OCSHIFT)
471 #define OA_BASEOP (0 << OCSHIFT)
472 #define OA_UNOP (1 << OCSHIFT)
473 #define OA_BINOP (2 << OCSHIFT)
474 #define OA_LOGOP (3 << OCSHIFT)
475 #define OA_LISTOP (4 << OCSHIFT)
476 #define OA_PMOP (5 << OCSHIFT)
477 #define OA_SVOP (6 << OCSHIFT)
478 #define OA_PADOP (7 << OCSHIFT)
479 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
480 #define OA_LOOP (9 << OCSHIFT)
481 #define OA_COP (10 << OCSHIFT)
482 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
483 #define OA_FILESTATOP (12 << OCSHIFT)
484 #define OA_LOOPEXOP (13 << OCSHIFT)
488 /* Remaining nybbles of PL_opargs */
495 #define OA_SCALARREF 7
496 #define OA_OPTIONAL 8
499 # define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
501 # define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
502 # define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
504 # define OP_REFCNT_LOCK op_refcnt_lock()
505 # define OP_REFCNT_UNLOCK op_refcnt_unlock()
507 # define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
509 # define OP_REFCNT_INIT NOOP
510 # define OP_REFCNT_LOCK NOOP
511 # define OP_REFCNT_UNLOCK NOOP
512 # define OP_REFCNT_TERM NOOP
515 #define OpREFCNT_set(o,n) ((o)->op_targ = (n))
516 #define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : Nullop)
517 #define OpREFCNT_dec(o) (--(o)->op_targ)
519 /* flags used by Perl_load_module() */
520 #define PERL_LOADMOD_DENY 0x1
521 #define PERL_LOADMOD_NOIMPORT 0x2
522 #define PERL_LOADMOD_IMPORT_OPS 0x4
524 /* used in perly.y */
525 #define ref(o, type) doref(o, type, TRUE)
527 #ifdef USE_REENTRANT_API
531 #if defined(PL_OP_SLAB_ALLOC)
532 #define NewOp(m,var,c,type) \
533 (var = (type *) Perl_Slab_Alloc(aTHX_ m,c*sizeof(type)))
534 #define NewOpSz(m,var,size) \
535 (var = (OP *) Perl_Slab_Alloc(aTHX_ m,size))
536 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
538 #define NewOp(m, var, c, type) Newxz(var, c, type)
539 #define NewOpSz(m, var, size) \
540 (var = (OP*)safemalloc(size), memzero(var, size))
541 #define FreeOp(p) Safefree(p)