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;
86class FileSystemOptions;
88class GlobalModuleIndex;
90class HeaderSearchOptions;
96class ObjCCategoryDecl;
97class ObjCInterfaceDecl;
98class PCHContainerReader;
100class PreprocessorOptions;
107class TypedefNameDecl;
136 StringRef ModuleFilename,
bool Complain,
137 bool AllowCompatibleDifferences) {
145 StringRef ModuleFilename,
bool Complain,
146 bool AllowCompatibleDifferences) {
155 StringRef ModuleFilename,
bool Complain,
156 bool AllowCompatibleDifferences) {
165 StringRef ModuleFilename,
bool Complain) {
187 StringRef ModuleFilename,
188 StringRef SpecificModuleCachePath,
216 StringRef ModuleFilename,
217 bool ReadMacros,
bool Complain,
218 std::string &SuggestedPredefines) {
245 bool isOverridden,
bool isExplicitModule) {
256 bool isSystem,
bool isOverridden,
257 bool isExplicitModule) {
276 std::unique_ptr<ASTReaderListener> First;
277 std::unique_ptr<ASTReaderListener> Second;
282 std::unique_ptr<ASTReaderListener> Second)
286 std::unique_ptr<ASTReaderListener>
takeSecond() {
return std::move(Second); }
292 StringRef ModuleFilename,
bool Complain,
293 bool AllowCompatibleDifferences)
override;
295 StringRef ModuleFilename,
bool Complain,
296 bool AllowCompatibleDifferences)
override;
298 StringRef ModuleFilename,
bool Complain,
299 bool AllowCompatibleDifferences)
override;
301 StringRef ModuleFilename,
bool Complain)
override;
303 bool Complain)
override;
306 StringRef ModuleFilename,
307 StringRef SpecificModuleCachePath,
308 bool Complain)
override;
310 StringRef ModuleFilename,
bool ReadMacros,
312 std::string &SuggestedPredefines)
override;
320 bool isOverridden,
bool isExplicitModule)
override;
333 : PP(PP), Reader(Reader) {}
336 StringRef ModuleFilename,
bool Complain,
337 bool AllowCompatibleDifferences)
override;
339 StringRef ModuleFilename,
bool Complain,
340 bool AllowCompatibleDifferences)
override;
342 StringRef ModuleFilename,
bool Complain,
343 bool AllowCompatibleDifferences)
override;
345 StringRef ModuleFilename,
bool Complain)
override;
347 StringRef ModuleFilename,
bool ReadMacros,
349 std::string &SuggestedPredefines)
override;
351 StringRef ModuleFilename,
352 StringRef SpecificModuleCachePath,
353 bool Complain)
override;
368 StringRef ModuleFilename,
bool ReadMacros,
370 std::string &SuggestedPredefines)
override;
373namespace serialization {
375class ReadMethodPoolVisitor;
484 std::unique_ptr<ASTReaderListener> Listener;
489 bool OwnsDeserializationListener =
false;
501 Sema *SemaObj =
nullptr;
524 llvm::StringMap<std::shared_ptr<ModuleFileExtension>> ModuleFileExtensions;
527 std::unique_ptr<llvm::Timer> ReadTimer;
530 std::optional<llvm::TimeRegion> ReadTimeRegion;
537 std::optional<ModuleKind> CurrentDeserializingModuleKind;
540 std::unique_ptr<GlobalModuleIndex> GlobalIndex;
560 llvm::PagedVector<QualType> TypesLoaded;
566 llvm::PagedVector<Decl *> DeclsLoaded;
568 using FileOffset = std::pair<ModuleFile *, uint64_t>;
570 using DeclUpdateOffsetsMap = llvm::DenseMap<GlobalDeclID, FileOffsetsTy>;
574 DeclUpdateOffsetsMap DeclUpdateOffsets;
576 using DelayedNamespaceOffsetMapTy =
577 llvm::DenseMap<GlobalDeclID, LookupBlockOffsets>;
587 DelayedNamespaceOffsetMapTy DelayedNamespaceOffsetMap;
603 llvm::DenseMap<GlobalDeclID, SmallVector<GlobalDeclID, 4>> RelatedDeclsMap;
605 struct PendingUpdateRecord {
613 :
D(
D), ID(ID), JustLoaded(JustLoaded) {}
620 enum class PendingFakeDefinitionKind { NotFake, Fake, FakeLoaded };
624 llvm::DenseMap<void *, PendingFakeDefinitionKind> PendingFakeDefinitionData;
630 llvm::SmallMapVector<Decl *, FunctionDecl *, 4> PendingExceptionSpecUpdates;
635 llvm::SmallMapVector<FunctionDecl *, QualType, 4> PendingDeducedTypeUpdates;
643 llvm::DenseMap<std::pair<DeclContext *, IdentifierInfo *>, NamedDecl *>
644 ImportedTypedefNamesForLinkage;
648 llvm::DenseMap<Decl*, llvm::SmallVector<NamedDecl*, 2>>
649 AnonymousDeclarationsForMerging;
652 llvm::DenseMap<std::pair<const Decl *, unsigned>, NamedDecl *>
653 LambdaDeclarationsForMerging;
657 using LETemporaryKey = std::pair<Decl *, unsigned>;
660 llvm::DenseMap<LETemporaryKey, LifetimeExtendedTemporaryDecl *>
661 LETemporaryForMerging;
663 struct FileDeclsInfo {
665 ArrayRef<serialization::unaligned_decl_id_t> Decls;
667 FileDeclsInfo() =
default;
669 ArrayRef<serialization::unaligned_decl_id_t> Decls)
670 : Mod(Mod), Decls(Decls) {}
674 llvm::DenseMap<FileID, FileDeclsInfo> FileDeclIDs;
678 using LexicalContents = ArrayRef<serialization::unaligned_decl_id_t>;
681 llvm::DenseMap<const DeclContext*, std::pair<ModuleFile*, LexicalContents>>
685 std::vector<std::pair<ModuleFile*, LexicalContents>> TULexicalDecls;
688 llvm::DenseMap<
const DeclContext *,
689 serialization::reader::DeclContextLookupTable> Lookups;
690 llvm::DenseMap<
const DeclContext *,
691 serialization::reader::ModuleLocalLookupTable>
693 llvm::DenseMap<
const DeclContext *,
694 serialization::reader::DeclContextLookupTable>
697 using SpecLookupTableTy =
698 llvm::DenseMap<
const Decl *,
699 serialization::reader::LazySpecializationInfoLookupTable>;
701 SpecLookupTableTy SpecializationsLookups;
703 SpecLookupTableTy PartialSpecializationsLookups;
705 bool LoadExternalSpecializationsImpl(SpecLookupTableTy &SpecLookups,
707 bool LoadExternalSpecializationsImpl(SpecLookupTableTy &SpecLookups,
709 ArrayRef<TemplateArgument> TemplateArgs);
717 const unsigned char *
Data;
719 using DeclContextVisibleUpdates = SmallVector<UpdateData, 1>;
723 llvm::DenseMap<GlobalDeclID, DeclContextVisibleUpdates> PendingVisibleUpdates;
724 llvm::DenseMap<GlobalDeclID, DeclContextVisibleUpdates>
725 PendingModuleLocalVisibleUpdates;
726 llvm::DenseMap<GlobalDeclID, DeclContextVisibleUpdates> TULocalUpdates;
728 using SpecializationsUpdate = SmallVector<UpdateData, 1>;
729 using SpecializationsUpdateMap =
730 llvm::DenseMap<GlobalDeclID, SpecializationsUpdate>;
731 SpecializationsUpdateMap PendingSpecializationsUpdates;
732 SpecializationsUpdateMap PendingPartialSpecializationsUpdates;
738 using PendingBodiesMap =
740 llvm::SmallDenseMap<Decl *, unsigned, 4>,
741 SmallVector<std::pair<Decl *, uint64_t>, 4>>;
744 PendingBodiesMap PendingBodies;
748 llvm::SetVector<NamedDecl *> PendingMergedDefinitionsToDeduplicate;
754 PendingWarningForDuplicatedDefsInModuleUnits;
757 bool ReadLexicalDeclContextStorage(
ModuleFile &M,
758 llvm::BitstreamCursor &Cursor,
759 uint64_t Offset, DeclContext *DC);
761 enum class VisibleDeclContextStorageKind {
768 bool ReadVisibleDeclContextStorage(
ModuleFile &M,
769 llvm::BitstreamCursor &Cursor,
770 uint64_t Offset, GlobalDeclID ID,
771 VisibleDeclContextStorageKind VisibleKind);
773 bool ReadSpecializations(
ModuleFile &M, llvm::BitstreamCursor &Cursor,
774 uint64_t Offset, Decl *
D,
bool IsPartial);
775 void AddSpecializations(
const Decl *
D,
const unsigned char *
Data,
784 std::vector<IdentifierInfo *> IdentifiersLoaded;
792 std::vector<MacroInfo *> MacrosLoaded;
794 using LoadedMacroInfo =
795 std::pair<IdentifierInfo *, serialization::SubmoduleID>;
800 llvm::DenseSet<LoadedMacroInfo> LoadedUndefs;
802 using GlobalMacroMapType =
803 ContinuousRangeMap<serialization::MacroID, ModuleFile *, 4>;
808 GlobalMacroMapType GlobalMacroMap;
814 SmallVector<Module *, 2> SubmodulesLoaded;
816 using GlobalSubmoduleMapType =
817 ContinuousRangeMap<serialization::SubmoduleID, ModuleFile *, 4>;
822 GlobalSubmoduleMapType GlobalSubmoduleMap;
825 using HiddenNames = SmallVector<Decl *, 2>;
826 using HiddenNamesMapType = llvm::DenseMap<Module *, HiddenNames>;
830 HiddenNamesMapType HiddenNamesMap;
833 struct UnresolvedModuleRef {
841 enum {
Import, Export, Conflict, Affecting }
Kind;
847 LLVM_PREFERRED_TYPE(
bool)
848 unsigned IsWildcard : 1;
856 SmallVector<UnresolvedModuleRef, 2> UnresolvedModuleRefs;
863 SmallVector<Selector, 16> SelectorsLoaded;
865 using GlobalSelectorMapType =
866 ContinuousRangeMap<serialization::SelectorID, ModuleFile *, 4>;
870 GlobalSelectorMapType GlobalSelectorMap;
874 llvm::DenseMap<Selector, unsigned> SelectorGeneration;
878 llvm::DenseMap<Selector, bool> SelectorOutOfDate;
880 struct PendingMacroInfo {
885 PendingMacroInfo(
ModuleFile *M, uint32_t MacroDirectivesOffset)
886 : M(M), MacroDirectivesOffset(MacroDirectivesOffset) {}
889 using PendingMacroIDsMap =
890 llvm::MapVector<IdentifierInfo *, SmallVector<PendingMacroInfo, 2>>;
894 PendingMacroIDsMap PendingMacroIDs;
896 using GlobalPreprocessedEntityMapType =
897 ContinuousRangeMap<unsigned, ModuleFile *, 4>;
902 GlobalPreprocessedEntityMapType GlobalPreprocessedEntityMap;
904 using GlobalSkippedRangeMapType =
905 ContinuousRangeMap<unsigned, ModuleFile *, 4>;
909 GlobalSkippedRangeMapType GlobalSkippedRangeMap;
921 SmallVector<GlobalDeclID, 16> EagerlyDeserializedDecls;
926 SmallVector<GlobalDeclID, 16> VTablesToEmit;
933 SmallVector<GlobalDeclID, 16> TentativeDefinitions;
945 SmallVector<VTableUse> VTableUses;
953 struct PendingInstantiation {
957 SmallVector<PendingInstantiation, 64> PendingInstantiations;
967 SmallVector<GlobalDeclID, 16> UnusedFileScopedDecls;
971 SmallVector<GlobalDeclID, 4> DelegatingCtorDecls;
975 SmallVector<serialization::SelectorID, 64> ReferencedSelectorsData;
979 SmallVector<serialization::IdentifierID, 64> WeakUndeclaredIdentifiers;
984 SmallVector<GlobalDeclID, 4> ExtVectorDecls;
995 SmallVector<GlobalDeclID, 16> UnusedLocalTypedefNameCandidates;
999 unsigned ForceHostDeviceDepth = 0;
1004 SmallVector<GlobalDeclID, 4> SemaDeclRefs;
1009 SmallVector<serialization::TypeID, 16> SpecialTypes;
1015 SmallVector<GlobalDeclID, 2> CUDASpecialDeclRefs;
1018 SmallVector<uint64_t, 1> FPPragmaOptions;
1021 SourceLocation OptimizeOffPragmaLocation;
1024 int PragmaMSStructState = -1;
1027 int PragmaMSPointersToMembersState = -1;
1028 SourceLocation PointersToMembersPragmaLocation;
1031 std::optional<FPOptionsOverride> FpPragmaCurrentValue;
1032 SourceLocation FpPragmaCurrentLocation;
1033 struct FpPragmaStackEntry {
1034 FPOptionsOverride
Value;
1035 SourceLocation Location;
1036 SourceLocation PushLocation;
1037 StringRef SlotLabel;
1043 std::optional<Sema::AlignPackInfo> PragmaAlignPackCurrentValue;
1044 SourceLocation PragmaAlignPackCurrentLocation;
1045 struct PragmaAlignPackStackEntry {
1046 Sema::AlignPackInfo
Value;
1047 SourceLocation Location;
1048 SourceLocation PushLocation;
1049 StringRef SlotLabel;
1055 OpenCLOptions OpenCLExtensions;
1058 llvm::DenseMap<const Type *, std::set<std::string>> OpenCLTypeExtMap;
1061 llvm::DenseMap<const Decl *, std::set<std::string>> OpenCLDeclExtMap;
1064 SmallVector<GlobalDeclID, 4> KnownNamespaces;
1068 struct UndefinedButUsedDecl {
1072 SmallVector<UndefinedButUsedDecl, 8> UndefinedButUsed;
1075 SmallVector<uint64_t, 8> DelayedDeleteExprs;
1078 SmallVector<std::pair<ModuleFile *, SmallVector<uint64_t, 1>>, 4>
1079 LateParsedTemplates;
1087 SmallVector<GlobalDeclID> DeclsWithEffectsToVerify;
1090 struct ImportedSubmodule {
1092 SourceLocation ImportLoc;
1095 :
ID(
ID), ImportLoc(ImportLoc) {}
1102 SmallVector<ImportedSubmodule, 2> PendingImportedModules;
1106 SmallVector<ImportedSubmodule, 2> PendingImportedModulesSema;
1111 std::string isysroot;
1118 bool AllowASTWithCompilerErrors;
1122 bool AllowConfigurationMismatch;
1125 bool ValidateSystemInputs;
1128 bool ForceValidateUserInputs;
1131 bool ValidateASTInputFilesContent;
1134 bool UseGlobalIndex;
1137 bool TriedLoadingGlobalIndex =
false;
1140 bool ProcessingUpdateRecords =
false;
1142 using SwitchCaseMapTy = llvm::DenseMap<unsigned, SwitchCase *>;
1148 SwitchCaseMapTy SwitchCaseStmts;
1150 SwitchCaseMapTy *CurrSwitchCaseStmts;
1154 unsigned NumSLocEntriesRead = 0;
1157 unsigned TotalNumSLocEntries = 0;
1161 unsigned NumStatementsRead = 0;
1165 unsigned TotalNumStatements = 0;
1168 unsigned NumMacrosRead = 0;
1171 unsigned TotalNumMacros = 0;
1174 unsigned NumIdentifierLookups = 0;
1177 unsigned NumIdentifierLookupHits = 0;
1180 unsigned NumSelectorsRead = 0;
1183 unsigned NumMethodPoolEntriesRead = 0;
1187 unsigned NumMethodPoolLookups = 0;
1191 unsigned NumMethodPoolHits = 0;
1195 unsigned NumMethodPoolTableLookups = 0;
1199 unsigned NumMethodPoolTableHits = 0;
1202 unsigned TotalNumMethodPoolEntries = 0;
1205 unsigned NumLexicalDeclContextsRead = 0, TotalLexicalDeclContexts = 0;
1208 unsigned NumVisibleDeclContextsRead = 0, TotalVisibleDeclContexts = 0;
1211 unsigned NumModuleLocalVisibleDeclContexts = 0,
1212 TotalModuleLocalVisibleDeclContexts = 0;
1215 unsigned NumTULocalVisibleDeclContexts = 0,
1216 TotalTULocalVisibleDeclContexts = 0;
1219 uint64_t TotalModulesSizeInBits = 0;
1222 unsigned NumCurrentElementsDeserializing = 0;
1228 bool CanPassDeclsToConsumer =
true;
1235 llvm::MapVector<IdentifierInfo *, SmallVector<GlobalDeclID, 4>>
1236 PendingIdentifierInfos;
1240 llvm::SmallMapVector<const IdentifierInfo *, SmallVector<NamedDecl *, 2>, 16>
1241 PendingFakeLookupResults;
1245 llvm::DenseMap<const IdentifierInfo *, unsigned> IdentifierGeneration;
1253 std::deque<Decl *> PotentiallyInterestingDecls;
1258 SmallVector<std::pair<FunctionDecl *, serialization::TypeID>, 16>
1259 PendingDeducedFunctionTypes;
1264 SmallVector<std::pair<VarDecl *, serialization::TypeID>, 16>
1265 PendingDeducedVarTypes;
1270 SmallVector<std::pair<Decl *, uint64_t>, 16> PendingDeclChains;
1274 SmallVector<Decl *, 16> PendingIncompleteDeclChains;
1278 struct PendingDeclContextInfo {
1280 GlobalDeclID SemaDC;
1281 GlobalDeclID LexicalDC;
1289 std::deque<PendingDeclContextInfo> PendingDeclContextInfos;
1291 template <
typename DeclTy>
1292 using DuplicateObjCDecls = std::pair<DeclTy *, DeclTy *>;
1298 llvm::SmallMapVector<DuplicateObjCDecls<ObjCCategoryDecl>,
1301 PendingObjCExtensionIvarRedeclarations;
1306 SmallVector<std::pair<CXXRecordDecl*, Decl*>, 4> PendingAddedClassMembers;
1316 using DataPointers =
1317 std::pair<CXXRecordDecl *, struct CXXRecordDecl::DefinitionData *>;
1318 using ObjCInterfaceDataPointers =
1319 std::pair<ObjCInterfaceDecl *,
1320 struct ObjCInterfaceDecl::DefinitionData *>;
1321 using ObjCProtocolDataPointers =
1322 std::pair<ObjCProtocolDecl *, struct ObjCProtocolDecl::DefinitionData *>;
1325 llvm::SmallDenseMap<CXXRecordDecl *, llvm::SmallVector<DataPointers, 2>, 2>
1326 PendingOdrMergeFailures;
1329 llvm::SmallDenseMap<RecordDecl *, llvm::SmallVector<RecordDecl *, 2>, 2>
1330 PendingRecordOdrMergeFailures;
1333 llvm::SmallDenseMap<FunctionDecl *, llvm::SmallVector<FunctionDecl *, 2>, 2>
1334 PendingFunctionOdrMergeFailures;
1337 llvm::SmallDenseMap<EnumDecl *, llvm::SmallVector<EnumDecl *, 2>, 2>
1338 PendingEnumOdrMergeFailures;
1341 llvm::SmallDenseMap<ObjCInterfaceDecl *,
1343 PendingObjCInterfaceOdrMergeFailures;
1346 llvm::SmallDenseMap<ObjCProtocolDecl *,
1348 PendingObjCProtocolOdrMergeFailures;
1360 SmallVector<ObjCInterfaceDecl *, 16> ObjCClassesLoaded;
1362 using KeyDeclsMap = llvm::DenseMap<Decl *, SmallVector<GlobalDeclID, 2>>;
1369 KeyDeclsMap KeyDecls;
1374 llvm::DenseMap<DeclContext *, DeclContext *> MergedDeclContexts;
1378 llvm::DenseMap<EnumDecl *, EnumDecl *> EnumDefinitions;
1382 llvm::DenseMap<RecordDecl *, RecordDecl *> RecordDefinitions;
1385 SmallVector<Stmt *, 16> StmtStack;
1389 Read_None, Read_Decl, Read_Type, Read_Stmt
1393 ReadingKind ReadingKind = Read_None;
1396 class ReadingKindTracker {
1398 enum ReadingKind PrevKind;
1401 ReadingKindTracker(
enum ReadingKind newKind, ASTReader &reader)
1402 : Reader(reader), PrevKind(Reader.ReadingKind) {
1403 Reader.ReadingKind = newKind;
1406 ReadingKindTracker(
const ReadingKindTracker &) =
delete;
1407 ReadingKindTracker &operator=(
const ReadingKindTracker &) =
delete;
1408 ~ReadingKindTracker() { Reader.ReadingKind = PrevKind; }
1412 class ProcessingUpdatesRAIIObj {
1417 ProcessingUpdatesRAIIObj(ASTReader &reader)
1418 : Reader(reader), PrevState(Reader.ProcessingUpdateRecords) {
1419 Reader.ProcessingUpdateRecords =
true;
1422 ProcessingUpdatesRAIIObj(
const ProcessingUpdatesRAIIObj &) =
delete;
1423 ProcessingUpdatesRAIIObj &
1424 operator=(
const ProcessingUpdatesRAIIObj &) =
delete;
1425 ~ProcessingUpdatesRAIIObj() { Reader.ProcessingUpdateRecords = PrevState; }
1436 std::string SuggestedPredefines;
1438 llvm::DenseMap<const Decl *, bool> DefinitionSource;
1442 llvm::DenseSet<const FunctionDecl *> ThisDeclarationWasADefinitionSet;
1444 bool shouldDisableValidationForFile(
const serialization::ModuleFile &M)
const;
1450 serialization::InputFileInfo getInputFileInfo(
ModuleFile &F,
unsigned ID);
1454 serialization::InputFile getInputFile(
ModuleFile &F,
unsigned ID,
1455 bool Complain =
true);
1458 SmallString<0> PathBuf;
1461 class TemporarilyOwnedStringRef {
1466 TemporarilyOwnedStringRef(StringRef S, SmallString<0> &UnderlyingBuffer)
1467 : String(S), UnderlyingBuffer(UnderlyingBuffer, {}) {}
1470 const StringRef *operator->() const & {
return &String; }
1471 const StringRef &
operator*() const & {
return String; }
1474 const StringRef *operator->() && =
delete;
1475 const StringRef &
operator*() && =
delete;
1484 static TemporarilyOwnedStringRef
1488 static TemporarilyOwnedStringRef
1504 D =
D->getCanonicalDecl();
1505 if (
D->isFromASTFile())
1508 auto I = KeyDecls.find(
D);
1509 if (I == KeyDecls.end() || I->second.empty())
1518 template <
typename Fn>
1520 D =
D->getCanonicalDecl();
1521 if (
D->isFromASTFile())
1524 auto It = KeyDecls.find(
const_cast<Decl*
>(
D));
1525 if (It != KeyDecls.end())
1526 for (
auto ID : It->second)
1549 struct ImportedModule {
1557 : Mod(Mod), ImportedBy(ImportedBy), ImportLoc(ImportLoc) {}
1561 SourceLocation ImportLoc,
ModuleFile *ImportedBy,
1562 SmallVectorImpl<ImportedModule> &Loaded,
1563 off_t ExpectedSize, time_t ExpectedModTime,
1564 ASTFileSignature ExpectedSignature,
1565 unsigned ClientLoadCapabilities);
1567 SmallVectorImpl<ImportedModule> &Loaded,
1569 unsigned ClientLoadCapabilities);
1571 ReadOptionsBlock(llvm::BitstreamCursor &Stream, StringRef
Filename,
1572 unsigned ClientLoadCapabilities,
1573 bool AllowCompatibleConfigurationMismatch,
1574 ASTReaderListener &Listener,
1575 std::string &SuggestedPredefines);
1582 unsigned ClientLoadCapabilities);
1586 unsigned ClientLoadCapabilities,
1587 bool AllowCompatibleConfigurationMismatch, ASTReaderListener *Listener,
1588 bool ValidateDiagnosticOptions);
1590 llvm::Error ReadASTBlock(
ModuleFile &F,
unsigned ClientLoadCapabilities);
1591 llvm::Error ReadExtensionBlock(
ModuleFile &F);
1592 void ReadModuleOffsetMap(
ModuleFile &F)
const;
1594 llvm::Error ReadSourceManagerBlock(
ModuleFile &F);
1595 SourceLocation getImportLocation(
ModuleFile *F);
1598 unsigned ClientLoadCapabilities);
1599 llvm::Error ReadSubmoduleBlock(
ModuleFile &F,
1600 unsigned ClientLoadCapabilities);
1602 StringRef ModuleFilename,
bool Complain,
1603 ASTReaderListener &Listener,
1604 bool AllowCompatibleDifferences);
1606 StringRef ModuleFilename,
bool Complain,
1607 ASTReaderListener &Listener,
1608 bool AllowCompatibleDifferences);
1610 StringRef ModuleFilename,
bool Complain,
1611 ASTReaderListener &Listener,
1612 bool AllowCompatibleDifferences);
1614 StringRef ModuleFilename,
bool Complain,
1615 ASTReaderListener &Listener);
1616 static bool ParseFileSystemOptions(
const RecordData &
Record,
bool Complain,
1617 ASTReaderListener &Listener);
1619 StringRef ModuleFilename,
bool Complain,
1620 ASTReaderListener &Listener);
1621 static bool ParseHeaderSearchPaths(
const RecordData &
Record,
bool Complain,
1622 ASTReaderListener &Listener);
1624 StringRef ModuleFilename,
bool Complain,
1625 ASTReaderListener &Listener,
1626 std::string &SuggestedPredefines);
1628 struct RecordLocation {
1632 RecordLocation(
ModuleFile *M, uint64_t O) : F(M), Offset(O) {}
1637 void LoadedDecl(
unsigned Index, Decl *
D);
1638 Decl *ReadDeclRecord(GlobalDeclID ID);
1639 void markIncompleteDeclChain(Decl *
D);
1644 Decl *getMostRecentExistingDecl(Decl *
D);
1646 RecordLocation DeclCursorForID(GlobalDeclID ID, SourceLocation &Location);
1647 void loadDeclUpdateRecords(PendingUpdateRecord &
Record);
1648 void loadPendingDeclChain(Decl *
D, uint64_t LocalOffset);
1649 void loadObjCCategories(GlobalDeclID ID, ObjCInterfaceDecl *
D,
1650 unsigned PreviousGeneration = 0);
1652 RecordLocation getLocalBitOffset(uint64_t GlobalOffset);
1658 findPreprocessedEntity(SourceLocation
Loc,
bool EndsAfter)
const;
1667 findNextPreprocessedEntity(
1672 std::pair<ModuleFile *, unsigned>
1673 getModulePreprocessedEntity(
unsigned GlobalIndex);
1677 llvm::iterator_range<PreprocessingRecord::iterator>
1678 getModulePreprocessedEntities(
ModuleFile &Mod)
const;
1680 bool canRecoverFromOutOfDate(StringRef ModuleFileName,
1681 unsigned ClientLoadCapabilities);
1685 :
public llvm::iterator_adaptor_base<
1686 ModuleDeclIterator, const serialization::unaligned_decl_id_t *,
1687 std::random_access_iterator_tag, const Decl *, ptrdiff_t,
1688 const Decl *, const Decl *> {
1697 : iterator_adaptor_base(Pos), Reader(Reader), Mod(Mod) {}
1707 assert(Reader == RHS.Reader && Mod == RHS.Mod);
1712 llvm::iterator_range<ModuleDeclIterator>
1716 bool isConsumerInterestedIn(
Decl *
D);
1717 void PassInterestingDeclsToConsumer();
1718 void PassInterestingDeclToConsumer(
Decl *
D);
1721 void finishPendingActions();
1722 void diagnoseOdrViolations();
1729 PendingDeclContextInfo Info = {
D, SemaDC, LexicalDC };
1730 PendingDeclContextInfos.push_back(Info);
1737 void Error(StringRef Msg)
const;
1738 void Error(
unsigned DiagID, StringRef Arg1 = StringRef(),
1739 StringRef Arg2 = StringRef(), StringRef Arg3 = StringRef())
const;
1740 void Error(llvm::Error &&Err)
const;
1743 unsigned translateGlobalDeclIDToIndex(GlobalDeclID ID)
const;
1747 std::pair<ModuleFile *, unsigned>
1752 std::pair<ModuleFile *, unsigned>
1798 ASTReader(Preprocessor &PP, ModuleCache &ModCache, ASTContext *Context,
1799 const PCHContainerReader &PCHContainerRdr,
1800 const CodeGenOptions &CodeGenOpts,
1801 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
1802 StringRef isysroot =
"",
1805 bool AllowASTWithCompilerErrors =
false,
1806 bool AllowConfigurationMismatch =
false,
1807 bool ValidateSystemInputs =
false,
1808 bool ForceValidateUserInputs =
true,
1809 bool ValidateASTInputFilesContent =
false,
1810 bool UseGlobalIndex =
true,
1811 std::unique_ptr<llvm::Timer> ReadTimer = {});
1875 unsigned ClientLoadCapabilities,
1900 return std::move(Listener);
1905 this->Listener = std::move(Listener);
1913 L = std::make_unique<ChainedASTReaderListener>(std::move(L),
1914 std::move(Listener));
1915 Listener = std::move(L);
1921 bool Chained =
false;
1929 L = std::make_unique<ChainedASTReaderListener>(std::move(L),
1945 bool TakeOwnership =
false);
1949 return DeserializationListener;
1978 std::unique_ptr<llvm::MemoryBuffer> Buffer) {
2026 bool RequireStrictOptionMatches =
false);
2041 std::pair<unsigned, unsigned>
2059 return TotalNumSLocEntries;
2064 return static_cast<unsigned>(IdentifiersLoaded.size());
2069 return static_cast<unsigned>(MacrosLoaded.size());
2074 return static_cast<unsigned>(TypesLoaded.size());
2079 return static_cast<unsigned>(DeclsLoaded.size());
2084 return static_cast<unsigned>(SubmodulesLoaded.size());
2089 return static_cast<unsigned>(SelectorsLoaded.size());
2096 for (
const auto &M : ModuleMgr)
2097 Result += M.NumPreprocessedEntities;
2115 if (Idx >=
Record.size())
2183 template <
typename T>
2207 uint64_t *StartOfBlockOffset =
nullptr);
2237 llvm::function_ref<
bool(
Decl::Kind)> IsKindWeWant,
2306 llvm::MapVector<NamedDecl *, SourceLocation> &
Undefined)
override;
2333 SmallVectorImpl<std::pair<IdentifierInfo *, WeakInfo>> &WeakIDs)
override;
2342 llvm::MapVector<
const FunctionDecl *, std::unique_ptr<LateParsedTemplate>>
2362 llvm::function_ref<
void()> Fn);
2408 unsigned LocalID)
const;
2449 unsigned LocalID)
const;
2463 std::pair<SourceLocation, unsigned>
2471 ReadModuleOffsetMap(MF);
2478 "Run out source location space");
2487 if (
Loc.isInvalid())
2508 unsigned &Idx)
const {
2514 assert(FID.ID >= 0 &&
"Reading non-local FileID.");
2525 const StringRef Blob);
2539 unsigned &Idx, StringRef &Blob);
2555 assert(ReadingKind == Read_Stmt &&
2556 "Should be called only during statement reading!");
2559 assert(!StmtStack.empty() &&
"Read too many sub-statements!");
2560 return StmtStack.pop_back_val();
2584 uint32_t MacroDirectivesOffset);
2600 assert(ContextObj &&
"requested AST context when not loading AST");
2647 bool IncludeSystem,
bool Complain,
2649 bool isSystem)> Visitor);
2662 constexpr static uint32_t BitsIndexUpbound = 32;
2674 CurrentBitsIndex = 0;
2677 void advance(uint32_t BitsWidth) { CurrentBitsIndex += BitsWidth; }
2681 return Value & (1 << CurrentBitsIndex++);
2686 assert(Width < BitsIndexUpbound);
2687 uint32_t Ret = (
Value >> CurrentBitsIndex) & ((1 << Width) - 1);
2688 CurrentBitsIndex += Width;
2693 return CurrentBitsIndex + Width < BitsIndexUpbound;
2697 bool isValid()
const {
return CurrentBitsIndex < BitsIndexUpbound; }
2700 uint32_t CurrentBitsIndex = ~0;
Defines the Diagnostic-related interfaces.
clang::CharUnits operator*(clang::CharUnits::QuantityType Scale, const clang::CharUnits &CU)
enum clang::sema::@1840::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 ReadDiagnosticOptions(DiagnosticOptions &DiagOpts, StringRef ModuleFilename, bool Complain)
Receives the diagnostic options.
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 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 bool visitInputFile(StringRef FilenameAsRequested, StringRef Filename, bool isSystem, bool isOverridden, bool isExplicitModule)
Overloaded member function of visitInputFile that should be defined when there is a distinction betwe...
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...
virtual bool ReadCodeGenOptions(const CodeGenOptions &CGOpts, StringRef ModuleFilename, bool Complain, bool AllowCompatibleDifferences)
Receives the codegen options.
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.
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
const serialization::reader::ModuleLocalLookupTable * getModuleLocalLookupTables(DeclContext *Primary) const
SourceLocation getSourceLocationForDeclID(GlobalDeclID ID)
Returns the source location for the decl ID.
const CodeGenOptions & getCodeGenOpts() const
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
SourceRange ReadSourceRange(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Read a source range.
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)
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.
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.
static bool isAcceptableASTFile(StringRef Filename, FileManager &FileMgr, const ModuleCache &ModCache, const PCHContainerReader &PCHContainerRdr, const LangOptions &LangOpts, const CodeGenOptions &CGOpts, 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...
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.
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 ModuleCache &ModCache, 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.
bool FindExternalVisibleDeclsByName(const DeclContext *DC, DeclarationName Name, const DeclContext *OriginalDC) override
Finds all the visible declarations with a given name.
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.
SourceLocation ReadSourceLocation(ModuleFile &ModuleFile, const RecordDataImpl &Record, unsigned &Idx)
Read a source location.
ASTReader(Preprocessor &PP, ModuleCache &ModCache, ASTContext *Context, const PCHContainerReader &PCHContainerRdr, const CodeGenOptions &CodeGenOpts, ArrayRef< std::shared_ptr< ModuleFileExtension > > Extensions, StringRef isysroot="", DisableValidationForModuleKind DisableValidationKind=DisableValidationForModuleKind::None, bool AllowASTWithCompilerErrors=false, bool AllowConfigurationMismatch=false, bool ValidateSystemInputs=false, bool ForceValidateUserInputs=true, bool ValidateASTInputFilesContent=false, bool UseGlobalIndex=true, std::unique_ptr< llvm::Timer > ReadTimer={})
Load the AST file and validate its contents against the given Preprocessor.
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.
int getSLocEntryID(SourceLocation::UIntTy SLocOffset) override
Get the index ID for the loaded SourceLocation offset.
SourceLocation ReadSourceLocation(ModuleFile &MF, RawLocEncoding Raw) const
Read a source location from raw form.
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
std::pair< SourceLocation, unsigned > ReadUntranslatedSourceLocation(RawLocEncoding Raw) const
Read a source location from raw form and return it in its originating module file's source location s...
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.
const serialization::reader::DeclContextLookupTable * getTULocalLookupTables(DeclContext *Primary) const
void resetForReload()
Reset reader for a reload try.
FileManager & getFileManager() const
unsigned getTotalNumDecls() const
Returns the number of declarations found in the chain.
bool wasThisDeclarationADefinition(const FunctionDecl *FD) override
True if this function declaration was a definition before in its own module.
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.
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...
bool ReadCodeGenOptions(const CodeGenOptions &CGOpts, StringRef ModuleFilename, bool Complain, bool AllowCompatibleDifferences) override
Receives the codegen options.
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 needsSystemInputFileVisitation() override
Returns true if this ASTReaderListener wants to receive the system input files of the AST file via vi...
bool ReadDiagnosticOptions(DiagnosticOptions &DiagOpts, StringRef ModuleFilename, bool Complain) override
Receives the diagnostic options.
CodeGenOptions - Track various options which control how the code is optimized and passed to the back...
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.
Options for controlling the compiler diagnostics engine.
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.
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.
The module cache used for compiling modules implicitly.
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 ReadDiagnosticOptions(DiagnosticOptions &DiagOpts, StringRef ModuleFilename, bool Complain) override
Receives the diagnostic options.
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.
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 ReadCodeGenOptions(const CodeGenOptions &CGOpts, StringRef ModuleFilename, bool Complain, bool AllowCompatibleDifferences) override
Receives the codegen 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)
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.
std::variant< struct RequiresDecl, struct HeaderDecl, struct UmbrellaDirDecl, struct ModuleDecl, struct ExcludeDecl, struct ExportDecl, struct ExportAsDecl, struct ExternModuleDecl, struct UseDecl, struct LinkDecl, struct ConfigMacrosDecl, struct ConflictDecl > Decl
All declarations that can appear in a module declaration.
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.
@ 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...
UnsignedOrNone getPrimaryModuleHash(const Module *M)
Calculate a hash value for the primary module name of the given module.
uint64_t ModuleLocalOffset