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.
403 ASTContext *ContextObj = nullptr;
405 /// \brief The AST consumer.
406 ASTConsumer *Consumer = nullptr;
408 /// \brief The module manager which manages modules and their dependencies
409 ModuleManager ModuleMgr;
411 /// The cache that manages memory buffers for PCM files.
412 MemoryBufferCache &PCMCache;
414 /// \brief A dummy identifier resolver used to merge TU-scope declarations in
415 /// C, for the cases where we don't have a Sema object to provide a real
416 /// identifier resolver.
417 IdentifierResolver DummyIdResolver;
419 /// A mapping from extension block names to module file extensions.
420 llvm::StringMap<std::shared_ptr<ModuleFileExtension>> ModuleFileExtensions;
422 /// \brief A timer used to track the time spent deserializing.
423 std::unique_ptr<llvm::Timer> ReadTimer;
425 /// \brief The location where the module file will be considered as
426 /// imported from. For non-module AST types it should be invalid.
427 SourceLocation CurrentImportLoc;
429 /// \brief The global module index, if loaded.
430 std::unique_ptr<GlobalModuleIndex> GlobalIndex;
432 /// \brief A map of global bit offsets to the module that stores entities
433 /// at those bit offsets.
434 ContinuousRangeMap<uint64_t, ModuleFile*, 4> GlobalBitOffsetsMap;
436 /// \brief A map of negated SLocEntryIDs to the modules containing them.
437 ContinuousRangeMap<unsigned, ModuleFile*, 64> GlobalSLocEntryMap;
439 typedef ContinuousRangeMap<unsigned, ModuleFile*, 64> GlobalSLocOffsetMapType;
441 /// \brief A map of reversed (SourceManager::MaxLoadedOffset - SLocOffset)
442 /// SourceLocation offsets to the modules containing them.
443 GlobalSLocOffsetMapType GlobalSLocOffsetMap;
445 /// \brief Types that have already been loaded from the chain.
447 /// When the pointer at index I is non-NULL, the type with
448 /// ID = (I + 1) << FastQual::Width has already been loaded
449 std::vector<QualType> TypesLoaded;
451 typedef ContinuousRangeMap<serialization::TypeID, ModuleFile *, 4>
454 /// \brief Mapping from global type IDs to the module in which the
455 /// type resides along with the offset that should be added to the
456 /// global type ID to produce a local ID.
457 GlobalTypeMapType GlobalTypeMap;
459 /// \brief Declarations that have already been loaded from the chain.
461 /// When the pointer at index I is non-NULL, the declaration with ID
462 /// = I + 1 has already been loaded.
463 std::vector<Decl *> DeclsLoaded;
465 typedef ContinuousRangeMap<serialization::DeclID, ModuleFile *, 4>
468 /// \brief Mapping from global declaration IDs to the module in which the
469 /// declaration resides.
470 GlobalDeclMapType GlobalDeclMap;
472 typedef std::pair<ModuleFile *, uint64_t> FileOffset;
473 typedef SmallVector<FileOffset, 2> FileOffsetsTy;
474 typedef llvm::DenseMap<serialization::DeclID, FileOffsetsTy>
475 DeclUpdateOffsetsMap;
477 /// \brief Declarations that have modifications residing in a later file
479 DeclUpdateOffsetsMap DeclUpdateOffsets;
481 struct PendingUpdateRecord {
483 serialization::GlobalDeclID ID;
484 // Whether the declaration was just deserialized.
486 PendingUpdateRecord(serialization::GlobalDeclID ID, Decl *D,
488 : D(D), ID(ID), JustLoaded(JustLoaded) {}
490 /// \brief Declaration updates for already-loaded declarations that we need
491 /// to apply once we finish processing an import.
492 llvm::SmallVector<PendingUpdateRecord, 16> PendingUpdateRecords;
494 enum class PendingFakeDefinitionKind { NotFake, Fake, FakeLoaded };
496 /// \brief The DefinitionData pointers that we faked up for class definitions
497 /// that we needed but hadn't loaded yet.
498 llvm::DenseMap<void *, PendingFakeDefinitionKind> PendingFakeDefinitionData;
500 /// \brief Exception specification updates that have been loaded but not yet
501 /// propagated across the relevant redeclaration chain. The map key is the
502 /// canonical declaration (used only for deduplication) and the value is a
503 /// declaration that has an exception specification.
504 llvm::SmallMapVector<Decl *, FunctionDecl *, 4> PendingExceptionSpecUpdates;
506 /// \brief Declarations that have been imported and have typedef names for
507 /// linkage purposes.
508 llvm::DenseMap<std::pair<DeclContext*, IdentifierInfo*>, NamedDecl*>
509 ImportedTypedefNamesForLinkage;
511 /// \brief Mergeable declaration contexts that have anonymous declarations
512 /// within them, and those anonymous declarations.
513 llvm::DenseMap<DeclContext*, llvm::SmallVector<NamedDecl*, 2>>
514 AnonymousDeclarationsForMerging;
516 struct FileDeclsInfo {
518 ArrayRef<serialization::LocalDeclID> Decls;
520 FileDeclsInfo() : Mod(nullptr) {}
521 FileDeclsInfo(ModuleFile *Mod, ArrayRef<serialization::LocalDeclID> Decls)
522 : Mod(Mod), Decls(Decls) {}
525 /// \brief Map from a FileID to the file-level declarations that it contains.
526 llvm::DenseMap<FileID, FileDeclsInfo> FileDeclIDs;
528 /// \brief An array of lexical contents of a declaration context, as a sequence of
529 /// Decl::Kind, DeclID pairs.
530 typedef ArrayRef<llvm::support::unaligned_uint32_t> LexicalContents;
532 /// \brief Map from a DeclContext to its lexical contents.
533 llvm::DenseMap<const DeclContext*, std::pair<ModuleFile*, LexicalContents>>
536 /// \brief Map from the TU to its lexical contents from each module file.
537 std::vector<std::pair<ModuleFile*, LexicalContents>> TULexicalDecls;
539 /// \brief Map from a DeclContext to its lookup tables.
540 llvm::DenseMap<const DeclContext *,
541 serialization::reader::DeclContextLookupTable> Lookups;
543 // Updates for visible decls can occur for other contexts than just the
544 // TU, and when we read those update records, the actual context may not
545 // be available yet, so have this pending map using the ID as a key. It
546 // will be realized when the context is actually loaded.
547 struct PendingVisibleUpdate {
549 const unsigned char *Data;
551 typedef SmallVector<PendingVisibleUpdate, 1> DeclContextVisibleUpdates;
553 /// \brief Updates to the visible declarations of declaration contexts that
554 /// haven't been loaded yet.
555 llvm::DenseMap<serialization::DeclID, DeclContextVisibleUpdates>
556 PendingVisibleUpdates;
558 /// \brief The set of C++ or Objective-C classes that have forward
559 /// declarations that have not yet been linked to their definitions.
560 llvm::SmallPtrSet<Decl *, 4> PendingDefinitions;
562 typedef llvm::MapVector<Decl *, uint64_t,
563 llvm::SmallDenseMap<Decl *, unsigned, 4>,
564 SmallVector<std::pair<Decl *, uint64_t>, 4> >
567 /// \brief Functions or methods that have bodies that will be attached.
568 PendingBodiesMap PendingBodies;
570 /// \brief Definitions for which we have added merged definitions but not yet
571 /// performed deduplication.
572 llvm::SetVector<NamedDecl*> PendingMergedDefinitionsToDeduplicate;
574 /// \brief Read the record that describes the lexical contents of a DC.
575 bool ReadLexicalDeclContextStorage(ModuleFile &M,
576 llvm::BitstreamCursor &Cursor,
577 uint64_t Offset, DeclContext *DC);
578 /// \brief Read the record that describes the visible contents of a DC.
579 bool ReadVisibleDeclContextStorage(ModuleFile &M,
580 llvm::BitstreamCursor &Cursor,
581 uint64_t Offset, serialization::DeclID ID);
583 /// \brief A vector containing identifiers that have already been
586 /// If the pointer at index I is non-NULL, then it refers to the
587 /// IdentifierInfo for the identifier with ID=I+1 that has already
589 std::vector<IdentifierInfo *> IdentifiersLoaded;
591 typedef ContinuousRangeMap<serialization::IdentID, ModuleFile *, 4>
592 GlobalIdentifierMapType;
594 /// \brief Mapping from global identifier IDs to the module in which the
595 /// identifier resides along with the offset that should be added to the
596 /// global identifier ID to produce a local ID.
597 GlobalIdentifierMapType GlobalIdentifierMap;
599 /// \brief A vector containing macros that have already been
602 /// If the pointer at index I is non-NULL, then it refers to the
603 /// MacroInfo for the identifier with ID=I+1 that has already
605 std::vector<MacroInfo *> MacrosLoaded;
607 typedef std::pair<IdentifierInfo *, serialization::SubmoduleID>
610 /// \brief A set of #undef directives that we have loaded; used to
611 /// deduplicate the same #undef information coming from multiple module
613 llvm::DenseSet<LoadedMacroInfo> LoadedUndefs;
615 typedef ContinuousRangeMap<serialization::MacroID, ModuleFile *, 4>
618 /// \brief Mapping from global macro IDs to the module in which the
619 /// macro resides along with the offset that should be added to the
620 /// global macro ID to produce a local ID.
621 GlobalMacroMapType GlobalMacroMap;
623 /// \brief A vector containing submodules that have already been loaded.
625 /// This vector is indexed by the Submodule ID (-1). NULL submodule entries
626 /// indicate that the particular submodule ID has not yet been loaded.
627 SmallVector<Module *, 2> SubmodulesLoaded;
629 typedef ContinuousRangeMap<serialization::SubmoduleID, ModuleFile *, 4>
630 GlobalSubmoduleMapType;
632 /// \brief Mapping from global submodule IDs to the module file in which the
633 /// submodule resides along with the offset that should be added to the
634 /// global submodule ID to produce a local ID.
635 GlobalSubmoduleMapType GlobalSubmoduleMap;
637 /// \brief A set of hidden declarations.
638 typedef SmallVector<Decl*, 2> HiddenNames;
639 typedef llvm::DenseMap<Module *, HiddenNames> HiddenNamesMapType;
641 /// \brief A mapping from each of the hidden submodules to the deserialized
642 /// declarations in that submodule that could be made visible.
643 HiddenNamesMapType HiddenNamesMap;
646 /// \brief A module import, export, or conflict that hasn't yet been resolved.
647 struct UnresolvedModuleRef {
648 /// \brief The file in which this module resides.
651 /// \brief The module that is importing or exporting.
654 /// \brief The kind of module reference.
655 enum { Import, Export, Conflict } Kind;
657 /// \brief The local ID of the module that is being exported.
660 /// \brief Whether this is a wildcard export.
661 unsigned IsWildcard : 1;
663 /// \brief String data.
667 /// \brief The set of module imports and exports that still need to be
669 SmallVector<UnresolvedModuleRef, 2> UnresolvedModuleRefs;
671 /// \brief A vector containing selectors that have already been loaded.
673 /// This vector is indexed by the Selector ID (-1). NULL selector
674 /// entries indicate that the particular selector ID has not yet
676 SmallVector<Selector, 16> SelectorsLoaded;
678 typedef ContinuousRangeMap<serialization::SelectorID, ModuleFile *, 4>
679 GlobalSelectorMapType;
681 /// \brief Mapping from global selector IDs to the module in which the
683 /// global selector ID to produce a local ID.
684 GlobalSelectorMapType GlobalSelectorMap;
686 /// \brief The generation number of the last time we loaded data from the
687 /// global method pool for this selector.
688 llvm::DenseMap<Selector, unsigned> SelectorGeneration;
690 /// Whether a selector is out of date. We mark a selector as out of date
691 /// if we load another module after the method pool entry was pulled in.
692 llvm::DenseMap<Selector, bool> SelectorOutOfDate;
694 struct PendingMacroInfo {
696 uint64_t MacroDirectivesOffset;
698 PendingMacroInfo(ModuleFile *M, uint64_t MacroDirectivesOffset)
699 : M(M), MacroDirectivesOffset(MacroDirectivesOffset) {}
702 typedef llvm::MapVector<IdentifierInfo *, SmallVector<PendingMacroInfo, 2> >
705 /// \brief Mapping from identifiers that have a macro history to the global
706 /// IDs have not yet been deserialized to the global IDs of those macros.
707 PendingMacroIDsMap PendingMacroIDs;
709 typedef ContinuousRangeMap<unsigned, ModuleFile *, 4>
710 GlobalPreprocessedEntityMapType;
712 /// \brief Mapping from global preprocessing entity IDs to the module in
713 /// which the preprocessed entity resides along with the offset that should be
714 /// added to the global preprocessing entity ID to produce a local ID.
715 GlobalPreprocessedEntityMapType GlobalPreprocessedEntityMap;
717 /// \name CodeGen-relevant special data
718 /// \brief Fields containing data that is relevant to CodeGen.
721 /// \brief The IDs of all declarations that fulfill the criteria of
722 /// "interesting" decls.
724 /// This contains the data loaded from all EAGERLY_DESERIALIZED_DECLS blocks
725 /// in the chain. The referenced declarations are deserialized and passed to
726 /// the consumer eagerly.
727 SmallVector<uint64_t, 16> EagerlyDeserializedDecls;
729 /// \brief The IDs of all tentative definitions stored in the chain.
731 /// Sema keeps track of all tentative definitions in a TU because it has to
732 /// complete them and pass them on to CodeGen. Thus, tentative definitions in
733 /// the PCH chain must be eagerly deserialized.
734 SmallVector<uint64_t, 16> TentativeDefinitions;
736 /// \brief The IDs of all CXXRecordDecls stored in the chain whose VTables are
739 /// CodeGen has to emit VTables for these records, so they have to be eagerly
741 SmallVector<uint64_t, 64> VTableUses;
743 /// \brief A snapshot of the pending instantiations in the chain.
745 /// This record tracks the instantiations that Sema has to perform at the
746 /// end of the TU. It consists of a pair of values for every pending
747 /// instantiation where the first value is the ID of the decl and the second
748 /// is the instantiation location.
749 SmallVector<uint64_t, 64> PendingInstantiations;
753 /// \name DiagnosticsEngine-relevant special data
754 /// \brief Fields containing data that is used for generating diagnostics
757 /// \brief A snapshot of Sema's unused file-scoped variable tracking, for
758 /// generating warnings.
759 SmallVector<uint64_t, 16> UnusedFileScopedDecls;
761 /// \brief A list of all the delegating constructors we've seen, to diagnose
763 SmallVector<uint64_t, 4> DelegatingCtorDecls;
765 /// \brief Method selectors used in a @selector expression. Used for
766 /// implementation of -Wselector.
767 SmallVector<uint64_t, 64> ReferencedSelectorsData;
769 /// \brief A snapshot of Sema's weak undeclared identifier tracking, for
770 /// generating warnings.
771 SmallVector<uint64_t, 64> WeakUndeclaredIdentifiers;
773 /// \brief The IDs of type aliases for ext_vectors that exist in the chain.
775 /// Used by Sema for finding sugared names for ext_vectors in diagnostics.
776 SmallVector<uint64_t, 4> ExtVectorDecls;
780 /// \name Sema-relevant special data
781 /// \brief Fields containing data that is used for semantic analysis
784 /// \brief The IDs of all potentially unused typedef names in the chain.
786 /// Sema tracks these to emit warnings.
787 SmallVector<uint64_t, 16> UnusedLocalTypedefNameCandidates;
789 /// \brief Our current depth in #pragma cuda force_host_device begin/end
791 unsigned ForceCUDAHostDeviceDepth = 0;
793 /// \brief The IDs of the declarations Sema stores directly.
795 /// Sema tracks a few important decls, such as namespace std, directly.
796 SmallVector<uint64_t, 4> SemaDeclRefs;
798 /// \brief The IDs of the types ASTContext stores directly.
800 /// The AST context tracks a few important types, such as va_list, directly.
801 SmallVector<uint64_t, 16> SpecialTypes;
803 /// \brief The IDs of CUDA-specific declarations ASTContext stores directly.
805 /// The AST context tracks a few important decls, currently cudaConfigureCall,
807 SmallVector<uint64_t, 2> CUDASpecialDeclRefs;
809 /// \brief The floating point pragma option settings.
810 SmallVector<uint64_t, 1> FPPragmaOptions;
812 /// \brief The pragma clang optimize location (if the pragma state is "off").
813 SourceLocation OptimizeOffPragmaLocation;
815 /// \brief The PragmaMSStructKind pragma ms_struct state if set, or -1.
816 int PragmaMSStructState = -1;
818 /// \brief The PragmaMSPointersToMembersKind pragma pointers_to_members state.
819 int PragmaMSPointersToMembersState = -1;
820 SourceLocation PointersToMembersPragmaLocation;
822 /// \brief The pragma pack state.
823 Optional<unsigned> PragmaPackCurrentValue;
824 SourceLocation PragmaPackCurrentLocation;
825 struct PragmaPackStackEntry {
827 SourceLocation Location;
830 llvm::SmallVector<PragmaPackStackEntry, 2> PragmaPackStack;
831 llvm::SmallVector<std::string, 2> PragmaPackStrings;
833 /// \brief The OpenCL extension settings.
834 OpenCLOptions OpenCLExtensions;
836 /// \brief Extensions required by an OpenCL type.
837 llvm::DenseMap<const Type *, std::set<std::string>> OpenCLTypeExtMap;
839 /// \brief Extensions required by an OpenCL declaration.
840 llvm::DenseMap<const Decl *, std::set<std::string>> OpenCLDeclExtMap;
842 /// \brief A list of the namespaces we've seen.
843 SmallVector<uint64_t, 4> KnownNamespaces;
845 /// \brief A list of undefined decls with internal linkage followed by the
846 /// SourceLocation of a matching ODR-use.
847 SmallVector<uint64_t, 8> UndefinedButUsed;
849 /// \brief Delete expressions to analyze at the end of translation unit.
850 SmallVector<uint64_t, 8> DelayedDeleteExprs;
852 // \brief A list of late parsed template function data.
853 SmallVector<uint64_t, 1> LateParsedTemplates;
856 struct ImportedSubmodule {
857 serialization::SubmoduleID ID;
858 SourceLocation ImportLoc;
860 ImportedSubmodule(serialization::SubmoduleID ID, SourceLocation ImportLoc)
861 : ID(ID), ImportLoc(ImportLoc) {}
865 /// \brief A list of modules that were imported by precompiled headers or
866 /// any other non-module AST file.
867 SmallVector<ImportedSubmodule, 2> ImportedModules;
870 /// \brief The directory that the PCH we are reading is stored in.
871 std::string CurrentDir;
873 /// \brief The system include root to be used when loading the
874 /// precompiled header.
875 std::string isysroot;
877 /// \brief Whether to disable the normal validation performed on precompiled
878 /// headers when they are loaded.
879 bool DisableValidation;
881 /// \brief Whether to accept an AST file with compiler errors.
882 bool AllowASTWithCompilerErrors;
884 /// \brief Whether to accept an AST file that has a different configuration
885 /// from the current compiler instance.
886 bool AllowConfigurationMismatch;
888 /// \brief Whether validate system input files.
889 bool ValidateSystemInputs;
891 /// \brief Whether we are allowed to use the global module index.
894 /// \brief Whether we have tried loading the global module index yet.
895 bool TriedLoadingGlobalIndex = false;
897 ///\brief Whether we are currently processing update records.
898 bool ProcessingUpdateRecords = false;
900 typedef llvm::DenseMap<unsigned, SwitchCase *> SwitchCaseMapTy;
901 /// \brief Mapping from switch-case IDs in the chain to switch-case statements
903 /// Statements usually don't have IDs, but switch cases need them, so that the
904 /// switch statement can refer to them.
905 SwitchCaseMapTy SwitchCaseStmts;
907 SwitchCaseMapTy *CurrSwitchCaseStmts;
909 /// \brief The number of source location entries de-serialized from
911 unsigned NumSLocEntriesRead = 0;
913 /// \brief The number of source location entries in the chain.
914 unsigned TotalNumSLocEntries = 0;
916 /// \brief The number of statements (and expressions) de-serialized
918 unsigned NumStatementsRead = 0;
920 /// \brief The total number of statements (and expressions) stored
922 unsigned TotalNumStatements = 0;
924 /// \brief The number of macros de-serialized from the chain.
925 unsigned NumMacrosRead = 0;
927 /// \brief The total number of macros stored in the chain.
928 unsigned TotalNumMacros = 0;
930 /// \brief The number of lookups into identifier tables.
931 unsigned NumIdentifierLookups = 0;
933 /// \brief The number of lookups into identifier tables that succeed.
934 unsigned NumIdentifierLookupHits = 0;
936 /// \brief The number of selectors that have been read.
937 unsigned NumSelectorsRead = 0;
939 /// \brief The number of method pool entries that have been read.
940 unsigned NumMethodPoolEntriesRead = 0;
942 /// \brief The number of times we have looked up a selector in the method
944 unsigned NumMethodPoolLookups = 0;
946 /// \brief The number of times we have looked up a selector in the method
947 /// pool and found something.
948 unsigned NumMethodPoolHits = 0;
950 /// \brief The number of times we have looked up a selector in the method
951 /// pool within a specific module.
952 unsigned NumMethodPoolTableLookups = 0;
954 /// \brief The number of times we have looked up a selector in the method
955 /// pool within a specific module and found something.
956 unsigned NumMethodPoolTableHits = 0;
958 /// \brief The total number of method pool entries in the selector table.
959 unsigned TotalNumMethodPoolEntries = 0;
961 /// Number of lexical decl contexts read/total.
962 unsigned NumLexicalDeclContextsRead = 0, TotalLexicalDeclContexts = 0;
964 /// Number of visible decl contexts read/total.
965 unsigned NumVisibleDeclContextsRead = 0, TotalVisibleDeclContexts = 0;
967 /// Total size of modules, in bits, currently loaded
968 uint64_t TotalModulesSizeInBits = 0;
970 /// \brief Number of Decl/types that are currently deserializing.
971 unsigned NumCurrentElementsDeserializing = 0;
973 /// \brief Set true while we are in the process of passing deserialized
974 /// "interesting" decls to consumer inside FinishedDeserializing().
975 /// This is used as a guard to avoid recursively repeating the process of
976 /// passing decls to consumer.
977 bool PassingDeclsToConsumer = false;
979 /// \brief The set of identifiers that were read while the AST reader was
980 /// (recursively) loading declarations.
982 /// The declarations on the identifier chain for these identifiers will be
983 /// loaded once the recursive loading has completed.
984 llvm::MapVector<IdentifierInfo *, SmallVector<uint32_t, 4> >
985 PendingIdentifierInfos;
987 /// \brief The set of lookup results that we have faked in order to support
988 /// merging of partially deserialized decls but that we have not yet removed.
989 llvm::SmallMapVector<IdentifierInfo *, SmallVector<NamedDecl*, 2>, 16>
990 PendingFakeLookupResults;
992 /// \brief The generation number of each identifier, which keeps track of
993 /// the last time we loaded information about this identifier.
994 llvm::DenseMap<IdentifierInfo *, unsigned> IdentifierGeneration;
996 class InterestingDecl {
998 bool DeclHasPendingBody;
1001 InterestingDecl(Decl *D, bool HasBody)
1002 : D(D), DeclHasPendingBody(HasBody) {}
1003 Decl *getDecl() { return D; }
1004 /// Whether the declaration has a pending body.
1005 bool hasPendingBody() { return DeclHasPendingBody; }
1008 /// \brief Contains declarations and definitions that could be
1009 /// "interesting" to the ASTConsumer, when we get that AST consumer.
1011 /// "Interesting" declarations are those that have data that may
1012 /// need to be emitted, such as inline function definitions or
1013 /// Objective-C protocols.
1014 std::deque<InterestingDecl> PotentiallyInterestingDecls;
1016 /// \brief The list of redeclaration chains that still need to be
1017 /// reconstructed, and the local offset to the corresponding list
1018 /// of redeclarations.
1019 SmallVector<std::pair<Decl *, uint64_t>, 16> PendingDeclChains;
1021 /// \brief The list of canonical declarations whose redeclaration chains
1022 /// need to be marked as incomplete once we're done deserializing things.
1023 SmallVector<Decl *, 16> PendingIncompleteDeclChains;
1025 /// \brief The Decl IDs for the Sema/Lexical DeclContext of a Decl that has
1026 /// been loaded but its DeclContext was not set yet.
1027 struct PendingDeclContextInfo {
1029 serialization::GlobalDeclID SemaDC;
1030 serialization::GlobalDeclID LexicalDC;
1033 /// \brief The set of Decls that have been loaded but their DeclContexts are
1036 /// The DeclContexts for these Decls will be set once recursive loading has
1038 std::deque<PendingDeclContextInfo> PendingDeclContextInfos;
1040 /// \brief The set of NamedDecls that have been loaded, but are members of a
1041 /// context that has been merged into another context where the corresponding
1042 /// declaration is either missing or has not yet been loaded.
1044 /// We will check whether the corresponding declaration is in fact missing
1045 /// once recursing loading has been completed.
1046 llvm::SmallVector<NamedDecl *, 16> PendingOdrMergeChecks;
1048 /// \brief Record definitions in which we found an ODR violation.
1049 llvm::SmallDenseMap<CXXRecordDecl *, llvm::TinyPtrVector<CXXRecordDecl *>, 2>
1050 PendingOdrMergeFailures;
1052 /// \brief DeclContexts in which we have diagnosed an ODR violation.
1053 llvm::SmallPtrSet<DeclContext*, 2> DiagnosedOdrMergeFailures;
1055 /// \brief The set of Objective-C categories that have been deserialized
1056 /// since the last time the declaration chains were linked.
1057 llvm::SmallPtrSet<ObjCCategoryDecl *, 16> CategoriesDeserialized;
1059 /// \brief The set of Objective-C class definitions that have already been
1060 /// loaded, for which we will need to check for categories whenever a new
1061 /// module is loaded.
1062 SmallVector<ObjCInterfaceDecl *, 16> ObjCClassesLoaded;
1064 typedef llvm::DenseMap<Decl *, SmallVector<serialization::DeclID, 2> >
1067 /// \brief A mapping from canonical declarations to the set of global
1068 /// declaration IDs for key declaration that have been merged with that
1069 /// canonical declaration. A key declaration is a formerly-canonical
1070 /// declaration whose module did not import any other key declaration for that
1071 /// entity. These are the IDs that we use as keys when finding redecl chains.
1072 KeyDeclsMap KeyDecls;
1074 /// \brief A mapping from DeclContexts to the semantic DeclContext that we
1075 /// are treating as the definition of the entity. This is used, for instance,
1076 /// when merging implicit instantiations of class templates across modules.
1077 llvm::DenseMap<DeclContext *, DeclContext *> MergedDeclContexts;
1079 /// \brief A mapping from canonical declarations of enums to their canonical
1080 /// definitions. Only populated when using modules in C++.
1081 llvm::DenseMap<EnumDecl *, EnumDecl *> EnumDefinitions;
1083 /// \brief When reading a Stmt tree, Stmt operands are placed in this stack.
1084 SmallVector<Stmt *, 16> StmtStack;
1086 /// \brief What kind of records we are reading.
1088 Read_None, Read_Decl, Read_Type, Read_Stmt
1091 /// \brief What kind of records we are reading.
1092 ReadingKind ReadingKind = Read_None;
1094 /// \brief RAII object to change the reading kind.
1095 class ReadingKindTracker {
1097 enum ReadingKind PrevKind;
1099 ReadingKindTracker(const ReadingKindTracker &) = delete;
1100 void operator=(const ReadingKindTracker &) = delete;
1103 ReadingKindTracker(enum ReadingKind newKind, ASTReader &reader)
1104 : Reader(reader), PrevKind(Reader.ReadingKind) {
1105 Reader.ReadingKind = newKind;
1108 ~ReadingKindTracker() { Reader.ReadingKind = PrevKind; }
1111 /// \brief RAII object to mark the start of processing updates.
1112 class ProcessingUpdatesRAIIObj {
1116 ProcessingUpdatesRAIIObj(const ProcessingUpdatesRAIIObj &) = delete;
1117 void operator=(const ProcessingUpdatesRAIIObj &) = delete;
1120 ProcessingUpdatesRAIIObj(ASTReader &reader)
1121 : Reader(reader), PrevState(Reader.ProcessingUpdateRecords) {
1122 Reader.ProcessingUpdateRecords = true;
1125 ~ProcessingUpdatesRAIIObj() { Reader.ProcessingUpdateRecords = PrevState; }
1128 /// \brief Suggested contents of the predefines buffer, after this
1129 /// PCH file has been processed.
1131 /// In most cases, this string will be empty, because the predefines
1132 /// buffer computed to build the PCH file will be identical to the
1133 /// predefines buffer computed from the command line. However, when
1134 /// there are differences that the PCH reader can work around, this
1135 /// predefines buffer may contain additional definitions.
1136 std::string SuggestedPredefines;
1138 llvm::DenseMap<const Decl *, bool> BodySource;
1140 /// \brief Reads a statement from the specified cursor.
1141 Stmt *ReadStmtFromStream(ModuleFile &F);
1143 struct InputFileInfo {
1144 std::string Filename;
1149 bool TopLevelModuleMap;
1152 /// \brief Reads the stored information about an input file.
1153 InputFileInfo readInputFileInfo(ModuleFile &F, unsigned ID);
1155 /// \brief Retrieve the file entry and 'overridden' bit for an input
1156 /// file in the given module file.
1157 serialization::InputFile getInputFile(ModuleFile &F, unsigned ID,
1158 bool Complain = true);
1161 void ResolveImportedPath(ModuleFile &M, std::string &Filename);
1162 static void ResolveImportedPath(std::string &Filename, StringRef Prefix);
1164 /// \brief Returns the first key declaration for the given declaration. This
1165 /// is one that is formerly-canonical (or still canonical) and whose module
1166 /// did not import any other key declaration of the entity.
1167 Decl *getKeyDeclaration(Decl *D) {
1168 D = D->getCanonicalDecl();
1169 if (D->isFromASTFile())
1172 auto I = KeyDecls.find(D);
1173 if (I == KeyDecls.end() || I->second.empty())
1175 return GetExistingDecl(I->second[0]);
1177 const Decl *getKeyDeclaration(const Decl *D) {
1178 return getKeyDeclaration(const_cast<Decl*>(D));
1181 /// \brief Run a callback on each imported key declaration of \p D.
1182 template <typename Fn>
1183 void forEachImportedKeyDecl(const Decl *D, Fn Visit) {
1184 D = D->getCanonicalDecl();
1185 if (D->isFromASTFile())
1188 auto It = KeyDecls.find(const_cast<Decl*>(D));
1189 if (It != KeyDecls.end())
1190 for (auto ID : It->second)
1191 Visit(GetExistingDecl(ID));
1194 /// \brief Get the loaded lookup tables for \p Primary, if any.
1195 const serialization::reader::DeclContextLookupTable *
1196 getLoadedLookupTables(DeclContext *Primary) const;
1199 struct ImportedModule {
1201 ModuleFile *ImportedBy;
1202 SourceLocation ImportLoc;
1204 ImportedModule(ModuleFile *Mod,
1205 ModuleFile *ImportedBy,
1206 SourceLocation ImportLoc)
1207 : Mod(Mod), ImportedBy(ImportedBy), ImportLoc(ImportLoc) { }
1210 ASTReadResult ReadASTCore(StringRef FileName, ModuleKind Type,
1211 SourceLocation ImportLoc, ModuleFile *ImportedBy,
1212 SmallVectorImpl<ImportedModule> &Loaded,
1213 off_t ExpectedSize, time_t ExpectedModTime,
1214 ASTFileSignature ExpectedSignature,
1215 unsigned ClientLoadCapabilities);
1216 ASTReadResult ReadControlBlock(ModuleFile &F,
1217 SmallVectorImpl<ImportedModule> &Loaded,
1218 const ModuleFile *ImportedBy,
1219 unsigned ClientLoadCapabilities);
1220 static ASTReadResult ReadOptionsBlock(
1221 llvm::BitstreamCursor &Stream, unsigned ClientLoadCapabilities,
1222 bool AllowCompatibleConfigurationMismatch, ASTReaderListener &Listener,
1223 std::string &SuggestedPredefines);
1225 /// Read the unhashed control block.
1227 /// This has no effect on \c F.Stream, instead creating a fresh cursor from
1228 /// \c F.Data and reading ahead.
1229 ASTReadResult readUnhashedControlBlock(ModuleFile &F, bool WasImportedBy,
1230 unsigned ClientLoadCapabilities);
1232 static ASTReadResult
1233 readUnhashedControlBlockImpl(ModuleFile *F, llvm::StringRef StreamData,
1234 unsigned ClientLoadCapabilities,
1235 bool AllowCompatibleConfigurationMismatch,
1236 ASTReaderListener *Listener,
1237 bool ValidateDiagnosticOptions);
1239 ASTReadResult ReadASTBlock(ModuleFile &F, unsigned ClientLoadCapabilities);
1240 ASTReadResult ReadExtensionBlock(ModuleFile &F);
1241 void ReadModuleOffsetMap(ModuleFile &F) const;
1242 bool ParseLineTable(ModuleFile &F, const RecordData &Record);
1243 bool ReadSourceManagerBlock(ModuleFile &F);
1244 llvm::BitstreamCursor &SLocCursorForID(int ID);
1245 SourceLocation getImportLocation(ModuleFile *F);
1246 ASTReadResult ReadModuleMapFileBlock(RecordData &Record, ModuleFile &F,
1247 const ModuleFile *ImportedBy,
1248 unsigned ClientLoadCapabilities);
1249 ASTReadResult ReadSubmoduleBlock(ModuleFile &F,
1250 unsigned ClientLoadCapabilities);
1251 static bool ParseLanguageOptions(const RecordData &Record, bool Complain,
1252 ASTReaderListener &Listener,
1253 bool AllowCompatibleDifferences);
1254 static bool ParseTargetOptions(const RecordData &Record, bool Complain,
1255 ASTReaderListener &Listener,
1256 bool AllowCompatibleDifferences);
1257 static bool ParseDiagnosticOptions(const RecordData &Record, bool Complain,
1258 ASTReaderListener &Listener);
1259 static bool ParseFileSystemOptions(const RecordData &Record, bool Complain,
1260 ASTReaderListener &Listener);
1261 static bool ParseHeaderSearchOptions(const RecordData &Record, bool Complain,
1262 ASTReaderListener &Listener);
1263 static bool ParsePreprocessorOptions(const RecordData &Record, bool Complain,
1264 ASTReaderListener &Listener,
1265 std::string &SuggestedPredefines);
1267 struct RecordLocation {
1268 RecordLocation(ModuleFile *M, uint64_t O)
1269 : F(M), Offset(O) {}
1274 QualType readTypeRecord(unsigned Index);
1275 void readExceptionSpec(ModuleFile &ModuleFile,
1276 SmallVectorImpl<QualType> &ExceptionStorage,
1277 FunctionProtoType::ExceptionSpecInfo &ESI,
1278 const RecordData &Record, unsigned &Index);
1279 RecordLocation TypeCursorForIndex(unsigned Index);
1280 void LoadedDecl(unsigned Index, Decl *D);
1281 Decl *ReadDeclRecord(serialization::DeclID ID);
1282 void markIncompleteDeclChain(Decl *Canon);
1284 /// \brief Returns the most recent declaration of a declaration (which must be
1285 /// of a redeclarable kind) that is either local or has already been loaded
1286 /// merged into its redecl chain.
1287 Decl *getMostRecentExistingDecl(Decl *D);
1289 RecordLocation DeclCursorForID(serialization::DeclID ID,
1290 SourceLocation &Location);
1291 void loadDeclUpdateRecords(PendingUpdateRecord &Record);
1292 void loadPendingDeclChain(Decl *D, uint64_t LocalOffset);
1293 void loadObjCCategories(serialization::GlobalDeclID ID, ObjCInterfaceDecl *D,
1294 unsigned PreviousGeneration = 0);
1296 RecordLocation getLocalBitOffset(uint64_t GlobalOffset);
1297 uint64_t getGlobalBitOffset(ModuleFile &M, uint32_t LocalOffset);
1299 /// \brief Returns the first preprocessed entity ID that begins or ends after
1301 serialization::PreprocessedEntityID
1302 findPreprocessedEntity(SourceLocation Loc, bool EndsAfter) const;
1304 /// \brief Find the next module that contains entities and return the ID
1305 /// of the first entry.
1307 /// \param SLocMapI points at a chunk of a module that contains no
1308 /// preprocessed entities or the entities it contains are not the
1309 /// ones we are looking for.
1310 serialization::PreprocessedEntityID
1311 findNextPreprocessedEntity(
1312 GlobalSLocOffsetMapType::const_iterator SLocMapI) const;
1314 /// \brief Returns (ModuleFile, Local index) pair for \p GlobalIndex of a
1315 /// preprocessed entity.
1316 std::pair<ModuleFile *, unsigned>
1317 getModulePreprocessedEntity(unsigned GlobalIndex);
1319 /// \brief Returns (begin, end) pair for the preprocessed entities of a
1320 /// particular module.
1321 llvm::iterator_range<PreprocessingRecord::iterator>
1322 getModulePreprocessedEntities(ModuleFile &Mod) const;
1325 class ModuleDeclIterator
1326 : public llvm::iterator_adaptor_base<
1327 ModuleDeclIterator, const serialization::LocalDeclID *,
1328 std::random_access_iterator_tag, const Decl *, ptrdiff_t,
1329 const Decl *, const Decl *> {
1334 ModuleDeclIterator()
1335 : iterator_adaptor_base(nullptr), Reader(nullptr), Mod(nullptr) {}
1337 ModuleDeclIterator(ASTReader *Reader, ModuleFile *Mod,
1338 const serialization::LocalDeclID *Pos)
1339 : iterator_adaptor_base(Pos), Reader(Reader), Mod(Mod) {}
1341 value_type operator*() const {
1342 return Reader->GetDecl(Reader->getGlobalDeclID(*Mod, *I));
1344 value_type operator->() const { return **this; }
1346 bool operator==(const ModuleDeclIterator &RHS) const {
1347 assert(Reader == RHS.Reader && Mod == RHS.Mod);
1352 llvm::iterator_range<ModuleDeclIterator>
1353 getModuleFileLevelDecls(ModuleFile &Mod);
1356 void PassInterestingDeclsToConsumer();
1357 void PassInterestingDeclToConsumer(Decl *D);
1359 void finishPendingActions();
1360 void diagnoseOdrViolations();
1362 void pushExternalDeclIntoScope(NamedDecl *D, DeclarationName Name);
1364 void addPendingDeclContextInfo(Decl *D,
1365 serialization::GlobalDeclID SemaDC,
1366 serialization::GlobalDeclID LexicalDC) {
1368 PendingDeclContextInfo Info = { D, SemaDC, LexicalDC };
1369 PendingDeclContextInfos.push_back(Info);
1372 /// \brief Produce an error diagnostic and return true.
1374 /// This routine should only be used for fatal errors that have to
1375 /// do with non-routine failures (e.g., corrupted AST file).
1376 void Error(StringRef Msg) const;
1377 void Error(unsigned DiagID, StringRef Arg1 = StringRef(),
1378 StringRef Arg2 = StringRef()) const;
1380 ASTReader(const ASTReader &) = delete;
1381 void operator=(const ASTReader &) = delete;
1383 /// \brief Load the AST file and validate its contents against the given
1386 /// \param PP the preprocessor associated with the context in which this
1387 /// precompiled header will be loaded.
1389 /// \param Context the AST context that this precompiled header will be
1390 /// loaded into, if any.
1392 /// \param PCHContainerRdr the PCHContainerOperations to use for loading and
1393 /// creating modules.
1395 /// \param Extensions the list of module file extensions that can be loaded
1396 /// from the AST files.
1398 /// \param isysroot If non-NULL, the system include path specified by the
1399 /// user. This is only used with relocatable PCH files. If non-NULL,
1400 /// a relocatable PCH file will use the default path "/".
1402 /// \param DisableValidation If true, the AST reader will suppress most
1403 /// of its regular consistency checking, allowing the use of precompiled
1404 /// headers that cannot be determined to be compatible.
1406 /// \param AllowASTWithCompilerErrors If true, the AST reader will accept an
1407 /// AST file the was created out of an AST with compiler errors,
1408 /// otherwise it will reject it.
1410 /// \param AllowConfigurationMismatch If true, the AST reader will not check
1411 /// for configuration differences between the AST file and the invocation.
1413 /// \param ValidateSystemInputs If true, the AST reader will validate
1414 /// system input files in addition to user input files. This is only
1415 /// meaningful if \p DisableValidation is false.
1417 /// \param UseGlobalIndex If true, the AST reader will try to load and use
1418 /// the global module index.
1420 /// \param ReadTimer If non-null, a timer used to track the time spent
1422 ASTReader(Preprocessor &PP, ASTContext *Context,
1423 const PCHContainerReader &PCHContainerRdr,
1424 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
1425 StringRef isysroot = "", bool DisableValidation = false,
1426 bool AllowASTWithCompilerErrors = false,
1427 bool AllowConfigurationMismatch = false,
1428 bool ValidateSystemInputs = false, bool UseGlobalIndex = true,
1429 std::unique_ptr<llvm::Timer> ReadTimer = {});
1431 ~ASTReader() override;
1433 SourceManager &getSourceManager() const { return SourceMgr; }
1434 FileManager &getFileManager() const { return FileMgr; }
1435 DiagnosticsEngine &getDiags() const { return Diags; }
1437 /// \brief Flags that indicate what kind of AST loading failures the client
1438 /// of the AST reader can directly handle.
1440 /// When a client states that it can handle a particular kind of failure,
1441 /// the AST reader will not emit errors when producing that kind of failure.
1442 enum LoadFailureCapabilities {
1443 /// \brief The client can't handle any AST loading failures.
1445 /// \brief The client can handle an AST file that cannot load because it
1448 /// \brief The client can handle an AST file that cannot load because it
1449 /// is out-of-date relative to its input files.
1450 ARR_OutOfDate = 0x2,
1451 /// \brief The client can handle an AST file that cannot load because it
1452 /// was built with a different version of Clang.
1453 ARR_VersionMismatch = 0x4,
1454 /// \brief The client can handle an AST file that cannot load because it's
1455 /// compiled configuration doesn't match that of the context it was
1457 ARR_ConfigurationMismatch = 0x8
1460 /// \brief Load the AST file designated by the given file name.
1462 /// \param FileName The name of the AST file to load.
1464 /// \param Type The kind of AST being loaded, e.g., PCH, module, main file,
1467 /// \param ImportLoc the location where the module file will be considered as
1468 /// imported from. For non-module AST types it should be invalid.
1470 /// \param ClientLoadCapabilities The set of client load-failure
1471 /// capabilities, represented as a bitset of the enumerators of
1472 /// LoadFailureCapabilities.
1474 /// \param Imported optional out-parameter to append the list of modules
1475 /// that were imported by precompiled headers or any other non-module AST file
1476 ASTReadResult ReadAST(StringRef FileName, ModuleKind Type,
1477 SourceLocation ImportLoc,
1478 unsigned ClientLoadCapabilities,
1479 SmallVectorImpl<ImportedSubmodule> *Imported = nullptr);
1481 /// \brief Make the entities in the given module and any of its (non-explicit)
1482 /// submodules visible to name lookup.
1484 /// \param Mod The module whose names should be made visible.
1486 /// \param NameVisibility The level of visibility to give the names in the
1487 /// module. Visibility can only be increased over time.
1489 /// \param ImportLoc The location at which the import occurs.
1490 void makeModuleVisible(Module *Mod,
1491 Module::NameVisibilityKind NameVisibility,
1492 SourceLocation ImportLoc);
1494 /// \brief Make the names within this set of hidden names visible.
1495 void makeNamesVisible(const HiddenNames &Names, Module *Owner);
1497 /// \brief Note that MergedDef is a redefinition of the canonical definition
1498 /// Def, so Def should be visible whenever MergedDef is.
1499 void mergeDefinitionVisibility(NamedDecl *Def, NamedDecl *MergedDef);
1501 /// \brief Take the AST callbacks listener.
1502 std::unique_ptr<ASTReaderListener> takeListener() {
1503 return std::move(Listener);
1506 /// \brief Set the AST callbacks listener.
1507 void setListener(std::unique_ptr<ASTReaderListener> Listener) {
1508 this->Listener = std::move(Listener);
1511 /// \brief Add an AST callback listener.
1513 /// Takes ownership of \p L.
1514 void addListener(std::unique_ptr<ASTReaderListener> L) {
1516 L = llvm::make_unique<ChainedASTReaderListener>(std::move(L),
1517 std::move(Listener));
1518 Listener = std::move(L);
1521 /// RAII object to temporarily add an AST callback listener.
1522 class ListenerScope {
1527 ListenerScope(ASTReader &Reader, std::unique_ptr<ASTReaderListener> L)
1528 : Reader(Reader), Chained(false) {
1529 auto Old = Reader.takeListener();
1532 L = llvm::make_unique<ChainedASTReaderListener>(std::move(L),
1535 Reader.setListener(std::move(L));
1538 auto New = Reader.takeListener();
1540 Reader.setListener(static_cast<ChainedASTReaderListener *>(New.get())
1545 /// \brief Set the AST deserialization listener.
1546 void setDeserializationListener(ASTDeserializationListener *Listener,
1547 bool TakeOwnership = false);
1549 /// \brief Determine whether this AST reader has a global index.
1550 bool hasGlobalIndex() const { return (bool)GlobalIndex; }
1552 /// \brief Return global module index.
1553 GlobalModuleIndex *getGlobalIndex() { return GlobalIndex.get(); }
1555 /// \brief Reset reader for a reload try.
1556 void resetForReload() { TriedLoadingGlobalIndex = false; }
1558 /// \brief Attempts to load the global index.
1560 /// \returns true if loading the global index has failed for any reason.
1561 bool loadGlobalIndex();
1563 /// \brief Determine whether we tried to load the global index, but failed,
1564 /// e.g., because it is out-of-date or does not exist.
1565 bool isGlobalIndexUnavailable() const;
1567 /// \brief Initializes the ASTContext
1568 void InitializeContext();
1570 /// \brief Update the state of Sema after loading some additional modules.
1573 /// \brief Add in-memory (virtual file) buffer.
1574 void addInMemoryBuffer(StringRef &FileName,
1575 std::unique_ptr<llvm::MemoryBuffer> Buffer) {
1576 ModuleMgr.addInMemoryBuffer(FileName, std::move(Buffer));
1579 /// \brief Finalizes the AST reader's state before writing an AST file to
1582 /// This operation may undo temporary state in the AST that should not be
1584 void finalizeForWriting();
1586 /// \brief Retrieve the module manager.
1587 ModuleManager &getModuleManager() { return ModuleMgr; }
1589 /// \brief Retrieve the preprocessor.
1590 Preprocessor &getPreprocessor() const { return PP; }
1592 /// \brief Retrieve the name of the original source file name for the primary
1594 StringRef getOriginalSourceFile() {
1595 return ModuleMgr.getPrimaryModule().OriginalSourceFileName;
1598 /// \brief Retrieve the name of the original source file name directly from
1599 /// the AST file, without actually loading the AST file.
1601 getOriginalSourceFile(const std::string &ASTFileName, FileManager &FileMgr,
1602 const PCHContainerReader &PCHContainerRdr,
1603 DiagnosticsEngine &Diags);
1605 /// \brief Read the control block for the named AST file.
1607 /// \returns true if an error occurred, false otherwise.
1609 readASTFileControlBlock(StringRef Filename, FileManager &FileMgr,
1610 const PCHContainerReader &PCHContainerRdr,
1611 bool FindModuleFileExtensions,
1612 ASTReaderListener &Listener,
1613 bool ValidateDiagnosticOptions);
1615 /// \brief Determine whether the given AST file is acceptable to load into a
1616 /// translation unit with the given language and target options.
1617 static bool isAcceptableASTFile(StringRef Filename, FileManager &FileMgr,
1618 const PCHContainerReader &PCHContainerRdr,
1619 const LangOptions &LangOpts,
1620 const TargetOptions &TargetOpts,
1621 const PreprocessorOptions &PPOpts,
1622 StringRef ExistingModuleCachePath);
1624 /// \brief Returns the suggested contents of the predefines buffer,
1625 /// which contains a (typically-empty) subset of the predefines
1626 /// build prior to including the precompiled header.
1627 const std::string &getSuggestedPredefines() { return SuggestedPredefines; }
1629 /// \brief Read a preallocated preprocessed entity from the external source.
1631 /// \returns null if an error occurred that prevented the preprocessed
1632 /// entity from being loaded.
1633 PreprocessedEntity *ReadPreprocessedEntity(unsigned Index) override;
1635 /// \brief Returns a pair of [Begin, End) indices of preallocated
1636 /// preprocessed entities that \p Range encompasses.
1637 std::pair<unsigned, unsigned>
1638 findPreprocessedEntitiesInRange(SourceRange Range) override;
1640 /// \brief Optionally returns true or false if the preallocated preprocessed
1641 /// entity with index \p Index came from file \p FID.
1642 Optional<bool> isPreprocessedEntityInFileID(unsigned Index,
1643 FileID FID) override;
1645 /// \brief Read the header file information for the given file entry.
1646 HeaderFileInfo GetHeaderFileInfo(const FileEntry *FE) override;
1648 void ReadPragmaDiagnosticMappings(DiagnosticsEngine &Diag);
1650 /// \brief Returns the number of source locations found in the chain.
1651 unsigned getTotalNumSLocs() const {
1652 return TotalNumSLocEntries;
1655 /// \brief Returns the number of identifiers found in the chain.
1656 unsigned getTotalNumIdentifiers() const {
1657 return static_cast<unsigned>(IdentifiersLoaded.size());
1660 /// \brief Returns the number of macros found in the chain.
1661 unsigned getTotalNumMacros() const {
1662 return static_cast<unsigned>(MacrosLoaded.size());
1665 /// \brief Returns the number of types found in the chain.
1666 unsigned getTotalNumTypes() const {
1667 return static_cast<unsigned>(TypesLoaded.size());
1670 /// \brief Returns the number of declarations found in the chain.
1671 unsigned getTotalNumDecls() const {
1672 return static_cast<unsigned>(DeclsLoaded.size());
1675 /// \brief Returns the number of submodules known.
1676 unsigned getTotalNumSubmodules() const {
1677 return static_cast<unsigned>(SubmodulesLoaded.size());
1680 /// \brief Returns the number of selectors found in the chain.
1681 unsigned getTotalNumSelectors() const {
1682 return static_cast<unsigned>(SelectorsLoaded.size());
1685 /// \brief Returns the number of preprocessed entities known to the AST
1687 unsigned getTotalNumPreprocessedEntities() const {
1688 unsigned Result = 0;
1689 for (const auto &M : ModuleMgr)
1690 Result += M.NumPreprocessedEntities;
1694 /// \brief Reads a TemplateArgumentLocInfo appropriate for the
1695 /// given TemplateArgument kind.
1696 TemplateArgumentLocInfo
1697 GetTemplateArgumentLocInfo(ModuleFile &F, TemplateArgument::ArgKind Kind,
1698 const RecordData &Record, unsigned &Idx);
1700 /// \brief Reads a TemplateArgumentLoc.
1702 ReadTemplateArgumentLoc(ModuleFile &F,
1703 const RecordData &Record, unsigned &Idx);
1705 const ASTTemplateArgumentListInfo*
1706 ReadASTTemplateArgumentListInfo(ModuleFile &F,
1707 const RecordData &Record, unsigned &Index);
1709 /// \brief Reads a declarator info from the given record.
1710 TypeSourceInfo *GetTypeSourceInfo(ModuleFile &F,
1711 const RecordData &Record, unsigned &Idx);
1713 /// \brief Resolve a type ID into a type, potentially building a new
1715 QualType GetType(serialization::TypeID ID);
1717 /// \brief Resolve a local type ID within a given AST file into a type.
1718 QualType getLocalType(ModuleFile &F, unsigned LocalID);
1720 /// \brief Map a local type ID within a given AST file into a global type ID.
1721 serialization::TypeID getGlobalTypeID(ModuleFile &F, unsigned LocalID) const;
1723 /// \brief Read a type from the current position in the given record, which
1724 /// was read from the given AST file.
1725 QualType readType(ModuleFile &F, const RecordData &Record, unsigned &Idx) {
1726 if (Idx >= Record.size())
1729 return getLocalType(F, Record[Idx++]);
1732 /// \brief Map from a local declaration ID within a given module to a
1733 /// global declaration ID.
1734 serialization::DeclID getGlobalDeclID(ModuleFile &F,
1735 serialization::LocalDeclID LocalID) const;
1737 /// \brief Returns true if global DeclID \p ID originated from module \p M.
1738 bool isDeclIDFromModule(serialization::GlobalDeclID ID, ModuleFile &M) const;
1740 /// \brief Retrieve the module file that owns the given declaration, or NULL
1741 /// if the declaration is not from a module file.
1742 ModuleFile *getOwningModuleFile(const Decl *D);
1744 /// \brief Get the best name we know for the module that owns the given
1745 /// declaration, or an empty string if the declaration is not from a module.
1746 std::string getOwningModuleNameForDiagnostic(const Decl *D);
1748 /// \brief Returns the source location for the decl \p ID.
1749 SourceLocation getSourceLocationForDeclID(serialization::GlobalDeclID ID);
1751 /// \brief Resolve a declaration ID into a declaration, potentially
1752 /// building a new declaration.
1753 Decl *GetDecl(serialization::DeclID ID);
1754 Decl *GetExternalDecl(uint32_t ID) override;
1756 /// \brief Resolve a declaration ID into a declaration. Return 0 if it's not
1757 /// been loaded yet.
1758 Decl *GetExistingDecl(serialization::DeclID ID);
1760 /// \brief Reads a declaration with the given local ID in the given module.
1761 Decl *GetLocalDecl(ModuleFile &F, uint32_t LocalID) {
1762 return GetDecl(getGlobalDeclID(F, LocalID));
1765 /// \brief Reads a declaration with the given local ID in the given module.
1767 /// \returns The requested declaration, casted to the given return type.
1768 template<typename T>
1769 T *GetLocalDeclAs(ModuleFile &F, uint32_t LocalID) {
1770 return cast_or_null<T>(GetLocalDecl(F, LocalID));
1773 /// \brief Map a global declaration ID into the declaration ID used to
1774 /// refer to this declaration within the given module fule.
1776 /// \returns the global ID of the given declaration as known in the given
1778 serialization::DeclID
1779 mapGlobalIDToModuleFileGlobalID(ModuleFile &M,
1780 serialization::DeclID GlobalID);
1782 /// \brief Reads a declaration ID from the given position in a record in the
1785 /// \returns The declaration ID read from the record, adjusted to a global ID.
1786 serialization::DeclID ReadDeclID(ModuleFile &F, const RecordData &Record,
1789 /// \brief Reads a declaration from the given position in a record in the
1791 Decl *ReadDecl(ModuleFile &F, const RecordData &R, unsigned &I) {
1792 return GetDecl(ReadDeclID(F, R, I));
1795 /// \brief Reads a declaration from the given position in a record in the
1798 /// \returns The declaration read from this location, casted to the given
1800 template<typename T>
1801 T *ReadDeclAs(ModuleFile &F, const RecordData &R, unsigned &I) {
1802 return cast_or_null<T>(GetDecl(ReadDeclID(F, R, I)));
1805 /// \brief If any redeclarations of \p D have been imported since it was
1806 /// last checked, this digs out those redeclarations and adds them to the
1807 /// redeclaration chain for \p D.
1808 void CompleteRedeclChain(const Decl *D) override;
1810 CXXBaseSpecifier *GetExternalCXXBaseSpecifiers(uint64_t Offset) override;
1812 /// \brief Resolve the offset of a statement into a statement.
1814 /// This operation will read a new statement from the external
1815 /// source each time it is called, and is meant to be used via a
1816 /// LazyOffsetPtr (which is used by Decls for the body of functions, etc).
1817 Stmt *GetExternalDeclStmt(uint64_t Offset) override;
1819 /// ReadBlockAbbrevs - Enter a subblock of the specified BlockID with the
1820 /// specified cursor. Read the abbreviations that are at the top of the block
1821 /// and then leave the cursor pointing into the block.
1822 static bool ReadBlockAbbrevs(llvm::BitstreamCursor &Cursor, unsigned BlockID);
1824 /// \brief Finds all the visible declarations with a given name.
1825 /// The current implementation of this method just loads the entire
1826 /// lookup table as unmaterialized references.
1827 bool FindExternalVisibleDeclsByName(const DeclContext *DC,
1828 DeclarationName Name) override;
1830 /// \brief Read all of the declarations lexically stored in a
1831 /// declaration context.
1833 /// \param DC The declaration context whose declarations will be
1836 /// \param IsKindWeWant A predicate indicating which declaration kinds
1837 /// we are interested in.
1839 /// \param Decls Vector that will contain the declarations loaded
1840 /// from the external source. The caller is responsible for merging
1841 /// these declarations with any declarations already stored in the
1842 /// declaration context.
1844 FindExternalLexicalDecls(const DeclContext *DC,
1845 llvm::function_ref<bool(Decl::Kind)> IsKindWeWant,
1846 SmallVectorImpl<Decl *> &Decls) override;
1848 /// \brief Get the decls that are contained in a file in the Offset/Length
1849 /// range. \p Length can be 0 to indicate a point at \p Offset instead of
1851 void FindFileRegionDecls(FileID File, unsigned Offset, unsigned Length,
1852 SmallVectorImpl<Decl *> &Decls) override;
1854 /// \brief Notify ASTReader that we started deserialization of
1855 /// a decl or type so until FinishedDeserializing is called there may be
1856 /// decls that are initializing. Must be paired with FinishedDeserializing.
1857 void StartedDeserializing() override;
1859 /// \brief Notify ASTReader that we finished the deserialization of
1860 /// a decl or type. Must be paired with StartedDeserializing.
1861 void FinishedDeserializing() override;
1863 /// \brief Function that will be invoked when we begin parsing a new
1864 /// translation unit involving this external AST source.
1866 /// This function will provide all of the external definitions to
1867 /// the ASTConsumer.
1868 void StartTranslationUnit(ASTConsumer *Consumer) override;
1870 /// \brief Print some statistics about AST usage.
1871 void PrintStats() override;
1873 /// \brief Dump information about the AST reader to standard error.
1876 /// Return the amount of memory used by memory buffers, breaking down
1877 /// by heap-backed versus mmap'ed memory.
1878 void getMemoryBufferSizes(MemoryBufferSizes &sizes) const override;
1880 /// \brief Initialize the semantic source with the Sema instance
1881 /// being used to perform semantic analysis on the abstract syntax
1883 void InitializeSema(Sema &S) override;
1885 /// \brief Inform the semantic consumer that Sema is no longer available.
1886 void ForgetSema() override { SemaObj = nullptr; }
1888 /// \brief Retrieve the IdentifierInfo for the named identifier.
1890 /// This routine builds a new IdentifierInfo for the given identifier. If any
1891 /// declarations with this name are visible from translation unit scope, their
1892 /// declarations will be deserialized and introduced into the declaration
1893 /// chain of the identifier.
1894 IdentifierInfo *get(StringRef Name) override;
1896 /// \brief Retrieve an iterator into the set of all identifiers
1897 /// in all loaded AST files.
1898 IdentifierIterator *getIdentifiers() override;
1900 /// \brief Load the contents of the global method pool for a given
1902 void ReadMethodPool(Selector Sel) override;
1904 /// Load the contents of the global method pool for a given
1905 /// selector if necessary.
1906 void updateOutOfDateSelector(Selector Sel) override;
1908 /// \brief Load the set of namespaces that are known to the external source,
1909 /// which will be used during typo correction.
1910 void ReadKnownNamespaces(
1911 SmallVectorImpl<NamespaceDecl *> &Namespaces) override;
1913 void ReadUndefinedButUsed(
1914 llvm::MapVector<NamedDecl *, SourceLocation> &Undefined) override;
1916 void ReadMismatchingDeleteExpressions(llvm::MapVector<
1917 FieldDecl *, llvm::SmallVector<std::pair<SourceLocation, bool>, 4>> &
1920 void ReadTentativeDefinitions(
1921 SmallVectorImpl<VarDecl *> &TentativeDefs) override;
1923 void ReadUnusedFileScopedDecls(
1924 SmallVectorImpl<const DeclaratorDecl *> &Decls) override;
1926 void ReadDelegatingConstructors(
1927 SmallVectorImpl<CXXConstructorDecl *> &Decls) override;
1929 void ReadExtVectorDecls(SmallVectorImpl<TypedefNameDecl *> &Decls) override;
1931 void ReadUnusedLocalTypedefNameCandidates(
1932 llvm::SmallSetVector<const TypedefNameDecl *, 4> &Decls) override;
1934 void ReadReferencedSelectors(
1935 SmallVectorImpl<std::pair<Selector, SourceLocation> > &Sels) override;
1937 void ReadWeakUndeclaredIdentifiers(
1938 SmallVectorImpl<std::pair<IdentifierInfo *, WeakInfo> > &WI) override;
1940 void ReadUsedVTables(SmallVectorImpl<ExternalVTableUse> &VTables) override;
1942 void ReadPendingInstantiations(
1943 SmallVectorImpl<std::pair<ValueDecl *,
1944 SourceLocation> > &Pending) override;
1946 void ReadLateParsedTemplates(
1947 llvm::MapVector<const FunctionDecl *, std::unique_ptr<LateParsedTemplate>>
1950 /// \brief Load a selector from disk, registering its ID if it exists.
1951 void LoadSelector(Selector Sel);
1953 void SetIdentifierInfo(unsigned ID, IdentifierInfo *II);
1954 void SetGloballyVisibleDecls(IdentifierInfo *II,
1955 const SmallVectorImpl<uint32_t> &DeclIDs,
1956 SmallVectorImpl<Decl *> *Decls = nullptr);
1958 /// \brief Report a diagnostic.
1959 DiagnosticBuilder Diag(unsigned DiagID) const;
1961 /// \brief Report a diagnostic.
1962 DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) const;
1964 IdentifierInfo *DecodeIdentifierInfo(serialization::IdentifierID ID);
1966 IdentifierInfo *GetIdentifierInfo(ModuleFile &M, const RecordData &Record,
1968 return DecodeIdentifierInfo(getGlobalIdentifierID(M, Record[Idx++]));
1971 IdentifierInfo *GetIdentifier(serialization::IdentifierID ID) override {
1972 // Note that we are loading an identifier.
1973 Deserializing AnIdentifier(this);
1975 return DecodeIdentifierInfo(ID);
1978 IdentifierInfo *getLocalIdentifier(ModuleFile &M, unsigned LocalID);
1980 serialization::IdentifierID getGlobalIdentifierID(ModuleFile &M,
1983 void resolvePendingMacro(IdentifierInfo *II, const PendingMacroInfo &PMInfo);
1985 /// \brief Retrieve the macro with the given ID.
1986 MacroInfo *getMacro(serialization::MacroID ID);
1988 /// \brief Retrieve the global macro ID corresponding to the given local
1989 /// ID within the given module file.
1990 serialization::MacroID getGlobalMacroID(ModuleFile &M, unsigned LocalID);
1992 /// \brief Read the source location entry with index ID.
1993 bool ReadSLocEntry(int ID) override;
1995 /// \brief Retrieve the module import location and module name for the
1996 /// given source manager entry ID.
1997 std::pair<SourceLocation, StringRef> getModuleImportLoc(int ID) override;
1999 /// \brief Retrieve the global submodule ID given a module and its local ID
2001 serialization::SubmoduleID
2002 getGlobalSubmoduleID(ModuleFile &M, unsigned LocalID);
2004 /// \brief Retrieve the submodule that corresponds to a global submodule ID.
2006 Module *getSubmodule(serialization::SubmoduleID GlobalID);
2008 /// \brief Retrieve the module that corresponds to the given module ID.
2010 /// Note: overrides method in ExternalASTSource
2011 Module *getModule(unsigned ID) override;
2013 /// \brief Retrieve the module file with a given local ID within the specified
2015 ModuleFile *getLocalModuleFile(ModuleFile &M, unsigned ID);
2017 /// \brief Get an ID for the given module file.
2018 unsigned getModuleFileID(ModuleFile *M);
2020 /// \brief Return a descriptor for the corresponding module.
2021 llvm::Optional<ASTSourceDescriptor> getSourceDescriptor(unsigned ID) override;
2023 ExtKind hasExternalDefinitions(const Decl *D) override;
2025 /// \brief Retrieve a selector from the given module with its local ID
2027 Selector getLocalSelector(ModuleFile &M, unsigned LocalID);
2029 Selector DecodeSelector(serialization::SelectorID Idx);
2031 Selector GetExternalSelector(serialization::SelectorID ID) override;
2032 uint32_t GetNumExternalSelectors() override;
2034 Selector ReadSelector(ModuleFile &M, const RecordData &Record, unsigned &Idx) {
2035 return getLocalSelector(M, Record[Idx++]);
2038 /// \brief Retrieve the global selector ID that corresponds to this
2039 /// the local selector ID in a given module.
2040 serialization::SelectorID getGlobalSelectorID(ModuleFile &F,
2041 unsigned LocalID) const;
2043 /// \brief Read a declaration name.
2044 DeclarationName ReadDeclarationName(ModuleFile &F,
2045 const RecordData &Record, unsigned &Idx);
2046 void ReadDeclarationNameLoc(ModuleFile &F,
2047 DeclarationNameLoc &DNLoc, DeclarationName Name,
2048 const RecordData &Record, unsigned &Idx);
2049 void ReadDeclarationNameInfo(ModuleFile &F, DeclarationNameInfo &NameInfo,
2050 const RecordData &Record, unsigned &Idx);
2052 void ReadQualifierInfo(ModuleFile &F, QualifierInfo &Info,
2053 const RecordData &Record, unsigned &Idx);
2055 NestedNameSpecifier *ReadNestedNameSpecifier(ModuleFile &F,
2056 const RecordData &Record,
2059 NestedNameSpecifierLoc ReadNestedNameSpecifierLoc(ModuleFile &F,
2060 const RecordData &Record,
2063 /// \brief Read a template name.
2064 TemplateName ReadTemplateName(ModuleFile &F, const RecordData &Record,
2067 /// \brief Read a template argument.
2068 TemplateArgument ReadTemplateArgument(ModuleFile &F, const RecordData &Record,
2070 bool Canonicalize = false);
2072 /// \brief Read a template parameter list.
2073 TemplateParameterList *ReadTemplateParameterList(ModuleFile &F,
2074 const RecordData &Record,
2077 /// \brief Read a template argument array.
2078 void ReadTemplateArgumentList(SmallVectorImpl<TemplateArgument> &TemplArgs,
2079 ModuleFile &F, const RecordData &Record,
2080 unsigned &Idx, bool Canonicalize = false);
2082 /// \brief Read a UnresolvedSet structure.
2083 void ReadUnresolvedSet(ModuleFile &F, LazyASTUnresolvedSet &Set,
2084 const RecordData &Record, unsigned &Idx);
2086 /// \brief Read a C++ base specifier.
2087 CXXBaseSpecifier ReadCXXBaseSpecifier(ModuleFile &F,
2088 const RecordData &Record,unsigned &Idx);
2090 /// \brief Read a CXXCtorInitializer array.
2091 CXXCtorInitializer **
2092 ReadCXXCtorInitializers(ModuleFile &F, const RecordData &Record,
2095 /// \brief Read the contents of a CXXCtorInitializer array.
2096 CXXCtorInitializer **GetExternalCXXCtorInitializers(uint64_t Offset) override;
2098 /// \brief Read a source location from raw form and return it in its
2099 /// originating module file's source location space.
2100 SourceLocation ReadUntranslatedSourceLocation(uint32_t Raw) const {
2101 return SourceLocation::getFromRawEncoding((Raw >> 1) | (Raw << 31));
2104 /// \brief Read a source location from raw form.
2105 SourceLocation ReadSourceLocation(ModuleFile &ModuleFile, uint32_t Raw) const {
2106 SourceLocation Loc = ReadUntranslatedSourceLocation(Raw);
2107 return TranslateSourceLocation(ModuleFile, Loc);
2110 /// \brief Translate a source location from another module file's source
2111 /// location space into ours.
2112 SourceLocation TranslateSourceLocation(ModuleFile &ModuleFile,
2113 SourceLocation Loc) const {
2114 if (!ModuleFile.ModuleOffsetMap.empty())
2115 ReadModuleOffsetMap(ModuleFile);
2116 assert(ModuleFile.SLocRemap.find(Loc.getOffset()) !=
2117 ModuleFile.SLocRemap.end() &&
2118 "Cannot find offset to remap.");
2119 int Remap = ModuleFile.SLocRemap.find(Loc.getOffset())->second;
2120 return Loc.getLocWithOffset(Remap);
2123 /// \brief Read a source location.
2124 SourceLocation ReadSourceLocation(ModuleFile &ModuleFile,
2125 const RecordDataImpl &Record,
2127 return ReadSourceLocation(ModuleFile, Record[Idx++]);
2130 /// \brief Read a source range.
2131 SourceRange ReadSourceRange(ModuleFile &F,
2132 const RecordData &Record, unsigned &Idx);
2134 /// \brief Read an integral value
2135 llvm::APInt ReadAPInt(const RecordData &Record, unsigned &Idx);
2137 /// \brief Read a signed integral value
2138 llvm::APSInt ReadAPSInt(const RecordData &Record, unsigned &Idx);
2140 /// \brief Read a floating-point value
2141 llvm::APFloat ReadAPFloat(const RecordData &Record,
2142 const llvm::fltSemantics &Sem, unsigned &Idx);
2144 // \brief Read a string
2145 static std::string ReadString(const RecordData &Record, unsigned &Idx);
2147 // \brief Read a path
2148 std::string ReadPath(ModuleFile &F, const RecordData &Record, unsigned &Idx);
2150 /// \brief Read a version tuple.
2151 static VersionTuple ReadVersionTuple(const RecordData &Record, unsigned &Idx);
2153 CXXTemporary *ReadCXXTemporary(ModuleFile &F, const RecordData &Record,
2156 /// \brief Reads attributes from the current stream position.
2157 void ReadAttributes(ASTRecordReader &Record, AttrVec &Attrs);
2159 /// \brief Reads a statement.
2160 Stmt *ReadStmt(ModuleFile &F);
2162 /// \brief Reads an expression.
2163 Expr *ReadExpr(ModuleFile &F);
2165 /// \brief Reads a sub-statement operand during statement reading.
2166 Stmt *ReadSubStmt() {
2167 assert(ReadingKind == Read_Stmt &&
2168 "Should be called only during statement reading!");
2169 // Subexpressions are stored from last to first, so the next Stmt we need
2170 // is at the back of the stack.
2171 assert(!StmtStack.empty() && "Read too many sub-statements!");
2172 return StmtStack.pop_back_val();
2175 /// \brief Reads a sub-expression operand during statement reading.
2176 Expr *ReadSubExpr();
2178 /// \brief Reads a token out of a record.
2179 Token ReadToken(ModuleFile &M, const RecordDataImpl &Record, unsigned &Idx);
2181 /// \brief Reads the macro record located at the given offset.
2182 MacroInfo *ReadMacroRecord(ModuleFile &F, uint64_t Offset);
2184 /// \brief Determine the global preprocessed entity ID that corresponds to
2185 /// the given local ID within the given module.
2186 serialization::PreprocessedEntityID
2187 getGlobalPreprocessedEntityID(ModuleFile &M, unsigned LocalID) const;
2189 /// \brief Add a macro to deserialize its macro directive history.
2191 /// \param II The name of the macro.
2192 /// \param M The module file.
2193 /// \param MacroDirectivesOffset Offset of the serialized macro directive
2195 void addPendingMacro(IdentifierInfo *II, ModuleFile *M,
2196 uint64_t MacroDirectivesOffset);
2198 /// \brief Read the set of macros defined by this external macro source.
2199 void ReadDefinedMacros() override;
2201 /// \brief Update an out-of-date identifier.
2202 void updateOutOfDateIdentifier(IdentifierInfo &II) override;
2204 /// \brief Note that this identifier is up-to-date.
2205 void markIdentifierUpToDate(IdentifierInfo *II);
2207 /// \brief Load all external visible decls in the given DeclContext.
2208 void completeVisibleDeclsMap(const DeclContext *DC) override;
2210 /// \brief Retrieve the AST context that this AST reader supplements.
2211 ASTContext &getContext() {
2212 assert(ContextObj && "requested AST context when not loading AST");
2216 // \brief Contains the IDs for declarations that were requested before we have
2217 // access to a Sema object.
2218 SmallVector<uint64_t, 16> PreloadedDeclIDs;
2220 /// \brief Retrieve the semantic analysis object used to analyze the
2221 /// translation unit in which the precompiled header is being
2223 Sema *getSema() { return SemaObj; }
2225 /// \brief Get the identifier resolver used for name lookup / updates
2226 /// in the translation unit scope. We have one of these even if we don't
2227 /// have a Sema object.
2228 IdentifierResolver &getIdResolver();
2230 /// \brief Retrieve the identifier table associated with the
2232 IdentifierTable &getIdentifierTable();
2234 /// \brief Record that the given ID maps to the given switch-case
2236 void RecordSwitchCaseID(SwitchCase *SC, unsigned ID);
2238 /// \brief Retrieve the switch-case statement with the given ID.
2239 SwitchCase *getSwitchCaseWithID(unsigned ID);
2241 void ClearSwitchCaseIDs();
2243 /// \brief Cursors for comments blocks.
2244 SmallVector<std::pair<llvm::BitstreamCursor,
2245 serialization::ModuleFile *>, 8> CommentsCursors;
2247 /// \brief Loads comments ranges.
2248 void ReadComments() override;
2250 /// Visit all the input files of the given module file.
2251 void visitInputFiles(serialization::ModuleFile &MF,
2252 bool IncludeSystem, bool Complain,
2253 llvm::function_ref<void(const serialization::InputFile &IF,
2254 bool isSystem)> Visitor);
2256 /// Visit all the top-level module maps loaded when building the given module
2258 void visitTopLevelModuleMaps(serialization::ModuleFile &MF,
2260 void(const FileEntry *)> Visitor);
2262 bool isProcessingUpdateRecords() { return ProcessingUpdateRecords; }
2265 /// \brief An object for streaming information from a record.
2266 class ASTRecordReader {
2267 typedef serialization::ModuleFile ModuleFile;
2272 ASTReader::RecordData Record;
2274 typedef ASTReader::RecordData RecordData;
2275 typedef ASTReader::RecordDataImpl RecordDataImpl;
2278 /// Construct an ASTRecordReader that uses the default encoding scheme.
2279 ASTRecordReader(ASTReader &Reader, ModuleFile &F)
2280 : Reader(&Reader), F(&F) {}
2282 /// \brief Reads a record with id AbbrevID from Cursor, resetting the
2284 unsigned readRecord(llvm::BitstreamCursor &Cursor, unsigned AbbrevID);
2286 /// \brief Is this a module file for a module (rather than a PCH or similar).
2287 bool isModule() const { return F->isModule(); }
2289 /// \brief Retrieve the AST context that this AST reader supplements.
2290 ASTContext &getContext() { return Reader->getContext(); }
2292 /// \brief The current position in this record.
2293 unsigned getIdx() const { return Idx; }
2294 /// \brief The length of this record.
2295 size_t size() const { return Record.size(); }
2297 /// \brief An arbitrary index in this record.
2298 const uint64_t &operator[](size_t N) { return Record[N]; }
2299 /// \brief The last element in this record.
2300 const uint64_t &back() const { return Record.back(); }
2302 /// \brief Returns the current value in this record, and advances to the
2304 const uint64_t &readInt() { return Record[Idx++]; }
2305 /// \brief Returns the current value in this record, without advancing.
2306 const uint64_t &peekInt() { return Record[Idx]; }
2308 /// \brief Skips the specified number of values.
2309 void skipInts(unsigned N) { Idx += N; }
2311 /// \brief Retrieve the global submodule ID its local ID number.
2312 serialization::SubmoduleID
2313 getGlobalSubmoduleID(unsigned LocalID) {
2314 return Reader->getGlobalSubmoduleID(*F, LocalID);
2317 /// \brief Retrieve the submodule that corresponds to a global submodule ID.
2318 Module *getSubmodule(serialization::SubmoduleID GlobalID) {
2319 return Reader->getSubmodule(GlobalID);
2322 /// \brief Read the record that describes the lexical contents of a DC.
2323 bool readLexicalDeclContextStorage(uint64_t Offset, DeclContext *DC) {
2324 return Reader->ReadLexicalDeclContextStorage(*F, F->DeclsCursor, Offset,
2328 /// \brief Read the record that describes the visible contents of a DC.
2329 bool readVisibleDeclContextStorage(uint64_t Offset,
2330 serialization::DeclID ID) {
2331 return Reader->ReadVisibleDeclContextStorage(*F, F->DeclsCursor, Offset,
2335 void readExceptionSpec(SmallVectorImpl<QualType> &ExceptionStorage,
2336 FunctionProtoType::ExceptionSpecInfo &ESI) {
2337 return Reader->readExceptionSpec(*F, ExceptionStorage, ESI, Record, Idx);
2340 /// \brief Get the global offset corresponding to a local offset.
2341 uint64_t getGlobalBitOffset(uint32_t LocalOffset) {
2342 return Reader->getGlobalBitOffset(*F, LocalOffset);
2345 /// \brief Reads a statement.
2346 Stmt *readStmt() { return Reader->ReadStmt(*F); }
2348 /// \brief Reads an expression.
2349 Expr *readExpr() { return Reader->ReadExpr(*F); }
2351 /// \brief Reads a sub-statement operand during statement reading.
2352 Stmt *readSubStmt() { return Reader->ReadSubStmt(); }
2354 /// \brief Reads a sub-expression operand during statement reading.
2355 Expr *readSubExpr() { return Reader->ReadSubExpr(); }
2357 /// \brief Reads a declaration with the given local ID in the given module.
2359 /// \returns The requested declaration, casted to the given return type.
2360 template<typename T>
2361 T *GetLocalDeclAs(uint32_t LocalID) {
2362 return cast_or_null<T>(Reader->GetLocalDecl(*F, LocalID));
2365 /// \brief Reads a TemplateArgumentLocInfo appropriate for the
2366 /// given TemplateArgument kind, advancing Idx.
2367 TemplateArgumentLocInfo
2368 getTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind) {
2369 return Reader->GetTemplateArgumentLocInfo(*F, Kind, Record, Idx);
2372 /// \brief Reads a TemplateArgumentLoc, advancing Idx.
2374 readTemplateArgumentLoc() {
2375 return Reader->ReadTemplateArgumentLoc(*F, Record, Idx);
2378 const ASTTemplateArgumentListInfo*
2379 readASTTemplateArgumentListInfo() {
2380 return Reader->ReadASTTemplateArgumentListInfo(*F, Record, Idx);
2383 /// \brief Reads a declarator info from the given record, advancing Idx.
2384 TypeSourceInfo *getTypeSourceInfo() {
2385 return Reader->GetTypeSourceInfo(*F, Record, Idx);
2388 /// \brief Map a local type ID within a given AST file to a global type ID.
2389 serialization::TypeID getGlobalTypeID(unsigned LocalID) const {
2390 return Reader->getGlobalTypeID(*F, LocalID);
2393 /// \brief Read a type from the current position in the record.
2394 QualType readType() {
2395 return Reader->readType(*F, Record, Idx);
2398 /// \brief Reads a declaration ID from the given position in this record.
2400 /// \returns The declaration ID read from the record, adjusted to a global ID.
2401 serialization::DeclID readDeclID() {
2402 return Reader->ReadDeclID(*F, Record, Idx);
2405 /// \brief Reads a declaration from the given position in a record in the
2406 /// given module, advancing Idx.
2408 return Reader->ReadDecl(*F, Record, Idx);
2411 /// \brief Reads a declaration from the given position in the record,
2414 /// \returns The declaration read from this location, casted to the given
2416 template<typename T>
2418 return Reader->ReadDeclAs<T>(*F, Record, Idx);
2421 IdentifierInfo *getIdentifierInfo() {
2422 return Reader->GetIdentifierInfo(*F, Record, Idx);
2425 /// \brief Read a selector from the Record, advancing Idx.
2426 Selector readSelector() {
2427 return Reader->ReadSelector(*F, Record, Idx);
2430 /// \brief Read a declaration name, advancing Idx.
2431 DeclarationName readDeclarationName() {
2432 return Reader->ReadDeclarationName(*F, Record, Idx);
2434 void readDeclarationNameLoc(DeclarationNameLoc &DNLoc, DeclarationName Name) {
2435 return Reader->ReadDeclarationNameLoc(*F, DNLoc, Name, Record, Idx);
2437 void readDeclarationNameInfo(DeclarationNameInfo &NameInfo) {
2438 return Reader->ReadDeclarationNameInfo(*F, NameInfo, Record, Idx);
2441 void readQualifierInfo(QualifierInfo &Info) {
2442 return Reader->ReadQualifierInfo(*F, Info, Record, Idx);
2445 NestedNameSpecifier *readNestedNameSpecifier() {
2446 return Reader->ReadNestedNameSpecifier(*F, Record, Idx);
2449 NestedNameSpecifierLoc readNestedNameSpecifierLoc() {
2450 return Reader->ReadNestedNameSpecifierLoc(*F, Record, Idx);
2453 /// \brief Read a template name, advancing Idx.
2454 TemplateName readTemplateName() {
2455 return Reader->ReadTemplateName(*F, Record, Idx);
2458 /// \brief Read a template argument, advancing Idx.
2459 TemplateArgument readTemplateArgument(bool Canonicalize = false) {
2460 return Reader->ReadTemplateArgument(*F, Record, Idx, Canonicalize);
2463 /// \brief Read a template parameter list, advancing Idx.
2464 TemplateParameterList *readTemplateParameterList() {
2465 return Reader->ReadTemplateParameterList(*F, Record, Idx);
2468 /// \brief Read a template argument array, advancing Idx.
2469 void readTemplateArgumentList(SmallVectorImpl<TemplateArgument> &TemplArgs,
2470 bool Canonicalize = false) {
2471 return Reader->ReadTemplateArgumentList(TemplArgs, *F, Record, Idx,
2475 /// \brief Read a UnresolvedSet structure, advancing Idx.
2476 void readUnresolvedSet(LazyASTUnresolvedSet &Set) {
2477 return Reader->ReadUnresolvedSet(*F, Set, Record, Idx);
2480 /// \brief Read a C++ base specifier, advancing Idx.
2481 CXXBaseSpecifier readCXXBaseSpecifier() {
2482 return Reader->ReadCXXBaseSpecifier(*F, Record, Idx);
2485 /// \brief Read a CXXCtorInitializer array, advancing Idx.
2486 CXXCtorInitializer **readCXXCtorInitializers() {
2487 return Reader->ReadCXXCtorInitializers(*F, Record, Idx);
2490 CXXTemporary *readCXXTemporary() {
2491 return Reader->ReadCXXTemporary(*F, Record, Idx);
2494 /// \brief Read a source location, advancing Idx.
2495 SourceLocation readSourceLocation() {
2496 return Reader->ReadSourceLocation(*F, Record, Idx);
2499 /// \brief Read a source range, advancing Idx.
2500 SourceRange readSourceRange() {
2501 return Reader->ReadSourceRange(*F, Record, Idx);
2504 /// \brief Read an integral value, advancing Idx.
2505 llvm::APInt readAPInt() {
2506 return Reader->ReadAPInt(Record, Idx);
2509 /// \brief Read a signed integral value, advancing Idx.
2510 llvm::APSInt readAPSInt() {
2511 return Reader->ReadAPSInt(Record, Idx);
2514 /// \brief Read a floating-point value, advancing Idx.
2515 llvm::APFloat readAPFloat(const llvm::fltSemantics &Sem) {
2516 return Reader->ReadAPFloat(Record, Sem,Idx);
2519 /// \brief Read a string, advancing Idx.
2520 std::string readString() {
2521 return Reader->ReadString(Record, Idx);
2524 /// \brief Read a path, advancing Idx.
2525 std::string readPath() {
2526 return Reader->ReadPath(*F, Record, Idx);
2529 /// \brief Read a version tuple, advancing Idx.
2530 VersionTuple readVersionTuple() {
2531 return ASTReader::ReadVersionTuple(Record, Idx);
2534 /// \brief Reads attributes from the current stream position, advancing Idx.
2535 void readAttributes(AttrVec &Attrs) {
2536 return Reader->ReadAttributes(*this, Attrs);
2539 /// \brief Reads a token out of a record, advancing Idx.
2541 return Reader->ReadToken(*F, Record, Idx);
2544 void recordSwitchCaseID(SwitchCase *SC, unsigned ID) {
2545 Reader->RecordSwitchCaseID(SC, ID);
2548 /// \brief Retrieve the switch-case statement with the given ID.
2549 SwitchCase *getSwitchCaseWithID(unsigned ID) {
2550 return Reader->getSwitchCaseWithID(ID);
2554 /// \brief Helper class that saves the current stream position and
2555 /// then restores it when destroyed.
2556 struct SavedStreamPosition {
2557 explicit SavedStreamPosition(llvm::BitstreamCursor &Cursor)
2558 : Cursor(Cursor), Offset(Cursor.GetCurrentBitNo()) { }
2560 ~SavedStreamPosition() {
2561 Cursor.JumpToBit(Offset);
2565 llvm::BitstreamCursor &Cursor;
2569 inline void PCHValidator::Error(const char *Msg) {
2573 } // end namespace clang