tools/llvm-link/llvm-link.cpp

   1 //===- llvm-link.cpp - Low-level LLVM linker ------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // 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/Linker/Linker.h"
  16 #include "llvm/ADT/STLExtras.h"
  17 #include "llvm/Bitcode/ReaderWriter.h"
  18 #include "llvm/IR/DiagnosticInfo.h"
  19 #include "llvm/IR/DiagnosticPrinter.h"
  20 #include "llvm/IR/LLVMContext.h"
  21 #include "llvm/IR/Module.h"
  22 #include "llvm/IR/Verifier.h"
  23 #include "llvm/IRReader/IRReader.h"
  24 #include "llvm/Support/CommandLine.h"
  25 #include "llvm/Support/FileSystem.h"
  26 #include "llvm/Support/ManagedStatic.h"
  27 #include "llvm/Support/Path.h"
  28 #include "llvm/Support/PrettyStackTrace.h"
  29 #include "llvm/Support/Signals.h"
  30 #include "llvm/Support/SourceMgr.h"
  31 #include "llvm/Support/SystemUtils.h"
  32 #include "llvm/Support/ToolOutputFile.h"
  33 #include <memory>
  34 using namespace llvm;
  35
  36 static cl::list<std::string>
  37 InputFilenames(cl::Positional, cl::OneOrMore,
  38                cl::desc("<input bitcode files>"));
  39
  40 static cl::opt<std::string>
  41 OutputFilename("o", cl::desc("Override output filename"), cl::init("-"),
  42                cl::value_desc("filename"));
  43
  44 static cl::opt<bool>
  45 Force("f", cl::desc("Enable binary output on terminals"));
  46
  47 static cl::opt<bool>
  48 OutputAssembly("S",
  49          cl::desc("Write output as LLVM assembly"), cl::Hidden);
  50
  51 static cl::opt<bool>
  52 Verbose("v", cl::desc("Print information about actions taken"));
  53
  54 static cl::opt<bool>
  55 DumpAsm("d", cl::desc("Print assembly as linked"), cl::Hidden);
  56
  57 static cl::opt<bool>
  58 SuppressWarnings("suppress-warnings", cl::desc("Suppress all linking warnings"),
  59                  cl::init(false));
  60
  61 // Read the specified bitcode file in and return it. This routine searches the
  62 // link path for the specified file to try to find it...
  63 //
  64 static std::unique_ptr<Module>
  65 loadFile(const char *argv0, const std::string &FN, LLVMContext &Context) {
  66   SMDiagnostic Err;
  67   if (Verbose) errs() << "Loading '" << FN << "'\n";
  68   std::unique_ptr<Module> Result = getLazyIRFileModule(FN, Err, Context);
  69   if (!Result)
  70     Err.print(argv0, errs());
  71
  72   // Fixme (pr23045). We would like to upgrade the metadata with something like
  73   //  Result->materializeMetadata();
  74   //  UpgradeDebugInfo(*Result);
  75   // but that fails to drop old debug info from function bodies.
  76   Result->materializeAllPermanently();
  77
  78   return Result;
  79 }
  80
  81 static void diagnosticHandler(const DiagnosticInfo &DI) {
  82   unsigned Severity = DI.getSeverity();
  83   switch (Severity) {
  84   case DS_Error:
  85     errs() << "ERROR: ";
  86     break;
  87   case DS_Warning:
  88     if (SuppressWarnings)
  89       return;
  90     errs() << "WARNING: ";
  91     break;
  92   case DS_Remark:
  93   case DS_Note:
  94     llvm_unreachable("Only expecting warnings and errors");
  95   }
  96
  97   DiagnosticPrinterRawOStream DP(errs());
  98   DI.print(DP);
  99   errs() << '\n';
 100 }
 101
 102 int main(int argc, char **argv) {
 103   // Print a stack trace if we signal out.
 104   sys::PrintStackTraceOnErrorSignal();
 105   PrettyStackTraceProgram X(argc, argv);
 106
 107   LLVMContext &Context = getGlobalContext();
 108   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 109   cl::ParseCommandLineOptions(argc, argv, "llvm linker\n");
 110
 111   auto Composite = make_unique<Module>("llvm-link", Context);
 112   Linker L(Composite.get(), diagnosticHandler);
 113
 114   for (unsigned i = 0; i < InputFilenames.size(); ++i) {
 115     std::unique_ptr<Module> M = loadFile(argv[0], InputFilenames[i], Context);
 116     if (!M.get()) {
 117       errs() << argv[0] << ": error loading file '" <<InputFilenames[i]<< "'\n";
 118       return 1;
 119     }
 120
 121     if (verifyModule(*M)) {
 122       errs() << argv[0] << ": input module '" << InputFilenames[i]
 123              << "' is broken!\n";
 124       return 1;
 125     }
 126
 127     if (Verbose) errs() << "Linking in '" << InputFilenames[i] << "'\n";
 128
 129     if (L.linkInModule(M.get()))
 130       return 1;
 131   }
 132
 133   if (DumpAsm) errs() << "Here's the assembly:\n" << *Composite;
 134
 135   std::error_code EC;
 136   tool_output_file Out(OutputFilename, EC, sys::fs::F_None);
 137   if (EC) {
 138     errs() << EC.message() << '\n';
 139     return 1;
 140   }
 141
 142   if (verifyModule(*Composite)) {
 143     errs() << argv[0] << ": linked module is broken!\n";
 144     return 1;
 145   }
 146
 147   if (Verbose) errs() << "Writing bitcode...\n";
 148   if (OutputAssembly) {
 149     Out.os() << *Composite;
 150   } else if (Force || !CheckBitcodeOutputToConsole(Out.os(), true))
 151     WriteBitcodeToFile(Composite.get(), Out.os());
 152
 153   // Declare success.
 154   Out.keep();
 155
 156   return 0;
 157 }