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