1 //===- ASTReader.cpp - AST File Reader ------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the ASTReader class, which reads AST files.
12 //===----------------------------------------------------------------------===//
14 #include "clang/Serialization/ASTReader.h"
15 #include "ASTCommon.h"
16 #include "ASTReaderInternals.h"
17 #include "clang/AST/ASTConsumer.h"
18 #include "clang/AST/ASTContext.h"
19 #include "clang/AST/ASTMutationListener.h"
20 #include "clang/AST/ASTUnresolvedSet.h"
21 #include "clang/AST/Decl.h"
22 #include "clang/AST/DeclBase.h"
23 #include "clang/AST/DeclCXX.h"
24 #include "clang/AST/DeclFriend.h"
25 #include "clang/AST/DeclGroup.h"
26 #include "clang/AST/DeclObjC.h"
27 #include "clang/AST/DeclTemplate.h"
28 #include "clang/AST/DeclarationName.h"
29 #include "clang/AST/Expr.h"
30 #include "clang/AST/ExprCXX.h"
31 #include "clang/AST/ExternalASTSource.h"
32 #include "clang/AST/NestedNameSpecifier.h"
33 #include "clang/AST/ODRHash.h"
34 #include "clang/AST/RawCommentList.h"
35 #include "clang/AST/TemplateBase.h"
36 #include "clang/AST/TemplateName.h"
37 #include "clang/AST/Type.h"
38 #include "clang/AST/TypeLoc.h"
39 #include "clang/AST/TypeLocVisitor.h"
40 #include "clang/AST/UnresolvedSet.h"
41 #include "clang/Basic/CommentOptions.h"
42 #include "clang/Basic/Diagnostic.h"
43 #include "clang/Basic/DiagnosticOptions.h"
44 #include "clang/Basic/ExceptionSpecificationType.h"
45 #include "clang/Basic/FileManager.h"
46 #include "clang/Basic/FileSystemOptions.h"
47 #include "clang/Basic/IdentifierTable.h"
48 #include "clang/Basic/LLVM.h"
49 #include "clang/Basic/LangOptions.h"
50 #include "clang/Basic/MemoryBufferCache.h"
51 #include "clang/Basic/Module.h"
52 #include "clang/Basic/ObjCRuntime.h"
53 #include "clang/Basic/OperatorKinds.h"
54 #include "clang/Basic/PragmaKinds.h"
55 #include "clang/Basic/Sanitizers.h"
56 #include "clang/Basic/SourceLocation.h"
57 #include "clang/Basic/SourceManager.h"
58 #include "clang/Basic/SourceManagerInternals.h"
59 #include "clang/Basic/Specifiers.h"
60 #include "clang/Basic/TargetInfo.h"
61 #include "clang/Basic/TargetOptions.h"
62 #include "clang/Basic/TokenKinds.h"
63 #include "clang/Basic/Version.h"
64 #include "clang/Basic/VersionTuple.h"
65 #include "clang/Frontend/PCHContainerOperations.h"
66 #include "clang/Lex/HeaderSearch.h"
67 #include "clang/Lex/HeaderSearchOptions.h"
68 #include "clang/Lex/MacroInfo.h"
69 #include "clang/Lex/ModuleMap.h"
70 #include "clang/Lex/PreprocessingRecord.h"
71 #include "clang/Lex/Preprocessor.h"
72 #include "clang/Lex/PreprocessorOptions.h"
73 #include "clang/Lex/Token.h"
74 #include "clang/Sema/ObjCMethodList.h"
75 #include "clang/Sema/Scope.h"
76 #include "clang/Sema/Sema.h"
77 #include "clang/Sema/Weak.h"
78 #include "clang/Serialization/ASTBitCodes.h"
79 #include "clang/Serialization/ASTDeserializationListener.h"
80 #include "clang/Serialization/ContinuousRangeMap.h"
81 #include "clang/Serialization/GlobalModuleIndex.h"
82 #include "clang/Serialization/Module.h"
83 #include "clang/Serialization/ModuleFileExtension.h"
84 #include "clang/Serialization/ModuleManager.h"
85 #include "clang/Serialization/SerializationDiagnostic.h"
86 #include "llvm/ADT/APFloat.h"
87 #include "llvm/ADT/APInt.h"
88 #include "llvm/ADT/APSInt.h"
89 #include "llvm/ADT/ArrayRef.h"
90 #include "llvm/ADT/DenseMap.h"
91 #include "llvm/ADT/FoldingSet.h"
92 #include "llvm/ADT/Hashing.h"
93 #include "llvm/ADT/IntrusiveRefCntPtr.h"
94 #include "llvm/ADT/None.h"
95 #include "llvm/ADT/Optional.h"
96 #include "llvm/ADT/STLExtras.h"
97 #include "llvm/ADT/SmallPtrSet.h"
98 #include "llvm/ADT/SmallString.h"
99 #include "llvm/ADT/SmallVector.h"
100 #include "llvm/ADT/StringExtras.h"
101 #include "llvm/ADT/StringMap.h"
102 #include "llvm/ADT/StringRef.h"
103 #include "llvm/ADT/Triple.h"
104 #include "llvm/ADT/iterator_range.h"
105 #include "llvm/Bitcode/BitstreamReader.h"
106 #include "llvm/Support/Casting.h"
107 #include "llvm/Support/Compression.h"
108 #include "llvm/Support/Compiler.h"
109 #include "llvm/Support/Endian.h"
110 #include "llvm/Support/Error.h"
111 #include "llvm/Support/ErrorHandling.h"
112 #include "llvm/Support/FileSystem.h"
113 #include "llvm/Support/MemoryBuffer.h"
114 #include "llvm/Support/Path.h"
115 #include "llvm/Support/SaveAndRestore.h"
116 #include "llvm/Support/Timer.h"
117 #include "llvm/Support/raw_ostream.h"
129 #include <system_error>
134 using namespace clang;
135 using namespace clang::serialization;
136 using namespace clang::serialization::reader;
137 using llvm::BitstreamCursor;
139 //===----------------------------------------------------------------------===//
140 // ChainedASTReaderListener implementation
141 //===----------------------------------------------------------------------===//
144 ChainedASTReaderListener::ReadFullVersionInformation(StringRef FullVersion) {
145 return First->ReadFullVersionInformation(FullVersion) ||
146 Second->ReadFullVersionInformation(FullVersion);
149 void ChainedASTReaderListener::ReadModuleName(StringRef ModuleName) {
150 First->ReadModuleName(ModuleName);
151 Second->ReadModuleName(ModuleName);
154 void ChainedASTReaderListener::ReadModuleMapFile(StringRef ModuleMapPath) {
155 First->ReadModuleMapFile(ModuleMapPath);
156 Second->ReadModuleMapFile(ModuleMapPath);
160 ChainedASTReaderListener::ReadLanguageOptions(const LangOptions &LangOpts,
162 bool AllowCompatibleDifferences) {
163 return First->ReadLanguageOptions(LangOpts, Complain,
164 AllowCompatibleDifferences) ||
165 Second->ReadLanguageOptions(LangOpts, Complain,
166 AllowCompatibleDifferences);
169 bool ChainedASTReaderListener::ReadTargetOptions(
170 const TargetOptions &TargetOpts, bool Complain,
171 bool AllowCompatibleDifferences) {
172 return First->ReadTargetOptions(TargetOpts, Complain,
173 AllowCompatibleDifferences) ||
174 Second->ReadTargetOptions(TargetOpts, Complain,
175 AllowCompatibleDifferences);
178 bool ChainedASTReaderListener::ReadDiagnosticOptions(
179 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts, bool Complain) {
180 return First->ReadDiagnosticOptions(DiagOpts, Complain) ||
181 Second->ReadDiagnosticOptions(DiagOpts, Complain);
185 ChainedASTReaderListener::ReadFileSystemOptions(const FileSystemOptions &FSOpts,
187 return First->ReadFileSystemOptions(FSOpts, Complain) ||
188 Second->ReadFileSystemOptions(FSOpts, Complain);
191 bool ChainedASTReaderListener::ReadHeaderSearchOptions(
192 const HeaderSearchOptions &HSOpts, StringRef SpecificModuleCachePath,
194 return First->ReadHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
196 Second->ReadHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
200 bool ChainedASTReaderListener::ReadPreprocessorOptions(
201 const PreprocessorOptions &PPOpts, bool Complain,
202 std::string &SuggestedPredefines) {
203 return First->ReadPreprocessorOptions(PPOpts, Complain,
204 SuggestedPredefines) ||
205 Second->ReadPreprocessorOptions(PPOpts, Complain, SuggestedPredefines);
208 void ChainedASTReaderListener::ReadCounter(const serialization::ModuleFile &M,
210 First->ReadCounter(M, Value);
211 Second->ReadCounter(M, Value);
214 bool ChainedASTReaderListener::needsInputFileVisitation() {
215 return First->needsInputFileVisitation() ||
216 Second->needsInputFileVisitation();
219 bool ChainedASTReaderListener::needsSystemInputFileVisitation() {
220 return First->needsSystemInputFileVisitation() ||
221 Second->needsSystemInputFileVisitation();
224 void ChainedASTReaderListener::visitModuleFile(StringRef Filename,
226 First->visitModuleFile(Filename, Kind);
227 Second->visitModuleFile(Filename, Kind);
230 bool ChainedASTReaderListener::visitInputFile(StringRef Filename,
233 bool isExplicitModule) {
234 bool Continue = false;
235 if (First->needsInputFileVisitation() &&
236 (!isSystem || First->needsSystemInputFileVisitation()))
237 Continue |= First->visitInputFile(Filename, isSystem, isOverridden,
239 if (Second->needsInputFileVisitation() &&
240 (!isSystem || Second->needsSystemInputFileVisitation()))
241 Continue |= Second->visitInputFile(Filename, isSystem, isOverridden,
246 void ChainedASTReaderListener::readModuleFileExtension(
247 const ModuleFileExtensionMetadata &Metadata) {
248 First->readModuleFileExtension(Metadata);
249 Second->readModuleFileExtension(Metadata);
252 //===----------------------------------------------------------------------===//
253 // PCH validator implementation
254 //===----------------------------------------------------------------------===//
256 ASTReaderListener::~ASTReaderListener() = default;
258 /// \brief Compare the given set of language options against an existing set of
259 /// language options.
261 /// \param Diags If non-NULL, diagnostics will be emitted via this engine.
262 /// \param AllowCompatibleDifferences If true, differences between compatible
263 /// language options will be permitted.
265 /// \returns true if the languagae options mis-match, false otherwise.
266 static bool checkLanguageOptions(const LangOptions &LangOpts,
267 const LangOptions &ExistingLangOpts,
268 DiagnosticsEngine *Diags,
269 bool AllowCompatibleDifferences = true) {
270 #define LANGOPT(Name, Bits, Default, Description) \
271 if (ExistingLangOpts.Name != LangOpts.Name) { \
273 Diags->Report(diag::err_pch_langopt_mismatch) \
274 << Description << LangOpts.Name << ExistingLangOpts.Name; \
278 #define VALUE_LANGOPT(Name, Bits, Default, Description) \
279 if (ExistingLangOpts.Name != LangOpts.Name) { \
281 Diags->Report(diag::err_pch_langopt_value_mismatch) \
286 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
287 if (ExistingLangOpts.get##Name() != LangOpts.get##Name()) { \
289 Diags->Report(diag::err_pch_langopt_value_mismatch) \
294 #define COMPATIBLE_LANGOPT(Name, Bits, Default, Description) \
295 if (!AllowCompatibleDifferences) \
296 LANGOPT(Name, Bits, Default, Description)
298 #define COMPATIBLE_ENUM_LANGOPT(Name, Bits, Default, Description) \
299 if (!AllowCompatibleDifferences) \
300 ENUM_LANGOPT(Name, Bits, Default, Description)
302 #define COMPATIBLE_VALUE_LANGOPT(Name, Bits, Default, Description) \
303 if (!AllowCompatibleDifferences) \
304 VALUE_LANGOPT(Name, Bits, Default, Description)
306 #define BENIGN_LANGOPT(Name, Bits, Default, Description)
307 #define BENIGN_ENUM_LANGOPT(Name, Type, Bits, Default, Description)
308 #define BENIGN_VALUE_LANGOPT(Name, Type, Bits, Default, Description)
309 #include "clang/Basic/LangOptions.def"
311 if (ExistingLangOpts.ModuleFeatures != LangOpts.ModuleFeatures) {
313 Diags->Report(diag::err_pch_langopt_value_mismatch) << "module features";
317 if (ExistingLangOpts.ObjCRuntime != LangOpts.ObjCRuntime) {
319 Diags->Report(diag::err_pch_langopt_value_mismatch)
320 << "target Objective-C runtime";
324 if (ExistingLangOpts.CommentOpts.BlockCommandNames !=
325 LangOpts.CommentOpts.BlockCommandNames) {
327 Diags->Report(diag::err_pch_langopt_value_mismatch)
328 << "block command names";
332 // Sanitizer feature mismatches are treated as compatible differences. If
333 // compatible differences aren't allowed, we still only want to check for
334 // mismatches of non-modular sanitizers (the only ones which can affect AST
336 if (!AllowCompatibleDifferences) {
337 SanitizerMask ModularSanitizers = getPPTransparentSanitizers();
338 SanitizerSet ExistingSanitizers = ExistingLangOpts.Sanitize;
339 SanitizerSet ImportedSanitizers = LangOpts.Sanitize;
340 ExistingSanitizers.clear(ModularSanitizers);
341 ImportedSanitizers.clear(ModularSanitizers);
342 if (ExistingSanitizers.Mask != ImportedSanitizers.Mask) {
343 const std::string Flag = "-fsanitize=";
345 #define SANITIZER(NAME, ID) \
347 bool InExistingModule = ExistingSanitizers.has(SanitizerKind::ID); \
348 bool InImportedModule = ImportedSanitizers.has(SanitizerKind::ID); \
349 if (InExistingModule != InImportedModule) \
350 Diags->Report(diag::err_pch_targetopt_feature_mismatch) \
351 << InExistingModule << (Flag + NAME); \
353 #include "clang/Basic/Sanitizers.def"
362 /// \brief Compare the given set of target options against an existing set of
365 /// \param Diags If non-NULL, diagnostics will be emitted via this engine.
367 /// \returns true if the target options mis-match, false otherwise.
368 static bool checkTargetOptions(const TargetOptions &TargetOpts,
369 const TargetOptions &ExistingTargetOpts,
370 DiagnosticsEngine *Diags,
371 bool AllowCompatibleDifferences = true) {
372 #define CHECK_TARGET_OPT(Field, Name) \
373 if (TargetOpts.Field != ExistingTargetOpts.Field) { \
375 Diags->Report(diag::err_pch_targetopt_mismatch) \
376 << Name << TargetOpts.Field << ExistingTargetOpts.Field; \
380 // The triple and ABI must match exactly.
381 CHECK_TARGET_OPT(Triple, "target");
382 CHECK_TARGET_OPT(ABI, "target ABI");
384 // We can tolerate different CPUs in many cases, notably when one CPU
385 // supports a strict superset of another. When allowing compatible
386 // differences skip this check.
387 if (!AllowCompatibleDifferences)
388 CHECK_TARGET_OPT(CPU, "target CPU");
390 #undef CHECK_TARGET_OPT
392 // Compare feature sets.
393 SmallVector<StringRef, 4> ExistingFeatures(
394 ExistingTargetOpts.FeaturesAsWritten.begin(),
395 ExistingTargetOpts.FeaturesAsWritten.end());
396 SmallVector<StringRef, 4> ReadFeatures(TargetOpts.FeaturesAsWritten.begin(),
397 TargetOpts.FeaturesAsWritten.end());
398 std::sort(ExistingFeatures.begin(), ExistingFeatures.end());
399 std::sort(ReadFeatures.begin(), ReadFeatures.end());
401 // We compute the set difference in both directions explicitly so that we can
402 // diagnose the differences differently.
403 SmallVector<StringRef, 4> UnmatchedExistingFeatures, UnmatchedReadFeatures;
405 ExistingFeatures.begin(), ExistingFeatures.end(), ReadFeatures.begin(),
406 ReadFeatures.end(), std::back_inserter(UnmatchedExistingFeatures));
407 std::set_difference(ReadFeatures.begin(), ReadFeatures.end(),
408 ExistingFeatures.begin(), ExistingFeatures.end(),
409 std::back_inserter(UnmatchedReadFeatures));
411 // If we are allowing compatible differences and the read feature set is
412 // a strict subset of the existing feature set, there is nothing to diagnose.
413 if (AllowCompatibleDifferences && UnmatchedReadFeatures.empty())
417 for (StringRef Feature : UnmatchedReadFeatures)
418 Diags->Report(diag::err_pch_targetopt_feature_mismatch)
419 << /* is-existing-feature */ false << Feature;
420 for (StringRef Feature : UnmatchedExistingFeatures)
421 Diags->Report(diag::err_pch_targetopt_feature_mismatch)
422 << /* is-existing-feature */ true << Feature;
425 return !UnmatchedReadFeatures.empty() || !UnmatchedExistingFeatures.empty();
429 PCHValidator::ReadLanguageOptions(const LangOptions &LangOpts,
431 bool AllowCompatibleDifferences) {
432 const LangOptions &ExistingLangOpts = PP.getLangOpts();
433 return checkLanguageOptions(LangOpts, ExistingLangOpts,
434 Complain ? &Reader.Diags : nullptr,
435 AllowCompatibleDifferences);
438 bool PCHValidator::ReadTargetOptions(const TargetOptions &TargetOpts,
440 bool AllowCompatibleDifferences) {
441 const TargetOptions &ExistingTargetOpts = PP.getTargetInfo().getTargetOpts();
442 return checkTargetOptions(TargetOpts, ExistingTargetOpts,
443 Complain ? &Reader.Diags : nullptr,
444 AllowCompatibleDifferences);
449 using MacroDefinitionsMap =
450 llvm::StringMap<std::pair<StringRef, bool /*IsUndef*/>>;
451 using DeclsMap = llvm::DenseMap<DeclarationName, SmallVector<NamedDecl *, 8>>;
455 static bool checkDiagnosticGroupMappings(DiagnosticsEngine &StoredDiags,
456 DiagnosticsEngine &Diags,
458 using Level = DiagnosticsEngine::Level;
460 // Check current mappings for new -Werror mappings, and the stored mappings
461 // for cases that were explicitly mapped to *not* be errors that are now
462 // errors because of options like -Werror.
463 DiagnosticsEngine *MappingSources[] = { &Diags, &StoredDiags };
465 for (DiagnosticsEngine *MappingSource : MappingSources) {
466 for (auto DiagIDMappingPair : MappingSource->getDiagnosticMappings()) {
467 diag::kind DiagID = DiagIDMappingPair.first;
468 Level CurLevel = Diags.getDiagnosticLevel(DiagID, SourceLocation());
469 if (CurLevel < DiagnosticsEngine::Error)
470 continue; // not significant
472 StoredDiags.getDiagnosticLevel(DiagID, SourceLocation());
473 if (StoredLevel < DiagnosticsEngine::Error) {
475 Diags.Report(diag::err_pch_diagopt_mismatch) << "-Werror=" +
476 Diags.getDiagnosticIDs()->getWarningOptionForDiag(DiagID).str();
485 static bool isExtHandlingFromDiagsError(DiagnosticsEngine &Diags) {
486 diag::Severity Ext = Diags.getExtensionHandlingBehavior();
487 if (Ext == diag::Severity::Warning && Diags.getWarningsAsErrors())
489 return Ext >= diag::Severity::Error;
492 static bool checkDiagnosticMappings(DiagnosticsEngine &StoredDiags,
493 DiagnosticsEngine &Diags,
494 bool IsSystem, bool Complain) {
497 if (Diags.getSuppressSystemWarnings())
499 // If -Wsystem-headers was not enabled before, be conservative
500 if (StoredDiags.getSuppressSystemWarnings()) {
502 Diags.Report(diag::err_pch_diagopt_mismatch) << "-Wsystem-headers";
507 if (Diags.getWarningsAsErrors() && !StoredDiags.getWarningsAsErrors()) {
509 Diags.Report(diag::err_pch_diagopt_mismatch) << "-Werror";
513 if (Diags.getWarningsAsErrors() && Diags.getEnableAllWarnings() &&
514 !StoredDiags.getEnableAllWarnings()) {
516 Diags.Report(diag::err_pch_diagopt_mismatch) << "-Weverything -Werror";
520 if (isExtHandlingFromDiagsError(Diags) &&
521 !isExtHandlingFromDiagsError(StoredDiags)) {
523 Diags.Report(diag::err_pch_diagopt_mismatch) << "-pedantic-errors";
527 return checkDiagnosticGroupMappings(StoredDiags, Diags, Complain);
530 /// Return the top import module if it is implicit, nullptr otherwise.
531 static Module *getTopImportImplicitModule(ModuleManager &ModuleMgr,
533 // If the original import came from a file explicitly generated by the user,
534 // don't check the diagnostic mappings.
535 // FIXME: currently this is approximated by checking whether this is not a
536 // module import of an implicitly-loaded module file.
537 // Note: ModuleMgr.rbegin() may not be the current module, but it must be in
538 // the transitive closure of its imports, since unrelated modules cannot be
539 // imported until after this module finishes validation.
540 ModuleFile *TopImport = &*ModuleMgr.rbegin();
541 while (!TopImport->ImportedBy.empty())
542 TopImport = TopImport->ImportedBy[0];
543 if (TopImport->Kind != MK_ImplicitModule)
546 StringRef ModuleName = TopImport->ModuleName;
547 assert(!ModuleName.empty() && "diagnostic options read before module name");
549 Module *M = PP.getHeaderSearchInfo().lookupModule(ModuleName);
550 assert(M && "missing module");
554 bool PCHValidator::ReadDiagnosticOptions(
555 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts, bool Complain) {
556 DiagnosticsEngine &ExistingDiags = PP.getDiagnostics();
557 IntrusiveRefCntPtr<DiagnosticIDs> DiagIDs(ExistingDiags.getDiagnosticIDs());
558 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
559 new DiagnosticsEngine(DiagIDs, DiagOpts.get()));
560 // This should never fail, because we would have processed these options
561 // before writing them to an ASTFile.
562 ProcessWarningOptions(*Diags, *DiagOpts, /*Report*/false);
564 ModuleManager &ModuleMgr = Reader.getModuleManager();
565 assert(ModuleMgr.size() >= 1 && "what ASTFile is this then");
567 Module *TopM = getTopImportImplicitModule(ModuleMgr, PP);
571 // FIXME: if the diagnostics are incompatible, save a DiagnosticOptions that
572 // contains the union of their flags.
573 return checkDiagnosticMappings(*Diags, ExistingDiags, TopM->IsSystem,
577 /// \brief Collect the macro definitions provided by the given preprocessor
580 collectMacroDefinitions(const PreprocessorOptions &PPOpts,
581 MacroDefinitionsMap &Macros,
582 SmallVectorImpl<StringRef> *MacroNames = nullptr) {
583 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
584 StringRef Macro = PPOpts.Macros[I].first;
585 bool IsUndef = PPOpts.Macros[I].second;
587 std::pair<StringRef, StringRef> MacroPair = Macro.split('=');
588 StringRef MacroName = MacroPair.first;
589 StringRef MacroBody = MacroPair.second;
591 // For an #undef'd macro, we only care about the name.
593 if (MacroNames && !Macros.count(MacroName))
594 MacroNames->push_back(MacroName);
596 Macros[MacroName] = std::make_pair("", true);
600 // For a #define'd macro, figure out the actual definition.
601 if (MacroName.size() == Macro.size())
604 // Note: GCC drops anything following an end-of-line character.
605 StringRef::size_type End = MacroBody.find_first_of("\n\r");
606 MacroBody = MacroBody.substr(0, End);
609 if (MacroNames && !Macros.count(MacroName))
610 MacroNames->push_back(MacroName);
611 Macros[MacroName] = std::make_pair(MacroBody, false);
615 /// \brief Check the preprocessor options deserialized from the control block
616 /// against the preprocessor options in an existing preprocessor.
618 /// \param Diags If non-null, produce diagnostics for any mismatches incurred.
619 /// \param Validate If true, validate preprocessor options. If false, allow
620 /// macros defined by \p ExistingPPOpts to override those defined by
621 /// \p PPOpts in SuggestedPredefines.
622 static bool checkPreprocessorOptions(const PreprocessorOptions &PPOpts,
623 const PreprocessorOptions &ExistingPPOpts,
624 DiagnosticsEngine *Diags,
625 FileManager &FileMgr,
626 std::string &SuggestedPredefines,
627 const LangOptions &LangOpts,
628 bool Validate = true) {
629 // Check macro definitions.
630 MacroDefinitionsMap ASTFileMacros;
631 collectMacroDefinitions(PPOpts, ASTFileMacros);
632 MacroDefinitionsMap ExistingMacros;
633 SmallVector<StringRef, 4> ExistingMacroNames;
634 collectMacroDefinitions(ExistingPPOpts, ExistingMacros, &ExistingMacroNames);
636 for (unsigned I = 0, N = ExistingMacroNames.size(); I != N; ++I) {
637 // Dig out the macro definition in the existing preprocessor options.
638 StringRef MacroName = ExistingMacroNames[I];
639 std::pair<StringRef, bool> Existing = ExistingMacros[MacroName];
641 // Check whether we know anything about this macro name or not.
642 llvm::StringMap<std::pair<StringRef, bool /*IsUndef*/>>::iterator Known =
643 ASTFileMacros.find(MacroName);
644 if (!Validate || Known == ASTFileMacros.end()) {
645 // FIXME: Check whether this identifier was referenced anywhere in the
646 // AST file. If so, we should reject the AST file. Unfortunately, this
647 // information isn't in the control block. What shall we do about it?
649 if (Existing.second) {
650 SuggestedPredefines += "#undef ";
651 SuggestedPredefines += MacroName.str();
652 SuggestedPredefines += '\n';
654 SuggestedPredefines += "#define ";
655 SuggestedPredefines += MacroName.str();
656 SuggestedPredefines += ' ';
657 SuggestedPredefines += Existing.first.str();
658 SuggestedPredefines += '\n';
663 // If the macro was defined in one but undef'd in the other, we have a
665 if (Existing.second != Known->second.second) {
667 Diags->Report(diag::err_pch_macro_def_undef)
668 << MacroName << Known->second.second;
673 // If the macro was #undef'd in both, or if the macro bodies are identical,
675 if (Existing.second || Existing.first == Known->second.first)
678 // The macro bodies differ; complain.
680 Diags->Report(diag::err_pch_macro_def_conflict)
681 << MacroName << Known->second.first << Existing.first;
686 // Check whether we're using predefines.
687 if (PPOpts.UsePredefines != ExistingPPOpts.UsePredefines && Validate) {
689 Diags->Report(diag::err_pch_undef) << ExistingPPOpts.UsePredefines;
694 // Detailed record is important since it is used for the module cache hash.
695 if (LangOpts.Modules &&
696 PPOpts.DetailedRecord != ExistingPPOpts.DetailedRecord && Validate) {
698 Diags->Report(diag::err_pch_pp_detailed_record) << PPOpts.DetailedRecord;
703 // Compute the #include and #include_macros lines we need.
704 for (unsigned I = 0, N = ExistingPPOpts.Includes.size(); I != N; ++I) {
705 StringRef File = ExistingPPOpts.Includes[I];
706 if (File == ExistingPPOpts.ImplicitPCHInclude)
709 if (std::find(PPOpts.Includes.begin(), PPOpts.Includes.end(), File)
710 != PPOpts.Includes.end())
713 SuggestedPredefines += "#include \"";
714 SuggestedPredefines += File;
715 SuggestedPredefines += "\"\n";
718 for (unsigned I = 0, N = ExistingPPOpts.MacroIncludes.size(); I != N; ++I) {
719 StringRef File = ExistingPPOpts.MacroIncludes[I];
720 if (std::find(PPOpts.MacroIncludes.begin(), PPOpts.MacroIncludes.end(),
722 != PPOpts.MacroIncludes.end())
725 SuggestedPredefines += "#__include_macros \"";
726 SuggestedPredefines += File;
727 SuggestedPredefines += "\"\n##\n";
733 bool PCHValidator::ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
735 std::string &SuggestedPredefines) {
736 const PreprocessorOptions &ExistingPPOpts = PP.getPreprocessorOpts();
738 return checkPreprocessorOptions(PPOpts, ExistingPPOpts,
739 Complain? &Reader.Diags : nullptr,
745 bool SimpleASTReaderListener::ReadPreprocessorOptions(
746 const PreprocessorOptions &PPOpts,
748 std::string &SuggestedPredefines) {
749 return checkPreprocessorOptions(PPOpts,
750 PP.getPreprocessorOpts(),
758 /// Check the header search options deserialized from the control block
759 /// against the header search options in an existing preprocessor.
761 /// \param Diags If non-null, produce diagnostics for any mismatches incurred.
762 static bool checkHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
763 StringRef SpecificModuleCachePath,
764 StringRef ExistingModuleCachePath,
765 DiagnosticsEngine *Diags,
766 const LangOptions &LangOpts) {
767 if (LangOpts.Modules) {
768 if (SpecificModuleCachePath != ExistingModuleCachePath) {
770 Diags->Report(diag::err_pch_modulecache_mismatch)
771 << SpecificModuleCachePath << ExistingModuleCachePath;
779 bool PCHValidator::ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
780 StringRef SpecificModuleCachePath,
782 return checkHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
783 PP.getHeaderSearchInfo().getModuleCachePath(),
784 Complain ? &Reader.Diags : nullptr,
788 void PCHValidator::ReadCounter(const ModuleFile &M, unsigned Value) {
789 PP.setCounterValue(Value);
792 //===----------------------------------------------------------------------===//
793 // AST reader implementation
794 //===----------------------------------------------------------------------===//
796 void ASTReader::setDeserializationListener(ASTDeserializationListener *Listener,
797 bool TakeOwnership) {
798 DeserializationListener = Listener;
799 OwnsDeserializationListener = TakeOwnership;
802 unsigned ASTSelectorLookupTrait::ComputeHash(Selector Sel) {
803 return serialization::ComputeHash(Sel);
806 std::pair<unsigned, unsigned>
807 ASTSelectorLookupTrait::ReadKeyDataLength(const unsigned char*& d) {
808 using namespace llvm::support;
810 unsigned KeyLen = endian::readNext<uint16_t, little, unaligned>(d);
811 unsigned DataLen = endian::readNext<uint16_t, little, unaligned>(d);
812 return std::make_pair(KeyLen, DataLen);
815 ASTSelectorLookupTrait::internal_key_type
816 ASTSelectorLookupTrait::ReadKey(const unsigned char* d, unsigned) {
817 using namespace llvm::support;
819 SelectorTable &SelTable = Reader.getContext().Selectors;
820 unsigned N = endian::readNext<uint16_t, little, unaligned>(d);
821 IdentifierInfo *FirstII = Reader.getLocalIdentifier(
822 F, endian::readNext<uint32_t, little, unaligned>(d));
824 return SelTable.getNullarySelector(FirstII);
826 return SelTable.getUnarySelector(FirstII);
828 SmallVector<IdentifierInfo *, 16> Args;
829 Args.push_back(FirstII);
830 for (unsigned I = 1; I != N; ++I)
831 Args.push_back(Reader.getLocalIdentifier(
832 F, endian::readNext<uint32_t, little, unaligned>(d)));
834 return SelTable.getSelector(N, Args.data());
837 ASTSelectorLookupTrait::data_type
838 ASTSelectorLookupTrait::ReadData(Selector, const unsigned char* d,
840 using namespace llvm::support;
844 Result.ID = Reader.getGlobalSelectorID(
845 F, endian::readNext<uint32_t, little, unaligned>(d));
846 unsigned FullInstanceBits = endian::readNext<uint16_t, little, unaligned>(d);
847 unsigned FullFactoryBits = endian::readNext<uint16_t, little, unaligned>(d);
848 Result.InstanceBits = FullInstanceBits & 0x3;
849 Result.InstanceHasMoreThanOneDecl = (FullInstanceBits >> 2) & 0x1;
850 Result.FactoryBits = FullFactoryBits & 0x3;
851 Result.FactoryHasMoreThanOneDecl = (FullFactoryBits >> 2) & 0x1;
852 unsigned NumInstanceMethods = FullInstanceBits >> 3;
853 unsigned NumFactoryMethods = FullFactoryBits >> 3;
855 // Load instance methods
856 for (unsigned I = 0; I != NumInstanceMethods; ++I) {
857 if (ObjCMethodDecl *Method = Reader.GetLocalDeclAs<ObjCMethodDecl>(
858 F, endian::readNext<uint32_t, little, unaligned>(d)))
859 Result.Instance.push_back(Method);
862 // Load factory methods
863 for (unsigned I = 0; I != NumFactoryMethods; ++I) {
864 if (ObjCMethodDecl *Method = Reader.GetLocalDeclAs<ObjCMethodDecl>(
865 F, endian::readNext<uint32_t, little, unaligned>(d)))
866 Result.Factory.push_back(Method);
872 unsigned ASTIdentifierLookupTraitBase::ComputeHash(const internal_key_type& a) {
873 return llvm::HashString(a);
876 std::pair<unsigned, unsigned>
877 ASTIdentifierLookupTraitBase::ReadKeyDataLength(const unsigned char*& d) {
878 using namespace llvm::support;
880 unsigned DataLen = endian::readNext<uint16_t, little, unaligned>(d);
881 unsigned KeyLen = endian::readNext<uint16_t, little, unaligned>(d);
882 return std::make_pair(KeyLen, DataLen);
885 ASTIdentifierLookupTraitBase::internal_key_type
886 ASTIdentifierLookupTraitBase::ReadKey(const unsigned char* d, unsigned n) {
887 assert(n >= 2 && d[n-1] == '\0');
888 return StringRef((const char*) d, n-1);
891 /// \brief Whether the given identifier is "interesting".
892 static bool isInterestingIdentifier(ASTReader &Reader, IdentifierInfo &II,
894 return II.hadMacroDefinition() ||
896 (IsModule ? II.hasRevertedBuiltin() : II.getObjCOrBuiltinID()) ||
897 II.hasRevertedTokenIDToIdentifier() ||
898 (!(IsModule && Reader.getPreprocessor().getLangOpts().CPlusPlus) &&
899 II.getFETokenInfo<void>());
902 static bool readBit(unsigned &Bits) {
903 bool Value = Bits & 0x1;
908 IdentID ASTIdentifierLookupTrait::ReadIdentifierID(const unsigned char *d) {
909 using namespace llvm::support;
911 unsigned RawID = endian::readNext<uint32_t, little, unaligned>(d);
912 return Reader.getGlobalIdentifierID(F, RawID >> 1);
915 static void markIdentifierFromAST(ASTReader &Reader, IdentifierInfo &II) {
916 if (!II.isFromAST()) {
918 bool IsModule = Reader.getPreprocessor().getCurrentModule() != nullptr;
919 if (isInterestingIdentifier(Reader, II, IsModule))
920 II.setChangedSinceDeserialization();
924 IdentifierInfo *ASTIdentifierLookupTrait::ReadData(const internal_key_type& k,
925 const unsigned char* d,
927 using namespace llvm::support;
929 unsigned RawID = endian::readNext<uint32_t, little, unaligned>(d);
930 bool IsInteresting = RawID & 0x01;
932 // Wipe out the "is interesting" bit.
935 // Build the IdentifierInfo and link the identifier ID with it.
936 IdentifierInfo *II = KnownII;
938 II = &Reader.getIdentifierTable().getOwn(k);
941 markIdentifierFromAST(Reader, *II);
942 Reader.markIdentifierUpToDate(II);
944 IdentID ID = Reader.getGlobalIdentifierID(F, RawID);
945 if (!IsInteresting) {
946 // For uninteresting identifiers, there's nothing else to do. Just notify
947 // the reader that we've finished loading this identifier.
948 Reader.SetIdentifierInfo(ID, II);
952 unsigned ObjCOrBuiltinID = endian::readNext<uint16_t, little, unaligned>(d);
953 unsigned Bits = endian::readNext<uint16_t, little, unaligned>(d);
954 bool CPlusPlusOperatorKeyword = readBit(Bits);
955 bool HasRevertedTokenIDToIdentifier = readBit(Bits);
956 bool HasRevertedBuiltin = readBit(Bits);
957 bool Poisoned = readBit(Bits);
958 bool ExtensionToken = readBit(Bits);
959 bool HadMacroDefinition = readBit(Bits);
961 assert(Bits == 0 && "Extra bits in the identifier?");
964 // Set or check the various bits in the IdentifierInfo structure.
965 // Token IDs are read-only.
966 if (HasRevertedTokenIDToIdentifier && II->getTokenID() != tok::identifier)
967 II->revertTokenIDToIdentifier();
969 II->setObjCOrBuiltinID(ObjCOrBuiltinID);
970 else if (HasRevertedBuiltin && II->getBuiltinID()) {
972 assert((II->hasRevertedBuiltin() ||
973 II->getObjCOrBuiltinID() == ObjCOrBuiltinID) &&
974 "Incorrect ObjC keyword or builtin ID");
976 assert(II->isExtensionToken() == ExtensionToken &&
977 "Incorrect extension token flag");
978 (void)ExtensionToken;
980 II->setIsPoisoned(true);
981 assert(II->isCPlusPlusOperatorKeyword() == CPlusPlusOperatorKeyword &&
982 "Incorrect C++ operator keyword flag");
983 (void)CPlusPlusOperatorKeyword;
985 // If this identifier is a macro, deserialize the macro
987 if (HadMacroDefinition) {
988 uint32_t MacroDirectivesOffset =
989 endian::readNext<uint32_t, little, unaligned>(d);
992 Reader.addPendingMacro(II, &F, MacroDirectivesOffset);
995 Reader.SetIdentifierInfo(ID, II);
997 // Read all of the declarations visible at global scope with this
1000 SmallVector<uint32_t, 4> DeclIDs;
1001 for (; DataLen > 0; DataLen -= 4)
1002 DeclIDs.push_back(Reader.getGlobalDeclID(
1003 F, endian::readNext<uint32_t, little, unaligned>(d)));
1004 Reader.SetGloballyVisibleDecls(II, DeclIDs);
1010 DeclarationNameKey::DeclarationNameKey(DeclarationName Name)
1011 : Kind(Name.getNameKind()) {
1013 case DeclarationName::Identifier:
1014 Data = (uint64_t)Name.getAsIdentifierInfo();
1016 case DeclarationName::ObjCZeroArgSelector:
1017 case DeclarationName::ObjCOneArgSelector:
1018 case DeclarationName::ObjCMultiArgSelector:
1019 Data = (uint64_t)Name.getObjCSelector().getAsOpaquePtr();
1021 case DeclarationName::CXXOperatorName:
1022 Data = Name.getCXXOverloadedOperator();
1024 case DeclarationName::CXXLiteralOperatorName:
1025 Data = (uint64_t)Name.getCXXLiteralIdentifier();
1027 case DeclarationName::CXXDeductionGuideName:
1028 Data = (uint64_t)Name.getCXXDeductionGuideTemplate()
1029 ->getDeclName().getAsIdentifierInfo();
1031 case DeclarationName::CXXConstructorName:
1032 case DeclarationName::CXXDestructorName:
1033 case DeclarationName::CXXConversionFunctionName:
1034 case DeclarationName::CXXUsingDirective:
1040 unsigned DeclarationNameKey::getHash() const {
1041 llvm::FoldingSetNodeID ID;
1042 ID.AddInteger(Kind);
1045 case DeclarationName::Identifier:
1046 case DeclarationName::CXXLiteralOperatorName:
1047 case DeclarationName::CXXDeductionGuideName:
1048 ID.AddString(((IdentifierInfo*)Data)->getName());
1050 case DeclarationName::ObjCZeroArgSelector:
1051 case DeclarationName::ObjCOneArgSelector:
1052 case DeclarationName::ObjCMultiArgSelector:
1053 ID.AddInteger(serialization::ComputeHash(Selector(Data)));
1055 case DeclarationName::CXXOperatorName:
1056 ID.AddInteger((OverloadedOperatorKind)Data);
1058 case DeclarationName::CXXConstructorName:
1059 case DeclarationName::CXXDestructorName:
1060 case DeclarationName::CXXConversionFunctionName:
1061 case DeclarationName::CXXUsingDirective:
1065 return ID.ComputeHash();
1069 ASTDeclContextNameLookupTrait::ReadFileRef(const unsigned char *&d) {
1070 using namespace llvm::support;
1072 uint32_t ModuleFileID = endian::readNext<uint32_t, little, unaligned>(d);
1073 return Reader.getLocalModuleFile(F, ModuleFileID);
1076 std::pair<unsigned, unsigned>
1077 ASTDeclContextNameLookupTrait::ReadKeyDataLength(const unsigned char *&d) {
1078 using namespace llvm::support;
1080 unsigned KeyLen = endian::readNext<uint16_t, little, unaligned>(d);
1081 unsigned DataLen = endian::readNext<uint16_t, little, unaligned>(d);
1082 return std::make_pair(KeyLen, DataLen);
1085 ASTDeclContextNameLookupTrait::internal_key_type
1086 ASTDeclContextNameLookupTrait::ReadKey(const unsigned char *d, unsigned) {
1087 using namespace llvm::support;
1089 auto Kind = (DeclarationName::NameKind)*d++;
1092 case DeclarationName::Identifier:
1093 case DeclarationName::CXXLiteralOperatorName:
1094 case DeclarationName::CXXDeductionGuideName:
1095 Data = (uint64_t)Reader.getLocalIdentifier(
1096 F, endian::readNext<uint32_t, little, unaligned>(d));
1098 case DeclarationName::ObjCZeroArgSelector:
1099 case DeclarationName::ObjCOneArgSelector:
1100 case DeclarationName::ObjCMultiArgSelector:
1102 (uint64_t)Reader.getLocalSelector(
1103 F, endian::readNext<uint32_t, little, unaligned>(
1104 d)).getAsOpaquePtr();
1106 case DeclarationName::CXXOperatorName:
1107 Data = *d++; // OverloadedOperatorKind
1109 case DeclarationName::CXXConstructorName:
1110 case DeclarationName::CXXDestructorName:
1111 case DeclarationName::CXXConversionFunctionName:
1112 case DeclarationName::CXXUsingDirective:
1117 return DeclarationNameKey(Kind, Data);
1120 void ASTDeclContextNameLookupTrait::ReadDataInto(internal_key_type,
1121 const unsigned char *d,
1123 data_type_builder &Val) {
1124 using namespace llvm::support;
1126 for (unsigned NumDecls = DataLen / 4; NumDecls; --NumDecls) {
1127 uint32_t LocalID = endian::readNext<uint32_t, little, unaligned>(d);
1128 Val.insert(Reader.getGlobalDeclID(F, LocalID));
1132 bool ASTReader::ReadLexicalDeclContextStorage(ModuleFile &M,
1133 BitstreamCursor &Cursor,
1136 assert(Offset != 0);
1138 SavedStreamPosition SavedPosition(Cursor);
1139 Cursor.JumpToBit(Offset);
1143 unsigned Code = Cursor.ReadCode();
1144 unsigned RecCode = Cursor.readRecord(Code, Record, &Blob);
1145 if (RecCode != DECL_CONTEXT_LEXICAL) {
1146 Error("Expected lexical block");
1150 assert(!isa<TranslationUnitDecl>(DC) &&
1151 "expected a TU_UPDATE_LEXICAL record for TU");
1152 // If we are handling a C++ class template instantiation, we can see multiple
1153 // lexical updates for the same record. It's important that we select only one
1154 // of them, so that field numbering works properly. Just pick the first one we
1156 auto &Lex = LexicalDecls[DC];
1158 Lex = std::make_pair(
1159 &M, llvm::makeArrayRef(
1160 reinterpret_cast<const llvm::support::unaligned_uint32_t *>(
1164 DC->setHasExternalLexicalStorage(true);
1168 bool ASTReader::ReadVisibleDeclContextStorage(ModuleFile &M,
1169 BitstreamCursor &Cursor,
1172 assert(Offset != 0);
1174 SavedStreamPosition SavedPosition(Cursor);
1175 Cursor.JumpToBit(Offset);
1179 unsigned Code = Cursor.ReadCode();
1180 unsigned RecCode = Cursor.readRecord(Code, Record, &Blob);
1181 if (RecCode != DECL_CONTEXT_VISIBLE) {
1182 Error("Expected visible lookup table block");
1186 // We can't safely determine the primary context yet, so delay attaching the
1187 // lookup table until we're done with recursive deserialization.
1188 auto *Data = (const unsigned char*)Blob.data();
1189 PendingVisibleUpdates[ID].push_back(PendingVisibleUpdate{&M, Data});
1193 void ASTReader::Error(StringRef Msg) const {
1194 Error(diag::err_fe_pch_malformed, Msg);
1195 if (PP.getLangOpts().Modules && !Diags.isDiagnosticInFlight() &&
1196 !PP.getHeaderSearchInfo().getModuleCachePath().empty()) {
1197 Diag(diag::note_module_cache_path)
1198 << PP.getHeaderSearchInfo().getModuleCachePath();
1202 void ASTReader::Error(unsigned DiagID,
1203 StringRef Arg1, StringRef Arg2) const {
1204 if (Diags.isDiagnosticInFlight())
1205 Diags.SetDelayedDiagnostic(DiagID, Arg1, Arg2);
1207 Diag(DiagID) << Arg1 << Arg2;
1210 //===----------------------------------------------------------------------===//
1211 // Source Manager Deserialization
1212 //===----------------------------------------------------------------------===//
1214 /// \brief Read the line table in the source manager block.
1215 /// \returns true if there was an error.
1216 bool ASTReader::ParseLineTable(ModuleFile &F,
1217 const RecordData &Record) {
1219 LineTableInfo &LineTable = SourceMgr.getLineTable();
1221 // Parse the file names
1222 std::map<int, int> FileIDs;
1223 FileIDs[-1] = -1; // For unspecified filenames.
1224 for (unsigned I = 0; Record[Idx]; ++I) {
1225 // Extract the file name
1226 auto Filename = ReadPath(F, Record, Idx);
1227 FileIDs[I] = LineTable.getLineTableFilenameID(Filename);
1231 // Parse the line entries
1232 std::vector<LineEntry> Entries;
1233 while (Idx < Record.size()) {
1234 int FID = Record[Idx++];
1235 assert(FID >= 0 && "Serialized line entries for non-local file.");
1236 // Remap FileID from 1-based old view.
1237 FID += F.SLocEntryBaseID - 1;
1239 // Extract the line entries
1240 unsigned NumEntries = Record[Idx++];
1241 assert(NumEntries && "no line entries for file ID");
1243 Entries.reserve(NumEntries);
1244 for (unsigned I = 0; I != NumEntries; ++I) {
1245 unsigned FileOffset = Record[Idx++];
1246 unsigned LineNo = Record[Idx++];
1247 int FilenameID = FileIDs[Record[Idx++]];
1248 SrcMgr::CharacteristicKind FileKind
1249 = (SrcMgr::CharacteristicKind)Record[Idx++];
1250 unsigned IncludeOffset = Record[Idx++];
1251 Entries.push_back(LineEntry::get(FileOffset, LineNo, FilenameID,
1252 FileKind, IncludeOffset));
1254 LineTable.AddEntry(FileID::get(FID), Entries);
1260 /// \brief Read a source manager block
1261 bool ASTReader::ReadSourceManagerBlock(ModuleFile &F) {
1262 using namespace SrcMgr;
1264 BitstreamCursor &SLocEntryCursor = F.SLocEntryCursor;
1266 // Set the source-location entry cursor to the current position in
1267 // the stream. This cursor will be used to read the contents of the
1268 // source manager block initially, and then lazily read
1269 // source-location entries as needed.
1270 SLocEntryCursor = F.Stream;
1272 // The stream itself is going to skip over the source manager block.
1273 if (F.Stream.SkipBlock()) {
1274 Error("malformed block record in AST file");
1278 // Enter the source manager block.
1279 if (SLocEntryCursor.EnterSubBlock(SOURCE_MANAGER_BLOCK_ID)) {
1280 Error("malformed source manager block record in AST file");
1286 llvm::BitstreamEntry E = SLocEntryCursor.advanceSkippingSubblocks();
1289 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
1290 case llvm::BitstreamEntry::Error:
1291 Error("malformed block record in AST file");
1293 case llvm::BitstreamEntry::EndBlock:
1295 case llvm::BitstreamEntry::Record:
1296 // The interesting case.
1303 switch (SLocEntryCursor.readRecord(E.ID, Record, &Blob)) {
1304 default: // Default behavior: ignore.
1307 case SM_SLOC_FILE_ENTRY:
1308 case SM_SLOC_BUFFER_ENTRY:
1309 case SM_SLOC_EXPANSION_ENTRY:
1310 // Once we hit one of the source location entries, we're done.
1316 /// \brief If a header file is not found at the path that we expect it to be
1317 /// and the PCH file was moved from its original location, try to resolve the
1318 /// file by assuming that header+PCH were moved together and the header is in
1319 /// the same place relative to the PCH.
1321 resolveFileRelativeToOriginalDir(const std::string &Filename,
1322 const std::string &OriginalDir,
1323 const std::string &CurrDir) {
1324 assert(OriginalDir != CurrDir &&
1325 "No point trying to resolve the file if the PCH dir didn't change");
1327 using namespace llvm::sys;
1329 SmallString<128> filePath(Filename);
1330 fs::make_absolute(filePath);
1331 assert(path::is_absolute(OriginalDir));
1332 SmallString<128> currPCHPath(CurrDir);
1334 path::const_iterator fileDirI = path::begin(path::parent_path(filePath)),
1335 fileDirE = path::end(path::parent_path(filePath));
1336 path::const_iterator origDirI = path::begin(OriginalDir),
1337 origDirE = path::end(OriginalDir);
1338 // Skip the common path components from filePath and OriginalDir.
1339 while (fileDirI != fileDirE && origDirI != origDirE &&
1340 *fileDirI == *origDirI) {
1344 for (; origDirI != origDirE; ++origDirI)
1345 path::append(currPCHPath, "..");
1346 path::append(currPCHPath, fileDirI, fileDirE);
1347 path::append(currPCHPath, path::filename(Filename));
1348 return currPCHPath.str();
1351 bool ASTReader::ReadSLocEntry(int ID) {
1355 if (unsigned(-ID) - 2 >= getTotalNumSLocs() || ID > 0) {
1356 Error("source location entry ID out-of-range for AST file");
1360 // Local helper to read the (possibly-compressed) buffer data following the
1362 auto ReadBuffer = [this](
1363 BitstreamCursor &SLocEntryCursor,
1364 StringRef Name) -> std::unique_ptr<llvm::MemoryBuffer> {
1367 unsigned Code = SLocEntryCursor.ReadCode();
1368 unsigned RecCode = SLocEntryCursor.readRecord(Code, Record, &Blob);
1370 if (RecCode == SM_SLOC_BUFFER_BLOB_COMPRESSED) {
1371 if (!llvm::zlib::isAvailable()) {
1372 Error("zlib is not available");
1375 SmallString<0> Uncompressed;
1377 llvm::zlib::uncompress(Blob, Uncompressed, Record[0])) {
1378 Error("could not decompress embedded file contents: " +
1379 llvm::toString(std::move(E)));
1382 return llvm::MemoryBuffer::getMemBufferCopy(Uncompressed, Name);
1383 } else if (RecCode == SM_SLOC_BUFFER_BLOB) {
1384 return llvm::MemoryBuffer::getMemBuffer(Blob.drop_back(1), Name, true);
1386 Error("AST record has invalid code");
1391 ModuleFile *F = GlobalSLocEntryMap.find(-ID)->second;
1392 F->SLocEntryCursor.JumpToBit(F->SLocEntryOffsets[ID - F->SLocEntryBaseID]);
1393 BitstreamCursor &SLocEntryCursor = F->SLocEntryCursor;
1394 unsigned BaseOffset = F->SLocEntryBaseOffset;
1396 ++NumSLocEntriesRead;
1397 llvm::BitstreamEntry Entry = SLocEntryCursor.advance();
1398 if (Entry.Kind != llvm::BitstreamEntry::Record) {
1399 Error("incorrectly-formatted source location entry in AST file");
1405 switch (SLocEntryCursor.readRecord(Entry.ID, Record, &Blob)) {
1407 Error("incorrectly-formatted source location entry in AST file");
1410 case SM_SLOC_FILE_ENTRY: {
1411 // We will detect whether a file changed and return 'Failure' for it, but
1412 // we will also try to fail gracefully by setting up the SLocEntry.
1413 unsigned InputID = Record[4];
1414 InputFile IF = getInputFile(*F, InputID);
1415 const FileEntry *File = IF.getFile();
1416 bool OverriddenBuffer = IF.isOverridden();
1418 // Note that we only check if a File was returned. If it was out-of-date
1419 // we have complained but we will continue creating a FileID to recover
1424 SourceLocation IncludeLoc = ReadSourceLocation(*F, Record[1]);
1425 if (IncludeLoc.isInvalid() && F->Kind != MK_MainFile) {
1426 // This is the module's main file.
1427 IncludeLoc = getImportLocation(F);
1429 SrcMgr::CharacteristicKind
1430 FileCharacter = (SrcMgr::CharacteristicKind)Record[2];
1431 FileID FID = SourceMgr.createFileID(File, IncludeLoc, FileCharacter,
1432 ID, BaseOffset + Record[0]);
1433 SrcMgr::FileInfo &FileInfo =
1434 const_cast<SrcMgr::FileInfo&>(SourceMgr.getSLocEntry(FID).getFile());
1435 FileInfo.NumCreatedFIDs = Record[5];
1437 FileInfo.setHasLineDirectives();
1439 const DeclID *FirstDecl = F->FileSortedDecls + Record[6];
1440 unsigned NumFileDecls = Record[7];
1441 if (NumFileDecls && ContextObj) {
1442 assert(F->FileSortedDecls && "FILE_SORTED_DECLS not encountered yet ?");
1443 FileDeclIDs[FID] = FileDeclsInfo(F, llvm::makeArrayRef(FirstDecl,
1447 const SrcMgr::ContentCache *ContentCache
1448 = SourceMgr.getOrCreateContentCache(File, isSystem(FileCharacter));
1449 if (OverriddenBuffer && !ContentCache->BufferOverridden &&
1450 ContentCache->ContentsEntry == ContentCache->OrigEntry &&
1451 !ContentCache->getRawBuffer()) {
1452 auto Buffer = ReadBuffer(SLocEntryCursor, File->getName());
1455 SourceMgr.overrideFileContents(File, std::move(Buffer));
1461 case SM_SLOC_BUFFER_ENTRY: {
1462 const char *Name = Blob.data();
1463 unsigned Offset = Record[0];
1464 SrcMgr::CharacteristicKind
1465 FileCharacter = (SrcMgr::CharacteristicKind)Record[2];
1466 SourceLocation IncludeLoc = ReadSourceLocation(*F, Record[1]);
1467 if (IncludeLoc.isInvalid() && F->isModule()) {
1468 IncludeLoc = getImportLocation(F);
1471 auto Buffer = ReadBuffer(SLocEntryCursor, Name);
1474 SourceMgr.createFileID(std::move(Buffer), FileCharacter, ID,
1475 BaseOffset + Offset, IncludeLoc);
1479 case SM_SLOC_EXPANSION_ENTRY: {
1480 SourceLocation SpellingLoc = ReadSourceLocation(*F, Record[1]);
1481 SourceMgr.createExpansionLoc(SpellingLoc,
1482 ReadSourceLocation(*F, Record[2]),
1483 ReadSourceLocation(*F, Record[3]),
1486 BaseOffset + Record[0]);
1494 std::pair<SourceLocation, StringRef> ASTReader::getModuleImportLoc(int ID) {
1496 return std::make_pair(SourceLocation(), "");
1498 if (unsigned(-ID) - 2 >= getTotalNumSLocs() || ID > 0) {
1499 Error("source location entry ID out-of-range for AST file");
1500 return std::make_pair(SourceLocation(), "");
1503 // Find which module file this entry lands in.
1504 ModuleFile *M = GlobalSLocEntryMap.find(-ID)->second;
1506 return std::make_pair(SourceLocation(), "");
1508 // FIXME: Can we map this down to a particular submodule? That would be
1510 return std::make_pair(M->ImportLoc, StringRef(M->ModuleName));
1513 /// \brief Find the location where the module F is imported.
1514 SourceLocation ASTReader::getImportLocation(ModuleFile *F) {
1515 if (F->ImportLoc.isValid())
1516 return F->ImportLoc;
1518 // Otherwise we have a PCH. It's considered to be "imported" at the first
1519 // location of its includer.
1520 if (F->ImportedBy.empty() || !F->ImportedBy[0]) {
1521 // Main file is the importer.
1522 assert(SourceMgr.getMainFileID().isValid() && "missing main file");
1523 return SourceMgr.getLocForStartOfFile(SourceMgr.getMainFileID());
1525 return F->ImportedBy[0]->FirstLoc;
1528 /// ReadBlockAbbrevs - Enter a subblock of the specified BlockID with the
1529 /// specified cursor. Read the abbreviations that are at the top of the block
1530 /// and then leave the cursor pointing into the block.
1531 bool ASTReader::ReadBlockAbbrevs(BitstreamCursor &Cursor, unsigned BlockID) {
1532 if (Cursor.EnterSubBlock(BlockID))
1536 uint64_t Offset = Cursor.GetCurrentBitNo();
1537 unsigned Code = Cursor.ReadCode();
1539 // We expect all abbrevs to be at the start of the block.
1540 if (Code != llvm::bitc::DEFINE_ABBREV) {
1541 Cursor.JumpToBit(Offset);
1544 Cursor.ReadAbbrevRecord();
1548 Token ASTReader::ReadToken(ModuleFile &F, const RecordDataImpl &Record,
1552 Tok.setLocation(ReadSourceLocation(F, Record, Idx));
1553 Tok.setLength(Record[Idx++]);
1554 if (IdentifierInfo *II = getLocalIdentifier(F, Record[Idx++]))
1555 Tok.setIdentifierInfo(II);
1556 Tok.setKind((tok::TokenKind)Record[Idx++]);
1557 Tok.setFlag((Token::TokenFlags)Record[Idx++]);
1561 MacroInfo *ASTReader::ReadMacroRecord(ModuleFile &F, uint64_t Offset) {
1562 BitstreamCursor &Stream = F.MacroCursor;
1564 // Keep track of where we are in the stream, then jump back there
1565 // after reading this macro.
1566 SavedStreamPosition SavedPosition(Stream);
1568 Stream.JumpToBit(Offset);
1570 SmallVector<IdentifierInfo*, 16> MacroParams;
1571 MacroInfo *Macro = nullptr;
1574 // Advance to the next record, but if we get to the end of the block, don't
1575 // pop it (removing all the abbreviations from the cursor) since we want to
1576 // be able to reseek within the block and read entries.
1577 unsigned Flags = BitstreamCursor::AF_DontPopBlockAtEnd;
1578 llvm::BitstreamEntry Entry = Stream.advanceSkippingSubblocks(Flags);
1580 switch (Entry.Kind) {
1581 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
1582 case llvm::BitstreamEntry::Error:
1583 Error("malformed block record in AST file");
1585 case llvm::BitstreamEntry::EndBlock:
1587 case llvm::BitstreamEntry::Record:
1588 // The interesting case.
1594 PreprocessorRecordTypes RecType =
1595 (PreprocessorRecordTypes)Stream.readRecord(Entry.ID, Record);
1597 case PP_MODULE_MACRO:
1598 case PP_MACRO_DIRECTIVE_HISTORY:
1601 case PP_MACRO_OBJECT_LIKE:
1602 case PP_MACRO_FUNCTION_LIKE: {
1603 // If we already have a macro, that means that we've hit the end
1604 // of the definition of the macro we were looking for. We're
1609 unsigned NextIndex = 1; // Skip identifier ID.
1610 SourceLocation Loc = ReadSourceLocation(F, Record, NextIndex);
1611 MacroInfo *MI = PP.AllocateMacroInfo(Loc);
1612 MI->setDefinitionEndLoc(ReadSourceLocation(F, Record, NextIndex));
1613 MI->setIsUsed(Record[NextIndex++]);
1614 MI->setUsedForHeaderGuard(Record[NextIndex++]);
1616 if (RecType == PP_MACRO_FUNCTION_LIKE) {
1617 // Decode function-like macro info.
1618 bool isC99VarArgs = Record[NextIndex++];
1619 bool isGNUVarArgs = Record[NextIndex++];
1620 bool hasCommaPasting = Record[NextIndex++];
1621 MacroParams.clear();
1622 unsigned NumArgs = Record[NextIndex++];
1623 for (unsigned i = 0; i != NumArgs; ++i)
1624 MacroParams.push_back(getLocalIdentifier(F, Record[NextIndex++]));
1626 // Install function-like macro info.
1627 MI->setIsFunctionLike();
1628 if (isC99VarArgs) MI->setIsC99Varargs();
1629 if (isGNUVarArgs) MI->setIsGNUVarargs();
1630 if (hasCommaPasting) MI->setHasCommaPasting();
1631 MI->setParameterList(MacroParams, PP.getPreprocessorAllocator());
1634 // Remember that we saw this macro last so that we add the tokens that
1635 // form its body to it.
1638 if (NextIndex + 1 == Record.size() && PP.getPreprocessingRecord() &&
1639 Record[NextIndex]) {
1640 // We have a macro definition. Register the association
1641 PreprocessedEntityID
1642 GlobalID = getGlobalPreprocessedEntityID(F, Record[NextIndex]);
1643 PreprocessingRecord &PPRec = *PP.getPreprocessingRecord();
1644 PreprocessingRecord::PPEntityID PPID =
1645 PPRec.getPPEntityID(GlobalID - 1, /*isLoaded=*/true);
1646 MacroDefinitionRecord *PPDef = cast_or_null<MacroDefinitionRecord>(
1647 PPRec.getPreprocessedEntity(PPID));
1649 PPRec.RegisterMacroDefinition(Macro, PPDef);
1657 // If we see a TOKEN before a PP_MACRO_*, then the file is
1658 // erroneous, just pretend we didn't see this.
1662 Token Tok = ReadToken(F, Record, Idx);
1663 Macro->AddTokenToBody(Tok);
1670 PreprocessedEntityID
1671 ASTReader::getGlobalPreprocessedEntityID(ModuleFile &M,
1672 unsigned LocalID) const {
1673 if (!M.ModuleOffsetMap.empty())
1674 ReadModuleOffsetMap(M);
1676 ContinuousRangeMap<uint32_t, int, 2>::const_iterator
1677 I = M.PreprocessedEntityRemap.find(LocalID - NUM_PREDEF_PP_ENTITY_IDS);
1678 assert(I != M.PreprocessedEntityRemap.end()
1679 && "Invalid index into preprocessed entity index remap");
1681 return LocalID + I->second;
1684 unsigned HeaderFileInfoTrait::ComputeHash(internal_key_ref ikey) {
1685 return llvm::hash_combine(ikey.Size, ikey.ModTime);
1688 HeaderFileInfoTrait::internal_key_type
1689 HeaderFileInfoTrait::GetInternalKey(const FileEntry *FE) {
1690 internal_key_type ikey = {FE->getSize(),
1691 M.HasTimestamps ? FE->getModificationTime() : 0,
1692 FE->getName(), /*Imported*/ false};
1696 bool HeaderFileInfoTrait::EqualKey(internal_key_ref a, internal_key_ref b) {
1697 if (a.Size != b.Size || (a.ModTime && b.ModTime && a.ModTime != b.ModTime))
1700 if (llvm::sys::path::is_absolute(a.Filename) && a.Filename == b.Filename)
1703 // Determine whether the actual files are equivalent.
1704 FileManager &FileMgr = Reader.getFileManager();
1705 auto GetFile = [&](const internal_key_type &Key) -> const FileEntry* {
1707 return FileMgr.getFile(Key.Filename);
1709 std::string Resolved = Key.Filename;
1710 Reader.ResolveImportedPath(M, Resolved);
1711 return FileMgr.getFile(Resolved);
1714 const FileEntry *FEA = GetFile(a);
1715 const FileEntry *FEB = GetFile(b);
1716 return FEA && FEA == FEB;
1719 std::pair<unsigned, unsigned>
1720 HeaderFileInfoTrait::ReadKeyDataLength(const unsigned char*& d) {
1721 using namespace llvm::support;
1723 unsigned KeyLen = (unsigned) endian::readNext<uint16_t, little, unaligned>(d);
1724 unsigned DataLen = (unsigned) *d++;
1725 return std::make_pair(KeyLen, DataLen);
1728 HeaderFileInfoTrait::internal_key_type
1729 HeaderFileInfoTrait::ReadKey(const unsigned char *d, unsigned) {
1730 using namespace llvm::support;
1732 internal_key_type ikey;
1733 ikey.Size = off_t(endian::readNext<uint64_t, little, unaligned>(d));
1734 ikey.ModTime = time_t(endian::readNext<uint64_t, little, unaligned>(d));
1735 ikey.Filename = (const char *)d;
1736 ikey.Imported = true;
1740 HeaderFileInfoTrait::data_type
1741 HeaderFileInfoTrait::ReadData(internal_key_ref key, const unsigned char *d,
1743 using namespace llvm::support;
1745 const unsigned char *End = d + DataLen;
1747 unsigned Flags = *d++;
1748 // FIXME: Refactor with mergeHeaderFileInfo in HeaderSearch.cpp.
1749 HFI.isImport |= (Flags >> 5) & 0x01;
1750 HFI.isPragmaOnce |= (Flags >> 4) & 0x01;
1751 HFI.DirInfo = (Flags >> 1) & 0x07;
1752 HFI.IndexHeaderMapHeader = Flags & 0x01;
1753 // FIXME: Find a better way to handle this. Maybe just store a
1754 // "has been included" flag?
1755 HFI.NumIncludes = std::max(endian::readNext<uint16_t, little, unaligned>(d),
1757 HFI.ControllingMacroID = Reader.getGlobalIdentifierID(
1758 M, endian::readNext<uint32_t, little, unaligned>(d));
1759 if (unsigned FrameworkOffset =
1760 endian::readNext<uint32_t, little, unaligned>(d)) {
1761 // The framework offset is 1 greater than the actual offset,
1762 // since 0 is used as an indicator for "no framework name".
1763 StringRef FrameworkName(FrameworkStrings + FrameworkOffset - 1);
1764 HFI.Framework = HS->getUniqueFrameworkName(FrameworkName);
1767 assert((End - d) % 4 == 0 &&
1768 "Wrong data length in HeaderFileInfo deserialization");
1770 uint32_t LocalSMID = endian::readNext<uint32_t, little, unaligned>(d);
1771 auto HeaderRole = static_cast<ModuleMap::ModuleHeaderRole>(LocalSMID & 3);
1774 // This header is part of a module. Associate it with the module to enable
1775 // implicit module import.
1776 SubmoduleID GlobalSMID = Reader.getGlobalSubmoduleID(M, LocalSMID);
1777 Module *Mod = Reader.getSubmodule(GlobalSMID);
1778 FileManager &FileMgr = Reader.getFileManager();
1780 Reader.getPreprocessor().getHeaderSearchInfo().getModuleMap();
1782 std::string Filename = key.Filename;
1784 Reader.ResolveImportedPath(M, Filename);
1785 // FIXME: This is not always the right filename-as-written, but we're not
1786 // going to use this information to rebuild the module, so it doesn't make
1787 // a lot of difference.
1788 Module::Header H = { key.Filename, FileMgr.getFile(Filename) };
1789 ModMap.addHeader(Mod, H, HeaderRole, /*Imported*/true);
1790 HFI.isModuleHeader |= !(HeaderRole & ModuleMap::TextualHeader);
1793 // This HeaderFileInfo was externally loaded.
1794 HFI.External = true;
1799 void ASTReader::addPendingMacro(IdentifierInfo *II,
1801 uint64_t MacroDirectivesOffset) {
1802 assert(NumCurrentElementsDeserializing > 0 &&"Missing deserialization guard");
1803 PendingMacroIDs[II].push_back(PendingMacroInfo(M, MacroDirectivesOffset));
1806 void ASTReader::ReadDefinedMacros() {
1807 // Note that we are loading defined macros.
1808 Deserializing Macros(this);
1810 for (ModuleFile &I : llvm::reverse(ModuleMgr)) {
1811 BitstreamCursor &MacroCursor = I.MacroCursor;
1813 // If there was no preprocessor block, skip this file.
1814 if (MacroCursor.getBitcodeBytes().empty())
1817 BitstreamCursor Cursor = MacroCursor;
1818 Cursor.JumpToBit(I.MacroStartOffset);
1822 llvm::BitstreamEntry E = Cursor.advanceSkippingSubblocks();
1825 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
1826 case llvm::BitstreamEntry::Error:
1827 Error("malformed block record in AST file");
1829 case llvm::BitstreamEntry::EndBlock:
1832 case llvm::BitstreamEntry::Record:
1834 switch (Cursor.readRecord(E.ID, Record)) {
1835 default: // Default behavior: ignore.
1838 case PP_MACRO_OBJECT_LIKE:
1839 case PP_MACRO_FUNCTION_LIKE: {
1840 IdentifierInfo *II = getLocalIdentifier(I, Record[0]);
1841 if (II->isOutOfDate())
1842 updateOutOfDateIdentifier(*II);
1859 /// \brief Visitor class used to look up identifirs in an AST file.
1860 class IdentifierLookupVisitor {
1863 unsigned PriorGeneration;
1864 unsigned &NumIdentifierLookups;
1865 unsigned &NumIdentifierLookupHits;
1866 IdentifierInfo *Found = nullptr;
1869 IdentifierLookupVisitor(StringRef Name, unsigned PriorGeneration,
1870 unsigned &NumIdentifierLookups,
1871 unsigned &NumIdentifierLookupHits)
1872 : Name(Name), NameHash(ASTIdentifierLookupTrait::ComputeHash(Name)),
1873 PriorGeneration(PriorGeneration),
1874 NumIdentifierLookups(NumIdentifierLookups),
1875 NumIdentifierLookupHits(NumIdentifierLookupHits) {}
1877 bool operator()(ModuleFile &M) {
1878 // If we've already searched this module file, skip it now.
1879 if (M.Generation <= PriorGeneration)
1882 ASTIdentifierLookupTable *IdTable
1883 = (ASTIdentifierLookupTable *)M.IdentifierLookupTable;
1887 ASTIdentifierLookupTrait Trait(IdTable->getInfoObj().getReader(), M,
1889 ++NumIdentifierLookups;
1890 ASTIdentifierLookupTable::iterator Pos =
1891 IdTable->find_hashed(Name, NameHash, &Trait);
1892 if (Pos == IdTable->end())
1895 // Dereferencing the iterator has the effect of building the
1896 // IdentifierInfo node and populating it with the various
1897 // declarations it needs.
1898 ++NumIdentifierLookupHits;
1903 // \brief Retrieve the identifier info found within the module
1905 IdentifierInfo *getIdentifierInfo() const { return Found; }
1910 void ASTReader::updateOutOfDateIdentifier(IdentifierInfo &II) {
1911 // Note that we are loading an identifier.
1912 Deserializing AnIdentifier(this);
1914 unsigned PriorGeneration = 0;
1915 if (getContext().getLangOpts().Modules)
1916 PriorGeneration = IdentifierGeneration[&II];
1918 // If there is a global index, look there first to determine which modules
1919 // provably do not have any results for this identifier.
1920 GlobalModuleIndex::HitSet Hits;
1921 GlobalModuleIndex::HitSet *HitsPtr = nullptr;
1922 if (!loadGlobalIndex()) {
1923 if (GlobalIndex->lookupIdentifier(II.getName(), Hits)) {
1928 IdentifierLookupVisitor Visitor(II.getName(), PriorGeneration,
1929 NumIdentifierLookups,
1930 NumIdentifierLookupHits);
1931 ModuleMgr.visit(Visitor, HitsPtr);
1932 markIdentifierUpToDate(&II);
1935 void ASTReader::markIdentifierUpToDate(IdentifierInfo *II) {
1939 II->setOutOfDate(false);
1941 // Update the generation for this identifier.
1942 if (getContext().getLangOpts().Modules)
1943 IdentifierGeneration[II] = getGeneration();
1946 void ASTReader::resolvePendingMacro(IdentifierInfo *II,
1947 const PendingMacroInfo &PMInfo) {
1948 ModuleFile &M = *PMInfo.M;
1950 BitstreamCursor &Cursor = M.MacroCursor;
1951 SavedStreamPosition SavedPosition(Cursor);
1952 Cursor.JumpToBit(PMInfo.MacroDirectivesOffset);
1954 struct ModuleMacroRecord {
1955 SubmoduleID SubModID;
1957 SmallVector<SubmoduleID, 8> Overrides;
1959 llvm::SmallVector<ModuleMacroRecord, 8> ModuleMacros;
1961 // We expect to see a sequence of PP_MODULE_MACRO records listing exported
1962 // macros, followed by a PP_MACRO_DIRECTIVE_HISTORY record with the complete
1966 llvm::BitstreamEntry Entry =
1967 Cursor.advance(BitstreamCursor::AF_DontPopBlockAtEnd);
1968 if (Entry.Kind != llvm::BitstreamEntry::Record) {
1969 Error("malformed block record in AST file");
1974 switch ((PreprocessorRecordTypes)Cursor.readRecord(Entry.ID, Record)) {
1975 case PP_MACRO_DIRECTIVE_HISTORY:
1978 case PP_MODULE_MACRO: {
1979 ModuleMacros.push_back(ModuleMacroRecord());
1980 auto &Info = ModuleMacros.back();
1981 Info.SubModID = getGlobalSubmoduleID(M, Record[0]);
1982 Info.MI = getMacro(getGlobalMacroID(M, Record[1]));
1983 for (int I = 2, N = Record.size(); I != N; ++I)
1984 Info.Overrides.push_back(getGlobalSubmoduleID(M, Record[I]));
1989 Error("malformed block record in AST file");
1993 // We found the macro directive history; that's the last record
1998 // Module macros are listed in reverse dependency order.
2000 std::reverse(ModuleMacros.begin(), ModuleMacros.end());
2001 llvm::SmallVector<ModuleMacro*, 8> Overrides;
2002 for (auto &MMR : ModuleMacros) {
2004 for (unsigned ModID : MMR.Overrides) {
2005 Module *Mod = getSubmodule(ModID);
2006 auto *Macro = PP.getModuleMacro(Mod, II);
2007 assert(Macro && "missing definition for overridden macro");
2008 Overrides.push_back(Macro);
2011 bool Inserted = false;
2012 Module *Owner = getSubmodule(MMR.SubModID);
2013 PP.addModuleMacro(Owner, II, MMR.MI, Overrides, Inserted);
2017 // Don't read the directive history for a module; we don't have anywhere
2022 // Deserialize the macro directives history in reverse source-order.
2023 MacroDirective *Latest = nullptr, *Earliest = nullptr;
2024 unsigned Idx = 0, N = Record.size();
2026 MacroDirective *MD = nullptr;
2027 SourceLocation Loc = ReadSourceLocation(M, Record, Idx);
2028 MacroDirective::Kind K = (MacroDirective::Kind)Record[Idx++];
2030 case MacroDirective::MD_Define: {
2031 MacroInfo *MI = getMacro(getGlobalMacroID(M, Record[Idx++]));
2032 MD = PP.AllocateDefMacroDirective(MI, Loc);
2035 case MacroDirective::MD_Undefine:
2036 MD = PP.AllocateUndefMacroDirective(Loc);
2038 case MacroDirective::MD_Visibility:
2039 bool isPublic = Record[Idx++];
2040 MD = PP.AllocateVisibilityMacroDirective(Loc, isPublic);
2047 Earliest->setPrevious(MD);
2052 PP.setLoadedMacroDirective(II, Earliest, Latest);
2055 ASTReader::InputFileInfo
2056 ASTReader::readInputFileInfo(ModuleFile &F, unsigned ID) {
2057 // Go find this input file.
2058 BitstreamCursor &Cursor = F.InputFilesCursor;
2059 SavedStreamPosition SavedPosition(Cursor);
2060 Cursor.JumpToBit(F.InputFileOffsets[ID-1]);
2062 unsigned Code = Cursor.ReadCode();
2066 unsigned Result = Cursor.readRecord(Code, Record, &Blob);
2067 assert(static_cast<InputFileRecordTypes>(Result) == INPUT_FILE &&
2068 "invalid record type for input file");
2071 assert(Record[0] == ID && "Bogus stored ID or offset");
2073 R.StoredSize = static_cast<off_t>(Record[1]);
2074 R.StoredTime = static_cast<time_t>(Record[2]);
2075 R.Overridden = static_cast<bool>(Record[3]);
2076 R.Transient = static_cast<bool>(Record[4]);
2077 R.TopLevelModuleMap = static_cast<bool>(Record[5]);
2079 ResolveImportedPath(F, R.Filename);
2083 static unsigned moduleKindForDiagnostic(ModuleKind Kind);
2084 InputFile ASTReader::getInputFile(ModuleFile &F, unsigned ID, bool Complain) {
2085 // If this ID is bogus, just return an empty input file.
2086 if (ID == 0 || ID > F.InputFilesLoaded.size())
2089 // If we've already loaded this input file, return it.
2090 if (F.InputFilesLoaded[ID-1].getFile())
2091 return F.InputFilesLoaded[ID-1];
2093 if (F.InputFilesLoaded[ID-1].isNotFound())
2096 // Go find this input file.
2097 BitstreamCursor &Cursor = F.InputFilesCursor;
2098 SavedStreamPosition SavedPosition(Cursor);
2099 Cursor.JumpToBit(F.InputFileOffsets[ID-1]);
2101 InputFileInfo FI = readInputFileInfo(F, ID);
2102 off_t StoredSize = FI.StoredSize;
2103 time_t StoredTime = FI.StoredTime;
2104 bool Overridden = FI.Overridden;
2105 bool Transient = FI.Transient;
2106 StringRef Filename = FI.Filename;
2108 const FileEntry *File = FileMgr.getFile(Filename, /*OpenFile=*/false);
2109 // If we didn't find the file, resolve it relative to the
2110 // original directory from which this AST file was created.
2111 if (File == nullptr && !F.OriginalDir.empty() && !F.BaseDirectory.empty() &&
2112 F.OriginalDir != F.BaseDirectory) {
2113 std::string Resolved = resolveFileRelativeToOriginalDir(
2114 Filename, F.OriginalDir, F.BaseDirectory);
2115 if (!Resolved.empty())
2116 File = FileMgr.getFile(Resolved);
2119 // For an overridden file, create a virtual file with the stored
2121 if ((Overridden || Transient) && File == nullptr)
2122 File = FileMgr.getVirtualFile(Filename, StoredSize, StoredTime);
2124 if (File == nullptr) {
2126 std::string ErrorStr = "could not find file '";
2127 ErrorStr += Filename;
2128 ErrorStr += "' referenced by AST file '";
2129 ErrorStr += F.FileName;
2133 // Record that we didn't find the file.
2134 F.InputFilesLoaded[ID-1] = InputFile::getNotFound();
2138 // Check if there was a request to override the contents of the file
2139 // that was part of the precompiled header. Overridding such a file
2140 // can lead to problems when lexing using the source locations from the
2142 SourceManager &SM = getSourceManager();
2143 // FIXME: Reject if the overrides are different.
2144 if ((!Overridden && !Transient) && SM.isFileOverridden(File)) {
2146 Error(diag::err_fe_pch_file_overridden, Filename);
2147 // After emitting the diagnostic, recover by disabling the override so
2148 // that the original file will be used.
2150 // FIXME: This recovery is just as broken as the original state; there may
2151 // be another precompiled module that's using the overridden contents, or
2152 // we might be half way through parsing it. Instead, we should treat the
2153 // overridden contents as belonging to a separate FileEntry.
2154 SM.disableFileContentsOverride(File);
2155 // The FileEntry is a virtual file entry with the size of the contents
2156 // that would override the original contents. Set it to the original's
2158 FileMgr.modifyFileEntry(const_cast<FileEntry*>(File),
2159 StoredSize, StoredTime);
2162 bool IsOutOfDate = false;
2164 // For an overridden file, there is nothing to validate.
2165 if (!Overridden && //
2166 (StoredSize != File->getSize() ||
2167 (StoredTime && StoredTime != File->getModificationTime() &&
2171 // Build a list of the PCH imports that got us here (in reverse).
2172 SmallVector<ModuleFile *, 4> ImportStack(1, &F);
2173 while (!ImportStack.back()->ImportedBy.empty())
2174 ImportStack.push_back(ImportStack.back()->ImportedBy[0]);
2176 // The top-level PCH is stale.
2177 StringRef TopLevelPCHName(ImportStack.back()->FileName);
2178 unsigned DiagnosticKind = moduleKindForDiagnostic(ImportStack.back()->Kind);
2179 if (DiagnosticKind == 0)
2180 Error(diag::err_fe_pch_file_modified, Filename, TopLevelPCHName);
2181 else if (DiagnosticKind == 1)
2182 Error(diag::err_fe_module_file_modified, Filename, TopLevelPCHName);
2184 Error(diag::err_fe_ast_file_modified, Filename, TopLevelPCHName);
2186 // Print the import stack.
2187 if (ImportStack.size() > 1 && !Diags.isDiagnosticInFlight()) {
2188 Diag(diag::note_pch_required_by)
2189 << Filename << ImportStack[0]->FileName;
2190 for (unsigned I = 1; I < ImportStack.size(); ++I)
2191 Diag(diag::note_pch_required_by)
2192 << ImportStack[I-1]->FileName << ImportStack[I]->FileName;
2195 if (!Diags.isDiagnosticInFlight())
2196 Diag(diag::note_pch_rebuild_required) << TopLevelPCHName;
2201 // FIXME: If the file is overridden and we've already opened it,
2202 // issue an error (or split it into a separate FileEntry).
2204 InputFile IF = InputFile(File, Overridden || Transient, IsOutOfDate);
2206 // Note that we've loaded this input file.
2207 F.InputFilesLoaded[ID-1] = IF;
2211 /// \brief If we are loading a relocatable PCH or module file, and the filename
2212 /// is not an absolute path, add the system or module root to the beginning of
2214 void ASTReader::ResolveImportedPath(ModuleFile &M, std::string &Filename) {
2215 // Resolve relative to the base directory, if we have one.
2216 if (!M.BaseDirectory.empty())
2217 return ResolveImportedPath(Filename, M.BaseDirectory);
2220 void ASTReader::ResolveImportedPath(std::string &Filename, StringRef Prefix) {
2221 if (Filename.empty() || llvm::sys::path::is_absolute(Filename))
2224 SmallString<128> Buffer;
2225 llvm::sys::path::append(Buffer, Prefix, Filename);
2226 Filename.assign(Buffer.begin(), Buffer.end());
2229 static bool isDiagnosedResult(ASTReader::ASTReadResult ARR, unsigned Caps) {
2231 case ASTReader::Failure: return true;
2232 case ASTReader::Missing: return !(Caps & ASTReader::ARR_Missing);
2233 case ASTReader::OutOfDate: return !(Caps & ASTReader::ARR_OutOfDate);
2234 case ASTReader::VersionMismatch: return !(Caps & ASTReader::ARR_VersionMismatch);
2235 case ASTReader::ConfigurationMismatch:
2236 return !(Caps & ASTReader::ARR_ConfigurationMismatch);
2237 case ASTReader::HadErrors: return true;
2238 case ASTReader::Success: return false;
2241 llvm_unreachable("unknown ASTReadResult");
2244 ASTReader::ASTReadResult ASTReader::ReadOptionsBlock(
2245 BitstreamCursor &Stream, unsigned ClientLoadCapabilities,
2246 bool AllowCompatibleConfigurationMismatch, ASTReaderListener &Listener,
2247 std::string &SuggestedPredefines) {
2248 if (Stream.EnterSubBlock(OPTIONS_BLOCK_ID))
2251 // Read all of the records in the options block.
2253 ASTReadResult Result = Success;
2255 llvm::BitstreamEntry Entry = Stream.advance();
2257 switch (Entry.Kind) {
2258 case llvm::BitstreamEntry::Error:
2259 case llvm::BitstreamEntry::SubBlock:
2262 case llvm::BitstreamEntry::EndBlock:
2265 case llvm::BitstreamEntry::Record:
2266 // The interesting case.
2270 // Read and process a record.
2272 switch ((OptionsRecordTypes)Stream.readRecord(Entry.ID, Record)) {
2273 case LANGUAGE_OPTIONS: {
2274 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2275 if (ParseLanguageOptions(Record, Complain, Listener,
2276 AllowCompatibleConfigurationMismatch))
2277 Result = ConfigurationMismatch;
2281 case TARGET_OPTIONS: {
2282 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2283 if (ParseTargetOptions(Record, Complain, Listener,
2284 AllowCompatibleConfigurationMismatch))
2285 Result = ConfigurationMismatch;
2289 case FILE_SYSTEM_OPTIONS: {
2290 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2291 if (!AllowCompatibleConfigurationMismatch &&
2292 ParseFileSystemOptions(Record, Complain, Listener))
2293 Result = ConfigurationMismatch;
2297 case HEADER_SEARCH_OPTIONS: {
2298 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2299 if (!AllowCompatibleConfigurationMismatch &&
2300 ParseHeaderSearchOptions(Record, Complain, Listener))
2301 Result = ConfigurationMismatch;
2305 case PREPROCESSOR_OPTIONS:
2306 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2307 if (!AllowCompatibleConfigurationMismatch &&
2308 ParsePreprocessorOptions(Record, Complain, Listener,
2309 SuggestedPredefines))
2310 Result = ConfigurationMismatch;
2316 ASTReader::ASTReadResult
2317 ASTReader::ReadControlBlock(ModuleFile &F,
2318 SmallVectorImpl<ImportedModule> &Loaded,
2319 const ModuleFile *ImportedBy,
2320 unsigned ClientLoadCapabilities) {
2321 BitstreamCursor &Stream = F.Stream;
2322 ASTReadResult Result = Success;
2324 if (Stream.EnterSubBlock(CONTROL_BLOCK_ID)) {
2325 Error("malformed block record in AST file");
2329 // Lambda to read the unhashed control block the first time it's called.
2331 // For PCM files, the unhashed control block cannot be read until after the
2332 // MODULE_NAME record. However, PCH files have no MODULE_NAME, and yet still
2333 // need to look ahead before reading the IMPORTS record. For consistency,
2334 // this block is always read somehow (see BitstreamEntry::EndBlock).
2335 bool HasReadUnhashedControlBlock = false;
2336 auto readUnhashedControlBlockOnce = [&]() {
2337 if (!HasReadUnhashedControlBlock) {
2338 HasReadUnhashedControlBlock = true;
2339 if (ASTReadResult Result =
2340 readUnhashedControlBlock(F, ImportedBy, ClientLoadCapabilities))
2346 // Read all of the records and blocks in the control block.
2348 unsigned NumInputs = 0;
2349 unsigned NumUserInputs = 0;
2351 llvm::BitstreamEntry Entry = Stream.advance();
2353 switch (Entry.Kind) {
2354 case llvm::BitstreamEntry::Error:
2355 Error("malformed block record in AST file");
2357 case llvm::BitstreamEntry::EndBlock: {
2358 // Validate the module before returning. This call catches an AST with
2359 // no module name and no imports.
2360 if (ASTReadResult Result = readUnhashedControlBlockOnce())
2363 // Validate input files.
2364 const HeaderSearchOptions &HSOpts =
2365 PP.getHeaderSearchInfo().getHeaderSearchOpts();
2367 // All user input files reside at the index range [0, NumUserInputs), and
2368 // system input files reside at [NumUserInputs, NumInputs). For explicitly
2369 // loaded module files, ignore missing inputs.
2370 if (!DisableValidation && F.Kind != MK_ExplicitModule &&
2371 F.Kind != MK_PrebuiltModule) {
2372 bool Complain = (ClientLoadCapabilities & ARR_OutOfDate) == 0;
2374 // If we are reading a module, we will create a verification timestamp,
2375 // so we verify all input files. Otherwise, verify only user input
2378 unsigned N = NumUserInputs;
2379 if (ValidateSystemInputs ||
2380 (HSOpts.ModulesValidateOncePerBuildSession &&
2381 F.InputFilesValidationTimestamp <= HSOpts.BuildSessionTimestamp &&
2382 F.Kind == MK_ImplicitModule))
2385 for (unsigned I = 0; I < N; ++I) {
2386 InputFile IF = getInputFile(F, I+1, Complain);
2387 if (!IF.getFile() || IF.isOutOfDate())
2393 Listener->visitModuleFile(F.FileName, F.Kind);
2395 if (Listener && Listener->needsInputFileVisitation()) {
2396 unsigned N = Listener->needsSystemInputFileVisitation() ? NumInputs
2398 for (unsigned I = 0; I < N; ++I) {
2399 bool IsSystem = I >= NumUserInputs;
2400 InputFileInfo FI = readInputFileInfo(F, I+1);
2401 Listener->visitInputFile(FI.Filename, IsSystem, FI.Overridden,
2402 F.Kind == MK_ExplicitModule ||
2403 F.Kind == MK_PrebuiltModule);
2410 case llvm::BitstreamEntry::SubBlock:
2412 case INPUT_FILES_BLOCK_ID:
2413 F.InputFilesCursor = Stream;
2414 if (Stream.SkipBlock() || // Skip with the main cursor
2415 // Read the abbreviations
2416 ReadBlockAbbrevs(F.InputFilesCursor, INPUT_FILES_BLOCK_ID)) {
2417 Error("malformed block record in AST file");
2422 case OPTIONS_BLOCK_ID:
2423 // If we're reading the first module for this group, check its options
2424 // are compatible with ours. For modules it imports, no further checking
2425 // is required, because we checked them when we built it.
2426 if (Listener && !ImportedBy) {
2427 // Should we allow the configuration of the module file to differ from
2428 // the configuration of the current translation unit in a compatible
2431 // FIXME: Allow this for files explicitly specified with -include-pch.
2432 bool AllowCompatibleConfigurationMismatch =
2433 F.Kind == MK_ExplicitModule || F.Kind == MK_PrebuiltModule;
2435 Result = ReadOptionsBlock(Stream, ClientLoadCapabilities,
2436 AllowCompatibleConfigurationMismatch,
2437 *Listener, SuggestedPredefines);
2438 if (Result == Failure) {
2439 Error("malformed block record in AST file");
2443 if (DisableValidation ||
2444 (AllowConfigurationMismatch && Result == ConfigurationMismatch))
2447 // If we can't load the module, exit early since we likely
2448 // will rebuild the module anyway. The stream may be in the
2449 // middle of a block.
2450 if (Result != Success)
2452 } else if (Stream.SkipBlock()) {
2453 Error("malformed block record in AST file");
2459 if (Stream.SkipBlock()) {
2460 Error("malformed block record in AST file");
2466 case llvm::BitstreamEntry::Record:
2467 // The interesting case.
2471 // Read and process a record.
2474 switch ((ControlRecordTypes)Stream.readRecord(Entry.ID, Record, &Blob)) {
2476 if (Record[0] != VERSION_MAJOR && !DisableValidation) {
2477 if ((ClientLoadCapabilities & ARR_VersionMismatch) == 0)
2478 Diag(Record[0] < VERSION_MAJOR? diag::err_pch_version_too_old
2479 : diag::err_pch_version_too_new);
2480 return VersionMismatch;
2483 bool hasErrors = Record[6];
2484 if (hasErrors && !DisableValidation && !AllowASTWithCompilerErrors) {
2485 Diag(diag::err_pch_with_compiler_errors);
2489 Diags.ErrorOccurred = true;
2490 Diags.UncompilableErrorOccurred = true;
2491 Diags.UnrecoverableErrorOccurred = true;
2494 F.RelocatablePCH = Record[4];
2495 // Relative paths in a relocatable PCH are relative to our sysroot.
2496 if (F.RelocatablePCH)
2497 F.BaseDirectory = isysroot.empty() ? "/" : isysroot;
2499 F.HasTimestamps = Record[5];
2501 const std::string &CurBranch = getClangFullRepositoryVersion();
2502 StringRef ASTBranch = Blob;
2503 if (StringRef(CurBranch) != ASTBranch && !DisableValidation) {
2504 if ((ClientLoadCapabilities & ARR_VersionMismatch) == 0)
2505 Diag(diag::err_pch_different_branch) << ASTBranch << CurBranch;
2506 return VersionMismatch;
2512 // Validate the AST before processing any imports (otherwise, untangling
2513 // them can be error-prone and expensive). A module will have a name and
2514 // will already have been validated, but this catches the PCH case.
2515 if (ASTReadResult Result = readUnhashedControlBlockOnce())
2518 // Load each of the imported PCH files.
2519 unsigned Idx = 0, N = Record.size();
2521 // Read information about the AST file.
2522 ModuleKind ImportedKind = (ModuleKind)Record[Idx++];
2523 // The import location will be the local one for now; we will adjust
2524 // all import locations of module imports after the global source
2525 // location info are setup, in ReadAST.
2526 SourceLocation ImportLoc =
2527 ReadUntranslatedSourceLocation(Record[Idx++]);
2528 off_t StoredSize = (off_t)Record[Idx++];
2529 time_t StoredModTime = (time_t)Record[Idx++];
2530 ASTFileSignature StoredSignature = {
2531 {{(uint32_t)Record[Idx++], (uint32_t)Record[Idx++],
2532 (uint32_t)Record[Idx++], (uint32_t)Record[Idx++],
2533 (uint32_t)Record[Idx++]}}};
2535 std::string ImportedName = ReadString(Record, Idx);
2536 std::string ImportedFile;
2538 // For prebuilt and explicit modules first consult the file map for
2539 // an override. Note that here we don't search prebuilt module
2540 // directories, only the explicit name to file mappings. Also, we will
2541 // still verify the size/signature making sure it is essentially the
2542 // same file but perhaps in a different location.
2543 if (ImportedKind == MK_PrebuiltModule || ImportedKind == MK_ExplicitModule)
2544 ImportedFile = PP.getHeaderSearchInfo().getPrebuiltModuleFileName(
2545 ImportedName, /*FileMapOnly*/ true);
2547 if (ImportedFile.empty())
2548 ImportedFile = ReadPath(F, Record, Idx);
2550 SkipPath(Record, Idx);
2552 // If our client can't cope with us being out of date, we can't cope with
2553 // our dependency being missing.
2554 unsigned Capabilities = ClientLoadCapabilities;
2555 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
2556 Capabilities &= ~ARR_Missing;
2558 // Load the AST file.
2559 auto Result = ReadASTCore(ImportedFile, ImportedKind, ImportLoc, &F,
2560 Loaded, StoredSize, StoredModTime,
2561 StoredSignature, Capabilities);
2563 // If we diagnosed a problem, produce a backtrace.
2564 if (isDiagnosedResult(Result, Capabilities))
2565 Diag(diag::note_module_file_imported_by)
2566 << F.FileName << !F.ModuleName.empty() << F.ModuleName;
2569 case Failure: return Failure;
2570 // If we have to ignore the dependency, we'll have to ignore this too.
2572 case OutOfDate: return OutOfDate;
2573 case VersionMismatch: return VersionMismatch;
2574 case ConfigurationMismatch: return ConfigurationMismatch;
2575 case HadErrors: return HadErrors;
2576 case Success: break;
2583 F.OriginalSourceFileID = FileID::get(Record[0]);
2584 F.ActualOriginalSourceFileName = Blob;
2585 F.OriginalSourceFileName = F.ActualOriginalSourceFileName;
2586 ResolveImportedPath(F, F.OriginalSourceFileName);
2589 case ORIGINAL_FILE_ID:
2590 F.OriginalSourceFileID = FileID::get(Record[0]);
2593 case ORIGINAL_PCH_DIR:
2594 F.OriginalDir = Blob;
2598 F.ModuleName = Blob;
2600 Listener->ReadModuleName(F.ModuleName);
2602 // Validate the AST as soon as we have a name so we can exit early on
2604 if (ASTReadResult Result = readUnhashedControlBlockOnce())
2609 case MODULE_DIRECTORY: {
2610 assert(!F.ModuleName.empty() &&
2611 "MODULE_DIRECTORY found before MODULE_NAME");
2612 // If we've already loaded a module map file covering this module, we may
2613 // have a better path for it (relative to the current build).
2614 Module *M = PP.getHeaderSearchInfo().lookupModule(F.ModuleName);
2615 if (M && M->Directory) {
2616 // If we're implicitly loading a module, the base directory can't
2617 // change between the build and use.
2618 if (F.Kind != MK_ExplicitModule && F.Kind != MK_PrebuiltModule) {
2619 const DirectoryEntry *BuildDir =
2620 PP.getFileManager().getDirectory(Blob);
2621 if (!BuildDir || BuildDir != M->Directory) {
2622 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
2623 Diag(diag::err_imported_module_relocated)
2624 << F.ModuleName << Blob << M->Directory->getName();
2628 F.BaseDirectory = M->Directory->getName();
2630 F.BaseDirectory = Blob;
2635 case MODULE_MAP_FILE:
2636 if (ASTReadResult Result =
2637 ReadModuleMapFileBlock(Record, F, ImportedBy, ClientLoadCapabilities))
2641 case INPUT_FILE_OFFSETS:
2642 NumInputs = Record[0];
2643 NumUserInputs = Record[1];
2644 F.InputFileOffsets =
2645 (const llvm::support::unaligned_uint64_t *)Blob.data();
2646 F.InputFilesLoaded.resize(NumInputs);
2647 F.NumUserInputFiles = NumUserInputs;
2653 ASTReader::ASTReadResult
2654 ASTReader::ReadASTBlock(ModuleFile &F, unsigned ClientLoadCapabilities) {
2655 BitstreamCursor &Stream = F.Stream;
2657 if (Stream.EnterSubBlock(AST_BLOCK_ID)) {
2658 Error("malformed block record in AST file");
2662 // Read all of the records and blocks for the AST file.
2665 llvm::BitstreamEntry Entry = Stream.advance();
2667 switch (Entry.Kind) {
2668 case llvm::BitstreamEntry::Error:
2669 Error("error at end of module block in AST file");
2671 case llvm::BitstreamEntry::EndBlock:
2672 // Outside of C++, we do not store a lookup map for the translation unit.
2673 // Instead, mark it as needing a lookup map to be built if this module
2674 // contains any declarations lexically within it (which it always does!).
2675 // This usually has no cost, since we very rarely need the lookup map for
2676 // the translation unit outside C++.
2677 if (ASTContext *Ctx = ContextObj) {
2678 DeclContext *DC = Ctx->getTranslationUnitDecl();
2679 if (DC->hasExternalLexicalStorage() && !Ctx->getLangOpts().CPlusPlus)
2680 DC->setMustBuildLookupTable();
2684 case llvm::BitstreamEntry::SubBlock:
2686 case DECLTYPES_BLOCK_ID:
2687 // We lazily load the decls block, but we want to set up the
2688 // DeclsCursor cursor to point into it. Clone our current bitcode
2689 // cursor to it, enter the block and read the abbrevs in that block.
2690 // With the main cursor, we just skip over it.
2691 F.DeclsCursor = Stream;
2692 if (Stream.SkipBlock() || // Skip with the main cursor.
2693 // Read the abbrevs.
2694 ReadBlockAbbrevs(F.DeclsCursor, DECLTYPES_BLOCK_ID)) {
2695 Error("malformed block record in AST file");
2700 case PREPROCESSOR_BLOCK_ID:
2701 F.MacroCursor = Stream;
2702 if (!PP.getExternalSource())
2703 PP.setExternalSource(this);
2705 if (Stream.SkipBlock() ||
2706 ReadBlockAbbrevs(F.MacroCursor, PREPROCESSOR_BLOCK_ID)) {
2707 Error("malformed block record in AST file");
2710 F.MacroStartOffset = F.MacroCursor.GetCurrentBitNo();
2713 case PREPROCESSOR_DETAIL_BLOCK_ID:
2714 F.PreprocessorDetailCursor = Stream;
2715 if (Stream.SkipBlock() ||
2716 ReadBlockAbbrevs(F.PreprocessorDetailCursor,
2717 PREPROCESSOR_DETAIL_BLOCK_ID)) {
2718 Error("malformed preprocessor detail record in AST file");
2721 F.PreprocessorDetailStartOffset
2722 = F.PreprocessorDetailCursor.GetCurrentBitNo();
2724 if (!PP.getPreprocessingRecord())
2725 PP.createPreprocessingRecord();
2726 if (!PP.getPreprocessingRecord()->getExternalSource())
2727 PP.getPreprocessingRecord()->SetExternalSource(*this);
2730 case SOURCE_MANAGER_BLOCK_ID:
2731 if (ReadSourceManagerBlock(F))
2735 case SUBMODULE_BLOCK_ID:
2736 if (ASTReadResult Result =
2737 ReadSubmoduleBlock(F, ClientLoadCapabilities))
2741 case COMMENTS_BLOCK_ID: {
2742 BitstreamCursor C = Stream;
2743 if (Stream.SkipBlock() ||
2744 ReadBlockAbbrevs(C, COMMENTS_BLOCK_ID)) {
2745 Error("malformed comments block in AST file");
2748 CommentsCursors.push_back(std::make_pair(C, &F));
2753 if (Stream.SkipBlock()) {
2754 Error("malformed block record in AST file");
2761 case llvm::BitstreamEntry::Record:
2762 // The interesting case.
2766 // Read and process a record.
2770 (ASTRecordTypes)Stream.readRecord(Entry.ID, Record, &Blob);
2772 // If we're not loading an AST context, we don't care about most records.
2774 switch (RecordType) {
2775 case IDENTIFIER_TABLE:
2776 case IDENTIFIER_OFFSET:
2777 case INTERESTING_IDENTIFIERS:
2779 case PP_CONDITIONAL_STACK:
2780 case PP_COUNTER_VALUE:
2781 case SOURCE_LOCATION_OFFSETS:
2782 case MODULE_OFFSET_MAP:
2783 case SOURCE_MANAGER_LINE_TABLE:
2784 case SOURCE_LOCATION_PRELOADS:
2785 case PPD_ENTITIES_OFFSETS:
2786 case HEADER_SEARCH_TABLE:
2787 case IMPORTED_MODULES:
2795 switch (RecordType) {
2796 default: // Default behavior: ignore.
2800 if (F.LocalNumTypes != 0) {
2801 Error("duplicate TYPE_OFFSET record in AST file");
2804 F.TypeOffsets = (const uint32_t *)Blob.data();
2805 F.LocalNumTypes = Record[0];
2806 unsigned LocalBaseTypeIndex = Record[1];
2807 F.BaseTypeIndex = getTotalNumTypes();
2809 if (F.LocalNumTypes > 0) {
2810 // Introduce the global -> local mapping for types within this module.
2811 GlobalTypeMap.insert(std::make_pair(getTotalNumTypes(), &F));
2813 // Introduce the local -> global mapping for types within this module.
2814 F.TypeRemap.insertOrReplace(
2815 std::make_pair(LocalBaseTypeIndex,
2816 F.BaseTypeIndex - LocalBaseTypeIndex));
2818 TypesLoaded.resize(TypesLoaded.size() + F.LocalNumTypes);
2824 if (F.LocalNumDecls != 0) {
2825 Error("duplicate DECL_OFFSET record in AST file");
2828 F.DeclOffsets = (const DeclOffset *)Blob.data();
2829 F.LocalNumDecls = Record[0];
2830 unsigned LocalBaseDeclID = Record[1];
2831 F.BaseDeclID = getTotalNumDecls();
2833 if (F.LocalNumDecls > 0) {
2834 // Introduce the global -> local mapping for declarations within this
2836 GlobalDeclMap.insert(
2837 std::make_pair(getTotalNumDecls() + NUM_PREDEF_DECL_IDS, &F));
2839 // Introduce the local -> global mapping for declarations within this
2841 F.DeclRemap.insertOrReplace(
2842 std::make_pair(LocalBaseDeclID, F.BaseDeclID - LocalBaseDeclID));
2844 // Introduce the global -> local mapping for declarations within this
2846 F.GlobalToLocalDeclIDs[&F] = LocalBaseDeclID;
2848 DeclsLoaded.resize(DeclsLoaded.size() + F.LocalNumDecls);
2853 case TU_UPDATE_LEXICAL: {
2854 DeclContext *TU = ContextObj->getTranslationUnitDecl();
2855 LexicalContents Contents(
2856 reinterpret_cast<const llvm::support::unaligned_uint32_t *>(
2858 static_cast<unsigned int>(Blob.size() / 4));
2859 TULexicalDecls.push_back(std::make_pair(&F, Contents));
2860 TU->setHasExternalLexicalStorage(true);
2864 case UPDATE_VISIBLE: {
2866 serialization::DeclID ID = ReadDeclID(F, Record, Idx);
2867 auto *Data = (const unsigned char*)Blob.data();
2868 PendingVisibleUpdates[ID].push_back(PendingVisibleUpdate{&F, Data});
2869 // If we've already loaded the decl, perform the updates when we finish
2870 // loading this block.
2871 if (Decl *D = GetExistingDecl(ID))
2872 PendingUpdateRecords.push_back(
2873 PendingUpdateRecord(ID, D, /*JustLoaded=*/false));
2877 case IDENTIFIER_TABLE:
2878 F.IdentifierTableData = Blob.data();
2880 F.IdentifierLookupTable = ASTIdentifierLookupTable::Create(
2881 (const unsigned char *)F.IdentifierTableData + Record[0],
2882 (const unsigned char *)F.IdentifierTableData + sizeof(uint32_t),
2883 (const unsigned char *)F.IdentifierTableData,
2884 ASTIdentifierLookupTrait(*this, F));
2886 PP.getIdentifierTable().setExternalIdentifierLookup(this);
2890 case IDENTIFIER_OFFSET: {
2891 if (F.LocalNumIdentifiers != 0) {
2892 Error("duplicate IDENTIFIER_OFFSET record in AST file");
2895 F.IdentifierOffsets = (const uint32_t *)Blob.data();
2896 F.LocalNumIdentifiers = Record[0];
2897 unsigned LocalBaseIdentifierID = Record[1];
2898 F.BaseIdentifierID = getTotalNumIdentifiers();
2900 if (F.LocalNumIdentifiers > 0) {
2901 // Introduce the global -> local mapping for identifiers within this
2903 GlobalIdentifierMap.insert(std::make_pair(getTotalNumIdentifiers() + 1,
2906 // Introduce the local -> global mapping for identifiers within this
2908 F.IdentifierRemap.insertOrReplace(
2909 std::make_pair(LocalBaseIdentifierID,
2910 F.BaseIdentifierID - LocalBaseIdentifierID));
2912 IdentifiersLoaded.resize(IdentifiersLoaded.size()
2913 + F.LocalNumIdentifiers);
2918 case INTERESTING_IDENTIFIERS:
2919 F.PreloadIdentifierOffsets.assign(Record.begin(), Record.end());
2922 case EAGERLY_DESERIALIZED_DECLS:
2923 // FIXME: Skip reading this record if our ASTConsumer doesn't care
2924 // about "interesting" decls (for instance, if we're building a module).
2925 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2926 EagerlyDeserializedDecls.push_back(getGlobalDeclID(F, Record[I]));
2929 case MODULAR_CODEGEN_DECLS:
2930 // FIXME: Skip reading this record if our ASTConsumer doesn't care about
2931 // them (ie: if we're not codegenerating this module).
2932 if (F.Kind == MK_MainFile)
2933 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2934 EagerlyDeserializedDecls.push_back(getGlobalDeclID(F, Record[I]));
2938 if (SpecialTypes.empty()) {
2939 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2940 SpecialTypes.push_back(getGlobalTypeID(F, Record[I]));
2944 if (SpecialTypes.size() != Record.size()) {
2945 Error("invalid special-types record");
2949 for (unsigned I = 0, N = Record.size(); I != N; ++I) {
2950 serialization::TypeID ID = getGlobalTypeID(F, Record[I]);
2951 if (!SpecialTypes[I])
2952 SpecialTypes[I] = ID;
2953 // FIXME: If ID && SpecialTypes[I] != ID, do we need a separate
2959 TotalNumStatements += Record[0];
2960 TotalNumMacros += Record[1];
2961 TotalLexicalDeclContexts += Record[2];
2962 TotalVisibleDeclContexts += Record[3];
2965 case UNUSED_FILESCOPED_DECLS:
2966 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2967 UnusedFileScopedDecls.push_back(getGlobalDeclID(F, Record[I]));
2970 case DELEGATING_CTORS:
2971 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2972 DelegatingCtorDecls.push_back(getGlobalDeclID(F, Record[I]));
2975 case WEAK_UNDECLARED_IDENTIFIERS:
2976 if (Record.size() % 4 != 0) {
2977 Error("invalid weak identifiers record");
2981 // FIXME: Ignore weak undeclared identifiers from non-original PCH
2982 // files. This isn't the way to do it :)
2983 WeakUndeclaredIdentifiers.clear();
2985 // Translate the weak, undeclared identifiers into global IDs.
2986 for (unsigned I = 0, N = Record.size(); I < N; /* in loop */) {
2987 WeakUndeclaredIdentifiers.push_back(
2988 getGlobalIdentifierID(F, Record[I++]));
2989 WeakUndeclaredIdentifiers.push_back(
2990 getGlobalIdentifierID(F, Record[I++]));
2991 WeakUndeclaredIdentifiers.push_back(
2992 ReadSourceLocation(F, Record, I).getRawEncoding());
2993 WeakUndeclaredIdentifiers.push_back(Record[I++]);
2997 case SELECTOR_OFFSETS: {
2998 F.SelectorOffsets = (const uint32_t *)Blob.data();
2999 F.LocalNumSelectors = Record[0];
3000 unsigned LocalBaseSelectorID = Record[1];
3001 F.BaseSelectorID = getTotalNumSelectors();
3003 if (F.LocalNumSelectors > 0) {
3004 // Introduce the global -> local mapping for selectors within this
3006 GlobalSelectorMap.insert(std::make_pair(getTotalNumSelectors()+1, &F));
3008 // Introduce the local -> global mapping for selectors within this
3010 F.SelectorRemap.insertOrReplace(
3011 std::make_pair(LocalBaseSelectorID,
3012 F.BaseSelectorID - LocalBaseSelectorID));
3014 SelectorsLoaded.resize(SelectorsLoaded.size() + F.LocalNumSelectors);
3020 F.SelectorLookupTableData = (const unsigned char *)Blob.data();
3022 F.SelectorLookupTable
3023 = ASTSelectorLookupTable::Create(
3024 F.SelectorLookupTableData + Record[0],
3025 F.SelectorLookupTableData,
3026 ASTSelectorLookupTrait(*this, F));
3027 TotalNumMethodPoolEntries += Record[1];
3030 case REFERENCED_SELECTOR_POOL:
3031 if (!Record.empty()) {
3032 for (unsigned Idx = 0, N = Record.size() - 1; Idx < N; /* in loop */) {
3033 ReferencedSelectorsData.push_back(getGlobalSelectorID(F,
3035 ReferencedSelectorsData.push_back(ReadSourceLocation(F, Record, Idx).
3041 case PP_CONDITIONAL_STACK:
3042 if (!Record.empty()) {
3043 unsigned Idx = 0, End = Record.size() - 1;
3044 bool ReachedEOFWhileSkipping = Record[Idx++];
3045 llvm::Optional<Preprocessor::PreambleSkipInfo> SkipInfo;
3046 if (ReachedEOFWhileSkipping) {
3047 SourceLocation HashToken = ReadSourceLocation(F, Record, Idx);
3048 SourceLocation IfTokenLoc = ReadSourceLocation(F, Record, Idx);
3049 bool FoundNonSkipPortion = Record[Idx++];
3050 bool FoundElse = Record[Idx++];
3051 SourceLocation ElseLoc = ReadSourceLocation(F, Record, Idx);
3052 SkipInfo.emplace(HashToken, IfTokenLoc, FoundNonSkipPortion,
3053 FoundElse, ElseLoc);
3055 SmallVector<PPConditionalInfo, 4> ConditionalStack;
3057 auto Loc = ReadSourceLocation(F, Record, Idx);
3058 bool WasSkipping = Record[Idx++];
3059 bool FoundNonSkip = Record[Idx++];
3060 bool FoundElse = Record[Idx++];
3061 ConditionalStack.push_back(
3062 {Loc, WasSkipping, FoundNonSkip, FoundElse});
3064 PP.setReplayablePreambleConditionalStack(ConditionalStack, SkipInfo);
3068 case PP_COUNTER_VALUE:
3069 if (!Record.empty() && Listener)
3070 Listener->ReadCounter(F, Record[0]);
3073 case FILE_SORTED_DECLS:
3074 F.FileSortedDecls = (const DeclID *)Blob.data();
3075 F.NumFileSortedDecls = Record[0];
3078 case SOURCE_LOCATION_OFFSETS: {
3079 F.SLocEntryOffsets = (const uint32_t *)Blob.data();
3080 F.LocalNumSLocEntries = Record[0];
3081 unsigned SLocSpaceSize = Record[1];
3082 std::tie(F.SLocEntryBaseID, F.SLocEntryBaseOffset) =
3083 SourceMgr.AllocateLoadedSLocEntries(F.LocalNumSLocEntries,
3085 if (!F.SLocEntryBaseID) {
3086 Error("ran out of source locations");
3089 // Make our entry in the range map. BaseID is negative and growing, so
3090 // we invert it. Because we invert it, though, we need the other end of
3092 unsigned RangeStart =
3093 unsigned(-F.SLocEntryBaseID) - F.LocalNumSLocEntries + 1;
3094 GlobalSLocEntryMap.insert(std::make_pair(RangeStart, &F));
3095 F.FirstLoc = SourceLocation::getFromRawEncoding(F.SLocEntryBaseOffset);
3097 // SLocEntryBaseOffset is lower than MaxLoadedOffset and decreasing.
3098 assert((F.SLocEntryBaseOffset & (1U << 31U)) == 0);
3099 GlobalSLocOffsetMap.insert(
3100 std::make_pair(SourceManager::MaxLoadedOffset - F.SLocEntryBaseOffset
3101 - SLocSpaceSize,&F));
3103 // Initialize the remapping table.
3104 // Invalid stays invalid.
3105 F.SLocRemap.insertOrReplace(std::make_pair(0U, 0));
3106 // This module. Base was 2 when being compiled.
3107 F.SLocRemap.insertOrReplace(std::make_pair(2U,
3108 static_cast<int>(F.SLocEntryBaseOffset - 2)));
3110 TotalNumSLocEntries += F.LocalNumSLocEntries;
3114 case MODULE_OFFSET_MAP:
3115 F.ModuleOffsetMap = Blob;
3118 case SOURCE_MANAGER_LINE_TABLE:
3119 if (ParseLineTable(F, Record))
3123 case SOURCE_LOCATION_PRELOADS: {
3124 // Need to transform from the local view (1-based IDs) to the global view,
3125 // which is based off F.SLocEntryBaseID.
3126 if (!F.PreloadSLocEntries.empty()) {
3127 Error("Multiple SOURCE_LOCATION_PRELOADS records in AST file");
3131 F.PreloadSLocEntries.swap(Record);
3135 case EXT_VECTOR_DECLS:
3136 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3137 ExtVectorDecls.push_back(getGlobalDeclID(F, Record[I]));
3141 if (Record.size() % 3 != 0) {
3142 Error("Invalid VTABLE_USES record");
3146 // Later tables overwrite earlier ones.
3147 // FIXME: Modules will have some trouble with this. This is clearly not
3148 // the right way to do this.
3151 for (unsigned Idx = 0, N = Record.size(); Idx != N; /* In loop */) {
3152 VTableUses.push_back(getGlobalDeclID(F, Record[Idx++]));
3153 VTableUses.push_back(
3154 ReadSourceLocation(F, Record, Idx).getRawEncoding());
3155 VTableUses.push_back(Record[Idx++]);
3159 case PENDING_IMPLICIT_INSTANTIATIONS:
3160 if (PendingInstantiations.size() % 2 != 0) {
3161 Error("Invalid existing PendingInstantiations");
3165 if (Record.size() % 2 != 0) {
3166 Error("Invalid PENDING_IMPLICIT_INSTANTIATIONS block");
3170 for (unsigned I = 0, N = Record.size(); I != N; /* in loop */) {
3171 PendingInstantiations.push_back(getGlobalDeclID(F, Record[I++]));
3172 PendingInstantiations.push_back(
3173 ReadSourceLocation(F, Record, I).getRawEncoding());
3177 case SEMA_DECL_REFS:
3178 if (Record.size() != 3) {
3179 Error("Invalid SEMA_DECL_REFS block");
3182 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3183 SemaDeclRefs.push_back(getGlobalDeclID(F, Record[I]));
3186 case PPD_ENTITIES_OFFSETS: {
3187 F.PreprocessedEntityOffsets = (const PPEntityOffset *)Blob.data();
3188 assert(Blob.size() % sizeof(PPEntityOffset) == 0);
3189 F.NumPreprocessedEntities = Blob.size() / sizeof(PPEntityOffset);
3191 unsigned LocalBasePreprocessedEntityID = Record[0];
3193 unsigned StartingID;
3194 if (!PP.getPreprocessingRecord())
3195 PP.createPreprocessingRecord();
3196 if (!PP.getPreprocessingRecord()->getExternalSource())
3197 PP.getPreprocessingRecord()->SetExternalSource(*this);
3199 = PP.getPreprocessingRecord()
3200 ->allocateLoadedEntities(F.NumPreprocessedEntities);
3201 F.BasePreprocessedEntityID = StartingID;
3203 if (F.NumPreprocessedEntities > 0) {
3204 // Introduce the global -> local mapping for preprocessed entities in
3206 GlobalPreprocessedEntityMap.insert(std::make_pair(StartingID, &F));
3208 // Introduce the local -> global mapping for preprocessed entities in
3210 F.PreprocessedEntityRemap.insertOrReplace(
3211 std::make_pair(LocalBasePreprocessedEntityID,
3212 F.BasePreprocessedEntityID - LocalBasePreprocessedEntityID));
3218 case DECL_UPDATE_OFFSETS:
3219 if (Record.size() % 2 != 0) {
3220 Error("invalid DECL_UPDATE_OFFSETS block in AST file");
3223 for (unsigned I = 0, N = Record.size(); I != N; I += 2) {
3224 GlobalDeclID ID = getGlobalDeclID(F, Record[I]);
3225 DeclUpdateOffsets[ID].push_back(std::make_pair(&F, Record[I + 1]));
3227 // If we've already loaded the decl, perform the updates when we finish
3228 // loading this block.
3229 if (Decl *D = GetExistingDecl(ID))
3230 PendingUpdateRecords.push_back(
3231 PendingUpdateRecord(ID, D, /*JustLoaded=*/false));
3235 case OBJC_CATEGORIES_MAP:
3236 if (F.LocalNumObjCCategoriesInMap != 0) {
3237 Error("duplicate OBJC_CATEGORIES_MAP record in AST file");
3241 F.LocalNumObjCCategoriesInMap = Record[0];
3242 F.ObjCCategoriesMap = (const ObjCCategoriesInfo *)Blob.data();
3245 case OBJC_CATEGORIES:
3246 F.ObjCCategories.swap(Record);
3249 case CUDA_SPECIAL_DECL_REFS:
3250 // Later tables overwrite earlier ones.
3251 // FIXME: Modules will have trouble with this.
3252 CUDASpecialDeclRefs.clear();
3253 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3254 CUDASpecialDeclRefs.push_back(getGlobalDeclID(F, Record[I]));
3257 case HEADER_SEARCH_TABLE:
3258 F.HeaderFileInfoTableData = Blob.data();
3259 F.LocalNumHeaderFileInfos = Record[1];
3261 F.HeaderFileInfoTable
3262 = HeaderFileInfoLookupTable::Create(
3263 (const unsigned char *)F.HeaderFileInfoTableData + Record[0],
3264 (const unsigned char *)F.HeaderFileInfoTableData,
3265 HeaderFileInfoTrait(*this, F,
3266 &PP.getHeaderSearchInfo(),
3267 Blob.data() + Record[2]));
3269 PP.getHeaderSearchInfo().SetExternalSource(this);
3270 if (!PP.getHeaderSearchInfo().getExternalLookup())
3271 PP.getHeaderSearchInfo().SetExternalLookup(this);
3275 case FP_PRAGMA_OPTIONS:
3276 // Later tables overwrite earlier ones.
3277 FPPragmaOptions.swap(Record);
3280 case OPENCL_EXTENSIONS:
3281 for (unsigned I = 0, E = Record.size(); I != E; ) {
3282 auto Name = ReadString(Record, I);
3283 auto &Opt = OpenCLExtensions.OptMap[Name];
3284 Opt.Supported = Record[I++] != 0;
3285 Opt.Enabled = Record[I++] != 0;
3286 Opt.Avail = Record[I++];
3287 Opt.Core = Record[I++];
3291 case OPENCL_EXTENSION_TYPES:
3292 for (unsigned I = 0, E = Record.size(); I != E;) {
3293 auto TypeID = static_cast<::TypeID>(Record[I++]);
3294 auto *Type = GetType(TypeID).getTypePtr();
3295 auto NumExt = static_cast<unsigned>(Record[I++]);
3296 for (unsigned II = 0; II != NumExt; ++II) {
3297 auto Ext = ReadString(Record, I);
3298 OpenCLTypeExtMap[Type].insert(Ext);
3303 case OPENCL_EXTENSION_DECLS:
3304 for (unsigned I = 0, E = Record.size(); I != E;) {
3305 auto DeclID = static_cast<::DeclID>(Record[I++]);
3306 auto *Decl = GetDecl(DeclID);
3307 auto NumExt = static_cast<unsigned>(Record[I++]);
3308 for (unsigned II = 0; II != NumExt; ++II) {
3309 auto Ext = ReadString(Record, I);
3310 OpenCLDeclExtMap[Decl].insert(Ext);
3315 case TENTATIVE_DEFINITIONS:
3316 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3317 TentativeDefinitions.push_back(getGlobalDeclID(F, Record[I]));
3320 case KNOWN_NAMESPACES:
3321 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3322 KnownNamespaces.push_back(getGlobalDeclID(F, Record[I]));
3325 case UNDEFINED_BUT_USED:
3326 if (UndefinedButUsed.size() % 2 != 0) {
3327 Error("Invalid existing UndefinedButUsed");
3331 if (Record.size() % 2 != 0) {
3332 Error("invalid undefined-but-used record");
3335 for (unsigned I = 0, N = Record.size(); I != N; /* in loop */) {
3336 UndefinedButUsed.push_back(getGlobalDeclID(F, Record[I++]));
3337 UndefinedButUsed.push_back(
3338 ReadSourceLocation(F, Record, I).getRawEncoding());
3342 case DELETE_EXPRS_TO_ANALYZE:
3343 for (unsigned I = 0, N = Record.size(); I != N;) {
3344 DelayedDeleteExprs.push_back(getGlobalDeclID(F, Record[I++]));
3345 const uint64_t Count = Record[I++];
3346 DelayedDeleteExprs.push_back(Count);
3347 for (uint64_t C = 0; C < Count; ++C) {
3348 DelayedDeleteExprs.push_back(ReadSourceLocation(F, Record, I).getRawEncoding());
3349 bool IsArrayForm = Record[I++] == 1;
3350 DelayedDeleteExprs.push_back(IsArrayForm);
3355 case IMPORTED_MODULES:
3356 if (!F.isModule()) {
3357 // If we aren't loading a module (which has its own exports), make
3358 // all of the imported modules visible.
3359 // FIXME: Deal with macros-only imports.
3360 for (unsigned I = 0, N = Record.size(); I != N; /**/) {
3361 unsigned GlobalID = getGlobalSubmoduleID(F, Record[I++]);
3362 SourceLocation Loc = ReadSourceLocation(F, Record, I);
3364 ImportedModules.push_back(ImportedSubmodule(GlobalID, Loc));
3365 if (DeserializationListener)
3366 DeserializationListener->ModuleImportRead(GlobalID, Loc);
3372 case MACRO_OFFSET: {
3373 if (F.LocalNumMacros != 0) {
3374 Error("duplicate MACRO_OFFSET record in AST file");
3377 F.MacroOffsets = (const uint32_t *)Blob.data();
3378 F.LocalNumMacros = Record[0];
3379 unsigned LocalBaseMacroID = Record[1];
3380 F.BaseMacroID = getTotalNumMacros();
3382 if (F.LocalNumMacros > 0) {
3383 // Introduce the global -> local mapping for macros within this module.
3384 GlobalMacroMap.insert(std::make_pair(getTotalNumMacros() + 1, &F));
3386 // Introduce the local -> global mapping for macros within this module.
3387 F.MacroRemap.insertOrReplace(
3388 std::make_pair(LocalBaseMacroID,
3389 F.BaseMacroID - LocalBaseMacroID));
3391 MacrosLoaded.resize(MacrosLoaded.size() + F.LocalNumMacros);
3396 case LATE_PARSED_TEMPLATE:
3397 LateParsedTemplates.append(Record.begin(), Record.end());
3400 case OPTIMIZE_PRAGMA_OPTIONS:
3401 if (Record.size() != 1) {
3402 Error("invalid pragma optimize record");
3405 OptimizeOffPragmaLocation = ReadSourceLocation(F, Record[0]);
3408 case MSSTRUCT_PRAGMA_OPTIONS:
3409 if (Record.size() != 1) {
3410 Error("invalid pragma ms_struct record");
3413 PragmaMSStructState = Record[0];
3416 case POINTERS_TO_MEMBERS_PRAGMA_OPTIONS:
3417 if (Record.size() != 2) {
3418 Error("invalid pragma ms_struct record");
3421 PragmaMSPointersToMembersState = Record[0];
3422 PointersToMembersPragmaLocation = ReadSourceLocation(F, Record[1]);
3425 case UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES:
3426 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3427 UnusedLocalTypedefNameCandidates.push_back(
3428 getGlobalDeclID(F, Record[I]));
3431 case CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH:
3432 if (Record.size() != 1) {
3433 Error("invalid cuda pragma options record");
3436 ForceCUDAHostDeviceDepth = Record[0];
3439 case PACK_PRAGMA_OPTIONS: {
3440 if (Record.size() < 3) {
3441 Error("invalid pragma pack record");
3444 PragmaPackCurrentValue = Record[0];
3445 PragmaPackCurrentLocation = ReadSourceLocation(F, Record[1]);
3446 unsigned NumStackEntries = Record[2];
3448 // Reset the stack when importing a new module.
3449 PragmaPackStack.clear();
3450 for (unsigned I = 0; I < NumStackEntries; ++I) {
3451 PragmaPackStackEntry Entry;
3452 Entry.Value = Record[Idx++];
3453 Entry.Location = ReadSourceLocation(F, Record[Idx++]);
3454 Entry.PushLocation = ReadSourceLocation(F, Record[Idx++]);
3455 PragmaPackStrings.push_back(ReadString(Record, Idx));
3456 Entry.SlotLabel = PragmaPackStrings.back();
3457 PragmaPackStack.push_back(Entry);
3465 void ASTReader::ReadModuleOffsetMap(ModuleFile &F) const {
3466 assert(!F.ModuleOffsetMap.empty() && "no module offset map to read");
3468 // Additional remapping information.
3469 const unsigned char *Data = (const unsigned char*)F.ModuleOffsetMap.data();
3470 const unsigned char *DataEnd = Data + F.ModuleOffsetMap.size();
3471 F.ModuleOffsetMap = StringRef();
3473 // If we see this entry before SOURCE_LOCATION_OFFSETS, add placeholders.
3474 if (F.SLocRemap.find(0) == F.SLocRemap.end()) {
3475 F.SLocRemap.insert(std::make_pair(0U, 0));
3476 F.SLocRemap.insert(std::make_pair(2U, 1));
3479 // Continuous range maps we may be updating in our module.
3480 using RemapBuilder = ContinuousRangeMap<uint32_t, int, 2>::Builder;
3481 RemapBuilder SLocRemap(F.SLocRemap);
3482 RemapBuilder IdentifierRemap(F.IdentifierRemap);
3483 RemapBuilder MacroRemap(F.MacroRemap);
3484 RemapBuilder PreprocessedEntityRemap(F.PreprocessedEntityRemap);
3485 RemapBuilder SubmoduleRemap(F.SubmoduleRemap);
3486 RemapBuilder SelectorRemap(F.SelectorRemap);
3487 RemapBuilder DeclRemap(F.DeclRemap);
3488 RemapBuilder TypeRemap(F.TypeRemap);
3490 while (Data < DataEnd) {
3491 // FIXME: Looking up dependency modules by filename is horrible. Let's
3492 // start fixing this with prebuilt and explicit modules and see how it
3494 using namespace llvm::support;
3495 ModuleKind Kind = static_cast<ModuleKind>(
3496 endian::readNext<uint8_t, little, unaligned>(Data));
3497 uint16_t Len = endian::readNext<uint16_t, little, unaligned>(Data);
3498 StringRef Name = StringRef((const char*)Data, Len);
3500 ModuleFile *OM = (Kind == MK_PrebuiltModule || Kind == MK_ExplicitModule
3501 ? ModuleMgr.lookupByModuleName(Name)
3502 : ModuleMgr.lookupByFileName(Name));
3505 "SourceLocation remap refers to unknown module, cannot find ";
3511 uint32_t SLocOffset =
3512 endian::readNext<uint32_t, little, unaligned>(Data);
3513 uint32_t IdentifierIDOffset =
3514 endian::readNext<uint32_t, little, unaligned>(Data);
3515 uint32_t MacroIDOffset =
3516 endian::readNext<uint32_t, little, unaligned>(Data);
3517 uint32_t PreprocessedEntityIDOffset =
3518 endian::readNext<uint32_t, little, unaligned>(Data);
3519 uint32_t SubmoduleIDOffset =
3520 endian::readNext<uint32_t, little, unaligned>(Data);
3521 uint32_t SelectorIDOffset =
3522 endian::readNext<uint32_t, little, unaligned>(Data);
3523 uint32_t DeclIDOffset =
3524 endian::readNext<uint32_t, little, unaligned>(Data);
3525 uint32_t TypeIndexOffset =
3526 endian::readNext<uint32_t, little, unaligned>(Data);
3528 uint32_t None = std::numeric_limits<uint32_t>::max();
3530 auto mapOffset = [&](uint32_t Offset, uint32_t BaseOffset,
3531 RemapBuilder &Remap) {
3533 Remap.insert(std::make_pair(Offset,
3534 static_cast<int>(BaseOffset - Offset)));
3536 mapOffset(SLocOffset, OM->SLocEntryBaseOffset, SLocRemap);
3537 mapOffset(IdentifierIDOffset, OM->BaseIdentifierID, IdentifierRemap);
3538 mapOffset(MacroIDOffset, OM->BaseMacroID, MacroRemap);
3539 mapOffset(PreprocessedEntityIDOffset, OM->BasePreprocessedEntityID,
3540 PreprocessedEntityRemap);
3541 mapOffset(SubmoduleIDOffset, OM->BaseSubmoduleID, SubmoduleRemap);
3542 mapOffset(SelectorIDOffset, OM->BaseSelectorID, SelectorRemap);
3543 mapOffset(DeclIDOffset, OM->BaseDeclID, DeclRemap);
3544 mapOffset(TypeIndexOffset, OM->BaseTypeIndex, TypeRemap);
3546 // Global -> local mappings.
3547 F.GlobalToLocalDeclIDs[OM] = DeclIDOffset;
3551 ASTReader::ASTReadResult
3552 ASTReader::ReadModuleMapFileBlock(RecordData &Record, ModuleFile &F,
3553 const ModuleFile *ImportedBy,
3554 unsigned ClientLoadCapabilities) {
3556 F.ModuleMapPath = ReadPath(F, Record, Idx);
3558 // Try to resolve ModuleName in the current header search context and
3559 // verify that it is found in the same module map file as we saved. If the
3560 // top-level AST file is a main file, skip this check because there is no
3561 // usable header search context.
3562 assert(!F.ModuleName.empty() &&
3563 "MODULE_NAME should come before MODULE_MAP_FILE");
3564 if (F.Kind == MK_ImplicitModule && ModuleMgr.begin()->Kind != MK_MainFile) {
3565 // An implicitly-loaded module file should have its module listed in some
3566 // module map file that we've already loaded.
3567 Module *M = PP.getHeaderSearchInfo().lookupModule(F.ModuleName);
3568 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
3569 const FileEntry *ModMap = M ? Map.getModuleMapFileForUniquing(M) : nullptr;
3571 assert(ImportedBy && "top-level import should be verified");
3572 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0) {
3573 if (auto *ASTFE = M ? M->getASTFile() : nullptr) {
3574 // This module was defined by an imported (explicit) module.
3575 Diag(diag::err_module_file_conflict) << F.ModuleName << F.FileName
3576 << ASTFE->getName();
3578 // This module was built with a different module map.
3579 Diag(diag::err_imported_module_not_found)
3580 << F.ModuleName << F.FileName << ImportedBy->FileName
3582 // In case it was imported by a PCH, there's a chance the user is
3583 // just missing to include the search path to the directory containing
3585 if (ImportedBy->Kind == MK_PCH)
3586 Diag(diag::note_imported_by_pch_module_not_found)
3587 << llvm::sys::path::parent_path(F.ModuleMapPath);
3593 assert(M->Name == F.ModuleName && "found module with different name");
3595 // Check the primary module map file.
3596 const FileEntry *StoredModMap = FileMgr.getFile(F.ModuleMapPath);
3597 if (StoredModMap == nullptr || StoredModMap != ModMap) {
3598 assert(ModMap && "found module is missing module map file");
3599 assert(ImportedBy && "top-level import should be verified");
3600 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3601 Diag(diag::err_imported_module_modmap_changed)
3602 << F.ModuleName << ImportedBy->FileName
3603 << ModMap->getName() << F.ModuleMapPath;
3607 llvm::SmallPtrSet<const FileEntry *, 1> AdditionalStoredMaps;
3608 for (unsigned I = 0, N = Record[Idx++]; I < N; ++I) {
3609 // FIXME: we should use input files rather than storing names.
3610 std::string Filename = ReadPath(F, Record, Idx);
3611 const FileEntry *F =
3612 FileMgr.getFile(Filename, false, false);
3614 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3615 Error("could not find file '" + Filename +"' referenced by AST file");
3618 AdditionalStoredMaps.insert(F);
3621 // Check any additional module map files (e.g. module.private.modulemap)
3622 // that are not in the pcm.
3623 if (auto *AdditionalModuleMaps = Map.getAdditionalModuleMapFiles(M)) {
3624 for (const FileEntry *ModMap : *AdditionalModuleMaps) {
3625 // Remove files that match
3626 // Note: SmallPtrSet::erase is really remove
3627 if (!AdditionalStoredMaps.erase(ModMap)) {
3628 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3629 Diag(diag::err_module_different_modmap)
3630 << F.ModuleName << /*new*/0 << ModMap->getName();
3636 // Check any additional module map files that are in the pcm, but not
3637 // found in header search. Cases that match are already removed.
3638 for (const FileEntry *ModMap : AdditionalStoredMaps) {
3639 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3640 Diag(diag::err_module_different_modmap)
3641 << F.ModuleName << /*not new*/1 << ModMap->getName();
3647 Listener->ReadModuleMapFile(F.ModuleMapPath);
3651 /// \brief Move the given method to the back of the global list of methods.
3652 static void moveMethodToBackOfGlobalList(Sema &S, ObjCMethodDecl *Method) {
3653 // Find the entry for this selector in the method pool.
3654 Sema::GlobalMethodPool::iterator Known
3655 = S.MethodPool.find(Method->getSelector());
3656 if (Known == S.MethodPool.end())
3659 // Retrieve the appropriate method list.
3660 ObjCMethodList &Start = Method->isInstanceMethod()? Known->second.first
3661 : Known->second.second;
3663 for (ObjCMethodList *List = &Start; List; List = List->getNext()) {
3665 if (List->getMethod() == Method) {
3673 if (List->getNext())
3674 List->setMethod(List->getNext()->getMethod());
3676 List->setMethod(Method);
3680 void ASTReader::makeNamesVisible(const HiddenNames &Names, Module *Owner) {
3681 assert(Owner->NameVisibility != Module::Hidden && "nothing to make visible?");
3682 for (Decl *D : Names) {
3683 bool wasHidden = D->isHidden();
3684 D->setVisibleDespiteOwningModule();
3686 if (wasHidden && SemaObj) {
3687 if (ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(D)) {
3688 moveMethodToBackOfGlobalList(*SemaObj, Method);
3694 void ASTReader::makeModuleVisible(Module *Mod,
3695 Module::NameVisibilityKind NameVisibility,
3696 SourceLocation ImportLoc) {
3697 llvm::SmallPtrSet<Module *, 4> Visited;
3698 SmallVector<Module *, 4> Stack;
3699 Stack.push_back(Mod);
3700 while (!Stack.empty()) {
3701 Mod = Stack.pop_back_val();
3703 if (NameVisibility <= Mod->NameVisibility) {
3704 // This module already has this level of visibility (or greater), so
3705 // there is nothing more to do.
3709 if (!Mod->isAvailable()) {
3710 // Modules that aren't available cannot be made visible.
3714 // Update the module's name visibility.
3715 Mod->NameVisibility = NameVisibility;
3717 // If we've already deserialized any names from this module,
3718 // mark them as visible.
3719 HiddenNamesMapType::iterator Hidden = HiddenNamesMap.find(Mod);
3720 if (Hidden != HiddenNamesMap.end()) {
3721 auto HiddenNames = std::move(*Hidden);
3722 HiddenNamesMap.erase(Hidden);
3723 makeNamesVisible(HiddenNames.second, HiddenNames.first);
3724 assert(HiddenNamesMap.find(Mod) == HiddenNamesMap.end() &&
3725 "making names visible added hidden names");
3728 // Push any exported modules onto the stack to be marked as visible.
3729 SmallVector<Module *, 16> Exports;
3730 Mod->getExportedModules(Exports);
3731 for (SmallVectorImpl<Module *>::iterator
3732 I = Exports.begin(), E = Exports.end(); I != E; ++I) {
3733 Module *Exported = *I;
3734 if (Visited.insert(Exported).second)
3735 Stack.push_back(Exported);
3740 /// We've merged the definition \p MergedDef into the existing definition
3741 /// \p Def. Ensure that \p Def is made visible whenever \p MergedDef is made
3743 void ASTReader::mergeDefinitionVisibility(NamedDecl *Def,
3744 NamedDecl *MergedDef) {
3745 // FIXME: This doesn't correctly handle the case where MergedDef is visible
3746 // in modules other than its owning module. We should instead give the
3747 // ASTContext a list of merged definitions for Def.
3748 if (Def->isHidden()) {
3749 // If MergedDef is visible or becomes visible, make the definition visible.
3750 if (!MergedDef->isHidden())
3751 Def->setVisibleDespiteOwningModule();
3752 else if (getContext().getLangOpts().ModulesLocalVisibility) {
3753 getContext().mergeDefinitionIntoModule(
3754 Def, MergedDef->getImportedOwningModule(),
3755 /*NotifyListeners*/ false);
3756 PendingMergedDefinitionsToDeduplicate.insert(Def);
3758 auto SubmoduleID = MergedDef->getOwningModuleID();
3759 assert(SubmoduleID && "hidden definition in no module");
3760 HiddenNamesMap[getSubmodule(SubmoduleID)].push_back(Def);
3765 bool ASTReader::loadGlobalIndex() {
3769 if (TriedLoadingGlobalIndex || !UseGlobalIndex ||
3770 !PP.getLangOpts().Modules)
3773 // Try to load the global index.
3774 TriedLoadingGlobalIndex = true;
3775 StringRef ModuleCachePath
3776 = getPreprocessor().getHeaderSearchInfo().getModuleCachePath();
3777 std::pair<GlobalModuleIndex *, GlobalModuleIndex::ErrorCode> Result
3778 = GlobalModuleIndex::readIndex(ModuleCachePath);
3782 GlobalIndex.reset(Result.first);
3783 ModuleMgr.setGlobalIndex(GlobalIndex.get());
3787 bool ASTReader::isGlobalIndexUnavailable() const {
3788 return PP.getLangOpts().Modules && UseGlobalIndex &&
3789 !hasGlobalIndex() && TriedLoadingGlobalIndex;
3792 static void updateModuleTimestamp(ModuleFile &MF) {
3793 // Overwrite the timestamp file contents so that file's mtime changes.
3794 std::string TimestampFilename = MF.getTimestampFilename();
3796 llvm::raw_fd_ostream OS(TimestampFilename, EC, llvm::sys::fs::F_Text);
3799 OS << "Timestamp file\n";
3801 OS.clear_error(); // Avoid triggering a fatal error.
3804 /// \brief Given a cursor at the start of an AST file, scan ahead and drop the
3805 /// cursor into the start of the given block ID, returning false on success and
3806 /// true on failure.
3807 static bool SkipCursorToBlock(BitstreamCursor &Cursor, unsigned BlockID) {
3809 llvm::BitstreamEntry Entry = Cursor.advance();
3810 switch (Entry.Kind) {
3811 case llvm::BitstreamEntry::Error:
3812 case llvm::BitstreamEntry::EndBlock:
3815 case llvm::BitstreamEntry::Record:
3816 // Ignore top-level records.
3817 Cursor.skipRecord(Entry.ID);
3820 case llvm::BitstreamEntry::SubBlock:
3821 if (Entry.ID == BlockID) {
3822 if (Cursor.EnterSubBlock(BlockID))
3828 if (Cursor.SkipBlock())
3834 ASTReader::ASTReadResult ASTReader::ReadAST(StringRef FileName,
3836 SourceLocation ImportLoc,
3837 unsigned ClientLoadCapabilities,
3838 SmallVectorImpl<ImportedSubmodule> *Imported) {
3839 llvm::SaveAndRestore<SourceLocation>
3840 SetCurImportLocRAII(CurrentImportLoc, ImportLoc);
3842 // Defer any pending actions until we get to the end of reading the AST file.
3843 Deserializing AnASTFile(this);
3845 // Bump the generation number.
3846 unsigned PreviousGeneration = 0;
3848 PreviousGeneration = incrementGeneration(*ContextObj);
3850 unsigned NumModules = ModuleMgr.size();
3851 SmallVector<ImportedModule, 4> Loaded;
3852 switch (ASTReadResult ReadResult =
3853 ReadASTCore(FileName, Type, ImportLoc,
3854 /*ImportedBy=*/nullptr, Loaded, 0, 0,
3855 ASTFileSignature(), ClientLoadCapabilities)) {
3859 case VersionMismatch:
3860 case ConfigurationMismatch:
3862 llvm::SmallPtrSet<ModuleFile *, 4> LoadedSet;
3863 for (const ImportedModule &IM : Loaded)
3864 LoadedSet.insert(IM.Mod);
3866 ModuleMgr.removeModules(ModuleMgr.begin() + NumModules, LoadedSet,
3867 PP.getLangOpts().Modules
3868 ? &PP.getHeaderSearchInfo().getModuleMap()
3871 // If we find that any modules are unusable, the global index is going
3872 // to be out-of-date. Just remove it.
3873 GlobalIndex.reset();
3874 ModuleMgr.setGlobalIndex(nullptr);
3881 // Here comes stuff that we only do once the entire chain is loaded.
3883 // Load the AST blocks of all of the modules that we loaded.
3884 for (SmallVectorImpl<ImportedModule>::iterator M = Loaded.begin(),
3885 MEnd = Loaded.end();
3887 ModuleFile &F = *M->Mod;
3889 // Read the AST block.
3890 if (ASTReadResult Result = ReadASTBlock(F, ClientLoadCapabilities))
3893 // Read the extension blocks.
3894 while (!SkipCursorToBlock(F.Stream, EXTENSION_BLOCK_ID)) {
3895 if (ASTReadResult Result = ReadExtensionBlock(F))
3899 // Once read, set the ModuleFile bit base offset and update the size in
3900 // bits of all files we've seen.
3901 F.GlobalBitOffset = TotalModulesSizeInBits;
3902 TotalModulesSizeInBits += F.SizeInBits;
3903 GlobalBitOffsetsMap.insert(std::make_pair(F.GlobalBitOffset, &F));
3905 // Preload SLocEntries.
3906 for (unsigned I = 0, N = F.PreloadSLocEntries.size(); I != N; ++I) {
3907 int Index = int(F.PreloadSLocEntries[I] - 1) + F.SLocEntryBaseID;
3908 // Load it through the SourceManager and don't call ReadSLocEntry()
3909 // directly because the entry may have already been loaded in which case
3910 // calling ReadSLocEntry() directly would trigger an assertion in
3912 SourceMgr.getLoadedSLocEntryByID(Index);
3915 // Map the original source file ID into the ID space of the current
3917 if (F.OriginalSourceFileID.isValid()) {
3918 F.OriginalSourceFileID = FileID::get(
3919 F.SLocEntryBaseID + F.OriginalSourceFileID.getOpaqueValue() - 1);
3922 // Preload all the pending interesting identifiers by marking them out of
3924 for (auto Offset : F.PreloadIdentifierOffsets) {
3925 const unsigned char *Data = reinterpret_cast<const unsigned char *>(
3926 F.IdentifierTableData + Offset);
3928 ASTIdentifierLookupTrait Trait(*this, F);
3929 auto KeyDataLen = Trait.ReadKeyDataLength(Data);
3930 auto Key = Trait.ReadKey(Data, KeyDataLen.first);
3931 auto &II = PP.getIdentifierTable().getOwn(Key);
3932 II.setOutOfDate(true);
3934 // Mark this identifier as being from an AST file so that we can track
3935 // whether we need to serialize it.
3936 markIdentifierFromAST(*this, II);
3938 // Associate the ID with the identifier so that the writer can reuse it.
3939 auto ID = Trait.ReadIdentifierID(Data + KeyDataLen.first);
3940 SetIdentifierInfo(ID, &II);
3944 // Setup the import locations and notify the module manager that we've
3945 // committed to these module files.
3946 for (SmallVectorImpl<ImportedModule>::iterator M = Loaded.begin(),
3947 MEnd = Loaded.end();
3949 ModuleFile &F = *M->Mod;
3951 ModuleMgr.moduleFileAccepted(&F);
3953 // Set the import location.
3954 F.DirectImportLoc = ImportLoc;
3955 // FIXME: We assume that locations from PCH / preamble do not need
3958 F.ImportLoc = M->ImportLoc;
3960 F.ImportLoc = TranslateSourceLocation(*M->ImportedBy, M->ImportLoc);
3963 if (!PP.getLangOpts().CPlusPlus ||
3964 (Type != MK_ImplicitModule && Type != MK_ExplicitModule &&
3965 Type != MK_PrebuiltModule)) {
3966 // Mark all of the identifiers in the identifier table as being out of date,
3967 // so that various accessors know to check the loaded modules when the
3968 // identifier is used.
3970 // For C++ modules, we don't need information on many identifiers (just
3971 // those that provide macros or are poisoned), so we mark all of
3972 // the interesting ones via PreloadIdentifierOffsets.
3973 for (IdentifierTable::iterator Id = PP.getIdentifierTable().begin(),
3974 IdEnd = PP.getIdentifierTable().end();
3976 Id->second->setOutOfDate(true);
3978 // Mark selectors as out of date.
3979 for (auto Sel : SelectorGeneration)
3980 SelectorOutOfDate[Sel.first] = true;
3982 // Resolve any unresolved module exports.
3983 for (unsigned I = 0, N = UnresolvedModuleRefs.size(); I != N; ++I) {
3984 UnresolvedModuleRef &Unresolved = UnresolvedModuleRefs[I];
3985 SubmoduleID GlobalID = getGlobalSubmoduleID(*Unresolved.File,Unresolved.ID);
3986 Module *ResolvedMod = getSubmodule(GlobalID);
3988 switch (Unresolved.Kind) {
3989 case UnresolvedModuleRef::Conflict:
3991 Module::Conflict Conflict;
3992 Conflict.Other = ResolvedMod;
3993 Conflict.Message = Unresolved.String.str();
3994 Unresolved.Mod->Conflicts.push_back(Conflict);
3998 case UnresolvedModuleRef::Import:
4000 Unresolved.Mod->Imports.insert(ResolvedMod);
4003 case UnresolvedModuleRef::Export:
4004 if (ResolvedMod || Unresolved.IsWildcard)
4005 Unresolved.Mod->Exports.push_back(
4006 Module::ExportDecl(ResolvedMod, Unresolved.IsWildcard));
4010 UnresolvedModuleRefs.clear();
4013 Imported->append(ImportedModules.begin(),
4014 ImportedModules.end());
4016 // FIXME: How do we load the 'use'd modules? They may not be submodules.
4017 // Might be unnecessary as use declarations are only used to build the
4021 InitializeContext();
4026 if (DeserializationListener)
4027 DeserializationListener->ReaderInitialized(this);
4029 ModuleFile &PrimaryModule = ModuleMgr.getPrimaryModule();
4030 if (PrimaryModule.OriginalSourceFileID.isValid()) {
4031 // If this AST file is a precompiled preamble, then set the
4032 // preamble file ID of the source manager to the file source file
4033 // from which the preamble was built.
4034 if (Type == MK_Preamble) {
4035 SourceMgr.setPreambleFileID(PrimaryModule.OriginalSourceFileID);
4036 } else if (Type == MK_MainFile) {
4037 SourceMgr.setMainFileID(PrimaryModule.OriginalSourceFileID);
4041 // For any Objective-C class definitions we have already loaded, make sure
4042 // that we load any additional categories.
4044 for (unsigned I = 0, N = ObjCClassesLoaded.size(); I != N; ++I) {
4045 loadObjCCategories(ObjCClassesLoaded[I]->getGlobalID(),
4046 ObjCClassesLoaded[I],
4047 PreviousGeneration);
4051 if (PP.getHeaderSearchInfo()
4052 .getHeaderSearchOpts()
4053 .ModulesValidateOncePerBuildSession) {
4054 // Now we are certain that the module and all modules it depends on are
4055 // up to date. Create or update timestamp files for modules that are
4056 // located in the module cache (not for PCH files that could be anywhere
4057 // in the filesystem).
4058 for (unsigned I = 0, N = Loaded.size(); I != N; ++I) {
4059 ImportedModule &M = Loaded[I];
4060 if (M.Mod->Kind == MK_ImplicitModule) {
4061 updateModuleTimestamp(*M.Mod);
4069 static ASTFileSignature readASTFileSignature(StringRef PCH);
4071 /// \brief Whether \p Stream starts with the AST/PCH file magic number 'CPCH'.
4072 static bool startsWithASTFileMagic(BitstreamCursor &Stream) {
4073 return Stream.canSkipToPos(4) &&
4074 Stream.Read(8) == 'C' &&
4075 Stream.Read(8) == 'P' &&
4076 Stream.Read(8) == 'C' &&
4077 Stream.Read(8) == 'H';
4080 static unsigned moduleKindForDiagnostic(ModuleKind Kind) {
4084 case MK_ImplicitModule:
4085 case MK_ExplicitModule:
4086 case MK_PrebuiltModule:
4090 return 2; // main source file
4092 llvm_unreachable("unknown module kind");
4095 ASTReader::ASTReadResult
4096 ASTReader::ReadASTCore(StringRef FileName,
4098 SourceLocation ImportLoc,
4099 ModuleFile *ImportedBy,
4100 SmallVectorImpl<ImportedModule> &Loaded,
4101 off_t ExpectedSize, time_t ExpectedModTime,
4102 ASTFileSignature ExpectedSignature,
4103 unsigned ClientLoadCapabilities) {
4105 std::string ErrorStr;
4106 ModuleManager::AddModuleResult AddResult
4107 = ModuleMgr.addModule(FileName, Type, ImportLoc, ImportedBy,
4108 getGeneration(), ExpectedSize, ExpectedModTime,
4109 ExpectedSignature, readASTFileSignature,
4112 switch (AddResult) {
4113 case ModuleManager::AlreadyLoaded:
4116 case ModuleManager::NewlyLoaded:
4117 // Load module file below.
4120 case ModuleManager::Missing:
4121 // The module file was missing; if the client can handle that, return
4123 if (ClientLoadCapabilities & ARR_Missing)
4126 // Otherwise, return an error.
4127 Diag(diag::err_module_file_not_found) << moduleKindForDiagnostic(Type)
4128 << FileName << !ErrorStr.empty()
4132 case ModuleManager::OutOfDate:
4133 // We couldn't load the module file because it is out-of-date. If the
4134 // client can handle out-of-date, return it.
4135 if (ClientLoadCapabilities & ARR_OutOfDate)
4138 // Otherwise, return an error.
4139 Diag(diag::err_module_file_out_of_date) << moduleKindForDiagnostic(Type)
4140 << FileName << !ErrorStr.empty()
4145 assert(M && "Missing module file");
4148 BitstreamCursor &Stream = F.Stream;
4149 Stream = BitstreamCursor(PCHContainerRdr.ExtractPCH(*F.Buffer));
4150 F.SizeInBits = F.Buffer->getBufferSize() * 8;
4152 // Sniff for the signature.
4153 if (!startsWithASTFileMagic(Stream)) {
4154 Diag(diag::err_module_file_invalid) << moduleKindForDiagnostic(Type)
4159 // This is used for compatibility with older PCH formats.
4160 bool HaveReadControlBlock = false;
4162 llvm::BitstreamEntry Entry = Stream.advance();
4164 switch (Entry.Kind) {
4165 case llvm::BitstreamEntry::Error:
4166 case llvm::BitstreamEntry::Record:
4167 case llvm::BitstreamEntry::EndBlock:
4168 Error("invalid record at top-level of AST file");
4171 case llvm::BitstreamEntry::SubBlock:
4176 case CONTROL_BLOCK_ID:
4177 HaveReadControlBlock = true;
4178 switch (ReadControlBlock(F, Loaded, ImportedBy, ClientLoadCapabilities)) {
4180 // Check that we didn't try to load a non-module AST file as a module.
4182 // FIXME: Should we also perform the converse check? Loading a module as
4183 // a PCH file sort of works, but it's a bit wonky.
4184 if ((Type == MK_ImplicitModule || Type == MK_ExplicitModule ||
4185 Type == MK_PrebuiltModule) &&
4186 F.ModuleName.empty()) {
4187 auto Result = (Type == MK_ImplicitModule) ? OutOfDate : Failure;
4188 if (Result != OutOfDate ||
4189 (ClientLoadCapabilities & ARR_OutOfDate) == 0)
4190 Diag(diag::err_module_file_not_module) << FileName;
4195 case Failure: return Failure;
4196 case Missing: return Missing;
4197 case OutOfDate: return OutOfDate;
4198 case VersionMismatch: return VersionMismatch;
4199 case ConfigurationMismatch: return ConfigurationMismatch;
4200 case HadErrors: return HadErrors;
4205 if (!HaveReadControlBlock) {
4206 if ((ClientLoadCapabilities & ARR_VersionMismatch) == 0)
4207 Diag(diag::err_pch_version_too_old);
4208 return VersionMismatch;
4211 // Record that we've loaded this module.
4212 Loaded.push_back(ImportedModule(M, ImportedBy, ImportLoc));
4215 case UNHASHED_CONTROL_BLOCK_ID:
4216 // This block is handled using look-ahead during ReadControlBlock. We
4217 // shouldn't get here!
4218 Error("malformed block record in AST file");
4222 if (Stream.SkipBlock()) {
4223 Error("malformed block record in AST file");
4233 ASTReader::ASTReadResult
4234 ASTReader::readUnhashedControlBlock(ModuleFile &F, bool WasImportedBy,
4235 unsigned ClientLoadCapabilities) {
4236 const HeaderSearchOptions &HSOpts =
4237 PP.getHeaderSearchInfo().getHeaderSearchOpts();
4238 bool AllowCompatibleConfigurationMismatch =
4239 F.Kind == MK_ExplicitModule || F.Kind == MK_PrebuiltModule;
4241 ASTReadResult Result = readUnhashedControlBlockImpl(
4242 &F, F.Data, ClientLoadCapabilities, AllowCompatibleConfigurationMismatch,
4244 WasImportedBy ? false : HSOpts.ModulesValidateDiagnosticOptions);
4246 // If F was directly imported by another module, it's implicitly validated by
4247 // the importing module.
4248 if (DisableValidation || WasImportedBy ||
4249 (AllowConfigurationMismatch && Result == ConfigurationMismatch))
4252 if (Result == Failure) {
4253 Error("malformed block record in AST file");
4257 if (Result == OutOfDate && F.Kind == MK_ImplicitModule) {
4258 // If this module has already been finalized in the PCMCache, we're stuck
4259 // with it; we can only load a single version of each module.
4261 // This can happen when a module is imported in two contexts: in one, as a
4262 // user module; in another, as a system module (due to an import from
4263 // another module marked with the [system] flag). It usually indicates a
4264 // bug in the module map: this module should also be marked with [system].
4266 // If -Wno-system-headers (the default), and the first import is as a
4267 // system module, then validation will fail during the as-user import,
4268 // since -Werror flags won't have been validated. However, it's reasonable
4269 // to treat this consistently as a system module.
4271 // If -Wsystem-headers, the PCM on disk was built with
4272 // -Wno-system-headers, and the first import is as a user module, then
4273 // validation will fail during the as-system import since the PCM on disk
4274 // doesn't guarantee that -Werror was respected. However, the -Werror
4275 // flags were checked during the initial as-user import.
4276 if (PCMCache.isBufferFinal(F.FileName)) {
4277 Diag(diag::warn_module_system_bit_conflict) << F.FileName;
4285 ASTReader::ASTReadResult ASTReader::readUnhashedControlBlockImpl(
4286 ModuleFile *F, llvm::StringRef StreamData, unsigned ClientLoadCapabilities,
4287 bool AllowCompatibleConfigurationMismatch, ASTReaderListener *Listener,
4288 bool ValidateDiagnosticOptions) {
4289 // Initialize a stream.
4290 BitstreamCursor Stream(StreamData);
4292 // Sniff for the signature.
4293 if (!startsWithASTFileMagic(Stream))
4296 // Scan for the UNHASHED_CONTROL_BLOCK_ID block.
4297 if (SkipCursorToBlock(Stream, UNHASHED_CONTROL_BLOCK_ID))
4300 // Read all of the records in the options block.
4302 ASTReadResult Result = Success;
4304 llvm::BitstreamEntry Entry = Stream.advance();
4306 switch (Entry.Kind) {
4307 case llvm::BitstreamEntry::Error:
4308 case llvm::BitstreamEntry::SubBlock:
4311 case llvm::BitstreamEntry::EndBlock:
4314 case llvm::BitstreamEntry::Record:
4315 // The interesting case.
4319 // Read and process a record.
4322 (UnhashedControlBlockRecordTypes)Stream.readRecord(Entry.ID, Record)) {
4325 std::copy(Record.begin(), Record.end(), F->Signature.data());
4327 case DIAGNOSTIC_OPTIONS: {
4328 bool Complain = (ClientLoadCapabilities & ARR_OutOfDate) == 0;
4329 if (Listener && ValidateDiagnosticOptions &&
4330 !AllowCompatibleConfigurationMismatch &&
4331 ParseDiagnosticOptions(Record, Complain, *Listener))
4332 Result = OutOfDate; // Don't return early. Read the signature.
4335 case DIAG_PRAGMA_MAPPINGS:
4338 if (F->PragmaDiagMappings.empty())
4339 F->PragmaDiagMappings.swap(Record);
4341 F->PragmaDiagMappings.insert(F->PragmaDiagMappings.end(),
4342 Record.begin(), Record.end());
4348 /// Parse a record and blob containing module file extension metadata.
4349 static bool parseModuleFileExtensionMetadata(
4350 const SmallVectorImpl<uint64_t> &Record,
4352 ModuleFileExtensionMetadata &Metadata) {
4353 if (Record.size() < 4) return true;
4355 Metadata.MajorVersion = Record[0];
4356 Metadata.MinorVersion = Record[1];
4358 unsigned BlockNameLen = Record[2];
4359 unsigned UserInfoLen = Record[3];
4361 if (BlockNameLen + UserInfoLen > Blob.size()) return true;
4363 Metadata.BlockName = std::string(Blob.data(), Blob.data() + BlockNameLen);
4364 Metadata.UserInfo = std::string(Blob.data() + BlockNameLen,
4365 Blob.data() + BlockNameLen + UserInfoLen);
4369 ASTReader::ASTReadResult ASTReader::ReadExtensionBlock(ModuleFile &F) {
4370 BitstreamCursor &Stream = F.Stream;
4374 llvm::BitstreamEntry Entry = Stream.advance();
4375 switch (Entry.Kind) {
4376 case llvm::BitstreamEntry::SubBlock:
4377 if (Stream.SkipBlock())
4382 case llvm::BitstreamEntry::EndBlock:
4385 case llvm::BitstreamEntry::Error:
4388 case llvm::BitstreamEntry::Record:
4394 unsigned RecCode = Stream.readRecord(Entry.ID, Record, &Blob);
4396 case EXTENSION_METADATA: {
4397 ModuleFileExtensionMetadata Metadata;
4398 if (parseModuleFileExtensionMetadata(Record, Blob, Metadata))
4401 // Find a module file extension with this block name.
4402 auto Known = ModuleFileExtensions.find(Metadata.BlockName);
4403 if (Known == ModuleFileExtensions.end()) break;
4406 if (auto Reader = Known->second->createExtensionReader(Metadata, *this,
4408 F.ExtensionReaders.push_back(std::move(Reader));
4419 void ASTReader::InitializeContext() {
4420 assert(ContextObj && "no context to initialize");
4421 ASTContext &Context = *ContextObj;
4423 // If there's a listener, notify them that we "read" the translation unit.
4424 if (DeserializationListener)
4425 DeserializationListener->DeclRead(PREDEF_DECL_TRANSLATION_UNIT_ID,
4426 Context.getTranslationUnitDecl());
4428 // FIXME: Find a better way to deal with collisions between these
4429 // built-in types. Right now, we just ignore the problem.
4431 // Load the special types.
4432 if (SpecialTypes.size() >= NumSpecialTypeIDs) {
4433 if (unsigned String = SpecialTypes[SPECIAL_TYPE_CF_CONSTANT_STRING]) {
4434 if (!Context.CFConstantStringTypeDecl)
4435 Context.setCFConstantStringType(GetType(String));
4438 if (unsigned File = SpecialTypes[SPECIAL_TYPE_FILE]) {
4439 QualType FileType = GetType(File);
4440 if (FileType.isNull()) {
4441 Error("FILE type is NULL");
4445 if (!Context.FILEDecl) {
4446 if (const TypedefType *Typedef = FileType->getAs<TypedefType>())
4447 Context.setFILEDecl(Typedef->getDecl());
4449 const TagType *Tag = FileType->getAs<TagType>();
4451 Error("Invalid FILE type in AST file");
4454 Context.setFILEDecl(Tag->getDecl());
4459 if (unsigned Jmp_buf = SpecialTypes[SPECIAL_TYPE_JMP_BUF]) {
4460 QualType Jmp_bufType = GetType(Jmp_buf);
4461 if (Jmp_bufType.isNull()) {
4462 Error("jmp_buf type is NULL");
4466 if (!Context.jmp_bufDecl) {
4467 if (const TypedefType *Typedef = Jmp_bufType->getAs<TypedefType>())
4468 Context.setjmp_bufDecl(Typedef->getDecl());
4470 const TagType *Tag = Jmp_bufType->getAs<TagType>();
4472 Error("Invalid jmp_buf type in AST file");
4475 Context.setjmp_bufDecl(Tag->getDecl());
4480 if (unsigned Sigjmp_buf = SpecialTypes[SPECIAL_TYPE_SIGJMP_BUF]) {
4481 QualType Sigjmp_bufType = GetType(Sigjmp_buf);
4482 if (Sigjmp_bufType.isNull()) {
4483 Error("sigjmp_buf type is NULL");
4487 if (!Context.sigjmp_bufDecl) {
4488 if (const TypedefType *Typedef = Sigjmp_bufType->getAs<TypedefType>())
4489 Context.setsigjmp_bufDecl(Typedef->getDecl());
4491 const TagType *Tag = Sigjmp_bufType->getAs<TagType>();
4492 assert(Tag && "Invalid sigjmp_buf type in AST file");
4493 Context.setsigjmp_bufDecl(Tag->getDecl());
4498 if (unsigned ObjCIdRedef
4499 = SpecialTypes[SPECIAL_TYPE_OBJC_ID_REDEFINITION]) {
4500 if (Context.ObjCIdRedefinitionType.isNull())
4501 Context.ObjCIdRedefinitionType = GetType(ObjCIdRedef);
4504 if (unsigned ObjCClassRedef
4505 = SpecialTypes[SPECIAL_TYPE_OBJC_CLASS_REDEFINITION]) {
4506 if (Context.ObjCClassRedefinitionType.isNull())
4507 Context.ObjCClassRedefinitionType = GetType(ObjCClassRedef);
4510 if (unsigned ObjCSelRedef
4511 = SpecialTypes[SPECIAL_TYPE_OBJC_SEL_REDEFINITION]) {
4512 if (Context.ObjCSelRedefinitionType.isNull())
4513 Context.ObjCSelRedefinitionType = GetType(ObjCSelRedef);
4516 if (unsigned Ucontext_t = SpecialTypes[SPECIAL_TYPE_UCONTEXT_T]) {
4517 QualType Ucontext_tType = GetType(Ucontext_t);
4518 if (Ucontext_tType.isNull()) {
4519 Error("ucontext_t type is NULL");
4523 if (!Context.ucontext_tDecl) {
4524 if (const TypedefType *Typedef = Ucontext_tType->getAs<TypedefType>())
4525 Context.setucontext_tDecl(Typedef->getDecl());
4527 const TagType *Tag = Ucontext_tType->getAs<TagType>();
4528 assert(Tag && "Invalid ucontext_t type in AST file");
4529 Context.setucontext_tDecl(Tag->getDecl());
4535 ReadPragmaDiagnosticMappings(Context.getDiagnostics());
4537 // If there were any CUDA special declarations, deserialize them.
4538 if (!CUDASpecialDeclRefs.empty()) {
4539 assert(CUDASpecialDeclRefs.size() == 1 && "More decl refs than expected!");
4540 Context.setcudaConfigureCallDecl(
4541 cast<FunctionDecl>(GetDecl(CUDASpecialDeclRefs[0])));
4544 // Re-export any modules that were imported by a non-module AST file.
4545 // FIXME: This does not make macro-only imports visible again.
4546 for (auto &Import : ImportedModules) {
4547 if (Module *Imported = getSubmodule(Import.ID)) {
4548 makeModuleVisible(Imported, Module::AllVisible,
4549 /*ImportLoc=*/Import.ImportLoc);
4550 if (Import.ImportLoc.isValid())
4551 PP.makeModuleVisible(Imported, Import.ImportLoc);
4552 // FIXME: should we tell Sema to make the module visible too?
4555 ImportedModules.clear();
4558 void ASTReader::finalizeForWriting() {
4559 // Nothing to do for now.
4562 /// \brief Reads and return the signature record from \p PCH's control block, or
4564 static ASTFileSignature readASTFileSignature(StringRef PCH) {
4565 BitstreamCursor Stream(PCH);
4566 if (!startsWithASTFileMagic(Stream))
4567 return ASTFileSignature();
4569 // Scan for the UNHASHED_CONTROL_BLOCK_ID block.
4570 if (SkipCursorToBlock(Stream, UNHASHED_CONTROL_BLOCK_ID))
4571 return ASTFileSignature();
4573 // Scan for SIGNATURE inside the diagnostic options block.
4574 ASTReader::RecordData Record;
4576 llvm::BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
4577 if (Entry.Kind != llvm::BitstreamEntry::Record)
4578 return ASTFileSignature();
4582 if (SIGNATURE == Stream.readRecord(Entry.ID, Record, &Blob))
4583 return {{{(uint32_t)Record[0], (uint32_t)Record[1], (uint32_t)Record[2],
4584 (uint32_t)Record[3], (uint32_t)Record[4]}}};
4588 /// \brief Retrieve the name of the original source file name
4589 /// directly from the AST file, without actually loading the AST
4591 std::string ASTReader::getOriginalSourceFile(
4592 const std::string &ASTFileName, FileManager &FileMgr,
4593 const PCHContainerReader &PCHContainerRdr, DiagnosticsEngine &Diags) {
4594 // Open the AST file.
4595 auto Buffer = FileMgr.getBufferForFile(ASTFileName);
4597 Diags.Report(diag::err_fe_unable_to_read_pch_file)
4598 << ASTFileName << Buffer.getError().message();
4599 return std::string();
4602 // Initialize the stream
4603 BitstreamCursor Stream(PCHContainerRdr.ExtractPCH(**Buffer));
4605 // Sniff for the signature.
4606 if (!startsWithASTFileMagic(Stream)) {
4607 Diags.Report(diag::err_fe_not_a_pch_file) << ASTFileName;
4608 return std::string();
4611 // Scan for the CONTROL_BLOCK_ID block.
4612 if (SkipCursorToBlock(Stream, CONTROL_BLOCK_ID)) {
4613 Diags.Report(diag::err_fe_pch_malformed_block) << ASTFileName;
4614 return std::string();
4617 // Scan for ORIGINAL_FILE inside the control block.
4620 llvm::BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
4621 if (Entry.Kind == llvm::BitstreamEntry::EndBlock)
4622 return std::string();
4624 if (Entry.Kind != llvm::BitstreamEntry::Record) {
4625 Diags.Report(diag::err_fe_pch_malformed_block) << ASTFileName;
4626 return std::string();
4631 if (Stream.readRecord(Entry.ID, Record, &Blob) == ORIGINAL_FILE)
4638 class SimplePCHValidator : public ASTReaderListener {
4639 const LangOptions &ExistingLangOpts;
4640 const TargetOptions &ExistingTargetOpts;
4641 const PreprocessorOptions &ExistingPPOpts;
4642 std::string ExistingModuleCachePath;
4643 FileManager &FileMgr;
4646 SimplePCHValidator(const LangOptions &ExistingLangOpts,
4647 const TargetOptions &ExistingTargetOpts,
4648 const PreprocessorOptions &ExistingPPOpts,
4649 StringRef ExistingModuleCachePath,
4650 FileManager &FileMgr)
4651 : ExistingLangOpts(ExistingLangOpts),
4652 ExistingTargetOpts(ExistingTargetOpts),
4653 ExistingPPOpts(ExistingPPOpts),
4654 ExistingModuleCachePath(ExistingModuleCachePath),
4657 bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
4658 bool AllowCompatibleDifferences) override {
4659 return checkLanguageOptions(ExistingLangOpts, LangOpts, nullptr,
4660 AllowCompatibleDifferences);
4663 bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
4664 bool AllowCompatibleDifferences) override {
4665 return checkTargetOptions(ExistingTargetOpts, TargetOpts, nullptr,
4666 AllowCompatibleDifferences);
4669 bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
4670 StringRef SpecificModuleCachePath,
4671 bool Complain) override {
4672 return checkHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
4673 ExistingModuleCachePath,
4674 nullptr, ExistingLangOpts);
4677 bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
4679 std::string &SuggestedPredefines) override {
4680 return checkPreprocessorOptions(ExistingPPOpts, PPOpts, nullptr, FileMgr,
4681 SuggestedPredefines, ExistingLangOpts);
4687 bool ASTReader::readASTFileControlBlock(
4688 StringRef Filename, FileManager &FileMgr,
4689 const PCHContainerReader &PCHContainerRdr,
4690 bool FindModuleFileExtensions,
4691 ASTReaderListener &Listener, bool ValidateDiagnosticOptions) {
4692 // Open the AST file.
4693 // FIXME: This allows use of the VFS; we do not allow use of the
4694 // VFS when actually loading a module.
4695 auto Buffer = FileMgr.getBufferForFile(Filename);
4700 // Initialize the stream
4701 StringRef Bytes = PCHContainerRdr.ExtractPCH(**Buffer);
4702 BitstreamCursor Stream(Bytes);
4704 // Sniff for the signature.
4705 if (!startsWithASTFileMagic(Stream))
4708 // Scan for the CONTROL_BLOCK_ID block.
4709 if (SkipCursorToBlock(Stream, CONTROL_BLOCK_ID))
4712 bool NeedsInputFiles = Listener.needsInputFileVisitation();
4713 bool NeedsSystemInputFiles = Listener.needsSystemInputFileVisitation();
4714 bool NeedsImports = Listener.needsImportVisitation();
4715 BitstreamCursor InputFilesCursor;
4718 std::string ModuleDir;
4719 bool DoneWithControlBlock = false;
4720 while (!DoneWithControlBlock) {
4721 llvm::BitstreamEntry Entry = Stream.advance();
4723 switch (Entry.Kind) {
4724 case llvm::BitstreamEntry::SubBlock: {
4726 case OPTIONS_BLOCK_ID: {
4727 std::string IgnoredSuggestedPredefines;
4728 if (ReadOptionsBlock(Stream, ARR_ConfigurationMismatch | ARR_OutOfDate,
4729 /*AllowCompatibleConfigurationMismatch*/ false,
4730 Listener, IgnoredSuggestedPredefines) != Success)
4735 case INPUT_FILES_BLOCK_ID:
4736 InputFilesCursor = Stream;
4737 if (Stream.SkipBlock() ||
4739 ReadBlockAbbrevs(InputFilesCursor, INPUT_FILES_BLOCK_ID)))
4744 if (Stream.SkipBlock())
4752 case llvm::BitstreamEntry::EndBlock:
4753 DoneWithControlBlock = true;
4756 case llvm::BitstreamEntry::Error:
4759 case llvm::BitstreamEntry::Record:
4763 if (DoneWithControlBlock) break;
4767 unsigned RecCode = Stream.readRecord(Entry.ID, Record, &Blob);
4768 switch ((ControlRecordTypes)RecCode) {
4770 if (Record[0] != VERSION_MAJOR)
4772 if (Listener.ReadFullVersionInformation(Blob))
4776 Listener.ReadModuleName(Blob);
4778 case MODULE_DIRECTORY:
4781 case MODULE_MAP_FILE: {
4783 auto Path = ReadString(Record, Idx);
4784 ResolveImportedPath(Path, ModuleDir);
4785 Listener.ReadModuleMapFile(Path);
4788 case INPUT_FILE_OFFSETS: {
4789 if (!NeedsInputFiles)
4792 unsigned NumInputFiles = Record[0];
4793 unsigned NumUserFiles = Record[1];
4794 const uint64_t *InputFileOffs = (const uint64_t *)Blob.data();
4795 for (unsigned I = 0; I != NumInputFiles; ++I) {
4796 // Go find this input file.
4797 bool isSystemFile = I >= NumUserFiles;
4799 if (isSystemFile && !NeedsSystemInputFiles)
4800 break; // the rest are system input files
4802 BitstreamCursor &Cursor = InputFilesCursor;
4803 SavedStreamPosition SavedPosition(Cursor);
4804 Cursor.JumpToBit(InputFileOffs[I]);
4806 unsigned Code = Cursor.ReadCode();
4809 bool shouldContinue = false;
4810 switch ((InputFileRecordTypes)Cursor.readRecord(Code, Record, &Blob)) {
4812 bool Overridden = static_cast<bool>(Record[3]);
4813 std::string Filename = Blob;
4814 ResolveImportedPath(Filename, ModuleDir);
4815 shouldContinue = Listener.visitInputFile(
4816 Filename, isSystemFile, Overridden, /*IsExplicitModule*/false);
4819 if (!shouldContinue)
4829 unsigned Idx = 0, N = Record.size();
4831 // Read information about the AST file.
4832 Idx += 5; // ImportLoc, Size, ModTime, Signature
4833 SkipString(Record, Idx); // Module name; FIXME: pass to listener?
4834 std::string Filename = ReadString(Record, Idx);
4835 ResolveImportedPath(Filename, ModuleDir);
4836 Listener.visitImport(Filename);
4842 // No other validation to perform.
4847 // Look for module file extension blocks, if requested.
4848 if (FindModuleFileExtensions) {
4849 BitstreamCursor SavedStream = Stream;
4850 while (!SkipCursorToBlock(Stream, EXTENSION_BLOCK_ID)) {
4851 bool DoneWithExtensionBlock = false;
4852 while (!DoneWithExtensionBlock) {
4853 llvm::BitstreamEntry Entry = Stream.advance();
4855 switch (Entry.Kind) {
4856 case llvm::BitstreamEntry::SubBlock:
4857 if (Stream.SkipBlock())
4862 case llvm::BitstreamEntry::EndBlock:
4863 DoneWithExtensionBlock = true;
4866 case llvm::BitstreamEntry::Error:
4869 case llvm::BitstreamEntry::Record:
4875 unsigned RecCode = Stream.readRecord(Entry.ID, Record, &Blob);
4877 case EXTENSION_METADATA: {
4878 ModuleFileExtensionMetadata Metadata;
4879 if (parseModuleFileExtensionMetadata(Record, Blob, Metadata))
4882 Listener.readModuleFileExtension(Metadata);
4888 Stream = SavedStream;
4891 // Scan for the UNHASHED_CONTROL_BLOCK_ID block.
4892 if (readUnhashedControlBlockImpl(
4893 nullptr, Bytes, ARR_ConfigurationMismatch | ARR_OutOfDate,
4894 /*AllowCompatibleConfigurationMismatch*/ false, &Listener,
4895 ValidateDiagnosticOptions) != Success)
4901 bool ASTReader::isAcceptableASTFile(StringRef Filename, FileManager &FileMgr,
4902 const PCHContainerReader &PCHContainerRdr,
4903 const LangOptions &LangOpts,
4904 const TargetOptions &TargetOpts,
4905 const PreprocessorOptions &PPOpts,
4906 StringRef ExistingModuleCachePath) {
4907 SimplePCHValidator validator(LangOpts, TargetOpts, PPOpts,
4908 ExistingModuleCachePath, FileMgr);
4909 return !readASTFileControlBlock(Filename, FileMgr, PCHContainerRdr,
4910 /*FindModuleFileExtensions=*/false,
4912 /*ValidateDiagnosticOptions=*/true);
4915 ASTReader::ASTReadResult
4916 ASTReader::ReadSubmoduleBlock(ModuleFile &F, unsigned ClientLoadCapabilities) {
4917 // Enter the submodule block.
4918 if (F.Stream.EnterSubBlock(SUBMODULE_BLOCK_ID)) {
4919 Error("malformed submodule block record in AST file");
4923 ModuleMap &ModMap = PP.getHeaderSearchInfo().getModuleMap();
4925 Module *CurrentModule = nullptr;
4928 llvm::BitstreamEntry Entry = F.Stream.advanceSkippingSubblocks();
4930 switch (Entry.Kind) {
4931 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
4932 case llvm::BitstreamEntry::Error:
4933 Error("malformed block record in AST file");
4935 case llvm::BitstreamEntry::EndBlock:
4937 case llvm::BitstreamEntry::Record:
4938 // The interesting case.
4945 auto Kind = F.Stream.readRecord(Entry.ID, Record, &Blob);
4947 if ((Kind == SUBMODULE_METADATA) != First) {
4948 Error("submodule metadata record should be at beginning of block");
4953 // Submodule information is only valid if we have a current module.
4954 // FIXME: Should we error on these cases?
4955 if (!CurrentModule && Kind != SUBMODULE_METADATA &&
4956 Kind != SUBMODULE_DEFINITION)
4960 default: // Default behavior: ignore.
4963 case SUBMODULE_DEFINITION: {
4964 if (Record.size() < 8) {
4965 Error("malformed module definition");
4969 StringRef Name = Blob;
4971 SubmoduleID GlobalID = getGlobalSubmoduleID(F, Record[Idx++]);
4972 SubmoduleID Parent = getGlobalSubmoduleID(F, Record[Idx++]);
4973 Module::ModuleKind Kind = (Module::ModuleKind)Record[Idx++];
4974 bool IsFramework = Record[Idx++];
4975 bool IsExplicit = Record[Idx++];
4976 bool IsSystem = Record[Idx++];
4977 bool IsExternC = Record[Idx++];
4978 bool InferSubmodules = Record[Idx++];
4979 bool InferExplicitSubmodules = Record[Idx++];
4980 bool InferExportWildcard = Record[Idx++];
4981 bool ConfigMacrosExhaustive = Record[Idx++];
4983 Module *ParentModule = nullptr;
4985 ParentModule = getSubmodule(Parent);
4987 // Retrieve this (sub)module from the module map, creating it if
4990 ModMap.findOrCreateModule(Name, ParentModule, IsFramework, IsExplicit)
4993 // FIXME: set the definition loc for CurrentModule, or call
4994 // ModMap.setInferredModuleAllowedBy()
4996 SubmoduleID GlobalIndex = GlobalID - NUM_PREDEF_SUBMODULE_IDS;
4997 if (GlobalIndex >= SubmodulesLoaded.size() ||
4998 SubmodulesLoaded[GlobalIndex]) {
4999 Error("too many submodules");
5003 if (!ParentModule) {
5004 if (const FileEntry *CurFile = CurrentModule->getASTFile()) {
5005 if (CurFile != F.File) {
5006 if (!Diags.isDiagnosticInFlight()) {
5007 Diag(diag::err_module_file_conflict)
5008 << CurrentModule->getTopLevelModuleName()
5009 << CurFile->getName()
5010 << F.File->getName();
5016 CurrentModule->setASTFile(F.File);
5017 CurrentModule->PresumedModuleMapFile = F.ModuleMapPath;
5020 CurrentModule->Kind = Kind;
5021 CurrentModule->Signature = F.Signature;
5022 CurrentModule->IsFromModuleFile = true;
5023 CurrentModule->IsSystem = IsSystem || CurrentModule->IsSystem;
5024 CurrentModule->IsExternC = IsExternC;
5025 CurrentModule->InferSubmodules = InferSubmodules;
5026 CurrentModule->InferExplicitSubmodules = InferExplicitSubmodules;
5027 CurrentModule->InferExportWildcard = InferExportWildcard;
5028 CurrentModule->ConfigMacrosExhaustive = ConfigMacrosExhaustive;
5029 if (DeserializationListener)
5030 DeserializationListener->ModuleRead(GlobalID, CurrentModule);
5032 SubmodulesLoaded[GlobalIndex] = CurrentModule;
5034 // Clear out data that will be replaced by what is in the module file.
5035 CurrentModule->LinkLibraries.clear();
5036 CurrentModule->ConfigMacros.clear();
5037 CurrentModule->UnresolvedConflicts.clear();
5038 CurrentModule->Conflicts.clear();
5040 // The module is available unless it's missing a requirement; relevant
5041 // requirements will be (re-)added by SUBMODULE_REQUIRES records.
5042 // Missing headers that were present when the module was built do not
5043 // make it unavailable -- if we got this far, this must be an explicitly
5044 // imported module file.
5045 CurrentModule->Requirements.clear();
5046 CurrentModule->MissingHeaders.clear();
5047 CurrentModule->IsMissingRequirement =
5048 ParentModule && ParentModule->IsMissingRequirement;
5049 CurrentModule->IsAvailable = !CurrentModule->IsMissingRequirement;
5053 case SUBMODULE_UMBRELLA_HEADER: {
5054 std::string Filename = Blob;
5055 ResolveImportedPath(F, Filename);
5056 if (auto *Umbrella = PP.getFileManager().getFile(Filename)) {
5057 if (!CurrentModule->getUmbrellaHeader())
5058 ModMap.setUmbrellaHeader(CurrentModule, Umbrella, Blob);
5059 else if (CurrentModule->getUmbrellaHeader().Entry != Umbrella) {
5060 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
5061 Error("mismatched umbrella headers in submodule");
5068 case SUBMODULE_HEADER:
5069 case SUBMODULE_EXCLUDED_HEADER:
5070 case SUBMODULE_PRIVATE_HEADER:
5071 // We lazily associate headers with their modules via the HeaderInfo table.
5072 // FIXME: Re-evaluate this section; maybe only store InputFile IDs instead
5073 // of complete filenames or remove it entirely.
5076 case SUBMODULE_TEXTUAL_HEADER:
5077 case SUBMODULE_PRIVATE_TEXTUAL_HEADER:
5078 // FIXME: Textual headers are not marked in the HeaderInfo table. Load
5082 case SUBMODULE_TOPHEADER:
5083 CurrentModule->addTopHeaderFilename(Blob);
5086 case SUBMODULE_UMBRELLA_DIR: {
5087 std::string Dirname = Blob;
5088 ResolveImportedPath(F, Dirname);
5089 if (auto *Umbrella = PP.getFileManager().getDirectory(Dirname)) {
5090 if (!CurrentModule->getUmbrellaDir())
5091 ModMap.setUmbrellaDir(CurrentModule, Umbrella, Blob);
5092 else if (CurrentModule->getUmbrellaDir().Entry != Umbrella) {
5093 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
5094 Error("mismatched umbrella directories in submodule");
5101 case SUBMODULE_METADATA: {
5102 F.BaseSubmoduleID = getTotalNumSubmodules();
5103 F.LocalNumSubmodules = Record[0];
5104 unsigned LocalBaseSubmoduleID = Record[1];
5105 if (F.LocalNumSubmodules > 0) {
5106 // Introduce the global -> local mapping for submodules within this
5108 GlobalSubmoduleMap.insert(std::make_pair(getTotalNumSubmodules()+1,&F));
5110 // Introduce the local -> global mapping for submodules within this
5112 F.SubmoduleRemap.insertOrReplace(
5113 std::make_pair(LocalBaseSubmoduleID,
5114 F.BaseSubmoduleID - LocalBaseSubmoduleID));
5116 SubmodulesLoaded.resize(SubmodulesLoaded.size() + F.LocalNumSubmodules);
5121 case SUBMODULE_IMPORTS:
5122 for (unsigned Idx = 0; Idx != Record.size(); ++Idx) {
5123 UnresolvedModuleRef Unresolved;
5124 Unresolved.File = &F;
5125 Unresolved.Mod = CurrentModule;
5126 Unresolved.ID = Record[Idx];
5127 Unresolved.Kind = UnresolvedModuleRef::Import;
5128 Unresolved.IsWildcard = false;
5129 UnresolvedModuleRefs.push_back(Unresolved);
5133 case SUBMODULE_EXPORTS:
5134 for (unsigned Idx = 0; Idx + 1 < Record.size(); Idx += 2) {
5135 UnresolvedModuleRef Unresolved;
5136 Unresolved.File = &F;
5137 Unresolved.Mod = CurrentModule;
5138 Unresolved.ID = Record[Idx];
5139 Unresolved.Kind = UnresolvedModuleRef::Export;
5140 Unresolved.IsWildcard = Record[Idx + 1];
5141 UnresolvedModuleRefs.push_back(Unresolved);
5144 // Once we've loaded the set of exports, there's no reason to keep
5145 // the parsed, unresolved exports around.
5146 CurrentModule->UnresolvedExports.clear();
5149 case SUBMODULE_REQUIRES:
5150 CurrentModule->addRequirement(Blob, Record[0], PP.getLangOpts(),
5151 PP.getTargetInfo());
5154 case SUBMODULE_LINK_LIBRARY:
5155 CurrentModule->LinkLibraries.push_back(
5156 Module::LinkLibrary(Blob, Record[0]));
5159 case SUBMODULE_CONFIG_MACRO:
5160 CurrentModule->ConfigMacros.push_back(Blob.str());
5163 case SUBMODULE_CONFLICT: {
5164 UnresolvedModuleRef Unresolved;
5165 Unresolved.File = &F;
5166 Unresolved.Mod = CurrentModule;
5167 Unresolved.ID = Record[0];
5168 Unresolved.Kind = UnresolvedModuleRef::Conflict;
5169 Unresolved.IsWildcard = false;
5170 Unresolved.String = Blob;
5171 UnresolvedModuleRefs.push_back(Unresolved);
5175 case SUBMODULE_INITIALIZERS: {
5178 SmallVector<uint32_t, 16> Inits;
5179 for (auto &ID : Record)
5180 Inits.push_back(getGlobalDeclID(F, ID));
5181 ContextObj->addLazyModuleInitializers(CurrentModule, Inits);
5185 case SUBMODULE_EXPORT_AS:
5186 CurrentModule->ExportAsModule = Blob.str();
5192 /// \brief Parse the record that corresponds to a LangOptions data
5195 /// This routine parses the language options from the AST file and then gives
5196 /// them to the AST listener if one is set.
5198 /// \returns true if the listener deems the file unacceptable, false otherwise.
5199 bool ASTReader::ParseLanguageOptions(const RecordData &Record,
5201 ASTReaderListener &Listener,
5202 bool AllowCompatibleDifferences) {
5203 LangOptions LangOpts;
5205 #define LANGOPT(Name, Bits, Default, Description) \
5206 LangOpts.Name = Record[Idx++];
5207 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
5208 LangOpts.set##Name(static_cast<LangOptions::Type>(Record[Idx++]));
5209 #include "clang/Basic/LangOptions.def"
5210 #define SANITIZER(NAME, ID) \
5211 LangOpts.Sanitize.set(SanitizerKind::ID, Record[Idx++]);
5212 #include "clang/Basic/Sanitizers.def"
5214 for (unsigned N = Record[Idx++]; N; --N)
5215 LangOpts.ModuleFeatures.push_back(ReadString(Record, Idx));
5217 ObjCRuntime::Kind runtimeKind = (ObjCRuntime::Kind) Record[Idx++];
5218 VersionTuple runtimeVersion = ReadVersionTuple(Record, Idx);
5219 LangOpts.ObjCRuntime = ObjCRuntime(runtimeKind, runtimeVersion);
5221 LangOpts.CurrentModule = ReadString(Record, Idx);
5224 for (unsigned N = Record[Idx++]; N; --N) {
5225 LangOpts.CommentOpts.BlockCommandNames.push_back(
5226 ReadString(Record, Idx));
5228 LangOpts.CommentOpts.ParseAllComments = Record[Idx++];
5230 // OpenMP offloading options.
5231 for (unsigned N = Record[Idx++]; N; --N) {
5232 LangOpts.OMPTargetTriples.push_back(llvm::Triple(ReadString(Record, Idx)));
5235 LangOpts.OMPHostIRFile = ReadString(Record, Idx);
5237 return Listener.ReadLanguageOptions(LangOpts, Complain,
5238 AllowCompatibleDifferences);
5241 bool ASTReader::ParseTargetOptions(const RecordData &Record, bool Complain,
5242 ASTReaderListener &Listener,
5243 bool AllowCompatibleDifferences) {
5245 TargetOptions TargetOpts;
5246 TargetOpts.Triple = ReadString(Record, Idx);
5247 TargetOpts.CPU = ReadString(Record, Idx);
5248 TargetOpts.ABI = ReadString(Record, Idx);
5249 for (unsigned N = Record[Idx++]; N; --N) {
5250 TargetOpts.FeaturesAsWritten.push_back(ReadString(Record, Idx));
5252 for (unsigned N = Record[Idx++]; N; --N) {
5253 TargetOpts.Features.push_back(ReadString(Record, Idx));
5256 return Listener.ReadTargetOptions(TargetOpts, Complain,
5257 AllowCompatibleDifferences);
5260 bool ASTReader::ParseDiagnosticOptions(const RecordData &Record, bool Complain,
5261 ASTReaderListener &Listener) {
5262 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts(new DiagnosticOptions);
5264 #define DIAGOPT(Name, Bits, Default) DiagOpts->Name = Record[Idx++];
5265 #define ENUM_DIAGOPT(Name, Type, Bits, Default) \
5266 DiagOpts->set##Name(static_cast<Type>(Record[Idx++]));
5267 #include "clang/Basic/DiagnosticOptions.def"
5269 for (unsigned N = Record[Idx++]; N; --N)
5270 DiagOpts->Warnings.push_back(ReadString(Record, Idx));
5271 for (unsigned N = Record[Idx++]; N; --N)
5272 DiagOpts->Remarks.push_back(ReadString(Record, Idx));
5274 return Listener.ReadDiagnosticOptions(DiagOpts, Complain);
5277 bool ASTReader::ParseFileSystemOptions(const RecordData &Record, bool Complain,
5278 ASTReaderListener &Listener) {
5279 FileSystemOptions FSOpts;
5281 FSOpts.WorkingDir = ReadString(Record, Idx);
5282 return Listener.ReadFileSystemOptions(FSOpts, Complain);
5285 bool ASTReader::ParseHeaderSearchOptions(const RecordData &Record,
5287 ASTReaderListener &Listener) {
5288 HeaderSearchOptions HSOpts;
5290 HSOpts.Sysroot = ReadString(Record, Idx);
5293 for (unsigned N = Record[Idx++]; N; --N) {
5294 std::string Path = ReadString(Record, Idx);
5295 frontend::IncludeDirGroup Group
5296 = static_cast<frontend::IncludeDirGroup>(Record[Idx++]);
5297 bool IsFramework = Record[Idx++];
5298 bool IgnoreSysRoot = Record[Idx++];
5299 HSOpts.UserEntries.emplace_back(std::move(Path), Group, IsFramework,
5303 // System header prefixes.
5304 for (unsigned N = Record[Idx++]; N; --N) {
5305 std::string Prefix = ReadString(Record, Idx);
5306 bool IsSystemHeader = Record[Idx++];
5307 HSOpts.SystemHeaderPrefixes.emplace_back(std::move(Prefix), IsSystemHeader);
5310 HSOpts.ResourceDir = ReadString(Record, Idx);
5311 HSOpts.ModuleCachePath = ReadString(Record, Idx);
5312 HSOpts.ModuleUserBuildPath = ReadString(Record, Idx);
5313 HSOpts.DisableModuleHash = Record[Idx++];
5314 HSOpts.ImplicitModuleMaps = Record[Idx++];
5315 HSOpts.ModuleMapFileHomeIsCwd = Record[Idx++];
5316 HSOpts.UseBuiltinIncludes = Record[Idx++];
5317 HSOpts.UseStandardSystemIncludes = Record[Idx++];
5318 HSOpts.UseStandardCXXIncludes = Record[Idx++];
5319 HSOpts.UseLibcxx = Record[Idx++];
5320 std::string SpecificModuleCachePath = ReadString(Record, Idx);
5322 return Listener.ReadHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
5326 bool ASTReader::ParsePreprocessorOptions(const RecordData &Record,
5328 ASTReaderListener &Listener,
5329 std::string &SuggestedPredefines) {
5330 PreprocessorOptions PPOpts;
5333 // Macro definitions/undefs
5334 for (unsigned N = Record[Idx++]; N; --N) {
5335 std::string Macro = ReadString(Record, Idx);
5336 bool IsUndef = Record[Idx++];
5337 PPOpts.Macros.push_back(std::make_pair(Macro, IsUndef));
5341 for (unsigned N = Record[Idx++]; N; --N) {
5342 PPOpts.Includes.push_back(ReadString(Record, Idx));
5346 for (unsigned N = Record[Idx++]; N; --N) {
5347 PPOpts.MacroIncludes.push_back(ReadString(Record, Idx));
5350 PPOpts.UsePredefines = Record[Idx++];
5351 PPOpts.DetailedRecord = Record[Idx++];
5352 PPOpts.ImplicitPCHInclude = ReadString(Record, Idx);
5353 PPOpts.ImplicitPTHInclude = ReadString(Record, Idx);
5354 PPOpts.ObjCXXARCStandardLibrary =
5355 static_cast<ObjCXXARCStandardLibraryKind>(Record[Idx++]);
5356 SuggestedPredefines.clear();
5357 return Listener.ReadPreprocessorOptions(PPOpts, Complain,
5358 SuggestedPredefines);
5361 std::pair<ModuleFile *, unsigned>
5362 ASTReader::getModulePreprocessedEntity(unsigned GlobalIndex) {
5363 GlobalPreprocessedEntityMapType::iterator
5364 I = GlobalPreprocessedEntityMap.find(GlobalIndex);
5365 assert(I != GlobalPreprocessedEntityMap.end() &&
5366 "Corrupted global preprocessed entity map");
5367 ModuleFile *M = I->second;
5368 unsigned LocalIndex = GlobalIndex - M->BasePreprocessedEntityID;
5369 return std::make_pair(M, LocalIndex);
5372 llvm::iterator_range<PreprocessingRecord::iterator>
5373 ASTReader::getModulePreprocessedEntities(ModuleFile &Mod) const {
5374 if (PreprocessingRecord *PPRec = PP.getPreprocessingRecord())
5375 return PPRec->getIteratorsForLoadedRange(Mod.BasePreprocessedEntityID,
5376 Mod.NumPreprocessedEntities);
5378 return llvm::make_range(PreprocessingRecord::iterator(),
5379 PreprocessingRecord::iterator());
5382 llvm::iterator_range<ASTReader::ModuleDeclIterator>
5383 ASTReader::getModuleFileLevelDecls(ModuleFile &Mod) {
5384 return llvm::make_range(
5385 ModuleDeclIterator(this, &Mod, Mod.FileSortedDecls),
5386 ModuleDeclIterator(this, &Mod,
5387 Mod.FileSortedDecls + Mod.NumFileSortedDecls));
5390 PreprocessedEntity *ASTReader::ReadPreprocessedEntity(unsigned Index) {
5391 PreprocessedEntityID PPID = Index+1;
5392 std::pair<ModuleFile *, unsigned> PPInfo = getModulePreprocessedEntity(Index);
5393 ModuleFile &M = *PPInfo.first;
5394 unsigned LocalIndex = PPInfo.second;
5395 const PPEntityOffset &PPOffs = M.PreprocessedEntityOffsets[LocalIndex];
5397 if (!PP.getPreprocessingRecord()) {
5398 Error("no preprocessing record");
5402 SavedStreamPosition SavedPosition(M.PreprocessorDetailCursor);
5403 M.PreprocessorDetailCursor.JumpToBit(PPOffs.BitOffset);
5405 llvm::BitstreamEntry Entry =
5406 M.PreprocessorDetailCursor.advance(BitstreamCursor::AF_DontPopBlockAtEnd);
5407 if (Entry.Kind != llvm::BitstreamEntry::Record)
5411 SourceRange Range(TranslateSourceLocation(M, PPOffs.getBegin()),
5412 TranslateSourceLocation(M, PPOffs.getEnd()));
5413 PreprocessingRecord &PPRec = *PP.getPreprocessingRecord();
5416 PreprocessorDetailRecordTypes RecType =
5417 (PreprocessorDetailRecordTypes)M.PreprocessorDetailCursor.readRecord(
5418 Entry.ID, Record, &Blob);
5420 case PPD_MACRO_EXPANSION: {
5421 bool isBuiltin = Record[0];
5422 IdentifierInfo *Name = nullptr;
5423 MacroDefinitionRecord *Def = nullptr;
5425 Name = getLocalIdentifier(M, Record[1]);
5427 PreprocessedEntityID GlobalID =
5428 getGlobalPreprocessedEntityID(M, Record[1]);
5429 Def = cast<MacroDefinitionRecord>(
5430 PPRec.getLoadedPreprocessedEntity(GlobalID - 1));
5435 ME = new (PPRec) MacroExpansion(Name, Range);
5437 ME = new (PPRec) MacroExpansion(Def, Range);
5442 case PPD_MACRO_DEFINITION: {
5443 // Decode the identifier info and then check again; if the macro is
5444 // still defined and associated with the identifier,
5445 IdentifierInfo *II = getLocalIdentifier(M, Record[0]);
5446 MacroDefinitionRecord *MD = new (PPRec) MacroDefinitionRecord(II, Range);
5448 if (DeserializationListener)
5449 DeserializationListener->MacroDefinitionRead(PPID, MD);
5454 case PPD_INCLUSION_DIRECTIVE: {
5455 const char *FullFileNameStart = Blob.data() + Record[0];
5456 StringRef FullFileName(FullFileNameStart, Blob.size() - Record[0]);
5457 const FileEntry *File = nullptr;
5458 if (!FullFileName.empty())
5459 File = PP.getFileManager().getFile(FullFileName);
5461 // FIXME: Stable encoding
5462 InclusionDirective::InclusionKind Kind
5463 = static_cast<InclusionDirective::InclusionKind>(Record[2]);
5464 InclusionDirective *ID
5465 = new (PPRec) InclusionDirective(PPRec, Kind,
5466 StringRef(Blob.data(), Record[0]),
5467 Record[1], Record[3],
5474 llvm_unreachable("Invalid PreprocessorDetailRecordTypes");
5477 /// \brief Find the next module that contains entities and return the ID
5478 /// of the first entry.
5480 /// \param SLocMapI points at a chunk of a module that contains no
5481 /// preprocessed entities or the entities it contains are not the ones we are
5483 PreprocessedEntityID ASTReader::findNextPreprocessedEntity(
5484 GlobalSLocOffsetMapType::const_iterator SLocMapI) const {
5486 for (GlobalSLocOffsetMapType::const_iterator
5487 EndI = GlobalSLocOffsetMap.end(); SLocMapI != EndI; ++SLocMapI) {
5488 ModuleFile &M = *SLocMapI->second;
5489 if (M.NumPreprocessedEntities)
5490 return M.BasePreprocessedEntityID;
5493 return getTotalNumPreprocessedEntities();
5498 struct PPEntityComp {
5499 const ASTReader &Reader;
5502 PPEntityComp(const ASTReader &Reader, ModuleFile &M) : Reader(Reader), M(M) {}
5504 bool operator()(const PPEntityOffset &L, const PPEntityOffset &R) const {
5505 SourceLocation LHS = getLoc(L);
5506 SourceLocation RHS = getLoc(R);
5507 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
5510 bool operator()(const PPEntityOffset &L, SourceLocation RHS) const {
5511 SourceLocation LHS = getLoc(L);
5512 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
5515 bool operator()(SourceLocation LHS, const PPEntityOffset &R) const {
5516 SourceLocation RHS = getLoc(R);
5517 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
5520 SourceLocation getLoc(const PPEntityOffset &PPE) const {
5521 return Reader.TranslateSourceLocation(M, PPE.getBegin());
5527 PreprocessedEntityID ASTReader::findPreprocessedEntity(SourceLocation Loc,
5528 bool EndsAfter) const {
5529 if (SourceMgr.isLocalSourceLocation(Loc))
5530 return getTotalNumPreprocessedEntities();
5532 GlobalSLocOffsetMapType::const_iterator SLocMapI = GlobalSLocOffsetMap.find(
5533 SourceManager::MaxLoadedOffset - Loc.getOffset() - 1);
5534 assert(SLocMapI != GlobalSLocOffsetMap.end() &&
5535 "Corrupted global sloc offset map");
5537 if (SLocMapI->second->NumPreprocessedEntities == 0)
5538 return findNextPreprocessedEntity(SLocMapI);
5540 ModuleFile &M = *SLocMapI->second;
5542 using pp_iterator = const PPEntityOffset *;
5544 pp_iterator pp_begin = M.PreprocessedEntityOffsets;
5545 pp_iterator pp_end = pp_begin + M.NumPreprocessedEntities;
5547 size_t Count = M.NumPreprocessedEntities;
5549 pp_iterator First = pp_begin;
5553 PPI = std::upper_bound(pp_begin, pp_end, Loc,
5554 PPEntityComp(*this, M));
5556 // Do a binary search manually instead of using std::lower_bound because
5557 // The end locations of entities may be unordered (when a macro expansion
5558 // is inside another macro argument), but for this case it is not important
5559 // whether we get the first macro expansion or its containing macro.
5563 std::advance(PPI, Half);
5564 if (SourceMgr.isBeforeInTranslationUnit(
5565 TranslateSourceLocation(M, PPI->getEnd()), Loc)) {
5568 Count = Count - Half - 1;
5575 return findNextPreprocessedEntity(SLocMapI);
5577 return M.BasePreprocessedEntityID + (PPI - pp_begin);
5580 /// \brief Returns a pair of [Begin, End) indices of preallocated
5581 /// preprocessed entities that \arg Range encompasses.
5582 std::pair<unsigned, unsigned>
5583 ASTReader::findPreprocessedEntitiesInRange(SourceRange Range) {
5584 if (Range.isInvalid())
5585 return std::make_pair(0,0);
5586 assert(!SourceMgr.isBeforeInTranslationUnit(Range.getEnd(),Range.getBegin()));
5588 PreprocessedEntityID BeginID =
5589 findPreprocessedEntity(Range.getBegin(), false);
5590 PreprocessedEntityID EndID = findPreprocessedEntity(Range.getEnd(), true);
5591 return std::make_pair(BeginID, EndID);
5594 /// \brief Optionally returns true or false if the preallocated preprocessed
5595 /// entity with index \arg Index came from file \arg FID.
5596 Optional<bool> ASTReader::isPreprocessedEntityInFileID(unsigned Index,
5598 if (FID.isInvalid())
5601 std::pair<ModuleFile *, unsigned> PPInfo = getModulePreprocessedEntity(Index);
5602 ModuleFile &M = *PPInfo.first;
5603 unsigned LocalIndex = PPInfo.second;
5604 const PPEntityOffset &PPOffs = M.PreprocessedEntityOffsets[LocalIndex];
5606 SourceLocation Loc = TranslateSourceLocation(M, PPOffs.getBegin());
5607 if (Loc.isInvalid())
5610 if (SourceMgr.isInFileID(SourceMgr.getFileLoc(Loc), FID))
5618 /// \brief Visitor used to search for information about a header file.
5619 class HeaderFileInfoVisitor {
5620 const FileEntry *FE;
5621 Optional<HeaderFileInfo> HFI;
5624 explicit HeaderFileInfoVisitor(const FileEntry *FE) : FE(FE) {}
5626 bool operator()(ModuleFile &M) {
5627 HeaderFileInfoLookupTable *Table
5628 = static_cast<HeaderFileInfoLookupTable *>(M.HeaderFileInfoTable);
5632 // Look in the on-disk hash table for an entry for this file name.
5633 HeaderFileInfoLookupTable::iterator Pos = Table->find(FE);
5634 if (Pos == Table->end())
5641 Optional<HeaderFileInfo> getHeaderFileInfo() const { return HFI; }
5646 HeaderFileInfo ASTReader::GetHeaderFileInfo(const FileEntry *FE) {
5647 HeaderFileInfoVisitor Visitor(FE);
5648 ModuleMgr.visit(Visitor);
5649 if (Optional<HeaderFileInfo> HFI = Visitor.getHeaderFileInfo())
5652 return HeaderFileInfo();
5655 void ASTReader::ReadPragmaDiagnosticMappings(DiagnosticsEngine &Diag) {
5656 using DiagState = DiagnosticsEngine::DiagState;
5657 SmallVector<DiagState *, 32> DiagStates;
5659 for (ModuleFile &F : ModuleMgr) {
5661 auto &Record = F.PragmaDiagMappings;
5667 auto ReadDiagState =
5668 [&](const DiagState &BasedOn, SourceLocation Loc,
5669 bool IncludeNonPragmaStates) -> DiagnosticsEngine::DiagState * {
5670 unsigned BackrefID = Record[Idx++];
5672 return DiagStates[BackrefID - 1];
5674 // A new DiagState was created here.
5675 Diag.DiagStates.push_back(BasedOn);
5676 DiagState *NewState = &Diag.DiagStates.back();
5677 DiagStates.push_back(NewState);
5678 unsigned Size = Record[Idx++];
5679 assert(Idx + Size * 2 <= Record.size() &&
5680 "Invalid data, not enough diag/map pairs");
5682 unsigned DiagID = Record[Idx++];
5683 DiagnosticMapping NewMapping =
5684 DiagnosticMapping::deserialize(Record[Idx++]);
5685 if (!NewMapping.isPragma() && !IncludeNonPragmaStates)
5688 DiagnosticMapping &Mapping = NewState->getOrAddMapping(DiagID);
5690 // If this mapping was specified as a warning but the severity was
5691 // upgraded due to diagnostic settings, simulate the current diagnostic
5692 // settings (and use a warning).
5693 if (NewMapping.wasUpgradedFromWarning() && !Mapping.isErrorOrFatal()) {
5694 NewMapping.setSeverity(diag::Severity::Warning);
5695 NewMapping.setUpgradedFromWarning(false);
5698 Mapping = NewMapping;
5703 // Read the first state.
5704 DiagState *FirstState;
5705 if (F.Kind == MK_ImplicitModule) {
5706 // Implicitly-built modules are reused with different diagnostic
5707 // settings. Use the initial diagnostic state from Diag to simulate this
5708 // compilation's diagnostic settings.
5709 FirstState = Diag.DiagStatesByLoc.FirstDiagState;
5710 DiagStates.push_back(FirstState);
5712 // Skip the initial diagnostic state from the serialized module.
5713 assert(Record[1] == 0 &&
5714 "Invalid data, unexpected backref in initial state");
5715 Idx = 3 + Record[2] * 2;
5716 assert(Idx < Record.size() &&
5717 "Invalid data, not enough state change pairs in initial state");
5718 } else if (F.isModule()) {
5719 // For an explicit module, preserve the flags from the module build
5720 // command line (-w, -Weverything, -Werror, ...) along with any explicit
5722 unsigned Flags = Record[Idx++];
5724 Initial.SuppressSystemWarnings = Flags & 1; Flags >>= 1;
5725 Initial.ErrorsAsFatal = Flags & 1; Flags >>= 1;
5726 Initial.WarningsAsErrors = Flags & 1; Flags >>= 1;
5727 Initial.EnableAllWarnings = Flags & 1; Flags >>= 1;
5728 Initial.IgnoreAllWarnings = Flags & 1; Flags >>= 1;
5729 Initial.ExtBehavior = (diag::Severity)Flags;
5730 FirstState = ReadDiagState(Initial, SourceLocation(), true);
5732 // Set up the root buffer of the module to start with the initial
5733 // diagnostic state of the module itself, to cover files that contain no
5734 // explicit transitions (for which we did not serialize anything).
5735 Diag.DiagStatesByLoc.Files[F.OriginalSourceFileID]
5736 .StateTransitions.push_back({FirstState, 0});
5738 // For prefix ASTs, start with whatever the user configured on the
5740 Idx++; // Skip flags.
5741 FirstState = ReadDiagState(*Diag.DiagStatesByLoc.CurDiagState,
5742 SourceLocation(), false);
5745 // Read the state transitions.
5746 unsigned NumLocations = Record[Idx++];
5747 while (NumLocations--) {
5748 assert(Idx < Record.size() &&
5749 "Invalid data, missing pragma diagnostic states");
5750 SourceLocation Loc = ReadSourceLocation(F, Record[Idx++]);
5751 auto IDAndOffset = SourceMgr.getDecomposedLoc(Loc);
5752 assert(IDAndOffset.second == 0 && "not a start location for a FileID");
5753 unsigned Transitions = Record[Idx++];
5755 // Note that we don't need to set up Parent/ParentOffset here, because
5756 // we won't be changing the diagnostic state within imported FileIDs
5757 // (other than perhaps appending to the main source file, which has no
5759 auto &F = Diag.DiagStatesByLoc.Files[IDAndOffset.first];
5760 F.StateTransitions.reserve(F.StateTransitions.size() + Transitions);
5761 for (unsigned I = 0; I != Transitions; ++I) {
5762 unsigned Offset = Record[Idx++];
5764 ReadDiagState(*FirstState, Loc.getLocWithOffset(Offset), false);
5765 F.StateTransitions.push_back({State, Offset});
5769 // Read the final state.
5770 assert(Idx < Record.size() &&
5771 "Invalid data, missing final pragma diagnostic state");
5772 SourceLocation CurStateLoc =
5773 ReadSourceLocation(F, F.PragmaDiagMappings[Idx++]);
5774 auto *CurState = ReadDiagState(*FirstState, CurStateLoc, false);
5776 if (!F.isModule()) {
5777 Diag.DiagStatesByLoc.CurDiagState = CurState;
5778 Diag.DiagStatesByLoc.CurDiagStateLoc = CurStateLoc;
5780 // Preserve the property that the imaginary root file describes the
5783 auto &T = Diag.DiagStatesByLoc.Files[NullFile].StateTransitions;
5785 T.push_back({CurState, 0});
5787 T[0].State = CurState;
5790 // Don't try to read these mappings again.
5795 /// \brief Get the correct cursor and offset for loading a type.
5796 ASTReader::RecordLocation ASTReader::TypeCursorForIndex(unsigned Index) {
5797 GlobalTypeMapType::iterator I = GlobalTypeMap.find(Index);
5798 assert(I != GlobalTypeMap.end() && "Corrupted global type map");
5799 ModuleFile *M = I->second;
5800 return RecordLocation(M, M->TypeOffsets[Index - M->BaseTypeIndex]);
5803 /// \brief Read and return the type with the given index..
5805 /// The index is the type ID, shifted and minus the number of predefs. This
5806 /// routine actually reads the record corresponding to the type at the given
5807 /// location. It is a helper routine for GetType, which deals with reading type
5809 QualType ASTReader::readTypeRecord(unsigned Index) {
5810 assert(ContextObj && "reading type with no AST context");
5811 ASTContext &Context = *ContextObj;
5812 RecordLocation Loc = TypeCursorForIndex(Index);
5813 BitstreamCursor &DeclsCursor = Loc.F->DeclsCursor;
5815 // Keep track of where we are in the stream, then jump back there
5816 // after reading this type.
5817 SavedStreamPosition SavedPosition(DeclsCursor);
5819 ReadingKindTracker ReadingKind(Read_Type, *this);
5821 // Note that we are loading a type record.
5822 Deserializing AType(this);
5825 DeclsCursor.JumpToBit(Loc.Offset);
5827 unsigned Code = DeclsCursor.ReadCode();
5828 switch ((TypeCode)DeclsCursor.readRecord(Code, Record)) {
5829 case TYPE_EXT_QUAL: {
5830 if (Record.size() != 2) {
5831 Error("Incorrect encoding of extended qualifier type");
5834 QualType Base = readType(*Loc.F, Record, Idx);
5835 Qualifiers Quals = Qualifiers::fromOpaqueValue(Record[Idx++]);
5836 return Context.getQualifiedType(Base, Quals);
5839 case TYPE_COMPLEX: {
5840 if (Record.size() != 1) {
5841 Error("Incorrect encoding of complex type");
5844 QualType ElemType = readType(*Loc.F, Record, Idx);
5845 return Context.getComplexType(ElemType);
5848 case TYPE_POINTER: {
5849 if (Record.size() != 1) {
5850 Error("Incorrect encoding of pointer type");
5853 QualType PointeeType = readType(*Loc.F, Record, Idx);
5854 return Context.getPointerType(PointeeType);
5857 case TYPE_DECAYED: {
5858 if (Record.size() != 1) {
5859 Error("Incorrect encoding of decayed type");
5862 QualType OriginalType = readType(*Loc.F, Record, Idx);
5863 QualType DT = Context.getAdjustedParameterType(OriginalType);
5864 if (!isa<DecayedType>(DT))
5865 Error("Decayed type does not decay");
5869 case TYPE_ADJUSTED: {
5870 if (Record.size() != 2) {
5871 Error("Incorrect encoding of adjusted type");
5874 QualType OriginalTy = readType(*Loc.F, Record, Idx);
5875 QualType AdjustedTy = readType(*Loc.F, Record, Idx);
5876 return Context.getAdjustedType(OriginalTy, AdjustedTy);
5879 case TYPE_BLOCK_POINTER: {
5880 if (Record.size() != 1) {
5881 Error("Incorrect encoding of block pointer type");
5884 QualType PointeeType = readType(*Loc.F, Record, Idx);
5885 return Context.getBlockPointerType(PointeeType);
5888 case TYPE_LVALUE_REFERENCE: {
5889 if (Record.size() != 2) {
5890 Error("Incorrect encoding of lvalue reference type");
5893 QualType PointeeType = readType(*Loc.F, Record, Idx);
5894 return Context.getLValueReferenceType(PointeeType, Record[1]);
5897 case TYPE_RVALUE_REFERENCE: {
5898 if (Record.size() != 1) {
5899 Error("Incorrect encoding of rvalue reference type");
5902 QualType PointeeType = readType(*Loc.F, Record, Idx);
5903 return Context.getRValueReferenceType(PointeeType);
5906 case TYPE_MEMBER_POINTER: {
5907 if (Record.size() != 2) {
5908 Error("Incorrect encoding of member pointer type");
5911 QualType PointeeType = readType(*Loc.F, Record, Idx);
5912 QualType ClassType = readType(*Loc.F, Record, Idx);
5913 if (PointeeType.isNull() || ClassType.isNull())
5916 return Context.getMemberPointerType(PointeeType, ClassType.getTypePtr());
5919 case TYPE_CONSTANT_ARRAY: {
5920 QualType ElementType = readType(*Loc.F, Record, Idx);
5921 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
5922 unsigned IndexTypeQuals = Record[2];
5924 llvm::APInt Size = ReadAPInt(Record, Idx);
5925 return Context.getConstantArrayType(ElementType, Size,
5926 ASM, IndexTypeQuals);
5929 case TYPE_INCOMPLETE_ARRAY: {
5930 QualType ElementType = readType(*Loc.F, Record, Idx);
5931 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
5932 unsigned IndexTypeQuals = Record[2];
5933 return Context.getIncompleteArrayType(ElementType, ASM, IndexTypeQuals);
5936 case TYPE_VARIABLE_ARRAY: {
5937 QualType ElementType = readType(*Loc.F, Record, Idx);
5938 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
5939 unsigned IndexTypeQuals = Record[2];
5940 SourceLocation LBLoc = ReadSourceLocation(*Loc.F, Record[3]);
5941 SourceLocation RBLoc = ReadSourceLocation(*Loc.F, Record[4]);
5942 return Context.getVariableArrayType(ElementType, ReadExpr(*Loc.F),
5943 ASM, IndexTypeQuals,
5944 SourceRange(LBLoc, RBLoc));
5948 if (Record.size() != 3) {
5949 Error("incorrect encoding of vector type in AST file");
5953 QualType ElementType = readType(*Loc.F, Record, Idx);
5954 unsigned NumElements = Record[1];
5955 unsigned VecKind = Record[2];
5956 return Context.getVectorType(ElementType, NumElements,
5957 (VectorType::VectorKind)VecKind);
5960 case TYPE_EXT_VECTOR: {
5961 if (Record.size() != 3) {
5962 Error("incorrect encoding of extended vector type in AST file");
5966 QualType ElementType = readType(*Loc.F, Record, Idx);
5967 unsigned NumElements = Record[1];
5968 return Context.getExtVectorType(ElementType, NumElements);
5971 case TYPE_FUNCTION_NO_PROTO: {
5972 if (Record.size() != 7) {
5973 Error("incorrect encoding of no-proto function type");
5976 QualType ResultType = readType(*Loc.F, Record, Idx);
5977 FunctionType::ExtInfo Info(Record[1], Record[2], Record[3],
5978 (CallingConv)Record[4], Record[5], Record[6]);
5979 return Context.getFunctionNoProtoType(ResultType, Info);
5982 case TYPE_FUNCTION_PROTO: {
5983 QualType ResultType = readType(*Loc.F, Record, Idx);
5985 FunctionProtoType::ExtProtoInfo EPI;
5986 EPI.ExtInfo = FunctionType::ExtInfo(/*noreturn*/ Record[1],
5987 /*hasregparm*/ Record[2],
5988 /*regparm*/ Record[3],
5989 static_cast<CallingConv>(Record[4]),
5990 /*produces*/ Record[5],
5991 /*nocallersavedregs*/ Record[6]);
5995 EPI.Variadic = Record[Idx++];
5996 EPI.HasTrailingReturn = Record[Idx++];
5997 EPI.TypeQuals = Record[Idx++];
5998 EPI.RefQualifier = static_cast<RefQualifierKind>(Record[Idx++]);
5999 SmallVector<QualType, 8> ExceptionStorage;
6000 readExceptionSpec(*Loc.F, ExceptionStorage, EPI.ExceptionSpec, Record, Idx);
6002 unsigned NumParams = Record[Idx++];
6003 SmallVector<QualType, 16> ParamTypes;
6004 for (unsigned I = 0; I != NumParams; ++I)
6005 ParamTypes.push_back(readType(*Loc.F, Record, Idx));
6007 SmallVector<FunctionProtoType::ExtParameterInfo, 4> ExtParameterInfos;
6008 if (Idx != Record.size()) {
6009 for (unsigned I = 0; I != NumParams; ++I)
6010 ExtParameterInfos.push_back(
6011 FunctionProtoType::ExtParameterInfo
6012 ::getFromOpaqueValue(Record[Idx++]));
6013 EPI.ExtParameterInfos = ExtParameterInfos.data();
6016 assert(Idx == Record.size());
6018 return Context.getFunctionType(ResultType, ParamTypes, EPI);
6021 case TYPE_UNRESOLVED_USING: {
6023 return Context.getTypeDeclType(
6024 ReadDeclAs<UnresolvedUsingTypenameDecl>(*Loc.F, Record, Idx));
6027 case TYPE_TYPEDEF: {
6028 if (Record.size() != 2) {
6029 Error("incorrect encoding of typedef type");
6033 TypedefNameDecl *Decl = ReadDeclAs<TypedefNameDecl>(*Loc.F, Record, Idx);
6034 QualType Canonical = readType(*Loc.F, Record, Idx);
6035 if (!Canonical.isNull())
6036 Canonical = Context.getCanonicalType(Canonical);
6037 return Context.getTypedefType(Decl, Canonical);
6040 case TYPE_TYPEOF_EXPR:
6041 return Context.getTypeOfExprType(ReadExpr(*Loc.F));
6044 if (Record.size() != 1) {
6045 Error("incorrect encoding of typeof(type) in AST file");
6048 QualType UnderlyingType = readType(*Loc.F, Record, Idx);
6049 return Context.getTypeOfType(UnderlyingType);
6052 case TYPE_DECLTYPE: {
6053 QualType UnderlyingType = readType(*Loc.F, Record, Idx);
6054 return Context.getDecltypeType(ReadExpr(*Loc.F), UnderlyingType);
6057 case TYPE_UNARY_TRANSFORM: {
6058 QualType BaseType = readType(*Loc.F, Record, Idx);
6059 QualType UnderlyingType = readType(*Loc.F, Record, Idx);
6060 UnaryTransformType::UTTKind UKind = (UnaryTransformType::UTTKind)Record[2];
6061 return Context.getUnaryTransformType(BaseType, UnderlyingType, UKind);
6065 QualType Deduced = readType(*Loc.F, Record, Idx);
6066 AutoTypeKeyword Keyword = (AutoTypeKeyword)Record[Idx++];
6067 bool IsDependent = Deduced.isNull() ? Record[Idx++] : false;
6068 return Context.getAutoType(Deduced, Keyword, IsDependent);
6071 case TYPE_DEDUCED_TEMPLATE_SPECIALIZATION: {
6072 TemplateName Name = ReadTemplateName(*Loc.F, Record, Idx);
6073 QualType Deduced = readType(*Loc.F, Record, Idx);
6074 bool IsDependent = Deduced.isNull() ? Record[Idx++] : false;
6075 return Context.getDeducedTemplateSpecializationType(Name, Deduced,
6080 if (Record.size() != 2) {
6081 Error("incorrect encoding of record type");
6085 bool IsDependent = Record[Idx++];
6086 RecordDecl *RD = ReadDeclAs<RecordDecl>(*Loc.F, Record, Idx);
6087 RD = cast_or_null<RecordDecl>(RD->getCanonicalDecl());
6088 QualType T = Context.getRecordType(RD);
6089 const_cast<Type*>(T.getTypePtr())->setDependent(IsDependent);
6094 if (Record.size() != 2) {
6095 Error("incorrect encoding of enum type");
6099 bool IsDependent = Record[Idx++];
6101 = Context.getEnumType(ReadDeclAs<EnumDecl>(*Loc.F, Record, Idx));
6102 const_cast<Type*>(T.getTypePtr())->setDependent(IsDependent);
6106 case TYPE_ATTRIBUTED: {
6107 if (Record.size() != 3) {
6108 Error("incorrect encoding of attributed type");
6111 QualType modifiedType = readType(*Loc.F, Record, Idx);
6112 QualType equivalentType = readType(*Loc.F, Record, Idx);
6113 AttributedType::Kind kind = static_cast<AttributedType::Kind>(Record[2]);
6114 return Context.getAttributedType(kind, modifiedType, equivalentType);
6118 if (Record.size() != 1) {
6119 Error("incorrect encoding of paren type");
6122 QualType InnerType = readType(*Loc.F, Record, Idx);
6123 return Context.getParenType(InnerType);
6126 case TYPE_PACK_EXPANSION: {
6127 if (Record.size() != 2) {
6128 Error("incorrect encoding of pack expansion type");
6131 QualType Pattern = readType(*Loc.F, Record, Idx);
6132 if (Pattern.isNull())
6134 Optional<unsigned> NumExpansions;
6136 NumExpansions = Record[1] - 1;
6137 return Context.getPackExpansionType(Pattern, NumExpansions);
6140 case TYPE_ELABORATED: {
6142 ElaboratedTypeKeyword Keyword = (ElaboratedTypeKeyword)Record[Idx++];
6143 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(*Loc.F, Record, Idx);
6144 QualType NamedType = readType(*Loc.F, Record, Idx);
6145 return Context.getElaboratedType(Keyword, NNS, NamedType);
6148 case TYPE_OBJC_INTERFACE: {
6150 ObjCInterfaceDecl *ItfD
6151 = ReadDeclAs<ObjCInterfaceDecl>(*Loc.F, Record, Idx);
6152 return Context.getObjCInterfaceType(ItfD->getCanonicalDecl());
6155 case TYPE_OBJC_TYPE_PARAM: {
6157 ObjCTypeParamDecl *Decl
6158 = ReadDeclAs<ObjCTypeParamDecl>(*Loc.F, Record, Idx);
6159 unsigned NumProtos = Record[Idx++];
6160 SmallVector<ObjCProtocolDecl*, 4> Protos;
6161 for (unsigned I = 0; I != NumProtos; ++I)
6162 Protos.push_back(ReadDeclAs<ObjCProtocolDecl>(*Loc.F, Record, Idx));
6163 return Context.getObjCTypeParamType(Decl, Protos);
6166 case TYPE_OBJC_OBJECT: {
6168 QualType Base = readType(*Loc.F, Record, Idx);
6169 unsigned NumTypeArgs = Record[Idx++];
6170 SmallVector<QualType, 4> TypeArgs;
6171 for (unsigned I = 0; I != NumTypeArgs; ++I)
6172 TypeArgs.push_back(readType(*Loc.F, Record, Idx));
6173 unsigned NumProtos = Record[Idx++];
6174 SmallVector<ObjCProtocolDecl*, 4> Protos;
6175 for (unsigned I = 0; I != NumProtos; ++I)
6176 Protos.push_back(ReadDeclAs<ObjCProtocolDecl>(*Loc.F, Record, Idx));
6177 bool IsKindOf = Record[Idx++];
6178 return Context.getObjCObjectType(Base, TypeArgs, Protos, IsKindOf);
6181 case TYPE_OBJC_OBJECT_POINTER: {
6183 QualType Pointee = readType(*Loc.F, Record, Idx);
6184 return Context.getObjCObjectPointerType(Pointee);
6187 case TYPE_SUBST_TEMPLATE_TYPE_PARM: {
6189 QualType Parm = readType(*Loc.F, Record, Idx);
6190 QualType Replacement = readType(*Loc.F, Record, Idx);
6191 return Context.getSubstTemplateTypeParmType(
6192 cast<TemplateTypeParmType>(Parm),
6193 Context.getCanonicalType(Replacement));
6196 case TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK: {
6198 QualType Parm = readType(*Loc.F, Record, Idx);
6199 TemplateArgument ArgPack = ReadTemplateArgument(*Loc.F, Record, Idx);
6200 return Context.getSubstTemplateTypeParmPackType(
6201 cast<TemplateTypeParmType>(Parm),
6205 case TYPE_INJECTED_CLASS_NAME: {
6206 CXXRecordDecl *D = ReadDeclAs<CXXRecordDecl>(*Loc.F, Record, Idx);
6207 QualType TST = readType(*Loc.F, Record, Idx); // probably derivable
6208 // FIXME: ASTContext::getInjectedClassNameType is not currently suitable
6209 // for AST reading, too much interdependencies.
6210 const Type *T = nullptr;
6211 for (auto *DI = D; DI; DI = DI->getPreviousDecl()) {
6212 if (const Type *Existing = DI->getTypeForDecl()) {
6218 T = new (Context, TypeAlignment) InjectedClassNameType(D, TST);
6219 for (auto *DI = D; DI; DI = DI->getPreviousDecl())
6220 DI->setTypeForDecl(T);
6222 return QualType(T, 0);
6225 case TYPE_TEMPLATE_TYPE_PARM: {
6227 unsigned Depth = Record[Idx++];
6228 unsigned Index = Record[Idx++];
6229 bool Pack = Record[Idx++];
6230 TemplateTypeParmDecl *D
6231 = ReadDeclAs<TemplateTypeParmDecl>(*Loc.F, Record, Idx);
6232 return Context.getTemplateTypeParmType(Depth, Index, Pack, D);
6235 case TYPE_DEPENDENT_NAME: {
6237 ElaboratedTypeKeyword Keyword = (ElaboratedTypeKeyword)Record[Idx++];
6238 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(*Loc.F, Record, Idx);
6239 const IdentifierInfo *Name = GetIdentifierInfo(*Loc.F, Record, Idx);
6240 QualType Canon = readType(*Loc.F, Record, Idx);
6241 if (!Canon.isNull())
6242 Canon = Context.getCanonicalType(Canon);
6243 return Context.getDependentNameType(Keyword, NNS, Name, Canon);
6246 case TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION: {
6248 ElaboratedTypeKeyword Keyword = (ElaboratedTypeKeyword)Record[Idx++];
6249 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(*Loc.F, Record, Idx);
6250 const IdentifierInfo *Name = GetIdentifierInfo(*Loc.F, Record, Idx);
6251 unsigned NumArgs = Record[Idx++];
6252 SmallVector<TemplateArgument, 8> Args;
6253 Args.reserve(NumArgs);
6255 Args.push_back(ReadTemplateArgument(*Loc.F, Record, Idx));
6256 return Context.getDependentTemplateSpecializationType(Keyword, NNS, Name,
6260 case TYPE_DEPENDENT_SIZED_ARRAY: {
6264 QualType ElementType = readType(*Loc.F, Record, Idx);
6265 ArrayType::ArraySizeModifier ASM
6266 = (ArrayType::ArraySizeModifier)Record[Idx++];
6267 unsigned IndexTypeQuals = Record[Idx++];
6269 // DependentSizedArrayType
6270 Expr *NumElts = ReadExpr(*Loc.F);
6271 SourceRange Brackets = ReadSourceRange(*Loc.F, Record, Idx);
6273 return Context.getDependentSizedArrayType(ElementType, NumElts, ASM,
6274 IndexTypeQuals, Brackets);
6277 case TYPE_TEMPLATE_SPECIALIZATION: {
6279 bool IsDependent = Record[Idx++];
6280 TemplateName Name = ReadTemplateName(*Loc.F, Record, Idx);
6281 SmallVector<TemplateArgument, 8> Args;
6282 ReadTemplateArgumentList(Args, *Loc.F, Record, Idx);
6283 QualType Underlying = readType(*Loc.F, Record, Idx);
6285 if (Underlying.isNull())
6286 T = Context.getCanonicalTemplateSpecializationType(Name, Args);
6288 T = Context.getTemplateSpecializationType(Name, Args, Underlying);
6289 const_cast<Type*>(T.getTypePtr())->setDependent(IsDependent);
6294 if (Record.size() != 1) {
6295 Error("Incorrect encoding of atomic type");
6298 QualType ValueType = readType(*Loc.F, Record, Idx);
6299 return Context.getAtomicType(ValueType);
6303 if (Record.size() != 2) {
6304 Error("Incorrect encoding of pipe type");
6308 // Reading the pipe element type.
6309 QualType ElementType = readType(*Loc.F, Record, Idx);
6310 unsigned ReadOnly = Record[1];
6311 return Context.getPipeType(ElementType, ReadOnly);
6314 case TYPE_DEPENDENT_SIZED_EXT_VECTOR: {
6317 // DependentSizedExtVectorType
6318 QualType ElementType = readType(*Loc.F, Record, Idx);
6319 Expr *SizeExpr = ReadExpr(*Loc.F);
6320 SourceLocation AttrLoc = ReadSourceLocation(*Loc.F, Record, Idx);
6322 return Context.getDependentSizedExtVectorType(ElementType, SizeExpr,
6326 case TYPE_DEPENDENT_ADDRESS_SPACE: {
6329 // DependentAddressSpaceType
6330 QualType PointeeType = readType(*Loc.F, Record, Idx);
6331 Expr *AddrSpaceExpr = ReadExpr(*Loc.F);
6332 SourceLocation AttrLoc = ReadSourceLocation(*Loc.F, Record, Idx);
6334 return Context.getDependentAddressSpaceType(PointeeType, AddrSpaceExpr,
6338 llvm_unreachable("Invalid TypeCode!");
6341 void ASTReader::readExceptionSpec(ModuleFile &ModuleFile,
6342 SmallVectorImpl<QualType> &Exceptions,
6343 FunctionProtoType::ExceptionSpecInfo &ESI,
6344 const RecordData &Record, unsigned &Idx) {
6345 ExceptionSpecificationType EST =
6346 static_cast<ExceptionSpecificationType>(Record[Idx++]);
6348 if (EST == EST_Dynamic) {
6349 for (unsigned I = 0, N = Record[Idx++]; I != N; ++I)
6350 Exceptions.push_back(readType(ModuleFile, Record, Idx));
6351 ESI.Exceptions = Exceptions;
6352 } else if (EST == EST_ComputedNoexcept) {
6353 ESI.NoexceptExpr = ReadExpr(ModuleFile);
6354 } else if (EST == EST_Uninstantiated) {
6355 ESI.SourceDecl = ReadDeclAs<FunctionDecl>(ModuleFile, Record, Idx);
6356 ESI.SourceTemplate = ReadDeclAs<FunctionDecl>(ModuleFile, Record, Idx);
6357 } else if (EST == EST_Unevaluated) {
6358 ESI.SourceDecl = ReadDeclAs<FunctionDecl>(ModuleFile, Record, Idx);
6364 class TypeLocReader : public TypeLocVisitor<TypeLocReader> {
6367 const ASTReader::RecordData &Record;
6370 SourceLocation ReadSourceLocation() {
6371 return Reader->ReadSourceLocation(*F, Record, Idx);
6374 TypeSourceInfo *GetTypeSourceInfo() {
6375 return Reader->GetTypeSourceInfo(*F, Record, Idx);
6378 NestedNameSpecifierLoc ReadNestedNameSpecifierLoc() {
6379 return Reader->ReadNestedNameSpecifierLoc(*F, Record, Idx);
6383 TypeLocReader(ModuleFile &F, ASTReader &Reader,
6384 const ASTReader::RecordData &Record, unsigned &Idx)
6385 : F(&F), Reader(&Reader), Record(Record), Idx(Idx) {}
6387 // We want compile-time assurance that we've enumerated all of
6388 // these, so unfortunately we have to declare them first, then
6389 // define them out-of-line.
6390 #define ABSTRACT_TYPELOC(CLASS, PARENT)
6391 #define TYPELOC(CLASS, PARENT) \
6392 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
6393 #include "clang/AST/TypeLocNodes.def"
6395 void VisitFunctionTypeLoc(FunctionTypeLoc);
6396 void VisitArrayTypeLoc(ArrayTypeLoc);
6399 } // namespace clang
6401 void TypeLocReader::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
6405 void TypeLocReader::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
6406 TL.setBuiltinLoc(ReadSourceLocation());
6407 if (TL.needsExtraLocalData()) {
6408 TL.setWrittenTypeSpec(static_cast<DeclSpec::TST>(Record[Idx++]));
6409 TL.setWrittenSignSpec(static_cast<DeclSpec::TSS>(Record[Idx++]));
6410 TL.setWrittenWidthSpec(static_cast<DeclSpec::TSW>(Record[Idx++]));
6411 TL.setModeAttr(Record[Idx++]);
6415 void TypeLocReader::VisitComplexTypeLoc(ComplexTypeLoc TL) {
6416 TL.setNameLoc(ReadSourceLocation());
6419 void TypeLocReader::VisitPointerTypeLoc(PointerTypeLoc TL) {
6420 TL.setStarLoc(ReadSourceLocation());
6423 void TypeLocReader::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
6427 void TypeLocReader::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
6431 void TypeLocReader::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
6432 TL.setCaretLoc(ReadSourceLocation());
6435 void TypeLocReader::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
6436 TL.setAmpLoc(ReadSourceLocation());
6439 void TypeLocReader::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
6440 TL.setAmpAmpLoc(ReadSourceLocation());
6443 void TypeLocReader::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
6444 TL.setStarLoc(ReadSourceLocation());
6445 TL.setClassTInfo(GetTypeSourceInfo());
6448 void TypeLocReader::VisitArrayTypeLoc(ArrayTypeLoc TL) {
6449 TL.setLBracketLoc(ReadSourceLocation());
6450 TL.setRBracketLoc(ReadSourceLocation());
6452 TL.setSizeExpr(Reader->ReadExpr(*F));
6454 TL.setSizeExpr(nullptr);
6457 void TypeLocReader::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
6458 VisitArrayTypeLoc(TL);
6461 void TypeLocReader::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
6462 VisitArrayTypeLoc(TL);
6465 void TypeLocReader::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
6466 VisitArrayTypeLoc(TL);
6469 void TypeLocReader::VisitDependentSizedArrayTypeLoc(
6470 DependentSizedArrayTypeLoc TL) {
6471 VisitArrayTypeLoc(TL);
6474 void TypeLocReader::VisitDependentAddressSpaceTypeLoc(
6475 DependentAddressSpaceTypeLoc TL) {
6477 TL.setAttrNameLoc(ReadSourceLocation());
6479 range.setBegin(ReadSourceLocation());
6480 range.setEnd(ReadSourceLocation());
6481 TL.setAttrOperandParensRange(range);
6482 TL.setAttrExprOperand(Reader->ReadExpr(*F));
6485 void TypeLocReader::VisitDependentSizedExtVectorTypeLoc(
6486 DependentSizedExtVectorTypeLoc TL) {
6487 TL.setNameLoc(ReadSourceLocation());
6490 void TypeLocReader::VisitVectorTypeLoc(VectorTypeLoc TL) {
6491 TL.setNameLoc(ReadSourceLocation());
6494 void TypeLocReader::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
6495 TL.setNameLoc(ReadSourceLocation());
6498 void TypeLocReader::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
6499 TL.setLocalRangeBegin(ReadSourceLocation());
6500 TL.setLParenLoc(ReadSourceLocation());
6501 TL.setRParenLoc(ReadSourceLocation());
6502 TL.setExceptionSpecRange(SourceRange(Reader->ReadSourceLocation(*F, Record, Idx),
6503 Reader->ReadSourceLocation(*F, Record, Idx)));
6504 TL.setLocalRangeEnd(ReadSourceLocation());
6505 for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i) {
6506 TL.setParam(i, Reader->ReadDeclAs<ParmVarDecl>(*F, Record, Idx));
6510 void TypeLocReader::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
6511 VisitFunctionTypeLoc(TL);
6514 void TypeLocReader::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
6515 VisitFunctionTypeLoc(TL);
6518 void TypeLocReader::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
6519 TL.setNameLoc(ReadSourceLocation());
6522 void TypeLocReader::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
6523 TL.setNameLoc(ReadSourceLocation());
6526 void TypeLocReader::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
6527 TL.setTypeofLoc(ReadSourceLocation());
6528 TL.setLParenLoc(ReadSourceLocation());
6529 TL.setRParenLoc(ReadSourceLocation());
6532 void TypeLocReader::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
6533 TL.setTypeofLoc(ReadSourceLocation());
6534 TL.setLParenLoc(ReadSourceLocation());
6535 TL.setRParenLoc(ReadSourceLocation());
6536 TL.setUnderlyingTInfo(GetTypeSourceInfo());
6539 void TypeLocReader::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
6540 TL.setNameLoc(ReadSourceLocation());
6543 void TypeLocReader::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
6544 TL.setKWLoc(ReadSourceLocation());
6545 TL.setLParenLoc(ReadSourceLocation());
6546 TL.setRParenLoc(ReadSourceLocation());
6547 TL.setUnderlyingTInfo(GetTypeSourceInfo());
6550 void TypeLocReader::VisitAutoTypeLoc(AutoTypeLoc TL) {
6551 TL.setNameLoc(ReadSourceLocation());
6554 void TypeLocReader::VisitDeducedTemplateSpecializationTypeLoc(
6555 DeducedTemplateSpecializationTypeLoc TL) {
6556 TL.setTemplateNameLoc(ReadSourceLocation());
6559 void TypeLocReader::VisitRecordTypeLoc(RecordTypeLoc TL) {
6560 TL.setNameLoc(ReadSourceLocation());
6563 void TypeLocReader::VisitEnumTypeLoc(EnumTypeLoc TL) {
6564 TL.setNameLoc(ReadSourceLocation());
6567 void TypeLocReader::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
6568 TL.setAttrNameLoc(ReadSourceLocation());
6569 if (TL.hasAttrOperand()) {
6571 range.setBegin(ReadSourceLocation());
6572 range.setEnd(ReadSourceLocation());
6573 TL.setAttrOperandParensRange(range);
6575 if (TL.hasAttrExprOperand()) {
6577 TL.setAttrExprOperand(Reader->ReadExpr(*F));
6579 TL.setAttrExprOperand(nullptr);
6580 } else if (TL.hasAttrEnumOperand())
6581 TL.setAttrEnumOperandLoc(ReadSourceLocation());
6584 void TypeLocReader::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
6585 TL.setNameLoc(ReadSourceLocation());
6588 void TypeLocReader::VisitSubstTemplateTypeParmTypeLoc(
6589 SubstTemplateTypeParmTypeLoc TL) {
6590 TL.setNameLoc(ReadSourceLocation());
6593 void TypeLocReader::VisitSubstTemplateTypeParmPackTypeLoc(
6594 SubstTemplateTypeParmPackTypeLoc TL) {
6595 TL.setNameLoc(ReadSourceLocation());
6598 void TypeLocReader::VisitTemplateSpecializationTypeLoc(
6599 TemplateSpecializationTypeLoc TL) {
6600 TL.setTemplateKeywordLoc(ReadSourceLocation());
6601 TL.setTemplateNameLoc(ReadSourceLocation());
6602 TL.setLAngleLoc(ReadSourceLocation());
6603 TL.setRAngleLoc(ReadSourceLocation());
6604 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
6607 Reader->GetTemplateArgumentLocInfo(
6608 *F, TL.getTypePtr()->getArg(i).getKind(), Record, Idx));
6611 void TypeLocReader::VisitParenTypeLoc(ParenTypeLoc TL) {
6612 TL.setLParenLoc(ReadSourceLocation());
6613 TL.setRParenLoc(ReadSourceLocation());
6616 void TypeLocReader::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
6617 TL.setElaboratedKeywordLoc(ReadSourceLocation());
6618 TL.setQualifierLoc(ReadNestedNameSpecifierLoc());
6621 void TypeLocReader::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
6622 TL.setNameLoc(ReadSourceLocation());
6625 void TypeLocReader::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
6626 TL.setElaboratedKeywordLoc(ReadSourceLocation());
6627 TL.setQualifierLoc(ReadNestedNameSpecifierLoc());
6628 TL.setNameLoc(ReadSourceLocation());
6631 void TypeLocReader::VisitDependentTemplateSpecializationTypeLoc(
6632 DependentTemplateSpecializationTypeLoc TL) {
6633 TL.setElaboratedKeywordLoc(ReadSourceLocation());
6634 TL.setQualifierLoc(ReadNestedNameSpecifierLoc());
6635 TL.setTemplateKeywordLoc(ReadSourceLocation());
6636 TL.setTemplateNameLoc(ReadSourceLocation());
6637 TL.setLAngleLoc(ReadSourceLocation());
6638 TL.setRAngleLoc(ReadSourceLocation());
6639 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
6642 Reader->GetTemplateArgumentLocInfo(
6643 *F, TL.getTypePtr()->getArg(I).getKind(), Record, Idx));
6646 void TypeLocReader::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
6647 TL.setEllipsisLoc(ReadSourceLocation());
6650 void TypeLocReader::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
6651 TL.setNameLoc(ReadSourceLocation());
6654 void TypeLocReader::VisitObjCTypeParamTypeLoc(ObjCTypeParamTypeLoc TL) {
6655 if (TL.getNumProtocols()) {
6656 TL.setProtocolLAngleLoc(ReadSourceLocation());
6657 TL.setProtocolRAngleLoc(ReadSourceLocation());
6659 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
6660 TL.setProtocolLoc(i, ReadSourceLocation());
6663 void TypeLocReader::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
6664 TL.setHasBaseTypeAsWritten(Record[Idx++]);
6665 TL.setTypeArgsLAngleLoc(ReadSourceLocation());
6666 TL.setTypeArgsRAngleLoc(ReadSourceLocation());
6667 for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
6668 TL.setTypeArgTInfo(i, GetTypeSourceInfo());
6669 TL.setProtocolLAngleLoc(ReadSourceLocation());
6670 TL.setProtocolRAngleLoc(ReadSourceLocation());
6671 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
6672 TL.setProtocolLoc(i, ReadSourceLocation());
6675 void TypeLocReader::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
6676 TL.setStarLoc(ReadSourceLocation());
6679 void TypeLocReader::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
6680 TL.setKWLoc(ReadSourceLocation());
6681 TL.setLParenLoc(ReadSourceLocation());
6682 TL.setRParenLoc(ReadSourceLocation());
6685 void TypeLocReader::VisitPipeTypeLoc(PipeTypeLoc TL) {
6686 TL.setKWLoc(ReadSourceLocation());
6690 ASTReader::GetTypeSourceInfo(ModuleFile &F, const ASTReader::RecordData &Record,
6692 QualType InfoTy = readType(F, Record, Idx);
6693 if (InfoTy.isNull())
6696 TypeSourceInfo *TInfo = getContext().CreateTypeSourceInfo(InfoTy);
6697 TypeLocReader TLR(F, *this, Record, Idx);
6698 for (TypeLoc TL = TInfo->getTypeLoc(); !TL.isNull(); TL = TL.getNextTypeLoc())
6703 QualType ASTReader::GetType(TypeID ID) {
6704 assert(ContextObj && "reading type with no AST context");
6705 ASTContext &Context = *ContextObj;
6707 unsigned FastQuals = ID & Qualifiers::FastMask;
6708 unsigned Index = ID >> Qualifiers::FastWidth;
6710 if (Index < NUM_PREDEF_TYPE_IDS) {
6712 switch ((PredefinedTypeIDs)Index) {
6713 case PREDEF_TYPE_NULL_ID:
6715 case PREDEF_TYPE_VOID_ID:
6718 case PREDEF_TYPE_BOOL_ID:
6721 case PREDEF_TYPE_CHAR_U_ID:
6722 case PREDEF_TYPE_CHAR_S_ID:
6723 // FIXME: Check that the signedness of CharTy is correct!
6726 case PREDEF_TYPE_UCHAR_ID:
6727 T = Context.UnsignedCharTy;
6729 case PREDEF_TYPE_USHORT_ID:
6730 T = Context.UnsignedShortTy;
6732 case PREDEF_TYPE_UINT_ID:
6733 T = Context.UnsignedIntTy;
6735 case PREDEF_TYPE_ULONG_ID:
6736 T = Context.UnsignedLongTy;
6738 case PREDEF_TYPE_ULONGLONG_ID:
6739 T = Context.UnsignedLongLongTy;
6741 case PREDEF_TYPE_UINT128_ID:
6742 T = Context.UnsignedInt128Ty;
6744 case PREDEF_TYPE_SCHAR_ID:
6745 T = Context.SignedCharTy;
6747 case PREDEF_TYPE_WCHAR_ID:
6748 T = Context.WCharTy;
6750 case PREDEF_TYPE_SHORT_ID:
6751 T = Context.ShortTy;
6753 case PREDEF_TYPE_INT_ID:
6756 case PREDEF_TYPE_LONG_ID:
6759 case PREDEF_TYPE_LONGLONG_ID:
6760 T = Context.LongLongTy;
6762 case PREDEF_TYPE_INT128_ID:
6763 T = Context.Int128Ty;
6765 case PREDEF_TYPE_HALF_ID:
6768 case PREDEF_TYPE_FLOAT_ID:
6769 T = Context.FloatTy;
6771 case PREDEF_TYPE_DOUBLE_ID:
6772 T = Context.DoubleTy;
6774 case PREDEF_TYPE_LONGDOUBLE_ID:
6775 T = Context.LongDoubleTy;
6777 case PREDEF_TYPE_FLOAT16_ID:
6778 T = Context.Float16Ty;
6780 case PREDEF_TYPE_FLOAT128_ID:
6781 T = Context.Float128Ty;
6783 case PREDEF_TYPE_OVERLOAD_ID:
6784 T = Context.OverloadTy;
6786 case PREDEF_TYPE_BOUND_MEMBER:
6787 T = Context.BoundMemberTy;
6789 case PREDEF_TYPE_PSEUDO_OBJECT:
6790 T = Context.PseudoObjectTy;
6792 case PREDEF_TYPE_DEPENDENT_ID:
6793 T = Context.DependentTy;
6795 case PREDEF_TYPE_UNKNOWN_ANY:
6796 T = Context.UnknownAnyTy;
6798 case PREDEF_TYPE_NULLPTR_ID:
6799 T = Context.NullPtrTy;
6801 case PREDEF_TYPE_CHAR16_ID:
6802 T = Context.Char16Ty;
6804 case PREDEF_TYPE_CHAR32_ID:
6805 T = Context.Char32Ty;
6807 case PREDEF_TYPE_OBJC_ID:
6808 T = Context.ObjCBuiltinIdTy;
6810 case PREDEF_TYPE_OBJC_CLASS:
6811 T = Context.ObjCBuiltinClassTy;
6813 case PREDEF_TYPE_OBJC_SEL:
6814 T = Context.ObjCBuiltinSelTy;
6816 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
6817 case PREDEF_TYPE_##Id##_ID: \
6818 T = Context.SingletonId; \
6820 #include "clang/Basic/OpenCLImageTypes.def"
6821 case PREDEF_TYPE_SAMPLER_ID:
6822 T = Context.OCLSamplerTy;
6824 case PREDEF_TYPE_EVENT_ID:
6825 T = Context.OCLEventTy;
6827 case PREDEF_TYPE_CLK_EVENT_ID:
6828 T = Context.OCLClkEventTy;
6830 case PREDEF_TYPE_QUEUE_ID:
6831 T = Context.OCLQueueTy;
6833 case PREDEF_TYPE_RESERVE_ID_ID:
6834 T = Context.OCLReserveIDTy;
6836 case PREDEF_TYPE_AUTO_DEDUCT:
6837 T = Context.getAutoDeductType();
6839 case PREDEF_TYPE_AUTO_RREF_DEDUCT:
6840 T = Context.getAutoRRefDeductType();
6842 case PREDEF_TYPE_ARC_UNBRIDGED_CAST:
6843 T = Context.ARCUnbridgedCastTy;
6845 case PREDEF_TYPE_BUILTIN_FN:
6846 T = Context.BuiltinFnTy;
6848 case PREDEF_TYPE_OMP_ARRAY_SECTION:
6849 T = Context.OMPArraySectionTy;
6853 assert(!T.isNull() && "Unknown predefined type");
6854 return T.withFastQualifiers(FastQuals);
6857 Index -= NUM_PREDEF_TYPE_IDS;
6858 assert(Index < TypesLoaded.size() && "Type index out-of-range");
6859 if (TypesLoaded[Index].isNull()) {
6860 TypesLoaded[Index] = readTypeRecord(Index);
6861 if (TypesLoaded[Index].isNull())
6864 TypesLoaded[Index]->setFromAST();
6865 if (DeserializationListener)
6866 DeserializationListener->TypeRead(TypeIdx::fromTypeID(ID),
6867 TypesLoaded[Index]);
6870 return TypesLoaded[Index].withFastQualifiers(FastQuals);
6873 QualType ASTReader::getLocalType(ModuleFile &F, unsigned LocalID) {
6874 return GetType(getGlobalTypeID(F, LocalID));
6877 serialization::TypeID
6878 ASTReader::getGlobalTypeID(ModuleFile &F, unsigned LocalID) const {
6879 unsigned FastQuals = LocalID & Qualifiers::FastMask;
6880 unsigned LocalIndex = LocalID >> Qualifiers::FastWidth;
6882 if (LocalIndex < NUM_PREDEF_TYPE_IDS)
6885 if (!F.ModuleOffsetMap.empty())
6886 ReadModuleOffsetMap(F);
6888 ContinuousRangeMap<uint32_t, int, 2>::iterator I
6889 = F.TypeRemap.find(LocalIndex - NUM_PREDEF_TYPE_IDS);
6890 assert(I != F.TypeRemap.end() && "Invalid index into type index remap");
6892 unsigned GlobalIndex = LocalIndex + I->second;
6893 return (GlobalIndex << Qualifiers::FastWidth) | FastQuals;
6896 TemplateArgumentLocInfo
6897 ASTReader::GetTemplateArgumentLocInfo(ModuleFile &F,
6898 TemplateArgument::ArgKind Kind,
6899 const RecordData &Record,
6902 case TemplateArgument::Expression:
6904 case TemplateArgument::Type:
6905 return GetTypeSourceInfo(F, Record, Index);
6906 case TemplateArgument::Template: {
6907 NestedNameSpecifierLoc QualifierLoc = ReadNestedNameSpecifierLoc(F, Record,
6909 SourceLocation TemplateNameLoc = ReadSourceLocation(F, Record, Index);
6910 return TemplateArgumentLocInfo(QualifierLoc, TemplateNameLoc,
6913 case TemplateArgument::TemplateExpansion: {
6914 NestedNameSpecifierLoc QualifierLoc = ReadNestedNameSpecifierLoc(F, Record,
6916 SourceLocation TemplateNameLoc = ReadSourceLocation(F, Record, Index);
6917 SourceLocation EllipsisLoc = ReadSourceLocation(F, Record, Index);
6918 return TemplateArgumentLocInfo(QualifierLoc, TemplateNameLoc,
6921 case TemplateArgument::Null:
6922 case TemplateArgument::Integral:
6923 case TemplateArgument::Declaration:
6924 case TemplateArgument::NullPtr:
6925 case TemplateArgument::Pack:
6926 // FIXME: Is this right?
6927 return TemplateArgumentLocInfo();
6929 llvm_unreachable("unexpected template argument loc");
6933 ASTReader::ReadTemplateArgumentLoc(ModuleFile &F,
6934 const RecordData &Record, unsigned &Index) {
6935 TemplateArgument Arg = ReadTemplateArgument(F, Record, Index);
6937 if (Arg.getKind() == TemplateArgument::Expression) {
6938 if (Record[Index++]) // bool InfoHasSameExpr.
6939 return TemplateArgumentLoc(Arg, TemplateArgumentLocInfo(Arg.getAsExpr()));
6941 return TemplateArgumentLoc(Arg, GetTemplateArgumentLocInfo(F, Arg.getKind(),
6945 const ASTTemplateArgumentListInfo*
6946 ASTReader::ReadASTTemplateArgumentListInfo(ModuleFile &F,
6947 const RecordData &Record,
6949 SourceLocation LAngleLoc = ReadSourceLocation(F, Record, Index);
6950 SourceLocation RAngleLoc = ReadSourceLocation(F, Record, Index);
6951 unsigned NumArgsAsWritten = Record[Index++];
6952 TemplateArgumentListInfo TemplArgsInfo(LAngleLoc, RAngleLoc);
6953 for (unsigned i = 0; i != NumArgsAsWritten; ++i)
6954 TemplArgsInfo.addArgument(ReadTemplateArgumentLoc(F, Record, Index));
6955 return ASTTemplateArgumentListInfo::Create(getContext(), TemplArgsInfo);
6958 Decl *ASTReader::GetExternalDecl(uint32_t ID) {
6962 void ASTReader::CompleteRedeclChain(const Decl *D) {
6963 if (NumCurrentElementsDeserializing) {
6964 // We arrange to not care about the complete redeclaration chain while we're
6965 // deserializing. Just remember that the AST has marked this one as complete
6966 // but that it's not actually complete yet, so we know we still need to
6967 // complete it later.
6968 PendingIncompleteDeclChains.push_back(const_cast<Decl*>(D));
6972 const DeclContext *DC = D->getDeclContext()->getRedeclContext();
6974 // If this is a named declaration, complete it by looking it up
6975 // within its context.
6977 // FIXME: Merging a function definition should merge
6978 // all mergeable entities within it.
6979 if (isa<TranslationUnitDecl>(DC) || isa<NamespaceDecl>(DC) ||
6980 isa<CXXRecordDecl>(DC) || isa<EnumDecl>(DC)) {
6981 if (DeclarationName Name = cast<NamedDecl>(D)->getDeclName()) {
6982 if (!getContext().getLangOpts().CPlusPlus &&
6983 isa<TranslationUnitDecl>(DC)) {
6984 // Outside of C++, we don't have a lookup table for the TU, so update
6985 // the identifier instead. (For C++ modules, we don't store decls
6986 // in the serialized identifier table, so we do the lookup in the TU.)
6987 auto *II = Name.getAsIdentifierInfo();
6988 assert(II && "non-identifier name in C?");
6989 if (II->isOutOfDate())
6990 updateOutOfDateIdentifier(*II);
6993 } else if (needsAnonymousDeclarationNumber(cast<NamedDecl>(D))) {
6994 // Find all declarations of this kind from the relevant context.
6995 for (auto *DCDecl : cast<Decl>(D->getLexicalDeclContext())->redecls()) {
6996 auto *DC = cast<DeclContext>(DCDecl);
6997 SmallVector<Decl*, 8> Decls;
6998 FindExternalLexicalDecls(
6999 DC, [&](Decl::Kind K) { return K == D->getKind(); }, Decls);
7004 if (auto *CTSD = dyn_cast<ClassTemplateSpecializationDecl>(D))
7005 CTSD->getSpecializedTemplate()->LoadLazySpecializations();
7006 if (auto *VTSD = dyn_cast<VarTemplateSpecializationDecl>(D))
7007 VTSD->getSpecializedTemplate()->LoadLazySpecializations();
7008 if (auto *FD = dyn_cast<FunctionDecl>(D)) {
7009 if (auto *Template = FD->getPrimaryTemplate())
7010 Template->LoadLazySpecializations();
7014 CXXCtorInitializer **
7015 ASTReader::GetExternalCXXCtorInitializers(uint64_t Offset) {
7016 RecordLocation Loc = getLocalBitOffset(Offset);
7017 BitstreamCursor &Cursor = Loc.F->DeclsCursor;
7018 SavedStreamPosition SavedPosition(Cursor);
7019 Cursor.JumpToBit(Loc.Offset);
7020 ReadingKindTracker ReadingKind(Read_Decl, *this);
7023 unsigned Code = Cursor.ReadCode();
7024 unsigned RecCode = Cursor.readRecord(Code, Record);
7025 if (RecCode != DECL_CXX_CTOR_INITIALIZERS) {
7026 Error("malformed AST file: missing C++ ctor initializers");
7031 return ReadCXXCtorInitializers(*Loc.F, Record, Idx);
7034 CXXBaseSpecifier *ASTReader::GetExternalCXXBaseSpecifiers(uint64_t Offset) {
7035 assert(ContextObj && "reading base specifiers with no AST context");
7036 ASTContext &Context = *ContextObj;
7038 RecordLocation Loc = getLocalBitOffset(Offset);
7039 BitstreamCursor &Cursor = Loc.F->DeclsCursor;
7040 SavedStreamPosition SavedPosition(Cursor);
7041 Cursor.JumpToBit(Loc.Offset);
7042 ReadingKindTracker ReadingKind(Read_Decl, *this);
7044 unsigned Code = Cursor.ReadCode();
7045 unsigned RecCode = Cursor.readRecord(Code, Record);
7046 if (RecCode != DECL_CXX_BASE_SPECIFIERS) {
7047 Error("malformed AST file: missing C++ base specifiers");
7052 unsigned NumBases = Record[Idx++];
7053 void *Mem = Context.Allocate(sizeof(CXXBaseSpecifier) * NumBases);
7054 CXXBaseSpecifier *Bases = new (Mem) CXXBaseSpecifier [NumBases];
7055 for (unsigned I = 0; I != NumBases; ++I)
7056 Bases[I] = ReadCXXBaseSpecifier(*Loc.F, Record, Idx);
7060 serialization::DeclID
7061 ASTReader::getGlobalDeclID(ModuleFile &F, LocalDeclID LocalID) const {
7062 if (LocalID < NUM_PREDEF_DECL_IDS)
7065 if (!F.ModuleOffsetMap.empty())
7066 ReadModuleOffsetMap(F);
7068 ContinuousRangeMap<uint32_t, int, 2>::iterator I
7069 = F.DeclRemap.find(LocalID - NUM_PREDEF_DECL_IDS);
7070 assert(I != F.DeclRemap.end() && "Invalid index into decl index remap");
7072 return LocalID + I->second;
7075 bool ASTReader::isDeclIDFromModule(serialization::GlobalDeclID ID,
7076 ModuleFile &M) const {
7077 // Predefined decls aren't from any module.
7078 if (ID < NUM_PREDEF_DECL_IDS)
7081 return ID - NUM_PREDEF_DECL_IDS >= M.BaseDeclID &&
7082 ID - NUM_PREDEF_DECL_IDS < M.BaseDeclID + M.LocalNumDecls;
7085 ModuleFile *ASTReader::getOwningModuleFile(const Decl *D) {
7086 if (!D->isFromASTFile())
7088 GlobalDeclMapType::const_iterator I = GlobalDeclMap.find(D->getGlobalID());
7089 assert(I != GlobalDeclMap.end() && "Corrupted global declaration map");
7093 SourceLocation ASTReader::getSourceLocationForDeclID(GlobalDeclID ID) {
7094 if (ID < NUM_PREDEF_DECL_IDS)
7095 return SourceLocation();
7097 unsigned Index = ID - NUM_PREDEF_DECL_IDS;
7099 if (Index > DeclsLoaded.size()) {
7100 Error("declaration ID out-of-range for AST file");
7101 return SourceLocation();
7104 if (Decl *D = DeclsLoaded[Index])
7105 return D->getLocation();
7108 DeclCursorForID(ID, Loc);
7112 static Decl *getPredefinedDecl(ASTContext &Context, PredefinedDeclIDs ID) {
7114 case PREDEF_DECL_NULL_ID:
7117 case PREDEF_DECL_TRANSLATION_UNIT_ID:
7118 return Context.getTranslationUnitDecl();
7120 case PREDEF_DECL_OBJC_ID_ID:
7121 return Context.getObjCIdDecl();
7123 case PREDEF_DECL_OBJC_SEL_ID:
7124 return Context.getObjCSelDecl();
7126 case PREDEF_DECL_OBJC_CLASS_ID:
7127 return Context.getObjCClassDecl();
7129 case PREDEF_DECL_OBJC_PROTOCOL_ID:
7130 return Context.getObjCProtocolDecl();
7132 case PREDEF_DECL_INT_128_ID:
7133 return Context.getInt128Decl();
7135 case PREDEF_DECL_UNSIGNED_INT_128_ID:
7136 return Context.getUInt128Decl();
7138 case PREDEF_DECL_OBJC_INSTANCETYPE_ID:
7139 return Context.getObjCInstanceTypeDecl();
7141 case PREDEF_DECL_BUILTIN_VA_LIST_ID:
7142 return Context.getBuiltinVaListDecl();
7144 case PREDEF_DECL_VA_LIST_TAG:
7145 return Context.getVaListTagDecl();
7147 case PREDEF_DECL_BUILTIN_MS_VA_LIST_ID:
7148 return Context.getBuiltinMSVaListDecl();
7150 case PREDEF_DECL_EXTERN_C_CONTEXT_ID:
7151 return Context.getExternCContextDecl();
7153 case PREDEF_DECL_MAKE_INTEGER_SEQ_ID:
7154 return Context.getMakeIntegerSeqDecl();
7156 case PREDEF_DECL_CF_CONSTANT_STRING_ID:
7157 return Context.getCFConstantStringDecl();
7159 case PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID:
7160 return Context.getCFConstantStringTagDecl();
7162 case PREDEF_DECL_TYPE_PACK_ELEMENT_ID:
7163 return Context.getTypePackElementDecl();
7165 llvm_unreachable("PredefinedDeclIDs unknown enum value");
7168 Decl *ASTReader::GetExistingDecl(DeclID ID) {
7169 assert(ContextObj && "reading decl with no AST context");
7170 if (ID < NUM_PREDEF_DECL_IDS) {
7171 Decl *D = getPredefinedDecl(*ContextObj, (PredefinedDeclIDs)ID);
7173 // Track that we have merged the declaration with ID \p ID into the
7174 // pre-existing predefined declaration \p D.
7175 auto &Merged = KeyDecls[D->getCanonicalDecl()];
7177 Merged.push_back(ID);
7182 unsigned Index = ID - NUM_PREDEF_DECL_IDS;
7184 if (Index >= DeclsLoaded.size()) {
7185 assert(0 && "declaration ID out-of-range for AST file");
7186 Error("declaration ID out-of-range for AST file");
7190 return DeclsLoaded[Index];
7193 Decl *ASTReader::GetDecl(DeclID ID) {
7194 if (ID < NUM_PREDEF_DECL_IDS)
7195 return GetExistingDecl(ID);
7197 unsigned Index = ID - NUM_PREDEF_DECL_IDS;
7199 if (Index >= DeclsLoaded.size()) {
7200 assert(0 && "declaration ID out-of-range for AST file");
7201 Error("declaration ID out-of-range for AST file");
7205 if (!DeclsLoaded[Index]) {
7207 if (DeserializationListener)
7208 DeserializationListener->DeclRead(ID, DeclsLoaded[Index]);
7211 return DeclsLoaded[Index];
7214 DeclID ASTReader::mapGlobalIDToModuleFileGlobalID(ModuleFile &M,
7216 if (GlobalID < NUM_PREDEF_DECL_IDS)
7219 GlobalDeclMapType::const_iterator I = GlobalDeclMap.find(GlobalID);
7220 assert(I != GlobalDeclMap.end() && "Corrupted global declaration map");
7221 ModuleFile *Owner = I->second;
7223 llvm::DenseMap<ModuleFile *, serialization::DeclID>::iterator Pos
7224 = M.GlobalToLocalDeclIDs.find(Owner);
7225 if (Pos == M.GlobalToLocalDeclIDs.end())
7228 return GlobalID - Owner->BaseDeclID + Pos->second;
7231 serialization::DeclID ASTReader::ReadDeclID(ModuleFile &F,
7232 const RecordData &Record,
7234 if (Idx >= Record.size()) {
7235 Error("Corrupted AST file");
7239 return getGlobalDeclID(F, Record[Idx++]);
7242 /// \brief Resolve the offset of a statement into a statement.
7244 /// This operation will read a new statement from the external
7245 /// source each time it is called, and is meant to be used via a
7246 /// LazyOffsetPtr (which is used by Decls for the body of functions, etc).
7247 Stmt *ASTReader::GetExternalDeclStmt(uint64_t Offset) {
7248 // Switch case IDs are per Decl.
7249 ClearSwitchCaseIDs();
7251 // Offset here is a global offset across the entire chain.
7252 RecordLocation Loc = getLocalBitOffset(Offset);
7253 Loc.F->DeclsCursor.JumpToBit(Loc.Offset);
7254 assert(NumCurrentElementsDeserializing == 0 &&
7255 "should not be called while already deserializing");
7256 Deserializing D(this);
7257 return ReadStmtFromStream(*Loc.F);
7260 void ASTReader::FindExternalLexicalDecls(
7261 const DeclContext *DC, llvm::function_ref<bool(Decl::Kind)> IsKindWeWant,
7262 SmallVectorImpl<Decl *> &Decls) {
7263 bool PredefsVisited[NUM_PREDEF_DECL_IDS] = {};
7265 auto Visit = [&] (ModuleFile *M, LexicalContents LexicalDecls) {
7266 assert(LexicalDecls.size() % 2 == 0 && "expected an even number of entries");
7267 for (int I = 0, N = LexicalDecls.size(); I != N; I += 2) {
7268 auto K = (Decl::Kind)+LexicalDecls[I];
7269 if (!IsKindWeWant(K))
7272 auto ID = (serialization::DeclID)+LexicalDecls[I + 1];
7274 // Don't add predefined declarations to the lexical context more
7276 if (ID < NUM_PREDEF_DECL_IDS) {
7277 if (PredefsVisited[ID])
7280 PredefsVisited[ID] = true;
7283 if (Decl *D = GetLocalDecl(*M, ID)) {
7284 assert(D->getKind() == K && "wrong kind for lexical decl");
7285 if (!DC->isDeclInLexicalTraversal(D))
7291 if (isa<TranslationUnitDecl>(DC)) {
7292 for (auto Lexical : TULexicalDecls)
7293 Visit(Lexical.first, Lexical.second);
7295 auto I = LexicalDecls.find(DC);
7296 if (I != LexicalDecls.end())
7297 Visit(I->second.first, I->second.second);
7300 ++NumLexicalDeclContextsRead;
7310 DeclIDComp(ASTReader &Reader, ModuleFile &M) : Reader(Reader), Mod(M) {}
7312 bool operator()(LocalDeclID L, LocalDeclID R) const {
7313 SourceLocation LHS = getLocation(L);
7314 SourceLocation RHS = getLocation(R);
7315 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
7318 bool operator()(SourceLocation LHS, LocalDeclID R) const {
7319 SourceLocation RHS = getLocation(R);
7320 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
7323 bool operator()(LocalDeclID L, SourceLocation RHS) const {
7324 SourceLocation LHS = getLocation(L);
7325 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
7328 SourceLocation getLocation(LocalDeclID ID) const {
7329 return Reader.getSourceManager().getFileLoc(
7330 Reader.getSourceLocationForDeclID(Reader.getGlobalDeclID(Mod, ID)));
7336 void ASTReader::FindFileRegionDecls(FileID File,
7337 unsigned Offset, unsigned Length,
7338 SmallVectorImpl<Decl *> &Decls) {
7339 SourceManager &SM = getSourceManager();
7341 llvm::DenseMap<FileID, FileDeclsInfo>::iterator I = FileDeclIDs.find(File);
7342 if (I == FileDeclIDs.end())
7345 FileDeclsInfo &DInfo = I->second;
7346 if (DInfo.Decls.empty())
7350 BeginLoc = SM.getLocForStartOfFile(File).getLocWithOffset(Offset);
7351 SourceLocation EndLoc = BeginLoc.getLocWithOffset(Length);
7353 DeclIDComp DIDComp(*this, *DInfo.Mod);
7354 ArrayRef<serialization::LocalDeclID>::iterator
7355 BeginIt = std::lower_bound(DInfo.Decls.begin(), DInfo.Decls.end(),
7357 if (BeginIt != DInfo.Decls.begin())
7360 // If we are pointing at a top-level decl inside an objc container, we need
7361 // to backtrack until we find it otherwise we will fail to report that the
7362 // region overlaps with an objc container.
7363 while (BeginIt != DInfo.Decls.begin() &&
7364 GetDecl(getGlobalDeclID(*DInfo.Mod, *BeginIt))
7365 ->isTopLevelDeclInObjCContainer())
7368 ArrayRef<serialization::LocalDeclID>::iterator
7369 EndIt = std::upper_bound(DInfo.Decls.begin(), DInfo.Decls.end(),
7371 if (EndIt != DInfo.Decls.end())
7374 for (ArrayRef<serialization::LocalDeclID>::iterator
7375 DIt = BeginIt; DIt != EndIt; ++DIt)
7376 Decls.push_back(GetDecl(getGlobalDeclID(*DInfo.Mod, *DIt)));
7380 ASTReader::FindExternalVisibleDeclsByName(const DeclContext *DC,
7381 DeclarationName Name) {
7382 assert(DC->hasExternalVisibleStorage() && DC == DC->getPrimaryContext() &&
7383 "DeclContext has no visible decls in storage");
7387 auto It = Lookups.find(DC);
7388 if (It == Lookups.end())
7391 Deserializing LookupResults(this);
7393 // Load the list of declarations.
7394 SmallVector<NamedDecl *, 64> Decls;
7395 for (DeclID ID : It->second.Table.find(Name)) {
7396 NamedDecl *ND = cast<NamedDecl>(GetDecl(ID));
7397 if (ND->getDeclName() == Name)
7398 Decls.push_back(ND);
7401 ++NumVisibleDeclContextsRead;
7402 SetExternalVisibleDeclsForName(DC, Name, Decls);
7403 return !Decls.empty();
7406 void ASTReader::completeVisibleDeclsMap(const DeclContext *DC) {
7407 if (!DC->hasExternalVisibleStorage())
7410 auto It = Lookups.find(DC);
7411 assert(It != Lookups.end() &&
7412 "have external visible storage but no lookup tables");
7416 for (DeclID ID : It->second.Table.findAll()) {
7417 NamedDecl *ND = cast<NamedDecl>(GetDecl(ID));
7418 Decls[ND->getDeclName()].push_back(ND);
7421 ++NumVisibleDeclContextsRead;
7423 for (DeclsMap::iterator I = Decls.begin(), E = Decls.end(); I != E; ++I) {
7424 SetExternalVisibleDeclsForName(DC, I->first, I->second);
7426 const_cast<DeclContext *>(DC)->setHasExternalVisibleStorage(false);
7429 const serialization::reader::DeclContextLookupTable *
7430 ASTReader::getLoadedLookupTables(DeclContext *Primary) const {
7431 auto I = Lookups.find(Primary);
7432 return I == Lookups.end() ? nullptr : &I->second;
7435 /// \brief Under non-PCH compilation the consumer receives the objc methods
7436 /// before receiving the implementation, and codegen depends on this.
7437 /// We simulate this by deserializing and passing to consumer the methods of the
7438 /// implementation before passing the deserialized implementation decl.
7439 static void PassObjCImplDeclToConsumer(ObjCImplDecl *ImplD,
7440 ASTConsumer *Consumer) {
7441 assert(ImplD && Consumer);
7443 for (auto *I : ImplD->methods())
7444 Consumer->HandleInterestingDecl(DeclGroupRef(I));
7446 Consumer->HandleInterestingDecl(DeclGroupRef(ImplD));
7449 void ASTReader::PassInterestingDeclToConsumer(Decl *D) {
7450 if (ObjCImplDecl *ImplD = dyn_cast<ObjCImplDecl>(D))
7451 PassObjCImplDeclToConsumer(ImplD, Consumer);
7453 Consumer->HandleInterestingDecl(DeclGroupRef(D));
7456 void ASTReader::StartTranslationUnit(ASTConsumer *Consumer) {
7457 this->Consumer = Consumer;
7460 PassInterestingDeclsToConsumer();
7462 if (DeserializationListener)
7463 DeserializationListener->ReaderInitialized(this);
7466 void ASTReader::PrintStats() {
7467 std::fprintf(stderr, "*** AST File Statistics:\n");
7469 unsigned NumTypesLoaded
7470 = TypesLoaded.size() - std::count(TypesLoaded.begin(), TypesLoaded.end(),
7472 unsigned NumDeclsLoaded
7473 = DeclsLoaded.size() - std::count(DeclsLoaded.begin(), DeclsLoaded.end(),
7475 unsigned NumIdentifiersLoaded
7476 = IdentifiersLoaded.size() - std::count(IdentifiersLoaded.begin(),
7477 IdentifiersLoaded.end(),
7478 (IdentifierInfo *)nullptr);
7479 unsigned NumMacrosLoaded
7480 = MacrosLoaded.size() - std::count(MacrosLoaded.begin(),
7482 (MacroInfo *)nullptr);
7483 unsigned NumSelectorsLoaded
7484 = SelectorsLoaded.size() - std::count(SelectorsLoaded.begin(),
7485 SelectorsLoaded.end(),
7488 if (unsigned TotalNumSLocEntries = getTotalNumSLocs())
7489 std::fprintf(stderr, " %u/%u source location entries read (%f%%)\n",
7490 NumSLocEntriesRead, TotalNumSLocEntries,
7491 ((float)NumSLocEntriesRead/TotalNumSLocEntries * 100));
7492 if (!TypesLoaded.empty())
7493 std::fprintf(stderr, " %u/%u types read (%f%%)\n",
7494 NumTypesLoaded, (unsigned)TypesLoaded.size(),
7495 ((float)NumTypesLoaded/TypesLoaded.size() * 100));
7496 if (!DeclsLoaded.empty())
7497 std::fprintf(stderr, " %u/%u declarations read (%f%%)\n",
7498 NumDeclsLoaded, (unsigned)DeclsLoaded.size(),
7499 ((float)NumDeclsLoaded/DeclsLoaded.size() * 100));
7500 if (!IdentifiersLoaded.empty())
7501 std::fprintf(stderr, " %u/%u identifiers read (%f%%)\n",
7502 NumIdentifiersLoaded, (unsigned)IdentifiersLoaded.size(),
7503 ((float)NumIdentifiersLoaded/IdentifiersLoaded.size() * 100));
7504 if (!MacrosLoaded.empty())
7505 std::fprintf(stderr, " %u/%u macros read (%f%%)\n",
7506 NumMacrosLoaded, (unsigned)MacrosLoaded.size(),
7507 ((float)NumMacrosLoaded/MacrosLoaded.size() * 100));
7508 if (!SelectorsLoaded.empty())
7509 std::fprintf(stderr, " %u/%u selectors read (%f%%)\n",
7510 NumSelectorsLoaded, (unsigned)SelectorsLoaded.size(),
7511 ((float)NumSelectorsLoaded/SelectorsLoaded.size() * 100));
7512 if (TotalNumStatements)
7513 std::fprintf(stderr, " %u/%u statements read (%f%%)\n",
7514 NumStatementsRead, TotalNumStatements,
7515 ((float)NumStatementsRead/TotalNumStatements * 100));
7517 std::fprintf(stderr, " %u/%u macros read (%f%%)\n",
7518 NumMacrosRead, TotalNumMacros,
7519 ((float)NumMacrosRead/TotalNumMacros * 100));
7520 if (TotalLexicalDeclContexts)
7521 std::fprintf(stderr, " %u/%u lexical declcontexts read (%f%%)\n",
7522 NumLexicalDeclContextsRead, TotalLexicalDeclContexts,
7523 ((float)NumLexicalDeclContextsRead/TotalLexicalDeclContexts
7525 if (TotalVisibleDeclContexts)
7526 std::fprintf(stderr, " %u/%u visible declcontexts read (%f%%)\n",
7527 NumVisibleDeclContextsRead, TotalVisibleDeclContexts,
7528 ((float)NumVisibleDeclContextsRead/TotalVisibleDeclContexts
7530 if (TotalNumMethodPoolEntries)
7531 std::fprintf(stderr, " %u/%u method pool entries read (%f%%)\n",
7532 NumMethodPoolEntriesRead, TotalNumMethodPoolEntries,
7533 ((float)NumMethodPoolEntriesRead/TotalNumMethodPoolEntries
7535 if (NumMethodPoolLookups)
7536 std::fprintf(stderr, " %u/%u method pool lookups succeeded (%f%%)\n",
7537 NumMethodPoolHits, NumMethodPoolLookups,
7538 ((float)NumMethodPoolHits/NumMethodPoolLookups * 100.0));
7539 if (NumMethodPoolTableLookups)
7540 std::fprintf(stderr, " %u/%u method pool table lookups succeeded (%f%%)\n",
7541 NumMethodPoolTableHits, NumMethodPoolTableLookups,
7542 ((float)NumMethodPoolTableHits/NumMethodPoolTableLookups
7544 if (NumIdentifierLookupHits)
7545 std::fprintf(stderr,
7546 " %u / %u identifier table lookups succeeded (%f%%)\n",
7547 NumIdentifierLookupHits, NumIdentifierLookups,
7548 (double)NumIdentifierLookupHits*100.0/NumIdentifierLookups);
7551 std::fprintf(stderr, "\n");
7552 GlobalIndex->printStats();
7555 std::fprintf(stderr, "\n");
7557 std::fprintf(stderr, "\n");
7560 template<typename Key, typename ModuleFile, unsigned InitialCapacity>
7561 LLVM_DUMP_METHOD static void
7562 dumpModuleIDMap(StringRef Name,
7563 const ContinuousRangeMap<Key, ModuleFile *,
7564 InitialCapacity> &Map) {
7565 if (Map.begin() == Map.end())
7568 using MapType = ContinuousRangeMap<Key, ModuleFile *, InitialCapacity>;
7570 llvm::errs() << Name << ":\n";
7571 for (typename MapType::const_iterator I = Map.begin(), IEnd = Map.end();
7573 llvm::errs() << " " << I->first << " -> " << I->second->FileName
7578 LLVM_DUMP_METHOD void ASTReader::dump() {
7579 llvm::errs() << "*** PCH/ModuleFile Remappings:\n";
7580 dumpModuleIDMap("Global bit offset map", GlobalBitOffsetsMap);
7581 dumpModuleIDMap("Global source location entry map", GlobalSLocEntryMap);
7582 dumpModuleIDMap("Global type map", GlobalTypeMap);
7583 dumpModuleIDMap("Global declaration map", GlobalDeclMap);
7584 dumpModuleIDMap("Global identifier map", GlobalIdentifierMap);
7585 dumpModuleIDMap("Global macro map", GlobalMacroMap);
7586 dumpModuleIDMap("Global submodule map", GlobalSubmoduleMap);
7587 dumpModuleIDMap("Global selector map", GlobalSelectorMap);
7588 dumpModuleIDMap("Global preprocessed entity map",
7589 GlobalPreprocessedEntityMap);
7591 llvm::errs() << "\n*** PCH/Modules Loaded:";
7592 for (ModuleFile &M : ModuleMgr)
7596 /// Return the amount of memory used by memory buffers, breaking down
7597 /// by heap-backed versus mmap'ed memory.
7598 void ASTReader::getMemoryBufferSizes(MemoryBufferSizes &sizes) const {
7599 for (ModuleFile &I : ModuleMgr) {
7600 if (llvm::MemoryBuffer *buf = I.Buffer) {
7601 size_t bytes = buf->getBufferSize();
7602 switch (buf->getBufferKind()) {
7603 case llvm::MemoryBuffer::MemoryBuffer_Malloc:
7604 sizes.malloc_bytes += bytes;
7606 case llvm::MemoryBuffer::MemoryBuffer_MMap:
7607 sizes.mmap_bytes += bytes;
7614 void ASTReader::InitializeSema(Sema &S) {
7616 S.addExternalSource(this);
7618 // Makes sure any declarations that were deserialized "too early"
7619 // still get added to the identifier's declaration chains.
7620 for (uint64_t ID : PreloadedDeclIDs) {
7621 NamedDecl *D = cast<NamedDecl>(GetDecl(ID));
7622 pushExternalDeclIntoScope(D, D->getDeclName());
7624 PreloadedDeclIDs.clear();
7626 // FIXME: What happens if these are changed by a module import?
7627 if (!FPPragmaOptions.empty()) {
7628 assert(FPPragmaOptions.size() == 1 && "Wrong number of FP_PRAGMA_OPTIONS");
7629 SemaObj->FPFeatures = FPOptions(FPPragmaOptions[0]);
7632 SemaObj->OpenCLFeatures.copy(OpenCLExtensions);
7633 SemaObj->OpenCLTypeExtMap = OpenCLTypeExtMap;
7634 SemaObj->OpenCLDeclExtMap = OpenCLDeclExtMap;
7639 void ASTReader::UpdateSema() {
7640 assert(SemaObj && "no Sema to update");
7642 // Load the offsets of the declarations that Sema references.
7643 // They will be lazily deserialized when needed.
7644 if (!SemaDeclRefs.empty()) {
7645 assert(SemaDeclRefs.size() % 3 == 0);
7646 for (unsigned I = 0; I != SemaDeclRefs.size(); I += 3) {
7647 if (!SemaObj->StdNamespace)
7648 SemaObj->StdNamespace = SemaDeclRefs[I];
7649 if (!SemaObj->StdBadAlloc)
7650 SemaObj->StdBadAlloc = SemaDeclRefs[I+1];
7651 if (!SemaObj->StdAlignValT)
7652 SemaObj->StdAlignValT = SemaDeclRefs[I+2];
7654 SemaDeclRefs.clear();
7657 // Update the state of pragmas. Use the same API as if we had encountered the
7658 // pragma in the source.
7659 if(OptimizeOffPragmaLocation.isValid())
7660 SemaObj->ActOnPragmaOptimize(/* IsOn = */ false, OptimizeOffPragmaLocation);
7661 if (PragmaMSStructState != -1)
7662 SemaObj->ActOnPragmaMSStruct((PragmaMSStructKind)PragmaMSStructState);
7663 if (PointersToMembersPragmaLocation.isValid()) {
7664 SemaObj->ActOnPragmaMSPointersToMembers(
7665 (LangOptions::PragmaMSPointersToMembersKind)
7666 PragmaMSPointersToMembersState,
7667 PointersToMembersPragmaLocation);
7669 SemaObj->ForceCUDAHostDeviceDepth = ForceCUDAHostDeviceDepth;
7671 if (PragmaPackCurrentValue) {
7672 // The bottom of the stack might have a default value. It must be adjusted
7673 // to the current value to ensure that the packing state is preserved after
7674 // popping entries that were included/imported from a PCH/module.
7675 bool DropFirst = false;
7676 if (!PragmaPackStack.empty() &&
7677 PragmaPackStack.front().Location.isInvalid()) {
7678 assert(PragmaPackStack.front().Value == SemaObj->PackStack.DefaultValue &&
7679 "Expected a default alignment value");
7680 SemaObj->PackStack.Stack.emplace_back(
7681 PragmaPackStack.front().SlotLabel, SemaObj->PackStack.CurrentValue,
7682 SemaObj->PackStack.CurrentPragmaLocation,
7683 PragmaPackStack.front().PushLocation);
7686 for (const auto &Entry :
7687 llvm::makeArrayRef(PragmaPackStack).drop_front(DropFirst ? 1 : 0))
7688 SemaObj->PackStack.Stack.emplace_back(Entry.SlotLabel, Entry.Value,
7689 Entry.Location, Entry.PushLocation);
7690 if (PragmaPackCurrentLocation.isInvalid()) {
7691 assert(*PragmaPackCurrentValue == SemaObj->PackStack.DefaultValue &&
7692 "Expected a default alignment value");
7693 // Keep the current values.
7695 SemaObj->PackStack.CurrentValue = *PragmaPackCurrentValue;
7696 SemaObj->PackStack.CurrentPragmaLocation = PragmaPackCurrentLocation;
7701 IdentifierInfo *ASTReader::get(StringRef Name) {
7702 // Note that we are loading an identifier.
7703 Deserializing AnIdentifier(this);
7705 IdentifierLookupVisitor Visitor(Name, /*PriorGeneration=*/0,
7706 NumIdentifierLookups,
7707 NumIdentifierLookupHits);
7709 // We don't need to do identifier table lookups in C++ modules (we preload
7710 // all interesting declarations, and don't need to use the scope for name
7711 // lookups). Perform the lookup in PCH files, though, since we don't build
7712 // a complete initial identifier table if we're carrying on from a PCH.
7713 if (PP.getLangOpts().CPlusPlus) {
7714 for (auto F : ModuleMgr.pch_modules())
7718 // If there is a global index, look there first to determine which modules
7719 // provably do not have any results for this identifier.
7720 GlobalModuleIndex::HitSet Hits;
7721 GlobalModuleIndex::HitSet *HitsPtr = nullptr;
7722 if (!loadGlobalIndex()) {
7723 if (GlobalIndex->lookupIdentifier(Name, Hits)) {
7728 ModuleMgr.visit(Visitor, HitsPtr);
7731 IdentifierInfo *II = Visitor.getIdentifierInfo();
7732 markIdentifierUpToDate(II);
7738 /// \brief An identifier-lookup iterator that enumerates all of the
7739 /// identifiers stored within a set of AST files.
7740 class ASTIdentifierIterator : public IdentifierIterator {
7741 /// \brief The AST reader whose identifiers are being enumerated.
7742 const ASTReader &Reader;
7744 /// \brief The current index into the chain of AST files stored in
7748 /// \brief The current position within the identifier lookup table
7749 /// of the current AST file.
7750 ASTIdentifierLookupTable::key_iterator Current;
7752 /// \brief The end position within the identifier lookup table of
7753 /// the current AST file.
7754 ASTIdentifierLookupTable::key_iterator End;
7756 /// \brief Whether to skip any modules in the ASTReader.
7760 explicit ASTIdentifierIterator(const ASTReader &Reader,
7761 bool SkipModules = false);
7763 StringRef Next() override;
7766 } // namespace clang
7768 ASTIdentifierIterator::ASTIdentifierIterator(const ASTReader &Reader,
7770 : Reader(Reader), Index(Reader.ModuleMgr.size()), SkipModules(SkipModules) {
7773 StringRef ASTIdentifierIterator::Next() {
7774 while (Current == End) {
7775 // If we have exhausted all of our AST files, we're done.
7780 ModuleFile &F = Reader.ModuleMgr[Index];
7781 if (SkipModules && F.isModule())
7784 ASTIdentifierLookupTable *IdTable =
7785 (ASTIdentifierLookupTable *)F.IdentifierLookupTable;
7786 Current = IdTable->key_begin();
7787 End = IdTable->key_end();
7790 // We have any identifiers remaining in the current AST file; return
7792 StringRef Result = *Current;
7799 /// A utility for appending two IdentifierIterators.
7800 class ChainedIdentifierIterator : public IdentifierIterator {
7801 std::unique_ptr<IdentifierIterator> Current;
7802 std::unique_ptr<IdentifierIterator> Queued;
7805 ChainedIdentifierIterator(std::unique_ptr<IdentifierIterator> First,
7806 std::unique_ptr<IdentifierIterator> Second)
7807 : Current(std::move(First)), Queued(std::move(Second)) {}
7809 StringRef Next() override {
7813 StringRef result = Current->Next();
7814 if (!result.empty())
7817 // Try the queued iterator, which may itself be empty.
7819 std::swap(Current, Queued);
7826 IdentifierIterator *ASTReader::getIdentifiers() {
7827 if (!loadGlobalIndex()) {
7828 std::unique_ptr<IdentifierIterator> ReaderIter(
7829 new ASTIdentifierIterator(*this, /*SkipModules=*/true));
7830 std::unique_ptr<IdentifierIterator> ModulesIter(
7831 GlobalIndex->createIdentifierIterator());
7832 return new ChainedIdentifierIterator(std::move(ReaderIter),
7833 std::move(ModulesIter));
7836 return new ASTIdentifierIterator(*this);
7840 namespace serialization {
7842 class ReadMethodPoolVisitor {
7845 unsigned PriorGeneration;
7846 unsigned InstanceBits = 0;
7847 unsigned FactoryBits = 0;
7848 bool InstanceHasMoreThanOneDecl = false;
7849 bool FactoryHasMoreThanOneDecl = false;
7850 SmallVector<ObjCMethodDecl *, 4> InstanceMethods;
7851 SmallVector<ObjCMethodDecl *, 4> FactoryMethods;
7854 ReadMethodPoolVisitor(ASTReader &Reader, Selector Sel,
7855 unsigned PriorGeneration)
7856 : Reader(Reader), Sel(Sel), PriorGeneration(PriorGeneration) {}
7858 bool operator()(ModuleFile &M) {
7859 if (!M.SelectorLookupTable)
7862 // If we've already searched this module file, skip it now.
7863 if (M.Generation <= PriorGeneration)
7866 ++Reader.NumMethodPoolTableLookups;
7867 ASTSelectorLookupTable *PoolTable
7868 = (ASTSelectorLookupTable*)M.SelectorLookupTable;
7869 ASTSelectorLookupTable::iterator Pos = PoolTable->find(Sel);
7870 if (Pos == PoolTable->end())
7873 ++Reader.NumMethodPoolTableHits;
7874 ++Reader.NumSelectorsRead;
7875 // FIXME: Not quite happy with the statistics here. We probably should
7876 // disable this tracking when called via LoadSelector.
7877 // Also, should entries without methods count as misses?
7878 ++Reader.NumMethodPoolEntriesRead;
7879 ASTSelectorLookupTrait::data_type Data = *Pos;
7880 if (Reader.DeserializationListener)
7881 Reader.DeserializationListener->SelectorRead(Data.ID, Sel);
7883 InstanceMethods.append(Data.Instance.begin(), Data.Instance.end());
7884 FactoryMethods.append(Data.Factory.begin(), Data.Factory.end());
7885 InstanceBits = Data.InstanceBits;
7886 FactoryBits = Data.FactoryBits;
7887 InstanceHasMoreThanOneDecl = Data.InstanceHasMoreThanOneDecl;
7888 FactoryHasMoreThanOneDecl = Data.FactoryHasMoreThanOneDecl;
7892 /// \brief Retrieve the instance methods found by this visitor.
7893 ArrayRef<ObjCMethodDecl *> getInstanceMethods() const {
7894 return InstanceMethods;
7897 /// \brief Retrieve the instance methods found by this visitor.
7898 ArrayRef<ObjCMethodDecl *> getFactoryMethods() const {
7899 return FactoryMethods;
7902 unsigned getInstanceBits() const { return InstanceBits; }
7903 unsigned getFactoryBits() const { return FactoryBits; }
7905 bool instanceHasMoreThanOneDecl() const {
7906 return InstanceHasMoreThanOneDecl;
7909 bool factoryHasMoreThanOneDecl() const { return FactoryHasMoreThanOneDecl; }
7912 } // namespace serialization
7913 } // namespace clang
7915 /// \brief Add the given set of methods to the method list.
7916 static void addMethodsToPool(Sema &S, ArrayRef<ObjCMethodDecl *> Methods,
7917 ObjCMethodList &List) {
7918 for (unsigned I = 0, N = Methods.size(); I != N; ++I) {
7919 S.addMethodToGlobalList(&List, Methods[I]);
7923 void ASTReader::ReadMethodPool(Selector Sel) {
7924 // Get the selector generation and update it to the current generation.
7925 unsigned &Generation = SelectorGeneration[Sel];
7926 unsigned PriorGeneration = Generation;
7927 Generation = getGeneration();
7928 SelectorOutOfDate[Sel] = false;
7930 // Search for methods defined with this selector.
7931 ++NumMethodPoolLookups;
7932 ReadMethodPoolVisitor Visitor(*this, Sel, PriorGeneration);
7933 ModuleMgr.visit(Visitor);
7935 if (Visitor.getInstanceMethods().empty() &&
7936 Visitor.getFactoryMethods().empty())
7939 ++NumMethodPoolHits;
7944 Sema &S = *getSema();
7945 Sema::GlobalMethodPool::iterator Pos
7946 = S.MethodPool.insert(std::make_pair(Sel, Sema::GlobalMethods())).first;
7948 Pos->second.first.setBits(Visitor.getInstanceBits());
7949 Pos->second.first.setHasMoreThanOneDecl(Visitor.instanceHasMoreThanOneDecl());
7950 Pos->second.second.setBits(Visitor.getFactoryBits());
7951 Pos->second.second.setHasMoreThanOneDecl(Visitor.factoryHasMoreThanOneDecl());
7953 // Add methods to the global pool *after* setting hasMoreThanOneDecl, since
7954 // when building a module we keep every method individually and may need to
7955 // update hasMoreThanOneDecl as we add the methods.
7956 addMethodsToPool(S, Visitor.getInstanceMethods(), Pos->second.first);
7957 addMethodsToPool(S, Visitor.getFactoryMethods(), Pos->second.second);
7960 void ASTReader::updateOutOfDateSelector(Selector Sel) {
7961 if (SelectorOutOfDate[Sel])
7962 ReadMethodPool(Sel);
7965 void ASTReader::ReadKnownNamespaces(
7966 SmallVectorImpl<NamespaceDecl *> &Namespaces) {
7969 for (unsigned I = 0, N = KnownNamespaces.size(); I != N; ++I) {
7970 if (NamespaceDecl *Namespace
7971 = dyn_cast_or_null<NamespaceDecl>(GetDecl(KnownNamespaces[I])))
7972 Namespaces.push_back(Namespace);
7976 void ASTReader::ReadUndefinedButUsed(
7977 llvm::MapVector<NamedDecl *, SourceLocation> &Undefined) {
7978 for (unsigned Idx = 0, N = UndefinedButUsed.size(); Idx != N;) {
7979 NamedDecl *D = cast<NamedDecl>(GetDecl(UndefinedButUsed[Idx++]));
7980 SourceLocation Loc =
7981 SourceLocation::getFromRawEncoding(UndefinedButUsed[Idx++]);
7982 Undefined.insert(std::make_pair(D, Loc));
7986 void ASTReader::ReadMismatchingDeleteExpressions(llvm::MapVector<
7987 FieldDecl *, llvm::SmallVector<std::pair<SourceLocation, bool>, 4>> &
7989 for (unsigned Idx = 0, N = DelayedDeleteExprs.size(); Idx != N;) {
7990 FieldDecl *FD = cast<FieldDecl>(GetDecl(DelayedDeleteExprs[Idx++]));
7991 uint64_t Count = DelayedDeleteExprs[Idx++];
7992 for (uint64_t C = 0; C < Count; ++C) {
7993 SourceLocation DeleteLoc =
7994 SourceLocation::getFromRawEncoding(DelayedDeleteExprs[Idx++]);
7995 const bool IsArrayForm = DelayedDeleteExprs[Idx++];
7996 Exprs[FD].push_back(std::make_pair(DeleteLoc, IsArrayForm));
8001 void ASTReader::ReadTentativeDefinitions(
8002 SmallVectorImpl<VarDecl *> &TentativeDefs) {
8003 for (unsigned I = 0, N = TentativeDefinitions.size(); I != N; ++I) {
8004 VarDecl *Var = dyn_cast_or_null<VarDecl>(GetDecl(TentativeDefinitions[I]));
8006 TentativeDefs.push_back(Var);
8008 TentativeDefinitions.clear();
8011 void ASTReader::ReadUnusedFileScopedDecls(
8012 SmallVectorImpl<const DeclaratorDecl *> &Decls) {
8013 for (unsigned I = 0, N = UnusedFileScopedDecls.size(); I != N; ++I) {
8015 = dyn_cast_or_null<DeclaratorDecl>(GetDecl(UnusedFileScopedDecls[I]));
8019 UnusedFileScopedDecls.clear();
8022 void ASTReader::ReadDelegatingConstructors(
8023 SmallVectorImpl<CXXConstructorDecl *> &Decls) {
8024 for (unsigned I = 0, N = DelegatingCtorDecls.size(); I != N; ++I) {
8025 CXXConstructorDecl *D
8026 = dyn_cast_or_null<CXXConstructorDecl>(GetDecl(DelegatingCtorDecls[I]));
8030 DelegatingCtorDecls.clear();
8033 void ASTReader::ReadExtVectorDecls(SmallVectorImpl<TypedefNameDecl *> &Decls) {
8034 for (unsigned I = 0, N = ExtVectorDecls.size(); I != N; ++I) {
8036 = dyn_cast_or_null<TypedefNameDecl>(GetDecl(ExtVectorDecls[I]));
8040 ExtVectorDecls.clear();
8043 void ASTReader::ReadUnusedLocalTypedefNameCandidates(
8044 llvm::SmallSetVector<const TypedefNameDecl *, 4> &Decls) {
8045 for (unsigned I = 0, N = UnusedLocalTypedefNameCandidates.size(); I != N;
8047 TypedefNameDecl *D = dyn_cast_or_null<TypedefNameDecl>(
8048 GetDecl(UnusedLocalTypedefNameCandidates[I]));
8052 UnusedLocalTypedefNameCandidates.clear();
8055 void ASTReader::ReadReferencedSelectors(
8056 SmallVectorImpl<std::pair<Selector, SourceLocation>> &Sels) {
8057 if (ReferencedSelectorsData.empty())
8060 // If there are @selector references added them to its pool. This is for
8061 // implementation of -Wselector.
8062 unsigned int DataSize = ReferencedSelectorsData.size()-1;
8064 while (I < DataSize) {
8065 Selector Sel = DecodeSelector(ReferencedSelectorsData[I++]);
8066 SourceLocation SelLoc
8067 = SourceLocation::getFromRawEncoding(ReferencedSelectorsData[I++]);
8068 Sels.push_back(std::make_pair(Sel, SelLoc));
8070 ReferencedSelectorsData.clear();
8073 void ASTReader::ReadWeakUndeclaredIdentifiers(
8074 SmallVectorImpl<std::pair<IdentifierInfo *, WeakInfo>> &WeakIDs) {
8075 if (WeakUndeclaredIdentifiers.empty())
8078 for (unsigned I = 0, N = WeakUndeclaredIdentifiers.size(); I < N; /*none*/) {
8079 IdentifierInfo *WeakId
8080 = DecodeIdentifierInfo(WeakUndeclaredIdentifiers[I++]);
8081 IdentifierInfo *AliasId
8082 = DecodeIdentifierInfo(WeakUndeclaredIdentifiers[I++]);
8084 = SourceLocation::getFromRawEncoding(WeakUndeclaredIdentifiers[I++]);
8085 bool Used = WeakUndeclaredIdentifiers[I++];
8086 WeakInfo WI(AliasId, Loc);
8088 WeakIDs.push_back(std::make_pair(WeakId, WI));
8090 WeakUndeclaredIdentifiers.clear();
8093 void ASTReader::ReadUsedVTables(SmallVectorImpl<ExternalVTableUse> &VTables) {
8094 for (unsigned Idx = 0, N = VTableUses.size(); Idx < N; /* In loop */) {
8095 ExternalVTableUse VT;
8096 VT.Record = dyn_cast_or_null<CXXRecordDecl>(GetDecl(VTableUses[Idx++]));
8097 VT.Location = SourceLocation::getFromRawEncoding(VTableUses[Idx++]);
8098 VT.DefinitionRequired = VTableUses[Idx++];
8099 VTables.push_back(VT);
8105 void ASTReader::ReadPendingInstantiations(
8106 SmallVectorImpl<std::pair<ValueDecl *, SourceLocation>> &Pending) {
8107 for (unsigned Idx = 0, N = PendingInstantiations.size(); Idx < N;) {
8108 ValueDecl *D = cast<ValueDecl>(GetDecl(PendingInstantiations[Idx++]));
8110 = SourceLocation::getFromRawEncoding(PendingInstantiations[Idx++]);
8112 Pending.push_back(std::make_pair(D, Loc));
8114 PendingInstantiations.clear();
8117 void ASTReader::ReadLateParsedTemplates(
8118 llvm::MapVector<const FunctionDecl *, std::unique_ptr<LateParsedTemplate>>
8120 for (unsigned Idx = 0, N = LateParsedTemplates.size(); Idx < N;
8122 FunctionDecl *FD = cast<FunctionDecl>(GetDecl(LateParsedTemplates[Idx++]));
8124 auto LT = llvm::make_unique<LateParsedTemplate>();
8125 LT->D = GetDecl(LateParsedTemplates[Idx++]);
8127 ModuleFile *F = getOwningModuleFile(LT->D);
8128 assert(F && "No module");
8130 unsigned TokN = LateParsedTemplates[Idx++];
8131 LT->Toks.reserve(TokN);
8132 for (unsigned T = 0; T < TokN; ++T)
8133 LT->Toks.push_back(ReadToken(*F, LateParsedTemplates, Idx));
8135 LPTMap.insert(std::make_pair(FD, std::move(LT)));
8138 LateParsedTemplates.clear();
8141 void ASTReader::LoadSelector(Selector Sel) {
8142 // It would be complicated to avoid reading the methods anyway. So don't.
8143 ReadMethodPool(Sel);
8146 void ASTReader::SetIdentifierInfo(IdentifierID ID, IdentifierInfo *II) {
8147 assert(ID && "Non-zero identifier ID required");
8148 assert(ID <= IdentifiersLoaded.size() && "identifier ID out of range");
8149 IdentifiersLoaded[ID - 1] = II;
8150 if (DeserializationListener)
8151 DeserializationListener->IdentifierRead(ID, II);
8154 /// \brief Set the globally-visible declarations associated with the given
8157 /// If the AST reader is currently in a state where the given declaration IDs
8158 /// cannot safely be resolved, they are queued until it is safe to resolve
8161 /// \param II an IdentifierInfo that refers to one or more globally-visible
8164 /// \param DeclIDs the set of declaration IDs with the name @p II that are
8165 /// visible at global scope.
8167 /// \param Decls if non-null, this vector will be populated with the set of
8168 /// deserialized declarations. These declarations will not be pushed into
8171 ASTReader::SetGloballyVisibleDecls(IdentifierInfo *II,
8172 const SmallVectorImpl<uint32_t> &DeclIDs,
8173 SmallVectorImpl<Decl *> *Decls) {
8174 if (NumCurrentElementsDeserializing && !Decls) {
8175 PendingIdentifierInfos[II].append(DeclIDs.begin(), DeclIDs.end());
8179 for (unsigned I = 0, N = DeclIDs.size(); I != N; ++I) {
8181 // Queue this declaration so that it will be added to the
8182 // translation unit scope and identifier's declaration chain
8183 // once a Sema object is known.
8184 PreloadedDeclIDs.push_back(DeclIDs[I]);
8188 NamedDecl *D = cast<NamedDecl>(GetDecl(DeclIDs[I]));
8190 // If we're simply supposed to record the declarations, do so now.
8192 Decls->push_back(D);
8196 // Introduce this declaration into the translation-unit scope
8197 // and add it to the declaration chain for this identifier, so
8198 // that (unqualified) name lookup will find it.
8199 pushExternalDeclIntoScope(D, II);
8203 IdentifierInfo *ASTReader::DecodeIdentifierInfo(IdentifierID ID) {
8207 if (IdentifiersLoaded.empty()) {
8208 Error("no identifier table in AST file");
8213 if (!IdentifiersLoaded[ID]) {
8214 GlobalIdentifierMapType::iterator I = GlobalIdentifierMap.find(ID + 1);
8215 assert(I != GlobalIdentifierMap.end() && "Corrupted global identifier map");
8216 ModuleFile *M = I->second;
8217 unsigned Index = ID - M->BaseIdentifierID;
8218 const char *Str = M->IdentifierTableData + M->IdentifierOffsets[Index];
8220 // All of the strings in the AST file are preceded by a 16-bit length.
8221 // Extract that 16-bit length to avoid having to execute strlen().
8222 // NOTE: 'StrLenPtr' is an 'unsigned char*' so that we load bytes as
8223 // unsigned integers. This is important to avoid integer overflow when
8224 // we cast them to 'unsigned'.
8225 const unsigned char *StrLenPtr = (const unsigned char*) Str - 2;
8226 unsigned StrLen = (((unsigned) StrLenPtr[0])
8227 | (((unsigned) StrLenPtr[1]) << 8)) - 1;
8228 auto &II = PP.getIdentifierTable().get(StringRef(Str, StrLen));
8229 IdentifiersLoaded[ID] = &II;
8230 markIdentifierFromAST(*this, II);
8231 if (DeserializationListener)
8232 DeserializationListener->IdentifierRead(ID + 1, &II);
8235 return IdentifiersLoaded[ID];
8238 IdentifierInfo *ASTReader::getLocalIdentifier(ModuleFile &M, unsigned LocalID) {
8239 return DecodeIdentifierInfo(getGlobalIdentifierID(M, LocalID));
8242 IdentifierID ASTReader::getGlobalIdentifierID(ModuleFile &M, unsigned LocalID) {
8243 if (LocalID < NUM_PREDEF_IDENT_IDS)
8246 if (!M.ModuleOffsetMap.empty())
8247 ReadModuleOffsetMap(M);
8249 ContinuousRangeMap<uint32_t, int, 2>::iterator I
8250 = M.IdentifierRemap.find(LocalID - NUM_PREDEF_IDENT_IDS);
8251 assert(I != M.IdentifierRemap.end()
8252 && "Invalid index into identifier index remap");
8254 return LocalID + I->second;
8257 MacroInfo *ASTReader::getMacro(MacroID ID) {
8261 if (MacrosLoaded.empty()) {
8262 Error("no macro table in AST file");
8266 ID -= NUM_PREDEF_MACRO_IDS;
8267 if (!MacrosLoaded[ID]) {
8268 GlobalMacroMapType::iterator I
8269 = GlobalMacroMap.find(ID + NUM_PREDEF_MACRO_IDS);
8270 assert(I != GlobalMacroMap.end() && "Corrupted global macro map");
8271 ModuleFile *M = I->second;
8272 unsigned Index = ID - M->BaseMacroID;
8273 MacrosLoaded[ID] = ReadMacroRecord(*M, M->MacroOffsets[Index]);
8275 if (DeserializationListener)
8276 DeserializationListener->MacroRead(ID + NUM_PREDEF_MACRO_IDS,
8280 return MacrosLoaded[ID];
8283 MacroID ASTReader::getGlobalMacroID(ModuleFile &M, unsigned LocalID) {
8284 if (LocalID < NUM_PREDEF_MACRO_IDS)
8287 if (!M.ModuleOffsetMap.empty())
8288 ReadModuleOffsetMap(M);
8290 ContinuousRangeMap<uint32_t, int, 2>::iterator I
8291 = M.MacroRemap.find(LocalID - NUM_PREDEF_MACRO_IDS);
8292 assert(I != M.MacroRemap.end() && "Invalid index into macro index remap");
8294 return LocalID + I->second;
8297 serialization::SubmoduleID
8298 ASTReader::getGlobalSubmoduleID(ModuleFile &M, unsigned LocalID) {
8299 if (LocalID < NUM_PREDEF_SUBMODULE_IDS)
8302 if (!M.ModuleOffsetMap.empty())
8303 ReadModuleOffsetMap(M);
8305 ContinuousRangeMap<uint32_t, int, 2>::iterator I
8306 = M.SubmoduleRemap.find(LocalID - NUM_PREDEF_SUBMODULE_IDS);
8307 assert(I != M.SubmoduleRemap.end()
8308 && "Invalid index into submodule index remap");
8310 return LocalID + I->second;
8313 Module *ASTReader::getSubmodule(SubmoduleID GlobalID) {
8314 if (GlobalID < NUM_PREDEF_SUBMODULE_IDS) {
8315 assert(GlobalID == 0 && "Unhandled global submodule ID");
8319 if (GlobalID > SubmodulesLoaded.size()) {
8320 Error("submodule ID out of range in AST file");
8324 return SubmodulesLoaded[GlobalID - NUM_PREDEF_SUBMODULE_IDS];
8327 Module *ASTReader::getModule(unsigned ID) {
8328 return getSubmodule(ID);
8331 ModuleFile *ASTReader::getLocalModuleFile(ModuleFile &F, unsigned ID) {
8333 // It's a module, look it up by submodule ID.
8334 auto I = GlobalSubmoduleMap.find(getGlobalSubmoduleID(F, ID >> 1));
8335 return I == GlobalSubmoduleMap.end() ? nullptr : I->second;
8337 // It's a prefix (preamble, PCH, ...). Look it up by index.
8338 unsigned IndexFromEnd = ID >> 1;
8339 assert(IndexFromEnd && "got reference to unknown module file");
8340 return getModuleManager().pch_modules().end()[-IndexFromEnd];
8344 unsigned ASTReader::getModuleFileID(ModuleFile *F) {
8348 // For a file representing a module, use the submodule ID of the top-level
8349 // module as the file ID. For any other kind of file, the number of such
8350 // files loaded beforehand will be the same on reload.
8351 // FIXME: Is this true even if we have an explicit module file and a PCH?
8353 return ((F->BaseSubmoduleID + NUM_PREDEF_SUBMODULE_IDS) << 1) | 1;
8355 auto PCHModules = getModuleManager().pch_modules();
8356 auto I = std::find(PCHModules.begin(), PCHModules.end(), F);
8357 assert(I != PCHModules.end() && "emitting reference to unknown file");
8358 return (I - PCHModules.end()) << 1;
8361 llvm::Optional<ExternalASTSource::ASTSourceDescriptor>
8362 ASTReader::getSourceDescriptor(unsigned ID) {
8363 if (const Module *M = getSubmodule(ID))
8364 return ExternalASTSource::ASTSourceDescriptor(*M);
8366 // If there is only a single PCH, return it instead.
8367 // Chained PCH are not supported.
8368 const auto &PCHChain = ModuleMgr.pch_modules();
8369 if (std::distance(std::begin(PCHChain), std::end(PCHChain))) {
8370 ModuleFile &MF = ModuleMgr.getPrimaryModule();
8371 StringRef ModuleName = llvm::sys::path::filename(MF.OriginalSourceFileName);
8372 StringRef FileName = llvm::sys::path::filename(MF.FileName);
8373 return ASTReader::ASTSourceDescriptor(ModuleName, MF.OriginalDir, FileName,
8379 ExternalASTSource::ExtKind ASTReader::hasExternalDefinitions(const Decl *FD) {
8380 auto I = DefinitionSource.find(FD);
8381 if (I == DefinitionSource.end())
8382 return EK_ReplyHazy;
8383 return I->second ? EK_Never : EK_Always;
8386 Selector ASTReader::getLocalSelector(ModuleFile &M, unsigned LocalID) {
8387 return DecodeSelector(getGlobalSelectorID(M, LocalID));
8390 Selector ASTReader::DecodeSelector(serialization::SelectorID ID) {
8394 if (ID > SelectorsLoaded.size()) {
8395 Error("selector ID out of range in AST file");
8399 if (SelectorsLoaded[ID - 1].getAsOpaquePtr() == nullptr) {
8400 // Load this selector from the selector table.
8401 GlobalSelectorMapType::iterator I = GlobalSelectorMap.find(ID);
8402 assert(I != GlobalSelectorMap.end() && "Corrupted global selector map");
8403 ModuleFile &M = *I->second;
8404 ASTSelectorLookupTrait Trait(*this, M);
8405 unsigned Idx = ID - M.BaseSelectorID - NUM_PREDEF_SELECTOR_IDS;
8406 SelectorsLoaded[ID - 1] =
8407 Trait.ReadKey(M.SelectorLookupTableData + M.SelectorOffsets[Idx], 0);
8408 if (DeserializationListener)
8409 DeserializationListener->SelectorRead(ID, SelectorsLoaded[ID - 1]);
8412 return SelectorsLoaded[ID - 1];
8415 Selector ASTReader::GetExternalSelector(serialization::SelectorID ID) {
8416 return DecodeSelector(ID);
8419 uint32_t ASTReader::GetNumExternalSelectors() {
8420 // ID 0 (the null selector) is considered an external selector.
8421 return getTotalNumSelectors() + 1;
8424 serialization::SelectorID
8425 ASTReader::getGlobalSelectorID(ModuleFile &M, unsigned LocalID) const {
8426 if (LocalID < NUM_PREDEF_SELECTOR_IDS)
8429 if (!M.ModuleOffsetMap.empty())
8430 ReadModuleOffsetMap(M);
8432 ContinuousRangeMap<uint32_t, int, 2>::iterator I
8433 = M.SelectorRemap.find(LocalID - NUM_PREDEF_SELECTOR_IDS);
8434 assert(I != M.SelectorRemap.end()
8435 && "Invalid index into selector index remap");
8437 return LocalID + I->second;
8441 ASTReader::ReadDeclarationName(ModuleFile &F,
8442 const RecordData &Record, unsigned &Idx) {
8443 ASTContext &Context = getContext();
8444 DeclarationName::NameKind Kind = (DeclarationName::NameKind)Record[Idx++];
8446 case DeclarationName::Identifier:
8447 return DeclarationName(GetIdentifierInfo(F, Record, Idx));
8449 case DeclarationName::ObjCZeroArgSelector:
8450 case DeclarationName::ObjCOneArgSelector:
8451 case DeclarationName::ObjCMultiArgSelector:
8452 return DeclarationName(ReadSelector(F, Record, Idx));
8454 case DeclarationName::CXXConstructorName:
8455 return Context.DeclarationNames.getCXXConstructorName(
8456 Context.getCanonicalType(readType(F, Record, Idx)));
8458 case DeclarationName::CXXDestructorName:
8459 return Context.DeclarationNames.getCXXDestructorName(
8460 Context.getCanonicalType(readType(F, Record, Idx)));
8462 case DeclarationName::CXXDeductionGuideName:
8463 return Context.DeclarationNames.getCXXDeductionGuideName(
8464 ReadDeclAs<TemplateDecl>(F, Record, Idx));
8466 case DeclarationName::CXXConversionFunctionName:
8467 return Context.DeclarationNames.getCXXConversionFunctionName(
8468 Context.getCanonicalType(readType(F, Record, Idx)));
8470 case DeclarationName::CXXOperatorName:
8471 return Context.DeclarationNames.getCXXOperatorName(
8472 (OverloadedOperatorKind)Record[Idx++]);
8474 case DeclarationName::CXXLiteralOperatorName:
8475 return Context.DeclarationNames.getCXXLiteralOperatorName(
8476 GetIdentifierInfo(F, Record, Idx));
8478 case DeclarationName::CXXUsingDirective:
8479 return DeclarationName::getUsingDirectiveName();
8482 llvm_unreachable("Invalid NameKind!");
8485 void ASTReader::ReadDeclarationNameLoc(ModuleFile &F,
8486 DeclarationNameLoc &DNLoc,
8487 DeclarationName Name,
8488 const RecordData &Record, unsigned &Idx) {
8489 switch (Name.getNameKind()) {
8490 case DeclarationName::CXXConstructorName:
8491 case DeclarationName::CXXDestructorName:
8492 case DeclarationName::CXXConversionFunctionName:
8493 DNLoc.NamedType.TInfo = GetTypeSourceInfo(F, Record, Idx);
8496 case DeclarationName::CXXOperatorName:
8497 DNLoc.CXXOperatorName.BeginOpNameLoc
8498 = ReadSourceLocation(F, Record, Idx).getRawEncoding();
8499 DNLoc.CXXOperatorName.EndOpNameLoc
8500 = ReadSourceLocation(F, Record, Idx).getRawEncoding();
8503 case DeclarationName::CXXLiteralOperatorName:
8504 DNLoc.CXXLiteralOperatorName.OpNameLoc
8505 = ReadSourceLocation(F, Record, Idx).getRawEncoding();
8508 case DeclarationName::Identifier:
8509 case DeclarationName::ObjCZeroArgSelector:
8510 case DeclarationName::ObjCOneArgSelector:
8511 case DeclarationName::ObjCMultiArgSelector:
8512 case DeclarationName::CXXUsingDirective:
8513 case DeclarationName::CXXDeductionGuideName:
8518 void ASTReader::ReadDeclarationNameInfo(ModuleFile &F,
8519 DeclarationNameInfo &NameInfo,
8520 const RecordData &Record, unsigned &Idx) {
8521 NameInfo.setName(ReadDeclarationName(F, Record, Idx));
8522 NameInfo.setLoc(ReadSourceLocation(F, Record, Idx));
8523 DeclarationNameLoc DNLoc;
8524 ReadDeclarationNameLoc(F, DNLoc, NameInfo.getName(), Record, Idx);
8525 NameInfo.setInfo(DNLoc);
8528 void ASTReader::ReadQualifierInfo(ModuleFile &F, QualifierInfo &Info,
8529 const RecordData &Record, unsigned &Idx) {
8530 Info.QualifierLoc = ReadNestedNameSpecifierLoc(F, Record, Idx);
8531 unsigned NumTPLists = Record[Idx++];
8532 Info.NumTemplParamLists = NumTPLists;
8534 Info.TemplParamLists =
8535 new (getContext()) TemplateParameterList *[NumTPLists];
8536 for (unsigned i = 0; i != NumTPLists; ++i)
8537 Info.TemplParamLists[i] = ReadTemplateParameterList(F, Record, Idx);
8542 ASTReader::ReadTemplateName(ModuleFile &F, const RecordData &Record,
8544 ASTContext &Context = getContext();
8545 TemplateName::NameKind Kind = (TemplateName::NameKind)Record[Idx++];
8547 case TemplateName::Template:
8548 return TemplateName(ReadDeclAs<TemplateDecl>(F, Record, Idx));
8550 case TemplateName::OverloadedTemplate: {
8551 unsigned size = Record[Idx++];
8552 UnresolvedSet<8> Decls;
8554 Decls.addDecl(ReadDeclAs<NamedDecl>(F, Record, Idx));
8556 return Context.getOverloadedTemplateName(Decls.begin(), Decls.end());
8559 case TemplateName::QualifiedTemplate: {
8560 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(F, Record, Idx);
8561 bool hasTemplKeyword = Record[Idx++];
8562 TemplateDecl *Template = ReadDeclAs<TemplateDecl>(F, Record, Idx);
8563 return Context.getQualifiedTemplateName(NNS, hasTemplKeyword, Template);
8566 case TemplateName::DependentTemplate: {
8567 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(F, Record, Idx);
8568 if (Record[Idx++]) // isIdentifier
8569 return Context.getDependentTemplateName(NNS,
8570 GetIdentifierInfo(F, Record,
8572 return Context.getDependentTemplateName(NNS,
8573 (OverloadedOperatorKind)Record[Idx++]);
8576 case TemplateName::SubstTemplateTemplateParm: {
8577 TemplateTemplateParmDecl *param
8578 = ReadDeclAs<TemplateTemplateParmDecl>(F, Record, Idx);
8579 if (!param) return TemplateName();
8580 TemplateName replacement = ReadTemplateName(F, Record, Idx);
8581 return Context.getSubstTemplateTemplateParm(param, replacement);
8584 case TemplateName::SubstTemplateTemplateParmPack: {
8585 TemplateTemplateParmDecl *Param
8586 = ReadDeclAs<TemplateTemplateParmDecl>(F, Record, Idx);
8588 return TemplateName();
8590 TemplateArgument ArgPack = ReadTemplateArgument(F, Record, Idx);
8591 if (ArgPack.getKind() != TemplateArgument::Pack)
8592 return TemplateName();
8594 return Context.getSubstTemplateTemplateParmPack(Param, ArgPack);
8598 llvm_unreachable("Unhandled template name kind!");
8601 TemplateArgument ASTReader::ReadTemplateArgument(ModuleFile &F,
8602 const RecordData &Record,
8604 bool Canonicalize) {
8605 ASTContext &Context = getContext();
8607 // The caller wants a canonical template argument. Sometimes the AST only
8608 // wants template arguments in canonical form (particularly as the template
8609 // argument lists of template specializations) so ensure we preserve that
8610 // canonical form across serialization.
8611 TemplateArgument Arg = ReadTemplateArgument(F, Record, Idx, false);
8612 return Context.getCanonicalTemplateArgument(Arg);
8615 TemplateArgument::ArgKind Kind = (TemplateArgument::ArgKind)Record[Idx++];
8617 case TemplateArgument::Null:
8618 return TemplateArgument();
8619 case TemplateArgument::Type:
8620 return TemplateArgument(readType(F, Record, Idx));
8621 case TemplateArgument::Declaration: {
8622 ValueDecl *D = ReadDeclAs<ValueDecl>(F, Record, Idx);
8623 return TemplateArgument(D, readType(F, Record, Idx));
8625 case TemplateArgument::NullPtr:
8626 return TemplateArgument(readType(F, Record, Idx), /*isNullPtr*/true);
8627 case TemplateArgument::Integral: {
8628 llvm::APSInt Value = ReadAPSInt(Record, Idx);
8629 QualType T = readType(F, Record, Idx);
8630 return TemplateArgument(Context, Value, T);
8632 case TemplateArgument::Template:
8633 return TemplateArgument(ReadTemplateName(F, Record, Idx));
8634 case TemplateArgument::TemplateExpansion: {
8635 TemplateName Name = ReadTemplateName(F, Record, Idx);
8636 Optional<unsigned> NumTemplateExpansions;
8637 if (unsigned NumExpansions = Record[Idx++])
8638 NumTemplateExpansions = NumExpansions - 1;
8639 return TemplateArgument(Name, NumTemplateExpansions);
8641 case TemplateArgument::Expression:
8642 return TemplateArgument(ReadExpr(F));
8643 case TemplateArgument::Pack: {
8644 unsigned NumArgs = Record[Idx++];
8645 TemplateArgument *Args = new (Context) TemplateArgument[NumArgs];
8646 for (unsigned I = 0; I != NumArgs; ++I)
8647 Args[I] = ReadTemplateArgument(F, Record, Idx);
8648 return TemplateArgument(llvm::makeArrayRef(Args, NumArgs));
8652 llvm_unreachable("Unhandled template argument kind!");
8655 TemplateParameterList *
8656 ASTReader::ReadTemplateParameterList(ModuleFile &F,
8657 const RecordData &Record, unsigned &Idx) {
8658 SourceLocation TemplateLoc = ReadSourceLocation(F, Record, Idx);
8659 SourceLocation LAngleLoc = ReadSourceLocation(F, Record, Idx);
8660 SourceLocation RAngleLoc = ReadSourceLocation(F, Record, Idx);
8662 unsigned NumParams = Record[Idx++];
8663 SmallVector<NamedDecl *, 16> Params;
8664 Params.reserve(NumParams);
8666 Params.push_back(ReadDeclAs<NamedDecl>(F, Record, Idx));
8669 TemplateParameterList *TemplateParams = TemplateParameterList::Create(
8670 getContext(), TemplateLoc, LAngleLoc, Params, RAngleLoc, nullptr);
8671 return TemplateParams;
8676 ReadTemplateArgumentList(SmallVectorImpl<TemplateArgument> &TemplArgs,
8677 ModuleFile &F, const RecordData &Record,
8678 unsigned &Idx, bool Canonicalize) {
8679 unsigned NumTemplateArgs = Record[Idx++];
8680 TemplArgs.reserve(NumTemplateArgs);
8681 while (NumTemplateArgs--)
8682 TemplArgs.push_back(ReadTemplateArgument(F, Record, Idx, Canonicalize));
8685 /// \brief Read a UnresolvedSet structure.
8686 void ASTReader::ReadUnresolvedSet(ModuleFile &F, LazyASTUnresolvedSet &Set,
8687 const RecordData &Record, unsigned &Idx) {
8688 unsigned NumDecls = Record[Idx++];
8689 Set.reserve(getContext(), NumDecls);
8690 while (NumDecls--) {
8691 DeclID ID = ReadDeclID(F, Record, Idx);
8692 AccessSpecifier AS = (AccessSpecifier)Record[Idx++];
8693 Set.addLazyDecl(getContext(), ID, AS);
8698 ASTReader::ReadCXXBaseSpecifier(ModuleFile &F,
8699 const RecordData &Record, unsigned &Idx) {
8700 bool isVirtual = static_cast<bool>(Record[Idx++]);
8701 bool isBaseOfClass = static_cast<bool>(Record[Idx++]);
8702 AccessSpecifier AS = static_cast<AccessSpecifier>(Record[Idx++]);
8703 bool inheritConstructors = static_cast<bool>(Record[Idx++]);
8704 TypeSourceInfo *TInfo = GetTypeSourceInfo(F, Record, Idx);
8705 SourceRange Range = ReadSourceRange(F, Record, Idx);
8706 SourceLocation EllipsisLoc = ReadSourceLocation(F, Record, Idx);
8707 CXXBaseSpecifier Result(Range, isVirtual, isBaseOfClass, AS, TInfo,
8709 Result.setInheritConstructors(inheritConstructors);
8713 CXXCtorInitializer **
8714 ASTReader::ReadCXXCtorInitializers(ModuleFile &F, const RecordData &Record,
8716 ASTContext &Context = getContext();
8717 unsigned NumInitializers = Record[Idx++];
8718 assert(NumInitializers && "wrote ctor initializers but have no inits");
8719 auto **CtorInitializers = new (Context) CXXCtorInitializer*[NumInitializers];
8720 for (unsigned i = 0; i != NumInitializers; ++i) {
8721 TypeSourceInfo *TInfo = nullptr;
8722 bool IsBaseVirtual = false;
8723 FieldDecl *Member = nullptr;
8724 IndirectFieldDecl *IndirectMember = nullptr;
8726 CtorInitializerType Type = (CtorInitializerType)Record[Idx++];
8728 case CTOR_INITIALIZER_BASE:
8729 TInfo = GetTypeSourceInfo(F, Record, Idx);
8730 IsBaseVirtual = Record[Idx++];
8733 case CTOR_INITIALIZER_DELEGATING:
8734 TInfo = GetTypeSourceInfo(F, Record, Idx);
8737 case CTOR_INITIALIZER_MEMBER:
8738 Member = ReadDeclAs<FieldDecl>(F, Record, Idx);
8741 case CTOR_INITIALIZER_INDIRECT_MEMBER:
8742 IndirectMember = ReadDeclAs<IndirectFieldDecl>(F, Record, Idx);
8746 SourceLocation MemberOrEllipsisLoc = ReadSourceLocation(F, Record, Idx);
8747 Expr *Init = ReadExpr(F);
8748 SourceLocation LParenLoc = ReadSourceLocation(F, Record, Idx);
8749 SourceLocation RParenLoc = ReadSourceLocation(F, Record, Idx);
8751 CXXCtorInitializer *BOMInit;
8752 if (Type == CTOR_INITIALIZER_BASE)
8753 BOMInit = new (Context)
8754 CXXCtorInitializer(Context, TInfo, IsBaseVirtual, LParenLoc, Init,
8755 RParenLoc, MemberOrEllipsisLoc);
8756 else if (Type == CTOR_INITIALIZER_DELEGATING)
8757 BOMInit = new (Context)
8758 CXXCtorInitializer(Context, TInfo, LParenLoc, Init, RParenLoc);
8760 BOMInit = new (Context)
8761 CXXCtorInitializer(Context, Member, MemberOrEllipsisLoc, LParenLoc,
8764 BOMInit = new (Context)
8765 CXXCtorInitializer(Context, IndirectMember, MemberOrEllipsisLoc,
8766 LParenLoc, Init, RParenLoc);
8768 if (/*IsWritten*/Record[Idx++]) {
8769 unsigned SourceOrder = Record[Idx++];
8770 BOMInit->setSourceOrder(SourceOrder);
8773 CtorInitializers[i] = BOMInit;
8776 return CtorInitializers;
8779 NestedNameSpecifier *
8780 ASTReader::ReadNestedNameSpecifier(ModuleFile &F,
8781 const RecordData &Record, unsigned &Idx) {
8782 ASTContext &Context = getContext();
8783 unsigned N = Record[Idx++];
8784 NestedNameSpecifier *NNS = nullptr, *Prev = nullptr;
8785 for (unsigned I = 0; I != N; ++I) {
8786 NestedNameSpecifier::SpecifierKind Kind
8787 = (NestedNameSpecifier::SpecifierKind)Record[Idx++];
8789 case NestedNameSpecifier::Identifier: {
8790 IdentifierInfo *II = GetIdentifierInfo(F, Record, Idx);
8791 NNS = NestedNameSpecifier::Create(Context, Prev, II);
8795 case NestedNameSpecifier::Namespace: {
8796 NamespaceDecl *NS = ReadDeclAs<NamespaceDecl>(F, Record, Idx);
8797 NNS = NestedNameSpecifier::Create(Context, Prev, NS);
8801 case NestedNameSpecifier::NamespaceAlias: {
8802 NamespaceAliasDecl *Alias =ReadDeclAs<NamespaceAliasDecl>(F, Record, Idx);
8803 NNS = NestedNameSpecifier::Create(Context, Prev, Alias);
8807 case NestedNameSpecifier::TypeSpec:
8808 case NestedNameSpecifier::TypeSpecWithTemplate: {
8809 const Type *T = readType(F, Record, Idx).getTypePtrOrNull();
8813 bool Template = Record[Idx++];
8814 NNS = NestedNameSpecifier::Create(Context, Prev, Template, T);
8818 case NestedNameSpecifier::Global:
8819 NNS = NestedNameSpecifier::GlobalSpecifier(Context);
8820 // No associated value, and there can't be a prefix.
8823 case NestedNameSpecifier::Super: {
8824 CXXRecordDecl *RD = ReadDeclAs<CXXRecordDecl>(F, Record, Idx);
8825 NNS = NestedNameSpecifier::SuperSpecifier(Context, RD);
8834 NestedNameSpecifierLoc
8835 ASTReader::ReadNestedNameSpecifierLoc(ModuleFile &F, const RecordData &Record,
8837 ASTContext &Context = getContext();
8838 unsigned N = Record[Idx++];
8839 NestedNameSpecifierLocBuilder Builder;
8840 for (unsigned I = 0; I != N; ++I) {
8841 NestedNameSpecifier::SpecifierKind Kind
8842 = (NestedNameSpecifier::SpecifierKind)Record[Idx++];
8844 case NestedNameSpecifier::Identifier: {
8845 IdentifierInfo *II = GetIdentifierInfo(F, Record, Idx);
8846 SourceRange Range = ReadSourceRange(F, Record, Idx);
8847 Builder.Extend(Context, II, Range.getBegin(), Range.getEnd());
8851 case NestedNameSpecifier::Namespace: {
8852 NamespaceDecl *NS = ReadDeclAs<NamespaceDecl>(F, Record, Idx);
8853 SourceRange Range = ReadSourceRange(F, Record, Idx);
8854 Builder.Extend(Context, NS, Range.getBegin(), Range.getEnd());
8858 case NestedNameSpecifier::NamespaceAlias: {
8859 NamespaceAliasDecl *Alias =ReadDeclAs<NamespaceAliasDecl>(F, Record, Idx);
8860 SourceRange Range = ReadSourceRange(F, Record, Idx);
8861 Builder.Extend(Context, Alias, Range.getBegin(), Range.getEnd());
8865 case NestedNameSpecifier::TypeSpec:
8866 case NestedNameSpecifier::TypeSpecWithTemplate: {
8867 bool Template = Record[Idx++];
8868 TypeSourceInfo *T = GetTypeSourceInfo(F, Record, Idx);
8870 return NestedNameSpecifierLoc();
8871 SourceLocation ColonColonLoc = ReadSourceLocation(F, Record, Idx);
8873 // FIXME: 'template' keyword location not saved anywhere, so we fake it.
8874 Builder.Extend(Context,
8875 Template? T->getTypeLoc().getBeginLoc() : SourceLocation(),
8876 T->getTypeLoc(), ColonColonLoc);
8880 case NestedNameSpecifier::Global: {
8881 SourceLocation ColonColonLoc = ReadSourceLocation(F, Record, Idx);
8882 Builder.MakeGlobal(Context, ColonColonLoc);
8886 case NestedNameSpecifier::Super: {
8887 CXXRecordDecl *RD = ReadDeclAs<CXXRecordDecl>(F, Record, Idx);
8888 SourceRange Range = ReadSourceRange(F, Record, Idx);
8889 Builder.MakeSuper(Context, RD, Range.getBegin(), Range.getEnd());
8895 return Builder.getWithLocInContext(Context);
8899 ASTReader::ReadSourceRange(ModuleFile &F, const RecordData &Record,
8901 SourceLocation beg = ReadSourceLocation(F, Record, Idx);
8902 SourceLocation end = ReadSourceLocation(F, Record, Idx);
8903 return SourceRange(beg, end);
8906 /// \brief Read an integral value
8907 llvm::APInt ASTReader::ReadAPInt(const RecordData &Record, unsigned &Idx) {
8908 unsigned BitWidth = Record[Idx++];
8909 unsigned NumWords = llvm::APInt::getNumWords(BitWidth);
8910 llvm::APInt Result(BitWidth, NumWords, &Record[Idx]);
8915 /// \brief Read a signed integral value
8916 llvm::APSInt ASTReader::ReadAPSInt(const RecordData &Record, unsigned &Idx) {
8917 bool isUnsigned = Record[Idx++];
8918 return llvm::APSInt(ReadAPInt(Record, Idx), isUnsigned);
8921 /// \brief Read a floating-point value
8922 llvm::APFloat ASTReader::ReadAPFloat(const RecordData &Record,
8923 const llvm::fltSemantics &Sem,
8925 return llvm::APFloat(Sem, ReadAPInt(Record, Idx));
8928 // \brief Read a string
8929 std::string ASTReader::ReadString(const RecordData &Record, unsigned &Idx) {
8930 unsigned Len = Record[Idx++];
8931 std::string Result(Record.data() + Idx, Record.data() + Idx + Len);
8936 std::string ASTReader::ReadPath(ModuleFile &F, const RecordData &Record,
8938 std::string Filename = ReadString(Record, Idx);
8939 ResolveImportedPath(F, Filename);
8943 VersionTuple ASTReader::ReadVersionTuple(const RecordData &Record,
8945 unsigned Major = Record[Idx++];
8946 unsigned Minor = Record[Idx++];
8947 unsigned Subminor = Record[Idx++];
8949 return VersionTuple(Major);
8951 return VersionTuple(Major, Minor - 1);
8952 return VersionTuple(Major, Minor - 1, Subminor - 1);
8955 CXXTemporary *ASTReader::ReadCXXTemporary(ModuleFile &F,
8956 const RecordData &Record,
8958 CXXDestructorDecl *Decl = ReadDeclAs<CXXDestructorDecl>(F, Record, Idx);
8959 return CXXTemporary::Create(getContext(), Decl);
8962 DiagnosticBuilder ASTReader::Diag(unsigned DiagID) const {
8963 return Diag(CurrentImportLoc, DiagID);
8966 DiagnosticBuilder ASTReader::Diag(SourceLocation Loc, unsigned DiagID) const {
8967 return Diags.Report(Loc, DiagID);
8970 /// \brief Retrieve the identifier table associated with the
8972 IdentifierTable &ASTReader::getIdentifierTable() {
8973 return PP.getIdentifierTable();
8976 /// \brief Record that the given ID maps to the given switch-case
8978 void ASTReader::RecordSwitchCaseID(SwitchCase *SC, unsigned ID) {
8979 assert((*CurrSwitchCaseStmts)[ID] == nullptr &&
8980 "Already have a SwitchCase with this ID");
8981 (*CurrSwitchCaseStmts)[ID] = SC;
8984 /// \brief Retrieve the switch-case statement with the given ID.
8985 SwitchCase *ASTReader::getSwitchCaseWithID(unsigned ID) {
8986 assert((*CurrSwitchCaseStmts)[ID] != nullptr && "No SwitchCase with this ID");
8987 return (*CurrSwitchCaseStmts)[ID];
8990 void ASTReader::ClearSwitchCaseIDs() {
8991 CurrSwitchCaseStmts->clear();
8994 void ASTReader::ReadComments() {
8995 ASTContext &Context = getContext();
8996 std::vector<RawComment *> Comments;
8997 for (SmallVectorImpl<std::pair<BitstreamCursor,
8998 serialization::ModuleFile *>>::iterator
8999 I = CommentsCursors.begin(),
9000 E = CommentsCursors.end();
9003 BitstreamCursor &Cursor = I->first;
9004 serialization::ModuleFile &F = *I->second;
9005 SavedStreamPosition SavedPosition(Cursor);
9009 llvm::BitstreamEntry Entry =
9010 Cursor.advanceSkippingSubblocks(BitstreamCursor::AF_DontPopBlockAtEnd);
9012 switch (Entry.Kind) {
9013 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
9014 case llvm::BitstreamEntry::Error:
9015 Error("malformed block record in AST file");
9017 case llvm::BitstreamEntry::EndBlock:
9019 case llvm::BitstreamEntry::Record:
9020 // The interesting case.
9026 switch ((CommentRecordTypes)Cursor.readRecord(Entry.ID, Record)) {
9027 case COMMENTS_RAW_COMMENT: {
9029 SourceRange SR = ReadSourceRange(F, Record, Idx);
9030 RawComment::CommentKind Kind =
9031 (RawComment::CommentKind) Record[Idx++];
9032 bool IsTrailingComment = Record[Idx++];
9033 bool IsAlmostTrailingComment = Record[Idx++];
9034 Comments.push_back(new (Context) RawComment(
9035 SR, Kind, IsTrailingComment, IsAlmostTrailingComment,
9036 Context.getLangOpts().CommentOpts.ParseAllComments));
9042 // De-serialized SourceLocations get negative FileIDs for other modules,
9043 // potentially invalidating the original order. Sort it again.
9044 std::sort(Comments.begin(), Comments.end(),
9045 BeforeThanCompare<RawComment>(SourceMgr));
9046 Context.Comments.addDeserializedComments(Comments);
9050 void ASTReader::visitInputFiles(serialization::ModuleFile &MF,
9051 bool IncludeSystem, bool Complain,
9052 llvm::function_ref<void(const serialization::InputFile &IF,
9053 bool isSystem)> Visitor) {
9054 unsigned NumUserInputs = MF.NumUserInputFiles;
9055 unsigned NumInputs = MF.InputFilesLoaded.size();
9056 assert(NumUserInputs <= NumInputs);
9057 unsigned N = IncludeSystem ? NumInputs : NumUserInputs;
9058 for (unsigned I = 0; I < N; ++I) {
9059 bool IsSystem = I >= NumUserInputs;
9060 InputFile IF = getInputFile(MF, I+1, Complain);
9061 Visitor(IF, IsSystem);
9065 void ASTReader::visitTopLevelModuleMaps(
9066 serialization::ModuleFile &MF,
9067 llvm::function_ref<void(const FileEntry *FE)> Visitor) {
9068 unsigned NumInputs = MF.InputFilesLoaded.size();
9069 for (unsigned I = 0; I < NumInputs; ++I) {
9070 InputFileInfo IFI = readInputFileInfo(MF, I + 1);
9071 if (IFI.TopLevelModuleMap)
9072 // FIXME: This unnecessarily re-reads the InputFileInfo.
9073 if (auto *FE = getInputFile(MF, I + 1).getFile())
9078 std::string ASTReader::getOwningModuleNameForDiagnostic(const Decl *D) {
9079 // If we know the owning module, use it.
9080 if (Module *M = D->getImportedOwningModule())
9081 return M->getFullModuleName();
9083 // Otherwise, use the name of the top-level module the decl is within.
9084 if (ModuleFile *M = getOwningModuleFile(D))
9085 return M->ModuleName;
9087 // Not from a module.
9091 void ASTReader::finishPendingActions() {
9092 while (!PendingIdentifierInfos.empty() ||
9093 !PendingIncompleteDeclChains.empty() || !PendingDeclChains.empty() ||
9094 !PendingMacroIDs.empty() || !PendingDeclContextInfos.empty() ||
9095 !PendingUpdateRecords.empty()) {
9096 // If any identifiers with corresponding top-level declarations have
9097 // been loaded, load those declarations now.
9098 using TopLevelDeclsMap =
9099 llvm::DenseMap<IdentifierInfo *, SmallVector<Decl *, 2>>;
9100 TopLevelDeclsMap TopLevelDecls;
9102 while (!PendingIdentifierInfos.empty()) {
9103 IdentifierInfo *II = PendingIdentifierInfos.back().first;
9104 SmallVector<uint32_t, 4> DeclIDs =
9105 std::move(PendingIdentifierInfos.back().second);
9106 PendingIdentifierInfos.pop_back();
9108 SetGloballyVisibleDecls(II, DeclIDs, &TopLevelDecls[II]);
9111 // For each decl chain that we wanted to complete while deserializing, mark
9112 // it as "still needs to be completed".
9113 for (unsigned I = 0; I != PendingIncompleteDeclChains.size(); ++I) {
9114 markIncompleteDeclChain(PendingIncompleteDeclChains[I]);
9116 PendingIncompleteDeclChains.clear();
9118 // Load pending declaration chains.
9119 for (unsigned I = 0; I != PendingDeclChains.size(); ++I)
9120 loadPendingDeclChain(PendingDeclChains[I].first, PendingDeclChains[I].second);
9121 PendingDeclChains.clear();
9123 // Make the most recent of the top-level declarations visible.
9124 for (TopLevelDeclsMap::iterator TLD = TopLevelDecls.begin(),
9125 TLDEnd = TopLevelDecls.end(); TLD != TLDEnd; ++TLD) {
9126 IdentifierInfo *II = TLD->first;
9127 for (unsigned I = 0, N = TLD->second.size(); I != N; ++I) {
9128 pushExternalDeclIntoScope(cast<NamedDecl>(TLD->second[I]), II);
9132 // Load any pending macro definitions.
9133 for (unsigned I = 0; I != PendingMacroIDs.size(); ++I) {
9134 IdentifierInfo *II = PendingMacroIDs.begin()[I].first;
9135 SmallVector<PendingMacroInfo, 2> GlobalIDs;
9136 GlobalIDs.swap(PendingMacroIDs.begin()[I].second);
9137 // Initialize the macro history from chained-PCHs ahead of module imports.
9138 for (unsigned IDIdx = 0, NumIDs = GlobalIDs.size(); IDIdx != NumIDs;
9140 const PendingMacroInfo &Info = GlobalIDs[IDIdx];
9141 if (!Info.M->isModule())
9142 resolvePendingMacro(II, Info);
9144 // Handle module imports.
9145 for (unsigned IDIdx = 0, NumIDs = GlobalIDs.size(); IDIdx != NumIDs;
9147 const PendingMacroInfo &Info = GlobalIDs[IDIdx];
9148 if (Info.M->isModule())
9149 resolvePendingMacro(II, Info);
9152 PendingMacroIDs.clear();
9154 // Wire up the DeclContexts for Decls that we delayed setting until
9155 // recursive loading is completed.
9156 while (!PendingDeclContextInfos.empty()) {
9157 PendingDeclContextInfo Info = PendingDeclContextInfos.front();
9158 PendingDeclContextInfos.pop_front();
9159 DeclContext *SemaDC = cast<DeclContext>(GetDecl(Info.SemaDC));
9160 DeclContext *LexicalDC = cast<DeclContext>(GetDecl(Info.LexicalDC));
9161 Info.D->setDeclContextsImpl(SemaDC, LexicalDC, getContext());
9164 // Perform any pending declaration updates.
9165 while (!PendingUpdateRecords.empty()) {
9166 auto Update = PendingUpdateRecords.pop_back_val();
9167 ReadingKindTracker ReadingKind(Read_Decl, *this);
9168 loadDeclUpdateRecords(Update);
9172 // At this point, all update records for loaded decls are in place, so any
9173 // fake class definitions should have become real.
9174 assert(PendingFakeDefinitionData.empty() &&
9175 "faked up a class definition but never saw the real one");
9177 // If we deserialized any C++ or Objective-C class definitions, any
9178 // Objective-C protocol definitions, or any redeclarable templates, make sure
9179 // that all redeclarations point to the definitions. Note that this can only
9180 // happen now, after the redeclaration chains have been fully wired.
9181 for (Decl *D : PendingDefinitions) {
9182 if (TagDecl *TD = dyn_cast<TagDecl>(D)) {
9183 if (const TagType *TagT = dyn_cast<TagType>(TD->getTypeForDecl())) {
9184 // Make sure that the TagType points at the definition.
9185 const_cast<TagType*>(TagT)->decl = TD;
9188 if (auto RD = dyn_cast<CXXRecordDecl>(D)) {
9189 for (auto *R = getMostRecentExistingDecl(RD); R;
9190 R = R->getPreviousDecl()) {
9192 cast<CXXRecordDecl>(R)->isThisDeclarationADefinition() &&
9193 "declaration thinks it's the definition but it isn't");
9194 cast<CXXRecordDecl>(R)->DefinitionData = RD->DefinitionData;
9201 if (auto ID = dyn_cast<ObjCInterfaceDecl>(D)) {
9202 // Make sure that the ObjCInterfaceType points at the definition.
9203 const_cast<ObjCInterfaceType *>(cast<ObjCInterfaceType>(ID->TypeForDecl))
9206 for (auto *R = getMostRecentExistingDecl(ID); R; R = R->getPreviousDecl())
9207 cast<ObjCInterfaceDecl>(R)->Data = ID->Data;
9212 if (auto PD = dyn_cast<ObjCProtocolDecl>(D)) {
9213 for (auto *R = getMostRecentExistingDecl(PD); R; R = R->getPreviousDecl())
9214 cast<ObjCProtocolDecl>(R)->Data = PD->Data;
9219 auto RTD = cast<RedeclarableTemplateDecl>(D)->getCanonicalDecl();
9220 for (auto *R = getMostRecentExistingDecl(RTD); R; R = R->getPreviousDecl())
9221 cast<RedeclarableTemplateDecl>(R)->Common = RTD->Common;
9223 PendingDefinitions.clear();
9225 // Load the bodies of any functions or methods we've encountered. We do
9226 // this now (delayed) so that we can be sure that the declaration chains
9227 // have been fully wired up (hasBody relies on this).
9228 // FIXME: We shouldn't require complete redeclaration chains here.
9229 for (PendingBodiesMap::iterator PB = PendingBodies.begin(),
9230 PBEnd = PendingBodies.end();
9231 PB != PBEnd; ++PB) {
9232 if (FunctionDecl *FD = dyn_cast<FunctionDecl>(PB->first)) {
9233 // FIXME: Check for =delete/=default?
9234 // FIXME: Complain about ODR violations here?
9235 const FunctionDecl *Defn = nullptr;
9236 if (!getContext().getLangOpts().Modules || !FD->hasBody(Defn)) {
9237 FD->setLazyBody(PB->second);
9239 auto *NonConstDefn = const_cast<FunctionDecl*>(Defn);
9240 mergeDefinitionVisibility(NonConstDefn, FD);
9242 if (!FD->isLateTemplateParsed() &&
9243 !NonConstDefn->isLateTemplateParsed() &&
9244 FD->getODRHash() != NonConstDefn->getODRHash()) {
9245 PendingFunctionOdrMergeFailures[FD].push_back(NonConstDefn);
9251 ObjCMethodDecl *MD = cast<ObjCMethodDecl>(PB->first);
9252 if (!getContext().getLangOpts().Modules || !MD->hasBody())
9253 MD->setLazyBody(PB->second);
9255 PendingBodies.clear();
9258 for (auto *ND : PendingMergedDefinitionsToDeduplicate)
9259 getContext().deduplicateMergedDefinitonsFor(ND);
9260 PendingMergedDefinitionsToDeduplicate.clear();
9263 void ASTReader::diagnoseOdrViolations() {
9264 if (PendingOdrMergeFailures.empty() && PendingOdrMergeChecks.empty() &&
9265 PendingFunctionOdrMergeFailures.empty())
9268 // Trigger the import of the full definition of each class that had any
9269 // odr-merging problems, so we can produce better diagnostics for them.
9270 // These updates may in turn find and diagnose some ODR failures, so take
9271 // ownership of the set first.
9272 auto OdrMergeFailures = std::move(PendingOdrMergeFailures);
9273 PendingOdrMergeFailures.clear();
9274 for (auto &Merge : OdrMergeFailures) {
9275 Merge.first->buildLookup();
9276 Merge.first->decls_begin();
9277 Merge.first->bases_begin();
9278 Merge.first->vbases_begin();
9279 for (auto &RecordPair : Merge.second) {
9280 auto *RD = RecordPair.first;
9287 // Trigger the import of functions.
9288 auto FunctionOdrMergeFailures = std::move(PendingFunctionOdrMergeFailures);
9289 PendingFunctionOdrMergeFailures.clear();
9290 for (auto &Merge : FunctionOdrMergeFailures) {
9291 Merge.first->buildLookup();
9292 Merge.first->decls_begin();
9293 Merge.first->getBody();
9294 for (auto &FD : Merge.second) {
9301 // For each declaration from a merged context, check that the canonical
9302 // definition of that context also contains a declaration of the same
9305 // Caution: this loop does things that might invalidate iterators into
9306 // PendingOdrMergeChecks. Don't turn this into a range-based for loop!
9307 while (!PendingOdrMergeChecks.empty()) {
9308 NamedDecl *D = PendingOdrMergeChecks.pop_back_val();
9310 // FIXME: Skip over implicit declarations for now. This matters for things
9311 // like implicitly-declared special member functions. This isn't entirely
9312 // correct; we can end up with multiple unmerged declarations of the same
9314 if (D->isImplicit())
9317 DeclContext *CanonDef = D->getDeclContext();
9320 const Decl *DCanon = D->getCanonicalDecl();
9322 for (auto RI : D->redecls()) {
9323 if (RI->getLexicalDeclContext() == CanonDef) {
9331 // Quick check failed, time to do the slow thing. Note, we can't just
9332 // look up the name of D in CanonDef here, because the member that is
9333 // in CanonDef might not be found by name lookup (it might have been
9334 // replaced by a more recent declaration in the lookup table), and we
9335 // can't necessarily find it in the redeclaration chain because it might
9336 // be merely mergeable, not redeclarable.
9337 llvm::SmallVector<const NamedDecl*, 4> Candidates;
9338 for (auto *CanonMember : CanonDef->decls()) {
9339 if (CanonMember->getCanonicalDecl() == DCanon) {
9340 // This can happen if the declaration is merely mergeable and not
9341 // actually redeclarable (we looked for redeclarations earlier).
9343 // FIXME: We should be able to detect this more efficiently, without
9344 // pulling in all of the members of CanonDef.
9348 if (auto *ND = dyn_cast<NamedDecl>(CanonMember))
9349 if (ND->getDeclName() == D->getDeclName())
9350 Candidates.push_back(ND);
9354 // The AST doesn't like TagDecls becoming invalid after they've been
9355 // completed. We only really need to mark FieldDecls as invalid here.
9356 if (!isa<TagDecl>(D))
9357 D->setInvalidDecl();
9359 // Ensure we don't accidentally recursively enter deserialization while
9360 // we're producing our diagnostic.
9361 Deserializing RecursionGuard(this);
9363 std::string CanonDefModule =
9364 getOwningModuleNameForDiagnostic(cast<Decl>(CanonDef));
9365 Diag(D->getLocation(), diag::err_module_odr_violation_missing_decl)
9366 << D << getOwningModuleNameForDiagnostic(D)
9367 << CanonDef << CanonDefModule.empty() << CanonDefModule;
9369 if (Candidates.empty())
9370 Diag(cast<Decl>(CanonDef)->getLocation(),
9371 diag::note_module_odr_violation_no_possible_decls) << D;
9373 for (unsigned I = 0, N = Candidates.size(); I != N; ++I)
9374 Diag(Candidates[I]->getLocation(),
9375 diag::note_module_odr_violation_possible_decl)
9379 DiagnosedOdrMergeFailures.insert(CanonDef);
9383 if (OdrMergeFailures.empty() && FunctionOdrMergeFailures.empty())
9386 // Ensure we don't accidentally recursively enter deserialization while
9387 // we're producing our diagnostics.
9388 Deserializing RecursionGuard(this);
9390 // Common code for hashing helpers.
9392 auto ComputeQualTypeODRHash = [&Hash](QualType Ty) {
9394 Hash.AddQualType(Ty);
9395 return Hash.CalculateHash();
9398 auto ComputeODRHash = [&Hash](const Stmt *S) {
9402 return Hash.CalculateHash();
9405 auto ComputeSubDeclODRHash = [&Hash](const Decl *D) {
9409 return Hash.CalculateHash();
9412 // Issue any pending ODR-failure diagnostics.
9413 for (auto &Merge : OdrMergeFailures) {
9414 // If we've already pointed out a specific problem with this class, don't
9415 // bother issuing a general "something's different" diagnostic.
9416 if (!DiagnosedOdrMergeFailures.insert(Merge.first).second)
9419 bool Diagnosed = false;
9420 CXXRecordDecl *FirstRecord = Merge.first;
9421 std::string FirstModule = getOwningModuleNameForDiagnostic(FirstRecord);
9422 for (auto &RecordPair : Merge.second) {
9423 CXXRecordDecl *SecondRecord = RecordPair.first;
9424 // Multiple different declarations got merged together; tell the user
9425 // where they came from.
9426 if (FirstRecord == SecondRecord)
9429 std::string SecondModule = getOwningModuleNameForDiagnostic(SecondRecord);
9431 auto *FirstDD = FirstRecord->DefinitionData;
9432 auto *SecondDD = RecordPair.second;
9434 assert(FirstDD && SecondDD && "Definitions without DefinitionData");
9436 // Diagnostics from DefinitionData are emitted here.
9437 if (FirstDD != SecondDD) {
9438 enum ODRDefinitionDataDifference {
9445 auto ODRDiagError = [FirstRecord, &FirstModule,
9446 this](SourceLocation Loc, SourceRange Range,
9447 ODRDefinitionDataDifference DiffType) {
9448 return Diag(Loc, diag::err_module_odr_violation_definition_data)
9449 << FirstRecord << FirstModule.empty() << FirstModule << Range
9452 auto ODRDiagNote = [&SecondModule,
9453 this](SourceLocation Loc, SourceRange Range,
9454 ODRDefinitionDataDifference DiffType) {
9455 return Diag(Loc, diag::note_module_odr_violation_definition_data)
9456 << SecondModule << Range << DiffType;
9459 unsigned FirstNumBases = FirstDD->NumBases;
9460 unsigned FirstNumVBases = FirstDD->NumVBases;
9461 unsigned SecondNumBases = SecondDD->NumBases;
9462 unsigned SecondNumVBases = SecondDD->NumVBases;
9464 auto GetSourceRange = [](struct CXXRecordDecl::DefinitionData *DD) {
9465 unsigned NumBases = DD->NumBases;
9466 if (NumBases == 0) return SourceRange();
9467 auto bases = DD->bases();
9468 return SourceRange(bases[0].getLocStart(),
9469 bases[NumBases - 1].getLocEnd());
9472 if (FirstNumBases != SecondNumBases) {
9473 ODRDiagError(FirstRecord->getLocation(), GetSourceRange(FirstDD),
9476 ODRDiagNote(SecondRecord->getLocation(), GetSourceRange(SecondDD),
9483 if (FirstNumVBases != SecondNumVBases) {
9484 ODRDiagError(FirstRecord->getLocation(), GetSourceRange(FirstDD),
9487 ODRDiagNote(SecondRecord->getLocation(), GetSourceRange(SecondDD),
9494 auto FirstBases = FirstDD->bases();
9495 auto SecondBases = SecondDD->bases();
9497 for (i = 0; i < FirstNumBases; ++i) {
9498 auto FirstBase = FirstBases[i];
9499 auto SecondBase = SecondBases[i];
9500 if (ComputeQualTypeODRHash(FirstBase.getType()) !=
9501 ComputeQualTypeODRHash(SecondBase.getType())) {
9502 ODRDiagError(FirstRecord->getLocation(), FirstBase.getSourceRange(),
9504 << (i + 1) << FirstBase.getType();
9505 ODRDiagNote(SecondRecord->getLocation(),
9506 SecondBase.getSourceRange(), BaseType)
9507 << (i + 1) << SecondBase.getType();
9511 if (FirstBase.isVirtual() != SecondBase.isVirtual()) {
9512 ODRDiagError(FirstRecord->getLocation(), FirstBase.getSourceRange(),
9514 << (i + 1) << FirstBase.isVirtual() << FirstBase.getType();
9515 ODRDiagNote(SecondRecord->getLocation(),
9516 SecondBase.getSourceRange(), BaseVirtual)
9517 << (i + 1) << SecondBase.isVirtual() << SecondBase.getType();
9521 if (FirstBase.getAccessSpecifierAsWritten() !=
9522 SecondBase.getAccessSpecifierAsWritten()) {
9523 ODRDiagError(FirstRecord->getLocation(), FirstBase.getSourceRange(),
9525 << (i + 1) << FirstBase.getType()
9526 << (int)FirstBase.getAccessSpecifierAsWritten();
9527 ODRDiagNote(SecondRecord->getLocation(),
9528 SecondBase.getSourceRange(), BaseAccess)
9529 << (i + 1) << SecondBase.getType()
9530 << (int)SecondBase.getAccessSpecifierAsWritten();
9535 if (i != FirstNumBases) {
9541 using DeclHashes = llvm::SmallVector<std::pair<Decl *, unsigned>, 4>;
9543 const ClassTemplateDecl *FirstTemplate =
9544 FirstRecord->getDescribedClassTemplate();
9545 const ClassTemplateDecl *SecondTemplate =
9546 SecondRecord->getDescribedClassTemplate();
9548 assert(!FirstTemplate == !SecondTemplate &&
9549 "Both pointers should be null or non-null");
9551 enum ODRTemplateDifference {
9554 ParamSingleDefaultArgument,
9555 ParamDifferentDefaultArgument,
9558 if (FirstTemplate && SecondTemplate) {
9559 DeclHashes FirstTemplateHashes;
9560 DeclHashes SecondTemplateHashes;
9562 auto PopulateTemplateParameterHashs =
9563 [&ComputeSubDeclODRHash](DeclHashes &Hashes,
9564 const ClassTemplateDecl *TD) {
9565 for (auto *D : TD->getTemplateParameters()->asArray()) {
9566 Hashes.emplace_back(D, ComputeSubDeclODRHash(D));
9570 PopulateTemplateParameterHashs(FirstTemplateHashes, FirstTemplate);
9571 PopulateTemplateParameterHashs(SecondTemplateHashes, SecondTemplate);
9573 assert(FirstTemplateHashes.size() == SecondTemplateHashes.size() &&
9574 "Number of template parameters should be equal.");
9576 auto FirstIt = FirstTemplateHashes.begin();
9577 auto FirstEnd = FirstTemplateHashes.end();
9578 auto SecondIt = SecondTemplateHashes.begin();
9579 for (; FirstIt != FirstEnd; ++FirstIt, ++SecondIt) {
9580 if (FirstIt->second == SecondIt->second)
9583 auto ODRDiagError = [FirstRecord, &FirstModule,
9584 this](SourceLocation Loc, SourceRange Range,
9585 ODRTemplateDifference DiffType) {
9586 return Diag(Loc, diag::err_module_odr_violation_template_parameter)
9587 << FirstRecord << FirstModule.empty() << FirstModule << Range
9590 auto ODRDiagNote = [&SecondModule,
9591 this](SourceLocation Loc, SourceRange Range,
9592 ODRTemplateDifference DiffType) {
9593 return Diag(Loc, diag::note_module_odr_violation_template_parameter)
9594 << SecondModule << Range << DiffType;
9597 const NamedDecl* FirstDecl = cast<NamedDecl>(FirstIt->first);
9598 const NamedDecl* SecondDecl = cast<NamedDecl>(SecondIt->first);
9600 assert(FirstDecl->getKind() == SecondDecl->getKind() &&
9601 "Parameter Decl's should be the same kind.");
9603 DeclarationName FirstName = FirstDecl->getDeclName();
9604 DeclarationName SecondName = SecondDecl->getDeclName();
9606 if (FirstName != SecondName) {
9607 const bool FirstNameEmpty =
9608 FirstName.isIdentifier() && !FirstName.getAsIdentifierInfo();
9609 const bool SecondNameEmpty =
9610 SecondName.isIdentifier() && !SecondName.getAsIdentifierInfo();
9611 assert((!FirstNameEmpty || !SecondNameEmpty) &&
9612 "Both template parameters cannot be unnamed.");
9613 ODRDiagError(FirstDecl->getLocation(), FirstDecl->getSourceRange(),
9614 FirstNameEmpty ? ParamEmptyName : ParamName)
9616 ODRDiagNote(SecondDecl->getLocation(), SecondDecl->getSourceRange(),
9617 SecondNameEmpty ? ParamEmptyName : ParamName)
9622 switch (FirstDecl->getKind()) {
9624 llvm_unreachable("Invalid template parameter type.");
9625 case Decl::TemplateTypeParm: {
9626 const auto *FirstParam = cast<TemplateTypeParmDecl>(FirstDecl);
9627 const auto *SecondParam = cast<TemplateTypeParmDecl>(SecondDecl);
9628 const bool HasFirstDefaultArgument =
9629 FirstParam->hasDefaultArgument() &&
9630 !FirstParam->defaultArgumentWasInherited();
9631 const bool HasSecondDefaultArgument =
9632 SecondParam->hasDefaultArgument() &&
9633 !SecondParam->defaultArgumentWasInherited();
9635 if (HasFirstDefaultArgument != HasSecondDefaultArgument) {
9636 ODRDiagError(FirstDecl->getLocation(),
9637 FirstDecl->getSourceRange(),
9638 ParamSingleDefaultArgument)
9639 << HasFirstDefaultArgument;
9640 ODRDiagNote(SecondDecl->getLocation(),
9641 SecondDecl->getSourceRange(),
9642 ParamSingleDefaultArgument)
9643 << HasSecondDefaultArgument;
9647 assert(HasFirstDefaultArgument && HasSecondDefaultArgument &&
9648 "Expecting default arguments.");
9650 ODRDiagError(FirstDecl->getLocation(), FirstDecl->getSourceRange(),
9651 ParamDifferentDefaultArgument);
9652 ODRDiagNote(SecondDecl->getLocation(), SecondDecl->getSourceRange(),
9653 ParamDifferentDefaultArgument);
9657 case Decl::NonTypeTemplateParm: {
9658 const auto *FirstParam = cast<NonTypeTemplateParmDecl>(FirstDecl);
9659 const auto *SecondParam = cast<NonTypeTemplateParmDecl>(SecondDecl);
9660 const bool HasFirstDefaultArgument =
9661 FirstParam->hasDefaultArgument() &&
9662 !FirstParam->defaultArgumentWasInherited();
9663 const bool HasSecondDefaultArgument =
9664 SecondParam->hasDefaultArgument() &&
9665 !SecondParam->defaultArgumentWasInherited();
9667 if (HasFirstDefaultArgument != HasSecondDefaultArgument) {
9668 ODRDiagError(FirstDecl->getLocation(),
9669 FirstDecl->getSourceRange(),
9670 ParamSingleDefaultArgument)
9671 << HasFirstDefaultArgument;
9672 ODRDiagNote(SecondDecl->getLocation(),
9673 SecondDecl->getSourceRange(),
9674 ParamSingleDefaultArgument)
9675 << HasSecondDefaultArgument;
9679 assert(HasFirstDefaultArgument && HasSecondDefaultArgument &&
9680 "Expecting default arguments.");
9682 ODRDiagError(FirstDecl->getLocation(), FirstDecl->getSourceRange(),
9683 ParamDifferentDefaultArgument);
9684 ODRDiagNote(SecondDecl->getLocation(), SecondDecl->getSourceRange(),
9685 ParamDifferentDefaultArgument);
9689 case Decl::TemplateTemplateParm: {
9690 const auto *FirstParam = cast<TemplateTemplateParmDecl>(FirstDecl);
9691 const auto *SecondParam =
9692 cast<TemplateTemplateParmDecl>(SecondDecl);
9693 const bool HasFirstDefaultArgument =
9694 FirstParam->hasDefaultArgument() &&
9695 !FirstParam->defaultArgumentWasInherited();
9696 const bool HasSecondDefaultArgument =
9697 SecondParam->hasDefaultArgument() &&
9698 !SecondParam->defaultArgumentWasInherited();
9700 if (HasFirstDefaultArgument != HasSecondDefaultArgument) {
9701 ODRDiagError(FirstDecl->getLocation(),
9702 FirstDecl->getSourceRange(),
9703 ParamSingleDefaultArgument)
9704 << HasFirstDefaultArgument;
9705 ODRDiagNote(SecondDecl->getLocation(),
9706 SecondDecl->getSourceRange(),
9707 ParamSingleDefaultArgument)
9708 << HasSecondDefaultArgument;
9712 assert(HasFirstDefaultArgument && HasSecondDefaultArgument &&
9713 "Expecting default arguments.");
9715 ODRDiagError(FirstDecl->getLocation(), FirstDecl->getSourceRange(),
9716 ParamDifferentDefaultArgument);
9717 ODRDiagNote(SecondDecl->getLocation(), SecondDecl->getSourceRange(),
9718 ParamDifferentDefaultArgument);
9727 if (FirstIt != FirstEnd) {
9733 DeclHashes FirstHashes;
9734 DeclHashes SecondHashes;
9736 auto PopulateHashes = [&ComputeSubDeclODRHash, FirstRecord](
9737 DeclHashes &Hashes, CXXRecordDecl *Record) {
9738 for (auto *D : Record->decls()) {
9739 // Due to decl merging, the first CXXRecordDecl is the parent of
9740 // Decls in both records.
9741 if (!ODRHash::isWhitelistedDecl(D, FirstRecord))
9743 Hashes.emplace_back(D, ComputeSubDeclODRHash(D));
9746 PopulateHashes(FirstHashes, FirstRecord);
9747 PopulateHashes(SecondHashes, SecondRecord);
9749 // Used with err_module_odr_violation_mismatch_decl and
9750 // note_module_odr_violation_mismatch_decl
9751 // This list should be the same Decl's as in ODRHash::isWhiteListedDecl
9765 } FirstDiffType = Other,
9766 SecondDiffType = Other;
9768 auto DifferenceSelector = [](Decl *D) {
9769 assert(D && "valid Decl required");
9770 switch (D->getKind()) {
9773 case Decl::AccessSpec:
9774 switch (D->getAccess()) {
9776 return PublicSpecifer;
9778 return PrivateSpecifer;
9780 return ProtectedSpecifer;
9784 llvm_unreachable("Invalid access specifier");
9785 case Decl::StaticAssert:
9786 return StaticAssert;
9789 case Decl::CXXMethod:
9790 case Decl::CXXConstructor:
9791 case Decl::CXXDestructor:
9793 case Decl::TypeAlias:
9804 Decl *FirstDecl = nullptr;
9805 Decl *SecondDecl = nullptr;
9806 auto FirstIt = FirstHashes.begin();
9807 auto SecondIt = SecondHashes.begin();
9809 // If there is a diagnoseable difference, FirstDiffType and
9810 // SecondDiffType will not be Other and FirstDecl and SecondDecl will be
9811 // filled in if not EndOfClass.
9812 while (FirstIt != FirstHashes.end() || SecondIt != SecondHashes.end()) {
9813 if (FirstIt != FirstHashes.end() && SecondIt != SecondHashes.end() &&
9814 FirstIt->second == SecondIt->second) {
9820 FirstDecl = FirstIt == FirstHashes.end() ? nullptr : FirstIt->first;
9821 SecondDecl = SecondIt == SecondHashes.end() ? nullptr : SecondIt->first;
9823 FirstDiffType = FirstDecl ? DifferenceSelector(FirstDecl) : EndOfClass;
9825 SecondDecl ? DifferenceSelector(SecondDecl) : EndOfClass;
9830 if (FirstDiffType == Other || SecondDiffType == Other) {
9831 // Reaching this point means an unexpected Decl was encountered
9832 // or no difference was detected. This causes a generic error
9833 // message to be emitted.
9834 Diag(FirstRecord->getLocation(),
9835 diag::err_module_odr_violation_different_definitions)
9836 << FirstRecord << FirstModule.empty() << FirstModule;
9839 Diag(FirstDecl->getLocation(), diag::note_first_module_difference)
9840 << FirstRecord << FirstDecl->getSourceRange();
9843 Diag(SecondRecord->getLocation(),
9844 diag::note_module_odr_violation_different_definitions)
9848 Diag(SecondDecl->getLocation(), diag::note_second_module_difference)
9849 << SecondDecl->getSourceRange();
9856 if (FirstDiffType != SecondDiffType) {
9857 SourceLocation FirstLoc;
9858 SourceRange FirstRange;
9859 if (FirstDiffType == EndOfClass) {
9860 FirstLoc = FirstRecord->getBraceRange().getEnd();
9862 FirstLoc = FirstIt->first->getLocation();
9863 FirstRange = FirstIt->first->getSourceRange();
9865 Diag(FirstLoc, diag::err_module_odr_violation_mismatch_decl)
9866 << FirstRecord << FirstModule.empty() << FirstModule << FirstRange
9869 SourceLocation SecondLoc;
9870 SourceRange SecondRange;
9871 if (SecondDiffType == EndOfClass) {
9872 SecondLoc = SecondRecord->getBraceRange().getEnd();
9874 SecondLoc = SecondDecl->getLocation();
9875 SecondRange = SecondDecl->getSourceRange();
9877 Diag(SecondLoc, diag::note_module_odr_violation_mismatch_decl)
9878 << SecondModule << SecondRange << SecondDiffType;
9883 assert(FirstDiffType == SecondDiffType);
9885 // Used with err_module_odr_violation_mismatch_decl_diff and
9886 // note_module_odr_violation_mismatch_decl_diff
9887 enum ODRDeclDifference{
9888 StaticAssertCondition,
9889 StaticAssertMessage,
9890 StaticAssertOnlyMessage,
9893 FieldSingleBitField,
9894 FieldDifferentWidthBitField,
9896 FieldSingleInitializer,
9897 FieldDifferentInitializers,
9905 MethodNumberParameters,
9906 MethodParameterType,
9907 MethodParameterName,
9908 MethodParameterSingleDefaultArgument,
9909 MethodParameterDifferentDefaultArgument,
9914 VarSingleInitializer,
9915 VarDifferentInitializer,
9922 // These lambdas have the common portions of the ODR diagnostics. This
9923 // has the same return as Diag(), so addition parameters can be passed
9924 // in with operator<<
9925 auto ODRDiagError = [FirstRecord, &FirstModule, this](
9926 SourceLocation Loc, SourceRange Range, ODRDeclDifference DiffType) {
9927 return Diag(Loc, diag::err_module_odr_violation_mismatch_decl_diff)
9928 << FirstRecord << FirstModule.empty() << FirstModule << Range
9931 auto ODRDiagNote = [&SecondModule, this](
9932 SourceLocation Loc, SourceRange Range, ODRDeclDifference DiffType) {
9933 return Diag(Loc, diag::note_module_odr_violation_mismatch_decl_diff)
9934 << SecondModule << Range << DiffType;
9937 switch (FirstDiffType) {
9940 case PublicSpecifer:
9941 case PrivateSpecifer:
9942 case ProtectedSpecifer:
9943 llvm_unreachable("Invalid diff type");
9945 case StaticAssert: {
9946 StaticAssertDecl *FirstSA = cast<StaticAssertDecl>(FirstDecl);
9947 StaticAssertDecl *SecondSA = cast<StaticAssertDecl>(SecondDecl);
9949 Expr *FirstExpr = FirstSA->getAssertExpr();
9950 Expr *SecondExpr = SecondSA->getAssertExpr();
9951 unsigned FirstODRHash = ComputeODRHash(FirstExpr);
9952 unsigned SecondODRHash = ComputeODRHash(SecondExpr);
9953 if (FirstODRHash != SecondODRHash) {
9954 ODRDiagError(FirstExpr->getLocStart(), FirstExpr->getSourceRange(),
9955 StaticAssertCondition);
9956 ODRDiagNote(SecondExpr->getLocStart(),
9957 SecondExpr->getSourceRange(), StaticAssertCondition);
9962 StringLiteral *FirstStr = FirstSA->getMessage();
9963 StringLiteral *SecondStr = SecondSA->getMessage();
9964 assert((FirstStr || SecondStr) && "Both messages cannot be empty");
9965 if ((FirstStr && !SecondStr) || (!FirstStr && SecondStr)) {
9966 SourceLocation FirstLoc, SecondLoc;
9967 SourceRange FirstRange, SecondRange;
9969 FirstLoc = FirstStr->getLocStart();
9970 FirstRange = FirstStr->getSourceRange();
9972 FirstLoc = FirstSA->getLocStart();
9973 FirstRange = FirstSA->getSourceRange();
9976 SecondLoc = SecondStr->getLocStart();
9977 SecondRange = SecondStr->getSourceRange();
9979 SecondLoc = SecondSA->getLocStart();
9980 SecondRange = SecondSA->getSourceRange();
9982 ODRDiagError(FirstLoc, FirstRange, StaticAssertOnlyMessage)
9983 << (FirstStr == nullptr);
9984 ODRDiagNote(SecondLoc, SecondRange, StaticAssertOnlyMessage)
9985 << (SecondStr == nullptr);
9990 if (FirstStr && SecondStr &&
9991 FirstStr->getString() != SecondStr->getString()) {
9992 ODRDiagError(FirstStr->getLocStart(), FirstStr->getSourceRange(),
9993 StaticAssertMessage);
9994 ODRDiagNote(SecondStr->getLocStart(), SecondStr->getSourceRange(),
9995 StaticAssertMessage);
10002 FieldDecl *FirstField = cast<FieldDecl>(FirstDecl);
10003 FieldDecl *SecondField = cast<FieldDecl>(SecondDecl);
10004 IdentifierInfo *FirstII = FirstField->getIdentifier();
10005 IdentifierInfo *SecondII = SecondField->getIdentifier();
10006 if (FirstII->getName() != SecondII->getName()) {
10007 ODRDiagError(FirstField->getLocation(), FirstField->getSourceRange(),
10010 ODRDiagNote(SecondField->getLocation(), SecondField->getSourceRange(),
10018 assert(getContext().hasSameType(FirstField->getType(),
10019 SecondField->getType()));
10021 QualType FirstType = FirstField->getType();
10022 QualType SecondType = SecondField->getType();
10023 if (ComputeQualTypeODRHash(FirstType) !=
10024 ComputeQualTypeODRHash(SecondType)) {
10025 ODRDiagError(FirstField->getLocation(), FirstField->getSourceRange(),
10027 << FirstII << FirstType;
10028 ODRDiagNote(SecondField->getLocation(), SecondField->getSourceRange(),
10030 << SecondII << SecondType;
10036 const bool IsFirstBitField = FirstField->isBitField();
10037 const bool IsSecondBitField = SecondField->isBitField();
10038 if (IsFirstBitField != IsSecondBitField) {
10039 ODRDiagError(FirstField->getLocation(), FirstField->getSourceRange(),
10040 FieldSingleBitField)
10041 << FirstII << IsFirstBitField;
10042 ODRDiagNote(SecondField->getLocation(), SecondField->getSourceRange(),
10043 FieldSingleBitField)
10044 << SecondII << IsSecondBitField;
10049 if (IsFirstBitField && IsSecondBitField) {
10050 ODRDiagError(FirstField->getLocation(), FirstField->getSourceRange(),
10051 FieldDifferentWidthBitField)
10052 << FirstII << FirstField->getBitWidth()->getSourceRange();
10053 ODRDiagNote(SecondField->getLocation(), SecondField->getSourceRange(),
10054 FieldDifferentWidthBitField)
10055 << SecondII << SecondField->getBitWidth()->getSourceRange();
10060 const bool IsFirstMutable = FirstField->isMutable();
10061 const bool IsSecondMutable = SecondField->isMutable();
10062 if (IsFirstMutable != IsSecondMutable) {
10063 ODRDiagError(FirstField->getLocation(), FirstField->getSourceRange(),
10064 FieldSingleMutable)
10065 << FirstII << IsFirstMutable;
10066 ODRDiagNote(SecondField->getLocation(), SecondField->getSourceRange(),
10067 FieldSingleMutable)
10068 << SecondII << IsSecondMutable;
10073 const Expr *FirstInitializer = FirstField->getInClassInitializer();
10074 const Expr *SecondInitializer = SecondField->getInClassInitializer();
10075 if ((!FirstInitializer && SecondInitializer) ||
10076 (FirstInitializer && !SecondInitializer)) {
10077 ODRDiagError(FirstField->getLocation(), FirstField->getSourceRange(),
10078 FieldSingleInitializer)
10079 << FirstII << (FirstInitializer != nullptr);
10080 ODRDiagNote(SecondField->getLocation(), SecondField->getSourceRange(),
10081 FieldSingleInitializer)
10082 << SecondII << (SecondInitializer != nullptr);
10087 if (FirstInitializer && SecondInitializer) {
10088 unsigned FirstInitHash = ComputeODRHash(FirstInitializer);
10089 unsigned SecondInitHash = ComputeODRHash(SecondInitializer);
10090 if (FirstInitHash != SecondInitHash) {
10091 ODRDiagError(FirstField->getLocation(),
10092 FirstField->getSourceRange(),
10093 FieldDifferentInitializers)
10094 << FirstII << FirstInitializer->getSourceRange();
10095 ODRDiagNote(SecondField->getLocation(),
10096 SecondField->getSourceRange(),
10097 FieldDifferentInitializers)
10098 << SecondII << SecondInitializer->getSourceRange();
10113 auto GetMethodTypeForDiagnostics = [](const CXXMethodDecl* D) {
10114 if (isa<CXXConstructorDecl>(D)) return DiagConstructor;
10115 if (isa<CXXDestructorDecl>(D)) return DiagDestructor;
10118 const CXXMethodDecl *FirstMethod = cast<CXXMethodDecl>(FirstDecl);
10119 const CXXMethodDecl *SecondMethod = cast<CXXMethodDecl>(SecondDecl);
10120 FirstMethodType = GetMethodTypeForDiagnostics(FirstMethod);
10121 SecondMethodType = GetMethodTypeForDiagnostics(SecondMethod);
10122 auto FirstName = FirstMethod->getDeclName();
10123 auto SecondName = SecondMethod->getDeclName();
10124 if (FirstMethodType != SecondMethodType || FirstName != SecondName) {
10125 ODRDiagError(FirstMethod->getLocation(),
10126 FirstMethod->getSourceRange(), MethodName)
10127 << FirstMethodType << FirstName;
10128 ODRDiagNote(SecondMethod->getLocation(),
10129 SecondMethod->getSourceRange(), MethodName)
10130 << SecondMethodType << SecondName;
10136 const bool FirstDeleted = FirstMethod->isDeleted();
10137 const bool SecondDeleted = SecondMethod->isDeleted();
10138 if (FirstDeleted != SecondDeleted) {
10139 ODRDiagError(FirstMethod->getLocation(),
10140 FirstMethod->getSourceRange(), MethodDeleted)
10141 << FirstMethodType << FirstName << FirstDeleted;
10143 ODRDiagNote(SecondMethod->getLocation(),
10144 SecondMethod->getSourceRange(), MethodDeleted)
10145 << SecondMethodType << SecondName << SecondDeleted;
10150 const bool FirstVirtual = FirstMethod->isVirtualAsWritten();
10151 const bool SecondVirtual = SecondMethod->isVirtualAsWritten();
10152 const bool FirstPure = FirstMethod->isPure();
10153 const bool SecondPure = SecondMethod->isPure();
10154 if ((FirstVirtual || SecondVirtual) &&
10155 (FirstVirtual != SecondVirtual || FirstPure != SecondPure)) {
10156 ODRDiagError(FirstMethod->getLocation(),
10157 FirstMethod->getSourceRange(), MethodVirtual)
10158 << FirstMethodType << FirstName << FirstPure << FirstVirtual;
10159 ODRDiagNote(SecondMethod->getLocation(),
10160 SecondMethod->getSourceRange(), MethodVirtual)
10161 << SecondMethodType << SecondName << SecondPure << SecondVirtual;
10166 // CXXMethodDecl::isStatic uses the canonical Decl. With Decl merging,
10167 // FirstDecl is the canonical Decl of SecondDecl, so the storage
10168 // class needs to be checked instead.
10169 const auto FirstStorage = FirstMethod->getStorageClass();
10170 const auto SecondStorage = SecondMethod->getStorageClass();
10171 const bool FirstStatic = FirstStorage == SC_Static;
10172 const bool SecondStatic = SecondStorage == SC_Static;
10173 if (FirstStatic != SecondStatic) {
10174 ODRDiagError(FirstMethod->getLocation(),
10175 FirstMethod->getSourceRange(), MethodStatic)
10176 << FirstMethodType << FirstName << FirstStatic;
10177 ODRDiagNote(SecondMethod->getLocation(),
10178 SecondMethod->getSourceRange(), MethodStatic)
10179 << SecondMethodType << SecondName << SecondStatic;
10184 const bool FirstVolatile = FirstMethod->isVolatile();
10185 const bool SecondVolatile = SecondMethod->isVolatile();
10186 if (FirstVolatile != SecondVolatile) {
10187 ODRDiagError(FirstMethod->getLocation(),
10188 FirstMethod->getSourceRange(), MethodVolatile)
10189 << FirstMethodType << FirstName << FirstVolatile;
10190 ODRDiagNote(SecondMethod->getLocation(),
10191 SecondMethod->getSourceRange(), MethodVolatile)
10192 << SecondMethodType << SecondName << SecondVolatile;
10197 const bool FirstConst = FirstMethod->isConst();
10198 const bool SecondConst = SecondMethod->isConst();
10199 if (FirstConst != SecondConst) {
10200 ODRDiagError(FirstMethod->getLocation(),
10201 FirstMethod->getSourceRange(), MethodConst)
10202 << FirstMethodType << FirstName << FirstConst;
10203 ODRDiagNote(SecondMethod->getLocation(),
10204 SecondMethod->getSourceRange(), MethodConst)
10205 << SecondMethodType << SecondName << SecondConst;
10210 const bool FirstInline = FirstMethod->isInlineSpecified();
10211 const bool SecondInline = SecondMethod->isInlineSpecified();
10212 if (FirstInline != SecondInline) {
10213 ODRDiagError(FirstMethod->getLocation(),
10214 FirstMethod->getSourceRange(), MethodInline)
10215 << FirstMethodType << FirstName << FirstInline;
10216 ODRDiagNote(SecondMethod->getLocation(),
10217 SecondMethod->getSourceRange(), MethodInline)
10218 << SecondMethodType << SecondName << SecondInline;
10223 const unsigned FirstNumParameters = FirstMethod->param_size();
10224 const unsigned SecondNumParameters = SecondMethod->param_size();
10225 if (FirstNumParameters != SecondNumParameters) {
10226 ODRDiagError(FirstMethod->getLocation(),
10227 FirstMethod->getSourceRange(), MethodNumberParameters)
10228 << FirstMethodType << FirstName << FirstNumParameters;
10229 ODRDiagNote(SecondMethod->getLocation(),
10230 SecondMethod->getSourceRange(), MethodNumberParameters)
10231 << SecondMethodType << SecondName << SecondNumParameters;
10236 // Need this status boolean to know when break out of the switch.
10237 bool ParameterMismatch = false;
10238 for (unsigned I = 0; I < FirstNumParameters; ++I) {
10239 const ParmVarDecl *FirstParam = FirstMethod->getParamDecl(I);
10240 const ParmVarDecl *SecondParam = SecondMethod->getParamDecl(I);
10242 QualType FirstParamType = FirstParam->getType();
10243 QualType SecondParamType = SecondParam->getType();
10244 if (FirstParamType != SecondParamType &&
10245 ComputeQualTypeODRHash(FirstParamType) !=
10246 ComputeQualTypeODRHash(SecondParamType)) {
10247 if (const DecayedType *ParamDecayedType =
10248 FirstParamType->getAs<DecayedType>()) {
10249 ODRDiagError(FirstMethod->getLocation(),
10250 FirstMethod->getSourceRange(), MethodParameterType)
10251 << FirstMethodType << FirstName << (I + 1) << FirstParamType
10252 << true << ParamDecayedType->getOriginalType();
10254 ODRDiagError(FirstMethod->getLocation(),
10255 FirstMethod->getSourceRange(), MethodParameterType)
10256 << FirstMethodType << FirstName << (I + 1) << FirstParamType
10260 if (const DecayedType *ParamDecayedType =
10261 SecondParamType->getAs<DecayedType>()) {
10262 ODRDiagNote(SecondMethod->getLocation(),
10263 SecondMethod->getSourceRange(), MethodParameterType)
10264 << SecondMethodType << SecondName << (I + 1)
10265 << SecondParamType << true
10266 << ParamDecayedType->getOriginalType();
10268 ODRDiagNote(SecondMethod->getLocation(),
10269 SecondMethod->getSourceRange(), MethodParameterType)
10270 << SecondMethodType << SecondName << (I + 1)
10271 << SecondParamType << false;
10273 ParameterMismatch = true;
10277 DeclarationName FirstParamName = FirstParam->getDeclName();
10278 DeclarationName SecondParamName = SecondParam->getDeclName();
10279 if (FirstParamName != SecondParamName) {
10280 ODRDiagError(FirstMethod->getLocation(),
10281 FirstMethod->getSourceRange(), MethodParameterName)
10282 << FirstMethodType << FirstName << (I + 1) << FirstParamName;
10283 ODRDiagNote(SecondMethod->getLocation(),
10284 SecondMethod->getSourceRange(), MethodParameterName)
10285 << SecondMethodType << SecondName << (I + 1) << SecondParamName;
10286 ParameterMismatch = true;
10290 const Expr *FirstInit = FirstParam->getInit();
10291 const Expr *SecondInit = SecondParam->getInit();
10292 if ((FirstInit == nullptr) != (SecondInit == nullptr)) {
10293 ODRDiagError(FirstMethod->getLocation(),
10294 FirstMethod->getSourceRange(),
10295 MethodParameterSingleDefaultArgument)
10296 << FirstMethodType << FirstName << (I + 1)
10297 << (FirstInit == nullptr)
10298 << (FirstInit ? FirstInit->getSourceRange() : SourceRange());
10299 ODRDiagNote(SecondMethod->getLocation(),
10300 SecondMethod->getSourceRange(),
10301 MethodParameterSingleDefaultArgument)
10302 << SecondMethodType << SecondName << (I + 1)
10303 << (SecondInit == nullptr)
10304 << (SecondInit ? SecondInit->getSourceRange() : SourceRange());
10305 ParameterMismatch = true;
10309 if (FirstInit && SecondInit &&
10310 ComputeODRHash(FirstInit) != ComputeODRHash(SecondInit)) {
10311 ODRDiagError(FirstMethod->getLocation(),
10312 FirstMethod->getSourceRange(),
10313 MethodParameterDifferentDefaultArgument)
10314 << FirstMethodType << FirstName << (I + 1)
10315 << FirstInit->getSourceRange();
10316 ODRDiagNote(SecondMethod->getLocation(),
10317 SecondMethod->getSourceRange(),
10318 MethodParameterDifferentDefaultArgument)
10319 << SecondMethodType << SecondName << (I + 1)
10320 << SecondInit->getSourceRange();
10321 ParameterMismatch = true;
10327 if (ParameterMismatch) {
10336 TypedefNameDecl *FirstTD = cast<TypedefNameDecl>(FirstDecl);
10337 TypedefNameDecl *SecondTD = cast<TypedefNameDecl>(SecondDecl);
10338 auto FirstName = FirstTD->getDeclName();
10339 auto SecondName = SecondTD->getDeclName();
10340 if (FirstName != SecondName) {
10341 ODRDiagError(FirstTD->getLocation(), FirstTD->getSourceRange(),
10343 << (FirstDiffType == TypeAlias) << FirstName;
10344 ODRDiagNote(SecondTD->getLocation(), SecondTD->getSourceRange(),
10346 << (FirstDiffType == TypeAlias) << SecondName;
10351 QualType FirstType = FirstTD->getUnderlyingType();
10352 QualType SecondType = SecondTD->getUnderlyingType();
10353 if (ComputeQualTypeODRHash(FirstType) !=
10354 ComputeQualTypeODRHash(SecondType)) {
10355 ODRDiagError(FirstTD->getLocation(), FirstTD->getSourceRange(),
10357 << (FirstDiffType == TypeAlias) << FirstName << FirstType;
10358 ODRDiagNote(SecondTD->getLocation(), SecondTD->getSourceRange(),
10360 << (FirstDiffType == TypeAlias) << SecondName << SecondType;
10367 VarDecl *FirstVD = cast<VarDecl>(FirstDecl);
10368 VarDecl *SecondVD = cast<VarDecl>(SecondDecl);
10369 auto FirstName = FirstVD->getDeclName();
10370 auto SecondName = SecondVD->getDeclName();
10371 if (FirstName != SecondName) {
10372 ODRDiagError(FirstVD->getLocation(), FirstVD->getSourceRange(),
10375 ODRDiagNote(SecondVD->getLocation(), SecondVD->getSourceRange(),
10382 QualType FirstType = FirstVD->getType();
10383 QualType SecondType = SecondVD->getType();
10384 if (ComputeQualTypeODRHash(FirstType) !=
10385 ComputeQualTypeODRHash(SecondType)) {
10386 ODRDiagError(FirstVD->getLocation(), FirstVD->getSourceRange(),
10388 << FirstName << FirstType;
10389 ODRDiagNote(SecondVD->getLocation(), SecondVD->getSourceRange(),
10391 << SecondName << SecondType;
10396 const Expr *FirstInit = FirstVD->getInit();
10397 const Expr *SecondInit = SecondVD->getInit();
10398 if ((FirstInit == nullptr) != (SecondInit == nullptr)) {
10399 ODRDiagError(FirstVD->getLocation(), FirstVD->getSourceRange(),
10400 VarSingleInitializer)
10401 << FirstName << (FirstInit == nullptr)
10402 << (FirstInit ? FirstInit->getSourceRange(): SourceRange());
10403 ODRDiagNote(SecondVD->getLocation(), SecondVD->getSourceRange(),
10404 VarSingleInitializer)
10405 << SecondName << (SecondInit == nullptr)
10406 << (SecondInit ? SecondInit->getSourceRange() : SourceRange());
10411 if (FirstInit && SecondInit &&
10412 ComputeODRHash(FirstInit) != ComputeODRHash(SecondInit)) {
10413 ODRDiagError(FirstVD->getLocation(), FirstVD->getSourceRange(),
10414 VarDifferentInitializer)
10415 << FirstName << FirstInit->getSourceRange();
10416 ODRDiagNote(SecondVD->getLocation(), SecondVD->getSourceRange(),
10417 VarDifferentInitializer)
10418 << SecondName << SecondInit->getSourceRange();
10423 const bool FirstIsConstexpr = FirstVD->isConstexpr();
10424 const bool SecondIsConstexpr = SecondVD->isConstexpr();
10425 if (FirstIsConstexpr != SecondIsConstexpr) {
10426 ODRDiagError(FirstVD->getLocation(), FirstVD->getSourceRange(),
10428 << FirstName << FirstIsConstexpr;
10429 ODRDiagNote(SecondVD->getLocation(), SecondVD->getSourceRange(),
10431 << SecondName << SecondIsConstexpr;
10438 FriendDecl *FirstFriend = cast<FriendDecl>(FirstDecl);
10439 FriendDecl *SecondFriend = cast<FriendDecl>(SecondDecl);
10441 NamedDecl *FirstND = FirstFriend->getFriendDecl();
10442 NamedDecl *SecondND = SecondFriend->getFriendDecl();
10444 TypeSourceInfo *FirstTSI = FirstFriend->getFriendType();
10445 TypeSourceInfo *SecondTSI = SecondFriend->getFriendType();
10447 if (FirstND && SecondND) {
10448 ODRDiagError(FirstFriend->getFriendLoc(),
10449 FirstFriend->getSourceRange(), FriendFunction)
10451 ODRDiagNote(SecondFriend->getFriendLoc(),
10452 SecondFriend->getSourceRange(), FriendFunction)
10459 if (FirstTSI && SecondTSI) {
10460 QualType FirstFriendType = FirstTSI->getType();
10461 QualType SecondFriendType = SecondTSI->getType();
10462 assert(ComputeQualTypeODRHash(FirstFriendType) !=
10463 ComputeQualTypeODRHash(SecondFriendType));
10464 ODRDiagError(FirstFriend->getFriendLoc(),
10465 FirstFriend->getSourceRange(), FriendType)
10466 << FirstFriendType;
10467 ODRDiagNote(SecondFriend->getFriendLoc(),
10468 SecondFriend->getSourceRange(), FriendType)
10469 << SecondFriendType;
10474 ODRDiagError(FirstFriend->getFriendLoc(), FirstFriend->getSourceRange(),
10475 FriendTypeFunction)
10476 << (FirstTSI == nullptr);
10477 ODRDiagNote(SecondFriend->getFriendLoc(),
10478 SecondFriend->getSourceRange(), FriendTypeFunction)
10479 << (SecondTSI == nullptr);
10489 Diag(FirstDecl->getLocation(),
10490 diag::err_module_odr_violation_mismatch_decl_unknown)
10491 << FirstRecord << FirstModule.empty() << FirstModule << FirstDiffType
10492 << FirstDecl->getSourceRange();
10493 Diag(SecondDecl->getLocation(),
10494 diag::note_module_odr_violation_mismatch_decl_unknown)
10495 << SecondModule << FirstDiffType << SecondDecl->getSourceRange();
10500 // All definitions are updates to the same declaration. This happens if a
10501 // module instantiates the declaration of a class template specialization
10502 // and two or more other modules instantiate its definition.
10504 // FIXME: Indicate which modules had instantiations of this definition.
10505 // FIXME: How can this even happen?
10506 Diag(Merge.first->getLocation(),
10507 diag::err_module_odr_violation_different_instantiations)
10512 // Issue ODR failures diagnostics for functions.
10513 for (auto &Merge : FunctionOdrMergeFailures) {
10514 enum ODRFunctionDifference {
10518 ParameterSingleDefaultArgument,
10519 ParameterDifferentDefaultArgument,
10523 FunctionDecl *FirstFunction = Merge.first;
10524 std::string FirstModule = getOwningModuleNameForDiagnostic(FirstFunction);
10526 bool Diagnosed = false;
10527 for (auto &SecondFunction : Merge.second) {
10529 if (FirstFunction == SecondFunction)
10532 std::string SecondModule =
10533 getOwningModuleNameForDiagnostic(SecondFunction);
10535 auto ODRDiagError = [FirstFunction, &FirstModule,
10536 this](SourceLocation Loc, SourceRange Range,
10537 ODRFunctionDifference DiffType) {
10538 return Diag(Loc, diag::err_module_odr_violation_function)
10539 << FirstFunction << FirstModule.empty() << FirstModule << Range
10542 auto ODRDiagNote = [&SecondModule, this](SourceLocation Loc,
10544 ODRFunctionDifference DiffType) {
10545 return Diag(Loc, diag::note_module_odr_violation_function)
10546 << SecondModule << Range << DiffType;
10549 if (ComputeQualTypeODRHash(FirstFunction->getReturnType()) !=
10550 ComputeQualTypeODRHash(SecondFunction->getReturnType())) {
10551 ODRDiagError(FirstFunction->getReturnTypeSourceRange().getBegin(),
10552 FirstFunction->getReturnTypeSourceRange(), ReturnType)
10553 << FirstFunction->getReturnType();
10554 ODRDiagNote(SecondFunction->getReturnTypeSourceRange().getBegin(),
10555 SecondFunction->getReturnTypeSourceRange(), ReturnType)
10556 << SecondFunction->getReturnType();
10561 assert(FirstFunction->param_size() == SecondFunction->param_size() &&
10562 "Merged functions with different number of parameters");
10564 auto ParamSize = FirstFunction->param_size();
10565 bool ParameterMismatch = false;
10566 for (unsigned I = 0; I < ParamSize; ++I) {
10567 auto *FirstParam = FirstFunction->getParamDecl(I);
10568 auto *SecondParam = SecondFunction->getParamDecl(I);
10570 assert(getContext().hasSameType(FirstParam->getType(),
10571 SecondParam->getType()) &&
10572 "Merged function has different parameter types.");
10574 if (FirstParam->getDeclName() != SecondParam->getDeclName()) {
10575 ODRDiagError(FirstParam->getLocation(), FirstParam->getSourceRange(),
10577 << I + 1 << FirstParam->getDeclName();
10578 ODRDiagNote(SecondParam->getLocation(), SecondParam->getSourceRange(),
10580 << I + 1 << SecondParam->getDeclName();
10581 ParameterMismatch = true;
10585 QualType FirstParamType = FirstParam->getType();
10586 QualType SecondParamType = SecondParam->getType();
10587 if (FirstParamType != SecondParamType &&
10588 ComputeQualTypeODRHash(FirstParamType) !=
10589 ComputeQualTypeODRHash(SecondParamType)) {
10590 if (const DecayedType *ParamDecayedType =
10591 FirstParamType->getAs<DecayedType>()) {
10592 ODRDiagError(FirstParam->getLocation(),
10593 FirstParam->getSourceRange(), ParameterType)
10594 << (I + 1) << FirstParamType << true
10595 << ParamDecayedType->getOriginalType();
10597 ODRDiagError(FirstParam->getLocation(),
10598 FirstParam->getSourceRange(), ParameterType)
10599 << (I + 1) << FirstParamType << false;
10602 if (const DecayedType *ParamDecayedType =
10603 SecondParamType->getAs<DecayedType>()) {
10604 ODRDiagNote(SecondParam->getLocation(),
10605 SecondParam->getSourceRange(), ParameterType)
10606 << (I + 1) << SecondParamType << true
10607 << ParamDecayedType->getOriginalType();
10609 ODRDiagNote(SecondParam->getLocation(),
10610 SecondParam->getSourceRange(), ParameterType)
10611 << (I + 1) << SecondParamType << false;
10613 ParameterMismatch = true;
10617 const Expr *FirstInit = FirstParam->getInit();
10618 const Expr *SecondInit = SecondParam->getInit();
10619 if ((FirstInit == nullptr) != (SecondInit == nullptr)) {
10620 ODRDiagError(FirstParam->getLocation(), FirstParam->getSourceRange(),
10621 ParameterSingleDefaultArgument)
10622 << (I + 1) << (FirstInit == nullptr)
10623 << (FirstInit ? FirstInit->getSourceRange() : SourceRange());
10624 ODRDiagNote(SecondParam->getLocation(), SecondParam->getSourceRange(),
10625 ParameterSingleDefaultArgument)
10626 << (I + 1) << (SecondInit == nullptr)
10627 << (SecondInit ? SecondInit->getSourceRange() : SourceRange());
10628 ParameterMismatch = true;
10632 if (FirstInit && SecondInit &&
10633 ComputeODRHash(FirstInit) != ComputeODRHash(SecondInit)) {
10634 ODRDiagError(FirstParam->getLocation(), FirstParam->getSourceRange(),
10635 ParameterDifferentDefaultArgument)
10636 << (I + 1) << FirstInit->getSourceRange();
10637 ODRDiagNote(SecondParam->getLocation(), SecondParam->getSourceRange(),
10638 ParameterDifferentDefaultArgument)
10639 << (I + 1) << SecondInit->getSourceRange();
10640 ParameterMismatch = true;
10644 assert(ComputeSubDeclODRHash(FirstParam) ==
10645 ComputeSubDeclODRHash(SecondParam) &&
10646 "Undiagnosed parameter difference.");
10649 if (ParameterMismatch) {
10654 // If no error has been generated before now, assume the problem is in
10655 // the body and generate a message.
10656 ODRDiagError(FirstFunction->getLocation(),
10657 FirstFunction->getSourceRange(), FunctionBody);
10658 ODRDiagNote(SecondFunction->getLocation(),
10659 SecondFunction->getSourceRange(), FunctionBody);
10663 assert(Diagnosed && "Unable to emit ODR diagnostic.");
10667 void ASTReader::StartedDeserializing() {
10668 if (++NumCurrentElementsDeserializing == 1 && ReadTimer.get())
10669 ReadTimer->startTimer();
10672 void ASTReader::FinishedDeserializing() {
10673 assert(NumCurrentElementsDeserializing &&
10674 "FinishedDeserializing not paired with StartedDeserializing");
10675 if (NumCurrentElementsDeserializing == 1) {
10676 // We decrease NumCurrentElementsDeserializing only after pending actions
10677 // are finished, to avoid recursively re-calling finishPendingActions().
10678 finishPendingActions();
10680 --NumCurrentElementsDeserializing;
10682 if (NumCurrentElementsDeserializing == 0) {
10683 // Propagate exception specification updates along redeclaration chains.
10684 while (!PendingExceptionSpecUpdates.empty()) {
10685 auto Updates = std::move(PendingExceptionSpecUpdates);
10686 PendingExceptionSpecUpdates.clear();
10687 for (auto Update : Updates) {
10688 ProcessingUpdatesRAIIObj ProcessingUpdates(*this);
10689 auto *FPT = Update.second->getType()->castAs<FunctionProtoType>();
10690 auto ESI = FPT->getExtProtoInfo().ExceptionSpec;
10691 if (auto *Listener = getContext().getASTMutationListener())
10692 Listener->ResolvedExceptionSpec(cast<FunctionDecl>(Update.second));
10693 for (auto *Redecl : Update.second->redecls())
10694 getContext().adjustExceptionSpec(cast<FunctionDecl>(Redecl), ESI);
10699 ReadTimer->stopTimer();
10701 diagnoseOdrViolations();
10703 // We are not in recursive loading, so it's safe to pass the "interesting"
10704 // decls to the consumer.
10706 PassInterestingDeclsToConsumer();
10710 void ASTReader::pushExternalDeclIntoScope(NamedDecl *D, DeclarationName Name) {
10711 if (IdentifierInfo *II = Name.getAsIdentifierInfo()) {
10712 // Remove any fake results before adding any real ones.
10713 auto It = PendingFakeLookupResults.find(II);
10714 if (It != PendingFakeLookupResults.end()) {
10715 for (auto *ND : It->second)
10716 SemaObj->IdResolver.RemoveDecl(ND);
10717 // FIXME: this works around module+PCH performance issue.
10718 // Rather than erase the result from the map, which is O(n), just clear
10719 // the vector of NamedDecls.
10720 It->second.clear();
10724 if (SemaObj->IdResolver.tryAddTopLevelDecl(D, Name) && SemaObj->TUScope) {
10725 SemaObj->TUScope->AddDecl(D);
10726 } else if (SemaObj->TUScope) {
10727 // Adding the decl to IdResolver may have failed because it was already in
10728 // (even though it was not added in scope). If it is already in, make sure
10729 // it gets in the scope as well.
10730 if (std::find(SemaObj->IdResolver.begin(Name),
10731 SemaObj->IdResolver.end(), D) != SemaObj->IdResolver.end())
10732 SemaObj->TUScope->AddDecl(D);
10736 ASTReader::ASTReader(Preprocessor &PP, ASTContext *Context,
10737 const PCHContainerReader &PCHContainerRdr,
10738 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
10739 StringRef isysroot, bool DisableValidation,
10740 bool AllowASTWithCompilerErrors,
10741 bool AllowConfigurationMismatch, bool ValidateSystemInputs,
10742 bool UseGlobalIndex,
10743 std::unique_ptr<llvm::Timer> ReadTimer)
10744 : Listener(DisableValidation
10745 ? cast<ASTReaderListener>(new SimpleASTReaderListener(PP))
10746 : cast<ASTReaderListener>(new PCHValidator(PP, *this))),
10747 SourceMgr(PP.getSourceManager()), FileMgr(PP.getFileManager()),
10748 PCHContainerRdr(PCHContainerRdr), Diags(PP.getDiagnostics()), PP(PP),
10749 ContextObj(Context),
10750 ModuleMgr(PP.getFileManager(), PP.getPCMCache(), PCHContainerRdr,
10751 PP.getHeaderSearchInfo()),
10752 PCMCache(PP.getPCMCache()), DummyIdResolver(PP),
10753 ReadTimer(std::move(ReadTimer)), isysroot(isysroot),
10754 DisableValidation(DisableValidation),
10755 AllowASTWithCompilerErrors(AllowASTWithCompilerErrors),
10756 AllowConfigurationMismatch(AllowConfigurationMismatch),
10757 ValidateSystemInputs(ValidateSystemInputs),
10758 UseGlobalIndex(UseGlobalIndex), CurrSwitchCaseStmts(&SwitchCaseStmts) {
10759 SourceMgr.setExternalSLocEntrySource(this);
10761 for (const auto &Ext : Extensions) {
10762 auto BlockName = Ext->getExtensionMetadata().BlockName;
10763 auto Known = ModuleFileExtensions.find(BlockName);
10764 if (Known != ModuleFileExtensions.end()) {
10765 Diags.Report(diag::warn_duplicate_module_file_extension)
10770 ModuleFileExtensions.insert({BlockName, Ext});
10774 ASTReader::~ASTReader() {
10775 if (OwnsDeserializationListener)
10776 delete DeserializationListener;
10779 IdentifierResolver &ASTReader::getIdResolver() {
10780 return SemaObj ? SemaObj->IdResolver : DummyIdResolver;
10783 unsigned ASTRecordReader::readRecord(llvm::BitstreamCursor &Cursor,
10784 unsigned AbbrevID) {
10787 return Cursor.readRecord(AbbrevID, Record);