clang  6.0.0svn
Execution.h
Go to the documentation of this file.
1 //===--- Execution.h - Executing clang frontend actions -*- C++ ---------*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines framework for executing clang frontend actions.
11 //
12 // The framework can be extended to support different execution plans including
13 // standalone execution on the given TUs or parallel execution on all TUs in
14 // the codebase.
15 //
16 // In order to enable multiprocessing execution, tool actions are expected to
17 // output result into the ToolResults provided by the executor. The
18 // `ToolResults` is an interface that abstracts how results are stored e.g.
19 // in-memory for standalone execution or on-disk for large-scale execution.
20 //
21 // New executors can be registered as ToolExecutorPlugins via the
22 // `ToolExecutorPluginRegistry`. CLI tools can use
23 // `createExecutorFromCommandLineArgs` to create a specific registered executor
24 // according to the command-line arguments.
25 //
26 //===----------------------------------------------------------------------===//
27 
28 #ifndef LLVM_CLANG_TOOLING_EXECUTION_H
29 #define LLVM_CLANG_TOOLING_EXECUTION_H
30 
32 #include "clang/Tooling/Tooling.h"
33 #include "llvm/Support/Error.h"
34 #include "llvm/Support/Registry.h"
35 
36 namespace clang {
37 namespace tooling {
38 
39 /// \brief An abstraction for the result of a tool execution. For example, the
40 /// underlying result can be in-memory or on-disk.
41 ///
42 /// Results should be string key-value pairs. For example, a refactoring tool
43 /// can use source location as key and a replacement in YAML format as value.
44 class ToolResults {
45 public:
46  virtual ~ToolResults() = default;
47  virtual void addResult(StringRef Key, StringRef Value) = 0;
48  virtual std::vector<std::pair<std::string, std::string>> AllKVResults() = 0;
49  virtual void forEachResult(
50  llvm::function_ref<void(StringRef Key, StringRef Value)> Callback) = 0;
51 };
52 
54 public:
55  void addResult(StringRef Key, StringRef Value) override;
56  std::vector<std::pair<std::string, std::string>> AllKVResults() override;
57  void forEachResult(llvm::function_ref<void(StringRef Key, StringRef Value)>
58  Callback) override;
59 
60 private:
61  std::vector<std::pair<std::string, std::string>> KVResults;
62 };
63 
64 /// \brief The context of an execution, including the information about
65 /// compilation and results.
67 public:
68  virtual ~ExecutionContext() {}
69 
70  /// \brief Initializes a context. This does not take ownership of `Results`.
71  explicit ExecutionContext(ToolResults *Results) : Results(Results) {}
72 
73  /// \brief Adds a KV pair to the result container of this execution.
74  void reportResult(StringRef Key, StringRef Value);
75 
76  // Returns the source control system's revision number if applicable.
77  // Otherwise returns an empty string.
78  virtual std::string getRevision() { return ""; }
79 
80  // Returns the corpus being analyzed, e.g. "llvm" for the LLVM codebase, if
81  // applicable.
82  virtual std::string getCorpus() { return ""; }
83 
84  // Returns the currently processed compilation unit if available.
85  virtual std::string getCurrentCompilationUnit() { return ""; }
86 
87 private:
88  ToolResults *Results;
89 };
90 
91 /// \brief Interface for executing clang frontend actions.
92 ///
93 /// This can be extended to support running tool actions in different
94 /// execution mode, e.g. on a specific set of TUs or many TUs in parallel.
95 ///
96 /// New executors can be registered as ToolExecutorPlugins via the
97 /// `ToolExecutorPluginRegistry`. CLI tools can use
98 /// `createExecutorFromCommandLineArgs` to create a specific registered
99 /// executor according to the command-line arguments.
101 public:
102  virtual ~ToolExecutor() {}
103 
104  /// \brief Returns the name of a specific executor.
105  virtual StringRef getExecutorName() const = 0;
106 
107  /// \brief Executes each action with a corresponding arguments adjuster.
108  virtual llvm::Error
109  execute(llvm::ArrayRef<
110  std::pair<std::unique_ptr<FrontendActionFactory>, ArgumentsAdjuster>>
111  Actions) = 0;
112 
113  /// \brief Convenient functions for the above `execute`.
114  llvm::Error execute(std::unique_ptr<FrontendActionFactory> Action);
115  /// Executes an action with an argument adjuster.
116  llvm::Error execute(std::unique_ptr<FrontendActionFactory> Action,
117  ArgumentsAdjuster Adjuster);
118 
119  /// \brief Returns a reference to the execution context.
120  ///
121  /// This should be passed to tool callbacks, and tool callbacks should report
122  /// results via the returned context.
123  virtual ExecutionContext *getExecutionContext() = 0;
124 
125  /// \brief Returns a reference to the result container.
126  ///
127  /// NOTE: This should only be used after the execution finishes. Tool
128  /// callbacks should report results via `ExecutionContext` instead.
129  virtual ToolResults *getToolResults() = 0;
130 
131  /// \brief Map a virtual file to be used while running the tool.
132  ///
133  /// \param FilePath The path at which the content will be mapped.
134  /// \param Content A buffer of the file's content.
135  virtual void mapVirtualFile(StringRef FilePath, StringRef Content) = 0;
136 };
137 
138 /// \brief Interface for factories that create specific executors. This is also
139 /// used as a plugin to be registered into ToolExecutorPluginRegistry.
141 public:
142  virtual ~ToolExecutorPlugin() {}
143 
144  /// \brief Create an `ToolExecutor`.
145  ///
146  /// `OptionsParser` can be consumed (e.g. moved) if the creation succeeds.
148  create(CommonOptionsParser &OptionsParser) = 0;
149 };
150 
151 /// \brief This creates a ToolExecutor that is in the global registry based on
152 /// commandline arguments.
153 ///
154 /// This picks the right executor based on the `--executor` option. This parses
155 /// the commandline arguments with `CommonOptionsParser`, so caller does not
156 /// need to parse again.
157 ///
158 /// By default, this creates a `StandaloneToolExecutor` ("standalone") if
159 /// `--executor` is not provided.
161 createExecutorFromCommandLineArgs(int &argc, const char **argv,
162  llvm::cl::OptionCategory &Category,
163  const char *Overview = nullptr);
164 
165 namespace internal {
167 createExecutorFromCommandLineArgsImpl(int &argc, const char **argv,
168  llvm::cl::OptionCategory &Category,
169  const char *Overview = nullptr);
170 } // end namespace internal
171 
172 } // end namespace tooling
173 } // end namespace clang
174 
175 #endif // LLVM_CLANG_TOOLING_EXECUTION_H
virtual std::string getRevision()
Definition: Execution.h:78
llvm::Expected< std::unique_ptr< ToolExecutor > > createExecutorFromCommandLineArgsImpl(int &argc, const char **argv, llvm::cl::OptionCategory &Category, const char *Overview=nullptr)
Definition: Execution.cpp:59
ExecutionContext(ToolResults *Results)
Initializes a context. This does not take ownership of Results.
Definition: Execution.h:71
The context of an execution, including the information about compilation and results.
Definition: Execution.h:66
int Category
Definition: Format.cpp:1348
virtual ~ToolResults()=default
virtual void addResult(StringRef Key, StringRef Value)=0
virtual std::vector< std::pair< std::string, std::string > > AllKVResults()=0
std::function< CommandLineArguments(const CommandLineArguments &, StringRef Filename)> ArgumentsAdjuster
A prototype of a command line adjuster.
Interface for executing clang frontend actions.
Definition: Execution.h:100
virtual std::string getCurrentCompilationUnit()
Definition: Execution.h:85
virtual void forEachResult(llvm::function_ref< void(StringRef Key, StringRef Value)> Callback)=0
A parser for options common to all command-line Clang tools.
Dataflow Directional Tag Classes.
An abstraction for the result of a tool execution.
Definition: Execution.h:44
std::unique_ptr< DiagnosticConsumer > create(StringRef OutputFile, DiagnosticOptions *Diags, bool MergeChildRecords=false)
Returns a DiagnosticConsumer that serializes diagnostics to a bitcode file.
llvm::Expected< std::unique_ptr< ToolExecutor > > createExecutorFromCommandLineArgs(int &argc, const char **argv, llvm::cl::OptionCategory &Category, const char *Overview=nullptr)
This creates a ToolExecutor that is in the global registry based on commandline arguments.
Definition: Execution.cpp:91
Interface for factories that create specific executors.
Definition: Execution.h:140
virtual std::string getCorpus()
Definition: Execution.h:82