Skip to content

[clang-include-cleaner] Fix incorrect directory issue for writing files #111375

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 9 commits into from
Oct 17, 2024
Merged

[clang-include-cleaner] Fix incorrect directory issue for writing files #111375

Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
23b90bb
[clang-include-cleaner] Fix incorrect directory issue for writing files
bc-lee Oct 7, 2024
eef397c
Fix path issue identified by @kadircet
bc-lee Oct 9, 2024
2409d6f
Apply code review feedback
bc-lee Oct 10, 2024
0c9477d
Add test cases where the cwd and the compilation database's directory…
bc-lee Oct 10, 2024
dec9be8
Fix the previous commit that removed existing test cases
bc-lee Oct 10, 2024
b39f36e
Make clang-format happy
bc-lee Oct 10, 2024
3a0f02e
Fix unittest failures in Windows
bc-lee Oct 10, 2024
c65d828
Apply review comments.
bc-lee Oct 13, 2024
11f78a3
Apply review comments
bc-lee Oct 14, 2024
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
73 changes: 72 additions & 1 deletion clang-tools-extra/include-cleaner/tool/IncludeCleaner.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ class Action : public clang::ASTFrontendAction {
if (!HTMLReportPath.empty())
writeHTML();

// Source File's path relative to compilation database.
llvm::StringRef Path =
Copy link
Member

@kadircet kadircet Oct 9, 2024

Choose a reason for hiding this comment

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

can we keep reporting with abs-paths here, i.e:

llvm::SmallString<256> AbsPath(SM.getFileEntryRefForID(SM.getMainFileID())->getName());
SM.getFileManager().makeAbsolutePath(AbsPath);
...

This way we can recognize these paths in main and perform the mapping accordingly.

SM.getFileEntryRefForID(SM.getMainFileID())->getName();
assert(!Path.empty() && "Main file path not known?");
Expand Down Expand Up @@ -280,6 +281,42 @@ std::function<bool(llvm::StringRef)> headerFilter() {
};
}

llvm::ErrorOr<std::string> getCurrentWorkingDirectory() {
llvm::SmallString<256> CurrentPath;
if (const std::error_code EC = llvm::sys::fs::current_path(CurrentPath))
return llvm::ErrorOr<std::string>(EC);
return std::string(CurrentPath.str());
}

std::optional<std::string>
adjustCompilationPath(const std::string &Filename, const std::string &Directory,
const std::string &CurrentWorkingDirectory) {
if (llvm::sys::path::is_absolute(Filename)) {
// If the file path is already absolute, use it as is.
return Filename;
}

auto Sept = llvm::sys::path::get_separator().str();
// First, try to find the file based on the compilation database.
std::string FilePath = Directory + Sept + Filename;
// Check if it is writable.
if (llvm::sys::fs::access(FilePath, llvm::sys::fs::AccessMode::Write) !=
std::error_code()) {
// If not, try to find the file based on the current working
// directory, as some Bazel invocations may not set the compilation
// invocation's filesystem as non-writable. In such cases, we can
// find the file based on the current working directory.
FilePath =
static_cast<std::string>(CurrentWorkingDirectory) + Sept + Filename;
if (llvm::sys::fs::access(FilePath, llvm::sys::fs::AccessMode::Write) !=
std::error_code()) {
llvm::errs() << "Failed to find a writable path for " << Filename << "\n";
return std::nullopt;
}
}
return FilePath;
}

} // namespace
} // namespace include_cleaner
} // namespace clang
Expand All @@ -305,7 +342,32 @@ int main(int argc, const char **argv) {
}
}

clang::tooling::ClangTool Tool(OptionsParser->getCompilations(),
auto &CompilationDatabase = OptionsParser->getCompilations();
Copy link
Member

@kadircet kadircet Oct 9, 2024

Choose a reason for hiding this comment

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

i think this can be simplified with something like:

auto VFS = llvm::vfs::getRealFileSystem();
auto &CDB = OptionsParser->getCompilations();
std::map<std::string, std::string> CDBToAbsPaths;
for (auto &Source : OptionsParser->getSourcePathList()) {
  llvm::SmallString<256> AbsPath(Source);
  if (auto Err = VFS.makeAbsolute(AbsPath)) {
      llvm::errs() << "Failed to get absolute path for " << Source << " : " <<  Err.message() << '\n';
      return 1;
  }
  for(auto Cmd : CDB.getCompilecommands(AbsPath)) {
    llvm::SmallString<256> CDBPath(Cmd.Filename);
    llvm::sys::fs::make_absolute(Cmd.Directory, CDBPath);
    CDBToAbsPaths[CDBPath] = AbsPath;
  }
}
....
if (Edit) {
  for (const auto &NameAndContent : Factory.editedFiles()) {
     llvm::StringRef FileName = NameAndContent.first();
     if (auto It = CDBToAbsPaths.find(FileName); It != CDBToAbsPaths.end())
         FileName = It->second;
     ...
  }
}

Copy link
Contributor Author

@bc-lee bc-lee Oct 10, 2024

Choose a reason for hiding this comment

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

I didn't simplify it much, but I tried to explain my intent as clearly as possible. However, I feel the code is somewhat verbose.

// Mapping of edited file paths to their actual paths.
std::map<std::string, std::string> EditedFilesToActualFiles;
if (Edit) {
Copy link
Member

@kadircet kadircet Oct 10, 2024

Choose a reason for hiding this comment

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

nit: I don't think it saves much to do this only when Edit is on, parsing C++ is way slower than anything we can do here over a couple of filenames.

Copy link
Contributor Author

@bc-lee bc-lee Oct 13, 2024

Choose a reason for hiding this comment

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

Done. Removed the check for Edit mode.

std::vector<clang::tooling::CompileCommand> Commands =
CompilationDatabase.getAllCompileCommands();
auto CurrentWorkingDirectory = getCurrentWorkingDirectory();
// if (CurrentWorkingDirectory.get()
if (auto EC = CurrentWorkingDirectory.getError()) {
llvm::errs() << "Failed to get current working directory: "
<< EC.message() << "\n";
return 1;
}

for (const auto &Command : Commands) {
auto AdjustedFilePath = adjustCompilationPath(
Command.Filename, Command.Directory, CurrentWorkingDirectory.get());
if (!AdjustedFilePath.has_value()) {
// We already printed an error message.
return 1;
}
EditedFilesToActualFiles[Command.Filename] = AdjustedFilePath.value();
}
}

clang::tooling::ClangTool Tool(CompilationDatabase,
OptionsParser->getSourcePathList());

auto HeaderFilter = headerFilter();
Expand All @@ -316,6 +378,15 @@ int main(int argc, const char **argv) {
if (Edit) {
for (const auto &NameAndContent : Factory.editedFiles()) {
llvm::StringRef FileName = NameAndContent.first();
auto AdjustedFilePathIter = EditedFilesToActualFiles.find(FileName.str());
if (AdjustedFilePathIter != EditedFilesToActualFiles.end()) {
FileName = AdjustedFilePathIter->second;
} else {
llvm::errs() << "Failed to find the actual path for " << FileName
<< "\n";
++Errors;
}

const std::string &FinalCode = NameAndContent.second;
if (auto Err = llvm::writeToOutput(
FileName, [&](llvm::raw_ostream &OS) -> llvm::Error {
Expand Down
Loading