1 package DBICTest::Util::LeakTracer;
8 use Scalar::Util qw(isweak weaken blessed reftype);
9 use DBIx::Class::_Util qw(refcount hrefaddr refdesc);
10 use DBICTest::RunMode;
11 use Data::Dumper::Concise;
12 use DBICTest::Util qw( stacktrace visit_namespaces );
15 !DBICTest::RunMode->is_plain
17 require DBIx::Class::Optional::Dependencies
19 DBIx::Class::Optional::Dependencies->req_ok_for ('test_leaks_heavy')
24 our @EXPORT_OK = qw(populate_weakregistry assert_empty_weakregistry visit_refs);
30 sub populate_weakregistry {
31 my ($weak_registry, $target, $note) = @_;
33 croak 'Expecting a registry hashref' unless ref $weak_registry eq 'HASH';
34 croak 'Target is not a reference' unless length ref $target;
36 my $refaddr = hrefaddr $target;
38 # a registry could be fed to itself or another registry via recursive sweeps
39 return $target if $reg_of_regs{$refaddr};
41 weaken( $reg_of_regs{ hrefaddr($weak_registry) } = $weak_registry )
42 unless( $reg_of_regs{ hrefaddr($weak_registry) } );
44 # an explicit "garbage collection" pass every time we store a ref
45 # if we do not do this the registry will keep growing appearing
46 # as if the traced program is continuously slowly leaking memory
47 for my $reg (values %reg_of_regs) {
48 (defined $reg->{$_}{weakref}) or delete $reg->{$_}
52 if (! defined $weak_registry->{$refaddr}{weakref}) {
53 $weak_registry->{$refaddr} = {
54 stacktrace => stacktrace(1),
58 # on perl < 5.8.3 sometimes a weaken can throw (can't find RT)
59 # so guard against that unlikely event
60 local $SIG{__DIE__} if $SIG{__DIE__};
62 eval { weaken( $weak_registry->{$refaddr}{weakref} ); $refs_traced++ }
63 or delete $weak_registry->{$refaddr};
66 my $desc = refdesc $target;
67 $weak_registry->{$refaddr}{slot_names}{$desc} = 1;
69 $note =~ s/\s*\Q$desc\E\s*//g;
70 $weak_registry->{$refaddr}{slot_names}{$note} = 1;
76 # Regenerate the slots names on a thread spawn
78 my @individual_regs = grep { scalar keys %{$_||{}} } values %reg_of_regs;
81 for my $reg (@individual_regs) {
82 my @live_slots = grep { defined $_->{weakref} } values %$reg
85 $reg = {}; # get a fresh hashref in the new thread ctx
86 weaken( $reg_of_regs{hrefaddr($reg)} = $reg );
88 for my $slot_info (@live_slots) {
89 my $new_addr = hrefaddr $slot_info->{weakref};
91 # replace all slot names
92 $slot_info->{slot_names} = { map {
94 $name =~ s/\(0x[0-9A-F]+\)/sprintf ('(%s)', $new_addr)/ieg;
96 } keys %{$slot_info->{slot_names}} };
98 $reg->{$new_addr} = $slot_info;
102 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
103 # collected before leaving this scope. Depending on the code above, this
104 # may very well be just a preventive measure guarding future modifications
109 my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
111 $args->{seen_refs} ||= {};
113 my $visited_cnt = '0E0';
114 for my $i (0 .. $#{$args->{refs}} ) {
116 next unless length ref $args->{refs}[$i]; # not-a-ref
118 my $addr = hrefaddr $args->{refs}[$i];
120 # no diving into weakregistries
121 next if $reg_of_regs{$addr};
123 next if $args->{seen_refs}{$addr}++;
126 my $r = $args->{refs}[$i];
128 $args->{action}->($r) or next;
130 # This may end up being necessarry some day, but do not slow things
132 #if ( defined( my $t = tied($r) ) ) {
133 # $visited_cnt += visit_refs({ %$args, refs => [ $t ] });
136 my $type = reftype $r;
138 local $SIG{__DIE__} if $SIG{__DIE__};
141 if ($type eq 'HASH') {
142 $visited_cnt += visit_refs({ %$args, refs => [ map {
143 ( !isweak($r->{$_}) ) ? $r->{$_} : ()
146 elsif ($type eq 'ARRAY') {
147 $visited_cnt += visit_refs({ %$args, refs => [ map {
148 ( !isweak($r->[$_]) ) ? $r->[$_] : ()
151 elsif ($type eq 'REF' and !isweak($$r)) {
152 $visited_cnt += visit_refs({ %$args, refs => [ $$r ] });
154 elsif (CV_TRACING and $type eq 'CODE') {
155 $visited_cnt += visit_refs({ %$args, refs => [ map {
156 ( !isweak($_) ) ? $_ : ()
157 } values %{ scalar PadWalker::closed_over($r) } ] }); # scalar due to RT#92269
160 } or warn "Could not descend into @{[ refdesc $r ]}: $@\n";
165 # compiles a list of addresses stored as globals (possibly even catching
166 # class data in the form of method closures), so we can skip them further on
167 sub symtable_referenced_addresses {
179 # the unless regex at the end skips some dangerous namespaces outright
180 # (but does not prevent descent)
181 $refs_per_pkg->{$pkg} += visit_refs (
182 seen_refs => $seen_refs,
186 refs => [ map { my $sym = $_;
187 # *{"${pkg}::$sym"}{CODE} won't simply work - MRO-cached CVs are invisible there
188 ( CV_TRACING ? Class::MethodCache::get_cv("${pkg}::$sym") : () ),
190 ( defined *{"${pkg}::$sym"}{SCALAR} and length ref ${"${pkg}::$sym"} and ! isweak( ${"${pkg}::$sym"} ) )
191 ? ${"${pkg}::$sym"} : ()
195 ( defined *{"${pkg}::$sym"}{$_} and ! isweak(defined *{"${pkg}::$sym"}{$_}) )
196 ? *{"${pkg}::$sym"}{$_}
198 } qw(HASH ARRAY IO GLOB) ),
200 } keys %{"${pkg}::"} ],
201 ) unless $pkg =~ /^ (?:
202 DB | next | B | .+? ::::ISA (?: ::CACHE ) | Class::C3
209 # { { $_ => $refs_per_pkg->{$_} } }
211 # {$refs_per_pkg->{$a} <=> $refs_per_pkg->{$b} }
212 # keys %$refs_per_pkg
218 sub assert_empty_weakregistry {
219 my ($weak_registry, $quiet) = @_;
221 # in case we hooked bless any extra object creation will wreak
222 # havoc during the assert phase
223 local *CORE::GLOBAL::bless;
224 *CORE::GLOBAL::bless = sub { CORE::bless( $_[0], (@_ > 1) ? $_[1] : CORE::caller() ) };
226 croak 'Expecting a registry hashref' unless ref $weak_registry eq 'HASH';
228 defined $weak_registry->{$_}{weakref} or delete $weak_registry->{$_}
229 for keys %$weak_registry;
231 return unless keys %$weak_registry;
233 my $tb = eval { Test::Builder->new }
234 or croak "Calling assert_empty_weakregistry in $0 without a loaded Test::Builder makes no sense";
236 for my $addr (keys %$weak_registry) {
237 $weak_registry->{$addr}{display_name} = join ' | ', (
239 { length $a <=> length $b or $a cmp $b }
240 keys %{$weak_registry->{$addr}{slot_names}}
243 $tb->BAILOUT("!!!! WEAK REGISTRY SLOT $weak_registry->{$addr}{display_name} IS NOT A WEAKREF !!!!")
244 if defined $weak_registry->{$addr}{weakref} and ! isweak( $weak_registry->{$addr}{weakref} );
247 # the symtable walk is very expensive
248 # if we are $quiet (running in an END block) we do not really need to be
249 # that thorough - can get by with only %Sub::Quote::QUOTED
250 delete $weak_registry->{$_} for $quiet
254 # only look at the closed over stuffs
255 refs => [ grep { length ref $_ } map { values %{$_->[2]} } grep { ref $_ eq 'ARRAY' } values %Sub::Quote::QUOTED ],
262 # full sumtable walk, starting from ::
263 keys %{ symtable_referenced_addresses() }
267 for my $addr (sort { $weak_registry->{$a}{display_name} cmp $weak_registry->{$b}{display_name} } keys %$weak_registry) {
269 next if ! defined $weak_registry->{$addr}{weakref};
271 $leaks_found++ unless $tb->in_todo;
272 $tb->ok (0, "Expected garbage collection of $weak_registry->{$addr}{display_name}");
275 local $Data::Dumper::Maxdepth = 1;
276 sprintf "\n%s (refcnt %d) => %s\n",
277 $weak_registry->{$addr}{display_name},
278 refcount($weak_registry->{$addr}{weakref}),
280 ref($weak_registry->{$addr}{weakref}) eq 'CODE'
282 B::svref_2object($weak_registry->{$addr}{weakref})->XSUB
283 ) ? '__XSUB__' : Dumper( $weak_registry->{$addr}{weakref} )
287 # FIXME - need to add a circular reference seeker based on the visitor
288 # (will need a bunch of modifications, punting with just a stub for now)
290 $diag .= Devel::FindRef::track ($weak_registry->{$addr}{weakref}, 50) . "\n"
291 if ( $ENV{TEST_VERBOSE} && eval { require Devel::FindRef });
295 if (my $stack = $weak_registry->{$addr}{stacktrace}) {
296 $diag .= " Reference first seen$stack";
301 # if ($leaks_found == 1) {
302 # # using the fh dumper due to intermittent buffering issues
303 # # in case we decide to exit soon after (possibly via _exit)
304 # require Devel::MAT::Dumper;
305 # local $Devel::MAT::Dumper::MAX_STRING = -1;
306 # open( my $fh, '>:raw', "leaked_${addr}_pid$$.pmat" ) or die $!;
307 # Devel::MAT::Dumper::dumpfh( $fh );
308 # close ($fh) or die $!;
315 if (! $quiet and !$leaks_found and ! $tb->in_todo) {
316 $tb->ok(1, sprintf "No leaks found at %s line %d", (CORE::caller())[1,2] );
322 $INC{'Test/Builder.pm'}
326 my $t = eval { Test::Builder->new }
327 or warn "Test::Builder->new failed:\n$@\n";
331 # we check for test passage - a leak may be a part of a TODO
332 if ($leaks_found and !$tb->is_passing) {
335 "\n\n%s\n%s\n\nInstall Devel::FindRef and re-run the test with set "
336 . '$ENV{TEST_VERBOSE} (prove -v) to see a more detailed leak-report'
337 . "\n\n%s\n%s\n\n", ('#' x 16) x 4
338 ) if ( !$ENV{TEST_VERBOSE} or !$INC{'Devel/FindRef.pm'} );
342 $tb->note("Auto checked $refs_traced references for leaks - none detected");
345 # also while we are here and not in plain runmode: make sure we never
346 # loaded any of the strictures XS bullshit (it's a leak in a sense)
348 $ENV{MOO_FATAL_WARNINGS}
350 # FIXME - SQLT loads strictures explicitly, /facedesk
351 # remove this INC check when 0fb58589 and 45287c815 are rectified
352 $INC{'SQL/Translator.pm'}
354 DBICTest::RunMode->is_plain
356 for (qw(indirect multidimensional bareword::filehandles)) {
357 exists $INC{ Module::Runtime::module_notional_filename($_) }
359 $tb->ok(0, "$_ load should not have been attempted!!!" )