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