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