clang  16.0.0git
ExecuteCompilerInvocation.cpp
Go to the documentation of this file.
1 //===--- ExecuteCompilerInvocation.cpp ------------------------------------===//
2 //
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
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file holds ExecuteCompilerInvocation(). It is split into its own file to
10 // minimize the impact of pulling in essentially everything else in Clang.
11 //
12 //===----------------------------------------------------------------------===//
13 
16 #include "clang/Config/config.h"
17 #include "clang/Driver/Options.h"
24 #include "clang/Frontend/Utils.h"
29 #include "llvm/Option/OptTable.h"
30 #include "llvm/Option/Option.h"
31 #include "llvm/Support/BuryPointer.h"
32 #include "llvm/Support/DynamicLibrary.h"
33 #include "llvm/Support/ErrorHandling.h"
34 using namespace clang;
35 using namespace llvm::opt;
36 
37 namespace clang {
38 
39 static std::unique_ptr<FrontendAction>
41  using namespace clang::frontend;
42  StringRef Action("unknown");
43  (void)Action;
44 
45  switch (CI.getFrontendOpts().ProgramAction) {
46  case ASTDeclList: return std::make_unique<ASTDeclListAction>();
47  case ASTDump: return std::make_unique<ASTDumpAction>();
48  case ASTPrint: return std::make_unique<ASTPrintAction>();
49  case ASTView: return std::make_unique<ASTViewAction>();
51  return std::make_unique<DumpCompilerOptionsAction>();
52  case DumpRawTokens: return std::make_unique<DumpRawTokensAction>();
53  case DumpTokens: return std::make_unique<DumpTokensAction>();
54  case EmitAssembly: return std::make_unique<EmitAssemblyAction>();
55  case EmitBC: return std::make_unique<EmitBCAction>();
56  case EmitHTML: return std::make_unique<HTMLPrintAction>();
57  case EmitLLVM: return std::make_unique<EmitLLVMAction>();
58  case EmitLLVMOnly: return std::make_unique<EmitLLVMOnlyAction>();
59  case EmitCodeGenOnly: return std::make_unique<EmitCodeGenOnlyAction>();
60  case EmitObj: return std::make_unique<EmitObjAction>();
61  case ExtractAPI:
62  return std::make_unique<ExtractAPIAction>();
63  case FixIt: return std::make_unique<FixItAction>();
64  case GenerateModule:
65  return std::make_unique<GenerateModuleFromModuleMapAction>();
67  return std::make_unique<GenerateModuleInterfaceAction>();
68  case GenerateHeaderUnit:
69  return std::make_unique<GenerateHeaderUnitAction>();
70  case GeneratePCH: return std::make_unique<GeneratePCHAction>();
72  return std::make_unique<GenerateInterfaceStubsAction>();
73  case InitOnly: return std::make_unique<InitOnlyAction>();
74  case ParseSyntaxOnly: return std::make_unique<SyntaxOnlyAction>();
75  case ModuleFileInfo: return std::make_unique<DumpModuleInfoAction>();
76  case VerifyPCH: return std::make_unique<VerifyPCHAction>();
77  case TemplightDump: return std::make_unique<TemplightDumpAction>();
78 
79  case PluginAction: {
80  for (const FrontendPluginRegistry::entry &Plugin :
81  FrontendPluginRegistry::entries()) {
82  if (Plugin.getName() == CI.getFrontendOpts().ActionName) {
83  std::unique_ptr<PluginASTAction> P(Plugin.instantiate());
84  if ((P->getActionType() != PluginASTAction::ReplaceAction &&
85  P->getActionType() != PluginASTAction::CmdlineAfterMainAction) ||
86  !P->ParseArgs(
87  CI,
88  CI.getFrontendOpts().PluginArgs[std::string(Plugin.getName())]))
89  return nullptr;
90  return std::move(P);
91  }
92  }
93 
94  CI.getDiagnostics().Report(diag::err_fe_invalid_plugin_name)
96  return nullptr;
97  }
98 
99  case PrintPreamble: return std::make_unique<PrintPreambleAction>();
100  case PrintPreprocessedInput: {
103  return std::make_unique<RewriteIncludesAction>();
104  return std::make_unique<PrintPreprocessedAction>();
105  }
106 
107  case RewriteMacros: return std::make_unique<RewriteMacrosAction>();
108  case RewriteTest: return std::make_unique<RewriteTestAction>();
109 #if CLANG_ENABLE_OBJC_REWRITER
110  case RewriteObjC: return std::make_unique<RewriteObjCAction>();
111 #else
112  case RewriteObjC: Action = "RewriteObjC"; break;
113 #endif
114 #if CLANG_ENABLE_ARCMT
115  case MigrateSource:
116  return std::make_unique<arcmt::MigrateSourceAction>();
117 #else
118  case MigrateSource: Action = "MigrateSource"; break;
119 #endif
120 #if CLANG_ENABLE_STATIC_ANALYZER
121  case RunAnalysis: return std::make_unique<ento::AnalysisAction>();
122 #else
123  case RunAnalysis: Action = "RunAnalysis"; break;
124 #endif
125  case RunPreprocessorOnly: return std::make_unique<PreprocessOnlyAction>();
127  return std::make_unique<PrintDependencyDirectivesSourceMinimizerAction>();
128  }
129 
130 #if !CLANG_ENABLE_ARCMT || !CLANG_ENABLE_STATIC_ANALYZER \
131  || !CLANG_ENABLE_OBJC_REWRITER
132  CI.getDiagnostics().Report(diag::err_fe_action_not_available) << Action;
133  return 0;
134 #else
135  llvm_unreachable("Invalid program action!");
136 #endif
137 }
138 
139 std::unique_ptr<FrontendAction>
141  // Create the underlying action.
142  std::unique_ptr<FrontendAction> Act = CreateFrontendBaseAction(CI);
143  if (!Act)
144  return nullptr;
145 
146  const FrontendOptions &FEOpts = CI.getFrontendOpts();
147 
148  if (FEOpts.FixAndRecompile) {
149  Act = std::make_unique<FixItRecompile>(std::move(Act));
150  }
151 
152 #if CLANG_ENABLE_ARCMT
155  // Potentially wrap the base FE action in an ARC Migrate Tool action.
156  switch (FEOpts.ARCMTAction) {
158  break;
160  Act = std::make_unique<arcmt::CheckAction>(std::move(Act));
161  break;
163  Act = std::make_unique<arcmt::ModifyAction>(std::move(Act));
164  break;
166  Act = std::make_unique<arcmt::MigrateAction>(std::move(Act),
167  FEOpts.MTMigrateDir,
168  FEOpts.ARCMTMigrateReportOut,
170  break;
171  }
172 
174  Act = std::make_unique<arcmt::ObjCMigrateAction>(std::move(Act),
175  FEOpts.MTMigrateDir,
176  FEOpts.ObjCMTAction);
177  }
178  }
179 #endif
180 
181  // If there are any AST files to merge, create a frontend action
182  // adaptor to perform the merge.
183  if (!FEOpts.ASTMergeFiles.empty())
184  Act = std::make_unique<ASTMergeAction>(std::move(Act),
185  FEOpts.ASTMergeFiles);
186 
187  return Act;
188 }
189 
191  // Honor -help.
192  if (Clang->getFrontendOpts().ShowHelp) {
193  driver::getDriverOptTable().printHelp(
194  llvm::outs(), "clang -cc1 [options] file...",
195  "LLVM 'Clang' Compiler: http://clang.llvm.org",
196  /*Include=*/driver::options::CC1Option,
197  /*Exclude=*/0, /*ShowAllAliases=*/false);
198  return true;
199  }
200 
201  // Honor -version.
202  //
203  // FIXME: Use a better -version message?
204  if (Clang->getFrontendOpts().ShowVersion) {
205  llvm::cl::PrintVersionMessage();
206  return true;
207  }
208 
209  Clang->LoadRequestedPlugins();
210 
211  // Honor -mllvm.
212  //
213  // FIXME: Remove this, one day.
214  // This should happen AFTER plugins have been loaded!
215  if (!Clang->getFrontendOpts().LLVMArgs.empty()) {
216  unsigned NumArgs = Clang->getFrontendOpts().LLVMArgs.size();
217  auto Args = std::make_unique<const char*[]>(NumArgs + 2);
218  Args[0] = "clang (LLVM option parsing)";
219  for (unsigned i = 0; i != NumArgs; ++i)
220  Args[i + 1] = Clang->getFrontendOpts().LLVMArgs[i].c_str();
221  Args[NumArgs + 1] = nullptr;
222  llvm::cl::ParseCommandLineOptions(NumArgs + 1, Args.get());
223  }
224 
225 #if CLANG_ENABLE_STATIC_ANALYZER
226  // These should happen AFTER plugins have been loaded!
227 
228  AnalyzerOptions &AnOpts = *Clang->getAnalyzerOpts();
229 
230  // Honor -analyzer-checker-help and -analyzer-checker-help-hidden.
231  if (AnOpts.ShowCheckerHelp || AnOpts.ShowCheckerHelpAlpha ||
232  AnOpts.ShowCheckerHelpDeveloper) {
233  ento::printCheckerHelp(llvm::outs(), *Clang);
234  return true;
235  }
236 
237  // Honor -analyzer-checker-option-help.
238  if (AnOpts.ShowCheckerOptionList || AnOpts.ShowCheckerOptionAlphaList ||
240  ento::printCheckerConfigList(llvm::outs(), *Clang);
241  return true;
242  }
243 
244  // Honor -analyzer-list-enabled-checkers.
245  if (AnOpts.ShowEnabledCheckerList) {
246  ento::printEnabledCheckerList(llvm::outs(), *Clang);
247  return true;
248  }
249 
250  // Honor -analyzer-config-help.
251  if (AnOpts.ShowConfigOptionsList) {
252  ento::printAnalyzerConfigList(llvm::outs());
253  return true;
254  }
255 #endif
256 
257  // If there were errors in processing arguments, don't do anything else.
258  if (Clang->getDiagnostics().hasErrorOccurred())
259  return false;
260  // Create and execute the frontend action.
261  std::unique_ptr<FrontendAction> Act(CreateFrontendAction(*Clang));
262  if (!Act)
263  return false;
264  bool Success = Clang->ExecuteAction(*Act);
265  if (Clang->getFrontendOpts().DisableFree)
266  llvm::BuryPointer(std::move(Act));
267  return Success;
268 }
269 
270 } // namespace clang
clang::ento::printAnalyzerConfigList
void printAnalyzerConfigList(llvm::raw_ostream &OS)
clang::AnalyzerOptions::ShowCheckerOptionDeveloperList
unsigned ShowCheckerOptionDeveloperList
Definition: AnalyzerOptions.h:224
clang::FrontendOptions::FixAndRecompile
unsigned FixAndRecompile
Apply fixes and recompile.
Definition: FrontendOptions.h:296
FrontendPluginRegistry.h
clang::FrontendOptions::ARCMT_Migrate
@ ARCMT_Migrate
Definition: FrontendOptions.h:359
clang::FrontendOptions::ARCMT_Modify
@ ARCMT_Modify
Definition: FrontendOptions.h:358
clang::frontend::EmitAssembly
@ EmitAssembly
Emit a .s file.
Definition: FrontendOptions.h:58
Utils.h
clang::CompilerInstance::getPreprocessorOutputOpts
PreprocessorOutputOptions & getPreprocessorOutputOpts()
Definition: CompilerInstance.h:313
string
string(SUBSTRING ${CMAKE_CURRENT_BINARY_DIR} 0 ${PATH_LIB_START} PATH_HEAD) string(SUBSTRING $
Definition: CMakeLists.txt:22
clang::frontend::RewriteTest
@ RewriteTest
Rewriter playground.
Definition: FrontendOptions.h:127
clang::FrontendOptions::ARCMT_None
@ ARCMT_None
Definition: FrontendOptions.h:356
clang::FrontendOptions::ProgramAction
frontend::ActionKind ProgramAction
The frontend action to perform.
Definition: FrontendOptions.h:445
clang::PluginASTAction::ReplaceAction
@ ReplaceAction
Replace the main action.
Definition: FrontendAction.h:277
clang::FrontendOptions::LLVMArgs
std::vector< std::string > LLVMArgs
A list of arguments to forward to LLVM's option processing; this should only be used for debugging an...
Definition: FrontendOptions.h:485
clang::FrontendOptions::PluginArgs
std::map< std::string, std::vector< std::string > > PluginArgs
Args to pass to the plugins.
Definition: FrontendOptions.h:459
clang::FrontendOptions::ARCMTMigrateReportOut
std::string ARCMTMigrateReportOut
Definition: FrontendOptions.h:419
clang::frontend::ModuleFileInfo
@ ModuleFileInfo
Dump information about a module file.
Definition: FrontendOptions.h:103
clang::frontend::RunPreprocessorOnly
@ RunPreprocessorOnly
Just lex, no output.
Definition: FrontendOptions.h:139
clang::CreateFrontendAction
std::unique_ptr< FrontendAction > CreateFrontendAction(CompilerInstance &CI)
Construct the FrontendAction of a compiler invocation based on the options specified for the compiler...
Definition: ExecuteCompilerInvocation.cpp:140
AnalyzerHelpFlags.h
clang::FrontendOptions::ObjCMT_None
@ ObjCMT_None
Definition: FrontendOptions.h:363
clang::driver::options::CC1Option
@ CC1Option
Definition: Options.h:31
clang::frontend::ASTDump
@ ASTDump
Parse ASTs and dump them.
Definition: FrontendOptions.h:40
clang::CompilerInstance::getAnalyzerOpts
AnalyzerOptionsRef getAnalyzerOpts()
Definition: CompilerInstance.h:250
clang::frontend::VerifyPCH
@ VerifyPCH
Load and verify that a PCH file is usable.
Definition: FrontendOptions.h:106
clang::frontend::PluginAction
@ PluginAction
Run a plugin action,.
Definition: FrontendOptions.h:112
clang::frontend::RewriteObjC
@ RewriteObjC
ObjC->C Rewriter.
Definition: FrontendOptions.h:124
CompilerInvocation.h
CodeGenAction.h
clang::FrontendOptions::ShowVersion
unsigned ShowVersion
Show the -version text.
Definition: FrontendOptions.h:287
clang::frontend::GeneratePCH
@ GeneratePCH
Generate pre-compiled header.
Definition: FrontendOptions.h:94
clang::frontend::ASTView
@ ASTView
Parse ASTs and view them in Graphviz.
Definition: FrontendOptions.h:46
clang::FrontendOptions::ShowHelp
unsigned ShowHelp
Show the -help text.
Definition: FrontendOptions.h:275
clang::AnalyzerOptions::ShowCheckerHelpAlpha
unsigned ShowCheckerHelpAlpha
Definition: AnalyzerOptions.h:219
clang::frontend::ASTPrint
@ ASTPrint
Parse ASTs and print them.
Definition: FrontendOptions.h:43
clang::frontend::RunAnalysis
@ RunAnalysis
Run one or more source code analyses.
Definition: FrontendOptions.h:130
clang::driver::getDriverOptTable
const llvm::opt::OptTable & getDriverOptTable()
Definition: DriverOptions.cpp:42
Options.h
clang::frontend::EmitObj
@ EmitObj
Emit a .o file.
Definition: FrontendOptions.h:76
clang::CompilerInstance::ExecuteAction
bool ExecuteAction(FrontendAction &Act)
ExecuteAction - Execute the provided action against the compiler's CompilerInvocation object.
Definition: CompilerInstance.cpp:999
clang::DiagnosticsEngine::hasErrorOccurred
bool hasErrorOccurred() const
Definition: Diagnostic.h:838
clang::frontend::ParseSyntaxOnly
@ ParseSyntaxOnly
Parse and perform semantic analysis.
Definition: FrontendOptions.h:109
llvm::opt
Definition: DiagnosticOptions.h:19
clang::ento::printEnabledCheckerList
void printEnabledCheckerList(llvm::raw_ostream &OS, CompilerInstance &CI)
clang::FrontendOptions
FrontendOptions - Options for controlling the behavior of the frontend.
Definition: FrontendOptions.h:265
clang::AnalyzerOptions::ShowEnabledCheckerList
unsigned ShowEnabledCheckerList
Definition: AnalyzerOptions.h:226
Utils.h
clang::frontend::ASTDeclList
@ ASTDeclList
Parse ASTs and list Decl nodes.
Definition: FrontendOptions.h:37
clang::frontend::DumpRawTokens
@ DumpRawTokens
Dump out raw tokens.
Definition: FrontendOptions.h:52
clang::frontend::EmitLLVM
@ EmitLLVM
Emit a .ll file.
Definition: FrontendOptions.h:67
clang::PreprocessorOutputOptions::RewriteImports
unsigned RewriteImports
Include contents of transitively-imported modules.
Definition: PreprocessorOutputOptions.h:26
clang::FrontendOptions::ObjCMTAction
unsigned ObjCMTAction
Definition: FrontendOptions.h:415
clang::frontend::PrintDependencyDirectivesSourceMinimizerOutput
@ PrintDependencyDirectivesSourceMinimizerOutput
Print the output of the dependency directives source minimizer.
Definition: FrontendOptions.h:142
clang::FrontendOptions::ASTMergeFiles
std::vector< std::string > ASTMergeFiles
The list of AST files to merge.
Definition: FrontendOptions.h:481
clang::AnalyzerOptions::ShowCheckerHelp
unsigned ShowCheckerHelp
Definition: AnalyzerOptions.h:218
clang::frontend::EmitHTML
@ EmitHTML
Translate input source into HTML.
Definition: FrontendOptions.h:64
clang::frontend::RewriteMacros
@ RewriteMacros
Expand macros but not #includes.
Definition: FrontendOptions.h:121
clang::PreprocessorOutputOptions::RewriteIncludes
unsigned RewriteIncludes
Preprocess include directives only.
Definition: PreprocessorOutputOptions.h:25
clang::CompilerInstance
CompilerInstance - Helper class for managing a single instance of the Clang compiler.
Definition: CompilerInstance.h:72
clang::AnalyzerOptions::ShowCheckerOptionList
unsigned ShowCheckerOptionList
Definition: AnalyzerOptions.h:222
clang::ExecuteCompilerInvocation
bool ExecuteCompilerInvocation(CompilerInstance *Clang)
ExecuteCompilerInvocation - Execute the given actions described by the compiler invocation object in ...
Definition: ExecuteCompilerInvocation.cpp:190
clang::FrontendOptions::ARCMT_Check
@ ARCMT_Check
Definition: FrontendOptions.h:357
clang::ento::printCheckerConfigList
void printCheckerConfigList(llvm::raw_ostream &OS, CompilerInstance &CI)
clang::FrontendOptions::ARCMTAction
enum clang::FrontendOptions::@189 ARCMTAction
clang::frontend::EmitBC
@ EmitBC
Emit a .bc file.
Definition: FrontendOptions.h:61
clang::frontend::GenerateHeaderUnit
@ GenerateHeaderUnit
Generate a C++20 header unit module from a header file.
Definition: FrontendOptions.h:91
P
StringRef P
Definition: ASTMatchersInternal.cpp:563
clang::AnalyzerOptions::ShowCheckerHelpDeveloper
unsigned ShowCheckerHelpDeveloper
Definition: AnalyzerOptions.h:220
clang::CreateFrontendBaseAction
static std::unique_ptr< FrontendAction > CreateFrontendBaseAction(CompilerInstance &CI)
Definition: ExecuteCompilerInvocation.cpp:40
clang::frontend::GenerateModule
@ GenerateModule
Generate pre-compiled module from a module map.
Definition: FrontendOptions.h:85
clang::ento::printCheckerHelp
void printCheckerHelp(llvm::raw_ostream &OS, CompilerInstance &CI)
ARCMTActions.h
clang::frontend::FixIt
@ FixIt
Parse and apply any fixits to the source.
Definition: FrontendOptions.h:82
FrontendActions.h
FrontendActions.h
clang::frontend::ExtractAPI
@ ExtractAPI
Definition: FrontendOptions.h:79
clang::AnalyzerOptions
Stores options for the analyzer from the command line.
Definition: AnalyzerOptions.h:150
clang::FrontendOptions::ActionName
std::string ActionName
The name of the action to run when using a plugin action.
Definition: FrontendOptions.h:448
clang::AnalyzerOptions::ShowConfigOptionsList
unsigned ShowConfigOptionsList
Definition: AnalyzerOptions.h:227
clang::FrontendOptions::ARCMTMigrateEmitARCErrors
unsigned ARCMTMigrateEmitARCErrors
Emit ARC errors even if the migrator can fix them.
Definition: FrontendOptions.h:302
clang
Definition: CalledOnceCheck.h:17
clang::frontend::DumpTokens
@ DumpTokens
Dump out preprocessed tokens.
Definition: FrontendOptions.h:55
FrontendDiagnostic.h
clang::frontend
Definition: FrontendOptions.h:33
clang::frontend::DumpCompilerOptions
@ DumpCompilerOptions
Dump the compiler configuration.
Definition: FrontendOptions.h:49
CompilerInstance.h
clang::FrontendOptions::MTMigrateDir
std::string MTMigrateDir
Definition: FrontendOptions.h:418
clang::CompilerInstance::getFrontendOpts
FrontendOptions & getFrontendOpts()
Definition: CompilerInstance.h:282
clang::FrontendOptions::DisableFree
unsigned DisableFree
Disable memory freeing on exit.
Definition: FrontendOptions.h:268
clang::frontend::PrintPreprocessedInput
@ PrintPreprocessedInput
-E mode.
Definition: FrontendOptions.h:118
clang::CompilerInstance::getDiagnostics
DiagnosticsEngine & getDiagnostics() const
Get the current diagnostics engine.
Definition: CompilerInstance.h:334
clang::PluginASTAction::CmdlineAfterMainAction
@ CmdlineAfterMainAction
Execute the action after the main action if on the command line.
Definition: FrontendAction.h:275
FrontendActions.h
clang::frontend::EmitLLVMOnly
@ EmitLLVMOnly
Generate LLVM IR, but do not emit anything.
Definition: FrontendOptions.h:70
clang::frontend::MigrateSource
@ MigrateSource
Run migrator.
Definition: FrontendOptions.h:136
FrontendActions.h
clang::frontend::GenerateInterfaceStubs
@ GenerateInterfaceStubs
Generate Interface Stub Files.
Definition: FrontendOptions.h:97
clang::frontend::InitOnly
@ InitOnly
Only execute frontend initialization.
Definition: FrontendOptions.h:100
clang::AnalyzerOptions::ShowCheckerOptionAlphaList
unsigned ShowCheckerOptionAlphaList
Definition: AnalyzerOptions.h:223
clang::frontend::PrintPreamble
@ PrintPreamble
Print the "preamble" of the input file.
Definition: FrontendOptions.h:115
clang::frontend::TemplightDump
@ TemplightDump
Dump template instantiations.
Definition: FrontendOptions.h:133
clang::frontend::GenerateModuleInterface
@ GenerateModuleInterface
Generate pre-compiled module from a C++ module interface file.
Definition: FrontendOptions.h:88
clang::CompilerInstance::LoadRequestedPlugins
void LoadRequestedPlugins()
Load the list of plugins requested in the FrontendOptions.
Definition: CompilerInstance.cpp:1100
clang::DiagnosticsEngine::Report
DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID)
Issue the message to the client.
Definition: Diagnostic.h:1537
clang::frontend::EmitCodeGenOnly
@ EmitCodeGenOnly
Generate machine code, but don't emit anything.
Definition: FrontendOptions.h:73