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>
46 using namespace clang;
47
48 LLVM_INSTANTIATE_REGISTRY(FrontendPluginRegistry)
49
50 namespace {
51
52 class DelegatingDeserializationListener : public ASTDeserializationListener {
53 ASTDeserializationListener *Previous;
54 bool DeletePrevious;
55
56 public:
DelegatingDeserializationListener(ASTDeserializationListener * Previous,bool DeletePrevious)57 explicit DelegatingDeserializationListener(
58 ASTDeserializationListener *Previous, bool DeletePrevious)
59 : Previous(Previous), DeletePrevious(DeletePrevious) {}
~DelegatingDeserializationListener()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
ReaderInitialized(ASTReader * Reader)70 void ReaderInitialized(ASTReader *Reader) override {
71 if (Previous)
72 Previous->ReaderInitialized(Reader);
73 }
IdentifierRead(serialization::IdentID ID,IdentifierInfo * II)74 void IdentifierRead(serialization::IdentID ID,
75 IdentifierInfo *II) override {
76 if (Previous)
77 Previous->IdentifierRead(ID, II);
78 }
TypeRead(serialization::TypeIdx Idx,QualType T)79 void TypeRead(serialization::TypeIdx Idx, QualType T) override {
80 if (Previous)
81 Previous->TypeRead(Idx, T);
82 }
DeclRead(serialization::DeclID ID,const Decl * D)83 void DeclRead(serialization::DeclID ID, const Decl *D) override {
84 if (Previous)
85 Previous->DeclRead(ID, D);
86 }
SelectorRead(serialization::SelectorID ID,Selector Sel)87 void SelectorRead(serialization::SelectorID ID, Selector Sel) override {
88 if (Previous)
89 Previous->SelectorRead(ID, Sel);
90 }
MacroDefinitionRead(serialization::PreprocessedEntityID PPID,MacroDefinitionRecord * MD)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.
99 class DeserializedDeclsDumper : public DelegatingDeserializationListener {
100 public:
DeserializedDeclsDumper(ASTDeserializationListener * Previous,bool DeletePrevious)101 explicit DeserializedDeclsDumper(ASTDeserializationListener *Previous,
102 bool DeletePrevious)
103 : DelegatingDeserializationListener(Previous, DeletePrevious) {}
104
DeclRead(serialization::DeclID ID,const Decl * D)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>(D)) {
108 llvm::outs() << " - ";
109 ND->printQualifiedName(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.
119 class DeserializedDeclsChecker : public DelegatingDeserializationListener {
120 ASTContext &Ctx;
121 std::set<std::string> NamesToCheck;
122
123 public:
DeserializedDeclsChecker(ASTContext & Ctx,const std::set<std::string> & NamesToCheck,ASTDeserializationListener * Previous,bool DeletePrevious)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
DeclRead(serialization::DeclID ID,const Decl * D)131 void DeclRead(serialization::DeclID ID, const Decl *D) override {
132 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D))
133 if (NamesToCheck.find(ND->getNameAsString()) != NamesToCheck.end()) {
134 unsigned DiagID
135 = Ctx.getDiagnostics().getCustomDiagID(DiagnosticsEngine::Error,
136 "%0 was deserialized");
137 Ctx.getDiagnostics().Report(Ctx.getFullLoc(D->getLocation()), DiagID)
138 << ND;
139 }
140
141 DelegatingDeserializationListener::DeclRead(ID, D);
142 }
143 };
144
145 } // end anonymous namespace
146
FrontendAction()147 FrontendAction::FrontendAction() : Instance(nullptr) {}
148
~FrontendAction()149 FrontendAction::~FrontendAction() {}
150
setCurrentInput(const FrontendInputFile & CurrentInput,std::unique_ptr<ASTUnit> AST)151 void FrontendAction::setCurrentInput(const FrontendInputFile &CurrentInput,
152 std::unique_ptr<ASTUnit> AST) {
153 this->CurrentInput = CurrentInput;
154 CurrentASTUnit = std::move(AST);
155 }
156
getCurrentModule() const157 Module *FrontendAction::getCurrentModule() const {
158 CompilerInstance &CI = getCompilerInstance();
159 return CI.getPreprocessor().getHeaderSearchInfo().lookupModule(
160 CI.getLangOpts().CurrentModule, SourceLocation(), /*AllowSearch*/false);
161 }
162
163 std::unique_ptr<ASTConsumer>
CreateWrappedASTConsumer(CompilerInstance & CI,StringRef InFile)164 FrontendAction::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(CI.getFrontendOpts().AddPluginActions,
208 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 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(std::move(PluginConsumer));
223 } else {
224 AfterConsumers.push_back(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(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(std::move(C));
238 }
239
240 return std::make_unique<MultiplexConsumer>(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.)
ReadOriginalFileName(CompilerInstance & CI,std::string & InputFile,bool IsModuleMap=false)252 static 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(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(T) || T.getKind() != tok::hash)
272 return SourceLocation();
273 if (RawLexer->LexFromRawLexer(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(LineNoLoc, Buffer, SourceMgr, CI.getLangOpts())
282 .getAsInteger(10, LineNo))
283 return SourceLocation();
284 }
285
286 RawLexer->LexFromRawLexer(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(T);
294 if (T.isNot(tok::eof) && !T.isAtStartOfLine())
295 return SourceLocation();
296 InputFile = Literal.GetString().str();
297
298 if (IsModuleMap)
299 CI.getSourceManager().AddLineNote(
300 LineNoLoc, LineNo, SourceMgr.getLineTableFilenameID(InputFile), false,
301 false, SrcMgr::C_User_ModuleMap);
302
303 return T.getLocation();
304 }
305
306 static SmallVectorImpl<char> &
operator +=(SmallVectorImpl<char> & Includes,StringRef RHS)307 operator+=(SmallVectorImpl<char> &Includes, StringRef RHS) {
308 Includes.append(RHS.begin(), RHS.end());
309 return Includes;
310 }
311
addHeaderInclude(StringRef HeaderName,SmallVectorImpl<char> & Includes,const LangOptions & LangOpts,bool IsExternC)312 static 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.
collectModuleHeaderIncludes(const LangOptions & LangOpts,FileManager & FileMgr,DiagnosticsEngine & Diag,ModuleMap & ModMap,clang::Module * Module,SmallVectorImpl<char> & Includes)337 static 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(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(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(H.PathRelativeToRootModuleDirectory, Includes, LangOpts,
368 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(UmbrellaHeader->Entry);
376 if (Module->Parent)
377 // Include the umbrella header for submodules.
378 addHeaderInclude(UmbrellaHeader->PathRelativeToRootModuleDirectory,
379 Includes, LangOpts, 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(UmbrellaDir->Entry.getName(), 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(Dir->path()))
394 .Cases(".h", ".H", ".hh", ".hpp", true)
395 .Default(false))
396 continue;
397
398 auto Header = FileMgr.getOptionalFileRef(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, 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(Dir->path());
412 for (int I = 0; I != Dir.level() + 1; ++I, ++PathIt)
413 Components.push_back(*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(RelativeHeader, *It);
419
420 std::string RelName = RelativeHeader.c_str();
421 Headers.push_back(std::make_pair(RelName, *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(Headers, llvm::less_first());
430 for (auto &H : Headers) {
431 // Include this header as part of the umbrella directory.
432 Module->addTopHeader(H.second);
433 addHeaderInclude(H.first, Includes, LangOpts, 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, Submodule, Includes))
441 return Err;
442
443 return std::error_code();
444 }
445
loadModuleMapForModuleBuild(CompilerInstance & CI,bool IsSystem,bool IsPreprocessed,std::string & PresumedModuleMapFile,unsigned & Offset)446 static 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(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, PresumedModuleMapFile, /*IsModuleMap*/ true);
464 if (EndOfLineMarker.isValid())
465 Offset = CI.getSourceManager().getDecomposedLoc(EndOfLineMarker).second;
466 }
467
468 // Load the module map file.
469 if (HS.loadModuleMapFile(*ModuleMap, IsSystem, ModuleMapID, &Offset,
470 PresumedModuleMapFile))
471 return true;
472
473 if (SrcMgr.getBufferOrFake(ModuleMapID).getBufferSize() == Offset)
474 Offset = 0;
475
476 // Infer framework module if possible.
477 if (HS.getModuleMap().canInferFrameworkModule(ModuleMap->getDir())) {
478 SmallString<128> InferredFrameworkPath = ModuleMap->getDir().getName();
479 llvm::sys::path::append(InferredFrameworkPath,
480 CI.getLangOpts().ModuleName + ".framework");
481 if (auto Dir =
482 CI.getFileManager().getOptionalDirectoryRef(InferredFrameworkPath))
483 (void)HS.getModuleMap().inferFrameworkModule(*Dir, IsSystem, nullptr);
484 }
485
486 return false;
487 }
488
prepareToBuildModule(CompilerInstance & CI,StringRef ModuleMapFilename)489 static 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(CI.getLangOpts().CurrentModule, 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(CI.getLangOpts(), CI.getTarget(), *M,
514 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(OriginalModuleMapName,
529 /*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 CI.getSourceManager().getMainFileID())) {
537 M->IsInferred = true;
538 CI.getPreprocessor().getHeaderSearchInfo().getModuleMap()
539 .setInferredModuleAllowedBy(M, *OriginalModuleMap);
540 }
541 }
542
543 // If we're being run from the command-line, the module build stack will not
544 // have been filled in yet, so complete it now in order to allow us to detect
545 // module cycles.
546 SourceManager &SourceMgr = CI.getSourceManager();
547 if (SourceMgr.getModuleBuildStack().empty())
548 SourceMgr.pushModuleBuildStack(CI.getLangOpts().CurrentModule,
549 FullSourceLoc(SourceLocation(), SourceMgr));
550 return M;
551 }
552
553 /// Compute the input buffer that should be used to build the specified module.
554 static std::unique_ptr<llvm::MemoryBuffer>
getInputBufferForModule(CompilerInstance & CI,Module * M)555 getInputBufferForModule(CompilerInstance &CI, Module *M) {
556 FileManager &FileMgr = CI.getFileManager();
557
558 // Collect the set of #includes we need to build the module.
559 SmallString<256> HeaderContents;
560 std::error_code Err = std::error_code();
561 if (std::optional<Module::Header> UmbrellaHeader =
562 M->getUmbrellaHeaderAsWritten())
563 addHeaderInclude(UmbrellaHeader->PathRelativeToRootModuleDirectory,
564 HeaderContents, CI.getLangOpts(), M->IsExternC);
565 Err = collectModuleHeaderIncludes(
566 CI.getLangOpts(), FileMgr, CI.getDiagnostics(),
567 CI.getPreprocessor().getHeaderSearchInfo().getModuleMap(), M,
568 HeaderContents);
569
570 if (Err) {
571 CI.getDiagnostics().Report(diag::err_module_cannot_create_includes)
572 << M->getFullModuleName() << Err.message();
573 return nullptr;
574 }
575
576 return llvm::MemoryBuffer::getMemBufferCopy(
577 HeaderContents, Module::getModuleInputBufferName());
578 }
579
BeginSourceFile(CompilerInstance & CI,const FrontendInputFile & RealInput)580 bool FrontendAction::BeginSourceFile(CompilerInstance &CI,
581 const FrontendInputFile &RealInput) {
582 FrontendInputFile Input(RealInput);
583 assert(!Instance && "Already processing a source file!");
584 assert(!Input.isEmpty() && "Unexpected empty filename!");
585 setCurrentInput(Input);
586 setCompilerInstance(&CI);
587
588 bool HasBegunSourceFile = false;
589 bool ReplayASTFile = Input.getKind().getFormat() == InputKind::Precompiled &&
590 usesPreprocessorOnly();
591
592 // If we fail, reset state since the client will not end up calling the
593 // matching EndSourceFile(). All paths that return true should release this.
594 auto FailureCleanup = llvm::make_scope_exit([&]() {
595 if (HasBegunSourceFile)
596 CI.getDiagnosticClient().EndSourceFile();
597 CI.setASTConsumer(nullptr);
598 CI.clearOutputFiles(/*EraseFiles=*/true);
599 CI.getLangOpts().setCompilingModule(LangOptions::CMK_None);
600 setCurrentInput(FrontendInputFile());
601 setCompilerInstance(nullptr);
602 });
603
604 if (!BeginInvocation(CI))
605 return false;
606
607 // If we're replaying the build of an AST file, import it and set up
608 // the initial state from its build.
609 if (ReplayASTFile) {
610 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(&CI.getDiagnostics());
611
612 // The AST unit populates its own diagnostics engine rather than ours.
613 IntrusiveRefCntPtr<DiagnosticsEngine> ASTDiags(
614 new DiagnosticsEngine(Diags->getDiagnosticIDs(),
615 &Diags->getDiagnosticOptions()));
616 ASTDiags->setClient(Diags->getClient(), /*OwnsClient*/false);
617
618 // FIXME: What if the input is a memory buffer?
619 StringRef InputFile = Input.getFile();
620
621 std::unique_ptr<ASTUnit> AST = ASTUnit::LoadFromASTFile(
622 std::string(InputFile), CI.getPCHContainerReader(),
623 ASTUnit::LoadPreprocessorOnly, ASTDiags, CI.getFileSystemOpts(),
624 /*HeaderSearchOptions=*/nullptr);
625 if (!AST)
626 return false;
627
628 // Options relating to how we treat the input (but not what we do with it)
629 // are inherited from the AST unit.
630 CI.getHeaderSearchOpts() = AST->getHeaderSearchOpts();
631 CI.getPreprocessorOpts() = AST->getPreprocessorOpts();
632 CI.getLangOpts() = AST->getLangOpts();
633
634 // Set the shared objects, these are reset when we finish processing the
635 // file, otherwise the CompilerInstance will happily destroy them.
636 CI.setFileManager(&AST->getFileManager());
637 CI.createSourceManager(CI.getFileManager());
638 CI.getSourceManager().initializeForReplay(AST->getSourceManager());
639
640 // Preload all the module files loaded transitively by the AST unit. Also
641 // load all module map files that were parsed as part of building the AST
642 // unit.
643 if (auto ASTReader = AST->getASTReader()) {
644 auto &MM = ASTReader->getModuleManager();
645 auto &PrimaryModule = MM.getPrimaryModule();
646
647 for (serialization::ModuleFile &MF : MM)
648 if (&MF != &PrimaryModule)
649 CI.getFrontendOpts().ModuleFiles.push_back(MF.FileName);
650
651 ASTReader->visitTopLevelModuleMaps(PrimaryModule, [&](FileEntryRef FE) {
652 CI.getFrontendOpts().ModuleMapFiles.push_back(
653 std::string(FE.getName()));
654 });
655 }
656
657 // Set up the input file for replay purposes.
658 auto Kind = AST->getInputKind();
659 if (Kind.getFormat() == InputKind::ModuleMap) {
660 Module *ASTModule =
661 AST->getPreprocessor().getHeaderSearchInfo().lookupModule(
662 AST->getLangOpts().CurrentModule, SourceLocation(),
663 /*AllowSearch*/ false);
664 assert(ASTModule && "module file does not define its own module");
665 Input = FrontendInputFile(ASTModule->PresumedModuleMapFile, Kind);
666 } else {
667 auto &OldSM = AST->getSourceManager();
668 FileID ID = OldSM.getMainFileID();
669 if (auto File = OldSM.getFileEntryRefForID(ID))
670 Input = FrontendInputFile(File->getName(), Kind);
671 else
672 Input = FrontendInputFile(OldSM.getBufferOrFake(ID), Kind);
673 }
674 setCurrentInput(Input, std::move(AST));
675 }
676
677 // AST files follow a very different path, since they share objects via the
678 // AST unit.
679 if (Input.getKind().getFormat() == InputKind::Precompiled) {
680 assert(!usesPreprocessorOnly() && "this case was handled above");
681 assert(hasASTFileSupport() &&
682 "This action does not have AST file support!");
683
684 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(&CI.getDiagnostics());
685
686 // FIXME: What if the input is a memory buffer?
687 StringRef InputFile = Input.getFile();
688
689 std::unique_ptr<ASTUnit> AST = ASTUnit::LoadFromASTFile(
690 std::string(InputFile), CI.getPCHContainerReader(),
691 ASTUnit::LoadEverything, Diags, CI.getFileSystemOpts(),
692 CI.getHeaderSearchOptsPtr());
693
694 if (!AST)
695 return false;
696
697 // Inform the diagnostic client we are processing a source file.
698 CI.getDiagnosticClient().BeginSourceFile(CI.getLangOpts(), nullptr);
699 HasBegunSourceFile = true;
700
701 // Set the shared objects, these are reset when we finish processing the
702 // file, otherwise the CompilerInstance will happily destroy them.
703 CI.setFileManager(&AST->getFileManager());
704 CI.setSourceManager(&AST->getSourceManager());
705 CI.setPreprocessor(AST->getPreprocessorPtr());
706 Preprocessor &PP = CI.getPreprocessor();
707 PP.getBuiltinInfo().initializeBuiltins(PP.getIdentifierTable(),
708 PP.getLangOpts());
709 CI.setASTContext(&AST->getASTContext());
710
711 setCurrentInput(Input, std::move(AST));
712
713 // Initialize the action.
714 if (!BeginSourceFileAction(CI))
715 return false;
716
717 // Create the AST consumer.
718 CI.setASTConsumer(CreateWrappedASTConsumer(CI, InputFile));
719 if (!CI.hasASTConsumer())
720 return false;
721
722 FailureCleanup.release();
723 return true;
724 }
725
726 // Set up the file and source managers, if needed.
727 if (!CI.hasFileManager()) {
728 if (!CI.createFileManager()) {
729 return false;
730 }
731 }
732 if (!CI.hasSourceManager()) {
733 CI.createSourceManager(CI.getFileManager());
734 if (CI.getDiagnosticOpts().getFormat() == DiagnosticOptions::SARIF) {
735 static_cast<SARIFDiagnosticPrinter *>(&CI.getDiagnosticClient())
736 ->setSarifWriter(
737 std::make_unique<SarifDocumentWriter>(CI.getSourceManager()));
738 }
739 }
740
741 // Set up embedding for any specified files. Do this before we load any
742 // source files, including the primary module map for the compilation.
743 for (const auto &F : CI.getFrontendOpts().ModulesEmbedFiles) {
744 if (auto FE = CI.getFileManager().getOptionalFileRef(F, /*openFile*/true))
745 CI.getSourceManager().setFileIsTransient(*FE);
746 else
747 CI.getDiagnostics().Report(diag::err_modules_embed_file_not_found) << F;
748 }
749 if (CI.getFrontendOpts().ModulesEmbedAllFiles)
750 CI.getSourceManager().setAllFilesAreTransient(true);
751
752 // IR files bypass the rest of initialization.
753 if (Input.getKind().getLanguage() == Language::LLVM_IR) {
754 assert(hasIRSupport() &&
755 "This action does not have IR file support!");
756
757 // Inform the diagnostic client we are processing a source file.
758 CI.getDiagnosticClient().BeginSourceFile(CI.getLangOpts(), nullptr);
759 HasBegunSourceFile = true;
760
761 // Initialize the action.
762 if (!BeginSourceFileAction(CI))
763 return false;
764
765 // Initialize the main file entry.
766 if (!CI.InitializeSourceManager(CurrentInput))
767 return false;
768
769 FailureCleanup.release();
770 return true;
771 }
772
773 // If the implicit PCH include is actually a directory, rather than
774 // a single file, search for a suitable PCH file in that directory.
775 if (!CI.getPreprocessorOpts().ImplicitPCHInclude.empty()) {
776 FileManager &FileMgr = CI.getFileManager();
777 PreprocessorOptions &PPOpts = CI.getPreprocessorOpts();
778 StringRef PCHInclude = PPOpts.ImplicitPCHInclude;
779 std::string SpecificModuleCachePath = CI.getSpecificModuleCachePath();
780 if (auto PCHDir = FileMgr.getOptionalDirectoryRef(PCHInclude)) {
781 std::error_code EC;
782 SmallString<128> DirNative;
783 llvm::sys::path::native(PCHDir->getName(), DirNative);
784 bool Found = false;
785 llvm::vfs::FileSystem &FS = FileMgr.getVirtualFileSystem();
786 for (llvm::vfs::directory_iterator Dir = FS.dir_begin(DirNative, EC),
787 DirEnd;
788 Dir != DirEnd && !EC; Dir.increment(EC)) {
789 // Check whether this is an acceptable AST file.
790 if (ASTReader::isAcceptableASTFile(
791 Dir->path(), FileMgr, CI.getModuleCache(),
792 CI.getPCHContainerReader(), CI.getLangOpts(),
793 CI.getTargetOpts(), CI.getPreprocessorOpts(),
794 SpecificModuleCachePath, /*RequireStrictOptionMatches=*/true)) {
795 PPOpts.ImplicitPCHInclude = std::string(Dir->path());
796 Found = true;
797 break;
798 }
799 }
800
801 if (!Found) {
802 CI.getDiagnostics().Report(diag::err_fe_no_pch_in_dir) << PCHInclude;
803 return false;
804 }
805 }
806 }
807
808 // Set up the preprocessor if needed. When parsing model files the
809 // preprocessor of the original source is reused.
810 if (!isModelParsingAction())
811 CI.createPreprocessor(getTranslationUnitKind());
812
813 // Inform the diagnostic client we are processing a source file.
814 CI.getDiagnosticClient().BeginSourceFile(CI.getLangOpts(),
815 &CI.getPreprocessor());
816 HasBegunSourceFile = true;
817
818 // Handle C++20 header units.
819 // Here, the user has the option to specify that the header name should be
820 // looked up in the pre-processor search paths (and the main filename as
821 // passed by the driver might therefore be incomplete until that look-up).
822 if (CI.getLangOpts().CPlusPlusModules && Input.getKind().isHeaderUnit() &&
823 !Input.getKind().isPreprocessed()) {
824 StringRef FileName = Input.getFile();
825 InputKind Kind = Input.getKind();
826 if (Kind.getHeaderUnitKind() != InputKind::HeaderUnit_Abs) {
827 assert(CI.hasPreprocessor() &&
828 "trying to build a header unit without a Pre-processor?");
829 HeaderSearch &HS = CI.getPreprocessor().getHeaderSearchInfo();
830 // Relative searches begin from CWD.
831 auto Dir = CI.getFileManager().getOptionalDirectoryRef(".");
832 SmallVector<std::pair<OptionalFileEntryRef, DirectoryEntryRef>, 1> CWD;
833 CWD.push_back({std::nullopt, *Dir});
834 OptionalFileEntryRef FE =
835 HS.LookupFile(FileName, SourceLocation(),
836 /*Angled*/ Input.getKind().getHeaderUnitKind() ==
837 InputKind::HeaderUnit_System,
838 nullptr, nullptr, CWD, nullptr, nullptr, nullptr,
839 nullptr, nullptr, nullptr);
840 if (!FE) {
841 CI.getDiagnostics().Report(diag::err_module_header_file_not_found)
842 << FileName;
843 return false;
844 }
845 // We now have the filename...
846 FileName = FE->getName();
847 // ... still a header unit, but now use the path as written.
848 Kind = Input.getKind().withHeaderUnit(InputKind::HeaderUnit_Abs);
849 Input = FrontendInputFile(FileName, Kind, Input.isSystem());
850 }
851 // Unless the user has overridden the name, the header unit module name is
852 // the pathname for the file.
853 if (CI.getLangOpts().ModuleName.empty())
854 CI.getLangOpts().ModuleName = std::string(FileName);
855 CI.getLangOpts().CurrentModule = CI.getLangOpts().ModuleName;
856 }
857
858 if (!CI.InitializeSourceManager(Input))
859 return false;
860
861 if (CI.getLangOpts().CPlusPlusModules && Input.getKind().isHeaderUnit() &&
862 Input.getKind().isPreprocessed() && !usesPreprocessorOnly()) {
863 // We have an input filename like foo.iih, but we want to find the right
864 // module name (and original file, to build the map entry).
865 // Check if the first line specifies the original source file name with a
866 // linemarker.
867 std::string PresumedInputFile = std::string(getCurrentFileOrBufferName());
868 ReadOriginalFileName(CI, PresumedInputFile);
869 // Unless the user overrides this, the module name is the name by which the
870 // original file was known.
871 if (CI.getLangOpts().ModuleName.empty())
872 CI.getLangOpts().ModuleName = std::string(PresumedInputFile);
873 CI.getLangOpts().CurrentModule = CI.getLangOpts().ModuleName;
874 }
875
876 // For module map files, we first parse the module map and synthesize a
877 // "<module-includes>" buffer before more conventional processing.
878 if (Input.getKind().getFormat() == InputKind::ModuleMap) {
879 CI.getLangOpts().setCompilingModule(LangOptions::CMK_ModuleMap);
880
881 std::string PresumedModuleMapFile;
882 unsigned OffsetToContents;
883 if (loadModuleMapForModuleBuild(CI, Input.isSystem(),
884 Input.isPreprocessed(),
885 PresumedModuleMapFile, OffsetToContents))
886 return false;
887
888 auto *CurrentModule = prepareToBuildModule(CI, Input.getFile());
889 if (!CurrentModule)
890 return false;
891
892 CurrentModule->PresumedModuleMapFile = PresumedModuleMapFile;
893
894 if (OffsetToContents)
895 // If the module contents are in the same file, skip to them.
896 CI.getPreprocessor().setSkipMainFilePreamble(OffsetToContents, true);
897 else {
898 // Otherwise, convert the module description to a suitable input buffer.
899 auto Buffer = getInputBufferForModule(CI, CurrentModule);
900 if (!Buffer)
901 return false;
902
903 // Reinitialize the main file entry to refer to the new input.
904 auto Kind = CurrentModule->IsSystem ? SrcMgr::C_System : SrcMgr::C_User;
905 auto &SourceMgr = CI.getSourceManager();
906 auto BufferID = SourceMgr.createFileID(std::move(Buffer), Kind);
907 assert(BufferID.isValid() && "couldn't create module buffer ID");
908 SourceMgr.setMainFileID(BufferID);
909 }
910 }
911
912 // Initialize the action.
913 if (!BeginSourceFileAction(CI))
914 return false;
915
916 // If we were asked to load any module map files, do so now.
917 for (const auto &Filename : CI.getFrontendOpts().ModuleMapFiles) {
918 if (auto File = CI.getFileManager().getOptionalFileRef(Filename))
919 CI.getPreprocessor().getHeaderSearchInfo().loadModuleMapFile(
920 *File, /*IsSystem*/false);
921 else
922 CI.getDiagnostics().Report(diag::err_module_map_not_found) << Filename;
923 }
924
925 // If compiling implementation of a module, load its module map file now.
926 (void)CI.getPreprocessor().getCurrentModuleImplementation();
927
928 // Add a module declaration scope so that modules from -fmodule-map-file
929 // arguments may shadow modules found implicitly in search paths.
930 CI.getPreprocessor()
931 .getHeaderSearchInfo()
932 .getModuleMap()
933 .finishModuleDeclarationScope();
934
935 // Create the AST context and consumer unless this is a preprocessor only
936 // action.
937 if (!usesPreprocessorOnly()) {
938 // Parsing a model file should reuse the existing ASTContext.
939 if (!isModelParsingAction())
940 CI.createASTContext();
941
942 // For preprocessed files, check if the first line specifies the original
943 // source file name with a linemarker.
944 std::string PresumedInputFile = std::string(getCurrentFileOrBufferName());
945 if (Input.isPreprocessed())
946 ReadOriginalFileName(CI, PresumedInputFile);
947
948 std::unique_ptr<ASTConsumer> Consumer =
949 CreateWrappedASTConsumer(CI, PresumedInputFile);
950 if (!Consumer)
951 return false;
952
953 // FIXME: should not overwrite ASTMutationListener when parsing model files?
954 if (!isModelParsingAction())
955 CI.getASTContext().setASTMutationListener(Consumer->GetASTMutationListener());
956
957 if (!CI.getPreprocessorOpts().ChainedIncludes.empty()) {
958 // Convert headers to PCH and chain them.
959 IntrusiveRefCntPtr<ExternalSemaSource> source, FinalReader;
960 source = createChainedIncludesSource(CI, FinalReader);
961 if (!source)
962 return false;
963 CI.setASTReader(static_cast<ASTReader *>(FinalReader.get()));
964 CI.getASTContext().setExternalSource(source);
965 } else if (CI.getLangOpts().Modules ||
966 !CI.getPreprocessorOpts().ImplicitPCHInclude.empty()) {
967 // Use PCM or PCH.
968 assert(hasPCHSupport() && "This action does not have PCH support!");
969 ASTDeserializationListener *DeserialListener =
970 Consumer->GetASTDeserializationListener();
971 bool DeleteDeserialListener = false;
972 if (CI.getPreprocessorOpts().DumpDeserializedPCHDecls) {
973 DeserialListener = new DeserializedDeclsDumper(DeserialListener,
974 DeleteDeserialListener);
975 DeleteDeserialListener = true;
976 }
977 if (!CI.getPreprocessorOpts().DeserializedPCHDeclsToErrorOn.empty()) {
978 DeserialListener = new DeserializedDeclsChecker(
979 CI.getASTContext(),
980 CI.getPreprocessorOpts().DeserializedPCHDeclsToErrorOn,
981 DeserialListener, DeleteDeserialListener);
982 DeleteDeserialListener = true;
983 }
984 if (!CI.getPreprocessorOpts().ImplicitPCHInclude.empty()) {
985 CI.createPCHExternalASTSource(
986 CI.getPreprocessorOpts().ImplicitPCHInclude,
987 CI.getPreprocessorOpts().DisablePCHOrModuleValidation,
988 CI.getPreprocessorOpts().AllowPCHWithCompilerErrors,
989 DeserialListener, DeleteDeserialListener);
990 if (!CI.getASTContext().getExternalSource())
991 return false;
992 }
993 // If modules are enabled, create the AST reader before creating
994 // any builtins, so that all declarations know that they might be
995 // extended by an external source.
996 if (CI.getLangOpts().Modules || !CI.hasASTContext() ||
997 !CI.getASTContext().getExternalSource()) {
998 CI.createASTReader();
999 CI.getASTReader()->setDeserializationListener(DeserialListener,
1000 DeleteDeserialListener);
1001 }
1002 }
1003
1004 CI.setASTConsumer(std::move(Consumer));
1005 if (!CI.hasASTConsumer())
1006 return false;
1007 }
1008
1009 // Initialize built-in info as long as we aren't using an external AST
1010 // source.
1011 if (CI.getLangOpts().Modules || !CI.hasASTContext() ||
1012 !CI.getASTContext().getExternalSource()) {
1013 Preprocessor &PP = CI.getPreprocessor();
1014 PP.getBuiltinInfo().initializeBuiltins(PP.getIdentifierTable(),
1015 PP.getLangOpts());
1016 } else {
1017 // FIXME: If this is a problem, recover from it by creating a multiplex
1018 // source.
1019 assert((!CI.getLangOpts().Modules || CI.getASTReader()) &&
1020 "modules enabled but created an external source that "
1021 "doesn't support modules");
1022 }
1023
1024 // If we were asked to load any module files, do so now.
1025 for (const auto &ModuleFile : CI.getFrontendOpts().ModuleFiles) {
1026 serialization::ModuleFile *Loaded = nullptr;
1027 if (!CI.loadModuleFile(ModuleFile, Loaded))
1028 return false;
1029
1030 if (Loaded && Loaded->StandardCXXModule)
1031 CI.getDiagnostics().Report(
1032 diag::warn_eagerly_load_for_standard_cplusplus_modules);
1033 }
1034
1035 // If there is a layout overrides file, attach an external AST source that
1036 // provides the layouts from that file.
1037 if (!CI.getFrontendOpts().OverrideRecordLayoutsFile.empty() &&
1038 CI.hasASTContext() && !CI.getASTContext().getExternalSource()) {
1039 IntrusiveRefCntPtr<ExternalASTSource>
1040 Override(new LayoutOverrideSource(
1041 CI.getFrontendOpts().OverrideRecordLayoutsFile));
1042 CI.getASTContext().setExternalSource(Override);
1043 }
1044
1045 // Setup HLSL External Sema Source
1046 if (CI.getLangOpts().HLSL && CI.hasASTContext()) {
1047 IntrusiveRefCntPtr<ExternalSemaSource> HLSLSema(
1048 new HLSLExternalSemaSource());
1049 if (auto *SemaSource = dyn_cast_if_present<ExternalSemaSource>(
1050 CI.getASTContext().getExternalSource())) {
1051 IntrusiveRefCntPtr<ExternalSemaSource> MultiSema(
1052 new MultiplexExternalSemaSource(SemaSource, HLSLSema.get()));
1053 CI.getASTContext().setExternalSource(MultiSema);
1054 } else
1055 CI.getASTContext().setExternalSource(HLSLSema);
1056 }
1057
1058 FailureCleanup.release();
1059 return true;
1060 }
1061
Execute()1062 llvm::Error FrontendAction::Execute() {
1063 CompilerInstance &CI = getCompilerInstance();
1064
1065 if (CI.hasFrontendTimer()) {
1066 llvm::TimeRegion Timer(CI.getFrontendTimer());
1067 ExecuteAction();
1068 }
1069 else ExecuteAction();
1070
1071 // If we are supposed to rebuild the global module index, do so now unless
1072 // there were any module-build failures.
1073 if (CI.shouldBuildGlobalModuleIndex() && CI.hasFileManager() &&
1074 CI.hasPreprocessor()) {
1075 StringRef Cache =
1076 CI.getPreprocessor().getHeaderSearchInfo().getModuleCachePath();
1077 if (!Cache.empty()) {
1078 if (llvm::Error Err = GlobalModuleIndex::writeIndex(
1079 CI.getFileManager(), CI.getPCHContainerReader(), Cache)) {
1080 // FIXME this drops the error on the floor, but
1081 // Index/pch-from-libclang.c seems to rely on dropping at least some of
1082 // the error conditions!
1083 consumeError(std::move(Err));
1084 }
1085 }
1086 }
1087
1088 return llvm::Error::success();
1089 }
1090
EndSourceFile()1091 void FrontendAction::EndSourceFile() {
1092 CompilerInstance &CI = getCompilerInstance();
1093
1094 // Inform the diagnostic client we are done with this source file.
1095 CI.getDiagnosticClient().EndSourceFile();
1096
1097 // Inform the preprocessor we are done.
1098 if (CI.hasPreprocessor())
1099 CI.getPreprocessor().EndSourceFile();
1100
1101 // Finalize the action.
1102 EndSourceFileAction();
1103
1104 // Sema references the ast consumer, so reset sema first.
1105 //
1106 // FIXME: There is more per-file stuff we could just drop here?
1107 bool DisableFree = CI.getFrontendOpts().DisableFree;
1108 if (DisableFree) {
1109 CI.resetAndLeakSema();
1110 CI.resetAndLeakASTContext();
1111 llvm::BuryPointer(CI.takeASTConsumer().get());
1112 } else {
1113 CI.setSema(nullptr);
1114 CI.setASTContext(nullptr);
1115 CI.setASTConsumer(nullptr);
1116 }
1117
1118 if (CI.getFrontendOpts().ShowStats) {
1119 llvm::errs() << "\nSTATISTICS FOR '" << getCurrentFileOrBufferName() << "':\n";
1120 CI.getPreprocessor().PrintStats();
1121 CI.getPreprocessor().getIdentifierTable().PrintStats();
1122 CI.getPreprocessor().getHeaderSearchInfo().PrintStats();
1123 CI.getSourceManager().PrintStats();
1124 llvm::errs() << "\n";
1125 }
1126
1127 // Cleanup the output streams, and erase the output files if instructed by the
1128 // FrontendAction.
1129 CI.clearOutputFiles(/*EraseFiles=*/shouldEraseOutputFiles());
1130
1131 // The resources are owned by AST when the current file is AST.
1132 // So we reset the resources here to avoid users accessing it
1133 // accidently.
1134 if (isCurrentFileAST()) {
1135 if (DisableFree) {
1136 CI.resetAndLeakPreprocessor();
1137 CI.resetAndLeakSourceManager();
1138 CI.resetAndLeakFileManager();
1139 llvm::BuryPointer(std::move(CurrentASTUnit));
1140 } else {
1141 CI.setPreprocessor(nullptr);
1142 CI.setSourceManager(nullptr);
1143 CI.setFileManager(nullptr);
1144 }
1145 }
1146
1147 setCompilerInstance(nullptr);
1148 setCurrentInput(FrontendInputFile());
1149 CI.getLangOpts().setCompilingModule(LangOptions::CMK_None);
1150 }
1151
shouldEraseOutputFiles()1152 bool FrontendAction::shouldEraseOutputFiles() {
1153 return getCompilerInstance().getDiagnostics().hasErrorOccurred();
1154 }
1155
1156 //===----------------------------------------------------------------------===//
1157 // Utility Actions
1158 //===----------------------------------------------------------------------===//
1159
ExecuteAction()1160 void ASTFrontendAction::ExecuteAction() {
1161 CompilerInstance &CI = getCompilerInstance();
1162 if (!CI.hasPreprocessor())
1163 return;
1164 // This is a fallback: If the client forgets to invoke this, we mark the
1165 // current stack as the bottom. Though not optimal, this could help prevent
1166 // stack overflow during deep recursion.
1167 clang::noteBottomOfStack();
1168
1169 // FIXME: Move the truncation aspect of this into Sema, we delayed this till
1170 // here so the source manager would be initialized.
1171 if (hasCodeCompletionSupport() &&
1172 !CI.getFrontendOpts().CodeCompletionAt.FileName.empty())
1173 CI.createCodeCompletionConsumer();
1174
1175 // Use a code completion consumer?
1176 CodeCompleteConsumer *CompletionConsumer = nullptr;
1177 if (CI.hasCodeCompletionConsumer())
1178 CompletionConsumer = &CI.getCodeCompletionConsumer();
1179
1180 if (!CI.hasSema())
1181 CI.createSema(getTranslationUnitKind(), CompletionConsumer);
1182
1183 ParseAST(CI.getSema(), CI.getFrontendOpts().ShowStats,
1184 CI.getFrontendOpts().SkipFunctionBodies);
1185 }
1186
anchor()1187 void PluginASTAction::anchor() { }
1188
1189 std::unique_ptr<ASTConsumer>
CreateASTConsumer(CompilerInstance & CI,StringRef InFile)1190 PreprocessorFrontendAction::CreateASTConsumer(CompilerInstance &CI,
1191 StringRef InFile) {
1192 llvm_unreachable("Invalid CreateASTConsumer on preprocessor action!");
1193 }
1194
PrepareToExecuteAction(CompilerInstance & CI)1195 bool WrapperFrontendAction::PrepareToExecuteAction(CompilerInstance &CI) {
1196 return WrappedAction->PrepareToExecuteAction(CI);
1197 }
1198 std::unique_ptr<ASTConsumer>
CreateASTConsumer(CompilerInstance & CI,StringRef InFile)1199 WrapperFrontendAction::CreateASTConsumer(CompilerInstance &CI,
1200 StringRef InFile) {
1201 return WrappedAction->CreateASTConsumer(CI, InFile);
1202 }
BeginInvocation(CompilerInstance & CI)1203 bool WrapperFrontendAction::BeginInvocation(CompilerInstance &CI) {
1204 return WrappedAction->BeginInvocation(CI);
1205 }
BeginSourceFileAction(CompilerInstance & CI)1206 bool WrapperFrontendAction::BeginSourceFileAction(CompilerInstance &CI) {
1207 WrappedAction->setCurrentInput(getCurrentInput());
1208 WrappedAction->setCompilerInstance(&CI);
1209 auto Ret = WrappedAction->BeginSourceFileAction(CI);
1210 // BeginSourceFileAction may change CurrentInput, e.g. during module builds.
1211 setCurrentInput(WrappedAction->getCurrentInput());
1212 return Ret;
1213 }
ExecuteAction()1214 void WrapperFrontendAction::ExecuteAction() {
1215 WrappedAction->ExecuteAction();
1216 }
EndSourceFile()1217 void WrapperFrontendAction::EndSourceFile() { WrappedAction->EndSourceFile(); }
EndSourceFileAction()1218 void WrapperFrontendAction::EndSourceFileAction() {
1219 WrappedAction->EndSourceFileAction();
1220 }
shouldEraseOutputFiles()1221 bool WrapperFrontendAction::shouldEraseOutputFiles() {
1222 return WrappedAction->shouldEraseOutputFiles();
1223 }
1224
usesPreprocessorOnly() const1225 bool WrapperFrontendAction::usesPreprocessorOnly() const {
1226 return WrappedAction->usesPreprocessorOnly();
1227 }
getTranslationUnitKind()1228 TranslationUnitKind WrapperFrontendAction::getTranslationUnitKind() {
1229 return WrappedAction->getTranslationUnitKind();
1230 }
hasPCHSupport() const1231 bool WrapperFrontendAction::hasPCHSupport() const {
1232 return WrappedAction->hasPCHSupport();
1233 }
hasASTFileSupport() const1234 bool WrapperFrontendAction::hasASTFileSupport() const {
1235 return WrappedAction->hasASTFileSupport();
1236 }
hasIRSupport() const1237 bool WrapperFrontendAction::hasIRSupport() const {
1238 return WrappedAction->hasIRSupport();
1239 }
hasCodeCompletionSupport() const1240 bool WrapperFrontendAction::hasCodeCompletionSupport() const {
1241 return WrappedAction->hasCodeCompletionSupport();
1242 }
1243
WrapperFrontendAction(std::unique_ptr<FrontendAction> WrappedAction)1244 WrapperFrontendAction::WrapperFrontendAction(
1245 std::unique_ptr<FrontendAction> WrappedAction)
1246 : WrappedAction(std::move(WrappedAction)) {}
1247