2003-09-20 02:42:54 +00:00
|
|
|
//===- llvm-link.cpp - Low-level LLVM linker ------------------------------===//
|
2005-04-22 00:00:37 +00:00
|
|
|
//
|
2003-10-20 17:47:21 +00:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-29 20:44:31 +00:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2005-04-22 00:00:37 +00:00
|
|
|
//
|
2003-10-20 17:47:21 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2001-10-13 07:06:23 +00:00
|
|
|
//
|
|
|
|
// This utility may be invoked in the following manner:
|
2003-09-15 18:34:34 +00:00
|
|
|
// llvm-link a.bc b.bc c.bc -o x.bc
|
2001-10-13 07:06:23 +00:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2014-03-06 03:42:23 +00:00
|
|
|
#include "llvm/Linker/Linker.h"
|
2015-03-01 21:28:53 +00:00
|
|
|
#include "llvm/ADT/STLExtras.h"
|
2007-05-06 05:13:17 +00:00
|
|
|
#include "llvm/Bitcode/ReaderWriter.h"
|
2015-03-30 21:36:43 +00:00
|
|
|
#include "llvm/IR/AutoUpgrade.h"
|
2014-10-25 04:06:10 +00:00
|
|
|
#include "llvm/IR/DiagnosticInfo.h"
|
|
|
|
#include "llvm/IR/DiagnosticPrinter.h"
|
2015-11-03 00:14:15 +00:00
|
|
|
#include "llvm/IR/FunctionInfo.h"
|
2013-01-02 11:36:10 +00:00
|
|
|
#include "llvm/IR/LLVMContext.h"
|
|
|
|
#include "llvm/IR/Module.h"
|
2014-01-13 09:26:24 +00:00
|
|
|
#include "llvm/IR/Verifier.h"
|
2013-03-26 02:25:37 +00:00
|
|
|
#include "llvm/IRReader/IRReader.h"
|
2015-11-03 00:14:15 +00:00
|
|
|
#include "llvm/Object/FunctionIndexObjectFile.h"
|
2004-09-01 22:55:40 +00:00
|
|
|
#include "llvm/Support/CommandLine.h"
|
2014-04-29 23:26:49 +00:00
|
|
|
#include "llvm/Support/FileSystem.h"
|
2006-12-06 01:18:01 +00:00
|
|
|
#include "llvm/Support/ManagedStatic.h"
|
2012-12-04 10:44:52 +00:00
|
|
|
#include "llvm/Support/Path.h"
|
2009-03-06 05:34:10 +00:00
|
|
|
#include "llvm/Support/PrettyStackTrace.h"
|
2010-11-29 18:16:10 +00:00
|
|
|
#include "llvm/Support/Signals.h"
|
2013-03-26 02:25:37 +00:00
|
|
|
#include "llvm/Support/SourceMgr.h"
|
2012-12-04 10:44:52 +00:00
|
|
|
#include "llvm/Support/SystemUtils.h"
|
|
|
|
#include "llvm/Support/ToolOutputFile.h"
|
2001-10-13 07:06:23 +00:00
|
|
|
#include <memory>
|
2003-11-11 22:41:34 +00:00
|
|
|
using namespace llvm;
|
|
|
|
|
2002-07-22 02:10:13 +00:00
|
|
|
static cl::list<std::string>
|
|
|
|
InputFilenames(cl::Positional, cl::OneOrMore,
|
2007-07-05 17:07:56 +00:00
|
|
|
cl::desc("<input bitcode files>"));
|
2002-07-22 02:10:13 +00:00
|
|
|
|
2015-04-22 04:11:00 +00:00
|
|
|
static cl::list<std::string> OverridingInputs(
|
|
|
|
"override", cl::ZeroOrMore, cl::value_desc("filename"),
|
|
|
|
cl::desc(
|
|
|
|
"input bitcode file which can override previously defined symbol(s)"));
|
|
|
|
|
2015-11-03 00:14:15 +00:00
|
|
|
// Option to simulate function importing for testing. This enables using
|
|
|
|
// llvm-link to simulate ThinLTO backend processes.
|
|
|
|
static cl::list<std::string> Imports(
|
|
|
|
"import", cl::ZeroOrMore, cl::value_desc("function:filename"),
|
|
|
|
cl::desc("Pair of function name and filename, where function should be "
|
|
|
|
"imported from bitcode in filename"));
|
|
|
|
|
|
|
|
// Option to support testing of function importing. The function index
|
|
|
|
// must be specified in the case were we request imports via the -import
|
|
|
|
// option, as well as when compiling any module with functions that may be
|
|
|
|
// exported (imported by a different llvm-link -import invocation), to ensure
|
|
|
|
// consistent promotion and renaming of locals.
|
|
|
|
static cl::opt<std::string> FunctionIndex("functionindex",
|
|
|
|
cl::desc("Function index filename"),
|
|
|
|
cl::init(""),
|
|
|
|
cl::value_desc("filename"));
|
|
|
|
|
2002-07-22 02:10:13 +00:00
|
|
|
static cl::opt<std::string>
|
|
|
|
OutputFilename("o", cl::desc("Override output filename"), cl::init("-"),
|
|
|
|
cl::value_desc("filename"));
|
|
|
|
|
2015-09-01 17:55:55 +00:00
|
|
|
static cl::opt<bool>
|
|
|
|
Internalize("internalize", cl::desc("Internalize linked symbols"));
|
|
|
|
|
|
|
|
static cl::opt<bool>
|
|
|
|
OnlyNeeded("only-needed", cl::desc("Link only needed symbols"));
|
|
|
|
|
2009-08-25 15:34:52 +00:00
|
|
|
static cl::opt<bool>
|
|
|
|
Force("f", cl::desc("Enable binary output on terminals"));
|
2002-07-22 02:10:13 +00:00
|
|
|
|
2009-09-15 15:35:07 +00:00
|
|
|
static cl::opt<bool>
|
|
|
|
OutputAssembly("S",
|
|
|
|
cl::desc("Write output as LLVM assembly"), cl::Hidden);
|
|
|
|
|
2002-07-22 02:10:13 +00:00
|
|
|
static cl::opt<bool>
|
|
|
|
Verbose("v", cl::desc("Print information about actions taken"));
|
|
|
|
|
|
|
|
static cl::opt<bool>
|
|
|
|
DumpAsm("d", cl::desc("Print assembly as linked"), cl::Hidden);
|
|
|
|
|
2014-02-20 22:19:24 +00:00
|
|
|
static cl::opt<bool>
|
|
|
|
SuppressWarnings("suppress-warnings", cl::desc("Suppress all linking warnings"),
|
|
|
|
cl::init(false));
|
|
|
|
|
2015-04-15 03:14:06 +00:00
|
|
|
static cl::opt<bool> PreserveBitcodeUseListOrder(
|
|
|
|
"preserve-bc-uselistorder",
|
|
|
|
cl::desc("Preserve use-list order when writing LLVM bitcode."),
|
|
|
|
cl::init(true), cl::Hidden);
|
|
|
|
|
|
|
|
static cl::opt<bool> PreserveAssemblyUseListOrder(
|
|
|
|
"preserve-ll-uselistorder",
|
|
|
|
cl::desc("Preserve use-list order when writing LLVM assembly."),
|
|
|
|
cl::init(false), cl::Hidden);
|
|
|
|
|
2014-08-26 17:29:46 +00:00
|
|
|
// Read the specified bitcode file in and return it. This routine searches the
|
|
|
|
// link path for the specified file to try to find it...
|
2004-09-12 23:39:42 +00:00
|
|
|
//
|
2015-12-17 17:14:09 +00:00
|
|
|
static std::unique_ptr<Module> loadFile(const char *argv0,
|
|
|
|
const std::string &FN,
|
|
|
|
LLVMContext &Context,
|
|
|
|
bool MaterializeMetadata = true) {
|
2009-09-12 21:55:12 +00:00
|
|
|
SMDiagnostic Err;
|
2013-06-17 17:32:19 +00:00
|
|
|
if (Verbose) errs() << "Loading '" << FN << "'\n";
|
2015-12-17 17:14:09 +00:00
|
|
|
std::unique_ptr<Module> Result =
|
|
|
|
getLazyIRFileModule(FN, Err, Context, !MaterializeMetadata);
|
2014-08-26 18:03:35 +00:00
|
|
|
if (!Result)
|
|
|
|
Err.print(argv0, errs());
|
2001-10-24 06:23:00 +00:00
|
|
|
|
2015-12-17 17:14:09 +00:00
|
|
|
if (MaterializeMetadata) {
|
|
|
|
Result->materializeMetadata();
|
|
|
|
UpgradeDebugInfo(*Result);
|
|
|
|
}
|
2015-03-27 15:55:06 +00:00
|
|
|
|
2014-08-26 18:03:35 +00:00
|
|
|
return Result;
|
2001-10-24 06:23:00 +00:00
|
|
|
}
|
2001-10-13 07:06:23 +00:00
|
|
|
|
2014-10-27 23:02:10 +00:00
|
|
|
static void diagnosticHandler(const DiagnosticInfo &DI) {
|
2014-10-25 04:06:10 +00:00
|
|
|
unsigned Severity = DI.getSeverity();
|
|
|
|
switch (Severity) {
|
|
|
|
case DS_Error:
|
|
|
|
errs() << "ERROR: ";
|
2014-10-27 23:02:10 +00:00
|
|
|
break;
|
2014-10-25 04:06:10 +00:00
|
|
|
case DS_Warning:
|
|
|
|
if (SuppressWarnings)
|
|
|
|
return;
|
|
|
|
errs() << "WARNING: ";
|
|
|
|
break;
|
|
|
|
case DS_Remark:
|
|
|
|
case DS_Note:
|
|
|
|
llvm_unreachable("Only expecting warnings and errors");
|
|
|
|
}
|
|
|
|
|
|
|
|
DiagnosticPrinterRawOStream DP(errs());
|
|
|
|
DI.print(DP);
|
2014-10-27 23:02:10 +00:00
|
|
|
errs() << '\n';
|
2014-10-25 04:06:10 +00:00
|
|
|
}
|
|
|
|
|
2015-12-14 23:17:03 +00:00
|
|
|
static void diagnosticHandlerWithContext(const DiagnosticInfo &DI, void *C) {
|
|
|
|
diagnosticHandler(DI);
|
|
|
|
}
|
|
|
|
|
2015-11-03 00:14:15 +00:00
|
|
|
/// Import any functions requested via the -import option.
|
|
|
|
static bool importFunctions(const char *argv0, LLVMContext &Context,
|
|
|
|
Linker &L) {
|
2015-12-17 17:14:09 +00:00
|
|
|
StringMap<std::unique_ptr<DenseMap<unsigned, MDNode *>>>
|
|
|
|
ModuleToTempMDValsMap;
|
2015-11-03 00:14:15 +00:00
|
|
|
for (const auto &Import : Imports) {
|
|
|
|
// Identify the requested function and its bitcode source file.
|
|
|
|
size_t Idx = Import.find(':');
|
|
|
|
if (Idx == std::string::npos) {
|
|
|
|
errs() << "Import parameter bad format: " << Import << "\n";
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
std::string FunctionName = Import.substr(0, Idx);
|
|
|
|
std::string FileName = Import.substr(Idx + 1, std::string::npos);
|
|
|
|
|
|
|
|
// Load the specified source module.
|
2015-12-17 17:14:09 +00:00
|
|
|
std::unique_ptr<Module> M = loadFile(argv0, FileName, Context, false);
|
2015-11-03 00:14:15 +00:00
|
|
|
if (!M.get()) {
|
|
|
|
errs() << argv0 << ": error loading file '" << FileName << "'\n";
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (verifyModule(*M, &errs())) {
|
|
|
|
errs() << argv0 << ": " << FileName
|
|
|
|
<< ": error: input module is broken!\n";
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
Function *F = M->getFunction(FunctionName);
|
|
|
|
if (!F) {
|
|
|
|
errs() << "Ignoring import request for non-existent function "
|
|
|
|
<< FunctionName << " from " << FileName << "\n";
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
// We cannot import weak_any functions without possibly affecting the
|
|
|
|
// order they are seen and selected by the linker, changing program
|
|
|
|
// semantics.
|
|
|
|
if (F->hasWeakAnyLinkage()) {
|
|
|
|
errs() << "Ignoring import request for weak-any function " << FunctionName
|
|
|
|
<< " from " << FileName << "\n";
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (Verbose)
|
|
|
|
errs() << "Importing " << FunctionName << " from " << FileName << "\n";
|
|
|
|
|
|
|
|
std::unique_ptr<FunctionInfoIndex> Index;
|
|
|
|
if (!FunctionIndex.empty()) {
|
2015-11-23 19:19:11 +00:00
|
|
|
ErrorOr<std::unique_ptr<FunctionInfoIndex>> IndexOrErr =
|
|
|
|
llvm::getFunctionIndexForFile(FunctionIndex, diagnosticHandler);
|
2015-11-03 00:14:15 +00:00
|
|
|
std::error_code EC = IndexOrErr.getError();
|
|
|
|
if (EC) {
|
|
|
|
errs() << EC.message() << '\n';
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
Index = std::move(IndexOrErr.get());
|
|
|
|
}
|
|
|
|
|
2015-12-17 17:14:09 +00:00
|
|
|
// Save the mapping of value ids to temporary metadata created when
|
|
|
|
// importing this function. If we have already imported from this module,
|
|
|
|
// add new temporary metadata to the existing mapping.
|
|
|
|
auto &TempMDVals = ModuleToTempMDValsMap[FileName];
|
|
|
|
if (!TempMDVals)
|
|
|
|
TempMDVals = llvm::make_unique<DenseMap<unsigned, MDNode *>>();
|
|
|
|
|
2015-11-03 00:14:15 +00:00
|
|
|
// Link in the specified function.
|
2015-12-03 02:40:39 +00:00
|
|
|
DenseSet<const GlobalValue *> FunctionsToImport;
|
|
|
|
FunctionsToImport.insert(F);
|
2015-12-16 23:16:33 +00:00
|
|
|
if (L.linkInModule(std::move(M), Linker::Flags::None, Index.get(),
|
2015-12-17 17:14:09 +00:00
|
|
|
&FunctionsToImport, TempMDVals.get()))
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Now link in metadata for all modules from which we imported functions.
|
|
|
|
for (StringMapEntry<std::unique_ptr<DenseMap<unsigned, MDNode *>>> &SME :
|
|
|
|
ModuleToTempMDValsMap) {
|
|
|
|
// Load the specified source module.
|
|
|
|
std::unique_ptr<Module> M = loadFile(argv0, SME.getKey(), Context, true);
|
|
|
|
if (!M.get()) {
|
|
|
|
errs() << argv0 << ": error loading file '" << SME.getKey() << "'\n";
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (verifyModule(*M, &errs())) {
|
|
|
|
errs() << argv0 << ": " << SME.getKey()
|
|
|
|
<< ": error: input module is broken!\n";
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Link in all necessary metadata from this module.
|
|
|
|
if (L.linkInMetadata(*M, SME.getValue().get()))
|
2015-11-03 00:14:15 +00:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2015-04-22 04:08:22 +00:00
|
|
|
static bool linkFiles(const char *argv0, LLVMContext &Context, Linker &L,
|
2015-04-22 04:11:00 +00:00
|
|
|
const cl::list<std::string> &Files,
|
2015-09-01 17:55:55 +00:00
|
|
|
unsigned Flags) {
|
|
|
|
// Filter out flags that don't apply to the first file we load.
|
|
|
|
unsigned ApplicableFlags = Flags & Linker::Flags::OverrideFromSrc;
|
2015-04-22 04:08:22 +00:00
|
|
|
for (const auto &File : Files) {
|
|
|
|
std::unique_ptr<Module> M = loadFile(argv0, File, Context);
|
|
|
|
if (!M.get()) {
|
|
|
|
errs() << argv0 << ": error loading file '" << File << "'\n";
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (verifyModule(*M, &errs())) {
|
|
|
|
errs() << argv0 << ": " << File << ": error: input module is broken!\n";
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2015-11-03 00:14:15 +00:00
|
|
|
// If a function index is supplied, load it so linkInModule can treat
|
|
|
|
// local functions/variables as exported and promote if necessary.
|
|
|
|
std::unique_ptr<FunctionInfoIndex> Index;
|
|
|
|
if (!FunctionIndex.empty()) {
|
2015-11-23 19:19:11 +00:00
|
|
|
ErrorOr<std::unique_ptr<FunctionInfoIndex>> IndexOrErr =
|
2015-12-03 02:37:23 +00:00
|
|
|
llvm::getFunctionIndexForFile(FunctionIndex, diagnosticHandler);
|
2015-11-03 00:14:15 +00:00
|
|
|
std::error_code EC = IndexOrErr.getError();
|
|
|
|
if (EC) {
|
|
|
|
errs() << EC.message() << '\n';
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
Index = std::move(IndexOrErr.get());
|
|
|
|
}
|
|
|
|
|
2015-04-22 04:08:22 +00:00
|
|
|
if (Verbose)
|
|
|
|
errs() << "Linking in '" << File << "'\n";
|
|
|
|
|
2015-12-16 23:16:33 +00:00
|
|
|
if (L.linkInModule(std::move(M), ApplicableFlags, Index.get()))
|
2015-04-22 04:08:22 +00:00
|
|
|
return false;
|
2015-09-01 17:55:55 +00:00
|
|
|
// All linker flags apply to linking of subsequent files.
|
|
|
|
ApplicableFlags = Flags;
|
2015-04-22 04:08:22 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2001-10-13 07:06:23 +00:00
|
|
|
int main(int argc, char **argv) {
|
2009-03-06 05:34:10 +00:00
|
|
|
// Print a stack trace if we signal out.
|
2007-05-06 05:13:17 +00:00
|
|
|
sys::PrintStackTraceOnErrorSignal();
|
2009-03-06 05:34:10 +00:00
|
|
|
PrettyStackTraceProgram X(argc, argv);
|
2013-09-18 23:31:10 +00:00
|
|
|
|
2009-07-15 22:16:10 +00:00
|
|
|
LLVMContext &Context = getGlobalContext();
|
2015-12-14 23:17:03 +00:00
|
|
|
Context.setDiagnosticHandler(diagnosticHandlerWithContext, nullptr, true);
|
|
|
|
|
2009-03-06 05:34:10 +00:00
|
|
|
llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
|
|
|
|
cl::ParseCommandLineOptions(argc, argv, "llvm linker\n");
|
2001-10-23 20:44:55 +00:00
|
|
|
|
2014-10-23 19:40:45 +00:00
|
|
|
auto Composite = make_unique<Module>("llvm-link", Context);
|
2015-12-14 23:17:03 +00:00
|
|
|
Linker L(*Composite);
|
2014-10-23 19:40:45 +00:00
|
|
|
|
2015-09-01 17:55:55 +00:00
|
|
|
unsigned Flags = Linker::Flags::None;
|
|
|
|
if (Internalize)
|
|
|
|
Flags |= Linker::Flags::InternalizeLinkedSymbols;
|
|
|
|
if (OnlyNeeded)
|
|
|
|
Flags |= Linker::Flags::LinkOnlyNeeded;
|
|
|
|
|
2015-04-22 04:11:00 +00:00
|
|
|
// First add all the regular input files
|
2015-09-01 17:55:55 +00:00
|
|
|
if (!linkFiles(argv[0], Context, L, InputFilenames, Flags))
|
2015-04-22 04:11:00 +00:00
|
|
|
return 1;
|
|
|
|
|
|
|
|
// Next the -override ones.
|
2015-09-01 17:55:55 +00:00
|
|
|
if (!linkFiles(argv[0], Context, L, OverridingInputs,
|
|
|
|
Flags | Linker::Flags::OverrideFromSrc))
|
2015-04-22 04:08:22 +00:00
|
|
|
return 1;
|
2007-05-06 05:13:17 +00:00
|
|
|
|
2015-11-03 00:14:15 +00:00
|
|
|
// Import any functions requested via -import
|
|
|
|
if (!importFunctions(argv[0], Context, L))
|
|
|
|
return 1;
|
|
|
|
|
2009-09-15 15:35:07 +00:00
|
|
|
if (DumpAsm) errs() << "Here's the assembly:\n" << *Composite;
|
2007-05-06 05:13:17 +00:00
|
|
|
|
2014-08-25 18:16:47 +00:00
|
|
|
std::error_code EC;
|
|
|
|
tool_output_file Out(OutputFilename, EC, sys::fs::F_None);
|
|
|
|
if (EC) {
|
|
|
|
errs() << EC.message() << '\n';
|
2009-08-23 02:56:05 +00:00
|
|
|
return 1;
|
|
|
|
}
|
2002-04-18 19:55:25 +00:00
|
|
|
|
2015-03-31 03:07:23 +00:00
|
|
|
if (verifyModule(*Composite, &errs())) {
|
|
|
|
errs() << argv[0] << ": error: linked module is broken!\n";
|
2007-05-06 05:13:17 +00:00
|
|
|
return 1;
|
|
|
|
}
|
|
|
|
|
2009-07-16 15:30:09 +00:00
|
|
|
if (Verbose) errs() << "Writing bitcode...\n";
|
2009-09-15 15:35:07 +00:00
|
|
|
if (OutputAssembly) {
|
2015-04-15 03:14:06 +00:00
|
|
|
Composite->print(Out.os(), nullptr, PreserveAssemblyUseListOrder);
|
2010-09-01 14:20:41 +00:00
|
|
|
} else if (Force || !CheckBitcodeOutputToConsole(Out.os(), true))
|
2015-04-15 03:14:06 +00:00
|
|
|
WriteBitcodeToFile(Composite.get(), Out.os(), PreserveBitcodeUseListOrder);
|
2010-08-20 01:12:13 +00:00
|
|
|
|
|
|
|
// Declare success.
|
|
|
|
Out.keep();
|
2007-05-06 05:13:17 +00:00
|
|
|
|
|
|
|
return 0;
|
2001-10-13 07:06:23 +00:00
|
|
|
}
|