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