| 1 | package Devel::FindRef; |
1 | package Devel::FindRef; |
| 2 | |
2 | |
| 3 | use strict; |
3 | use common::sense; |
| 4 | |
4 | |
| 5 | use XSLoader; |
5 | use XSLoader; |
| 6 | |
6 | use Scalar::Util; |
| 7 | |
7 | |
| 8 | BEGIN { |
8 | BEGIN { |
| 9 | our $VERSION = '0.2'; |
9 | our $VERSION = '1.422'; |
| 10 | XSLoader::load __PACKAGE__, $VERSION; |
10 | XSLoader::load __PACKAGE__, $VERSION; |
| 11 | } |
11 | } |
| 12 | |
12 | |
| 13 | =head1 NAME |
13 | =head1 NAME |
| 14 | |
14 | |
| 15 | Devel::FindRef - where is that reference to my scalar hiding? |
15 | Devel::FindRef - where is that reference to my variable hiding? |
| 16 | |
16 | |
| 17 | =head1 SYNOPSIS |
17 | =head1 SYNOPSIS |
| 18 | |
18 | |
| 19 | use Devel::FindRef; |
19 | use Devel::FindRef; |
|
|
20 | |
|
|
21 | print Devel::FindRef::track \$some_variable; |
| 20 | |
22 | |
| 21 | =head1 DESCRIPTION |
23 | =head1 DESCRIPTION |
| 22 | |
24 | |
| 23 | Tracking down reference problems (e.g. you expect some object to be |
25 | Tracking down reference problems (e.g. you expect some object to be |
| 24 | destroyed, but there are still references to it that keep it alive) can be |
26 | destroyed, but there are still references to it that keep it alive) can be |
| … | |
… | |
| 29 | the variables containing them. |
31 | the variables containing them. |
| 30 | |
32 | |
| 31 | For example, for this fragment: |
33 | For example, for this fragment: |
| 32 | |
34 | |
| 33 | package Test; |
35 | package Test; |
|
|
36 | |
|
|
37 | use Devel::FindRef; |
|
|
38 | use Scalar::Util; |
| 34 | |
39 | |
| 35 | our $var = "hi\n"; |
40 | our $var = "hi\n"; |
| 36 | my $x = \$var; |
41 | my $global_my = \$var; |
| 37 | our %hash = (ukukey => \$var); |
42 | our %global_hash = (ukukey => \$var); |
| 38 | our $hash2 = {ukukey2 => \$var}; |
43 | our $global_hashref = { ukukey2 => \$var }; |
| 39 | |
44 | |
| 40 | sub testsub { |
45 | sub testsub { |
| 41 | my $local = $hash2; |
46 | my $testsub_local = $global_hashref; |
| 42 | print Devel::FindRef::track \$var; |
47 | print Devel::FindRef::track \$var; |
| 43 | } |
48 | } |
| 44 | |
49 | |
| 45 | testsub; |
50 | |
|
|
51 | my $closure = sub { |
|
|
52 | my $closure_var = \$_[0]; |
|
|
53 | Scalar::Util::weaken (my $weak_ref = \$var); |
|
|
54 | testsub; |
|
|
55 | }; |
|
|
56 | |
|
|
57 | $closure->($var); |
| 46 | |
58 | |
| 47 | The output is as follows (or similar to this, in case I forget to update |
59 | The output is as follows (or similar to this, in case I forget to update |
| 48 | the manpage after some changes): |
60 | the manpage after some changes): |
| 49 | |
61 | |
| 50 | SCALAR(0x676fa0) is |
62 | SCALAR(0x7cc888) [refcount 6] is |
| 51 | referenced by REF(0x676fb0), which is |
63 | +- referenced by REF(0x8abcc8) [refcount 1], which is |
| 52 | in the lexical '$x' in CODE(0x676370), which is |
64 | | the lexical '$closure_var' in CODE(0x8abc50) [refcount 4], which is |
| 53 | not found anywhere I looked :( |
65 | | +- the closure created at tst:18. |
| 54 | referenced by REF(0x676360), which is |
66 | | +- referenced by REF(0x7d3c58) [refcount 1], which is |
| 55 | in the member 'ukukey' of HASH(0x756660), which is |
67 | | | the lexical '$closure' in CODE(0x7ae530) [refcount 2], which is |
| 56 | in the global %Test::hash. |
68 | | | +- the containing scope for CODE(0x8ab430) [refcount 3], which is |
|
|
69 | | | | the global &Test::testsub. |
|
|
70 | | | +- the main body of the program. |
|
|
71 | | +- the lexical '&' in CODE(0x7ae530) [refcount 2], which was seen before. |
|
|
72 | +- referenced by REF(0x7cc7c8) [refcount 1], which is |
|
|
73 | | the lexical '$global_my' in CODE(0x7ae530) [refcount 2], which was seen before. |
| 57 | in the global $Test::var. |
74 | +- the global $Test::var. |
|
|
75 | +- referenced by REF(0x7cc558) [refcount 1], which is |
|
|
76 | | the member 'ukukey2' of HASH(0x7ae140) [refcount 2], which is |
|
|
77 | | +- referenced by REF(0x8abad0) [refcount 1], which is |
|
|
78 | | | the lexical '$testsub_local' in CODE(0x8ab430) [refcount 3], which was seen before. |
|
|
79 | | +- referenced by REF(0x8ab4f0) [refcount 1], which is |
|
|
80 | | the global $Test::global_hashref. |
|
|
81 | +- referenced by REF(0x7ae518) [refcount 1], which is |
|
|
82 | | the member 'ukukey' of HASH(0x7d3bb0) [refcount 1], which is |
|
|
83 | | the global %Test::global_hash. |
| 58 | referenced by REF(0x6760e0), which is |
84 | +- referenced by REF(0x7ae2f0) [refcount 1], which is |
| 59 | in the member 'ukukey2' of HASH(0x676f30), which is |
85 | a temporary on the stack. |
| 60 | referenced by REF(0x77bcf0), which is |
|
|
| 61 | in the lexical '$local' in CODE(0x77bcb0), which is |
|
|
| 62 | in the global &Test::testsub. |
|
|
| 63 | referenced by REF(0x77bc80), which is |
|
|
| 64 | in the global $Test::hash2. |
|
|
| 65 | |
|
|
| 66 | |
86 | |
| 67 | It is a bit convoluted to read, but basically it says that the value |
87 | It is a bit convoluted to read, but basically it says that the value |
| 68 | stored in C<$var> can be found: |
88 | stored in C<$var> is referenced by: |
| 69 | |
89 | |
| 70 | =over 4 |
90 | =over 4 |
| 71 | |
91 | |
| 72 | =item - in some variable C<$x> whose origin is not known (I frankly have no |
92 | =item - the lexical C<$closure_var> (0x8abcc8), which is inside an instantiated |
| 73 | idea why, hints accepted). |
93 | closure, which in turn is used quite a bit. |
| 74 | |
94 | |
| 75 | =item - in the hash element with key C<ukukey> in the hash stored in C<%Test::hash>. |
95 | =item - the package-level lexical C<$global_my>. |
| 76 | |
96 | |
| 77 | =item - in the global variable named C<$Test::var>. |
97 | =item - the global package variable named C<$Test::var>. |
| 78 | |
98 | |
| 79 | =item - in the hash element C<ukukey2>, in the hash in the my variable |
99 | =item - the hash element C<ukukey2>, in the hash in the my variable |
| 80 | C<$local> in the sub C<Test::testsub> and also in the hash referenced by |
100 | C<$testsub_local> in the sub C<Test::testsub> and also in the hash |
|
|
101 | C<$referenced by Test::hash2>. |
|
|
102 | |
|
|
103 | =item - the hash element with key C<ukukey> in the hash stored in |
| 81 | C<$Test::hash2>. |
104 | C<%Test::hash>. |
|
|
105 | |
|
|
106 | =item - some anonymous mortalised reference on the stack (which is caused |
|
|
107 | by calling C<track> with the expression C<\$var>, which creates the |
|
|
108 | reference). |
|
|
109 | |
|
|
110 | =back |
|
|
111 | |
|
|
112 | And all these account for six reference counts. |
|
|
113 | |
| 82 | |
114 | |
| 83 | =head1 EXPORTS |
115 | =head1 EXPORTS |
| 84 | |
116 | |
| 85 | None. |
117 | None. |
| 86 | |
118 | |
| … | |
… | |
| 98 | |
130 | |
| 99 | =cut |
131 | =cut |
| 100 | |
132 | |
| 101 | sub find($); |
133 | sub find($); |
| 102 | |
134 | |
|
|
135 | sub _f($) { |
|
|
136 | "$_[0] [refcount " . (_refcnt $_[0]) . "]" |
|
|
137 | } |
|
|
138 | |
| 103 | sub track { |
139 | sub track { |
|
|
140 | my ($ref, $depth) = @_; |
|
|
141 | @_ = (); |
|
|
142 | |
| 104 | my $buf = ""; |
143 | my $buf = ""; |
|
|
144 | my %seen; |
|
|
145 | |
|
|
146 | Scalar::Util::weaken $ref; |
| 105 | |
147 | |
| 106 | my $track; $track = sub { |
148 | my $track; $track = sub { |
| 107 | my (undef, $depth, $indent) = @_; |
149 | my ($refref, $depth, $indent) = @_; |
| 108 | |
150 | |
| 109 | if ($depth) { |
151 | if ($depth) { |
| 110 | my (@about) = find $_[0]; |
152 | my (@about) = find $$refref; |
| 111 | if (@about) { |
153 | if (@about) { |
| 112 | for my $about (@about) { |
154 | for my $about (@about) { |
| 113 | $buf .= (" ") x $indent; |
155 | $about->[0] =~ s/([^\x20-\x7e])/sprintf "\\{%02x}", ord $1/ge; |
| 114 | $buf .= $about->[0]; |
156 | $buf .= "$indent" . (@about > 1 ? "+- " : "") . $about->[0]; |
| 115 | if (@$about > 1) { |
157 | if (@$about > 1) { |
|
|
158 | if ($seen{ref2ptr $about->[1]}++) { |
|
|
159 | $buf .= " " . (_f $about->[1]) . ", which was seen before.\n"; |
|
|
160 | } else { |
| 116 | $buf .= " $about->[1], which is\n"; |
161 | $buf .= " " . (_f $about->[1]) . ", which is\n"; |
| 117 | $track->($about->[1], $depth - 1, $indent + 1); |
162 | $track->(\$about->[1], $depth - 1, $about == $about[-1] ? "$indent " : "$indent| "); |
|
|
163 | } |
| 118 | } else { |
164 | } else { |
| 119 | $buf .= ".\n"; |
165 | $buf .= ".\n"; |
| 120 | } |
166 | } |
| 121 | } |
167 | } |
| 122 | } else { |
168 | } else { |
| 123 | $buf .= (" ") x $indent; |
|
|
| 124 | $buf .= "not found anywhere I looked :(\n"; |
169 | $buf .= "$indent not found anywhere I looked :(\n"; |
| 125 | } |
170 | } |
| 126 | } else { |
171 | } else { |
| 127 | $buf .= (" ") x $indent; |
|
|
| 128 | $buf .= "not referenced within the search depth.\n"; |
172 | $buf .= "$indent not referenced within the search depth.\n"; |
| 129 | } |
173 | } |
| 130 | }; |
174 | }; |
| 131 | |
175 | |
| 132 | $buf .= "$_[0] is\n"; |
176 | $buf .= (_f $ref) . " is\n"; |
| 133 | $track->($_[0], $_[1] || 10, 1); |
177 | |
|
|
178 | $track->(\$ref, $depth || $ENV{PERL_DEVEL_FINDREF_DEPTH} || 10, ""); |
| 134 | $buf |
179 | $buf |
| 135 | } |
180 | } |
| 136 | |
181 | |
| 137 | =item @references = Devel::FindRef::find $ref |
182 | =item @references = Devel::FindRef::find $ref |
| 138 | |
183 | |
| 139 | Return arrayrefs that contain [$message, $ref] pairs. The message |
184 | Return arrayrefs that contain [$message, $ref] pairs. The message |
| 140 | describes what kind of reference was found and the C<$ref> is the |
185 | describes what kind of reference was found and the C<$ref> is the |
| 141 | reference itself, which cna be omitted if C<find> decided to end the |
186 | reference itself, which can be omitted if C<find> decided to end the |
| 142 | search. |
187 | search. The returned references are all weak references. |
| 143 | |
188 | |
| 144 | The C<track> function uses this to find references to the value you are |
189 | The C<track> function uses this to find references to the value you are |
| 145 | interested in and recurses on the returned references. |
190 | interested in and recurses on the returned references. |
| 146 | |
191 | |
| 147 | =cut |
192 | =cut |
| 148 | |
193 | |
| 149 | sub find($) { |
194 | sub find($) { |
| 150 | my ($about, $excl) = &find_; |
195 | my ($about, $excl) = &find_; |
| 151 | my %excl = map +($_ => 1), @$excl; |
196 | my %excl = map +($_ => undef), @$excl; |
| 152 | grep !$excl{$_->[1] + 0}, @$about |
197 | grep !($#$_ && exists $excl{ref2ptr $_->[1]}), @$about |
| 153 | } |
198 | } |
| 154 | |
199 | |
| 155 | =item $ref = Devel::FindRef::ref2ptr $ptr |
200 | =item $ref = Devel::FindRef::ptr2ref $integer |
| 156 | |
201 | |
| 157 | Sometimes you know (from debugging output) the address of a perl scalar |
202 | Sometimes you know (from debugging output) the address of a perl scalar |
| 158 | you are interested in. This function can be used to turn the address into |
203 | you are interested in (e.g. C<HASH(0x176ff70)>). This function can be used |
| 159 | a reference to that scalar. It is quite safe to call on valid addresses, |
204 | to turn the address into a reference to that scalar. It is quite safe to |
| 160 | but extremely dangerous to call on invalid ones. |
205 | call on valid addresses, but extremely dangerous to call on invalid ones. |
|
|
206 | |
|
|
207 | # we know that HASH(0x176ff70) exists, so turn it into a hashref: |
|
|
208 | my $ref_to_hash = Devel::FindRef::ptr2ref 0x176ff70; |
|
|
209 | |
|
|
210 | =item $ptr = Devel::FindRef::ref2ptr $reference |
|
|
211 | |
|
|
212 | The opposite of C<ptr2ref>, above: returns the internal address of the |
|
|
213 | value pointed to by the passed reference. I<No checks whatsoever will be |
|
|
214 | done>, so don't use this. |
| 161 | |
215 | |
| 162 | =back |
216 | =back |
| 163 | |
217 | |
|
|
218 | =head1 ENVIRONMENT VARIABLES |
|
|
219 | |
|
|
220 | You can set the environment variable C<PERL_DEVEL_FINDREF_DEPTH> to an |
|
|
221 | integer to override the default depth in C<track>. If a call explicitly |
|
|
222 | specified a depth it is not overridden. |
|
|
223 | |
| 164 | =head1 AUTHOR |
224 | =head1 AUTHOR |
| 165 | |
225 | |
| 166 | Marc Lehmann <pcg@goof.com>. |
226 | Marc Lehmann <pcg@goof.com>. |
| 167 | |
227 | |
| 168 | =head1 BUGS |
|
|
| 169 | |
|
|
| 170 | Only code values, arrays, hashes, scalars and magic are being looked at. |
|
|
| 171 | |
|
|
| 172 | This is a quick hack only. |
|
|
| 173 | |
|
|
| 174 | =head1 COPYRIGHT AND LICENSE |
228 | =head1 COPYRIGHT AND LICENSE |
| 175 | |
229 | |
| 176 | Copyright (C) 2007 by Marc Lehmann. |
230 | Copyright (C) 2007, 2008 by Marc Lehmann. |
| 177 | |
231 | |
| 178 | This library is free software; you can redistribute it and/or modify |
232 | This library is free software; you can redistribute it and/or modify |
| 179 | it under the same terms as Perl itself, either Perl version 5.8.8 or, |
233 | it under the same terms as Perl itself, either Perl version 5.8.8 or, |
| 180 | at your option, any later version of Perl 5 you may have available. |
234 | at your option, any later version of Perl 5 you may have available. |
| 181 | |
235 | |
