This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
tr///c: handle len(replacement charlist) > 32767
[perl5.git] / op.h
1 /*    op.h
2  *
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
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  *
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.
20  *      op_opt          Whether or not the op has been optimised by the
21  *                      peephole optimiser.
22  *      op_slabbed      allocated via opslab
23  *      op_static       tell op_free() to skip PerlMemShared_free(), when
24  *                      !op_slabbed.
25  *      op_savefree     on savestack via SAVEFREEOP
26  *      op_folded       Result/remainder of a constant fold operation.
27  *      op_moresib      this op is is not the last sibling
28  *      op_spare        One spare bit
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  */
35 #include "op_reg_common.h"
36
37 #define OPCODE U16
38
39 typedef PERL_BITFIELD16 Optype;
40
41 /* this field now either points to the next sibling or to the parent,
42  * depending on op_moresib. So rename it from op_sibling to op_sibparent.
43  */
44 #ifdef PERL_OP_PARENT
45 #  define _OP_SIBPARENT_FIELDNAME op_sibparent
46 #else
47 #  define _OP_SIBPARENT_FIELDNAME op_sibling
48 #endif
49
50 #ifdef BASEOP_DEFINITION
51 #define BASEOP BASEOP_DEFINITION
52 #else
53 #define BASEOP                          \
54     OP*         op_next;                \
55     OP*         _OP_SIBPARENT_FIELDNAME;\
56     OP*         (*op_ppaddr)(pTHX);     \
57     PADOFFSET   op_targ;                \
58     PERL_BITFIELD16 op_type:9;          \
59     PERL_BITFIELD16 op_opt:1;           \
60     PERL_BITFIELD16 op_slabbed:1;       \
61     PERL_BITFIELD16 op_savefree:1;      \
62     PERL_BITFIELD16 op_static:1;        \
63     PERL_BITFIELD16 op_folded:1;        \
64     PERL_BITFIELD16 op_moresib:1;       \
65     PERL_BITFIELD16 op_spare:1;         \
66     U8          op_flags;               \
67     U8          op_private;
68 #endif
69
70 /* If op_type:9 is changed to :10, also change cx_pusheval()
71    Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
72    then all the other bit-fields before/after it should change their
73    types too to let VC pack them into the same 4 byte integer.*/
74
75 /* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
76 #define OP_GIMME(op,dfl) \
77         (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
78
79 #define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
80
81 /*
82 =head1 "Gimme" Values
83
84 =for apidoc Amn|U32|GIMME_V
85 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
86 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
87 respectively.  See L<perlcall> for a usage example.
88
89 =for apidoc Amn|U32|GIMME
90 A backward-compatible version of C<GIMME_V> which can only return
91 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
92 Deprecated.  Use C<GIMME_V> instead.
93
94 =cut
95 */
96
97 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
98
99 /* Public flags */
100
101 #define OPf_WANT        3       /* Mask for "want" bits: */
102 #define  OPf_WANT_VOID   1      /*   Want nothing */
103 #define  OPf_WANT_SCALAR 2      /*   Want single value */
104 #define  OPf_WANT_LIST   3      /*   Want list of any length */
105 #define OPf_KIDS        4       /* There is a firstborn child. */
106 #define OPf_PARENS      8       /* This operator was parenthesized. */
107                                 /*  (Or block needs explicit scope entry.) */
108 #define OPf_REF         16      /* Certified reference. */
109                                 /*  (Return container, not containee). */
110 #define OPf_MOD         32      /* Will modify (lvalue). */
111 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
112 #define OPf_SPECIAL     128     /* Do something weird for this op: */
113                                 /*  On local LVAL, don't init local value. */
114                                 /*  On OP_SORT, subroutine is inlined. */
115                                 /*  On OP_NOT, inversion was implicit. */
116                                 /*  On OP_LEAVE, don't restore curpm, e.g.
117                                  *      /(...)/ while ...>;  */
118                                 /*  On truncate, we truncate filehandle */
119                                 /*  On control verbs, we saw no label */
120                                 /*  On flipflop, we saw ... instead of .. */
121                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
122                                 /*  On OP_CHDIR, handle (or bare parens) */
123                                 /*  On OP_NULL, saw a "do". */
124                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
125                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
126                                 /*  On regcomp, "use re 'eval'" was in scope */
127                                 /*  On RV2[ACGHS]V, don't create GV--in
128                                     defined()*/
129                                 /*  On OP_DBSTATE, indicates breakpoint
130                                  *    (runtime property) */
131                                 /*  On OP_REQUIRE, was seen as CORE::require */
132                                 /*  On OP_(ENTER|LEAVE)WHEN, there's
133                                     no condition */
134                                 /*  On OP_SMARTMATCH, an implicit smartmatch */
135                                 /*  On OP_ANONHASH and OP_ANONLIST, create a
136                                     reference to the new anon hash or array */
137                                 /*  On OP_HELEM, OP_MULTIDEREF and OP_HSLICE,
138                                     localization will be followed by assignment,
139                                     so do not wipe the target if it is special
140                                     (e.g. a glob or a magic SV) */
141                                 /*  On OP_MATCH, OP_SUBST & OP_TRANS, the
142                                     operand of a logical or conditional
143                                     that was optimised away, so it should
144                                     not be bound via =~ */
145                                 /*  On OP_CONST, from a constant CV */
146                                 /*  On OP_GLOB, two meanings:
147                                     - Before ck_glob, called as CORE::glob
148                                     - After ck_glob, use Perl glob function
149                                  */
150                                 /*  On OP_PADRANGE, push @_ */
151                                 /*  On OP_DUMP, has no label */
152                                 /*  On OP_UNSTACK, in a C-style for loop */
153 /* There is no room in op_flags for this one, so it has its own bit-
154    field member (op_folded) instead.  The flag is only used to tell
155    op_convert_list to set op_folded.  */
156 #define OPf_FOLDED      (1<<16)
157
158 /* old names; don't use in new code, but don't break them, either */
159 #define OPf_LIST        OPf_WANT_LIST
160 #define OPf_KNOW        OPf_WANT
161
162 #if !defined(PERL_CORE) && !defined(PERL_EXT)
163 #  define GIMME \
164           (PL_op->op_flags & OPf_WANT                                   \
165            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
166               ? G_ARRAY                                                 \
167               : G_SCALAR)                                               \
168            : dowantarray())
169 #endif
170
171
172 /* NOTE: OPp* flags are now auto-generated and defined in opcode.h,
173  *       from data in regen/op_private */
174
175
176 #define OPpTRANS_ALL    (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
177
178
179
180 /* Mask for OP_ENTERSUB flags, the absence of which must be propagated
181  in dynamic context */
182 #define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
183
184
185 /* things that can be elements of op_aux */
186 typedef union  {
187     PADOFFSET pad_offset;
188     SV        *sv;
189     IV        iv;
190     UV        uv;
191     char      *pv;
192     SSize_t   ssize;
193 } UNOP_AUX_item;
194
195 #ifdef USE_ITHREADS
196 #  define UNOP_AUX_item_sv(item) PAD_SVl((item)->pad_offset);
197 #else
198 #  define UNOP_AUX_item_sv(item) ((item)->sv);
199 #endif
200
201
202
203
204 struct op {
205     BASEOP
206 };
207
208 struct unop {
209     BASEOP
210     OP *        op_first;
211 };
212
213 struct unop_aux {
214     BASEOP
215     OP            *op_first;
216     UNOP_AUX_item *op_aux;
217 };
218
219 struct binop {
220     BASEOP
221     OP *        op_first;
222     OP *        op_last;
223 };
224
225 struct logop {
226     BASEOP
227     OP *        op_first;
228     OP *        op_other;
229 };
230
231 struct listop {
232     BASEOP
233     OP *        op_first;
234     OP *        op_last;
235 };
236
237 struct methop {
238     BASEOP
239     union {
240         /* op_u.op_first *must* be aligned the same as the op_first
241          * field of the other op types, and op_u.op_meth_sv *must*
242          * be aligned with op_sv */
243         OP* op_first;   /* optree for method name */
244         SV* op_meth_sv; /* static method name */
245     } op_u;
246 #ifdef USE_ITHREADS
247     PADOFFSET op_rclass_targ; /* pad index for redirect class */
248 #else
249     SV*       op_rclass_sv;   /* static redirect class $o->A::meth() */
250 #endif
251 };
252
253 struct pmop {
254     BASEOP
255     OP *        op_first;
256     OP *        op_last;
257 #ifdef USE_ITHREADS
258     PADOFFSET   op_pmoffset;
259 #else
260     REGEXP *    op_pmregexp;            /* compiled expression */
261 #endif
262     U32         op_pmflags;
263     union {
264         OP *    op_pmreplroot;          /* For OP_SUBST */
265         PADOFFSET op_pmtargetoff;       /* For OP_SPLIT lex ary or thr GV */
266         GV *    op_pmtargetgv;          /* For OP_SPLIT non-threaded GV */
267     }   op_pmreplrootu;
268     union {
269         OP *    op_pmreplstart; /* Only used in OP_SUBST */
270 #ifdef USE_ITHREADS
271         PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
272 #else
273         HV *    op_pmstash;
274 #endif
275     }           op_pmstashstartu;
276     OP *        op_code_list;   /* list of (?{}) code blocks */
277 };
278
279 #ifdef USE_ITHREADS
280 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
281                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
282 /* The assignment is just to enforce type safety (or at least get a warning).
283  */
284 /* With first class regexps not via a reference one needs to assign
285    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
286    is cheaper. I guess we could allow NULL, but the check above would get
287    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
288 /* BEWARE - something that calls this macro passes (r) which has a side
289    effect.  */
290 #define PM_SETRE(o,r)   STMT_START {                                    \
291                             REGEXP *const _pm_setre = (r);              \
292                             assert(_pm_setre);                          \
293                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
294                         } STMT_END
295 #else
296 #define PM_GETRE(o)     ((o)->op_pmregexp)
297 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
298 #endif
299
300 /* Currently these PMf flags occupy a single 32-bit word.  Not all bits are
301  * currently used.  The lower bits are shared with their corresponding RXf flag
302  * bits, up to but not including _RXf_PMf_SHIFT_NEXT.  The unused bits
303  * immediately follow; finally the used Pmf-only (unshared) bits, so that the
304  * highest bit in the word is used.  This gathers all the unused bits as a pool
305  * in the middle, like so: 11111111111111110000001111111111
306  * where the '1's represent used bits, and the '0's unused.  This design allows
307  * us to allocate off one end of the pool if we need to add a shared bit, and
308  * off the other end if we need a non-shared bit, without disturbing the other
309  * bits.  This maximizes the likelihood of being able to change things without
310  * breaking binary compatibility.
311  *
312  * To add shared bits, do so in op_reg_common.h.  This should change
313  * _RXf_PMf_SHIFT_NEXT so that things won't compile.  Then come to regexp.h and
314  * op.h and adjust the constant adders in the definitions of PMf_BASE_SHIFT and
315  * Pmf_BASE_SHIFT down by the number of shared bits you added.  That's it.
316  * Things should be binary compatible.  But if either of these gets to having
317  * to subtract rather than add, leave at 0 and adjust all the entries below
318  * that are in terms of this according.  But if the first one of those is
319  * already PMf_BASE_SHIFT+0, there are no bits left, and a redesign is in
320  * order.
321  *
322  * To remove unshared bits, just delete its entry.  If you're where breaking
323  * binary compatibility is ok to do, you might want to adjust things to move
324  * the newly opened space so that it gets absorbed into the common pool.
325  *
326  * To add unshared bits, first use up any gaps in the middle.  Otherwise,
327  * allocate off the low end until you get to PMf_BASE_SHIFT+0.  If that isn't
328  * enough, move PMf_BASE_SHIFT down (if possible) and add the new bit at the
329  * other end instead; this preserves binary compatibility. */
330 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+2)
331
332 /* Set by the parser if it discovers an error, so the regex shouldn't be
333  * compiled */
334 #define PMf_HAS_ERROR   (1U<<(PMf_BASE_SHIFT+4))
335
336 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
337 #define PMf_RETAINT     (1U<<(PMf_BASE_SHIFT+5))
338
339 /* match successfully only once per reset, with related flag RXf_USED in
340  * re->extflags holding state.  This is used only for ?? matches, and only on
341  * OP_MATCH and OP_QR */
342 #define PMf_ONCE        (1U<<(PMf_BASE_SHIFT+6))
343
344 /* PMf_ONCE, i.e. ?pat?, has matched successfully.  Not used under threading. */
345 #define PMf_USED        (1U<<(PMf_BASE_SHIFT+7))
346
347 /* subst replacement is constant */
348 #define PMf_CONST       (1U<<(PMf_BASE_SHIFT+8))
349
350 /* keep 1st runtime pattern forever */
351 #define PMf_KEEP        (1U<<(PMf_BASE_SHIFT+9))
352
353 #define PMf_GLOBAL      (1U<<(PMf_BASE_SHIFT+10)) /* pattern had a g modifier */
354
355 /* don't reset pos() if //g fails */
356 #define PMf_CONTINUE    (1U<<(PMf_BASE_SHIFT+11))
357
358 /* evaluating replacement as expr */
359 #define PMf_EVAL        (1U<<(PMf_BASE_SHIFT+12))
360
361 /* Return substituted string instead of modifying it. */
362 #define PMf_NONDESTRUCT (1U<<(PMf_BASE_SHIFT+13))
363
364 /* the pattern has a CV attached (currently only under qr/...(?{}).../) */
365 #define PMf_HAS_CV      (1U<<(PMf_BASE_SHIFT+14))
366
367 /* op_code_list is private; don't free it etc. It may well point to
368  * code within another sub, with different pad etc */
369 #define PMf_CODELIST_PRIVATE    (1U<<(PMf_BASE_SHIFT+15))
370
371 /* the PMOP is a QR (we should be able to detect that from the op type,
372  * but the regex compilation API passes just the pm flags, not the op
373  * itself */
374 #define PMf_IS_QR       (1U<<(PMf_BASE_SHIFT+16))
375 #define PMf_USE_RE_EVAL (1U<<(PMf_BASE_SHIFT+17)) /* use re'eval' in scope */
376
377 /* See comments at the beginning of these defines about adding bits.  The
378  * highest bit position should be used, so that if PMf_BASE_SHIFT gets
379  * increased, the #error below will be triggered so that you will be reminded
380  * to adjust things at the other end to keep the bit positions unchanged */
381 #if PMf_BASE_SHIFT+17 > 31
382 #   error Too many PMf_ bits used.  See above and regnodes.h for any spare in middle
383 #endif
384
385 #ifdef USE_ITHREADS
386
387 #  define PmopSTASH(o)         ((o)->op_pmflags & PMf_ONCE                         \
388                                 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff]   \
389                                 : NULL)
390 #  define PmopSTASH_set(o,hv)   \
391         (assert_((o)->op_pmflags & PMf_ONCE)                            \
392          (o)->op_pmstashstartu.op_pmstashoff =                          \
393             (hv) ? alloccopstash(hv) : 0)
394 #else
395 #  define PmopSTASH(o)                                                  \
396     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
397 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
398 #    define PmopSTASH_set(o,hv)         ({                              \
399         assert((o)->op_pmflags & PMf_ONCE);                             \
400         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
401     })
402 #  else
403 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
404 #  endif
405 #endif
406 #define PmopSTASHPV(o)  (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
407    /* op_pmstashstartu.op_pmstash is not refcounted */
408 #define PmopSTASHPV_set(o,pv)   PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
409
410 struct svop {
411     BASEOP
412     SV *        op_sv;
413 };
414
415 struct padop {
416     BASEOP
417     PADOFFSET   op_padix;
418 };
419
420 struct pvop {
421     BASEOP
422     char *      op_pv;
423 };
424
425 struct loop {
426     BASEOP
427     OP *        op_first;
428     OP *        op_last;
429     OP *        op_redoop;
430     OP *        op_nextop;
431     OP *        op_lastop;
432 };
433
434 #define cUNOPx(o)       ((UNOP*)(o))
435 #define cUNOP_AUXx(o)   ((UNOP_AUX*)(o))
436 #define cBINOPx(o)      ((BINOP*)(o))
437 #define cLISTOPx(o)     ((LISTOP*)(o))
438 #define cLOGOPx(o)      ((LOGOP*)(o))
439 #define cPMOPx(o)       ((PMOP*)(o))
440 #define cSVOPx(o)       ((SVOP*)(o))
441 #define cPADOPx(o)      ((PADOP*)(o))
442 #define cPVOPx(o)       ((PVOP*)(o))
443 #define cCOPx(o)        ((COP*)(o))
444 #define cLOOPx(o)       ((LOOP*)(o))
445 #define cMETHOPx(o)     ((METHOP*)(o))
446
447 #define cUNOP           cUNOPx(PL_op)
448 #define cUNOP_AUX       cUNOP_AUXx(PL_op)
449 #define cBINOP          cBINOPx(PL_op)
450 #define cLISTOP         cLISTOPx(PL_op)
451 #define cLOGOP          cLOGOPx(PL_op)
452 #define cPMOP           cPMOPx(PL_op)
453 #define cSVOP           cSVOPx(PL_op)
454 #define cPADOP          cPADOPx(PL_op)
455 #define cPVOP           cPVOPx(PL_op)
456 #define cCOP            cCOPx(PL_op)
457 #define cLOOP           cLOOPx(PL_op)
458
459 #define cUNOPo          cUNOPx(o)
460 #define cUNOP_AUXo      cUNOP_AUXx(o)
461 #define cBINOPo         cBINOPx(o)
462 #define cLISTOPo        cLISTOPx(o)
463 #define cLOGOPo         cLOGOPx(o)
464 #define cPMOPo          cPMOPx(o)
465 #define cSVOPo          cSVOPx(o)
466 #define cPADOPo         cPADOPx(o)
467 #define cPVOPo          cPVOPx(o)
468 #define cCOPo           cCOPx(o)
469 #define cLOOPo          cLOOPx(o)
470
471 #define kUNOP           cUNOPx(kid)
472 #define kUNOP_AUX       cUNOP_AUXx(kid)
473 #define kBINOP          cBINOPx(kid)
474 #define kLISTOP         cLISTOPx(kid)
475 #define kLOGOP          cLOGOPx(kid)
476 #define kPMOP           cPMOPx(kid)
477 #define kSVOP           cSVOPx(kid)
478 #define kPADOP          cPADOPx(kid)
479 #define kPVOP           cPVOPx(kid)
480 #define kCOP            cCOPx(kid)
481 #define kLOOP           cLOOPx(kid)
482
483
484 typedef enum {
485     OPclass_NULL,     /*  0 */
486     OPclass_BASEOP,   /*  1 */
487     OPclass_UNOP,     /*  2 */
488     OPclass_BINOP,    /*  3 */
489     OPclass_LOGOP,    /*  4 */
490     OPclass_LISTOP,   /*  5 */
491     OPclass_PMOP,     /*  6 */
492     OPclass_SVOP,     /*  7 */
493     OPclass_PADOP,    /*  8 */
494     OPclass_PVOP,     /*  9 */
495     OPclass_LOOP,     /* 10 */
496     OPclass_COP,      /* 11 */
497     OPclass_METHOP,   /* 12 */
498     OPclass_UNOP_AUX  /* 13 */
499 } OPclass;
500
501
502 #ifdef USE_ITHREADS
503 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
504 #  ifndef PERL_CORE
505 #    define     IS_PADGV(v)     (v && isGV(v))
506 #    define     IS_PADCONST(v) \
507         (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
508 #  endif
509 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
510                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
511 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
512                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
513 #  define       cMETHOPx_rclass(v) PAD_SVl(cMETHOPx(v)->op_rclass_targ)
514 #else
515 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
516 #  ifndef PERL_CORE
517 #    define     IS_PADGV(v)     FALSE
518 #    define     IS_PADCONST(v)  FALSE
519 #  endif
520 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
521 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
522 #  define       cMETHOPx_rclass(v) (cMETHOPx(v)->op_rclass_sv)
523 #endif
524
525 #  define       cMETHOPx_meth(v)        cSVOPx_sv(v)
526
527 #define cGVOP_gv                cGVOPx_gv(PL_op)
528 #define cGVOPo_gv               cGVOPx_gv(o)
529 #define kGVOP_gv                cGVOPx_gv(kid)
530 #define cSVOP_sv                cSVOPx_sv(PL_op)
531 #define cSVOPo_sv               cSVOPx_sv(o)
532 #define kSVOP_sv                cSVOPx_sv(kid)
533
534 #ifndef PERL_CORE
535 #  define Nullop ((OP*)NULL)
536 #endif
537
538 /* Lowest byte of PL_opargs */
539 #define OA_MARK 1
540 #define OA_FOLDCONST 2
541 #define OA_RETSCALAR 4
542 #define OA_TARGET 8
543 #define OA_TARGLEX 16
544 #define OA_OTHERINT 32
545 #define OA_DANGEROUS 64
546 #define OA_DEFGV 128
547
548 /* The next 4 bits (8..11) encode op class information */
549 #define OCSHIFT 8
550
551 #define OA_CLASS_MASK (15 << OCSHIFT)
552
553 #define OA_BASEOP (0 << OCSHIFT)
554 #define OA_UNOP (1 << OCSHIFT)
555 #define OA_BINOP (2 << OCSHIFT)
556 #define OA_LOGOP (3 << OCSHIFT)
557 #define OA_LISTOP (4 << OCSHIFT)
558 #define OA_PMOP (5 << OCSHIFT)
559 #define OA_SVOP (6 << OCSHIFT)
560 #define OA_PADOP (7 << OCSHIFT)
561 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
562 #define OA_LOOP (9 << OCSHIFT)
563 #define OA_COP (10 << OCSHIFT)
564 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
565 #define OA_FILESTATOP (12 << OCSHIFT)
566 #define OA_LOOPEXOP (13 << OCSHIFT)
567 #define OA_METHOP (14 << OCSHIFT)
568 #define OA_UNOP_AUX (15 << OCSHIFT)
569
570 /* Each remaining nybble of PL_opargs (i.e. bits 12..15, 16..19 etc)
571  * encode the type for each arg */
572 #define OASHIFT 12
573
574 #define OA_SCALAR 1
575 #define OA_LIST 2
576 #define OA_AVREF 3
577 #define OA_HVREF 4
578 #define OA_CVREF 5
579 #define OA_FILEREF 6
580 #define OA_SCALARREF 7
581 #define OA_OPTIONAL 8
582
583 /* Op_REFCNT is a reference count at the head of each op tree: needed
584  * since the tree is shared between threads, and between cloned closure
585  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
586  * this count.
587  * The same mutex is used to protect the refcounts of the reg_trie_data
588  * and reg_ac_data structures, which are shared between duplicated
589  * regexes.
590  */
591
592 #ifdef USE_ITHREADS
593 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
594 #  ifdef PERL_CORE
595 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
596 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
597 #  else
598 #    define OP_REFCNT_LOCK              op_refcnt_lock()
599 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
600 #  endif
601 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
602 #else
603 #  define OP_REFCNT_INIT                NOOP
604 #  define OP_REFCNT_LOCK                NOOP
605 #  define OP_REFCNT_UNLOCK              NOOP
606 #  define OP_REFCNT_TERM                NOOP
607 #endif
608
609 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
610 #ifdef PERL_DEBUG_READONLY_OPS
611 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
612 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
613 #else
614 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
615 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
616 #endif
617
618 /* flags used by Perl_load_module() */
619 #define PERL_LOADMOD_DENY               0x1     /* no Module */
620 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
621 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* import arguments
622                                                    are passed as a sin-
623                                                    gle op tree, not a
624                                                    list of SVs */
625
626 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
627 #define ref(o, type) doref(o, type, TRUE)
628 #endif
629
630
631 /* basic and extended translation tables attached to OP_TRANS/OP_TRANSR ops */
632
633 typedef struct {
634     short map[256];
635 } OPtrans_map;
636
637 /* used in the presence of tr///c to record any replacement chars that
638  * are paired with the implicit 0x100..0x7fffffff search chars */
639 typedef struct {
640     short map[256];
641     SSize_t excess_len; /* number of entries in map_ex[] */
642     short repeat_char;
643     short map_ex[1];  /* Unwarranted chumminess */
644 } OPtrans_map_ex;
645
646
647 /*
648 =head1 Optree Manipulation Functions
649
650 =for apidoc Am|OP*|LINKLIST|OP *o
651 Given the root of an optree, link the tree in execution order using the
652 C<op_next> pointers and return the first op executed.  If this has
653 already been done, it will not be redone, and C<< o->op_next >> will be
654 returned.  If C<< o->op_next >> is not already set, C<o> should be at
655 least an C<UNOP>.
656
657 =cut
658 */
659
660 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
661
662 /* no longer used anywhere in core */
663 #ifndef PERL_CORE
664 #define cv_ckproto(cv, gv, p) \
665    cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
666 #endif
667
668 #ifdef PERL_CORE
669 #  define my(o) my_attrs((o), NULL)
670 #endif
671
672 #ifdef USE_REENTRANT_API
673 #include "reentr.h"
674 #endif
675
676 #define NewOp(m,var,c,type)     \
677         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
678 #define NewOpSz(m,var,size)     \
679         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
680 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
681
682 /*
683  * The per-CV op slabs consist of a header (the opslab struct) and a bunch
684  * of space for allocating op slots, each of which consists of two pointers
685  * followed by an op.  The first pointer points to the next op slot.  The
686  * second points to the slab.  At the end of the slab is a null pointer,
687  * so that slot->opslot_next - slot can be used to determine the size
688  * of the op.
689  *
690  * Each CV can have multiple slabs; opslab_next points to the next slab, to
691  * form a chain.  All bookkeeping is done on the first slab, which is where
692  * all the op slots point.
693  *
694  * Freed ops are marked as freed and attached to the freed chain
695  * via op_next pointers.
696  *
697  * When there is more than one slab, the second slab in the slab chain is
698  * assumed to be the one with free space available.  It is used when allo-
699  * cating an op if there are no freed ops available or big enough.
700  */
701
702 #ifdef PERL_CORE
703 struct opslot {
704     /* keep opslot_next first */
705     OPSLOT *    opslot_next;            /* next slot */
706     OPSLAB *    opslot_slab;            /* owner */
707     OP          opslot_op;              /* the op itself */
708 };
709
710 struct opslab {
711     OPSLOT *    opslab_first;           /* first op in this slab */
712     OPSLAB *    opslab_next;            /* next slab */
713     OP *        opslab_freed;           /* chain of freed ops */
714     size_t      opslab_refcnt;          /* number of ops */
715 # ifdef PERL_DEBUG_READONLY_OPS
716     U16         opslab_size;            /* size of slab in pointers */
717     bool        opslab_readonly;
718 # endif
719     OPSLOT      opslab_slots;           /* slots begin here */
720 };
721
722 # define OPSLOT_HEADER          STRUCT_OFFSET(OPSLOT, opslot_op)
723 # define OPSLOT_HEADER_P        (OPSLOT_HEADER/sizeof(I32 *))
724 # define OpSLOT(o)              (assert_(o->op_slabbed) \
725                                  (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
726 # define OpSLAB(o)              OpSLOT(o)->opslot_slab
727 # define OpslabREFCNT_dec(slab)      \
728         (((slab)->opslab_refcnt == 1) \
729          ? opslab_free_nopad(slab)     \
730          : (void)--(slab)->opslab_refcnt)
731   /* Variant that does not null out the pads */
732 # define OpslabREFCNT_dec_padok(slab) \
733         (((slab)->opslab_refcnt == 1)  \
734          ? opslab_free(slab)            \
735          : (void)--(slab)->opslab_refcnt)
736 #endif
737
738 struct block_hooks {
739     U32     bhk_flags;
740     void    (*bhk_start)        (pTHX_ int full);
741     void    (*bhk_pre_end)      (pTHX_ OP **seq);
742     void    (*bhk_post_end)     (pTHX_ OP **seq);
743     void    (*bhk_eval)         (pTHX_ OP *const saveop);
744 };
745
746 /*
747 =head1 Compile-time scope hooks
748
749 =for apidoc mx|U32|BhkFLAGS|BHK *hk
750 Return the BHK's flags.
751
752 =for apidoc mx|void *|BhkENTRY|BHK *hk|which
753 Return an entry from the BHK structure.  C<which> is a preprocessor token
754 indicating which entry to return.  If the appropriate flag is not set
755 this will return C<NULL>.  The type of the return value depends on which
756 entry you ask for.
757
758 =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
759 Set an entry in the BHK structure, and set the flags to indicate it is
760 valid.  C<which> is a preprocessing token indicating which entry to set.
761 The type of C<ptr> depends on the entry.
762
763 =for apidoc Amx|void|BhkDISABLE|BHK *hk|which
764 Temporarily disable an entry in this BHK structure, by clearing the
765 appropriate flag.  C<which> is a preprocessor token indicating which
766 entry to disable.
767
768 =for apidoc Amx|void|BhkENABLE|BHK *hk|which
769 Re-enable an entry in this BHK structure, by setting the appropriate
770 flag.  C<which> is a preprocessor token indicating which entry to enable.
771 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
772 pointer.
773
774 =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
775 Call all the registered block hooks for type C<which>.  C<which> is a
776 preprocessing token; the type of C<arg> depends on C<which>.
777
778 =cut
779 */
780
781 #define BhkFLAGS(hk)            ((hk)->bhk_flags)
782
783 #define BHKf_bhk_start      0x01
784 #define BHKf_bhk_pre_end    0x02
785 #define BHKf_bhk_post_end   0x04
786 #define BHKf_bhk_eval       0x08
787
788 #define BhkENTRY(hk, which) \
789     ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
790
791 #define BhkENABLE(hk, which) \
792     STMT_START { \
793         BhkFLAGS(hk) |= BHKf_ ## which; \
794         assert(BhkENTRY(hk, which)); \
795     } STMT_END
796
797 #define BhkDISABLE(hk, which) \
798     STMT_START { \
799         BhkFLAGS(hk) &= ~(BHKf_ ## which); \
800     } STMT_END
801
802 #define BhkENTRY_set(hk, which, ptr) \
803     STMT_START { \
804         (hk)->which = ptr; \
805         BhkENABLE(hk, which); \
806     } STMT_END
807
808 #define CALL_BLOCK_HOOKS(which, arg) \
809     STMT_START { \
810         if (PL_blockhooks) { \
811             SSize_t i; \
812             for (i = av_tindex(PL_blockhooks); i >= 0; i--) { \
813                 SV *sv = AvARRAY(PL_blockhooks)[i]; \
814                 BHK *hk; \
815                 \
816                 assert(SvIOK(sv)); \
817                 if (SvUOK(sv)) \
818                     hk = INT2PTR(BHK *, SvUVX(sv)); \
819                 else \
820                     hk = INT2PTR(BHK *, SvIVX(sv)); \
821                 \
822                 if (BhkENTRY(hk, which)) \
823                     BhkENTRY(hk, which)(aTHX_ arg); \
824             } \
825         } \
826     } STMT_END
827
828 /* flags for rv2cv_op_cv */
829
830 #define RV2CVOPCV_MARK_EARLY     0x00000001
831 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
832 #define RV2CVOPCV_RETURN_STUB    0x00000004
833 #ifdef PERL_CORE /* behaviour of this flag is subject to change: */
834 # define RV2CVOPCV_MAYBE_NAME_GV  0x00000008
835 #endif
836 #define RV2CVOPCV_FLAG_MASK      0x0000000f /* all of the above */
837
838 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
839
840 /* flags for op_lvalue_flags */
841
842 #define OP_LVALUE_NO_CROAK 1
843
844 /*
845 =head1 Custom Operators
846
847 =for apidoc Am|U32|XopFLAGS|XOP *xop
848 Return the XOP's flags.
849
850 =for apidoc Am||XopENTRY|XOP *xop|which
851 Return a member of the XOP structure.  C<which> is a cpp token
852 indicating which entry to return.  If the member is not set
853 this will return a default value.  The return type depends
854 on C<which>.  This macro evaluates its arguments more than
855 once.  If you are using C<Perl_custom_op_xop> to retreive a
856 C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead.
857
858 =for apidoc Am||XopENTRYCUSTOM|const OP *o|which
859 Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more
860 efficient.  The C<which> parameter is identical to L</XopENTRY>.
861
862 =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
863 Set a member of the XOP structure.  C<which> is a cpp token
864 indicating which entry to set.  See L<perlguts/"Custom Operators">
865 for details about the available members and how
866 they are used.  This macro evaluates its argument
867 more than once.
868
869 =for apidoc Am|void|XopDISABLE|XOP *xop|which
870 Temporarily disable a member of the XOP, by clearing the appropriate flag.
871
872 =for apidoc Am|void|XopENABLE|XOP *xop|which
873 Reenable a member of the XOP which has been disabled.
874
875 =cut
876 */
877
878 struct custom_op {
879     U32             xop_flags;    
880     const char     *xop_name;
881     const char     *xop_desc;
882     U32             xop_class;
883     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
884 };
885
886 /* return value of Perl_custom_op_get_field, similar to void * then casting but
887    the U32 doesn't need truncation on 64 bit platforms in the caller, also
888    for easier macro writing */
889 typedef union {
890     const char     *xop_name;
891     const char     *xop_desc;
892     U32             xop_class;
893     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
894     XOP            *xop_ptr;
895 } XOPRETANY;
896
897 #define XopFLAGS(xop) ((xop)->xop_flags)
898
899 #define XOPf_xop_name   0x01
900 #define XOPf_xop_desc   0x02
901 #define XOPf_xop_class  0x04
902 #define XOPf_xop_peep   0x08
903
904 /* used by Perl_custom_op_get_field for option checking */
905 typedef enum {
906     XOPe_xop_ptr = 0, /* just get the XOP *, don't look inside it */
907     XOPe_xop_name = XOPf_xop_name,
908     XOPe_xop_desc = XOPf_xop_desc,
909     XOPe_xop_class = XOPf_xop_class,
910     XOPe_xop_peep = XOPf_xop_peep
911 } xop_flags_enum;
912
913 #define XOPd_xop_name   PL_op_name[OP_CUSTOM]
914 #define XOPd_xop_desc   PL_op_desc[OP_CUSTOM]
915 #define XOPd_xop_class  OA_BASEOP
916 #define XOPd_xop_peep   ((Perl_cpeep_t)0)
917
918 #define XopENTRY_set(xop, which, to) \
919     STMT_START { \
920         (xop)->which = (to); \
921         (xop)->xop_flags |= XOPf_ ## which; \
922     } STMT_END
923
924 #define XopENTRY(xop, which) \
925     ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
926
927 #define XopENTRYCUSTOM(o, which) \
928     (Perl_custom_op_get_field(aTHX_ o, XOPe_ ## which).which)
929
930 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
931 #define XopENABLE(xop, which) \
932     STMT_START { \
933         (xop)->xop_flags |= XOPf_ ## which; \
934         assert(XopENTRY(xop, which)); \
935     } STMT_END
936
937 #define Perl_custom_op_xop(x) \
938     (Perl_custom_op_get_field(x, XOPe_xop_ptr).xop_ptr)
939
940 /*
941 =head1 Optree Manipulation Functions
942
943 =for apidoc Am|const char *|OP_NAME|OP *o
944 Return the name of the provided OP.  For core ops this looks up the name
945 from the op_type; for custom ops from the op_ppaddr.
946
947 =for apidoc Am|const char *|OP_DESC|OP *o
948 Return a short description of the provided OP.
949
950 =for apidoc Am|U32|OP_CLASS|OP *o
951 Return the class of the provided OP: that is, which of the *OP
952 structures it uses.  For core ops this currently gets the information out
953 of C<PL_opargs>, which does not always accurately reflect the type used;
954 in v5.26 onwards, see also the function C<L</op_class>> which can do a better
955 job of determining the used type.
956
957 For custom ops the type is returned from the registration, and it is up
958 to the registree to ensure it is accurate.  The value returned will be
959 one of the C<OA_>* constants from F<op.h>.
960
961 =for apidoc Am|bool|OP_TYPE_IS|OP *o|Optype type
962 Returns true if the given OP is not a C<NULL> pointer
963 and if it is of the given type.
964
965 The negation of this macro, C<OP_TYPE_ISNT> is also available
966 as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide
967 the NULL pointer check.
968
969 =for apidoc Am|bool|OP_TYPE_IS_OR_WAS|OP *o|Optype type
970 Returns true if the given OP is not a NULL pointer and
971 if it is of the given type or used to be before being
972 replaced by an OP of type OP_NULL.
973
974 The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT>
975 is also available as well as C<OP_TYPE_IS_OR_WAS_NN>
976 and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide
977 the C<NULL> pointer check.
978
979 =for apidoc Am|bool|OpHAS_SIBLING|OP *o
980 Returns true if C<o> has a sibling
981
982 =for apidoc Am|OP*|OpSIBLING|OP *o
983 Returns the sibling of C<o>, or C<NULL> if there is no sibling
984
985 =for apidoc Am|void|OpMORESIB_set|OP *o|OP *sib
986 Sets the sibling of C<o> to the non-zero value C<sib>. See also C<L</OpLASTSIB_set>>
987 and C<L</OpMAYBESIB_set>>. For a higher-level interface, see
988 C<L</op_sibling_splice>>.
989
990 =for apidoc Am|void|OpLASTSIB_set|OP *o|OP *parent
991 Marks C<o> as having no further siblings. On C<PERL_OP_PARENT> builds, marks
992 o as having the specified parent. See also C<L</OpMORESIB_set>> and
993 C<OpMAYBESIB_set>. For a higher-level interface, see
994 C<L</op_sibling_splice>>.
995
996 =for apidoc Am|void|OpMAYBESIB_set|OP *o|OP *sib|OP *parent
997 Conditionally does C<OpMORESIB_set> or C<OpLASTSIB_set> depending on whether
998 C<sib> is non-null. For a higher-level interface, see C<L</op_sibling_splice>>.
999
1000 =cut
1001 */
1002
1003 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
1004                     ? XopENTRYCUSTOM(o, xop_name) \
1005                     : PL_op_name[(o)->op_type])
1006 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
1007                     ? XopENTRYCUSTOM(o, xop_desc) \
1008                     : PL_op_desc[(o)->op_type])
1009 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
1010                      ? XopENTRYCUSTOM(o, xop_class) \
1011                      : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
1012
1013 #define OP_TYPE_IS(o, type) ((o) && (o)->op_type == (type))
1014 #define OP_TYPE_IS_NN(o, type) ((o)->op_type == (type))
1015 #define OP_TYPE_ISNT(o, type) ((o) && (o)->op_type != (type))
1016 #define OP_TYPE_ISNT_NN(o, type) ((o)->op_type != (type))
1017
1018 #define OP_TYPE_IS_OR_WAS_NN(o, type) \
1019     ( ((o)->op_type == OP_NULL \
1020        ? (o)->op_targ \
1021        : (o)->op_type) \
1022       == (type) )
1023
1024 #define OP_TYPE_IS_OR_WAS(o, type) \
1025     ( (o) && OP_TYPE_IS_OR_WAS_NN(o, type) )
1026
1027 #define OP_TYPE_ISNT_AND_WASNT_NN(o, type) \
1028     ( ((o)->op_type == OP_NULL \
1029        ? (o)->op_targ \
1030        : (o)->op_type) \
1031       != (type) )
1032
1033 #define OP_TYPE_ISNT_AND_WASNT(o, type) \
1034     ( (o) && OP_TYPE_ISNT_AND_WASNT_NN(o, type) )
1035
1036
1037 #ifdef PERL_OP_PARENT
1038 #  define OpHAS_SIBLING(o)      (cBOOL((o)->op_moresib))
1039 #  define OpSIBLING(o)          (0 + (o)->op_moresib ? (o)->op_sibparent : NULL)
1040 #  define OpMORESIB_set(o, sib) ((o)->op_moresib = 1, (o)->op_sibparent = (sib))
1041 #  define OpLASTSIB_set(o, parent) \
1042        ((o)->op_moresib = 0, (o)->op_sibparent = (parent))
1043 #  define OpMAYBESIB_set(o, sib, parent) \
1044        ((o)->op_sibparent = ((o)->op_moresib = cBOOL(sib)) ? (sib) : (parent))
1045 #else
1046 #  define OpHAS_SIBLING(o)      (cBOOL((o)->op_sibling))
1047 #  define OpSIBLING(o)          (0 + (o)->op_sibling)
1048 #  define OpMORESIB_set(o, sib) ((o)->op_moresib = 1, (o)->op_sibling = (sib))
1049 #  define OpLASTSIB_set(o, parent) \
1050        ((o)->op_moresib = 0, (o)->op_sibling = NULL)
1051 #  define OpMAYBESIB_set(o, sib, parent) \
1052        ((o)->op_moresib = cBOOL(sib), (o)->op_sibling = (sib))
1053 #endif
1054
1055 #if !defined(PERL_CORE) && !defined(PERL_EXT)
1056 /* for backwards compatibility only */
1057 #  define OP_SIBLING(o)         OpSIBLING(o)
1058 #endif
1059
1060 #define newATTRSUB(f, o, p, a, b) Perl_newATTRSUB_x(aTHX_  f, o, p, a, b, FALSE)
1061 #define newSUB(f, o, p, b)      newATTRSUB((f), (o), (p), NULL, (b))
1062
1063 /*
1064 =head1 Hook manipulation
1065 */
1066
1067 #ifdef USE_ITHREADS
1068 #  define OP_CHECK_MUTEX_INIT           MUTEX_INIT(&PL_check_mutex)
1069 #  define OP_CHECK_MUTEX_LOCK           MUTEX_LOCK(&PL_check_mutex)
1070 #  define OP_CHECK_MUTEX_UNLOCK         MUTEX_UNLOCK(&PL_check_mutex)
1071 #  define OP_CHECK_MUTEX_TERM           MUTEX_DESTROY(&PL_check_mutex)
1072 #else
1073 #  define OP_CHECK_MUTEX_INIT           NOOP
1074 #  define OP_CHECK_MUTEX_LOCK           NOOP
1075 #  define OP_CHECK_MUTEX_UNLOCK         NOOP
1076 #  define OP_CHECK_MUTEX_TERM           NOOP
1077 #endif
1078
1079
1080 /* Stuff for OP_MULTDEREF/pp_multideref. */
1081
1082 /* actions */
1083
1084 /* Load another word of actions/flag bits. Must be 0 */
1085 #define MDEREF_reload                       0
1086
1087 #define MDEREF_AV_pop_rv2av_aelem           1
1088 #define MDEREF_AV_gvsv_vivify_rv2av_aelem   2
1089 #define MDEREF_AV_padsv_vivify_rv2av_aelem  3
1090 #define MDEREF_AV_vivify_rv2av_aelem        4
1091 #define MDEREF_AV_padav_aelem               5
1092 #define MDEREF_AV_gvav_aelem                6
1093
1094 #define MDEREF_HV_pop_rv2hv_helem           8
1095 #define MDEREF_HV_gvsv_vivify_rv2hv_helem   9
1096 #define MDEREF_HV_padsv_vivify_rv2hv_helem 10
1097 #define MDEREF_HV_vivify_rv2hv_helem       11
1098 #define MDEREF_HV_padhv_helem              12
1099 #define MDEREF_HV_gvhv_helem               13
1100
1101 #define MDEREF_ACTION_MASK                0xf
1102
1103 /* key / index type */
1104
1105 #define MDEREF_INDEX_none   0x00 /* run external ops to generate index */
1106 #define MDEREF_INDEX_const  0x10 /* index is const PV/UV */
1107 #define MDEREF_INDEX_padsv  0x20 /* index is lexical var */
1108 #define MDEREF_INDEX_gvsv   0x30 /* index is GV */
1109
1110 #define MDEREF_INDEX_MASK   0x30
1111
1112 /* bit flags */
1113
1114 #define MDEREF_FLAG_last    0x40 /* the last [ah]elem; PL_op flags apply */
1115
1116 #define MDEREF_MASK         0x7F
1117 #define MDEREF_SHIFT           7
1118
1119 #if defined(PERL_IN_DOOP_C) || defined(PERL_IN_PP_C)
1120 static const char * const fatal_above_ff_msg
1121     = "Use of strings with code points over 0xFF as arguments to "
1122       "%s operator is not allowed";
1123 #endif
1124
1125
1126 /*
1127  * ex: set ts=8 sts=4 sw=4 et:
1128  */