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.11 by root, Fri Jul 11 17:59:19 2008 UTC vs.
Revision 1.22 by root, Thu Apr 28 06:39:42 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines