Skip to content

[include-cleaner] Fix a race issue when editing multiple files. #76960

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.

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 4 commits into from
Jan 5, 2024
Merged
Changes from all commits
Commits
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
58 changes: 31 additions & 27 deletions clang-tools-extra/include-cleaner/tool/IncludeCleaner.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
#include "clang/Tooling/Tooling.h"
#include "llvm/ADT/STLFunctionalExtras.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringMap.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/FormatVariadic.h"
#include "llvm/Support/MemoryBuffer.h"
#include "llvm/Support/Regex.h"
#include "llvm/Support/Signals.h"
#include "llvm/Support/raw_ostream.h"
Expand Down Expand Up @@ -110,14 +110,16 @@ format::FormatStyle getStyle(llvm::StringRef Filename) {

class Action : public clang::ASTFrontendAction {
public:
Action(llvm::function_ref<bool(llvm::StringRef)> HeaderFilter)
: HeaderFilter(HeaderFilter){};
Action(llvm::function_ref<bool(llvm::StringRef)> HeaderFilter,
llvm::StringMap<std::string> &EditedFiles)
: HeaderFilter(HeaderFilter), EditedFiles(EditedFiles) {}

private:
RecordedAST AST;
RecordedPP PP;
PragmaIncludes PI;
llvm::function_ref<bool(llvm::StringRef)> HeaderFilter;
llvm::StringMap<std::string> &EditedFiles;

bool BeginInvocation(CompilerInstance &CI) override {
// We only perform include-cleaner analysis. So we disable diagnostics that
Expand Down Expand Up @@ -181,17 +183,8 @@ class Action : public clang::ASTFrontendAction {
}
}

if (Edit && (!Results.Missing.empty() || !Results.Unused.empty())) {
if (auto Err = llvm::writeToOutput(
Path, [&](llvm::raw_ostream &OS) -> llvm::Error {
OS << Final;
return llvm::Error::success();
})) {
llvm::errs() << "Failed to apply edits to " << Path << ": "
<< toString(std::move(Err)) << "\n";
++Errors;
}
}
if (!Results.Missing.empty() || !Results.Unused.empty())
EditedFiles.try_emplace(Path, Final);
}

void writeHTML() {
Expand All @@ -215,11 +208,17 @@ class ActionFactory : public tooling::FrontendActionFactory {
: HeaderFilter(HeaderFilter) {}

std::unique_ptr<clang::FrontendAction> create() override {
return std::make_unique<Action>(HeaderFilter);
return std::make_unique<Action>(HeaderFilter, EditedFiles);
}

const llvm::StringMap<std::string> &editedFiles() const {
return EditedFiles;
}

private:
llvm::function_ref<bool(llvm::StringRef)> HeaderFilter;
// Map from file name to final code with the include edits applied.
llvm::StringMap<std::string> EditedFiles;
};

std::function<bool(llvm::StringRef)> headerFilter() {
Expand Down Expand Up @@ -274,21 +273,26 @@ int main(int argc, const char **argv) {

clang::tooling::ClangTool Tool(OptionsParser->getCompilations(),
OptionsParser->getSourcePathList());
std::vector<std::unique_ptr<llvm::MemoryBuffer>> Buffers;
for (const auto &File : OptionsParser->getSourcePathList()) {
auto Content = llvm::MemoryBuffer::getFile(File);
if (!Content) {
llvm::errs() << "Error: can't read file '" << File
<< "': " << Content.getError().message() << "\n";
return 1;
}
Buffers.push_back(std::move(Content.get()));
Tool.mapVirtualFile(File, Buffers.back()->getBuffer());
}

auto HeaderFilter = headerFilter();
if (!HeaderFilter)
return 1; // error already reported.
ActionFactory Factory(HeaderFilter);
return Tool.run(&Factory) || Errors != 0;
auto ErrorCode = Tool.run(&Factory);
if (Edit) {
for (const auto &NameAndContent : Factory.editedFiles()) {
llvm::StringRef FileName = NameAndContent.first();
const std::string &FinalCode = NameAndContent.second;
if (auto Err = llvm::writeToOutput(
FileName, [&](llvm::raw_ostream &OS) -> llvm::Error {
OS << FinalCode;
return llvm::Error::success();
})) {
llvm::errs() << "Failed to apply edits to " << FileName << ": "
<< toString(std::move(Err)) << "\n";
++Errors;
}
}
}
return ErrorCode || Errors != 0;
}