This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
pad.c: Stop turning on GvIN_PAD
[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))
cecf5685
NC
393# define IS_PADGV(v) (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
394 && GvIN_PAD(v))
f5a0fd1e
FC
395# define IS_PADCONST(v) \
396 (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
7766f137 397# define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
dd2155a4 398 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
638eceb6 399# define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
dd2155a4 400 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
350de78d 401#else
638eceb6 402# define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
743e66e6 403# define IS_PADGV(v) FALSE
7766f137
GS
404# define IS_PADCONST(v) FALSE
405# define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
638eceb6 406# define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
350de78d 407#endif
79072805 408
638eceb6
GS
409#define cGVOP_gv cGVOPx_gv(PL_op)
410#define cGVOPo_gv cGVOPx_gv(o)
411#define kGVOP_gv cGVOPx_gv(kid)
412#define cSVOP_sv cSVOPx_sv(PL_op)
413#define cSVOPo_sv cSVOPx_sv(o)
414#define kSVOP_sv cSVOPx_sv(kid)
7766f137 415
bcabcc50
NC
416#ifndef PERL_CORE
417# define Nullop ((OP*)NULL)
418#endif
79072805 419
cee4176c 420/* Lowest byte of PL_opargs */
a0d0e21e
LW
421#define OA_MARK 1
422#define OA_FOLDCONST 2
423#define OA_RETSCALAR 4
424#define OA_TARGET 8
903fd87c 425#define OA_TARGLEX 16
a0d0e21e
LW
426#define OA_OTHERINT 32
427#define OA_DANGEROUS 64
428#define OA_DEFGV 128
429
738ec380 430/* The next 4 bits (8..11) encode op class information */
903fd87c 431#define OCSHIFT 8
b162f9ea
IZ
432
433#define OA_CLASS_MASK (15 << OCSHIFT)
434
435#define OA_BASEOP (0 << OCSHIFT)
436#define OA_UNOP (1 << OCSHIFT)
437#define OA_BINOP (2 << OCSHIFT)
438#define OA_LOGOP (3 << OCSHIFT)
1a67a97c
SM
439#define OA_LISTOP (4 << OCSHIFT)
440#define OA_PMOP (5 << OCSHIFT)
441#define OA_SVOP (6 << OCSHIFT)
7934575e 442#define OA_PADOP (7 << OCSHIFT)
1a67a97c
SM
443#define OA_PVOP_OR_SVOP (8 << OCSHIFT)
444#define OA_LOOP (9 << OCSHIFT)
445#define OA_COP (10 << OCSHIFT)
446#define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
447#define OA_FILESTATOP (12 << OCSHIFT)
448#define OA_LOOPEXOP (13 << OCSHIFT)
b162f9ea 449
738ec380
DM
450/* Each remaining nybble of PL_opargs (i.e. bits 12..15, 16..19 etc)
451 * encode the type for each arg */
903fd87c 452#define OASHIFT 12
a0d0e21e 453
a0d0e21e
LW
454#define OA_SCALAR 1
455#define OA_LIST 2
456#define OA_AVREF 3
457#define OA_HVREF 4
458#define OA_CVREF 5
459#define OA_FILEREF 6
460#define OA_SCALARREF 7
461#define OA_OPTIONAL 8
462
d3c72c2a
DM
463/* Op_REFCNT is a reference count at the head of each op tree: needed
464 * since the tree is shared between threads, and between cloned closure
465 * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
466 * this count.
467 * The same mutex is used to protect the refcounts of the reg_trie_data
468 * and reg_ac_data structures, which are shared between duplicated
469 * regexes.
470 */
471
534825c4
GS
472#ifdef USE_ITHREADS
473# define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
4026c95a
SH
474# ifdef PERL_CORE
475# define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
476# define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
477# else
478# define OP_REFCNT_LOCK op_refcnt_lock()
479# define OP_REFCNT_UNLOCK op_refcnt_unlock()
480# endif
534825c4 481# define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
534825c4
GS
482#else
483# define OP_REFCNT_INIT NOOP
484# define OP_REFCNT_LOCK NOOP
485# define OP_REFCNT_UNLOCK NOOP
486# define OP_REFCNT_TERM NOOP
534825c4 487#endif
e4783991 488
282f25c9 489#define OpREFCNT_set(o,n) ((o)->op_targ = (n))
fc97af9c
NC
490#ifdef PERL_DEBUG_READONLY_OPS
491# define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o)
492# define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o)
493#else
494# define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL)
495# define OpREFCNT_dec(o) (--(o)->op_targ)
496#endif
282f25c9 497
e4783991 498/* flags used by Perl_load_module() */
ec6d81ab
RGS
499#define PERL_LOADMOD_DENY 0x1 /* no Module */
500#define PERL_LOADMOD_NOIMPORT 0x2 /* use Module () */
466f50cc
FC
501#define PERL_LOADMOD_IMPORT_OPS 0x4 /* import arguments
502 are passed as a sin-
503 gle op tree, not a
504 list of SVs */
e5dd39fc 505
30d9c59b 506#if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
e4c5ccf3 507#define ref(o, type) doref(o, type, TRUE)
a0c21aa1 508#endif
e4c5ccf3 509
5983a79d
BM
510/*
511=head1 Optree Manipulation Functions
512
513=for apidoc Am|OP*|LINKLIST|OP *o
514Given the root of an optree, link the tree in execution order using the
72d33970 515C<op_next> pointers and return the first op executed. If this has
5983a79d 516already been done, it will not be redone, and C<< o->op_next >> will be
72d33970 517returned. If C<< o->op_next >> is not already set, I<o> should be at
5983a79d
BM
518least an C<UNOP>.
519
520=cut
521*/
522
523#define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
524
33f36c71
NC
525/* no longer used anywhere in core */
526#ifndef PERL_CORE
46471bde 527#define cv_ckproto(cv, gv, p) \
f717afa7 528 cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
33f36c71
NC
529#endif
530
7d0905b9
NC
531#ifdef PERL_CORE
532# define my(o) my_attrs((o), NULL)
533#endif
534
e5dd39fc 535#ifdef USE_REENTRANT_API
10bc17b6 536#include "reentr.h"
e5dd39fc
AB
537#endif
538
c7e45529 539#define NewOp(m,var,c,type) \
e91d68d5 540 (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
c7e45529 541#define NewOpSz(m,var,size) \
e91d68d5 542 (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
c7e45529 543#define FreeOp(p) Perl_Slab_Free(aTHX_ p)
8be227ab
FC
544
545/*
546 * The per-CV op slabs consist of a header (the opslab struct) and a bunch
547 * of space for allocating op slots, each of which consists of two pointers
548 * followed by an op. The first pointer points to the next op slot. The
549 * second points to the slab. At the end of the slab is a null pointer,
550 * so that slot->opslot_next - slot can be used to determine the size
551 * of the op.
552 *
553 * Each CV can have multiple slabs; opslab_next points to the next slab, to
554 * form a chain. All bookkeeping is done on the first slab, which is where
555 * all the op slots point.
556 *
557 * Freed ops are marked as freed and attached to the freed chain
558 * via op_next pointers.
559 *
560 * When there is more than one slab, the second slab in the slab chain is
561 * assumed to be the one with free space available. It is used when allo-
562 * cating an op if there are no freed ops available or big enough.
563 */
564
7aef8e5b 565#ifdef PERL_CORE
8be227ab
FC
566struct opslot {
567 /* keep opslot_next first */
568 OPSLOT * opslot_next; /* next slot */
569 OPSLAB * opslot_slab; /* owner */
570 OP opslot_op; /* the op itself */
571};
572
573struct opslab {
574 OPSLOT * opslab_first; /* first op in this slab */
575 OPSLAB * opslab_next; /* next slab */
576 OP * opslab_freed; /* chain of freed ops */
577 size_t opslab_refcnt; /* number of ops */
3107b51f
FC
578# ifdef PERL_DEBUG_READONLY_OPS
579 U16 opslab_size; /* size of slab in pointers */
580 bool opslab_readonly;
581# endif
8be227ab
FC
582 OPSLOT opslab_slots; /* slots begin here */
583};
584
585# define OPSLOT_HEADER STRUCT_OFFSET(OPSLOT, opslot_op)
586# define OPSLOT_HEADER_P (OPSLOT_HEADER/sizeof(I32 *))
c7724415 587# define OpSLOT(o) (assert_(o->op_slabbed) \
8be227ab 588 (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
8be227ab
FC
589# define OpSLAB(o) OpSLOT(o)->opslot_slab
590# define OpslabREFCNT_dec(slab) \
591 (((slab)->opslab_refcnt == 1) \
592 ? opslab_free_nopad(slab) \
593 : (void)--(slab)->opslab_refcnt)
594 /* Variant that does not null out the pads */
595# define OpslabREFCNT_dec_padok(slab) \
596 (((slab)->opslab_refcnt == 1) \
597 ? opslab_free(slab) \
598 : (void)--(slab)->opslab_refcnt)
c7e45529 599#endif
598921a7 600
1930840b 601struct block_hooks {
52db365a 602 U32 bhk_flags;
1930840b
BM
603 void (*bhk_start) (pTHX_ int full);
604 void (*bhk_pre_end) (pTHX_ OP **seq);
605 void (*bhk_post_end) (pTHX_ OP **seq);
52db365a 606 void (*bhk_eval) (pTHX_ OP *const saveop);
1930840b
BM
607};
608
fd85fad2
BM
609/*
610=head1 Compile-time scope hooks
611
3e4ddde5 612=for apidoc mx|U32|BhkFLAGS|BHK *hk
fd85fad2
BM
613Return the BHK's flags.
614
3e4ddde5 615=for apidoc mx|void *|BhkENTRY|BHK *hk|which
72d33970
FC
616Return an entry from the BHK structure. I<which> is a preprocessor token
617indicating which entry to return. If the appropriate flag is not set
618this will return NULL. The type of the return value depends on which
fd85fad2
BM
619entry you ask for.
620
3e4ddde5 621=for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
fd85fad2 622Set an entry in the BHK structure, and set the flags to indicate it is
72d33970 623valid. I<which> is a preprocessing token indicating which entry to set.
fd85fad2
BM
624The type of I<ptr> depends on the entry.
625
3e4ddde5 626=for apidoc Amx|void|BhkDISABLE|BHK *hk|which
a3e07c87 627Temporarily disable an entry in this BHK structure, by clearing the
72d33970 628appropriate flag. I<which> is a preprocessor token indicating which
a3e07c87
BM
629entry to disable.
630
3e4ddde5 631=for apidoc Amx|void|BhkENABLE|BHK *hk|which
a3e07c87 632Re-enable an entry in this BHK structure, by setting the appropriate
72d33970 633flag. I<which> is a preprocessor token indicating which entry to enable.
a3e07c87
BM
634This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
635pointer.
636
3e4ddde5 637=for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
72d33970 638Call all the registered block hooks for type I<which>. I<which> is a
fd85fad2
BM
639preprocessing token; the type of I<arg> depends on I<which>.
640
641=cut
642*/
643
52db365a
BM
644#define BhkFLAGS(hk) ((hk)->bhk_flags)
645
a88d97bf
BM
646#define BHKf_bhk_start 0x01
647#define BHKf_bhk_pre_end 0x02
648#define BHKf_bhk_post_end 0x04
649#define BHKf_bhk_eval 0x08
52db365a
BM
650
651#define BhkENTRY(hk, which) \
a88d97bf 652 ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
52db365a 653
a3e07c87
BM
654#define BhkENABLE(hk, which) \
655 STMT_START { \
656 BhkFLAGS(hk) |= BHKf_ ## which; \
657 assert(BhkENTRY(hk, which)); \
658 } STMT_END
659
660#define BhkDISABLE(hk, which) \
661 STMT_START { \
662 BhkFLAGS(hk) &= ~(BHKf_ ## which); \
663 } STMT_END
664
52db365a
BM
665#define BhkENTRY_set(hk, which, ptr) \
666 STMT_START { \
a88d97bf 667 (hk)->which = ptr; \
a3e07c87 668 BhkENABLE(hk, which); \
52db365a
BM
669 } STMT_END
670
1930840b
BM
671#define CALL_BLOCK_HOOKS(which, arg) \
672 STMT_START { \
673 if (PL_blockhooks) { \
c70927a6 674 SSize_t i; \
b9f2b683 675 for (i = av_tindex(PL_blockhooks); i >= 0; i--) { \
1930840b 676 SV *sv = AvARRAY(PL_blockhooks)[i]; \
52db365a 677 BHK *hk; \
1930840b
BM
678 \
679 assert(SvIOK(sv)); \
680 if (SvUOK(sv)) \
52db365a 681 hk = INT2PTR(BHK *, SvUVX(sv)); \
1930840b 682 else \
52db365a 683 hk = INT2PTR(BHK *, SvIVX(sv)); \
1930840b 684 \
52db365a 685 if (BhkENTRY(hk, which)) \
16c91539 686 BhkENTRY(hk, which)(aTHX_ arg); \
1930840b
BM
687 } \
688 } \
689 } STMT_END
690
d9088386
Z
691/* flags for rv2cv_op_cv */
692
693#define RV2CVOPCV_MARK_EARLY 0x00000001
694#define RV2CVOPCV_RETURN_NAME_GV 0x00000002
211a4342 695#define RV2CVOPCV_RETURN_STUB 0x00000004
9c98a81f
FC
696#ifdef PERL_CORE /* behaviour of this flag is subject to change: */
697# define RV2CVOPCV_MAYBE_NAME_GV 0x00000008
698#endif
699#define RV2CVOPCV_FLAG_MASK 0x0000000f /* all of the above */
d9088386 700
d3d7d28f
FC
701#define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
702
f5d552b4
FC
703/* flags for op_lvalue_flags */
704
705#define OP_LVALUE_NO_CROAK 1
706
9733086d
BM
707/*
708=head1 Custom Operators
709
710=for apidoc Am|U32|XopFLAGS|XOP *xop
711Return the XOP's flags.
712
713=for apidoc Am||XopENTRY|XOP *xop|which
72d33970
FC
714Return a member of the XOP structure. I<which> is a cpp token
715indicating which entry to return. If the member is not set
716this will return a default value. The return type depends
717on I<which>. This macro evaluates its arguments more than
718once. If you are using C<Perl_custom_op_xop> to retreive a
ae103e09
DD
719C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead.
720
721=for apidoc Am||XopENTRYCUSTOM|const OP *o|which
722Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more
72d33970 723efficient. The I<which> parameter is identical to L</XopENTRY>.
9733086d
BM
724
725=for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
72d33970
FC
726Set a member of the XOP structure. I<which> is a cpp token
727indicating which entry to set. See L<perlguts/"Custom Operators">
728for details about the available members and how
729they are used. This macro evaluates its argument
ae103e09 730more than once.
9733086d
BM
731
732=for apidoc Am|void|XopDISABLE|XOP *xop|which
733Temporarily disable a member of the XOP, by clearing the appropriate flag.
734
735=for apidoc Am|void|XopENABLE|XOP *xop|which
736Reenable a member of the XOP which has been disabled.
737
738=cut
739*/
740
1830b3d9
BM
741struct custom_op {
742 U32 xop_flags;
743 const char *xop_name;
744 const char *xop_desc;
745 U32 xop_class;
746 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
747};
748
ae103e09
DD
749/* return value of Perl_custom_op_get_field, similar to void * then casting but
750 the U32 doesn't need truncation on 64 bit platforms in the caller, also
751 for easier macro writing */
752typedef union {
753 const char *xop_name;
754 const char *xop_desc;
755 U32 xop_class;
756 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
757 XOP *xop_ptr;
758} XOPRETANY;
759
1830b3d9
BM
760#define XopFLAGS(xop) ((xop)->xop_flags)
761
762#define XOPf_xop_name 0x01
763#define XOPf_xop_desc 0x02
764#define XOPf_xop_class 0x04
765#define XOPf_xop_peep 0x08
766
ae103e09
DD
767/* used by Perl_custom_op_get_field for option checking */
768typedef enum {
769 XOPe_xop_ptr = 0, /* just get the XOP *, don't look inside it */
770 XOPe_xop_name = XOPf_xop_name,
771 XOPe_xop_desc = XOPf_xop_desc,
772 XOPe_xop_class = XOPf_xop_class,
4a3798ca 773 XOPe_xop_peep = XOPf_xop_peep
ae103e09
DD
774} xop_flags_enum;
775
1830b3d9
BM
776#define XOPd_xop_name PL_op_name[OP_CUSTOM]
777#define XOPd_xop_desc PL_op_desc[OP_CUSTOM]
778#define XOPd_xop_class OA_BASEOP
779#define XOPd_xop_peep ((Perl_cpeep_t)0)
780
781#define XopENTRY_set(xop, which, to) \
782 STMT_START { \
783 (xop)->which = (to); \
784 (xop)->xop_flags |= XOPf_ ## which; \
785 } STMT_END
786
787#define XopENTRY(xop, which) \
788 ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
789
ae103e09
DD
790#define XopENTRYCUSTOM(o, which) \
791 (Perl_custom_op_get_field(aTHX_ o, XOPe_ ## which).which)
792
1830b3d9
BM
793#define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
794#define XopENABLE(xop, which) \
795 STMT_START { \
796 (xop)->xop_flags |= XOPf_ ## which; \
797 assert(XopENTRY(xop, which)); \
798 } STMT_END
799
ae103e09
DD
800#define Perl_custom_op_xop(x) \
801 (Perl_custom_op_get_field(x, XOPe_xop_ptr).xop_ptr)
802
9733086d
BM
803/*
804=head1 Optree Manipulation Functions
805
806=for apidoc Am|const char *|OP_NAME|OP *o
72d33970 807Return the name of the provided OP. For core ops this looks up the name
9733086d
BM
808from the op_type; for custom ops from the op_ppaddr.
809
810=for apidoc Am|const char *|OP_DESC|OP *o
811Return a short description of the provided OP.
812
813=for apidoc Am|U32|OP_CLASS|OP *o
814Return the class of the provided OP: that is, which of the *OP
72d33970 815structures it uses. For core ops this currently gets the information out
9733086d
BM
816of PL_opargs, which does not always accurately reflect the type used.
817For custom ops the type is returned from the registration, and it is up
72d33970 818to the registree to ensure it is accurate. The value returned will be
9733086d
BM
819one of the OA_* constants from op.h.
820
437e3a7d 821=for apidoc Am|bool|OP_TYPE_IS|OP *o, Optype type
11ee9dd6
SM
822Returns true if the given OP is not a NULL pointer
823and if it is of the given type.
824
825The negation of this macro, C<OP_TYPE_ISNT> is also available
826as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide
827the NULL pointer check.
828
829=for apidoc Am|bool|OP_TYPE_IS_OR_WAS|OP *o, Optype type
830Returns true if the given OP is not a NULL pointer and
831if it is of the given type or used to be before being
832replaced by an OP of type OP_NULL.
833
834The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT>
835is also available as well as C<OP_TYPE_IS_OR_WAS_NN>
836and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide
837the NULL pointer check.
838
1ed44841
DM
839=for apidoc Am|bool|OP_HAS_SIBLING|OP *o
840Returns true if o has a sibling
841
842=for apidoc Am|bool|OP_SIBLING|OP *o
843Returns the sibling of o, or NULL if there is no sibling
844
845=for apidoc Am|bool|OP_SIBLING_set|OP *o|OP *sib
846Sets the sibling of o to sib
847
9733086d
BM
848=cut
849*/
850
1830b3d9 851#define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
ae103e09 852 ? XopENTRYCUSTOM(o, xop_name) \
1830b3d9
BM
853 : PL_op_name[(o)->op_type])
854#define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
ae103e09 855 ? XopENTRYCUSTOM(o, xop_desc) \
1830b3d9
BM
856 : PL_op_desc[(o)->op_type])
857#define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
ae103e09 858 ? XopENTRYCUSTOM(o, xop_class) \
1830b3d9
BM
859 : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
860
437e3a7d 861#define OP_TYPE_IS(o, type) ((o) && (o)->op_type == (type))
11ee9dd6
SM
862#define OP_TYPE_IS_NN(o, type) ((o)->op_type == (type))
863#define OP_TYPE_ISNT(o, type) ((o) && (o)->op_type != (type))
864#define OP_TYPE_ISNT_NN(o, type) ((o)->op_type != (type))
865
866#define OP_TYPE_IS_OR_WAS_NN(o, type) \
867 ( ((o)->op_type == OP_NULL \
868 ? (o)->op_targ \
869 : (o)->op_type) \
870 == (type) )
871
872#define OP_TYPE_IS_OR_WAS(o, type) \
873 ( (o) && OP_TYPE_IS_OR_WAS_NN(o, type) )
874
875#define OP_TYPE_ISNT_AND_WASNT_NN(o, type) \
876 ( ((o)->op_type == OP_NULL \
877 ? (o)->op_targ \
878 : (o)->op_type) \
879 != (type) )
880
881#define OP_TYPE_ISNT_AND_WASNT(o, type) \
882 ( (o) && OP_TYPE_ISNT_AND_WASNT_NN(o, type) )
437e3a7d 883
29e61fd9
DM
884#ifdef PERL_OP_PARENT
885# define OP_HAS_SIBLING(o) (!cBOOL((o)->op_lastsib))
886# define OP_SIBLING(o) (0 + (o)->op_lastsib ? NULL : (o)->op_sibling)
887# define OP_SIBLING_set(o, sib) ((o)->op_sibling = (sib))
888#else
889# define OP_HAS_SIBLING(o) (cBOOL((o)->op_sibling))
890# define OP_SIBLING(o) (0 + (o)->op_sibling)
891# define OP_SIBLING_set(o, sib) ((o)->op_sibling = (sib))
892#endif
1ed44841 893
e8f91c91
DD
894#define newATTRSUB(f, o, p, a, b) Perl_newATTRSUB_x(aTHX_ f, o, p, a, b, FALSE)
895#define newSUB(f, o, p, b) newATTRSUB((f), (o), (p), NULL, (b))
7bff8c33 896
3f2908ec 897/*
e8570548
Z
898=head1 Hook manipulation
899*/
900
901#ifdef USE_ITHREADS
902# define OP_CHECK_MUTEX_INIT MUTEX_INIT(&PL_check_mutex)
903# define OP_CHECK_MUTEX_LOCK MUTEX_LOCK(&PL_check_mutex)
904# define OP_CHECK_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_check_mutex)
905# define OP_CHECK_MUTEX_TERM MUTEX_DESTROY(&PL_check_mutex)
906#else
907# define OP_CHECK_MUTEX_INIT NOOP
908# define OP_CHECK_MUTEX_LOCK NOOP
909# define OP_CHECK_MUTEX_UNLOCK NOOP
910# define OP_CHECK_MUTEX_TERM NOOP
911#endif
912
913/*
3f2908ec
NC
914 * Local variables:
915 * c-indentation-style: bsd
916 * c-basic-offset: 4
14d04a33 917 * indent-tabs-mode: nil
3f2908ec
NC
918 * End:
919 *
14d04a33 920 * ex: set ts=8 sts=4 sw=4 et:
3f2908ec 921 */