1 //===-- ASTReader.cpp - AST File Reader -----------------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 //  This file defines the ASTReader class, which reads AST files.
11 //
12 //===----------------------------------------------------------------------===//
13 
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/RawCommentList.h"
30 #include "clang/AST/Type.h"
31 #include "clang/AST/TypeLocVisitor.h"
32 #include "clang/AST/UnresolvedSet.h"
33 #include "clang/Basic/CommentOptions.h"
34 #include "clang/Basic/DiagnosticOptions.h"
35 #include "clang/Basic/ExceptionSpecificationType.h"
36 #include "clang/Basic/FileManager.h"
37 #include "clang/Basic/FileSystemOptions.h"
38 #include "clang/Basic/LangOptions.h"
39 #include "clang/Basic/ObjCRuntime.h"
40 #include "clang/Basic/OperatorKinds.h"
41 #include "clang/Basic/Sanitizers.h"
42 #include "clang/Basic/SourceManager.h"
43 #include "clang/Basic/SourceManagerInternals.h"
44 #include "clang/Basic/Specifiers.h"
45 #include "clang/Basic/TargetInfo.h"
46 #include "clang/Basic/TargetOptions.h"
47 #include "clang/Basic/TokenKinds.h"
48 #include "clang/Basic/Version.h"
49 #include "clang/Basic/VersionTuple.h"
50 #include "clang/Frontend/PCHContainerOperations.h"
51 #include "clang/Lex/HeaderSearch.h"
52 #include "clang/Lex/HeaderSearchOptions.h"
53 #include "clang/Lex/MacroInfo.h"
54 #include "clang/Lex/ModuleMap.h"
55 #include "clang/Lex/PreprocessingRecord.h"
56 #include "clang/Lex/Preprocessor.h"
57 #include "clang/Lex/PreprocessorOptions.h"
58 #include "clang/Sema/Scope.h"
59 #include "clang/Sema/Sema.h"
60 #include "clang/Sema/Weak.h"
61 #include "clang/Serialization/ASTDeserializationListener.h"
62 #include "clang/Serialization/GlobalModuleIndex.h"
63 #include "clang/Serialization/ModuleManager.h"
64 #include "clang/Serialization/SerializationDiagnostic.h"
65 #include "llvm/ADT/APFloat.h"
66 #include "llvm/ADT/APInt.h"
67 #include "llvm/ADT/APSInt.h"
68 #include "llvm/ADT/Hashing.h"
69 #include "llvm/ADT/SmallString.h"
70 #include "llvm/ADT/StringExtras.h"
71 #include "llvm/ADT/Triple.h"
72 #include "llvm/Bitcode/BitstreamReader.h"
73 #include "llvm/Support/Compression.h"
74 #include "llvm/Support/Compiler.h"
75 #include "llvm/Support/Error.h"
76 #include "llvm/Support/ErrorHandling.h"
77 #include "llvm/Support/FileSystem.h"
78 #include "llvm/Support/MemoryBuffer.h"
79 #include "llvm/Support/Path.h"
80 #include "llvm/Support/SaveAndRestore.h"
81 #include "llvm/Support/raw_ostream.h"
82 #include <algorithm>
83 #include <cassert>
84 #include <cstdint>
85 #include <cstdio>
86 #include <cstring>
87 #include <ctime>
88 #include <iterator>
89 #include <limits>
90 #include <map>
91 #include <memory>
92 #include <new>
93 #include <string>
94 #include <system_error>
95 #include <tuple>
96 #include <utility>
97 #include <vector>
98 
99 using namespace clang;
100 using namespace clang::serialization;
101 using namespace clang::serialization::reader;
102 using llvm::BitstreamCursor;
103 
104 //===----------------------------------------------------------------------===//
105 // ChainedASTReaderListener implementation
106 //===----------------------------------------------------------------------===//
107 
108 bool
109 ChainedASTReaderListener::ReadFullVersionInformation(StringRef FullVersion) {
110   return First->ReadFullVersionInformation(FullVersion) ||
111          Second->ReadFullVersionInformation(FullVersion);
112 }
113 
114 void ChainedASTReaderListener::ReadModuleName(StringRef ModuleName) {
115   First->ReadModuleName(ModuleName);
116   Second->ReadModuleName(ModuleName);
117 }
118 
119 void ChainedASTReaderListener::ReadModuleMapFile(StringRef ModuleMapPath) {
120   First->ReadModuleMapFile(ModuleMapPath);
121   Second->ReadModuleMapFile(ModuleMapPath);
122 }
123 
124 bool
125 ChainedASTReaderListener::ReadLanguageOptions(const LangOptions &LangOpts,
126                                               bool Complain,
127                                               bool AllowCompatibleDifferences) {
128   return First->ReadLanguageOptions(LangOpts, Complain,
129                                     AllowCompatibleDifferences) ||
130          Second->ReadLanguageOptions(LangOpts, Complain,
131                                      AllowCompatibleDifferences);
132 }
133 
134 bool ChainedASTReaderListener::ReadTargetOptions(
135     const TargetOptions &TargetOpts, bool Complain,
136     bool AllowCompatibleDifferences) {
137   return First->ReadTargetOptions(TargetOpts, Complain,
138                                   AllowCompatibleDifferences) ||
139          Second->ReadTargetOptions(TargetOpts, Complain,
140                                    AllowCompatibleDifferences);
141 }
142 
143 bool ChainedASTReaderListener::ReadDiagnosticOptions(
144     IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts, bool Complain) {
145   return First->ReadDiagnosticOptions(DiagOpts, Complain) ||
146          Second->ReadDiagnosticOptions(DiagOpts, Complain);
147 }
148 
149 bool
150 ChainedASTReaderListener::ReadFileSystemOptions(const FileSystemOptions &FSOpts,
151                                                 bool Complain) {
152   return First->ReadFileSystemOptions(FSOpts, Complain) ||
153          Second->ReadFileSystemOptions(FSOpts, Complain);
154 }
155 
156 bool ChainedASTReaderListener::ReadHeaderSearchOptions(
157     const HeaderSearchOptions &HSOpts, StringRef SpecificModuleCachePath,
158     bool Complain) {
159   return First->ReadHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
160                                         Complain) ||
161          Second->ReadHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
162                                          Complain);
163 }
164 
165 bool ChainedASTReaderListener::ReadPreprocessorOptions(
166     const PreprocessorOptions &PPOpts, bool Complain,
167     std::string &SuggestedPredefines) {
168   return First->ReadPreprocessorOptions(PPOpts, Complain,
169                                         SuggestedPredefines) ||
170          Second->ReadPreprocessorOptions(PPOpts, Complain, SuggestedPredefines);
171 }
172 void ChainedASTReaderListener::ReadCounter(const serialization::ModuleFile &M,
173                                            unsigned Value) {
174   First->ReadCounter(M, Value);
175   Second->ReadCounter(M, Value);
176 }
177 bool ChainedASTReaderListener::needsInputFileVisitation() {
178   return First->needsInputFileVisitation() ||
179          Second->needsInputFileVisitation();
180 }
181 bool ChainedASTReaderListener::needsSystemInputFileVisitation() {
182   return First->needsSystemInputFileVisitation() ||
183   Second->needsSystemInputFileVisitation();
184 }
185 void ChainedASTReaderListener::visitModuleFile(StringRef Filename,
186                                                ModuleKind Kind) {
187   First->visitModuleFile(Filename, Kind);
188   Second->visitModuleFile(Filename, Kind);
189 }
190 
191 bool ChainedASTReaderListener::visitInputFile(StringRef Filename,
192                                               bool isSystem,
193                                               bool isOverridden,
194                                               bool isExplicitModule) {
195   bool Continue = false;
196   if (First->needsInputFileVisitation() &&
197       (!isSystem || First->needsSystemInputFileVisitation()))
198     Continue |= First->visitInputFile(Filename, isSystem, isOverridden,
199                                       isExplicitModule);
200   if (Second->needsInputFileVisitation() &&
201       (!isSystem || Second->needsSystemInputFileVisitation()))
202     Continue |= Second->visitInputFile(Filename, isSystem, isOverridden,
203                                        isExplicitModule);
204   return Continue;
205 }
206 
207 void ChainedASTReaderListener::readModuleFileExtension(
208        const ModuleFileExtensionMetadata &Metadata) {
209   First->readModuleFileExtension(Metadata);
210   Second->readModuleFileExtension(Metadata);
211 }
212 
213 //===----------------------------------------------------------------------===//
214 // PCH validator implementation
215 //===----------------------------------------------------------------------===//
216 
217 ASTReaderListener::~ASTReaderListener() {}
218 
219 /// \brief Compare the given set of language options against an existing set of
220 /// language options.
221 ///
222 /// \param Diags If non-NULL, diagnostics will be emitted via this engine.
223 /// \param AllowCompatibleDifferences If true, differences between compatible
224 ///        language options will be permitted.
225 ///
226 /// \returns true if the languagae options mis-match, false otherwise.
227 static bool checkLanguageOptions(const LangOptions &LangOpts,
228                                  const LangOptions &ExistingLangOpts,
229                                  DiagnosticsEngine *Diags,
230                                  bool AllowCompatibleDifferences = true) {
231 #define LANGOPT(Name, Bits, Default, Description)                 \
232   if (ExistingLangOpts.Name != LangOpts.Name) {                   \
233     if (Diags)                                                    \
234       Diags->Report(diag::err_pch_langopt_mismatch)               \
235         << Description << LangOpts.Name << ExistingLangOpts.Name; \
236     return true;                                                  \
237   }
238 
239 #define VALUE_LANGOPT(Name, Bits, Default, Description)   \
240   if (ExistingLangOpts.Name != LangOpts.Name) {           \
241     if (Diags)                                            \
242       Diags->Report(diag::err_pch_langopt_value_mismatch) \
243         << Description;                                   \
244     return true;                                          \
245   }
246 
247 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description)   \
248   if (ExistingLangOpts.get##Name() != LangOpts.get##Name()) {  \
249     if (Diags)                                                 \
250       Diags->Report(diag::err_pch_langopt_value_mismatch)      \
251         << Description;                                        \
252     return true;                                               \
253   }
254 
255 #define COMPATIBLE_LANGOPT(Name, Bits, Default, Description)  \
256   if (!AllowCompatibleDifferences)                            \
257     LANGOPT(Name, Bits, Default, Description)
258 
259 #define COMPATIBLE_ENUM_LANGOPT(Name, Bits, Default, Description)  \
260   if (!AllowCompatibleDifferences)                                 \
261     ENUM_LANGOPT(Name, Bits, Default, Description)
262 
263 #define COMPATIBLE_VALUE_LANGOPT(Name, Bits, Default, Description) \
264   if (!AllowCompatibleDifferences)                                 \
265     VALUE_LANGOPT(Name, Bits, Default, Description)
266 
267 #define BENIGN_LANGOPT(Name, Bits, Default, Description)
268 #define BENIGN_ENUM_LANGOPT(Name, Type, Bits, Default, Description)
269 #define BENIGN_VALUE_LANGOPT(Name, Type, Bits, Default, Description)
270 #include "clang/Basic/LangOptions.def"
271 
272   if (ExistingLangOpts.ModuleFeatures != LangOpts.ModuleFeatures) {
273     if (Diags)
274       Diags->Report(diag::err_pch_langopt_value_mismatch) << "module features";
275     return true;
276   }
277 
278   if (ExistingLangOpts.ObjCRuntime != LangOpts.ObjCRuntime) {
279     if (Diags)
280       Diags->Report(diag::err_pch_langopt_value_mismatch)
281       << "target Objective-C runtime";
282     return true;
283   }
284 
285   if (ExistingLangOpts.CommentOpts.BlockCommandNames !=
286       LangOpts.CommentOpts.BlockCommandNames) {
287     if (Diags)
288       Diags->Report(diag::err_pch_langopt_value_mismatch)
289         << "block command names";
290     return true;
291   }
292 
293   return false;
294 }
295 
296 /// \brief Compare the given set of target options against an existing set of
297 /// target options.
298 ///
299 /// \param Diags If non-NULL, diagnostics will be emitted via this engine.
300 ///
301 /// \returns true if the target options mis-match, false otherwise.
302 static bool checkTargetOptions(const TargetOptions &TargetOpts,
303                                const TargetOptions &ExistingTargetOpts,
304                                DiagnosticsEngine *Diags,
305                                bool AllowCompatibleDifferences = true) {
306 #define CHECK_TARGET_OPT(Field, Name)                             \
307   if (TargetOpts.Field != ExistingTargetOpts.Field) {             \
308     if (Diags)                                                    \
309       Diags->Report(diag::err_pch_targetopt_mismatch)             \
310         << Name << TargetOpts.Field << ExistingTargetOpts.Field;  \
311     return true;                                                  \
312   }
313 
314   // The triple and ABI must match exactly.
315   CHECK_TARGET_OPT(Triple, "target");
316   CHECK_TARGET_OPT(ABI, "target ABI");
317 
318   // We can tolerate different CPUs in many cases, notably when one CPU
319   // supports a strict superset of another. When allowing compatible
320   // differences skip this check.
321   if (!AllowCompatibleDifferences)
322     CHECK_TARGET_OPT(CPU, "target CPU");
323 
324 #undef CHECK_TARGET_OPT
325 
326   // Compare feature sets.
327   SmallVector<StringRef, 4> ExistingFeatures(
328                                              ExistingTargetOpts.FeaturesAsWritten.begin(),
329                                              ExistingTargetOpts.FeaturesAsWritten.end());
330   SmallVector<StringRef, 4> ReadFeatures(TargetOpts.FeaturesAsWritten.begin(),
331                                          TargetOpts.FeaturesAsWritten.end());
332   std::sort(ExistingFeatures.begin(), ExistingFeatures.end());
333   std::sort(ReadFeatures.begin(), ReadFeatures.end());
334 
335   // We compute the set difference in both directions explicitly so that we can
336   // diagnose the differences differently.
337   SmallVector<StringRef, 4> UnmatchedExistingFeatures, UnmatchedReadFeatures;
338   std::set_difference(
339       ExistingFeatures.begin(), ExistingFeatures.end(), ReadFeatures.begin(),
340       ReadFeatures.end(), std::back_inserter(UnmatchedExistingFeatures));
341   std::set_difference(ReadFeatures.begin(), ReadFeatures.end(),
342                       ExistingFeatures.begin(), ExistingFeatures.end(),
343                       std::back_inserter(UnmatchedReadFeatures));
344 
345   // If we are allowing compatible differences and the read feature set is
346   // a strict subset of the existing feature set, there is nothing to diagnose.
347   if (AllowCompatibleDifferences && UnmatchedReadFeatures.empty())
348     return false;
349 
350   if (Diags) {
351     for (StringRef Feature : UnmatchedReadFeatures)
352       Diags->Report(diag::err_pch_targetopt_feature_mismatch)
353           << /* is-existing-feature */ false << Feature;
354     for (StringRef Feature : UnmatchedExistingFeatures)
355       Diags->Report(diag::err_pch_targetopt_feature_mismatch)
356           << /* is-existing-feature */ true << Feature;
357   }
358 
359   return !UnmatchedReadFeatures.empty() || !UnmatchedExistingFeatures.empty();
360 }
361 
362 bool
363 PCHValidator::ReadLanguageOptions(const LangOptions &LangOpts,
364                                   bool Complain,
365                                   bool AllowCompatibleDifferences) {
366   const LangOptions &ExistingLangOpts = PP.getLangOpts();
367   return checkLanguageOptions(LangOpts, ExistingLangOpts,
368                               Complain ? &Reader.Diags : nullptr,
369                               AllowCompatibleDifferences);
370 }
371 
372 bool PCHValidator::ReadTargetOptions(const TargetOptions &TargetOpts,
373                                      bool Complain,
374                                      bool AllowCompatibleDifferences) {
375   const TargetOptions &ExistingTargetOpts = PP.getTargetInfo().getTargetOpts();
376   return checkTargetOptions(TargetOpts, ExistingTargetOpts,
377                             Complain ? &Reader.Diags : nullptr,
378                             AllowCompatibleDifferences);
379 }
380 
381 namespace {
382 
383   typedef llvm::StringMap<std::pair<StringRef, bool /*IsUndef*/> >
384     MacroDefinitionsMap;
385   typedef llvm::DenseMap<DeclarationName, SmallVector<NamedDecl *, 8> >
386     DeclsMap;
387 
388 } // end anonymous namespace
389 
390 static bool checkDiagnosticGroupMappings(DiagnosticsEngine &StoredDiags,
391                                          DiagnosticsEngine &Diags,
392                                          bool Complain) {
393   typedef DiagnosticsEngine::Level Level;
394 
395   // Check current mappings for new -Werror mappings, and the stored mappings
396   // for cases that were explicitly mapped to *not* be errors that are now
397   // errors because of options like -Werror.
398   DiagnosticsEngine *MappingSources[] = { &Diags, &StoredDiags };
399 
400   for (DiagnosticsEngine *MappingSource : MappingSources) {
401     for (auto DiagIDMappingPair : MappingSource->getDiagnosticMappings()) {
402       diag::kind DiagID = DiagIDMappingPair.first;
403       Level CurLevel = Diags.getDiagnosticLevel(DiagID, SourceLocation());
404       if (CurLevel < DiagnosticsEngine::Error)
405         continue; // not significant
406       Level StoredLevel =
407           StoredDiags.getDiagnosticLevel(DiagID, SourceLocation());
408       if (StoredLevel < DiagnosticsEngine::Error) {
409         if (Complain)
410           Diags.Report(diag::err_pch_diagopt_mismatch) << "-Werror=" +
411               Diags.getDiagnosticIDs()->getWarningOptionForDiag(DiagID).str();
412         return true;
413       }
414     }
415   }
416 
417   return false;
418 }
419 
420 static bool isExtHandlingFromDiagsError(DiagnosticsEngine &Diags) {
421   diag::Severity Ext = Diags.getExtensionHandlingBehavior();
422   if (Ext == diag::Severity::Warning && Diags.getWarningsAsErrors())
423     return true;
424   return Ext >= diag::Severity::Error;
425 }
426 
427 static bool checkDiagnosticMappings(DiagnosticsEngine &StoredDiags,
428                                     DiagnosticsEngine &Diags,
429                                     bool IsSystem, bool Complain) {
430   // Top-level options
431   if (IsSystem) {
432     if (Diags.getSuppressSystemWarnings())
433       return false;
434     // If -Wsystem-headers was not enabled before, be conservative
435     if (StoredDiags.getSuppressSystemWarnings()) {
436       if (Complain)
437         Diags.Report(diag::err_pch_diagopt_mismatch) << "-Wsystem-headers";
438       return true;
439     }
440   }
441 
442   if (Diags.getWarningsAsErrors() && !StoredDiags.getWarningsAsErrors()) {
443     if (Complain)
444       Diags.Report(diag::err_pch_diagopt_mismatch) << "-Werror";
445     return true;
446   }
447 
448   if (Diags.getWarningsAsErrors() && Diags.getEnableAllWarnings() &&
449       !StoredDiags.getEnableAllWarnings()) {
450     if (Complain)
451       Diags.Report(diag::err_pch_diagopt_mismatch) << "-Weverything -Werror";
452     return true;
453   }
454 
455   if (isExtHandlingFromDiagsError(Diags) &&
456       !isExtHandlingFromDiagsError(StoredDiags)) {
457     if (Complain)
458       Diags.Report(diag::err_pch_diagopt_mismatch) << "-pedantic-errors";
459     return true;
460   }
461 
462   return checkDiagnosticGroupMappings(StoredDiags, Diags, Complain);
463 }
464 
465 bool PCHValidator::ReadDiagnosticOptions(
466     IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts, bool Complain) {
467   DiagnosticsEngine &ExistingDiags = PP.getDiagnostics();
468   IntrusiveRefCntPtr<DiagnosticIDs> DiagIDs(ExistingDiags.getDiagnosticIDs());
469   IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
470       new DiagnosticsEngine(DiagIDs, DiagOpts.get()));
471   // This should never fail, because we would have processed these options
472   // before writing them to an ASTFile.
473   ProcessWarningOptions(*Diags, *DiagOpts, /*Report*/false);
474 
475   ModuleManager &ModuleMgr = Reader.getModuleManager();
476   assert(ModuleMgr.size() >= 1 && "what ASTFile is this then");
477 
478   // If the original import came from a file explicitly generated by the user,
479   // don't check the diagnostic mappings.
480   // FIXME: currently this is approximated by checking whether this is not a
481   // module import of an implicitly-loaded module file.
482   // Note: ModuleMgr.rbegin() may not be the current module, but it must be in
483   // the transitive closure of its imports, since unrelated modules cannot be
484   // imported until after this module finishes validation.
485   ModuleFile *TopImport = *ModuleMgr.rbegin();
486   while (!TopImport->ImportedBy.empty())
487     TopImport = TopImport->ImportedBy[0];
488   if (TopImport->Kind != MK_ImplicitModule)
489     return false;
490 
491   StringRef ModuleName = TopImport->ModuleName;
492   assert(!ModuleName.empty() && "diagnostic options read before module name");
493 
494   Module *M = PP.getHeaderSearchInfo().lookupModule(ModuleName);
495   assert(M && "missing module");
496 
497   // FIXME: if the diagnostics are incompatible, save a DiagnosticOptions that
498   // contains the union of their flags.
499   return checkDiagnosticMappings(*Diags, ExistingDiags, M->IsSystem, Complain);
500 }
501 
502 /// \brief Collect the macro definitions provided by the given preprocessor
503 /// options.
504 static void
505 collectMacroDefinitions(const PreprocessorOptions &PPOpts,
506                         MacroDefinitionsMap &Macros,
507                         SmallVectorImpl<StringRef> *MacroNames = nullptr) {
508   for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
509     StringRef Macro = PPOpts.Macros[I].first;
510     bool IsUndef = PPOpts.Macros[I].second;
511 
512     std::pair<StringRef, StringRef> MacroPair = Macro.split('=');
513     StringRef MacroName = MacroPair.first;
514     StringRef MacroBody = MacroPair.second;
515 
516     // For an #undef'd macro, we only care about the name.
517     if (IsUndef) {
518       if (MacroNames && !Macros.count(MacroName))
519         MacroNames->push_back(MacroName);
520 
521       Macros[MacroName] = std::make_pair("", true);
522       continue;
523     }
524 
525     // For a #define'd macro, figure out the actual definition.
526     if (MacroName.size() == Macro.size())
527       MacroBody = "1";
528     else {
529       // Note: GCC drops anything following an end-of-line character.
530       StringRef::size_type End = MacroBody.find_first_of("\n\r");
531       MacroBody = MacroBody.substr(0, End);
532     }
533 
534     if (MacroNames && !Macros.count(MacroName))
535       MacroNames->push_back(MacroName);
536     Macros[MacroName] = std::make_pair(MacroBody, false);
537   }
538 }
539 
540 /// \brief Check the preprocessor options deserialized from the control block
541 /// against the preprocessor options in an existing preprocessor.
542 ///
543 /// \param Diags If non-null, produce diagnostics for any mismatches incurred.
544 /// \param Validate If true, validate preprocessor options. If false, allow
545 ///        macros defined by \p ExistingPPOpts to override those defined by
546 ///        \p PPOpts in SuggestedPredefines.
547 static bool checkPreprocessorOptions(const PreprocessorOptions &PPOpts,
548                                      const PreprocessorOptions &ExistingPPOpts,
549                                      DiagnosticsEngine *Diags,
550                                      FileManager &FileMgr,
551                                      std::string &SuggestedPredefines,
552                                      const LangOptions &LangOpts,
553                                      bool Validate = true) {
554   // Check macro definitions.
555   MacroDefinitionsMap ASTFileMacros;
556   collectMacroDefinitions(PPOpts, ASTFileMacros);
557   MacroDefinitionsMap ExistingMacros;
558   SmallVector<StringRef, 4> ExistingMacroNames;
559   collectMacroDefinitions(ExistingPPOpts, ExistingMacros, &ExistingMacroNames);
560 
561   for (unsigned I = 0, N = ExistingMacroNames.size(); I != N; ++I) {
562     // Dig out the macro definition in the existing preprocessor options.
563     StringRef MacroName = ExistingMacroNames[I];
564     std::pair<StringRef, bool> Existing = ExistingMacros[MacroName];
565 
566     // Check whether we know anything about this macro name or not.
567     llvm::StringMap<std::pair<StringRef, bool /*IsUndef*/> >::iterator Known
568       = ASTFileMacros.find(MacroName);
569     if (!Validate || Known == ASTFileMacros.end()) {
570       // FIXME: Check whether this identifier was referenced anywhere in the
571       // AST file. If so, we should reject the AST file. Unfortunately, this
572       // information isn't in the control block. What shall we do about it?
573 
574       if (Existing.second) {
575         SuggestedPredefines += "#undef ";
576         SuggestedPredefines += MacroName.str();
577         SuggestedPredefines += '\n';
578       } else {
579         SuggestedPredefines += "#define ";
580         SuggestedPredefines += MacroName.str();
581         SuggestedPredefines += ' ';
582         SuggestedPredefines += Existing.first.str();
583         SuggestedPredefines += '\n';
584       }
585       continue;
586     }
587 
588     // If the macro was defined in one but undef'd in the other, we have a
589     // conflict.
590     if (Existing.second != Known->second.second) {
591       if (Diags) {
592         Diags->Report(diag::err_pch_macro_def_undef)
593           << MacroName << Known->second.second;
594       }
595       return true;
596     }
597 
598     // If the macro was #undef'd in both, or if the macro bodies are identical,
599     // it's fine.
600     if (Existing.second || Existing.first == Known->second.first)
601       continue;
602 
603     // The macro bodies differ; complain.
604     if (Diags) {
605       Diags->Report(diag::err_pch_macro_def_conflict)
606         << MacroName << Known->second.first << Existing.first;
607     }
608     return true;
609   }
610 
611   // Check whether we're using predefines.
612   if (PPOpts.UsePredefines != ExistingPPOpts.UsePredefines && Validate) {
613     if (Diags) {
614       Diags->Report(diag::err_pch_undef) << ExistingPPOpts.UsePredefines;
615     }
616     return true;
617   }
618 
619   // Detailed record is important since it is used for the module cache hash.
620   if (LangOpts.Modules &&
621       PPOpts.DetailedRecord != ExistingPPOpts.DetailedRecord && Validate) {
622     if (Diags) {
623       Diags->Report(diag::err_pch_pp_detailed_record) << PPOpts.DetailedRecord;
624     }
625     return true;
626   }
627 
628   // Compute the #include and #include_macros lines we need.
629   for (unsigned I = 0, N = ExistingPPOpts.Includes.size(); I != N; ++I) {
630     StringRef File = ExistingPPOpts.Includes[I];
631     if (File == ExistingPPOpts.ImplicitPCHInclude)
632       continue;
633 
634     if (std::find(PPOpts.Includes.begin(), PPOpts.Includes.end(), File)
635           != PPOpts.Includes.end())
636       continue;
637 
638     SuggestedPredefines += "#include \"";
639     SuggestedPredefines += File;
640     SuggestedPredefines += "\"\n";
641   }
642 
643   for (unsigned I = 0, N = ExistingPPOpts.MacroIncludes.size(); I != N; ++I) {
644     StringRef File = ExistingPPOpts.MacroIncludes[I];
645     if (std::find(PPOpts.MacroIncludes.begin(), PPOpts.MacroIncludes.end(),
646                   File)
647         != PPOpts.MacroIncludes.end())
648       continue;
649 
650     SuggestedPredefines += "#__include_macros \"";
651     SuggestedPredefines += File;
652     SuggestedPredefines += "\"\n##\n";
653   }
654 
655   return false;
656 }
657 
658 bool PCHValidator::ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
659                                            bool Complain,
660                                            std::string &SuggestedPredefines) {
661   const PreprocessorOptions &ExistingPPOpts = PP.getPreprocessorOpts();
662 
663   return checkPreprocessorOptions(PPOpts, ExistingPPOpts,
664                                   Complain? &Reader.Diags : nullptr,
665                                   PP.getFileManager(),
666                                   SuggestedPredefines,
667                                   PP.getLangOpts());
668 }
669 
670 bool SimpleASTReaderListener::ReadPreprocessorOptions(
671                                   const PreprocessorOptions &PPOpts,
672                                   bool Complain,
673                                   std::string &SuggestedPredefines) {
674   return checkPreprocessorOptions(PPOpts,
675                                   PP.getPreprocessorOpts(),
676                                   nullptr,
677                                   PP.getFileManager(),
678                                   SuggestedPredefines,
679                                   PP.getLangOpts(),
680                                   false);
681 }
682 
683 /// Check the header search options deserialized from the control block
684 /// against the header search options in an existing preprocessor.
685 ///
686 /// \param Diags If non-null, produce diagnostics for any mismatches incurred.
687 static bool checkHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
688                                      StringRef SpecificModuleCachePath,
689                                      StringRef ExistingModuleCachePath,
690                                      DiagnosticsEngine *Diags,
691                                      const LangOptions &LangOpts) {
692   if (LangOpts.Modules) {
693     if (SpecificModuleCachePath != ExistingModuleCachePath) {
694       if (Diags)
695         Diags->Report(diag::err_pch_modulecache_mismatch)
696           << SpecificModuleCachePath << ExistingModuleCachePath;
697       return true;
698     }
699   }
700 
701   return false;
702 }
703 
704 bool PCHValidator::ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
705                                            StringRef SpecificModuleCachePath,
706                                            bool Complain) {
707   return checkHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
708                                   PP.getHeaderSearchInfo().getModuleCachePath(),
709                                   Complain ? &Reader.Diags : nullptr,
710                                   PP.getLangOpts());
711 }
712 
713 void PCHValidator::ReadCounter(const ModuleFile &M, unsigned Value) {
714   PP.setCounterValue(Value);
715 }
716 
717 //===----------------------------------------------------------------------===//
718 // AST reader implementation
719 //===----------------------------------------------------------------------===//
720 
721 void ASTReader::setDeserializationListener(ASTDeserializationListener *Listener,
722                                            bool TakeOwnership) {
723   DeserializationListener = Listener;
724   OwnsDeserializationListener = TakeOwnership;
725 }
726 
727 unsigned ASTSelectorLookupTrait::ComputeHash(Selector Sel) {
728   return serialization::ComputeHash(Sel);
729 }
730 
731 std::pair<unsigned, unsigned>
732 ASTSelectorLookupTrait::ReadKeyDataLength(const unsigned char*& d) {
733   using namespace llvm::support;
734   unsigned KeyLen = endian::readNext<uint16_t, little, unaligned>(d);
735   unsigned DataLen = endian::readNext<uint16_t, little, unaligned>(d);
736   return std::make_pair(KeyLen, DataLen);
737 }
738 
739 ASTSelectorLookupTrait::internal_key_type
740 ASTSelectorLookupTrait::ReadKey(const unsigned char* d, unsigned) {
741   using namespace llvm::support;
742   SelectorTable &SelTable = Reader.getContext().Selectors;
743   unsigned N = endian::readNext<uint16_t, little, unaligned>(d);
744   IdentifierInfo *FirstII = Reader.getLocalIdentifier(
745       F, endian::readNext<uint32_t, little, unaligned>(d));
746   if (N == 0)
747     return SelTable.getNullarySelector(FirstII);
748   else if (N == 1)
749     return SelTable.getUnarySelector(FirstII);
750 
751   SmallVector<IdentifierInfo *, 16> Args;
752   Args.push_back(FirstII);
753   for (unsigned I = 1; I != N; ++I)
754     Args.push_back(Reader.getLocalIdentifier(
755         F, endian::readNext<uint32_t, little, unaligned>(d)));
756 
757   return SelTable.getSelector(N, Args.data());
758 }
759 
760 ASTSelectorLookupTrait::data_type
761 ASTSelectorLookupTrait::ReadData(Selector, const unsigned char* d,
762                                  unsigned DataLen) {
763   using namespace llvm::support;
764 
765   data_type Result;
766 
767   Result.ID = Reader.getGlobalSelectorID(
768       F, endian::readNext<uint32_t, little, unaligned>(d));
769   unsigned FullInstanceBits = endian::readNext<uint16_t, little, unaligned>(d);
770   unsigned FullFactoryBits = endian::readNext<uint16_t, little, unaligned>(d);
771   Result.InstanceBits = FullInstanceBits & 0x3;
772   Result.InstanceHasMoreThanOneDecl = (FullInstanceBits >> 2) & 0x1;
773   Result.FactoryBits = FullFactoryBits & 0x3;
774   Result.FactoryHasMoreThanOneDecl = (FullFactoryBits >> 2) & 0x1;
775   unsigned NumInstanceMethods = FullInstanceBits >> 3;
776   unsigned NumFactoryMethods = FullFactoryBits >> 3;
777 
778   // Load instance methods
779   for (unsigned I = 0; I != NumInstanceMethods; ++I) {
780     if (ObjCMethodDecl *Method = Reader.GetLocalDeclAs<ObjCMethodDecl>(
781             F, endian::readNext<uint32_t, little, unaligned>(d)))
782       Result.Instance.push_back(Method);
783   }
784 
785   // Load factory methods
786   for (unsigned I = 0; I != NumFactoryMethods; ++I) {
787     if (ObjCMethodDecl *Method = Reader.GetLocalDeclAs<ObjCMethodDecl>(
788             F, endian::readNext<uint32_t, little, unaligned>(d)))
789       Result.Factory.push_back(Method);
790   }
791 
792   return Result;
793 }
794 
795 unsigned ASTIdentifierLookupTraitBase::ComputeHash(const internal_key_type& a) {
796   return llvm::HashString(a);
797 }
798 
799 std::pair<unsigned, unsigned>
800 ASTIdentifierLookupTraitBase::ReadKeyDataLength(const unsigned char*& d) {
801   using namespace llvm::support;
802   unsigned DataLen = endian::readNext<uint16_t, little, unaligned>(d);
803   unsigned KeyLen = endian::readNext<uint16_t, little, unaligned>(d);
804   return std::make_pair(KeyLen, DataLen);
805 }
806 
807 ASTIdentifierLookupTraitBase::internal_key_type
808 ASTIdentifierLookupTraitBase::ReadKey(const unsigned char* d, unsigned n) {
809   assert(n >= 2 && d[n-1] == '\0');
810   return StringRef((const char*) d, n-1);
811 }
812 
813 /// \brief Whether the given identifier is "interesting".
814 static bool isInterestingIdentifier(ASTReader &Reader, IdentifierInfo &II,
815                                     bool IsModule) {
816   return II.hadMacroDefinition() ||
817          II.isPoisoned() ||
818          (IsModule ? II.hasRevertedBuiltin() : II.getObjCOrBuiltinID()) ||
819          II.hasRevertedTokenIDToIdentifier() ||
820          (!(IsModule && Reader.getContext().getLangOpts().CPlusPlus) &&
821           II.getFETokenInfo<void>());
822 }
823 
824 static bool readBit(unsigned &Bits) {
825   bool Value = Bits & 0x1;
826   Bits >>= 1;
827   return Value;
828 }
829 
830 IdentID ASTIdentifierLookupTrait::ReadIdentifierID(const unsigned char *d) {
831   using namespace llvm::support;
832   unsigned RawID = endian::readNext<uint32_t, little, unaligned>(d);
833   return Reader.getGlobalIdentifierID(F, RawID >> 1);
834 }
835 
836 static void markIdentifierFromAST(ASTReader &Reader, IdentifierInfo &II) {
837   if (!II.isFromAST()) {
838     II.setIsFromAST();
839     bool IsModule = Reader.getPreprocessor().getCurrentModule() != nullptr;
840     if (isInterestingIdentifier(Reader, II, IsModule))
841       II.setChangedSinceDeserialization();
842   }
843 }
844 
845 IdentifierInfo *ASTIdentifierLookupTrait::ReadData(const internal_key_type& k,
846                                                    const unsigned char* d,
847                                                    unsigned DataLen) {
848   using namespace llvm::support;
849   unsigned RawID = endian::readNext<uint32_t, little, unaligned>(d);
850   bool IsInteresting = RawID & 0x01;
851 
852   // Wipe out the "is interesting" bit.
853   RawID = RawID >> 1;
854 
855   // Build the IdentifierInfo and link the identifier ID with it.
856   IdentifierInfo *II = KnownII;
857   if (!II) {
858     II = &Reader.getIdentifierTable().getOwn(k);
859     KnownII = II;
860   }
861   markIdentifierFromAST(Reader, *II);
862   Reader.markIdentifierUpToDate(II);
863 
864   IdentID ID = Reader.getGlobalIdentifierID(F, RawID);
865   if (!IsInteresting) {
866     // For uninteresting identifiers, there's nothing else to do. Just notify
867     // the reader that we've finished loading this identifier.
868     Reader.SetIdentifierInfo(ID, II);
869     return II;
870   }
871 
872   unsigned ObjCOrBuiltinID = endian::readNext<uint16_t, little, unaligned>(d);
873   unsigned Bits = endian::readNext<uint16_t, little, unaligned>(d);
874   bool CPlusPlusOperatorKeyword = readBit(Bits);
875   bool HasRevertedTokenIDToIdentifier = readBit(Bits);
876   bool HasRevertedBuiltin = readBit(Bits);
877   bool Poisoned = readBit(Bits);
878   bool ExtensionToken = readBit(Bits);
879   bool HadMacroDefinition = readBit(Bits);
880 
881   assert(Bits == 0 && "Extra bits in the identifier?");
882   DataLen -= 8;
883 
884   // Set or check the various bits in the IdentifierInfo structure.
885   // Token IDs are read-only.
886   if (HasRevertedTokenIDToIdentifier && II->getTokenID() != tok::identifier)
887     II->revertTokenIDToIdentifier();
888   if (!F.isModule())
889     II->setObjCOrBuiltinID(ObjCOrBuiltinID);
890   else if (HasRevertedBuiltin && II->getBuiltinID()) {
891     II->revertBuiltin();
892     assert((II->hasRevertedBuiltin() ||
893             II->getObjCOrBuiltinID() == ObjCOrBuiltinID) &&
894            "Incorrect ObjC keyword or builtin ID");
895   }
896   assert(II->isExtensionToken() == ExtensionToken &&
897          "Incorrect extension token flag");
898   (void)ExtensionToken;
899   if (Poisoned)
900     II->setIsPoisoned(true);
901   assert(II->isCPlusPlusOperatorKeyword() == CPlusPlusOperatorKeyword &&
902          "Incorrect C++ operator keyword flag");
903   (void)CPlusPlusOperatorKeyword;
904 
905   // If this identifier is a macro, deserialize the macro
906   // definition.
907   if (HadMacroDefinition) {
908     uint32_t MacroDirectivesOffset =
909         endian::readNext<uint32_t, little, unaligned>(d);
910     DataLen -= 4;
911 
912     Reader.addPendingMacro(II, &F, MacroDirectivesOffset);
913   }
914 
915   Reader.SetIdentifierInfo(ID, II);
916 
917   // Read all of the declarations visible at global scope with this
918   // name.
919   if (DataLen > 0) {
920     SmallVector<uint32_t, 4> DeclIDs;
921     for (; DataLen > 0; DataLen -= 4)
922       DeclIDs.push_back(Reader.getGlobalDeclID(
923           F, endian::readNext<uint32_t, little, unaligned>(d)));
924     Reader.SetGloballyVisibleDecls(II, DeclIDs);
925   }
926 
927   return II;
928 }
929 
930 DeclarationNameKey::DeclarationNameKey(DeclarationName Name)
931     : Kind(Name.getNameKind()) {
932   switch (Kind) {
933   case DeclarationName::Identifier:
934     Data = (uint64_t)Name.getAsIdentifierInfo();
935     break;
936   case DeclarationName::ObjCZeroArgSelector:
937   case DeclarationName::ObjCOneArgSelector:
938   case DeclarationName::ObjCMultiArgSelector:
939     Data = (uint64_t)Name.getObjCSelector().getAsOpaquePtr();
940     break;
941   case DeclarationName::CXXOperatorName:
942     Data = Name.getCXXOverloadedOperator();
943     break;
944   case DeclarationName::CXXLiteralOperatorName:
945     Data = (uint64_t)Name.getCXXLiteralIdentifier();
946     break;
947   case DeclarationName::CXXConstructorName:
948   case DeclarationName::CXXDestructorName:
949   case DeclarationName::CXXConversionFunctionName:
950   case DeclarationName::CXXUsingDirective:
951     Data = 0;
952     break;
953   }
954 }
955 
956 unsigned DeclarationNameKey::getHash() const {
957   llvm::FoldingSetNodeID ID;
958   ID.AddInteger(Kind);
959 
960   switch (Kind) {
961   case DeclarationName::Identifier:
962   case DeclarationName::CXXLiteralOperatorName:
963     ID.AddString(((IdentifierInfo*)Data)->getName());
964     break;
965   case DeclarationName::ObjCZeroArgSelector:
966   case DeclarationName::ObjCOneArgSelector:
967   case DeclarationName::ObjCMultiArgSelector:
968     ID.AddInteger(serialization::ComputeHash(Selector(Data)));
969     break;
970   case DeclarationName::CXXOperatorName:
971     ID.AddInteger((OverloadedOperatorKind)Data);
972     break;
973   case DeclarationName::CXXConstructorName:
974   case DeclarationName::CXXDestructorName:
975   case DeclarationName::CXXConversionFunctionName:
976   case DeclarationName::CXXUsingDirective:
977     break;
978   }
979 
980   return ID.ComputeHash();
981 }
982 
983 ModuleFile *
984 ASTDeclContextNameLookupTrait::ReadFileRef(const unsigned char *&d) {
985   using namespace llvm::support;
986   uint32_t ModuleFileID = endian::readNext<uint32_t, little, unaligned>(d);
987   return Reader.getLocalModuleFile(F, ModuleFileID);
988 }
989 
990 std::pair<unsigned, unsigned>
991 ASTDeclContextNameLookupTrait::ReadKeyDataLength(const unsigned char *&d) {
992   using namespace llvm::support;
993   unsigned KeyLen = endian::readNext<uint16_t, little, unaligned>(d);
994   unsigned DataLen = endian::readNext<uint16_t, little, unaligned>(d);
995   return std::make_pair(KeyLen, DataLen);
996 }
997 
998 ASTDeclContextNameLookupTrait::internal_key_type
999 ASTDeclContextNameLookupTrait::ReadKey(const unsigned char *d, unsigned) {
1000   using namespace llvm::support;
1001 
1002   auto Kind = (DeclarationName::NameKind)*d++;
1003   uint64_t Data;
1004   switch (Kind) {
1005   case DeclarationName::Identifier:
1006     Data = (uint64_t)Reader.getLocalIdentifier(
1007         F, endian::readNext<uint32_t, little, unaligned>(d));
1008     break;
1009   case DeclarationName::ObjCZeroArgSelector:
1010   case DeclarationName::ObjCOneArgSelector:
1011   case DeclarationName::ObjCMultiArgSelector:
1012     Data =
1013         (uint64_t)Reader.getLocalSelector(
1014                              F, endian::readNext<uint32_t, little, unaligned>(
1015                                     d)).getAsOpaquePtr();
1016     break;
1017   case DeclarationName::CXXOperatorName:
1018     Data = *d++; // OverloadedOperatorKind
1019     break;
1020   case DeclarationName::CXXLiteralOperatorName:
1021     Data = (uint64_t)Reader.getLocalIdentifier(
1022         F, endian::readNext<uint32_t, little, unaligned>(d));
1023     break;
1024   case DeclarationName::CXXConstructorName:
1025   case DeclarationName::CXXDestructorName:
1026   case DeclarationName::CXXConversionFunctionName:
1027   case DeclarationName::CXXUsingDirective:
1028     Data = 0;
1029     break;
1030   }
1031 
1032   return DeclarationNameKey(Kind, Data);
1033 }
1034 
1035 void ASTDeclContextNameLookupTrait::ReadDataInto(internal_key_type,
1036                                                  const unsigned char *d,
1037                                                  unsigned DataLen,
1038                                                  data_type_builder &Val) {
1039   using namespace llvm::support;
1040   for (unsigned NumDecls = DataLen / 4; NumDecls; --NumDecls) {
1041     uint32_t LocalID = endian::readNext<uint32_t, little, unaligned>(d);
1042     Val.insert(Reader.getGlobalDeclID(F, LocalID));
1043   }
1044 }
1045 
1046 bool ASTReader::ReadLexicalDeclContextStorage(ModuleFile &M,
1047                                               BitstreamCursor &Cursor,
1048                                               uint64_t Offset,
1049                                               DeclContext *DC) {
1050   assert(Offset != 0);
1051 
1052   SavedStreamPosition SavedPosition(Cursor);
1053   Cursor.JumpToBit(Offset);
1054 
1055   RecordData Record;
1056   StringRef Blob;
1057   unsigned Code = Cursor.ReadCode();
1058   unsigned RecCode = Cursor.readRecord(Code, Record, &Blob);
1059   if (RecCode != DECL_CONTEXT_LEXICAL) {
1060     Error("Expected lexical block");
1061     return true;
1062   }
1063 
1064   assert(!isa<TranslationUnitDecl>(DC) &&
1065          "expected a TU_UPDATE_LEXICAL record for TU");
1066   // If we are handling a C++ class template instantiation, we can see multiple
1067   // lexical updates for the same record. It's important that we select only one
1068   // of them, so that field numbering works properly. Just pick the first one we
1069   // see.
1070   auto &Lex = LexicalDecls[DC];
1071   if (!Lex.first) {
1072     Lex = std::make_pair(
1073         &M, llvm::makeArrayRef(
1074                 reinterpret_cast<const llvm::support::unaligned_uint32_t *>(
1075                     Blob.data()),
1076                 Blob.size() / 4));
1077   }
1078   DC->setHasExternalLexicalStorage(true);
1079   return false;
1080 }
1081 
1082 bool ASTReader::ReadVisibleDeclContextStorage(ModuleFile &M,
1083                                               BitstreamCursor &Cursor,
1084                                               uint64_t Offset,
1085                                               DeclID ID) {
1086   assert(Offset != 0);
1087 
1088   SavedStreamPosition SavedPosition(Cursor);
1089   Cursor.JumpToBit(Offset);
1090 
1091   RecordData Record;
1092   StringRef Blob;
1093   unsigned Code = Cursor.ReadCode();
1094   unsigned RecCode = Cursor.readRecord(Code, Record, &Blob);
1095   if (RecCode != DECL_CONTEXT_VISIBLE) {
1096     Error("Expected visible lookup table block");
1097     return true;
1098   }
1099 
1100   // We can't safely determine the primary context yet, so delay attaching the
1101   // lookup table until we're done with recursive deserialization.
1102   auto *Data = (const unsigned char*)Blob.data();
1103   PendingVisibleUpdates[ID].push_back(PendingVisibleUpdate{&M, Data});
1104   return false;
1105 }
1106 
1107 void ASTReader::Error(StringRef Msg) {
1108   Error(diag::err_fe_pch_malformed, Msg);
1109   if (Context.getLangOpts().Modules && !Diags.isDiagnosticInFlight() &&
1110       !PP.getHeaderSearchInfo().getModuleCachePath().empty()) {
1111     Diag(diag::note_module_cache_path)
1112       << PP.getHeaderSearchInfo().getModuleCachePath();
1113   }
1114 }
1115 
1116 void ASTReader::Error(unsigned DiagID,
1117                       StringRef Arg1, StringRef Arg2) {
1118   if (Diags.isDiagnosticInFlight())
1119     Diags.SetDelayedDiagnostic(DiagID, Arg1, Arg2);
1120   else
1121     Diag(DiagID) << Arg1 << Arg2;
1122 }
1123 
1124 //===----------------------------------------------------------------------===//
1125 // Source Manager Deserialization
1126 //===----------------------------------------------------------------------===//
1127 
1128 /// \brief Read the line table in the source manager block.
1129 /// \returns true if there was an error.
1130 bool ASTReader::ParseLineTable(ModuleFile &F,
1131                                const RecordData &Record) {
1132   unsigned Idx = 0;
1133   LineTableInfo &LineTable = SourceMgr.getLineTable();
1134 
1135   // Parse the file names
1136   std::map<int, int> FileIDs;
1137   for (unsigned I = 0; Record[Idx]; ++I) {
1138     // Extract the file name
1139     auto Filename = ReadPath(F, Record, Idx);
1140     FileIDs[I] = LineTable.getLineTableFilenameID(Filename);
1141   }
1142   ++Idx;
1143 
1144   // Parse the line entries
1145   std::vector<LineEntry> Entries;
1146   while (Idx < Record.size()) {
1147     int FID = Record[Idx++];
1148     assert(FID >= 0 && "Serialized line entries for non-local file.");
1149     // Remap FileID from 1-based old view.
1150     FID += F.SLocEntryBaseID - 1;
1151 
1152     // Extract the line entries
1153     unsigned NumEntries = Record[Idx++];
1154     assert(NumEntries && "no line entries for file ID");
1155     Entries.clear();
1156     Entries.reserve(NumEntries);
1157     for (unsigned I = 0; I != NumEntries; ++I) {
1158       unsigned FileOffset = Record[Idx++];
1159       unsigned LineNo = Record[Idx++];
1160       int FilenameID = FileIDs[Record[Idx++]];
1161       SrcMgr::CharacteristicKind FileKind
1162         = (SrcMgr::CharacteristicKind)Record[Idx++];
1163       unsigned IncludeOffset = Record[Idx++];
1164       Entries.push_back(LineEntry::get(FileOffset, LineNo, FilenameID,
1165                                        FileKind, IncludeOffset));
1166     }
1167     LineTable.AddEntry(FileID::get(FID), Entries);
1168   }
1169 
1170   return false;
1171 }
1172 
1173 /// \brief Read a source manager block
1174 bool ASTReader::ReadSourceManagerBlock(ModuleFile &F) {
1175   using namespace SrcMgr;
1176 
1177   BitstreamCursor &SLocEntryCursor = F.SLocEntryCursor;
1178 
1179   // Set the source-location entry cursor to the current position in
1180   // the stream. This cursor will be used to read the contents of the
1181   // source manager block initially, and then lazily read
1182   // source-location entries as needed.
1183   SLocEntryCursor = F.Stream;
1184 
1185   // The stream itself is going to skip over the source manager block.
1186   if (F.Stream.SkipBlock()) {
1187     Error("malformed block record in AST file");
1188     return true;
1189   }
1190 
1191   // Enter the source manager block.
1192   if (SLocEntryCursor.EnterSubBlock(SOURCE_MANAGER_BLOCK_ID)) {
1193     Error("malformed source manager block record in AST file");
1194     return true;
1195   }
1196 
1197   RecordData Record;
1198   while (true) {
1199     llvm::BitstreamEntry E = SLocEntryCursor.advanceSkippingSubblocks();
1200 
1201     switch (E.Kind) {
1202     case llvm::BitstreamEntry::SubBlock: // Handled for us already.
1203     case llvm::BitstreamEntry::Error:
1204       Error("malformed block record in AST file");
1205       return true;
1206     case llvm::BitstreamEntry::EndBlock:
1207       return false;
1208     case llvm::BitstreamEntry::Record:
1209       // The interesting case.
1210       break;
1211     }
1212 
1213     // Read a record.
1214     Record.clear();
1215     StringRef Blob;
1216     switch (SLocEntryCursor.readRecord(E.ID, Record, &Blob)) {
1217     default:  // Default behavior: ignore.
1218       break;
1219 
1220     case SM_SLOC_FILE_ENTRY:
1221     case SM_SLOC_BUFFER_ENTRY:
1222     case SM_SLOC_EXPANSION_ENTRY:
1223       // Once we hit one of the source location entries, we're done.
1224       return false;
1225     }
1226   }
1227 }
1228 
1229 /// \brief If a header file is not found at the path that we expect it to be
1230 /// and the PCH file was moved from its original location, try to resolve the
1231 /// file by assuming that header+PCH were moved together and the header is in
1232 /// the same place relative to the PCH.
1233 static std::string
1234 resolveFileRelativeToOriginalDir(const std::string &Filename,
1235                                  const std::string &OriginalDir,
1236                                  const std::string &CurrDir) {
1237   assert(OriginalDir != CurrDir &&
1238          "No point trying to resolve the file if the PCH dir didn't change");
1239   using namespace llvm::sys;
1240   SmallString<128> filePath(Filename);
1241   fs::make_absolute(filePath);
1242   assert(path::is_absolute(OriginalDir));
1243   SmallString<128> currPCHPath(CurrDir);
1244 
1245   path::const_iterator fileDirI = path::begin(path::parent_path(filePath)),
1246                        fileDirE = path::end(path::parent_path(filePath));
1247   path::const_iterator origDirI = path::begin(OriginalDir),
1248                        origDirE = path::end(OriginalDir);
1249   // Skip the common path components from filePath and OriginalDir.
1250   while (fileDirI != fileDirE && origDirI != origDirE &&
1251          *fileDirI == *origDirI) {
1252     ++fileDirI;
1253     ++origDirI;
1254   }
1255   for (; origDirI != origDirE; ++origDirI)
1256     path::append(currPCHPath, "..");
1257   path::append(currPCHPath, fileDirI, fileDirE);
1258   path::append(currPCHPath, path::filename(Filename));
1259   return currPCHPath.str();
1260 }
1261 
1262 bool ASTReader::ReadSLocEntry(int ID) {
1263   if (ID == 0)
1264     return false;
1265 
1266   if (unsigned(-ID) - 2 >= getTotalNumSLocs() || ID > 0) {
1267     Error("source location entry ID out-of-range for AST file");
1268     return true;
1269   }
1270 
1271   // Local helper to read the (possibly-compressed) buffer data following the
1272   // entry record.
1273   auto ReadBuffer = [this](
1274       BitstreamCursor &SLocEntryCursor,
1275       StringRef Name) -> std::unique_ptr<llvm::MemoryBuffer> {
1276     RecordData Record;
1277     StringRef Blob;
1278     unsigned Code = SLocEntryCursor.ReadCode();
1279     unsigned RecCode = SLocEntryCursor.readRecord(Code, Record, &Blob);
1280 
1281     if (RecCode == SM_SLOC_BUFFER_BLOB_COMPRESSED) {
1282       if (!llvm::zlib::isAvailable()) {
1283         Error("zlib is not available");
1284         return nullptr;
1285       }
1286       SmallString<0> Uncompressed;
1287       if (llvm::Error E =
1288               llvm::zlib::uncompress(Blob, Uncompressed, Record[0])) {
1289         Error("could not decompress embedded file contents: " +
1290               llvm::toString(std::move(E)));
1291         return nullptr;
1292       }
1293       return llvm::MemoryBuffer::getMemBufferCopy(Uncompressed, Name);
1294     } else if (RecCode == SM_SLOC_BUFFER_BLOB) {
1295       return llvm::MemoryBuffer::getMemBuffer(Blob.drop_back(1), Name, true);
1296     } else {
1297       Error("AST record has invalid code");
1298       return nullptr;
1299     }
1300   };
1301 
1302   ModuleFile *F = GlobalSLocEntryMap.find(-ID)->second;
1303   F->SLocEntryCursor.JumpToBit(F->SLocEntryOffsets[ID - F->SLocEntryBaseID]);
1304   BitstreamCursor &SLocEntryCursor = F->SLocEntryCursor;
1305   unsigned BaseOffset = F->SLocEntryBaseOffset;
1306 
1307   ++NumSLocEntriesRead;
1308   llvm::BitstreamEntry Entry = SLocEntryCursor.advance();
1309   if (Entry.Kind != llvm::BitstreamEntry::Record) {
1310     Error("incorrectly-formatted source location entry in AST file");
1311     return true;
1312   }
1313 
1314   RecordData Record;
1315   StringRef Blob;
1316   switch (SLocEntryCursor.readRecord(Entry.ID, Record, &Blob)) {
1317   default:
1318     Error("incorrectly-formatted source location entry in AST file");
1319     return true;
1320 
1321   case SM_SLOC_FILE_ENTRY: {
1322     // We will detect whether a file changed and return 'Failure' for it, but
1323     // we will also try to fail gracefully by setting up the SLocEntry.
1324     unsigned InputID = Record[4];
1325     InputFile IF = getInputFile(*F, InputID);
1326     const FileEntry *File = IF.getFile();
1327     bool OverriddenBuffer = IF.isOverridden();
1328 
1329     // Note that we only check if a File was returned. If it was out-of-date
1330     // we have complained but we will continue creating a FileID to recover
1331     // gracefully.
1332     if (!File)
1333       return true;
1334 
1335     SourceLocation IncludeLoc = ReadSourceLocation(*F, Record[1]);
1336     if (IncludeLoc.isInvalid() && F->Kind != MK_MainFile) {
1337       // This is the module's main file.
1338       IncludeLoc = getImportLocation(F);
1339     }
1340     SrcMgr::CharacteristicKind
1341       FileCharacter = (SrcMgr::CharacteristicKind)Record[2];
1342     FileID FID = SourceMgr.createFileID(File, IncludeLoc, FileCharacter,
1343                                         ID, BaseOffset + Record[0]);
1344     SrcMgr::FileInfo &FileInfo =
1345           const_cast<SrcMgr::FileInfo&>(SourceMgr.getSLocEntry(FID).getFile());
1346     FileInfo.NumCreatedFIDs = Record[5];
1347     if (Record[3])
1348       FileInfo.setHasLineDirectives();
1349 
1350     const DeclID *FirstDecl = F->FileSortedDecls + Record[6];
1351     unsigned NumFileDecls = Record[7];
1352     if (NumFileDecls) {
1353       assert(F->FileSortedDecls && "FILE_SORTED_DECLS not encountered yet ?");
1354       FileDeclIDs[FID] = FileDeclsInfo(F, llvm::makeArrayRef(FirstDecl,
1355                                                              NumFileDecls));
1356     }
1357 
1358     const SrcMgr::ContentCache *ContentCache
1359       = SourceMgr.getOrCreateContentCache(File,
1360                               /*isSystemFile=*/FileCharacter != SrcMgr::C_User);
1361     if (OverriddenBuffer && !ContentCache->BufferOverridden &&
1362         ContentCache->ContentsEntry == ContentCache->OrigEntry &&
1363         !ContentCache->getRawBuffer()) {
1364       auto Buffer = ReadBuffer(SLocEntryCursor, File->getName());
1365       if (!Buffer)
1366         return true;
1367       SourceMgr.overrideFileContents(File, std::move(Buffer));
1368     }
1369 
1370     break;
1371   }
1372 
1373   case SM_SLOC_BUFFER_ENTRY: {
1374     const char *Name = Blob.data();
1375     unsigned Offset = Record[0];
1376     SrcMgr::CharacteristicKind
1377       FileCharacter = (SrcMgr::CharacteristicKind)Record[2];
1378     SourceLocation IncludeLoc = ReadSourceLocation(*F, Record[1]);
1379     if (IncludeLoc.isInvalid() && F->isModule()) {
1380       IncludeLoc = getImportLocation(F);
1381     }
1382 
1383     auto Buffer = ReadBuffer(SLocEntryCursor, Name);
1384     if (!Buffer)
1385       return true;
1386     SourceMgr.createFileID(std::move(Buffer), FileCharacter, ID,
1387                            BaseOffset + Offset, IncludeLoc);
1388     break;
1389   }
1390 
1391   case SM_SLOC_EXPANSION_ENTRY: {
1392     SourceLocation SpellingLoc = ReadSourceLocation(*F, Record[1]);
1393     SourceMgr.createExpansionLoc(SpellingLoc,
1394                                      ReadSourceLocation(*F, Record[2]),
1395                                      ReadSourceLocation(*F, Record[3]),
1396                                      Record[4],
1397                                      ID,
1398                                      BaseOffset + Record[0]);
1399     break;
1400   }
1401   }
1402 
1403   return false;
1404 }
1405 
1406 std::pair<SourceLocation, StringRef> ASTReader::getModuleImportLoc(int ID) {
1407   if (ID == 0)
1408     return std::make_pair(SourceLocation(), "");
1409 
1410   if (unsigned(-ID) - 2 >= getTotalNumSLocs() || ID > 0) {
1411     Error("source location entry ID out-of-range for AST file");
1412     return std::make_pair(SourceLocation(), "");
1413   }
1414 
1415   // Find which module file this entry lands in.
1416   ModuleFile *M = GlobalSLocEntryMap.find(-ID)->second;
1417   if (!M->isModule())
1418     return std::make_pair(SourceLocation(), "");
1419 
1420   // FIXME: Can we map this down to a particular submodule? That would be
1421   // ideal.
1422   return std::make_pair(M->ImportLoc, StringRef(M->ModuleName));
1423 }
1424 
1425 /// \brief Find the location where the module F is imported.
1426 SourceLocation ASTReader::getImportLocation(ModuleFile *F) {
1427   if (F->ImportLoc.isValid())
1428     return F->ImportLoc;
1429 
1430   // Otherwise we have a PCH. It's considered to be "imported" at the first
1431   // location of its includer.
1432   if (F->ImportedBy.empty() || !F->ImportedBy[0]) {
1433     // Main file is the importer.
1434     assert(SourceMgr.getMainFileID().isValid() && "missing main file");
1435     return SourceMgr.getLocForStartOfFile(SourceMgr.getMainFileID());
1436   }
1437   return F->ImportedBy[0]->FirstLoc;
1438 }
1439 
1440 /// ReadBlockAbbrevs - Enter a subblock of the specified BlockID with the
1441 /// specified cursor.  Read the abbreviations that are at the top of the block
1442 /// and then leave the cursor pointing into the block.
1443 bool ASTReader::ReadBlockAbbrevs(BitstreamCursor &Cursor, unsigned BlockID) {
1444   if (Cursor.EnterSubBlock(BlockID))
1445     return true;
1446 
1447   while (true) {
1448     uint64_t Offset = Cursor.GetCurrentBitNo();
1449     unsigned Code = Cursor.ReadCode();
1450 
1451     // We expect all abbrevs to be at the start of the block.
1452     if (Code != llvm::bitc::DEFINE_ABBREV) {
1453       Cursor.JumpToBit(Offset);
1454       return false;
1455     }
1456     Cursor.ReadAbbrevRecord();
1457   }
1458 }
1459 
1460 Token ASTReader::ReadToken(ModuleFile &F, const RecordDataImpl &Record,
1461                            unsigned &Idx) {
1462   Token Tok;
1463   Tok.startToken();
1464   Tok.setLocation(ReadSourceLocation(F, Record, Idx));
1465   Tok.setLength(Record[Idx++]);
1466   if (IdentifierInfo *II = getLocalIdentifier(F, Record[Idx++]))
1467     Tok.setIdentifierInfo(II);
1468   Tok.setKind((tok::TokenKind)Record[Idx++]);
1469   Tok.setFlag((Token::TokenFlags)Record[Idx++]);
1470   return Tok;
1471 }
1472 
1473 MacroInfo *ASTReader::ReadMacroRecord(ModuleFile &F, uint64_t Offset) {
1474   BitstreamCursor &Stream = F.MacroCursor;
1475 
1476   // Keep track of where we are in the stream, then jump back there
1477   // after reading this macro.
1478   SavedStreamPosition SavedPosition(Stream);
1479 
1480   Stream.JumpToBit(Offset);
1481   RecordData Record;
1482   SmallVector<IdentifierInfo*, 16> MacroArgs;
1483   MacroInfo *Macro = nullptr;
1484 
1485   while (true) {
1486     // Advance to the next record, but if we get to the end of the block, don't
1487     // pop it (removing all the abbreviations from the cursor) since we want to
1488     // be able to reseek within the block and read entries.
1489     unsigned Flags = BitstreamCursor::AF_DontPopBlockAtEnd;
1490     llvm::BitstreamEntry Entry = Stream.advanceSkippingSubblocks(Flags);
1491 
1492     switch (Entry.Kind) {
1493     case llvm::BitstreamEntry::SubBlock: // Handled for us already.
1494     case llvm::BitstreamEntry::Error:
1495       Error("malformed block record in AST file");
1496       return Macro;
1497     case llvm::BitstreamEntry::EndBlock:
1498       return Macro;
1499     case llvm::BitstreamEntry::Record:
1500       // The interesting case.
1501       break;
1502     }
1503 
1504     // Read a record.
1505     Record.clear();
1506     PreprocessorRecordTypes RecType =
1507       (PreprocessorRecordTypes)Stream.readRecord(Entry.ID, Record);
1508     switch (RecType) {
1509     case PP_MODULE_MACRO:
1510     case PP_MACRO_DIRECTIVE_HISTORY:
1511       return Macro;
1512 
1513     case PP_MACRO_OBJECT_LIKE:
1514     case PP_MACRO_FUNCTION_LIKE: {
1515       // If we already have a macro, that means that we've hit the end
1516       // of the definition of the macro we were looking for. We're
1517       // done.
1518       if (Macro)
1519         return Macro;
1520 
1521       unsigned NextIndex = 1; // Skip identifier ID.
1522       SubmoduleID SubModID = getGlobalSubmoduleID(F, Record[NextIndex++]);
1523       SourceLocation Loc = ReadSourceLocation(F, Record, NextIndex);
1524       MacroInfo *MI = PP.AllocateDeserializedMacroInfo(Loc, SubModID);
1525       MI->setDefinitionEndLoc(ReadSourceLocation(F, Record, NextIndex));
1526       MI->setIsUsed(Record[NextIndex++]);
1527       MI->setUsedForHeaderGuard(Record[NextIndex++]);
1528 
1529       if (RecType == PP_MACRO_FUNCTION_LIKE) {
1530         // Decode function-like macro info.
1531         bool isC99VarArgs = Record[NextIndex++];
1532         bool isGNUVarArgs = Record[NextIndex++];
1533         bool hasCommaPasting = Record[NextIndex++];
1534         MacroArgs.clear();
1535         unsigned NumArgs = Record[NextIndex++];
1536         for (unsigned i = 0; i != NumArgs; ++i)
1537           MacroArgs.push_back(getLocalIdentifier(F, Record[NextIndex++]));
1538 
1539         // Install function-like macro info.
1540         MI->setIsFunctionLike();
1541         if (isC99VarArgs) MI->setIsC99Varargs();
1542         if (isGNUVarArgs) MI->setIsGNUVarargs();
1543         if (hasCommaPasting) MI->setHasCommaPasting();
1544         MI->setArgumentList(MacroArgs, PP.getPreprocessorAllocator());
1545       }
1546 
1547       // Remember that we saw this macro last so that we add the tokens that
1548       // form its body to it.
1549       Macro = MI;
1550 
1551       if (NextIndex + 1 == Record.size() && PP.getPreprocessingRecord() &&
1552           Record[NextIndex]) {
1553         // We have a macro definition. Register the association
1554         PreprocessedEntityID
1555             GlobalID = getGlobalPreprocessedEntityID(F, Record[NextIndex]);
1556         PreprocessingRecord &PPRec = *PP.getPreprocessingRecord();
1557         PreprocessingRecord::PPEntityID PPID =
1558             PPRec.getPPEntityID(GlobalID - 1, /*isLoaded=*/true);
1559         MacroDefinitionRecord *PPDef = cast_or_null<MacroDefinitionRecord>(
1560             PPRec.getPreprocessedEntity(PPID));
1561         if (PPDef)
1562           PPRec.RegisterMacroDefinition(Macro, PPDef);
1563       }
1564 
1565       ++NumMacrosRead;
1566       break;
1567     }
1568 
1569     case PP_TOKEN: {
1570       // If we see a TOKEN before a PP_MACRO_*, then the file is
1571       // erroneous, just pretend we didn't see this.
1572       if (!Macro) break;
1573 
1574       unsigned Idx = 0;
1575       Token Tok = ReadToken(F, Record, Idx);
1576       Macro->AddTokenToBody(Tok);
1577       break;
1578     }
1579     }
1580   }
1581 }
1582 
1583 PreprocessedEntityID
1584 ASTReader::getGlobalPreprocessedEntityID(ModuleFile &M, unsigned LocalID) const {
1585   ContinuousRangeMap<uint32_t, int, 2>::const_iterator
1586     I = M.PreprocessedEntityRemap.find(LocalID - NUM_PREDEF_PP_ENTITY_IDS);
1587   assert(I != M.PreprocessedEntityRemap.end()
1588          && "Invalid index into preprocessed entity index remap");
1589 
1590   return LocalID + I->second;
1591 }
1592 
1593 unsigned HeaderFileInfoTrait::ComputeHash(internal_key_ref ikey) {
1594   return llvm::hash_combine(ikey.Size, ikey.ModTime);
1595 }
1596 
1597 HeaderFileInfoTrait::internal_key_type
1598 HeaderFileInfoTrait::GetInternalKey(const FileEntry *FE) {
1599   internal_key_type ikey = {FE->getSize(),
1600                             M.HasTimestamps ? FE->getModificationTime() : 0,
1601                             FE->getName(), /*Imported*/ false};
1602   return ikey;
1603 }
1604 
1605 bool HeaderFileInfoTrait::EqualKey(internal_key_ref a, internal_key_ref b) {
1606   if (a.Size != b.Size || (a.ModTime && b.ModTime && a.ModTime != b.ModTime))
1607     return false;
1608 
1609   if (llvm::sys::path::is_absolute(a.Filename) && a.Filename == b.Filename)
1610     return true;
1611 
1612   // Determine whether the actual files are equivalent.
1613   FileManager &FileMgr = Reader.getFileManager();
1614   auto GetFile = [&](const internal_key_type &Key) -> const FileEntry* {
1615     if (!Key.Imported)
1616       return FileMgr.getFile(Key.Filename);
1617 
1618     std::string Resolved = Key.Filename;
1619     Reader.ResolveImportedPath(M, Resolved);
1620     return FileMgr.getFile(Resolved);
1621   };
1622 
1623   const FileEntry *FEA = GetFile(a);
1624   const FileEntry *FEB = GetFile(b);
1625   return FEA && FEA == FEB;
1626 }
1627 
1628 std::pair<unsigned, unsigned>
1629 HeaderFileInfoTrait::ReadKeyDataLength(const unsigned char*& d) {
1630   using namespace llvm::support;
1631   unsigned KeyLen = (unsigned) endian::readNext<uint16_t, little, unaligned>(d);
1632   unsigned DataLen = (unsigned) *d++;
1633   return std::make_pair(KeyLen, DataLen);
1634 }
1635 
1636 HeaderFileInfoTrait::internal_key_type
1637 HeaderFileInfoTrait::ReadKey(const unsigned char *d, unsigned) {
1638   using namespace llvm::support;
1639   internal_key_type ikey;
1640   ikey.Size = off_t(endian::readNext<uint64_t, little, unaligned>(d));
1641   ikey.ModTime = time_t(endian::readNext<uint64_t, little, unaligned>(d));
1642   ikey.Filename = (const char *)d;
1643   ikey.Imported = true;
1644   return ikey;
1645 }
1646 
1647 HeaderFileInfoTrait::data_type
1648 HeaderFileInfoTrait::ReadData(internal_key_ref key, const unsigned char *d,
1649                               unsigned DataLen) {
1650   const unsigned char *End = d + DataLen;
1651   using namespace llvm::support;
1652   HeaderFileInfo HFI;
1653   unsigned Flags = *d++;
1654   // FIXME: Refactor with mergeHeaderFileInfo in HeaderSearch.cpp.
1655   HFI.isImport |= (Flags >> 4) & 0x01;
1656   HFI.isPragmaOnce |= (Flags >> 3) & 0x01;
1657   HFI.DirInfo = (Flags >> 1) & 0x03;
1658   HFI.IndexHeaderMapHeader = Flags & 0x01;
1659   // FIXME: Find a better way to handle this. Maybe just store a
1660   // "has been included" flag?
1661   HFI.NumIncludes = std::max(endian::readNext<uint16_t, little, unaligned>(d),
1662                              HFI.NumIncludes);
1663   HFI.ControllingMacroID = Reader.getGlobalIdentifierID(
1664       M, endian::readNext<uint32_t, little, unaligned>(d));
1665   if (unsigned FrameworkOffset =
1666           endian::readNext<uint32_t, little, unaligned>(d)) {
1667     // The framework offset is 1 greater than the actual offset,
1668     // since 0 is used as an indicator for "no framework name".
1669     StringRef FrameworkName(FrameworkStrings + FrameworkOffset - 1);
1670     HFI.Framework = HS->getUniqueFrameworkName(FrameworkName);
1671   }
1672 
1673   assert((End - d) % 4 == 0 &&
1674          "Wrong data length in HeaderFileInfo deserialization");
1675   while (d != End) {
1676     uint32_t LocalSMID = endian::readNext<uint32_t, little, unaligned>(d);
1677     auto HeaderRole = static_cast<ModuleMap::ModuleHeaderRole>(LocalSMID & 3);
1678     LocalSMID >>= 2;
1679 
1680     // This header is part of a module. Associate it with the module to enable
1681     // implicit module import.
1682     SubmoduleID GlobalSMID = Reader.getGlobalSubmoduleID(M, LocalSMID);
1683     Module *Mod = Reader.getSubmodule(GlobalSMID);
1684     FileManager &FileMgr = Reader.getFileManager();
1685     ModuleMap &ModMap =
1686         Reader.getPreprocessor().getHeaderSearchInfo().getModuleMap();
1687 
1688     std::string Filename = key.Filename;
1689     if (key.Imported)
1690       Reader.ResolveImportedPath(M, Filename);
1691     // FIXME: This is not always the right filename-as-written, but we're not
1692     // going to use this information to rebuild the module, so it doesn't make
1693     // a lot of difference.
1694     Module::Header H = { key.Filename, FileMgr.getFile(Filename) };
1695     ModMap.addHeader(Mod, H, HeaderRole, /*Imported*/true);
1696     HFI.isModuleHeader |= !(HeaderRole & ModuleMap::TextualHeader);
1697   }
1698 
1699   // This HeaderFileInfo was externally loaded.
1700   HFI.External = true;
1701   HFI.IsValid = true;
1702   return HFI;
1703 }
1704 
1705 void ASTReader::addPendingMacro(IdentifierInfo *II,
1706                                 ModuleFile *M,
1707                                 uint64_t MacroDirectivesOffset) {
1708   assert(NumCurrentElementsDeserializing > 0 &&"Missing deserialization guard");
1709   PendingMacroIDs[II].push_back(PendingMacroInfo(M, MacroDirectivesOffset));
1710 }
1711 
1712 void ASTReader::ReadDefinedMacros() {
1713   // Note that we are loading defined macros.
1714   Deserializing Macros(this);
1715 
1716   for (auto &I : llvm::reverse(ModuleMgr)) {
1717     BitstreamCursor &MacroCursor = I->MacroCursor;
1718 
1719     // If there was no preprocessor block, skip this file.
1720     if (MacroCursor.getBitcodeBytes().empty())
1721       continue;
1722 
1723     BitstreamCursor Cursor = MacroCursor;
1724     Cursor.JumpToBit(I->MacroStartOffset);
1725 
1726     RecordData Record;
1727     while (true) {
1728       llvm::BitstreamEntry E = Cursor.advanceSkippingSubblocks();
1729 
1730       switch (E.Kind) {
1731       case llvm::BitstreamEntry::SubBlock: // Handled for us already.
1732       case llvm::BitstreamEntry::Error:
1733         Error("malformed block record in AST file");
1734         return;
1735       case llvm::BitstreamEntry::EndBlock:
1736         goto NextCursor;
1737 
1738       case llvm::BitstreamEntry::Record:
1739         Record.clear();
1740         switch (Cursor.readRecord(E.ID, Record)) {
1741         default:  // Default behavior: ignore.
1742           break;
1743 
1744         case PP_MACRO_OBJECT_LIKE:
1745         case PP_MACRO_FUNCTION_LIKE: {
1746           IdentifierInfo *II = getLocalIdentifier(*I, Record[0]);
1747           if (II->isOutOfDate())
1748             updateOutOfDateIdentifier(*II);
1749           break;
1750         }
1751 
1752         case PP_TOKEN:
1753           // Ignore tokens.
1754           break;
1755         }
1756         break;
1757       }
1758     }
1759     NextCursor:  ;
1760   }
1761 }
1762 
1763 namespace {
1764 
1765   /// \brief Visitor class used to look up identifirs in an AST file.
1766   class IdentifierLookupVisitor {
1767     StringRef Name;
1768     unsigned NameHash;
1769     unsigned PriorGeneration;
1770     unsigned &NumIdentifierLookups;
1771     unsigned &NumIdentifierLookupHits;
1772     IdentifierInfo *Found;
1773 
1774   public:
1775     IdentifierLookupVisitor(StringRef Name, unsigned PriorGeneration,
1776                             unsigned &NumIdentifierLookups,
1777                             unsigned &NumIdentifierLookupHits)
1778       : Name(Name), NameHash(ASTIdentifierLookupTrait::ComputeHash(Name)),
1779         PriorGeneration(PriorGeneration),
1780         NumIdentifierLookups(NumIdentifierLookups),
1781         NumIdentifierLookupHits(NumIdentifierLookupHits),
1782         Found()
1783     {
1784     }
1785 
1786     bool operator()(ModuleFile &M) {
1787       // If we've already searched this module file, skip it now.
1788       if (M.Generation <= PriorGeneration)
1789         return true;
1790 
1791       ASTIdentifierLookupTable *IdTable
1792         = (ASTIdentifierLookupTable *)M.IdentifierLookupTable;
1793       if (!IdTable)
1794         return false;
1795 
1796       ASTIdentifierLookupTrait Trait(IdTable->getInfoObj().getReader(), M,
1797                                      Found);
1798       ++NumIdentifierLookups;
1799       ASTIdentifierLookupTable::iterator Pos =
1800           IdTable->find_hashed(Name, NameHash, &Trait);
1801       if (Pos == IdTable->end())
1802         return false;
1803 
1804       // Dereferencing the iterator has the effect of building the
1805       // IdentifierInfo node and populating it with the various
1806       // declarations it needs.
1807       ++NumIdentifierLookupHits;
1808       Found = *Pos;
1809       return true;
1810     }
1811 
1812     // \brief Retrieve the identifier info found within the module
1813     // files.
1814     IdentifierInfo *getIdentifierInfo() const { return Found; }
1815   };
1816 
1817 } // end anonymous namespace
1818 
1819 void ASTReader::updateOutOfDateIdentifier(IdentifierInfo &II) {
1820   // Note that we are loading an identifier.
1821   Deserializing AnIdentifier(this);
1822 
1823   unsigned PriorGeneration = 0;
1824   if (getContext().getLangOpts().Modules)
1825     PriorGeneration = IdentifierGeneration[&II];
1826 
1827   // If there is a global index, look there first to determine which modules
1828   // provably do not have any results for this identifier.
1829   GlobalModuleIndex::HitSet Hits;
1830   GlobalModuleIndex::HitSet *HitsPtr = nullptr;
1831   if (!loadGlobalIndex()) {
1832     if (GlobalIndex->lookupIdentifier(II.getName(), Hits)) {
1833       HitsPtr = &Hits;
1834     }
1835   }
1836 
1837   IdentifierLookupVisitor Visitor(II.getName(), PriorGeneration,
1838                                   NumIdentifierLookups,
1839                                   NumIdentifierLookupHits);
1840   ModuleMgr.visit(Visitor, HitsPtr);
1841   markIdentifierUpToDate(&II);
1842 }
1843 
1844 void ASTReader::markIdentifierUpToDate(IdentifierInfo *II) {
1845   if (!II)
1846     return;
1847 
1848   II->setOutOfDate(false);
1849 
1850   // Update the generation for this identifier.
1851   if (getContext().getLangOpts().Modules)
1852     IdentifierGeneration[II] = getGeneration();
1853 }
1854 
1855 void ASTReader::resolvePendingMacro(IdentifierInfo *II,
1856                                     const PendingMacroInfo &PMInfo) {
1857   ModuleFile &M = *PMInfo.M;
1858 
1859   BitstreamCursor &Cursor = M.MacroCursor;
1860   SavedStreamPosition SavedPosition(Cursor);
1861   Cursor.JumpToBit(PMInfo.MacroDirectivesOffset);
1862 
1863   struct ModuleMacroRecord {
1864     SubmoduleID SubModID;
1865     MacroInfo *MI;
1866     SmallVector<SubmoduleID, 8> Overrides;
1867   };
1868   llvm::SmallVector<ModuleMacroRecord, 8> ModuleMacros;
1869 
1870   // We expect to see a sequence of PP_MODULE_MACRO records listing exported
1871   // macros, followed by a PP_MACRO_DIRECTIVE_HISTORY record with the complete
1872   // macro histroy.
1873   RecordData Record;
1874   while (true) {
1875     llvm::BitstreamEntry Entry =
1876         Cursor.advance(BitstreamCursor::AF_DontPopBlockAtEnd);
1877     if (Entry.Kind != llvm::BitstreamEntry::Record) {
1878       Error("malformed block record in AST file");
1879       return;
1880     }
1881 
1882     Record.clear();
1883     switch ((PreprocessorRecordTypes)Cursor.readRecord(Entry.ID, Record)) {
1884     case PP_MACRO_DIRECTIVE_HISTORY:
1885       break;
1886 
1887     case PP_MODULE_MACRO: {
1888       ModuleMacros.push_back(ModuleMacroRecord());
1889       auto &Info = ModuleMacros.back();
1890       Info.SubModID = getGlobalSubmoduleID(M, Record[0]);
1891       Info.MI = getMacro(getGlobalMacroID(M, Record[1]));
1892       for (int I = 2, N = Record.size(); I != N; ++I)
1893         Info.Overrides.push_back(getGlobalSubmoduleID(M, Record[I]));
1894       continue;
1895     }
1896 
1897     default:
1898       Error("malformed block record in AST file");
1899       return;
1900     }
1901 
1902     // We found the macro directive history; that's the last record
1903     // for this macro.
1904     break;
1905   }
1906 
1907   // Module macros are listed in reverse dependency order.
1908   {
1909     std::reverse(ModuleMacros.begin(), ModuleMacros.end());
1910     llvm::SmallVector<ModuleMacro*, 8> Overrides;
1911     for (auto &MMR : ModuleMacros) {
1912       Overrides.clear();
1913       for (unsigned ModID : MMR.Overrides) {
1914         Module *Mod = getSubmodule(ModID);
1915         auto *Macro = PP.getModuleMacro(Mod, II);
1916         assert(Macro && "missing definition for overridden macro");
1917         Overrides.push_back(Macro);
1918       }
1919 
1920       bool Inserted = false;
1921       Module *Owner = getSubmodule(MMR.SubModID);
1922       PP.addModuleMacro(Owner, II, MMR.MI, Overrides, Inserted);
1923     }
1924   }
1925 
1926   // Don't read the directive history for a module; we don't have anywhere
1927   // to put it.
1928   if (M.isModule())
1929     return;
1930 
1931   // Deserialize the macro directives history in reverse source-order.
1932   MacroDirective *Latest = nullptr, *Earliest = nullptr;
1933   unsigned Idx = 0, N = Record.size();
1934   while (Idx < N) {
1935     MacroDirective *MD = nullptr;
1936     SourceLocation Loc = ReadSourceLocation(M, Record, Idx);
1937     MacroDirective::Kind K = (MacroDirective::Kind)Record[Idx++];
1938     switch (K) {
1939     case MacroDirective::MD_Define: {
1940       MacroInfo *MI = getMacro(getGlobalMacroID(M, Record[Idx++]));
1941       MD = PP.AllocateDefMacroDirective(MI, Loc);
1942       break;
1943     }
1944     case MacroDirective::MD_Undefine: {
1945       MD = PP.AllocateUndefMacroDirective(Loc);
1946       break;
1947     }
1948     case MacroDirective::MD_Visibility:
1949       bool isPublic = Record[Idx++];
1950       MD = PP.AllocateVisibilityMacroDirective(Loc, isPublic);
1951       break;
1952     }
1953 
1954     if (!Latest)
1955       Latest = MD;
1956     if (Earliest)
1957       Earliest->setPrevious(MD);
1958     Earliest = MD;
1959   }
1960 
1961   if (Latest)
1962     PP.setLoadedMacroDirective(II, Earliest, Latest);
1963 }
1964 
1965 ASTReader::InputFileInfo
1966 ASTReader::readInputFileInfo(ModuleFile &F, unsigned ID) {
1967   // Go find this input file.
1968   BitstreamCursor &Cursor = F.InputFilesCursor;
1969   SavedStreamPosition SavedPosition(Cursor);
1970   Cursor.JumpToBit(F.InputFileOffsets[ID-1]);
1971 
1972   unsigned Code = Cursor.ReadCode();
1973   RecordData Record;
1974   StringRef Blob;
1975 
1976   unsigned Result = Cursor.readRecord(Code, Record, &Blob);
1977   assert(static_cast<InputFileRecordTypes>(Result) == INPUT_FILE &&
1978          "invalid record type for input file");
1979   (void)Result;
1980 
1981   assert(Record[0] == ID && "Bogus stored ID or offset");
1982   InputFileInfo R;
1983   R.StoredSize = static_cast<off_t>(Record[1]);
1984   R.StoredTime = static_cast<time_t>(Record[2]);
1985   R.Overridden = static_cast<bool>(Record[3]);
1986   R.Transient = static_cast<bool>(Record[4]);
1987   R.Filename = Blob;
1988   ResolveImportedPath(F, R.Filename);
1989   return R;
1990 }
1991 
1992 static unsigned moduleKindForDiagnostic(ModuleKind Kind);
1993 InputFile ASTReader::getInputFile(ModuleFile &F, unsigned ID, bool Complain) {
1994   // If this ID is bogus, just return an empty input file.
1995   if (ID == 0 || ID > F.InputFilesLoaded.size())
1996     return InputFile();
1997 
1998   // If we've already loaded this input file, return it.
1999   if (F.InputFilesLoaded[ID-1].getFile())
2000     return F.InputFilesLoaded[ID-1];
2001 
2002   if (F.InputFilesLoaded[ID-1].isNotFound())
2003     return InputFile();
2004 
2005   // Go find this input file.
2006   BitstreamCursor &Cursor = F.InputFilesCursor;
2007   SavedStreamPosition SavedPosition(Cursor);
2008   Cursor.JumpToBit(F.InputFileOffsets[ID-1]);
2009 
2010   InputFileInfo FI = readInputFileInfo(F, ID);
2011   off_t StoredSize = FI.StoredSize;
2012   time_t StoredTime = FI.StoredTime;
2013   bool Overridden = FI.Overridden;
2014   bool Transient = FI.Transient;
2015   StringRef Filename = FI.Filename;
2016 
2017   const FileEntry *File = FileMgr.getFile(Filename, /*OpenFile=*/false);
2018 
2019   // If we didn't find the file, resolve it relative to the
2020   // original directory from which this AST file was created.
2021   if (File == nullptr && !F.OriginalDir.empty() && !CurrentDir.empty() &&
2022       F.OriginalDir != CurrentDir) {
2023     std::string Resolved = resolveFileRelativeToOriginalDir(Filename,
2024                                                             F.OriginalDir,
2025                                                             CurrentDir);
2026     if (!Resolved.empty())
2027       File = FileMgr.getFile(Resolved);
2028   }
2029 
2030   // For an overridden file, create a virtual file with the stored
2031   // size/timestamp.
2032   if ((Overridden || Transient) && File == nullptr)
2033     File = FileMgr.getVirtualFile(Filename, StoredSize, StoredTime);
2034 
2035   if (File == nullptr) {
2036     if (Complain) {
2037       std::string ErrorStr = "could not find file '";
2038       ErrorStr += Filename;
2039       ErrorStr += "' referenced by AST file '";
2040       ErrorStr += F.FileName;
2041       ErrorStr += "'";
2042       Error(ErrorStr);
2043     }
2044     // Record that we didn't find the file.
2045     F.InputFilesLoaded[ID-1] = InputFile::getNotFound();
2046     return InputFile();
2047   }
2048 
2049   // Check if there was a request to override the contents of the file
2050   // that was part of the precompiled header. Overridding such a file
2051   // can lead to problems when lexing using the source locations from the
2052   // PCH.
2053   SourceManager &SM = getSourceManager();
2054   // FIXME: Reject if the overrides are different.
2055   if ((!Overridden && !Transient) && SM.isFileOverridden(File)) {
2056     if (Complain)
2057       Error(diag::err_fe_pch_file_overridden, Filename);
2058     // After emitting the diagnostic, recover by disabling the override so
2059     // that the original file will be used.
2060     //
2061     // FIXME: This recovery is just as broken as the original state; there may
2062     // be another precompiled module that's using the overridden contents, or
2063     // we might be half way through parsing it. Instead, we should treat the
2064     // overridden contents as belonging to a separate FileEntry.
2065     SM.disableFileContentsOverride(File);
2066     // The FileEntry is a virtual file entry with the size of the contents
2067     // that would override the original contents. Set it to the original's
2068     // size/time.
2069     FileMgr.modifyFileEntry(const_cast<FileEntry*>(File),
2070                             StoredSize, StoredTime);
2071   }
2072 
2073   bool IsOutOfDate = false;
2074 
2075   // For an overridden file, there is nothing to validate.
2076   if (!Overridden && //
2077       (StoredSize != File->getSize() ||
2078        (StoredTime && StoredTime != File->getModificationTime() &&
2079         !DisableValidation)
2080        )) {
2081     if (Complain) {
2082       // Build a list of the PCH imports that got us here (in reverse).
2083       SmallVector<ModuleFile *, 4> ImportStack(1, &F);
2084       while (ImportStack.back()->ImportedBy.size() > 0)
2085         ImportStack.push_back(ImportStack.back()->ImportedBy[0]);
2086 
2087       // The top-level PCH is stale.
2088       StringRef TopLevelPCHName(ImportStack.back()->FileName);
2089       unsigned DiagnosticKind = moduleKindForDiagnostic(ImportStack.back()->Kind);
2090       if (DiagnosticKind == 0)
2091         Error(diag::err_fe_pch_file_modified, Filename, TopLevelPCHName);
2092       else if (DiagnosticKind == 1)
2093         Error(diag::err_fe_module_file_modified, Filename, TopLevelPCHName);
2094       else
2095         Error(diag::err_fe_ast_file_modified, Filename, TopLevelPCHName);
2096 
2097       // Print the import stack.
2098       if (ImportStack.size() > 1 && !Diags.isDiagnosticInFlight()) {
2099         Diag(diag::note_pch_required_by)
2100           << Filename << ImportStack[0]->FileName;
2101         for (unsigned I = 1; I < ImportStack.size(); ++I)
2102           Diag(diag::note_pch_required_by)
2103             << ImportStack[I-1]->FileName << ImportStack[I]->FileName;
2104       }
2105 
2106       if (!Diags.isDiagnosticInFlight())
2107         Diag(diag::note_pch_rebuild_required) << TopLevelPCHName;
2108     }
2109 
2110     IsOutOfDate = true;
2111   }
2112   // FIXME: If the file is overridden and we've already opened it,
2113   // issue an error (or split it into a separate FileEntry).
2114 
2115   InputFile IF = InputFile(File, Overridden || Transient, IsOutOfDate);
2116 
2117   // Note that we've loaded this input file.
2118   F.InputFilesLoaded[ID-1] = IF;
2119   return IF;
2120 }
2121 
2122 /// \brief If we are loading a relocatable PCH or module file, and the filename
2123 /// is not an absolute path, add the system or module root to the beginning of
2124 /// the file name.
2125 void ASTReader::ResolveImportedPath(ModuleFile &M, std::string &Filename) {
2126   // Resolve relative to the base directory, if we have one.
2127   if (!M.BaseDirectory.empty())
2128     return ResolveImportedPath(Filename, M.BaseDirectory);
2129 }
2130 
2131 void ASTReader::ResolveImportedPath(std::string &Filename, StringRef Prefix) {
2132   if (Filename.empty() || llvm::sys::path::is_absolute(Filename))
2133     return;
2134 
2135   SmallString<128> Buffer;
2136   llvm::sys::path::append(Buffer, Prefix, Filename);
2137   Filename.assign(Buffer.begin(), Buffer.end());
2138 }
2139 
2140 static bool isDiagnosedResult(ASTReader::ASTReadResult ARR, unsigned Caps) {
2141   switch (ARR) {
2142   case ASTReader::Failure: return true;
2143   case ASTReader::Missing: return !(Caps & ASTReader::ARR_Missing);
2144   case ASTReader::OutOfDate: return !(Caps & ASTReader::ARR_OutOfDate);
2145   case ASTReader::VersionMismatch: return !(Caps & ASTReader::ARR_VersionMismatch);
2146   case ASTReader::ConfigurationMismatch:
2147     return !(Caps & ASTReader::ARR_ConfigurationMismatch);
2148   case ASTReader::HadErrors: return true;
2149   case ASTReader::Success: return false;
2150   }
2151 
2152   llvm_unreachable("unknown ASTReadResult");
2153 }
2154 
2155 ASTReader::ASTReadResult ASTReader::ReadOptionsBlock(
2156     BitstreamCursor &Stream, unsigned ClientLoadCapabilities,
2157     bool AllowCompatibleConfigurationMismatch, ASTReaderListener &Listener,
2158     std::string &SuggestedPredefines, bool ValidateDiagnosticOptions) {
2159   if (Stream.EnterSubBlock(OPTIONS_BLOCK_ID))
2160     return Failure;
2161 
2162   // Read all of the records in the options block.
2163   RecordData Record;
2164   ASTReadResult Result = Success;
2165   while (true) {
2166     llvm::BitstreamEntry Entry = Stream.advance();
2167 
2168     switch (Entry.Kind) {
2169     case llvm::BitstreamEntry::Error:
2170     case llvm::BitstreamEntry::SubBlock:
2171       return Failure;
2172 
2173     case llvm::BitstreamEntry::EndBlock:
2174       return Result;
2175 
2176     case llvm::BitstreamEntry::Record:
2177       // The interesting case.
2178       break;
2179     }
2180 
2181     // Read and process a record.
2182     Record.clear();
2183     switch ((OptionsRecordTypes)Stream.readRecord(Entry.ID, Record)) {
2184     case LANGUAGE_OPTIONS: {
2185       bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2186       if (ParseLanguageOptions(Record, Complain, Listener,
2187                                AllowCompatibleConfigurationMismatch))
2188         Result = ConfigurationMismatch;
2189       break;
2190     }
2191 
2192     case TARGET_OPTIONS: {
2193       bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2194       if (ParseTargetOptions(Record, Complain, Listener,
2195                              AllowCompatibleConfigurationMismatch))
2196         Result = ConfigurationMismatch;
2197       break;
2198     }
2199 
2200     case DIAGNOSTIC_OPTIONS: {
2201       bool Complain = (ClientLoadCapabilities & ARR_OutOfDate) == 0;
2202       if (ValidateDiagnosticOptions &&
2203           !AllowCompatibleConfigurationMismatch &&
2204           ParseDiagnosticOptions(Record, Complain, Listener))
2205         return OutOfDate;
2206       break;
2207     }
2208 
2209     case FILE_SYSTEM_OPTIONS: {
2210       bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2211       if (!AllowCompatibleConfigurationMismatch &&
2212           ParseFileSystemOptions(Record, Complain, Listener))
2213         Result = ConfigurationMismatch;
2214       break;
2215     }
2216 
2217     case HEADER_SEARCH_OPTIONS: {
2218       bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2219       if (!AllowCompatibleConfigurationMismatch &&
2220           ParseHeaderSearchOptions(Record, Complain, Listener))
2221         Result = ConfigurationMismatch;
2222       break;
2223     }
2224 
2225     case PREPROCESSOR_OPTIONS:
2226       bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2227       if (!AllowCompatibleConfigurationMismatch &&
2228           ParsePreprocessorOptions(Record, Complain, Listener,
2229                                    SuggestedPredefines))
2230         Result = ConfigurationMismatch;
2231       break;
2232     }
2233   }
2234 }
2235 
2236 ASTReader::ASTReadResult
2237 ASTReader::ReadControlBlock(ModuleFile &F,
2238                             SmallVectorImpl<ImportedModule> &Loaded,
2239                             const ModuleFile *ImportedBy,
2240                             unsigned ClientLoadCapabilities) {
2241   BitstreamCursor &Stream = F.Stream;
2242   ASTReadResult Result = Success;
2243 
2244   if (Stream.EnterSubBlock(CONTROL_BLOCK_ID)) {
2245     Error("malformed block record in AST file");
2246     return Failure;
2247   }
2248 
2249   // Read all of the records and blocks in the control block.
2250   RecordData Record;
2251   unsigned NumInputs = 0;
2252   unsigned NumUserInputs = 0;
2253   while (true) {
2254     llvm::BitstreamEntry Entry = Stream.advance();
2255 
2256     switch (Entry.Kind) {
2257     case llvm::BitstreamEntry::Error:
2258       Error("malformed block record in AST file");
2259       return Failure;
2260     case llvm::BitstreamEntry::EndBlock: {
2261       // Validate input files.
2262       const HeaderSearchOptions &HSOpts =
2263           PP.getHeaderSearchInfo().getHeaderSearchOpts();
2264 
2265       // All user input files reside at the index range [0, NumUserInputs), and
2266       // system input files reside at [NumUserInputs, NumInputs). For explicitly
2267       // loaded module files, ignore missing inputs.
2268       if (!DisableValidation && F.Kind != MK_ExplicitModule &&
2269           F.Kind != MK_PrebuiltModule) {
2270         bool Complain = (ClientLoadCapabilities & ARR_OutOfDate) == 0;
2271 
2272         // If we are reading a module, we will create a verification timestamp,
2273         // so we verify all input files.  Otherwise, verify only user input
2274         // files.
2275 
2276         unsigned N = NumUserInputs;
2277         if (ValidateSystemInputs ||
2278             (HSOpts.ModulesValidateOncePerBuildSession &&
2279              F.InputFilesValidationTimestamp <= HSOpts.BuildSessionTimestamp &&
2280              F.Kind == MK_ImplicitModule))
2281           N = NumInputs;
2282 
2283         for (unsigned I = 0; I < N; ++I) {
2284           InputFile IF = getInputFile(F, I+1, Complain);
2285           if (!IF.getFile() || IF.isOutOfDate())
2286             return OutOfDate;
2287         }
2288       }
2289 
2290       if (Listener)
2291         Listener->visitModuleFile(F.FileName, F.Kind);
2292 
2293       if (Listener && Listener->needsInputFileVisitation()) {
2294         unsigned N = Listener->needsSystemInputFileVisitation() ? NumInputs
2295                                                                 : NumUserInputs;
2296         for (unsigned I = 0; I < N; ++I) {
2297           bool IsSystem = I >= NumUserInputs;
2298           InputFileInfo FI = readInputFileInfo(F, I+1);
2299           Listener->visitInputFile(FI.Filename, IsSystem, FI.Overridden,
2300                                    F.Kind == MK_ExplicitModule ||
2301                                    F.Kind == MK_PrebuiltModule);
2302         }
2303       }
2304 
2305       return Result;
2306     }
2307 
2308     case llvm::BitstreamEntry::SubBlock:
2309       switch (Entry.ID) {
2310       case INPUT_FILES_BLOCK_ID:
2311         F.InputFilesCursor = Stream;
2312         if (Stream.SkipBlock() || // Skip with the main cursor
2313             // Read the abbreviations
2314             ReadBlockAbbrevs(F.InputFilesCursor, INPUT_FILES_BLOCK_ID)) {
2315           Error("malformed block record in AST file");
2316           return Failure;
2317         }
2318         continue;
2319 
2320       case OPTIONS_BLOCK_ID:
2321         // If we're reading the first module for this group, check its options
2322         // are compatible with ours. For modules it imports, no further checking
2323         // is required, because we checked them when we built it.
2324         if (Listener && !ImportedBy) {
2325           // Should we allow the configuration of the module file to differ from
2326           // the configuration of the current translation unit in a compatible
2327           // way?
2328           //
2329           // FIXME: Allow this for files explicitly specified with -include-pch.
2330           bool AllowCompatibleConfigurationMismatch =
2331               F.Kind == MK_ExplicitModule || F.Kind == MK_PrebuiltModule;
2332           const HeaderSearchOptions &HSOpts =
2333               PP.getHeaderSearchInfo().getHeaderSearchOpts();
2334 
2335           Result = ReadOptionsBlock(Stream, ClientLoadCapabilities,
2336                                     AllowCompatibleConfigurationMismatch,
2337                                     *Listener, SuggestedPredefines,
2338                                     HSOpts.ModulesValidateDiagnosticOptions);
2339           if (Result == Failure) {
2340             Error("malformed block record in AST file");
2341             return Result;
2342           }
2343 
2344           if (DisableValidation ||
2345               (AllowConfigurationMismatch && Result == ConfigurationMismatch))
2346             Result = Success;
2347 
2348           // If we can't load the module, exit early since we likely
2349           // will rebuild the module anyway. The stream may be in the
2350           // middle of a block.
2351           if (Result != Success)
2352             return Result;
2353         } else if (Stream.SkipBlock()) {
2354           Error("malformed block record in AST file");
2355           return Failure;
2356         }
2357         continue;
2358 
2359       default:
2360         if (Stream.SkipBlock()) {
2361           Error("malformed block record in AST file");
2362           return Failure;
2363         }
2364         continue;
2365       }
2366 
2367     case llvm::BitstreamEntry::Record:
2368       // The interesting case.
2369       break;
2370     }
2371 
2372     // Read and process a record.
2373     Record.clear();
2374     StringRef Blob;
2375     switch ((ControlRecordTypes)Stream.readRecord(Entry.ID, Record, &Blob)) {
2376     case METADATA: {
2377       if (Record[0] != VERSION_MAJOR && !DisableValidation) {
2378         if ((ClientLoadCapabilities & ARR_VersionMismatch) == 0)
2379           Diag(Record[0] < VERSION_MAJOR? diag::err_pch_version_too_old
2380                                         : diag::err_pch_version_too_new);
2381         return VersionMismatch;
2382       }
2383 
2384       bool hasErrors = Record[6];
2385       if (hasErrors && !DisableValidation && !AllowASTWithCompilerErrors) {
2386         Diag(diag::err_pch_with_compiler_errors);
2387         return HadErrors;
2388       }
2389       if (hasErrors) {
2390         Diags.ErrorOccurred = true;
2391         Diags.UncompilableErrorOccurred = true;
2392         Diags.UnrecoverableErrorOccurred = true;
2393       }
2394 
2395       F.RelocatablePCH = Record[4];
2396       // Relative paths in a relocatable PCH are relative to our sysroot.
2397       if (F.RelocatablePCH)
2398         F.BaseDirectory = isysroot.empty() ? "/" : isysroot;
2399 
2400       F.HasTimestamps = Record[5];
2401 
2402       const std::string &CurBranch = getClangFullRepositoryVersion();
2403       StringRef ASTBranch = Blob;
2404       if (StringRef(CurBranch) != ASTBranch && !DisableValidation) {
2405         if ((ClientLoadCapabilities & ARR_VersionMismatch) == 0)
2406           Diag(diag::err_pch_different_branch) << ASTBranch << CurBranch;
2407         return VersionMismatch;
2408       }
2409       break;
2410     }
2411 
2412     case SIGNATURE:
2413       assert((!F.Signature || F.Signature == Record[0]) && "signature changed");
2414       F.Signature = Record[0];
2415       break;
2416 
2417     case IMPORTS: {
2418       // Load each of the imported PCH files.
2419       unsigned Idx = 0, N = Record.size();
2420       while (Idx < N) {
2421         // Read information about the AST file.
2422         ModuleKind ImportedKind = (ModuleKind)Record[Idx++];
2423         // The import location will be the local one for now; we will adjust
2424         // all import locations of module imports after the global source
2425         // location info are setup, in ReadAST.
2426         SourceLocation ImportLoc =
2427             ReadUntranslatedSourceLocation(Record[Idx++]);
2428         off_t StoredSize = (off_t)Record[Idx++];
2429         time_t StoredModTime = (time_t)Record[Idx++];
2430         ASTFileSignature StoredSignature = Record[Idx++];
2431         auto ImportedFile = ReadPath(F, Record, Idx);
2432 
2433         // If our client can't cope with us being out of date, we can't cope with
2434         // our dependency being missing.
2435         unsigned Capabilities = ClientLoadCapabilities;
2436         if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
2437           Capabilities &= ~ARR_Missing;
2438 
2439         // Load the AST file.
2440         auto Result = ReadASTCore(ImportedFile, ImportedKind, ImportLoc, &F,
2441                                   Loaded, StoredSize, StoredModTime,
2442                                   StoredSignature, Capabilities);
2443 
2444         // If we diagnosed a problem, produce a backtrace.
2445         if (isDiagnosedResult(Result, Capabilities))
2446           Diag(diag::note_module_file_imported_by)
2447               << F.FileName << !F.ModuleName.empty() << F.ModuleName;
2448 
2449         switch (Result) {
2450         case Failure: return Failure;
2451           // If we have to ignore the dependency, we'll have to ignore this too.
2452         case Missing:
2453         case OutOfDate: return OutOfDate;
2454         case VersionMismatch: return VersionMismatch;
2455         case ConfigurationMismatch: return ConfigurationMismatch;
2456         case HadErrors: return HadErrors;
2457         case Success: break;
2458         }
2459       }
2460       break;
2461     }
2462 
2463     case ORIGINAL_FILE:
2464       F.OriginalSourceFileID = FileID::get(Record[0]);
2465       F.ActualOriginalSourceFileName = Blob;
2466       F.OriginalSourceFileName = F.ActualOriginalSourceFileName;
2467       ResolveImportedPath(F, F.OriginalSourceFileName);
2468       break;
2469 
2470     case ORIGINAL_FILE_ID:
2471       F.OriginalSourceFileID = FileID::get(Record[0]);
2472       break;
2473 
2474     case ORIGINAL_PCH_DIR:
2475       F.OriginalDir = Blob;
2476       break;
2477 
2478     case MODULE_NAME:
2479       F.ModuleName = Blob;
2480       if (Listener)
2481         Listener->ReadModuleName(F.ModuleName);
2482       break;
2483 
2484     case MODULE_DIRECTORY: {
2485       assert(!F.ModuleName.empty() &&
2486              "MODULE_DIRECTORY found before MODULE_NAME");
2487       // If we've already loaded a module map file covering this module, we may
2488       // have a better path for it (relative to the current build).
2489       Module *M = PP.getHeaderSearchInfo().lookupModule(F.ModuleName);
2490       if (M && M->Directory) {
2491         // If we're implicitly loading a module, the base directory can't
2492         // change between the build and use.
2493         if (F.Kind != MK_ExplicitModule && F.Kind != MK_PrebuiltModule) {
2494           const DirectoryEntry *BuildDir =
2495               PP.getFileManager().getDirectory(Blob);
2496           if (!BuildDir || BuildDir != M->Directory) {
2497             if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
2498               Diag(diag::err_imported_module_relocated)
2499                   << F.ModuleName << Blob << M->Directory->getName();
2500             return OutOfDate;
2501           }
2502         }
2503         F.BaseDirectory = M->Directory->getName();
2504       } else {
2505         F.BaseDirectory = Blob;
2506       }
2507       break;
2508     }
2509 
2510     case MODULE_MAP_FILE:
2511       if (ASTReadResult Result =
2512               ReadModuleMapFileBlock(Record, F, ImportedBy, ClientLoadCapabilities))
2513         return Result;
2514       break;
2515 
2516     case INPUT_FILE_OFFSETS:
2517       NumInputs = Record[0];
2518       NumUserInputs = Record[1];
2519       F.InputFileOffsets =
2520           (const llvm::support::unaligned_uint64_t *)Blob.data();
2521       F.InputFilesLoaded.resize(NumInputs);
2522       break;
2523     }
2524   }
2525 }
2526 
2527 ASTReader::ASTReadResult
2528 ASTReader::ReadASTBlock(ModuleFile &F, unsigned ClientLoadCapabilities) {
2529   BitstreamCursor &Stream = F.Stream;
2530 
2531   if (Stream.EnterSubBlock(AST_BLOCK_ID)) {
2532     Error("malformed block record in AST file");
2533     return Failure;
2534   }
2535 
2536   // Read all of the records and blocks for the AST file.
2537   RecordData Record;
2538   while (true) {
2539     llvm::BitstreamEntry Entry = Stream.advance();
2540 
2541     switch (Entry.Kind) {
2542     case llvm::BitstreamEntry::Error:
2543       Error("error at end of module block in AST file");
2544       return Failure;
2545     case llvm::BitstreamEntry::EndBlock: {
2546       // Outside of C++, we do not store a lookup map for the translation unit.
2547       // Instead, mark it as needing a lookup map to be built if this module
2548       // contains any declarations lexically within it (which it always does!).
2549       // This usually has no cost, since we very rarely need the lookup map for
2550       // the translation unit outside C++.
2551       DeclContext *DC = Context.getTranslationUnitDecl();
2552       if (DC->hasExternalLexicalStorage() &&
2553           !getContext().getLangOpts().CPlusPlus)
2554         DC->setMustBuildLookupTable();
2555 
2556       return Success;
2557     }
2558     case llvm::BitstreamEntry::SubBlock:
2559       switch (Entry.ID) {
2560       case DECLTYPES_BLOCK_ID:
2561         // We lazily load the decls block, but we want to set up the
2562         // DeclsCursor cursor to point into it.  Clone our current bitcode
2563         // cursor to it, enter the block and read the abbrevs in that block.
2564         // With the main cursor, we just skip over it.
2565         F.DeclsCursor = Stream;
2566         if (Stream.SkipBlock() ||  // Skip with the main cursor.
2567             // Read the abbrevs.
2568             ReadBlockAbbrevs(F.DeclsCursor, DECLTYPES_BLOCK_ID)) {
2569           Error("malformed block record in AST file");
2570           return Failure;
2571         }
2572         break;
2573 
2574       case PREPROCESSOR_BLOCK_ID:
2575         F.MacroCursor = Stream;
2576         if (!PP.getExternalSource())
2577           PP.setExternalSource(this);
2578 
2579         if (Stream.SkipBlock() ||
2580             ReadBlockAbbrevs(F.MacroCursor, PREPROCESSOR_BLOCK_ID)) {
2581           Error("malformed block record in AST file");
2582           return Failure;
2583         }
2584         F.MacroStartOffset = F.MacroCursor.GetCurrentBitNo();
2585         break;
2586 
2587       case PREPROCESSOR_DETAIL_BLOCK_ID:
2588         F.PreprocessorDetailCursor = Stream;
2589         if (Stream.SkipBlock() ||
2590             ReadBlockAbbrevs(F.PreprocessorDetailCursor,
2591                              PREPROCESSOR_DETAIL_BLOCK_ID)) {
2592               Error("malformed preprocessor detail record in AST file");
2593               return Failure;
2594             }
2595         F.PreprocessorDetailStartOffset
2596         = F.PreprocessorDetailCursor.GetCurrentBitNo();
2597 
2598         if (!PP.getPreprocessingRecord())
2599           PP.createPreprocessingRecord();
2600         if (!PP.getPreprocessingRecord()->getExternalSource())
2601           PP.getPreprocessingRecord()->SetExternalSource(*this);
2602         break;
2603 
2604       case SOURCE_MANAGER_BLOCK_ID:
2605         if (ReadSourceManagerBlock(F))
2606           return Failure;
2607         break;
2608 
2609       case SUBMODULE_BLOCK_ID:
2610         if (ASTReadResult Result = ReadSubmoduleBlock(F, ClientLoadCapabilities))
2611           return Result;
2612         break;
2613 
2614       case COMMENTS_BLOCK_ID: {
2615         BitstreamCursor C = Stream;
2616         if (Stream.SkipBlock() ||
2617             ReadBlockAbbrevs(C, COMMENTS_BLOCK_ID)) {
2618           Error("malformed comments block in AST file");
2619           return Failure;
2620         }
2621         CommentsCursors.push_back(std::make_pair(C, &F));
2622         break;
2623       }
2624 
2625       default:
2626         if (Stream.SkipBlock()) {
2627           Error("malformed block record in AST file");
2628           return Failure;
2629         }
2630         break;
2631       }
2632       continue;
2633 
2634     case llvm::BitstreamEntry::Record:
2635       // The interesting case.
2636       break;
2637     }
2638 
2639     // Read and process a record.
2640     Record.clear();
2641     StringRef Blob;
2642     switch ((ASTRecordTypes)Stream.readRecord(Entry.ID, Record, &Blob)) {
2643     default:  // Default behavior: ignore.
2644       break;
2645 
2646     case TYPE_OFFSET: {
2647       if (F.LocalNumTypes != 0) {
2648         Error("duplicate TYPE_OFFSET record in AST file");
2649         return Failure;
2650       }
2651       F.TypeOffsets = (const uint32_t *)Blob.data();
2652       F.LocalNumTypes = Record[0];
2653       unsigned LocalBaseTypeIndex = Record[1];
2654       F.BaseTypeIndex = getTotalNumTypes();
2655 
2656       if (F.LocalNumTypes > 0) {
2657         // Introduce the global -> local mapping for types within this module.
2658         GlobalTypeMap.insert(std::make_pair(getTotalNumTypes(), &F));
2659 
2660         // Introduce the local -> global mapping for types within this module.
2661         F.TypeRemap.insertOrReplace(
2662           std::make_pair(LocalBaseTypeIndex,
2663                          F.BaseTypeIndex - LocalBaseTypeIndex));
2664 
2665         TypesLoaded.resize(TypesLoaded.size() + F.LocalNumTypes);
2666       }
2667       break;
2668     }
2669 
2670     case DECL_OFFSET: {
2671       if (F.LocalNumDecls != 0) {
2672         Error("duplicate DECL_OFFSET record in AST file");
2673         return Failure;
2674       }
2675       F.DeclOffsets = (const DeclOffset *)Blob.data();
2676       F.LocalNumDecls = Record[0];
2677       unsigned LocalBaseDeclID = Record[1];
2678       F.BaseDeclID = getTotalNumDecls();
2679 
2680       if (F.LocalNumDecls > 0) {
2681         // Introduce the global -> local mapping for declarations within this
2682         // module.
2683         GlobalDeclMap.insert(
2684           std::make_pair(getTotalNumDecls() + NUM_PREDEF_DECL_IDS, &F));
2685 
2686         // Introduce the local -> global mapping for declarations within this
2687         // module.
2688         F.DeclRemap.insertOrReplace(
2689           std::make_pair(LocalBaseDeclID, F.BaseDeclID - LocalBaseDeclID));
2690 
2691         // Introduce the global -> local mapping for declarations within this
2692         // module.
2693         F.GlobalToLocalDeclIDs[&F] = LocalBaseDeclID;
2694 
2695         DeclsLoaded.resize(DeclsLoaded.size() + F.LocalNumDecls);
2696       }
2697       break;
2698     }
2699 
2700     case TU_UPDATE_LEXICAL: {
2701       DeclContext *TU = Context.getTranslationUnitDecl();
2702       LexicalContents Contents(
2703           reinterpret_cast<const llvm::support::unaligned_uint32_t *>(
2704               Blob.data()),
2705           static_cast<unsigned int>(Blob.size() / 4));
2706       TULexicalDecls.push_back(std::make_pair(&F, Contents));
2707       TU->setHasExternalLexicalStorage(true);
2708       break;
2709     }
2710 
2711     case UPDATE_VISIBLE: {
2712       unsigned Idx = 0;
2713       serialization::DeclID ID = ReadDeclID(F, Record, Idx);
2714       auto *Data = (const unsigned char*)Blob.data();
2715       PendingVisibleUpdates[ID].push_back(PendingVisibleUpdate{&F, Data});
2716       // If we've already loaded the decl, perform the updates when we finish
2717       // loading this block.
2718       if (Decl *D = GetExistingDecl(ID))
2719         PendingUpdateRecords.push_back(std::make_pair(ID, D));
2720       break;
2721     }
2722 
2723     case IDENTIFIER_TABLE:
2724       F.IdentifierTableData = Blob.data();
2725       if (Record[0]) {
2726         F.IdentifierLookupTable = ASTIdentifierLookupTable::Create(
2727             (const unsigned char *)F.IdentifierTableData + Record[0],
2728             (const unsigned char *)F.IdentifierTableData + sizeof(uint32_t),
2729             (const unsigned char *)F.IdentifierTableData,
2730             ASTIdentifierLookupTrait(*this, F));
2731 
2732         PP.getIdentifierTable().setExternalIdentifierLookup(this);
2733       }
2734       break;
2735 
2736     case IDENTIFIER_OFFSET: {
2737       if (F.LocalNumIdentifiers != 0) {
2738         Error("duplicate IDENTIFIER_OFFSET record in AST file");
2739         return Failure;
2740       }
2741       F.IdentifierOffsets = (const uint32_t *)Blob.data();
2742       F.LocalNumIdentifiers = Record[0];
2743       unsigned LocalBaseIdentifierID = Record[1];
2744       F.BaseIdentifierID = getTotalNumIdentifiers();
2745 
2746       if (F.LocalNumIdentifiers > 0) {
2747         // Introduce the global -> local mapping for identifiers within this
2748         // module.
2749         GlobalIdentifierMap.insert(std::make_pair(getTotalNumIdentifiers() + 1,
2750                                                   &F));
2751 
2752         // Introduce the local -> global mapping for identifiers within this
2753         // module.
2754         F.IdentifierRemap.insertOrReplace(
2755           std::make_pair(LocalBaseIdentifierID,
2756                          F.BaseIdentifierID - LocalBaseIdentifierID));
2757 
2758         IdentifiersLoaded.resize(IdentifiersLoaded.size()
2759                                  + F.LocalNumIdentifiers);
2760       }
2761       break;
2762     }
2763 
2764     case INTERESTING_IDENTIFIERS:
2765       F.PreloadIdentifierOffsets.assign(Record.begin(), Record.end());
2766       break;
2767 
2768     case EAGERLY_DESERIALIZED_DECLS:
2769       // FIXME: Skip reading this record if our ASTConsumer doesn't care
2770       // about "interesting" decls (for instance, if we're building a module).
2771       for (unsigned I = 0, N = Record.size(); I != N; ++I)
2772         EagerlyDeserializedDecls.push_back(getGlobalDeclID(F, Record[I]));
2773       break;
2774 
2775     case SPECIAL_TYPES:
2776       if (SpecialTypes.empty()) {
2777         for (unsigned I = 0, N = Record.size(); I != N; ++I)
2778           SpecialTypes.push_back(getGlobalTypeID(F, Record[I]));
2779         break;
2780       }
2781 
2782       if (SpecialTypes.size() != Record.size()) {
2783         Error("invalid special-types record");
2784         return Failure;
2785       }
2786 
2787       for (unsigned I = 0, N = Record.size(); I != N; ++I) {
2788         serialization::TypeID ID = getGlobalTypeID(F, Record[I]);
2789         if (!SpecialTypes[I])
2790           SpecialTypes[I] = ID;
2791         // FIXME: If ID && SpecialTypes[I] != ID, do we need a separate
2792         // merge step?
2793       }
2794       break;
2795 
2796     case STATISTICS:
2797       TotalNumStatements += Record[0];
2798       TotalNumMacros += Record[1];
2799       TotalLexicalDeclContexts += Record[2];
2800       TotalVisibleDeclContexts += Record[3];
2801       break;
2802 
2803     case UNUSED_FILESCOPED_DECLS:
2804       for (unsigned I = 0, N = Record.size(); I != N; ++I)
2805         UnusedFileScopedDecls.push_back(getGlobalDeclID(F, Record[I]));
2806       break;
2807 
2808     case DELEGATING_CTORS:
2809       for (unsigned I = 0, N = Record.size(); I != N; ++I)
2810         DelegatingCtorDecls.push_back(getGlobalDeclID(F, Record[I]));
2811       break;
2812 
2813     case WEAK_UNDECLARED_IDENTIFIERS:
2814       if (Record.size() % 4 != 0) {
2815         Error("invalid weak identifiers record");
2816         return Failure;
2817       }
2818 
2819       // FIXME: Ignore weak undeclared identifiers from non-original PCH
2820       // files. This isn't the way to do it :)
2821       WeakUndeclaredIdentifiers.clear();
2822 
2823       // Translate the weak, undeclared identifiers into global IDs.
2824       for (unsigned I = 0, N = Record.size(); I < N; /* in loop */) {
2825         WeakUndeclaredIdentifiers.push_back(
2826           getGlobalIdentifierID(F, Record[I++]));
2827         WeakUndeclaredIdentifiers.push_back(
2828           getGlobalIdentifierID(F, Record[I++]));
2829         WeakUndeclaredIdentifiers.push_back(
2830           ReadSourceLocation(F, Record, I).getRawEncoding());
2831         WeakUndeclaredIdentifiers.push_back(Record[I++]);
2832       }
2833       break;
2834 
2835     case SELECTOR_OFFSETS: {
2836       F.SelectorOffsets = (const uint32_t *)Blob.data();
2837       F.LocalNumSelectors = Record[0];
2838       unsigned LocalBaseSelectorID = Record[1];
2839       F.BaseSelectorID = getTotalNumSelectors();
2840 
2841       if (F.LocalNumSelectors > 0) {
2842         // Introduce the global -> local mapping for selectors within this
2843         // module.
2844         GlobalSelectorMap.insert(std::make_pair(getTotalNumSelectors()+1, &F));
2845 
2846         // Introduce the local -> global mapping for selectors within this
2847         // module.
2848         F.SelectorRemap.insertOrReplace(
2849           std::make_pair(LocalBaseSelectorID,
2850                          F.BaseSelectorID - LocalBaseSelectorID));
2851 
2852         SelectorsLoaded.resize(SelectorsLoaded.size() + F.LocalNumSelectors);
2853       }
2854       break;
2855     }
2856 
2857     case METHOD_POOL:
2858       F.SelectorLookupTableData = (const unsigned char *)Blob.data();
2859       if (Record[0])
2860         F.SelectorLookupTable
2861           = ASTSelectorLookupTable::Create(
2862                         F.SelectorLookupTableData + Record[0],
2863                         F.SelectorLookupTableData,
2864                         ASTSelectorLookupTrait(*this, F));
2865       TotalNumMethodPoolEntries += Record[1];
2866       break;
2867 
2868     case REFERENCED_SELECTOR_POOL:
2869       if (!Record.empty()) {
2870         for (unsigned Idx = 0, N = Record.size() - 1; Idx < N; /* in loop */) {
2871           ReferencedSelectorsData.push_back(getGlobalSelectorID(F,
2872                                                                 Record[Idx++]));
2873           ReferencedSelectorsData.push_back(ReadSourceLocation(F, Record, Idx).
2874                                               getRawEncoding());
2875         }
2876       }
2877       break;
2878 
2879     case PP_COUNTER_VALUE:
2880       if (!Record.empty() && Listener)
2881         Listener->ReadCounter(F, Record[0]);
2882       break;
2883 
2884     case FILE_SORTED_DECLS:
2885       F.FileSortedDecls = (const DeclID *)Blob.data();
2886       F.NumFileSortedDecls = Record[0];
2887       break;
2888 
2889     case SOURCE_LOCATION_OFFSETS: {
2890       F.SLocEntryOffsets = (const uint32_t *)Blob.data();
2891       F.LocalNumSLocEntries = Record[0];
2892       unsigned SLocSpaceSize = Record[1];
2893       std::tie(F.SLocEntryBaseID, F.SLocEntryBaseOffset) =
2894           SourceMgr.AllocateLoadedSLocEntries(F.LocalNumSLocEntries,
2895                                               SLocSpaceSize);
2896       if (!F.SLocEntryBaseID) {
2897         Error("ran out of source locations");
2898         break;
2899       }
2900       // Make our entry in the range map. BaseID is negative and growing, so
2901       // we invert it. Because we invert it, though, we need the other end of
2902       // the range.
2903       unsigned RangeStart =
2904           unsigned(-F.SLocEntryBaseID) - F.LocalNumSLocEntries + 1;
2905       GlobalSLocEntryMap.insert(std::make_pair(RangeStart, &F));
2906       F.FirstLoc = SourceLocation::getFromRawEncoding(F.SLocEntryBaseOffset);
2907 
2908       // SLocEntryBaseOffset is lower than MaxLoadedOffset and decreasing.
2909       assert((F.SLocEntryBaseOffset & (1U << 31U)) == 0);
2910       GlobalSLocOffsetMap.insert(
2911           std::make_pair(SourceManager::MaxLoadedOffset - F.SLocEntryBaseOffset
2912                            - SLocSpaceSize,&F));
2913 
2914       // Initialize the remapping table.
2915       // Invalid stays invalid.
2916       F.SLocRemap.insertOrReplace(std::make_pair(0U, 0));
2917       // This module. Base was 2 when being compiled.
2918       F.SLocRemap.insertOrReplace(std::make_pair(2U,
2919                                   static_cast<int>(F.SLocEntryBaseOffset - 2)));
2920 
2921       TotalNumSLocEntries += F.LocalNumSLocEntries;
2922       break;
2923     }
2924 
2925     case MODULE_OFFSET_MAP: {
2926       // Additional remapping information.
2927       const unsigned char *Data = (const unsigned char*)Blob.data();
2928       const unsigned char *DataEnd = Data + Blob.size();
2929 
2930       // If we see this entry before SOURCE_LOCATION_OFFSETS, add placeholders.
2931       if (F.SLocRemap.find(0) == F.SLocRemap.end()) {
2932         F.SLocRemap.insert(std::make_pair(0U, 0));
2933         F.SLocRemap.insert(std::make_pair(2U, 1));
2934       }
2935 
2936       // Continuous range maps we may be updating in our module.
2937       typedef ContinuousRangeMap<uint32_t, int, 2>::Builder
2938           RemapBuilder;
2939       RemapBuilder SLocRemap(F.SLocRemap);
2940       RemapBuilder IdentifierRemap(F.IdentifierRemap);
2941       RemapBuilder MacroRemap(F.MacroRemap);
2942       RemapBuilder PreprocessedEntityRemap(F.PreprocessedEntityRemap);
2943       RemapBuilder SubmoduleRemap(F.SubmoduleRemap);
2944       RemapBuilder SelectorRemap(F.SelectorRemap);
2945       RemapBuilder DeclRemap(F.DeclRemap);
2946       RemapBuilder TypeRemap(F.TypeRemap);
2947 
2948       while (Data < DataEnd) {
2949         using namespace llvm::support;
2950         uint16_t Len = endian::readNext<uint16_t, little, unaligned>(Data);
2951         StringRef Name = StringRef((const char*)Data, Len);
2952         Data += Len;
2953         ModuleFile *OM = ModuleMgr.lookup(Name);
2954         if (!OM) {
2955           Error("SourceLocation remap refers to unknown module");
2956           return Failure;
2957         }
2958 
2959         uint32_t SLocOffset =
2960             endian::readNext<uint32_t, little, unaligned>(Data);
2961         uint32_t IdentifierIDOffset =
2962             endian::readNext<uint32_t, little, unaligned>(Data);
2963         uint32_t MacroIDOffset =
2964             endian::readNext<uint32_t, little, unaligned>(Data);
2965         uint32_t PreprocessedEntityIDOffset =
2966             endian::readNext<uint32_t, little, unaligned>(Data);
2967         uint32_t SubmoduleIDOffset =
2968             endian::readNext<uint32_t, little, unaligned>(Data);
2969         uint32_t SelectorIDOffset =
2970             endian::readNext<uint32_t, little, unaligned>(Data);
2971         uint32_t DeclIDOffset =
2972             endian::readNext<uint32_t, little, unaligned>(Data);
2973         uint32_t TypeIndexOffset =
2974             endian::readNext<uint32_t, little, unaligned>(Data);
2975 
2976         uint32_t None = std::numeric_limits<uint32_t>::max();
2977 
2978         auto mapOffset = [&](uint32_t Offset, uint32_t BaseOffset,
2979                              RemapBuilder &Remap) {
2980           if (Offset != None)
2981             Remap.insert(std::make_pair(Offset,
2982                                         static_cast<int>(BaseOffset - Offset)));
2983         };
2984         mapOffset(SLocOffset, OM->SLocEntryBaseOffset, SLocRemap);
2985         mapOffset(IdentifierIDOffset, OM->BaseIdentifierID, IdentifierRemap);
2986         mapOffset(MacroIDOffset, OM->BaseMacroID, MacroRemap);
2987         mapOffset(PreprocessedEntityIDOffset, OM->BasePreprocessedEntityID,
2988                   PreprocessedEntityRemap);
2989         mapOffset(SubmoduleIDOffset, OM->BaseSubmoduleID, SubmoduleRemap);
2990         mapOffset(SelectorIDOffset, OM->BaseSelectorID, SelectorRemap);
2991         mapOffset(DeclIDOffset, OM->BaseDeclID, DeclRemap);
2992         mapOffset(TypeIndexOffset, OM->BaseTypeIndex, TypeRemap);
2993 
2994         // Global -> local mappings.
2995         F.GlobalToLocalDeclIDs[OM] = DeclIDOffset;
2996       }
2997       break;
2998     }
2999 
3000     case SOURCE_MANAGER_LINE_TABLE:
3001       if (ParseLineTable(F, Record))
3002         return Failure;
3003       break;
3004 
3005     case SOURCE_LOCATION_PRELOADS: {
3006       // Need to transform from the local view (1-based IDs) to the global view,
3007       // which is based off F.SLocEntryBaseID.
3008       if (!F.PreloadSLocEntries.empty()) {
3009         Error("Multiple SOURCE_LOCATION_PRELOADS records in AST file");
3010         return Failure;
3011       }
3012 
3013       F.PreloadSLocEntries.swap(Record);
3014       break;
3015     }
3016 
3017     case EXT_VECTOR_DECLS:
3018       for (unsigned I = 0, N = Record.size(); I != N; ++I)
3019         ExtVectorDecls.push_back(getGlobalDeclID(F, Record[I]));
3020       break;
3021 
3022     case VTABLE_USES:
3023       if (Record.size() % 3 != 0) {
3024         Error("Invalid VTABLE_USES record");
3025         return Failure;
3026       }
3027 
3028       // Later tables overwrite earlier ones.
3029       // FIXME: Modules will have some trouble with this. This is clearly not
3030       // the right way to do this.
3031       VTableUses.clear();
3032 
3033       for (unsigned Idx = 0, N = Record.size(); Idx != N; /* In loop */) {
3034         VTableUses.push_back(getGlobalDeclID(F, Record[Idx++]));
3035         VTableUses.push_back(
3036           ReadSourceLocation(F, Record, Idx).getRawEncoding());
3037         VTableUses.push_back(Record[Idx++]);
3038       }
3039       break;
3040 
3041     case PENDING_IMPLICIT_INSTANTIATIONS:
3042       if (PendingInstantiations.size() % 2 != 0) {
3043         Error("Invalid existing PendingInstantiations");
3044         return Failure;
3045       }
3046 
3047       if (Record.size() % 2 != 0) {
3048         Error("Invalid PENDING_IMPLICIT_INSTANTIATIONS block");
3049         return Failure;
3050       }
3051 
3052       for (unsigned I = 0, N = Record.size(); I != N; /* in loop */) {
3053         PendingInstantiations.push_back(getGlobalDeclID(F, Record[I++]));
3054         PendingInstantiations.push_back(
3055           ReadSourceLocation(F, Record, I).getRawEncoding());
3056       }
3057       break;
3058 
3059     case SEMA_DECL_REFS:
3060       if (Record.size() != 3) {
3061         Error("Invalid SEMA_DECL_REFS block");
3062         return Failure;
3063       }
3064       for (unsigned I = 0, N = Record.size(); I != N; ++I)
3065         SemaDeclRefs.push_back(getGlobalDeclID(F, Record[I]));
3066       break;
3067 
3068     case PPD_ENTITIES_OFFSETS: {
3069       F.PreprocessedEntityOffsets = (const PPEntityOffset *)Blob.data();
3070       assert(Blob.size() % sizeof(PPEntityOffset) == 0);
3071       F.NumPreprocessedEntities = Blob.size() / sizeof(PPEntityOffset);
3072 
3073       unsigned LocalBasePreprocessedEntityID = Record[0];
3074 
3075       unsigned StartingID;
3076       if (!PP.getPreprocessingRecord())
3077         PP.createPreprocessingRecord();
3078       if (!PP.getPreprocessingRecord()->getExternalSource())
3079         PP.getPreprocessingRecord()->SetExternalSource(*this);
3080       StartingID
3081         = PP.getPreprocessingRecord()
3082             ->allocateLoadedEntities(F.NumPreprocessedEntities);
3083       F.BasePreprocessedEntityID = StartingID;
3084 
3085       if (F.NumPreprocessedEntities > 0) {
3086         // Introduce the global -> local mapping for preprocessed entities in
3087         // this module.
3088         GlobalPreprocessedEntityMap.insert(std::make_pair(StartingID, &F));
3089 
3090         // Introduce the local -> global mapping for preprocessed entities in
3091         // this module.
3092         F.PreprocessedEntityRemap.insertOrReplace(
3093           std::make_pair(LocalBasePreprocessedEntityID,
3094             F.BasePreprocessedEntityID - LocalBasePreprocessedEntityID));
3095       }
3096 
3097       break;
3098     }
3099 
3100     case DECL_UPDATE_OFFSETS: {
3101       if (Record.size() % 2 != 0) {
3102         Error("invalid DECL_UPDATE_OFFSETS block in AST file");
3103         return Failure;
3104       }
3105       for (unsigned I = 0, N = Record.size(); I != N; I += 2) {
3106         GlobalDeclID ID = getGlobalDeclID(F, Record[I]);
3107         DeclUpdateOffsets[ID].push_back(std::make_pair(&F, Record[I + 1]));
3108 
3109         // If we've already loaded the decl, perform the updates when we finish
3110         // loading this block.
3111         if (Decl *D = GetExistingDecl(ID))
3112           PendingUpdateRecords.push_back(std::make_pair(ID, D));
3113       }
3114       break;
3115     }
3116 
3117     case OBJC_CATEGORIES_MAP: {
3118       if (F.LocalNumObjCCategoriesInMap != 0) {
3119         Error("duplicate OBJC_CATEGORIES_MAP record in AST file");
3120         return Failure;
3121       }
3122 
3123       F.LocalNumObjCCategoriesInMap = Record[0];
3124       F.ObjCCategoriesMap = (const ObjCCategoriesInfo *)Blob.data();
3125       break;
3126     }
3127 
3128     case OBJC_CATEGORIES:
3129       F.ObjCCategories.swap(Record);
3130       break;
3131 
3132     case DIAG_PRAGMA_MAPPINGS:
3133       if (F.PragmaDiagMappings.empty())
3134         F.PragmaDiagMappings.swap(Record);
3135       else
3136         F.PragmaDiagMappings.insert(F.PragmaDiagMappings.end(),
3137                                     Record.begin(), Record.end());
3138       break;
3139 
3140     case CUDA_SPECIAL_DECL_REFS:
3141       // Later tables overwrite earlier ones.
3142       // FIXME: Modules will have trouble with this.
3143       CUDASpecialDeclRefs.clear();
3144       for (unsigned I = 0, N = Record.size(); I != N; ++I)
3145         CUDASpecialDeclRefs.push_back(getGlobalDeclID(F, Record[I]));
3146       break;
3147 
3148     case HEADER_SEARCH_TABLE: {
3149       F.HeaderFileInfoTableData = Blob.data();
3150       F.LocalNumHeaderFileInfos = Record[1];
3151       if (Record[0]) {
3152         F.HeaderFileInfoTable
3153           = HeaderFileInfoLookupTable::Create(
3154                    (const unsigned char *)F.HeaderFileInfoTableData + Record[0],
3155                    (const unsigned char *)F.HeaderFileInfoTableData,
3156                    HeaderFileInfoTrait(*this, F,
3157                                        &PP.getHeaderSearchInfo(),
3158                                        Blob.data() + Record[2]));
3159 
3160         PP.getHeaderSearchInfo().SetExternalSource(this);
3161         if (!PP.getHeaderSearchInfo().getExternalLookup())
3162           PP.getHeaderSearchInfo().SetExternalLookup(this);
3163       }
3164       break;
3165     }
3166 
3167     case FP_PRAGMA_OPTIONS:
3168       // Later tables overwrite earlier ones.
3169       FPPragmaOptions.swap(Record);
3170       break;
3171 
3172     case OPENCL_EXTENSIONS:
3173       for (unsigned I = 0, E = Record.size(); I != E; ) {
3174         auto Name = ReadString(Record, I);
3175         auto &Opt = OpenCLExtensions.OptMap[Name];
3176         Opt.Supported = Record[I++] != 0;
3177         Opt.Enabled = Record[I++] != 0;
3178         Opt.Avail = Record[I++];
3179         Opt.Core = Record[I++];
3180       }
3181       break;
3182 
3183     case OPENCL_EXTENSION_TYPES:
3184       for (unsigned I = 0, E = Record.size(); I != E;) {
3185         auto TypeID = static_cast<::TypeID>(Record[I++]);
3186         auto *Type = GetType(TypeID).getTypePtr();
3187         auto NumExt = static_cast<unsigned>(Record[I++]);
3188         for (unsigned II = 0; II != NumExt; ++II) {
3189           auto Ext = ReadString(Record, I);
3190           OpenCLTypeExtMap[Type].insert(Ext);
3191         }
3192       }
3193       break;
3194 
3195     case OPENCL_EXTENSION_DECLS:
3196       for (unsigned I = 0, E = Record.size(); I != E;) {
3197         auto DeclID = static_cast<::DeclID>(Record[I++]);
3198         auto *Decl = GetDecl(DeclID);
3199         auto NumExt = static_cast<unsigned>(Record[I++]);
3200         for (unsigned II = 0; II != NumExt; ++II) {
3201           auto Ext = ReadString(Record, I);
3202           OpenCLDeclExtMap[Decl].insert(Ext);
3203         }
3204       }
3205       break;
3206 
3207     case TENTATIVE_DEFINITIONS:
3208       for (unsigned I = 0, N = Record.size(); I != N; ++I)
3209         TentativeDefinitions.push_back(getGlobalDeclID(F, Record[I]));
3210       break;
3211 
3212     case KNOWN_NAMESPACES:
3213       for (unsigned I = 0, N = Record.size(); I != N; ++I)
3214         KnownNamespaces.push_back(getGlobalDeclID(F, Record[I]));
3215       break;
3216 
3217     case UNDEFINED_BUT_USED:
3218       if (UndefinedButUsed.size() % 2 != 0) {
3219         Error("Invalid existing UndefinedButUsed");
3220         return Failure;
3221       }
3222 
3223       if (Record.size() % 2 != 0) {
3224         Error("invalid undefined-but-used record");
3225         return Failure;
3226       }
3227       for (unsigned I = 0, N = Record.size(); I != N; /* in loop */) {
3228         UndefinedButUsed.push_back(getGlobalDeclID(F, Record[I++]));
3229         UndefinedButUsed.push_back(
3230             ReadSourceLocation(F, Record, I).getRawEncoding());
3231       }
3232       break;
3233     case DELETE_EXPRS_TO_ANALYZE:
3234       for (unsigned I = 0, N = Record.size(); I != N;) {
3235         DelayedDeleteExprs.push_back(getGlobalDeclID(F, Record[I++]));
3236         const uint64_t Count = Record[I++];
3237         DelayedDeleteExprs.push_back(Count);
3238         for (uint64_t C = 0; C < Count; ++C) {
3239           DelayedDeleteExprs.push_back(ReadSourceLocation(F, Record, I).getRawEncoding());
3240           bool IsArrayForm = Record[I++] == 1;
3241           DelayedDeleteExprs.push_back(IsArrayForm);
3242         }
3243       }
3244       break;
3245 
3246     case IMPORTED_MODULES: {
3247       if (!F.isModule()) {
3248         // If we aren't loading a module (which has its own exports), make
3249         // all of the imported modules visible.
3250         // FIXME: Deal with macros-only imports.
3251         for (unsigned I = 0, N = Record.size(); I != N; /**/) {
3252           unsigned GlobalID = getGlobalSubmoduleID(F, Record[I++]);
3253           SourceLocation Loc = ReadSourceLocation(F, Record, I);
3254           if (GlobalID)
3255             ImportedModules.push_back(ImportedSubmodule(GlobalID, Loc));
3256         }
3257       }
3258       break;
3259     }
3260 
3261     case MACRO_OFFSET: {
3262       if (F.LocalNumMacros != 0) {
3263         Error("duplicate MACRO_OFFSET record in AST file");
3264         return Failure;
3265       }
3266       F.MacroOffsets = (const uint32_t *)Blob.data();
3267       F.LocalNumMacros = Record[0];
3268       unsigned LocalBaseMacroID = Record[1];
3269       F.BaseMacroID = getTotalNumMacros();
3270 
3271       if (F.LocalNumMacros > 0) {
3272         // Introduce the global -> local mapping for macros within this module.
3273         GlobalMacroMap.insert(std::make_pair(getTotalNumMacros() + 1, &F));
3274 
3275         // Introduce the local -> global mapping for macros within this module.
3276         F.MacroRemap.insertOrReplace(
3277           std::make_pair(LocalBaseMacroID,
3278                          F.BaseMacroID - LocalBaseMacroID));
3279 
3280         MacrosLoaded.resize(MacrosLoaded.size() + F.LocalNumMacros);
3281       }
3282       break;
3283     }
3284 
3285     case LATE_PARSED_TEMPLATE: {
3286       LateParsedTemplates.append(Record.begin(), Record.end());
3287       break;
3288     }
3289 
3290     case OPTIMIZE_PRAGMA_OPTIONS:
3291       if (Record.size() != 1) {
3292         Error("invalid pragma optimize record");
3293         return Failure;
3294       }
3295       OptimizeOffPragmaLocation = ReadSourceLocation(F, Record[0]);
3296       break;
3297 
3298     case MSSTRUCT_PRAGMA_OPTIONS:
3299       if (Record.size() != 1) {
3300         Error("invalid pragma ms_struct record");
3301         return Failure;
3302       }
3303       PragmaMSStructState = Record[0];
3304       break;
3305 
3306     case POINTERS_TO_MEMBERS_PRAGMA_OPTIONS:
3307       if (Record.size() != 2) {
3308         Error("invalid pragma ms_struct record");
3309         return Failure;
3310       }
3311       PragmaMSPointersToMembersState = Record[0];
3312       PointersToMembersPragmaLocation = ReadSourceLocation(F, Record[1]);
3313       break;
3314 
3315     case UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES:
3316       for (unsigned I = 0, N = Record.size(); I != N; ++I)
3317         UnusedLocalTypedefNameCandidates.push_back(
3318             getGlobalDeclID(F, Record[I]));
3319       break;
3320 
3321     case CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH:
3322       if (Record.size() != 1) {
3323         Error("invalid cuda pragma options record");
3324         return Failure;
3325       }
3326       ForceCUDAHostDeviceDepth = Record[0];
3327       break;
3328     }
3329   }
3330 }
3331 
3332 ASTReader::ASTReadResult
3333 ASTReader::ReadModuleMapFileBlock(RecordData &Record, ModuleFile &F,
3334                                   const ModuleFile *ImportedBy,
3335                                   unsigned ClientLoadCapabilities) {
3336   unsigned Idx = 0;
3337   F.ModuleMapPath = ReadPath(F, Record, Idx);
3338 
3339   if (F.Kind == MK_ExplicitModule || F.Kind == MK_PrebuiltModule) {
3340     // For an explicitly-loaded module, we don't care whether the original
3341     // module map file exists or matches.
3342     return Success;
3343   }
3344 
3345   // Try to resolve ModuleName in the current header search context and
3346   // verify that it is found in the same module map file as we saved. If the
3347   // top-level AST file is a main file, skip this check because there is no
3348   // usable header search context.
3349   assert(!F.ModuleName.empty() &&
3350          "MODULE_NAME should come before MODULE_MAP_FILE");
3351   if (F.Kind == MK_ImplicitModule &&
3352       (*ModuleMgr.begin())->Kind != MK_MainFile) {
3353     // An implicitly-loaded module file should have its module listed in some
3354     // module map file that we've already loaded.
3355     Module *M = PP.getHeaderSearchInfo().lookupModule(F.ModuleName);
3356     auto &Map = PP.getHeaderSearchInfo().getModuleMap();
3357     const FileEntry *ModMap = M ? Map.getModuleMapFileForUniquing(M) : nullptr;
3358     if (!ModMap) {
3359       assert(ImportedBy && "top-level import should be verified");
3360       if ((ClientLoadCapabilities & ARR_OutOfDate) == 0) {
3361         if (auto *ASTFE = M ? M->getASTFile() : nullptr)
3362           // This module was defined by an imported (explicit) module.
3363           Diag(diag::err_module_file_conflict) << F.ModuleName << F.FileName
3364                                                << ASTFE->getName();
3365         else
3366           // This module was built with a different module map.
3367           Diag(diag::err_imported_module_not_found)
3368               << F.ModuleName << F.FileName << ImportedBy->FileName
3369               << F.ModuleMapPath;
3370       }
3371       return OutOfDate;
3372     }
3373 
3374     assert(M->Name == F.ModuleName && "found module with different name");
3375 
3376     // Check the primary module map file.
3377     const FileEntry *StoredModMap = FileMgr.getFile(F.ModuleMapPath);
3378     if (StoredModMap == nullptr || StoredModMap != ModMap) {
3379       assert(ModMap && "found module is missing module map file");
3380       assert(ImportedBy && "top-level import should be verified");
3381       if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3382         Diag(diag::err_imported_module_modmap_changed)
3383           << F.ModuleName << ImportedBy->FileName
3384           << ModMap->getName() << F.ModuleMapPath;
3385       return OutOfDate;
3386     }
3387 
3388     llvm::SmallPtrSet<const FileEntry *, 1> AdditionalStoredMaps;
3389     for (unsigned I = 0, N = Record[Idx++]; I < N; ++I) {
3390       // FIXME: we should use input files rather than storing names.
3391       std::string Filename = ReadPath(F, Record, Idx);
3392       const FileEntry *F =
3393           FileMgr.getFile(Filename, false, false);
3394       if (F == nullptr) {
3395         if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3396           Error("could not find file '" + Filename +"' referenced by AST file");
3397         return OutOfDate;
3398       }
3399       AdditionalStoredMaps.insert(F);
3400     }
3401 
3402     // Check any additional module map files (e.g. module.private.modulemap)
3403     // that are not in the pcm.
3404     if (auto *AdditionalModuleMaps = Map.getAdditionalModuleMapFiles(M)) {
3405       for (const FileEntry *ModMap : *AdditionalModuleMaps) {
3406         // Remove files that match
3407         // Note: SmallPtrSet::erase is really remove
3408         if (!AdditionalStoredMaps.erase(ModMap)) {
3409           if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3410             Diag(diag::err_module_different_modmap)
3411               << F.ModuleName << /*new*/0 << ModMap->getName();
3412           return OutOfDate;
3413         }
3414       }
3415     }
3416 
3417     // Check any additional module map files that are in the pcm, but not
3418     // found in header search. Cases that match are already removed.
3419     for (const FileEntry *ModMap : AdditionalStoredMaps) {
3420       if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3421         Diag(diag::err_module_different_modmap)
3422           << F.ModuleName << /*not new*/1 << ModMap->getName();
3423       return OutOfDate;
3424     }
3425   }
3426 
3427   if (Listener)
3428     Listener->ReadModuleMapFile(F.ModuleMapPath);
3429   return Success;
3430 }
3431 
3432 
3433 /// \brief Move the given method to the back of the global list of methods.
3434 static void moveMethodToBackOfGlobalList(Sema &S, ObjCMethodDecl *Method) {
3435   // Find the entry for this selector in the method pool.
3436   Sema::GlobalMethodPool::iterator Known
3437     = S.MethodPool.find(Method->getSelector());
3438   if (Known == S.MethodPool.end())
3439     return;
3440 
3441   // Retrieve the appropriate method list.
3442   ObjCMethodList &Start = Method->isInstanceMethod()? Known->second.first
3443                                                     : Known->second.second;
3444   bool Found = false;
3445   for (ObjCMethodList *List = &Start; List; List = List->getNext()) {
3446     if (!Found) {
3447       if (List->getMethod() == Method) {
3448         Found = true;
3449       } else {
3450         // Keep searching.
3451         continue;
3452       }
3453     }
3454 
3455     if (List->getNext())
3456       List->setMethod(List->getNext()->getMethod());
3457     else
3458       List->setMethod(Method);
3459   }
3460 }
3461 
3462 void ASTReader::makeNamesVisible(const HiddenNames &Names, Module *Owner) {
3463   assert(Owner->NameVisibility != Module::Hidden && "nothing to make visible?");
3464   for (Decl *D : Names) {
3465     bool wasHidden = D->Hidden;
3466     D->Hidden = false;
3467 
3468     if (wasHidden && SemaObj) {
3469       if (ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(D)) {
3470         moveMethodToBackOfGlobalList(*SemaObj, Method);
3471       }
3472     }
3473   }
3474 }
3475 
3476 void ASTReader::makeModuleVisible(Module *Mod,
3477                                   Module::NameVisibilityKind NameVisibility,
3478                                   SourceLocation ImportLoc) {
3479   llvm::SmallPtrSet<Module *, 4> Visited;
3480   SmallVector<Module *, 4> Stack;
3481   Stack.push_back(Mod);
3482   while (!Stack.empty()) {
3483     Mod = Stack.pop_back_val();
3484 
3485     if (NameVisibility <= Mod->NameVisibility) {
3486       // This module already has this level of visibility (or greater), so
3487       // there is nothing more to do.
3488       continue;
3489     }
3490 
3491     if (!Mod->isAvailable()) {
3492       // Modules that aren't available cannot be made visible.
3493       continue;
3494     }
3495 
3496     // Update the module's name visibility.
3497     Mod->NameVisibility = NameVisibility;
3498 
3499     // If we've already deserialized any names from this module,
3500     // mark them as visible.
3501     HiddenNamesMapType::iterator Hidden = HiddenNamesMap.find(Mod);
3502     if (Hidden != HiddenNamesMap.end()) {
3503       auto HiddenNames = std::move(*Hidden);
3504       HiddenNamesMap.erase(Hidden);
3505       makeNamesVisible(HiddenNames.second, HiddenNames.first);
3506       assert(HiddenNamesMap.find(Mod) == HiddenNamesMap.end() &&
3507              "making names visible added hidden names");
3508     }
3509 
3510     // Push any exported modules onto the stack to be marked as visible.
3511     SmallVector<Module *, 16> Exports;
3512     Mod->getExportedModules(Exports);
3513     for (SmallVectorImpl<Module *>::iterator
3514            I = Exports.begin(), E = Exports.end(); I != E; ++I) {
3515       Module *Exported = *I;
3516       if (Visited.insert(Exported).second)
3517         Stack.push_back(Exported);
3518     }
3519   }
3520 }
3521 
3522 /// We've merged the definition \p MergedDef into the existing definition
3523 /// \p Def. Ensure that \p Def is made visible whenever \p MergedDef is made
3524 /// visible.
3525 void ASTReader::mergeDefinitionVisibility(NamedDecl *Def,
3526                                           NamedDecl *MergedDef) {
3527   // FIXME: This doesn't correctly handle the case where MergedDef is visible
3528   // in modules other than its owning module. We should instead give the
3529   // ASTContext a list of merged definitions for Def.
3530   if (Def->isHidden()) {
3531     // If MergedDef is visible or becomes visible, make the definition visible.
3532     if (!MergedDef->isHidden())
3533       Def->Hidden = false;
3534     else if (getContext().getLangOpts().ModulesLocalVisibility) {
3535       getContext().mergeDefinitionIntoModule(
3536           Def, MergedDef->getImportedOwningModule(),
3537           /*NotifyListeners*/ false);
3538       PendingMergedDefinitionsToDeduplicate.insert(Def);
3539     } else {
3540       auto SubmoduleID = MergedDef->getOwningModuleID();
3541       assert(SubmoduleID && "hidden definition in no module");
3542       HiddenNamesMap[getSubmodule(SubmoduleID)].push_back(Def);
3543     }
3544   }
3545 }
3546 
3547 bool ASTReader::loadGlobalIndex() {
3548   if (GlobalIndex)
3549     return false;
3550 
3551   if (TriedLoadingGlobalIndex || !UseGlobalIndex ||
3552       !Context.getLangOpts().Modules)
3553     return true;
3554 
3555   // Try to load the global index.
3556   TriedLoadingGlobalIndex = true;
3557   StringRef ModuleCachePath
3558     = getPreprocessor().getHeaderSearchInfo().getModuleCachePath();
3559   std::pair<GlobalModuleIndex *, GlobalModuleIndex::ErrorCode> Result
3560     = GlobalModuleIndex::readIndex(ModuleCachePath);
3561   if (!Result.first)
3562     return true;
3563 
3564   GlobalIndex.reset(Result.first);
3565   ModuleMgr.setGlobalIndex(GlobalIndex.get());
3566   return false;
3567 }
3568 
3569 bool ASTReader::isGlobalIndexUnavailable() const {
3570   return Context.getLangOpts().Modules && UseGlobalIndex &&
3571          !hasGlobalIndex() && TriedLoadingGlobalIndex;
3572 }
3573 
3574 static void updateModuleTimestamp(ModuleFile &MF) {
3575   // Overwrite the timestamp file contents so that file's mtime changes.
3576   std::string TimestampFilename = MF.getTimestampFilename();
3577   std::error_code EC;
3578   llvm::raw_fd_ostream OS(TimestampFilename, EC, llvm::sys::fs::F_Text);
3579   if (EC)
3580     return;
3581   OS << "Timestamp file\n";
3582 }
3583 
3584 /// \brief Given a cursor at the start of an AST file, scan ahead and drop the
3585 /// cursor into the start of the given block ID, returning false on success and
3586 /// true on failure.
3587 static bool SkipCursorToBlock(BitstreamCursor &Cursor, unsigned BlockID) {
3588   while (true) {
3589     llvm::BitstreamEntry Entry = Cursor.advance();
3590     switch (Entry.Kind) {
3591     case llvm::BitstreamEntry::Error:
3592     case llvm::BitstreamEntry::EndBlock:
3593       return true;
3594 
3595     case llvm::BitstreamEntry::Record:
3596       // Ignore top-level records.
3597       Cursor.skipRecord(Entry.ID);
3598       break;
3599 
3600     case llvm::BitstreamEntry::SubBlock:
3601       if (Entry.ID == BlockID) {
3602         if (Cursor.EnterSubBlock(BlockID))
3603           return true;
3604         // Found it!
3605         return false;
3606       }
3607 
3608       if (Cursor.SkipBlock())
3609         return true;
3610     }
3611   }
3612 }
3613 
3614 ASTReader::ASTReadResult ASTReader::ReadAST(StringRef FileName,
3615                                             ModuleKind Type,
3616                                             SourceLocation ImportLoc,
3617                                             unsigned ClientLoadCapabilities,
3618                                             SmallVectorImpl<ImportedSubmodule> *Imported) {
3619   llvm::SaveAndRestore<SourceLocation>
3620     SetCurImportLocRAII(CurrentImportLoc, ImportLoc);
3621 
3622   // Defer any pending actions until we get to the end of reading the AST file.
3623   Deserializing AnASTFile(this);
3624 
3625   // Bump the generation number.
3626   unsigned PreviousGeneration = incrementGeneration(Context);
3627 
3628   unsigned NumModules = ModuleMgr.size();
3629   SmallVector<ImportedModule, 4> Loaded;
3630   switch(ASTReadResult ReadResult = ReadASTCore(FileName, Type, ImportLoc,
3631                                                 /*ImportedBy=*/nullptr, Loaded,
3632                                                 0, 0, 0,
3633                                                 ClientLoadCapabilities)) {
3634   case Failure:
3635   case Missing:
3636   case OutOfDate:
3637   case VersionMismatch:
3638   case ConfigurationMismatch:
3639   case HadErrors: {
3640     llvm::SmallPtrSet<ModuleFile *, 4> LoadedSet;
3641     for (const ImportedModule &IM : Loaded)
3642       LoadedSet.insert(IM.Mod);
3643 
3644     ModuleMgr.removeModules(ModuleMgr.begin() + NumModules, ModuleMgr.end(),
3645                             LoadedSet,
3646                             Context.getLangOpts().Modules
3647                               ? &PP.getHeaderSearchInfo().getModuleMap()
3648                               : nullptr);
3649 
3650     // If we find that any modules are unusable, the global index is going
3651     // to be out-of-date. Just remove it.
3652     GlobalIndex.reset();
3653     ModuleMgr.setGlobalIndex(nullptr);
3654     return ReadResult;
3655   }
3656   case Success:
3657     break;
3658   }
3659 
3660   // Here comes stuff that we only do once the entire chain is loaded.
3661 
3662   // Load the AST blocks of all of the modules that we loaded.
3663   for (SmallVectorImpl<ImportedModule>::iterator M = Loaded.begin(),
3664                                               MEnd = Loaded.end();
3665        M != MEnd; ++M) {
3666     ModuleFile &F = *M->Mod;
3667 
3668     // Read the AST block.
3669     if (ASTReadResult Result = ReadASTBlock(F, ClientLoadCapabilities))
3670       return Result;
3671 
3672     // Read the extension blocks.
3673     while (!SkipCursorToBlock(F.Stream, EXTENSION_BLOCK_ID)) {
3674       if (ASTReadResult Result = ReadExtensionBlock(F))
3675         return Result;
3676     }
3677 
3678     // Once read, set the ModuleFile bit base offset and update the size in
3679     // bits of all files we've seen.
3680     F.GlobalBitOffset = TotalModulesSizeInBits;
3681     TotalModulesSizeInBits += F.SizeInBits;
3682     GlobalBitOffsetsMap.insert(std::make_pair(F.GlobalBitOffset, &F));
3683 
3684     // Preload SLocEntries.
3685     for (unsigned I = 0, N = F.PreloadSLocEntries.size(); I != N; ++I) {
3686       int Index = int(F.PreloadSLocEntries[I] - 1) + F.SLocEntryBaseID;
3687       // Load it through the SourceManager and don't call ReadSLocEntry()
3688       // directly because the entry may have already been loaded in which case
3689       // calling ReadSLocEntry() directly would trigger an assertion in
3690       // SourceManager.
3691       SourceMgr.getLoadedSLocEntryByID(Index);
3692     }
3693 
3694     // Preload all the pending interesting identifiers by marking them out of
3695     // date.
3696     for (auto Offset : F.PreloadIdentifierOffsets) {
3697       const unsigned char *Data = reinterpret_cast<const unsigned char *>(
3698           F.IdentifierTableData + Offset);
3699 
3700       ASTIdentifierLookupTrait Trait(*this, F);
3701       auto KeyDataLen = Trait.ReadKeyDataLength(Data);
3702       auto Key = Trait.ReadKey(Data, KeyDataLen.first);
3703       auto &II = PP.getIdentifierTable().getOwn(Key);
3704       II.setOutOfDate(true);
3705 
3706       // Mark this identifier as being from an AST file so that we can track
3707       // whether we need to serialize it.
3708       markIdentifierFromAST(*this, II);
3709 
3710       // Associate the ID with the identifier so that the writer can reuse it.
3711       auto ID = Trait.ReadIdentifierID(Data + KeyDataLen.first);
3712       SetIdentifierInfo(ID, &II);
3713     }
3714   }
3715 
3716   // Setup the import locations and notify the module manager that we've
3717   // committed to these module files.
3718   for (SmallVectorImpl<ImportedModule>::iterator M = Loaded.begin(),
3719                                               MEnd = Loaded.end();
3720        M != MEnd; ++M) {
3721     ModuleFile &F = *M->Mod;
3722 
3723     ModuleMgr.moduleFileAccepted(&F);
3724 
3725     // Set the import location.
3726     F.DirectImportLoc = ImportLoc;
3727     // FIXME: We assume that locations from PCH / preamble do not need
3728     // any translation.
3729     if (!M->ImportedBy)
3730       F.ImportLoc = M->ImportLoc;
3731     else
3732       F.ImportLoc = TranslateSourceLocation(*M->ImportedBy, M->ImportLoc);
3733   }
3734 
3735   if (!Context.getLangOpts().CPlusPlus ||
3736       (Type != MK_ImplicitModule && Type != MK_ExplicitModule &&
3737        Type != MK_PrebuiltModule)) {
3738     // Mark all of the identifiers in the identifier table as being out of date,
3739     // so that various accessors know to check the loaded modules when the
3740     // identifier is used.
3741     //
3742     // For C++ modules, we don't need information on many identifiers (just
3743     // those that provide macros or are poisoned), so we mark all of
3744     // the interesting ones via PreloadIdentifierOffsets.
3745     for (IdentifierTable::iterator Id = PP.getIdentifierTable().begin(),
3746                                 IdEnd = PP.getIdentifierTable().end();
3747          Id != IdEnd; ++Id)
3748       Id->second->setOutOfDate(true);
3749   }
3750   // Mark selectors as out of date.
3751   for (auto Sel : SelectorGeneration)
3752     SelectorOutOfDate[Sel.first] = true;
3753 
3754   // Resolve any unresolved module exports.
3755   for (unsigned I = 0, N = UnresolvedModuleRefs.size(); I != N; ++I) {
3756     UnresolvedModuleRef &Unresolved = UnresolvedModuleRefs[I];
3757     SubmoduleID GlobalID = getGlobalSubmoduleID(*Unresolved.File,Unresolved.ID);
3758     Module *ResolvedMod = getSubmodule(GlobalID);
3759 
3760     switch (Unresolved.Kind) {
3761     case UnresolvedModuleRef::Conflict:
3762       if (ResolvedMod) {
3763         Module::Conflict Conflict;
3764         Conflict.Other = ResolvedMod;
3765         Conflict.Message = Unresolved.String.str();
3766         Unresolved.Mod->Conflicts.push_back(Conflict);
3767       }
3768       continue;
3769 
3770     case UnresolvedModuleRef::Import:
3771       if (ResolvedMod)
3772         Unresolved.Mod->Imports.insert(ResolvedMod);
3773       continue;
3774 
3775     case UnresolvedModuleRef::Export:
3776       if (ResolvedMod || Unresolved.IsWildcard)
3777         Unresolved.Mod->Exports.push_back(
3778           Module::ExportDecl(ResolvedMod, Unresolved.IsWildcard));
3779       continue;
3780     }
3781   }
3782   UnresolvedModuleRefs.clear();
3783 
3784   if (Imported)
3785     Imported->append(ImportedModules.begin(),
3786                      ImportedModules.end());
3787 
3788   // FIXME: How do we load the 'use'd modules? They may not be submodules.
3789   // Might be unnecessary as use declarations are only used to build the
3790   // module itself.
3791 
3792   InitializeContext();
3793 
3794   if (SemaObj)
3795     UpdateSema();
3796 
3797   if (DeserializationListener)
3798     DeserializationListener->ReaderInitialized(this);
3799 
3800   ModuleFile &PrimaryModule = ModuleMgr.getPrimaryModule();
3801   if (PrimaryModule.OriginalSourceFileID.isValid()) {
3802     PrimaryModule.OriginalSourceFileID
3803       = FileID::get(PrimaryModule.SLocEntryBaseID
3804                     + PrimaryModule.OriginalSourceFileID.getOpaqueValue() - 1);
3805 
3806     // If this AST file is a precompiled preamble, then set the
3807     // preamble file ID of the source manager to the file source file
3808     // from which the preamble was built.
3809     if (Type == MK_Preamble) {
3810       SourceMgr.setPreambleFileID(PrimaryModule.OriginalSourceFileID);
3811     } else if (Type == MK_MainFile) {
3812       SourceMgr.setMainFileID(PrimaryModule.OriginalSourceFileID);
3813     }
3814   }
3815 
3816   // For any Objective-C class definitions we have already loaded, make sure
3817   // that we load any additional categories.
3818   for (unsigned I = 0, N = ObjCClassesLoaded.size(); I != N; ++I) {
3819     loadObjCCategories(ObjCClassesLoaded[I]->getGlobalID(),
3820                        ObjCClassesLoaded[I],
3821                        PreviousGeneration);
3822   }
3823 
3824   if (PP.getHeaderSearchInfo()
3825           .getHeaderSearchOpts()
3826           .ModulesValidateOncePerBuildSession) {
3827     // Now we are certain that the module and all modules it depends on are
3828     // up to date.  Create or update timestamp files for modules that are
3829     // located in the module cache (not for PCH files that could be anywhere
3830     // in the filesystem).
3831     for (unsigned I = 0, N = Loaded.size(); I != N; ++I) {
3832       ImportedModule &M = Loaded[I];
3833       if (M.Mod->Kind == MK_ImplicitModule) {
3834         updateModuleTimestamp(*M.Mod);
3835       }
3836     }
3837   }
3838 
3839   return Success;
3840 }
3841 
3842 static ASTFileSignature readASTFileSignature(StringRef PCH);
3843 
3844 /// \brief Whether \p Stream starts with the AST/PCH file magic number 'CPCH'.
3845 static bool startsWithASTFileMagic(BitstreamCursor &Stream) {
3846   return Stream.canSkipToPos(4) &&
3847          Stream.Read(8) == 'C' &&
3848          Stream.Read(8) == 'P' &&
3849          Stream.Read(8) == 'C' &&
3850          Stream.Read(8) == 'H';
3851 }
3852 
3853 static unsigned moduleKindForDiagnostic(ModuleKind Kind) {
3854   switch (Kind) {
3855   case MK_PCH:
3856     return 0; // PCH
3857   case MK_ImplicitModule:
3858   case MK_ExplicitModule:
3859   case MK_PrebuiltModule:
3860     return 1; // module
3861   case MK_MainFile:
3862   case MK_Preamble:
3863     return 2; // main source file
3864   }
3865   llvm_unreachable("unknown module kind");
3866 }
3867 
3868 ASTReader::ASTReadResult
3869 ASTReader::ReadASTCore(StringRef FileName,
3870                        ModuleKind Type,
3871                        SourceLocation ImportLoc,
3872                        ModuleFile *ImportedBy,
3873                        SmallVectorImpl<ImportedModule> &Loaded,
3874                        off_t ExpectedSize, time_t ExpectedModTime,
3875                        ASTFileSignature ExpectedSignature,
3876                        unsigned ClientLoadCapabilities) {
3877   ModuleFile *M;
3878   std::string ErrorStr;
3879   ModuleManager::AddModuleResult AddResult
3880     = ModuleMgr.addModule(FileName, Type, ImportLoc, ImportedBy,
3881                           getGeneration(), ExpectedSize, ExpectedModTime,
3882                           ExpectedSignature, readASTFileSignature,
3883                           M, ErrorStr);
3884 
3885   switch (AddResult) {
3886   case ModuleManager::AlreadyLoaded:
3887     return Success;
3888 
3889   case ModuleManager::NewlyLoaded:
3890     // Load module file below.
3891     break;
3892 
3893   case ModuleManager::Missing:
3894     // The module file was missing; if the client can handle that, return
3895     // it.
3896     if (ClientLoadCapabilities & ARR_Missing)
3897       return Missing;
3898 
3899     // Otherwise, return an error.
3900     Diag(diag::err_module_file_not_found) << moduleKindForDiagnostic(Type)
3901                                           << FileName << !ErrorStr.empty()
3902                                           << ErrorStr;
3903     return Failure;
3904 
3905   case ModuleManager::OutOfDate:
3906     // We couldn't load the module file because it is out-of-date. If the
3907     // client can handle out-of-date, return it.
3908     if (ClientLoadCapabilities & ARR_OutOfDate)
3909       return OutOfDate;
3910 
3911     // Otherwise, return an error.
3912     Diag(diag::err_module_file_out_of_date) << moduleKindForDiagnostic(Type)
3913                                             << FileName << !ErrorStr.empty()
3914                                             << ErrorStr;
3915     return Failure;
3916   }
3917 
3918   assert(M && "Missing module file");
3919 
3920   // FIXME: This seems rather a hack. Should CurrentDir be part of the
3921   // module?
3922   if (FileName != "-") {
3923     CurrentDir = llvm::sys::path::parent_path(FileName);
3924     if (CurrentDir.empty()) CurrentDir = ".";
3925   }
3926 
3927   ModuleFile &F = *M;
3928   BitstreamCursor &Stream = F.Stream;
3929   Stream = BitstreamCursor(PCHContainerRdr.ExtractPCH(*F.Buffer));
3930   F.SizeInBits = F.Buffer->getBufferSize() * 8;
3931 
3932   // Sniff for the signature.
3933   if (!startsWithASTFileMagic(Stream)) {
3934     Diag(diag::err_module_file_invalid) << moduleKindForDiagnostic(Type)
3935                                         << FileName;
3936     return Failure;
3937   }
3938 
3939   // This is used for compatibility with older PCH formats.
3940   bool HaveReadControlBlock = false;
3941   while (true) {
3942     llvm::BitstreamEntry Entry = Stream.advance();
3943 
3944     switch (Entry.Kind) {
3945     case llvm::BitstreamEntry::Error:
3946     case llvm::BitstreamEntry::Record:
3947     case llvm::BitstreamEntry::EndBlock:
3948       Error("invalid record at top-level of AST file");
3949       return Failure;
3950 
3951     case llvm::BitstreamEntry::SubBlock:
3952       break;
3953     }
3954 
3955     switch (Entry.ID) {
3956     case CONTROL_BLOCK_ID:
3957       HaveReadControlBlock = true;
3958       switch (ReadControlBlock(F, Loaded, ImportedBy, ClientLoadCapabilities)) {
3959       case Success:
3960         // Check that we didn't try to load a non-module AST file as a module.
3961         //
3962         // FIXME: Should we also perform the converse check? Loading a module as
3963         // a PCH file sort of works, but it's a bit wonky.
3964         if ((Type == MK_ImplicitModule || Type == MK_ExplicitModule ||
3965              Type == MK_PrebuiltModule) &&
3966             F.ModuleName.empty()) {
3967           auto Result = (Type == MK_ImplicitModule) ? OutOfDate : Failure;
3968           if (Result != OutOfDate ||
3969               (ClientLoadCapabilities & ARR_OutOfDate) == 0)
3970             Diag(diag::err_module_file_not_module) << FileName;
3971           return Result;
3972         }
3973         break;
3974 
3975       case Failure: return Failure;
3976       case Missing: return Missing;
3977       case OutOfDate: return OutOfDate;
3978       case VersionMismatch: return VersionMismatch;
3979       case ConfigurationMismatch: return ConfigurationMismatch;
3980       case HadErrors: return HadErrors;
3981       }
3982       break;
3983 
3984     case AST_BLOCK_ID:
3985       if (!HaveReadControlBlock) {
3986         if ((ClientLoadCapabilities & ARR_VersionMismatch) == 0)
3987           Diag(diag::err_pch_version_too_old);
3988         return VersionMismatch;
3989       }
3990 
3991       // Record that we've loaded this module.
3992       Loaded.push_back(ImportedModule(M, ImportedBy, ImportLoc));
3993       return Success;
3994 
3995     default:
3996       if (Stream.SkipBlock()) {
3997         Error("malformed block record in AST file");
3998         return Failure;
3999       }
4000       break;
4001     }
4002   }
4003 
4004   return Success;
4005 }
4006 
4007 /// Parse a record and blob containing module file extension metadata.
4008 static bool parseModuleFileExtensionMetadata(
4009               const SmallVectorImpl<uint64_t> &Record,
4010               StringRef Blob,
4011               ModuleFileExtensionMetadata &Metadata) {
4012   if (Record.size() < 4) return true;
4013 
4014   Metadata.MajorVersion = Record[0];
4015   Metadata.MinorVersion = Record[1];
4016 
4017   unsigned BlockNameLen = Record[2];
4018   unsigned UserInfoLen = Record[3];
4019 
4020   if (BlockNameLen + UserInfoLen > Blob.size()) return true;
4021 
4022   Metadata.BlockName = std::string(Blob.data(), Blob.data() + BlockNameLen);
4023   Metadata.UserInfo = std::string(Blob.data() + BlockNameLen,
4024                                   Blob.data() + BlockNameLen + UserInfoLen);
4025   return false;
4026 }
4027 
4028 ASTReader::ASTReadResult ASTReader::ReadExtensionBlock(ModuleFile &F) {
4029   BitstreamCursor &Stream = F.Stream;
4030 
4031   RecordData Record;
4032   while (true) {
4033     llvm::BitstreamEntry Entry = Stream.advance();
4034     switch (Entry.Kind) {
4035     case llvm::BitstreamEntry::SubBlock:
4036       if (Stream.SkipBlock())
4037         return Failure;
4038 
4039       continue;
4040 
4041     case llvm::BitstreamEntry::EndBlock:
4042       return Success;
4043 
4044     case llvm::BitstreamEntry::Error:
4045       return HadErrors;
4046 
4047     case llvm::BitstreamEntry::Record:
4048       break;
4049     }
4050 
4051     Record.clear();
4052     StringRef Blob;
4053     unsigned RecCode = Stream.readRecord(Entry.ID, Record, &Blob);
4054     switch (RecCode) {
4055     case EXTENSION_METADATA: {
4056       ModuleFileExtensionMetadata Metadata;
4057       if (parseModuleFileExtensionMetadata(Record, Blob, Metadata))
4058         return Failure;
4059 
4060       // Find a module file extension with this block name.
4061       auto Known = ModuleFileExtensions.find(Metadata.BlockName);
4062       if (Known == ModuleFileExtensions.end()) break;
4063 
4064       // Form a reader.
4065       if (auto Reader = Known->second->createExtensionReader(Metadata, *this,
4066                                                              F, Stream)) {
4067         F.ExtensionReaders.push_back(std::move(Reader));
4068       }
4069 
4070       break;
4071     }
4072     }
4073   }
4074 
4075   return Success;
4076 }
4077 
4078 void ASTReader::InitializeContext() {
4079   // If there's a listener, notify them that we "read" the translation unit.
4080   if (DeserializationListener)
4081     DeserializationListener->DeclRead(PREDEF_DECL_TRANSLATION_UNIT_ID,
4082                                       Context.getTranslationUnitDecl());
4083 
4084   // FIXME: Find a better way to deal with collisions between these
4085   // built-in types. Right now, we just ignore the problem.
4086 
4087   // Load the special types.
4088   if (SpecialTypes.size() >= NumSpecialTypeIDs) {
4089     if (unsigned String = SpecialTypes[SPECIAL_TYPE_CF_CONSTANT_STRING]) {
4090       if (!Context.CFConstantStringTypeDecl)
4091         Context.setCFConstantStringType(GetType(String));
4092     }
4093 
4094     if (unsigned File = SpecialTypes[SPECIAL_TYPE_FILE]) {
4095       QualType FileType = GetType(File);
4096       if (FileType.isNull()) {
4097         Error("FILE type is NULL");
4098         return;
4099       }
4100 
4101       if (!Context.FILEDecl) {
4102         if (const TypedefType *Typedef = FileType->getAs<TypedefType>())
4103           Context.setFILEDecl(Typedef->getDecl());
4104         else {
4105           const TagType *Tag = FileType->getAs<TagType>();
4106           if (!Tag) {
4107             Error("Invalid FILE type in AST file");
4108             return;
4109           }
4110           Context.setFILEDecl(Tag->getDecl());
4111         }
4112       }
4113     }
4114 
4115     if (unsigned Jmp_buf = SpecialTypes[SPECIAL_TYPE_JMP_BUF]) {
4116       QualType Jmp_bufType = GetType(Jmp_buf);
4117       if (Jmp_bufType.isNull()) {
4118         Error("jmp_buf type is NULL");
4119         return;
4120       }
4121 
4122       if (!Context.jmp_bufDecl) {
4123         if (const TypedefType *Typedef = Jmp_bufType->getAs<TypedefType>())
4124           Context.setjmp_bufDecl(Typedef->getDecl());
4125         else {
4126           const TagType *Tag = Jmp_bufType->getAs<TagType>();
4127           if (!Tag) {
4128             Error("Invalid jmp_buf type in AST file");
4129             return;
4130           }
4131           Context.setjmp_bufDecl(Tag->getDecl());
4132         }
4133       }
4134     }
4135 
4136     if (unsigned Sigjmp_buf = SpecialTypes[SPECIAL_TYPE_SIGJMP_BUF]) {
4137       QualType Sigjmp_bufType = GetType(Sigjmp_buf);
4138       if (Sigjmp_bufType.isNull()) {
4139         Error("sigjmp_buf type is NULL");
4140         return;
4141       }
4142 
4143       if (!Context.sigjmp_bufDecl) {
4144         if (const TypedefType *Typedef = Sigjmp_bufType->getAs<TypedefType>())
4145           Context.setsigjmp_bufDecl(Typedef->getDecl());
4146         else {
4147           const TagType *Tag = Sigjmp_bufType->getAs<TagType>();
4148           assert(Tag && "Invalid sigjmp_buf type in AST file");
4149           Context.setsigjmp_bufDecl(Tag->getDecl());
4150         }
4151       }
4152     }
4153 
4154     if (unsigned ObjCIdRedef
4155           = SpecialTypes[SPECIAL_TYPE_OBJC_ID_REDEFINITION]) {
4156       if (Context.ObjCIdRedefinitionType.isNull())
4157         Context.ObjCIdRedefinitionType = GetType(ObjCIdRedef);
4158     }
4159 
4160     if (unsigned ObjCClassRedef
4161           = SpecialTypes[SPECIAL_TYPE_OBJC_CLASS_REDEFINITION]) {
4162       if (Context.ObjCClassRedefinitionType.isNull())
4163         Context.ObjCClassRedefinitionType = GetType(ObjCClassRedef);
4164     }
4165 
4166     if (unsigned ObjCSelRedef
4167           = SpecialTypes[SPECIAL_TYPE_OBJC_SEL_REDEFINITION]) {
4168       if (Context.ObjCSelRedefinitionType.isNull())
4169         Context.ObjCSelRedefinitionType = GetType(ObjCSelRedef);
4170     }
4171 
4172     if (unsigned Ucontext_t = SpecialTypes[SPECIAL_TYPE_UCONTEXT_T]) {
4173       QualType Ucontext_tType = GetType(Ucontext_t);
4174       if (Ucontext_tType.isNull()) {
4175         Error("ucontext_t type is NULL");
4176         return;
4177       }
4178 
4179       if (!Context.ucontext_tDecl) {
4180         if (const TypedefType *Typedef = Ucontext_tType->getAs<TypedefType>())
4181           Context.setucontext_tDecl(Typedef->getDecl());
4182         else {
4183           const TagType *Tag = Ucontext_tType->getAs<TagType>();
4184           assert(Tag && "Invalid ucontext_t type in AST file");
4185           Context.setucontext_tDecl(Tag->getDecl());
4186         }
4187       }
4188     }
4189   }
4190 
4191   ReadPragmaDiagnosticMappings(Context.getDiagnostics());
4192 
4193   // If there were any CUDA special declarations, deserialize them.
4194   if (!CUDASpecialDeclRefs.empty()) {
4195     assert(CUDASpecialDeclRefs.size() == 1 && "More decl refs than expected!");
4196     Context.setcudaConfigureCallDecl(
4197                            cast<FunctionDecl>(GetDecl(CUDASpecialDeclRefs[0])));
4198   }
4199 
4200   // Re-export any modules that were imported by a non-module AST file.
4201   // FIXME: This does not make macro-only imports visible again.
4202   for (auto &Import : ImportedModules) {
4203     if (Module *Imported = getSubmodule(Import.ID)) {
4204       makeModuleVisible(Imported, Module::AllVisible,
4205                         /*ImportLoc=*/Import.ImportLoc);
4206       if (Import.ImportLoc.isValid())
4207         PP.makeModuleVisible(Imported, Import.ImportLoc);
4208       // FIXME: should we tell Sema to make the module visible too?
4209     }
4210   }
4211   ImportedModules.clear();
4212 }
4213 
4214 void ASTReader::finalizeForWriting() {
4215   // Nothing to do for now.
4216 }
4217 
4218 /// \brief Reads and return the signature record from \p PCH's control block, or
4219 /// else returns 0.
4220 static ASTFileSignature readASTFileSignature(StringRef PCH) {
4221   BitstreamCursor Stream(PCH);
4222   if (!startsWithASTFileMagic(Stream))
4223     return 0;
4224 
4225   // Scan for the CONTROL_BLOCK_ID block.
4226   if (SkipCursorToBlock(Stream, CONTROL_BLOCK_ID))
4227     return 0;
4228 
4229   // Scan for SIGNATURE inside the control block.
4230   ASTReader::RecordData Record;
4231   while (true) {
4232     llvm::BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
4233     if (Entry.Kind != llvm::BitstreamEntry::Record)
4234       return 0;
4235 
4236     Record.clear();
4237     StringRef Blob;
4238     if (SIGNATURE == Stream.readRecord(Entry.ID, Record, &Blob))
4239       return Record[0];
4240   }
4241 }
4242 
4243 /// \brief Retrieve the name of the original source file name
4244 /// directly from the AST file, without actually loading the AST
4245 /// file.
4246 std::string ASTReader::getOriginalSourceFile(
4247     const std::string &ASTFileName, FileManager &FileMgr,
4248     const PCHContainerReader &PCHContainerRdr, DiagnosticsEngine &Diags) {
4249   // Open the AST file.
4250   auto Buffer = FileMgr.getBufferForFile(ASTFileName);
4251   if (!Buffer) {
4252     Diags.Report(diag::err_fe_unable_to_read_pch_file)
4253         << ASTFileName << Buffer.getError().message();
4254     return std::string();
4255   }
4256 
4257   // Initialize the stream
4258   BitstreamCursor Stream(PCHContainerRdr.ExtractPCH(**Buffer));
4259 
4260   // Sniff for the signature.
4261   if (!startsWithASTFileMagic(Stream)) {
4262     Diags.Report(diag::err_fe_not_a_pch_file) << ASTFileName;
4263     return std::string();
4264   }
4265 
4266   // Scan for the CONTROL_BLOCK_ID block.
4267   if (SkipCursorToBlock(Stream, CONTROL_BLOCK_ID)) {
4268     Diags.Report(diag::err_fe_pch_malformed_block) << ASTFileName;
4269     return std::string();
4270   }
4271 
4272   // Scan for ORIGINAL_FILE inside the control block.
4273   RecordData Record;
4274   while (true) {
4275     llvm::BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
4276     if (Entry.Kind == llvm::BitstreamEntry::EndBlock)
4277       return std::string();
4278 
4279     if (Entry.Kind != llvm::BitstreamEntry::Record) {
4280       Diags.Report(diag::err_fe_pch_malformed_block) << ASTFileName;
4281       return std::string();
4282     }
4283 
4284     Record.clear();
4285     StringRef Blob;
4286     if (Stream.readRecord(Entry.ID, Record, &Blob) == ORIGINAL_FILE)
4287       return Blob.str();
4288   }
4289 }
4290 
4291 namespace {
4292 
4293   class SimplePCHValidator : public ASTReaderListener {
4294     const LangOptions &ExistingLangOpts;
4295     const TargetOptions &ExistingTargetOpts;
4296     const PreprocessorOptions &ExistingPPOpts;
4297     std::string ExistingModuleCachePath;
4298     FileManager &FileMgr;
4299 
4300   public:
4301     SimplePCHValidator(const LangOptions &ExistingLangOpts,
4302                        const TargetOptions &ExistingTargetOpts,
4303                        const PreprocessorOptions &ExistingPPOpts,
4304                        StringRef ExistingModuleCachePath,
4305                        FileManager &FileMgr)
4306       : ExistingLangOpts(ExistingLangOpts),
4307         ExistingTargetOpts(ExistingTargetOpts),
4308         ExistingPPOpts(ExistingPPOpts),
4309         ExistingModuleCachePath(ExistingModuleCachePath),
4310         FileMgr(FileMgr)
4311     {
4312     }
4313 
4314     bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
4315                              bool AllowCompatibleDifferences) override {
4316       return checkLanguageOptions(ExistingLangOpts, LangOpts, nullptr,
4317                                   AllowCompatibleDifferences);
4318     }
4319 
4320     bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
4321                            bool AllowCompatibleDifferences) override {
4322       return checkTargetOptions(ExistingTargetOpts, TargetOpts, nullptr,
4323                                 AllowCompatibleDifferences);
4324     }
4325 
4326     bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
4327                                  StringRef SpecificModuleCachePath,
4328                                  bool Complain) override {
4329       return checkHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
4330                                       ExistingModuleCachePath,
4331                                       nullptr, ExistingLangOpts);
4332     }
4333 
4334     bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
4335                                  bool Complain,
4336                                  std::string &SuggestedPredefines) override {
4337       return checkPreprocessorOptions(ExistingPPOpts, PPOpts, nullptr, FileMgr,
4338                                       SuggestedPredefines, ExistingLangOpts);
4339     }
4340   };
4341 
4342 } // end anonymous namespace
4343 
4344 bool ASTReader::readASTFileControlBlock(
4345     StringRef Filename, FileManager &FileMgr,
4346     const PCHContainerReader &PCHContainerRdr,
4347     bool FindModuleFileExtensions,
4348     ASTReaderListener &Listener, bool ValidateDiagnosticOptions) {
4349   // Open the AST file.
4350   // FIXME: This allows use of the VFS; we do not allow use of the
4351   // VFS when actually loading a module.
4352   auto Buffer = FileMgr.getBufferForFile(Filename);
4353   if (!Buffer) {
4354     return true;
4355   }
4356 
4357   // Initialize the stream
4358   BitstreamCursor Stream(PCHContainerRdr.ExtractPCH(**Buffer));
4359 
4360   // Sniff for the signature.
4361   if (!startsWithASTFileMagic(Stream))
4362     return true;
4363 
4364   // Scan for the CONTROL_BLOCK_ID block.
4365   if (SkipCursorToBlock(Stream, CONTROL_BLOCK_ID))
4366     return true;
4367 
4368   bool NeedsInputFiles = Listener.needsInputFileVisitation();
4369   bool NeedsSystemInputFiles = Listener.needsSystemInputFileVisitation();
4370   bool NeedsImports = Listener.needsImportVisitation();
4371   BitstreamCursor InputFilesCursor;
4372 
4373   RecordData Record;
4374   std::string ModuleDir;
4375   bool DoneWithControlBlock = false;
4376   while (!DoneWithControlBlock) {
4377     llvm::BitstreamEntry Entry = Stream.advance();
4378 
4379     switch (Entry.Kind) {
4380     case llvm::BitstreamEntry::SubBlock: {
4381       switch (Entry.ID) {
4382       case OPTIONS_BLOCK_ID: {
4383         std::string IgnoredSuggestedPredefines;
4384         if (ReadOptionsBlock(Stream, ARR_ConfigurationMismatch | ARR_OutOfDate,
4385                              /*AllowCompatibleConfigurationMismatch*/ false,
4386                              Listener, IgnoredSuggestedPredefines,
4387                              ValidateDiagnosticOptions) != Success)
4388           return true;
4389         break;
4390       }
4391 
4392       case INPUT_FILES_BLOCK_ID:
4393         InputFilesCursor = Stream;
4394         if (Stream.SkipBlock() ||
4395             (NeedsInputFiles &&
4396              ReadBlockAbbrevs(InputFilesCursor, INPUT_FILES_BLOCK_ID)))
4397           return true;
4398         break;
4399 
4400       default:
4401         if (Stream.SkipBlock())
4402           return true;
4403         break;
4404       }
4405 
4406       continue;
4407     }
4408 
4409     case llvm::BitstreamEntry::EndBlock:
4410       DoneWithControlBlock = true;
4411       break;
4412 
4413     case llvm::BitstreamEntry::Error:
4414       return true;
4415 
4416     case llvm::BitstreamEntry::Record:
4417       break;
4418     }
4419 
4420     if (DoneWithControlBlock) break;
4421 
4422     Record.clear();
4423     StringRef Blob;
4424     unsigned RecCode = Stream.readRecord(Entry.ID, Record, &Blob);
4425     switch ((ControlRecordTypes)RecCode) {
4426     case METADATA: {
4427       if (Record[0] != VERSION_MAJOR)
4428         return true;
4429 
4430       if (Listener.ReadFullVersionInformation(Blob))
4431         return true;
4432 
4433       break;
4434     }
4435     case MODULE_NAME:
4436       Listener.ReadModuleName(Blob);
4437       break;
4438     case MODULE_DIRECTORY:
4439       ModuleDir = Blob;
4440       break;
4441     case MODULE_MAP_FILE: {
4442       unsigned Idx = 0;
4443       auto Path = ReadString(Record, Idx);
4444       ResolveImportedPath(Path, ModuleDir);
4445       Listener.ReadModuleMapFile(Path);
4446       break;
4447     }
4448     case INPUT_FILE_OFFSETS: {
4449       if (!NeedsInputFiles)
4450         break;
4451 
4452       unsigned NumInputFiles = Record[0];
4453       unsigned NumUserFiles = Record[1];
4454       const uint64_t *InputFileOffs = (const uint64_t *)Blob.data();
4455       for (unsigned I = 0; I != NumInputFiles; ++I) {
4456         // Go find this input file.
4457         bool isSystemFile = I >= NumUserFiles;
4458 
4459         if (isSystemFile && !NeedsSystemInputFiles)
4460           break; // the rest are system input files
4461 
4462         BitstreamCursor &Cursor = InputFilesCursor;
4463         SavedStreamPosition SavedPosition(Cursor);
4464         Cursor.JumpToBit(InputFileOffs[I]);
4465 
4466         unsigned Code = Cursor.ReadCode();
4467         RecordData Record;
4468         StringRef Blob;
4469         bool shouldContinue = false;
4470         switch ((InputFileRecordTypes)Cursor.readRecord(Code, Record, &Blob)) {
4471         case INPUT_FILE:
4472           bool Overridden = static_cast<bool>(Record[3]);
4473           std::string Filename = Blob;
4474           ResolveImportedPath(Filename, ModuleDir);
4475           shouldContinue = Listener.visitInputFile(
4476               Filename, isSystemFile, Overridden, /*IsExplicitModule*/false);
4477           break;
4478         }
4479         if (!shouldContinue)
4480           break;
4481       }
4482       break;
4483     }
4484 
4485     case IMPORTS: {
4486       if (!NeedsImports)
4487         break;
4488 
4489       unsigned Idx = 0, N = Record.size();
4490       while (Idx < N) {
4491         // Read information about the AST file.
4492         Idx += 5; // ImportLoc, Size, ModTime, Signature
4493         std::string Filename = ReadString(Record, Idx);
4494         ResolveImportedPath(Filename, ModuleDir);
4495         Listener.visitImport(Filename);
4496       }
4497       break;
4498     }
4499 
4500     default:
4501       // No other validation to perform.
4502       break;
4503     }
4504   }
4505 
4506   // Look for module file extension blocks, if requested.
4507   if (FindModuleFileExtensions) {
4508     while (!SkipCursorToBlock(Stream, EXTENSION_BLOCK_ID)) {
4509       bool DoneWithExtensionBlock = false;
4510       while (!DoneWithExtensionBlock) {
4511        llvm::BitstreamEntry Entry = Stream.advance();
4512 
4513        switch (Entry.Kind) {
4514        case llvm::BitstreamEntry::SubBlock:
4515          if (Stream.SkipBlock())
4516            return true;
4517 
4518          continue;
4519 
4520        case llvm::BitstreamEntry::EndBlock:
4521          DoneWithExtensionBlock = true;
4522          continue;
4523 
4524        case llvm::BitstreamEntry::Error:
4525          return true;
4526 
4527        case llvm::BitstreamEntry::Record:
4528          break;
4529        }
4530 
4531        Record.clear();
4532        StringRef Blob;
4533        unsigned RecCode = Stream.readRecord(Entry.ID, Record, &Blob);
4534        switch (RecCode) {
4535        case EXTENSION_METADATA: {
4536          ModuleFileExtensionMetadata Metadata;
4537          if (parseModuleFileExtensionMetadata(Record, Blob, Metadata))
4538            return true;
4539 
4540          Listener.readModuleFileExtension(Metadata);
4541          break;
4542        }
4543        }
4544       }
4545     }
4546   }
4547 
4548   return false;
4549 }
4550 
4551 bool ASTReader::isAcceptableASTFile(
4552     StringRef Filename, FileManager &FileMgr,
4553     const PCHContainerReader &PCHContainerRdr, const LangOptions &LangOpts,
4554     const TargetOptions &TargetOpts, const PreprocessorOptions &PPOpts,
4555     std::string ExistingModuleCachePath) {
4556   SimplePCHValidator validator(LangOpts, TargetOpts, PPOpts,
4557                                ExistingModuleCachePath, FileMgr);
4558   return !readASTFileControlBlock(Filename, FileMgr, PCHContainerRdr,
4559                                   /*FindModuleFileExtensions=*/false,
4560                                   validator,
4561                                   /*ValidateDiagnosticOptions=*/true);
4562 }
4563 
4564 ASTReader::ASTReadResult
4565 ASTReader::ReadSubmoduleBlock(ModuleFile &F, unsigned ClientLoadCapabilities) {
4566   // Enter the submodule block.
4567   if (F.Stream.EnterSubBlock(SUBMODULE_BLOCK_ID)) {
4568     Error("malformed submodule block record in AST file");
4569     return Failure;
4570   }
4571 
4572   ModuleMap &ModMap = PP.getHeaderSearchInfo().getModuleMap();
4573   bool First = true;
4574   Module *CurrentModule = nullptr;
4575   RecordData Record;
4576   while (true) {
4577     llvm::BitstreamEntry Entry = F.Stream.advanceSkippingSubblocks();
4578 
4579     switch (Entry.Kind) {
4580     case llvm::BitstreamEntry::SubBlock: // Handled for us already.
4581     case llvm::BitstreamEntry::Error:
4582       Error("malformed block record in AST file");
4583       return Failure;
4584     case llvm::BitstreamEntry::EndBlock:
4585       return Success;
4586     case llvm::BitstreamEntry::Record:
4587       // The interesting case.
4588       break;
4589     }
4590 
4591     // Read a record.
4592     StringRef Blob;
4593     Record.clear();
4594     auto Kind = F.Stream.readRecord(Entry.ID, Record, &Blob);
4595 
4596     if ((Kind == SUBMODULE_METADATA) != First) {
4597       Error("submodule metadata record should be at beginning of block");
4598       return Failure;
4599     }
4600     First = false;
4601 
4602     // Submodule information is only valid if we have a current module.
4603     // FIXME: Should we error on these cases?
4604     if (!CurrentModule && Kind != SUBMODULE_METADATA &&
4605         Kind != SUBMODULE_DEFINITION)
4606       continue;
4607 
4608     switch (Kind) {
4609     default:  // Default behavior: ignore.
4610       break;
4611 
4612     case SUBMODULE_DEFINITION: {
4613       if (Record.size() < 8) {
4614         Error("malformed module definition");
4615         return Failure;
4616       }
4617 
4618       StringRef Name = Blob;
4619       unsigned Idx = 0;
4620       SubmoduleID GlobalID = getGlobalSubmoduleID(F, Record[Idx++]);
4621       SubmoduleID Parent = getGlobalSubmoduleID(F, Record[Idx++]);
4622       bool IsFramework = Record[Idx++];
4623       bool IsExplicit = Record[Idx++];
4624       bool IsSystem = Record[Idx++];
4625       bool IsExternC = Record[Idx++];
4626       bool InferSubmodules = Record[Idx++];
4627       bool InferExplicitSubmodules = Record[Idx++];
4628       bool InferExportWildcard = Record[Idx++];
4629       bool ConfigMacrosExhaustive = Record[Idx++];
4630 
4631       Module *ParentModule = nullptr;
4632       if (Parent)
4633         ParentModule = getSubmodule(Parent);
4634 
4635       // Retrieve this (sub)module from the module map, creating it if
4636       // necessary.
4637       CurrentModule = ModMap.findOrCreateModule(Name, ParentModule, IsFramework,
4638                                                 IsExplicit).first;
4639 
4640       // FIXME: set the definition loc for CurrentModule, or call
4641       // ModMap.setInferredModuleAllowedBy()
4642 
4643       SubmoduleID GlobalIndex = GlobalID - NUM_PREDEF_SUBMODULE_IDS;
4644       if (GlobalIndex >= SubmodulesLoaded.size() ||
4645           SubmodulesLoaded[GlobalIndex]) {
4646         Error("too many submodules");
4647         return Failure;
4648       }
4649 
4650       if (!ParentModule) {
4651         if (const FileEntry *CurFile = CurrentModule->getASTFile()) {
4652           if (CurFile != F.File) {
4653             if (!Diags.isDiagnosticInFlight()) {
4654               Diag(diag::err_module_file_conflict)
4655                 << CurrentModule->getTopLevelModuleName()
4656                 << CurFile->getName()
4657                 << F.File->getName();
4658             }
4659             return Failure;
4660           }
4661         }
4662 
4663         CurrentModule->setASTFile(F.File);
4664       }
4665 
4666       CurrentModule->Signature = F.Signature;
4667       CurrentModule->IsFromModuleFile = true;
4668       CurrentModule->IsSystem = IsSystem || CurrentModule->IsSystem;
4669       CurrentModule->IsExternC = IsExternC;
4670       CurrentModule->InferSubmodules = InferSubmodules;
4671       CurrentModule->InferExplicitSubmodules = InferExplicitSubmodules;
4672       CurrentModule->InferExportWildcard = InferExportWildcard;
4673       CurrentModule->ConfigMacrosExhaustive = ConfigMacrosExhaustive;
4674       if (DeserializationListener)
4675         DeserializationListener->ModuleRead(GlobalID, CurrentModule);
4676 
4677       SubmodulesLoaded[GlobalIndex] = CurrentModule;
4678 
4679       // Clear out data that will be replaced by what is in the module file.
4680       CurrentModule->LinkLibraries.clear();
4681       CurrentModule->ConfigMacros.clear();
4682       CurrentModule->UnresolvedConflicts.clear();
4683       CurrentModule->Conflicts.clear();
4684 
4685       // The module is available unless it's missing a requirement; relevant
4686       // requirements will be (re-)added by SUBMODULE_REQUIRES records.
4687       // Missing headers that were present when the module was built do not
4688       // make it unavailable -- if we got this far, this must be an explicitly
4689       // imported module file.
4690       CurrentModule->Requirements.clear();
4691       CurrentModule->MissingHeaders.clear();
4692       CurrentModule->IsMissingRequirement =
4693           ParentModule && ParentModule->IsMissingRequirement;
4694       CurrentModule->IsAvailable = !CurrentModule->IsMissingRequirement;
4695       break;
4696     }
4697 
4698     case SUBMODULE_UMBRELLA_HEADER: {
4699       std::string Filename = Blob;
4700       ResolveImportedPath(F, Filename);
4701       if (auto *Umbrella = PP.getFileManager().getFile(Filename)) {
4702         if (!CurrentModule->getUmbrellaHeader())
4703           ModMap.setUmbrellaHeader(CurrentModule, Umbrella, Blob);
4704         else if (CurrentModule->getUmbrellaHeader().Entry != Umbrella) {
4705           // This can be a spurious difference caused by changing the VFS to
4706           // point to a different copy of the file, and it is too late to
4707           // to rebuild safely.
4708           // FIXME: If we wrote the virtual paths instead of the 'real' paths,
4709           // after input file validation only real problems would remain and we
4710           // could just error. For now, assume it's okay.
4711           break;
4712         }
4713       }
4714       break;
4715     }
4716 
4717     case SUBMODULE_HEADER:
4718     case SUBMODULE_EXCLUDED_HEADER:
4719     case SUBMODULE_PRIVATE_HEADER:
4720       // We lazily associate headers with their modules via the HeaderInfo table.
4721       // FIXME: Re-evaluate this section; maybe only store InputFile IDs instead
4722       // of complete filenames or remove it entirely.
4723       break;
4724 
4725     case SUBMODULE_TEXTUAL_HEADER:
4726     case SUBMODULE_PRIVATE_TEXTUAL_HEADER:
4727       // FIXME: Textual headers are not marked in the HeaderInfo table. Load
4728       // them here.
4729       break;
4730 
4731     case SUBMODULE_TOPHEADER: {
4732       CurrentModule->addTopHeaderFilename(Blob);
4733       break;
4734     }
4735 
4736     case SUBMODULE_UMBRELLA_DIR: {
4737       std::string Dirname = Blob;
4738       ResolveImportedPath(F, Dirname);
4739       if (auto *Umbrella = PP.getFileManager().getDirectory(Dirname)) {
4740         if (!CurrentModule->getUmbrellaDir())
4741           ModMap.setUmbrellaDir(CurrentModule, Umbrella, Blob);
4742         else if (CurrentModule->getUmbrellaDir().Entry != Umbrella) {
4743           if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
4744             Error("mismatched umbrella directories in submodule");
4745           return OutOfDate;
4746         }
4747       }
4748       break;
4749     }
4750 
4751     case SUBMODULE_METADATA: {
4752       F.BaseSubmoduleID = getTotalNumSubmodules();
4753       F.LocalNumSubmodules = Record[0];
4754       unsigned LocalBaseSubmoduleID = Record[1];
4755       if (F.LocalNumSubmodules > 0) {
4756         // Introduce the global -> local mapping for submodules within this
4757         // module.
4758         GlobalSubmoduleMap.insert(std::make_pair(getTotalNumSubmodules()+1,&F));
4759 
4760         // Introduce the local -> global mapping for submodules within this
4761         // module.
4762         F.SubmoduleRemap.insertOrReplace(
4763           std::make_pair(LocalBaseSubmoduleID,
4764                          F.BaseSubmoduleID - LocalBaseSubmoduleID));
4765 
4766         SubmodulesLoaded.resize(SubmodulesLoaded.size() + F.LocalNumSubmodules);
4767       }
4768       break;
4769     }
4770 
4771     case SUBMODULE_IMPORTS: {
4772       for (unsigned Idx = 0; Idx != Record.size(); ++Idx) {
4773         UnresolvedModuleRef Unresolved;
4774         Unresolved.File = &F;
4775         Unresolved.Mod = CurrentModule;
4776         Unresolved.ID = Record[Idx];
4777         Unresolved.Kind = UnresolvedModuleRef::Import;
4778         Unresolved.IsWildcard = false;
4779         UnresolvedModuleRefs.push_back(Unresolved);
4780       }
4781       break;
4782     }
4783 
4784     case SUBMODULE_EXPORTS: {
4785       for (unsigned Idx = 0; Idx + 1 < Record.size(); Idx += 2) {
4786         UnresolvedModuleRef Unresolved;
4787         Unresolved.File = &F;
4788         Unresolved.Mod = CurrentModule;
4789         Unresolved.ID = Record[Idx];
4790         Unresolved.Kind = UnresolvedModuleRef::Export;
4791         Unresolved.IsWildcard = Record[Idx + 1];
4792         UnresolvedModuleRefs.push_back(Unresolved);
4793       }
4794 
4795       // Once we've loaded the set of exports, there's no reason to keep
4796       // the parsed, unresolved exports around.
4797       CurrentModule->UnresolvedExports.clear();
4798       break;
4799     }
4800     case SUBMODULE_REQUIRES: {
4801       CurrentModule->addRequirement(Blob, Record[0], Context.getLangOpts(),
4802                                     Context.getTargetInfo());
4803       break;
4804     }
4805 
4806     case SUBMODULE_LINK_LIBRARY:
4807       CurrentModule->LinkLibraries.push_back(
4808                                          Module::LinkLibrary(Blob, Record[0]));
4809       break;
4810 
4811     case SUBMODULE_CONFIG_MACRO:
4812       CurrentModule->ConfigMacros.push_back(Blob.str());
4813       break;
4814 
4815     case SUBMODULE_CONFLICT: {
4816       UnresolvedModuleRef Unresolved;
4817       Unresolved.File = &F;
4818       Unresolved.Mod = CurrentModule;
4819       Unresolved.ID = Record[0];
4820       Unresolved.Kind = UnresolvedModuleRef::Conflict;
4821       Unresolved.IsWildcard = false;
4822       Unresolved.String = Blob;
4823       UnresolvedModuleRefs.push_back(Unresolved);
4824       break;
4825     }
4826 
4827     case SUBMODULE_INITIALIZERS:
4828       SmallVector<uint32_t, 16> Inits;
4829       for (auto &ID : Record)
4830         Inits.push_back(getGlobalDeclID(F, ID));
4831       Context.addLazyModuleInitializers(CurrentModule, Inits);
4832       break;
4833     }
4834   }
4835 }
4836 
4837 /// \brief Parse the record that corresponds to a LangOptions data
4838 /// structure.
4839 ///
4840 /// This routine parses the language options from the AST file and then gives
4841 /// them to the AST listener if one is set.
4842 ///
4843 /// \returns true if the listener deems the file unacceptable, false otherwise.
4844 bool ASTReader::ParseLanguageOptions(const RecordData &Record,
4845                                      bool Complain,
4846                                      ASTReaderListener &Listener,
4847                                      bool AllowCompatibleDifferences) {
4848   LangOptions LangOpts;
4849   unsigned Idx = 0;
4850 #define LANGOPT(Name, Bits, Default, Description) \
4851   LangOpts.Name = Record[Idx++];
4852 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
4853   LangOpts.set##Name(static_cast<LangOptions::Type>(Record[Idx++]));
4854 #include "clang/Basic/LangOptions.def"
4855 #define SANITIZER(NAME, ID)                                                    \
4856   LangOpts.Sanitize.set(SanitizerKind::ID, Record[Idx++]);
4857 #include "clang/Basic/Sanitizers.def"
4858 
4859   for (unsigned N = Record[Idx++]; N; --N)
4860     LangOpts.ModuleFeatures.push_back(ReadString(Record, Idx));
4861 
4862   ObjCRuntime::Kind runtimeKind = (ObjCRuntime::Kind) Record[Idx++];
4863   VersionTuple runtimeVersion = ReadVersionTuple(Record, Idx);
4864   LangOpts.ObjCRuntime = ObjCRuntime(runtimeKind, runtimeVersion);
4865 
4866   LangOpts.CurrentModule = ReadString(Record, Idx);
4867 
4868   // Comment options.
4869   for (unsigned N = Record[Idx++]; N; --N) {
4870     LangOpts.CommentOpts.BlockCommandNames.push_back(
4871       ReadString(Record, Idx));
4872   }
4873   LangOpts.CommentOpts.ParseAllComments = Record[Idx++];
4874 
4875   // OpenMP offloading options.
4876   for (unsigned N = Record[Idx++]; N; --N) {
4877     LangOpts.OMPTargetTriples.push_back(llvm::Triple(ReadString(Record, Idx)));
4878   }
4879 
4880   LangOpts.OMPHostIRFile = ReadString(Record, Idx);
4881 
4882   return Listener.ReadLanguageOptions(LangOpts, Complain,
4883                                       AllowCompatibleDifferences);
4884 }
4885 
4886 bool ASTReader::ParseTargetOptions(const RecordData &Record, bool Complain,
4887                                    ASTReaderListener &Listener,
4888                                    bool AllowCompatibleDifferences) {
4889   unsigned Idx = 0;
4890   TargetOptions TargetOpts;
4891   TargetOpts.Triple = ReadString(Record, Idx);
4892   TargetOpts.CPU = ReadString(Record, Idx);
4893   TargetOpts.ABI = ReadString(Record, Idx);
4894   for (unsigned N = Record[Idx++]; N; --N) {
4895     TargetOpts.FeaturesAsWritten.push_back(ReadString(Record, Idx));
4896   }
4897   for (unsigned N = Record[Idx++]; N; --N) {
4898     TargetOpts.Features.push_back(ReadString(Record, Idx));
4899   }
4900 
4901   return Listener.ReadTargetOptions(TargetOpts, Complain,
4902                                     AllowCompatibleDifferences);
4903 }
4904 
4905 bool ASTReader::ParseDiagnosticOptions(const RecordData &Record, bool Complain,
4906                                        ASTReaderListener &Listener) {
4907   IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts(new DiagnosticOptions);
4908   unsigned Idx = 0;
4909 #define DIAGOPT(Name, Bits, Default) DiagOpts->Name = Record[Idx++];
4910 #define ENUM_DIAGOPT(Name, Type, Bits, Default) \
4911   DiagOpts->set##Name(static_cast<Type>(Record[Idx++]));
4912 #include "clang/Basic/DiagnosticOptions.def"
4913 
4914   for (unsigned N = Record[Idx++]; N; --N)
4915     DiagOpts->Warnings.push_back(ReadString(Record, Idx));
4916   for (unsigned N = Record[Idx++]; N; --N)
4917     DiagOpts->Remarks.push_back(ReadString(Record, Idx));
4918 
4919   return Listener.ReadDiagnosticOptions(DiagOpts, Complain);
4920 }
4921 
4922 bool ASTReader::ParseFileSystemOptions(const RecordData &Record, bool Complain,
4923                                        ASTReaderListener &Listener) {
4924   FileSystemOptions FSOpts;
4925   unsigned Idx = 0;
4926   FSOpts.WorkingDir = ReadString(Record, Idx);
4927   return Listener.ReadFileSystemOptions(FSOpts, Complain);
4928 }
4929 
4930 bool ASTReader::ParseHeaderSearchOptions(const RecordData &Record,
4931                                          bool Complain,
4932                                          ASTReaderListener &Listener) {
4933   HeaderSearchOptions HSOpts;
4934   unsigned Idx = 0;
4935   HSOpts.Sysroot = ReadString(Record, Idx);
4936 
4937   // Include entries.
4938   for (unsigned N = Record[Idx++]; N; --N) {
4939     std::string Path = ReadString(Record, Idx);
4940     frontend::IncludeDirGroup Group
4941       = static_cast<frontend::IncludeDirGroup>(Record[Idx++]);
4942     bool IsFramework = Record[Idx++];
4943     bool IgnoreSysRoot = Record[Idx++];
4944     HSOpts.UserEntries.emplace_back(std::move(Path), Group, IsFramework,
4945                                     IgnoreSysRoot);
4946   }
4947 
4948   // System header prefixes.
4949   for (unsigned N = Record[Idx++]; N; --N) {
4950     std::string Prefix = ReadString(Record, Idx);
4951     bool IsSystemHeader = Record[Idx++];
4952     HSOpts.SystemHeaderPrefixes.emplace_back(std::move(Prefix), IsSystemHeader);
4953   }
4954 
4955   HSOpts.ResourceDir = ReadString(Record, Idx);
4956   HSOpts.ModuleCachePath = ReadString(Record, Idx);
4957   HSOpts.ModuleUserBuildPath = ReadString(Record, Idx);
4958   HSOpts.DisableModuleHash = Record[Idx++];
4959   HSOpts.UseBuiltinIncludes = Record[Idx++];
4960   HSOpts.UseStandardSystemIncludes = Record[Idx++];
4961   HSOpts.UseStandardCXXIncludes = Record[Idx++];
4962   HSOpts.UseLibcxx = Record[Idx++];
4963   std::string SpecificModuleCachePath = ReadString(Record, Idx);
4964 
4965   return Listener.ReadHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
4966                                           Complain);
4967 }
4968 
4969 bool ASTReader::ParsePreprocessorOptions(const RecordData &Record,
4970                                          bool Complain,
4971                                          ASTReaderListener &Listener,
4972                                          std::string &SuggestedPredefines) {
4973   PreprocessorOptions PPOpts;
4974   unsigned Idx = 0;
4975 
4976   // Macro definitions/undefs
4977   for (unsigned N = Record[Idx++]; N; --N) {
4978     std::string Macro = ReadString(Record, Idx);
4979     bool IsUndef = Record[Idx++];
4980     PPOpts.Macros.push_back(std::make_pair(Macro, IsUndef));
4981   }
4982 
4983   // Includes
4984   for (unsigned N = Record[Idx++]; N; --N) {
4985     PPOpts.Includes.push_back(ReadString(Record, Idx));
4986   }
4987 
4988   // Macro Includes
4989   for (unsigned N = Record[Idx++]; N; --N) {
4990     PPOpts.MacroIncludes.push_back(ReadString(Record, Idx));
4991   }
4992 
4993   PPOpts.UsePredefines = Record[Idx++];
4994   PPOpts.DetailedRecord = Record[Idx++];
4995   PPOpts.ImplicitPCHInclude = ReadString(Record, Idx);
4996   PPOpts.ImplicitPTHInclude = ReadString(Record, Idx);
4997   PPOpts.ObjCXXARCStandardLibrary =
4998     static_cast<ObjCXXARCStandardLibraryKind>(Record[Idx++]);
4999   SuggestedPredefines.clear();
5000   return Listener.ReadPreprocessorOptions(PPOpts, Complain,
5001                                           SuggestedPredefines);
5002 }
5003 
5004 std::pair<ModuleFile *, unsigned>
5005 ASTReader::getModulePreprocessedEntity(unsigned GlobalIndex) {
5006   GlobalPreprocessedEntityMapType::iterator
5007   I = GlobalPreprocessedEntityMap.find(GlobalIndex);
5008   assert(I != GlobalPreprocessedEntityMap.end() &&
5009          "Corrupted global preprocessed entity map");
5010   ModuleFile *M = I->second;
5011   unsigned LocalIndex = GlobalIndex - M->BasePreprocessedEntityID;
5012   return std::make_pair(M, LocalIndex);
5013 }
5014 
5015 llvm::iterator_range<PreprocessingRecord::iterator>
5016 ASTReader::getModulePreprocessedEntities(ModuleFile &Mod) const {
5017   if (PreprocessingRecord *PPRec = PP.getPreprocessingRecord())
5018     return PPRec->getIteratorsForLoadedRange(Mod.BasePreprocessedEntityID,
5019                                              Mod.NumPreprocessedEntities);
5020 
5021   return llvm::make_range(PreprocessingRecord::iterator(),
5022                           PreprocessingRecord::iterator());
5023 }
5024 
5025 llvm::iterator_range<ASTReader::ModuleDeclIterator>
5026 ASTReader::getModuleFileLevelDecls(ModuleFile &Mod) {
5027   return llvm::make_range(
5028       ModuleDeclIterator(this, &Mod, Mod.FileSortedDecls),
5029       ModuleDeclIterator(this, &Mod,
5030                          Mod.FileSortedDecls + Mod.NumFileSortedDecls));
5031 }
5032 
5033 PreprocessedEntity *ASTReader::ReadPreprocessedEntity(unsigned Index) {
5034   PreprocessedEntityID PPID = Index+1;
5035   std::pair<ModuleFile *, unsigned> PPInfo = getModulePreprocessedEntity(Index);
5036   ModuleFile &M = *PPInfo.first;
5037   unsigned LocalIndex = PPInfo.second;
5038   const PPEntityOffset &PPOffs = M.PreprocessedEntityOffsets[LocalIndex];
5039 
5040   if (!PP.getPreprocessingRecord()) {
5041     Error("no preprocessing record");
5042     return nullptr;
5043   }
5044 
5045   SavedStreamPosition SavedPosition(M.PreprocessorDetailCursor);
5046   M.PreprocessorDetailCursor.JumpToBit(PPOffs.BitOffset);
5047 
5048   llvm::BitstreamEntry Entry =
5049     M.PreprocessorDetailCursor.advance(BitstreamCursor::AF_DontPopBlockAtEnd);
5050   if (Entry.Kind != llvm::BitstreamEntry::Record)
5051     return nullptr;
5052 
5053   // Read the record.
5054   SourceRange Range(TranslateSourceLocation(M, PPOffs.getBegin()),
5055                     TranslateSourceLocation(M, PPOffs.getEnd()));
5056   PreprocessingRecord &PPRec = *PP.getPreprocessingRecord();
5057   StringRef Blob;
5058   RecordData Record;
5059   PreprocessorDetailRecordTypes RecType =
5060     (PreprocessorDetailRecordTypes)M.PreprocessorDetailCursor.readRecord(
5061                                           Entry.ID, Record, &Blob);
5062   switch (RecType) {
5063   case PPD_MACRO_EXPANSION: {
5064     bool isBuiltin = Record[0];
5065     IdentifierInfo *Name = nullptr;
5066     MacroDefinitionRecord *Def = nullptr;
5067     if (isBuiltin)
5068       Name = getLocalIdentifier(M, Record[1]);
5069     else {
5070       PreprocessedEntityID GlobalID =
5071           getGlobalPreprocessedEntityID(M, Record[1]);
5072       Def = cast<MacroDefinitionRecord>(
5073           PPRec.getLoadedPreprocessedEntity(GlobalID - 1));
5074     }
5075 
5076     MacroExpansion *ME;
5077     if (isBuiltin)
5078       ME = new (PPRec) MacroExpansion(Name, Range);
5079     else
5080       ME = new (PPRec) MacroExpansion(Def, Range);
5081 
5082     return ME;
5083   }
5084 
5085   case PPD_MACRO_DEFINITION: {
5086     // Decode the identifier info and then check again; if the macro is
5087     // still defined and associated with the identifier,
5088     IdentifierInfo *II = getLocalIdentifier(M, Record[0]);
5089     MacroDefinitionRecord *MD = new (PPRec) MacroDefinitionRecord(II, Range);
5090 
5091     if (DeserializationListener)
5092       DeserializationListener->MacroDefinitionRead(PPID, MD);
5093 
5094     return MD;
5095   }
5096 
5097   case PPD_INCLUSION_DIRECTIVE: {
5098     const char *FullFileNameStart = Blob.data() + Record[0];
5099     StringRef FullFileName(FullFileNameStart, Blob.size() - Record[0]);
5100     const FileEntry *File = nullptr;
5101     if (!FullFileName.empty())
5102       File = PP.getFileManager().getFile(FullFileName);
5103 
5104     // FIXME: Stable encoding
5105     InclusionDirective::InclusionKind Kind
5106       = static_cast<InclusionDirective::InclusionKind>(Record[2]);
5107     InclusionDirective *ID
5108       = new (PPRec) InclusionDirective(PPRec, Kind,
5109                                        StringRef(Blob.data(), Record[0]),
5110                                        Record[1], Record[3],
5111                                        File,
5112                                        Range);
5113     return ID;
5114   }
5115   }
5116 
5117   llvm_unreachable("Invalid PreprocessorDetailRecordTypes");
5118 }
5119 
5120 /// \brief \arg SLocMapI points at a chunk of a module that contains no
5121 /// preprocessed entities or the entities it contains are not the ones we are
5122 /// looking for. Find the next module that contains entities and return the ID
5123 /// of the first entry.
5124 PreprocessedEntityID ASTReader::findNextPreprocessedEntity(
5125                        GlobalSLocOffsetMapType::const_iterator SLocMapI) const {
5126   ++SLocMapI;
5127   for (GlobalSLocOffsetMapType::const_iterator
5128          EndI = GlobalSLocOffsetMap.end(); SLocMapI != EndI; ++SLocMapI) {
5129     ModuleFile &M = *SLocMapI->second;
5130     if (M.NumPreprocessedEntities)
5131       return M.BasePreprocessedEntityID;
5132   }
5133 
5134   return getTotalNumPreprocessedEntities();
5135 }
5136 
5137 namespace {
5138 
5139 struct PPEntityComp {
5140   const ASTReader &Reader;
5141   ModuleFile &M;
5142 
5143   PPEntityComp(const ASTReader &Reader, ModuleFile &M) : Reader(Reader), M(M) { }
5144 
5145   bool operator()(const PPEntityOffset &L, const PPEntityOffset &R) const {
5146     SourceLocation LHS = getLoc(L);
5147     SourceLocation RHS = getLoc(R);
5148     return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
5149   }
5150 
5151   bool operator()(const PPEntityOffset &L, SourceLocation RHS) const {
5152     SourceLocation LHS = getLoc(L);
5153     return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
5154   }
5155 
5156   bool operator()(SourceLocation LHS, const PPEntityOffset &R) const {
5157     SourceLocation RHS = getLoc(R);
5158     return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
5159   }
5160 
5161   SourceLocation getLoc(const PPEntityOffset &PPE) const {
5162     return Reader.TranslateSourceLocation(M, PPE.getBegin());
5163   }
5164 };
5165 
5166 } // end anonymous namespace
5167 
5168 PreprocessedEntityID ASTReader::findPreprocessedEntity(SourceLocation Loc,
5169                                                        bool EndsAfter) const {
5170   if (SourceMgr.isLocalSourceLocation(Loc))
5171     return getTotalNumPreprocessedEntities();
5172 
5173   GlobalSLocOffsetMapType::const_iterator SLocMapI = GlobalSLocOffsetMap.find(
5174       SourceManager::MaxLoadedOffset - Loc.getOffset() - 1);
5175   assert(SLocMapI != GlobalSLocOffsetMap.end() &&
5176          "Corrupted global sloc offset map");
5177 
5178   if (SLocMapI->second->NumPreprocessedEntities == 0)
5179     return findNextPreprocessedEntity(SLocMapI);
5180 
5181   ModuleFile &M = *SLocMapI->second;
5182   typedef const PPEntityOffset *pp_iterator;
5183   pp_iterator pp_begin = M.PreprocessedEntityOffsets;
5184   pp_iterator pp_end = pp_begin + M.NumPreprocessedEntities;
5185 
5186   size_t Count = M.NumPreprocessedEntities;
5187   size_t Half;
5188   pp_iterator First = pp_begin;
5189   pp_iterator PPI;
5190 
5191   if (EndsAfter) {
5192     PPI = std::upper_bound(pp_begin, pp_end, Loc,
5193                            PPEntityComp(*this, M));
5194   } else {
5195     // Do a binary search manually instead of using std::lower_bound because
5196     // The end locations of entities may be unordered (when a macro expansion
5197     // is inside another macro argument), but for this case it is not important
5198     // whether we get the first macro expansion or its containing macro.
5199     while (Count > 0) {
5200       Half = Count / 2;
5201       PPI = First;
5202       std::advance(PPI, Half);
5203       if (SourceMgr.isBeforeInTranslationUnit(
5204               TranslateSourceLocation(M, PPI->getEnd()), Loc)) {
5205         First = PPI;
5206         ++First;
5207         Count = Count - Half - 1;
5208       } else
5209         Count = Half;
5210     }
5211   }
5212 
5213   if (PPI == pp_end)
5214     return findNextPreprocessedEntity(SLocMapI);
5215 
5216   return M.BasePreprocessedEntityID + (PPI - pp_begin);
5217 }
5218 
5219 /// \brief Returns a pair of [Begin, End) indices of preallocated
5220 /// preprocessed entities that \arg Range encompasses.
5221 std::pair<unsigned, unsigned>
5222     ASTReader::findPreprocessedEntitiesInRange(SourceRange Range) {
5223   if (Range.isInvalid())
5224     return std::make_pair(0,0);
5225   assert(!SourceMgr.isBeforeInTranslationUnit(Range.getEnd(),Range.getBegin()));
5226 
5227   PreprocessedEntityID BeginID =
5228       findPreprocessedEntity(Range.getBegin(), false);
5229   PreprocessedEntityID EndID = findPreprocessedEntity(Range.getEnd(), true);
5230   return std::make_pair(BeginID, EndID);
5231 }
5232 
5233 /// \brief Optionally returns true or false if the preallocated preprocessed
5234 /// entity with index \arg Index came from file \arg FID.
5235 Optional<bool> ASTReader::isPreprocessedEntityInFileID(unsigned Index,
5236                                                              FileID FID) {
5237   if (FID.isInvalid())
5238     return false;
5239 
5240   std::pair<ModuleFile *, unsigned> PPInfo = getModulePreprocessedEntity(Index);
5241   ModuleFile &M = *PPInfo.first;
5242   unsigned LocalIndex = PPInfo.second;
5243   const PPEntityOffset &PPOffs = M.PreprocessedEntityOffsets[LocalIndex];
5244 
5245   SourceLocation Loc = TranslateSourceLocation(M, PPOffs.getBegin());
5246   if (Loc.isInvalid())
5247     return false;
5248 
5249   if (SourceMgr.isInFileID(SourceMgr.getFileLoc(Loc), FID))
5250     return true;
5251   else
5252     return false;
5253 }
5254 
5255 namespace {
5256 
5257   /// \brief Visitor used to search for information about a header file.
5258   class HeaderFileInfoVisitor {
5259     const FileEntry *FE;
5260 
5261     Optional<HeaderFileInfo> HFI;
5262 
5263   public:
5264     explicit HeaderFileInfoVisitor(const FileEntry *FE)
5265       : FE(FE) { }
5266 
5267     bool operator()(ModuleFile &M) {
5268       HeaderFileInfoLookupTable *Table
5269         = static_cast<HeaderFileInfoLookupTable *>(M.HeaderFileInfoTable);
5270       if (!Table)
5271         return false;
5272 
5273       // Look in the on-disk hash table for an entry for this file name.
5274       HeaderFileInfoLookupTable::iterator Pos = Table->find(FE);
5275       if (Pos == Table->end())
5276         return false;
5277 
5278       HFI = *Pos;
5279       return true;
5280     }
5281 
5282     Optional<HeaderFileInfo> getHeaderFileInfo() const { return HFI; }
5283   };
5284 
5285 } // end anonymous namespace
5286 
5287 HeaderFileInfo ASTReader::GetHeaderFileInfo(const FileEntry *FE) {
5288   HeaderFileInfoVisitor Visitor(FE);
5289   ModuleMgr.visit(Visitor);
5290   if (Optional<HeaderFileInfo> HFI = Visitor.getHeaderFileInfo())
5291     return *HFI;
5292 
5293   return HeaderFileInfo();
5294 }
5295 
5296 void ASTReader::ReadPragmaDiagnosticMappings(DiagnosticsEngine &Diag) {
5297   // FIXME: Make it work properly with modules.
5298   SmallVector<DiagnosticsEngine::DiagState *, 32> DiagStates;
5299   for (ModuleIterator I = ModuleMgr.begin(), E = ModuleMgr.end(); I != E; ++I) {
5300     ModuleFile &F = *(*I);
5301     unsigned Idx = 0;
5302     DiagStates.clear();
5303     assert(!Diag.DiagStates.empty());
5304     DiagStates.push_back(&Diag.DiagStates.front()); // the command-line one.
5305     while (Idx < F.PragmaDiagMappings.size()) {
5306       SourceLocation Loc = ReadSourceLocation(F, F.PragmaDiagMappings[Idx++]);
5307       unsigned DiagStateID = F.PragmaDiagMappings[Idx++];
5308       if (DiagStateID != 0) {
5309         Diag.DiagStatePoints.push_back(
5310                     DiagnosticsEngine::DiagStatePoint(DiagStates[DiagStateID-1],
5311                     FullSourceLoc(Loc, SourceMgr)));
5312         continue;
5313       }
5314 
5315       assert(DiagStateID == 0);
5316       // A new DiagState was created here.
5317       Diag.DiagStates.push_back(*Diag.GetCurDiagState());
5318       DiagnosticsEngine::DiagState *NewState = &Diag.DiagStates.back();
5319       DiagStates.push_back(NewState);
5320       Diag.DiagStatePoints.push_back(
5321           DiagnosticsEngine::DiagStatePoint(NewState,
5322                                             FullSourceLoc(Loc, SourceMgr)));
5323       while (true) {
5324         assert(Idx < F.PragmaDiagMappings.size() &&
5325                "Invalid data, didn't find '-1' marking end of diag/map pairs");
5326         if (Idx >= F.PragmaDiagMappings.size()) {
5327           break; // Something is messed up but at least avoid infinite loop in
5328                  // release build.
5329         }
5330         unsigned DiagID = F.PragmaDiagMappings[Idx++];
5331         if (DiagID == (unsigned)-1) {
5332           break; // no more diag/map pairs for this location.
5333         }
5334         diag::Severity Map = (diag::Severity)F.PragmaDiagMappings[Idx++];
5335         DiagnosticMapping Mapping = Diag.makeUserMapping(Map, Loc);
5336         Diag.GetCurDiagState()->setMapping(DiagID, Mapping);
5337       }
5338     }
5339   }
5340 }
5341 
5342 /// \brief Get the correct cursor and offset for loading a type.
5343 ASTReader::RecordLocation ASTReader::TypeCursorForIndex(unsigned Index) {
5344   GlobalTypeMapType::iterator I = GlobalTypeMap.find(Index);
5345   assert(I != GlobalTypeMap.end() && "Corrupted global type map");
5346   ModuleFile *M = I->second;
5347   return RecordLocation(M, M->TypeOffsets[Index - M->BaseTypeIndex]);
5348 }
5349 
5350 /// \brief Read and return the type with the given index..
5351 ///
5352 /// The index is the type ID, shifted and minus the number of predefs. This
5353 /// routine actually reads the record corresponding to the type at the given
5354 /// location. It is a helper routine for GetType, which deals with reading type
5355 /// IDs.
5356 QualType ASTReader::readTypeRecord(unsigned Index) {
5357   RecordLocation Loc = TypeCursorForIndex(Index);
5358   BitstreamCursor &DeclsCursor = Loc.F->DeclsCursor;
5359 
5360   // Keep track of where we are in the stream, then jump back there
5361   // after reading this type.
5362   SavedStreamPosition SavedPosition(DeclsCursor);
5363 
5364   ReadingKindTracker ReadingKind(Read_Type, *this);
5365 
5366   // Note that we are loading a type record.
5367   Deserializing AType(this);
5368 
5369   unsigned Idx = 0;
5370   DeclsCursor.JumpToBit(Loc.Offset);
5371   RecordData Record;
5372   unsigned Code = DeclsCursor.ReadCode();
5373   switch ((TypeCode)DeclsCursor.readRecord(Code, Record)) {
5374   case TYPE_EXT_QUAL: {
5375     if (Record.size() != 2) {
5376       Error("Incorrect encoding of extended qualifier type");
5377       return QualType();
5378     }
5379     QualType Base = readType(*Loc.F, Record, Idx);
5380     Qualifiers Quals = Qualifiers::fromOpaqueValue(Record[Idx++]);
5381     return Context.getQualifiedType(Base, Quals);
5382   }
5383 
5384   case TYPE_COMPLEX: {
5385     if (Record.size() != 1) {
5386       Error("Incorrect encoding of complex type");
5387       return QualType();
5388     }
5389     QualType ElemType = readType(*Loc.F, Record, Idx);
5390     return Context.getComplexType(ElemType);
5391   }
5392 
5393   case TYPE_POINTER: {
5394     if (Record.size() != 1) {
5395       Error("Incorrect encoding of pointer type");
5396       return QualType();
5397     }
5398     QualType PointeeType = readType(*Loc.F, Record, Idx);
5399     return Context.getPointerType(PointeeType);
5400   }
5401 
5402   case TYPE_DECAYED: {
5403     if (Record.size() != 1) {
5404       Error("Incorrect encoding of decayed type");
5405       return QualType();
5406     }
5407     QualType OriginalType = readType(*Loc.F, Record, Idx);
5408     QualType DT = Context.getAdjustedParameterType(OriginalType);
5409     if (!isa<DecayedType>(DT))
5410       Error("Decayed type does not decay");
5411     return DT;
5412   }
5413 
5414   case TYPE_ADJUSTED: {
5415     if (Record.size() != 2) {
5416       Error("Incorrect encoding of adjusted type");
5417       return QualType();
5418     }
5419     QualType OriginalTy = readType(*Loc.F, Record, Idx);
5420     QualType AdjustedTy = readType(*Loc.F, Record, Idx);
5421     return Context.getAdjustedType(OriginalTy, AdjustedTy);
5422   }
5423 
5424   case TYPE_BLOCK_POINTER: {
5425     if (Record.size() != 1) {
5426       Error("Incorrect encoding of block pointer type");
5427       return QualType();
5428     }
5429     QualType PointeeType = readType(*Loc.F, Record, Idx);
5430     return Context.getBlockPointerType(PointeeType);
5431   }
5432 
5433   case TYPE_LVALUE_REFERENCE: {
5434     if (Record.size() != 2) {
5435       Error("Incorrect encoding of lvalue reference type");
5436       return QualType();
5437     }
5438     QualType PointeeType = readType(*Loc.F, Record, Idx);
5439     return Context.getLValueReferenceType(PointeeType, Record[1]);
5440   }
5441 
5442   case TYPE_RVALUE_REFERENCE: {
5443     if (Record.size() != 1) {
5444       Error("Incorrect encoding of rvalue reference type");
5445       return QualType();
5446     }
5447     QualType PointeeType = readType(*Loc.F, Record, Idx);
5448     return Context.getRValueReferenceType(PointeeType);
5449   }
5450 
5451   case TYPE_MEMBER_POINTER: {
5452     if (Record.size() != 2) {
5453       Error("Incorrect encoding of member pointer type");
5454       return QualType();
5455     }
5456     QualType PointeeType = readType(*Loc.F, Record, Idx);
5457     QualType ClassType = readType(*Loc.F, Record, Idx);
5458     if (PointeeType.isNull() || ClassType.isNull())
5459       return QualType();
5460 
5461     return Context.getMemberPointerType(PointeeType, ClassType.getTypePtr());
5462   }
5463 
5464   case TYPE_CONSTANT_ARRAY: {
5465     QualType ElementType = readType(*Loc.F, Record, Idx);
5466     ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
5467     unsigned IndexTypeQuals = Record[2];
5468     unsigned Idx = 3;
5469     llvm::APInt Size = ReadAPInt(Record, Idx);
5470     return Context.getConstantArrayType(ElementType, Size,
5471                                          ASM, IndexTypeQuals);
5472   }
5473 
5474   case TYPE_INCOMPLETE_ARRAY: {
5475     QualType ElementType = readType(*Loc.F, Record, Idx);
5476     ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
5477     unsigned IndexTypeQuals = Record[2];
5478     return Context.getIncompleteArrayType(ElementType, ASM, IndexTypeQuals);
5479   }
5480 
5481   case TYPE_VARIABLE_ARRAY: {
5482     QualType ElementType = readType(*Loc.F, Record, Idx);
5483     ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
5484     unsigned IndexTypeQuals = Record[2];
5485     SourceLocation LBLoc = ReadSourceLocation(*Loc.F, Record[3]);
5486     SourceLocation RBLoc = ReadSourceLocation(*Loc.F, Record[4]);
5487     return Context.getVariableArrayType(ElementType, ReadExpr(*Loc.F),
5488                                          ASM, IndexTypeQuals,
5489                                          SourceRange(LBLoc, RBLoc));
5490   }
5491 
5492   case TYPE_VECTOR: {
5493     if (Record.size() != 3) {
5494       Error("incorrect encoding of vector type in AST file");
5495       return QualType();
5496     }
5497 
5498     QualType ElementType = readType(*Loc.F, Record, Idx);
5499     unsigned NumElements = Record[1];
5500     unsigned VecKind = Record[2];
5501     return Context.getVectorType(ElementType, NumElements,
5502                                   (VectorType::VectorKind)VecKind);
5503   }
5504 
5505   case TYPE_EXT_VECTOR: {
5506     if (Record.size() != 3) {
5507       Error("incorrect encoding of extended vector type in AST file");
5508       return QualType();
5509     }
5510 
5511     QualType ElementType = readType(*Loc.F, Record, Idx);
5512     unsigned NumElements = Record[1];
5513     return Context.getExtVectorType(ElementType, NumElements);
5514   }
5515 
5516   case TYPE_FUNCTION_NO_PROTO: {
5517     if (Record.size() != 6) {
5518       Error("incorrect encoding of no-proto function type");
5519       return QualType();
5520     }
5521     QualType ResultType = readType(*Loc.F, Record, Idx);
5522     FunctionType::ExtInfo Info(Record[1], Record[2], Record[3],
5523                                (CallingConv)Record[4], Record[5]);
5524     return Context.getFunctionNoProtoType(ResultType, Info);
5525   }
5526 
5527   case TYPE_FUNCTION_PROTO: {
5528     QualType ResultType = readType(*Loc.F, Record, Idx);
5529 
5530     FunctionProtoType::ExtProtoInfo EPI;
5531     EPI.ExtInfo = FunctionType::ExtInfo(/*noreturn*/ Record[1],
5532                                         /*hasregparm*/ Record[2],
5533                                         /*regparm*/ Record[3],
5534                                         static_cast<CallingConv>(Record[4]),
5535                                         /*produces*/ Record[5]);
5536 
5537     unsigned Idx = 6;
5538 
5539     EPI.Variadic = Record[Idx++];
5540     EPI.HasTrailingReturn = Record[Idx++];
5541     EPI.TypeQuals = Record[Idx++];
5542     EPI.RefQualifier = static_cast<RefQualifierKind>(Record[Idx++]);
5543     SmallVector<QualType, 8> ExceptionStorage;
5544     readExceptionSpec(*Loc.F, ExceptionStorage, EPI.ExceptionSpec, Record, Idx);
5545 
5546     unsigned NumParams = Record[Idx++];
5547     SmallVector<QualType, 16> ParamTypes;
5548     for (unsigned I = 0; I != NumParams; ++I)
5549       ParamTypes.push_back(readType(*Loc.F, Record, Idx));
5550 
5551     SmallVector<FunctionProtoType::ExtParameterInfo, 4> ExtParameterInfos;
5552     if (Idx != Record.size()) {
5553       for (unsigned I = 0; I != NumParams; ++I)
5554         ExtParameterInfos.push_back(
5555           FunctionProtoType::ExtParameterInfo
5556                            ::getFromOpaqueValue(Record[Idx++]));
5557       EPI.ExtParameterInfos = ExtParameterInfos.data();
5558     }
5559 
5560     assert(Idx == Record.size());
5561 
5562     return Context.getFunctionType(ResultType, ParamTypes, EPI);
5563   }
5564 
5565   case TYPE_UNRESOLVED_USING: {
5566     unsigned Idx = 0;
5567     return Context.getTypeDeclType(
5568                   ReadDeclAs<UnresolvedUsingTypenameDecl>(*Loc.F, Record, Idx));
5569   }
5570 
5571   case TYPE_TYPEDEF: {
5572     if (Record.size() != 2) {
5573       Error("incorrect encoding of typedef type");
5574       return QualType();
5575     }
5576     unsigned Idx = 0;
5577     TypedefNameDecl *Decl = ReadDeclAs<TypedefNameDecl>(*Loc.F, Record, Idx);
5578     QualType Canonical = readType(*Loc.F, Record, Idx);
5579     if (!Canonical.isNull())
5580       Canonical = Context.getCanonicalType(Canonical);
5581     return Context.getTypedefType(Decl, Canonical);
5582   }
5583 
5584   case TYPE_TYPEOF_EXPR:
5585     return Context.getTypeOfExprType(ReadExpr(*Loc.F));
5586 
5587   case TYPE_TYPEOF: {
5588     if (Record.size() != 1) {
5589       Error("incorrect encoding of typeof(type) in AST file");
5590       return QualType();
5591     }
5592     QualType UnderlyingType = readType(*Loc.F, Record, Idx);
5593     return Context.getTypeOfType(UnderlyingType);
5594   }
5595 
5596   case TYPE_DECLTYPE: {
5597     QualType UnderlyingType = readType(*Loc.F, Record, Idx);
5598     return Context.getDecltypeType(ReadExpr(*Loc.F), UnderlyingType);
5599   }
5600 
5601   case TYPE_UNARY_TRANSFORM: {
5602     QualType BaseType = readType(*Loc.F, Record, Idx);
5603     QualType UnderlyingType = readType(*Loc.F, Record, Idx);
5604     UnaryTransformType::UTTKind UKind = (UnaryTransformType::UTTKind)Record[2];
5605     return Context.getUnaryTransformType(BaseType, UnderlyingType, UKind);
5606   }
5607 
5608   case TYPE_AUTO: {
5609     QualType Deduced = readType(*Loc.F, Record, Idx);
5610     AutoTypeKeyword Keyword = (AutoTypeKeyword)Record[Idx++];
5611     bool IsDependent = Deduced.isNull() ? Record[Idx++] : false;
5612     return Context.getAutoType(Deduced, Keyword, IsDependent);
5613   }
5614 
5615   case TYPE_RECORD: {
5616     if (Record.size() != 2) {
5617       Error("incorrect encoding of record type");
5618       return QualType();
5619     }
5620     unsigned Idx = 0;
5621     bool IsDependent = Record[Idx++];
5622     RecordDecl *RD = ReadDeclAs<RecordDecl>(*Loc.F, Record, Idx);
5623     RD = cast_or_null<RecordDecl>(RD->getCanonicalDecl());
5624     QualType T = Context.getRecordType(RD);
5625     const_cast<Type*>(T.getTypePtr())->setDependent(IsDependent);
5626     return T;
5627   }
5628 
5629   case TYPE_ENUM: {
5630     if (Record.size() != 2) {
5631       Error("incorrect encoding of enum type");
5632       return QualType();
5633     }
5634     unsigned Idx = 0;
5635     bool IsDependent = Record[Idx++];
5636     QualType T
5637       = Context.getEnumType(ReadDeclAs<EnumDecl>(*Loc.F, Record, Idx));
5638     const_cast<Type*>(T.getTypePtr())->setDependent(IsDependent);
5639     return T;
5640   }
5641 
5642   case TYPE_ATTRIBUTED: {
5643     if (Record.size() != 3) {
5644       Error("incorrect encoding of attributed type");
5645       return QualType();
5646     }
5647     QualType modifiedType = readType(*Loc.F, Record, Idx);
5648     QualType equivalentType = readType(*Loc.F, Record, Idx);
5649     AttributedType::Kind kind = static_cast<AttributedType::Kind>(Record[2]);
5650     return Context.getAttributedType(kind, modifiedType, equivalentType);
5651   }
5652 
5653   case TYPE_PAREN: {
5654     if (Record.size() != 1) {
5655       Error("incorrect encoding of paren type");
5656       return QualType();
5657     }
5658     QualType InnerType = readType(*Loc.F, Record, Idx);
5659     return Context.getParenType(InnerType);
5660   }
5661 
5662   case TYPE_PACK_EXPANSION: {
5663     if (Record.size() != 2) {
5664       Error("incorrect encoding of pack expansion type");
5665       return QualType();
5666     }
5667     QualType Pattern = readType(*Loc.F, Record, Idx);
5668     if (Pattern.isNull())
5669       return QualType();
5670     Optional<unsigned> NumExpansions;
5671     if (Record[1])
5672       NumExpansions = Record[1] - 1;
5673     return Context.getPackExpansionType(Pattern, NumExpansions);
5674   }
5675 
5676   case TYPE_ELABORATED: {
5677     unsigned Idx = 0;
5678     ElaboratedTypeKeyword Keyword = (ElaboratedTypeKeyword)Record[Idx++];
5679     NestedNameSpecifier *NNS = ReadNestedNameSpecifier(*Loc.F, Record, Idx);
5680     QualType NamedType = readType(*Loc.F, Record, Idx);
5681     return Context.getElaboratedType(Keyword, NNS, NamedType);
5682   }
5683 
5684   case TYPE_OBJC_INTERFACE: {
5685     unsigned Idx = 0;
5686     ObjCInterfaceDecl *ItfD
5687       = ReadDeclAs<ObjCInterfaceDecl>(*Loc.F, Record, Idx);
5688     return Context.getObjCInterfaceType(ItfD->getCanonicalDecl());
5689   }
5690 
5691   case TYPE_OBJC_TYPE_PARAM: {
5692     unsigned Idx = 0;
5693     ObjCTypeParamDecl *Decl
5694       = ReadDeclAs<ObjCTypeParamDecl>(*Loc.F, Record, Idx);
5695     unsigned NumProtos = Record[Idx++];
5696     SmallVector<ObjCProtocolDecl*, 4> Protos;
5697     for (unsigned I = 0; I != NumProtos; ++I)
5698       Protos.push_back(ReadDeclAs<ObjCProtocolDecl>(*Loc.F, Record, Idx));
5699     return Context.getObjCTypeParamType(Decl, Protos);
5700   }
5701   case TYPE_OBJC_OBJECT: {
5702     unsigned Idx = 0;
5703     QualType Base = readType(*Loc.F, Record, Idx);
5704     unsigned NumTypeArgs = Record[Idx++];
5705     SmallVector<QualType, 4> TypeArgs;
5706     for (unsigned I = 0; I != NumTypeArgs; ++I)
5707       TypeArgs.push_back(readType(*Loc.F, Record, Idx));
5708     unsigned NumProtos = Record[Idx++];
5709     SmallVector<ObjCProtocolDecl*, 4> Protos;
5710     for (unsigned I = 0; I != NumProtos; ++I)
5711       Protos.push_back(ReadDeclAs<ObjCProtocolDecl>(*Loc.F, Record, Idx));
5712     bool IsKindOf = Record[Idx++];
5713     return Context.getObjCObjectType(Base, TypeArgs, Protos, IsKindOf);
5714   }
5715 
5716   case TYPE_OBJC_OBJECT_POINTER: {
5717     unsigned Idx = 0;
5718     QualType Pointee = readType(*Loc.F, Record, Idx);
5719     return Context.getObjCObjectPointerType(Pointee);
5720   }
5721 
5722   case TYPE_SUBST_TEMPLATE_TYPE_PARM: {
5723     unsigned Idx = 0;
5724     QualType Parm = readType(*Loc.F, Record, Idx);
5725     QualType Replacement = readType(*Loc.F, Record, Idx);
5726     return Context.getSubstTemplateTypeParmType(
5727         cast<TemplateTypeParmType>(Parm),
5728         Context.getCanonicalType(Replacement));
5729   }
5730 
5731   case TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK: {
5732     unsigned Idx = 0;
5733     QualType Parm = readType(*Loc.F, Record, Idx);
5734     TemplateArgument ArgPack = ReadTemplateArgument(*Loc.F, Record, Idx);
5735     return Context.getSubstTemplateTypeParmPackType(
5736                                                cast<TemplateTypeParmType>(Parm),
5737                                                      ArgPack);
5738   }
5739 
5740   case TYPE_INJECTED_CLASS_NAME: {
5741     CXXRecordDecl *D = ReadDeclAs<CXXRecordDecl>(*Loc.F, Record, Idx);
5742     QualType TST = readType(*Loc.F, Record, Idx); // probably derivable
5743     // FIXME: ASTContext::getInjectedClassNameType is not currently suitable
5744     // for AST reading, too much interdependencies.
5745     const Type *T = nullptr;
5746     for (auto *DI = D; DI; DI = DI->getPreviousDecl()) {
5747       if (const Type *Existing = DI->getTypeForDecl()) {
5748         T = Existing;
5749         break;
5750       }
5751     }
5752     if (!T) {
5753       T = new (Context, TypeAlignment) InjectedClassNameType(D, TST);
5754       for (auto *DI = D; DI; DI = DI->getPreviousDecl())
5755         DI->setTypeForDecl(T);
5756     }
5757     return QualType(T, 0);
5758   }
5759 
5760   case TYPE_TEMPLATE_TYPE_PARM: {
5761     unsigned Idx = 0;
5762     unsigned Depth = Record[Idx++];
5763     unsigned Index = Record[Idx++];
5764     bool Pack = Record[Idx++];
5765     TemplateTypeParmDecl *D
5766       = ReadDeclAs<TemplateTypeParmDecl>(*Loc.F, Record, Idx);
5767     return Context.getTemplateTypeParmType(Depth, Index, Pack, D);
5768   }
5769 
5770   case TYPE_DEPENDENT_NAME: {
5771     unsigned Idx = 0;
5772     ElaboratedTypeKeyword Keyword = (ElaboratedTypeKeyword)Record[Idx++];
5773     NestedNameSpecifier *NNS = ReadNestedNameSpecifier(*Loc.F, Record, Idx);
5774     const IdentifierInfo *Name = GetIdentifierInfo(*Loc.F, Record, Idx);
5775     QualType Canon = readType(*Loc.F, Record, Idx);
5776     if (!Canon.isNull())
5777       Canon = Context.getCanonicalType(Canon);
5778     return Context.getDependentNameType(Keyword, NNS, Name, Canon);
5779   }
5780 
5781   case TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION: {
5782     unsigned Idx = 0;
5783     ElaboratedTypeKeyword Keyword = (ElaboratedTypeKeyword)Record[Idx++];
5784     NestedNameSpecifier *NNS = ReadNestedNameSpecifier(*Loc.F, Record, Idx);
5785     const IdentifierInfo *Name = GetIdentifierInfo(*Loc.F, Record, Idx);
5786     unsigned NumArgs = Record[Idx++];
5787     SmallVector<TemplateArgument, 8> Args;
5788     Args.reserve(NumArgs);
5789     while (NumArgs--)
5790       Args.push_back(ReadTemplateArgument(*Loc.F, Record, Idx));
5791     return Context.getDependentTemplateSpecializationType(Keyword, NNS, Name,
5792                                                           Args);
5793   }
5794 
5795   case TYPE_DEPENDENT_SIZED_ARRAY: {
5796     unsigned Idx = 0;
5797 
5798     // ArrayType
5799     QualType ElementType = readType(*Loc.F, Record, Idx);
5800     ArrayType::ArraySizeModifier ASM
5801       = (ArrayType::ArraySizeModifier)Record[Idx++];
5802     unsigned IndexTypeQuals = Record[Idx++];
5803 
5804     // DependentSizedArrayType
5805     Expr *NumElts = ReadExpr(*Loc.F);
5806     SourceRange Brackets = ReadSourceRange(*Loc.F, Record, Idx);
5807 
5808     return Context.getDependentSizedArrayType(ElementType, NumElts, ASM,
5809                                                IndexTypeQuals, Brackets);
5810   }
5811 
5812   case TYPE_TEMPLATE_SPECIALIZATION: {
5813     unsigned Idx = 0;
5814     bool IsDependent = Record[Idx++];
5815     TemplateName Name = ReadTemplateName(*Loc.F, Record, Idx);
5816     SmallVector<TemplateArgument, 8> Args;
5817     ReadTemplateArgumentList(Args, *Loc.F, Record, Idx);
5818     QualType Underlying = readType(*Loc.F, Record, Idx);
5819     QualType T;
5820     if (Underlying.isNull())
5821       T = Context.getCanonicalTemplateSpecializationType(Name, Args);
5822     else
5823       T = Context.getTemplateSpecializationType(Name, Args, Underlying);
5824     const_cast<Type*>(T.getTypePtr())->setDependent(IsDependent);
5825     return T;
5826   }
5827 
5828   case TYPE_ATOMIC: {
5829     if (Record.size() != 1) {
5830       Error("Incorrect encoding of atomic type");
5831       return QualType();
5832     }
5833     QualType ValueType = readType(*Loc.F, Record, Idx);
5834     return Context.getAtomicType(ValueType);
5835   }
5836 
5837   case TYPE_PIPE: {
5838     if (Record.size() != 2) {
5839       Error("Incorrect encoding of pipe type");
5840       return QualType();
5841     }
5842 
5843     // Reading the pipe element type.
5844     QualType ElementType = readType(*Loc.F, Record, Idx);
5845     unsigned ReadOnly = Record[1];
5846     return Context.getPipeType(ElementType, ReadOnly);
5847   }
5848 
5849   }
5850   llvm_unreachable("Invalid TypeCode!");
5851 }
5852 
5853 void ASTReader::readExceptionSpec(ModuleFile &ModuleFile,
5854                                   SmallVectorImpl<QualType> &Exceptions,
5855                                   FunctionProtoType::ExceptionSpecInfo &ESI,
5856                                   const RecordData &Record, unsigned &Idx) {
5857   ExceptionSpecificationType EST =
5858       static_cast<ExceptionSpecificationType>(Record[Idx++]);
5859   ESI.Type = EST;
5860   if (EST == EST_Dynamic) {
5861     for (unsigned I = 0, N = Record[Idx++]; I != N; ++I)
5862       Exceptions.push_back(readType(ModuleFile, Record, Idx));
5863     ESI.Exceptions = Exceptions;
5864   } else if (EST == EST_ComputedNoexcept) {
5865     ESI.NoexceptExpr = ReadExpr(ModuleFile);
5866   } else if (EST == EST_Uninstantiated) {
5867     ESI.SourceDecl = ReadDeclAs<FunctionDecl>(ModuleFile, Record, Idx);
5868     ESI.SourceTemplate = ReadDeclAs<FunctionDecl>(ModuleFile, Record, Idx);
5869   } else if (EST == EST_Unevaluated) {
5870     ESI.SourceDecl = ReadDeclAs<FunctionDecl>(ModuleFile, Record, Idx);
5871   }
5872 }
5873 
5874 class clang::TypeLocReader : public TypeLocVisitor<TypeLocReader> {
5875   ModuleFile *F;
5876   ASTReader *Reader;
5877   const ASTReader::RecordData &Record;
5878   unsigned &Idx;
5879 
5880   SourceLocation ReadSourceLocation() {
5881     return Reader->ReadSourceLocation(*F, Record, Idx);
5882   }
5883 
5884   TypeSourceInfo *GetTypeSourceInfo() {
5885     return Reader->GetTypeSourceInfo(*F, Record, Idx);
5886   }
5887 
5888   NestedNameSpecifierLoc ReadNestedNameSpecifierLoc() {
5889     return Reader->ReadNestedNameSpecifierLoc(*F, Record, Idx);
5890   }
5891 
5892 public:
5893   TypeLocReader(ModuleFile &F, ASTReader &Reader,
5894                 const ASTReader::RecordData &Record, unsigned &Idx)
5895       : F(&F), Reader(&Reader), Record(Record), Idx(Idx) {}
5896 
5897   // We want compile-time assurance that we've enumerated all of
5898   // these, so unfortunately we have to declare them first, then
5899   // define them out-of-line.
5900 #define ABSTRACT_TYPELOC(CLASS, PARENT)
5901 #define TYPELOC(CLASS, PARENT) \
5902   void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
5903 #include "clang/AST/TypeLocNodes.def"
5904 
5905   void VisitFunctionTypeLoc(FunctionTypeLoc);
5906   void VisitArrayTypeLoc(ArrayTypeLoc);
5907 };
5908 
5909 void TypeLocReader::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
5910   // nothing to do
5911 }
5912 
5913 void TypeLocReader::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
5914   TL.setBuiltinLoc(ReadSourceLocation());
5915   if (TL.needsExtraLocalData()) {
5916     TL.setWrittenTypeSpec(static_cast<DeclSpec::TST>(Record[Idx++]));
5917     TL.setWrittenSignSpec(static_cast<DeclSpec::TSS>(Record[Idx++]));
5918     TL.setWrittenWidthSpec(static_cast<DeclSpec::TSW>(Record[Idx++]));
5919     TL.setModeAttr(Record[Idx++]);
5920   }
5921 }
5922 
5923 void TypeLocReader::VisitComplexTypeLoc(ComplexTypeLoc TL) {
5924   TL.setNameLoc(ReadSourceLocation());
5925 }
5926 
5927 void TypeLocReader::VisitPointerTypeLoc(PointerTypeLoc TL) {
5928   TL.setStarLoc(ReadSourceLocation());
5929 }
5930 
5931 void TypeLocReader::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
5932   // nothing to do
5933 }
5934 
5935 void TypeLocReader::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
5936   // nothing to do
5937 }
5938 
5939 void TypeLocReader::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
5940   TL.setCaretLoc(ReadSourceLocation());
5941 }
5942 
5943 void TypeLocReader::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
5944   TL.setAmpLoc(ReadSourceLocation());
5945 }
5946 
5947 void TypeLocReader::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
5948   TL.setAmpAmpLoc(ReadSourceLocation());
5949 }
5950 
5951 void TypeLocReader::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
5952   TL.setStarLoc(ReadSourceLocation());
5953   TL.setClassTInfo(GetTypeSourceInfo());
5954 }
5955 
5956 void TypeLocReader::VisitArrayTypeLoc(ArrayTypeLoc TL) {
5957   TL.setLBracketLoc(ReadSourceLocation());
5958   TL.setRBracketLoc(ReadSourceLocation());
5959   if (Record[Idx++])
5960     TL.setSizeExpr(Reader->ReadExpr(*F));
5961   else
5962     TL.setSizeExpr(nullptr);
5963 }
5964 
5965 void TypeLocReader::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
5966   VisitArrayTypeLoc(TL);
5967 }
5968 
5969 void TypeLocReader::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
5970   VisitArrayTypeLoc(TL);
5971 }
5972 
5973 void TypeLocReader::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
5974   VisitArrayTypeLoc(TL);
5975 }
5976 
5977 void TypeLocReader::VisitDependentSizedArrayTypeLoc(
5978                                             DependentSizedArrayTypeLoc TL) {
5979   VisitArrayTypeLoc(TL);
5980 }
5981 
5982 void TypeLocReader::VisitDependentSizedExtVectorTypeLoc(
5983                                         DependentSizedExtVectorTypeLoc TL) {
5984   TL.setNameLoc(ReadSourceLocation());
5985 }
5986 
5987 void TypeLocReader::VisitVectorTypeLoc(VectorTypeLoc TL) {
5988   TL.setNameLoc(ReadSourceLocation());
5989 }
5990 
5991 void TypeLocReader::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
5992   TL.setNameLoc(ReadSourceLocation());
5993 }
5994 
5995 void TypeLocReader::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
5996   TL.setLocalRangeBegin(ReadSourceLocation());
5997   TL.setLParenLoc(ReadSourceLocation());
5998   TL.setRParenLoc(ReadSourceLocation());
5999   TL.setExceptionSpecRange(SourceRange(Reader->ReadSourceLocation(*F, Record, Idx),
6000                                        Reader->ReadSourceLocation(*F, Record, Idx)));
6001   TL.setLocalRangeEnd(ReadSourceLocation());
6002   for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i) {
6003     TL.setParam(i, Reader->ReadDeclAs<ParmVarDecl>(*F, Record, Idx));
6004   }
6005 }
6006 
6007 void TypeLocReader::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
6008   VisitFunctionTypeLoc(TL);
6009 }
6010 
6011 void TypeLocReader::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
6012   VisitFunctionTypeLoc(TL);
6013 }
6014 void TypeLocReader::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
6015   TL.setNameLoc(ReadSourceLocation());
6016 }
6017 void TypeLocReader::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
6018   TL.setNameLoc(ReadSourceLocation());
6019 }
6020 void TypeLocReader::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
6021   TL.setTypeofLoc(ReadSourceLocation());
6022   TL.setLParenLoc(ReadSourceLocation());
6023   TL.setRParenLoc(ReadSourceLocation());
6024 }
6025 void TypeLocReader::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
6026   TL.setTypeofLoc(ReadSourceLocation());
6027   TL.setLParenLoc(ReadSourceLocation());
6028   TL.setRParenLoc(ReadSourceLocation());
6029   TL.setUnderlyingTInfo(GetTypeSourceInfo());
6030 }
6031 void TypeLocReader::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
6032   TL.setNameLoc(ReadSourceLocation());
6033 }
6034 
6035 void TypeLocReader::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
6036   TL.setKWLoc(ReadSourceLocation());
6037   TL.setLParenLoc(ReadSourceLocation());
6038   TL.setRParenLoc(ReadSourceLocation());
6039   TL.setUnderlyingTInfo(GetTypeSourceInfo());
6040 }
6041 
6042 void TypeLocReader::VisitAutoTypeLoc(AutoTypeLoc TL) {
6043   TL.setNameLoc(ReadSourceLocation());
6044 }
6045 
6046 void TypeLocReader::VisitRecordTypeLoc(RecordTypeLoc TL) {
6047   TL.setNameLoc(ReadSourceLocation());
6048 }
6049 
6050 void TypeLocReader::VisitEnumTypeLoc(EnumTypeLoc TL) {
6051   TL.setNameLoc(ReadSourceLocation());
6052 }
6053 
6054 void TypeLocReader::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
6055   TL.setAttrNameLoc(ReadSourceLocation());
6056   if (TL.hasAttrOperand()) {
6057     SourceRange range;
6058     range.setBegin(ReadSourceLocation());
6059     range.setEnd(ReadSourceLocation());
6060     TL.setAttrOperandParensRange(range);
6061   }
6062   if (TL.hasAttrExprOperand()) {
6063     if (Record[Idx++])
6064       TL.setAttrExprOperand(Reader->ReadExpr(*F));
6065     else
6066       TL.setAttrExprOperand(nullptr);
6067   } else if (TL.hasAttrEnumOperand())
6068     TL.setAttrEnumOperandLoc(ReadSourceLocation());
6069 }
6070 
6071 void TypeLocReader::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
6072   TL.setNameLoc(ReadSourceLocation());
6073 }
6074 
6075 void TypeLocReader::VisitSubstTemplateTypeParmTypeLoc(
6076                                             SubstTemplateTypeParmTypeLoc TL) {
6077   TL.setNameLoc(ReadSourceLocation());
6078 }
6079 void TypeLocReader::VisitSubstTemplateTypeParmPackTypeLoc(
6080                                           SubstTemplateTypeParmPackTypeLoc TL) {
6081   TL.setNameLoc(ReadSourceLocation());
6082 }
6083 void TypeLocReader::VisitTemplateSpecializationTypeLoc(
6084                                            TemplateSpecializationTypeLoc TL) {
6085   TL.setTemplateKeywordLoc(ReadSourceLocation());
6086   TL.setTemplateNameLoc(ReadSourceLocation());
6087   TL.setLAngleLoc(ReadSourceLocation());
6088   TL.setRAngleLoc(ReadSourceLocation());
6089   for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
6090     TL.setArgLocInfo(
6091         i,
6092         Reader->GetTemplateArgumentLocInfo(
6093             *F, TL.getTypePtr()->getArg(i).getKind(), Record, Idx));
6094 }
6095 void TypeLocReader::VisitParenTypeLoc(ParenTypeLoc TL) {
6096   TL.setLParenLoc(ReadSourceLocation());
6097   TL.setRParenLoc(ReadSourceLocation());
6098 }
6099 
6100 void TypeLocReader::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
6101   TL.setElaboratedKeywordLoc(ReadSourceLocation());
6102   TL.setQualifierLoc(ReadNestedNameSpecifierLoc());
6103 }
6104 
6105 void TypeLocReader::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
6106   TL.setNameLoc(ReadSourceLocation());
6107 }
6108 
6109 void TypeLocReader::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
6110   TL.setElaboratedKeywordLoc(ReadSourceLocation());
6111   TL.setQualifierLoc(ReadNestedNameSpecifierLoc());
6112   TL.setNameLoc(ReadSourceLocation());
6113 }
6114 
6115 void TypeLocReader::VisitDependentTemplateSpecializationTypeLoc(
6116        DependentTemplateSpecializationTypeLoc TL) {
6117   TL.setElaboratedKeywordLoc(ReadSourceLocation());
6118   TL.setQualifierLoc(ReadNestedNameSpecifierLoc());
6119   TL.setTemplateKeywordLoc(ReadSourceLocation());
6120   TL.setTemplateNameLoc(ReadSourceLocation());
6121   TL.setLAngleLoc(ReadSourceLocation());
6122   TL.setRAngleLoc(ReadSourceLocation());
6123   for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
6124     TL.setArgLocInfo(
6125         I,
6126         Reader->GetTemplateArgumentLocInfo(
6127             *F, TL.getTypePtr()->getArg(I).getKind(), Record, Idx));
6128 }
6129 
6130 void TypeLocReader::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
6131   TL.setEllipsisLoc(ReadSourceLocation());
6132 }
6133 
6134 void TypeLocReader::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
6135   TL.setNameLoc(ReadSourceLocation());
6136 }
6137 
6138 void TypeLocReader::VisitObjCTypeParamTypeLoc(ObjCTypeParamTypeLoc TL) {
6139   if (TL.getNumProtocols()) {
6140     TL.setProtocolLAngleLoc(ReadSourceLocation());
6141     TL.setProtocolRAngleLoc(ReadSourceLocation());
6142   }
6143   for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
6144     TL.setProtocolLoc(i, ReadSourceLocation());
6145 }
6146 
6147 void TypeLocReader::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
6148   TL.setHasBaseTypeAsWritten(Record[Idx++]);
6149   TL.setTypeArgsLAngleLoc(ReadSourceLocation());
6150   TL.setTypeArgsRAngleLoc(ReadSourceLocation());
6151   for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
6152     TL.setTypeArgTInfo(i, GetTypeSourceInfo());
6153   TL.setProtocolLAngleLoc(ReadSourceLocation());
6154   TL.setProtocolRAngleLoc(ReadSourceLocation());
6155   for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
6156     TL.setProtocolLoc(i, ReadSourceLocation());
6157 }
6158 
6159 void TypeLocReader::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
6160   TL.setStarLoc(ReadSourceLocation());
6161 }
6162 
6163 void TypeLocReader::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
6164   TL.setKWLoc(ReadSourceLocation());
6165   TL.setLParenLoc(ReadSourceLocation());
6166   TL.setRParenLoc(ReadSourceLocation());
6167 }
6168 
6169 void TypeLocReader::VisitPipeTypeLoc(PipeTypeLoc TL) {
6170   TL.setKWLoc(ReadSourceLocation());
6171 }
6172 
6173 TypeSourceInfo *
6174 ASTReader::GetTypeSourceInfo(ModuleFile &F, const ASTReader::RecordData &Record,
6175                              unsigned &Idx) {
6176   QualType InfoTy = readType(F, Record, Idx);
6177   if (InfoTy.isNull())
6178     return nullptr;
6179 
6180   TypeSourceInfo *TInfo = getContext().CreateTypeSourceInfo(InfoTy);
6181   TypeLocReader TLR(F, *this, Record, Idx);
6182   for (TypeLoc TL = TInfo->getTypeLoc(); !TL.isNull(); TL = TL.getNextTypeLoc())
6183     TLR.Visit(TL);
6184   return TInfo;
6185 }
6186 
6187 QualType ASTReader::GetType(TypeID ID) {
6188   unsigned FastQuals = ID & Qualifiers::FastMask;
6189   unsigned Index = ID >> Qualifiers::FastWidth;
6190 
6191   if (Index < NUM_PREDEF_TYPE_IDS) {
6192     QualType T;
6193     switch ((PredefinedTypeIDs)Index) {
6194     case PREDEF_TYPE_NULL_ID:
6195       return QualType();
6196     case PREDEF_TYPE_VOID_ID:
6197       T = Context.VoidTy;
6198       break;
6199     case PREDEF_TYPE_BOOL_ID:
6200       T = Context.BoolTy;
6201       break;
6202 
6203     case PREDEF_TYPE_CHAR_U_ID:
6204     case PREDEF_TYPE_CHAR_S_ID:
6205       // FIXME: Check that the signedness of CharTy is correct!
6206       T = Context.CharTy;
6207       break;
6208 
6209     case PREDEF_TYPE_UCHAR_ID:
6210       T = Context.UnsignedCharTy;
6211       break;
6212     case PREDEF_TYPE_USHORT_ID:
6213       T = Context.UnsignedShortTy;
6214       break;
6215     case PREDEF_TYPE_UINT_ID:
6216       T = Context.UnsignedIntTy;
6217       break;
6218     case PREDEF_TYPE_ULONG_ID:
6219       T = Context.UnsignedLongTy;
6220       break;
6221     case PREDEF_TYPE_ULONGLONG_ID:
6222       T = Context.UnsignedLongLongTy;
6223       break;
6224     case PREDEF_TYPE_UINT128_ID:
6225       T = Context.UnsignedInt128Ty;
6226       break;
6227     case PREDEF_TYPE_SCHAR_ID:
6228       T = Context.SignedCharTy;
6229       break;
6230     case PREDEF_TYPE_WCHAR_ID:
6231       T = Context.WCharTy;
6232       break;
6233     case PREDEF_TYPE_SHORT_ID:
6234       T = Context.ShortTy;
6235       break;
6236     case PREDEF_TYPE_INT_ID:
6237       T = Context.IntTy;
6238       break;
6239     case PREDEF_TYPE_LONG_ID:
6240       T = Context.LongTy;
6241       break;
6242     case PREDEF_TYPE_LONGLONG_ID:
6243       T = Context.LongLongTy;
6244       break;
6245     case PREDEF_TYPE_INT128_ID:
6246       T = Context.Int128Ty;
6247       break;
6248     case PREDEF_TYPE_HALF_ID:
6249       T = Context.HalfTy;
6250       break;
6251     case PREDEF_TYPE_FLOAT_ID:
6252       T = Context.FloatTy;
6253       break;
6254     case PREDEF_TYPE_DOUBLE_ID:
6255       T = Context.DoubleTy;
6256       break;
6257     case PREDEF_TYPE_LONGDOUBLE_ID:
6258       T = Context.LongDoubleTy;
6259       break;
6260     case PREDEF_TYPE_FLOAT128_ID:
6261       T = Context.Float128Ty;
6262       break;
6263     case PREDEF_TYPE_OVERLOAD_ID:
6264       T = Context.OverloadTy;
6265       break;
6266     case PREDEF_TYPE_BOUND_MEMBER:
6267       T = Context.BoundMemberTy;
6268       break;
6269     case PREDEF_TYPE_PSEUDO_OBJECT:
6270       T = Context.PseudoObjectTy;
6271       break;
6272     case PREDEF_TYPE_DEPENDENT_ID:
6273       T = Context.DependentTy;
6274       break;
6275     case PREDEF_TYPE_UNKNOWN_ANY:
6276       T = Context.UnknownAnyTy;
6277       break;
6278     case PREDEF_TYPE_NULLPTR_ID:
6279       T = Context.NullPtrTy;
6280       break;
6281     case PREDEF_TYPE_CHAR16_ID:
6282       T = Context.Char16Ty;
6283       break;
6284     case PREDEF_TYPE_CHAR32_ID:
6285       T = Context.Char32Ty;
6286       break;
6287     case PREDEF_TYPE_OBJC_ID:
6288       T = Context.ObjCBuiltinIdTy;
6289       break;
6290     case PREDEF_TYPE_OBJC_CLASS:
6291       T = Context.ObjCBuiltinClassTy;
6292       break;
6293     case PREDEF_TYPE_OBJC_SEL:
6294       T = Context.ObjCBuiltinSelTy;
6295       break;
6296 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
6297     case PREDEF_TYPE_##Id##_ID: \
6298       T = Context.SingletonId; \
6299       break;
6300 #include "clang/Basic/OpenCLImageTypes.def"
6301     case PREDEF_TYPE_SAMPLER_ID:
6302       T = Context.OCLSamplerTy;
6303       break;
6304     case PREDEF_TYPE_EVENT_ID:
6305       T = Context.OCLEventTy;
6306       break;
6307     case PREDEF_TYPE_CLK_EVENT_ID:
6308       T = Context.OCLClkEventTy;
6309       break;
6310     case PREDEF_TYPE_QUEUE_ID:
6311       T = Context.OCLQueueTy;
6312       break;
6313     case PREDEF_TYPE_NDRANGE_ID:
6314       T = Context.OCLNDRangeTy;
6315       break;
6316     case PREDEF_TYPE_RESERVE_ID_ID:
6317       T = Context.OCLReserveIDTy;
6318       break;
6319     case PREDEF_TYPE_AUTO_DEDUCT:
6320       T = Context.getAutoDeductType();
6321       break;
6322 
6323     case PREDEF_TYPE_AUTO_RREF_DEDUCT:
6324       T = Context.getAutoRRefDeductType();
6325       break;
6326 
6327     case PREDEF_TYPE_ARC_UNBRIDGED_CAST:
6328       T = Context.ARCUnbridgedCastTy;
6329       break;
6330 
6331     case PREDEF_TYPE_BUILTIN_FN:
6332       T = Context.BuiltinFnTy;
6333       break;
6334 
6335     case PREDEF_TYPE_OMP_ARRAY_SECTION:
6336       T = Context.OMPArraySectionTy;
6337       break;
6338     }
6339 
6340     assert(!T.isNull() && "Unknown predefined type");
6341     return T.withFastQualifiers(FastQuals);
6342   }
6343 
6344   Index -= NUM_PREDEF_TYPE_IDS;
6345   assert(Index < TypesLoaded.size() && "Type index out-of-range");
6346   if (TypesLoaded[Index].isNull()) {
6347     TypesLoaded[Index] = readTypeRecord(Index);
6348     if (TypesLoaded[Index].isNull())
6349       return QualType();
6350 
6351     TypesLoaded[Index]->setFromAST();
6352     if (DeserializationListener)
6353       DeserializationListener->TypeRead(TypeIdx::fromTypeID(ID),
6354                                         TypesLoaded[Index]);
6355   }
6356 
6357   return TypesLoaded[Index].withFastQualifiers(FastQuals);
6358 }
6359 
6360 QualType ASTReader::getLocalType(ModuleFile &F, unsigned LocalID) {
6361   return GetType(getGlobalTypeID(F, LocalID));
6362 }
6363 
6364 serialization::TypeID
6365 ASTReader::getGlobalTypeID(ModuleFile &F, unsigned LocalID) const {
6366   unsigned FastQuals = LocalID & Qualifiers::FastMask;
6367   unsigned LocalIndex = LocalID >> Qualifiers::FastWidth;
6368 
6369   if (LocalIndex < NUM_PREDEF_TYPE_IDS)
6370     return LocalID;
6371 
6372   ContinuousRangeMap<uint32_t, int, 2>::iterator I
6373     = F.TypeRemap.find(LocalIndex - NUM_PREDEF_TYPE_IDS);
6374   assert(I != F.TypeRemap.end() && "Invalid index into type index remap");
6375 
6376   unsigned GlobalIndex = LocalIndex + I->second;
6377   return (GlobalIndex << Qualifiers::FastWidth) | FastQuals;
6378 }
6379 
6380 TemplateArgumentLocInfo
6381 ASTReader::GetTemplateArgumentLocInfo(ModuleFile &F,
6382                                       TemplateArgument::ArgKind Kind,
6383                                       const RecordData &Record,
6384                                       unsigned &Index) {
6385   switch (Kind) {
6386   case TemplateArgument::Expression:
6387     return ReadExpr(F);
6388   case TemplateArgument::Type:
6389     return GetTypeSourceInfo(F, Record, Index);
6390   case TemplateArgument::Template: {
6391     NestedNameSpecifierLoc QualifierLoc = ReadNestedNameSpecifierLoc(F, Record,
6392                                                                      Index);
6393     SourceLocation TemplateNameLoc = ReadSourceLocation(F, Record, Index);
6394     return TemplateArgumentLocInfo(QualifierLoc, TemplateNameLoc,
6395                                    SourceLocation());
6396   }
6397   case TemplateArgument::TemplateExpansion: {
6398     NestedNameSpecifierLoc QualifierLoc = ReadNestedNameSpecifierLoc(F, Record,
6399                                                                      Index);
6400     SourceLocation TemplateNameLoc = ReadSourceLocation(F, Record, Index);
6401     SourceLocation EllipsisLoc = ReadSourceLocation(F, Record, Index);
6402     return TemplateArgumentLocInfo(QualifierLoc, TemplateNameLoc,
6403                                    EllipsisLoc);
6404   }
6405   case TemplateArgument::Null:
6406   case TemplateArgument::Integral:
6407   case TemplateArgument::Declaration:
6408   case TemplateArgument::NullPtr:
6409   case TemplateArgument::Pack:
6410     // FIXME: Is this right?
6411     return TemplateArgumentLocInfo();
6412   }
6413   llvm_unreachable("unexpected template argument loc");
6414 }
6415 
6416 TemplateArgumentLoc
6417 ASTReader::ReadTemplateArgumentLoc(ModuleFile &F,
6418                                    const RecordData &Record, unsigned &Index) {
6419   TemplateArgument Arg = ReadTemplateArgument(F, Record, Index);
6420 
6421   if (Arg.getKind() == TemplateArgument::Expression) {
6422     if (Record[Index++]) // bool InfoHasSameExpr.
6423       return TemplateArgumentLoc(Arg, TemplateArgumentLocInfo(Arg.getAsExpr()));
6424   }
6425   return TemplateArgumentLoc(Arg, GetTemplateArgumentLocInfo(F, Arg.getKind(),
6426                                                              Record, Index));
6427 }
6428 
6429 const ASTTemplateArgumentListInfo*
6430 ASTReader::ReadASTTemplateArgumentListInfo(ModuleFile &F,
6431                                            const RecordData &Record,
6432                                            unsigned &Index) {
6433   SourceLocation LAngleLoc = ReadSourceLocation(F, Record, Index);
6434   SourceLocation RAngleLoc = ReadSourceLocation(F, Record, Index);
6435   unsigned NumArgsAsWritten = Record[Index++];
6436   TemplateArgumentListInfo TemplArgsInfo(LAngleLoc, RAngleLoc);
6437   for (unsigned i = 0; i != NumArgsAsWritten; ++i)
6438     TemplArgsInfo.addArgument(ReadTemplateArgumentLoc(F, Record, Index));
6439   return ASTTemplateArgumentListInfo::Create(getContext(), TemplArgsInfo);
6440 }
6441 
6442 Decl *ASTReader::GetExternalDecl(uint32_t ID) {
6443   return GetDecl(ID);
6444 }
6445 
6446 template<typename TemplateSpecializationDecl>
6447 static void completeRedeclChainForTemplateSpecialization(Decl *D) {
6448   if (auto *TSD = dyn_cast<TemplateSpecializationDecl>(D))
6449     TSD->getSpecializedTemplate()->LoadLazySpecializations();
6450 }
6451 
6452 void ASTReader::CompleteRedeclChain(const Decl *D) {
6453   if (NumCurrentElementsDeserializing) {
6454     // We arrange to not care about the complete redeclaration chain while we're
6455     // deserializing. Just remember that the AST has marked this one as complete
6456     // but that it's not actually complete yet, so we know we still need to
6457     // complete it later.
6458     PendingIncompleteDeclChains.push_back(const_cast<Decl*>(D));
6459     return;
6460   }
6461 
6462   const DeclContext *DC = D->getDeclContext()->getRedeclContext();
6463 
6464   // If this is a named declaration, complete it by looking it up
6465   // within its context.
6466   //
6467   // FIXME: Merging a function definition should merge
6468   // all mergeable entities within it.
6469   if (isa<TranslationUnitDecl>(DC) || isa<NamespaceDecl>(DC) ||
6470       isa<CXXRecordDecl>(DC) || isa<EnumDecl>(DC)) {
6471     if (DeclarationName Name = cast<NamedDecl>(D)->getDeclName()) {
6472       if (!getContext().getLangOpts().CPlusPlus &&
6473           isa<TranslationUnitDecl>(DC)) {
6474         // Outside of C++, we don't have a lookup table for the TU, so update
6475         // the identifier instead. (For C++ modules, we don't store decls
6476         // in the serialized identifier table, so we do the lookup in the TU.)
6477         auto *II = Name.getAsIdentifierInfo();
6478         assert(II && "non-identifier name in C?");
6479         if (II->isOutOfDate())
6480           updateOutOfDateIdentifier(*II);
6481       } else
6482         DC->lookup(Name);
6483     } else if (needsAnonymousDeclarationNumber(cast<NamedDecl>(D))) {
6484       // Find all declarations of this kind from the relevant context.
6485       for (auto *DCDecl : cast<Decl>(D->getLexicalDeclContext())->redecls()) {
6486         auto *DC = cast<DeclContext>(DCDecl);
6487         SmallVector<Decl*, 8> Decls;
6488         FindExternalLexicalDecls(
6489             DC, [&](Decl::Kind K) { return K == D->getKind(); }, Decls);
6490       }
6491     }
6492   }
6493 
6494   if (auto *CTSD = dyn_cast<ClassTemplateSpecializationDecl>(D))
6495     CTSD->getSpecializedTemplate()->LoadLazySpecializations();
6496   if (auto *VTSD = dyn_cast<VarTemplateSpecializationDecl>(D))
6497     VTSD->getSpecializedTemplate()->LoadLazySpecializations();
6498   if (auto *FD = dyn_cast<FunctionDecl>(D)) {
6499     if (auto *Template = FD->getPrimaryTemplate())
6500       Template->LoadLazySpecializations();
6501   }
6502 }
6503 
6504 CXXCtorInitializer **
6505 ASTReader::GetExternalCXXCtorInitializers(uint64_t Offset) {
6506   RecordLocation Loc = getLocalBitOffset(Offset);
6507   BitstreamCursor &Cursor = Loc.F->DeclsCursor;
6508   SavedStreamPosition SavedPosition(Cursor);
6509   Cursor.JumpToBit(Loc.Offset);
6510   ReadingKindTracker ReadingKind(Read_Decl, *this);
6511 
6512   RecordData Record;
6513   unsigned Code = Cursor.ReadCode();
6514   unsigned RecCode = Cursor.readRecord(Code, Record);
6515   if (RecCode != DECL_CXX_CTOR_INITIALIZERS) {
6516     Error("malformed AST file: missing C++ ctor initializers");
6517     return nullptr;
6518   }
6519 
6520   unsigned Idx = 0;
6521   return ReadCXXCtorInitializers(*Loc.F, Record, Idx);
6522 }
6523 
6524 CXXBaseSpecifier *ASTReader::GetExternalCXXBaseSpecifiers(uint64_t Offset) {
6525   RecordLocation Loc = getLocalBitOffset(Offset);
6526   BitstreamCursor &Cursor = Loc.F->DeclsCursor;
6527   SavedStreamPosition SavedPosition(Cursor);
6528   Cursor.JumpToBit(Loc.Offset);
6529   ReadingKindTracker ReadingKind(Read_Decl, *this);
6530   RecordData Record;
6531   unsigned Code = Cursor.ReadCode();
6532   unsigned RecCode = Cursor.readRecord(Code, Record);
6533   if (RecCode != DECL_CXX_BASE_SPECIFIERS) {
6534     Error("malformed AST file: missing C++ base specifiers");
6535     return nullptr;
6536   }
6537 
6538   unsigned Idx = 0;
6539   unsigned NumBases = Record[Idx++];
6540   void *Mem = Context.Allocate(sizeof(CXXBaseSpecifier) * NumBases);
6541   CXXBaseSpecifier *Bases = new (Mem) CXXBaseSpecifier [NumBases];
6542   for (unsigned I = 0; I != NumBases; ++I)
6543     Bases[I] = ReadCXXBaseSpecifier(*Loc.F, Record, Idx);
6544   return Bases;
6545 }
6546 
6547 serialization::DeclID
6548 ASTReader::getGlobalDeclID(ModuleFile &F, LocalDeclID LocalID) const {
6549   if (LocalID < NUM_PREDEF_DECL_IDS)
6550     return LocalID;
6551 
6552   ContinuousRangeMap<uint32_t, int, 2>::iterator I
6553     = F.DeclRemap.find(LocalID - NUM_PREDEF_DECL_IDS);
6554   assert(I != F.DeclRemap.end() && "Invalid index into decl index remap");
6555 
6556   return LocalID + I->second;
6557 }
6558 
6559 bool ASTReader::isDeclIDFromModule(serialization::GlobalDeclID ID,
6560                                    ModuleFile &M) const {
6561   // Predefined decls aren't from any module.
6562   if (ID < NUM_PREDEF_DECL_IDS)
6563     return false;
6564 
6565   return ID - NUM_PREDEF_DECL_IDS >= M.BaseDeclID &&
6566          ID - NUM_PREDEF_DECL_IDS < M.BaseDeclID + M.LocalNumDecls;
6567 }
6568 
6569 ModuleFile *ASTReader::getOwningModuleFile(const Decl *D) {
6570   if (!D->isFromASTFile())
6571     return nullptr;
6572   GlobalDeclMapType::const_iterator I = GlobalDeclMap.find(D->getGlobalID());
6573   assert(I != GlobalDeclMap.end() && "Corrupted global declaration map");
6574   return I->second;
6575 }
6576 
6577 SourceLocation ASTReader::getSourceLocationForDeclID(GlobalDeclID ID) {
6578   if (ID < NUM_PREDEF_DECL_IDS)
6579     return SourceLocation();
6580 
6581   unsigned Index = ID - NUM_PREDEF_DECL_IDS;
6582 
6583   if (Index > DeclsLoaded.size()) {
6584     Error("declaration ID out-of-range for AST file");
6585     return SourceLocation();
6586   }
6587 
6588   if (Decl *D = DeclsLoaded[Index])
6589     return D->getLocation();
6590 
6591   SourceLocation Loc;
6592   DeclCursorForID(ID, Loc);
6593   return Loc;
6594 }
6595 
6596 static Decl *getPredefinedDecl(ASTContext &Context, PredefinedDeclIDs ID) {
6597   switch (ID) {
6598   case PREDEF_DECL_NULL_ID:
6599     return nullptr;
6600 
6601   case PREDEF_DECL_TRANSLATION_UNIT_ID:
6602     return Context.getTranslationUnitDecl();
6603 
6604   case PREDEF_DECL_OBJC_ID_ID:
6605     return Context.getObjCIdDecl();
6606 
6607   case PREDEF_DECL_OBJC_SEL_ID:
6608     return Context.getObjCSelDecl();
6609 
6610   case PREDEF_DECL_OBJC_CLASS_ID:
6611     return Context.getObjCClassDecl();
6612 
6613   case PREDEF_DECL_OBJC_PROTOCOL_ID:
6614     return Context.getObjCProtocolDecl();
6615 
6616   case PREDEF_DECL_INT_128_ID:
6617     return Context.getInt128Decl();
6618 
6619   case PREDEF_DECL_UNSIGNED_INT_128_ID:
6620     return Context.getUInt128Decl();
6621 
6622   case PREDEF_DECL_OBJC_INSTANCETYPE_ID:
6623     return Context.getObjCInstanceTypeDecl();
6624 
6625   case PREDEF_DECL_BUILTIN_VA_LIST_ID:
6626     return Context.getBuiltinVaListDecl();
6627 
6628   case PREDEF_DECL_VA_LIST_TAG:
6629     return Context.getVaListTagDecl();
6630 
6631   case PREDEF_DECL_BUILTIN_MS_VA_LIST_ID:
6632     return Context.getBuiltinMSVaListDecl();
6633 
6634   case PREDEF_DECL_EXTERN_C_CONTEXT_ID:
6635     return Context.getExternCContextDecl();
6636 
6637   case PREDEF_DECL_MAKE_INTEGER_SEQ_ID:
6638     return Context.getMakeIntegerSeqDecl();
6639 
6640   case PREDEF_DECL_CF_CONSTANT_STRING_ID:
6641     return Context.getCFConstantStringDecl();
6642 
6643   case PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID:
6644     return Context.getCFConstantStringTagDecl();
6645 
6646   case PREDEF_DECL_TYPE_PACK_ELEMENT_ID:
6647     return Context.getTypePackElementDecl();
6648   }
6649   llvm_unreachable("PredefinedDeclIDs unknown enum value");
6650 }
6651 
6652 Decl *ASTReader::GetExistingDecl(DeclID ID) {
6653   if (ID < NUM_PREDEF_DECL_IDS) {
6654     Decl *D = getPredefinedDecl(Context, (PredefinedDeclIDs)ID);
6655     if (D) {
6656       // Track that we have merged the declaration with ID \p ID into the
6657       // pre-existing predefined declaration \p D.
6658       auto &Merged = KeyDecls[D->getCanonicalDecl()];
6659       if (Merged.empty())
6660         Merged.push_back(ID);
6661     }
6662     return D;
6663   }
6664 
6665   unsigned Index = ID - NUM_PREDEF_DECL_IDS;
6666 
6667   if (Index >= DeclsLoaded.size()) {
6668     assert(0 && "declaration ID out-of-range for AST file");
6669     Error("declaration ID out-of-range for AST file");
6670     return nullptr;
6671   }
6672 
6673   return DeclsLoaded[Index];
6674 }
6675 
6676 Decl *ASTReader::GetDecl(DeclID ID) {
6677   if (ID < NUM_PREDEF_DECL_IDS)
6678     return GetExistingDecl(ID);
6679 
6680   unsigned Index = ID - NUM_PREDEF_DECL_IDS;
6681 
6682   if (Index >= DeclsLoaded.size()) {
6683     assert(0 && "declaration ID out-of-range for AST file");
6684     Error("declaration ID out-of-range for AST file");
6685     return nullptr;
6686   }
6687 
6688   if (!DeclsLoaded[Index]) {
6689     ReadDeclRecord(ID);
6690     if (DeserializationListener)
6691       DeserializationListener->DeclRead(ID, DeclsLoaded[Index]);
6692   }
6693 
6694   return DeclsLoaded[Index];
6695 }
6696 
6697 DeclID ASTReader::mapGlobalIDToModuleFileGlobalID(ModuleFile &M,
6698                                                   DeclID GlobalID) {
6699   if (GlobalID < NUM_PREDEF_DECL_IDS)
6700     return GlobalID;
6701 
6702   GlobalDeclMapType::const_iterator I = GlobalDeclMap.find(GlobalID);
6703   assert(I != GlobalDeclMap.end() && "Corrupted global declaration map");
6704   ModuleFile *Owner = I->second;
6705 
6706   llvm::DenseMap<ModuleFile *, serialization::DeclID>::iterator Pos
6707     = M.GlobalToLocalDeclIDs.find(Owner);
6708   if (Pos == M.GlobalToLocalDeclIDs.end())
6709     return 0;
6710 
6711   return GlobalID - Owner->BaseDeclID + Pos->second;
6712 }
6713 
6714 serialization::DeclID ASTReader::ReadDeclID(ModuleFile &F,
6715                                             const RecordData &Record,
6716                                             unsigned &Idx) {
6717   if (Idx >= Record.size()) {
6718     Error("Corrupted AST file");
6719     return 0;
6720   }
6721 
6722   return getGlobalDeclID(F, Record[Idx++]);
6723 }
6724 
6725 /// \brief Resolve the offset of a statement into a statement.
6726 ///
6727 /// This operation will read a new statement from the external
6728 /// source each time it is called, and is meant to be used via a
6729 /// LazyOffsetPtr (which is used by Decls for the body of functions, etc).
6730 Stmt *ASTReader::GetExternalDeclStmt(uint64_t Offset) {
6731   // Switch case IDs are per Decl.
6732   ClearSwitchCaseIDs();
6733 
6734   // Offset here is a global offset across the entire chain.
6735   RecordLocation Loc = getLocalBitOffset(Offset);
6736   Loc.F->DeclsCursor.JumpToBit(Loc.Offset);
6737   return ReadStmtFromStream(*Loc.F);
6738 }
6739 
6740 void ASTReader::FindExternalLexicalDecls(
6741     const DeclContext *DC, llvm::function_ref<bool(Decl::Kind)> IsKindWeWant,
6742     SmallVectorImpl<Decl *> &Decls) {
6743   bool PredefsVisited[NUM_PREDEF_DECL_IDS] = {};
6744 
6745   auto Visit = [&] (ModuleFile *M, LexicalContents LexicalDecls) {
6746     assert(LexicalDecls.size() % 2 == 0 && "expected an even number of entries");
6747     for (int I = 0, N = LexicalDecls.size(); I != N; I += 2) {
6748       auto K = (Decl::Kind)+LexicalDecls[I];
6749       if (!IsKindWeWant(K))
6750         continue;
6751 
6752       auto ID = (serialization::DeclID)+LexicalDecls[I + 1];
6753 
6754       // Don't add predefined declarations to the lexical context more
6755       // than once.
6756       if (ID < NUM_PREDEF_DECL_IDS) {
6757         if (PredefsVisited[ID])
6758           continue;
6759 
6760         PredefsVisited[ID] = true;
6761       }
6762 
6763       if (Decl *D = GetLocalDecl(*M, ID)) {
6764         assert(D->getKind() == K && "wrong kind for lexical decl");
6765         if (!DC->isDeclInLexicalTraversal(D))
6766           Decls.push_back(D);
6767       }
6768     }
6769   };
6770 
6771   if (isa<TranslationUnitDecl>(DC)) {
6772     for (auto Lexical : TULexicalDecls)
6773       Visit(Lexical.first, Lexical.second);
6774   } else {
6775     auto I = LexicalDecls.find(DC);
6776     if (I != LexicalDecls.end())
6777       Visit(I->second.first, I->second.second);
6778   }
6779 
6780   ++NumLexicalDeclContextsRead;
6781 }
6782 
6783 namespace {
6784 
6785 class DeclIDComp {
6786   ASTReader &Reader;
6787   ModuleFile &Mod;
6788 
6789 public:
6790   DeclIDComp(ASTReader &Reader, ModuleFile &M) : Reader(Reader), Mod(M) {}
6791 
6792   bool operator()(LocalDeclID L, LocalDeclID R) const {
6793     SourceLocation LHS = getLocation(L);
6794     SourceLocation RHS = getLocation(R);
6795     return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
6796   }
6797 
6798   bool operator()(SourceLocation LHS, LocalDeclID R) const {
6799     SourceLocation RHS = getLocation(R);
6800     return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
6801   }
6802 
6803   bool operator()(LocalDeclID L, SourceLocation RHS) const {
6804     SourceLocation LHS = getLocation(L);
6805     return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
6806   }
6807 
6808   SourceLocation getLocation(LocalDeclID ID) const {
6809     return Reader.getSourceManager().getFileLoc(
6810             Reader.getSourceLocationForDeclID(Reader.getGlobalDeclID(Mod, ID)));
6811   }
6812 };
6813 
6814 } // end anonymous namespace
6815 
6816 void ASTReader::FindFileRegionDecls(FileID File,
6817                                     unsigned Offset, unsigned Length,
6818                                     SmallVectorImpl<Decl *> &Decls) {
6819   SourceManager &SM = getSourceManager();
6820 
6821   llvm::DenseMap<FileID, FileDeclsInfo>::iterator I = FileDeclIDs.find(File);
6822   if (I == FileDeclIDs.end())
6823     return;
6824 
6825   FileDeclsInfo &DInfo = I->second;
6826   if (DInfo.Decls.empty())
6827     return;
6828 
6829   SourceLocation
6830     BeginLoc = SM.getLocForStartOfFile(File).getLocWithOffset(Offset);
6831   SourceLocation EndLoc = BeginLoc.getLocWithOffset(Length);
6832 
6833   DeclIDComp DIDComp(*this, *DInfo.Mod);
6834   ArrayRef<serialization::LocalDeclID>::iterator
6835     BeginIt = std::lower_bound(DInfo.Decls.begin(), DInfo.Decls.end(),
6836                                BeginLoc, DIDComp);
6837   if (BeginIt != DInfo.Decls.begin())
6838     --BeginIt;
6839 
6840   // If we are pointing at a top-level decl inside an objc container, we need
6841   // to backtrack until we find it otherwise we will fail to report that the
6842   // region overlaps with an objc container.
6843   while (BeginIt != DInfo.Decls.begin() &&
6844          GetDecl(getGlobalDeclID(*DInfo.Mod, *BeginIt))
6845              ->isTopLevelDeclInObjCContainer())
6846     --BeginIt;
6847 
6848   ArrayRef<serialization::LocalDeclID>::iterator
6849     EndIt = std::upper_bound(DInfo.Decls.begin(), DInfo.Decls.end(),
6850                              EndLoc, DIDComp);
6851   if (EndIt != DInfo.Decls.end())
6852     ++EndIt;
6853 
6854   for (ArrayRef<serialization::LocalDeclID>::iterator
6855          DIt = BeginIt; DIt != EndIt; ++DIt)
6856     Decls.push_back(GetDecl(getGlobalDeclID(*DInfo.Mod, *DIt)));
6857 }
6858 
6859 bool
6860 ASTReader::FindExternalVisibleDeclsByName(const DeclContext *DC,
6861                                           DeclarationName Name) {
6862   assert(DC->hasExternalVisibleStorage() && DC == DC->getPrimaryContext() &&
6863          "DeclContext has no visible decls in storage");
6864   if (!Name)
6865     return false;
6866 
6867   auto It = Lookups.find(DC);
6868   if (It == Lookups.end())
6869     return false;
6870 
6871   Deserializing LookupResults(this);
6872 
6873   // Load the list of declarations.
6874   SmallVector<NamedDecl *, 64> Decls;
6875   for (DeclID ID : It->second.Table.find(Name)) {
6876     NamedDecl *ND = cast<NamedDecl>(GetDecl(ID));
6877     if (ND->getDeclName() == Name)
6878       Decls.push_back(ND);
6879   }
6880 
6881   ++NumVisibleDeclContextsRead;
6882   SetExternalVisibleDeclsForName(DC, Name, Decls);
6883   return !Decls.empty();
6884 }
6885 
6886 void ASTReader::completeVisibleDeclsMap(const DeclContext *DC) {
6887   if (!DC->hasExternalVisibleStorage())
6888     return;
6889 
6890   auto It = Lookups.find(DC);
6891   assert(It != Lookups.end() &&
6892          "have external visible storage but no lookup tables");
6893 
6894   DeclsMap Decls;
6895 
6896   for (DeclID ID : It->second.Table.findAll()) {
6897     NamedDecl *ND = cast<NamedDecl>(GetDecl(ID));
6898     Decls[ND->getDeclName()].push_back(ND);
6899   }
6900 
6901   ++NumVisibleDeclContextsRead;
6902 
6903   for (DeclsMap::iterator I = Decls.begin(), E = Decls.end(); I != E; ++I) {
6904     SetExternalVisibleDeclsForName(DC, I->first, I->second);
6905   }
6906   const_cast<DeclContext *>(DC)->setHasExternalVisibleStorage(false);
6907 }
6908 
6909 const serialization::reader::DeclContextLookupTable *
6910 ASTReader::getLoadedLookupTables(DeclContext *Primary) const {
6911   auto I = Lookups.find(Primary);
6912   return I == Lookups.end() ? nullptr : &I->second;
6913 }
6914 
6915 /// \brief Under non-PCH compilation the consumer receives the objc methods
6916 /// before receiving the implementation, and codegen depends on this.
6917 /// We simulate this by deserializing and passing to consumer the methods of the
6918 /// implementation before passing the deserialized implementation decl.
6919 static void PassObjCImplDeclToConsumer(ObjCImplDecl *ImplD,
6920                                        ASTConsumer *Consumer) {
6921   assert(ImplD && Consumer);
6922 
6923   for (auto *I : ImplD->methods())
6924     Consumer->HandleInterestingDecl(DeclGroupRef(I));
6925 
6926   Consumer->HandleInterestingDecl(DeclGroupRef(ImplD));
6927 }
6928 
6929 void ASTReader::PassInterestingDeclsToConsumer() {
6930   assert(Consumer);
6931 
6932   if (PassingDeclsToConsumer)
6933     return;
6934 
6935   // Guard variable to avoid recursively redoing the process of passing
6936   // decls to consumer.
6937   SaveAndRestore<bool> GuardPassingDeclsToConsumer(PassingDeclsToConsumer,
6938                                                    true);
6939 
6940   // Ensure that we've loaded all potentially-interesting declarations
6941   // that need to be eagerly loaded.
6942   for (auto ID : EagerlyDeserializedDecls)
6943     GetDecl(ID);
6944   EagerlyDeserializedDecls.clear();
6945 
6946   while (!InterestingDecls.empty()) {
6947     Decl *D = InterestingDecls.front();
6948     InterestingDecls.pop_front();
6949 
6950     PassInterestingDeclToConsumer(D);
6951   }
6952 }
6953 
6954 void ASTReader::PassInterestingDeclToConsumer(Decl *D) {
6955   if (ObjCImplDecl *ImplD = dyn_cast<ObjCImplDecl>(D))
6956     PassObjCImplDeclToConsumer(ImplD, Consumer);
6957   else
6958     Consumer->HandleInterestingDecl(DeclGroupRef(D));
6959 }
6960 
6961 void ASTReader::StartTranslationUnit(ASTConsumer *Consumer) {
6962   this->Consumer = Consumer;
6963 
6964   if (Consumer)
6965     PassInterestingDeclsToConsumer();
6966 
6967   if (DeserializationListener)
6968     DeserializationListener->ReaderInitialized(this);
6969 }
6970 
6971 void ASTReader::PrintStats() {
6972   std::fprintf(stderr, "*** AST File Statistics:\n");
6973 
6974   unsigned NumTypesLoaded
6975     = TypesLoaded.size() - std::count(TypesLoaded.begin(), TypesLoaded.end(),
6976                                       QualType());
6977   unsigned NumDeclsLoaded
6978     = DeclsLoaded.size() - std::count(DeclsLoaded.begin(), DeclsLoaded.end(),
6979                                       (Decl *)nullptr);
6980   unsigned NumIdentifiersLoaded
6981     = IdentifiersLoaded.size() - std::count(IdentifiersLoaded.begin(),
6982                                             IdentifiersLoaded.end(),
6983                                             (IdentifierInfo *)nullptr);
6984   unsigned NumMacrosLoaded
6985     = MacrosLoaded.size() - std::count(MacrosLoaded.begin(),
6986                                        MacrosLoaded.end(),
6987                                        (MacroInfo *)nullptr);
6988   unsigned NumSelectorsLoaded
6989     = SelectorsLoaded.size() - std::count(SelectorsLoaded.begin(),
6990                                           SelectorsLoaded.end(),
6991                                           Selector());
6992 
6993   if (unsigned TotalNumSLocEntries = getTotalNumSLocs())
6994     std::fprintf(stderr, "  %u/%u source location entries read (%f%%)\n",
6995                  NumSLocEntriesRead, TotalNumSLocEntries,
6996                  ((float)NumSLocEntriesRead/TotalNumSLocEntries * 100));
6997   if (!TypesLoaded.empty())
6998     std::fprintf(stderr, "  %u/%u types read (%f%%)\n",
6999                  NumTypesLoaded, (unsigned)TypesLoaded.size(),
7000                  ((float)NumTypesLoaded/TypesLoaded.size() * 100));
7001   if (!DeclsLoaded.empty())
7002     std::fprintf(stderr, "  %u/%u declarations read (%f%%)\n",
7003                  NumDeclsLoaded, (unsigned)DeclsLoaded.size(),
7004                  ((float)NumDeclsLoaded/DeclsLoaded.size() * 100));
7005   if (!IdentifiersLoaded.empty())
7006     std::fprintf(stderr, "  %u/%u identifiers read (%f%%)\n",
7007                  NumIdentifiersLoaded, (unsigned)IdentifiersLoaded.size(),
7008                  ((float)NumIdentifiersLoaded/IdentifiersLoaded.size() * 100));
7009   if (!MacrosLoaded.empty())
7010     std::fprintf(stderr, "  %u/%u macros read (%f%%)\n",
7011                  NumMacrosLoaded, (unsigned)MacrosLoaded.size(),
7012                  ((float)NumMacrosLoaded/MacrosLoaded.size() * 100));
7013   if (!SelectorsLoaded.empty())
7014     std::fprintf(stderr, "  %u/%u selectors read (%f%%)\n",
7015                  NumSelectorsLoaded, (unsigned)SelectorsLoaded.size(),
7016                  ((float)NumSelectorsLoaded/SelectorsLoaded.size() * 100));
7017   if (TotalNumStatements)
7018     std::fprintf(stderr, "  %u/%u statements read (%f%%)\n",
7019                  NumStatementsRead, TotalNumStatements,
7020                  ((float)NumStatementsRead/TotalNumStatements * 100));
7021   if (TotalNumMacros)
7022     std::fprintf(stderr, "  %u/%u macros read (%f%%)\n",
7023                  NumMacrosRead, TotalNumMacros,
7024                  ((float)NumMacrosRead/TotalNumMacros * 100));
7025   if (TotalLexicalDeclContexts)
7026     std::fprintf(stderr, "  %u/%u lexical declcontexts read (%f%%)\n",
7027                  NumLexicalDeclContextsRead, TotalLexicalDeclContexts,
7028                  ((float)NumLexicalDeclContextsRead/TotalLexicalDeclContexts
7029                   * 100));
7030   if (TotalVisibleDeclContexts)
7031     std::fprintf(stderr, "  %u/%u visible declcontexts read (%f%%)\n",
7032                  NumVisibleDeclContextsRead, TotalVisibleDeclContexts,
7033                  ((float)NumVisibleDeclContextsRead/TotalVisibleDeclContexts
7034                   * 100));
7035   if (TotalNumMethodPoolEntries) {
7036     std::fprintf(stderr, "  %u/%u method pool entries read (%f%%)\n",
7037                  NumMethodPoolEntriesRead, TotalNumMethodPoolEntries,
7038                  ((float)NumMethodPoolEntriesRead/TotalNumMethodPoolEntries
7039                   * 100));
7040   }
7041   if (NumMethodPoolLookups) {
7042     std::fprintf(stderr, "  %u/%u method pool lookups succeeded (%f%%)\n",
7043                  NumMethodPoolHits, NumMethodPoolLookups,
7044                  ((float)NumMethodPoolHits/NumMethodPoolLookups * 100.0));
7045   }
7046   if (NumMethodPoolTableLookups) {
7047     std::fprintf(stderr, "  %u/%u method pool table lookups succeeded (%f%%)\n",
7048                  NumMethodPoolTableHits, NumMethodPoolTableLookups,
7049                  ((float)NumMethodPoolTableHits/NumMethodPoolTableLookups
7050                   * 100.0));
7051   }
7052 
7053   if (NumIdentifierLookupHits) {
7054     std::fprintf(stderr,
7055                  "  %u / %u identifier table lookups succeeded (%f%%)\n",
7056                  NumIdentifierLookupHits, NumIdentifierLookups,
7057                  (double)NumIdentifierLookupHits*100.0/NumIdentifierLookups);
7058   }
7059 
7060   if (GlobalIndex) {
7061     std::fprintf(stderr, "\n");
7062     GlobalIndex->printStats();
7063   }
7064 
7065   std::fprintf(stderr, "\n");
7066   dump();
7067   std::fprintf(stderr, "\n");
7068 }
7069 
7070 template<typename Key, typename ModuleFile, unsigned InitialCapacity>
7071 static void
7072 dumpModuleIDMap(StringRef Name,
7073                 const ContinuousRangeMap<Key, ModuleFile *,
7074                                          InitialCapacity> &Map) {
7075   if (Map.begin() == Map.end())
7076     return;
7077 
7078   typedef ContinuousRangeMap<Key, ModuleFile *, InitialCapacity> MapType;
7079   llvm::errs() << Name << ":\n";
7080   for (typename MapType::const_iterator I = Map.begin(), IEnd = Map.end();
7081        I != IEnd; ++I) {
7082     llvm::errs() << "  " << I->first << " -> " << I->second->FileName
7083       << "\n";
7084   }
7085 }
7086 
7087 LLVM_DUMP_METHOD void ASTReader::dump() {
7088   llvm::errs() << "*** PCH/ModuleFile Remappings:\n";
7089   dumpModuleIDMap("Global bit offset map", GlobalBitOffsetsMap);
7090   dumpModuleIDMap("Global source location entry map", GlobalSLocEntryMap);
7091   dumpModuleIDMap("Global type map", GlobalTypeMap);
7092   dumpModuleIDMap("Global declaration map", GlobalDeclMap);
7093   dumpModuleIDMap("Global identifier map", GlobalIdentifierMap);
7094   dumpModuleIDMap("Global macro map", GlobalMacroMap);
7095   dumpModuleIDMap("Global submodule map", GlobalSubmoduleMap);
7096   dumpModuleIDMap("Global selector map", GlobalSelectorMap);
7097   dumpModuleIDMap("Global preprocessed entity map",
7098                   GlobalPreprocessedEntityMap);
7099 
7100   llvm::errs() << "\n*** PCH/Modules Loaded:";
7101   for (ModuleManager::ModuleConstIterator M = ModuleMgr.begin(),
7102                                        MEnd = ModuleMgr.end();
7103        M != MEnd; ++M)
7104     (*M)->dump();
7105 }
7106 
7107 /// Return the amount of memory used by memory buffers, breaking down
7108 /// by heap-backed versus mmap'ed memory.
7109 void ASTReader::getMemoryBufferSizes(MemoryBufferSizes &sizes) const {
7110   for (ModuleConstIterator I = ModuleMgr.begin(),
7111       E = ModuleMgr.end(); I != E; ++I) {
7112     if (llvm::MemoryBuffer *buf = (*I)->Buffer.get()) {
7113       size_t bytes = buf->getBufferSize();
7114       switch (buf->getBufferKind()) {
7115         case llvm::MemoryBuffer::MemoryBuffer_Malloc:
7116           sizes.malloc_bytes += bytes;
7117           break;
7118         case llvm::MemoryBuffer::MemoryBuffer_MMap:
7119           sizes.mmap_bytes += bytes;
7120           break;
7121       }
7122     }
7123   }
7124 }
7125 
7126 void ASTReader::InitializeSema(Sema &S) {
7127   SemaObj = &S;
7128   S.addExternalSource(this);
7129 
7130   // Makes sure any declarations that were deserialized "too early"
7131   // still get added to the identifier's declaration chains.
7132   for (uint64_t ID : PreloadedDeclIDs) {
7133     NamedDecl *D = cast<NamedDecl>(GetDecl(ID));
7134     pushExternalDeclIntoScope(D, D->getDeclName());
7135   }
7136   PreloadedDeclIDs.clear();
7137 
7138   // FIXME: What happens if these are changed by a module import?
7139   if (!FPPragmaOptions.empty()) {
7140     assert(FPPragmaOptions.size() == 1 && "Wrong number of FP_PRAGMA_OPTIONS");
7141     SemaObj->FPFeatures.fp_contract = FPPragmaOptions[0];
7142   }
7143 
7144   SemaObj->OpenCLFeatures.copy(OpenCLExtensions);
7145   SemaObj->OpenCLTypeExtMap = OpenCLTypeExtMap;
7146   SemaObj->OpenCLDeclExtMap = OpenCLDeclExtMap;
7147 
7148   UpdateSema();
7149 }
7150 
7151 void ASTReader::UpdateSema() {
7152   assert(SemaObj && "no Sema to update");
7153 
7154   // Load the offsets of the declarations that Sema references.
7155   // They will be lazily deserialized when needed.
7156   if (!SemaDeclRefs.empty()) {
7157     assert(SemaDeclRefs.size() % 3 == 0);
7158     for (unsigned I = 0; I != SemaDeclRefs.size(); I += 3) {
7159       if (!SemaObj->StdNamespace)
7160         SemaObj->StdNamespace = SemaDeclRefs[I];
7161       if (!SemaObj->StdBadAlloc)
7162         SemaObj->StdBadAlloc = SemaDeclRefs[I+1];
7163       if (!SemaObj->StdAlignValT)
7164         SemaObj->StdAlignValT = SemaDeclRefs[I+2];
7165     }
7166     SemaDeclRefs.clear();
7167   }
7168 
7169   // Update the state of pragmas. Use the same API as if we had encountered the
7170   // pragma in the source.
7171   if(OptimizeOffPragmaLocation.isValid())
7172     SemaObj->ActOnPragmaOptimize(/* IsOn = */ false, OptimizeOffPragmaLocation);
7173   if (PragmaMSStructState != -1)
7174     SemaObj->ActOnPragmaMSStruct((PragmaMSStructKind)PragmaMSStructState);
7175   if (PointersToMembersPragmaLocation.isValid()) {
7176     SemaObj->ActOnPragmaMSPointersToMembers(
7177         (LangOptions::PragmaMSPointersToMembersKind)
7178             PragmaMSPointersToMembersState,
7179         PointersToMembersPragmaLocation);
7180   }
7181   SemaObj->ForceCUDAHostDeviceDepth = ForceCUDAHostDeviceDepth;
7182 }
7183 
7184 IdentifierInfo *ASTReader::get(StringRef Name) {
7185   // Note that we are loading an identifier.
7186   Deserializing AnIdentifier(this);
7187 
7188   IdentifierLookupVisitor Visitor(Name, /*PriorGeneration=*/0,
7189                                   NumIdentifierLookups,
7190                                   NumIdentifierLookupHits);
7191 
7192   // We don't need to do identifier table lookups in C++ modules (we preload
7193   // all interesting declarations, and don't need to use the scope for name
7194   // lookups). Perform the lookup in PCH files, though, since we don't build
7195   // a complete initial identifier table if we're carrying on from a PCH.
7196   if (Context.getLangOpts().CPlusPlus) {
7197     for (auto F : ModuleMgr.pch_modules())
7198       if (Visitor(*F))
7199         break;
7200   } else {
7201     // If there is a global index, look there first to determine which modules
7202     // provably do not have any results for this identifier.
7203     GlobalModuleIndex::HitSet Hits;
7204     GlobalModuleIndex::HitSet *HitsPtr = nullptr;
7205     if (!loadGlobalIndex()) {
7206       if (GlobalIndex->lookupIdentifier(Name, Hits)) {
7207         HitsPtr = &Hits;
7208       }
7209     }
7210 
7211     ModuleMgr.visit(Visitor, HitsPtr);
7212   }
7213 
7214   IdentifierInfo *II = Visitor.getIdentifierInfo();
7215   markIdentifierUpToDate(II);
7216   return II;
7217 }
7218 
7219 namespace clang {
7220 
7221   /// \brief An identifier-lookup iterator that enumerates all of the
7222   /// identifiers stored within a set of AST files.
7223   class ASTIdentifierIterator : public IdentifierIterator {
7224     /// \brief The AST reader whose identifiers are being enumerated.
7225     const ASTReader &Reader;
7226 
7227     /// \brief The current index into the chain of AST files stored in
7228     /// the AST reader.
7229     unsigned Index;
7230 
7231     /// \brief The current position within the identifier lookup table
7232     /// of the current AST file.
7233     ASTIdentifierLookupTable::key_iterator Current;
7234 
7235     /// \brief The end position within the identifier lookup table of
7236     /// the current AST file.
7237     ASTIdentifierLookupTable::key_iterator End;
7238 
7239     /// \brief Whether to skip any modules in the ASTReader.
7240     bool SkipModules;
7241 
7242   public:
7243     explicit ASTIdentifierIterator(const ASTReader &Reader,
7244                                    bool SkipModules = false);
7245 
7246     StringRef Next() override;
7247   };
7248 
7249 } // end namespace clang
7250 
7251 ASTIdentifierIterator::ASTIdentifierIterator(const ASTReader &Reader,
7252                                              bool SkipModules)
7253     : Reader(Reader), Index(Reader.ModuleMgr.size()), SkipModules(SkipModules) {
7254 }
7255 
7256 StringRef ASTIdentifierIterator::Next() {
7257   while (Current == End) {
7258     // If we have exhausted all of our AST files, we're done.
7259     if (Index == 0)
7260       return StringRef();
7261 
7262     --Index;
7263     ModuleFile &F = Reader.ModuleMgr[Index];
7264     if (SkipModules && F.isModule())
7265       continue;
7266 
7267     ASTIdentifierLookupTable *IdTable =
7268         (ASTIdentifierLookupTable *)F.IdentifierLookupTable;
7269     Current = IdTable->key_begin();
7270     End = IdTable->key_end();
7271   }
7272 
7273   // We have any identifiers remaining in the current AST file; return
7274   // the next one.
7275   StringRef Result = *Current;
7276   ++Current;
7277   return Result;
7278 }
7279 
7280 namespace {
7281 
7282 /// A utility for appending two IdentifierIterators.
7283 class ChainedIdentifierIterator : public IdentifierIterator {
7284   std::unique_ptr<IdentifierIterator> Current;
7285   std::unique_ptr<IdentifierIterator> Queued;
7286 
7287 public:
7288   ChainedIdentifierIterator(std::unique_ptr<IdentifierIterator> First,
7289                             std::unique_ptr<IdentifierIterator> Second)
7290       : Current(std::move(First)), Queued(std::move(Second)) {}
7291 
7292   StringRef Next() override {
7293     if (!Current)
7294       return StringRef();
7295 
7296     StringRef result = Current->Next();
7297     if (!result.empty())
7298       return result;
7299 
7300     // Try the queued iterator, which may itself be empty.
7301     Current.reset();
7302     std::swap(Current, Queued);
7303     return Next();
7304   }
7305 };
7306 
7307 } // end anonymous namespace.
7308 
7309 IdentifierIterator *ASTReader::getIdentifiers() {
7310   if (!loadGlobalIndex()) {
7311     std::unique_ptr<IdentifierIterator> ReaderIter(
7312         new ASTIdentifierIterator(*this, /*SkipModules=*/true));
7313     std::unique_ptr<IdentifierIterator> ModulesIter(
7314         GlobalIndex->createIdentifierIterator());
7315     return new ChainedIdentifierIterator(std::move(ReaderIter),
7316                                          std::move(ModulesIter));
7317   }
7318 
7319   return new ASTIdentifierIterator(*this);
7320 }
7321 
7322 namespace clang {
7323 namespace serialization {
7324 
7325   class ReadMethodPoolVisitor {
7326     ASTReader &Reader;
7327     Selector Sel;
7328     unsigned PriorGeneration;
7329     unsigned InstanceBits;
7330     unsigned FactoryBits;
7331     bool InstanceHasMoreThanOneDecl;
7332     bool FactoryHasMoreThanOneDecl;
7333     SmallVector<ObjCMethodDecl *, 4> InstanceMethods;
7334     SmallVector<ObjCMethodDecl *, 4> FactoryMethods;
7335 
7336   public:
7337     ReadMethodPoolVisitor(ASTReader &Reader, Selector Sel,
7338                           unsigned PriorGeneration)
7339         : Reader(Reader), Sel(Sel), PriorGeneration(PriorGeneration),
7340           InstanceBits(0), FactoryBits(0), InstanceHasMoreThanOneDecl(false),
7341           FactoryHasMoreThanOneDecl(false) {}
7342 
7343     bool operator()(ModuleFile &M) {
7344       if (!M.SelectorLookupTable)
7345         return false;
7346 
7347       // If we've already searched this module file, skip it now.
7348       if (M.Generation <= PriorGeneration)
7349         return true;
7350 
7351       ++Reader.NumMethodPoolTableLookups;
7352       ASTSelectorLookupTable *PoolTable
7353         = (ASTSelectorLookupTable*)M.SelectorLookupTable;
7354       ASTSelectorLookupTable::iterator Pos = PoolTable->find(Sel);
7355       if (Pos == PoolTable->end())
7356         return false;
7357 
7358       ++Reader.NumMethodPoolTableHits;
7359       ++Reader.NumSelectorsRead;
7360       // FIXME: Not quite happy with the statistics here. We probably should
7361       // disable this tracking when called via LoadSelector.
7362       // Also, should entries without methods count as misses?
7363       ++Reader.NumMethodPoolEntriesRead;
7364       ASTSelectorLookupTrait::data_type Data = *Pos;
7365       if (Reader.DeserializationListener)
7366         Reader.DeserializationListener->SelectorRead(Data.ID, Sel);
7367 
7368       InstanceMethods.append(Data.Instance.begin(), Data.Instance.end());
7369       FactoryMethods.append(Data.Factory.begin(), Data.Factory.end());
7370       InstanceBits = Data.InstanceBits;
7371       FactoryBits = Data.FactoryBits;
7372       InstanceHasMoreThanOneDecl = Data.InstanceHasMoreThanOneDecl;
7373       FactoryHasMoreThanOneDecl = Data.FactoryHasMoreThanOneDecl;
7374       return true;
7375     }
7376 
7377     /// \brief Retrieve the instance methods found by this visitor.
7378     ArrayRef<ObjCMethodDecl *> getInstanceMethods() const {
7379       return InstanceMethods;
7380     }
7381 
7382     /// \brief Retrieve the instance methods found by this visitor.
7383     ArrayRef<ObjCMethodDecl *> getFactoryMethods() const {
7384       return FactoryMethods;
7385     }
7386 
7387     unsigned getInstanceBits() const { return InstanceBits; }
7388     unsigned getFactoryBits() const { return FactoryBits; }
7389     bool instanceHasMoreThanOneDecl() const {
7390       return InstanceHasMoreThanOneDecl;
7391     }
7392     bool factoryHasMoreThanOneDecl() const { return FactoryHasMoreThanOneDecl; }
7393   };
7394 
7395 } // end namespace serialization
7396 } // end namespace clang
7397 
7398 /// \brief Add the given set of methods to the method list.
7399 static void addMethodsToPool(Sema &S, ArrayRef<ObjCMethodDecl *> Methods,
7400                              ObjCMethodList &List) {
7401   for (unsigned I = 0, N = Methods.size(); I != N; ++I) {
7402     S.addMethodToGlobalList(&List, Methods[I]);
7403   }
7404 }
7405 
7406 void ASTReader::ReadMethodPool(Selector Sel) {
7407   // Get the selector generation and update it to the current generation.
7408   unsigned &Generation = SelectorGeneration[Sel];
7409   unsigned PriorGeneration = Generation;
7410   Generation = getGeneration();
7411   SelectorOutOfDate[Sel] = false;
7412 
7413   // Search for methods defined with this selector.
7414   ++NumMethodPoolLookups;
7415   ReadMethodPoolVisitor Visitor(*this, Sel, PriorGeneration);
7416   ModuleMgr.visit(Visitor);
7417 
7418   if (Visitor.getInstanceMethods().empty() &&
7419       Visitor.getFactoryMethods().empty())
7420     return;
7421 
7422   ++NumMethodPoolHits;
7423 
7424   if (!getSema())
7425     return;
7426 
7427   Sema &S = *getSema();
7428   Sema::GlobalMethodPool::iterator Pos
7429     = S.MethodPool.insert(std::make_pair(Sel, Sema::GlobalMethods())).first;
7430 
7431   Pos->second.first.setBits(Visitor.getInstanceBits());
7432   Pos->second.first.setHasMoreThanOneDecl(Visitor.instanceHasMoreThanOneDecl());
7433   Pos->second.second.setBits(Visitor.getFactoryBits());
7434   Pos->second.second.setHasMoreThanOneDecl(Visitor.factoryHasMoreThanOneDecl());
7435 
7436   // Add methods to the global pool *after* setting hasMoreThanOneDecl, since
7437   // when building a module we keep every method individually and may need to
7438   // update hasMoreThanOneDecl as we add the methods.
7439   addMethodsToPool(S, Visitor.getInstanceMethods(), Pos->second.first);
7440   addMethodsToPool(S, Visitor.getFactoryMethods(), Pos->second.second);
7441 }
7442 
7443 void ASTReader::updateOutOfDateSelector(Selector Sel) {
7444   if (SelectorOutOfDate[Sel])
7445     ReadMethodPool(Sel);
7446 }
7447 
7448 void ASTReader::ReadKnownNamespaces(
7449                           SmallVectorImpl<NamespaceDecl *> &Namespaces) {
7450   Namespaces.clear();
7451 
7452   for (unsigned I = 0, N = KnownNamespaces.size(); I != N; ++I) {
7453     if (NamespaceDecl *Namespace
7454                 = dyn_cast_or_null<NamespaceDecl>(GetDecl(KnownNamespaces[I])))
7455       Namespaces.push_back(Namespace);
7456   }
7457 }
7458 
7459 void ASTReader::ReadUndefinedButUsed(
7460     llvm::MapVector<NamedDecl *, SourceLocation> &Undefined) {
7461   for (unsigned Idx = 0, N = UndefinedButUsed.size(); Idx != N;) {
7462     NamedDecl *D = cast<NamedDecl>(GetDecl(UndefinedButUsed[Idx++]));
7463     SourceLocation Loc =
7464         SourceLocation::getFromRawEncoding(UndefinedButUsed[Idx++]);
7465     Undefined.insert(std::make_pair(D, Loc));
7466   }
7467 }
7468 
7469 void ASTReader::ReadMismatchingDeleteExpressions(llvm::MapVector<
7470     FieldDecl *, llvm::SmallVector<std::pair<SourceLocation, bool>, 4>> &
7471                                                      Exprs) {
7472   for (unsigned Idx = 0, N = DelayedDeleteExprs.size(); Idx != N;) {
7473     FieldDecl *FD = cast<FieldDecl>(GetDecl(DelayedDeleteExprs[Idx++]));
7474     uint64_t Count = DelayedDeleteExprs[Idx++];
7475     for (uint64_t C = 0; C < Count; ++C) {
7476       SourceLocation DeleteLoc =
7477           SourceLocation::getFromRawEncoding(DelayedDeleteExprs[Idx++]);
7478       const bool IsArrayForm = DelayedDeleteExprs[Idx++];
7479       Exprs[FD].push_back(std::make_pair(DeleteLoc, IsArrayForm));
7480     }
7481   }
7482 }
7483 
7484 void ASTReader::ReadTentativeDefinitions(
7485                   SmallVectorImpl<VarDecl *> &TentativeDefs) {
7486   for (unsigned I = 0, N = TentativeDefinitions.size(); I != N; ++I) {
7487     VarDecl *Var = dyn_cast_or_null<VarDecl>(GetDecl(TentativeDefinitions[I]));
7488     if (Var)
7489       TentativeDefs.push_back(Var);
7490   }
7491   TentativeDefinitions.clear();
7492 }
7493 
7494 void ASTReader::ReadUnusedFileScopedDecls(
7495                                SmallVectorImpl<const DeclaratorDecl *> &Decls) {
7496   for (unsigned I = 0, N = UnusedFileScopedDecls.size(); I != N; ++I) {
7497     DeclaratorDecl *D
7498       = dyn_cast_or_null<DeclaratorDecl>(GetDecl(UnusedFileScopedDecls[I]));
7499     if (D)
7500       Decls.push_back(D);
7501   }
7502   UnusedFileScopedDecls.clear();
7503 }
7504 
7505 void ASTReader::ReadDelegatingConstructors(
7506                                  SmallVectorImpl<CXXConstructorDecl *> &Decls) {
7507   for (unsigned I = 0, N = DelegatingCtorDecls.size(); I != N; ++I) {
7508     CXXConstructorDecl *D
7509       = dyn_cast_or_null<CXXConstructorDecl>(GetDecl(DelegatingCtorDecls[I]));
7510     if (D)
7511       Decls.push_back(D);
7512   }
7513   DelegatingCtorDecls.clear();
7514 }
7515 
7516 void ASTReader::ReadExtVectorDecls(SmallVectorImpl<TypedefNameDecl *> &Decls) {
7517   for (unsigned I = 0, N = ExtVectorDecls.size(); I != N; ++I) {
7518     TypedefNameDecl *D
7519       = dyn_cast_or_null<TypedefNameDecl>(GetDecl(ExtVectorDecls[I]));
7520     if (D)
7521       Decls.push_back(D);
7522   }
7523   ExtVectorDecls.clear();
7524 }
7525 
7526 void ASTReader::ReadUnusedLocalTypedefNameCandidates(
7527     llvm::SmallSetVector<const TypedefNameDecl *, 4> &Decls) {
7528   for (unsigned I = 0, N = UnusedLocalTypedefNameCandidates.size(); I != N;
7529        ++I) {
7530     TypedefNameDecl *D = dyn_cast_or_null<TypedefNameDecl>(
7531         GetDecl(UnusedLocalTypedefNameCandidates[I]));
7532     if (D)
7533       Decls.insert(D);
7534   }
7535   UnusedLocalTypedefNameCandidates.clear();
7536 }
7537 
7538 void ASTReader::ReadReferencedSelectors(
7539        SmallVectorImpl<std::pair<Selector, SourceLocation> > &Sels) {
7540   if (ReferencedSelectorsData.empty())
7541     return;
7542 
7543   // If there are @selector references added them to its pool. This is for
7544   // implementation of -Wselector.
7545   unsigned int DataSize = ReferencedSelectorsData.size()-1;
7546   unsigned I = 0;
7547   while (I < DataSize) {
7548     Selector Sel = DecodeSelector(ReferencedSelectorsData[I++]);
7549     SourceLocation SelLoc
7550       = SourceLocation::getFromRawEncoding(ReferencedSelectorsData[I++]);
7551     Sels.push_back(std::make_pair(Sel, SelLoc));
7552   }
7553   ReferencedSelectorsData.clear();
7554 }
7555 
7556 void ASTReader::ReadWeakUndeclaredIdentifiers(
7557        SmallVectorImpl<std::pair<IdentifierInfo *, WeakInfo> > &WeakIDs) {
7558   if (WeakUndeclaredIdentifiers.empty())
7559     return;
7560 
7561   for (unsigned I = 0, N = WeakUndeclaredIdentifiers.size(); I < N; /*none*/) {
7562     IdentifierInfo *WeakId
7563       = DecodeIdentifierInfo(WeakUndeclaredIdentifiers[I++]);
7564     IdentifierInfo *AliasId
7565       = DecodeIdentifierInfo(WeakUndeclaredIdentifiers[I++]);
7566     SourceLocation Loc
7567       = SourceLocation::getFromRawEncoding(WeakUndeclaredIdentifiers[I++]);
7568     bool Used = WeakUndeclaredIdentifiers[I++];
7569     WeakInfo WI(AliasId, Loc);
7570     WI.setUsed(Used);
7571     WeakIDs.push_back(std::make_pair(WeakId, WI));
7572   }
7573   WeakUndeclaredIdentifiers.clear();
7574 }
7575 
7576 void ASTReader::ReadUsedVTables(SmallVectorImpl<ExternalVTableUse> &VTables) {
7577   for (unsigned Idx = 0, N = VTableUses.size(); Idx < N; /* In loop */) {
7578     ExternalVTableUse VT;
7579     VT.Record = dyn_cast_or_null<CXXRecordDecl>(GetDecl(VTableUses[Idx++]));
7580     VT.Location = SourceLocation::getFromRawEncoding(VTableUses[Idx++]);
7581     VT.DefinitionRequired = VTableUses[Idx++];
7582     VTables.push_back(VT);
7583   }
7584 
7585   VTableUses.clear();
7586 }
7587 
7588 void ASTReader::ReadPendingInstantiations(
7589        SmallVectorImpl<std::pair<ValueDecl *, SourceLocation> > &Pending) {
7590   for (unsigned Idx = 0, N = PendingInstantiations.size(); Idx < N;) {
7591     ValueDecl *D = cast<ValueDecl>(GetDecl(PendingInstantiations[Idx++]));
7592     SourceLocation Loc
7593       = SourceLocation::getFromRawEncoding(PendingInstantiations[Idx++]);
7594 
7595     Pending.push_back(std::make_pair(D, Loc));
7596   }
7597   PendingInstantiations.clear();
7598 }
7599 
7600 void ASTReader::ReadLateParsedTemplates(
7601     llvm::MapVector<const FunctionDecl *, std::unique_ptr<LateParsedTemplate>>
7602         &LPTMap) {
7603   for (unsigned Idx = 0, N = LateParsedTemplates.size(); Idx < N;
7604        /* In loop */) {
7605     FunctionDecl *FD = cast<FunctionDecl>(GetDecl(LateParsedTemplates[Idx++]));
7606 
7607     auto LT = llvm::make_unique<LateParsedTemplate>();
7608     LT->D = GetDecl(LateParsedTemplates[Idx++]);
7609 
7610     ModuleFile *F = getOwningModuleFile(LT->D);
7611     assert(F && "No module");
7612 
7613     unsigned TokN = LateParsedTemplates[Idx++];
7614     LT->Toks.reserve(TokN);
7615     for (unsigned T = 0; T < TokN; ++T)
7616       LT->Toks.push_back(ReadToken(*F, LateParsedTemplates, Idx));
7617 
7618     LPTMap.insert(std::make_pair(FD, std::move(LT)));
7619   }
7620 
7621   LateParsedTemplates.clear();
7622 }
7623 
7624 void ASTReader::LoadSelector(Selector Sel) {
7625   // It would be complicated to avoid reading the methods anyway. So don't.
7626   ReadMethodPool(Sel);
7627 }
7628 
7629 void ASTReader::SetIdentifierInfo(IdentifierID ID, IdentifierInfo *II) {
7630   assert(ID && "Non-zero identifier ID required");
7631   assert(ID <= IdentifiersLoaded.size() && "identifier ID out of range");
7632   IdentifiersLoaded[ID - 1] = II;
7633   if (DeserializationListener)
7634     DeserializationListener->IdentifierRead(ID, II);
7635 }
7636 
7637 /// \brief Set the globally-visible declarations associated with the given
7638 /// identifier.
7639 ///
7640 /// If the AST reader is currently in a state where the given declaration IDs
7641 /// cannot safely be resolved, they are queued until it is safe to resolve
7642 /// them.
7643 ///
7644 /// \param II an IdentifierInfo that refers to one or more globally-visible
7645 /// declarations.
7646 ///
7647 /// \param DeclIDs the set of declaration IDs with the name @p II that are
7648 /// visible at global scope.
7649 ///
7650 /// \param Decls if non-null, this vector will be populated with the set of
7651 /// deserialized declarations. These declarations will not be pushed into
7652 /// scope.
7653 void
7654 ASTReader::SetGloballyVisibleDecls(IdentifierInfo *II,
7655                               const SmallVectorImpl<uint32_t> &DeclIDs,
7656                                    SmallVectorImpl<Decl *> *Decls) {
7657   if (NumCurrentElementsDeserializing && !Decls) {
7658     PendingIdentifierInfos[II].append(DeclIDs.begin(), DeclIDs.end());
7659     return;
7660   }
7661 
7662   for (unsigned I = 0, N = DeclIDs.size(); I != N; ++I) {
7663     if (!SemaObj) {
7664       // Queue this declaration so that it will be added to the
7665       // translation unit scope and identifier's declaration chain
7666       // once a Sema object is known.
7667       PreloadedDeclIDs.push_back(DeclIDs[I]);
7668       continue;
7669     }
7670 
7671     NamedDecl *D = cast<NamedDecl>(GetDecl(DeclIDs[I]));
7672 
7673     // If we're simply supposed to record the declarations, do so now.
7674     if (Decls) {
7675       Decls->push_back(D);
7676       continue;
7677     }
7678 
7679     // Introduce this declaration into the translation-unit scope
7680     // and add it to the declaration chain for this identifier, so
7681     // that (unqualified) name lookup will find it.
7682     pushExternalDeclIntoScope(D, II);
7683   }
7684 }
7685 
7686 IdentifierInfo *ASTReader::DecodeIdentifierInfo(IdentifierID ID) {
7687   if (ID == 0)
7688     return nullptr;
7689 
7690   if (IdentifiersLoaded.empty()) {
7691     Error("no identifier table in AST file");
7692     return nullptr;
7693   }
7694 
7695   ID -= 1;
7696   if (!IdentifiersLoaded[ID]) {
7697     GlobalIdentifierMapType::iterator I = GlobalIdentifierMap.find(ID + 1);
7698     assert(I != GlobalIdentifierMap.end() && "Corrupted global identifier map");
7699     ModuleFile *M = I->second;
7700     unsigned Index = ID - M->BaseIdentifierID;
7701     const char *Str = M->IdentifierTableData + M->IdentifierOffsets[Index];
7702 
7703     // All of the strings in the AST file are preceded by a 16-bit length.
7704     // Extract that 16-bit length to avoid having to execute strlen().
7705     // NOTE: 'StrLenPtr' is an 'unsigned char*' so that we load bytes as
7706     //  unsigned integers.  This is important to avoid integer overflow when
7707     //  we cast them to 'unsigned'.
7708     const unsigned char *StrLenPtr = (const unsigned char*) Str - 2;
7709     unsigned StrLen = (((unsigned) StrLenPtr[0])
7710                        | (((unsigned) StrLenPtr[1]) << 8)) - 1;
7711     auto &II = PP.getIdentifierTable().get(StringRef(Str, StrLen));
7712     IdentifiersLoaded[ID] = &II;
7713     markIdentifierFromAST(*this,  II);
7714     if (DeserializationListener)
7715       DeserializationListener->IdentifierRead(ID + 1, &II);
7716   }
7717 
7718   return IdentifiersLoaded[ID];
7719 }
7720 
7721 IdentifierInfo *ASTReader::getLocalIdentifier(ModuleFile &M, unsigned LocalID) {
7722   return DecodeIdentifierInfo(getGlobalIdentifierID(M, LocalID));
7723 }
7724 
7725 IdentifierID ASTReader::getGlobalIdentifierID(ModuleFile &M, unsigned LocalID) {
7726   if (LocalID < NUM_PREDEF_IDENT_IDS)
7727     return LocalID;
7728 
7729   ContinuousRangeMap<uint32_t, int, 2>::iterator I
7730     = M.IdentifierRemap.find(LocalID - NUM_PREDEF_IDENT_IDS);
7731   assert(I != M.IdentifierRemap.end()
7732          && "Invalid index into identifier index remap");
7733 
7734   return LocalID + I->second;
7735 }
7736 
7737 MacroInfo *ASTReader::getMacro(MacroID ID) {
7738   if (ID == 0)
7739     return nullptr;
7740 
7741   if (MacrosLoaded.empty()) {
7742     Error("no macro table in AST file");
7743     return nullptr;
7744   }
7745 
7746   ID -= NUM_PREDEF_MACRO_IDS;
7747   if (!MacrosLoaded[ID]) {
7748     GlobalMacroMapType::iterator I
7749       = GlobalMacroMap.find(ID + NUM_PREDEF_MACRO_IDS);
7750     assert(I != GlobalMacroMap.end() && "Corrupted global macro map");
7751     ModuleFile *M = I->second;
7752     unsigned Index = ID - M->BaseMacroID;
7753     MacrosLoaded[ID] = ReadMacroRecord(*M, M->MacroOffsets[Index]);
7754 
7755     if (DeserializationListener)
7756       DeserializationListener->MacroRead(ID + NUM_PREDEF_MACRO_IDS,
7757                                          MacrosLoaded[ID]);
7758   }
7759 
7760   return MacrosLoaded[ID];
7761 }
7762 
7763 MacroID ASTReader::getGlobalMacroID(ModuleFile &M, unsigned LocalID) {
7764   if (LocalID < NUM_PREDEF_MACRO_IDS)
7765     return LocalID;
7766 
7767   ContinuousRangeMap<uint32_t, int, 2>::iterator I
7768     = M.MacroRemap.find(LocalID - NUM_PREDEF_MACRO_IDS);
7769   assert(I != M.MacroRemap.end() && "Invalid index into macro index remap");
7770 
7771   return LocalID + I->second;
7772 }
7773 
7774 serialization::SubmoduleID
7775 ASTReader::getGlobalSubmoduleID(ModuleFile &M, unsigned LocalID) {
7776   if (LocalID < NUM_PREDEF_SUBMODULE_IDS)
7777     return LocalID;
7778 
7779   ContinuousRangeMap<uint32_t, int, 2>::iterator I
7780     = M.SubmoduleRemap.find(LocalID - NUM_PREDEF_SUBMODULE_IDS);
7781   assert(I != M.SubmoduleRemap.end()
7782          && "Invalid index into submodule index remap");
7783 
7784   return LocalID + I->second;
7785 }
7786 
7787 Module *ASTReader::getSubmodule(SubmoduleID GlobalID) {
7788   if (GlobalID < NUM_PREDEF_SUBMODULE_IDS) {
7789     assert(GlobalID == 0 && "Unhandled global submodule ID");
7790     return nullptr;
7791   }
7792 
7793   if (GlobalID > SubmodulesLoaded.size()) {
7794     Error("submodule ID out of range in AST file");
7795     return nullptr;
7796   }
7797 
7798   return SubmodulesLoaded[GlobalID - NUM_PREDEF_SUBMODULE_IDS];
7799 }
7800 
7801 Module *ASTReader::getModule(unsigned ID) {
7802   return getSubmodule(ID);
7803 }
7804 
7805 ModuleFile *ASTReader::getLocalModuleFile(ModuleFile &F, unsigned ID) {
7806   if (ID & 1) {
7807     // It's a module, look it up by submodule ID.
7808     auto I = GlobalSubmoduleMap.find(getGlobalSubmoduleID(F, ID >> 1));
7809     return I == GlobalSubmoduleMap.end() ? nullptr : I->second;
7810   } else {
7811     // It's a prefix (preamble, PCH, ...). Look it up by index.
7812     unsigned IndexFromEnd = ID >> 1;
7813     assert(IndexFromEnd && "got reference to unknown module file");
7814     return getModuleManager().pch_modules().end()[-IndexFromEnd];
7815   }
7816 }
7817 
7818 unsigned ASTReader::getModuleFileID(ModuleFile *F) {
7819   if (!F)
7820     return 1;
7821 
7822   // For a file representing a module, use the submodule ID of the top-level
7823   // module as the file ID. For any other kind of file, the number of such
7824   // files loaded beforehand will be the same on reload.
7825   // FIXME: Is this true even if we have an explicit module file and a PCH?
7826   if (F->isModule())
7827     return ((F->BaseSubmoduleID + NUM_PREDEF_SUBMODULE_IDS) << 1) | 1;
7828 
7829   auto PCHModules = getModuleManager().pch_modules();
7830   auto I = std::find(PCHModules.begin(), PCHModules.end(), F);
7831   assert(I != PCHModules.end() && "emitting reference to unknown file");
7832   return (I - PCHModules.end()) << 1;
7833 }
7834 
7835 llvm::Optional<ExternalASTSource::ASTSourceDescriptor>
7836 ASTReader::getSourceDescriptor(unsigned ID) {
7837   if (const Module *M = getSubmodule(ID))
7838     return ExternalASTSource::ASTSourceDescriptor(*M);
7839 
7840   // If there is only a single PCH, return it instead.
7841   // Chained PCH are not suported.
7842   if (ModuleMgr.size() == 1) {
7843     ModuleFile &MF = ModuleMgr.getPrimaryModule();
7844     StringRef ModuleName = llvm::sys::path::filename(MF.OriginalSourceFileName);
7845     StringRef FileName = llvm::sys::path::filename(MF.FileName);
7846     return ASTReader::ASTSourceDescriptor(ModuleName, MF.OriginalDir, FileName,
7847                                           MF.Signature);
7848   }
7849   return None;
7850 }
7851 
7852 Selector ASTReader::getLocalSelector(ModuleFile &M, unsigned LocalID) {
7853   return DecodeSelector(getGlobalSelectorID(M, LocalID));
7854 }
7855 
7856 Selector ASTReader::DecodeSelector(serialization::SelectorID ID) {
7857   if (ID == 0)
7858     return Selector();
7859 
7860   if (ID > SelectorsLoaded.size()) {
7861     Error("selector ID out of range in AST file");
7862     return Selector();
7863   }
7864 
7865   if (SelectorsLoaded[ID - 1].getAsOpaquePtr() == nullptr) {
7866     // Load this selector from the selector table.
7867     GlobalSelectorMapType::iterator I = GlobalSelectorMap.find(ID);
7868     assert(I != GlobalSelectorMap.end() && "Corrupted global selector map");
7869     ModuleFile &M = *I->second;
7870     ASTSelectorLookupTrait Trait(*this, M);
7871     unsigned Idx = ID - M.BaseSelectorID - NUM_PREDEF_SELECTOR_IDS;
7872     SelectorsLoaded[ID - 1] =
7873       Trait.ReadKey(M.SelectorLookupTableData + M.SelectorOffsets[Idx], 0);
7874     if (DeserializationListener)
7875       DeserializationListener->SelectorRead(ID, SelectorsLoaded[ID - 1]);
7876   }
7877 
7878   return SelectorsLoaded[ID - 1];
7879 }
7880 
7881 Selector ASTReader::GetExternalSelector(serialization::SelectorID ID) {
7882   return DecodeSelector(ID);
7883 }
7884 
7885 uint32_t ASTReader::GetNumExternalSelectors() {
7886   // ID 0 (the null selector) is considered an external selector.
7887   return getTotalNumSelectors() + 1;
7888 }
7889 
7890 serialization::SelectorID
7891 ASTReader::getGlobalSelectorID(ModuleFile &M, unsigned LocalID) const {
7892   if (LocalID < NUM_PREDEF_SELECTOR_IDS)
7893     return LocalID;
7894 
7895   ContinuousRangeMap<uint32_t, int, 2>::iterator I
7896     = M.SelectorRemap.find(LocalID - NUM_PREDEF_SELECTOR_IDS);
7897   assert(I != M.SelectorRemap.end()
7898          && "Invalid index into selector index remap");
7899 
7900   return LocalID + I->second;
7901 }
7902 
7903 DeclarationName
7904 ASTReader::ReadDeclarationName(ModuleFile &F,
7905                                const RecordData &Record, unsigned &Idx) {
7906   DeclarationName::NameKind Kind = (DeclarationName::NameKind)Record[Idx++];
7907   switch (Kind) {
7908   case DeclarationName::Identifier:
7909     return DeclarationName(GetIdentifierInfo(F, Record, Idx));
7910 
7911   case DeclarationName::ObjCZeroArgSelector:
7912   case DeclarationName::ObjCOneArgSelector:
7913   case DeclarationName::ObjCMultiArgSelector:
7914     return DeclarationName(ReadSelector(F, Record, Idx));
7915 
7916   case DeclarationName::CXXConstructorName:
7917     return Context.DeclarationNames.getCXXConstructorName(
7918                           Context.getCanonicalType(readType(F, Record, Idx)));
7919 
7920   case DeclarationName::CXXDestructorName:
7921     return Context.DeclarationNames.getCXXDestructorName(
7922                           Context.getCanonicalType(readType(F, Record, Idx)));
7923 
7924   case DeclarationName::CXXConversionFunctionName:
7925     return Context.DeclarationNames.getCXXConversionFunctionName(
7926                           Context.getCanonicalType(readType(F, Record, Idx)));
7927 
7928   case DeclarationName::CXXOperatorName:
7929     return Context.DeclarationNames.getCXXOperatorName(
7930                                        (OverloadedOperatorKind)Record[Idx++]);
7931 
7932   case DeclarationName::CXXLiteralOperatorName:
7933     return Context.DeclarationNames.getCXXLiteralOperatorName(
7934                                        GetIdentifierInfo(F, Record, Idx));
7935 
7936   case DeclarationName::CXXUsingDirective:
7937     return DeclarationName::getUsingDirectiveName();
7938   }
7939 
7940   llvm_unreachable("Invalid NameKind!");
7941 }
7942 
7943 void ASTReader::ReadDeclarationNameLoc(ModuleFile &F,
7944                                        DeclarationNameLoc &DNLoc,
7945                                        DeclarationName Name,
7946                                       const RecordData &Record, unsigned &Idx) {
7947   switch (Name.getNameKind()) {
7948   case DeclarationName::CXXConstructorName:
7949   case DeclarationName::CXXDestructorName:
7950   case DeclarationName::CXXConversionFunctionName:
7951     DNLoc.NamedType.TInfo = GetTypeSourceInfo(F, Record, Idx);
7952     break;
7953 
7954   case DeclarationName::CXXOperatorName:
7955     DNLoc.CXXOperatorName.BeginOpNameLoc
7956         = ReadSourceLocation(F, Record, Idx).getRawEncoding();
7957     DNLoc.CXXOperatorName.EndOpNameLoc
7958         = ReadSourceLocation(F, Record, Idx).getRawEncoding();
7959     break;
7960 
7961   case DeclarationName::CXXLiteralOperatorName:
7962     DNLoc.CXXLiteralOperatorName.OpNameLoc
7963         = ReadSourceLocation(F, Record, Idx).getRawEncoding();
7964     break;
7965 
7966   case DeclarationName::Identifier:
7967   case DeclarationName::ObjCZeroArgSelector:
7968   case DeclarationName::ObjCOneArgSelector:
7969   case DeclarationName::ObjCMultiArgSelector:
7970   case DeclarationName::CXXUsingDirective:
7971     break;
7972   }
7973 }
7974 
7975 void ASTReader::ReadDeclarationNameInfo(ModuleFile &F,
7976                                         DeclarationNameInfo &NameInfo,
7977                                       const RecordData &Record, unsigned &Idx) {
7978   NameInfo.setName(ReadDeclarationName(F, Record, Idx));
7979   NameInfo.setLoc(ReadSourceLocation(F, Record, Idx));
7980   DeclarationNameLoc DNLoc;
7981   ReadDeclarationNameLoc(F, DNLoc, NameInfo.getName(), Record, Idx);
7982   NameInfo.setInfo(DNLoc);
7983 }
7984 
7985 void ASTReader::ReadQualifierInfo(ModuleFile &F, QualifierInfo &Info,
7986                                   const RecordData &Record, unsigned &Idx) {
7987   Info.QualifierLoc = ReadNestedNameSpecifierLoc(F, Record, Idx);
7988   unsigned NumTPLists = Record[Idx++];
7989   Info.NumTemplParamLists = NumTPLists;
7990   if (NumTPLists) {
7991     Info.TemplParamLists = new (Context) TemplateParameterList*[NumTPLists];
7992     for (unsigned i = 0; i != NumTPLists; ++i)
7993       Info.TemplParamLists[i] = ReadTemplateParameterList(F, Record, Idx);
7994   }
7995 }
7996 
7997 TemplateName
7998 ASTReader::ReadTemplateName(ModuleFile &F, const RecordData &Record,
7999                             unsigned &Idx) {
8000   TemplateName::NameKind Kind = (TemplateName::NameKind)Record[Idx++];
8001   switch (Kind) {
8002   case TemplateName::Template:
8003       return TemplateName(ReadDeclAs<TemplateDecl>(F, Record, Idx));
8004 
8005   case TemplateName::OverloadedTemplate: {
8006     unsigned size = Record[Idx++];
8007     UnresolvedSet<8> Decls;
8008     while (size--)
8009       Decls.addDecl(ReadDeclAs<NamedDecl>(F, Record, Idx));
8010 
8011     return Context.getOverloadedTemplateName(Decls.begin(), Decls.end());
8012   }
8013 
8014   case TemplateName::QualifiedTemplate: {
8015     NestedNameSpecifier *NNS = ReadNestedNameSpecifier(F, Record, Idx);
8016     bool hasTemplKeyword = Record[Idx++];
8017     TemplateDecl *Template = ReadDeclAs<TemplateDecl>(F, Record, Idx);
8018     return Context.getQualifiedTemplateName(NNS, hasTemplKeyword, Template);
8019   }
8020 
8021   case TemplateName::DependentTemplate: {
8022     NestedNameSpecifier *NNS = ReadNestedNameSpecifier(F, Record, Idx);
8023     if (Record[Idx++])  // isIdentifier
8024       return Context.getDependentTemplateName(NNS,
8025                                                GetIdentifierInfo(F, Record,
8026                                                                  Idx));
8027     return Context.getDependentTemplateName(NNS,
8028                                          (OverloadedOperatorKind)Record[Idx++]);
8029   }
8030 
8031   case TemplateName::SubstTemplateTemplateParm: {
8032     TemplateTemplateParmDecl *param
8033       = ReadDeclAs<TemplateTemplateParmDecl>(F, Record, Idx);
8034     if (!param) return TemplateName();
8035     TemplateName replacement = ReadTemplateName(F, Record, Idx);
8036     return Context.getSubstTemplateTemplateParm(param, replacement);
8037   }
8038 
8039   case TemplateName::SubstTemplateTemplateParmPack: {
8040     TemplateTemplateParmDecl *Param
8041       = ReadDeclAs<TemplateTemplateParmDecl>(F, Record, Idx);
8042     if (!Param)
8043       return TemplateName();
8044 
8045     TemplateArgument ArgPack = ReadTemplateArgument(F, Record, Idx);
8046     if (ArgPack.getKind() != TemplateArgument::Pack)
8047       return TemplateName();
8048 
8049     return Context.getSubstTemplateTemplateParmPack(Param, ArgPack);
8050   }
8051   }
8052 
8053   llvm_unreachable("Unhandled template name kind!");
8054 }
8055 
8056 TemplateArgument ASTReader::ReadTemplateArgument(ModuleFile &F,
8057                                                  const RecordData &Record,
8058                                                  unsigned &Idx,
8059                                                  bool Canonicalize) {
8060   if (Canonicalize) {
8061     // The caller wants a canonical template argument. Sometimes the AST only
8062     // wants template arguments in canonical form (particularly as the template
8063     // argument lists of template specializations) so ensure we preserve that
8064     // canonical form across serialization.
8065     TemplateArgument Arg = ReadTemplateArgument(F, Record, Idx, false);
8066     return Context.getCanonicalTemplateArgument(Arg);
8067   }
8068 
8069   TemplateArgument::ArgKind Kind = (TemplateArgument::ArgKind)Record[Idx++];
8070   switch (Kind) {
8071   case TemplateArgument::Null:
8072     return TemplateArgument();
8073   case TemplateArgument::Type:
8074     return TemplateArgument(readType(F, Record, Idx));
8075   case TemplateArgument::Declaration: {
8076     ValueDecl *D = ReadDeclAs<ValueDecl>(F, Record, Idx);
8077     return TemplateArgument(D, readType(F, Record, Idx));
8078   }
8079   case TemplateArgument::NullPtr:
8080     return TemplateArgument(readType(F, Record, Idx), /*isNullPtr*/true);
8081   case TemplateArgument::Integral: {
8082     llvm::APSInt Value = ReadAPSInt(Record, Idx);
8083     QualType T = readType(F, Record, Idx);
8084     return TemplateArgument(Context, Value, T);
8085   }
8086   case TemplateArgument::Template:
8087     return TemplateArgument(ReadTemplateName(F, Record, Idx));
8088   case TemplateArgument::TemplateExpansion: {
8089     TemplateName Name = ReadTemplateName(F, Record, Idx);
8090     Optional<unsigned> NumTemplateExpansions;
8091     if (unsigned NumExpansions = Record[Idx++])
8092       NumTemplateExpansions = NumExpansions - 1;
8093     return TemplateArgument(Name, NumTemplateExpansions);
8094   }
8095   case TemplateArgument::Expression:
8096     return TemplateArgument(ReadExpr(F));
8097   case TemplateArgument::Pack: {
8098     unsigned NumArgs = Record[Idx++];
8099     TemplateArgument *Args = new (Context) TemplateArgument[NumArgs];
8100     for (unsigned I = 0; I != NumArgs; ++I)
8101       Args[I] = ReadTemplateArgument(F, Record, Idx);
8102     return TemplateArgument(llvm::makeArrayRef(Args, NumArgs));
8103   }
8104   }
8105 
8106   llvm_unreachable("Unhandled template argument kind!");
8107 }
8108 
8109 TemplateParameterList *
8110 ASTReader::ReadTemplateParameterList(ModuleFile &F,
8111                                      const RecordData &Record, unsigned &Idx) {
8112   SourceLocation TemplateLoc = ReadSourceLocation(F, Record, Idx);
8113   SourceLocation LAngleLoc = ReadSourceLocation(F, Record, Idx);
8114   SourceLocation RAngleLoc = ReadSourceLocation(F, Record, Idx);
8115 
8116   unsigned NumParams = Record[Idx++];
8117   SmallVector<NamedDecl *, 16> Params;
8118   Params.reserve(NumParams);
8119   while (NumParams--)
8120     Params.push_back(ReadDeclAs<NamedDecl>(F, Record, Idx));
8121 
8122   // TODO: Concepts
8123   TemplateParameterList* TemplateParams =
8124     TemplateParameterList::Create(Context, TemplateLoc, LAngleLoc,
8125                                   Params, RAngleLoc, nullptr);
8126   return TemplateParams;
8127 }
8128 
8129 void
8130 ASTReader::
8131 ReadTemplateArgumentList(SmallVectorImpl<TemplateArgument> &TemplArgs,
8132                          ModuleFile &F, const RecordData &Record,
8133                          unsigned &Idx, bool Canonicalize) {
8134   unsigned NumTemplateArgs = Record[Idx++];
8135   TemplArgs.reserve(NumTemplateArgs);
8136   while (NumTemplateArgs--)
8137     TemplArgs.push_back(ReadTemplateArgument(F, Record, Idx, Canonicalize));
8138 }
8139 
8140 /// \brief Read a UnresolvedSet structure.
8141 void ASTReader::ReadUnresolvedSet(ModuleFile &F, LazyASTUnresolvedSet &Set,
8142                                   const RecordData &Record, unsigned &Idx) {
8143   unsigned NumDecls = Record[Idx++];
8144   Set.reserve(Context, NumDecls);
8145   while (NumDecls--) {
8146     DeclID ID = ReadDeclID(F, Record, Idx);
8147     AccessSpecifier AS = (AccessSpecifier)Record[Idx++];
8148     Set.addLazyDecl(Context, ID, AS);
8149   }
8150 }
8151 
8152 CXXBaseSpecifier
8153 ASTReader::ReadCXXBaseSpecifier(ModuleFile &F,
8154                                 const RecordData &Record, unsigned &Idx) {
8155   bool isVirtual = static_cast<bool>(Record[Idx++]);
8156   bool isBaseOfClass = static_cast<bool>(Record[Idx++]);
8157   AccessSpecifier AS = static_cast<AccessSpecifier>(Record[Idx++]);
8158   bool inheritConstructors = static_cast<bool>(Record[Idx++]);
8159   TypeSourceInfo *TInfo = GetTypeSourceInfo(F, Record, Idx);
8160   SourceRange Range = ReadSourceRange(F, Record, Idx);
8161   SourceLocation EllipsisLoc = ReadSourceLocation(F, Record, Idx);
8162   CXXBaseSpecifier Result(Range, isVirtual, isBaseOfClass, AS, TInfo,
8163                           EllipsisLoc);
8164   Result.setInheritConstructors(inheritConstructors);
8165   return Result;
8166 }
8167 
8168 CXXCtorInitializer **
8169 ASTReader::ReadCXXCtorInitializers(ModuleFile &F, const RecordData &Record,
8170                                    unsigned &Idx) {
8171   unsigned NumInitializers = Record[Idx++];
8172   assert(NumInitializers && "wrote ctor initializers but have no inits");
8173   auto **CtorInitializers = new (Context) CXXCtorInitializer*[NumInitializers];
8174   for (unsigned i = 0; i != NumInitializers; ++i) {
8175     TypeSourceInfo *TInfo = nullptr;
8176     bool IsBaseVirtual = false;
8177     FieldDecl *Member = nullptr;
8178     IndirectFieldDecl *IndirectMember = nullptr;
8179 
8180     CtorInitializerType Type = (CtorInitializerType)Record[Idx++];
8181     switch (Type) {
8182     case CTOR_INITIALIZER_BASE:
8183       TInfo = GetTypeSourceInfo(F, Record, Idx);
8184       IsBaseVirtual = Record[Idx++];
8185       break;
8186 
8187     case CTOR_INITIALIZER_DELEGATING:
8188       TInfo = GetTypeSourceInfo(F, Record, Idx);
8189       break;
8190 
8191      case CTOR_INITIALIZER_MEMBER:
8192       Member = ReadDeclAs<FieldDecl>(F, Record, Idx);
8193       break;
8194 
8195      case CTOR_INITIALIZER_INDIRECT_MEMBER:
8196       IndirectMember = ReadDeclAs<IndirectFieldDecl>(F, Record, Idx);
8197       break;
8198     }
8199 
8200     SourceLocation MemberOrEllipsisLoc = ReadSourceLocation(F, Record, Idx);
8201     Expr *Init = ReadExpr(F);
8202     SourceLocation LParenLoc = ReadSourceLocation(F, Record, Idx);
8203     SourceLocation RParenLoc = ReadSourceLocation(F, Record, Idx);
8204 
8205     CXXCtorInitializer *BOMInit;
8206     if (Type == CTOR_INITIALIZER_BASE)
8207       BOMInit = new (Context)
8208           CXXCtorInitializer(Context, TInfo, IsBaseVirtual, LParenLoc, Init,
8209                              RParenLoc, MemberOrEllipsisLoc);
8210     else if (Type == CTOR_INITIALIZER_DELEGATING)
8211       BOMInit = new (Context)
8212           CXXCtorInitializer(Context, TInfo, LParenLoc, Init, RParenLoc);
8213     else if (Member)
8214       BOMInit = new (Context)
8215           CXXCtorInitializer(Context, Member, MemberOrEllipsisLoc, LParenLoc,
8216                              Init, RParenLoc);
8217     else
8218       BOMInit = new (Context)
8219           CXXCtorInitializer(Context, IndirectMember, MemberOrEllipsisLoc,
8220                              LParenLoc, Init, RParenLoc);
8221 
8222     if (/*IsWritten*/Record[Idx++]) {
8223       unsigned SourceOrder = Record[Idx++];
8224       BOMInit->setSourceOrder(SourceOrder);
8225     }
8226 
8227     CtorInitializers[i] = BOMInit;
8228   }
8229 
8230   return CtorInitializers;
8231 }
8232 
8233 NestedNameSpecifier *
8234 ASTReader::ReadNestedNameSpecifier(ModuleFile &F,
8235                                    const RecordData &Record, unsigned &Idx) {
8236   unsigned N = Record[Idx++];
8237   NestedNameSpecifier *NNS = nullptr, *Prev = nullptr;
8238   for (unsigned I = 0; I != N; ++I) {
8239     NestedNameSpecifier::SpecifierKind Kind
8240       = (NestedNameSpecifier::SpecifierKind)Record[Idx++];
8241     switch (Kind) {
8242     case NestedNameSpecifier::Identifier: {
8243       IdentifierInfo *II = GetIdentifierInfo(F, Record, Idx);
8244       NNS = NestedNameSpecifier::Create(Context, Prev, II);
8245       break;
8246     }
8247 
8248     case NestedNameSpecifier::Namespace: {
8249       NamespaceDecl *NS = ReadDeclAs<NamespaceDecl>(F, Record, Idx);
8250       NNS = NestedNameSpecifier::Create(Context, Prev, NS);
8251       break;
8252     }
8253 
8254     case NestedNameSpecifier::NamespaceAlias: {
8255       NamespaceAliasDecl *Alias =ReadDeclAs<NamespaceAliasDecl>(F, Record, Idx);
8256       NNS = NestedNameSpecifier::Create(Context, Prev, Alias);
8257       break;
8258     }
8259 
8260     case NestedNameSpecifier::TypeSpec:
8261     case NestedNameSpecifier::TypeSpecWithTemplate: {
8262       const Type *T = readType(F, Record, Idx).getTypePtrOrNull();
8263       if (!T)
8264         return nullptr;
8265 
8266       bool Template = Record[Idx++];
8267       NNS = NestedNameSpecifier::Create(Context, Prev, Template, T);
8268       break;
8269     }
8270 
8271     case NestedNameSpecifier::Global: {
8272       NNS = NestedNameSpecifier::GlobalSpecifier(Context);
8273       // No associated value, and there can't be a prefix.
8274       break;
8275     }
8276 
8277     case NestedNameSpecifier::Super: {
8278       CXXRecordDecl *RD = ReadDeclAs<CXXRecordDecl>(F, Record, Idx);
8279       NNS = NestedNameSpecifier::SuperSpecifier(Context, RD);
8280       break;
8281     }
8282     }
8283     Prev = NNS;
8284   }
8285   return NNS;
8286 }
8287 
8288 NestedNameSpecifierLoc
8289 ASTReader::ReadNestedNameSpecifierLoc(ModuleFile &F, const RecordData &Record,
8290                                       unsigned &Idx) {
8291   unsigned N = Record[Idx++];
8292   NestedNameSpecifierLocBuilder Builder;
8293   for (unsigned I = 0; I != N; ++I) {
8294     NestedNameSpecifier::SpecifierKind Kind
8295       = (NestedNameSpecifier::SpecifierKind)Record[Idx++];
8296     switch (Kind) {
8297     case NestedNameSpecifier::Identifier: {
8298       IdentifierInfo *II = GetIdentifierInfo(F, Record, Idx);
8299       SourceRange Range = ReadSourceRange(F, Record, Idx);
8300       Builder.Extend(Context, II, Range.getBegin(), Range.getEnd());
8301       break;
8302     }
8303 
8304     case NestedNameSpecifier::Namespace: {
8305       NamespaceDecl *NS = ReadDeclAs<NamespaceDecl>(F, Record, Idx);
8306       SourceRange Range = ReadSourceRange(F, Record, Idx);
8307       Builder.Extend(Context, NS, Range.getBegin(), Range.getEnd());
8308       break;
8309     }
8310 
8311     case NestedNameSpecifier::NamespaceAlias: {
8312       NamespaceAliasDecl *Alias =ReadDeclAs<NamespaceAliasDecl>(F, Record, Idx);
8313       SourceRange Range = ReadSourceRange(F, Record, Idx);
8314       Builder.Extend(Context, Alias, Range.getBegin(), Range.getEnd());
8315       break;
8316     }
8317 
8318     case NestedNameSpecifier::TypeSpec:
8319     case NestedNameSpecifier::TypeSpecWithTemplate: {
8320       bool Template = Record[Idx++];
8321       TypeSourceInfo *T = GetTypeSourceInfo(F, Record, Idx);
8322       if (!T)
8323         return NestedNameSpecifierLoc();
8324       SourceLocation ColonColonLoc = ReadSourceLocation(F, Record, Idx);
8325 
8326       // FIXME: 'template' keyword location not saved anywhere, so we fake it.
8327       Builder.Extend(Context,
8328                      Template? T->getTypeLoc().getBeginLoc() : SourceLocation(),
8329                      T->getTypeLoc(), ColonColonLoc);
8330       break;
8331     }
8332 
8333     case NestedNameSpecifier::Global: {
8334       SourceLocation ColonColonLoc = ReadSourceLocation(F, Record, Idx);
8335       Builder.MakeGlobal(Context, ColonColonLoc);
8336       break;
8337     }
8338 
8339     case NestedNameSpecifier::Super: {
8340       CXXRecordDecl *RD = ReadDeclAs<CXXRecordDecl>(F, Record, Idx);
8341       SourceRange Range = ReadSourceRange(F, Record, Idx);
8342       Builder.MakeSuper(Context, RD, Range.getBegin(), Range.getEnd());
8343       break;
8344     }
8345     }
8346   }
8347 
8348   return Builder.getWithLocInContext(Context);
8349 }
8350 
8351 SourceRange
8352 ASTReader::ReadSourceRange(ModuleFile &F, const RecordData &Record,
8353                            unsigned &Idx) {
8354   SourceLocation beg = ReadSourceLocation(F, Record, Idx);
8355   SourceLocation end = ReadSourceLocation(F, Record, Idx);
8356   return SourceRange(beg, end);
8357 }
8358 
8359 /// \brief Read an integral value
8360 llvm::APInt ASTReader::ReadAPInt(const RecordData &Record, unsigned &Idx) {
8361   unsigned BitWidth = Record[Idx++];
8362   unsigned NumWords = llvm::APInt::getNumWords(BitWidth);
8363   llvm::APInt Result(BitWidth, NumWords, &Record[Idx]);
8364   Idx += NumWords;
8365   return Result;
8366 }
8367 
8368 /// \brief Read a signed integral value
8369 llvm::APSInt ASTReader::ReadAPSInt(const RecordData &Record, unsigned &Idx) {
8370   bool isUnsigned = Record[Idx++];
8371   return llvm::APSInt(ReadAPInt(Record, Idx), isUnsigned);
8372 }
8373 
8374 /// \brief Read a floating-point value
8375 llvm::APFloat ASTReader::ReadAPFloat(const RecordData &Record,
8376                                      const llvm::fltSemantics &Sem,
8377                                      unsigned &Idx) {
8378   return llvm::APFloat(Sem, ReadAPInt(Record, Idx));
8379 }
8380 
8381 // \brief Read a string
8382 std::string ASTReader::ReadString(const RecordData &Record, unsigned &Idx) {
8383   unsigned Len = Record[Idx++];
8384   std::string Result(Record.data() + Idx, Record.data() + Idx + Len);
8385   Idx += Len;
8386   return Result;
8387 }
8388 
8389 std::string ASTReader::ReadPath(ModuleFile &F, const RecordData &Record,
8390                                 unsigned &Idx) {
8391   std::string Filename = ReadString(Record, Idx);
8392   ResolveImportedPath(F, Filename);
8393   return Filename;
8394 }
8395 
8396 VersionTuple ASTReader::ReadVersionTuple(const RecordData &Record,
8397                                          unsigned &Idx) {
8398   unsigned Major = Record[Idx++];
8399   unsigned Minor = Record[Idx++];
8400   unsigned Subminor = Record[Idx++];
8401   if (Minor == 0)
8402     return VersionTuple(Major);
8403   if (Subminor == 0)
8404     return VersionTuple(Major, Minor - 1);
8405   return VersionTuple(Major, Minor - 1, Subminor - 1);
8406 }
8407 
8408 CXXTemporary *ASTReader::ReadCXXTemporary(ModuleFile &F,
8409                                           const RecordData &Record,
8410                                           unsigned &Idx) {
8411   CXXDestructorDecl *Decl = ReadDeclAs<CXXDestructorDecl>(F, Record, Idx);
8412   return CXXTemporary::Create(Context, Decl);
8413 }
8414 
8415 DiagnosticBuilder ASTReader::Diag(unsigned DiagID) {
8416   return Diag(CurrentImportLoc, DiagID);
8417 }
8418 
8419 DiagnosticBuilder ASTReader::Diag(SourceLocation Loc, unsigned DiagID) {
8420   return Diags.Report(Loc, DiagID);
8421 }
8422 
8423 /// \brief Retrieve the identifier table associated with the
8424 /// preprocessor.
8425 IdentifierTable &ASTReader::getIdentifierTable() {
8426   return PP.getIdentifierTable();
8427 }
8428 
8429 /// \brief Record that the given ID maps to the given switch-case
8430 /// statement.
8431 void ASTReader::RecordSwitchCaseID(SwitchCase *SC, unsigned ID) {
8432   assert((*CurrSwitchCaseStmts)[ID] == nullptr &&
8433          "Already have a SwitchCase with this ID");
8434   (*CurrSwitchCaseStmts)[ID] = SC;
8435 }
8436 
8437 /// \brief Retrieve the switch-case statement with the given ID.
8438 SwitchCase *ASTReader::getSwitchCaseWithID(unsigned ID) {
8439   assert((*CurrSwitchCaseStmts)[ID] != nullptr && "No SwitchCase with this ID");
8440   return (*CurrSwitchCaseStmts)[ID];
8441 }
8442 
8443 void ASTReader::ClearSwitchCaseIDs() {
8444   CurrSwitchCaseStmts->clear();
8445 }
8446 
8447 void ASTReader::ReadComments() {
8448   std::vector<RawComment *> Comments;
8449   for (SmallVectorImpl<std::pair<BitstreamCursor,
8450                                  serialization::ModuleFile *> >::iterator
8451        I = CommentsCursors.begin(),
8452        E = CommentsCursors.end();
8453        I != E; ++I) {
8454     Comments.clear();
8455     BitstreamCursor &Cursor = I->first;
8456     serialization::ModuleFile &F = *I->second;
8457     SavedStreamPosition SavedPosition(Cursor);
8458 
8459     RecordData Record;
8460     while (true) {
8461       llvm::BitstreamEntry Entry =
8462         Cursor.advanceSkippingSubblocks(BitstreamCursor::AF_DontPopBlockAtEnd);
8463 
8464       switch (Entry.Kind) {
8465       case llvm::BitstreamEntry::SubBlock: // Handled for us already.
8466       case llvm::BitstreamEntry::Error:
8467         Error("malformed block record in AST file");
8468         return;
8469       case llvm::BitstreamEntry::EndBlock:
8470         goto NextCursor;
8471       case llvm::BitstreamEntry::Record:
8472         // The interesting case.
8473         break;
8474       }
8475 
8476       // Read a record.
8477       Record.clear();
8478       switch ((CommentRecordTypes)Cursor.readRecord(Entry.ID, Record)) {
8479       case COMMENTS_RAW_COMMENT: {
8480         unsigned Idx = 0;
8481         SourceRange SR = ReadSourceRange(F, Record, Idx);
8482         RawComment::CommentKind Kind =
8483             (RawComment::CommentKind) Record[Idx++];
8484         bool IsTrailingComment = Record[Idx++];
8485         bool IsAlmostTrailingComment = Record[Idx++];
8486         Comments.push_back(new (Context) RawComment(
8487             SR, Kind, IsTrailingComment, IsAlmostTrailingComment,
8488             Context.getLangOpts().CommentOpts.ParseAllComments));
8489         break;
8490       }
8491       }
8492     }
8493   NextCursor:
8494     // De-serialized SourceLocations get negative FileIDs for other modules,
8495     // potentially invalidating the original order. Sort it again.
8496     std::sort(Comments.begin(), Comments.end(),
8497               BeforeThanCompare<RawComment>(SourceMgr));
8498     Context.Comments.addDeserializedComments(Comments);
8499   }
8500 }
8501 
8502 std::string ASTReader::getOwningModuleNameForDiagnostic(const Decl *D) {
8503   // If we know the owning module, use it.
8504   if (Module *M = D->getImportedOwningModule())
8505     return M->getFullModuleName();
8506 
8507   // Otherwise, use the name of the top-level module the decl is within.
8508   if (ModuleFile *M = getOwningModuleFile(D))
8509     return M->ModuleName;
8510 
8511   // Not from a module.
8512   return "";
8513 }
8514 
8515 void ASTReader::finishPendingActions() {
8516   while (!PendingIdentifierInfos.empty() ||
8517          !PendingIncompleteDeclChains.empty() || !PendingDeclChains.empty() ||
8518          !PendingMacroIDs.empty() || !PendingDeclContextInfos.empty() ||
8519          !PendingUpdateRecords.empty()) {
8520     // If any identifiers with corresponding top-level declarations have
8521     // been loaded, load those declarations now.
8522     typedef llvm::DenseMap<IdentifierInfo *, SmallVector<Decl *, 2> >
8523       TopLevelDeclsMap;
8524     TopLevelDeclsMap TopLevelDecls;
8525 
8526     while (!PendingIdentifierInfos.empty()) {
8527       IdentifierInfo *II = PendingIdentifierInfos.back().first;
8528       SmallVector<uint32_t, 4> DeclIDs =
8529           std::move(PendingIdentifierInfos.back().second);
8530       PendingIdentifierInfos.pop_back();
8531 
8532       SetGloballyVisibleDecls(II, DeclIDs, &TopLevelDecls[II]);
8533     }
8534 
8535     // For each decl chain that we wanted to complete while deserializing, mark
8536     // it as "still needs to be completed".
8537     for (unsigned I = 0; I != PendingIncompleteDeclChains.size(); ++I) {
8538       markIncompleteDeclChain(PendingIncompleteDeclChains[I]);
8539     }
8540     PendingIncompleteDeclChains.clear();
8541 
8542     // Load pending declaration chains.
8543     for (unsigned I = 0; I != PendingDeclChains.size(); ++I)
8544       loadPendingDeclChain(PendingDeclChains[I].first, PendingDeclChains[I].second);
8545     PendingDeclChains.clear();
8546 
8547     // Make the most recent of the top-level declarations visible.
8548     for (TopLevelDeclsMap::iterator TLD = TopLevelDecls.begin(),
8549            TLDEnd = TopLevelDecls.end(); TLD != TLDEnd; ++TLD) {
8550       IdentifierInfo *II = TLD->first;
8551       for (unsigned I = 0, N = TLD->second.size(); I != N; ++I) {
8552         pushExternalDeclIntoScope(cast<NamedDecl>(TLD->second[I]), II);
8553       }
8554     }
8555 
8556     // Load any pending macro definitions.
8557     for (unsigned I = 0; I != PendingMacroIDs.size(); ++I) {
8558       IdentifierInfo *II = PendingMacroIDs.begin()[I].first;
8559       SmallVector<PendingMacroInfo, 2> GlobalIDs;
8560       GlobalIDs.swap(PendingMacroIDs.begin()[I].second);
8561       // Initialize the macro history from chained-PCHs ahead of module imports.
8562       for (unsigned IDIdx = 0, NumIDs = GlobalIDs.size(); IDIdx != NumIDs;
8563            ++IDIdx) {
8564         const PendingMacroInfo &Info = GlobalIDs[IDIdx];
8565         if (!Info.M->isModule())
8566           resolvePendingMacro(II, Info);
8567       }
8568       // Handle module imports.
8569       for (unsigned IDIdx = 0, NumIDs = GlobalIDs.size(); IDIdx != NumIDs;
8570            ++IDIdx) {
8571         const PendingMacroInfo &Info = GlobalIDs[IDIdx];
8572         if (Info.M->isModule())
8573           resolvePendingMacro(II, Info);
8574       }
8575     }
8576     PendingMacroIDs.clear();
8577 
8578     // Wire up the DeclContexts for Decls that we delayed setting until
8579     // recursive loading is completed.
8580     while (!PendingDeclContextInfos.empty()) {
8581       PendingDeclContextInfo Info = PendingDeclContextInfos.front();
8582       PendingDeclContextInfos.pop_front();
8583       DeclContext *SemaDC = cast<DeclContext>(GetDecl(Info.SemaDC));
8584       DeclContext *LexicalDC = cast<DeclContext>(GetDecl(Info.LexicalDC));
8585       Info.D->setDeclContextsImpl(SemaDC, LexicalDC, getContext());
8586     }
8587 
8588     // Perform any pending declaration updates.
8589     while (!PendingUpdateRecords.empty()) {
8590       auto Update = PendingUpdateRecords.pop_back_val();
8591       ReadingKindTracker ReadingKind(Read_Decl, *this);
8592       loadDeclUpdateRecords(Update.first, Update.second);
8593     }
8594   }
8595 
8596   // At this point, all update records for loaded decls are in place, so any
8597   // fake class definitions should have become real.
8598   assert(PendingFakeDefinitionData.empty() &&
8599          "faked up a class definition but never saw the real one");
8600 
8601   // If we deserialized any C++ or Objective-C class definitions, any
8602   // Objective-C protocol definitions, or any redeclarable templates, make sure
8603   // that all redeclarations point to the definitions. Note that this can only
8604   // happen now, after the redeclaration chains have been fully wired.
8605   for (Decl *D : PendingDefinitions) {
8606     if (TagDecl *TD = dyn_cast<TagDecl>(D)) {
8607       if (const TagType *TagT = dyn_cast<TagType>(TD->getTypeForDecl())) {
8608         // Make sure that the TagType points at the definition.
8609         const_cast<TagType*>(TagT)->decl = TD;
8610       }
8611 
8612       if (auto RD = dyn_cast<CXXRecordDecl>(D)) {
8613         for (auto *R = getMostRecentExistingDecl(RD); R;
8614              R = R->getPreviousDecl()) {
8615           assert((R == D) ==
8616                      cast<CXXRecordDecl>(R)->isThisDeclarationADefinition() &&
8617                  "declaration thinks it's the definition but it isn't");
8618           cast<CXXRecordDecl>(R)->DefinitionData = RD->DefinitionData;
8619         }
8620       }
8621 
8622       continue;
8623     }
8624 
8625     if (auto ID = dyn_cast<ObjCInterfaceDecl>(D)) {
8626       // Make sure that the ObjCInterfaceType points at the definition.
8627       const_cast<ObjCInterfaceType *>(cast<ObjCInterfaceType>(ID->TypeForDecl))
8628         ->Decl = ID;
8629 
8630       for (auto *R = getMostRecentExistingDecl(ID); R; R = R->getPreviousDecl())
8631         cast<ObjCInterfaceDecl>(R)->Data = ID->Data;
8632 
8633       continue;
8634     }
8635 
8636     if (auto PD = dyn_cast<ObjCProtocolDecl>(D)) {
8637       for (auto *R = getMostRecentExistingDecl(PD); R; R = R->getPreviousDecl())
8638         cast<ObjCProtocolDecl>(R)->Data = PD->Data;
8639 
8640       continue;
8641     }
8642 
8643     auto RTD = cast<RedeclarableTemplateDecl>(D)->getCanonicalDecl();
8644     for (auto *R = getMostRecentExistingDecl(RTD); R; R = R->getPreviousDecl())
8645       cast<RedeclarableTemplateDecl>(R)->Common = RTD->Common;
8646   }
8647   PendingDefinitions.clear();
8648 
8649   // Load the bodies of any functions or methods we've encountered. We do
8650   // this now (delayed) so that we can be sure that the declaration chains
8651   // have been fully wired up (hasBody relies on this).
8652   // FIXME: We shouldn't require complete redeclaration chains here.
8653   for (PendingBodiesMap::iterator PB = PendingBodies.begin(),
8654                                PBEnd = PendingBodies.end();
8655        PB != PBEnd; ++PB) {
8656     if (FunctionDecl *FD = dyn_cast<FunctionDecl>(PB->first)) {
8657       // FIXME: Check for =delete/=default?
8658       // FIXME: Complain about ODR violations here?
8659       const FunctionDecl *Defn = nullptr;
8660       if (!getContext().getLangOpts().Modules || !FD->hasBody(Defn))
8661         FD->setLazyBody(PB->second);
8662       else
8663         mergeDefinitionVisibility(const_cast<FunctionDecl*>(Defn), FD);
8664       continue;
8665     }
8666 
8667     ObjCMethodDecl *MD = cast<ObjCMethodDecl>(PB->first);
8668     if (!getContext().getLangOpts().Modules || !MD->hasBody())
8669       MD->setLazyBody(PB->second);
8670   }
8671   PendingBodies.clear();
8672 
8673   // Do some cleanup.
8674   for (auto *ND : PendingMergedDefinitionsToDeduplicate)
8675     getContext().deduplicateMergedDefinitonsFor(ND);
8676   PendingMergedDefinitionsToDeduplicate.clear();
8677 }
8678 
8679 void ASTReader::diagnoseOdrViolations() {
8680   if (PendingOdrMergeFailures.empty() && PendingOdrMergeChecks.empty())
8681     return;
8682 
8683   // Trigger the import of the full definition of each class that had any
8684   // odr-merging problems, so we can produce better diagnostics for them.
8685   // These updates may in turn find and diagnose some ODR failures, so take
8686   // ownership of the set first.
8687   auto OdrMergeFailures = std::move(PendingOdrMergeFailures);
8688   PendingOdrMergeFailures.clear();
8689   for (auto &Merge : OdrMergeFailures) {
8690     Merge.first->buildLookup();
8691     Merge.first->decls_begin();
8692     Merge.first->bases_begin();
8693     Merge.first->vbases_begin();
8694     for (auto *RD : Merge.second) {
8695       RD->decls_begin();
8696       RD->bases_begin();
8697       RD->vbases_begin();
8698     }
8699   }
8700 
8701   // For each declaration from a merged context, check that the canonical
8702   // definition of that context also contains a declaration of the same
8703   // entity.
8704   //
8705   // Caution: this loop does things that might invalidate iterators into
8706   // PendingOdrMergeChecks. Don't turn this into a range-based for loop!
8707   while (!PendingOdrMergeChecks.empty()) {
8708     NamedDecl *D = PendingOdrMergeChecks.pop_back_val();
8709 
8710     // FIXME: Skip over implicit declarations for now. This matters for things
8711     // like implicitly-declared special member functions. This isn't entirely
8712     // correct; we can end up with multiple unmerged declarations of the same
8713     // implicit entity.
8714     if (D->isImplicit())
8715       continue;
8716 
8717     DeclContext *CanonDef = D->getDeclContext();
8718 
8719     bool Found = false;
8720     const Decl *DCanon = D->getCanonicalDecl();
8721 
8722     for (auto RI : D->redecls()) {
8723       if (RI->getLexicalDeclContext() == CanonDef) {
8724         Found = true;
8725         break;
8726       }
8727     }
8728     if (Found)
8729       continue;
8730 
8731     // Quick check failed, time to do the slow thing. Note, we can't just
8732     // look up the name of D in CanonDef here, because the member that is
8733     // in CanonDef might not be found by name lookup (it might have been
8734     // replaced by a more recent declaration in the lookup table), and we
8735     // can't necessarily find it in the redeclaration chain because it might
8736     // be merely mergeable, not redeclarable.
8737     llvm::SmallVector<const NamedDecl*, 4> Candidates;
8738     for (auto *CanonMember : CanonDef->decls()) {
8739       if (CanonMember->getCanonicalDecl() == DCanon) {
8740         // This can happen if the declaration is merely mergeable and not
8741         // actually redeclarable (we looked for redeclarations earlier).
8742         //
8743         // FIXME: We should be able to detect this more efficiently, without
8744         // pulling in all of the members of CanonDef.
8745         Found = true;
8746         break;
8747       }
8748       if (auto *ND = dyn_cast<NamedDecl>(CanonMember))
8749         if (ND->getDeclName() == D->getDeclName())
8750           Candidates.push_back(ND);
8751     }
8752 
8753     if (!Found) {
8754       // The AST doesn't like TagDecls becoming invalid after they've been
8755       // completed. We only really need to mark FieldDecls as invalid here.
8756       if (!isa<TagDecl>(D))
8757         D->setInvalidDecl();
8758 
8759       // Ensure we don't accidentally recursively enter deserialization while
8760       // we're producing our diagnostic.
8761       Deserializing RecursionGuard(this);
8762 
8763       std::string CanonDefModule =
8764           getOwningModuleNameForDiagnostic(cast<Decl>(CanonDef));
8765       Diag(D->getLocation(), diag::err_module_odr_violation_missing_decl)
8766         << D << getOwningModuleNameForDiagnostic(D)
8767         << CanonDef << CanonDefModule.empty() << CanonDefModule;
8768 
8769       if (Candidates.empty())
8770         Diag(cast<Decl>(CanonDef)->getLocation(),
8771              diag::note_module_odr_violation_no_possible_decls) << D;
8772       else {
8773         for (unsigned I = 0, N = Candidates.size(); I != N; ++I)
8774           Diag(Candidates[I]->getLocation(),
8775                diag::note_module_odr_violation_possible_decl)
8776             << Candidates[I];
8777       }
8778 
8779       DiagnosedOdrMergeFailures.insert(CanonDef);
8780     }
8781   }
8782 
8783   if (OdrMergeFailures.empty())
8784     return;
8785 
8786   // Ensure we don't accidentally recursively enter deserialization while
8787   // we're producing our diagnostics.
8788   Deserializing RecursionGuard(this);
8789 
8790   // Issue any pending ODR-failure diagnostics.
8791   for (auto &Merge : OdrMergeFailures) {
8792     // If we've already pointed out a specific problem with this class, don't
8793     // bother issuing a general "something's different" diagnostic.
8794     if (!DiagnosedOdrMergeFailures.insert(Merge.first).second)
8795       continue;
8796 
8797     bool Diagnosed = false;
8798     for (auto *RD : Merge.second) {
8799       // Multiple different declarations got merged together; tell the user
8800       // where they came from.
8801       if (Merge.first != RD) {
8802         // FIXME: Walk the definition, figure out what's different,
8803         // and diagnose that.
8804         if (!Diagnosed) {
8805           std::string Module = getOwningModuleNameForDiagnostic(Merge.first);
8806           Diag(Merge.first->getLocation(),
8807                diag::err_module_odr_violation_different_definitions)
8808             << Merge.first << Module.empty() << Module;
8809           Diagnosed = true;
8810         }
8811 
8812         Diag(RD->getLocation(),
8813              diag::note_module_odr_violation_different_definitions)
8814           << getOwningModuleNameForDiagnostic(RD);
8815       }
8816     }
8817 
8818     if (!Diagnosed) {
8819       // All definitions are updates to the same declaration. This happens if a
8820       // module instantiates the declaration of a class template specialization
8821       // and two or more other modules instantiate its definition.
8822       //
8823       // FIXME: Indicate which modules had instantiations of this definition.
8824       // FIXME: How can this even happen?
8825       Diag(Merge.first->getLocation(),
8826            diag::err_module_odr_violation_different_instantiations)
8827         << Merge.first;
8828     }
8829   }
8830 }
8831 
8832 void ASTReader::StartedDeserializing() {
8833   if (++NumCurrentElementsDeserializing == 1 && ReadTimer.get())
8834     ReadTimer->startTimer();
8835 }
8836 
8837 void ASTReader::FinishedDeserializing() {
8838   assert(NumCurrentElementsDeserializing &&
8839          "FinishedDeserializing not paired with StartedDeserializing");
8840   if (NumCurrentElementsDeserializing == 1) {
8841     // We decrease NumCurrentElementsDeserializing only after pending actions
8842     // are finished, to avoid recursively re-calling finishPendingActions().
8843     finishPendingActions();
8844   }
8845   --NumCurrentElementsDeserializing;
8846 
8847   if (NumCurrentElementsDeserializing == 0) {
8848     // Propagate exception specification updates along redeclaration chains.
8849     while (!PendingExceptionSpecUpdates.empty()) {
8850       auto Updates = std::move(PendingExceptionSpecUpdates);
8851       PendingExceptionSpecUpdates.clear();
8852       for (auto Update : Updates) {
8853         ProcessingUpdatesRAIIObj ProcessingUpdates(*this);
8854         auto *FPT = Update.second->getType()->castAs<FunctionProtoType>();
8855         auto ESI = FPT->getExtProtoInfo().ExceptionSpec;
8856         if (auto *Listener = Context.getASTMutationListener())
8857           Listener->ResolvedExceptionSpec(cast<FunctionDecl>(Update.second));
8858         for (auto *Redecl : Update.second->redecls())
8859           Context.adjustExceptionSpec(cast<FunctionDecl>(Redecl), ESI);
8860       }
8861     }
8862 
8863     if (ReadTimer)
8864       ReadTimer->stopTimer();
8865 
8866     diagnoseOdrViolations();
8867 
8868     // We are not in recursive loading, so it's safe to pass the "interesting"
8869     // decls to the consumer.
8870     if (Consumer)
8871       PassInterestingDeclsToConsumer();
8872   }
8873 }
8874 
8875 void ASTReader::pushExternalDeclIntoScope(NamedDecl *D, DeclarationName Name) {
8876   if (IdentifierInfo *II = Name.getAsIdentifierInfo()) {
8877     // Remove any fake results before adding any real ones.
8878     auto It = PendingFakeLookupResults.find(II);
8879     if (It != PendingFakeLookupResults.end()) {
8880       for (auto *ND : It->second)
8881         SemaObj->IdResolver.RemoveDecl(ND);
8882       // FIXME: this works around module+PCH performance issue.
8883       // Rather than erase the result from the map, which is O(n), just clear
8884       // the vector of NamedDecls.
8885       It->second.clear();
8886     }
8887   }
8888 
8889   if (SemaObj->IdResolver.tryAddTopLevelDecl(D, Name) && SemaObj->TUScope) {
8890     SemaObj->TUScope->AddDecl(D);
8891   } else if (SemaObj->TUScope) {
8892     // Adding the decl to IdResolver may have failed because it was already in
8893     // (even though it was not added in scope). If it is already in, make sure
8894     // it gets in the scope as well.
8895     if (std::find(SemaObj->IdResolver.begin(Name),
8896                   SemaObj->IdResolver.end(), D) != SemaObj->IdResolver.end())
8897       SemaObj->TUScope->AddDecl(D);
8898   }
8899 }
8900 
8901 ASTReader::ASTReader(Preprocessor &PP, ASTContext &Context,
8902                      const PCHContainerReader &PCHContainerRdr,
8903                      ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
8904                      StringRef isysroot, bool DisableValidation,
8905                      bool AllowASTWithCompilerErrors,
8906                      bool AllowConfigurationMismatch, bool ValidateSystemInputs,
8907                      bool UseGlobalIndex,
8908                      std::unique_ptr<llvm::Timer> ReadTimer)
8909     : Listener(DisableValidation
8910                    ? cast<ASTReaderListener>(new SimpleASTReaderListener(PP))
8911                    : cast<ASTReaderListener>(new PCHValidator(PP, *this))),
8912       SourceMgr(PP.getSourceManager()), FileMgr(PP.getFileManager()),
8913       PCHContainerRdr(PCHContainerRdr), Diags(PP.getDiagnostics()), PP(PP),
8914       Context(Context), ModuleMgr(PP.getFileManager(), PCHContainerRdr),
8915       DummyIdResolver(PP), ReadTimer(std::move(ReadTimer)), isysroot(isysroot),
8916       DisableValidation(DisableValidation),
8917       AllowASTWithCompilerErrors(AllowASTWithCompilerErrors),
8918       AllowConfigurationMismatch(AllowConfigurationMismatch),
8919       ValidateSystemInputs(ValidateSystemInputs),
8920       UseGlobalIndex(UseGlobalIndex), CurrSwitchCaseStmts(&SwitchCaseStmts) {
8921   SourceMgr.setExternalSLocEntrySource(this);
8922 
8923   for (const auto &Ext : Extensions) {
8924     auto BlockName = Ext->getExtensionMetadata().BlockName;
8925     auto Known = ModuleFileExtensions.find(BlockName);
8926     if (Known != ModuleFileExtensions.end()) {
8927       Diags.Report(diag::warn_duplicate_module_file_extension)
8928         << BlockName;
8929       continue;
8930     }
8931 
8932     ModuleFileExtensions.insert({BlockName, Ext});
8933   }
8934 }
8935 
8936 ASTReader::~ASTReader() {
8937   if (OwnsDeserializationListener)
8938     delete DeserializationListener;
8939 }
8940 
8941 IdentifierResolver &ASTReader::getIdResolver() {
8942   return SemaObj ? SemaObj->IdResolver : DummyIdResolver;
8943 }
8944 
8945 unsigned ASTRecordReader::readRecord(llvm::BitstreamCursor &Cursor,
8946                                      unsigned AbbrevID) {
8947   Idx = 0;
8948   Record.clear();
8949   return Cursor.readRecord(AbbrevID, Record);
8950 }
8951