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