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