1 //===--- ASTReader.h - AST File Reader --------------------------*- C++ -*-===//
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 // This file defines the ASTReader class, which reads AST files.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_SERIALIZATION_ASTREADER_H
15 #define LLVM_CLANG_SERIALIZATION_ASTREADER_H
17 #include "clang/AST/DeclObjC.h"
18 #include "clang/AST/DeclarationName.h"
19 #include "clang/AST/TemplateBase.h"
20 #include "clang/Basic/Diagnostic.h"
21 #include "clang/Basic/FileSystemOptions.h"
22 #include "clang/Basic/IdentifierTable.h"
23 #include "clang/Basic/Version.h"
24 #include "clang/Lex/ExternalPreprocessorSource.h"
25 #include "clang/Lex/HeaderSearch.h"
26 #include "clang/Lex/PreprocessingRecord.h"
27 #include "clang/Sema/ExternalSemaSource.h"
28 #include "clang/Sema/IdentifierResolver.h"
29 #include "clang/Serialization/ASTBitCodes.h"
30 #include "clang/Serialization/ContinuousRangeMap.h"
31 #include "clang/Serialization/Module.h"
32 #include "clang/Serialization/ModuleFileExtension.h"
33 #include "clang/Serialization/ModuleManager.h"
34 #include "llvm/ADT/MapVector.h"
35 #include "llvm/ADT/SmallPtrSet.h"
36 #include "llvm/ADT/SmallSet.h"
37 #include "llvm/ADT/SmallVector.h"
38 #include "llvm/ADT/StringMap.h"
39 #include "llvm/ADT/StringRef.h"
40 #include "llvm/ADT/TinyPtrVector.h"
41 #include "llvm/Support/DataTypes.h"
42 #include "llvm/Support/Timer.h"
50 class BitstreamCursor;
60 class HeaderSearchOptions;
65 class ASTIdentifierIterator;
66 class ASTUnit; // FIXME: Layering violation and egregious hack.
70 class DefMacroDirective;
71 class DiagnosticOptions;
72 class NestedNameSpecifier;
73 class CXXBaseSpecifier;
74 class CXXConstructorDecl;
75 class CXXCtorInitializer;
76 class GlobalModuleIndex;
78 class MacroDefinition;
82 class OpaqueValueExpr;
84 class PreprocessorOptions;
87 class ASTDeserializationListener;
92 class ASTRecordReader;
94 struct HeaderFileInfo;
97 class LazyASTUnresolvedSet;
99 /// \brief Abstract interface for callback invocations by the ASTReader.
101 /// While reading an AST file, the ASTReader will call the methods of the
102 /// listener to pass on specific information. Some of the listener methods can
103 /// return true to indicate to the ASTReader that the information (and
104 /// consequently the AST file) is invalid.
105 class ASTReaderListener {
107 virtual ~ASTReaderListener();
109 /// \brief Receives the full Clang version information.
111 /// \returns true to indicate that the version is invalid. Subclasses should
112 /// generally defer to this implementation.
113 virtual bool ReadFullVersionInformation(StringRef FullVersion) {
114 return FullVersion != getClangFullRepositoryVersion();
117 virtual void ReadModuleName(StringRef ModuleName) {}
118 virtual void ReadModuleMapFile(StringRef ModuleMapPath) {}
120 /// \brief Receives the language options.
122 /// \returns true to indicate the options are invalid or false otherwise.
123 virtual bool ReadLanguageOptions(const LangOptions &LangOpts,
125 bool AllowCompatibleDifferences) {
129 /// \brief Receives the target options.
131 /// \returns true to indicate the target options are invalid, or false
133 virtual bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
134 bool AllowCompatibleDifferences) {
138 /// \brief Receives the diagnostic options.
140 /// \returns true to indicate the diagnostic options are invalid, or false
143 ReadDiagnosticOptions(IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts,
148 /// \brief Receives the file system options.
150 /// \returns true to indicate the file system options are invalid, or false
152 virtual bool ReadFileSystemOptions(const FileSystemOptions &FSOpts,
157 /// \brief Receives the header search options.
159 /// \returns true to indicate the header search options are invalid, or false
161 virtual bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
162 StringRef SpecificModuleCachePath,
167 /// \brief Receives the preprocessor options.
169 /// \param SuggestedPredefines Can be filled in with the set of predefines
170 /// that are suggested by the preprocessor options. Typically only used when
171 /// loading a precompiled header.
173 /// \returns true to indicate the preprocessor options are invalid, or false
175 virtual bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
177 std::string &SuggestedPredefines) {
181 /// \brief Receives __COUNTER__ value.
182 virtual void ReadCounter(const serialization::ModuleFile &M,
185 /// This is called for each AST file loaded.
186 virtual void visitModuleFile(StringRef Filename,
187 serialization::ModuleKind Kind) {}
189 /// \brief Returns true if this \c ASTReaderListener wants to receive the
190 /// input files of the AST file via \c visitInputFile, false otherwise.
191 virtual bool needsInputFileVisitation() { return false; }
192 /// \brief Returns true if this \c ASTReaderListener wants to receive the
193 /// system input files of the AST file via \c visitInputFile, false otherwise.
194 virtual bool needsSystemInputFileVisitation() { return false; }
195 /// \brief if \c needsInputFileVisitation returns true, this is called for
196 /// each non-system input file of the AST File. If
197 /// \c needsSystemInputFileVisitation is true, then it is called for all
198 /// system input files as well.
200 /// \returns true to continue receiving the next input file, false to stop.
201 virtual bool visitInputFile(StringRef Filename, bool isSystem,
202 bool isOverridden, bool isExplicitModule) {
206 /// \brief Returns true if this \c ASTReaderListener wants to receive the
207 /// imports of the AST file via \c visitImport, false otherwise.
208 virtual bool needsImportVisitation() const { return false; }
209 /// \brief If needsImportVisitation returns \c true, this is called for each
210 /// AST file imported by this AST file.
211 virtual void visitImport(StringRef Filename) {}
213 /// Indicates that a particular module file extension has been read.
214 virtual void readModuleFileExtension(
215 const ModuleFileExtensionMetadata &Metadata) {}
218 /// \brief Simple wrapper class for chaining listeners.
219 class ChainedASTReaderListener : public ASTReaderListener {
220 std::unique_ptr<ASTReaderListener> First;
221 std::unique_ptr<ASTReaderListener> Second;
224 /// Takes ownership of \p First and \p Second.
225 ChainedASTReaderListener(std::unique_ptr<ASTReaderListener> First,
226 std::unique_ptr<ASTReaderListener> Second)
227 : First(std::move(First)), Second(std::move(Second)) {}
229 std::unique_ptr<ASTReaderListener> takeFirst() { return std::move(First); }
230 std::unique_ptr<ASTReaderListener> takeSecond() { return std::move(Second); }
232 bool ReadFullVersionInformation(StringRef FullVersion) override;
233 void ReadModuleName(StringRef ModuleName) override;
234 void ReadModuleMapFile(StringRef ModuleMapPath) override;
235 bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
236 bool AllowCompatibleDifferences) override;
237 bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
238 bool AllowCompatibleDifferences) override;
239 bool ReadDiagnosticOptions(IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts,
240 bool Complain) override;
241 bool ReadFileSystemOptions(const FileSystemOptions &FSOpts,
242 bool Complain) override;
244 bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
245 StringRef SpecificModuleCachePath,
246 bool Complain) override;
247 bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
249 std::string &SuggestedPredefines) override;
251 void ReadCounter(const serialization::ModuleFile &M, unsigned Value) override;
252 bool needsInputFileVisitation() override;
253 bool needsSystemInputFileVisitation() override;
254 void visitModuleFile(StringRef Filename,
255 serialization::ModuleKind Kind) override;
256 bool visitInputFile(StringRef Filename, bool isSystem,
257 bool isOverridden, bool isExplicitModule) override;
258 void readModuleFileExtension(
259 const ModuleFileExtensionMetadata &Metadata) override;
262 /// \brief ASTReaderListener implementation to validate the information of
263 /// the PCH file against an initialized Preprocessor.
264 class PCHValidator : public ASTReaderListener {
269 PCHValidator(Preprocessor &PP, ASTReader &Reader)
270 : PP(PP), Reader(Reader) {}
272 bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
273 bool AllowCompatibleDifferences) override;
274 bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
275 bool AllowCompatibleDifferences) override;
276 bool ReadDiagnosticOptions(IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts,
277 bool Complain) override;
278 bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts, bool Complain,
279 std::string &SuggestedPredefines) override;
280 bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
281 StringRef SpecificModuleCachePath,
282 bool Complain) override;
283 void ReadCounter(const serialization::ModuleFile &M, unsigned Value) override;
286 void Error(const char *Msg);
289 /// \brief ASTReaderListenter implementation to set SuggestedPredefines of
290 /// ASTReader which is required to use a pch file. This is the replacement
291 /// of PCHValidator or SimplePCHValidator when using a pch file without
293 class SimpleASTReaderListener : public ASTReaderListener {
297 SimpleASTReaderListener(Preprocessor &PP)
300 bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts, bool Complain,
301 std::string &SuggestedPredefines) override;
304 namespace serialization {
306 class ReadMethodPoolVisitor;
309 class ASTIdentifierLookupTrait;
310 /// \brief The on-disk hash table(s) used for DeclContext name lookup.
311 struct DeclContextLookupTable;
314 } // end namespace serialization
316 /// \brief Reads an AST files chain containing the contents of a translation
319 /// The ASTReader class reads bitstreams (produced by the ASTWriter
320 /// class) containing the serialized representation of a given
321 /// abstract syntax tree and its supporting data structures. An
322 /// instance of the ASTReader can be attached to an ASTContext object,
323 /// which will provide access to the contents of the AST files.
325 /// The AST reader provides lazy de-serialization of declarations, as
326 /// required when traversing the AST. Only those AST nodes that are
327 /// actually required will be de-serialized.
329 : public ExternalPreprocessorSource,
330 public ExternalPreprocessingRecordSource,
331 public ExternalHeaderFileInfoSource,
332 public ExternalSemaSource,
333 public IdentifierInfoLookup,
334 public ExternalSLocEntrySource
337 typedef SmallVector<uint64_t, 64> RecordData;
338 typedef SmallVectorImpl<uint64_t> RecordDataImpl;
340 /// \brief The result of reading the control block of an AST file, which
341 /// can fail for various reasons.
343 /// \brief The control block was read successfully. Aside from failures,
344 /// the AST file is safe to read into the current context.
346 /// \brief The AST file itself appears corrupted.
348 /// \brief The AST file was missing.
350 /// \brief The AST file is out-of-date relative to its input files,
351 /// and needs to be regenerated.
353 /// \brief The AST file was written by a different version of Clang.
355 /// \brief The AST file was writtten with a different language/target
357 ConfigurationMismatch,
358 /// \brief The AST file has errors.
362 /// \brief Types of AST files.
363 friend class PCHValidator;
364 friend class ASTDeclReader;
365 friend class ASTStmtReader;
366 friend class ASTIdentifierIterator;
367 friend class serialization::reader::ASTIdentifierLookupTrait;
368 friend class TypeLocReader;
369 friend class ASTRecordReader;
370 friend class ASTWriter;
371 friend class ASTUnit; // ASTUnit needs to remap source locations.
372 friend class serialization::ReadMethodPoolVisitor;
374 typedef serialization::ModuleFile ModuleFile;
375 typedef serialization::ModuleKind ModuleKind;
376 typedef serialization::ModuleManager ModuleManager;
378 typedef ModuleManager::ModuleIterator ModuleIterator;
379 typedef ModuleManager::ModuleConstIterator ModuleConstIterator;
380 typedef ModuleManager::ModuleReverseIterator ModuleReverseIterator;
383 /// \brief The receiver of some callbacks invoked by ASTReader.
384 std::unique_ptr<ASTReaderListener> Listener;
386 /// \brief The receiver of deserialization events.
387 ASTDeserializationListener *DeserializationListener = nullptr;
388 bool OwnsDeserializationListener = false;
390 SourceManager &SourceMgr;
391 FileManager &FileMgr;
392 const PCHContainerReader &PCHContainerRdr;
393 DiagnosticsEngine &Diags;
395 /// \brief The semantic analysis object that will be processing the
396 /// AST files and the translation unit that uses it.
397 Sema *SemaObj = nullptr;
399 /// \brief The preprocessor that will be loading the source file.
402 /// \brief The AST context into which we'll read the AST files.
405 /// \brief The AST consumer.
406 ASTConsumer *Consumer = nullptr;
408 /// \brief The module manager which manages modules and their dependencies
409 ModuleManager ModuleMgr;
411 /// \brief A dummy identifier resolver used to merge TU-scope declarations in
412 /// C, for the cases where we don't have a Sema object to provide a real
413 /// identifier resolver.
414 IdentifierResolver DummyIdResolver;
416 /// A mapping from extension block names to module file extensions.
417 llvm::StringMap<std::shared_ptr<ModuleFileExtension>> ModuleFileExtensions;
419 /// \brief A timer used to track the time spent deserializing.
420 std::unique_ptr<llvm::Timer> ReadTimer;
422 /// \brief The location where the module file will be considered as
423 /// imported from. For non-module AST types it should be invalid.
424 SourceLocation CurrentImportLoc;
426 /// \brief The global module index, if loaded.
427 std::unique_ptr<GlobalModuleIndex> GlobalIndex;
429 /// \brief A map of global bit offsets to the module that stores entities
430 /// at those bit offsets.
431 ContinuousRangeMap<uint64_t, ModuleFile*, 4> GlobalBitOffsetsMap;
433 /// \brief A map of negated SLocEntryIDs to the modules containing them.
434 ContinuousRangeMap<unsigned, ModuleFile*, 64> GlobalSLocEntryMap;
436 typedef ContinuousRangeMap<unsigned, ModuleFile*, 64> GlobalSLocOffsetMapType;
438 /// \brief A map of reversed (SourceManager::MaxLoadedOffset - SLocOffset)
439 /// SourceLocation offsets to the modules containing them.
440 GlobalSLocOffsetMapType GlobalSLocOffsetMap;
442 /// \brief Types that have already been loaded from the chain.
444 /// When the pointer at index I is non-NULL, the type with
445 /// ID = (I + 1) << FastQual::Width has already been loaded
446 std::vector<QualType> TypesLoaded;
448 typedef ContinuousRangeMap<serialization::TypeID, ModuleFile *, 4>
451 /// \brief Mapping from global type IDs to the module in which the
452 /// type resides along with the offset that should be added to the
453 /// global type ID to produce a local ID.
454 GlobalTypeMapType GlobalTypeMap;
456 /// \brief Declarations that have already been loaded from the chain.
458 /// When the pointer at index I is non-NULL, the declaration with ID
459 /// = I + 1 has already been loaded.
460 std::vector<Decl *> DeclsLoaded;
462 typedef ContinuousRangeMap<serialization::DeclID, ModuleFile *, 4>
465 /// \brief Mapping from global declaration IDs to the module in which the
466 /// declaration resides.
467 GlobalDeclMapType GlobalDeclMap;
469 typedef std::pair<ModuleFile *, uint64_t> FileOffset;
470 typedef SmallVector<FileOffset, 2> FileOffsetsTy;
471 typedef llvm::DenseMap<serialization::DeclID, FileOffsetsTy>
472 DeclUpdateOffsetsMap;
474 /// \brief Declarations that have modifications residing in a later file
476 DeclUpdateOffsetsMap DeclUpdateOffsets;
478 /// \brief Declaration updates for already-loaded declarations that we need
479 /// to apply once we finish processing an import.
480 llvm::SmallVector<std::pair<serialization::GlobalDeclID, Decl*>, 16>
481 PendingUpdateRecords;
483 enum class PendingFakeDefinitionKind { NotFake, Fake, FakeLoaded };
485 /// \brief The DefinitionData pointers that we faked up for class definitions
486 /// that we needed but hadn't loaded yet.
487 llvm::DenseMap<void *, PendingFakeDefinitionKind> PendingFakeDefinitionData;
489 /// \brief Exception specification updates that have been loaded but not yet
490 /// propagated across the relevant redeclaration chain. The map key is the
491 /// canonical declaration (used only for deduplication) and the value is a
492 /// declaration that has an exception specification.
493 llvm::SmallMapVector<Decl *, FunctionDecl *, 4> PendingExceptionSpecUpdates;
495 /// \brief Declarations that have been imported and have typedef names for
496 /// linkage purposes.
497 llvm::DenseMap<std::pair<DeclContext*, IdentifierInfo*>, NamedDecl*>
498 ImportedTypedefNamesForLinkage;
500 /// \brief Mergeable declaration contexts that have anonymous declarations
501 /// within them, and those anonymous declarations.
502 llvm::DenseMap<DeclContext*, llvm::SmallVector<NamedDecl*, 2>>
503 AnonymousDeclarationsForMerging;
505 struct FileDeclsInfo {
507 ArrayRef<serialization::LocalDeclID> Decls;
509 FileDeclsInfo() : Mod(nullptr) {}
510 FileDeclsInfo(ModuleFile *Mod, ArrayRef<serialization::LocalDeclID> Decls)
511 : Mod(Mod), Decls(Decls) {}
514 /// \brief Map from a FileID to the file-level declarations that it contains.
515 llvm::DenseMap<FileID, FileDeclsInfo> FileDeclIDs;
517 /// \brief An array of lexical contents of a declaration context, as a sequence of
518 /// Decl::Kind, DeclID pairs.
519 typedef ArrayRef<llvm::support::unaligned_uint32_t> LexicalContents;
521 /// \brief Map from a DeclContext to its lexical contents.
522 llvm::DenseMap<const DeclContext*, std::pair<ModuleFile*, LexicalContents>>
525 /// \brief Map from the TU to its lexical contents from each module file.
526 std::vector<std::pair<ModuleFile*, LexicalContents>> TULexicalDecls;
528 /// \brief Map from a DeclContext to its lookup tables.
529 llvm::DenseMap<const DeclContext *,
530 serialization::reader::DeclContextLookupTable> Lookups;
532 // Updates for visible decls can occur for other contexts than just the
533 // TU, and when we read those update records, the actual context may not
534 // be available yet, so have this pending map using the ID as a key. It
535 // will be realized when the context is actually loaded.
536 struct PendingVisibleUpdate {
538 const unsigned char *Data;
540 typedef SmallVector<PendingVisibleUpdate, 1> DeclContextVisibleUpdates;
542 /// \brief Updates to the visible declarations of declaration contexts that
543 /// haven't been loaded yet.
544 llvm::DenseMap<serialization::DeclID, DeclContextVisibleUpdates>
545 PendingVisibleUpdates;
547 /// \brief The set of C++ or Objective-C classes that have forward
548 /// declarations that have not yet been linked to their definitions.
549 llvm::SmallPtrSet<Decl *, 4> PendingDefinitions;
551 typedef llvm::MapVector<Decl *, uint64_t,
552 llvm::SmallDenseMap<Decl *, unsigned, 4>,
553 SmallVector<std::pair<Decl *, uint64_t>, 4> >
556 /// \brief Functions or methods that have bodies that will be attached.
557 PendingBodiesMap PendingBodies;
559 /// \brief Definitions for which we have added merged definitions but not yet
560 /// performed deduplication.
561 llvm::SetVector<NamedDecl*> PendingMergedDefinitionsToDeduplicate;
563 /// \brief Read the record that describes the lexical contents of a DC.
564 bool ReadLexicalDeclContextStorage(ModuleFile &M,
565 llvm::BitstreamCursor &Cursor,
566 uint64_t Offset, DeclContext *DC);
567 /// \brief Read the record that describes the visible contents of a DC.
568 bool ReadVisibleDeclContextStorage(ModuleFile &M,
569 llvm::BitstreamCursor &Cursor,
570 uint64_t Offset, serialization::DeclID ID);
572 /// \brief A vector containing identifiers that have already been
575 /// If the pointer at index I is non-NULL, then it refers to the
576 /// IdentifierInfo for the identifier with ID=I+1 that has already
578 std::vector<IdentifierInfo *> IdentifiersLoaded;
580 typedef ContinuousRangeMap<serialization::IdentID, ModuleFile *, 4>
581 GlobalIdentifierMapType;
583 /// \brief Mapping from global identifier IDs to the module in which the
584 /// identifier resides along with the offset that should be added to the
585 /// global identifier ID to produce a local ID.
586 GlobalIdentifierMapType GlobalIdentifierMap;
588 /// \brief A vector containing macros that have already been
591 /// If the pointer at index I is non-NULL, then it refers to the
592 /// MacroInfo for the identifier with ID=I+1 that has already
594 std::vector<MacroInfo *> MacrosLoaded;
596 typedef std::pair<IdentifierInfo *, serialization::SubmoduleID>
599 /// \brief A set of #undef directives that we have loaded; used to
600 /// deduplicate the same #undef information coming from multiple module
602 llvm::DenseSet<LoadedMacroInfo> LoadedUndefs;
604 typedef ContinuousRangeMap<serialization::MacroID, ModuleFile *, 4>
607 /// \brief Mapping from global macro IDs to the module in which the
608 /// macro resides along with the offset that should be added to the
609 /// global macro ID to produce a local ID.
610 GlobalMacroMapType GlobalMacroMap;
612 /// \brief A vector containing submodules that have already been loaded.
614 /// This vector is indexed by the Submodule ID (-1). NULL submodule entries
615 /// indicate that the particular submodule ID has not yet been loaded.
616 SmallVector<Module *, 2> SubmodulesLoaded;
618 typedef ContinuousRangeMap<serialization::SubmoduleID, ModuleFile *, 4>
619 GlobalSubmoduleMapType;
621 /// \brief Mapping from global submodule IDs to the module file in which the
622 /// submodule resides along with the offset that should be added to the
623 /// global submodule ID to produce a local ID.
624 GlobalSubmoduleMapType GlobalSubmoduleMap;
626 /// \brief A set of hidden declarations.
627 typedef SmallVector<Decl*, 2> HiddenNames;
628 typedef llvm::DenseMap<Module *, HiddenNames> HiddenNamesMapType;
630 /// \brief A mapping from each of the hidden submodules to the deserialized
631 /// declarations in that submodule that could be made visible.
632 HiddenNamesMapType HiddenNamesMap;
635 /// \brief A module import, export, or conflict that hasn't yet been resolved.
636 struct UnresolvedModuleRef {
637 /// \brief The file in which this module resides.
640 /// \brief The module that is importing or exporting.
643 /// \brief The kind of module reference.
644 enum { Import, Export, Conflict } Kind;
646 /// \brief The local ID of the module that is being exported.
649 /// \brief Whether this is a wildcard export.
650 unsigned IsWildcard : 1;
652 /// \brief String data.
656 /// \brief The set of module imports and exports that still need to be
658 SmallVector<UnresolvedModuleRef, 2> UnresolvedModuleRefs;
660 /// \brief A vector containing selectors that have already been loaded.
662 /// This vector is indexed by the Selector ID (-1). NULL selector
663 /// entries indicate that the particular selector ID has not yet
665 SmallVector<Selector, 16> SelectorsLoaded;
667 typedef ContinuousRangeMap<serialization::SelectorID, ModuleFile *, 4>
668 GlobalSelectorMapType;
670 /// \brief Mapping from global selector IDs to the module in which the
672 /// global selector ID to produce a local ID.
673 GlobalSelectorMapType GlobalSelectorMap;
675 /// \brief The generation number of the last time we loaded data from the
676 /// global method pool for this selector.
677 llvm::DenseMap<Selector, unsigned> SelectorGeneration;
679 /// Whether a selector is out of date. We mark a selector as out of date
680 /// if we load another module after the method pool entry was pulled in.
681 llvm::DenseMap<Selector, bool> SelectorOutOfDate;
683 struct PendingMacroInfo {
685 uint64_t MacroDirectivesOffset;
687 PendingMacroInfo(ModuleFile *M, uint64_t MacroDirectivesOffset)
688 : M(M), MacroDirectivesOffset(MacroDirectivesOffset) {}
691 typedef llvm::MapVector<IdentifierInfo *, SmallVector<PendingMacroInfo, 2> >
694 /// \brief Mapping from identifiers that have a macro history to the global
695 /// IDs have not yet been deserialized to the global IDs of those macros.
696 PendingMacroIDsMap PendingMacroIDs;
698 typedef ContinuousRangeMap<unsigned, ModuleFile *, 4>
699 GlobalPreprocessedEntityMapType;
701 /// \brief Mapping from global preprocessing entity IDs to the module in
702 /// which the preprocessed entity resides along with the offset that should be
703 /// added to the global preprocessing entitiy ID to produce a local ID.
704 GlobalPreprocessedEntityMapType GlobalPreprocessedEntityMap;
706 /// \name CodeGen-relevant special data
707 /// \brief Fields containing data that is relevant to CodeGen.
710 /// \brief The IDs of all declarations that fulfill the criteria of
711 /// "interesting" decls.
713 /// This contains the data loaded from all EAGERLY_DESERIALIZED_DECLS blocks
714 /// in the chain. The referenced declarations are deserialized and passed to
715 /// the consumer eagerly.
716 SmallVector<uint64_t, 16> EagerlyDeserializedDecls;
718 /// \brief The IDs of all tentative definitions stored in the chain.
720 /// Sema keeps track of all tentative definitions in a TU because it has to
721 /// complete them and pass them on to CodeGen. Thus, tentative definitions in
722 /// the PCH chain must be eagerly deserialized.
723 SmallVector<uint64_t, 16> TentativeDefinitions;
725 /// \brief The IDs of all CXXRecordDecls stored in the chain whose VTables are
728 /// CodeGen has to emit VTables for these records, so they have to be eagerly
730 SmallVector<uint64_t, 64> VTableUses;
732 /// \brief A snapshot of the pending instantiations in the chain.
734 /// This record tracks the instantiations that Sema has to perform at the
735 /// end of the TU. It consists of a pair of values for every pending
736 /// instantiation where the first value is the ID of the decl and the second
737 /// is the instantiation location.
738 SmallVector<uint64_t, 64> PendingInstantiations;
742 /// \name DiagnosticsEngine-relevant special data
743 /// \brief Fields containing data that is used for generating diagnostics
746 /// \brief A snapshot of Sema's unused file-scoped variable tracking, for
747 /// generating warnings.
748 SmallVector<uint64_t, 16> UnusedFileScopedDecls;
750 /// \brief A list of all the delegating constructors we've seen, to diagnose
752 SmallVector<uint64_t, 4> DelegatingCtorDecls;
754 /// \brief Method selectors used in a @selector expression. Used for
755 /// implementation of -Wselector.
756 SmallVector<uint64_t, 64> ReferencedSelectorsData;
758 /// \brief A snapshot of Sema's weak undeclared identifier tracking, for
759 /// generating warnings.
760 SmallVector<uint64_t, 64> WeakUndeclaredIdentifiers;
762 /// \brief The IDs of type aliases for ext_vectors that exist in the chain.
764 /// Used by Sema for finding sugared names for ext_vectors in diagnostics.
765 SmallVector<uint64_t, 4> ExtVectorDecls;
769 /// \name Sema-relevant special data
770 /// \brief Fields containing data that is used for semantic analysis
773 /// \brief The IDs of all potentially unused typedef names in the chain.
775 /// Sema tracks these to emit warnings.
776 SmallVector<uint64_t, 16> UnusedLocalTypedefNameCandidates;
778 /// \brief Our current depth in #pragma cuda force_host_device begin/end
780 unsigned ForceCUDAHostDeviceDepth = 0;
782 /// \brief The IDs of the declarations Sema stores directly.
784 /// Sema tracks a few important decls, such as namespace std, directly.
785 SmallVector<uint64_t, 4> SemaDeclRefs;
787 /// \brief The IDs of the types ASTContext stores directly.
789 /// The AST context tracks a few important types, such as va_list, directly.
790 SmallVector<uint64_t, 16> SpecialTypes;
792 /// \brief The IDs of CUDA-specific declarations ASTContext stores directly.
794 /// The AST context tracks a few important decls, currently cudaConfigureCall,
796 SmallVector<uint64_t, 2> CUDASpecialDeclRefs;
798 /// \brief The floating point pragma option settings.
799 SmallVector<uint64_t, 1> FPPragmaOptions;
801 /// \brief The pragma clang optimize location (if the pragma state is "off").
802 SourceLocation OptimizeOffPragmaLocation;
804 /// \brief The PragmaMSStructKind pragma ms_struct state if set, or -1.
805 int PragmaMSStructState = -1;
807 /// \brief The PragmaMSPointersToMembersKind pragma pointers_to_members state.
808 int PragmaMSPointersToMembersState = -1;
809 SourceLocation PointersToMembersPragmaLocation;
811 /// \brief The OpenCL extension settings.
812 OpenCLOptions OpenCLExtensions;
814 /// \brief Extensions required by an OpenCL type.
815 llvm::DenseMap<const Type *, std::set<std::string>> OpenCLTypeExtMap;
817 /// \brief Extensions required by an OpenCL declaration.
818 llvm::DenseMap<const Decl *, std::set<std::string>> OpenCLDeclExtMap;
820 /// \brief A list of the namespaces we've seen.
821 SmallVector<uint64_t, 4> KnownNamespaces;
823 /// \brief A list of undefined decls with internal linkage followed by the
824 /// SourceLocation of a matching ODR-use.
825 SmallVector<uint64_t, 8> UndefinedButUsed;
827 /// \brief Delete expressions to analyze at the end of translation unit.
828 SmallVector<uint64_t, 8> DelayedDeleteExprs;
830 // \brief A list of late parsed template function data.
831 SmallVector<uint64_t, 1> LateParsedTemplates;
834 struct ImportedSubmodule {
835 serialization::SubmoduleID ID;
836 SourceLocation ImportLoc;
838 ImportedSubmodule(serialization::SubmoduleID ID, SourceLocation ImportLoc)
839 : ID(ID), ImportLoc(ImportLoc) {}
843 /// \brief A list of modules that were imported by precompiled headers or
844 /// any other non-module AST file.
845 SmallVector<ImportedSubmodule, 2> ImportedModules;
848 /// \brief The directory that the PCH we are reading is stored in.
849 std::string CurrentDir;
851 /// \brief The system include root to be used when loading the
852 /// precompiled header.
853 std::string isysroot;
855 /// \brief Whether to disable the normal validation performed on precompiled
856 /// headers when they are loaded.
857 bool DisableValidation;
859 /// \brief Whether to accept an AST file with compiler errors.
860 bool AllowASTWithCompilerErrors;
862 /// \brief Whether to accept an AST file that has a different configuration
863 /// from the current compiler instance.
864 bool AllowConfigurationMismatch;
866 /// \brief Whether validate system input files.
867 bool ValidateSystemInputs;
869 /// \brief Whether we are allowed to use the global module index.
872 /// \brief Whether we have tried loading the global module index yet.
873 bool TriedLoadingGlobalIndex = false;
875 ///\brief Whether we are currently processing update records.
876 bool ProcessingUpdateRecords = false;
878 typedef llvm::DenseMap<unsigned, SwitchCase *> SwitchCaseMapTy;
879 /// \brief Mapping from switch-case IDs in the chain to switch-case statements
881 /// Statements usually don't have IDs, but switch cases need them, so that the
882 /// switch statement can refer to them.
883 SwitchCaseMapTy SwitchCaseStmts;
885 SwitchCaseMapTy *CurrSwitchCaseStmts;
887 /// \brief The number of source location entries de-serialized from
889 unsigned NumSLocEntriesRead = 0;
891 /// \brief The number of source location entries in the chain.
892 unsigned TotalNumSLocEntries = 0;
894 /// \brief The number of statements (and expressions) de-serialized
896 unsigned NumStatementsRead = 0;
898 /// \brief The total number of statements (and expressions) stored
900 unsigned TotalNumStatements = 0;
902 /// \brief The number of macros de-serialized from the chain.
903 unsigned NumMacrosRead = 0;
905 /// \brief The total number of macros stored in the chain.
906 unsigned TotalNumMacros = 0;
908 /// \brief The number of lookups into identifier tables.
909 unsigned NumIdentifierLookups = 0;
911 /// \brief The number of lookups into identifier tables that succeed.
912 unsigned NumIdentifierLookupHits = 0;
914 /// \brief The number of selectors that have been read.
915 unsigned NumSelectorsRead = 0;
917 /// \brief The number of method pool entries that have been read.
918 unsigned NumMethodPoolEntriesRead = 0;
920 /// \brief The number of times we have looked up a selector in the method
922 unsigned NumMethodPoolLookups = 0;
924 /// \brief The number of times we have looked up a selector in the method
925 /// pool and found something.
926 unsigned NumMethodPoolHits = 0;
928 /// \brief The number of times we have looked up a selector in the method
929 /// pool within a specific module.
930 unsigned NumMethodPoolTableLookups = 0;
932 /// \brief The number of times we have looked up a selector in the method
933 /// pool within a specific module and found something.
934 unsigned NumMethodPoolTableHits = 0;
936 /// \brief The total number of method pool entries in the selector table.
937 unsigned TotalNumMethodPoolEntries = 0;
939 /// Number of lexical decl contexts read/total.
940 unsigned NumLexicalDeclContextsRead = 0, TotalLexicalDeclContexts = 0;
942 /// Number of visible decl contexts read/total.
943 unsigned NumVisibleDeclContextsRead = 0, TotalVisibleDeclContexts = 0;
945 /// Total size of modules, in bits, currently loaded
946 uint64_t TotalModulesSizeInBits = 0;
948 /// \brief Number of Decl/types that are currently deserializing.
949 unsigned NumCurrentElementsDeserializing = 0;
951 /// \brief Set true while we are in the process of passing deserialized
952 /// "interesting" decls to consumer inside FinishedDeserializing().
953 /// This is used as a guard to avoid recursively repeating the process of
954 /// passing decls to consumer.
955 bool PassingDeclsToConsumer = false;
957 /// \brief The set of identifiers that were read while the AST reader was
958 /// (recursively) loading declarations.
960 /// The declarations on the identifier chain for these identifiers will be
961 /// loaded once the recursive loading has completed.
962 llvm::MapVector<IdentifierInfo *, SmallVector<uint32_t, 4> >
963 PendingIdentifierInfos;
965 /// \brief The set of lookup results that we have faked in order to support
966 /// merging of partially deserialized decls but that we have not yet removed.
967 llvm::SmallMapVector<IdentifierInfo *, SmallVector<NamedDecl*, 2>, 16>
968 PendingFakeLookupResults;
970 /// \brief The generation number of each identifier, which keeps track of
971 /// the last time we loaded information about this identifier.
972 llvm::DenseMap<IdentifierInfo *, unsigned> IdentifierGeneration;
974 /// \brief Contains declarations and definitions that will be
975 /// "interesting" to the ASTConsumer, when we get that AST consumer.
977 /// "Interesting" declarations are those that have data that may
978 /// need to be emitted, such as inline function definitions or
979 /// Objective-C protocols.
980 std::deque<Decl *> InterestingDecls;
982 /// \brief The list of redeclaration chains that still need to be
983 /// reconstructed, and the local offset to the corresponding list
984 /// of redeclarations.
985 SmallVector<std::pair<Decl *, uint64_t>, 16> PendingDeclChains;
987 /// \brief The list of canonical declarations whose redeclaration chains
988 /// need to be marked as incomplete once we're done deserializing things.
989 SmallVector<Decl *, 16> PendingIncompleteDeclChains;
991 /// \brief The Decl IDs for the Sema/Lexical DeclContext of a Decl that has
992 /// been loaded but its DeclContext was not set yet.
993 struct PendingDeclContextInfo {
995 serialization::GlobalDeclID SemaDC;
996 serialization::GlobalDeclID LexicalDC;
999 /// \brief The set of Decls that have been loaded but their DeclContexts are
1002 /// The DeclContexts for these Decls will be set once recursive loading has
1004 std::deque<PendingDeclContextInfo> PendingDeclContextInfos;
1006 /// \brief The set of NamedDecls that have been loaded, but are members of a
1007 /// context that has been merged into another context where the corresponding
1008 /// declaration is either missing or has not yet been loaded.
1010 /// We will check whether the corresponding declaration is in fact missing
1011 /// once recursing loading has been completed.
1012 llvm::SmallVector<NamedDecl *, 16> PendingOdrMergeChecks;
1014 /// \brief Record definitions in which we found an ODR violation.
1015 llvm::SmallDenseMap<CXXRecordDecl *, llvm::TinyPtrVector<CXXRecordDecl *>, 2>
1016 PendingOdrMergeFailures;
1018 /// \brief DeclContexts in which we have diagnosed an ODR violation.
1019 llvm::SmallPtrSet<DeclContext*, 2> DiagnosedOdrMergeFailures;
1021 /// \brief The set of Objective-C categories that have been deserialized
1022 /// since the last time the declaration chains were linked.
1023 llvm::SmallPtrSet<ObjCCategoryDecl *, 16> CategoriesDeserialized;
1025 /// \brief The set of Objective-C class definitions that have already been
1026 /// loaded, for which we will need to check for categories whenever a new
1027 /// module is loaded.
1028 SmallVector<ObjCInterfaceDecl *, 16> ObjCClassesLoaded;
1030 typedef llvm::DenseMap<Decl *, SmallVector<serialization::DeclID, 2> >
1033 /// \brief A mapping from canonical declarations to the set of global
1034 /// declaration IDs for key declaration that have been merged with that
1035 /// canonical declaration. A key declaration is a formerly-canonical
1036 /// declaration whose module did not import any other key declaration for that
1037 /// entity. These are the IDs that we use as keys when finding redecl chains.
1038 KeyDeclsMap KeyDecls;
1040 /// \brief A mapping from DeclContexts to the semantic DeclContext that we
1041 /// are treating as the definition of the entity. This is used, for instance,
1042 /// when merging implicit instantiations of class templates across modules.
1043 llvm::DenseMap<DeclContext *, DeclContext *> MergedDeclContexts;
1045 /// \brief A mapping from canonical declarations of enums to their canonical
1046 /// definitions. Only populated when using modules in C++.
1047 llvm::DenseMap<EnumDecl *, EnumDecl *> EnumDefinitions;
1049 /// \brief When reading a Stmt tree, Stmt operands are placed in this stack.
1050 SmallVector<Stmt *, 16> StmtStack;
1052 /// \brief What kind of records we are reading.
1054 Read_None, Read_Decl, Read_Type, Read_Stmt
1057 /// \brief What kind of records we are reading.
1058 ReadingKind ReadingKind = Read_None;
1060 /// \brief RAII object to change the reading kind.
1061 class ReadingKindTracker {
1063 enum ReadingKind PrevKind;
1065 ReadingKindTracker(const ReadingKindTracker &) = delete;
1066 void operator=(const ReadingKindTracker &) = delete;
1069 ReadingKindTracker(enum ReadingKind newKind, ASTReader &reader)
1070 : Reader(reader), PrevKind(Reader.ReadingKind) {
1071 Reader.ReadingKind = newKind;
1074 ~ReadingKindTracker() { Reader.ReadingKind = PrevKind; }
1077 /// \brief RAII object to mark the start of processing updates.
1078 class ProcessingUpdatesRAIIObj {
1082 ProcessingUpdatesRAIIObj(const ProcessingUpdatesRAIIObj &) = delete;
1083 void operator=(const ProcessingUpdatesRAIIObj &) = delete;
1086 ProcessingUpdatesRAIIObj(ASTReader &reader)
1087 : Reader(reader), PrevState(Reader.ProcessingUpdateRecords) {
1088 Reader.ProcessingUpdateRecords = true;
1091 ~ProcessingUpdatesRAIIObj() { Reader.ProcessingUpdateRecords = PrevState; }
1094 /// \brief Suggested contents of the predefines buffer, after this
1095 /// PCH file has been processed.
1097 /// In most cases, this string will be empty, because the predefines
1098 /// buffer computed to build the PCH file will be identical to the
1099 /// predefines buffer computed from the command line. However, when
1100 /// there are differences that the PCH reader can work around, this
1101 /// predefines buffer may contain additional definitions.
1102 std::string SuggestedPredefines;
1104 /// \brief Reads a statement from the specified cursor.
1105 Stmt *ReadStmtFromStream(ModuleFile &F);
1107 struct InputFileInfo {
1108 std::string Filename;
1115 /// \brief Reads the stored information about an input file.
1116 InputFileInfo readInputFileInfo(ModuleFile &F, unsigned ID);
1118 /// \brief Retrieve the file entry and 'overridden' bit for an input
1119 /// file in the given module file.
1120 serialization::InputFile getInputFile(ModuleFile &F, unsigned ID,
1121 bool Complain = true);
1124 void ResolveImportedPath(ModuleFile &M, std::string &Filename);
1125 static void ResolveImportedPath(std::string &Filename, StringRef Prefix);
1127 /// \brief Returns the first key declaration for the given declaration. This
1128 /// is one that is formerly-canonical (or still canonical) and whose module
1129 /// did not import any other key declaration of the entity.
1130 Decl *getKeyDeclaration(Decl *D) {
1131 D = D->getCanonicalDecl();
1132 if (D->isFromASTFile())
1135 auto I = KeyDecls.find(D);
1136 if (I == KeyDecls.end() || I->second.empty())
1138 return GetExistingDecl(I->second[0]);
1140 const Decl *getKeyDeclaration(const Decl *D) {
1141 return getKeyDeclaration(const_cast<Decl*>(D));
1144 /// \brief Run a callback on each imported key declaration of \p D.
1145 template <typename Fn>
1146 void forEachImportedKeyDecl(const Decl *D, Fn Visit) {
1147 D = D->getCanonicalDecl();
1148 if (D->isFromASTFile())
1151 auto It = KeyDecls.find(const_cast<Decl*>(D));
1152 if (It != KeyDecls.end())
1153 for (auto ID : It->second)
1154 Visit(GetExistingDecl(ID));
1157 /// \brief Get the loaded lookup tables for \p Primary, if any.
1158 const serialization::reader::DeclContextLookupTable *
1159 getLoadedLookupTables(DeclContext *Primary) const;
1162 struct ImportedModule {
1164 ModuleFile *ImportedBy;
1165 SourceLocation ImportLoc;
1167 ImportedModule(ModuleFile *Mod,
1168 ModuleFile *ImportedBy,
1169 SourceLocation ImportLoc)
1170 : Mod(Mod), ImportedBy(ImportedBy), ImportLoc(ImportLoc) { }
1173 ASTReadResult ReadASTCore(StringRef FileName, ModuleKind Type,
1174 SourceLocation ImportLoc, ModuleFile *ImportedBy,
1175 SmallVectorImpl<ImportedModule> &Loaded,
1176 off_t ExpectedSize, time_t ExpectedModTime,
1177 serialization::ASTFileSignature ExpectedSignature,
1178 unsigned ClientLoadCapabilities);
1179 ASTReadResult ReadControlBlock(ModuleFile &F,
1180 SmallVectorImpl<ImportedModule> &Loaded,
1181 const ModuleFile *ImportedBy,
1182 unsigned ClientLoadCapabilities);
1183 static ASTReadResult ReadOptionsBlock(
1184 llvm::BitstreamCursor &Stream, unsigned ClientLoadCapabilities,
1185 bool AllowCompatibleConfigurationMismatch, ASTReaderListener &Listener,
1186 std::string &SuggestedPredefines, bool ValidateDiagnosticOptions);
1187 ASTReadResult ReadASTBlock(ModuleFile &F, unsigned ClientLoadCapabilities);
1188 ASTReadResult ReadExtensionBlock(ModuleFile &F);
1189 bool ParseLineTable(ModuleFile &F, const RecordData &Record);
1190 bool ReadSourceManagerBlock(ModuleFile &F);
1191 llvm::BitstreamCursor &SLocCursorForID(int ID);
1192 SourceLocation getImportLocation(ModuleFile *F);
1193 ASTReadResult ReadModuleMapFileBlock(RecordData &Record, ModuleFile &F,
1194 const ModuleFile *ImportedBy,
1195 unsigned ClientLoadCapabilities);
1196 ASTReadResult ReadSubmoduleBlock(ModuleFile &F,
1197 unsigned ClientLoadCapabilities);
1198 static bool ParseLanguageOptions(const RecordData &Record, bool Complain,
1199 ASTReaderListener &Listener,
1200 bool AllowCompatibleDifferences);
1201 static bool ParseTargetOptions(const RecordData &Record, bool Complain,
1202 ASTReaderListener &Listener,
1203 bool AllowCompatibleDifferences);
1204 static bool ParseDiagnosticOptions(const RecordData &Record, bool Complain,
1205 ASTReaderListener &Listener);
1206 static bool ParseFileSystemOptions(const RecordData &Record, bool Complain,
1207 ASTReaderListener &Listener);
1208 static bool ParseHeaderSearchOptions(const RecordData &Record, bool Complain,
1209 ASTReaderListener &Listener);
1210 static bool ParsePreprocessorOptions(const RecordData &Record, bool Complain,
1211 ASTReaderListener &Listener,
1212 std::string &SuggestedPredefines);
1214 struct RecordLocation {
1215 RecordLocation(ModuleFile *M, uint64_t O)
1216 : F(M), Offset(O) {}
1221 QualType readTypeRecord(unsigned Index);
1222 void readExceptionSpec(ModuleFile &ModuleFile,
1223 SmallVectorImpl<QualType> &ExceptionStorage,
1224 FunctionProtoType::ExceptionSpecInfo &ESI,
1225 const RecordData &Record, unsigned &Index);
1226 RecordLocation TypeCursorForIndex(unsigned Index);
1227 void LoadedDecl(unsigned Index, Decl *D);
1228 Decl *ReadDeclRecord(serialization::DeclID ID);
1229 void markIncompleteDeclChain(Decl *Canon);
1231 /// \brief Returns the most recent declaration of a declaration (which must be
1232 /// of a redeclarable kind) that is either local or has already been loaded
1233 /// merged into its redecl chain.
1234 Decl *getMostRecentExistingDecl(Decl *D);
1236 RecordLocation DeclCursorForID(serialization::DeclID ID,
1237 SourceLocation &Location);
1238 void loadDeclUpdateRecords(serialization::DeclID ID, Decl *D);
1239 void loadPendingDeclChain(Decl *D, uint64_t LocalOffset);
1240 void loadObjCCategories(serialization::GlobalDeclID ID, ObjCInterfaceDecl *D,
1241 unsigned PreviousGeneration = 0);
1243 RecordLocation getLocalBitOffset(uint64_t GlobalOffset);
1244 uint64_t getGlobalBitOffset(ModuleFile &M, uint32_t LocalOffset);
1246 /// \brief Returns the first preprocessed entity ID that begins or ends after
1248 serialization::PreprocessedEntityID
1249 findPreprocessedEntity(SourceLocation Loc, bool EndsAfter) const;
1251 /// \brief Find the next module that contains entities and return the ID
1252 /// of the first entry.
1254 /// \param SLocMapI points at a chunk of a module that contains no
1255 /// preprocessed entities or the entities it contains are not the
1256 /// ones we are looking for.
1257 serialization::PreprocessedEntityID
1258 findNextPreprocessedEntity(
1259 GlobalSLocOffsetMapType::const_iterator SLocMapI) const;
1261 /// \brief Returns (ModuleFile, Local index) pair for \p GlobalIndex of a
1262 /// preprocessed entity.
1263 std::pair<ModuleFile *, unsigned>
1264 getModulePreprocessedEntity(unsigned GlobalIndex);
1266 /// \brief Returns (begin, end) pair for the preprocessed entities of a
1267 /// particular module.
1268 llvm::iterator_range<PreprocessingRecord::iterator>
1269 getModulePreprocessedEntities(ModuleFile &Mod) const;
1271 class ModuleDeclIterator
1272 : public llvm::iterator_adaptor_base<
1273 ModuleDeclIterator, const serialization::LocalDeclID *,
1274 std::random_access_iterator_tag, const Decl *, ptrdiff_t,
1275 const Decl *, const Decl *> {
1280 ModuleDeclIterator()
1281 : iterator_adaptor_base(nullptr), Reader(nullptr), Mod(nullptr) {}
1283 ModuleDeclIterator(ASTReader *Reader, ModuleFile *Mod,
1284 const serialization::LocalDeclID *Pos)
1285 : iterator_adaptor_base(Pos), Reader(Reader), Mod(Mod) {}
1287 value_type operator*() const {
1288 return Reader->GetDecl(Reader->getGlobalDeclID(*Mod, *I));
1290 value_type operator->() const { return **this; }
1292 bool operator==(const ModuleDeclIterator &RHS) const {
1293 assert(Reader == RHS.Reader && Mod == RHS.Mod);
1298 llvm::iterator_range<ModuleDeclIterator>
1299 getModuleFileLevelDecls(ModuleFile &Mod);
1301 void PassInterestingDeclsToConsumer();
1302 void PassInterestingDeclToConsumer(Decl *D);
1304 void finishPendingActions();
1305 void diagnoseOdrViolations();
1307 void pushExternalDeclIntoScope(NamedDecl *D, DeclarationName Name);
1309 void addPendingDeclContextInfo(Decl *D,
1310 serialization::GlobalDeclID SemaDC,
1311 serialization::GlobalDeclID LexicalDC) {
1313 PendingDeclContextInfo Info = { D, SemaDC, LexicalDC };
1314 PendingDeclContextInfos.push_back(Info);
1317 /// \brief Produce an error diagnostic and return true.
1319 /// This routine should only be used for fatal errors that have to
1320 /// do with non-routine failures (e.g., corrupted AST file).
1321 void Error(StringRef Msg);
1322 void Error(unsigned DiagID, StringRef Arg1 = StringRef(),
1323 StringRef Arg2 = StringRef());
1325 ASTReader(const ASTReader &) = delete;
1326 void operator=(const ASTReader &) = delete;
1328 /// \brief Load the AST file and validate its contents against the given
1331 /// \param PP the preprocessor associated with the context in which this
1332 /// precompiled header will be loaded.
1334 /// \param Context the AST context that this precompiled header will be
1337 /// \param PCHContainerRdr the PCHContainerOperations to use for loading and
1338 /// creating modules.
1340 /// \param Extensions the list of module file extensions that can be loaded
1341 /// from the AST files.
1343 /// \param isysroot If non-NULL, the system include path specified by the
1344 /// user. This is only used with relocatable PCH files. If non-NULL,
1345 /// a relocatable PCH file will use the default path "/".
1347 /// \param DisableValidation If true, the AST reader will suppress most
1348 /// of its regular consistency checking, allowing the use of precompiled
1349 /// headers that cannot be determined to be compatible.
1351 /// \param AllowASTWithCompilerErrors If true, the AST reader will accept an
1352 /// AST file the was created out of an AST with compiler errors,
1353 /// otherwise it will reject it.
1355 /// \param AllowConfigurationMismatch If true, the AST reader will not check
1356 /// for configuration differences between the AST file and the invocation.
1358 /// \param ValidateSystemInputs If true, the AST reader will validate
1359 /// system input files in addition to user input files. This is only
1360 /// meaningful if \p DisableValidation is false.
1362 /// \param UseGlobalIndex If true, the AST reader will try to load and use
1363 /// the global module index.
1365 /// \param ReadTimer If non-null, a timer used to track the time spent
1367 ASTReader(Preprocessor &PP, ASTContext &Context,
1368 const PCHContainerReader &PCHContainerRdr,
1369 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
1370 StringRef isysroot = "", bool DisableValidation = false,
1371 bool AllowASTWithCompilerErrors = false,
1372 bool AllowConfigurationMismatch = false,
1373 bool ValidateSystemInputs = false, bool UseGlobalIndex = true,
1374 std::unique_ptr<llvm::Timer> ReadTimer = {});
1376 ~ASTReader() override;
1378 SourceManager &getSourceManager() const { return SourceMgr; }
1379 FileManager &getFileManager() const { return FileMgr; }
1380 DiagnosticsEngine &getDiags() const { return Diags; }
1382 /// \brief Flags that indicate what kind of AST loading failures the client
1383 /// of the AST reader can directly handle.
1385 /// When a client states that it can handle a particular kind of failure,
1386 /// the AST reader will not emit errors when producing that kind of failure.
1387 enum LoadFailureCapabilities {
1388 /// \brief The client can't handle any AST loading failures.
1390 /// \brief The client can handle an AST file that cannot load because it
1393 /// \brief The client can handle an AST file that cannot load because it
1394 /// is out-of-date relative to its input files.
1395 ARR_OutOfDate = 0x2,
1396 /// \brief The client can handle an AST file that cannot load because it
1397 /// was built with a different version of Clang.
1398 ARR_VersionMismatch = 0x4,
1399 /// \brief The client can handle an AST file that cannot load because it's
1400 /// compiled configuration doesn't match that of the context it was
1402 ARR_ConfigurationMismatch = 0x8
1405 /// \brief Load the AST file designated by the given file name.
1407 /// \param FileName The name of the AST file to load.
1409 /// \param Type The kind of AST being loaded, e.g., PCH, module, main file,
1412 /// \param ImportLoc the location where the module file will be considered as
1413 /// imported from. For non-module AST types it should be invalid.
1415 /// \param ClientLoadCapabilities The set of client load-failure
1416 /// capabilities, represented as a bitset of the enumerators of
1417 /// LoadFailureCapabilities.
1419 /// \param Imported optional out-parameter to append the list of modules
1420 /// that were imported by precompiled headers or any other non-module AST file
1421 ASTReadResult ReadAST(StringRef FileName, ModuleKind Type,
1422 SourceLocation ImportLoc,
1423 unsigned ClientLoadCapabilities,
1424 SmallVectorImpl<ImportedSubmodule> *Imported = nullptr);
1426 /// \brief Make the entities in the given module and any of its (non-explicit)
1427 /// submodules visible to name lookup.
1429 /// \param Mod The module whose names should be made visible.
1431 /// \param NameVisibility The level of visibility to give the names in the
1432 /// module. Visibility can only be increased over time.
1434 /// \param ImportLoc The location at which the import occurs.
1435 void makeModuleVisible(Module *Mod,
1436 Module::NameVisibilityKind NameVisibility,
1437 SourceLocation ImportLoc);
1439 /// \brief Make the names within this set of hidden names visible.
1440 void makeNamesVisible(const HiddenNames &Names, Module *Owner);
1442 /// \brief Note that MergedDef is a redefinition of the canonical definition
1443 /// Def, so Def should be visible whenever MergedDef is.
1444 void mergeDefinitionVisibility(NamedDecl *Def, NamedDecl *MergedDef);
1446 /// \brief Take the AST callbacks listener.
1447 std::unique_ptr<ASTReaderListener> takeListener() {
1448 return std::move(Listener);
1451 /// \brief Set the AST callbacks listener.
1452 void setListener(std::unique_ptr<ASTReaderListener> Listener) {
1453 this->Listener = std::move(Listener);
1456 /// \brief Add an AST callback listener.
1458 /// Takes ownership of \p L.
1459 void addListener(std::unique_ptr<ASTReaderListener> L) {
1461 L = llvm::make_unique<ChainedASTReaderListener>(std::move(L),
1462 std::move(Listener));
1463 Listener = std::move(L);
1466 /// RAII object to temporarily add an AST callback listener.
1467 class ListenerScope {
1472 ListenerScope(ASTReader &Reader, std::unique_ptr<ASTReaderListener> L)
1473 : Reader(Reader), Chained(false) {
1474 auto Old = Reader.takeListener();
1477 L = llvm::make_unique<ChainedASTReaderListener>(std::move(L),
1480 Reader.setListener(std::move(L));
1483 auto New = Reader.takeListener();
1485 Reader.setListener(static_cast<ChainedASTReaderListener *>(New.get())
1490 /// \brief Set the AST deserialization listener.
1491 void setDeserializationListener(ASTDeserializationListener *Listener,
1492 bool TakeOwnership = false);
1494 /// \brief Determine whether this AST reader has a global index.
1495 bool hasGlobalIndex() const { return (bool)GlobalIndex; }
1497 /// \brief Return global module index.
1498 GlobalModuleIndex *getGlobalIndex() { return GlobalIndex.get(); }
1500 /// \brief Reset reader for a reload try.
1501 void resetForReload() { TriedLoadingGlobalIndex = false; }
1503 /// \brief Attempts to load the global index.
1505 /// \returns true if loading the global index has failed for any reason.
1506 bool loadGlobalIndex();
1508 /// \brief Determine whether we tried to load the global index, but failed,
1509 /// e.g., because it is out-of-date or does not exist.
1510 bool isGlobalIndexUnavailable() const;
1512 /// \brief Initializes the ASTContext
1513 void InitializeContext();
1515 /// \brief Update the state of Sema after loading some additional modules.
1518 /// \brief Add in-memory (virtual file) buffer.
1519 void addInMemoryBuffer(StringRef &FileName,
1520 std::unique_ptr<llvm::MemoryBuffer> Buffer) {
1521 ModuleMgr.addInMemoryBuffer(FileName, std::move(Buffer));
1524 /// \brief Finalizes the AST reader's state before writing an AST file to
1527 /// This operation may undo temporary state in the AST that should not be
1529 void finalizeForWriting();
1531 /// \brief Retrieve the module manager.
1532 ModuleManager &getModuleManager() { return ModuleMgr; }
1534 /// \brief Retrieve the preprocessor.
1535 Preprocessor &getPreprocessor() const { return PP; }
1537 /// \brief Retrieve the name of the original source file name for the primary
1539 StringRef getOriginalSourceFile() {
1540 return ModuleMgr.getPrimaryModule().OriginalSourceFileName;
1543 /// \brief Retrieve the name of the original source file name directly from
1544 /// the AST file, without actually loading the AST file.
1546 getOriginalSourceFile(const std::string &ASTFileName, FileManager &FileMgr,
1547 const PCHContainerReader &PCHContainerRdr,
1548 DiagnosticsEngine &Diags);
1550 /// \brief Read the control block for the named AST file.
1552 /// \returns true if an error occurred, false otherwise.
1554 readASTFileControlBlock(StringRef Filename, FileManager &FileMgr,
1555 const PCHContainerReader &PCHContainerRdr,
1556 bool FindModuleFileExtensions,
1557 ASTReaderListener &Listener,
1558 bool ValidateDiagnosticOptions);
1560 /// \brief Determine whether the given AST file is acceptable to load into a
1561 /// translation unit with the given language and target options.
1562 static bool isAcceptableASTFile(StringRef Filename, FileManager &FileMgr,
1563 const PCHContainerReader &PCHContainerRdr,
1564 const LangOptions &LangOpts,
1565 const TargetOptions &TargetOpts,
1566 const PreprocessorOptions &PPOpts,
1567 std::string ExistingModuleCachePath);
1569 /// \brief Returns the suggested contents of the predefines buffer,
1570 /// which contains a (typically-empty) subset of the predefines
1571 /// build prior to including the precompiled header.
1572 const std::string &getSuggestedPredefines() { return SuggestedPredefines; }
1574 /// \brief Read a preallocated preprocessed entity from the external source.
1576 /// \returns null if an error occurred that prevented the preprocessed
1577 /// entity from being loaded.
1578 PreprocessedEntity *ReadPreprocessedEntity(unsigned Index) override;
1580 /// \brief Returns a pair of [Begin, End) indices of preallocated
1581 /// preprocessed entities that \p Range encompasses.
1582 std::pair<unsigned, unsigned>
1583 findPreprocessedEntitiesInRange(SourceRange Range) override;
1585 /// \brief Optionally returns true or false if the preallocated preprocessed
1586 /// entity with index \p Index came from file \p FID.
1587 Optional<bool> isPreprocessedEntityInFileID(unsigned Index,
1588 FileID FID) override;
1590 /// \brief Read the header file information for the given file entry.
1591 HeaderFileInfo GetHeaderFileInfo(const FileEntry *FE) override;
1593 void ReadPragmaDiagnosticMappings(DiagnosticsEngine &Diag);
1595 /// \brief Returns the number of source locations found in the chain.
1596 unsigned getTotalNumSLocs() const {
1597 return TotalNumSLocEntries;
1600 /// \brief Returns the number of identifiers found in the chain.
1601 unsigned getTotalNumIdentifiers() const {
1602 return static_cast<unsigned>(IdentifiersLoaded.size());
1605 /// \brief Returns the number of macros found in the chain.
1606 unsigned getTotalNumMacros() const {
1607 return static_cast<unsigned>(MacrosLoaded.size());
1610 /// \brief Returns the number of types found in the chain.
1611 unsigned getTotalNumTypes() const {
1612 return static_cast<unsigned>(TypesLoaded.size());
1615 /// \brief Returns the number of declarations found in the chain.
1616 unsigned getTotalNumDecls() const {
1617 return static_cast<unsigned>(DeclsLoaded.size());
1620 /// \brief Returns the number of submodules known.
1621 unsigned getTotalNumSubmodules() const {
1622 return static_cast<unsigned>(SubmodulesLoaded.size());
1625 /// \brief Returns the number of selectors found in the chain.
1626 unsigned getTotalNumSelectors() const {
1627 return static_cast<unsigned>(SelectorsLoaded.size());
1630 /// \brief Returns the number of preprocessed entities known to the AST
1632 unsigned getTotalNumPreprocessedEntities() const {
1633 unsigned Result = 0;
1634 for (ModuleConstIterator I = ModuleMgr.begin(),
1635 E = ModuleMgr.end(); I != E; ++I) {
1636 Result += (*I)->NumPreprocessedEntities;
1642 /// \brief Reads a TemplateArgumentLocInfo appropriate for the
1643 /// given TemplateArgument kind.
1644 TemplateArgumentLocInfo
1645 GetTemplateArgumentLocInfo(ModuleFile &F, TemplateArgument::ArgKind Kind,
1646 const RecordData &Record, unsigned &Idx);
1648 /// \brief Reads a TemplateArgumentLoc.
1650 ReadTemplateArgumentLoc(ModuleFile &F,
1651 const RecordData &Record, unsigned &Idx);
1653 const ASTTemplateArgumentListInfo*
1654 ReadASTTemplateArgumentListInfo(ModuleFile &F,
1655 const RecordData &Record, unsigned &Index);
1657 /// \brief Reads a declarator info from the given record.
1658 TypeSourceInfo *GetTypeSourceInfo(ModuleFile &F,
1659 const RecordData &Record, unsigned &Idx);
1661 /// \brief Resolve a type ID into a type, potentially building a new
1663 QualType GetType(serialization::TypeID ID);
1665 /// \brief Resolve a local type ID within a given AST file into a type.
1666 QualType getLocalType(ModuleFile &F, unsigned LocalID);
1668 /// \brief Map a local type ID within a given AST file into a global type ID.
1669 serialization::TypeID getGlobalTypeID(ModuleFile &F, unsigned LocalID) const;
1671 /// \brief Read a type from the current position in the given record, which
1672 /// was read from the given AST file.
1673 QualType readType(ModuleFile &F, const RecordData &Record, unsigned &Idx) {
1674 if (Idx >= Record.size())
1677 return getLocalType(F, Record[Idx++]);
1680 /// \brief Map from a local declaration ID within a given module to a
1681 /// global declaration ID.
1682 serialization::DeclID getGlobalDeclID(ModuleFile &F,
1683 serialization::LocalDeclID LocalID) const;
1685 /// \brief Returns true if global DeclID \p ID originated from module \p M.
1686 bool isDeclIDFromModule(serialization::GlobalDeclID ID, ModuleFile &M) const;
1688 /// \brief Retrieve the module file that owns the given declaration, or NULL
1689 /// if the declaration is not from a module file.
1690 ModuleFile *getOwningModuleFile(const Decl *D);
1692 /// \brief Get the best name we know for the module that owns the given
1693 /// declaration, or an empty string if the declaration is not from a module.
1694 std::string getOwningModuleNameForDiagnostic(const Decl *D);
1696 /// \brief Returns the source location for the decl \p ID.
1697 SourceLocation getSourceLocationForDeclID(serialization::GlobalDeclID ID);
1699 /// \brief Resolve a declaration ID into a declaration, potentially
1700 /// building a new declaration.
1701 Decl *GetDecl(serialization::DeclID ID);
1702 Decl *GetExternalDecl(uint32_t ID) override;
1704 /// \brief Resolve a declaration ID into a declaration. Return 0 if it's not
1705 /// been loaded yet.
1706 Decl *GetExistingDecl(serialization::DeclID ID);
1708 /// \brief Reads a declaration with the given local ID in the given module.
1709 Decl *GetLocalDecl(ModuleFile &F, uint32_t LocalID) {
1710 return GetDecl(getGlobalDeclID(F, LocalID));
1713 /// \brief Reads a declaration with the given local ID in the given module.
1715 /// \returns The requested declaration, casted to the given return type.
1716 template<typename T>
1717 T *GetLocalDeclAs(ModuleFile &F, uint32_t LocalID) {
1718 return cast_or_null<T>(GetLocalDecl(F, LocalID));
1721 /// \brief Map a global declaration ID into the declaration ID used to
1722 /// refer to this declaration within the given module fule.
1724 /// \returns the global ID of the given declaration as known in the given
1726 serialization::DeclID
1727 mapGlobalIDToModuleFileGlobalID(ModuleFile &M,
1728 serialization::DeclID GlobalID);
1730 /// \brief Reads a declaration ID from the given position in a record in the
1733 /// \returns The declaration ID read from the record, adjusted to a global ID.
1734 serialization::DeclID ReadDeclID(ModuleFile &F, const RecordData &Record,
1737 /// \brief Reads a declaration from the given position in a record in the
1739 Decl *ReadDecl(ModuleFile &F, const RecordData &R, unsigned &I) {
1740 return GetDecl(ReadDeclID(F, R, I));
1743 /// \brief Reads a declaration from the given position in a record in the
1746 /// \returns The declaration read from this location, casted to the given
1748 template<typename T>
1749 T *ReadDeclAs(ModuleFile &F, const RecordData &R, unsigned &I) {
1750 return cast_or_null<T>(GetDecl(ReadDeclID(F, R, I)));
1753 /// \brief If any redeclarations of \p D have been imported since it was
1754 /// last checked, this digs out those redeclarations and adds them to the
1755 /// redeclaration chain for \p D.
1756 void CompleteRedeclChain(const Decl *D) override;
1758 CXXBaseSpecifier *GetExternalCXXBaseSpecifiers(uint64_t Offset) override;
1760 /// \brief Resolve the offset of a statement into a statement.
1762 /// This operation will read a new statement from the external
1763 /// source each time it is called, and is meant to be used via a
1764 /// LazyOffsetPtr (which is used by Decls for the body of functions, etc).
1765 Stmt *GetExternalDeclStmt(uint64_t Offset) override;
1767 /// ReadBlockAbbrevs - Enter a subblock of the specified BlockID with the
1768 /// specified cursor. Read the abbreviations that are at the top of the block
1769 /// and then leave the cursor pointing into the block.
1770 static bool ReadBlockAbbrevs(llvm::BitstreamCursor &Cursor, unsigned BlockID);
1772 /// \brief Finds all the visible declarations with a given name.
1773 /// The current implementation of this method just loads the entire
1774 /// lookup table as unmaterialized references.
1775 bool FindExternalVisibleDeclsByName(const DeclContext *DC,
1776 DeclarationName Name) override;
1778 /// \brief Read all of the declarations lexically stored in a
1779 /// declaration context.
1781 /// \param DC The declaration context whose declarations will be
1784 /// \param IsKindWeWant A predicate indicating which declaration kinds
1785 /// we are interested in.
1787 /// \param Decls Vector that will contain the declarations loaded
1788 /// from the external source. The caller is responsible for merging
1789 /// these declarations with any declarations already stored in the
1790 /// declaration context.
1792 FindExternalLexicalDecls(const DeclContext *DC,
1793 llvm::function_ref<bool(Decl::Kind)> IsKindWeWant,
1794 SmallVectorImpl<Decl *> &Decls) override;
1796 /// \brief Get the decls that are contained in a file in the Offset/Length
1797 /// range. \p Length can be 0 to indicate a point at \p Offset instead of
1799 void FindFileRegionDecls(FileID File, unsigned Offset, unsigned Length,
1800 SmallVectorImpl<Decl *> &Decls) override;
1802 /// \brief Notify ASTReader that we started deserialization of
1803 /// a decl or type so until FinishedDeserializing is called there may be
1804 /// decls that are initializing. Must be paired with FinishedDeserializing.
1805 void StartedDeserializing() override;
1807 /// \brief Notify ASTReader that we finished the deserialization of
1808 /// a decl or type. Must be paired with StartedDeserializing.
1809 void FinishedDeserializing() override;
1811 /// \brief Function that will be invoked when we begin parsing a new
1812 /// translation unit involving this external AST source.
1814 /// This function will provide all of the external definitions to
1815 /// the ASTConsumer.
1816 void StartTranslationUnit(ASTConsumer *Consumer) override;
1818 /// \brief Print some statistics about AST usage.
1819 void PrintStats() override;
1821 /// \brief Dump information about the AST reader to standard error.
1824 /// Return the amount of memory used by memory buffers, breaking down
1825 /// by heap-backed versus mmap'ed memory.
1826 void getMemoryBufferSizes(MemoryBufferSizes &sizes) const override;
1828 /// \brief Initialize the semantic source with the Sema instance
1829 /// being used to perform semantic analysis on the abstract syntax
1831 void InitializeSema(Sema &S) override;
1833 /// \brief Inform the semantic consumer that Sema is no longer available.
1834 void ForgetSema() override { SemaObj = nullptr; }
1836 /// \brief Retrieve the IdentifierInfo for the named identifier.
1838 /// This routine builds a new IdentifierInfo for the given identifier. If any
1839 /// declarations with this name are visible from translation unit scope, their
1840 /// declarations will be deserialized and introduced into the declaration
1841 /// chain of the identifier.
1842 IdentifierInfo *get(StringRef Name) override;
1844 /// \brief Retrieve an iterator into the set of all identifiers
1845 /// in all loaded AST files.
1846 IdentifierIterator *getIdentifiers() override;
1848 /// \brief Load the contents of the global method pool for a given
1850 void ReadMethodPool(Selector Sel) override;
1852 /// Load the contents of the global method pool for a given
1853 /// selector if necessary.
1854 void updateOutOfDateSelector(Selector Sel) override;
1856 /// \brief Load the set of namespaces that are known to the external source,
1857 /// which will be used during typo correction.
1858 void ReadKnownNamespaces(
1859 SmallVectorImpl<NamespaceDecl *> &Namespaces) override;
1861 void ReadUndefinedButUsed(
1862 llvm::MapVector<NamedDecl *, SourceLocation> &Undefined) override;
1864 void ReadMismatchingDeleteExpressions(llvm::MapVector<
1865 FieldDecl *, llvm::SmallVector<std::pair<SourceLocation, bool>, 4>> &
1868 void ReadTentativeDefinitions(
1869 SmallVectorImpl<VarDecl *> &TentativeDefs) override;
1871 void ReadUnusedFileScopedDecls(
1872 SmallVectorImpl<const DeclaratorDecl *> &Decls) override;
1874 void ReadDelegatingConstructors(
1875 SmallVectorImpl<CXXConstructorDecl *> &Decls) override;
1877 void ReadExtVectorDecls(SmallVectorImpl<TypedefNameDecl *> &Decls) override;
1879 void ReadUnusedLocalTypedefNameCandidates(
1880 llvm::SmallSetVector<const TypedefNameDecl *, 4> &Decls) override;
1882 void ReadReferencedSelectors(
1883 SmallVectorImpl<std::pair<Selector, SourceLocation> > &Sels) override;
1885 void ReadWeakUndeclaredIdentifiers(
1886 SmallVectorImpl<std::pair<IdentifierInfo *, WeakInfo> > &WI) override;
1888 void ReadUsedVTables(SmallVectorImpl<ExternalVTableUse> &VTables) override;
1890 void ReadPendingInstantiations(
1891 SmallVectorImpl<std::pair<ValueDecl *,
1892 SourceLocation> > &Pending) override;
1894 void ReadLateParsedTemplates(
1895 llvm::MapVector<const FunctionDecl *, std::unique_ptr<LateParsedTemplate>>
1898 /// \brief Load a selector from disk, registering its ID if it exists.
1899 void LoadSelector(Selector Sel);
1901 void SetIdentifierInfo(unsigned ID, IdentifierInfo *II);
1902 void SetGloballyVisibleDecls(IdentifierInfo *II,
1903 const SmallVectorImpl<uint32_t> &DeclIDs,
1904 SmallVectorImpl<Decl *> *Decls = nullptr);
1906 /// \brief Report a diagnostic.
1907 DiagnosticBuilder Diag(unsigned DiagID);
1909 /// \brief Report a diagnostic.
1910 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID);
1912 IdentifierInfo *DecodeIdentifierInfo(serialization::IdentifierID ID);
1914 IdentifierInfo *GetIdentifierInfo(ModuleFile &M, const RecordData &Record,
1916 return DecodeIdentifierInfo(getGlobalIdentifierID(M, Record[Idx++]));
1919 IdentifierInfo *GetIdentifier(serialization::IdentifierID ID) override {
1920 // Note that we are loading an identifier.
1921 Deserializing AnIdentifier(this);
1923 return DecodeIdentifierInfo(ID);
1926 IdentifierInfo *getLocalIdentifier(ModuleFile &M, unsigned LocalID);
1928 serialization::IdentifierID getGlobalIdentifierID(ModuleFile &M,
1931 void resolvePendingMacro(IdentifierInfo *II, const PendingMacroInfo &PMInfo);
1933 /// \brief Retrieve the macro with the given ID.
1934 MacroInfo *getMacro(serialization::MacroID ID);
1936 /// \brief Retrieve the global macro ID corresponding to the given local
1937 /// ID within the given module file.
1938 serialization::MacroID getGlobalMacroID(ModuleFile &M, unsigned LocalID);
1940 /// \brief Read the source location entry with index ID.
1941 bool ReadSLocEntry(int ID) override;
1943 /// \brief Retrieve the module import location and module name for the
1944 /// given source manager entry ID.
1945 std::pair<SourceLocation, StringRef> getModuleImportLoc(int ID) override;
1947 /// \brief Retrieve the global submodule ID given a module and its local ID
1949 serialization::SubmoduleID
1950 getGlobalSubmoduleID(ModuleFile &M, unsigned LocalID);
1952 /// \brief Retrieve the submodule that corresponds to a global submodule ID.
1954 Module *getSubmodule(serialization::SubmoduleID GlobalID);
1956 /// \brief Retrieve the module that corresponds to the given module ID.
1958 /// Note: overrides method in ExternalASTSource
1959 Module *getModule(unsigned ID) override;
1961 /// \brief Retrieve the module file with a given local ID within the specified
1963 ModuleFile *getLocalModuleFile(ModuleFile &M, unsigned ID);
1965 /// \brief Get an ID for the given module file.
1966 unsigned getModuleFileID(ModuleFile *M);
1968 /// \brief Return a descriptor for the corresponding module.
1969 llvm::Optional<ASTSourceDescriptor> getSourceDescriptor(unsigned ID) override;
1971 /// \brief Retrieve a selector from the given module with its local ID
1973 Selector getLocalSelector(ModuleFile &M, unsigned LocalID);
1975 Selector DecodeSelector(serialization::SelectorID Idx);
1977 Selector GetExternalSelector(serialization::SelectorID ID) override;
1978 uint32_t GetNumExternalSelectors() override;
1980 Selector ReadSelector(ModuleFile &M, const RecordData &Record, unsigned &Idx) {
1981 return getLocalSelector(M, Record[Idx++]);
1984 /// \brief Retrieve the global selector ID that corresponds to this
1985 /// the local selector ID in a given module.
1986 serialization::SelectorID getGlobalSelectorID(ModuleFile &F,
1987 unsigned LocalID) const;
1989 /// \brief Read a declaration name.
1990 DeclarationName ReadDeclarationName(ModuleFile &F,
1991 const RecordData &Record, unsigned &Idx);
1992 void ReadDeclarationNameLoc(ModuleFile &F,
1993 DeclarationNameLoc &DNLoc, DeclarationName Name,
1994 const RecordData &Record, unsigned &Idx);
1995 void ReadDeclarationNameInfo(ModuleFile &F, DeclarationNameInfo &NameInfo,
1996 const RecordData &Record, unsigned &Idx);
1998 void ReadQualifierInfo(ModuleFile &F, QualifierInfo &Info,
1999 const RecordData &Record, unsigned &Idx);
2001 NestedNameSpecifier *ReadNestedNameSpecifier(ModuleFile &F,
2002 const RecordData &Record,
2005 NestedNameSpecifierLoc ReadNestedNameSpecifierLoc(ModuleFile &F,
2006 const RecordData &Record,
2009 /// \brief Read a template name.
2010 TemplateName ReadTemplateName(ModuleFile &F, const RecordData &Record,
2013 /// \brief Read a template argument.
2014 TemplateArgument ReadTemplateArgument(ModuleFile &F, const RecordData &Record,
2016 bool Canonicalize = false);
2018 /// \brief Read a template parameter list.
2019 TemplateParameterList *ReadTemplateParameterList(ModuleFile &F,
2020 const RecordData &Record,
2023 /// \brief Read a template argument array.
2024 void ReadTemplateArgumentList(SmallVectorImpl<TemplateArgument> &TemplArgs,
2025 ModuleFile &F, const RecordData &Record,
2026 unsigned &Idx, bool Canonicalize = false);
2028 /// \brief Read a UnresolvedSet structure.
2029 void ReadUnresolvedSet(ModuleFile &F, LazyASTUnresolvedSet &Set,
2030 const RecordData &Record, unsigned &Idx);
2032 /// \brief Read a C++ base specifier.
2033 CXXBaseSpecifier ReadCXXBaseSpecifier(ModuleFile &F,
2034 const RecordData &Record,unsigned &Idx);
2036 /// \brief Read a CXXCtorInitializer array.
2037 CXXCtorInitializer **
2038 ReadCXXCtorInitializers(ModuleFile &F, const RecordData &Record,
2041 /// \brief Read the contents of a CXXCtorInitializer array.
2042 CXXCtorInitializer **GetExternalCXXCtorInitializers(uint64_t Offset) override;
2044 /// \brief Read a source location from raw form and return it in its
2045 /// originating module file's source location space.
2046 SourceLocation ReadUntranslatedSourceLocation(uint32_t Raw) const {
2047 return SourceLocation::getFromRawEncoding((Raw >> 1) | (Raw << 31));
2050 /// \brief Read a source location from raw form.
2051 SourceLocation ReadSourceLocation(ModuleFile &ModuleFile, uint32_t Raw) const {
2052 SourceLocation Loc = ReadUntranslatedSourceLocation(Raw);
2053 return TranslateSourceLocation(ModuleFile, Loc);
2056 /// \brief Translate a source location from another module file's source
2057 /// location space into ours.
2058 SourceLocation TranslateSourceLocation(ModuleFile &ModuleFile,
2059 SourceLocation Loc) const {
2060 assert(ModuleFile.SLocRemap.find(Loc.getOffset()) !=
2061 ModuleFile.SLocRemap.end() &&
2062 "Cannot find offset to remap.");
2063 int Remap = ModuleFile.SLocRemap.find(Loc.getOffset())->second;
2064 return Loc.getLocWithOffset(Remap);
2067 /// \brief Read a source location.
2068 SourceLocation ReadSourceLocation(ModuleFile &ModuleFile,
2069 const RecordDataImpl &Record,
2071 return ReadSourceLocation(ModuleFile, Record[Idx++]);
2074 /// \brief Read a source range.
2075 SourceRange ReadSourceRange(ModuleFile &F,
2076 const RecordData &Record, unsigned &Idx);
2078 /// \brief Read an integral value
2079 llvm::APInt ReadAPInt(const RecordData &Record, unsigned &Idx);
2081 /// \brief Read a signed integral value
2082 llvm::APSInt ReadAPSInt(const RecordData &Record, unsigned &Idx);
2084 /// \brief Read a floating-point value
2085 llvm::APFloat ReadAPFloat(const RecordData &Record,
2086 const llvm::fltSemantics &Sem, unsigned &Idx);
2088 // \brief Read a string
2089 static std::string ReadString(const RecordData &Record, unsigned &Idx);
2091 // \brief Read a path
2092 std::string ReadPath(ModuleFile &F, const RecordData &Record, unsigned &Idx);
2094 /// \brief Read a version tuple.
2095 static VersionTuple ReadVersionTuple(const RecordData &Record, unsigned &Idx);
2097 CXXTemporary *ReadCXXTemporary(ModuleFile &F, const RecordData &Record,
2100 /// \brief Reads attributes from the current stream position.
2101 void ReadAttributes(ModuleFile &F, AttrVec &Attrs,
2102 const RecordData &Record, unsigned &Idx);
2104 /// \brief Reads a statement.
2105 Stmt *ReadStmt(ModuleFile &F);
2107 /// \brief Reads an expression.
2108 Expr *ReadExpr(ModuleFile &F);
2110 /// \brief Reads a sub-statement operand during statement reading.
2111 Stmt *ReadSubStmt() {
2112 assert(ReadingKind == Read_Stmt &&
2113 "Should be called only during statement reading!");
2114 // Subexpressions are stored from last to first, so the next Stmt we need
2115 // is at the back of the stack.
2116 assert(!StmtStack.empty() && "Read too many sub-statements!");
2117 return StmtStack.pop_back_val();
2120 /// \brief Reads a sub-expression operand during statement reading.
2121 Expr *ReadSubExpr();
2123 /// \brief Reads a token out of a record.
2124 Token ReadToken(ModuleFile &M, const RecordDataImpl &Record, unsigned &Idx);
2126 /// \brief Reads the macro record located at the given offset.
2127 MacroInfo *ReadMacroRecord(ModuleFile &F, uint64_t Offset);
2129 /// \brief Determine the global preprocessed entity ID that corresponds to
2130 /// the given local ID within the given module.
2131 serialization::PreprocessedEntityID
2132 getGlobalPreprocessedEntityID(ModuleFile &M, unsigned LocalID) const;
2134 /// \brief Add a macro to deserialize its macro directive history.
2136 /// \param II The name of the macro.
2137 /// \param M The module file.
2138 /// \param MacroDirectivesOffset Offset of the serialized macro directive
2140 void addPendingMacro(IdentifierInfo *II, ModuleFile *M,
2141 uint64_t MacroDirectivesOffset);
2143 /// \brief Read the set of macros defined by this external macro source.
2144 void ReadDefinedMacros() override;
2146 /// \brief Update an out-of-date identifier.
2147 void updateOutOfDateIdentifier(IdentifierInfo &II) override;
2149 /// \brief Note that this identifier is up-to-date.
2150 void markIdentifierUpToDate(IdentifierInfo *II);
2152 /// \brief Load all external visible decls in the given DeclContext.
2153 void completeVisibleDeclsMap(const DeclContext *DC) override;
2155 /// \brief Retrieve the AST context that this AST reader supplements.
2156 ASTContext &getContext() { return Context; }
2158 // \brief Contains the IDs for declarations that were requested before we have
2159 // access to a Sema object.
2160 SmallVector<uint64_t, 16> PreloadedDeclIDs;
2162 /// \brief Retrieve the semantic analysis object used to analyze the
2163 /// translation unit in which the precompiled header is being
2165 Sema *getSema() { return SemaObj; }
2167 /// \brief Get the identifier resolver used for name lookup / updates
2168 /// in the translation unit scope. We have one of these even if we don't
2169 /// have a Sema object.
2170 IdentifierResolver &getIdResolver();
2172 /// \brief Retrieve the identifier table associated with the
2174 IdentifierTable &getIdentifierTable();
2176 /// \brief Record that the given ID maps to the given switch-case
2178 void RecordSwitchCaseID(SwitchCase *SC, unsigned ID);
2180 /// \brief Retrieve the switch-case statement with the given ID.
2181 SwitchCase *getSwitchCaseWithID(unsigned ID);
2183 void ClearSwitchCaseIDs();
2185 /// \brief Cursors for comments blocks.
2186 SmallVector<std::pair<llvm::BitstreamCursor,
2187 serialization::ModuleFile *>, 8> CommentsCursors;
2189 /// \brief Loads comments ranges.
2190 void ReadComments() override;
2192 bool isProcessingUpdateRecords() { return ProcessingUpdateRecords; }
2195 /// \brief An object for streaming information from a record.
2196 class ASTRecordReader {
2197 typedef serialization::ModuleFile ModuleFile;
2202 ASTReader::RecordData Record;
2204 typedef ASTReader::RecordData RecordData;
2205 typedef ASTReader::RecordDataImpl RecordDataImpl;
2208 /// Construct an ASTRecordReader that uses the default encoding scheme.
2209 ASTRecordReader(ASTReader &Reader, ModuleFile &F)
2210 : Reader(&Reader), F(&F) {}
2212 /// \brief Reads a record with id AbbrevID from Cursor, resetting the
2214 unsigned readRecord(llvm::BitstreamCursor &Cursor, unsigned AbbrevID);
2216 /// \brief Is this a module file for a module (rather than a PCH or similar).
2217 bool isModule() const { return F->isModule(); }
2219 /// \brief Retrieve the AST context that this AST reader supplements.
2220 ASTContext &getContext() { return Reader->getContext(); }
2222 /// \brief The current position in this record.
2223 unsigned getIdx() const { return Idx; }
2224 /// \brief The length of this record.
2225 size_t size() const { return Record.size(); }
2227 /// \brief An arbitrary index in this record.
2228 const uint64_t &operator[](size_t N) { return Record[N]; }
2229 /// \brief The last element in this record.
2230 const uint64_t &back() const { return Record.back(); }
2232 /// \brief Returns the current value in this record, and advances to the
2234 const uint64_t &readInt() { return Record[Idx++]; }
2235 /// \brief Returns the current value in this record, without advancing.
2236 const uint64_t &peekInt() { return Record[Idx]; }
2238 /// \brief Skips the specified number of values.
2239 void skipInts(unsigned N) { Idx += N; }
2241 /// \brief Retrieve the global submodule ID its local ID number.
2242 serialization::SubmoduleID
2243 getGlobalSubmoduleID(unsigned LocalID) {
2244 return Reader->getGlobalSubmoduleID(*F, LocalID);
2247 /// \brief Retrieve the submodule that corresponds to a global submodule ID.
2248 Module *getSubmodule(serialization::SubmoduleID GlobalID) {
2249 return Reader->getSubmodule(GlobalID);
2252 /// \brief Read the record that describes the lexical contents of a DC.
2253 bool readLexicalDeclContextStorage(uint64_t Offset, DeclContext *DC) {
2254 return Reader->ReadLexicalDeclContextStorage(*F, F->DeclsCursor, Offset,
2258 /// \brief Read the record that describes the visible contents of a DC.
2259 bool readVisibleDeclContextStorage(uint64_t Offset,
2260 serialization::DeclID ID) {
2261 return Reader->ReadVisibleDeclContextStorage(*F, F->DeclsCursor, Offset,
2265 void readExceptionSpec(SmallVectorImpl<QualType> &ExceptionStorage,
2266 FunctionProtoType::ExceptionSpecInfo &ESI) {
2267 return Reader->readExceptionSpec(*F, ExceptionStorage, ESI, Record, Idx);
2270 /// \brief Get the global offset corresponding to a local offset.
2271 uint64_t getGlobalBitOffset(uint32_t LocalOffset) {
2272 return Reader->getGlobalBitOffset(*F, LocalOffset);
2275 /// \brief Reads a statement.
2276 Stmt *readStmt() { return Reader->ReadStmt(*F); }
2278 /// \brief Reads an expression.
2279 Expr *readExpr() { return Reader->ReadExpr(*F); }
2281 /// \brief Reads a sub-statement operand during statement reading.
2282 Stmt *readSubStmt() { return Reader->ReadSubStmt(); }
2284 /// \brief Reads a sub-expression operand during statement reading.
2285 Expr *readSubExpr() { return Reader->ReadSubExpr(); }
2287 /// \brief Reads a TemplateArgumentLocInfo appropriate for the
2288 /// given TemplateArgument kind, advancing Idx.
2289 TemplateArgumentLocInfo
2290 getTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind) {
2291 return Reader->GetTemplateArgumentLocInfo(*F, Kind, Record, Idx);
2294 /// \brief Reads a TemplateArgumentLoc, advancing Idx.
2296 readTemplateArgumentLoc() {
2297 return Reader->ReadTemplateArgumentLoc(*F, Record, Idx);
2300 const ASTTemplateArgumentListInfo*
2301 readASTTemplateArgumentListInfo() {
2302 return Reader->ReadASTTemplateArgumentListInfo(*F, Record, Idx);
2305 /// \brief Reads a declarator info from the given record, advancing Idx.
2306 TypeSourceInfo *getTypeSourceInfo() {
2307 return Reader->GetTypeSourceInfo(*F, Record, Idx);
2310 /// \brief Map a local type ID within a given AST file to a global type ID.
2311 serialization::TypeID getGlobalTypeID(unsigned LocalID) const {
2312 return Reader->getGlobalTypeID(*F, LocalID);
2315 /// \brief Read a type from the current position in the record.
2316 QualType readType() {
2317 return Reader->readType(*F, Record, Idx);
2320 /// \brief Reads a declaration ID from the given position in this record.
2322 /// \returns The declaration ID read from the record, adjusted to a global ID.
2323 serialization::DeclID readDeclID() {
2324 return Reader->ReadDeclID(*F, Record, Idx);
2327 /// \brief Reads a declaration from the given position in a record in the
2328 /// given module, advancing Idx.
2330 return Reader->ReadDecl(*F, Record, Idx);
2333 /// \brief Reads a declaration from the given position in the record,
2336 /// \returns The declaration read from this location, casted to the given
2338 template<typename T>
2340 return Reader->ReadDeclAs<T>(*F, Record, Idx);
2343 IdentifierInfo *getIdentifierInfo() {
2344 return Reader->GetIdentifierInfo(*F, Record, Idx);
2347 /// \brief Read a selector from the Record, advancing Idx.
2348 Selector readSelector() {
2349 return Reader->ReadSelector(*F, Record, Idx);
2352 /// \brief Read a declaration name, advancing Idx.
2353 DeclarationName readDeclarationName() {
2354 return Reader->ReadDeclarationName(*F, Record, Idx);
2356 void readDeclarationNameLoc(DeclarationNameLoc &DNLoc, DeclarationName Name) {
2357 return Reader->ReadDeclarationNameLoc(*F, DNLoc, Name, Record, Idx);
2359 void readDeclarationNameInfo(DeclarationNameInfo &NameInfo) {
2360 return Reader->ReadDeclarationNameInfo(*F, NameInfo, Record, Idx);
2363 void readQualifierInfo(QualifierInfo &Info) {
2364 return Reader->ReadQualifierInfo(*F, Info, Record, Idx);
2367 NestedNameSpecifier *readNestedNameSpecifier() {
2368 return Reader->ReadNestedNameSpecifier(*F, Record, Idx);
2371 NestedNameSpecifierLoc readNestedNameSpecifierLoc() {
2372 return Reader->ReadNestedNameSpecifierLoc(*F, Record, Idx);
2375 /// \brief Read a template name, advancing Idx.
2376 TemplateName readTemplateName() {
2377 return Reader->ReadTemplateName(*F, Record, Idx);
2380 /// \brief Read a template argument, advancing Idx.
2381 TemplateArgument readTemplateArgument(bool Canonicalize = false) {
2382 return Reader->ReadTemplateArgument(*F, Record, Idx, Canonicalize);
2385 /// \brief Read a template parameter list, advancing Idx.
2386 TemplateParameterList *readTemplateParameterList() {
2387 return Reader->ReadTemplateParameterList(*F, Record, Idx);
2390 /// \brief Read a template argument array, advancing Idx.
2391 void readTemplateArgumentList(SmallVectorImpl<TemplateArgument> &TemplArgs,
2392 bool Canonicalize = false) {
2393 return Reader->ReadTemplateArgumentList(TemplArgs, *F, Record, Idx,
2397 /// \brief Read a UnresolvedSet structure, advancing Idx.
2398 void readUnresolvedSet(LazyASTUnresolvedSet &Set) {
2399 return Reader->ReadUnresolvedSet(*F, Set, Record, Idx);
2402 /// \brief Read a C++ base specifier, advancing Idx.
2403 CXXBaseSpecifier readCXXBaseSpecifier() {
2404 return Reader->ReadCXXBaseSpecifier(*F, Record, Idx);
2407 /// \brief Read a CXXCtorInitializer array, advancing Idx.
2408 CXXCtorInitializer **readCXXCtorInitializers() {
2409 return Reader->ReadCXXCtorInitializers(*F, Record, Idx);
2412 CXXTemporary *readCXXTemporary() {
2413 return Reader->ReadCXXTemporary(*F, Record, Idx);
2416 /// \brief Read a source location, advancing Idx.
2417 SourceLocation readSourceLocation() {
2418 return Reader->ReadSourceLocation(*F, Record, Idx);
2421 /// \brief Read a source range, advancing Idx.
2422 SourceRange readSourceRange() {
2423 return Reader->ReadSourceRange(*F, Record, Idx);
2426 /// \brief Read an integral value, advancing Idx.
2427 llvm::APInt readAPInt() {
2428 return Reader->ReadAPInt(Record, Idx);
2431 /// \brief Read a signed integral value, advancing Idx.
2432 llvm::APSInt readAPSInt() {
2433 return Reader->ReadAPSInt(Record, Idx);
2436 /// \brief Read a floating-point value, advancing Idx.
2437 llvm::APFloat readAPFloat(const llvm::fltSemantics &Sem) {
2438 return Reader->ReadAPFloat(Record, Sem,Idx);
2441 /// \brief Read a string, advancing Idx.
2442 std::string readString() {
2443 return Reader->ReadString(Record, Idx);
2446 /// \brief Read a path, advancing Idx.
2447 std::string readPath() {
2448 return Reader->ReadPath(*F, Record, Idx);
2451 /// \brief Read a version tuple, advancing Idx.
2452 VersionTuple readVersionTuple() {
2453 return ASTReader::ReadVersionTuple(Record, Idx);
2456 /// \brief Reads attributes from the current stream position, advancing Idx.
2457 void readAttributes(AttrVec &Attrs) {
2458 return Reader->ReadAttributes(*F, Attrs, Record, Idx);
2461 /// \brief Reads a token out of a record, advancing Idx.
2463 return Reader->ReadToken(*F, Record, Idx);
2466 void recordSwitchCaseID(SwitchCase *SC, unsigned ID) {
2467 Reader->RecordSwitchCaseID(SC, ID);
2470 /// \brief Retrieve the switch-case statement with the given ID.
2471 SwitchCase *getSwitchCaseWithID(unsigned ID) {
2472 return Reader->getSwitchCaseWithID(ID);
2476 /// \brief Helper class that saves the current stream position and
2477 /// then restores it when destroyed.
2478 struct SavedStreamPosition {
2479 explicit SavedStreamPosition(llvm::BitstreamCursor &Cursor)
2480 : Cursor(Cursor), Offset(Cursor.GetCurrentBitNo()) { }
2482 ~SavedStreamPosition() {
2483 Cursor.JumpToBit(Offset);
2487 llvm::BitstreamCursor &Cursor;
2491 inline void PCHValidator::Error(const char *Msg) {
2495 } // end namespace clang