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