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