Fix typo 'ompress' => 'compress'.
[oota-llvm.git] / tools / llvm-link / llvm-link.cpp
index 11000de9a719ab6b365221897a7f4f82201da405..a32b884e56a47fde043994fa130125ddbde4ff92 100644 (file)
+//===- llvm-link.cpp - Low-level LLVM linker ------------------------------===//
+// 
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// 
 //===----------------------------------------------------------------------===//
-// LLVM 'LINK' UTILITY 
 //
 // This utility may be invoked in the following manner:
-//  link a.bc b.bc c.bc -o x.bc
-//
-// Alternatively, this can be used as an 'ar' tool as well.  If invoked as
-// either 'ar' or 'llvm-ar', it accepts a 'rc' parameter as well.
+//  llvm-link a.bc b.bc c.bc -o x.bc
 //
 //===----------------------------------------------------------------------===//
 
-#include "llvm/Transforms/Utils/Linker.h"
+#include "llvm/Linker.h"
+#include "llvm/Module.h"
+#include "llvm/Analysis/Verifier.h"
 #include "llvm/Bytecode/Reader.h"
 #include "llvm/Bytecode/Writer.h"
-#include "llvm/Module.h"
-#include "Support/CommandLine.h"
-#include "Support/Signals.h"
+#include "llvm/Support/CommandLine.h"
+#include "llvm/System/Signals.h"
+#include "llvm/System/Path.h"
 #include <fstream>
+#include <iostream>
 #include <memory>
-#include <sys/types.h>     // For FileExists
-#include <sys/stat.h>
-
-
-cl::StringList InputFilenames("", "Load <arg> files, linking them together", 
-                             cl::OneOrMore);
-cl::String OutputFilename("o", "Override output filename", cl::NoFlags, "-");
-cl::Flag   Force         ("f", "Overwrite output files", cl::NoFlags, false);
-cl::Flag   Verbose       ("v", "Print information about actions taken");
-cl::Flag   DumpAsm       ("d", "Print assembly as linked", cl::Hidden, false);
-cl::StringList LibPaths  ("L", "Specify a library search path", cl::ZeroOrMore);
-
-// FileExists - Return true if the specified string is an openable file...
-static inline bool FileExists(const std::string &FN) {
-  struct stat StatBuf;
-  return stat(FN.c_str(), &StatBuf) != -1;
-}
+
+using namespace llvm;
+
+static cl::list<std::string>
+InputFilenames(cl::Positional, cl::OneOrMore,
+               cl::desc("<input bytecode files>"));
+
+static cl::opt<std::string>
+OutputFilename("o", cl::desc("Override output filename"), cl::init("-"),
+               cl::value_desc("filename"));
+
+static cl::opt<bool> Force("f", cl::desc("Overwrite output files"));
+
+static cl::opt<bool>
+Verbose("v", cl::desc("Print information about actions taken"));
+
+static cl::opt<bool>
+DumpAsm("d", cl::desc("Print assembly as linked"), cl::Hidden);
+
+static cl::opt<bool> NoCompress("disable-compression", cl::init(false),
+       cl::desc("Don't compress the generated bytecode"));
 
 // LoadFile - Read the specified bytecode file in and return it.  This routine
 // searches the link path for the specified file to try to find it...
 //
 static inline std::auto_ptr<Module> LoadFile(const std::string &FN) {
-  std::string Filename = FN;
-  std::string ErrorMessage;
-
-  unsigned NextLibPathIdx = 0;
-  bool FoundAFile = false;
+  sys::Path Filename;
+  if (!Filename.setFile(FN)) {
+    std::cerr << "Invalid file name: '" << FN << "'\n";
+    return std::auto_ptr<Module>();
+  }
 
-  while (1) {
-    if (Verbose) cerr << "Loading '" << Filename << "'\n";
-    if (FileExists(Filename)) FoundAFile = true;
-    Module *Result = ParseBytecodeFile(Filename, &ErrorMessage);
+  std::string ErrorMessage;
+  if (Filename.exists()) {
+    if (Verbose) std::cerr << "Loading '" << Filename.c_str() << "'\n";
+    Module* Result = ParseBytecodeFile(Filename.toString(), &ErrorMessage);
     if (Result) return std::auto_ptr<Module>(Result);   // Load successful!
 
     if (Verbose) {
-      cerr << "Error opening bytecode file: '" << Filename << "'";
-      if (ErrorMessage.size()) cerr << ": " << ErrorMessage;
-      cerr << "\n";
+      std::cerr << "Error opening bytecode file: '" << Filename.c_str() << "'";
+      if (ErrorMessage.size()) std::cerr << ": " << ErrorMessage;
+      std::cerr << "\n";
     }
-    
-    if (NextLibPathIdx == LibPaths.size()) break;
-    Filename = LibPaths[NextLibPathIdx++] + "/" + FN;
+  } else {
+    std::cerr << "Bytecode file: '" << Filename.c_str() 
+              << "' does not exist.\n";
   }
 
-  if (FoundAFile)
-    cerr << "Bytecode file '" << FN << "' corrupt!  "
-         << "Use 'link -v ...' for more info.\n";
-  else
-    cerr << "Could not locate bytecode file: '" << FN << "'\n";
   return std::auto_ptr<Module>();
 }
 
-
-
-
 int main(int argc, char **argv) {
-  cl::ParseCommandLineOptions(argc, argv, " llvm linker\n",
-                             cl::EnableSingleLetterArgValue |
-                             cl::DisableSingleLetterArgGrouping);
-  assert(InputFilenames.size() > 0 && "OneOrMore is not working");
-
-  unsigned BaseArg = 0;
-  std::string ErrorMessage;
-
-  // TODO: TEST argv[0] for llvm-ar forms... for now, this is a huge hack.
-  if (InputFilenames.size() >= 3 && InputFilenames[0] == "rc" &&
-      OutputFilename == "-") {
-    BaseArg = 2;
-    OutputFilename = InputFilenames[1];
-  }
-
-  std::auto_ptr<Module> Composite(LoadFile(InputFilenames[BaseArg]));
-  if (Composite.get() == 0) return 1;
-
-  for (unsigned i = BaseArg+1; i < InputFilenames.size(); ++i) {
-    std::auto_ptr<Module> M(LoadFile(InputFilenames[i]));
-    if (M.get() == 0) return 1;
-
-    if (Verbose) cerr << "Linking in '" << InputFilenames[i] << "'\n";
-
-    if (LinkModules(Composite.get(), M.get(), &ErrorMessage)) {
-      cerr << "Error linking in '" << InputFilenames[i] << "': "
-          << ErrorMessage << "\n";
+  try {
+    cl::ParseCommandLineOptions(argc, argv, " llvm linker\n");
+    sys::PrintStackTraceOnErrorSignal();
+    assert(InputFilenames.size() > 0 && "OneOrMore is not working");
+
+    unsigned BaseArg = 0;
+    std::string ErrorMessage;
+
+    std::auto_ptr<Module> Composite(LoadFile(InputFilenames[BaseArg]));
+    if (Composite.get() == 0) {
+      std::cerr << argv[0] << ": error loading file '"
+                << InputFilenames[BaseArg] << "'\n";
       return 1;
     }
-  }
 
-  if (DumpAsm) cerr << "Here's the assembly:\n" << Composite.get();
+    for (unsigned i = BaseArg+1; i < InputFilenames.size(); ++i) {
+      std::auto_ptr<Module> M(LoadFile(InputFilenames[i]));
+      if (M.get() == 0) {
+        std::cerr << argv[0] << ": error loading file '"
+                  << InputFilenames[i] << "'\n";
+        return 1;
+      }
+
+      if (Verbose) std::cerr << "Linking in '" << InputFilenames[i] << "'\n";
+
+      if (Linker::LinkModules(Composite.get(), M.get(), &ErrorMessage)) {
+        std::cerr << argv[0] << ": link error in '" << InputFilenames[i]
+                  << "': " << ErrorMessage << "\n";
+        return 1;
+      }
+    }
 
-  ostream *Out = &cout;  // Default to printing to stdout...
-  if (OutputFilename != "-") {
-    if (!Force && std::ifstream(OutputFilename.c_str())) {
-      // If force is not specified, make sure not to overwrite a file!
-      cerr << "Error opening '" << OutputFilename << "': File exists!\n"
-           << "Use -f command line argument to force output\n";
-      return 1;
+    // TODO: Iterate over the -l list and link in any modules containing
+    // global symbols that have not been resolved so far.
+
+    if (DumpAsm) std::cerr << "Here's the assembly:\n" << Composite.get();
+
+    std::ostream *Out = &std::cout;  // Default to printing to stdout...
+    if (OutputFilename != "-") {
+      if (!Force && std::ifstream(OutputFilename.c_str())) {
+        // If force is not specified, make sure not to overwrite a file!
+        std::cerr << argv[0] << ": error opening '" << OutputFilename
+                  << "': file exists!\n"
+                  << "Use -f command line argument to force output\n";
+        return 1;
+      }
+      Out = new std::ofstream(OutputFilename.c_str());
+      if (!Out->good()) {
+        std::cerr << argv[0] << ": error opening '" << OutputFilename << "'!\n";
+        return 1;
+      }
+
+      // Make sure that the Out file gets unlinked from the disk if we get a
+      // SIGINT
+      sys::RemoveFileOnSignal(sys::Path(OutputFilename));
     }
-    Out = new std::ofstream(OutputFilename.c_str());
-    if (!Out->good()) {
-      cerr << "Error opening '" << OutputFilename << "'!\n";
+
+    if (verifyModule(*Composite.get())) {
+      std::cerr << argv[0] << ": linked module is broken!\n";
       return 1;
     }
 
-    // Make sure that the Out file gets unlink'd from the disk if we get a
-    // SIGINT
-    RemoveFileOnSignal(OutputFilename);
-  }
-
-  if (Verbose) cerr << "Writing bytecode...\n";
-  WriteBytecodeToFile(Composite.get(), *Out);
+    if (Verbose) std::cerr << "Writing bytecode...\n";
+    WriteBytecodeToFile(Composite.get(), *Out, !NoCompress);
 
-  if (Out != &std::cout) delete Out;
-  return 0;
+    if (Out != &std::cout) delete Out;
+    return 0;
+  } catch (const std::string& msg) {
+    std::cerr << argv[0] << ": " << msg << "\n";
+  } catch (...) {
+    std::cerr << argv[0] << ": Unexpected unknown exception occurred.\n";
+  }
+  return 1;
 }