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