tools/llvm-link/llvm-link.cpp

   1 //===- llvm-link.cpp - Low-level LLVM linker ------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This utility may be invoked in the following manner:
  11 //  llvm-link a.bc b.bc c.bc -o x.bc
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/Module.h"
  16 #include "llvm/Analysis/Verifier.h"
  17 #include "llvm/Bytecode/Reader.h"
  18 #include "llvm/Bytecode/Writer.h"
  19 #include "llvm/Support/Linker.h"
  20 #include "llvm/Support/CommandLine.h"
  21 #include "llvm/System/Signals.h"
  22 #include "llvm/System/Path.h"
  23 #include <fstream>
  24 #include <iostream>
  25 #include <memory>
  26
  27 using namespace llvm;
  28
  29 static cl::list<std::string>
  30 InputFilenames(cl::Positional, cl::OneOrMore,
  31                cl::desc("<input bytecode files>"));
  32
  33 static cl::opt<std::string>
  34 OutputFilename("o", cl::desc("Override output filename"), cl::init("-"),
  35                cl::value_desc("filename"));
  36
  37 static cl::opt<bool> Force("f", cl::desc("Overwrite output files"));
  38
  39 static cl::opt<bool>
  40 Verbose("v", cl::desc("Print information about actions taken"));
  41
  42 static cl::opt<bool>
  43 DumpAsm("d", cl::desc("Print assembly as linked"), cl::Hidden);
  44
  45 static cl::list<std::string>
  46 LibPaths("L", cl::desc("Specify a library search path"), cl::ZeroOrMore,
  47          cl::value_desc("directory"), cl::Prefix);
  48
  49 // GetModule - This function is just factored out of the functions below
  50 static inline Module* GetModule(const sys::Path& Filename) {
  51   if (Verbose) std::cerr << "Loading '" << Filename.c_str() << "'\n";
  52   std::string ErrorMessage;
  53   if (Filename.exists()) {
  54     Module* Result = ParseBytecodeFile(Filename.get(), &ErrorMessage);
  55     if (Result) return Result;   // Load successful!
  56
  57     if (Verbose) {
  58       std::cerr << "Error opening bytecode file: '" << Filename.c_str() << "'";
  59       if (ErrorMessage.size()) std::cerr << ": " << ErrorMessage;
  60       std::cerr << "\n";
  61     }
  62   } else {
  63     std::cerr << "Bytecode file: '" << Filename.c_str()
  64               << "' does not exist.\n";
  65   }
  66   return 0;
  67 }
  68
  69 // LoadFile - Read the specified bytecode file in and return it.  This routine
  70 // searches the link path for the specified file to try to find it...
  71 //
  72 static inline std::auto_ptr<Module> LoadFile(const std::string &FN) {
  73   sys::Path Filename;
  74   if (!Filename.set_file(FN)) {
  75     std::cerr << "Invalid file name: '" << Filename.c_str() << "'\n";
  76     return std::auto_ptr<Module>();
  77   }
  78
  79   if (Module* Result = GetModule(Filename))
  80     return std::auto_ptr<Module>(Result);
  81
  82   bool FoundAFile = false;
  83
  84   for (unsigned i = 0; i < LibPaths.size(); i++) {
  85     if (!Filename.set_directory(LibPaths[i])) {
  86       std::cerr << "Invalid library path: '" << LibPaths[i] << "'\n";
  87     } else if (!Filename.append_file(FN)) {
  88       std::cerr << "Invalid library path: '" << LibPaths[i]
  89                 << "/" << FN.c_str() << "'\n";
  90     } else if (Filename.exists()) {
  91       FoundAFile = true;
  92       if (Module *Result = GetModule(Filename))
  93         return std::auto_ptr<Module>(Result);   // Load successful!
  94     }
  95   }
  96
  97   if (FoundAFile)
  98     std::cerr << "Bytecode file '" << FN << "' corrupt!  "
  99               << "Use 'llvm-link -v ...' for more info.\n";
 100   else
 101     std::cerr << "Could not locate bytecode file: '" << FN << "'\n";
 102   return std::auto_ptr<Module>();
 103 }
 104
 105 int main(int argc, char **argv) {
 106   cl::ParseCommandLineOptions(argc, argv, " llvm linker\n");
 107   sys::PrintStackTraceOnErrorSignal();
 108   assert(InputFilenames.size() > 0 && "OneOrMore is not working");
 109
 110   unsigned BaseArg = 0;
 111   std::string ErrorMessage;
 112
 113   std::auto_ptr<Module> Composite(LoadFile(InputFilenames[BaseArg]));
 114   if (Composite.get() == 0) return 1;
 115
 116   for (unsigned i = BaseArg+1; i < InputFilenames.size(); ++i) {
 117     std::auto_ptr<Module> M(LoadFile(InputFilenames[i]));
 118     if (M.get() == 0) return 1;
 119
 120     if (Verbose) std::cerr << "Linking in '" << InputFilenames[i] << "'\n";
 121
 122     if (LinkModules(Composite.get(), M.get(), &ErrorMessage)) {
 123       std::cerr << argv[0] << ": link error in '" << InputFilenames[i]
 124                 << "': " << ErrorMessage << "\n";
 125       return 1;
 126     }
 127   }
 128
 129   // TODO: Iterate over the -l list and link in any modules containing
 130   // global symbols that have not been resolved so far.
 131
 132   if (DumpAsm) std::cerr << "Here's the assembly:\n" << Composite.get();
 133
 134   std::ostream *Out = &std::cout;  // Default to printing to stdout...
 135   if (OutputFilename != "-") {
 136     if (!Force && std::ifstream(OutputFilename.c_str())) {
 137       // If force is not specified, make sure not to overwrite a file!
 138       std::cerr << argv[0] << ": error opening '" << OutputFilename
 139                 << "': file exists!\n"
 140                 << "Use -f command line argument to force output\n";
 141       return 1;
 142     }
 143     Out = new std::ofstream(OutputFilename.c_str());
 144     if (!Out->good()) {
 145       std::cerr << argv[0] << ": error opening '" << OutputFilename << "'!\n";
 146       return 1;
 147     }
 148
 149     // Make sure that the Out file gets unlinked from the disk if we get a
 150     // SIGINT
 151     sys::RemoveFileOnSignal(OutputFilename);
 152   }
 153
 154   if (verifyModule(*Composite.get())) {
 155     std::cerr << argv[0] << ": linked module is broken!\n";
 156     return 1;
 157   }
 158
 159   if (Verbose) std::cerr << "Writing bytecode...\n";
 160   WriteBytecodeToFile(Composite.get(), *Out);
 161
 162   if (Out != &std::cout) delete Out;
 163   return 0;
 164 }