Add an "implies" field to features. This indicates that, if the current
[oota-llvm.git] / utils / GenLibDeps.pl
index 60c291d9456cdf1157f5aa06b743dbf2ffdd1280..419d8f92d866d62cf43d074f8d702a8cbfa924f7 100755 (executable)
@@ -6,28 +6,42 @@
 #           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>
+# Syntax:   GenLibDeps.pl [-flat] <directory_with_libraries_in_it> [path_to_nm_binary]
 #
 
 # Parse arguments... 
+my $FLAT = 0;
+my $WHY = 0;
 while (scalar(@ARGV) and ($_ = $ARGV[0], /^[-+]/)) {
   shift;
   last if /^--$/;  # Stop processing arguments on --
 
   # List command line options here...
   if (/^-flat$/)     { $FLAT = 1; next; }
+  if (/^-why/)       { $WHY = 1; $FLAT = 1; next; }
   print "Unknown option: $_ : ignoring!\n";
 }
 
 # Give first option a name.
 my $Directory = $ARGV[0];
+if (!defined($Directory) || ! -d "$Directory") {
+  die "First argument must specify the directory containing LLVM libs\n";
+}
+
+my $nmPath = $ARGV[1];
 
 # Find the "dot" program
+my $DotPath="";
 if (!$FLAT) {
-  chomp(my $DotPath = `which dot`);
+  chomp($DotPath = `which dot`);
   die "Can't find 'dot'" if (! -x "$DotPath");
 }
 
+if (!defined($nmPath) || $nmPath eq "") {
+  chomp($nmPath=`which nm`);
+  die "Can't find 'nm'" if (! -x "$nmPath");
+}
+
 # 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;
@@ -44,7 +58,7 @@ my %objdefs;
 # Gather definitions from the libraries
 foreach $lib (@libs ) {
   open DEFS, 
-    "nm -g $Directory/$lib | grep ' [ABCDGRST] ' | sed -e 's/^[0-9A-Fa-f]* [ABCDGRST] //' | sort | uniq |";
+    "$nmPath -g $Directory/$lib | grep ' [ABCDGRST] ' | sed -e 's/^[0-9A-Fa-f]* [ABCDGRST] //' | sort | uniq |";
   while (<DEFS>) {
     chomp($_);
     $libdefs{$_} = $lib;
@@ -55,7 +69,7 @@ foreach $lib (@libs ) {
 # Gather definitions from the object files.
 foreach $obj (@objs ) {
   open DEFS, 
-    "nm -g $Directory/$obj | grep ' [ABCDGRST] ' | sed -e 's/^[0-9A-Fa-f]* [ABCDGRST] //' | sort | uniq |";
+    "$nmPath -g $Directory/$obj | grep ' [ABCDGRST] ' | sed -e 's/^[0-9A-Fa-f]* [ABCDGRST] //' | sort | uniq |";
   while (<DEFS>) {
     chomp($_);
     $objdefs{$_} = $obj;
@@ -72,46 +86,54 @@ sub gen_one_entry {
   $lib_ns =~ s/(.*)\.[oa]/$1/;
   if ($FLAT) {
     print "$lib:";
+    if ($WHY) { print "\n"; }
   } else {
     print "  <dt><b>$lib</b</dt><dd><ul>\n";
   }
   open UNDEFS, 
-    "nm -g -u $Directory/$lib | grep ' U ' | sed -e 's/         U //' | sort | uniq |";
-  open DEPENDS,
-    "| sort | uniq > GenLibDeps.out";
+    "$nmPath -g -u $Directory/$lib | sed -e 's/^  *U //' | sort | uniq |";
+  my %DepLibs;
   while (<UNDEFS>) {
     chomp;
+    my $lib_printed = 0;
     if (defined($libdefs{$_}) && $libdefs{$_} ne $lib) {
-      print DEPENDS "$libdefs{$_}\n";
+      $DepLibs{$libdefs{$_}} = [] unless exists $DepLibs{$libdefs{$_}};
+      push(@{$DepLibs{$libdefs{$_}}}, $_);
     } elsif (defined($objdefs{$_}) && $objdefs{$_} ne $lib) {
       $libroot = $lib;
       $libroot =~ s/lib(.*).a/$1/;
       if ($objdefs{$_} ne "$libroot.o") {
-        print DEPENDS "$objdefs{$_}\n";
+        $DepLibs{$objdefs{$_}} = [] unless exists $DepLibs{$objdefs{$_}};
+        push(@{$DepLibs{$objdefs{$_}}}, $_);
       }
     }
   }
   close UNDEFS;
-  close DEPENDS;
-  open DF, "<GenLibDeps.out";
-  while (<DF>) {
-    chomp;
+  for my $key (sort keys %DepLibs) {
     if ($FLAT) {
-      print " $_";
+      print " $key";
+      if ($WHY) {
+        print "\n";
+        my @syms = @{$DepLibs{$key}};
+        foreach $sym (@syms) {
+          print "  $sym\n";
+        }
+      }
     } else {
-      print "    <li>$_</li>\n";
+      print "    <li>$key</li>\n";
     }
-    $suffix = substr($_,length($_)-1,1);
-    $_ =~ s/(.*)\.[oa]/$1/;
+    $suffix = substr($key,length($key)-1,1);
+    $key =~ s/(.*)\.[oa]/$1/;
     if ($suffix eq "a") {
-      if (!$FLAT) { print DOT "$lib_ns -> $_ [ weight=0 ];\n" };
+      if (!$FLAT) { print DOT "$lib_ns -> $key [ weight=0 ];\n" };
     } else {
-      if (!$FLAT) { print DOT "$lib_ns -> $_ [ weight=10];\n" };
+      if (!$FLAT) { print DOT "$lib_ns -> $key [ weight=10];\n" };
     }
   }
-  close DF;
   if ($FLAT) {
-    print "\n";
+    if (!$WHY) {
+      print "\n";
+    }
   } else {
     print "  </ul></dd>\n";
   }
@@ -127,9 +149,23 @@ if (!$FLAT) {
 
   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 DOT "digraph LibDeps {\n";
+  print DOT "  size=\"40,15\"; \n";
+  print DOT "  ratio=\"1.33333\"; \n";
+  print DOT "  margin=\"0.25\"; \n";
+  print DOT "  rankdir=\"LR\"; \n";
+  print DOT "  mclimit=\"50.0\"; \n";
+  print DOT "  ordering=\"out\"; \n";
+  print DOT "  center=\"1\";\n";
+  print DOT "node [shape=\"box\",\n";
+  print DOT "      color=\"#000088\",\n";
+  print DOT "      fillcolor=\"#FFFACD\",\n";
+  print DOT "      fontcolor=\"#3355BB\",\n";
+  print DOT "      style=\"filled\",\n";
+  print DOT "      fontname=\"sans\",\n";
+  print DOT "      fontsize=\"24\"\n";
+  print DOT "];\n";
+  print DOT "edge [dir=\"forward\",style=\"solid\",color=\"#000088\"];\n";
 }
 
 # Print libraries first
@@ -141,9 +177,22 @@ if (!$FLAT) {
   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 DOT "digraph ObjDeps {\n";
+  print DOT "  size=\"8,10\";\n";
+  print DOT "  margin=\"0.25\";\n";
+  print DOT "  rankdir=\"LR\";\n";
+  print DOT "  mclimit=\"50.0\";\n";
+  print DOT "  ordering=\"out\";\n";
+  print DOT "  center=\"1\";\n";
+  print DOT "node [shape=\"box\",\n";
+  print DOT "      color=\"#000088\",\n";
+  print DOT "      fillcolor=\"#FFFACD\",\n";
+  print DOT "      fontcolor=\"#3355BB\",\n";
+  print DOT "      fontname=\"sans\",\n";
+  print DOT "      style=\"filled\",\n";
+  print DOT "      fontsize=\"24\"\n";
+  print DOT "];\n";
+  print DOT "edge [dir=\"forward\",style=\"solid\",color=\"#000088\"];\n";
 }
 
 # Print objects second