1//===--- FrontendAction.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#include "clang/Frontend/FrontendAction.h"
10#include "clang/AST/ASTConsumer.h"
11#include "clang/AST/ASTContext.h"
12#include "clang/AST/DeclGroup.h"
13#include "clang/Basic/Builtins.h"
14#include "clang/Basic/DiagnosticOptions.h"
15#include "clang/Basic/FileEntry.h"
16#include "clang/Basic/LangStandard.h"
17#include "clang/Basic/Sarif.h"
18#include "clang/Basic/Stack.h"
19#include "clang/Frontend/ASTUnit.h"
20#include "clang/Frontend/CompilerInstance.h"
21#include "clang/Frontend/FrontendDiagnostic.h"
22#include "clang/Frontend/FrontendPluginRegistry.h"
23#include "clang/Frontend/LayoutOverrideSource.h"
24#include "clang/Frontend/MultiplexConsumer.h"
25#include "clang/Frontend/SARIFDiagnosticPrinter.h"
26#include "clang/Frontend/Utils.h"
27#include "clang/Lex/HeaderSearch.h"
28#include "clang/Lex/LiteralSupport.h"
29#include "clang/Lex/Preprocessor.h"
30#include "clang/Lex/PreprocessorOptions.h"
31#include "clang/Parse/ParseAST.h"
32#include "clang/Sema/HLSLExternalSemaSource.h"
33#include "clang/Sema/MultiplexExternalSemaSource.h"
34#include "clang/Serialization/ASTDeserializationListener.h"
35#include "clang/Serialization/ASTReader.h"
36#include "clang/Serialization/GlobalModuleIndex.h"
37#include "llvm/ADT/ScopeExit.h"
38#include "llvm/Support/BuryPointer.h"
39#include "llvm/Support/ErrorHandling.h"
40#include "llvm/Support/FileSystem.h"
41#include "llvm/Support/Path.h"
42#include "llvm/Support/Timer.h"
43#include "llvm/Support/raw_ostream.h"
44#include <memory>
45#include <system_error>
46using namespace clang;
47
48LLVM_INSTANTIATE_REGISTRY(FrontendPluginRegistry)
49
50namespace {
51
52class DelegatingDeserializationListener : public ASTDeserializationListener {
53 ASTDeserializationListener *Previous;
54 bool DeletePrevious;
55
56public:
57 explicit DelegatingDeserializationListener(
58 ASTDeserializationListener *Previous, bool DeletePrevious)
59 : Previous(Previous), DeletePrevious(DeletePrevious) {}
60 ~DelegatingDeserializationListener() override {
61 if (DeletePrevious)
62 delete Previous;
63 }
64
65 DelegatingDeserializationListener(const DelegatingDeserializationListener &) =
66 delete;
67 DelegatingDeserializationListener &
68 operator=(const DelegatingDeserializationListener &) = delete;
69
70 void ReaderInitialized(ASTReader *Reader) override {
71 if (Previous)
72 Previous->ReaderInitialized(Reader);
73 }
74 void IdentifierRead(serialization::IdentID ID,
75 IdentifierInfo *II) override {
76 if (Previous)
77 Previous->IdentifierRead(ID, II);
78 }
79 void TypeRead(serialization::TypeIdx Idx, QualType T) override {
80 if (Previous)
81 Previous->TypeRead(Idx, T);
82 }
83 void DeclRead(serialization::DeclID ID, const Decl *D) override {
84 if (Previous)
85 Previous->DeclRead(ID, D);
86 }
87 void SelectorRead(serialization::SelectorID ID, Selector Sel) override {
88 if (Previous)
89 Previous->SelectorRead(iD: ID, Sel);
90 }
91 void MacroDefinitionRead(serialization::PreprocessedEntityID PPID,
92 MacroDefinitionRecord *MD) override {
93 if (Previous)
94 Previous->MacroDefinitionRead(PPID, MD);
95 }
96};
97
98/// Dumps deserialized declarations.
99class DeserializedDeclsDumper : public DelegatingDeserializationListener {
100public:
101 explicit DeserializedDeclsDumper(ASTDeserializationListener *Previous,
102 bool DeletePrevious)
103 : DelegatingDeserializationListener(Previous, DeletePrevious) {}
104
105 void DeclRead(serialization::DeclID ID, const Decl *D) override {
106 llvm::outs() << "PCH DECL: " << D->getDeclKindName();
107 if (const NamedDecl *ND = dyn_cast<NamedDecl>(Val: D)) {
108 llvm::outs() << " - ";
109 ND->printQualifiedName(OS&: llvm::outs());
110 }
111 llvm::outs() << "\n";
112
113 DelegatingDeserializationListener::DeclRead(ID, D);
114 }
115};
116
117/// Checks deserialized declarations and emits error if a name
118/// matches one given in command-line using -error-on-deserialized-decl.
119class DeserializedDeclsChecker : public DelegatingDeserializationListener {
120 ASTContext &Ctx;
121 std::set<std::string> NamesToCheck;
122
123public:
124 DeserializedDeclsChecker(ASTContext &Ctx,
125 const std::set<std::string> &NamesToCheck,
126 ASTDeserializationListener *Previous,
127 bool DeletePrevious)
128 : DelegatingDeserializationListener(Previous, DeletePrevious), Ctx(Ctx),
129 NamesToCheck(NamesToCheck) {}
130
131 void DeclRead(serialization::DeclID ID, const Decl *D) override {
132 if (const NamedDecl *ND = dyn_cast<NamedDecl>(Val: D))
133 if (NamesToCheck.find(x: ND->getNameAsString()) != NamesToCheck.end()) {
134 unsigned DiagID
135 = Ctx.getDiagnostics().getCustomDiagID(L: DiagnosticsEngine::Error,
136 FormatString: "%0 was deserialized");
137 Ctx.getDiagnostics().Report(Loc: Ctx.getFullLoc(Loc: D->getLocation()), DiagID)
138 << ND;
139 }
140
141 DelegatingDeserializationListener::DeclRead(ID, D);
142 }
143};
144
145} // end anonymous namespace
146
147FrontendAction::FrontendAction() : Instance(nullptr) {}
148
149FrontendAction::~FrontendAction() {}
150
151void FrontendAction::setCurrentInput(const FrontendInputFile &CurrentInput,
152 std::unique_ptr<ASTUnit> AST) {
153 this->CurrentInput = CurrentInput;
154 CurrentASTUnit = std::move(AST);
155}
156
157Module *FrontendAction::getCurrentModule() const {
158 CompilerInstance &CI = getCompilerInstance();
159 return CI.getPreprocessor().getHeaderSearchInfo().lookupModule(
160 ModuleName: CI.getLangOpts().CurrentModule, ImportLoc: SourceLocation(), /*AllowSearch*/false);
161}
162
163std::unique_ptr<ASTConsumer>
164FrontendAction::CreateWrappedASTConsumer(CompilerInstance &CI,
165 StringRef InFile) {
166 std::unique_ptr<ASTConsumer> Consumer = CreateASTConsumer(CI, InFile);
167 if (!Consumer)
168 return nullptr;
169
170 // Validate -add-plugin args.
171 bool FoundAllPlugins = true;
172 for (const std::string &Arg : CI.getFrontendOpts().AddPluginActions) {
173 bool Found = false;
174 for (const FrontendPluginRegistry::entry &Plugin :
175 FrontendPluginRegistry::entries()) {
176 if (Plugin.getName() == Arg)
177 Found = true;
178 }
179 if (!Found) {
180 CI.getDiagnostics().Report(diag::err_fe_invalid_plugin_name) << Arg;
181 FoundAllPlugins = false;
182 }
183 }
184 if (!FoundAllPlugins)
185 return nullptr;
186
187 // If there are no registered plugins we don't need to wrap the consumer
188 if (FrontendPluginRegistry::begin() == FrontendPluginRegistry::end())
189 return Consumer;
190
191 // If this is a code completion run, avoid invoking the plugin consumers
192 if (CI.hasCodeCompletionConsumer())
193 return Consumer;
194
195 // Collect the list of plugins that go before the main action (in Consumers)
196 // or after it (in AfterConsumers)
197 std::vector<std::unique_ptr<ASTConsumer>> Consumers;
198 std::vector<std::unique_ptr<ASTConsumer>> AfterConsumers;
199 for (const FrontendPluginRegistry::entry &Plugin :
200 FrontendPluginRegistry::entries()) {
201 std::unique_ptr<PluginASTAction> P = Plugin.instantiate();
202 PluginASTAction::ActionType ActionType = P->getActionType();
203 if (ActionType == PluginASTAction::CmdlineAfterMainAction ||
204 ActionType == PluginASTAction::CmdlineBeforeMainAction) {
205 // This is O(|plugins| * |add_plugins|), but since both numbers are
206 // way below 50 in practice, that's ok.
207 if (llvm::is_contained(Range&: CI.getFrontendOpts().AddPluginActions,
208 Element: Plugin.getName())) {
209 if (ActionType == PluginASTAction::CmdlineBeforeMainAction)
210 ActionType = PluginASTAction::AddBeforeMainAction;
211 else
212 ActionType = PluginASTAction::AddAfterMainAction;
213 }
214 }
215 if ((ActionType == PluginASTAction::AddBeforeMainAction ||
216 ActionType == PluginASTAction::AddAfterMainAction) &&
217 P->ParseArgs(
218 CI,
219 arg: CI.getFrontendOpts().PluginArgs[std::string(Plugin.getName())])) {
220 std::unique_ptr<ASTConsumer> PluginConsumer = P->CreateASTConsumer(CI, InFile);
221 if (ActionType == PluginASTAction::AddBeforeMainAction) {
222 Consumers.push_back(x: std::move(PluginConsumer));
223 } else {
224 AfterConsumers.push_back(x: std::move(PluginConsumer));
225 }
226 }
227 }
228
229 // Add to Consumers the main consumer, then all the plugins that go after it
230 Consumers.push_back(x: std::move(Consumer));
231 if (!AfterConsumers.empty()) {
232 // If we have plugins after the main consumer, which may be the codegen
233 // action, they likely will need the ASTContext, so don't clear it in the
234 // codegen action.
235 CI.getCodeGenOpts().ClearASTBeforeBackend = false;
236 for (auto &C : AfterConsumers)
237 Consumers.push_back(x: std::move(C));
238 }
239
240 return std::make_unique<MultiplexConsumer>(args: std::move(Consumers));
241}
242
243/// For preprocessed files, if the first line is the linemarker and specifies
244/// the original source file name, use that name as the input file name.
245/// Returns the location of the first token after the line marker directive.
246///
247/// \param CI The compiler instance.
248/// \param InputFile Populated with the filename from the line marker.
249/// \param IsModuleMap If \c true, add a line note corresponding to this line
250/// directive. (We need to do this because the directive will not be
251/// visited by the preprocessor.)
252static SourceLocation ReadOriginalFileName(CompilerInstance &CI,
253 std::string &InputFile,
254 bool IsModuleMap = false) {
255 auto &SourceMgr = CI.getSourceManager();
256 auto MainFileID = SourceMgr.getMainFileID();
257
258 auto MainFileBuf = SourceMgr.getBufferOrNone(FID: MainFileID);
259 if (!MainFileBuf)
260 return SourceLocation();
261
262 std::unique_ptr<Lexer> RawLexer(
263 new Lexer(MainFileID, *MainFileBuf, SourceMgr, CI.getLangOpts()));
264
265 // If the first line has the syntax of
266 //
267 // # NUM "FILENAME"
268 //
269 // we use FILENAME as the input file name.
270 Token T;
271 if (RawLexer->LexFromRawLexer(Result&: T) || T.getKind() != tok::hash)
272 return SourceLocation();
273 if (RawLexer->LexFromRawLexer(Result&: T) || T.isAtStartOfLine() ||
274 T.getKind() != tok::numeric_constant)
275 return SourceLocation();
276
277 unsigned LineNo;
278 SourceLocation LineNoLoc = T.getLocation();
279 if (IsModuleMap) {
280 llvm::SmallString<16> Buffer;
281 if (Lexer::getSpelling(loc: LineNoLoc, buffer&: Buffer, SM: SourceMgr, options: CI.getLangOpts())
282 .getAsInteger(Radix: 10, Result&: LineNo))
283 return SourceLocation();
284 }
285
286 RawLexer->LexFromRawLexer(Result&: T);
287 if (T.isAtStartOfLine() || T.getKind() != tok::string_literal)
288 return SourceLocation();
289
290 StringLiteralParser Literal(T, CI.getPreprocessor());
291 if (Literal.hadError)
292 return SourceLocation();
293 RawLexer->LexFromRawLexer(Result&: T);
294 if (T.isNot(K: tok::eof) && !T.isAtStartOfLine())
295 return SourceLocation();
296 InputFile = Literal.GetString().str();
297
298 if (IsModuleMap)
299 CI.getSourceManager().AddLineNote(
300 Loc: LineNoLoc, LineNo, FilenameID: SourceMgr.getLineTableFilenameID(Str: InputFile), IsFileEntry: false,
301 IsFileExit: false, FileKind: SrcMgr::C_User_ModuleMap);
302
303 return T.getLocation();
304}
305
306static SmallVectorImpl<char> &
307operator+=(SmallVectorImpl<char> &Includes, StringRef RHS) {
308 Includes.append(in_start: RHS.begin(), in_end: RHS.end());
309 return Includes;
310}
311
312static void addHeaderInclude(StringRef HeaderName,
313 SmallVectorImpl<char> &Includes,
314 const LangOptions &LangOpts,
315 bool IsExternC) {
316 if (IsExternC && LangOpts.CPlusPlus)
317 Includes += "extern \"C\" {\n";
318 if (LangOpts.ObjC)
319 Includes += "#import \"";
320 else
321 Includes += "#include \"";
322
323 Includes += HeaderName;
324
325 Includes += "\"\n";
326 if (IsExternC && LangOpts.CPlusPlus)
327 Includes += "}\n";
328}
329
330/// Collect the set of header includes needed to construct the given
331/// module and update the TopHeaders file set of the module.
332///
333/// \param Module The module we're collecting includes from.
334///
335/// \param Includes Will be augmented with the set of \#includes or \#imports
336/// needed to load all of the named headers.
337static std::error_code collectModuleHeaderIncludes(
338 const LangOptions &LangOpts, FileManager &FileMgr, DiagnosticsEngine &Diag,
339 ModuleMap &ModMap, clang::Module *Module, SmallVectorImpl<char> &Includes) {
340 // Don't collect any headers for unavailable modules.
341 if (!Module->isAvailable())
342 return std::error_code();
343
344 // Resolve all lazy header directives to header files.
345 ModMap.resolveHeaderDirectives(Mod: Module, /*File=*/std::nullopt);
346
347 // If any headers are missing, we can't build this module. In most cases,
348 // diagnostics for this should have already been produced; we only get here
349 // if explicit stat information was provided.
350 // FIXME: If the name resolves to a file with different stat information,
351 // produce a better diagnostic.
352 if (!Module->MissingHeaders.empty()) {
353 auto &MissingHeader = Module->MissingHeaders.front();
354 Diag.Report(MissingHeader.FileNameLoc, diag::err_module_header_missing)
355 << MissingHeader.IsUmbrella << MissingHeader.FileName;
356 return std::error_code();
357 }
358
359 // Add includes for each of these headers.
360 for (auto HK : {Module::HK_Normal, Module::HK_Private}) {
361 for (Module::Header &H : Module->Headers[HK]) {
362 Module->addTopHeader(File: H.Entry);
363 // Use the path as specified in the module map file. We'll look for this
364 // file relative to the module build directory (the directory containing
365 // the module map file) so this will find the same file that we found
366 // while parsing the module map.
367 addHeaderInclude(HeaderName: H.PathRelativeToRootModuleDirectory, Includes, LangOpts,
368 IsExternC: Module->IsExternC);
369 }
370 }
371 // Note that Module->PrivateHeaders will not be a TopHeader.
372
373 if (std::optional<Module::Header> UmbrellaHeader =
374 Module->getUmbrellaHeaderAsWritten()) {
375 Module->addTopHeader(File: UmbrellaHeader->Entry);
376 if (Module->Parent)
377 // Include the umbrella header for submodules.
378 addHeaderInclude(HeaderName: UmbrellaHeader->PathRelativeToRootModuleDirectory,
379 Includes, LangOpts, IsExternC: Module->IsExternC);
380 } else if (std::optional<Module::DirectoryName> UmbrellaDir =
381 Module->getUmbrellaDirAsWritten()) {
382 // Add all of the headers we find in this subdirectory.
383 std::error_code EC;
384 SmallString<128> DirNative;
385 llvm::sys::path::native(path: UmbrellaDir->Entry.getName(), result&: DirNative);
386
387 llvm::vfs::FileSystem &FS = FileMgr.getVirtualFileSystem();
388 SmallVector<std::pair<std::string, FileEntryRef>, 8> Headers;
389 for (llvm::vfs::recursive_directory_iterator Dir(FS, DirNative, EC), End;
390 Dir != End && !EC; Dir.increment(EC)) {
391 // Check whether this entry has an extension typically associated with
392 // headers.
393 if (!llvm::StringSwitch<bool>(llvm::sys::path::extension(path: Dir->path()))
394 .Cases(S0: ".h", S1: ".H", S2: ".hh", S3: ".hpp", Value: true)
395 .Default(Value: false))
396 continue;
397
398 auto Header = FileMgr.getOptionalFileRef(Filename: Dir->path());
399 // FIXME: This shouldn't happen unless there is a file system race. Is
400 // that worth diagnosing?
401 if (!Header)
402 continue;
403
404 // If this header is marked 'unavailable' in this module, don't include
405 // it.
406 if (ModMap.isHeaderUnavailableInModule(Header: *Header, RequestingModule: Module))
407 continue;
408
409 // Compute the relative path from the directory to this file.
410 SmallVector<StringRef, 16> Components;
411 auto PathIt = llvm::sys::path::rbegin(path: Dir->path());
412 for (int I = 0; I != Dir.level() + 1; ++I, ++PathIt)
413 Components.push_back(Elt: *PathIt);
414 SmallString<128> RelativeHeader(
415 UmbrellaDir->PathRelativeToRootModuleDirectory);
416 for (auto It = Components.rbegin(), End = Components.rend(); It != End;
417 ++It)
418 llvm::sys::path::append(path&: RelativeHeader, a: *It);
419
420 std::string RelName = RelativeHeader.c_str();
421 Headers.push_back(Elt: std::make_pair(x&: RelName, y&: *Header));
422 }
423
424 if (EC)
425 return EC;
426
427 // Sort header paths and make the header inclusion order deterministic
428 // across different OSs and filesystems.
429 llvm::sort(C&: Headers, Comp: llvm::less_first());
430 for (auto &H : Headers) {
431 // Include this header as part of the umbrella directory.
432 Module->addTopHeader(File: H.second);
433 addHeaderInclude(HeaderName: H.first, Includes, LangOpts, IsExternC: Module->IsExternC);
434 }
435 }
436
437 // Recurse into submodules.
438 for (auto *Submodule : Module->submodules())
439 if (std::error_code Err = collectModuleHeaderIncludes(
440 LangOpts, FileMgr, Diag, ModMap, Module: Submodule, Includes))
441 return Err;
442
443 return std::error_code();
444}
445
446static bool loadModuleMapForModuleBuild(CompilerInstance &CI, bool IsSystem,
447 bool IsPreprocessed,
448 std::string &PresumedModuleMapFile,
449 unsigned &Offset) {
450 auto &SrcMgr = CI.getSourceManager();
451 HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
452
453 // Map the current input to a file.
454 FileID ModuleMapID = SrcMgr.getMainFileID();
455 OptionalFileEntryRef ModuleMap = SrcMgr.getFileEntryRefForID(FID: ModuleMapID);
456 assert(ModuleMap && "MainFileID without FileEntry");
457
458 // If the module map is preprocessed, handle the initial line marker;
459 // line directives are not part of the module map syntax in general.
460 Offset = 0;
461 if (IsPreprocessed) {
462 SourceLocation EndOfLineMarker =
463 ReadOriginalFileName(CI, InputFile&: PresumedModuleMapFile, /*IsModuleMap*/ true);
464 if (EndOfLineMarker.isValid())
465 Offset = CI.getSourceManager().getDecomposedLoc(Loc: EndOfLineMarker).second;
466 }
467
468 // Load the module map file.
469 if (HS.loadModuleMapFile(File: *ModuleMap, IsSystem, ID: ModuleMapID, Offset: &Offset,
470 OriginalModuleMapFile: PresumedModuleMapFile))
471 return true;
472
473 if (SrcMgr.getBufferOrFake(FID: ModuleMapID).getBufferSize() == Offset)
474 Offset = 0;
475
476 // Infer framework module if possible.
477 if (HS.getModuleMap().canInferFrameworkModule(Dir: ModuleMap->getDir())) {
478 SmallString<128> InferredFrameworkPath = ModuleMap->getDir().getName();
479 llvm::sys::path::append(path&: InferredFrameworkPath,
480 a: CI.getLangOpts().ModuleName + ".framework");
481 if (auto Dir =
482 CI.getFileManager().getOptionalDirectoryRef(DirName: InferredFrameworkPath))
483 (void)HS.getModuleMap().inferFrameworkModule(FrameworkDir: *Dir, IsSystem, Parent: nullptr);
484 }
485
486 return false;
487}
488
489static Module *prepareToBuildModule(CompilerInstance &CI,
490 StringRef ModuleMapFilename) {
491 if (CI.getLangOpts().CurrentModule.empty()) {
492 CI.getDiagnostics().Report(diag::err_missing_module_name);
493
494 // FIXME: Eventually, we could consider asking whether there was just
495 // a single module described in the module map, and use that as a
496 // default. Then it would be fairly trivial to just "compile" a module
497 // map with a single module (the common case).
498 return nullptr;
499 }
500
501 // Dig out the module definition.
502 HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
503 Module *M = HS.lookupModule(ModuleName: CI.getLangOpts().CurrentModule, ImportLoc: SourceLocation(),
504 /*AllowSearch=*/true);
505 if (!M) {
506 CI.getDiagnostics().Report(diag::err_missing_module)
507 << CI.getLangOpts().CurrentModule << ModuleMapFilename;
508
509 return nullptr;
510 }
511
512 // Check whether we can build this module at all.
513 if (Preprocessor::checkModuleIsAvailable(LangOpts: CI.getLangOpts(), TargetInfo: CI.getTarget(), M: *M,
514 Diags&: CI.getDiagnostics()))
515 return nullptr;
516
517 // Inform the preprocessor that includes from within the input buffer should
518 // be resolved relative to the build directory of the module map file.
519 CI.getPreprocessor().setMainFileDir(*M->Directory);
520
521 // If the module was inferred from a different module map (via an expanded
522 // umbrella module definition), track that fact.
523 // FIXME: It would be preferable to fill this in as part of processing
524 // the module map, rather than adding it after the fact.
525 StringRef OriginalModuleMapName = CI.getFrontendOpts().OriginalModuleMap;
526 if (!OriginalModuleMapName.empty()) {
527 auto OriginalModuleMap =
528 CI.getFileManager().getOptionalFileRef(Filename: OriginalModuleMapName,
529 /*openFile*/ OpenFile: true);
530 if (!OriginalModuleMap) {
531 CI.getDiagnostics().Report(diag::err_module_map_not_found)
532 << OriginalModuleMapName;
533 return nullptr;
534 }
535 if (*OriginalModuleMap != CI.getSourceManager().getFileEntryRefForID(
536 FID: CI.getSourceManager().getMainFileID())) {
537 M->IsInferred = true;
538 auto FileCharacter =
539 M->IsSystem ? SrcMgr::C_System_ModuleMap : SrcMgr::C_User_ModuleMap;
540 FileID OriginalModuleMapFID = CI.getSourceManager().getOrCreateFileID(
541 SourceFile: *OriginalModuleMap, FileCharacter);
542 CI.getPreprocessor()
543 .getHeaderSearchInfo()
544 .getModuleMap()
545 .setInferredModuleAllowedBy(M, ModMapFID: OriginalModuleMapFID);
546 }
547 }
548
549 // If we're being run from the command-line, the module build stack will not
550 // have been filled in yet, so complete it now in order to allow us to detect
551 // module cycles.
552 SourceManager &SourceMgr = CI.getSourceManager();
553 if (SourceMgr.getModuleBuildStack().empty())
554 SourceMgr.pushModuleBuildStack(moduleName: CI.getLangOpts().CurrentModule,
555 importLoc: FullSourceLoc(SourceLocation(), SourceMgr));
556 return M;
557}
558
559/// Compute the input buffer that should be used to build the specified module.
560static std::unique_ptr<llvm::MemoryBuffer>
561getInputBufferForModule(CompilerInstance &CI, Module *M) {
562 FileManager &FileMgr = CI.getFileManager();
563
564 // Collect the set of #includes we need to build the module.
565 SmallString<256> HeaderContents;
566 std::error_code Err = std::error_code();
567 if (std::optional<Module::Header> UmbrellaHeader =
568 M->getUmbrellaHeaderAsWritten())
569 addHeaderInclude(HeaderName: UmbrellaHeader->PathRelativeToRootModuleDirectory,
570 Includes&: HeaderContents, LangOpts: CI.getLangOpts(), IsExternC: M->IsExternC);
571 Err = collectModuleHeaderIncludes(
572 LangOpts: CI.getLangOpts(), FileMgr, Diag&: CI.getDiagnostics(),
573 ModMap&: CI.getPreprocessor().getHeaderSearchInfo().getModuleMap(), Module: M,
574 Includes&: HeaderContents);
575
576 if (Err) {
577 CI.getDiagnostics().Report(diag::err_module_cannot_create_includes)
578 << M->getFullModuleName() << Err.message();
579 return nullptr;
580 }
581
582 return llvm::MemoryBuffer::getMemBufferCopy(
583 InputData: HeaderContents, BufferName: Module::getModuleInputBufferName());
584}
585
586bool FrontendAction::BeginSourceFile(CompilerInstance &CI,
587 const FrontendInputFile &RealInput) {
588 FrontendInputFile Input(RealInput);
589 assert(!Instance && "Already processing a source file!");
590 assert(!Input.isEmpty() && "Unexpected empty filename!");
591 setCurrentInput(CurrentInput: Input);
592 setCompilerInstance(&CI);
593
594 bool HasBegunSourceFile = false;
595 bool ReplayASTFile = Input.getKind().getFormat() == InputKind::Precompiled &&
596 usesPreprocessorOnly();
597
598 // If we fail, reset state since the client will not end up calling the
599 // matching EndSourceFile(). All paths that return true should release this.
600 auto FailureCleanup = llvm::make_scope_exit(F: [&]() {
601 if (HasBegunSourceFile)
602 CI.getDiagnosticClient().EndSourceFile();
603 CI.setASTConsumer(nullptr);
604 CI.clearOutputFiles(/*EraseFiles=*/true);
605 CI.getLangOpts().setCompilingModule(LangOptions::CMK_None);
606 setCurrentInput(CurrentInput: FrontendInputFile());
607 setCompilerInstance(nullptr);
608 });
609
610 if (!BeginInvocation(CI))
611 return false;
612
613 // If we're replaying the build of an AST file, import it and set up
614 // the initial state from its build.
615 if (ReplayASTFile) {
616 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(&CI.getDiagnostics());
617
618 // The AST unit populates its own diagnostics engine rather than ours.
619 IntrusiveRefCntPtr<DiagnosticsEngine> ASTDiags(
620 new DiagnosticsEngine(Diags->getDiagnosticIDs(),
621 &Diags->getDiagnosticOptions()));
622 ASTDiags->setClient(client: Diags->getClient(), /*OwnsClient*/ShouldOwnClient: false);
623
624 // FIXME: What if the input is a memory buffer?
625 StringRef InputFile = Input.getFile();
626
627 std::unique_ptr<ASTUnit> AST = ASTUnit::LoadFromASTFile(
628 Filename: std::string(InputFile), PCHContainerRdr: CI.getPCHContainerReader(),
629 ToLoad: ASTUnit::LoadPreprocessorOnly, Diags: ASTDiags, FileSystemOpts: CI.getFileSystemOpts(),
630 /*HeaderSearchOptions=*/HSOpts: nullptr);
631 if (!AST)
632 return false;
633
634 // Options relating to how we treat the input (but not what we do with it)
635 // are inherited from the AST unit.
636 CI.getHeaderSearchOpts() = AST->getHeaderSearchOpts();
637 CI.getPreprocessorOpts() = AST->getPreprocessorOpts();
638 CI.getLangOpts() = AST->getLangOpts();
639
640 // Set the shared objects, these are reset when we finish processing the
641 // file, otherwise the CompilerInstance will happily destroy them.
642 CI.setFileManager(&AST->getFileManager());
643 CI.createSourceManager(FileMgr&: CI.getFileManager());
644 CI.getSourceManager().initializeForReplay(Old: AST->getSourceManager());
645
646 // Preload all the module files loaded transitively by the AST unit. Also
647 // load all module map files that were parsed as part of building the AST
648 // unit.
649 if (auto ASTReader = AST->getASTReader()) {
650 auto &MM = ASTReader->getModuleManager();
651 auto &PrimaryModule = MM.getPrimaryModule();
652
653 for (serialization::ModuleFile &MF : MM)
654 if (&MF != &PrimaryModule)
655 CI.getFrontendOpts().ModuleFiles.push_back(x: MF.FileName);
656
657 ASTReader->visitTopLevelModuleMaps(MF&: PrimaryModule, Visitor: [&](FileEntryRef FE) {
658 CI.getFrontendOpts().ModuleMapFiles.push_back(
659 x: std::string(FE.getName()));
660 });
661 }
662
663 // Set up the input file for replay purposes.
664 auto Kind = AST->getInputKind();
665 if (Kind.getFormat() == InputKind::ModuleMap) {
666 Module *ASTModule =
667 AST->getPreprocessor().getHeaderSearchInfo().lookupModule(
668 ModuleName: AST->getLangOpts().CurrentModule, ImportLoc: SourceLocation(),
669 /*AllowSearch*/ false);
670 assert(ASTModule && "module file does not define its own module");
671 Input = FrontendInputFile(ASTModule->PresumedModuleMapFile, Kind);
672 } else {
673 auto &OldSM = AST->getSourceManager();
674 FileID ID = OldSM.getMainFileID();
675 if (auto File = OldSM.getFileEntryRefForID(FID: ID))
676 Input = FrontendInputFile(File->getName(), Kind);
677 else
678 Input = FrontendInputFile(OldSM.getBufferOrFake(FID: ID), Kind);
679 }
680 setCurrentInput(CurrentInput: Input, AST: std::move(AST));
681 }
682
683 // AST files follow a very different path, since they share objects via the
684 // AST unit.
685 if (Input.getKind().getFormat() == InputKind::Precompiled) {
686 assert(!usesPreprocessorOnly() && "this case was handled above");
687 assert(hasASTFileSupport() &&
688 "This action does not have AST file support!");
689
690 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(&CI.getDiagnostics());
691
692 // FIXME: What if the input is a memory buffer?
693 StringRef InputFile = Input.getFile();
694
695 std::unique_ptr<ASTUnit> AST = ASTUnit::LoadFromASTFile(
696 Filename: std::string(InputFile), PCHContainerRdr: CI.getPCHContainerReader(),
697 ToLoad: ASTUnit::LoadEverything, Diags, FileSystemOpts: CI.getFileSystemOpts(),
698 HSOpts: CI.getHeaderSearchOptsPtr(), LangOpts: CI.getLangOptsPtr());
699
700 if (!AST)
701 return false;
702
703 // Inform the diagnostic client we are processing a source file.
704 CI.getDiagnosticClient().BeginSourceFile(LangOpts: CI.getLangOpts(), PP: nullptr);
705 HasBegunSourceFile = true;
706
707 // Set the shared objects, these are reset when we finish processing the
708 // file, otherwise the CompilerInstance will happily destroy them.
709 CI.setFileManager(&AST->getFileManager());
710 CI.setSourceManager(&AST->getSourceManager());
711 CI.setPreprocessor(AST->getPreprocessorPtr());
712 Preprocessor &PP = CI.getPreprocessor();
713 PP.getBuiltinInfo().initializeBuiltins(Table&: PP.getIdentifierTable(),
714 LangOpts: PP.getLangOpts());
715 CI.setASTContext(&AST->getASTContext());
716
717 setCurrentInput(CurrentInput: Input, AST: std::move(AST));
718
719 // Initialize the action.
720 if (!BeginSourceFileAction(CI))
721 return false;
722
723 // Create the AST consumer.
724 CI.setASTConsumer(CreateWrappedASTConsumer(CI, InFile: InputFile));
725 if (!CI.hasASTConsumer())
726 return false;
727
728 FailureCleanup.release();
729 return true;
730 }
731
732 // Set up the file and source managers, if needed.
733 if (!CI.hasFileManager()) {
734 if (!CI.createFileManager()) {
735 return false;
736 }
737 }
738 if (!CI.hasSourceManager()) {
739 CI.createSourceManager(FileMgr&: CI.getFileManager());
740 if (CI.getDiagnosticOpts().getFormat() == DiagnosticOptions::SARIF) {
741 static_cast<SARIFDiagnosticPrinter *>(&CI.getDiagnosticClient())
742 ->setSarifWriter(
743 std::make_unique<SarifDocumentWriter>(args&: CI.getSourceManager()));
744 }
745 }
746
747 // Set up embedding for any specified files. Do this before we load any
748 // source files, including the primary module map for the compilation.
749 for (const auto &F : CI.getFrontendOpts().ModulesEmbedFiles) {
750 if (auto FE = CI.getFileManager().getOptionalFileRef(Filename: F, /*openFile*/OpenFile: true))
751 CI.getSourceManager().setFileIsTransient(*FE);
752 else
753 CI.getDiagnostics().Report(diag::err_modules_embed_file_not_found) << F;
754 }
755 if (CI.getFrontendOpts().ModulesEmbedAllFiles)
756 CI.getSourceManager().setAllFilesAreTransient(true);
757
758 // IR files bypass the rest of initialization.
759 if (Input.getKind().getLanguage() == Language::LLVM_IR) {
760 assert(hasIRSupport() &&
761 "This action does not have IR file support!");
762
763 // Inform the diagnostic client we are processing a source file.
764 CI.getDiagnosticClient().BeginSourceFile(LangOpts: CI.getLangOpts(), PP: nullptr);
765 HasBegunSourceFile = true;
766
767 // Initialize the action.
768 if (!BeginSourceFileAction(CI))
769 return false;
770
771 // Initialize the main file entry.
772 if (!CI.InitializeSourceManager(Input: CurrentInput))
773 return false;
774
775 FailureCleanup.release();
776 return true;
777 }
778
779 // If the implicit PCH include is actually a directory, rather than
780 // a single file, search for a suitable PCH file in that directory.
781 if (!CI.getPreprocessorOpts().ImplicitPCHInclude.empty()) {
782 FileManager &FileMgr = CI.getFileManager();
783 PreprocessorOptions &PPOpts = CI.getPreprocessorOpts();
784 StringRef PCHInclude = PPOpts.ImplicitPCHInclude;
785 std::string SpecificModuleCachePath = CI.getSpecificModuleCachePath();
786 if (auto PCHDir = FileMgr.getOptionalDirectoryRef(DirName: PCHInclude)) {
787 std::error_code EC;
788 SmallString<128> DirNative;
789 llvm::sys::path::native(path: PCHDir->getName(), result&: DirNative);
790 bool Found = false;
791 llvm::vfs::FileSystem &FS = FileMgr.getVirtualFileSystem();
792 for (llvm::vfs::directory_iterator Dir = FS.dir_begin(Dir: DirNative, EC),
793 DirEnd;
794 Dir != DirEnd && !EC; Dir.increment(EC)) {
795 // Check whether this is an acceptable AST file.
796 if (ASTReader::isAcceptableASTFile(
797 Filename: Dir->path(), FileMgr, ModuleCache: CI.getModuleCache(),
798 PCHContainerRdr: CI.getPCHContainerReader(), LangOpts: CI.getLangOpts(),
799 TargetOpts: CI.getTargetOpts(), PPOpts: CI.getPreprocessorOpts(),
800 ExistingModuleCachePath: SpecificModuleCachePath, /*RequireStrictOptionMatches=*/true)) {
801 PPOpts.ImplicitPCHInclude = std::string(Dir->path());
802 Found = true;
803 break;
804 }
805 }
806
807 if (!Found) {
808 CI.getDiagnostics().Report(diag::err_fe_no_pch_in_dir) << PCHInclude;
809 return false;
810 }
811 }
812 }
813
814 // Set up the preprocessor if needed. When parsing model files the
815 // preprocessor of the original source is reused.
816 if (!isModelParsingAction())
817 CI.createPreprocessor(TUKind: getTranslationUnitKind());
818
819 // Inform the diagnostic client we are processing a source file.
820 CI.getDiagnosticClient().BeginSourceFile(LangOpts: CI.getLangOpts(),
821 PP: &CI.getPreprocessor());
822 HasBegunSourceFile = true;
823
824 // Handle C++20 header units.
825 // Here, the user has the option to specify that the header name should be
826 // looked up in the pre-processor search paths (and the main filename as
827 // passed by the driver might therefore be incomplete until that look-up).
828 if (CI.getLangOpts().CPlusPlusModules && Input.getKind().isHeaderUnit() &&
829 !Input.getKind().isPreprocessed()) {
830 StringRef FileName = Input.getFile();
831 InputKind Kind = Input.getKind();
832 if (Kind.getHeaderUnitKind() != InputKind::HeaderUnit_Abs) {
833 assert(CI.hasPreprocessor() &&
834 "trying to build a header unit without a Pre-processor?");
835 HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
836 // Relative searches begin from CWD.
837 auto Dir = CI.getFileManager().getOptionalDirectoryRef(DirName: ".");
838 SmallVector<std::pair<OptionalFileEntryRef, DirectoryEntryRef>, 1> CWD;
839 CWD.push_back(Elt: {std::nullopt, *Dir});
840 OptionalFileEntryRef FE =
841 HS.LookupFile(Filename: FileName, IncludeLoc: SourceLocation(),
842 /*Angled*/ isAngled: Input.getKind().getHeaderUnitKind() ==
843 InputKind::HeaderUnit_System,
844 FromDir: nullptr, CurDir: nullptr, Includers: CWD, SearchPath: nullptr, RelativePath: nullptr, RequestingModule: nullptr,
845 SuggestedModule: nullptr, IsMapped: nullptr, IsFrameworkFound: nullptr);
846 if (!FE) {
847 CI.getDiagnostics().Report(diag::err_module_header_file_not_found)
848 << FileName;
849 return false;
850 }
851 // We now have the filename...
852 FileName = FE->getName();
853 // ... still a header unit, but now use the path as written.
854 Kind = Input.getKind().withHeaderUnit(HU: InputKind::HeaderUnit_Abs);
855 Input = FrontendInputFile(FileName, Kind, Input.isSystem());
856 }
857 // Unless the user has overridden the name, the header unit module name is
858 // the pathname for the file.
859 if (CI.getLangOpts().ModuleName.empty())
860 CI.getLangOpts().ModuleName = std::string(FileName);
861 CI.getLangOpts().CurrentModule = CI.getLangOpts().ModuleName;
862 }
863
864 if (!CI.InitializeSourceManager(Input))
865 return false;
866
867 if (CI.getLangOpts().CPlusPlusModules && Input.getKind().isHeaderUnit() &&
868 Input.getKind().isPreprocessed() && !usesPreprocessorOnly()) {
869 // We have an input filename like foo.iih, but we want to find the right
870 // module name (and original file, to build the map entry).
871 // Check if the first line specifies the original source file name with a
872 // linemarker.
873 std::string PresumedInputFile = std::string(getCurrentFileOrBufferName());
874 ReadOriginalFileName(CI, InputFile&: PresumedInputFile);
875 // Unless the user overrides this, the module name is the name by which the
876 // original file was known.
877 if (CI.getLangOpts().ModuleName.empty())
878 CI.getLangOpts().ModuleName = std::string(PresumedInputFile);
879 CI.getLangOpts().CurrentModule = CI.getLangOpts().ModuleName;
880 }
881
882 // For module map files, we first parse the module map and synthesize a
883 // "<module-includes>" buffer before more conventional processing.
884 if (Input.getKind().getFormat() == InputKind::ModuleMap) {
885 CI.getLangOpts().setCompilingModule(LangOptions::CMK_ModuleMap);
886
887 std::string PresumedModuleMapFile;
888 unsigned OffsetToContents;
889 if (loadModuleMapForModuleBuild(CI, IsSystem: Input.isSystem(),
890 IsPreprocessed: Input.isPreprocessed(),
891 PresumedModuleMapFile, Offset&: OffsetToContents))
892 return false;
893
894 auto *CurrentModule = prepareToBuildModule(CI, ModuleMapFilename: Input.getFile());
895 if (!CurrentModule)
896 return false;
897
898 CurrentModule->PresumedModuleMapFile = PresumedModuleMapFile;
899
900 if (OffsetToContents)
901 // If the module contents are in the same file, skip to them.
902 CI.getPreprocessor().setSkipMainFilePreamble(Bytes: OffsetToContents, StartOfLine: true);
903 else {
904 // Otherwise, convert the module description to a suitable input buffer.
905 auto Buffer = getInputBufferForModule(CI, M: CurrentModule);
906 if (!Buffer)
907 return false;
908
909 // Reinitialize the main file entry to refer to the new input.
910 auto Kind = CurrentModule->IsSystem ? SrcMgr::C_System : SrcMgr::C_User;
911 auto &SourceMgr = CI.getSourceManager();
912 auto BufferID = SourceMgr.createFileID(Buffer: std::move(Buffer), FileCharacter: Kind);
913 assert(BufferID.isValid() && "couldn't create module buffer ID");
914 SourceMgr.setMainFileID(BufferID);
915 }
916 }
917
918 // Initialize the action.
919 if (!BeginSourceFileAction(CI))
920 return false;
921
922 // If we were asked to load any module map files, do so now.
923 for (const auto &Filename : CI.getFrontendOpts().ModuleMapFiles) {
924 if (auto File = CI.getFileManager().getOptionalFileRef(Filename))
925 CI.getPreprocessor().getHeaderSearchInfo().loadModuleMapFile(
926 File: *File, /*IsSystem*/false);
927 else
928 CI.getDiagnostics().Report(diag::err_module_map_not_found) << Filename;
929 }
930
931 // If compiling implementation of a module, load its module map file now.
932 (void)CI.getPreprocessor().getCurrentModuleImplementation();
933
934 // Add a module declaration scope so that modules from -fmodule-map-file
935 // arguments may shadow modules found implicitly in search paths.
936 CI.getPreprocessor()
937 .getHeaderSearchInfo()
938 .getModuleMap()
939 .finishModuleDeclarationScope();
940
941 // Create the AST context and consumer unless this is a preprocessor only
942 // action.
943 if (!usesPreprocessorOnly()) {
944 // Parsing a model file should reuse the existing ASTContext.
945 if (!isModelParsingAction())
946 CI.createASTContext();
947
948 // For preprocessed files, check if the first line specifies the original
949 // source file name with a linemarker.
950 std::string PresumedInputFile = std::string(getCurrentFileOrBufferName());
951 if (Input.isPreprocessed())
952 ReadOriginalFileName(CI, InputFile&: PresumedInputFile);
953
954 std::unique_ptr<ASTConsumer> Consumer =
955 CreateWrappedASTConsumer(CI, InFile: PresumedInputFile);
956 if (!Consumer)
957 return false;
958
959 // FIXME: should not overwrite ASTMutationListener when parsing model files?
960 if (!isModelParsingAction())
961 CI.getASTContext().setASTMutationListener(Consumer->GetASTMutationListener());
962
963 if (!CI.getPreprocessorOpts().ChainedIncludes.empty()) {
964 // Convert headers to PCH and chain them.
965 IntrusiveRefCntPtr<ExternalSemaSource> source, FinalReader;
966 source = createChainedIncludesSource(CI, Reader&: FinalReader);
967 if (!source)
968 return false;
969 CI.setASTReader(static_cast<ASTReader *>(FinalReader.get()));
970 CI.getASTContext().setExternalSource(source);
971 } else if (CI.getLangOpts().Modules ||
972 !CI.getPreprocessorOpts().ImplicitPCHInclude.empty()) {
973 // Use PCM or PCH.
974 assert(hasPCHSupport() && "This action does not have PCH support!");
975 ASTDeserializationListener *DeserialListener =
976 Consumer->GetASTDeserializationListener();
977 bool DeleteDeserialListener = false;
978 if (CI.getPreprocessorOpts().DumpDeserializedPCHDecls) {
979 DeserialListener = new DeserializedDeclsDumper(DeserialListener,
980 DeleteDeserialListener);
981 DeleteDeserialListener = true;
982 }
983 if (!CI.getPreprocessorOpts().DeserializedPCHDeclsToErrorOn.empty()) {
984 DeserialListener = new DeserializedDeclsChecker(
985 CI.getASTContext(),
986 CI.getPreprocessorOpts().DeserializedPCHDeclsToErrorOn,
987 DeserialListener, DeleteDeserialListener);
988 DeleteDeserialListener = true;
989 }
990 if (!CI.getPreprocessorOpts().ImplicitPCHInclude.empty()) {
991 CI.createPCHExternalASTSource(
992 Path: CI.getPreprocessorOpts().ImplicitPCHInclude,
993 DisableValidation: CI.getPreprocessorOpts().DisablePCHOrModuleValidation,
994 AllowPCHWithCompilerErrors: CI.getPreprocessorOpts().AllowPCHWithCompilerErrors,
995 DeserializationListener: DeserialListener, OwnDeserializationListener: DeleteDeserialListener);
996 if (!CI.getASTContext().getExternalSource())
997 return false;
998 }
999 // If modules are enabled, create the AST reader before creating
1000 // any builtins, so that all declarations know that they might be
1001 // extended by an external source.
1002 if (CI.getLangOpts().Modules || !CI.hasASTContext() ||
1003 !CI.getASTContext().getExternalSource()) {
1004 CI.createASTReader();
1005 CI.getASTReader()->setDeserializationListener(Listener: DeserialListener,
1006 TakeOwnership: DeleteDeserialListener);
1007 }
1008 }
1009
1010 CI.setASTConsumer(std::move(Consumer));
1011 if (!CI.hasASTConsumer())
1012 return false;
1013 }
1014
1015 // Initialize built-in info as long as we aren't using an external AST
1016 // source.
1017 if (CI.getLangOpts().Modules || !CI.hasASTContext() ||
1018 !CI.getASTContext().getExternalSource()) {
1019 Preprocessor &PP = CI.getPreprocessor();
1020 PP.getBuiltinInfo().initializeBuiltins(Table&: PP.getIdentifierTable(),
1021 LangOpts: PP.getLangOpts());
1022 } else {
1023 // FIXME: If this is a problem, recover from it by creating a multiplex
1024 // source.
1025 assert((!CI.getLangOpts().Modules || CI.getASTReader()) &&
1026 "modules enabled but created an external source that "
1027 "doesn't support modules");
1028 }
1029
1030 // If we were asked to load any module files, do so now.
1031 for (const auto &ModuleFile : CI.getFrontendOpts().ModuleFiles) {
1032 serialization::ModuleFile *Loaded = nullptr;
1033 if (!CI.loadModuleFile(FileName: ModuleFile, LoadedModuleFile&: Loaded))
1034 return false;
1035
1036 if (Loaded && Loaded->StandardCXXModule)
1037 CI.getDiagnostics().Report(
1038 diag::warn_eagerly_load_for_standard_cplusplus_modules);
1039 }
1040
1041 // If there is a layout overrides file, attach an external AST source that
1042 // provides the layouts from that file.
1043 if (!CI.getFrontendOpts().OverrideRecordLayoutsFile.empty() &&
1044 CI.hasASTContext() && !CI.getASTContext().getExternalSource()) {
1045 IntrusiveRefCntPtr<ExternalASTSource>
1046 Override(new LayoutOverrideSource(
1047 CI.getFrontendOpts().OverrideRecordLayoutsFile));
1048 CI.getASTContext().setExternalSource(Override);
1049 }
1050
1051 // Setup HLSL External Sema Source
1052 if (CI.getLangOpts().HLSL && CI.hasASTContext()) {
1053 IntrusiveRefCntPtr<ExternalSemaSource> HLSLSema(
1054 new HLSLExternalSemaSource());
1055 if (auto *SemaSource = dyn_cast_if_present<ExternalSemaSource>(
1056 Val: CI.getASTContext().getExternalSource())) {
1057 IntrusiveRefCntPtr<ExternalSemaSource> MultiSema(
1058 new MultiplexExternalSemaSource(SemaSource, HLSLSema.get()));
1059 CI.getASTContext().setExternalSource(MultiSema);
1060 } else
1061 CI.getASTContext().setExternalSource(HLSLSema);
1062 }
1063
1064 FailureCleanup.release();
1065 return true;
1066}
1067
1068llvm::Error FrontendAction::Execute() {
1069 CompilerInstance &CI = getCompilerInstance();
1070
1071 if (CI.hasFrontendTimer()) {
1072 llvm::TimeRegion Timer(CI.getFrontendTimer());
1073 ExecuteAction();
1074 }
1075 else ExecuteAction();
1076
1077 // If we are supposed to rebuild the global module index, do so now unless
1078 // there were any module-build failures.
1079 if (CI.shouldBuildGlobalModuleIndex() && CI.hasFileManager() &&
1080 CI.hasPreprocessor()) {
1081 StringRef Cache =
1082 CI.getPreprocessor().getHeaderSearchInfo().getModuleCachePath();
1083 if (!Cache.empty()) {
1084 if (llvm::Error Err = GlobalModuleIndex::writeIndex(
1085 FileMgr&: CI.getFileManager(), PCHContainerRdr: CI.getPCHContainerReader(), Path: Cache)) {
1086 // FIXME this drops the error on the floor, but
1087 // Index/pch-from-libclang.c seems to rely on dropping at least some of
1088 // the error conditions!
1089 consumeError(Err: std::move(Err));
1090 }
1091 }
1092 }
1093
1094 return llvm::Error::success();
1095}
1096
1097void FrontendAction::EndSourceFile() {
1098 CompilerInstance &CI = getCompilerInstance();
1099
1100 // Inform the diagnostic client we are done with this source file.
1101 CI.getDiagnosticClient().EndSourceFile();
1102
1103 // Inform the preprocessor we are done.
1104 if (CI.hasPreprocessor())
1105 CI.getPreprocessor().EndSourceFile();
1106
1107 // Finalize the action.
1108 EndSourceFileAction();
1109
1110 // Sema references the ast consumer, so reset sema first.
1111 //
1112 // FIXME: There is more per-file stuff we could just drop here?
1113 bool DisableFree = CI.getFrontendOpts().DisableFree;
1114 if (DisableFree) {
1115 CI.resetAndLeakSema();
1116 CI.resetAndLeakASTContext();
1117 llvm::BuryPointer(Ptr: CI.takeASTConsumer().get());
1118 } else {
1119 CI.setSema(nullptr);
1120 CI.setASTContext(nullptr);
1121 CI.setASTConsumer(nullptr);
1122 }
1123
1124 if (CI.getFrontendOpts().ShowStats) {
1125 llvm::errs() << "\nSTATISTICS FOR '" << getCurrentFileOrBufferName() << "':\n";
1126 CI.getPreprocessor().PrintStats();
1127 CI.getPreprocessor().getIdentifierTable().PrintStats();
1128 CI.getPreprocessor().getHeaderSearchInfo().PrintStats();
1129 CI.getSourceManager().PrintStats();
1130 llvm::errs() << "\n";
1131 }
1132
1133 // Cleanup the output streams, and erase the output files if instructed by the
1134 // FrontendAction.
1135 CI.clearOutputFiles(/*EraseFiles=*/shouldEraseOutputFiles());
1136
1137 // The resources are owned by AST when the current file is AST.
1138 // So we reset the resources here to avoid users accessing it
1139 // accidently.
1140 if (isCurrentFileAST()) {
1141 if (DisableFree) {
1142 CI.resetAndLeakPreprocessor();
1143 CI.resetAndLeakSourceManager();
1144 CI.resetAndLeakFileManager();
1145 llvm::BuryPointer(Ptr: std::move(CurrentASTUnit));
1146 } else {
1147 CI.setPreprocessor(nullptr);
1148 CI.setSourceManager(nullptr);
1149 CI.setFileManager(nullptr);
1150 }
1151 }
1152
1153 setCompilerInstance(nullptr);
1154 setCurrentInput(CurrentInput: FrontendInputFile());
1155 CI.getLangOpts().setCompilingModule(LangOptions::CMK_None);
1156}
1157
1158bool FrontendAction::shouldEraseOutputFiles() {
1159 return getCompilerInstance().getDiagnostics().hasErrorOccurred();
1160}
1161
1162//===----------------------------------------------------------------------===//
1163// Utility Actions
1164//===----------------------------------------------------------------------===//
1165
1166void ASTFrontendAction::ExecuteAction() {
1167 CompilerInstance &CI = getCompilerInstance();
1168 if (!CI.hasPreprocessor())
1169 return;
1170 // This is a fallback: If the client forgets to invoke this, we mark the
1171 // current stack as the bottom. Though not optimal, this could help prevent
1172 // stack overflow during deep recursion.
1173 clang::noteBottomOfStack();
1174
1175 // FIXME: Move the truncation aspect of this into Sema, we delayed this till
1176 // here so the source manager would be initialized.
1177 if (hasCodeCompletionSupport() &&
1178 !CI.getFrontendOpts().CodeCompletionAt.FileName.empty())
1179 CI.createCodeCompletionConsumer();
1180
1181 // Use a code completion consumer?
1182 CodeCompleteConsumer *CompletionConsumer = nullptr;
1183 if (CI.hasCodeCompletionConsumer())
1184 CompletionConsumer = &CI.getCodeCompletionConsumer();
1185
1186 if (!CI.hasSema())
1187 CI.createSema(TUKind: getTranslationUnitKind(), CompletionConsumer);
1188
1189 ParseAST(S&: CI.getSema(), PrintStats: CI.getFrontendOpts().ShowStats,
1190 SkipFunctionBodies: CI.getFrontendOpts().SkipFunctionBodies);
1191}
1192
1193void PluginASTAction::anchor() { }
1194
1195std::unique_ptr<ASTConsumer>
1196PreprocessorFrontendAction::CreateASTConsumer(CompilerInstance &CI,
1197 StringRef InFile) {
1198 llvm_unreachable("Invalid CreateASTConsumer on preprocessor action!");
1199}
1200
1201bool WrapperFrontendAction::PrepareToExecuteAction(CompilerInstance &CI) {
1202 return WrappedAction->PrepareToExecuteAction(CI);
1203}
1204std::unique_ptr<ASTConsumer>
1205WrapperFrontendAction::CreateASTConsumer(CompilerInstance &CI,
1206 StringRef InFile) {
1207 return WrappedAction->CreateASTConsumer(CI, InFile);
1208}
1209bool WrapperFrontendAction::BeginInvocation(CompilerInstance &CI) {
1210 return WrappedAction->BeginInvocation(CI);
1211}
1212bool WrapperFrontendAction::BeginSourceFileAction(CompilerInstance &CI) {
1213 WrappedAction->setCurrentInput(CurrentInput: getCurrentInput());
1214 WrappedAction->setCompilerInstance(&CI);
1215 auto Ret = WrappedAction->BeginSourceFileAction(CI);
1216 // BeginSourceFileAction may change CurrentInput, e.g. during module builds.
1217 setCurrentInput(CurrentInput: WrappedAction->getCurrentInput());
1218 return Ret;
1219}
1220void WrapperFrontendAction::ExecuteAction() {
1221 WrappedAction->ExecuteAction();
1222}
1223void WrapperFrontendAction::EndSourceFile() { WrappedAction->EndSourceFile(); }
1224void WrapperFrontendAction::EndSourceFileAction() {
1225 WrappedAction->EndSourceFileAction();
1226}
1227bool WrapperFrontendAction::shouldEraseOutputFiles() {
1228 return WrappedAction->shouldEraseOutputFiles();
1229}
1230
1231bool WrapperFrontendAction::usesPreprocessorOnly() const {
1232 return WrappedAction->usesPreprocessorOnly();
1233}
1234TranslationUnitKind WrapperFrontendAction::getTranslationUnitKind() {
1235 return WrappedAction->getTranslationUnitKind();
1236}
1237bool WrapperFrontendAction::hasPCHSupport() const {
1238 return WrappedAction->hasPCHSupport();
1239}
1240bool WrapperFrontendAction::hasASTFileSupport() const {
1241 return WrappedAction->hasASTFileSupport();
1242}
1243bool WrapperFrontendAction::hasIRSupport() const {
1244 return WrappedAction->hasIRSupport();
1245}
1246bool WrapperFrontendAction::hasCodeCompletionSupport() const {
1247 return WrappedAction->hasCodeCompletionSupport();
1248}
1249
1250WrapperFrontendAction::WrapperFrontendAction(
1251 std::unique_ptr<FrontendAction> WrappedAction)
1252 : WrappedAction(std::move(WrappedAction)) {}
1253

source code of clang/lib/Frontend/FrontendAction.cpp