13#ifndef LLVM_CLANG_SERIALIZATION_ASTREADER_H
14#define LLVM_CLANG_SERIALIZATION_ASTREADER_H
37#include "llvm/ADT/ArrayRef.h"
38#include "llvm/ADT/DenseMap.h"
39#include "llvm/ADT/DenseSet.h"
40#include "llvm/ADT/IntrusiveRefCntPtr.h"
41#include "llvm/ADT/MapVector.h"
42#include "llvm/ADT/PagedVector.h"
43#include "llvm/ADT/STLExtras.h"
44#include "llvm/ADT/SetVector.h"
45#include "llvm/ADT/SmallPtrSet.h"
46#include "llvm/ADT/SmallVector.h"
47#include "llvm/ADT/StringMap.h"
48#include "llvm/ADT/StringRef.h"
49#include "llvm/ADT/iterator.h"
50#include "llvm/ADT/iterator_range.h"
51#include "llvm/Bitstream/BitstreamReader.h"
52#include "llvm/Support/MemoryBuffer.h"
53#include "llvm/Support/SaveAndRestore.h"
54#include "llvm/Support/Timer.h"
55#include "llvm/Support/VersionTuple.h"
72class ASTDeserializationListener;
85class FileSystemOptions;
87class GlobalModuleIndex;
89class HeaderSearchOptions;
92class InMemoryModuleCache;
95class ObjCCategoryDecl;
96class ObjCInterfaceDecl;
97class PCHContainerReader;
99class PreprocessorOptions;
106class TypedefNameDecl;
135 StringRef ModuleFilename,
bool Complain,
136 bool AllowCompatibleDifferences) {
145 StringRef ModuleFilename,
bool Complain,
146 bool AllowCompatibleDifferences) {
156 StringRef ModuleFilename,
bool Complain) {
178 StringRef ModuleFilename,
179 StringRef SpecificModuleCachePath,
207 StringRef ModuleFilename,
208 bool ReadMacros,
bool Complain,
209 std::string &SuggestedPredefines) {
236 bool isOverridden,
bool isExplicitModule) {
255 std::unique_ptr<ASTReaderListener> First;
256 std::unique_ptr<ASTReaderListener> Second;
261 std::unique_ptr<ASTReaderListener> Second)
265 std::unique_ptr<ASTReaderListener>
takeSecond() {
return std::move(Second); }
271 StringRef ModuleFilename,
bool Complain,
272 bool AllowCompatibleDifferences)
override;
274 StringRef ModuleFilename,
bool Complain,
275 bool AllowCompatibleDifferences)
override;
277 StringRef ModuleFilename,
bool Complain)
override;
279 bool Complain)
override;
282 StringRef ModuleFilename,
283 StringRef SpecificModuleCachePath,
284 bool Complain)
override;
286 StringRef ModuleFilename,
bool ReadMacros,
288 std::string &SuggestedPredefines)
override;
296 bool isOverridden,
bool isExplicitModule)
override;
309 : PP(PP), Reader(Reader) {}
312 StringRef ModuleFilename,
bool Complain,
313 bool AllowCompatibleDifferences)
override;
315 StringRef ModuleFilename,
bool Complain,
316 bool AllowCompatibleDifferences)
override;
318 StringRef ModuleFilename,
bool Complain)
override;
320 StringRef ModuleFilename,
bool ReadMacros,
322 std::string &SuggestedPredefines)
override;
324 StringRef ModuleFilename,
325 StringRef SpecificModuleCachePath,
326 bool Complain)
override;
341 StringRef ModuleFilename,
bool ReadMacros,
343 std::string &SuggestedPredefines)
override;
346namespace serialization {
348class ReadMethodPoolVisitor;
440 std::unique_ptr<ASTReaderListener> Listener;
445 bool OwnsDeserializationListener =
false;
457 Sema *SemaObj =
nullptr;
477 llvm::StringMap<std::shared_ptr<ModuleFileExtension>> ModuleFileExtensions;
480 std::unique_ptr<llvm::Timer> ReadTimer;
487 std::optional<ModuleKind> CurrentDeserializingModuleKind;
490 std::unique_ptr<GlobalModuleIndex> GlobalIndex;
510 llvm::PagedVector<QualType> TypesLoaded;
516 llvm::PagedVector<Decl *> DeclsLoaded;
518 using FileOffset = std::pair<ModuleFile *, uint64_t>;
520 using DeclUpdateOffsetsMap = llvm::DenseMap<GlobalDeclID, FileOffsetsTy>;
524 DeclUpdateOffsetsMap DeclUpdateOffsets;
526 using DelayedNamespaceOffsetMapTy =
538 DelayedNamespaceOffsetMapTy DelayedNamespaceOffsetMap;
547 llvm::DenseMap<GlobalDeclID, SmallVector<GlobalDeclID, 4>> RelatedDeclsMap;
549 struct PendingUpdateRecord {
557 :
D(
D), ID(ID), JustLoaded(JustLoaded) {}
564 enum class PendingFakeDefinitionKind { NotFake, Fake, FakeLoaded };
568 llvm::DenseMap<void *, PendingFakeDefinitionKind> PendingFakeDefinitionData;
574 llvm::SmallMapVector<Decl *, FunctionDecl *, 4> PendingExceptionSpecUpdates;
579 llvm::SmallMapVector<FunctionDecl *, QualType, 4> PendingDeducedTypeUpdates;
587 llvm::DenseMap<std::pair<DeclContext *, IdentifierInfo *>, NamedDecl *>
588 ImportedTypedefNamesForLinkage;
592 llvm::DenseMap<Decl*, llvm::SmallVector<NamedDecl*, 2>>
593 AnonymousDeclarationsForMerging;
596 llvm::DenseMap<std::pair<const Decl *, unsigned>, NamedDecl *>
597 LambdaDeclarationsForMerging;
601 using LETemporaryKey = std::pair<Decl *, unsigned>;
604 llvm::DenseMap<LETemporaryKey, LifetimeExtendedTemporaryDecl *>
605 LETemporaryForMerging;
607 struct FileDeclsInfo {
609 ArrayRef<serialization::unaligned_decl_id_t> Decls;
611 FileDeclsInfo() =
default;
613 ArrayRef<serialization::unaligned_decl_id_t> Decls)
614 : Mod(Mod), Decls(Decls) {}
618 llvm::DenseMap<FileID, FileDeclsInfo> FileDeclIDs;
622 using LexicalContents = ArrayRef<serialization::unaligned_decl_id_t>;
625 llvm::DenseMap<const DeclContext*, std::pair<ModuleFile*, LexicalContents>>
629 std::vector<std::pair<ModuleFile*, LexicalContents>> TULexicalDecls;
632 llvm::DenseMap<
const DeclContext *,
633 serialization::reader::DeclContextLookupTable> Lookups;
635 using SpecLookupTableTy =
636 llvm::DenseMap<
const Decl *,
637 serialization::reader::LazySpecializationInfoLookupTable>;
639 SpecLookupTableTy SpecializationsLookups;
641 SpecLookupTableTy PartialSpecializationsLookups;
643 bool LoadExternalSpecializationsImpl(SpecLookupTableTy &SpecLookups,
645 bool LoadExternalSpecializationsImpl(SpecLookupTableTy &SpecLookups,
647 ArrayRef<TemplateArgument> TemplateArgs);
655 const unsigned char *
Data;
657 using DeclContextVisibleUpdates = SmallVector<UpdateData, 1>;
661 llvm::DenseMap<GlobalDeclID, DeclContextVisibleUpdates> PendingVisibleUpdates;
663 using SpecializationsUpdate = SmallVector<UpdateData, 1>;
664 using SpecializationsUpdateMap =
665 llvm::DenseMap<GlobalDeclID, SpecializationsUpdate>;
666 SpecializationsUpdateMap PendingSpecializationsUpdates;
667 SpecializationsUpdateMap PendingPartialSpecializationsUpdates;
673 using PendingBodiesMap =
675 llvm::SmallDenseMap<Decl *, unsigned, 4>,
676 SmallVector<std::pair<Decl *, uint64_t>, 4>>;
679 PendingBodiesMap PendingBodies;
683 llvm::SetVector<NamedDecl *> PendingMergedDefinitionsToDeduplicate;
689 PendingWarningForDuplicatedDefsInModuleUnits;
692 bool ReadLexicalDeclContextStorage(
ModuleFile &M,
693 llvm::BitstreamCursor &Cursor,
694 uint64_t Offset, DeclContext *DC);
697 bool ReadVisibleDeclContextStorage(
ModuleFile &M,
698 llvm::BitstreamCursor &Cursor,
699 uint64_t Offset, GlobalDeclID ID);
701 bool ReadSpecializations(
ModuleFile &M, llvm::BitstreamCursor &Cursor,
702 uint64_t Offset, Decl *
D,
bool IsPartial);
703 void AddSpecializations(
const Decl *
D,
const unsigned char *
Data,
712 std::vector<IdentifierInfo *> IdentifiersLoaded;
720 std::vector<MacroInfo *> MacrosLoaded;
722 using LoadedMacroInfo =
723 std::pair<IdentifierInfo *, serialization::SubmoduleID>;
728 llvm::DenseSet<LoadedMacroInfo> LoadedUndefs;
730 using GlobalMacroMapType =
731 ContinuousRangeMap<serialization::MacroID, ModuleFile *, 4>;
736 GlobalMacroMapType GlobalMacroMap;
742 SmallVector<Module *, 2> SubmodulesLoaded;
744 using GlobalSubmoduleMapType =
745 ContinuousRangeMap<serialization::SubmoduleID, ModuleFile *, 4>;
750 GlobalSubmoduleMapType GlobalSubmoduleMap;
753 using HiddenNames = SmallVector<Decl *, 2>;
754 using HiddenNamesMapType = llvm::DenseMap<Module *, HiddenNames>;
758 HiddenNamesMapType HiddenNamesMap;
761 struct UnresolvedModuleRef {
769 enum {
Import, Export, Conflict, Affecting }
Kind;
775 LLVM_PREFERRED_TYPE(
bool)
776 unsigned IsWildcard : 1;
784 SmallVector<UnresolvedModuleRef, 2> UnresolvedModuleRefs;
791 SmallVector<Selector, 16> SelectorsLoaded;
793 using GlobalSelectorMapType =
794 ContinuousRangeMap<serialization::SelectorID, ModuleFile *, 4>;
798 GlobalSelectorMapType GlobalSelectorMap;
802 llvm::DenseMap<Selector, unsigned> SelectorGeneration;
806 llvm::DenseMap<Selector, bool> SelectorOutOfDate;
808 struct PendingMacroInfo {
813 PendingMacroInfo(
ModuleFile *M, uint32_t MacroDirectivesOffset)
814 : M(M), MacroDirectivesOffset(MacroDirectivesOffset) {}
817 using PendingMacroIDsMap =
818 llvm::MapVector<IdentifierInfo *, SmallVector<PendingMacroInfo, 2>>;
822 PendingMacroIDsMap PendingMacroIDs;
824 using GlobalPreprocessedEntityMapType =
825 ContinuousRangeMap<unsigned, ModuleFile *, 4>;
830 GlobalPreprocessedEntityMapType GlobalPreprocessedEntityMap;
832 using GlobalSkippedRangeMapType =
833 ContinuousRangeMap<unsigned, ModuleFile *, 4>;
837 GlobalSkippedRangeMapType GlobalSkippedRangeMap;
849 SmallVector<GlobalDeclID, 16> EagerlyDeserializedDecls;
854 SmallVector<GlobalDeclID, 16> VTablesToEmit;
861 SmallVector<GlobalDeclID, 16> TentativeDefinitions;
873 SmallVector<VTableUse> VTableUses;
881 struct PendingInstantiation {
885 SmallVector<PendingInstantiation, 64> PendingInstantiations;
895 SmallVector<GlobalDeclID, 16> UnusedFileScopedDecls;
899 SmallVector<GlobalDeclID, 4> DelegatingCtorDecls;
903 SmallVector<serialization::SelectorID, 64> ReferencedSelectorsData;
907 SmallVector<serialization::IdentifierID, 64> WeakUndeclaredIdentifiers;
912 SmallVector<GlobalDeclID, 4> ExtVectorDecls;
923 SmallVector<GlobalDeclID, 16> UnusedLocalTypedefNameCandidates;
927 unsigned ForceHostDeviceDepth = 0;
932 SmallVector<GlobalDeclID, 4> SemaDeclRefs;
937 SmallVector<serialization::TypeID, 16> SpecialTypes;
943 SmallVector<GlobalDeclID, 2> CUDASpecialDeclRefs;
946 SmallVector<uint64_t, 1> FPPragmaOptions;
949 SourceLocation OptimizeOffPragmaLocation;
952 int PragmaMSStructState = -1;
955 int PragmaMSPointersToMembersState = -1;
956 SourceLocation PointersToMembersPragmaLocation;
959 std::optional<FPOptionsOverride> FpPragmaCurrentValue;
960 SourceLocation FpPragmaCurrentLocation;
961 struct FpPragmaStackEntry {
962 FPOptionsOverride
Value;
963 SourceLocation Location;
964 SourceLocation PushLocation;
971 std::optional<Sema::AlignPackInfo> PragmaAlignPackCurrentValue;
972 SourceLocation PragmaAlignPackCurrentLocation;
973 struct PragmaAlignPackStackEntry {
974 Sema::AlignPackInfo
Value;
975 SourceLocation Location;
976 SourceLocation PushLocation;
983 OpenCLOptions OpenCLExtensions;
986 llvm::DenseMap<const Type *, std::set<std::string>> OpenCLTypeExtMap;
989 llvm::DenseMap<const Decl *, std::set<std::string>> OpenCLDeclExtMap;
992 SmallVector<GlobalDeclID, 4> KnownNamespaces;
996 struct UndefinedButUsedDecl {
1000 SmallVector<UndefinedButUsedDecl, 8> UndefinedButUsed;
1003 SmallVector<uint64_t, 8> DelayedDeleteExprs;
1006 SmallVector<std::pair<ModuleFile *, SmallVector<uint64_t, 1>>, 4>
1007 LateParsedTemplates;
1015 SmallVector<GlobalDeclID> DeclsWithEffectsToVerify;
1018 struct ImportedSubmodule {
1020 SourceLocation ImportLoc;
1023 :
ID(
ID), ImportLoc(ImportLoc) {}
1030 SmallVector<ImportedSubmodule, 2> PendingImportedModules;
1034 SmallVector<ImportedSubmodule, 2> PendingImportedModulesSema;
1039 std::string isysroot;
1046 bool AllowASTWithCompilerErrors;
1050 bool AllowConfigurationMismatch;
1053 bool ValidateSystemInputs;
1056 bool ValidateASTInputFilesContent;
1059 bool UseGlobalIndex;
1062 bool TriedLoadingGlobalIndex =
false;
1065 bool ProcessingUpdateRecords =
false;
1067 using SwitchCaseMapTy = llvm::DenseMap<unsigned, SwitchCase *>;
1073 SwitchCaseMapTy SwitchCaseStmts;
1075 SwitchCaseMapTy *CurrSwitchCaseStmts;
1079 unsigned NumSLocEntriesRead = 0;
1082 unsigned TotalNumSLocEntries = 0;
1086 unsigned NumStatementsRead = 0;
1090 unsigned TotalNumStatements = 0;
1093 unsigned NumMacrosRead = 0;
1096 unsigned TotalNumMacros = 0;
1099 unsigned NumIdentifierLookups = 0;
1102 unsigned NumIdentifierLookupHits = 0;
1105 unsigned NumSelectorsRead = 0;
1108 unsigned NumMethodPoolEntriesRead = 0;
1112 unsigned NumMethodPoolLookups = 0;
1116 unsigned NumMethodPoolHits = 0;
1120 unsigned NumMethodPoolTableLookups = 0;
1124 unsigned NumMethodPoolTableHits = 0;
1127 unsigned TotalNumMethodPoolEntries = 0;
1130 unsigned NumLexicalDeclContextsRead = 0, TotalLexicalDeclContexts = 0;
1133 unsigned NumVisibleDeclContextsRead = 0, TotalVisibleDeclContexts = 0;
1136 uint64_t TotalModulesSizeInBits = 0;
1139 unsigned NumCurrentElementsDeserializing = 0;
1145 bool PassingDeclsToConsumer =
false;
1152 llvm::MapVector<IdentifierInfo *, SmallVector<GlobalDeclID, 4>>
1153 PendingIdentifierInfos;
1157 llvm::SmallMapVector<const IdentifierInfo *, SmallVector<NamedDecl *, 2>, 16>
1158 PendingFakeLookupResults;
1162 llvm::DenseMap<const IdentifierInfo *, unsigned> IdentifierGeneration;
1170 std::deque<Decl *> PotentiallyInterestingDecls;
1175 SmallVector<std::pair<FunctionDecl *, serialization::TypeID>, 16>
1176 PendingDeducedFunctionTypes;
1181 SmallVector<std::pair<VarDecl *, serialization::TypeID>, 16>
1182 PendingDeducedVarTypes;
1187 SmallVector<std::pair<Decl *, uint64_t>, 16> PendingDeclChains;
1191 SmallVector<Decl *, 16> PendingIncompleteDeclChains;
1195 struct PendingDeclContextInfo {
1197 GlobalDeclID SemaDC;
1198 GlobalDeclID LexicalDC;
1206 std::deque<PendingDeclContextInfo> PendingDeclContextInfos;
1208 template <
typename DeclTy>
1209 using DuplicateObjCDecls = std::pair<DeclTy *, DeclTy *>;
1215 llvm::SmallMapVector<DuplicateObjCDecls<ObjCCategoryDecl>,
1218 PendingObjCExtensionIvarRedeclarations;
1223 SmallVector<std::pair<CXXRecordDecl*, Decl*>, 4> PendingAddedClassMembers;
1233 using DataPointers =
1234 std::pair<CXXRecordDecl *, struct CXXRecordDecl::DefinitionData *>;
1235 using ObjCInterfaceDataPointers =
1236 std::pair<ObjCInterfaceDecl *,
1237 struct ObjCInterfaceDecl::DefinitionData *>;
1238 using ObjCProtocolDataPointers =
1239 std::pair<ObjCProtocolDecl *, struct ObjCProtocolDecl::DefinitionData *>;
1242 llvm::SmallDenseMap<CXXRecordDecl *, llvm::SmallVector<DataPointers, 2>, 2>
1243 PendingOdrMergeFailures;
1246 llvm::SmallDenseMap<RecordDecl *, llvm::SmallVector<RecordDecl *, 2>, 2>
1247 PendingRecordOdrMergeFailures;
1250 llvm::SmallDenseMap<FunctionDecl *, llvm::SmallVector<FunctionDecl *, 2>, 2>
1251 PendingFunctionOdrMergeFailures;
1254 llvm::SmallDenseMap<EnumDecl *, llvm::SmallVector<EnumDecl *, 2>, 2>
1255 PendingEnumOdrMergeFailures;
1258 llvm::SmallDenseMap<ObjCInterfaceDecl *,
1260 PendingObjCInterfaceOdrMergeFailures;
1263 llvm::SmallDenseMap<ObjCProtocolDecl *,
1265 PendingObjCProtocolOdrMergeFailures;
1277 SmallVector<ObjCInterfaceDecl *, 16> ObjCClassesLoaded;
1279 using KeyDeclsMap = llvm::DenseMap<Decl *, SmallVector<GlobalDeclID, 2>>;
1286 KeyDeclsMap KeyDecls;
1291 llvm::DenseMap<DeclContext *, DeclContext *> MergedDeclContexts;
1295 llvm::DenseMap<EnumDecl *, EnumDecl *> EnumDefinitions;
1299 llvm::DenseMap<RecordDecl *, RecordDecl *> RecordDefinitions;
1302 SmallVector<Stmt *, 16> StmtStack;
1306 Read_None, Read_Decl, Read_Type, Read_Stmt
1310 ReadingKind ReadingKind = Read_None;
1313 class ReadingKindTracker {
1315 enum ReadingKind PrevKind;
1318 ReadingKindTracker(
enum ReadingKind newKind, ASTReader &reader)
1319 : Reader(reader), PrevKind(Reader.ReadingKind) {
1320 Reader.ReadingKind = newKind;
1323 ReadingKindTracker(
const ReadingKindTracker &) =
delete;
1324 ReadingKindTracker &operator=(
const ReadingKindTracker &) =
delete;
1325 ~ReadingKindTracker() { Reader.ReadingKind = PrevKind; }
1329 class ProcessingUpdatesRAIIObj {
1334 ProcessingUpdatesRAIIObj(ASTReader &reader)
1335 : Reader(reader), PrevState(Reader.ProcessingUpdateRecords) {
1336 Reader.ProcessingUpdateRecords =
true;
1339 ProcessingUpdatesRAIIObj(
const ProcessingUpdatesRAIIObj &) =
delete;
1340 ProcessingUpdatesRAIIObj &
1341 operator=(
const ProcessingUpdatesRAIIObj &) =
delete;
1342 ~ProcessingUpdatesRAIIObj() { Reader.ProcessingUpdateRecords = PrevState; }
1353 std::string SuggestedPredefines;
1355 llvm::DenseMap<const Decl *, bool> DefinitionSource;
1357 bool shouldDisableValidationForFile(
const serialization::ModuleFile &M)
const;
1363 serialization::InputFileInfo getInputFileInfo(
ModuleFile &F,
unsigned ID);
1367 serialization::InputFile getInputFile(
ModuleFile &F,
unsigned ID,
1368 bool Complain =
true);
1371 SmallString<0> PathBuf;
1374 class TemporarilyOwnedStringRef {
1379 TemporarilyOwnedStringRef(StringRef S, SmallString<0> &UnderlyingBuffer)
1380 : String(S), UnderlyingBuffer(UnderlyingBuffer, {}) {}
1383 const StringRef *operator->() const & {
return &String; }
1384 const StringRef &
operator*() const & {
return String; }
1387 const StringRef *operator->() && =
delete;
1388 const StringRef &
operator*() && =
delete;
1397 static TemporarilyOwnedStringRef
1401 static TemporarilyOwnedStringRef
1417 D =
D->getCanonicalDecl();
1418 if (
D->isFromASTFile())
1421 auto I = KeyDecls.find(
D);
1422 if (I == KeyDecls.end() || I->second.empty())
1431 template <
typename Fn>
1433 D =
D->getCanonicalDecl();
1434 if (
D->isFromASTFile())
1437 auto It = KeyDecls.find(
const_cast<Decl*
>(
D));
1438 if (It != KeyDecls.end())
1439 for (
auto ID : It->second)
1456 struct ImportedModule {
1464 : Mod(Mod), ImportedBy(ImportedBy), ImportLoc(ImportLoc) {}
1468 SourceLocation ImportLoc,
ModuleFile *ImportedBy,
1469 SmallVectorImpl<ImportedModule> &Loaded,
1470 off_t ExpectedSize, time_t ExpectedModTime,
1471 ASTFileSignature ExpectedSignature,
1472 unsigned ClientLoadCapabilities);
1474 SmallVectorImpl<ImportedModule> &Loaded,
1476 unsigned ClientLoadCapabilities);
1478 ReadOptionsBlock(llvm::BitstreamCursor &Stream, StringRef
Filename,
1479 unsigned ClientLoadCapabilities,
1480 bool AllowCompatibleConfigurationMismatch,
1481 ASTReaderListener &Listener,
1482 std::string &SuggestedPredefines);
1489 unsigned ClientLoadCapabilities);
1493 unsigned ClientLoadCapabilities,
1494 bool AllowCompatibleConfigurationMismatch, ASTReaderListener *Listener,
1495 bool ValidateDiagnosticOptions);
1497 llvm::Error ReadASTBlock(
ModuleFile &F,
unsigned ClientLoadCapabilities);
1498 llvm::Error ReadExtensionBlock(
ModuleFile &F);
1499 void ReadModuleOffsetMap(
ModuleFile &F)
const;
1501 llvm::Error ReadSourceManagerBlock(
ModuleFile &F);
1502 SourceLocation getImportLocation(
ModuleFile *F);
1505 unsigned ClientLoadCapabilities);
1506 llvm::Error ReadSubmoduleBlock(
ModuleFile &F,
1507 unsigned ClientLoadCapabilities);
1509 StringRef ModuleFilename,
bool Complain,
1510 ASTReaderListener &Listener,
1511 bool AllowCompatibleDifferences);
1513 StringRef ModuleFilename,
bool Complain,
1514 ASTReaderListener &Listener,
1515 bool AllowCompatibleDifferences);
1517 StringRef ModuleFilename,
bool Complain,
1518 ASTReaderListener &Listener);
1519 static bool ParseFileSystemOptions(
const RecordData &
Record,
bool Complain,
1520 ASTReaderListener &Listener);
1522 StringRef ModuleFilename,
bool Complain,
1523 ASTReaderListener &Listener);
1524 static bool ParseHeaderSearchPaths(
const RecordData &
Record,
bool Complain,
1525 ASTReaderListener &Listener);
1527 StringRef ModuleFilename,
bool Complain,
1528 ASTReaderListener &Listener,
1529 std::string &SuggestedPredefines);
1531 struct RecordLocation {
1535 RecordLocation(
ModuleFile *M, uint64_t O) : F(M), Offset(O) {}
1540 void LoadedDecl(
unsigned Index, Decl *
D);
1541 Decl *ReadDeclRecord(GlobalDeclID ID);
1542 void markIncompleteDeclChain(Decl *
D);
1547 Decl *getMostRecentExistingDecl(Decl *
D);
1549 RecordLocation DeclCursorForID(GlobalDeclID ID, SourceLocation &Location);
1550 void loadDeclUpdateRecords(PendingUpdateRecord &
Record);
1551 void loadPendingDeclChain(Decl *
D, uint64_t LocalOffset);
1552 void loadObjCCategories(GlobalDeclID ID, ObjCInterfaceDecl *
D,
1553 unsigned PreviousGeneration = 0);
1555 RecordLocation getLocalBitOffset(uint64_t GlobalOffset);
1561 findPreprocessedEntity(SourceLocation
Loc,
bool EndsAfter)
const;
1570 findNextPreprocessedEntity(
1575 std::pair<ModuleFile *, unsigned>
1576 getModulePreprocessedEntity(
unsigned GlobalIndex);
1580 llvm::iterator_range<PreprocessingRecord::iterator>
1581 getModulePreprocessedEntities(
ModuleFile &Mod)
const;
1583 bool canRecoverFromOutOfDate(StringRef ModuleFileName,
1584 unsigned ClientLoadCapabilities);
1588 :
public llvm::iterator_adaptor_base<
1589 ModuleDeclIterator, const serialization::unaligned_decl_id_t *,
1590 std::random_access_iterator_tag, const Decl *, ptrdiff_t,
1591 const Decl *, const Decl *> {
1600 : iterator_adaptor_base(Pos), Reader(Reader), Mod(Mod) {}
1610 assert(Reader == RHS.Reader && Mod == RHS.Mod);
1615 llvm::iterator_range<ModuleDeclIterator>
1619 bool isConsumerInterestedIn(
Decl *
D);
1620 void PassInterestingDeclsToConsumer();
1621 void PassInterestingDeclToConsumer(
Decl *
D);
1624 void finishPendingActions();
1625 void diagnoseOdrViolations();
1632 PendingDeclContextInfo Info = {
D, SemaDC, LexicalDC };
1633 PendingDeclContextInfos.push_back(Info);
1640 void Error(StringRef Msg)
const;
1641 void Error(
unsigned DiagID, StringRef Arg1 = StringRef(),
1642 StringRef Arg2 = StringRef(), StringRef Arg3 = StringRef())
const;
1643 void Error(llvm::Error &&Err)
const;
1646 unsigned translateGlobalDeclIDToIndex(GlobalDeclID ID)
const;
1650 std::pair<ModuleFile *, unsigned>
1655 std::pair<ModuleFile *, unsigned>
1701 ASTReader(Preprocessor &PP, InMemoryModuleCache &ModuleCache,
1702 ASTContext *Context,
const PCHContainerReader &PCHContainerRdr,
1703 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
1704 StringRef isysroot =
"",
1707 bool AllowASTWithCompilerErrors =
false,
1708 bool AllowConfigurationMismatch =
false,
1709 bool ValidateSystemInputs =
false,
1710 bool ValidateASTInputFilesContent =
false,
1711 bool UseGlobalIndex =
true,
1712 std::unique_ptr<llvm::Timer> ReadTimer = {});
1775 unsigned ClientLoadCapabilities,
1800 return std::move(Listener);
1805 this->Listener = std::move(Listener);
1813 L = std::make_unique<ChainedASTReaderListener>(std::move(L),
1814 std::move(Listener));
1815 Listener = std::move(L);
1821 bool Chained =
false;
1829 L = std::make_unique<ChainedASTReaderListener>(std::move(L),
1845 bool TakeOwnership =
false);
1849 return DeserializationListener;
1878 std::unique_ptr<llvm::MemoryBuffer> Buffer) {
1928 StringRef ExistingModuleCachePath,
1929 bool RequireStrictOptionMatches =
false);
1944 std::pair<unsigned, unsigned>
1962 return TotalNumSLocEntries;
1967 return static_cast<unsigned>(IdentifiersLoaded.size());
1972 return static_cast<unsigned>(MacrosLoaded.size());
1977 return static_cast<unsigned>(TypesLoaded.size());
1982 return static_cast<unsigned>(DeclsLoaded.size());
1987 return static_cast<unsigned>(SubmodulesLoaded.size());
1992 return static_cast<unsigned>(SelectorsLoaded.size());
1999 for (
const auto &M : ModuleMgr)
2000 Result += M.NumPreprocessedEntities;
2018 if (Idx >=
Record.size())
2086 template <
typename T>
2110 uint64_t *StartOfBlockOffset =
nullptr);
2139 llvm::function_ref<
bool(
Decl::Kind)> IsKindWeWant,
2208 llvm::MapVector<NamedDecl *, SourceLocation> &Undefined)
override;
2235 SmallVectorImpl<std::pair<IdentifierInfo *, WeakInfo>> &WeakIDs)
override;
2244 llvm::MapVector<
const FunctionDecl *, std::unique_ptr<LateParsedTemplate>>
2264 llvm::function_ref<
void()> Fn);
2310 unsigned LocalID)
const;
2349 unsigned LocalID)
const;
2363 std::pair<SourceLocation, unsigned>
2373 ReadModuleOffsetMap(MF);
2380 "Run out source location space");
2389 if (
Loc.isInvalid())
2410 unsigned &Idx)
const {
2416 assert(FID.ID >= 0 &&
"Reading non-local FileID.");
2424 unsigned &Idx, LocSeq *
Seq =
nullptr);
2427 const StringRef Blob);
2441 unsigned &Idx, StringRef &Blob);
2457 assert(ReadingKind == Read_Stmt &&
2458 "Should be called only during statement reading!");
2461 assert(!StmtStack.empty() &&
"Read too many sub-statements!");
2462 return StmtStack.pop_back_val();
2486 uint32_t MacroDirectivesOffset);
2502 assert(ContextObj &&
"requested AST context when not loading AST");
2549 bool IncludeSystem,
bool Complain,
2551 bool isSystem)> Visitor);
2564 constexpr static uint32_t BitsIndexUpbound = 32;
2576 CurrentBitsIndex = 0;
2579 void advance(uint32_t BitsWidth) { CurrentBitsIndex += BitsWidth; }
2583 return Value & (1 << CurrentBitsIndex++);
2588 assert(Width < BitsIndexUpbound);
2589 uint32_t Ret = (
Value >> CurrentBitsIndex) & ((1 << Width) - 1);
2590 CurrentBitsIndex += Width;
2595 return CurrentBitsIndex + Width < BitsIndexUpbound;
2599 bool isValid()
const {
return CurrentBitsIndex < BitsIndexUpbound; }
2602 uint32_t CurrentBitsIndex = ~0;
Defines the Diagnostic-related interfaces.
clang::CharUnits operator*(clang::CharUnits::QuantityType Scale, const clang::CharUnits &CU)
enum clang::sema::@1718::IndirectLocalPathEntry::EntryKind Kind
Defines the clang::IdentifierInfo, clang::IdentifierTable, and clang::Selector interfaces.
llvm::MachO::Record Record
Defines the clang::OpenCLOptions class.
Defines the clang::SourceLocation class and associated facilities.
Defines a utilitiy for warning once when close to out of stack space.
C Language Family Type Representation.
Defines version macros and version-related utility functions for Clang.
ASTConsumer - This is an abstract interface that should be implemented by clients that read ASTs.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
const LangOptions & getLangOpts() const
An identifier-lookup iterator that enumerates all of the identifiers stored within a set of AST files...
Abstract interface for callback invocations by the ASTReader.
virtual void ReadModuleMapFile(StringRef ModuleMapPath)
virtual bool needsInputFileVisitation()
Returns true if this ASTReaderListener wants to receive the input files of the AST file via visitInpu...
virtual bool ReadTargetOptions(const TargetOptions &TargetOpts, StringRef ModuleFilename, bool Complain, bool AllowCompatibleDifferences)
Receives the target options.
virtual bool visitInputFile(StringRef Filename, bool isSystem, bool isOverridden, bool isExplicitModule)
if needsInputFileVisitation returns true, this is called for each non-system input file of the AST Fi...
virtual bool ReadDiagnosticOptions(IntrusiveRefCntPtr< DiagnosticOptions > DiagOpts, StringRef ModuleFilename, bool Complain)
Receives the diagnostic options.
virtual bool ReadHeaderSearchPaths(const HeaderSearchOptions &HSOpts, bool Complain)
Receives the header search paths.
virtual bool ReadFileSystemOptions(const FileSystemOptions &FSOpts, bool Complain)
Receives the file system options.
virtual ~ASTReaderListener()
virtual bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts, StringRef ModuleFilename, bool ReadMacros, bool Complain, std::string &SuggestedPredefines)
Receives the preprocessor options.
virtual bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts, StringRef ModuleFilename, StringRef SpecificModuleCachePath, bool Complain)
Receives the header search options.
virtual void readModuleFileExtension(const ModuleFileExtensionMetadata &Metadata)
Indicates that a particular module file extension has been read.
virtual bool ReadLanguageOptions(const LangOptions &LangOpts, StringRef ModuleFilename, bool Complain, bool AllowCompatibleDifferences)
Receives the language options.
virtual void visitImport(StringRef ModuleName, StringRef Filename)
If needsImportVisitation returns true, this is called for each AST file imported by this AST file.
virtual void visitModuleFile(StringRef Filename, serialization::ModuleKind Kind)
This is called for each AST file loaded.
virtual bool needsImportVisitation() const
Returns true if this ASTReaderListener wants to receive the imports of the AST file via visitImport,...
virtual bool ReadFullVersionInformation(StringRef FullVersion)
Receives the full Clang version information.
virtual void ReadCounter(const serialization::ModuleFile &M, unsigned Value)
Receives COUNTER value.
virtual void ReadModuleName(StringRef ModuleName)
virtual bool needsSystemInputFileVisitation()
Returns true if this ASTReaderListener wants to receive the system input files of the AST file via vi...
RAII object to temporarily add an AST callback listener.
ListenerScope(ASTReader &Reader, std::unique_ptr< ASTReaderListener > L)
value_type operator*() const
value_type operator->() const
bool operator==(const ModuleDeclIterator &RHS) const
ModuleDeclIterator(ASTReader *Reader, ModuleFile *Mod, const serialization::unaligned_decl_id_t *Pos)
Reads an AST files chain containing the contents of a translation unit.
std::optional< bool > isPreprocessedEntityInFileID(unsigned Index, FileID FID) override
Optionally returns true or false if the preallocated preprocessed entity with index Index came from f...
PreprocessedEntity * ReadPreprocessedEntity(unsigned Index) override
Read a preallocated preprocessed entity from the external source.
void markIdentifierUpToDate(const IdentifierInfo *II)
Note that this identifier is up-to-date.
void visitTopLevelModuleMaps(serialization::ModuleFile &MF, llvm::function_ref< void(FileEntryRef)> Visitor)
Visit all the top-level module maps loaded when building the given module file.
void setDeserializationListener(ASTDeserializationListener *Listener, bool TakeOwnership=false)
Set the AST deserialization listener.
SmallVectorImpl< uint64_t > RecordDataImpl
serialization::SubmoduleID getGlobalSubmoduleID(ModuleFile &M, unsigned LocalID) const
Retrieve the global submodule ID given a module and its local ID number.
ExtKind hasExternalDefinitions(const Decl *D) override
IdentifierTable & getIdentifierTable()
Retrieve the identifier table associated with the preprocessor.
SourceLocationEncoding::RawLocEncoding RawLocEncoding
ModuleManager & getModuleManager()
Retrieve the module manager.
ASTReader & operator=(const ASTReader &)=delete
bool isDeclIDFromModule(GlobalDeclID ID, ModuleFile &M) const
Returns true if global DeclID ID originated from module M.
bool ReadSLocEntry(int ID) override
Read the source location entry with index ID.
void RecordSwitchCaseID(SwitchCase *SC, unsigned ID)
Record that the given ID maps to the given switch-case statement.
DiagnosticBuilder Diag(unsigned DiagID) const
Report a diagnostic.
unsigned getTotalNumPreprocessedEntities() const
Returns the number of preprocessed entities known to the AST reader.
ASTContext & getContext()
Retrieve the AST context that this AST reader supplements.
Decl * ReadDecl(ModuleFile &F, const RecordDataImpl &R, unsigned &I)
Reads a declaration from the given position in a record in the given module.
ModuleManager::ModuleIterator ModuleIterator
static std::string ReadString(const RecordDataImpl &Record, unsigned &Idx)
void ReadDeclsToCheckForDeferredDiags(llvm::SmallSetVector< Decl *, 4 > &Decls) override
Read the set of decls to be checked for deferred diags.
void InitializeSema(Sema &S) override
Initialize the semantic source with the Sema instance being used to perform semantic analysis on the ...
LoadFailureCapabilities
Flags that indicate what kind of AST loading failures the client of the AST reader can directly handl...
@ ARR_Missing
The client can handle an AST file that cannot load because it is missing.
@ ARR_None
The client can't handle any AST loading failures.
@ ARR_ConfigurationMismatch
The client can handle an AST file that cannot load because it's compiled configuration doesn't match ...
@ ARR_OutOfDate
The client can handle an AST file that cannot load because it is out-of-date relative to its input fi...
@ ARR_TreatModuleWithErrorsAsOutOfDate
If a module file is marked with errors treat it as out-of-date so the caller can rebuild it.
@ ARR_VersionMismatch
The client can handle an AST file that cannot load because it was built with a different version of C...
void ReadMismatchingDeleteExpressions(llvm::MapVector< FieldDecl *, llvm::SmallVector< std::pair< SourceLocation, bool >, 4 > > &Exprs) override
void FindFileRegionDecls(FileID File, unsigned Offset, unsigned Length, SmallVectorImpl< Decl * > &Decls) override
Get the decls that are contained in a file in the Offset/Length range.
std::string ReadPathBlob(StringRef BaseDirectory, const RecordData &Record, unsigned &Idx, StringRef &Blob)
SourceRange ReadSkippedRange(unsigned Index) override
Read a preallocated skipped range from the external source.
serialization::TypeID getGlobalTypeID(ModuleFile &F, serialization::LocalTypeID LocalID) const
Map a local type ID within a given AST file into a global type ID.
const std::string & getSuggestedPredefines()
Returns the suggested contents of the predefines buffer, which contains a (typically-empty) subset of...
void dump()
Dump information about the AST reader to standard error.
MacroInfo * ReadMacroRecord(ModuleFile &F, uint64_t Offset)
Reads the macro record located at the given offset.
SmallVector< std::pair< llvm::BitstreamCursor, serialization::ModuleFile * >, 8 > CommentsCursors
Cursors for comments blocks.
Selector getLocalSelector(ModuleFile &M, unsigned LocalID)
Retrieve a selector from the given module with its local ID number.
void FindExternalLexicalDecls(const DeclContext *DC, llvm::function_ref< bool(Decl::Kind)> IsKindWeWant, SmallVectorImpl< Decl * > &Decls) override
Read all of the declarations lexically stored in a declaration context.
ModuleFile * getOwningModuleFile(const Decl *D) const
Retrieve the module file that owns the given declaration, or NULL if the declaration is not from a mo...
std::optional< ASTSourceDescriptor > getSourceDescriptor(unsigned ID) override
Return a descriptor for the corresponding module.
const serialization::reader::DeclContextLookupTable * getLoadedLookupTables(DeclContext *Primary) const
Get the loaded lookup tables for Primary, if any.
T * ReadDeclAs(ModuleFile &F, const RecordDataImpl &R, unsigned &I)
Reads a declaration from the given position in a record in the given module.
QualType getLocalType(ModuleFile &F, serialization::LocalTypeID LocalID)
Resolve a local type ID within a given AST file into a type.
void ClearSwitchCaseIDs()
Sema::AlignPackInfo ReadAlignPackInfo(uint32_t Raw) const
Read a AlignPackInfo from raw form.
QualType readType(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Read a type from the current position in the given record, which was read from the given AST file.
SourceLocation ReadSourceLocation(ModuleFile &MF, RawLocEncoding Raw, LocSeq *Seq=nullptr) const
Read a source location from raw form.
void SetGloballyVisibleDecls(IdentifierInfo *II, const SmallVectorImpl< GlobalDeclID > &DeclIDs, SmallVectorImpl< Decl * > *Decls=nullptr)
Set the globally-visible declarations associated with the given identifier.
serialization::ModuleKind ModuleKind
bool loadGlobalIndex()
Attempts to load the global index.
void ReadComments() override
Loads comments ranges.
SourceManager & getSourceManager() const
SourceLocation getSourceLocationForDeclID(GlobalDeclID ID)
Returns the source location for the decl ID.
void makeModuleVisible(Module *Mod, Module::NameVisibilityKind NameVisibility, SourceLocation ImportLoc)
Make the entities in the given module and any of its (non-explicit) submodules visible to name lookup...
unsigned getTotalNumSubmodules() const
Returns the number of submodules known.
ASTReader(const ASTReader &)=delete
bool LoadExternalSpecializations(const Decl *D, bool OnlyPartial) override
Load all the external specializations for the Decl.
void finalizeForWriting()
Finalizes the AST reader's state before writing an AST file to disk.
Sema * getSema()
Retrieve the semantic analysis object used to analyze the translation unit in which the precompiled h...
static std::string ResolveImportedPathAndAllocate(SmallString< 0 > &Buf, StringRef Path, ModuleFile &ModF)
Resolve Path in the context of module file M.
static StringRef ReadStringBlob(const RecordDataImpl &Record, unsigned &Idx, StringRef &Blob)
unsigned getTotalNumIdentifiers() const
Returns the number of identifiers found in the chain.
CXXCtorInitializer ** GetExternalCXXCtorInitializers(uint64_t Offset) override
Read the contents of a CXXCtorInitializer array.
void visitInputFileInfos(serialization::ModuleFile &MF, bool IncludeSystem, llvm::function_ref< void(const serialization::InputFileInfo &IFI, bool IsSystem)> Visitor)
Visit all the input file infos of the given module file.
const ModuleManager & getModuleManager() const
unsigned getTotalNumSLocs() const
Returns the number of source locations found in the chain.
void StartTranslationUnit(ASTConsumer *Consumer) override
Function that will be invoked when we begin parsing a new translation unit involving this external AS...
LocalDeclID mapGlobalIDToModuleFileGlobalID(ModuleFile &M, GlobalDeclID GlobalID)
Map a global declaration ID into the declaration ID used to refer to this declaration within the give...
void resolvePendingMacro(IdentifierInfo *II, const PendingMacroInfo &PMInfo)
bool FindExternalVisibleDeclsByName(const DeclContext *DC, DeclarationName Name) override
Finds all the visible declarations with a given name.
void ReadTentativeDefinitions(SmallVectorImpl< VarDecl * > &TentativeDefs) override
Read the set of tentative definitions known to the external Sema source.
Decl * GetExternalDecl(GlobalDeclID ID) override
Resolve a declaration ID into a declaration, potentially building a new declaration.
std::pair< SourceLocation, unsigned > ReadUntranslatedSourceLocation(RawLocEncoding Raw, LocSeq *Seq=nullptr) const
Read a source location from raw form and return it in its originating module file's source location s...
GlobalDeclID ReadDeclID(ModuleFile &F, const RecordDataImpl &Record, unsigned &Idx)
Reads a declaration ID from the given position in a record in the given module.
llvm::Expected< SourceLocation::UIntTy > readSLocOffset(ModuleFile *F, unsigned Index)
Try to read the offset of the SLocEntry at the given index in the given module file.
void forEachImportedKeyDecl(const Decl *D, Fn Visit)
Run a callback on each imported key declaration of D.
bool haveUnloadedSpecializations(const Decl *D) const
If we have any unloaded specialization for D.
Stmt * ReadSubStmt()
Reads a sub-statement operand during statement reading.
void CompleteRedeclChain(const Decl *D) override
If any redeclarations of D have been imported since it was last checked, this digs out those redeclar...
Expr * ReadSubExpr()
Reads a sub-expression operand during statement reading.
SourceLocation TranslateSourceLocation(ModuleFile &ModuleFile, SourceLocation Loc) const
Translate a source location from another module file's source location space into ours.
static llvm::Error ReadBlockAbbrevs(llvm::BitstreamCursor &Cursor, unsigned BlockID, uint64_t *StartOfBlockOffset=nullptr)
ReadBlockAbbrevs - Enter a subblock of the specified BlockID with the specified cursor.
void SetIdentifierInfo(serialization::IdentifierID ID, IdentifierInfo *II)
serialization::PreprocessedEntityID getGlobalPreprocessedEntityID(ModuleFile &M, unsigned LocalID) const
Determine the global preprocessed entity ID that corresponds to the given local ID within the given m...
std::pair< unsigned, unsigned > findPreprocessedEntitiesInRange(SourceRange Range) override
Returns a pair of [Begin, End) indices of preallocated preprocessed entities that Range encompasses.
IdentifierInfo * get(StringRef Name) override
Retrieve the IdentifierInfo for the named identifier.
IdentifierInfo * getLocalIdentifier(ModuleFile &M, uint64_t LocalID)
void visitInputFiles(serialization::ModuleFile &MF, bool IncludeSystem, bool Complain, llvm::function_ref< void(const serialization::InputFile &IF, bool isSystem)> Visitor)
Visit all the input files of the given module file.
Module * getModule(unsigned ID) override
Retrieve the module that corresponds to the given module ID.
llvm::iterator_range< ModuleDeclIterator > getModuleFileLevelDecls(ModuleFile &Mod)
Stmt * GetExternalDeclStmt(uint64_t Offset) override
Resolve the offset of a statement into a statement.
Selector GetExternalSelector(serialization::SelectorID ID) override
Resolve a selector ID into a selector.
unsigned getTotalNumSelectors() const
Returns the number of selectors found in the chain.
MacroInfo * getMacro(serialization::MacroID ID)
Retrieve the macro with the given ID.
void ReadUndefinedButUsed(llvm::MapVector< NamedDecl *, SourceLocation > &Undefined) override
Load the set of used but not defined functions or variables with internal linkage,...
void ReadDelegatingConstructors(SmallVectorImpl< CXXConstructorDecl * > &Decls) override
Read the set of delegating constructors known to the external Sema source.
unsigned getTotalNumTypes() const
Returns the number of types found in the chain.
QualType GetType(serialization::TypeID ID)
Resolve a type ID into a type, potentially building a new type.
void addPendingMacro(IdentifierInfo *II, ModuleFile *M, uint32_t MacroDirectivesOffset)
Add a macro to deserialize its macro directive history.
SourceRange ReadSourceRange(ModuleFile &F, const RecordData &Record, unsigned &Idx, LocSeq *Seq=nullptr)
Read a source range.
GlobalDeclID getGlobalDeclID(ModuleFile &F, LocalDeclID LocalID) const
Map from a local declaration ID within a given module to a global declaration ID.
Expr * ReadExpr(ModuleFile &F)
Reads an expression.
void ReadWeakUndeclaredIdentifiers(SmallVectorImpl< std::pair< IdentifierInfo *, WeakInfo > > &WeakIDs) override
Read the set of weak, undeclared identifiers known to the external Sema source.
void completeVisibleDeclsMap(const DeclContext *DC) override
Load all external visible decls in the given DeclContext.
void AssignedLambdaNumbering(CXXRecordDecl *Lambda) override
Notify the external source that a lambda was assigned a mangling number.
void ReadUnusedLocalTypedefNameCandidates(llvm::SmallSetVector< const TypedefNameDecl *, 4 > &Decls) override
Read the set of potentially unused typedefs known to the source.
IdentifierResolver & getIdResolver()
Get the identifier resolver used for name lookup / updates in the translation unit scope.
static bool readASTFileControlBlock(StringRef Filename, FileManager &FileMgr, const InMemoryModuleCache &ModuleCache, const PCHContainerReader &PCHContainerRdr, bool FindModuleFileExtensions, ASTReaderListener &Listener, bool ValidateDiagnosticOptions, unsigned ClientLoadCapabilities=ARR_ConfigurationMismatch|ARR_OutOfDate)
Read the control block for the named AST file.
void ReadExtVectorDecls(SmallVectorImpl< TypedefNameDecl * > &Decls) override
Read the set of ext_vector type declarations known to the external Sema source.
SmallVector< GlobalDeclID, 16 > PreloadedDeclIDs
std::pair< SourceLocation, StringRef > getModuleImportLoc(int ID) override
Retrieve the module import location and module name for the given source manager entry ID.
void ReadUnusedFileScopedDecls(SmallVectorImpl< const DeclaratorDecl * > &Decls) override
Read the set of unused file-scope declarations known to the external Sema source.
void ReadReferencedSelectors(SmallVectorImpl< std::pair< Selector, SourceLocation > > &Sels) override
Read the set of referenced selectors known to the external Sema source.
Selector DecodeSelector(serialization::SelectorID Idx)
ASTReadResult ReadAST(StringRef FileName, ModuleKind Type, SourceLocation ImportLoc, unsigned ClientLoadCapabilities, ModuleFile **NewLoadedModuleFile=nullptr)
Load the AST file designated by the given file name.
StringRef getOriginalSourceFile()
Retrieve the name of the original source file name for the primary module file.
std::string ReadPath(ModuleFile &F, const RecordData &Record, unsigned &Idx)
ASTDeserializationListener * getDeserializationListener()
Get the AST deserialization listener.
void addListener(std::unique_ptr< ASTReaderListener > L)
Add an AST callback listener.
unsigned getModuleFileID(ModuleFile *M)
Get an ID for the given module file.
Decl * getKeyDeclaration(Decl *D)
Returns the first key declaration for the given declaration.
void setListener(std::unique_ptr< ASTReaderListener > Listener)
Set the AST callbacks listener.
Selector ReadSelector(ModuleFile &M, const RecordData &Record, unsigned &Idx)
ModuleManager::ModuleReverseIterator ModuleReverseIterator
IdentifierInfo * DecodeIdentifierInfo(serialization::IdentifierID ID)
ASTReadResult
The result of reading the control block of an AST file, which can fail for various reasons.
@ Success
The control block was read successfully.
@ ConfigurationMismatch
The AST file was written with a different language/target configuration.
@ OutOfDate
The AST file is out-of-date relative to its input files, and needs to be regenerated.
@ Failure
The AST file itself appears corrupted.
@ VersionMismatch
The AST file was written by a different version of Clang.
@ HadErrors
The AST file has errors.
@ Missing
The AST file was missing.
void addInMemoryBuffer(StringRef &FileName, std::unique_ptr< llvm::MemoryBuffer > Buffer)
Add in-memory (virtual file) buffer.
static VersionTuple ReadVersionTuple(const RecordData &Record, unsigned &Idx)
Read a version tuple.
SmallString< 0 > & getPathBuf()
Get the buffer for resolving paths.
Token ReadToken(ModuleFile &M, const RecordDataImpl &Record, unsigned &Idx)
Reads a token out of a record.
SwitchCase * getSwitchCaseWithID(unsigned ID)
Retrieve the switch-case statement with the given ID.
serialization::IdentifierID getGlobalIdentifierID(ModuleFile &M, uint64_t LocalID)
FileID TranslateFileID(ModuleFile &F, FileID FID) const
Translate a FileID from another module file's FileID space into ours.
void ReadLateParsedTemplates(llvm::MapVector< const FunctionDecl *, std::unique_ptr< LateParsedTemplate > > &LPTMap) override
Read the set of late parsed template functions for this source.
IdentifierIterator * getIdentifiers() override
Retrieve an iterator into the set of all identifiers in all loaded AST files.
void ReadUsedVTables(SmallVectorImpl< ExternalVTableUse > &VTables) override
Read the set of used vtables known to the external Sema source.
bool isGlobalIndexUnavailable() const
Determine whether we tried to load the global index, but failed, e.g., because it is out-of-date or d...
uint32_t GetNumExternalSelectors() override
Returns the number of selectors known to the external AST source.
static TemporarilyOwnedStringRef ResolveImportedPath(SmallString< 0 > &Buf, StringRef Path, ModuleFile &ModF)
Resolve Path in the context of module file M.
void updateOutOfDateSelector(Selector Sel) override
Load the contents of the global method pool for a given selector if necessary.
Decl * GetExistingDecl(GlobalDeclID ID)
Resolve a declaration ID into a declaration.
Stmt * ReadStmt(ModuleFile &F)
Reads a statement.
static llvm::BitVector ReadBitVector(const RecordData &Record, const StringRef Blob)
ModuleFile * getLocalModuleFile(ModuleFile &M, unsigned ID) const
Retrieve the module file with a given local ID within the specified ModuleFile.
void ForgetSema() override
Inform the semantic consumer that Sema is no longer available.
DiagnosticsEngine & getDiags() const
void LoadSelector(Selector Sel)
Load a selector from disk, registering its ID if it exists.
void ReadPragmaDiagnosticMappings(DiagnosticsEngine &Diag)
void makeNamesVisible(const HiddenNames &Names, Module *Owner)
Make the names within this set of hidden names visible.
void UpdateSema()
Update the state of Sema after loading some additional modules.
Decl * GetDecl(GlobalDeclID ID)
Resolve a declaration ID into a declaration, potentially building a new declaration.
Decl * GetLocalDecl(ModuleFile &F, LocalDeclID LocalID)
Reads a declaration with the given local ID in the given module.
bool isProcessingUpdateRecords()
T * GetLocalDeclAs(ModuleFile &F, LocalDeclID LocalID)
Reads a declaration with the given local ID in the given module.
ASTReader(Preprocessor &PP, InMemoryModuleCache &ModuleCache, ASTContext *Context, const PCHContainerReader &PCHContainerRdr, ArrayRef< std::shared_ptr< ModuleFileExtension > > Extensions, StringRef isysroot="", DisableValidationForModuleKind DisableValidationKind=DisableValidationForModuleKind::None, bool AllowASTWithCompilerErrors=false, bool AllowConfigurationMismatch=false, bool ValidateSystemInputs=false, bool ValidateASTInputFilesContent=false, bool UseGlobalIndex=true, std::unique_ptr< llvm::Timer > ReadTimer={})
Load the AST file and validate its contents against the given Preprocessor.
int getSLocEntryID(SourceLocation::UIntTy SLocOffset) override
Get the index ID for the loaded SourceLocation offset.
void ReadPendingInstantiations(SmallVectorImpl< std::pair< ValueDecl *, SourceLocation > > &Pending) override
Read the set of pending instantiations known to the external Sema source.
Preprocessor & getPreprocessor() const
Retrieve the preprocessor.
serialization::reader::LazySpecializationInfoLookupTable * getLoadedSpecializationsLookupTables(const Decl *D, bool IsPartial)
Get the loaded specializations lookup tables for D, if any.
CXXTemporary * ReadCXXTemporary(ModuleFile &F, const RecordData &Record, unsigned &Idx)
void ReadKnownNamespaces(SmallVectorImpl< NamespaceDecl * > &Namespaces) override
Load the set of namespaces that are known to the external source, which will be used during typo corr...
const Decl * getKeyDeclaration(const Decl *D)
ModuleManager::ModuleConstIterator ModuleConstIterator
Module * getSubmodule(serialization::SubmoduleID GlobalID)
Retrieve the submodule that corresponds to a global submodule ID.
void PrintStats() override
Print some statistics about AST usage.
void mergeDefinitionVisibility(NamedDecl *Def, NamedDecl *MergedDef)
Note that MergedDef is a redefinition of the canonical definition Def, so Def should be visible whene...
serialization::SelectorID getGlobalSelectorID(ModuleFile &M, unsigned LocalID) const
Retrieve the global selector ID that corresponds to this the local selector ID in a given module.
void runWithSufficientStackSpace(SourceLocation Loc, llvm::function_ref< void()> Fn)
SmallVector< uint64_t, 64 > RecordData
unsigned getTotalNumMacros() const
Returns the number of macros found in the chain.
FileID ReadFileID(ModuleFile &F, const RecordDataImpl &Record, unsigned &Idx) const
Read a FileID.
void StartedDeserializing() override
Notify ASTReader that we started deserialization of a decl or type so until FinishedDeserializing is ...
void ReadMethodPool(Selector Sel) override
Load the contents of the global method pool for a given selector.
void InitializeContext()
Initializes the ASTContext.
CXXBaseSpecifier * GetExternalCXXBaseSpecifiers(uint64_t Offset) override
Resolve the offset of a set of C++ base specifiers in the decl stream into an array of specifiers.
std::unique_ptr< ASTReaderListener > takeListener()
Take the AST callbacks listener.
void resetForReload()
Reset reader for a reload try.
FileManager & getFileManager() const
unsigned getTotalNumDecls() const
Returns the number of declarations found in the chain.
static bool isAcceptableASTFile(StringRef Filename, FileManager &FileMgr, const InMemoryModuleCache &ModuleCache, const PCHContainerReader &PCHContainerRdr, const LangOptions &LangOpts, const TargetOptions &TargetOpts, const PreprocessorOptions &PPOpts, StringRef ExistingModuleCachePath, bool RequireStrictOptionMatches=false)
Determine whether the given AST file is acceptable to load into a translation unit with the given lan...
void FinishedDeserializing() override
Notify ASTReader that we finished the deserialization of a decl or type.
IdentifierInfo * readIdentifier(ModuleFile &M, const RecordData &Record, unsigned &Idx)
void updateOutOfDateIdentifier(const IdentifierInfo &II) override
Update an out-of-date identifier.
void ReadDefinedMacros() override
Read the set of macros defined by this external macro source.
GlobalModuleIndex * getGlobalIndex()
Return global module index.
IdentifierInfo * GetIdentifier(serialization::IdentifierID ID) override
Return the identifier associated with the given ID number.
HeaderFileInfo GetHeaderFileInfo(FileEntryRef FE) override
Read the header file information for the given file entry.
SourceLocation ReadSourceLocation(ModuleFile &ModuleFile, const RecordDataImpl &Record, unsigned &Idx, LocSeq *Seq=nullptr)
Read a source location.
serialization::MacroID getGlobalMacroID(ModuleFile &M, unsigned LocalID)
Retrieve the global macro ID corresponding to the given local ID within the given module file.
serialization::ModuleFile ModuleFile
bool hasGlobalIndex() const
Determine whether this AST reader has a global index.
An object for streaming information from a record.
Utility class for loading a ASTContext from an AST file.
Writes an AST file containing the contents of a translation unit.
A simple helper class to unpack an integer to bits and consuming the bits in order.
BitsUnpacker operator=(const BitsUnpacker &)=delete
uint32_t getNextBits(uint32_t Width)
void advance(uint32_t BitsWidth)
bool canGetNextNBits(uint32_t Width) const
BitsUnpacker(BitsUnpacker &&)=delete
BitsUnpacker(const BitsUnpacker &)=delete
void updateValue(uint32_t V)
BitsUnpacker operator=(BitsUnpacker &&)=delete
Represents a base class of a C++ class.
Represents a C++ base or member initializer.
Represents a C++ struct/union/class.
Represents a C++ temporary.
Simple wrapper class for chaining listeners.
bool visitInputFile(StringRef Filename, bool isSystem, bool isOverridden, bool isExplicitModule) override
if needsInputFileVisitation returns true, this is called for each non-system input file of the AST Fi...
std::unique_ptr< ASTReaderListener > takeSecond()
bool ReadFullVersionInformation(StringRef FullVersion) override
Receives the full Clang version information.
bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts, StringRef ModuleFilename, StringRef SpecificModuleCachePath, bool Complain) override
Receives the header search options.
bool ReadFileSystemOptions(const FileSystemOptions &FSOpts, bool Complain) override
Receives the file system options.
std::unique_ptr< ASTReaderListener > takeFirst()
void ReadCounter(const serialization::ModuleFile &M, unsigned Value) override
Receives COUNTER value.
void ReadModuleMapFile(StringRef ModuleMapPath) override
bool ReadLanguageOptions(const LangOptions &LangOpts, StringRef ModuleFilename, bool Complain, bool AllowCompatibleDifferences) override
Receives the language options.
bool ReadTargetOptions(const TargetOptions &TargetOpts, StringRef ModuleFilename, bool Complain, bool AllowCompatibleDifferences) override
Receives the target options.
void ReadModuleName(StringRef ModuleName) override
bool needsInputFileVisitation() override
Returns true if this ASTReaderListener wants to receive the input files of the AST file via visitInpu...
bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts, StringRef ModuleFilename, bool ReadMacros, bool Complain, std::string &SuggestedPredefines) override
Receives the preprocessor options.
ChainedASTReaderListener(std::unique_ptr< ASTReaderListener > First, std::unique_ptr< ASTReaderListener > Second)
Takes ownership of First and Second.
void readModuleFileExtension(const ModuleFileExtensionMetadata &Metadata) override
Indicates that a particular module file extension has been read.
void visitModuleFile(StringRef Filename, serialization::ModuleKind Kind) override
This is called for each AST file loaded.
bool ReadDiagnosticOptions(IntrusiveRefCntPtr< DiagnosticOptions > DiagOpts, StringRef ModuleFilename, bool Complain) override
Receives the diagnostic options.
bool needsSystemInputFileVisitation() override
Returns true if this ASTReaderListener wants to receive the system input files of the AST file via vi...
A map from continuous integer ranges to some value, with a very specialized interface.
typename Representation::const_iterator const_iterator
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Decl - This represents one declaration (or definition), e.g.
bool isFromGlobalModule() const
Whether this declaration comes from global module.
ASTContext & getASTContext() const LLVM_READONLY
Kind
Lists the kind of concrete classes of Decl.
bool isFromHeaderUnit() const
Whether this declaration comes from a header unit.
The name of a declaration.
A little helper class used to produce diagnostics.
Concrete class used by the front-end to report problems and issues.
This represents one expression.
RAII class for safely pairing a StartedDeserializing call with FinishedDeserializing.
MemoryBufferSizes getMemoryBufferSizes() const
Return the amount of memory used by memory buffers, breaking down by heap-backed versus mmap'ed memor...
An abstract class that should be subclassed by any external source of preprocessing record entries.
Abstract interface for external sources of preprocessor information.
External source of source location entries.
An abstract interface that should be implemented by external AST sources that also provide informatio...
Represents a member of a struct/union/class.
A reference to a FileEntry that includes the name of the file as it was accessed by the FileManager's...
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
Implements support for file system lookup, file system caching, and directory search management.
Keeps track of options that affect how file operations are performed.
Represents a function declaration or definition.
A global index for a set of module files, providing information about the identifiers within those mo...
Provides lookups to, and iteration over, IdentiferInfo objects.
One of these records is kept for each identifier that is lexed.
An iterator that walks over all of the known identifiers in the lookup table.
IdentifierResolver - Keeps track of shadowed decls on enclosing scopes.
Implements an efficient mapping from strings to IdentifierInfo nodes.
In-memory cache for modules.
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
static LocalDeclID get(ASTReader &Reader, serialization::ModuleFile &MF, DeclID ID)
Encapsulates the data about a macro definition (e.g.
Describes a module or submodule.
NameVisibilityKind
Describes the visibility of the various names within a particular module.
This represents a decl that may have a name.
This abstract interface provides operations for unwrapping containers for serialized ASTs (precompile...
ASTReaderListener implementation to validate the information of the PCH file against an initialized P...
bool ReadLanguageOptions(const LangOptions &LangOpts, StringRef ModuleFilename, bool Complain, bool AllowCompatibleDifferences) override
Receives the language options.
bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts, StringRef ModuleFilename, StringRef SpecificModuleCachePath, bool Complain) override
Receives the header search options.
bool ReadDiagnosticOptions(IntrusiveRefCntPtr< DiagnosticOptions > DiagOpts, StringRef ModuleFilename, bool Complain) override
Receives the diagnostic options.
PCHValidator(Preprocessor &PP, ASTReader &Reader)
void ReadCounter(const serialization::ModuleFile &M, unsigned Value) override
Receives COUNTER value.
bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts, StringRef ModuleFilename, bool ReadMacros, bool Complain, std::string &SuggestedPredefines) override
Receives the preprocessor options.
bool ReadTargetOptions(const TargetOptions &TargetOpts, StringRef ModuleFilename, bool Complain, bool AllowCompatibleDifferences) override
Receives the target options.
Base class that describes a preprocessed entity, which may be a preprocessor directive or macro expan...
PreprocessorOptions - This class is used for passing the various options used in preprocessor initial...
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
A (possibly-)qualified type.
Smart pointer class that efficiently represents Objective-C method names.
static AlignPackInfo getFromRawEncoding(unsigned Encoding)
Sema - This implements semantic analysis and AST building for C.
ASTReaderListenter implementation to set SuggestedPredefines of ASTReader which is required to use a ...
SimpleASTReaderListener(Preprocessor &PP)
bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts, StringRef ModuleFilename, bool ReadMacros, bool Complain, std::string &SuggestedPredefines) override
Receives the preprocessor options.
static std::pair< SourceLocation, unsigned > decode(RawLocEncoding, SourceLocationSequence *=nullptr)
Serialized encoding of a sequence of SourceLocations.
Encodes a location in the source.
This class handles loading and caching of source files into memory.
bool isLoadedSourceLocation(SourceLocation Loc) const
Returns true if Loc came from a PCH/Module.
A trivial tuple used to represent a source range.
Stmt - This represents one statement.
Options for controlling the target.
Token - This structure provides full information about a lexed token.
The base class of the type hierarchy.
Represent the declaration of a variable (in which case it is an lvalue) a function (in which case it ...
Information about a module that has been loaded by the ASTReader.
int SLocEntryBaseID
The base ID in the source manager's view of this module.
std::string OriginalSourceFileName
The original source file name that was used to build the primary AST file, which may have been modifi...
StringRef ModuleOffsetMap
The module offset map data for this file.
SourceLocation::UIntTy SLocEntryBaseOffset
The base offset in the source manager's view of this module.
llvm::SmallVector< ModuleFile *, 16 > TransitiveImports
List of modules which this modules dependent on.
Manages the set of modules loaded by an AST reader.
ModuleFile & getPrimaryModule()
Returns the primary module associated with the manager, that is, the first module loaded.
llvm::pointee_iterator< SmallVectorImpl< std::unique_ptr< ModuleFile > >::const_iterator > ModuleConstIterator
void addInMemoryBuffer(StringRef FileName, std::unique_ptr< llvm::MemoryBuffer > Buffer)
Add an in-memory buffer the list of known buffers.
llvm::pointee_iterator< SmallVectorImpl< std::unique_ptr< ModuleFile > >::reverse_iterator > ModuleReverseIterator
llvm::pointee_iterator< SmallVectorImpl< std::unique_ptr< ModuleFile > >::iterator > ModuleIterator
Class that performs lookup for an identifier stored in an AST file.
@ Decl
The l-value was an access to a declared entity or something equivalently strong, like the address of ...
uint64_t TypeID
An ID number that refers to a type in an AST file.
llvm::support::detail::packed_endian_specific_integral< serialization::DeclID, llvm::endianness::native, llvm::support::unaligned > unaligned_decl_id_t
TypeID LocalTypeID
Same with TypeID except that the LocalTypeID is only meaningful with the corresponding ModuleFile.
uint32_t SubmoduleID
An ID number that refers to a submodule in a module file.
uint32_t SelectorID
An ID number that refers to an ObjC selector in an AST file.
uint32_t PreprocessedEntityID
An ID number that refers to an entity in the detailed preprocessing record.
ModuleKind
Specifies the kind of module that has been loaded.
uint64_t IdentifierID
An ID number that refers to an identifier in an AST file.
uint32_t MacroID
An ID number that refers to a macro in an AST file.
The JSON file list parser is used to communicate input to InstallAPI.
@ Seq
'seq' clause, allowed on 'loop' and 'routine' directives.
@ Module
Module linkage, which indicates that the entity can be referred to from other translation units withi...
PredefinedDeclIDs
Predefined declaration IDs.
@ Result
The result type of a method or function.
const FunctionProtoType * T
DisableValidationForModuleKind
Whether to disable the normal validation performed on precompiled headers and module files when they ...
@ None
Perform validation, don't disable it.
bool shouldSkipCheckingODR(const Decl *D)
std::string getClangFullRepositoryVersion()
Retrieves the full repository version that is an amalgamation of the information in getClangRepositor...