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