This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add Max as a release victim
[perl5.git] / cv.h
CommitLineData
a0d0e21e 1/* cv.h
79072805 2 *
1129b882
NC
3 * Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2001,
4 * 2002, 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
79072805
LW
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 *
79072805
LW
9 */
10
7c60e434 11/* This structure must the beginning of XPVFM in sv.h */
44a8e56a 12
79072805 13struct xpvcv {
20f4945e 14 _XPV_HEAD;
20f4945e 15 _XPVCV_COMMON;
c4648999 16 I32 xcv_depth; /* >= 2 indicates recursive call */
79072805 17};
748a9306 18
954c1994 19/*
ccfc67b7
JH
20=head1 Handy Values
21
954c1994
GS
22=for apidoc AmU||Nullcv
23Null CV pointer.
24
3ae1b226
NC
25(deprecated - use C<(CV *)NULL> instead)
26
ccfc67b7
JH
27=head1 CV Manipulation Functions
28
f0b90de1
SF
29This section documents functions to manipulate CVs which are code-values,
30or subroutines. For more information, see L<perlguts>.
31
954c1994 32=for apidoc Am|HV*|CvSTASH|CV* cv
f0b90de1
SF
33Returns the stash of the CV. A stash is the symbol table hash, containing
34the package-scoped variables in the package where the subroutine was defined.
35For more information, see L<perlguts>.
954c1994
GS
36
37=cut
38*/
39
3ae1b226
NC
40#ifndef PERL_CORE
41# define Nullcv Null(CV*)
42#endif
a5f75d66 43
c68d9564
Z
44#define CvSTASH(sv) (0+((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_stash)
45#define CvSTASH_set(cv,st) Perl_cvstash_set(aTHX_ cv, st)
8f629a87
NC
46#define CvSTART(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_start_u.xcv_start
47#define CvROOT(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_root_u.xcv_root
48#define CvXSUB(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_root_u.xcv_xsub
49#define CvXSUBANY(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_start_u.xcv_xsubany
b3f91e91
DM
50#define CvGV(sv) (0+((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_gv)
51#define CvGV_set(cv,gv) Perl_cvgv_set(aTHX_ cv, gv)
8f629a87 52#define CvFILE(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_file
a636914a
RH
53#ifdef USE_ITHREADS
54# define CvFILE_set_from_cop(sv, cop) (CvFILE(sv) = savepv(CopFILE(cop)))
55#else
56# define CvFILE_set_from_cop(sv, cop) (CvFILE(sv) = CopFILE(cop))
57#endif
9ec2a764 58#define CvFILEGV(sv) (gv_fetchfile(CvFILE(sv)))
bb172083 59#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
8f629a87 60# define CvDEPTH(sv) (*({const CV *const _cvdepth = (const CV *)sv; \
5129b2ca 61 assert(SvTYPE(_cvdepth) == SVt_PVCV); \
c4648999 62 &((XPVCV*)SvANY(_cvdepth))->xcv_depth; \
bb172083
NC
63 }))
64#else
c4648999 65# define CvDEPTH(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_depth
bb172083 66#endif
8f629a87
NC
67#define CvPADLIST(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_padlist
68#define CvOUTSIDE(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_outside
69#define CvFLAGS(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_flags
70#define CvOUTSIDE_SEQ(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_outside_seq
a5f75d66 71
5b4563c8 72#define CVf_METHOD 0x0001 /* CV is explicitly marked as a method */
c2485e0c
NC
73#define CVf_LVALUE 0x0002 /* CV return value can be used as lvalue */
74#define CVf_CONST 0x0004 /* inlinable sub */
75#define CVf_ISXSUB 0x0008 /* CV is an XSUB, not pure perl. */
5b4563c8
NC
76
77#define CVf_WEAKOUTSIDE 0x0010 /* CvOUTSIDE isn't ref counted */
78#define CVf_CLONE 0x0020 /* anon CV uses external lexicals */
79#define CVf_CLONED 0x0040 /* a clone of one of those */
cfc1e951 80#define CVf_ANON 0x0080 /* CV is not pointed to by a GV */
5b4563c8 81#define CVf_UNIQUE 0x0100 /* sub is only called once (eg PL_main_cv,
1108974d 82 * require, eval). */
5b4563c8 83#define CVf_NODEBUG 0x0200 /* no DB::sub indirection for this CV
8ebc5c01 84 (esp. useful for special XSUBs) */
cfc1e951 85#define CVf_CVGV_RC 0x0400 /* CvGV is reference counted */
7dafbf52 86
d3cea301 87/* This symbol for optimised communication between toke.c and op.c: */
e95ab0c0 88#define CVf_BUILTIN_ATTRS (CVf_METHOD|CVf_LVALUE)
a5f75d66
AD
89
90#define CvCLONE(cv) (CvFLAGS(cv) & CVf_CLONE)
91#define CvCLONE_on(cv) (CvFLAGS(cv) |= CVf_CLONE)
92#define CvCLONE_off(cv) (CvFLAGS(cv) &= ~CVf_CLONE)
93
94#define CvCLONED(cv) (CvFLAGS(cv) & CVf_CLONED)
95#define CvCLONED_on(cv) (CvFLAGS(cv) |= CVf_CLONED)
96#define CvCLONED_off(cv) (CvFLAGS(cv) &= ~CVf_CLONED)
97
98#define CvANON(cv) (CvFLAGS(cv) & CVf_ANON)
99#define CvANON_on(cv) (CvFLAGS(cv) |= CVf_ANON)
100#define CvANON_off(cv) (CvFLAGS(cv) &= ~CVf_ANON)
79072805 101
07055b4c
CS
102#define CvUNIQUE(cv) (CvFLAGS(cv) & CVf_UNIQUE)
103#define CvUNIQUE_on(cv) (CvFLAGS(cv) |= CVf_UNIQUE)
104#define CvUNIQUE_off(cv) (CvFLAGS(cv) &= ~CVf_UNIQUE)
8ebc5c01
PP
105
106#define CvNODEBUG(cv) (CvFLAGS(cv) & CVf_NODEBUG)
107#define CvNODEBUG_on(cv) (CvFLAGS(cv) |= CVf_NODEBUG)
108#define CvNODEBUG_off(cv) (CvFLAGS(cv) &= ~CVf_NODEBUG)
77a005ab
MB
109
110#define CvMETHOD(cv) (CvFLAGS(cv) & CVf_METHOD)
111#define CvMETHOD_on(cv) (CvFLAGS(cv) |= CVf_METHOD)
112#define CvMETHOD_off(cv) (CvFLAGS(cv) &= ~CVf_METHOD)
113
cd06dffe
GS
114#define CvLVALUE(cv) (CvFLAGS(cv) & CVf_LVALUE)
115#define CvLVALUE_on(cv) (CvFLAGS(cv) |= CVf_LVALUE)
116#define CvLVALUE_off(cv) (CvFLAGS(cv) &= ~CVf_LVALUE)
117
1aff0e91
GS
118#define CvEVAL(cv) (CvUNIQUE(cv) && !SvFAKE(cv))
119#define CvEVAL_on(cv) (CvUNIQUE_on(cv),SvFAKE_off(cv))
120#define CvEVAL_off(cv) CvUNIQUE_off(cv)
121
3c10abe3 122/* BEGIN|CHECK|INIT|UNITCHECK|END */
1aff0e91
GS
123#define CvSPECIAL(cv) (CvUNIQUE(cv) && SvFAKE(cv))
124#define CvSPECIAL_on(cv) (CvUNIQUE_on(cv),SvFAKE_on(cv))
125#define CvSPECIAL_off(cv) (CvUNIQUE_off(cv),SvFAKE_off(cv))
beab0874
JT
126
127#define CvCONST(cv) (CvFLAGS(cv) & CVf_CONST)
128#define CvCONST_on(cv) (CvFLAGS(cv) |= CVf_CONST)
129#define CvCONST_off(cv) (CvFLAGS(cv) &= ~CVf_CONST)
a4f1a029 130
7dafbf52
DM
131#define CvWEAKOUTSIDE(cv) (CvFLAGS(cv) & CVf_WEAKOUTSIDE)
132#define CvWEAKOUTSIDE_on(cv) (CvFLAGS(cv) |= CVf_WEAKOUTSIDE)
133#define CvWEAKOUTSIDE_off(cv) (CvFLAGS(cv) &= ~CVf_WEAKOUTSIDE)
134
d04ba589
NC
135#define CvISXSUB(cv) (CvFLAGS(cv) & CVf_ISXSUB)
136#define CvISXSUB_on(cv) (CvFLAGS(cv) |= CVf_ISXSUB)
137#define CvISXSUB_off(cv) (CvFLAGS(cv) &= ~CVf_ISXSUB)
138
cfc1e951
DM
139#define CvCVGV_RC(cv) (CvFLAGS(cv) & CVf_CVGV_RC)
140#define CvCVGV_RC_on(cv) (CvFLAGS(cv) |= CVf_CVGV_RC)
141#define CvCVGV_RC_off(cv) (CvFLAGS(cv) &= ~CVf_CVGV_RC)
142
77004dee
NC
143/* Flags for newXS_flags */
144#define XS_DYNAMIC_FILENAME 0x01 /* The filename isn't static */
145
7dafbf52
DM
146/*
147=head1 CV reference counts and CvOUTSIDE
148
149=for apidoc m|bool|CvWEAKOUTSIDE|CV *cv
150
151Each CV has a pointer, C<CvOUTSIDE()>, to its lexically enclosing
152CV (if any). Because pointers to anonymous sub prototypes are
153stored in C<&> pad slots, it is a possible to get a circular reference,
154with the parent pointing to the child and vice-versa. To avoid the
155ensuing memory leak, we do not increment the reference count of the CV
156pointed to by C<CvOUTSIDE> in the I<one specific instance> that the parent
157has a C<&> pad slot pointing back to us. In this case, we set the
158C<CvWEAKOUTSIDE> flag in the child. This allows us to determine under what
159circumstances we should decrement the refcount of the parent when freeing
160the child.
161
eeb8d49e 162There is a further complication with non-closure anonymous subs (i.e. those
7dafbf52
DM
163that do not refer to any lexicals outside that sub). In this case, the
164anonymous prototype is shared rather than being cloned. This has the
165consequence that the parent may be freed while there are still active
166children, eg
167
168 BEGIN { $a = sub { eval '$x' } }
169
170In this case, the BEGIN is freed immediately after execution since there
171are no active references to it: the anon sub prototype has
172C<CvWEAKOUTSIDE> set since it's not a closure, and $a points to the same
173CV, so it doesn't contribute to BEGIN's refcount either. When $a is
174executed, the C<eval '$x'> causes the chain of C<CvOUTSIDE>s to be followed,
175and the freed BEGIN is accessed.
176
177To avoid this, whenever a CV and its associated pad is freed, any
178C<&> entries in the pad are explicitly removed from the pad, and if the
179refcount of the pointed-to anon sub is still positive, then that
180child's C<CvOUTSIDE> is set to point to its grandparent. This will only
181occur in the single specific case of a non-closure anon prototype
182having one or more active references (such as C<$a> above).
183
184One other thing to consider is that a CV may be merely undefined
185rather than freed, eg C<undef &foo>. In this case, its refcount may
186not have reached zero, but we still delete its pad and its C<CvROOT> etc.
187Since various children may still have their C<CvOUTSIDE> pointing at this
188undefined CV, we keep its own C<CvOUTSIDE> for the time being, so that
189the chain of lexical scopes is unbroken. For example, the following
190should print 123:
191
192 my $x = 123;
193 sub tmp { sub { eval '$x' } }
194 my $a = tmp();
195 undef &tmp;
196 print $a->();
197
198=cut
199*/
102d3b8a 200
d9088386
Z
201typedef OP *(*Perl_call_checker)(pTHX_ OP *, GV *, SV *);
202
102d3b8a
NC
203/*
204 * Local variables:
205 * c-indentation-style: bsd
206 * c-basic-offset: 4
207 * indent-tabs-mode: t
208 * End:
209 *
210 * ex: set ts=8 sts=4 sw=4 noet:
211 */