ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/Devel-FindRef/FindRef.xs
(Generate patch)

Comparing Devel-FindRef/FindRef.xs (file contents):
Revision 1.12 by root, Sat Jul 19 01:17:12 2008 UTC vs.
Revision 1.27 by root, Tue Jul 31 22:55:47 2018 UTC

… …
4 4
5#define PERL_VERSION_ATLEAST(a,b,c) \ 5#define PERL_VERSION_ATLEAST(a,b,c) \
6 (PERL_REVISION > (a) \ 6 (PERL_REVISION > (a) \
7 || (PERL_REVISION == (a) \ 7 || (PERL_REVISION == (a) \
8 && (PERL_VERSION > (b) \ 8 && (PERL_VERSION > (b) \
9 || (PERL_VERSION == (b) && PERLSUBVERSION >= (c))))) 9 || (PERL_VERSION == (b) && PERL_SUBVERSION >= (c)))))
10 10
11#if !PERL_VERSION_ATLEAST (5,8,9) 11#if !PERL_VERSION_ATLEAST (5,8,9)
12# define SVt_LAST 16 12# define SVt_LAST 16
13#endif 13#endif
14 14
15#if !PERL_VERSION_ATLEAST (5,10,0) 15#ifndef SvPAD_OUR
16# define SvPAD_OUR(dummy) 0 16# define SvPAD_OUR(dummy) 0
17#endif
18
19/* pre-5.10 perls always succeed, with 5.10, we have to check first apparently */
20#ifndef GvNAME_HEK
21# define GvNAME_HEK(sv) 1
22#endif
23
24#ifndef PadARRAY
25typedef AV PADNAMELIST;
26typedef SV PADNAME;
27# define PadnamePV(sv) SvPVX (sv)
28# define PadnameLEN(sv) SvCUR (sv)
29# define PadARRAY(pad) AvARRAY (pad)
30# define PadlistARRAY(pl) ((PAD **)AvARRAY (pl))
31#endif
32
33#ifndef PadMAX
34# define PadMAX(pad) AvFILLp (pad)
35#endif
36
37#ifndef padnamelist_fetch
38# define padnamelist_fetch(a,b) *av_fetch (a, b, FALSE)
39#endif
40
41#ifndef PadlistNAMES
42# define PadlistNAMES(padlist) *PadlistARRAY (padlist)
17#endif 43#endif
18 44
19#define res_pair(text) \ 45#define res_pair(text) \
20 do { \ 46 do { \
21 AV *av = newAV (); \ 47 AV *av = newAV (); \
… …
32 av_push (av, newSVpv (text, 0)); \ 58 av_push (av, newSVpv (text, 0)); \
33 av_push (about, newRV_noinc ((SV *)av)); \ 59 av_push (about, newRV_noinc ((SV *)av)); \
34 } while (0) 60 } while (0)
35 61
36#define res_gv(sigil) \ 62#define res_gv(sigil) \
37 res_text (form ("in the global %c%s::%.*s", sigil, \ 63 res_text (form ("the global %c%s::%.*s", sigil, \
38 HvNAME (GvSTASH (sv)), \ 64 HvNAME (GvSTASH (sv)), \
39 GvNAMELEN (sv), \ 65 GvNAME_HEK (sv) ? GvNAMELEN (sv) : 11, \
40 GvNAME (sv) ? GvNAME (sv) : "<anonymous>")) 66 GvNAME_HEK (sv) ? GvNAME (sv) : "<anonymous>"))
41 67
42MODULE = Devel::FindRef PACKAGE = Devel::FindRef 68MODULE = Devel::FindRef PACKAGE = Devel::FindRef
43 69
44PROTOTYPES: ENABLE 70PROTOTYPES: ENABLE
45 71
46SV *
47ptr2ref (UV ptr)
48 CODE:
49 RETVAL = newRV_inc (INT2PTR (SV *, ptr));
50 OUTPUT:
51 RETVAL
52
53UV
54ref2ptr (SV *rv)
55 CODE:
56 RETVAL = PTR2UV (SvRV (rv));
57 OUTPUT:
58 RETVAL
59
60void 72void
61find_ (SV *target) 73find_ (SV *target_ref)
62 PPCODE: 74 PPCODE:
63{ 75{
64 SV *arena, *targ; 76 SV *arena, *targ;
65 U32 rmagical; 77 U32 rmagical;
66 int i; 78 int i;
67 AV *about = newAV (); 79 AV *about = newAV ();
68 AV *excl = newAV (); 80 AV *excl = newAV ();
69 81
70 if (!SvROK (target)) 82 if (!SvROK (target_ref))
71 croak ("find expects a reference to a perl value"); 83 croak ("find expects a reference to a perl value");
72 84
73 targ = SvRV (target); 85 targ = SvRV (target_ref);
74 86
75 for (arena = PL_sv_arenaroot; arena; arena = SvANY (arena)) 87 if (SvIMMORTAL (targ))
76 { 88 {
77 UV idx = SvREFCNT (arena); 89 if (targ == &PL_sv_undef)
78 90 res_text ("the immortal 'undef' value");
79 /* Remember that the zeroth slot is used as the pointer onwards, so don't 91 else if (targ == &PL_sv_yes)
80 include it. */ 92 res_text ("the immortal 'yes' value");
81 while (--idx > 0) 93 else if (targ == &PL_sv_no)
94 res_text ("the immortal 'no' value");
95 else if (targ == &PL_sv_placeholder)
96 res_text ("the immortal placeholder value");
97 else
98 res_text ("some unknown immortal");
99 }
100 else
101 {
102 for (arena = PL_sv_arenaroot; arena; arena = SvANY (arena))
82 { 103 {
83 SV *sv = &arena [idx]; 104 UV idx = SvREFCNT (arena);
84 105
85 if (SvTYPE (sv) >= SVt_LAST) 106 /* Remember that the zeroth slot is used as the pointer onwards, so don't
86 continue; 107 include it. */
87 108 while (--idx > 0)
88 /* temporarily disable RMAGICAL, it can easily interfere with us */
89 if ((rmagical = SvRMAGICAL (sv)))
90 SvRMAGICAL_off (sv);
91
92 if (SvTYPE (sv) >= SVt_PVMG)
93 { 109 {
110 SV *sv = &arena [idx];
111
112 if (SvTYPE (sv) >= SVt_LAST)
113 continue;
114
115 /* temporarily disable RMAGICAL, it can easily interfere with us */
116 if ((rmagical = SvRMAGICAL (sv)))
117 SvRMAGICAL_off (sv);
118
94 if (SvTYPE (sv) == SVt_PVMG && SvPAD_OUR (sv)) 119 if (SvTYPE (sv) >= SVt_PVMG)
95 { 120 {
121#if !PERL_VERSION_ATLEAST (5,21,6)
122 if (SvTYPE (sv) == SVt_PVMG && SvPAD_OUR (sv))
123 {
96 /* I have no clue what this is */ 124 /* I have no clue what this is */
97 /* maybe some placeholder for our variables for eval? */ 125 /* maybe some placeholder for our variables for eval? */
98 /* it doesn't seem to reference anything, so we should be able to ignore it */ 126 /* it doesn't seem to reference anything, so we should be able to ignore it */
127 }
128 else
129#endif
130 if (SvMAGICAL (sv)) /* name-pads use SvMAGIC for other purposes */
131 {
132 MAGIC *mg = SvMAGIC (sv);
133
134 while (mg)
135 {
136 if (mg->mg_obj == targ && mg->mg_flags & MGf_REFCOUNTED)
137 res_pair (form ("referenced (in mg_obj) by '%c' type magic attached to", mg->mg_type));
138
139 if ((SV *)mg->mg_ptr == targ)
140 res_pair (form ("%sreferenced (in mg_ptr) by '%c' type magic attached to",
141 mg->mg_len == HEf_SVKEY ? "" : "possibly ",
142 mg->mg_type));
143
144 mg = mg->mg_moremagic;
145 }
146 }
147 }
148
149 if (SvROK (sv))
150 {
151 if (SvRV (sv) == targ && !SvWEAKREF (sv) && sv != target_ref)
152 res_pair ("referenced by");
99 } 153 }
100 else 154 else
155 switch (SvTYPE (sv))
101 { 156 {
102 MAGIC *mg = SvMAGIC (sv); 157 case SVt_PVAV:
158 if (AvREAL (sv))
159 for (i = AvFILLp (sv) + 1; i--; )
160 if (AvARRAY (sv)[i] == targ)
161 res_pair (form ("the array element %d of", i));
103 162
104 while (mg) 163 break;
164
165 case SVt_PVHV:
166 if (hv_iterinit ((HV *)sv))
167 {
168 HE *he;
169
170 while ((he = hv_iternext ((HV *)sv)))
171 if (HeVAL (he) == targ)
172 res_pair (form ("the hash member '%.*s' of", HeKLEN (he), HeKEY (he)));
173 }
174
175 break;
176
177 case SVt_PVCV:
105 { 178 {
106 if (mg->mg_obj == targ) 179 PADLIST *padlist = CvISXSUB (cv) ? 0 : CvPADLIST (sv);
107 res_pair (form ("referenced (in mg_obj) by '%c' type magic attached to", mg->mg_type));
108 180
109 if ((SV *)mg->mg_ptr == targ && mg->mg_flags & MGf_REFCOUNTED) 181 if (padlist)
110 res_pair (form ("referenced (in mg_ptr) by '%c' type magic attached to", mg->mg_type)); 182 {
183 int depth = CvDEPTH (sv);
111 184
112 mg = mg->mg_moremagic; 185 /* Anonymous subs have a padlist but zero depth */
186 /* some hacks switch CvANON off, so we just blindly assume a minimum of 1 */
187 if (!depth && !PERL_VERSION_ATLEAST (5,21,6))
188 depth = 1;
189
190 while (depth)
191 {
192 PAD *pad = PadlistARRAY (padlist)[depth];
193
194 av_push (excl, newSVuv (PTR2UV (pad))); /* exclude pads themselves from being found */
195
196 /* The 0th pad slot is @_ */
197 if (PadARRAY (pad)[0] == targ)
198 res_pair ("the argument array for");
199
200 for (i = PadMAX (pad) + 1; --i; )
201 if (PadARRAY (pad)[i] == targ)
202 {
203 /* Values from constant functions are stored in the pad without any name */
204 PADNAME *name = padnamelist_fetch (PadlistNAMES (padlist), i);
205
206 if (name && PadnamePV (name) && *PadnamePV (name))
207 res_pair (form ("the lexical '%s' in", PadnamePV (name)));
208 else
209 res_pair ("an unnamed lexical in");
210 }
211
212 --depth;
213 }
214 }
215
216 if (CvCONST (sv) && (SV*)CvXSUBANY (sv).any_ptr == targ)
217 res_pair ("the constant value of");
218
219 if (!CvWEAKOUTSIDE (sv) && (SV*)CvOUTSIDE (sv) == targ)
220 res_pair ("the containing scope for");
221
222 if (sv == targ && CvANON (sv))
223 if (CvSTART (sv)
224 && CvSTART (sv)->op_type == OP_NEXTSTATE
225 && CopLINE ((COP *)CvSTART (sv)))
226 res_text (form ("the closure created at %s:%d",
227 CopFILE ((COP *)CvSTART (sv)) ? CopFILE ((COP *)CvSTART (sv)) : "<unknown>",
228 CopLINE ((COP *)CvSTART (sv))));
229 else
230 res_text (form ("the closure created somewhere in file %s (PLEASE REPORT!)",
231 CvFILE (sv) ? CvFILE (sv) : "<unknown>"));
113 } 232 }
233
234 break;
235
236 case SVt_PVGV:
237 if (GvGP (sv))
238 {
239 if (GvSV (sv) == (SV *)targ) res_gv ('$');
240 if (GvAV (sv) == (AV *)targ) res_gv ('@');
241 if (GvHV (sv) == (HV *)targ) res_gv ('%');
242 if (GvCV (sv) == (CV *)targ) res_gv ('&');
243 }
244
245 break;
246
247 case SVt_PVLV:
248 if (LvTARG (sv) == targ)
249 {
250 if (LvTYPE (sv) == 'y')
251 {
252 MAGIC *mg = mg_find (sv, PERL_MAGIC_defelem);
253
254 if (mg && mg->mg_obj)
255 res_pair (form ("the target for the lvalue hash element '%.*s',",
256 (int)SvCUR (mg->mg_obj), SvPV_nolen (mg->mg_obj)));
257 else
258 res_pair (form ("the target for the lvalue array element #%d,", LvTARGOFF (sv)));
259 }
260 else
261 res_pair (form ("an lvalue reference target (type '%c', ofs %d, len %d),",
262 LvTYPE (sv), LvTARGOFF (sv), LvTARGLEN (sv)));
263 }
264
265 break;
114 } 266 }
267
268 if (rmagical)
269 SvRMAGICAL_on (sv);
115 } 270 }
116
117 if (SvROK (sv))
118 {
119 if (sv != target && SvRV (sv) == targ && !SvWEAKREF (sv))
120 res_pair ("referenced by");
121 }
122 else
123 switch (SvTYPE (sv))
124 {
125 case SVt_PVAV:
126 if (AvREAL (sv))
127 for (i = AvFILLp (sv) + 1; i--; )
128 if (AvARRAY (sv)[i] == targ)
129 res_pair (form ("in array element %d of", i));
130
131 break;
132
133 case SVt_PVHV:
134 if (hv_iterinit ((HV *)sv))
135 {
136 HE *he;
137
138 while ((he = hv_iternext ((HV *)sv)))
139 if (HeVAL (he) == targ)
140 res_pair (form ("in the member '%.*s' of", HeKLEN (he), HeKEY (he)));
141 }
142
143 break;
144
145 case SVt_PVCV:
146 {
147 int depth = CvDEPTH (sv);
148
149 /* Anonymous subs have a padlist but zero depth */
150 if (CvANON (sv) && !depth && CvPADLIST (sv))
151 depth = 1;
152
153 if (depth)
154 {
155 AV *padlist = CvPADLIST (sv);
156
157 while (depth)
158 {
159 AV *pad = (AV *)AvARRAY (padlist)[depth];
160
161 av_push (excl, newSVuv (PTR2UV (pad))); /* exclude pads themselves from being found */
162
163 for (i = AvFILLp (pad) + 1; i--; )
164 if (AvARRAY (pad)[i] == targ)
165 {
166 /* Values from constant functions are stored in the pad without any name */
167 SV *name_sv = AvARRAY (AvARRAY (padlist)[0])[i];
168
169 if (name_sv && SvPOK (name_sv))
170 res_pair (form ("in the lexical '%s' in", SvPVX (name_sv)));
171 else
172 res_pair ("in an unnamed lexical in");
173 }
174
175 --depth;
176 }
177 }
178
179 if (CvCONST (sv) && (SV*)CvXSUBANY (sv).any_ptr == targ)
180 res_pair ("the constant value of");
181
182 if (!CvWEAKOUTSIDE (sv) && (SV*)CvOUTSIDE (sv) == targ)
183 res_pair ("the containing scope for");
184
185 if (sv == targ && CvANON (sv))
186 if (CvSTART (sv)
187 && CvSTART (sv)->op_type == OP_NEXTSTATE
188 && CopLINE ((COP *)CvSTART (sv)))
189 res_text (form ("the closure created at %s:%d",
190 CopFILE ((COP *)CvSTART (sv)) ? CopFILE ((COP *)CvSTART (sv)) : "<unknown>",
191 CopLINE ((COP *)CvSTART (sv))));
192 else
193 res_text (form ("the closure created somewhere in file %s (PLEASE REPORT!)",
194 CvFILE (sv) ? CvFILE (sv) : "<unknown>"));
195 }
196
197 break;
198
199 case SVt_PVGV:
200 if (GvGP (sv))
201 {
202 if (GvSV (sv) == (SV *)targ) res_gv ('$');
203 if (GvAV (sv) == (AV *)targ) res_gv ('@');
204 if (GvHV (sv) == (HV *)targ) res_gv ('%');
205 if (GvCV (sv) == (CV *)targ) res_gv ('&');
206 }
207
208 break;
209 }
210
211 if (rmagical)
212 SvRMAGICAL_on (sv);
213 } 271 }
272
273 /* look at the mortalise stack of the current coroutine */
274 for (i = 0; i <= PL_tmps_ix; ++i)
275 if (PL_tmps_stack [i] == targ)
276 res_text ("a temporary on the stack");
277
278 if (targ == (SV*)PL_main_cv)
279 res_text ("the main body of the program");
214 } 280 }
215 281
216 EXTEND (SP, 2); 282 EXTEND (SP, 2);
217 PUSHs (sv_2mortal (newRV_noinc ((SV *)about))); 283 PUSHs (sv_2mortal (newRV_noinc ((SV *)about)));
218 PUSHs (sv_2mortal (newRV_noinc ((SV *)excl))); 284 PUSHs (sv_2mortal (newRV_noinc ((SV *)excl)));
219} 285}
220 286
287SV *
288ptr2ref (UV ptr)
289 CODE:
290 RETVAL = newRV_inc (INT2PTR (SV *, ptr));
291 OUTPUT:
292 RETVAL
293
294UV
295ref2ptr (SV *rv)
296 CODE:
297 if (!SvROK (rv))
298 croak ("argument to Devel::FindRef::ref2ptr must be a reference");
299 RETVAL = PTR2UV (SvRV (rv));
300 OUTPUT:
301 RETVAL
302
303U32
304_refcnt (SV *rv)
305 CODE:
306 if (!SvROK (rv))
307 croak ("argument to Devel::FindRef::_refcnt must be a reference");
308 RETVAL = SvREFCNT (SvRV (rv));
309 OUTPUT:
310 RETVAL

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines