utils/GenLibDeps.pl

   1 #!/usr/bin/perl -w
   2 #
   3 # Program:  GenLibDeps.pl
   4 #
   5 # Synopsis: Generate HTML output that shows the dependencies between a set of
   6 #           libraries. The output of this script should periodically replace
   7 #           the similar content in the UsingLibraries.html document.
   8 #
   9 # Syntax:   GenLibDeps.pl [-flat] <directory_with_libraries_in_it>
  10 #
  11
  12 # Parse arguments...
  13 my $FLAT = 0;
  14 my $WHY = 0;
  15 while (scalar(@ARGV) and ($_ = $ARGV[0], /^[-+]/)) {
  16   shift;
  17   last if /^--$/;  # Stop processing arguments on --
  18
  19   # List command line options here...
  20   if (/^-flat$/)     { $FLAT = 1; next; }
  21   if (/^-why/)       { $WHY = 1; $FLAT = 1; next; }
  22   print "Unknown option: $_ : ignoring!\n";
  23 }
  24
  25 # Give first option a name.
  26 my $Directory = $ARGV[0];
  27
  28 # Find the "dot" program
  29 my $DotPath="";
  30 if (!$FLAT) {
  31   chomp($DotPath = `which dot`);
  32   die "Can't find 'dot'" if (! -x "$DotPath");
  33 }
  34
  35 chomp(my $nmPath=`which nm`);
  36 die "Can't find 'nm'" if (! -x "$nmPath");
  37
  38 # Open the directory and read its contents, sorting by name and differentiating
  39 # by whether its a library (.a) or an object file (.o)
  40 opendir DIR,$Directory;
  41 my @files = readdir DIR;
  42 closedir DIR;
  43 @libs = grep(/libLLVM.*\.a$/,sort(@files));
  44 @objs = grep(/LLVM.*\.o$/,sort(@files));
  45
  46 # Declare the hashes we will use to keep track of the library and object file
  47 # symbol definitions.
  48 my %libdefs;
  49 my %objdefs;
  50
  51 # Gather definitions from the libraries
  52 foreach $lib (@libs ) {
  53   open DEFS,
  54     "$nmPath -g $Directory/$lib | grep ' [ABCDGRST] ' | sed -e 's/^[0-9A-Fa-f]* [ABCDGRST] //' | sort | uniq |";
  55   while (<DEFS>) {
  56     chomp($_);
  57     $libdefs{$_} = $lib;
  58   }
  59   close DEFS;
  60 }
  61
  62 # Gather definitions from the object files.
  63 foreach $obj (@objs ) {
  64   open DEFS,
  65     "$nmPath -g $Directory/$obj | grep ' [ABCDGRST] ' | sed -e 's/^[0-9A-Fa-f]* [ABCDGRST] //' | sort | uniq |";
  66   while (<DEFS>) {
  67     chomp($_);
  68     $objdefs{$_} = $obj;
  69   }
  70   close DEFS;
  71 }
  72
  73 # Generate one entry in the <dl> list. This generates the <dt> and <dd> elements
  74 # for one library or object file. The <dt> provides the name of the library or
  75 # object. The <dd> provides a list of the libraries/objects it depends on.
  76 sub gen_one_entry {
  77   my $lib = $_[0];
  78   my $lib_ns = $lib;
  79   $lib_ns =~ s/(.*)\.[oa]/$1/;
  80   if ($FLAT) {
  81     print "$lib:";
  82     if ($WHY) { print "\n"; }
  83   } else {
  84     print "  <dt><b>$lib</b</dt><dd><ul>\n";
  85   }
  86   open UNDEFS,
  87     "$nmPath -g -u $Directory/$lib | sed -e 's/^  *U //' | sort | uniq |";
  88   my %DepLibs;
  89   while (<UNDEFS>) {
  90     chomp;
  91     my $lib_printed = 0;
  92     if (defined($libdefs{$_}) && $libdefs{$_} ne $lib) {
  93       $DepLibs{$libdefs{$_}} = [] unless exists $DepLibs{$libdefs{$_}};
  94       push(@{$DepLibs{$libdefs{$_}}}, $_);
  95     } elsif (defined($objdefs{$_}) && $objdefs{$_} ne $lib) {
  96       $libroot = $lib;
  97       $libroot =~ s/lib(.*).a/$1/;
  98       if ($objdefs{$_} ne "$libroot.o") {
  99         $DepLibs{$objdefs{$_}} = [] unless exists $DepLibs{$objdefs{$_}};
 100         push(@{$DepLibs{$objdefs{$_}}}, $_);
 101       }
 102     }
 103   }
 104   close UNDEFS;
 105   for my $key (sort keys %DepLibs) {
 106     if ($FLAT) {
 107       print " $key";
 108       if ($WHY) {
 109         print "\n";
 110         my @syms = @{$DepLibs{$key}};
 111         foreach $sym (@syms) {
 112           print "  $sym\n";
 113         }
 114       }
 115     } else {
 116       print "    <li>$key</li>\n";
 117     }
 118     $suffix = substr($key,length($key)-1,1);
 119     $key =~ s/(.*)\.[oa]/$1/;
 120     if ($suffix eq "a") {
 121       if (!$FLAT) { print DOT "$lib_ns -> $key [ weight=0 ];\n" };
 122     } else {
 123       if (!$FLAT) { print DOT "$lib_ns -> $key [ weight=10];\n" };
 124     }
 125   }
 126   if ($FLAT) {
 127     if (!$WHY) {
 128       print "\n";
 129     }
 130   } else {
 131     print "  </ul></dd>\n";
 132   }
 133 }
 134
 135 # Make sure we flush on write. This is slower but correct based on the way we
 136 # write I/O in gen_one_entry.
 137 $| = 1;
 138
 139 # Print the definition list tag
 140 if (!$FLAT) {
 141     print "<dl>\n";
 142
 143   open DOT, "| $DotPath -Tgif > libdeps.gif";
 144
 145   print DOT "digraph LibDeps {size=\"40,15\"; ratio=\"1.33333\"; margin=\"0.25\"; rankdir=\"LR\"; mclimit=\"50.0\"; ordering=\"out\"; center=\"1\";\n";
 146   print DOT "node [shape=\"box\",color=\"#000088\",fillcolor=\"#FFFACD\",fontcolor=\"#5577DD\",style=\"filled\",fontsize=\"24\"];\n";
 147   print DOT "edge [style=\"solid\",color=\"#000088\"];\n";
 148 }
 149
 150 # Print libraries first
 151 foreach $lib (@libs) {
 152   gen_one_entry($lib);
 153 }
 154
 155 if (!$FLAT) {
 156   print DOT "}\n";
 157   close DOT;
 158   open DOT, "| $DotPath -Tgif > objdeps.gif";
 159   print DOT "digraph ObjDeps {size=\"40,15\"; ratio=\"1.33333\"; margin=\"0.25\"; rankdir=\"LR\"; mclimit=\"50.0\"; ordering=\"out\"; center=\"1\";\n";
 160   print DOT "node [shape=\"box\",color=\"#000088\",fillcolor=\"#FFFACD\",fontcolor=\"#5577DD\",style=\"filled\",fontsize=\"24\"];\n";
 161   print DOT "edge [style=\"solid\",color=\"#000088\"];\n";
 162 }
 163
 164 # Print objects second
 165 foreach $obj (@objs) {
 166   gen_one_entry($obj);
 167 }
 168
 169 if (!$FLAT) {
 170   print DOT "}\n";
 171   close DOT;
 172
 173 # Print end tag of definition list element
 174   print "</dl>\n";
 175 }