Skip to content

[LLD] [COFF] Rewrite handling of the /debug: option. NFC. #75175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 15, 2023
Merged

[LLD] [COFF] Rewrite handling of the /debug: option. NFC. #75175

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 42 additions & 57 deletions lld/COFF/Driver.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -858,46 +858,6 @@ static std::string createResponseFile(const opt::InputArgList &args,
return std::string(data.str());
}

enum class DebugKind {
Unknown,
None,
Full,
FastLink,
GHash,
NoGHash,
Dwarf,
Symtab
};

static DebugKind parseDebugKind(const opt::InputArgList &args) {
auto *a = args.getLastArg(OPT_debug, OPT_debug_opt);
if (!a)
return DebugKind::None;
if (a->getNumValues() == 0)
return DebugKind::Full;

DebugKind debug = StringSwitch<DebugKind>(a->getValue())
.CaseLower("none", DebugKind::None)
.CaseLower("full", DebugKind::Full)
.CaseLower("fastlink", DebugKind::FastLink)
// LLD extensions
.CaseLower("ghash", DebugKind::GHash)
.CaseLower("noghash", DebugKind::NoGHash)
.CaseLower("dwarf", DebugKind::Dwarf)
.CaseLower("symtab", DebugKind::Symtab)
.Default(DebugKind::Unknown);

if (debug == DebugKind::FastLink) {
warn("/debug:fastlink unsupported; using /debug:full");
return DebugKind::Full;
}
if (debug == DebugKind::Unknown) {
error("/debug: unknown option: " + Twine(a->getValue()));
return DebugKind::None;
}
return debug;
}

static unsigned parseDebugTypes(const opt::InputArgList &args) {
unsigned debugTypes = static_cast<unsigned>(DebugType::None);

Expand Down Expand Up @@ -1647,13 +1607,47 @@ void LinkerDriver::linkerMain(ArrayRef<const char *> argsArr) {
if (args.hasArg(OPT_force, OPT_force_multipleres))
config->forceMultipleRes = true;

// Don't warn about long section names, such as .debug_info, for mingw (or
// when -debug:dwarf is requested, handled below).
if (config->mingw)
config->warnLongSectionNames = false;

bool doGC = true;

// Handle /debug
DebugKind debug = parseDebugKind(args);
if (debug == DebugKind::Full || debug == DebugKind::Dwarf ||
debug == DebugKind::GHash || debug == DebugKind::NoGHash) {
config->debug = true;
config->incremental = true;
config->includeDwarfChunks = true;
bool shouldCreatePDB = false;
if (auto *arg = args.getLastArg(OPT_debug, OPT_debug_opt)) {
std::string s;
if (arg->getOption().getID() == OPT_debug)
s = "full";
else
s = StringRef(arg->getValue()).lower();
if (s == "fastlink") {
warn("/debug:fastlink unsupported; using /debug:full");
s = "full";
}
if (s == "none") {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe make doGC default to false and set to true here. So the following doGC = false can be removed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But if there's no /debug: option at all, then we'd go with the initial value of doGC - which should be true for that case.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ZequanWu Can you follow up here?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I missed that. That makes sense.

} else if (s == "full" || s == "ghash" || s == "noghash") {
config->debug = true;
config->incremental = true;
config->includeDwarfChunks = true;
if (s == "full" || s == "ghash")
config->debugGHashes = true;
shouldCreatePDB = true;
doGC = false;
} else if (s == "dwarf") {
config->debug = true;
config->incremental = true;
config->includeDwarfChunks = true;
config->writeSymtab = true;
config->warnLongSectionNames = false;
doGC = false;
} else if (s == "symtab") {
config->writeSymtab = true;
doGC = false;
} else {
error("/debug: unknown option: " + s);
}
}

// Handle /demangle
Expand All @@ -1673,9 +1667,6 @@ void LinkerDriver::linkerMain(ArrayRef<const char *> argsArr) {
config->driverUponly || config->driverWdm || args.hasArg(OPT_driver);

// Handle /pdb
bool shouldCreatePDB =
(debug == DebugKind::Full || debug == DebugKind::GHash ||
debug == DebugKind::NoGHash);
if (shouldCreatePDB) {
if (auto *arg = args.getLastArg(OPT_pdb))
config->pdbPath = arg->getValue();
Expand Down Expand Up @@ -1838,8 +1829,9 @@ void LinkerDriver::linkerMain(ArrayRef<const char *> argsArr) {

config->noimplib = args.hasArg(OPT_noimplib);

if (args.hasArg(OPT_profile))
doGC = true;
// Handle /opt.
bool doGC = debug == DebugKind::None || args.hasArg(OPT_profile);
std::optional<ICFLevel> icfLevel;
if (args.hasArg(OPT_profile))
icfLevel = ICFLevel::None;
Expand Down Expand Up @@ -2030,8 +2022,6 @@ void LinkerDriver::linkerMain(ArrayRef<const char *> argsArr) {
parseSwaprun(arg->getValue());
config->terminalServerAware =
!config->dll && args.hasFlag(OPT_tsaware, OPT_tsaware_no, true);
config->debugGHashes = debug == DebugKind::GHash || debug == DebugKind::Full;
config->writeSymtab = debug == DebugKind::Dwarf || debug == DebugKind::Symtab;
config->autoImport =
args.hasFlag(OPT_auto_import, OPT_auto_import_no, config->mingw);
config->pseudoRelocs = args.hasFlag(
Expand All @@ -2048,11 +2038,6 @@ void LinkerDriver::linkerMain(ArrayRef<const char *> argsArr) {
if (args.hasFlag(OPT_inferasanlibs, OPT_inferasanlibs_no, false))
warn("ignoring '/inferasanlibs', this flag is not supported");

// Don't warn about long section names, such as .debug_info, for mingw or
// when -debug:dwarf is requested.
if (config->mingw || debug == DebugKind::Dwarf)
config->warnLongSectionNames = false;

if (config->incremental && args.hasArg(OPT_profile)) {
warn("ignoring '/incremental' due to '/profile' specification");
config->incremental = false;
Expand Down