1 |
NAME |
2 |
Devel::FindRef - where is that reference to my variable hiding? |
3 |
|
4 |
SYNOPSIS |
5 |
use Devel::FindRef; |
6 |
|
7 |
DESCRIPTION |
8 |
Tracking down reference problems (e.g. you expect some object to be |
9 |
destroyed, but there are still references to it that keep it alive) can |
10 |
be very hard. Fortunately, perl keeps track of all its values, so |
11 |
tracking references "backwards" is usually possible. |
12 |
|
13 |
The "track" function can help track down some of those references back |
14 |
to the variables containing them. |
15 |
|
16 |
For example, for this fragment: |
17 |
|
18 |
package Test; |
19 |
|
20 |
our $var = "hi\n"; |
21 |
my $x = \$var; |
22 |
our %hash = (ukukey => \$var); |
23 |
our $hash2 = {ukukey2 => \$var}; |
24 |
|
25 |
sub testsub { |
26 |
my $local = $hash2; |
27 |
print Devel::FindRef::track \$var; |
28 |
} |
29 |
|
30 |
testsub; |
31 |
|
32 |
The output is as follows (or similar to this, in case I forget to update |
33 |
the manpage after some changes): |
34 |
|
35 |
SCALAR(0x814ece8) is |
36 |
+- in the global $Test::var. |
37 |
+- referenced by REF(0x814f9e4), which is |
38 |
| in the lexical '$x' in CODE(0x814ed78), which is |
39 |
| the containing scope for CODE(0x820c4b0), which is |
40 |
| in the global &Test::testsub. |
41 |
+- referenced by REF(0x814ed6c), which is |
42 |
| in the member 'ukukey' of HASH(0x81da20c), which is |
43 |
| in the global %Test::hash. |
44 |
+- referenced by REF(0x814ec28), which is |
45 |
| not found anywhere I looked :( |
46 |
+- referenced by REF(0x814eb44), which is |
47 |
in the member 'ukukey2' of HASH(0x814f99c), which is |
48 |
+- referenced by REF(0x820c450), which is |
49 |
| in the lexical '$local' in CODE(0x820c4b0), which was seen before. |
50 |
+- referenced by REF(0x820c204), which is |
51 |
in the global $Test::hash2. |
52 |
|
53 |
It is a bit convoluted to read, but basically it says that the value |
54 |
stored in $var can be found: |
55 |
|
56 |
- in some variable $x whose origin is not known (I frankly have no idea |
57 |
why, hints accepted). |
58 |
- in the hash element with key "ukukey" in the hash stored in |
59 |
%Test::hash. |
60 |
- in the global variable named $Test::var. |
61 |
- in the hash element "ukukey2", in the hash in the my variable $local |
62 |
in the sub "Test::testsub" and also in the hash referenced by |
63 |
$Test::hash2. |
64 |
|
65 |
EXPORTS |
66 |
None. |
67 |
|
68 |
FUNCTIONS |
69 |
$string = Devel::FindRef::track $ref[, $depth] |
70 |
Track the perl value pointed to by $ref up to a depth of $depth and |
71 |
return a descriptive string. $ref can point at any perl value, be it |
72 |
anonymous sub, hash, array, scalar etc. |
73 |
|
74 |
This is the function you most often use. |
75 |
|
76 |
@references = Devel::FindRef::find $ref |
77 |
Return arrayrefs that contain [$message, $ref] pairs. The message |
78 |
describes what kind of reference was found and the $ref is the |
79 |
reference itself, which can be omitted if "find" decided to end the |
80 |
search. The returned references are all weak references. |
81 |
|
82 |
The "track" function uses this to find references to the value you |
83 |
are interested in and recurses on the returned references. |
84 |
|
85 |
$ref = Devel::FindRef::ptr2ref $integer |
86 |
Sometimes you know (from debugging output) the address of a perl |
87 |
scalar you are interested in (e.g. "HASH(0x176ff70)"). This function |
88 |
can be used to turn the address into a reference to that scalar. It |
89 |
is quite safe to call on valid addresses, but extremely dangerous to |
90 |
call on invalid ones. |
91 |
|
92 |
# we know that HASH(0x176ff70) exists, so turn it into a hashref: |
93 |
my $ref_to_hash = Devel::FindRef::ptr2ref 0x176ff70; |
94 |
|
95 |
$ref = Devel::FindRef::ref2ptr $reference |
96 |
The opposite of "ptr2ref", above: returns the internal address of |
97 |
the value pointed to by the passed reference. *No checks whatsoever |
98 |
will be done*, so don't use this. |
99 |
|
100 |
ENVIRONMENT VARIABLES |
101 |
You can set the environment variable "PERL_DEVEL_FINDREF_DEPTH" to an |
102 |
integer to override the default depth in "track". If a call explicitly |
103 |
specified a depth it is not overridden. |
104 |
|
105 |
AUTHOR |
106 |
Marc Lehmann <pcg@goof.com>. |
107 |
|
108 |
BUGS |
109 |
Only code values, arrays, hashes, scalars and magic are being looked at. |
110 |
|
111 |
This is a quick hack only. |
112 |
|
113 |
COPYRIGHT AND LICENSE |
114 |
Copyright (C) 2007 by Marc Lehmann. |
115 |
|
116 |
This library is free software; you can redistribute it and/or modify it |
117 |
under the same terms as Perl itself, either Perl version 5.8.8 or, at |
118 |
your option, any later version of Perl 5 you may have available. |
119 |
|