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