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