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/DeclCXX.h"
23 #include "clang/AST/DeclGroup.h"
24 #include "clang/AST/DeclObjC.h"
25 #include "clang/AST/DeclTemplate.h"
26 #include "clang/AST/Expr.h"
27 #include "clang/AST/ExprCXX.h"
28 #include "clang/AST/NestedNameSpecifier.h"
29 #include "clang/AST/ODRHash.h"
30 #include "clang/AST/RawCommentList.h"
31 #include "clang/AST/Type.h"
32 #include "clang/AST/TypeLocVisitor.h"
33 #include "clang/AST/UnresolvedSet.h"
34 #include "clang/Basic/CommentOptions.h"
35 #include "clang/Basic/DiagnosticOptions.h"
36 #include "clang/Basic/ExceptionSpecificationType.h"
37 #include "clang/Basic/FileManager.h"
38 #include "clang/Basic/FileSystemOptions.h"
39 #include "clang/Basic/LangOptions.h"
40 #include "clang/Basic/MemoryBufferCache.h"
41 #include "clang/Basic/ObjCRuntime.h"
42 #include "clang/Basic/OperatorKinds.h"
43 #include "clang/Basic/Sanitizers.h"
44 #include "clang/Basic/SourceManager.h"
45 #include "clang/Basic/SourceManagerInternals.h"
46 #include "clang/Basic/Specifiers.h"
47 #include "clang/Basic/TargetInfo.h"
48 #include "clang/Basic/TargetOptions.h"
49 #include "clang/Basic/TokenKinds.h"
50 #include "clang/Basic/Version.h"
51 #include "clang/Basic/VersionTuple.h"
52 #include "clang/Frontend/PCHContainerOperations.h"
53 #include "clang/Lex/HeaderSearch.h"
54 #include "clang/Lex/HeaderSearchOptions.h"
55 #include "clang/Lex/MacroInfo.h"
56 #include "clang/Lex/ModuleMap.h"
57 #include "clang/Lex/PreprocessingRecord.h"
58 #include "clang/Lex/Preprocessor.h"
59 #include "clang/Lex/PreprocessorOptions.h"
60 #include "clang/Sema/Scope.h"
61 #include "clang/Sema/Sema.h"
62 #include "clang/Sema/Weak.h"
63 #include "clang/Serialization/ASTDeserializationListener.h"
64 #include "clang/Serialization/GlobalModuleIndex.h"
65 #include "clang/Serialization/ModuleManager.h"
66 #include "clang/Serialization/SerializationDiagnostic.h"
67 #include "llvm/ADT/APFloat.h"
68 #include "llvm/ADT/APInt.h"
69 #include "llvm/ADT/APSInt.h"
70 #include "llvm/ADT/Hashing.h"
71 #include "llvm/ADT/SmallString.h"
72 #include "llvm/ADT/StringExtras.h"
73 #include "llvm/ADT/Triple.h"
74 #include "llvm/Bitcode/BitstreamReader.h"
75 #include "llvm/Support/Compression.h"
76 #include "llvm/Support/Compiler.h"
77 #include "llvm/Support/Error.h"
78 #include "llvm/Support/ErrorHandling.h"
79 #include "llvm/Support/FileSystem.h"
80 #include "llvm/Support/MemoryBuffer.h"
81 #include "llvm/Support/Path.h"
82 #include "llvm/Support/SaveAndRestore.h"
83 #include "llvm/Support/raw_ostream.h"
96 #include <system_error>
101 using namespace clang;
102 using namespace clang::serialization;
103 using namespace clang::serialization::reader;
104 using llvm::BitstreamCursor;
106 //===----------------------------------------------------------------------===//
107 // ChainedASTReaderListener implementation
108 //===----------------------------------------------------------------------===//
111 ChainedASTReaderListener::ReadFullVersionInformation(StringRef FullVersion) {
112 return First->ReadFullVersionInformation(FullVersion) ||
113 Second->ReadFullVersionInformation(FullVersion);
116 void ChainedASTReaderListener::ReadModuleName(StringRef ModuleName) {
117 First->ReadModuleName(ModuleName);
118 Second->ReadModuleName(ModuleName);
121 void ChainedASTReaderListener::ReadModuleMapFile(StringRef ModuleMapPath) {
122 First->ReadModuleMapFile(ModuleMapPath);
123 Second->ReadModuleMapFile(ModuleMapPath);
127 ChainedASTReaderListener::ReadLanguageOptions(const LangOptions &LangOpts,
129 bool AllowCompatibleDifferences) {
130 return First->ReadLanguageOptions(LangOpts, Complain,
131 AllowCompatibleDifferences) ||
132 Second->ReadLanguageOptions(LangOpts, Complain,
133 AllowCompatibleDifferences);
136 bool ChainedASTReaderListener::ReadTargetOptions(
137 const TargetOptions &TargetOpts, bool Complain,
138 bool AllowCompatibleDifferences) {
139 return First->ReadTargetOptions(TargetOpts, Complain,
140 AllowCompatibleDifferences) ||
141 Second->ReadTargetOptions(TargetOpts, Complain,
142 AllowCompatibleDifferences);
145 bool ChainedASTReaderListener::ReadDiagnosticOptions(
146 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts, bool Complain) {
147 return First->ReadDiagnosticOptions(DiagOpts, Complain) ||
148 Second->ReadDiagnosticOptions(DiagOpts, Complain);
152 ChainedASTReaderListener::ReadFileSystemOptions(const FileSystemOptions &FSOpts,
154 return First->ReadFileSystemOptions(FSOpts, Complain) ||
155 Second->ReadFileSystemOptions(FSOpts, Complain);
158 bool ChainedASTReaderListener::ReadHeaderSearchOptions(
159 const HeaderSearchOptions &HSOpts, StringRef SpecificModuleCachePath,
161 return First->ReadHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
163 Second->ReadHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
167 bool ChainedASTReaderListener::ReadPreprocessorOptions(
168 const PreprocessorOptions &PPOpts, bool Complain,
169 std::string &SuggestedPredefines) {
170 return First->ReadPreprocessorOptions(PPOpts, Complain,
171 SuggestedPredefines) ||
172 Second->ReadPreprocessorOptions(PPOpts, Complain, SuggestedPredefines);
174 void ChainedASTReaderListener::ReadCounter(const serialization::ModuleFile &M,
176 First->ReadCounter(M, Value);
177 Second->ReadCounter(M, Value);
179 bool ChainedASTReaderListener::needsInputFileVisitation() {
180 return First->needsInputFileVisitation() ||
181 Second->needsInputFileVisitation();
183 bool ChainedASTReaderListener::needsSystemInputFileVisitation() {
184 return First->needsSystemInputFileVisitation() ||
185 Second->needsSystemInputFileVisitation();
187 void ChainedASTReaderListener::visitModuleFile(StringRef Filename,
189 First->visitModuleFile(Filename, Kind);
190 Second->visitModuleFile(Filename, Kind);
193 bool ChainedASTReaderListener::visitInputFile(StringRef Filename,
196 bool isExplicitModule) {
197 bool Continue = false;
198 if (First->needsInputFileVisitation() &&
199 (!isSystem || First->needsSystemInputFileVisitation()))
200 Continue |= First->visitInputFile(Filename, isSystem, isOverridden,
202 if (Second->needsInputFileVisitation() &&
203 (!isSystem || Second->needsSystemInputFileVisitation()))
204 Continue |= Second->visitInputFile(Filename, isSystem, isOverridden,
209 void ChainedASTReaderListener::readModuleFileExtension(
210 const ModuleFileExtensionMetadata &Metadata) {
211 First->readModuleFileExtension(Metadata);
212 Second->readModuleFileExtension(Metadata);
215 //===----------------------------------------------------------------------===//
216 // PCH validator implementation
217 //===----------------------------------------------------------------------===//
219 ASTReaderListener::~ASTReaderListener() {}
221 /// \brief Compare the given set of language options against an existing set of
222 /// language options.
224 /// \param Diags If non-NULL, diagnostics will be emitted via this engine.
225 /// \param AllowCompatibleDifferences If true, differences between compatible
226 /// language options will be permitted.
228 /// \returns true if the languagae options mis-match, false otherwise.
229 static bool checkLanguageOptions(const LangOptions &LangOpts,
230 const LangOptions &ExistingLangOpts,
231 DiagnosticsEngine *Diags,
232 bool AllowCompatibleDifferences = true) {
233 #define LANGOPT(Name, Bits, Default, Description) \
234 if (ExistingLangOpts.Name != LangOpts.Name) { \
236 Diags->Report(diag::err_pch_langopt_mismatch) \
237 << Description << LangOpts.Name << ExistingLangOpts.Name; \
241 #define VALUE_LANGOPT(Name, Bits, Default, Description) \
242 if (ExistingLangOpts.Name != LangOpts.Name) { \
244 Diags->Report(diag::err_pch_langopt_value_mismatch) \
249 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
250 if (ExistingLangOpts.get##Name() != LangOpts.get##Name()) { \
252 Diags->Report(diag::err_pch_langopt_value_mismatch) \
257 #define COMPATIBLE_LANGOPT(Name, Bits, Default, Description) \
258 if (!AllowCompatibleDifferences) \
259 LANGOPT(Name, Bits, Default, Description)
261 #define COMPATIBLE_ENUM_LANGOPT(Name, Bits, Default, Description) \
262 if (!AllowCompatibleDifferences) \
263 ENUM_LANGOPT(Name, Bits, Default, Description)
265 #define COMPATIBLE_VALUE_LANGOPT(Name, Bits, Default, Description) \
266 if (!AllowCompatibleDifferences) \
267 VALUE_LANGOPT(Name, Bits, Default, Description)
269 #define BENIGN_LANGOPT(Name, Bits, Default, Description)
270 #define BENIGN_ENUM_LANGOPT(Name, Type, Bits, Default, Description)
271 #define BENIGN_VALUE_LANGOPT(Name, Type, Bits, Default, Description)
272 #include "clang/Basic/LangOptions.def"
274 if (ExistingLangOpts.ModuleFeatures != LangOpts.ModuleFeatures) {
276 Diags->Report(diag::err_pch_langopt_value_mismatch) << "module features";
280 if (ExistingLangOpts.ObjCRuntime != LangOpts.ObjCRuntime) {
282 Diags->Report(diag::err_pch_langopt_value_mismatch)
283 << "target Objective-C runtime";
287 if (ExistingLangOpts.CommentOpts.BlockCommandNames !=
288 LangOpts.CommentOpts.BlockCommandNames) {
290 Diags->Report(diag::err_pch_langopt_value_mismatch)
291 << "block command names";
295 // Sanitizer feature mismatches are treated as compatible differences. If
296 // compatible differences aren't allowed, we still only want to check for
297 // mismatches of non-modular sanitizers (the only ones which can affect AST
299 if (!AllowCompatibleDifferences) {
300 SanitizerMask ModularSanitizers = getPPTransparentSanitizers();
301 SanitizerSet ExistingSanitizers = ExistingLangOpts.Sanitize;
302 SanitizerSet ImportedSanitizers = LangOpts.Sanitize;
303 ExistingSanitizers.clear(ModularSanitizers);
304 ImportedSanitizers.clear(ModularSanitizers);
305 if (ExistingSanitizers.Mask != ImportedSanitizers.Mask) {
306 const std::string Flag = "-fsanitize=";
308 #define SANITIZER(NAME, ID) \
310 bool InExistingModule = ExistingSanitizers.has(SanitizerKind::ID); \
311 bool InImportedModule = ImportedSanitizers.has(SanitizerKind::ID); \
312 if (InExistingModule != InImportedModule) \
313 Diags->Report(diag::err_pch_targetopt_feature_mismatch) \
314 << InExistingModule << (Flag + NAME); \
316 #include "clang/Basic/Sanitizers.def"
325 /// \brief Compare the given set of target options against an existing set of
328 /// \param Diags If non-NULL, diagnostics will be emitted via this engine.
330 /// \returns true if the target options mis-match, false otherwise.
331 static bool checkTargetOptions(const TargetOptions &TargetOpts,
332 const TargetOptions &ExistingTargetOpts,
333 DiagnosticsEngine *Diags,
334 bool AllowCompatibleDifferences = true) {
335 #define CHECK_TARGET_OPT(Field, Name) \
336 if (TargetOpts.Field != ExistingTargetOpts.Field) { \
338 Diags->Report(diag::err_pch_targetopt_mismatch) \
339 << Name << TargetOpts.Field << ExistingTargetOpts.Field; \
343 // The triple and ABI must match exactly.
344 CHECK_TARGET_OPT(Triple, "target");
345 CHECK_TARGET_OPT(ABI, "target ABI");
347 // We can tolerate different CPUs in many cases, notably when one CPU
348 // supports a strict superset of another. When allowing compatible
349 // differences skip this check.
350 if (!AllowCompatibleDifferences)
351 CHECK_TARGET_OPT(CPU, "target CPU");
353 #undef CHECK_TARGET_OPT
355 // Compare feature sets.
356 SmallVector<StringRef, 4> ExistingFeatures(
357 ExistingTargetOpts.FeaturesAsWritten.begin(),
358 ExistingTargetOpts.FeaturesAsWritten.end());
359 SmallVector<StringRef, 4> ReadFeatures(TargetOpts.FeaturesAsWritten.begin(),
360 TargetOpts.FeaturesAsWritten.end());
361 std::sort(ExistingFeatures.begin(), ExistingFeatures.end());
362 std::sort(ReadFeatures.begin(), ReadFeatures.end());
364 // We compute the set difference in both directions explicitly so that we can
365 // diagnose the differences differently.
366 SmallVector<StringRef, 4> UnmatchedExistingFeatures, UnmatchedReadFeatures;
368 ExistingFeatures.begin(), ExistingFeatures.end(), ReadFeatures.begin(),
369 ReadFeatures.end(), std::back_inserter(UnmatchedExistingFeatures));
370 std::set_difference(ReadFeatures.begin(), ReadFeatures.end(),
371 ExistingFeatures.begin(), ExistingFeatures.end(),
372 std::back_inserter(UnmatchedReadFeatures));
374 // If we are allowing compatible differences and the read feature set is
375 // a strict subset of the existing feature set, there is nothing to diagnose.
376 if (AllowCompatibleDifferences && UnmatchedReadFeatures.empty())
380 for (StringRef Feature : UnmatchedReadFeatures)
381 Diags->Report(diag::err_pch_targetopt_feature_mismatch)
382 << /* is-existing-feature */ false << Feature;
383 for (StringRef Feature : UnmatchedExistingFeatures)
384 Diags->Report(diag::err_pch_targetopt_feature_mismatch)
385 << /* is-existing-feature */ true << Feature;
388 return !UnmatchedReadFeatures.empty() || !UnmatchedExistingFeatures.empty();
392 PCHValidator::ReadLanguageOptions(const LangOptions &LangOpts,
394 bool AllowCompatibleDifferences) {
395 const LangOptions &ExistingLangOpts = PP.getLangOpts();
396 return checkLanguageOptions(LangOpts, ExistingLangOpts,
397 Complain ? &Reader.Diags : nullptr,
398 AllowCompatibleDifferences);
401 bool PCHValidator::ReadTargetOptions(const TargetOptions &TargetOpts,
403 bool AllowCompatibleDifferences) {
404 const TargetOptions &ExistingTargetOpts = PP.getTargetInfo().getTargetOpts();
405 return checkTargetOptions(TargetOpts, ExistingTargetOpts,
406 Complain ? &Reader.Diags : nullptr,
407 AllowCompatibleDifferences);
412 typedef llvm::StringMap<std::pair<StringRef, bool /*IsUndef*/> >
414 typedef llvm::DenseMap<DeclarationName, SmallVector<NamedDecl *, 8> >
417 } // end anonymous namespace
419 static bool checkDiagnosticGroupMappings(DiagnosticsEngine &StoredDiags,
420 DiagnosticsEngine &Diags,
422 typedef DiagnosticsEngine::Level Level;
424 // Check current mappings for new -Werror mappings, and the stored mappings
425 // for cases that were explicitly mapped to *not* be errors that are now
426 // errors because of options like -Werror.
427 DiagnosticsEngine *MappingSources[] = { &Diags, &StoredDiags };
429 for (DiagnosticsEngine *MappingSource : MappingSources) {
430 for (auto DiagIDMappingPair : MappingSource->getDiagnosticMappings()) {
431 diag::kind DiagID = DiagIDMappingPair.first;
432 Level CurLevel = Diags.getDiagnosticLevel(DiagID, SourceLocation());
433 if (CurLevel < DiagnosticsEngine::Error)
434 continue; // not significant
436 StoredDiags.getDiagnosticLevel(DiagID, SourceLocation());
437 if (StoredLevel < DiagnosticsEngine::Error) {
439 Diags.Report(diag::err_pch_diagopt_mismatch) << "-Werror=" +
440 Diags.getDiagnosticIDs()->getWarningOptionForDiag(DiagID).str();
449 static bool isExtHandlingFromDiagsError(DiagnosticsEngine &Diags) {
450 diag::Severity Ext = Diags.getExtensionHandlingBehavior();
451 if (Ext == diag::Severity::Warning && Diags.getWarningsAsErrors())
453 return Ext >= diag::Severity::Error;
456 static bool checkDiagnosticMappings(DiagnosticsEngine &StoredDiags,
457 DiagnosticsEngine &Diags,
458 bool IsSystem, bool Complain) {
461 if (Diags.getSuppressSystemWarnings())
463 // If -Wsystem-headers was not enabled before, be conservative
464 if (StoredDiags.getSuppressSystemWarnings()) {
466 Diags.Report(diag::err_pch_diagopt_mismatch) << "-Wsystem-headers";
471 if (Diags.getWarningsAsErrors() && !StoredDiags.getWarningsAsErrors()) {
473 Diags.Report(diag::err_pch_diagopt_mismatch) << "-Werror";
477 if (Diags.getWarningsAsErrors() && Diags.getEnableAllWarnings() &&
478 !StoredDiags.getEnableAllWarnings()) {
480 Diags.Report(diag::err_pch_diagopt_mismatch) << "-Weverything -Werror";
484 if (isExtHandlingFromDiagsError(Diags) &&
485 !isExtHandlingFromDiagsError(StoredDiags)) {
487 Diags.Report(diag::err_pch_diagopt_mismatch) << "-pedantic-errors";
491 return checkDiagnosticGroupMappings(StoredDiags, Diags, Complain);
494 /// Return the top import module if it is implicit, nullptr otherwise.
495 static Module *getTopImportImplicitModule(ModuleManager &ModuleMgr,
497 // If the original import came from a file explicitly generated by the user,
498 // don't check the diagnostic mappings.
499 // FIXME: currently this is approximated by checking whether this is not a
500 // module import of an implicitly-loaded module file.
501 // Note: ModuleMgr.rbegin() may not be the current module, but it must be in
502 // the transitive closure of its imports, since unrelated modules cannot be
503 // imported until after this module finishes validation.
504 ModuleFile *TopImport = &*ModuleMgr.rbegin();
505 while (!TopImport->ImportedBy.empty())
506 TopImport = TopImport->ImportedBy[0];
507 if (TopImport->Kind != MK_ImplicitModule)
510 StringRef ModuleName = TopImport->ModuleName;
511 assert(!ModuleName.empty() && "diagnostic options read before module name");
513 Module *M = PP.getHeaderSearchInfo().lookupModule(ModuleName);
514 assert(M && "missing module");
518 bool PCHValidator::ReadDiagnosticOptions(
519 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts, bool Complain) {
520 DiagnosticsEngine &ExistingDiags = PP.getDiagnostics();
521 IntrusiveRefCntPtr<DiagnosticIDs> DiagIDs(ExistingDiags.getDiagnosticIDs());
522 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
523 new DiagnosticsEngine(DiagIDs, DiagOpts.get()));
524 // This should never fail, because we would have processed these options
525 // before writing them to an ASTFile.
526 ProcessWarningOptions(*Diags, *DiagOpts, /*Report*/false);
528 ModuleManager &ModuleMgr = Reader.getModuleManager();
529 assert(ModuleMgr.size() >= 1 && "what ASTFile is this then");
531 Module *TopM = getTopImportImplicitModule(ModuleMgr, PP);
535 // FIXME: if the diagnostics are incompatible, save a DiagnosticOptions that
536 // contains the union of their flags.
537 return checkDiagnosticMappings(*Diags, ExistingDiags, TopM->IsSystem,
541 /// \brief Collect the macro definitions provided by the given preprocessor
544 collectMacroDefinitions(const PreprocessorOptions &PPOpts,
545 MacroDefinitionsMap &Macros,
546 SmallVectorImpl<StringRef> *MacroNames = nullptr) {
547 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
548 StringRef Macro = PPOpts.Macros[I].first;
549 bool IsUndef = PPOpts.Macros[I].second;
551 std::pair<StringRef, StringRef> MacroPair = Macro.split('=');
552 StringRef MacroName = MacroPair.first;
553 StringRef MacroBody = MacroPair.second;
555 // For an #undef'd macro, we only care about the name.
557 if (MacroNames && !Macros.count(MacroName))
558 MacroNames->push_back(MacroName);
560 Macros[MacroName] = std::make_pair("", true);
564 // For a #define'd macro, figure out the actual definition.
565 if (MacroName.size() == Macro.size())
568 // Note: GCC drops anything following an end-of-line character.
569 StringRef::size_type End = MacroBody.find_first_of("\n\r");
570 MacroBody = MacroBody.substr(0, End);
573 if (MacroNames && !Macros.count(MacroName))
574 MacroNames->push_back(MacroName);
575 Macros[MacroName] = std::make_pair(MacroBody, false);
579 /// \brief Check the preprocessor options deserialized from the control block
580 /// against the preprocessor options in an existing preprocessor.
582 /// \param Diags If non-null, produce diagnostics for any mismatches incurred.
583 /// \param Validate If true, validate preprocessor options. If false, allow
584 /// macros defined by \p ExistingPPOpts to override those defined by
585 /// \p PPOpts in SuggestedPredefines.
586 static bool checkPreprocessorOptions(const PreprocessorOptions &PPOpts,
587 const PreprocessorOptions &ExistingPPOpts,
588 DiagnosticsEngine *Diags,
589 FileManager &FileMgr,
590 std::string &SuggestedPredefines,
591 const LangOptions &LangOpts,
592 bool Validate = true) {
593 // Check macro definitions.
594 MacroDefinitionsMap ASTFileMacros;
595 collectMacroDefinitions(PPOpts, ASTFileMacros);
596 MacroDefinitionsMap ExistingMacros;
597 SmallVector<StringRef, 4> ExistingMacroNames;
598 collectMacroDefinitions(ExistingPPOpts, ExistingMacros, &ExistingMacroNames);
600 for (unsigned I = 0, N = ExistingMacroNames.size(); I != N; ++I) {
601 // Dig out the macro definition in the existing preprocessor options.
602 StringRef MacroName = ExistingMacroNames[I];
603 std::pair<StringRef, bool> Existing = ExistingMacros[MacroName];
605 // Check whether we know anything about this macro name or not.
606 llvm::StringMap<std::pair<StringRef, bool /*IsUndef*/> >::iterator Known
607 = ASTFileMacros.find(MacroName);
608 if (!Validate || Known == ASTFileMacros.end()) {
609 // FIXME: Check whether this identifier was referenced anywhere in the
610 // AST file. If so, we should reject the AST file. Unfortunately, this
611 // information isn't in the control block. What shall we do about it?
613 if (Existing.second) {
614 SuggestedPredefines += "#undef ";
615 SuggestedPredefines += MacroName.str();
616 SuggestedPredefines += '\n';
618 SuggestedPredefines += "#define ";
619 SuggestedPredefines += MacroName.str();
620 SuggestedPredefines += ' ';
621 SuggestedPredefines += Existing.first.str();
622 SuggestedPredefines += '\n';
627 // If the macro was defined in one but undef'd in the other, we have a
629 if (Existing.second != Known->second.second) {
631 Diags->Report(diag::err_pch_macro_def_undef)
632 << MacroName << Known->second.second;
637 // If the macro was #undef'd in both, or if the macro bodies are identical,
639 if (Existing.second || Existing.first == Known->second.first)
642 // The macro bodies differ; complain.
644 Diags->Report(diag::err_pch_macro_def_conflict)
645 << MacroName << Known->second.first << Existing.first;
650 // Check whether we're using predefines.
651 if (PPOpts.UsePredefines != ExistingPPOpts.UsePredefines && Validate) {
653 Diags->Report(diag::err_pch_undef) << ExistingPPOpts.UsePredefines;
658 // Detailed record is important since it is used for the module cache hash.
659 if (LangOpts.Modules &&
660 PPOpts.DetailedRecord != ExistingPPOpts.DetailedRecord && Validate) {
662 Diags->Report(diag::err_pch_pp_detailed_record) << PPOpts.DetailedRecord;
667 // Compute the #include and #include_macros lines we need.
668 for (unsigned I = 0, N = ExistingPPOpts.Includes.size(); I != N; ++I) {
669 StringRef File = ExistingPPOpts.Includes[I];
670 if (File == ExistingPPOpts.ImplicitPCHInclude)
673 if (std::find(PPOpts.Includes.begin(), PPOpts.Includes.end(), File)
674 != PPOpts.Includes.end())
677 SuggestedPredefines += "#include \"";
678 SuggestedPredefines += File;
679 SuggestedPredefines += "\"\n";
682 for (unsigned I = 0, N = ExistingPPOpts.MacroIncludes.size(); I != N; ++I) {
683 StringRef File = ExistingPPOpts.MacroIncludes[I];
684 if (std::find(PPOpts.MacroIncludes.begin(), PPOpts.MacroIncludes.end(),
686 != PPOpts.MacroIncludes.end())
689 SuggestedPredefines += "#__include_macros \"";
690 SuggestedPredefines += File;
691 SuggestedPredefines += "\"\n##\n";
697 bool PCHValidator::ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
699 std::string &SuggestedPredefines) {
700 const PreprocessorOptions &ExistingPPOpts = PP.getPreprocessorOpts();
702 return checkPreprocessorOptions(PPOpts, ExistingPPOpts,
703 Complain? &Reader.Diags : nullptr,
709 bool SimpleASTReaderListener::ReadPreprocessorOptions(
710 const PreprocessorOptions &PPOpts,
712 std::string &SuggestedPredefines) {
713 return checkPreprocessorOptions(PPOpts,
714 PP.getPreprocessorOpts(),
722 /// Check the header search options deserialized from the control block
723 /// against the header search options in an existing preprocessor.
725 /// \param Diags If non-null, produce diagnostics for any mismatches incurred.
726 static bool checkHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
727 StringRef SpecificModuleCachePath,
728 StringRef ExistingModuleCachePath,
729 DiagnosticsEngine *Diags,
730 const LangOptions &LangOpts) {
731 if (LangOpts.Modules) {
732 if (SpecificModuleCachePath != ExistingModuleCachePath) {
734 Diags->Report(diag::err_pch_modulecache_mismatch)
735 << SpecificModuleCachePath << ExistingModuleCachePath;
743 bool PCHValidator::ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
744 StringRef SpecificModuleCachePath,
746 return checkHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
747 PP.getHeaderSearchInfo().getModuleCachePath(),
748 Complain ? &Reader.Diags : nullptr,
752 void PCHValidator::ReadCounter(const ModuleFile &M, unsigned Value) {
753 PP.setCounterValue(Value);
756 //===----------------------------------------------------------------------===//
757 // AST reader implementation
758 //===----------------------------------------------------------------------===//
760 void ASTReader::setDeserializationListener(ASTDeserializationListener *Listener,
761 bool TakeOwnership) {
762 DeserializationListener = Listener;
763 OwnsDeserializationListener = TakeOwnership;
766 unsigned ASTSelectorLookupTrait::ComputeHash(Selector Sel) {
767 return serialization::ComputeHash(Sel);
770 std::pair<unsigned, unsigned>
771 ASTSelectorLookupTrait::ReadKeyDataLength(const unsigned char*& d) {
772 using namespace llvm::support;
773 unsigned KeyLen = endian::readNext<uint16_t, little, unaligned>(d);
774 unsigned DataLen = endian::readNext<uint16_t, little, unaligned>(d);
775 return std::make_pair(KeyLen, DataLen);
778 ASTSelectorLookupTrait::internal_key_type
779 ASTSelectorLookupTrait::ReadKey(const unsigned char* d, unsigned) {
780 using namespace llvm::support;
781 SelectorTable &SelTable = Reader.getContext().Selectors;
782 unsigned N = endian::readNext<uint16_t, little, unaligned>(d);
783 IdentifierInfo *FirstII = Reader.getLocalIdentifier(
784 F, endian::readNext<uint32_t, little, unaligned>(d));
786 return SelTable.getNullarySelector(FirstII);
788 return SelTable.getUnarySelector(FirstII);
790 SmallVector<IdentifierInfo *, 16> Args;
791 Args.push_back(FirstII);
792 for (unsigned I = 1; I != N; ++I)
793 Args.push_back(Reader.getLocalIdentifier(
794 F, endian::readNext<uint32_t, little, unaligned>(d)));
796 return SelTable.getSelector(N, Args.data());
799 ASTSelectorLookupTrait::data_type
800 ASTSelectorLookupTrait::ReadData(Selector, const unsigned char* d,
802 using namespace llvm::support;
806 Result.ID = Reader.getGlobalSelectorID(
807 F, endian::readNext<uint32_t, little, unaligned>(d));
808 unsigned FullInstanceBits = endian::readNext<uint16_t, little, unaligned>(d);
809 unsigned FullFactoryBits = endian::readNext<uint16_t, little, unaligned>(d);
810 Result.InstanceBits = FullInstanceBits & 0x3;
811 Result.InstanceHasMoreThanOneDecl = (FullInstanceBits >> 2) & 0x1;
812 Result.FactoryBits = FullFactoryBits & 0x3;
813 Result.FactoryHasMoreThanOneDecl = (FullFactoryBits >> 2) & 0x1;
814 unsigned NumInstanceMethods = FullInstanceBits >> 3;
815 unsigned NumFactoryMethods = FullFactoryBits >> 3;
817 // Load instance methods
818 for (unsigned I = 0; I != NumInstanceMethods; ++I) {
819 if (ObjCMethodDecl *Method = Reader.GetLocalDeclAs<ObjCMethodDecl>(
820 F, endian::readNext<uint32_t, little, unaligned>(d)))
821 Result.Instance.push_back(Method);
824 // Load factory methods
825 for (unsigned I = 0; I != NumFactoryMethods; ++I) {
826 if (ObjCMethodDecl *Method = Reader.GetLocalDeclAs<ObjCMethodDecl>(
827 F, endian::readNext<uint32_t, little, unaligned>(d)))
828 Result.Factory.push_back(Method);
834 unsigned ASTIdentifierLookupTraitBase::ComputeHash(const internal_key_type& a) {
835 return llvm::HashString(a);
838 std::pair<unsigned, unsigned>
839 ASTIdentifierLookupTraitBase::ReadKeyDataLength(const unsigned char*& d) {
840 using namespace llvm::support;
841 unsigned DataLen = endian::readNext<uint16_t, little, unaligned>(d);
842 unsigned KeyLen = endian::readNext<uint16_t, little, unaligned>(d);
843 return std::make_pair(KeyLen, DataLen);
846 ASTIdentifierLookupTraitBase::internal_key_type
847 ASTIdentifierLookupTraitBase::ReadKey(const unsigned char* d, unsigned n) {
848 assert(n >= 2 && d[n-1] == '\0');
849 return StringRef((const char*) d, n-1);
852 /// \brief Whether the given identifier is "interesting".
853 static bool isInterestingIdentifier(ASTReader &Reader, IdentifierInfo &II,
855 return II.hadMacroDefinition() ||
857 (IsModule ? II.hasRevertedBuiltin() : II.getObjCOrBuiltinID()) ||
858 II.hasRevertedTokenIDToIdentifier() ||
859 (!(IsModule && Reader.getPreprocessor().getLangOpts().CPlusPlus) &&
860 II.getFETokenInfo<void>());
863 static bool readBit(unsigned &Bits) {
864 bool Value = Bits & 0x1;
869 IdentID ASTIdentifierLookupTrait::ReadIdentifierID(const unsigned char *d) {
870 using namespace llvm::support;
871 unsigned RawID = endian::readNext<uint32_t, little, unaligned>(d);
872 return Reader.getGlobalIdentifierID(F, RawID >> 1);
875 static void markIdentifierFromAST(ASTReader &Reader, IdentifierInfo &II) {
876 if (!II.isFromAST()) {
878 bool IsModule = Reader.getPreprocessor().getCurrentModule() != nullptr;
879 if (isInterestingIdentifier(Reader, II, IsModule))
880 II.setChangedSinceDeserialization();
884 IdentifierInfo *ASTIdentifierLookupTrait::ReadData(const internal_key_type& k,
885 const unsigned char* d,
887 using namespace llvm::support;
888 unsigned RawID = endian::readNext<uint32_t, little, unaligned>(d);
889 bool IsInteresting = RawID & 0x01;
891 // Wipe out the "is interesting" bit.
894 // Build the IdentifierInfo and link the identifier ID with it.
895 IdentifierInfo *II = KnownII;
897 II = &Reader.getIdentifierTable().getOwn(k);
900 markIdentifierFromAST(Reader, *II);
901 Reader.markIdentifierUpToDate(II);
903 IdentID ID = Reader.getGlobalIdentifierID(F, RawID);
904 if (!IsInteresting) {
905 // For uninteresting identifiers, there's nothing else to do. Just notify
906 // the reader that we've finished loading this identifier.
907 Reader.SetIdentifierInfo(ID, II);
911 unsigned ObjCOrBuiltinID = endian::readNext<uint16_t, little, unaligned>(d);
912 unsigned Bits = endian::readNext<uint16_t, little, unaligned>(d);
913 bool CPlusPlusOperatorKeyword = readBit(Bits);
914 bool HasRevertedTokenIDToIdentifier = readBit(Bits);
915 bool HasRevertedBuiltin = readBit(Bits);
916 bool Poisoned = readBit(Bits);
917 bool ExtensionToken = readBit(Bits);
918 bool HadMacroDefinition = readBit(Bits);
920 assert(Bits == 0 && "Extra bits in the identifier?");
923 // Set or check the various bits in the IdentifierInfo structure.
924 // Token IDs are read-only.
925 if (HasRevertedTokenIDToIdentifier && II->getTokenID() != tok::identifier)
926 II->revertTokenIDToIdentifier();
928 II->setObjCOrBuiltinID(ObjCOrBuiltinID);
929 else if (HasRevertedBuiltin && II->getBuiltinID()) {
931 assert((II->hasRevertedBuiltin() ||
932 II->getObjCOrBuiltinID() == ObjCOrBuiltinID) &&
933 "Incorrect ObjC keyword or builtin ID");
935 assert(II->isExtensionToken() == ExtensionToken &&
936 "Incorrect extension token flag");
937 (void)ExtensionToken;
939 II->setIsPoisoned(true);
940 assert(II->isCPlusPlusOperatorKeyword() == CPlusPlusOperatorKeyword &&
941 "Incorrect C++ operator keyword flag");
942 (void)CPlusPlusOperatorKeyword;
944 // If this identifier is a macro, deserialize the macro
946 if (HadMacroDefinition) {
947 uint32_t MacroDirectivesOffset =
948 endian::readNext<uint32_t, little, unaligned>(d);
951 Reader.addPendingMacro(II, &F, MacroDirectivesOffset);
954 Reader.SetIdentifierInfo(ID, II);
956 // Read all of the declarations visible at global scope with this
959 SmallVector<uint32_t, 4> DeclIDs;
960 for (; DataLen > 0; DataLen -= 4)
961 DeclIDs.push_back(Reader.getGlobalDeclID(
962 F, endian::readNext<uint32_t, little, unaligned>(d)));
963 Reader.SetGloballyVisibleDecls(II, DeclIDs);
969 DeclarationNameKey::DeclarationNameKey(DeclarationName Name)
970 : Kind(Name.getNameKind()) {
972 case DeclarationName::Identifier:
973 Data = (uint64_t)Name.getAsIdentifierInfo();
975 case DeclarationName::ObjCZeroArgSelector:
976 case DeclarationName::ObjCOneArgSelector:
977 case DeclarationName::ObjCMultiArgSelector:
978 Data = (uint64_t)Name.getObjCSelector().getAsOpaquePtr();
980 case DeclarationName::CXXOperatorName:
981 Data = Name.getCXXOverloadedOperator();
983 case DeclarationName::CXXLiteralOperatorName:
984 Data = (uint64_t)Name.getCXXLiteralIdentifier();
986 case DeclarationName::CXXDeductionGuideName:
987 Data = (uint64_t)Name.getCXXDeductionGuideTemplate()
988 ->getDeclName().getAsIdentifierInfo();
990 case DeclarationName::CXXConstructorName:
991 case DeclarationName::CXXDestructorName:
992 case DeclarationName::CXXConversionFunctionName:
993 case DeclarationName::CXXUsingDirective:
999 unsigned DeclarationNameKey::getHash() const {
1000 llvm::FoldingSetNodeID ID;
1001 ID.AddInteger(Kind);
1004 case DeclarationName::Identifier:
1005 case DeclarationName::CXXLiteralOperatorName:
1006 case DeclarationName::CXXDeductionGuideName:
1007 ID.AddString(((IdentifierInfo*)Data)->getName());
1009 case DeclarationName::ObjCZeroArgSelector:
1010 case DeclarationName::ObjCOneArgSelector:
1011 case DeclarationName::ObjCMultiArgSelector:
1012 ID.AddInteger(serialization::ComputeHash(Selector(Data)));
1014 case DeclarationName::CXXOperatorName:
1015 ID.AddInteger((OverloadedOperatorKind)Data);
1017 case DeclarationName::CXXConstructorName:
1018 case DeclarationName::CXXDestructorName:
1019 case DeclarationName::CXXConversionFunctionName:
1020 case DeclarationName::CXXUsingDirective:
1024 return ID.ComputeHash();
1028 ASTDeclContextNameLookupTrait::ReadFileRef(const unsigned char *&d) {
1029 using namespace llvm::support;
1030 uint32_t ModuleFileID = endian::readNext<uint32_t, little, unaligned>(d);
1031 return Reader.getLocalModuleFile(F, ModuleFileID);
1034 std::pair<unsigned, unsigned>
1035 ASTDeclContextNameLookupTrait::ReadKeyDataLength(const unsigned char *&d) {
1036 using namespace llvm::support;
1037 unsigned KeyLen = endian::readNext<uint16_t, little, unaligned>(d);
1038 unsigned DataLen = endian::readNext<uint16_t, little, unaligned>(d);
1039 return std::make_pair(KeyLen, DataLen);
1042 ASTDeclContextNameLookupTrait::internal_key_type
1043 ASTDeclContextNameLookupTrait::ReadKey(const unsigned char *d, unsigned) {
1044 using namespace llvm::support;
1046 auto Kind = (DeclarationName::NameKind)*d++;
1049 case DeclarationName::Identifier:
1050 case DeclarationName::CXXLiteralOperatorName:
1051 case DeclarationName::CXXDeductionGuideName:
1052 Data = (uint64_t)Reader.getLocalIdentifier(
1053 F, endian::readNext<uint32_t, little, unaligned>(d));
1055 case DeclarationName::ObjCZeroArgSelector:
1056 case DeclarationName::ObjCOneArgSelector:
1057 case DeclarationName::ObjCMultiArgSelector:
1059 (uint64_t)Reader.getLocalSelector(
1060 F, endian::readNext<uint32_t, little, unaligned>(
1061 d)).getAsOpaquePtr();
1063 case DeclarationName::CXXOperatorName:
1064 Data = *d++; // OverloadedOperatorKind
1066 case DeclarationName::CXXConstructorName:
1067 case DeclarationName::CXXDestructorName:
1068 case DeclarationName::CXXConversionFunctionName:
1069 case DeclarationName::CXXUsingDirective:
1074 return DeclarationNameKey(Kind, Data);
1077 void ASTDeclContextNameLookupTrait::ReadDataInto(internal_key_type,
1078 const unsigned char *d,
1080 data_type_builder &Val) {
1081 using namespace llvm::support;
1082 for (unsigned NumDecls = DataLen / 4; NumDecls; --NumDecls) {
1083 uint32_t LocalID = endian::readNext<uint32_t, little, unaligned>(d);
1084 Val.insert(Reader.getGlobalDeclID(F, LocalID));
1088 bool ASTReader::ReadLexicalDeclContextStorage(ModuleFile &M,
1089 BitstreamCursor &Cursor,
1092 assert(Offset != 0);
1094 SavedStreamPosition SavedPosition(Cursor);
1095 Cursor.JumpToBit(Offset);
1099 unsigned Code = Cursor.ReadCode();
1100 unsigned RecCode = Cursor.readRecord(Code, Record, &Blob);
1101 if (RecCode != DECL_CONTEXT_LEXICAL) {
1102 Error("Expected lexical block");
1106 assert(!isa<TranslationUnitDecl>(DC) &&
1107 "expected a TU_UPDATE_LEXICAL record for TU");
1108 // If we are handling a C++ class template instantiation, we can see multiple
1109 // lexical updates for the same record. It's important that we select only one
1110 // of them, so that field numbering works properly. Just pick the first one we
1112 auto &Lex = LexicalDecls[DC];
1114 Lex = std::make_pair(
1115 &M, llvm::makeArrayRef(
1116 reinterpret_cast<const llvm::support::unaligned_uint32_t *>(
1120 DC->setHasExternalLexicalStorage(true);
1124 bool ASTReader::ReadVisibleDeclContextStorage(ModuleFile &M,
1125 BitstreamCursor &Cursor,
1128 assert(Offset != 0);
1130 SavedStreamPosition SavedPosition(Cursor);
1131 Cursor.JumpToBit(Offset);
1135 unsigned Code = Cursor.ReadCode();
1136 unsigned RecCode = Cursor.readRecord(Code, Record, &Blob);
1137 if (RecCode != DECL_CONTEXT_VISIBLE) {
1138 Error("Expected visible lookup table block");
1142 // We can't safely determine the primary context yet, so delay attaching the
1143 // lookup table until we're done with recursive deserialization.
1144 auto *Data = (const unsigned char*)Blob.data();
1145 PendingVisibleUpdates[ID].push_back(PendingVisibleUpdate{&M, Data});
1149 void ASTReader::Error(StringRef Msg) const {
1150 Error(diag::err_fe_pch_malformed, Msg);
1151 if (PP.getLangOpts().Modules && !Diags.isDiagnosticInFlight() &&
1152 !PP.getHeaderSearchInfo().getModuleCachePath().empty()) {
1153 Diag(diag::note_module_cache_path)
1154 << PP.getHeaderSearchInfo().getModuleCachePath();
1158 void ASTReader::Error(unsigned DiagID,
1159 StringRef Arg1, StringRef Arg2) const {
1160 if (Diags.isDiagnosticInFlight())
1161 Diags.SetDelayedDiagnostic(DiagID, Arg1, Arg2);
1163 Diag(DiagID) << Arg1 << Arg2;
1166 //===----------------------------------------------------------------------===//
1167 // Source Manager Deserialization
1168 //===----------------------------------------------------------------------===//
1170 /// \brief Read the line table in the source manager block.
1171 /// \returns true if there was an error.
1172 bool ASTReader::ParseLineTable(ModuleFile &F,
1173 const RecordData &Record) {
1175 LineTableInfo &LineTable = SourceMgr.getLineTable();
1177 // Parse the file names
1178 std::map<int, int> FileIDs;
1179 for (unsigned I = 0; Record[Idx]; ++I) {
1180 // Extract the file name
1181 auto Filename = ReadPath(F, Record, Idx);
1182 FileIDs[I] = LineTable.getLineTableFilenameID(Filename);
1186 // Parse the line entries
1187 std::vector<LineEntry> Entries;
1188 while (Idx < Record.size()) {
1189 int FID = Record[Idx++];
1190 assert(FID >= 0 && "Serialized line entries for non-local file.");
1191 // Remap FileID from 1-based old view.
1192 FID += F.SLocEntryBaseID - 1;
1194 // Extract the line entries
1195 unsigned NumEntries = Record[Idx++];
1196 assert(NumEntries && "no line entries for file ID");
1198 Entries.reserve(NumEntries);
1199 for (unsigned I = 0; I != NumEntries; ++I) {
1200 unsigned FileOffset = Record[Idx++];
1201 unsigned LineNo = Record[Idx++];
1202 int FilenameID = FileIDs[Record[Idx++]];
1203 SrcMgr::CharacteristicKind FileKind
1204 = (SrcMgr::CharacteristicKind)Record[Idx++];
1205 unsigned IncludeOffset = Record[Idx++];
1206 Entries.push_back(LineEntry::get(FileOffset, LineNo, FilenameID,
1207 FileKind, IncludeOffset));
1209 LineTable.AddEntry(FileID::get(FID), Entries);
1215 /// \brief Read a source manager block
1216 bool ASTReader::ReadSourceManagerBlock(ModuleFile &F) {
1217 using namespace SrcMgr;
1219 BitstreamCursor &SLocEntryCursor = F.SLocEntryCursor;
1221 // Set the source-location entry cursor to the current position in
1222 // the stream. This cursor will be used to read the contents of the
1223 // source manager block initially, and then lazily read
1224 // source-location entries as needed.
1225 SLocEntryCursor = F.Stream;
1227 // The stream itself is going to skip over the source manager block.
1228 if (F.Stream.SkipBlock()) {
1229 Error("malformed block record in AST file");
1233 // Enter the source manager block.
1234 if (SLocEntryCursor.EnterSubBlock(SOURCE_MANAGER_BLOCK_ID)) {
1235 Error("malformed source manager block record in AST file");
1241 llvm::BitstreamEntry E = SLocEntryCursor.advanceSkippingSubblocks();
1244 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
1245 case llvm::BitstreamEntry::Error:
1246 Error("malformed block record in AST file");
1248 case llvm::BitstreamEntry::EndBlock:
1250 case llvm::BitstreamEntry::Record:
1251 // The interesting case.
1258 switch (SLocEntryCursor.readRecord(E.ID, Record, &Blob)) {
1259 default: // Default behavior: ignore.
1262 case SM_SLOC_FILE_ENTRY:
1263 case SM_SLOC_BUFFER_ENTRY:
1264 case SM_SLOC_EXPANSION_ENTRY:
1265 // Once we hit one of the source location entries, we're done.
1271 /// \brief If a header file is not found at the path that we expect it to be
1272 /// and the PCH file was moved from its original location, try to resolve the
1273 /// file by assuming that header+PCH were moved together and the header is in
1274 /// the same place relative to the PCH.
1276 resolveFileRelativeToOriginalDir(const std::string &Filename,
1277 const std::string &OriginalDir,
1278 const std::string &CurrDir) {
1279 assert(OriginalDir != CurrDir &&
1280 "No point trying to resolve the file if the PCH dir didn't change");
1281 using namespace llvm::sys;
1282 SmallString<128> filePath(Filename);
1283 fs::make_absolute(filePath);
1284 assert(path::is_absolute(OriginalDir));
1285 SmallString<128> currPCHPath(CurrDir);
1287 path::const_iterator fileDirI = path::begin(path::parent_path(filePath)),
1288 fileDirE = path::end(path::parent_path(filePath));
1289 path::const_iterator origDirI = path::begin(OriginalDir),
1290 origDirE = path::end(OriginalDir);
1291 // Skip the common path components from filePath and OriginalDir.
1292 while (fileDirI != fileDirE && origDirI != origDirE &&
1293 *fileDirI == *origDirI) {
1297 for (; origDirI != origDirE; ++origDirI)
1298 path::append(currPCHPath, "..");
1299 path::append(currPCHPath, fileDirI, fileDirE);
1300 path::append(currPCHPath, path::filename(Filename));
1301 return currPCHPath.str();
1304 bool ASTReader::ReadSLocEntry(int ID) {
1308 if (unsigned(-ID) - 2 >= getTotalNumSLocs() || ID > 0) {
1309 Error("source location entry ID out-of-range for AST file");
1313 // Local helper to read the (possibly-compressed) buffer data following the
1315 auto ReadBuffer = [this](
1316 BitstreamCursor &SLocEntryCursor,
1317 StringRef Name) -> std::unique_ptr<llvm::MemoryBuffer> {
1320 unsigned Code = SLocEntryCursor.ReadCode();
1321 unsigned RecCode = SLocEntryCursor.readRecord(Code, Record, &Blob);
1323 if (RecCode == SM_SLOC_BUFFER_BLOB_COMPRESSED) {
1324 if (!llvm::zlib::isAvailable()) {
1325 Error("zlib is not available");
1328 SmallString<0> Uncompressed;
1330 llvm::zlib::uncompress(Blob, Uncompressed, Record[0])) {
1331 Error("could not decompress embedded file contents: " +
1332 llvm::toString(std::move(E)));
1335 return llvm::MemoryBuffer::getMemBufferCopy(Uncompressed, Name);
1336 } else if (RecCode == SM_SLOC_BUFFER_BLOB) {
1337 return llvm::MemoryBuffer::getMemBuffer(Blob.drop_back(1), Name, true);
1339 Error("AST record has invalid code");
1344 ModuleFile *F = GlobalSLocEntryMap.find(-ID)->second;
1345 F->SLocEntryCursor.JumpToBit(F->SLocEntryOffsets[ID - F->SLocEntryBaseID]);
1346 BitstreamCursor &SLocEntryCursor = F->SLocEntryCursor;
1347 unsigned BaseOffset = F->SLocEntryBaseOffset;
1349 ++NumSLocEntriesRead;
1350 llvm::BitstreamEntry Entry = SLocEntryCursor.advance();
1351 if (Entry.Kind != llvm::BitstreamEntry::Record) {
1352 Error("incorrectly-formatted source location entry in AST file");
1358 switch (SLocEntryCursor.readRecord(Entry.ID, Record, &Blob)) {
1360 Error("incorrectly-formatted source location entry in AST file");
1363 case SM_SLOC_FILE_ENTRY: {
1364 // We will detect whether a file changed and return 'Failure' for it, but
1365 // we will also try to fail gracefully by setting up the SLocEntry.
1366 unsigned InputID = Record[4];
1367 InputFile IF = getInputFile(*F, InputID);
1368 const FileEntry *File = IF.getFile();
1369 bool OverriddenBuffer = IF.isOverridden();
1371 // Note that we only check if a File was returned. If it was out-of-date
1372 // we have complained but we will continue creating a FileID to recover
1377 SourceLocation IncludeLoc = ReadSourceLocation(*F, Record[1]);
1378 if (IncludeLoc.isInvalid() && F->Kind != MK_MainFile) {
1379 // This is the module's main file.
1380 IncludeLoc = getImportLocation(F);
1382 SrcMgr::CharacteristicKind
1383 FileCharacter = (SrcMgr::CharacteristicKind)Record[2];
1384 FileID FID = SourceMgr.createFileID(File, IncludeLoc, FileCharacter,
1385 ID, BaseOffset + Record[0]);
1386 SrcMgr::FileInfo &FileInfo =
1387 const_cast<SrcMgr::FileInfo&>(SourceMgr.getSLocEntry(FID).getFile());
1388 FileInfo.NumCreatedFIDs = Record[5];
1390 FileInfo.setHasLineDirectives();
1392 const DeclID *FirstDecl = F->FileSortedDecls + Record[6];
1393 unsigned NumFileDecls = Record[7];
1394 if (NumFileDecls && ContextObj) {
1395 assert(F->FileSortedDecls && "FILE_SORTED_DECLS not encountered yet ?");
1396 FileDeclIDs[FID] = FileDeclsInfo(F, llvm::makeArrayRef(FirstDecl,
1400 const SrcMgr::ContentCache *ContentCache
1401 = SourceMgr.getOrCreateContentCache(File, isSystem(FileCharacter));
1402 if (OverriddenBuffer && !ContentCache->BufferOverridden &&
1403 ContentCache->ContentsEntry == ContentCache->OrigEntry &&
1404 !ContentCache->getRawBuffer()) {
1405 auto Buffer = ReadBuffer(SLocEntryCursor, File->getName());
1408 SourceMgr.overrideFileContents(File, std::move(Buffer));
1414 case SM_SLOC_BUFFER_ENTRY: {
1415 const char *Name = Blob.data();
1416 unsigned Offset = Record[0];
1417 SrcMgr::CharacteristicKind
1418 FileCharacter = (SrcMgr::CharacteristicKind)Record[2];
1419 SourceLocation IncludeLoc = ReadSourceLocation(*F, Record[1]);
1420 if (IncludeLoc.isInvalid() && F->isModule()) {
1421 IncludeLoc = getImportLocation(F);
1424 auto Buffer = ReadBuffer(SLocEntryCursor, Name);
1427 SourceMgr.createFileID(std::move(Buffer), FileCharacter, ID,
1428 BaseOffset + Offset, IncludeLoc);
1432 case SM_SLOC_EXPANSION_ENTRY: {
1433 SourceLocation SpellingLoc = ReadSourceLocation(*F, Record[1]);
1434 SourceMgr.createExpansionLoc(SpellingLoc,
1435 ReadSourceLocation(*F, Record[2]),
1436 ReadSourceLocation(*F, Record[3]),
1439 BaseOffset + Record[0]);
1447 std::pair<SourceLocation, StringRef> ASTReader::getModuleImportLoc(int ID) {
1449 return std::make_pair(SourceLocation(), "");
1451 if (unsigned(-ID) - 2 >= getTotalNumSLocs() || ID > 0) {
1452 Error("source location entry ID out-of-range for AST file");
1453 return std::make_pair(SourceLocation(), "");
1456 // Find which module file this entry lands in.
1457 ModuleFile *M = GlobalSLocEntryMap.find(-ID)->second;
1459 return std::make_pair(SourceLocation(), "");
1461 // FIXME: Can we map this down to a particular submodule? That would be
1463 return std::make_pair(M->ImportLoc, StringRef(M->ModuleName));
1466 /// \brief Find the location where the module F is imported.
1467 SourceLocation ASTReader::getImportLocation(ModuleFile *F) {
1468 if (F->ImportLoc.isValid())
1469 return F->ImportLoc;
1471 // Otherwise we have a PCH. It's considered to be "imported" at the first
1472 // location of its includer.
1473 if (F->ImportedBy.empty() || !F->ImportedBy[0]) {
1474 // Main file is the importer.
1475 assert(SourceMgr.getMainFileID().isValid() && "missing main file");
1476 return SourceMgr.getLocForStartOfFile(SourceMgr.getMainFileID());
1478 return F->ImportedBy[0]->FirstLoc;
1481 /// ReadBlockAbbrevs - Enter a subblock of the specified BlockID with the
1482 /// specified cursor. Read the abbreviations that are at the top of the block
1483 /// and then leave the cursor pointing into the block.
1484 bool ASTReader::ReadBlockAbbrevs(BitstreamCursor &Cursor, unsigned BlockID) {
1485 if (Cursor.EnterSubBlock(BlockID))
1489 uint64_t Offset = Cursor.GetCurrentBitNo();
1490 unsigned Code = Cursor.ReadCode();
1492 // We expect all abbrevs to be at the start of the block.
1493 if (Code != llvm::bitc::DEFINE_ABBREV) {
1494 Cursor.JumpToBit(Offset);
1497 Cursor.ReadAbbrevRecord();
1501 Token ASTReader::ReadToken(ModuleFile &F, const RecordDataImpl &Record,
1505 Tok.setLocation(ReadSourceLocation(F, Record, Idx));
1506 Tok.setLength(Record[Idx++]);
1507 if (IdentifierInfo *II = getLocalIdentifier(F, Record[Idx++]))
1508 Tok.setIdentifierInfo(II);
1509 Tok.setKind((tok::TokenKind)Record[Idx++]);
1510 Tok.setFlag((Token::TokenFlags)Record[Idx++]);
1514 MacroInfo *ASTReader::ReadMacroRecord(ModuleFile &F, uint64_t Offset) {
1515 BitstreamCursor &Stream = F.MacroCursor;
1517 // Keep track of where we are in the stream, then jump back there
1518 // after reading this macro.
1519 SavedStreamPosition SavedPosition(Stream);
1521 Stream.JumpToBit(Offset);
1523 SmallVector<IdentifierInfo*, 16> MacroParams;
1524 MacroInfo *Macro = nullptr;
1527 // Advance to the next record, but if we get to the end of the block, don't
1528 // pop it (removing all the abbreviations from the cursor) since we want to
1529 // be able to reseek within the block and read entries.
1530 unsigned Flags = BitstreamCursor::AF_DontPopBlockAtEnd;
1531 llvm::BitstreamEntry Entry = Stream.advanceSkippingSubblocks(Flags);
1533 switch (Entry.Kind) {
1534 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
1535 case llvm::BitstreamEntry::Error:
1536 Error("malformed block record in AST file");
1538 case llvm::BitstreamEntry::EndBlock:
1540 case llvm::BitstreamEntry::Record:
1541 // The interesting case.
1547 PreprocessorRecordTypes RecType =
1548 (PreprocessorRecordTypes)Stream.readRecord(Entry.ID, Record);
1550 case PP_MODULE_MACRO:
1551 case PP_MACRO_DIRECTIVE_HISTORY:
1554 case PP_MACRO_OBJECT_LIKE:
1555 case PP_MACRO_FUNCTION_LIKE: {
1556 // If we already have a macro, that means that we've hit the end
1557 // of the definition of the macro we were looking for. We're
1562 unsigned NextIndex = 1; // Skip identifier ID.
1563 SourceLocation Loc = ReadSourceLocation(F, Record, NextIndex);
1564 MacroInfo *MI = PP.AllocateMacroInfo(Loc);
1565 MI->setDefinitionEndLoc(ReadSourceLocation(F, Record, NextIndex));
1566 MI->setIsUsed(Record[NextIndex++]);
1567 MI->setUsedForHeaderGuard(Record[NextIndex++]);
1569 if (RecType == PP_MACRO_FUNCTION_LIKE) {
1570 // Decode function-like macro info.
1571 bool isC99VarArgs = Record[NextIndex++];
1572 bool isGNUVarArgs = Record[NextIndex++];
1573 bool hasCommaPasting = Record[NextIndex++];
1574 MacroParams.clear();
1575 unsigned NumArgs = Record[NextIndex++];
1576 for (unsigned i = 0; i != NumArgs; ++i)
1577 MacroParams.push_back(getLocalIdentifier(F, Record[NextIndex++]));
1579 // Install function-like macro info.
1580 MI->setIsFunctionLike();
1581 if (isC99VarArgs) MI->setIsC99Varargs();
1582 if (isGNUVarArgs) MI->setIsGNUVarargs();
1583 if (hasCommaPasting) MI->setHasCommaPasting();
1584 MI->setParameterList(MacroParams, PP.getPreprocessorAllocator());
1587 // Remember that we saw this macro last so that we add the tokens that
1588 // form its body to it.
1591 if (NextIndex + 1 == Record.size() && PP.getPreprocessingRecord() &&
1592 Record[NextIndex]) {
1593 // We have a macro definition. Register the association
1594 PreprocessedEntityID
1595 GlobalID = getGlobalPreprocessedEntityID(F, Record[NextIndex]);
1596 PreprocessingRecord &PPRec = *PP.getPreprocessingRecord();
1597 PreprocessingRecord::PPEntityID PPID =
1598 PPRec.getPPEntityID(GlobalID - 1, /*isLoaded=*/true);
1599 MacroDefinitionRecord *PPDef = cast_or_null<MacroDefinitionRecord>(
1600 PPRec.getPreprocessedEntity(PPID));
1602 PPRec.RegisterMacroDefinition(Macro, PPDef);
1610 // If we see a TOKEN before a PP_MACRO_*, then the file is
1611 // erroneous, just pretend we didn't see this.
1615 Token Tok = ReadToken(F, Record, Idx);
1616 Macro->AddTokenToBody(Tok);
1623 PreprocessedEntityID
1624 ASTReader::getGlobalPreprocessedEntityID(ModuleFile &M,
1625 unsigned LocalID) const {
1626 if (!M.ModuleOffsetMap.empty())
1627 ReadModuleOffsetMap(M);
1629 ContinuousRangeMap<uint32_t, int, 2>::const_iterator
1630 I = M.PreprocessedEntityRemap.find(LocalID - NUM_PREDEF_PP_ENTITY_IDS);
1631 assert(I != M.PreprocessedEntityRemap.end()
1632 && "Invalid index into preprocessed entity index remap");
1634 return LocalID + I->second;
1637 unsigned HeaderFileInfoTrait::ComputeHash(internal_key_ref ikey) {
1638 return llvm::hash_combine(ikey.Size, ikey.ModTime);
1641 HeaderFileInfoTrait::internal_key_type
1642 HeaderFileInfoTrait::GetInternalKey(const FileEntry *FE) {
1643 internal_key_type ikey = {FE->getSize(),
1644 M.HasTimestamps ? FE->getModificationTime() : 0,
1645 FE->getName(), /*Imported*/ false};
1649 bool HeaderFileInfoTrait::EqualKey(internal_key_ref a, internal_key_ref b) {
1650 if (a.Size != b.Size || (a.ModTime && b.ModTime && a.ModTime != b.ModTime))
1653 if (llvm::sys::path::is_absolute(a.Filename) && a.Filename == b.Filename)
1656 // Determine whether the actual files are equivalent.
1657 FileManager &FileMgr = Reader.getFileManager();
1658 auto GetFile = [&](const internal_key_type &Key) -> const FileEntry* {
1660 return FileMgr.getFile(Key.Filename);
1662 std::string Resolved = Key.Filename;
1663 Reader.ResolveImportedPath(M, Resolved);
1664 return FileMgr.getFile(Resolved);
1667 const FileEntry *FEA = GetFile(a);
1668 const FileEntry *FEB = GetFile(b);
1669 return FEA && FEA == FEB;
1672 std::pair<unsigned, unsigned>
1673 HeaderFileInfoTrait::ReadKeyDataLength(const unsigned char*& d) {
1674 using namespace llvm::support;
1675 unsigned KeyLen = (unsigned) endian::readNext<uint16_t, little, unaligned>(d);
1676 unsigned DataLen = (unsigned) *d++;
1677 return std::make_pair(KeyLen, DataLen);
1680 HeaderFileInfoTrait::internal_key_type
1681 HeaderFileInfoTrait::ReadKey(const unsigned char *d, unsigned) {
1682 using namespace llvm::support;
1683 internal_key_type ikey;
1684 ikey.Size = off_t(endian::readNext<uint64_t, little, unaligned>(d));
1685 ikey.ModTime = time_t(endian::readNext<uint64_t, little, unaligned>(d));
1686 ikey.Filename = (const char *)d;
1687 ikey.Imported = true;
1691 HeaderFileInfoTrait::data_type
1692 HeaderFileInfoTrait::ReadData(internal_key_ref key, const unsigned char *d,
1694 const unsigned char *End = d + DataLen;
1695 using namespace llvm::support;
1697 unsigned Flags = *d++;
1698 // FIXME: Refactor with mergeHeaderFileInfo in HeaderSearch.cpp.
1699 HFI.isImport |= (Flags >> 5) & 0x01;
1700 HFI.isPragmaOnce |= (Flags >> 4) & 0x01;
1701 HFI.DirInfo = (Flags >> 1) & 0x07;
1702 HFI.IndexHeaderMapHeader = Flags & 0x01;
1703 // FIXME: Find a better way to handle this. Maybe just store a
1704 // "has been included" flag?
1705 HFI.NumIncludes = std::max(endian::readNext<uint16_t, little, unaligned>(d),
1707 HFI.ControllingMacroID = Reader.getGlobalIdentifierID(
1708 M, endian::readNext<uint32_t, little, unaligned>(d));
1709 if (unsigned FrameworkOffset =
1710 endian::readNext<uint32_t, little, unaligned>(d)) {
1711 // The framework offset is 1 greater than the actual offset,
1712 // since 0 is used as an indicator for "no framework name".
1713 StringRef FrameworkName(FrameworkStrings + FrameworkOffset - 1);
1714 HFI.Framework = HS->getUniqueFrameworkName(FrameworkName);
1717 assert((End - d) % 4 == 0 &&
1718 "Wrong data length in HeaderFileInfo deserialization");
1720 uint32_t LocalSMID = endian::readNext<uint32_t, little, unaligned>(d);
1721 auto HeaderRole = static_cast<ModuleMap::ModuleHeaderRole>(LocalSMID & 3);
1724 // This header is part of a module. Associate it with the module to enable
1725 // implicit module import.
1726 SubmoduleID GlobalSMID = Reader.getGlobalSubmoduleID(M, LocalSMID);
1727 Module *Mod = Reader.getSubmodule(GlobalSMID);
1728 FileManager &FileMgr = Reader.getFileManager();
1730 Reader.getPreprocessor().getHeaderSearchInfo().getModuleMap();
1732 std::string Filename = key.Filename;
1734 Reader.ResolveImportedPath(M, Filename);
1735 // FIXME: This is not always the right filename-as-written, but we're not
1736 // going to use this information to rebuild the module, so it doesn't make
1737 // a lot of difference.
1738 Module::Header H = { key.Filename, FileMgr.getFile(Filename) };
1739 ModMap.addHeader(Mod, H, HeaderRole, /*Imported*/true);
1740 HFI.isModuleHeader |= !(HeaderRole & ModuleMap::TextualHeader);
1743 // This HeaderFileInfo was externally loaded.
1744 HFI.External = true;
1749 void ASTReader::addPendingMacro(IdentifierInfo *II,
1751 uint64_t MacroDirectivesOffset) {
1752 assert(NumCurrentElementsDeserializing > 0 &&"Missing deserialization guard");
1753 PendingMacroIDs[II].push_back(PendingMacroInfo(M, MacroDirectivesOffset));
1756 void ASTReader::ReadDefinedMacros() {
1757 // Note that we are loading defined macros.
1758 Deserializing Macros(this);
1760 for (ModuleFile &I : llvm::reverse(ModuleMgr)) {
1761 BitstreamCursor &MacroCursor = I.MacroCursor;
1763 // If there was no preprocessor block, skip this file.
1764 if (MacroCursor.getBitcodeBytes().empty())
1767 BitstreamCursor Cursor = MacroCursor;
1768 Cursor.JumpToBit(I.MacroStartOffset);
1772 llvm::BitstreamEntry E = Cursor.advanceSkippingSubblocks();
1775 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
1776 case llvm::BitstreamEntry::Error:
1777 Error("malformed block record in AST file");
1779 case llvm::BitstreamEntry::EndBlock:
1782 case llvm::BitstreamEntry::Record:
1784 switch (Cursor.readRecord(E.ID, Record)) {
1785 default: // Default behavior: ignore.
1788 case PP_MACRO_OBJECT_LIKE:
1789 case PP_MACRO_FUNCTION_LIKE: {
1790 IdentifierInfo *II = getLocalIdentifier(I, Record[0]);
1791 if (II->isOutOfDate())
1792 updateOutOfDateIdentifier(*II);
1809 /// \brief Visitor class used to look up identifirs in an AST file.
1810 class IdentifierLookupVisitor {
1813 unsigned PriorGeneration;
1814 unsigned &NumIdentifierLookups;
1815 unsigned &NumIdentifierLookupHits;
1816 IdentifierInfo *Found;
1819 IdentifierLookupVisitor(StringRef Name, unsigned PriorGeneration,
1820 unsigned &NumIdentifierLookups,
1821 unsigned &NumIdentifierLookupHits)
1822 : Name(Name), NameHash(ASTIdentifierLookupTrait::ComputeHash(Name)),
1823 PriorGeneration(PriorGeneration),
1824 NumIdentifierLookups(NumIdentifierLookups),
1825 NumIdentifierLookupHits(NumIdentifierLookupHits),
1830 bool operator()(ModuleFile &M) {
1831 // If we've already searched this module file, skip it now.
1832 if (M.Generation <= PriorGeneration)
1835 ASTIdentifierLookupTable *IdTable
1836 = (ASTIdentifierLookupTable *)M.IdentifierLookupTable;
1840 ASTIdentifierLookupTrait Trait(IdTable->getInfoObj().getReader(), M,
1842 ++NumIdentifierLookups;
1843 ASTIdentifierLookupTable::iterator Pos =
1844 IdTable->find_hashed(Name, NameHash, &Trait);
1845 if (Pos == IdTable->end())
1848 // Dereferencing the iterator has the effect of building the
1849 // IdentifierInfo node and populating it with the various
1850 // declarations it needs.
1851 ++NumIdentifierLookupHits;
1856 // \brief Retrieve the identifier info found within the module
1858 IdentifierInfo *getIdentifierInfo() const { return Found; }
1861 } // end anonymous namespace
1863 void ASTReader::updateOutOfDateIdentifier(IdentifierInfo &II) {
1864 // Note that we are loading an identifier.
1865 Deserializing AnIdentifier(this);
1867 unsigned PriorGeneration = 0;
1868 if (getContext().getLangOpts().Modules)
1869 PriorGeneration = IdentifierGeneration[&II];
1871 // If there is a global index, look there first to determine which modules
1872 // provably do not have any results for this identifier.
1873 GlobalModuleIndex::HitSet Hits;
1874 GlobalModuleIndex::HitSet *HitsPtr = nullptr;
1875 if (!loadGlobalIndex()) {
1876 if (GlobalIndex->lookupIdentifier(II.getName(), Hits)) {
1881 IdentifierLookupVisitor Visitor(II.getName(), PriorGeneration,
1882 NumIdentifierLookups,
1883 NumIdentifierLookupHits);
1884 ModuleMgr.visit(Visitor, HitsPtr);
1885 markIdentifierUpToDate(&II);
1888 void ASTReader::markIdentifierUpToDate(IdentifierInfo *II) {
1892 II->setOutOfDate(false);
1894 // Update the generation for this identifier.
1895 if (getContext().getLangOpts().Modules)
1896 IdentifierGeneration[II] = getGeneration();
1899 void ASTReader::resolvePendingMacro(IdentifierInfo *II,
1900 const PendingMacroInfo &PMInfo) {
1901 ModuleFile &M = *PMInfo.M;
1903 BitstreamCursor &Cursor = M.MacroCursor;
1904 SavedStreamPosition SavedPosition(Cursor);
1905 Cursor.JumpToBit(PMInfo.MacroDirectivesOffset);
1907 struct ModuleMacroRecord {
1908 SubmoduleID SubModID;
1910 SmallVector<SubmoduleID, 8> Overrides;
1912 llvm::SmallVector<ModuleMacroRecord, 8> ModuleMacros;
1914 // We expect to see a sequence of PP_MODULE_MACRO records listing exported
1915 // macros, followed by a PP_MACRO_DIRECTIVE_HISTORY record with the complete
1919 llvm::BitstreamEntry Entry =
1920 Cursor.advance(BitstreamCursor::AF_DontPopBlockAtEnd);
1921 if (Entry.Kind != llvm::BitstreamEntry::Record) {
1922 Error("malformed block record in AST file");
1927 switch ((PreprocessorRecordTypes)Cursor.readRecord(Entry.ID, Record)) {
1928 case PP_MACRO_DIRECTIVE_HISTORY:
1931 case PP_MODULE_MACRO: {
1932 ModuleMacros.push_back(ModuleMacroRecord());
1933 auto &Info = ModuleMacros.back();
1934 Info.SubModID = getGlobalSubmoduleID(M, Record[0]);
1935 Info.MI = getMacro(getGlobalMacroID(M, Record[1]));
1936 for (int I = 2, N = Record.size(); I != N; ++I)
1937 Info.Overrides.push_back(getGlobalSubmoduleID(M, Record[I]));
1942 Error("malformed block record in AST file");
1946 // We found the macro directive history; that's the last record
1951 // Module macros are listed in reverse dependency order.
1953 std::reverse(ModuleMacros.begin(), ModuleMacros.end());
1954 llvm::SmallVector<ModuleMacro*, 8> Overrides;
1955 for (auto &MMR : ModuleMacros) {
1957 for (unsigned ModID : MMR.Overrides) {
1958 Module *Mod = getSubmodule(ModID);
1959 auto *Macro = PP.getModuleMacro(Mod, II);
1960 assert(Macro && "missing definition for overridden macro");
1961 Overrides.push_back(Macro);
1964 bool Inserted = false;
1965 Module *Owner = getSubmodule(MMR.SubModID);
1966 PP.addModuleMacro(Owner, II, MMR.MI, Overrides, Inserted);
1970 // Don't read the directive history for a module; we don't have anywhere
1975 // Deserialize the macro directives history in reverse source-order.
1976 MacroDirective *Latest = nullptr, *Earliest = nullptr;
1977 unsigned Idx = 0, N = Record.size();
1979 MacroDirective *MD = nullptr;
1980 SourceLocation Loc = ReadSourceLocation(M, Record, Idx);
1981 MacroDirective::Kind K = (MacroDirective::Kind)Record[Idx++];
1983 case MacroDirective::MD_Define: {
1984 MacroInfo *MI = getMacro(getGlobalMacroID(M, Record[Idx++]));
1985 MD = PP.AllocateDefMacroDirective(MI, Loc);
1988 case MacroDirective::MD_Undefine: {
1989 MD = PP.AllocateUndefMacroDirective(Loc);
1992 case MacroDirective::MD_Visibility:
1993 bool isPublic = Record[Idx++];
1994 MD = PP.AllocateVisibilityMacroDirective(Loc, isPublic);
2001 Earliest->setPrevious(MD);
2006 PP.setLoadedMacroDirective(II, Earliest, Latest);
2009 ASTReader::InputFileInfo
2010 ASTReader::readInputFileInfo(ModuleFile &F, unsigned ID) {
2011 // Go find this input file.
2012 BitstreamCursor &Cursor = F.InputFilesCursor;
2013 SavedStreamPosition SavedPosition(Cursor);
2014 Cursor.JumpToBit(F.InputFileOffsets[ID-1]);
2016 unsigned Code = Cursor.ReadCode();
2020 unsigned Result = Cursor.readRecord(Code, Record, &Blob);
2021 assert(static_cast<InputFileRecordTypes>(Result) == INPUT_FILE &&
2022 "invalid record type for input file");
2025 assert(Record[0] == ID && "Bogus stored ID or offset");
2027 R.StoredSize = static_cast<off_t>(Record[1]);
2028 R.StoredTime = static_cast<time_t>(Record[2]);
2029 R.Overridden = static_cast<bool>(Record[3]);
2030 R.Transient = static_cast<bool>(Record[4]);
2031 R.TopLevelModuleMap = static_cast<bool>(Record[5]);
2033 ResolveImportedPath(F, R.Filename);
2037 static unsigned moduleKindForDiagnostic(ModuleKind Kind);
2038 InputFile ASTReader::getInputFile(ModuleFile &F, unsigned ID, bool Complain) {
2039 // If this ID is bogus, just return an empty input file.
2040 if (ID == 0 || ID > F.InputFilesLoaded.size())
2043 // If we've already loaded this input file, return it.
2044 if (F.InputFilesLoaded[ID-1].getFile())
2045 return F.InputFilesLoaded[ID-1];
2047 if (F.InputFilesLoaded[ID-1].isNotFound())
2050 // Go find this input file.
2051 BitstreamCursor &Cursor = F.InputFilesCursor;
2052 SavedStreamPosition SavedPosition(Cursor);
2053 Cursor.JumpToBit(F.InputFileOffsets[ID-1]);
2055 InputFileInfo FI = readInputFileInfo(F, ID);
2056 off_t StoredSize = FI.StoredSize;
2057 time_t StoredTime = FI.StoredTime;
2058 bool Overridden = FI.Overridden;
2059 bool Transient = FI.Transient;
2060 StringRef Filename = FI.Filename;
2062 const FileEntry *File = FileMgr.getFile(Filename, /*OpenFile=*/false);
2064 // If we didn't find the file, resolve it relative to the
2065 // original directory from which this AST file was created.
2066 if (File == nullptr && !F.OriginalDir.empty() && !CurrentDir.empty() &&
2067 F.OriginalDir != CurrentDir) {
2068 std::string Resolved = resolveFileRelativeToOriginalDir(Filename,
2071 if (!Resolved.empty())
2072 File = FileMgr.getFile(Resolved);
2075 // For an overridden file, create a virtual file with the stored
2077 if ((Overridden || Transient) && File == nullptr)
2078 File = FileMgr.getVirtualFile(Filename, StoredSize, StoredTime);
2080 if (File == nullptr) {
2082 std::string ErrorStr = "could not find file '";
2083 ErrorStr += Filename;
2084 ErrorStr += "' referenced by AST file '";
2085 ErrorStr += F.FileName;
2089 // Record that we didn't find the file.
2090 F.InputFilesLoaded[ID-1] = InputFile::getNotFound();
2094 // Check if there was a request to override the contents of the file
2095 // that was part of the precompiled header. Overridding such a file
2096 // can lead to problems when lexing using the source locations from the
2098 SourceManager &SM = getSourceManager();
2099 // FIXME: Reject if the overrides are different.
2100 if ((!Overridden && !Transient) && SM.isFileOverridden(File)) {
2102 Error(diag::err_fe_pch_file_overridden, Filename);
2103 // After emitting the diagnostic, recover by disabling the override so
2104 // that the original file will be used.
2106 // FIXME: This recovery is just as broken as the original state; there may
2107 // be another precompiled module that's using the overridden contents, or
2108 // we might be half way through parsing it. Instead, we should treat the
2109 // overridden contents as belonging to a separate FileEntry.
2110 SM.disableFileContentsOverride(File);
2111 // The FileEntry is a virtual file entry with the size of the contents
2112 // that would override the original contents. Set it to the original's
2114 FileMgr.modifyFileEntry(const_cast<FileEntry*>(File),
2115 StoredSize, StoredTime);
2118 bool IsOutOfDate = false;
2120 // For an overridden file, there is nothing to validate.
2121 if (!Overridden && //
2122 (StoredSize != File->getSize() ||
2123 (StoredTime && StoredTime != File->getModificationTime() &&
2127 // Build a list of the PCH imports that got us here (in reverse).
2128 SmallVector<ModuleFile *, 4> ImportStack(1, &F);
2129 while (ImportStack.back()->ImportedBy.size() > 0)
2130 ImportStack.push_back(ImportStack.back()->ImportedBy[0]);
2132 // The top-level PCH is stale.
2133 StringRef TopLevelPCHName(ImportStack.back()->FileName);
2134 unsigned DiagnosticKind = moduleKindForDiagnostic(ImportStack.back()->Kind);
2135 if (DiagnosticKind == 0)
2136 Error(diag::err_fe_pch_file_modified, Filename, TopLevelPCHName);
2137 else if (DiagnosticKind == 1)
2138 Error(diag::err_fe_module_file_modified, Filename, TopLevelPCHName);
2140 Error(diag::err_fe_ast_file_modified, Filename, TopLevelPCHName);
2142 // Print the import stack.
2143 if (ImportStack.size() > 1 && !Diags.isDiagnosticInFlight()) {
2144 Diag(diag::note_pch_required_by)
2145 << Filename << ImportStack[0]->FileName;
2146 for (unsigned I = 1; I < ImportStack.size(); ++I)
2147 Diag(diag::note_pch_required_by)
2148 << ImportStack[I-1]->FileName << ImportStack[I]->FileName;
2151 if (!Diags.isDiagnosticInFlight())
2152 Diag(diag::note_pch_rebuild_required) << TopLevelPCHName;
2157 // FIXME: If the file is overridden and we've already opened it,
2158 // issue an error (or split it into a separate FileEntry).
2160 InputFile IF = InputFile(File, Overridden || Transient, IsOutOfDate);
2162 // Note that we've loaded this input file.
2163 F.InputFilesLoaded[ID-1] = IF;
2167 /// \brief If we are loading a relocatable PCH or module file, and the filename
2168 /// is not an absolute path, add the system or module root to the beginning of
2170 void ASTReader::ResolveImportedPath(ModuleFile &M, std::string &Filename) {
2171 // Resolve relative to the base directory, if we have one.
2172 if (!M.BaseDirectory.empty())
2173 return ResolveImportedPath(Filename, M.BaseDirectory);
2176 void ASTReader::ResolveImportedPath(std::string &Filename, StringRef Prefix) {
2177 if (Filename.empty() || llvm::sys::path::is_absolute(Filename))
2180 SmallString<128> Buffer;
2181 llvm::sys::path::append(Buffer, Prefix, Filename);
2182 Filename.assign(Buffer.begin(), Buffer.end());
2185 static bool isDiagnosedResult(ASTReader::ASTReadResult ARR, unsigned Caps) {
2187 case ASTReader::Failure: return true;
2188 case ASTReader::Missing: return !(Caps & ASTReader::ARR_Missing);
2189 case ASTReader::OutOfDate: return !(Caps & ASTReader::ARR_OutOfDate);
2190 case ASTReader::VersionMismatch: return !(Caps & ASTReader::ARR_VersionMismatch);
2191 case ASTReader::ConfigurationMismatch:
2192 return !(Caps & ASTReader::ARR_ConfigurationMismatch);
2193 case ASTReader::HadErrors: return true;
2194 case ASTReader::Success: return false;
2197 llvm_unreachable("unknown ASTReadResult");
2200 ASTReader::ASTReadResult ASTReader::ReadOptionsBlock(
2201 BitstreamCursor &Stream, unsigned ClientLoadCapabilities,
2202 bool AllowCompatibleConfigurationMismatch, ASTReaderListener &Listener,
2203 std::string &SuggestedPredefines) {
2204 if (Stream.EnterSubBlock(OPTIONS_BLOCK_ID))
2207 // Read all of the records in the options block.
2209 ASTReadResult Result = Success;
2211 llvm::BitstreamEntry Entry = Stream.advance();
2213 switch (Entry.Kind) {
2214 case llvm::BitstreamEntry::Error:
2215 case llvm::BitstreamEntry::SubBlock:
2218 case llvm::BitstreamEntry::EndBlock:
2221 case llvm::BitstreamEntry::Record:
2222 // The interesting case.
2226 // Read and process a record.
2228 switch ((OptionsRecordTypes)Stream.readRecord(Entry.ID, Record)) {
2229 case LANGUAGE_OPTIONS: {
2230 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2231 if (ParseLanguageOptions(Record, Complain, Listener,
2232 AllowCompatibleConfigurationMismatch))
2233 Result = ConfigurationMismatch;
2237 case TARGET_OPTIONS: {
2238 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2239 if (ParseTargetOptions(Record, Complain, Listener,
2240 AllowCompatibleConfigurationMismatch))
2241 Result = ConfigurationMismatch;
2245 case FILE_SYSTEM_OPTIONS: {
2246 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2247 if (!AllowCompatibleConfigurationMismatch &&
2248 ParseFileSystemOptions(Record, Complain, Listener))
2249 Result = ConfigurationMismatch;
2253 case HEADER_SEARCH_OPTIONS: {
2254 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2255 if (!AllowCompatibleConfigurationMismatch &&
2256 ParseHeaderSearchOptions(Record, Complain, Listener))
2257 Result = ConfigurationMismatch;
2261 case PREPROCESSOR_OPTIONS:
2262 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2263 if (!AllowCompatibleConfigurationMismatch &&
2264 ParsePreprocessorOptions(Record, Complain, Listener,
2265 SuggestedPredefines))
2266 Result = ConfigurationMismatch;
2272 ASTReader::ASTReadResult
2273 ASTReader::ReadControlBlock(ModuleFile &F,
2274 SmallVectorImpl<ImportedModule> &Loaded,
2275 const ModuleFile *ImportedBy,
2276 unsigned ClientLoadCapabilities) {
2277 BitstreamCursor &Stream = F.Stream;
2278 ASTReadResult Result = Success;
2280 if (Stream.EnterSubBlock(CONTROL_BLOCK_ID)) {
2281 Error("malformed block record in AST file");
2285 // Lambda to read the unhashed control block the first time it's called.
2287 // For PCM files, the unhashed control block cannot be read until after the
2288 // MODULE_NAME record. However, PCH files have no MODULE_NAME, and yet still
2289 // need to look ahead before reading the IMPORTS record. For consistency,
2290 // this block is always read somehow (see BitstreamEntry::EndBlock).
2291 bool HasReadUnhashedControlBlock = false;
2292 auto readUnhashedControlBlockOnce = [&]() {
2293 if (!HasReadUnhashedControlBlock) {
2294 HasReadUnhashedControlBlock = true;
2295 if (ASTReadResult Result =
2296 readUnhashedControlBlock(F, ImportedBy, ClientLoadCapabilities))
2302 // Read all of the records and blocks in the control block.
2304 unsigned NumInputs = 0;
2305 unsigned NumUserInputs = 0;
2307 llvm::BitstreamEntry Entry = Stream.advance();
2309 switch (Entry.Kind) {
2310 case llvm::BitstreamEntry::Error:
2311 Error("malformed block record in AST file");
2313 case llvm::BitstreamEntry::EndBlock: {
2314 // Validate the module before returning. This call catches an AST with
2315 // no module name and no imports.
2316 if (ASTReadResult Result = readUnhashedControlBlockOnce())
2319 // Validate input files.
2320 const HeaderSearchOptions &HSOpts =
2321 PP.getHeaderSearchInfo().getHeaderSearchOpts();
2323 // All user input files reside at the index range [0, NumUserInputs), and
2324 // system input files reside at [NumUserInputs, NumInputs). For explicitly
2325 // loaded module files, ignore missing inputs.
2326 if (!DisableValidation && F.Kind != MK_ExplicitModule &&
2327 F.Kind != MK_PrebuiltModule) {
2328 bool Complain = (ClientLoadCapabilities & ARR_OutOfDate) == 0;
2330 // If we are reading a module, we will create a verification timestamp,
2331 // so we verify all input files. Otherwise, verify only user input
2334 unsigned N = NumUserInputs;
2335 if (ValidateSystemInputs ||
2336 (HSOpts.ModulesValidateOncePerBuildSession &&
2337 F.InputFilesValidationTimestamp <= HSOpts.BuildSessionTimestamp &&
2338 F.Kind == MK_ImplicitModule))
2341 for (unsigned I = 0; I < N; ++I) {
2342 InputFile IF = getInputFile(F, I+1, Complain);
2343 if (!IF.getFile() || IF.isOutOfDate())
2349 Listener->visitModuleFile(F.FileName, F.Kind);
2351 if (Listener && Listener->needsInputFileVisitation()) {
2352 unsigned N = Listener->needsSystemInputFileVisitation() ? NumInputs
2354 for (unsigned I = 0; I < N; ++I) {
2355 bool IsSystem = I >= NumUserInputs;
2356 InputFileInfo FI = readInputFileInfo(F, I+1);
2357 Listener->visitInputFile(FI.Filename, IsSystem, FI.Overridden,
2358 F.Kind == MK_ExplicitModule ||
2359 F.Kind == MK_PrebuiltModule);
2366 case llvm::BitstreamEntry::SubBlock:
2368 case INPUT_FILES_BLOCK_ID:
2369 F.InputFilesCursor = Stream;
2370 if (Stream.SkipBlock() || // Skip with the main cursor
2371 // Read the abbreviations
2372 ReadBlockAbbrevs(F.InputFilesCursor, INPUT_FILES_BLOCK_ID)) {
2373 Error("malformed block record in AST file");
2378 case OPTIONS_BLOCK_ID:
2379 // If we're reading the first module for this group, check its options
2380 // are compatible with ours. For modules it imports, no further checking
2381 // is required, because we checked them when we built it.
2382 if (Listener && !ImportedBy) {
2383 // Should we allow the configuration of the module file to differ from
2384 // the configuration of the current translation unit in a compatible
2387 // FIXME: Allow this for files explicitly specified with -include-pch.
2388 bool AllowCompatibleConfigurationMismatch =
2389 F.Kind == MK_ExplicitModule || F.Kind == MK_PrebuiltModule;
2391 Result = ReadOptionsBlock(Stream, ClientLoadCapabilities,
2392 AllowCompatibleConfigurationMismatch,
2393 *Listener, SuggestedPredefines);
2394 if (Result == Failure) {
2395 Error("malformed block record in AST file");
2399 if (DisableValidation ||
2400 (AllowConfigurationMismatch && Result == ConfigurationMismatch))
2403 // If we can't load the module, exit early since we likely
2404 // will rebuild the module anyway. The stream may be in the
2405 // middle of a block.
2406 if (Result != Success)
2408 } else if (Stream.SkipBlock()) {
2409 Error("malformed block record in AST file");
2415 if (Stream.SkipBlock()) {
2416 Error("malformed block record in AST file");
2422 case llvm::BitstreamEntry::Record:
2423 // The interesting case.
2427 // Read and process a record.
2430 switch ((ControlRecordTypes)Stream.readRecord(Entry.ID, Record, &Blob)) {
2432 if (Record[0] != VERSION_MAJOR && !DisableValidation) {
2433 if ((ClientLoadCapabilities & ARR_VersionMismatch) == 0)
2434 Diag(Record[0] < VERSION_MAJOR? diag::err_pch_version_too_old
2435 : diag::err_pch_version_too_new);
2436 return VersionMismatch;
2439 bool hasErrors = Record[6];
2440 if (hasErrors && !DisableValidation && !AllowASTWithCompilerErrors) {
2441 Diag(diag::err_pch_with_compiler_errors);
2445 Diags.ErrorOccurred = true;
2446 Diags.UncompilableErrorOccurred = true;
2447 Diags.UnrecoverableErrorOccurred = true;
2450 F.RelocatablePCH = Record[4];
2451 // Relative paths in a relocatable PCH are relative to our sysroot.
2452 if (F.RelocatablePCH)
2453 F.BaseDirectory = isysroot.empty() ? "/" : isysroot;
2455 F.HasTimestamps = Record[5];
2457 const std::string &CurBranch = getClangFullRepositoryVersion();
2458 StringRef ASTBranch = Blob;
2459 if (StringRef(CurBranch) != ASTBranch && !DisableValidation) {
2460 if ((ClientLoadCapabilities & ARR_VersionMismatch) == 0)
2461 Diag(diag::err_pch_different_branch) << ASTBranch << CurBranch;
2462 return VersionMismatch;
2468 // Validate the AST before processing any imports (otherwise, untangling
2469 // them can be error-prone and expensive). A module will have a name and
2470 // will already have been validated, but this catches the PCH case.
2471 if (ASTReadResult Result = readUnhashedControlBlockOnce())
2474 // Load each of the imported PCH files.
2475 unsigned Idx = 0, N = Record.size();
2477 // Read information about the AST file.
2478 ModuleKind ImportedKind = (ModuleKind)Record[Idx++];
2479 // The import location will be the local one for now; we will adjust
2480 // all import locations of module imports after the global source
2481 // location info are setup, in ReadAST.
2482 SourceLocation ImportLoc =
2483 ReadUntranslatedSourceLocation(Record[Idx++]);
2484 off_t StoredSize = (off_t)Record[Idx++];
2485 time_t StoredModTime = (time_t)Record[Idx++];
2486 ASTFileSignature StoredSignature = {
2487 {{(uint32_t)Record[Idx++], (uint32_t)Record[Idx++],
2488 (uint32_t)Record[Idx++], (uint32_t)Record[Idx++],
2489 (uint32_t)Record[Idx++]}}};
2490 auto ImportedFile = ReadPath(F, Record, Idx);
2492 // If our client can't cope with us being out of date, we can't cope with
2493 // our dependency being missing.
2494 unsigned Capabilities = ClientLoadCapabilities;
2495 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
2496 Capabilities &= ~ARR_Missing;
2498 // Load the AST file.
2499 auto Result = ReadASTCore(ImportedFile, ImportedKind, ImportLoc, &F,
2500 Loaded, StoredSize, StoredModTime,
2501 StoredSignature, Capabilities);
2503 // If we diagnosed a problem, produce a backtrace.
2504 if (isDiagnosedResult(Result, Capabilities))
2505 Diag(diag::note_module_file_imported_by)
2506 << F.FileName << !F.ModuleName.empty() << F.ModuleName;
2509 case Failure: return Failure;
2510 // If we have to ignore the dependency, we'll have to ignore this too.
2512 case OutOfDate: return OutOfDate;
2513 case VersionMismatch: return VersionMismatch;
2514 case ConfigurationMismatch: return ConfigurationMismatch;
2515 case HadErrors: return HadErrors;
2516 case Success: break;
2523 F.OriginalSourceFileID = FileID::get(Record[0]);
2524 F.ActualOriginalSourceFileName = Blob;
2525 F.OriginalSourceFileName = F.ActualOriginalSourceFileName;
2526 ResolveImportedPath(F, F.OriginalSourceFileName);
2529 case ORIGINAL_FILE_ID:
2530 F.OriginalSourceFileID = FileID::get(Record[0]);
2533 case ORIGINAL_PCH_DIR:
2534 F.OriginalDir = Blob;
2538 F.ModuleName = Blob;
2540 Listener->ReadModuleName(F.ModuleName);
2542 // Validate the AST as soon as we have a name so we can exit early on
2544 if (ASTReadResult Result = readUnhashedControlBlockOnce())
2549 case MODULE_DIRECTORY: {
2550 assert(!F.ModuleName.empty() &&
2551 "MODULE_DIRECTORY found before MODULE_NAME");
2552 // If we've already loaded a module map file covering this module, we may
2553 // have a better path for it (relative to the current build).
2554 Module *M = PP.getHeaderSearchInfo().lookupModule(F.ModuleName);
2555 if (M && M->Directory) {
2556 // If we're implicitly loading a module, the base directory can't
2557 // change between the build and use.
2558 if (F.Kind != MK_ExplicitModule && F.Kind != MK_PrebuiltModule) {
2559 const DirectoryEntry *BuildDir =
2560 PP.getFileManager().getDirectory(Blob);
2561 if (!BuildDir || BuildDir != M->Directory) {
2562 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
2563 Diag(diag::err_imported_module_relocated)
2564 << F.ModuleName << Blob << M->Directory->getName();
2568 F.BaseDirectory = M->Directory->getName();
2570 F.BaseDirectory = Blob;
2575 case MODULE_MAP_FILE:
2576 if (ASTReadResult Result =
2577 ReadModuleMapFileBlock(Record, F, ImportedBy, ClientLoadCapabilities))
2581 case INPUT_FILE_OFFSETS:
2582 NumInputs = Record[0];
2583 NumUserInputs = Record[1];
2584 F.InputFileOffsets =
2585 (const llvm::support::unaligned_uint64_t *)Blob.data();
2586 F.InputFilesLoaded.resize(NumInputs);
2587 F.NumUserInputFiles = NumUserInputs;
2593 ASTReader::ASTReadResult
2594 ASTReader::ReadASTBlock(ModuleFile &F, unsigned ClientLoadCapabilities) {
2595 BitstreamCursor &Stream = F.Stream;
2597 if (Stream.EnterSubBlock(AST_BLOCK_ID)) {
2598 Error("malformed block record in AST file");
2602 // Read all of the records and blocks for the AST file.
2605 llvm::BitstreamEntry Entry = Stream.advance();
2607 switch (Entry.Kind) {
2608 case llvm::BitstreamEntry::Error:
2609 Error("error at end of module block in AST file");
2611 case llvm::BitstreamEntry::EndBlock: {
2612 // Outside of C++, we do not store a lookup map for the translation unit.
2613 // Instead, mark it as needing a lookup map to be built if this module
2614 // contains any declarations lexically within it (which it always does!).
2615 // This usually has no cost, since we very rarely need the lookup map for
2616 // the translation unit outside C++.
2617 if (ASTContext *Ctx = ContextObj) {
2618 DeclContext *DC = Ctx->getTranslationUnitDecl();
2619 if (DC->hasExternalLexicalStorage() && !Ctx->getLangOpts().CPlusPlus)
2620 DC->setMustBuildLookupTable();
2625 case llvm::BitstreamEntry::SubBlock:
2627 case DECLTYPES_BLOCK_ID:
2628 // We lazily load the decls block, but we want to set up the
2629 // DeclsCursor cursor to point into it. Clone our current bitcode
2630 // cursor to it, enter the block and read the abbrevs in that block.
2631 // With the main cursor, we just skip over it.
2632 F.DeclsCursor = Stream;
2633 if (Stream.SkipBlock() || // Skip with the main cursor.
2634 // Read the abbrevs.
2635 ReadBlockAbbrevs(F.DeclsCursor, DECLTYPES_BLOCK_ID)) {
2636 Error("malformed block record in AST file");
2641 case PREPROCESSOR_BLOCK_ID:
2642 F.MacroCursor = Stream;
2643 if (!PP.getExternalSource())
2644 PP.setExternalSource(this);
2646 if (Stream.SkipBlock() ||
2647 ReadBlockAbbrevs(F.MacroCursor, PREPROCESSOR_BLOCK_ID)) {
2648 Error("malformed block record in AST file");
2651 F.MacroStartOffset = F.MacroCursor.GetCurrentBitNo();
2654 case PREPROCESSOR_DETAIL_BLOCK_ID:
2655 F.PreprocessorDetailCursor = Stream;
2656 if (Stream.SkipBlock() ||
2657 ReadBlockAbbrevs(F.PreprocessorDetailCursor,
2658 PREPROCESSOR_DETAIL_BLOCK_ID)) {
2659 Error("malformed preprocessor detail record in AST file");
2662 F.PreprocessorDetailStartOffset
2663 = F.PreprocessorDetailCursor.GetCurrentBitNo();
2665 if (!PP.getPreprocessingRecord())
2666 PP.createPreprocessingRecord();
2667 if (!PP.getPreprocessingRecord()->getExternalSource())
2668 PP.getPreprocessingRecord()->SetExternalSource(*this);
2671 case SOURCE_MANAGER_BLOCK_ID:
2672 if (ReadSourceManagerBlock(F))
2676 case SUBMODULE_BLOCK_ID:
2677 if (ASTReadResult Result =
2678 ReadSubmoduleBlock(F, ClientLoadCapabilities))
2682 case COMMENTS_BLOCK_ID: {
2683 BitstreamCursor C = Stream;
2684 if (Stream.SkipBlock() ||
2685 ReadBlockAbbrevs(C, COMMENTS_BLOCK_ID)) {
2686 Error("malformed comments block in AST file");
2689 CommentsCursors.push_back(std::make_pair(C, &F));
2694 if (Stream.SkipBlock()) {
2695 Error("malformed block record in AST file");
2702 case llvm::BitstreamEntry::Record:
2703 // The interesting case.
2707 // Read and process a record.
2711 (ASTRecordTypes)Stream.readRecord(Entry.ID, Record, &Blob);
2713 // If we're not loading an AST context, we don't care about most records.
2715 switch (RecordType) {
2716 case IDENTIFIER_TABLE:
2717 case IDENTIFIER_OFFSET:
2718 case INTERESTING_IDENTIFIERS:
2720 case PP_CONDITIONAL_STACK:
2721 case PP_COUNTER_VALUE:
2722 case SOURCE_LOCATION_OFFSETS:
2723 case MODULE_OFFSET_MAP:
2724 case SOURCE_MANAGER_LINE_TABLE:
2725 case SOURCE_LOCATION_PRELOADS:
2726 case PPD_ENTITIES_OFFSETS:
2727 case HEADER_SEARCH_TABLE:
2728 case IMPORTED_MODULES:
2736 switch (RecordType) {
2737 default: // Default behavior: ignore.
2741 if (F.LocalNumTypes != 0) {
2742 Error("duplicate TYPE_OFFSET record in AST file");
2745 F.TypeOffsets = (const uint32_t *)Blob.data();
2746 F.LocalNumTypes = Record[0];
2747 unsigned LocalBaseTypeIndex = Record[1];
2748 F.BaseTypeIndex = getTotalNumTypes();
2750 if (F.LocalNumTypes > 0) {
2751 // Introduce the global -> local mapping for types within this module.
2752 GlobalTypeMap.insert(std::make_pair(getTotalNumTypes(), &F));
2754 // Introduce the local -> global mapping for types within this module.
2755 F.TypeRemap.insertOrReplace(
2756 std::make_pair(LocalBaseTypeIndex,
2757 F.BaseTypeIndex - LocalBaseTypeIndex));
2759 TypesLoaded.resize(TypesLoaded.size() + F.LocalNumTypes);
2765 if (F.LocalNumDecls != 0) {
2766 Error("duplicate DECL_OFFSET record in AST file");
2769 F.DeclOffsets = (const DeclOffset *)Blob.data();
2770 F.LocalNumDecls = Record[0];
2771 unsigned LocalBaseDeclID = Record[1];
2772 F.BaseDeclID = getTotalNumDecls();
2774 if (F.LocalNumDecls > 0) {
2775 // Introduce the global -> local mapping for declarations within this
2777 GlobalDeclMap.insert(
2778 std::make_pair(getTotalNumDecls() + NUM_PREDEF_DECL_IDS, &F));
2780 // Introduce the local -> global mapping for declarations within this
2782 F.DeclRemap.insertOrReplace(
2783 std::make_pair(LocalBaseDeclID, F.BaseDeclID - LocalBaseDeclID));
2785 // Introduce the global -> local mapping for declarations within this
2787 F.GlobalToLocalDeclIDs[&F] = LocalBaseDeclID;
2789 DeclsLoaded.resize(DeclsLoaded.size() + F.LocalNumDecls);
2794 case TU_UPDATE_LEXICAL: {
2795 DeclContext *TU = ContextObj->getTranslationUnitDecl();
2796 LexicalContents Contents(
2797 reinterpret_cast<const llvm::support::unaligned_uint32_t *>(
2799 static_cast<unsigned int>(Blob.size() / 4));
2800 TULexicalDecls.push_back(std::make_pair(&F, Contents));
2801 TU->setHasExternalLexicalStorage(true);
2805 case UPDATE_VISIBLE: {
2807 serialization::DeclID ID = ReadDeclID(F, Record, Idx);
2808 auto *Data = (const unsigned char*)Blob.data();
2809 PendingVisibleUpdates[ID].push_back(PendingVisibleUpdate{&F, Data});
2810 // If we've already loaded the decl, perform the updates when we finish
2811 // loading this block.
2812 if (Decl *D = GetExistingDecl(ID))
2813 PendingUpdateRecords.push_back(
2814 PendingUpdateRecord(ID, D, /*JustLoaded=*/false));
2818 case IDENTIFIER_TABLE:
2819 F.IdentifierTableData = Blob.data();
2821 F.IdentifierLookupTable = ASTIdentifierLookupTable::Create(
2822 (const unsigned char *)F.IdentifierTableData + Record[0],
2823 (const unsigned char *)F.IdentifierTableData + sizeof(uint32_t),
2824 (const unsigned char *)F.IdentifierTableData,
2825 ASTIdentifierLookupTrait(*this, F));
2827 PP.getIdentifierTable().setExternalIdentifierLookup(this);
2831 case IDENTIFIER_OFFSET: {
2832 if (F.LocalNumIdentifiers != 0) {
2833 Error("duplicate IDENTIFIER_OFFSET record in AST file");
2836 F.IdentifierOffsets = (const uint32_t *)Blob.data();
2837 F.LocalNumIdentifiers = Record[0];
2838 unsigned LocalBaseIdentifierID = Record[1];
2839 F.BaseIdentifierID = getTotalNumIdentifiers();
2841 if (F.LocalNumIdentifiers > 0) {
2842 // Introduce the global -> local mapping for identifiers within this
2844 GlobalIdentifierMap.insert(std::make_pair(getTotalNumIdentifiers() + 1,
2847 // Introduce the local -> global mapping for identifiers within this
2849 F.IdentifierRemap.insertOrReplace(
2850 std::make_pair(LocalBaseIdentifierID,
2851 F.BaseIdentifierID - LocalBaseIdentifierID));
2853 IdentifiersLoaded.resize(IdentifiersLoaded.size()
2854 + F.LocalNumIdentifiers);
2859 case INTERESTING_IDENTIFIERS:
2860 F.PreloadIdentifierOffsets.assign(Record.begin(), Record.end());
2863 case EAGERLY_DESERIALIZED_DECLS:
2864 // FIXME: Skip reading this record if our ASTConsumer doesn't care
2865 // about "interesting" decls (for instance, if we're building a module).
2866 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2867 EagerlyDeserializedDecls.push_back(getGlobalDeclID(F, Record[I]));
2870 case MODULAR_CODEGEN_DECLS:
2871 // FIXME: Skip reading this record if our ASTConsumer doesn't care about
2872 // them (ie: if we're not codegenerating this module).
2873 if (F.Kind == MK_MainFile)
2874 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2875 EagerlyDeserializedDecls.push_back(getGlobalDeclID(F, Record[I]));
2879 if (SpecialTypes.empty()) {
2880 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2881 SpecialTypes.push_back(getGlobalTypeID(F, Record[I]));
2885 if (SpecialTypes.size() != Record.size()) {
2886 Error("invalid special-types record");
2890 for (unsigned I = 0, N = Record.size(); I != N; ++I) {
2891 serialization::TypeID ID = getGlobalTypeID(F, Record[I]);
2892 if (!SpecialTypes[I])
2893 SpecialTypes[I] = ID;
2894 // FIXME: If ID && SpecialTypes[I] != ID, do we need a separate
2900 TotalNumStatements += Record[0];
2901 TotalNumMacros += Record[1];
2902 TotalLexicalDeclContexts += Record[2];
2903 TotalVisibleDeclContexts += Record[3];
2906 case UNUSED_FILESCOPED_DECLS:
2907 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2908 UnusedFileScopedDecls.push_back(getGlobalDeclID(F, Record[I]));
2911 case DELEGATING_CTORS:
2912 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2913 DelegatingCtorDecls.push_back(getGlobalDeclID(F, Record[I]));
2916 case WEAK_UNDECLARED_IDENTIFIERS:
2917 if (Record.size() % 4 != 0) {
2918 Error("invalid weak identifiers record");
2922 // FIXME: Ignore weak undeclared identifiers from non-original PCH
2923 // files. This isn't the way to do it :)
2924 WeakUndeclaredIdentifiers.clear();
2926 // Translate the weak, undeclared identifiers into global IDs.
2927 for (unsigned I = 0, N = Record.size(); I < N; /* in loop */) {
2928 WeakUndeclaredIdentifiers.push_back(
2929 getGlobalIdentifierID(F, Record[I++]));
2930 WeakUndeclaredIdentifiers.push_back(
2931 getGlobalIdentifierID(F, Record[I++]));
2932 WeakUndeclaredIdentifiers.push_back(
2933 ReadSourceLocation(F, Record, I).getRawEncoding());
2934 WeakUndeclaredIdentifiers.push_back(Record[I++]);
2938 case SELECTOR_OFFSETS: {
2939 F.SelectorOffsets = (const uint32_t *)Blob.data();
2940 F.LocalNumSelectors = Record[0];
2941 unsigned LocalBaseSelectorID = Record[1];
2942 F.BaseSelectorID = getTotalNumSelectors();
2944 if (F.LocalNumSelectors > 0) {
2945 // Introduce the global -> local mapping for selectors within this
2947 GlobalSelectorMap.insert(std::make_pair(getTotalNumSelectors()+1, &F));
2949 // Introduce the local -> global mapping for selectors within this
2951 F.SelectorRemap.insertOrReplace(
2952 std::make_pair(LocalBaseSelectorID,
2953 F.BaseSelectorID - LocalBaseSelectorID));
2955 SelectorsLoaded.resize(SelectorsLoaded.size() + F.LocalNumSelectors);
2961 F.SelectorLookupTableData = (const unsigned char *)Blob.data();
2963 F.SelectorLookupTable
2964 = ASTSelectorLookupTable::Create(
2965 F.SelectorLookupTableData + Record[0],
2966 F.SelectorLookupTableData,
2967 ASTSelectorLookupTrait(*this, F));
2968 TotalNumMethodPoolEntries += Record[1];
2971 case REFERENCED_SELECTOR_POOL:
2972 if (!Record.empty()) {
2973 for (unsigned Idx = 0, N = Record.size() - 1; Idx < N; /* in loop */) {
2974 ReferencedSelectorsData.push_back(getGlobalSelectorID(F,
2976 ReferencedSelectorsData.push_back(ReadSourceLocation(F, Record, Idx).
2982 case PP_CONDITIONAL_STACK:
2983 if (!Record.empty()) {
2984 SmallVector<PPConditionalInfo, 4> ConditionalStack;
2985 for (unsigned Idx = 0, N = Record.size() - 1; Idx < N; /* in loop */) {
2986 auto Loc = ReadSourceLocation(F, Record, Idx);
2987 bool WasSkipping = Record[Idx++];
2988 bool FoundNonSkip = Record[Idx++];
2989 bool FoundElse = Record[Idx++];
2990 ConditionalStack.push_back(
2991 {Loc, WasSkipping, FoundNonSkip, FoundElse});
2993 PP.setReplayablePreambleConditionalStack(ConditionalStack);
2997 case PP_COUNTER_VALUE:
2998 if (!Record.empty() && Listener)
2999 Listener->ReadCounter(F, Record[0]);
3002 case FILE_SORTED_DECLS:
3003 F.FileSortedDecls = (const DeclID *)Blob.data();
3004 F.NumFileSortedDecls = Record[0];
3007 case SOURCE_LOCATION_OFFSETS: {
3008 F.SLocEntryOffsets = (const uint32_t *)Blob.data();
3009 F.LocalNumSLocEntries = Record[0];
3010 unsigned SLocSpaceSize = Record[1];
3011 std::tie(F.SLocEntryBaseID, F.SLocEntryBaseOffset) =
3012 SourceMgr.AllocateLoadedSLocEntries(F.LocalNumSLocEntries,
3014 if (!F.SLocEntryBaseID) {
3015 Error("ran out of source locations");
3018 // Make our entry in the range map. BaseID is negative and growing, so
3019 // we invert it. Because we invert it, though, we need the other end of
3021 unsigned RangeStart =
3022 unsigned(-F.SLocEntryBaseID) - F.LocalNumSLocEntries + 1;
3023 GlobalSLocEntryMap.insert(std::make_pair(RangeStart, &F));
3024 F.FirstLoc = SourceLocation::getFromRawEncoding(F.SLocEntryBaseOffset);
3026 // SLocEntryBaseOffset is lower than MaxLoadedOffset and decreasing.
3027 assert((F.SLocEntryBaseOffset & (1U << 31U)) == 0);
3028 GlobalSLocOffsetMap.insert(
3029 std::make_pair(SourceManager::MaxLoadedOffset - F.SLocEntryBaseOffset
3030 - SLocSpaceSize,&F));
3032 // Initialize the remapping table.
3033 // Invalid stays invalid.
3034 F.SLocRemap.insertOrReplace(std::make_pair(0U, 0));
3035 // This module. Base was 2 when being compiled.
3036 F.SLocRemap.insertOrReplace(std::make_pair(2U,
3037 static_cast<int>(F.SLocEntryBaseOffset - 2)));
3039 TotalNumSLocEntries += F.LocalNumSLocEntries;
3043 case MODULE_OFFSET_MAP:
3044 F.ModuleOffsetMap = Blob;
3047 case SOURCE_MANAGER_LINE_TABLE:
3048 if (ParseLineTable(F, Record))
3052 case SOURCE_LOCATION_PRELOADS: {
3053 // Need to transform from the local view (1-based IDs) to the global view,
3054 // which is based off F.SLocEntryBaseID.
3055 if (!F.PreloadSLocEntries.empty()) {
3056 Error("Multiple SOURCE_LOCATION_PRELOADS records in AST file");
3060 F.PreloadSLocEntries.swap(Record);
3064 case EXT_VECTOR_DECLS:
3065 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3066 ExtVectorDecls.push_back(getGlobalDeclID(F, Record[I]));
3070 if (Record.size() % 3 != 0) {
3071 Error("Invalid VTABLE_USES record");
3075 // Later tables overwrite earlier ones.
3076 // FIXME: Modules will have some trouble with this. This is clearly not
3077 // the right way to do this.
3080 for (unsigned Idx = 0, N = Record.size(); Idx != N; /* In loop */) {
3081 VTableUses.push_back(getGlobalDeclID(F, Record[Idx++]));
3082 VTableUses.push_back(
3083 ReadSourceLocation(F, Record, Idx).getRawEncoding());
3084 VTableUses.push_back(Record[Idx++]);
3088 case PENDING_IMPLICIT_INSTANTIATIONS:
3089 if (PendingInstantiations.size() % 2 != 0) {
3090 Error("Invalid existing PendingInstantiations");
3094 if (Record.size() % 2 != 0) {
3095 Error("Invalid PENDING_IMPLICIT_INSTANTIATIONS block");
3099 for (unsigned I = 0, N = Record.size(); I != N; /* in loop */) {
3100 PendingInstantiations.push_back(getGlobalDeclID(F, Record[I++]));
3101 PendingInstantiations.push_back(
3102 ReadSourceLocation(F, Record, I).getRawEncoding());
3106 case SEMA_DECL_REFS:
3107 if (Record.size() != 3) {
3108 Error("Invalid SEMA_DECL_REFS block");
3111 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3112 SemaDeclRefs.push_back(getGlobalDeclID(F, Record[I]));
3115 case PPD_ENTITIES_OFFSETS: {
3116 F.PreprocessedEntityOffsets = (const PPEntityOffset *)Blob.data();
3117 assert(Blob.size() % sizeof(PPEntityOffset) == 0);
3118 F.NumPreprocessedEntities = Blob.size() / sizeof(PPEntityOffset);
3120 unsigned LocalBasePreprocessedEntityID = Record[0];
3122 unsigned StartingID;
3123 if (!PP.getPreprocessingRecord())
3124 PP.createPreprocessingRecord();
3125 if (!PP.getPreprocessingRecord()->getExternalSource())
3126 PP.getPreprocessingRecord()->SetExternalSource(*this);
3128 = PP.getPreprocessingRecord()
3129 ->allocateLoadedEntities(F.NumPreprocessedEntities);
3130 F.BasePreprocessedEntityID = StartingID;
3132 if (F.NumPreprocessedEntities > 0) {
3133 // Introduce the global -> local mapping for preprocessed entities in
3135 GlobalPreprocessedEntityMap.insert(std::make_pair(StartingID, &F));
3137 // Introduce the local -> global mapping for preprocessed entities in
3139 F.PreprocessedEntityRemap.insertOrReplace(
3140 std::make_pair(LocalBasePreprocessedEntityID,
3141 F.BasePreprocessedEntityID - LocalBasePreprocessedEntityID));
3147 case DECL_UPDATE_OFFSETS: {
3148 if (Record.size() % 2 != 0) {
3149 Error("invalid DECL_UPDATE_OFFSETS block in AST file");
3152 for (unsigned I = 0, N = Record.size(); I != N; I += 2) {
3153 GlobalDeclID ID = getGlobalDeclID(F, Record[I]);
3154 DeclUpdateOffsets[ID].push_back(std::make_pair(&F, Record[I + 1]));
3156 // If we've already loaded the decl, perform the updates when we finish
3157 // loading this block.
3158 if (Decl *D = GetExistingDecl(ID))
3159 PendingUpdateRecords.push_back(
3160 PendingUpdateRecord(ID, D, /*JustLoaded=*/false));
3165 case OBJC_CATEGORIES_MAP: {
3166 if (F.LocalNumObjCCategoriesInMap != 0) {
3167 Error("duplicate OBJC_CATEGORIES_MAP record in AST file");
3171 F.LocalNumObjCCategoriesInMap = Record[0];
3172 F.ObjCCategoriesMap = (const ObjCCategoriesInfo *)Blob.data();
3176 case OBJC_CATEGORIES:
3177 F.ObjCCategories.swap(Record);
3180 case CUDA_SPECIAL_DECL_REFS:
3181 // Later tables overwrite earlier ones.
3182 // FIXME: Modules will have trouble with this.
3183 CUDASpecialDeclRefs.clear();
3184 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3185 CUDASpecialDeclRefs.push_back(getGlobalDeclID(F, Record[I]));
3188 case HEADER_SEARCH_TABLE: {
3189 F.HeaderFileInfoTableData = Blob.data();
3190 F.LocalNumHeaderFileInfos = Record[1];
3192 F.HeaderFileInfoTable
3193 = HeaderFileInfoLookupTable::Create(
3194 (const unsigned char *)F.HeaderFileInfoTableData + Record[0],
3195 (const unsigned char *)F.HeaderFileInfoTableData,
3196 HeaderFileInfoTrait(*this, F,
3197 &PP.getHeaderSearchInfo(),
3198 Blob.data() + Record[2]));
3200 PP.getHeaderSearchInfo().SetExternalSource(this);
3201 if (!PP.getHeaderSearchInfo().getExternalLookup())
3202 PP.getHeaderSearchInfo().SetExternalLookup(this);
3207 case FP_PRAGMA_OPTIONS:
3208 // Later tables overwrite earlier ones.
3209 FPPragmaOptions.swap(Record);
3212 case OPENCL_EXTENSIONS:
3213 for (unsigned I = 0, E = Record.size(); I != E; ) {
3214 auto Name = ReadString(Record, I);
3215 auto &Opt = OpenCLExtensions.OptMap[Name];
3216 Opt.Supported = Record[I++] != 0;
3217 Opt.Enabled = Record[I++] != 0;
3218 Opt.Avail = Record[I++];
3219 Opt.Core = Record[I++];
3223 case OPENCL_EXTENSION_TYPES:
3224 for (unsigned I = 0, E = Record.size(); I != E;) {
3225 auto TypeID = static_cast<::TypeID>(Record[I++]);
3226 auto *Type = GetType(TypeID).getTypePtr();
3227 auto NumExt = static_cast<unsigned>(Record[I++]);
3228 for (unsigned II = 0; II != NumExt; ++II) {
3229 auto Ext = ReadString(Record, I);
3230 OpenCLTypeExtMap[Type].insert(Ext);
3235 case OPENCL_EXTENSION_DECLS:
3236 for (unsigned I = 0, E = Record.size(); I != E;) {
3237 auto DeclID = static_cast<::DeclID>(Record[I++]);
3238 auto *Decl = GetDecl(DeclID);
3239 auto NumExt = static_cast<unsigned>(Record[I++]);
3240 for (unsigned II = 0; II != NumExt; ++II) {
3241 auto Ext = ReadString(Record, I);
3242 OpenCLDeclExtMap[Decl].insert(Ext);
3247 case TENTATIVE_DEFINITIONS:
3248 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3249 TentativeDefinitions.push_back(getGlobalDeclID(F, Record[I]));
3252 case KNOWN_NAMESPACES:
3253 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3254 KnownNamespaces.push_back(getGlobalDeclID(F, Record[I]));
3257 case UNDEFINED_BUT_USED:
3258 if (UndefinedButUsed.size() % 2 != 0) {
3259 Error("Invalid existing UndefinedButUsed");
3263 if (Record.size() % 2 != 0) {
3264 Error("invalid undefined-but-used record");
3267 for (unsigned I = 0, N = Record.size(); I != N; /* in loop */) {
3268 UndefinedButUsed.push_back(getGlobalDeclID(F, Record[I++]));
3269 UndefinedButUsed.push_back(
3270 ReadSourceLocation(F, Record, I).getRawEncoding());
3273 case DELETE_EXPRS_TO_ANALYZE:
3274 for (unsigned I = 0, N = Record.size(); I != N;) {
3275 DelayedDeleteExprs.push_back(getGlobalDeclID(F, Record[I++]));
3276 const uint64_t Count = Record[I++];
3277 DelayedDeleteExprs.push_back(Count);
3278 for (uint64_t C = 0; C < Count; ++C) {
3279 DelayedDeleteExprs.push_back(ReadSourceLocation(F, Record, I).getRawEncoding());
3280 bool IsArrayForm = Record[I++] == 1;
3281 DelayedDeleteExprs.push_back(IsArrayForm);
3286 case IMPORTED_MODULES: {
3287 if (!F.isModule()) {
3288 // If we aren't loading a module (which has its own exports), make
3289 // all of the imported modules visible.
3290 // FIXME: Deal with macros-only imports.
3291 for (unsigned I = 0, N = Record.size(); I != N; /**/) {
3292 unsigned GlobalID = getGlobalSubmoduleID(F, Record[I++]);
3293 SourceLocation Loc = ReadSourceLocation(F, Record, I);
3295 ImportedModules.push_back(ImportedSubmodule(GlobalID, Loc));
3296 if (DeserializationListener)
3297 DeserializationListener->ModuleImportRead(GlobalID, Loc);
3304 case MACRO_OFFSET: {
3305 if (F.LocalNumMacros != 0) {
3306 Error("duplicate MACRO_OFFSET record in AST file");
3309 F.MacroOffsets = (const uint32_t *)Blob.data();
3310 F.LocalNumMacros = Record[0];
3311 unsigned LocalBaseMacroID = Record[1];
3312 F.BaseMacroID = getTotalNumMacros();
3314 if (F.LocalNumMacros > 0) {
3315 // Introduce the global -> local mapping for macros within this module.
3316 GlobalMacroMap.insert(std::make_pair(getTotalNumMacros() + 1, &F));
3318 // Introduce the local -> global mapping for macros within this module.
3319 F.MacroRemap.insertOrReplace(
3320 std::make_pair(LocalBaseMacroID,
3321 F.BaseMacroID - LocalBaseMacroID));
3323 MacrosLoaded.resize(MacrosLoaded.size() + F.LocalNumMacros);
3328 case LATE_PARSED_TEMPLATE: {
3329 LateParsedTemplates.append(Record.begin(), Record.end());
3333 case OPTIMIZE_PRAGMA_OPTIONS:
3334 if (Record.size() != 1) {
3335 Error("invalid pragma optimize record");
3338 OptimizeOffPragmaLocation = ReadSourceLocation(F, Record[0]);
3341 case MSSTRUCT_PRAGMA_OPTIONS:
3342 if (Record.size() != 1) {
3343 Error("invalid pragma ms_struct record");
3346 PragmaMSStructState = Record[0];
3349 case POINTERS_TO_MEMBERS_PRAGMA_OPTIONS:
3350 if (Record.size() != 2) {
3351 Error("invalid pragma ms_struct record");
3354 PragmaMSPointersToMembersState = Record[0];
3355 PointersToMembersPragmaLocation = ReadSourceLocation(F, Record[1]);
3358 case UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES:
3359 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3360 UnusedLocalTypedefNameCandidates.push_back(
3361 getGlobalDeclID(F, Record[I]));
3364 case CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH:
3365 if (Record.size() != 1) {
3366 Error("invalid cuda pragma options record");
3369 ForceCUDAHostDeviceDepth = Record[0];
3372 case PACK_PRAGMA_OPTIONS: {
3373 if (Record.size() < 3) {
3374 Error("invalid pragma pack record");
3377 PragmaPackCurrentValue = Record[0];
3378 PragmaPackCurrentLocation = ReadSourceLocation(F, Record[1]);
3379 unsigned NumStackEntries = Record[2];
3381 // Reset the stack when importing a new module.
3382 PragmaPackStack.clear();
3383 for (unsigned I = 0; I < NumStackEntries; ++I) {
3384 PragmaPackStackEntry Entry;
3385 Entry.Value = Record[Idx++];
3386 Entry.Location = ReadSourceLocation(F, Record[Idx++]);
3387 PragmaPackStrings.push_back(ReadString(Record, Idx));
3388 Entry.SlotLabel = PragmaPackStrings.back();
3389 PragmaPackStack.push_back(Entry);
3397 void ASTReader::ReadModuleOffsetMap(ModuleFile &F) const {
3398 assert(!F.ModuleOffsetMap.empty() && "no module offset map to read");
3400 // Additional remapping information.
3401 const unsigned char *Data = (const unsigned char*)F.ModuleOffsetMap.data();
3402 const unsigned char *DataEnd = Data + F.ModuleOffsetMap.size();
3403 F.ModuleOffsetMap = StringRef();
3405 // If we see this entry before SOURCE_LOCATION_OFFSETS, add placeholders.
3406 if (F.SLocRemap.find(0) == F.SLocRemap.end()) {
3407 F.SLocRemap.insert(std::make_pair(0U, 0));
3408 F.SLocRemap.insert(std::make_pair(2U, 1));
3411 // Continuous range maps we may be updating in our module.
3412 typedef ContinuousRangeMap<uint32_t, int, 2>::Builder
3414 RemapBuilder SLocRemap(F.SLocRemap);
3415 RemapBuilder IdentifierRemap(F.IdentifierRemap);
3416 RemapBuilder MacroRemap(F.MacroRemap);
3417 RemapBuilder PreprocessedEntityRemap(F.PreprocessedEntityRemap);
3418 RemapBuilder SubmoduleRemap(F.SubmoduleRemap);
3419 RemapBuilder SelectorRemap(F.SelectorRemap);
3420 RemapBuilder DeclRemap(F.DeclRemap);
3421 RemapBuilder TypeRemap(F.TypeRemap);
3423 while (Data < DataEnd) {
3424 // FIXME: Looking up dependency modules by filename is horrible.
3425 using namespace llvm::support;
3426 uint16_t Len = endian::readNext<uint16_t, little, unaligned>(Data);
3427 StringRef Name = StringRef((const char*)Data, Len);
3429 ModuleFile *OM = ModuleMgr.lookup(Name);
3432 "SourceLocation remap refers to unknown module, cannot find ";
3438 uint32_t SLocOffset =
3439 endian::readNext<uint32_t, little, unaligned>(Data);
3440 uint32_t IdentifierIDOffset =
3441 endian::readNext<uint32_t, little, unaligned>(Data);
3442 uint32_t MacroIDOffset =
3443 endian::readNext<uint32_t, little, unaligned>(Data);
3444 uint32_t PreprocessedEntityIDOffset =
3445 endian::readNext<uint32_t, little, unaligned>(Data);
3446 uint32_t SubmoduleIDOffset =
3447 endian::readNext<uint32_t, little, unaligned>(Data);
3448 uint32_t SelectorIDOffset =
3449 endian::readNext<uint32_t, little, unaligned>(Data);
3450 uint32_t DeclIDOffset =
3451 endian::readNext<uint32_t, little, unaligned>(Data);
3452 uint32_t TypeIndexOffset =
3453 endian::readNext<uint32_t, little, unaligned>(Data);
3455 uint32_t None = std::numeric_limits<uint32_t>::max();
3457 auto mapOffset = [&](uint32_t Offset, uint32_t BaseOffset,
3458 RemapBuilder &Remap) {
3460 Remap.insert(std::make_pair(Offset,
3461 static_cast<int>(BaseOffset - Offset)));
3463 mapOffset(SLocOffset, OM->SLocEntryBaseOffset, SLocRemap);
3464 mapOffset(IdentifierIDOffset, OM->BaseIdentifierID, IdentifierRemap);
3465 mapOffset(MacroIDOffset, OM->BaseMacroID, MacroRemap);
3466 mapOffset(PreprocessedEntityIDOffset, OM->BasePreprocessedEntityID,
3467 PreprocessedEntityRemap);
3468 mapOffset(SubmoduleIDOffset, OM->BaseSubmoduleID, SubmoduleRemap);
3469 mapOffset(SelectorIDOffset, OM->BaseSelectorID, SelectorRemap);
3470 mapOffset(DeclIDOffset, OM->BaseDeclID, DeclRemap);
3471 mapOffset(TypeIndexOffset, OM->BaseTypeIndex, TypeRemap);
3473 // Global -> local mappings.
3474 F.GlobalToLocalDeclIDs[OM] = DeclIDOffset;
3478 ASTReader::ASTReadResult
3479 ASTReader::ReadModuleMapFileBlock(RecordData &Record, ModuleFile &F,
3480 const ModuleFile *ImportedBy,
3481 unsigned ClientLoadCapabilities) {
3483 F.ModuleMapPath = ReadPath(F, Record, Idx);
3485 // Try to resolve ModuleName in the current header search context and
3486 // verify that it is found in the same module map file as we saved. If the
3487 // top-level AST file is a main file, skip this check because there is no
3488 // usable header search context.
3489 assert(!F.ModuleName.empty() &&
3490 "MODULE_NAME should come before MODULE_MAP_FILE");
3491 if (F.Kind == MK_ImplicitModule && ModuleMgr.begin()->Kind != MK_MainFile) {
3492 // An implicitly-loaded module file should have its module listed in some
3493 // module map file that we've already loaded.
3494 Module *M = PP.getHeaderSearchInfo().lookupModule(F.ModuleName);
3495 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
3496 const FileEntry *ModMap = M ? Map.getModuleMapFileForUniquing(M) : nullptr;
3498 assert(ImportedBy && "top-level import should be verified");
3499 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0) {
3500 if (auto *ASTFE = M ? M->getASTFile() : nullptr)
3501 // This module was defined by an imported (explicit) module.
3502 Diag(diag::err_module_file_conflict) << F.ModuleName << F.FileName
3503 << ASTFE->getName();
3505 // This module was built with a different module map.
3506 Diag(diag::err_imported_module_not_found)
3507 << F.ModuleName << F.FileName << ImportedBy->FileName
3513 assert(M->Name == F.ModuleName && "found module with different name");
3515 // Check the primary module map file.
3516 const FileEntry *StoredModMap = FileMgr.getFile(F.ModuleMapPath);
3517 if (StoredModMap == nullptr || StoredModMap != ModMap) {
3518 assert(ModMap && "found module is missing module map file");
3519 assert(ImportedBy && "top-level import should be verified");
3520 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3521 Diag(diag::err_imported_module_modmap_changed)
3522 << F.ModuleName << ImportedBy->FileName
3523 << ModMap->getName() << F.ModuleMapPath;
3527 llvm::SmallPtrSet<const FileEntry *, 1> AdditionalStoredMaps;
3528 for (unsigned I = 0, N = Record[Idx++]; I < N; ++I) {
3529 // FIXME: we should use input files rather than storing names.
3530 std::string Filename = ReadPath(F, Record, Idx);
3531 const FileEntry *F =
3532 FileMgr.getFile(Filename, false, false);
3534 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3535 Error("could not find file '" + Filename +"' referenced by AST file");
3538 AdditionalStoredMaps.insert(F);
3541 // Check any additional module map files (e.g. module.private.modulemap)
3542 // that are not in the pcm.
3543 if (auto *AdditionalModuleMaps = Map.getAdditionalModuleMapFiles(M)) {
3544 for (const FileEntry *ModMap : *AdditionalModuleMaps) {
3545 // Remove files that match
3546 // Note: SmallPtrSet::erase is really remove
3547 if (!AdditionalStoredMaps.erase(ModMap)) {
3548 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3549 Diag(diag::err_module_different_modmap)
3550 << F.ModuleName << /*new*/0 << ModMap->getName();
3556 // Check any additional module map files that are in the pcm, but not
3557 // found in header search. Cases that match are already removed.
3558 for (const FileEntry *ModMap : AdditionalStoredMaps) {
3559 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3560 Diag(diag::err_module_different_modmap)
3561 << F.ModuleName << /*not new*/1 << ModMap->getName();
3567 Listener->ReadModuleMapFile(F.ModuleMapPath);
3572 /// \brief Move the given method to the back of the global list of methods.
3573 static void moveMethodToBackOfGlobalList(Sema &S, ObjCMethodDecl *Method) {
3574 // Find the entry for this selector in the method pool.
3575 Sema::GlobalMethodPool::iterator Known
3576 = S.MethodPool.find(Method->getSelector());
3577 if (Known == S.MethodPool.end())
3580 // Retrieve the appropriate method list.
3581 ObjCMethodList &Start = Method->isInstanceMethod()? Known->second.first
3582 : Known->second.second;
3584 for (ObjCMethodList *List = &Start; List; List = List->getNext()) {
3586 if (List->getMethod() == Method) {
3594 if (List->getNext())
3595 List->setMethod(List->getNext()->getMethod());
3597 List->setMethod(Method);
3601 void ASTReader::makeNamesVisible(const HiddenNames &Names, Module *Owner) {
3602 assert(Owner->NameVisibility != Module::Hidden && "nothing to make visible?");
3603 for (Decl *D : Names) {
3604 bool wasHidden = D->isHidden();
3605 D->setVisibleDespiteOwningModule();
3607 if (wasHidden && SemaObj) {
3608 if (ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(D)) {
3609 moveMethodToBackOfGlobalList(*SemaObj, Method);
3615 void ASTReader::makeModuleVisible(Module *Mod,
3616 Module::NameVisibilityKind NameVisibility,
3617 SourceLocation ImportLoc) {
3618 llvm::SmallPtrSet<Module *, 4> Visited;
3619 SmallVector<Module *, 4> Stack;
3620 Stack.push_back(Mod);
3621 while (!Stack.empty()) {
3622 Mod = Stack.pop_back_val();
3624 if (NameVisibility <= Mod->NameVisibility) {
3625 // This module already has this level of visibility (or greater), so
3626 // there is nothing more to do.
3630 if (!Mod->isAvailable()) {
3631 // Modules that aren't available cannot be made visible.
3635 // Update the module's name visibility.
3636 Mod->NameVisibility = NameVisibility;
3638 // If we've already deserialized any names from this module,
3639 // mark them as visible.
3640 HiddenNamesMapType::iterator Hidden = HiddenNamesMap.find(Mod);
3641 if (Hidden != HiddenNamesMap.end()) {
3642 auto HiddenNames = std::move(*Hidden);
3643 HiddenNamesMap.erase(Hidden);
3644 makeNamesVisible(HiddenNames.second, HiddenNames.first);
3645 assert(HiddenNamesMap.find(Mod) == HiddenNamesMap.end() &&
3646 "making names visible added hidden names");
3649 // Push any exported modules onto the stack to be marked as visible.
3650 SmallVector<Module *, 16> Exports;
3651 Mod->getExportedModules(Exports);
3652 for (SmallVectorImpl<Module *>::iterator
3653 I = Exports.begin(), E = Exports.end(); I != E; ++I) {
3654 Module *Exported = *I;
3655 if (Visited.insert(Exported).second)
3656 Stack.push_back(Exported);
3661 /// We've merged the definition \p MergedDef into the existing definition
3662 /// \p Def. Ensure that \p Def is made visible whenever \p MergedDef is made
3664 void ASTReader::mergeDefinitionVisibility(NamedDecl *Def,
3665 NamedDecl *MergedDef) {
3666 // FIXME: This doesn't correctly handle the case where MergedDef is visible
3667 // in modules other than its owning module. We should instead give the
3668 // ASTContext a list of merged definitions for Def.
3669 if (Def->isHidden()) {
3670 // If MergedDef is visible or becomes visible, make the definition visible.
3671 if (!MergedDef->isHidden())
3672 Def->setVisibleDespiteOwningModule();
3673 else if (getContext().getLangOpts().ModulesLocalVisibility) {
3674 getContext().mergeDefinitionIntoModule(
3675 Def, MergedDef->getImportedOwningModule(),
3676 /*NotifyListeners*/ false);
3677 PendingMergedDefinitionsToDeduplicate.insert(Def);
3679 auto SubmoduleID = MergedDef->getOwningModuleID();
3680 assert(SubmoduleID && "hidden definition in no module");
3681 HiddenNamesMap[getSubmodule(SubmoduleID)].push_back(Def);
3686 bool ASTReader::loadGlobalIndex() {
3690 if (TriedLoadingGlobalIndex || !UseGlobalIndex ||
3691 !PP.getLangOpts().Modules)
3694 // Try to load the global index.
3695 TriedLoadingGlobalIndex = true;
3696 StringRef ModuleCachePath
3697 = getPreprocessor().getHeaderSearchInfo().getModuleCachePath();
3698 std::pair<GlobalModuleIndex *, GlobalModuleIndex::ErrorCode> Result
3699 = GlobalModuleIndex::readIndex(ModuleCachePath);
3703 GlobalIndex.reset(Result.first);
3704 ModuleMgr.setGlobalIndex(GlobalIndex.get());
3708 bool ASTReader::isGlobalIndexUnavailable() const {
3709 return PP.getLangOpts().Modules && UseGlobalIndex &&
3710 !hasGlobalIndex() && TriedLoadingGlobalIndex;
3713 static void updateModuleTimestamp(ModuleFile &MF) {
3714 // Overwrite the timestamp file contents so that file's mtime changes.
3715 std::string TimestampFilename = MF.getTimestampFilename();
3717 llvm::raw_fd_ostream OS(TimestampFilename, EC, llvm::sys::fs::F_Text);
3720 OS << "Timestamp file\n";
3722 OS.clear_error(); // Avoid triggering a fatal error.
3725 /// \brief Given a cursor at the start of an AST file, scan ahead and drop the
3726 /// cursor into the start of the given block ID, returning false on success and
3727 /// true on failure.
3728 static bool SkipCursorToBlock(BitstreamCursor &Cursor, unsigned BlockID) {
3730 llvm::BitstreamEntry Entry = Cursor.advance();
3731 switch (Entry.Kind) {
3732 case llvm::BitstreamEntry::Error:
3733 case llvm::BitstreamEntry::EndBlock:
3736 case llvm::BitstreamEntry::Record:
3737 // Ignore top-level records.
3738 Cursor.skipRecord(Entry.ID);
3741 case llvm::BitstreamEntry::SubBlock:
3742 if (Entry.ID == BlockID) {
3743 if (Cursor.EnterSubBlock(BlockID))
3749 if (Cursor.SkipBlock())
3755 ASTReader::ASTReadResult ASTReader::ReadAST(StringRef FileName,
3757 SourceLocation ImportLoc,
3758 unsigned ClientLoadCapabilities,
3759 SmallVectorImpl<ImportedSubmodule> *Imported) {
3760 llvm::SaveAndRestore<SourceLocation>
3761 SetCurImportLocRAII(CurrentImportLoc, ImportLoc);
3763 // Defer any pending actions until we get to the end of reading the AST file.
3764 Deserializing AnASTFile(this);
3766 // Bump the generation number.
3767 unsigned PreviousGeneration = 0;
3769 PreviousGeneration = incrementGeneration(*ContextObj);
3771 unsigned NumModules = ModuleMgr.size();
3772 SmallVector<ImportedModule, 4> Loaded;
3773 switch (ASTReadResult ReadResult =
3774 ReadASTCore(FileName, Type, ImportLoc,
3775 /*ImportedBy=*/nullptr, Loaded, 0, 0,
3776 ASTFileSignature(), ClientLoadCapabilities)) {
3780 case VersionMismatch:
3781 case ConfigurationMismatch:
3783 llvm::SmallPtrSet<ModuleFile *, 4> LoadedSet;
3784 for (const ImportedModule &IM : Loaded)
3785 LoadedSet.insert(IM.Mod);
3787 ModuleMgr.removeModules(ModuleMgr.begin() + NumModules, LoadedSet,
3788 PP.getLangOpts().Modules
3789 ? &PP.getHeaderSearchInfo().getModuleMap()
3792 // If we find that any modules are unusable, the global index is going
3793 // to be out-of-date. Just remove it.
3794 GlobalIndex.reset();
3795 ModuleMgr.setGlobalIndex(nullptr);
3802 // Here comes stuff that we only do once the entire chain is loaded.
3804 // Load the AST blocks of all of the modules that we loaded.
3805 for (SmallVectorImpl<ImportedModule>::iterator M = Loaded.begin(),
3806 MEnd = Loaded.end();
3808 ModuleFile &F = *M->Mod;
3810 // Read the AST block.
3811 if (ASTReadResult Result = ReadASTBlock(F, ClientLoadCapabilities))
3814 // Read the extension blocks.
3815 while (!SkipCursorToBlock(F.Stream, EXTENSION_BLOCK_ID)) {
3816 if (ASTReadResult Result = ReadExtensionBlock(F))
3820 // Once read, set the ModuleFile bit base offset and update the size in
3821 // bits of all files we've seen.
3822 F.GlobalBitOffset = TotalModulesSizeInBits;
3823 TotalModulesSizeInBits += F.SizeInBits;
3824 GlobalBitOffsetsMap.insert(std::make_pair(F.GlobalBitOffset, &F));
3826 // Preload SLocEntries.
3827 for (unsigned I = 0, N = F.PreloadSLocEntries.size(); I != N; ++I) {
3828 int Index = int(F.PreloadSLocEntries[I] - 1) + F.SLocEntryBaseID;
3829 // Load it through the SourceManager and don't call ReadSLocEntry()
3830 // directly because the entry may have already been loaded in which case
3831 // calling ReadSLocEntry() directly would trigger an assertion in
3833 SourceMgr.getLoadedSLocEntryByID(Index);
3836 // Map the original source file ID into the ID space of the current
3838 if (F.OriginalSourceFileID.isValid()) {
3839 F.OriginalSourceFileID = FileID::get(
3840 F.SLocEntryBaseID + F.OriginalSourceFileID.getOpaqueValue() - 1);
3843 // Preload all the pending interesting identifiers by marking them out of
3845 for (auto Offset : F.PreloadIdentifierOffsets) {
3846 const unsigned char *Data = reinterpret_cast<const unsigned char *>(
3847 F.IdentifierTableData + Offset);
3849 ASTIdentifierLookupTrait Trait(*this, F);
3850 auto KeyDataLen = Trait.ReadKeyDataLength(Data);
3851 auto Key = Trait.ReadKey(Data, KeyDataLen.first);
3852 auto &II = PP.getIdentifierTable().getOwn(Key);
3853 II.setOutOfDate(true);
3855 // Mark this identifier as being from an AST file so that we can track
3856 // whether we need to serialize it.
3857 markIdentifierFromAST(*this, II);
3859 // Associate the ID with the identifier so that the writer can reuse it.
3860 auto ID = Trait.ReadIdentifierID(Data + KeyDataLen.first);
3861 SetIdentifierInfo(ID, &II);
3865 // Setup the import locations and notify the module manager that we've
3866 // committed to these module files.
3867 for (SmallVectorImpl<ImportedModule>::iterator M = Loaded.begin(),
3868 MEnd = Loaded.end();
3870 ModuleFile &F = *M->Mod;
3872 ModuleMgr.moduleFileAccepted(&F);
3874 // Set the import location.
3875 F.DirectImportLoc = ImportLoc;
3876 // FIXME: We assume that locations from PCH / preamble do not need
3879 F.ImportLoc = M->ImportLoc;
3881 F.ImportLoc = TranslateSourceLocation(*M->ImportedBy, M->ImportLoc);
3884 if (!PP.getLangOpts().CPlusPlus ||
3885 (Type != MK_ImplicitModule && Type != MK_ExplicitModule &&
3886 Type != MK_PrebuiltModule)) {
3887 // Mark all of the identifiers in the identifier table as being out of date,
3888 // so that various accessors know to check the loaded modules when the
3889 // identifier is used.
3891 // For C++ modules, we don't need information on many identifiers (just
3892 // those that provide macros or are poisoned), so we mark all of
3893 // the interesting ones via PreloadIdentifierOffsets.
3894 for (IdentifierTable::iterator Id = PP.getIdentifierTable().begin(),
3895 IdEnd = PP.getIdentifierTable().end();
3897 Id->second->setOutOfDate(true);
3899 // Mark selectors as out of date.
3900 for (auto Sel : SelectorGeneration)
3901 SelectorOutOfDate[Sel.first] = true;
3903 // Resolve any unresolved module exports.
3904 for (unsigned I = 0, N = UnresolvedModuleRefs.size(); I != N; ++I) {
3905 UnresolvedModuleRef &Unresolved = UnresolvedModuleRefs[I];
3906 SubmoduleID GlobalID = getGlobalSubmoduleID(*Unresolved.File,Unresolved.ID);
3907 Module *ResolvedMod = getSubmodule(GlobalID);
3909 switch (Unresolved.Kind) {
3910 case UnresolvedModuleRef::Conflict:
3912 Module::Conflict Conflict;
3913 Conflict.Other = ResolvedMod;
3914 Conflict.Message = Unresolved.String.str();
3915 Unresolved.Mod->Conflicts.push_back(Conflict);
3919 case UnresolvedModuleRef::Import:
3921 Unresolved.Mod->Imports.insert(ResolvedMod);
3924 case UnresolvedModuleRef::Export:
3925 if (ResolvedMod || Unresolved.IsWildcard)
3926 Unresolved.Mod->Exports.push_back(
3927 Module::ExportDecl(ResolvedMod, Unresolved.IsWildcard));
3931 UnresolvedModuleRefs.clear();
3934 Imported->append(ImportedModules.begin(),
3935 ImportedModules.end());
3937 // FIXME: How do we load the 'use'd modules? They may not be submodules.
3938 // Might be unnecessary as use declarations are only used to build the
3942 InitializeContext();
3947 if (DeserializationListener)
3948 DeserializationListener->ReaderInitialized(this);
3950 ModuleFile &PrimaryModule = ModuleMgr.getPrimaryModule();
3951 if (PrimaryModule.OriginalSourceFileID.isValid()) {
3952 // If this AST file is a precompiled preamble, then set the
3953 // preamble file ID of the source manager to the file source file
3954 // from which the preamble was built.
3955 if (Type == MK_Preamble) {
3956 SourceMgr.setPreambleFileID(PrimaryModule.OriginalSourceFileID);
3957 } else if (Type == MK_MainFile) {
3958 SourceMgr.setMainFileID(PrimaryModule.OriginalSourceFileID);
3962 // For any Objective-C class definitions we have already loaded, make sure
3963 // that we load any additional categories.
3965 for (unsigned I = 0, N = ObjCClassesLoaded.size(); I != N; ++I) {
3966 loadObjCCategories(ObjCClassesLoaded[I]->getGlobalID(),
3967 ObjCClassesLoaded[I],
3968 PreviousGeneration);
3972 if (PP.getHeaderSearchInfo()
3973 .getHeaderSearchOpts()
3974 .ModulesValidateOncePerBuildSession) {
3975 // Now we are certain that the module and all modules it depends on are
3976 // up to date. Create or update timestamp files for modules that are
3977 // located in the module cache (not for PCH files that could be anywhere
3978 // in the filesystem).
3979 for (unsigned I = 0, N = Loaded.size(); I != N; ++I) {
3980 ImportedModule &M = Loaded[I];
3981 if (M.Mod->Kind == MK_ImplicitModule) {
3982 updateModuleTimestamp(*M.Mod);
3990 static ASTFileSignature readASTFileSignature(StringRef PCH);
3992 /// \brief Whether \p Stream starts with the AST/PCH file magic number 'CPCH'.
3993 static bool startsWithASTFileMagic(BitstreamCursor &Stream) {
3994 return Stream.canSkipToPos(4) &&
3995 Stream.Read(8) == 'C' &&
3996 Stream.Read(8) == 'P' &&
3997 Stream.Read(8) == 'C' &&
3998 Stream.Read(8) == 'H';
4001 static unsigned moduleKindForDiagnostic(ModuleKind Kind) {
4005 case MK_ImplicitModule:
4006 case MK_ExplicitModule:
4007 case MK_PrebuiltModule:
4011 return 2; // main source file
4013 llvm_unreachable("unknown module kind");
4016 ASTReader::ASTReadResult
4017 ASTReader::ReadASTCore(StringRef FileName,
4019 SourceLocation ImportLoc,
4020 ModuleFile *ImportedBy,
4021 SmallVectorImpl<ImportedModule> &Loaded,
4022 off_t ExpectedSize, time_t ExpectedModTime,
4023 ASTFileSignature ExpectedSignature,
4024 unsigned ClientLoadCapabilities) {
4026 std::string ErrorStr;
4027 ModuleManager::AddModuleResult AddResult
4028 = ModuleMgr.addModule(FileName, Type, ImportLoc, ImportedBy,
4029 getGeneration(), ExpectedSize, ExpectedModTime,
4030 ExpectedSignature, readASTFileSignature,
4033 switch (AddResult) {
4034 case ModuleManager::AlreadyLoaded:
4037 case ModuleManager::NewlyLoaded:
4038 // Load module file below.
4041 case ModuleManager::Missing:
4042 // The module file was missing; if the client can handle that, return
4044 if (ClientLoadCapabilities & ARR_Missing)
4047 // Otherwise, return an error.
4048 Diag(diag::err_module_file_not_found) << moduleKindForDiagnostic(Type)
4049 << FileName << !ErrorStr.empty()
4053 case ModuleManager::OutOfDate:
4054 // We couldn't load the module file because it is out-of-date. If the
4055 // client can handle out-of-date, return it.
4056 if (ClientLoadCapabilities & ARR_OutOfDate)
4059 // Otherwise, return an error.
4060 Diag(diag::err_module_file_out_of_date) << moduleKindForDiagnostic(Type)
4061 << FileName << !ErrorStr.empty()
4066 assert(M && "Missing module file");
4068 // FIXME: This seems rather a hack. Should CurrentDir be part of the
4070 if (FileName != "-") {
4071 CurrentDir = llvm::sys::path::parent_path(FileName);
4072 if (CurrentDir.empty()) CurrentDir = ".";
4076 BitstreamCursor &Stream = F.Stream;
4077 Stream = BitstreamCursor(PCHContainerRdr.ExtractPCH(*F.Buffer));
4078 F.SizeInBits = F.Buffer->getBufferSize() * 8;
4080 // Sniff for the signature.
4081 if (!startsWithASTFileMagic(Stream)) {
4082 Diag(diag::err_module_file_invalid) << moduleKindForDiagnostic(Type)
4087 // This is used for compatibility with older PCH formats.
4088 bool HaveReadControlBlock = false;
4090 llvm::BitstreamEntry Entry = Stream.advance();
4092 switch (Entry.Kind) {
4093 case llvm::BitstreamEntry::Error:
4094 case llvm::BitstreamEntry::Record:
4095 case llvm::BitstreamEntry::EndBlock:
4096 Error("invalid record at top-level of AST file");
4099 case llvm::BitstreamEntry::SubBlock:
4104 case CONTROL_BLOCK_ID:
4105 HaveReadControlBlock = true;
4106 switch (ReadControlBlock(F, Loaded, ImportedBy, ClientLoadCapabilities)) {
4108 // Check that we didn't try to load a non-module AST file as a module.
4110 // FIXME: Should we also perform the converse check? Loading a module as
4111 // a PCH file sort of works, but it's a bit wonky.
4112 if ((Type == MK_ImplicitModule || Type == MK_ExplicitModule ||
4113 Type == MK_PrebuiltModule) &&
4114 F.ModuleName.empty()) {
4115 auto Result = (Type == MK_ImplicitModule) ? OutOfDate : Failure;
4116 if (Result != OutOfDate ||
4117 (ClientLoadCapabilities & ARR_OutOfDate) == 0)
4118 Diag(diag::err_module_file_not_module) << FileName;
4123 case Failure: return Failure;
4124 case Missing: return Missing;
4125 case OutOfDate: return OutOfDate;
4126 case VersionMismatch: return VersionMismatch;
4127 case ConfigurationMismatch: return ConfigurationMismatch;
4128 case HadErrors: return HadErrors;
4133 if (!HaveReadControlBlock) {
4134 if ((ClientLoadCapabilities & ARR_VersionMismatch) == 0)
4135 Diag(diag::err_pch_version_too_old);
4136 return VersionMismatch;
4139 // Record that we've loaded this module.
4140 Loaded.push_back(ImportedModule(M, ImportedBy, ImportLoc));
4143 case UNHASHED_CONTROL_BLOCK_ID:
4144 // This block is handled using look-ahead during ReadControlBlock. We
4145 // shouldn't get here!
4146 Error("malformed block record in AST file");
4150 if (Stream.SkipBlock()) {
4151 Error("malformed block record in AST file");
4161 ASTReader::ASTReadResult
4162 ASTReader::readUnhashedControlBlock(ModuleFile &F, bool WasImportedBy,
4163 unsigned ClientLoadCapabilities) {
4164 const HeaderSearchOptions &HSOpts =
4165 PP.getHeaderSearchInfo().getHeaderSearchOpts();
4166 bool AllowCompatibleConfigurationMismatch =
4167 F.Kind == MK_ExplicitModule || F.Kind == MK_PrebuiltModule;
4169 ASTReadResult Result = readUnhashedControlBlockImpl(
4170 &F, F.Data, ClientLoadCapabilities, AllowCompatibleConfigurationMismatch,
4172 WasImportedBy ? false : HSOpts.ModulesValidateDiagnosticOptions);
4174 // If F was directly imported by another module, it's implicitly validated by
4175 // the importing module.
4176 if (DisableValidation || WasImportedBy ||
4177 (AllowConfigurationMismatch && Result == ConfigurationMismatch))
4180 if (Result == Failure) {
4181 Error("malformed block record in AST file");
4185 if (Result == OutOfDate && F.Kind == MK_ImplicitModule) {
4186 // If this module has already been finalized in the PCMCache, we're stuck
4187 // with it; we can only load a single version of each module.
4189 // This can happen when a module is imported in two contexts: in one, as a
4190 // user module; in another, as a system module (due to an import from
4191 // another module marked with the [system] flag). It usually indicates a
4192 // bug in the module map: this module should also be marked with [system].
4194 // If -Wno-system-headers (the default), and the first import is as a
4195 // system module, then validation will fail during the as-user import,
4196 // since -Werror flags won't have been validated. However, it's reasonable
4197 // to treat this consistently as a system module.
4199 // If -Wsystem-headers, the PCM on disk was built with
4200 // -Wno-system-headers, and the first import is as a user module, then
4201 // validation will fail during the as-system import since the PCM on disk
4202 // doesn't guarantee that -Werror was respected. However, the -Werror
4203 // flags were checked during the initial as-user import.
4204 if (PCMCache.isBufferFinal(F.FileName)) {
4205 Diag(diag::warn_module_system_bit_conflict) << F.FileName;
4213 ASTReader::ASTReadResult ASTReader::readUnhashedControlBlockImpl(
4214 ModuleFile *F, llvm::StringRef StreamData, unsigned ClientLoadCapabilities,
4215 bool AllowCompatibleConfigurationMismatch, ASTReaderListener *Listener,
4216 bool ValidateDiagnosticOptions) {
4217 // Initialize a stream.
4218 BitstreamCursor Stream(StreamData);
4220 // Sniff for the signature.
4221 if (!startsWithASTFileMagic(Stream))
4224 // Scan for the UNHASHED_CONTROL_BLOCK_ID block.
4225 if (SkipCursorToBlock(Stream, UNHASHED_CONTROL_BLOCK_ID))
4228 // Read all of the records in the options block.
4230 ASTReadResult Result = Success;
4232 llvm::BitstreamEntry Entry = Stream.advance();
4234 switch (Entry.Kind) {
4235 case llvm::BitstreamEntry::Error:
4236 case llvm::BitstreamEntry::SubBlock:
4239 case llvm::BitstreamEntry::EndBlock:
4242 case llvm::BitstreamEntry::Record:
4243 // The interesting case.
4247 // Read and process a record.
4250 (UnhashedControlBlockRecordTypes)Stream.readRecord(Entry.ID, Record)) {
4253 std::copy(Record.begin(), Record.end(), F->Signature.data());
4256 case DIAGNOSTIC_OPTIONS: {
4257 bool Complain = (ClientLoadCapabilities & ARR_OutOfDate) == 0;
4258 if (Listener && ValidateDiagnosticOptions &&
4259 !AllowCompatibleConfigurationMismatch &&
4260 ParseDiagnosticOptions(Record, Complain, *Listener))
4261 Result = OutOfDate; // Don't return early. Read the signature.
4264 case DIAG_PRAGMA_MAPPINGS:
4267 if (F->PragmaDiagMappings.empty())
4268 F->PragmaDiagMappings.swap(Record);
4270 F->PragmaDiagMappings.insert(F->PragmaDiagMappings.end(),
4271 Record.begin(), Record.end());
4277 /// Parse a record and blob containing module file extension metadata.
4278 static bool parseModuleFileExtensionMetadata(
4279 const SmallVectorImpl<uint64_t> &Record,
4281 ModuleFileExtensionMetadata &Metadata) {
4282 if (Record.size() < 4) return true;
4284 Metadata.MajorVersion = Record[0];
4285 Metadata.MinorVersion = Record[1];
4287 unsigned BlockNameLen = Record[2];
4288 unsigned UserInfoLen = Record[3];
4290 if (BlockNameLen + UserInfoLen > Blob.size()) return true;
4292 Metadata.BlockName = std::string(Blob.data(), Blob.data() + BlockNameLen);
4293 Metadata.UserInfo = std::string(Blob.data() + BlockNameLen,
4294 Blob.data() + BlockNameLen + UserInfoLen);
4298 ASTReader::ASTReadResult ASTReader::ReadExtensionBlock(ModuleFile &F) {
4299 BitstreamCursor &Stream = F.Stream;
4303 llvm::BitstreamEntry Entry = Stream.advance();
4304 switch (Entry.Kind) {
4305 case llvm::BitstreamEntry::SubBlock:
4306 if (Stream.SkipBlock())
4311 case llvm::BitstreamEntry::EndBlock:
4314 case llvm::BitstreamEntry::Error:
4317 case llvm::BitstreamEntry::Record:
4323 unsigned RecCode = Stream.readRecord(Entry.ID, Record, &Blob);
4325 case EXTENSION_METADATA: {
4326 ModuleFileExtensionMetadata Metadata;
4327 if (parseModuleFileExtensionMetadata(Record, Blob, Metadata))
4330 // Find a module file extension with this block name.
4331 auto Known = ModuleFileExtensions.find(Metadata.BlockName);
4332 if (Known == ModuleFileExtensions.end()) break;
4335 if (auto Reader = Known->second->createExtensionReader(Metadata, *this,
4337 F.ExtensionReaders.push_back(std::move(Reader));
4348 void ASTReader::InitializeContext() {
4349 assert(ContextObj && "no context to initialize");
4350 ASTContext &Context = *ContextObj;
4352 // If there's a listener, notify them that we "read" the translation unit.
4353 if (DeserializationListener)
4354 DeserializationListener->DeclRead(PREDEF_DECL_TRANSLATION_UNIT_ID,
4355 Context.getTranslationUnitDecl());
4357 // FIXME: Find a better way to deal with collisions between these
4358 // built-in types. Right now, we just ignore the problem.
4360 // Load the special types.
4361 if (SpecialTypes.size() >= NumSpecialTypeIDs) {
4362 if (unsigned String = SpecialTypes[SPECIAL_TYPE_CF_CONSTANT_STRING]) {
4363 if (!Context.CFConstantStringTypeDecl)
4364 Context.setCFConstantStringType(GetType(String));
4367 if (unsigned File = SpecialTypes[SPECIAL_TYPE_FILE]) {
4368 QualType FileType = GetType(File);
4369 if (FileType.isNull()) {
4370 Error("FILE type is NULL");
4374 if (!Context.FILEDecl) {
4375 if (const TypedefType *Typedef = FileType->getAs<TypedefType>())
4376 Context.setFILEDecl(Typedef->getDecl());
4378 const TagType *Tag = FileType->getAs<TagType>();
4380 Error("Invalid FILE type in AST file");
4383 Context.setFILEDecl(Tag->getDecl());
4388 if (unsigned Jmp_buf = SpecialTypes[SPECIAL_TYPE_JMP_BUF]) {
4389 QualType Jmp_bufType = GetType(Jmp_buf);
4390 if (Jmp_bufType.isNull()) {
4391 Error("jmp_buf type is NULL");
4395 if (!Context.jmp_bufDecl) {
4396 if (const TypedefType *Typedef = Jmp_bufType->getAs<TypedefType>())
4397 Context.setjmp_bufDecl(Typedef->getDecl());
4399 const TagType *Tag = Jmp_bufType->getAs<TagType>();
4401 Error("Invalid jmp_buf type in AST file");
4404 Context.setjmp_bufDecl(Tag->getDecl());
4409 if (unsigned Sigjmp_buf = SpecialTypes[SPECIAL_TYPE_SIGJMP_BUF]) {
4410 QualType Sigjmp_bufType = GetType(Sigjmp_buf);
4411 if (Sigjmp_bufType.isNull()) {
4412 Error("sigjmp_buf type is NULL");
4416 if (!Context.sigjmp_bufDecl) {
4417 if (const TypedefType *Typedef = Sigjmp_bufType->getAs<TypedefType>())
4418 Context.setsigjmp_bufDecl(Typedef->getDecl());
4420 const TagType *Tag = Sigjmp_bufType->getAs<TagType>();
4421 assert(Tag && "Invalid sigjmp_buf type in AST file");
4422 Context.setsigjmp_bufDecl(Tag->getDecl());
4427 if (unsigned ObjCIdRedef
4428 = SpecialTypes[SPECIAL_TYPE_OBJC_ID_REDEFINITION]) {
4429 if (Context.ObjCIdRedefinitionType.isNull())
4430 Context.ObjCIdRedefinitionType = GetType(ObjCIdRedef);
4433 if (unsigned ObjCClassRedef
4434 = SpecialTypes[SPECIAL_TYPE_OBJC_CLASS_REDEFINITION]) {
4435 if (Context.ObjCClassRedefinitionType.isNull())
4436 Context.ObjCClassRedefinitionType = GetType(ObjCClassRedef);
4439 if (unsigned ObjCSelRedef
4440 = SpecialTypes[SPECIAL_TYPE_OBJC_SEL_REDEFINITION]) {
4441 if (Context.ObjCSelRedefinitionType.isNull())
4442 Context.ObjCSelRedefinitionType = GetType(ObjCSelRedef);
4445 if (unsigned Ucontext_t = SpecialTypes[SPECIAL_TYPE_UCONTEXT_T]) {
4446 QualType Ucontext_tType = GetType(Ucontext_t);
4447 if (Ucontext_tType.isNull()) {
4448 Error("ucontext_t type is NULL");
4452 if (!Context.ucontext_tDecl) {
4453 if (const TypedefType *Typedef = Ucontext_tType->getAs<TypedefType>())
4454 Context.setucontext_tDecl(Typedef->getDecl());
4456 const TagType *Tag = Ucontext_tType->getAs<TagType>();
4457 assert(Tag && "Invalid ucontext_t type in AST file");
4458 Context.setucontext_tDecl(Tag->getDecl());
4464 ReadPragmaDiagnosticMappings(Context.getDiagnostics());
4466 // If there were any CUDA special declarations, deserialize them.
4467 if (!CUDASpecialDeclRefs.empty()) {
4468 assert(CUDASpecialDeclRefs.size() == 1 && "More decl refs than expected!");
4469 Context.setcudaConfigureCallDecl(
4470 cast<FunctionDecl>(GetDecl(CUDASpecialDeclRefs[0])));
4473 // Re-export any modules that were imported by a non-module AST file.
4474 // FIXME: This does not make macro-only imports visible again.
4475 for (auto &Import : ImportedModules) {
4476 if (Module *Imported = getSubmodule(Import.ID)) {
4477 makeModuleVisible(Imported, Module::AllVisible,
4478 /*ImportLoc=*/Import.ImportLoc);
4479 if (Import.ImportLoc.isValid())
4480 PP.makeModuleVisible(Imported, Import.ImportLoc);
4481 // FIXME: should we tell Sema to make the module visible too?
4484 ImportedModules.clear();
4487 void ASTReader::finalizeForWriting() {
4488 // Nothing to do for now.
4491 /// \brief Reads and return the signature record from \p PCH's control block, or
4493 static ASTFileSignature readASTFileSignature(StringRef PCH) {
4494 BitstreamCursor Stream(PCH);
4495 if (!startsWithASTFileMagic(Stream))
4496 return ASTFileSignature();
4498 // Scan for the UNHASHED_CONTROL_BLOCK_ID block.
4499 if (SkipCursorToBlock(Stream, UNHASHED_CONTROL_BLOCK_ID))
4500 return ASTFileSignature();
4502 // Scan for SIGNATURE inside the diagnostic options block.
4503 ASTReader::RecordData Record;
4505 llvm::BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
4506 if (Entry.Kind != llvm::BitstreamEntry::Record)
4507 return ASTFileSignature();
4511 if (SIGNATURE == Stream.readRecord(Entry.ID, Record, &Blob))
4512 return {{{(uint32_t)Record[0], (uint32_t)Record[1], (uint32_t)Record[2],
4513 (uint32_t)Record[3], (uint32_t)Record[4]}}};
4517 /// \brief Retrieve the name of the original source file name
4518 /// directly from the AST file, without actually loading the AST
4520 std::string ASTReader::getOriginalSourceFile(
4521 const std::string &ASTFileName, FileManager &FileMgr,
4522 const PCHContainerReader &PCHContainerRdr, DiagnosticsEngine &Diags) {
4523 // Open the AST file.
4524 auto Buffer = FileMgr.getBufferForFile(ASTFileName);
4526 Diags.Report(diag::err_fe_unable_to_read_pch_file)
4527 << ASTFileName << Buffer.getError().message();
4528 return std::string();
4531 // Initialize the stream
4532 BitstreamCursor Stream(PCHContainerRdr.ExtractPCH(**Buffer));
4534 // Sniff for the signature.
4535 if (!startsWithASTFileMagic(Stream)) {
4536 Diags.Report(diag::err_fe_not_a_pch_file) << ASTFileName;
4537 return std::string();
4540 // Scan for the CONTROL_BLOCK_ID block.
4541 if (SkipCursorToBlock(Stream, CONTROL_BLOCK_ID)) {
4542 Diags.Report(diag::err_fe_pch_malformed_block) << ASTFileName;
4543 return std::string();
4546 // Scan for ORIGINAL_FILE inside the control block.
4549 llvm::BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
4550 if (Entry.Kind == llvm::BitstreamEntry::EndBlock)
4551 return std::string();
4553 if (Entry.Kind != llvm::BitstreamEntry::Record) {
4554 Diags.Report(diag::err_fe_pch_malformed_block) << ASTFileName;
4555 return std::string();
4560 if (Stream.readRecord(Entry.ID, Record, &Blob) == ORIGINAL_FILE)
4567 class SimplePCHValidator : public ASTReaderListener {
4568 const LangOptions &ExistingLangOpts;
4569 const TargetOptions &ExistingTargetOpts;
4570 const PreprocessorOptions &ExistingPPOpts;
4571 std::string ExistingModuleCachePath;
4572 FileManager &FileMgr;
4575 SimplePCHValidator(const LangOptions &ExistingLangOpts,
4576 const TargetOptions &ExistingTargetOpts,
4577 const PreprocessorOptions &ExistingPPOpts,
4578 StringRef ExistingModuleCachePath,
4579 FileManager &FileMgr)
4580 : ExistingLangOpts(ExistingLangOpts),
4581 ExistingTargetOpts(ExistingTargetOpts),
4582 ExistingPPOpts(ExistingPPOpts),
4583 ExistingModuleCachePath(ExistingModuleCachePath),
4588 bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
4589 bool AllowCompatibleDifferences) override {
4590 return checkLanguageOptions(ExistingLangOpts, LangOpts, nullptr,
4591 AllowCompatibleDifferences);
4594 bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
4595 bool AllowCompatibleDifferences) override {
4596 return checkTargetOptions(ExistingTargetOpts, TargetOpts, nullptr,
4597 AllowCompatibleDifferences);
4600 bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
4601 StringRef SpecificModuleCachePath,
4602 bool Complain) override {
4603 return checkHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
4604 ExistingModuleCachePath,
4605 nullptr, ExistingLangOpts);
4608 bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
4610 std::string &SuggestedPredefines) override {
4611 return checkPreprocessorOptions(ExistingPPOpts, PPOpts, nullptr, FileMgr,
4612 SuggestedPredefines, ExistingLangOpts);
4616 } // end anonymous namespace
4618 bool ASTReader::readASTFileControlBlock(
4619 StringRef Filename, FileManager &FileMgr,
4620 const PCHContainerReader &PCHContainerRdr,
4621 bool FindModuleFileExtensions,
4622 ASTReaderListener &Listener, bool ValidateDiagnosticOptions) {
4623 // Open the AST file.
4624 // FIXME: This allows use of the VFS; we do not allow use of the
4625 // VFS when actually loading a module.
4626 auto Buffer = FileMgr.getBufferForFile(Filename);
4631 // Initialize the stream
4632 StringRef Bytes = PCHContainerRdr.ExtractPCH(**Buffer);
4633 BitstreamCursor Stream(Bytes);
4635 // Sniff for the signature.
4636 if (!startsWithASTFileMagic(Stream))
4639 // Scan for the CONTROL_BLOCK_ID block.
4640 if (SkipCursorToBlock(Stream, CONTROL_BLOCK_ID))
4643 bool NeedsInputFiles = Listener.needsInputFileVisitation();
4644 bool NeedsSystemInputFiles = Listener.needsSystemInputFileVisitation();
4645 bool NeedsImports = Listener.needsImportVisitation();
4646 BitstreamCursor InputFilesCursor;
4649 std::string ModuleDir;
4650 bool DoneWithControlBlock = false;
4651 while (!DoneWithControlBlock) {
4652 llvm::BitstreamEntry Entry = Stream.advance();
4654 switch (Entry.Kind) {
4655 case llvm::BitstreamEntry::SubBlock: {
4657 case OPTIONS_BLOCK_ID: {
4658 std::string IgnoredSuggestedPredefines;
4659 if (ReadOptionsBlock(Stream, ARR_ConfigurationMismatch | ARR_OutOfDate,
4660 /*AllowCompatibleConfigurationMismatch*/ false,
4661 Listener, IgnoredSuggestedPredefines) != Success)
4666 case INPUT_FILES_BLOCK_ID:
4667 InputFilesCursor = Stream;
4668 if (Stream.SkipBlock() ||
4670 ReadBlockAbbrevs(InputFilesCursor, INPUT_FILES_BLOCK_ID)))
4675 if (Stream.SkipBlock())
4683 case llvm::BitstreamEntry::EndBlock:
4684 DoneWithControlBlock = true;
4687 case llvm::BitstreamEntry::Error:
4690 case llvm::BitstreamEntry::Record:
4694 if (DoneWithControlBlock) break;
4698 unsigned RecCode = Stream.readRecord(Entry.ID, Record, &Blob);
4699 switch ((ControlRecordTypes)RecCode) {
4701 if (Record[0] != VERSION_MAJOR)
4704 if (Listener.ReadFullVersionInformation(Blob))
4710 Listener.ReadModuleName(Blob);
4712 case MODULE_DIRECTORY:
4715 case MODULE_MAP_FILE: {
4717 auto Path = ReadString(Record, Idx);
4718 ResolveImportedPath(Path, ModuleDir);
4719 Listener.ReadModuleMapFile(Path);
4722 case INPUT_FILE_OFFSETS: {
4723 if (!NeedsInputFiles)
4726 unsigned NumInputFiles = Record[0];
4727 unsigned NumUserFiles = Record[1];
4728 const uint64_t *InputFileOffs = (const uint64_t *)Blob.data();
4729 for (unsigned I = 0; I != NumInputFiles; ++I) {
4730 // Go find this input file.
4731 bool isSystemFile = I >= NumUserFiles;
4733 if (isSystemFile && !NeedsSystemInputFiles)
4734 break; // the rest are system input files
4736 BitstreamCursor &Cursor = InputFilesCursor;
4737 SavedStreamPosition SavedPosition(Cursor);
4738 Cursor.JumpToBit(InputFileOffs[I]);
4740 unsigned Code = Cursor.ReadCode();
4743 bool shouldContinue = false;
4744 switch ((InputFileRecordTypes)Cursor.readRecord(Code, Record, &Blob)) {
4746 bool Overridden = static_cast<bool>(Record[3]);
4747 std::string Filename = Blob;
4748 ResolveImportedPath(Filename, ModuleDir);
4749 shouldContinue = Listener.visitInputFile(
4750 Filename, isSystemFile, Overridden, /*IsExplicitModule*/false);
4753 if (!shouldContinue)
4763 unsigned Idx = 0, N = Record.size();
4765 // Read information about the AST file.
4766 Idx += 5; // ImportLoc, Size, ModTime, Signature
4767 std::string Filename = ReadString(Record, Idx);
4768 ResolveImportedPath(Filename, ModuleDir);
4769 Listener.visitImport(Filename);
4775 // No other validation to perform.
4780 // Look for module file extension blocks, if requested.
4781 if (FindModuleFileExtensions) {
4782 BitstreamCursor SavedStream = Stream;
4783 while (!SkipCursorToBlock(Stream, EXTENSION_BLOCK_ID)) {
4784 bool DoneWithExtensionBlock = false;
4785 while (!DoneWithExtensionBlock) {
4786 llvm::BitstreamEntry Entry = Stream.advance();
4788 switch (Entry.Kind) {
4789 case llvm::BitstreamEntry::SubBlock:
4790 if (Stream.SkipBlock())
4795 case llvm::BitstreamEntry::EndBlock:
4796 DoneWithExtensionBlock = true;
4799 case llvm::BitstreamEntry::Error:
4802 case llvm::BitstreamEntry::Record:
4808 unsigned RecCode = Stream.readRecord(Entry.ID, Record, &Blob);
4810 case EXTENSION_METADATA: {
4811 ModuleFileExtensionMetadata Metadata;
4812 if (parseModuleFileExtensionMetadata(Record, Blob, Metadata))
4815 Listener.readModuleFileExtension(Metadata);
4821 Stream = SavedStream;
4824 // Scan for the UNHASHED_CONTROL_BLOCK_ID block.
4825 if (readUnhashedControlBlockImpl(
4826 nullptr, Bytes, ARR_ConfigurationMismatch | ARR_OutOfDate,
4827 /*AllowCompatibleConfigurationMismatch*/ false, &Listener,
4828 ValidateDiagnosticOptions) != Success)
4834 bool ASTReader::isAcceptableASTFile(StringRef Filename, FileManager &FileMgr,
4835 const PCHContainerReader &PCHContainerRdr,
4836 const LangOptions &LangOpts,
4837 const TargetOptions &TargetOpts,
4838 const PreprocessorOptions &PPOpts,
4839 StringRef ExistingModuleCachePath) {
4840 SimplePCHValidator validator(LangOpts, TargetOpts, PPOpts,
4841 ExistingModuleCachePath, FileMgr);
4842 return !readASTFileControlBlock(Filename, FileMgr, PCHContainerRdr,
4843 /*FindModuleFileExtensions=*/false,
4845 /*ValidateDiagnosticOptions=*/true);
4848 ASTReader::ASTReadResult
4849 ASTReader::ReadSubmoduleBlock(ModuleFile &F, unsigned ClientLoadCapabilities) {
4850 // Enter the submodule block.
4851 if (F.Stream.EnterSubBlock(SUBMODULE_BLOCK_ID)) {
4852 Error("malformed submodule block record in AST file");
4856 ModuleMap &ModMap = PP.getHeaderSearchInfo().getModuleMap();
4858 Module *CurrentModule = nullptr;
4859 Module::ModuleKind ModuleKind = Module::ModuleMapModule;
4862 llvm::BitstreamEntry Entry = F.Stream.advanceSkippingSubblocks();
4864 switch (Entry.Kind) {
4865 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
4866 case llvm::BitstreamEntry::Error:
4867 Error("malformed block record in AST file");
4869 case llvm::BitstreamEntry::EndBlock:
4871 case llvm::BitstreamEntry::Record:
4872 // The interesting case.
4879 auto Kind = F.Stream.readRecord(Entry.ID, Record, &Blob);
4881 if ((Kind == SUBMODULE_METADATA) != First) {
4882 Error("submodule metadata record should be at beginning of block");
4887 // Submodule information is only valid if we have a current module.
4888 // FIXME: Should we error on these cases?
4889 if (!CurrentModule && Kind != SUBMODULE_METADATA &&
4890 Kind != SUBMODULE_DEFINITION)
4894 default: // Default behavior: ignore.
4897 case SUBMODULE_DEFINITION: {
4898 if (Record.size() < 8) {
4899 Error("malformed module definition");
4903 StringRef Name = Blob;
4905 SubmoduleID GlobalID = getGlobalSubmoduleID(F, Record[Idx++]);
4906 SubmoduleID Parent = getGlobalSubmoduleID(F, Record[Idx++]);
4907 bool IsFramework = Record[Idx++];
4908 bool IsExplicit = Record[Idx++];
4909 bool IsSystem = Record[Idx++];
4910 bool IsExternC = Record[Idx++];
4911 bool InferSubmodules = Record[Idx++];
4912 bool InferExplicitSubmodules = Record[Idx++];
4913 bool InferExportWildcard = Record[Idx++];
4914 bool ConfigMacrosExhaustive = Record[Idx++];
4916 Module *ParentModule = nullptr;
4918 ParentModule = getSubmodule(Parent);
4920 // Retrieve this (sub)module from the module map, creating it if
4923 ModMap.findOrCreateModule(Name, ParentModule, IsFramework, IsExplicit)
4926 // FIXME: set the definition loc for CurrentModule, or call
4927 // ModMap.setInferredModuleAllowedBy()
4929 SubmoduleID GlobalIndex = GlobalID - NUM_PREDEF_SUBMODULE_IDS;
4930 if (GlobalIndex >= SubmodulesLoaded.size() ||
4931 SubmodulesLoaded[GlobalIndex]) {
4932 Error("too many submodules");
4936 if (!ParentModule) {
4937 if (const FileEntry *CurFile = CurrentModule->getASTFile()) {
4938 if (CurFile != F.File) {
4939 if (!Diags.isDiagnosticInFlight()) {
4940 Diag(diag::err_module_file_conflict)
4941 << CurrentModule->getTopLevelModuleName()
4942 << CurFile->getName()
4943 << F.File->getName();
4949 CurrentModule->setASTFile(F.File);
4950 CurrentModule->PresumedModuleMapFile = F.ModuleMapPath;
4953 CurrentModule->Kind = ModuleKind;
4954 CurrentModule->Signature = F.Signature;
4955 CurrentModule->IsFromModuleFile = true;
4956 CurrentModule->IsSystem = IsSystem || CurrentModule->IsSystem;
4957 CurrentModule->IsExternC = IsExternC;
4958 CurrentModule->InferSubmodules = InferSubmodules;
4959 CurrentModule->InferExplicitSubmodules = InferExplicitSubmodules;
4960 CurrentModule->InferExportWildcard = InferExportWildcard;
4961 CurrentModule->ConfigMacrosExhaustive = ConfigMacrosExhaustive;
4962 if (DeserializationListener)
4963 DeserializationListener->ModuleRead(GlobalID, CurrentModule);
4965 SubmodulesLoaded[GlobalIndex] = CurrentModule;
4967 // Clear out data that will be replaced by what is in the module file.
4968 CurrentModule->LinkLibraries.clear();
4969 CurrentModule->ConfigMacros.clear();
4970 CurrentModule->UnresolvedConflicts.clear();
4971 CurrentModule->Conflicts.clear();
4973 // The module is available unless it's missing a requirement; relevant
4974 // requirements will be (re-)added by SUBMODULE_REQUIRES records.
4975 // Missing headers that were present when the module was built do not
4976 // make it unavailable -- if we got this far, this must be an explicitly
4977 // imported module file.
4978 CurrentModule->Requirements.clear();
4979 CurrentModule->MissingHeaders.clear();
4980 CurrentModule->IsMissingRequirement =
4981 ParentModule && ParentModule->IsMissingRequirement;
4982 CurrentModule->IsAvailable = !CurrentModule->IsMissingRequirement;
4986 case SUBMODULE_UMBRELLA_HEADER: {
4987 std::string Filename = Blob;
4988 ResolveImportedPath(F, Filename);
4989 if (auto *Umbrella = PP.getFileManager().getFile(Filename)) {
4990 if (!CurrentModule->getUmbrellaHeader())
4991 ModMap.setUmbrellaHeader(CurrentModule, Umbrella, Blob);
4992 else if (CurrentModule->getUmbrellaHeader().Entry != Umbrella) {
4993 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
4994 Error("mismatched umbrella headers in submodule");
5001 case SUBMODULE_HEADER:
5002 case SUBMODULE_EXCLUDED_HEADER:
5003 case SUBMODULE_PRIVATE_HEADER:
5004 // We lazily associate headers with their modules via the HeaderInfo table.
5005 // FIXME: Re-evaluate this section; maybe only store InputFile IDs instead
5006 // of complete filenames or remove it entirely.
5009 case SUBMODULE_TEXTUAL_HEADER:
5010 case SUBMODULE_PRIVATE_TEXTUAL_HEADER:
5011 // FIXME: Textual headers are not marked in the HeaderInfo table. Load
5015 case SUBMODULE_TOPHEADER: {
5016 CurrentModule->addTopHeaderFilename(Blob);
5020 case SUBMODULE_UMBRELLA_DIR: {
5021 std::string Dirname = Blob;
5022 ResolveImportedPath(F, Dirname);
5023 if (auto *Umbrella = PP.getFileManager().getDirectory(Dirname)) {
5024 if (!CurrentModule->getUmbrellaDir())
5025 ModMap.setUmbrellaDir(CurrentModule, Umbrella, Blob);
5026 else if (CurrentModule->getUmbrellaDir().Entry != Umbrella) {
5027 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
5028 Error("mismatched umbrella directories in submodule");
5035 case SUBMODULE_METADATA: {
5036 F.BaseSubmoduleID = getTotalNumSubmodules();
5037 F.LocalNumSubmodules = Record[0];
5038 unsigned LocalBaseSubmoduleID = Record[1];
5039 if (F.LocalNumSubmodules > 0) {
5040 // Introduce the global -> local mapping for submodules within this
5042 GlobalSubmoduleMap.insert(std::make_pair(getTotalNumSubmodules()+1,&F));
5044 // Introduce the local -> global mapping for submodules within this
5046 F.SubmoduleRemap.insertOrReplace(
5047 std::make_pair(LocalBaseSubmoduleID,
5048 F.BaseSubmoduleID - LocalBaseSubmoduleID));
5050 SubmodulesLoaded.resize(SubmodulesLoaded.size() + F.LocalNumSubmodules);
5052 ModuleKind = (Module::ModuleKind)Record[2];
5056 case SUBMODULE_IMPORTS: {
5057 for (unsigned Idx = 0; Idx != Record.size(); ++Idx) {
5058 UnresolvedModuleRef Unresolved;
5059 Unresolved.File = &F;
5060 Unresolved.Mod = CurrentModule;
5061 Unresolved.ID = Record[Idx];
5062 Unresolved.Kind = UnresolvedModuleRef::Import;
5063 Unresolved.IsWildcard = false;
5064 UnresolvedModuleRefs.push_back(Unresolved);
5069 case SUBMODULE_EXPORTS: {
5070 for (unsigned Idx = 0; Idx + 1 < Record.size(); Idx += 2) {
5071 UnresolvedModuleRef Unresolved;
5072 Unresolved.File = &F;
5073 Unresolved.Mod = CurrentModule;
5074 Unresolved.ID = Record[Idx];
5075 Unresolved.Kind = UnresolvedModuleRef::Export;
5076 Unresolved.IsWildcard = Record[Idx + 1];
5077 UnresolvedModuleRefs.push_back(Unresolved);
5080 // Once we've loaded the set of exports, there's no reason to keep
5081 // the parsed, unresolved exports around.
5082 CurrentModule->UnresolvedExports.clear();
5085 case SUBMODULE_REQUIRES: {
5086 CurrentModule->addRequirement(Blob, Record[0], PP.getLangOpts(),
5087 PP.getTargetInfo());
5091 case SUBMODULE_LINK_LIBRARY:
5092 CurrentModule->LinkLibraries.push_back(
5093 Module::LinkLibrary(Blob, Record[0]));
5096 case SUBMODULE_CONFIG_MACRO:
5097 CurrentModule->ConfigMacros.push_back(Blob.str());
5100 case SUBMODULE_CONFLICT: {
5101 UnresolvedModuleRef Unresolved;
5102 Unresolved.File = &F;
5103 Unresolved.Mod = CurrentModule;
5104 Unresolved.ID = Record[0];
5105 Unresolved.Kind = UnresolvedModuleRef::Conflict;
5106 Unresolved.IsWildcard = false;
5107 Unresolved.String = Blob;
5108 UnresolvedModuleRefs.push_back(Unresolved);
5112 case SUBMODULE_INITIALIZERS:
5115 SmallVector<uint32_t, 16> Inits;
5116 for (auto &ID : Record)
5117 Inits.push_back(getGlobalDeclID(F, ID));
5118 ContextObj->addLazyModuleInitializers(CurrentModule, Inits);
5124 /// \brief Parse the record that corresponds to a LangOptions data
5127 /// This routine parses the language options from the AST file and then gives
5128 /// them to the AST listener if one is set.
5130 /// \returns true if the listener deems the file unacceptable, false otherwise.
5131 bool ASTReader::ParseLanguageOptions(const RecordData &Record,
5133 ASTReaderListener &Listener,
5134 bool AllowCompatibleDifferences) {
5135 LangOptions LangOpts;
5137 #define LANGOPT(Name, Bits, Default, Description) \
5138 LangOpts.Name = Record[Idx++];
5139 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
5140 LangOpts.set##Name(static_cast<LangOptions::Type>(Record[Idx++]));
5141 #include "clang/Basic/LangOptions.def"
5142 #define SANITIZER(NAME, ID) \
5143 LangOpts.Sanitize.set(SanitizerKind::ID, Record[Idx++]);
5144 #include "clang/Basic/Sanitizers.def"
5146 for (unsigned N = Record[Idx++]; N; --N)
5147 LangOpts.ModuleFeatures.push_back(ReadString(Record, Idx));
5149 ObjCRuntime::Kind runtimeKind = (ObjCRuntime::Kind) Record[Idx++];
5150 VersionTuple runtimeVersion = ReadVersionTuple(Record, Idx);
5151 LangOpts.ObjCRuntime = ObjCRuntime(runtimeKind, runtimeVersion);
5153 LangOpts.CurrentModule = ReadString(Record, Idx);
5156 for (unsigned N = Record[Idx++]; N; --N) {
5157 LangOpts.CommentOpts.BlockCommandNames.push_back(
5158 ReadString(Record, Idx));
5160 LangOpts.CommentOpts.ParseAllComments = Record[Idx++];
5162 // OpenMP offloading options.
5163 for (unsigned N = Record[Idx++]; N; --N) {
5164 LangOpts.OMPTargetTriples.push_back(llvm::Triple(ReadString(Record, Idx)));
5167 LangOpts.OMPHostIRFile = ReadString(Record, Idx);
5169 return Listener.ReadLanguageOptions(LangOpts, Complain,
5170 AllowCompatibleDifferences);
5173 bool ASTReader::ParseTargetOptions(const RecordData &Record, bool Complain,
5174 ASTReaderListener &Listener,
5175 bool AllowCompatibleDifferences) {
5177 TargetOptions TargetOpts;
5178 TargetOpts.Triple = ReadString(Record, Idx);
5179 TargetOpts.CPU = ReadString(Record, Idx);
5180 TargetOpts.ABI = ReadString(Record, Idx);
5181 for (unsigned N = Record[Idx++]; N; --N) {
5182 TargetOpts.FeaturesAsWritten.push_back(ReadString(Record, Idx));
5184 for (unsigned N = Record[Idx++]; N; --N) {
5185 TargetOpts.Features.push_back(ReadString(Record, Idx));
5188 return Listener.ReadTargetOptions(TargetOpts, Complain,
5189 AllowCompatibleDifferences);
5192 bool ASTReader::ParseDiagnosticOptions(const RecordData &Record, bool Complain,
5193 ASTReaderListener &Listener) {
5194 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts(new DiagnosticOptions);
5196 #define DIAGOPT(Name, Bits, Default) DiagOpts->Name = Record[Idx++];
5197 #define ENUM_DIAGOPT(Name, Type, Bits, Default) \
5198 DiagOpts->set##Name(static_cast<Type>(Record[Idx++]));
5199 #include "clang/Basic/DiagnosticOptions.def"
5201 for (unsigned N = Record[Idx++]; N; --N)
5202 DiagOpts->Warnings.push_back(ReadString(Record, Idx));
5203 for (unsigned N = Record[Idx++]; N; --N)
5204 DiagOpts->Remarks.push_back(ReadString(Record, Idx));
5206 return Listener.ReadDiagnosticOptions(DiagOpts, Complain);
5209 bool ASTReader::ParseFileSystemOptions(const RecordData &Record, bool Complain,
5210 ASTReaderListener &Listener) {
5211 FileSystemOptions FSOpts;
5213 FSOpts.WorkingDir = ReadString(Record, Idx);
5214 return Listener.ReadFileSystemOptions(FSOpts, Complain);
5217 bool ASTReader::ParseHeaderSearchOptions(const RecordData &Record,
5219 ASTReaderListener &Listener) {
5220 HeaderSearchOptions HSOpts;
5222 HSOpts.Sysroot = ReadString(Record, Idx);
5225 for (unsigned N = Record[Idx++]; N; --N) {
5226 std::string Path = ReadString(Record, Idx);
5227 frontend::IncludeDirGroup Group
5228 = static_cast<frontend::IncludeDirGroup>(Record[Idx++]);
5229 bool IsFramework = Record[Idx++];
5230 bool IgnoreSysRoot = Record[Idx++];
5231 HSOpts.UserEntries.emplace_back(std::move(Path), Group, IsFramework,
5235 // System header prefixes.
5236 for (unsigned N = Record[Idx++]; N; --N) {
5237 std::string Prefix = ReadString(Record, Idx);
5238 bool IsSystemHeader = Record[Idx++];
5239 HSOpts.SystemHeaderPrefixes.emplace_back(std::move(Prefix), IsSystemHeader);
5242 HSOpts.ResourceDir = ReadString(Record, Idx);
5243 HSOpts.ModuleCachePath = ReadString(Record, Idx);
5244 HSOpts.ModuleUserBuildPath = ReadString(Record, Idx);
5245 HSOpts.DisableModuleHash = Record[Idx++];
5246 HSOpts.ImplicitModuleMaps = Record[Idx++];
5247 HSOpts.ModuleMapFileHomeIsCwd = Record[Idx++];
5248 HSOpts.UseBuiltinIncludes = Record[Idx++];
5249 HSOpts.UseStandardSystemIncludes = Record[Idx++];
5250 HSOpts.UseStandardCXXIncludes = Record[Idx++];
5251 HSOpts.UseLibcxx = Record[Idx++];
5252 std::string SpecificModuleCachePath = ReadString(Record, Idx);
5254 return Listener.ReadHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
5258 bool ASTReader::ParsePreprocessorOptions(const RecordData &Record,
5260 ASTReaderListener &Listener,
5261 std::string &SuggestedPredefines) {
5262 PreprocessorOptions PPOpts;
5265 // Macro definitions/undefs
5266 for (unsigned N = Record[Idx++]; N; --N) {
5267 std::string Macro = ReadString(Record, Idx);
5268 bool IsUndef = Record[Idx++];
5269 PPOpts.Macros.push_back(std::make_pair(Macro, IsUndef));
5273 for (unsigned N = Record[Idx++]; N; --N) {
5274 PPOpts.Includes.push_back(ReadString(Record, Idx));
5278 for (unsigned N = Record[Idx++]; N; --N) {
5279 PPOpts.MacroIncludes.push_back(ReadString(Record, Idx));
5282 PPOpts.UsePredefines = Record[Idx++];
5283 PPOpts.DetailedRecord = Record[Idx++];
5284 PPOpts.ImplicitPCHInclude = ReadString(Record, Idx);
5285 PPOpts.ImplicitPTHInclude = ReadString(Record, Idx);
5286 PPOpts.ObjCXXARCStandardLibrary =
5287 static_cast<ObjCXXARCStandardLibraryKind>(Record[Idx++]);
5288 SuggestedPredefines.clear();
5289 return Listener.ReadPreprocessorOptions(PPOpts, Complain,
5290 SuggestedPredefines);
5293 std::pair<ModuleFile *, unsigned>
5294 ASTReader::getModulePreprocessedEntity(unsigned GlobalIndex) {
5295 GlobalPreprocessedEntityMapType::iterator
5296 I = GlobalPreprocessedEntityMap.find(GlobalIndex);
5297 assert(I != GlobalPreprocessedEntityMap.end() &&
5298 "Corrupted global preprocessed entity map");
5299 ModuleFile *M = I->second;
5300 unsigned LocalIndex = GlobalIndex - M->BasePreprocessedEntityID;
5301 return std::make_pair(M, LocalIndex);
5304 llvm::iterator_range<PreprocessingRecord::iterator>
5305 ASTReader::getModulePreprocessedEntities(ModuleFile &Mod) const {
5306 if (PreprocessingRecord *PPRec = PP.getPreprocessingRecord())
5307 return PPRec->getIteratorsForLoadedRange(Mod.BasePreprocessedEntityID,
5308 Mod.NumPreprocessedEntities);
5310 return llvm::make_range(PreprocessingRecord::iterator(),
5311 PreprocessingRecord::iterator());
5314 llvm::iterator_range<ASTReader::ModuleDeclIterator>
5315 ASTReader::getModuleFileLevelDecls(ModuleFile &Mod) {
5316 return llvm::make_range(
5317 ModuleDeclIterator(this, &Mod, Mod.FileSortedDecls),
5318 ModuleDeclIterator(this, &Mod,
5319 Mod.FileSortedDecls + Mod.NumFileSortedDecls));
5322 PreprocessedEntity *ASTReader::ReadPreprocessedEntity(unsigned Index) {
5323 PreprocessedEntityID PPID = Index+1;
5324 std::pair<ModuleFile *, unsigned> PPInfo = getModulePreprocessedEntity(Index);
5325 ModuleFile &M = *PPInfo.first;
5326 unsigned LocalIndex = PPInfo.second;
5327 const PPEntityOffset &PPOffs = M.PreprocessedEntityOffsets[LocalIndex];
5329 if (!PP.getPreprocessingRecord()) {
5330 Error("no preprocessing record");
5334 SavedStreamPosition SavedPosition(M.PreprocessorDetailCursor);
5335 M.PreprocessorDetailCursor.JumpToBit(PPOffs.BitOffset);
5337 llvm::BitstreamEntry Entry =
5338 M.PreprocessorDetailCursor.advance(BitstreamCursor::AF_DontPopBlockAtEnd);
5339 if (Entry.Kind != llvm::BitstreamEntry::Record)
5343 SourceRange Range(TranslateSourceLocation(M, PPOffs.getBegin()),
5344 TranslateSourceLocation(M, PPOffs.getEnd()));
5345 PreprocessingRecord &PPRec = *PP.getPreprocessingRecord();
5348 PreprocessorDetailRecordTypes RecType =
5349 (PreprocessorDetailRecordTypes)M.PreprocessorDetailCursor.readRecord(
5350 Entry.ID, Record, &Blob);
5352 case PPD_MACRO_EXPANSION: {
5353 bool isBuiltin = Record[0];
5354 IdentifierInfo *Name = nullptr;
5355 MacroDefinitionRecord *Def = nullptr;
5357 Name = getLocalIdentifier(M, Record[1]);
5359 PreprocessedEntityID GlobalID =
5360 getGlobalPreprocessedEntityID(M, Record[1]);
5361 Def = cast<MacroDefinitionRecord>(
5362 PPRec.getLoadedPreprocessedEntity(GlobalID - 1));
5367 ME = new (PPRec) MacroExpansion(Name, Range);
5369 ME = new (PPRec) MacroExpansion(Def, Range);
5374 case PPD_MACRO_DEFINITION: {
5375 // Decode the identifier info and then check again; if the macro is
5376 // still defined and associated with the identifier,
5377 IdentifierInfo *II = getLocalIdentifier(M, Record[0]);
5378 MacroDefinitionRecord *MD = new (PPRec) MacroDefinitionRecord(II, Range);
5380 if (DeserializationListener)
5381 DeserializationListener->MacroDefinitionRead(PPID, MD);
5386 case PPD_INCLUSION_DIRECTIVE: {
5387 const char *FullFileNameStart = Blob.data() + Record[0];
5388 StringRef FullFileName(FullFileNameStart, Blob.size() - Record[0]);
5389 const FileEntry *File = nullptr;
5390 if (!FullFileName.empty())
5391 File = PP.getFileManager().getFile(FullFileName);
5393 // FIXME: Stable encoding
5394 InclusionDirective::InclusionKind Kind
5395 = static_cast<InclusionDirective::InclusionKind>(Record[2]);
5396 InclusionDirective *ID
5397 = new (PPRec) InclusionDirective(PPRec, Kind,
5398 StringRef(Blob.data(), Record[0]),
5399 Record[1], Record[3],
5406 llvm_unreachable("Invalid PreprocessorDetailRecordTypes");
5409 /// \brief \arg SLocMapI points at a chunk of a module that contains no
5410 /// preprocessed entities or the entities it contains are not the ones we are
5411 /// looking for. Find the next module that contains entities and return the ID
5412 /// of the first entry.
5413 PreprocessedEntityID ASTReader::findNextPreprocessedEntity(
5414 GlobalSLocOffsetMapType::const_iterator SLocMapI) const {
5416 for (GlobalSLocOffsetMapType::const_iterator
5417 EndI = GlobalSLocOffsetMap.end(); SLocMapI != EndI; ++SLocMapI) {
5418 ModuleFile &M = *SLocMapI->second;
5419 if (M.NumPreprocessedEntities)
5420 return M.BasePreprocessedEntityID;
5423 return getTotalNumPreprocessedEntities();
5428 struct PPEntityComp {
5429 const ASTReader &Reader;
5432 PPEntityComp(const ASTReader &Reader, ModuleFile &M) : Reader(Reader), M(M) { }
5434 bool operator()(const PPEntityOffset &L, const PPEntityOffset &R) const {
5435 SourceLocation LHS = getLoc(L);
5436 SourceLocation RHS = getLoc(R);
5437 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
5440 bool operator()(const PPEntityOffset &L, SourceLocation RHS) const {
5441 SourceLocation LHS = getLoc(L);
5442 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
5445 bool operator()(SourceLocation LHS, const PPEntityOffset &R) const {
5446 SourceLocation RHS = getLoc(R);
5447 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
5450 SourceLocation getLoc(const PPEntityOffset &PPE) const {
5451 return Reader.TranslateSourceLocation(M, PPE.getBegin());
5455 } // end anonymous namespace
5457 PreprocessedEntityID ASTReader::findPreprocessedEntity(SourceLocation Loc,
5458 bool EndsAfter) const {
5459 if (SourceMgr.isLocalSourceLocation(Loc))
5460 return getTotalNumPreprocessedEntities();
5462 GlobalSLocOffsetMapType::const_iterator SLocMapI = GlobalSLocOffsetMap.find(
5463 SourceManager::MaxLoadedOffset - Loc.getOffset() - 1);
5464 assert(SLocMapI != GlobalSLocOffsetMap.end() &&
5465 "Corrupted global sloc offset map");
5467 if (SLocMapI->second->NumPreprocessedEntities == 0)
5468 return findNextPreprocessedEntity(SLocMapI);
5470 ModuleFile &M = *SLocMapI->second;
5471 typedef const PPEntityOffset *pp_iterator;
5472 pp_iterator pp_begin = M.PreprocessedEntityOffsets;
5473 pp_iterator pp_end = pp_begin + M.NumPreprocessedEntities;
5475 size_t Count = M.NumPreprocessedEntities;
5477 pp_iterator First = pp_begin;
5481 PPI = std::upper_bound(pp_begin, pp_end, Loc,
5482 PPEntityComp(*this, M));
5484 // Do a binary search manually instead of using std::lower_bound because
5485 // The end locations of entities may be unordered (when a macro expansion
5486 // is inside another macro argument), but for this case it is not important
5487 // whether we get the first macro expansion or its containing macro.
5491 std::advance(PPI, Half);
5492 if (SourceMgr.isBeforeInTranslationUnit(
5493 TranslateSourceLocation(M, PPI->getEnd()), Loc)) {
5496 Count = Count - Half - 1;
5503 return findNextPreprocessedEntity(SLocMapI);
5505 return M.BasePreprocessedEntityID + (PPI - pp_begin);
5508 /// \brief Returns a pair of [Begin, End) indices of preallocated
5509 /// preprocessed entities that \arg Range encompasses.
5510 std::pair<unsigned, unsigned>
5511 ASTReader::findPreprocessedEntitiesInRange(SourceRange Range) {
5512 if (Range.isInvalid())
5513 return std::make_pair(0,0);
5514 assert(!SourceMgr.isBeforeInTranslationUnit(Range.getEnd(),Range.getBegin()));
5516 PreprocessedEntityID BeginID =
5517 findPreprocessedEntity(Range.getBegin(), false);
5518 PreprocessedEntityID EndID = findPreprocessedEntity(Range.getEnd(), true);
5519 return std::make_pair(BeginID, EndID);
5522 /// \brief Optionally returns true or false if the preallocated preprocessed
5523 /// entity with index \arg Index came from file \arg FID.
5524 Optional<bool> ASTReader::isPreprocessedEntityInFileID(unsigned Index,
5526 if (FID.isInvalid())
5529 std::pair<ModuleFile *, unsigned> PPInfo = getModulePreprocessedEntity(Index);
5530 ModuleFile &M = *PPInfo.first;
5531 unsigned LocalIndex = PPInfo.second;
5532 const PPEntityOffset &PPOffs = M.PreprocessedEntityOffsets[LocalIndex];
5534 SourceLocation Loc = TranslateSourceLocation(M, PPOffs.getBegin());
5535 if (Loc.isInvalid())
5538 if (SourceMgr.isInFileID(SourceMgr.getFileLoc(Loc), FID))
5546 /// \brief Visitor used to search for information about a header file.
5547 class HeaderFileInfoVisitor {
5548 const FileEntry *FE;
5550 Optional<HeaderFileInfo> HFI;
5553 explicit HeaderFileInfoVisitor(const FileEntry *FE)
5556 bool operator()(ModuleFile &M) {
5557 HeaderFileInfoLookupTable *Table
5558 = static_cast<HeaderFileInfoLookupTable *>(M.HeaderFileInfoTable);
5562 // Look in the on-disk hash table for an entry for this file name.
5563 HeaderFileInfoLookupTable::iterator Pos = Table->find(FE);
5564 if (Pos == Table->end())
5571 Optional<HeaderFileInfo> getHeaderFileInfo() const { return HFI; }
5574 } // end anonymous namespace
5576 HeaderFileInfo ASTReader::GetHeaderFileInfo(const FileEntry *FE) {
5577 HeaderFileInfoVisitor Visitor(FE);
5578 ModuleMgr.visit(Visitor);
5579 if (Optional<HeaderFileInfo> HFI = Visitor.getHeaderFileInfo())
5582 return HeaderFileInfo();
5585 void ASTReader::ReadPragmaDiagnosticMappings(DiagnosticsEngine &Diag) {
5586 using DiagState = DiagnosticsEngine::DiagState;
5587 SmallVector<DiagState *, 32> DiagStates;
5589 for (ModuleFile &F : ModuleMgr) {
5591 auto &Record = F.PragmaDiagMappings;
5597 auto ReadDiagState =
5598 [&](const DiagState &BasedOn, SourceLocation Loc,
5599 bool IncludeNonPragmaStates) -> DiagnosticsEngine::DiagState * {
5600 unsigned BackrefID = Record[Idx++];
5602 return DiagStates[BackrefID - 1];
5604 // A new DiagState was created here.
5605 Diag.DiagStates.push_back(BasedOn);
5606 DiagState *NewState = &Diag.DiagStates.back();
5607 DiagStates.push_back(NewState);
5608 unsigned Size = Record[Idx++];
5609 assert(Idx + Size * 2 <= Record.size() &&
5610 "Invalid data, not enough diag/map pairs");
5612 unsigned DiagID = Record[Idx++];
5613 DiagnosticMapping NewMapping =
5614 DiagnosticMapping::deserialize(Record[Idx++]);
5615 if (!NewMapping.isPragma() && !IncludeNonPragmaStates)
5618 DiagnosticMapping &Mapping = NewState->getOrAddMapping(DiagID);
5620 // If this mapping was specified as a warning but the severity was
5621 // upgraded due to diagnostic settings, simulate the current diagnostic
5622 // settings (and use a warning).
5623 if (NewMapping.wasUpgradedFromWarning() && !Mapping.isErrorOrFatal()) {
5624 NewMapping.setSeverity(diag::Severity::Warning);
5625 NewMapping.setUpgradedFromWarning(false);
5628 Mapping = NewMapping;
5633 // Read the first state.
5634 DiagState *FirstState;
5635 if (F.Kind == MK_ImplicitModule) {
5636 // Implicitly-built modules are reused with different diagnostic
5637 // settings. Use the initial diagnostic state from Diag to simulate this
5638 // compilation's diagnostic settings.
5639 FirstState = Diag.DiagStatesByLoc.FirstDiagState;
5640 DiagStates.push_back(FirstState);
5642 // Skip the initial diagnostic state from the serialized module.
5643 assert(Record[1] == 0 &&
5644 "Invalid data, unexpected backref in initial state");
5645 Idx = 3 + Record[2] * 2;
5646 assert(Idx < Record.size() &&
5647 "Invalid data, not enough state change pairs in initial state");
5648 } else if (F.isModule()) {
5649 // For an explicit module, preserve the flags from the module build
5650 // command line (-w, -Weverything, -Werror, ...) along with any explicit
5652 unsigned Flags = Record[Idx++];
5654 Initial.SuppressSystemWarnings = Flags & 1; Flags >>= 1;
5655 Initial.ErrorsAsFatal = Flags & 1; Flags >>= 1;
5656 Initial.WarningsAsErrors = Flags & 1; Flags >>= 1;
5657 Initial.EnableAllWarnings = Flags & 1; Flags >>= 1;
5658 Initial.IgnoreAllWarnings = Flags & 1; Flags >>= 1;
5659 Initial.ExtBehavior = (diag::Severity)Flags;
5660 FirstState = ReadDiagState(Initial, SourceLocation(), true);
5662 // Set up the root buffer of the module to start with the initial
5663 // diagnostic state of the module itself, to cover files that contain no
5664 // explicit transitions (for which we did not serialize anything).
5665 Diag.DiagStatesByLoc.Files[F.OriginalSourceFileID]
5666 .StateTransitions.push_back({FirstState, 0});
5668 // For prefix ASTs, start with whatever the user configured on the
5670 Idx++; // Skip flags.
5671 FirstState = ReadDiagState(*Diag.DiagStatesByLoc.CurDiagState,
5672 SourceLocation(), false);
5675 // Read the state transitions.
5676 unsigned NumLocations = Record[Idx++];
5677 while (NumLocations--) {
5678 assert(Idx < Record.size() &&
5679 "Invalid data, missing pragma diagnostic states");
5680 SourceLocation Loc = ReadSourceLocation(F, Record[Idx++]);
5681 auto IDAndOffset = SourceMgr.getDecomposedLoc(Loc);
5682 assert(IDAndOffset.second == 0 && "not a start location for a FileID");
5683 unsigned Transitions = Record[Idx++];
5685 // Note that we don't need to set up Parent/ParentOffset here, because
5686 // we won't be changing the diagnostic state within imported FileIDs
5687 // (other than perhaps appending to the main source file, which has no
5689 auto &F = Diag.DiagStatesByLoc.Files[IDAndOffset.first];
5690 F.StateTransitions.reserve(F.StateTransitions.size() + Transitions);
5691 for (unsigned I = 0; I != Transitions; ++I) {
5692 unsigned Offset = Record[Idx++];
5694 ReadDiagState(*FirstState, Loc.getLocWithOffset(Offset), false);
5695 F.StateTransitions.push_back({State, Offset});
5699 // Read the final state.
5700 assert(Idx < Record.size() &&
5701 "Invalid data, missing final pragma diagnostic state");
5702 SourceLocation CurStateLoc =
5703 ReadSourceLocation(F, F.PragmaDiagMappings[Idx++]);
5704 auto *CurState = ReadDiagState(*FirstState, CurStateLoc, false);
5706 if (!F.isModule()) {
5707 Diag.DiagStatesByLoc.CurDiagState = CurState;
5708 Diag.DiagStatesByLoc.CurDiagStateLoc = CurStateLoc;
5710 // Preserve the property that the imaginary root file describes the
5712 auto &T = Diag.DiagStatesByLoc.Files[FileID()].StateTransitions;
5714 T.push_back({CurState, 0});
5716 T[0].State = CurState;
5719 // Don't try to read these mappings again.
5724 /// \brief Get the correct cursor and offset for loading a type.
5725 ASTReader::RecordLocation ASTReader::TypeCursorForIndex(unsigned Index) {
5726 GlobalTypeMapType::iterator I = GlobalTypeMap.find(Index);
5727 assert(I != GlobalTypeMap.end() && "Corrupted global type map");
5728 ModuleFile *M = I->second;
5729 return RecordLocation(M, M->TypeOffsets[Index - M->BaseTypeIndex]);
5732 /// \brief Read and return the type with the given index..
5734 /// The index is the type ID, shifted and minus the number of predefs. This
5735 /// routine actually reads the record corresponding to the type at the given
5736 /// location. It is a helper routine for GetType, which deals with reading type
5738 QualType ASTReader::readTypeRecord(unsigned Index) {
5739 assert(ContextObj && "reading type with no AST context");
5740 ASTContext &Context = *ContextObj;
5741 RecordLocation Loc = TypeCursorForIndex(Index);
5742 BitstreamCursor &DeclsCursor = Loc.F->DeclsCursor;
5744 // Keep track of where we are in the stream, then jump back there
5745 // after reading this type.
5746 SavedStreamPosition SavedPosition(DeclsCursor);
5748 ReadingKindTracker ReadingKind(Read_Type, *this);
5750 // Note that we are loading a type record.
5751 Deserializing AType(this);
5754 DeclsCursor.JumpToBit(Loc.Offset);
5756 unsigned Code = DeclsCursor.ReadCode();
5757 switch ((TypeCode)DeclsCursor.readRecord(Code, Record)) {
5758 case TYPE_EXT_QUAL: {
5759 if (Record.size() != 2) {
5760 Error("Incorrect encoding of extended qualifier type");
5763 QualType Base = readType(*Loc.F, Record, Idx);
5764 Qualifiers Quals = Qualifiers::fromOpaqueValue(Record[Idx++]);
5765 return Context.getQualifiedType(Base, Quals);
5768 case TYPE_COMPLEX: {
5769 if (Record.size() != 1) {
5770 Error("Incorrect encoding of complex type");
5773 QualType ElemType = readType(*Loc.F, Record, Idx);
5774 return Context.getComplexType(ElemType);
5777 case TYPE_POINTER: {
5778 if (Record.size() != 1) {
5779 Error("Incorrect encoding of pointer type");
5782 QualType PointeeType = readType(*Loc.F, Record, Idx);
5783 return Context.getPointerType(PointeeType);
5786 case TYPE_DECAYED: {
5787 if (Record.size() != 1) {
5788 Error("Incorrect encoding of decayed type");
5791 QualType OriginalType = readType(*Loc.F, Record, Idx);
5792 QualType DT = Context.getAdjustedParameterType(OriginalType);
5793 if (!isa<DecayedType>(DT))
5794 Error("Decayed type does not decay");
5798 case TYPE_ADJUSTED: {
5799 if (Record.size() != 2) {
5800 Error("Incorrect encoding of adjusted type");
5803 QualType OriginalTy = readType(*Loc.F, Record, Idx);
5804 QualType AdjustedTy = readType(*Loc.F, Record, Idx);
5805 return Context.getAdjustedType(OriginalTy, AdjustedTy);
5808 case TYPE_BLOCK_POINTER: {
5809 if (Record.size() != 1) {
5810 Error("Incorrect encoding of block pointer type");
5813 QualType PointeeType = readType(*Loc.F, Record, Idx);
5814 return Context.getBlockPointerType(PointeeType);
5817 case TYPE_LVALUE_REFERENCE: {
5818 if (Record.size() != 2) {
5819 Error("Incorrect encoding of lvalue reference type");
5822 QualType PointeeType = readType(*Loc.F, Record, Idx);
5823 return Context.getLValueReferenceType(PointeeType, Record[1]);
5826 case TYPE_RVALUE_REFERENCE: {
5827 if (Record.size() != 1) {
5828 Error("Incorrect encoding of rvalue reference type");
5831 QualType PointeeType = readType(*Loc.F, Record, Idx);
5832 return Context.getRValueReferenceType(PointeeType);
5835 case TYPE_MEMBER_POINTER: {
5836 if (Record.size() != 2) {
5837 Error("Incorrect encoding of member pointer type");
5840 QualType PointeeType = readType(*Loc.F, Record, Idx);
5841 QualType ClassType = readType(*Loc.F, Record, Idx);
5842 if (PointeeType.isNull() || ClassType.isNull())
5845 return Context.getMemberPointerType(PointeeType, ClassType.getTypePtr());
5848 case TYPE_CONSTANT_ARRAY: {
5849 QualType ElementType = readType(*Loc.F, Record, Idx);
5850 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
5851 unsigned IndexTypeQuals = Record[2];
5853 llvm::APInt Size = ReadAPInt(Record, Idx);
5854 return Context.getConstantArrayType(ElementType, Size,
5855 ASM, IndexTypeQuals);
5858 case TYPE_INCOMPLETE_ARRAY: {
5859 QualType ElementType = readType(*Loc.F, Record, Idx);
5860 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
5861 unsigned IndexTypeQuals = Record[2];
5862 return Context.getIncompleteArrayType(ElementType, ASM, IndexTypeQuals);
5865 case TYPE_VARIABLE_ARRAY: {
5866 QualType ElementType = readType(*Loc.F, Record, Idx);
5867 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
5868 unsigned IndexTypeQuals = Record[2];
5869 SourceLocation LBLoc = ReadSourceLocation(*Loc.F, Record[3]);
5870 SourceLocation RBLoc = ReadSourceLocation(*Loc.F, Record[4]);
5871 return Context.getVariableArrayType(ElementType, ReadExpr(*Loc.F),
5872 ASM, IndexTypeQuals,
5873 SourceRange(LBLoc, RBLoc));
5877 if (Record.size() != 3) {
5878 Error("incorrect encoding of vector type in AST file");
5882 QualType ElementType = readType(*Loc.F, Record, Idx);
5883 unsigned NumElements = Record[1];
5884 unsigned VecKind = Record[2];
5885 return Context.getVectorType(ElementType, NumElements,
5886 (VectorType::VectorKind)VecKind);
5889 case TYPE_EXT_VECTOR: {
5890 if (Record.size() != 3) {
5891 Error("incorrect encoding of extended vector type in AST file");
5895 QualType ElementType = readType(*Loc.F, Record, Idx);
5896 unsigned NumElements = Record[1];
5897 return Context.getExtVectorType(ElementType, NumElements);
5900 case TYPE_FUNCTION_NO_PROTO: {
5901 if (Record.size() != 7) {
5902 Error("incorrect encoding of no-proto function type");
5905 QualType ResultType = readType(*Loc.F, Record, Idx);
5906 FunctionType::ExtInfo Info(Record[1], Record[2], Record[3],
5907 (CallingConv)Record[4], Record[5], Record[6]);
5908 return Context.getFunctionNoProtoType(ResultType, Info);
5911 case TYPE_FUNCTION_PROTO: {
5912 QualType ResultType = readType(*Loc.F, Record, Idx);
5914 FunctionProtoType::ExtProtoInfo EPI;
5915 EPI.ExtInfo = FunctionType::ExtInfo(/*noreturn*/ Record[1],
5916 /*hasregparm*/ Record[2],
5917 /*regparm*/ Record[3],
5918 static_cast<CallingConv>(Record[4]),
5919 /*produces*/ Record[5],
5920 /*nocallersavedregs*/ Record[6]);
5924 EPI.Variadic = Record[Idx++];
5925 EPI.HasTrailingReturn = Record[Idx++];
5926 EPI.TypeQuals = Record[Idx++];
5927 EPI.RefQualifier = static_cast<RefQualifierKind>(Record[Idx++]);
5928 SmallVector<QualType, 8> ExceptionStorage;
5929 readExceptionSpec(*Loc.F, ExceptionStorage, EPI.ExceptionSpec, Record, Idx);
5931 unsigned NumParams = Record[Idx++];
5932 SmallVector<QualType, 16> ParamTypes;
5933 for (unsigned I = 0; I != NumParams; ++I)
5934 ParamTypes.push_back(readType(*Loc.F, Record, Idx));
5936 SmallVector<FunctionProtoType::ExtParameterInfo, 4> ExtParameterInfos;
5937 if (Idx != Record.size()) {
5938 for (unsigned I = 0; I != NumParams; ++I)
5939 ExtParameterInfos.push_back(
5940 FunctionProtoType::ExtParameterInfo
5941 ::getFromOpaqueValue(Record[Idx++]));
5942 EPI.ExtParameterInfos = ExtParameterInfos.data();
5945 assert(Idx == Record.size());
5947 return Context.getFunctionType(ResultType, ParamTypes, EPI);
5950 case TYPE_UNRESOLVED_USING: {
5952 return Context.getTypeDeclType(
5953 ReadDeclAs<UnresolvedUsingTypenameDecl>(*Loc.F, Record, Idx));
5956 case TYPE_TYPEDEF: {
5957 if (Record.size() != 2) {
5958 Error("incorrect encoding of typedef type");
5962 TypedefNameDecl *Decl = ReadDeclAs<TypedefNameDecl>(*Loc.F, Record, Idx);
5963 QualType Canonical = readType(*Loc.F, Record, Idx);
5964 if (!Canonical.isNull())
5965 Canonical = Context.getCanonicalType(Canonical);
5966 return Context.getTypedefType(Decl, Canonical);
5969 case TYPE_TYPEOF_EXPR:
5970 return Context.getTypeOfExprType(ReadExpr(*Loc.F));
5973 if (Record.size() != 1) {
5974 Error("incorrect encoding of typeof(type) in AST file");
5977 QualType UnderlyingType = readType(*Loc.F, Record, Idx);
5978 return Context.getTypeOfType(UnderlyingType);
5981 case TYPE_DECLTYPE: {
5982 QualType UnderlyingType = readType(*Loc.F, Record, Idx);
5983 return Context.getDecltypeType(ReadExpr(*Loc.F), UnderlyingType);
5986 case TYPE_UNARY_TRANSFORM: {
5987 QualType BaseType = readType(*Loc.F, Record, Idx);
5988 QualType UnderlyingType = readType(*Loc.F, Record, Idx);
5989 UnaryTransformType::UTTKind UKind = (UnaryTransformType::UTTKind)Record[2];
5990 return Context.getUnaryTransformType(BaseType, UnderlyingType, UKind);
5994 QualType Deduced = readType(*Loc.F, Record, Idx);
5995 AutoTypeKeyword Keyword = (AutoTypeKeyword)Record[Idx++];
5996 bool IsDependent = Deduced.isNull() ? Record[Idx++] : false;
5997 return Context.getAutoType(Deduced, Keyword, IsDependent);
6000 case TYPE_DEDUCED_TEMPLATE_SPECIALIZATION: {
6001 TemplateName Name = ReadTemplateName(*Loc.F, Record, Idx);
6002 QualType Deduced = readType(*Loc.F, Record, Idx);
6003 bool IsDependent = Deduced.isNull() ? Record[Idx++] : false;
6004 return Context.getDeducedTemplateSpecializationType(Name, Deduced,
6009 if (Record.size() != 2) {
6010 Error("incorrect encoding of record type");
6014 bool IsDependent = Record[Idx++];
6015 RecordDecl *RD = ReadDeclAs<RecordDecl>(*Loc.F, Record, Idx);
6016 RD = cast_or_null<RecordDecl>(RD->getCanonicalDecl());
6017 QualType T = Context.getRecordType(RD);
6018 const_cast<Type*>(T.getTypePtr())->setDependent(IsDependent);
6023 if (Record.size() != 2) {
6024 Error("incorrect encoding of enum type");
6028 bool IsDependent = Record[Idx++];
6030 = Context.getEnumType(ReadDeclAs<EnumDecl>(*Loc.F, Record, Idx));
6031 const_cast<Type*>(T.getTypePtr())->setDependent(IsDependent);
6035 case TYPE_ATTRIBUTED: {
6036 if (Record.size() != 3) {
6037 Error("incorrect encoding of attributed type");
6040 QualType modifiedType = readType(*Loc.F, Record, Idx);
6041 QualType equivalentType = readType(*Loc.F, Record, Idx);
6042 AttributedType::Kind kind = static_cast<AttributedType::Kind>(Record[2]);
6043 return Context.getAttributedType(kind, modifiedType, equivalentType);
6047 if (Record.size() != 1) {
6048 Error("incorrect encoding of paren type");
6051 QualType InnerType = readType(*Loc.F, Record, Idx);
6052 return Context.getParenType(InnerType);
6055 case TYPE_PACK_EXPANSION: {
6056 if (Record.size() != 2) {
6057 Error("incorrect encoding of pack expansion type");
6060 QualType Pattern = readType(*Loc.F, Record, Idx);
6061 if (Pattern.isNull())
6063 Optional<unsigned> NumExpansions;
6065 NumExpansions = Record[1] - 1;
6066 return Context.getPackExpansionType(Pattern, NumExpansions);
6069 case TYPE_ELABORATED: {
6071 ElaboratedTypeKeyword Keyword = (ElaboratedTypeKeyword)Record[Idx++];
6072 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(*Loc.F, Record, Idx);
6073 QualType NamedType = readType(*Loc.F, Record, Idx);
6074 return Context.getElaboratedType(Keyword, NNS, NamedType);
6077 case TYPE_OBJC_INTERFACE: {
6079 ObjCInterfaceDecl *ItfD
6080 = ReadDeclAs<ObjCInterfaceDecl>(*Loc.F, Record, Idx);
6081 return Context.getObjCInterfaceType(ItfD->getCanonicalDecl());
6084 case TYPE_OBJC_TYPE_PARAM: {
6086 ObjCTypeParamDecl *Decl
6087 = ReadDeclAs<ObjCTypeParamDecl>(*Loc.F, Record, Idx);
6088 unsigned NumProtos = Record[Idx++];
6089 SmallVector<ObjCProtocolDecl*, 4> Protos;
6090 for (unsigned I = 0; I != NumProtos; ++I)
6091 Protos.push_back(ReadDeclAs<ObjCProtocolDecl>(*Loc.F, Record, Idx));
6092 return Context.getObjCTypeParamType(Decl, Protos);
6094 case TYPE_OBJC_OBJECT: {
6096 QualType Base = readType(*Loc.F, Record, Idx);
6097 unsigned NumTypeArgs = Record[Idx++];
6098 SmallVector<QualType, 4> TypeArgs;
6099 for (unsigned I = 0; I != NumTypeArgs; ++I)
6100 TypeArgs.push_back(readType(*Loc.F, Record, Idx));
6101 unsigned NumProtos = Record[Idx++];
6102 SmallVector<ObjCProtocolDecl*, 4> Protos;
6103 for (unsigned I = 0; I != NumProtos; ++I)
6104 Protos.push_back(ReadDeclAs<ObjCProtocolDecl>(*Loc.F, Record, Idx));
6105 bool IsKindOf = Record[Idx++];
6106 return Context.getObjCObjectType(Base, TypeArgs, Protos, IsKindOf);
6109 case TYPE_OBJC_OBJECT_POINTER: {
6111 QualType Pointee = readType(*Loc.F, Record, Idx);
6112 return Context.getObjCObjectPointerType(Pointee);
6115 case TYPE_SUBST_TEMPLATE_TYPE_PARM: {
6117 QualType Parm = readType(*Loc.F, Record, Idx);
6118 QualType Replacement = readType(*Loc.F, Record, Idx);
6119 return Context.getSubstTemplateTypeParmType(
6120 cast<TemplateTypeParmType>(Parm),
6121 Context.getCanonicalType(Replacement));
6124 case TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK: {
6126 QualType Parm = readType(*Loc.F, Record, Idx);
6127 TemplateArgument ArgPack = ReadTemplateArgument(*Loc.F, Record, Idx);
6128 return Context.getSubstTemplateTypeParmPackType(
6129 cast<TemplateTypeParmType>(Parm),
6133 case TYPE_INJECTED_CLASS_NAME: {
6134 CXXRecordDecl *D = ReadDeclAs<CXXRecordDecl>(*Loc.F, Record, Idx);
6135 QualType TST = readType(*Loc.F, Record, Idx); // probably derivable
6136 // FIXME: ASTContext::getInjectedClassNameType is not currently suitable
6137 // for AST reading, too much interdependencies.
6138 const Type *T = nullptr;
6139 for (auto *DI = D; DI; DI = DI->getPreviousDecl()) {
6140 if (const Type *Existing = DI->getTypeForDecl()) {
6146 T = new (Context, TypeAlignment) InjectedClassNameType(D, TST);
6147 for (auto *DI = D; DI; DI = DI->getPreviousDecl())
6148 DI->setTypeForDecl(T);
6150 return QualType(T, 0);
6153 case TYPE_TEMPLATE_TYPE_PARM: {
6155 unsigned Depth = Record[Idx++];
6156 unsigned Index = Record[Idx++];
6157 bool Pack = Record[Idx++];
6158 TemplateTypeParmDecl *D
6159 = ReadDeclAs<TemplateTypeParmDecl>(*Loc.F, Record, Idx);
6160 return Context.getTemplateTypeParmType(Depth, Index, Pack, D);
6163 case TYPE_DEPENDENT_NAME: {
6165 ElaboratedTypeKeyword Keyword = (ElaboratedTypeKeyword)Record[Idx++];
6166 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(*Loc.F, Record, Idx);
6167 const IdentifierInfo *Name = GetIdentifierInfo(*Loc.F, Record, Idx);
6168 QualType Canon = readType(*Loc.F, Record, Idx);
6169 if (!Canon.isNull())
6170 Canon = Context.getCanonicalType(Canon);
6171 return Context.getDependentNameType(Keyword, NNS, Name, Canon);
6174 case TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION: {
6176 ElaboratedTypeKeyword Keyword = (ElaboratedTypeKeyword)Record[Idx++];
6177 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(*Loc.F, Record, Idx);
6178 const IdentifierInfo *Name = GetIdentifierInfo(*Loc.F, Record, Idx);
6179 unsigned NumArgs = Record[Idx++];
6180 SmallVector<TemplateArgument, 8> Args;
6181 Args.reserve(NumArgs);
6183 Args.push_back(ReadTemplateArgument(*Loc.F, Record, Idx));
6184 return Context.getDependentTemplateSpecializationType(Keyword, NNS, Name,
6188 case TYPE_DEPENDENT_SIZED_ARRAY: {
6192 QualType ElementType = readType(*Loc.F, Record, Idx);
6193 ArrayType::ArraySizeModifier ASM
6194 = (ArrayType::ArraySizeModifier)Record[Idx++];
6195 unsigned IndexTypeQuals = Record[Idx++];
6197 // DependentSizedArrayType
6198 Expr *NumElts = ReadExpr(*Loc.F);
6199 SourceRange Brackets = ReadSourceRange(*Loc.F, Record, Idx);
6201 return Context.getDependentSizedArrayType(ElementType, NumElts, ASM,
6202 IndexTypeQuals, Brackets);
6205 case TYPE_TEMPLATE_SPECIALIZATION: {
6207 bool IsDependent = Record[Idx++];
6208 TemplateName Name = ReadTemplateName(*Loc.F, Record, Idx);
6209 SmallVector<TemplateArgument, 8> Args;
6210 ReadTemplateArgumentList(Args, *Loc.F, Record, Idx);
6211 QualType Underlying = readType(*Loc.F, Record, Idx);
6213 if (Underlying.isNull())
6214 T = Context.getCanonicalTemplateSpecializationType(Name, Args);
6216 T = Context.getTemplateSpecializationType(Name, Args, Underlying);
6217 const_cast<Type*>(T.getTypePtr())->setDependent(IsDependent);
6222 if (Record.size() != 1) {
6223 Error("Incorrect encoding of atomic type");
6226 QualType ValueType = readType(*Loc.F, Record, Idx);
6227 return Context.getAtomicType(ValueType);
6231 if (Record.size() != 2) {
6232 Error("Incorrect encoding of pipe type");
6236 // Reading the pipe element type.
6237 QualType ElementType = readType(*Loc.F, Record, Idx);
6238 unsigned ReadOnly = Record[1];
6239 return Context.getPipeType(ElementType, ReadOnly);
6242 case TYPE_DEPENDENT_SIZED_EXT_VECTOR: {
6245 // DependentSizedExtVectorType
6246 QualType ElementType = readType(*Loc.F, Record, Idx);
6247 Expr *SizeExpr = ReadExpr(*Loc.F);
6248 SourceLocation AttrLoc = ReadSourceLocation(*Loc.F, Record, Idx);
6250 return Context.getDependentSizedExtVectorType(ElementType, SizeExpr,
6254 llvm_unreachable("Invalid TypeCode!");
6257 void ASTReader::readExceptionSpec(ModuleFile &ModuleFile,
6258 SmallVectorImpl<QualType> &Exceptions,
6259 FunctionProtoType::ExceptionSpecInfo &ESI,
6260 const RecordData &Record, unsigned &Idx) {
6261 ExceptionSpecificationType EST =
6262 static_cast<ExceptionSpecificationType>(Record[Idx++]);
6264 if (EST == EST_Dynamic) {
6265 for (unsigned I = 0, N = Record[Idx++]; I != N; ++I)
6266 Exceptions.push_back(readType(ModuleFile, Record, Idx));
6267 ESI.Exceptions = Exceptions;
6268 } else if (EST == EST_ComputedNoexcept) {
6269 ESI.NoexceptExpr = ReadExpr(ModuleFile);
6270 } else if (EST == EST_Uninstantiated) {
6271 ESI.SourceDecl = ReadDeclAs<FunctionDecl>(ModuleFile, Record, Idx);
6272 ESI.SourceTemplate = ReadDeclAs<FunctionDecl>(ModuleFile, Record, Idx);
6273 } else if (EST == EST_Unevaluated) {
6274 ESI.SourceDecl = ReadDeclAs<FunctionDecl>(ModuleFile, Record, Idx);
6278 class clang::TypeLocReader : public TypeLocVisitor<TypeLocReader> {
6281 const ASTReader::RecordData &Record;
6284 SourceLocation ReadSourceLocation() {
6285 return Reader->ReadSourceLocation(*F, Record, Idx);
6288 TypeSourceInfo *GetTypeSourceInfo() {
6289 return Reader->GetTypeSourceInfo(*F, Record, Idx);
6292 NestedNameSpecifierLoc ReadNestedNameSpecifierLoc() {
6293 return Reader->ReadNestedNameSpecifierLoc(*F, Record, Idx);
6297 TypeLocReader(ModuleFile &F, ASTReader &Reader,
6298 const ASTReader::RecordData &Record, unsigned &Idx)
6299 : F(&F), Reader(&Reader), Record(Record), Idx(Idx) {}
6301 // We want compile-time assurance that we've enumerated all of
6302 // these, so unfortunately we have to declare them first, then
6303 // define them out-of-line.
6304 #define ABSTRACT_TYPELOC(CLASS, PARENT)
6305 #define TYPELOC(CLASS, PARENT) \
6306 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
6307 #include "clang/AST/TypeLocNodes.def"
6309 void VisitFunctionTypeLoc(FunctionTypeLoc);
6310 void VisitArrayTypeLoc(ArrayTypeLoc);
6313 void TypeLocReader::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
6317 void TypeLocReader::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
6318 TL.setBuiltinLoc(ReadSourceLocation());
6319 if (TL.needsExtraLocalData()) {
6320 TL.setWrittenTypeSpec(static_cast<DeclSpec::TST>(Record[Idx++]));
6321 TL.setWrittenSignSpec(static_cast<DeclSpec::TSS>(Record[Idx++]));
6322 TL.setWrittenWidthSpec(static_cast<DeclSpec::TSW>(Record[Idx++]));
6323 TL.setModeAttr(Record[Idx++]);
6327 void TypeLocReader::VisitComplexTypeLoc(ComplexTypeLoc TL) {
6328 TL.setNameLoc(ReadSourceLocation());
6331 void TypeLocReader::VisitPointerTypeLoc(PointerTypeLoc TL) {
6332 TL.setStarLoc(ReadSourceLocation());
6335 void TypeLocReader::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
6339 void TypeLocReader::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
6343 void TypeLocReader::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
6344 TL.setCaretLoc(ReadSourceLocation());
6347 void TypeLocReader::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
6348 TL.setAmpLoc(ReadSourceLocation());
6351 void TypeLocReader::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
6352 TL.setAmpAmpLoc(ReadSourceLocation());
6355 void TypeLocReader::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
6356 TL.setStarLoc(ReadSourceLocation());
6357 TL.setClassTInfo(GetTypeSourceInfo());
6360 void TypeLocReader::VisitArrayTypeLoc(ArrayTypeLoc TL) {
6361 TL.setLBracketLoc(ReadSourceLocation());
6362 TL.setRBracketLoc(ReadSourceLocation());
6364 TL.setSizeExpr(Reader->ReadExpr(*F));
6366 TL.setSizeExpr(nullptr);
6369 void TypeLocReader::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
6370 VisitArrayTypeLoc(TL);
6373 void TypeLocReader::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
6374 VisitArrayTypeLoc(TL);
6377 void TypeLocReader::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
6378 VisitArrayTypeLoc(TL);
6381 void TypeLocReader::VisitDependentSizedArrayTypeLoc(
6382 DependentSizedArrayTypeLoc TL) {
6383 VisitArrayTypeLoc(TL);
6386 void TypeLocReader::VisitDependentSizedExtVectorTypeLoc(
6387 DependentSizedExtVectorTypeLoc TL) {
6388 TL.setNameLoc(ReadSourceLocation());
6391 void TypeLocReader::VisitVectorTypeLoc(VectorTypeLoc TL) {
6392 TL.setNameLoc(ReadSourceLocation());
6395 void TypeLocReader::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
6396 TL.setNameLoc(ReadSourceLocation());
6399 void TypeLocReader::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
6400 TL.setLocalRangeBegin(ReadSourceLocation());
6401 TL.setLParenLoc(ReadSourceLocation());
6402 TL.setRParenLoc(ReadSourceLocation());
6403 TL.setExceptionSpecRange(SourceRange(Reader->ReadSourceLocation(*F, Record, Idx),
6404 Reader->ReadSourceLocation(*F, Record, Idx)));
6405 TL.setLocalRangeEnd(ReadSourceLocation());
6406 for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i) {
6407 TL.setParam(i, Reader->ReadDeclAs<ParmVarDecl>(*F, Record, Idx));
6411 void TypeLocReader::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
6412 VisitFunctionTypeLoc(TL);
6415 void TypeLocReader::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
6416 VisitFunctionTypeLoc(TL);
6418 void TypeLocReader::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
6419 TL.setNameLoc(ReadSourceLocation());
6421 void TypeLocReader::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
6422 TL.setNameLoc(ReadSourceLocation());
6424 void TypeLocReader::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
6425 TL.setTypeofLoc(ReadSourceLocation());
6426 TL.setLParenLoc(ReadSourceLocation());
6427 TL.setRParenLoc(ReadSourceLocation());
6429 void TypeLocReader::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
6430 TL.setTypeofLoc(ReadSourceLocation());
6431 TL.setLParenLoc(ReadSourceLocation());
6432 TL.setRParenLoc(ReadSourceLocation());
6433 TL.setUnderlyingTInfo(GetTypeSourceInfo());
6435 void TypeLocReader::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
6436 TL.setNameLoc(ReadSourceLocation());
6439 void TypeLocReader::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
6440 TL.setKWLoc(ReadSourceLocation());
6441 TL.setLParenLoc(ReadSourceLocation());
6442 TL.setRParenLoc(ReadSourceLocation());
6443 TL.setUnderlyingTInfo(GetTypeSourceInfo());
6446 void TypeLocReader::VisitAutoTypeLoc(AutoTypeLoc TL) {
6447 TL.setNameLoc(ReadSourceLocation());
6450 void TypeLocReader::VisitDeducedTemplateSpecializationTypeLoc(
6451 DeducedTemplateSpecializationTypeLoc TL) {
6452 TL.setTemplateNameLoc(ReadSourceLocation());
6455 void TypeLocReader::VisitRecordTypeLoc(RecordTypeLoc TL) {
6456 TL.setNameLoc(ReadSourceLocation());
6459 void TypeLocReader::VisitEnumTypeLoc(EnumTypeLoc TL) {
6460 TL.setNameLoc(ReadSourceLocation());
6463 void TypeLocReader::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
6464 TL.setAttrNameLoc(ReadSourceLocation());
6465 if (TL.hasAttrOperand()) {
6467 range.setBegin(ReadSourceLocation());
6468 range.setEnd(ReadSourceLocation());
6469 TL.setAttrOperandParensRange(range);
6471 if (TL.hasAttrExprOperand()) {
6473 TL.setAttrExprOperand(Reader->ReadExpr(*F));
6475 TL.setAttrExprOperand(nullptr);
6476 } else if (TL.hasAttrEnumOperand())
6477 TL.setAttrEnumOperandLoc(ReadSourceLocation());
6480 void TypeLocReader::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
6481 TL.setNameLoc(ReadSourceLocation());
6484 void TypeLocReader::VisitSubstTemplateTypeParmTypeLoc(
6485 SubstTemplateTypeParmTypeLoc TL) {
6486 TL.setNameLoc(ReadSourceLocation());
6488 void TypeLocReader::VisitSubstTemplateTypeParmPackTypeLoc(
6489 SubstTemplateTypeParmPackTypeLoc TL) {
6490 TL.setNameLoc(ReadSourceLocation());
6492 void TypeLocReader::VisitTemplateSpecializationTypeLoc(
6493 TemplateSpecializationTypeLoc TL) {
6494 TL.setTemplateKeywordLoc(ReadSourceLocation());
6495 TL.setTemplateNameLoc(ReadSourceLocation());
6496 TL.setLAngleLoc(ReadSourceLocation());
6497 TL.setRAngleLoc(ReadSourceLocation());
6498 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
6501 Reader->GetTemplateArgumentLocInfo(
6502 *F, TL.getTypePtr()->getArg(i).getKind(), Record, Idx));
6504 void TypeLocReader::VisitParenTypeLoc(ParenTypeLoc TL) {
6505 TL.setLParenLoc(ReadSourceLocation());
6506 TL.setRParenLoc(ReadSourceLocation());
6509 void TypeLocReader::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
6510 TL.setElaboratedKeywordLoc(ReadSourceLocation());
6511 TL.setQualifierLoc(ReadNestedNameSpecifierLoc());
6514 void TypeLocReader::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
6515 TL.setNameLoc(ReadSourceLocation());
6518 void TypeLocReader::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
6519 TL.setElaboratedKeywordLoc(ReadSourceLocation());
6520 TL.setQualifierLoc(ReadNestedNameSpecifierLoc());
6521 TL.setNameLoc(ReadSourceLocation());
6524 void TypeLocReader::VisitDependentTemplateSpecializationTypeLoc(
6525 DependentTemplateSpecializationTypeLoc TL) {
6526 TL.setElaboratedKeywordLoc(ReadSourceLocation());
6527 TL.setQualifierLoc(ReadNestedNameSpecifierLoc());
6528 TL.setTemplateKeywordLoc(ReadSourceLocation());
6529 TL.setTemplateNameLoc(ReadSourceLocation());
6530 TL.setLAngleLoc(ReadSourceLocation());
6531 TL.setRAngleLoc(ReadSourceLocation());
6532 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
6535 Reader->GetTemplateArgumentLocInfo(
6536 *F, TL.getTypePtr()->getArg(I).getKind(), Record, Idx));
6539 void TypeLocReader::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
6540 TL.setEllipsisLoc(ReadSourceLocation());
6543 void TypeLocReader::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
6544 TL.setNameLoc(ReadSourceLocation());
6547 void TypeLocReader::VisitObjCTypeParamTypeLoc(ObjCTypeParamTypeLoc TL) {
6548 if (TL.getNumProtocols()) {
6549 TL.setProtocolLAngleLoc(ReadSourceLocation());
6550 TL.setProtocolRAngleLoc(ReadSourceLocation());
6552 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
6553 TL.setProtocolLoc(i, ReadSourceLocation());
6556 void TypeLocReader::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
6557 TL.setHasBaseTypeAsWritten(Record[Idx++]);
6558 TL.setTypeArgsLAngleLoc(ReadSourceLocation());
6559 TL.setTypeArgsRAngleLoc(ReadSourceLocation());
6560 for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
6561 TL.setTypeArgTInfo(i, GetTypeSourceInfo());
6562 TL.setProtocolLAngleLoc(ReadSourceLocation());
6563 TL.setProtocolRAngleLoc(ReadSourceLocation());
6564 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
6565 TL.setProtocolLoc(i, ReadSourceLocation());
6568 void TypeLocReader::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
6569 TL.setStarLoc(ReadSourceLocation());
6572 void TypeLocReader::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
6573 TL.setKWLoc(ReadSourceLocation());
6574 TL.setLParenLoc(ReadSourceLocation());
6575 TL.setRParenLoc(ReadSourceLocation());
6578 void TypeLocReader::VisitPipeTypeLoc(PipeTypeLoc TL) {
6579 TL.setKWLoc(ReadSourceLocation());
6583 ASTReader::GetTypeSourceInfo(ModuleFile &F, const ASTReader::RecordData &Record,
6585 QualType InfoTy = readType(F, Record, Idx);
6586 if (InfoTy.isNull())
6589 TypeSourceInfo *TInfo = getContext().CreateTypeSourceInfo(InfoTy);
6590 TypeLocReader TLR(F, *this, Record, Idx);
6591 for (TypeLoc TL = TInfo->getTypeLoc(); !TL.isNull(); TL = TL.getNextTypeLoc())
6596 QualType ASTReader::GetType(TypeID ID) {
6597 assert(ContextObj && "reading type with no AST context");
6598 ASTContext &Context = *ContextObj;
6600 unsigned FastQuals = ID & Qualifiers::FastMask;
6601 unsigned Index = ID >> Qualifiers::FastWidth;
6603 if (Index < NUM_PREDEF_TYPE_IDS) {
6605 switch ((PredefinedTypeIDs)Index) {
6606 case PREDEF_TYPE_NULL_ID:
6608 case PREDEF_TYPE_VOID_ID:
6611 case PREDEF_TYPE_BOOL_ID:
6615 case PREDEF_TYPE_CHAR_U_ID:
6616 case PREDEF_TYPE_CHAR_S_ID:
6617 // FIXME: Check that the signedness of CharTy is correct!
6621 case PREDEF_TYPE_UCHAR_ID:
6622 T = Context.UnsignedCharTy;
6624 case PREDEF_TYPE_USHORT_ID:
6625 T = Context.UnsignedShortTy;
6627 case PREDEF_TYPE_UINT_ID:
6628 T = Context.UnsignedIntTy;
6630 case PREDEF_TYPE_ULONG_ID:
6631 T = Context.UnsignedLongTy;
6633 case PREDEF_TYPE_ULONGLONG_ID:
6634 T = Context.UnsignedLongLongTy;
6636 case PREDEF_TYPE_UINT128_ID:
6637 T = Context.UnsignedInt128Ty;
6639 case PREDEF_TYPE_SCHAR_ID:
6640 T = Context.SignedCharTy;
6642 case PREDEF_TYPE_WCHAR_ID:
6643 T = Context.WCharTy;
6645 case PREDEF_TYPE_SHORT_ID:
6646 T = Context.ShortTy;
6648 case PREDEF_TYPE_INT_ID:
6651 case PREDEF_TYPE_LONG_ID:
6654 case PREDEF_TYPE_LONGLONG_ID:
6655 T = Context.LongLongTy;
6657 case PREDEF_TYPE_INT128_ID:
6658 T = Context.Int128Ty;
6660 case PREDEF_TYPE_HALF_ID:
6663 case PREDEF_TYPE_FLOAT_ID:
6664 T = Context.FloatTy;
6666 case PREDEF_TYPE_DOUBLE_ID:
6667 T = Context.DoubleTy;
6669 case PREDEF_TYPE_LONGDOUBLE_ID:
6670 T = Context.LongDoubleTy;
6672 case PREDEF_TYPE_FLOAT128_ID:
6673 T = Context.Float128Ty;
6675 case PREDEF_TYPE_OVERLOAD_ID:
6676 T = Context.OverloadTy;
6678 case PREDEF_TYPE_BOUND_MEMBER:
6679 T = Context.BoundMemberTy;
6681 case PREDEF_TYPE_PSEUDO_OBJECT:
6682 T = Context.PseudoObjectTy;
6684 case PREDEF_TYPE_DEPENDENT_ID:
6685 T = Context.DependentTy;
6687 case PREDEF_TYPE_UNKNOWN_ANY:
6688 T = Context.UnknownAnyTy;
6690 case PREDEF_TYPE_NULLPTR_ID:
6691 T = Context.NullPtrTy;
6693 case PREDEF_TYPE_CHAR16_ID:
6694 T = Context.Char16Ty;
6696 case PREDEF_TYPE_CHAR32_ID:
6697 T = Context.Char32Ty;
6699 case PREDEF_TYPE_OBJC_ID:
6700 T = Context.ObjCBuiltinIdTy;
6702 case PREDEF_TYPE_OBJC_CLASS:
6703 T = Context.ObjCBuiltinClassTy;
6705 case PREDEF_TYPE_OBJC_SEL:
6706 T = Context.ObjCBuiltinSelTy;
6708 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
6709 case PREDEF_TYPE_##Id##_ID: \
6710 T = Context.SingletonId; \
6712 #include "clang/Basic/OpenCLImageTypes.def"
6713 case PREDEF_TYPE_SAMPLER_ID:
6714 T = Context.OCLSamplerTy;
6716 case PREDEF_TYPE_EVENT_ID:
6717 T = Context.OCLEventTy;
6719 case PREDEF_TYPE_CLK_EVENT_ID:
6720 T = Context.OCLClkEventTy;
6722 case PREDEF_TYPE_QUEUE_ID:
6723 T = Context.OCLQueueTy;
6725 case PREDEF_TYPE_RESERVE_ID_ID:
6726 T = Context.OCLReserveIDTy;
6728 case PREDEF_TYPE_AUTO_DEDUCT:
6729 T = Context.getAutoDeductType();
6732 case PREDEF_TYPE_AUTO_RREF_DEDUCT:
6733 T = Context.getAutoRRefDeductType();
6736 case PREDEF_TYPE_ARC_UNBRIDGED_CAST:
6737 T = Context.ARCUnbridgedCastTy;
6740 case PREDEF_TYPE_BUILTIN_FN:
6741 T = Context.BuiltinFnTy;
6744 case PREDEF_TYPE_OMP_ARRAY_SECTION:
6745 T = Context.OMPArraySectionTy;
6749 assert(!T.isNull() && "Unknown predefined type");
6750 return T.withFastQualifiers(FastQuals);
6753 Index -= NUM_PREDEF_TYPE_IDS;
6754 assert(Index < TypesLoaded.size() && "Type index out-of-range");
6755 if (TypesLoaded[Index].isNull()) {
6756 TypesLoaded[Index] = readTypeRecord(Index);
6757 if (TypesLoaded[Index].isNull())
6760 TypesLoaded[Index]->setFromAST();
6761 if (DeserializationListener)
6762 DeserializationListener->TypeRead(TypeIdx::fromTypeID(ID),
6763 TypesLoaded[Index]);
6766 return TypesLoaded[Index].withFastQualifiers(FastQuals);
6769 QualType ASTReader::getLocalType(ModuleFile &F, unsigned LocalID) {
6770 return GetType(getGlobalTypeID(F, LocalID));
6773 serialization::TypeID
6774 ASTReader::getGlobalTypeID(ModuleFile &F, unsigned LocalID) const {
6775 unsigned FastQuals = LocalID & Qualifiers::FastMask;
6776 unsigned LocalIndex = LocalID >> Qualifiers::FastWidth;
6778 if (LocalIndex < NUM_PREDEF_TYPE_IDS)
6781 if (!F.ModuleOffsetMap.empty())
6782 ReadModuleOffsetMap(F);
6784 ContinuousRangeMap<uint32_t, int, 2>::iterator I
6785 = F.TypeRemap.find(LocalIndex - NUM_PREDEF_TYPE_IDS);
6786 assert(I != F.TypeRemap.end() && "Invalid index into type index remap");
6788 unsigned GlobalIndex = LocalIndex + I->second;
6789 return (GlobalIndex << Qualifiers::FastWidth) | FastQuals;
6792 TemplateArgumentLocInfo
6793 ASTReader::GetTemplateArgumentLocInfo(ModuleFile &F,
6794 TemplateArgument::ArgKind Kind,
6795 const RecordData &Record,
6798 case TemplateArgument::Expression:
6800 case TemplateArgument::Type:
6801 return GetTypeSourceInfo(F, Record, Index);
6802 case TemplateArgument::Template: {
6803 NestedNameSpecifierLoc QualifierLoc = ReadNestedNameSpecifierLoc(F, Record,
6805 SourceLocation TemplateNameLoc = ReadSourceLocation(F, Record, Index);
6806 return TemplateArgumentLocInfo(QualifierLoc, TemplateNameLoc,
6809 case TemplateArgument::TemplateExpansion: {
6810 NestedNameSpecifierLoc QualifierLoc = ReadNestedNameSpecifierLoc(F, Record,
6812 SourceLocation TemplateNameLoc = ReadSourceLocation(F, Record, Index);
6813 SourceLocation EllipsisLoc = ReadSourceLocation(F, Record, Index);
6814 return TemplateArgumentLocInfo(QualifierLoc, TemplateNameLoc,
6817 case TemplateArgument::Null:
6818 case TemplateArgument::Integral:
6819 case TemplateArgument::Declaration:
6820 case TemplateArgument::NullPtr:
6821 case TemplateArgument::Pack:
6822 // FIXME: Is this right?
6823 return TemplateArgumentLocInfo();
6825 llvm_unreachable("unexpected template argument loc");
6829 ASTReader::ReadTemplateArgumentLoc(ModuleFile &F,
6830 const RecordData &Record, unsigned &Index) {
6831 TemplateArgument Arg = ReadTemplateArgument(F, Record, Index);
6833 if (Arg.getKind() == TemplateArgument::Expression) {
6834 if (Record[Index++]) // bool InfoHasSameExpr.
6835 return TemplateArgumentLoc(Arg, TemplateArgumentLocInfo(Arg.getAsExpr()));
6837 return TemplateArgumentLoc(Arg, GetTemplateArgumentLocInfo(F, Arg.getKind(),
6841 const ASTTemplateArgumentListInfo*
6842 ASTReader::ReadASTTemplateArgumentListInfo(ModuleFile &F,
6843 const RecordData &Record,
6845 SourceLocation LAngleLoc = ReadSourceLocation(F, Record, Index);
6846 SourceLocation RAngleLoc = ReadSourceLocation(F, Record, Index);
6847 unsigned NumArgsAsWritten = Record[Index++];
6848 TemplateArgumentListInfo TemplArgsInfo(LAngleLoc, RAngleLoc);
6849 for (unsigned i = 0; i != NumArgsAsWritten; ++i)
6850 TemplArgsInfo.addArgument(ReadTemplateArgumentLoc(F, Record, Index));
6851 return ASTTemplateArgumentListInfo::Create(getContext(), TemplArgsInfo);
6854 Decl *ASTReader::GetExternalDecl(uint32_t ID) {
6858 void ASTReader::CompleteRedeclChain(const Decl *D) {
6859 if (NumCurrentElementsDeserializing) {
6860 // We arrange to not care about the complete redeclaration chain while we're
6861 // deserializing. Just remember that the AST has marked this one as complete
6862 // but that it's not actually complete yet, so we know we still need to
6863 // complete it later.
6864 PendingIncompleteDeclChains.push_back(const_cast<Decl*>(D));
6868 const DeclContext *DC = D->getDeclContext()->getRedeclContext();
6870 // If this is a named declaration, complete it by looking it up
6871 // within its context.
6873 // FIXME: Merging a function definition should merge
6874 // all mergeable entities within it.
6875 if (isa<TranslationUnitDecl>(DC) || isa<NamespaceDecl>(DC) ||
6876 isa<CXXRecordDecl>(DC) || isa<EnumDecl>(DC)) {
6877 if (DeclarationName Name = cast<NamedDecl>(D)->getDeclName()) {
6878 if (!getContext().getLangOpts().CPlusPlus &&
6879 isa<TranslationUnitDecl>(DC)) {
6880 // Outside of C++, we don't have a lookup table for the TU, so update
6881 // the identifier instead. (For C++ modules, we don't store decls
6882 // in the serialized identifier table, so we do the lookup in the TU.)
6883 auto *II = Name.getAsIdentifierInfo();
6884 assert(II && "non-identifier name in C?");
6885 if (II->isOutOfDate())
6886 updateOutOfDateIdentifier(*II);
6889 } else if (needsAnonymousDeclarationNumber(cast<NamedDecl>(D))) {
6890 // Find all declarations of this kind from the relevant context.
6891 for (auto *DCDecl : cast<Decl>(D->getLexicalDeclContext())->redecls()) {
6892 auto *DC = cast<DeclContext>(DCDecl);
6893 SmallVector<Decl*, 8> Decls;
6894 FindExternalLexicalDecls(
6895 DC, [&](Decl::Kind K) { return K == D->getKind(); }, Decls);
6900 if (auto *CTSD = dyn_cast<ClassTemplateSpecializationDecl>(D))
6901 CTSD->getSpecializedTemplate()->LoadLazySpecializations();
6902 if (auto *VTSD = dyn_cast<VarTemplateSpecializationDecl>(D))
6903 VTSD->getSpecializedTemplate()->LoadLazySpecializations();
6904 if (auto *FD = dyn_cast<FunctionDecl>(D)) {
6905 if (auto *Template = FD->getPrimaryTemplate())
6906 Template->LoadLazySpecializations();
6910 CXXCtorInitializer **
6911 ASTReader::GetExternalCXXCtorInitializers(uint64_t Offset) {
6912 RecordLocation Loc = getLocalBitOffset(Offset);
6913 BitstreamCursor &Cursor = Loc.F->DeclsCursor;
6914 SavedStreamPosition SavedPosition(Cursor);
6915 Cursor.JumpToBit(Loc.Offset);
6916 ReadingKindTracker ReadingKind(Read_Decl, *this);
6919 unsigned Code = Cursor.ReadCode();
6920 unsigned RecCode = Cursor.readRecord(Code, Record);
6921 if (RecCode != DECL_CXX_CTOR_INITIALIZERS) {
6922 Error("malformed AST file: missing C++ ctor initializers");
6927 return ReadCXXCtorInitializers(*Loc.F, Record, Idx);
6930 CXXBaseSpecifier *ASTReader::GetExternalCXXBaseSpecifiers(uint64_t Offset) {
6931 assert(ContextObj && "reading base specifiers with no AST context");
6932 ASTContext &Context = *ContextObj;
6934 RecordLocation Loc = getLocalBitOffset(Offset);
6935 BitstreamCursor &Cursor = Loc.F->DeclsCursor;
6936 SavedStreamPosition SavedPosition(Cursor);
6937 Cursor.JumpToBit(Loc.Offset);
6938 ReadingKindTracker ReadingKind(Read_Decl, *this);
6940 unsigned Code = Cursor.ReadCode();
6941 unsigned RecCode = Cursor.readRecord(Code, Record);
6942 if (RecCode != DECL_CXX_BASE_SPECIFIERS) {
6943 Error("malformed AST file: missing C++ base specifiers");
6948 unsigned NumBases = Record[Idx++];
6949 void *Mem = Context.Allocate(sizeof(CXXBaseSpecifier) * NumBases);
6950 CXXBaseSpecifier *Bases = new (Mem) CXXBaseSpecifier [NumBases];
6951 for (unsigned I = 0; I != NumBases; ++I)
6952 Bases[I] = ReadCXXBaseSpecifier(*Loc.F, Record, Idx);
6956 serialization::DeclID
6957 ASTReader::getGlobalDeclID(ModuleFile &F, LocalDeclID LocalID) const {
6958 if (LocalID < NUM_PREDEF_DECL_IDS)
6961 if (!F.ModuleOffsetMap.empty())
6962 ReadModuleOffsetMap(F);
6964 ContinuousRangeMap<uint32_t, int, 2>::iterator I
6965 = F.DeclRemap.find(LocalID - NUM_PREDEF_DECL_IDS);
6966 assert(I != F.DeclRemap.end() && "Invalid index into decl index remap");
6968 return LocalID + I->second;
6971 bool ASTReader::isDeclIDFromModule(serialization::GlobalDeclID ID,
6972 ModuleFile &M) const {
6973 // Predefined decls aren't from any module.
6974 if (ID < NUM_PREDEF_DECL_IDS)
6977 return ID - NUM_PREDEF_DECL_IDS >= M.BaseDeclID &&
6978 ID - NUM_PREDEF_DECL_IDS < M.BaseDeclID + M.LocalNumDecls;
6981 ModuleFile *ASTReader::getOwningModuleFile(const Decl *D) {
6982 if (!D->isFromASTFile())
6984 GlobalDeclMapType::const_iterator I = GlobalDeclMap.find(D->getGlobalID());
6985 assert(I != GlobalDeclMap.end() && "Corrupted global declaration map");
6989 SourceLocation ASTReader::getSourceLocationForDeclID(GlobalDeclID ID) {
6990 if (ID < NUM_PREDEF_DECL_IDS)
6991 return SourceLocation();
6993 unsigned Index = ID - NUM_PREDEF_DECL_IDS;
6995 if (Index > DeclsLoaded.size()) {
6996 Error("declaration ID out-of-range for AST file");
6997 return SourceLocation();
7000 if (Decl *D = DeclsLoaded[Index])
7001 return D->getLocation();
7004 DeclCursorForID(ID, Loc);
7008 static Decl *getPredefinedDecl(ASTContext &Context, PredefinedDeclIDs ID) {
7010 case PREDEF_DECL_NULL_ID:
7013 case PREDEF_DECL_TRANSLATION_UNIT_ID:
7014 return Context.getTranslationUnitDecl();
7016 case PREDEF_DECL_OBJC_ID_ID:
7017 return Context.getObjCIdDecl();
7019 case PREDEF_DECL_OBJC_SEL_ID:
7020 return Context.getObjCSelDecl();
7022 case PREDEF_DECL_OBJC_CLASS_ID:
7023 return Context.getObjCClassDecl();
7025 case PREDEF_DECL_OBJC_PROTOCOL_ID:
7026 return Context.getObjCProtocolDecl();
7028 case PREDEF_DECL_INT_128_ID:
7029 return Context.getInt128Decl();
7031 case PREDEF_DECL_UNSIGNED_INT_128_ID:
7032 return Context.getUInt128Decl();
7034 case PREDEF_DECL_OBJC_INSTANCETYPE_ID:
7035 return Context.getObjCInstanceTypeDecl();
7037 case PREDEF_DECL_BUILTIN_VA_LIST_ID:
7038 return Context.getBuiltinVaListDecl();
7040 case PREDEF_DECL_VA_LIST_TAG:
7041 return Context.getVaListTagDecl();
7043 case PREDEF_DECL_BUILTIN_MS_VA_LIST_ID:
7044 return Context.getBuiltinMSVaListDecl();
7046 case PREDEF_DECL_EXTERN_C_CONTEXT_ID:
7047 return Context.getExternCContextDecl();
7049 case PREDEF_DECL_MAKE_INTEGER_SEQ_ID:
7050 return Context.getMakeIntegerSeqDecl();
7052 case PREDEF_DECL_CF_CONSTANT_STRING_ID:
7053 return Context.getCFConstantStringDecl();
7055 case PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID:
7056 return Context.getCFConstantStringTagDecl();
7058 case PREDEF_DECL_TYPE_PACK_ELEMENT_ID:
7059 return Context.getTypePackElementDecl();
7061 llvm_unreachable("PredefinedDeclIDs unknown enum value");
7064 Decl *ASTReader::GetExistingDecl(DeclID ID) {
7065 assert(ContextObj && "reading decl with no AST context");
7066 if (ID < NUM_PREDEF_DECL_IDS) {
7067 Decl *D = getPredefinedDecl(*ContextObj, (PredefinedDeclIDs)ID);
7069 // Track that we have merged the declaration with ID \p ID into the
7070 // pre-existing predefined declaration \p D.
7071 auto &Merged = KeyDecls[D->getCanonicalDecl()];
7073 Merged.push_back(ID);
7078 unsigned Index = ID - NUM_PREDEF_DECL_IDS;
7080 if (Index >= DeclsLoaded.size()) {
7081 assert(0 && "declaration ID out-of-range for AST file");
7082 Error("declaration ID out-of-range for AST file");
7086 return DeclsLoaded[Index];
7089 Decl *ASTReader::GetDecl(DeclID ID) {
7090 if (ID < NUM_PREDEF_DECL_IDS)
7091 return GetExistingDecl(ID);
7093 unsigned Index = ID - NUM_PREDEF_DECL_IDS;
7095 if (Index >= DeclsLoaded.size()) {
7096 assert(0 && "declaration ID out-of-range for AST file");
7097 Error("declaration ID out-of-range for AST file");
7101 if (!DeclsLoaded[Index]) {
7103 if (DeserializationListener)
7104 DeserializationListener->DeclRead(ID, DeclsLoaded[Index]);
7107 return DeclsLoaded[Index];
7110 DeclID ASTReader::mapGlobalIDToModuleFileGlobalID(ModuleFile &M,
7112 if (GlobalID < NUM_PREDEF_DECL_IDS)
7115 GlobalDeclMapType::const_iterator I = GlobalDeclMap.find(GlobalID);
7116 assert(I != GlobalDeclMap.end() && "Corrupted global declaration map");
7117 ModuleFile *Owner = I->second;
7119 llvm::DenseMap<ModuleFile *, serialization::DeclID>::iterator Pos
7120 = M.GlobalToLocalDeclIDs.find(Owner);
7121 if (Pos == M.GlobalToLocalDeclIDs.end())
7124 return GlobalID - Owner->BaseDeclID + Pos->second;
7127 serialization::DeclID ASTReader::ReadDeclID(ModuleFile &F,
7128 const RecordData &Record,
7130 if (Idx >= Record.size()) {
7131 Error("Corrupted AST file");
7135 return getGlobalDeclID(F, Record[Idx++]);
7138 /// \brief Resolve the offset of a statement into a statement.
7140 /// This operation will read a new statement from the external
7141 /// source each time it is called, and is meant to be used via a
7142 /// LazyOffsetPtr (which is used by Decls for the body of functions, etc).
7143 Stmt *ASTReader::GetExternalDeclStmt(uint64_t Offset) {
7144 // Switch case IDs are per Decl.
7145 ClearSwitchCaseIDs();
7147 // Offset here is a global offset across the entire chain.
7148 RecordLocation Loc = getLocalBitOffset(Offset);
7149 Loc.F->DeclsCursor.JumpToBit(Loc.Offset);
7150 assert(NumCurrentElementsDeserializing == 0 &&
7151 "should not be called while already deserializing");
7152 Deserializing D(this);
7153 return ReadStmtFromStream(*Loc.F);
7156 void ASTReader::FindExternalLexicalDecls(
7157 const DeclContext *DC, llvm::function_ref<bool(Decl::Kind)> IsKindWeWant,
7158 SmallVectorImpl<Decl *> &Decls) {
7159 bool PredefsVisited[NUM_PREDEF_DECL_IDS] = {};
7161 auto Visit = [&] (ModuleFile *M, LexicalContents LexicalDecls) {
7162 assert(LexicalDecls.size() % 2 == 0 && "expected an even number of entries");
7163 for (int I = 0, N = LexicalDecls.size(); I != N; I += 2) {
7164 auto K = (Decl::Kind)+LexicalDecls[I];
7165 if (!IsKindWeWant(K))
7168 auto ID = (serialization::DeclID)+LexicalDecls[I + 1];
7170 // Don't add predefined declarations to the lexical context more
7172 if (ID < NUM_PREDEF_DECL_IDS) {
7173 if (PredefsVisited[ID])
7176 PredefsVisited[ID] = true;
7179 if (Decl *D = GetLocalDecl(*M, ID)) {
7180 assert(D->getKind() == K && "wrong kind for lexical decl");
7181 if (!DC->isDeclInLexicalTraversal(D))
7187 if (isa<TranslationUnitDecl>(DC)) {
7188 for (auto Lexical : TULexicalDecls)
7189 Visit(Lexical.first, Lexical.second);
7191 auto I = LexicalDecls.find(DC);
7192 if (I != LexicalDecls.end())
7193 Visit(I->second.first, I->second.second);
7196 ++NumLexicalDeclContextsRead;
7206 DeclIDComp(ASTReader &Reader, ModuleFile &M) : Reader(Reader), Mod(M) {}
7208 bool operator()(LocalDeclID L, LocalDeclID R) const {
7209 SourceLocation LHS = getLocation(L);
7210 SourceLocation RHS = getLocation(R);
7211 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
7214 bool operator()(SourceLocation LHS, LocalDeclID R) const {
7215 SourceLocation RHS = getLocation(R);
7216 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
7219 bool operator()(LocalDeclID L, SourceLocation RHS) const {
7220 SourceLocation LHS = getLocation(L);
7221 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
7224 SourceLocation getLocation(LocalDeclID ID) const {
7225 return Reader.getSourceManager().getFileLoc(
7226 Reader.getSourceLocationForDeclID(Reader.getGlobalDeclID(Mod, ID)));
7230 } // end anonymous namespace
7232 void ASTReader::FindFileRegionDecls(FileID File,
7233 unsigned Offset, unsigned Length,
7234 SmallVectorImpl<Decl *> &Decls) {
7235 SourceManager &SM = getSourceManager();
7237 llvm::DenseMap<FileID, FileDeclsInfo>::iterator I = FileDeclIDs.find(File);
7238 if (I == FileDeclIDs.end())
7241 FileDeclsInfo &DInfo = I->second;
7242 if (DInfo.Decls.empty())
7246 BeginLoc = SM.getLocForStartOfFile(File).getLocWithOffset(Offset);
7247 SourceLocation EndLoc = BeginLoc.getLocWithOffset(Length);
7249 DeclIDComp DIDComp(*this, *DInfo.Mod);
7250 ArrayRef<serialization::LocalDeclID>::iterator
7251 BeginIt = std::lower_bound(DInfo.Decls.begin(), DInfo.Decls.end(),
7253 if (BeginIt != DInfo.Decls.begin())
7256 // If we are pointing at a top-level decl inside an objc container, we need
7257 // to backtrack until we find it otherwise we will fail to report that the
7258 // region overlaps with an objc container.
7259 while (BeginIt != DInfo.Decls.begin() &&
7260 GetDecl(getGlobalDeclID(*DInfo.Mod, *BeginIt))
7261 ->isTopLevelDeclInObjCContainer())
7264 ArrayRef<serialization::LocalDeclID>::iterator
7265 EndIt = std::upper_bound(DInfo.Decls.begin(), DInfo.Decls.end(),
7267 if (EndIt != DInfo.Decls.end())
7270 for (ArrayRef<serialization::LocalDeclID>::iterator
7271 DIt = BeginIt; DIt != EndIt; ++DIt)
7272 Decls.push_back(GetDecl(getGlobalDeclID(*DInfo.Mod, *DIt)));
7276 ASTReader::FindExternalVisibleDeclsByName(const DeclContext *DC,
7277 DeclarationName Name) {
7278 assert(DC->hasExternalVisibleStorage() && DC == DC->getPrimaryContext() &&
7279 "DeclContext has no visible decls in storage");
7283 auto It = Lookups.find(DC);
7284 if (It == Lookups.end())
7287 Deserializing LookupResults(this);
7289 // Load the list of declarations.
7290 SmallVector<NamedDecl *, 64> Decls;
7291 for (DeclID ID : It->second.Table.find(Name)) {
7292 NamedDecl *ND = cast<NamedDecl>(GetDecl(ID));
7293 if (ND->getDeclName() == Name)
7294 Decls.push_back(ND);
7297 ++NumVisibleDeclContextsRead;
7298 SetExternalVisibleDeclsForName(DC, Name, Decls);
7299 return !Decls.empty();
7302 void ASTReader::completeVisibleDeclsMap(const DeclContext *DC) {
7303 if (!DC->hasExternalVisibleStorage())
7306 auto It = Lookups.find(DC);
7307 assert(It != Lookups.end() &&
7308 "have external visible storage but no lookup tables");
7312 for (DeclID ID : It->second.Table.findAll()) {
7313 NamedDecl *ND = cast<NamedDecl>(GetDecl(ID));
7314 Decls[ND->getDeclName()].push_back(ND);
7317 ++NumVisibleDeclContextsRead;
7319 for (DeclsMap::iterator I = Decls.begin(), E = Decls.end(); I != E; ++I) {
7320 SetExternalVisibleDeclsForName(DC, I->first, I->second);
7322 const_cast<DeclContext *>(DC)->setHasExternalVisibleStorage(false);
7325 const serialization::reader::DeclContextLookupTable *
7326 ASTReader::getLoadedLookupTables(DeclContext *Primary) const {
7327 auto I = Lookups.find(Primary);
7328 return I == Lookups.end() ? nullptr : &I->second;
7331 /// \brief Under non-PCH compilation the consumer receives the objc methods
7332 /// before receiving the implementation, and codegen depends on this.
7333 /// We simulate this by deserializing and passing to consumer the methods of the
7334 /// implementation before passing the deserialized implementation decl.
7335 static void PassObjCImplDeclToConsumer(ObjCImplDecl *ImplD,
7336 ASTConsumer *Consumer) {
7337 assert(ImplD && Consumer);
7339 for (auto *I : ImplD->methods())
7340 Consumer->HandleInterestingDecl(DeclGroupRef(I));
7342 Consumer->HandleInterestingDecl(DeclGroupRef(ImplD));
7345 void ASTReader::PassInterestingDeclToConsumer(Decl *D) {
7346 if (ObjCImplDecl *ImplD = dyn_cast<ObjCImplDecl>(D))
7347 PassObjCImplDeclToConsumer(ImplD, Consumer);
7349 Consumer->HandleInterestingDecl(DeclGroupRef(D));
7352 void ASTReader::StartTranslationUnit(ASTConsumer *Consumer) {
7353 this->Consumer = Consumer;
7356 PassInterestingDeclsToConsumer();
7358 if (DeserializationListener)
7359 DeserializationListener->ReaderInitialized(this);
7362 void ASTReader::PrintStats() {
7363 std::fprintf(stderr, "*** AST File Statistics:\n");
7365 unsigned NumTypesLoaded
7366 = TypesLoaded.size() - std::count(TypesLoaded.begin(), TypesLoaded.end(),
7368 unsigned NumDeclsLoaded
7369 = DeclsLoaded.size() - std::count(DeclsLoaded.begin(), DeclsLoaded.end(),
7371 unsigned NumIdentifiersLoaded
7372 = IdentifiersLoaded.size() - std::count(IdentifiersLoaded.begin(),
7373 IdentifiersLoaded.end(),
7374 (IdentifierInfo *)nullptr);
7375 unsigned NumMacrosLoaded
7376 = MacrosLoaded.size() - std::count(MacrosLoaded.begin(),
7378 (MacroInfo *)nullptr);
7379 unsigned NumSelectorsLoaded
7380 = SelectorsLoaded.size() - std::count(SelectorsLoaded.begin(),
7381 SelectorsLoaded.end(),
7384 if (unsigned TotalNumSLocEntries = getTotalNumSLocs())
7385 std::fprintf(stderr, " %u/%u source location entries read (%f%%)\n",
7386 NumSLocEntriesRead, TotalNumSLocEntries,
7387 ((float)NumSLocEntriesRead/TotalNumSLocEntries * 100));
7388 if (!TypesLoaded.empty())
7389 std::fprintf(stderr, " %u/%u types read (%f%%)\n",
7390 NumTypesLoaded, (unsigned)TypesLoaded.size(),
7391 ((float)NumTypesLoaded/TypesLoaded.size() * 100));
7392 if (!DeclsLoaded.empty())
7393 std::fprintf(stderr, " %u/%u declarations read (%f%%)\n",
7394 NumDeclsLoaded, (unsigned)DeclsLoaded.size(),
7395 ((float)NumDeclsLoaded/DeclsLoaded.size() * 100));
7396 if (!IdentifiersLoaded.empty())
7397 std::fprintf(stderr, " %u/%u identifiers read (%f%%)\n",
7398 NumIdentifiersLoaded, (unsigned)IdentifiersLoaded.size(),
7399 ((float)NumIdentifiersLoaded/IdentifiersLoaded.size() * 100));
7400 if (!MacrosLoaded.empty())
7401 std::fprintf(stderr, " %u/%u macros read (%f%%)\n",
7402 NumMacrosLoaded, (unsigned)MacrosLoaded.size(),
7403 ((float)NumMacrosLoaded/MacrosLoaded.size() * 100));
7404 if (!SelectorsLoaded.empty())
7405 std::fprintf(stderr, " %u/%u selectors read (%f%%)\n",
7406 NumSelectorsLoaded, (unsigned)SelectorsLoaded.size(),
7407 ((float)NumSelectorsLoaded/SelectorsLoaded.size() * 100));
7408 if (TotalNumStatements)
7409 std::fprintf(stderr, " %u/%u statements read (%f%%)\n",
7410 NumStatementsRead, TotalNumStatements,
7411 ((float)NumStatementsRead/TotalNumStatements * 100));
7413 std::fprintf(stderr, " %u/%u macros read (%f%%)\n",
7414 NumMacrosRead, TotalNumMacros,
7415 ((float)NumMacrosRead/TotalNumMacros * 100));
7416 if (TotalLexicalDeclContexts)
7417 std::fprintf(stderr, " %u/%u lexical declcontexts read (%f%%)\n",
7418 NumLexicalDeclContextsRead, TotalLexicalDeclContexts,
7419 ((float)NumLexicalDeclContextsRead/TotalLexicalDeclContexts
7421 if (TotalVisibleDeclContexts)
7422 std::fprintf(stderr, " %u/%u visible declcontexts read (%f%%)\n",
7423 NumVisibleDeclContextsRead, TotalVisibleDeclContexts,
7424 ((float)NumVisibleDeclContextsRead/TotalVisibleDeclContexts
7426 if (TotalNumMethodPoolEntries) {
7427 std::fprintf(stderr, " %u/%u method pool entries read (%f%%)\n",
7428 NumMethodPoolEntriesRead, TotalNumMethodPoolEntries,
7429 ((float)NumMethodPoolEntriesRead/TotalNumMethodPoolEntries
7432 if (NumMethodPoolLookups) {
7433 std::fprintf(stderr, " %u/%u method pool lookups succeeded (%f%%)\n",
7434 NumMethodPoolHits, NumMethodPoolLookups,
7435 ((float)NumMethodPoolHits/NumMethodPoolLookups * 100.0));
7437 if (NumMethodPoolTableLookups) {
7438 std::fprintf(stderr, " %u/%u method pool table lookups succeeded (%f%%)\n",
7439 NumMethodPoolTableHits, NumMethodPoolTableLookups,
7440 ((float)NumMethodPoolTableHits/NumMethodPoolTableLookups
7444 if (NumIdentifierLookupHits) {
7445 std::fprintf(stderr,
7446 " %u / %u identifier table lookups succeeded (%f%%)\n",
7447 NumIdentifierLookupHits, NumIdentifierLookups,
7448 (double)NumIdentifierLookupHits*100.0/NumIdentifierLookups);
7452 std::fprintf(stderr, "\n");
7453 GlobalIndex->printStats();
7456 std::fprintf(stderr, "\n");
7458 std::fprintf(stderr, "\n");
7461 template<typename Key, typename ModuleFile, unsigned InitialCapacity>
7462 LLVM_DUMP_METHOD static void
7463 dumpModuleIDMap(StringRef Name,
7464 const ContinuousRangeMap<Key, ModuleFile *,
7465 InitialCapacity> &Map) {
7466 if (Map.begin() == Map.end())
7469 typedef ContinuousRangeMap<Key, ModuleFile *, InitialCapacity> MapType;
7470 llvm::errs() << Name << ":\n";
7471 for (typename MapType::const_iterator I = Map.begin(), IEnd = Map.end();
7473 llvm::errs() << " " << I->first << " -> " << I->second->FileName
7478 LLVM_DUMP_METHOD void ASTReader::dump() {
7479 llvm::errs() << "*** PCH/ModuleFile Remappings:\n";
7480 dumpModuleIDMap("Global bit offset map", GlobalBitOffsetsMap);
7481 dumpModuleIDMap("Global source location entry map", GlobalSLocEntryMap);
7482 dumpModuleIDMap("Global type map", GlobalTypeMap);
7483 dumpModuleIDMap("Global declaration map", GlobalDeclMap);
7484 dumpModuleIDMap("Global identifier map", GlobalIdentifierMap);
7485 dumpModuleIDMap("Global macro map", GlobalMacroMap);
7486 dumpModuleIDMap("Global submodule map", GlobalSubmoduleMap);
7487 dumpModuleIDMap("Global selector map", GlobalSelectorMap);
7488 dumpModuleIDMap("Global preprocessed entity map",
7489 GlobalPreprocessedEntityMap);
7491 llvm::errs() << "\n*** PCH/Modules Loaded:";
7492 for (ModuleFile &M : ModuleMgr)
7496 /// Return the amount of memory used by memory buffers, breaking down
7497 /// by heap-backed versus mmap'ed memory.
7498 void ASTReader::getMemoryBufferSizes(MemoryBufferSizes &sizes) const {
7499 for (ModuleFile &I : ModuleMgr) {
7500 if (llvm::MemoryBuffer *buf = I.Buffer) {
7501 size_t bytes = buf->getBufferSize();
7502 switch (buf->getBufferKind()) {
7503 case llvm::MemoryBuffer::MemoryBuffer_Malloc:
7504 sizes.malloc_bytes += bytes;
7506 case llvm::MemoryBuffer::MemoryBuffer_MMap:
7507 sizes.mmap_bytes += bytes;
7514 void ASTReader::InitializeSema(Sema &S) {
7516 S.addExternalSource(this);
7518 // Makes sure any declarations that were deserialized "too early"
7519 // still get added to the identifier's declaration chains.
7520 for (uint64_t ID : PreloadedDeclIDs) {
7521 NamedDecl *D = cast<NamedDecl>(GetDecl(ID));
7522 pushExternalDeclIntoScope(D, D->getDeclName());
7524 PreloadedDeclIDs.clear();
7526 // FIXME: What happens if these are changed by a module import?
7527 if (!FPPragmaOptions.empty()) {
7528 assert(FPPragmaOptions.size() == 1 && "Wrong number of FP_PRAGMA_OPTIONS");
7529 SemaObj->FPFeatures = FPOptions(FPPragmaOptions[0]);
7532 SemaObj->OpenCLFeatures.copy(OpenCLExtensions);
7533 SemaObj->OpenCLTypeExtMap = OpenCLTypeExtMap;
7534 SemaObj->OpenCLDeclExtMap = OpenCLDeclExtMap;
7539 void ASTReader::UpdateSema() {
7540 assert(SemaObj && "no Sema to update");
7542 // Load the offsets of the declarations that Sema references.
7543 // They will be lazily deserialized when needed.
7544 if (!SemaDeclRefs.empty()) {
7545 assert(SemaDeclRefs.size() % 3 == 0);
7546 for (unsigned I = 0; I != SemaDeclRefs.size(); I += 3) {
7547 if (!SemaObj->StdNamespace)
7548 SemaObj->StdNamespace = SemaDeclRefs[I];
7549 if (!SemaObj->StdBadAlloc)
7550 SemaObj->StdBadAlloc = SemaDeclRefs[I+1];
7551 if (!SemaObj->StdAlignValT)
7552 SemaObj->StdAlignValT = SemaDeclRefs[I+2];
7554 SemaDeclRefs.clear();
7557 // Update the state of pragmas. Use the same API as if we had encountered the
7558 // pragma in the source.
7559 if(OptimizeOffPragmaLocation.isValid())
7560 SemaObj->ActOnPragmaOptimize(/* IsOn = */ false, OptimizeOffPragmaLocation);
7561 if (PragmaMSStructState != -1)
7562 SemaObj->ActOnPragmaMSStruct((PragmaMSStructKind)PragmaMSStructState);
7563 if (PointersToMembersPragmaLocation.isValid()) {
7564 SemaObj->ActOnPragmaMSPointersToMembers(
7565 (LangOptions::PragmaMSPointersToMembersKind)
7566 PragmaMSPointersToMembersState,
7567 PointersToMembersPragmaLocation);
7569 SemaObj->ForceCUDAHostDeviceDepth = ForceCUDAHostDeviceDepth;
7571 if (PragmaPackCurrentValue) {
7572 // The bottom of the stack might have a default value. It must be adjusted
7573 // to the current value to ensure that the packing state is preserved after
7574 // popping entries that were included/imported from a PCH/module.
7575 bool DropFirst = false;
7576 if (!PragmaPackStack.empty() &&
7577 PragmaPackStack.front().Location.isInvalid()) {
7578 assert(PragmaPackStack.front().Value == SemaObj->PackStack.DefaultValue &&
7579 "Expected a default alignment value");
7580 SemaObj->PackStack.Stack.emplace_back(
7581 PragmaPackStack.front().SlotLabel, SemaObj->PackStack.CurrentValue,
7582 SemaObj->PackStack.CurrentPragmaLocation);
7585 for (const auto &Entry :
7586 llvm::makeArrayRef(PragmaPackStack).drop_front(DropFirst ? 1 : 0))
7587 SemaObj->PackStack.Stack.emplace_back(Entry.SlotLabel, Entry.Value,
7589 if (PragmaPackCurrentLocation.isInvalid()) {
7590 assert(*PragmaPackCurrentValue == SemaObj->PackStack.DefaultValue &&
7591 "Expected a default alignment value");
7592 // Keep the current values.
7594 SemaObj->PackStack.CurrentValue = *PragmaPackCurrentValue;
7595 SemaObj->PackStack.CurrentPragmaLocation = PragmaPackCurrentLocation;
7600 IdentifierInfo *ASTReader::get(StringRef Name) {
7601 // Note that we are loading an identifier.
7602 Deserializing AnIdentifier(this);
7604 IdentifierLookupVisitor Visitor(Name, /*PriorGeneration=*/0,
7605 NumIdentifierLookups,
7606 NumIdentifierLookupHits);
7608 // We don't need to do identifier table lookups in C++ modules (we preload
7609 // all interesting declarations, and don't need to use the scope for name
7610 // lookups). Perform the lookup in PCH files, though, since we don't build
7611 // a complete initial identifier table if we're carrying on from a PCH.
7612 if (PP.getLangOpts().CPlusPlus) {
7613 for (auto F : ModuleMgr.pch_modules())
7617 // If there is a global index, look there first to determine which modules
7618 // provably do not have any results for this identifier.
7619 GlobalModuleIndex::HitSet Hits;
7620 GlobalModuleIndex::HitSet *HitsPtr = nullptr;
7621 if (!loadGlobalIndex()) {
7622 if (GlobalIndex->lookupIdentifier(Name, Hits)) {
7627 ModuleMgr.visit(Visitor, HitsPtr);
7630 IdentifierInfo *II = Visitor.getIdentifierInfo();
7631 markIdentifierUpToDate(II);
7637 /// \brief An identifier-lookup iterator that enumerates all of the
7638 /// identifiers stored within a set of AST files.
7639 class ASTIdentifierIterator : public IdentifierIterator {
7640 /// \brief The AST reader whose identifiers are being enumerated.
7641 const ASTReader &Reader;
7643 /// \brief The current index into the chain of AST files stored in
7647 /// \brief The current position within the identifier lookup table
7648 /// of the current AST file.
7649 ASTIdentifierLookupTable::key_iterator Current;
7651 /// \brief The end position within the identifier lookup table of
7652 /// the current AST file.
7653 ASTIdentifierLookupTable::key_iterator End;
7655 /// \brief Whether to skip any modules in the ASTReader.
7659 explicit ASTIdentifierIterator(const ASTReader &Reader,
7660 bool SkipModules = false);
7662 StringRef Next() override;
7665 } // end namespace clang
7667 ASTIdentifierIterator::ASTIdentifierIterator(const ASTReader &Reader,
7669 : Reader(Reader), Index(Reader.ModuleMgr.size()), SkipModules(SkipModules) {
7672 StringRef ASTIdentifierIterator::Next() {
7673 while (Current == End) {
7674 // If we have exhausted all of our AST files, we're done.
7679 ModuleFile &F = Reader.ModuleMgr[Index];
7680 if (SkipModules && F.isModule())
7683 ASTIdentifierLookupTable *IdTable =
7684 (ASTIdentifierLookupTable *)F.IdentifierLookupTable;
7685 Current = IdTable->key_begin();
7686 End = IdTable->key_end();
7689 // We have any identifiers remaining in the current AST file; return
7691 StringRef Result = *Current;
7698 /// A utility for appending two IdentifierIterators.
7699 class ChainedIdentifierIterator : public IdentifierIterator {
7700 std::unique_ptr<IdentifierIterator> Current;
7701 std::unique_ptr<IdentifierIterator> Queued;
7704 ChainedIdentifierIterator(std::unique_ptr<IdentifierIterator> First,
7705 std::unique_ptr<IdentifierIterator> Second)
7706 : Current(std::move(First)), Queued(std::move(Second)) {}
7708 StringRef Next() override {
7712 StringRef result = Current->Next();
7713 if (!result.empty())
7716 // Try the queued iterator, which may itself be empty.
7718 std::swap(Current, Queued);
7723 } // end anonymous namespace.
7725 IdentifierIterator *ASTReader::getIdentifiers() {
7726 if (!loadGlobalIndex()) {
7727 std::unique_ptr<IdentifierIterator> ReaderIter(
7728 new ASTIdentifierIterator(*this, /*SkipModules=*/true));
7729 std::unique_ptr<IdentifierIterator> ModulesIter(
7730 GlobalIndex->createIdentifierIterator());
7731 return new ChainedIdentifierIterator(std::move(ReaderIter),
7732 std::move(ModulesIter));
7735 return new ASTIdentifierIterator(*this);
7739 namespace serialization {
7741 class ReadMethodPoolVisitor {
7744 unsigned PriorGeneration;
7745 unsigned InstanceBits;
7746 unsigned FactoryBits;
7747 bool InstanceHasMoreThanOneDecl;
7748 bool FactoryHasMoreThanOneDecl;
7749 SmallVector<ObjCMethodDecl *, 4> InstanceMethods;
7750 SmallVector<ObjCMethodDecl *, 4> FactoryMethods;
7753 ReadMethodPoolVisitor(ASTReader &Reader, Selector Sel,
7754 unsigned PriorGeneration)
7755 : Reader(Reader), Sel(Sel), PriorGeneration(PriorGeneration),
7756 InstanceBits(0), FactoryBits(0), InstanceHasMoreThanOneDecl(false),
7757 FactoryHasMoreThanOneDecl(false) {}
7759 bool operator()(ModuleFile &M) {
7760 if (!M.SelectorLookupTable)
7763 // If we've already searched this module file, skip it now.
7764 if (M.Generation <= PriorGeneration)
7767 ++Reader.NumMethodPoolTableLookups;
7768 ASTSelectorLookupTable *PoolTable
7769 = (ASTSelectorLookupTable*)M.SelectorLookupTable;
7770 ASTSelectorLookupTable::iterator Pos = PoolTable->find(Sel);
7771 if (Pos == PoolTable->end())
7774 ++Reader.NumMethodPoolTableHits;
7775 ++Reader.NumSelectorsRead;
7776 // FIXME: Not quite happy with the statistics here. We probably should
7777 // disable this tracking when called via LoadSelector.
7778 // Also, should entries without methods count as misses?
7779 ++Reader.NumMethodPoolEntriesRead;
7780 ASTSelectorLookupTrait::data_type Data = *Pos;
7781 if (Reader.DeserializationListener)
7782 Reader.DeserializationListener->SelectorRead(Data.ID, Sel);
7784 InstanceMethods.append(Data.Instance.begin(), Data.Instance.end());
7785 FactoryMethods.append(Data.Factory.begin(), Data.Factory.end());
7786 InstanceBits = Data.InstanceBits;
7787 FactoryBits = Data.FactoryBits;
7788 InstanceHasMoreThanOneDecl = Data.InstanceHasMoreThanOneDecl;
7789 FactoryHasMoreThanOneDecl = Data.FactoryHasMoreThanOneDecl;
7793 /// \brief Retrieve the instance methods found by this visitor.
7794 ArrayRef<ObjCMethodDecl *> getInstanceMethods() const {
7795 return InstanceMethods;
7798 /// \brief Retrieve the instance methods found by this visitor.
7799 ArrayRef<ObjCMethodDecl *> getFactoryMethods() const {
7800 return FactoryMethods;
7803 unsigned getInstanceBits() const { return InstanceBits; }
7804 unsigned getFactoryBits() const { return FactoryBits; }
7805 bool instanceHasMoreThanOneDecl() const {
7806 return InstanceHasMoreThanOneDecl;
7808 bool factoryHasMoreThanOneDecl() const { return FactoryHasMoreThanOneDecl; }
7811 } // end namespace serialization
7812 } // end namespace clang
7814 /// \brief Add the given set of methods to the method list.
7815 static void addMethodsToPool(Sema &S, ArrayRef<ObjCMethodDecl *> Methods,
7816 ObjCMethodList &List) {
7817 for (unsigned I = 0, N = Methods.size(); I != N; ++I) {
7818 S.addMethodToGlobalList(&List, Methods[I]);
7822 void ASTReader::ReadMethodPool(Selector Sel) {
7823 // Get the selector generation and update it to the current generation.
7824 unsigned &Generation = SelectorGeneration[Sel];
7825 unsigned PriorGeneration = Generation;
7826 Generation = getGeneration();
7827 SelectorOutOfDate[Sel] = false;
7829 // Search for methods defined with this selector.
7830 ++NumMethodPoolLookups;
7831 ReadMethodPoolVisitor Visitor(*this, Sel, PriorGeneration);
7832 ModuleMgr.visit(Visitor);
7834 if (Visitor.getInstanceMethods().empty() &&
7835 Visitor.getFactoryMethods().empty())
7838 ++NumMethodPoolHits;
7843 Sema &S = *getSema();
7844 Sema::GlobalMethodPool::iterator Pos
7845 = S.MethodPool.insert(std::make_pair(Sel, Sema::GlobalMethods())).first;
7847 Pos->second.first.setBits(Visitor.getInstanceBits());
7848 Pos->second.first.setHasMoreThanOneDecl(Visitor.instanceHasMoreThanOneDecl());
7849 Pos->second.second.setBits(Visitor.getFactoryBits());
7850 Pos->second.second.setHasMoreThanOneDecl(Visitor.factoryHasMoreThanOneDecl());
7852 // Add methods to the global pool *after* setting hasMoreThanOneDecl, since
7853 // when building a module we keep every method individually and may need to
7854 // update hasMoreThanOneDecl as we add the methods.
7855 addMethodsToPool(S, Visitor.getInstanceMethods(), Pos->second.first);
7856 addMethodsToPool(S, Visitor.getFactoryMethods(), Pos->second.second);
7859 void ASTReader::updateOutOfDateSelector(Selector Sel) {
7860 if (SelectorOutOfDate[Sel])
7861 ReadMethodPool(Sel);
7864 void ASTReader::ReadKnownNamespaces(
7865 SmallVectorImpl<NamespaceDecl *> &Namespaces) {
7868 for (unsigned I = 0, N = KnownNamespaces.size(); I != N; ++I) {
7869 if (NamespaceDecl *Namespace
7870 = dyn_cast_or_null<NamespaceDecl>(GetDecl(KnownNamespaces[I])))
7871 Namespaces.push_back(Namespace);
7875 void ASTReader::ReadUndefinedButUsed(
7876 llvm::MapVector<NamedDecl *, SourceLocation> &Undefined) {
7877 for (unsigned Idx = 0, N = UndefinedButUsed.size(); Idx != N;) {
7878 NamedDecl *D = cast<NamedDecl>(GetDecl(UndefinedButUsed[Idx++]));
7879 SourceLocation Loc =
7880 SourceLocation::getFromRawEncoding(UndefinedButUsed[Idx++]);
7881 Undefined.insert(std::make_pair(D, Loc));
7885 void ASTReader::ReadMismatchingDeleteExpressions(llvm::MapVector<
7886 FieldDecl *, llvm::SmallVector<std::pair<SourceLocation, bool>, 4>> &
7888 for (unsigned Idx = 0, N = DelayedDeleteExprs.size(); Idx != N;) {
7889 FieldDecl *FD = cast<FieldDecl>(GetDecl(DelayedDeleteExprs[Idx++]));
7890 uint64_t Count = DelayedDeleteExprs[Idx++];
7891 for (uint64_t C = 0; C < Count; ++C) {
7892 SourceLocation DeleteLoc =
7893 SourceLocation::getFromRawEncoding(DelayedDeleteExprs[Idx++]);
7894 const bool IsArrayForm = DelayedDeleteExprs[Idx++];
7895 Exprs[FD].push_back(std::make_pair(DeleteLoc, IsArrayForm));
7900 void ASTReader::ReadTentativeDefinitions(
7901 SmallVectorImpl<VarDecl *> &TentativeDefs) {
7902 for (unsigned I = 0, N = TentativeDefinitions.size(); I != N; ++I) {
7903 VarDecl *Var = dyn_cast_or_null<VarDecl>(GetDecl(TentativeDefinitions[I]));
7905 TentativeDefs.push_back(Var);
7907 TentativeDefinitions.clear();
7910 void ASTReader::ReadUnusedFileScopedDecls(
7911 SmallVectorImpl<const DeclaratorDecl *> &Decls) {
7912 for (unsigned I = 0, N = UnusedFileScopedDecls.size(); I != N; ++I) {
7914 = dyn_cast_or_null<DeclaratorDecl>(GetDecl(UnusedFileScopedDecls[I]));
7918 UnusedFileScopedDecls.clear();
7921 void ASTReader::ReadDelegatingConstructors(
7922 SmallVectorImpl<CXXConstructorDecl *> &Decls) {
7923 for (unsigned I = 0, N = DelegatingCtorDecls.size(); I != N; ++I) {
7924 CXXConstructorDecl *D
7925 = dyn_cast_or_null<CXXConstructorDecl>(GetDecl(DelegatingCtorDecls[I]));
7929 DelegatingCtorDecls.clear();
7932 void ASTReader::ReadExtVectorDecls(SmallVectorImpl<TypedefNameDecl *> &Decls) {
7933 for (unsigned I = 0, N = ExtVectorDecls.size(); I != N; ++I) {
7935 = dyn_cast_or_null<TypedefNameDecl>(GetDecl(ExtVectorDecls[I]));
7939 ExtVectorDecls.clear();
7942 void ASTReader::ReadUnusedLocalTypedefNameCandidates(
7943 llvm::SmallSetVector<const TypedefNameDecl *, 4> &Decls) {
7944 for (unsigned I = 0, N = UnusedLocalTypedefNameCandidates.size(); I != N;
7946 TypedefNameDecl *D = dyn_cast_or_null<TypedefNameDecl>(
7947 GetDecl(UnusedLocalTypedefNameCandidates[I]));
7951 UnusedLocalTypedefNameCandidates.clear();
7954 void ASTReader::ReadReferencedSelectors(
7955 SmallVectorImpl<std::pair<Selector, SourceLocation> > &Sels) {
7956 if (ReferencedSelectorsData.empty())
7959 // If there are @selector references added them to its pool. This is for
7960 // implementation of -Wselector.
7961 unsigned int DataSize = ReferencedSelectorsData.size()-1;
7963 while (I < DataSize) {
7964 Selector Sel = DecodeSelector(ReferencedSelectorsData[I++]);
7965 SourceLocation SelLoc
7966 = SourceLocation::getFromRawEncoding(ReferencedSelectorsData[I++]);
7967 Sels.push_back(std::make_pair(Sel, SelLoc));
7969 ReferencedSelectorsData.clear();
7972 void ASTReader::ReadWeakUndeclaredIdentifiers(
7973 SmallVectorImpl<std::pair<IdentifierInfo *, WeakInfo> > &WeakIDs) {
7974 if (WeakUndeclaredIdentifiers.empty())
7977 for (unsigned I = 0, N = WeakUndeclaredIdentifiers.size(); I < N; /*none*/) {
7978 IdentifierInfo *WeakId
7979 = DecodeIdentifierInfo(WeakUndeclaredIdentifiers[I++]);
7980 IdentifierInfo *AliasId
7981 = DecodeIdentifierInfo(WeakUndeclaredIdentifiers[I++]);
7983 = SourceLocation::getFromRawEncoding(WeakUndeclaredIdentifiers[I++]);
7984 bool Used = WeakUndeclaredIdentifiers[I++];
7985 WeakInfo WI(AliasId, Loc);
7987 WeakIDs.push_back(std::make_pair(WeakId, WI));
7989 WeakUndeclaredIdentifiers.clear();
7992 void ASTReader::ReadUsedVTables(SmallVectorImpl<ExternalVTableUse> &VTables) {
7993 for (unsigned Idx = 0, N = VTableUses.size(); Idx < N; /* In loop */) {
7994 ExternalVTableUse VT;
7995 VT.Record = dyn_cast_or_null<CXXRecordDecl>(GetDecl(VTableUses[Idx++]));
7996 VT.Location = SourceLocation::getFromRawEncoding(VTableUses[Idx++]);
7997 VT.DefinitionRequired = VTableUses[Idx++];
7998 VTables.push_back(VT);
8004 void ASTReader::ReadPendingInstantiations(
8005 SmallVectorImpl<std::pair<ValueDecl *, SourceLocation> > &Pending) {
8006 for (unsigned Idx = 0, N = PendingInstantiations.size(); Idx < N;) {
8007 ValueDecl *D = cast<ValueDecl>(GetDecl(PendingInstantiations[Idx++]));
8009 = SourceLocation::getFromRawEncoding(PendingInstantiations[Idx++]);
8011 Pending.push_back(std::make_pair(D, Loc));
8013 PendingInstantiations.clear();
8016 void ASTReader::ReadLateParsedTemplates(
8017 llvm::MapVector<const FunctionDecl *, std::unique_ptr<LateParsedTemplate>>
8019 for (unsigned Idx = 0, N = LateParsedTemplates.size(); Idx < N;
8021 FunctionDecl *FD = cast<FunctionDecl>(GetDecl(LateParsedTemplates[Idx++]));
8023 auto LT = llvm::make_unique<LateParsedTemplate>();
8024 LT->D = GetDecl(LateParsedTemplates[Idx++]);
8026 ModuleFile *F = getOwningModuleFile(LT->D);
8027 assert(F && "No module");
8029 unsigned TokN = LateParsedTemplates[Idx++];
8030 LT->Toks.reserve(TokN);
8031 for (unsigned T = 0; T < TokN; ++T)
8032 LT->Toks.push_back(ReadToken(*F, LateParsedTemplates, Idx));
8034 LPTMap.insert(std::make_pair(FD, std::move(LT)));
8037 LateParsedTemplates.clear();
8040 void ASTReader::LoadSelector(Selector Sel) {
8041 // It would be complicated to avoid reading the methods anyway. So don't.
8042 ReadMethodPool(Sel);
8045 void ASTReader::SetIdentifierInfo(IdentifierID ID, IdentifierInfo *II) {
8046 assert(ID && "Non-zero identifier ID required");
8047 assert(ID <= IdentifiersLoaded.size() && "identifier ID out of range");
8048 IdentifiersLoaded[ID - 1] = II;
8049 if (DeserializationListener)
8050 DeserializationListener->IdentifierRead(ID, II);
8053 /// \brief Set the globally-visible declarations associated with the given
8056 /// If the AST reader is currently in a state where the given declaration IDs
8057 /// cannot safely be resolved, they are queued until it is safe to resolve
8060 /// \param II an IdentifierInfo that refers to one or more globally-visible
8063 /// \param DeclIDs the set of declaration IDs with the name @p II that are
8064 /// visible at global scope.
8066 /// \param Decls if non-null, this vector will be populated with the set of
8067 /// deserialized declarations. These declarations will not be pushed into
8070 ASTReader::SetGloballyVisibleDecls(IdentifierInfo *II,
8071 const SmallVectorImpl<uint32_t> &DeclIDs,
8072 SmallVectorImpl<Decl *> *Decls) {
8073 if (NumCurrentElementsDeserializing && !Decls) {
8074 PendingIdentifierInfos[II].append(DeclIDs.begin(), DeclIDs.end());
8078 for (unsigned I = 0, N = DeclIDs.size(); I != N; ++I) {
8080 // Queue this declaration so that it will be added to the
8081 // translation unit scope and identifier's declaration chain
8082 // once a Sema object is known.
8083 PreloadedDeclIDs.push_back(DeclIDs[I]);
8087 NamedDecl *D = cast<NamedDecl>(GetDecl(DeclIDs[I]));
8089 // If we're simply supposed to record the declarations, do so now.
8091 Decls->push_back(D);
8095 // Introduce this declaration into the translation-unit scope
8096 // and add it to the declaration chain for this identifier, so
8097 // that (unqualified) name lookup will find it.
8098 pushExternalDeclIntoScope(D, II);
8102 IdentifierInfo *ASTReader::DecodeIdentifierInfo(IdentifierID ID) {
8106 if (IdentifiersLoaded.empty()) {
8107 Error("no identifier table in AST file");
8112 if (!IdentifiersLoaded[ID]) {
8113 GlobalIdentifierMapType::iterator I = GlobalIdentifierMap.find(ID + 1);
8114 assert(I != GlobalIdentifierMap.end() && "Corrupted global identifier map");
8115 ModuleFile *M = I->second;
8116 unsigned Index = ID - M->BaseIdentifierID;
8117 const char *Str = M->IdentifierTableData + M->IdentifierOffsets[Index];
8119 // All of the strings in the AST file are preceded by a 16-bit length.
8120 // Extract that 16-bit length to avoid having to execute strlen().
8121 // NOTE: 'StrLenPtr' is an 'unsigned char*' so that we load bytes as
8122 // unsigned integers. This is important to avoid integer overflow when
8123 // we cast them to 'unsigned'.
8124 const unsigned char *StrLenPtr = (const unsigned char*) Str - 2;
8125 unsigned StrLen = (((unsigned) StrLenPtr[0])
8126 | (((unsigned) StrLenPtr[1]) << 8)) - 1;
8127 auto &II = PP.getIdentifierTable().get(StringRef(Str, StrLen));
8128 IdentifiersLoaded[ID] = &II;
8129 markIdentifierFromAST(*this, II);
8130 if (DeserializationListener)
8131 DeserializationListener->IdentifierRead(ID + 1, &II);
8134 return IdentifiersLoaded[ID];
8137 IdentifierInfo *ASTReader::getLocalIdentifier(ModuleFile &M, unsigned LocalID) {
8138 return DecodeIdentifierInfo(getGlobalIdentifierID(M, LocalID));
8141 IdentifierID ASTReader::getGlobalIdentifierID(ModuleFile &M, unsigned LocalID) {
8142 if (LocalID < NUM_PREDEF_IDENT_IDS)
8145 if (!M.ModuleOffsetMap.empty())
8146 ReadModuleOffsetMap(M);
8148 ContinuousRangeMap<uint32_t, int, 2>::iterator I
8149 = M.IdentifierRemap.find(LocalID - NUM_PREDEF_IDENT_IDS);
8150 assert(I != M.IdentifierRemap.end()
8151 && "Invalid index into identifier index remap");
8153 return LocalID + I->second;
8156 MacroInfo *ASTReader::getMacro(MacroID ID) {
8160 if (MacrosLoaded.empty()) {
8161 Error("no macro table in AST file");
8165 ID -= NUM_PREDEF_MACRO_IDS;
8166 if (!MacrosLoaded[ID]) {
8167 GlobalMacroMapType::iterator I
8168 = GlobalMacroMap.find(ID + NUM_PREDEF_MACRO_IDS);
8169 assert(I != GlobalMacroMap.end() && "Corrupted global macro map");
8170 ModuleFile *M = I->second;
8171 unsigned Index = ID - M->BaseMacroID;
8172 MacrosLoaded[ID] = ReadMacroRecord(*M, M->MacroOffsets[Index]);
8174 if (DeserializationListener)
8175 DeserializationListener->MacroRead(ID + NUM_PREDEF_MACRO_IDS,
8179 return MacrosLoaded[ID];
8182 MacroID ASTReader::getGlobalMacroID(ModuleFile &M, unsigned LocalID) {
8183 if (LocalID < NUM_PREDEF_MACRO_IDS)
8186 if (!M.ModuleOffsetMap.empty())
8187 ReadModuleOffsetMap(M);
8189 ContinuousRangeMap<uint32_t, int, 2>::iterator I
8190 = M.MacroRemap.find(LocalID - NUM_PREDEF_MACRO_IDS);
8191 assert(I != M.MacroRemap.end() && "Invalid index into macro index remap");
8193 return LocalID + I->second;
8196 serialization::SubmoduleID
8197 ASTReader::getGlobalSubmoduleID(ModuleFile &M, unsigned LocalID) {
8198 if (LocalID < NUM_PREDEF_SUBMODULE_IDS)
8201 if (!M.ModuleOffsetMap.empty())
8202 ReadModuleOffsetMap(M);
8204 ContinuousRangeMap<uint32_t, int, 2>::iterator I
8205 = M.SubmoduleRemap.find(LocalID - NUM_PREDEF_SUBMODULE_IDS);
8206 assert(I != M.SubmoduleRemap.end()
8207 && "Invalid index into submodule index remap");
8209 return LocalID + I->second;
8212 Module *ASTReader::getSubmodule(SubmoduleID GlobalID) {
8213 if (GlobalID < NUM_PREDEF_SUBMODULE_IDS) {
8214 assert(GlobalID == 0 && "Unhandled global submodule ID");
8218 if (GlobalID > SubmodulesLoaded.size()) {
8219 Error("submodule ID out of range in AST file");
8223 return SubmodulesLoaded[GlobalID - NUM_PREDEF_SUBMODULE_IDS];
8226 Module *ASTReader::getModule(unsigned ID) {
8227 return getSubmodule(ID);
8230 ModuleFile *ASTReader::getLocalModuleFile(ModuleFile &F, unsigned ID) {
8232 // It's a module, look it up by submodule ID.
8233 auto I = GlobalSubmoduleMap.find(getGlobalSubmoduleID(F, ID >> 1));
8234 return I == GlobalSubmoduleMap.end() ? nullptr : I->second;
8236 // It's a prefix (preamble, PCH, ...). Look it up by index.
8237 unsigned IndexFromEnd = ID >> 1;
8238 assert(IndexFromEnd && "got reference to unknown module file");
8239 return getModuleManager().pch_modules().end()[-IndexFromEnd];
8243 unsigned ASTReader::getModuleFileID(ModuleFile *F) {
8247 // For a file representing a module, use the submodule ID of the top-level
8248 // module as the file ID. For any other kind of file, the number of such
8249 // files loaded beforehand will be the same on reload.
8250 // FIXME: Is this true even if we have an explicit module file and a PCH?
8252 return ((F->BaseSubmoduleID + NUM_PREDEF_SUBMODULE_IDS) << 1) | 1;
8254 auto PCHModules = getModuleManager().pch_modules();
8255 auto I = std::find(PCHModules.begin(), PCHModules.end(), F);
8256 assert(I != PCHModules.end() && "emitting reference to unknown file");
8257 return (I - PCHModules.end()) << 1;
8260 llvm::Optional<ExternalASTSource::ASTSourceDescriptor>
8261 ASTReader::getSourceDescriptor(unsigned ID) {
8262 if (const Module *M = getSubmodule(ID))
8263 return ExternalASTSource::ASTSourceDescriptor(*M);
8265 // If there is only a single PCH, return it instead.
8266 // Chained PCH are not supported.
8267 const auto &PCHChain = ModuleMgr.pch_modules();
8268 if (std::distance(std::begin(PCHChain), std::end(PCHChain))) {
8269 ModuleFile &MF = ModuleMgr.getPrimaryModule();
8270 StringRef ModuleName = llvm::sys::path::filename(MF.OriginalSourceFileName);
8271 StringRef FileName = llvm::sys::path::filename(MF.FileName);
8272 return ASTReader::ASTSourceDescriptor(ModuleName, MF.OriginalDir, FileName,
8278 ExternalASTSource::ExtKind ASTReader::hasExternalDefinitions(const Decl *FD) {
8279 auto I = BodySource.find(FD);
8280 if (I == BodySource.end())
8281 return EK_ReplyHazy;
8282 return I->second ? EK_Never : EK_Always;
8285 Selector ASTReader::getLocalSelector(ModuleFile &M, unsigned LocalID) {
8286 return DecodeSelector(getGlobalSelectorID(M, LocalID));
8289 Selector ASTReader::DecodeSelector(serialization::SelectorID ID) {
8293 if (ID > SelectorsLoaded.size()) {
8294 Error("selector ID out of range in AST file");
8298 if (SelectorsLoaded[ID - 1].getAsOpaquePtr() == nullptr) {
8299 // Load this selector from the selector table.
8300 GlobalSelectorMapType::iterator I = GlobalSelectorMap.find(ID);
8301 assert(I != GlobalSelectorMap.end() && "Corrupted global selector map");
8302 ModuleFile &M = *I->second;
8303 ASTSelectorLookupTrait Trait(*this, M);
8304 unsigned Idx = ID - M.BaseSelectorID - NUM_PREDEF_SELECTOR_IDS;
8305 SelectorsLoaded[ID - 1] =
8306 Trait.ReadKey(M.SelectorLookupTableData + M.SelectorOffsets[Idx], 0);
8307 if (DeserializationListener)
8308 DeserializationListener->SelectorRead(ID, SelectorsLoaded[ID - 1]);
8311 return SelectorsLoaded[ID - 1];
8314 Selector ASTReader::GetExternalSelector(serialization::SelectorID ID) {
8315 return DecodeSelector(ID);
8318 uint32_t ASTReader::GetNumExternalSelectors() {
8319 // ID 0 (the null selector) is considered an external selector.
8320 return getTotalNumSelectors() + 1;
8323 serialization::SelectorID
8324 ASTReader::getGlobalSelectorID(ModuleFile &M, unsigned LocalID) const {
8325 if (LocalID < NUM_PREDEF_SELECTOR_IDS)
8328 if (!M.ModuleOffsetMap.empty())
8329 ReadModuleOffsetMap(M);
8331 ContinuousRangeMap<uint32_t, int, 2>::iterator I
8332 = M.SelectorRemap.find(LocalID - NUM_PREDEF_SELECTOR_IDS);
8333 assert(I != M.SelectorRemap.end()
8334 && "Invalid index into selector index remap");
8336 return LocalID + I->second;
8340 ASTReader::ReadDeclarationName(ModuleFile &F,
8341 const RecordData &Record, unsigned &Idx) {
8342 ASTContext &Context = getContext();
8343 DeclarationName::NameKind Kind = (DeclarationName::NameKind)Record[Idx++];
8345 case DeclarationName::Identifier:
8346 return DeclarationName(GetIdentifierInfo(F, Record, Idx));
8348 case DeclarationName::ObjCZeroArgSelector:
8349 case DeclarationName::ObjCOneArgSelector:
8350 case DeclarationName::ObjCMultiArgSelector:
8351 return DeclarationName(ReadSelector(F, Record, Idx));
8353 case DeclarationName::CXXConstructorName:
8354 return Context.DeclarationNames.getCXXConstructorName(
8355 Context.getCanonicalType(readType(F, Record, Idx)));
8357 case DeclarationName::CXXDestructorName:
8358 return Context.DeclarationNames.getCXXDestructorName(
8359 Context.getCanonicalType(readType(F, Record, Idx)));
8361 case DeclarationName::CXXDeductionGuideName:
8362 return Context.DeclarationNames.getCXXDeductionGuideName(
8363 ReadDeclAs<TemplateDecl>(F, Record, Idx));
8365 case DeclarationName::CXXConversionFunctionName:
8366 return Context.DeclarationNames.getCXXConversionFunctionName(
8367 Context.getCanonicalType(readType(F, Record, Idx)));
8369 case DeclarationName::CXXOperatorName:
8370 return Context.DeclarationNames.getCXXOperatorName(
8371 (OverloadedOperatorKind)Record[Idx++]);
8373 case DeclarationName::CXXLiteralOperatorName:
8374 return Context.DeclarationNames.getCXXLiteralOperatorName(
8375 GetIdentifierInfo(F, Record, Idx));
8377 case DeclarationName::CXXUsingDirective:
8378 return DeclarationName::getUsingDirectiveName();
8381 llvm_unreachable("Invalid NameKind!");
8384 void ASTReader::ReadDeclarationNameLoc(ModuleFile &F,
8385 DeclarationNameLoc &DNLoc,
8386 DeclarationName Name,
8387 const RecordData &Record, unsigned &Idx) {
8388 switch (Name.getNameKind()) {
8389 case DeclarationName::CXXConstructorName:
8390 case DeclarationName::CXXDestructorName:
8391 case DeclarationName::CXXConversionFunctionName:
8392 DNLoc.NamedType.TInfo = GetTypeSourceInfo(F, Record, Idx);
8395 case DeclarationName::CXXOperatorName:
8396 DNLoc.CXXOperatorName.BeginOpNameLoc
8397 = ReadSourceLocation(F, Record, Idx).getRawEncoding();
8398 DNLoc.CXXOperatorName.EndOpNameLoc
8399 = ReadSourceLocation(F, Record, Idx).getRawEncoding();
8402 case DeclarationName::CXXLiteralOperatorName:
8403 DNLoc.CXXLiteralOperatorName.OpNameLoc
8404 = ReadSourceLocation(F, Record, Idx).getRawEncoding();
8407 case DeclarationName::Identifier:
8408 case DeclarationName::ObjCZeroArgSelector:
8409 case DeclarationName::ObjCOneArgSelector:
8410 case DeclarationName::ObjCMultiArgSelector:
8411 case DeclarationName::CXXUsingDirective:
8412 case DeclarationName::CXXDeductionGuideName:
8417 void ASTReader::ReadDeclarationNameInfo(ModuleFile &F,
8418 DeclarationNameInfo &NameInfo,
8419 const RecordData &Record, unsigned &Idx) {
8420 NameInfo.setName(ReadDeclarationName(F, Record, Idx));
8421 NameInfo.setLoc(ReadSourceLocation(F, Record, Idx));
8422 DeclarationNameLoc DNLoc;
8423 ReadDeclarationNameLoc(F, DNLoc, NameInfo.getName(), Record, Idx);
8424 NameInfo.setInfo(DNLoc);
8427 void ASTReader::ReadQualifierInfo(ModuleFile &F, QualifierInfo &Info,
8428 const RecordData &Record, unsigned &Idx) {
8429 Info.QualifierLoc = ReadNestedNameSpecifierLoc(F, Record, Idx);
8430 unsigned NumTPLists = Record[Idx++];
8431 Info.NumTemplParamLists = NumTPLists;
8433 Info.TemplParamLists =
8434 new (getContext()) TemplateParameterList *[NumTPLists];
8435 for (unsigned i = 0; i != NumTPLists; ++i)
8436 Info.TemplParamLists[i] = ReadTemplateParameterList(F, Record, Idx);
8441 ASTReader::ReadTemplateName(ModuleFile &F, const RecordData &Record,
8443 ASTContext &Context = getContext();
8444 TemplateName::NameKind Kind = (TemplateName::NameKind)Record[Idx++];
8446 case TemplateName::Template:
8447 return TemplateName(ReadDeclAs<TemplateDecl>(F, Record, Idx));
8449 case TemplateName::OverloadedTemplate: {
8450 unsigned size = Record[Idx++];
8451 UnresolvedSet<8> Decls;
8453 Decls.addDecl(ReadDeclAs<NamedDecl>(F, Record, Idx));
8455 return Context.getOverloadedTemplateName(Decls.begin(), Decls.end());
8458 case TemplateName::QualifiedTemplate: {
8459 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(F, Record, Idx);
8460 bool hasTemplKeyword = Record[Idx++];
8461 TemplateDecl *Template = ReadDeclAs<TemplateDecl>(F, Record, Idx);
8462 return Context.getQualifiedTemplateName(NNS, hasTemplKeyword, Template);
8465 case TemplateName::DependentTemplate: {
8466 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(F, Record, Idx);
8467 if (Record[Idx++]) // isIdentifier
8468 return Context.getDependentTemplateName(NNS,
8469 GetIdentifierInfo(F, Record,
8471 return Context.getDependentTemplateName(NNS,
8472 (OverloadedOperatorKind)Record[Idx++]);
8475 case TemplateName::SubstTemplateTemplateParm: {
8476 TemplateTemplateParmDecl *param
8477 = ReadDeclAs<TemplateTemplateParmDecl>(F, Record, Idx);
8478 if (!param) return TemplateName();
8479 TemplateName replacement = ReadTemplateName(F, Record, Idx);
8480 return Context.getSubstTemplateTemplateParm(param, replacement);
8483 case TemplateName::SubstTemplateTemplateParmPack: {
8484 TemplateTemplateParmDecl *Param
8485 = ReadDeclAs<TemplateTemplateParmDecl>(F, Record, Idx);
8487 return TemplateName();
8489 TemplateArgument ArgPack = ReadTemplateArgument(F, Record, Idx);
8490 if (ArgPack.getKind() != TemplateArgument::Pack)
8491 return TemplateName();
8493 return Context.getSubstTemplateTemplateParmPack(Param, ArgPack);
8497 llvm_unreachable("Unhandled template name kind!");
8500 TemplateArgument ASTReader::ReadTemplateArgument(ModuleFile &F,
8501 const RecordData &Record,
8503 bool Canonicalize) {
8504 ASTContext &Context = getContext();
8506 // The caller wants a canonical template argument. Sometimes the AST only
8507 // wants template arguments in canonical form (particularly as the template
8508 // argument lists of template specializations) so ensure we preserve that
8509 // canonical form across serialization.
8510 TemplateArgument Arg = ReadTemplateArgument(F, Record, Idx, false);
8511 return Context.getCanonicalTemplateArgument(Arg);
8514 TemplateArgument::ArgKind Kind = (TemplateArgument::ArgKind)Record[Idx++];
8516 case TemplateArgument::Null:
8517 return TemplateArgument();
8518 case TemplateArgument::Type:
8519 return TemplateArgument(readType(F, Record, Idx));
8520 case TemplateArgument::Declaration: {
8521 ValueDecl *D = ReadDeclAs<ValueDecl>(F, Record, Idx);
8522 return TemplateArgument(D, readType(F, Record, Idx));
8524 case TemplateArgument::NullPtr:
8525 return TemplateArgument(readType(F, Record, Idx), /*isNullPtr*/true);
8526 case TemplateArgument::Integral: {
8527 llvm::APSInt Value = ReadAPSInt(Record, Idx);
8528 QualType T = readType(F, Record, Idx);
8529 return TemplateArgument(Context, Value, T);
8531 case TemplateArgument::Template:
8532 return TemplateArgument(ReadTemplateName(F, Record, Idx));
8533 case TemplateArgument::TemplateExpansion: {
8534 TemplateName Name = ReadTemplateName(F, Record, Idx);
8535 Optional<unsigned> NumTemplateExpansions;
8536 if (unsigned NumExpansions = Record[Idx++])
8537 NumTemplateExpansions = NumExpansions - 1;
8538 return TemplateArgument(Name, NumTemplateExpansions);
8540 case TemplateArgument::Expression:
8541 return TemplateArgument(ReadExpr(F));
8542 case TemplateArgument::Pack: {
8543 unsigned NumArgs = Record[Idx++];
8544 TemplateArgument *Args = new (Context) TemplateArgument[NumArgs];
8545 for (unsigned I = 0; I != NumArgs; ++I)
8546 Args[I] = ReadTemplateArgument(F, Record, Idx);
8547 return TemplateArgument(llvm::makeArrayRef(Args, NumArgs));
8551 llvm_unreachable("Unhandled template argument kind!");
8554 TemplateParameterList *
8555 ASTReader::ReadTemplateParameterList(ModuleFile &F,
8556 const RecordData &Record, unsigned &Idx) {
8557 SourceLocation TemplateLoc = ReadSourceLocation(F, Record, Idx);
8558 SourceLocation LAngleLoc = ReadSourceLocation(F, Record, Idx);
8559 SourceLocation RAngleLoc = ReadSourceLocation(F, Record, Idx);
8561 unsigned NumParams = Record[Idx++];
8562 SmallVector<NamedDecl *, 16> Params;
8563 Params.reserve(NumParams);
8565 Params.push_back(ReadDeclAs<NamedDecl>(F, Record, Idx));
8568 TemplateParameterList *TemplateParams = TemplateParameterList::Create(
8569 getContext(), TemplateLoc, LAngleLoc, Params, RAngleLoc, nullptr);
8570 return TemplateParams;
8575 ReadTemplateArgumentList(SmallVectorImpl<TemplateArgument> &TemplArgs,
8576 ModuleFile &F, const RecordData &Record,
8577 unsigned &Idx, bool Canonicalize) {
8578 unsigned NumTemplateArgs = Record[Idx++];
8579 TemplArgs.reserve(NumTemplateArgs);
8580 while (NumTemplateArgs--)
8581 TemplArgs.push_back(ReadTemplateArgument(F, Record, Idx, Canonicalize));
8584 /// \brief Read a UnresolvedSet structure.
8585 void ASTReader::ReadUnresolvedSet(ModuleFile &F, LazyASTUnresolvedSet &Set,
8586 const RecordData &Record, unsigned &Idx) {
8587 unsigned NumDecls = Record[Idx++];
8588 Set.reserve(getContext(), NumDecls);
8589 while (NumDecls--) {
8590 DeclID ID = ReadDeclID(F, Record, Idx);
8591 AccessSpecifier AS = (AccessSpecifier)Record[Idx++];
8592 Set.addLazyDecl(getContext(), ID, AS);
8597 ASTReader::ReadCXXBaseSpecifier(ModuleFile &F,
8598 const RecordData &Record, unsigned &Idx) {
8599 bool isVirtual = static_cast<bool>(Record[Idx++]);
8600 bool isBaseOfClass = static_cast<bool>(Record[Idx++]);
8601 AccessSpecifier AS = static_cast<AccessSpecifier>(Record[Idx++]);
8602 bool inheritConstructors = static_cast<bool>(Record[Idx++]);
8603 TypeSourceInfo *TInfo = GetTypeSourceInfo(F, Record, Idx);
8604 SourceRange Range = ReadSourceRange(F, Record, Idx);
8605 SourceLocation EllipsisLoc = ReadSourceLocation(F, Record, Idx);
8606 CXXBaseSpecifier Result(Range, isVirtual, isBaseOfClass, AS, TInfo,
8608 Result.setInheritConstructors(inheritConstructors);
8612 CXXCtorInitializer **
8613 ASTReader::ReadCXXCtorInitializers(ModuleFile &F, const RecordData &Record,
8615 ASTContext &Context = getContext();
8616 unsigned NumInitializers = Record[Idx++];
8617 assert(NumInitializers && "wrote ctor initializers but have no inits");
8618 auto **CtorInitializers = new (Context) CXXCtorInitializer*[NumInitializers];
8619 for (unsigned i = 0; i != NumInitializers; ++i) {
8620 TypeSourceInfo *TInfo = nullptr;
8621 bool IsBaseVirtual = false;
8622 FieldDecl *Member = nullptr;
8623 IndirectFieldDecl *IndirectMember = nullptr;
8625 CtorInitializerType Type = (CtorInitializerType)Record[Idx++];
8627 case CTOR_INITIALIZER_BASE:
8628 TInfo = GetTypeSourceInfo(F, Record, Idx);
8629 IsBaseVirtual = Record[Idx++];
8632 case CTOR_INITIALIZER_DELEGATING:
8633 TInfo = GetTypeSourceInfo(F, Record, Idx);
8636 case CTOR_INITIALIZER_MEMBER:
8637 Member = ReadDeclAs<FieldDecl>(F, Record, Idx);
8640 case CTOR_INITIALIZER_INDIRECT_MEMBER:
8641 IndirectMember = ReadDeclAs<IndirectFieldDecl>(F, Record, Idx);
8645 SourceLocation MemberOrEllipsisLoc = ReadSourceLocation(F, Record, Idx);
8646 Expr *Init = ReadExpr(F);
8647 SourceLocation LParenLoc = ReadSourceLocation(F, Record, Idx);
8648 SourceLocation RParenLoc = ReadSourceLocation(F, Record, Idx);
8650 CXXCtorInitializer *BOMInit;
8651 if (Type == CTOR_INITIALIZER_BASE)
8652 BOMInit = new (Context)
8653 CXXCtorInitializer(Context, TInfo, IsBaseVirtual, LParenLoc, Init,
8654 RParenLoc, MemberOrEllipsisLoc);
8655 else if (Type == CTOR_INITIALIZER_DELEGATING)
8656 BOMInit = new (Context)
8657 CXXCtorInitializer(Context, TInfo, LParenLoc, Init, RParenLoc);
8659 BOMInit = new (Context)
8660 CXXCtorInitializer(Context, Member, MemberOrEllipsisLoc, LParenLoc,
8663 BOMInit = new (Context)
8664 CXXCtorInitializer(Context, IndirectMember, MemberOrEllipsisLoc,
8665 LParenLoc, Init, RParenLoc);
8667 if (/*IsWritten*/Record[Idx++]) {
8668 unsigned SourceOrder = Record[Idx++];
8669 BOMInit->setSourceOrder(SourceOrder);
8672 CtorInitializers[i] = BOMInit;
8675 return CtorInitializers;
8678 NestedNameSpecifier *
8679 ASTReader::ReadNestedNameSpecifier(ModuleFile &F,
8680 const RecordData &Record, unsigned &Idx) {
8681 ASTContext &Context = getContext();
8682 unsigned N = Record[Idx++];
8683 NestedNameSpecifier *NNS = nullptr, *Prev = nullptr;
8684 for (unsigned I = 0; I != N; ++I) {
8685 NestedNameSpecifier::SpecifierKind Kind
8686 = (NestedNameSpecifier::SpecifierKind)Record[Idx++];
8688 case NestedNameSpecifier::Identifier: {
8689 IdentifierInfo *II = GetIdentifierInfo(F, Record, Idx);
8690 NNS = NestedNameSpecifier::Create(Context, Prev, II);
8694 case NestedNameSpecifier::Namespace: {
8695 NamespaceDecl *NS = ReadDeclAs<NamespaceDecl>(F, Record, Idx);
8696 NNS = NestedNameSpecifier::Create(Context, Prev, NS);
8700 case NestedNameSpecifier::NamespaceAlias: {
8701 NamespaceAliasDecl *Alias =ReadDeclAs<NamespaceAliasDecl>(F, Record, Idx);
8702 NNS = NestedNameSpecifier::Create(Context, Prev, Alias);
8706 case NestedNameSpecifier::TypeSpec:
8707 case NestedNameSpecifier::TypeSpecWithTemplate: {
8708 const Type *T = readType(F, Record, Idx).getTypePtrOrNull();
8712 bool Template = Record[Idx++];
8713 NNS = NestedNameSpecifier::Create(Context, Prev, Template, T);
8717 case NestedNameSpecifier::Global: {
8718 NNS = NestedNameSpecifier::GlobalSpecifier(Context);
8719 // No associated value, and there can't be a prefix.
8723 case NestedNameSpecifier::Super: {
8724 CXXRecordDecl *RD = ReadDeclAs<CXXRecordDecl>(F, Record, Idx);
8725 NNS = NestedNameSpecifier::SuperSpecifier(Context, RD);
8734 NestedNameSpecifierLoc
8735 ASTReader::ReadNestedNameSpecifierLoc(ModuleFile &F, const RecordData &Record,
8737 ASTContext &Context = getContext();
8738 unsigned N = Record[Idx++];
8739 NestedNameSpecifierLocBuilder Builder;
8740 for (unsigned I = 0; I != N; ++I) {
8741 NestedNameSpecifier::SpecifierKind Kind
8742 = (NestedNameSpecifier::SpecifierKind)Record[Idx++];
8744 case NestedNameSpecifier::Identifier: {
8745 IdentifierInfo *II = GetIdentifierInfo(F, Record, Idx);
8746 SourceRange Range = ReadSourceRange(F, Record, Idx);
8747 Builder.Extend(Context, II, Range.getBegin(), Range.getEnd());
8751 case NestedNameSpecifier::Namespace: {
8752 NamespaceDecl *NS = ReadDeclAs<NamespaceDecl>(F, Record, Idx);
8753 SourceRange Range = ReadSourceRange(F, Record, Idx);
8754 Builder.Extend(Context, NS, Range.getBegin(), Range.getEnd());
8758 case NestedNameSpecifier::NamespaceAlias: {
8759 NamespaceAliasDecl *Alias =ReadDeclAs<NamespaceAliasDecl>(F, Record, Idx);
8760 SourceRange Range = ReadSourceRange(F, Record, Idx);
8761 Builder.Extend(Context, Alias, Range.getBegin(), Range.getEnd());
8765 case NestedNameSpecifier::TypeSpec:
8766 case NestedNameSpecifier::TypeSpecWithTemplate: {
8767 bool Template = Record[Idx++];
8768 TypeSourceInfo *T = GetTypeSourceInfo(F, Record, Idx);
8770 return NestedNameSpecifierLoc();
8771 SourceLocation ColonColonLoc = ReadSourceLocation(F, Record, Idx);
8773 // FIXME: 'template' keyword location not saved anywhere, so we fake it.
8774 Builder.Extend(Context,
8775 Template? T->getTypeLoc().getBeginLoc() : SourceLocation(),
8776 T->getTypeLoc(), ColonColonLoc);
8780 case NestedNameSpecifier::Global: {
8781 SourceLocation ColonColonLoc = ReadSourceLocation(F, Record, Idx);
8782 Builder.MakeGlobal(Context, ColonColonLoc);
8786 case NestedNameSpecifier::Super: {
8787 CXXRecordDecl *RD = ReadDeclAs<CXXRecordDecl>(F, Record, Idx);
8788 SourceRange Range = ReadSourceRange(F, Record, Idx);
8789 Builder.MakeSuper(Context, RD, Range.getBegin(), Range.getEnd());
8795 return Builder.getWithLocInContext(Context);
8799 ASTReader::ReadSourceRange(ModuleFile &F, const RecordData &Record,
8801 SourceLocation beg = ReadSourceLocation(F, Record, Idx);
8802 SourceLocation end = ReadSourceLocation(F, Record, Idx);
8803 return SourceRange(beg, end);
8806 /// \brief Read an integral value
8807 llvm::APInt ASTReader::ReadAPInt(const RecordData &Record, unsigned &Idx) {
8808 unsigned BitWidth = Record[Idx++];
8809 unsigned NumWords = llvm::APInt::getNumWords(BitWidth);
8810 llvm::APInt Result(BitWidth, NumWords, &Record[Idx]);
8815 /// \brief Read a signed integral value
8816 llvm::APSInt ASTReader::ReadAPSInt(const RecordData &Record, unsigned &Idx) {
8817 bool isUnsigned = Record[Idx++];
8818 return llvm::APSInt(ReadAPInt(Record, Idx), isUnsigned);
8821 /// \brief Read a floating-point value
8822 llvm::APFloat ASTReader::ReadAPFloat(const RecordData &Record,
8823 const llvm::fltSemantics &Sem,
8825 return llvm::APFloat(Sem, ReadAPInt(Record, Idx));
8828 // \brief Read a string
8829 std::string ASTReader::ReadString(const RecordData &Record, unsigned &Idx) {
8830 unsigned Len = Record[Idx++];
8831 std::string Result(Record.data() + Idx, Record.data() + Idx + Len);
8836 std::string ASTReader::ReadPath(ModuleFile &F, const RecordData &Record,
8838 std::string Filename = ReadString(Record, Idx);
8839 ResolveImportedPath(F, Filename);
8843 VersionTuple ASTReader::ReadVersionTuple(const RecordData &Record,
8845 unsigned Major = Record[Idx++];
8846 unsigned Minor = Record[Idx++];
8847 unsigned Subminor = Record[Idx++];
8849 return VersionTuple(Major);
8851 return VersionTuple(Major, Minor - 1);
8852 return VersionTuple(Major, Minor - 1, Subminor - 1);
8855 CXXTemporary *ASTReader::ReadCXXTemporary(ModuleFile &F,
8856 const RecordData &Record,
8858 CXXDestructorDecl *Decl = ReadDeclAs<CXXDestructorDecl>(F, Record, Idx);
8859 return CXXTemporary::Create(getContext(), Decl);
8862 DiagnosticBuilder ASTReader::Diag(unsigned DiagID) const {
8863 return Diag(CurrentImportLoc, DiagID);
8866 DiagnosticBuilder ASTReader::Diag(SourceLocation Loc, unsigned DiagID) const {
8867 return Diags.Report(Loc, DiagID);
8870 /// \brief Retrieve the identifier table associated with the
8872 IdentifierTable &ASTReader::getIdentifierTable() {
8873 return PP.getIdentifierTable();
8876 /// \brief Record that the given ID maps to the given switch-case
8878 void ASTReader::RecordSwitchCaseID(SwitchCase *SC, unsigned ID) {
8879 assert((*CurrSwitchCaseStmts)[ID] == nullptr &&
8880 "Already have a SwitchCase with this ID");
8881 (*CurrSwitchCaseStmts)[ID] = SC;
8884 /// \brief Retrieve the switch-case statement with the given ID.
8885 SwitchCase *ASTReader::getSwitchCaseWithID(unsigned ID) {
8886 assert((*CurrSwitchCaseStmts)[ID] != nullptr && "No SwitchCase with this ID");
8887 return (*CurrSwitchCaseStmts)[ID];
8890 void ASTReader::ClearSwitchCaseIDs() {
8891 CurrSwitchCaseStmts->clear();
8894 void ASTReader::ReadComments() {
8895 ASTContext &Context = getContext();
8896 std::vector<RawComment *> Comments;
8897 for (SmallVectorImpl<std::pair<BitstreamCursor,
8898 serialization::ModuleFile *> >::iterator
8899 I = CommentsCursors.begin(),
8900 E = CommentsCursors.end();
8903 BitstreamCursor &Cursor = I->first;
8904 serialization::ModuleFile &F = *I->second;
8905 SavedStreamPosition SavedPosition(Cursor);
8909 llvm::BitstreamEntry Entry =
8910 Cursor.advanceSkippingSubblocks(BitstreamCursor::AF_DontPopBlockAtEnd);
8912 switch (Entry.Kind) {
8913 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
8914 case llvm::BitstreamEntry::Error:
8915 Error("malformed block record in AST file");
8917 case llvm::BitstreamEntry::EndBlock:
8919 case llvm::BitstreamEntry::Record:
8920 // The interesting case.
8926 switch ((CommentRecordTypes)Cursor.readRecord(Entry.ID, Record)) {
8927 case COMMENTS_RAW_COMMENT: {
8929 SourceRange SR = ReadSourceRange(F, Record, Idx);
8930 RawComment::CommentKind Kind =
8931 (RawComment::CommentKind) Record[Idx++];
8932 bool IsTrailingComment = Record[Idx++];
8933 bool IsAlmostTrailingComment = Record[Idx++];
8934 Comments.push_back(new (Context) RawComment(
8935 SR, Kind, IsTrailingComment, IsAlmostTrailingComment,
8936 Context.getLangOpts().CommentOpts.ParseAllComments));
8942 // De-serialized SourceLocations get negative FileIDs for other modules,
8943 // potentially invalidating the original order. Sort it again.
8944 std::sort(Comments.begin(), Comments.end(),
8945 BeforeThanCompare<RawComment>(SourceMgr));
8946 Context.Comments.addDeserializedComments(Comments);
8950 void ASTReader::visitInputFiles(serialization::ModuleFile &MF,
8951 bool IncludeSystem, bool Complain,
8952 llvm::function_ref<void(const serialization::InputFile &IF,
8953 bool isSystem)> Visitor) {
8954 unsigned NumUserInputs = MF.NumUserInputFiles;
8955 unsigned NumInputs = MF.InputFilesLoaded.size();
8956 assert(NumUserInputs <= NumInputs);
8957 unsigned N = IncludeSystem ? NumInputs : NumUserInputs;
8958 for (unsigned I = 0; I < N; ++I) {
8959 bool IsSystem = I >= NumUserInputs;
8960 InputFile IF = getInputFile(MF, I+1, Complain);
8961 Visitor(IF, IsSystem);
8965 void ASTReader::visitTopLevelModuleMaps(
8966 serialization::ModuleFile &MF,
8967 llvm::function_ref<void(const FileEntry *FE)> Visitor) {
8968 unsigned NumInputs = MF.InputFilesLoaded.size();
8969 for (unsigned I = 0; I < NumInputs; ++I) {
8970 InputFileInfo IFI = readInputFileInfo(MF, I + 1);
8971 if (IFI.TopLevelModuleMap)
8972 // FIXME: This unnecessarily re-reads the InputFileInfo.
8973 if (auto *FE = getInputFile(MF, I + 1).getFile())
8978 std::string ASTReader::getOwningModuleNameForDiagnostic(const Decl *D) {
8979 // If we know the owning module, use it.
8980 if (Module *M = D->getImportedOwningModule())
8981 return M->getFullModuleName();
8983 // Otherwise, use the name of the top-level module the decl is within.
8984 if (ModuleFile *M = getOwningModuleFile(D))
8985 return M->ModuleName;
8987 // Not from a module.
8991 void ASTReader::finishPendingActions() {
8992 while (!PendingIdentifierInfos.empty() ||
8993 !PendingIncompleteDeclChains.empty() || !PendingDeclChains.empty() ||
8994 !PendingMacroIDs.empty() || !PendingDeclContextInfos.empty() ||
8995 !PendingUpdateRecords.empty()) {
8996 // If any identifiers with corresponding top-level declarations have
8997 // been loaded, load those declarations now.
8998 typedef llvm::DenseMap<IdentifierInfo *, SmallVector<Decl *, 2> >
9000 TopLevelDeclsMap TopLevelDecls;
9002 while (!PendingIdentifierInfos.empty()) {
9003 IdentifierInfo *II = PendingIdentifierInfos.back().first;
9004 SmallVector<uint32_t, 4> DeclIDs =
9005 std::move(PendingIdentifierInfos.back().second);
9006 PendingIdentifierInfos.pop_back();
9008 SetGloballyVisibleDecls(II, DeclIDs, &TopLevelDecls[II]);
9011 // For each decl chain that we wanted to complete while deserializing, mark
9012 // it as "still needs to be completed".
9013 for (unsigned I = 0; I != PendingIncompleteDeclChains.size(); ++I) {
9014 markIncompleteDeclChain(PendingIncompleteDeclChains[I]);
9016 PendingIncompleteDeclChains.clear();
9018 // Load pending declaration chains.
9019 for (unsigned I = 0; I != PendingDeclChains.size(); ++I)
9020 loadPendingDeclChain(PendingDeclChains[I].first, PendingDeclChains[I].second);
9021 PendingDeclChains.clear();
9023 // Make the most recent of the top-level declarations visible.
9024 for (TopLevelDeclsMap::iterator TLD = TopLevelDecls.begin(),
9025 TLDEnd = TopLevelDecls.end(); TLD != TLDEnd; ++TLD) {
9026 IdentifierInfo *II = TLD->first;
9027 for (unsigned I = 0, N = TLD->second.size(); I != N; ++I) {
9028 pushExternalDeclIntoScope(cast<NamedDecl>(TLD->second[I]), II);
9032 // Load any pending macro definitions.
9033 for (unsigned I = 0; I != PendingMacroIDs.size(); ++I) {
9034 IdentifierInfo *II = PendingMacroIDs.begin()[I].first;
9035 SmallVector<PendingMacroInfo, 2> GlobalIDs;
9036 GlobalIDs.swap(PendingMacroIDs.begin()[I].second);
9037 // Initialize the macro history from chained-PCHs ahead of module imports.
9038 for (unsigned IDIdx = 0, NumIDs = GlobalIDs.size(); IDIdx != NumIDs;
9040 const PendingMacroInfo &Info = GlobalIDs[IDIdx];
9041 if (!Info.M->isModule())
9042 resolvePendingMacro(II, Info);
9044 // Handle module imports.
9045 for (unsigned IDIdx = 0, NumIDs = GlobalIDs.size(); IDIdx != NumIDs;
9047 const PendingMacroInfo &Info = GlobalIDs[IDIdx];
9048 if (Info.M->isModule())
9049 resolvePendingMacro(II, Info);
9052 PendingMacroIDs.clear();
9054 // Wire up the DeclContexts for Decls that we delayed setting until
9055 // recursive loading is completed.
9056 while (!PendingDeclContextInfos.empty()) {
9057 PendingDeclContextInfo Info = PendingDeclContextInfos.front();
9058 PendingDeclContextInfos.pop_front();
9059 DeclContext *SemaDC = cast<DeclContext>(GetDecl(Info.SemaDC));
9060 DeclContext *LexicalDC = cast<DeclContext>(GetDecl(Info.LexicalDC));
9061 Info.D->setDeclContextsImpl(SemaDC, LexicalDC, getContext());
9064 // Perform any pending declaration updates.
9065 while (!PendingUpdateRecords.empty()) {
9066 auto Update = PendingUpdateRecords.pop_back_val();
9067 ReadingKindTracker ReadingKind(Read_Decl, *this);
9068 loadDeclUpdateRecords(Update);
9072 // At this point, all update records for loaded decls are in place, so any
9073 // fake class definitions should have become real.
9074 assert(PendingFakeDefinitionData.empty() &&
9075 "faked up a class definition but never saw the real one");
9077 // If we deserialized any C++ or Objective-C class definitions, any
9078 // Objective-C protocol definitions, or any redeclarable templates, make sure
9079 // that all redeclarations point to the definitions. Note that this can only
9080 // happen now, after the redeclaration chains have been fully wired.
9081 for (Decl *D : PendingDefinitions) {
9082 if (TagDecl *TD = dyn_cast<TagDecl>(D)) {
9083 if (const TagType *TagT = dyn_cast<TagType>(TD->getTypeForDecl())) {
9084 // Make sure that the TagType points at the definition.
9085 const_cast<TagType*>(TagT)->decl = TD;
9088 if (auto RD = dyn_cast<CXXRecordDecl>(D)) {
9089 for (auto *R = getMostRecentExistingDecl(RD); R;
9090 R = R->getPreviousDecl()) {
9092 cast<CXXRecordDecl>(R)->isThisDeclarationADefinition() &&
9093 "declaration thinks it's the definition but it isn't");
9094 cast<CXXRecordDecl>(R)->DefinitionData = RD->DefinitionData;
9101 if (auto ID = dyn_cast<ObjCInterfaceDecl>(D)) {
9102 // Make sure that the ObjCInterfaceType points at the definition.
9103 const_cast<ObjCInterfaceType *>(cast<ObjCInterfaceType>(ID->TypeForDecl))
9106 for (auto *R = getMostRecentExistingDecl(ID); R; R = R->getPreviousDecl())
9107 cast<ObjCInterfaceDecl>(R)->Data = ID->Data;
9112 if (auto PD = dyn_cast<ObjCProtocolDecl>(D)) {
9113 for (auto *R = getMostRecentExistingDecl(PD); R; R = R->getPreviousDecl())
9114 cast<ObjCProtocolDecl>(R)->Data = PD->Data;
9119 auto RTD = cast<RedeclarableTemplateDecl>(D)->getCanonicalDecl();
9120 for (auto *R = getMostRecentExistingDecl(RTD); R; R = R->getPreviousDecl())
9121 cast<RedeclarableTemplateDecl>(R)->Common = RTD->Common;
9123 PendingDefinitions.clear();
9125 // Load the bodies of any functions or methods we've encountered. We do
9126 // this now (delayed) so that we can be sure that the declaration chains
9127 // have been fully wired up (hasBody relies on this).
9128 // FIXME: We shouldn't require complete redeclaration chains here.
9129 for (PendingBodiesMap::iterator PB = PendingBodies.begin(),
9130 PBEnd = PendingBodies.end();
9131 PB != PBEnd; ++PB) {
9132 if (FunctionDecl *FD = dyn_cast<FunctionDecl>(PB->first)) {
9133 // FIXME: Check for =delete/=default?
9134 // FIXME: Complain about ODR violations here?
9135 const FunctionDecl *Defn = nullptr;
9136 if (!getContext().getLangOpts().Modules || !FD->hasBody(Defn)) {
9137 FD->setLazyBody(PB->second);
9139 mergeDefinitionVisibility(const_cast<FunctionDecl*>(Defn), FD);
9143 ObjCMethodDecl *MD = cast<ObjCMethodDecl>(PB->first);
9144 if (!getContext().getLangOpts().Modules || !MD->hasBody())
9145 MD->setLazyBody(PB->second);
9147 PendingBodies.clear();
9150 for (auto *ND : PendingMergedDefinitionsToDeduplicate)
9151 getContext().deduplicateMergedDefinitonsFor(ND);
9152 PendingMergedDefinitionsToDeduplicate.clear();
9155 void ASTReader::diagnoseOdrViolations() {
9156 if (PendingOdrMergeFailures.empty() && PendingOdrMergeChecks.empty())
9159 // Trigger the import of the full definition of each class that had any
9160 // odr-merging problems, so we can produce better diagnostics for them.
9161 // These updates may in turn find and diagnose some ODR failures, so take
9162 // ownership of the set first.
9163 auto OdrMergeFailures = std::move(PendingOdrMergeFailures);
9164 PendingOdrMergeFailures.clear();
9165 for (auto &Merge : OdrMergeFailures) {
9166 Merge.first->buildLookup();
9167 Merge.first->decls_begin();
9168 Merge.first->bases_begin();
9169 Merge.first->vbases_begin();
9170 for (auto *RD : Merge.second) {
9177 // For each declaration from a merged context, check that the canonical
9178 // definition of that context also contains a declaration of the same
9181 // Caution: this loop does things that might invalidate iterators into
9182 // PendingOdrMergeChecks. Don't turn this into a range-based for loop!
9183 while (!PendingOdrMergeChecks.empty()) {
9184 NamedDecl *D = PendingOdrMergeChecks.pop_back_val();
9186 // FIXME: Skip over implicit declarations for now. This matters for things
9187 // like implicitly-declared special member functions. This isn't entirely
9188 // correct; we can end up with multiple unmerged declarations of the same
9190 if (D->isImplicit())
9193 DeclContext *CanonDef = D->getDeclContext();
9196 const Decl *DCanon = D->getCanonicalDecl();
9198 for (auto RI : D->redecls()) {
9199 if (RI->getLexicalDeclContext() == CanonDef) {
9207 // Quick check failed, time to do the slow thing. Note, we can't just
9208 // look up the name of D in CanonDef here, because the member that is
9209 // in CanonDef might not be found by name lookup (it might have been
9210 // replaced by a more recent declaration in the lookup table), and we
9211 // can't necessarily find it in the redeclaration chain because it might
9212 // be merely mergeable, not redeclarable.
9213 llvm::SmallVector<const NamedDecl*, 4> Candidates;
9214 for (auto *CanonMember : CanonDef->decls()) {
9215 if (CanonMember->getCanonicalDecl() == DCanon) {
9216 // This can happen if the declaration is merely mergeable and not
9217 // actually redeclarable (we looked for redeclarations earlier).
9219 // FIXME: We should be able to detect this more efficiently, without
9220 // pulling in all of the members of CanonDef.
9224 if (auto *ND = dyn_cast<NamedDecl>(CanonMember))
9225 if (ND->getDeclName() == D->getDeclName())
9226 Candidates.push_back(ND);
9230 // The AST doesn't like TagDecls becoming invalid after they've been
9231 // completed. We only really need to mark FieldDecls as invalid here.
9232 if (!isa<TagDecl>(D))
9233 D->setInvalidDecl();
9235 // Ensure we don't accidentally recursively enter deserialization while
9236 // we're producing our diagnostic.
9237 Deserializing RecursionGuard(this);
9239 std::string CanonDefModule =
9240 getOwningModuleNameForDiagnostic(cast<Decl>(CanonDef));
9241 Diag(D->getLocation(), diag::err_module_odr_violation_missing_decl)
9242 << D << getOwningModuleNameForDiagnostic(D)
9243 << CanonDef << CanonDefModule.empty() << CanonDefModule;
9245 if (Candidates.empty())
9246 Diag(cast<Decl>(CanonDef)->getLocation(),
9247 diag::note_module_odr_violation_no_possible_decls) << D;
9249 for (unsigned I = 0, N = Candidates.size(); I != N; ++I)
9250 Diag(Candidates[I]->getLocation(),
9251 diag::note_module_odr_violation_possible_decl)
9255 DiagnosedOdrMergeFailures.insert(CanonDef);
9259 if (OdrMergeFailures.empty())
9262 // Ensure we don't accidentally recursively enter deserialization while
9263 // we're producing our diagnostics.
9264 Deserializing RecursionGuard(this);
9266 // Issue any pending ODR-failure diagnostics.
9267 for (auto &Merge : OdrMergeFailures) {
9268 // If we've already pointed out a specific problem with this class, don't
9269 // bother issuing a general "something's different" diagnostic.
9270 if (!DiagnosedOdrMergeFailures.insert(Merge.first).second)
9273 bool Diagnosed = false;
9274 CXXRecordDecl *FirstRecord = Merge.first;
9275 std::string FirstModule = getOwningModuleNameForDiagnostic(FirstRecord);
9276 for (CXXRecordDecl *SecondRecord : Merge.second) {
9277 // Multiple different declarations got merged together; tell the user
9278 // where they came from.
9279 if (FirstRecord == SecondRecord)
9282 std::string SecondModule = getOwningModuleNameForDiagnostic(SecondRecord);
9283 using DeclHashes = llvm::SmallVector<std::pair<Decl *, unsigned>, 4>;
9284 DeclHashes FirstHashes;
9285 DeclHashes SecondHashes;
9288 auto PopulateHashes = [&Hash, FirstRecord](DeclHashes &Hashes,
9289 CXXRecordDecl *Record) {
9290 for (auto *D : Record->decls()) {
9291 // Due to decl merging, the first CXXRecordDecl is the parent of
9292 // Decls in both records.
9293 if (!ODRHash::isWhitelistedDecl(D, FirstRecord))
9297 Hashes.emplace_back(D, Hash.CalculateHash());
9300 PopulateHashes(FirstHashes, FirstRecord);
9301 PopulateHashes(SecondHashes, SecondRecord);
9303 // Used with err_module_odr_violation_mismatch_decl and
9304 // note_module_odr_violation_mismatch_decl
9305 // This list should be the same Decl's as in ODRHash::isWhiteListedDecl
9319 } FirstDiffType = Other,
9320 SecondDiffType = Other;
9322 auto DifferenceSelector = [](Decl *D) {
9323 assert(D && "valid Decl required");
9324 switch (D->getKind()) {
9327 case Decl::AccessSpec:
9328 switch (D->getAccess()) {
9330 return PublicSpecifer;
9332 return PrivateSpecifer;
9334 return ProtectedSpecifer;
9338 llvm_unreachable("Invalid access specifier");
9339 case Decl::StaticAssert:
9340 return StaticAssert;
9343 case Decl::CXXMethod:
9344 case Decl::CXXConstructor:
9345 case Decl::CXXDestructor:
9347 case Decl::TypeAlias:
9358 Decl *FirstDecl = nullptr;
9359 Decl *SecondDecl = nullptr;
9360 auto FirstIt = FirstHashes.begin();
9361 auto SecondIt = SecondHashes.begin();
9363 // If there is a diagnoseable difference, FirstDiffType and
9364 // SecondDiffType will not be Other and FirstDecl and SecondDecl will be
9365 // filled in if not EndOfClass.
9366 while (FirstIt != FirstHashes.end() || SecondIt != SecondHashes.end()) {
9367 if (FirstIt != FirstHashes.end() && SecondIt != SecondHashes.end() &&
9368 FirstIt->second == SecondIt->second) {
9374 FirstDecl = FirstIt == FirstHashes.end() ? nullptr : FirstIt->first;
9375 SecondDecl = SecondIt == SecondHashes.end() ? nullptr : SecondIt->first;
9377 FirstDiffType = FirstDecl ? DifferenceSelector(FirstDecl) : EndOfClass;
9379 SecondDecl ? DifferenceSelector(SecondDecl) : EndOfClass;
9384 if (FirstDiffType == Other || SecondDiffType == Other) {
9385 // Reaching this point means an unexpected Decl was encountered
9386 // or no difference was detected. This causes a generic error
9387 // message to be emitted.
9388 Diag(FirstRecord->getLocation(),
9389 diag::err_module_odr_violation_different_definitions)
9390 << FirstRecord << FirstModule.empty() << FirstModule;
9393 Diag(FirstDecl->getLocation(), diag::note_first_module_difference)
9394 << FirstRecord << FirstDecl->getSourceRange();
9397 Diag(SecondRecord->getLocation(),
9398 diag::note_module_odr_violation_different_definitions)
9402 Diag(SecondDecl->getLocation(), diag::note_second_module_difference)
9403 << SecondDecl->getSourceRange();
9410 if (FirstDiffType != SecondDiffType) {
9411 SourceLocation FirstLoc;
9412 SourceRange FirstRange;
9413 if (FirstDiffType == EndOfClass) {
9414 FirstLoc = FirstRecord->getBraceRange().getEnd();
9416 FirstLoc = FirstIt->first->getLocation();
9417 FirstRange = FirstIt->first->getSourceRange();
9419 Diag(FirstLoc, diag::err_module_odr_violation_mismatch_decl)
9420 << FirstRecord << FirstModule.empty() << FirstModule << FirstRange
9423 SourceLocation SecondLoc;
9424 SourceRange SecondRange;
9425 if (SecondDiffType == EndOfClass) {
9426 SecondLoc = SecondRecord->getBraceRange().getEnd();
9428 SecondLoc = SecondDecl->getLocation();
9429 SecondRange = SecondDecl->getSourceRange();
9431 Diag(SecondLoc, diag::note_module_odr_violation_mismatch_decl)
9432 << SecondModule << SecondRange << SecondDiffType;
9437 assert(FirstDiffType == SecondDiffType);
9439 // Used with err_module_odr_violation_mismatch_decl_diff and
9440 // note_module_odr_violation_mismatch_decl_diff
9441 enum ODRDeclDifference{
9442 StaticAssertCondition,
9443 StaticAssertMessage,
9444 StaticAssertOnlyMessage,
9447 FieldSingleBitField,
9448 FieldDifferentWidthBitField,
9450 FieldSingleInitializer,
9451 FieldDifferentInitializers,
9459 MethodNumberParameters,
9460 MethodParameterType,
9461 MethodParameterName,
9462 MethodParameterSingleDefaultArgument,
9463 MethodParameterDifferentDefaultArgument,
9468 VarSingleInitializer,
9469 VarDifferentInitializer,
9476 // These lambdas have the common portions of the ODR diagnostics. This
9477 // has the same return as Diag(), so addition parameters can be passed
9478 // in with operator<<
9479 auto ODRDiagError = [FirstRecord, &FirstModule, this](
9480 SourceLocation Loc, SourceRange Range, ODRDeclDifference DiffType) {
9481 return Diag(Loc, diag::err_module_odr_violation_mismatch_decl_diff)
9482 << FirstRecord << FirstModule.empty() << FirstModule << Range
9485 auto ODRDiagNote = [&SecondModule, this](
9486 SourceLocation Loc, SourceRange Range, ODRDeclDifference DiffType) {
9487 return Diag(Loc, diag::note_module_odr_violation_mismatch_decl_diff)
9488 << SecondModule << Range << DiffType;
9491 auto ComputeODRHash = [&Hash](const Stmt* S) {
9495 return Hash.CalculateHash();
9498 auto ComputeQualTypeODRHash = [&Hash](QualType Ty) {
9500 Hash.AddQualType(Ty);
9501 return Hash.CalculateHash();
9504 switch (FirstDiffType) {
9507 case PublicSpecifer:
9508 case PrivateSpecifer:
9509 case ProtectedSpecifer:
9510 llvm_unreachable("Invalid diff type");
9512 case StaticAssert: {
9513 StaticAssertDecl *FirstSA = cast<StaticAssertDecl>(FirstDecl);
9514 StaticAssertDecl *SecondSA = cast<StaticAssertDecl>(SecondDecl);
9516 Expr *FirstExpr = FirstSA->getAssertExpr();
9517 Expr *SecondExpr = SecondSA->getAssertExpr();
9518 unsigned FirstODRHash = ComputeODRHash(FirstExpr);
9519 unsigned SecondODRHash = ComputeODRHash(SecondExpr);
9520 if (FirstODRHash != SecondODRHash) {
9521 ODRDiagError(FirstExpr->getLocStart(), FirstExpr->getSourceRange(),
9522 StaticAssertCondition);
9523 ODRDiagNote(SecondExpr->getLocStart(),
9524 SecondExpr->getSourceRange(), StaticAssertCondition);
9529 StringLiteral *FirstStr = FirstSA->getMessage();
9530 StringLiteral *SecondStr = SecondSA->getMessage();
9531 assert((FirstStr || SecondStr) && "Both messages cannot be empty");
9532 if ((FirstStr && !SecondStr) || (!FirstStr && SecondStr)) {
9533 SourceLocation FirstLoc, SecondLoc;
9534 SourceRange FirstRange, SecondRange;
9536 FirstLoc = FirstStr->getLocStart();
9537 FirstRange = FirstStr->getSourceRange();
9539 FirstLoc = FirstSA->getLocStart();
9540 FirstRange = FirstSA->getSourceRange();
9543 SecondLoc = SecondStr->getLocStart();
9544 SecondRange = SecondStr->getSourceRange();
9546 SecondLoc = SecondSA->getLocStart();
9547 SecondRange = SecondSA->getSourceRange();
9549 ODRDiagError(FirstLoc, FirstRange, StaticAssertOnlyMessage)
9550 << (FirstStr == nullptr);
9551 ODRDiagNote(SecondLoc, SecondRange, StaticAssertOnlyMessage)
9552 << (SecondStr == nullptr);
9557 if (FirstStr && SecondStr &&
9558 FirstStr->getString() != SecondStr->getString()) {
9559 ODRDiagError(FirstStr->getLocStart(), FirstStr->getSourceRange(),
9560 StaticAssertMessage);
9561 ODRDiagNote(SecondStr->getLocStart(), SecondStr->getSourceRange(),
9562 StaticAssertMessage);
9569 FieldDecl *FirstField = cast<FieldDecl>(FirstDecl);
9570 FieldDecl *SecondField = cast<FieldDecl>(SecondDecl);
9571 IdentifierInfo *FirstII = FirstField->getIdentifier();
9572 IdentifierInfo *SecondII = SecondField->getIdentifier();
9573 if (FirstII->getName() != SecondII->getName()) {
9574 ODRDiagError(FirstField->getLocation(), FirstField->getSourceRange(),
9577 ODRDiagNote(SecondField->getLocation(), SecondField->getSourceRange(),
9585 assert(getContext().hasSameType(FirstField->getType(),
9586 SecondField->getType()));
9588 QualType FirstType = FirstField->getType();
9589 QualType SecondType = SecondField->getType();
9590 if (ComputeQualTypeODRHash(FirstType) !=
9591 ComputeQualTypeODRHash(SecondType)) {
9592 ODRDiagError(FirstField->getLocation(), FirstField->getSourceRange(),
9594 << FirstII << FirstType;
9595 ODRDiagNote(SecondField->getLocation(), SecondField->getSourceRange(),
9597 << SecondII << SecondType;
9603 const bool IsFirstBitField = FirstField->isBitField();
9604 const bool IsSecondBitField = SecondField->isBitField();
9605 if (IsFirstBitField != IsSecondBitField) {
9606 ODRDiagError(FirstField->getLocation(), FirstField->getSourceRange(),
9607 FieldSingleBitField)
9608 << FirstII << IsFirstBitField;
9609 ODRDiagNote(SecondField->getLocation(), SecondField->getSourceRange(),
9610 FieldSingleBitField)
9611 << SecondII << IsSecondBitField;
9616 if (IsFirstBitField && IsSecondBitField) {
9617 ODRDiagError(FirstField->getLocation(), FirstField->getSourceRange(),
9618 FieldDifferentWidthBitField)
9619 << FirstII << FirstField->getBitWidth()->getSourceRange();
9620 ODRDiagNote(SecondField->getLocation(), SecondField->getSourceRange(),
9621 FieldDifferentWidthBitField)
9622 << SecondII << SecondField->getBitWidth()->getSourceRange();
9627 const bool IsFirstMutable = FirstField->isMutable();
9628 const bool IsSecondMutable = SecondField->isMutable();
9629 if (IsFirstMutable != IsSecondMutable) {
9630 ODRDiagError(FirstField->getLocation(), FirstField->getSourceRange(),
9632 << FirstII << IsFirstMutable;
9633 ODRDiagNote(SecondField->getLocation(), SecondField->getSourceRange(),
9635 << SecondII << IsSecondMutable;
9640 const Expr *FirstInitializer = FirstField->getInClassInitializer();
9641 const Expr *SecondInitializer = SecondField->getInClassInitializer();
9642 if ((!FirstInitializer && SecondInitializer) ||
9643 (FirstInitializer && !SecondInitializer)) {
9644 ODRDiagError(FirstField->getLocation(), FirstField->getSourceRange(),
9645 FieldSingleInitializer)
9646 << FirstII << (FirstInitializer != nullptr);
9647 ODRDiagNote(SecondField->getLocation(), SecondField->getSourceRange(),
9648 FieldSingleInitializer)
9649 << SecondII << (SecondInitializer != nullptr);
9654 if (FirstInitializer && SecondInitializer) {
9655 unsigned FirstInitHash = ComputeODRHash(FirstInitializer);
9656 unsigned SecondInitHash = ComputeODRHash(SecondInitializer);
9657 if (FirstInitHash != SecondInitHash) {
9658 ODRDiagError(FirstField->getLocation(),
9659 FirstField->getSourceRange(),
9660 FieldDifferentInitializers)
9661 << FirstII << FirstInitializer->getSourceRange();
9662 ODRDiagNote(SecondField->getLocation(),
9663 SecondField->getSourceRange(),
9664 FieldDifferentInitializers)
9665 << SecondII << SecondInitializer->getSourceRange();
9680 auto GetMethodTypeForDiagnostics = [](const CXXMethodDecl* D) {
9681 if (isa<CXXConstructorDecl>(D)) return DiagConstructor;
9682 if (isa<CXXDestructorDecl>(D)) return DiagDestructor;
9685 const CXXMethodDecl *FirstMethod = cast<CXXMethodDecl>(FirstDecl);
9686 const CXXMethodDecl *SecondMethod = cast<CXXMethodDecl>(SecondDecl);
9687 FirstMethodType = GetMethodTypeForDiagnostics(FirstMethod);
9688 SecondMethodType = GetMethodTypeForDiagnostics(SecondMethod);
9689 auto FirstName = FirstMethod->getDeclName();
9690 auto SecondName = SecondMethod->getDeclName();
9691 if (FirstMethodType != SecondMethodType || FirstName != SecondName) {
9692 ODRDiagError(FirstMethod->getLocation(),
9693 FirstMethod->getSourceRange(), MethodName)
9694 << FirstMethodType << FirstName;
9695 ODRDiagNote(SecondMethod->getLocation(),
9696 SecondMethod->getSourceRange(), MethodName)
9697 << SecondMethodType << SecondName;
9703 const bool FirstDeleted = FirstMethod->isDeleted();
9704 const bool SecondDeleted = SecondMethod->isDeleted();
9705 if (FirstDeleted != SecondDeleted) {
9706 ODRDiagError(FirstMethod->getLocation(),
9707 FirstMethod->getSourceRange(), MethodDeleted)
9708 << FirstMethodType << FirstName << FirstDeleted;
9710 ODRDiagNote(SecondMethod->getLocation(),
9711 SecondMethod->getSourceRange(), MethodDeleted)
9712 << SecondMethodType << SecondName << SecondDeleted;
9717 const bool FirstVirtual = FirstMethod->isVirtualAsWritten();
9718 const bool SecondVirtual = SecondMethod->isVirtualAsWritten();
9719 const bool FirstPure = FirstMethod->isPure();
9720 const bool SecondPure = SecondMethod->isPure();
9721 if ((FirstVirtual || SecondVirtual) &&
9722 (FirstVirtual != SecondVirtual || FirstPure != SecondPure)) {
9723 ODRDiagError(FirstMethod->getLocation(),
9724 FirstMethod->getSourceRange(), MethodVirtual)
9725 << FirstMethodType << FirstName << FirstPure << FirstVirtual;
9726 ODRDiagNote(SecondMethod->getLocation(),
9727 SecondMethod->getSourceRange(), MethodVirtual)
9728 << SecondMethodType << SecondName << SecondPure << SecondVirtual;
9733 // CXXMethodDecl::isStatic uses the canonical Decl. With Decl merging,
9734 // FirstDecl is the canonical Decl of SecondDecl, so the storage
9735 // class needs to be checked instead.
9736 const auto FirstStorage = FirstMethod->getStorageClass();
9737 const auto SecondStorage = SecondMethod->getStorageClass();
9738 const bool FirstStatic = FirstStorage == SC_Static;
9739 const bool SecondStatic = SecondStorage == SC_Static;
9740 if (FirstStatic != SecondStatic) {
9741 ODRDiagError(FirstMethod->getLocation(),
9742 FirstMethod->getSourceRange(), MethodStatic)
9743 << FirstMethodType << FirstName << FirstStatic;
9744 ODRDiagNote(SecondMethod->getLocation(),
9745 SecondMethod->getSourceRange(), MethodStatic)
9746 << SecondMethodType << SecondName << SecondStatic;
9751 const bool FirstVolatile = FirstMethod->isVolatile();
9752 const bool SecondVolatile = SecondMethod->isVolatile();
9753 if (FirstVolatile != SecondVolatile) {
9754 ODRDiagError(FirstMethod->getLocation(),
9755 FirstMethod->getSourceRange(), MethodVolatile)
9756 << FirstMethodType << FirstName << FirstVolatile;
9757 ODRDiagNote(SecondMethod->getLocation(),
9758 SecondMethod->getSourceRange(), MethodVolatile)
9759 << SecondMethodType << SecondName << SecondVolatile;
9764 const bool FirstConst = FirstMethod->isConst();
9765 const bool SecondConst = SecondMethod->isConst();
9766 if (FirstConst != SecondConst) {
9767 ODRDiagError(FirstMethod->getLocation(),
9768 FirstMethod->getSourceRange(), MethodConst)
9769 << FirstMethodType << FirstName << FirstConst;
9770 ODRDiagNote(SecondMethod->getLocation(),
9771 SecondMethod->getSourceRange(), MethodConst)
9772 << SecondMethodType << SecondName << SecondConst;
9777 const bool FirstInline = FirstMethod->isInlineSpecified();
9778 const bool SecondInline = SecondMethod->isInlineSpecified();
9779 if (FirstInline != SecondInline) {
9780 ODRDiagError(FirstMethod->getLocation(),
9781 FirstMethod->getSourceRange(), MethodInline)
9782 << FirstMethodType << FirstName << FirstInline;
9783 ODRDiagNote(SecondMethod->getLocation(),
9784 SecondMethod->getSourceRange(), MethodInline)
9785 << SecondMethodType << SecondName << SecondInline;
9790 const unsigned FirstNumParameters = FirstMethod->param_size();
9791 const unsigned SecondNumParameters = SecondMethod->param_size();
9792 if (FirstNumParameters != SecondNumParameters) {
9793 ODRDiagError(FirstMethod->getLocation(),
9794 FirstMethod->getSourceRange(), MethodNumberParameters)
9795 << FirstMethodType << FirstName << FirstNumParameters;
9796 ODRDiagNote(SecondMethod->getLocation(),
9797 SecondMethod->getSourceRange(), MethodNumberParameters)
9798 << SecondMethodType << SecondName << SecondNumParameters;
9803 // Need this status boolean to know when break out of the switch.
9804 bool ParameterMismatch = false;
9805 for (unsigned I = 0; I < FirstNumParameters; ++I) {
9806 const ParmVarDecl *FirstParam = FirstMethod->getParamDecl(I);
9807 const ParmVarDecl *SecondParam = SecondMethod->getParamDecl(I);
9809 QualType FirstParamType = FirstParam->getType();
9810 QualType SecondParamType = SecondParam->getType();
9811 if (FirstParamType != SecondParamType &&
9812 ComputeQualTypeODRHash(FirstParamType) !=
9813 ComputeQualTypeODRHash(SecondParamType)) {
9814 if (const DecayedType *ParamDecayedType =
9815 FirstParamType->getAs<DecayedType>()) {
9816 ODRDiagError(FirstMethod->getLocation(),
9817 FirstMethod->getSourceRange(), MethodParameterType)
9818 << FirstMethodType << FirstName << (I + 1) << FirstParamType
9819 << true << ParamDecayedType->getOriginalType();
9821 ODRDiagError(FirstMethod->getLocation(),
9822 FirstMethod->getSourceRange(), MethodParameterType)
9823 << FirstMethodType << FirstName << (I + 1) << FirstParamType
9827 if (const DecayedType *ParamDecayedType =
9828 SecondParamType->getAs<DecayedType>()) {
9829 ODRDiagNote(SecondMethod->getLocation(),
9830 SecondMethod->getSourceRange(), MethodParameterType)
9831 << SecondMethodType << SecondName << (I + 1)
9832 << SecondParamType << true
9833 << ParamDecayedType->getOriginalType();
9835 ODRDiagNote(SecondMethod->getLocation(),
9836 SecondMethod->getSourceRange(), MethodParameterType)
9837 << SecondMethodType << SecondName << (I + 1)
9838 << SecondParamType << false;
9840 ParameterMismatch = true;
9844 DeclarationName FirstParamName = FirstParam->getDeclName();
9845 DeclarationName SecondParamName = SecondParam->getDeclName();
9846 if (FirstParamName != SecondParamName) {
9847 ODRDiagError(FirstMethod->getLocation(),
9848 FirstMethod->getSourceRange(), MethodParameterName)
9849 << FirstMethodType << FirstName << (I + 1) << FirstParamName;
9850 ODRDiagNote(SecondMethod->getLocation(),
9851 SecondMethod->getSourceRange(), MethodParameterName)
9852 << SecondMethodType << SecondName << (I + 1) << SecondParamName;
9853 ParameterMismatch = true;
9857 const Expr *FirstInit = FirstParam->getInit();
9858 const Expr *SecondInit = SecondParam->getInit();
9859 if ((FirstInit == nullptr) != (SecondInit == nullptr)) {
9860 ODRDiagError(FirstMethod->getLocation(),
9861 FirstMethod->getSourceRange(),
9862 MethodParameterSingleDefaultArgument)
9863 << FirstMethodType << FirstName << (I + 1)
9864 << (FirstInit == nullptr)
9865 << (FirstInit ? FirstInit->getSourceRange() : SourceRange());
9866 ODRDiagNote(SecondMethod->getLocation(),
9867 SecondMethod->getSourceRange(),
9868 MethodParameterSingleDefaultArgument)
9869 << SecondMethodType << SecondName << (I + 1)
9870 << (SecondInit == nullptr)
9871 << (SecondInit ? SecondInit->getSourceRange() : SourceRange());
9872 ParameterMismatch = true;
9876 if (FirstInit && SecondInit &&
9877 ComputeODRHash(FirstInit) != ComputeODRHash(SecondInit)) {
9878 ODRDiagError(FirstMethod->getLocation(),
9879 FirstMethod->getSourceRange(),
9880 MethodParameterDifferentDefaultArgument)
9881 << FirstMethodType << FirstName << (I + 1)
9882 << FirstInit->getSourceRange();
9883 ODRDiagNote(SecondMethod->getLocation(),
9884 SecondMethod->getSourceRange(),
9885 MethodParameterDifferentDefaultArgument)
9886 << SecondMethodType << SecondName << (I + 1)
9887 << SecondInit->getSourceRange();
9888 ParameterMismatch = true;
9894 if (ParameterMismatch) {
9903 TypedefNameDecl *FirstTD = cast<TypedefNameDecl>(FirstDecl);
9904 TypedefNameDecl *SecondTD = cast<TypedefNameDecl>(SecondDecl);
9905 auto FirstName = FirstTD->getDeclName();
9906 auto SecondName = SecondTD->getDeclName();
9907 if (FirstName != SecondName) {
9908 ODRDiagError(FirstTD->getLocation(), FirstTD->getSourceRange(),
9910 << (FirstDiffType == TypeAlias) << FirstName;
9911 ODRDiagNote(SecondTD->getLocation(), SecondTD->getSourceRange(),
9913 << (FirstDiffType == TypeAlias) << SecondName;
9918 QualType FirstType = FirstTD->getUnderlyingType();
9919 QualType SecondType = SecondTD->getUnderlyingType();
9920 if (ComputeQualTypeODRHash(FirstType) !=
9921 ComputeQualTypeODRHash(SecondType)) {
9922 ODRDiagError(FirstTD->getLocation(), FirstTD->getSourceRange(),
9924 << (FirstDiffType == TypeAlias) << FirstName << FirstType;
9925 ODRDiagNote(SecondTD->getLocation(), SecondTD->getSourceRange(),
9927 << (FirstDiffType == TypeAlias) << SecondName << SecondType;
9934 VarDecl *FirstVD = cast<VarDecl>(FirstDecl);
9935 VarDecl *SecondVD = cast<VarDecl>(SecondDecl);
9936 auto FirstName = FirstVD->getDeclName();
9937 auto SecondName = SecondVD->getDeclName();
9938 if (FirstName != SecondName) {
9939 ODRDiagError(FirstVD->getLocation(), FirstVD->getSourceRange(),
9942 ODRDiagNote(SecondVD->getLocation(), SecondVD->getSourceRange(),
9949 QualType FirstType = FirstVD->getType();
9950 QualType SecondType = SecondVD->getType();
9951 if (ComputeQualTypeODRHash(FirstType) !=
9952 ComputeQualTypeODRHash(SecondType)) {
9953 ODRDiagError(FirstVD->getLocation(), FirstVD->getSourceRange(),
9955 << FirstName << FirstType;
9956 ODRDiagNote(SecondVD->getLocation(), SecondVD->getSourceRange(),
9958 << SecondName << SecondType;
9963 const Expr *FirstInit = FirstVD->getInit();
9964 const Expr *SecondInit = SecondVD->getInit();
9965 if ((FirstInit == nullptr) != (SecondInit == nullptr)) {
9966 ODRDiagError(FirstVD->getLocation(), FirstVD->getSourceRange(),
9967 VarSingleInitializer)
9968 << FirstName << (FirstInit == nullptr)
9969 << (FirstInit ? FirstInit->getSourceRange(): SourceRange());
9970 ODRDiagNote(SecondVD->getLocation(), SecondVD->getSourceRange(),
9971 VarSingleInitializer)
9972 << SecondName << (SecondInit == nullptr)
9973 << (SecondInit ? SecondInit->getSourceRange() : SourceRange());
9978 if (FirstInit && SecondInit &&
9979 ComputeODRHash(FirstInit) != ComputeODRHash(SecondInit)) {
9980 ODRDiagError(FirstVD->getLocation(), FirstVD->getSourceRange(),
9981 VarDifferentInitializer)
9982 << FirstName << FirstInit->getSourceRange();
9983 ODRDiagNote(SecondVD->getLocation(), SecondVD->getSourceRange(),
9984 VarDifferentInitializer)
9985 << SecondName << SecondInit->getSourceRange();
9990 const bool FirstIsConstexpr = FirstVD->isConstexpr();
9991 const bool SecondIsConstexpr = SecondVD->isConstexpr();
9992 if (FirstIsConstexpr != SecondIsConstexpr) {
9993 ODRDiagError(FirstVD->getLocation(), FirstVD->getSourceRange(),
9995 << FirstName << FirstIsConstexpr;
9996 ODRDiagNote(SecondVD->getLocation(), SecondVD->getSourceRange(),
9998 << SecondName << SecondIsConstexpr;
10005 FriendDecl *FirstFriend = cast<FriendDecl>(FirstDecl);
10006 FriendDecl *SecondFriend = cast<FriendDecl>(SecondDecl);
10008 NamedDecl *FirstND = FirstFriend->getFriendDecl();
10009 NamedDecl *SecondND = SecondFriend->getFriendDecl();
10011 TypeSourceInfo *FirstTSI = FirstFriend->getFriendType();
10012 TypeSourceInfo *SecondTSI = SecondFriend->getFriendType();
10014 if (FirstND && SecondND) {
10015 ODRDiagError(FirstFriend->getFriendLoc(),
10016 FirstFriend->getSourceRange(), FriendFunction)
10018 ODRDiagNote(SecondFriend->getFriendLoc(),
10019 SecondFriend->getSourceRange(), FriendFunction)
10026 if (FirstTSI && SecondTSI) {
10027 QualType FirstFriendType = FirstTSI->getType();
10028 QualType SecondFriendType = SecondTSI->getType();
10029 assert(ComputeQualTypeODRHash(FirstFriendType) !=
10030 ComputeQualTypeODRHash(SecondFriendType));
10031 ODRDiagError(FirstFriend->getFriendLoc(),
10032 FirstFriend->getSourceRange(), FriendType)
10033 << FirstFriendType;
10034 ODRDiagNote(SecondFriend->getFriendLoc(),
10035 SecondFriend->getSourceRange(), FriendType)
10036 << SecondFriendType;
10041 ODRDiagError(FirstFriend->getFriendLoc(), FirstFriend->getSourceRange(),
10042 FriendTypeFunction)
10043 << (FirstTSI == nullptr);
10044 ODRDiagNote(SecondFriend->getFriendLoc(),
10045 SecondFriend->getSourceRange(), FriendTypeFunction)
10046 << (SecondTSI == nullptr);
10053 if (Diagnosed == true)
10056 Diag(FirstDecl->getLocation(),
10057 diag::err_module_odr_violation_mismatch_decl_unknown)
10058 << FirstRecord << FirstModule.empty() << FirstModule << FirstDiffType
10059 << FirstDecl->getSourceRange();
10060 Diag(SecondDecl->getLocation(),
10061 diag::note_module_odr_violation_mismatch_decl_unknown)
10062 << SecondModule << FirstDiffType << SecondDecl->getSourceRange();
10067 // All definitions are updates to the same declaration. This happens if a
10068 // module instantiates the declaration of a class template specialization
10069 // and two or more other modules instantiate its definition.
10071 // FIXME: Indicate which modules had instantiations of this definition.
10072 // FIXME: How can this even happen?
10073 Diag(Merge.first->getLocation(),
10074 diag::err_module_odr_violation_different_instantiations)
10080 void ASTReader::StartedDeserializing() {
10081 if (++NumCurrentElementsDeserializing == 1 && ReadTimer.get())
10082 ReadTimer->startTimer();
10085 void ASTReader::FinishedDeserializing() {
10086 assert(NumCurrentElementsDeserializing &&
10087 "FinishedDeserializing not paired with StartedDeserializing");
10088 if (NumCurrentElementsDeserializing == 1) {
10089 // We decrease NumCurrentElementsDeserializing only after pending actions
10090 // are finished, to avoid recursively re-calling finishPendingActions().
10091 finishPendingActions();
10093 --NumCurrentElementsDeserializing;
10095 if (NumCurrentElementsDeserializing == 0) {
10096 // Propagate exception specification updates along redeclaration chains.
10097 while (!PendingExceptionSpecUpdates.empty()) {
10098 auto Updates = std::move(PendingExceptionSpecUpdates);
10099 PendingExceptionSpecUpdates.clear();
10100 for (auto Update : Updates) {
10101 ProcessingUpdatesRAIIObj ProcessingUpdates(*this);
10102 auto *FPT = Update.second->getType()->castAs<FunctionProtoType>();
10103 auto ESI = FPT->getExtProtoInfo().ExceptionSpec;
10104 if (auto *Listener = getContext().getASTMutationListener())
10105 Listener->ResolvedExceptionSpec(cast<FunctionDecl>(Update.second));
10106 for (auto *Redecl : Update.second->redecls())
10107 getContext().adjustExceptionSpec(cast<FunctionDecl>(Redecl), ESI);
10112 ReadTimer->stopTimer();
10114 diagnoseOdrViolations();
10116 // We are not in recursive loading, so it's safe to pass the "interesting"
10117 // decls to the consumer.
10119 PassInterestingDeclsToConsumer();
10123 void ASTReader::pushExternalDeclIntoScope(NamedDecl *D, DeclarationName Name) {
10124 if (IdentifierInfo *II = Name.getAsIdentifierInfo()) {
10125 // Remove any fake results before adding any real ones.
10126 auto It = PendingFakeLookupResults.find(II);
10127 if (It != PendingFakeLookupResults.end()) {
10128 for (auto *ND : It->second)
10129 SemaObj->IdResolver.RemoveDecl(ND);
10130 // FIXME: this works around module+PCH performance issue.
10131 // Rather than erase the result from the map, which is O(n), just clear
10132 // the vector of NamedDecls.
10133 It->second.clear();
10137 if (SemaObj->IdResolver.tryAddTopLevelDecl(D, Name) && SemaObj->TUScope) {
10138 SemaObj->TUScope->AddDecl(D);
10139 } else if (SemaObj->TUScope) {
10140 // Adding the decl to IdResolver may have failed because it was already in
10141 // (even though it was not added in scope). If it is already in, make sure
10142 // it gets in the scope as well.
10143 if (std::find(SemaObj->IdResolver.begin(Name),
10144 SemaObj->IdResolver.end(), D) != SemaObj->IdResolver.end())
10145 SemaObj->TUScope->AddDecl(D);
10149 ASTReader::ASTReader(Preprocessor &PP, ASTContext *Context,
10150 const PCHContainerReader &PCHContainerRdr,
10151 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
10152 StringRef isysroot, bool DisableValidation,
10153 bool AllowASTWithCompilerErrors,
10154 bool AllowConfigurationMismatch, bool ValidateSystemInputs,
10155 bool UseGlobalIndex,
10156 std::unique_ptr<llvm::Timer> ReadTimer)
10157 : Listener(DisableValidation
10158 ? cast<ASTReaderListener>(new SimpleASTReaderListener(PP))
10159 : cast<ASTReaderListener>(new PCHValidator(PP, *this))),
10160 SourceMgr(PP.getSourceManager()), FileMgr(PP.getFileManager()),
10161 PCHContainerRdr(PCHContainerRdr), Diags(PP.getDiagnostics()), PP(PP),
10162 ContextObj(Context),
10163 ModuleMgr(PP.getFileManager(), PP.getPCMCache(), PCHContainerRdr),
10164 PCMCache(PP.getPCMCache()), DummyIdResolver(PP),
10165 ReadTimer(std::move(ReadTimer)), isysroot(isysroot),
10166 DisableValidation(DisableValidation),
10167 AllowASTWithCompilerErrors(AllowASTWithCompilerErrors),
10168 AllowConfigurationMismatch(AllowConfigurationMismatch),
10169 ValidateSystemInputs(ValidateSystemInputs),
10170 UseGlobalIndex(UseGlobalIndex), CurrSwitchCaseStmts(&SwitchCaseStmts) {
10171 SourceMgr.setExternalSLocEntrySource(this);
10173 for (const auto &Ext : Extensions) {
10174 auto BlockName = Ext->getExtensionMetadata().BlockName;
10175 auto Known = ModuleFileExtensions.find(BlockName);
10176 if (Known != ModuleFileExtensions.end()) {
10177 Diags.Report(diag::warn_duplicate_module_file_extension)
10182 ModuleFileExtensions.insert({BlockName, Ext});
10186 ASTReader::~ASTReader() {
10187 if (OwnsDeserializationListener)
10188 delete DeserializationListener;
10191 IdentifierResolver &ASTReader::getIdResolver() {
10192 return SemaObj ? SemaObj->IdResolver : DummyIdResolver;
10195 unsigned ASTRecordReader::readRecord(llvm::BitstreamCursor &Cursor,
10196 unsigned AbbrevID) {
10199 return Cursor.readRecord(AbbrevID, Record);