tools/llvm-lto/llvm-lto.cpp

   1 //===-- llvm-lto: a simple command-line program to link modules with LTO --===//
   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 program takes in a list of bitcode files, links them, performs link-time
  11 // optimization, and outputs an object file.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "llvm/ADT/StringSet.h"
  16 #include "llvm/Bitcode/ReaderWriter.h"
  17 #include "llvm/CodeGen/CommandFlags.h"
  18 #include "llvm/IR/DiagnosticPrinter.h"
  19 #include "llvm/IR/LLVMContext.h"
  20 #include "llvm/LTO/LTOCodeGenerator.h"
  21 #include "llvm/LTO/LTOModule.h"
  22 #include "llvm/Object/FunctionIndexObjectFile.h"
  23 #include "llvm/Support/CommandLine.h"
  24 #include "llvm/Support/FileSystem.h"
  25 #include "llvm/Support/ManagedStatic.h"
  26 #include "llvm/Support/PrettyStackTrace.h"
  27 #include "llvm/Support/Signals.h"
  28 #include "llvm/Support/TargetSelect.h"
  29 #include "llvm/Support/ToolOutputFile.h"
  30 #include "llvm/Support/raw_ostream.h"
  31 #include <list>
  32
  33 using namespace llvm;
  34
  35 static cl::opt<char>
  36 OptLevel("O",
  37          cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
  38                   "(default = '-O2')"),
  39          cl::Prefix,
  40          cl::ZeroOrMore,
  41          cl::init('2'));
  42
  43 static cl::opt<bool> DisableVerify(
  44     "disable-verify", cl::init(false),
  45     cl::desc("Do not run the verifier during the optimization pipeline"));
  46
  47 static cl::opt<bool>
  48 DisableInline("disable-inlining", cl::init(false),
  49   cl::desc("Do not run the inliner pass"));
  50
  51 static cl::opt<bool>
  52 DisableGVNLoadPRE("disable-gvn-loadpre", cl::init(false),
  53   cl::desc("Do not run the GVN load PRE pass"));
  54
  55 static cl::opt<bool>
  56 DisableLTOVectorization("disable-lto-vectorization", cl::init(false),
  57   cl::desc("Do not run loop or slp vectorization during LTO"));
  58
  59 static cl::opt<bool>
  60 UseDiagnosticHandler("use-diagnostic-handler", cl::init(false),
  61   cl::desc("Use a diagnostic handler to test the handler interface"));
  62
  63 static cl::opt<bool>
  64     ThinLTO("thinlto", cl::init(false),
  65             cl::desc("Only write combined global index for ThinLTO backends"));
  66
  67 static cl::opt<bool>
  68 SaveModuleFile("save-merged-module", cl::init(false),
  69                cl::desc("Write merged LTO module to file before CodeGen"));
  70
  71 static cl::list<std::string>
  72 InputFilenames(cl::Positional, cl::OneOrMore,
  73   cl::desc("<input bitcode files>"));
  74
  75 static cl::opt<std::string>
  76 OutputFilename("o", cl::init(""),
  77   cl::desc("Override output filename"),
  78   cl::value_desc("filename"));
  79
  80 static cl::list<std::string>
  81 ExportedSymbols("exported-symbol",
  82   cl::desc("Symbol to export from the resulting object file"),
  83   cl::ZeroOrMore);
  84
  85 static cl::list<std::string>
  86 DSOSymbols("dso-symbol",
  87   cl::desc("Symbol to put in the symtab in the resulting dso"),
  88   cl::ZeroOrMore);
  89
  90 static cl::opt<bool> ListSymbolsOnly(
  91     "list-symbols-only", cl::init(false),
  92     cl::desc("Instead of running LTO, list the symbols in each IR file"));
  93
  94 static cl::opt<bool> SetMergedModule(
  95     "set-merged-module", cl::init(false),
  96     cl::desc("Use the first input module as the merged module"));
  97
  98 static cl::opt<unsigned> Parallelism("j", cl::Prefix, cl::init(1),
  99                                      cl::desc("Number of backend threads"));
 100
 101 namespace {
 102 struct ModuleInfo {
 103   std::vector<bool> CanBeHidden;
 104 };
 105 }
 106
 107 static void handleDiagnostics(lto_codegen_diagnostic_severity_t Severity,
 108                               const char *Msg, void *) {
 109   errs() << "llvm-lto: ";
 110   switch (Severity) {
 111   case LTO_DS_NOTE:
 112     errs() << "note: ";
 113     break;
 114   case LTO_DS_REMARK:
 115     errs() << "remark: ";
 116     break;
 117   case LTO_DS_ERROR:
 118     errs() << "error: ";
 119     break;
 120   case LTO_DS_WARNING:
 121     errs() << "warning: ";
 122     break;
 123   }
 124   errs() << Msg << "\n";
 125 }
 126
 127 static void diagnosticHandler(const DiagnosticInfo &DI) {
 128   raw_ostream &OS = errs();
 129   OS << "llvm-lto: ";
 130   switch (DI.getSeverity()) {
 131   case DS_Error:
 132     OS << "error: ";
 133     break;
 134   case DS_Warning:
 135     OS << "warning: ";
 136     break;
 137   case DS_Remark:
 138     OS << "remark: ";
 139     break;
 140   case DS_Note:
 141     OS << "note: ";
 142     break;
 143   }
 144
 145   DiagnosticPrinterRawOStream DP(OS);
 146   DI.print(DP);
 147   OS << '\n';
 148
 149   if (DI.getSeverity() == DS_Error)
 150     exit(1);
 151 }
 152
 153 static std::unique_ptr<LTOModule>
 154 getLocalLTOModule(StringRef Path, std::unique_ptr<MemoryBuffer> &Buffer,
 155                   const TargetOptions &Options, std::string &Error) {
 156   ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
 157       MemoryBuffer::getFile(Path);
 158   if (std::error_code EC = BufferOrErr.getError()) {
 159     Error = EC.message();
 160     return nullptr;
 161   }
 162   Buffer = std::move(BufferOrErr.get());
 163   return std::unique_ptr<LTOModule>(LTOModule::createInLocalContext(
 164       Buffer->getBufferStart(), Buffer->getBufferSize(), Options, Error, Path));
 165 }
 166
 167 /// \brief List symbols in each IR file.
 168 ///
 169 /// The main point here is to provide lit-testable coverage for the LTOModule
 170 /// functionality that's exposed by the C API to list symbols.  Moreover, this
 171 /// provides testing coverage for modules that have been created in their own
 172 /// contexts.
 173 static int listSymbols(StringRef Command, const TargetOptions &Options) {
 174   for (auto &Filename : InputFilenames) {
 175     std::string Error;
 176     std::unique_ptr<MemoryBuffer> Buffer;
 177     std::unique_ptr<LTOModule> Module =
 178         getLocalLTOModule(Filename, Buffer, Options, Error);
 179     if (!Module) {
 180       errs() << Command << ": error loading file '" << Filename
 181              << "': " << Error << "\n";
 182       return 1;
 183     }
 184
 185     // List the symbols.
 186     outs() << Filename << ":\n";
 187     for (int I = 0, E = Module->getSymbolCount(); I != E; ++I)
 188       outs() << Module->getSymbolName(I) << "\n";
 189   }
 190   return 0;
 191 }
 192
 193 /// Create a combined index file from the input IR files and write it.
 194 ///
 195 /// This is meant to enable testing of ThinLTO combined index generation,
 196 /// currently available via the gold plugin via -thinlto.
 197 static int createCombinedFunctionIndex(StringRef Command) {
 198   FunctionInfoIndex CombinedIndex;
 199   uint64_t NextModuleId = 0;
 200   for (auto &Filename : InputFilenames) {
 201     ErrorOr<std::unique_ptr<FunctionInfoIndex>> IndexOrErr =
 202         llvm::getFunctionIndexForFile(Filename, diagnosticHandler);
 203     if (std::error_code EC = IndexOrErr.getError()) {
 204       std::string Error = EC.message();
 205       errs() << Command << ": error loading file '" << Filename
 206              << "': " << Error << "\n";
 207       return 1;
 208     }
 209     std::unique_ptr<FunctionInfoIndex> Index = std::move(IndexOrErr.get());
 210     // Skip files without a function summary.
 211     if (!Index)
 212       continue;
 213     CombinedIndex.mergeFrom(std::move(Index), ++NextModuleId);
 214   }
 215   std::error_code EC;
 216   assert(!OutputFilename.empty());
 217   raw_fd_ostream OS(OutputFilename + ".thinlto.bc", EC,
 218                     sys::fs::OpenFlags::F_None);
 219   if (EC) {
 220     errs() << Command << ": error opening the file '" << OutputFilename
 221            << ".thinlto.bc': " << EC.message() << "\n";
 222     return 1;
 223   }
 224   WriteFunctionSummaryToFile(CombinedIndex, OS);
 225   OS.close();
 226   return 0;
 227 }
 228
 229 int main(int argc, char **argv) {
 230   // Print a stack trace if we signal out.
 231   sys::PrintStackTraceOnErrorSignal();
 232   PrettyStackTraceProgram X(argc, argv);
 233
 234   llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
 235   cl::ParseCommandLineOptions(argc, argv, "llvm LTO linker\n");
 236
 237   if (OptLevel < '0' || OptLevel > '3') {
 238     errs() << argv[0] << ": optimization level must be between 0 and 3\n";
 239     return 1;
 240   }
 241
 242   // Initialize the configured targets.
 243   InitializeAllTargets();
 244   InitializeAllTargetMCs();
 245   InitializeAllAsmPrinters();
 246   InitializeAllAsmParsers();
 247
 248   // set up the TargetOptions for the machine
 249   TargetOptions Options = InitTargetOptionsFromCodeGenFlags();
 250
 251   if (ListSymbolsOnly)
 252     return listSymbols(argv[0], Options);
 253
 254   if (ThinLTO)
 255     return createCombinedFunctionIndex(argv[0]);
 256
 257   unsigned BaseArg = 0;
 258
 259   LTOCodeGenerator CodeGen;
 260
 261   if (UseDiagnosticHandler)
 262     CodeGen.setDiagnosticHandler(handleDiagnostics, nullptr);
 263
 264   CodeGen.setCodePICModel(RelocModel);
 265
 266   CodeGen.setDebugInfo(LTO_DEBUG_MODEL_DWARF);
 267   CodeGen.setTargetOptions(Options);
 268
 269   llvm::StringSet<llvm::MallocAllocator> DSOSymbolsSet;
 270   for (unsigned i = 0; i < DSOSymbols.size(); ++i)
 271     DSOSymbolsSet.insert(DSOSymbols[i]);
 272
 273   std::vector<std::string> KeptDSOSyms;
 274
 275   for (unsigned i = BaseArg; i < InputFilenames.size(); ++i) {
 276     std::string error;
 277     std::unique_ptr<LTOModule> Module(
 278         LTOModule::createFromFile(InputFilenames[i].c_str(), Options, error));
 279     if (!error.empty()) {
 280       errs() << argv[0] << ": error loading file '" << InputFilenames[i]
 281              << "': " << error << "\n";
 282       return 1;
 283     }
 284
 285     unsigned NumSyms = Module->getSymbolCount();
 286     for (unsigned I = 0; I < NumSyms; ++I) {
 287       StringRef Name = Module->getSymbolName(I);
 288       if (!DSOSymbolsSet.count(Name))
 289         continue;
 290       lto_symbol_attributes Attrs = Module->getSymbolAttributes(I);
 291       unsigned Scope = Attrs & LTO_SYMBOL_SCOPE_MASK;
 292       if (Scope != LTO_SYMBOL_SCOPE_DEFAULT_CAN_BE_HIDDEN)
 293         KeptDSOSyms.push_back(Name);
 294     }
 295
 296     // We use the first input module as the destination module when
 297     // SetMergedModule is true.
 298     if (SetMergedModule && i == BaseArg) {
 299       // Transfer ownership to the code generator.
 300       CodeGen.setModule(std::move(Module));
 301     } else if (!CodeGen.addModule(Module.get())) {
 302       // Print a message here so that we know addModule() did not abort.
 303       errs() << argv[0] << ": error adding file '" << InputFilenames[i] << "'\n";
 304       return 1;
 305     }
 306   }
 307
 308   // Add all the exported symbols to the table of symbols to preserve.
 309   for (unsigned i = 0; i < ExportedSymbols.size(); ++i)
 310     CodeGen.addMustPreserveSymbol(ExportedSymbols[i].c_str());
 311
 312   // Add all the dso symbols to the table of symbols to expose.
 313   for (unsigned i = 0; i < KeptDSOSyms.size(); ++i)
 314     CodeGen.addMustPreserveSymbol(KeptDSOSyms[i].c_str());
 315
 316   // Set cpu and attrs strings for the default target/subtarget.
 317   CodeGen.setCpu(MCPU.c_str());
 318
 319   CodeGen.setOptLevel(OptLevel - '0');
 320
 321   std::string attrs;
 322   for (unsigned i = 0; i < MAttrs.size(); ++i) {
 323     if (i > 0)
 324       attrs.append(",");
 325     attrs.append(MAttrs[i]);
 326   }
 327
 328   if (!attrs.empty())
 329     CodeGen.setAttr(attrs.c_str());
 330
 331   if (FileType.getNumOccurrences())
 332     CodeGen.setFileType(FileType);
 333
 334   if (!OutputFilename.empty()) {
 335     if (!CodeGen.optimize(DisableVerify, DisableInline, DisableGVNLoadPRE,
 336                           DisableLTOVectorization)) {
 337       // Diagnostic messages should have been printed by the handler.
 338       errs() << argv[0] << ": error optimizing the code\n";
 339       return 1;
 340     }
 341
 342     if (SaveModuleFile) {
 343       std::string ModuleFilename = OutputFilename;
 344       ModuleFilename += ".merged.bc";
 345       std::string ErrMsg;
 346
 347       if (!CodeGen.writeMergedModules(ModuleFilename.c_str())) {
 348         errs() << argv[0] << ": writing merged module failed.\n";
 349         return 1;
 350       }
 351     }
 352
 353     std::list<tool_output_file> OSs;
 354     std::vector<raw_pwrite_stream *> OSPtrs;
 355     for (unsigned I = 0; I != Parallelism; ++I) {
 356       std::string PartFilename = OutputFilename;
 357       if (Parallelism != 1)
 358         PartFilename += "." + utostr(I);
 359       std::error_code EC;
 360       OSs.emplace_back(PartFilename, EC, sys::fs::F_None);
 361       if (EC) {
 362         errs() << argv[0] << ": error opening the file '" << PartFilename
 363                << "': " << EC.message() << "\n";
 364         return 1;
 365       }
 366       OSPtrs.push_back(&OSs.back().os());
 367     }
 368
 369     if (!CodeGen.compileOptimized(OSPtrs)) {
 370       // Diagnostic messages should have been printed by the handler.
 371       errs() << argv[0] << ": error compiling the code\n";
 372       return 1;
 373     }
 374
 375     for (tool_output_file &OS : OSs)
 376       OS.keep();
 377   } else {
 378     if (Parallelism != 1) {
 379       errs() << argv[0] << ": -j must be specified together with -o\n";
 380       return 1;
 381     }
 382
 383     if (SaveModuleFile) {
 384       errs() << argv[0] << ": -save-merged-module must be specified with -o\n";
 385       return 1;
 386     }
 387
 388     const char *OutputName = nullptr;
 389     if (!CodeGen.compile_to_file(&OutputName, DisableVerify, DisableInline,
 390                                  DisableGVNLoadPRE, DisableLTOVectorization)) {
 391       // Diagnostic messages should have been printed by the handler.
 392       errs() << argv[0] << ": error compiling the code\n";
 393       return 1;
 394     }
 395
 396     outs() << "Wrote native object file '" << OutputName << "'\n";
 397   }
 398
 399   return 0;
 400 }