[Tooling] Add "-filter" option to AllTUsExecution

[hokein]

Summary

We can run the tools on a subset files of compilation database.

[ioeric]

lib/Tooling/AllTUsExecution.cpp

58

Please also mention that this only applies to all-TUs.

121

Filter.getNumOccurrences() != 0

Would this work if Filter is set grammatically? Although it's not exposed now, it might make more sense to check Filter != ".*".

[hokein]

Update comment.

[hokein]

lib/Tooling/AllTUsExecution.cpp

121

Yes, getNumOccurrences returns non-zero only when the flag is set by the command line.

clang-tool -executor=all-TUs .  # => getNumOccurrences() == 0
clang-tool -executor=all-TUs -filter="xx" .  #  > getNumOccurrences() != 0

[ioeric]

lib/Tooling/AllTUsExecution.cpp

121

Sorry, I meant "programmatically"... something like Filter.setInitialValue("...").

[hokein]

Remove the default value check.

lib/Tooling/AllTUsExecution.cpp

121

hmm, it works the same as llvm::cl::init (getNumOccurrences returns 0).

I removed this check (just use if (!Filter.match)), the reason I added here is to avoid the cost of regex match, but it seems pre-optimization.

[ioeric]

lib/Tooling/AllTUsExecution.cpp

121

sounds good.

[ioeric]

maybe add a test?

[hokein]

Add test.

include/clang/Tooling/AllTUsExecution.h

private:
   llvm::Optional<CommonOptionsParser> OptionsParser;
   const CompilationDatabase &Compilations;
   std::unique_ptr<ToolResults> Results;
   ExecutionContext Context;
   llvm::StringMap<std::string> OverlayFiles;
   unsigned ThreadCount;
 };
 
+extern llvm::cl::opt<std::string> Filter;
+
 } // end namespace tooling
 } // end namespace clang
 
 #endif // LLVM_CLANG_TOOLING_ALLTUSEXECUTION_H

lib/Tooling/AllTUsExecution.cpp

 
 private:
   InMemoryToolResults Results;
   std::mutex Mutex;
 };
 
 } // namespace
 
+llvm::cl::opt<std::string>
+    Filter("filter",
+           llvm::cl::desc("Only process files that match this filter. "
+                          "This flag only applies to all-TUs."),
+           llvm::cl::init(".*"));
+
 AllTUsToolExecutor::AllTUsToolExecutor(
     const CompilationDatabase &Compilations, unsigned ThreadCount,
     std::shared_ptr<PCHContainerOperations> PCHContainerOps)
     : Compilations(Compilations), Results(new ThreadSafeToolResults),
       Context(Results.get()), ThreadCount(ThreadCount) {}
 
 AllTUsToolExecutor::AllTUsToolExecutor(
     CommonOptionsParser Options, unsigned ThreadCount,
auto &Action = Actions.front();
     llvm::ThreadPool Pool(ThreadCount == 0 ? llvm::hardware_concurrency()
                                            : ThreadCount);
     llvm::SmallString<128> InitialWorkingDir;
     if (auto EC = llvm::sys::fs::current_path(InitialWorkingDir)) {
       InitialWorkingDir = "";
       llvm::errs() << "Error while getting current working directory: "
                    << EC.message() << "\n";
     }
+    llvm::Regex RegexFilter(Filter);
     for (std::string File : Files) {
+      if (!RegexFilter.match(File))
+        continue;
       Pool.async(
           [&](std::string Path) {
             Log("[" + std::to_string(Count()) + "/" + TotalNumStr +
                 "] Processing file " + Path);
             ClangTool Tool(Compilations, {Path});
             Tool.appendArgumentsAdjuster(Action.second);
             Tool.appendArgumentsAdjuster(getDefaultArgumentsAdjusters());
             for (const auto &FileAndContent : OverlayFiles)
if (!ErrorMsg.empty())
     return make_string_error(ErrorMsg);
 
   return llvm::Error::success();
 }
 
 static llvm::cl::opt<unsigned> ExecutorConcurrency(
     "execute-concurrency",
     llvm::cl::desc("The number of threads used to process all files in "
-                   "parallel. Set to 0 for hardware concurrency."),
+                   "parallel. Set to 0 for hardware concurrency. "
+                   "This flag only applies to all-TUs."),
     llvm::cl::init(0));
 
 class AllTUsToolExecutorPlugin : public ToolExecutorPlugin {
 public:
   llvm::Expected<std::unique_ptr<ToolExecutor>>
   create(CommonOptionsParser &OptionsParser) override {
     if (OptionsParser.getSourcePathList().empty())
       return make_string_error(

unittests/Tooling/ExecutionTest.cpp

 private:
   FixedCompilationDatabase FixedCompilations;
   std::vector<std::string> Files;
 };
 
 MATCHER_P(Named, Name, "") { return arg.first == Name; }
 
 TEST(AllTUsToolTest, AFewFiles) {
-  FixedCompilationDatabaseWithFiles Compilations(".", {"a.cc", "b.cc", "c.cc"},
-                                                 std::vector<std::string>());
+  FixedCompilationDatabaseWithFiles Compilations(
+      ".", {"a.cc", "b.cc", "c.cc", "ignore.cc"}, std::vector<std::string>());
   AllTUsToolExecutor Executor(Compilations, /*ThreadCount=*/0);
+  Filter.setValue("[a-c].cc");
   Executor.mapVirtualFile("a.cc", "void x() {}");
   Executor.mapVirtualFile("b.cc", "void y() {}");
   Executor.mapVirtualFile("c.cc", "void z() {}");
+  Executor.mapVirtualFile("ignore.cc", "void d() {}");
 
   auto Err = Executor.execute(std::unique_ptr<FrontendActionFactory>(
       new ReportResultActionFactory(Executor.getExecutionContext())));
   ASSERT_TRUE(!Err);
   EXPECT_THAT(
       Executor.getToolResults()->AllKVResults(),
       ::testing::UnorderedElementsAre(Named("x"), Named("y"), Named("z")));
+  Filter.setValue(".*"); // reset to default value.
 }
 
 TEST(AllTUsToolTest, ManyFiles) {
   unsigned NumFiles = 100;
   std::vector<std::string> Files;
   std::map<std::string, std::string> FileToContent;
   std::vector<std::string> ExpectedSymbols;
   for (unsigned i = 1; i <= NumFiles; ++i) {