blob: 910f5dcf779cbc4679ea5eace72f4c094d68fe66 [file] [log] [blame]
Richard Smith9e2341d2015-03-23 03:25:59 +00001//===-- ASTReader.cpp - AST File Reader ----------------------------------===//
Guy Benyei11169dd2012-12-18 14:30:41 +00002//
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/DeclTemplate.h"
20#include "clang/AST/Expr.h"
21#include "clang/AST/ExprCXX.h"
Adrian Prantlbb165fb2015-06-20 18:53:08 +000022#include "clang/Frontend/PCHContainerOperations.h"
Richard Smithd88a7f12015-09-01 20:35:42 +000023#include "clang/AST/ASTMutationListener.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000024#include "clang/AST/NestedNameSpecifier.h"
25#include "clang/AST/Type.h"
26#include "clang/AST/TypeLocVisitor.h"
Benjamin Kramerf3ca26982014-05-10 16:31:55 +000027#include "clang/Basic/DiagnosticOptions.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000028#include "clang/Basic/FileManager.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000029#include "clang/Basic/SourceManager.h"
30#include "clang/Basic/SourceManagerInternals.h"
31#include "clang/Basic/TargetInfo.h"
32#include "clang/Basic/TargetOptions.h"
33#include "clang/Basic/Version.h"
34#include "clang/Basic/VersionTuple.h"
Ben Langmuirb92de022014-04-29 16:25:26 +000035#include "clang/Frontend/Utils.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000036#include "clang/Lex/HeaderSearch.h"
37#include "clang/Lex/HeaderSearchOptions.h"
38#include "clang/Lex/MacroInfo.h"
39#include "clang/Lex/PreprocessingRecord.h"
40#include "clang/Lex/Preprocessor.h"
41#include "clang/Lex/PreprocessorOptions.h"
42#include "clang/Sema/Scope.h"
43#include "clang/Sema/Sema.h"
44#include "clang/Serialization/ASTDeserializationListener.h"
Douglas Gregore060e572013-01-25 01:03:03 +000045#include "clang/Serialization/GlobalModuleIndex.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000046#include "clang/Serialization/ModuleManager.h"
47#include "clang/Serialization/SerializationDiagnostic.h"
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +000048#include "llvm/ADT/Hashing.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000049#include "llvm/ADT/StringExtras.h"
50#include "llvm/Bitcode/BitstreamReader.h"
Richard Smithaada85c2016-02-06 02:06:43 +000051#include "llvm/Support/Compression.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000052#include "llvm/Support/ErrorHandling.h"
53#include "llvm/Support/FileSystem.h"
54#include "llvm/Support/MemoryBuffer.h"
55#include "llvm/Support/Path.h"
56#include "llvm/Support/SaveAndRestore.h"
Dmitri Gribenkof430da42014-02-12 10:33:14 +000057#include "llvm/Support/raw_ostream.h"
Guy Benyei11169dd2012-12-18 14:30:41 +000058#include <algorithm>
Chris Lattner91f373e2013-01-20 00:57:52 +000059#include <cstdio>
Guy Benyei11169dd2012-12-18 14:30:41 +000060#include <iterator>
Rafael Espindola8a8e5542014-06-12 17:19:42 +000061#include <system_error>
Guy Benyei11169dd2012-12-18 14:30:41 +000062
63using namespace clang;
64using namespace clang::serialization;
65using namespace clang::serialization::reader;
Chris Lattner7fb3bef2013-01-20 00:56:42 +000066using llvm::BitstreamCursor;
Guy Benyei11169dd2012-12-18 14:30:41 +000067
Ben Langmuircb69b572014-03-07 06:40:32 +000068
69//===----------------------------------------------------------------------===//
70// ChainedASTReaderListener implementation
71//===----------------------------------------------------------------------===//
72
73bool
74ChainedASTReaderListener::ReadFullVersionInformation(StringRef FullVersion) {
75 return First->ReadFullVersionInformation(FullVersion) ||
76 Second->ReadFullVersionInformation(FullVersion);
77}
Ben Langmuir4f5212a2014-04-14 22:12:44 +000078void ChainedASTReaderListener::ReadModuleName(StringRef ModuleName) {
79 First->ReadModuleName(ModuleName);
80 Second->ReadModuleName(ModuleName);
81}
82void ChainedASTReaderListener::ReadModuleMapFile(StringRef ModuleMapPath) {
83 First->ReadModuleMapFile(ModuleMapPath);
84 Second->ReadModuleMapFile(ModuleMapPath);
85}
Richard Smith1e2cf0d2014-10-31 02:28:58 +000086bool
87ChainedASTReaderListener::ReadLanguageOptions(const LangOptions &LangOpts,
88 bool Complain,
89 bool AllowCompatibleDifferences) {
90 return First->ReadLanguageOptions(LangOpts, Complain,
91 AllowCompatibleDifferences) ||
92 Second->ReadLanguageOptions(LangOpts, Complain,
93 AllowCompatibleDifferences);
Ben Langmuircb69b572014-03-07 06:40:32 +000094}
Chandler Carruth0d745bc2015-03-14 04:47:43 +000095bool ChainedASTReaderListener::ReadTargetOptions(
96 const TargetOptions &TargetOpts, bool Complain,
97 bool AllowCompatibleDifferences) {
98 return First->ReadTargetOptions(TargetOpts, Complain,
99 AllowCompatibleDifferences) ||
100 Second->ReadTargetOptions(TargetOpts, Complain,
101 AllowCompatibleDifferences);
Ben Langmuircb69b572014-03-07 06:40:32 +0000102}
103bool ChainedASTReaderListener::ReadDiagnosticOptions(
Ben Langmuirb92de022014-04-29 16:25:26 +0000104 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts, bool Complain) {
Ben Langmuircb69b572014-03-07 06:40:32 +0000105 return First->ReadDiagnosticOptions(DiagOpts, Complain) ||
106 Second->ReadDiagnosticOptions(DiagOpts, Complain);
107}
108bool
109ChainedASTReaderListener::ReadFileSystemOptions(const FileSystemOptions &FSOpts,
110 bool Complain) {
111 return First->ReadFileSystemOptions(FSOpts, Complain) ||
112 Second->ReadFileSystemOptions(FSOpts, Complain);
113}
114
115bool ChainedASTReaderListener::ReadHeaderSearchOptions(
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000116 const HeaderSearchOptions &HSOpts, StringRef SpecificModuleCachePath,
117 bool Complain) {
118 return First->ReadHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
119 Complain) ||
120 Second->ReadHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
121 Complain);
Ben Langmuircb69b572014-03-07 06:40:32 +0000122}
123bool ChainedASTReaderListener::ReadPreprocessorOptions(
124 const PreprocessorOptions &PPOpts, bool Complain,
125 std::string &SuggestedPredefines) {
126 return First->ReadPreprocessorOptions(PPOpts, Complain,
127 SuggestedPredefines) ||
128 Second->ReadPreprocessorOptions(PPOpts, Complain, SuggestedPredefines);
129}
130void ChainedASTReaderListener::ReadCounter(const serialization::ModuleFile &M,
131 unsigned Value) {
132 First->ReadCounter(M, Value);
133 Second->ReadCounter(M, Value);
134}
135bool ChainedASTReaderListener::needsInputFileVisitation() {
136 return First->needsInputFileVisitation() ||
137 Second->needsInputFileVisitation();
138}
139bool ChainedASTReaderListener::needsSystemInputFileVisitation() {
140 return First->needsSystemInputFileVisitation() ||
141 Second->needsSystemInputFileVisitation();
142}
Richard Smith216a3bd2015-08-13 17:57:10 +0000143void ChainedASTReaderListener::visitModuleFile(StringRef Filename,
144 ModuleKind Kind) {
145 First->visitModuleFile(Filename, Kind);
146 Second->visitModuleFile(Filename, Kind);
Argyrios Kyrtzidis6d0753d2014-03-14 03:07:38 +0000147}
Ben Langmuircb69b572014-03-07 06:40:32 +0000148bool ChainedASTReaderListener::visitInputFile(StringRef Filename,
Argyrios Kyrtzidis68ccbe02014-03-14 02:26:31 +0000149 bool isSystem,
Richard Smith216a3bd2015-08-13 17:57:10 +0000150 bool isOverridden,
151 bool isExplicitModule) {
Justin Bognerc65a66d2014-05-22 06:04:59 +0000152 bool Continue = false;
153 if (First->needsInputFileVisitation() &&
154 (!isSystem || First->needsSystemInputFileVisitation()))
Richard Smith216a3bd2015-08-13 17:57:10 +0000155 Continue |= First->visitInputFile(Filename, isSystem, isOverridden,
156 isExplicitModule);
Justin Bognerc65a66d2014-05-22 06:04:59 +0000157 if (Second->needsInputFileVisitation() &&
158 (!isSystem || Second->needsSystemInputFileVisitation()))
Richard Smith216a3bd2015-08-13 17:57:10 +0000159 Continue |= Second->visitInputFile(Filename, isSystem, isOverridden,
160 isExplicitModule);
Justin Bognerc65a66d2014-05-22 06:04:59 +0000161 return Continue;
Ben Langmuircb69b572014-03-07 06:40:32 +0000162}
163
Douglas Gregor6623e1f2015-11-03 18:33:07 +0000164void ChainedASTReaderListener::readModuleFileExtension(
165 const ModuleFileExtensionMetadata &Metadata) {
166 First->readModuleFileExtension(Metadata);
167 Second->readModuleFileExtension(Metadata);
168}
169
Guy Benyei11169dd2012-12-18 14:30:41 +0000170//===----------------------------------------------------------------------===//
171// PCH validator implementation
172//===----------------------------------------------------------------------===//
173
Angel Garcia Gomez637d1e62015-10-20 13:23:58 +0000174ASTReaderListener::~ASTReaderListener() {}
Guy Benyei11169dd2012-12-18 14:30:41 +0000175
176/// \brief Compare the given set of language options against an existing set of
177/// language options.
178///
179/// \param Diags If non-NULL, diagnostics will be emitted via this engine.
Richard Smith1e2cf0d2014-10-31 02:28:58 +0000180/// \param AllowCompatibleDifferences If true, differences between compatible
181/// language options will be permitted.
Guy Benyei11169dd2012-12-18 14:30:41 +0000182///
183/// \returns true if the languagae options mis-match, false otherwise.
184static bool checkLanguageOptions(const LangOptions &LangOpts,
185 const LangOptions &ExistingLangOpts,
Richard Smith1e2cf0d2014-10-31 02:28:58 +0000186 DiagnosticsEngine *Diags,
187 bool AllowCompatibleDifferences = true) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000188#define LANGOPT(Name, Bits, Default, Description) \
189 if (ExistingLangOpts.Name != LangOpts.Name) { \
190 if (Diags) \
191 Diags->Report(diag::err_pch_langopt_mismatch) \
192 << Description << LangOpts.Name << ExistingLangOpts.Name; \
193 return true; \
194 }
195
196#define VALUE_LANGOPT(Name, Bits, Default, Description) \
197 if (ExistingLangOpts.Name != LangOpts.Name) { \
198 if (Diags) \
199 Diags->Report(diag::err_pch_langopt_value_mismatch) \
200 << Description; \
201 return true; \
202 }
203
204#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
205 if (ExistingLangOpts.get##Name() != LangOpts.get##Name()) { \
206 if (Diags) \
207 Diags->Report(diag::err_pch_langopt_value_mismatch) \
208 << Description; \
209 return true; \
210 }
211
Richard Smith1e2cf0d2014-10-31 02:28:58 +0000212#define COMPATIBLE_LANGOPT(Name, Bits, Default, Description) \
213 if (!AllowCompatibleDifferences) \
214 LANGOPT(Name, Bits, Default, Description)
215
216#define COMPATIBLE_ENUM_LANGOPT(Name, Bits, Default, Description) \
217 if (!AllowCompatibleDifferences) \
218 ENUM_LANGOPT(Name, Bits, Default, Description)
219
Richard Smitha1ddf5e2016-04-07 20:47:37 +0000220#define COMPATIBLE_VALUE_LANGOPT(Name, Bits, Default, Description) \
221 if (!AllowCompatibleDifferences) \
222 VALUE_LANGOPT(Name, Bits, Default, Description)
223
Guy Benyei11169dd2012-12-18 14:30:41 +0000224#define BENIGN_LANGOPT(Name, Bits, Default, Description)
225#define BENIGN_ENUM_LANGOPT(Name, Type, Bits, Default, Description)
Richard Smitha1ddf5e2016-04-07 20:47:37 +0000226#define BENIGN_VALUE_LANGOPT(Name, Type, Bits, Default, Description)
Guy Benyei11169dd2012-12-18 14:30:41 +0000227#include "clang/Basic/LangOptions.def"
228
Ben Langmuircd98cb72015-06-23 18:20:18 +0000229 if (ExistingLangOpts.ModuleFeatures != LangOpts.ModuleFeatures) {
230 if (Diags)
231 Diags->Report(diag::err_pch_langopt_value_mismatch) << "module features";
232 return true;
233 }
234
Guy Benyei11169dd2012-12-18 14:30:41 +0000235 if (ExistingLangOpts.ObjCRuntime != LangOpts.ObjCRuntime) {
236 if (Diags)
237 Diags->Report(diag::err_pch_langopt_value_mismatch)
238 << "target Objective-C runtime";
239 return true;
240 }
241
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +0000242 if (ExistingLangOpts.CommentOpts.BlockCommandNames !=
243 LangOpts.CommentOpts.BlockCommandNames) {
244 if (Diags)
245 Diags->Report(diag::err_pch_langopt_value_mismatch)
246 << "block command names";
247 return true;
248 }
249
Guy Benyei11169dd2012-12-18 14:30:41 +0000250 return false;
251}
252
253/// \brief Compare the given set of target options against an existing set of
254/// target options.
255///
256/// \param Diags If non-NULL, diagnostics will be emitted via this engine.
257///
258/// \returns true if the target options mis-match, false otherwise.
259static bool checkTargetOptions(const TargetOptions &TargetOpts,
260 const TargetOptions &ExistingTargetOpts,
Chandler Carruth0d745bc2015-03-14 04:47:43 +0000261 DiagnosticsEngine *Diags,
262 bool AllowCompatibleDifferences = true) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000263#define CHECK_TARGET_OPT(Field, Name) \
264 if (TargetOpts.Field != ExistingTargetOpts.Field) { \
265 if (Diags) \
266 Diags->Report(diag::err_pch_targetopt_mismatch) \
267 << Name << TargetOpts.Field << ExistingTargetOpts.Field; \
268 return true; \
269 }
270
Chandler Carruth0d745bc2015-03-14 04:47:43 +0000271 // The triple and ABI must match exactly.
Guy Benyei11169dd2012-12-18 14:30:41 +0000272 CHECK_TARGET_OPT(Triple, "target");
Guy Benyei11169dd2012-12-18 14:30:41 +0000273 CHECK_TARGET_OPT(ABI, "target ABI");
Chandler Carruth0d745bc2015-03-14 04:47:43 +0000274
275 // We can tolerate different CPUs in many cases, notably when one CPU
276 // supports a strict superset of another. When allowing compatible
277 // differences skip this check.
278 if (!AllowCompatibleDifferences)
279 CHECK_TARGET_OPT(CPU, "target CPU");
280
Guy Benyei11169dd2012-12-18 14:30:41 +0000281#undef CHECK_TARGET_OPT
282
283 // Compare feature sets.
284 SmallVector<StringRef, 4> ExistingFeatures(
285 ExistingTargetOpts.FeaturesAsWritten.begin(),
286 ExistingTargetOpts.FeaturesAsWritten.end());
287 SmallVector<StringRef, 4> ReadFeatures(TargetOpts.FeaturesAsWritten.begin(),
288 TargetOpts.FeaturesAsWritten.end());
289 std::sort(ExistingFeatures.begin(), ExistingFeatures.end());
290 std::sort(ReadFeatures.begin(), ReadFeatures.end());
291
Chandler Carruth0d745bc2015-03-14 04:47:43 +0000292 // We compute the set difference in both directions explicitly so that we can
293 // diagnose the differences differently.
294 SmallVector<StringRef, 4> UnmatchedExistingFeatures, UnmatchedReadFeatures;
295 std::set_difference(
296 ExistingFeatures.begin(), ExistingFeatures.end(), ReadFeatures.begin(),
297 ReadFeatures.end(), std::back_inserter(UnmatchedExistingFeatures));
298 std::set_difference(ReadFeatures.begin(), ReadFeatures.end(),
299 ExistingFeatures.begin(), ExistingFeatures.end(),
300 std::back_inserter(UnmatchedReadFeatures));
Guy Benyei11169dd2012-12-18 14:30:41 +0000301
Chandler Carruth0d745bc2015-03-14 04:47:43 +0000302 // If we are allowing compatible differences and the read feature set is
303 // a strict subset of the existing feature set, there is nothing to diagnose.
304 if (AllowCompatibleDifferences && UnmatchedReadFeatures.empty())
305 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +0000306
Chandler Carruth0d745bc2015-03-14 04:47:43 +0000307 if (Diags) {
308 for (StringRef Feature : UnmatchedReadFeatures)
Guy Benyei11169dd2012-12-18 14:30:41 +0000309 Diags->Report(diag::err_pch_targetopt_feature_mismatch)
Chandler Carruth0d745bc2015-03-14 04:47:43 +0000310 << /* is-existing-feature */ false << Feature;
311 for (StringRef Feature : UnmatchedExistingFeatures)
312 Diags->Report(diag::err_pch_targetopt_feature_mismatch)
313 << /* is-existing-feature */ true << Feature;
Guy Benyei11169dd2012-12-18 14:30:41 +0000314 }
315
Chandler Carruth0d745bc2015-03-14 04:47:43 +0000316 return !UnmatchedReadFeatures.empty() || !UnmatchedExistingFeatures.empty();
Guy Benyei11169dd2012-12-18 14:30:41 +0000317}
318
319bool
320PCHValidator::ReadLanguageOptions(const LangOptions &LangOpts,
Richard Smith1e2cf0d2014-10-31 02:28:58 +0000321 bool Complain,
322 bool AllowCompatibleDifferences) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000323 const LangOptions &ExistingLangOpts = PP.getLangOpts();
324 return checkLanguageOptions(LangOpts, ExistingLangOpts,
Richard Smith1e2cf0d2014-10-31 02:28:58 +0000325 Complain ? &Reader.Diags : nullptr,
326 AllowCompatibleDifferences);
Guy Benyei11169dd2012-12-18 14:30:41 +0000327}
328
329bool PCHValidator::ReadTargetOptions(const TargetOptions &TargetOpts,
Chandler Carruth0d745bc2015-03-14 04:47:43 +0000330 bool Complain,
331 bool AllowCompatibleDifferences) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000332 const TargetOptions &ExistingTargetOpts = PP.getTargetInfo().getTargetOpts();
333 return checkTargetOptions(TargetOpts, ExistingTargetOpts,
Chandler Carruth0d745bc2015-03-14 04:47:43 +0000334 Complain ? &Reader.Diags : nullptr,
335 AllowCompatibleDifferences);
Guy Benyei11169dd2012-12-18 14:30:41 +0000336}
337
338namespace {
339 typedef llvm::StringMap<std::pair<StringRef, bool /*IsUndef*/> >
340 MacroDefinitionsMap;
Craig Topper3598eb72013-07-05 04:43:31 +0000341 typedef llvm::DenseMap<DeclarationName, SmallVector<NamedDecl *, 8> >
342 DeclsMap;
Guy Benyei11169dd2012-12-18 14:30:41 +0000343}
344
Ben Langmuirb92de022014-04-29 16:25:26 +0000345static bool checkDiagnosticGroupMappings(DiagnosticsEngine &StoredDiags,
346 DiagnosticsEngine &Diags,
347 bool Complain) {
348 typedef DiagnosticsEngine::Level Level;
349
350 // Check current mappings for new -Werror mappings, and the stored mappings
351 // for cases that were explicitly mapped to *not* be errors that are now
352 // errors because of options like -Werror.
353 DiagnosticsEngine *MappingSources[] = { &Diags, &StoredDiags };
354
355 for (DiagnosticsEngine *MappingSource : MappingSources) {
356 for (auto DiagIDMappingPair : MappingSource->getDiagnosticMappings()) {
357 diag::kind DiagID = DiagIDMappingPair.first;
358 Level CurLevel = Diags.getDiagnosticLevel(DiagID, SourceLocation());
359 if (CurLevel < DiagnosticsEngine::Error)
360 continue; // not significant
361 Level StoredLevel =
362 StoredDiags.getDiagnosticLevel(DiagID, SourceLocation());
363 if (StoredLevel < DiagnosticsEngine::Error) {
364 if (Complain)
365 Diags.Report(diag::err_pch_diagopt_mismatch) << "-Werror=" +
366 Diags.getDiagnosticIDs()->getWarningOptionForDiag(DiagID).str();
367 return true;
368 }
369 }
370 }
371
372 return false;
373}
374
Alp Tokerac4e8e52014-06-22 21:58:33 +0000375static bool isExtHandlingFromDiagsError(DiagnosticsEngine &Diags) {
376 diag::Severity Ext = Diags.getExtensionHandlingBehavior();
377 if (Ext == diag::Severity::Warning && Diags.getWarningsAsErrors())
378 return true;
379 return Ext >= diag::Severity::Error;
Ben Langmuirb92de022014-04-29 16:25:26 +0000380}
381
382static bool checkDiagnosticMappings(DiagnosticsEngine &StoredDiags,
383 DiagnosticsEngine &Diags,
384 bool IsSystem, bool Complain) {
385 // Top-level options
386 if (IsSystem) {
387 if (Diags.getSuppressSystemWarnings())
388 return false;
389 // If -Wsystem-headers was not enabled before, be conservative
390 if (StoredDiags.getSuppressSystemWarnings()) {
391 if (Complain)
392 Diags.Report(diag::err_pch_diagopt_mismatch) << "-Wsystem-headers";
393 return true;
394 }
395 }
396
397 if (Diags.getWarningsAsErrors() && !StoredDiags.getWarningsAsErrors()) {
398 if (Complain)
399 Diags.Report(diag::err_pch_diagopt_mismatch) << "-Werror";
400 return true;
401 }
402
403 if (Diags.getWarningsAsErrors() && Diags.getEnableAllWarnings() &&
404 !StoredDiags.getEnableAllWarnings()) {
405 if (Complain)
406 Diags.Report(diag::err_pch_diagopt_mismatch) << "-Weverything -Werror";
407 return true;
408 }
409
410 if (isExtHandlingFromDiagsError(Diags) &&
411 !isExtHandlingFromDiagsError(StoredDiags)) {
412 if (Complain)
413 Diags.Report(diag::err_pch_diagopt_mismatch) << "-pedantic-errors";
414 return true;
415 }
416
417 return checkDiagnosticGroupMappings(StoredDiags, Diags, Complain);
418}
419
420bool PCHValidator::ReadDiagnosticOptions(
421 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts, bool Complain) {
422 DiagnosticsEngine &ExistingDiags = PP.getDiagnostics();
423 IntrusiveRefCntPtr<DiagnosticIDs> DiagIDs(ExistingDiags.getDiagnosticIDs());
424 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
Alp Tokerf994cef2014-07-05 03:08:06 +0000425 new DiagnosticsEngine(DiagIDs, DiagOpts.get()));
Ben Langmuirb92de022014-04-29 16:25:26 +0000426 // This should never fail, because we would have processed these options
427 // before writing them to an ASTFile.
428 ProcessWarningOptions(*Diags, *DiagOpts, /*Report*/false);
429
430 ModuleManager &ModuleMgr = Reader.getModuleManager();
431 assert(ModuleMgr.size() >= 1 && "what ASTFile is this then");
432
433 // If the original import came from a file explicitly generated by the user,
434 // don't check the diagnostic mappings.
435 // FIXME: currently this is approximated by checking whether this is not a
Richard Smithe842a472014-10-22 02:05:46 +0000436 // module import of an implicitly-loaded module file.
Ben Langmuirb92de022014-04-29 16:25:26 +0000437 // Note: ModuleMgr.rbegin() may not be the current module, but it must be in
438 // the transitive closure of its imports, since unrelated modules cannot be
439 // imported until after this module finishes validation.
440 ModuleFile *TopImport = *ModuleMgr.rbegin();
441 while (!TopImport->ImportedBy.empty())
442 TopImport = TopImport->ImportedBy[0];
Richard Smithe842a472014-10-22 02:05:46 +0000443 if (TopImport->Kind != MK_ImplicitModule)
Ben Langmuirb92de022014-04-29 16:25:26 +0000444 return false;
445
446 StringRef ModuleName = TopImport->ModuleName;
447 assert(!ModuleName.empty() && "diagnostic options read before module name");
448
449 Module *M = PP.getHeaderSearchInfo().lookupModule(ModuleName);
450 assert(M && "missing module");
451
452 // FIXME: if the diagnostics are incompatible, save a DiagnosticOptions that
453 // contains the union of their flags.
454 return checkDiagnosticMappings(*Diags, ExistingDiags, M->IsSystem, Complain);
455}
456
Guy Benyei11169dd2012-12-18 14:30:41 +0000457/// \brief Collect the macro definitions provided by the given preprocessor
458/// options.
Craig Toppera13603a2014-05-22 05:54:18 +0000459static void
460collectMacroDefinitions(const PreprocessorOptions &PPOpts,
461 MacroDefinitionsMap &Macros,
462 SmallVectorImpl<StringRef> *MacroNames = nullptr) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000463 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
464 StringRef Macro = PPOpts.Macros[I].first;
465 bool IsUndef = PPOpts.Macros[I].second;
466
467 std::pair<StringRef, StringRef> MacroPair = Macro.split('=');
468 StringRef MacroName = MacroPair.first;
469 StringRef MacroBody = MacroPair.second;
470
471 // For an #undef'd macro, we only care about the name.
472 if (IsUndef) {
473 if (MacroNames && !Macros.count(MacroName))
474 MacroNames->push_back(MacroName);
475
476 Macros[MacroName] = std::make_pair("", true);
477 continue;
478 }
479
480 // For a #define'd macro, figure out the actual definition.
481 if (MacroName.size() == Macro.size())
482 MacroBody = "1";
483 else {
484 // Note: GCC drops anything following an end-of-line character.
485 StringRef::size_type End = MacroBody.find_first_of("\n\r");
486 MacroBody = MacroBody.substr(0, End);
487 }
488
489 if (MacroNames && !Macros.count(MacroName))
490 MacroNames->push_back(MacroName);
491 Macros[MacroName] = std::make_pair(MacroBody, false);
492 }
493}
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000494
Guy Benyei11169dd2012-12-18 14:30:41 +0000495/// \brief Check the preprocessor options deserialized from the control block
496/// against the preprocessor options in an existing preprocessor.
497///
498/// \param Diags If non-null, produce diagnostics for any mismatches incurred.
499static bool checkPreprocessorOptions(const PreprocessorOptions &PPOpts,
500 const PreprocessorOptions &ExistingPPOpts,
501 DiagnosticsEngine *Diags,
502 FileManager &FileMgr,
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +0000503 std::string &SuggestedPredefines,
504 const LangOptions &LangOpts) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000505 // Check macro definitions.
506 MacroDefinitionsMap ASTFileMacros;
507 collectMacroDefinitions(PPOpts, ASTFileMacros);
508 MacroDefinitionsMap ExistingMacros;
509 SmallVector<StringRef, 4> ExistingMacroNames;
510 collectMacroDefinitions(ExistingPPOpts, ExistingMacros, &ExistingMacroNames);
511
512 for (unsigned I = 0, N = ExistingMacroNames.size(); I != N; ++I) {
513 // Dig out the macro definition in the existing preprocessor options.
514 StringRef MacroName = ExistingMacroNames[I];
515 std::pair<StringRef, bool> Existing = ExistingMacros[MacroName];
516
517 // Check whether we know anything about this macro name or not.
518 llvm::StringMap<std::pair<StringRef, bool /*IsUndef*/> >::iterator Known
519 = ASTFileMacros.find(MacroName);
520 if (Known == ASTFileMacros.end()) {
521 // FIXME: Check whether this identifier was referenced anywhere in the
522 // AST file. If so, we should reject the AST file. Unfortunately, this
523 // information isn't in the control block. What shall we do about it?
524
525 if (Existing.second) {
526 SuggestedPredefines += "#undef ";
527 SuggestedPredefines += MacroName.str();
528 SuggestedPredefines += '\n';
529 } else {
530 SuggestedPredefines += "#define ";
531 SuggestedPredefines += MacroName.str();
532 SuggestedPredefines += ' ';
533 SuggestedPredefines += Existing.first.str();
534 SuggestedPredefines += '\n';
535 }
536 continue;
537 }
538
539 // If the macro was defined in one but undef'd in the other, we have a
540 // conflict.
541 if (Existing.second != Known->second.second) {
542 if (Diags) {
543 Diags->Report(diag::err_pch_macro_def_undef)
544 << MacroName << Known->second.second;
545 }
546 return true;
547 }
548
549 // If the macro was #undef'd in both, or if the macro bodies are identical,
550 // it's fine.
551 if (Existing.second || Existing.first == Known->second.first)
552 continue;
553
554 // The macro bodies differ; complain.
555 if (Diags) {
556 Diags->Report(diag::err_pch_macro_def_conflict)
557 << MacroName << Known->second.first << Existing.first;
558 }
559 return true;
560 }
561
562 // Check whether we're using predefines.
563 if (PPOpts.UsePredefines != ExistingPPOpts.UsePredefines) {
564 if (Diags) {
565 Diags->Report(diag::err_pch_undef) << ExistingPPOpts.UsePredefines;
566 }
567 return true;
568 }
569
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +0000570 // Detailed record is important since it is used for the module cache hash.
571 if (LangOpts.Modules &&
572 PPOpts.DetailedRecord != ExistingPPOpts.DetailedRecord) {
573 if (Diags) {
574 Diags->Report(diag::err_pch_pp_detailed_record) << PPOpts.DetailedRecord;
575 }
576 return true;
577 }
578
Guy Benyei11169dd2012-12-18 14:30:41 +0000579 // Compute the #include and #include_macros lines we need.
580 for (unsigned I = 0, N = ExistingPPOpts.Includes.size(); I != N; ++I) {
581 StringRef File = ExistingPPOpts.Includes[I];
582 if (File == ExistingPPOpts.ImplicitPCHInclude)
583 continue;
584
585 if (std::find(PPOpts.Includes.begin(), PPOpts.Includes.end(), File)
586 != PPOpts.Includes.end())
587 continue;
588
589 SuggestedPredefines += "#include \"";
Manuel Klimek9af34ae2014-08-12 08:25:57 +0000590 SuggestedPredefines += File;
Guy Benyei11169dd2012-12-18 14:30:41 +0000591 SuggestedPredefines += "\"\n";
592 }
593
594 for (unsigned I = 0, N = ExistingPPOpts.MacroIncludes.size(); I != N; ++I) {
595 StringRef File = ExistingPPOpts.MacroIncludes[I];
596 if (std::find(PPOpts.MacroIncludes.begin(), PPOpts.MacroIncludes.end(),
597 File)
598 != PPOpts.MacroIncludes.end())
599 continue;
600
601 SuggestedPredefines += "#__include_macros \"";
Manuel Klimek9af34ae2014-08-12 08:25:57 +0000602 SuggestedPredefines += File;
Guy Benyei11169dd2012-12-18 14:30:41 +0000603 SuggestedPredefines += "\"\n##\n";
604 }
605
606 return false;
607}
608
609bool PCHValidator::ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
610 bool Complain,
611 std::string &SuggestedPredefines) {
612 const PreprocessorOptions &ExistingPPOpts = PP.getPreprocessorOpts();
613
614 return checkPreprocessorOptions(PPOpts, ExistingPPOpts,
Craig Toppera13603a2014-05-22 05:54:18 +0000615 Complain? &Reader.Diags : nullptr,
Guy Benyei11169dd2012-12-18 14:30:41 +0000616 PP.getFileManager(),
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +0000617 SuggestedPredefines,
618 PP.getLangOpts());
Guy Benyei11169dd2012-12-18 14:30:41 +0000619}
620
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +0000621/// Check the header search options deserialized from the control block
622/// against the header search options in an existing preprocessor.
623///
624/// \param Diags If non-null, produce diagnostics for any mismatches incurred.
625static bool checkHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
626 StringRef SpecificModuleCachePath,
627 StringRef ExistingModuleCachePath,
628 DiagnosticsEngine *Diags,
629 const LangOptions &LangOpts) {
630 if (LangOpts.Modules) {
631 if (SpecificModuleCachePath != ExistingModuleCachePath) {
632 if (Diags)
633 Diags->Report(diag::err_pch_modulecache_mismatch)
634 << SpecificModuleCachePath << ExistingModuleCachePath;
635 return true;
636 }
637 }
638
639 return false;
640}
641
642bool PCHValidator::ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
643 StringRef SpecificModuleCachePath,
644 bool Complain) {
645 return checkHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
646 PP.getHeaderSearchInfo().getModuleCachePath(),
647 Complain ? &Reader.Diags : nullptr,
648 PP.getLangOpts());
649}
650
Guy Benyei11169dd2012-12-18 14:30:41 +0000651void PCHValidator::ReadCounter(const ModuleFile &M, unsigned Value) {
652 PP.setCounterValue(Value);
653}
654
655//===----------------------------------------------------------------------===//
656// AST reader implementation
657//===----------------------------------------------------------------------===//
658
Nico Weber824285e2014-05-08 04:26:47 +0000659void ASTReader::setDeserializationListener(ASTDeserializationListener *Listener,
660 bool TakeOwnership) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000661 DeserializationListener = Listener;
Nico Weber824285e2014-05-08 04:26:47 +0000662 OwnsDeserializationListener = TakeOwnership;
Guy Benyei11169dd2012-12-18 14:30:41 +0000663}
664
665
666
667unsigned ASTSelectorLookupTrait::ComputeHash(Selector Sel) {
668 return serialization::ComputeHash(Sel);
669}
670
671
672std::pair<unsigned, unsigned>
673ASTSelectorLookupTrait::ReadKeyDataLength(const unsigned char*& d) {
Justin Bogner57ba0b22014-03-28 22:03:24 +0000674 using namespace llvm::support;
675 unsigned KeyLen = endian::readNext<uint16_t, little, unaligned>(d);
676 unsigned DataLen = endian::readNext<uint16_t, little, unaligned>(d);
Guy Benyei11169dd2012-12-18 14:30:41 +0000677 return std::make_pair(KeyLen, DataLen);
678}
679
680ASTSelectorLookupTrait::internal_key_type
681ASTSelectorLookupTrait::ReadKey(const unsigned char* d, unsigned) {
Justin Bogner57ba0b22014-03-28 22:03:24 +0000682 using namespace llvm::support;
Guy Benyei11169dd2012-12-18 14:30:41 +0000683 SelectorTable &SelTable = Reader.getContext().Selectors;
Justin Bogner57ba0b22014-03-28 22:03:24 +0000684 unsigned N = endian::readNext<uint16_t, little, unaligned>(d);
685 IdentifierInfo *FirstII = Reader.getLocalIdentifier(
686 F, endian::readNext<uint32_t, little, unaligned>(d));
Guy Benyei11169dd2012-12-18 14:30:41 +0000687 if (N == 0)
688 return SelTable.getNullarySelector(FirstII);
689 else if (N == 1)
690 return SelTable.getUnarySelector(FirstII);
691
692 SmallVector<IdentifierInfo *, 16> Args;
693 Args.push_back(FirstII);
694 for (unsigned I = 1; I != N; ++I)
Justin Bogner57ba0b22014-03-28 22:03:24 +0000695 Args.push_back(Reader.getLocalIdentifier(
696 F, endian::readNext<uint32_t, little, unaligned>(d)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000697
698 return SelTable.getSelector(N, Args.data());
699}
700
701ASTSelectorLookupTrait::data_type
702ASTSelectorLookupTrait::ReadData(Selector, const unsigned char* d,
703 unsigned DataLen) {
Justin Bogner57ba0b22014-03-28 22:03:24 +0000704 using namespace llvm::support;
Guy Benyei11169dd2012-12-18 14:30:41 +0000705
706 data_type Result;
707
Justin Bogner57ba0b22014-03-28 22:03:24 +0000708 Result.ID = Reader.getGlobalSelectorID(
709 F, endian::readNext<uint32_t, little, unaligned>(d));
Nico Weberff4b35e2014-12-27 22:14:15 +0000710 unsigned FullInstanceBits = endian::readNext<uint16_t, little, unaligned>(d);
711 unsigned FullFactoryBits = endian::readNext<uint16_t, little, unaligned>(d);
712 Result.InstanceBits = FullInstanceBits & 0x3;
713 Result.InstanceHasMoreThanOneDecl = (FullInstanceBits >> 2) & 0x1;
714 Result.FactoryBits = FullFactoryBits & 0x3;
715 Result.FactoryHasMoreThanOneDecl = (FullFactoryBits >> 2) & 0x1;
716 unsigned NumInstanceMethods = FullInstanceBits >> 3;
717 unsigned NumFactoryMethods = FullFactoryBits >> 3;
Guy Benyei11169dd2012-12-18 14:30:41 +0000718
719 // Load instance methods
720 for (unsigned I = 0; I != NumInstanceMethods; ++I) {
Justin Bogner57ba0b22014-03-28 22:03:24 +0000721 if (ObjCMethodDecl *Method = Reader.GetLocalDeclAs<ObjCMethodDecl>(
722 F, endian::readNext<uint32_t, little, unaligned>(d)))
Guy Benyei11169dd2012-12-18 14:30:41 +0000723 Result.Instance.push_back(Method);
724 }
725
726 // Load factory methods
727 for (unsigned I = 0; I != NumFactoryMethods; ++I) {
Justin Bogner57ba0b22014-03-28 22:03:24 +0000728 if (ObjCMethodDecl *Method = Reader.GetLocalDeclAs<ObjCMethodDecl>(
729 F, endian::readNext<uint32_t, little, unaligned>(d)))
Guy Benyei11169dd2012-12-18 14:30:41 +0000730 Result.Factory.push_back(Method);
731 }
732
733 return Result;
734}
735
Douglas Gregorbfd73d72013-01-23 18:53:14 +0000736unsigned ASTIdentifierLookupTraitBase::ComputeHash(const internal_key_type& a) {
737 return llvm::HashString(a);
Guy Benyei11169dd2012-12-18 14:30:41 +0000738}
739
740std::pair<unsigned, unsigned>
Douglas Gregorbfd73d72013-01-23 18:53:14 +0000741ASTIdentifierLookupTraitBase::ReadKeyDataLength(const unsigned char*& d) {
Justin Bogner57ba0b22014-03-28 22:03:24 +0000742 using namespace llvm::support;
743 unsigned DataLen = endian::readNext<uint16_t, little, unaligned>(d);
744 unsigned KeyLen = endian::readNext<uint16_t, little, unaligned>(d);
Guy Benyei11169dd2012-12-18 14:30:41 +0000745 return std::make_pair(KeyLen, DataLen);
746}
747
Douglas Gregorbfd73d72013-01-23 18:53:14 +0000748ASTIdentifierLookupTraitBase::internal_key_type
749ASTIdentifierLookupTraitBase::ReadKey(const unsigned char* d, unsigned n) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000750 assert(n >= 2 && d[n-1] == '\0');
Douglas Gregorbfd73d72013-01-23 18:53:14 +0000751 return StringRef((const char*) d, n-1);
Guy Benyei11169dd2012-12-18 14:30:41 +0000752}
753
Douglas Gregordcf25082013-02-11 18:16:18 +0000754/// \brief Whether the given identifier is "interesting".
Richard Smitha534a312015-07-21 23:54:07 +0000755static bool isInterestingIdentifier(ASTReader &Reader, IdentifierInfo &II,
756 bool IsModule) {
Richard Smithcab89802015-07-17 20:19:56 +0000757 return II.hadMacroDefinition() ||
758 II.isPoisoned() ||
Richard Smith9c254182015-07-19 21:41:12 +0000759 (IsModule ? II.hasRevertedBuiltin() : II.getObjCOrBuiltinID()) ||
Douglas Gregordcf25082013-02-11 18:16:18 +0000760 II.hasRevertedTokenIDToIdentifier() ||
Richard Smitha534a312015-07-21 23:54:07 +0000761 (!(IsModule && Reader.getContext().getLangOpts().CPlusPlus) &&
762 II.getFETokenInfo<void>());
Douglas Gregordcf25082013-02-11 18:16:18 +0000763}
764
Richard Smith76c2f2c2015-07-17 20:09:43 +0000765static bool readBit(unsigned &Bits) {
766 bool Value = Bits & 0x1;
767 Bits >>= 1;
768 return Value;
769}
770
Richard Smith79bf9202015-08-24 03:33:22 +0000771IdentID ASTIdentifierLookupTrait::ReadIdentifierID(const unsigned char *d) {
772 using namespace llvm::support;
773 unsigned RawID = endian::readNext<uint32_t, little, unaligned>(d);
774 return Reader.getGlobalIdentifierID(F, RawID >> 1);
775}
776
Richard Smitheb4b58f62016-02-05 01:40:54 +0000777static void markIdentifierFromAST(ASTReader &Reader, IdentifierInfo &II) {
778 if (!II.isFromAST()) {
779 II.setIsFromAST();
780 bool IsModule = Reader.getPreprocessor().getCurrentModule() != nullptr;
781 if (isInterestingIdentifier(Reader, II, IsModule))
782 II.setChangedSinceDeserialization();
783 }
784}
785
Guy Benyei11169dd2012-12-18 14:30:41 +0000786IdentifierInfo *ASTIdentifierLookupTrait::ReadData(const internal_key_type& k,
787 const unsigned char* d,
788 unsigned DataLen) {
Justin Bogner57ba0b22014-03-28 22:03:24 +0000789 using namespace llvm::support;
790 unsigned RawID = endian::readNext<uint32_t, little, unaligned>(d);
Guy Benyei11169dd2012-12-18 14:30:41 +0000791 bool IsInteresting = RawID & 0x01;
792
793 // Wipe out the "is interesting" bit.
794 RawID = RawID >> 1;
795
Richard Smith76c2f2c2015-07-17 20:09:43 +0000796 // Build the IdentifierInfo and link the identifier ID with it.
797 IdentifierInfo *II = KnownII;
798 if (!II) {
799 II = &Reader.getIdentifierTable().getOwn(k);
800 KnownII = II;
801 }
Richard Smitheb4b58f62016-02-05 01:40:54 +0000802 markIdentifierFromAST(Reader, *II);
Richard Smith76c2f2c2015-07-17 20:09:43 +0000803 Reader.markIdentifierUpToDate(II);
804
Guy Benyei11169dd2012-12-18 14:30:41 +0000805 IdentID ID = Reader.getGlobalIdentifierID(F, RawID);
806 if (!IsInteresting) {
Richard Smith76c2f2c2015-07-17 20:09:43 +0000807 // For uninteresting identifiers, there's nothing else to do. Just notify
808 // the reader that we've finished loading this identifier.
Guy Benyei11169dd2012-12-18 14:30:41 +0000809 Reader.SetIdentifierInfo(ID, II);
Guy Benyei11169dd2012-12-18 14:30:41 +0000810 return II;
811 }
812
Justin Bogner57ba0b22014-03-28 22:03:24 +0000813 unsigned ObjCOrBuiltinID = endian::readNext<uint16_t, little, unaligned>(d);
814 unsigned Bits = endian::readNext<uint16_t, little, unaligned>(d);
Richard Smith76c2f2c2015-07-17 20:09:43 +0000815 bool CPlusPlusOperatorKeyword = readBit(Bits);
816 bool HasRevertedTokenIDToIdentifier = readBit(Bits);
Richard Smith9c254182015-07-19 21:41:12 +0000817 bool HasRevertedBuiltin = readBit(Bits);
Richard Smith76c2f2c2015-07-17 20:09:43 +0000818 bool Poisoned = readBit(Bits);
819 bool ExtensionToken = readBit(Bits);
820 bool HadMacroDefinition = readBit(Bits);
Guy Benyei11169dd2012-12-18 14:30:41 +0000821
822 assert(Bits == 0 && "Extra bits in the identifier?");
823 DataLen -= 8;
824
Guy Benyei11169dd2012-12-18 14:30:41 +0000825 // Set or check the various bits in the IdentifierInfo structure.
826 // Token IDs are read-only.
Argyrios Kyrtzidisddee8c92013-02-27 01:13:51 +0000827 if (HasRevertedTokenIDToIdentifier && II->getTokenID() != tok::identifier)
Richard Smith9c254182015-07-19 21:41:12 +0000828 II->revertTokenIDToIdentifier();
829 if (!F.isModule())
830 II->setObjCOrBuiltinID(ObjCOrBuiltinID);
831 else if (HasRevertedBuiltin && II->getBuiltinID()) {
832 II->revertBuiltin();
833 assert((II->hasRevertedBuiltin() ||
834 II->getObjCOrBuiltinID() == ObjCOrBuiltinID) &&
835 "Incorrect ObjC keyword or builtin ID");
836 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000837 assert(II->isExtensionToken() == ExtensionToken &&
838 "Incorrect extension token flag");
839 (void)ExtensionToken;
840 if (Poisoned)
841 II->setIsPoisoned(true);
842 assert(II->isCPlusPlusOperatorKeyword() == CPlusPlusOperatorKeyword &&
843 "Incorrect C++ operator keyword flag");
844 (void)CPlusPlusOperatorKeyword;
845
846 // If this identifier is a macro, deserialize the macro
847 // definition.
Richard Smith76c2f2c2015-07-17 20:09:43 +0000848 if (HadMacroDefinition) {
Justin Bogner57ba0b22014-03-28 22:03:24 +0000849 uint32_t MacroDirectivesOffset =
850 endian::readNext<uint32_t, little, unaligned>(d);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +0000851 DataLen -= 4;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +0000852
Richard Smithd7329392015-04-21 21:46:32 +0000853 Reader.addPendingMacro(II, &F, MacroDirectivesOffset);
Guy Benyei11169dd2012-12-18 14:30:41 +0000854 }
855
856 Reader.SetIdentifierInfo(ID, II);
857
858 // Read all of the declarations visible at global scope with this
859 // name.
860 if (DataLen > 0) {
861 SmallVector<uint32_t, 4> DeclIDs;
862 for (; DataLen > 0; DataLen -= 4)
Justin Bogner57ba0b22014-03-28 22:03:24 +0000863 DeclIDs.push_back(Reader.getGlobalDeclID(
864 F, endian::readNext<uint32_t, little, unaligned>(d)));
Guy Benyei11169dd2012-12-18 14:30:41 +0000865 Reader.SetGloballyVisibleDecls(II, DeclIDs);
866 }
867
868 return II;
869}
870
Richard Smitha06c7e62015-08-26 23:55:49 +0000871DeclarationNameKey::DeclarationNameKey(DeclarationName Name)
872 : Kind(Name.getNameKind()) {
873 switch (Kind) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000874 case DeclarationName::Identifier:
Richard Smitha06c7e62015-08-26 23:55:49 +0000875 Data = (uint64_t)Name.getAsIdentifierInfo();
Guy Benyei11169dd2012-12-18 14:30:41 +0000876 break;
877 case DeclarationName::ObjCZeroArgSelector:
878 case DeclarationName::ObjCOneArgSelector:
879 case DeclarationName::ObjCMultiArgSelector:
Richard Smitha06c7e62015-08-26 23:55:49 +0000880 Data = (uint64_t)Name.getObjCSelector().getAsOpaquePtr();
Guy Benyei11169dd2012-12-18 14:30:41 +0000881 break;
882 case DeclarationName::CXXOperatorName:
Richard Smitha06c7e62015-08-26 23:55:49 +0000883 Data = Name.getCXXOverloadedOperator();
884 break;
885 case DeclarationName::CXXLiteralOperatorName:
886 Data = (uint64_t)Name.getCXXLiteralIdentifier();
887 break;
888 case DeclarationName::CXXConstructorName:
889 case DeclarationName::CXXDestructorName:
890 case DeclarationName::CXXConversionFunctionName:
891 case DeclarationName::CXXUsingDirective:
892 Data = 0;
893 break;
894 }
895}
896
897unsigned DeclarationNameKey::getHash() const {
898 llvm::FoldingSetNodeID ID;
899 ID.AddInteger(Kind);
900
901 switch (Kind) {
902 case DeclarationName::Identifier:
903 case DeclarationName::CXXLiteralOperatorName:
904 ID.AddString(((IdentifierInfo*)Data)->getName());
905 break;
906 case DeclarationName::ObjCZeroArgSelector:
907 case DeclarationName::ObjCOneArgSelector:
908 case DeclarationName::ObjCMultiArgSelector:
909 ID.AddInteger(serialization::ComputeHash(Selector(Data)));
910 break;
911 case DeclarationName::CXXOperatorName:
912 ID.AddInteger((OverloadedOperatorKind)Data);
Guy Benyei11169dd2012-12-18 14:30:41 +0000913 break;
914 case DeclarationName::CXXConstructorName:
915 case DeclarationName::CXXDestructorName:
916 case DeclarationName::CXXConversionFunctionName:
917 case DeclarationName::CXXUsingDirective:
918 break;
919 }
920
921 return ID.ComputeHash();
922}
923
Richard Smithd88a7f12015-09-01 20:35:42 +0000924ModuleFile *
925ASTDeclContextNameLookupTrait::ReadFileRef(const unsigned char *&d) {
926 using namespace llvm::support;
927 uint32_t ModuleFileID = endian::readNext<uint32_t, little, unaligned>(d);
928 return Reader.getLocalModuleFile(F, ModuleFileID);
929}
930
Guy Benyei11169dd2012-12-18 14:30:41 +0000931std::pair<unsigned, unsigned>
Richard Smitha06c7e62015-08-26 23:55:49 +0000932ASTDeclContextNameLookupTrait::ReadKeyDataLength(const unsigned char *&d) {
Justin Bogner57ba0b22014-03-28 22:03:24 +0000933 using namespace llvm::support;
934 unsigned KeyLen = endian::readNext<uint16_t, little, unaligned>(d);
935 unsigned DataLen = endian::readNext<uint16_t, little, unaligned>(d);
Guy Benyei11169dd2012-12-18 14:30:41 +0000936 return std::make_pair(KeyLen, DataLen);
937}
938
Richard Smitha06c7e62015-08-26 23:55:49 +0000939ASTDeclContextNameLookupTrait::internal_key_type
940ASTDeclContextNameLookupTrait::ReadKey(const unsigned char *d, unsigned) {
Justin Bogner57ba0b22014-03-28 22:03:24 +0000941 using namespace llvm::support;
Guy Benyei11169dd2012-12-18 14:30:41 +0000942
Richard Smitha06c7e62015-08-26 23:55:49 +0000943 auto Kind = (DeclarationName::NameKind)*d++;
944 uint64_t Data;
945 switch (Kind) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000946 case DeclarationName::Identifier:
Richard Smitha06c7e62015-08-26 23:55:49 +0000947 Data = (uint64_t)Reader.getLocalIdentifier(
Justin Bogner57ba0b22014-03-28 22:03:24 +0000948 F, endian::readNext<uint32_t, little, unaligned>(d));
Guy Benyei11169dd2012-12-18 14:30:41 +0000949 break;
950 case DeclarationName::ObjCZeroArgSelector:
951 case DeclarationName::ObjCOneArgSelector:
952 case DeclarationName::ObjCMultiArgSelector:
Richard Smitha06c7e62015-08-26 23:55:49 +0000953 Data =
Justin Bogner57ba0b22014-03-28 22:03:24 +0000954 (uint64_t)Reader.getLocalSelector(
955 F, endian::readNext<uint32_t, little, unaligned>(
956 d)).getAsOpaquePtr();
Guy Benyei11169dd2012-12-18 14:30:41 +0000957 break;
958 case DeclarationName::CXXOperatorName:
Richard Smitha06c7e62015-08-26 23:55:49 +0000959 Data = *d++; // OverloadedOperatorKind
Guy Benyei11169dd2012-12-18 14:30:41 +0000960 break;
961 case DeclarationName::CXXLiteralOperatorName:
Richard Smitha06c7e62015-08-26 23:55:49 +0000962 Data = (uint64_t)Reader.getLocalIdentifier(
Justin Bogner57ba0b22014-03-28 22:03:24 +0000963 F, endian::readNext<uint32_t, little, unaligned>(d));
Guy Benyei11169dd2012-12-18 14:30:41 +0000964 break;
965 case DeclarationName::CXXConstructorName:
966 case DeclarationName::CXXDestructorName:
967 case DeclarationName::CXXConversionFunctionName:
968 case DeclarationName::CXXUsingDirective:
Richard Smitha06c7e62015-08-26 23:55:49 +0000969 Data = 0;
Guy Benyei11169dd2012-12-18 14:30:41 +0000970 break;
971 }
972
Richard Smitha06c7e62015-08-26 23:55:49 +0000973 return DeclarationNameKey(Kind, Data);
Guy Benyei11169dd2012-12-18 14:30:41 +0000974}
975
Richard Smithd88a7f12015-09-01 20:35:42 +0000976void ASTDeclContextNameLookupTrait::ReadDataInto(internal_key_type,
977 const unsigned char *d,
978 unsigned DataLen,
979 data_type_builder &Val) {
Justin Bogner57ba0b22014-03-28 22:03:24 +0000980 using namespace llvm::support;
Richard Smithd88a7f12015-09-01 20:35:42 +0000981 for (unsigned NumDecls = DataLen / 4; NumDecls; --NumDecls) {
982 uint32_t LocalID = endian::readNext<uint32_t, little, unaligned>(d);
983 Val.insert(Reader.getGlobalDeclID(F, LocalID));
984 }
Guy Benyei11169dd2012-12-18 14:30:41 +0000985}
986
Richard Smith0f4e2c42015-08-06 04:23:48 +0000987bool ASTReader::ReadLexicalDeclContextStorage(ModuleFile &M,
988 BitstreamCursor &Cursor,
989 uint64_t Offset,
990 DeclContext *DC) {
991 assert(Offset != 0);
992
Guy Benyei11169dd2012-12-18 14:30:41 +0000993 SavedStreamPosition SavedPosition(Cursor);
Richard Smith0f4e2c42015-08-06 04:23:48 +0000994 Cursor.JumpToBit(Offset);
Guy Benyei11169dd2012-12-18 14:30:41 +0000995
Richard Smith0f4e2c42015-08-06 04:23:48 +0000996 RecordData Record;
997 StringRef Blob;
998 unsigned Code = Cursor.ReadCode();
999 unsigned RecCode = Cursor.readRecord(Code, Record, &Blob);
1000 if (RecCode != DECL_CONTEXT_LEXICAL) {
1001 Error("Expected lexical block");
1002 return true;
Guy Benyei11169dd2012-12-18 14:30:41 +00001003 }
1004
Richard Smith82f8fcd2015-08-06 22:07:25 +00001005 assert(!isa<TranslationUnitDecl>(DC) &&
1006 "expected a TU_UPDATE_LEXICAL record for TU");
Richard Smith9c9173d2015-08-11 22:00:24 +00001007 // If we are handling a C++ class template instantiation, we can see multiple
1008 // lexical updates for the same record. It's important that we select only one
1009 // of them, so that field numbering works properly. Just pick the first one we
1010 // see.
1011 auto &Lex = LexicalDecls[DC];
1012 if (!Lex.first) {
1013 Lex = std::make_pair(
1014 &M, llvm::makeArrayRef(
1015 reinterpret_cast<const llvm::support::unaligned_uint32_t *>(
1016 Blob.data()),
1017 Blob.size() / 4));
1018 }
Richard Smith0f4e2c42015-08-06 04:23:48 +00001019 DC->setHasExternalLexicalStorage(true);
1020 return false;
1021}
Guy Benyei11169dd2012-12-18 14:30:41 +00001022
Richard Smith0f4e2c42015-08-06 04:23:48 +00001023bool ASTReader::ReadVisibleDeclContextStorage(ModuleFile &M,
1024 BitstreamCursor &Cursor,
1025 uint64_t Offset,
1026 DeclID ID) {
1027 assert(Offset != 0);
1028
1029 SavedStreamPosition SavedPosition(Cursor);
1030 Cursor.JumpToBit(Offset);
1031
1032 RecordData Record;
1033 StringRef Blob;
1034 unsigned Code = Cursor.ReadCode();
1035 unsigned RecCode = Cursor.readRecord(Code, Record, &Blob);
1036 if (RecCode != DECL_CONTEXT_VISIBLE) {
1037 Error("Expected visible lookup table block");
1038 return true;
Guy Benyei11169dd2012-12-18 14:30:41 +00001039 }
1040
Richard Smith0f4e2c42015-08-06 04:23:48 +00001041 // We can't safely determine the primary context yet, so delay attaching the
1042 // lookup table until we're done with recursive deserialization.
Richard Smithd88a7f12015-09-01 20:35:42 +00001043 auto *Data = (const unsigned char*)Blob.data();
1044 PendingVisibleUpdates[ID].push_back(PendingVisibleUpdate{&M, Data});
Guy Benyei11169dd2012-12-18 14:30:41 +00001045 return false;
1046}
1047
1048void ASTReader::Error(StringRef Msg) {
1049 Error(diag::err_fe_pch_malformed, Msg);
Richard Smithfb1e7f72015-08-14 05:02:58 +00001050 if (Context.getLangOpts().Modules && !Diags.isDiagnosticInFlight() &&
1051 !PP.getHeaderSearchInfo().getModuleCachePath().empty()) {
Douglas Gregor940e8052013-05-10 22:15:13 +00001052 Diag(diag::note_module_cache_path)
1053 << PP.getHeaderSearchInfo().getModuleCachePath();
1054 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001055}
1056
1057void ASTReader::Error(unsigned DiagID,
1058 StringRef Arg1, StringRef Arg2) {
1059 if (Diags.isDiagnosticInFlight())
1060 Diags.SetDelayedDiagnostic(DiagID, Arg1, Arg2);
1061 else
1062 Diag(DiagID) << Arg1 << Arg2;
1063}
1064
1065//===----------------------------------------------------------------------===//
1066// Source Manager Deserialization
1067//===----------------------------------------------------------------------===//
1068
1069/// \brief Read the line table in the source manager block.
1070/// \returns true if there was an error.
1071bool ASTReader::ParseLineTable(ModuleFile &F,
Richard Smith7ed1bc92014-12-05 22:42:13 +00001072 const RecordData &Record) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001073 unsigned Idx = 0;
1074 LineTableInfo &LineTable = SourceMgr.getLineTable();
1075
1076 // Parse the file names
1077 std::map<int, int> FileIDs;
Richard Smith63078492015-09-01 07:41:55 +00001078 for (unsigned I = 0; Record[Idx]; ++I) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001079 // Extract the file name
Richard Smith7ed1bc92014-12-05 22:42:13 +00001080 auto Filename = ReadPath(F, Record, Idx);
Guy Benyei11169dd2012-12-18 14:30:41 +00001081 FileIDs[I] = LineTable.getLineTableFilenameID(Filename);
1082 }
Richard Smith63078492015-09-01 07:41:55 +00001083 ++Idx;
Guy Benyei11169dd2012-12-18 14:30:41 +00001084
1085 // Parse the line entries
1086 std::vector<LineEntry> Entries;
1087 while (Idx < Record.size()) {
1088 int FID = Record[Idx++];
1089 assert(FID >= 0 && "Serialized line entries for non-local file.");
1090 // Remap FileID from 1-based old view.
1091 FID += F.SLocEntryBaseID - 1;
1092
1093 // Extract the line entries
1094 unsigned NumEntries = Record[Idx++];
Richard Smith63078492015-09-01 07:41:55 +00001095 assert(NumEntries && "no line entries for file ID");
Guy Benyei11169dd2012-12-18 14:30:41 +00001096 Entries.clear();
1097 Entries.reserve(NumEntries);
1098 for (unsigned I = 0; I != NumEntries; ++I) {
1099 unsigned FileOffset = Record[Idx++];
1100 unsigned LineNo = Record[Idx++];
1101 int FilenameID = FileIDs[Record[Idx++]];
1102 SrcMgr::CharacteristicKind FileKind
1103 = (SrcMgr::CharacteristicKind)Record[Idx++];
1104 unsigned IncludeOffset = Record[Idx++];
1105 Entries.push_back(LineEntry::get(FileOffset, LineNo, FilenameID,
1106 FileKind, IncludeOffset));
1107 }
1108 LineTable.AddEntry(FileID::get(FID), Entries);
1109 }
1110
1111 return false;
1112}
1113
1114/// \brief Read a source manager block
1115bool ASTReader::ReadSourceManagerBlock(ModuleFile &F) {
1116 using namespace SrcMgr;
1117
Chris Lattner7fb3bef2013-01-20 00:56:42 +00001118 BitstreamCursor &SLocEntryCursor = F.SLocEntryCursor;
Guy Benyei11169dd2012-12-18 14:30:41 +00001119
1120 // Set the source-location entry cursor to the current position in
1121 // the stream. This cursor will be used to read the contents of the
1122 // source manager block initially, and then lazily read
1123 // source-location entries as needed.
1124 SLocEntryCursor = F.Stream;
1125
1126 // The stream itself is going to skip over the source manager block.
1127 if (F.Stream.SkipBlock()) {
1128 Error("malformed block record in AST file");
1129 return true;
1130 }
1131
1132 // Enter the source manager block.
1133 if (SLocEntryCursor.EnterSubBlock(SOURCE_MANAGER_BLOCK_ID)) {
1134 Error("malformed source manager block record in AST file");
1135 return true;
1136 }
1137
1138 RecordData Record;
1139 while (true) {
Chris Lattnere7b154b2013-01-19 21:39:22 +00001140 llvm::BitstreamEntry E = SLocEntryCursor.advanceSkippingSubblocks();
1141
1142 switch (E.Kind) {
1143 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
1144 case llvm::BitstreamEntry::Error:
1145 Error("malformed block record in AST file");
1146 return true;
1147 case llvm::BitstreamEntry::EndBlock:
Guy Benyei11169dd2012-12-18 14:30:41 +00001148 return false;
Chris Lattnere7b154b2013-01-19 21:39:22 +00001149 case llvm::BitstreamEntry::Record:
1150 // The interesting case.
1151 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001152 }
Chris Lattnere7b154b2013-01-19 21:39:22 +00001153
Guy Benyei11169dd2012-12-18 14:30:41 +00001154 // Read a record.
Guy Benyei11169dd2012-12-18 14:30:41 +00001155 Record.clear();
Chris Lattner15c3e7d2013-01-21 18:28:26 +00001156 StringRef Blob;
1157 switch (SLocEntryCursor.readRecord(E.ID, Record, &Blob)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001158 default: // Default behavior: ignore.
1159 break;
1160
1161 case SM_SLOC_FILE_ENTRY:
1162 case SM_SLOC_BUFFER_ENTRY:
1163 case SM_SLOC_EXPANSION_ENTRY:
1164 // Once we hit one of the source location entries, we're done.
1165 return false;
1166 }
1167 }
1168}
1169
1170/// \brief If a header file is not found at the path that we expect it to be
1171/// and the PCH file was moved from its original location, try to resolve the
1172/// file by assuming that header+PCH were moved together and the header is in
1173/// the same place relative to the PCH.
1174static std::string
1175resolveFileRelativeToOriginalDir(const std::string &Filename,
1176 const std::string &OriginalDir,
1177 const std::string &CurrDir) {
1178 assert(OriginalDir != CurrDir &&
1179 "No point trying to resolve the file if the PCH dir didn't change");
1180 using namespace llvm::sys;
1181 SmallString<128> filePath(Filename);
1182 fs::make_absolute(filePath);
1183 assert(path::is_absolute(OriginalDir));
1184 SmallString<128> currPCHPath(CurrDir);
1185
1186 path::const_iterator fileDirI = path::begin(path::parent_path(filePath)),
1187 fileDirE = path::end(path::parent_path(filePath));
1188 path::const_iterator origDirI = path::begin(OriginalDir),
1189 origDirE = path::end(OriginalDir);
1190 // Skip the common path components from filePath and OriginalDir.
1191 while (fileDirI != fileDirE && origDirI != origDirE &&
1192 *fileDirI == *origDirI) {
1193 ++fileDirI;
1194 ++origDirI;
1195 }
1196 for (; origDirI != origDirE; ++origDirI)
1197 path::append(currPCHPath, "..");
1198 path::append(currPCHPath, fileDirI, fileDirE);
1199 path::append(currPCHPath, path::filename(Filename));
1200 return currPCHPath.str();
1201}
1202
1203bool ASTReader::ReadSLocEntry(int ID) {
1204 if (ID == 0)
1205 return false;
1206
1207 if (unsigned(-ID) - 2 >= getTotalNumSLocs() || ID > 0) {
1208 Error("source location entry ID out-of-range for AST file");
1209 return true;
1210 }
1211
Richard Smithaada85c2016-02-06 02:06:43 +00001212 // Local helper to read the (possibly-compressed) buffer data following the
1213 // entry record.
1214 auto ReadBuffer = [this](
1215 BitstreamCursor &SLocEntryCursor,
1216 StringRef Name) -> std::unique_ptr<llvm::MemoryBuffer> {
1217 RecordData Record;
1218 StringRef Blob;
1219 unsigned Code = SLocEntryCursor.ReadCode();
1220 unsigned RecCode = SLocEntryCursor.readRecord(Code, Record, &Blob);
1221
1222 if (RecCode == SM_SLOC_BUFFER_BLOB_COMPRESSED) {
1223 SmallString<0> Uncompressed;
1224 if (llvm::zlib::uncompress(Blob, Uncompressed, Record[0]) !=
1225 llvm::zlib::StatusOK) {
1226 Error("could not decompress embedded file contents");
1227 return nullptr;
1228 }
1229 return llvm::MemoryBuffer::getMemBufferCopy(Uncompressed, Name);
1230 } else if (RecCode == SM_SLOC_BUFFER_BLOB) {
1231 return llvm::MemoryBuffer::getMemBuffer(Blob.drop_back(1), Name, true);
1232 } else {
1233 Error("AST record has invalid code");
1234 return nullptr;
1235 }
1236 };
1237
Guy Benyei11169dd2012-12-18 14:30:41 +00001238 ModuleFile *F = GlobalSLocEntryMap.find(-ID)->second;
1239 F->SLocEntryCursor.JumpToBit(F->SLocEntryOffsets[ID - F->SLocEntryBaseID]);
Chris Lattner7fb3bef2013-01-20 00:56:42 +00001240 BitstreamCursor &SLocEntryCursor = F->SLocEntryCursor;
Guy Benyei11169dd2012-12-18 14:30:41 +00001241 unsigned BaseOffset = F->SLocEntryBaseOffset;
1242
1243 ++NumSLocEntriesRead;
Chris Lattnere7b154b2013-01-19 21:39:22 +00001244 llvm::BitstreamEntry Entry = SLocEntryCursor.advance();
1245 if (Entry.Kind != llvm::BitstreamEntry::Record) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001246 Error("incorrectly-formatted source location entry in AST file");
1247 return true;
1248 }
Chris Lattnere7b154b2013-01-19 21:39:22 +00001249
Guy Benyei11169dd2012-12-18 14:30:41 +00001250 RecordData Record;
Chris Lattner0e6c9402013-01-20 02:38:54 +00001251 StringRef Blob;
1252 switch (SLocEntryCursor.readRecord(Entry.ID, Record, &Blob)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001253 default:
1254 Error("incorrectly-formatted source location entry in AST file");
1255 return true;
1256
1257 case SM_SLOC_FILE_ENTRY: {
1258 // We will detect whether a file changed and return 'Failure' for it, but
1259 // we will also try to fail gracefully by setting up the SLocEntry.
1260 unsigned InputID = Record[4];
1261 InputFile IF = getInputFile(*F, InputID);
Argyrios Kyrtzidis61c3d872013-03-01 03:26:04 +00001262 const FileEntry *File = IF.getFile();
1263 bool OverriddenBuffer = IF.isOverridden();
Guy Benyei11169dd2012-12-18 14:30:41 +00001264
Argyrios Kyrtzidis61c3d872013-03-01 03:26:04 +00001265 // Note that we only check if a File was returned. If it was out-of-date
1266 // we have complained but we will continue creating a FileID to recover
1267 // gracefully.
1268 if (!File)
Guy Benyei11169dd2012-12-18 14:30:41 +00001269 return true;
1270
1271 SourceLocation IncludeLoc = ReadSourceLocation(*F, Record[1]);
1272 if (IncludeLoc.isInvalid() && F->Kind != MK_MainFile) {
1273 // This is the module's main file.
1274 IncludeLoc = getImportLocation(F);
1275 }
1276 SrcMgr::CharacteristicKind
1277 FileCharacter = (SrcMgr::CharacteristicKind)Record[2];
1278 FileID FID = SourceMgr.createFileID(File, IncludeLoc, FileCharacter,
1279 ID, BaseOffset + Record[0]);
1280 SrcMgr::FileInfo &FileInfo =
1281 const_cast<SrcMgr::FileInfo&>(SourceMgr.getSLocEntry(FID).getFile());
1282 FileInfo.NumCreatedFIDs = Record[5];
1283 if (Record[3])
1284 FileInfo.setHasLineDirectives();
1285
1286 const DeclID *FirstDecl = F->FileSortedDecls + Record[6];
1287 unsigned NumFileDecls = Record[7];
1288 if (NumFileDecls) {
1289 assert(F->FileSortedDecls && "FILE_SORTED_DECLS not encountered yet ?");
1290 FileDeclIDs[FID] = FileDeclsInfo(F, llvm::makeArrayRef(FirstDecl,
1291 NumFileDecls));
1292 }
Richard Smithaada85c2016-02-06 02:06:43 +00001293
Guy Benyei11169dd2012-12-18 14:30:41 +00001294 const SrcMgr::ContentCache *ContentCache
1295 = SourceMgr.getOrCreateContentCache(File,
1296 /*isSystemFile=*/FileCharacter != SrcMgr::C_User);
1297 if (OverriddenBuffer && !ContentCache->BufferOverridden &&
Richard Smitha8cfffa2015-11-26 02:04:16 +00001298 ContentCache->ContentsEntry == ContentCache->OrigEntry &&
1299 !ContentCache->getRawBuffer()) {
Richard Smithaada85c2016-02-06 02:06:43 +00001300 auto Buffer = ReadBuffer(SLocEntryCursor, File->getName());
1301 if (!Buffer)
Guy Benyei11169dd2012-12-18 14:30:41 +00001302 return true;
David Blaikie49cc3182014-08-27 20:54:45 +00001303 SourceMgr.overrideFileContents(File, std::move(Buffer));
Guy Benyei11169dd2012-12-18 14:30:41 +00001304 }
1305
1306 break;
1307 }
1308
1309 case SM_SLOC_BUFFER_ENTRY: {
Chris Lattner0e6c9402013-01-20 02:38:54 +00001310 const char *Name = Blob.data();
Guy Benyei11169dd2012-12-18 14:30:41 +00001311 unsigned Offset = Record[0];
1312 SrcMgr::CharacteristicKind
1313 FileCharacter = (SrcMgr::CharacteristicKind)Record[2];
1314 SourceLocation IncludeLoc = ReadSourceLocation(*F, Record[1]);
Richard Smithe842a472014-10-22 02:05:46 +00001315 if (IncludeLoc.isInvalid() &&
1316 (F->Kind == MK_ImplicitModule || F->Kind == MK_ExplicitModule)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001317 IncludeLoc = getImportLocation(F);
1318 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001319
Richard Smithaada85c2016-02-06 02:06:43 +00001320 auto Buffer = ReadBuffer(SLocEntryCursor, Name);
1321 if (!Buffer)
Guy Benyei11169dd2012-12-18 14:30:41 +00001322 return true;
David Blaikie50a5f972014-08-29 07:59:55 +00001323 SourceMgr.createFileID(std::move(Buffer), FileCharacter, ID,
Rafael Espindolad87f8d72014-08-27 20:03:29 +00001324 BaseOffset + Offset, IncludeLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00001325 break;
1326 }
1327
1328 case SM_SLOC_EXPANSION_ENTRY: {
1329 SourceLocation SpellingLoc = ReadSourceLocation(*F, Record[1]);
1330 SourceMgr.createExpansionLoc(SpellingLoc,
1331 ReadSourceLocation(*F, Record[2]),
1332 ReadSourceLocation(*F, Record[3]),
1333 Record[4],
1334 ID,
1335 BaseOffset + Record[0]);
1336 break;
1337 }
1338 }
1339
1340 return false;
1341}
1342
1343std::pair<SourceLocation, StringRef> ASTReader::getModuleImportLoc(int ID) {
1344 if (ID == 0)
1345 return std::make_pair(SourceLocation(), "");
1346
1347 if (unsigned(-ID) - 2 >= getTotalNumSLocs() || ID > 0) {
1348 Error("source location entry ID out-of-range for AST file");
1349 return std::make_pair(SourceLocation(), "");
1350 }
1351
1352 // Find which module file this entry lands in.
1353 ModuleFile *M = GlobalSLocEntryMap.find(-ID)->second;
Richard Smithe842a472014-10-22 02:05:46 +00001354 if (M->Kind != MK_ImplicitModule && M->Kind != MK_ExplicitModule)
Guy Benyei11169dd2012-12-18 14:30:41 +00001355 return std::make_pair(SourceLocation(), "");
1356
1357 // FIXME: Can we map this down to a particular submodule? That would be
1358 // ideal.
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001359 return std::make_pair(M->ImportLoc, StringRef(M->ModuleName));
Guy Benyei11169dd2012-12-18 14:30:41 +00001360}
1361
1362/// \brief Find the location where the module F is imported.
1363SourceLocation ASTReader::getImportLocation(ModuleFile *F) {
1364 if (F->ImportLoc.isValid())
1365 return F->ImportLoc;
1366
1367 // Otherwise we have a PCH. It's considered to be "imported" at the first
1368 // location of its includer.
1369 if (F->ImportedBy.empty() || !F->ImportedBy[0]) {
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001370 // Main file is the importer.
Yaron Keren8b563662015-10-03 10:46:20 +00001371 assert(SourceMgr.getMainFileID().isValid() && "missing main file");
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001372 return SourceMgr.getLocForStartOfFile(SourceMgr.getMainFileID());
Guy Benyei11169dd2012-12-18 14:30:41 +00001373 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001374 return F->ImportedBy[0]->FirstLoc;
1375}
1376
1377/// ReadBlockAbbrevs - Enter a subblock of the specified BlockID with the
1378/// specified cursor. Read the abbreviations that are at the top of the block
1379/// and then leave the cursor pointing into the block.
Chris Lattner7fb3bef2013-01-20 00:56:42 +00001380bool ASTReader::ReadBlockAbbrevs(BitstreamCursor &Cursor, unsigned BlockID) {
Richard Smith0516b182015-09-08 19:40:14 +00001381 if (Cursor.EnterSubBlock(BlockID))
1382 return true;
Guy Benyei11169dd2012-12-18 14:30:41 +00001383
1384 while (true) {
1385 uint64_t Offset = Cursor.GetCurrentBitNo();
1386 unsigned Code = Cursor.ReadCode();
1387
1388 // We expect all abbrevs to be at the start of the block.
1389 if (Code != llvm::bitc::DEFINE_ABBREV) {
1390 Cursor.JumpToBit(Offset);
1391 return false;
1392 }
1393 Cursor.ReadAbbrevRecord();
1394 }
1395}
1396
Richard Smithe40f2ba2013-08-07 21:41:30 +00001397Token ASTReader::ReadToken(ModuleFile &F, const RecordDataImpl &Record,
John McCallf413f5e2013-05-03 00:10:13 +00001398 unsigned &Idx) {
1399 Token Tok;
1400 Tok.startToken();
1401 Tok.setLocation(ReadSourceLocation(F, Record, Idx));
1402 Tok.setLength(Record[Idx++]);
1403 if (IdentifierInfo *II = getLocalIdentifier(F, Record[Idx++]))
1404 Tok.setIdentifierInfo(II);
1405 Tok.setKind((tok::TokenKind)Record[Idx++]);
1406 Tok.setFlag((Token::TokenFlags)Record[Idx++]);
1407 return Tok;
1408}
1409
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001410MacroInfo *ASTReader::ReadMacroRecord(ModuleFile &F, uint64_t Offset) {
Chris Lattner7fb3bef2013-01-20 00:56:42 +00001411 BitstreamCursor &Stream = F.MacroCursor;
Guy Benyei11169dd2012-12-18 14:30:41 +00001412
1413 // Keep track of where we are in the stream, then jump back there
1414 // after reading this macro.
1415 SavedStreamPosition SavedPosition(Stream);
1416
1417 Stream.JumpToBit(Offset);
1418 RecordData Record;
1419 SmallVector<IdentifierInfo*, 16> MacroArgs;
Craig Toppera13603a2014-05-22 05:54:18 +00001420 MacroInfo *Macro = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00001421
Guy Benyei11169dd2012-12-18 14:30:41 +00001422 while (true) {
Chris Lattnerefa77172013-01-20 00:00:22 +00001423 // Advance to the next record, but if we get to the end of the block, don't
1424 // pop it (removing all the abbreviations from the cursor) since we want to
1425 // be able to reseek within the block and read entries.
Chris Lattner7fb3bef2013-01-20 00:56:42 +00001426 unsigned Flags = BitstreamCursor::AF_DontPopBlockAtEnd;
Chris Lattnerefa77172013-01-20 00:00:22 +00001427 llvm::BitstreamEntry Entry = Stream.advanceSkippingSubblocks(Flags);
1428
1429 switch (Entry.Kind) {
1430 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
1431 case llvm::BitstreamEntry::Error:
1432 Error("malformed block record in AST file");
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001433 return Macro;
Chris Lattnerefa77172013-01-20 00:00:22 +00001434 case llvm::BitstreamEntry::EndBlock:
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001435 return Macro;
Chris Lattnerefa77172013-01-20 00:00:22 +00001436 case llvm::BitstreamEntry::Record:
1437 // The interesting case.
1438 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001439 }
1440
1441 // Read a record.
Guy Benyei11169dd2012-12-18 14:30:41 +00001442 Record.clear();
1443 PreprocessorRecordTypes RecType =
Chris Lattner0e6c9402013-01-20 02:38:54 +00001444 (PreprocessorRecordTypes)Stream.readRecord(Entry.ID, Record);
Guy Benyei11169dd2012-12-18 14:30:41 +00001445 switch (RecType) {
Richard Smithd7329392015-04-21 21:46:32 +00001446 case PP_MODULE_MACRO:
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001447 case PP_MACRO_DIRECTIVE_HISTORY:
1448 return Macro;
1449
Guy Benyei11169dd2012-12-18 14:30:41 +00001450 case PP_MACRO_OBJECT_LIKE:
1451 case PP_MACRO_FUNCTION_LIKE: {
1452 // If we already have a macro, that means that we've hit the end
1453 // of the definition of the macro we were looking for. We're
1454 // done.
1455 if (Macro)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001456 return Macro;
Guy Benyei11169dd2012-12-18 14:30:41 +00001457
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001458 unsigned NextIndex = 1; // Skip identifier ID.
1459 SubmoduleID SubModID = getGlobalSubmoduleID(F, Record[NextIndex++]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001460 SourceLocation Loc = ReadSourceLocation(F, Record, NextIndex);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001461 MacroInfo *MI = PP.AllocateDeserializedMacroInfo(Loc, SubModID);
Argyrios Kyrtzidis7572be22013-01-07 19:16:23 +00001462 MI->setDefinitionEndLoc(ReadSourceLocation(F, Record, NextIndex));
Guy Benyei11169dd2012-12-18 14:30:41 +00001463 MI->setIsUsed(Record[NextIndex++]);
Argyrios Kyrtzidis9ef53ce2014-04-09 18:21:23 +00001464 MI->setUsedForHeaderGuard(Record[NextIndex++]);
Guy Benyei11169dd2012-12-18 14:30:41 +00001465
Guy Benyei11169dd2012-12-18 14:30:41 +00001466 if (RecType == PP_MACRO_FUNCTION_LIKE) {
1467 // Decode function-like macro info.
1468 bool isC99VarArgs = Record[NextIndex++];
1469 bool isGNUVarArgs = Record[NextIndex++];
1470 bool hasCommaPasting = Record[NextIndex++];
1471 MacroArgs.clear();
1472 unsigned NumArgs = Record[NextIndex++];
1473 for (unsigned i = 0; i != NumArgs; ++i)
1474 MacroArgs.push_back(getLocalIdentifier(F, Record[NextIndex++]));
1475
1476 // Install function-like macro info.
1477 MI->setIsFunctionLike();
1478 if (isC99VarArgs) MI->setIsC99Varargs();
1479 if (isGNUVarArgs) MI->setIsGNUVarargs();
1480 if (hasCommaPasting) MI->setHasCommaPasting();
Craig Topperd96b3f92015-10-22 04:59:52 +00001481 MI->setArgumentList(MacroArgs, PP.getPreprocessorAllocator());
Guy Benyei11169dd2012-12-18 14:30:41 +00001482 }
1483
Guy Benyei11169dd2012-12-18 14:30:41 +00001484 // Remember that we saw this macro last so that we add the tokens that
1485 // form its body to it.
1486 Macro = MI;
1487
1488 if (NextIndex + 1 == Record.size() && PP.getPreprocessingRecord() &&
1489 Record[NextIndex]) {
1490 // We have a macro definition. Register the association
1491 PreprocessedEntityID
1492 GlobalID = getGlobalPreprocessedEntityID(F, Record[NextIndex]);
1493 PreprocessingRecord &PPRec = *PP.getPreprocessingRecord();
Richard Smith66a81862015-05-04 02:25:31 +00001494 PreprocessingRecord::PPEntityID PPID =
1495 PPRec.getPPEntityID(GlobalID - 1, /*isLoaded=*/true);
1496 MacroDefinitionRecord *PPDef = cast_or_null<MacroDefinitionRecord>(
1497 PPRec.getPreprocessedEntity(PPID));
Argyrios Kyrtzidis832de9f2013-02-22 18:35:59 +00001498 if (PPDef)
1499 PPRec.RegisterMacroDefinition(Macro, PPDef);
Guy Benyei11169dd2012-12-18 14:30:41 +00001500 }
1501
1502 ++NumMacrosRead;
1503 break;
1504 }
1505
1506 case PP_TOKEN: {
1507 // If we see a TOKEN before a PP_MACRO_*, then the file is
1508 // erroneous, just pretend we didn't see this.
Craig Toppera13603a2014-05-22 05:54:18 +00001509 if (!Macro) break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001510
John McCallf413f5e2013-05-03 00:10:13 +00001511 unsigned Idx = 0;
1512 Token Tok = ReadToken(F, Record, Idx);
Guy Benyei11169dd2012-12-18 14:30:41 +00001513 Macro->AddTokenToBody(Tok);
1514 break;
1515 }
1516 }
1517 }
1518}
1519
1520PreprocessedEntityID
1521ASTReader::getGlobalPreprocessedEntityID(ModuleFile &M, unsigned LocalID) const {
1522 ContinuousRangeMap<uint32_t, int, 2>::const_iterator
1523 I = M.PreprocessedEntityRemap.find(LocalID - NUM_PREDEF_PP_ENTITY_IDS);
1524 assert(I != M.PreprocessedEntityRemap.end()
1525 && "Invalid index into preprocessed entity index remap");
1526
1527 return LocalID + I->second;
1528}
1529
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001530unsigned HeaderFileInfoTrait::ComputeHash(internal_key_ref ikey) {
1531 return llvm::hash_combine(ikey.Size, ikey.ModTime);
Guy Benyei11169dd2012-12-18 14:30:41 +00001532}
Richard Smith7ed1bc92014-12-05 22:42:13 +00001533
Guy Benyei11169dd2012-12-18 14:30:41 +00001534HeaderFileInfoTrait::internal_key_type
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001535HeaderFileInfoTrait::GetInternalKey(const FileEntry *FE) {
Richard Smithe75ee0f2015-08-17 07:13:32 +00001536 internal_key_type ikey = {FE->getSize(),
1537 M.HasTimestamps ? FE->getModificationTime() : 0,
1538 FE->getName(), /*Imported*/ false};
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001539 return ikey;
1540}
Guy Benyei11169dd2012-12-18 14:30:41 +00001541
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001542bool HeaderFileInfoTrait::EqualKey(internal_key_ref a, internal_key_ref b) {
Richard Smithe75ee0f2015-08-17 07:13:32 +00001543 if (a.Size != b.Size || (a.ModTime && b.ModTime && a.ModTime != b.ModTime))
Guy Benyei11169dd2012-12-18 14:30:41 +00001544 return false;
1545
Richard Smith7ed1bc92014-12-05 22:42:13 +00001546 if (llvm::sys::path::is_absolute(a.Filename) &&
1547 strcmp(a.Filename, b.Filename) == 0)
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001548 return true;
1549
Guy Benyei11169dd2012-12-18 14:30:41 +00001550 // Determine whether the actual files are equivalent.
Argyrios Kyrtzidis2a513e82013-03-04 20:33:40 +00001551 FileManager &FileMgr = Reader.getFileManager();
Richard Smith7ed1bc92014-12-05 22:42:13 +00001552 auto GetFile = [&](const internal_key_type &Key) -> const FileEntry* {
1553 if (!Key.Imported)
1554 return FileMgr.getFile(Key.Filename);
1555
1556 std::string Resolved = Key.Filename;
1557 Reader.ResolveImportedPath(M, Resolved);
1558 return FileMgr.getFile(Resolved);
1559 };
1560
1561 const FileEntry *FEA = GetFile(a);
1562 const FileEntry *FEB = GetFile(b);
1563 return FEA && FEA == FEB;
Guy Benyei11169dd2012-12-18 14:30:41 +00001564}
1565
1566std::pair<unsigned, unsigned>
1567HeaderFileInfoTrait::ReadKeyDataLength(const unsigned char*& d) {
Justin Bogner57ba0b22014-03-28 22:03:24 +00001568 using namespace llvm::support;
1569 unsigned KeyLen = (unsigned) endian::readNext<uint16_t, little, unaligned>(d);
Guy Benyei11169dd2012-12-18 14:30:41 +00001570 unsigned DataLen = (unsigned) *d++;
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001571 return std::make_pair(KeyLen, DataLen);
Guy Benyei11169dd2012-12-18 14:30:41 +00001572}
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001573
1574HeaderFileInfoTrait::internal_key_type
1575HeaderFileInfoTrait::ReadKey(const unsigned char *d, unsigned) {
Justin Bogner57ba0b22014-03-28 22:03:24 +00001576 using namespace llvm::support;
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001577 internal_key_type ikey;
Justin Bogner57ba0b22014-03-28 22:03:24 +00001578 ikey.Size = off_t(endian::readNext<uint64_t, little, unaligned>(d));
1579 ikey.ModTime = time_t(endian::readNext<uint64_t, little, unaligned>(d));
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001580 ikey.Filename = (const char *)d;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001581 ikey.Imported = true;
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001582 return ikey;
1583}
1584
Guy Benyei11169dd2012-12-18 14:30:41 +00001585HeaderFileInfoTrait::data_type
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001586HeaderFileInfoTrait::ReadData(internal_key_ref key, const unsigned char *d,
Guy Benyei11169dd2012-12-18 14:30:41 +00001587 unsigned DataLen) {
1588 const unsigned char *End = d + DataLen;
Justin Bogner57ba0b22014-03-28 22:03:24 +00001589 using namespace llvm::support;
Guy Benyei11169dd2012-12-18 14:30:41 +00001590 HeaderFileInfo HFI;
1591 unsigned Flags = *d++;
Richard Smith386bb072015-08-18 23:42:23 +00001592 // FIXME: Refactor with mergeHeaderFileInfo in HeaderSearch.cpp.
1593 HFI.isImport |= (Flags >> 4) & 0x01;
1594 HFI.isPragmaOnce |= (Flags >> 3) & 0x01;
1595 HFI.DirInfo = (Flags >> 1) & 0x03;
Guy Benyei11169dd2012-12-18 14:30:41 +00001596 HFI.IndexHeaderMapHeader = Flags & 0x01;
Richard Smith386bb072015-08-18 23:42:23 +00001597 // FIXME: Find a better way to handle this. Maybe just store a
1598 // "has been included" flag?
1599 HFI.NumIncludes = std::max(endian::readNext<uint16_t, little, unaligned>(d),
1600 HFI.NumIncludes);
Justin Bogner57ba0b22014-03-28 22:03:24 +00001601 HFI.ControllingMacroID = Reader.getGlobalIdentifierID(
1602 M, endian::readNext<uint32_t, little, unaligned>(d));
1603 if (unsigned FrameworkOffset =
1604 endian::readNext<uint32_t, little, unaligned>(d)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001605 // The framework offset is 1 greater than the actual offset,
1606 // since 0 is used as an indicator for "no framework name".
1607 StringRef FrameworkName(FrameworkStrings + FrameworkOffset - 1);
1608 HFI.Framework = HS->getUniqueFrameworkName(FrameworkName);
1609 }
Richard Smith386bb072015-08-18 23:42:23 +00001610
1611 assert((End - d) % 4 == 0 &&
1612 "Wrong data length in HeaderFileInfo deserialization");
1613 while (d != End) {
Justin Bogner57ba0b22014-03-28 22:03:24 +00001614 uint32_t LocalSMID = endian::readNext<uint32_t, little, unaligned>(d);
Richard Smith386bb072015-08-18 23:42:23 +00001615 auto HeaderRole = static_cast<ModuleMap::ModuleHeaderRole>(LocalSMID & 3);
1616 LocalSMID >>= 2;
1617
1618 // This header is part of a module. Associate it with the module to enable
1619 // implicit module import.
1620 SubmoduleID GlobalSMID = Reader.getGlobalSubmoduleID(M, LocalSMID);
1621 Module *Mod = Reader.getSubmodule(GlobalSMID);
1622 FileManager &FileMgr = Reader.getFileManager();
1623 ModuleMap &ModMap =
1624 Reader.getPreprocessor().getHeaderSearchInfo().getModuleMap();
1625
1626 std::string Filename = key.Filename;
1627 if (key.Imported)
1628 Reader.ResolveImportedPath(M, Filename);
1629 // FIXME: This is not always the right filename-as-written, but we're not
1630 // going to use this information to rebuild the module, so it doesn't make
1631 // a lot of difference.
1632 Module::Header H = { key.Filename, FileMgr.getFile(Filename) };
Richard Smithd8879c82015-08-24 21:59:32 +00001633 ModMap.addHeader(Mod, H, HeaderRole, /*Imported*/true);
1634 HFI.isModuleHeader |= !(HeaderRole & ModuleMap::TextualHeader);
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001635 }
1636
Guy Benyei11169dd2012-12-18 14:30:41 +00001637 // This HeaderFileInfo was externally loaded.
1638 HFI.External = true;
Richard Smithd8879c82015-08-24 21:59:32 +00001639 HFI.IsValid = true;
Guy Benyei11169dd2012-12-18 14:30:41 +00001640 return HFI;
1641}
1642
Richard Smithd7329392015-04-21 21:46:32 +00001643void ASTReader::addPendingMacro(IdentifierInfo *II,
1644 ModuleFile *M,
1645 uint64_t MacroDirectivesOffset) {
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001646 assert(NumCurrentElementsDeserializing > 0 &&"Missing deserialization guard");
1647 PendingMacroIDs[II].push_back(PendingMacroInfo(M, MacroDirectivesOffset));
Guy Benyei11169dd2012-12-18 14:30:41 +00001648}
1649
1650void ASTReader::ReadDefinedMacros() {
1651 // Note that we are loading defined macros.
1652 Deserializing Macros(this);
1653
Pete Cooper57d3f142015-07-30 17:22:52 +00001654 for (auto &I : llvm::reverse(ModuleMgr)) {
1655 BitstreamCursor &MacroCursor = I->MacroCursor;
Guy Benyei11169dd2012-12-18 14:30:41 +00001656
1657 // If there was no preprocessor block, skip this file.
1658 if (!MacroCursor.getBitStreamReader())
1659 continue;
1660
Chris Lattner7fb3bef2013-01-20 00:56:42 +00001661 BitstreamCursor Cursor = MacroCursor;
Pete Cooper57d3f142015-07-30 17:22:52 +00001662 Cursor.JumpToBit(I->MacroStartOffset);
Guy Benyei11169dd2012-12-18 14:30:41 +00001663
1664 RecordData Record;
1665 while (true) {
Chris Lattnere7b154b2013-01-19 21:39:22 +00001666 llvm::BitstreamEntry E = Cursor.advanceSkippingSubblocks();
1667
1668 switch (E.Kind) {
1669 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
1670 case llvm::BitstreamEntry::Error:
1671 Error("malformed block record in AST file");
1672 return;
1673 case llvm::BitstreamEntry::EndBlock:
1674 goto NextCursor;
1675
1676 case llvm::BitstreamEntry::Record:
Chris Lattnere7b154b2013-01-19 21:39:22 +00001677 Record.clear();
Chris Lattner0e6c9402013-01-20 02:38:54 +00001678 switch (Cursor.readRecord(E.ID, Record)) {
Chris Lattnere7b154b2013-01-19 21:39:22 +00001679 default: // Default behavior: ignore.
1680 break;
1681
1682 case PP_MACRO_OBJECT_LIKE:
1683 case PP_MACRO_FUNCTION_LIKE:
Pete Cooper57d3f142015-07-30 17:22:52 +00001684 getLocalIdentifier(*I, Record[0]);
Chris Lattnere7b154b2013-01-19 21:39:22 +00001685 break;
1686
1687 case PP_TOKEN:
1688 // Ignore tokens.
1689 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00001690 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001691 break;
1692 }
1693 }
Chris Lattnere7b154b2013-01-19 21:39:22 +00001694 NextCursor: ;
Guy Benyei11169dd2012-12-18 14:30:41 +00001695 }
1696}
1697
1698namespace {
1699 /// \brief Visitor class used to look up identifirs in an AST file.
1700 class IdentifierLookupVisitor {
1701 StringRef Name;
Richard Smith3b637412015-07-14 18:42:41 +00001702 unsigned NameHash;
Guy Benyei11169dd2012-12-18 14:30:41 +00001703 unsigned PriorGeneration;
Douglas Gregor00a50f72013-01-25 00:38:33 +00001704 unsigned &NumIdentifierLookups;
1705 unsigned &NumIdentifierLookupHits;
Guy Benyei11169dd2012-12-18 14:30:41 +00001706 IdentifierInfo *Found;
Douglas Gregor00a50f72013-01-25 00:38:33 +00001707
Guy Benyei11169dd2012-12-18 14:30:41 +00001708 public:
Douglas Gregor00a50f72013-01-25 00:38:33 +00001709 IdentifierLookupVisitor(StringRef Name, unsigned PriorGeneration,
1710 unsigned &NumIdentifierLookups,
1711 unsigned &NumIdentifierLookupHits)
Richard Smith3b637412015-07-14 18:42:41 +00001712 : Name(Name), NameHash(ASTIdentifierLookupTrait::ComputeHash(Name)),
1713 PriorGeneration(PriorGeneration),
Douglas Gregor00a50f72013-01-25 00:38:33 +00001714 NumIdentifierLookups(NumIdentifierLookups),
1715 NumIdentifierLookupHits(NumIdentifierLookupHits),
1716 Found()
1717 {
1718 }
Benjamin Kramer9a9efba2015-07-25 12:14:04 +00001719
1720 bool operator()(ModuleFile &M) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001721 // If we've already searched this module file, skip it now.
Richard Smithbdf2d932015-07-30 03:37:16 +00001722 if (M.Generation <= PriorGeneration)
Guy Benyei11169dd2012-12-18 14:30:41 +00001723 return true;
Douglas Gregore060e572013-01-25 01:03:03 +00001724
Guy Benyei11169dd2012-12-18 14:30:41 +00001725 ASTIdentifierLookupTable *IdTable
1726 = (ASTIdentifierLookupTable *)M.IdentifierLookupTable;
1727 if (!IdTable)
1728 return false;
Benjamin Kramer9a9efba2015-07-25 12:14:04 +00001729
1730 ASTIdentifierLookupTrait Trait(IdTable->getInfoObj().getReader(), M,
Richard Smithbdf2d932015-07-30 03:37:16 +00001731 Found);
1732 ++NumIdentifierLookups;
Richard Smith3b637412015-07-14 18:42:41 +00001733 ASTIdentifierLookupTable::iterator Pos =
Richard Smithbdf2d932015-07-30 03:37:16 +00001734 IdTable->find_hashed(Name, NameHash, &Trait);
Guy Benyei11169dd2012-12-18 14:30:41 +00001735 if (Pos == IdTable->end())
1736 return false;
1737
1738 // Dereferencing the iterator has the effect of building the
1739 // IdentifierInfo node and populating it with the various
1740 // declarations it needs.
Richard Smithbdf2d932015-07-30 03:37:16 +00001741 ++NumIdentifierLookupHits;
1742 Found = *Pos;
Guy Benyei11169dd2012-12-18 14:30:41 +00001743 return true;
1744 }
1745
1746 // \brief Retrieve the identifier info found within the module
1747 // files.
1748 IdentifierInfo *getIdentifierInfo() const { return Found; }
1749 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00001750}
Guy Benyei11169dd2012-12-18 14:30:41 +00001751
1752void ASTReader::updateOutOfDateIdentifier(IdentifierInfo &II) {
1753 // Note that we are loading an identifier.
1754 Deserializing AnIdentifier(this);
1755
1756 unsigned PriorGeneration = 0;
1757 if (getContext().getLangOpts().Modules)
1758 PriorGeneration = IdentifierGeneration[&II];
Douglas Gregore060e572013-01-25 01:03:03 +00001759
1760 // If there is a global index, look there first to determine which modules
1761 // provably do not have any results for this identifier.
Douglas Gregor7211ac12013-01-25 23:32:03 +00001762 GlobalModuleIndex::HitSet Hits;
Craig Toppera13603a2014-05-22 05:54:18 +00001763 GlobalModuleIndex::HitSet *HitsPtr = nullptr;
Douglas Gregore060e572013-01-25 01:03:03 +00001764 if (!loadGlobalIndex()) {
Douglas Gregor7211ac12013-01-25 23:32:03 +00001765 if (GlobalIndex->lookupIdentifier(II.getName(), Hits)) {
1766 HitsPtr = &Hits;
Douglas Gregore060e572013-01-25 01:03:03 +00001767 }
1768 }
1769
Douglas Gregor7211ac12013-01-25 23:32:03 +00001770 IdentifierLookupVisitor Visitor(II.getName(), PriorGeneration,
Douglas Gregor00a50f72013-01-25 00:38:33 +00001771 NumIdentifierLookups,
1772 NumIdentifierLookupHits);
Benjamin Kramer9a9efba2015-07-25 12:14:04 +00001773 ModuleMgr.visit(Visitor, HitsPtr);
Guy Benyei11169dd2012-12-18 14:30:41 +00001774 markIdentifierUpToDate(&II);
1775}
1776
1777void ASTReader::markIdentifierUpToDate(IdentifierInfo *II) {
1778 if (!II)
1779 return;
1780
1781 II->setOutOfDate(false);
1782
1783 // Update the generation for this identifier.
1784 if (getContext().getLangOpts().Modules)
Richard Smith053f6c62014-05-16 23:01:30 +00001785 IdentifierGeneration[II] = getGeneration();
Guy Benyei11169dd2012-12-18 14:30:41 +00001786}
1787
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001788void ASTReader::resolvePendingMacro(IdentifierInfo *II,
1789 const PendingMacroInfo &PMInfo) {
Richard Smithd7329392015-04-21 21:46:32 +00001790 ModuleFile &M = *PMInfo.M;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001791
1792 BitstreamCursor &Cursor = M.MacroCursor;
1793 SavedStreamPosition SavedPosition(Cursor);
Richard Smithd7329392015-04-21 21:46:32 +00001794 Cursor.JumpToBit(PMInfo.MacroDirectivesOffset);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001795
Richard Smith713369b2015-04-23 20:40:50 +00001796 struct ModuleMacroRecord {
1797 SubmoduleID SubModID;
1798 MacroInfo *MI;
1799 SmallVector<SubmoduleID, 8> Overrides;
1800 };
1801 llvm::SmallVector<ModuleMacroRecord, 8> ModuleMacros;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001802
Richard Smithd7329392015-04-21 21:46:32 +00001803 // We expect to see a sequence of PP_MODULE_MACRO records listing exported
1804 // macros, followed by a PP_MACRO_DIRECTIVE_HISTORY record with the complete
1805 // macro histroy.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001806 RecordData Record;
Richard Smithd7329392015-04-21 21:46:32 +00001807 while (true) {
1808 llvm::BitstreamEntry Entry =
1809 Cursor.advance(BitstreamCursor::AF_DontPopBlockAtEnd);
1810 if (Entry.Kind != llvm::BitstreamEntry::Record) {
1811 Error("malformed block record in AST file");
1812 return;
1813 }
1814
1815 Record.clear();
Aaron Ballmanc75a1922015-04-22 15:25:05 +00001816 switch ((PreprocessorRecordTypes)Cursor.readRecord(Entry.ID, Record)) {
Richard Smithd7329392015-04-21 21:46:32 +00001817 case PP_MACRO_DIRECTIVE_HISTORY:
1818 break;
1819
1820 case PP_MODULE_MACRO: {
Richard Smith713369b2015-04-23 20:40:50 +00001821 ModuleMacros.push_back(ModuleMacroRecord());
1822 auto &Info = ModuleMacros.back();
Richard Smithe56c8bc2015-04-22 00:26:11 +00001823 Info.SubModID = getGlobalSubmoduleID(M, Record[0]);
1824 Info.MI = getMacro(getGlobalMacroID(M, Record[1]));
Richard Smith713369b2015-04-23 20:40:50 +00001825 for (int I = 2, N = Record.size(); I != N; ++I)
1826 Info.Overrides.push_back(getGlobalSubmoduleID(M, Record[I]));
Richard Smithd7329392015-04-21 21:46:32 +00001827 continue;
1828 }
1829
1830 default:
1831 Error("malformed block record in AST file");
1832 return;
1833 }
1834
1835 // We found the macro directive history; that's the last record
1836 // for this macro.
1837 break;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001838 }
1839
Richard Smithd7329392015-04-21 21:46:32 +00001840 // Module macros are listed in reverse dependency order.
Richard Smithe56c8bc2015-04-22 00:26:11 +00001841 {
1842 std::reverse(ModuleMacros.begin(), ModuleMacros.end());
Richard Smithe56c8bc2015-04-22 00:26:11 +00001843 llvm::SmallVector<ModuleMacro*, 8> Overrides;
Richard Smith713369b2015-04-23 20:40:50 +00001844 for (auto &MMR : ModuleMacros) {
Richard Smithe56c8bc2015-04-22 00:26:11 +00001845 Overrides.clear();
Richard Smith713369b2015-04-23 20:40:50 +00001846 for (unsigned ModID : MMR.Overrides) {
Richard Smithb8b2ed62015-04-23 18:18:26 +00001847 Module *Mod = getSubmodule(ModID);
1848 auto *Macro = PP.getModuleMacro(Mod, II);
Richard Smithe56c8bc2015-04-22 00:26:11 +00001849 assert(Macro && "missing definition for overridden macro");
Richard Smith5dbef922015-04-22 02:09:43 +00001850 Overrides.push_back(Macro);
Richard Smithe56c8bc2015-04-22 00:26:11 +00001851 }
1852
1853 bool Inserted = false;
Richard Smith713369b2015-04-23 20:40:50 +00001854 Module *Owner = getSubmodule(MMR.SubModID);
Richard Smith20e883e2015-04-29 23:20:19 +00001855 PP.addModuleMacro(Owner, II, MMR.MI, Overrides, Inserted);
Richard Smithd7329392015-04-21 21:46:32 +00001856 }
1857 }
1858
1859 // Don't read the directive history for a module; we don't have anywhere
1860 // to put it.
1861 if (M.Kind == MK_ImplicitModule || M.Kind == MK_ExplicitModule)
1862 return;
1863
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001864 // Deserialize the macro directives history in reverse source-order.
Craig Toppera13603a2014-05-22 05:54:18 +00001865 MacroDirective *Latest = nullptr, *Earliest = nullptr;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001866 unsigned Idx = 0, N = Record.size();
1867 while (Idx < N) {
Craig Toppera13603a2014-05-22 05:54:18 +00001868 MacroDirective *MD = nullptr;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001869 SourceLocation Loc = ReadSourceLocation(M, Record, Idx);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00001870 MacroDirective::Kind K = (MacroDirective::Kind)Record[Idx++];
1871 switch (K) {
1872 case MacroDirective::MD_Define: {
Richard Smith713369b2015-04-23 20:40:50 +00001873 MacroInfo *MI = getMacro(getGlobalMacroID(M, Record[Idx++]));
Richard Smith3981b172015-04-30 02:16:23 +00001874 MD = PP.AllocateDefMacroDirective(MI, Loc);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00001875 break;
1876 }
Richard Smithdaa69e02014-07-25 04:40:03 +00001877 case MacroDirective::MD_Undefine: {
Richard Smith3981b172015-04-30 02:16:23 +00001878 MD = PP.AllocateUndefMacroDirective(Loc);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00001879 break;
Richard Smithdaa69e02014-07-25 04:40:03 +00001880 }
1881 case MacroDirective::MD_Visibility:
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00001882 bool isPublic = Record[Idx++];
1883 MD = PP.AllocateVisibilityMacroDirective(Loc, isPublic);
1884 break;
1885 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001886
1887 if (!Latest)
1888 Latest = MD;
1889 if (Earliest)
1890 Earliest->setPrevious(MD);
1891 Earliest = MD;
1892 }
1893
Richard Smithd6e8c0d2015-05-04 19:58:00 +00001894 if (Latest)
1895 PP.setLoadedMacroDirective(II, Latest);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001896}
1897
Argyrios Kyrtzidisce9b49e2014-03-14 02:26:27 +00001898ASTReader::InputFileInfo
1899ASTReader::readInputFileInfo(ModuleFile &F, unsigned ID) {
Ben Langmuir198c1682014-03-07 07:27:49 +00001900 // Go find this input file.
1901 BitstreamCursor &Cursor = F.InputFilesCursor;
1902 SavedStreamPosition SavedPosition(Cursor);
1903 Cursor.JumpToBit(F.InputFileOffsets[ID-1]);
1904
1905 unsigned Code = Cursor.ReadCode();
1906 RecordData Record;
1907 StringRef Blob;
1908
1909 unsigned Result = Cursor.readRecord(Code, Record, &Blob);
1910 assert(static_cast<InputFileRecordTypes>(Result) == INPUT_FILE &&
1911 "invalid record type for input file");
1912 (void)Result;
1913
1914 assert(Record[0] == ID && "Bogus stored ID or offset");
Richard Smitha8cfffa2015-11-26 02:04:16 +00001915 InputFileInfo R;
1916 R.StoredSize = static_cast<off_t>(Record[1]);
1917 R.StoredTime = static_cast<time_t>(Record[2]);
1918 R.Overridden = static_cast<bool>(Record[3]);
1919 R.Transient = static_cast<bool>(Record[4]);
1920 R.Filename = Blob;
1921 ResolveImportedPath(F, R.Filename);
Hans Wennborg73945142014-03-14 17:45:06 +00001922 return R;
Ben Langmuir198c1682014-03-07 07:27:49 +00001923}
1924
Argyrios Kyrtzidis61c3d872013-03-01 03:26:04 +00001925InputFile ASTReader::getInputFile(ModuleFile &F, unsigned ID, bool Complain) {
Guy Benyei11169dd2012-12-18 14:30:41 +00001926 // If this ID is bogus, just return an empty input file.
1927 if (ID == 0 || ID > F.InputFilesLoaded.size())
1928 return InputFile();
1929
1930 // If we've already loaded this input file, return it.
Argyrios Kyrtzidis61c3d872013-03-01 03:26:04 +00001931 if (F.InputFilesLoaded[ID-1].getFile())
Guy Benyei11169dd2012-12-18 14:30:41 +00001932 return F.InputFilesLoaded[ID-1];
1933
Argyrios Kyrtzidis9308f0a2014-01-08 19:13:34 +00001934 if (F.InputFilesLoaded[ID-1].isNotFound())
1935 return InputFile();
1936
Guy Benyei11169dd2012-12-18 14:30:41 +00001937 // Go find this input file.
Chris Lattner7fb3bef2013-01-20 00:56:42 +00001938 BitstreamCursor &Cursor = F.InputFilesCursor;
Guy Benyei11169dd2012-12-18 14:30:41 +00001939 SavedStreamPosition SavedPosition(Cursor);
1940 Cursor.JumpToBit(F.InputFileOffsets[ID-1]);
1941
Argyrios Kyrtzidisce9b49e2014-03-14 02:26:27 +00001942 InputFileInfo FI = readInputFileInfo(F, ID);
1943 off_t StoredSize = FI.StoredSize;
1944 time_t StoredTime = FI.StoredTime;
1945 bool Overridden = FI.Overridden;
Richard Smitha8cfffa2015-11-26 02:04:16 +00001946 bool Transient = FI.Transient;
Argyrios Kyrtzidisce9b49e2014-03-14 02:26:27 +00001947 StringRef Filename = FI.Filename;
Argyrios Kyrtzidis61c3d872013-03-01 03:26:04 +00001948
Richard Smitha8cfffa2015-11-26 02:04:16 +00001949 const FileEntry *File = FileMgr.getFile(Filename, /*OpenFile=*/false);
Ben Langmuir198c1682014-03-07 07:27:49 +00001950
1951 // If we didn't find the file, resolve it relative to the
1952 // original directory from which this AST file was created.
Craig Toppera13603a2014-05-22 05:54:18 +00001953 if (File == nullptr && !F.OriginalDir.empty() && !CurrentDir.empty() &&
Ben Langmuir198c1682014-03-07 07:27:49 +00001954 F.OriginalDir != CurrentDir) {
1955 std::string Resolved = resolveFileRelativeToOriginalDir(Filename,
1956 F.OriginalDir,
1957 CurrentDir);
1958 if (!Resolved.empty())
1959 File = FileMgr.getFile(Resolved);
1960 }
1961
1962 // For an overridden file, create a virtual file with the stored
1963 // size/timestamp.
Richard Smitha8cfffa2015-11-26 02:04:16 +00001964 if ((Overridden || Transient) && File == nullptr)
Ben Langmuir198c1682014-03-07 07:27:49 +00001965 File = FileMgr.getVirtualFile(Filename, StoredSize, StoredTime);
Ben Langmuir198c1682014-03-07 07:27:49 +00001966
Craig Toppera13603a2014-05-22 05:54:18 +00001967 if (File == nullptr) {
Ben Langmuir198c1682014-03-07 07:27:49 +00001968 if (Complain) {
1969 std::string ErrorStr = "could not find file '";
1970 ErrorStr += Filename;
Richard Smith68142212015-10-13 01:26:26 +00001971 ErrorStr += "' referenced by AST file '";
1972 ErrorStr += F.FileName;
1973 ErrorStr += "'";
Ben Langmuir198c1682014-03-07 07:27:49 +00001974 Error(ErrorStr.c_str());
Guy Benyei11169dd2012-12-18 14:30:41 +00001975 }
Ben Langmuir198c1682014-03-07 07:27:49 +00001976 // Record that we didn't find the file.
1977 F.InputFilesLoaded[ID-1] = InputFile::getNotFound();
1978 return InputFile();
1979 }
Guy Benyei11169dd2012-12-18 14:30:41 +00001980
Ben Langmuir198c1682014-03-07 07:27:49 +00001981 // Check if there was a request to override the contents of the file
1982 // that was part of the precompiled header. Overridding such a file
1983 // can lead to problems when lexing using the source locations from the
1984 // PCH.
1985 SourceManager &SM = getSourceManager();
Richard Smith64daf7b2015-12-01 03:32:49 +00001986 // FIXME: Reject if the overrides are different.
1987 if ((!Overridden && !Transient) && SM.isFileOverridden(File)) {
Ben Langmuir198c1682014-03-07 07:27:49 +00001988 if (Complain)
1989 Error(diag::err_fe_pch_file_overridden, Filename);
1990 // After emitting the diagnostic, recover by disabling the override so
1991 // that the original file will be used.
Richard Smitha8cfffa2015-11-26 02:04:16 +00001992 //
1993 // FIXME: This recovery is just as broken as the original state; there may
1994 // be another precompiled module that's using the overridden contents, or
1995 // we might be half way through parsing it. Instead, we should treat the
1996 // overridden contents as belonging to a separate FileEntry.
Ben Langmuir198c1682014-03-07 07:27:49 +00001997 SM.disableFileContentsOverride(File);
1998 // The FileEntry is a virtual file entry with the size of the contents
1999 // that would override the original contents. Set it to the original's
2000 // size/time.
2001 FileMgr.modifyFileEntry(const_cast<FileEntry*>(File),
2002 StoredSize, StoredTime);
2003 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002004
Ben Langmuir198c1682014-03-07 07:27:49 +00002005 bool IsOutOfDate = false;
2006
2007 // For an overridden file, there is nothing to validate.
Richard Smith96fdab62014-10-28 16:24:08 +00002008 if (!Overridden && //
2009 (StoredSize != File->getSize() ||
2010#if defined(LLVM_ON_WIN32)
2011 false
2012#else
Ben Langmuir198c1682014-03-07 07:27:49 +00002013 // In our regression testing, the Windows file system seems to
2014 // have inconsistent modification times that sometimes
2015 // erroneously trigger this error-handling path.
Richard Smith96fdab62014-10-28 16:24:08 +00002016 //
Richard Smithe75ee0f2015-08-17 07:13:32 +00002017 // FIXME: This probably also breaks HeaderFileInfo lookups on Windows.
2018 (StoredTime && StoredTime != File->getModificationTime() &&
2019 !DisableValidation)
Guy Benyei11169dd2012-12-18 14:30:41 +00002020#endif
Ben Langmuir198c1682014-03-07 07:27:49 +00002021 )) {
2022 if (Complain) {
2023 // Build a list of the PCH imports that got us here (in reverse).
2024 SmallVector<ModuleFile *, 4> ImportStack(1, &F);
2025 while (ImportStack.back()->ImportedBy.size() > 0)
2026 ImportStack.push_back(ImportStack.back()->ImportedBy[0]);
Ben Langmuire82630d2014-01-17 00:19:09 +00002027
Ben Langmuir198c1682014-03-07 07:27:49 +00002028 // The top-level PCH is stale.
2029 StringRef TopLevelPCHName(ImportStack.back()->FileName);
2030 Error(diag::err_fe_pch_file_modified, Filename, TopLevelPCHName);
Ben Langmuire82630d2014-01-17 00:19:09 +00002031
Ben Langmuir198c1682014-03-07 07:27:49 +00002032 // Print the import stack.
2033 if (ImportStack.size() > 1 && !Diags.isDiagnosticInFlight()) {
2034 Diag(diag::note_pch_required_by)
2035 << Filename << ImportStack[0]->FileName;
2036 for (unsigned I = 1; I < ImportStack.size(); ++I)
Ben Langmuire82630d2014-01-17 00:19:09 +00002037 Diag(diag::note_pch_required_by)
Ben Langmuir198c1682014-03-07 07:27:49 +00002038 << ImportStack[I-1]->FileName << ImportStack[I]->FileName;
Douglas Gregor7029ce12013-03-19 00:28:20 +00002039 }
2040
Ben Langmuir198c1682014-03-07 07:27:49 +00002041 if (!Diags.isDiagnosticInFlight())
2042 Diag(diag::note_pch_rebuild_required) << TopLevelPCHName;
Guy Benyei11169dd2012-12-18 14:30:41 +00002043 }
2044
Ben Langmuir198c1682014-03-07 07:27:49 +00002045 IsOutOfDate = true;
Guy Benyei11169dd2012-12-18 14:30:41 +00002046 }
Richard Smitha8cfffa2015-11-26 02:04:16 +00002047 // FIXME: If the file is overridden and we've already opened it,
2048 // issue an error (or split it into a separate FileEntry).
Guy Benyei11169dd2012-12-18 14:30:41 +00002049
Richard Smitha8cfffa2015-11-26 02:04:16 +00002050 InputFile IF = InputFile(File, Overridden || Transient, IsOutOfDate);
Ben Langmuir198c1682014-03-07 07:27:49 +00002051
2052 // Note that we've loaded this input file.
2053 F.InputFilesLoaded[ID-1] = IF;
2054 return IF;
Guy Benyei11169dd2012-12-18 14:30:41 +00002055}
2056
Richard Smith7ed1bc92014-12-05 22:42:13 +00002057/// \brief If we are loading a relocatable PCH or module file, and the filename
2058/// is not an absolute path, add the system or module root to the beginning of
2059/// the file name.
2060void ASTReader::ResolveImportedPath(ModuleFile &M, std::string &Filename) {
2061 // Resolve relative to the base directory, if we have one.
2062 if (!M.BaseDirectory.empty())
2063 return ResolveImportedPath(Filename, M.BaseDirectory);
Guy Benyei11169dd2012-12-18 14:30:41 +00002064}
2065
Richard Smith7ed1bc92014-12-05 22:42:13 +00002066void ASTReader::ResolveImportedPath(std::string &Filename, StringRef Prefix) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002067 if (Filename.empty() || llvm::sys::path::is_absolute(Filename))
2068 return;
2069
Richard Smith7ed1bc92014-12-05 22:42:13 +00002070 SmallString<128> Buffer;
2071 llvm::sys::path::append(Buffer, Prefix, Filename);
2072 Filename.assign(Buffer.begin(), Buffer.end());
Guy Benyei11169dd2012-12-18 14:30:41 +00002073}
2074
Richard Smith0f99d6a2015-08-09 08:48:41 +00002075static bool isDiagnosedResult(ASTReader::ASTReadResult ARR, unsigned Caps) {
2076 switch (ARR) {
2077 case ASTReader::Failure: return true;
2078 case ASTReader::Missing: return !(Caps & ASTReader::ARR_Missing);
2079 case ASTReader::OutOfDate: return !(Caps & ASTReader::ARR_OutOfDate);
2080 case ASTReader::VersionMismatch: return !(Caps & ASTReader::ARR_VersionMismatch);
2081 case ASTReader::ConfigurationMismatch:
2082 return !(Caps & ASTReader::ARR_ConfigurationMismatch);
2083 case ASTReader::HadErrors: return true;
2084 case ASTReader::Success: return false;
2085 }
2086
2087 llvm_unreachable("unknown ASTReadResult");
2088}
2089
Richard Smith0516b182015-09-08 19:40:14 +00002090ASTReader::ASTReadResult ASTReader::ReadOptionsBlock(
2091 BitstreamCursor &Stream, unsigned ClientLoadCapabilities,
2092 bool AllowCompatibleConfigurationMismatch, ASTReaderListener &Listener,
2093 std::string &SuggestedPredefines) {
2094 if (Stream.EnterSubBlock(OPTIONS_BLOCK_ID))
2095 return Failure;
2096
2097 // Read all of the records in the options block.
2098 RecordData Record;
2099 ASTReadResult Result = Success;
2100 while (1) {
2101 llvm::BitstreamEntry Entry = Stream.advance();
2102
2103 switch (Entry.Kind) {
2104 case llvm::BitstreamEntry::Error:
2105 case llvm::BitstreamEntry::SubBlock:
2106 return Failure;
2107
2108 case llvm::BitstreamEntry::EndBlock:
2109 return Result;
2110
2111 case llvm::BitstreamEntry::Record:
2112 // The interesting case.
2113 break;
2114 }
2115
2116 // Read and process a record.
2117 Record.clear();
2118 switch ((OptionsRecordTypes)Stream.readRecord(Entry.ID, Record)) {
2119 case LANGUAGE_OPTIONS: {
2120 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2121 if (ParseLanguageOptions(Record, Complain, Listener,
2122 AllowCompatibleConfigurationMismatch))
2123 Result = ConfigurationMismatch;
2124 break;
2125 }
2126
2127 case TARGET_OPTIONS: {
2128 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2129 if (ParseTargetOptions(Record, Complain, Listener,
2130 AllowCompatibleConfigurationMismatch))
2131 Result = ConfigurationMismatch;
2132 break;
2133 }
2134
2135 case DIAGNOSTIC_OPTIONS: {
2136 bool Complain = (ClientLoadCapabilities & ARR_OutOfDate) == 0;
2137 if (!AllowCompatibleConfigurationMismatch &&
2138 ParseDiagnosticOptions(Record, Complain, Listener))
2139 return OutOfDate;
2140 break;
2141 }
2142
2143 case FILE_SYSTEM_OPTIONS: {
2144 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2145 if (!AllowCompatibleConfigurationMismatch &&
2146 ParseFileSystemOptions(Record, Complain, Listener))
2147 Result = ConfigurationMismatch;
2148 break;
2149 }
2150
2151 case HEADER_SEARCH_OPTIONS: {
2152 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2153 if (!AllowCompatibleConfigurationMismatch &&
2154 ParseHeaderSearchOptions(Record, Complain, Listener))
2155 Result = ConfigurationMismatch;
2156 break;
2157 }
2158
2159 case PREPROCESSOR_OPTIONS:
2160 bool Complain = (ClientLoadCapabilities & ARR_ConfigurationMismatch) == 0;
2161 if (!AllowCompatibleConfigurationMismatch &&
2162 ParsePreprocessorOptions(Record, Complain, Listener,
2163 SuggestedPredefines))
2164 Result = ConfigurationMismatch;
2165 break;
2166 }
2167 }
2168}
2169
Guy Benyei11169dd2012-12-18 14:30:41 +00002170ASTReader::ASTReadResult
2171ASTReader::ReadControlBlock(ModuleFile &F,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002172 SmallVectorImpl<ImportedModule> &Loaded,
Ben Langmuirbeee15e2014-04-14 18:00:01 +00002173 const ModuleFile *ImportedBy,
Guy Benyei11169dd2012-12-18 14:30:41 +00002174 unsigned ClientLoadCapabilities) {
Chris Lattner7fb3bef2013-01-20 00:56:42 +00002175 BitstreamCursor &Stream = F.Stream;
Richard Smith8a308ec2015-11-05 00:54:55 +00002176 ASTReadResult Result = Success;
Guy Benyei11169dd2012-12-18 14:30:41 +00002177
2178 if (Stream.EnterSubBlock(CONTROL_BLOCK_ID)) {
2179 Error("malformed block record in AST file");
2180 return Failure;
2181 }
2182
2183 // Read all of the records and blocks in the control block.
2184 RecordData Record;
Richard Smitha1825302014-10-23 22:18:29 +00002185 unsigned NumInputs = 0;
2186 unsigned NumUserInputs = 0;
Chris Lattnere7b154b2013-01-19 21:39:22 +00002187 while (1) {
2188 llvm::BitstreamEntry Entry = Stream.advance();
2189
2190 switch (Entry.Kind) {
2191 case llvm::BitstreamEntry::Error:
2192 Error("malformed block record in AST file");
2193 return Failure;
Dmitri Gribenkof430da42014-02-12 10:33:14 +00002194 case llvm::BitstreamEntry::EndBlock: {
2195 // Validate input files.
2196 const HeaderSearchOptions &HSOpts =
2197 PP.getHeaderSearchInfo().getHeaderSearchOpts();
Ben Langmuircb69b572014-03-07 06:40:32 +00002198
Richard Smitha1825302014-10-23 22:18:29 +00002199 // All user input files reside at the index range [0, NumUserInputs), and
Richard Smith0f99d6a2015-08-09 08:48:41 +00002200 // system input files reside at [NumUserInputs, NumInputs). For explicitly
2201 // loaded module files, ignore missing inputs.
2202 if (!DisableValidation && F.Kind != MK_ExplicitModule) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002203 bool Complain = (ClientLoadCapabilities & ARR_OutOfDate) == 0;
Ben Langmuircb69b572014-03-07 06:40:32 +00002204
Dmitri Gribenkof430da42014-02-12 10:33:14 +00002205 // If we are reading a module, we will create a verification timestamp,
2206 // so we verify all input files. Otherwise, verify only user input
2207 // files.
Ben Langmuircb69b572014-03-07 06:40:32 +00002208
2209 unsigned N = NumUserInputs;
2210 if (ValidateSystemInputs ||
Richard Smithe842a472014-10-22 02:05:46 +00002211 (HSOpts.ModulesValidateOncePerBuildSession &&
Ben Langmuiracb803e2014-11-10 22:13:10 +00002212 F.InputFilesValidationTimestamp <= HSOpts.BuildSessionTimestamp &&
Richard Smithe842a472014-10-22 02:05:46 +00002213 F.Kind == MK_ImplicitModule))
Ben Langmuircb69b572014-03-07 06:40:32 +00002214 N = NumInputs;
2215
Ben Langmuir3d4417c2014-02-07 17:31:11 +00002216 for (unsigned I = 0; I < N; ++I) {
Argyrios Kyrtzidis61c3d872013-03-01 03:26:04 +00002217 InputFile IF = getInputFile(F, I+1, Complain);
2218 if (!IF.getFile() || IF.isOutOfDate())
Guy Benyei11169dd2012-12-18 14:30:41 +00002219 return OutOfDate;
Argyrios Kyrtzidis61c3d872013-03-01 03:26:04 +00002220 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002221 }
Ben Langmuircb69b572014-03-07 06:40:32 +00002222
Argyrios Kyrtzidis6d0753d2014-03-14 03:07:38 +00002223 if (Listener)
Richard Smith216a3bd2015-08-13 17:57:10 +00002224 Listener->visitModuleFile(F.FileName, F.Kind);
Argyrios Kyrtzidis6d0753d2014-03-14 03:07:38 +00002225
Ben Langmuircb69b572014-03-07 06:40:32 +00002226 if (Listener && Listener->needsInputFileVisitation()) {
2227 unsigned N = Listener->needsSystemInputFileVisitation() ? NumInputs
2228 : NumUserInputs;
Argyrios Kyrtzidis68ccbe02014-03-14 02:26:31 +00002229 for (unsigned I = 0; I < N; ++I) {
2230 bool IsSystem = I >= NumUserInputs;
2231 InputFileInfo FI = readInputFileInfo(F, I+1);
Richard Smith216a3bd2015-08-13 17:57:10 +00002232 Listener->visitInputFile(FI.Filename, IsSystem, FI.Overridden,
2233 F.Kind == MK_ExplicitModule);
Argyrios Kyrtzidis68ccbe02014-03-14 02:26:31 +00002234 }
Ben Langmuircb69b572014-03-07 06:40:32 +00002235 }
2236
Richard Smith8a308ec2015-11-05 00:54:55 +00002237 return Result;
Dmitri Gribenkof430da42014-02-12 10:33:14 +00002238 }
2239
Chris Lattnere7b154b2013-01-19 21:39:22 +00002240 case llvm::BitstreamEntry::SubBlock:
2241 switch (Entry.ID) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002242 case INPUT_FILES_BLOCK_ID:
2243 F.InputFilesCursor = Stream;
2244 if (Stream.SkipBlock() || // Skip with the main cursor
2245 // Read the abbreviations
2246 ReadBlockAbbrevs(F.InputFilesCursor, INPUT_FILES_BLOCK_ID)) {
2247 Error("malformed block record in AST file");
2248 return Failure;
2249 }
2250 continue;
Richard Smith0516b182015-09-08 19:40:14 +00002251
2252 case OPTIONS_BLOCK_ID:
2253 // If we're reading the first module for this group, check its options
2254 // are compatible with ours. For modules it imports, no further checking
2255 // is required, because we checked them when we built it.
2256 if (Listener && !ImportedBy) {
2257 // Should we allow the configuration of the module file to differ from
2258 // the configuration of the current translation unit in a compatible
2259 // way?
2260 //
2261 // FIXME: Allow this for files explicitly specified with -include-pch.
2262 bool AllowCompatibleConfigurationMismatch =
2263 F.Kind == MK_ExplicitModule;
2264
Richard Smith8a308ec2015-11-05 00:54:55 +00002265 Result = ReadOptionsBlock(Stream, ClientLoadCapabilities,
2266 AllowCompatibleConfigurationMismatch,
2267 *Listener, SuggestedPredefines);
Richard Smith0516b182015-09-08 19:40:14 +00002268 if (Result == Failure) {
2269 Error("malformed block record in AST file");
2270 return Result;
2271 }
2272
Richard Smith8a308ec2015-11-05 00:54:55 +00002273 if (DisableValidation ||
2274 (AllowConfigurationMismatch && Result == ConfigurationMismatch))
2275 Result = Success;
2276
Ben Langmuir9b1e442e2016-02-11 18:54:02 +00002277 // If we can't load the module, exit early since we likely
2278 // will rebuild the module anyway. The stream may be in the
2279 // middle of a block.
2280 if (Result != Success)
Richard Smith0516b182015-09-08 19:40:14 +00002281 return Result;
2282 } else if (Stream.SkipBlock()) {
2283 Error("malformed block record in AST file");
2284 return Failure;
2285 }
2286 continue;
Chris Lattnere7b154b2013-01-19 21:39:22 +00002287
Guy Benyei11169dd2012-12-18 14:30:41 +00002288 default:
Chris Lattnere7b154b2013-01-19 21:39:22 +00002289 if (Stream.SkipBlock()) {
2290 Error("malformed block record in AST file");
2291 return Failure;
2292 }
2293 continue;
Guy Benyei11169dd2012-12-18 14:30:41 +00002294 }
Chris Lattnere7b154b2013-01-19 21:39:22 +00002295
2296 case llvm::BitstreamEntry::Record:
2297 // The interesting case.
2298 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002299 }
2300
2301 // Read and process a record.
2302 Record.clear();
Chris Lattner0e6c9402013-01-20 02:38:54 +00002303 StringRef Blob;
2304 switch ((ControlRecordTypes)Stream.readRecord(Entry.ID, Record, &Blob)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002305 case METADATA: {
2306 if (Record[0] != VERSION_MAJOR && !DisableValidation) {
2307 if ((ClientLoadCapabilities & ARR_VersionMismatch) == 0)
Dmitri Gribenko2228cd32014-02-11 15:40:09 +00002308 Diag(Record[0] < VERSION_MAJOR? diag::err_pch_version_too_old
2309 : diag::err_pch_version_too_new);
Guy Benyei11169dd2012-12-18 14:30:41 +00002310 return VersionMismatch;
2311 }
2312
Richard Smithe75ee0f2015-08-17 07:13:32 +00002313 bool hasErrors = Record[6];
Guy Benyei11169dd2012-12-18 14:30:41 +00002314 if (hasErrors && !DisableValidation && !AllowASTWithCompilerErrors) {
2315 Diag(diag::err_pch_with_compiler_errors);
2316 return HadErrors;
2317 }
2318
2319 F.RelocatablePCH = Record[4];
Richard Smith7ed1bc92014-12-05 22:42:13 +00002320 // Relative paths in a relocatable PCH are relative to our sysroot.
2321 if (F.RelocatablePCH)
2322 F.BaseDirectory = isysroot.empty() ? "/" : isysroot;
Guy Benyei11169dd2012-12-18 14:30:41 +00002323
Richard Smithe75ee0f2015-08-17 07:13:32 +00002324 F.HasTimestamps = Record[5];
2325
Guy Benyei11169dd2012-12-18 14:30:41 +00002326 const std::string &CurBranch = getClangFullRepositoryVersion();
Chris Lattner0e6c9402013-01-20 02:38:54 +00002327 StringRef ASTBranch = Blob;
Guy Benyei11169dd2012-12-18 14:30:41 +00002328 if (StringRef(CurBranch) != ASTBranch && !DisableValidation) {
2329 if ((ClientLoadCapabilities & ARR_VersionMismatch) == 0)
Dmitri Gribenko2228cd32014-02-11 15:40:09 +00002330 Diag(diag::err_pch_different_branch) << ASTBranch << CurBranch;
Guy Benyei11169dd2012-12-18 14:30:41 +00002331 return VersionMismatch;
2332 }
2333 break;
2334 }
2335
Ben Langmuir487ea142014-10-23 18:05:36 +00002336 case SIGNATURE:
2337 assert((!F.Signature || F.Signature == Record[0]) && "signature changed");
2338 F.Signature = Record[0];
2339 break;
2340
Guy Benyei11169dd2012-12-18 14:30:41 +00002341 case IMPORTS: {
2342 // Load each of the imported PCH files.
2343 unsigned Idx = 0, N = Record.size();
2344 while (Idx < N) {
2345 // Read information about the AST file.
2346 ModuleKind ImportedKind = (ModuleKind)Record[Idx++];
2347 // The import location will be the local one for now; we will adjust
2348 // all import locations of module imports after the global source
Richard Smithb22a1d12016-03-27 20:13:24 +00002349 // location info are setup, in ReadAST.
Guy Benyei11169dd2012-12-18 14:30:41 +00002350 SourceLocation ImportLoc =
Richard Smithb22a1d12016-03-27 20:13:24 +00002351 ReadUntranslatedSourceLocation(Record[Idx++]);
Douglas Gregor7029ce12013-03-19 00:28:20 +00002352 off_t StoredSize = (off_t)Record[Idx++];
2353 time_t StoredModTime = (time_t)Record[Idx++];
Ben Langmuir487ea142014-10-23 18:05:36 +00002354 ASTFileSignature StoredSignature = Record[Idx++];
Richard Smith7ed1bc92014-12-05 22:42:13 +00002355 auto ImportedFile = ReadPath(F, Record, Idx);
Guy Benyei11169dd2012-12-18 14:30:41 +00002356
Richard Smith0f99d6a2015-08-09 08:48:41 +00002357 // If our client can't cope with us being out of date, we can't cope with
2358 // our dependency being missing.
2359 unsigned Capabilities = ClientLoadCapabilities;
2360 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
2361 Capabilities &= ~ARR_Missing;
2362
Guy Benyei11169dd2012-12-18 14:30:41 +00002363 // Load the AST file.
Richard Smith0f99d6a2015-08-09 08:48:41 +00002364 auto Result = ReadASTCore(ImportedFile, ImportedKind, ImportLoc, &F,
2365 Loaded, StoredSize, StoredModTime,
2366 StoredSignature, Capabilities);
2367
2368 // If we diagnosed a problem, produce a backtrace.
2369 if (isDiagnosedResult(Result, Capabilities))
2370 Diag(diag::note_module_file_imported_by)
2371 << F.FileName << !F.ModuleName.empty() << F.ModuleName;
2372
2373 switch (Result) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002374 case Failure: return Failure;
2375 // If we have to ignore the dependency, we'll have to ignore this too.
Douglas Gregor2f1806e2013-03-19 00:38:50 +00002376 case Missing:
Guy Benyei11169dd2012-12-18 14:30:41 +00002377 case OutOfDate: return OutOfDate;
2378 case VersionMismatch: return VersionMismatch;
2379 case ConfigurationMismatch: return ConfigurationMismatch;
2380 case HadErrors: return HadErrors;
2381 case Success: break;
2382 }
2383 }
2384 break;
2385 }
2386
Guy Benyei11169dd2012-12-18 14:30:41 +00002387 case ORIGINAL_FILE:
2388 F.OriginalSourceFileID = FileID::get(Record[0]);
Chris Lattner0e6c9402013-01-20 02:38:54 +00002389 F.ActualOriginalSourceFileName = Blob;
Guy Benyei11169dd2012-12-18 14:30:41 +00002390 F.OriginalSourceFileName = F.ActualOriginalSourceFileName;
Richard Smith7ed1bc92014-12-05 22:42:13 +00002391 ResolveImportedPath(F, F.OriginalSourceFileName);
Guy Benyei11169dd2012-12-18 14:30:41 +00002392 break;
2393
2394 case ORIGINAL_FILE_ID:
2395 F.OriginalSourceFileID = FileID::get(Record[0]);
2396 break;
2397
2398 case ORIGINAL_PCH_DIR:
Chris Lattner0e6c9402013-01-20 02:38:54 +00002399 F.OriginalDir = Blob;
Guy Benyei11169dd2012-12-18 14:30:41 +00002400 break;
2401
Ben Langmuirbeee15e2014-04-14 18:00:01 +00002402 case MODULE_NAME:
2403 F.ModuleName = Blob;
Ben Langmuir4f5212a2014-04-14 22:12:44 +00002404 if (Listener)
2405 Listener->ReadModuleName(F.ModuleName);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00002406 break;
2407
Richard Smith223d3f22014-12-06 03:21:08 +00002408 case MODULE_DIRECTORY: {
2409 assert(!F.ModuleName.empty() &&
2410 "MODULE_DIRECTORY found before MODULE_NAME");
2411 // If we've already loaded a module map file covering this module, we may
2412 // have a better path for it (relative to the current build).
2413 Module *M = PP.getHeaderSearchInfo().lookupModule(F.ModuleName);
2414 if (M && M->Directory) {
2415 // If we're implicitly loading a module, the base directory can't
2416 // change between the build and use.
2417 if (F.Kind != MK_ExplicitModule) {
2418 const DirectoryEntry *BuildDir =
2419 PP.getFileManager().getDirectory(Blob);
2420 if (!BuildDir || BuildDir != M->Directory) {
2421 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
2422 Diag(diag::err_imported_module_relocated)
2423 << F.ModuleName << Blob << M->Directory->getName();
2424 return OutOfDate;
2425 }
2426 }
2427 F.BaseDirectory = M->Directory->getName();
2428 } else {
2429 F.BaseDirectory = Blob;
2430 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00002431 break;
Richard Smith223d3f22014-12-06 03:21:08 +00002432 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00002433
Ben Langmuirbeee15e2014-04-14 18:00:01 +00002434 case MODULE_MAP_FILE:
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00002435 if (ASTReadResult Result =
2436 ReadModuleMapFileBlock(Record, F, ImportedBy, ClientLoadCapabilities))
2437 return Result;
Ben Langmuir264ea152014-11-08 00:06:39 +00002438 break;
2439
Justin Bognerca9c0cc2015-06-21 20:32:36 +00002440 case INPUT_FILE_OFFSETS:
Richard Smitha1825302014-10-23 22:18:29 +00002441 NumInputs = Record[0];
2442 NumUserInputs = Record[1];
Justin Bogner4c183242015-06-21 20:32:40 +00002443 F.InputFileOffsets =
2444 (const llvm::support::unaligned_uint64_t *)Blob.data();
Richard Smitha1825302014-10-23 22:18:29 +00002445 F.InputFilesLoaded.resize(NumInputs);
Guy Benyei11169dd2012-12-18 14:30:41 +00002446 break;
2447 }
2448 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002449}
2450
Ben Langmuir2c9af442014-04-10 17:57:43 +00002451ASTReader::ASTReadResult
2452ASTReader::ReadASTBlock(ModuleFile &F, unsigned ClientLoadCapabilities) {
Chris Lattner7fb3bef2013-01-20 00:56:42 +00002453 BitstreamCursor &Stream = F.Stream;
Guy Benyei11169dd2012-12-18 14:30:41 +00002454
2455 if (Stream.EnterSubBlock(AST_BLOCK_ID)) {
2456 Error("malformed block record in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002457 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002458 }
2459
2460 // Read all of the records and blocks for the AST file.
2461 RecordData Record;
Chris Lattnere7b154b2013-01-19 21:39:22 +00002462 while (1) {
2463 llvm::BitstreamEntry Entry = Stream.advance();
2464
2465 switch (Entry.Kind) {
2466 case llvm::BitstreamEntry::Error:
2467 Error("error at end of module block in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002468 return Failure;
Chris Lattnere7b154b2013-01-19 21:39:22 +00002469 case llvm::BitstreamEntry::EndBlock: {
Richard Smithc0fbba72013-04-03 22:49:41 +00002470 // Outside of C++, we do not store a lookup map for the translation unit.
2471 // Instead, mark it as needing a lookup map to be built if this module
2472 // contains any declarations lexically within it (which it always does!).
2473 // This usually has no cost, since we very rarely need the lookup map for
2474 // the translation unit outside C++.
Guy Benyei11169dd2012-12-18 14:30:41 +00002475 DeclContext *DC = Context.getTranslationUnitDecl();
Richard Smithc0fbba72013-04-03 22:49:41 +00002476 if (DC->hasExternalLexicalStorage() &&
2477 !getContext().getLangOpts().CPlusPlus)
Guy Benyei11169dd2012-12-18 14:30:41 +00002478 DC->setMustBuildLookupTable();
Chris Lattnere7b154b2013-01-19 21:39:22 +00002479
Ben Langmuir2c9af442014-04-10 17:57:43 +00002480 return Success;
Guy Benyei11169dd2012-12-18 14:30:41 +00002481 }
Chris Lattnere7b154b2013-01-19 21:39:22 +00002482 case llvm::BitstreamEntry::SubBlock:
2483 switch (Entry.ID) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002484 case DECLTYPES_BLOCK_ID:
2485 // We lazily load the decls block, but we want to set up the
2486 // DeclsCursor cursor to point into it. Clone our current bitcode
2487 // cursor to it, enter the block and read the abbrevs in that block.
2488 // With the main cursor, we just skip over it.
2489 F.DeclsCursor = Stream;
2490 if (Stream.SkipBlock() || // Skip with the main cursor.
2491 // Read the abbrevs.
2492 ReadBlockAbbrevs(F.DeclsCursor, DECLTYPES_BLOCK_ID)) {
2493 Error("malformed block record in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002494 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002495 }
2496 break;
Richard Smithb9eab6d2014-03-20 19:44:17 +00002497
Guy Benyei11169dd2012-12-18 14:30:41 +00002498 case PREPROCESSOR_BLOCK_ID:
2499 F.MacroCursor = Stream;
2500 if (!PP.getExternalSource())
2501 PP.setExternalSource(this);
Chris Lattnere7b154b2013-01-19 21:39:22 +00002502
Guy Benyei11169dd2012-12-18 14:30:41 +00002503 if (Stream.SkipBlock() ||
2504 ReadBlockAbbrevs(F.MacroCursor, PREPROCESSOR_BLOCK_ID)) {
2505 Error("malformed block record in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002506 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002507 }
2508 F.MacroStartOffset = F.MacroCursor.GetCurrentBitNo();
2509 break;
Chris Lattnere7b154b2013-01-19 21:39:22 +00002510
Guy Benyei11169dd2012-12-18 14:30:41 +00002511 case PREPROCESSOR_DETAIL_BLOCK_ID:
2512 F.PreprocessorDetailCursor = Stream;
2513 if (Stream.SkipBlock() ||
Chris Lattnere7b154b2013-01-19 21:39:22 +00002514 ReadBlockAbbrevs(F.PreprocessorDetailCursor,
Guy Benyei11169dd2012-12-18 14:30:41 +00002515 PREPROCESSOR_DETAIL_BLOCK_ID)) {
Chris Lattnere7b154b2013-01-19 21:39:22 +00002516 Error("malformed preprocessor detail record in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002517 return Failure;
Chris Lattnere7b154b2013-01-19 21:39:22 +00002518 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002519 F.PreprocessorDetailStartOffset
Chris Lattnere7b154b2013-01-19 21:39:22 +00002520 = F.PreprocessorDetailCursor.GetCurrentBitNo();
2521
Guy Benyei11169dd2012-12-18 14:30:41 +00002522 if (!PP.getPreprocessingRecord())
2523 PP.createPreprocessingRecord();
2524 if (!PP.getPreprocessingRecord()->getExternalSource())
2525 PP.getPreprocessingRecord()->SetExternalSource(*this);
2526 break;
2527
2528 case SOURCE_MANAGER_BLOCK_ID:
2529 if (ReadSourceManagerBlock(F))
Ben Langmuir2c9af442014-04-10 17:57:43 +00002530 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002531 break;
Chris Lattnere7b154b2013-01-19 21:39:22 +00002532
Guy Benyei11169dd2012-12-18 14:30:41 +00002533 case SUBMODULE_BLOCK_ID:
Ben Langmuir2c9af442014-04-10 17:57:43 +00002534 if (ASTReadResult Result = ReadSubmoduleBlock(F, ClientLoadCapabilities))
2535 return Result;
Guy Benyei11169dd2012-12-18 14:30:41 +00002536 break;
Chris Lattnere7b154b2013-01-19 21:39:22 +00002537
Guy Benyei11169dd2012-12-18 14:30:41 +00002538 case COMMENTS_BLOCK_ID: {
Chris Lattner7fb3bef2013-01-20 00:56:42 +00002539 BitstreamCursor C = Stream;
Guy Benyei11169dd2012-12-18 14:30:41 +00002540 if (Stream.SkipBlock() ||
2541 ReadBlockAbbrevs(C, COMMENTS_BLOCK_ID)) {
2542 Error("malformed comments block in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002543 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002544 }
2545 CommentsCursors.push_back(std::make_pair(C, &F));
2546 break;
2547 }
Chris Lattnere7b154b2013-01-19 21:39:22 +00002548
Guy Benyei11169dd2012-12-18 14:30:41 +00002549 default:
Chris Lattnere7b154b2013-01-19 21:39:22 +00002550 if (Stream.SkipBlock()) {
2551 Error("malformed block record in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002552 return Failure;
Chris Lattnere7b154b2013-01-19 21:39:22 +00002553 }
2554 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002555 }
2556 continue;
Chris Lattnere7b154b2013-01-19 21:39:22 +00002557
2558 case llvm::BitstreamEntry::Record:
2559 // The interesting case.
2560 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00002561 }
2562
2563 // Read and process a record.
2564 Record.clear();
Chris Lattner0e6c9402013-01-20 02:38:54 +00002565 StringRef Blob;
2566 switch ((ASTRecordTypes)Stream.readRecord(Entry.ID, Record, &Blob)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00002567 default: // Default behavior: ignore.
2568 break;
2569
2570 case TYPE_OFFSET: {
2571 if (F.LocalNumTypes != 0) {
2572 Error("duplicate TYPE_OFFSET record in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002573 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002574 }
Chris Lattner0e6c9402013-01-20 02:38:54 +00002575 F.TypeOffsets = (const uint32_t *)Blob.data();
Guy Benyei11169dd2012-12-18 14:30:41 +00002576 F.LocalNumTypes = Record[0];
2577 unsigned LocalBaseTypeIndex = Record[1];
2578 F.BaseTypeIndex = getTotalNumTypes();
2579
2580 if (F.LocalNumTypes > 0) {
2581 // Introduce the global -> local mapping for types within this module.
2582 GlobalTypeMap.insert(std::make_pair(getTotalNumTypes(), &F));
2583
2584 // Introduce the local -> global mapping for types within this module.
2585 F.TypeRemap.insertOrReplace(
2586 std::make_pair(LocalBaseTypeIndex,
2587 F.BaseTypeIndex - LocalBaseTypeIndex));
Ben Langmuir52ca6782014-10-20 16:27:32 +00002588
2589 TypesLoaded.resize(TypesLoaded.size() + F.LocalNumTypes);
Guy Benyei11169dd2012-12-18 14:30:41 +00002590 }
2591 break;
2592 }
2593
2594 case DECL_OFFSET: {
2595 if (F.LocalNumDecls != 0) {
2596 Error("duplicate DECL_OFFSET record in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002597 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002598 }
Chris Lattner0e6c9402013-01-20 02:38:54 +00002599 F.DeclOffsets = (const DeclOffset *)Blob.data();
Guy Benyei11169dd2012-12-18 14:30:41 +00002600 F.LocalNumDecls = Record[0];
2601 unsigned LocalBaseDeclID = Record[1];
2602 F.BaseDeclID = getTotalNumDecls();
2603
2604 if (F.LocalNumDecls > 0) {
2605 // Introduce the global -> local mapping for declarations within this
2606 // module.
2607 GlobalDeclMap.insert(
2608 std::make_pair(getTotalNumDecls() + NUM_PREDEF_DECL_IDS, &F));
2609
2610 // Introduce the local -> global mapping for declarations within this
2611 // module.
2612 F.DeclRemap.insertOrReplace(
2613 std::make_pair(LocalBaseDeclID, F.BaseDeclID - LocalBaseDeclID));
2614
2615 // Introduce the global -> local mapping for declarations within this
2616 // module.
2617 F.GlobalToLocalDeclIDs[&F] = LocalBaseDeclID;
Ben Langmuirfe971d92014-08-16 04:54:18 +00002618
Ben Langmuir52ca6782014-10-20 16:27:32 +00002619 DeclsLoaded.resize(DeclsLoaded.size() + F.LocalNumDecls);
2620 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002621 break;
2622 }
2623
2624 case TU_UPDATE_LEXICAL: {
2625 DeclContext *TU = Context.getTranslationUnitDecl();
Richard Smith82f8fcd2015-08-06 22:07:25 +00002626 LexicalContents Contents(
2627 reinterpret_cast<const llvm::support::unaligned_uint32_t *>(
2628 Blob.data()),
2629 static_cast<unsigned int>(Blob.size() / 4));
2630 TULexicalDecls.push_back(std::make_pair(&F, Contents));
Guy Benyei11169dd2012-12-18 14:30:41 +00002631 TU->setHasExternalLexicalStorage(true);
2632 break;
2633 }
2634
2635 case UPDATE_VISIBLE: {
2636 unsigned Idx = 0;
2637 serialization::DeclID ID = ReadDeclID(F, Record, Idx);
Richard Smith0f4e2c42015-08-06 04:23:48 +00002638 auto *Data = (const unsigned char*)Blob.data();
Richard Smithd88a7f12015-09-01 20:35:42 +00002639 PendingVisibleUpdates[ID].push_back(PendingVisibleUpdate{&F, Data});
Richard Smith0f4e2c42015-08-06 04:23:48 +00002640 // If we've already loaded the decl, perform the updates when we finish
2641 // loading this block.
2642 if (Decl *D = GetExistingDecl(ID))
2643 PendingUpdateRecords.push_back(std::make_pair(ID, D));
Guy Benyei11169dd2012-12-18 14:30:41 +00002644 break;
2645 }
2646
2647 case IDENTIFIER_TABLE:
Chris Lattner0e6c9402013-01-20 02:38:54 +00002648 F.IdentifierTableData = Blob.data();
Guy Benyei11169dd2012-12-18 14:30:41 +00002649 if (Record[0]) {
Justin Bognerda4e6502014-04-14 16:34:29 +00002650 F.IdentifierLookupTable = ASTIdentifierLookupTable::Create(
2651 (const unsigned char *)F.IdentifierTableData + Record[0],
2652 (const unsigned char *)F.IdentifierTableData + sizeof(uint32_t),
2653 (const unsigned char *)F.IdentifierTableData,
2654 ASTIdentifierLookupTrait(*this, F));
Guy Benyei11169dd2012-12-18 14:30:41 +00002655
2656 PP.getIdentifierTable().setExternalIdentifierLookup(this);
2657 }
2658 break;
2659
2660 case IDENTIFIER_OFFSET: {
2661 if (F.LocalNumIdentifiers != 0) {
2662 Error("duplicate IDENTIFIER_OFFSET record in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002663 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002664 }
Chris Lattner0e6c9402013-01-20 02:38:54 +00002665 F.IdentifierOffsets = (const uint32_t *)Blob.data();
Guy Benyei11169dd2012-12-18 14:30:41 +00002666 F.LocalNumIdentifiers = Record[0];
2667 unsigned LocalBaseIdentifierID = Record[1];
2668 F.BaseIdentifierID = getTotalNumIdentifiers();
2669
2670 if (F.LocalNumIdentifiers > 0) {
2671 // Introduce the global -> local mapping for identifiers within this
2672 // module.
2673 GlobalIdentifierMap.insert(std::make_pair(getTotalNumIdentifiers() + 1,
2674 &F));
2675
2676 // Introduce the local -> global mapping for identifiers within this
2677 // module.
2678 F.IdentifierRemap.insertOrReplace(
2679 std::make_pair(LocalBaseIdentifierID,
2680 F.BaseIdentifierID - LocalBaseIdentifierID));
Ben Langmuirfe971d92014-08-16 04:54:18 +00002681
Ben Langmuir52ca6782014-10-20 16:27:32 +00002682 IdentifiersLoaded.resize(IdentifiersLoaded.size()
2683 + F.LocalNumIdentifiers);
2684 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002685 break;
2686 }
2687
Richard Smith33e0f7e2015-07-22 02:08:40 +00002688 case INTERESTING_IDENTIFIERS:
2689 F.PreloadIdentifierOffsets.assign(Record.begin(), Record.end());
2690 break;
2691
Ben Langmuir332aafe2014-01-31 01:06:56 +00002692 case EAGERLY_DESERIALIZED_DECLS:
Richard Smith9e2341d2015-03-23 03:25:59 +00002693 // FIXME: Skip reading this record if our ASTConsumer doesn't care
2694 // about "interesting" decls (for instance, if we're building a module).
Guy Benyei11169dd2012-12-18 14:30:41 +00002695 for (unsigned I = 0, N = Record.size(); I != N; ++I)
Ben Langmuir332aafe2014-01-31 01:06:56 +00002696 EagerlyDeserializedDecls.push_back(getGlobalDeclID(F, Record[I]));
Guy Benyei11169dd2012-12-18 14:30:41 +00002697 break;
2698
2699 case SPECIAL_TYPES:
Douglas Gregor44180f82013-02-01 23:45:03 +00002700 if (SpecialTypes.empty()) {
2701 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2702 SpecialTypes.push_back(getGlobalTypeID(F, Record[I]));
2703 break;
2704 }
2705
2706 if (SpecialTypes.size() != Record.size()) {
2707 Error("invalid special-types record");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002708 return Failure;
Douglas Gregor44180f82013-02-01 23:45:03 +00002709 }
2710
2711 for (unsigned I = 0, N = Record.size(); I != N; ++I) {
2712 serialization::TypeID ID = getGlobalTypeID(F, Record[I]);
2713 if (!SpecialTypes[I])
2714 SpecialTypes[I] = ID;
2715 // FIXME: If ID && SpecialTypes[I] != ID, do we need a separate
2716 // merge step?
2717 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002718 break;
2719
2720 case STATISTICS:
2721 TotalNumStatements += Record[0];
2722 TotalNumMacros += Record[1];
2723 TotalLexicalDeclContexts += Record[2];
2724 TotalVisibleDeclContexts += Record[3];
2725 break;
2726
2727 case UNUSED_FILESCOPED_DECLS:
2728 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2729 UnusedFileScopedDecls.push_back(getGlobalDeclID(F, Record[I]));
2730 break;
2731
2732 case DELEGATING_CTORS:
2733 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2734 DelegatingCtorDecls.push_back(getGlobalDeclID(F, Record[I]));
2735 break;
2736
2737 case WEAK_UNDECLARED_IDENTIFIERS:
2738 if (Record.size() % 4 != 0) {
2739 Error("invalid weak identifiers record");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002740 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002741 }
2742
2743 // FIXME: Ignore weak undeclared identifiers from non-original PCH
2744 // files. This isn't the way to do it :)
2745 WeakUndeclaredIdentifiers.clear();
2746
2747 // Translate the weak, undeclared identifiers into global IDs.
2748 for (unsigned I = 0, N = Record.size(); I < N; /* in loop */) {
2749 WeakUndeclaredIdentifiers.push_back(
2750 getGlobalIdentifierID(F, Record[I++]));
2751 WeakUndeclaredIdentifiers.push_back(
2752 getGlobalIdentifierID(F, Record[I++]));
2753 WeakUndeclaredIdentifiers.push_back(
2754 ReadSourceLocation(F, Record, I).getRawEncoding());
2755 WeakUndeclaredIdentifiers.push_back(Record[I++]);
2756 }
2757 break;
2758
Guy Benyei11169dd2012-12-18 14:30:41 +00002759 case SELECTOR_OFFSETS: {
Chris Lattner0e6c9402013-01-20 02:38:54 +00002760 F.SelectorOffsets = (const uint32_t *)Blob.data();
Guy Benyei11169dd2012-12-18 14:30:41 +00002761 F.LocalNumSelectors = Record[0];
2762 unsigned LocalBaseSelectorID = Record[1];
2763 F.BaseSelectorID = getTotalNumSelectors();
2764
2765 if (F.LocalNumSelectors > 0) {
2766 // Introduce the global -> local mapping for selectors within this
2767 // module.
2768 GlobalSelectorMap.insert(std::make_pair(getTotalNumSelectors()+1, &F));
2769
2770 // Introduce the local -> global mapping for selectors within this
2771 // module.
2772 F.SelectorRemap.insertOrReplace(
2773 std::make_pair(LocalBaseSelectorID,
2774 F.BaseSelectorID - LocalBaseSelectorID));
Ben Langmuir52ca6782014-10-20 16:27:32 +00002775
2776 SelectorsLoaded.resize(SelectorsLoaded.size() + F.LocalNumSelectors);
Guy Benyei11169dd2012-12-18 14:30:41 +00002777 }
2778 break;
2779 }
2780
2781 case METHOD_POOL:
Chris Lattner0e6c9402013-01-20 02:38:54 +00002782 F.SelectorLookupTableData = (const unsigned char *)Blob.data();
Guy Benyei11169dd2012-12-18 14:30:41 +00002783 if (Record[0])
2784 F.SelectorLookupTable
2785 = ASTSelectorLookupTable::Create(
2786 F.SelectorLookupTableData + Record[0],
2787 F.SelectorLookupTableData,
2788 ASTSelectorLookupTrait(*this, F));
2789 TotalNumMethodPoolEntries += Record[1];
2790 break;
2791
2792 case REFERENCED_SELECTOR_POOL:
2793 if (!Record.empty()) {
2794 for (unsigned Idx = 0, N = Record.size() - 1; Idx < N; /* in loop */) {
2795 ReferencedSelectorsData.push_back(getGlobalSelectorID(F,
2796 Record[Idx++]));
2797 ReferencedSelectorsData.push_back(ReadSourceLocation(F, Record, Idx).
2798 getRawEncoding());
2799 }
2800 }
2801 break;
2802
2803 case PP_COUNTER_VALUE:
2804 if (!Record.empty() && Listener)
2805 Listener->ReadCounter(F, Record[0]);
2806 break;
2807
2808 case FILE_SORTED_DECLS:
Chris Lattner0e6c9402013-01-20 02:38:54 +00002809 F.FileSortedDecls = (const DeclID *)Blob.data();
Guy Benyei11169dd2012-12-18 14:30:41 +00002810 F.NumFileSortedDecls = Record[0];
2811 break;
2812
2813 case SOURCE_LOCATION_OFFSETS: {
Chris Lattner0e6c9402013-01-20 02:38:54 +00002814 F.SLocEntryOffsets = (const uint32_t *)Blob.data();
Guy Benyei11169dd2012-12-18 14:30:41 +00002815 F.LocalNumSLocEntries = Record[0];
2816 unsigned SLocSpaceSize = Record[1];
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002817 std::tie(F.SLocEntryBaseID, F.SLocEntryBaseOffset) =
Ben Langmuir52ca6782014-10-20 16:27:32 +00002818 SourceMgr.AllocateLoadedSLocEntries(F.LocalNumSLocEntries,
Guy Benyei11169dd2012-12-18 14:30:41 +00002819 SLocSpaceSize);
Richard Smith78d81ec2015-08-12 22:25:24 +00002820 if (!F.SLocEntryBaseID) {
2821 Error("ran out of source locations");
2822 break;
2823 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002824 // Make our entry in the range map. BaseID is negative and growing, so
2825 // we invert it. Because we invert it, though, we need the other end of
2826 // the range.
2827 unsigned RangeStart =
2828 unsigned(-F.SLocEntryBaseID) - F.LocalNumSLocEntries + 1;
2829 GlobalSLocEntryMap.insert(std::make_pair(RangeStart, &F));
2830 F.FirstLoc = SourceLocation::getFromRawEncoding(F.SLocEntryBaseOffset);
2831
2832 // SLocEntryBaseOffset is lower than MaxLoadedOffset and decreasing.
2833 assert((F.SLocEntryBaseOffset & (1U << 31U)) == 0);
2834 GlobalSLocOffsetMap.insert(
2835 std::make_pair(SourceManager::MaxLoadedOffset - F.SLocEntryBaseOffset
2836 - SLocSpaceSize,&F));
2837
2838 // Initialize the remapping table.
2839 // Invalid stays invalid.
Richard Smithb9eab6d2014-03-20 19:44:17 +00002840 F.SLocRemap.insertOrReplace(std::make_pair(0U, 0));
Guy Benyei11169dd2012-12-18 14:30:41 +00002841 // This module. Base was 2 when being compiled.
Richard Smithb9eab6d2014-03-20 19:44:17 +00002842 F.SLocRemap.insertOrReplace(std::make_pair(2U,
Guy Benyei11169dd2012-12-18 14:30:41 +00002843 static_cast<int>(F.SLocEntryBaseOffset - 2)));
2844
2845 TotalNumSLocEntries += F.LocalNumSLocEntries;
2846 break;
2847 }
2848
2849 case MODULE_OFFSET_MAP: {
2850 // Additional remapping information.
Chris Lattner0e6c9402013-01-20 02:38:54 +00002851 const unsigned char *Data = (const unsigned char*)Blob.data();
2852 const unsigned char *DataEnd = Data + Blob.size();
Richard Smithb9eab6d2014-03-20 19:44:17 +00002853
2854 // If we see this entry before SOURCE_LOCATION_OFFSETS, add placeholders.
2855 if (F.SLocRemap.find(0) == F.SLocRemap.end()) {
2856 F.SLocRemap.insert(std::make_pair(0U, 0));
2857 F.SLocRemap.insert(std::make_pair(2U, 1));
2858 }
2859
Guy Benyei11169dd2012-12-18 14:30:41 +00002860 // Continuous range maps we may be updating in our module.
Ben Langmuir785180e2014-10-20 16:27:30 +00002861 typedef ContinuousRangeMap<uint32_t, int, 2>::Builder
2862 RemapBuilder;
2863 RemapBuilder SLocRemap(F.SLocRemap);
2864 RemapBuilder IdentifierRemap(F.IdentifierRemap);
2865 RemapBuilder MacroRemap(F.MacroRemap);
2866 RemapBuilder PreprocessedEntityRemap(F.PreprocessedEntityRemap);
2867 RemapBuilder SubmoduleRemap(F.SubmoduleRemap);
2868 RemapBuilder SelectorRemap(F.SelectorRemap);
2869 RemapBuilder DeclRemap(F.DeclRemap);
2870 RemapBuilder TypeRemap(F.TypeRemap);
Guy Benyei11169dd2012-12-18 14:30:41 +00002871
Richard Smithd8879c82015-08-24 21:59:32 +00002872 while (Data < DataEnd) {
Justin Bogner57ba0b22014-03-28 22:03:24 +00002873 using namespace llvm::support;
2874 uint16_t Len = endian::readNext<uint16_t, little, unaligned>(Data);
Guy Benyei11169dd2012-12-18 14:30:41 +00002875 StringRef Name = StringRef((const char*)Data, Len);
2876 Data += Len;
2877 ModuleFile *OM = ModuleMgr.lookup(Name);
2878 if (!OM) {
2879 Error("SourceLocation remap refers to unknown module");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002880 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002881 }
2882
Justin Bogner57ba0b22014-03-28 22:03:24 +00002883 uint32_t SLocOffset =
2884 endian::readNext<uint32_t, little, unaligned>(Data);
2885 uint32_t IdentifierIDOffset =
2886 endian::readNext<uint32_t, little, unaligned>(Data);
2887 uint32_t MacroIDOffset =
2888 endian::readNext<uint32_t, little, unaligned>(Data);
2889 uint32_t PreprocessedEntityIDOffset =
2890 endian::readNext<uint32_t, little, unaligned>(Data);
2891 uint32_t SubmoduleIDOffset =
2892 endian::readNext<uint32_t, little, unaligned>(Data);
2893 uint32_t SelectorIDOffset =
2894 endian::readNext<uint32_t, little, unaligned>(Data);
2895 uint32_t DeclIDOffset =
2896 endian::readNext<uint32_t, little, unaligned>(Data);
2897 uint32_t TypeIndexOffset =
2898 endian::readNext<uint32_t, little, unaligned>(Data);
2899
Ben Langmuir785180e2014-10-20 16:27:30 +00002900 uint32_t None = std::numeric_limits<uint32_t>::max();
2901
2902 auto mapOffset = [&](uint32_t Offset, uint32_t BaseOffset,
2903 RemapBuilder &Remap) {
2904 if (Offset != None)
2905 Remap.insert(std::make_pair(Offset,
2906 static_cast<int>(BaseOffset - Offset)));
2907 };
2908 mapOffset(SLocOffset, OM->SLocEntryBaseOffset, SLocRemap);
2909 mapOffset(IdentifierIDOffset, OM->BaseIdentifierID, IdentifierRemap);
2910 mapOffset(MacroIDOffset, OM->BaseMacroID, MacroRemap);
2911 mapOffset(PreprocessedEntityIDOffset, OM->BasePreprocessedEntityID,
2912 PreprocessedEntityRemap);
2913 mapOffset(SubmoduleIDOffset, OM->BaseSubmoduleID, SubmoduleRemap);
2914 mapOffset(SelectorIDOffset, OM->BaseSelectorID, SelectorRemap);
2915 mapOffset(DeclIDOffset, OM->BaseDeclID, DeclRemap);
2916 mapOffset(TypeIndexOffset, OM->BaseTypeIndex, TypeRemap);
Guy Benyei11169dd2012-12-18 14:30:41 +00002917
2918 // Global -> local mappings.
2919 F.GlobalToLocalDeclIDs[OM] = DeclIDOffset;
2920 }
2921 break;
2922 }
2923
2924 case SOURCE_MANAGER_LINE_TABLE:
2925 if (ParseLineTable(F, Record))
Ben Langmuir2c9af442014-04-10 17:57:43 +00002926 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002927 break;
2928
2929 case SOURCE_LOCATION_PRELOADS: {
2930 // Need to transform from the local view (1-based IDs) to the global view,
2931 // which is based off F.SLocEntryBaseID.
2932 if (!F.PreloadSLocEntries.empty()) {
2933 Error("Multiple SOURCE_LOCATION_PRELOADS records in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002934 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002935 }
2936
2937 F.PreloadSLocEntries.swap(Record);
2938 break;
2939 }
2940
2941 case EXT_VECTOR_DECLS:
2942 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2943 ExtVectorDecls.push_back(getGlobalDeclID(F, Record[I]));
2944 break;
2945
2946 case VTABLE_USES:
2947 if (Record.size() % 3 != 0) {
2948 Error("Invalid VTABLE_USES record");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002949 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002950 }
2951
2952 // Later tables overwrite earlier ones.
2953 // FIXME: Modules will have some trouble with this. This is clearly not
2954 // the right way to do this.
2955 VTableUses.clear();
2956
2957 for (unsigned Idx = 0, N = Record.size(); Idx != N; /* In loop */) {
2958 VTableUses.push_back(getGlobalDeclID(F, Record[Idx++]));
2959 VTableUses.push_back(
2960 ReadSourceLocation(F, Record, Idx).getRawEncoding());
2961 VTableUses.push_back(Record[Idx++]);
2962 }
2963 break;
2964
Guy Benyei11169dd2012-12-18 14:30:41 +00002965 case PENDING_IMPLICIT_INSTANTIATIONS:
2966 if (PendingInstantiations.size() % 2 != 0) {
2967 Error("Invalid existing PendingInstantiations");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002968 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002969 }
2970
2971 if (Record.size() % 2 != 0) {
2972 Error("Invalid PENDING_IMPLICIT_INSTANTIATIONS block");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002973 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00002974 }
2975
2976 for (unsigned I = 0, N = Record.size(); I != N; /* in loop */) {
2977 PendingInstantiations.push_back(getGlobalDeclID(F, Record[I++]));
2978 PendingInstantiations.push_back(
2979 ReadSourceLocation(F, Record, I).getRawEncoding());
2980 }
2981 break;
2982
2983 case SEMA_DECL_REFS:
Richard Smith3d8e97e2013-10-18 06:54:39 +00002984 if (Record.size() != 2) {
2985 Error("Invalid SEMA_DECL_REFS block");
Ben Langmuir2c9af442014-04-10 17:57:43 +00002986 return Failure;
Richard Smith3d8e97e2013-10-18 06:54:39 +00002987 }
Guy Benyei11169dd2012-12-18 14:30:41 +00002988 for (unsigned I = 0, N = Record.size(); I != N; ++I)
2989 SemaDeclRefs.push_back(getGlobalDeclID(F, Record[I]));
2990 break;
2991
2992 case PPD_ENTITIES_OFFSETS: {
Chris Lattner0e6c9402013-01-20 02:38:54 +00002993 F.PreprocessedEntityOffsets = (const PPEntityOffset *)Blob.data();
2994 assert(Blob.size() % sizeof(PPEntityOffset) == 0);
2995 F.NumPreprocessedEntities = Blob.size() / sizeof(PPEntityOffset);
Guy Benyei11169dd2012-12-18 14:30:41 +00002996
2997 unsigned LocalBasePreprocessedEntityID = Record[0];
2998
2999 unsigned StartingID;
3000 if (!PP.getPreprocessingRecord())
3001 PP.createPreprocessingRecord();
3002 if (!PP.getPreprocessingRecord()->getExternalSource())
3003 PP.getPreprocessingRecord()->SetExternalSource(*this);
3004 StartingID
3005 = PP.getPreprocessingRecord()
Ben Langmuir52ca6782014-10-20 16:27:32 +00003006 ->allocateLoadedEntities(F.NumPreprocessedEntities);
Guy Benyei11169dd2012-12-18 14:30:41 +00003007 F.BasePreprocessedEntityID = StartingID;
3008
3009 if (F.NumPreprocessedEntities > 0) {
3010 // Introduce the global -> local mapping for preprocessed entities in
3011 // this module.
3012 GlobalPreprocessedEntityMap.insert(std::make_pair(StartingID, &F));
3013
3014 // Introduce the local -> global mapping for preprocessed entities in
3015 // this module.
3016 F.PreprocessedEntityRemap.insertOrReplace(
3017 std::make_pair(LocalBasePreprocessedEntityID,
3018 F.BasePreprocessedEntityID - LocalBasePreprocessedEntityID));
3019 }
3020
3021 break;
3022 }
3023
3024 case DECL_UPDATE_OFFSETS: {
3025 if (Record.size() % 2 != 0) {
3026 Error("invalid DECL_UPDATE_OFFSETS block in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00003027 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00003028 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00003029 for (unsigned I = 0, N = Record.size(); I != N; I += 2) {
3030 GlobalDeclID ID = getGlobalDeclID(F, Record[I]);
3031 DeclUpdateOffsets[ID].push_back(std::make_pair(&F, Record[I + 1]));
3032
3033 // If we've already loaded the decl, perform the updates when we finish
3034 // loading this block.
3035 if (Decl *D = GetExistingDecl(ID))
3036 PendingUpdateRecords.push_back(std::make_pair(ID, D));
3037 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003038 break;
3039 }
3040
Guy Benyei11169dd2012-12-18 14:30:41 +00003041 case OBJC_CATEGORIES_MAP: {
3042 if (F.LocalNumObjCCategoriesInMap != 0) {
3043 Error("duplicate OBJC_CATEGORIES_MAP record in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00003044 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00003045 }
3046
3047 F.LocalNumObjCCategoriesInMap = Record[0];
Chris Lattner0e6c9402013-01-20 02:38:54 +00003048 F.ObjCCategoriesMap = (const ObjCCategoriesInfo *)Blob.data();
Guy Benyei11169dd2012-12-18 14:30:41 +00003049 break;
3050 }
3051
3052 case OBJC_CATEGORIES:
3053 F.ObjCCategories.swap(Record);
3054 break;
Richard Smithc2bb8182015-03-24 06:36:48 +00003055
Guy Benyei11169dd2012-12-18 14:30:41 +00003056 case DIAG_PRAGMA_MAPPINGS:
3057 if (F.PragmaDiagMappings.empty())
3058 F.PragmaDiagMappings.swap(Record);
3059 else
3060 F.PragmaDiagMappings.insert(F.PragmaDiagMappings.end(),
3061 Record.begin(), Record.end());
3062 break;
3063
3064 case CUDA_SPECIAL_DECL_REFS:
3065 // Later tables overwrite earlier ones.
3066 // FIXME: Modules will have trouble with this.
3067 CUDASpecialDeclRefs.clear();
3068 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3069 CUDASpecialDeclRefs.push_back(getGlobalDeclID(F, Record[I]));
3070 break;
3071
3072 case HEADER_SEARCH_TABLE: {
Chris Lattner0e6c9402013-01-20 02:38:54 +00003073 F.HeaderFileInfoTableData = Blob.data();
Guy Benyei11169dd2012-12-18 14:30:41 +00003074 F.LocalNumHeaderFileInfos = Record[1];
Guy Benyei11169dd2012-12-18 14:30:41 +00003075 if (Record[0]) {
3076 F.HeaderFileInfoTable
3077 = HeaderFileInfoLookupTable::Create(
3078 (const unsigned char *)F.HeaderFileInfoTableData + Record[0],
3079 (const unsigned char *)F.HeaderFileInfoTableData,
3080 HeaderFileInfoTrait(*this, F,
3081 &PP.getHeaderSearchInfo(),
Chris Lattner0e6c9402013-01-20 02:38:54 +00003082 Blob.data() + Record[2]));
Guy Benyei11169dd2012-12-18 14:30:41 +00003083
3084 PP.getHeaderSearchInfo().SetExternalSource(this);
3085 if (!PP.getHeaderSearchInfo().getExternalLookup())
3086 PP.getHeaderSearchInfo().SetExternalLookup(this);
3087 }
3088 break;
3089 }
3090
3091 case FP_PRAGMA_OPTIONS:
3092 // Later tables overwrite earlier ones.
3093 FPPragmaOptions.swap(Record);
3094 break;
3095
3096 case OPENCL_EXTENSIONS:
3097 // Later tables overwrite earlier ones.
3098 OpenCLExtensions.swap(Record);
3099 break;
3100
3101 case TENTATIVE_DEFINITIONS:
3102 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3103 TentativeDefinitions.push_back(getGlobalDeclID(F, Record[I]));
3104 break;
3105
3106 case KNOWN_NAMESPACES:
3107 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3108 KnownNamespaces.push_back(getGlobalDeclID(F, Record[I]));
3109 break;
Nick Lewycky8334af82013-01-26 00:35:08 +00003110
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00003111 case UNDEFINED_BUT_USED:
3112 if (UndefinedButUsed.size() % 2 != 0) {
3113 Error("Invalid existing UndefinedButUsed");
Ben Langmuir2c9af442014-04-10 17:57:43 +00003114 return Failure;
Nick Lewycky8334af82013-01-26 00:35:08 +00003115 }
3116
3117 if (Record.size() % 2 != 0) {
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00003118 Error("invalid undefined-but-used record");
Ben Langmuir2c9af442014-04-10 17:57:43 +00003119 return Failure;
Nick Lewycky8334af82013-01-26 00:35:08 +00003120 }
3121 for (unsigned I = 0, N = Record.size(); I != N; /* in loop */) {
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00003122 UndefinedButUsed.push_back(getGlobalDeclID(F, Record[I++]));
3123 UndefinedButUsed.push_back(
Nick Lewycky8334af82013-01-26 00:35:08 +00003124 ReadSourceLocation(F, Record, I).getRawEncoding());
3125 }
3126 break;
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00003127 case DELETE_EXPRS_TO_ANALYZE:
3128 for (unsigned I = 0, N = Record.size(); I != N;) {
3129 DelayedDeleteExprs.push_back(getGlobalDeclID(F, Record[I++]));
3130 const uint64_t Count = Record[I++];
3131 DelayedDeleteExprs.push_back(Count);
3132 for (uint64_t C = 0; C < Count; ++C) {
3133 DelayedDeleteExprs.push_back(ReadSourceLocation(F, Record, I).getRawEncoding());
3134 bool IsArrayForm = Record[I++] == 1;
3135 DelayedDeleteExprs.push_back(IsArrayForm);
3136 }
3137 }
3138 break;
Nick Lewycky8334af82013-01-26 00:35:08 +00003139
Guy Benyei11169dd2012-12-18 14:30:41 +00003140 case IMPORTED_MODULES: {
Richard Smithe842a472014-10-22 02:05:46 +00003141 if (F.Kind != MK_ImplicitModule && F.Kind != MK_ExplicitModule) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003142 // If we aren't loading a module (which has its own exports), make
3143 // all of the imported modules visible.
3144 // FIXME: Deal with macros-only imports.
Richard Smith56be7542014-03-21 00:33:59 +00003145 for (unsigned I = 0, N = Record.size(); I != N; /**/) {
3146 unsigned GlobalID = getGlobalSubmoduleID(F, Record[I++]);
3147 SourceLocation Loc = ReadSourceLocation(F, Record, I);
3148 if (GlobalID)
Aaron Ballman4f45b712014-03-21 15:22:56 +00003149 ImportedModules.push_back(ImportedSubmodule(GlobalID, Loc));
Guy Benyei11169dd2012-12-18 14:30:41 +00003150 }
3151 }
3152 break;
3153 }
3154
Guy Benyei11169dd2012-12-18 14:30:41 +00003155 case MACRO_OFFSET: {
3156 if (F.LocalNumMacros != 0) {
3157 Error("duplicate MACRO_OFFSET record in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00003158 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00003159 }
Chris Lattner0e6c9402013-01-20 02:38:54 +00003160 F.MacroOffsets = (const uint32_t *)Blob.data();
Guy Benyei11169dd2012-12-18 14:30:41 +00003161 F.LocalNumMacros = Record[0];
3162 unsigned LocalBaseMacroID = Record[1];
3163 F.BaseMacroID = getTotalNumMacros();
3164
3165 if (F.LocalNumMacros > 0) {
3166 // Introduce the global -> local mapping for macros within this module.
3167 GlobalMacroMap.insert(std::make_pair(getTotalNumMacros() + 1, &F));
3168
3169 // Introduce the local -> global mapping for macros within this module.
3170 F.MacroRemap.insertOrReplace(
3171 std::make_pair(LocalBaseMacroID,
3172 F.BaseMacroID - LocalBaseMacroID));
Ben Langmuir52ca6782014-10-20 16:27:32 +00003173
3174 MacrosLoaded.resize(MacrosLoaded.size() + F.LocalNumMacros);
Guy Benyei11169dd2012-12-18 14:30:41 +00003175 }
3176 break;
3177 }
3178
Richard Smithe40f2ba2013-08-07 21:41:30 +00003179 case LATE_PARSED_TEMPLATE: {
3180 LateParsedTemplates.append(Record.begin(), Record.end());
3181 break;
3182 }
Dario Domizioli13a0a382014-05-23 12:13:25 +00003183
3184 case OPTIMIZE_PRAGMA_OPTIONS:
3185 if (Record.size() != 1) {
3186 Error("invalid pragma optimize record");
3187 return Failure;
3188 }
3189 OptimizeOffPragmaLocation = ReadSourceLocation(F, Record[0]);
3190 break;
Nico Weber72889432014-09-06 01:25:55 +00003191
Nico Weber779355f2016-03-02 23:22:00 +00003192 case MSSTRUCT_PRAGMA_OPTIONS:
3193 if (Record.size() != 1) {
3194 Error("invalid pragma ms_struct record");
3195 return Failure;
3196 }
3197 PragmaMSStructState = Record[0];
3198 break;
3199
Nico Weber42932312016-03-03 00:17:35 +00003200 case POINTERS_TO_MEMBERS_PRAGMA_OPTIONS:
3201 if (Record.size() != 2) {
3202 Error("invalid pragma ms_struct record");
3203 return Failure;
3204 }
3205 PragmaMSPointersToMembersState = Record[0];
3206 PointersToMembersPragmaLocation = ReadSourceLocation(F, Record[1]);
3207 break;
3208
Nico Weber72889432014-09-06 01:25:55 +00003209 case UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES:
3210 for (unsigned I = 0, N = Record.size(); I != N; ++I)
3211 UnusedLocalTypedefNameCandidates.push_back(
3212 getGlobalDeclID(F, Record[I]));
3213 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00003214 }
3215 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003216}
3217
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00003218ASTReader::ASTReadResult
3219ASTReader::ReadModuleMapFileBlock(RecordData &Record, ModuleFile &F,
3220 const ModuleFile *ImportedBy,
3221 unsigned ClientLoadCapabilities) {
3222 unsigned Idx = 0;
Richard Smith7ed1bc92014-12-05 22:42:13 +00003223 F.ModuleMapPath = ReadPath(F, Record, Idx);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00003224
Richard Smithe842a472014-10-22 02:05:46 +00003225 if (F.Kind == MK_ExplicitModule) {
3226 // For an explicitly-loaded module, we don't care whether the original
3227 // module map file exists or matches.
3228 return Success;
3229 }
3230
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00003231 // Try to resolve ModuleName in the current header search context and
3232 // verify that it is found in the same module map file as we saved. If the
3233 // top-level AST file is a main file, skip this check because there is no
3234 // usable header search context.
3235 assert(!F.ModuleName.empty() &&
Richard Smithe842a472014-10-22 02:05:46 +00003236 "MODULE_NAME should come before MODULE_MAP_FILE");
3237 if (F.Kind == MK_ImplicitModule &&
3238 (*ModuleMgr.begin())->Kind != MK_MainFile) {
3239 // An implicitly-loaded module file should have its module listed in some
3240 // module map file that we've already loaded.
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00003241 Module *M = PP.getHeaderSearchInfo().lookupModule(F.ModuleName);
Richard Smithe842a472014-10-22 02:05:46 +00003242 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
3243 const FileEntry *ModMap = M ? Map.getModuleMapFileForUniquing(M) : nullptr;
3244 if (!ModMap) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00003245 assert(ImportedBy && "top-level import should be verified");
Richard Smith0f99d6a2015-08-09 08:48:41 +00003246 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0) {
3247 if (auto *ASTFE = M ? M->getASTFile() : nullptr)
3248 // This module was defined by an imported (explicit) module.
3249 Diag(diag::err_module_file_conflict) << F.ModuleName << F.FileName
3250 << ASTFE->getName();
3251 else
3252 // This module was built with a different module map.
3253 Diag(diag::err_imported_module_not_found)
3254 << F.ModuleName << F.FileName << ImportedBy->FileName
3255 << F.ModuleMapPath;
3256 }
3257 return OutOfDate;
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00003258 }
3259
Richard Smithe842a472014-10-22 02:05:46 +00003260 assert(M->Name == F.ModuleName && "found module with different name");
3261
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00003262 // Check the primary module map file.
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00003263 const FileEntry *StoredModMap = FileMgr.getFile(F.ModuleMapPath);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00003264 if (StoredModMap == nullptr || StoredModMap != ModMap) {
3265 assert(ModMap && "found module is missing module map file");
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00003266 assert(ImportedBy && "top-level import should be verified");
3267 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3268 Diag(diag::err_imported_module_modmap_changed)
3269 << F.ModuleName << ImportedBy->FileName
3270 << ModMap->getName() << F.ModuleMapPath;
3271 return OutOfDate;
3272 }
3273
3274 llvm::SmallPtrSet<const FileEntry *, 1> AdditionalStoredMaps;
3275 for (unsigned I = 0, N = Record[Idx++]; I < N; ++I) {
3276 // FIXME: we should use input files rather than storing names.
Richard Smith7ed1bc92014-12-05 22:42:13 +00003277 std::string Filename = ReadPath(F, Record, Idx);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00003278 const FileEntry *F =
3279 FileMgr.getFile(Filename, false, false);
3280 if (F == nullptr) {
3281 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3282 Error("could not find file '" + Filename +"' referenced by AST file");
3283 return OutOfDate;
3284 }
3285 AdditionalStoredMaps.insert(F);
3286 }
3287
3288 // Check any additional module map files (e.g. module.private.modulemap)
3289 // that are not in the pcm.
3290 if (auto *AdditionalModuleMaps = Map.getAdditionalModuleMapFiles(M)) {
3291 for (const FileEntry *ModMap : *AdditionalModuleMaps) {
3292 // Remove files that match
3293 // Note: SmallPtrSet::erase is really remove
3294 if (!AdditionalStoredMaps.erase(ModMap)) {
3295 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3296 Diag(diag::err_module_different_modmap)
3297 << F.ModuleName << /*new*/0 << ModMap->getName();
3298 return OutOfDate;
3299 }
3300 }
3301 }
3302
3303 // Check any additional module map files that are in the pcm, but not
3304 // found in header search. Cases that match are already removed.
3305 for (const FileEntry *ModMap : AdditionalStoredMaps) {
3306 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
3307 Diag(diag::err_module_different_modmap)
3308 << F.ModuleName << /*not new*/1 << ModMap->getName();
3309 return OutOfDate;
3310 }
3311 }
3312
3313 if (Listener)
3314 Listener->ReadModuleMapFile(F.ModuleMapPath);
3315 return Success;
3316}
3317
3318
Douglas Gregorc1489562013-02-12 23:36:21 +00003319/// \brief Move the given method to the back of the global list of methods.
3320static void moveMethodToBackOfGlobalList(Sema &S, ObjCMethodDecl *Method) {
3321 // Find the entry for this selector in the method pool.
3322 Sema::GlobalMethodPool::iterator Known
3323 = S.MethodPool.find(Method->getSelector());
3324 if (Known == S.MethodPool.end())
3325 return;
3326
3327 // Retrieve the appropriate method list.
3328 ObjCMethodList &Start = Method->isInstanceMethod()? Known->second.first
3329 : Known->second.second;
3330 bool Found = false;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003331 for (ObjCMethodList *List = &Start; List; List = List->getNext()) {
Douglas Gregorc1489562013-02-12 23:36:21 +00003332 if (!Found) {
Nico Weber2e0c8f72014-12-27 03:58:08 +00003333 if (List->getMethod() == Method) {
Douglas Gregorc1489562013-02-12 23:36:21 +00003334 Found = true;
3335 } else {
3336 // Keep searching.
3337 continue;
3338 }
3339 }
3340
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003341 if (List->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003342 List->setMethod(List->getNext()->getMethod());
Douglas Gregorc1489562013-02-12 23:36:21 +00003343 else
Nico Weber2e0c8f72014-12-27 03:58:08 +00003344 List->setMethod(Method);
Douglas Gregorc1489562013-02-12 23:36:21 +00003345 }
3346}
3347
Richard Smithde711422015-04-23 21:20:19 +00003348void ASTReader::makeNamesVisible(const HiddenNames &Names, Module *Owner) {
Richard Smith10434f32015-05-02 02:08:26 +00003349 assert(Owner->NameVisibility != Module::Hidden && "nothing to make visible?");
Richard Smith20e883e2015-04-29 23:20:19 +00003350 for (Decl *D : Names) {
Richard Smith49f906a2014-03-01 00:08:04 +00003351 bool wasHidden = D->Hidden;
3352 D->Hidden = false;
Guy Benyei11169dd2012-12-18 14:30:41 +00003353
Richard Smith49f906a2014-03-01 00:08:04 +00003354 if (wasHidden && SemaObj) {
3355 if (ObjCMethodDecl *Method = dyn_cast<ObjCMethodDecl>(D)) {
3356 moveMethodToBackOfGlobalList(*SemaObj, Method);
Douglas Gregorc1489562013-02-12 23:36:21 +00003357 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003358 }
3359 }
3360}
3361
Richard Smith49f906a2014-03-01 00:08:04 +00003362void ASTReader::makeModuleVisible(Module *Mod,
Argyrios Kyrtzidis125df052013-02-01 16:36:12 +00003363 Module::NameVisibilityKind NameVisibility,
Richard Smitha7e2cc62015-05-01 01:53:09 +00003364 SourceLocation ImportLoc) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003365 llvm::SmallPtrSet<Module *, 4> Visited;
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003366 SmallVector<Module *, 4> Stack;
Robert Wilhelm25284cc2013-08-23 16:11:15 +00003367 Stack.push_back(Mod);
Guy Benyei11169dd2012-12-18 14:30:41 +00003368 while (!Stack.empty()) {
Robert Wilhelm25284cc2013-08-23 16:11:15 +00003369 Mod = Stack.pop_back_val();
Guy Benyei11169dd2012-12-18 14:30:41 +00003370
3371 if (NameVisibility <= Mod->NameVisibility) {
Robert Wilhelm25284cc2013-08-23 16:11:15 +00003372 // This module already has this level of visibility (or greater), so
Guy Benyei11169dd2012-12-18 14:30:41 +00003373 // there is nothing more to do.
3374 continue;
3375 }
Richard Smith49f906a2014-03-01 00:08:04 +00003376
Guy Benyei11169dd2012-12-18 14:30:41 +00003377 if (!Mod->isAvailable()) {
3378 // Modules that aren't available cannot be made visible.
3379 continue;
3380 }
3381
3382 // Update the module's name visibility.
3383 Mod->NameVisibility = NameVisibility;
Richard Smith49f906a2014-03-01 00:08:04 +00003384
Guy Benyei11169dd2012-12-18 14:30:41 +00003385 // If we've already deserialized any names from this module,
3386 // mark them as visible.
3387 HiddenNamesMapType::iterator Hidden = HiddenNamesMap.find(Mod);
3388 if (Hidden != HiddenNamesMap.end()) {
Richard Smith57721ac2014-07-21 04:10:40 +00003389 auto HiddenNames = std::move(*Hidden);
Guy Benyei11169dd2012-12-18 14:30:41 +00003390 HiddenNamesMap.erase(Hidden);
Richard Smithde711422015-04-23 21:20:19 +00003391 makeNamesVisible(HiddenNames.second, HiddenNames.first);
Richard Smith57721ac2014-07-21 04:10:40 +00003392 assert(HiddenNamesMap.find(Mod) == HiddenNamesMap.end() &&
3393 "making names visible added hidden names");
Guy Benyei11169dd2012-12-18 14:30:41 +00003394 }
Dmitri Gribenkoe9bcf5b2013-11-04 21:51:33 +00003395
Guy Benyei11169dd2012-12-18 14:30:41 +00003396 // Push any exported modules onto the stack to be marked as visible.
Argyrios Kyrtzidis8739f7b2013-02-19 19:34:40 +00003397 SmallVector<Module *, 16> Exports;
3398 Mod->getExportedModules(Exports);
3399 for (SmallVectorImpl<Module *>::iterator
3400 I = Exports.begin(), E = Exports.end(); I != E; ++I) {
3401 Module *Exported = *I;
David Blaikie82e95a32014-11-19 07:49:47 +00003402 if (Visited.insert(Exported).second)
Argyrios Kyrtzidis8739f7b2013-02-19 19:34:40 +00003403 Stack.push_back(Exported);
Guy Benyei11169dd2012-12-18 14:30:41 +00003404 }
3405 }
3406}
3407
Douglas Gregore060e572013-01-25 01:03:03 +00003408bool ASTReader::loadGlobalIndex() {
3409 if (GlobalIndex)
3410 return false;
3411
3412 if (TriedLoadingGlobalIndex || !UseGlobalIndex ||
3413 !Context.getLangOpts().Modules)
3414 return true;
3415
3416 // Try to load the global index.
3417 TriedLoadingGlobalIndex = true;
3418 StringRef ModuleCachePath
3419 = getPreprocessor().getHeaderSearchInfo().getModuleCachePath();
3420 std::pair<GlobalModuleIndex *, GlobalModuleIndex::ErrorCode> Result
Douglas Gregor7029ce12013-03-19 00:28:20 +00003421 = GlobalModuleIndex::readIndex(ModuleCachePath);
Douglas Gregore060e572013-01-25 01:03:03 +00003422 if (!Result.first)
3423 return true;
3424
3425 GlobalIndex.reset(Result.first);
Douglas Gregor7211ac12013-01-25 23:32:03 +00003426 ModuleMgr.setGlobalIndex(GlobalIndex.get());
Douglas Gregore060e572013-01-25 01:03:03 +00003427 return false;
3428}
3429
3430bool ASTReader::isGlobalIndexUnavailable() const {
3431 return Context.getLangOpts().Modules && UseGlobalIndex &&
3432 !hasGlobalIndex() && TriedLoadingGlobalIndex;
3433}
3434
Dmitri Gribenkof430da42014-02-12 10:33:14 +00003435static void updateModuleTimestamp(ModuleFile &MF) {
3436 // Overwrite the timestamp file contents so that file's mtime changes.
3437 std::string TimestampFilename = MF.getTimestampFilename();
Rafael Espindoladae941a2014-08-25 18:17:04 +00003438 std::error_code EC;
3439 llvm::raw_fd_ostream OS(TimestampFilename, EC, llvm::sys::fs::F_Text);
3440 if (EC)
Dmitri Gribenkof430da42014-02-12 10:33:14 +00003441 return;
3442 OS << "Timestamp file\n";
3443}
3444
Douglas Gregor6623e1f2015-11-03 18:33:07 +00003445/// \brief Given a cursor at the start of an AST file, scan ahead and drop the
3446/// cursor into the start of the given block ID, returning false on success and
3447/// true on failure.
3448static bool SkipCursorToBlock(BitstreamCursor &Cursor, unsigned BlockID) {
3449 while (1) {
3450 llvm::BitstreamEntry Entry = Cursor.advance();
3451 switch (Entry.Kind) {
3452 case llvm::BitstreamEntry::Error:
3453 case llvm::BitstreamEntry::EndBlock:
3454 return true;
3455
3456 case llvm::BitstreamEntry::Record:
3457 // Ignore top-level records.
3458 Cursor.skipRecord(Entry.ID);
3459 break;
3460
3461 case llvm::BitstreamEntry::SubBlock:
3462 if (Entry.ID == BlockID) {
3463 if (Cursor.EnterSubBlock(BlockID))
3464 return true;
3465 // Found it!
3466 return false;
3467 }
3468
3469 if (Cursor.SkipBlock())
3470 return true;
3471 }
3472 }
3473}
3474
Benjamin Kramer0772c422016-02-13 13:42:54 +00003475ASTReader::ASTReadResult ASTReader::ReadAST(StringRef FileName,
Guy Benyei11169dd2012-12-18 14:30:41 +00003476 ModuleKind Type,
3477 SourceLocation ImportLoc,
3478 unsigned ClientLoadCapabilities) {
Argyrios Kyrtzidisdc9fdaf2013-05-24 05:44:08 +00003479 llvm::SaveAndRestore<SourceLocation>
3480 SetCurImportLocRAII(CurrentImportLoc, ImportLoc);
3481
Richard Smithd1c46742014-04-30 02:24:17 +00003482 // Defer any pending actions until we get to the end of reading the AST file.
3483 Deserializing AnASTFile(this);
3484
Guy Benyei11169dd2012-12-18 14:30:41 +00003485 // Bump the generation number.
Richard Smith053f6c62014-05-16 23:01:30 +00003486 unsigned PreviousGeneration = incrementGeneration(Context);
Guy Benyei11169dd2012-12-18 14:30:41 +00003487
3488 unsigned NumModules = ModuleMgr.size();
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003489 SmallVector<ImportedModule, 4> Loaded;
Guy Benyei11169dd2012-12-18 14:30:41 +00003490 switch(ASTReadResult ReadResult = ReadASTCore(FileName, Type, ImportLoc,
Craig Toppera13603a2014-05-22 05:54:18 +00003491 /*ImportedBy=*/nullptr, Loaded,
Ben Langmuir487ea142014-10-23 18:05:36 +00003492 0, 0, 0,
Guy Benyei11169dd2012-12-18 14:30:41 +00003493 ClientLoadCapabilities)) {
3494 case Failure:
Douglas Gregor7029ce12013-03-19 00:28:20 +00003495 case Missing:
Guy Benyei11169dd2012-12-18 14:30:41 +00003496 case OutOfDate:
3497 case VersionMismatch:
3498 case ConfigurationMismatch:
Ben Langmuir9801b252014-06-20 00:24:56 +00003499 case HadErrors: {
3500 llvm::SmallPtrSet<ModuleFile *, 4> LoadedSet;
3501 for (const ImportedModule &IM : Loaded)
3502 LoadedSet.insert(IM.Mod);
3503
Douglas Gregor7029ce12013-03-19 00:28:20 +00003504 ModuleMgr.removeModules(ModuleMgr.begin() + NumModules, ModuleMgr.end(),
Ben Langmuir9801b252014-06-20 00:24:56 +00003505 LoadedSet,
Douglas Gregor7029ce12013-03-19 00:28:20 +00003506 Context.getLangOpts().Modules
3507 ? &PP.getHeaderSearchInfo().getModuleMap()
Craig Toppera13603a2014-05-22 05:54:18 +00003508 : nullptr);
Douglas Gregore060e572013-01-25 01:03:03 +00003509
3510 // If we find that any modules are unusable, the global index is going
3511 // to be out-of-date. Just remove it.
3512 GlobalIndex.reset();
Craig Toppera13603a2014-05-22 05:54:18 +00003513 ModuleMgr.setGlobalIndex(nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00003514 return ReadResult;
Ben Langmuir9801b252014-06-20 00:24:56 +00003515 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003516 case Success:
3517 break;
3518 }
3519
3520 // Here comes stuff that we only do once the entire chain is loaded.
3521
3522 // Load the AST blocks of all of the modules that we loaded.
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003523 for (SmallVectorImpl<ImportedModule>::iterator M = Loaded.begin(),
3524 MEnd = Loaded.end();
Guy Benyei11169dd2012-12-18 14:30:41 +00003525 M != MEnd; ++M) {
3526 ModuleFile &F = *M->Mod;
3527
3528 // Read the AST block.
Ben Langmuir2c9af442014-04-10 17:57:43 +00003529 if (ASTReadResult Result = ReadASTBlock(F, ClientLoadCapabilities))
3530 return Result;
Guy Benyei11169dd2012-12-18 14:30:41 +00003531
Douglas Gregor6623e1f2015-11-03 18:33:07 +00003532 // Read the extension blocks.
3533 while (!SkipCursorToBlock(F.Stream, EXTENSION_BLOCK_ID)) {
3534 if (ASTReadResult Result = ReadExtensionBlock(F))
3535 return Result;
3536 }
3537
Guy Benyei11169dd2012-12-18 14:30:41 +00003538 // Once read, set the ModuleFile bit base offset and update the size in
3539 // bits of all files we've seen.
3540 F.GlobalBitOffset = TotalModulesSizeInBits;
3541 TotalModulesSizeInBits += F.SizeInBits;
3542 GlobalBitOffsetsMap.insert(std::make_pair(F.GlobalBitOffset, &F));
3543
3544 // Preload SLocEntries.
3545 for (unsigned I = 0, N = F.PreloadSLocEntries.size(); I != N; ++I) {
3546 int Index = int(F.PreloadSLocEntries[I] - 1) + F.SLocEntryBaseID;
3547 // Load it through the SourceManager and don't call ReadSLocEntry()
3548 // directly because the entry may have already been loaded in which case
3549 // calling ReadSLocEntry() directly would trigger an assertion in
3550 // SourceManager.
3551 SourceMgr.getLoadedSLocEntryByID(Index);
3552 }
Richard Smith33e0f7e2015-07-22 02:08:40 +00003553
3554 // Preload all the pending interesting identifiers by marking them out of
3555 // date.
3556 for (auto Offset : F.PreloadIdentifierOffsets) {
3557 const unsigned char *Data = reinterpret_cast<const unsigned char *>(
3558 F.IdentifierTableData + Offset);
3559
3560 ASTIdentifierLookupTrait Trait(*this, F);
3561 auto KeyDataLen = Trait.ReadKeyDataLength(Data);
3562 auto Key = Trait.ReadKey(Data, KeyDataLen.first);
Richard Smith79bf9202015-08-24 03:33:22 +00003563 auto &II = PP.getIdentifierTable().getOwn(Key);
3564 II.setOutOfDate(true);
3565
3566 // Mark this identifier as being from an AST file so that we can track
3567 // whether we need to serialize it.
Richard Smitheb4b58f62016-02-05 01:40:54 +00003568 markIdentifierFromAST(*this, II);
Richard Smith79bf9202015-08-24 03:33:22 +00003569
3570 // Associate the ID with the identifier so that the writer can reuse it.
3571 auto ID = Trait.ReadIdentifierID(Data + KeyDataLen.first);
3572 SetIdentifierInfo(ID, &II);
Richard Smith33e0f7e2015-07-22 02:08:40 +00003573 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003574 }
3575
Douglas Gregor603cd862013-03-22 18:50:14 +00003576 // Setup the import locations and notify the module manager that we've
3577 // committed to these module files.
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003578 for (SmallVectorImpl<ImportedModule>::iterator M = Loaded.begin(),
3579 MEnd = Loaded.end();
Guy Benyei11169dd2012-12-18 14:30:41 +00003580 M != MEnd; ++M) {
3581 ModuleFile &F = *M->Mod;
Douglas Gregor603cd862013-03-22 18:50:14 +00003582
3583 ModuleMgr.moduleFileAccepted(&F);
3584
3585 // Set the import location.
Argyrios Kyrtzidis71c1af82013-02-01 16:36:14 +00003586 F.DirectImportLoc = ImportLoc;
Richard Smithb22a1d12016-03-27 20:13:24 +00003587 // FIXME: We assume that locations from PCH / preamble do not need
3588 // any translation.
Guy Benyei11169dd2012-12-18 14:30:41 +00003589 if (!M->ImportedBy)
3590 F.ImportLoc = M->ImportLoc;
3591 else
Richard Smithb22a1d12016-03-27 20:13:24 +00003592 F.ImportLoc = TranslateSourceLocation(*M->ImportedBy, M->ImportLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00003593 }
3594
Richard Smith33e0f7e2015-07-22 02:08:40 +00003595 if (!Context.getLangOpts().CPlusPlus ||
3596 (Type != MK_ImplicitModule && Type != MK_ExplicitModule)) {
3597 // Mark all of the identifiers in the identifier table as being out of date,
3598 // so that various accessors know to check the loaded modules when the
3599 // identifier is used.
3600 //
3601 // For C++ modules, we don't need information on many identifiers (just
3602 // those that provide macros or are poisoned), so we mark all of
3603 // the interesting ones via PreloadIdentifierOffsets.
3604 for (IdentifierTable::iterator Id = PP.getIdentifierTable().begin(),
3605 IdEnd = PP.getIdentifierTable().end();
3606 Id != IdEnd; ++Id)
3607 Id->second->setOutOfDate(true);
3608 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003609
3610 // Resolve any unresolved module exports.
Douglas Gregorfb912652013-03-20 21:10:35 +00003611 for (unsigned I = 0, N = UnresolvedModuleRefs.size(); I != N; ++I) {
3612 UnresolvedModuleRef &Unresolved = UnresolvedModuleRefs[I];
Guy Benyei11169dd2012-12-18 14:30:41 +00003613 SubmoduleID GlobalID = getGlobalSubmoduleID(*Unresolved.File,Unresolved.ID);
3614 Module *ResolvedMod = getSubmodule(GlobalID);
Douglas Gregorfb912652013-03-20 21:10:35 +00003615
3616 switch (Unresolved.Kind) {
3617 case UnresolvedModuleRef::Conflict:
3618 if (ResolvedMod) {
3619 Module::Conflict Conflict;
3620 Conflict.Other = ResolvedMod;
3621 Conflict.Message = Unresolved.String.str();
3622 Unresolved.Mod->Conflicts.push_back(Conflict);
3623 }
3624 continue;
3625
3626 case UnresolvedModuleRef::Import:
Guy Benyei11169dd2012-12-18 14:30:41 +00003627 if (ResolvedMod)
Richard Smith38477db2015-05-02 00:45:56 +00003628 Unresolved.Mod->Imports.insert(ResolvedMod);
Guy Benyei11169dd2012-12-18 14:30:41 +00003629 continue;
Guy Benyei11169dd2012-12-18 14:30:41 +00003630
Douglas Gregorfb912652013-03-20 21:10:35 +00003631 case UnresolvedModuleRef::Export:
3632 if (ResolvedMod || Unresolved.IsWildcard)
3633 Unresolved.Mod->Exports.push_back(
3634 Module::ExportDecl(ResolvedMod, Unresolved.IsWildcard));
3635 continue;
3636 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003637 }
Douglas Gregorfb912652013-03-20 21:10:35 +00003638 UnresolvedModuleRefs.clear();
Daniel Jasperba7f2f72013-09-24 09:14:14 +00003639
3640 // FIXME: How do we load the 'use'd modules? They may not be submodules.
3641 // Might be unnecessary as use declarations are only used to build the
3642 // module itself.
Guy Benyei11169dd2012-12-18 14:30:41 +00003643
3644 InitializeContext();
3645
Richard Smith3d8e97e2013-10-18 06:54:39 +00003646 if (SemaObj)
3647 UpdateSema();
3648
Guy Benyei11169dd2012-12-18 14:30:41 +00003649 if (DeserializationListener)
3650 DeserializationListener->ReaderInitialized(this);
3651
3652 ModuleFile &PrimaryModule = ModuleMgr.getPrimaryModule();
Yaron Keren8b563662015-10-03 10:46:20 +00003653 if (PrimaryModule.OriginalSourceFileID.isValid()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003654 PrimaryModule.OriginalSourceFileID
3655 = FileID::get(PrimaryModule.SLocEntryBaseID
3656 + PrimaryModule.OriginalSourceFileID.getOpaqueValue() - 1);
3657
3658 // If this AST file is a precompiled preamble, then set the
3659 // preamble file ID of the source manager to the file source file
3660 // from which the preamble was built.
3661 if (Type == MK_Preamble) {
3662 SourceMgr.setPreambleFileID(PrimaryModule.OriginalSourceFileID);
3663 } else if (Type == MK_MainFile) {
3664 SourceMgr.setMainFileID(PrimaryModule.OriginalSourceFileID);
3665 }
3666 }
3667
3668 // For any Objective-C class definitions we have already loaded, make sure
3669 // that we load any additional categories.
3670 for (unsigned I = 0, N = ObjCClassesLoaded.size(); I != N; ++I) {
3671 loadObjCCategories(ObjCClassesLoaded[I]->getGlobalID(),
3672 ObjCClassesLoaded[I],
3673 PreviousGeneration);
3674 }
Douglas Gregore060e572013-01-25 01:03:03 +00003675
Dmitri Gribenkof430da42014-02-12 10:33:14 +00003676 if (PP.getHeaderSearchInfo()
3677 .getHeaderSearchOpts()
3678 .ModulesValidateOncePerBuildSession) {
3679 // Now we are certain that the module and all modules it depends on are
3680 // up to date. Create or update timestamp files for modules that are
3681 // located in the module cache (not for PCH files that could be anywhere
3682 // in the filesystem).
3683 for (unsigned I = 0, N = Loaded.size(); I != N; ++I) {
3684 ImportedModule &M = Loaded[I];
Richard Smithe842a472014-10-22 02:05:46 +00003685 if (M.Mod->Kind == MK_ImplicitModule) {
Dmitri Gribenkof430da42014-02-12 10:33:14 +00003686 updateModuleTimestamp(*M.Mod);
3687 }
3688 }
3689 }
3690
Guy Benyei11169dd2012-12-18 14:30:41 +00003691 return Success;
3692}
3693
Ben Langmuir487ea142014-10-23 18:05:36 +00003694static ASTFileSignature readASTFileSignature(llvm::BitstreamReader &StreamFile);
3695
Ben Langmuir70a1b812015-03-24 04:43:52 +00003696/// \brief Whether \p Stream starts with the AST/PCH file magic number 'CPCH'.
3697static bool startsWithASTFileMagic(BitstreamCursor &Stream) {
3698 return Stream.Read(8) == 'C' &&
3699 Stream.Read(8) == 'P' &&
3700 Stream.Read(8) == 'C' &&
3701 Stream.Read(8) == 'H';
3702}
3703
Richard Smith0f99d6a2015-08-09 08:48:41 +00003704static unsigned moduleKindForDiagnostic(ModuleKind Kind) {
3705 switch (Kind) {
3706 case MK_PCH:
3707 return 0; // PCH
3708 case MK_ImplicitModule:
3709 case MK_ExplicitModule:
3710 return 1; // module
3711 case MK_MainFile:
3712 case MK_Preamble:
3713 return 2; // main source file
3714 }
3715 llvm_unreachable("unknown module kind");
3716}
3717
Guy Benyei11169dd2012-12-18 14:30:41 +00003718ASTReader::ASTReadResult
3719ASTReader::ReadASTCore(StringRef FileName,
3720 ModuleKind Type,
3721 SourceLocation ImportLoc,
3722 ModuleFile *ImportedBy,
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003723 SmallVectorImpl<ImportedModule> &Loaded,
Douglas Gregor7029ce12013-03-19 00:28:20 +00003724 off_t ExpectedSize, time_t ExpectedModTime,
Ben Langmuir487ea142014-10-23 18:05:36 +00003725 ASTFileSignature ExpectedSignature,
Guy Benyei11169dd2012-12-18 14:30:41 +00003726 unsigned ClientLoadCapabilities) {
3727 ModuleFile *M;
Guy Benyei11169dd2012-12-18 14:30:41 +00003728 std::string ErrorStr;
Douglas Gregor7029ce12013-03-19 00:28:20 +00003729 ModuleManager::AddModuleResult AddResult
3730 = ModuleMgr.addModule(FileName, Type, ImportLoc, ImportedBy,
Richard Smith053f6c62014-05-16 23:01:30 +00003731 getGeneration(), ExpectedSize, ExpectedModTime,
Ben Langmuir487ea142014-10-23 18:05:36 +00003732 ExpectedSignature, readASTFileSignature,
Douglas Gregor7029ce12013-03-19 00:28:20 +00003733 M, ErrorStr);
Guy Benyei11169dd2012-12-18 14:30:41 +00003734
Douglas Gregor7029ce12013-03-19 00:28:20 +00003735 switch (AddResult) {
3736 case ModuleManager::AlreadyLoaded:
3737 return Success;
3738
3739 case ModuleManager::NewlyLoaded:
3740 // Load module file below.
3741 break;
3742
3743 case ModuleManager::Missing:
Richard Smithe842a472014-10-22 02:05:46 +00003744 // The module file was missing; if the client can handle that, return
Douglas Gregor7029ce12013-03-19 00:28:20 +00003745 // it.
3746 if (ClientLoadCapabilities & ARR_Missing)
3747 return Missing;
3748
3749 // Otherwise, return an error.
Richard Smith0f99d6a2015-08-09 08:48:41 +00003750 Diag(diag::err_module_file_not_found) << moduleKindForDiagnostic(Type)
3751 << FileName << ErrorStr.empty()
3752 << ErrorStr;
Douglas Gregor7029ce12013-03-19 00:28:20 +00003753 return Failure;
3754
3755 case ModuleManager::OutOfDate:
3756 // We couldn't load the module file because it is out-of-date. If the
3757 // client can handle out-of-date, return it.
3758 if (ClientLoadCapabilities & ARR_OutOfDate)
3759 return OutOfDate;
3760
3761 // Otherwise, return an error.
Richard Smith0f99d6a2015-08-09 08:48:41 +00003762 Diag(diag::err_module_file_out_of_date) << moduleKindForDiagnostic(Type)
3763 << FileName << ErrorStr.empty()
3764 << ErrorStr;
Guy Benyei11169dd2012-12-18 14:30:41 +00003765 return Failure;
3766 }
3767
Douglas Gregor7029ce12013-03-19 00:28:20 +00003768 assert(M && "Missing module file");
Guy Benyei11169dd2012-12-18 14:30:41 +00003769
3770 // FIXME: This seems rather a hack. Should CurrentDir be part of the
3771 // module?
3772 if (FileName != "-") {
3773 CurrentDir = llvm::sys::path::parent_path(FileName);
3774 if (CurrentDir.empty()) CurrentDir = ".";
3775 }
3776
3777 ModuleFile &F = *M;
Chris Lattner7fb3bef2013-01-20 00:56:42 +00003778 BitstreamCursor &Stream = F.Stream;
Adrian Prantlfb2398d2015-07-17 01:19:54 +00003779 PCHContainerRdr.ExtractPCH(F.Buffer->getMemBufferRef(), F.StreamFile);
Rafael Espindolafd832392014-11-12 14:48:44 +00003780 Stream.init(&F.StreamFile);
Adrian Prantlcbc368c2015-02-25 02:44:04 +00003781 F.SizeInBits = F.Buffer->getBufferSize() * 8;
3782
Guy Benyei11169dd2012-12-18 14:30:41 +00003783 // Sniff for the signature.
Ben Langmuir70a1b812015-03-24 04:43:52 +00003784 if (!startsWithASTFileMagic(Stream)) {
Richard Smith0f99d6a2015-08-09 08:48:41 +00003785 Diag(diag::err_module_file_invalid) << moduleKindForDiagnostic(Type)
3786 << FileName;
Guy Benyei11169dd2012-12-18 14:30:41 +00003787 return Failure;
3788 }
3789
3790 // This is used for compatibility with older PCH formats.
3791 bool HaveReadControlBlock = false;
Chris Lattnerefa77172013-01-20 00:00:22 +00003792 while (1) {
3793 llvm::BitstreamEntry Entry = Stream.advance();
3794
3795 switch (Entry.Kind) {
3796 case llvm::BitstreamEntry::Error:
Chris Lattnerefa77172013-01-20 00:00:22 +00003797 case llvm::BitstreamEntry::Record:
Douglas Gregor6623e1f2015-11-03 18:33:07 +00003798 case llvm::BitstreamEntry::EndBlock:
Guy Benyei11169dd2012-12-18 14:30:41 +00003799 Error("invalid record at top-level of AST file");
3800 return Failure;
Chris Lattnerefa77172013-01-20 00:00:22 +00003801
3802 case llvm::BitstreamEntry::SubBlock:
3803 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00003804 }
3805
Chris Lattnerefa77172013-01-20 00:00:22 +00003806 switch (Entry.ID) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003807 case CONTROL_BLOCK_ID:
3808 HaveReadControlBlock = true;
Ben Langmuirbeee15e2014-04-14 18:00:01 +00003809 switch (ReadControlBlock(F, Loaded, ImportedBy, ClientLoadCapabilities)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00003810 case Success:
Richard Smith0f99d6a2015-08-09 08:48:41 +00003811 // Check that we didn't try to load a non-module AST file as a module.
3812 //
3813 // FIXME: Should we also perform the converse check? Loading a module as
3814 // a PCH file sort of works, but it's a bit wonky.
3815 if ((Type == MK_ImplicitModule || Type == MK_ExplicitModule) &&
3816 F.ModuleName.empty()) {
3817 auto Result = (Type == MK_ImplicitModule) ? OutOfDate : Failure;
3818 if (Result != OutOfDate ||
3819 (ClientLoadCapabilities & ARR_OutOfDate) == 0)
3820 Diag(diag::err_module_file_not_module) << FileName;
3821 return Result;
3822 }
Guy Benyei11169dd2012-12-18 14:30:41 +00003823 break;
3824
3825 case Failure: return Failure;
Douglas Gregor7029ce12013-03-19 00:28:20 +00003826 case Missing: return Missing;
Guy Benyei11169dd2012-12-18 14:30:41 +00003827 case OutOfDate: return OutOfDate;
3828 case VersionMismatch: return VersionMismatch;
3829 case ConfigurationMismatch: return ConfigurationMismatch;
3830 case HadErrors: return HadErrors;
3831 }
3832 break;
Richard Smithf8c32552015-09-02 17:45:54 +00003833
Guy Benyei11169dd2012-12-18 14:30:41 +00003834 case AST_BLOCK_ID:
3835 if (!HaveReadControlBlock) {
3836 if ((ClientLoadCapabilities & ARR_VersionMismatch) == 0)
Dmitri Gribenko2228cd32014-02-11 15:40:09 +00003837 Diag(diag::err_pch_version_too_old);
Guy Benyei11169dd2012-12-18 14:30:41 +00003838 return VersionMismatch;
3839 }
3840
3841 // Record that we've loaded this module.
3842 Loaded.push_back(ImportedModule(M, ImportedBy, ImportLoc));
3843 return Success;
3844
3845 default:
3846 if (Stream.SkipBlock()) {
3847 Error("malformed block record in AST file");
3848 return Failure;
3849 }
3850 break;
3851 }
3852 }
Douglas Gregor6623e1f2015-11-03 18:33:07 +00003853
3854 return Success;
3855}
3856
3857/// Parse a record and blob containing module file extension metadata.
3858static bool parseModuleFileExtensionMetadata(
3859 const SmallVectorImpl<uint64_t> &Record,
3860 StringRef Blob,
3861 ModuleFileExtensionMetadata &Metadata) {
3862 if (Record.size() < 4) return true;
3863
3864 Metadata.MajorVersion = Record[0];
3865 Metadata.MinorVersion = Record[1];
3866
3867 unsigned BlockNameLen = Record[2];
3868 unsigned UserInfoLen = Record[3];
3869
3870 if (BlockNameLen + UserInfoLen > Blob.size()) return true;
3871
3872 Metadata.BlockName = std::string(Blob.data(), Blob.data() + BlockNameLen);
3873 Metadata.UserInfo = std::string(Blob.data() + BlockNameLen,
3874 Blob.data() + BlockNameLen + UserInfoLen);
3875 return false;
3876}
3877
3878ASTReader::ASTReadResult ASTReader::ReadExtensionBlock(ModuleFile &F) {
3879 BitstreamCursor &Stream = F.Stream;
3880
3881 RecordData Record;
3882 while (true) {
3883 llvm::BitstreamEntry Entry = Stream.advance();
3884 switch (Entry.Kind) {
3885 case llvm::BitstreamEntry::SubBlock:
3886 if (Stream.SkipBlock())
3887 return Failure;
3888
3889 continue;
3890
3891 case llvm::BitstreamEntry::EndBlock:
3892 return Success;
3893
3894 case llvm::BitstreamEntry::Error:
3895 return HadErrors;
3896
3897 case llvm::BitstreamEntry::Record:
3898 break;
3899 }
3900
3901 Record.clear();
3902 StringRef Blob;
3903 unsigned RecCode = Stream.readRecord(Entry.ID, Record, &Blob);
3904 switch (RecCode) {
3905 case EXTENSION_METADATA: {
3906 ModuleFileExtensionMetadata Metadata;
3907 if (parseModuleFileExtensionMetadata(Record, Blob, Metadata))
3908 return Failure;
3909
3910 // Find a module file extension with this block name.
3911 auto Known = ModuleFileExtensions.find(Metadata.BlockName);
3912 if (Known == ModuleFileExtensions.end()) break;
3913
3914 // Form a reader.
3915 if (auto Reader = Known->second->createExtensionReader(Metadata, *this,
3916 F, Stream)) {
3917 F.ExtensionReaders.push_back(std::move(Reader));
3918 }
3919
3920 break;
3921 }
3922 }
3923 }
3924
3925 return Success;
Guy Benyei11169dd2012-12-18 14:30:41 +00003926}
3927
Richard Smitha7e2cc62015-05-01 01:53:09 +00003928void ASTReader::InitializeContext() {
Guy Benyei11169dd2012-12-18 14:30:41 +00003929 // If there's a listener, notify them that we "read" the translation unit.
3930 if (DeserializationListener)
3931 DeserializationListener->DeclRead(PREDEF_DECL_TRANSLATION_UNIT_ID,
3932 Context.getTranslationUnitDecl());
3933
Guy Benyei11169dd2012-12-18 14:30:41 +00003934 // FIXME: Find a better way to deal with collisions between these
3935 // built-in types. Right now, we just ignore the problem.
3936
3937 // Load the special types.
3938 if (SpecialTypes.size() >= NumSpecialTypeIDs) {
3939 if (unsigned String = SpecialTypes[SPECIAL_TYPE_CF_CONSTANT_STRING]) {
3940 if (!Context.CFConstantStringTypeDecl)
3941 Context.setCFConstantStringType(GetType(String));
3942 }
3943
3944 if (unsigned File = SpecialTypes[SPECIAL_TYPE_FILE]) {
3945 QualType FileType = GetType(File);
3946 if (FileType.isNull()) {
3947 Error("FILE type is NULL");
3948 return;
3949 }
3950
3951 if (!Context.FILEDecl) {
3952 if (const TypedefType *Typedef = FileType->getAs<TypedefType>())
3953 Context.setFILEDecl(Typedef->getDecl());
3954 else {
3955 const TagType *Tag = FileType->getAs<TagType>();
3956 if (!Tag) {
3957 Error("Invalid FILE type in AST file");
3958 return;
3959 }
3960 Context.setFILEDecl(Tag->getDecl());
3961 }
3962 }
3963 }
3964
3965 if (unsigned Jmp_buf = SpecialTypes[SPECIAL_TYPE_JMP_BUF]) {
3966 QualType Jmp_bufType = GetType(Jmp_buf);
3967 if (Jmp_bufType.isNull()) {
3968 Error("jmp_buf type is NULL");
3969 return;
3970 }
3971
3972 if (!Context.jmp_bufDecl) {
3973 if (const TypedefType *Typedef = Jmp_bufType->getAs<TypedefType>())
3974 Context.setjmp_bufDecl(Typedef->getDecl());
3975 else {
3976 const TagType *Tag = Jmp_bufType->getAs<TagType>();
3977 if (!Tag) {
3978 Error("Invalid jmp_buf type in AST file");
3979 return;
3980 }
3981 Context.setjmp_bufDecl(Tag->getDecl());
3982 }
3983 }
3984 }
3985
3986 if (unsigned Sigjmp_buf = SpecialTypes[SPECIAL_TYPE_SIGJMP_BUF]) {
3987 QualType Sigjmp_bufType = GetType(Sigjmp_buf);
3988 if (Sigjmp_bufType.isNull()) {
3989 Error("sigjmp_buf type is NULL");
3990 return;
3991 }
3992
3993 if (!Context.sigjmp_bufDecl) {
3994 if (const TypedefType *Typedef = Sigjmp_bufType->getAs<TypedefType>())
3995 Context.setsigjmp_bufDecl(Typedef->getDecl());
3996 else {
3997 const TagType *Tag = Sigjmp_bufType->getAs<TagType>();
3998 assert(Tag && "Invalid sigjmp_buf type in AST file");
3999 Context.setsigjmp_bufDecl(Tag->getDecl());
4000 }
4001 }
4002 }
4003
4004 if (unsigned ObjCIdRedef
4005 = SpecialTypes[SPECIAL_TYPE_OBJC_ID_REDEFINITION]) {
4006 if (Context.ObjCIdRedefinitionType.isNull())
4007 Context.ObjCIdRedefinitionType = GetType(ObjCIdRedef);
4008 }
4009
4010 if (unsigned ObjCClassRedef
4011 = SpecialTypes[SPECIAL_TYPE_OBJC_CLASS_REDEFINITION]) {
4012 if (Context.ObjCClassRedefinitionType.isNull())
4013 Context.ObjCClassRedefinitionType = GetType(ObjCClassRedef);
4014 }
4015
4016 if (unsigned ObjCSelRedef
4017 = SpecialTypes[SPECIAL_TYPE_OBJC_SEL_REDEFINITION]) {
4018 if (Context.ObjCSelRedefinitionType.isNull())
4019 Context.ObjCSelRedefinitionType = GetType(ObjCSelRedef);
4020 }
4021
4022 if (unsigned Ucontext_t = SpecialTypes[SPECIAL_TYPE_UCONTEXT_T]) {
4023 QualType Ucontext_tType = GetType(Ucontext_t);
4024 if (Ucontext_tType.isNull()) {
4025 Error("ucontext_t type is NULL");
4026 return;
4027 }
4028
4029 if (!Context.ucontext_tDecl) {
4030 if (const TypedefType *Typedef = Ucontext_tType->getAs<TypedefType>())
4031 Context.setucontext_tDecl(Typedef->getDecl());
4032 else {
4033 const TagType *Tag = Ucontext_tType->getAs<TagType>();
4034 assert(Tag && "Invalid ucontext_t type in AST file");
4035 Context.setucontext_tDecl(Tag->getDecl());
4036 }
4037 }
4038 }
4039 }
4040
4041 ReadPragmaDiagnosticMappings(Context.getDiagnostics());
4042
4043 // If there were any CUDA special declarations, deserialize them.
4044 if (!CUDASpecialDeclRefs.empty()) {
4045 assert(CUDASpecialDeclRefs.size() == 1 && "More decl refs than expected!");
4046 Context.setcudaConfigureCallDecl(
4047 cast<FunctionDecl>(GetDecl(CUDASpecialDeclRefs[0])));
4048 }
Richard Smith56be7542014-03-21 00:33:59 +00004049
Guy Benyei11169dd2012-12-18 14:30:41 +00004050 // Re-export any modules that were imported by a non-module AST file.
Richard Smitha7e2cc62015-05-01 01:53:09 +00004051 // FIXME: This does not make macro-only imports visible again.
Richard Smith56be7542014-03-21 00:33:59 +00004052 for (auto &Import : ImportedModules) {
Richard Smitha7e2cc62015-05-01 01:53:09 +00004053 if (Module *Imported = getSubmodule(Import.ID)) {
Argyrios Kyrtzidis125df052013-02-01 16:36:12 +00004054 makeModuleVisible(Imported, Module::AllVisible,
Richard Smitha7e2cc62015-05-01 01:53:09 +00004055 /*ImportLoc=*/Import.ImportLoc);
Ben Langmuir6d25fdc2016-02-11 17:04:42 +00004056 if (Import.ImportLoc.isValid())
4057 PP.makeModuleVisible(Imported, Import.ImportLoc);
4058 // FIXME: should we tell Sema to make the module visible too?
Richard Smitha7e2cc62015-05-01 01:53:09 +00004059 }
Guy Benyei11169dd2012-12-18 14:30:41 +00004060 }
4061 ImportedModules.clear();
4062}
4063
4064void ASTReader::finalizeForWriting() {
Richard Smithde711422015-04-23 21:20:19 +00004065 // Nothing to do for now.
Guy Benyei11169dd2012-12-18 14:30:41 +00004066}
4067
Ben Langmuir70a1b812015-03-24 04:43:52 +00004068/// \brief Reads and return the signature record from \p StreamFile's control
4069/// block, or else returns 0.
Ben Langmuir487ea142014-10-23 18:05:36 +00004070static ASTFileSignature readASTFileSignature(llvm::BitstreamReader &StreamFile){
4071 BitstreamCursor Stream(StreamFile);
Ben Langmuir70a1b812015-03-24 04:43:52 +00004072 if (!startsWithASTFileMagic(Stream))
Ben Langmuir487ea142014-10-23 18:05:36 +00004073 return 0;
Ben Langmuir487ea142014-10-23 18:05:36 +00004074
4075 // Scan for the CONTROL_BLOCK_ID block.
4076 if (SkipCursorToBlock(Stream, CONTROL_BLOCK_ID))
4077 return 0;
4078
4079 // Scan for SIGNATURE inside the control block.
4080 ASTReader::RecordData Record;
4081 while (1) {
4082 llvm::BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
4083 if (Entry.Kind == llvm::BitstreamEntry::EndBlock ||
4084 Entry.Kind != llvm::BitstreamEntry::Record)
4085 return 0;
4086
4087 Record.clear();
4088 StringRef Blob;
4089 if (SIGNATURE == Stream.readRecord(Entry.ID, Record, &Blob))
4090 return Record[0];
4091 }
4092}
4093
Guy Benyei11169dd2012-12-18 14:30:41 +00004094/// \brief Retrieve the name of the original source file name
4095/// directly from the AST file, without actually loading the AST
4096/// file.
Adrian Prantlbb165fb2015-06-20 18:53:08 +00004097std::string ASTReader::getOriginalSourceFile(
4098 const std::string &ASTFileName, FileManager &FileMgr,
Adrian Prantlfb2398d2015-07-17 01:19:54 +00004099 const PCHContainerReader &PCHContainerRdr, DiagnosticsEngine &Diags) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004100 // Open the AST file.
Benjamin Kramera8857962014-10-26 22:44:13 +00004101 auto Buffer = FileMgr.getBufferForFile(ASTFileName);
Guy Benyei11169dd2012-12-18 14:30:41 +00004102 if (!Buffer) {
Benjamin Kramera8857962014-10-26 22:44:13 +00004103 Diags.Report(diag::err_fe_unable_to_read_pch_file)
4104 << ASTFileName << Buffer.getError().message();
Guy Benyei11169dd2012-12-18 14:30:41 +00004105 return std::string();
4106 }
4107
4108 // Initialize the stream
4109 llvm::BitstreamReader StreamFile;
Adrian Prantlfb2398d2015-07-17 01:19:54 +00004110 PCHContainerRdr.ExtractPCH((*Buffer)->getMemBufferRef(), StreamFile);
Rafael Espindolaaf0e40a2014-11-12 14:42:25 +00004111 BitstreamCursor Stream(StreamFile);
Guy Benyei11169dd2012-12-18 14:30:41 +00004112
4113 // Sniff for the signature.
Ben Langmuir70a1b812015-03-24 04:43:52 +00004114 if (!startsWithASTFileMagic(Stream)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004115 Diags.Report(diag::err_fe_not_a_pch_file) << ASTFileName;
4116 return std::string();
4117 }
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004118
Chris Lattnere7b154b2013-01-19 21:39:22 +00004119 // Scan for the CONTROL_BLOCK_ID block.
Argyrios Kyrtzidisc4cd2c42013-05-06 19:23:40 +00004120 if (SkipCursorToBlock(Stream, CONTROL_BLOCK_ID)) {
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004121 Diags.Report(diag::err_fe_pch_malformed_block) << ASTFileName;
4122 return std::string();
Chris Lattnere7b154b2013-01-19 21:39:22 +00004123 }
Guy Benyei11169dd2012-12-18 14:30:41 +00004124
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004125 // Scan for ORIGINAL_FILE inside the control block.
4126 RecordData Record;
Chris Lattnere7b154b2013-01-19 21:39:22 +00004127 while (1) {
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004128 llvm::BitstreamEntry Entry = Stream.advanceSkippingSubblocks();
Chris Lattnere7b154b2013-01-19 21:39:22 +00004129 if (Entry.Kind == llvm::BitstreamEntry::EndBlock)
4130 return std::string();
4131
4132 if (Entry.Kind != llvm::BitstreamEntry::Record) {
4133 Diags.Report(diag::err_fe_pch_malformed_block) << ASTFileName;
4134 return std::string();
Guy Benyei11169dd2012-12-18 14:30:41 +00004135 }
Chris Lattnere7b154b2013-01-19 21:39:22 +00004136
Guy Benyei11169dd2012-12-18 14:30:41 +00004137 Record.clear();
Chris Lattner0e6c9402013-01-20 02:38:54 +00004138 StringRef Blob;
4139 if (Stream.readRecord(Entry.ID, Record, &Blob) == ORIGINAL_FILE)
4140 return Blob.str();
Guy Benyei11169dd2012-12-18 14:30:41 +00004141 }
Guy Benyei11169dd2012-12-18 14:30:41 +00004142}
4143
4144namespace {
4145 class SimplePCHValidator : public ASTReaderListener {
4146 const LangOptions &ExistingLangOpts;
4147 const TargetOptions &ExistingTargetOpts;
4148 const PreprocessorOptions &ExistingPPOpts;
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00004149 std::string ExistingModuleCachePath;
Guy Benyei11169dd2012-12-18 14:30:41 +00004150 FileManager &FileMgr;
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00004151
Guy Benyei11169dd2012-12-18 14:30:41 +00004152 public:
4153 SimplePCHValidator(const LangOptions &ExistingLangOpts,
4154 const TargetOptions &ExistingTargetOpts,
4155 const PreprocessorOptions &ExistingPPOpts,
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00004156 StringRef ExistingModuleCachePath,
Guy Benyei11169dd2012-12-18 14:30:41 +00004157 FileManager &FileMgr)
4158 : ExistingLangOpts(ExistingLangOpts),
4159 ExistingTargetOpts(ExistingTargetOpts),
4160 ExistingPPOpts(ExistingPPOpts),
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00004161 ExistingModuleCachePath(ExistingModuleCachePath),
Guy Benyei11169dd2012-12-18 14:30:41 +00004162 FileMgr(FileMgr)
4163 {
4164 }
4165
Richard Smith1e2cf0d2014-10-31 02:28:58 +00004166 bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
4167 bool AllowCompatibleDifferences) override {
4168 return checkLanguageOptions(ExistingLangOpts, LangOpts, nullptr,
4169 AllowCompatibleDifferences);
Guy Benyei11169dd2012-12-18 14:30:41 +00004170 }
Chandler Carruth0d745bc2015-03-14 04:47:43 +00004171 bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
4172 bool AllowCompatibleDifferences) override {
4173 return checkTargetOptions(ExistingTargetOpts, TargetOpts, nullptr,
4174 AllowCompatibleDifferences);
Guy Benyei11169dd2012-12-18 14:30:41 +00004175 }
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00004176 bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
4177 StringRef SpecificModuleCachePath,
4178 bool Complain) override {
4179 return checkHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
4180 ExistingModuleCachePath,
4181 nullptr, ExistingLangOpts);
4182 }
Craig Topper3e89dfe2014-03-13 02:13:41 +00004183 bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
4184 bool Complain,
4185 std::string &SuggestedPredefines) override {
Craig Toppera13603a2014-05-22 05:54:18 +00004186 return checkPreprocessorOptions(ExistingPPOpts, PPOpts, nullptr, FileMgr,
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +00004187 SuggestedPredefines, ExistingLangOpts);
Guy Benyei11169dd2012-12-18 14:30:41 +00004188 }
4189 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00004190}
Guy Benyei11169dd2012-12-18 14:30:41 +00004191
Adrian Prantlbb165fb2015-06-20 18:53:08 +00004192bool ASTReader::readASTFileControlBlock(
4193 StringRef Filename, FileManager &FileMgr,
Adrian Prantlfb2398d2015-07-17 01:19:54 +00004194 const PCHContainerReader &PCHContainerRdr,
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004195 bool FindModuleFileExtensions,
Adrian Prantlbb165fb2015-06-20 18:53:08 +00004196 ASTReaderListener &Listener) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004197 // Open the AST file.
Richard Smith7f330cd2015-03-18 01:42:29 +00004198 // FIXME: This allows use of the VFS; we do not allow use of the
4199 // VFS when actually loading a module.
Benjamin Kramera8857962014-10-26 22:44:13 +00004200 auto Buffer = FileMgr.getBufferForFile(Filename);
Guy Benyei11169dd2012-12-18 14:30:41 +00004201 if (!Buffer) {
4202 return true;
4203 }
4204
4205 // Initialize the stream
4206 llvm::BitstreamReader StreamFile;
Adrian Prantlfb2398d2015-07-17 01:19:54 +00004207 PCHContainerRdr.ExtractPCH((*Buffer)->getMemBufferRef(), StreamFile);
Rafael Espindolaaf0e40a2014-11-12 14:42:25 +00004208 BitstreamCursor Stream(StreamFile);
Guy Benyei11169dd2012-12-18 14:30:41 +00004209
4210 // Sniff for the signature.
Ben Langmuir70a1b812015-03-24 04:43:52 +00004211 if (!startsWithASTFileMagic(Stream))
Guy Benyei11169dd2012-12-18 14:30:41 +00004212 return true;
Guy Benyei11169dd2012-12-18 14:30:41 +00004213
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004214 // Scan for the CONTROL_BLOCK_ID block.
Argyrios Kyrtzidisc4cd2c42013-05-06 19:23:40 +00004215 if (SkipCursorToBlock(Stream, CONTROL_BLOCK_ID))
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004216 return true;
Argyrios Kyrtzidisc4cd2c42013-05-06 19:23:40 +00004217
4218 bool NeedsInputFiles = Listener.needsInputFileVisitation();
Ben Langmuircb69b572014-03-07 06:40:32 +00004219 bool NeedsSystemInputFiles = Listener.needsSystemInputFileVisitation();
Richard Smithd4b230b2014-10-27 23:01:16 +00004220 bool NeedsImports = Listener.needsImportVisitation();
Argyrios Kyrtzidisc4cd2c42013-05-06 19:23:40 +00004221 BitstreamCursor InputFilesCursor;
Argyrios Kyrtzidisc4cd2c42013-05-06 19:23:40 +00004222
Guy Benyei11169dd2012-12-18 14:30:41 +00004223 RecordData Record;
Richard Smith7ed1bc92014-12-05 22:42:13 +00004224 std::string ModuleDir;
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004225 bool DoneWithControlBlock = false;
4226 while (!DoneWithControlBlock) {
Richard Smith0516b182015-09-08 19:40:14 +00004227 llvm::BitstreamEntry Entry = Stream.advance();
4228
4229 switch (Entry.Kind) {
4230 case llvm::BitstreamEntry::SubBlock: {
4231 switch (Entry.ID) {
4232 case OPTIONS_BLOCK_ID: {
4233 std::string IgnoredSuggestedPredefines;
4234 if (ReadOptionsBlock(Stream, ARR_ConfigurationMismatch | ARR_OutOfDate,
4235 /*AllowCompatibleConfigurationMismatch*/ false,
4236 Listener, IgnoredSuggestedPredefines) != Success)
4237 return true;
4238 break;
4239 }
4240
4241 case INPUT_FILES_BLOCK_ID:
4242 InputFilesCursor = Stream;
4243 if (Stream.SkipBlock() ||
4244 (NeedsInputFiles &&
4245 ReadBlockAbbrevs(InputFilesCursor, INPUT_FILES_BLOCK_ID)))
4246 return true;
4247 break;
4248
4249 default:
4250 if (Stream.SkipBlock())
4251 return true;
4252 break;
4253 }
4254
4255 continue;
4256 }
4257
4258 case llvm::BitstreamEntry::EndBlock:
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004259 DoneWithControlBlock = true;
4260 break;
Richard Smith0516b182015-09-08 19:40:14 +00004261
4262 case llvm::BitstreamEntry::Error:
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004263 return true;
Richard Smith0516b182015-09-08 19:40:14 +00004264
4265 case llvm::BitstreamEntry::Record:
4266 break;
4267 }
4268
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004269 if (DoneWithControlBlock) break;
4270
Guy Benyei11169dd2012-12-18 14:30:41 +00004271 Record.clear();
Chris Lattner0e6c9402013-01-20 02:38:54 +00004272 StringRef Blob;
4273 unsigned RecCode = Stream.readRecord(Entry.ID, Record, &Blob);
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004274 switch ((ControlRecordTypes)RecCode) {
4275 case METADATA: {
4276 if (Record[0] != VERSION_MAJOR)
4277 return true;
Guy Benyei11169dd2012-12-18 14:30:41 +00004278
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +00004279 if (Listener.ReadFullVersionInformation(Blob))
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004280 return true;
Douglas Gregorbf7fc9c2013-03-27 16:47:18 +00004281
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004282 break;
4283 }
Ben Langmuir4f5212a2014-04-14 22:12:44 +00004284 case MODULE_NAME:
4285 Listener.ReadModuleName(Blob);
4286 break;
Richard Smith7ed1bc92014-12-05 22:42:13 +00004287 case MODULE_DIRECTORY:
4288 ModuleDir = Blob;
4289 break;
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00004290 case MODULE_MAP_FILE: {
4291 unsigned Idx = 0;
Richard Smith7ed1bc92014-12-05 22:42:13 +00004292 auto Path = ReadString(Record, Idx);
4293 ResolveImportedPath(Path, ModuleDir);
4294 Listener.ReadModuleMapFile(Path);
Ben Langmuir4f5212a2014-04-14 22:12:44 +00004295 break;
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00004296 }
Argyrios Kyrtzidisc4cd2c42013-05-06 19:23:40 +00004297 case INPUT_FILE_OFFSETS: {
4298 if (!NeedsInputFiles)
4299 break;
4300
4301 unsigned NumInputFiles = Record[0];
4302 unsigned NumUserFiles = Record[1];
Richard Smithec216502015-02-13 19:48:37 +00004303 const uint64_t *InputFileOffs = (const uint64_t *)Blob.data();
Argyrios Kyrtzidisc4cd2c42013-05-06 19:23:40 +00004304 for (unsigned I = 0; I != NumInputFiles; ++I) {
4305 // Go find this input file.
4306 bool isSystemFile = I >= NumUserFiles;
Ben Langmuircb69b572014-03-07 06:40:32 +00004307
4308 if (isSystemFile && !NeedsSystemInputFiles)
4309 break; // the rest are system input files
4310
Argyrios Kyrtzidisc4cd2c42013-05-06 19:23:40 +00004311 BitstreamCursor &Cursor = InputFilesCursor;
4312 SavedStreamPosition SavedPosition(Cursor);
4313 Cursor.JumpToBit(InputFileOffs[I]);
4314
4315 unsigned Code = Cursor.ReadCode();
4316 RecordData Record;
4317 StringRef Blob;
4318 bool shouldContinue = false;
4319 switch ((InputFileRecordTypes)Cursor.readRecord(Code, Record, &Blob)) {
4320 case INPUT_FILE:
Argyrios Kyrtzidis68ccbe02014-03-14 02:26:31 +00004321 bool Overridden = static_cast<bool>(Record[3]);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004322 std::string Filename = Blob;
4323 ResolveImportedPath(Filename, ModuleDir);
Richard Smith216a3bd2015-08-13 17:57:10 +00004324 shouldContinue = Listener.visitInputFile(
4325 Filename, isSystemFile, Overridden, /*IsExplicitModule*/false);
Argyrios Kyrtzidisc4cd2c42013-05-06 19:23:40 +00004326 break;
4327 }
4328 if (!shouldContinue)
4329 break;
4330 }
4331 break;
4332 }
4333
Richard Smithd4b230b2014-10-27 23:01:16 +00004334 case IMPORTS: {
4335 if (!NeedsImports)
4336 break;
4337
4338 unsigned Idx = 0, N = Record.size();
4339 while (Idx < N) {
4340 // Read information about the AST file.
Richard Smith79c98cc2014-10-27 23:25:15 +00004341 Idx += 5; // ImportLoc, Size, ModTime, Signature
Richard Smith7ed1bc92014-12-05 22:42:13 +00004342 std::string Filename = ReadString(Record, Idx);
4343 ResolveImportedPath(Filename, ModuleDir);
4344 Listener.visitImport(Filename);
Richard Smithd4b230b2014-10-27 23:01:16 +00004345 }
4346 break;
4347 }
4348
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004349 default:
4350 // No other validation to perform.
4351 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00004352 }
4353 }
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004354
4355 // Look for module file extension blocks, if requested.
4356 if (FindModuleFileExtensions) {
4357 while (!SkipCursorToBlock(Stream, EXTENSION_BLOCK_ID)) {
4358 bool DoneWithExtensionBlock = false;
4359 while (!DoneWithExtensionBlock) {
4360 llvm::BitstreamEntry Entry = Stream.advance();
4361
4362 switch (Entry.Kind) {
4363 case llvm::BitstreamEntry::SubBlock:
4364 if (Stream.SkipBlock())
4365 return true;
4366
4367 continue;
4368
4369 case llvm::BitstreamEntry::EndBlock:
4370 DoneWithExtensionBlock = true;
4371 continue;
4372
4373 case llvm::BitstreamEntry::Error:
4374 return true;
4375
4376 case llvm::BitstreamEntry::Record:
4377 break;
4378 }
4379
4380 Record.clear();
4381 StringRef Blob;
4382 unsigned RecCode = Stream.readRecord(Entry.ID, Record, &Blob);
4383 switch (RecCode) {
4384 case EXTENSION_METADATA: {
4385 ModuleFileExtensionMetadata Metadata;
4386 if (parseModuleFileExtensionMetadata(Record, Blob, Metadata))
4387 return true;
4388
4389 Listener.readModuleFileExtension(Metadata);
4390 break;
4391 }
4392 }
4393 }
4394 }
4395 }
4396
4397 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +00004398}
4399
Adrian Prantlbb165fb2015-06-20 18:53:08 +00004400bool ASTReader::isAcceptableASTFile(
4401 StringRef Filename, FileManager &FileMgr,
Adrian Prantlfb2398d2015-07-17 01:19:54 +00004402 const PCHContainerReader &PCHContainerRdr, const LangOptions &LangOpts,
Adrian Prantlbb165fb2015-06-20 18:53:08 +00004403 const TargetOptions &TargetOpts, const PreprocessorOptions &PPOpts,
4404 std::string ExistingModuleCachePath) {
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00004405 SimplePCHValidator validator(LangOpts, TargetOpts, PPOpts,
4406 ExistingModuleCachePath, FileMgr);
Adrian Prantlfb2398d2015-07-17 01:19:54 +00004407 return !readASTFileControlBlock(Filename, FileMgr, PCHContainerRdr,
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004408 /*FindModuleFileExtensions=*/false,
Adrian Prantlbb165fb2015-06-20 18:53:08 +00004409 validator);
Guy Benyei11169dd2012-12-18 14:30:41 +00004410}
4411
Ben Langmuir2c9af442014-04-10 17:57:43 +00004412ASTReader::ASTReadResult
4413ASTReader::ReadSubmoduleBlock(ModuleFile &F, unsigned ClientLoadCapabilities) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004414 // Enter the submodule block.
4415 if (F.Stream.EnterSubBlock(SUBMODULE_BLOCK_ID)) {
4416 Error("malformed submodule block record in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00004417 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00004418 }
4419
4420 ModuleMap &ModMap = PP.getHeaderSearchInfo().getModuleMap();
4421 bool First = true;
Craig Toppera13603a2014-05-22 05:54:18 +00004422 Module *CurrentModule = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00004423 RecordData Record;
4424 while (true) {
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004425 llvm::BitstreamEntry Entry = F.Stream.advanceSkippingSubblocks();
4426
4427 switch (Entry.Kind) {
4428 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
4429 case llvm::BitstreamEntry::Error:
4430 Error("malformed block record in AST file");
Ben Langmuir2c9af442014-04-10 17:57:43 +00004431 return Failure;
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004432 case llvm::BitstreamEntry::EndBlock:
Ben Langmuir2c9af442014-04-10 17:57:43 +00004433 return Success;
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004434 case llvm::BitstreamEntry::Record:
4435 // The interesting case.
4436 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00004437 }
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004438
Guy Benyei11169dd2012-12-18 14:30:41 +00004439 // Read a record.
Chris Lattner0e6c9402013-01-20 02:38:54 +00004440 StringRef Blob;
Guy Benyei11169dd2012-12-18 14:30:41 +00004441 Record.clear();
Richard Smith03478d92014-10-23 22:12:14 +00004442 auto Kind = F.Stream.readRecord(Entry.ID, Record, &Blob);
4443
4444 if ((Kind == SUBMODULE_METADATA) != First) {
4445 Error("submodule metadata record should be at beginning of block");
4446 return Failure;
4447 }
4448 First = false;
4449
4450 // Submodule information is only valid if we have a current module.
4451 // FIXME: Should we error on these cases?
4452 if (!CurrentModule && Kind != SUBMODULE_METADATA &&
4453 Kind != SUBMODULE_DEFINITION)
4454 continue;
4455
4456 switch (Kind) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004457 default: // Default behavior: ignore.
4458 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00004459
Richard Smith03478d92014-10-23 22:12:14 +00004460 case SUBMODULE_DEFINITION: {
Douglas Gregor8d932422013-03-20 03:59:18 +00004461 if (Record.size() < 8) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004462 Error("malformed module definition");
Ben Langmuir2c9af442014-04-10 17:57:43 +00004463 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00004464 }
Richard Smith03478d92014-10-23 22:12:14 +00004465
Chris Lattner0e6c9402013-01-20 02:38:54 +00004466 StringRef Name = Blob;
Richard Smith9bca2982014-03-08 00:03:56 +00004467 unsigned Idx = 0;
4468 SubmoduleID GlobalID = getGlobalSubmoduleID(F, Record[Idx++]);
4469 SubmoduleID Parent = getGlobalSubmoduleID(F, Record[Idx++]);
4470 bool IsFramework = Record[Idx++];
4471 bool IsExplicit = Record[Idx++];
4472 bool IsSystem = Record[Idx++];
4473 bool IsExternC = Record[Idx++];
4474 bool InferSubmodules = Record[Idx++];
4475 bool InferExplicitSubmodules = Record[Idx++];
4476 bool InferExportWildcard = Record[Idx++];
4477 bool ConfigMacrosExhaustive = Record[Idx++];
Douglas Gregor8d932422013-03-20 03:59:18 +00004478
Ben Langmuirbeee15e2014-04-14 18:00:01 +00004479 Module *ParentModule = nullptr;
Ben Langmuir9d6448b2014-08-09 00:57:23 +00004480 if (Parent)
Guy Benyei11169dd2012-12-18 14:30:41 +00004481 ParentModule = getSubmodule(Parent);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00004482
Guy Benyei11169dd2012-12-18 14:30:41 +00004483 // Retrieve this (sub)module from the module map, creating it if
4484 // necessary.
Ben Langmuir9d6448b2014-08-09 00:57:23 +00004485 CurrentModule = ModMap.findOrCreateModule(Name, ParentModule, IsFramework,
Guy Benyei11169dd2012-12-18 14:30:41 +00004486 IsExplicit).first;
Ben Langmuir9d6448b2014-08-09 00:57:23 +00004487
4488 // FIXME: set the definition loc for CurrentModule, or call
4489 // ModMap.setInferredModuleAllowedBy()
4490
Guy Benyei11169dd2012-12-18 14:30:41 +00004491 SubmoduleID GlobalIndex = GlobalID - NUM_PREDEF_SUBMODULE_IDS;
4492 if (GlobalIndex >= SubmodulesLoaded.size() ||
4493 SubmodulesLoaded[GlobalIndex]) {
4494 Error("too many submodules");
Ben Langmuir2c9af442014-04-10 17:57:43 +00004495 return Failure;
Guy Benyei11169dd2012-12-18 14:30:41 +00004496 }
Douglas Gregor8a114ab2013-02-06 22:40:31 +00004497
Douglas Gregor7029ce12013-03-19 00:28:20 +00004498 if (!ParentModule) {
4499 if (const FileEntry *CurFile = CurrentModule->getASTFile()) {
4500 if (CurFile != F.File) {
4501 if (!Diags.isDiagnosticInFlight()) {
4502 Diag(diag::err_module_file_conflict)
4503 << CurrentModule->getTopLevelModuleName()
4504 << CurFile->getName()
4505 << F.File->getName();
4506 }
Ben Langmuir2c9af442014-04-10 17:57:43 +00004507 return Failure;
Douglas Gregor8a114ab2013-02-06 22:40:31 +00004508 }
Douglas Gregor8a114ab2013-02-06 22:40:31 +00004509 }
Douglas Gregor7029ce12013-03-19 00:28:20 +00004510
4511 CurrentModule->setASTFile(F.File);
Douglas Gregor8a114ab2013-02-06 22:40:31 +00004512 }
Ben Langmuirbeee15e2014-04-14 18:00:01 +00004513
Adrian Prantl15bcf702015-06-30 17:39:43 +00004514 CurrentModule->Signature = F.Signature;
Guy Benyei11169dd2012-12-18 14:30:41 +00004515 CurrentModule->IsFromModuleFile = true;
4516 CurrentModule->IsSystem = IsSystem || CurrentModule->IsSystem;
Richard Smith9bca2982014-03-08 00:03:56 +00004517 CurrentModule->IsExternC = IsExternC;
Guy Benyei11169dd2012-12-18 14:30:41 +00004518 CurrentModule->InferSubmodules = InferSubmodules;
4519 CurrentModule->InferExplicitSubmodules = InferExplicitSubmodules;
4520 CurrentModule->InferExportWildcard = InferExportWildcard;
Douglas Gregor8d932422013-03-20 03:59:18 +00004521 CurrentModule->ConfigMacrosExhaustive = ConfigMacrosExhaustive;
Guy Benyei11169dd2012-12-18 14:30:41 +00004522 if (DeserializationListener)
4523 DeserializationListener->ModuleRead(GlobalID, CurrentModule);
4524
4525 SubmodulesLoaded[GlobalIndex] = CurrentModule;
Douglas Gregor6ddfca92013-01-14 17:21:00 +00004526
Richard Smith8a3e39a2016-03-28 21:31:09 +00004527 // Clear out data that will be replaced by what is in the module file.
Douglas Gregor6ddfca92013-01-14 17:21:00 +00004528 CurrentModule->LinkLibraries.clear();
Douglas Gregor8d932422013-03-20 03:59:18 +00004529 CurrentModule->ConfigMacros.clear();
Douglas Gregorfb912652013-03-20 21:10:35 +00004530 CurrentModule->UnresolvedConflicts.clear();
4531 CurrentModule->Conflicts.clear();
Richard Smith8a3e39a2016-03-28 21:31:09 +00004532
4533 // The module is available unless it's missing a requirement; relevant
4534 // requirements will be (re-)added by SUBMODULE_REQUIRES records.
4535 // Missing headers that were present when the module was built do not
4536 // make it unavailable -- if we got this far, this must be an explicitly
4537 // imported module file.
4538 CurrentModule->Requirements.clear();
4539 CurrentModule->MissingHeaders.clear();
4540 CurrentModule->IsMissingRequirement =
4541 ParentModule && ParentModule->IsMissingRequirement;
4542 CurrentModule->IsAvailable = !CurrentModule->IsMissingRequirement;
Guy Benyei11169dd2012-12-18 14:30:41 +00004543 break;
4544 }
Richard Smith8a3e39a2016-03-28 21:31:09 +00004545
Guy Benyei11169dd2012-12-18 14:30:41 +00004546 case SUBMODULE_UMBRELLA_HEADER: {
Richard Smith2b63d152015-05-16 02:28:53 +00004547 std::string Filename = Blob;
4548 ResolveImportedPath(F, Filename);
4549 if (auto *Umbrella = PP.getFileManager().getFile(Filename)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004550 if (!CurrentModule->getUmbrellaHeader())
Richard Smith2b63d152015-05-16 02:28:53 +00004551 ModMap.setUmbrellaHeader(CurrentModule, Umbrella, Blob);
4552 else if (CurrentModule->getUmbrellaHeader().Entry != Umbrella) {
Ben Langmuirbc35fbe2015-02-20 21:46:39 +00004553 // This can be a spurious difference caused by changing the VFS to
4554 // point to a different copy of the file, and it is too late to
4555 // to rebuild safely.
4556 // FIXME: If we wrote the virtual paths instead of the 'real' paths,
4557 // after input file validation only real problems would remain and we
4558 // could just error. For now, assume it's okay.
4559 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00004560 }
4561 }
4562 break;
4563 }
4564
Richard Smith202210b2014-10-24 20:23:01 +00004565 case SUBMODULE_HEADER:
4566 case SUBMODULE_EXCLUDED_HEADER:
4567 case SUBMODULE_PRIVATE_HEADER:
4568 // We lazily associate headers with their modules via the HeaderInfo table.
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00004569 // FIXME: Re-evaluate this section; maybe only store InputFile IDs instead
4570 // of complete filenames or remove it entirely.
Richard Smith202210b2014-10-24 20:23:01 +00004571 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00004572
Richard Smith202210b2014-10-24 20:23:01 +00004573 case SUBMODULE_TEXTUAL_HEADER:
4574 case SUBMODULE_PRIVATE_TEXTUAL_HEADER:
4575 // FIXME: Textual headers are not marked in the HeaderInfo table. Load
4576 // them here.
4577 break;
Lawrence Crowlb53e5482013-06-20 21:14:14 +00004578
Guy Benyei11169dd2012-12-18 14:30:41 +00004579 case SUBMODULE_TOPHEADER: {
Argyrios Kyrtzidis3c5305c2013-03-13 21:13:43 +00004580 CurrentModule->addTopHeaderFilename(Blob);
Guy Benyei11169dd2012-12-18 14:30:41 +00004581 break;
4582 }
4583
4584 case SUBMODULE_UMBRELLA_DIR: {
Richard Smith2b63d152015-05-16 02:28:53 +00004585 std::string Dirname = Blob;
4586 ResolveImportedPath(F, Dirname);
4587 if (auto *Umbrella = PP.getFileManager().getDirectory(Dirname)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004588 if (!CurrentModule->getUmbrellaDir())
Richard Smith2b63d152015-05-16 02:28:53 +00004589 ModMap.setUmbrellaDir(CurrentModule, Umbrella, Blob);
4590 else if (CurrentModule->getUmbrellaDir().Entry != Umbrella) {
Ben Langmuir2c9af442014-04-10 17:57:43 +00004591 if ((ClientLoadCapabilities & ARR_OutOfDate) == 0)
4592 Error("mismatched umbrella directories in submodule");
4593 return OutOfDate;
Guy Benyei11169dd2012-12-18 14:30:41 +00004594 }
4595 }
4596 break;
4597 }
4598
4599 case SUBMODULE_METADATA: {
Guy Benyei11169dd2012-12-18 14:30:41 +00004600 F.BaseSubmoduleID = getTotalNumSubmodules();
4601 F.LocalNumSubmodules = Record[0];
4602 unsigned LocalBaseSubmoduleID = Record[1];
4603 if (F.LocalNumSubmodules > 0) {
4604 // Introduce the global -> local mapping for submodules within this
4605 // module.
4606 GlobalSubmoduleMap.insert(std::make_pair(getTotalNumSubmodules()+1,&F));
4607
4608 // Introduce the local -> global mapping for submodules within this
4609 // module.
4610 F.SubmoduleRemap.insertOrReplace(
4611 std::make_pair(LocalBaseSubmoduleID,
4612 F.BaseSubmoduleID - LocalBaseSubmoduleID));
Ben Langmuirfe971d92014-08-16 04:54:18 +00004613
Ben Langmuir52ca6782014-10-20 16:27:32 +00004614 SubmodulesLoaded.resize(SubmodulesLoaded.size() + F.LocalNumSubmodules);
4615 }
Guy Benyei11169dd2012-12-18 14:30:41 +00004616 break;
4617 }
4618
4619 case SUBMODULE_IMPORTS: {
Guy Benyei11169dd2012-12-18 14:30:41 +00004620 for (unsigned Idx = 0; Idx != Record.size(); ++Idx) {
Douglas Gregorfb912652013-03-20 21:10:35 +00004621 UnresolvedModuleRef Unresolved;
Guy Benyei11169dd2012-12-18 14:30:41 +00004622 Unresolved.File = &F;
4623 Unresolved.Mod = CurrentModule;
4624 Unresolved.ID = Record[Idx];
Douglas Gregorfb912652013-03-20 21:10:35 +00004625 Unresolved.Kind = UnresolvedModuleRef::Import;
Guy Benyei11169dd2012-12-18 14:30:41 +00004626 Unresolved.IsWildcard = false;
Douglas Gregorfb912652013-03-20 21:10:35 +00004627 UnresolvedModuleRefs.push_back(Unresolved);
Guy Benyei11169dd2012-12-18 14:30:41 +00004628 }
4629 break;
4630 }
4631
4632 case SUBMODULE_EXPORTS: {
Guy Benyei11169dd2012-12-18 14:30:41 +00004633 for (unsigned Idx = 0; Idx + 1 < Record.size(); Idx += 2) {
Douglas Gregorfb912652013-03-20 21:10:35 +00004634 UnresolvedModuleRef Unresolved;
Guy Benyei11169dd2012-12-18 14:30:41 +00004635 Unresolved.File = &F;
4636 Unresolved.Mod = CurrentModule;
4637 Unresolved.ID = Record[Idx];
Douglas Gregorfb912652013-03-20 21:10:35 +00004638 Unresolved.Kind = UnresolvedModuleRef::Export;
Guy Benyei11169dd2012-12-18 14:30:41 +00004639 Unresolved.IsWildcard = Record[Idx + 1];
Douglas Gregorfb912652013-03-20 21:10:35 +00004640 UnresolvedModuleRefs.push_back(Unresolved);
Guy Benyei11169dd2012-12-18 14:30:41 +00004641 }
4642
4643 // Once we've loaded the set of exports, there's no reason to keep
4644 // the parsed, unresolved exports around.
4645 CurrentModule->UnresolvedExports.clear();
4646 break;
4647 }
4648 case SUBMODULE_REQUIRES: {
Richard Smitha3feee22013-10-28 22:18:19 +00004649 CurrentModule->addRequirement(Blob, Record[0], Context.getLangOpts(),
Guy Benyei11169dd2012-12-18 14:30:41 +00004650 Context.getTargetInfo());
4651 break;
4652 }
Douglas Gregor6ddfca92013-01-14 17:21:00 +00004653
4654 case SUBMODULE_LINK_LIBRARY:
Douglas Gregor6ddfca92013-01-14 17:21:00 +00004655 CurrentModule->LinkLibraries.push_back(
Chris Lattner0e6c9402013-01-20 02:38:54 +00004656 Module::LinkLibrary(Blob, Record[0]));
Douglas Gregor6ddfca92013-01-14 17:21:00 +00004657 break;
Douglas Gregor35b13ec2013-03-20 00:22:05 +00004658
4659 case SUBMODULE_CONFIG_MACRO:
Douglas Gregor35b13ec2013-03-20 00:22:05 +00004660 CurrentModule->ConfigMacros.push_back(Blob.str());
4661 break;
Douglas Gregorfb912652013-03-20 21:10:35 +00004662
4663 case SUBMODULE_CONFLICT: {
Douglas Gregorfb912652013-03-20 21:10:35 +00004664 UnresolvedModuleRef Unresolved;
4665 Unresolved.File = &F;
4666 Unresolved.Mod = CurrentModule;
4667 Unresolved.ID = Record[0];
4668 Unresolved.Kind = UnresolvedModuleRef::Conflict;
4669 Unresolved.IsWildcard = false;
4670 Unresolved.String = Blob;
4671 UnresolvedModuleRefs.push_back(Unresolved);
4672 break;
4673 }
Guy Benyei11169dd2012-12-18 14:30:41 +00004674 }
4675 }
4676}
4677
4678/// \brief Parse the record that corresponds to a LangOptions data
4679/// structure.
4680///
4681/// This routine parses the language options from the AST file and then gives
4682/// them to the AST listener if one is set.
4683///
4684/// \returns true if the listener deems the file unacceptable, false otherwise.
4685bool ASTReader::ParseLanguageOptions(const RecordData &Record,
4686 bool Complain,
Richard Smith1e2cf0d2014-10-31 02:28:58 +00004687 ASTReaderListener &Listener,
4688 bool AllowCompatibleDifferences) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004689 LangOptions LangOpts;
4690 unsigned Idx = 0;
4691#define LANGOPT(Name, Bits, Default, Description) \
4692 LangOpts.Name = Record[Idx++];
4693#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
4694 LangOpts.set##Name(static_cast<LangOptions::Type>(Record[Idx++]));
4695#include "clang/Basic/LangOptions.def"
Alexey Samsonovedf99a92014-11-07 22:29:38 +00004696#define SANITIZER(NAME, ID) \
4697 LangOpts.Sanitize.set(SanitizerKind::ID, Record[Idx++]);
Will Dietzf54319c2013-01-18 11:30:38 +00004698#include "clang/Basic/Sanitizers.def"
Guy Benyei11169dd2012-12-18 14:30:41 +00004699
Ben Langmuircd98cb72015-06-23 18:20:18 +00004700 for (unsigned N = Record[Idx++]; N; --N)
4701 LangOpts.ModuleFeatures.push_back(ReadString(Record, Idx));
4702
Guy Benyei11169dd2012-12-18 14:30:41 +00004703 ObjCRuntime::Kind runtimeKind = (ObjCRuntime::Kind) Record[Idx++];
4704 VersionTuple runtimeVersion = ReadVersionTuple(Record, Idx);
4705 LangOpts.ObjCRuntime = ObjCRuntime(runtimeKind, runtimeVersion);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00004706
Ben Langmuird4a667a2015-06-23 18:20:23 +00004707 LangOpts.CurrentModule = ReadString(Record, Idx);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00004708
4709 // Comment options.
4710 for (unsigned N = Record[Idx++]; N; --N) {
4711 LangOpts.CommentOpts.BlockCommandNames.push_back(
4712 ReadString(Record, Idx));
4713 }
Dmitri Gribenkoa7d16ce2013-04-10 15:35:17 +00004714 LangOpts.CommentOpts.ParseAllComments = Record[Idx++];
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00004715
Samuel Antaoee8fb302016-01-06 13:42:12 +00004716 // OpenMP offloading options.
4717 for (unsigned N = Record[Idx++]; N; --N) {
4718 LangOpts.OMPTargetTriples.push_back(llvm::Triple(ReadString(Record, Idx)));
4719 }
4720
4721 LangOpts.OMPHostIRFile = ReadString(Record, Idx);
4722
Richard Smith1e2cf0d2014-10-31 02:28:58 +00004723 return Listener.ReadLanguageOptions(LangOpts, Complain,
4724 AllowCompatibleDifferences);
Guy Benyei11169dd2012-12-18 14:30:41 +00004725}
4726
Chandler Carruth0d745bc2015-03-14 04:47:43 +00004727bool ASTReader::ParseTargetOptions(const RecordData &Record, bool Complain,
4728 ASTReaderListener &Listener,
4729 bool AllowCompatibleDifferences) {
Guy Benyei11169dd2012-12-18 14:30:41 +00004730 unsigned Idx = 0;
4731 TargetOptions TargetOpts;
4732 TargetOpts.Triple = ReadString(Record, Idx);
4733 TargetOpts.CPU = ReadString(Record, Idx);
4734 TargetOpts.ABI = ReadString(Record, Idx);
Guy Benyei11169dd2012-12-18 14:30:41 +00004735 for (unsigned N = Record[Idx++]; N; --N) {
4736 TargetOpts.FeaturesAsWritten.push_back(ReadString(Record, Idx));
4737 }
4738 for (unsigned N = Record[Idx++]; N; --N) {
4739 TargetOpts.Features.push_back(ReadString(Record, Idx));
4740 }
4741
Chandler Carruth0d745bc2015-03-14 04:47:43 +00004742 return Listener.ReadTargetOptions(TargetOpts, Complain,
4743 AllowCompatibleDifferences);
Guy Benyei11169dd2012-12-18 14:30:41 +00004744}
4745
4746bool ASTReader::ParseDiagnosticOptions(const RecordData &Record, bool Complain,
4747 ASTReaderListener &Listener) {
Ben Langmuirb92de022014-04-29 16:25:26 +00004748 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts(new DiagnosticOptions);
Guy Benyei11169dd2012-12-18 14:30:41 +00004749 unsigned Idx = 0;
Ben Langmuirb92de022014-04-29 16:25:26 +00004750#define DIAGOPT(Name, Bits, Default) DiagOpts->Name = Record[Idx++];
Guy Benyei11169dd2012-12-18 14:30:41 +00004751#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
Ben Langmuirb92de022014-04-29 16:25:26 +00004752 DiagOpts->set##Name(static_cast<Type>(Record[Idx++]));
Guy Benyei11169dd2012-12-18 14:30:41 +00004753#include "clang/Basic/DiagnosticOptions.def"
4754
Richard Smith3be1cb22014-08-07 00:24:21 +00004755 for (unsigned N = Record[Idx++]; N; --N)
Ben Langmuirb92de022014-04-29 16:25:26 +00004756 DiagOpts->Warnings.push_back(ReadString(Record, Idx));
Richard Smith3be1cb22014-08-07 00:24:21 +00004757 for (unsigned N = Record[Idx++]; N; --N)
4758 DiagOpts->Remarks.push_back(ReadString(Record, Idx));
Guy Benyei11169dd2012-12-18 14:30:41 +00004759
4760 return Listener.ReadDiagnosticOptions(DiagOpts, Complain);
4761}
4762
4763bool ASTReader::ParseFileSystemOptions(const RecordData &Record, bool Complain,
4764 ASTReaderListener &Listener) {
4765 FileSystemOptions FSOpts;
4766 unsigned Idx = 0;
4767 FSOpts.WorkingDir = ReadString(Record, Idx);
4768 return Listener.ReadFileSystemOptions(FSOpts, Complain);
4769}
4770
4771bool ASTReader::ParseHeaderSearchOptions(const RecordData &Record,
4772 bool Complain,
4773 ASTReaderListener &Listener) {
4774 HeaderSearchOptions HSOpts;
4775 unsigned Idx = 0;
4776 HSOpts.Sysroot = ReadString(Record, Idx);
4777
4778 // Include entries.
4779 for (unsigned N = Record[Idx++]; N; --N) {
4780 std::string Path = ReadString(Record, Idx);
4781 frontend::IncludeDirGroup Group
4782 = static_cast<frontend::IncludeDirGroup>(Record[Idx++]);
Guy Benyei11169dd2012-12-18 14:30:41 +00004783 bool IsFramework = Record[Idx++];
4784 bool IgnoreSysRoot = Record[Idx++];
Benjamin Kramer3204b152015-05-29 19:42:19 +00004785 HSOpts.UserEntries.emplace_back(std::move(Path), Group, IsFramework,
4786 IgnoreSysRoot);
Guy Benyei11169dd2012-12-18 14:30:41 +00004787 }
4788
4789 // System header prefixes.
4790 for (unsigned N = Record[Idx++]; N; --N) {
4791 std::string Prefix = ReadString(Record, Idx);
4792 bool IsSystemHeader = Record[Idx++];
Benjamin Kramer3204b152015-05-29 19:42:19 +00004793 HSOpts.SystemHeaderPrefixes.emplace_back(std::move(Prefix), IsSystemHeader);
Guy Benyei11169dd2012-12-18 14:30:41 +00004794 }
4795
4796 HSOpts.ResourceDir = ReadString(Record, Idx);
4797 HSOpts.ModuleCachePath = ReadString(Record, Idx);
Argyrios Kyrtzidis1594c152014-03-03 08:12:05 +00004798 HSOpts.ModuleUserBuildPath = ReadString(Record, Idx);
Guy Benyei11169dd2012-12-18 14:30:41 +00004799 HSOpts.DisableModuleHash = Record[Idx++];
4800 HSOpts.UseBuiltinIncludes = Record[Idx++];
4801 HSOpts.UseStandardSystemIncludes = Record[Idx++];
4802 HSOpts.UseStandardCXXIncludes = Record[Idx++];
4803 HSOpts.UseLibcxx = Record[Idx++];
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00004804 std::string SpecificModuleCachePath = ReadString(Record, Idx);
Guy Benyei11169dd2012-12-18 14:30:41 +00004805
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00004806 return Listener.ReadHeaderSearchOptions(HSOpts, SpecificModuleCachePath,
4807 Complain);
Guy Benyei11169dd2012-12-18 14:30:41 +00004808}
4809
4810bool ASTReader::ParsePreprocessorOptions(const RecordData &Record,
4811 bool Complain,
4812 ASTReaderListener &Listener,
4813 std::string &SuggestedPredefines) {
4814 PreprocessorOptions PPOpts;
4815 unsigned Idx = 0;
4816
4817 // Macro definitions/undefs
4818 for (unsigned N = Record[Idx++]; N; --N) {
4819 std::string Macro = ReadString(Record, Idx);
4820 bool IsUndef = Record[Idx++];
4821 PPOpts.Macros.push_back(std::make_pair(Macro, IsUndef));
4822 }
4823
4824 // Includes
4825 for (unsigned N = Record[Idx++]; N; --N) {
4826 PPOpts.Includes.push_back(ReadString(Record, Idx));
4827 }
4828
4829 // Macro Includes
4830 for (unsigned N = Record[Idx++]; N; --N) {
4831 PPOpts.MacroIncludes.push_back(ReadString(Record, Idx));
4832 }
4833
4834 PPOpts.UsePredefines = Record[Idx++];
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +00004835 PPOpts.DetailedRecord = Record[Idx++];
Guy Benyei11169dd2012-12-18 14:30:41 +00004836 PPOpts.ImplicitPCHInclude = ReadString(Record, Idx);
4837 PPOpts.ImplicitPTHInclude = ReadString(Record, Idx);
4838 PPOpts.ObjCXXARCStandardLibrary =
4839 static_cast<ObjCXXARCStandardLibraryKind>(Record[Idx++]);
4840 SuggestedPredefines.clear();
4841 return Listener.ReadPreprocessorOptions(PPOpts, Complain,
4842 SuggestedPredefines);
4843}
4844
4845std::pair<ModuleFile *, unsigned>
4846ASTReader::getModulePreprocessedEntity(unsigned GlobalIndex) {
4847 GlobalPreprocessedEntityMapType::iterator
4848 I = GlobalPreprocessedEntityMap.find(GlobalIndex);
4849 assert(I != GlobalPreprocessedEntityMap.end() &&
4850 "Corrupted global preprocessed entity map");
4851 ModuleFile *M = I->second;
4852 unsigned LocalIndex = GlobalIndex - M->BasePreprocessedEntityID;
4853 return std::make_pair(M, LocalIndex);
4854}
4855
Benjamin Kramerb4ef6682015-02-06 17:25:10 +00004856llvm::iterator_range<PreprocessingRecord::iterator>
Guy Benyei11169dd2012-12-18 14:30:41 +00004857ASTReader::getModulePreprocessedEntities(ModuleFile &Mod) const {
4858 if (PreprocessingRecord *PPRec = PP.getPreprocessingRecord())
4859 return PPRec->getIteratorsForLoadedRange(Mod.BasePreprocessedEntityID,
4860 Mod.NumPreprocessedEntities);
4861
Benjamin Kramerb4ef6682015-02-06 17:25:10 +00004862 return llvm::make_range(PreprocessingRecord::iterator(),
4863 PreprocessingRecord::iterator());
Guy Benyei11169dd2012-12-18 14:30:41 +00004864}
4865
Benjamin Kramerb4ef6682015-02-06 17:25:10 +00004866llvm::iterator_range<ASTReader::ModuleDeclIterator>
Guy Benyei11169dd2012-12-18 14:30:41 +00004867ASTReader::getModuleFileLevelDecls(ModuleFile &Mod) {
Benjamin Kramerb4ef6682015-02-06 17:25:10 +00004868 return llvm::make_range(
4869 ModuleDeclIterator(this, &Mod, Mod.FileSortedDecls),
4870 ModuleDeclIterator(this, &Mod,
4871 Mod.FileSortedDecls + Mod.NumFileSortedDecls));
Guy Benyei11169dd2012-12-18 14:30:41 +00004872}
4873
4874PreprocessedEntity *ASTReader::ReadPreprocessedEntity(unsigned Index) {
4875 PreprocessedEntityID PPID = Index+1;
4876 std::pair<ModuleFile *, unsigned> PPInfo = getModulePreprocessedEntity(Index);
4877 ModuleFile &M = *PPInfo.first;
4878 unsigned LocalIndex = PPInfo.second;
4879 const PPEntityOffset &PPOffs = M.PreprocessedEntityOffsets[LocalIndex];
4880
Guy Benyei11169dd2012-12-18 14:30:41 +00004881 if (!PP.getPreprocessingRecord()) {
4882 Error("no preprocessing record");
Craig Toppera13603a2014-05-22 05:54:18 +00004883 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00004884 }
4885
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004886 SavedStreamPosition SavedPosition(M.PreprocessorDetailCursor);
4887 M.PreprocessorDetailCursor.JumpToBit(PPOffs.BitOffset);
4888
4889 llvm::BitstreamEntry Entry =
4890 M.PreprocessorDetailCursor.advance(BitstreamCursor::AF_DontPopBlockAtEnd);
4891 if (Entry.Kind != llvm::BitstreamEntry::Record)
Craig Toppera13603a2014-05-22 05:54:18 +00004892 return nullptr;
Chris Lattner7fb3bef2013-01-20 00:56:42 +00004893
Guy Benyei11169dd2012-12-18 14:30:41 +00004894 // Read the record.
Richard Smithcb34bd32016-03-27 07:28:06 +00004895 SourceRange Range(TranslateSourceLocation(M, PPOffs.getBegin()),
4896 TranslateSourceLocation(M, PPOffs.getEnd()));
Guy Benyei11169dd2012-12-18 14:30:41 +00004897 PreprocessingRecord &PPRec = *PP.getPreprocessingRecord();
Chris Lattner0e6c9402013-01-20 02:38:54 +00004898 StringRef Blob;
Guy Benyei11169dd2012-12-18 14:30:41 +00004899 RecordData Record;
4900 PreprocessorDetailRecordTypes RecType =
Chris Lattner0e6c9402013-01-20 02:38:54 +00004901 (PreprocessorDetailRecordTypes)M.PreprocessorDetailCursor.readRecord(
4902 Entry.ID, Record, &Blob);
Guy Benyei11169dd2012-12-18 14:30:41 +00004903 switch (RecType) {
4904 case PPD_MACRO_EXPANSION: {
4905 bool isBuiltin = Record[0];
Craig Toppera13603a2014-05-22 05:54:18 +00004906 IdentifierInfo *Name = nullptr;
Richard Smith66a81862015-05-04 02:25:31 +00004907 MacroDefinitionRecord *Def = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00004908 if (isBuiltin)
4909 Name = getLocalIdentifier(M, Record[1]);
4910 else {
Richard Smith66a81862015-05-04 02:25:31 +00004911 PreprocessedEntityID GlobalID =
4912 getGlobalPreprocessedEntityID(M, Record[1]);
4913 Def = cast<MacroDefinitionRecord>(
4914 PPRec.getLoadedPreprocessedEntity(GlobalID - 1));
Guy Benyei11169dd2012-12-18 14:30:41 +00004915 }
4916
4917 MacroExpansion *ME;
4918 if (isBuiltin)
4919 ME = new (PPRec) MacroExpansion(Name, Range);
4920 else
4921 ME = new (PPRec) MacroExpansion(Def, Range);
4922
4923 return ME;
4924 }
4925
4926 case PPD_MACRO_DEFINITION: {
4927 // Decode the identifier info and then check again; if the macro is
4928 // still defined and associated with the identifier,
4929 IdentifierInfo *II = getLocalIdentifier(M, Record[0]);
Richard Smith66a81862015-05-04 02:25:31 +00004930 MacroDefinitionRecord *MD = new (PPRec) MacroDefinitionRecord(II, Range);
Guy Benyei11169dd2012-12-18 14:30:41 +00004931
4932 if (DeserializationListener)
4933 DeserializationListener->MacroDefinitionRead(PPID, MD);
4934
4935 return MD;
4936 }
4937
4938 case PPD_INCLUSION_DIRECTIVE: {
Chris Lattner0e6c9402013-01-20 02:38:54 +00004939 const char *FullFileNameStart = Blob.data() + Record[0];
4940 StringRef FullFileName(FullFileNameStart, Blob.size() - Record[0]);
Craig Toppera13603a2014-05-22 05:54:18 +00004941 const FileEntry *File = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00004942 if (!FullFileName.empty())
4943 File = PP.getFileManager().getFile(FullFileName);
4944
4945 // FIXME: Stable encoding
4946 InclusionDirective::InclusionKind Kind
4947 = static_cast<InclusionDirective::InclusionKind>(Record[2]);
4948 InclusionDirective *ID
4949 = new (PPRec) InclusionDirective(PPRec, Kind,
Chris Lattner0e6c9402013-01-20 02:38:54 +00004950 StringRef(Blob.data(), Record[0]),
Guy Benyei11169dd2012-12-18 14:30:41 +00004951 Record[1], Record[3],
4952 File,
4953 Range);
4954 return ID;
4955 }
4956 }
4957
4958 llvm_unreachable("Invalid PreprocessorDetailRecordTypes");
4959}
4960
4961/// \brief \arg SLocMapI points at a chunk of a module that contains no
4962/// preprocessed entities or the entities it contains are not the ones we are
4963/// looking for. Find the next module that contains entities and return the ID
4964/// of the first entry.
4965PreprocessedEntityID ASTReader::findNextPreprocessedEntity(
4966 GlobalSLocOffsetMapType::const_iterator SLocMapI) const {
4967 ++SLocMapI;
4968 for (GlobalSLocOffsetMapType::const_iterator
4969 EndI = GlobalSLocOffsetMap.end(); SLocMapI != EndI; ++SLocMapI) {
4970 ModuleFile &M = *SLocMapI->second;
4971 if (M.NumPreprocessedEntities)
4972 return M.BasePreprocessedEntityID;
4973 }
4974
4975 return getTotalNumPreprocessedEntities();
4976}
4977
4978namespace {
4979
Guy Benyei11169dd2012-12-18 14:30:41 +00004980struct PPEntityComp {
4981 const ASTReader &Reader;
4982 ModuleFile &M;
4983
4984 PPEntityComp(const ASTReader &Reader, ModuleFile &M) : Reader(Reader), M(M) { }
4985
4986 bool operator()(const PPEntityOffset &L, const PPEntityOffset &R) const {
4987 SourceLocation LHS = getLoc(L);
4988 SourceLocation RHS = getLoc(R);
4989 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
4990 }
4991
4992 bool operator()(const PPEntityOffset &L, SourceLocation RHS) const {
4993 SourceLocation LHS = getLoc(L);
4994 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
4995 }
4996
4997 bool operator()(SourceLocation LHS, const PPEntityOffset &R) const {
4998 SourceLocation RHS = getLoc(R);
4999 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
5000 }
5001
5002 SourceLocation getLoc(const PPEntityOffset &PPE) const {
Richard Smithb22a1d12016-03-27 20:13:24 +00005003 return Reader.TranslateSourceLocation(M, PPE.getBegin());
Guy Benyei11169dd2012-12-18 14:30:41 +00005004 }
5005};
5006
Alexander Kornienkoab9db512015-06-22 23:07:51 +00005007}
Guy Benyei11169dd2012-12-18 14:30:41 +00005008
Alp Toker2e9ce4c2014-05-16 18:59:21 +00005009PreprocessedEntityID ASTReader::findPreprocessedEntity(SourceLocation Loc,
5010 bool EndsAfter) const {
5011 if (SourceMgr.isLocalSourceLocation(Loc))
Guy Benyei11169dd2012-12-18 14:30:41 +00005012 return getTotalNumPreprocessedEntities();
5013
Alp Toker2e9ce4c2014-05-16 18:59:21 +00005014 GlobalSLocOffsetMapType::const_iterator SLocMapI = GlobalSLocOffsetMap.find(
5015 SourceManager::MaxLoadedOffset - Loc.getOffset() - 1);
Guy Benyei11169dd2012-12-18 14:30:41 +00005016 assert(SLocMapI != GlobalSLocOffsetMap.end() &&
5017 "Corrupted global sloc offset map");
5018
5019 if (SLocMapI->second->NumPreprocessedEntities == 0)
5020 return findNextPreprocessedEntity(SLocMapI);
5021
5022 ModuleFile &M = *SLocMapI->second;
5023 typedef const PPEntityOffset *pp_iterator;
5024 pp_iterator pp_begin = M.PreprocessedEntityOffsets;
5025 pp_iterator pp_end = pp_begin + M.NumPreprocessedEntities;
5026
5027 size_t Count = M.NumPreprocessedEntities;
5028 size_t Half;
5029 pp_iterator First = pp_begin;
5030 pp_iterator PPI;
5031
Alp Toker2e9ce4c2014-05-16 18:59:21 +00005032 if (EndsAfter) {
5033 PPI = std::upper_bound(pp_begin, pp_end, Loc,
Richard Smithb22a1d12016-03-27 20:13:24 +00005034 PPEntityComp(*this, M));
Alp Toker2e9ce4c2014-05-16 18:59:21 +00005035 } else {
5036 // Do a binary search manually instead of using std::lower_bound because
5037 // The end locations of entities may be unordered (when a macro expansion
5038 // is inside another macro argument), but for this case it is not important
5039 // whether we get the first macro expansion or its containing macro.
5040 while (Count > 0) {
5041 Half = Count / 2;
5042 PPI = First;
5043 std::advance(PPI, Half);
Richard Smithb22a1d12016-03-27 20:13:24 +00005044 if (SourceMgr.isBeforeInTranslationUnit(
5045 TranslateSourceLocation(M, PPI->getEnd()), Loc)) {
Alp Toker2e9ce4c2014-05-16 18:59:21 +00005046 First = PPI;
5047 ++First;
5048 Count = Count - Half - 1;
5049 } else
5050 Count = Half;
5051 }
Guy Benyei11169dd2012-12-18 14:30:41 +00005052 }
5053
5054 if (PPI == pp_end)
5055 return findNextPreprocessedEntity(SLocMapI);
5056
5057 return M.BasePreprocessedEntityID + (PPI - pp_begin);
5058}
5059
Guy Benyei11169dd2012-12-18 14:30:41 +00005060/// \brief Returns a pair of [Begin, End) indices of preallocated
5061/// preprocessed entities that \arg Range encompasses.
5062std::pair<unsigned, unsigned>
5063 ASTReader::findPreprocessedEntitiesInRange(SourceRange Range) {
5064 if (Range.isInvalid())
5065 return std::make_pair(0,0);
5066 assert(!SourceMgr.isBeforeInTranslationUnit(Range.getEnd(),Range.getBegin()));
5067
Alp Toker2e9ce4c2014-05-16 18:59:21 +00005068 PreprocessedEntityID BeginID =
5069 findPreprocessedEntity(Range.getBegin(), false);
5070 PreprocessedEntityID EndID = findPreprocessedEntity(Range.getEnd(), true);
Guy Benyei11169dd2012-12-18 14:30:41 +00005071 return std::make_pair(BeginID, EndID);
5072}
5073
5074/// \brief Optionally returns true or false if the preallocated preprocessed
5075/// entity with index \arg Index came from file \arg FID.
David Blaikie05785d12013-02-20 22:23:23 +00005076Optional<bool> ASTReader::isPreprocessedEntityInFileID(unsigned Index,
Guy Benyei11169dd2012-12-18 14:30:41 +00005077 FileID FID) {
5078 if (FID.isInvalid())
5079 return false;
5080
5081 std::pair<ModuleFile *, unsigned> PPInfo = getModulePreprocessedEntity(Index);
5082 ModuleFile &M = *PPInfo.first;
5083 unsigned LocalIndex = PPInfo.second;
5084 const PPEntityOffset &PPOffs = M.PreprocessedEntityOffsets[LocalIndex];
5085
Richard Smithcb34bd32016-03-27 07:28:06 +00005086 SourceLocation Loc = TranslateSourceLocation(M, PPOffs.getBegin());
Guy Benyei11169dd2012-12-18 14:30:41 +00005087 if (Loc.isInvalid())
5088 return false;
5089
5090 if (SourceMgr.isInFileID(SourceMgr.getFileLoc(Loc), FID))
5091 return true;
5092 else
5093 return false;
5094}
5095
5096namespace {
5097 /// \brief Visitor used to search for information about a header file.
5098 class HeaderFileInfoVisitor {
Guy Benyei11169dd2012-12-18 14:30:41 +00005099 const FileEntry *FE;
5100
David Blaikie05785d12013-02-20 22:23:23 +00005101 Optional<HeaderFileInfo> HFI;
Guy Benyei11169dd2012-12-18 14:30:41 +00005102
5103 public:
Argyrios Kyrtzidis61a38962013-03-06 18:12:44 +00005104 explicit HeaderFileInfoVisitor(const FileEntry *FE)
5105 : FE(FE) { }
Benjamin Kramer9a9efba2015-07-25 12:14:04 +00005106
5107 bool operator()(ModuleFile &M) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005108 HeaderFileInfoLookupTable *Table
5109 = static_cast<HeaderFileInfoLookupTable *>(M.HeaderFileInfoTable);
5110 if (!Table)
5111 return false;
5112
5113 // Look in the on-disk hash table for an entry for this file name.
Richard Smithbdf2d932015-07-30 03:37:16 +00005114 HeaderFileInfoLookupTable::iterator Pos = Table->find(FE);
Guy Benyei11169dd2012-12-18 14:30:41 +00005115 if (Pos == Table->end())
5116 return false;
5117
Richard Smithbdf2d932015-07-30 03:37:16 +00005118 HFI = *Pos;
Guy Benyei11169dd2012-12-18 14:30:41 +00005119 return true;
5120 }
5121
David Blaikie05785d12013-02-20 22:23:23 +00005122 Optional<HeaderFileInfo> getHeaderFileInfo() const { return HFI; }
Guy Benyei11169dd2012-12-18 14:30:41 +00005123 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00005124}
Guy Benyei11169dd2012-12-18 14:30:41 +00005125
5126HeaderFileInfo ASTReader::GetHeaderFileInfo(const FileEntry *FE) {
Argyrios Kyrtzidis61a38962013-03-06 18:12:44 +00005127 HeaderFileInfoVisitor Visitor(FE);
Benjamin Kramer9a9efba2015-07-25 12:14:04 +00005128 ModuleMgr.visit(Visitor);
Argyrios Kyrtzidis1054bbf2013-05-08 23:46:55 +00005129 if (Optional<HeaderFileInfo> HFI = Visitor.getHeaderFileInfo())
Guy Benyei11169dd2012-12-18 14:30:41 +00005130 return *HFI;
Guy Benyei11169dd2012-12-18 14:30:41 +00005131
5132 return HeaderFileInfo();
5133}
5134
5135void ASTReader::ReadPragmaDiagnosticMappings(DiagnosticsEngine &Diag) {
5136 // FIXME: Make it work properly with modules.
Dmitri Gribenkof8579502013-01-12 19:30:44 +00005137 SmallVector<DiagnosticsEngine::DiagState *, 32> DiagStates;
Guy Benyei11169dd2012-12-18 14:30:41 +00005138 for (ModuleIterator I = ModuleMgr.begin(), E = ModuleMgr.end(); I != E; ++I) {
5139 ModuleFile &F = *(*I);
5140 unsigned Idx = 0;
5141 DiagStates.clear();
5142 assert(!Diag.DiagStates.empty());
5143 DiagStates.push_back(&Diag.DiagStates.front()); // the command-line one.
5144 while (Idx < F.PragmaDiagMappings.size()) {
5145 SourceLocation Loc = ReadSourceLocation(F, F.PragmaDiagMappings[Idx++]);
5146 unsigned DiagStateID = F.PragmaDiagMappings[Idx++];
5147 if (DiagStateID != 0) {
5148 Diag.DiagStatePoints.push_back(
5149 DiagnosticsEngine::DiagStatePoint(DiagStates[DiagStateID-1],
5150 FullSourceLoc(Loc, SourceMgr)));
5151 continue;
5152 }
5153
5154 assert(DiagStateID == 0);
5155 // A new DiagState was created here.
5156 Diag.DiagStates.push_back(*Diag.GetCurDiagState());
5157 DiagnosticsEngine::DiagState *NewState = &Diag.DiagStates.back();
5158 DiagStates.push_back(NewState);
5159 Diag.DiagStatePoints.push_back(
5160 DiagnosticsEngine::DiagStatePoint(NewState,
5161 FullSourceLoc(Loc, SourceMgr)));
5162 while (1) {
5163 assert(Idx < F.PragmaDiagMappings.size() &&
5164 "Invalid data, didn't find '-1' marking end of diag/map pairs");
5165 if (Idx >= F.PragmaDiagMappings.size()) {
5166 break; // Something is messed up but at least avoid infinite loop in
5167 // release build.
5168 }
5169 unsigned DiagID = F.PragmaDiagMappings[Idx++];
5170 if (DiagID == (unsigned)-1) {
5171 break; // no more diag/map pairs for this location.
5172 }
Alp Tokerc726c362014-06-10 09:31:37 +00005173 diag::Severity Map = (diag::Severity)F.PragmaDiagMappings[Idx++];
5174 DiagnosticMapping Mapping = Diag.makeUserMapping(Map, Loc);
5175 Diag.GetCurDiagState()->setMapping(DiagID, Mapping);
Guy Benyei11169dd2012-12-18 14:30:41 +00005176 }
5177 }
5178 }
5179}
5180
5181/// \brief Get the correct cursor and offset for loading a type.
5182ASTReader::RecordLocation ASTReader::TypeCursorForIndex(unsigned Index) {
5183 GlobalTypeMapType::iterator I = GlobalTypeMap.find(Index);
5184 assert(I != GlobalTypeMap.end() && "Corrupted global type map");
5185 ModuleFile *M = I->second;
5186 return RecordLocation(M, M->TypeOffsets[Index - M->BaseTypeIndex]);
5187}
5188
5189/// \brief Read and return the type with the given index..
5190///
5191/// The index is the type ID, shifted and minus the number of predefs. This
5192/// routine actually reads the record corresponding to the type at the given
5193/// location. It is a helper routine for GetType, which deals with reading type
5194/// IDs.
5195QualType ASTReader::readTypeRecord(unsigned Index) {
5196 RecordLocation Loc = TypeCursorForIndex(Index);
Chris Lattner7fb3bef2013-01-20 00:56:42 +00005197 BitstreamCursor &DeclsCursor = Loc.F->DeclsCursor;
Guy Benyei11169dd2012-12-18 14:30:41 +00005198
5199 // Keep track of where we are in the stream, then jump back there
5200 // after reading this type.
5201 SavedStreamPosition SavedPosition(DeclsCursor);
5202
5203 ReadingKindTracker ReadingKind(Read_Type, *this);
5204
5205 // Note that we are loading a type record.
5206 Deserializing AType(this);
5207
5208 unsigned Idx = 0;
5209 DeclsCursor.JumpToBit(Loc.Offset);
5210 RecordData Record;
5211 unsigned Code = DeclsCursor.ReadCode();
Chris Lattner0e6c9402013-01-20 02:38:54 +00005212 switch ((TypeCode)DeclsCursor.readRecord(Code, Record)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00005213 case TYPE_EXT_QUAL: {
5214 if (Record.size() != 2) {
5215 Error("Incorrect encoding of extended qualifier type");
5216 return QualType();
5217 }
5218 QualType Base = readType(*Loc.F, Record, Idx);
5219 Qualifiers Quals = Qualifiers::fromOpaqueValue(Record[Idx++]);
5220 return Context.getQualifiedType(Base, Quals);
5221 }
5222
5223 case TYPE_COMPLEX: {
5224 if (Record.size() != 1) {
5225 Error("Incorrect encoding of complex type");
5226 return QualType();
5227 }
5228 QualType ElemType = readType(*Loc.F, Record, Idx);
5229 return Context.getComplexType(ElemType);
5230 }
5231
5232 case TYPE_POINTER: {
5233 if (Record.size() != 1) {
5234 Error("Incorrect encoding of pointer type");
5235 return QualType();
5236 }
5237 QualType PointeeType = readType(*Loc.F, Record, Idx);
5238 return Context.getPointerType(PointeeType);
5239 }
5240
Reid Kleckner8a365022013-06-24 17:51:48 +00005241 case TYPE_DECAYED: {
5242 if (Record.size() != 1) {
5243 Error("Incorrect encoding of decayed type");
5244 return QualType();
5245 }
5246 QualType OriginalType = readType(*Loc.F, Record, Idx);
5247 QualType DT = Context.getAdjustedParameterType(OriginalType);
5248 if (!isa<DecayedType>(DT))
5249 Error("Decayed type does not decay");
5250 return DT;
5251 }
5252
Reid Kleckner0503a872013-12-05 01:23:43 +00005253 case TYPE_ADJUSTED: {
5254 if (Record.size() != 2) {
5255 Error("Incorrect encoding of adjusted type");
5256 return QualType();
5257 }
5258 QualType OriginalTy = readType(*Loc.F, Record, Idx);
5259 QualType AdjustedTy = readType(*Loc.F, Record, Idx);
5260 return Context.getAdjustedType(OriginalTy, AdjustedTy);
5261 }
5262
Guy Benyei11169dd2012-12-18 14:30:41 +00005263 case TYPE_BLOCK_POINTER: {
5264 if (Record.size() != 1) {
5265 Error("Incorrect encoding of block pointer type");
5266 return QualType();
5267 }
5268 QualType PointeeType = readType(*Loc.F, Record, Idx);
5269 return Context.getBlockPointerType(PointeeType);
5270 }
5271
5272 case TYPE_LVALUE_REFERENCE: {
5273 if (Record.size() != 2) {
5274 Error("Incorrect encoding of lvalue reference type");
5275 return QualType();
5276 }
5277 QualType PointeeType = readType(*Loc.F, Record, Idx);
5278 return Context.getLValueReferenceType(PointeeType, Record[1]);
5279 }
5280
5281 case TYPE_RVALUE_REFERENCE: {
5282 if (Record.size() != 1) {
5283 Error("Incorrect encoding of rvalue reference type");
5284 return QualType();
5285 }
5286 QualType PointeeType = readType(*Loc.F, Record, Idx);
5287 return Context.getRValueReferenceType(PointeeType);
5288 }
5289
5290 case TYPE_MEMBER_POINTER: {
5291 if (Record.size() != 2) {
5292 Error("Incorrect encoding of member pointer type");
5293 return QualType();
5294 }
5295 QualType PointeeType = readType(*Loc.F, Record, Idx);
5296 QualType ClassType = readType(*Loc.F, Record, Idx);
5297 if (PointeeType.isNull() || ClassType.isNull())
5298 return QualType();
5299
5300 return Context.getMemberPointerType(PointeeType, ClassType.getTypePtr());
5301 }
5302
5303 case TYPE_CONSTANT_ARRAY: {
5304 QualType ElementType = readType(*Loc.F, Record, Idx);
5305 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
5306 unsigned IndexTypeQuals = Record[2];
5307 unsigned Idx = 3;
5308 llvm::APInt Size = ReadAPInt(Record, Idx);
5309 return Context.getConstantArrayType(ElementType, Size,
5310 ASM, IndexTypeQuals);
5311 }
5312
5313 case TYPE_INCOMPLETE_ARRAY: {
5314 QualType ElementType = readType(*Loc.F, Record, Idx);
5315 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
5316 unsigned IndexTypeQuals = Record[2];
5317 return Context.getIncompleteArrayType(ElementType, ASM, IndexTypeQuals);
5318 }
5319
5320 case TYPE_VARIABLE_ARRAY: {
5321 QualType ElementType = readType(*Loc.F, Record, Idx);
5322 ArrayType::ArraySizeModifier ASM = (ArrayType::ArraySizeModifier)Record[1];
5323 unsigned IndexTypeQuals = Record[2];
5324 SourceLocation LBLoc = ReadSourceLocation(*Loc.F, Record[3]);
5325 SourceLocation RBLoc = ReadSourceLocation(*Loc.F, Record[4]);
5326 return Context.getVariableArrayType(ElementType, ReadExpr(*Loc.F),
5327 ASM, IndexTypeQuals,
5328 SourceRange(LBLoc, RBLoc));
5329 }
5330
5331 case TYPE_VECTOR: {
5332 if (Record.size() != 3) {
5333 Error("incorrect encoding of vector type in AST file");
5334 return QualType();
5335 }
5336
5337 QualType ElementType = readType(*Loc.F, Record, Idx);
5338 unsigned NumElements = Record[1];
5339 unsigned VecKind = Record[2];
5340 return Context.getVectorType(ElementType, NumElements,
5341 (VectorType::VectorKind)VecKind);
5342 }
5343
5344 case TYPE_EXT_VECTOR: {
5345 if (Record.size() != 3) {
5346 Error("incorrect encoding of extended vector type in AST file");
5347 return QualType();
5348 }
5349
5350 QualType ElementType = readType(*Loc.F, Record, Idx);
5351 unsigned NumElements = Record[1];
5352 return Context.getExtVectorType(ElementType, NumElements);
5353 }
5354
5355 case TYPE_FUNCTION_NO_PROTO: {
5356 if (Record.size() != 6) {
5357 Error("incorrect encoding of no-proto function type");
5358 return QualType();
5359 }
5360 QualType ResultType = readType(*Loc.F, Record, Idx);
5361 FunctionType::ExtInfo Info(Record[1], Record[2], Record[3],
5362 (CallingConv)Record[4], Record[5]);
5363 return Context.getFunctionNoProtoType(ResultType, Info);
5364 }
5365
5366 case TYPE_FUNCTION_PROTO: {
5367 QualType ResultType = readType(*Loc.F, Record, Idx);
5368
5369 FunctionProtoType::ExtProtoInfo EPI;
5370 EPI.ExtInfo = FunctionType::ExtInfo(/*noreturn*/ Record[1],
5371 /*hasregparm*/ Record[2],
5372 /*regparm*/ Record[3],
5373 static_cast<CallingConv>(Record[4]),
5374 /*produces*/ Record[5]);
5375
5376 unsigned Idx = 6;
Guy Benyei11169dd2012-12-18 14:30:41 +00005377
5378 EPI.Variadic = Record[Idx++];
5379 EPI.HasTrailingReturn = Record[Idx++];
5380 EPI.TypeQuals = Record[Idx++];
5381 EPI.RefQualifier = static_cast<RefQualifierKind>(Record[Idx++]);
Richard Smith564417a2014-03-20 21:47:22 +00005382 SmallVector<QualType, 8> ExceptionStorage;
Richard Smith8acb4282014-07-31 21:57:55 +00005383 readExceptionSpec(*Loc.F, ExceptionStorage, EPI.ExceptionSpec, Record, Idx);
Richard Smith01b2cb42014-07-26 06:37:51 +00005384
5385 unsigned NumParams = Record[Idx++];
5386 SmallVector<QualType, 16> ParamTypes;
5387 for (unsigned I = 0; I != NumParams; ++I)
5388 ParamTypes.push_back(readType(*Loc.F, Record, Idx));
5389
John McCall18afab72016-03-01 00:49:02 +00005390 SmallVector<FunctionProtoType::ExtParameterInfo, 4> ExtParameterInfos;
5391 if (Idx != Record.size()) {
5392 for (unsigned I = 0; I != NumParams; ++I)
5393 ExtParameterInfos.push_back(
5394 FunctionProtoType::ExtParameterInfo
5395 ::getFromOpaqueValue(Record[Idx++]));
5396 EPI.ExtParameterInfos = ExtParameterInfos.data();
5397 }
5398
5399 assert(Idx == Record.size());
5400
Jordan Rose5c382722013-03-08 21:51:21 +00005401 return Context.getFunctionType(ResultType, ParamTypes, EPI);
Guy Benyei11169dd2012-12-18 14:30:41 +00005402 }
5403
5404 case TYPE_UNRESOLVED_USING: {
5405 unsigned Idx = 0;
5406 return Context.getTypeDeclType(
5407 ReadDeclAs<UnresolvedUsingTypenameDecl>(*Loc.F, Record, Idx));
5408 }
5409
5410 case TYPE_TYPEDEF: {
5411 if (Record.size() != 2) {
5412 Error("incorrect encoding of typedef type");
5413 return QualType();
5414 }
5415 unsigned Idx = 0;
5416 TypedefNameDecl *Decl = ReadDeclAs<TypedefNameDecl>(*Loc.F, Record, Idx);
5417 QualType Canonical = readType(*Loc.F, Record, Idx);
5418 if (!Canonical.isNull())
5419 Canonical = Context.getCanonicalType(Canonical);
5420 return Context.getTypedefType(Decl, Canonical);
5421 }
5422
5423 case TYPE_TYPEOF_EXPR:
5424 return Context.getTypeOfExprType(ReadExpr(*Loc.F));
5425
5426 case TYPE_TYPEOF: {
5427 if (Record.size() != 1) {
5428 Error("incorrect encoding of typeof(type) in AST file");
5429 return QualType();
5430 }
5431 QualType UnderlyingType = readType(*Loc.F, Record, Idx);
5432 return Context.getTypeOfType(UnderlyingType);
5433 }
5434
5435 case TYPE_DECLTYPE: {
5436 QualType UnderlyingType = readType(*Loc.F, Record, Idx);
5437 return Context.getDecltypeType(ReadExpr(*Loc.F), UnderlyingType);
5438 }
5439
5440 case TYPE_UNARY_TRANSFORM: {
5441 QualType BaseType = readType(*Loc.F, Record, Idx);
5442 QualType UnderlyingType = readType(*Loc.F, Record, Idx);
5443 UnaryTransformType::UTTKind UKind = (UnaryTransformType::UTTKind)Record[2];
5444 return Context.getUnaryTransformType(BaseType, UnderlyingType, UKind);
5445 }
5446
Richard Smith74aeef52013-04-26 16:15:35 +00005447 case TYPE_AUTO: {
5448 QualType Deduced = readType(*Loc.F, Record, Idx);
Richard Smithe301ba22015-11-11 02:02:15 +00005449 AutoTypeKeyword Keyword = (AutoTypeKeyword)Record[Idx++];
Richard Smith27d807c2013-04-30 13:56:41 +00005450 bool IsDependent = Deduced.isNull() ? Record[Idx++] : false;
Richard Smithe301ba22015-11-11 02:02:15 +00005451 return Context.getAutoType(Deduced, Keyword, IsDependent);
Richard Smith74aeef52013-04-26 16:15:35 +00005452 }
Guy Benyei11169dd2012-12-18 14:30:41 +00005453
5454 case TYPE_RECORD: {
5455 if (Record.size() != 2) {
5456 Error("incorrect encoding of record type");
5457 return QualType();
5458 }
5459 unsigned Idx = 0;
5460 bool IsDependent = Record[Idx++];
5461 RecordDecl *RD = ReadDeclAs<RecordDecl>(*Loc.F, Record, Idx);
5462 RD = cast_or_null<RecordDecl>(RD->getCanonicalDecl());
5463 QualType T = Context.getRecordType(RD);
5464 const_cast<Type*>(T.getTypePtr())->setDependent(IsDependent);
5465 return T;
5466 }
5467
5468 case TYPE_ENUM: {
5469 if (Record.size() != 2) {
5470 Error("incorrect encoding of enum type");
5471 return QualType();
5472 }
5473 unsigned Idx = 0;
5474 bool IsDependent = Record[Idx++];
5475 QualType T
5476 = Context.getEnumType(ReadDeclAs<EnumDecl>(*Loc.F, Record, Idx));
5477 const_cast<Type*>(T.getTypePtr())->setDependent(IsDependent);
5478 return T;
5479 }
5480
5481 case TYPE_ATTRIBUTED: {
5482 if (Record.size() != 3) {
5483 Error("incorrect encoding of attributed type");
5484 return QualType();
5485 }
5486 QualType modifiedType = readType(*Loc.F, Record, Idx);
5487 QualType equivalentType = readType(*Loc.F, Record, Idx);
5488 AttributedType::Kind kind = static_cast<AttributedType::Kind>(Record[2]);
5489 return Context.getAttributedType(kind, modifiedType, equivalentType);
5490 }
5491
5492 case TYPE_PAREN: {
5493 if (Record.size() != 1) {
5494 Error("incorrect encoding of paren type");
5495 return QualType();
5496 }
5497 QualType InnerType = readType(*Loc.F, Record, Idx);
5498 return Context.getParenType(InnerType);
5499 }
5500
5501 case TYPE_PACK_EXPANSION: {
5502 if (Record.size() != 2) {
5503 Error("incorrect encoding of pack expansion type");
5504 return QualType();
5505 }
5506 QualType Pattern = readType(*Loc.F, Record, Idx);
5507 if (Pattern.isNull())
5508 return QualType();
David Blaikie05785d12013-02-20 22:23:23 +00005509 Optional<unsigned> NumExpansions;
Guy Benyei11169dd2012-12-18 14:30:41 +00005510 if (Record[1])
5511 NumExpansions = Record[1] - 1;
5512 return Context.getPackExpansionType(Pattern, NumExpansions);
5513 }
5514
5515 case TYPE_ELABORATED: {
5516 unsigned Idx = 0;
5517 ElaboratedTypeKeyword Keyword = (ElaboratedTypeKeyword)Record[Idx++];
5518 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(*Loc.F, Record, Idx);
5519 QualType NamedType = readType(*Loc.F, Record, Idx);
5520 return Context.getElaboratedType(Keyword, NNS, NamedType);
5521 }
5522
5523 case TYPE_OBJC_INTERFACE: {
5524 unsigned Idx = 0;
5525 ObjCInterfaceDecl *ItfD
5526 = ReadDeclAs<ObjCInterfaceDecl>(*Loc.F, Record, Idx);
5527 return Context.getObjCInterfaceType(ItfD->getCanonicalDecl());
5528 }
5529
5530 case TYPE_OBJC_OBJECT: {
5531 unsigned Idx = 0;
5532 QualType Base = readType(*Loc.F, Record, Idx);
Douglas Gregore9d95f12015-07-07 03:57:35 +00005533 unsigned NumTypeArgs = Record[Idx++];
5534 SmallVector<QualType, 4> TypeArgs;
5535 for (unsigned I = 0; I != NumTypeArgs; ++I)
5536 TypeArgs.push_back(readType(*Loc.F, Record, Idx));
Guy Benyei11169dd2012-12-18 14:30:41 +00005537 unsigned NumProtos = Record[Idx++];
5538 SmallVector<ObjCProtocolDecl*, 4> Protos;
5539 for (unsigned I = 0; I != NumProtos; ++I)
5540 Protos.push_back(ReadDeclAs<ObjCProtocolDecl>(*Loc.F, Record, Idx));
Douglas Gregorab209d82015-07-07 03:58:42 +00005541 bool IsKindOf = Record[Idx++];
5542 return Context.getObjCObjectType(Base, TypeArgs, Protos, IsKindOf);
Guy Benyei11169dd2012-12-18 14:30:41 +00005543 }
5544
5545 case TYPE_OBJC_OBJECT_POINTER: {
5546 unsigned Idx = 0;
5547 QualType Pointee = readType(*Loc.F, Record, Idx);
5548 return Context.getObjCObjectPointerType(Pointee);
5549 }
5550
5551 case TYPE_SUBST_TEMPLATE_TYPE_PARM: {
5552 unsigned Idx = 0;
5553 QualType Parm = readType(*Loc.F, Record, Idx);
5554 QualType Replacement = readType(*Loc.F, Record, Idx);
Stephan Tolksdorfe96f8b32014-03-15 10:23:27 +00005555 return Context.getSubstTemplateTypeParmType(
5556 cast<TemplateTypeParmType>(Parm),
5557 Context.getCanonicalType(Replacement));
Guy Benyei11169dd2012-12-18 14:30:41 +00005558 }
5559
5560 case TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK: {
5561 unsigned Idx = 0;
5562 QualType Parm = readType(*Loc.F, Record, Idx);
5563 TemplateArgument ArgPack = ReadTemplateArgument(*Loc.F, Record, Idx);
5564 return Context.getSubstTemplateTypeParmPackType(
5565 cast<TemplateTypeParmType>(Parm),
5566 ArgPack);
5567 }
5568
5569 case TYPE_INJECTED_CLASS_NAME: {
5570 CXXRecordDecl *D = ReadDeclAs<CXXRecordDecl>(*Loc.F, Record, Idx);
5571 QualType TST = readType(*Loc.F, Record, Idx); // probably derivable
5572 // FIXME: ASTContext::getInjectedClassNameType is not currently suitable
5573 // for AST reading, too much interdependencies.
Richard Smith6377f8f2014-10-21 21:15:18 +00005574 const Type *T = nullptr;
5575 for (auto *DI = D; DI; DI = DI->getPreviousDecl()) {
5576 if (const Type *Existing = DI->getTypeForDecl()) {
5577 T = Existing;
5578 break;
5579 }
5580 }
5581 if (!T) {
Richard Smithf17fdbd2014-04-24 02:25:27 +00005582 T = new (Context, TypeAlignment) InjectedClassNameType(D, TST);
Richard Smith6377f8f2014-10-21 21:15:18 +00005583 for (auto *DI = D; DI; DI = DI->getPreviousDecl())
5584 DI->setTypeForDecl(T);
5585 }
Richard Smithf17fdbd2014-04-24 02:25:27 +00005586 return QualType(T, 0);
Guy Benyei11169dd2012-12-18 14:30:41 +00005587 }
5588
5589 case TYPE_TEMPLATE_TYPE_PARM: {
5590 unsigned Idx = 0;
5591 unsigned Depth = Record[Idx++];
5592 unsigned Index = Record[Idx++];
5593 bool Pack = Record[Idx++];
5594 TemplateTypeParmDecl *D
5595 = ReadDeclAs<TemplateTypeParmDecl>(*Loc.F, Record, Idx);
5596 return Context.getTemplateTypeParmType(Depth, Index, Pack, D);
5597 }
5598
5599 case TYPE_DEPENDENT_NAME: {
5600 unsigned Idx = 0;
5601 ElaboratedTypeKeyword Keyword = (ElaboratedTypeKeyword)Record[Idx++];
5602 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(*Loc.F, Record, Idx);
Richard Smithbdf2d932015-07-30 03:37:16 +00005603 const IdentifierInfo *Name = GetIdentifierInfo(*Loc.F, Record, Idx);
Guy Benyei11169dd2012-12-18 14:30:41 +00005604 QualType Canon = readType(*Loc.F, Record, Idx);
5605 if (!Canon.isNull())
5606 Canon = Context.getCanonicalType(Canon);
5607 return Context.getDependentNameType(Keyword, NNS, Name, Canon);
5608 }
5609
5610 case TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION: {
5611 unsigned Idx = 0;
5612 ElaboratedTypeKeyword Keyword = (ElaboratedTypeKeyword)Record[Idx++];
5613 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(*Loc.F, Record, Idx);
Richard Smithbdf2d932015-07-30 03:37:16 +00005614 const IdentifierInfo *Name = GetIdentifierInfo(*Loc.F, Record, Idx);
Guy Benyei11169dd2012-12-18 14:30:41 +00005615 unsigned NumArgs = Record[Idx++];
5616 SmallVector<TemplateArgument, 8> Args;
5617 Args.reserve(NumArgs);
5618 while (NumArgs--)
5619 Args.push_back(ReadTemplateArgument(*Loc.F, Record, Idx));
5620 return Context.getDependentTemplateSpecializationType(Keyword, NNS, Name,
5621 Args.size(), Args.data());
5622 }
5623
5624 case TYPE_DEPENDENT_SIZED_ARRAY: {
5625 unsigned Idx = 0;
5626
5627 // ArrayType
5628 QualType ElementType = readType(*Loc.F, Record, Idx);
5629 ArrayType::ArraySizeModifier ASM
5630 = (ArrayType::ArraySizeModifier)Record[Idx++];
5631 unsigned IndexTypeQuals = Record[Idx++];
5632
5633 // DependentSizedArrayType
5634 Expr *NumElts = ReadExpr(*Loc.F);
5635 SourceRange Brackets = ReadSourceRange(*Loc.F, Record, Idx);
5636
5637 return Context.getDependentSizedArrayType(ElementType, NumElts, ASM,
5638 IndexTypeQuals, Brackets);
5639 }
5640
5641 case TYPE_TEMPLATE_SPECIALIZATION: {
5642 unsigned Idx = 0;
5643 bool IsDependent = Record[Idx++];
5644 TemplateName Name = ReadTemplateName(*Loc.F, Record, Idx);
5645 SmallVector<TemplateArgument, 8> Args;
5646 ReadTemplateArgumentList(Args, *Loc.F, Record, Idx);
5647 QualType Underlying = readType(*Loc.F, Record, Idx);
5648 QualType T;
5649 if (Underlying.isNull())
5650 T = Context.getCanonicalTemplateSpecializationType(Name, Args.data(),
5651 Args.size());
5652 else
5653 T = Context.getTemplateSpecializationType(Name, Args.data(),
5654 Args.size(), Underlying);
5655 const_cast<Type*>(T.getTypePtr())->setDependent(IsDependent);
5656 return T;
5657 }
5658
5659 case TYPE_ATOMIC: {
5660 if (Record.size() != 1) {
5661 Error("Incorrect encoding of atomic type");
5662 return QualType();
5663 }
5664 QualType ValueType = readType(*Loc.F, Record, Idx);
5665 return Context.getAtomicType(ValueType);
5666 }
Xiuli Pan9c14e282016-01-09 12:53:17 +00005667
5668 case TYPE_PIPE: {
5669 if (Record.size() != 1) {
5670 Error("Incorrect encoding of pipe type");
5671 return QualType();
5672 }
5673
5674 // Reading the pipe element type.
5675 QualType ElementType = readType(*Loc.F, Record, Idx);
5676 return Context.getPipeType(ElementType);
5677 }
Guy Benyei11169dd2012-12-18 14:30:41 +00005678 }
5679 llvm_unreachable("Invalid TypeCode!");
5680}
5681
Richard Smith564417a2014-03-20 21:47:22 +00005682void ASTReader::readExceptionSpec(ModuleFile &ModuleFile,
5683 SmallVectorImpl<QualType> &Exceptions,
Richard Smith8acb4282014-07-31 21:57:55 +00005684 FunctionProtoType::ExceptionSpecInfo &ESI,
Richard Smith564417a2014-03-20 21:47:22 +00005685 const RecordData &Record, unsigned &Idx) {
5686 ExceptionSpecificationType EST =
5687 static_cast<ExceptionSpecificationType>(Record[Idx++]);
Richard Smith8acb4282014-07-31 21:57:55 +00005688 ESI.Type = EST;
Richard Smith564417a2014-03-20 21:47:22 +00005689 if (EST == EST_Dynamic) {
Richard Smith8acb4282014-07-31 21:57:55 +00005690 for (unsigned I = 0, N = Record[Idx++]; I != N; ++I)
Richard Smith564417a2014-03-20 21:47:22 +00005691 Exceptions.push_back(readType(ModuleFile, Record, Idx));
Richard Smith8acb4282014-07-31 21:57:55 +00005692 ESI.Exceptions = Exceptions;
Richard Smith564417a2014-03-20 21:47:22 +00005693 } else if (EST == EST_ComputedNoexcept) {
Richard Smith8acb4282014-07-31 21:57:55 +00005694 ESI.NoexceptExpr = ReadExpr(ModuleFile);
Richard Smith564417a2014-03-20 21:47:22 +00005695 } else if (EST == EST_Uninstantiated) {
Richard Smith8acb4282014-07-31 21:57:55 +00005696 ESI.SourceDecl = ReadDeclAs<FunctionDecl>(ModuleFile, Record, Idx);
5697 ESI.SourceTemplate = ReadDeclAs<FunctionDecl>(ModuleFile, Record, Idx);
Richard Smith564417a2014-03-20 21:47:22 +00005698 } else if (EST == EST_Unevaluated) {
Richard Smith8acb4282014-07-31 21:57:55 +00005699 ESI.SourceDecl = ReadDeclAs<FunctionDecl>(ModuleFile, Record, Idx);
Richard Smith564417a2014-03-20 21:47:22 +00005700 }
5701}
5702
Guy Benyei11169dd2012-12-18 14:30:41 +00005703class clang::TypeLocReader : public TypeLocVisitor<TypeLocReader> {
5704 ASTReader &Reader;
5705 ModuleFile &F;
5706 const ASTReader::RecordData &Record;
5707 unsigned &Idx;
5708
5709 SourceLocation ReadSourceLocation(const ASTReader::RecordData &R,
5710 unsigned &I) {
5711 return Reader.ReadSourceLocation(F, R, I);
5712 }
5713
5714 template<typename T>
5715 T *ReadDeclAs(const ASTReader::RecordData &Record, unsigned &Idx) {
5716 return Reader.ReadDeclAs<T>(F, Record, Idx);
5717 }
5718
5719public:
5720 TypeLocReader(ASTReader &Reader, ModuleFile &F,
5721 const ASTReader::RecordData &Record, unsigned &Idx)
5722 : Reader(Reader), F(F), Record(Record), Idx(Idx)
5723 { }
5724
5725 // We want compile-time assurance that we've enumerated all of
5726 // these, so unfortunately we have to declare them first, then
5727 // define them out-of-line.
5728#define ABSTRACT_TYPELOC(CLASS, PARENT)
5729#define TYPELOC(CLASS, PARENT) \
5730 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
5731#include "clang/AST/TypeLocNodes.def"
5732
5733 void VisitFunctionTypeLoc(FunctionTypeLoc);
5734 void VisitArrayTypeLoc(ArrayTypeLoc);
5735};
5736
5737void TypeLocReader::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
5738 // nothing to do
5739}
5740void TypeLocReader::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
5741 TL.setBuiltinLoc(ReadSourceLocation(Record, Idx));
5742 if (TL.needsExtraLocalData()) {
5743 TL.setWrittenTypeSpec(static_cast<DeclSpec::TST>(Record[Idx++]));
5744 TL.setWrittenSignSpec(static_cast<DeclSpec::TSS>(Record[Idx++]));
5745 TL.setWrittenWidthSpec(static_cast<DeclSpec::TSW>(Record[Idx++]));
5746 TL.setModeAttr(Record[Idx++]);
5747 }
5748}
5749void TypeLocReader::VisitComplexTypeLoc(ComplexTypeLoc TL) {
5750 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5751}
5752void TypeLocReader::VisitPointerTypeLoc(PointerTypeLoc TL) {
5753 TL.setStarLoc(ReadSourceLocation(Record, Idx));
5754}
Reid Kleckner8a365022013-06-24 17:51:48 +00005755void TypeLocReader::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
5756 // nothing to do
5757}
Reid Kleckner0503a872013-12-05 01:23:43 +00005758void TypeLocReader::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
5759 // nothing to do
5760}
Guy Benyei11169dd2012-12-18 14:30:41 +00005761void TypeLocReader::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
5762 TL.setCaretLoc(ReadSourceLocation(Record, Idx));
5763}
5764void TypeLocReader::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
5765 TL.setAmpLoc(ReadSourceLocation(Record, Idx));
5766}
5767void TypeLocReader::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
5768 TL.setAmpAmpLoc(ReadSourceLocation(Record, Idx));
5769}
5770void TypeLocReader::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
5771 TL.setStarLoc(ReadSourceLocation(Record, Idx));
5772 TL.setClassTInfo(Reader.GetTypeSourceInfo(F, Record, Idx));
5773}
5774void TypeLocReader::VisitArrayTypeLoc(ArrayTypeLoc TL) {
5775 TL.setLBracketLoc(ReadSourceLocation(Record, Idx));
5776 TL.setRBracketLoc(ReadSourceLocation(Record, Idx));
5777 if (Record[Idx++])
5778 TL.setSizeExpr(Reader.ReadExpr(F));
5779 else
Craig Toppera13603a2014-05-22 05:54:18 +00005780 TL.setSizeExpr(nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00005781}
5782void TypeLocReader::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
5783 VisitArrayTypeLoc(TL);
5784}
5785void TypeLocReader::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
5786 VisitArrayTypeLoc(TL);
5787}
5788void TypeLocReader::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
5789 VisitArrayTypeLoc(TL);
5790}
5791void TypeLocReader::VisitDependentSizedArrayTypeLoc(
5792 DependentSizedArrayTypeLoc TL) {
5793 VisitArrayTypeLoc(TL);
5794}
5795void TypeLocReader::VisitDependentSizedExtVectorTypeLoc(
5796 DependentSizedExtVectorTypeLoc TL) {
5797 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5798}
5799void TypeLocReader::VisitVectorTypeLoc(VectorTypeLoc TL) {
5800 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5801}
5802void TypeLocReader::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
5803 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5804}
5805void TypeLocReader::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
5806 TL.setLocalRangeBegin(ReadSourceLocation(Record, Idx));
5807 TL.setLParenLoc(ReadSourceLocation(Record, Idx));
5808 TL.setRParenLoc(ReadSourceLocation(Record, Idx));
5809 TL.setLocalRangeEnd(ReadSourceLocation(Record, Idx));
Alp Tokerb3fd5cf2014-01-21 00:32:38 +00005810 for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i) {
5811 TL.setParam(i, ReadDeclAs<ParmVarDecl>(Record, Idx));
Guy Benyei11169dd2012-12-18 14:30:41 +00005812 }
5813}
5814void TypeLocReader::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
5815 VisitFunctionTypeLoc(TL);
5816}
5817void TypeLocReader::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
5818 VisitFunctionTypeLoc(TL);
5819}
5820void TypeLocReader::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
5821 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5822}
5823void TypeLocReader::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
5824 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5825}
5826void TypeLocReader::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
5827 TL.setTypeofLoc(ReadSourceLocation(Record, Idx));
5828 TL.setLParenLoc(ReadSourceLocation(Record, Idx));
5829 TL.setRParenLoc(ReadSourceLocation(Record, Idx));
5830}
5831void TypeLocReader::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
5832 TL.setTypeofLoc(ReadSourceLocation(Record, Idx));
5833 TL.setLParenLoc(ReadSourceLocation(Record, Idx));
5834 TL.setRParenLoc(ReadSourceLocation(Record, Idx));
5835 TL.setUnderlyingTInfo(Reader.GetTypeSourceInfo(F, Record, Idx));
5836}
5837void TypeLocReader::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
5838 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5839}
5840void TypeLocReader::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
5841 TL.setKWLoc(ReadSourceLocation(Record, Idx));
5842 TL.setLParenLoc(ReadSourceLocation(Record, Idx));
5843 TL.setRParenLoc(ReadSourceLocation(Record, Idx));
5844 TL.setUnderlyingTInfo(Reader.GetTypeSourceInfo(F, Record, Idx));
5845}
5846void TypeLocReader::VisitAutoTypeLoc(AutoTypeLoc TL) {
5847 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5848}
5849void TypeLocReader::VisitRecordTypeLoc(RecordTypeLoc TL) {
5850 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5851}
5852void TypeLocReader::VisitEnumTypeLoc(EnumTypeLoc TL) {
5853 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5854}
5855void TypeLocReader::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
5856 TL.setAttrNameLoc(ReadSourceLocation(Record, Idx));
5857 if (TL.hasAttrOperand()) {
5858 SourceRange range;
5859 range.setBegin(ReadSourceLocation(Record, Idx));
5860 range.setEnd(ReadSourceLocation(Record, Idx));
5861 TL.setAttrOperandParensRange(range);
5862 }
5863 if (TL.hasAttrExprOperand()) {
5864 if (Record[Idx++])
5865 TL.setAttrExprOperand(Reader.ReadExpr(F));
5866 else
Craig Toppera13603a2014-05-22 05:54:18 +00005867 TL.setAttrExprOperand(nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00005868 } else if (TL.hasAttrEnumOperand())
5869 TL.setAttrEnumOperandLoc(ReadSourceLocation(Record, Idx));
5870}
5871void TypeLocReader::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
5872 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5873}
5874void TypeLocReader::VisitSubstTemplateTypeParmTypeLoc(
5875 SubstTemplateTypeParmTypeLoc TL) {
5876 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5877}
5878void TypeLocReader::VisitSubstTemplateTypeParmPackTypeLoc(
5879 SubstTemplateTypeParmPackTypeLoc TL) {
5880 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5881}
5882void TypeLocReader::VisitTemplateSpecializationTypeLoc(
5883 TemplateSpecializationTypeLoc TL) {
5884 TL.setTemplateKeywordLoc(ReadSourceLocation(Record, Idx));
5885 TL.setTemplateNameLoc(ReadSourceLocation(Record, Idx));
5886 TL.setLAngleLoc(ReadSourceLocation(Record, Idx));
5887 TL.setRAngleLoc(ReadSourceLocation(Record, Idx));
5888 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
5889 TL.setArgLocInfo(i,
5890 Reader.GetTemplateArgumentLocInfo(F,
5891 TL.getTypePtr()->getArg(i).getKind(),
5892 Record, Idx));
5893}
5894void TypeLocReader::VisitParenTypeLoc(ParenTypeLoc TL) {
5895 TL.setLParenLoc(ReadSourceLocation(Record, Idx));
5896 TL.setRParenLoc(ReadSourceLocation(Record, Idx));
5897}
5898void TypeLocReader::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
5899 TL.setElaboratedKeywordLoc(ReadSourceLocation(Record, Idx));
5900 TL.setQualifierLoc(Reader.ReadNestedNameSpecifierLoc(F, Record, Idx));
5901}
5902void TypeLocReader::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
5903 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5904}
5905void TypeLocReader::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
5906 TL.setElaboratedKeywordLoc(ReadSourceLocation(Record, Idx));
5907 TL.setQualifierLoc(Reader.ReadNestedNameSpecifierLoc(F, Record, Idx));
5908 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5909}
5910void TypeLocReader::VisitDependentTemplateSpecializationTypeLoc(
5911 DependentTemplateSpecializationTypeLoc TL) {
5912 TL.setElaboratedKeywordLoc(ReadSourceLocation(Record, Idx));
5913 TL.setQualifierLoc(Reader.ReadNestedNameSpecifierLoc(F, Record, Idx));
5914 TL.setTemplateKeywordLoc(ReadSourceLocation(Record, Idx));
5915 TL.setTemplateNameLoc(ReadSourceLocation(Record, Idx));
5916 TL.setLAngleLoc(ReadSourceLocation(Record, Idx));
5917 TL.setRAngleLoc(ReadSourceLocation(Record, Idx));
5918 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
5919 TL.setArgLocInfo(I,
5920 Reader.GetTemplateArgumentLocInfo(F,
5921 TL.getTypePtr()->getArg(I).getKind(),
5922 Record, Idx));
5923}
5924void TypeLocReader::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
5925 TL.setEllipsisLoc(ReadSourceLocation(Record, Idx));
5926}
5927void TypeLocReader::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
5928 TL.setNameLoc(ReadSourceLocation(Record, Idx));
5929}
5930void TypeLocReader::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
5931 TL.setHasBaseTypeAsWritten(Record[Idx++]);
Douglas Gregore9d95f12015-07-07 03:57:35 +00005932 TL.setTypeArgsLAngleLoc(ReadSourceLocation(Record, Idx));
5933 TL.setTypeArgsRAngleLoc(ReadSourceLocation(Record, Idx));
5934 for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
5935 TL.setTypeArgTInfo(i, Reader.GetTypeSourceInfo(F, Record, Idx));
5936 TL.setProtocolLAngleLoc(ReadSourceLocation(Record, Idx));
5937 TL.setProtocolRAngleLoc(ReadSourceLocation(Record, Idx));
Guy Benyei11169dd2012-12-18 14:30:41 +00005938 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
5939 TL.setProtocolLoc(i, ReadSourceLocation(Record, Idx));
5940}
5941void TypeLocReader::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
5942 TL.setStarLoc(ReadSourceLocation(Record, Idx));
5943}
5944void TypeLocReader::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
5945 TL.setKWLoc(ReadSourceLocation(Record, Idx));
5946 TL.setLParenLoc(ReadSourceLocation(Record, Idx));
5947 TL.setRParenLoc(ReadSourceLocation(Record, Idx));
5948}
Xiuli Pan9c14e282016-01-09 12:53:17 +00005949void TypeLocReader::VisitPipeTypeLoc(PipeTypeLoc TL) {
5950 TL.setKWLoc(ReadSourceLocation(Record, Idx));
5951}
Guy Benyei11169dd2012-12-18 14:30:41 +00005952
5953TypeSourceInfo *ASTReader::GetTypeSourceInfo(ModuleFile &F,
5954 const RecordData &Record,
5955 unsigned &Idx) {
5956 QualType InfoTy = readType(F, Record, Idx);
5957 if (InfoTy.isNull())
Craig Toppera13603a2014-05-22 05:54:18 +00005958 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00005959
5960 TypeSourceInfo *TInfo = getContext().CreateTypeSourceInfo(InfoTy);
5961 TypeLocReader TLR(*this, F, Record, Idx);
5962 for (TypeLoc TL = TInfo->getTypeLoc(); !TL.isNull(); TL = TL.getNextTypeLoc())
5963 TLR.Visit(TL);
5964 return TInfo;
5965}
5966
5967QualType ASTReader::GetType(TypeID ID) {
5968 unsigned FastQuals = ID & Qualifiers::FastMask;
5969 unsigned Index = ID >> Qualifiers::FastWidth;
5970
5971 if (Index < NUM_PREDEF_TYPE_IDS) {
5972 QualType T;
5973 switch ((PredefinedTypeIDs)Index) {
Alexey Baderbdf7c842015-09-15 12:18:29 +00005974 case PREDEF_TYPE_NULL_ID:
5975 return QualType();
5976 case PREDEF_TYPE_VOID_ID:
5977 T = Context.VoidTy;
5978 break;
5979 case PREDEF_TYPE_BOOL_ID:
5980 T = Context.BoolTy;
5981 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00005982
5983 case PREDEF_TYPE_CHAR_U_ID:
5984 case PREDEF_TYPE_CHAR_S_ID:
5985 // FIXME: Check that the signedness of CharTy is correct!
5986 T = Context.CharTy;
5987 break;
5988
Alexey Baderbdf7c842015-09-15 12:18:29 +00005989 case PREDEF_TYPE_UCHAR_ID:
5990 T = Context.UnsignedCharTy;
5991 break;
5992 case PREDEF_TYPE_USHORT_ID:
5993 T = Context.UnsignedShortTy;
5994 break;
5995 case PREDEF_TYPE_UINT_ID:
5996 T = Context.UnsignedIntTy;
5997 break;
5998 case PREDEF_TYPE_ULONG_ID:
5999 T = Context.UnsignedLongTy;
6000 break;
6001 case PREDEF_TYPE_ULONGLONG_ID:
6002 T = Context.UnsignedLongLongTy;
6003 break;
6004 case PREDEF_TYPE_UINT128_ID:
6005 T = Context.UnsignedInt128Ty;
6006 break;
6007 case PREDEF_TYPE_SCHAR_ID:
6008 T = Context.SignedCharTy;
6009 break;
6010 case PREDEF_TYPE_WCHAR_ID:
6011 T = Context.WCharTy;
6012 break;
6013 case PREDEF_TYPE_SHORT_ID:
6014 T = Context.ShortTy;
6015 break;
6016 case PREDEF_TYPE_INT_ID:
6017 T = Context.IntTy;
6018 break;
6019 case PREDEF_TYPE_LONG_ID:
6020 T = Context.LongTy;
6021 break;
6022 case PREDEF_TYPE_LONGLONG_ID:
6023 T = Context.LongLongTy;
6024 break;
6025 case PREDEF_TYPE_INT128_ID:
6026 T = Context.Int128Ty;
6027 break;
6028 case PREDEF_TYPE_HALF_ID:
6029 T = Context.HalfTy;
6030 break;
6031 case PREDEF_TYPE_FLOAT_ID:
6032 T = Context.FloatTy;
6033 break;
6034 case PREDEF_TYPE_DOUBLE_ID:
6035 T = Context.DoubleTy;
6036 break;
6037 case PREDEF_TYPE_LONGDOUBLE_ID:
6038 T = Context.LongDoubleTy;
6039 break;
6040 case PREDEF_TYPE_OVERLOAD_ID:
6041 T = Context.OverloadTy;
6042 break;
6043 case PREDEF_TYPE_BOUND_MEMBER:
6044 T = Context.BoundMemberTy;
6045 break;
6046 case PREDEF_TYPE_PSEUDO_OBJECT:
6047 T = Context.PseudoObjectTy;
6048 break;
6049 case PREDEF_TYPE_DEPENDENT_ID:
6050 T = Context.DependentTy;
6051 break;
6052 case PREDEF_TYPE_UNKNOWN_ANY:
6053 T = Context.UnknownAnyTy;
6054 break;
6055 case PREDEF_TYPE_NULLPTR_ID:
6056 T = Context.NullPtrTy;
6057 break;
6058 case PREDEF_TYPE_CHAR16_ID:
6059 T = Context.Char16Ty;
6060 break;
6061 case PREDEF_TYPE_CHAR32_ID:
6062 T = Context.Char32Ty;
6063 break;
6064 case PREDEF_TYPE_OBJC_ID:
6065 T = Context.ObjCBuiltinIdTy;
6066 break;
6067 case PREDEF_TYPE_OBJC_CLASS:
6068 T = Context.ObjCBuiltinClassTy;
6069 break;
6070 case PREDEF_TYPE_OBJC_SEL:
6071 T = Context.ObjCBuiltinSelTy;
6072 break;
Alexey Bader954ba212016-04-08 13:40:33 +00006073#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
6074 case PREDEF_TYPE_##Id##_ID: \
6075 T = Context.SingletonId; \
Alexey Baderbdf7c842015-09-15 12:18:29 +00006076 break;
Alexey Baderb62f1442016-04-13 08:33:41 +00006077#include "clang/Basic/OpenCLImageTypes.def"
Alexey Baderbdf7c842015-09-15 12:18:29 +00006078 case PREDEF_TYPE_SAMPLER_ID:
6079 T = Context.OCLSamplerTy;
6080 break;
6081 case PREDEF_TYPE_EVENT_ID:
6082 T = Context.OCLEventTy;
6083 break;
Alexey Bader9c8453f2015-09-15 11:18:52 +00006084 case PREDEF_TYPE_CLK_EVENT_ID:
6085 T = Context.OCLClkEventTy;
6086 break;
6087 case PREDEF_TYPE_QUEUE_ID:
6088 T = Context.OCLQueueTy;
6089 break;
6090 case PREDEF_TYPE_NDRANGE_ID:
6091 T = Context.OCLNDRangeTy;
6092 break;
6093 case PREDEF_TYPE_RESERVE_ID_ID:
6094 T = Context.OCLReserveIDTy;
6095 break;
Alexey Baderbdf7c842015-09-15 12:18:29 +00006096 case PREDEF_TYPE_AUTO_DEDUCT:
6097 T = Context.getAutoDeductType();
6098 break;
6099
6100 case PREDEF_TYPE_AUTO_RREF_DEDUCT:
6101 T = Context.getAutoRRefDeductType();
Guy Benyei11169dd2012-12-18 14:30:41 +00006102 break;
6103
6104 case PREDEF_TYPE_ARC_UNBRIDGED_CAST:
6105 T = Context.ARCUnbridgedCastTy;
6106 break;
6107
Guy Benyei11169dd2012-12-18 14:30:41 +00006108 case PREDEF_TYPE_BUILTIN_FN:
6109 T = Context.BuiltinFnTy;
6110 break;
Alexey Bataev1a3320e2015-08-25 14:24:04 +00006111
6112 case PREDEF_TYPE_OMP_ARRAY_SECTION:
6113 T = Context.OMPArraySectionTy;
6114 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00006115 }
6116
6117 assert(!T.isNull() && "Unknown predefined type");
6118 return T.withFastQualifiers(FastQuals);
6119 }
6120
6121 Index -= NUM_PREDEF_TYPE_IDS;
6122 assert(Index < TypesLoaded.size() && "Type index out-of-range");
6123 if (TypesLoaded[Index].isNull()) {
6124 TypesLoaded[Index] = readTypeRecord(Index);
6125 if (TypesLoaded[Index].isNull())
6126 return QualType();
6127
6128 TypesLoaded[Index]->setFromAST();
6129 if (DeserializationListener)
6130 DeserializationListener->TypeRead(TypeIdx::fromTypeID(ID),
6131 TypesLoaded[Index]);
6132 }
6133
6134 return TypesLoaded[Index].withFastQualifiers(FastQuals);
6135}
6136
6137QualType ASTReader::getLocalType(ModuleFile &F, unsigned LocalID) {
6138 return GetType(getGlobalTypeID(F, LocalID));
6139}
6140
6141serialization::TypeID
6142ASTReader::getGlobalTypeID(ModuleFile &F, unsigned LocalID) const {
6143 unsigned FastQuals = LocalID & Qualifiers::FastMask;
6144 unsigned LocalIndex = LocalID >> Qualifiers::FastWidth;
6145
6146 if (LocalIndex < NUM_PREDEF_TYPE_IDS)
6147 return LocalID;
6148
6149 ContinuousRangeMap<uint32_t, int, 2>::iterator I
6150 = F.TypeRemap.find(LocalIndex - NUM_PREDEF_TYPE_IDS);
6151 assert(I != F.TypeRemap.end() && "Invalid index into type index remap");
6152
6153 unsigned GlobalIndex = LocalIndex + I->second;
6154 return (GlobalIndex << Qualifiers::FastWidth) | FastQuals;
6155}
6156
6157TemplateArgumentLocInfo
6158ASTReader::GetTemplateArgumentLocInfo(ModuleFile &F,
6159 TemplateArgument::ArgKind Kind,
6160 const RecordData &Record,
6161 unsigned &Index) {
6162 switch (Kind) {
6163 case TemplateArgument::Expression:
6164 return ReadExpr(F);
6165 case TemplateArgument::Type:
6166 return GetTypeSourceInfo(F, Record, Index);
6167 case TemplateArgument::Template: {
6168 NestedNameSpecifierLoc QualifierLoc = ReadNestedNameSpecifierLoc(F, Record,
6169 Index);
6170 SourceLocation TemplateNameLoc = ReadSourceLocation(F, Record, Index);
6171 return TemplateArgumentLocInfo(QualifierLoc, TemplateNameLoc,
6172 SourceLocation());
6173 }
6174 case TemplateArgument::TemplateExpansion: {
6175 NestedNameSpecifierLoc QualifierLoc = ReadNestedNameSpecifierLoc(F, Record,
6176 Index);
6177 SourceLocation TemplateNameLoc = ReadSourceLocation(F, Record, Index);
6178 SourceLocation EllipsisLoc = ReadSourceLocation(F, Record, Index);
6179 return TemplateArgumentLocInfo(QualifierLoc, TemplateNameLoc,
6180 EllipsisLoc);
6181 }
6182 case TemplateArgument::Null:
6183 case TemplateArgument::Integral:
6184 case TemplateArgument::Declaration:
6185 case TemplateArgument::NullPtr:
6186 case TemplateArgument::Pack:
6187 // FIXME: Is this right?
6188 return TemplateArgumentLocInfo();
6189 }
6190 llvm_unreachable("unexpected template argument loc");
6191}
6192
6193TemplateArgumentLoc
6194ASTReader::ReadTemplateArgumentLoc(ModuleFile &F,
6195 const RecordData &Record, unsigned &Index) {
6196 TemplateArgument Arg = ReadTemplateArgument(F, Record, Index);
6197
6198 if (Arg.getKind() == TemplateArgument::Expression) {
6199 if (Record[Index++]) // bool InfoHasSameExpr.
6200 return TemplateArgumentLoc(Arg, TemplateArgumentLocInfo(Arg.getAsExpr()));
6201 }
6202 return TemplateArgumentLoc(Arg, GetTemplateArgumentLocInfo(F, Arg.getKind(),
6203 Record, Index));
6204}
6205
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00006206const ASTTemplateArgumentListInfo*
6207ASTReader::ReadASTTemplateArgumentListInfo(ModuleFile &F,
6208 const RecordData &Record,
6209 unsigned &Index) {
6210 SourceLocation LAngleLoc = ReadSourceLocation(F, Record, Index);
6211 SourceLocation RAngleLoc = ReadSourceLocation(F, Record, Index);
6212 unsigned NumArgsAsWritten = Record[Index++];
6213 TemplateArgumentListInfo TemplArgsInfo(LAngleLoc, RAngleLoc);
6214 for (unsigned i = 0; i != NumArgsAsWritten; ++i)
6215 TemplArgsInfo.addArgument(ReadTemplateArgumentLoc(F, Record, Index));
6216 return ASTTemplateArgumentListInfo::Create(getContext(), TemplArgsInfo);
6217}
6218
Guy Benyei11169dd2012-12-18 14:30:41 +00006219Decl *ASTReader::GetExternalDecl(uint32_t ID) {
6220 return GetDecl(ID);
6221}
6222
Richard Smith50895422015-01-31 03:04:55 +00006223template<typename TemplateSpecializationDecl>
6224static void completeRedeclChainForTemplateSpecialization(Decl *D) {
6225 if (auto *TSD = dyn_cast<TemplateSpecializationDecl>(D))
6226 TSD->getSpecializedTemplate()->LoadLazySpecializations();
6227}
6228
Richard Smith053f6c62014-05-16 23:01:30 +00006229void ASTReader::CompleteRedeclChain(const Decl *D) {
Richard Smith851072e2014-05-19 20:59:20 +00006230 if (NumCurrentElementsDeserializing) {
6231 // We arrange to not care about the complete redeclaration chain while we're
6232 // deserializing. Just remember that the AST has marked this one as complete
6233 // but that it's not actually complete yet, so we know we still need to
6234 // complete it later.
6235 PendingIncompleteDeclChains.push_back(const_cast<Decl*>(D));
6236 return;
6237 }
6238
Richard Smith053f6c62014-05-16 23:01:30 +00006239 const DeclContext *DC = D->getDeclContext()->getRedeclContext();
6240
Richard Smith053f6c62014-05-16 23:01:30 +00006241 // If this is a named declaration, complete it by looking it up
6242 // within its context.
6243 //
Richard Smith01bdb7a2014-08-28 05:44:07 +00006244 // FIXME: Merging a function definition should merge
Richard Smith053f6c62014-05-16 23:01:30 +00006245 // all mergeable entities within it.
6246 if (isa<TranslationUnitDecl>(DC) || isa<NamespaceDecl>(DC) ||
6247 isa<CXXRecordDecl>(DC) || isa<EnumDecl>(DC)) {
6248 if (DeclarationName Name = cast<NamedDecl>(D)->getDeclName()) {
Richard Smitha534a312015-07-21 23:54:07 +00006249 if (!getContext().getLangOpts().CPlusPlus &&
6250 isa<TranslationUnitDecl>(DC)) {
Richard Smith053f6c62014-05-16 23:01:30 +00006251 // Outside of C++, we don't have a lookup table for the TU, so update
Richard Smitha534a312015-07-21 23:54:07 +00006252 // the identifier instead. (For C++ modules, we don't store decls
6253 // in the serialized identifier table, so we do the lookup in the TU.)
6254 auto *II = Name.getAsIdentifierInfo();
6255 assert(II && "non-identifier name in C?");
Richard Smith053f6c62014-05-16 23:01:30 +00006256 if (II->isOutOfDate())
6257 updateOutOfDateIdentifier(*II);
6258 } else
6259 DC->lookup(Name);
Richard Smith01bdb7a2014-08-28 05:44:07 +00006260 } else if (needsAnonymousDeclarationNumber(cast<NamedDecl>(D))) {
Richard Smith3cb15722015-08-05 22:41:45 +00006261 // Find all declarations of this kind from the relevant context.
6262 for (auto *DCDecl : cast<Decl>(D->getLexicalDeclContext())->redecls()) {
6263 auto *DC = cast<DeclContext>(DCDecl);
6264 SmallVector<Decl*, 8> Decls;
6265 FindExternalLexicalDecls(
6266 DC, [&](Decl::Kind K) { return K == D->getKind(); }, Decls);
6267 }
Richard Smith053f6c62014-05-16 23:01:30 +00006268 }
6269 }
Richard Smith50895422015-01-31 03:04:55 +00006270
6271 if (auto *CTSD = dyn_cast<ClassTemplateSpecializationDecl>(D))
6272 CTSD->getSpecializedTemplate()->LoadLazySpecializations();
6273 if (auto *VTSD = dyn_cast<VarTemplateSpecializationDecl>(D))
6274 VTSD->getSpecializedTemplate()->LoadLazySpecializations();
6275 if (auto *FD = dyn_cast<FunctionDecl>(D)) {
6276 if (auto *Template = FD->getPrimaryTemplate())
6277 Template->LoadLazySpecializations();
6278 }
Richard Smith053f6c62014-05-16 23:01:30 +00006279}
6280
Richard Smithc2bb8182015-03-24 06:36:48 +00006281CXXCtorInitializer **
6282ASTReader::GetExternalCXXCtorInitializers(uint64_t Offset) {
6283 RecordLocation Loc = getLocalBitOffset(Offset);
6284 BitstreamCursor &Cursor = Loc.F->DeclsCursor;
6285 SavedStreamPosition SavedPosition(Cursor);
6286 Cursor.JumpToBit(Loc.Offset);
6287 ReadingKindTracker ReadingKind(Read_Decl, *this);
6288
6289 RecordData Record;
6290 unsigned Code = Cursor.ReadCode();
6291 unsigned RecCode = Cursor.readRecord(Code, Record);
6292 if (RecCode != DECL_CXX_CTOR_INITIALIZERS) {
6293 Error("malformed AST file: missing C++ ctor initializers");
6294 return nullptr;
6295 }
6296
6297 unsigned Idx = 0;
6298 return ReadCXXCtorInitializers(*Loc.F, Record, Idx);
6299}
6300
Guy Benyei11169dd2012-12-18 14:30:41 +00006301CXXBaseSpecifier *ASTReader::GetExternalCXXBaseSpecifiers(uint64_t Offset) {
6302 RecordLocation Loc = getLocalBitOffset(Offset);
Chris Lattner7fb3bef2013-01-20 00:56:42 +00006303 BitstreamCursor &Cursor = Loc.F->DeclsCursor;
Guy Benyei11169dd2012-12-18 14:30:41 +00006304 SavedStreamPosition SavedPosition(Cursor);
6305 Cursor.JumpToBit(Loc.Offset);
6306 ReadingKindTracker ReadingKind(Read_Decl, *this);
6307 RecordData Record;
6308 unsigned Code = Cursor.ReadCode();
Chris Lattner0e6c9402013-01-20 02:38:54 +00006309 unsigned RecCode = Cursor.readRecord(Code, Record);
Guy Benyei11169dd2012-12-18 14:30:41 +00006310 if (RecCode != DECL_CXX_BASE_SPECIFIERS) {
Richard Smithcd45dbc2014-04-19 03:48:30 +00006311 Error("malformed AST file: missing C++ base specifiers");
Craig Toppera13603a2014-05-22 05:54:18 +00006312 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006313 }
6314
6315 unsigned Idx = 0;
6316 unsigned NumBases = Record[Idx++];
6317 void *Mem = Context.Allocate(sizeof(CXXBaseSpecifier) * NumBases);
6318 CXXBaseSpecifier *Bases = new (Mem) CXXBaseSpecifier [NumBases];
6319 for (unsigned I = 0; I != NumBases; ++I)
6320 Bases[I] = ReadCXXBaseSpecifier(*Loc.F, Record, Idx);
6321 return Bases;
6322}
6323
6324serialization::DeclID
6325ASTReader::getGlobalDeclID(ModuleFile &F, LocalDeclID LocalID) const {
6326 if (LocalID < NUM_PREDEF_DECL_IDS)
6327 return LocalID;
6328
6329 ContinuousRangeMap<uint32_t, int, 2>::iterator I
6330 = F.DeclRemap.find(LocalID - NUM_PREDEF_DECL_IDS);
6331 assert(I != F.DeclRemap.end() && "Invalid index into decl index remap");
6332
6333 return LocalID + I->second;
6334}
6335
6336bool ASTReader::isDeclIDFromModule(serialization::GlobalDeclID ID,
6337 ModuleFile &M) const {
Richard Smithfe620d22015-03-05 23:24:12 +00006338 // Predefined decls aren't from any module.
6339 if (ID < NUM_PREDEF_DECL_IDS)
6340 return false;
6341
Richard Smithbcda1a92015-07-12 23:51:20 +00006342 return ID - NUM_PREDEF_DECL_IDS >= M.BaseDeclID &&
6343 ID - NUM_PREDEF_DECL_IDS < M.BaseDeclID + M.LocalNumDecls;
Guy Benyei11169dd2012-12-18 14:30:41 +00006344}
6345
Douglas Gregor9f782892013-01-21 15:25:38 +00006346ModuleFile *ASTReader::getOwningModuleFile(const Decl *D) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006347 if (!D->isFromASTFile())
Craig Toppera13603a2014-05-22 05:54:18 +00006348 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006349 GlobalDeclMapType::const_iterator I = GlobalDeclMap.find(D->getGlobalID());
6350 assert(I != GlobalDeclMap.end() && "Corrupted global declaration map");
6351 return I->second;
6352}
6353
6354SourceLocation ASTReader::getSourceLocationForDeclID(GlobalDeclID ID) {
6355 if (ID < NUM_PREDEF_DECL_IDS)
6356 return SourceLocation();
Richard Smithcd45dbc2014-04-19 03:48:30 +00006357
Guy Benyei11169dd2012-12-18 14:30:41 +00006358 unsigned Index = ID - NUM_PREDEF_DECL_IDS;
6359
6360 if (Index > DeclsLoaded.size()) {
6361 Error("declaration ID out-of-range for AST file");
6362 return SourceLocation();
6363 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00006364
Guy Benyei11169dd2012-12-18 14:30:41 +00006365 if (Decl *D = DeclsLoaded[Index])
6366 return D->getLocation();
6367
Richard Smithcb34bd32016-03-27 07:28:06 +00006368 SourceLocation Loc;
6369 DeclCursorForID(ID, Loc);
6370 return Loc;
Guy Benyei11169dd2012-12-18 14:30:41 +00006371}
6372
Richard Smithfe620d22015-03-05 23:24:12 +00006373static Decl *getPredefinedDecl(ASTContext &Context, PredefinedDeclIDs ID) {
6374 switch (ID) {
6375 case PREDEF_DECL_NULL_ID:
6376 return nullptr;
6377
6378 case PREDEF_DECL_TRANSLATION_UNIT_ID:
6379 return Context.getTranslationUnitDecl();
6380
6381 case PREDEF_DECL_OBJC_ID_ID:
6382 return Context.getObjCIdDecl();
6383
6384 case PREDEF_DECL_OBJC_SEL_ID:
6385 return Context.getObjCSelDecl();
6386
6387 case PREDEF_DECL_OBJC_CLASS_ID:
6388 return Context.getObjCClassDecl();
6389
6390 case PREDEF_DECL_OBJC_PROTOCOL_ID:
6391 return Context.getObjCProtocolDecl();
6392
6393 case PREDEF_DECL_INT_128_ID:
6394 return Context.getInt128Decl();
6395
6396 case PREDEF_DECL_UNSIGNED_INT_128_ID:
6397 return Context.getUInt128Decl();
6398
6399 case PREDEF_DECL_OBJC_INSTANCETYPE_ID:
6400 return Context.getObjCInstanceTypeDecl();
6401
6402 case PREDEF_DECL_BUILTIN_VA_LIST_ID:
6403 return Context.getBuiltinVaListDecl();
Richard Smithf19e1272015-03-07 00:04:49 +00006404
Richard Smith9b88a4c2015-07-27 05:40:23 +00006405 case PREDEF_DECL_VA_LIST_TAG:
6406 return Context.getVaListTagDecl();
6407
Charles Davisc7d5c942015-09-17 20:55:33 +00006408 case PREDEF_DECL_BUILTIN_MS_VA_LIST_ID:
6409 return Context.getBuiltinMSVaListDecl();
6410
Richard Smithf19e1272015-03-07 00:04:49 +00006411 case PREDEF_DECL_EXTERN_C_CONTEXT_ID:
6412 return Context.getExternCContextDecl();
David Majnemerd9b1a4f2015-11-04 03:40:30 +00006413
6414 case PREDEF_DECL_MAKE_INTEGER_SEQ_ID:
6415 return Context.getMakeIntegerSeqDecl();
Quentin Colombet043406b2016-02-03 22:41:00 +00006416
6417 case PREDEF_DECL_CF_CONSTANT_STRING_ID:
6418 return Context.getCFConstantStringDecl();
Ben Langmuirf5416742016-02-04 00:55:24 +00006419
6420 case PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID:
6421 return Context.getCFConstantStringTagDecl();
Richard Smithfe620d22015-03-05 23:24:12 +00006422 }
Yaron Keren322bdad2015-03-06 07:49:14 +00006423 llvm_unreachable("PredefinedDeclIDs unknown enum value");
Richard Smithfe620d22015-03-05 23:24:12 +00006424}
6425
Richard Smithcd45dbc2014-04-19 03:48:30 +00006426Decl *ASTReader::GetExistingDecl(DeclID ID) {
6427 if (ID < NUM_PREDEF_DECL_IDS) {
Richard Smithfe620d22015-03-05 23:24:12 +00006428 Decl *D = getPredefinedDecl(Context, (PredefinedDeclIDs)ID);
6429 if (D) {
6430 // Track that we have merged the declaration with ID \p ID into the
6431 // pre-existing predefined declaration \p D.
Richard Smith5fc18a92015-07-12 23:43:21 +00006432 auto &Merged = KeyDecls[D->getCanonicalDecl()];
Richard Smithfe620d22015-03-05 23:24:12 +00006433 if (Merged.empty())
6434 Merged.push_back(ID);
Guy Benyei11169dd2012-12-18 14:30:41 +00006435 }
Richard Smithfe620d22015-03-05 23:24:12 +00006436 return D;
Guy Benyei11169dd2012-12-18 14:30:41 +00006437 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00006438
Guy Benyei11169dd2012-12-18 14:30:41 +00006439 unsigned Index = ID - NUM_PREDEF_DECL_IDS;
6440
6441 if (Index >= DeclsLoaded.size()) {
6442 assert(0 && "declaration ID out-of-range for AST file");
6443 Error("declaration ID out-of-range for AST file");
Craig Toppera13603a2014-05-22 05:54:18 +00006444 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00006445 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00006446
6447 return DeclsLoaded[Index];
6448}
6449
6450Decl *ASTReader::GetDecl(DeclID ID) {
6451 if (ID < NUM_PREDEF_DECL_IDS)
6452 return GetExistingDecl(ID);
6453
6454 unsigned Index = ID - NUM_PREDEF_DECL_IDS;
6455
6456 if (Index >= DeclsLoaded.size()) {
6457 assert(0 && "declaration ID out-of-range for AST file");
6458 Error("declaration ID out-of-range for AST file");
Craig Toppera13603a2014-05-22 05:54:18 +00006459 return nullptr;
Richard Smithcd45dbc2014-04-19 03:48:30 +00006460 }
6461
Guy Benyei11169dd2012-12-18 14:30:41 +00006462 if (!DeclsLoaded[Index]) {
6463 ReadDeclRecord(ID);
6464 if (DeserializationListener)
6465 DeserializationListener->DeclRead(ID, DeclsLoaded[Index]);
6466 }
6467
6468 return DeclsLoaded[Index];
6469}
6470
6471DeclID ASTReader::mapGlobalIDToModuleFileGlobalID(ModuleFile &M,
6472 DeclID GlobalID) {
6473 if (GlobalID < NUM_PREDEF_DECL_IDS)
6474 return GlobalID;
6475
6476 GlobalDeclMapType::const_iterator I = GlobalDeclMap.find(GlobalID);
6477 assert(I != GlobalDeclMap.end() && "Corrupted global declaration map");
6478 ModuleFile *Owner = I->second;
6479
6480 llvm::DenseMap<ModuleFile *, serialization::DeclID>::iterator Pos
6481 = M.GlobalToLocalDeclIDs.find(Owner);
6482 if (Pos == M.GlobalToLocalDeclIDs.end())
6483 return 0;
6484
6485 return GlobalID - Owner->BaseDeclID + Pos->second;
6486}
6487
6488serialization::DeclID ASTReader::ReadDeclID(ModuleFile &F,
6489 const RecordData &Record,
6490 unsigned &Idx) {
6491 if (Idx >= Record.size()) {
6492 Error("Corrupted AST file");
6493 return 0;
6494 }
6495
6496 return getGlobalDeclID(F, Record[Idx++]);
6497}
6498
6499/// \brief Resolve the offset of a statement into a statement.
6500///
6501/// This operation will read a new statement from the external
6502/// source each time it is called, and is meant to be used via a
6503/// LazyOffsetPtr (which is used by Decls for the body of functions, etc).
6504Stmt *ASTReader::GetExternalDeclStmt(uint64_t Offset) {
6505 // Switch case IDs are per Decl.
6506 ClearSwitchCaseIDs();
6507
6508 // Offset here is a global offset across the entire chain.
6509 RecordLocation Loc = getLocalBitOffset(Offset);
6510 Loc.F->DeclsCursor.JumpToBit(Loc.Offset);
6511 return ReadStmtFromStream(*Loc.F);
6512}
6513
Richard Smith3cb15722015-08-05 22:41:45 +00006514void ASTReader::FindExternalLexicalDecls(
6515 const DeclContext *DC, llvm::function_ref<bool(Decl::Kind)> IsKindWeWant,
6516 SmallVectorImpl<Decl *> &Decls) {
Richard Smith82f8fcd2015-08-06 22:07:25 +00006517 bool PredefsVisited[NUM_PREDEF_DECL_IDS] = {};
6518
Richard Smith9ccdd932015-08-06 22:14:12 +00006519 auto Visit = [&] (ModuleFile *M, LexicalContents LexicalDecls) {
Richard Smith82f8fcd2015-08-06 22:07:25 +00006520 assert(LexicalDecls.size() % 2 == 0 && "expected an even number of entries");
6521 for (int I = 0, N = LexicalDecls.size(); I != N; I += 2) {
6522 auto K = (Decl::Kind)+LexicalDecls[I];
6523 if (!IsKindWeWant(K))
6524 continue;
6525
6526 auto ID = (serialization::DeclID)+LexicalDecls[I + 1];
6527
6528 // Don't add predefined declarations to the lexical context more
6529 // than once.
6530 if (ID < NUM_PREDEF_DECL_IDS) {
6531 if (PredefsVisited[ID])
6532 continue;
6533
6534 PredefsVisited[ID] = true;
6535 }
6536
6537 if (Decl *D = GetLocalDecl(*M, ID)) {
Richard Smith2317a3e2015-08-11 21:21:20 +00006538 assert(D->getKind() == K && "wrong kind for lexical decl");
Richard Smith82f8fcd2015-08-06 22:07:25 +00006539 if (!DC->isDeclInLexicalTraversal(D))
6540 Decls.push_back(D);
6541 }
6542 }
6543 };
6544
6545 if (isa<TranslationUnitDecl>(DC)) {
6546 for (auto Lexical : TULexicalDecls)
6547 Visit(Lexical.first, Lexical.second);
6548 } else {
6549 auto I = LexicalDecls.find(DC);
6550 if (I != LexicalDecls.end())
Richard Smith9c9173d2015-08-11 22:00:24 +00006551 Visit(I->second.first, I->second.second);
Richard Smith82f8fcd2015-08-06 22:07:25 +00006552 }
6553
Guy Benyei11169dd2012-12-18 14:30:41 +00006554 ++NumLexicalDeclContextsRead;
Guy Benyei11169dd2012-12-18 14:30:41 +00006555}
6556
6557namespace {
6558
6559class DeclIDComp {
6560 ASTReader &Reader;
6561 ModuleFile &Mod;
6562
6563public:
6564 DeclIDComp(ASTReader &Reader, ModuleFile &M) : Reader(Reader), Mod(M) {}
6565
6566 bool operator()(LocalDeclID L, LocalDeclID R) const {
6567 SourceLocation LHS = getLocation(L);
6568 SourceLocation RHS = getLocation(R);
6569 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
6570 }
6571
6572 bool operator()(SourceLocation LHS, LocalDeclID R) const {
6573 SourceLocation RHS = getLocation(R);
6574 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
6575 }
6576
6577 bool operator()(LocalDeclID L, SourceLocation RHS) const {
6578 SourceLocation LHS = getLocation(L);
6579 return Reader.getSourceManager().isBeforeInTranslationUnit(LHS, RHS);
6580 }
6581
6582 SourceLocation getLocation(LocalDeclID ID) const {
6583 return Reader.getSourceManager().getFileLoc(
6584 Reader.getSourceLocationForDeclID(Reader.getGlobalDeclID(Mod, ID)));
6585 }
6586};
6587
Alexander Kornienkoab9db512015-06-22 23:07:51 +00006588}
Guy Benyei11169dd2012-12-18 14:30:41 +00006589
6590void ASTReader::FindFileRegionDecls(FileID File,
6591 unsigned Offset, unsigned Length,
6592 SmallVectorImpl<Decl *> &Decls) {
6593 SourceManager &SM = getSourceManager();
6594
6595 llvm::DenseMap<FileID, FileDeclsInfo>::iterator I = FileDeclIDs.find(File);
6596 if (I == FileDeclIDs.end())
6597 return;
6598
6599 FileDeclsInfo &DInfo = I->second;
6600 if (DInfo.Decls.empty())
6601 return;
6602
6603 SourceLocation
6604 BeginLoc = SM.getLocForStartOfFile(File).getLocWithOffset(Offset);
6605 SourceLocation EndLoc = BeginLoc.getLocWithOffset(Length);
6606
6607 DeclIDComp DIDComp(*this, *DInfo.Mod);
6608 ArrayRef<serialization::LocalDeclID>::iterator
6609 BeginIt = std::lower_bound(DInfo.Decls.begin(), DInfo.Decls.end(),
6610 BeginLoc, DIDComp);
6611 if (BeginIt != DInfo.Decls.begin())
6612 --BeginIt;
6613
6614 // If we are pointing at a top-level decl inside an objc container, we need
6615 // to backtrack until we find it otherwise we will fail to report that the
6616 // region overlaps with an objc container.
6617 while (BeginIt != DInfo.Decls.begin() &&
6618 GetDecl(getGlobalDeclID(*DInfo.Mod, *BeginIt))
6619 ->isTopLevelDeclInObjCContainer())
6620 --BeginIt;
6621
6622 ArrayRef<serialization::LocalDeclID>::iterator
6623 EndIt = std::upper_bound(DInfo.Decls.begin(), DInfo.Decls.end(),
6624 EndLoc, DIDComp);
6625 if (EndIt != DInfo.Decls.end())
6626 ++EndIt;
6627
6628 for (ArrayRef<serialization::LocalDeclID>::iterator
6629 DIt = BeginIt; DIt != EndIt; ++DIt)
6630 Decls.push_back(GetDecl(getGlobalDeclID(*DInfo.Mod, *DIt)));
6631}
6632
Richard Smith9ce12e32013-02-07 03:30:24 +00006633bool
Guy Benyei11169dd2012-12-18 14:30:41 +00006634ASTReader::FindExternalVisibleDeclsByName(const DeclContext *DC,
6635 DeclarationName Name) {
Richard Smithd88a7f12015-09-01 20:35:42 +00006636 assert(DC->hasExternalVisibleStorage() && DC == DC->getPrimaryContext() &&
Guy Benyei11169dd2012-12-18 14:30:41 +00006637 "DeclContext has no visible decls in storage");
6638 if (!Name)
Richard Smith9ce12e32013-02-07 03:30:24 +00006639 return false;
Guy Benyei11169dd2012-12-18 14:30:41 +00006640
Richard Smithd88a7f12015-09-01 20:35:42 +00006641 auto It = Lookups.find(DC);
6642 if (It == Lookups.end())
6643 return false;
6644
Richard Smith8c913ec2014-08-14 02:21:01 +00006645 Deserializing LookupResults(this);
6646
Richard Smithd88a7f12015-09-01 20:35:42 +00006647 // Load the list of declarations.
Guy Benyei11169dd2012-12-18 14:30:41 +00006648 SmallVector<NamedDecl *, 64> Decls;
Richard Smithd88a7f12015-09-01 20:35:42 +00006649 for (DeclID ID : It->second.Table.find(Name)) {
6650 NamedDecl *ND = cast<NamedDecl>(GetDecl(ID));
6651 if (ND->getDeclName() == Name)
6652 Decls.push_back(ND);
6653 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00006654
Guy Benyei11169dd2012-12-18 14:30:41 +00006655 ++NumVisibleDeclContextsRead;
6656 SetExternalVisibleDeclsForName(DC, Name, Decls);
Richard Smith9ce12e32013-02-07 03:30:24 +00006657 return !Decls.empty();
Guy Benyei11169dd2012-12-18 14:30:41 +00006658}
6659
Guy Benyei11169dd2012-12-18 14:30:41 +00006660void ASTReader::completeVisibleDeclsMap(const DeclContext *DC) {
6661 if (!DC->hasExternalVisibleStorage())
6662 return;
Richard Smithd88a7f12015-09-01 20:35:42 +00006663
6664 auto It = Lookups.find(DC);
6665 assert(It != Lookups.end() &&
6666 "have external visible storage but no lookup tables");
6667
Craig Topper79be4cd2013-07-05 04:33:53 +00006668 DeclsMap Decls;
Guy Benyei11169dd2012-12-18 14:30:41 +00006669
Richard Smithd88a7f12015-09-01 20:35:42 +00006670 for (DeclID ID : It->second.Table.findAll()) {
6671 NamedDecl *ND = cast<NamedDecl>(GetDecl(ID));
6672 Decls[ND->getDeclName()].push_back(ND);
Guy Benyei11169dd2012-12-18 14:30:41 +00006673 }
6674
Guy Benyei11169dd2012-12-18 14:30:41 +00006675 ++NumVisibleDeclContextsRead;
6676
Craig Topper79be4cd2013-07-05 04:33:53 +00006677 for (DeclsMap::iterator I = Decls.begin(), E = Decls.end(); I != E; ++I) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006678 SetExternalVisibleDeclsForName(DC, I->first, I->second);
6679 }
6680 const_cast<DeclContext *>(DC)->setHasExternalVisibleStorage(false);
6681}
6682
Richard Smithd88a7f12015-09-01 20:35:42 +00006683const serialization::reader::DeclContextLookupTable *
6684ASTReader::getLoadedLookupTables(DeclContext *Primary) const {
6685 auto I = Lookups.find(Primary);
6686 return I == Lookups.end() ? nullptr : &I->second;
6687}
6688
Guy Benyei11169dd2012-12-18 14:30:41 +00006689/// \brief Under non-PCH compilation the consumer receives the objc methods
6690/// before receiving the implementation, and codegen depends on this.
6691/// We simulate this by deserializing and passing to consumer the methods of the
6692/// implementation before passing the deserialized implementation decl.
6693static void PassObjCImplDeclToConsumer(ObjCImplDecl *ImplD,
6694 ASTConsumer *Consumer) {
6695 assert(ImplD && Consumer);
6696
Aaron Ballmanaff18c02014-03-13 19:03:34 +00006697 for (auto *I : ImplD->methods())
6698 Consumer->HandleInterestingDecl(DeclGroupRef(I));
Guy Benyei11169dd2012-12-18 14:30:41 +00006699
6700 Consumer->HandleInterestingDecl(DeclGroupRef(ImplD));
6701}
6702
6703void ASTReader::PassInterestingDeclsToConsumer() {
6704 assert(Consumer);
Richard Smith04d05b52014-03-23 00:27:18 +00006705
6706 if (PassingDeclsToConsumer)
6707 return;
6708
6709 // Guard variable to avoid recursively redoing the process of passing
6710 // decls to consumer.
6711 SaveAndRestore<bool> GuardPassingDeclsToConsumer(PassingDeclsToConsumer,
6712 true);
6713
Richard Smith9e2341d2015-03-23 03:25:59 +00006714 // Ensure that we've loaded all potentially-interesting declarations
6715 // that need to be eagerly loaded.
6716 for (auto ID : EagerlyDeserializedDecls)
6717 GetDecl(ID);
6718 EagerlyDeserializedDecls.clear();
6719
Guy Benyei11169dd2012-12-18 14:30:41 +00006720 while (!InterestingDecls.empty()) {
6721 Decl *D = InterestingDecls.front();
6722 InterestingDecls.pop_front();
6723
6724 PassInterestingDeclToConsumer(D);
6725 }
6726}
6727
6728void ASTReader::PassInterestingDeclToConsumer(Decl *D) {
6729 if (ObjCImplDecl *ImplD = dyn_cast<ObjCImplDecl>(D))
6730 PassObjCImplDeclToConsumer(ImplD, Consumer);
6731 else
6732 Consumer->HandleInterestingDecl(DeclGroupRef(D));
6733}
6734
6735void ASTReader::StartTranslationUnit(ASTConsumer *Consumer) {
6736 this->Consumer = Consumer;
6737
Richard Smith9e2341d2015-03-23 03:25:59 +00006738 if (Consumer)
6739 PassInterestingDeclsToConsumer();
Richard Smith7f330cd2015-03-18 01:42:29 +00006740
6741 if (DeserializationListener)
6742 DeserializationListener->ReaderInitialized(this);
Guy Benyei11169dd2012-12-18 14:30:41 +00006743}
6744
6745void ASTReader::PrintStats() {
6746 std::fprintf(stderr, "*** AST File Statistics:\n");
6747
6748 unsigned NumTypesLoaded
6749 = TypesLoaded.size() - std::count(TypesLoaded.begin(), TypesLoaded.end(),
6750 QualType());
6751 unsigned NumDeclsLoaded
6752 = DeclsLoaded.size() - std::count(DeclsLoaded.begin(), DeclsLoaded.end(),
Craig Toppera13603a2014-05-22 05:54:18 +00006753 (Decl *)nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00006754 unsigned NumIdentifiersLoaded
6755 = IdentifiersLoaded.size() - std::count(IdentifiersLoaded.begin(),
6756 IdentifiersLoaded.end(),
Craig Toppera13603a2014-05-22 05:54:18 +00006757 (IdentifierInfo *)nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00006758 unsigned NumMacrosLoaded
6759 = MacrosLoaded.size() - std::count(MacrosLoaded.begin(),
6760 MacrosLoaded.end(),
Craig Toppera13603a2014-05-22 05:54:18 +00006761 (MacroInfo *)nullptr);
Guy Benyei11169dd2012-12-18 14:30:41 +00006762 unsigned NumSelectorsLoaded
6763 = SelectorsLoaded.size() - std::count(SelectorsLoaded.begin(),
6764 SelectorsLoaded.end(),
6765 Selector());
6766
6767 if (unsigned TotalNumSLocEntries = getTotalNumSLocs())
6768 std::fprintf(stderr, " %u/%u source location entries read (%f%%)\n",
6769 NumSLocEntriesRead, TotalNumSLocEntries,
6770 ((float)NumSLocEntriesRead/TotalNumSLocEntries * 100));
6771 if (!TypesLoaded.empty())
6772 std::fprintf(stderr, " %u/%u types read (%f%%)\n",
6773 NumTypesLoaded, (unsigned)TypesLoaded.size(),
6774 ((float)NumTypesLoaded/TypesLoaded.size() * 100));
6775 if (!DeclsLoaded.empty())
6776 std::fprintf(stderr, " %u/%u declarations read (%f%%)\n",
6777 NumDeclsLoaded, (unsigned)DeclsLoaded.size(),
6778 ((float)NumDeclsLoaded/DeclsLoaded.size() * 100));
6779 if (!IdentifiersLoaded.empty())
6780 std::fprintf(stderr, " %u/%u identifiers read (%f%%)\n",
6781 NumIdentifiersLoaded, (unsigned)IdentifiersLoaded.size(),
6782 ((float)NumIdentifiersLoaded/IdentifiersLoaded.size() * 100));
6783 if (!MacrosLoaded.empty())
6784 std::fprintf(stderr, " %u/%u macros read (%f%%)\n",
6785 NumMacrosLoaded, (unsigned)MacrosLoaded.size(),
6786 ((float)NumMacrosLoaded/MacrosLoaded.size() * 100));
6787 if (!SelectorsLoaded.empty())
6788 std::fprintf(stderr, " %u/%u selectors read (%f%%)\n",
6789 NumSelectorsLoaded, (unsigned)SelectorsLoaded.size(),
6790 ((float)NumSelectorsLoaded/SelectorsLoaded.size() * 100));
6791 if (TotalNumStatements)
6792 std::fprintf(stderr, " %u/%u statements read (%f%%)\n",
6793 NumStatementsRead, TotalNumStatements,
6794 ((float)NumStatementsRead/TotalNumStatements * 100));
6795 if (TotalNumMacros)
6796 std::fprintf(stderr, " %u/%u macros read (%f%%)\n",
6797 NumMacrosRead, TotalNumMacros,
6798 ((float)NumMacrosRead/TotalNumMacros * 100));
6799 if (TotalLexicalDeclContexts)
6800 std::fprintf(stderr, " %u/%u lexical declcontexts read (%f%%)\n",
6801 NumLexicalDeclContextsRead, TotalLexicalDeclContexts,
6802 ((float)NumLexicalDeclContextsRead/TotalLexicalDeclContexts
6803 * 100));
6804 if (TotalVisibleDeclContexts)
6805 std::fprintf(stderr, " %u/%u visible declcontexts read (%f%%)\n",
6806 NumVisibleDeclContextsRead, TotalVisibleDeclContexts,
6807 ((float)NumVisibleDeclContextsRead/TotalVisibleDeclContexts
6808 * 100));
6809 if (TotalNumMethodPoolEntries) {
6810 std::fprintf(stderr, " %u/%u method pool entries read (%f%%)\n",
6811 NumMethodPoolEntriesRead, TotalNumMethodPoolEntries,
6812 ((float)NumMethodPoolEntriesRead/TotalNumMethodPoolEntries
6813 * 100));
Guy Benyei11169dd2012-12-18 14:30:41 +00006814 }
Douglas Gregorad2f7a52013-01-28 17:54:36 +00006815 if (NumMethodPoolLookups) {
6816 std::fprintf(stderr, " %u/%u method pool lookups succeeded (%f%%)\n",
6817 NumMethodPoolHits, NumMethodPoolLookups,
6818 ((float)NumMethodPoolHits/NumMethodPoolLookups * 100.0));
6819 }
6820 if (NumMethodPoolTableLookups) {
6821 std::fprintf(stderr, " %u/%u method pool table lookups succeeded (%f%%)\n",
6822 NumMethodPoolTableHits, NumMethodPoolTableLookups,
6823 ((float)NumMethodPoolTableHits/NumMethodPoolTableLookups
6824 * 100.0));
6825 }
6826
Douglas Gregor00a50f72013-01-25 00:38:33 +00006827 if (NumIdentifierLookupHits) {
6828 std::fprintf(stderr,
6829 " %u / %u identifier table lookups succeeded (%f%%)\n",
6830 NumIdentifierLookupHits, NumIdentifierLookups,
6831 (double)NumIdentifierLookupHits*100.0/NumIdentifierLookups);
6832 }
6833
Douglas Gregore060e572013-01-25 01:03:03 +00006834 if (GlobalIndex) {
6835 std::fprintf(stderr, "\n");
6836 GlobalIndex->printStats();
6837 }
6838
Guy Benyei11169dd2012-12-18 14:30:41 +00006839 std::fprintf(stderr, "\n");
6840 dump();
6841 std::fprintf(stderr, "\n");
6842}
6843
6844template<typename Key, typename ModuleFile, unsigned InitialCapacity>
6845static void
6846dumpModuleIDMap(StringRef Name,
6847 const ContinuousRangeMap<Key, ModuleFile *,
6848 InitialCapacity> &Map) {
6849 if (Map.begin() == Map.end())
6850 return;
6851
6852 typedef ContinuousRangeMap<Key, ModuleFile *, InitialCapacity> MapType;
6853 llvm::errs() << Name << ":\n";
6854 for (typename MapType::const_iterator I = Map.begin(), IEnd = Map.end();
6855 I != IEnd; ++I) {
6856 llvm::errs() << " " << I->first << " -> " << I->second->FileName
6857 << "\n";
6858 }
6859}
6860
Yaron Kerencdae9412016-01-29 19:38:18 +00006861LLVM_DUMP_METHOD void ASTReader::dump() {
Guy Benyei11169dd2012-12-18 14:30:41 +00006862 llvm::errs() << "*** PCH/ModuleFile Remappings:\n";
6863 dumpModuleIDMap("Global bit offset map", GlobalBitOffsetsMap);
6864 dumpModuleIDMap("Global source location entry map", GlobalSLocEntryMap);
6865 dumpModuleIDMap("Global type map", GlobalTypeMap);
6866 dumpModuleIDMap("Global declaration map", GlobalDeclMap);
6867 dumpModuleIDMap("Global identifier map", GlobalIdentifierMap);
6868 dumpModuleIDMap("Global macro map", GlobalMacroMap);
6869 dumpModuleIDMap("Global submodule map", GlobalSubmoduleMap);
6870 dumpModuleIDMap("Global selector map", GlobalSelectorMap);
6871 dumpModuleIDMap("Global preprocessed entity map",
6872 GlobalPreprocessedEntityMap);
6873
6874 llvm::errs() << "\n*** PCH/Modules Loaded:";
6875 for (ModuleManager::ModuleConstIterator M = ModuleMgr.begin(),
6876 MEnd = ModuleMgr.end();
6877 M != MEnd; ++M)
6878 (*M)->dump();
6879}
6880
6881/// Return the amount of memory used by memory buffers, breaking down
6882/// by heap-backed versus mmap'ed memory.
6883void ASTReader::getMemoryBufferSizes(MemoryBufferSizes &sizes) const {
6884 for (ModuleConstIterator I = ModuleMgr.begin(),
6885 E = ModuleMgr.end(); I != E; ++I) {
6886 if (llvm::MemoryBuffer *buf = (*I)->Buffer.get()) {
6887 size_t bytes = buf->getBufferSize();
6888 switch (buf->getBufferKind()) {
6889 case llvm::MemoryBuffer::MemoryBuffer_Malloc:
6890 sizes.malloc_bytes += bytes;
6891 break;
6892 case llvm::MemoryBuffer::MemoryBuffer_MMap:
6893 sizes.mmap_bytes += bytes;
6894 break;
6895 }
6896 }
6897 }
6898}
6899
6900void ASTReader::InitializeSema(Sema &S) {
6901 SemaObj = &S;
6902 S.addExternalSource(this);
6903
6904 // Makes sure any declarations that were deserialized "too early"
6905 // still get added to the identifier's declaration chains.
Ben Langmuir5418f402014-09-10 21:29:41 +00006906 for (uint64_t ID : PreloadedDeclIDs) {
6907 NamedDecl *D = cast<NamedDecl>(GetDecl(ID));
6908 pushExternalDeclIntoScope(D, D->getDeclName());
Guy Benyei11169dd2012-12-18 14:30:41 +00006909 }
Ben Langmuir5418f402014-09-10 21:29:41 +00006910 PreloadedDeclIDs.clear();
Guy Benyei11169dd2012-12-18 14:30:41 +00006911
Richard Smith3d8e97e2013-10-18 06:54:39 +00006912 // FIXME: What happens if these are changed by a module import?
Guy Benyei11169dd2012-12-18 14:30:41 +00006913 if (!FPPragmaOptions.empty()) {
6914 assert(FPPragmaOptions.size() == 1 && "Wrong number of FP_PRAGMA_OPTIONS");
6915 SemaObj->FPFeatures.fp_contract = FPPragmaOptions[0];
6916 }
6917
Richard Smith3d8e97e2013-10-18 06:54:39 +00006918 // FIXME: What happens if these are changed by a module import?
Guy Benyei11169dd2012-12-18 14:30:41 +00006919 if (!OpenCLExtensions.empty()) {
6920 unsigned I = 0;
6921#define OPENCLEXT(nm) SemaObj->OpenCLFeatures.nm = OpenCLExtensions[I++];
6922#include "clang/Basic/OpenCLExtensions.def"
6923
6924 assert(OpenCLExtensions.size() == I && "Wrong number of OPENCL_EXTENSIONS");
6925 }
Richard Smith3d8e97e2013-10-18 06:54:39 +00006926
6927 UpdateSema();
6928}
6929
6930void ASTReader::UpdateSema() {
6931 assert(SemaObj && "no Sema to update");
6932
6933 // Load the offsets of the declarations that Sema references.
6934 // They will be lazily deserialized when needed.
6935 if (!SemaDeclRefs.empty()) {
6936 assert(SemaDeclRefs.size() % 2 == 0);
6937 for (unsigned I = 0; I != SemaDeclRefs.size(); I += 2) {
6938 if (!SemaObj->StdNamespace)
6939 SemaObj->StdNamespace = SemaDeclRefs[I];
6940 if (!SemaObj->StdBadAlloc)
6941 SemaObj->StdBadAlloc = SemaDeclRefs[I+1];
6942 }
6943 SemaDeclRefs.clear();
6944 }
Dario Domizioli13a0a382014-05-23 12:13:25 +00006945
Nico Weber779355f2016-03-02 23:22:00 +00006946 // Update the state of pragmas. Use the same API as if we had encountered the
6947 // pragma in the source.
Dario Domizioli13a0a382014-05-23 12:13:25 +00006948 if(OptimizeOffPragmaLocation.isValid())
6949 SemaObj->ActOnPragmaOptimize(/* IsOn = */ false, OptimizeOffPragmaLocation);
Nico Weber779355f2016-03-02 23:22:00 +00006950 if (PragmaMSStructState != -1)
6951 SemaObj->ActOnPragmaMSStruct((PragmaMSStructKind)PragmaMSStructState);
Nico Weber42932312016-03-03 00:17:35 +00006952 if (PointersToMembersPragmaLocation.isValid()) {
6953 SemaObj->ActOnPragmaMSPointersToMembers(
6954 (LangOptions::PragmaMSPointersToMembersKind)
6955 PragmaMSPointersToMembersState,
6956 PointersToMembersPragmaLocation);
6957 }
Guy Benyei11169dd2012-12-18 14:30:41 +00006958}
6959
Richard Smitha8d5b6a2015-07-17 19:51:03 +00006960IdentifierInfo *ASTReader::get(StringRef Name) {
Guy Benyei11169dd2012-12-18 14:30:41 +00006961 // Note that we are loading an identifier.
6962 Deserializing AnIdentifier(this);
Douglas Gregore060e572013-01-25 01:03:03 +00006963
Douglas Gregor7211ac12013-01-25 23:32:03 +00006964 IdentifierLookupVisitor Visitor(Name, /*PriorGeneration=*/0,
Douglas Gregor00a50f72013-01-25 00:38:33 +00006965 NumIdentifierLookups,
6966 NumIdentifierLookupHits);
Richard Smith33e0f7e2015-07-22 02:08:40 +00006967
6968 // We don't need to do identifier table lookups in C++ modules (we preload
6969 // all interesting declarations, and don't need to use the scope for name
6970 // lookups). Perform the lookup in PCH files, though, since we don't build
6971 // a complete initial identifier table if we're carrying on from a PCH.
6972 if (Context.getLangOpts().CPlusPlus) {
6973 for (auto F : ModuleMgr.pch_modules())
Benjamin Kramer9a9efba2015-07-25 12:14:04 +00006974 if (Visitor(*F))
Richard Smith33e0f7e2015-07-22 02:08:40 +00006975 break;
6976 } else {
6977 // If there is a global index, look there first to determine which modules
6978 // provably do not have any results for this identifier.
6979 GlobalModuleIndex::HitSet Hits;
6980 GlobalModuleIndex::HitSet *HitsPtr = nullptr;
6981 if (!loadGlobalIndex()) {
6982 if (GlobalIndex->lookupIdentifier(Name, Hits)) {
6983 HitsPtr = &Hits;
6984 }
6985 }
6986
Benjamin Kramer9a9efba2015-07-25 12:14:04 +00006987 ModuleMgr.visit(Visitor, HitsPtr);
Richard Smith33e0f7e2015-07-22 02:08:40 +00006988 }
6989
Guy Benyei11169dd2012-12-18 14:30:41 +00006990 IdentifierInfo *II = Visitor.getIdentifierInfo();
6991 markIdentifierUpToDate(II);
6992 return II;
6993}
6994
6995namespace clang {
6996 /// \brief An identifier-lookup iterator that enumerates all of the
6997 /// identifiers stored within a set of AST files.
6998 class ASTIdentifierIterator : public IdentifierIterator {
6999 /// \brief The AST reader whose identifiers are being enumerated.
7000 const ASTReader &Reader;
7001
7002 /// \brief The current index into the chain of AST files stored in
7003 /// the AST reader.
7004 unsigned Index;
7005
7006 /// \brief The current position within the identifier lookup table
7007 /// of the current AST file.
7008 ASTIdentifierLookupTable::key_iterator Current;
7009
7010 /// \brief The end position within the identifier lookup table of
7011 /// the current AST file.
7012 ASTIdentifierLookupTable::key_iterator End;
7013
7014 public:
7015 explicit ASTIdentifierIterator(const ASTReader &Reader);
7016
Craig Topper3e89dfe2014-03-13 02:13:41 +00007017 StringRef Next() override;
Guy Benyei11169dd2012-12-18 14:30:41 +00007018 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00007019}
Guy Benyei11169dd2012-12-18 14:30:41 +00007020
7021ASTIdentifierIterator::ASTIdentifierIterator(const ASTReader &Reader)
7022 : Reader(Reader), Index(Reader.ModuleMgr.size() - 1) {
7023 ASTIdentifierLookupTable *IdTable
7024 = (ASTIdentifierLookupTable *)Reader.ModuleMgr[Index].IdentifierLookupTable;
7025 Current = IdTable->key_begin();
7026 End = IdTable->key_end();
7027}
7028
7029StringRef ASTIdentifierIterator::Next() {
7030 while (Current == End) {
7031 // If we have exhausted all of our AST files, we're done.
7032 if (Index == 0)
7033 return StringRef();
7034
7035 --Index;
7036 ASTIdentifierLookupTable *IdTable
7037 = (ASTIdentifierLookupTable *)Reader.ModuleMgr[Index].
7038 IdentifierLookupTable;
7039 Current = IdTable->key_begin();
7040 End = IdTable->key_end();
7041 }
7042
7043 // We have any identifiers remaining in the current AST file; return
7044 // the next one.
Douglas Gregorbfd73d72013-01-23 18:53:14 +00007045 StringRef Result = *Current;
Guy Benyei11169dd2012-12-18 14:30:41 +00007046 ++Current;
Douglas Gregorbfd73d72013-01-23 18:53:14 +00007047 return Result;
Guy Benyei11169dd2012-12-18 14:30:41 +00007048}
7049
Argyrios Kyrtzidis9aca3c62013-04-17 22:10:55 +00007050IdentifierIterator *ASTReader::getIdentifiers() {
7051 if (!loadGlobalIndex())
7052 return GlobalIndex->createIdentifierIterator();
7053
Guy Benyei11169dd2012-12-18 14:30:41 +00007054 return new ASTIdentifierIterator(*this);
7055}
7056
7057namespace clang { namespace serialization {
7058 class ReadMethodPoolVisitor {
7059 ASTReader &Reader;
7060 Selector Sel;
7061 unsigned PriorGeneration;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00007062 unsigned InstanceBits;
7063 unsigned FactoryBits;
Nico Weberff4b35e2014-12-27 22:14:15 +00007064 bool InstanceHasMoreThanOneDecl;
7065 bool FactoryHasMoreThanOneDecl;
Dmitri Gribenkof8579502013-01-12 19:30:44 +00007066 SmallVector<ObjCMethodDecl *, 4> InstanceMethods;
7067 SmallVector<ObjCMethodDecl *, 4> FactoryMethods;
Guy Benyei11169dd2012-12-18 14:30:41 +00007068
7069 public:
Nico Weber2e0c8f72014-12-27 03:58:08 +00007070 ReadMethodPoolVisitor(ASTReader &Reader, Selector Sel,
Guy Benyei11169dd2012-12-18 14:30:41 +00007071 unsigned PriorGeneration)
Nico Weber2e0c8f72014-12-27 03:58:08 +00007072 : Reader(Reader), Sel(Sel), PriorGeneration(PriorGeneration),
Nico Weberff4b35e2014-12-27 22:14:15 +00007073 InstanceBits(0), FactoryBits(0), InstanceHasMoreThanOneDecl(false),
7074 FactoryHasMoreThanOneDecl(false) {}
Nico Weber2e0c8f72014-12-27 03:58:08 +00007075
Benjamin Kramer9a9efba2015-07-25 12:14:04 +00007076 bool operator()(ModuleFile &M) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007077 if (!M.SelectorLookupTable)
7078 return false;
7079
7080 // If we've already searched this module file, skip it now.
Richard Smithbdf2d932015-07-30 03:37:16 +00007081 if (M.Generation <= PriorGeneration)
Guy Benyei11169dd2012-12-18 14:30:41 +00007082 return true;
7083
Richard Smithbdf2d932015-07-30 03:37:16 +00007084 ++Reader.NumMethodPoolTableLookups;
Guy Benyei11169dd2012-12-18 14:30:41 +00007085 ASTSelectorLookupTable *PoolTable
7086 = (ASTSelectorLookupTable*)M.SelectorLookupTable;
Richard Smithbdf2d932015-07-30 03:37:16 +00007087 ASTSelectorLookupTable::iterator Pos = PoolTable->find(Sel);
Guy Benyei11169dd2012-12-18 14:30:41 +00007088 if (Pos == PoolTable->end())
7089 return false;
Douglas Gregorad2f7a52013-01-28 17:54:36 +00007090
Richard Smithbdf2d932015-07-30 03:37:16 +00007091 ++Reader.NumMethodPoolTableHits;
7092 ++Reader.NumSelectorsRead;
Guy Benyei11169dd2012-12-18 14:30:41 +00007093 // FIXME: Not quite happy with the statistics here. We probably should
7094 // disable this tracking when called via LoadSelector.
7095 // Also, should entries without methods count as misses?
Richard Smithbdf2d932015-07-30 03:37:16 +00007096 ++Reader.NumMethodPoolEntriesRead;
Guy Benyei11169dd2012-12-18 14:30:41 +00007097 ASTSelectorLookupTrait::data_type Data = *Pos;
Richard Smithbdf2d932015-07-30 03:37:16 +00007098 if (Reader.DeserializationListener)
7099 Reader.DeserializationListener->SelectorRead(Data.ID, Sel);
Benjamin Kramer9a9efba2015-07-25 12:14:04 +00007100
Richard Smithbdf2d932015-07-30 03:37:16 +00007101 InstanceMethods.append(Data.Instance.begin(), Data.Instance.end());
7102 FactoryMethods.append(Data.Factory.begin(), Data.Factory.end());
7103 InstanceBits = Data.InstanceBits;
7104 FactoryBits = Data.FactoryBits;
7105 InstanceHasMoreThanOneDecl = Data.InstanceHasMoreThanOneDecl;
7106 FactoryHasMoreThanOneDecl = Data.FactoryHasMoreThanOneDecl;
Guy Benyei11169dd2012-12-18 14:30:41 +00007107 return true;
7108 }
7109
7110 /// \brief Retrieve the instance methods found by this visitor.
7111 ArrayRef<ObjCMethodDecl *> getInstanceMethods() const {
7112 return InstanceMethods;
7113 }
7114
7115 /// \brief Retrieve the instance methods found by this visitor.
7116 ArrayRef<ObjCMethodDecl *> getFactoryMethods() const {
7117 return FactoryMethods;
7118 }
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00007119
7120 unsigned getInstanceBits() const { return InstanceBits; }
7121 unsigned getFactoryBits() const { return FactoryBits; }
Nico Weberff4b35e2014-12-27 22:14:15 +00007122 bool instanceHasMoreThanOneDecl() const {
7123 return InstanceHasMoreThanOneDecl;
7124 }
7125 bool factoryHasMoreThanOneDecl() const { return FactoryHasMoreThanOneDecl; }
Guy Benyei11169dd2012-12-18 14:30:41 +00007126 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +00007127} } // end namespace clang::serialization
Guy Benyei11169dd2012-12-18 14:30:41 +00007128
7129/// \brief Add the given set of methods to the method list.
7130static void addMethodsToPool(Sema &S, ArrayRef<ObjCMethodDecl *> Methods,
7131 ObjCMethodList &List) {
7132 for (unsigned I = 0, N = Methods.size(); I != N; ++I) {
7133 S.addMethodToGlobalList(&List, Methods[I]);
7134 }
7135}
7136
7137void ASTReader::ReadMethodPool(Selector Sel) {
7138 // Get the selector generation and update it to the current generation.
7139 unsigned &Generation = SelectorGeneration[Sel];
7140 unsigned PriorGeneration = Generation;
Richard Smith053f6c62014-05-16 23:01:30 +00007141 Generation = getGeneration();
Guy Benyei11169dd2012-12-18 14:30:41 +00007142
7143 // Search for methods defined with this selector.
Douglas Gregorad2f7a52013-01-28 17:54:36 +00007144 ++NumMethodPoolLookups;
Guy Benyei11169dd2012-12-18 14:30:41 +00007145 ReadMethodPoolVisitor Visitor(*this, Sel, PriorGeneration);
Benjamin Kramer9a9efba2015-07-25 12:14:04 +00007146 ModuleMgr.visit(Visitor);
7147
Guy Benyei11169dd2012-12-18 14:30:41 +00007148 if (Visitor.getInstanceMethods().empty() &&
Douglas Gregorad2f7a52013-01-28 17:54:36 +00007149 Visitor.getFactoryMethods().empty())
Guy Benyei11169dd2012-12-18 14:30:41 +00007150 return;
Douglas Gregorad2f7a52013-01-28 17:54:36 +00007151
7152 ++NumMethodPoolHits;
7153
Guy Benyei11169dd2012-12-18 14:30:41 +00007154 if (!getSema())
7155 return;
7156
7157 Sema &S = *getSema();
7158 Sema::GlobalMethodPool::iterator Pos
7159 = S.MethodPool.insert(std::make_pair(Sel, Sema::GlobalMethods())).first;
Ben Langmuira0c32e92015-01-12 19:27:00 +00007160
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00007161 Pos->second.first.setBits(Visitor.getInstanceBits());
Nico Weberff4b35e2014-12-27 22:14:15 +00007162 Pos->second.first.setHasMoreThanOneDecl(Visitor.instanceHasMoreThanOneDecl());
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00007163 Pos->second.second.setBits(Visitor.getFactoryBits());
Nico Weberff4b35e2014-12-27 22:14:15 +00007164 Pos->second.second.setHasMoreThanOneDecl(Visitor.factoryHasMoreThanOneDecl());
Ben Langmuira0c32e92015-01-12 19:27:00 +00007165
7166 // Add methods to the global pool *after* setting hasMoreThanOneDecl, since
7167 // when building a module we keep every method individually and may need to
7168 // update hasMoreThanOneDecl as we add the methods.
7169 addMethodsToPool(S, Visitor.getInstanceMethods(), Pos->second.first);
7170 addMethodsToPool(S, Visitor.getFactoryMethods(), Pos->second.second);
Guy Benyei11169dd2012-12-18 14:30:41 +00007171}
7172
7173void ASTReader::ReadKnownNamespaces(
7174 SmallVectorImpl<NamespaceDecl *> &Namespaces) {
7175 Namespaces.clear();
7176
7177 for (unsigned I = 0, N = KnownNamespaces.size(); I != N; ++I) {
7178 if (NamespaceDecl *Namespace
7179 = dyn_cast_or_null<NamespaceDecl>(GetDecl(KnownNamespaces[I])))
7180 Namespaces.push_back(Namespace);
7181 }
7182}
7183
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00007184void ASTReader::ReadUndefinedButUsed(
Richard Smithd6a04d72016-03-25 21:49:43 +00007185 llvm::MapVector<NamedDecl *, SourceLocation> &Undefined) {
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00007186 for (unsigned Idx = 0, N = UndefinedButUsed.size(); Idx != N;) {
7187 NamedDecl *D = cast<NamedDecl>(GetDecl(UndefinedButUsed[Idx++]));
Nick Lewycky8334af82013-01-26 00:35:08 +00007188 SourceLocation Loc =
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00007189 SourceLocation::getFromRawEncoding(UndefinedButUsed[Idx++]);
Nick Lewycky8334af82013-01-26 00:35:08 +00007190 Undefined.insert(std::make_pair(D, Loc));
7191 }
7192}
Nick Lewycky8334af82013-01-26 00:35:08 +00007193
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00007194void ASTReader::ReadMismatchingDeleteExpressions(llvm::MapVector<
7195 FieldDecl *, llvm::SmallVector<std::pair<SourceLocation, bool>, 4>> &
7196 Exprs) {
7197 for (unsigned Idx = 0, N = DelayedDeleteExprs.size(); Idx != N;) {
7198 FieldDecl *FD = cast<FieldDecl>(GetDecl(DelayedDeleteExprs[Idx++]));
7199 uint64_t Count = DelayedDeleteExprs[Idx++];
7200 for (uint64_t C = 0; C < Count; ++C) {
7201 SourceLocation DeleteLoc =
7202 SourceLocation::getFromRawEncoding(DelayedDeleteExprs[Idx++]);
7203 const bool IsArrayForm = DelayedDeleteExprs[Idx++];
7204 Exprs[FD].push_back(std::make_pair(DeleteLoc, IsArrayForm));
7205 }
7206 }
7207}
7208
Guy Benyei11169dd2012-12-18 14:30:41 +00007209void ASTReader::ReadTentativeDefinitions(
7210 SmallVectorImpl<VarDecl *> &TentativeDefs) {
7211 for (unsigned I = 0, N = TentativeDefinitions.size(); I != N; ++I) {
7212 VarDecl *Var = dyn_cast_or_null<VarDecl>(GetDecl(TentativeDefinitions[I]));
7213 if (Var)
7214 TentativeDefs.push_back(Var);
7215 }
7216 TentativeDefinitions.clear();
7217}
7218
7219void ASTReader::ReadUnusedFileScopedDecls(
7220 SmallVectorImpl<const DeclaratorDecl *> &Decls) {
7221 for (unsigned I = 0, N = UnusedFileScopedDecls.size(); I != N; ++I) {
7222 DeclaratorDecl *D
7223 = dyn_cast_or_null<DeclaratorDecl>(GetDecl(UnusedFileScopedDecls[I]));
7224 if (D)
7225 Decls.push_back(D);
7226 }
7227 UnusedFileScopedDecls.clear();
7228}
7229
7230void ASTReader::ReadDelegatingConstructors(
7231 SmallVectorImpl<CXXConstructorDecl *> &Decls) {
7232 for (unsigned I = 0, N = DelegatingCtorDecls.size(); I != N; ++I) {
7233 CXXConstructorDecl *D
7234 = dyn_cast_or_null<CXXConstructorDecl>(GetDecl(DelegatingCtorDecls[I]));
7235 if (D)
7236 Decls.push_back(D);
7237 }
7238 DelegatingCtorDecls.clear();
7239}
7240
7241void ASTReader::ReadExtVectorDecls(SmallVectorImpl<TypedefNameDecl *> &Decls) {
7242 for (unsigned I = 0, N = ExtVectorDecls.size(); I != N; ++I) {
7243 TypedefNameDecl *D
7244 = dyn_cast_or_null<TypedefNameDecl>(GetDecl(ExtVectorDecls[I]));
7245 if (D)
7246 Decls.push_back(D);
7247 }
7248 ExtVectorDecls.clear();
7249}
7250
Nico Weber72889432014-09-06 01:25:55 +00007251void ASTReader::ReadUnusedLocalTypedefNameCandidates(
7252 llvm::SmallSetVector<const TypedefNameDecl *, 4> &Decls) {
7253 for (unsigned I = 0, N = UnusedLocalTypedefNameCandidates.size(); I != N;
7254 ++I) {
7255 TypedefNameDecl *D = dyn_cast_or_null<TypedefNameDecl>(
7256 GetDecl(UnusedLocalTypedefNameCandidates[I]));
7257 if (D)
7258 Decls.insert(D);
7259 }
7260 UnusedLocalTypedefNameCandidates.clear();
7261}
7262
Guy Benyei11169dd2012-12-18 14:30:41 +00007263void ASTReader::ReadReferencedSelectors(
7264 SmallVectorImpl<std::pair<Selector, SourceLocation> > &Sels) {
7265 if (ReferencedSelectorsData.empty())
7266 return;
7267
7268 // If there are @selector references added them to its pool. This is for
7269 // implementation of -Wselector.
7270 unsigned int DataSize = ReferencedSelectorsData.size()-1;
7271 unsigned I = 0;
7272 while (I < DataSize) {
7273 Selector Sel = DecodeSelector(ReferencedSelectorsData[I++]);
7274 SourceLocation SelLoc
7275 = SourceLocation::getFromRawEncoding(ReferencedSelectorsData[I++]);
7276 Sels.push_back(std::make_pair(Sel, SelLoc));
7277 }
7278 ReferencedSelectorsData.clear();
7279}
7280
7281void ASTReader::ReadWeakUndeclaredIdentifiers(
7282 SmallVectorImpl<std::pair<IdentifierInfo *, WeakInfo> > &WeakIDs) {
7283 if (WeakUndeclaredIdentifiers.empty())
7284 return;
7285
7286 for (unsigned I = 0, N = WeakUndeclaredIdentifiers.size(); I < N; /*none*/) {
7287 IdentifierInfo *WeakId
7288 = DecodeIdentifierInfo(WeakUndeclaredIdentifiers[I++]);
7289 IdentifierInfo *AliasId
7290 = DecodeIdentifierInfo(WeakUndeclaredIdentifiers[I++]);
7291 SourceLocation Loc
7292 = SourceLocation::getFromRawEncoding(WeakUndeclaredIdentifiers[I++]);
7293 bool Used = WeakUndeclaredIdentifiers[I++];
7294 WeakInfo WI(AliasId, Loc);
7295 WI.setUsed(Used);
7296 WeakIDs.push_back(std::make_pair(WeakId, WI));
7297 }
7298 WeakUndeclaredIdentifiers.clear();
7299}
7300
7301void ASTReader::ReadUsedVTables(SmallVectorImpl<ExternalVTableUse> &VTables) {
7302 for (unsigned Idx = 0, N = VTableUses.size(); Idx < N; /* In loop */) {
7303 ExternalVTableUse VT;
7304 VT.Record = dyn_cast_or_null<CXXRecordDecl>(GetDecl(VTableUses[Idx++]));
7305 VT.Location = SourceLocation::getFromRawEncoding(VTableUses[Idx++]);
7306 VT.DefinitionRequired = VTableUses[Idx++];
7307 VTables.push_back(VT);
7308 }
7309
7310 VTableUses.clear();
7311}
7312
7313void ASTReader::ReadPendingInstantiations(
7314 SmallVectorImpl<std::pair<ValueDecl *, SourceLocation> > &Pending) {
7315 for (unsigned Idx = 0, N = PendingInstantiations.size(); Idx < N;) {
7316 ValueDecl *D = cast<ValueDecl>(GetDecl(PendingInstantiations[Idx++]));
7317 SourceLocation Loc
7318 = SourceLocation::getFromRawEncoding(PendingInstantiations[Idx++]);
7319
7320 Pending.push_back(std::make_pair(D, Loc));
7321 }
7322 PendingInstantiations.clear();
7323}
7324
Richard Smithe40f2ba2013-08-07 21:41:30 +00007325void ASTReader::ReadLateParsedTemplates(
Chandler Carruth52cee4d2015-03-26 09:08:15 +00007326 llvm::MapVector<const FunctionDecl *, LateParsedTemplate *> &LPTMap) {
Richard Smithe40f2ba2013-08-07 21:41:30 +00007327 for (unsigned Idx = 0, N = LateParsedTemplates.size(); Idx < N;
7328 /* In loop */) {
7329 FunctionDecl *FD = cast<FunctionDecl>(GetDecl(LateParsedTemplates[Idx++]));
7330
7331 LateParsedTemplate *LT = new LateParsedTemplate;
7332 LT->D = GetDecl(LateParsedTemplates[Idx++]);
7333
7334 ModuleFile *F = getOwningModuleFile(LT->D);
7335 assert(F && "No module");
7336
7337 unsigned TokN = LateParsedTemplates[Idx++];
7338 LT->Toks.reserve(TokN);
7339 for (unsigned T = 0; T < TokN; ++T)
7340 LT->Toks.push_back(ReadToken(*F, LateParsedTemplates, Idx));
7341
Chandler Carruth52cee4d2015-03-26 09:08:15 +00007342 LPTMap.insert(std::make_pair(FD, LT));
Richard Smithe40f2ba2013-08-07 21:41:30 +00007343 }
7344
7345 LateParsedTemplates.clear();
7346}
7347
Guy Benyei11169dd2012-12-18 14:30:41 +00007348void ASTReader::LoadSelector(Selector Sel) {
7349 // It would be complicated to avoid reading the methods anyway. So don't.
7350 ReadMethodPool(Sel);
7351}
7352
7353void ASTReader::SetIdentifierInfo(IdentifierID ID, IdentifierInfo *II) {
7354 assert(ID && "Non-zero identifier ID required");
7355 assert(ID <= IdentifiersLoaded.size() && "identifier ID out of range");
7356 IdentifiersLoaded[ID - 1] = II;
7357 if (DeserializationListener)
7358 DeserializationListener->IdentifierRead(ID, II);
7359}
7360
7361/// \brief Set the globally-visible declarations associated with the given
7362/// identifier.
7363///
7364/// If the AST reader is currently in a state where the given declaration IDs
7365/// cannot safely be resolved, they are queued until it is safe to resolve
7366/// them.
7367///
7368/// \param II an IdentifierInfo that refers to one or more globally-visible
7369/// declarations.
7370///
7371/// \param DeclIDs the set of declaration IDs with the name @p II that are
7372/// visible at global scope.
7373///
Douglas Gregor6168bd22013-02-18 15:53:43 +00007374/// \param Decls if non-null, this vector will be populated with the set of
7375/// deserialized declarations. These declarations will not be pushed into
7376/// scope.
Guy Benyei11169dd2012-12-18 14:30:41 +00007377void
7378ASTReader::SetGloballyVisibleDecls(IdentifierInfo *II,
7379 const SmallVectorImpl<uint32_t> &DeclIDs,
Douglas Gregor6168bd22013-02-18 15:53:43 +00007380 SmallVectorImpl<Decl *> *Decls) {
7381 if (NumCurrentElementsDeserializing && !Decls) {
7382 PendingIdentifierInfos[II].append(DeclIDs.begin(), DeclIDs.end());
Guy Benyei11169dd2012-12-18 14:30:41 +00007383 return;
7384 }
7385
7386 for (unsigned I = 0, N = DeclIDs.size(); I != N; ++I) {
Ben Langmuir5418f402014-09-10 21:29:41 +00007387 if (!SemaObj) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007388 // Queue this declaration so that it will be added to the
7389 // translation unit scope and identifier's declaration chain
7390 // once a Sema object is known.
Ben Langmuir5418f402014-09-10 21:29:41 +00007391 PreloadedDeclIDs.push_back(DeclIDs[I]);
7392 continue;
Guy Benyei11169dd2012-12-18 14:30:41 +00007393 }
Ben Langmuir5418f402014-09-10 21:29:41 +00007394
7395 NamedDecl *D = cast<NamedDecl>(GetDecl(DeclIDs[I]));
7396
7397 // If we're simply supposed to record the declarations, do so now.
7398 if (Decls) {
7399 Decls->push_back(D);
7400 continue;
7401 }
7402
7403 // Introduce this declaration into the translation-unit scope
7404 // and add it to the declaration chain for this identifier, so
7405 // that (unqualified) name lookup will find it.
7406 pushExternalDeclIntoScope(D, II);
Guy Benyei11169dd2012-12-18 14:30:41 +00007407 }
7408}
7409
Douglas Gregorc8a992f2013-01-21 16:52:34 +00007410IdentifierInfo *ASTReader::DecodeIdentifierInfo(IdentifierID ID) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007411 if (ID == 0)
Craig Toppera13603a2014-05-22 05:54:18 +00007412 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007413
7414 if (IdentifiersLoaded.empty()) {
7415 Error("no identifier table in AST file");
Craig Toppera13603a2014-05-22 05:54:18 +00007416 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007417 }
7418
7419 ID -= 1;
7420 if (!IdentifiersLoaded[ID]) {
7421 GlobalIdentifierMapType::iterator I = GlobalIdentifierMap.find(ID + 1);
7422 assert(I != GlobalIdentifierMap.end() && "Corrupted global identifier map");
7423 ModuleFile *M = I->second;
7424 unsigned Index = ID - M->BaseIdentifierID;
7425 const char *Str = M->IdentifierTableData + M->IdentifierOffsets[Index];
7426
7427 // All of the strings in the AST file are preceded by a 16-bit length.
7428 // Extract that 16-bit length to avoid having to execute strlen().
7429 // NOTE: 'StrLenPtr' is an 'unsigned char*' so that we load bytes as
7430 // unsigned integers. This is important to avoid integer overflow when
7431 // we cast them to 'unsigned'.
7432 const unsigned char *StrLenPtr = (const unsigned char*) Str - 2;
7433 unsigned StrLen = (((unsigned) StrLenPtr[0])
7434 | (((unsigned) StrLenPtr[1]) << 8)) - 1;
Richard Smitheb4b58f62016-02-05 01:40:54 +00007435 auto &II = PP.getIdentifierTable().get(StringRef(Str, StrLen));
7436 IdentifiersLoaded[ID] = &II;
7437 markIdentifierFromAST(*this, II);
Guy Benyei11169dd2012-12-18 14:30:41 +00007438 if (DeserializationListener)
Richard Smitheb4b58f62016-02-05 01:40:54 +00007439 DeserializationListener->IdentifierRead(ID + 1, &II);
Guy Benyei11169dd2012-12-18 14:30:41 +00007440 }
7441
7442 return IdentifiersLoaded[ID];
7443}
7444
Douglas Gregorc8a992f2013-01-21 16:52:34 +00007445IdentifierInfo *ASTReader::getLocalIdentifier(ModuleFile &M, unsigned LocalID) {
7446 return DecodeIdentifierInfo(getGlobalIdentifierID(M, LocalID));
Guy Benyei11169dd2012-12-18 14:30:41 +00007447}
7448
7449IdentifierID ASTReader::getGlobalIdentifierID(ModuleFile &M, unsigned LocalID) {
7450 if (LocalID < NUM_PREDEF_IDENT_IDS)
7451 return LocalID;
7452
7453 ContinuousRangeMap<uint32_t, int, 2>::iterator I
7454 = M.IdentifierRemap.find(LocalID - NUM_PREDEF_IDENT_IDS);
7455 assert(I != M.IdentifierRemap.end()
7456 && "Invalid index into identifier index remap");
7457
7458 return LocalID + I->second;
7459}
7460
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00007461MacroInfo *ASTReader::getMacro(MacroID ID) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007462 if (ID == 0)
Craig Toppera13603a2014-05-22 05:54:18 +00007463 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007464
7465 if (MacrosLoaded.empty()) {
7466 Error("no macro table in AST file");
Craig Toppera13603a2014-05-22 05:54:18 +00007467 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007468 }
7469
7470 ID -= NUM_PREDEF_MACRO_IDS;
7471 if (!MacrosLoaded[ID]) {
7472 GlobalMacroMapType::iterator I
7473 = GlobalMacroMap.find(ID + NUM_PREDEF_MACRO_IDS);
7474 assert(I != GlobalMacroMap.end() && "Corrupted global macro map");
7475 ModuleFile *M = I->second;
7476 unsigned Index = ID - M->BaseMacroID;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00007477 MacrosLoaded[ID] = ReadMacroRecord(*M, M->MacroOffsets[Index]);
7478
7479 if (DeserializationListener)
7480 DeserializationListener->MacroRead(ID + NUM_PREDEF_MACRO_IDS,
7481 MacrosLoaded[ID]);
Guy Benyei11169dd2012-12-18 14:30:41 +00007482 }
7483
7484 return MacrosLoaded[ID];
7485}
7486
7487MacroID ASTReader::getGlobalMacroID(ModuleFile &M, unsigned LocalID) {
7488 if (LocalID < NUM_PREDEF_MACRO_IDS)
7489 return LocalID;
7490
7491 ContinuousRangeMap<uint32_t, int, 2>::iterator I
7492 = M.MacroRemap.find(LocalID - NUM_PREDEF_MACRO_IDS);
7493 assert(I != M.MacroRemap.end() && "Invalid index into macro index remap");
7494
7495 return LocalID + I->second;
7496}
7497
7498serialization::SubmoduleID
7499ASTReader::getGlobalSubmoduleID(ModuleFile &M, unsigned LocalID) {
7500 if (LocalID < NUM_PREDEF_SUBMODULE_IDS)
7501 return LocalID;
7502
7503 ContinuousRangeMap<uint32_t, int, 2>::iterator I
7504 = M.SubmoduleRemap.find(LocalID - NUM_PREDEF_SUBMODULE_IDS);
7505 assert(I != M.SubmoduleRemap.end()
7506 && "Invalid index into submodule index remap");
7507
7508 return LocalID + I->second;
7509}
7510
7511Module *ASTReader::getSubmodule(SubmoduleID GlobalID) {
7512 if (GlobalID < NUM_PREDEF_SUBMODULE_IDS) {
7513 assert(GlobalID == 0 && "Unhandled global submodule ID");
Craig Toppera13603a2014-05-22 05:54:18 +00007514 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007515 }
7516
7517 if (GlobalID > SubmodulesLoaded.size()) {
7518 Error("submodule ID out of range in AST file");
Craig Toppera13603a2014-05-22 05:54:18 +00007519 return nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007520 }
7521
7522 return SubmodulesLoaded[GlobalID - NUM_PREDEF_SUBMODULE_IDS];
7523}
Douglas Gregorc147b0b2013-01-12 01:29:50 +00007524
7525Module *ASTReader::getModule(unsigned ID) {
7526 return getSubmodule(ID);
7527}
7528
Richard Smithd88a7f12015-09-01 20:35:42 +00007529ModuleFile *ASTReader::getLocalModuleFile(ModuleFile &F, unsigned ID) {
7530 if (ID & 1) {
7531 // It's a module, look it up by submodule ID.
7532 auto I = GlobalSubmoduleMap.find(getGlobalSubmoduleID(F, ID >> 1));
7533 return I == GlobalSubmoduleMap.end() ? nullptr : I->second;
7534 } else {
7535 // It's a prefix (preamble, PCH, ...). Look it up by index.
7536 unsigned IndexFromEnd = ID >> 1;
7537 assert(IndexFromEnd && "got reference to unknown module file");
7538 return getModuleManager().pch_modules().end()[-IndexFromEnd];
7539 }
7540}
7541
7542unsigned ASTReader::getModuleFileID(ModuleFile *F) {
7543 if (!F)
7544 return 1;
7545
7546 // For a file representing a module, use the submodule ID of the top-level
7547 // module as the file ID. For any other kind of file, the number of such
7548 // files loaded beforehand will be the same on reload.
7549 // FIXME: Is this true even if we have an explicit module file and a PCH?
7550 if (F->isModule())
7551 return ((F->BaseSubmoduleID + NUM_PREDEF_SUBMODULE_IDS) << 1) | 1;
7552
7553 auto PCHModules = getModuleManager().pch_modules();
7554 auto I = std::find(PCHModules.begin(), PCHModules.end(), F);
7555 assert(I != PCHModules.end() && "emitting reference to unknown file");
7556 return (I - PCHModules.end()) << 1;
7557}
7558
Adrian Prantl15bcf702015-06-30 17:39:43 +00007559llvm::Optional<ExternalASTSource::ASTSourceDescriptor>
7560ASTReader::getSourceDescriptor(unsigned ID) {
7561 if (const Module *M = getSubmodule(ID))
Adrian Prantlc6458d62015-09-19 00:10:32 +00007562 return ExternalASTSource::ASTSourceDescriptor(*M);
Adrian Prantl15bcf702015-06-30 17:39:43 +00007563
7564 // If there is only a single PCH, return it instead.
7565 // Chained PCH are not suported.
7566 if (ModuleMgr.size() == 1) {
7567 ModuleFile &MF = ModuleMgr.getPrimaryModule();
Adrian Prantl3a2d4942016-01-22 23:30:56 +00007568 StringRef ModuleName = llvm::sys::path::filename(MF.OriginalSourceFileName);
Adrian Prantl9bc3c4f2016-04-27 17:06:22 +00007569 StringRef FileName = llvm::sys::path::filename(MF.FileName);
7570 return ASTReader::ASTSourceDescriptor(ModuleName, MF.OriginalDir, FileName,
7571 MF.Signature);
Adrian Prantl15bcf702015-06-30 17:39:43 +00007572 }
7573 return None;
7574}
7575
Guy Benyei11169dd2012-12-18 14:30:41 +00007576Selector ASTReader::getLocalSelector(ModuleFile &M, unsigned LocalID) {
7577 return DecodeSelector(getGlobalSelectorID(M, LocalID));
7578}
7579
7580Selector ASTReader::DecodeSelector(serialization::SelectorID ID) {
7581 if (ID == 0)
7582 return Selector();
7583
7584 if (ID > SelectorsLoaded.size()) {
7585 Error("selector ID out of range in AST file");
7586 return Selector();
7587 }
7588
Craig Toppera13603a2014-05-22 05:54:18 +00007589 if (SelectorsLoaded[ID - 1].getAsOpaquePtr() == nullptr) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007590 // Load this selector from the selector table.
7591 GlobalSelectorMapType::iterator I = GlobalSelectorMap.find(ID);
7592 assert(I != GlobalSelectorMap.end() && "Corrupted global selector map");
7593 ModuleFile &M = *I->second;
7594 ASTSelectorLookupTrait Trait(*this, M);
7595 unsigned Idx = ID - M.BaseSelectorID - NUM_PREDEF_SELECTOR_IDS;
7596 SelectorsLoaded[ID - 1] =
7597 Trait.ReadKey(M.SelectorLookupTableData + M.SelectorOffsets[Idx], 0);
7598 if (DeserializationListener)
7599 DeserializationListener->SelectorRead(ID, SelectorsLoaded[ID - 1]);
7600 }
7601
7602 return SelectorsLoaded[ID - 1];
7603}
7604
7605Selector ASTReader::GetExternalSelector(serialization::SelectorID ID) {
7606 return DecodeSelector(ID);
7607}
7608
7609uint32_t ASTReader::GetNumExternalSelectors() {
7610 // ID 0 (the null selector) is considered an external selector.
7611 return getTotalNumSelectors() + 1;
7612}
7613
7614serialization::SelectorID
7615ASTReader::getGlobalSelectorID(ModuleFile &M, unsigned LocalID) const {
7616 if (LocalID < NUM_PREDEF_SELECTOR_IDS)
7617 return LocalID;
7618
7619 ContinuousRangeMap<uint32_t, int, 2>::iterator I
7620 = M.SelectorRemap.find(LocalID - NUM_PREDEF_SELECTOR_IDS);
7621 assert(I != M.SelectorRemap.end()
7622 && "Invalid index into selector index remap");
7623
7624 return LocalID + I->second;
7625}
7626
7627DeclarationName
7628ASTReader::ReadDeclarationName(ModuleFile &F,
7629 const RecordData &Record, unsigned &Idx) {
7630 DeclarationName::NameKind Kind = (DeclarationName::NameKind)Record[Idx++];
7631 switch (Kind) {
7632 case DeclarationName::Identifier:
Douglas Gregorc8a992f2013-01-21 16:52:34 +00007633 return DeclarationName(GetIdentifierInfo(F, Record, Idx));
Guy Benyei11169dd2012-12-18 14:30:41 +00007634
7635 case DeclarationName::ObjCZeroArgSelector:
7636 case DeclarationName::ObjCOneArgSelector:
7637 case DeclarationName::ObjCMultiArgSelector:
7638 return DeclarationName(ReadSelector(F, Record, Idx));
7639
7640 case DeclarationName::CXXConstructorName:
7641 return Context.DeclarationNames.getCXXConstructorName(
7642 Context.getCanonicalType(readType(F, Record, Idx)));
7643
7644 case DeclarationName::CXXDestructorName:
7645 return Context.DeclarationNames.getCXXDestructorName(
7646 Context.getCanonicalType(readType(F, Record, Idx)));
7647
7648 case DeclarationName::CXXConversionFunctionName:
7649 return Context.DeclarationNames.getCXXConversionFunctionName(
7650 Context.getCanonicalType(readType(F, Record, Idx)));
7651
7652 case DeclarationName::CXXOperatorName:
7653 return Context.DeclarationNames.getCXXOperatorName(
7654 (OverloadedOperatorKind)Record[Idx++]);
7655
7656 case DeclarationName::CXXLiteralOperatorName:
7657 return Context.DeclarationNames.getCXXLiteralOperatorName(
7658 GetIdentifierInfo(F, Record, Idx));
7659
7660 case DeclarationName::CXXUsingDirective:
7661 return DeclarationName::getUsingDirectiveName();
7662 }
7663
7664 llvm_unreachable("Invalid NameKind!");
7665}
7666
7667void ASTReader::ReadDeclarationNameLoc(ModuleFile &F,
7668 DeclarationNameLoc &DNLoc,
7669 DeclarationName Name,
7670 const RecordData &Record, unsigned &Idx) {
7671 switch (Name.getNameKind()) {
7672 case DeclarationName::CXXConstructorName:
7673 case DeclarationName::CXXDestructorName:
7674 case DeclarationName::CXXConversionFunctionName:
7675 DNLoc.NamedType.TInfo = GetTypeSourceInfo(F, Record, Idx);
7676 break;
7677
7678 case DeclarationName::CXXOperatorName:
7679 DNLoc.CXXOperatorName.BeginOpNameLoc
7680 = ReadSourceLocation(F, Record, Idx).getRawEncoding();
7681 DNLoc.CXXOperatorName.EndOpNameLoc
7682 = ReadSourceLocation(F, Record, Idx).getRawEncoding();
7683 break;
7684
7685 case DeclarationName::CXXLiteralOperatorName:
7686 DNLoc.CXXLiteralOperatorName.OpNameLoc
7687 = ReadSourceLocation(F, Record, Idx).getRawEncoding();
7688 break;
7689
7690 case DeclarationName::Identifier:
7691 case DeclarationName::ObjCZeroArgSelector:
7692 case DeclarationName::ObjCOneArgSelector:
7693 case DeclarationName::ObjCMultiArgSelector:
7694 case DeclarationName::CXXUsingDirective:
7695 break;
7696 }
7697}
7698
7699void ASTReader::ReadDeclarationNameInfo(ModuleFile &F,
7700 DeclarationNameInfo &NameInfo,
7701 const RecordData &Record, unsigned &Idx) {
7702 NameInfo.setName(ReadDeclarationName(F, Record, Idx));
7703 NameInfo.setLoc(ReadSourceLocation(F, Record, Idx));
7704 DeclarationNameLoc DNLoc;
7705 ReadDeclarationNameLoc(F, DNLoc, NameInfo.getName(), Record, Idx);
7706 NameInfo.setInfo(DNLoc);
7707}
7708
7709void ASTReader::ReadQualifierInfo(ModuleFile &F, QualifierInfo &Info,
7710 const RecordData &Record, unsigned &Idx) {
7711 Info.QualifierLoc = ReadNestedNameSpecifierLoc(F, Record, Idx);
7712 unsigned NumTPLists = Record[Idx++];
7713 Info.NumTemplParamLists = NumTPLists;
7714 if (NumTPLists) {
7715 Info.TemplParamLists = new (Context) TemplateParameterList*[NumTPLists];
7716 for (unsigned i=0; i != NumTPLists; ++i)
7717 Info.TemplParamLists[i] = ReadTemplateParameterList(F, Record, Idx);
7718 }
7719}
7720
7721TemplateName
7722ASTReader::ReadTemplateName(ModuleFile &F, const RecordData &Record,
7723 unsigned &Idx) {
7724 TemplateName::NameKind Kind = (TemplateName::NameKind)Record[Idx++];
7725 switch (Kind) {
7726 case TemplateName::Template:
7727 return TemplateName(ReadDeclAs<TemplateDecl>(F, Record, Idx));
7728
7729 case TemplateName::OverloadedTemplate: {
7730 unsigned size = Record[Idx++];
7731 UnresolvedSet<8> Decls;
7732 while (size--)
7733 Decls.addDecl(ReadDeclAs<NamedDecl>(F, Record, Idx));
7734
7735 return Context.getOverloadedTemplateName(Decls.begin(), Decls.end());
7736 }
7737
7738 case TemplateName::QualifiedTemplate: {
7739 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(F, Record, Idx);
7740 bool hasTemplKeyword = Record[Idx++];
7741 TemplateDecl *Template = ReadDeclAs<TemplateDecl>(F, Record, Idx);
7742 return Context.getQualifiedTemplateName(NNS, hasTemplKeyword, Template);
7743 }
7744
7745 case TemplateName::DependentTemplate: {
7746 NestedNameSpecifier *NNS = ReadNestedNameSpecifier(F, Record, Idx);
7747 if (Record[Idx++]) // isIdentifier
7748 return Context.getDependentTemplateName(NNS,
7749 GetIdentifierInfo(F, Record,
7750 Idx));
7751 return Context.getDependentTemplateName(NNS,
7752 (OverloadedOperatorKind)Record[Idx++]);
7753 }
7754
7755 case TemplateName::SubstTemplateTemplateParm: {
7756 TemplateTemplateParmDecl *param
7757 = ReadDeclAs<TemplateTemplateParmDecl>(F, Record, Idx);
7758 if (!param) return TemplateName();
7759 TemplateName replacement = ReadTemplateName(F, Record, Idx);
7760 return Context.getSubstTemplateTemplateParm(param, replacement);
7761 }
7762
7763 case TemplateName::SubstTemplateTemplateParmPack: {
7764 TemplateTemplateParmDecl *Param
7765 = ReadDeclAs<TemplateTemplateParmDecl>(F, Record, Idx);
7766 if (!Param)
7767 return TemplateName();
7768
7769 TemplateArgument ArgPack = ReadTemplateArgument(F, Record, Idx);
7770 if (ArgPack.getKind() != TemplateArgument::Pack)
7771 return TemplateName();
7772
7773 return Context.getSubstTemplateTemplateParmPack(Param, ArgPack);
7774 }
7775 }
7776
7777 llvm_unreachable("Unhandled template name kind!");
7778}
7779
Richard Smith2bb3c342015-08-09 01:05:31 +00007780TemplateArgument ASTReader::ReadTemplateArgument(ModuleFile &F,
7781 const RecordData &Record,
7782 unsigned &Idx,
7783 bool Canonicalize) {
7784 if (Canonicalize) {
7785 // The caller wants a canonical template argument. Sometimes the AST only
7786 // wants template arguments in canonical form (particularly as the template
7787 // argument lists of template specializations) so ensure we preserve that
7788 // canonical form across serialization.
7789 TemplateArgument Arg = ReadTemplateArgument(F, Record, Idx, false);
7790 return Context.getCanonicalTemplateArgument(Arg);
7791 }
7792
Guy Benyei11169dd2012-12-18 14:30:41 +00007793 TemplateArgument::ArgKind Kind = (TemplateArgument::ArgKind)Record[Idx++];
7794 switch (Kind) {
7795 case TemplateArgument::Null:
7796 return TemplateArgument();
7797 case TemplateArgument::Type:
7798 return TemplateArgument(readType(F, Record, Idx));
7799 case TemplateArgument::Declaration: {
7800 ValueDecl *D = ReadDeclAs<ValueDecl>(F, Record, Idx);
David Blaikie0f62c8d2014-10-16 04:21:25 +00007801 return TemplateArgument(D, readType(F, Record, Idx));
Guy Benyei11169dd2012-12-18 14:30:41 +00007802 }
7803 case TemplateArgument::NullPtr:
7804 return TemplateArgument(readType(F, Record, Idx), /*isNullPtr*/true);
7805 case TemplateArgument::Integral: {
7806 llvm::APSInt Value = ReadAPSInt(Record, Idx);
7807 QualType T = readType(F, Record, Idx);
7808 return TemplateArgument(Context, Value, T);
7809 }
7810 case TemplateArgument::Template:
7811 return TemplateArgument(ReadTemplateName(F, Record, Idx));
7812 case TemplateArgument::TemplateExpansion: {
7813 TemplateName Name = ReadTemplateName(F, Record, Idx);
David Blaikie05785d12013-02-20 22:23:23 +00007814 Optional<unsigned> NumTemplateExpansions;
Guy Benyei11169dd2012-12-18 14:30:41 +00007815 if (unsigned NumExpansions = Record[Idx++])
7816 NumTemplateExpansions = NumExpansions - 1;
7817 return TemplateArgument(Name, NumTemplateExpansions);
7818 }
7819 case TemplateArgument::Expression:
7820 return TemplateArgument(ReadExpr(F));
7821 case TemplateArgument::Pack: {
7822 unsigned NumArgs = Record[Idx++];
7823 TemplateArgument *Args = new (Context) TemplateArgument[NumArgs];
7824 for (unsigned I = 0; I != NumArgs; ++I)
7825 Args[I] = ReadTemplateArgument(F, Record, Idx);
Benjamin Kramercce63472015-08-05 09:40:22 +00007826 return TemplateArgument(llvm::makeArrayRef(Args, NumArgs));
Guy Benyei11169dd2012-12-18 14:30:41 +00007827 }
7828 }
7829
7830 llvm_unreachable("Unhandled template argument kind!");
7831}
7832
7833TemplateParameterList *
7834ASTReader::ReadTemplateParameterList(ModuleFile &F,
7835 const RecordData &Record, unsigned &Idx) {
7836 SourceLocation TemplateLoc = ReadSourceLocation(F, Record, Idx);
7837 SourceLocation LAngleLoc = ReadSourceLocation(F, Record, Idx);
7838 SourceLocation RAngleLoc = ReadSourceLocation(F, Record, Idx);
7839
7840 unsigned NumParams = Record[Idx++];
7841 SmallVector<NamedDecl *, 16> Params;
7842 Params.reserve(NumParams);
7843 while (NumParams--)
7844 Params.push_back(ReadDeclAs<NamedDecl>(F, Record, Idx));
7845
7846 TemplateParameterList* TemplateParams =
7847 TemplateParameterList::Create(Context, TemplateLoc, LAngleLoc,
David Majnemer902f8c62015-12-27 07:16:27 +00007848 Params, RAngleLoc);
Guy Benyei11169dd2012-12-18 14:30:41 +00007849 return TemplateParams;
7850}
7851
7852void
7853ASTReader::
Craig Topper5603df42013-07-05 19:34:19 +00007854ReadTemplateArgumentList(SmallVectorImpl<TemplateArgument> &TemplArgs,
Guy Benyei11169dd2012-12-18 14:30:41 +00007855 ModuleFile &F, const RecordData &Record,
Richard Smith2bb3c342015-08-09 01:05:31 +00007856 unsigned &Idx, bool Canonicalize) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007857 unsigned NumTemplateArgs = Record[Idx++];
7858 TemplArgs.reserve(NumTemplateArgs);
7859 while (NumTemplateArgs--)
Richard Smith2bb3c342015-08-09 01:05:31 +00007860 TemplArgs.push_back(ReadTemplateArgument(F, Record, Idx, Canonicalize));
Guy Benyei11169dd2012-12-18 14:30:41 +00007861}
7862
7863/// \brief Read a UnresolvedSet structure.
Richard Smitha4ba74c2013-08-30 04:46:40 +00007864void ASTReader::ReadUnresolvedSet(ModuleFile &F, LazyASTUnresolvedSet &Set,
Guy Benyei11169dd2012-12-18 14:30:41 +00007865 const RecordData &Record, unsigned &Idx) {
7866 unsigned NumDecls = Record[Idx++];
7867 Set.reserve(Context, NumDecls);
7868 while (NumDecls--) {
Richard Smitha4ba74c2013-08-30 04:46:40 +00007869 DeclID ID = ReadDeclID(F, Record, Idx);
Guy Benyei11169dd2012-12-18 14:30:41 +00007870 AccessSpecifier AS = (AccessSpecifier)Record[Idx++];
Richard Smitha4ba74c2013-08-30 04:46:40 +00007871 Set.addLazyDecl(Context, ID, AS);
Guy Benyei11169dd2012-12-18 14:30:41 +00007872 }
7873}
7874
7875CXXBaseSpecifier
7876ASTReader::ReadCXXBaseSpecifier(ModuleFile &F,
7877 const RecordData &Record, unsigned &Idx) {
7878 bool isVirtual = static_cast<bool>(Record[Idx++]);
7879 bool isBaseOfClass = static_cast<bool>(Record[Idx++]);
7880 AccessSpecifier AS = static_cast<AccessSpecifier>(Record[Idx++]);
7881 bool inheritConstructors = static_cast<bool>(Record[Idx++]);
7882 TypeSourceInfo *TInfo = GetTypeSourceInfo(F, Record, Idx);
7883 SourceRange Range = ReadSourceRange(F, Record, Idx);
7884 SourceLocation EllipsisLoc = ReadSourceLocation(F, Record, Idx);
7885 CXXBaseSpecifier Result(Range, isVirtual, isBaseOfClass, AS, TInfo,
7886 EllipsisLoc);
7887 Result.setInheritConstructors(inheritConstructors);
7888 return Result;
7889}
7890
Richard Smithc2bb8182015-03-24 06:36:48 +00007891CXXCtorInitializer **
Guy Benyei11169dd2012-12-18 14:30:41 +00007892ASTReader::ReadCXXCtorInitializers(ModuleFile &F, const RecordData &Record,
7893 unsigned &Idx) {
Guy Benyei11169dd2012-12-18 14:30:41 +00007894 unsigned NumInitializers = Record[Idx++];
Richard Smithc2bb8182015-03-24 06:36:48 +00007895 assert(NumInitializers && "wrote ctor initializers but have no inits");
7896 auto **CtorInitializers = new (Context) CXXCtorInitializer*[NumInitializers];
7897 for (unsigned i = 0; i != NumInitializers; ++i) {
7898 TypeSourceInfo *TInfo = nullptr;
7899 bool IsBaseVirtual = false;
7900 FieldDecl *Member = nullptr;
7901 IndirectFieldDecl *IndirectMember = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007902
Richard Smithc2bb8182015-03-24 06:36:48 +00007903 CtorInitializerType Type = (CtorInitializerType)Record[Idx++];
7904 switch (Type) {
7905 case CTOR_INITIALIZER_BASE:
7906 TInfo = GetTypeSourceInfo(F, Record, Idx);
7907 IsBaseVirtual = Record[Idx++];
7908 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00007909
Richard Smithc2bb8182015-03-24 06:36:48 +00007910 case CTOR_INITIALIZER_DELEGATING:
7911 TInfo = GetTypeSourceInfo(F, Record, Idx);
7912 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00007913
Richard Smithc2bb8182015-03-24 06:36:48 +00007914 case CTOR_INITIALIZER_MEMBER:
7915 Member = ReadDeclAs<FieldDecl>(F, Record, Idx);
7916 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00007917
Richard Smithc2bb8182015-03-24 06:36:48 +00007918 case CTOR_INITIALIZER_INDIRECT_MEMBER:
7919 IndirectMember = ReadDeclAs<IndirectFieldDecl>(F, Record, Idx);
7920 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00007921 }
Richard Smithc2bb8182015-03-24 06:36:48 +00007922
7923 SourceLocation MemberOrEllipsisLoc = ReadSourceLocation(F, Record, Idx);
7924 Expr *Init = ReadExpr(F);
7925 SourceLocation LParenLoc = ReadSourceLocation(F, Record, Idx);
7926 SourceLocation RParenLoc = ReadSourceLocation(F, Record, Idx);
7927 bool IsWritten = Record[Idx++];
7928 unsigned SourceOrderOrNumArrayIndices;
7929 SmallVector<VarDecl *, 8> Indices;
7930 if (IsWritten) {
7931 SourceOrderOrNumArrayIndices = Record[Idx++];
7932 } else {
7933 SourceOrderOrNumArrayIndices = Record[Idx++];
7934 Indices.reserve(SourceOrderOrNumArrayIndices);
7935 for (unsigned i=0; i != SourceOrderOrNumArrayIndices; ++i)
7936 Indices.push_back(ReadDeclAs<VarDecl>(F, Record, Idx));
7937 }
7938
7939 CXXCtorInitializer *BOMInit;
7940 if (Type == CTOR_INITIALIZER_BASE) {
7941 BOMInit = new (Context)
7942 CXXCtorInitializer(Context, TInfo, IsBaseVirtual, LParenLoc, Init,
7943 RParenLoc, MemberOrEllipsisLoc);
7944 } else if (Type == CTOR_INITIALIZER_DELEGATING) {
7945 BOMInit = new (Context)
7946 CXXCtorInitializer(Context, TInfo, LParenLoc, Init, RParenLoc);
7947 } else if (IsWritten) {
7948 if (Member)
7949 BOMInit = new (Context) CXXCtorInitializer(
7950 Context, Member, MemberOrEllipsisLoc, LParenLoc, Init, RParenLoc);
7951 else
7952 BOMInit = new (Context)
7953 CXXCtorInitializer(Context, IndirectMember, MemberOrEllipsisLoc,
7954 LParenLoc, Init, RParenLoc);
7955 } else {
7956 if (IndirectMember) {
7957 assert(Indices.empty() && "Indirect field improperly initialized");
7958 BOMInit = new (Context)
7959 CXXCtorInitializer(Context, IndirectMember, MemberOrEllipsisLoc,
7960 LParenLoc, Init, RParenLoc);
7961 } else {
7962 BOMInit = CXXCtorInitializer::Create(
7963 Context, Member, MemberOrEllipsisLoc, LParenLoc, Init, RParenLoc,
7964 Indices.data(), Indices.size());
7965 }
7966 }
7967
7968 if (IsWritten)
7969 BOMInit->setSourceOrder(SourceOrderOrNumArrayIndices);
7970 CtorInitializers[i] = BOMInit;
Guy Benyei11169dd2012-12-18 14:30:41 +00007971 }
7972
Richard Smithc2bb8182015-03-24 06:36:48 +00007973 return CtorInitializers;
Guy Benyei11169dd2012-12-18 14:30:41 +00007974}
7975
7976NestedNameSpecifier *
7977ASTReader::ReadNestedNameSpecifier(ModuleFile &F,
7978 const RecordData &Record, unsigned &Idx) {
7979 unsigned N = Record[Idx++];
Craig Toppera13603a2014-05-22 05:54:18 +00007980 NestedNameSpecifier *NNS = nullptr, *Prev = nullptr;
Guy Benyei11169dd2012-12-18 14:30:41 +00007981 for (unsigned I = 0; I != N; ++I) {
7982 NestedNameSpecifier::SpecifierKind Kind
7983 = (NestedNameSpecifier::SpecifierKind)Record[Idx++];
7984 switch (Kind) {
7985 case NestedNameSpecifier::Identifier: {
7986 IdentifierInfo *II = GetIdentifierInfo(F, Record, Idx);
7987 NNS = NestedNameSpecifier::Create(Context, Prev, II);
7988 break;
7989 }
7990
7991 case NestedNameSpecifier::Namespace: {
7992 NamespaceDecl *NS = ReadDeclAs<NamespaceDecl>(F, Record, Idx);
7993 NNS = NestedNameSpecifier::Create(Context, Prev, NS);
7994 break;
7995 }
7996
7997 case NestedNameSpecifier::NamespaceAlias: {
7998 NamespaceAliasDecl *Alias =ReadDeclAs<NamespaceAliasDecl>(F, Record, Idx);
7999 NNS = NestedNameSpecifier::Create(Context, Prev, Alias);
8000 break;
8001 }
8002
8003 case NestedNameSpecifier::TypeSpec:
8004 case NestedNameSpecifier::TypeSpecWithTemplate: {
8005 const Type *T = readType(F, Record, Idx).getTypePtrOrNull();
8006 if (!T)
Craig Toppera13603a2014-05-22 05:54:18 +00008007 return nullptr;
8008
Guy Benyei11169dd2012-12-18 14:30:41 +00008009 bool Template = Record[Idx++];
8010 NNS = NestedNameSpecifier::Create(Context, Prev, Template, T);
8011 break;
8012 }
8013
8014 case NestedNameSpecifier::Global: {
8015 NNS = NestedNameSpecifier::GlobalSpecifier(Context);
8016 // No associated value, and there can't be a prefix.
8017 break;
8018 }
Nikola Smiljanic67860242014-09-26 00:28:20 +00008019
8020 case NestedNameSpecifier::Super: {
8021 CXXRecordDecl *RD = ReadDeclAs<CXXRecordDecl>(F, Record, Idx);
8022 NNS = NestedNameSpecifier::SuperSpecifier(Context, RD);
8023 break;
8024 }
Guy Benyei11169dd2012-12-18 14:30:41 +00008025 }
8026 Prev = NNS;
8027 }
8028 return NNS;
8029}
8030
8031NestedNameSpecifierLoc
8032ASTReader::ReadNestedNameSpecifierLoc(ModuleFile &F, const RecordData &Record,
8033 unsigned &Idx) {
8034 unsigned N = Record[Idx++];
8035 NestedNameSpecifierLocBuilder Builder;
8036 for (unsigned I = 0; I != N; ++I) {
8037 NestedNameSpecifier::SpecifierKind Kind
8038 = (NestedNameSpecifier::SpecifierKind)Record[Idx++];
8039 switch (Kind) {
8040 case NestedNameSpecifier::Identifier: {
8041 IdentifierInfo *II = GetIdentifierInfo(F, Record, Idx);
8042 SourceRange Range = ReadSourceRange(F, Record, Idx);
8043 Builder.Extend(Context, II, Range.getBegin(), Range.getEnd());
8044 break;
8045 }
8046
8047 case NestedNameSpecifier::Namespace: {
8048 NamespaceDecl *NS = ReadDeclAs<NamespaceDecl>(F, Record, Idx);
8049 SourceRange Range = ReadSourceRange(F, Record, Idx);
8050 Builder.Extend(Context, NS, Range.getBegin(), Range.getEnd());
8051 break;
8052 }
8053
8054 case NestedNameSpecifier::NamespaceAlias: {
8055 NamespaceAliasDecl *Alias =ReadDeclAs<NamespaceAliasDecl>(F, Record, Idx);
8056 SourceRange Range = ReadSourceRange(F, Record, Idx);
8057 Builder.Extend(Context, Alias, Range.getBegin(), Range.getEnd());
8058 break;
8059 }
8060
8061 case NestedNameSpecifier::TypeSpec:
8062 case NestedNameSpecifier::TypeSpecWithTemplate: {
8063 bool Template = Record[Idx++];
8064 TypeSourceInfo *T = GetTypeSourceInfo(F, Record, Idx);
8065 if (!T)
8066 return NestedNameSpecifierLoc();
8067 SourceLocation ColonColonLoc = ReadSourceLocation(F, Record, Idx);
8068
8069 // FIXME: 'template' keyword location not saved anywhere, so we fake it.
8070 Builder.Extend(Context,
8071 Template? T->getTypeLoc().getBeginLoc() : SourceLocation(),
8072 T->getTypeLoc(), ColonColonLoc);
8073 break;
8074 }
8075
8076 case NestedNameSpecifier::Global: {
8077 SourceLocation ColonColonLoc = ReadSourceLocation(F, Record, Idx);
8078 Builder.MakeGlobal(Context, ColonColonLoc);
8079 break;
8080 }
Nikola Smiljanic67860242014-09-26 00:28:20 +00008081
8082 case NestedNameSpecifier::Super: {
8083 CXXRecordDecl *RD = ReadDeclAs<CXXRecordDecl>(F, Record, Idx);
8084 SourceRange Range = ReadSourceRange(F, Record, Idx);
8085 Builder.MakeSuper(Context, RD, Range.getBegin(), Range.getEnd());
8086 break;
8087 }
Guy Benyei11169dd2012-12-18 14:30:41 +00008088 }
8089 }
Nikola Smiljanic67860242014-09-26 00:28:20 +00008090
Guy Benyei11169dd2012-12-18 14:30:41 +00008091 return Builder.getWithLocInContext(Context);
8092}
8093
8094SourceRange
8095ASTReader::ReadSourceRange(ModuleFile &F, const RecordData &Record,
8096 unsigned &Idx) {
8097 SourceLocation beg = ReadSourceLocation(F, Record, Idx);
8098 SourceLocation end = ReadSourceLocation(F, Record, Idx);
8099 return SourceRange(beg, end);
8100}
8101
8102/// \brief Read an integral value
8103llvm::APInt ASTReader::ReadAPInt(const RecordData &Record, unsigned &Idx) {
8104 unsigned BitWidth = Record[Idx++];
8105 unsigned NumWords = llvm::APInt::getNumWords(BitWidth);
8106 llvm::APInt Result(BitWidth, NumWords, &Record[Idx]);
8107 Idx += NumWords;
8108 return Result;
8109}
8110
8111/// \brief Read a signed integral value
8112llvm::APSInt ASTReader::ReadAPSInt(const RecordData &Record, unsigned &Idx) {
8113 bool isUnsigned = Record[Idx++];
8114 return llvm::APSInt(ReadAPInt(Record, Idx), isUnsigned);
8115}
8116
8117/// \brief Read a floating-point value
Tim Northover178723a2013-01-22 09:46:51 +00008118llvm::APFloat ASTReader::ReadAPFloat(const RecordData &Record,
8119 const llvm::fltSemantics &Sem,
8120 unsigned &Idx) {
8121 return llvm::APFloat(Sem, ReadAPInt(Record, Idx));
Guy Benyei11169dd2012-12-18 14:30:41 +00008122}
8123
8124// \brief Read a string
8125std::string ASTReader::ReadString(const RecordData &Record, unsigned &Idx) {
8126 unsigned Len = Record[Idx++];
8127 std::string Result(Record.data() + Idx, Record.data() + Idx + Len);
8128 Idx += Len;
8129 return Result;
8130}
8131
Richard Smith7ed1bc92014-12-05 22:42:13 +00008132std::string ASTReader::ReadPath(ModuleFile &F, const RecordData &Record,
8133 unsigned &Idx) {
8134 std::string Filename = ReadString(Record, Idx);
8135 ResolveImportedPath(F, Filename);
8136 return Filename;
8137}
8138
Guy Benyei11169dd2012-12-18 14:30:41 +00008139VersionTuple ASTReader::ReadVersionTuple(const RecordData &Record,
8140 unsigned &Idx) {
8141 unsigned Major = Record[Idx++];
8142 unsigned Minor = Record[Idx++];
8143 unsigned Subminor = Record[Idx++];
8144 if (Minor == 0)
8145 return VersionTuple(Major);
8146 if (Subminor == 0)
8147 return VersionTuple(Major, Minor - 1);
8148 return VersionTuple(Major, Minor - 1, Subminor - 1);
8149}
8150
8151CXXTemporary *ASTReader::ReadCXXTemporary(ModuleFile &F,
8152 const RecordData &Record,
8153 unsigned &Idx) {
8154 CXXDestructorDecl *Decl = ReadDeclAs<CXXDestructorDecl>(F, Record, Idx);
8155 return CXXTemporary::Create(Context, Decl);
8156}
8157
8158DiagnosticBuilder ASTReader::Diag(unsigned DiagID) {
Argyrios Kyrtzidisdc9fdaf2013-05-24 05:44:08 +00008159 return Diag(CurrentImportLoc, DiagID);
Guy Benyei11169dd2012-12-18 14:30:41 +00008160}
8161
8162DiagnosticBuilder ASTReader::Diag(SourceLocation Loc, unsigned DiagID) {
8163 return Diags.Report(Loc, DiagID);
8164}
8165
8166/// \brief Retrieve the identifier table associated with the
8167/// preprocessor.
8168IdentifierTable &ASTReader::getIdentifierTable() {
8169 return PP.getIdentifierTable();
8170}
8171
8172/// \brief Record that the given ID maps to the given switch-case
8173/// statement.
8174void ASTReader::RecordSwitchCaseID(SwitchCase *SC, unsigned ID) {
Craig Toppera13603a2014-05-22 05:54:18 +00008175 assert((*CurrSwitchCaseStmts)[ID] == nullptr &&
Guy Benyei11169dd2012-12-18 14:30:41 +00008176 "Already have a SwitchCase with this ID");
8177 (*CurrSwitchCaseStmts)[ID] = SC;
8178}
8179
8180/// \brief Retrieve the switch-case statement with the given ID.
8181SwitchCase *ASTReader::getSwitchCaseWithID(unsigned ID) {
Craig Toppera13603a2014-05-22 05:54:18 +00008182 assert((*CurrSwitchCaseStmts)[ID] != nullptr && "No SwitchCase with this ID");
Guy Benyei11169dd2012-12-18 14:30:41 +00008183 return (*CurrSwitchCaseStmts)[ID];
8184}
8185
8186void ASTReader::ClearSwitchCaseIDs() {
8187 CurrSwitchCaseStmts->clear();
8188}
8189
8190void ASTReader::ReadComments() {
8191 std::vector<RawComment *> Comments;
Chris Lattner7fb3bef2013-01-20 00:56:42 +00008192 for (SmallVectorImpl<std::pair<BitstreamCursor,
Guy Benyei11169dd2012-12-18 14:30:41 +00008193 serialization::ModuleFile *> >::iterator
8194 I = CommentsCursors.begin(),
8195 E = CommentsCursors.end();
8196 I != E; ++I) {
Dmitri Gribenko9ee0e302014-03-27 15:40:39 +00008197 Comments.clear();
Chris Lattner7fb3bef2013-01-20 00:56:42 +00008198 BitstreamCursor &Cursor = I->first;
Guy Benyei11169dd2012-12-18 14:30:41 +00008199 serialization::ModuleFile &F = *I->second;
8200 SavedStreamPosition SavedPosition(Cursor);
8201
8202 RecordData Record;
8203 while (true) {
Chris Lattner7fb3bef2013-01-20 00:56:42 +00008204 llvm::BitstreamEntry Entry =
8205 Cursor.advanceSkippingSubblocks(BitstreamCursor::AF_DontPopBlockAtEnd);
Dmitri Gribenko9ee0e302014-03-27 15:40:39 +00008206
Chris Lattner7fb3bef2013-01-20 00:56:42 +00008207 switch (Entry.Kind) {
8208 case llvm::BitstreamEntry::SubBlock: // Handled for us already.
8209 case llvm::BitstreamEntry::Error:
8210 Error("malformed block record in AST file");
8211 return;
8212 case llvm::BitstreamEntry::EndBlock:
8213 goto NextCursor;
8214 case llvm::BitstreamEntry::Record:
8215 // The interesting case.
Guy Benyei11169dd2012-12-18 14:30:41 +00008216 break;
Guy Benyei11169dd2012-12-18 14:30:41 +00008217 }
8218
8219 // Read a record.
8220 Record.clear();
Chris Lattner0e6c9402013-01-20 02:38:54 +00008221 switch ((CommentRecordTypes)Cursor.readRecord(Entry.ID, Record)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00008222 case COMMENTS_RAW_COMMENT: {
8223 unsigned Idx = 0;
8224 SourceRange SR = ReadSourceRange(F, Record, Idx);
8225 RawComment::CommentKind Kind =
8226 (RawComment::CommentKind) Record[Idx++];
8227 bool IsTrailingComment = Record[Idx++];
8228 bool IsAlmostTrailingComment = Record[Idx++];
Dmitri Gribenkoa7d16ce2013-04-10 15:35:17 +00008229 Comments.push_back(new (Context) RawComment(
8230 SR, Kind, IsTrailingComment, IsAlmostTrailingComment,
8231 Context.getLangOpts().CommentOpts.ParseAllComments));
Guy Benyei11169dd2012-12-18 14:30:41 +00008232 break;
8233 }
8234 }
8235 }
Dmitri Gribenko9ee0e302014-03-27 15:40:39 +00008236 NextCursor:
8237 Context.Comments.addDeserializedComments(Comments);
Guy Benyei11169dd2012-12-18 14:30:41 +00008238 }
Guy Benyei11169dd2012-12-18 14:30:41 +00008239}
8240
Richard Smithcd45dbc2014-04-19 03:48:30 +00008241std::string ASTReader::getOwningModuleNameForDiagnostic(const Decl *D) {
8242 // If we know the owning module, use it.
Richard Smith42413142015-05-15 20:05:43 +00008243 if (Module *M = D->getImportedOwningModule())
Richard Smithcd45dbc2014-04-19 03:48:30 +00008244 return M->getFullModuleName();
8245
8246 // Otherwise, use the name of the top-level module the decl is within.
8247 if (ModuleFile *M = getOwningModuleFile(D))
8248 return M->ModuleName;
8249
8250 // Not from a module.
8251 return "";
8252}
8253
Guy Benyei11169dd2012-12-18 14:30:41 +00008254void ASTReader::finishPendingActions() {
Richard Smith851072e2014-05-19 20:59:20 +00008255 while (!PendingIdentifierInfos.empty() ||
8256 !PendingIncompleteDeclChains.empty() || !PendingDeclChains.empty() ||
Richard Smith2b9e3e32013-10-18 06:05:18 +00008257 !PendingMacroIDs.empty() || !PendingDeclContextInfos.empty() ||
Richard Smitha0ce9c42014-07-29 23:23:27 +00008258 !PendingUpdateRecords.empty()) {
Guy Benyei11169dd2012-12-18 14:30:41 +00008259 // If any identifiers with corresponding top-level declarations have
8260 // been loaded, load those declarations now.
Craig Topper79be4cd2013-07-05 04:33:53 +00008261 typedef llvm::DenseMap<IdentifierInfo *, SmallVector<Decl *, 2> >
8262 TopLevelDeclsMap;
8263 TopLevelDeclsMap TopLevelDecls;
8264
Guy Benyei11169dd2012-12-18 14:30:41 +00008265 while (!PendingIdentifierInfos.empty()) {
Douglas Gregor6168bd22013-02-18 15:53:43 +00008266 IdentifierInfo *II = PendingIdentifierInfos.back().first;
Richard Smithf0ae3c2d2014-03-28 17:31:23 +00008267 SmallVector<uint32_t, 4> DeclIDs =
8268 std::move(PendingIdentifierInfos.back().second);
Douglas Gregorcb15f082013-02-19 18:26:28 +00008269 PendingIdentifierInfos.pop_back();
Douglas Gregor6168bd22013-02-18 15:53:43 +00008270
8271 SetGloballyVisibleDecls(II, DeclIDs, &TopLevelDecls[II]);
Guy Benyei11169dd2012-12-18 14:30:41 +00008272 }
Richard Smithf0ae3c2d2014-03-28 17:31:23 +00008273
Richard Smith851072e2014-05-19 20:59:20 +00008274 // For each decl chain that we wanted to complete while deserializing, mark
8275 // it as "still needs to be completed".
8276 for (unsigned I = 0; I != PendingIncompleteDeclChains.size(); ++I) {
8277 markIncompleteDeclChain(PendingIncompleteDeclChains[I]);
8278 }
8279 PendingIncompleteDeclChains.clear();
8280
Guy Benyei11169dd2012-12-18 14:30:41 +00008281 // Load pending declaration chains.
Richard Smithd8a83712015-08-22 01:47:18 +00008282 for (unsigned I = 0; I != PendingDeclChains.size(); ++I)
Richard Smithd61d4ac2015-08-22 20:13:39 +00008283 loadPendingDeclChain(PendingDeclChains[I].first, PendingDeclChains[I].second);
Guy Benyei11169dd2012-12-18 14:30:41 +00008284 PendingDeclChains.clear();
8285
Douglas Gregor6168bd22013-02-18 15:53:43 +00008286 // Make the most recent of the top-level declarations visible.
Craig Topper79be4cd2013-07-05 04:33:53 +00008287 for (TopLevelDeclsMap::iterator TLD = TopLevelDecls.begin(),
8288 TLDEnd = TopLevelDecls.end(); TLD != TLDEnd; ++TLD) {
Douglas Gregor6168bd22013-02-18 15:53:43 +00008289 IdentifierInfo *II = TLD->first;
8290 for (unsigned I = 0, N = TLD->second.size(); I != N; ++I) {
Argyrios Kyrtzidise5edbf92013-04-26 21:33:35 +00008291 pushExternalDeclIntoScope(cast<NamedDecl>(TLD->second[I]), II);
Douglas Gregor6168bd22013-02-18 15:53:43 +00008292 }
8293 }
8294
Guy Benyei11169dd2012-12-18 14:30:41 +00008295 // Load any pending macro definitions.
8296 for (unsigned I = 0; I != PendingMacroIDs.size(); ++I) {
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00008297 IdentifierInfo *II = PendingMacroIDs.begin()[I].first;
8298 SmallVector<PendingMacroInfo, 2> GlobalIDs;
8299 GlobalIDs.swap(PendingMacroIDs.begin()[I].second);
8300 // Initialize the macro history from chained-PCHs ahead of module imports.
Richard Smith49f906a2014-03-01 00:08:04 +00008301 for (unsigned IDIdx = 0, NumIDs = GlobalIDs.size(); IDIdx != NumIDs;
Argyrios Kyrtzidis719736c2013-01-19 03:14:56 +00008302 ++IDIdx) {
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00008303 const PendingMacroInfo &Info = GlobalIDs[IDIdx];
Richard Smithe842a472014-10-22 02:05:46 +00008304 if (Info.M->Kind != MK_ImplicitModule &&
8305 Info.M->Kind != MK_ExplicitModule)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00008306 resolvePendingMacro(II, Info);
8307 }
8308 // Handle module imports.
Richard Smith49f906a2014-03-01 00:08:04 +00008309 for (unsigned IDIdx = 0, NumIDs = GlobalIDs.size(); IDIdx != NumIDs;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00008310 ++IDIdx) {
8311 const PendingMacroInfo &Info = GlobalIDs[IDIdx];
Richard Smithe842a472014-10-22 02:05:46 +00008312 if (Info.M->Kind == MK_ImplicitModule ||
8313 Info.M->Kind == MK_ExplicitModule)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00008314 resolvePendingMacro(II, Info);
Guy Benyei11169dd2012-12-18 14:30:41 +00008315 }
8316 }
8317 PendingMacroIDs.clear();
Argyrios Kyrtzidis83a6e3b2013-02-16 00:48:59 +00008318
8319 // Wire up the DeclContexts for Decls that we delayed setting until
8320 // recursive loading is completed.
8321 while (!PendingDeclContextInfos.empty()) {
8322 PendingDeclContextInfo Info = PendingDeclContextInfos.front();
8323 PendingDeclContextInfos.pop_front();
8324 DeclContext *SemaDC = cast<DeclContext>(GetDecl(Info.SemaDC));
8325 DeclContext *LexicalDC = cast<DeclContext>(GetDecl(Info.LexicalDC));
8326 Info.D->setDeclContextsImpl(SemaDC, LexicalDC, getContext());
8327 }
Richard Smith2b9e3e32013-10-18 06:05:18 +00008328
Richard Smithd1c46742014-04-30 02:24:17 +00008329 // Perform any pending declaration updates.
Richard Smithd6db68c2014-08-07 20:58:41 +00008330 while (!PendingUpdateRecords.empty()) {
Richard Smithd1c46742014-04-30 02:24:17 +00008331 auto Update = PendingUpdateRecords.pop_back_val();
8332 ReadingKindTracker ReadingKind(Read_Decl, *this);
8333 loadDeclUpdateRecords(Update.first, Update.second);
8334 }
Guy Benyei11169dd2012-12-18 14:30:41 +00008335 }
Richard Smith8a639892015-01-24 01:07:20 +00008336
8337 // At this point, all update records for loaded decls are in place, so any
8338 // fake class definitions should have become real.
8339 assert(PendingFakeDefinitionData.empty() &&
8340 "faked up a class definition but never saw the real one");
8341
Guy Benyei11169dd2012-12-18 14:30:41 +00008342 // If we deserialized any C++ or Objective-C class definitions, any
8343 // Objective-C protocol definitions, or any redeclarable templates, make sure
8344 // that all redeclarations point to the definitions. Note that this can only
8345 // happen now, after the redeclaration chains have been fully wired.
Craig Topperc6914d02014-08-25 04:15:02 +00008346 for (Decl *D : PendingDefinitions) {
8347 if (TagDecl *TD = dyn_cast<TagDecl>(D)) {
Richard Smith5b21db82014-04-23 18:20:42 +00008348 if (const TagType *TagT = dyn_cast<TagType>(TD->getTypeForDecl())) {
Guy Benyei11169dd2012-12-18 14:30:41 +00008349 // Make sure that the TagType points at the definition.
8350 const_cast<TagType*>(TagT)->decl = TD;
8351 }
Richard Smith8ce51082015-03-11 01:44:51 +00008352
Craig Topperc6914d02014-08-25 04:15:02 +00008353 if (auto RD = dyn_cast<CXXRecordDecl>(D)) {
Richard Smith8ce51082015-03-11 01:44:51 +00008354 for (auto *R = getMostRecentExistingDecl(RD); R;
8355 R = R->getPreviousDecl()) {
8356 assert((R == D) ==
8357 cast<CXXRecordDecl>(R)->isThisDeclarationADefinition() &&
Richard Smith2c381642014-08-27 23:11:59 +00008358 "declaration thinks it's the definition but it isn't");
Aaron Ballman86c93902014-03-06 23:45:36 +00008359 cast<CXXRecordDecl>(R)->DefinitionData = RD->DefinitionData;
Richard Smith2c381642014-08-27 23:11:59 +00008360 }
Guy Benyei11169dd2012-12-18 14:30:41 +00008361 }
8362
8363 continue;
8364 }
Richard Smith8ce51082015-03-11 01:44:51 +00008365
Craig Topperc6914d02014-08-25 04:15:02 +00008366 if (auto ID = dyn_cast<ObjCInterfaceDecl>(D)) {
Guy Benyei11169dd2012-12-18 14:30:41 +00008367 // Make sure that the ObjCInterfaceType points at the definition.
8368 const_cast<ObjCInterfaceType *>(cast<ObjCInterfaceType>(ID->TypeForDecl))
8369 ->Decl = ID;
Richard Smith8ce51082015-03-11 01:44:51 +00008370
8371 for (auto *R = getMostRecentExistingDecl(ID); R; R = R->getPreviousDecl())
8372 cast<ObjCInterfaceDecl>(R)->Data = ID->Data;
8373
Guy Benyei11169dd2012-12-18 14:30:41 +00008374 continue;
8375 }
Richard Smith8ce51082015-03-11 01:44:51 +00008376
Craig Topperc6914d02014-08-25 04:15:02 +00008377 if (auto PD = dyn_cast<ObjCProtocolDecl>(D)) {
Richard Smith8ce51082015-03-11 01:44:51 +00008378 for (auto *R = getMostRecentExistingDecl(PD); R; R = R->getPreviousDecl())
8379 cast<ObjCProtocolDecl>(R)->Data = PD->Data;
8380
Guy Benyei11169dd2012-12-18 14:30:41 +00008381 continue;
8382 }
Richard Smith8ce51082015-03-11 01:44:51 +00008383
Craig Topperc6914d02014-08-25 04:15:02 +00008384 auto RTD = cast<RedeclarableTemplateDecl>(D)->getCanonicalDecl();
Richard Smith8ce51082015-03-11 01:44:51 +00008385 for (auto *R = getMostRecentExistingDecl(RTD); R; R = R->getPreviousDecl())
8386 cast<RedeclarableTemplateDecl>(R)->Common = RTD->Common;
Guy Benyei11169dd2012-12-18 14:30:41 +00008387 }
8388 PendingDefinitions.clear();
8389
8390 // Load the bodies of any functions or methods we've encountered. We do
8391 // this now (delayed) so that we can be sure that the declaration chains
Richard Smithb9fa9962015-08-21 03:04:33 +00008392 // have been fully wired up (hasBody relies on this).
8393 // FIXME: We shouldn't require complete redeclaration chains here.
Guy Benyei11169dd2012-12-18 14:30:41 +00008394 for (PendingBodiesMap::iterator PB = PendingBodies.begin(),
8395 PBEnd = PendingBodies.end();
8396 PB != PBEnd; ++PB) {
8397 if (FunctionDecl *FD = dyn_cast<FunctionDecl>(PB->first)) {
8398 // FIXME: Check for =delete/=default?
8399 // FIXME: Complain about ODR violations here?
8400 if (!getContext().getLangOpts().Modules || !FD->hasBody())
8401 FD->setLazyBody(PB->second);
8402 continue;
8403 }
8404
8405 ObjCMethodDecl *MD = cast<ObjCMethodDecl>(PB->first);
8406 if (!getContext().getLangOpts().Modules || !MD->hasBody())
8407 MD->setLazyBody(PB->second);
8408 }
8409 PendingBodies.clear();
Richard Smith42413142015-05-15 20:05:43 +00008410
8411 // Do some cleanup.
8412 for (auto *ND : PendingMergedDefinitionsToDeduplicate)
8413 getContext().deduplicateMergedDefinitonsFor(ND);
8414 PendingMergedDefinitionsToDeduplicate.clear();
Richard Smitha0ce9c42014-07-29 23:23:27 +00008415}
8416
8417void ASTReader::diagnoseOdrViolations() {
Richard Smithbb853c72014-08-13 01:23:33 +00008418 if (PendingOdrMergeFailures.empty() && PendingOdrMergeChecks.empty())
8419 return;
8420
Richard Smitha0ce9c42014-07-29 23:23:27 +00008421 // Trigger the import of the full definition of each class that had any
8422 // odr-merging problems, so we can produce better diagnostics for them.
Richard Smithbb853c72014-08-13 01:23:33 +00008423 // These updates may in turn find and diagnose some ODR failures, so take
8424 // ownership of the set first.
8425 auto OdrMergeFailures = std::move(PendingOdrMergeFailures);
8426 PendingOdrMergeFailures.clear();
8427 for (auto &Merge : OdrMergeFailures) {
Richard Smitha0ce9c42014-07-29 23:23:27 +00008428 Merge.first->buildLookup();
8429 Merge.first->decls_begin();
8430 Merge.first->bases_begin();
8431 Merge.first->vbases_begin();
8432 for (auto *RD : Merge.second) {
8433 RD->decls_begin();
8434 RD->bases_begin();
8435 RD->vbases_begin();
8436 }
8437 }
8438
8439 // For each declaration from a merged context, check that the canonical
8440 // definition of that context also contains a declaration of the same
8441 // entity.
8442 //
8443 // Caution: this loop does things that might invalidate iterators into
8444 // PendingOdrMergeChecks. Don't turn this into a range-based for loop!
8445 while (!PendingOdrMergeChecks.empty()) {
8446 NamedDecl *D = PendingOdrMergeChecks.pop_back_val();
8447
8448 // FIXME: Skip over implicit declarations for now. This matters for things
8449 // like implicitly-declared special member functions. This isn't entirely
8450 // correct; we can end up with multiple unmerged declarations of the same
8451 // implicit entity.
8452 if (D->isImplicit())
8453 continue;
8454
8455 DeclContext *CanonDef = D->getDeclContext();
Richard Smitha0ce9c42014-07-29 23:23:27 +00008456
8457 bool Found = false;
8458 const Decl *DCanon = D->getCanonicalDecl();
8459
Richard Smith01bdb7a2014-08-28 05:44:07 +00008460 for (auto RI : D->redecls()) {
8461 if (RI->getLexicalDeclContext() == CanonDef) {
8462 Found = true;
8463 break;
8464 }
8465 }
8466 if (Found)
8467 continue;
8468
Richard Smith0f4e2c42015-08-06 04:23:48 +00008469 // Quick check failed, time to do the slow thing. Note, we can't just
8470 // look up the name of D in CanonDef here, because the member that is
8471 // in CanonDef might not be found by name lookup (it might have been
8472 // replaced by a more recent declaration in the lookup table), and we
8473 // can't necessarily find it in the redeclaration chain because it might
8474 // be merely mergeable, not redeclarable.
Richard Smitha0ce9c42014-07-29 23:23:27 +00008475 llvm::SmallVector<const NamedDecl*, 4> Candidates;
Richard Smith0f4e2c42015-08-06 04:23:48 +00008476 for (auto *CanonMember : CanonDef->decls()) {
8477 if (CanonMember->getCanonicalDecl() == DCanon) {
8478 // This can happen if the declaration is merely mergeable and not
8479 // actually redeclarable (we looked for redeclarations earlier).
8480 //
8481 // FIXME: We should be able to detect this more efficiently, without
8482 // pulling in all of the members of CanonDef.
8483 Found = true;
8484 break;
Richard Smitha0ce9c42014-07-29 23:23:27 +00008485 }
Richard Smith0f4e2c42015-08-06 04:23:48 +00008486 if (auto *ND = dyn_cast<NamedDecl>(CanonMember))
8487 if (ND->getDeclName() == D->getDeclName())
8488 Candidates.push_back(ND);
Richard Smitha0ce9c42014-07-29 23:23:27 +00008489 }
8490
8491 if (!Found) {
Richard Smithd08aeb62014-08-28 01:33:39 +00008492 // The AST doesn't like TagDecls becoming invalid after they've been
8493 // completed. We only really need to mark FieldDecls as invalid here.
8494 if (!isa<TagDecl>(D))
8495 D->setInvalidDecl();
Richard Smith4ab3dbd2015-02-13 22:43:51 +00008496
8497 // Ensure we don't accidentally recursively enter deserialization while
8498 // we're producing our diagnostic.
8499 Deserializing RecursionGuard(this);
Richard Smitha0ce9c42014-07-29 23:23:27 +00008500
8501 std::string CanonDefModule =
8502 getOwningModuleNameForDiagnostic(cast<Decl>(CanonDef));
8503 Diag(D->getLocation(), diag::err_module_odr_violation_missing_decl)
8504 << D << getOwningModuleNameForDiagnostic(D)
8505 << CanonDef << CanonDefModule.empty() << CanonDefModule;
8506
8507 if (Candidates.empty())
8508 Diag(cast<Decl>(CanonDef)->getLocation(),
8509 diag::note_module_odr_violation_no_possible_decls) << D;
8510 else {
8511 for (unsigned I = 0, N = Candidates.size(); I != N; ++I)
8512 Diag(Candidates[I]->getLocation(),
8513 diag::note_module_odr_violation_possible_decl)
8514 << Candidates[I];
8515 }
8516
8517 DiagnosedOdrMergeFailures.insert(CanonDef);
8518 }
8519 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00008520
Richard Smith4ab3dbd2015-02-13 22:43:51 +00008521 if (OdrMergeFailures.empty())
8522 return;
8523
8524 // Ensure we don't accidentally recursively enter deserialization while
8525 // we're producing our diagnostics.
8526 Deserializing RecursionGuard(this);
8527
Richard Smithcd45dbc2014-04-19 03:48:30 +00008528 // Issue any pending ODR-failure diagnostics.
Richard Smithbb853c72014-08-13 01:23:33 +00008529 for (auto &Merge : OdrMergeFailures) {
Richard Smitha0ce9c42014-07-29 23:23:27 +00008530 // If we've already pointed out a specific problem with this class, don't
8531 // bother issuing a general "something's different" diagnostic.
David Blaikie82e95a32014-11-19 07:49:47 +00008532 if (!DiagnosedOdrMergeFailures.insert(Merge.first).second)
Richard Smithcd45dbc2014-04-19 03:48:30 +00008533 continue;
8534
8535 bool Diagnosed = false;
8536 for (auto *RD : Merge.second) {
8537 // Multiple different declarations got merged together; tell the user
8538 // where they came from.
8539 if (Merge.first != RD) {
8540 // FIXME: Walk the definition, figure out what's different,
8541 // and diagnose that.
8542 if (!Diagnosed) {
8543 std::string Module = getOwningModuleNameForDiagnostic(Merge.first);
8544 Diag(Merge.first->getLocation(),
8545 diag::err_module_odr_violation_different_definitions)
8546 << Merge.first << Module.empty() << Module;
8547 Diagnosed = true;
8548 }
8549
8550 Diag(RD->getLocation(),
8551 diag::note_module_odr_violation_different_definitions)
8552 << getOwningModuleNameForDiagnostic(RD);
8553 }
8554 }
8555
8556 if (!Diagnosed) {
8557 // All definitions are updates to the same declaration. This happens if a
8558 // module instantiates the declaration of a class template specialization
8559 // and two or more other modules instantiate its definition.
8560 //
8561 // FIXME: Indicate which modules had instantiations of this definition.
8562 // FIXME: How can this even happen?
8563 Diag(Merge.first->getLocation(),
8564 diag::err_module_odr_violation_different_instantiations)
8565 << Merge.first;
8566 }
8567 }
Guy Benyei11169dd2012-12-18 14:30:41 +00008568}
8569
Richard Smithce18a182015-07-14 00:26:00 +00008570void ASTReader::StartedDeserializing() {
8571 if (++NumCurrentElementsDeserializing == 1 && ReadTimer.get())
8572 ReadTimer->startTimer();
8573}
8574
Guy Benyei11169dd2012-12-18 14:30:41 +00008575void ASTReader::FinishedDeserializing() {
8576 assert(NumCurrentElementsDeserializing &&
8577 "FinishedDeserializing not paired with StartedDeserializing");
8578 if (NumCurrentElementsDeserializing == 1) {
8579 // We decrease NumCurrentElementsDeserializing only after pending actions
8580 // are finished, to avoid recursively re-calling finishPendingActions().
8581 finishPendingActions();
8582 }
8583 --NumCurrentElementsDeserializing;
8584
Richard Smitha0ce9c42014-07-29 23:23:27 +00008585 if (NumCurrentElementsDeserializing == 0) {
Richard Smith9e2341d2015-03-23 03:25:59 +00008586 // Propagate exception specification updates along redeclaration chains.
Richard Smith7226f2a2015-03-23 19:54:56 +00008587 while (!PendingExceptionSpecUpdates.empty()) {
8588 auto Updates = std::move(PendingExceptionSpecUpdates);
8589 PendingExceptionSpecUpdates.clear();
8590 for (auto Update : Updates) {
8591 auto *FPT = Update.second->getType()->castAs<FunctionProtoType>();
Richard Smith1d0f1992015-08-19 21:09:32 +00008592 auto ESI = FPT->getExtProtoInfo().ExceptionSpec;
Richard Smithd88a7f12015-09-01 20:35:42 +00008593 if (auto *Listener = Context.getASTMutationListener())
8594 Listener->ResolvedExceptionSpec(cast<FunctionDecl>(Update.second));
Richard Smith1d0f1992015-08-19 21:09:32 +00008595 for (auto *Redecl : Update.second->redecls())
8596 Context.adjustExceptionSpec(cast<FunctionDecl>(Redecl), ESI);
Richard Smith7226f2a2015-03-23 19:54:56 +00008597 }
Richard Smith9e2341d2015-03-23 03:25:59 +00008598 }
8599
Richard Smithce18a182015-07-14 00:26:00 +00008600 if (ReadTimer)
8601 ReadTimer->stopTimer();
8602
Richard Smith0f4e2c42015-08-06 04:23:48 +00008603 diagnoseOdrViolations();
8604
Richard Smith04d05b52014-03-23 00:27:18 +00008605 // We are not in recursive loading, so it's safe to pass the "interesting"
8606 // decls to the consumer.
Richard Smitha0ce9c42014-07-29 23:23:27 +00008607 if (Consumer)
8608 PassInterestingDeclsToConsumer();
Guy Benyei11169dd2012-12-18 14:30:41 +00008609 }
8610}
8611
Argyrios Kyrtzidise5edbf92013-04-26 21:33:35 +00008612void ASTReader::pushExternalDeclIntoScope(NamedDecl *D, DeclarationName Name) {
Richard Smith9e2341d2015-03-23 03:25:59 +00008613 if (IdentifierInfo *II = Name.getAsIdentifierInfo()) {
8614 // Remove any fake results before adding any real ones.
8615 auto It = PendingFakeLookupResults.find(II);
8616 if (It != PendingFakeLookupResults.end()) {
Richard Smitha534a312015-07-21 23:54:07 +00008617 for (auto *ND : It->second)
Richard Smith9e2341d2015-03-23 03:25:59 +00008618 SemaObj->IdResolver.RemoveDecl(ND);
Ben Langmuireb8bd2d2015-04-10 22:25:42 +00008619 // FIXME: this works around module+PCH performance issue.
8620 // Rather than erase the result from the map, which is O(n), just clear
8621 // the vector of NamedDecls.
8622 It->second.clear();
Richard Smith9e2341d2015-03-23 03:25:59 +00008623 }
8624 }
Argyrios Kyrtzidise5edbf92013-04-26 21:33:35 +00008625
8626 if (SemaObj->IdResolver.tryAddTopLevelDecl(D, Name) && SemaObj->TUScope) {
8627 SemaObj->TUScope->AddDecl(D);
8628 } else if (SemaObj->TUScope) {
8629 // Adding the decl to IdResolver may have failed because it was already in
8630 // (even though it was not added in scope). If it is already in, make sure
8631 // it gets in the scope as well.
8632 if (std::find(SemaObj->IdResolver.begin(Name),
8633 SemaObj->IdResolver.end(), D) != SemaObj->IdResolver.end())
8634 SemaObj->TUScope->AddDecl(D);
8635 }
8636}
8637
Douglas Gregor6623e1f2015-11-03 18:33:07 +00008638ASTReader::ASTReader(
8639 Preprocessor &PP, ASTContext &Context,
8640 const PCHContainerReader &PCHContainerRdr,
8641 ArrayRef<IntrusiveRefCntPtr<ModuleFileExtension>> Extensions,
8642 StringRef isysroot, bool DisableValidation,
8643 bool AllowASTWithCompilerErrors,
8644 bool AllowConfigurationMismatch, bool ValidateSystemInputs,
8645 bool UseGlobalIndex,
8646 std::unique_ptr<llvm::Timer> ReadTimer)
Craig Toppera13603a2014-05-22 05:54:18 +00008647 : Listener(new PCHValidator(PP, *this)), DeserializationListener(nullptr),
Nico Weber824285e2014-05-08 04:26:47 +00008648 OwnsDeserializationListener(false), SourceMgr(PP.getSourceManager()),
Adrian Prantlfb2398d2015-07-17 01:19:54 +00008649 FileMgr(PP.getFileManager()), PCHContainerRdr(PCHContainerRdr),
Adrian Prantlbb165fb2015-06-20 18:53:08 +00008650 Diags(PP.getDiagnostics()), SemaObj(nullptr), PP(PP), Context(Context),
Adrian Prantlfb2398d2015-07-17 01:19:54 +00008651 Consumer(nullptr), ModuleMgr(PP.getFileManager(), PCHContainerRdr),
Richard Smithce18a182015-07-14 00:26:00 +00008652 ReadTimer(std::move(ReadTimer)),
Nico Weber779355f2016-03-02 23:22:00 +00008653 PragmaMSStructState(-1),
Nico Weber42932312016-03-03 00:17:35 +00008654 PragmaMSPointersToMembersState(-1),
Adrian Prantlbb165fb2015-06-20 18:53:08 +00008655 isysroot(isysroot), DisableValidation(DisableValidation),
Nico Weber824285e2014-05-08 04:26:47 +00008656 AllowASTWithCompilerErrors(AllowASTWithCompilerErrors),
8657 AllowConfigurationMismatch(AllowConfigurationMismatch),
8658 ValidateSystemInputs(ValidateSystemInputs),
8659 UseGlobalIndex(UseGlobalIndex), TriedLoadingGlobalIndex(false),
Adrian Prantlbb165fb2015-06-20 18:53:08 +00008660 CurrSwitchCaseStmts(&SwitchCaseStmts), NumSLocEntriesRead(0),
8661 TotalNumSLocEntries(0), NumStatementsRead(0), TotalNumStatements(0),
8662 NumMacrosRead(0), TotalNumMacros(0), NumIdentifierLookups(0),
8663 NumIdentifierLookupHits(0), NumSelectorsRead(0),
Nico Weber824285e2014-05-08 04:26:47 +00008664 NumMethodPoolEntriesRead(0), NumMethodPoolLookups(0),
8665 NumMethodPoolHits(0), NumMethodPoolTableLookups(0),
8666 NumMethodPoolTableHits(0), TotalNumMethodPoolEntries(0),
8667 NumLexicalDeclContextsRead(0), TotalLexicalDeclContexts(0),
8668 NumVisibleDeclContextsRead(0), TotalVisibleDeclContexts(0),
8669 TotalModulesSizeInBits(0), NumCurrentElementsDeserializing(0),
Richard Smithc2bb8182015-03-24 06:36:48 +00008670 PassingDeclsToConsumer(false), ReadingKind(Read_None) {
Guy Benyei11169dd2012-12-18 14:30:41 +00008671 SourceMgr.setExternalSLocEntrySource(this);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00008672
8673 for (const auto &Ext : Extensions) {
8674 auto BlockName = Ext->getExtensionMetadata().BlockName;
8675 auto Known = ModuleFileExtensions.find(BlockName);
8676 if (Known != ModuleFileExtensions.end()) {
8677 Diags.Report(diag::warn_duplicate_module_file_extension)
8678 << BlockName;
8679 continue;
8680 }
8681
8682 ModuleFileExtensions.insert({BlockName, Ext});
8683 }
Guy Benyei11169dd2012-12-18 14:30:41 +00008684}
8685
8686ASTReader::~ASTReader() {
Nico Weber824285e2014-05-08 04:26:47 +00008687 if (OwnsDeserializationListener)
8688 delete DeserializationListener;
Guy Benyei11169dd2012-12-18 14:30:41 +00008689}