620 lines · cpp
1//===- MinGW/Driver.cpp ---------------------------------------------------===//2//3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.4// See https://llvm.org/LICENSE.txt for license information.5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception6//7//===----------------------------------------------------------------------===//8//9// MinGW is a GNU development environment for Windows. It consists of GNU10// tools such as GCC and GNU ld. Unlike Cygwin, there's no POSIX-compatible11// layer, as it aims to be a native development toolchain.12//13// lld/MinGW is a drop-in replacement for GNU ld/MinGW.14//15// Being a native development tool, a MinGW linker is not very different from16// Microsoft link.exe, so a MinGW linker can be implemented as a thin wrapper17// for lld/COFF. This driver takes Unix-ish command line options, translates18// them to Windows-ish ones, and then passes them to lld/COFF.19//20// When this driver calls the lld/COFF driver, it passes a hidden option21// "-lldmingw" along with other user-supplied options, to run the lld/COFF22// linker in "MinGW mode".23//24// There are subtle differences between MS link.exe and GNU ld/MinGW, and GNU25// ld/MinGW implements a few GNU-specific features. Such features are directly26// implemented in lld/COFF and enabled only when the linker is running in MinGW27// mode.28//29//===----------------------------------------------------------------------===//30 31#include "lld/Common/Driver.h"32#include "lld/Common/CommonLinkerContext.h"33#include "lld/Common/ErrorHandler.h"34#include "lld/Common/Version.h"35#include "llvm/ADT/ArrayRef.h"36#include "llvm/ADT/StringExtras.h"37#include "llvm/ADT/StringRef.h"38#include "llvm/Option/Arg.h"39#include "llvm/Option/ArgList.h"40#include "llvm/Option/Option.h"41#include "llvm/Support/CommandLine.h"42#include "llvm/Support/FileSystem.h"43#include "llvm/Support/Path.h"44#include "llvm/TargetParser/Host.h"45#include "llvm/TargetParser/Triple.h"46#include <optional>47 48using namespace lld;49using namespace llvm::opt;50using namespace llvm;51 52// Create OptTable53enum {54 OPT_INVALID = 0,55#define OPTION(...) LLVM_MAKE_OPT_ID(__VA_ARGS__),56#include "Options.inc"57#undef OPTION58};59 60#define OPTTABLE_STR_TABLE_CODE61#include "Options.inc"62#undef OPTTABLE_STR_TABLE_CODE63 64#define OPTTABLE_PREFIXES_TABLE_CODE65#include "Options.inc"66#undef OPTTABLE_PREFIXES_TABLE_CODE67 68// Create table mapping all options defined in Options.td69static constexpr opt::OptTable::Info infoTable[] = {70#define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, \71 VISIBILITY, PARAM, HELPTEXT, HELPTEXTSFORVARIANTS, METAVAR, \72 VALUES, SUBCOMMANDIDS_OFFSET) \73 {PREFIX, \74 NAME, \75 HELPTEXT, \76 HELPTEXTSFORVARIANTS, \77 METAVAR, \78 OPT_##ID, \79 opt::Option::KIND##Class, \80 PARAM, \81 FLAGS, \82 VISIBILITY, \83 OPT_##GROUP, \84 OPT_##ALIAS, \85 ALIASARGS, \86 VALUES, \87 SUBCOMMANDIDS_OFFSET},88#include "Options.inc"89#undef OPTION90};91 92namespace {93class MinGWOptTable : public opt::GenericOptTable {94public:95 MinGWOptTable()96 : opt::GenericOptTable(OptionStrTable, OptionPrefixesTable, infoTable,97 false) {}98 opt::InputArgList parse(ArrayRef<const char *> argv);99};100} // namespace101 102static void printHelp(CommonLinkerContext &ctx, const char *argv0) {103 auto &outs = ctx.e.outs();104 MinGWOptTable().printHelp(105 outs, (std::string(argv0) + " [options] file...").c_str(), "lld",106 /*ShowHidden=*/false, /*ShowAllAliases=*/true);107 outs << '\n';108}109 110static cl::TokenizerCallback getQuotingStyle() {111 if (Triple(sys::getProcessTriple()).getOS() == Triple::Win32)112 return cl::TokenizeWindowsCommandLine;113 return cl::TokenizeGNUCommandLine;114}115 116opt::InputArgList MinGWOptTable::parse(ArrayRef<const char *> argv) {117 unsigned missingIndex;118 unsigned missingCount;119 120 SmallVector<const char *, 256> vec(argv.data(), argv.data() + argv.size());121 cl::ExpandResponseFiles(saver(), getQuotingStyle(), vec);122 opt::InputArgList args = this->ParseArgs(vec, missingIndex, missingCount);123 124 if (missingCount)125 error(StringRef(args.getArgString(missingIndex)) + ": missing argument");126 for (auto *arg : args.filtered(OPT_UNKNOWN))127 error("unknown argument: " + arg->getAsString(args));128 return args;129}130 131// Find a file by concatenating given paths.132static std::optional<std::string> findFile(StringRef path1,133 const Twine &path2) {134 SmallString<128> s;135 sys::path::append(s, path1, path2);136 if (sys::fs::exists(s))137 return std::string(s);138 return std::nullopt;139}140 141// This is for -lfoo. We'll look for libfoo.dll.a or libfoo.a from search paths.142static std::string searchLibrary(StringRef name,143 ArrayRef<StringRef> searchPaths, bool bStatic,144 StringRef prefix) {145 if (name.starts_with(":")) {146 for (StringRef dir : searchPaths)147 if (std::optional<std::string> s = findFile(dir, name.substr(1)))148 return *s;149 error("unable to find library -l" + name);150 return "";151 }152 153 for (StringRef dir : searchPaths) {154 if (!bStatic) {155 if (std::optional<std::string> s = findFile(dir, "lib" + name + ".dll.a"))156 return *s;157 if (std::optional<std::string> s = findFile(dir, name + ".dll.a"))158 return *s;159 }160 if (std::optional<std::string> s = findFile(dir, "lib" + name + ".a"))161 return *s;162 if (std::optional<std::string> s = findFile(dir, name + ".lib"))163 return *s;164 if (!bStatic) {165 if (std::optional<std::string> s = findFile(dir, prefix + name + ".dll"))166 return *s;167 if (std::optional<std::string> s = findFile(dir, name + ".dll"))168 return *s;169 }170 }171 error("unable to find library -l" + name);172 return "";173}174 175static bool isI386Target(const opt::InputArgList &args,176 const Triple &defaultTarget) {177 auto *a = args.getLastArg(OPT_m);178 if (a)179 return StringRef(a->getValue()) == "i386pe";180 return defaultTarget.getArch() == Triple::x86;181}182 183namespace lld {184namespace coff {185bool link(ArrayRef<const char *> argsArr, llvm::raw_ostream &stdoutOS,186 llvm::raw_ostream &stderrOS, bool exitEarly, bool disableOutput);187}188 189namespace mingw {190// Convert Unix-ish command line arguments to Windows-ish ones and191// then call coff::link.192bool link(ArrayRef<const char *> argsArr, llvm::raw_ostream &stdoutOS,193 llvm::raw_ostream &stderrOS, bool exitEarly, bool disableOutput) {194 auto *ctx = new CommonLinkerContext;195 ctx->e.initialize(stdoutOS, stderrOS, exitEarly, disableOutput);196 197 MinGWOptTable parser;198 opt::InputArgList args = parser.parse(argsArr.slice(1));199 200 if (errorCount())201 return false;202 203 if (args.hasArg(OPT_help)) {204 printHelp(*ctx, argsArr[0]);205 return true;206 }207 208 // A note about "compatible with GNU linkers" message: this is a hack for209 // scripts generated by GNU Libtool 2.4.6 (released in February 2014 and210 // still the newest version in March 2017) or earlier to recognize LLD as211 // a GNU compatible linker. As long as an output for the -v option212 // contains "GNU" or "with BFD", they recognize us as GNU-compatible.213 if (args.hasArg(OPT_v) || args.hasArg(OPT_version))214 message(getLLDVersion() + " (compatible with GNU linkers)");215 216 // The behavior of -v or --version is a bit strange, but this is217 // needed for compatibility with GNU linkers.218 if (args.hasArg(OPT_v) && !args.hasArg(OPT_INPUT) && !args.hasArg(OPT_l))219 return true;220 if (args.hasArg(OPT_version))221 return true;222 223 if (!args.hasArg(OPT_INPUT) && !args.hasArg(OPT_l)) {224 error("no input files");225 return false;226 }227 228 Triple defaultTarget(Triple::normalize(sys::getDefaultTargetTriple()));229 230 std::vector<std::string> linkArgs;231 auto add = [&](const Twine &s) { linkArgs.push_back(s.str()); };232 233 add("lld-link");234 add("-lldmingw");235 236 if (auto *a = args.getLastArg(OPT_entry)) {237 StringRef s = a->getValue();238 if (isI386Target(args, defaultTarget) && s.starts_with("_"))239 add("-entry:" + s.substr(1));240 else if (!s.empty())241 add("-entry:" + s);242 else243 add("-noentry");244 }245 246 if (args.hasArg(OPT_major_os_version, OPT_minor_os_version,247 OPT_major_subsystem_version, OPT_minor_subsystem_version)) {248 StringRef majOSVer = args.getLastArgValue(OPT_major_os_version, "6");249 StringRef minOSVer = args.getLastArgValue(OPT_minor_os_version, "0");250 StringRef majSubSysVer = "6";251 StringRef minSubSysVer = "0";252 StringRef subSysName = "default";253 StringRef subSysVer;254 // Iterate over --{major,minor}-subsystem-version and --subsystem, and pick255 // the version number components from the last one of them that specifies256 // a version.257 for (auto *a : args.filtered(OPT_major_subsystem_version,258 OPT_minor_subsystem_version, OPT_subs)) {259 switch (a->getOption().getID()) {260 case OPT_major_subsystem_version:261 majSubSysVer = a->getValue();262 break;263 case OPT_minor_subsystem_version:264 minSubSysVer = a->getValue();265 break;266 case OPT_subs:267 std::tie(subSysName, subSysVer) = StringRef(a->getValue()).split(':');268 if (!subSysVer.empty()) {269 if (subSysVer.contains('.'))270 std::tie(majSubSysVer, minSubSysVer) = subSysVer.split('.');271 else272 majSubSysVer = subSysVer;273 }274 break;275 }276 }277 add("-osversion:" + majOSVer + "." + minOSVer);278 add("-subsystem:" + subSysName + "," + majSubSysVer + "." + minSubSysVer);279 } else if (args.hasArg(OPT_subs)) {280 StringRef subSys = args.getLastArgValue(OPT_subs, "default");281 StringRef subSysName, subSysVer;282 std::tie(subSysName, subSysVer) = subSys.split(':');283 StringRef sep = subSysVer.empty() ? "" : ",";284 add("-subsystem:" + subSysName + sep + subSysVer);285 }286 287 if (auto *a = args.getLastArg(OPT_out_implib))288 add("-implib:" + StringRef(a->getValue()));289 if (auto *a = args.getLastArg(OPT_stack))290 add("-stack:" + StringRef(a->getValue()));291 if (auto *a = args.getLastArg(OPT_output_def))292 add("-output-def:" + StringRef(a->getValue()));293 if (auto *a = args.getLastArg(OPT_image_base))294 add("-base:" + StringRef(a->getValue()));295 if (auto *a = args.getLastArg(OPT_map))296 add("-lldmap:" + StringRef(a->getValue()));297 if (auto *a = args.getLastArg(OPT_reproduce))298 add("-reproduce:" + StringRef(a->getValue()));299 if (auto *a = args.getLastArg(OPT_file_alignment))300 add("-filealign:" + StringRef(a->getValue()));301 if (auto *a = args.getLastArg(OPT_section_alignment))302 add("-align:" + StringRef(a->getValue()));303 if (auto *a = args.getLastArg(OPT_heap))304 add("-heap:" + StringRef(a->getValue()));305 if (auto *a = args.getLastArg(OPT_threads))306 add("-threads:" + StringRef(a->getValue()));307 308 if (auto *a = args.getLastArg(OPT_o))309 add("-out:" + StringRef(a->getValue()));310 else if (args.hasArg(OPT_shared))311 add("-out:a.dll");312 else313 add("-out:a.exe");314 315 if (auto *a = args.getLastArg(OPT_pdb)) {316 add("-debug");317 StringRef v = a->getValue();318 if (!v.empty())319 add("-pdb:" + v);320 if (args.hasArg(OPT_strip_all)) {321 add("-debug:nodwarf,nosymtab");322 } else if (args.hasArg(OPT_strip_debug)) {323 add("-debug:nodwarf,symtab");324 }325 } else if (args.hasArg(OPT_strip_debug)) {326 add("-debug:symtab");327 } else if (!args.hasArg(OPT_strip_all)) {328 add("-debug:dwarf");329 }330 if (auto *a = args.getLastArg(OPT_build_id)) {331 StringRef v = a->getValue();332 if (v == "none")333 add("-build-id:no");334 else {335 if (!v.empty())336 warn("unsupported build id hashing: " + v + ", using default hashing.");337 add("-build-id");338 }339 } else {340 if (args.hasArg(OPT_strip_debug) || args.hasArg(OPT_strip_all))341 add("-build-id:no");342 else343 add("-build-id");344 }345 346 if (auto *a = args.getLastArg(OPT_functionpadmin)) {347 StringRef v = a->getValue();348 if (v.empty())349 add("-functionpadmin");350 else351 add("-functionpadmin:" + v);352 }353 354 if (args.hasFlag(OPT_fatal_warnings, OPT_no_fatal_warnings, false))355 add("-WX");356 else357 add("-WX:no");358 359 if (args.hasFlag(OPT_enable_stdcall_fixup, OPT_disable_stdcall_fixup, false))360 add("-stdcall-fixup");361 else if (args.hasArg(OPT_disable_stdcall_fixup))362 add("-stdcall-fixup:no");363 364 if (args.hasArg(OPT_shared))365 add("-dll");366 if (args.hasArg(OPT_verbose))367 add("-verbose");368 if (args.hasArg(OPT_exclude_all_symbols))369 add("-exclude-all-symbols");370 if (args.hasArg(OPT_export_all_symbols))371 add("-export-all-symbols");372 if (args.hasArg(OPT_large_address_aware))373 add("-largeaddressaware");374 if (args.hasArg(OPT_kill_at))375 add("-kill-at");376 if (args.hasArg(OPT_appcontainer))377 add("-appcontainer");378 if (args.hasFlag(OPT_no_seh, OPT_disable_no_seh, false))379 add("-noseh");380 381 if (args.getLastArgValue(OPT_m) != "thumb2pe" &&382 args.getLastArgValue(OPT_m) != "arm64pe" &&383 args.getLastArgValue(OPT_m) != "arm64ecpe" &&384 args.hasFlag(OPT_disable_dynamicbase, OPT_dynamicbase, false))385 add("-dynamicbase:no");386 if (args.hasFlag(OPT_disable_high_entropy_va, OPT_high_entropy_va, false))387 add("-highentropyva:no");388 if (args.hasFlag(OPT_disable_nxcompat, OPT_nxcompat, false))389 add("-nxcompat:no");390 if (args.hasFlag(OPT_disable_tsaware, OPT_tsaware, false))391 add("-tsaware:no");392 393 if (args.hasFlag(OPT_disable_reloc_section, OPT_enable_reloc_section, false))394 add("-fixed");395 396 if (args.hasFlag(OPT_no_insert_timestamp, OPT_insert_timestamp, false))397 add("-timestamp:0");398 399 if (args.hasFlag(OPT_gc_sections, OPT_no_gc_sections, false))400 add("-opt:ref");401 else402 add("-opt:noref");403 404 if (args.hasFlag(OPT_demangle, OPT_no_demangle, true))405 add("-demangle");406 else407 add("-demangle:no");408 409 if (args.hasFlag(OPT_enable_auto_import, OPT_disable_auto_import, true))410 add("-auto-import");411 else412 add("-auto-import:no");413 if (args.hasFlag(OPT_enable_runtime_pseudo_reloc,414 OPT_disable_runtime_pseudo_reloc, true))415 add("-runtime-pseudo-reloc");416 else417 add("-runtime-pseudo-reloc:no");418 419 if (args.hasFlag(OPT_allow_multiple_definition,420 OPT_no_allow_multiple_definition, false))421 add("-force:multiple");422 423 if (auto *a = args.getLastArg(OPT_dependent_load_flag))424 add("-dependentloadflag:" + StringRef(a->getValue()));425 426 if (auto *a = args.getLastArg(OPT_icf)) {427 StringRef s = a->getValue();428 if (s == "all")429 add("-opt:icf");430 else if (s == "safe")431 add("-opt:safeicf");432 else if (s == "none")433 add("-opt:noicf");434 else435 error("unknown parameter: --icf=" + s);436 } else {437 add("-opt:noicf");438 }439 440 if (auto *a = args.getLastArg(OPT_m)) {441 StringRef s = a->getValue();442 if (s == "i386pe")443 add("-machine:x86");444 else if (s == "i386pep")445 add("-machine:x64");446 else if (s == "thumb2pe")447 add("-machine:arm");448 else if (s == "arm64pe")449 add("-machine:arm64");450 else if (s == "arm64ecpe")451 add("-machine:arm64ec");452 else if (s == "arm64xpe")453 add("-machine:arm64x");454 else if (s == "mipspe")455 add("-machine:mips");456 else457 error("unknown parameter: -m" + s);458 }459 460 if (args.hasFlag(OPT_guard_cf, OPT_no_guard_cf, false)) {461 if (args.hasFlag(OPT_guard_longjmp, OPT_no_guard_longjmp, true))462 add("-guard:cf,longjmp");463 else464 add("-guard:cf,nolongjmp");465 } else if (args.hasFlag(OPT_guard_longjmp, OPT_no_guard_longjmp, false)) {466 auto *a = args.getLastArg(OPT_guard_longjmp);467 warn("parameter " + a->getSpelling() +468 " only takes effect when used with --guard-cf");469 }470 471 if (auto *a = args.getLastArg(OPT_error_limit)) {472 int n;473 StringRef s = a->getValue();474 if (s.getAsInteger(10, n))475 error(a->getSpelling() + ": number expected, but got " + s);476 else477 add("-errorlimit:" + s);478 }479 480 if (auto *a = args.getLastArg(OPT_rpath))481 warn("parameter " + a->getSpelling() + " has no effect on PE/COFF targets");482 483 for (auto *a : args.filtered(OPT_mllvm))484 add("-mllvm:" + StringRef(a->getValue()));485 486 if (auto *arg = args.getLastArg(OPT_plugin_opt_mcpu_eq))487 add("-mllvm:-mcpu=" + StringRef(arg->getValue()));488 if (auto *arg = args.getLastArg(OPT_lto_O))489 add("-opt:lldlto=" + StringRef(arg->getValue()));490 if (auto *arg = args.getLastArg(OPT_lto_CGO))491 add("-opt:lldltocgo=" + StringRef(arg->getValue()));492 if (auto *arg = args.getLastArg(OPT_plugin_opt_dwo_dir_eq))493 add("-dwodir:" + StringRef(arg->getValue()));494 if (args.hasArg(OPT_lto_cs_profile_generate))495 add("-lto-cs-profile-generate");496 if (auto *arg = args.getLastArg(OPT_lto_cs_profile_file))497 add("-lto-cs-profile-file:" + StringRef(arg->getValue()));498 if (args.hasArg(OPT_plugin_opt_emit_llvm))499 add("-lldemit:llvm");500 if (args.hasArg(OPT_lto_emit_asm))501 add("-lldemit:asm");502 if (auto *arg = args.getLastArg(OPT_lto_sample_profile))503 add("-lto-sample-profile:" + StringRef(arg->getValue()));504 505 if (auto *a = args.getLastArg(OPT_thinlto_cache_dir))506 add("-lldltocache:" + StringRef(a->getValue()));507 if (auto *a = args.getLastArg(OPT_thinlto_cache_policy))508 add("-lldltocachepolicy:" + StringRef(a->getValue()));509 if (args.hasArg(OPT_thinlto_emit_imports_files))510 add("-thinlto-emit-imports-files");511 if (args.hasArg(OPT_thinlto_index_only))512 add("-thinlto-index-only");513 if (auto *arg = args.getLastArg(OPT_thinlto_index_only_eq))514 add("-thinlto-index-only:" + StringRef(arg->getValue()));515 if (auto *arg = args.getLastArg(OPT_thinlto_jobs_eq))516 add("-opt:lldltojobs=" + StringRef(arg->getValue()));517 if (auto *arg = args.getLastArg(OPT_thinlto_object_suffix_replace_eq))518 add("-thinlto-object-suffix-replace:" + StringRef(arg->getValue()));519 if (auto *arg = args.getLastArg(OPT_thinlto_prefix_replace_eq))520 add("-thinlto-prefix-replace:" + StringRef(arg->getValue()));521 522 for (auto *a : args.filtered(OPT_plugin_opt_eq_minus))523 add("-mllvm:-" + StringRef(a->getValue()));524 525 // GCC collect2 passes -plugin-opt=path/to/lto-wrapper with an absolute or526 // relative path. Just ignore. If not ended with "lto-wrapper" (or527 // "lto-wrapper.exe" for GCC cross-compiled for Windows), consider it an528 // unsupported LLVMgold.so option and error.529 for (opt::Arg *arg : args.filtered(OPT_plugin_opt_eq)) {530 StringRef v(arg->getValue());531 if (!v.ends_with("lto-wrapper") && !v.ends_with("lto-wrapper.exe"))532 error(arg->getSpelling() + ": unknown plugin option '" + arg->getValue() +533 "'");534 }535 536 for (auto *a : args.filtered(OPT_Xlink))537 add(a->getValue());538 539 if (isI386Target(args, defaultTarget))540 add("-alternatename:__image_base__=___ImageBase");541 else542 add("-alternatename:__image_base__=__ImageBase");543 544 for (auto *a : args.filtered(OPT_require_defined))545 add("-include:" + StringRef(a->getValue()));546 for (auto *a : args.filtered(OPT_undefined_glob))547 add("-includeglob:" + StringRef(a->getValue()));548 for (auto *a : args.filtered(OPT_undefined))549 add("-includeoptional:" + StringRef(a->getValue()));550 for (auto *a : args.filtered(OPT_delayload))551 add("-delayload:" + StringRef(a->getValue()));552 for (auto *a : args.filtered(OPT_wrap))553 add("-wrap:" + StringRef(a->getValue()));554 for (auto *a : args.filtered(OPT_exclude_symbols))555 add("-exclude-symbols:" + StringRef(a->getValue()));556 557 std::vector<StringRef> searchPaths;558 for (auto *a : args.filtered(OPT_L)) {559 searchPaths.push_back(a->getValue());560 add("-libpath:" + StringRef(a->getValue()));561 }562 563 StringRef dllPrefix = "lib";564 if (auto *arg = args.getLastArg(OPT_dll_search_prefix))565 dllPrefix = arg->getValue();566 567 StringRef prefix = "";568 bool isStatic = false;569 for (auto *a : args) {570 switch (a->getOption().getID()) {571 case OPT_INPUT:572 if (StringRef(a->getValue()).ends_with_insensitive(".def"))573 add("-def:" + StringRef(a->getValue()));574 else575 add(prefix + StringRef(a->getValue()));576 break;577 case OPT_l:578 add(prefix +579 searchLibrary(a->getValue(), searchPaths, isStatic, dllPrefix));580 break;581 case OPT_whole_archive:582 prefix = "-wholearchive:";583 break;584 case OPT_no_whole_archive:585 prefix = "";586 break;587 case OPT_Bstatic:588 isStatic = true;589 break;590 case OPT_Bdynamic:591 isStatic = false;592 break;593 }594 }595 596 if (errorCount())597 return false;598 599 if (args.hasArg(OPT_verbose) || args.hasArg(OPT__HASH_HASH_HASH))600 ctx->e.errs() << llvm::join(linkArgs, " ") << "\n";601 602 if (args.hasArg(OPT__HASH_HASH_HASH))603 return true;604 605 // Repack vector of strings to vector of const char pointers for coff::link.606 std::vector<const char *> vec;607 for (const std::string &s : linkArgs)608 vec.push_back(s.c_str());609 // Pass the actual binary name, to make error messages be printed with610 // the right prefix.611 vec[0] = argsArr[0];612 613 // The context will be re-created in the COFF driver.614 lld::CommonLinkerContext::destroy();615 616 return coff::link(vec, stdoutOS, stderrOS, exitEarly, disableOutput);617}618} // namespace mingw619} // namespace lld620