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