Convert some SvREFCNT_dec's to SvREFCNT_dec_NN's for efficiency
[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_spare        Three spare bits
27  *      op_flags        Flags common to all operations.  See OPf_* below.
28  *      op_private      Flags peculiar to a particular operation (BUT,
29  *                      by default, set to the number of children until
30  *                      the operation is privatized by a check routine,
31  *                      which may or may not check number of children).
32  */
33 #include "op_reg_common.h"
34
35 #define OPCODE U16
36
37 #ifdef PERL_MAD
38 #  define MADPROP_IN_BASEOP     MADPROP*        op_madprop;
39 #else
40 #  define MADPROP_IN_BASEOP
41 #endif
42
43 typedef PERL_BITFIELD16 Optype;
44
45 #ifdef BASEOP_DEFINITION
46 #define BASEOP BASEOP_DEFINITION
47 #else
48 #define BASEOP                          \
49     OP*         op_next;                \
50     OP*         op_sibling;             \
51     OP*         (*op_ppaddr)(pTHX);     \
52     MADPROP_IN_BASEOP                   \
53     PADOFFSET   op_targ;                \
54     PERL_BITFIELD16 op_type:9;          \
55     PERL_BITFIELD16 op_opt:1;           \
56     PERL_BITFIELD16 op_slabbed:1;       \
57     PERL_BITFIELD16 op_savefree:1;      \
58     PERL_BITFIELD16 op_static:1;        \
59     PERL_BITFIELD16 op_spare:3;         \
60     U8          op_flags;               \
61     U8          op_private;
62 #endif
63
64 /* If op_type:9 is changed to :10, also change PUSHEVAL in cop.h.
65    Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
66    then all the other bit-fields before/after it should change their
67    types too to let VC pack them into the same 4 byte integer.*/
68
69 /* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
70 #define OP_GIMME(op,dfl) \
71         (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
72
73 #define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
74
75 /*
76 =head1 "Gimme" Values
77
78 =for apidoc Amn|U32|GIMME_V
79 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
80 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
81 respectively. See L<perlcall> for a usage example.
82
83 =for apidoc Amn|U32|GIMME
84 A backward-compatible version of C<GIMME_V> which can only return
85 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
86 Deprecated.  Use C<GIMME_V> instead.
87
88 =cut
89 */
90
91 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
92
93 /* Public flags */
94
95 #define OPf_WANT        3       /* Mask for "want" bits: */
96 #define  OPf_WANT_VOID   1      /*   Want nothing */
97 #define  OPf_WANT_SCALAR 2      /*   Want single value */
98 #define  OPf_WANT_LIST   3      /*   Want list of any length */
99 #define OPf_KIDS        4       /* There is a firstborn child. */
100 #define OPf_PARENS      8       /* This operator was parenthesized. */
101                                 /*  (Or block needs explicit scope entry.) */
102 #define OPf_REF         16      /* Certified reference. */
103                                 /*  (Return container, not containee). */
104 #define OPf_MOD         32      /* Will modify (lvalue). */
105 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
106 #define OPf_SPECIAL     128     /* Do something weird for this op: */
107                                 /*  On local LVAL, don't init local value. */
108                                 /*  On OP_SORT, subroutine is inlined. */
109                                 /*  On OP_NOT, inversion was implicit. */
110                                 /*  On OP_LEAVE, don't restore curpm. */
111                                 /*  On truncate, we truncate filehandle */
112                                 /*  On control verbs, we saw no label */
113                                 /*  On flipflop, we saw ... instead of .. */
114                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
115                                 /*  On OP_ENTERSUB || OP_NULL, saw a "do". */
116                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
117                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
118                                 /*  On OP_SPLIT, special split " " */
119                                 /*  On regcomp, "use re 'eval'" was in scope */
120                                 /*  On OP_READLINE, was <$filehandle> */
121                                 /*  On RV2[ACGHS]V, don't create GV--in
122                                     defined()*/
123                                 /*  On OP_DBSTATE, indicates breakpoint
124                                  *    (runtime property) */
125                                 /*  On OP_REQUIRE, was seen as CORE::require */
126                                 /*  On OP_(ENTER|LEAVE)WHEN, there's
127                                     no condition */
128                                 /*  On OP_SMARTMATCH, an implicit smartmatch */
129                                 /*  On OP_ANONHASH and OP_ANONLIST, create a
130                                     reference to the new anon hash or array */
131                                 /*  On OP_HELEM and OP_HSLICE, localization will be followed
132                                     by assignment, so do not wipe the target if it is special
133                                     (e.g. a glob or a magic SV) */
134                                 /*  On OP_MATCH, OP_SUBST & OP_TRANS, the
135                                     operand of a logical or conditional
136                                     that was optimised away, so it should
137                                     not be bound via =~ */
138                                 /*  On OP_CONST, from a constant CV */
139                                 /*  On OP_GLOB, two meanings:
140                                     - Before ck_glob, called as CORE::glob
141                                     - After ck_glob, use Perl glob function
142                                  */
143                                 /*  On OP_PADRANGE, push @_ */
144
145 /* old names; don't use in new code, but don't break them, either */
146 #define OPf_LIST        OPf_WANT_LIST
147 #define OPf_KNOW        OPf_WANT
148
149 #define GIMME \
150           (PL_op->op_flags & OPf_WANT                                   \
151            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
152               ? G_ARRAY                                                 \
153               : G_SCALAR)                                               \
154            : dowantarray())
155
156 /* Lower bits of op_private often carry the number of arguments, as
157  * set by newBINOP, newUNOP and ck_fun */
158
159 /* NOTE: OP_NEXTSTATE and OP_DBSTATE (i.e. COPs) carry NATIVE_HINTS
160  * in op_private */
161
162 /* Private for lvalues */
163 #define OPpLVAL_INTRO   128     /* Lvalue must be localized or lvalue sub */
164
165 /* Private for OPs with TARGLEX */
166   /* (lower bits may carry MAXARG) */
167 #define OPpTARGET_MY            16      /* Target is PADMY. */
168
169 /* Private for OP_LEAVE, OP_LEAVESUB, OP_LEAVESUBLV and OP_LEAVEWRITE */
170 #define OPpREFCOUNTED           64      /* op_targ carries a refcount */
171
172 /* Private for OP_AASSIGN */
173 #define OPpASSIGN_COMMON        64      /* Left & right have syms in common. */
174
175 /* Private for OP_SASSIGN */
176 #define OPpASSIGN_BACKWARDS     64      /* Left & right switched. */
177 #define OPpASSIGN_CV_TO_GV      128     /* Possible optimisation for constants. */
178
179 /* Private for OP_MATCH and OP_SUBST{,CONT} */
180 #define OPpRUNTIME              64      /* Pattern coming in on the stack */
181
182 /* Private for OP_TRANS */
183 #define OPpTRANS_FROM_UTF       1
184 #define OPpTRANS_TO_UTF         2
185 #define OPpTRANS_IDENTICAL      4       /* right side is same as left */
186 #define OPpTRANS_SQUASH         8
187     /* 16 is used for OPpTARGET_MY */
188 #define OPpTRANS_COMPLEMENT     32
189 #define OPpTRANS_GROWS          64
190 #define OPpTRANS_DELETE         128
191 #define OPpTRANS_ALL    (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
192
193 /* Private for OP_REPEAT */
194 #define OPpREPEAT_DOLIST        64      /* List replication. */
195
196 /* Private for OP_RV2GV, OP_RV2SV, OP_AELEM, OP_HELEM, OP_PADSV */
197 #define OPpDEREF                (32|64) /* autovivify: Want ref to something: */
198 #define OPpDEREF_AV             32      /*   Want ref to AV. */
199 #define OPpDEREF_HV             64      /*   Want ref to HV. */
200 #define OPpDEREF_SV             (32|64) /*   Want ref to SV. */
201
202   /* OP_ENTERSUB only */
203 #define OPpENTERSUB_DB          16      /* Debug subroutine. */
204 #define OPpENTERSUB_HASTARG     4       /* Called from OP tree. */
205 #define OPpENTERSUB_INARGS      1       /* Lval used as arg to a sub. */
206 /* used by OPpDEREF             (32|64) */
207 /* used by HINT_STRICT_SUBS     2          */
208   /* Mask for OP_ENTERSUB flags, the absence of which must be propagated
209      in dynamic context */
210 #define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
211
212   /* OP_RV2CV only */
213 #define OPpENTERSUB_AMPER       8       /* Used & form to call. */
214 #define OPpENTERSUB_NOPAREN     128     /* bare sub call (without parens) */
215 #define OPpMAY_RETURN_CONSTANT  1       /* If a constant sub, return the constant */
216
217   /* OP_GV only */
218 #define OPpEARLY_CV             32      /* foo() called before sub foo was parsed */
219   /* OP_?ELEM only */
220 #define OPpLVAL_DEFER           16      /* Defer creation of array/hash elem */
221   /* OP_RV2[SAH]V, OP_GVSV, OP_ENTERITER only */
222 #define OPpOUR_INTRO            16      /* Variable was in an our() */
223   /* OP_RV2[AGH]V, OP_PAD[AH]V, OP_[AH]ELEM, OP_[AH]SLICE OP_AV2ARYLEN,
224      OP_R?KEYS, OP_SUBSTR, OP_POS, OP_VEC */
225 #define OPpMAYBE_LVSUB          8       /* We might be an lvalue to return */
226   /* OP_RV2HV and OP_PADHV */
227 #define OPpTRUEBOOL             32      /* %hash in (%hash || $foo) in
228                                            void context */
229 #define OPpMAYBE_TRUEBOOL       64      /* %hash in (%hash || $foo) where
230                                            cx is not known till run time */
231
232   /* OP_SUBSTR only */
233 #define OPpSUBSTR_REPL_FIRST    16      /* 1st arg is replacement string */
234
235   /* OP_PADSV only */
236 #define OPpPAD_STATE            16      /* is a "state" pad */
237   /* for OP_RV2?V, lower bits carry hints (currently only HINT_STRICT_REFS) */
238
239   /* OP_PADRANGE only */
240   /* bit 7 is OPpLVAL_INTRO */
241 #define OPpPADRANGE_COUNTMASK   127     /* bits 6..0 hold target range, */
242 #define OPpPADRANGE_COUNTSHIFT  7       /* 7 bits in total */
243
244   /* OP_RV2GV only */
245 #define OPpDONT_INIT_GV         4       /* Call gv_fetchpv with GV_NOINIT */
246 /* (Therefore will return whatever is currently in the symbol table, not
247    guaranteed to be a PVGV)  */
248 #define OPpALLOW_FAKE           16      /* OK to return fake glob */
249
250 /* Private for OP_ENTERITER and OP_ITER */
251 #define OPpITER_REVERSED        4       /* for (reverse ...) */
252 #define OPpITER_DEF             8       /* for $_ or for my $_ */
253
254 /* Private for OP_CONST */
255 #define OPpCONST_NOVER          2       /* no 6; */
256 #define OPpCONST_SHORTCIRCUIT   4       /* eg the constant 5 in (5 || foo) */
257 #define OPpCONST_STRICT         8       /* bareword subject to strict 'subs' */
258 #define OPpCONST_ENTERED        16      /* Has been entered as symbol. */
259 #define OPpCONST_BARE           64      /* Was a bare word (filehandle?). */
260 #define OPpCONST_FOLDED         128     /* Result of constant folding */
261
262 /* Private for OP_FLIP/FLOP */
263 #define OPpFLIP_LINENUM         64      /* Range arg potentially a line num. */
264
265 /* Private for OP_LIST */
266 #define OPpLIST_GUESSED         64      /* Guessed that pushmark was needed. */
267
268 /* Private for OP_DELETE */
269 #define OPpSLICE                64      /* Operating on a list of keys */
270 /* Also OPpLVAL_INTRO (128) */
271
272 /* Private for OP_EXISTS */
273 #define OPpEXISTS_SUB           64      /* Checking for &sub, not {} or [].  */
274
275 /* Private for OP_SORT */
276 #define OPpSORT_NUMERIC         1       /* Optimized away { $a <=> $b } */
277 #define OPpSORT_INTEGER         2       /* Ditto while under "use integer" */
278 #define OPpSORT_REVERSE         4       /* Reversed sort */
279 #define OPpSORT_INPLACE         8       /* sort in-place; eg @a = sort @a */
280 #define OPpSORT_DESCEND         16      /* Descending sort */
281 #define OPpSORT_QSORT           32      /* Use quicksort (not mergesort) */
282 #define OPpSORT_STABLE          64      /* Use a stable algorithm */
283
284 /* Private for OP_REVERSE */
285 #define OPpREVERSE_INPLACE      8       /* reverse in-place (@a = reverse @a) */
286
287 /* Private for OP_OPEN and OP_BACKTICK */
288 #define OPpOPEN_IN_RAW          16      /* binmode(F,":raw") on input fh */
289 #define OPpOPEN_IN_CRLF         32      /* binmode(F,":crlf") on input fh */
290 #define OPpOPEN_OUT_RAW         64      /* binmode(F,":raw") on output fh */
291 #define OPpOPEN_OUT_CRLF        128     /* binmode(F,":crlf") on output fh */
292
293 /* Private for OP_EXIT, HUSH also for OP_DIE */
294 #define OPpHUSH_VMSISH          64      /* hush DCL exit msg vmsish mode*/
295 #define OPpEXIT_VMSISH          128     /* exit(0) vs. exit(1) vmsish mode*/
296
297 /* Private for OP_FTXXX */
298 #define OPpFT_ACCESS            2       /* use filetest 'access' */
299 #define OPpFT_STACKED           4       /* stacked filetest, as "-f" in "-f -x $f" */
300 #define OPpFT_STACKING          8       /* stacking filetest, as "-x" in "-f -x $f" */
301 #define OPpFT_AFTER_t           16      /* previous op was -t */
302
303 /* Private for OP_(MAP|GREP)(WHILE|START) */
304 #define OPpGREP_LEX             2       /* iterate over lexical $_ */
305     
306 /* Private for OP_ENTEREVAL */
307 #define OPpEVAL_HAS_HH          2       /* Does it have a copy of %^H */
308 #define OPpEVAL_UNICODE         4
309 #define OPpEVAL_BYTES           8
310 #define OPpEVAL_COPHH           16      /* Construct %^H from cop hints */
311     
312 /* Private for OP_CALLER, OP_WANTARRAY and OP_RUNCV */
313 #define OPpOFFBYONE             128     /* Treat caller(1) as caller(2) */
314
315 /* Private for OP_COREARGS */
316 /* These must not conflict with OPpDONT_INIT_GV or OPpALLOW_FAKE.
317    See pp.c:S_rv2gv. */
318 #define OPpCOREARGS_DEREF1      1       /* Arg 1 is a handle constructor */
319 #define OPpCOREARGS_DEREF2      2       /* Arg 2 is a handle constructor */
320 #define OPpCOREARGS_SCALARMOD   64      /* \$ rather than \[$@%*] */
321 #define OPpCOREARGS_PUSHMARK    128     /* Call pp_pushmark */
322
323 /* Private for OP_(LAST|REDO|NEXT|GOTO|DUMP) */
324 #define OPpPV_IS_UTF8           128     /* label is in UTF8 */
325
326 struct op {
327     BASEOP
328 };
329
330 struct unop {
331     BASEOP
332     OP *        op_first;
333 };
334
335 struct binop {
336     BASEOP
337     OP *        op_first;
338     OP *        op_last;
339 };
340
341 struct logop {
342     BASEOP
343     OP *        op_first;
344     OP *        op_other;
345 };
346
347 struct listop {
348     BASEOP
349     OP *        op_first;
350     OP *        op_last;
351 };
352
353 struct pmop {
354     BASEOP
355     OP *        op_first;
356     OP *        op_last;
357 #ifdef USE_ITHREADS
358     IV          op_pmoffset;
359 #else
360     REGEXP *    op_pmregexp;            /* compiled expression */
361 #endif
362     U32         op_pmflags;
363     union {
364         OP *    op_pmreplroot;          /* For OP_SUBST */
365 #ifdef USE_ITHREADS
366         PADOFFSET  op_pmtargetoff;      /* For OP_PUSHRE */
367 #else
368         GV *    op_pmtargetgv;
369 #endif
370     }   op_pmreplrootu;
371     union {
372         OP *    op_pmreplstart; /* Only used in OP_SUBST */
373 #ifdef USE_ITHREADS
374         PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
375 #else
376         HV *    op_pmstash;
377 #endif
378     }           op_pmstashstartu;
379     OP *        op_code_list;   /* list of (?{}) code blocks */
380 };
381
382 #ifdef USE_ITHREADS
383 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
384                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
385 /* The assignment is just to enforce type safety (or at least get a warning).
386  */
387 /* With first class regexps not via a reference one needs to assign
388    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
389    is cheaper. I guess we could allow NULL, but the check above would get
390    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
391 /* BEWARE - something that calls this macro passes (r) which has a side
392    effect.  */
393 #define PM_SETRE(o,r)   STMT_START {                                    \
394                             REGEXP *const _pm_setre = (r);              \
395                             assert(_pm_setre);                          \
396                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
397                         } STMT_END
398 #else
399 #define PM_GETRE(o)     ((o)->op_pmregexp)
400 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
401 #endif
402
403 /* Leave some space, so future bit allocations can go either in the shared or
404  * unshared area without affecting binary compatibility */
405 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+6)
406
407 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
408 #define PMf_RETAINT     (1<<(PMf_BASE_SHIFT+0))
409
410 /* match successfully only once per reset, with related flag RXf_USED in
411  * re->extflags holding state.  This is used only for ?? matches, and only on
412  * OP_MATCH and OP_QR */
413 #define PMf_ONCE        (1<<(PMf_BASE_SHIFT+1))
414
415 /* PMf_ONCE has matched successfully.  Not used under threading. */
416 #define PMf_USED        (1<<(PMf_BASE_SHIFT+3))
417
418 /* subst replacement is constant */
419 #define PMf_CONST       (1<<(PMf_BASE_SHIFT+4))
420
421 /* keep 1st runtime pattern forever */
422 #define PMf_KEEP        (1<<(PMf_BASE_SHIFT+5))
423
424 #define PMf_GLOBAL      (1<<(PMf_BASE_SHIFT+6)) /* pattern had a g modifier */
425
426 /* don't reset pos() if //g fails */
427 #define PMf_CONTINUE    (1<<(PMf_BASE_SHIFT+7))
428
429 /* evaluating replacement as expr */
430 #define PMf_EVAL        (1<<(PMf_BASE_SHIFT+8))
431
432 /* Return substituted string instead of modifying it. */
433 #define PMf_NONDESTRUCT (1<<(PMf_BASE_SHIFT+9))
434
435 /* the pattern has a CV attached (currently only under qr/...(?{}).../) */
436 #define PMf_HAS_CV      (1<<(PMf_BASE_SHIFT+10))
437
438 /* op_code_list is private; don't free it etc. It may well point to
439  * code within another sub, with different pad etc */
440 #define PMf_CODELIST_PRIVATE    (1<<(PMf_BASE_SHIFT+11))
441
442 /* the PMOP is a QR (we should be able to detect that from the op type,
443  * but the regex compilation API passes just the pm flags, not the op
444  * itself */
445 #define PMf_IS_QR       (1<<(PMf_BASE_SHIFT+12))
446 #define PMf_USE_RE_EVAL (1<<(PMf_BASE_SHIFT+13)) /* use re'eval' in scope */
447
448 #if PMf_BASE_SHIFT+13 > 31
449 #   error Too many PMf_ bits used.  See above and regnodes.h for any spare in middle
450 #endif
451
452 #ifdef USE_ITHREADS
453
454 #  define PmopSTASH(o)         ((o)->op_pmflags & PMf_ONCE                         \
455                                 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff]   \
456                                 : NULL)
457 #  define PmopSTASH_set(o,hv)   \
458         (assert_((o)->op_pmflags & PMf_ONCE)                            \
459          (o)->op_pmstashstartu.op_pmstashoff =                          \
460             (hv) ? alloccopstash(hv) : NULL)
461 #else
462 #  define PmopSTASH(o)                                                  \
463     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
464 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
465 #    define PmopSTASH_set(o,hv)         ({                              \
466         assert((o)->op_pmflags & PMf_ONCE);                             \
467         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
468     })
469 #  else
470 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
471 #  endif
472 #endif
473 #define PmopSTASHPV(o)  (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
474    /* op_pmstashstartu.op_pmstash is not refcounted */
475 #define PmopSTASHPV_set(o,pv)   PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
476
477 struct svop {
478     BASEOP
479     SV *        op_sv;
480 };
481
482 struct padop {
483     BASEOP
484     PADOFFSET   op_padix;
485 };
486
487 struct pvop {
488     BASEOP
489     char *      op_pv;
490 };
491
492 struct loop {
493     BASEOP
494     OP *        op_first;
495     OP *        op_last;
496     OP *        op_redoop;
497     OP *        op_nextop;
498     OP *        op_lastop;
499 };
500
501 #define cUNOPx(o)       ((UNOP*)o)
502 #define cBINOPx(o)      ((BINOP*)o)
503 #define cLISTOPx(o)     ((LISTOP*)o)
504 #define cLOGOPx(o)      ((LOGOP*)o)
505 #define cPMOPx(o)       ((PMOP*)o)
506 #define cSVOPx(o)       ((SVOP*)o)
507 #define cPADOPx(o)      ((PADOP*)o)
508 #define cPVOPx(o)       ((PVOP*)o)
509 #define cCOPx(o)        ((COP*)o)
510 #define cLOOPx(o)       ((LOOP*)o)
511
512 #define cUNOP           cUNOPx(PL_op)
513 #define cBINOP          cBINOPx(PL_op)
514 #define cLISTOP         cLISTOPx(PL_op)
515 #define cLOGOP          cLOGOPx(PL_op)
516 #define cPMOP           cPMOPx(PL_op)
517 #define cSVOP           cSVOPx(PL_op)
518 #define cPADOP          cPADOPx(PL_op)
519 #define cPVOP           cPVOPx(PL_op)
520 #define cCOP            cCOPx(PL_op)
521 #define cLOOP           cLOOPx(PL_op)
522
523 #define cUNOPo          cUNOPx(o)
524 #define cBINOPo         cBINOPx(o)
525 #define cLISTOPo        cLISTOPx(o)
526 #define cLOGOPo         cLOGOPx(o)
527 #define cPMOPo          cPMOPx(o)
528 #define cSVOPo          cSVOPx(o)
529 #define cPADOPo         cPADOPx(o)
530 #define cPVOPo          cPVOPx(o)
531 #define cCOPo           cCOPx(o)
532 #define cLOOPo          cLOOPx(o)
533
534 #define kUNOP           cUNOPx(kid)
535 #define kBINOP          cBINOPx(kid)
536 #define kLISTOP         cLISTOPx(kid)
537 #define kLOGOP          cLOGOPx(kid)
538 #define kPMOP           cPMOPx(kid)
539 #define kSVOP           cSVOPx(kid)
540 #define kPADOP          cPADOPx(kid)
541 #define kPVOP           cPVOPx(kid)
542 #define kCOP            cCOPx(kid)
543 #define kLOOP           cLOOPx(kid)
544
545
546 #ifdef USE_ITHREADS
547 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
548 #  define       IS_PADGV(v)     (v && SvTYPE(v) == SVt_PVGV && isGV_with_GP(v) \
549                                  && GvIN_PAD(v))
550 #  define       IS_PADCONST(v) \
551         (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
552 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
553                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
554 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
555                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
556 #else
557 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
558 #  define       IS_PADGV(v)     FALSE
559 #  define       IS_PADCONST(v)  FALSE
560 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
561 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
562 #endif
563
564 #define cGVOP_gv                cGVOPx_gv(PL_op)
565 #define cGVOPo_gv               cGVOPx_gv(o)
566 #define kGVOP_gv                cGVOPx_gv(kid)
567 #define cSVOP_sv                cSVOPx_sv(PL_op)
568 #define cSVOPo_sv               cSVOPx_sv(o)
569 #define kSVOP_sv                cSVOPx_sv(kid)
570
571 #ifndef PERL_CORE
572 #  define Nullop ((OP*)NULL)
573 #endif
574
575 /* Lowest byte of PL_opargs */
576 #define OA_MARK 1
577 #define OA_FOLDCONST 2
578 #define OA_RETSCALAR 4
579 #define OA_TARGET 8
580 #define OA_TARGLEX 16
581 #define OA_OTHERINT 32
582 #define OA_DANGEROUS 64
583 #define OA_DEFGV 128
584
585 /* The next 4 bits encode op class information */
586 #define OCSHIFT 8
587
588 #define OA_CLASS_MASK (15 << OCSHIFT)
589
590 #define OA_BASEOP (0 << OCSHIFT)
591 #define OA_UNOP (1 << OCSHIFT)
592 #define OA_BINOP (2 << OCSHIFT)
593 #define OA_LOGOP (3 << OCSHIFT)
594 #define OA_LISTOP (4 << OCSHIFT)
595 #define OA_PMOP (5 << OCSHIFT)
596 #define OA_SVOP (6 << OCSHIFT)
597 #define OA_PADOP (7 << OCSHIFT)
598 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
599 #define OA_LOOP (9 << OCSHIFT)
600 #define OA_COP (10 << OCSHIFT)
601 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
602 #define OA_FILESTATOP (12 << OCSHIFT)
603 #define OA_LOOPEXOP (13 << OCSHIFT)
604
605 #define OASHIFT 12
606
607 /* Remaining nybbles of PL_opargs */
608 #define OA_SCALAR 1
609 #define OA_LIST 2
610 #define OA_AVREF 3
611 #define OA_HVREF 4
612 #define OA_CVREF 5
613 #define OA_FILEREF 6
614 #define OA_SCALARREF 7
615 #define OA_OPTIONAL 8
616
617 /* Op_REFCNT is a reference count at the head of each op tree: needed
618  * since the tree is shared between threads, and between cloned closure
619  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
620  * this count.
621  * The same mutex is used to protect the refcounts of the reg_trie_data
622  * and reg_ac_data structures, which are shared between duplicated
623  * regexes.
624  */
625
626 #ifdef USE_ITHREADS
627 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
628 #  ifdef PERL_CORE
629 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
630 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
631 #  else
632 #    define OP_REFCNT_LOCK              op_refcnt_lock()
633 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
634 #  endif
635 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
636 #else
637 #  define OP_REFCNT_INIT                NOOP
638 #  define OP_REFCNT_LOCK                NOOP
639 #  define OP_REFCNT_UNLOCK              NOOP
640 #  define OP_REFCNT_TERM                NOOP
641 #endif
642
643 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
644 #ifdef PERL_DEBUG_READONLY_OPS
645 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
646 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
647 #else
648 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
649 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
650 #endif
651
652 /* flags used by Perl_load_module() */
653 #define PERL_LOADMOD_DENY               0x1     /* no Module */
654 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
655 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* use Module (...) */
656
657 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C)
658 #define ref(o, type) doref(o, type, TRUE)
659 #endif
660
661 /*
662 =head1 Optree Manipulation Functions
663
664 =for apidoc Am|OP*|LINKLIST|OP *o
665 Given the root of an optree, link the tree in execution order using the
666 C<op_next> pointers and return the first op executed. If this has
667 already been done, it will not be redone, and C<< o->op_next >> will be
668 returned. If C<< o->op_next >> is not already set, I<o> should be at
669 least an C<UNOP>.
670
671 =cut
672 */
673
674 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
675
676 /* no longer used anywhere in core */
677 #ifndef PERL_CORE
678 #define cv_ckproto(cv, gv, p) \
679    cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
680 #endif
681
682 #ifdef PERL_CORE
683 #  define my(o) my_attrs((o), NULL)
684 #endif
685
686 #ifdef USE_REENTRANT_API
687 #include "reentr.h"
688 #endif
689
690 #define NewOp(m,var,c,type)     \
691         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
692 #define NewOpSz(m,var,size)     \
693         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
694 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
695
696 /*
697  * The per-CV op slabs consist of a header (the opslab struct) and a bunch
698  * of space for allocating op slots, each of which consists of two pointers
699  * followed by an op.  The first pointer points to the next op slot.  The
700  * second points to the slab.  At the end of the slab is a null pointer,
701  * so that slot->opslot_next - slot can be used to determine the size
702  * of the op.
703  *
704  * Each CV can have multiple slabs; opslab_next points to the next slab, to
705  * form a chain.  All bookkeeping is done on the first slab, which is where
706  * all the op slots point.
707  *
708  * Freed ops are marked as freed and attached to the freed chain
709  * via op_next pointers.
710  *
711  * When there is more than one slab, the second slab in the slab chain is
712  * assumed to be the one with free space available.  It is used when allo-
713  * cating an op if there are no freed ops available or big enough.
714  */
715
716 #ifdef PERL_CORE
717 struct opslot {
718     /* keep opslot_next first */
719     OPSLOT *    opslot_next;            /* next slot */
720     OPSLAB *    opslot_slab;            /* owner */
721     OP          opslot_op;              /* the op itself */
722 };
723
724 struct opslab {
725     OPSLOT *    opslab_first;           /* first op in this slab */
726     OPSLAB *    opslab_next;            /* next slab */
727     OP *        opslab_freed;           /* chain of freed ops */
728     size_t      opslab_refcnt;          /* number of ops */
729 # ifdef PERL_DEBUG_READONLY_OPS
730     U16         opslab_size;            /* size of slab in pointers */
731     bool        opslab_readonly;
732 # endif
733     OPSLOT      opslab_slots;           /* slots begin here */
734 };
735
736 # define OPSLOT_HEADER          STRUCT_OFFSET(OPSLOT, opslot_op)
737 # define OPSLOT_HEADER_P        (OPSLOT_HEADER/sizeof(I32 *))
738 # define OpSLOT(o)              (assert_(o->op_slabbed) \
739                                  (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
740 # define OpSLAB(o)              OpSLOT(o)->opslot_slab
741 # define OpslabREFCNT_dec(slab)      \
742         (((slab)->opslab_refcnt == 1) \
743          ? opslab_free_nopad(slab)     \
744          : (void)--(slab)->opslab_refcnt)
745   /* Variant that does not null out the pads */
746 # define OpslabREFCNT_dec_padok(slab) \
747         (((slab)->opslab_refcnt == 1)  \
748          ? opslab_free(slab)            \
749          : (void)--(slab)->opslab_refcnt)
750 #endif
751
752 struct block_hooks {
753     U32     bhk_flags;
754     void    (*bhk_start)        (pTHX_ int full);
755     void    (*bhk_pre_end)      (pTHX_ OP **seq);
756     void    (*bhk_post_end)     (pTHX_ OP **seq);
757     void    (*bhk_eval)         (pTHX_ OP *const saveop);
758 };
759
760 /*
761 =head1 Compile-time scope hooks
762
763 =for apidoc mx|U32|BhkFLAGS|BHK *hk
764 Return the BHK's flags.
765
766 =for apidoc mx|void *|BhkENTRY|BHK *hk|which
767 Return an entry from the BHK structure. I<which> is a preprocessor token
768 indicating which entry to return. If the appropriate flag is not set
769 this will return NULL. The type of the return value depends on which
770 entry you ask for.
771
772 =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
773 Set an entry in the BHK structure, and set the flags to indicate it is
774 valid. I<which> is a preprocessing token indicating which entry to set.
775 The type of I<ptr> depends on the entry.
776
777 =for apidoc Amx|void|BhkDISABLE|BHK *hk|which
778 Temporarily disable an entry in this BHK structure, by clearing the
779 appropriate flag. I<which> is a preprocessor token indicating which
780 entry to disable.
781
782 =for apidoc Amx|void|BhkENABLE|BHK *hk|which
783 Re-enable an entry in this BHK structure, by setting the appropriate
784 flag. I<which> is a preprocessor token indicating which entry to enable.
785 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
786 pointer.
787
788 =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
789 Call all the registered block hooks for type I<which>. I<which> is a
790 preprocessing token; the type of I<arg> depends on I<which>.
791
792 =cut
793 */
794
795 #define BhkFLAGS(hk)            ((hk)->bhk_flags)
796
797 #define BHKf_bhk_start      0x01
798 #define BHKf_bhk_pre_end    0x02
799 #define BHKf_bhk_post_end   0x04
800 #define BHKf_bhk_eval       0x08
801
802 #define BhkENTRY(hk, which) \
803     ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
804
805 #define BhkENABLE(hk, which) \
806     STMT_START { \
807         BhkFLAGS(hk) |= BHKf_ ## which; \
808         assert(BhkENTRY(hk, which)); \
809     } STMT_END
810
811 #define BhkDISABLE(hk, which) \
812     STMT_START { \
813         BhkFLAGS(hk) &= ~(BHKf_ ## which); \
814     } STMT_END
815
816 #define BhkENTRY_set(hk, which, ptr) \
817     STMT_START { \
818         (hk)->which = ptr; \
819         BhkENABLE(hk, which); \
820     } STMT_END
821
822 #define CALL_BLOCK_HOOKS(which, arg) \
823     STMT_START { \
824         if (PL_blockhooks) { \
825             I32 i; \
826             for (i = av_len(PL_blockhooks); i >= 0; i--) { \
827                 SV *sv = AvARRAY(PL_blockhooks)[i]; \
828                 BHK *hk; \
829                 \
830                 assert(SvIOK(sv)); \
831                 if (SvUOK(sv)) \
832                     hk = INT2PTR(BHK *, SvUVX(sv)); \
833                 else \
834                     hk = INT2PTR(BHK *, SvIVX(sv)); \
835                 \
836                 if (BhkENTRY(hk, which)) \
837                     BhkENTRY(hk, which)(aTHX_ arg); \
838             } \
839         } \
840     } STMT_END
841
842 /* flags for rv2cv_op_cv */
843
844 #define RV2CVOPCV_MARK_EARLY     0x00000001
845 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
846
847 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
848
849 /* flags for op_lvalue_flags */
850
851 #define OP_LVALUE_NO_CROAK 1
852
853 /*
854 =head1 Custom Operators
855
856 =for apidoc Am|U32|XopFLAGS|XOP *xop
857 Return the XOP's flags.
858
859 =for apidoc Am||XopENTRY|XOP *xop|which
860 Return a member of the XOP structure. I<which> is a cpp token indicating
861 which entry to return. If the member is not set this will return a
862 default value. The return type depends on I<which>.
863
864 =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
865 Set a member of the XOP structure. I<which> is a cpp token indicating
866 which entry to set. See L<perlguts/"Custom Operators"> for details about
867 the available members and how they are used.
868
869 =for apidoc Am|void|XopDISABLE|XOP *xop|which
870 Temporarily disable a member of the XOP, by clearing the appropriate flag.
871
872 =for apidoc Am|void|XopENABLE|XOP *xop|which
873 Reenable a member of the XOP which has been disabled.
874
875 =cut
876 */
877
878 struct custom_op {
879     U32             xop_flags;    
880     const char     *xop_name;
881     const char     *xop_desc;
882     U32             xop_class;
883     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
884 };
885
886 #define XopFLAGS(xop) ((xop)->xop_flags)
887
888 #define XOPf_xop_name   0x01
889 #define XOPf_xop_desc   0x02
890 #define XOPf_xop_class  0x04
891 #define XOPf_xop_peep   0x08
892
893 #define XOPd_xop_name   PL_op_name[OP_CUSTOM]
894 #define XOPd_xop_desc   PL_op_desc[OP_CUSTOM]
895 #define XOPd_xop_class  OA_BASEOP
896 #define XOPd_xop_peep   ((Perl_cpeep_t)0)
897
898 #define XopENTRY_set(xop, which, to) \
899     STMT_START { \
900         (xop)->which = (to); \
901         (xop)->xop_flags |= XOPf_ ## which; \
902     } STMT_END
903
904 #define XopENTRY(xop, which) \
905     ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
906
907 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
908 #define XopENABLE(xop, which) \
909     STMT_START { \
910         (xop)->xop_flags |= XOPf_ ## which; \
911         assert(XopENTRY(xop, which)); \
912     } STMT_END
913
914 /*
915 =head1 Optree Manipulation Functions
916
917 =for apidoc Am|const char *|OP_NAME|OP *o
918 Return the name of the provided OP. For core ops this looks up the name
919 from the op_type; for custom ops from the op_ppaddr.
920
921 =for apidoc Am|const char *|OP_DESC|OP *o
922 Return a short description of the provided OP.
923
924 =for apidoc Am|U32|OP_CLASS|OP *o
925 Return the class of the provided OP: that is, which of the *OP
926 structures it uses. For core ops this currently gets the information out
927 of PL_opargs, which does not always accurately reflect the type used.
928 For custom ops the type is returned from the registration, and it is up
929 to the registree to ensure it is accurate. The value returned will be
930 one of the OA_* constants from op.h.
931
932 =cut
933 */
934
935 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
936                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_name) \
937                     : PL_op_name[(o)->op_type])
938 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
939                     ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_desc) \
940                     : PL_op_desc[(o)->op_type])
941 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
942                      ? XopENTRY(Perl_custom_op_xop(aTHX_ o), xop_class) \
943                      : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
944
945 #define newSUB(f, o, p, b)      Perl_newATTRSUB(aTHX_ (f), (o), (p), NULL, (b))
946
947 #ifdef PERL_MAD
948 #  define MAD_NULL 1
949 #  define MAD_PV 2
950 #  define MAD_OP 3
951 #  define MAD_SV 4
952
953 struct madprop {
954     MADPROP* mad_next;
955     void *mad_val;
956     U32 mad_vlen;
957 /*    short mad_count; */
958     char mad_key;
959     char mad_type;
960 };
961
962 struct token {
963     I32 tk_type;
964     YYSTYPE tk_lval;
965     MADPROP* tk_mad;
966 };
967 #endif
968
969 /*
970  * Values that can be held by mad_key :
971  * ^       unfilled head spot
972  * ,       literal ,
973  * ;       literal ; (blank if implicit ; at end of block)
974  * :       literal : from ?: or attr list
975  * +       unary +
976  * ?       literal ? from ?:
977  * (       literal (
978  * )       literal )
979  * [       literal [
980  * ]       literal ]
981  * {       literal {
982  * }       literal }
983  * @       literal @ sigil
984  * $       literal $ sigil
985  * *       literal * sigil
986  * !       use is source filtered
987  * &       & or sub
988  * #       whitespace/comment following ; or }
989  * #       $# sigil
990  * 1       1st ; from for(;;)
991  * 1       retired protasis
992  * 2       2nd ; from for(;;)
993  * 2       retired apodosis
994  * 3       C-style for list
995  * a       sub or var attributes
996  * a       non-method arrow operator
997  * A       method arrow operator
998  * A       use import args
999  * b       format block
1000  * B       retired stub block
1001  * C       constant conditional op
1002  * d       declarator
1003  * D       do block
1004  * e       unreached "else" (see C)
1005  * e       expression producing E
1006  * E       tr/E/R/, /E/
1007  * f       folded constant op
1008  * F       peg op for format
1009  * g       op was forced to be a word
1010  * i       if/unless modifier
1011  * I       if/elsif/unless statement
1012  * k       local declarator
1013  * K       retired kid op
1014  * l       last index of array ($#foo)
1015  * L       label
1016  * m       modifier on regex
1017  * n       sub or format name
1018  * o       current operator/declarator name
1019  * o       else/continue
1020  * O       generic optimized op
1021  * p       peg to hold extra whitespace at statement level
1022  * P       peg op for package declaration
1023  * q       opening quote
1024  * =       quoted material
1025  * Q       closing quote
1026  * Q       optimized qw//
1027  * r       expression producing R
1028  * R       tr/E/R/ s/E/R/
1029  * s       sub signature
1030  * S       use import stub (no import)
1031  * S       retired sort block
1032  * t       unreached "then" (see C)
1033  * U       use import op
1034  * v       private sv of for loop
1035  * V       use version
1036  * w       while/until modifier
1037  * W       while/for statement
1038  * x       optimized qw
1039  * X       random thing
1040  * _       whitespace/comments preceding anything else
1041  * ~       =~ operator
1042  */
1043
1044 /*
1045 =head1 Hook manipulation
1046 */
1047
1048 #ifdef USE_ITHREADS
1049 #  define OP_CHECK_MUTEX_INIT           MUTEX_INIT(&PL_check_mutex)
1050 #  define OP_CHECK_MUTEX_LOCK           MUTEX_LOCK(&PL_check_mutex)
1051 #  define OP_CHECK_MUTEX_UNLOCK         MUTEX_UNLOCK(&PL_check_mutex)
1052 #  define OP_CHECK_MUTEX_TERM           MUTEX_DESTROY(&PL_check_mutex)
1053 #else
1054 #  define OP_CHECK_MUTEX_INIT           NOOP
1055 #  define OP_CHECK_MUTEX_LOCK           NOOP
1056 #  define OP_CHECK_MUTEX_UNLOCK         NOOP
1057 #  define OP_CHECK_MUTEX_TERM           NOOP
1058 #endif
1059
1060 /*
1061  * Local variables:
1062  * c-indentation-style: bsd
1063  * c-basic-offset: 4
1064  * indent-tabs-mode: nil
1065  * End:
1066  *
1067  * ex: set ts=8 sts=4 sw=4 et:
1068  */