blob: d5f179624640015445738f85e739beb0b88768b8 [file] [log] [blame]
#!/usr/bin/perl -w
#
# Program: GenLibDeps.pl
#
# Synopsis: Generate HTML output that shows the dependencies between a set of
# libraries. The output of this script should periodically replace
# the similar content in the UsingLibraries.html document.
#
# Syntax: GenLibDeps.pl <directory_with_libraries_in_it>
#
# Parse arguments...
while (scalar(@ARGV) and ($_ = $ARGV[0], /^[-+]/)) {
shift;
last if /^--$/; # Stop processing arguments on --
# List command line options here...
if (/^-flat$/) { $FLAT = 1; next; }
print "Unknown option: $_ : ignoring!\n";
}
# Give first option a name.
my $Directory = $ARGV[0];
# Find the "dot" program
chomp(my $DotPath = `which dot`);
die "Can't find 'dot'" if (! -x "$DotPath");
# Open the directory and read its contents, sorting by name and differentiating
# by whether its a library (.a) or an object file (.o)
opendir DIR,$Directory;
my @files = readdir DIR;
closedir DIR;
@libs = grep(/libLLVM.*\.a$/,sort(@files));
@objs = grep(/LLVM.*\.o$/,sort(@files));
# Declare the hashes we will use to keep track of the library and object file
# symbol definitions.
my %libdefs;
my %objdefs;
# Gather definitions from the libraries
foreach $lib (@libs ) {
open DEFS,
"nm -g --defined-only $Directory/$lib | grep ' [ABCDGRST] ' | sed -e 's/^[0-9A-Fa-f]* [ABCDGRST] //' | sort | uniq |";
while (<DEFS>) {
chomp($_);
$libdefs{$_} = $lib;
}
close DEFS;
}
# Gather definitions from the object files.
foreach $obj (@objs ) {
open DEFS,
"nm -g --defined-only $Directory/$obj | grep ' [ABCDGRST] ' | sed -e 's/^[0-9A-Fa-f]* [ABCDGRST] //' | sort | uniq |";
while (<DEFS>) {
chomp($_);
$objdefs{$_} = $obj;
}
close DEFS;
}
# Generate one entry in the <dl> list. This generates the <dt> and <dd> elements
# for one library or object file. The <dt> provides the name of the library or
# object. The <dd> provides a list of the libraries/objects it depends on.
sub gen_one_entry {
my $lib = $_[0];
my $lib_ns = $lib;
$lib_ns =~ s/(.*)\.[oa]/$1/;
if ($FLAT) {
print "$lib:";
} else {
print " <dt><b>$lib</b</dt><dd><ul>\n";
}
open UNDEFS,
"nm -u $Directory/$lib | grep ' U ' | sed -e 's/ U //' | sort | uniq |";
open DEPENDS,
"| sort | uniq > GenLibDeps.out";
while (<UNDEFS>) {
chomp;
if (defined($libdefs{$_}) && $libdefs{$_} ne $lib) {
print DEPENDS "$libdefs{$_}\n";
} elsif (defined($objdefs{$_}) && $objdefs{$_} ne $lib) {
$libroot = $lib;
$libroot =~ s/lib(.*).a/$1/;
if ($objdefs{$_} ne "$libroot.o") {
print DEPENDS "$objdefs{$_}\n";
}
}
}
close UNDEFS;
close DEPENDS;
open DF, "<GenLibDeps.out";
while (<DF>) {
chomp;
if ($FLAT) {
print " $_";
} else {
print " <li>$_</li>\n";
}
$suffix = substr($_,length($_)-1,1);
$_ =~ s/(.*)\.[oa]/$1/;
if ($suffix eq "a") {
print DOT "$lib_ns -> $_ [ weight=0 ];\n";
} else {
print DOT "$lib_ns -> $_ [ weight=10];\n";
}
}
close DF;
if ($FLAT) {
print "\n";
} else {
print " </ul></dd>\n";
}
}
# Make sure we flush on write. This is slower but correct based on the way we
# write I/O in gen_one_entry.
$| = 1;
# Print the definition list tag
if (!$FLAT) {
print "<dl>\n";
}
open DOT, "| $DotPath -Tgif > libdeps.gif";
print DOT "digraph LibDeps {size=\"40,15\"; ratio=\"1.33333\"; margin=\"0.25\"; rankdir=\"LR\"; mclimit=\"50.0\"; ordering=\"out\"; center=\"1\";\n";
print DOT "node [shape=\"box\",color=\"#000088\",fillcolor=\"#FFFACD\",fontcolor=\"#5577DD\",style=\"filled\",fontsize=\"24\"];\n";
print DOT "edge [style=\"solid\",color=\"#000088\"];\n";
# Print libraries first
foreach $lib (@libs) {
gen_one_entry($lib);
}
print DOT "}\n";
close DOT;
open DOT, "| $DotPath -Tgif > objdeps.gif";
print DOT "digraph ObjDeps {size=\"40,15\"; ratio=\"1.33333\"; margin=\"0.25\"; rankdir=\"LR\"; mclimit=\"50.0\"; ordering=\"out\"; center=\"1\";\n";
print DOT "node [shape=\"box\",color=\"#000088\",fillcolor=\"#FFFACD\",fontcolor=\"#5577DD\",style=\"filled\",fontsize=\"24\"];\n";
print DOT "edge [style=\"solid\",color=\"#000088\"];\n";
# Print objects second
foreach $obj (@objs) {
gen_one_entry($obj);
}
print DOT "}\n";
close DOT;
# Print end tag of definition list element
if (!$FLAT) {
print "</dl>\n";
}