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