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