clang  14.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"
23 #include "clang/Frontend/Utils.h"
28 #include "llvm/Option/OptTable.h"
29 #include "llvm/Option/Option.h"
30 #include "llvm/Support/BuryPointer.h"
31 #include "llvm/Support/DynamicLibrary.h"
32 #include "llvm/Support/ErrorHandling.h"
33 using namespace clang;
34 using namespace llvm::opt;
35 
36 namespace clang {
37 
38 static std::unique_ptr<FrontendAction>
40  using namespace clang::frontend;
41  StringRef Action("unknown");
42  (void)Action;
43 
44  switch (CI.getFrontendOpts().ProgramAction) {
45  case ASTDeclList: return std::make_unique<ASTDeclListAction>();
46  case ASTDump: return std::make_unique<ASTDumpAction>();
47  case ASTPrint: return std::make_unique<ASTPrintAction>();
48  case ASTView: return std::make_unique<ASTViewAction>();
50  return std::make_unique<DumpCompilerOptionsAction>();
51  case DumpRawTokens: return std::make_unique<DumpRawTokensAction>();
52  case DumpTokens: return std::make_unique<DumpTokensAction>();
53  case EmitAssembly: return std::make_unique<EmitAssemblyAction>();
54  case EmitBC: return std::make_unique<EmitBCAction>();
55  case EmitHTML: return std::make_unique<HTMLPrintAction>();
56  case EmitLLVM: return std::make_unique<EmitLLVMAction>();
57  case EmitLLVMOnly: return std::make_unique<EmitLLVMOnlyAction>();
58  case EmitCodeGenOnly: return std::make_unique<EmitCodeGenOnlyAction>();
59  case EmitObj: return std::make_unique<EmitObjAction>();
60  case FixIt: return std::make_unique<FixItAction>();
61  case GenerateModule:
62  return std::make_unique<GenerateModuleFromModuleMapAction>();
64  return std::make_unique<GenerateModuleInterfaceAction>();
66  return std::make_unique<GenerateHeaderModuleAction>();
67  case GeneratePCH: return std::make_unique<GeneratePCHAction>();
69  return std::make_unique<GenerateInterfaceStubsAction>();
70  case InitOnly: return std::make_unique<InitOnlyAction>();
71  case ParseSyntaxOnly: return std::make_unique<SyntaxOnlyAction>();
72  case ModuleFileInfo: return std::make_unique<DumpModuleInfoAction>();
73  case VerifyPCH: return std::make_unique<VerifyPCHAction>();
74  case TemplightDump: return std::make_unique<TemplightDumpAction>();
75 
76  case PluginAction: {
77  for (const FrontendPluginRegistry::entry &Plugin :
78  FrontendPluginRegistry::entries()) {
79  if (Plugin.getName() == CI.getFrontendOpts().ActionName) {
80  std::unique_ptr<PluginASTAction> P(Plugin.instantiate());
81  if ((P->getActionType() != PluginASTAction::ReplaceAction &&
82  P->getActionType() != PluginASTAction::CmdlineAfterMainAction) ||
83  !P->ParseArgs(
84  CI,
85  CI.getFrontendOpts().PluginArgs[std::string(Plugin.getName())]))
86  return nullptr;
87  return std::move(P);
88  }
89  }
90 
91  CI.getDiagnostics().Report(diag::err_fe_invalid_plugin_name)
93  return nullptr;
94  }
95 
96  case PrintPreamble: return std::make_unique<PrintPreambleAction>();
100  return std::make_unique<RewriteIncludesAction>();
101  return std::make_unique<PrintPreprocessedAction>();
102  }
103 
104  case RewriteMacros: return std::make_unique<RewriteMacrosAction>();
105  case RewriteTest: return std::make_unique<RewriteTestAction>();
106 #if CLANG_ENABLE_OBJC_REWRITER
107  case RewriteObjC: return std::make_unique<RewriteObjCAction>();
108 #else
109  case RewriteObjC: Action = "RewriteObjC"; break;
110 #endif
111 #if CLANG_ENABLE_ARCMT
112  case MigrateSource:
113  return std::make_unique<arcmt::MigrateSourceAction>();
114 #else
115  case MigrateSource: Action = "MigrateSource"; break;
116 #endif
117 #if CLANG_ENABLE_STATIC_ANALYZER
118  case RunAnalysis: return std::make_unique<ento::AnalysisAction>();
119 #else
120  case RunAnalysis: Action = "RunAnalysis"; break;
121 #endif
122  case RunPreprocessorOnly: return std::make_unique<PreprocessOnlyAction>();
124  return std::make_unique<PrintDependencyDirectivesSourceMinimizerAction>();
125  }
126 
127 #if !CLANG_ENABLE_ARCMT || !CLANG_ENABLE_STATIC_ANALYZER \
128  || !CLANG_ENABLE_OBJC_REWRITER
129  CI.getDiagnostics().Report(diag::err_fe_action_not_available) << Action;
130  return 0;
131 #else
132  llvm_unreachable("Invalid program action!");
133 #endif
134 }
135 
136 std::unique_ptr<FrontendAction>
138  // Create the underlying action.
139  std::unique_ptr<FrontendAction> Act = CreateFrontendBaseAction(CI);
140  if (!Act)
141  return nullptr;
142 
143  const FrontendOptions &FEOpts = CI.getFrontendOpts();
144 
145  if (FEOpts.FixAndRecompile) {
146  Act = std::make_unique<FixItRecompile>(std::move(Act));
147  }
148 
149 #if CLANG_ENABLE_ARCMT
152  // Potentially wrap the base FE action in an ARC Migrate Tool action.
153  switch (FEOpts.ARCMTAction) {
155  break;
157  Act = std::make_unique<arcmt::CheckAction>(std::move(Act));
158  break;
160  Act = std::make_unique<arcmt::ModifyAction>(std::move(Act));
161  break;
163  Act = std::make_unique<arcmt::MigrateAction>(std::move(Act),
164  FEOpts.MTMigrateDir,
165  FEOpts.ARCMTMigrateReportOut,
167  break;
168  }
169 
171  Act = std::make_unique<arcmt::ObjCMigrateAction>(std::move(Act),
172  FEOpts.MTMigrateDir,
173  FEOpts.ObjCMTAction);
174  }
175  }
176 #endif
177 
178  // If there are any AST files to merge, create a frontend action
179  // adaptor to perform the merge.
180  if (!FEOpts.ASTMergeFiles.empty())
181  Act = std::make_unique<ASTMergeAction>(std::move(Act),
182  FEOpts.ASTMergeFiles);
183 
184  return Act;
185 }
186 
188  // Honor -help.
189  if (Clang->getFrontendOpts().ShowHelp) {
190  driver::getDriverOptTable().printHelp(
191  llvm::outs(), "clang -cc1 [options] file...",
192  "LLVM 'Clang' Compiler: http://clang.llvm.org",
193  /*Include=*/driver::options::CC1Option,
194  /*Exclude=*/0, /*ShowAllAliases=*/false);
195  return true;
196  }
197 
198  // Honor -version.
199  //
200  // FIXME: Use a better -version message?
201  if (Clang->getFrontendOpts().ShowVersion) {
202  llvm::cl::PrintVersionMessage();
203  return true;
204  }
205 
206  Clang->LoadRequestedPlugins();
207 
208  // Honor -mllvm.
209  //
210  // FIXME: Remove this, one day.
211  // This should happen AFTER plugins have been loaded!
212  if (!Clang->getFrontendOpts().LLVMArgs.empty()) {
213  unsigned NumArgs = Clang->getFrontendOpts().LLVMArgs.size();
214  auto Args = std::make_unique<const char*[]>(NumArgs + 2);
215  Args[0] = "clang (LLVM option parsing)";
216  for (unsigned i = 0; i != NumArgs; ++i)
217  Args[i + 1] = Clang->getFrontendOpts().LLVMArgs[i].c_str();
218  Args[NumArgs + 1] = nullptr;
219  llvm::cl::ParseCommandLineOptions(NumArgs + 1, Args.get());
220  }
221 
222 #if CLANG_ENABLE_STATIC_ANALYZER
223  // These should happen AFTER plugins have been loaded!
224 
225  AnalyzerOptions &AnOpts = *Clang->getAnalyzerOpts();
226 
227  // Honor -analyzer-checker-help and -analyzer-checker-help-hidden.
228  if (AnOpts.ShowCheckerHelp || AnOpts.ShowCheckerHelpAlpha ||
229  AnOpts.ShowCheckerHelpDeveloper) {
230  ento::printCheckerHelp(llvm::outs(), *Clang);
231  return true;
232  }
233 
234  // Honor -analyzer-checker-option-help.
235  if (AnOpts.ShowCheckerOptionList || AnOpts.ShowCheckerOptionAlphaList ||
237  ento::printCheckerConfigList(llvm::outs(), *Clang);
238  return true;
239  }
240 
241  // Honor -analyzer-list-enabled-checkers.
242  if (AnOpts.ShowEnabledCheckerList) {
243  ento::printEnabledCheckerList(llvm::outs(), *Clang);
244  return true;
245  }
246 
247  // Honor -analyzer-config-help.
248  if (AnOpts.ShowConfigOptionsList) {
249  ento::printAnalyzerConfigList(llvm::outs());
250  return true;
251  }
252 #endif
253 
254  // If there were errors in processing arguments, don't do anything else.
255  if (Clang->getDiagnostics().hasErrorOccurred())
256  return false;
257  // Create and execute the frontend action.
258  std::unique_ptr<FrontendAction> Act(CreateFrontendAction(*Clang));
259  if (!Act)
260  return false;
261  bool Success = Clang->ExecuteAction(*Act);
262  if (Clang->getFrontendOpts().DisableFree)
263  llvm::BuryPointer(std::move(Act));
264  return Success;
265 }
266 
267 } // namespace clang
clang::ento::printAnalyzerConfigList
void printAnalyzerConfigList(llvm::raw_ostream &OS)
clang::AnalyzerOptions::ShowCheckerOptionDeveloperList
unsigned ShowCheckerOptionDeveloperList
Definition: AnalyzerOptions.h:238
clang::FrontendOptions::FixAndRecompile
unsigned FixAndRecompile
Apply fixes and recompile.
Definition: FrontendOptions.h:259
FrontendPluginRegistry.h
clang::frontend::EmitAssembly
@ EmitAssembly
Emit a .s file.
Definition: FrontendOptions.h:58
Utils.h
clang::CompilerInstance::getPreprocessorOutputOpts
PreprocessorOutputOptions & getPreprocessorOutputOpts()
Definition: CompilerInstance.h:315
string
string(SUBSTRING ${CMAKE_CURRENT_BINARY_DIR} 0 ${PATH_LIB_START} PATH_HEAD) string(SUBSTRING $
Definition: CMakeLists.txt:22
clang::frontend::GenerateHeaderModule
@ GenerateHeaderModule
Generate pre-compiled module from a set of header files.
Definition: FrontendOptions.h:88
clang::frontend::RewriteTest
@ RewriteTest
Rewriter playground.
Definition: FrontendOptions.h:124
clang::FrontendOptions::ProgramAction
frontend::ActionKind ProgramAction
The frontend action to perform.
Definition: FrontendOptions.h:405
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:437
clang::FrontendOptions::PluginArgs
std::map< std::string, std::vector< std::string > > PluginArgs
Args to pass to the plugins.
Definition: FrontendOptions.h:411
clang::FrontendOptions::ARCMTMigrateReportOut
std::string ARCMTMigrateReportOut
Definition: FrontendOptions.h:379
clang::frontend::ModuleFileInfo
@ ModuleFileInfo
Dump information about a module file.
Definition: FrontendOptions.h:100
clang::frontend::RunPreprocessorOnly
@ RunPreprocessorOnly
Just lex, no output.
Definition: FrontendOptions.h:136
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:137
AnalyzerHelpFlags.h
clang::FrontendOptions::ARCMT_Migrate
@ ARCMT_Migrate
Definition: FrontendOptions.h:319
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:252
clang::frontend::VerifyPCH
@ VerifyPCH
Load and verify that a PCH file is usable.
Definition: FrontendOptions.h:103
clang::frontend::PluginAction
@ PluginAction
Run a plugin action,.
Definition: FrontendOptions.h:109
clang::frontend::RewriteObjC
@ RewriteObjC
ObjC->C Rewriter.
Definition: FrontendOptions.h:121
CompilerInvocation.h
CodeGenAction.h
clang::FrontendOptions::ShowVersion
unsigned ShowVersion
Show the -version text.
Definition: FrontendOptions.h:250
clang::frontend::GeneratePCH
@ GeneratePCH
Generate pre-compiled header.
Definition: FrontendOptions.h:91
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:238
clang::AnalyzerOptions::ShowCheckerHelpAlpha
unsigned ShowCheckerHelpAlpha
Definition: AnalyzerOptions.h:233
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:127
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:989
clang::FrontendOptions::ARCMT_Modify
@ ARCMT_Modify
Definition: FrontendOptions.h:318
clang::DiagnosticsEngine::hasErrorOccurred
bool hasErrorOccurred() const
Definition: Diagnostic.h:836
clang::frontend::ParseSyntaxOnly
@ ParseSyntaxOnly
Parse and perform semantic analysis.
Definition: FrontendOptions.h:106
llvm::opt
Definition: DiagnosticOptions.h:19
clang::FrontendOptions::ARCMT_Check
@ ARCMT_Check
Definition: FrontendOptions.h:317
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:228
clang::AnalyzerOptions::ShowEnabledCheckerList
unsigned ShowEnabledCheckerList
Definition: AnalyzerOptions.h:240
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:375
clang::frontend::PrintDependencyDirectivesSourceMinimizerOutput
@ PrintDependencyDirectivesSourceMinimizerOutput
Print the output of the dependency directives source minimizer.
Definition: FrontendOptions.h:139
clang::FrontendOptions::ASTMergeFiles
std::vector< std::string > ASTMergeFiles
The list of AST files to merge.
Definition: FrontendOptions.h:433
clang::AnalyzerOptions::ShowCheckerHelp
unsigned ShowCheckerHelp
Definition: AnalyzerOptions.h:232
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:118
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:74
clang::AnalyzerOptions::ShowCheckerOptionList
unsigned ShowCheckerOptionList
Definition: AnalyzerOptions.h:236
clang::ExecuteCompilerInvocation
bool ExecuteCompilerInvocation(CompilerInstance *Clang)
ExecuteCompilerInvocation - Execute the given actions described by the compiler invocation object in ...
Definition: ExecuteCompilerInvocation.cpp:187
clang::ento::printCheckerConfigList
void printCheckerConfigList(llvm::raw_ostream &OS, CompilerInstance &CI)
clang::frontend::EmitBC
@ EmitBC
Emit a .bc file.
Definition: FrontendOptions.h:61
P
StringRef P
Definition: ASTMatchersInternal.cpp:563
clang::AnalyzerOptions::ShowCheckerHelpDeveloper
unsigned ShowCheckerHelpDeveloper
Definition: AnalyzerOptions.h:234
clang::FrontendOptions::ARCMTAction
enum clang::FrontendOptions::@185 ARCMTAction
clang::CreateFrontendBaseAction
static std::unique_ptr< FrontendAction > CreateFrontendBaseAction(CompilerInstance &CI)
Definition: ExecuteCompilerInvocation.cpp:39
clang::frontend::GenerateModule
@ GenerateModule
Generate pre-compiled module from a module map.
Definition: FrontendOptions.h:82
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:79
FrontendActions.h
FrontendActions.h
clang::AnalyzerOptions
Stores options for the analyzer from the command line.
Definition: AnalyzerOptions.h:163
clang::FrontendOptions::ActionName
std::string ActionName
The name of the action to run when using a plugin action.
Definition: FrontendOptions.h:408
clang::FrontendOptions::ObjCMT_None
@ ObjCMT_None
Definition: FrontendOptions.h:323
clang::AnalyzerOptions::ShowConfigOptionsList
unsigned ShowConfigOptionsList
Definition: AnalyzerOptions.h:241
clang::FrontendOptions::ARCMTMigrateEmitARCErrors
unsigned ARCMTMigrateEmitARCErrors
Emit ARC errors even if the migrator can fix them.
Definition: FrontendOptions.h:265
clang::FrontendOptions::ARCMT_None
@ ARCMT_None
Definition: FrontendOptions.h:316
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:378
clang::CompilerInstance::getFrontendOpts
FrontendOptions & getFrontendOpts()
Definition: CompilerInstance.h:284
clang::FrontendOptions::DisableFree
unsigned DisableFree
Disable memory freeing on exit.
Definition: FrontendOptions.h:231
clang::frontend::PrintPreprocessedInput
@ PrintPreprocessedInput
-E mode.
Definition: FrontendOptions.h:115
clang::CompilerInstance::getDiagnostics
DiagnosticsEngine & getDiagnostics() const
Get the current diagnostics engine.
Definition: CompilerInstance.h:336
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:133
clang::frontend::GenerateInterfaceStubs
@ GenerateInterfaceStubs
Generate Interface Stub Files.
Definition: FrontendOptions.h:94
clang::frontend::InitOnly
@ InitOnly
Only execute frontend initialization.
Definition: FrontendOptions.h:97
clang::AnalyzerOptions::ShowCheckerOptionAlphaList
unsigned ShowCheckerOptionAlphaList
Definition: AnalyzerOptions.h:237
clang::frontend::PrintPreamble
@ PrintPreamble
Print the "preamble" of the input file.
Definition: FrontendOptions.h:112
clang::frontend::TemplightDump
@ TemplightDump
Dump template instantiations.
Definition: FrontendOptions.h:130
clang::frontend::GenerateModuleInterface
@ GenerateModuleInterface
Generate pre-compiled module from a C++ module interface file.
Definition: FrontendOptions.h:85
clang::CompilerInstance::LoadRequestedPlugins
void LoadRequestedPlugins()
Load the list of plugins requested in the FrontendOptions.
Definition: CompilerInstance.cpp:1088
clang::DiagnosticsEngine::Report
DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID)
Issue the message to the client.
Definition: Diagnostic.h:1523
clang::frontend::EmitCodeGenOnly
@ EmitCodeGenOnly
Generate machine code, but don't emit anything.
Definition: FrontendOptions.h:73