1 //===--- AllTUsExecution.h - Execute actions on all TUs. -*- C++ --------*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 // This file defines a tool executor that runs given actions on all TUs in the
10 // compilation database. Tool results are deuplicated by the result key.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_TOOLING_ALLTUSEXECUTION_H
15 #define LLVM_CLANG_TOOLING_ALLTUSEXECUTION_H
17 #include "clang/Tooling/ArgumentsAdjusters.h"
18 #include "clang/Tooling/Execution.h"
23 /// Executes given frontend actions on all files/TUs in the compilation
25 class AllTUsToolExecutor : public ToolExecutor {
27 static const char *ExecutorName;
29 /// Init with \p CompilationDatabase.
30 /// This uses \p ThreadCount threads to exececute the actions on all files in
31 /// parallel. If \p ThreadCount is 0, this uses `llvm::hardware_concurrency`.
32 AllTUsToolExecutor(const CompilationDatabase &Compilations,
34 std::shared_ptr<PCHContainerOperations> PCHContainerOps =
35 std::make_shared<PCHContainerOperations>());
37 /// Init with \p CommonOptionsParser. This is expected to be used by
38 /// `createExecutorFromCommandLineArgs` based on commandline options.
40 /// The executor takes ownership of \p Options.
41 AllTUsToolExecutor(CommonOptionsParser Options, unsigned ThreadCount,
42 std::shared_ptr<PCHContainerOperations> PCHContainerOps =
43 std::make_shared<PCHContainerOperations>());
45 StringRef getExecutorName() const override { return ExecutorName; }
47 using ToolExecutor::execute;
50 execute(llvm::ArrayRef<
51 std::pair<std::unique_ptr<FrontendActionFactory>, ArgumentsAdjuster>>
54 ExecutionContext *getExecutionContext() override { return &Context; };
56 ToolResults *getToolResults() override { return Results.get(); }
58 void mapVirtualFile(StringRef FilePath, StringRef Content) override {
59 OverlayFiles[FilePath] = Content;
63 // Used to store the parser when the executor is initialized with parser.
64 llvm::Optional<CommonOptionsParser> OptionsParser;
65 const CompilationDatabase &Compilations;
66 std::unique_ptr<ToolResults> Results;
67 ExecutionContext Context;
68 llvm::StringMap<std::string> OverlayFiles;
72 extern llvm::cl::opt<unsigned> ExecutorConcurrency;
73 extern llvm::cl::opt<std::string> Filter;
75 } // end namespace tooling
76 } // end namespace clang
78 #endif // LLVM_CLANG_TOOLING_ALLTUSEXECUTION_H