1 //===--- FrontendAction.cpp -----------------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "clang/Frontend/FrontendAction.h"
11 #include "clang/AST/ASTConsumer.h"
12 #include "clang/AST/ASTContext.h"
13 #include "clang/AST/DeclGroup.h"
14 #include "clang/Frontend/ASTUnit.h"
15 #include "clang/Frontend/CompilerInstance.h"
16 #include "clang/Frontend/FrontendDiagnostic.h"
17 #include "clang/Frontend/FrontendPluginRegistry.h"
18 #include "clang/Frontend/LayoutOverrideSource.h"
19 #include "clang/Frontend/MultiplexConsumer.h"
20 #include "clang/Frontend/Utils.h"
21 #include "clang/Lex/HeaderSearch.h"
22 #include "clang/Lex/Preprocessor.h"
23 #include "clang/Parse/ParseAST.h"
24 #include "clang/Serialization/ASTDeserializationListener.h"
25 #include "clang/Serialization/ASTReader.h"
26 #include "clang/Serialization/GlobalModuleIndex.h"
27 #include "llvm/Support/ErrorHandling.h"
28 #include "llvm/Support/FileSystem.h"
29 #include "llvm/Support/MemoryBuffer.h"
30 #include "llvm/Support/Timer.h"
31 #include "llvm/Support/raw_ostream.h"
32 #include <system_error>
33 using namespace clang;
35 template class llvm::Registry<clang::PluginASTAction>;
39 class DelegatingDeserializationListener : public ASTDeserializationListener {
40 ASTDeserializationListener *Previous;
44 explicit DelegatingDeserializationListener(
45 ASTDeserializationListener *Previous, bool DeletePrevious)
46 : Previous(Previous), DeletePrevious(DeletePrevious) {}
47 ~DelegatingDeserializationListener() override {
52 void ReaderInitialized(ASTReader *Reader) override {
54 Previous->ReaderInitialized(Reader);
56 void IdentifierRead(serialization::IdentID ID,
57 IdentifierInfo *II) override {
59 Previous->IdentifierRead(ID, II);
61 void TypeRead(serialization::TypeIdx Idx, QualType T) override {
63 Previous->TypeRead(Idx, T);
65 void DeclRead(serialization::DeclID ID, const Decl *D) override {
67 Previous->DeclRead(ID, D);
69 void SelectorRead(serialization::SelectorID ID, Selector Sel) override {
71 Previous->SelectorRead(ID, Sel);
73 void MacroDefinitionRead(serialization::PreprocessedEntityID PPID,
74 MacroDefinitionRecord *MD) override {
76 Previous->MacroDefinitionRead(PPID, MD);
80 /// \brief Dumps deserialized declarations.
81 class DeserializedDeclsDumper : public DelegatingDeserializationListener {
83 explicit DeserializedDeclsDumper(ASTDeserializationListener *Previous,
85 : DelegatingDeserializationListener(Previous, DeletePrevious) {}
87 void DeclRead(serialization::DeclID ID, const Decl *D) override {
88 llvm::outs() << "PCH DECL: " << D->getDeclKindName();
89 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D))
90 llvm::outs() << " - " << *ND;
93 DelegatingDeserializationListener::DeclRead(ID, D);
97 /// \brief Checks deserialized declarations and emits error if a name
98 /// matches one given in command-line using -error-on-deserialized-decl.
99 class DeserializedDeclsChecker : public DelegatingDeserializationListener {
101 std::set<std::string> NamesToCheck;
104 DeserializedDeclsChecker(ASTContext &Ctx,
105 const std::set<std::string> &NamesToCheck,
106 ASTDeserializationListener *Previous,
108 : DelegatingDeserializationListener(Previous, DeletePrevious), Ctx(Ctx),
109 NamesToCheck(NamesToCheck) {}
111 void DeclRead(serialization::DeclID ID, const Decl *D) override {
112 if (const NamedDecl *ND = dyn_cast<NamedDecl>(D))
113 if (NamesToCheck.find(ND->getNameAsString()) != NamesToCheck.end()) {
115 = Ctx.getDiagnostics().getCustomDiagID(DiagnosticsEngine::Error,
116 "%0 was deserialized");
117 Ctx.getDiagnostics().Report(Ctx.getFullLoc(D->getLocation()), DiagID)
118 << ND->getNameAsString();
121 DelegatingDeserializationListener::DeclRead(ID, D);
125 } // end anonymous namespace
127 FrontendAction::FrontendAction() : Instance(nullptr) {}
129 FrontendAction::~FrontendAction() {}
131 void FrontendAction::setCurrentInput(const FrontendInputFile &CurrentInput,
132 std::unique_ptr<ASTUnit> AST) {
133 this->CurrentInput = CurrentInput;
134 CurrentASTUnit = std::move(AST);
137 std::unique_ptr<ASTConsumer>
138 FrontendAction::CreateWrappedASTConsumer(CompilerInstance &CI,
140 std::unique_ptr<ASTConsumer> Consumer = CreateASTConsumer(CI, InFile);
144 if (CI.getFrontendOpts().AddPluginActions.size() == 0)
147 // Make sure the non-plugin consumer is first, so that plugins can't
149 std::vector<std::unique_ptr<ASTConsumer>> Consumers;
150 Consumers.push_back(std::move(Consumer));
152 for (size_t i = 0, e = CI.getFrontendOpts().AddPluginActions.size();
154 // This is O(|plugins| * |add_plugins|), but since both numbers are
155 // way below 50 in practice, that's ok.
156 for (FrontendPluginRegistry::iterator
157 it = FrontendPluginRegistry::begin(),
158 ie = FrontendPluginRegistry::end();
160 if (it->getName() != CI.getFrontendOpts().AddPluginActions[i])
162 std::unique_ptr<PluginASTAction> P = it->instantiate();
163 if (P->ParseArgs(CI, CI.getFrontendOpts().AddPluginArgs[i]))
164 Consumers.push_back(P->CreateASTConsumer(CI, InFile));
168 return llvm::make_unique<MultiplexConsumer>(std::move(Consumers));
171 bool FrontendAction::BeginSourceFile(CompilerInstance &CI,
172 const FrontendInputFile &Input) {
173 assert(!Instance && "Already processing a source file!");
174 assert(!Input.isEmpty() && "Unexpected empty filename!");
175 setCurrentInput(Input);
176 setCompilerInstance(&CI);
178 StringRef InputFile = Input.getFile();
179 bool HasBegunSourceFile = false;
180 if (!BeginInvocation(CI))
183 // AST files follow a very different path, since they share objects via the
185 if (Input.getKind() == IK_AST) {
186 assert(!usesPreprocessorOnly() &&
187 "Attempt to pass AST file to preprocessor only action!");
188 assert(hasASTFileSupport() &&
189 "This action does not have AST file support!");
191 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(&CI.getDiagnostics());
193 std::unique_ptr<ASTUnit> AST =
194 ASTUnit::LoadFromASTFile(InputFile, Diags, CI.getFileSystemOpts());
199 // Inform the diagnostic client we are processing a source file.
200 CI.getDiagnosticClient().BeginSourceFile(CI.getLangOpts(), nullptr);
201 HasBegunSourceFile = true;
203 // Set the shared objects, these are reset when we finish processing the
204 // file, otherwise the CompilerInstance will happily destroy them.
205 CI.setFileManager(&AST->getFileManager());
206 CI.setSourceManager(&AST->getSourceManager());
207 CI.setPreprocessor(&AST->getPreprocessor());
208 CI.setASTContext(&AST->getASTContext());
210 setCurrentInput(Input, std::move(AST));
212 // Initialize the action.
213 if (!BeginSourceFileAction(CI, InputFile))
216 // Create the AST consumer.
217 CI.setASTConsumer(CreateWrappedASTConsumer(CI, InputFile));
218 if (!CI.hasASTConsumer())
224 if (!CI.hasVirtualFileSystem()) {
225 if (IntrusiveRefCntPtr<vfs::FileSystem> VFS =
226 createVFSFromCompilerInvocation(CI.getInvocation(),
227 CI.getDiagnostics()))
228 CI.setVirtualFileSystem(VFS);
233 // Set up the file and source managers, if needed.
234 if (!CI.hasFileManager())
235 CI.createFileManager();
236 if (!CI.hasSourceManager())
237 CI.createSourceManager(CI.getFileManager());
239 // IR files bypass the rest of initialization.
240 if (Input.getKind() == IK_LLVM_IR) {
241 assert(hasIRSupport() &&
242 "This action does not have IR file support!");
244 // Inform the diagnostic client we are processing a source file.
245 CI.getDiagnosticClient().BeginSourceFile(CI.getLangOpts(), nullptr);
246 HasBegunSourceFile = true;
248 // Initialize the action.
249 if (!BeginSourceFileAction(CI, InputFile))
252 // Initialize the main file entry.
253 if (!CI.InitializeSourceManager(CurrentInput))
259 // If the implicit PCH include is actually a directory, rather than
260 // a single file, search for a suitable PCH file in that directory.
261 if (!CI.getPreprocessorOpts().ImplicitPCHInclude.empty()) {
262 FileManager &FileMgr = CI.getFileManager();
263 PreprocessorOptions &PPOpts = CI.getPreprocessorOpts();
264 StringRef PCHInclude = PPOpts.ImplicitPCHInclude;
265 std::string SpecificModuleCachePath = CI.getSpecificModuleCachePath();
266 if (const DirectoryEntry *PCHDir = FileMgr.getDirectory(PCHInclude)) {
268 SmallString<128> DirNative;
269 llvm::sys::path::native(PCHDir->getName(), DirNative);
271 for (llvm::sys::fs::directory_iterator Dir(DirNative, EC), DirEnd;
272 Dir != DirEnd && !EC; Dir.increment(EC)) {
273 // Check whether this is an acceptable AST file.
274 if (ASTReader::isAcceptableASTFile(Dir->path(), FileMgr,
277 CI.getPreprocessorOpts(),
278 SpecificModuleCachePath)) {
279 PPOpts.ImplicitPCHInclude = Dir->path();
286 CI.getDiagnostics().Report(diag::err_fe_no_pch_in_dir) << PCHInclude;
292 // Set up the preprocessor if needed. When parsing model files the
293 // preprocessor of the original source is reused.
294 if (!isModelParsingAction())
295 CI.createPreprocessor(getTranslationUnitKind());
297 // Inform the diagnostic client we are processing a source file.
298 CI.getDiagnosticClient().BeginSourceFile(CI.getLangOpts(),
299 &CI.getPreprocessor());
300 HasBegunSourceFile = true;
302 // Initialize the action.
303 if (!BeginSourceFileAction(CI, InputFile))
306 // Initialize the main file entry. It is important that this occurs after
307 // BeginSourceFileAction, which may change CurrentInput during module builds.
308 if (!CI.InitializeSourceManager(CurrentInput))
311 // Create the AST context and consumer unless this is a preprocessor only
313 if (!usesPreprocessorOnly()) {
314 // Parsing a model file should reuse the existing ASTContext.
315 if (!isModelParsingAction())
316 CI.createASTContext();
318 std::unique_ptr<ASTConsumer> Consumer =
319 CreateWrappedASTConsumer(CI, InputFile);
323 // FIXME: should not overwrite ASTMutationListener when parsing model files?
324 if (!isModelParsingAction())
325 CI.getASTContext().setASTMutationListener(Consumer->GetASTMutationListener());
327 if (!CI.getPreprocessorOpts().ChainedIncludes.empty()) {
328 // Convert headers to PCH and chain them.
329 IntrusiveRefCntPtr<ExternalSemaSource> source, FinalReader;
330 source = createChainedIncludesSource(CI, FinalReader);
333 CI.setModuleManager(static_cast<ASTReader *>(FinalReader.get()));
334 CI.getASTContext().setExternalSource(source);
335 } else if (!CI.getPreprocessorOpts().ImplicitPCHInclude.empty()) {
337 assert(hasPCHSupport() && "This action does not have PCH support!");
338 ASTDeserializationListener *DeserialListener =
339 Consumer->GetASTDeserializationListener();
340 bool DeleteDeserialListener = false;
341 if (CI.getPreprocessorOpts().DumpDeserializedPCHDecls) {
342 DeserialListener = new DeserializedDeclsDumper(DeserialListener,
343 DeleteDeserialListener);
344 DeleteDeserialListener = true;
346 if (!CI.getPreprocessorOpts().DeserializedPCHDeclsToErrorOn.empty()) {
347 DeserialListener = new DeserializedDeclsChecker(
349 CI.getPreprocessorOpts().DeserializedPCHDeclsToErrorOn,
350 DeserialListener, DeleteDeserialListener);
351 DeleteDeserialListener = true;
353 CI.createPCHExternalASTSource(
354 CI.getPreprocessorOpts().ImplicitPCHInclude,
355 CI.getPreprocessorOpts().DisablePCHValidation,
356 CI.getPreprocessorOpts().AllowPCHWithCompilerErrors, DeserialListener,
357 DeleteDeserialListener);
358 if (!CI.getASTContext().getExternalSource())
362 CI.setASTConsumer(std::move(Consumer));
363 if (!CI.hasASTConsumer())
367 // Initialize built-in info as long as we aren't using an external AST
369 if (!CI.hasASTContext() || !CI.getASTContext().getExternalSource()) {
370 Preprocessor &PP = CI.getPreprocessor();
372 // If modules are enabled, create the module manager before creating
373 // any builtins, so that all declarations know that they might be
374 // extended by an external source.
375 if (CI.getLangOpts().Modules)
376 CI.createModuleManager();
378 PP.getBuiltinInfo().InitializeBuiltins(PP.getIdentifierTable(),
381 // FIXME: If this is a problem, recover from it by creating a multiplex
383 assert((!CI.getLangOpts().Modules || CI.getModuleManager()) &&
384 "modules enabled but created an external source that "
385 "doesn't support modules");
388 // If we were asked to load any module map files, do so now.
389 for (const auto &Filename : CI.getFrontendOpts().ModuleMapFiles) {
390 if (auto *File = CI.getFileManager().getFile(Filename))
391 CI.getPreprocessor().getHeaderSearchInfo().loadModuleMapFile(
392 File, /*IsSystem*/false);
394 CI.getDiagnostics().Report(diag::err_module_map_not_found) << Filename;
397 // If we were asked to load any module files, do so now.
398 for (const auto &ModuleFile : CI.getFrontendOpts().ModuleFiles)
399 if (!CI.loadModuleFile(ModuleFile))
402 // If there is a layout overrides file, attach an external AST source that
403 // provides the layouts from that file.
404 if (!CI.getFrontendOpts().OverrideRecordLayoutsFile.empty() &&
405 CI.hasASTContext() && !CI.getASTContext().getExternalSource()) {
406 IntrusiveRefCntPtr<ExternalASTSource>
407 Override(new LayoutOverrideSource(
408 CI.getFrontendOpts().OverrideRecordLayoutsFile));
409 CI.getASTContext().setExternalSource(Override);
414 // If we failed, reset state since the client will not end up calling the
415 // matching EndSourceFile().
417 if (isCurrentFileAST()) {
418 CI.setASTContext(nullptr);
419 CI.setPreprocessor(nullptr);
420 CI.setSourceManager(nullptr);
421 CI.setFileManager(nullptr);
424 if (HasBegunSourceFile)
425 CI.getDiagnosticClient().EndSourceFile();
426 CI.clearOutputFiles(/*EraseFiles=*/true);
427 setCurrentInput(FrontendInputFile());
428 setCompilerInstance(nullptr);
432 bool FrontendAction::Execute() {
433 CompilerInstance &CI = getCompilerInstance();
435 if (CI.hasFrontendTimer()) {
436 llvm::TimeRegion Timer(CI.getFrontendTimer());
439 else ExecuteAction();
441 // If we are supposed to rebuild the global module index, do so now unless
442 // there were any module-build failures.
443 if (CI.shouldBuildGlobalModuleIndex() && CI.hasFileManager() &&
444 CI.hasPreprocessor()) {
445 GlobalModuleIndex::writeIndex(
447 CI.getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
453 void FrontendAction::EndSourceFile() {
454 CompilerInstance &CI = getCompilerInstance();
456 // Inform the diagnostic client we are done with this source file.
457 CI.getDiagnosticClient().EndSourceFile();
459 // Inform the preprocessor we are done.
460 if (CI.hasPreprocessor())
461 CI.getPreprocessor().EndSourceFile();
463 // Finalize the action.
464 EndSourceFileAction();
466 // Sema references the ast consumer, so reset sema first.
468 // FIXME: There is more per-file stuff we could just drop here?
469 bool DisableFree = CI.getFrontendOpts().DisableFree;
471 CI.resetAndLeakSema();
472 CI.resetAndLeakASTContext();
473 BuryPointer(CI.takeASTConsumer().get());
476 CI.setASTContext(nullptr);
477 CI.setASTConsumer(nullptr);
480 if (CI.getFrontendOpts().ShowStats) {
481 llvm::errs() << "\nSTATISTICS FOR '" << getCurrentFile() << "':\n";
482 CI.getPreprocessor().PrintStats();
483 CI.getPreprocessor().getIdentifierTable().PrintStats();
484 CI.getPreprocessor().getHeaderSearchInfo().PrintStats();
485 CI.getSourceManager().PrintStats();
486 llvm::errs() << "\n";
489 // Cleanup the output streams, and erase the output files if instructed by the
491 CI.clearOutputFiles(/*EraseFiles=*/shouldEraseOutputFiles());
493 if (isCurrentFileAST()) {
495 CI.resetAndLeakPreprocessor();
496 CI.resetAndLeakSourceManager();
497 CI.resetAndLeakFileManager();
499 CI.setPreprocessor(nullptr);
500 CI.setSourceManager(nullptr);
501 CI.setFileManager(nullptr);
505 setCompilerInstance(nullptr);
506 setCurrentInput(FrontendInputFile());
509 bool FrontendAction::shouldEraseOutputFiles() {
510 return getCompilerInstance().getDiagnostics().hasErrorOccurred();
513 //===----------------------------------------------------------------------===//
515 //===----------------------------------------------------------------------===//
517 void ASTFrontendAction::ExecuteAction() {
518 CompilerInstance &CI = getCompilerInstance();
519 if (!CI.hasPreprocessor())
522 // FIXME: Move the truncation aspect of this into Sema, we delayed this till
523 // here so the source manager would be initialized.
524 if (hasCodeCompletionSupport() &&
525 !CI.getFrontendOpts().CodeCompletionAt.FileName.empty())
526 CI.createCodeCompletionConsumer();
528 // Use a code completion consumer?
529 CodeCompleteConsumer *CompletionConsumer = nullptr;
530 if (CI.hasCodeCompletionConsumer())
531 CompletionConsumer = &CI.getCodeCompletionConsumer();
534 CI.createSema(getTranslationUnitKind(), CompletionConsumer);
536 ParseAST(CI.getSema(), CI.getFrontendOpts().ShowStats,
537 CI.getFrontendOpts().SkipFunctionBodies);
540 void PluginASTAction::anchor() { }
542 std::unique_ptr<ASTConsumer>
543 PreprocessorFrontendAction::CreateASTConsumer(CompilerInstance &CI,
545 llvm_unreachable("Invalid CreateASTConsumer on preprocessor action!");
548 std::unique_ptr<ASTConsumer>
549 WrapperFrontendAction::CreateASTConsumer(CompilerInstance &CI,
551 return WrappedAction->CreateASTConsumer(CI, InFile);
553 bool WrapperFrontendAction::BeginInvocation(CompilerInstance &CI) {
554 return WrappedAction->BeginInvocation(CI);
556 bool WrapperFrontendAction::BeginSourceFileAction(CompilerInstance &CI,
557 StringRef Filename) {
558 WrappedAction->setCurrentInput(getCurrentInput());
559 WrappedAction->setCompilerInstance(&CI);
560 return WrappedAction->BeginSourceFileAction(CI, Filename);
562 void WrapperFrontendAction::ExecuteAction() {
563 WrappedAction->ExecuteAction();
565 void WrapperFrontendAction::EndSourceFileAction() {
566 WrappedAction->EndSourceFileAction();
569 bool WrapperFrontendAction::usesPreprocessorOnly() const {
570 return WrappedAction->usesPreprocessorOnly();
572 TranslationUnitKind WrapperFrontendAction::getTranslationUnitKind() {
573 return WrappedAction->getTranslationUnitKind();
575 bool WrapperFrontendAction::hasPCHSupport() const {
576 return WrappedAction->hasPCHSupport();
578 bool WrapperFrontendAction::hasASTFileSupport() const {
579 return WrappedAction->hasASTFileSupport();
581 bool WrapperFrontendAction::hasIRSupport() const {
582 return WrappedAction->hasIRSupport();
584 bool WrapperFrontendAction::hasCodeCompletionSupport() const {
585 return WrappedAction->hasCodeCompletionSupport();
588 WrapperFrontendAction::WrapperFrontendAction(FrontendAction *WrappedAction)
589 : WrappedAction(WrappedAction) {}