1 package DBICTest::Util::LeakTracer;
7 use Scalar::Util qw(isweak weaken blessed reftype);
8 use DBIx::Class::_Util qw(refcount hrefaddr refdesc);
9 use DBIx::Class::Optional::Dependencies;
10 use Data::Dumper::Concise;
11 use DBICTest::Util qw( stacktrace visit_namespaces );
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 sub populate_weakregistry {
24 my ($weak_registry, $target, $note) = @_;
26 croak 'Expecting a registry hashref' unless ref $weak_registry eq 'HASH';
27 croak 'Target is not a reference' unless length ref $target;
29 my $refaddr = hrefaddr $target;
31 # a registry could be fed to itself or another registry via recursive sweeps
32 return $target if $reg_of_regs{$refaddr};
34 weaken( $reg_of_regs{ hrefaddr($weak_registry) } = $weak_registry )
35 unless( $reg_of_regs{ hrefaddr($weak_registry) } );
37 # an explicit "garbage collection" pass every time we store a ref
38 # if we do not do this the registry will keep growing appearing
39 # as if the traced program is continuously slowly leaking memory
40 for my $reg (values %reg_of_regs) {
41 (defined $reg->{$_}{weakref}) or delete $reg->{$_}
45 if (! defined $weak_registry->{$refaddr}{weakref}) {
46 $weak_registry->{$refaddr} = {
47 stacktrace => stacktrace(1),
50 weaken( $weak_registry->{$refaddr}{weakref} );
54 my $desc = refdesc $target;
55 $weak_registry->{$refaddr}{slot_names}{$desc} = 1;
57 $note =~ s/\s*\Q$desc\E\s*//g;
58 $weak_registry->{$refaddr}{slot_names}{$note} = 1;
64 # Regenerate the slots names on a thread spawn
66 my @individual_regs = grep { scalar keys %{$_||{}} } values %reg_of_regs;
69 for my $reg (@individual_regs) {
70 my @live_slots = grep { defined $_->{weakref} } values %$reg
73 $reg = {}; # get a fresh hashref in the new thread ctx
74 weaken( $reg_of_regs{hrefaddr($reg)} = $reg );
76 for my $slot_info (@live_slots) {
77 my $new_addr = hrefaddr $slot_info->{weakref};
79 # replace all slot names
80 $slot_info->{slot_names} = { map {
82 $name =~ s/\(0x[0-9A-F]+\)/sprintf ('(%s)', $new_addr)/ieg;
84 } keys %{$slot_info->{slot_names}} };
86 $reg->{$new_addr} = $slot_info;
92 my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
94 $args->{seen_refs} ||= {};
96 my $visited_cnt = '0E0';
97 for my $i (0 .. $#{$args->{refs}} ) {
99 next unless length ref $args->{refs}[$i]; # not-a-ref
101 my $addr = hrefaddr $args->{refs}[$i];
103 # no diving into weakregistries
104 next if $reg_of_regs{$addr};
106 next if $args->{seen_refs}{$addr}++;
109 my $r = $args->{refs}[$i];
111 $args->{action}->($r) or next;
113 # This may end up being necessarry some day, but do not slow things
115 #if ( defined( my $t = tied($r) ) ) {
116 # $visited_cnt += visit_refs({ %$args, refs => [ $t ] });
119 my $type = reftype $r;
123 if ($type eq 'HASH') {
124 $visited_cnt += visit_refs({ %$args, refs => [ map {
125 ( !isweak($r->{$_}) ) ? $r->{$_} : ()
128 elsif ($type eq 'ARRAY') {
129 $visited_cnt += visit_refs({ %$args, refs => [ map {
130 ( !isweak($r->[$_]) ) ? $r->[$_] : ()
133 elsif ($type eq 'REF' and !isweak($$r)) {
134 $visited_cnt += visit_refs({ %$args, refs => [ $$r ] });
136 elsif (CV_TRACING and $type eq 'CODE') {
137 $visited_cnt += visit_refs({ %$args, refs => [ map {
138 ( !isweak($_) ) ? $_ : ()
139 } values %{ scalar PadWalker::closed_over($r) } ] }); # scalar due to RT#92269
142 } or warn "Could not descend into @{[ refdesc $r ]}: $@\n";
147 # compiles a list of addresses stored as globals (possibly even catching
148 # class data in the form of method closures), so we can skip them further on
149 sub symtable_referenced_addresses {
161 # the unless regex at the end skips some dangerous namespaces outright
162 # (but does not prevent descent)
163 $refs_per_pkg->{$pkg} += visit_refs (
164 seen_refs => $seen_refs,
168 refs => [ map { my $sym = $_;
169 # *{"${pkg}::$sym"}{CODE} won't simply work - MRO-cached CVs are invisible there
170 ( CV_TRACING ? Class::MethodCache::get_cv("${pkg}::$sym") : () ),
172 ( defined *{"${pkg}::$sym"}{SCALAR} and length ref ${"${pkg}::$sym"} and ! isweak( ${"${pkg}::$sym"} ) )
173 ? ${"${pkg}::$sym"} : ()
177 ( defined *{"${pkg}::$sym"}{$_} and ! isweak(defined *{"${pkg}::$sym"}{$_}) )
178 ? *{"${pkg}::$sym"}{$_}
180 } qw(HASH ARRAY IO GLOB) ),
182 } keys %{"${pkg}::"} ],
183 ) unless $pkg =~ /^ (?:
184 DB | next | B | .+? ::::ISA (?: ::CACHE ) | Class::C3
191 # { { $_ => $refs_per_pkg->{$_} } }
193 # {$refs_per_pkg->{$a} <=> $refs_per_pkg->{$b} }
194 # keys %$refs_per_pkg
200 sub assert_empty_weakregistry {
201 my ($weak_registry, $quiet) = @_;
203 # in case we hooked bless any extra object creation will wreak
204 # havoc during the assert phase
205 local *CORE::GLOBAL::bless;
206 *CORE::GLOBAL::bless = sub { CORE::bless( $_[0], (@_ > 1) ? $_[1] : caller() ) };
208 croak 'Expecting a registry hashref' unless ref $weak_registry eq 'HASH';
210 defined $weak_registry->{$_}{weakref} or delete $weak_registry->{$_}
211 for keys %$weak_registry;
213 return unless keys %$weak_registry;
215 my $tb = eval { Test::Builder->new }
216 or croak "Calling assert_empty_weakregistry in $0 without a loaded Test::Builder makes no sense";
218 for my $addr (keys %$weak_registry) {
219 $weak_registry->{$addr}{display_name} = join ' | ', (
221 { length $a <=> length $b or $a cmp $b }
222 keys %{$weak_registry->{$addr}{slot_names}}
225 $tb->BAILOUT("!!!! WEAK REGISTRY SLOT $weak_registry->{$addr}{display_name} IS NOT A WEAKREF !!!!")
226 if defined $weak_registry->{$addr}{weakref} and ! isweak( $weak_registry->{$addr}{weakref} );
229 # the symtable walk is very expensive
230 # if we are $quiet (running in an END block) we do not really need to be
231 # that thorough - can get by with only %Sub::Quote::QUOTED
232 delete $weak_registry->{$_} for $quiet
236 # only look at the closed over stuffs
237 refs => [ grep { length ref $_ } map { values %{$_->[2]} } grep { ref $_ eq 'ARRAY' } values %Sub::Quote::QUOTED ],
244 # full sumtable walk, starting from ::
245 keys %{ symtable_referenced_addresses() }
249 for my $addr (sort { $weak_registry->{$a}{display_name} cmp $weak_registry->{$b}{display_name} } keys %$weak_registry) {
251 next if ! defined $weak_registry->{$addr}{weakref};
253 $leaks_found++ unless $tb->in_todo;
254 $tb->ok (0, "Expected garbage collection of $weak_registry->{$addr}{display_name}");
257 local $Data::Dumper::Maxdepth = 1;
258 sprintf "\n%s (refcnt %d) => %s\n",
259 $weak_registry->{$addr}{display_name},
260 refcount($weak_registry->{$addr}{weakref}),
262 ref($weak_registry->{$addr}{weakref}) eq 'CODE'
264 B::svref_2object($weak_registry->{$addr}{weakref})->XSUB
265 ) ? '__XSUB__' : Dumper( $weak_registry->{$addr}{weakref} )
269 # FIXME - need to add a circular reference seeker based on the visitor
270 # (will need a bunch of modifications, punting with just a stub for now)
272 $diag .= Devel::FindRef::track ($weak_registry->{$addr}{weakref}, 50) . "\n"
273 if ( $ENV{TEST_VERBOSE} && eval { require Devel::FindRef });
277 if (my $stack = $weak_registry->{$addr}{stacktrace}) {
278 $diag .= " Reference first seen$stack";
283 # if ($leaks_found == 1) {
284 # # using the fh dumper due to intermittent buffering issues
285 # # in case we decide to exit soon after (possibly via _exit)
286 # require Devel::MAT::Dumper;
287 # local $Devel::MAT::Dumper::MAX_STRING = -1;
288 # open( my $fh, '>:raw', "leaked_${addr}_pid$$.pmat" ) or die $!;
289 # Devel::MAT::Dumper::dumpfh( $fh );
290 # close ($fh) or die $!;
297 if (! $quiet and !$leaks_found and ! $tb->in_todo) {
298 $tb->ok(1, sprintf "No leaks found at %s line %d", (caller())[1,2] );
304 $INC{'Test/Builder.pm'}
308 my $t = eval { Test::Builder->new }
309 or warn "Test::Builder->new failed:\n$@\n";
313 # we check for test passage - a leak may be a part of a TODO
314 if ($leaks_found and !$tb->is_passing) {
317 "\n\n%s\n%s\n\nInstall Devel::FindRef and re-run the test with set "
318 . '$ENV{TEST_VERBOSE} (prove -v) to see a more detailed leak-report'
319 . "\n\n%s\n%s\n\n", ('#' x 16) x 4
320 ) if ( !$ENV{TEST_VERBOSE} or !$INC{'Devel/FindRef.pm'} );
324 $tb->note("Auto checked $refs_traced references for leaks - none detected");
327 # also while we are here and not in plain runmode: make sure we never
328 # loaded any of the strictures XS bullshit (it's a leak in a sense)
330 $ENV{MOO_FATAL_WARNINGS}
332 # FIXME - SQLT loads strictures explicitly, /facedesk
333 # remove this INC check when 0fb58589 and 45287c815 are rectified
334 $INC{'SQL/Translator.pm'}
336 DBICTest::RunMode->is_plain
338 for (qw(indirect multidimensional bareword::filehandles)) {
339 exists $INC{ Module::Runtime::module_notional_filename($_) }
341 $tb->ok(0, "$_ load should not have been attempted!!!" )