This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
regexp.h: Comment shared-pool free bits scheme
[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(). */
a0d0e21e 112 /* On OP_ENTERSUB || 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
beae72ee
KW
248/* Leave some space, so future bit allocations can go either in the shared or
249 * unshared area without affecting binary compatibility */
df7a8460 250#define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+6)
f4a4cecb 251
ef07e810 252/* 'use re "taint"' in scope: taint $1 etc. if target tainted */
1ad4ec54 253#define PMf_RETAINT (1<<(PMf_BASE_SHIFT+0))
c737faaf 254
c0f1c194
KW
255/* match successfully only once per reset, with related flag RXf_USED in
256 * re->extflags holding state. This is used only for ?? matches, and only on
257 * OP_MATCH and OP_QR */
1ad4ec54 258#define PMf_ONCE (1<<(PMf_BASE_SHIFT+1))
1850c8f9 259
d234778b 260/* PMf_ONCE, i.e. ?pat?, has matched successfully. Not used under threading. */
1ad4ec54 261#define PMf_USED (1<<(PMf_BASE_SHIFT+3))
1850c8f9
KW
262
263/* subst replacement is constant */
1ad4ec54 264#define PMf_CONST (1<<(PMf_BASE_SHIFT+4))
c737faaf 265
1850c8f9 266/* keep 1st runtime pattern forever */
1ad4ec54 267#define PMf_KEEP (1<<(PMf_BASE_SHIFT+5))
4da3eb8b 268
1ad4ec54 269#define PMf_GLOBAL (1<<(PMf_BASE_SHIFT+6)) /* pattern had a g modifier */
c737faaf 270
1850c8f9 271/* don't reset pos() if //g fails */
1ad4ec54 272#define PMf_CONTINUE (1<<(PMf_BASE_SHIFT+7))
1850c8f9
KW
273
274/* evaluating replacement as expr */
1ad4ec54 275#define PMf_EVAL (1<<(PMf_BASE_SHIFT+8))
c0f1c194
KW
276
277/* Return substituted string instead of modifying it. */
1ad4ec54 278#define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+9))
e357fc67 279
d63c20f2
DM
280/* the pattern has a CV attached (currently only under qr/...(?{}).../) */
281#define PMf_HAS_CV (1<<(PMf_BASE_SHIFT+10))
282
867940b8
DM
283/* op_code_list is private; don't free it etc. It may well point to
284 * code within another sub, with different pad etc */
285#define PMf_CODELIST_PRIVATE (1<<(PMf_BASE_SHIFT+11))
286
2a92a973
DM
287/* the PMOP is a QR (we should be able to detect that from the op type,
288 * but the regex compilation API passes just the pm flags, not the op
289 * itself */
290#define PMf_IS_QR (1<<(PMf_BASE_SHIFT+12))
a5ae69f0 291#define PMf_USE_RE_EVAL (1<<(PMf_BASE_SHIFT+13)) /* use re'eval' in scope */
2a92a973 292
a5ae69f0 293#if PMf_BASE_SHIFT+13 > 31
32cdcf9d 294# error Too many PMf_ bits used. See above and regnodes.h for any spare in middle
1850c8f9 295#endif
79072805 296
cb55de95 297#ifdef USE_ITHREADS
05ec9bb3 298
23083432
FC
299# define PmopSTASH(o) ((o)->op_pmflags & PMf_ONCE \
300 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff] \
301 : NULL)
302# define PmopSTASH_set(o,hv) \
303 (assert_((o)->op_pmflags & PMf_ONCE) \
304 (o)->op_pmstashstartu.op_pmstashoff = \
01f44973 305 (hv) ? alloccopstash(hv) : 0)
cb55de95 306#else
29f2e912
NC
307# define PmopSTASH(o) \
308 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
309# if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
310# define PmopSTASH_set(o,hv) ({ \
311 assert((o)->op_pmflags & PMf_ONCE); \
312 ((o)->op_pmstashstartu.op_pmstash = (hv)); \
313 })
314# else
315# define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
316# endif
cb55de95 317#endif
23083432
FC
318#define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
319 /* op_pmstashstartu.op_pmstash is not refcounted */
320#define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
cb55de95 321
79072805
LW
322struct svop {
323 BASEOP
324 SV * op_sv;
325};
326
7934575e 327struct padop {
79072805 328 BASEOP
7934575e 329 PADOFFSET op_padix;
79072805
LW
330};
331
332struct pvop {
333 BASEOP
334 char * op_pv;
335};
336
79072805
LW
337struct loop {
338 BASEOP
339 OP * op_first;
340 OP * op_last;
79072805
LW
341 OP * op_redoop;
342 OP * op_nextop;
343 OP * op_lastop;
344};
345
350de78d
GS
346#define cUNOPx(o) ((UNOP*)o)
347#define cBINOPx(o) ((BINOP*)o)
348#define cLISTOPx(o) ((LISTOP*)o)
349#define cLOGOPx(o) ((LOGOP*)o)
350#define cPMOPx(o) ((PMOP*)o)
351#define cSVOPx(o) ((SVOP*)o)
352#define cPADOPx(o) ((PADOP*)o)
353#define cPVOPx(o) ((PVOP*)o)
354#define cCOPx(o) ((COP*)o)
355#define cLOOPx(o) ((LOOP*)o)
356
357#define cUNOP cUNOPx(PL_op)
358#define cBINOP cBINOPx(PL_op)
359#define cLISTOP cLISTOPx(PL_op)
360#define cLOGOP cLOGOPx(PL_op)
361#define cPMOP cPMOPx(PL_op)
362#define cSVOP cSVOPx(PL_op)
363#define cPADOP cPADOPx(PL_op)
364#define cPVOP cPVOPx(PL_op)
365#define cCOP cCOPx(PL_op)
366#define cLOOP cLOOPx(PL_op)
367
368#define cUNOPo cUNOPx(o)
369#define cBINOPo cBINOPx(o)
370#define cLISTOPo cLISTOPx(o)
371#define cLOGOPo cLOGOPx(o)
372#define cPMOPo cPMOPx(o)
373#define cSVOPo cSVOPx(o)
374#define cPADOPo cPADOPx(o)
375#define cPVOPo cPVOPx(o)
376#define cCOPo cCOPx(o)
377#define cLOOPo cLOOPx(o)
378
379#define kUNOP cUNOPx(kid)
380#define kBINOP cBINOPx(kid)
381#define kLISTOP cLISTOPx(kid)
382#define kLOGOP cLOGOPx(kid)
383#define kPMOP cPMOPx(kid)
384#define kSVOP cSVOPx(kid)
385#define kPADOP cPADOPx(kid)
386#define kPVOP cPVOPx(kid)
387#define kCOP cCOPx(kid)
388#define kLOOP cLOOPx(kid)
389
390
391#ifdef USE_ITHREADS
dd2155a4 392# define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
9429039d
FC
393# ifndef PERL_CORE
394# define IS_PADGV(v) (v && isGV(v))
395# define IS_PADCONST(v) \
f5a0fd1e 396 (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
9429039d 397# endif
7766f137 398# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
dd2155a4 399 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
638eceb6 400# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
dd2155a4 401 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
350de78d 402#else
638eceb6 403# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
9429039d
FC
404# ifndef PERL_CORE
405# define IS_PADGV(v) FALSE
406# define IS_PADCONST(v) FALSE
407# endif
7766f137 408# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
638eceb6 409# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
350de78d 410#endif
79072805 411
638eceb6
GS
412#define cGVOP_gv cGVOPx_gv(PL_op)
413#define cGVOPo_gv cGVOPx_gv(o)
414#define kGVOP_gv cGVOPx_gv(kid)
415#define cSVOP_sv cSVOPx_sv(PL_op)
416#define cSVOPo_sv cSVOPx_sv(o)
417#define kSVOP_sv cSVOPx_sv(kid)
7766f137 418
bcabcc50
NC
419#ifndef PERL_CORE
420# define Nullop ((OP*)NULL)
421#endif
79072805 422
cee4176c 423/* Lowest byte of PL_opargs */
a0d0e21e
LW
424#define OA_MARK 1
425#define OA_FOLDCONST 2
426#define OA_RETSCALAR 4
427#define OA_TARGET 8
903fd87c 428#define OA_TARGLEX 16
a0d0e21e
LW
429#define OA_OTHERINT 32
430#define OA_DANGEROUS 64
431#define OA_DEFGV 128
432
738ec380 433/* The next 4 bits (8..11) encode op class information */
903fd87c 434#define OCSHIFT 8
b162f9ea
IZ
435
436#define OA_CLASS_MASK (15 << OCSHIFT)
437
438#define OA_BASEOP (0 << OCSHIFT)
439#define OA_UNOP (1 << OCSHIFT)
440#define OA_BINOP (2 << OCSHIFT)
441#define OA_LOGOP (3 << OCSHIFT)
1a67a97c
SM
442#define OA_LISTOP (4 << OCSHIFT)
443#define OA_PMOP (5 << OCSHIFT)
444#define OA_SVOP (6 << OCSHIFT)
7934575e 445#define OA_PADOP (7 << OCSHIFT)
1a67a97c
SM
446#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
447#define OA_LOOP (9 << OCSHIFT)
448#define OA_COP (10 << OCSHIFT)
449#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
450#define OA_FILESTATOP (12 << OCSHIFT)
451#define OA_LOOPEXOP (13 << OCSHIFT)
b162f9ea 452
738ec380
DM
453/* Each remaining nybble of PL_opargs (i.e. bits 12..15, 16..19 etc)
454 * encode the type for each arg */
903fd87c 455#define OASHIFT 12
a0d0e21e 456
a0d0e21e
LW
457#define OA_SCALAR 1
458#define OA_LIST 2
459#define OA_AVREF 3
460#define OA_HVREF 4
461#define OA_CVREF 5
462#define OA_FILEREF 6
463#define OA_SCALARREF 7
464#define OA_OPTIONAL 8
465
d3c72c2a
DM
466/* Op_REFCNT is a reference count at the head of each op tree: needed
467 * since the tree is shared between threads, and between cloned closure
468 * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
469 * this count.
470 * The same mutex is used to protect the refcounts of the reg_trie_data
471 * and reg_ac_data structures, which are shared between duplicated
472 * regexes.
473 */
474
534825c4
GS
475#ifdef USE_ITHREADS
476# define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
4026c95a
SH
477# ifdef PERL_CORE
478# define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
479# define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
480# else
481# define OP_REFCNT_LOCK op_refcnt_lock()
482# define OP_REFCNT_UNLOCK op_refcnt_unlock()
483# endif
534825c4 484# define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
534825c4
GS
485#else
486# define OP_REFCNT_INIT NOOP
487# define OP_REFCNT_LOCK NOOP
488# define OP_REFCNT_UNLOCK NOOP
489# define OP_REFCNT_TERM NOOP
534825c4 490#endif
e4783991 491
282f25c9 492#define OpREFCNT_set(o,n) ((o)->op_targ = (n))
fc97af9c
NC
493#ifdef PERL_DEBUG_READONLY_OPS
494# define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o)
495# define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o)
496#else
497# define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL)
498# define OpREFCNT_dec(o) (--(o)->op_targ)
499#endif
282f25c9 500
e4783991 501/* flags used by Perl_load_module() */
ec6d81ab
RGS
502#define PERL_LOADMOD_DENY 0x1 /* no Module */
503#define PERL_LOADMOD_NOIMPORT 0x2 /* use Module () */
466f50cc
FC
504#define PERL_LOADMOD_IMPORT_OPS 0x4 /* import arguments
505 are passed as a sin-
506 gle op tree, not a
507 list of SVs */
e5dd39fc 508
30d9c59b 509#if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
e4c5ccf3 510#define ref(o, type) doref(o, type, TRUE)
a0c21aa1 511#endif
e4c5ccf3 512
5983a79d
BM
513/*
514=head1 Optree Manipulation Functions
515
516=for apidoc Am|OP*|LINKLIST|OP *o
517Given the root of an optree, link the tree in execution order using the
72d33970 518C<op_next> pointers and return the first op executed. If this has
5983a79d 519already been done, it will not be redone, and C<< o->op_next >> will be
72d33970 520returned. If C<< o->op_next >> is not already set, I<o> should be at
5983a79d
BM
521least an C<UNOP>.
522
523=cut
524*/
525
526#define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
527
33f36c71
NC
528/* no longer used anywhere in core */
529#ifndef PERL_CORE
46471bde 530#define cv_ckproto(cv, gv, p) \
f717afa7 531 cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
33f36c71
NC
532#endif
533
7d0905b9
NC
534#ifdef PERL_CORE
535# define my(o) my_attrs((o), NULL)
536#endif
537
e5dd39fc 538#ifdef USE_REENTRANT_API
10bc17b6 539#include "reentr.h"
e5dd39fc
AB
540#endif
541
c7e45529 542#define NewOp(m,var,c,type) \
e91d68d5 543 (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
c7e45529 544#define NewOpSz(m,var,size) \
e91d68d5 545 (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
c7e45529 546#define FreeOp(p) Perl_Slab_Free(aTHX_ p)
8be227ab
FC
547
548/*
549 * The per-CV op slabs consist of a header (the opslab struct) and a bunch
550 * of space for allocating op slots, each of which consists of two pointers
551 * followed by an op. The first pointer points to the next op slot. The
552 * second points to the slab. At the end of the slab is a null pointer,
553 * so that slot->opslot_next - slot can be used to determine the size
554 * of the op.
555 *
556 * Each CV can have multiple slabs; opslab_next points to the next slab, to
557 * form a chain. All bookkeeping is done on the first slab, which is where
558 * all the op slots point.
559 *
560 * Freed ops are marked as freed and attached to the freed chain
561 * via op_next pointers.
562 *
563 * When there is more than one slab, the second slab in the slab chain is
564 * assumed to be the one with free space available. It is used when allo-
565 * cating an op if there are no freed ops available or big enough.
566 */
567
7aef8e5b 568#ifdef PERL_CORE
8be227ab
FC
569struct opslot {
570 /* keep opslot_next first */
571 OPSLOT * opslot_next; /* next slot */
572 OPSLAB * opslot_slab; /* owner */
573 OP opslot_op; /* the op itself */
574};
575
576struct opslab {
577 OPSLOT * opslab_first; /* first op in this slab */
578 OPSLAB * opslab_next; /* next slab */
579 OP * opslab_freed; /* chain of freed ops */
580 size_t opslab_refcnt; /* number of ops */
3107b51f
FC
581# ifdef PERL_DEBUG_READONLY_OPS
582 U16 opslab_size; /* size of slab in pointers */
583 bool opslab_readonly;
584# endif
8be227ab
FC
585 OPSLOT opslab_slots; /* slots begin here */
586};
587
588# define OPSLOT_HEADER STRUCT_OFFSET(OPSLOT, opslot_op)
589# define OPSLOT_HEADER_P (OPSLOT_HEADER/sizeof(I32 *))
c7724415 590# define OpSLOT(o) (assert_(o->op_slabbed) \
8be227ab 591 (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
8be227ab
FC
592# define OpSLAB(o) OpSLOT(o)->opslot_slab
593# define OpslabREFCNT_dec(slab) \
594 (((slab)->opslab_refcnt == 1) \
595 ? opslab_free_nopad(slab) \
596 : (void)--(slab)->opslab_refcnt)
597 /* Variant that does not null out the pads */
598# define OpslabREFCNT_dec_padok(slab) \
599 (((slab)->opslab_refcnt == 1) \
600 ? opslab_free(slab) \
601 : (void)--(slab)->opslab_refcnt)
c7e45529 602#endif
598921a7 603
1930840b 604struct block_hooks {
52db365a 605 U32 bhk_flags;
1930840b
BM
606 void (*bhk_start) (pTHX_ int full);
607 void (*bhk_pre_end) (pTHX_ OP **seq);
608 void (*bhk_post_end) (pTHX_ OP **seq);
52db365a 609 void (*bhk_eval) (pTHX_ OP *const saveop);
1930840b
BM
610};
611
fd85fad2
BM
612/*
613=head1 Compile-time scope hooks
614
3e4ddde5 615=for apidoc mx|U32|BhkFLAGS|BHK *hk
fd85fad2
BM
616Return the BHK's flags.
617
3e4ddde5 618=for apidoc mx|void *|BhkENTRY|BHK *hk|which
72d33970
FC
619Return an entry from the BHK structure. I<which> is a preprocessor token
620indicating which entry to return. If the appropriate flag is not set
621this will return NULL. The type of the return value depends on which
fd85fad2
BM
622entry you ask for.
623
3e4ddde5 624=for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
fd85fad2 625Set an entry in the BHK structure, and set the flags to indicate it is
72d33970 626valid. I<which> is a preprocessing token indicating which entry to set.
fd85fad2
BM
627The type of I<ptr> depends on the entry.
628
3e4ddde5 629=for apidoc Amx|void|BhkDISABLE|BHK *hk|which
a3e07c87 630Temporarily disable an entry in this BHK structure, by clearing the
72d33970 631appropriate flag. I<which> is a preprocessor token indicating which
a3e07c87
BM
632entry to disable.
633
3e4ddde5 634=for apidoc Amx|void|BhkENABLE|BHK *hk|which
a3e07c87 635Re-enable an entry in this BHK structure, by setting the appropriate
72d33970 636flag. I<which> is a preprocessor token indicating which entry to enable.
a3e07c87
BM
637This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
638pointer.
639
3e4ddde5 640=for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
72d33970 641Call all the registered block hooks for type I<which>. I<which> is a
fd85fad2
BM
642preprocessing token; the type of I<arg> depends on I<which>.
643
644=cut
645*/
646
52db365a
BM
647#define BhkFLAGS(hk) ((hk)->bhk_flags)
648
a88d97bf
BM
649#define BHKf_bhk_start 0x01
650#define BHKf_bhk_pre_end 0x02
651#define BHKf_bhk_post_end 0x04
652#define BHKf_bhk_eval 0x08
52db365a
BM
653
654#define BhkENTRY(hk, which) \
a88d97bf 655 ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
52db365a 656
a3e07c87
BM
657#define BhkENABLE(hk, which) \
658 STMT_START { \
659 BhkFLAGS(hk) |= BHKf_ ## which; \
660 assert(BhkENTRY(hk, which)); \
661 } STMT_END
662
663#define BhkDISABLE(hk, which) \
664 STMT_START { \
665 BhkFLAGS(hk) &= ~(BHKf_ ## which); \
666 } STMT_END
667
52db365a
BM
668#define BhkENTRY_set(hk, which, ptr) \
669 STMT_START { \
a88d97bf 670 (hk)->which = ptr; \
a3e07c87 671 BhkENABLE(hk, which); \
52db365a
BM
672 } STMT_END
673
1930840b
BM
674#define CALL_BLOCK_HOOKS(which, arg) \
675 STMT_START { \
676 if (PL_blockhooks) { \
c70927a6 677 SSize_t i; \
b9f2b683 678 for (i = av_tindex(PL_blockhooks); i >= 0; i--) { \
1930840b 679 SV *sv = AvARRAY(PL_blockhooks)[i]; \
52db365a 680 BHK *hk; \
1930840b
BM
681 \
682 assert(SvIOK(sv)); \
683 if (SvUOK(sv)) \
52db365a 684 hk = INT2PTR(BHK *, SvUVX(sv)); \
1930840b 685 else \
52db365a 686 hk = INT2PTR(BHK *, SvIVX(sv)); \
1930840b 687 \
52db365a 688 if (BhkENTRY(hk, which)) \
16c91539 689 BhkENTRY(hk, which)(aTHX_ arg); \
1930840b
BM
690 } \
691 } \
692 } STMT_END
693
d9088386
Z
694/* flags for rv2cv_op_cv */
695
696#define RV2CVOPCV_MARK_EARLY 0x00000001
697#define RV2CVOPCV_RETURN_NAME_GV 0x00000002
211a4342 698#define RV2CVOPCV_RETURN_STUB 0x00000004
9c98a81f
FC
699#ifdef PERL_CORE /* behaviour of this flag is subject to change: */
700# define RV2CVOPCV_MAYBE_NAME_GV 0x00000008
701#endif
702#define RV2CVOPCV_FLAG_MASK 0x0000000f /* all of the above */
d9088386 703
d3d7d28f
FC
704#define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
705
f5d552b4
FC
706/* flags for op_lvalue_flags */
707
708#define OP_LVALUE_NO_CROAK 1
709
9733086d
BM
710/*
711=head1 Custom Operators
712
713=for apidoc Am|U32|XopFLAGS|XOP *xop
714Return the XOP's flags.
715
716=for apidoc Am||XopENTRY|XOP *xop|which
72d33970
FC
717Return a member of the XOP structure. I<which> is a cpp token
718indicating which entry to return. If the member is not set
719this will return a default value. The return type depends
720on I<which>. This macro evaluates its arguments more than
721once. If you are using C<Perl_custom_op_xop> to retreive a
ae103e09
DD
722C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead.
723
724=for apidoc Am||XopENTRYCUSTOM|const OP *o|which
725Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more
72d33970 726efficient. The I<which> parameter is identical to L</XopENTRY>.
9733086d
BM
727
728=for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
72d33970
FC
729Set a member of the XOP structure. I<which> is a cpp token
730indicating which entry to set. See L<perlguts/"Custom Operators">
731for details about the available members and how
732they are used. This macro evaluates its argument
ae103e09 733more than once.
9733086d
BM
734
735=for apidoc Am|void|XopDISABLE|XOP *xop|which
736Temporarily disable a member of the XOP, by clearing the appropriate flag.
737
738=for apidoc Am|void|XopENABLE|XOP *xop|which
739Reenable a member of the XOP which has been disabled.
740
741=cut
742*/
743
1830b3d9
BM
744struct custom_op {
745 U32 xop_flags;
746 const char *xop_name;
747 const char *xop_desc;
748 U32 xop_class;
749 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
750};
751
ae103e09
DD
752/* return value of Perl_custom_op_get_field, similar to void * then casting but
753 the U32 doesn't need truncation on 64 bit platforms in the caller, also
754 for easier macro writing */
755typedef union {
756 const char *xop_name;
757 const char *xop_desc;
758 U32 xop_class;
759 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
760 XOP *xop_ptr;
761} XOPRETANY;
762
1830b3d9
BM
763#define XopFLAGS(xop) ((xop)->xop_flags)
764
765#define XOPf_xop_name 0x01
766#define XOPf_xop_desc 0x02
767#define XOPf_xop_class 0x04
768#define XOPf_xop_peep 0x08
769
ae103e09
DD
770/* used by Perl_custom_op_get_field for option checking */
771typedef enum {
772 XOPe_xop_ptr = 0, /* just get the XOP *, don't look inside it */
773 XOPe_xop_name = XOPf_xop_name,
774 XOPe_xop_desc = XOPf_xop_desc,
775 XOPe_xop_class = XOPf_xop_class,
4a3798ca 776 XOPe_xop_peep = XOPf_xop_peep
ae103e09
DD
777} xop_flags_enum;
778
1830b3d9
BM
779#define XOPd_xop_name PL_op_name[OP_CUSTOM]
780#define XOPd_xop_desc PL_op_desc[OP_CUSTOM]
781#define XOPd_xop_class OA_BASEOP
782#define XOPd_xop_peep ((Perl_cpeep_t)0)
783
784#define XopENTRY_set(xop, which, to) \
785 STMT_START { \
786 (xop)->which = (to); \
787 (xop)->xop_flags |= XOPf_ ## which; \
788 } STMT_END
789
790#define XopENTRY(xop, which) \
791 ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
792
ae103e09
DD
793#define XopENTRYCUSTOM(o, which) \
794 (Perl_custom_op_get_field(aTHX_ o, XOPe_ ## which).which)
795
1830b3d9
BM
796#define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
797#define XopENABLE(xop, which) \
798 STMT_START { \
799 (xop)->xop_flags |= XOPf_ ## which; \
800 assert(XopENTRY(xop, which)); \
801 } STMT_END
802
ae103e09
DD
803#define Perl_custom_op_xop(x) \
804 (Perl_custom_op_get_field(x, XOPe_xop_ptr).xop_ptr)
805
9733086d
BM
806/*
807=head1 Optree Manipulation Functions
808
809=for apidoc Am|const char *|OP_NAME|OP *o
72d33970 810Return the name of the provided OP. For core ops this looks up the name
9733086d
BM
811from the op_type; for custom ops from the op_ppaddr.
812
813=for apidoc Am|const char *|OP_DESC|OP *o
814Return a short description of the provided OP.
815
816=for apidoc Am|U32|OP_CLASS|OP *o
817Return the class of the provided OP: that is, which of the *OP
72d33970 818structures it uses. For core ops this currently gets the information out
9733086d
BM
819of PL_opargs, which does not always accurately reflect the type used.
820For custom ops the type is returned from the registration, and it is up
72d33970 821to the registree to ensure it is accurate. The value returned will be
9733086d
BM
822one of the OA_* constants from op.h.
823
437e3a7d 824=for apidoc Am|bool|OP_TYPE_IS|OP *o, Optype type
11ee9dd6
SM
825Returns true if the given OP is not a NULL pointer
826and if it is of the given type.
827
828The negation of this macro, C<OP_TYPE_ISNT> is also available
829as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide
830the NULL pointer check.
831
832=for apidoc Am|bool|OP_TYPE_IS_OR_WAS|OP *o, Optype type
833Returns true if the given OP is not a NULL pointer and
834if it is of the given type or used to be before being
835replaced by an OP of type OP_NULL.
836
837The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT>
838is also available as well as C<OP_TYPE_IS_OR_WAS_NN>
839and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide
840the NULL pointer check.
841
1ed44841
DM
842=for apidoc Am|bool|OP_HAS_SIBLING|OP *o
843Returns true if o has a sibling
844
845=for apidoc Am|bool|OP_SIBLING|OP *o
846Returns the sibling of o, or NULL if there is no sibling
847
848=for apidoc Am|bool|OP_SIBLING_set|OP *o|OP *sib
849Sets the sibling of o to sib
850
9733086d
BM
851=cut
852*/
853
1830b3d9 854#define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
ae103e09 855 ? XopENTRYCUSTOM(o, xop_name) \
1830b3d9
BM
856 : PL_op_name[(o)->op_type])
857#define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
ae103e09 858 ? XopENTRYCUSTOM(o, xop_desc) \
1830b3d9
BM
859 : PL_op_desc[(o)->op_type])
860#define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
ae103e09 861 ? XopENTRYCUSTOM(o, xop_class) \
1830b3d9
BM
862 : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
863
437e3a7d 864#define OP_TYPE_IS(o, type) ((o) && (o)->op_type == (type))
11ee9dd6
SM
865#define OP_TYPE_IS_NN(o, type) ((o)->op_type == (type))
866#define OP_TYPE_ISNT(o, type) ((o) && (o)->op_type != (type))
867#define OP_TYPE_ISNT_NN(o, type) ((o)->op_type != (type))
868
869#define OP_TYPE_IS_OR_WAS_NN(o, type) \
870 ( ((o)->op_type == OP_NULL \
871 ? (o)->op_targ \
872 : (o)->op_type) \
873 == (type) )
874
875#define OP_TYPE_IS_OR_WAS(o, type) \
876 ( (o) && OP_TYPE_IS_OR_WAS_NN(o, type) )
877
878#define OP_TYPE_ISNT_AND_WASNT_NN(o, type) \
879 ( ((o)->op_type == OP_NULL \
880 ? (o)->op_targ \
881 : (o)->op_type) \
882 != (type) )
883
884#define OP_TYPE_ISNT_AND_WASNT(o, type) \
885 ( (o) && OP_TYPE_ISNT_AND_WASNT_NN(o, type) )
437e3a7d 886
29e61fd9
DM
887#ifdef PERL_OP_PARENT
888# define OP_HAS_SIBLING(o) (!cBOOL((o)->op_lastsib))
889# define OP_SIBLING(o) (0 + (o)->op_lastsib ? NULL : (o)->op_sibling)
890# define OP_SIBLING_set(o, sib) ((o)->op_sibling = (sib))
891#else
892# define OP_HAS_SIBLING(o) (cBOOL((o)->op_sibling))
893# define OP_SIBLING(o) (0 + (o)->op_sibling)
894# define OP_SIBLING_set(o, sib) ((o)->op_sibling = (sib))
895#endif
1ed44841 896
e8f91c91
DD
897#define newATTRSUB(f, o, p, a, b) Perl_newATTRSUB_x(aTHX_ f, o, p, a, b, FALSE)
898#define newSUB(f, o, p, b) newATTRSUB((f), (o), (p), NULL, (b))
7bff8c33 899
3f2908ec 900/*
e8570548
Z
901=head1 Hook manipulation
902*/
903
904#ifdef USE_ITHREADS
905# define OP_CHECK_MUTEX_INIT MUTEX_INIT(&PL_check_mutex)
906# define OP_CHECK_MUTEX_LOCK MUTEX_LOCK(&PL_check_mutex)
907# define OP_CHECK_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_check_mutex)
908# define OP_CHECK_MUTEX_TERM MUTEX_DESTROY(&PL_check_mutex)
909#else
910# define OP_CHECK_MUTEX_INIT NOOP
911# define OP_CHECK_MUTEX_LOCK NOOP
912# define OP_CHECK_MUTEX_UNLOCK NOOP
913# define OP_CHECK_MUTEX_TERM NOOP
914#endif
915
916/*
3f2908ec
NC
917 * Local variables:
918 * c-indentation-style: bsd
919 * c-basic-offset: 4
14d04a33 920 * indent-tabs-mode: nil
3f2908ec
NC
921 * End:
922 *
14d04a33 923 * ex: set ts=8 sts=4 sw=4 et:
3f2908ec 924 */