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
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.
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
22 * op_slabbed allocated via opslab
23 * op_static tell op_free() to skip PerlMemShared_free(), when
25 * op_savefree on savestack via SAVEFREEOP
26 * op_folded Result/remainder of a constant fold operation.
27 * op_moresib this op is is not 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).
35 #include "op_reg_common.h"
39 typedef PERL_BITFIELD16 Optype;
41 /* this field now either points to the next sibling or to the parent,
42 * depending on op_moresib. So rename it from op_sibling to op_sibparent.
45 # define _OP_SIBPARENT_FIELDNAME op_sibparent
47 # define _OP_SIBPARENT_FIELDNAME op_sibling
50 #ifdef BASEOP_DEFINITION
51 #define BASEOP BASEOP_DEFINITION
55 OP* _OP_SIBPARENT_FIELDNAME;\
56 OP* (*op_ppaddr)(pTHX); \
58 PERL_BITFIELD16 op_type:9; \
59 PERL_BITFIELD16 op_opt:1; \
60 PERL_BITFIELD16 op_slabbed:1; \
61 PERL_BITFIELD16 op_savefree:1; \
62 PERL_BITFIELD16 op_static:1; \
63 PERL_BITFIELD16 op_folded:1; \
64 PERL_BITFIELD16 op_moresib:1; \
65 PERL_BITFIELD16 op_spare:1; \
70 /* If op_type:9 is changed to :10, also change cx_pusheval()
71 Also, if the type of op_type is ever changed (e.g. to PERL_BITFIELD32)
72 then all the other bit-fields before/after it should change their
73 types too to let VC pack them into the same 4 byte integer.*/
75 /* for efficiency, requires OPf_WANT_VOID == G_VOID etc */
76 #define OP_GIMME(op,dfl) \
77 (((op)->op_flags & OPf_WANT) ? ((op)->op_flags & OPf_WANT) : dfl)
79 #define OP_GIMME_REVERSE(flags) ((flags) & G_WANT)
84 =for apidoc Amn|U32|GIMME_V
85 The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
86 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
87 respectively. See L<perlcall> for a usage example.
89 =for apidoc Amn|U32|GIMME
90 A backward-compatible version of C<GIMME_V> which can only return
91 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
92 Deprecated. Use C<GIMME_V> instead.
97 #define GIMME_V OP_GIMME(PL_op, block_gimme())
101 #define OPf_WANT 3 /* Mask for "want" bits: */
102 #define OPf_WANT_VOID 1 /* Want nothing */
103 #define OPf_WANT_SCALAR 2 /* Want single value */
104 #define OPf_WANT_LIST 3 /* Want list of any length */
105 #define OPf_KIDS 4 /* There is a firstborn child. */
106 #define OPf_PARENS 8 /* This operator was parenthesized. */
107 /* (Or block needs explicit scope entry.) */
108 #define OPf_REF 16 /* Certified reference. */
109 /* (Return container, not containee). */
110 #define OPf_MOD 32 /* Will modify (lvalue). */
111 #define OPf_STACKED 64 /* Some arg is arriving on the stack. */
112 #define OPf_SPECIAL 128 /* Do something weird for this op: */
113 /* On local LVAL, don't init local value. */
114 /* On OP_SORT, subroutine is inlined. */
115 /* On OP_NOT, inversion was implicit. */
116 /* On OP_LEAVE, don't restore curpm, e.g.
117 * /(...)/ while ...>; */
118 /* On truncate, we truncate filehandle */
119 /* On control verbs, we saw no label */
120 /* On flipflop, we saw ... instead of .. */
121 /* On UNOPs, saw bare parens, e.g. eof(). */
122 /* On OP_CHDIR, handle (or bare parens) */
123 /* On OP_NULL, saw a "do". */
124 /* On OP_EXISTS, treat av as av, not avhv. */
125 /* On OP_(ENTER|LEAVE)EVAL, don't clear $@ */
126 /* On pushre, rx is used as part of split, e.g. split " " */
127 /* On regcomp, "use re 'eval'" was in scope */
128 /* On RV2[ACGHS]V, don't create GV--in
130 /* On OP_DBSTATE, indicates breakpoint
131 * (runtime property) */
132 /* On OP_REQUIRE, was seen as CORE::require */
133 /* On OP_(ENTER|LEAVE)WHEN, there's
135 /* On OP_SMARTMATCH, an implicit smartmatch */
136 /* On OP_ANONHASH and OP_ANONLIST, create a
137 reference to the new anon hash or array */
138 /* On OP_HELEM, OP_MULTIDEREF and OP_HSLICE,
139 localization will be followed by assignment,
140 so do not wipe the target if it is special
141 (e.g. a glob or a magic SV) */
142 /* On OP_MATCH, OP_SUBST & OP_TRANS, the
143 operand of a logical or conditional
144 that was optimised away, so it should
145 not be bound via =~ */
146 /* On OP_CONST, from a constant CV */
147 /* On OP_GLOB, two meanings:
148 - Before ck_glob, called as CORE::glob
149 - After ck_glob, use Perl glob function
151 /* On OP_PADRANGE, push @_ */
152 /* On OP_DUMP, has no label */
153 /* On OP_UNSTACK, in a C-style for loop */
154 /* There is no room in op_flags for this one, so it has its own bit-
155 field member (op_folded) instead. The flag is only used to tell
156 op_convert_list to set op_folded. */
157 #define OPf_FOLDED 1<<16
159 /* old names; don't use in new code, but don't break them, either */
160 #define OPf_LIST OPf_WANT_LIST
161 #define OPf_KNOW OPf_WANT
163 #if !defined(PERL_CORE) && !defined(PERL_EXT)
165 (PL_op->op_flags & OPf_WANT \
166 ? ((PL_op->op_flags & OPf_WANT) == OPf_WANT_LIST \
173 /* NOTE: OPp* flags are now auto-generated and defined in opcode.h,
174 * from data in regen/op_private */
177 #define OPpTRANS_ALL (OPpTRANS_FROM_UTF|OPpTRANS_TO_UTF|OPpTRANS_IDENTICAL|OPpTRANS_SQUASH|OPpTRANS_COMPLEMENT|OPpTRANS_GROWS|OPpTRANS_DELETE)
181 /* Mask for OP_ENTERSUB flags, the absence of which must be propagated
182 in dynamic context */
183 #define OPpENTERSUB_LVAL_MASK (OPpLVAL_INTRO|OPpENTERSUB_INARGS)
186 /* things that can be elements of op_aux */
188 PADOFFSET pad_offset;
195 # define UNOP_AUX_item_sv(item) PAD_SVl((item)->pad_offset);
197 # define UNOP_AUX_item_sv(item) ((item)->sv);
215 UNOP_AUX_item *op_aux;
239 /* op_u.op_first *must* be aligned the same as the op_first
240 * field of the other op types, and op_u.op_meth_sv *must*
241 * be aligned with op_sv */
242 OP* op_first; /* optree for method name */
243 SV* op_meth_sv; /* static method name */
246 PADOFFSET op_rclass_targ; /* pad index for redirect class */
248 SV* op_rclass_sv; /* static redirect class $o->A::meth() */
257 PADOFFSET op_pmoffset;
259 REGEXP * op_pmregexp; /* compiled expression */
263 OP * op_pmreplroot; /* For OP_SUBST */
265 PADOFFSET op_pmtargetoff; /* For OP_PUSHRE */
271 OP * op_pmreplstart; /* Only used in OP_SUBST */
273 PADOFFSET op_pmstashoff; /* Only used in OP_MATCH, with PMf_ONCE set */
278 OP * op_code_list; /* list of (?{}) code blocks */
282 #define PM_GETRE(o) (SvTYPE(PL_regex_pad[(o)->op_pmoffset]) == SVt_REGEXP \
283 ? (REGEXP*)(PL_regex_pad[(o)->op_pmoffset]) : NULL)
284 /* The assignment is just to enforce type safety (or at least get a warning).
286 /* With first class regexps not via a reference one needs to assign
287 &PL_sv_undef under ithreads. (This would probably work unthreaded, but NULL
288 is cheaper. I guess we could allow NULL, but the check above would get
289 more complex, and we'd have an AV with (SV*)NULL in it, which feels bad */
290 /* BEWARE - something that calls this macro passes (r) which has a side
292 #define PM_SETRE(o,r) STMT_START { \
293 REGEXP *const _pm_setre = (r); \
295 PL_regex_pad[(o)->op_pmoffset] = MUTABLE_SV(_pm_setre); \
298 #define PM_GETRE(o) ((o)->op_pmregexp)
299 #define PM_SETRE(o,r) ((o)->op_pmregexp = (r))
302 /* Currently these PMf flags occupy a single 32-bit word. Not all bits are
303 * currently used. The lower bits are shared with their corresponding RXf flag
304 * bits, up to but not including _RXf_PMf_SHIFT_NEXT. The unused bits
305 * immediately follow; finally the used Pmf-only (unshared) bits, so that the
306 * highest bit in the word is used. This gathers all the unused bits as a pool
307 * in the middle, like so: 11111111111111110000001111111111
308 * where the '1's represent used bits, and the '0's unused. This design allows
309 * us to allocate off one end of the pool if we need to add a shared bit, and
310 * off the other end if we need a non-shared bit, without disturbing the other
311 * bits. This maximizes the likelihood of being able to change things without
312 * breaking binary compatibility.
314 * To add shared bits, do so in op_reg_common.h. This should change
315 * _RXf_PMf_SHIFT_NEXT so that things won't compile. Then come to regexp.h and
316 * op.h and adjust the constant adders in the definitions of PMf_BASE_SHIFT and
317 * Pmf_BASE_SHIFT down by the number of shared bits you added. That's it.
318 * Things should be binary compatible. But if either of these gets to having
319 * to subtract rather than add, leave at 0 and adjust all the entries below
320 * that are in terms of this according. But if the first one of those is
321 * already PMf_BASE_SHIFT+0, there are no bits left, and a redesign is in
324 * To remove unshared bits, just delete its entry. If you're where breaking
325 * binary compatibility is ok to do, you might want to adjust things to move
326 * the newly opened space so that it gets absorbed into the common pool.
328 * To add unshared bits, first use up any gaps in the middle. Otherwise,
329 * allocate off the low end until you get to PMf_BASE_SHIFT+0. If that isn't
330 * enough, move PMf_BASE_SHIFT down (if possible) and add the new bit at the
331 * other end instead; this preserves binary compatibility. */
332 #define PMf_BASE_SHIFT (_RXf_PMf_SHIFT_NEXT+2)
334 /* 'use re "taint"' in scope: taint $1 etc. if target tainted */
335 #define PMf_RETAINT (1U<<(PMf_BASE_SHIFT+5))
337 /* match successfully only once per reset, with related flag RXf_USED in
338 * re->extflags holding state. This is used only for ?? matches, and only on
339 * OP_MATCH and OP_QR */
340 #define PMf_ONCE (1U<<(PMf_BASE_SHIFT+6))
342 /* PMf_ONCE, i.e. ?pat?, has matched successfully. Not used under threading. */
343 #define PMf_USED (1U<<(PMf_BASE_SHIFT+7))
345 /* subst replacement is constant */
346 #define PMf_CONST (1U<<(PMf_BASE_SHIFT+8))
348 /* keep 1st runtime pattern forever */
349 #define PMf_KEEP (1U<<(PMf_BASE_SHIFT+9))
351 #define PMf_GLOBAL (1U<<(PMf_BASE_SHIFT+10)) /* pattern had a g modifier */
353 /* don't reset pos() if //g fails */
354 #define PMf_CONTINUE (1U<<(PMf_BASE_SHIFT+11))
356 /* evaluating replacement as expr */
357 #define PMf_EVAL (1U<<(PMf_BASE_SHIFT+12))
359 /* Return substituted string instead of modifying it. */
360 #define PMf_NONDESTRUCT (1U<<(PMf_BASE_SHIFT+13))
362 /* the pattern has a CV attached (currently only under qr/...(?{}).../) */
363 #define PMf_HAS_CV (1U<<(PMf_BASE_SHIFT+14))
365 /* op_code_list is private; don't free it etc. It may well point to
366 * code within another sub, with different pad etc */
367 #define PMf_CODELIST_PRIVATE (1U<<(PMf_BASE_SHIFT+15))
369 /* the PMOP is a QR (we should be able to detect that from the op type,
370 * but the regex compilation API passes just the pm flags, not the op
372 #define PMf_IS_QR (1U<<(PMf_BASE_SHIFT+16))
373 #define PMf_USE_RE_EVAL (1U<<(PMf_BASE_SHIFT+17)) /* use re'eval' in scope */
375 /* See comments at the beginning of these defines about adding bits. The
376 * highest bit position should be used, so that if PMf_BASE_SHIFT gets
377 * increased, the #error below will be triggered so that you will be reminded
378 * to adjust things at the other end to keep the bit positions unchanged */
379 #if PMf_BASE_SHIFT+17 > 31
380 # error Too many PMf_ bits used. See above and regnodes.h for any spare in middle
385 # define PmopSTASH(o) ((o)->op_pmflags & PMf_ONCE \
386 ? PL_stashpad[(o)->op_pmstashstartu.op_pmstashoff] \
388 # define PmopSTASH_set(o,hv) \
389 (assert_((o)->op_pmflags & PMf_ONCE) \
390 (o)->op_pmstashstartu.op_pmstashoff = \
391 (hv) ? alloccopstash(hv) : 0)
393 # define PmopSTASH(o) \
394 (((o)->op_pmflags & PMf_ONCE) ? (o)->op_pmstashstartu.op_pmstash : NULL)
395 # if defined (DEBUGGING) && defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
396 # define PmopSTASH_set(o,hv) ({ \
397 assert((o)->op_pmflags & PMf_ONCE); \
398 ((o)->op_pmstashstartu.op_pmstash = (hv)); \
401 # define PmopSTASH_set(o,hv) ((o)->op_pmstashstartu.op_pmstash = (hv))
404 #define PmopSTASHPV(o) (PmopSTASH(o) ? HvNAME_get(PmopSTASH(o)) : NULL)
405 /* op_pmstashstartu.op_pmstash is not refcounted */
406 #define PmopSTASHPV_set(o,pv) PmopSTASH_set((o), gv_stashpv(pv,GV_ADD))
432 #define cUNOPx(o) ((UNOP*)(o))
433 #define cUNOP_AUXx(o) ((UNOP_AUX*)(o))
434 #define cBINOPx(o) ((BINOP*)(o))
435 #define cLISTOPx(o) ((LISTOP*)(o))
436 #define cLOGOPx(o) ((LOGOP*)(o))
437 #define cPMOPx(o) ((PMOP*)(o))
438 #define cSVOPx(o) ((SVOP*)(o))
439 #define cPADOPx(o) ((PADOP*)(o))
440 #define cPVOPx(o) ((PVOP*)(o))
441 #define cCOPx(o) ((COP*)(o))
442 #define cLOOPx(o) ((LOOP*)(o))
443 #define cMETHOPx(o) ((METHOP*)(o))
445 #define cUNOP cUNOPx(PL_op)
446 #define cUNOP_AUX cUNOP_AUXx(PL_op)
447 #define cBINOP cBINOPx(PL_op)
448 #define cLISTOP cLISTOPx(PL_op)
449 #define cLOGOP cLOGOPx(PL_op)
450 #define cPMOP cPMOPx(PL_op)
451 #define cSVOP cSVOPx(PL_op)
452 #define cPADOP cPADOPx(PL_op)
453 #define cPVOP cPVOPx(PL_op)
454 #define cCOP cCOPx(PL_op)
455 #define cLOOP cLOOPx(PL_op)
457 #define cUNOPo cUNOPx(o)
458 #define cUNOP_AUXo cUNOP_AUXx(o)
459 #define cBINOPo cBINOPx(o)
460 #define cLISTOPo cLISTOPx(o)
461 #define cLOGOPo cLOGOPx(o)
462 #define cPMOPo cPMOPx(o)
463 #define cSVOPo cSVOPx(o)
464 #define cPADOPo cPADOPx(o)
465 #define cPVOPo cPVOPx(o)
466 #define cCOPo cCOPx(o)
467 #define cLOOPo cLOOPx(o)
469 #define kUNOP cUNOPx(kid)
470 #define kUNOP_AUX cUNOP_AUXx(kid)
471 #define kBINOP cBINOPx(kid)
472 #define kLISTOP cLISTOPx(kid)
473 #define kLOGOP cLOGOPx(kid)
474 #define kPMOP cPMOPx(kid)
475 #define kSVOP cSVOPx(kid)
476 #define kPADOP cPADOPx(kid)
477 #define kPVOP cPVOPx(kid)
478 #define kCOP cCOPx(kid)
479 #define kLOOP cLOOPx(kid)
483 # define cGVOPx_gv(o) ((GV*)PAD_SVl(cPADOPx(o)->op_padix))
485 # define IS_PADGV(v) (v && isGV(v))
486 # define IS_PADCONST(v) \
487 (v && (SvREADONLY(v) || (SvIsCOW(v) && !SvLEN(v))))
489 # define cSVOPx_sv(v) (cSVOPx(v)->op_sv \
490 ? cSVOPx(v)->op_sv : PAD_SVl((v)->op_targ))
491 # define cSVOPx_svp(v) (cSVOPx(v)->op_sv \
492 ? &cSVOPx(v)->op_sv : &PAD_SVl((v)->op_targ))
493 # define cMETHOPx_rclass(v) PAD_SVl(cMETHOPx(v)->op_rclass_targ)
495 # define cGVOPx_gv(o) ((GV*)cSVOPx(o)->op_sv)
497 # define IS_PADGV(v) FALSE
498 # define IS_PADCONST(v) FALSE
500 # define cSVOPx_sv(v) (cSVOPx(v)->op_sv)
501 # define cSVOPx_svp(v) (&cSVOPx(v)->op_sv)
502 # define cMETHOPx_rclass(v) (cMETHOPx(v)->op_rclass_sv)
505 # define cMETHOPx_meth(v) cSVOPx_sv(v)
507 #define cGVOP_gv cGVOPx_gv(PL_op)
508 #define cGVOPo_gv cGVOPx_gv(o)
509 #define kGVOP_gv cGVOPx_gv(kid)
510 #define cSVOP_sv cSVOPx_sv(PL_op)
511 #define cSVOPo_sv cSVOPx_sv(o)
512 #define kSVOP_sv cSVOPx_sv(kid)
515 # define Nullop ((OP*)NULL)
518 /* Lowest byte of PL_opargs */
520 #define OA_FOLDCONST 2
521 #define OA_RETSCALAR 4
523 #define OA_TARGLEX 16
524 #define OA_OTHERINT 32
525 #define OA_DANGEROUS 64
528 /* The next 4 bits (8..11) encode op class information */
531 #define OA_CLASS_MASK (15 << OCSHIFT)
533 #define OA_BASEOP (0 << OCSHIFT)
534 #define OA_UNOP (1 << OCSHIFT)
535 #define OA_BINOP (2 << OCSHIFT)
536 #define OA_LOGOP (3 << OCSHIFT)
537 #define OA_LISTOP (4 << OCSHIFT)
538 #define OA_PMOP (5 << OCSHIFT)
539 #define OA_SVOP (6 << OCSHIFT)
540 #define OA_PADOP (7 << OCSHIFT)
541 #define OA_PVOP_OR_SVOP (8 << OCSHIFT)
542 #define OA_LOOP (9 << OCSHIFT)
543 #define OA_COP (10 << OCSHIFT)
544 #define OA_BASEOP_OR_UNOP (11 << OCSHIFT)
545 #define OA_FILESTATOP (12 << OCSHIFT)
546 #define OA_LOOPEXOP (13 << OCSHIFT)
547 #define OA_METHOP (14 << OCSHIFT)
548 #define OA_UNOP_AUX (15 << OCSHIFT)
550 /* Each remaining nybble of PL_opargs (i.e. bits 12..15, 16..19 etc)
551 * encode the type for each arg */
560 #define OA_SCALARREF 7
561 #define OA_OPTIONAL 8
563 /* Op_REFCNT is a reference count at the head of each op tree: needed
564 * since the tree is shared between threads, and between cloned closure
565 * copies in the same thread. OP_REFCNT_LOCK/UNLOCK is used when modifying
567 * The same mutex is used to protect the refcounts of the reg_trie_data
568 * and reg_ac_data structures, which are shared between duplicated
573 # define OP_REFCNT_INIT MUTEX_INIT(&PL_op_mutex)
575 # define OP_REFCNT_LOCK MUTEX_LOCK(&PL_op_mutex)
576 # define OP_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_op_mutex)
578 # define OP_REFCNT_LOCK op_refcnt_lock()
579 # define OP_REFCNT_UNLOCK op_refcnt_unlock()
581 # define OP_REFCNT_TERM MUTEX_DESTROY(&PL_op_mutex)
583 # define OP_REFCNT_INIT NOOP
584 # define OP_REFCNT_LOCK NOOP
585 # define OP_REFCNT_UNLOCK NOOP
586 # define OP_REFCNT_TERM NOOP
589 #define OpREFCNT_set(o,n) ((o)->op_targ = (n))
590 #ifdef PERL_DEBUG_READONLY_OPS
591 # define OpREFCNT_inc(o) Perl_op_refcnt_inc(aTHX_ o)
592 # define OpREFCNT_dec(o) Perl_op_refcnt_dec(aTHX_ o)
594 # define OpREFCNT_inc(o) ((o) ? (++(o)->op_targ, (o)) : NULL)
595 # define OpREFCNT_dec(o) (--(o)->op_targ)
598 /* flags used by Perl_load_module() */
599 #define PERL_LOADMOD_DENY 0x1 /* no Module */
600 #define PERL_LOADMOD_NOIMPORT 0x2 /* use Module () */
601 #define PERL_LOADMOD_IMPORT_OPS 0x4 /* import arguments
606 #if defined(PERL_IN_PERLY_C) || defined(PERL_IN_OP_C) || defined(PERL_IN_TOKE_C)
607 #define ref(o, type) doref(o, type, TRUE)
611 =head1 Optree Manipulation Functions
613 =for apidoc Am|OP*|LINKLIST|OP *o
614 Given the root of an optree, link the tree in execution order using the
615 C<op_next> pointers and return the first op executed. If this has
616 already been done, it will not be redone, and C<< o->op_next >> will be
617 returned. If C<< o->op_next >> is not already set, C<o> should be at
623 #define LINKLIST(o) ((o)->op_next ? (o)->op_next : op_linklist((OP*)o))
625 /* no longer used anywhere in core */
627 #define cv_ckproto(cv, gv, p) \
628 cv_ckproto_len_flags((cv), (gv), (p), (p) ? strlen(p) : 0, 0)
632 # define my(o) my_attrs((o), NULL)
635 #ifdef USE_REENTRANT_API
639 #define NewOp(m,var,c,type) \
640 (var = (type *) Perl_Slab_Alloc(aTHX_ c*sizeof(type)))
641 #define NewOpSz(m,var,size) \
642 (var = (OP *) Perl_Slab_Alloc(aTHX_ size))
643 #define FreeOp(p) Perl_Slab_Free(aTHX_ p)
646 * The per-CV op slabs consist of a header (the opslab struct) and a bunch
647 * of space for allocating op slots, each of which consists of two pointers
648 * followed by an op. The first pointer points to the next op slot. The
649 * second points to the slab. At the end of the slab is a null pointer,
650 * so that slot->opslot_next - slot can be used to determine the size
653 * Each CV can have multiple slabs; opslab_next points to the next slab, to
654 * form a chain. All bookkeeping is done on the first slab, which is where
655 * all the op slots point.
657 * Freed ops are marked as freed and attached to the freed chain
658 * via op_next pointers.
660 * When there is more than one slab, the second slab in the slab chain is
661 * assumed to be the one with free space available. It is used when allo-
662 * cating an op if there are no freed ops available or big enough.
667 /* keep opslot_next first */
668 OPSLOT * opslot_next; /* next slot */
669 OPSLAB * opslot_slab; /* owner */
670 OP opslot_op; /* the op itself */
674 OPSLOT * opslab_first; /* first op in this slab */
675 OPSLAB * opslab_next; /* next slab */
676 OP * opslab_freed; /* chain of freed ops */
677 size_t opslab_refcnt; /* number of ops */
678 # ifdef PERL_DEBUG_READONLY_OPS
679 U16 opslab_size; /* size of slab in pointers */
680 bool opslab_readonly;
682 OPSLOT opslab_slots; /* slots begin here */
685 # define OPSLOT_HEADER STRUCT_OFFSET(OPSLOT, opslot_op)
686 # define OPSLOT_HEADER_P (OPSLOT_HEADER/sizeof(I32 *))
687 # define OpSLOT(o) (assert_(o->op_slabbed) \
688 (OPSLOT *)(((char *)o)-OPSLOT_HEADER))
689 # define OpSLAB(o) OpSLOT(o)->opslot_slab
690 # define OpslabREFCNT_dec(slab) \
691 (((slab)->opslab_refcnt == 1) \
692 ? opslab_free_nopad(slab) \
693 : (void)--(slab)->opslab_refcnt)
694 /* Variant that does not null out the pads */
695 # define OpslabREFCNT_dec_padok(slab) \
696 (((slab)->opslab_refcnt == 1) \
697 ? opslab_free(slab) \
698 : (void)--(slab)->opslab_refcnt)
703 void (*bhk_start) (pTHX_ int full);
704 void (*bhk_pre_end) (pTHX_ OP **seq);
705 void (*bhk_post_end) (pTHX_ OP **seq);
706 void (*bhk_eval) (pTHX_ OP *const saveop);
710 =head1 Compile-time scope hooks
712 =for apidoc mx|U32|BhkFLAGS|BHK *hk
713 Return the BHK's flags.
715 =for apidoc mx|void *|BhkENTRY|BHK *hk|which
716 Return an entry from the BHK structure. C<which> is a preprocessor token
717 indicating which entry to return. If the appropriate flag is not set
718 this will return C<NULL>. The type of the return value depends on which
721 =for apidoc Amx|void|BhkENTRY_set|BHK *hk|which|void *ptr
722 Set an entry in the BHK structure, and set the flags to indicate it is
723 valid. C<which> is a preprocessing token indicating which entry to set.
724 The type of C<ptr> depends on the entry.
726 =for apidoc Amx|void|BhkDISABLE|BHK *hk|which
727 Temporarily disable an entry in this BHK structure, by clearing the
728 appropriate flag. C<which> is a preprocessor token indicating which
731 =for apidoc Amx|void|BhkENABLE|BHK *hk|which
732 Re-enable an entry in this BHK structure, by setting the appropriate
733 flag. C<which> is a preprocessor token indicating which entry to enable.
734 This will assert (under -DDEBUGGING) if the entry doesn't contain a valid
737 =for apidoc mx|void|CALL_BLOCK_HOOKS|which|arg
738 Call all the registered block hooks for type C<which>. C<which> is a
739 preprocessing token; the type of C<arg> depends on C<which>.
744 #define BhkFLAGS(hk) ((hk)->bhk_flags)
746 #define BHKf_bhk_start 0x01
747 #define BHKf_bhk_pre_end 0x02
748 #define BHKf_bhk_post_end 0x04
749 #define BHKf_bhk_eval 0x08
751 #define BhkENTRY(hk, which) \
752 ((BhkFLAGS(hk) & BHKf_ ## which) ? ((hk)->which) : NULL)
754 #define BhkENABLE(hk, which) \
756 BhkFLAGS(hk) |= BHKf_ ## which; \
757 assert(BhkENTRY(hk, which)); \
760 #define BhkDISABLE(hk, which) \
762 BhkFLAGS(hk) &= ~(BHKf_ ## which); \
765 #define BhkENTRY_set(hk, which, ptr) \
768 BhkENABLE(hk, which); \
771 #define CALL_BLOCK_HOOKS(which, arg) \
773 if (PL_blockhooks) { \
775 for (i = av_tindex(PL_blockhooks); i >= 0; i--) { \
776 SV *sv = AvARRAY(PL_blockhooks)[i]; \
781 hk = INT2PTR(BHK *, SvUVX(sv)); \
783 hk = INT2PTR(BHK *, SvIVX(sv)); \
785 if (BhkENTRY(hk, which)) \
786 BhkENTRY(hk, which)(aTHX_ arg); \
791 /* flags for rv2cv_op_cv */
793 #define RV2CVOPCV_MARK_EARLY 0x00000001
794 #define RV2CVOPCV_RETURN_NAME_GV 0x00000002
795 #define RV2CVOPCV_RETURN_STUB 0x00000004
796 #ifdef PERL_CORE /* behaviour of this flag is subject to change: */
797 # define RV2CVOPCV_MAYBE_NAME_GV 0x00000008
799 #define RV2CVOPCV_FLAG_MASK 0x0000000f /* all of the above */
801 #define op_lvalue(op,t) Perl_op_lvalue_flags(aTHX_ op,t,0)
803 /* flags for op_lvalue_flags */
805 #define OP_LVALUE_NO_CROAK 1
808 =head1 Custom Operators
810 =for apidoc Am|U32|XopFLAGS|XOP *xop
811 Return the XOP's flags.
813 =for apidoc Am||XopENTRY|XOP *xop|which
814 Return a member of the XOP structure. C<which> is a cpp token
815 indicating which entry to return. If the member is not set
816 this will return a default value. The return type depends
817 on C<which>. This macro evaluates its arguments more than
818 once. If you are using C<Perl_custom_op_xop> to retreive a
819 C<XOP *> from a C<OP *>, use the more efficient L</XopENTRYCUSTOM> instead.
821 =for apidoc Am||XopENTRYCUSTOM|const OP *o|which
822 Exactly like C<XopENTRY(XopENTRY(Perl_custom_op_xop(aTHX_ o), which)> but more
823 efficient. The C<which> parameter is identical to L</XopENTRY>.
825 =for apidoc Am|void|XopENTRY_set|XOP *xop|which|value
826 Set a member of the XOP structure. C<which> is a cpp token
827 indicating which entry to set. See L<perlguts/"Custom Operators">
828 for details about the available members and how
829 they are used. This macro evaluates its argument
832 =for apidoc Am|void|XopDISABLE|XOP *xop|which
833 Temporarily disable a member of the XOP, by clearing the appropriate flag.
835 =for apidoc Am|void|XopENABLE|XOP *xop|which
836 Reenable a member of the XOP which has been disabled.
843 const char *xop_name;
844 const char *xop_desc;
846 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
849 /* return value of Perl_custom_op_get_field, similar to void * then casting but
850 the U32 doesn't need truncation on 64 bit platforms in the caller, also
851 for easier macro writing */
853 const char *xop_name;
854 const char *xop_desc;
856 void (*xop_peep)(pTHX_ OP *o, OP *oldop);
860 #define XopFLAGS(xop) ((xop)->xop_flags)
862 #define XOPf_xop_name 0x01
863 #define XOPf_xop_desc 0x02
864 #define XOPf_xop_class 0x04
865 #define XOPf_xop_peep 0x08
867 /* used by Perl_custom_op_get_field for option checking */
869 XOPe_xop_ptr = 0, /* just get the XOP *, don't look inside it */
870 XOPe_xop_name = XOPf_xop_name,
871 XOPe_xop_desc = XOPf_xop_desc,
872 XOPe_xop_class = XOPf_xop_class,
873 XOPe_xop_peep = XOPf_xop_peep
876 #define XOPd_xop_name PL_op_name[OP_CUSTOM]
877 #define XOPd_xop_desc PL_op_desc[OP_CUSTOM]
878 #define XOPd_xop_class OA_BASEOP
879 #define XOPd_xop_peep ((Perl_cpeep_t)0)
881 #define XopENTRY_set(xop, which, to) \
883 (xop)->which = (to); \
884 (xop)->xop_flags |= XOPf_ ## which; \
887 #define XopENTRY(xop, which) \
888 ((XopFLAGS(xop) & XOPf_ ## which) ? (xop)->which : XOPd_ ## which)
890 #define XopENTRYCUSTOM(o, which) \
891 (Perl_custom_op_get_field(aTHX_ o, XOPe_ ## which).which)
893 #define XopDISABLE(xop, which) ((xop)->xop_flags &= ~XOPf_ ## which)
894 #define XopENABLE(xop, which) \
896 (xop)->xop_flags |= XOPf_ ## which; \
897 assert(XopENTRY(xop, which)); \
900 #define Perl_custom_op_xop(x) \
901 (Perl_custom_op_get_field(x, XOPe_xop_ptr).xop_ptr)
904 =head1 Optree Manipulation Functions
906 =for apidoc Am|const char *|OP_NAME|OP *o
907 Return the name of the provided OP. For core ops this looks up the name
908 from the op_type; for custom ops from the op_ppaddr.
910 =for apidoc Am|const char *|OP_DESC|OP *o
911 Return a short description of the provided OP.
913 =for apidoc Am|U32|OP_CLASS|OP *o
914 Return the class of the provided OP: that is, which of the *OP
915 structures it uses. For core ops this currently gets the information out
916 of C<PL_opargs>, which does not always accurately reflect the type used.
917 For custom ops the type is returned from the registration, and it is up
918 to the registree to ensure it is accurate. The value returned will be
919 one of the C<OA_>* constants from F<op.h>.
921 =for apidoc Am|bool|OP_TYPE_IS|OP *o|Optype type
922 Returns true if the given OP is not a C<NULL> pointer
923 and if it is of the given type.
925 The negation of this macro, C<OP_TYPE_ISNT> is also available
926 as well as C<OP_TYPE_IS_NN> and C<OP_TYPE_ISNT_NN> which elide
927 the NULL pointer check.
929 =for apidoc Am|bool|OP_TYPE_IS_OR_WAS|OP *o|Optype type
930 Returns true if the given OP is not a NULL pointer and
931 if it is of the given type or used to be before being
932 replaced by an OP of type OP_NULL.
934 The negation of this macro, C<OP_TYPE_ISNT_AND_WASNT>
935 is also available as well as C<OP_TYPE_IS_OR_WAS_NN>
936 and C<OP_TYPE_ISNT_AND_WASNT_NN> which elide
937 the C<NULL> pointer check.
939 =for apidoc Am|bool|OpHAS_SIBLING|OP *o
940 Returns true if C<o> has a sibling
942 =for apidoc Am|OP*|OpSIBLING|OP *o
943 Returns the sibling of C<o>, or C<NULL> if there is no sibling
945 =for apidoc Am|void|OpMORESIB_set|OP *o|OP *sib
946 Sets the sibling of C<o> to the non-zero value C<sib>. See also C<L</OpLASTSIB_set>>
947 and C<L</OpMAYBESIB_set>>. For a higher-level interface, see
948 C<L</op_sibling_splice>>.
950 =for apidoc Am|void|OpLASTSIB_set|OP *o|OP *parent
951 Marks C<o> as having no further siblings. On C<PERL_OP_PARENT> builds, marks
952 o as having the specified parent. See also C<L</OpMORESIB_set>> and
953 C<OpMAYBESIB_set>. For a higher-level interface, see
954 C<L</op_sibling_splice>>.
956 =for apidoc Am|void|OpMAYBESIB_set|OP *o|OP *sib|OP *parent
957 Conditionally does C<OpMORESIB_set> or C<OpLASTSIB_set> depending on whether
958 C<sib> is non-null. For a higher-level interface, see C<L</op_sibling_splice>>.
963 #define OP_NAME(o) ((o)->op_type == OP_CUSTOM \
964 ? XopENTRYCUSTOM(o, xop_name) \
965 : PL_op_name[(o)->op_type])
966 #define OP_DESC(o) ((o)->op_type == OP_CUSTOM \
967 ? XopENTRYCUSTOM(o, xop_desc) \
968 : PL_op_desc[(o)->op_type])
969 #define OP_CLASS(o) ((o)->op_type == OP_CUSTOM \
970 ? XopENTRYCUSTOM(o, xop_class) \
971 : (PL_opargs[(o)->op_type] & OA_CLASS_MASK))
973 #define OP_TYPE_IS(o, type) ((o) && (o)->op_type == (type))
974 #define OP_TYPE_IS_NN(o, type) ((o)->op_type == (type))
975 #define OP_TYPE_ISNT(o, type) ((o) && (o)->op_type != (type))
976 #define OP_TYPE_ISNT_NN(o, type) ((o)->op_type != (type))
978 #define OP_TYPE_IS_OR_WAS_NN(o, type) \
979 ( ((o)->op_type == OP_NULL \
984 #define OP_TYPE_IS_OR_WAS(o, type) \
985 ( (o) && OP_TYPE_IS_OR_WAS_NN(o, type) )
987 #define OP_TYPE_ISNT_AND_WASNT_NN(o, type) \
988 ( ((o)->op_type == OP_NULL \
993 #define OP_TYPE_ISNT_AND_WASNT(o, type) \
994 ( (o) && OP_TYPE_ISNT_AND_WASNT_NN(o, type) )
997 #ifdef PERL_OP_PARENT
998 # define OpHAS_SIBLING(o) (cBOOL((o)->op_moresib))
999 # define OpSIBLING(o) (0 + (o)->op_moresib ? (o)->op_sibparent : NULL)
1000 # define OpMORESIB_set(o, sib) ((o)->op_moresib = 1, (o)->op_sibparent = (sib))
1001 # define OpLASTSIB_set(o, parent) \
1002 ((o)->op_moresib = 0, (o)->op_sibparent = (parent))
1003 # define OpMAYBESIB_set(o, sib, parent) \
1004 ((o)->op_sibparent = ((o)->op_moresib = cBOOL(sib)) ? (sib) : (parent))
1006 # define OpHAS_SIBLING(o) (cBOOL((o)->op_sibling))
1007 # define OpSIBLING(o) (0 + (o)->op_sibling)
1008 # define OpMORESIB_set(o, sib) ((o)->op_moresib = 1, (o)->op_sibling = (sib))
1009 # define OpLASTSIB_set(o, parent) \
1010 ((o)->op_moresib = 0, (o)->op_sibling = NULL)
1011 # define OpMAYBESIB_set(o, sib, parent) \
1012 ((o)->op_moresib = cBOOL(sib), (o)->op_sibling = (sib))
1015 #if !defined(PERL_CORE) && !defined(PERL_EXT)
1016 /* for backwards compatibility only */
1017 # define OP_SIBLING(o) OpSIBLING(o)
1020 #define newATTRSUB(f, o, p, a, b) Perl_newATTRSUB_x(aTHX_ f, o, p, a, b, FALSE)
1021 #define newSUB(f, o, p, b) newATTRSUB((f), (o), (p), NULL, (b))
1024 =head1 Hook manipulation
1028 # define OP_CHECK_MUTEX_INIT MUTEX_INIT(&PL_check_mutex)
1029 # define OP_CHECK_MUTEX_LOCK MUTEX_LOCK(&PL_check_mutex)
1030 # define OP_CHECK_MUTEX_UNLOCK MUTEX_UNLOCK(&PL_check_mutex)
1031 # define OP_CHECK_MUTEX_TERM MUTEX_DESTROY(&PL_check_mutex)
1033 # define OP_CHECK_MUTEX_INIT NOOP
1034 # define OP_CHECK_MUTEX_LOCK NOOP
1035 # define OP_CHECK_MUTEX_UNLOCK NOOP
1036 # define OP_CHECK_MUTEX_TERM NOOP
1040 /* Stuff for OP_MULTDEREF/pp_multideref. */
1044 /* Load another word of actions/flag bits. Must be 0 */
1045 #define MDEREF_reload 0
1047 #define MDEREF_AV_pop_rv2av_aelem 1
1048 #define MDEREF_AV_gvsv_vivify_rv2av_aelem 2
1049 #define MDEREF_AV_padsv_vivify_rv2av_aelem 3
1050 #define MDEREF_AV_vivify_rv2av_aelem 4
1051 #define MDEREF_AV_padav_aelem 5
1052 #define MDEREF_AV_gvav_aelem 6
1054 #define MDEREF_HV_pop_rv2hv_helem 8
1055 #define MDEREF_HV_gvsv_vivify_rv2hv_helem 9
1056 #define MDEREF_HV_padsv_vivify_rv2hv_helem 10
1057 #define MDEREF_HV_vivify_rv2hv_helem 11
1058 #define MDEREF_HV_padhv_helem 12
1059 #define MDEREF_HV_gvhv_helem 13
1061 #define MDEREF_ACTION_MASK 0xf
1063 /* key / index type */
1065 #define MDEREF_INDEX_none 0x00 /* run external ops to generate index */
1066 #define MDEREF_INDEX_const 0x10 /* index is const PV/UV */
1067 #define MDEREF_INDEX_padsv 0x20 /* index is lexical var */
1068 #define MDEREF_INDEX_gvsv 0x30 /* index is GV */
1070 #define MDEREF_INDEX_MASK 0x30
1074 #define MDEREF_FLAG_last 0x40 /* the last [ah]elem; PL_op flags apply */
1076 #define MDEREF_MASK 0x7F
1077 #define MDEREF_SHIFT 7
1079 #if defined(PERL_IN_DOOP_C) || defined(PERL_IN_PP_C)
1080 static const char * const deprecated_above_ff_msg
1081 = "Use of strings with code points over 0xFF as arguments to "
1082 "%s operator is deprecated";
1087 * ex: set ts=8 sts=4 sw=4 et: