my ($line, $memory);
my $debug_line = 0;
-my $total = 0;
+my $alloced = 0;
+my $leaked = 0;
+my $freed = 0;
my $max = 0;
+my $debug = 0;
+my $summary = 0;
+my $by_func = 0;
my @parsed;
my %cpu;
my $start_time = 0;
if (!defined($ARGV[0])) {
- print "No log file specified\n";
- exit
+ print "No log file specified\n";
+ print "Usage: leak_finder.pl <debug_file> [--option]\n";
+ print " --by-func show leak logs by function name in ascending order.\n";
+ print " --debug print more verbose debugging information.\n";
+ print " --summary implies --by-func, print a summary report by \n";
+ print " the number of total leak bytes of each function \n";
+ print " in ascending order in YAML format.\n";
+ exit
}
-open(INFILE, $ARGV[0]);
-while ($line = <INFILE>) {
- if ($line =~ m/^(.*)\((.*):(\d+):(.*)\(\)\)/) {
- @parsed = split(":", $1);
- if (substr ($parsed[2], -1, 1) eq "F") {
- chop $parsed[2];
- $cpu{$parsed[2]} = 0;
- } else {
- if (!defined($cpu{$parsed[2]})) {
- $cpu{$parsed[2]} = $parsed[3];
- }
- }
- }
+if (defined($ARGV[1]) and $ARGV[1] eq "--debug") {
+ $debug = 1;
}
-foreach $time (values %cpu) {
- if ($start_time < $time) {
- $start_time = $time;
- }
+if (defined($ARGV[1]) and $ARGV[1] eq "--summary") {
+ $summary = 1;
+ $by_func = 1;
}
-print "Starting analysis since $start_time\n";
+if (defined($ARGV[1]) and ($ARGV[1] eq "--by-func" || $ARGV[1] eq "--by_func")) {
+ $by_func = 1;
+}
+
+open(INFILE, $ARGV[0]);
+#while ($line = <INFILE>) {
+# if ($line =~ m/^(.*)\((.*):(\d+):(.*)\(\)\)/) {
+# @parsed = split(":", $1);
+# if (substr ($parsed[2], -1, 1) eq "F") {
+# chop $parsed[2];
+# $cpu{$parsed[2]} = 0;
+# } else {
+# if (!defined($cpu{$parsed[2]})) {
+# $cpu{$parsed[2]} = $parsed[3];
+# }
+# }
+# }
+#}
+#
+#foreach $time (values %cpu) {
+# if ($start_time < $time) {
+# $start_time = $time;
+# }
+#}
+#
+#print "Starting analysis since $start_time\n";
seek(INFILE, 0, 0);
while ($line = <INFILE>) {
$debug_line++;
+
my ($file, $func, $lno, $name, $size, $addr, $type);
- if ($line =~ m/^(.*)\((.*):(\d+):(.*)\(\)\) (k|v|slab-)(.*) '(.*)': (\d+) at ([\da-f]+)/){
- @parsed = split(":", $1);
- if ($parsed[3] <= $start_time) {
- next;
- }
-
+ # message format here needs to match OBD_ALLOC_POST()/OBD_FREE_PRE()
+ # mask:subs:cpu:epoch second.usec:?:pid:?:(filename:line:function_name())
+ # alloc-type 'var_name': size at memory_address.
+ if ($line =~ m/^(.*)\((.*):(\d+):(.*)\(\)\) (k[m]?|v[m]?|slab-|)(alloc(ed)?|free[d]?(_rcu)?) '(.*)': (\d+) at ([\da-f]+)/ ||
+ $line =~ m/^(.*)\((.*):(\d+):(.*)\(\)\) (k[m]?|v[m]?|slab-|)(alloc(ed)?|free[d]?(_rcu)?) '(.*)' of size (\d+) at ([\da-f]+)/) {
$file = $2;
$lno = $3;
$func = $4;
$type = $6;
- $name = $7;
- $size = $8;
+ $name = $9;
+ $size = $10;
+ $addr = $11;
+ } elsif ($line =~ m/^(.*)\((.*):(\d+):(.*)\(\)\) (slab-)(alloc(ed)?|free[d]?) '(.*)' at ([\da-f]+)/) {
+ $file = $2;
+ $lno = $3;
+ $func = $4;
+ $type = $6;
+ $name = $8;
+ $size = 0;
$addr = $9;
+ } elsif ($line =~ m/([ -]alloc(ed)? |[ -]free[d]? ).*at [0-9a-f]*/) {
+ # alloc/free line that didn't match regexp, notify user of missed line
+ print STDERR "Couldn't parse line $debug_line, script needs to be fixed:\n$line";
+ next;
+ } else {
+ # line not related to alloc/free, skip it silently
+ #print STDERR "Couldn't parse $line";
+ next;
+ }
- # we can't dump the log after portals has exited, so skip "leaks"
- # from memory freed in the portals module unloading.
- if ($func eq 'portals_handle_init') {
- next;
- }
+ # we can't dump the log after portals has exited, so skip "leaks"
+ # from memory freed in the portals module unloading.
+ if ($func =~ 'portals_handle_init') {
+ next;
+ }
+
+ if ($debug) {
+ print $line;
+ }
+ if ($summary == 0) {
printf("%8s %6d bytes at %s called %s (%s:%s:%d)\n", $type, $size,
$addr, $name, $file, $func, $lno);
- } else {
- next;
}
- if (index($type, 'alloced') >= 0) {
+ if (index($type, 'alloc') >= 0) {
if (defined($memory->{$addr})) {
- print STDERR "*** Two allocs with the same address ($size bytes at $addr, $file:$func:$lno)\n";
- print STDERR " first malloc at $memory->{$addr}->{file}:$memory->{$addr}->{func}:$memory->{$addr}->{lno}, second at $file:$func:$lno\n";
- next;
+ print STDOUT "*** Two allocs with the same address $addr\n";
+ print STDOUT " first malloc $memory->{$addr}->{size} bytes at $memory->{$addr}->{file}:$memory->{$addr}->{func}:$memory->{$addr}->{lno}, second $size bytes at $file:$func:$lno\n";
+ $memory->{$addr . "_a"} = $memory->{$addr};
}
$memory->{$addr}->{name} = $name;
$memory->{$addr}->{lno} = $lno;
$memory->{$addr}->{debug_line} = $debug_line;
- $total += $size;
- if ($total > $max) {
- $max = $total;
+ $alloced += $size;
+ if ($alloced > $max) {
+ $max = $alloced;
}
} else {
if (!defined($memory->{$addr})) {
- print STDERR "*** Free without malloc ($size bytes at $addr, $file:$func:$lno)\n";
+ if ($summary == 0) {
+ print STDOUT "*** Free without alloc ($size bytes at $addr, $file:$func:$lno)\n";
+ }
+ # offset addr to avoid alloc collision, shouldn't be multiple frees
+ $addr = $addr . "_f";
+ $memory->{$addr}->{name} = $name;
+ $memory->{$addr}->{size} = -$size;
+ $memory->{$addr}->{file} = $file;
+ $memory->{$addr}->{func} = $func;
+ $memory->{$addr}->{lno} = $lno;
+ $memory->{$addr}->{debug_line} = $debug_line;
+
+ $freed -= $size;
next;
}
my ($oldname, $oldsize, $oldfile, $oldfunc, $oldlno) = $memory->{$addr};
+ if ($size == 0) {
+ $size = $memory->{$addr}->{size};
+ }
if ($memory->{$addr}->{size} != $size) {
- print STDERR "*** Free different size ($memory->{$addr}->{size} alloced, $size freed).\n";
- print STDERR " malloc at $memory->{$addr}->{file}:$memory->{$addr}->{func}:$memory->{$addr}->{lno}, free at $file:$func:$lno\n";
+ print STDOUT "*** Free different size ($memory->{$addr}->{size} alloced, $size freed at $addr).\n";
+ print STDOUT " malloc at $memory->{$addr}->{file}:$memory->{$addr}->{func}:$memory->{$addr}->{lno}, free at $file:$func:$lno\n";
+
+ $freed -= $size;
next;
}
delete $memory->{$addr};
- $total -= $size;
+ $alloced -= $size;
}
}
close(INFILE);
-# Sort leak output by allocation time
+my $aa;
+my $bb;
my @sorted = sort {
- return $memory->{$a}->{debug_line} <=> $memory->{$b}->{debug_line};
+ if ($by_func) {
+ # Sort leak output by source code position
+ $aa = "$memory->{$a}->{func}:$memory->{$a}->{lno}:$memory->{$a}->{name}:$memory->{$a}->{size}";
+ $bb = "$memory->{$b}->{func}:$memory->{$b}->{lno}:$memory->{$b}->{name}:$memory->{$b}->{size}";
+ $aa cmp $bb;
+ } else {
+ # Sort leak output by allocation time
+ $memory->{$a}->{debug_line} <=> $memory->{$b}->{debug_line};
+ }
} keys(%{$memory});
+$aa = "";
+$bb = "";
my $key;
+my $leak_count = 1;
+my @records;
+my $leak_size = 0;
+my $leak_func;
+my $i = 0;
foreach $key (@sorted) {
- my ($oldname, $oldsize, $oldfile, $oldfunc, $oldlno) = $memory->{$key};
- print STDERR "*** Leak: $memory->{$key}->{size} bytes allocated at $key ($memory->{$key}->{file}:$memory->{$key}->{func}:$memory->{$key}->{lno}, debug file line $memory->{$key}->{debug_line})\n";
+ if ($summary) {
+ $aa = "$memory->{$key}->{func}:$memory->{$key}->{lno}:$memory->{$key}->{name}:$memory->{$key}->{size}";
+ if ($bb eq $aa) {
+ $leak_count++;
+ } elsif ($bb ne ""){
+ $records[$i]->{func} = $leak_func;
+ $records[$i]->{size} = $leak_size;
+ $records[$i]->{count} = $leak_count;
+ $records[$i]->{total} = $leak_count * $leak_size;;
+ $bb = $aa;
+ $i++;
+ $leak_count = 1;
+ } else {
+ $bb = $aa;
+ }
+ $leak_func = "$memory->{$key}->{func}:$memory->{$key}->{lno}:$memory->{$key}->{name}";
+ } else {
+ print STDOUT "*** Leak: $memory->{$key}->{size} bytes allocated at $key ($memory->{$key}->{file}:$memory->{$key}->{func}:$memory->{$key}->{lno}:$memory->{$key}->{name}, debug file line $memory->{$key}->{debug_line})\n";
+ }
+
+ $leak_size = $memory->{$key}->{size};
+ $leaked += $leak_size;
}
-print STDERR "maximum used: $max, amount leaked: $total\n";
+if ($summary) {
+ # print a summary report by total leak bytes in ASC order
+ my @sorted_records = sort {
+ $a->{total} <=> $b->{total};
+ } @records;
+ foreach $key (@sorted_records) {
+ printf("- { func: \"%-48s\", alloc_bytes: %-6d, leak_count: %-6d, leak_bytes: %-8d }\n",
+ $key->{func}, $key->{size}, $key->{count}, $key->{total});
+ }
+}
+print STDOUT "maximum_used: $max, total_alloc: $alloced, freed: $freed, leaked: $leaked\n";