This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add CVf_LEXICAL flag
[perl5.git] / cv.h
1 /*    cv.h
2  *
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
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 /* This structure must match the beginning of XPVFM in sv.h  */
12
13 struct xpvcv {
14     _XPV_HEAD;
15     _XPVCV_COMMON;
16 };
17
18 /*
19 =head1 Handy Values
20
21 =for apidoc AmU||Nullcv
22 Null CV pointer.
23
24 (deprecated - use C<(CV *)NULL> instead)
25
26 =head1 CV Manipulation Functions
27
28 This section documents functions to manipulate CVs which are code-values,
29 or subroutines.  For more information, see L<perlguts>.
30
31 =for apidoc Am|HV*|CvSTASH|CV* cv
32 Returns the stash of the CV.  A stash is the symbol table hash, containing
33 the package-scoped variables in the package where the subroutine was defined.
34 For more information, see L<perlguts>.
35
36 This also has a special use with XS AUTOLOAD subs.
37 See L<perlguts/Autoloading with XSUBs>.
38
39 =cut
40 */
41
42 #ifndef PERL_CORE
43 #  define Nullcv Null(CV*)
44 #endif
45
46 #define CvSTASH(sv)     (0+((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_stash)
47 #define CvSTASH_set(cv,st) Perl_cvstash_set(aTHX_ cv, st)
48 #define CvSTART(sv)     ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_start_u.xcv_start
49 #define CvROOT(sv)      ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_root_u.xcv_root
50 #define CvXSUB(sv)      ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_root_u.xcv_xsub
51 #define CvXSUBANY(sv)   ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_start_u.xcv_xsubany
52 #define CvGV(sv)        S_CvGV((const CV *)(sv))
53 #define CvGV_set(cv,gv) Perl_cvgv_set(aTHX_ cv, gv)
54 #define CvFILE(sv)      ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_file
55 #ifdef USE_ITHREADS
56 #  define CvFILE_set_from_cop(sv, cop)  \
57     (CvFILE(sv) = savepv(CopFILE(cop)), CvDYNFILE_on(sv))
58 #else
59 #  define CvFILE_set_from_cop(sv, cop)  \
60     (CvFILE(sv) = CopFILE(cop), CvDYNFILE_off(sv))
61 #endif
62 #define CvFILEGV(sv)    (gv_fetchfile(CvFILE(sv)))
63 #define CvDEPTH(sv)     (*S_CvDEPTHp((const CV *)sv))
64 #define CvPADLIST(sv)   ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_padlist
65 #define CvOUTSIDE(sv)   ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_outside
66 #define CvFLAGS(sv)     ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_flags
67 #define CvOUTSIDE_SEQ(sv) ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_outside_seq
68
69 /* These two are sometimes called on non-CVs */
70 #define CvPROTO(sv)                               \
71         (                                          \
72          SvPOK(sv)                                  \
73           ? SvTYPE(sv) == SVt_PVCV && CvAUTOLOAD(sv) \
74              ? SvEND(sv)+1 : SvPVX_const(sv)          \
75           : NULL                                       \
76         )
77 #define CvPROTOLEN(sv)                            \
78         (                                          \
79          SvPOK(sv)                                  \
80           ? SvTYPE(sv) == SVt_PVCV && CvAUTOLOAD(sv) \
81              ? SvLEN(sv)-SvCUR(sv)-2                  \
82              : SvCUR(sv)                               \
83           : 0                                           \
84         )
85
86 #define CVf_METHOD      0x0001  /* CV is explicitly marked as a method */
87 #define CVf_LVALUE      0x0002  /* CV return value can be used as lvalue */
88 #define CVf_CONST       0x0004  /* inlinable sub */
89 #define CVf_ISXSUB      0x0008  /* CV is an XSUB, not pure perl.  */
90
91 #define CVf_WEAKOUTSIDE 0x0010  /* CvOUTSIDE isn't ref counted */
92 #define CVf_CLONE       0x0020  /* anon CV uses external lexicals */
93 #define CVf_CLONED      0x0040  /* a clone of one of those */
94 #define CVf_ANON        0x0080  /* CV is not pointed to by a GV */
95 #define CVf_UNIQUE      0x0100  /* sub is only called once (eg PL_main_cv,
96                                  * require, eval). */
97 #define CVf_NODEBUG     0x0200  /* no DB::sub indirection for this CV
98                                    (esp. useful for special XSUBs) */
99 #define CVf_CVGV_RC     0x0400  /* CvGV is reference counted */
100 #ifdef PERL_CORE
101 # define CVf_SLABBED    0x0800  /* Holds refcount on op slab  */
102 #endif
103 #define CVf_DYNFILE     0x1000  /* The filename isn't static  */
104 #define CVf_AUTOLOAD    0x2000  /* SvPVX contains AUTOLOADed sub name  */
105 #define CVf_HASEVAL     0x4000  /* contains string eval  */
106 #define CVf_NAMED       0x8000  /* Has a name HEK */
107 #define CVf_LEXICAL     0x10000 /* Omit package from name */
108
109 /* This symbol for optimised communication between toke.c and op.c: */
110 #define CVf_BUILTIN_ATTRS       (CVf_METHOD|CVf_LVALUE)
111
112 #define CvCLONE(cv)             (CvFLAGS(cv) & CVf_CLONE)
113 #define CvCLONE_on(cv)          (CvFLAGS(cv) |= CVf_CLONE)
114 #define CvCLONE_off(cv)         (CvFLAGS(cv) &= ~CVf_CLONE)
115
116 #define CvCLONED(cv)            (CvFLAGS(cv) & CVf_CLONED)
117 #define CvCLONED_on(cv)         (CvFLAGS(cv) |= CVf_CLONED)
118 #define CvCLONED_off(cv)        (CvFLAGS(cv) &= ~CVf_CLONED)
119
120 #define CvANON(cv)              (CvFLAGS(cv) & CVf_ANON)
121 #define CvANON_on(cv)           (CvFLAGS(cv) |= CVf_ANON)
122 #define CvANON_off(cv)          (CvFLAGS(cv) &= ~CVf_ANON)
123
124 /* CvEVAL or CvSPECIAL */
125 #define CvUNIQUE(cv)            (CvFLAGS(cv) & CVf_UNIQUE)
126 #define CvUNIQUE_on(cv)         (CvFLAGS(cv) |= CVf_UNIQUE)
127 #define CvUNIQUE_off(cv)        (CvFLAGS(cv) &= ~CVf_UNIQUE)
128
129 #define CvNODEBUG(cv)           (CvFLAGS(cv) & CVf_NODEBUG)
130 #define CvNODEBUG_on(cv)        (CvFLAGS(cv) |= CVf_NODEBUG)
131 #define CvNODEBUG_off(cv)       (CvFLAGS(cv) &= ~CVf_NODEBUG)
132
133 #define CvMETHOD(cv)            (CvFLAGS(cv) & CVf_METHOD)
134 #define CvMETHOD_on(cv)         (CvFLAGS(cv) |= CVf_METHOD)
135 #define CvMETHOD_off(cv)        (CvFLAGS(cv) &= ~CVf_METHOD)
136
137 #define CvLVALUE(cv)            (CvFLAGS(cv) & CVf_LVALUE)
138 #define CvLVALUE_on(cv)         (CvFLAGS(cv) |= CVf_LVALUE)
139 #define CvLVALUE_off(cv)        (CvFLAGS(cv) &= ~CVf_LVALUE)
140
141 /* eval or PL_main_cv */
142 #define CvEVAL(cv)              (CvUNIQUE(cv) && !SvFAKE(cv))
143 #define CvEVAL_on(cv)           (CvUNIQUE_on(cv),SvFAKE_off(cv))
144 #define CvEVAL_off(cv)          CvUNIQUE_off(cv)
145
146 /* BEGIN|CHECK|INIT|UNITCHECK|END */
147 #define CvSPECIAL(cv)           (CvUNIQUE(cv) && SvFAKE(cv))
148 #define CvSPECIAL_on(cv)        (CvUNIQUE_on(cv),SvFAKE_on(cv))
149 #define CvSPECIAL_off(cv)       (CvUNIQUE_off(cv),SvFAKE_off(cv))
150
151 #define CvCONST(cv)             (CvFLAGS(cv) & CVf_CONST)
152 #define CvCONST_on(cv)          (CvFLAGS(cv) |= CVf_CONST)
153 #define CvCONST_off(cv)         (CvFLAGS(cv) &= ~CVf_CONST)
154
155 #define CvWEAKOUTSIDE(cv)       (CvFLAGS(cv) & CVf_WEAKOUTSIDE)
156 #define CvWEAKOUTSIDE_on(cv)    (CvFLAGS(cv) |= CVf_WEAKOUTSIDE)
157 #define CvWEAKOUTSIDE_off(cv)   (CvFLAGS(cv) &= ~CVf_WEAKOUTSIDE)
158
159 #define CvISXSUB(cv)            (CvFLAGS(cv) & CVf_ISXSUB)
160 #define CvISXSUB_on(cv)         (CvFLAGS(cv) |= CVf_ISXSUB)
161 #define CvISXSUB_off(cv)        (CvFLAGS(cv) &= ~CVf_ISXSUB)
162
163 #define CvCVGV_RC(cv)           (CvFLAGS(cv) & CVf_CVGV_RC)
164 #define CvCVGV_RC_on(cv)        (CvFLAGS(cv) |= CVf_CVGV_RC)
165 #define CvCVGV_RC_off(cv)       (CvFLAGS(cv) &= ~CVf_CVGV_RC)
166
167 #ifdef PERL_CORE
168 # define CvSLABBED(cv)          (CvFLAGS(cv) & CVf_SLABBED)
169 # define CvSLABBED_on(cv)       (CvFLAGS(cv) |= CVf_SLABBED)
170 # define CvSLABBED_off(cv)      (CvFLAGS(cv) &= ~CVf_SLABBED)
171 #endif
172
173 #define CvDYNFILE(cv)           (CvFLAGS(cv) & CVf_DYNFILE)
174 #define CvDYNFILE_on(cv)        (CvFLAGS(cv) |= CVf_DYNFILE)
175 #define CvDYNFILE_off(cv)       (CvFLAGS(cv) &= ~CVf_DYNFILE)
176
177 #define CvAUTOLOAD(cv)          (CvFLAGS(cv) & CVf_AUTOLOAD)
178 #define CvAUTOLOAD_on(cv)       (CvFLAGS(cv) |= CVf_AUTOLOAD)
179 #define CvAUTOLOAD_off(cv)      (CvFLAGS(cv) &= ~CVf_AUTOLOAD)
180
181 #define CvHASEVAL(cv)           (CvFLAGS(cv) & CVf_HASEVAL)
182 #define CvHASEVAL_on(cv)        (CvFLAGS(cv) |= CVf_HASEVAL)
183 #define CvHASEVAL_off(cv)       (CvFLAGS(cv) &= ~CVf_HASEVAL)
184
185 #define CvNAMED(cv)             (CvFLAGS(cv) & CVf_NAMED)
186 #define CvNAMED_on(cv)          (CvFLAGS(cv) |= CVf_NAMED)
187 #define CvNAMED_off(cv)         (CvFLAGS(cv) &= ~CVf_NAMED)
188
189 #define CvLEXICAL(cv)           (CvFLAGS(cv) & CVf_LEXICAL)
190 #define CvLEXICAL_on(cv)        (CvFLAGS(cv) |= CVf_LEXICAL)
191 #define CvLEXICAL_off(cv)       (CvFLAGS(cv) &= ~CVf_LEXICAL)
192
193 /* Flags for newXS_flags  */
194 #define XS_DYNAMIC_FILENAME     0x01    /* The filename isn't static  */
195
196 PERL_STATIC_INLINE GV *
197 S_CvGV(const CV *sv)
198 {
199     return CvNAMED(sv)
200         ? 0
201         : ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_gv_u.xcv_gv;
202 }
203 PERL_STATIC_INLINE HEK *
204 CvNAME_HEK(CV *sv)
205 {
206     return CvNAMED(sv)
207         ? ((XPVCV*)MUTABLE_PTR(SvANY(sv)))->xcv_gv_u.xcv_hek
208         : 0;
209 }
210 /* This lowers the refernce count of the previous value, but does *not*
211    increment the reference count of the new value. */
212 #define CvNAME_HEK_set(cv, hek) ( \
213         CvNAME_HEK((CV *)(cv))                                           \
214             ? unshare_hek(SvANY((CV *)(cv))->xcv_gv_u.xcv_hek)    \
215             : (void)0,                                             \
216         ((XPVCV*)MUTABLE_PTR(SvANY(cv)))->xcv_gv_u.xcv_hek = (hek), \
217         CvNAMED_on(cv)                                               \
218     )
219
220 /*
221 =head1 CV reference counts and CvOUTSIDE
222
223 =for apidoc m|bool|CvWEAKOUTSIDE|CV *cv
224
225 Each CV has a pointer, C<CvOUTSIDE()>, to its lexically enclosing
226 CV (if any).  Because pointers to anonymous sub prototypes are
227 stored in C<&> pad slots, it is a possible to get a circular reference,
228 with the parent pointing to the child and vice-versa.  To avoid the
229 ensuing memory leak, we do not increment the reference count of the CV
230 pointed to by C<CvOUTSIDE> in the I<one specific instance> that the parent
231 has a C<&> pad slot pointing back to us.  In this case, we set the
232 C<CvWEAKOUTSIDE> flag in the child.  This allows us to determine under what
233 circumstances we should decrement the refcount of the parent when freeing
234 the child.
235
236 There is a further complication with non-closure anonymous subs (i.e. those
237 that do not refer to any lexicals outside that sub).  In this case, the
238 anonymous prototype is shared rather than being cloned.  This has the
239 consequence that the parent may be freed while there are still active
240 children, eg
241
242     BEGIN { $a = sub { eval '$x' } }
243
244 In this case, the BEGIN is freed immediately after execution since there
245 are no active references to it: the anon sub prototype has
246 C<CvWEAKOUTSIDE> set since it's not a closure, and $a points to the same
247 CV, so it doesn't contribute to BEGIN's refcount either.  When $a is
248 executed, the C<eval '$x'> causes the chain of C<CvOUTSIDE>s to be followed,
249 and the freed BEGIN is accessed.
250
251 To avoid this, whenever a CV and its associated pad is freed, any
252 C<&> entries in the pad are explicitly removed from the pad, and if the
253 refcount of the pointed-to anon sub is still positive, then that
254 child's C<CvOUTSIDE> is set to point to its grandparent.  This will only
255 occur in the single specific case of a non-closure anon prototype
256 having one or more active references (such as C<$a> above).
257
258 One other thing to consider is that a CV may be merely undefined
259 rather than freed, eg C<undef &foo>.  In this case, its refcount may
260 not have reached zero, but we still delete its pad and its C<CvROOT> etc.
261 Since various children may still have their C<CvOUTSIDE> pointing at this
262 undefined CV, we keep its own C<CvOUTSIDE> for the time being, so that
263 the chain of lexical scopes is unbroken.  For example, the following
264 should print 123:
265
266     my $x = 123;
267     sub tmp { sub { eval '$x' } }
268     my $a = tmp();
269     undef &tmp;
270     print  $a->();
271
272 =cut
273 */
274
275 typedef OP *(*Perl_call_checker)(pTHX_ OP *, GV *, SV *);
276
277 /*
278  * Local variables:
279  * c-indentation-style: bsd
280  * c-basic-offset: 4
281  * indent-tabs-mode: nil
282  * End:
283  *
284  * ex: set ts=8 sts=4 sw=4 et:
285  */