X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=t%2Flib%2FDBICTest%2FUtil%2FLeakTracer.pm;h=49621ebc08c7c4b84fcb9311343cf23e4ad9fce7;hb=bced0adbd0c36588cbe2665bbba353a7445f0b79;hp=600a66797208e92e7373993c608a2ef1a71d9166;hpb=21aa86aae083ccb5b94ba994dec030627e95e40b;p=dbsrgits%2FDBIx-Class-Historic.git

diff --git a/t/lib/DBICTest/Util/LeakTracer.pm b/t/lib/DBICTest/Util/LeakTracer.pm
index 600a667..49621eb 100644
--- a/t/lib/DBICTest/Util/LeakTracer.pm
+++ b/t/lib/DBICTest/Util/LeakTracer.pm
@@ -3,34 +3,29 @@ package DBICTest::Util::LeakTracer;
 use warnings;
 use strict;
 
+use ANFANG;
 use Carp;
 use Scalar::Util qw(isweak weaken blessed reftype);
-use DBIx::Class::_Util 'refcount';
-use DBIx::Class::Optional::Dependencies;
-use Data::Dumper::Concise;
+use DBIx::Class::_Util qw(refcount hrefaddr refdesc dump_value visit_namespaces);
+use DBICTest::RunMode;
 use DBICTest::Util 'stacktrace';
 use constant {
-  CV_TRACING => DBIx::Class::Optional::Dependencies->req_ok_for ('test_leaks_heavy'),
+  CV_TRACING => !!(
+    !DBICTest::RunMode->is_plain
+      &&
+    require DBIx::Class::Optional::Dependencies
+      &&
+    DBIx::Class::Optional::Dependencies->req_ok_for ('test_leaks_heavy')
+  ),
 };
 
 use base 'Exporter';
-our @EXPORT_OK = qw(populate_weakregistry assert_empty_weakregistry hrefaddr visit_refs);
+our @EXPORT_OK = qw(populate_weakregistry assert_empty_weakregistry visit_refs);
 
 my $refs_traced = 0;
 my $leaks_found = 0;
 my %reg_of_regs;
 
-sub hrefaddr { sprintf '0x%x', &Scalar::Util::refaddr }
-
-# so we don't trigger stringification
-sub _describe_ref {
-  sprintf '%s%s(%s)',
-    (defined blessed $_[0]) ? blessed($_[0]) . '=' : '',
-    reftype $_[0],
-    hrefaddr $_[0],
-  ;
-}
-
 sub populate_weakregistry {
   my ($weak_registry, $target, $note) = @_;
 
@@ -53,16 +48,26 @@ sub populate_weakregistry {
       for keys %$reg;
   }
 
+  return $target if (
+    DBIx::Class::_ENV_::BROKEN_WEAK_SCALARREF_VALUES
+      and
+    ref $target eq 'SCALAR'
+  );
+
   if (! defined $weak_registry->{$refaddr}{weakref}) {
+
+    # replace slot entirely
     $weak_registry->{$refaddr} = {
       stacktrace => stacktrace(1),
       weakref => $target,
     };
+
     weaken( $weak_registry->{$refaddr}{weakref} );
+
     $refs_traced++;
   }
 
-  my $desc = _describe_ref($target);
+  my $desc = refdesc $target;
   $weak_registry->{$refaddr}{slot_names}{$desc} = 1;
   if ($note) {
     $note =~ s/\s*\Q$desc\E\s*//g;
@@ -73,7 +78,7 @@ sub populate_weakregistry {
 }
 
 # Regenerate the slots names on a thread spawn
-sub CLONE {
+sub DBICTest::__LeakTracer_iThreads_handler__::CLONE {
   my @individual_regs = grep { scalar keys %{$_||{}} } values %reg_of_regs;
   %reg_of_regs = ();
 
@@ -97,6 +102,11 @@ sub CLONE {
       $reg->{$new_addr} = $slot_info;
     }
   }
+
+  # Dummy NEXTSTATE ensuring the all temporaries on the stack are garbage
+  # collected before leaving this scope. Depending on the code above, this
+  # may very well be just a preventive measure guarding future modifications
+  undef;
 }
 
 sub visit_refs {
@@ -106,50 +116,131 @@ sub visit_refs {
 
   my $visited_cnt = '0E0';
   for my $i (0 .. $#{$args->{refs}} ) {
-    next if isweak($args->{refs}[$i]);
 
-    my $r = $args->{refs}[$i];
+    next unless length ref $args->{refs}[$i]; # not-a-ref
 
-    next unless length ref $r;
+    my $addr = hrefaddr $args->{refs}[$i];
 
-    next if $args->{seen_refs}{my $dec_addr = Scalar::Util::refaddr($r)}++;
+    # 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;
 
+    # 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;
-    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
-    }
+
+    local $SIG{__DIE__} if $SIG{__DIE__};
+    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($_) ) ? $_ : ()
+        } values %{ scalar PadWalker::closed_over($r) } ] }); # scalar due to RT#92269
+      }
+      1;
+    } or (
+      # this is some bizarre old DBI autosplit thing, no point mentioning it
+      $@ !~ m{ ^Can't \s locate \s (?:
+        auto/DBI/FIRSTKEY.al
+          |
+        \Qobject method "FIRSTKEY" via package "DBI"\E
+      )}x
+        and
+      warn "Could not descend into @{[ refdesc $r ]}: $@\n"
+    );
   }
   $visited_cnt;
 }
 
+# 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 {
+
+  my $refs_per_pkg;
+
+  my $seen_refs = {};
+  visit_namespaces(
+    action => sub {
+
+      no strict 'refs';
+
+      my $pkg = shift;
+
+      # 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,
+
+        action => sub { 1 },
+
+        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;
+}
+
 sub assert_empty_weakregistry {
   my ($weak_registry, $quiet) = @_;
 
   # 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() ) };
+  *CORE::GLOBAL::bless = sub { CORE::bless( $_[0], (@_ > 1) ? $_[1] : CORE::caller() ) };
 
   croak 'Expecting a registry hashref' unless ref $weak_registry eq 'HASH';
 
+  defined $weak_registry->{$_}{weakref} or delete $weak_registry->{$_}
+    for keys %$weak_registry;
+
   return unless keys %$weak_registry;
 
   my $tb = eval { Test::Builder->new }
@@ -166,65 +257,32 @@ sub assert_empty_weakregistry {
       if defined $weak_registry->{$addr}{weakref} and ! isweak( $weak_registry->{$addr}{weakref} );
   }
 
-  # compile a list of refs stored as globals (possibly even catching
-  # class data in the form of method closures), so we can skip them
-  # further on
-  my ($seen_refs, $classdata_refs) = ({}, undef);
-
-  # the walk is very expensive - if we are $quiet (running in an END block)
-  # we do not really need to be too thorough
-  unless ($quiet) {
-    my ($symwalker, $symcounts);
-    $symwalker = sub {
-      no strict 'refs';
-      my $pkg = shift || '::';
-
-      # any non-weak globals are "clasdata" in all possible sense
-      #
-      # the unless regex at the end skips some dangerous namespaces outright
-      # (but does not prevent descent)
-      $symcounts->{$pkg} += visit_refs (
-        seen_refs => $seen_refs,
-        action => sub { ++$classdata_refs->{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;
-
-      $symwalker->("${pkg}$_") for grep { $_ =~ /(?<!^main)::$/ } keys %$pkg;
-    };
-
-    $symwalker->();
-
-#    use Devel::Dwarn;
-#    Ddie [ map
-#      { { $_ => $symcounts->{$_} } }
-#      sort
-#        {$symcounts->{$a} <=> $symcounts->{$b} }
-#        keys %$symcounts
-#    ];
-  }
-
-  delete $weak_registry->{$_} for keys %$classdata_refs;
+  # 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 our own registry
+  delete $weak_registry->{$_} for $quiet
+    ? do {
+      my $refs = {};
+      visit_refs (
+        # only look at the closed over stuffs
+        refs => [ values %DBIx::Class::_Util::refs_closed_over_by_quote_sub_installed_crefs ],
+        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++;
-    $tb->ok (0, "Leaked $weak_registry->{$addr}{display_name}");
+    $leaks_found++ unless $tb->in_todo;
+    $tb->ok (0, "Expected garbage collection of $weak_registry->{$addr}{display_name}");
 
     my $diag = do {
       local $Data::Dumper::Maxdepth = 1;
@@ -235,10 +293,13 @@ sub assert_empty_weakregistry {
           ref($weak_registry->{$addr}{weakref}) eq 'CODE'
             and
           B::svref_2object($weak_registry->{$addr}{weakref})->XSUB
-        ) ? '__XSUB__' : Dumper( $weak_registry->{$addr}{weakref} )
+        ) ? '__XSUB__' : dump_value $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 });
 
@@ -249,17 +310,37 @@ sub assert_empty_weakregistry {
     }
 
     $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 $!;
+#
+#      require POSIX;
+#      POSIX::_exit(1);
+#    }
   }
 
-  if (! $quiet and ! $leaks_found) {
-    $tb->ok(1, sprintf "No leaks found at %s line %d", (caller())[1,2] );
+  if (! $quiet and !$leaks_found and ! $tb->in_todo) {
+    $tb->ok(1, sprintf "No leaks found at %s line %d", (CORE::caller())[1,2] );
   }
 }
 
 END {
-  if ($INC{'Test/Builder.pm'}) {
-    my $tb = Test::Builder->new;
-
+  if (
+    $INC{'Test/Builder.pm'}
+      and
+    my $tb = do {
+      local $@;
+      my $t = eval { Test::Builder->new }
+        or warn "Test::Builder->new failed:\n$@\n";
+      $t;
+    }
+  ) {
     # we check for test passage - a leak may be a part of a TODO
     if ($leaks_found and !$tb->is_passing) {
 
@@ -273,6 +354,24 @@ END {
     else {
       $tb->note("Auto checked $refs_traced references for leaks - none detected");
     }
+
+    # 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 (
+      $ENV{MOO_FATAL_WARNINGS}
+        or
+      # FIXME - SQLT loads strictures explicitly, /facedesk
+      # remove this INC check when 0fb58589 and 45287c815 are rectified
+      $INC{'SQL/Translator.pm'}
+        or
+      DBICTest::RunMode->is_plain
+    ) {
+      for (qw(indirect multidimensional bareword::filehandles)) {
+        exists $INC{ Module::Runtime::module_notional_filename($_) }
+          and
+        $tb->ok(0, "$_ load should not have been attempted!!!" )
+      }
+    }
   }
 }