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