1 //===- llvm-link.cpp - Low-level LLVM linker ------------------------------===//
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 utility may be invoked in the following manner:
11 // llvm-link a.bc b.bc c.bc -o x.bc
13 //===----------------------------------------------------------------------===//
15 #include "llvm/Linker/Linker.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/Bitcode/ReaderWriter.h"
18 #include "llvm/IR/AutoUpgrade.h"
19 #include "llvm/IR/DiagnosticInfo.h"
20 #include "llvm/IR/DiagnosticPrinter.h"
21 #include "llvm/IR/FunctionInfo.h"
22 #include "llvm/IR/LLVMContext.h"
23 #include "llvm/IR/Module.h"
24 #include "llvm/IR/Verifier.h"
25 #include "llvm/IRReader/IRReader.h"
26 #include "llvm/Object/FunctionIndexObjectFile.h"
27 #include "llvm/Support/CommandLine.h"
28 #include "llvm/Support/FileSystem.h"
29 #include "llvm/Support/ManagedStatic.h"
30 #include "llvm/Support/Path.h"
31 #include "llvm/Support/PrettyStackTrace.h"
32 #include "llvm/Support/Signals.h"
33 #include "llvm/Support/SourceMgr.h"
34 #include "llvm/Support/SystemUtils.h"
35 #include "llvm/Support/ToolOutputFile.h"
39 static cl::list<std::string>
40 InputFilenames(cl::Positional, cl::OneOrMore,
41 cl::desc("<input bitcode files>"));
43 static cl::list<std::string> OverridingInputs(
44 "override", cl::ZeroOrMore, cl::value_desc("filename"),
46 "input bitcode file which can override previously defined symbol(s)"));
48 // Option to simulate function importing for testing. This enables using
49 // llvm-link to simulate ThinLTO backend processes.
50 static cl::list<std::string> Imports(
51 "import", cl::ZeroOrMore, cl::value_desc("function:filename"),
52 cl::desc("Pair of function name and filename, where function should be "
53 "imported from bitcode in filename"));
55 // Option to support testing of function importing. The function index
56 // must be specified in the case were we request imports via the -import
57 // option, as well as when compiling any module with functions that may be
58 // exported (imported by a different llvm-link -import invocation), to ensure
59 // consistent promotion and renaming of locals.
60 static cl::opt<std::string> FunctionIndex("functionindex",
61 cl::desc("Function index filename"),
63 cl::value_desc("filename"));
65 static cl::opt<std::string>
66 OutputFilename("o", cl::desc("Override output filename"), cl::init("-"),
67 cl::value_desc("filename"));
70 Internalize("internalize", cl::desc("Internalize linked symbols"));
73 OnlyNeeded("only-needed", cl::desc("Link only needed symbols"));
76 Force("f", cl::desc("Enable binary output on terminals"));
80 cl::desc("Write output as LLVM assembly"), cl::Hidden);
83 Verbose("v", cl::desc("Print information about actions taken"));
86 DumpAsm("d", cl::desc("Print assembly as linked"), cl::Hidden);
89 SuppressWarnings("suppress-warnings", cl::desc("Suppress all linking warnings"),
93 PreserveModules("preserve-modules",
94 cl::desc("Preserve linked modules for testing"));
96 static cl::opt<bool> PreserveBitcodeUseListOrder(
97 "preserve-bc-uselistorder",
98 cl::desc("Preserve use-list order when writing LLVM bitcode."),
99 cl::init(true), cl::Hidden);
101 static cl::opt<bool> PreserveAssemblyUseListOrder(
102 "preserve-ll-uselistorder",
103 cl::desc("Preserve use-list order when writing LLVM assembly."),
104 cl::init(false), cl::Hidden);
106 // Read the specified bitcode file in and return it. This routine searches the
107 // link path for the specified file to try to find it...
109 static std::unique_ptr<Module>
110 loadFile(const char *argv0, const std::string &FN, LLVMContext &Context) {
112 if (Verbose) errs() << "Loading '" << FN << "'\n";
113 std::unique_ptr<Module> Result = getLazyIRFileModule(FN, Err, Context);
115 Err.print(argv0, errs());
117 Result->materializeMetadata();
118 UpgradeDebugInfo(*Result);
123 static void diagnosticHandler(const DiagnosticInfo &DI) {
124 unsigned Severity = DI.getSeverity();
130 if (SuppressWarnings)
132 errs() << "WARNING: ";
136 llvm_unreachable("Only expecting warnings and errors");
139 DiagnosticPrinterRawOStream DP(errs());
144 /// Load a function index if requested by the -functionindex option.
145 static ErrorOr<std::unique_ptr<FunctionInfoIndex>>
146 loadIndex(LLVMContext &Context, const Module *ExportingModule = nullptr) {
147 assert(!FunctionIndex.empty());
148 ErrorOr<std::unique_ptr<MemoryBuffer>> FileOrErr =
149 MemoryBuffer::getFileOrSTDIN(FunctionIndex);
150 std::error_code EC = FileOrErr.getError();
153 MemoryBufferRef BufferRef = (FileOrErr.get())->getMemBufferRef();
154 ErrorOr<std::unique_ptr<object::FunctionIndexObjectFile>> ObjOrErr =
155 object::FunctionIndexObjectFile::create(BufferRef, diagnosticHandler,
157 EC = ObjOrErr.getError();
161 object::FunctionIndexObjectFile &Obj = **ObjOrErr;
162 return Obj.takeIndex();
165 /// Import any functions requested via the -import option.
166 static bool importFunctions(const char *argv0, LLVMContext &Context,
168 for (const auto &Import : Imports) {
169 // Identify the requested function and its bitcode source file.
170 size_t Idx = Import.find(':');
171 if (Idx == std::string::npos) {
172 errs() << "Import parameter bad format: " << Import << "\n";
175 std::string FunctionName = Import.substr(0, Idx);
176 std::string FileName = Import.substr(Idx + 1, std::string::npos);
178 // Load the specified source module.
179 std::unique_ptr<Module> M = loadFile(argv0, FileName, Context);
181 errs() << argv0 << ": error loading file '" << FileName << "'\n";
185 if (verifyModule(*M, &errs())) {
186 errs() << argv0 << ": " << FileName
187 << ": error: input module is broken!\n";
191 Function *F = M->getFunction(FunctionName);
193 errs() << "Ignoring import request for non-existent function "
194 << FunctionName << " from " << FileName << "\n";
197 // We cannot import weak_any functions without possibly affecting the
198 // order they are seen and selected by the linker, changing program
200 if (F->hasWeakAnyLinkage()) {
201 errs() << "Ignoring import request for weak-any function " << FunctionName
202 << " from " << FileName << "\n";
207 errs() << "Importing " << FunctionName << " from " << FileName << "\n";
209 std::unique_ptr<FunctionInfoIndex> Index;
210 if (!FunctionIndex.empty()) {
211 ErrorOr<std::unique_ptr<FunctionInfoIndex>> IndexOrErr =
213 std::error_code EC = IndexOrErr.getError();
215 errs() << EC.message() << '\n';
218 Index = std::move(IndexOrErr.get());
221 // Link in the specified function.
222 if (L.linkInModule(M.get(), Linker::Flags::None, Index.get(), F))
228 static bool linkFiles(const char *argv0, LLVMContext &Context, Linker &L,
229 const cl::list<std::string> &Files,
231 // Filter out flags that don't apply to the first file we load.
232 unsigned ApplicableFlags = Flags & Linker::Flags::OverrideFromSrc;
233 for (const auto &File : Files) {
234 std::unique_ptr<Module> M = loadFile(argv0, File, Context);
236 errs() << argv0 << ": error loading file '" << File << "'\n";
240 if (verifyModule(*M, &errs())) {
241 errs() << argv0 << ": " << File << ": error: input module is broken!\n";
245 // If a function index is supplied, load it so linkInModule can treat
246 // local functions/variables as exported and promote if necessary.
247 std::unique_ptr<FunctionInfoIndex> Index;
248 if (!FunctionIndex.empty()) {
249 ErrorOr<std::unique_ptr<FunctionInfoIndex>> IndexOrErr =
250 loadIndex(Context, &*M);
251 std::error_code EC = IndexOrErr.getError();
253 errs() << EC.message() << '\n';
256 Index = std::move(IndexOrErr.get());
260 errs() << "Linking in '" << File << "'\n";
262 if (L.linkInModule(M.get(), ApplicableFlags, Index.get()))
264 // All linker flags apply to linking of subsequent files.
265 ApplicableFlags = Flags;
267 // If requested for testing, preserve modules by releasing them from
268 // the unique_ptr before the are freed. This can help catch any
269 // cross-module references from e.g. unneeded metadata references
270 // that aren't properly set to null but instead mapped to the source
271 // module version. The bitcode writer will assert if it finds any such
272 // cross-module references.
280 int main(int argc, char **argv) {
281 // Print a stack trace if we signal out.
282 sys::PrintStackTraceOnErrorSignal();
283 PrettyStackTraceProgram X(argc, argv);
285 LLVMContext &Context = getGlobalContext();
286 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
287 cl::ParseCommandLineOptions(argc, argv, "llvm linker\n");
289 auto Composite = make_unique<Module>("llvm-link", Context);
290 Linker L(Composite.get(), diagnosticHandler);
292 unsigned Flags = Linker::Flags::None;
294 Flags |= Linker::Flags::InternalizeLinkedSymbols;
296 Flags |= Linker::Flags::LinkOnlyNeeded;
298 // First add all the regular input files
299 if (!linkFiles(argv[0], Context, L, InputFilenames, Flags))
302 // Next the -override ones.
303 if (!linkFiles(argv[0], Context, L, OverridingInputs,
304 Flags | Linker::Flags::OverrideFromSrc))
307 // Import any functions requested via -import
308 if (!importFunctions(argv[0], Context, L))
311 if (DumpAsm) errs() << "Here's the assembly:\n" << *Composite;
314 tool_output_file Out(OutputFilename, EC, sys::fs::F_None);
316 errs() << EC.message() << '\n';
320 if (verifyModule(*Composite, &errs())) {
321 errs() << argv[0] << ": error: linked module is broken!\n";
325 if (Verbose) errs() << "Writing bitcode...\n";
326 if (OutputAssembly) {
327 Composite->print(Out.os(), nullptr, PreserveAssemblyUseListOrder);
328 } else if (Force || !CheckBitcodeOutputToConsole(Out.os(), true))
329 WriteBitcodeToFile(Composite.get(), Out.os(), PreserveBitcodeUseListOrder);