perlop: m?? requires the m in v5.22, not v5.24
[perl.git] / op.h
1 /*    op.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4  *    2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 /*
12  * The fields of BASEOP are:
13  *      op_next         Pointer to next ppcode to execute after this one.
14  *                      (Top level pre-grafted op points to first op,
15  *                      but this is replaced when op is grafted in, when
16  *                      this op will point to the real next op, and the new
17  *                      parent takes over role of remembering starting op.)
18  *      op_ppaddr       Pointer to current ppcode's function.
19  *      op_type         The type of the operation.
20  *      op_opt          Whether or not the op has been optimised by the
21  *                      peephole optimiser.
22  *      op_slabbed      allocated via opslab
23  *      op_static       tell op_free() to skip PerlMemShared_free(), when
24  *                      !op_slabbed.
25  *      op_savefree     on savestack via SAVEFREEOP
26  *      op_folded       Result/remainder of a constant fold operation.
27  *      op_lastsib      this op is is the last sibling
28  *      op_spare        One spare bit
29  *      op_flags        Flags common to all operations.  See OPf_* below.
30  *      op_private      Flags peculiar to a particular operation (BUT,
31  *                      by default, set to the number of children until
32  *                      the operation is privatized by a check routine,
33  *                      which may or may not check number of children).
34  */
35 #include "op_reg_common.h"
36
37 #define OPCODE U16
38
39 typedef PERL_BITFIELD16 Optype;
40
41 #ifdef BASEOP_DEFINITION
42 #define BASEOP BASEOP_DEFINITION
43 #else
44 #define BASEOP                          \
45     OP*         op_next;                \
46     OP*         op_sibling;             \
47     OP*         (*op_ppaddr)(pTHX);     \
48     PADOFFSET   op_targ;                \
49     PERL_BITFIELD16 op_type:9;          \
50     PERL_BITFIELD16 op_opt:1;           \
51     PERL_BITFIELD16 op_slabbed:1;       \
52     PERL_BITFIELD16 op_savefree:1;      \
53     PERL_BITFIELD16 op_static:1;        \
54     PERL_BITFIELD16 op_folded:1;        \
55     PERL_BITFIELD16 op_lastsib:1;       \
56     PERL_BITFIELD16 op_spare:1;         \
57     U8          op_flags;               \
58     U8          op_private;
59 #endif
60
61 /* If op_type:9 is changed to :10, also change PUSHEVAL in cop.h.
62    Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
63    then all the other bit-fields before/after it should change their
64    types too to let VC pack them into the same 4 byte integer.*/
65
66 /* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
67 #define OP_GIMME(op,dfl) \
68         (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
69
70 #define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
71
72 /*
73 =head1 "Gimme" Values
74
75 =for apidoc Amn|U32|GIMME_V
76 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
77 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
78 respectively.  See L<perlcall> for a usage example.
79
80 =for apidoc Amn|U32|GIMME
81 A backward-compatible version of C<GIMME_V> which can only return
82 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
83 Deprecated.  Use C<GIMME_V> instead.
84
85 =cut
86 */
87
88 #define GIMME_V         OP_GIMME(PL_op, block_gimme())
89
90 /* Public flags */
91
92 #define OPf_WANT        3       /* Mask for "want" bits: */
93 #define  OPf_WANT_VOID   1      /*   Want nothing */
94 #define  OPf_WANT_SCALAR 2      /*   Want single value */
95 #define  OPf_WANT_LIST   3      /*   Want list of any length */
96 #define OPf_KIDS        4       /* There is a firstborn child. */
97 #define OPf_PARENS      8       /* This operator was parenthesized. */
98                                 /*  (Or block needs explicit scope entry.) */
99 #define OPf_REF         16      /* Certified reference. */
100                                 /*  (Return container, not containee). */
101 #define OPf_MOD         32      /* Will modify (lvalue). */
102 #define OPf_STACKED     64      /* Some arg is arriving on the stack. */
103 #define OPf_SPECIAL     128     /* Do something weird for this op: */
104                                 /*  On local LVAL, don't init local value. */
105                                 /*  On OP_SORT, subroutine is inlined. */
106                                 /*  On OP_NOT, inversion was implicit. */
107                                 /*  On OP_LEAVE, don't restore curpm. */
108                                 /*  On truncate, we truncate filehandle */
109                                 /*  On control verbs, we saw no label */
110                                 /*  On flipflop, we saw ... instead of .. */
111                                 /*  On UNOPs, saw bare parens, e.g. eof(). */
112                                 /*  On OP_CHDIR, handle (or bare parens) */
113                                 /*  On OP_NULL, saw a "do". */
114                                 /*  On OP_EXISTS, treat av as av, not avhv.  */
115                                 /*  On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
116                                 /*  On pushre, rx is used as part of split, e.g. split " " */
117                                 /*  On regcomp, "use re 'eval'" was in scope */
118                                 /*  On RV2[ACGHS]V, don't create GV--in
119                                     defined()*/
120                                 /*  On OP_DBSTATE, indicates breakpoint
121                                  *    (runtime property) */
122                                 /*  On OP_REQUIRE, was seen as CORE::require */
123                                 /*  On OP_(ENTER|LEAVE)WHEN, there's
124                                     no condition */
125                                 /*  On OP_SMARTMATCH, an implicit smartmatch */
126                                 /*  On OP_ANONHASH and OP_ANONLIST, create a
127                                     reference to the new anon hash or array */
128                                 /*  On OP_HELEM, OP_MULTIDEREF and OP_HSLICE,
129                                     localization will be followed by assignment,
130                                     so do not wipe the target if it is special
131                                     (e.g. a glob or a magic SV) */
132                                 /*  On OP_MATCH, OP_SUBST & OP_TRANS, the
133                                     operand of a logical or conditional
134                                     that was optimised away, so it should
135                                     not be bound via =~ */
136                                 /*  On OP_CONST, from a constant CV */
137                                 /*  On OP_GLOB, two meanings:
138                                     - Before ck_glob, called as CORE::glob
139                                     - After ck_glob, use Perl glob function
140                                  */
141                                 /*  On OP_PADRANGE, push @_ */
142                                 /*  On OP_DUMP, has no label */
143                                 /*  On OP_UNSTACK, in a C-style for loop */
144 /* There is no room in op_flags for this one, so it has its own bit-
145    field member (op_folded) instead.  The flag is only used to tell
146    op_convert_list to set op_folded.  */
147 #define OPf_FOLDED      1<<16
148
149 /* old names; don't use in new code, but don't break them, either */
150 #define OPf_LIST        OPf_WANT_LIST
151 #define OPf_KNOW        OPf_WANT
152
153 #if !defined(PERL_CORE) && !defined(PERL_EXT)
154 #  define GIMME \
155           (PL_op->op_flags & OPf_WANT                                   \
156            ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST             \
157               ? G_ARRAY                                                 \
158               : G_SCALAR)                                               \
159            : dowantarray())
160 #endif
161
162
163 /* NOTE: OPp* flags are now auto-generated and defined in opcode.h,
164  *       from data in regen/op_private */
165
166
167 #define OPpTRANS_ALL    (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
168
169
170
171 /* Mask for OP_ENTERSUB flags, the absence of which must be propagated
172  in dynamic context */
173 #define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
174
175
176 /* things that can be elements of op_aux */
177 typedef union  {
178     PADOFFSET pad_offset;
179     SV        *sv;
180     IV        iv;
181     UV        uv;
182 } UNOP_AUX_item;
183
184 #ifdef USE_ITHREADS
185 #  define UNOP_AUX_item_sv(item) PAD_SVl((item)->pad_offset);
186 #else
187 #  define UNOP_AUX_item_sv(item) ((item)->sv);
188 #endif
189
190
191
192
193 struct op {
194     BASEOP
195 };
196
197 struct unop {
198     BASEOP
199     OP *        op_first;
200 };
201
202 struct unop_aux {
203     BASEOP
204     OP            *op_first;
205     UNOP_AUX_item *op_aux;
206 };
207
208 struct binop {
209     BASEOP
210     OP *        op_first;
211     OP *        op_last;
212 };
213
214 struct logop {
215     BASEOP
216     OP *        op_first;
217     OP *        op_other;
218 };
219
220 struct listop {
221     BASEOP
222     OP *        op_first;
223     OP *        op_last;
224 };
225
226 struct methop {
227     BASEOP
228     union {
229         /* op_u.op_first *must* be aligned the same as the op_first
230          * field of the other op types, and op_u.op_meth_sv *must*
231          * be aligned with op_sv */
232         OP* op_first;   /* optree for method name */
233         SV* op_meth_sv; /* static method name */
234     } op_u;
235 #ifdef USE_ITHREADS
236     PADOFFSET op_rclass_targ; /* pad index for redirect class */
237 #else
238     SV*       op_rclass_sv;   /* static redirect class $o->A::meth() */
239 #endif
240 };
241
242 struct pmop {
243     BASEOP
244     OP *        op_first;
245     OP *        op_last;
246 #ifdef USE_ITHREADS
247     PADOFFSET   op_pmoffset;
248 #else
249     REGEXP *    op_pmregexp;            /* compiled expression */
250 #endif
251     U32         op_pmflags;
252     union {
253         OP *    op_pmreplroot;          /* For OP_SUBST */
254 #ifdef USE_ITHREADS
255         PADOFFSET  op_pmtargetoff;      /* For OP_PUSHRE */
256 #else
257         GV *    op_pmtargetgv;
258 #endif
259     }   op_pmreplrootu;
260     union {
261         OP *    op_pmreplstart; /* Only used in OP_SUBST */
262 #ifdef USE_ITHREADS
263         PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
264 #else
265         HV *    op_pmstash;
266 #endif
267     }           op_pmstashstartu;
268     OP *        op_code_list;   /* list of (?{}) code blocks */
269 };
270
271 #ifdef USE_ITHREADS
272 #define PM_GETRE(o)     (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
273                          ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
274 /* The assignment is just to enforce type safety (or at least get a warning).
275  */
276 /* With first class regexps not via a reference one needs to assign
277    &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
278    is cheaper. I guess we could allow NULL, but the check above would get
279    more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
280 /* BEWARE - something that calls this macro passes (r) which has a side
281    effect.  */
282 #define PM_SETRE(o,r)   STMT_START {                                    \
283                             REGEXP *const _pm_setre = (r);              \
284                             assert(_pm_setre);                          \
285                             PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
286                         } STMT_END
287 #else
288 #define PM_GETRE(o)     ((o)->op_pmregexp)
289 #define PM_SETRE(o,r)   ((o)->op_pmregexp = (r))
290 #endif
291
292 /* Currently these PMf flags occupy a single 32-bit word.  Not all bits are
293  * currently used.  The lower bits are shared with their corresponding RXf flag
294  * bits, up to but not including _RXf_PMf_SHIFT_NEXT.  The unused bits
295  * immediately follow; finally the used Pmf-only (unshared) bits, so that the
296  * highest bit in the word is used.  This gathers all the unused bits as a pool
297  * in the middle, like so: 11111111111111110000001111111111
298  * where the '1's represent used bits, and the '0's unused.  This design allows
299  * us to allocate off one end of the pool if we need to add a shared bit, and
300  * off the other end if we need a non-shared bit, without disturbing the other
301  * bits.  This maximizes the likelihood of being able to change things without
302  * breaking binary compatibility.
303  *
304  * To add shared bits, do so in op_reg_common.h.  This should change
305  * _RXf_PMf_SHIFT_NEXT so that things won't compile.  Then come to regexp.h and
306  * op.h and adjust the constant adders in the definitions of PMf_BASE_SHIFT and
307  * Pmf_BASE_SHIFT down by the number of shared bits you added.  That's it.
308  * Things should be binary compatible.  But if either of these gets to having
309  * to subtract rather than add, leave at 0 and adjust all the entries below
310  * that are in terms of this according.  But if the first one of those is
311  * already PMf_BASE_SHIFT+0, there are no bits left, and a redesign is in
312  * order.
313  *
314  * To remove unshared bits, just delete its entry.  If you're where breaking
315  * binary compatibility is ok to do, you might want to adjust things to move
316  * the newly opened space so that it gets absorbed into the common pool.
317  *
318  * To add unshared bits, first use up any gaps in the middle.  Otherwise,
319  * allocate off the low end until you get to PMf_BASE_SHIFT+0.  If that isn't
320  * enough, move PMf_BASE_SHIFT down (if possible) and add the new bit at the
321  * other end instead; this preserves binary compatibility. */
322 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+2)
323
324 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
325 #define PMf_RETAINT     (1U<<(PMf_BASE_SHIFT+5))
326
327 /* match successfully only once per reset, with related flag RXf_USED in
328  * re->extflags holding state.  This is used only for ?? matches, and only on
329  * OP_MATCH and OP_QR */
330 #define PMf_ONCE        (1U<<(PMf_BASE_SHIFT+6))
331
332 /* PMf_ONCE, i.e. ?pat?, has matched successfully.  Not used under threading. */
333 #define PMf_USED        (1U<<(PMf_BASE_SHIFT+7))
334
335 /* subst replacement is constant */
336 #define PMf_CONST       (1U<<(PMf_BASE_SHIFT+8))
337
338 /* keep 1st runtime pattern forever */
339 #define PMf_KEEP        (1U<<(PMf_BASE_SHIFT+9))
340
341 #define PMf_GLOBAL      (1U<<(PMf_BASE_SHIFT+10)) /* pattern had a g modifier */
342
343 /* don't reset pos() if //g fails */
344 #define PMf_CONTINUE    (1U<<(PMf_BASE_SHIFT+11))
345
346 /* evaluating replacement as expr */
347 #define PMf_EVAL        (1U<<(PMf_BASE_SHIFT+12))
348
349 /* Return substituted string instead of modifying it. */
350 #define PMf_NONDESTRUCT (1U<<(PMf_BASE_SHIFT+13))
351
352 /* the pattern has a CV attached (currently only under qr/...(?{}).../) */
353 #define PMf_HAS_CV      (1U<<(PMf_BASE_SHIFT+14))
354
355 /* op_code_list is private; don't free it etc. It may well point to
356  * code within another sub, with different pad etc */
357 #define PMf_CODELIST_PRIVATE    (1U<<(PMf_BASE_SHIFT+15))
358
359 /* the PMOP is a QR (we should be able to detect that from the op type,
360  * but the regex compilation API passes just the pm flags, not the op
361  * itself */
362 #define PMf_IS_QR       (1U<<(PMf_BASE_SHIFT+16))
363 #define PMf_USE_RE_EVAL (1U<<(PMf_BASE_SHIFT+17)) /* use re'eval' in scope */
364
365 /* See comments at the beginning of these defines about adding bits.  The
366  * highest bit position should be used, so that if PMf_BASE_SHIFT gets
367  * increased, the #error below will be triggered so that you will be reminded
368  * to adjust things at the other end to keep the bit positions unchanged */
369 #if PMf_BASE_SHIFT+17 > 31
370 #   error Too many PMf_ bits used.  See above and regnodes.h for any spare in middle
371 #endif
372
373 #ifdef USE_ITHREADS
374
375 #  define PmopSTASH(o)         ((o)->op_pmflags & PMf_ONCE                         \
376                                 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff]   \
377                                 : NULL)
378 #  define PmopSTASH_set(o,hv)   \
379         (assert_((o)->op_pmflags & PMf_ONCE)                            \
380          (o)->op_pmstashstartu.op_pmstashoff =                          \
381             (hv) ? alloccopstash(hv) : 0)
382 #else
383 #  define PmopSTASH(o)                                                  \
384     (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
385 #  if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
386 #    define PmopSTASH_set(o,hv)         ({                              \
387         assert((o)->op_pmflags & PMf_ONCE);                             \
388         ((o)->op_pmstashstartu.op_pmstash = (hv));                      \
389     })
390 #  else
391 #    define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
392 #  endif
393 #endif
394 #define PmopSTASHPV(o)  (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
395    /* op_pmstashstartu.op_pmstash is not refcounted */
396 #define PmopSTASHPV_set(o,pv)   PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
397
398 struct svop {
399     BASEOP
400     SV *        op_sv;
401 };
402
403 struct padop {
404     BASEOP
405     PADOFFSET   op_padix;
406 };
407
408 struct pvop {
409     BASEOP
410     char *      op_pv;
411 };
412
413 struct loop {
414     BASEOP
415     OP *        op_first;
416     OP *        op_last;
417     OP *        op_redoop;
418     OP *        op_nextop;
419     OP *        op_lastop;
420 };
421
422 #define cUNOPx(o)       ((UNOP*)(o))
423 #define cUNOP_AUXx(o)   ((UNOP_AUX*)(o))
424 #define cBINOPx(o)      ((BINOP*)(o))
425 #define cLISTOPx(o)     ((LISTOP*)(o))
426 #define cLOGOPx(o)      ((LOGOP*)(o))
427 #define cPMOPx(o)       ((PMOP*)(o))
428 #define cSVOPx(o)       ((SVOP*)(o))
429 #define cPADOPx(o)      ((PADOP*)(o))
430 #define cPVOPx(o)       ((PVOP*)(o))
431 #define cCOPx(o)        ((COP*)(o))
432 #define cLOOPx(o)       ((LOOP*)(o))
433 #define cMETHOPx(o)     ((METHOP*)(o))
434
435 #define cUNOP           cUNOPx(PL_op)
436 #define cUNOP_AUX       cUNOP_AUXx(PL_op)
437 #define cBINOP          cBINOPx(PL_op)
438 #define cLISTOP         cLISTOPx(PL_op)
439 #define cLOGOP          cLOGOPx(PL_op)
440 #define cPMOP           cPMOPx(PL_op)
441 #define cSVOP           cSVOPx(PL_op)
442 #define cPADOP          cPADOPx(PL_op)
443 #define cPVOP           cPVOPx(PL_op)
444 #define cCOP            cCOPx(PL_op)
445 #define cLOOP           cLOOPx(PL_op)
446
447 #define cUNOPo          cUNOPx(o)
448 #define cUNOP_AUXo      cUNOP_AUXx(o)
449 #define cBINOPo         cBINOPx(o)
450 #define cLISTOPo        cLISTOPx(o)
451 #define cLOGOPo         cLOGOPx(o)
452 #define cPMOPo          cPMOPx(o)
453 #define cSVOPo          cSVOPx(o)
454 #define cPADOPo         cPADOPx(o)
455 #define cPVOPo          cPVOPx(o)
456 #define cCOPo           cCOPx(o)
457 #define cLOOPo          cLOOPx(o)
458
459 #define kUNOP           cUNOPx(kid)
460 #define kUNOP_AUX       cUNOP_AUXx(kid)
461 #define kBINOP          cBINOPx(kid)
462 #define kLISTOP         cLISTOPx(kid)
463 #define kLOGOP          cLOGOPx(kid)
464 #define kPMOP           cPMOPx(kid)
465 #define kSVOP           cSVOPx(kid)
466 #define kPADOP          cPADOPx(kid)
467 #define kPVOP           cPVOPx(kid)
468 #define kCOP            cCOPx(kid)
469 #define kLOOP           cLOOPx(kid)
470
471
472 #ifdef USE_ITHREADS
473 #  define       cGVOPx_gv(o)    ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
474 #  ifndef PERL_CORE
475 #    define     IS_PADGV(v)     (v && isGV(v))
476 #    define     IS_PADCONST(v) \
477         (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
478 #  endif
479 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv \
480                                  ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
481 #  define       cSVOPx_svp(v)   (cSVOPx(v)->op_sv \
482                                  ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
483 #  define       cMETHOPx_rclass(v) PAD_SVl(cMETHOPx(v)->op_rclass_targ)
484 #else
485 #  define       cGVOPx_gv(o)    ((GV*)cSVOPx(o)->op_sv)
486 #  ifndef PERL_CORE
487 #    define     IS_PADGV(v)     FALSE
488 #    define     IS_PADCONST(v)  FALSE
489 #  endif
490 #  define       cSVOPx_sv(v)    (cSVOPx(v)->op_sv)
491 #  define       cSVOPx_svp(v)   (&cSVOPx(v)->op_sv)
492 #  define       cMETHOPx_rclass(v) (cMETHOPx(v)->op_rclass_sv)
493 #endif
494
495 #  define       cMETHOPx_meth(v)        cSVOPx_sv(v)
496
497 #define cGVOP_gv                cGVOPx_gv(PL_op)
498 #define cGVOPo_gv               cGVOPx_gv(o)
499 #define kGVOP_gv                cGVOPx_gv(kid)
500 #define cSVOP_sv                cSVOPx_sv(PL_op)
501 #define cSVOPo_sv               cSVOPx_sv(o)
502 #define kSVOP_sv                cSVOPx_sv(kid)
503
504 #ifndef PERL_CORE
505 #  define Nullop ((OP*)NULL)
506 #endif
507
508 /* Lowest byte of PL_opargs */
509 #define OA_MARK 1
510 #define OA_FOLDCONST 2
511 #define OA_RETSCALAR 4
512 #define OA_TARGET 8
513 #define OA_TARGLEX 16
514 #define OA_OTHERINT 32
515 #define OA_DANGEROUS 64
516 #define OA_DEFGV 128
517
518 /* The next 4 bits (8..11) encode op class information */
519 #define OCSHIFT 8
520
521 #define OA_CLASS_MASK (15 << OCSHIFT)
522
523 #define OA_BASEOP (0 << OCSHIFT)
524 #define OA_UNOP (1 << OCSHIFT)
525 #define OA_BINOP (2 << OCSHIFT)
526 #define OA_LOGOP (3 << OCSHIFT)
527 #define OA_LISTOP (4 << OCSHIFT)
528 #define OA_PMOP (5 << OCSHIFT)
529 #define OA_SVOP (6 << OCSHIFT)
530 #define OA_PADOP (7 << OCSHIFT)
531 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
532 #define OA_LOOP (9 << OCSHIFT)
533 #define OA_COP (10 << OCSHIFT)
534 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
535 #define OA_FILESTATOP (12 << OCSHIFT)
536 #define OA_LOOPEXOP (13 << OCSHIFT)
537 #define OA_METHOP (14 << OCSHIFT)
538 #define OA_UNOP_AUX (15 << OCSHIFT)
539
540 /* Each remaining nybble of PL_opargs (i.e. bits 12..15, 16..19 etc)
541  * encode the type for each arg */
542 #define OASHIFT 12
543
544 #define OA_SCALAR 1
545 #define OA_LIST 2
546 #define OA_AVREF 3
547 #define OA_HVREF 4
548 #define OA_CVREF 5
549 #define OA_FILEREF 6
550 #define OA_SCALARREF 7
551 #define OA_OPTIONAL 8
552
553 /* Op_REFCNT is a reference count at the head of each op tree: needed
554  * since the tree is shared between threads, and between cloned closure
555  * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
556  * this count.
557  * The same mutex is used to protect the refcounts of the reg_trie_data
558  * and reg_ac_data structures, which are shared between duplicated
559  * regexes.
560  */
561
562 #ifdef USE_ITHREADS
563 #  define OP_REFCNT_INIT                MUTEX_INIT(&PL_op_mutex)
564 #  ifdef PERL_CORE
565 #    define OP_REFCNT_LOCK              MUTEX_LOCK(&PL_op_mutex)
566 #    define OP_REFCNT_UNLOCK            MUTEX_UNLOCK(&PL_op_mutex)
567 #  else
568 #    define OP_REFCNT_LOCK              op_refcnt_lock()
569 #    define OP_REFCNT_UNLOCK            op_refcnt_unlock()
570 #  endif
571 #  define OP_REFCNT_TERM                MUTEX_DESTROY(&PL_op_mutex)
572 #else
573 #  define OP_REFCNT_INIT                NOOP
574 #  define OP_REFCNT_LOCK                NOOP
575 #  define OP_REFCNT_UNLOCK              NOOP
576 #  define OP_REFCNT_TERM                NOOP
577 #endif
578
579 #define OpREFCNT_set(o,n)               ((o)->op_targ = (n))
580 #ifdef PERL_DEBUG_READONLY_OPS
581 #  define OpREFCNT_inc(o)               Perl_op_refcnt_inc(aTHX_ o)
582 #  define OpREFCNT_dec(o)               Perl_op_refcnt_dec(aTHX_ o)
583 #else
584 #  define OpREFCNT_inc(o)               ((o) ? (++(o)->op_targ, (o)) : NULL)
585 #  define OpREFCNT_dec(o)               (--(o)->op_targ)
586 #endif
587
588 /* flags used by Perl_load_module() */
589 #define PERL_LOADMOD_DENY               0x1     /* no Module */
590 #define PERL_LOADMOD_NOIMPORT           0x2     /* use Module () */
591 #define PERL_LOADMOD_IMPORT_OPS         0x4     /* import arguments
592                                                    are passed as a sin-
593                                                    gle op tree, not a
594                                                    list of SVs */
595
596 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
597 #define ref(o, type) doref(o, type, TRUE)
598 #endif
599
600 /*
601 =head1 Optree Manipulation Functions
602
603 =for apidoc Am|OP*|LINKLIST|OP *o
604 Given the root of an optree, link the tree in execution order using the
605 C<op_next> pointers and return the first op executed.  If this has
606 already been done, it will not be redone, and C<< o->op_next >> will be
607 returned.  If C<< o->op_next >> is not already set, I<o> should be at
608 least an C<UNOP>.
609
610 =cut
611 */
612
613 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
614
615 /* no longer used anywhere in core */
616 #ifndef PERL_CORE
617 #define cv_ckproto(cv, gv, p) \
618    cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
619 #endif
620
621 #ifdef PERL_CORE
622 #  define my(o) my_attrs((o), NULL)
623 #endif
624
625 #ifdef USE_REENTRANT_API
626 #include "reentr.h"
627 #endif
628
629 #define NewOp(m,var,c,type)     \
630         (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
631 #define NewOpSz(m,var,size)     \
632         (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
633 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
634
635 /*
636  * The per-CV op slabs consist of a header (the opslab struct) and a bunch
637  * of space for allocating op slots, each of which consists of two pointers
638  * followed by an op.  The first pointer points to the next op slot.  The
639  * second points to the slab.  At the end of the slab is a null pointer,
640  * so that slot->opslot_next - slot can be used to determine the size
641  * of the op.
642  *
643  * Each CV can have multiple slabs; opslab_next points to the next slab, to
644  * form a chain.  All bookkeeping is done on the first slab, which is where
645  * all the op slots point.
646  *
647  * Freed ops are marked as freed and attached to the freed chain
648  * via op_next pointers.
649  *
650  * When there is more than one slab, the second slab in the slab chain is
651  * assumed to be the one with free space available.  It is used when allo-
652  * cating an op if there are no freed ops available or big enough.
653  */
654
655 #ifdef PERL_CORE
656 struct opslot {
657     /* keep opslot_next first */
658     OPSLOT *    opslot_next;            /* next slot */
659     OPSLAB *    opslot_slab;            /* owner */
660     OP          opslot_op;              /* the op itself */
661 };
662
663 struct opslab {
664     OPSLOT *    opslab_first;           /* first op in this slab */
665     OPSLAB *    opslab_next;            /* next slab */
666     OP *        opslab_freed;           /* chain of freed ops */
667     size_t      opslab_refcnt;          /* number of ops */
668 # ifdef PERL_DEBUG_READONLY_OPS
669     U16         opslab_size;            /* size of slab in pointers */
670     bool        opslab_readonly;
671 # endif
672     OPSLOT      opslab_slots;           /* slots begin here */
673 };
674
675 # define OPSLOT_HEADER          STRUCT_OFFSET(OPSLOT, opslot_op)
676 # define OPSLOT_HEADER_P        (OPSLOT_HEADER/sizeof(I32 *))
677 # define OpSLOT(o)              (assert_(o->op_slabbed) \
678                                  (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
679 # define OpSLAB(o)              OpSLOT(o)->opslot_slab
680 # define OpslabREFCNT_dec(slab)      \
681         (((slab)->opslab_refcnt == 1) \
682          ? opslab_free_nopad(slab)     \
683          : (void)--(slab)->opslab_refcnt)
684   /* Variant that does not null out the pads */
685 # define OpslabREFCNT_dec_padok(slab) \
686         (((slab)->opslab_refcnt == 1)  \
687          ? opslab_free(slab)            \
688          : (void)--(slab)->opslab_refcnt)
689 #endif
690
691 struct block_hooks {
692     U32     bhk_flags;
693     void    (*bhk_start)        (pTHX_ int full);
694     void    (*bhk_pre_end)      (pTHX_ OP **seq);
695     void    (*bhk_post_end)     (pTHX_ OP **seq);
696     void    (*bhk_eval)         (pTHX_ OP *const saveop);
697 };
698
699 /*
700 =head1 Compile-time scope hooks
701
702 =for apidoc mx|U32|BhkFLAGS|BHK *hk
703 Return the BHK's flags.
704
705 =for apidoc mx|void *|BhkENTRY|BHK *hk|which
706 Return an entry from the BHK structure.  I<which> is a preprocessor token
707 indicating which entry to return.  If the appropriate flag is not set
708 this will return NULL.  The type of the return value depends on which
709 entry you ask for.
710
711 =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
712 Set an entry in the BHK structure, and set the flags to indicate it is
713 valid.  I<which> is a preprocessing token indicating which entry to set.
714 The type of I<ptr> depends on the entry.
715
716 =for apidoc Amx|void|BhkDISABLE|BHK *hk|which
717 Temporarily disable an entry in this BHK structure, by clearing the
718 appropriate flag.  I<which> is a preprocessor token indicating which
719 entry to disable.
720
721 =for apidoc Amx|void|BhkENABLE|BHK *hk|which
722 Re-enable an entry in this BHK structure, by setting the appropriate
723 flag.  I<which> is a preprocessor token indicating which entry to enable.
724 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
725 pointer.
726
727 =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
728 Call all the registered block hooks for type I<which>.  I<which> is a
729 preprocessing token; the type of I<arg> depends on I<which>.
730
731 =cut
732 */
733
734 #define BhkFLAGS(hk)            ((hk)->bhk_flags)
735
736 #define BHKf_bhk_start      0x01
737 #define BHKf_bhk_pre_end    0x02
738 #define BHKf_bhk_post_end   0x04
739 #define BHKf_bhk_eval       0x08
740
741 #define BhkENTRY(hk, which) \
742     ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
743
744 #define BhkENABLE(hk, which) \
745     STMT_START { \
746         BhkFLAGS(hk) |= BHKf_ ## which; \
747         assert(BhkENTRY(hk, which)); \
748     } STMT_END
749
750 #define BhkDISABLE(hk, which) \
751     STMT_START { \
752         BhkFLAGS(hk) &= ~(BHKf_ ## which); \
753     } STMT_END
754
755 #define BhkENTRY_set(hk, which, ptr) \
756     STMT_START { \
757         (hk)->which = ptr; \
758         BhkENABLE(hk, which); \
759     } STMT_END
760
761 #define CALL_BLOCK_HOOKS(which, arg) \
762     STMT_START { \
763         if (PL_blockhooks) { \
764             SSize_t i; \
765             for (i = av_tindex(PL_blockhooks); i >= 0; i--) { \
766                 SV *sv = AvARRAY(PL_blockhooks)[i]; \
767                 BHK *hk; \
768                 \
769                 assert(SvIOK(sv)); \
770                 if (SvUOK(sv)) \
771                     hk = INT2PTR(BHK *, SvUVX(sv)); \
772                 else \
773                     hk = INT2PTR(BHK *, SvIVX(sv)); \
774                 \
775                 if (BhkENTRY(hk, which)) \
776                     BhkENTRY(hk, which)(aTHX_ arg); \
777             } \
778         } \
779     } STMT_END
780
781 /* flags for rv2cv_op_cv */
782
783 #define RV2CVOPCV_MARK_EARLY     0x00000001
784 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
785 #define RV2CVOPCV_RETURN_STUB    0x00000004
786 #ifdef PERL_CORE /* behaviour of this flag is subject to change: */
787 # define RV2CVOPCV_MAYBE_NAME_GV  0x00000008
788 #endif
789 #define RV2CVOPCV_FLAG_MASK      0x0000000f /* all of the above */
790
791 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
792
793 /* flags for op_lvalue_flags */
794
795 #define OP_LVALUE_NO_CROAK 1
796
797 /*
798 =head1 Custom Operators
799
800 =for apidoc Am|U32|XopFLAGS|XOP *xop
801 Return the XOP's flags.
802
803 =for apidoc Am||XopENTRY|XOP *xop|which
804 Return a member of the XOP structure.  I<which> is a cpp token
805 indicating which entry to return.  If the member is not set
806 this will return a default value.  The return type depends
807 on I<which>.  This macro evaluates its arguments more than
808 once.  If you are using C<Perl_custom_op_xop> to retreive a
809 C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead.
810
811 =for apidoc Am||XopENTRYCUSTOM|const OP *o|which
812 Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more
813 efficient.  The I<which> parameter is identical to L</XopENTRY>.
814
815 =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
816 Set a member of the XOP structure.  I<which> is a cpp token
817 indicating which entry to set.  See L<perlguts/"Custom Operators">
818 for details about the available members and how
819 they are used.  This macro evaluates its argument
820 more than once.
821
822 =for apidoc Am|void|XopDISABLE|XOP *xop|which
823 Temporarily disable a member of the XOP, by clearing the appropriate flag.
824
825 =for apidoc Am|void|XopENABLE|XOP *xop|which
826 Reenable a member of the XOP which has been disabled.
827
828 =cut
829 */
830
831 struct custom_op {
832     U32             xop_flags;    
833     const char     *xop_name;
834     const char     *xop_desc;
835     U32             xop_class;
836     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
837 };
838
839 /* return value of Perl_custom_op_get_field, similar to void * then casting but
840    the U32 doesn't need truncation on 64 bit platforms in the caller, also
841    for easier macro writing */
842 typedef union {
843     const char     *xop_name;
844     const char     *xop_desc;
845     U32             xop_class;
846     void          (*xop_peep)(pTHX_ OP *o, OP *oldop);
847     XOP            *xop_ptr;
848 } XOPRETANY;
849
850 #define XopFLAGS(xop) ((xop)->xop_flags)
851
852 #define XOPf_xop_name   0x01
853 #define XOPf_xop_desc   0x02
854 #define XOPf_xop_class  0x04
855 #define XOPf_xop_peep   0x08
856
857 /* used by Perl_custom_op_get_field for option checking */
858 typedef enum {
859     XOPe_xop_ptr = 0, /* just get the XOP *, don't look inside it */
860     XOPe_xop_name = XOPf_xop_name,
861     XOPe_xop_desc = XOPf_xop_desc,
862     XOPe_xop_class = XOPf_xop_class,
863     XOPe_xop_peep = XOPf_xop_peep
864 } xop_flags_enum;
865
866 #define XOPd_xop_name   PL_op_name[OP_CUSTOM]
867 #define XOPd_xop_desc   PL_op_desc[OP_CUSTOM]
868 #define XOPd_xop_class  OA_BASEOP
869 #define XOPd_xop_peep   ((Perl_cpeep_t)0)
870
871 #define XopENTRY_set(xop, which, to) \
872     STMT_START { \
873         (xop)->which = (to); \
874         (xop)->xop_flags |= XOPf_ ## which; \
875     } STMT_END
876
877 #define XopENTRY(xop, which) \
878     ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
879
880 #define XopENTRYCUSTOM(o, which) \
881     (Perl_custom_op_get_field(aTHX_ o, XOPe_ ## which).which)
882
883 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
884 #define XopENABLE(xop, which) \
885     STMT_START { \
886         (xop)->xop_flags |= XOPf_ ## which; \
887         assert(XopENTRY(xop, which)); \
888     } STMT_END
889
890 #define Perl_custom_op_xop(x) \
891     (Perl_custom_op_get_field(x, XOPe_xop_ptr).xop_ptr)
892
893 /*
894 =head1 Optree Manipulation Functions
895
896 =for apidoc Am|const char *|OP_NAME|OP *o
897 Return the name of the provided OP.  For core ops this looks up the name
898 from the op_type; for custom ops from the op_ppaddr.
899
900 =for apidoc Am|const char *|OP_DESC|OP *o
901 Return a short description of the provided OP.
902
903 =for apidoc Am|U32|OP_CLASS|OP *o
904 Return the class of the provided OP: that is, which of the *OP
905 structures it uses.  For core ops this currently gets the information out
906 of PL_opargs, which does not always accurately reflect the type used.
907 For custom ops the type is returned from the registration, and it is up
908 to the registree to ensure it is accurate.  The value returned will be
909 one of the OA_* constants from op.h.
910
911 =for apidoc Am|bool|OP_TYPE_IS|OP *o|Optype type
912 Returns true if the given OP is not a NULL pointer
913 and if it is of the given type.
914
915 The negation of this macro, C<OP_TYPE_ISNT> is also available
916 as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide
917 the NULL pointer check.
918
919 =for apidoc Am|bool|OP_TYPE_IS_OR_WAS|OP *o|Optype type
920 Returns true if the given OP is not a NULL pointer and
921 if it is of the given type or used to be before being
922 replaced by an OP of type OP_NULL.
923
924 The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT>
925 is also available as well as C<OP_TYPE_IS_OR_WAS_NN>
926 and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide
927 the NULL pointer check.
928
929 =for apidoc Am|bool|OpHAS_SIBLING|OP *o
930 Returns true if o has a sibling
931
932 =for apidoc Am|bool|OpSIBLING|OP *o
933 Returns the sibling of o, or NULL if there is no sibling
934
935 =for apidoc Am|bool|OpSIBLING_set|OP *o|OP *sib
936 Sets the sibling of o to sib
937
938 =cut
939 */
940
941 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
942                     ? XopENTRYCUSTOM(o, xop_name) \
943                     : PL_op_name[(o)->op_type])
944 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
945                     ? XopENTRYCUSTOM(o, xop_desc) \
946                     : PL_op_desc[(o)->op_type])
947 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
948                      ? XopENTRYCUSTOM(o, xop_class) \
949                      : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
950
951 #define OP_TYPE_IS(o, type) ((o) && (o)->op_type == (type))
952 #define OP_TYPE_IS_NN(o, type) ((o)->op_type == (type))
953 #define OP_TYPE_ISNT(o, type) ((o) && (o)->op_type != (type))
954 #define OP_TYPE_ISNT_NN(o, type) ((o)->op_type != (type))
955
956 #define OP_TYPE_IS_OR_WAS_NN(o, type) \
957     ( ((o)->op_type == OP_NULL \
958        ? (o)->op_targ \
959        : (o)->op_type) \
960       == (type) )
961
962 #define OP_TYPE_IS_OR_WAS(o, type) \
963     ( (o) && OP_TYPE_IS_OR_WAS_NN(o, type) )
964
965 #define OP_TYPE_ISNT_AND_WASNT_NN(o, type) \
966     ( ((o)->op_type == OP_NULL \
967        ? (o)->op_targ \
968        : (o)->op_type) \
969       != (type) )
970
971 #define OP_TYPE_ISNT_AND_WASNT(o, type) \
972     ( (o) && OP_TYPE_ISNT_AND_WASNT_NN(o, type) )
973
974 #ifdef PERL_OP_PARENT
975 #  define OpHAS_SIBLING(o)      (!cBOOL((o)->op_lastsib))
976 #  define OpSIBLING(o)          (0 + (o)->op_lastsib ? NULL : (o)->op_sibling)
977 #  define OpSIBLING_set(o, sib) ((o)->op_sibling = (sib))
978 #else
979 #  define OpHAS_SIBLING(o)      (cBOOL((o)->op_sibling))
980 #  define OpSIBLING(o)          (0 + (o)->op_sibling)
981 #  define OpSIBLING_set(o, sib) ((o)->op_sibling = (sib))
982 #endif
983 #if !defined(PERL_CORE) && !defined(PERL_EXT)
984 #  define OP_SIBLING(o)         OpSIBLING(o)
985 #endif
986
987 #define newATTRSUB(f, o, p, a, b) Perl_newATTRSUB_x(aTHX_  f, o, p, a, b, FALSE)
988 #define newSUB(f, o, p, b)      newATTRSUB((f), (o), (p), NULL, (b))
989
990 /*
991 =head1 Hook manipulation
992 */
993
994 #ifdef USE_ITHREADS
995 #  define OP_CHECK_MUTEX_INIT           MUTEX_INIT(&PL_check_mutex)
996 #  define OP_CHECK_MUTEX_LOCK           MUTEX_LOCK(&PL_check_mutex)
997 #  define OP_CHECK_MUTEX_UNLOCK         MUTEX_UNLOCK(&PL_check_mutex)
998 #  define OP_CHECK_MUTEX_TERM           MUTEX_DESTROY(&PL_check_mutex)
999 #else
1000 #  define OP_CHECK_MUTEX_INIT           NOOP
1001 #  define OP_CHECK_MUTEX_LOCK           NOOP
1002 #  define OP_CHECK_MUTEX_UNLOCK         NOOP
1003 #  define OP_CHECK_MUTEX_TERM           NOOP
1004 #endif
1005
1006
1007 /* Stuff for OP_MULTDEREF/pp_multideref. */
1008
1009 /* actions */
1010
1011 /* Load another word of actions/flag bits. Must be 0 */
1012 #define MDEREF_reload                       0
1013
1014 #define MDEREF_AV_pop_rv2av_aelem           1
1015 #define MDEREF_AV_gvsv_vivify_rv2av_aelem   2
1016 #define MDEREF_AV_padsv_vivify_rv2av_aelem  3
1017 #define MDEREF_AV_vivify_rv2av_aelem        4
1018 #define MDEREF_AV_padav_aelem               5
1019 #define MDEREF_AV_gvav_aelem                6
1020
1021 #define MDEREF_HV_pop_rv2hv_helem           8
1022 #define MDEREF_HV_gvsv_vivify_rv2hv_helem   9
1023 #define MDEREF_HV_padsv_vivify_rv2hv_helem 10
1024 #define MDEREF_HV_vivify_rv2hv_helem       11
1025 #define MDEREF_HV_padhv_helem              12
1026 #define MDEREF_HV_gvhv_helem               13
1027
1028 #define MDEREF_ACTION_MASK                0xf
1029
1030 /* key / index type */
1031
1032 #define MDEREF_INDEX_none   0x00 /* run external ops to generate index */
1033 #define MDEREF_INDEX_const  0x10 /* index is const PV/UV */
1034 #define MDEREF_INDEX_padsv  0x20 /* index is lexical var */
1035 #define MDEREF_INDEX_gvsv   0x30 /* index is GV */
1036
1037 #define MDEREF_INDEX_MASK   0x30
1038
1039 /* bit flags */
1040
1041 #define MDEREF_FLAG_last    0x40 /* the last [ah]elem; PL_op flags apply */
1042
1043 #define MDEREF_MASK         0x7F
1044 #define MDEREF_SHIFT           7
1045
1046
1047 /*
1048  * Local variables:
1049  * c-indentation-style: bsd
1050  * c-basic-offset: 4
1051  * indent-tabs-mode: nil
1052  * End:
1053  *
1054  * ex: set ts=8 sts=4 sw=4 et:
1055  */