1 package DBICTest::Util::LeakTracer;
8 use Scalar::Util qw(isweak weaken blessed reftype);
9 use DBIx::Class::_Util qw(refcount hrefaddr refdesc dump_value visit_namespaces);
10 use DBICTest::RunMode;
11 use DBICTest::Util 'stacktrace';
14 !DBICTest::RunMode->is_plain
16 require DBIx::Class::Optional::Dependencies
18 DBIx::Class::Optional::Dependencies->req_ok_for ('test_leaks_heavy')
23 our @EXPORT_OK = qw(populate_weakregistry assert_empty_weakregistry visit_refs);
29 sub populate_weakregistry {
30 my ($weak_registry, $target, $note) = @_;
32 croak 'Expecting a registry hashref' unless ref $weak_registry eq 'HASH';
33 croak 'Target is not a reference' unless length ref $target;
35 my $refaddr = hrefaddr $target;
37 # a registry could be fed to itself or another registry via recursive sweeps
38 return $target if $reg_of_regs{$refaddr};
40 weaken( $reg_of_regs{ hrefaddr($weak_registry) } = $weak_registry )
41 unless( $reg_of_regs{ hrefaddr($weak_registry) } );
43 # an explicit "garbage collection" pass every time we store a ref
44 # if we do not do this the registry will keep growing appearing
45 # as if the traced program is continuously slowly leaking memory
46 for my $reg (values %reg_of_regs) {
47 (defined $reg->{$_}{weakref}) or delete $reg->{$_}
52 DBIx::Class::_ENV_::BROKEN_WEAK_SCALARREF_VALUES
54 ref $target eq 'SCALAR'
57 if (! defined $weak_registry->{$refaddr}{weakref}) {
59 # replace slot entirely
60 $weak_registry->{$refaddr} = {
61 stacktrace => stacktrace(1),
65 weaken( $weak_registry->{$refaddr}{weakref} );
70 my $desc = refdesc $target;
71 $weak_registry->{$refaddr}{slot_names}{$desc} = 1;
73 $note =~ s/\s*\Q$desc\E\s*//g;
74 $weak_registry->{$refaddr}{slot_names}{$note} = 1;
80 # Regenerate the slots names on a thread spawn
81 sub DBICTest::__LeakTracer_iThreads_handler__::CLONE {
82 my @individual_regs = grep { scalar keys %{$_||{}} } values %reg_of_regs;
85 for my $reg (@individual_regs) {
86 my @live_slots = grep { defined $_->{weakref} } values %$reg
89 $reg = {}; # get a fresh hashref in the new thread ctx
90 weaken( $reg_of_regs{hrefaddr($reg)} = $reg );
92 for my $slot_info (@live_slots) {
93 my $new_addr = hrefaddr $slot_info->{weakref};
95 # replace all slot names
96 $slot_info->{slot_names} = { map {
98 $name =~ s/\(0x[0-9A-F]+\)/sprintf ('(%s)', $new_addr)/ieg;
100 } keys %{$slot_info->{slot_names}} };
102 $reg->{$new_addr} = $slot_info;
106 # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
107 # collected before leaving this scope. Depending on the code above, this
108 # may very well be just a preventive measure guarding future modifications
113 my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
115 $args->{seen_refs} ||= {};
117 my $visited_cnt = '0E0';
118 for my $i (0 .. $#{$args->{refs}} ) {
120 next unless length ref $args->{refs}[$i]; # not-a-ref
122 my $addr = hrefaddr $args->{refs}[$i];
124 # no diving into weakregistries
125 next if $reg_of_regs{$addr};
127 next if $args->{seen_refs}{$addr}++;
130 my $r = $args->{refs}[$i];
132 $args->{action}->($r) or next;
134 # This may end up being necessarry some day, but do not slow things
136 #if ( defined( my $t = tied($r) ) ) {
137 # $visited_cnt += visit_refs({ %$args, refs => [ $t ] });
140 my $type = reftype $r;
142 local $SIG{__DIE__} if $SIG{__DIE__};
145 if ($type eq 'HASH') {
146 $visited_cnt += visit_refs({ %$args, refs => [ map {
147 ( !isweak($r->{$_}) ) ? $r->{$_} : ()
150 elsif ($type eq 'ARRAY') {
151 $visited_cnt += visit_refs({ %$args, refs => [ map {
152 ( !isweak($r->[$_]) ) ? $r->[$_] : ()
155 elsif ($type eq 'REF' and !isweak($$r)) {
156 $visited_cnt += visit_refs({ %$args, refs => [ $$r ] });
158 elsif (CV_TRACING and $type eq 'CODE') {
159 $visited_cnt += visit_refs({ %$args, refs => [ map {
160 ( !isweak($_) ) ? $_ : ()
161 } values %{ scalar PadWalker::closed_over($r) } ] }); # scalar due to RT#92269
164 } or warn "Could not descend into @{[ refdesc $r ]}: $@\n";
169 # compiles a list of addresses stored as globals (possibly even catching
170 # class data in the form of method closures), so we can skip them further on
171 sub symtable_referenced_addresses {
183 # the unless regex at the end skips some dangerous namespaces outright
184 # (but does not prevent descent)
185 $refs_per_pkg->{$pkg} += visit_refs (
186 seen_refs => $seen_refs,
190 refs => [ map { my $sym = $_;
191 # *{"${pkg}::$sym"}{CODE} won't simply work - MRO-cached CVs are invisible there
192 ( CV_TRACING ? Class::MethodCache::get_cv("${pkg}::$sym") : () ),
194 ( defined *{"${pkg}::$sym"}{SCALAR} and length ref ${"${pkg}::$sym"} and ! isweak( ${"${pkg}::$sym"} ) )
195 ? ${"${pkg}::$sym"} : ()
199 ( defined *{"${pkg}::$sym"}{$_} and ! isweak(defined *{"${pkg}::$sym"}{$_}) )
200 ? *{"${pkg}::$sym"}{$_}
202 } qw(HASH ARRAY IO GLOB) ),
204 } keys %{"${pkg}::"} ],
205 ) unless $pkg =~ /^ (?:
206 DB | next | B | .+? ::::ISA (?: ::CACHE ) | Class::C3
213 # { { $_ => $refs_per_pkg->{$_} } }
215 # {$refs_per_pkg->{$a} <=> $refs_per_pkg->{$b} }
216 # keys %$refs_per_pkg
222 sub assert_empty_weakregistry {
223 my ($weak_registry, $quiet) = @_;
225 # in case we hooked bless any extra object creation will wreak
226 # havoc during the assert phase
227 local *CORE::GLOBAL::bless;
228 *CORE::GLOBAL::bless = sub { CORE::bless( $_[0], (@_ > 1) ? $_[1] : CORE::caller() ) };
230 croak 'Expecting a registry hashref' unless ref $weak_registry eq 'HASH';
232 defined $weak_registry->{$_}{weakref} or delete $weak_registry->{$_}
233 for keys %$weak_registry;
235 return unless keys %$weak_registry;
237 my $tb = eval { Test::Builder->new }
238 or croak "Calling assert_empty_weakregistry in $0 without a loaded Test::Builder makes no sense";
240 for my $addr (keys %$weak_registry) {
241 $weak_registry->{$addr}{display_name} = join ' | ', (
243 { length $a <=> length $b or $a cmp $b }
244 keys %{$weak_registry->{$addr}{slot_names}}
247 $tb->BAILOUT("!!!! WEAK REGISTRY SLOT $weak_registry->{$addr}{display_name} IS NOT A WEAKREF !!!!")
248 if defined $weak_registry->{$addr}{weakref} and ! isweak( $weak_registry->{$addr}{weakref} );
251 # the symtable walk is very expensive
252 # if we are $quiet (running in an END block) we do not really need to be
253 # that thorough - can get by with only %Sub::Quote::QUOTED
254 delete $weak_registry->{$_} for $quiet
258 # only look at the closed over stuffs
259 refs => [ grep { length ref $_ } map { values %{$_->[2]} } grep { ref $_ eq 'ARRAY' } values %Sub::Quote::QUOTED ],
266 # full sumtable walk, starting from ::
267 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, "Expected garbage collection of $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__' : dump_value $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", (CORE::caller())[1,2] );
326 $INC{'Test/Builder.pm'}
330 my $t = eval { Test::Builder->new }
331 or warn "Test::Builder->new failed:\n$@\n";
335 # we check for test passage - a leak may be a part of a TODO
336 if ($leaks_found and !$tb->is_passing) {
339 "\n\n%s\n%s\n\nInstall Devel::FindRef and re-run the test with set "
340 . '$ENV{TEST_VERBOSE} (prove -v) to see a more detailed leak-report'
341 . "\n\n%s\n%s\n\n", ('#' x 16) x 4
342 ) if ( !$ENV{TEST_VERBOSE} or !$INC{'Devel/FindRef.pm'} );
346 $tb->note("Auto checked $refs_traced references for leaks - none detected");
349 # also while we are here and not in plain runmode: make sure we never
350 # loaded any of the strictures XS bullshit (it's a leak in a sense)
352 $ENV{MOO_FATAL_WARNINGS}
354 # FIXME - SQLT loads strictures explicitly, /facedesk
355 # remove this INC check when 0fb58589 and 45287c815 are rectified
356 $INC{'SQL/Translator.pm'}
358 DBICTest::RunMode->is_plain
360 for (qw(indirect multidimensional bareword::filehandles)) {
361 exists $INC{ Module::Runtime::module_notional_filename($_) }
363 $tb->ok(0, "$_ load should not have been attempted!!!" )