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