Skip to content

[clangd] Fix sysroot flag handling in CommandMangler to prevent duplicates #75694

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
Jan 12, 2024
+91 −13
Merged

[clangd] Fix sysroot flag handling in CommandMangler to prevent duplicates #75694

Show file tree
Hide file tree
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
23 changes: 13 additions & 10 deletions clang-tools-extra/clangd/CompileCommands.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,26 +328,29 @@ void CommandMangler::operator()(tooling::CompileCommand &Command,

tooling::addTargetAndModeForProgramName(Cmd, Cmd.front());

// Check whether the flag exists, either as -flag or -flag=*
auto Has = [&](llvm::StringRef Flag) {
for (llvm::StringRef Arg : Cmd) {
if (Arg.consume_front(Flag) && (Arg.empty() || Arg[0] == '='))
return true;
}
return false;
// Check whether the flag exists in the command.
auto HasExact = [&](llvm::StringRef Flag) {
return llvm::any_of(Cmd, [&](llvm::StringRef Arg) { return Arg == Flag; });
};

// Check whether the flag appears in the command as a prefix.
auto HasPrefix = [&](llvm::StringRef Flag) {
return llvm::any_of(
Cmd, [&](llvm::StringRef Arg) { return Arg.startswith(Flag); });
};

llvm::erase_if(Cmd, [](llvm::StringRef Elem) {
return Elem.starts_with("--save-temps") || Elem.starts_with("-save-temps");
});

std::vector<std::string> ToAppend;
if (ResourceDir && !Has("-resource-dir"))
if (ResourceDir && !HasExact("-resource-dir") && !HasPrefix("-resource-dir="))
ToAppend.push_back(("-resource-dir=" + *ResourceDir));

// Don't set `-isysroot` if it is already set or if `--sysroot` is set.
// `--sysroot` is a superset of the `-isysroot` argument.
if (Sysroot && !Has("-isysroot") && !Has("--sysroot")) {
if (Sysroot && !HasPrefix("-isysroot") && !HasExact("--sysroot") &&
!HasPrefix("--sysroot=")) {
ToAppend.push_back("-isysroot");
ToAppend.push_back(*Sysroot);
}
Expand All @@ -358,7 +361,7 @@ void CommandMangler::operator()(tooling::CompileCommand &Command,
}

if (!Cmd.empty()) {
bool FollowSymlink = !Has("-no-canonical-prefixes");
bool FollowSymlink = !HasExact("-no-canonical-prefixes");
Cmd.front() =
(FollowSymlink ? ResolvedDrivers : ResolvedDriversNoFollow)
.get(Cmd.front(), [&, this] {
Expand Down
81 changes: 78 additions & 3 deletions clang-tools-extra/clangd/unittests/CompileCommandsTests.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,9 +385,8 @@ TEST(ArgStripperTest, OrderDependent) {
}

TEST(PrintArgvTest, All) {
std::vector<llvm::StringRef> Args = {
"one", "two", "thr ee", "f\"o\"ur", "fi\\ve", "$"
};
std::vector<llvm::StringRef> Args = {"one", "two", "thr ee",
"f\"o\"ur", "fi\\ve", "$"};
const char *Expected = R"(one two "thr ee" "f\"o\"ur" "fi\\ve" $)";
EXPECT_EQ(Expected, printArgv(Args));
}
Expand Down Expand Up @@ -465,6 +464,82 @@ TEST(CommandMangler, PathsAsPositional) {
Mangler(Cmd, "a.cc");
EXPECT_THAT(Cmd.CommandLine, Contains("foo"));
}

TEST(CommandMangler, RespectsOriginalResourceDir) {
auto Mangler = CommandMangler::forTests();
Mangler.ResourceDir = testPath("fake/resources");

{
tooling::CompileCommand Cmd;
Cmd.CommandLine = {"clang++", "-resource-dir", testPath("true/resources"),
"foo.cc"};
Mangler(Cmd, "foo.cc");
EXPECT_THAT(llvm::join(Cmd.CommandLine, " "),
HasSubstr("-resource-dir " + testPath("true/resources")));
EXPECT_THAT(llvm::join(Cmd.CommandLine, " "),
Not(HasSubstr(testPath("fake/resources"))));
}

{
tooling::CompileCommand Cmd;
Cmd.CommandLine = {"clang++", "-resource-dir=" + testPath("true/resources"),
"foo.cc"};
Mangler(Cmd, "foo.cc");
EXPECT_THAT(llvm::join(Cmd.CommandLine, " "),
HasSubstr("-resource-dir=" + testPath("true/resources")));
EXPECT_THAT(llvm::join(Cmd.CommandLine, " "),
Not(HasSubstr(testPath("fake/resources"))));
}
}

TEST(CommandMangler, RespectsOriginalSysroot) {
auto Mangler = CommandMangler::forTests();
Mangler.Sysroot = testPath("fake/sysroot");

{
tooling::CompileCommand Cmd;
Cmd.CommandLine = {"clang++", "-isysroot", testPath("true/sysroot"),
"foo.cc"};
Mangler(Cmd, "foo.cc");
EXPECT_THAT(llvm::join(Cmd.CommandLine, " "),
HasSubstr("-isysroot " + testPath("true/sysroot")));
EXPECT_THAT(llvm::join(Cmd.CommandLine, " "),
Not(HasSubstr(testPath("fake/sysroot"))));
}

{
tooling::CompileCommand Cmd;
Cmd.CommandLine = {"clang++", "-isysroot" + testPath("true/sysroot"),
"foo.cc"};
Mangler(Cmd, "foo.cc");
EXPECT_THAT(llvm::join(Cmd.CommandLine, " "),
HasSubstr("-isysroot" + testPath("true/sysroot")));
EXPECT_THAT(llvm::join(Cmd.CommandLine, " "),
Not(HasSubstr(testPath("fake/sysroot"))));
}

{
tooling::CompileCommand Cmd;
Cmd.CommandLine = {"clang++", "--sysroot", testPath("true/sysroot"),
"foo.cc"};
Mangler(Cmd, "foo.cc");
EXPECT_THAT(llvm::join(Cmd.CommandLine, " "),
HasSubstr("--sysroot " + testPath("true/sysroot")));
EXPECT_THAT(llvm::join(Cmd.CommandLine, " "),
Not(HasSubstr(testPath("fake/sysroot"))));
}

{
tooling::CompileCommand Cmd;
Cmd.CommandLine = {"clang++", "--sysroot=" + testPath("true/sysroot"),
"foo.cc"};
Mangler(Cmd, "foo.cc");
EXPECT_THAT(llvm::join(Cmd.CommandLine, " "),
HasSubstr("--sysroot=" + testPath("true/sysroot")));
EXPECT_THAT(llvm::join(Cmd.CommandLine, " "),
Not(HasSubstr(testPath("fake/sysroot"))));
}
}
} // namespace
} // namespace clangd
} // namespace clang