1 //===-- llvm-lto: a simple command-line program to link modules with LTO --===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This program takes in a list of bitcode files, links them, performs link-time
11 // optimization, and outputs an object file.
13 //===----------------------------------------------------------------------===//
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"
37 cl::desc("Optimization level. [-O0, -O1, -O2, or -O3] "
43 static cl::opt<bool> DisableVerify(
44 "disable-verify", cl::init(false),
45 cl::desc("Do not run the verifier during the optimization pipeline"));
48 DisableInline("disable-inlining", cl::init(false),
49 cl::desc("Do not run the inliner pass"));
52 DisableGVNLoadPRE("disable-gvn-loadpre", cl::init(false),
53 cl::desc("Do not run the GVN load PRE pass"));
56 DisableLTOVectorization("disable-lto-vectorization", cl::init(false),
57 cl::desc("Do not run loop or slp vectorization during LTO"));
60 UseDiagnosticHandler("use-diagnostic-handler", cl::init(false),
61 cl::desc("Use a diagnostic handler to test the handler interface"));
64 ThinLTO("thinlto", cl::init(false),
65 cl::desc("Only write combined global index for ThinLTO backends"));
68 SaveModuleFile("save-merged-module", cl::init(false),
69 cl::desc("Write merged LTO module to file before CodeGen"));
71 static cl::list<std::string>
72 InputFilenames(cl::Positional, cl::OneOrMore,
73 cl::desc("<input bitcode files>"));
75 static cl::opt<std::string>
76 OutputFilename("o", cl::init(""),
77 cl::desc("Override output filename"),
78 cl::value_desc("filename"));
80 static cl::list<std::string>
81 ExportedSymbols("exported-symbol",
82 cl::desc("Symbol to export from the resulting object file"),
85 static cl::list<std::string>
86 DSOSymbols("dso-symbol",
87 cl::desc("Symbol to put in the symtab in the resulting dso"),
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"));
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"));
98 static cl::opt<unsigned> Parallelism("j", cl::Prefix, cl::init(1),
99 cl::desc("Number of backend threads"));
103 std::vector<bool> CanBeHidden;
107 static void handleDiagnostics(lto_codegen_diagnostic_severity_t Severity,
108 const char *Msg, void *) {
109 errs() << "llvm-lto: ";
115 errs() << "remark: ";
121 errs() << "warning: ";
124 errs() << Msg << "\n";
127 static void diagnosticHandler(const DiagnosticInfo &DI) {
128 raw_ostream &OS = errs();
130 switch (DI.getSeverity()) {
145 DiagnosticPrinterRawOStream DP(OS);
149 if (DI.getSeverity() == DS_Error)
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();
162 Buffer = std::move(BufferOrErr.get());
163 return std::unique_ptr<LTOModule>(LTOModule::createInLocalContext(
164 Buffer->getBufferStart(), Buffer->getBufferSize(), Options, Error, Path));
167 /// \brief List symbols in each IR file.
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
173 static int listSymbols(StringRef Command, const TargetOptions &Options) {
174 for (auto &Filename : InputFilenames) {
176 std::unique_ptr<MemoryBuffer> Buffer;
177 std::unique_ptr<LTOModule> Module =
178 getLocalLTOModule(Filename, Buffer, Options, Error);
180 errs() << Command << ": error loading file '" << Filename
181 << "': " << Error << "\n";
186 outs() << Filename << ":\n";
187 for (int I = 0, E = Module->getSymbolCount(); I != E; ++I)
188 outs() << Module->getSymbolName(I) << "\n";
193 /// Parse the function index out of an IR file and return the function
194 /// index object if found, or nullptr if not.
195 static ErrorOr<std::unique_ptr<FunctionInfoIndex>>
196 getFunctionIndexForFile(StringRef Path,
197 DiagnosticHandlerFunction DiagnosticHandler) {
198 std::unique_ptr<MemoryBuffer> Buffer;
199 ErrorOr<std::unique_ptr<MemoryBuffer>> BufferOrErr =
200 MemoryBuffer::getFile(Path);
201 if (std::error_code EC = BufferOrErr.getError())
203 Buffer = std::move(BufferOrErr.get());
205 // Don't bother trying to build an index if there is no summary information
206 // in this bitcode file.
207 if (!object::FunctionIndexObjectFile::hasFunctionSummaryInMemBuffer(
208 Buffer->getMemBufferRef(), DiagnosticHandler))
209 return std::unique_ptr<FunctionInfoIndex>(nullptr);
211 ErrorOr<std::unique_ptr<object::FunctionIndexObjectFile>> ObjOrErr =
212 object::FunctionIndexObjectFile::create(Buffer->getMemBufferRef(),
214 if (std::error_code EC = ObjOrErr.getError())
216 return (*ObjOrErr)->takeIndex();
219 /// Create a combined index file from the input IR files and write it.
221 /// This is meant to enable testing of ThinLTO combined index generation,
222 /// currently available via the gold plugin via -thinlto.
223 static int createCombinedFunctionIndex(StringRef Command) {
224 FunctionInfoIndex CombinedIndex;
225 uint64_t NextModuleId = 0;
226 for (auto &Filename : InputFilenames) {
227 ErrorOr<std::unique_ptr<FunctionInfoIndex>> IndexOrErr =
228 getFunctionIndexForFile(Filename, diagnosticHandler);
229 if (std::error_code EC = IndexOrErr.getError()) {
230 std::string Error = EC.message();
231 errs() << Command << ": error loading file '" << Filename
232 << "': " << Error << "\n";
235 std::unique_ptr<FunctionInfoIndex> Index = std::move(IndexOrErr.get());
236 // Skip files without a function summary.
239 CombinedIndex.mergeFrom(std::move(Index), ++NextModuleId);
242 assert(!OutputFilename.empty());
243 raw_fd_ostream OS(OutputFilename + ".thinlto.bc", EC,
244 sys::fs::OpenFlags::F_None);
246 errs() << Command << ": error opening the file '" << OutputFilename
247 << ".thinlto.bc': " << EC.message() << "\n";
250 WriteFunctionSummaryToFile(CombinedIndex, OS);
255 int main(int argc, char **argv) {
256 // Print a stack trace if we signal out.
257 sys::PrintStackTraceOnErrorSignal();
258 PrettyStackTraceProgram X(argc, argv);
260 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
261 cl::ParseCommandLineOptions(argc, argv, "llvm LTO linker\n");
263 if (OptLevel < '0' || OptLevel > '3') {
264 errs() << argv[0] << ": optimization level must be between 0 and 3\n";
268 // Initialize the configured targets.
269 InitializeAllTargets();
270 InitializeAllTargetMCs();
271 InitializeAllAsmPrinters();
272 InitializeAllAsmParsers();
274 // set up the TargetOptions for the machine
275 TargetOptions Options = InitTargetOptionsFromCodeGenFlags();
278 return listSymbols(argv[0], Options);
281 return createCombinedFunctionIndex(argv[0]);
283 unsigned BaseArg = 0;
285 LTOCodeGenerator CodeGen;
287 if (UseDiagnosticHandler)
288 CodeGen.setDiagnosticHandler(handleDiagnostics, nullptr);
290 CodeGen.setCodePICModel(RelocModel);
292 CodeGen.setDebugInfo(LTO_DEBUG_MODEL_DWARF);
293 CodeGen.setTargetOptions(Options);
295 llvm::StringSet<llvm::MallocAllocator> DSOSymbolsSet;
296 for (unsigned i = 0; i < DSOSymbols.size(); ++i)
297 DSOSymbolsSet.insert(DSOSymbols[i]);
299 std::vector<std::string> KeptDSOSyms;
301 for (unsigned i = BaseArg; i < InputFilenames.size(); ++i) {
303 std::unique_ptr<LTOModule> Module(
304 LTOModule::createFromFile(InputFilenames[i].c_str(), Options, error));
305 if (!error.empty()) {
306 errs() << argv[0] << ": error loading file '" << InputFilenames[i]
307 << "': " << error << "\n";
311 unsigned NumSyms = Module->getSymbolCount();
312 for (unsigned I = 0; I < NumSyms; ++I) {
313 StringRef Name = Module->getSymbolName(I);
314 if (!DSOSymbolsSet.count(Name))
316 lto_symbol_attributes Attrs = Module->getSymbolAttributes(I);
317 unsigned Scope = Attrs & LTO_SYMBOL_SCOPE_MASK;
318 if (Scope != LTO_SYMBOL_SCOPE_DEFAULT_CAN_BE_HIDDEN)
319 KeptDSOSyms.push_back(Name);
322 // We use the first input module as the destination module when
323 // SetMergedModule is true.
324 if (SetMergedModule && i == BaseArg) {
325 // Transfer ownership to the code generator.
326 CodeGen.setModule(std::move(Module));
327 } else if (!CodeGen.addModule(Module.get())) {
328 // Print a message here so that we know addModule() did not abort.
329 errs() << argv[0] << ": error adding file '" << InputFilenames[i] << "'\n";
334 // Add all the exported symbols to the table of symbols to preserve.
335 for (unsigned i = 0; i < ExportedSymbols.size(); ++i)
336 CodeGen.addMustPreserveSymbol(ExportedSymbols[i].c_str());
338 // Add all the dso symbols to the table of symbols to expose.
339 for (unsigned i = 0; i < KeptDSOSyms.size(); ++i)
340 CodeGen.addMustPreserveSymbol(KeptDSOSyms[i].c_str());
342 // Set cpu and attrs strings for the default target/subtarget.
343 CodeGen.setCpu(MCPU.c_str());
345 CodeGen.setOptLevel(OptLevel - '0');
348 for (unsigned i = 0; i < MAttrs.size(); ++i) {
351 attrs.append(MAttrs[i]);
355 CodeGen.setAttr(attrs.c_str());
357 if (FileType.getNumOccurrences())
358 CodeGen.setFileType(FileType);
360 if (!OutputFilename.empty()) {
361 if (!CodeGen.optimize(DisableVerify, DisableInline, DisableGVNLoadPRE,
362 DisableLTOVectorization)) {
363 // Diagnostic messages should have been printed by the handler.
364 errs() << argv[0] << ": error optimizing the code\n";
368 if (SaveModuleFile) {
369 std::string ModuleFilename = OutputFilename;
370 ModuleFilename += ".merged.bc";
373 if (!CodeGen.writeMergedModules(ModuleFilename.c_str())) {
374 errs() << argv[0] << ": writing merged module failed.\n";
379 std::list<tool_output_file> OSs;
380 std::vector<raw_pwrite_stream *> OSPtrs;
381 for (unsigned I = 0; I != Parallelism; ++I) {
382 std::string PartFilename = OutputFilename;
383 if (Parallelism != 1)
384 PartFilename += "." + utostr(I);
386 OSs.emplace_back(PartFilename, EC, sys::fs::F_None);
388 errs() << argv[0] << ": error opening the file '" << PartFilename
389 << "': " << EC.message() << "\n";
392 OSPtrs.push_back(&OSs.back().os());
395 if (!CodeGen.compileOptimized(OSPtrs)) {
396 // Diagnostic messages should have been printed by the handler.
397 errs() << argv[0] << ": error compiling the code\n";
401 for (tool_output_file &OS : OSs)
404 if (Parallelism != 1) {
405 errs() << argv[0] << ": -j must be specified together with -o\n";
409 if (SaveModuleFile) {
410 errs() << argv[0] << ": -save-merged-module must be specified with -o\n";
414 const char *OutputName = nullptr;
415 if (!CodeGen.compile_to_file(&OutputName, DisableVerify, DisableInline,
416 DisableGVNLoadPRE, DisableLTOVectorization)) {
417 // Diagnostic messages should have been printed by the handler.
418 errs() << argv[0] << ": error compiling the code\n";
422 outs() << "Wrote native object file '" << OutputName << "'\n";