[dbsrgits/DBIx-Class.git] / t / lib / DBICTest / Util / LeakTracer.pm

package DBICTest::Util::LeakTracer;

use warnings;
use strict;

use ANFANG;
use Carp;
use Scalar::Util qw(isweak weaken blessed reftype);
use DBIx::Class::_Util qw(refcount hrefaddr refdesc dump_value visit_namespaces);
use DBICTest::RunMode;
use DBICTest::Util 'stacktrace';
use constant {
  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 visit_refs);

my $refs_traced = 0;
my $leaks_found = 0;
my %reg_of_regs;

sub populate_weakregistry {
  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 = hrefaddr $target;

  # a registry could be fed to itself or another registry via recursive sweeps
  return $target if $reg_of_regs{$refaddr};

  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;
  }

  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 = 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;
}

# Regenerate the slots names on a thread spawn
sub DBICTest::__LeakTracer_iThreads_handler__::CLONE {
  my @individual_regs = grep { scalar keys %{$_||{}} } values %reg_of_regs;
  %reg_of_regs = ();

  for my $reg (@individual_regs) {
    my @live_slots = grep { defined $_->{weakref} } values %$reg
      or next;

    $reg = {};  # get a fresh hashref in the new thread ctx
    weaken( $reg_of_regs{hrefaddr($reg)} = $reg );

    for my $slot_info (@live_slots) {
      my $new_addr = hrefaddr $slot_info->{weakref};

      # 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}} };

      $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 {
  my $args = { (ref $_[0]) ? %{$_[0]} : @_ };

  $args->{seen_refs} ||= {};

  my $visited_cnt = '0E0';
  for my $i (0 .. $#{$args->{refs}} ) {

    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;

    # 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 $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 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] : 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 }
    or croak "Calling assert_empty_weakregistry in $0 without a loaded Test::Builder makes no sense";

  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 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++ unless $tb->in_todo;
    $tb->ok (0, "Expected garbage collection of $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__' : 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 });

    $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 $!;
#
#      require POSIX;
#      POSIX::_exit(1);
#    }
  }

  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'}
      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) {

      $tb->diag(sprintf
        "\n\n%s\n%s\n\nInstall Devel::FindRef and re-run the test with set "
      . '$ENV{TEST_VERBOSE} (prove -v) to see a more detailed leak-report'
      . "\n\n%s\n%s\n\n", ('#' x 16) x 4
      ) if ( !$ENV{TEST_VERBOSE} or !$INC{'Devel/FindRef.pm'} );

    }
    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!!!" )
      }
    }
  }
}

1;
Commit	Line	Data
218b7c12	1	package DBICTest::Util::LeakTracer;
	2
	3	use warnings;
	4	use strict;
	5
c0329273	6	use ANFANG;
218b7c12	7	use Carp;
96577657	8	use Scalar::Util qw(isweak weaken blessed reftype);
10be570e	9	use DBIx::Class::_Util qw(refcount hrefaddr refdesc dump_value visit_namespaces);
c0329273	10	use DBICTest::RunMode;
10be570e	11	use DBICTest::Util 'stacktrace';
556c4fe6	12	use constant {
18a2903b	13	CV_TRACING => !!(
	14	!DBICTest::RunMode->is_plain
	15	&&
	16	require DBIx::Class::Optional::Dependencies
	17	&&
	18	DBIx::Class::Optional::Dependencies->req_ok_for ('test_leaks_heavy')
	19	),
556c4fe6	20	};
218b7c12	21
218b7c12	22	use base 'Exporter';
bf302897	23	our @EXPORT_OK = qw(populate_weakregistry assert_empty_weakregistry visit_refs);
218b7c12	24
218b7c12	25	my $refs_traced = 0;
96577657	26	my $leaks_found = 0;
218b7c12	27	my %reg_of_regs;
	28
	29	sub populate_weakregistry {
96577657	30	my ($weak_registry, $target, $note) = @_;
218b7c12	31
	32	croak 'Expecting a registry hashref' unless ref $weak_registry eq 'HASH';
	33	croak 'Target is not a reference' unless length ref $target;
	34
96577657	35	my $refaddr = hrefaddr $target;
8fa57d17	36
96577657	37	# a registry could be fed to itself or another registry via recursive sweeps
96577657	38	return $target if $reg_of_regs{$refaddr};
218b7c12	39
85ad63df	40	weaken( $reg_of_regs{ hrefaddr($weak_registry) } = $weak_registry )
	41	unless( $reg_of_regs{ hrefaddr($weak_registry) } );
	42
	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->{$_}
	48	for keys %$reg;
	49	}
	50
7bba735d	51	return $target if (
	52	DBIx::Class::_ENV_::BROKEN_WEAK_SCALARREF_VALUES
	53	and
	54	ref $target eq 'SCALAR'
	55	);
	56
96577657	57	if (! defined $weak_registry->{$refaddr}{weakref}) {
7bba735d	58
7bba735d	59	# replace slot entirely
96577657	60	$weak_registry->{$refaddr} = {
8fa57d17	61	stacktrace => stacktrace(1),
96577657	62	weakref => $target,
8fa57d17	63	};
4841171c	64
7bba735d	65	weaken( $weak_registry->{$refaddr}{weakref} );
	66
	67	$refs_traced++;
218b7c12	68	}
218b7c12	69
8433421f	70	my $desc = refdesc $target;
96577657	71	$weak_registry->{$refaddr}{slot_names}{$desc} = 1;
	72	if ($note) {
	73	$note =~ s/\s\Q$desc\E\s//g;
	74	$weak_registry->{$refaddr}{slot_names}{$note} = 1;
	75	}
	76
218b7c12	77	$target;
	78	}
	79
96577657	80	# Regenerate the slots names on a thread spawn
04c1a070	81	sub DBICTest::__LeakTracer_iThreads_handler__::CLONE {
218b7c12	82	my @individual_regs = grep { scalar keys %{$_\|\|{}} } values %reg_of_regs;
	83	%reg_of_regs = ();
	84
	85	for my $reg (@individual_regs) {
96577657	86	my @live_slots = grep { defined $_->{weakref} } values %$reg
218b7c12	87	or next;
cf8fa286	88
cf8fa286	89	$reg = {}; # get a fresh hashref in the new thread ctx
96577657	90	weaken( $reg_of_regs{hrefaddr($reg)} = $reg );
218b7c12	91
96577657	92	for my $slot_info (@live_slots) {
96577657	93	my $new_addr = hrefaddr $slot_info->{weakref};
8fa57d17	94
96577657	95	# replace all slot names
	96	$slot_info->{slot_names} = { map {
	97	my $name = $_;
	98	$name =~ s/\(0x[0-9A-F]+\)/sprintf ('(%s)', $new_addr)/ieg;
	99	($name => 1);
	100	} keys %{$slot_info->{slot_names}} };
218b7c12	101
96577657	102	$reg->{$new_addr} = $slot_info;
218b7c12	103	}
218b7c12	104	}
d52fc26d	105
	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
	109	undef;
218b7c12	110	}
218b7c12	111
556c4fe6	112	sub visit_refs {
	113	my $args = { (ref $_[0]) ? %{$_[0]} : @_ };
	114
	115	$args->{seen_refs} \|\|= {};
	116
	117	my $visited_cnt = '0E0';
	118	for my $i (0 .. $#{$args->{refs}} ) {
556c4fe6	119
a42634cd	120	next unless length ref $args->{refs}[$i]; # not-a-ref
556c4fe6	121
a42634cd	122	my $addr = hrefaddr $args->{refs}[$i];
556c4fe6	123
6ae62c5c	124	# no diving into weakregistries
a42634cd	125	next if $reg_of_regs{$addr};
556c4fe6	126
a42634cd	127	next if $args->{seen_refs}{$addr}++;
556c4fe6	128	$visited_cnt++;
a42634cd	129
	130	my $r = $args->{refs}[$i];
	131
556c4fe6	132	$args->{action}->($r) or next;
556c4fe6	133
6ae62c5c	134	# This may end up being necessarry some day, but do not slow things
	135	# down for now
	136	#if ( defined( my $t = tied($r) ) ) {
	137	# $visited_cnt += visit_refs({ %$args, refs => [ $t ] });
	138	#}
	139
a42634cd	140	my $type = reftype $r;
a42634cd	141
5c33c8be	142	local $SIG{__DIE__} if $SIG{__DIE__};
7664b1a0	143	local $@;
7664b1a0	144	eval {
7664b1a0	145	if ($type eq 'HASH') {
	146	$visited_cnt += visit_refs({ %$args, refs => [ map {
	147	( !isweak($r->{$_}) ) ? $r->{$_} : ()
	148	} keys %$r ] });
	149	}
	150	elsif ($type eq 'ARRAY') {
	151	$visited_cnt += visit_refs({ %$args, refs => [ map {
	152	( !isweak($r->[$_]) ) ? $r->[$_] : ()
	153	} 0..$#$r ] });
	154	}
	155	elsif ($type eq 'REF' and !isweak($$r)) {
	156	$visited_cnt += visit_refs({ %$args, refs => [ $$r ] });
	157	}
	158	elsif (CV_TRACING and $type eq 'CODE') {
	159	$visited_cnt += visit_refs({ %$args, refs => [ map {
	160	( !isweak($_) ) ? $_ : ()
1a77219a	161	} values %{ scalar PadWalker::closed_over($r) } ] }); # scalar due to RT#92269
7664b1a0	162	}
7664b1a0	163	1;
8433421f	164	} or warn "Could not descend into @{[ refdesc $r ]}: $@\n";
556c4fe6	165	}
	166	$visited_cnt;
	167	}
	168
a42634cd	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 {
	172
	173	my $refs_per_pkg;
	174
a42634cd	175	my $seen_refs = {};
	176	visit_namespaces(
	177	action => sub {
556c4fe6	178
556c4fe6	179	no strict 'refs';
556c4fe6	180
a42634cd	181	my $pkg = shift;
a42634cd	182
556c4fe6	183	# the unless regex at the end skips some dangerous namespaces outright
556c4fe6	184	# (but does not prevent descent)
a42634cd	185	$refs_per_pkg->{$pkg} += visit_refs (
556c4fe6	186	seen_refs => $seen_refs,
a42634cd	187
1a77219a	188	action => sub { 1 },
a42634cd	189
556c4fe6	190	refs => [ map { my $sym = $_;
c9abd679	191	# *{"${pkg}::$sym"}{CODE} won't simply work - MRO-cached CVs are invisible there
c9abd679	192	( CV_TRACING ? Class::MethodCache::get_cv("${pkg}::$sym") : () ),
556c4fe6	193
c9abd679	194	( defined *{"${pkg}::$sym"}{SCALAR} and length ref ${"${pkg}::$sym"} and ! isweak( ${"${pkg}::$sym"} ) )
c9abd679	195	? ${"${pkg}::$sym"} : ()
556c4fe6	196	,
a42634cd	197
556c4fe6	198	( map {
c9abd679	199	( defined {"${pkg}::$sym"}{$_} and ! isweak(defined {"${pkg}::$sym"}{$_}) )
c9abd679	200	? *{"${pkg}::$sym"}{$_}
556c4fe6	201	: ()
556c4fe6	202	} qw(HASH ARRAY IO GLOB) ),
a42634cd	203
c9abd679	204	} keys %{"${pkg}::"} ],
c9abd679	205	) unless $pkg =~ /^ (?:
556c4fe6	206	DB \| next \| B \| .+? ::::ISA (?: ::CACHE ) \| Class::C3
c9abd679	207	) $/x;
a42634cd	208	}
a42634cd	209	);
556c4fe6	210
a42634cd	211	# use Devel::Dwarn;
	212	# Ddie [ map
	213	# { { $_ => $refs_per_pkg->{$_} } }
	214	# sort
	215	# {$refs_per_pkg->{$a} <=> $refs_per_pkg->{$b} }
	216	# keys %$refs_per_pkg
	217	# ];
	218
	219	$seen_refs;
	220	}
	221
	222	sub assert_empty_weakregistry {
	223	my ($weak_registry, $quiet) = @_;
	224
	225	# in case we hooked bless any extra object creation will wreak
	226	# havoc during the assert phase
	227	local *CORE::GLOBAL::bless;
821edc09	228	*CORE::GLOBAL::bless = sub { CORE::bless( $_[0], (@_ > 1) ? $_[1] : CORE::caller() ) };
a42634cd	229
	230	croak 'Expecting a registry hashref' unless ref $weak_registry eq 'HASH';
	231
	232	defined $weak_registry->{$_}{weakref} or delete $weak_registry->{$_}
	233	for keys %$weak_registry;
	234
	235	return unless keys %$weak_registry;
8fa57d17	236
a42634cd	237	my $tb = eval { Test::Builder->new }
a42634cd	238	or croak "Calling assert_empty_weakregistry in $0 without a loaded Test::Builder makes no sense";
8fa57d17	239
a42634cd	240	for my $addr (keys %$weak_registry) {
	241	$weak_registry->{$addr}{display_name} = join ' \| ', (
	242	sort
	243	{ length $a <=> length $b or $a cmp $b }
	244	keys %{$weak_registry->{$addr}{slot_names}}
	245	);
	246
	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} );
	249	}
	250
8d73fcd4	251	# the symtable walk is very expensive
8d73fcd4	252	# if we are $quiet (running in an END block) we do not really need to be
dc715747	253	# that thorough - can get by with our own registry
8d73fcd4	254	delete $weak_registry->{$_} for $quiet
	255	? do {
	256	my $refs = {};
	257	visit_refs (
	258	# only look at the closed over stuffs
dc715747	259	refs => [ values %DBIx::Class::_Util::refs_closed_over_by_quote_sub_installed_crefs ],
8d73fcd4	260	seen_refs => $refs,
	261	action => sub { 1 },
	262	);
	263	keys %$refs;
	264	}
	265	: (
	266	# full sumtable walk, starting from ::
	267	keys %{ symtable_referenced_addresses() }
	268	)
	269	;
556c4fe6	270
96577657	271	for my $addr (sort { $weak_registry->{$a}{display_name} cmp $weak_registry->{$b}{display_name} } keys %$weak_registry) {
96577657	272
1a44a267	273	next if ! defined $weak_registry->{$addr}{weakref};
1a44a267	274
5dc4301c	275	$leaks_found++ unless $tb->in_todo;
ee20ecfc	276	$tb->ok (0, "Expected garbage collection of $weak_registry->{$addr}{display_name}");
1a44a267	277
	278	my $diag = do {
	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}),
	283	(
	284	ref($weak_registry->{$addr}{weakref}) eq 'CODE'
	285	and
	286	B::svref_2object($weak_registry->{$addr}{weakref})->XSUB
8fc4291e	287	) ? '__XSUB__' : dump_value $weak_registry->{$addr}{weakref}
1a44a267	288	;
218b7c12	289	};
1a44a267	290
5dc4301c	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)
	293
556c4fe6	294	$diag .= Devel::FindRef::track ($weak_registry->{$addr}{weakref}, 50) . "\n"
1a44a267	295	if ( $ENV{TEST_VERBOSE} && eval { require Devel::FindRef });
	296
	297	$diag =~ s/^/ /mg;
	298
	299	if (my $stack = $weak_registry->{$addr}{stacktrace}) {
	300	$diag .= " Reference first seen$stack";
	301	}
	302
	303	$tb->diag($diag);
6ae62c5c	304
	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 $!;
	313	#
47603d6c	314	# require POSIX;
6ae62c5c	315	# POSIX::_exit(1);
6ae62c5c	316	# }
1a44a267	317	}
1a44a267	318
5dc4301c	319	if (! $quiet and !$leaks_found and ! $tb->in_todo) {
821edc09	320	$tb->ok(1, sprintf "No leaks found at %s line %d", (CORE::caller())[1,2] );
218b7c12	321	}
	322	}
	323
	324	END {
b77a61d8	325	if (
	326	$INC{'Test/Builder.pm'}
	327	and
	328	my $tb = do {
	329	local $@;
	330	my $t = eval { Test::Builder->new }
	331	or warn "Test::Builder->new failed:\n$@\n";
	332	$t;
	333	}
	334	) {
218b7c12	335	# we check for test passage - a leak may be a part of a TODO
	336	if ($leaks_found and !$tb->is_passing) {
	337
	338	$tb->diag(sprintf
	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'} );
	343
	344	}
	345	else {
	346	$tb->note("Auto checked $refs_traced references for leaks - none detected");
	347	}
cbd7f87a	348
cbd7f87a	349	# also while we are here and not in plain runmode: make sure we never
cbd7f87a	350	# loaded any of the strictures XS bullshit (it's a leak in a sense)
0020e364	351	unless (
	352	$ENV{MOO_FATAL_WARNINGS}
	353	or
	354	# FIXME - SQLT loads strictures explicitly, /facedesk
	355	# remove this INC check when 0fb58589 and 45287c815 are rectified
	356	$INC{'SQL/Translator.pm'}
	357	or
	358	DBICTest::RunMode->is_plain
	359	) {
cbd7f87a	360	for (qw(indirect multidimensional bareword::filehandles)) {
	361	exists $INC{ Module::Runtime::module_notional_filename($_) }
	362	and
ee20ecfc	363	$tb->ok(0, "$_ load should not have been attempted!!!" )
cbd7f87a	364	}
cbd7f87a	365	}
218b7c12	366	}
	367	}
	368
	369	1;