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