1 package DBICTest::Util::LeakTracer;
7 use Scalar::Util qw(isweak weaken blessed reftype);
8 use DBIx::Class::_Util qw(refcount hrefaddr);
9 use DBIx::Class::Optional::Dependencies;
10 use Data::Dumper::Concise;
11 use DBICTest::Util 'stacktrace';
13 CV_TRACING => DBIx::Class::Optional::Dependencies->req_ok_for ('test_leaks_heavy'),
17 our @EXPORT_OK = qw(populate_weakregistry assert_empty_weakregistry visit_refs);
23 # so we don't trigger stringification
26 (defined blessed $_[0]) ? blessed($_[0]) . '=' : '',
32 sub populate_weakregistry {
33 my ($weak_registry, $target, $note) = @_;
35 croak 'Expecting a registry hashref' unless ref $weak_registry eq 'HASH';
36 croak 'Target is not a reference' unless length ref $target;
38 my $refaddr = hrefaddr $target;
40 # a registry could be fed to itself or another registry via recursive sweeps
41 return $target if $reg_of_regs{$refaddr};
43 weaken( $reg_of_regs{ hrefaddr($weak_registry) } = $weak_registry )
44 unless( $reg_of_regs{ hrefaddr($weak_registry) } );
46 # an explicit "garbage collection" pass every time we store a ref
47 # if we do not do this the registry will keep growing appearing
48 # as if the traced program is continuously slowly leaking memory
49 for my $reg (values %reg_of_regs) {
50 (defined $reg->{$_}{weakref}) or delete $reg->{$_}
54 if (! defined $weak_registry->{$refaddr}{weakref}) {
55 $weak_registry->{$refaddr} = {
56 stacktrace => stacktrace(1),
59 weaken( $weak_registry->{$refaddr}{weakref} );
63 my $desc = _describe_ref($target);
64 $weak_registry->{$refaddr}{slot_names}{$desc} = 1;
66 $note =~ s/\s*\Q$desc\E\s*//g;
67 $weak_registry->{$refaddr}{slot_names}{$note} = 1;
73 # Regenerate the slots names on a thread spawn
75 my @individual_regs = grep { scalar keys %{$_||{}} } values %reg_of_regs;
78 for my $reg (@individual_regs) {
79 my @live_slots = grep { defined $_->{weakref} } values %$reg
82 $reg = {}; # get a fresh hashref in the new thread ctx
83 weaken( $reg_of_regs{hrefaddr($reg)} = $reg );
85 for my $slot_info (@live_slots) {
86 my $new_addr = hrefaddr $slot_info->{weakref};
88 # replace all slot names
89 $slot_info->{slot_names} = { map {
91 $name =~ s/\(0x[0-9A-F]+\)/sprintf ('(%s)', $new_addr)/ieg;
93 } keys %{$slot_info->{slot_names}} };
95 $reg->{$new_addr} = $slot_info;
101 my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
103 $args->{seen_refs} ||= {};
105 my $visited_cnt = '0E0';
106 for my $i (0 .. $#{$args->{refs}} ) {
108 next unless length ref $args->{refs}[$i]; # not-a-ref
110 my $addr = hrefaddr $args->{refs}[$i];
112 # no diving into weakregistries
113 next if $reg_of_regs{$addr};
115 next if $args->{seen_refs}{$addr}++;
118 my $r = $args->{refs}[$i];
120 $args->{action}->($r) or next;
122 # This may end up being necessarry some day, but do not slow things
124 #if ( defined( my $t = tied($r) ) ) {
125 # $visited_cnt += visit_refs({ %$args, refs => [ $t ] });
128 my $type = reftype $r;
132 if ($type eq 'HASH') {
133 $visited_cnt += visit_refs({ %$args, refs => [ map {
134 ( !isweak($r->{$_}) ) ? $r->{$_} : ()
137 elsif ($type eq 'ARRAY') {
138 $visited_cnt += visit_refs({ %$args, refs => [ map {
139 ( !isweak($r->[$_]) ) ? $r->[$_] : ()
142 elsif ($type eq 'REF' and !isweak($$r)) {
143 $visited_cnt += visit_refs({ %$args, refs => [ $$r ] });
145 elsif (CV_TRACING and $type eq 'CODE') {
146 $visited_cnt += visit_refs({ %$args, refs => [ map {
147 ( !isweak($_) ) ? $_ : ()
148 } values %{ scalar PadWalker::closed_over($r) } ] }); # scalar due to RT#92269
151 } or warn "Could not descend into @{[ _describe_ref($r) ]}: $@\n";
156 sub visit_namespaces {
157 my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
161 $args->{package} ||= '::';
162 $args->{package} = '::' if $args->{package} eq 'main';
164 if ( $args->{action}->($args->{package}) ) {
166 my $base = $args->{package};
167 $base = '' if $base eq '::';
170 $visited += visit_namespaces({ %$args, package => $_ }) for map
171 { $_ =~ /(.+?)::$/ && "${base}::$1" }
173 { $_ =~ /(?<!^main)::$/ }
174 do { no strict 'refs'; keys %{ $base . '::'} }
180 # compiles a list of addresses stored as globals (possibly even catching
181 # class data in the form of method closures), so we can skip them further on
182 sub symtable_referenced_addresses {
193 $pkg = '' if $pkg eq '::';
196 # the unless regex at the end skips some dangerous namespaces outright
197 # (but does not prevent descent)
198 $refs_per_pkg->{$pkg} += visit_refs (
199 seen_refs => $seen_refs,
203 refs => [ map { my $sym = $_;
204 # *{"$pkg$sym"}{CODE} won't simply work - MRO-cached CVs are invisible there
205 ( CV_TRACING ? Class::MethodCache::get_cv("${pkg}$sym") : () ),
207 ( defined *{"$pkg$sym"}{SCALAR} and length ref ${"$pkg$sym"} and ! isweak( ${"$pkg$sym"} ) )
212 ( defined *{"$pkg$sym"}{$_} and ! isweak(defined *{"$pkg$sym"}{$_}) )
215 } qw(HASH ARRAY IO GLOB) ),
218 ) unless $pkg =~ /^ :: (?:
219 DB | next | B | .+? ::::ISA (?: ::CACHE ) | Class::C3
226 # { { $_ => $refs_per_pkg->{$_} } }
228 # {$refs_per_pkg->{$a} <=> $refs_per_pkg->{$b} }
229 # keys %$refs_per_pkg
235 sub assert_empty_weakregistry {
236 my ($weak_registry, $quiet) = @_;
238 # in case we hooked bless any extra object creation will wreak
239 # havoc during the assert phase
240 local *CORE::GLOBAL::bless;
241 *CORE::GLOBAL::bless = sub { CORE::bless( $_[0], (@_ > 1) ? $_[1] : caller() ) };
243 croak 'Expecting a registry hashref' unless ref $weak_registry eq 'HASH';
245 defined $weak_registry->{$_}{weakref} or delete $weak_registry->{$_}
246 for keys %$weak_registry;
248 return unless keys %$weak_registry;
250 my $tb = eval { Test::Builder->new }
251 or croak "Calling assert_empty_weakregistry in $0 without a loaded Test::Builder makes no sense";
253 for my $addr (keys %$weak_registry) {
254 $weak_registry->{$addr}{display_name} = join ' | ', (
256 { length $a <=> length $b or $a cmp $b }
257 keys %{$weak_registry->{$addr}{slot_names}}
260 $tb->BAILOUT("!!!! WEAK REGISTRY SLOT $weak_registry->{$addr}{display_name} IS NOT A WEAKREF !!!!")
261 if defined $weak_registry->{$addr}{weakref} and ! isweak( $weak_registry->{$addr}{weakref} );
264 # the walk is very expensive - if we are $quiet (running in an END block)
265 # we do not really need to be too thorough
267 delete $weak_registry->{$_} for keys %{ symtable_referenced_addresses() };
271 for my $addr (sort { $weak_registry->{$a}{display_name} cmp $weak_registry->{$b}{display_name} } keys %$weak_registry) {
273 next if ! defined $weak_registry->{$addr}{weakref};
275 $leaks_found++ unless $tb->in_todo;
276 $tb->ok (0, "Leaked $weak_registry->{$addr}{display_name}");
279 local $Data::Dumper::Maxdepth = 1;
280 sprintf "\n%s (refcnt %d) => %s\n",
281 $weak_registry->{$addr}{display_name},
282 refcount($weak_registry->{$addr}{weakref}),
284 ref($weak_registry->{$addr}{weakref}) eq 'CODE'
286 B::svref_2object($weak_registry->{$addr}{weakref})->XSUB
287 ) ? '__XSUB__' : Dumper( $weak_registry->{$addr}{weakref} )
291 # FIXME - need to add a circular reference seeker based on the visitor
292 # (will need a bunch of modifications, punting with just a stub for now)
294 $diag .= Devel::FindRef::track ($weak_registry->{$addr}{weakref}, 50) . "\n"
295 if ( $ENV{TEST_VERBOSE} && eval { require Devel::FindRef });
299 if (my $stack = $weak_registry->{$addr}{stacktrace}) {
300 $diag .= " Reference first seen$stack";
305 # if ($leaks_found == 1) {
306 # # using the fh dumper due to intermittent buffering issues
307 # # in case we decide to exit soon after (possibly via _exit)
308 # require Devel::MAT::Dumper;
309 # local $Devel::MAT::Dumper::MAX_STRING = -1;
310 # open( my $fh, '>:raw', "leaked_${addr}_pid$$.pmat" ) or die $!;
311 # Devel::MAT::Dumper::dumpfh( $fh );
312 # close ($fh) or die $!;
319 if (! $quiet and !$leaks_found and ! $tb->in_todo) {
320 $tb->ok(1, sprintf "No leaks found at %s line %d", (caller())[1,2] );
325 if ($INC{'Test/Builder.pm'}) {
326 my $tb = Test::Builder->new;
328 # we check for test passage - a leak may be a part of a TODO
329 if ($leaks_found and !$tb->is_passing) {
332 "\n\n%s\n%s\n\nInstall Devel::FindRef and re-run the test with set "
333 . '$ENV{TEST_VERBOSE} (prove -v) to see a more detailed leak-report'
334 . "\n\n%s\n%s\n\n", ('#' x 16) x 4
335 ) if ( !$ENV{TEST_VERBOSE} or !$INC{'Devel/FindRef.pm'} );
339 $tb->note("Auto checked $refs_traced references for leaks - none detected");