This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Do not rely on the precise error wording
[perl5.git] / op.h
CommitLineData
a0d0e21e 1/* op.h
79072805 2 *
1129b882
NC
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
79072805
LW
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 *
79072805
LW
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.
2814eb74
PJ
20 * op_opt Whether or not the op has been optimised by the
21 * peephole optimiser.
8be227ab 22 * op_slabbed allocated via opslab
90840c5d
RU
23 * op_static tell op_free() to skip PerlMemShared_free(), when
24 * !op_slabbed.
bb38a9e0 25 * op_savefree on savestack via SAVEFREEOP
3513c740 26 * op_folded Result/remainder of a constant fold operation.
29e61fd9
DM
27 * op_lastsib this op is is the last sibling
28 * op_spare One spare bit
79072805
LW
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 */
1850c8f9 35#include "op_reg_common.h"
79072805 36
79072805 37#define OPCODE U16
79072805 38
61a59f30 39typedef PERL_BITFIELD16 Optype;
0053d415 40
0f4eea8f
DL
41#ifdef BASEOP_DEFINITION
42#define BASEOP BASEOP_DEFINITION
43#else
79072805
LW
44#define BASEOP \
45 OP* op_next; \
46 OP* op_sibling; \
16c91539 47 OP* (*op_ppaddr)(pTHX); \
79072805 48 PADOFFSET op_targ; \
654eccd5
JD
49 PERL_BITFIELD16 op_type:9; \
50 PERL_BITFIELD16 op_opt:1; \
8be227ab 51 PERL_BITFIELD16 op_slabbed:1; \
bb38a9e0 52 PERL_BITFIELD16 op_savefree:1; \
90840c5d 53 PERL_BITFIELD16 op_static:1; \
3513c740 54 PERL_BITFIELD16 op_folded:1; \
ea726588 55 PERL_BITFIELD16 op_lastsib:1; \
29e61fd9 56 PERL_BITFIELD16 op_spare:1; \
a0d0e21e
LW
57 U8 op_flags; \
58 U8 op_private;
0f4eea8f 59#endif
79072805 60
0053d415
JD
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.*/
17347a51 65
fe615074 66/* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
54310121 67#define OP_GIMME(op,dfl) \
fe615074 68 (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
54310121 69
2f8edad0 70#define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
4f911530 71
954c1994 72/*
ccfc67b7
JH
73=head1 "Gimme" Values
74
954c1994
GS
75=for apidoc Amn|U32|GIMME_V
76The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
91e74348 77C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
72d33970 78respectively. See L<perlcall> for a usage example.
954c1994
GS
79
80=for apidoc Amn|U32|GIMME
81A backward-compatible version of C<GIMME_V> which can only return
82C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
83Deprecated. Use C<GIMME_V> instead.
84
85=cut
86*/
87
533c011a 88#define GIMME_V OP_GIMME(PL_op, block_gimme())
79072805
LW
89
90/* Public flags */
54310121
PP
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 */
79072805
LW
96#define OPf_KIDS 4 /* There is a firstborn child. */
97#define OPf_PARENS 8 /* This operator was parenthesized. */
463ee0b2 98 /* (Or block needs explicit scope entry.) */
a0d0e21e
LW
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. */
79072805
LW
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. */
a0d0e21e 107 /* On OP_LEAVE, don't restore curpm. */
79072805
LW
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(). */
a2167ea9 112 /* On OP_NULL, saw a "do". */
afebc493 113 /* On OP_EXISTS, treat av as av, not avhv. */
f2ec2afd 114 /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
dbc200c5 115 /* On pushre, rx is used as part of split, e.g. split " " */
497711e7 116 /* On regcomp, "use re 'eval'" was in scope */
17fda545
NC
117 /* On RV2[ACGHS]V, don't create GV--in
118 defined()*/
5df8de69
DM
119 /* On OP_DBSTATE, indicates breakpoint
120 * (runtime property) */
6b514a0d 121 /* On OP_REQUIRE, was seen as CORE::require */
fc7debfb
FC
122 /* On OP_(ENTER|LEAVE)WHEN, there's
123 no condition */
0d863452 124 /* On OP_SMARTMATCH, an implicit smartmatch */
78c72037
NC
125 /* On OP_ANONHASH and OP_ANONLIST, create a
126 reference to the new anon hash or array */
9711599e
CS
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) */
2474a784
FC
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 =~ */
6b7c6d95 134 /* On OP_CONST, from a constant CV */
d67594ff
FC
135 /* On OP_GLOB, two meanings:
136 - Before ck_glob, called as CORE::glob
137 - After ck_glob, use Perl glob function
138 */
d5524600 139 /* On OP_PADRANGE, push @_ */
7d1d69cb 140 /* On OP_DUMP, has no label */
79072805 141
54310121 142/* old names; don't use in new code, but don't break them, either */
d91ab173
GS
143#define OPf_LIST OPf_WANT_LIST
144#define OPf_KNOW OPf_WANT
954c1994 145
54310121 146#define GIMME \
62a559b8
NIS
147 (PL_op->op_flags & OPf_WANT \
148 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
d91ab173
GS
149 ? G_ARRAY \
150 : G_SCALAR) \
151 : dowantarray())
54310121 152
1dafeec8 153
f3574cc6
DM
154/* NOTE: OPp* flags are now auto-generated and defined in opcode.h,
155 * from data in regen/op_private */
d41ff1b8 156
a0d0e21e 157
59f00321 158#define OPpTRANS_ALL (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
79072805 159
97e1065a 160
97e1065a 161
f3574cc6
DM
162/* Mask for OP_ENTERSUB flags, the absence of which must be propagated
163 in dynamic context */
777d9014
FC
164#define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
165
0ef96805
DM
166/* VMS-specific hints in COPs */
167#define OPpHINT_M_VMSISH_MASK (OPpHINT_M_VMSISH_STATUS|OPpHINT_M_VMSISH_TIME)
e664e0a4 168
5db1eb8d 169
60041a09 170
79072805
LW
171struct op {
172 BASEOP
173};
174
175struct unop {
176 BASEOP
177 OP * op_first;
178};
179
180struct binop {
181 BASEOP
182 OP * op_first;
183 OP * op_last;
184};
185
186struct logop {
187 BASEOP
188 OP * op_first;
189 OP * op_other;
190};
191
79072805
LW
192struct listop {
193 BASEOP
194 OP * op_first;
195 OP * op_last;
79072805
LW
196};
197
198struct pmop {
199 BASEOP
200 OP * op_first;
201 OP * op_last;
1fcf4c12 202#ifdef USE_ITHREADS
784e50c8 203 PADOFFSET op_pmoffset;
1fcf4c12
AB
204#else
205 REGEXP * op_pmregexp; /* compiled expression */
206#endif
69bdead3 207 U32 op_pmflags;
29f2e912 208 union {
20e98b0f
NC
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 {
29f2e912 217 OP * op_pmreplstart; /* Only used in OP_SUBST */
cb55de95 218#ifdef USE_ITHREADS
23083432 219 PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
cb55de95 220#else
29f2e912 221 HV * op_pmstash;
cb55de95 222#endif
29f2e912 223 } op_pmstashstartu;
68e2671b 224 OP * op_code_list; /* list of (?{}) code blocks */
79072805 225};
a0d0e21e 226
1fcf4c12 227#ifdef USE_ITHREADS
14a49a24
NC
228#define PM_GETRE(o) (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
229 ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
ede1273d
NC
230/* The assignment is just to enforce type safety (or at least get a warning).
231 */
14a49a24
NC
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. */
ede1273d 238#define PM_SETRE(o,r) STMT_START { \
b1bc3f34 239 REGEXP *const _pm_setre = (r); \
7948fc08 240 assert(_pm_setre); \
b1bc3f34 241 PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
ede1273d 242 } STMT_END
1fcf4c12 243#else
b9ed2502
AB
244#define PM_GETRE(o) ((o)->op_pmregexp)
245#define PM_SETRE(o,r) ((o)->op_pmregexp = (r))
1fcf4c12 246#endif
4825b64b 247
a6cd0fea
KW
248/* Currently these PMf flags occupy a single 32-bit word. Not all bits are
249 * currently used. The lower bits are shared with their corresponding RXf flag
250 * bits, up to but not including _RXf_PMf_SHIFT_NEXT. The unused bits
251 * immediately follow; finally the used Pmf-only (unshared) bits, so that the
252 * highest bit in the word is used. This gathers all the unused bits as a pool
253 * in the middle, like so: 11111111111111110000001111111111
254 * where the '1's represent used bits, and the '0's unused. This design allows
255 * us to allocate off one end of the pool if we need to add a shared bit, and
256 * off the other end if we need a non-shared bit, without disturbing the other
257 * bits. This maximizes the likelihood of being able to change things without
258 * breaking binary compatibility.
259 *
260 * To add shared bits, do so in op_reg_common.h. This should change
261 * _RXf_PMf_SHIFT_NEXT so that things won't compile. Then come to regexp.h and
262 * op.h and adjust the constant adders in the definitions of PMf_BASE_SHIFT and
263 * Pmf_BASE_SHIFT down by the number of shared bits you added. That's it.
264 * Things should be binary compatible. But if either of these gets to having
265 * to subtract rather than add, leave at 0 and adjust all the entries below
266 * that are in terms of this according. But if the first one of those is
267 * already PMf_BASE_SHIFT+0, there are no bits left, and a redesign is in
268 * order.
269 *
270 * To remove unshared bits, just delete its entry. If you're where breaking
271 * binary compatibility is ok to do, you might want to adjust things to move
272 * the newly opened space so that it gets absorbed into the common pool.
273 *
274 * To add unshared bits, first use up any gaps in the middle. Otherwise,
275 * allocate off the low end until you get to PMf_BASE_SHIFT+0. If that isn't
276 * enough, move PMf_BASE_SHIFT down (if possible) and add the new bit at the
277 * other end instead; this preserves binary compatibility. */
334afb3e 278#define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+4)
f4a4cecb 279
ef07e810 280/* 'use re "taint"' in scope: taint $1 etc. if target tainted */
9cba692b 281#define PMf_RETAINT (1U<<(PMf_BASE_SHIFT+5))
c737faaf 282
c0f1c194
KW
283/* match successfully only once per reset, with related flag RXf_USED in
284 * re->extflags holding state. This is used only for ?? matches, and only on
285 * OP_MATCH and OP_QR */
9cba692b 286#define PMf_ONCE (1U<<(PMf_BASE_SHIFT+6))
1850c8f9 287
d234778b 288/* PMf_ONCE, i.e. ?pat?, has matched successfully. Not used under threading. */
9cba692b 289#define PMf_USED (1U<<(PMf_BASE_SHIFT+7))
1850c8f9
KW
290
291/* subst replacement is constant */
9cba692b 292#define PMf_CONST (1U<<(PMf_BASE_SHIFT+8))
c737faaf 293
1850c8f9 294/* keep 1st runtime pattern forever */
9cba692b 295#define PMf_KEEP (1U<<(PMf_BASE_SHIFT+9))
4da3eb8b 296
9cba692b 297#define PMf_GLOBAL (1U<<(PMf_BASE_SHIFT+10)) /* pattern had a g modifier */
c737faaf 298
1850c8f9 299/* don't reset pos() if //g fails */
9cba692b 300#define PMf_CONTINUE (1U<<(PMf_BASE_SHIFT+11))
1850c8f9
KW
301
302/* evaluating replacement as expr */
9cba692b 303#define PMf_EVAL (1U<<(PMf_BASE_SHIFT+12))
c0f1c194
KW
304
305/* Return substituted string instead of modifying it. */
9cba692b 306#define PMf_NONDESTRUCT (1U<<(PMf_BASE_SHIFT+13))
e357fc67 307
d63c20f2 308/* the pattern has a CV attached (currently only under qr/...(?{}).../) */
9cba692b 309#define PMf_HAS_CV (1U<<(PMf_BASE_SHIFT+14))
d63c20f2 310
867940b8
DM
311/* op_code_list is private; don't free it etc. It may well point to
312 * code within another sub, with different pad etc */
9cba692b 313#define PMf_CODELIST_PRIVATE (1U<<(PMf_BASE_SHIFT+15))
867940b8 314
2a92a973
DM
315/* the PMOP is a QR (we should be able to detect that from the op type,
316 * but the regex compilation API passes just the pm flags, not the op
317 * itself */
9cba692b
KW
318#define PMf_IS_QR (1U<<(PMf_BASE_SHIFT+16))
319#define PMf_USE_RE_EVAL (1U<<(PMf_BASE_SHIFT+17)) /* use re'eval' in scope */
a6cd0fea
KW
320
321/* See comments at the beginning of these defines about adding bits. The
322 * highest bit position should be used, so that if PMf_BASE_SHIFT gets
323 * increased, the #error below will be triggered so that you will be reminded
324 * to adjust things at the other end to keep the bit positions unchanged */
325#if PMf_BASE_SHIFT+17 > 31
32cdcf9d 326# error Too many PMf_ bits used. See above and regnodes.h for any spare in middle
1850c8f9 327#endif
79072805 328
cb55de95 329#ifdef USE_ITHREADS
05ec9bb3 330
23083432
FC
331# define PmopSTASH(o) ((o)->op_pmflags & PMf_ONCE \
332 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff] \
333 : NULL)
334# define PmopSTASH_set(o,hv) \
335 (assert_((o)->op_pmflags & PMf_ONCE) \
336 (o)->op_pmstashstartu.op_pmstashoff = \
01f44973 337 (hv) ? alloccopstash(hv) : 0)
cb55de95 338#else
29f2e912
NC
339# define PmopSTASH(o) \
340 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
341# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
342# define PmopSTASH_set(o,hv) ({ \
343 assert((o)->op_pmflags & PMf_ONCE); \
344 ((o)->op_pmstashstartu.op_pmstash = (hv)); \
345 })
346# else
347# define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
348# endif
cb55de95 349#endif
23083432
FC
350#define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
351 /* op_pmstashstartu.op_pmstash is not refcounted */
352#define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
cb55de95 353
79072805
LW
354struct svop {
355 BASEOP
356 SV * op_sv;
357};
358
7934575e 359struct padop {
79072805 360 BASEOP
7934575e 361 PADOFFSET op_padix;
79072805
LW
362};
363
364struct pvop {
365 BASEOP
366 char * op_pv;
367};
368
79072805
LW
369struct loop {
370 BASEOP
371 OP * op_first;
372 OP * op_last;
79072805
LW
373 OP * op_redoop;
374 OP * op_nextop;
375 OP * op_lastop;
376};
377
350de78d
GS
378#define cUNOPx(o) ((UNOP*)o)
379#define cBINOPx(o) ((BINOP*)o)
380#define cLISTOPx(o) ((LISTOP*)o)
381#define cLOGOPx(o) ((LOGOP*)o)
382#define cPMOPx(o) ((PMOP*)o)
383#define cSVOPx(o) ((SVOP*)o)
384#define cPADOPx(o) ((PADOP*)o)
385#define cPVOPx(o) ((PVOP*)o)
386#define cCOPx(o) ((COP*)o)
387#define cLOOPx(o) ((LOOP*)o)
388
389#define cUNOP cUNOPx(PL_op)
390#define cBINOP cBINOPx(PL_op)
391#define cLISTOP cLISTOPx(PL_op)
392#define cLOGOP cLOGOPx(PL_op)
393#define cPMOP cPMOPx(PL_op)
394#define cSVOP cSVOPx(PL_op)
395#define cPADOP cPADOPx(PL_op)
396#define cPVOP cPVOPx(PL_op)
397#define cCOP cCOPx(PL_op)
398#define cLOOP cLOOPx(PL_op)
399
400#define cUNOPo cUNOPx(o)
401#define cBINOPo cBINOPx(o)
402#define cLISTOPo cLISTOPx(o)
403#define cLOGOPo cLOGOPx(o)
404#define cPMOPo cPMOPx(o)
405#define cSVOPo cSVOPx(o)
406#define cPADOPo cPADOPx(o)
407#define cPVOPo cPVOPx(o)
408#define cCOPo cCOPx(o)
409#define cLOOPo cLOOPx(o)
410
411#define kUNOP cUNOPx(kid)
412#define kBINOP cBINOPx(kid)
413#define kLISTOP cLISTOPx(kid)
414#define kLOGOP cLOGOPx(kid)
415#define kPMOP cPMOPx(kid)
416#define kSVOP cSVOPx(kid)
417#define kPADOP cPADOPx(kid)
418#define kPVOP cPVOPx(kid)
419#define kCOP cCOPx(kid)
420#define kLOOP cLOOPx(kid)
421
422
423#ifdef USE_ITHREADS
dd2155a4 424# define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
9429039d
FC
425# ifndef PERL_CORE
426# define IS_PADGV(v) (v && isGV(v))
427# define IS_PADCONST(v) \
f5a0fd1e 428 (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
9429039d 429# endif
7766f137 430# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
dd2155a4 431 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
638eceb6 432# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
dd2155a4 433 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
350de78d 434#else
638eceb6 435# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
9429039d
FC
436# ifndef PERL_CORE
437# define IS_PADGV(v) FALSE
438# define IS_PADCONST(v) FALSE
439# endif
7766f137 440# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
638eceb6 441# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
350de78d 442#endif
79072805 443
638eceb6
GS
444#define cGVOP_gv cGVOPx_gv(PL_op)
445#define cGVOPo_gv cGVOPx_gv(o)
446#define kGVOP_gv cGVOPx_gv(kid)
447#define cSVOP_sv cSVOPx_sv(PL_op)
448#define cSVOPo_sv cSVOPx_sv(o)
449#define kSVOP_sv cSVOPx_sv(kid)
7766f137 450
bcabcc50
NC
451#ifndef PERL_CORE
452# define Nullop ((OP*)NULL)
453#endif
79072805 454
cee4176c 455/* Lowest byte of PL_opargs */
a0d0e21e
LW
456#define OA_MARK 1
457#define OA_FOLDCONST 2
458#define OA_RETSCALAR 4
459#define OA_TARGET 8
903fd87c 460#define OA_TARGLEX 16
a0d0e21e
LW
461#define OA_OTHERINT 32
462#define OA_DANGEROUS 64
463#define OA_DEFGV 128
464
738ec380 465/* The next 4 bits (8..11) encode op class information */
903fd87c 466#define OCSHIFT 8
b162f9ea
IZ
467
468#define OA_CLASS_MASK (15 << OCSHIFT)
469
470#define OA_BASEOP (0 << OCSHIFT)
471#define OA_UNOP (1 << OCSHIFT)
472#define OA_BINOP (2 << OCSHIFT)
473#define OA_LOGOP (3 << OCSHIFT)
1a67a97c
SM
474#define OA_LISTOP (4 << OCSHIFT)
475#define OA_PMOP (5 << OCSHIFT)
476#define OA_SVOP (6 << OCSHIFT)
7934575e 477#define OA_PADOP (7 << OCSHIFT)
1a67a97c
SM
478#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
479#define OA_LOOP (9 << OCSHIFT)
480#define OA_COP (10 << OCSHIFT)
481#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
482#define OA_FILESTATOP (12 << OCSHIFT)
483#define OA_LOOPEXOP (13 << OCSHIFT)
b162f9ea 484
738ec380
DM
485/* Each remaining nybble of PL_opargs (i.e. bits 12..15, 16..19 etc)
486 * encode the type for each arg */
903fd87c 487#define OASHIFT 12
a0d0e21e 488
a0d0e21e
LW
489#define OA_SCALAR 1
490#define OA_LIST 2
491#define OA_AVREF 3
492#define OA_HVREF 4
493#define OA_CVREF 5
494#define OA_FILEREF 6
495#define OA_SCALARREF 7
496#define OA_OPTIONAL 8
497
d3c72c2a
DM
498/* Op_REFCNT is a reference count at the head of each op tree: needed
499 * since the tree is shared between threads, and between cloned closure
500 * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
501 * this count.
502 * The same mutex is used to protect the refcounts of the reg_trie_data
503 * and reg_ac_data structures, which are shared between duplicated
504 * regexes.
505 */
506
534825c4
GS
507#ifdef USE_ITHREADS
508# define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
4026c95a
SH
509# ifdef PERL_CORE
510# define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
511# define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
512# else
513# define OP_REFCNT_LOCK op_refcnt_lock()
514# define OP_REFCNT_UNLOCK op_refcnt_unlock()
515# endif
534825c4 516# define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
534825c4
GS
517#else
518# define OP_REFCNT_INIT NOOP
519# define OP_REFCNT_LOCK NOOP
520# define OP_REFCNT_UNLOCK NOOP
521# define OP_REFCNT_TERM NOOP
534825c4 522#endif
e4783991 523
282f25c9 524#define OpREFCNT_set(o,n) ((o)->op_targ = (n))
fc97af9c
NC
525#ifdef PERL_DEBUG_READONLY_OPS
526# define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o)
527# define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o)
528#else
529# define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL)
530# define OpREFCNT_dec(o) (--(o)->op_targ)
531#endif
282f25c9 532
e4783991 533/* flags used by Perl_load_module() */
ec6d81ab
RGS
534#define PERL_LOADMOD_DENY 0x1 /* no Module */
535#define PERL_LOADMOD_NOIMPORT 0x2 /* use Module () */
466f50cc
FC
536#define PERL_LOADMOD_IMPORT_OPS 0x4 /* import arguments
537 are passed as a sin-
538 gle op tree, not a
539 list of SVs */
e5dd39fc 540
30d9c59b 541#if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
e4c5ccf3 542#define ref(o, type) doref(o, type, TRUE)
a0c21aa1 543#endif
e4c5ccf3 544
5983a79d
BM
545/*
546=head1 Optree Manipulation Functions
547
548=for apidoc Am|OP*|LINKLIST|OP *o
549Given the root of an optree, link the tree in execution order using the
72d33970 550C<op_next> pointers and return the first op executed. If this has
5983a79d 551already been done, it will not be redone, and C<< o->op_next >> will be
72d33970 552returned. If C<< o->op_next >> is not already set, I<o> should be at
5983a79d
BM
553least an C<UNOP>.
554
555=cut
556*/
557
558#define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
559
33f36c71
NC
560/* no longer used anywhere in core */
561#ifndef PERL_CORE
46471bde 562#define cv_ckproto(cv, gv, p) \
f717afa7 563 cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
33f36c71
NC
564#endif
565
7d0905b9
NC
566#ifdef PERL_CORE
567# define my(o) my_attrs((o), NULL)
568#endif
569
e5dd39fc 570#ifdef USE_REENTRANT_API
10bc17b6 571#include "reentr.h"
e5dd39fc
AB
572#endif
573
c7e45529 574#define NewOp(m,var,c,type) \
e91d68d5 575 (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
c7e45529 576#define NewOpSz(m,var,size) \
e91d68d5 577 (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
c7e45529 578#define FreeOp(p) Perl_Slab_Free(aTHX_ p)
8be227ab
FC
579
580/*
581 * The per-CV op slabs consist of a header (the opslab struct) and a bunch
582 * of space for allocating op slots, each of which consists of two pointers
583 * followed by an op. The first pointer points to the next op slot. The
584 * second points to the slab. At the end of the slab is a null pointer,
585 * so that slot->opslot_next - slot can be used to determine the size
586 * of the op.
587 *
588 * Each CV can have multiple slabs; opslab_next points to the next slab, to
589 * form a chain. All bookkeeping is done on the first slab, which is where
590 * all the op slots point.
591 *
592 * Freed ops are marked as freed and attached to the freed chain
593 * via op_next pointers.
594 *
595 * When there is more than one slab, the second slab in the slab chain is
596 * assumed to be the one with free space available. It is used when allo-
597 * cating an op if there are no freed ops available or big enough.
598 */
599
7aef8e5b 600#ifdef PERL_CORE
8be227ab
FC
601struct opslot {
602 /* keep opslot_next first */
603 OPSLOT * opslot_next; /* next slot */
604 OPSLAB * opslot_slab; /* owner */
605 OP opslot_op; /* the op itself */
606};
607
608struct opslab {
609 OPSLOT * opslab_first; /* first op in this slab */
610 OPSLAB * opslab_next; /* next slab */
611 OP * opslab_freed; /* chain of freed ops */
612 size_t opslab_refcnt; /* number of ops */
3107b51f
FC
613# ifdef PERL_DEBUG_READONLY_OPS
614 U16 opslab_size; /* size of slab in pointers */
615 bool opslab_readonly;
616# endif
8be227ab
FC
617 OPSLOT opslab_slots; /* slots begin here */
618};
619
620# define OPSLOT_HEADER STRUCT_OFFSET(OPSLOT, opslot_op)
621# define OPSLOT_HEADER_P (OPSLOT_HEADER/sizeof(I32 *))
c7724415 622# define OpSLOT(o) (assert_(o->op_slabbed) \
8be227ab 623 (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
8be227ab
FC
624# define OpSLAB(o) OpSLOT(o)->opslot_slab
625# define OpslabREFCNT_dec(slab) \
626 (((slab)->opslab_refcnt == 1) \
627 ? opslab_free_nopad(slab) \
628 : (void)--(slab)->opslab_refcnt)
629 /* Variant that does not null out the pads */
630# define OpslabREFCNT_dec_padok(slab) \
631 (((slab)->opslab_refcnt == 1) \
632 ? opslab_free(slab) \
633 : (void)--(slab)->opslab_refcnt)
c7e45529 634#endif
598921a7 635
1930840b 636struct block_hooks {
52db365a 637 U32 bhk_flags;
1930840b
BM
638 void (*bhk_start) (pTHX_ int full);
639 void (*bhk_pre_end) (pTHX_ OP **seq);
640 void (*bhk_post_end) (pTHX_ OP **seq);
52db365a 641 void (*bhk_eval) (pTHX_ OP *const saveop);
1930840b
BM
642};
643
fd85fad2
BM
644/*
645=head1 Compile-time scope hooks
646
3e4ddde5 647=for apidoc mx|U32|BhkFLAGS|BHK *hk
fd85fad2
BM
648Return the BHK's flags.
649
3e4ddde5 650=for apidoc mx|void *|BhkENTRY|BHK *hk|which
72d33970
FC
651Return an entry from the BHK structure. I<which> is a preprocessor token
652indicating which entry to return. If the appropriate flag is not set
653this will return NULL. The type of the return value depends on which
fd85fad2
BM
654entry you ask for.
655
3e4ddde5 656=for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
fd85fad2 657Set an entry in the BHK structure, and set the flags to indicate it is
72d33970 658valid. I<which> is a preprocessing token indicating which entry to set.
fd85fad2
BM
659The type of I<ptr> depends on the entry.
660
3e4ddde5 661=for apidoc Amx|void|BhkDISABLE|BHK *hk|which
a3e07c87 662Temporarily disable an entry in this BHK structure, by clearing the
72d33970 663appropriate flag. I<which> is a preprocessor token indicating which
a3e07c87
BM
664entry to disable.
665
3e4ddde5 666=for apidoc Amx|void|BhkENABLE|BHK *hk|which
a3e07c87 667Re-enable an entry in this BHK structure, by setting the appropriate
72d33970 668flag. I<which> is a preprocessor token indicating which entry to enable.
a3e07c87
BM
669This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
670pointer.
671
3e4ddde5 672=for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
72d33970 673Call all the registered block hooks for type I<which>. I<which> is a
fd85fad2
BM
674preprocessing token; the type of I<arg> depends on I<which>.
675
676=cut
677*/
678
52db365a
BM
679#define BhkFLAGS(hk) ((hk)->bhk_flags)
680
a88d97bf
BM
681#define BHKf_bhk_start 0x01
682#define BHKf_bhk_pre_end 0x02
683#define BHKf_bhk_post_end 0x04
684#define BHKf_bhk_eval 0x08
52db365a
BM
685
686#define BhkENTRY(hk, which) \
a88d97bf 687 ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
52db365a 688
a3e07c87
BM
689#define BhkENABLE(hk, which) \
690 STMT_START { \
691 BhkFLAGS(hk) |= BHKf_ ## which; \
692 assert(BhkENTRY(hk, which)); \
693 } STMT_END
694
695#define BhkDISABLE(hk, which) \
696 STMT_START { \
697 BhkFLAGS(hk) &= ~(BHKf_ ## which); \
698 } STMT_END
699
52db365a
BM
700#define BhkENTRY_set(hk, which, ptr) \
701 STMT_START { \
a88d97bf 702 (hk)->which = ptr; \
a3e07c87 703 BhkENABLE(hk, which); \
52db365a
BM
704 } STMT_END
705
1930840b
BM
706#define CALL_BLOCK_HOOKS(which, arg) \
707 STMT_START { \
708 if (PL_blockhooks) { \
c70927a6 709 SSize_t i; \
b9f2b683 710 for (i = av_tindex(PL_blockhooks); i >= 0; i--) { \
1930840b 711 SV *sv = AvARRAY(PL_blockhooks)[i]; \
52db365a 712 BHK *hk; \
1930840b
BM
713 \
714 assert(SvIOK(sv)); \
715 if (SvUOK(sv)) \
52db365a 716 hk = INT2PTR(BHK *, SvUVX(sv)); \
1930840b 717 else \
52db365a 718 hk = INT2PTR(BHK *, SvIVX(sv)); \
1930840b 719 \
52db365a 720 if (BhkENTRY(hk, which)) \
16c91539 721 BhkENTRY(hk, which)(aTHX_ arg); \
1930840b
BM
722 } \
723 } \
724 } STMT_END
725
d9088386
Z
726/* flags for rv2cv_op_cv */
727
728#define RV2CVOPCV_MARK_EARLY 0x00000001
729#define RV2CVOPCV_RETURN_NAME_GV 0x00000002
211a4342 730#define RV2CVOPCV_RETURN_STUB 0x00000004
9c98a81f
FC
731#ifdef PERL_CORE /* behaviour of this flag is subject to change: */
732# define RV2CVOPCV_MAYBE_NAME_GV 0x00000008
733#endif
734#define RV2CVOPCV_FLAG_MASK 0x0000000f /* all of the above */
d9088386 735
d3d7d28f
FC
736#define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
737
f5d552b4
FC
738/* flags for op_lvalue_flags */
739
740#define OP_LVALUE_NO_CROAK 1
741
9733086d
BM
742/*
743=head1 Custom Operators
744
745=for apidoc Am|U32|XopFLAGS|XOP *xop
746Return the XOP's flags.
747
748=for apidoc Am||XopENTRY|XOP *xop|which
72d33970
FC
749Return a member of the XOP structure. I<which> is a cpp token
750indicating which entry to return. If the member is not set
751this will return a default value. The return type depends
752on I<which>. This macro evaluates its arguments more than
753once. If you are using C<Perl_custom_op_xop> to retreive a
ae103e09
DD
754C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead.
755
756=for apidoc Am||XopENTRYCUSTOM|const OP *o|which
757Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more
72d33970 758efficient. The I<which> parameter is identical to L</XopENTRY>.
9733086d
BM
759
760=for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
72d33970
FC
761Set a member of the XOP structure. I<which> is a cpp token
762indicating which entry to set. See L<perlguts/"Custom Operators">
763for details about the available members and how
764they are used. This macro evaluates its argument
ae103e09 765more than once.
9733086d
BM
766
767=for apidoc Am|void|XopDISABLE|XOP *xop|which
768Temporarily disable a member of the XOP, by clearing the appropriate flag.
769
770=for apidoc Am|void|XopENABLE|XOP *xop|which
771Reenable a member of the XOP which has been disabled.
772
773=cut
774*/
775
1830b3d9
BM
776struct custom_op {
777 U32 xop_flags;
778 const char *xop_name;
779 const char *xop_desc;
780 U32 xop_class;
781 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
782};
783
ae103e09
DD
784/* return value of Perl_custom_op_get_field, similar to void * then casting but
785 the U32 doesn't need truncation on 64 bit platforms in the caller, also
786 for easier macro writing */
787typedef union {
788 const char *xop_name;
789 const char *xop_desc;
790 U32 xop_class;
791 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
792 XOP *xop_ptr;
793} XOPRETANY;
794
1830b3d9
BM
795#define XopFLAGS(xop) ((xop)->xop_flags)
796
797#define XOPf_xop_name 0x01
798#define XOPf_xop_desc 0x02
799#define XOPf_xop_class 0x04
800#define XOPf_xop_peep 0x08
801
ae103e09
DD
802/* used by Perl_custom_op_get_field for option checking */
803typedef enum {
804 XOPe_xop_ptr = 0, /* just get the XOP *, don't look inside it */
805 XOPe_xop_name = XOPf_xop_name,
806 XOPe_xop_desc = XOPf_xop_desc,
807 XOPe_xop_class = XOPf_xop_class,
4a3798ca 808 XOPe_xop_peep = XOPf_xop_peep
ae103e09
DD
809} xop_flags_enum;
810
1830b3d9
BM
811#define XOPd_xop_name PL_op_name[OP_CUSTOM]
812#define XOPd_xop_desc PL_op_desc[OP_CUSTOM]
813#define XOPd_xop_class OA_BASEOP
814#define XOPd_xop_peep ((Perl_cpeep_t)0)
815
816#define XopENTRY_set(xop, which, to) \
817 STMT_START { \
818 (xop)->which = (to); \
819 (xop)->xop_flags |= XOPf_ ## which; \
820 } STMT_END
821
822#define XopENTRY(xop, which) \
823 ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
824
ae103e09
DD
825#define XopENTRYCUSTOM(o, which) \
826 (Perl_custom_op_get_field(aTHX_ o, XOPe_ ## which).which)
827
1830b3d9
BM
828#define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
829#define XopENABLE(xop, which) \
830 STMT_START { \
831 (xop)->xop_flags |= XOPf_ ## which; \
832 assert(XopENTRY(xop, which)); \
833 } STMT_END
834
ae103e09
DD
835#define Perl_custom_op_xop(x) \
836 (Perl_custom_op_get_field(x, XOPe_xop_ptr).xop_ptr)
837
9733086d
BM
838/*
839=head1 Optree Manipulation Functions
840
841=for apidoc Am|const char *|OP_NAME|OP *o
72d33970 842Return the name of the provided OP. For core ops this looks up the name
9733086d
BM
843from the op_type; for custom ops from the op_ppaddr.
844
845=for apidoc Am|const char *|OP_DESC|OP *o
846Return a short description of the provided OP.
847
848=for apidoc Am|U32|OP_CLASS|OP *o
849Return the class of the provided OP: that is, which of the *OP
72d33970 850structures it uses. For core ops this currently gets the information out
9733086d
BM
851of PL_opargs, which does not always accurately reflect the type used.
852For custom ops the type is returned from the registration, and it is up
72d33970 853to the registree to ensure it is accurate. The value returned will be
9733086d
BM
854one of the OA_* constants from op.h.
855
437e3a7d 856=for apidoc Am|bool|OP_TYPE_IS|OP *o, Optype type
11ee9dd6
SM
857Returns true if the given OP is not a NULL pointer
858and if it is of the given type.
859
860The negation of this macro, C<OP_TYPE_ISNT> is also available
861as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide
862the NULL pointer check.
863
864=for apidoc Am|bool|OP_TYPE_IS_OR_WAS|OP *o, Optype type
865Returns true if the given OP is not a NULL pointer and
866if it is of the given type or used to be before being
867replaced by an OP of type OP_NULL.
868
869The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT>
870is also available as well as C<OP_TYPE_IS_OR_WAS_NN>
871and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide
872the NULL pointer check.
873
1ed44841
DM
874=for apidoc Am|bool|OP_HAS_SIBLING|OP *o
875Returns true if o has a sibling
876
877=for apidoc Am|bool|OP_SIBLING|OP *o
878Returns the sibling of o, or NULL if there is no sibling
879
880=for apidoc Am|bool|OP_SIBLING_set|OP *o|OP *sib
881Sets the sibling of o to sib
882
9733086d
BM
883=cut
884*/
885
1830b3d9 886#define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
ae103e09 887 ? XopENTRYCUSTOM(o, xop_name) \
1830b3d9
BM
888 : PL_op_name[(o)->op_type])
889#define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
ae103e09 890 ? XopENTRYCUSTOM(o, xop_desc) \
1830b3d9
BM
891 : PL_op_desc[(o)->op_type])
892#define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
ae103e09 893 ? XopENTRYCUSTOM(o, xop_class) \
1830b3d9
BM
894 : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
895
437e3a7d 896#define OP_TYPE_IS(o, type) ((o) && (o)->op_type == (type))
11ee9dd6
SM
897#define OP_TYPE_IS_NN(o, type) ((o)->op_type == (type))
898#define OP_TYPE_ISNT(o, type) ((o) && (o)->op_type != (type))
899#define OP_TYPE_ISNT_NN(o, type) ((o)->op_type != (type))
900
901#define OP_TYPE_IS_OR_WAS_NN(o, type) \
902 ( ((o)->op_type == OP_NULL \
903 ? (o)->op_targ \
904 : (o)->op_type) \
905 == (type) )
906
907#define OP_TYPE_IS_OR_WAS(o, type) \
908 ( (o) && OP_TYPE_IS_OR_WAS_NN(o, type) )
909
910#define OP_TYPE_ISNT_AND_WASNT_NN(o, type) \
911 ( ((o)->op_type == OP_NULL \
912 ? (o)->op_targ \
913 : (o)->op_type) \
914 != (type) )
915
916#define OP_TYPE_ISNT_AND_WASNT(o, type) \
917 ( (o) && OP_TYPE_ISNT_AND_WASNT_NN(o, type) )
437e3a7d 918
29e61fd9
DM
919#ifdef PERL_OP_PARENT
920# define OP_HAS_SIBLING(o) (!cBOOL((o)->op_lastsib))
921# define OP_SIBLING(o) (0 + (o)->op_lastsib ? NULL : (o)->op_sibling)
922# define OP_SIBLING_set(o, sib) ((o)->op_sibling = (sib))
923#else
924# define OP_HAS_SIBLING(o) (cBOOL((o)->op_sibling))
925# define OP_SIBLING(o) (0 + (o)->op_sibling)
926# define OP_SIBLING_set(o, sib) ((o)->op_sibling = (sib))
927#endif
1ed44841 928
e8f91c91
DD
929#define newATTRSUB(f, o, p, a, b) Perl_newATTRSUB_x(aTHX_ f, o, p, a, b, FALSE)
930#define newSUB(f, o, p, b) newATTRSUB((f), (o), (p), NULL, (b))
7bff8c33 931
3f2908ec 932/*
e8570548
Z
933=head1 Hook manipulation
934*/
935
936#ifdef USE_ITHREADS
937# define OP_CHECK_MUTEX_INIT MUTEX_INIT(&PL_check_mutex)
938# define OP_CHECK_MUTEX_LOCK MUTEX_LOCK(&PL_check_mutex)
939# define OP_CHECK_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_check_mutex)
940# define OP_CHECK_MUTEX_TERM MUTEX_DESTROY(&PL_check_mutex)
941#else
942# define OP_CHECK_MUTEX_INIT NOOP
943# define OP_CHECK_MUTEX_LOCK NOOP
944# define OP_CHECK_MUTEX_UNLOCK NOOP
945# define OP_CHECK_MUTEX_TERM NOOP
946#endif
947
948/*
3f2908ec
NC
949 * Local variables:
950 * c-indentation-style: bsd
951 * c-basic-offset: 4
14d04a33 952 * indent-tabs-mode: nil
3f2908ec
NC
953 * End:
954 *
14d04a33 955 * ex: set ts=8 sts=4 sw=4 et:
3f2908ec 956 */