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