/project/lld/COFF/DriverUtils.cpp
C++ | 650 lines | 537 code | 50 blank | 63 comment | 105 complexity | b99dd7b43e7ced87ec375cf15d500b8e MD5 | raw file
Possible License(s): BSD-3-Clause, 0BSD, BSD-2-Clause, GPL-2.0, GPL-3.0, LGPL-2.0, Apache-2.0
- //===- DriverUtils.cpp ----------------------------------------------------===//
- //
- // The LLVM Linker
- //
- // This file is distributed under the University of Illinois Open Source
- // License. See LICENSE.TXT for details.
- //
- //===----------------------------------------------------------------------===//
- //
- // This file contains utility functions for the driver. Because there
- // are so many small functions, we created this separate file to make
- // Driver.cpp less cluttered.
- //
- //===----------------------------------------------------------------------===//
- #include "Config.h"
- #include "Driver.h"
- #include "Error.h"
- #include "llvm/ADT/Optional.h"
- #include "llvm/ADT/STLExtras.h"
- #include "llvm/ADT/StringSwitch.h"
- #include "llvm/Object/COFF.h"
- #include "llvm/Option/Arg.h"
- #include "llvm/Option/ArgList.h"
- #include "llvm/Option/Option.h"
- #include "llvm/Support/CommandLine.h"
- #include "llvm/Support/FileUtilities.h"
- #include "llvm/Support/Path.h"
- #include "llvm/Support/Process.h"
- #include "llvm/Support/Program.h"
- #include "llvm/Support/raw_ostream.h"
- #include <memory>
- using namespace llvm::COFF;
- using namespace llvm;
- using llvm::cl::ExpandResponseFiles;
- using llvm::cl::TokenizeWindowsCommandLine;
- using llvm::sys::Process;
- namespace lld {
- namespace coff {
- namespace {
- class Executor {
- public:
- explicit Executor(StringRef S) : Saver(Alloc), Prog(Saver.save(S)) {}
- void add(StringRef S) { Args.push_back(Saver.save(S)); }
- void add(std::string &S) { Args.push_back(Saver.save(S)); }
- void add(Twine S) { Args.push_back(Saver.save(S)); }
- void add(const char *S) { Args.push_back(Saver.save(S)); }
- std::error_code run() {
- ErrorOr<std::string> ExeOrErr = llvm::sys::findProgramByName(Prog);
- if (auto EC = ExeOrErr.getError()) {
- llvm::errs() << "unable to find " << Prog << " in PATH: "
- << EC.message() << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- const char *Exe = Saver.save(ExeOrErr.get());
- Args.insert(Args.begin(), Exe);
- Args.push_back(nullptr);
- if (llvm::sys::ExecuteAndWait(Args[0], Args.data()) != 0) {
- for (const char *S : Args)
- if (S)
- llvm::errs() << S << " ";
- llvm::errs() << "failed\n";
- return make_error_code(LLDError::InvalidOption);
- }
- return std::error_code();
- }
- private:
- llvm::BumpPtrAllocator Alloc;
- llvm::BumpPtrStringSaver Saver;
- StringRef Prog;
- std::vector<const char *> Args;
- };
- } // anonymous namespace
- // Returns /machine's value.
- ErrorOr<MachineTypes> getMachineType(StringRef S) {
- MachineTypes MT = StringSwitch<MachineTypes>(S.lower())
- .Case("x64", IMAGE_FILE_MACHINE_AMD64)
- .Case("amd64", IMAGE_FILE_MACHINE_AMD64)
- .Case("x86", IMAGE_FILE_MACHINE_I386)
- .Case("i386", IMAGE_FILE_MACHINE_I386)
- .Case("arm", IMAGE_FILE_MACHINE_ARMNT)
- .Default(IMAGE_FILE_MACHINE_UNKNOWN);
- if (MT != IMAGE_FILE_MACHINE_UNKNOWN)
- return MT;
- llvm::errs() << "unknown /machine argument" << S << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- StringRef machineTypeToStr(MachineTypes MT) {
- switch (MT) {
- case IMAGE_FILE_MACHINE_ARMNT:
- return "arm";
- case IMAGE_FILE_MACHINE_AMD64:
- return "x64";
- case IMAGE_FILE_MACHINE_I386:
- return "x86";
- default:
- llvm_unreachable("unknown machine type");
- }
- }
- // Parses a string in the form of "<integer>[,<integer>]".
- std::error_code parseNumbers(StringRef Arg, uint64_t *Addr, uint64_t *Size) {
- StringRef S1, S2;
- std::tie(S1, S2) = Arg.split(',');
- if (S1.getAsInteger(0, *Addr)) {
- llvm::errs() << "invalid number: " << S1 << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- if (Size && !S2.empty() && S2.getAsInteger(0, *Size)) {
- llvm::errs() << "invalid number: " << S2 << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- return std::error_code();
- }
- // Parses a string in the form of "<integer>[.<integer>]".
- // If second number is not present, Minor is set to 0.
- std::error_code parseVersion(StringRef Arg, uint32_t *Major, uint32_t *Minor) {
- StringRef S1, S2;
- std::tie(S1, S2) = Arg.split('.');
- if (S1.getAsInteger(0, *Major)) {
- llvm::errs() << "invalid number: " << S1 << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- *Minor = 0;
- if (!S2.empty() && S2.getAsInteger(0, *Minor)) {
- llvm::errs() << "invalid number: " << S2 << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- return std::error_code();
- }
- // Parses a string in the form of "<subsystem>[,<integer>[.<integer>]]".
- std::error_code parseSubsystem(StringRef Arg, WindowsSubsystem *Sys,
- uint32_t *Major, uint32_t *Minor) {
- StringRef SysStr, Ver;
- std::tie(SysStr, Ver) = Arg.split(',');
- *Sys = StringSwitch<WindowsSubsystem>(SysStr.lower())
- .Case("boot_application", IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION)
- .Case("console", IMAGE_SUBSYSTEM_WINDOWS_CUI)
- .Case("efi_application", IMAGE_SUBSYSTEM_EFI_APPLICATION)
- .Case("efi_boot_service_driver", IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER)
- .Case("efi_rom", IMAGE_SUBSYSTEM_EFI_ROM)
- .Case("efi_runtime_driver", IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER)
- .Case("native", IMAGE_SUBSYSTEM_NATIVE)
- .Case("posix", IMAGE_SUBSYSTEM_POSIX_CUI)
- .Case("windows", IMAGE_SUBSYSTEM_WINDOWS_GUI)
- .Default(IMAGE_SUBSYSTEM_UNKNOWN);
- if (*Sys == IMAGE_SUBSYSTEM_UNKNOWN) {
- llvm::errs() << "unknown subsystem: " << SysStr << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- if (!Ver.empty())
- if (auto EC = parseVersion(Ver, Major, Minor))
- return EC;
- return std::error_code();
- }
- // Parse a string of the form of "<from>=<to>".
- // Results are directly written to Config.
- std::error_code parseAlternateName(StringRef S) {
- StringRef From, To;
- std::tie(From, To) = S.split('=');
- if (From.empty() || To.empty()) {
- llvm::errs() << "/alternatename: invalid argument: " << S << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- auto It = Config->AlternateNames.find(From);
- if (It != Config->AlternateNames.end() && It->second != To) {
- llvm::errs() << "/alternatename: conflicts: " << S << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- Config->AlternateNames.insert(It, std::make_pair(From, To));
- return std::error_code();
- }
- // Parse a string of the form of "<from>=<to>".
- // Results are directly written to Config.
- std::error_code parseMerge(StringRef S) {
- StringRef From, To;
- std::tie(From, To) = S.split('=');
- if (From.empty() || To.empty()) {
- llvm::errs() << "/merge: invalid argument: " << S << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- auto Pair = Config->Merge.insert(std::make_pair(From, To));
- bool Inserted = Pair.second;
- if (!Inserted) {
- StringRef Existing = Pair.first->second;
- if (Existing != To)
- llvm::errs() << "warning: " << S << ": already merged into "
- << Existing << "\n";
- }
- return std::error_code();
- }
- // Parses a string in the form of "EMBED[,=<integer>]|NO".
- // Results are directly written to Config.
- std::error_code parseManifest(StringRef Arg) {
- if (Arg.equals_lower("no")) {
- Config->Manifest = Configuration::No;
- return std::error_code();
- }
- if (!Arg.startswith_lower("embed"))
- return make_error_code(LLDError::InvalidOption);
- Config->Manifest = Configuration::Embed;
- Arg = Arg.substr(strlen("embed"));
- if (Arg.empty())
- return std::error_code();
- if (!Arg.startswith_lower(",id="))
- return make_error_code(LLDError::InvalidOption);
- Arg = Arg.substr(strlen(",id="));
- if (Arg.getAsInteger(0, Config->ManifestID))
- return make_error_code(LLDError::InvalidOption);
- return std::error_code();
- }
- // Parses a string in the form of "level=<string>|uiAccess=<string>|NO".
- // Results are directly written to Config.
- std::error_code parseManifestUAC(StringRef Arg) {
- if (Arg.equals_lower("no")) {
- Config->ManifestUAC = false;
- return std::error_code();
- }
- for (;;) {
- Arg = Arg.ltrim();
- if (Arg.empty())
- return std::error_code();
- if (Arg.startswith_lower("level=")) {
- Arg = Arg.substr(strlen("level="));
- std::tie(Config->ManifestLevel, Arg) = Arg.split(" ");
- continue;
- }
- if (Arg.startswith_lower("uiaccess=")) {
- Arg = Arg.substr(strlen("uiaccess="));
- std::tie(Config->ManifestUIAccess, Arg) = Arg.split(" ");
- continue;
- }
- return make_error_code(LLDError::InvalidOption);
- }
- }
- // Quote each line with "". Existing double-quote is converted
- // to two double-quotes.
- static void quoteAndPrint(raw_ostream &Out, StringRef S) {
- while (!S.empty()) {
- StringRef Line;
- std::tie(Line, S) = S.split("\n");
- if (Line.empty())
- continue;
- Out << '\"';
- for (int I = 0, E = Line.size(); I != E; ++I) {
- if (Line[I] == '\"') {
- Out << "\"\"";
- } else {
- Out << Line[I];
- }
- }
- Out << "\"\n";
- }
- }
- // Create a manifest file contents.
- static std::string createManifestXml() {
- std::string S;
- llvm::raw_string_ostream OS(S);
- // Emit the XML. Note that we do *not* verify that the XML attributes are
- // syntactically correct. This is intentional for link.exe compatibility.
- OS << "<?xml version=\"1.0\" standalone=\"yes\"?>\n"
- << "<assembly xmlns=\"urn:schemas-microsoft-com:asm.v1\"\n"
- << " manifestVersion=\"1.0\">\n";
- if (Config->ManifestUAC) {
- OS << " <trustInfo>\n"
- << " <security>\n"
- << " <requestedPrivileges>\n"
- << " <requestedExecutionLevel level=" << Config->ManifestLevel
- << " uiAccess=" << Config->ManifestUIAccess << "/>\n"
- << " </requestedPrivileges>\n"
- << " </security>\n"
- << " </trustInfo>\n";
- if (!Config->ManifestDependency.empty()) {
- OS << " <dependency>\n"
- << " <dependentAssembly>\n"
- << " <assemblyIdentity " << Config->ManifestDependency << " />\n"
- << " </dependentAssembly>\n"
- << " </dependency>\n";
- }
- }
- OS << "</assembly>\n";
- OS.flush();
- return S;
- }
- // Create a resource file containing a manifest XML.
- ErrorOr<std::unique_ptr<MemoryBuffer>> createManifestRes() {
- // Create a temporary file for the resource script file.
- SmallString<128> RCPath;
- if (sys::fs::createTemporaryFile("tmp", "rc", RCPath)) {
- llvm::errs() << "cannot create a temporary file\n";
- return make_error_code(LLDError::InvalidOption);
- }
- FileRemover RCRemover(RCPath);
- // Open the temporary file for writing.
- std::error_code EC;
- llvm::raw_fd_ostream Out(RCPath, EC, sys::fs::F_Text);
- if (EC) {
- llvm::errs() << "failed to open " << RCPath << ": " << EC.message() << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- // Write resource script to the RC file.
- Out << "#define LANG_ENGLISH 9\n"
- << "#define SUBLANG_DEFAULT 1\n"
- << "#define APP_MANIFEST " << Config->ManifestID << "\n"
- << "#define RT_MANIFEST 24\n"
- << "LANGUAGE LANG_ENGLISH, SUBLANG_DEFAULT\n"
- << "APP_MANIFEST RT_MANIFEST {\n";
- quoteAndPrint(Out, createManifestXml());
- Out << "}\n";
- Out.close();
- // Create output resource file.
- SmallString<128> ResPath;
- if (sys::fs::createTemporaryFile("tmp", "res", ResPath)) {
- llvm::errs() << "cannot create a temporary file\n";
- return make_error_code(LLDError::InvalidOption);
- }
- Executor E("rc.exe");
- E.add("/fo");
- E.add(ResPath.str());
- E.add("/nologo");
- E.add(RCPath.str());
- if (auto EC = E.run())
- return EC;
- return MemoryBuffer::getFile(ResPath);
- }
- std::error_code createSideBySideManifest() {
- std::string Path = Config->ManifestFile;
- if (Path == "")
- Path = (Twine(Config->OutputFile) + ".manifest").str();
- std::error_code EC;
- llvm::raw_fd_ostream Out(Path, EC, llvm::sys::fs::F_Text);
- if (EC) {
- llvm::errs() << EC.message() << "\n";
- return EC;
- }
- Out << createManifestXml();
- return std::error_code();
- }
- // Parse a string in the form of
- // "<name>[=<internalname>][,@ordinal[,NONAME]][,DATA][,PRIVATE]".
- // Used for parsing /export arguments.
- ErrorOr<Export> parseExport(StringRef Arg) {
- Export E;
- StringRef Rest;
- std::tie(E.Name, Rest) = Arg.split(",");
- if (E.Name.empty())
- goto err;
- if (E.Name.find('=') != StringRef::npos) {
- std::tie(E.ExtName, E.Name) = E.Name.split("=");
- if (E.Name.empty())
- goto err;
- } else {
- E.ExtName = E.Name;
- }
- while (!Rest.empty()) {
- StringRef Tok;
- std::tie(Tok, Rest) = Rest.split(",");
- if (Tok.equals_lower("noname")) {
- if (E.Ordinal == 0)
- goto err;
- E.Noname = true;
- continue;
- }
- if (Tok.equals_lower("data")) {
- E.Data = true;
- continue;
- }
- if (Tok.equals_lower("private")) {
- E.Private = true;
- continue;
- }
- if (Tok.startswith("@")) {
- int32_t Ord;
- if (Tok.substr(1).getAsInteger(0, Ord))
- goto err;
- if (Ord <= 0 || 65535 < Ord)
- goto err;
- E.Ordinal = Ord;
- continue;
- }
- goto err;
- }
- return E;
- err:
- llvm::errs() << "invalid /export: " << Arg << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- // Performs error checking on all /export arguments.
- // It also sets ordinals.
- std::error_code fixupExports() {
- // Symbol ordinals must be unique.
- std::set<uint16_t> Ords;
- for (Export &E : Config->Exports) {
- if (E.Ordinal == 0)
- continue;
- if (!Ords.insert(E.Ordinal).second) {
- llvm::errs() << "duplicate export ordinal: " << E.Name << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- }
- // Uniquefy by name.
- std::map<StringRef, Export *> Map;
- std::vector<Export> V;
- for (Export &E : Config->Exports) {
- auto Pair = Map.insert(std::make_pair(E.Name, &E));
- bool Inserted = Pair.second;
- if (Inserted) {
- V.push_back(E);
- continue;
- }
- Export *Existing = Pair.first->second;
- if (E == *Existing)
- continue;
- llvm::errs() << "warning: duplicate /export option: " << E.Name << "\n";
- continue;
- }
- Config->Exports = std::move(V);
- // Sort by name.
- std::sort(
- Config->Exports.begin(), Config->Exports.end(),
- [](const Export &A, const Export &B) { return A.ExtName < B.ExtName; });
- // Assign unique ordinals if default (= 0).
- uint16_t Max = 0;
- for (Export &E : Config->Exports)
- Max = std::max(Max, E.Ordinal);
- for (Export &E : Config->Exports)
- if (E.Ordinal == 0)
- E.Ordinal = ++Max;
- return std::error_code();
- }
- // Parses a string in the form of "key=value" and check
- // if value matches previous values for the same key.
- std::error_code checkFailIfMismatch(StringRef Arg) {
- StringRef K, V;
- std::tie(K, V) = Arg.split('=');
- if (K.empty() || V.empty()) {
- llvm::errs() << "/failifmismatch: invalid argument: " << Arg << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- StringRef Existing = Config->MustMatch[K];
- if (!Existing.empty() && V != Existing) {
- llvm::errs() << "/failifmismatch: mismatch detected: "
- << Existing << " and " << V << " for key " << K << "\n";
- return make_error_code(LLDError::InvalidOption);
- }
- Config->MustMatch[K] = V;
- return std::error_code();
- }
- // Convert Windows resource files (.res files) to a .obj file
- // using cvtres.exe.
- ErrorOr<std::unique_ptr<MemoryBuffer>>
- convertResToCOFF(const std::vector<MemoryBufferRef> &MBs) {
- // Create an output file path.
- SmallString<128> Path;
- if (llvm::sys::fs::createTemporaryFile("resource", "obj", Path))
- return make_error_code(LLDError::InvalidOption);
- // Execute cvtres.exe.
- Executor E("cvtres.exe");
- E.add("/machine:" + machineTypeToStr(Config->MachineType));
- E.add("/readonly");
- E.add("/nologo");
- E.add("/out:" + Path);
- for (MemoryBufferRef MB : MBs)
- E.add(MB.getBufferIdentifier());
- if (auto EC = E.run())
- return EC;
- return MemoryBuffer::getFile(Path);
- }
- static std::string writeToTempFile(StringRef Contents) {
- SmallString<128> Path;
- int FD;
- if (llvm::sys::fs::createTemporaryFile("tmp", "def", FD, Path)) {
- llvm::errs() << "failed to create a temporary file\n";
- return "";
- }
- llvm::raw_fd_ostream OS(FD, /*shouldClose*/ true);
- OS << Contents;
- return Path.str();
- }
- /// Creates a .def file containing the list of exported symbols.
- static std::string createModuleDefinitionFile() {
- std::string S;
- llvm::raw_string_ostream OS(S);
- OS << "LIBRARY \"" << llvm::sys::path::filename(Config->OutputFile) << "\"\n"
- << "EXPORTS\n";
- for (Export &E : Config->Exports) {
- OS << " " << E.ExtName;
- if (E.Ordinal > 0)
- OS << " @" << E.Ordinal;
- if (E.Noname)
- OS << " NONAME";
- if (E.Data)
- OS << " DATA";
- if (E.Private)
- OS << " PRIVATE";
- OS << "\n";
- }
- OS.flush();
- return S;
- }
- // Creates a .def file and runs lib.exe on it to create an import library.
- std::error_code writeImportLibrary() {
- std::string Contents = createModuleDefinitionFile();
- std::string Def = writeToTempFile(Contents);
- llvm::FileRemover TempFile(Def);
- Executor E("lib.exe");
- E.add("/nologo");
- E.add("/machine:" + machineTypeToStr(Config->MachineType));
- E.add(Twine("/def:") + Def);
- if (Config->Implib.empty()) {
- SmallString<128> Out = StringRef(Config->OutputFile);
- sys::path::replace_extension(Out, ".lib");
- E.add("/out:" + Out);
- } else {
- E.add("/out:" + Config->Implib);
- }
- return E.run();
- }
- void touchFile(StringRef Path) {
- int FD;
- if (sys::fs::openFileForWrite(Path, FD, sys::fs::F_Append))
- report_fatal_error("failed to create a file");
- sys::Process::SafelyCloseFileDescriptor(FD);
- }
- // Create OptTable
- // Create prefix string literals used in Options.td
- #define PREFIX(NAME, VALUE) const char *const NAME[] = VALUE;
- #include "Options.inc"
- #undef PREFIX
- // Create table mapping all options defined in Options.td
- static const llvm::opt::OptTable::Info infoTable[] = {
- #define OPTION(X1, X2, ID, KIND, GROUP, ALIAS, X6, X7, X8, X9, X10) \
- { \
- X1, X2, X9, X10, OPT_##ID, llvm::opt::Option::KIND##Class, X8, X7, \
- OPT_##GROUP, OPT_##ALIAS, X6 \
- },
- #include "Options.inc"
- #undef OPTION
- };
- class COFFOptTable : public llvm::opt::OptTable {
- public:
- COFFOptTable() : OptTable(infoTable, llvm::array_lengthof(infoTable), true) {}
- };
- // Parses a given list of options.
- ErrorOr<llvm::opt::InputArgList>
- ArgParser::parse(ArrayRef<const char *> ArgsArr) {
- // First, replace respnose files (@<file>-style options).
- auto ArgvOrErr = replaceResponseFiles(ArgsArr);
- if (auto EC = ArgvOrErr.getError()) {
- llvm::errs() << "error while reading response file: " << EC.message()
- << "\n";
- return EC;
- }
- std::vector<const char *> Argv = std::move(ArgvOrErr.get());
- // Make InputArgList from string vectors.
- COFFOptTable Table;
- unsigned MissingIndex;
- unsigned MissingCount;
- llvm::opt::InputArgList Args =
- Table.ParseArgs(Argv, MissingIndex, MissingCount);
- if (MissingCount) {
- llvm::errs() << "missing arg value for \""
- << Args.getArgString(MissingIndex) << "\", expected "
- << MissingCount
- << (MissingCount == 1 ? " argument.\n" : " arguments.\n");
- return make_error_code(LLDError::InvalidOption);
- }
- for (auto *Arg : Args.filtered(OPT_UNKNOWN))
- llvm::errs() << "ignoring unknown argument: " << Arg->getSpelling() << "\n";
- return std::move(Args);
- }
- ErrorOr<llvm::opt::InputArgList>
- ArgParser::parseLINK(ArrayRef<const char *> Args) {
- // Concatenate LINK env and given arguments and parse them.
- Optional<std::string> Env = Process::GetEnv("LINK");
- if (!Env)
- return parse(Args);
- std::vector<const char *> V = tokenize(*Env);
- V.insert(V.end(), Args.begin(), Args.end());
- return parse(V);
- }
- std::vector<const char *> ArgParser::tokenize(StringRef S) {
- SmallVector<const char *, 16> Tokens;
- BumpPtrStringSaver Saver(AllocAux);
- llvm::cl::TokenizeWindowsCommandLine(S, Saver, Tokens);
- return std::vector<const char *>(Tokens.begin(), Tokens.end());
- }
- // Creates a new command line by replacing options starting with '@'
- // character. '@<filename>' is replaced by the file's contents.
- ErrorOr<std::vector<const char *>>
- ArgParser::replaceResponseFiles(std::vector<const char *> Argv) {
- SmallVector<const char *, 256> Tokens(Argv.data(), Argv.data() + Argv.size());
- BumpPtrStringSaver Saver(AllocAux);
- ExpandResponseFiles(Saver, TokenizeWindowsCommandLine, Tokens);
- return std::vector<const char *>(Tokens.begin(), Tokens.end());
- }
- void printHelp(const char *Argv0) {
- COFFOptTable Table;
- Table.PrintHelp(llvm::outs(), Argv0, "LLVM Linker", false);
- }
- } // namespace coff
- } // namespace lld