X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;ds=sidebyside;f=tools%2Fllvm-link%2Fllvm-link.cpp;h=8d0ce0a040f9e03e690516977167286147ca019b;hb=fb792d346f2eb65d2e0b3065b0f2e6310aa47223;hp=a4a283ced0a00af00616c43d3333c97d5ebc060c;hpb=6939f8141ce40c5bf1ed5958abe29cc31919464c;p=oota-llvm.git diff --git a/tools/llvm-link/llvm-link.cpp b/tools/llvm-link/llvm-link.cpp index a4a283ced0a..8d0ce0a040f 100644 --- a/tools/llvm-link/llvm-link.cpp +++ b/tools/llvm-link/llvm-link.cpp @@ -1,10 +1,10 @@ //===- llvm-link.cpp - Low-level LLVM linker ------------------------------===// -// +// // The LLVM Compiler Infrastructure // -// This file was developed by the LLVM research group and is distributed under -// the University of Illinois Open Source License. See LICENSE.TXT for details. -// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// //===----------------------------------------------------------------------===// // // This utility may be invoked in the following manner: @@ -12,31 +12,72 @@ // //===----------------------------------------------------------------------===// -#include "llvm/Module.h" -#include "llvm/Analysis/Verifier.h" -#include "llvm/Bytecode/Reader.h" -#include "llvm/Bytecode/Writer.h" -#include "llvm/Support/Linker.h" +#include "llvm/Linker/Linker.h" +#include "llvm/ADT/STLExtras.h" +#include "llvm/Bitcode/ReaderWriter.h" +#include "llvm/IR/AutoUpgrade.h" +#include "llvm/IR/DiagnosticInfo.h" +#include "llvm/IR/DiagnosticPrinter.h" +#include "llvm/IR/FunctionInfo.h" +#include "llvm/IR/LLVMContext.h" +#include "llvm/IR/Module.h" +#include "llvm/IR/Verifier.h" +#include "llvm/IRReader/IRReader.h" +#include "llvm/Object/FunctionIndexObjectFile.h" #include "llvm/Support/CommandLine.h" -#include "llvm/Support/FileUtilities.h" -#include "llvm/System/Signals.h" -#include "llvm/System/Path.h" -#include "llvm/ADT/SetVector.h" -#include -#include +#include "llvm/Support/FileSystem.h" +#include "llvm/Support/ManagedStatic.h" +#include "llvm/Support/Path.h" +#include "llvm/Support/PrettyStackTrace.h" +#include "llvm/Support/Signals.h" +#include "llvm/Support/SourceMgr.h" +#include "llvm/Support/SystemUtils.h" +#include "llvm/Support/ToolOutputFile.h" #include - using namespace llvm; static cl::list InputFilenames(cl::Positional, cl::OneOrMore, - cl::desc("")); + cl::desc("")); + +static cl::list OverridingInputs( + "override", cl::ZeroOrMore, cl::value_desc("filename"), + cl::desc( + "input bitcode file which can override previously defined symbol(s)")); + +// Option to simulate function importing for testing. This enables using +// llvm-link to simulate ThinLTO backend processes. +static cl::list 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 FunctionIndex("functionindex", + cl::desc("Function index filename"), + cl::init(""), + cl::value_desc("filename")); static cl::opt OutputFilename("o", cl::desc("Override output filename"), cl::init("-"), cl::value_desc("filename")); -static cl::opt Force("f", cl::desc("Overwrite output files")); +static cl::opt +Internalize("internalize", cl::desc("Internalize linked symbols")); + +static cl::opt +OnlyNeeded("only-needed", cl::desc("Link only needed symbols")); + +static cl::opt +Force("f", cl::desc("Enable binary output on terminals")); + +static cl::opt +OutputAssembly("S", + cl::desc("Write output as LLVM assembly"), cl::Hidden); static cl::opt Verbose("v", cl::desc("Print information about actions taken")); @@ -44,226 +85,238 @@ Verbose("v", cl::desc("Print information about actions taken")); static cl::opt DumpAsm("d", cl::desc("Print assembly as linked"), cl::Hidden); -static cl::list -LibPaths("L", cl::desc("Specify a library search path"), cl::ZeroOrMore, - cl::value_desc("directory"), cl::Prefix); +static cl::opt +SuppressWarnings("suppress-warnings", cl::desc("Suppress all linking warnings"), + cl::init(false)); -static cl::list -Libraries("l", cl::desc("Specify library names to link with"), cl::ZeroOrMore, - cl::Prefix, cl::value_desc("library name")); - -// GetModule - This function is just factored out of the functions below -static inline Module* GetModule(const sys::Path& Filename) { - if (Verbose) std::cerr << "Loading '" << Filename.c_str() << "'\n"; - std::string ErrorMessage; - if (Filename.exists()) { - Module* Result = ParseBytecodeFile(Filename.get(), &ErrorMessage); - if (Result) return Result; // Load successful! - - if (Verbose) { - std::cerr << "Error opening bytecode file: '" << Filename.c_str() << "'"; - if (ErrorMessage.size()) std::cerr << ": " << ErrorMessage; - std::cerr << "\n"; - } - } else { - std::cerr << "Bytecode file: '" << Filename.c_str() - << "' does not exist.\n"; - } - return 0; -} +static cl::opt PreserveBitcodeUseListOrder( + "preserve-bc-uselistorder", + cl::desc("Preserve use-list order when writing LLVM bitcode."), + cl::init(true), cl::Hidden); + +static cl::opt PreserveAssemblyUseListOrder( + "preserve-ll-uselistorder", + cl::desc("Preserve use-list order when writing LLVM assembly."), + cl::init(false), cl::Hidden); -// LoadFile - Read the specified bytecode file in and return it. This routine -// searches the link path for the specified file to try to find it... +// Read the specified bitcode file in and return it. This routine searches the +// link path for the specified file to try to find it... // -static inline std::auto_ptr LoadFile(const std::string &FN) { - sys::Path Filename; - if (!Filename.set_file(FN)) { - std::cerr << "Invalid file name: '" << Filename.c_str() << "'\n"; - return std::auto_ptr(); - } +static std::unique_ptr +loadFile(const char *argv0, const std::string &FN, LLVMContext &Context) { + SMDiagnostic Err; + if (Verbose) errs() << "Loading '" << FN << "'\n"; + std::unique_ptr Result = getLazyIRFileModule(FN, Err, Context); + if (!Result) + Err.print(argv0, errs()); + + Result->materializeMetadata(); + UpgradeDebugInfo(*Result); + + return Result; +} - if (Module* Result = GetModule(Filename)) - return std::auto_ptr(Result); - - bool FoundAFile = false; - - for (unsigned i = 0; i < LibPaths.size(); i++) { - if (!Filename.set_directory(LibPaths[i])) { - std::cerr << "Invalid library path: '" << LibPaths[i] << "'\n"; - } else if (!Filename.append_file(FN)) { - std::cerr << "Invalid library path: '" << LibPaths[i] - << "/" << FN.c_str() << "'\n"; - } else if (Filename.exists()) { - FoundAFile = true; - if (Module *Result = GetModule(Filename)) - return std::auto_ptr(Result); // Load successful! - } +static void diagnosticHandler(const DiagnosticInfo &DI) { + unsigned Severity = DI.getSeverity(); + switch (Severity) { + case DS_Error: + errs() << "ERROR: "; + break; + case DS_Warning: + if (SuppressWarnings) + return; + errs() << "WARNING: "; + break; + case DS_Remark: + case DS_Note: + llvm_unreachable("Only expecting warnings and errors"); } - if (FoundAFile) - std::cerr << "Bytecode file '" << FN << "' corrupt! " - << "Use 'llvm-link -v ...' for more info.\n"; - else - std::cerr << "Could not locate bytecode file: '" << FN << "'\n"; - return std::auto_ptr(); + DiagnosticPrinterRawOStream DP(errs()); + DI.print(DP); + errs() << '\n'; } -sys::Path GetPathForLinkageItem(const std::string& link_item, - const std::string& dir) { - sys::Path fullpath; - fullpath.set_directory(dir); - - // Try *.o - fullpath.append_file(link_item); - fullpath.append_suffix("o"); - if (fullpath.readable()) - return fullpath; - - // Try *.bc - fullpath.elide_suffix(); - fullpath.append_suffix("bc"); - if (fullpath.readable()) - return fullpath; - - // Try *.so - fullpath.elide_suffix(); - fullpath.append_suffix(sys::Path::GetDLLSuffix()); - if (fullpath.readable()) - return fullpath; - - // Try lib*.a - fullpath.set_directory(dir); - fullpath.append_file(std::string("lib") + link_item); - fullpath.append_suffix("a"); - if (fullpath.readable()) - return fullpath; - - // Didn't find one. - fullpath.clear(); - return fullpath; +/// Load a function index if requested by the -functionindex option. +static ErrorOr> +loadIndex(LLVMContext &Context, const Module *ExportingModule = nullptr) { + assert(!FunctionIndex.empty()); + ErrorOr> FileOrErr = + MemoryBuffer::getFileOrSTDIN(FunctionIndex); + std::error_code EC = FileOrErr.getError(); + if (EC) + return EC; + MemoryBufferRef BufferRef = (FileOrErr.get())->getMemBufferRef(); + ErrorOr> ObjOrErr = + object::FunctionIndexObjectFile::create(BufferRef, Context, + ExportingModule); + EC = ObjOrErr.getError(); + if (EC) + return EC; + + object::FunctionIndexObjectFile &Obj = **ObjOrErr; + return Obj.takeIndex(); } -static inline bool LoadLibrary(const std::string &FN, Module*& Result) { - Result = 0; - sys::Path Filename; - if (!Filename.set_file(FN)) { - return false; - } +/// Import any functions requested via the -import option. +static bool importFunctions(const char *argv0, LLVMContext &Context, + Linker &L) { + 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. + std::unique_ptr M = loadFile(argv0, FileName, Context); + if (!M.get()) { + errs() << argv0 << ": error loading file '" << FileName << "'\n"; + return false; + } - if (Filename.readable() && Filename.is_bytecode_file()) { - if (Result = GetModule(Filename)) - return true; + 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 Index; + if (!FunctionIndex.empty()) { + ErrorOr> IndexOrErr = + loadIndex(Context); + std::error_code EC = IndexOrErr.getError(); + if (EC) { + errs() << EC.message() << '\n'; + return false; + } + Index = std::move(IndexOrErr.get()); + } + + // Link in the specified function. + if (L.linkInModule(M.get(), Linker::Flags::None, Index.get(), F)) + return false; } + return true; +} - bool foundAFile = false; - - for (unsigned I = 0; I < LibPaths.size(); I++) { - sys::Path path = GetPathForLinkageItem(FN,LibPaths[I]); - if (!path.is_empty()) { - if (path.is_bytecode_file()) { - if (Result = GetModule(path)) { - return true; - } else { - // We found file but its not a valid bytecode file so we - // return false and leave Result null. - return false; - } - } else { - // We found a file, but its not a bytecode file so we return - // false and leave Result null. +static bool linkFiles(const char *argv0, LLVMContext &Context, Linker &L, + const cl::list &Files, + unsigned Flags) { + // Filter out flags that don't apply to the first file we load. + unsigned ApplicableFlags = Flags & Linker::Flags::OverrideFromSrc; + for (const auto &File : Files) { + std::unique_ptr 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; + } + + // If a function index is supplied, load it so linkInModule can treat + // local functions/variables as exported and promote if necessary. + std::unique_ptr Index; + if (!FunctionIndex.empty()) { + ErrorOr> IndexOrErr = + loadIndex(Context, &*M); + std::error_code EC = IndexOrErr.getError(); + if (EC) { + errs() << EC.message() << '\n'; return false; } + Index = std::move(IndexOrErr.get()); } + + if (Verbose) + errs() << "Linking in '" << File << "'\n"; + + if (L.linkInModule(M.get(), ApplicableFlags, Index.get())) + return false; + // All linker flags apply to linking of subsequent files. + ApplicableFlags = Flags; } - // We didn't find a file so we leave Result null and return - // false to indicate that the library should be just left in the - // emitted module as resolvable at runtime. - return false; + return true; } int main(int argc, char **argv) { - cl::ParseCommandLineOptions(argc, argv, " llvm linker\n"); + // Print a stack trace if we signal out. sys::PrintStackTraceOnErrorSignal(); - assert(InputFilenames.size() > 0 && "OneOrMore is not working"); - - unsigned BaseArg = 0; - std::string ErrorMessage; + PrettyStackTraceProgram X(argc, argv); - std::auto_ptr Composite(LoadFile(InputFilenames[BaseArg])); - if (Composite.get() == 0) return 1; + LLVMContext &Context = getGlobalContext(); + llvm_shutdown_obj Y; // Call llvm_shutdown() on exit. + cl::ParseCommandLineOptions(argc, argv, "llvm linker\n"); - for (unsigned i = BaseArg+1; i < InputFilenames.size(); ++i) { - std::auto_ptr M(LoadFile(InputFilenames[i])); - if (M.get() == 0) return 1; + auto Composite = make_unique("llvm-link", Context); + Linker L(Composite.get(), diagnosticHandler); - if (Verbose) std::cerr << "Linking in '" << InputFilenames[i] << "'\n"; + unsigned Flags = Linker::Flags::None; + if (Internalize) + Flags |= Linker::Flags::InternalizeLinkedSymbols; + if (OnlyNeeded) + Flags |= Linker::Flags::LinkOnlyNeeded; - if (LinkModules(Composite.get(), M.get(), &ErrorMessage)) { - std::cerr << argv[0] << ": link error in '" << InputFilenames[i] - << "': " << ErrorMessage << "\n"; - return 1; - } - } - - // Get the list of dependent libraries from the composite module - const Module::LibraryListType& libs = Composite.get()->getLibraries(); - - // Iterate over the list of dependent libraries, linking them in as we - // find them - Module::LibraryListType::const_iterator I = libs.begin(); - while (I != libs.end()) { - Module* Mod = 0; - if (LoadLibrary(*I,Mod)) { - if (Mod != 0) { - std::auto_ptr M(Mod); - if (LinkModules(Composite.get(), M.get(), &ErrorMessage)) { - std::cerr << argv[0] << ": link error in '" << *I - << "': " << ErrorMessage << "\n"; - return 1; - } - } else { - std::cerr << argv[0] << ": confused loading library '" << *I - << "'. Aborting\n"; - return 2; - } - } - ++I; - } + // First add all the regular input files + if (!linkFiles(argv[0], Context, L, InputFilenames, Flags)) + return 1; - // TODO: Iterate over the -l list and link in any modules containing - // global symbols that have not been resolved so far. + // Next the -override ones. + if (!linkFiles(argv[0], Context, L, OverridingInputs, + Flags | Linker::Flags::OverrideFromSrc)) + return 1; - if (DumpAsm) std::cerr << "Here's the assembly:\n" << Composite.get(); + // Import any functions requested via -import + if (!importFunctions(argv[0], Context, L)) + return 1; - std::ostream *Out = &std::cout; // Default to printing to stdout... - if (OutputFilename != "-") { - if (!Force && std::ifstream(OutputFilename.c_str())) { - // If force is not specified, make sure not to overwrite a file! - std::cerr << argv[0] << ": error opening '" << OutputFilename - << "': file exists!\n" - << "Use -f command line argument to force output\n"; - return 1; - } - Out = new std::ofstream(OutputFilename.c_str()); - if (!Out->good()) { - std::cerr << argv[0] << ": error opening '" << OutputFilename << "'!\n"; - return 1; - } + if (DumpAsm) errs() << "Here's the assembly:\n" << *Composite; - // Make sure that the Out file gets unlinked from the disk if we get a - // SIGINT - sys::RemoveFileOnSignal(OutputFilename); + std::error_code EC; + tool_output_file Out(OutputFilename, EC, sys::fs::F_None); + if (EC) { + errs() << EC.message() << '\n'; + return 1; } - if (verifyModule(*Composite.get())) { - std::cerr << argv[0] << ": linked module is broken!\n"; + if (verifyModule(*Composite, &errs())) { + errs() << argv[0] << ": error: linked module is broken!\n"; return 1; } - if (Verbose) std::cerr << "Writing bytecode...\n"; - WriteBytecodeToFile(Composite.get(), *Out); + if (Verbose) errs() << "Writing bitcode...\n"; + if (OutputAssembly) { + Composite->print(Out.os(), nullptr, PreserveAssemblyUseListOrder); + } else if (Force || !CheckBitcodeOutputToConsole(Out.os(), true)) + WriteBitcodeToFile(Composite.get(), Out.os(), PreserveBitcodeUseListOrder); + + // Declare success. + Out.keep(); - if (Out != &std::cout) delete Out; return 0; }