use strict;
use Carp;
-use Scalar::Util qw/isweak weaken blessed reftype refaddr/;
-use DBIx::Class::_Util 'refcount';
+use Scalar::Util qw(isweak weaken blessed reftype);
+use DBIx::Class::_Util qw(refcount hrefaddr refdesc);
+use DBIx::Class::Optional::Dependencies;
+use Data::Dumper::Concise;
use DBICTest::Util 'stacktrace';
+use constant {
+ CV_TRACING => DBIx::Class::Optional::Dependencies->req_ok_for ('test_leaks_heavy'),
+ SKIP_SCALAR_REFS => ( $] > 5.017 ) ? 1 : 0,
+};
use base 'Exporter';
-our @EXPORT_OK = qw/populate_weakregistry assert_empty_weakregistry/;
+our @EXPORT_OK = qw(populate_weakregistry assert_empty_weakregistry visit_refs);
my $refs_traced = 0;
-my $leaks_found;
+my $leaks_found = 0;
my %reg_of_regs;
sub populate_weakregistry {
- my ($weak_registry, $target, $slot) = @_;
+ my ($weak_registry, $target, $note) = @_;
croak 'Expecting a registry hashref' unless ref $weak_registry eq 'HASH';
croak 'Target is not a reference' unless length ref $target;
- my $refaddr = refaddr $target;
+ my $refaddr = hrefaddr $target;
- $slot ||= (sprintf '%s%s(0x%x)', # so we don't trigger stringification
- (defined blessed $target) ? blessed($target) . '=' : '',
- reftype $target,
- $refaddr,
- );
+ # a registry could be fed to itself or another registry via recursive sweeps
+ return $target if $reg_of_regs{$refaddr};
- if (defined $weak_registry->{$slot}{weakref}) {
- if ( $weak_registry->{$slot}{refaddr} != $refaddr ) {
- print STDERR "Bail out! Weak Registry slot collision $slot: $weak_registry->{$slot}{weakref} / $target\n";
- exit 255;
- }
+ weaken( $reg_of_regs{ hrefaddr($weak_registry) } = $weak_registry )
+ unless( $reg_of_regs{ hrefaddr($weak_registry) } );
+
+ # an explicit "garbage collection" pass every time we store a ref
+ # if we do not do this the registry will keep growing appearing
+ # as if the traced program is continuously slowly leaking memory
+ for my $reg (values %reg_of_regs) {
+ (defined $reg->{$_}{weakref}) or delete $reg->{$_}
+ for keys %$reg;
}
- else {
- $weak_registry->{$slot} = {
+
+ # FIXME/INVESTIGATE - something fishy is going on with refs to plain
+ # strings, perhaps something to do with the CoW work etc...
+ return $target if SKIP_SCALAR_REFS and reftype($target) eq 'SCALAR';
+
+ if (! defined $weak_registry->{$refaddr}{weakref}) {
+ $weak_registry->{$refaddr} = {
stacktrace => stacktrace(1),
- refaddr => $refaddr,
- renumber => $_[2] ? 0 : 1,
+ weakref => $target,
};
- weaken( $weak_registry->{$slot}{weakref} = $target );
+ weaken( $weak_registry->{$refaddr}{weakref} );
$refs_traced++;
}
- weaken( $reg_of_regs{ refaddr($weak_registry) } = $weak_registry )
- unless( $reg_of_regs{ refaddr($weak_registry) } );
+ my $desc = refdesc $target;
+ $weak_registry->{$refaddr}{slot_names}{$desc} = 1;
+ if ($note) {
+ $note =~ s/\s*\Q$desc\E\s*//g;
+ $weak_registry->{$refaddr}{slot_names}{$note} = 1;
+ }
$target;
}
-# Renumber everything we auto-named on a thread spawn
+# Regenerate the slots names on a thread spawn
sub CLONE {
my @individual_regs = grep { scalar keys %{$_||{}} } values %reg_of_regs;
%reg_of_regs = ();
for my $reg (@individual_regs) {
- my @live_slots = grep { defined $reg->{$_}{weakref} } keys %$reg
+ my @live_slots = grep { defined $_->{weakref} } values %$reg
or next;
- my @live_instances = @{$reg}{@live_slots};
-
$reg = {}; # get a fresh hashref in the new thread ctx
- weaken( $reg_of_regs{refaddr($reg)} = $reg );
+ weaken( $reg_of_regs{hrefaddr($reg)} = $reg );
- while (@live_slots) {
- my $slot = shift @live_slots;
- my $inst = shift @live_instances;
+ for my $slot_info (@live_slots) {
+ my $new_addr = hrefaddr $slot_info->{weakref};
- my $refaddr = $inst->{refaddr} = refaddr($inst);
+ # replace all slot names
+ $slot_info->{slot_names} = { map {
+ my $name = $_;
+ $name =~ s/\(0x[0-9A-F]+\)/sprintf ('(%s)', $new_addr)/ieg;
+ ($name => 1);
+ } keys %{$slot_info->{slot_names}} };
- $slot =~ s/0x[0-9A-F]+/'0x' . sprintf ('0x%x', $refaddr)/ieg
- if $inst->{renumber};
-
- $reg->{$slot} = $inst;
+ $reg->{$new_addr} = $slot_info;
}
}
}
-sub assert_empty_weakregistry {
- my ($weak_registry, $quiet) = @_;
+sub visit_refs {
+ my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
- croak 'Expecting a registry hashref' unless ref $weak_registry eq 'HASH';
+ $args->{seen_refs} ||= {};
- return unless keys %$weak_registry;
+ my $visited_cnt = '0E0';
+ for my $i (0 .. $#{$args->{refs}} ) {
- my $tb = eval { Test::Builder->new }
- or croak 'Calling test_weakregistry without a loaded Test::Builder makes no sense';
+ next unless length ref $args->{refs}[$i]; # not-a-ref
+
+ my $addr = hrefaddr $args->{refs}[$i];
+
+ # no diving into weakregistries
+ next if $reg_of_regs{$addr};
+
+ next if $args->{seen_refs}{$addr}++;
+ $visited_cnt++;
+
+ my $r = $args->{refs}[$i];
+
+ $args->{action}->($r) or next;
- for my $slot (sort keys %$weak_registry) {
- next if ! defined $weak_registry->{$slot}{weakref};
- $tb->BAILOUT("!!!! WEAK REGISTRY SLOT $slot IS NOT A WEAKREF !!!!")
- unless isweak( $weak_registry->{$slot}{weakref} );
+ # This may end up being necessarry some day, but do not slow things
+ # down for now
+ #if ( defined( my $t = tied($r) ) ) {
+ # $visited_cnt += visit_refs({ %$args, refs => [ $t ] });
+ #}
+
+ my $type = reftype $r;
+
+ local $@;
+ eval {
+ if ($type eq 'HASH') {
+ $visited_cnt += visit_refs({ %$args, refs => [ map {
+ ( !isweak($r->{$_}) ) ? $r->{$_} : ()
+ } keys %$r ] });
+ }
+ elsif ($type eq 'ARRAY') {
+ $visited_cnt += visit_refs({ %$args, refs => [ map {
+ ( !isweak($r->[$_]) ) ? $r->[$_] : ()
+ } 0..$#$r ] });
+ }
+ elsif ($type eq 'REF' and !isweak($$r)) {
+ $visited_cnt += visit_refs({ %$args, refs => [ $$r ] });
+ }
+ elsif (CV_TRACING and $type eq 'CODE') {
+ $visited_cnt += visit_refs({ %$args, refs => [ map {
+ ( !isweak($_) ) ? $_ : ()
+ } scalar PadWalker::closed_over($r) ] }); # scalar due to RT#92269
+ }
+ 1;
+ } or warn "Could not descend into @{[ refdesc $r ]}: $@\n";
}
+ $visited_cnt;
+}
+sub visit_namespaces {
+ my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
- # compile a list of refs stored as CAG class data, so we can skip them
- # intelligently below
- my ($classdata_refcounts, $symwalker, $refwalker);
+ my $visited = 1;
- $refwalker = sub {
- return unless length ref $_[0];
+ $args->{package} ||= '::';
+ $args->{package} = '::' if $args->{package} eq 'main';
- my $seen = $_[1] || {};
- return if $seen->{refaddr $_[0]}++;
+ if ( $args->{action}->($args->{package}) ) {
- $classdata_refcounts->{refaddr $_[0]}++;
+ my $base = $args->{package};
+ $base = '' if $base eq '::';
- my $type = reftype $_[0];
- if ($type eq 'HASH') {
- $refwalker->($_, $seen) for values %{$_[0]};
- }
- elsif ($type eq 'ARRAY') {
- $refwalker->($_, $seen) for @{$_[0]};
- }
- elsif ($type eq 'REF') {
- $refwalker->($$_, $seen);
- }
- };
- $symwalker = sub {
- no strict 'refs';
- my $pkg = shift || '::';
+ $visited += visit_namespaces({ %$args, package => $_ }) for map
+ { $_ =~ /(.+?)::$/ ? "${base}::$1" : () }
+ grep
+ { $_ =~ /(?<!^main)::$/ }
+ do { no strict 'refs'; keys %{ $base . '::'} }
+ }
- $refwalker->(${"${pkg}$_"}) for grep { $_ =~ /__cag_(?!pkg_gen__|supers__)/ } keys %$pkg;
+ return $visited;
+}
- $symwalker->("${pkg}$_") for grep { $_ =~ /(?<!^main)::$/ } keys %$pkg;
- };
+# compiles a list of addresses stored as globals (possibly even catching
+# class data in the form of method closures), so we can skip them further on
+sub symtable_referenced_addresses {
- # run things twice, some cycles will be broken, introducing new
- # candidates for pseudo-GC
- for (1,2) {
- undef $classdata_refcounts;
+ my $refs_per_pkg;
- $symwalker->();
+ my $dummy_addresslist;
- for my $slot (keys %$weak_registry) {
- if (
- defined $weak_registry->{$slot}{weakref}
- and
- my $expected_refcnt = $classdata_refcounts->{$weak_registry->{$slot}{refaddr}}
- ) {
- delete $weak_registry->{$slot}
- if refcount($weak_registry->{$slot}{weakref}) == $expected_refcnt;
- }
+ my $seen_refs = {};
+ visit_namespaces(
+ action => sub {
+
+ no strict 'refs';
+
+ my $pkg = shift;
+ $pkg = '' if $pkg eq '::';
+ $pkg .= '::';
+
+ # the unless regex at the end skips some dangerous namespaces outright
+ # (but does not prevent descent)
+ $refs_per_pkg->{$pkg} += visit_refs (
+ seen_refs => $seen_refs,
+
+ # FIXME FIXME FIXME
+ # This is so damn odd - if we feed a constsub {1} (or in fact almost
+ # anything other than the actionsub below, any scalarref will show
+ # up as a leak, trapped by... something...
+ # Ideally we should be able to const this to sub{1} and just return
+ # $seen_refs (in fact it is identical to the dummy list at the end of
+ # a run here). Alas this doesn't seem to work, so punt for now...
+ action => sub { ++$dummy_addresslist->{ hrefaddr $_[0] } },
+
+ refs => [ map { my $sym = $_;
+ # *{"$pkg$sym"}{CODE} won't simply work - MRO-cached CVs are invisible there
+ ( CV_TRACING ? Class::MethodCache::get_cv("${pkg}$sym") : () ),
+
+ ( defined *{"$pkg$sym"}{SCALAR} and length ref ${"$pkg$sym"} and ! isweak( ${"$pkg$sym"} ) )
+ ? ${"$pkg$sym"} : ()
+ ,
+
+ ( map {
+ ( defined *{"$pkg$sym"}{$_} and ! isweak(defined *{"$pkg$sym"}{$_}) )
+ ? *{"$pkg$sym"}{$_}
+ : ()
+ } qw(HASH ARRAY IO GLOB) ),
+
+ } keys %$pkg ],
+ ) unless $pkg =~ /^ :: (?:
+ DB | next | B | .+? ::::ISA (?: ::CACHE ) | Class::C3
+ ) :: $/x;
}
- }
+ );
+
+# use Devel::Dwarn;
+# Ddie [ map
+# { { $_ => $refs_per_pkg->{$_} } }
+# sort
+# {$refs_per_pkg->{$a} <=> $refs_per_pkg->{$b} }
+# keys %$refs_per_pkg
+# ];
+
+ $seen_refs;
+}
- for my $slot (sort keys %$weak_registry) {
- ! defined $weak_registry->{$slot}{weakref} and next if $quiet;
+sub assert_empty_weakregistry {
+ my ($weak_registry, $quiet) = @_;
- $tb->ok (! defined $weak_registry->{$slot}{weakref}, "No leaks of $slot") or do {
- $leaks_found = 1;
+ Sub::Defer::undefer_all();
- my $diag = '';
+ # in case we hooked bless any extra object creation will wreak
+ # havoc during the assert phase
+ local *CORE::GLOBAL::bless;
+ *CORE::GLOBAL::bless = sub { CORE::bless( $_[0], (@_ > 1) ? $_[1] : caller() ) };
- $diag .= Devel::FindRef::track ($weak_registry->{$slot}{weakref}, 20) . "\n"
- if ( $ENV{TEST_VERBOSE} && eval { require Devel::FindRef });
+ croak 'Expecting a registry hashref' unless ref $weak_registry eq 'HASH';
- if (my $stack = $weak_registry->{$slot}{stacktrace}) {
- $diag .= " Reference first seen$stack";
- }
+ defined $weak_registry->{$_}{weakref} or delete $weak_registry->{$_}
+ for keys %$weak_registry;
+
+ return unless keys %$weak_registry;
+
+ my $tb = eval { Test::Builder->new }
+ or croak "Calling assert_empty_weakregistry in $0 without a loaded Test::Builder makes no sense";
- $tb->diag($diag) if $diag;
+ for my $addr (keys %$weak_registry) {
+ $weak_registry->{$addr}{display_name} = join ' | ', (
+ sort
+ { length $a <=> length $b or $a cmp $b }
+ keys %{$weak_registry->{$addr}{slot_names}}
+ );
+
+ $tb->BAILOUT("!!!! WEAK REGISTRY SLOT $weak_registry->{$addr}{display_name} IS NOT A WEAKREF !!!!")
+ if defined $weak_registry->{$addr}{weakref} and ! isweak( $weak_registry->{$addr}{weakref} );
+ }
+
+ # the symtable walk is very expensive
+ # if we are $quiet (running in an END block) we do not really need to be
+ # that thorough - can get by with only %Sub::Quote::QUOTED
+ delete $weak_registry->{$_} for $quiet
+ ? do {
+ my $refs = {};
+ visit_refs (
+ # only look at the closed over stuffs
+ refs => [ grep { length ref $_ } map { values %{$_->[2]} } grep { ref $_ eq 'ARRAY' } values %Sub::Quote::QUOTED ],
+ seen_refs => $refs,
+ action => sub { 1 },
+ );
+ keys %$refs;
+ }
+ : (
+ # full sumtable walk, starting from ::
+ keys %{ symtable_referenced_addresses() }
+ )
+ ;
+
+ for my $addr (sort { $weak_registry->{$a}{display_name} cmp $weak_registry->{$b}{display_name} } keys %$weak_registry) {
+
+ next if ! defined $weak_registry->{$addr}{weakref};
+
+ $leaks_found++ unless $tb->in_todo;
+ $tb->ok (0, "Leaked $weak_registry->{$addr}{display_name}");
+
+ my $diag = do {
+ local $Data::Dumper::Maxdepth = 1;
+ sprintf "\n%s (refcnt %d) => %s\n",
+ $weak_registry->{$addr}{display_name},
+ refcount($weak_registry->{$addr}{weakref}),
+ (
+ ref($weak_registry->{$addr}{weakref}) eq 'CODE'
+ and
+ B::svref_2object($weak_registry->{$addr}{weakref})->XSUB
+ ) ? '__XSUB__' : Dumper( $weak_registry->{$addr}{weakref} )
+ ;
};
+
+ # FIXME - need to add a circular reference seeker based on the visitor
+ # (will need a bunch of modifications, punting with just a stub for now)
+
+ $diag .= Devel::FindRef::track ($weak_registry->{$addr}{weakref}, 50) . "\n"
+ if ( $ENV{TEST_VERBOSE} && eval { require Devel::FindRef });
+
+ $diag =~ s/^/ /mg;
+
+ if (my $stack = $weak_registry->{$addr}{stacktrace}) {
+ $diag .= " Reference first seen$stack";
+ }
+
+ $tb->diag($diag);
+
+# if ($leaks_found == 1) {
+# # using the fh dumper due to intermittent buffering issues
+# # in case we decide to exit soon after (possibly via _exit)
+# require Devel::MAT::Dumper;
+# local $Devel::MAT::Dumper::MAX_STRING = -1;
+# open( my $fh, '>:raw', "leaked_${addr}_pid$$.pmat" ) or die $!;
+# Devel::MAT::Dumper::dumpfh( $fh );
+# close ($fh) or die $!;
+#
+# use POSIX;
+# POSIX::_exit(1);
+# }
+ }
+
+ if (! $quiet and !$leaks_found and ! $tb->in_todo) {
+ $tb->ok(1, sprintf "No leaks found at %s line %d", (caller())[1,2] );
}
}
else {
$tb->note("Auto checked $refs_traced references for leaks - none detected");
}
+
+# Disable this until better times - SQLT and probably other things
+# still load strictures. Let's just wait until Moo2.0 and go from there
+=begin for tears
+ # also while we are here and not in plain runmode: make sure we never
+ # loaded any of the strictures XS bullshit (it's a leak in a sense)
+ unless (DBICTest::RunMode->is_plain) {
+ for (qw(indirect multidimensional bareword::filehandles)) {
+ exists $INC{ Module::Runtime::module_notional_filename($_) }
+ and
+ $tb->ok(0, "$_ load apparently attempted!!!" )
+ }
+ }
+=cut
+
}
}
projects / dbsrgits/DBIx-Class.git / blobdiff