clang  10.0.0svn
ASTReader.h
Go to the documentation of this file.
1 //===- ASTReader.h - AST File Reader ----------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines the ASTReader class, which reads AST files.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_CLANG_SERIALIZATION_ASTREADER_H
14 #define LLVM_CLANG_SERIALIZATION_ASTREADER_H
15 
16 #include "clang/AST/DeclCXX.h"
17 #include "clang/AST/DeclObjC.h"
20 #include "clang/AST/OpenMPClause.h"
21 #include "clang/AST/TemplateBase.h"
22 #include "clang/AST/TemplateName.h"
23 #include "clang/AST/Type.h"
24 #include "clang/Basic/Diagnostic.h"
27 #include "clang/Basic/Module.h"
30 #include "clang/Basic/Version.h"
32 #include "clang/Lex/HeaderSearch.h"
34 #include "clang/Lex/Token.h"
42 #include "llvm/ADT/APFloat.h"
43 #include "llvm/ADT/APInt.h"
44 #include "llvm/ADT/APSInt.h"
45 #include "llvm/ADT/ArrayRef.h"
46 #include "llvm/ADT/DenseMap.h"
47 #include "llvm/ADT/DenseSet.h"
48 #include "llvm/ADT/IntrusiveRefCntPtr.h"
49 #include "llvm/ADT/MapVector.h"
50 #include "llvm/ADT/Optional.h"
51 #include "llvm/ADT/STLExtras.h"
52 #include "llvm/ADT/SetVector.h"
53 #include "llvm/ADT/SmallPtrSet.h"
54 #include "llvm/ADT/SmallVector.h"
55 #include "llvm/ADT/StringMap.h"
56 #include "llvm/ADT/StringRef.h"
57 #include "llvm/ADT/iterator.h"
58 #include "llvm/ADT/iterator_range.h"
59 #include "llvm/Bitstream/BitstreamReader.h"
60 #include "llvm/Support/Casting.h"
61 #include "llvm/Support/Endian.h"
62 #include "llvm/Support/MemoryBuffer.h"
63 #include "llvm/Support/Timer.h"
64 #include "llvm/Support/VersionTuple.h"
65 #include <cassert>
66 #include <cstddef>
67 #include <cstdint>
68 #include <ctime>
69 #include <deque>
70 #include <memory>
71 #include <set>
72 #include <string>
73 #include <utility>
74 #include <vector>
75 
76 namespace clang {
77 
78 class ASTConsumer;
79 class ASTContext;
80 class ASTDeserializationListener;
81 class ASTReader;
82 class ASTRecordReader;
83 class CXXTemporary;
84 class Decl;
85 class DeclaratorDecl;
86 class DeclContext;
87 class EnumDecl;
88 class Expr;
89 class FieldDecl;
90 class FileEntry;
91 class FileManager;
92 class FileSystemOptions;
93 class FunctionDecl;
94 class GlobalModuleIndex;
95 struct HeaderFileInfo;
96 class HeaderSearchOptions;
97 class LangOptions;
98 class LazyASTUnresolvedSet;
99 class MacroInfo;
100 class InMemoryModuleCache;
101 class NamedDecl;
102 class NamespaceDecl;
103 class ObjCCategoryDecl;
104 class ObjCInterfaceDecl;
105 class PCHContainerReader;
106 class Preprocessor;
107 class PreprocessorOptions;
108 struct QualifierInfo;
109 class Sema;
110 class SourceManager;
111 class Stmt;
112 class SwitchCase;
113 class TargetOptions;
114 class TemplateParameterList;
115 class TypedefNameDecl;
116 class TypeSourceInfo;
117 class ValueDecl;
118 class VarDecl;
119 
120 /// Abstract interface for callback invocations by the ASTReader.
121 ///
122 /// While reading an AST file, the ASTReader will call the methods of the
123 /// listener to pass on specific information. Some of the listener methods can
124 /// return true to indicate to the ASTReader that the information (and
125 /// consequently the AST file) is invalid.
127 public:
128  virtual ~ASTReaderListener();
129 
130  /// Receives the full Clang version information.
131  ///
132  /// \returns true to indicate that the version is invalid. Subclasses should
133  /// generally defer to this implementation.
134  virtual bool ReadFullVersionInformation(StringRef FullVersion) {
135  return FullVersion != getClangFullRepositoryVersion();
136  }
137 
138  virtual void ReadModuleName(StringRef ModuleName) {}
139  virtual void ReadModuleMapFile(StringRef ModuleMapPath) {}
140 
141  /// Receives the language options.
142  ///
143  /// \returns true to indicate the options are invalid or false otherwise.
144  virtual bool ReadLanguageOptions(const LangOptions &LangOpts,
145  bool Complain,
146  bool AllowCompatibleDifferences) {
147  return false;
148  }
149 
150  /// Receives the target options.
151  ///
152  /// \returns true to indicate the target options are invalid, or false
153  /// otherwise.
154  virtual bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
155  bool AllowCompatibleDifferences) {
156  return false;
157  }
158 
159  /// Receives the diagnostic options.
160  ///
161  /// \returns true to indicate the diagnostic options are invalid, or false
162  /// otherwise.
163  virtual bool
165  bool Complain) {
166  return false;
167  }
168 
169  /// Receives the file system options.
170  ///
171  /// \returns true to indicate the file system options are invalid, or false
172  /// otherwise.
173  virtual bool ReadFileSystemOptions(const FileSystemOptions &FSOpts,
174  bool Complain) {
175  return false;
176  }
177 
178  /// Receives the header search options.
179  ///
180  /// \returns true to indicate the header search options are invalid, or false
181  /// otherwise.
182  virtual bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
183  StringRef SpecificModuleCachePath,
184  bool Complain) {
185  return false;
186  }
187 
188  /// Receives the preprocessor options.
189  ///
190  /// \param SuggestedPredefines Can be filled in with the set of predefines
191  /// that are suggested by the preprocessor options. Typically only used when
192  /// loading a precompiled header.
193  ///
194  /// \returns true to indicate the preprocessor options are invalid, or false
195  /// otherwise.
196  virtual bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
197  bool Complain,
198  std::string &SuggestedPredefines) {
199  return false;
200  }
201 
202  /// Receives __COUNTER__ value.
203  virtual void ReadCounter(const serialization::ModuleFile &M,
204  unsigned Value) {}
205 
206  /// This is called for each AST file loaded.
207  virtual void visitModuleFile(StringRef Filename,
209 
210  /// Returns true if this \c ASTReaderListener wants to receive the
211  /// input files of the AST file via \c visitInputFile, false otherwise.
212  virtual bool needsInputFileVisitation() { return false; }
213 
214  /// Returns true if this \c ASTReaderListener wants to receive the
215  /// system input files of the AST file via \c visitInputFile, false otherwise.
216  virtual bool needsSystemInputFileVisitation() { return false; }
217 
218  /// if \c needsInputFileVisitation returns true, this is called for
219  /// each non-system input file of the AST File. If
220  /// \c needsSystemInputFileVisitation is true, then it is called for all
221  /// system input files as well.
222  ///
223  /// \returns true to continue receiving the next input file, false to stop.
224  virtual bool visitInputFile(StringRef Filename, bool isSystem,
225  bool isOverridden, bool isExplicitModule) {
226  return true;
227  }
228 
229  /// Returns true if this \c ASTReaderListener wants to receive the
230  /// imports of the AST file via \c visitImport, false otherwise.
231  virtual bool needsImportVisitation() const { return false; }
232 
233  /// If needsImportVisitation returns \c true, this is called for each
234  /// AST file imported by this AST file.
235  virtual void visitImport(StringRef ModuleName, StringRef Filename) {}
236 
237  /// Indicates that a particular module file extension has been read.
239  const ModuleFileExtensionMetadata &Metadata) {}
240 };
241 
242 /// Simple wrapper class for chaining listeners.
244  std::unique_ptr<ASTReaderListener> First;
245  std::unique_ptr<ASTReaderListener> Second;
246 
247 public:
248  /// Takes ownership of \p First and \p Second.
249  ChainedASTReaderListener(std::unique_ptr<ASTReaderListener> First,
250  std::unique_ptr<ASTReaderListener> Second)
251  : First(std::move(First)), Second(std::move(Second)) {}
252 
253  std::unique_ptr<ASTReaderListener> takeFirst() { return std::move(First); }
254  std::unique_ptr<ASTReaderListener> takeSecond() { return std::move(Second); }
255 
256  bool ReadFullVersionInformation(StringRef FullVersion) override;
257  void ReadModuleName(StringRef ModuleName) override;
258  void ReadModuleMapFile(StringRef ModuleMapPath) override;
259  bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
260  bool AllowCompatibleDifferences) override;
261  bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
262  bool AllowCompatibleDifferences) override;
264  bool Complain) override;
265  bool ReadFileSystemOptions(const FileSystemOptions &FSOpts,
266  bool Complain) override;
267 
268  bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
269  StringRef SpecificModuleCachePath,
270  bool Complain) override;
271  bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts,
272  bool Complain,
273  std::string &SuggestedPredefines) override;
274 
275  void ReadCounter(const serialization::ModuleFile &M, unsigned Value) override;
276  bool needsInputFileVisitation() override;
277  bool needsSystemInputFileVisitation() override;
278  void visitModuleFile(StringRef Filename,
280  bool visitInputFile(StringRef Filename, bool isSystem,
281  bool isOverridden, bool isExplicitModule) override;
283  const ModuleFileExtensionMetadata &Metadata) override;
284 };
285 
286 /// ASTReaderListener implementation to validate the information of
287 /// the PCH file against an initialized Preprocessor.
289  Preprocessor &PP;
290  ASTReader &Reader;
291 
292 public:
294  : PP(PP), Reader(Reader) {}
295 
296  bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain,
297  bool AllowCompatibleDifferences) override;
298  bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain,
299  bool AllowCompatibleDifferences) override;
301  bool Complain) override;
302  bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts, bool Complain,
303  std::string &SuggestedPredefines) override;
304  bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts,
305  StringRef SpecificModuleCachePath,
306  bool Complain) override;
307  void ReadCounter(const serialization::ModuleFile &M, unsigned Value) override;
308 
309 private:
310  void Error(const char *Msg);
311 };
312 
313 /// ASTReaderListenter implementation to set SuggestedPredefines of
314 /// ASTReader which is required to use a pch file. This is the replacement
315 /// of PCHValidator or SimplePCHValidator when using a pch file without
316 /// validating it.
318  Preprocessor &PP;
319 
320 public:
322 
323  bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts, bool Complain,
324  std::string &SuggestedPredefines) override;
325 };
326 
327 namespace serialization {
328 
329 class ReadMethodPoolVisitor;
330 
331 namespace reader {
332 
334 
335 /// The on-disk hash table(s) used for DeclContext name lookup.
337 
338 } // namespace reader
339 
340 } // namespace serialization
341 
342 /// Reads an AST files chain containing the contents of a translation
343 /// unit.
344 ///
345 /// The ASTReader class reads bitstreams (produced by the ASTWriter
346 /// class) containing the serialized representation of a given
347 /// abstract syntax tree and its supporting data structures. An
348 /// instance of the ASTReader can be attached to an ASTContext object,
349 /// which will provide access to the contents of the AST files.
350 ///
351 /// The AST reader provides lazy de-serialization of declarations, as
352 /// required when traversing the AST. Only those AST nodes that are
353 /// actually required will be de-serialized.
358  public ExternalSemaSource,
359  public IdentifierInfoLookup,
361 {
362 public:
363  /// Types of AST files.
364  friend class ASTDeclReader;
365  friend class ASTIdentifierIterator;
366  friend class ASTRecordReader;
367  friend class ASTStmtReader;
368  friend class ASTUnit; // ASTUnit needs to remap source locations.
369  friend class ASTWriter;
370  friend class PCHValidator;
373  friend class TypeLocReader;
374 
377 
378  /// The result of reading the control block of an AST file, which
379  /// can fail for various reasons.
381  /// The control block was read successfully. Aside from failures,
382  /// the AST file is safe to read into the current context.
384 
385  /// The AST file itself appears corrupted.
387 
388  /// The AST file was missing.
390 
391  /// The AST file is out-of-date relative to its input files,
392  /// and needs to be regenerated.
394 
395  /// The AST file was written by a different version of Clang.
397 
398  /// The AST file was writtten with a different language/target
399  /// configuration.
401 
402  /// The AST file has errors.
403  HadErrors
404  };
405 
412 
413 private:
414  /// The receiver of some callbacks invoked by ASTReader.
415  std::unique_ptr<ASTReaderListener> Listener;
416 
417  /// The receiver of deserialization events.
418  ASTDeserializationListener *DeserializationListener = nullptr;
419 
420  bool OwnsDeserializationListener = false;
421 
422  SourceManager &SourceMgr;
423  FileManager &FileMgr;
424  const PCHContainerReader &PCHContainerRdr;
425  DiagnosticsEngine &Diags;
426 
427  /// The semantic analysis object that will be processing the
428  /// AST files and the translation unit that uses it.
429  Sema *SemaObj = nullptr;
430 
431  /// The preprocessor that will be loading the source file.
432  Preprocessor &PP;
433 
434  /// The AST context into which we'll read the AST files.
435  ASTContext *ContextObj = nullptr;
436 
437  /// The AST consumer.
438  ASTConsumer *Consumer = nullptr;
439 
440  /// The module manager which manages modules and their dependencies
441  ModuleManager ModuleMgr;
442 
443  /// A dummy identifier resolver used to merge TU-scope declarations in
444  /// C, for the cases where we don't have a Sema object to provide a real
445  /// identifier resolver.
446  IdentifierResolver DummyIdResolver;
447 
448  /// A mapping from extension block names to module file extensions.
449  llvm::StringMap<std::shared_ptr<ModuleFileExtension>> ModuleFileExtensions;
450 
451  /// A timer used to track the time spent deserializing.
452  std::unique_ptr<llvm::Timer> ReadTimer;
453 
454  /// The location where the module file will be considered as
455  /// imported from. For non-module AST types it should be invalid.
456  SourceLocation CurrentImportLoc;
457 
458  /// The global module index, if loaded.
459  std::unique_ptr<GlobalModuleIndex> GlobalIndex;
460 
461  /// A map of global bit offsets to the module that stores entities
462  /// at those bit offsets.
464 
465  /// A map of negated SLocEntryIDs to the modules containing them.
467 
470 
471  /// A map of reversed (SourceManager::MaxLoadedOffset - SLocOffset)
472  /// SourceLocation offsets to the modules containing them.
473  GlobalSLocOffsetMapType GlobalSLocOffsetMap;
474 
475  /// Types that have already been loaded from the chain.
476  ///
477  /// When the pointer at index I is non-NULL, the type with
478  /// ID = (I + 1) << FastQual::Width has already been loaded
479  std::vector<QualType> TypesLoaded;
480 
481  using GlobalTypeMapType =
483 
484  /// Mapping from global type IDs to the module in which the
485  /// type resides along with the offset that should be added to the
486  /// global type ID to produce a local ID.
487  GlobalTypeMapType GlobalTypeMap;
488 
489  /// Declarations that have already been loaded from the chain.
490  ///
491  /// When the pointer at index I is non-NULL, the declaration with ID
492  /// = I + 1 has already been loaded.
493  std::vector<Decl *> DeclsLoaded;
494 
495  using GlobalDeclMapType =
497 
498  /// Mapping from global declaration IDs to the module in which the
499  /// declaration resides.
500  GlobalDeclMapType GlobalDeclMap;
501 
502  using FileOffset = std::pair<ModuleFile *, uint64_t>;
504  using DeclUpdateOffsetsMap =
505  llvm::DenseMap<serialization::DeclID, FileOffsetsTy>;
506 
507  /// Declarations that have modifications residing in a later file
508  /// in the chain.
509  DeclUpdateOffsetsMap DeclUpdateOffsets;
510 
511  struct PendingUpdateRecord {
512  Decl *D;
514 
515  // Whether the declaration was just deserialized.
516  bool JustLoaded;
517 
518  PendingUpdateRecord(serialization::GlobalDeclID ID, Decl *D,
519  bool JustLoaded)
520  : D(D), ID(ID), JustLoaded(JustLoaded) {}
521  };
522 
523  /// Declaration updates for already-loaded declarations that we need
524  /// to apply once we finish processing an import.
525  llvm::SmallVector<PendingUpdateRecord, 16> PendingUpdateRecords;
526 
527  enum class PendingFakeDefinitionKind { NotFake, Fake, FakeLoaded };
528 
529  /// The DefinitionData pointers that we faked up for class definitions
530  /// that we needed but hadn't loaded yet.
531  llvm::DenseMap<void *, PendingFakeDefinitionKind> PendingFakeDefinitionData;
532 
533  /// Exception specification updates that have been loaded but not yet
534  /// propagated across the relevant redeclaration chain. The map key is the
535  /// canonical declaration (used only for deduplication) and the value is a
536  /// declaration that has an exception specification.
537  llvm::SmallMapVector<Decl *, FunctionDecl *, 4> PendingExceptionSpecUpdates;
538 
539  /// Deduced return type updates that have been loaded but not yet propagated
540  /// across the relevant redeclaration chain. The map key is the canonical
541  /// declaration and the value is the deduced return type.
542  llvm::SmallMapVector<FunctionDecl *, QualType, 4> PendingDeducedTypeUpdates;
543 
544  /// Declarations that have been imported and have typedef names for
545  /// linkage purposes.
546  llvm::DenseMap<std::pair<DeclContext *, IdentifierInfo *>, NamedDecl *>
547  ImportedTypedefNamesForLinkage;
548 
549  /// Mergeable declaration contexts that have anonymous declarations
550  /// within them, and those anonymous declarations.
551  llvm::DenseMap<Decl*, llvm::SmallVector<NamedDecl*, 2>>
552  AnonymousDeclarationsForMerging;
553 
554  struct FileDeclsInfo {
555  ModuleFile *Mod = nullptr;
557 
558  FileDeclsInfo() = default;
559  FileDeclsInfo(ModuleFile *Mod, ArrayRef<serialization::LocalDeclID> Decls)
560  : Mod(Mod), Decls(Decls) {}
561  };
562 
563  /// Map from a FileID to the file-level declarations that it contains.
564  llvm::DenseMap<FileID, FileDeclsInfo> FileDeclIDs;
565 
566  /// An array of lexical contents of a declaration context, as a sequence of
567  /// Decl::Kind, DeclID pairs.
569 
570  /// Map from a DeclContext to its lexical contents.
571  llvm::DenseMap<const DeclContext*, std::pair<ModuleFile*, LexicalContents>>
572  LexicalDecls;
573 
574  /// Map from the TU to its lexical contents from each module file.
575  std::vector<std::pair<ModuleFile*, LexicalContents>> TULexicalDecls;
576 
577  /// Map from a DeclContext to its lookup tables.
578  llvm::DenseMap<const DeclContext *,
580 
581  // Updates for visible decls can occur for other contexts than just the
582  // TU, and when we read those update records, the actual context may not
583  // be available yet, so have this pending map using the ID as a key. It
584  // will be realized when the context is actually loaded.
585  struct PendingVisibleUpdate {
586  ModuleFile *Mod;
587  const unsigned char *Data;
588  };
590 
591  /// Updates to the visible declarations of declaration contexts that
592  /// haven't been loaded yet.
593  llvm::DenseMap<serialization::DeclID, DeclContextVisibleUpdates>
594  PendingVisibleUpdates;
595 
596  /// The set of C++ or Objective-C classes that have forward
597  /// declarations that have not yet been linked to their definitions.
598  llvm::SmallPtrSet<Decl *, 4> PendingDefinitions;
599 
600  using PendingBodiesMap =
601  llvm::MapVector<Decl *, uint64_t,
602  llvm::SmallDenseMap<Decl *, unsigned, 4>,
604 
605  /// Functions or methods that have bodies that will be attached.
606  PendingBodiesMap PendingBodies;
607 
608  /// Definitions for which we have added merged definitions but not yet
609  /// performed deduplication.
610  llvm::SetVector<NamedDecl *> PendingMergedDefinitionsToDeduplicate;
611 
612  /// Read the record that describes the lexical contents of a DC.
613  bool ReadLexicalDeclContextStorage(ModuleFile &M,
614  llvm::BitstreamCursor &Cursor,
615  uint64_t Offset, DeclContext *DC);
616 
617  /// Read the record that describes the visible contents of a DC.
618  bool ReadVisibleDeclContextStorage(ModuleFile &M,
619  llvm::BitstreamCursor &Cursor,
620  uint64_t Offset, serialization::DeclID ID);
621 
622  /// A vector containing identifiers that have already been
623  /// loaded.
624  ///
625  /// If the pointer at index I is non-NULL, then it refers to the
626  /// IdentifierInfo for the identifier with ID=I+1 that has already
627  /// been loaded.
628  std::vector<IdentifierInfo *> IdentifiersLoaded;
629 
632 
633  /// Mapping from global identifier IDs to the module in which the
634  /// identifier resides along with the offset that should be added to the
635  /// global identifier ID to produce a local ID.
636  GlobalIdentifierMapType GlobalIdentifierMap;
637 
638  /// A vector containing macros that have already been
639  /// loaded.
640  ///
641  /// If the pointer at index I is non-NULL, then it refers to the
642  /// MacroInfo for the identifier with ID=I+1 that has already
643  /// been loaded.
644  std::vector<MacroInfo *> MacrosLoaded;
645 
646  using LoadedMacroInfo =
647  std::pair<IdentifierInfo *, serialization::SubmoduleID>;
648 
649  /// A set of #undef directives that we have loaded; used to
650  /// deduplicate the same #undef information coming from multiple module
651  /// files.
652  llvm::DenseSet<LoadedMacroInfo> LoadedUndefs;
653 
654  using GlobalMacroMapType =
656 
657  /// Mapping from global macro IDs to the module in which the
658  /// macro resides along with the offset that should be added to the
659  /// global macro ID to produce a local ID.
660  GlobalMacroMapType GlobalMacroMap;
661 
662  /// A vector containing submodules that have already been loaded.
663  ///
664  /// This vector is indexed by the Submodule ID (-1). NULL submodule entries
665  /// indicate that the particular submodule ID has not yet been loaded.
666  SmallVector<Module *, 2> SubmodulesLoaded;
667 
668  using GlobalSubmoduleMapType =
670 
671  /// Mapping from global submodule IDs to the module file in which the
672  /// submodule resides along with the offset that should be added to the
673  /// global submodule ID to produce a local ID.
674  GlobalSubmoduleMapType GlobalSubmoduleMap;
675 
676  /// A set of hidden declarations.
678  using HiddenNamesMapType = llvm::DenseMap<Module *, HiddenNames>;
679 
680  /// A mapping from each of the hidden submodules to the deserialized
681  /// declarations in that submodule that could be made visible.
682  HiddenNamesMapType HiddenNamesMap;
683 
684  /// A module import, export, or conflict that hasn't yet been resolved.
685  struct UnresolvedModuleRef {
686  /// The file in which this module resides.
687  ModuleFile *File;
688 
689  /// The module that is importing or exporting.
690  Module *Mod;
691 
692  /// The kind of module reference.
693  enum { Import, Export, Conflict } Kind;
694 
695  /// The local ID of the module that is being exported.
696  unsigned ID;
697 
698  /// Whether this is a wildcard export.
699  unsigned IsWildcard : 1;
700 
701  /// String data.
702  StringRef String;
703  };
704 
705  /// The set of module imports and exports that still need to be
706  /// resolved.
707  SmallVector<UnresolvedModuleRef, 2> UnresolvedModuleRefs;
708 
709  /// A vector containing selectors that have already been loaded.
710  ///
711  /// This vector is indexed by the Selector ID (-1). NULL selector
712  /// entries indicate that the particular selector ID has not yet
713  /// been loaded.
714  SmallVector<Selector, 16> SelectorsLoaded;
715 
716  using GlobalSelectorMapType =
718 
719  /// Mapping from global selector IDs to the module in which the
720  /// global selector ID to produce a local ID.
721  GlobalSelectorMapType GlobalSelectorMap;
722 
723  /// The generation number of the last time we loaded data from the
724  /// global method pool for this selector.
725  llvm::DenseMap<Selector, unsigned> SelectorGeneration;
726 
727  /// Whether a selector is out of date. We mark a selector as out of date
728  /// if we load another module after the method pool entry was pulled in.
729  llvm::DenseMap<Selector, bool> SelectorOutOfDate;
730 
731  struct PendingMacroInfo {
732  ModuleFile *M;
733  uint64_t MacroDirectivesOffset;
734 
735  PendingMacroInfo(ModuleFile *M, uint64_t MacroDirectivesOffset)
736  : M(M), MacroDirectivesOffset(MacroDirectivesOffset) {}
737  };
738 
739  using PendingMacroIDsMap =
740  llvm::MapVector<IdentifierInfo *, SmallVector<PendingMacroInfo, 2>>;
741 
742  /// Mapping from identifiers that have a macro history to the global
743  /// IDs have not yet been deserialized to the global IDs of those macros.
744  PendingMacroIDsMap PendingMacroIDs;
745 
748 
749  /// Mapping from global preprocessing entity IDs to the module in
750  /// which the preprocessed entity resides along with the offset that should be
751  /// added to the global preprocessing entity ID to produce a local ID.
752  GlobalPreprocessedEntityMapType GlobalPreprocessedEntityMap;
753 
756 
757  /// Mapping from global skipped range base IDs to the module in which
758  /// the skipped ranges reside.
759  GlobalSkippedRangeMapType GlobalSkippedRangeMap;
760 
761  /// \name CodeGen-relevant special data
762  /// Fields containing data that is relevant to CodeGen.
763  //@{
764 
765  /// The IDs of all declarations that fulfill the criteria of
766  /// "interesting" decls.
767  ///
768  /// This contains the data loaded from all EAGERLY_DESERIALIZED_DECLS blocks
769  /// in the chain. The referenced declarations are deserialized and passed to
770  /// the consumer eagerly.
771  SmallVector<uint64_t, 16> EagerlyDeserializedDecls;
772 
773  /// The IDs of all tentative definitions stored in the chain.
774  ///
775  /// Sema keeps track of all tentative definitions in a TU because it has to
776  /// complete them and pass them on to CodeGen. Thus, tentative definitions in
777  /// the PCH chain must be eagerly deserialized.
778  SmallVector<uint64_t, 16> TentativeDefinitions;
779 
780  /// The IDs of all CXXRecordDecls stored in the chain whose VTables are
781  /// used.
782  ///
783  /// CodeGen has to emit VTables for these records, so they have to be eagerly
784  /// deserialized.
785  SmallVector<uint64_t, 64> VTableUses;
786 
787  /// A snapshot of the pending instantiations in the chain.
788  ///
789  /// This record tracks the instantiations that Sema has to perform at the
790  /// end of the TU. It consists of a pair of values for every pending
791  /// instantiation where the first value is the ID of the decl and the second
792  /// is the instantiation location.
793  SmallVector<uint64_t, 64> PendingInstantiations;
794 
795  //@}
796 
797  /// \name DiagnosticsEngine-relevant special data
798  /// Fields containing data that is used for generating diagnostics
799  //@{
800 
801  /// A snapshot of Sema's unused file-scoped variable tracking, for
802  /// generating warnings.
803  SmallVector<uint64_t, 16> UnusedFileScopedDecls;
804 
805  /// A list of all the delegating constructors we've seen, to diagnose
806  /// cycles.
807  SmallVector<uint64_t, 4> DelegatingCtorDecls;
808 
809  /// Method selectors used in a @selector expression. Used for
810  /// implementation of -Wselector.
811  SmallVector<uint64_t, 64> ReferencedSelectorsData;
812 
813  /// A snapshot of Sema's weak undeclared identifier tracking, for
814  /// generating warnings.
815  SmallVector<uint64_t, 64> WeakUndeclaredIdentifiers;
816 
817  /// The IDs of type aliases for ext_vectors that exist in the chain.
818  ///
819  /// Used by Sema for finding sugared names for ext_vectors in diagnostics.
820  SmallVector<uint64_t, 4> ExtVectorDecls;
821 
822  //@}
823 
824  /// \name Sema-relevant special data
825  /// Fields containing data that is used for semantic analysis
826  //@{
827 
828  /// The IDs of all potentially unused typedef names in the chain.
829  ///
830  /// Sema tracks these to emit warnings.
831  SmallVector<uint64_t, 16> UnusedLocalTypedefNameCandidates;
832 
833  /// Our current depth in #pragma cuda force_host_device begin/end
834  /// macros.
835  unsigned ForceCUDAHostDeviceDepth = 0;
836 
837  /// The IDs of the declarations Sema stores directly.
838  ///
839  /// Sema tracks a few important decls, such as namespace std, directly.
840  SmallVector<uint64_t, 4> SemaDeclRefs;
841 
842  /// The IDs of the types ASTContext stores directly.
843  ///
844  /// The AST context tracks a few important types, such as va_list, directly.
845  SmallVector<uint64_t, 16> SpecialTypes;
846 
847  /// The IDs of CUDA-specific declarations ASTContext stores directly.
848  ///
849  /// The AST context tracks a few important decls, currently cudaConfigureCall,
850  /// directly.
851  SmallVector<uint64_t, 2> CUDASpecialDeclRefs;
852 
853  /// The floating point pragma option settings.
854  SmallVector<uint64_t, 1> FPPragmaOptions;
855 
856  /// The pragma clang optimize location (if the pragma state is "off").
857  SourceLocation OptimizeOffPragmaLocation;
858 
859  /// The PragmaMSStructKind pragma ms_struct state if set, or -1.
860  int PragmaMSStructState = -1;
861 
862  /// The PragmaMSPointersToMembersKind pragma pointers_to_members state.
863  int PragmaMSPointersToMembersState = -1;
864  SourceLocation PointersToMembersPragmaLocation;
865 
866  /// The pragma pack state.
867  Optional<unsigned> PragmaPackCurrentValue;
868  SourceLocation PragmaPackCurrentLocation;
869  struct PragmaPackStackEntry {
870  unsigned Value;
871  SourceLocation Location;
872  SourceLocation PushLocation;
873  StringRef SlotLabel;
874  };
876  llvm::SmallVector<std::string, 2> PragmaPackStrings;
877 
878  /// The OpenCL extension settings.
879  OpenCLOptions OpenCLExtensions;
880 
881  /// Extensions required by an OpenCL type.
882  llvm::DenseMap<const Type *, std::set<std::string>> OpenCLTypeExtMap;
883 
884  /// Extensions required by an OpenCL declaration.
885  llvm::DenseMap<const Decl *, std::set<std::string>> OpenCLDeclExtMap;
886 
887  /// A list of the namespaces we've seen.
888  SmallVector<uint64_t, 4> KnownNamespaces;
889 
890  /// A list of undefined decls with internal linkage followed by the
891  /// SourceLocation of a matching ODR-use.
892  SmallVector<uint64_t, 8> UndefinedButUsed;
893 
894  /// Delete expressions to analyze at the end of translation unit.
895  SmallVector<uint64_t, 8> DelayedDeleteExprs;
896 
897  // A list of late parsed template function data.
898  SmallVector<uint64_t, 1> LateParsedTemplates;
899 
900 public:
904 
906  : ID(ID), ImportLoc(ImportLoc) {}
907  };
908 
909 private:
910  /// A list of modules that were imported by precompiled headers or
911  /// any other non-module AST file.
912  SmallVector<ImportedSubmodule, 2> ImportedModules;
913  //@}
914 
915  /// The system include root to be used when loading the
916  /// precompiled header.
917  std::string isysroot;
918 
919  /// Whether to disable the normal validation performed on precompiled
920  /// headers when they are loaded.
921  bool DisableValidation;
922 
923  /// Whether to accept an AST file with compiler errors.
924  bool AllowASTWithCompilerErrors;
925 
926  /// Whether to accept an AST file that has a different configuration
927  /// from the current compiler instance.
928  bool AllowConfigurationMismatch;
929 
930  /// Whether validate system input files.
931  bool ValidateSystemInputs;
932 
933  /// Whether validate headers and module maps using hash based on contents.
934  bool ValidateASTInputFilesContent;
935 
936  /// Whether we are allowed to use the global module index.
937  bool UseGlobalIndex;
938 
939  /// Whether we have tried loading the global module index yet.
940  bool TriedLoadingGlobalIndex = false;
941 
942  ///Whether we are currently processing update records.
943  bool ProcessingUpdateRecords = false;
944 
945  using SwitchCaseMapTy = llvm::DenseMap<unsigned, SwitchCase *>;
946 
947  /// Mapping from switch-case IDs in the chain to switch-case statements
948  ///
949  /// Statements usually don't have IDs, but switch cases need them, so that the
950  /// switch statement can refer to them.
951  SwitchCaseMapTy SwitchCaseStmts;
952 
953  SwitchCaseMapTy *CurrSwitchCaseStmts;
954 
955  /// The number of source location entries de-serialized from
956  /// the PCH file.
957  unsigned NumSLocEntriesRead = 0;
958 
959  /// The number of source location entries in the chain.
960  unsigned TotalNumSLocEntries = 0;
961 
962  /// The number of statements (and expressions) de-serialized
963  /// from the chain.
964  unsigned NumStatementsRead = 0;
965 
966  /// The total number of statements (and expressions) stored
967  /// in the chain.
968  unsigned TotalNumStatements = 0;
969 
970  /// The number of macros de-serialized from the chain.
971  unsigned NumMacrosRead = 0;
972 
973  /// The total number of macros stored in the chain.
974  unsigned TotalNumMacros = 0;
975 
976  /// The number of lookups into identifier tables.
977  unsigned NumIdentifierLookups = 0;
978 
979  /// The number of lookups into identifier tables that succeed.
980  unsigned NumIdentifierLookupHits = 0;
981 
982  /// The number of selectors that have been read.
983  unsigned NumSelectorsRead = 0;
984 
985  /// The number of method pool entries that have been read.
986  unsigned NumMethodPoolEntriesRead = 0;
987 
988  /// The number of times we have looked up a selector in the method
989  /// pool.
990  unsigned NumMethodPoolLookups = 0;
991 
992  /// The number of times we have looked up a selector in the method
993  /// pool and found something.
994  unsigned NumMethodPoolHits = 0;
995 
996  /// The number of times we have looked up a selector in the method
997  /// pool within a specific module.
998  unsigned NumMethodPoolTableLookups = 0;
999 
1000  /// The number of times we have looked up a selector in the method
1001  /// pool within a specific module and found something.
1002  unsigned NumMethodPoolTableHits = 0;
1003 
1004  /// The total number of method pool entries in the selector table.
1005  unsigned TotalNumMethodPoolEntries = 0;
1006 
1007  /// Number of lexical decl contexts read/total.
1008  unsigned NumLexicalDeclContextsRead = 0, TotalLexicalDeclContexts = 0;
1009 
1010  /// Number of visible decl contexts read/total.
1011  unsigned NumVisibleDeclContextsRead = 0, TotalVisibleDeclContexts = 0;
1012 
1013  /// Total size of modules, in bits, currently loaded
1014  uint64_t TotalModulesSizeInBits = 0;
1015 
1016  /// Number of Decl/types that are currently deserializing.
1017  unsigned NumCurrentElementsDeserializing = 0;
1018 
1019  /// Set true while we are in the process of passing deserialized
1020  /// "interesting" decls to consumer inside FinishedDeserializing().
1021  /// This is used as a guard to avoid recursively repeating the process of
1022  /// passing decls to consumer.
1023  bool PassingDeclsToConsumer = false;
1024 
1025  /// The set of identifiers that were read while the AST reader was
1026  /// (recursively) loading declarations.
1027  ///
1028  /// The declarations on the identifier chain for these identifiers will be
1029  /// loaded once the recursive loading has completed.
1030  llvm::MapVector<IdentifierInfo *, SmallVector<uint32_t, 4>>
1031  PendingIdentifierInfos;
1032 
1033  /// The set of lookup results that we have faked in order to support
1034  /// merging of partially deserialized decls but that we have not yet removed.
1035  llvm::SmallMapVector<IdentifierInfo *, SmallVector<NamedDecl*, 2>, 16>
1036  PendingFakeLookupResults;
1037 
1038  /// The generation number of each identifier, which keeps track of
1039  /// the last time we loaded information about this identifier.
1040  llvm::DenseMap<IdentifierInfo *, unsigned> IdentifierGeneration;
1041 
1042  class InterestingDecl {
1043  Decl *D;
1044  bool DeclHasPendingBody;
1045 
1046  public:
1047  InterestingDecl(Decl *D, bool HasBody)
1048  : D(D), DeclHasPendingBody(HasBody) {}
1049 
1050  Decl *getDecl() { return D; }
1051 
1052  /// Whether the declaration has a pending body.
1053  bool hasPendingBody() { return DeclHasPendingBody; }
1054  };
1055 
1056  /// Contains declarations and definitions that could be
1057  /// "interesting" to the ASTConsumer, when we get that AST consumer.
1058  ///
1059  /// "Interesting" declarations are those that have data that may
1060  /// need to be emitted, such as inline function definitions or
1061  /// Objective-C protocols.
1062  std::deque<InterestingDecl> PotentiallyInterestingDecls;
1063 
1064  /// The list of deduced function types that we have not yet read, because
1065  /// they might contain a deduced return type that refers to a local type
1066  /// declared within the function.
1068  PendingFunctionTypes;
1069 
1070  /// The list of redeclaration chains that still need to be
1071  /// reconstructed, and the local offset to the corresponding list
1072  /// of redeclarations.
1073  SmallVector<std::pair<Decl *, uint64_t>, 16> PendingDeclChains;
1074 
1075  /// The list of canonical declarations whose redeclaration chains
1076  /// need to be marked as incomplete once we're done deserializing things.
1077  SmallVector<Decl *, 16> PendingIncompleteDeclChains;
1078 
1079  /// The Decl IDs for the Sema/Lexical DeclContext of a Decl that has
1080  /// been loaded but its DeclContext was not set yet.
1081  struct PendingDeclContextInfo {
1082  Decl *D;
1084  serialization::GlobalDeclID LexicalDC;
1085  };
1086 
1087  /// The set of Decls that have been loaded but their DeclContexts are
1088  /// not set yet.
1089  ///
1090  /// The DeclContexts for these Decls will be set once recursive loading has
1091  /// been completed.
1092  std::deque<PendingDeclContextInfo> PendingDeclContextInfos;
1093 
1094  /// The set of NamedDecls that have been loaded, but are members of a
1095  /// context that has been merged into another context where the corresponding
1096  /// declaration is either missing or has not yet been loaded.
1097  ///
1098  /// We will check whether the corresponding declaration is in fact missing
1099  /// once recursing loading has been completed.
1100  llvm::SmallVector<NamedDecl *, 16> PendingOdrMergeChecks;
1101 
1102  using DataPointers =
1103  std::pair<CXXRecordDecl *, struct CXXRecordDecl::DefinitionData *>;
1104 
1105  /// Record definitions in which we found an ODR violation.
1106  llvm::SmallDenseMap<CXXRecordDecl *, llvm::SmallVector<DataPointers, 2>, 2>
1107  PendingOdrMergeFailures;
1108 
1109  /// Function definitions in which we found an ODR violation.
1110  llvm::SmallDenseMap<FunctionDecl *, llvm::SmallVector<FunctionDecl *, 2>, 2>
1111  PendingFunctionOdrMergeFailures;
1112 
1113  /// Enum definitions in which we found an ODR violation.
1114  llvm::SmallDenseMap<EnumDecl *, llvm::SmallVector<EnumDecl *, 2>, 2>
1115  PendingEnumOdrMergeFailures;
1116 
1117  /// DeclContexts in which we have diagnosed an ODR violation.
1118  llvm::SmallPtrSet<DeclContext*, 2> DiagnosedOdrMergeFailures;
1119 
1120  /// The set of Objective-C categories that have been deserialized
1121  /// since the last time the declaration chains were linked.
1122  llvm::SmallPtrSet<ObjCCategoryDecl *, 16> CategoriesDeserialized;
1123 
1124  /// The set of Objective-C class definitions that have already been
1125  /// loaded, for which we will need to check for categories whenever a new
1126  /// module is loaded.
1127  SmallVector<ObjCInterfaceDecl *, 16> ObjCClassesLoaded;
1128 
1129  using KeyDeclsMap =
1130  llvm::DenseMap<Decl *, SmallVector<serialization::DeclID, 2>>;
1131 
1132  /// A mapping from canonical declarations to the set of global
1133  /// declaration IDs for key declaration that have been merged with that
1134  /// canonical declaration. A key declaration is a formerly-canonical
1135  /// declaration whose module did not import any other key declaration for that
1136  /// entity. These are the IDs that we use as keys when finding redecl chains.
1137  KeyDeclsMap KeyDecls;
1138 
1139  /// A mapping from DeclContexts to the semantic DeclContext that we
1140  /// are treating as the definition of the entity. This is used, for instance,
1141  /// when merging implicit instantiations of class templates across modules.
1142  llvm::DenseMap<DeclContext *, DeclContext *> MergedDeclContexts;
1143 
1144  /// A mapping from canonical declarations of enums to their canonical
1145  /// definitions. Only populated when using modules in C++.
1146  llvm::DenseMap<EnumDecl *, EnumDecl *> EnumDefinitions;
1147 
1148  /// When reading a Stmt tree, Stmt operands are placed in this stack.
1149  SmallVector<Stmt *, 16> StmtStack;
1150 
1151  /// What kind of records we are reading.
1152  enum ReadingKind {
1153  Read_None, Read_Decl, Read_Type, Read_Stmt
1154  };
1155 
1156  /// What kind of records we are reading.
1157  ReadingKind ReadingKind = Read_None;
1158 
1159  /// RAII object to change the reading kind.
1160  class ReadingKindTracker {
1161  ASTReader &Reader;
1162  enum ReadingKind PrevKind;
1163 
1164  public:
1165  ReadingKindTracker(enum ReadingKind newKind, ASTReader &reader)
1166  : Reader(reader), PrevKind(Reader.ReadingKind) {
1167  Reader.ReadingKind = newKind;
1168  }
1169 
1170  ReadingKindTracker(const ReadingKindTracker &) = delete;
1171  ReadingKindTracker &operator=(const ReadingKindTracker &) = delete;
1172  ~ReadingKindTracker() { Reader.ReadingKind = PrevKind; }
1173  };
1174 
1175  /// RAII object to mark the start of processing updates.
1176  class ProcessingUpdatesRAIIObj {
1177  ASTReader &Reader;
1178  bool PrevState;
1179 
1180  public:
1181  ProcessingUpdatesRAIIObj(ASTReader &reader)
1182  : Reader(reader), PrevState(Reader.ProcessingUpdateRecords) {
1183  Reader.ProcessingUpdateRecords = true;
1184  }
1185 
1186  ProcessingUpdatesRAIIObj(const ProcessingUpdatesRAIIObj &) = delete;
1187  ProcessingUpdatesRAIIObj &
1188  operator=(const ProcessingUpdatesRAIIObj &) = delete;
1189  ~ProcessingUpdatesRAIIObj() { Reader.ProcessingUpdateRecords = PrevState; }
1190  };
1191 
1192  /// Suggested contents of the predefines buffer, after this
1193  /// PCH file has been processed.
1194  ///
1195  /// In most cases, this string will be empty, because the predefines
1196  /// buffer computed to build the PCH file will be identical to the
1197  /// predefines buffer computed from the command line. However, when
1198  /// there are differences that the PCH reader can work around, this
1199  /// predefines buffer may contain additional definitions.
1200  std::string SuggestedPredefines;
1201 
1202  llvm::DenseMap<const Decl *, bool> DefinitionSource;
1203 
1204  /// Reads a statement from the specified cursor.
1205  Stmt *ReadStmtFromStream(ModuleFile &F);
1206 
1207  struct InputFileInfo {
1208  std::string Filename;
1209  uint64_t ContentHash;
1210  off_t StoredSize;
1211  time_t StoredTime;
1212  bool Overridden;
1213  bool Transient;
1214  bool TopLevelModuleMap;
1215  };
1216 
1217  /// Reads the stored information about an input file.
1218  InputFileInfo readInputFileInfo(ModuleFile &F, unsigned ID);
1219 
1220  /// Retrieve the file entry and 'overridden' bit for an input
1221  /// file in the given module file.
1222  serialization::InputFile getInputFile(ModuleFile &F, unsigned ID,
1223  bool Complain = true);
1224 
1225 public:
1226  void ResolveImportedPath(ModuleFile &M, std::string &Filename);
1227  static void ResolveImportedPath(std::string &Filename, StringRef Prefix);
1228 
1229  /// Returns the first key declaration for the given declaration. This
1230  /// is one that is formerly-canonical (or still canonical) and whose module
1231  /// did not import any other key declaration of the entity.
1232  Decl *getKeyDeclaration(Decl *D) {
1233  D = D->getCanonicalDecl();
1234  if (D->isFromASTFile())
1235  return D;
1236 
1237  auto I = KeyDecls.find(D);
1238  if (I == KeyDecls.end() || I->second.empty())
1239  return D;
1240  return GetExistingDecl(I->second[0]);
1241  }
1242  const Decl *getKeyDeclaration(const Decl *D) {
1243  return getKeyDeclaration(const_cast<Decl*>(D));
1244  }
1245 
1246  /// Run a callback on each imported key declaration of \p D.
1247  template <typename Fn>
1248  void forEachImportedKeyDecl(const Decl *D, Fn Visit) {
1249  D = D->getCanonicalDecl();
1250  if (D->isFromASTFile())
1251  Visit(D);
1252 
1253  auto It = KeyDecls.find(const_cast<Decl*>(D));
1254  if (It != KeyDecls.end())
1255  for (auto ID : It->second)
1256  Visit(GetExistingDecl(ID));
1257  }
1258 
1259  /// Get the loaded lookup tables for \p Primary, if any.
1261  getLoadedLookupTables(DeclContext *Primary) const;
1262 
1263 private:
1264  struct ImportedModule {
1265  ModuleFile *Mod;
1266  ModuleFile *ImportedBy;
1267  SourceLocation ImportLoc;
1268 
1269  ImportedModule(ModuleFile *Mod,
1270  ModuleFile *ImportedBy,
1271  SourceLocation ImportLoc)
1272  : Mod(Mod), ImportedBy(ImportedBy), ImportLoc(ImportLoc) {}
1273  };
1274 
1275  ASTReadResult ReadASTCore(StringRef FileName, ModuleKind Type,
1276  SourceLocation ImportLoc, ModuleFile *ImportedBy,
1278  off_t ExpectedSize, time_t ExpectedModTime,
1279  ASTFileSignature ExpectedSignature,
1280  unsigned ClientLoadCapabilities);
1281  ASTReadResult ReadControlBlock(ModuleFile &F,
1283  const ModuleFile *ImportedBy,
1284  unsigned ClientLoadCapabilities);
1285  static ASTReadResult ReadOptionsBlock(
1286  llvm::BitstreamCursor &Stream, unsigned ClientLoadCapabilities,
1287  bool AllowCompatibleConfigurationMismatch, ASTReaderListener &Listener,
1288  std::string &SuggestedPredefines);
1289 
1290  /// Read the unhashed control block.
1291  ///
1292  /// This has no effect on \c F.Stream, instead creating a fresh cursor from
1293  /// \c F.Data and reading ahead.
1294  ASTReadResult readUnhashedControlBlock(ModuleFile &F, bool WasImportedBy,
1295  unsigned ClientLoadCapabilities);
1296 
1297  static ASTReadResult
1298  readUnhashedControlBlockImpl(ModuleFile *F, llvm::StringRef StreamData,
1299  unsigned ClientLoadCapabilities,
1300  bool AllowCompatibleConfigurationMismatch,
1301  ASTReaderListener *Listener,
1302  bool ValidateDiagnosticOptions);
1303 
1304  ASTReadResult ReadASTBlock(ModuleFile &F, unsigned ClientLoadCapabilities);
1305  ASTReadResult ReadExtensionBlock(ModuleFile &F);
1306  void ReadModuleOffsetMap(ModuleFile &F) const;
1307  bool ParseLineTable(ModuleFile &F, const RecordData &Record);
1308  bool ReadSourceManagerBlock(ModuleFile &F);
1309  llvm::BitstreamCursor &SLocCursorForID(int ID);
1310  SourceLocation getImportLocation(ModuleFile *F);
1311  ASTReadResult ReadModuleMapFileBlock(RecordData &Record, ModuleFile &F,
1312  const ModuleFile *ImportedBy,
1313  unsigned ClientLoadCapabilities);
1314  ASTReadResult ReadSubmoduleBlock(ModuleFile &F,
1315  unsigned ClientLoadCapabilities);
1316  static bool ParseLanguageOptions(const RecordData &Record, bool Complain,
1317  ASTReaderListener &Listener,
1318  bool AllowCompatibleDifferences);
1319  static bool ParseTargetOptions(const RecordData &Record, bool Complain,
1320  ASTReaderListener &Listener,
1321  bool AllowCompatibleDifferences);
1322  static bool ParseDiagnosticOptions(const RecordData &Record, bool Complain,
1323  ASTReaderListener &Listener);
1324  static bool ParseFileSystemOptions(const RecordData &Record, bool Complain,
1325  ASTReaderListener &Listener);
1326  static bool ParseHeaderSearchOptions(const RecordData &Record, bool Complain,
1327  ASTReaderListener &Listener);
1328  static bool ParsePreprocessorOptions(const RecordData &Record, bool Complain,
1329  ASTReaderListener &Listener,
1330  std::string &SuggestedPredefines);
1331 
1332  struct RecordLocation {
1333  ModuleFile *F;
1334  uint64_t Offset;
1335 
1336  RecordLocation(ModuleFile *M, uint64_t O) : F(M), Offset(O) {}
1337  };
1338 
1339  QualType readTypeRecord(unsigned Index);
1340  void readExceptionSpec(ModuleFile &ModuleFile,
1341  SmallVectorImpl<QualType> &ExceptionStorage,
1343  const RecordData &Record, unsigned &Index);
1344  RecordLocation TypeCursorForIndex(unsigned Index);
1345  void LoadedDecl(unsigned Index, Decl *D);
1346  Decl *ReadDeclRecord(serialization::DeclID ID);
1347  void markIncompleteDeclChain(Decl *Canon);
1348 
1349  /// Returns the most recent declaration of a declaration (which must be
1350  /// of a redeclarable kind) that is either local or has already been loaded
1351  /// merged into its redecl chain.
1352  Decl *getMostRecentExistingDecl(Decl *D);
1353 
1354  RecordLocation DeclCursorForID(serialization::DeclID ID,
1355  SourceLocation &Location);
1356  void loadDeclUpdateRecords(PendingUpdateRecord &Record);
1357  void loadPendingDeclChain(Decl *D, uint64_t LocalOffset);
1358  void loadObjCCategories(serialization::GlobalDeclID ID, ObjCInterfaceDecl *D,
1359  unsigned PreviousGeneration = 0);
1360 
1361  RecordLocation getLocalBitOffset(uint64_t GlobalOffset);
1362  uint64_t getGlobalBitOffset(ModuleFile &M, uint32_t LocalOffset);
1363 
1364  /// Returns the first preprocessed entity ID that begins or ends after
1365  /// \arg Loc.
1367  findPreprocessedEntity(SourceLocation Loc, bool EndsAfter) const;
1368 
1369  /// Find the next module that contains entities and return the ID
1370  /// of the first entry.
1371  ///
1372  /// \param SLocMapI points at a chunk of a module that contains no
1373  /// preprocessed entities or the entities it contains are not the
1374  /// ones we are looking for.
1376  findNextPreprocessedEntity(
1377  GlobalSLocOffsetMapType::const_iterator SLocMapI) const;
1378 
1379  /// Returns (ModuleFile, Local index) pair for \p GlobalIndex of a
1380  /// preprocessed entity.
1381  std::pair<ModuleFile *, unsigned>
1382  getModulePreprocessedEntity(unsigned GlobalIndex);
1383 
1384  /// Returns (begin, end) pair for the preprocessed entities of a
1385  /// particular module.
1386  llvm::iterator_range<PreprocessingRecord::iterator>
1387  getModulePreprocessedEntities(ModuleFile &Mod) const;
1388 
1389 public:
1391  : public llvm::iterator_adaptor_base<
1392  ModuleDeclIterator, const serialization::LocalDeclID *,
1393  std::random_access_iterator_tag, const Decl *, ptrdiff_t,
1394  const Decl *, const Decl *> {
1395  ASTReader *Reader = nullptr;
1396  ModuleFile *Mod = nullptr;
1397 
1398  public:
1399  ModuleDeclIterator() : iterator_adaptor_base(nullptr) {}
1400 
1401  ModuleDeclIterator(ASTReader *Reader, ModuleFile *Mod,
1402  const serialization::LocalDeclID *Pos)
1403  : iterator_adaptor_base(Pos), Reader(Reader), Mod(Mod) {}
1404 
1405  value_type operator*() const {
1406  return Reader->GetDecl(Reader->getGlobalDeclID(*Mod, *I));
1407  }
1408 
1409  value_type operator->() const { return **this; }
1410 
1411  bool operator==(const ModuleDeclIterator &RHS) const {
1412  assert(Reader == RHS.Reader && Mod == RHS.Mod);
1413  return I == RHS.I;
1414  }
1415  };
1416 
1417  llvm::iterator_range<ModuleDeclIterator>
1418  getModuleFileLevelDecls(ModuleFile &Mod);
1419 
1420 private:
1421  void PassInterestingDeclsToConsumer();
1422  void PassInterestingDeclToConsumer(Decl *D);
1423 
1424  void finishPendingActions();
1425  void diagnoseOdrViolations();
1426 
1427  void pushExternalDeclIntoScope(NamedDecl *D, DeclarationName Name);
1428 
1429  void addPendingDeclContextInfo(Decl *D,
1431  serialization::GlobalDeclID LexicalDC) {
1432  assert(D);
1433  PendingDeclContextInfo Info = { D, SemaDC, LexicalDC };
1434  PendingDeclContextInfos.push_back(Info);
1435  }
1436 
1437  /// Produce an error diagnostic and return true.
1438  ///
1439  /// This routine should only be used for fatal errors that have to
1440  /// do with non-routine failures (e.g., corrupted AST file).
1441  void Error(StringRef Msg) const;
1442  void Error(unsigned DiagID, StringRef Arg1 = StringRef(),
1443  StringRef Arg2 = StringRef()) const;
1444  void Error(unsigned DiagID, StringRef Arg1, StringRef Arg2,
1445  unsigned Select) const;
1446  void Error(llvm::Error &&Err) const;
1447 
1448 public:
1449  /// Load the AST file and validate its contents against the given
1450  /// Preprocessor.
1451  ///
1452  /// \param PP the preprocessor associated with the context in which this
1453  /// precompiled header will be loaded.
1454  ///
1455  /// \param Context the AST context that this precompiled header will be
1456  /// loaded into, if any.
1457  ///
1458  /// \param PCHContainerRdr the PCHContainerOperations to use for loading and
1459  /// creating modules.
1460  ///
1461  /// \param Extensions the list of module file extensions that can be loaded
1462  /// from the AST files.
1463  ///
1464  /// \param isysroot If non-NULL, the system include path specified by the
1465  /// user. This is only used with relocatable PCH files. If non-NULL,
1466  /// a relocatable PCH file will use the default path "/".
1467  ///
1468  /// \param DisableValidation If true, the AST reader will suppress most
1469  /// of its regular consistency checking, allowing the use of precompiled
1470  /// headers that cannot be determined to be compatible.
1471  ///
1472  /// \param AllowASTWithCompilerErrors If true, the AST reader will accept an
1473  /// AST file the was created out of an AST with compiler errors,
1474  /// otherwise it will reject it.
1475  ///
1476  /// \param AllowConfigurationMismatch If true, the AST reader will not check
1477  /// for configuration differences between the AST file and the invocation.
1478  ///
1479  /// \param ValidateSystemInputs If true, the AST reader will validate
1480  /// system input files in addition to user input files. This is only
1481  /// meaningful if \p DisableValidation is false.
1482  ///
1483  /// \param UseGlobalIndex If true, the AST reader will try to load and use
1484  /// the global module index.
1485  ///
1486  /// \param ReadTimer If non-null, a timer used to track the time spent
1487  /// deserializing.
1488  ASTReader(Preprocessor &PP, InMemoryModuleCache &ModuleCache,
1489  ASTContext *Context, const PCHContainerReader &PCHContainerRdr,
1490  ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
1491  StringRef isysroot = "", bool DisableValidation = false,
1492  bool AllowASTWithCompilerErrors = false,
1493  bool AllowConfigurationMismatch = false,
1494  bool ValidateSystemInputs = false,
1495  bool ValidateASTInputFilesContent = false,
1496  bool UseGlobalIndex = true,
1497  std::unique_ptr<llvm::Timer> ReadTimer = {});
1498  ASTReader(const ASTReader &) = delete;
1499  ASTReader &operator=(const ASTReader &) = delete;
1500  ~ASTReader() override;
1501 
1502  SourceManager &getSourceManager() const { return SourceMgr; }
1503  FileManager &getFileManager() const { return FileMgr; }
1504  DiagnosticsEngine &getDiags() const { return Diags; }
1505 
1506  /// Flags that indicate what kind of AST loading failures the client
1507  /// of the AST reader can directly handle.
1508  ///
1509  /// When a client states that it can handle a particular kind of failure,
1510  /// the AST reader will not emit errors when producing that kind of failure.
1512  /// The client can't handle any AST loading failures.
1513  ARR_None = 0,
1514 
1515  /// The client can handle an AST file that cannot load because it
1516  /// is missing.
1517  ARR_Missing = 0x1,
1518 
1519  /// The client can handle an AST file that cannot load because it
1520  /// is out-of-date relative to its input files.
1521  ARR_OutOfDate = 0x2,
1522 
1523  /// The client can handle an AST file that cannot load because it
1524  /// was built with a different version of Clang.
1525  ARR_VersionMismatch = 0x4,
1526 
1527  /// The client can handle an AST file that cannot load because it's
1528  /// compiled configuration doesn't match that of the context it was
1529  /// loaded into.
1530  ARR_ConfigurationMismatch = 0x8
1531  };
1532 
1533  /// Load the AST file designated by the given file name.
1534  ///
1535  /// \param FileName The name of the AST file to load.
1536  ///
1537  /// \param Type The kind of AST being loaded, e.g., PCH, module, main file,
1538  /// or preamble.
1539  ///
1540  /// \param ImportLoc the location where the module file will be considered as
1541  /// imported from. For non-module AST types it should be invalid.
1542  ///
1543  /// \param ClientLoadCapabilities The set of client load-failure
1544  /// capabilities, represented as a bitset of the enumerators of
1545  /// LoadFailureCapabilities.
1546  ///
1547  /// \param Imported optional out-parameter to append the list of modules
1548  /// that were imported by precompiled headers or any other non-module AST file
1549  ASTReadResult ReadAST(StringRef FileName, ModuleKind Type,
1550  SourceLocation ImportLoc,
1551  unsigned ClientLoadCapabilities,
1552  SmallVectorImpl<ImportedSubmodule> *Imported = nullptr);
1553 
1554  /// Make the entities in the given module and any of its (non-explicit)
1555  /// submodules visible to name lookup.
1556  ///
1557  /// \param Mod The module whose names should be made visible.
1558  ///
1559  /// \param NameVisibility The level of visibility to give the names in the
1560  /// module. Visibility can only be increased over time.
1561  ///
1562  /// \param ImportLoc The location at which the import occurs.
1563  void makeModuleVisible(Module *Mod,
1564  Module::NameVisibilityKind NameVisibility,
1565  SourceLocation ImportLoc);
1566 
1567  /// Make the names within this set of hidden names visible.
1568  void makeNamesVisible(const HiddenNames &Names, Module *Owner);
1569 
1570  /// Note that MergedDef is a redefinition of the canonical definition
1571  /// Def, so Def should be visible whenever MergedDef is.
1572  void mergeDefinitionVisibility(NamedDecl *Def, NamedDecl *MergedDef);
1573 
1574  /// Take the AST callbacks listener.
1575  std::unique_ptr<ASTReaderListener> takeListener() {
1576  return std::move(Listener);
1577  }
1578 
1579  /// Set the AST callbacks listener.
1580  void setListener(std::unique_ptr<ASTReaderListener> Listener) {
1581  this->Listener = std::move(Listener);
1582  }
1583 
1584  /// Add an AST callback listener.
1585  ///
1586  /// Takes ownership of \p L.
1587  void addListener(std::unique_ptr<ASTReaderListener> L) {
1588  if (Listener)
1589  L = std::make_unique<ChainedASTReaderListener>(std::move(L),
1590  std::move(Listener));
1591  Listener = std::move(L);
1592  }
1593 
1594  /// RAII object to temporarily add an AST callback listener.
1596  ASTReader &Reader;
1597  bool Chained = false;
1598 
1599  public:
1600  ListenerScope(ASTReader &Reader, std::unique_ptr<ASTReaderListener> L)
1601  : Reader(Reader) {
1602  auto Old = Reader.takeListener();
1603  if (Old) {
1604  Chained = true;
1605  L = std::make_unique<ChainedASTReaderListener>(std::move(L),
1606  std::move(Old));
1607  }
1608  Reader.setListener(std::move(L));
1609  }
1610 
1612  auto New = Reader.takeListener();
1613  if (Chained)
1614  Reader.setListener(static_cast<ChainedASTReaderListener *>(New.get())
1615  ->takeSecond());
1616  }
1617  };
1618 
1619  /// Set the AST deserialization listener.
1620  void setDeserializationListener(ASTDeserializationListener *Listener,
1621  bool TakeOwnership = false);
1622 
1623  /// Get the AST deserialization listener.
1625  return DeserializationListener;
1626  }
1627 
1628  /// Determine whether this AST reader has a global index.
1629  bool hasGlobalIndex() const { return (bool)GlobalIndex; }
1630 
1631  /// Return global module index.
1632  GlobalModuleIndex *getGlobalIndex() { return GlobalIndex.get(); }
1633 
1634  /// Reset reader for a reload try.
1635  void resetForReload() { TriedLoadingGlobalIndex = false; }
1636 
1637  /// Attempts to load the global index.
1638  ///
1639  /// \returns true if loading the global index has failed for any reason.
1640  bool loadGlobalIndex();
1641 
1642  /// Determine whether we tried to load the global index, but failed,
1643  /// e.g., because it is out-of-date or does not exist.
1644  bool isGlobalIndexUnavailable() const;
1645 
1646  /// Initializes the ASTContext
1647  void InitializeContext();
1648 
1649  /// Update the state of Sema after loading some additional modules.
1650  void UpdateSema();
1651 
1652  /// Add in-memory (virtual file) buffer.
1653  void addInMemoryBuffer(StringRef &FileName,
1654  std::unique_ptr<llvm::MemoryBuffer> Buffer) {
1655  ModuleMgr.addInMemoryBuffer(FileName, std::move(Buffer));
1656  }
1657 
1658  /// Finalizes the AST reader's state before writing an AST file to
1659  /// disk.
1660  ///
1661  /// This operation may undo temporary state in the AST that should not be
1662  /// emitted.
1663  void finalizeForWriting();
1664 
1665  /// Retrieve the module manager.
1666  ModuleManager &getModuleManager() { return ModuleMgr; }
1667 
1668  /// Retrieve the preprocessor.
1669  Preprocessor &getPreprocessor() const { return PP; }
1670 
1671  /// Retrieve the name of the original source file name for the primary
1672  /// module file.
1674  return ModuleMgr.getPrimaryModule().OriginalSourceFileName;
1675  }
1676 
1677  /// Retrieve the name of the original source file name directly from
1678  /// the AST file, without actually loading the AST file.
1679  static std::string
1680  getOriginalSourceFile(const std::string &ASTFileName, FileManager &FileMgr,
1681  const PCHContainerReader &PCHContainerRdr,
1682  DiagnosticsEngine &Diags);
1683 
1684  /// Read the control block for the named AST file.
1685  ///
1686  /// \returns true if an error occurred, false otherwise.
1687  static bool
1688  readASTFileControlBlock(StringRef Filename, FileManager &FileMgr,
1689  const PCHContainerReader &PCHContainerRdr,
1690  bool FindModuleFileExtensions,
1691  ASTReaderListener &Listener,
1692  bool ValidateDiagnosticOptions);
1693 
1694  /// Determine whether the given AST file is acceptable to load into a
1695  /// translation unit with the given language and target options.
1696  static bool isAcceptableASTFile(StringRef Filename, FileManager &FileMgr,
1697  const PCHContainerReader &PCHContainerRdr,
1698  const LangOptions &LangOpts,
1699  const TargetOptions &TargetOpts,
1700  const PreprocessorOptions &PPOpts,
1701  StringRef ExistingModuleCachePath);
1702 
1703  /// Returns the suggested contents of the predefines buffer,
1704  /// which contains a (typically-empty) subset of the predefines
1705  /// build prior to including the precompiled header.
1706  const std::string &getSuggestedPredefines() { return SuggestedPredefines; }
1707 
1708  /// Read a preallocated preprocessed entity from the external source.
1709  ///
1710  /// \returns null if an error occurred that prevented the preprocessed
1711  /// entity from being loaded.
1712  PreprocessedEntity *ReadPreprocessedEntity(unsigned Index) override;
1713 
1714  /// Returns a pair of [Begin, End) indices of preallocated
1715  /// preprocessed entities that \p Range encompasses.
1716  std::pair<unsigned, unsigned>
1717  findPreprocessedEntitiesInRange(SourceRange Range) override;
1718 
1719  /// Optionally returns true or false if the preallocated preprocessed
1720  /// entity with index \p Index came from file \p FID.
1721  Optional<bool> isPreprocessedEntityInFileID(unsigned Index,
1722  FileID FID) override;
1723 
1724  /// Read a preallocated skipped range from the external source.
1725  SourceRange ReadSkippedRange(unsigned Index) override;
1726 
1727  /// Read the header file information for the given file entry.
1728  HeaderFileInfo GetHeaderFileInfo(const FileEntry *FE) override;
1729 
1730  void ReadPragmaDiagnosticMappings(DiagnosticsEngine &Diag);
1731 
1732  /// Returns the number of source locations found in the chain.
1733  unsigned getTotalNumSLocs() const {
1734  return TotalNumSLocEntries;
1735  }
1736 
1737  /// Returns the number of identifiers found in the chain.
1738  unsigned getTotalNumIdentifiers() const {
1739  return static_cast<unsigned>(IdentifiersLoaded.size());
1740  }
1741 
1742  /// Returns the number of macros found in the chain.
1743  unsigned getTotalNumMacros() const {
1744  return static_cast<unsigned>(MacrosLoaded.size());
1745  }
1746 
1747  /// Returns the number of types found in the chain.
1748  unsigned getTotalNumTypes() const {
1749  return static_cast<unsigned>(TypesLoaded.size());
1750  }
1751 
1752  /// Returns the number of declarations found in the chain.
1753  unsigned getTotalNumDecls() const {
1754  return static_cast<unsigned>(DeclsLoaded.size());
1755  }
1756 
1757  /// Returns the number of submodules known.
1758  unsigned getTotalNumSubmodules() const {
1759  return static_cast<unsigned>(SubmodulesLoaded.size());
1760  }
1761 
1762  /// Returns the number of selectors found in the chain.
1763  unsigned getTotalNumSelectors() const {
1764  return static_cast<unsigned>(SelectorsLoaded.size());
1765  }
1766 
1767  /// Returns the number of preprocessed entities known to the AST
1768  /// reader.
1770  unsigned Result = 0;
1771  for (const auto &M : ModuleMgr)
1772  Result += M.NumPreprocessedEntities;
1773  return Result;
1774  }
1775 
1776  /// Reads a TemplateArgumentLocInfo appropriate for the
1777  /// given TemplateArgument kind.
1779  GetTemplateArgumentLocInfo(ModuleFile &F, TemplateArgument::ArgKind Kind,
1780  const RecordData &Record, unsigned &Idx);
1781 
1782  /// Reads a TemplateArgumentLoc.
1784  ReadTemplateArgumentLoc(ModuleFile &F,
1785  const RecordData &Record, unsigned &Idx);
1786 
1788  ReadASTTemplateArgumentListInfo(ModuleFile &F,
1789  const RecordData &Record, unsigned &Index);
1790 
1791  /// Reads a declarator info from the given record.
1792  TypeSourceInfo *GetTypeSourceInfo(ModuleFile &F,
1793  const RecordData &Record, unsigned &Idx);
1794 
1795  /// Raad the type locations for the given TInfo.
1796  void ReadTypeLoc(ModuleFile &F, const RecordData &Record, unsigned &Idx,
1797  TypeLoc TL);
1798 
1799  /// Resolve a type ID into a type, potentially building a new
1800  /// type.
1801  QualType GetType(serialization::TypeID ID);
1802 
1803  /// Resolve a local type ID within a given AST file into a type.
1804  QualType getLocalType(ModuleFile &F, unsigned LocalID);
1805 
1806  /// Map a local type ID within a given AST file into a global type ID.
1807  serialization::TypeID getGlobalTypeID(ModuleFile &F, unsigned LocalID) const;
1808 
1809  /// Read a type from the current position in the given record, which
1810  /// was read from the given AST file.
1811  QualType readType(ModuleFile &F, const RecordData &Record, unsigned &Idx) {
1812  if (Idx >= Record.size())
1813  return {};
1814 
1815  return getLocalType(F, Record[Idx++]);
1816  }
1817 
1818  /// Map from a local declaration ID within a given module to a
1819  /// global declaration ID.
1820  serialization::DeclID getGlobalDeclID(ModuleFile &F,
1821  serialization::LocalDeclID LocalID) const;
1822 
1823  /// Returns true if global DeclID \p ID originated from module \p M.
1824  bool isDeclIDFromModule(serialization::GlobalDeclID ID, ModuleFile &M) const;
1825 
1826  /// Retrieve the module file that owns the given declaration, or NULL
1827  /// if the declaration is not from a module file.
1828  ModuleFile *getOwningModuleFile(const Decl *D);
1829 
1830  /// Get the best name we know for the module that owns the given
1831  /// declaration, or an empty string if the declaration is not from a module.
1832  std::string getOwningModuleNameForDiagnostic(const Decl *D);
1833 
1834  /// Returns the source location for the decl \p ID.
1835  SourceLocation getSourceLocationForDeclID(serialization::GlobalDeclID ID);
1836 
1837  /// Resolve a declaration ID into a declaration, potentially
1838  /// building a new declaration.
1839  Decl *GetDecl(serialization::DeclID ID);
1840  Decl *GetExternalDecl(uint32_t ID) override;
1841 
1842  /// Resolve a declaration ID into a declaration. Return 0 if it's not
1843  /// been loaded yet.
1844  Decl *GetExistingDecl(serialization::DeclID ID);
1845 
1846  /// Reads a declaration with the given local ID in the given module.
1847  Decl *GetLocalDecl(ModuleFile &F, uint32_t LocalID) {
1848  return GetDecl(getGlobalDeclID(F, LocalID));
1849  }
1850 
1851  /// Reads a declaration with the given local ID in the given module.
1852  ///
1853  /// \returns The requested declaration, casted to the given return type.
1854  template<typename T>
1855  T *GetLocalDeclAs(ModuleFile &F, uint32_t LocalID) {
1856  return cast_or_null<T>(GetLocalDecl(F, LocalID));
1857  }
1858 
1859  /// Map a global declaration ID into the declaration ID used to
1860  /// refer to this declaration within the given module fule.
1861  ///
1862  /// \returns the global ID of the given declaration as known in the given
1863  /// module file.
1865  mapGlobalIDToModuleFileGlobalID(ModuleFile &M,
1866  serialization::DeclID GlobalID);
1867 
1868  /// Reads a declaration ID from the given position in a record in the
1869  /// given module.
1870  ///
1871  /// \returns The declaration ID read from the record, adjusted to a global ID.
1872  serialization::DeclID ReadDeclID(ModuleFile &F, const RecordData &Record,
1873  unsigned &Idx);
1874 
1875  /// Reads a declaration from the given position in a record in the
1876  /// given module.
1877  Decl *ReadDecl(ModuleFile &F, const RecordData &R, unsigned &I) {
1878  return GetDecl(ReadDeclID(F, R, I));
1879  }
1880 
1881  /// Reads a declaration from the given position in a record in the
1882  /// given module.
1883  ///
1884  /// \returns The declaration read from this location, casted to the given
1885  /// result type.
1886  template<typename T>
1887  T *ReadDeclAs(ModuleFile &F, const RecordData &R, unsigned &I) {
1888  return cast_or_null<T>(GetDecl(ReadDeclID(F, R, I)));
1889  }
1890 
1891  /// If any redeclarations of \p D have been imported since it was
1892  /// last checked, this digs out those redeclarations and adds them to the
1893  /// redeclaration chain for \p D.
1894  void CompleteRedeclChain(const Decl *D) override;
1895 
1896  CXXBaseSpecifier *GetExternalCXXBaseSpecifiers(uint64_t Offset) override;
1897 
1898  /// Resolve the offset of a statement into a statement.
1899  ///
1900  /// This operation will read a new statement from the external
1901  /// source each time it is called, and is meant to be used via a
1902  /// LazyOffsetPtr (which is used by Decls for the body of functions, etc).
1903  Stmt *GetExternalDeclStmt(uint64_t Offset) override;
1904 
1905  /// ReadBlockAbbrevs - Enter a subblock of the specified BlockID with the
1906  /// specified cursor. Read the abbreviations that are at the top of the block
1907  /// and then leave the cursor pointing into the block.
1908  static bool ReadBlockAbbrevs(llvm::BitstreamCursor &Cursor, unsigned BlockID);
1909 
1910  /// Finds all the visible declarations with a given name.
1911  /// The current implementation of this method just loads the entire
1912  /// lookup table as unmaterialized references.
1913  bool FindExternalVisibleDeclsByName(const DeclContext *DC,
1914  DeclarationName Name) override;
1915 
1916  /// Read all of the declarations lexically stored in a
1917  /// declaration context.
1918  ///
1919  /// \param DC The declaration context whose declarations will be
1920  /// read.
1921  ///
1922  /// \param IsKindWeWant A predicate indicating which declaration kinds
1923  /// we are interested in.
1924  ///
1925  /// \param Decls Vector that will contain the declarations loaded
1926  /// from the external source. The caller is responsible for merging
1927  /// these declarations with any declarations already stored in the
1928  /// declaration context.
1929  void
1930  FindExternalLexicalDecls(const DeclContext *DC,
1931  llvm::function_ref<bool(Decl::Kind)> IsKindWeWant,
1932  SmallVectorImpl<Decl *> &Decls) override;
1933 
1934  /// Get the decls that are contained in a file in the Offset/Length
1935  /// range. \p Length can be 0 to indicate a point at \p Offset instead of
1936  /// a range.
1937  void FindFileRegionDecls(FileID File, unsigned Offset, unsigned Length,
1938  SmallVectorImpl<Decl *> &Decls) override;
1939 
1940  /// Notify ASTReader that we started deserialization of
1941  /// a decl or type so until FinishedDeserializing is called there may be
1942  /// decls that are initializing. Must be paired with FinishedDeserializing.
1943  void StartedDeserializing() override;
1944 
1945  /// Notify ASTReader that we finished the deserialization of
1946  /// a decl or type. Must be paired with StartedDeserializing.
1947  void FinishedDeserializing() override;
1948 
1949  /// Function that will be invoked when we begin parsing a new
1950  /// translation unit involving this external AST source.
1951  ///
1952  /// This function will provide all of the external definitions to
1953  /// the ASTConsumer.
1954  void StartTranslationUnit(ASTConsumer *Consumer) override;
1955 
1956  /// Print some statistics about AST usage.
1957  void PrintStats() override;
1958 
1959  /// Dump information about the AST reader to standard error.
1960  void dump();
1961 
1962  /// Return the amount of memory used by memory buffers, breaking down
1963  /// by heap-backed versus mmap'ed memory.
1964  void getMemoryBufferSizes(MemoryBufferSizes &sizes) const override;
1965 
1966  /// Initialize the semantic source with the Sema instance
1967  /// being used to perform semantic analysis on the abstract syntax
1968  /// tree.
1969  void InitializeSema(Sema &S) override;
1970 
1971  /// Inform the semantic consumer that Sema is no longer available.
1972  void ForgetSema() override { SemaObj = nullptr; }
1973 
1974  /// Retrieve the IdentifierInfo for the named identifier.
1975  ///
1976  /// This routine builds a new IdentifierInfo for the given identifier. If any
1977  /// declarations with this name are visible from translation unit scope, their
1978  /// declarations will be deserialized and introduced into the declaration
1979  /// chain of the identifier.
1980  IdentifierInfo *get(StringRef Name) override;
1981 
1982  /// Retrieve an iterator into the set of all identifiers
1983  /// in all loaded AST files.
1984  IdentifierIterator *getIdentifiers() override;
1985 
1986  /// Load the contents of the global method pool for a given
1987  /// selector.
1988  void ReadMethodPool(Selector Sel) override;
1989 
1990  /// Load the contents of the global method pool for a given
1991  /// selector if necessary.
1992  void updateOutOfDateSelector(Selector Sel) override;
1993 
1994  /// Load the set of namespaces that are known to the external source,
1995  /// which will be used during typo correction.
1996  void ReadKnownNamespaces(
1997  SmallVectorImpl<NamespaceDecl *> &Namespaces) override;
1998 
1999  void ReadUndefinedButUsed(
2000  llvm::MapVector<NamedDecl *, SourceLocation> &Undefined) override;
2001 
2002  void ReadMismatchingDeleteExpressions(llvm::MapVector<
2003  FieldDecl *, llvm::SmallVector<std::pair<SourceLocation, bool>, 4>> &
2004  Exprs) override;
2005 
2006  void ReadTentativeDefinitions(
2007  SmallVectorImpl<VarDecl *> &TentativeDefs) override;
2008 
2009  void ReadUnusedFileScopedDecls(
2010  SmallVectorImpl<const DeclaratorDecl *> &Decls) override;
2011 
2012  void ReadDelegatingConstructors(
2013  SmallVectorImpl<CXXConstructorDecl *> &Decls) override;
2014 
2015  void ReadExtVectorDecls(SmallVectorImpl<TypedefNameDecl *> &Decls) override;
2016 
2017  void ReadUnusedLocalTypedefNameCandidates(
2019 
2020  void ReadReferencedSelectors(
2021  SmallVectorImpl<std::pair<Selector, SourceLocation>> &Sels) override;
2022 
2023  void ReadWeakUndeclaredIdentifiers(
2024  SmallVectorImpl<std::pair<IdentifierInfo *, WeakInfo>> &WI) override;
2025 
2026  void ReadUsedVTables(SmallVectorImpl<ExternalVTableUse> &VTables) override;
2027 
2028  void ReadPendingInstantiations(
2029  SmallVectorImpl<std::pair<ValueDecl *,
2030  SourceLocation>> &Pending) override;
2031 
2032  void ReadLateParsedTemplates(
2033  llvm::MapVector<const FunctionDecl *, std::unique_ptr<LateParsedTemplate>>
2034  &LPTMap) override;
2035 
2036  /// Load a selector from disk, registering its ID if it exists.
2037  void LoadSelector(Selector Sel);
2038 
2039  void SetIdentifierInfo(unsigned ID, IdentifierInfo *II);
2040  void SetGloballyVisibleDecls(IdentifierInfo *II,
2041  const SmallVectorImpl<uint32_t> &DeclIDs,
2042  SmallVectorImpl<Decl *> *Decls = nullptr);
2043 
2044  /// Report a diagnostic.
2045  DiagnosticBuilder Diag(unsigned DiagID) const;
2046 
2047  /// Report a diagnostic.
2048  DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) const;
2049 
2050  IdentifierInfo *DecodeIdentifierInfo(serialization::IdentifierID ID);
2051 
2052  IdentifierInfo *GetIdentifierInfo(ModuleFile &M, const RecordData &Record,
2053  unsigned &Idx) {
2054  return DecodeIdentifierInfo(getGlobalIdentifierID(M, Record[Idx++]));
2055  }
2056 
2058  // Note that we are loading an identifier.
2059  Deserializing AnIdentifier(this);
2060 
2061  return DecodeIdentifierInfo(ID);
2062  }
2063 
2064  IdentifierInfo *getLocalIdentifier(ModuleFile &M, unsigned LocalID);
2065 
2066  serialization::IdentifierID getGlobalIdentifierID(ModuleFile &M,
2067  unsigned LocalID);
2068 
2069  void resolvePendingMacro(IdentifierInfo *II, const PendingMacroInfo &PMInfo);
2070 
2071  /// Retrieve the macro with the given ID.
2072  MacroInfo *getMacro(serialization::MacroID ID);
2073 
2074  /// Retrieve the global macro ID corresponding to the given local
2075  /// ID within the given module file.
2076  serialization::MacroID getGlobalMacroID(ModuleFile &M, unsigned LocalID);
2077 
2078  /// Read the source location entry with index ID.
2079  bool ReadSLocEntry(int ID) override;
2080 
2081  /// Retrieve the module import location and module name for the
2082  /// given source manager entry ID.
2083  std::pair<SourceLocation, StringRef> getModuleImportLoc(int ID) override;
2084 
2085  /// Retrieve the global submodule ID given a module and its local ID
2086  /// number.
2088  getGlobalSubmoduleID(ModuleFile &M, unsigned LocalID);
2089 
2090  /// Retrieve the submodule that corresponds to a global submodule ID.
2091  ///
2092  Module *getSubmodule(serialization::SubmoduleID GlobalID);
2093 
2094  /// Retrieve the module that corresponds to the given module ID.
2095  ///
2096  /// Note: overrides method in ExternalASTSource
2097  Module *getModule(unsigned ID) override;
2098 
2099  bool DeclIsFromPCHWithObjectFile(const Decl *D) override;
2100 
2101  /// Retrieve the module file with a given local ID within the specified
2102  /// ModuleFile.
2103  ModuleFile *getLocalModuleFile(ModuleFile &M, unsigned ID);
2104 
2105  /// Get an ID for the given module file.
2106  unsigned getModuleFileID(ModuleFile *M);
2107 
2108  /// Return a descriptor for the corresponding module.
2109  llvm::Optional<ASTSourceDescriptor> getSourceDescriptor(unsigned ID) override;
2110 
2111  ExtKind hasExternalDefinitions(const Decl *D) override;
2112 
2113  /// Retrieve a selector from the given module with its local ID
2114  /// number.
2115  Selector getLocalSelector(ModuleFile &M, unsigned LocalID);
2116 
2117  Selector DecodeSelector(serialization::SelectorID Idx);
2118 
2119  Selector GetExternalSelector(serialization::SelectorID ID) override;
2120  uint32_t GetNumExternalSelectors() override;
2121 
2122  Selector ReadSelector(ModuleFile &M, const RecordData &Record, unsigned &Idx) {
2123  return getLocalSelector(M, Record[Idx++]);
2124  }
2125 
2126  /// Retrieve the global selector ID that corresponds to this
2127  /// the local selector ID in a given module.
2128  serialization::SelectorID getGlobalSelectorID(ModuleFile &F,
2129  unsigned LocalID) const;
2130 
2131  /// Read a declaration name.
2132  DeclarationName ReadDeclarationName(ModuleFile &F,
2133  const RecordData &Record, unsigned &Idx);
2134  void ReadDeclarationNameLoc(ModuleFile &F,
2135  DeclarationNameLoc &DNLoc, DeclarationName Name,
2136  const RecordData &Record, unsigned &Idx);
2137  void ReadDeclarationNameInfo(ModuleFile &F, DeclarationNameInfo &NameInfo,
2138  const RecordData &Record, unsigned &Idx);
2139 
2140  void ReadQualifierInfo(ModuleFile &F, QualifierInfo &Info,
2141  const RecordData &Record, unsigned &Idx);
2142 
2143  NestedNameSpecifier *ReadNestedNameSpecifier(ModuleFile &F,
2144  const RecordData &Record,
2145  unsigned &Idx);
2146 
2147  NestedNameSpecifierLoc ReadNestedNameSpecifierLoc(ModuleFile &F,
2148  const RecordData &Record,
2149  unsigned &Idx);
2150 
2151  /// Read a template name.
2152  TemplateName ReadTemplateName(ModuleFile &F, const RecordData &Record,
2153  unsigned &Idx);
2154 
2155  /// Read a template argument.
2156  TemplateArgument ReadTemplateArgument(ModuleFile &F, const RecordData &Record,
2157  unsigned &Idx,
2158  bool Canonicalize = false);
2159 
2160  /// Read a template parameter list.
2161  TemplateParameterList *ReadTemplateParameterList(ModuleFile &F,
2162  const RecordData &Record,
2163  unsigned &Idx);
2164 
2165  /// Read a template argument array.
2166  void ReadTemplateArgumentList(SmallVectorImpl<TemplateArgument> &TemplArgs,
2167  ModuleFile &F, const RecordData &Record,
2168  unsigned &Idx, bool Canonicalize = false);
2169 
2170  /// Read a UnresolvedSet structure.
2171  void ReadUnresolvedSet(ModuleFile &F, LazyASTUnresolvedSet &Set,
2172  const RecordData &Record, unsigned &Idx);
2173 
2174  /// Read a C++ base specifier.
2175  CXXBaseSpecifier ReadCXXBaseSpecifier(ModuleFile &F,
2176  const RecordData &Record,unsigned &Idx);
2177 
2178  /// Read a CXXCtorInitializer array.
2180  ReadCXXCtorInitializers(ModuleFile &F, const RecordData &Record,
2181  unsigned &Idx);
2182 
2183  /// Read the contents of a CXXCtorInitializer array.
2184  CXXCtorInitializer **GetExternalCXXCtorInitializers(uint64_t Offset) override;
2185 
2186  /// Read a source location from raw form and return it in its
2187  /// originating module file's source location space.
2189  return SourceLocation::getFromRawEncoding((Raw >> 1) | (Raw << 31));
2190  }
2191 
2192  /// Read a source location from raw form.
2193  SourceLocation ReadSourceLocation(ModuleFile &ModuleFile, uint32_t Raw) const {
2194  SourceLocation Loc = ReadUntranslatedSourceLocation(Raw);
2195  return TranslateSourceLocation(ModuleFile, Loc);
2196  }
2197 
2198  /// Translate a source location from another module file's source
2199  /// location space into ours.
2200  SourceLocation TranslateSourceLocation(ModuleFile &ModuleFile,
2201  SourceLocation Loc) const {
2202  if (!ModuleFile.ModuleOffsetMap.empty())
2203  ReadModuleOffsetMap(ModuleFile);
2204  assert(ModuleFile.SLocRemap.find(Loc.getOffset()) !=
2205  ModuleFile.SLocRemap.end() &&
2206  "Cannot find offset to remap.");
2207  int Remap = ModuleFile.SLocRemap.find(Loc.getOffset())->second;
2208  return Loc.getLocWithOffset(Remap);
2209  }
2210 
2211  /// Read a source location.
2212  SourceLocation ReadSourceLocation(ModuleFile &ModuleFile,
2213  const RecordDataImpl &Record,
2214  unsigned &Idx) {
2215  return ReadSourceLocation(ModuleFile, Record[Idx++]);
2216  }
2217 
2218  /// Read a source range.
2219  SourceRange ReadSourceRange(ModuleFile &F,
2220  const RecordData &Record, unsigned &Idx);
2221 
2222  /// Read an integral value
2223  llvm::APInt ReadAPInt(const RecordData &Record, unsigned &Idx);
2224 
2225  /// Read a signed integral value
2226  llvm::APSInt ReadAPSInt(const RecordData &Record, unsigned &Idx);
2227 
2228  /// Read a floating-point value
2229  llvm::APFloat ReadAPFloat(const RecordData &Record,
2230  const llvm::fltSemantics &Sem, unsigned &Idx);
2231 
2232  /// Read an APValue
2233  APValue ReadAPValue(const RecordData &Record, unsigned &Idx);
2234 
2235  // Read a string
2236  static std::string ReadString(const RecordData &Record, unsigned &Idx);
2237 
2238  // Skip a string
2239  static void SkipString(const RecordData &Record, unsigned &Idx) {
2240  Idx += Record[Idx] + 1;
2241  }
2242 
2243  // Read a path
2244  std::string ReadPath(ModuleFile &F, const RecordData &Record, unsigned &Idx);
2245 
2246  // Read a path
2247  std::string ReadPath(StringRef BaseDirectory, const RecordData &Record,
2248  unsigned &Idx);
2249 
2250  // Skip a path
2251  static void SkipPath(const RecordData &Record, unsigned &Idx) {
2252  SkipString(Record, Idx);
2253  }
2254 
2255  /// Read a version tuple.
2256  static VersionTuple ReadVersionTuple(const RecordData &Record, unsigned &Idx);
2257 
2258  CXXTemporary *ReadCXXTemporary(ModuleFile &F, const RecordData &Record,
2259  unsigned &Idx);
2260 
2261  /// Reads one attribute from the current stream position.
2262  Attr *ReadAttr(ModuleFile &M, const RecordData &Record, unsigned &Idx);
2263 
2264  /// Reads attributes from the current stream position.
2265  void ReadAttributes(ASTRecordReader &Record, AttrVec &Attrs);
2266 
2267  /// Reads a statement.
2268  Stmt *ReadStmt(ModuleFile &F);
2269 
2270  /// Reads an expression.
2271  Expr *ReadExpr(ModuleFile &F);
2272 
2273  /// Reads a sub-statement operand during statement reading.
2275  assert(ReadingKind == Read_Stmt &&
2276  "Should be called only during statement reading!");
2277  // Subexpressions are stored from last to first, so the next Stmt we need
2278  // is at the back of the stack.
2279  assert(!StmtStack.empty() && "Read too many sub-statements!");
2280  return StmtStack.pop_back_val();
2281  }
2282 
2283  /// Reads a sub-expression operand during statement reading.
2284  Expr *ReadSubExpr();
2285 
2286  /// Reads a token out of a record.
2287  Token ReadToken(ModuleFile &M, const RecordDataImpl &Record, unsigned &Idx);
2288 
2289  /// Reads the macro record located at the given offset.
2290  MacroInfo *ReadMacroRecord(ModuleFile &F, uint64_t Offset);
2291 
2292  /// Determine the global preprocessed entity ID that corresponds to
2293  /// the given local ID within the given module.
2295  getGlobalPreprocessedEntityID(ModuleFile &M, unsigned LocalID) const;
2296 
2297  /// Add a macro to deserialize its macro directive history.
2298  ///
2299  /// \param II The name of the macro.
2300  /// \param M The module file.
2301  /// \param MacroDirectivesOffset Offset of the serialized macro directive
2302  /// history.
2303  void addPendingMacro(IdentifierInfo *II, ModuleFile *M,
2304  uint64_t MacroDirectivesOffset);
2305 
2306  /// Read the set of macros defined by this external macro source.
2307  void ReadDefinedMacros() override;
2308 
2309  /// Update an out-of-date identifier.
2310  void updateOutOfDateIdentifier(IdentifierInfo &II) override;
2311 
2312  /// Note that this identifier is up-to-date.
2313  void markIdentifierUpToDate(IdentifierInfo *II);
2314 
2315  /// Load all external visible decls in the given DeclContext.
2316  void completeVisibleDeclsMap(const DeclContext *DC) override;
2317 
2318  /// Retrieve the AST context that this AST reader supplements.
2320  assert(ContextObj && "requested AST context when not loading AST");
2321  return *ContextObj;
2322  }
2323 
2324  // Contains the IDs for declarations that were requested before we have
2325  // access to a Sema object.
2327 
2328  /// Retrieve the semantic analysis object used to analyze the
2329  /// translation unit in which the precompiled header is being
2330  /// imported.
2331  Sema *getSema() { return SemaObj; }
2332 
2333  /// Get the identifier resolver used for name lookup / updates
2334  /// in the translation unit scope. We have one of these even if we don't
2335  /// have a Sema object.
2336  IdentifierResolver &getIdResolver();
2337 
2338  /// Retrieve the identifier table associated with the
2339  /// preprocessor.
2340  IdentifierTable &getIdentifierTable();
2341 
2342  /// Record that the given ID maps to the given switch-case
2343  /// statement.
2344  void RecordSwitchCaseID(SwitchCase *SC, unsigned ID);
2345 
2346  /// Retrieve the switch-case statement with the given ID.
2347  SwitchCase *getSwitchCaseWithID(unsigned ID);
2348 
2349  void ClearSwitchCaseIDs();
2350 
2351  /// Cursors for comments blocks.
2352  SmallVector<std::pair<llvm::BitstreamCursor,
2354 
2355  /// Loads comments ranges.
2356  void ReadComments() override;
2357 
2358  /// Visit all the input files of the given module file.
2359  void visitInputFiles(serialization::ModuleFile &MF,
2360  bool IncludeSystem, bool Complain,
2361  llvm::function_ref<void(const serialization::InputFile &IF,
2362  bool isSystem)> Visitor);
2363 
2364  /// Visit all the top-level module maps loaded when building the given module
2365  /// file.
2366  void visitTopLevelModuleMaps(serialization::ModuleFile &MF,
2367  llvm::function_ref<
2368  void(const FileEntry *)> Visitor);
2369 
2370  bool isProcessingUpdateRecords() { return ProcessingUpdateRecords; }
2371 };
2372 
2373 /// An object for streaming information from a record.
2375  using ModuleFile = serialization::ModuleFile;
2376 
2377  ASTReader *Reader;
2378  ModuleFile *F;
2379  unsigned Idx = 0;
2380  ASTReader::RecordData Record;
2381 
2384 
2385 public:
2386  /// Construct an ASTRecordReader that uses the default encoding scheme.
2387  ASTRecordReader(ASTReader &Reader, ModuleFile &F) : Reader(&Reader), F(&F) {}
2388 
2389  /// Reads a record with id AbbrevID from Cursor, resetting the
2390  /// internal state.
2391  Expected<unsigned> readRecord(llvm::BitstreamCursor &Cursor,
2392  unsigned AbbrevID);
2393 
2394  /// Is this a module file for a module (rather than a PCH or similar).
2395  bool isModule() const { return F->isModule(); }
2396 
2397  /// Retrieve the AST context that this AST reader supplements.
2398  ASTContext &getContext() { return Reader->getContext(); }
2399 
2400  /// The current position in this record.
2401  unsigned getIdx() const { return Idx; }
2402 
2403  /// The length of this record.
2404  size_t size() const { return Record.size(); }
2405 
2406  /// An arbitrary index in this record.
2407  const uint64_t &operator[](size_t N) { return Record[N]; }
2408 
2409  /// The last element in this record.
2410  const uint64_t &back() const { return Record.back(); }
2411 
2412  /// Returns the current value in this record, and advances to the
2413  /// next value.
2414  const uint64_t &readInt() { return Record[Idx++]; }
2415 
2416  /// Returns the current value in this record, without advancing.
2417  const uint64_t &peekInt() { return Record[Idx]; }
2418 
2419  /// Skips the specified number of values.
2420  void skipInts(unsigned N) { Idx += N; }
2421 
2422  /// Retrieve the global submodule ID its local ID number.
2424  getGlobalSubmoduleID(unsigned LocalID) {
2425  return Reader->getGlobalSubmoduleID(*F, LocalID);
2426  }
2427 
2428  /// Retrieve the submodule that corresponds to a global submodule ID.
2430  return Reader->getSubmodule(GlobalID);
2431  }
2432 
2433  /// Read the record that describes the lexical contents of a DC.
2434  bool readLexicalDeclContextStorage(uint64_t Offset, DeclContext *DC) {
2435  return Reader->ReadLexicalDeclContextStorage(*F, F->DeclsCursor, Offset,
2436  DC);
2437  }
2438 
2439  /// Read the record that describes the visible contents of a DC.
2440  bool readVisibleDeclContextStorage(uint64_t Offset,
2441  serialization::DeclID ID) {
2442  return Reader->ReadVisibleDeclContextStorage(*F, F->DeclsCursor, Offset,
2443  ID);
2444  }
2445 
2447  uint64_t Kind = readInt();
2448  bool HasExpr = Kind & 0x1;
2449  Kind = Kind >> 1;
2450  return ExplicitSpecifier(HasExpr ? readExpr() : nullptr,
2451  static_cast<ExplicitSpecKind>(Kind));
2452  }
2453 
2456  return Reader->readExceptionSpec(*F, ExceptionStorage, ESI, Record, Idx);
2457  }
2458 
2459  /// Get the global offset corresponding to a local offset.
2460  uint64_t getGlobalBitOffset(uint32_t LocalOffset) {
2461  return Reader->getGlobalBitOffset(*F, LocalOffset);
2462  }
2463 
2464  /// Reads a statement.
2465  Stmt *readStmt() { return Reader->ReadStmt(*F); }
2466 
2467  /// Reads an expression.
2468  Expr *readExpr() { return Reader->ReadExpr(*F); }
2469 
2470  /// Reads a sub-statement operand during statement reading.
2471  Stmt *readSubStmt() { return Reader->ReadSubStmt(); }
2472 
2473  /// Reads a sub-expression operand during statement reading.
2474  Expr *readSubExpr() { return Reader->ReadSubExpr(); }
2475 
2476  /// Reads a declaration with the given local ID in the given module.
2477  ///
2478  /// \returns The requested declaration, casted to the given return type.
2479  template<typename T>
2480  T *GetLocalDeclAs(uint32_t LocalID) {
2481  return cast_or_null<T>(Reader->GetLocalDecl(*F, LocalID));
2482  }
2483 
2484  /// Reads a TemplateArgumentLocInfo appropriate for the
2485  /// given TemplateArgument kind, advancing Idx.
2488  return Reader->GetTemplateArgumentLocInfo(*F, Kind, Record, Idx);
2489  }
2490 
2491  /// Reads a TemplateArgumentLoc, advancing Idx.
2494  return Reader->ReadTemplateArgumentLoc(*F, Record, Idx);
2495  }
2496 
2499  return Reader->ReadASTTemplateArgumentListInfo(*F, Record, Idx);
2500  }
2501 
2502  /// Reads a declarator info from the given record, advancing Idx.
2504  return Reader->GetTypeSourceInfo(*F, Record, Idx);
2505  }
2506 
2507  /// Reads the location information for a type.
2509  return Reader->ReadTypeLoc(*F, Record, Idx, TL);
2510  }
2511 
2512  /// Map a local type ID within a given AST file to a global type ID.
2513  serialization::TypeID getGlobalTypeID(unsigned LocalID) const {
2514  return Reader->getGlobalTypeID(*F, LocalID);
2515  }
2516 
2517  /// Read a type from the current position in the record.
2519  return Reader->readType(*F, Record, Idx);
2520  }
2521 
2522  /// Reads a declaration ID from the given position in this record.
2523  ///
2524  /// \returns The declaration ID read from the record, adjusted to a global ID.
2526  return Reader->ReadDeclID(*F, Record, Idx);
2527  }
2528 
2529  /// Reads a declaration from the given position in a record in the
2530  /// given module, advancing Idx.
2531  Decl *readDecl() {
2532  return Reader->ReadDecl(*F, Record, Idx);
2533  }
2534 
2535  /// Reads a declaration from the given position in the record,
2536  /// advancing Idx.
2537  ///
2538  /// \returns The declaration read from this location, casted to the given
2539  /// result type.
2540  template<typename T>
2541  T *readDeclAs() {
2542  return Reader->ReadDeclAs<T>(*F, Record, Idx);
2543  }
2544 
2546  return Reader->GetIdentifierInfo(*F, Record, Idx);
2547  }
2548 
2549  /// Read a selector from the Record, advancing Idx.
2551  return Reader->ReadSelector(*F, Record, Idx);
2552  }
2553 
2554  /// Read a declaration name, advancing Idx.
2556  return Reader->ReadDeclarationName(*F, Record, Idx);
2557  }
2559  return Reader->ReadDeclarationNameLoc(*F, DNLoc, Name, Record, Idx);
2560  }
2562  return Reader->ReadDeclarationNameInfo(*F, NameInfo, Record, Idx);
2563  }
2564 
2566  return Reader->ReadQualifierInfo(*F, Info, Record, Idx);
2567  }
2568 
2570  return Reader->ReadNestedNameSpecifier(*F, Record, Idx);
2571  }
2572 
2574  return Reader->ReadNestedNameSpecifierLoc(*F, Record, Idx);
2575  }
2576 
2577  /// Read a template name, advancing Idx.
2579  return Reader->ReadTemplateName(*F, Record, Idx);
2580  }
2581 
2582  /// Read a template argument, advancing Idx.
2583  TemplateArgument readTemplateArgument(bool Canonicalize = false) {
2584  return Reader->ReadTemplateArgument(*F, Record, Idx, Canonicalize);
2585  }
2586 
2587  /// Read a template parameter list, advancing Idx.
2589  return Reader->ReadTemplateParameterList(*F, Record, Idx);
2590  }
2591 
2592  /// Read a template argument array, advancing Idx.
2594  bool Canonicalize = false) {
2595  return Reader->ReadTemplateArgumentList(TemplArgs, *F, Record, Idx,
2596  Canonicalize);
2597  }
2598 
2599  /// Read a UnresolvedSet structure, advancing Idx.
2601  return Reader->ReadUnresolvedSet(*F, Set, Record, Idx);
2602  }
2603 
2604  /// Read a C++ base specifier, advancing Idx.
2606  return Reader->ReadCXXBaseSpecifier(*F, Record, Idx);
2607  }
2608 
2609  /// Read a CXXCtorInitializer array, advancing Idx.
2611  return Reader->ReadCXXCtorInitializers(*F, Record, Idx);
2612  }
2613 
2615  return Reader->ReadCXXTemporary(*F, Record, Idx);
2616  }
2617 
2618  /// Read a source location, advancing Idx.
2620  return Reader->ReadSourceLocation(*F, Record, Idx);
2621  }
2622 
2623  /// Read a source range, advancing Idx.
2625  return Reader->ReadSourceRange(*F, Record, Idx);
2626  }
2627 
2628  APValue readAPValue() { return Reader->ReadAPValue(Record, Idx); }
2629 
2630  /// Read an integral value, advancing Idx.
2632  return Reader->ReadAPInt(Record, Idx);
2633  }
2634 
2635  /// Read a signed integral value, advancing Idx.
2637  return Reader->ReadAPSInt(Record, Idx);
2638  }
2639 
2640  /// Read a floating-point value, advancing Idx.
2641  llvm::APFloat readAPFloat(const llvm::fltSemantics &Sem) {
2642  return Reader->ReadAPFloat(Record, Sem,Idx);
2643  }
2644 
2645  /// Read a string, advancing Idx.
2646  std::string readString() {
2647  return Reader->ReadString(Record, Idx);
2648  }
2649 
2650  /// Read a path, advancing Idx.
2651  std::string readPath() {
2652  return Reader->ReadPath(*F, Record, Idx);
2653  }
2654 
2655  /// Read a version tuple, advancing Idx.
2656  VersionTuple readVersionTuple() {
2657  return ASTReader::ReadVersionTuple(Record, Idx);
2658  }
2659 
2660  /// Reads one attribute from the current stream position, advancing Idx.
2662  return Reader->ReadAttr(*F, Record, Idx);
2663  }
2664 
2665  /// Reads attributes from the current stream position, advancing Idx.
2666  void readAttributes(AttrVec &Attrs) {
2667  return Reader->ReadAttributes(*this, Attrs);
2668  }
2669 
2670  /// Reads a token out of a record, advancing Idx.
2672  return Reader->ReadToken(*F, Record, Idx);
2673  }
2674 
2675  void recordSwitchCaseID(SwitchCase *SC, unsigned ID) {
2676  Reader->RecordSwitchCaseID(SC, ID);
2677  }
2678 
2679  /// Retrieve the switch-case statement with the given ID.
2681  return Reader->getSwitchCaseWithID(ID);
2682  }
2683 };
2684 
2685 /// Helper class that saves the current stream position and
2686 /// then restores it when destroyed.
2688  explicit SavedStreamPosition(llvm::BitstreamCursor &Cursor)
2689  : Cursor(Cursor), Offset(Cursor.GetCurrentBitNo()) {}
2690 
2692  if (llvm::Error Err = Cursor.JumpToBit(Offset))
2693  llvm::report_fatal_error(
2694  "Cursor should always be able to go back, failed: " +
2695  toString(std::move(Err)));
2696  }
2697 
2698 private:
2699  llvm::BitstreamCursor &Cursor;
2700  uint64_t Offset;
2701 };
2702 
2703 inline void PCHValidator::Error(const char *Msg) {
2704  Reader.Error(Msg);
2705 }
2706 
2707 class OMPClauseReader : public OMPClauseVisitor<OMPClauseReader> {
2708  ASTRecordReader &Record;
2709  ASTContext &Context;
2710 
2711 public:
2713  : Record(Record), Context(Record.getContext()) {}
2714 
2715 #define OPENMP_CLAUSE(Name, Class) void Visit##Class(Class *C);
2716 #include "clang/Basic/OpenMPKinds.def"
2717  OMPClause *readClause();
2718  void VisitOMPClauseWithPreInit(OMPClauseWithPreInit *C);
2719  void VisitOMPClauseWithPostUpdate(OMPClauseWithPostUpdate *C);
2720 };
2721 
2722 } // namespace clang
2723 
2724 #endif // LLVM_CLANG_SERIALIZATION_ASTREADER_H
llvm::APInt ReadAPInt(const RecordData &Record, unsigned &Idx)
Read an integral value.
Definition: ASTReader.cpp:9645
const uint64_t & readInt()
Returns the current value in this record, and advances to the next value.
Definition: ASTReader.h:2414
SmallVector< std::pair< llvm::BitstreamCursor, serialization::ModuleFile * >, 8 > CommentsCursors
Cursors for comments blocks.
Definition: ASTReader.h:2353
Decl * GetLocalDecl(ModuleFile &F, uint32_t LocalID)
Reads a declaration with the given local ID in the given module.
Definition: ASTReader.h:1847
ASTReadResult
The result of reading the control block of an AST file, which can fail for various reasons...
Definition: ASTReader.h:380
SourceLocation readSourceLocation()
Read a source location, advancing Idx.
Definition: ASTReader.h:2619
Represents a function declaration or definition.
Definition: Decl.h:1784
SourceLocation ReadUntranslatedSourceLocation(uint32_t Raw) const
Read a source location from raw form and return it in its originating module file&#39;s source location s...
Definition: ASTReader.h:2188
static DiagnosticBuilder Diag(DiagnosticsEngine *Diags, const LangOptions &Features, FullSourceLoc TokLoc, const char *TokBegin, const char *TokRangeBegin, const char *TokRangeEnd, unsigned DiagID)
Produce a diagnostic highlighting some portion of a literal.
SourceLocation getLocWithOffset(int Offset) const
Return a source location with the specified offset from this SourceLocation.
Smart pointer class that efficiently represents Objective-C method names.
A (possibly-)qualified type.
Definition: Type.h:643
virtual bool ReadPreprocessorOptions(const PreprocessorOptions &PPOpts, bool Complain, std::string &SuggestedPredefines)
Receives the preprocessor options.
Definition: ASTReader.h:196
virtual bool visitInputFile(StringRef Filename, bool isSystem, bool isOverridden, bool isExplicitModule)
if needsInputFileVisitation returns true, this is called for each non-system input file of the AST Fi...
Definition: ASTReader.h:224
Implements support for file system lookup, file system caching, and directory search management...
Definition: FileManager.h:171
ASTConsumer - This is an abstract interface that should be implemented by clients that read ASTs...
Definition: ASTConsumer.h:33
virtual void visitModuleFile(StringRef Filename, serialization::ModuleKind Kind)
This is called for each AST file loaded.
Definition: ASTReader.h:207
SourceManager & getSourceManager() const
Definition: ASTReader.h:1502
RAII class for safely pairing a StartedDeserializing call with FinishedDeserializing.
OpenCL supported extensions and optional core features.
Definition: OpenCLOptions.h:23
ASTRecordReader(ASTReader &Reader, ModuleFile &F)
Construct an ASTRecordReader that uses the default encoding scheme.
Definition: ASTReader.h:2387
Stmt - This represents one statement.
Definition: Stmt.h:66
ModuleManager::ModuleReverseIterator ModuleReverseIterator
Definition: ASTReader.h:411
C Language Family Type Representation.
GlobalModuleIndex * getGlobalIndex()
Return global module index.
Definition: ASTReader.h:1632
Module * getSubmodule(serialization::SubmoduleID GlobalID)
Retrieve the submodule that corresponds to a global submodule ID.
Definition: ASTReader.cpp:8983
SourceLocation ReadSourceLocation(ModuleFile &ModuleFile, uint32_t Raw) const
Read a source location from raw form.
Definition: ASTReader.h:2193
Defines the clang::Module class, which describes a module in the source code.
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:88
virtual void ReadCounter(const serialization::ModuleFile &M, unsigned Value)
Receives COUNTER value.
Definition: ASTReader.h:203
llvm::APFloat readAPFloat(const llvm::fltSemantics &Sem)
Read a floating-point value, advancing Idx.
Definition: ASTReader.h:2641
The base class of the type hierarchy.
Definition: Type.h:1436
StringRef getOriginalSourceFile()
Retrieve the name of the original source file name for the primary module file.
Definition: ASTReader.h:1673
Decl * GetDecl(serialization::DeclID ID)
Resolve a declaration ID into a declaration, potentially building a new declaration.
Definition: ASTReader.cpp:7862
ModuleManager::ModuleConstIterator ModuleConstIterator
Definition: ASTReader.h:410
The l-value was an access to a declared entity or something equivalently strong, like the address of ...
A container of type source information.
Definition: Decl.h:86
Store information needed for an explicit specifier.
Definition: DeclCXX.h:1792
Base class that describes a preprocessed entity, which may be a preprocessor directive or macro expan...
void readQualifierInfo(QualifierInfo &Info)
Definition: ASTReader.h:2565
PreprocessorOptions - This class is used for passing the various options used in preprocessor initial...
void readTypeLoc(TypeLoc TL)
Reads the location information for a type.
Definition: ASTReader.h:2508
CXXBaseSpecifier ReadCXXBaseSpecifier(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Read a C++ base specifier.
Definition: ASTReader.cpp:9380
ModuleDeclIterator(ASTReader *Reader, ModuleFile *Mod, const serialization::LocalDeclID *Pos)
Definition: ASTReader.h:1401
Manages the set of modules loaded by an AST reader.
Definition: ModuleManager.h:48
Options for controlling the target.
Definition: TargetOptions.h:26
unsigned getTotalNumPreprocessedEntities() const
Returns the number of preprocessed entities known to the AST reader.
Definition: ASTReader.h:1769
void recordSwitchCaseID(SwitchCase *SC, unsigned ID)
Definition: ASTReader.h:2675
QualType readType()
Read a type from the current position in the record.
Definition: ASTReader.h:2518
Represents an explicit template argument list in C++, e.g., the "<int>" in "sort<int>".
Definition: TemplateBase.h:603
Stores a list of template parameters for a TemplateDecl and its derived classes.
Definition: DeclTemplate.h:67
T * ReadDeclAs(ModuleFile &F, const RecordData &R, unsigned &I)
Reads a declaration from the given position in a record in the given module.
Definition: ASTReader.h:1887
Selector ReadSelector(ModuleFile &M, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.h:2122
Module * getSubmodule(serialization::SubmoduleID GlobalID)
Retrieve the submodule that corresponds to a global submodule ID.
Definition: ASTReader.h:2429
An UnresolvedSet-like class that might not have been loaded from the external AST source yet...
Base wrapper for a particular "section" of type source info.
Definition: TypeLoc.h:56
serialization::TypeID getGlobalTypeID(unsigned LocalID) const
Map a local type ID within a given AST file to a global type ID.
Definition: ASTReader.h:2513
StringRef ModuleOffsetMap
The module offset map data for this file.
Definition: Module.h:215
NestedNameSpecifierLoc readNestedNameSpecifierLoc()
Definition: ASTReader.h:2573
One of these records is kept for each identifier that is lexed.
T * readDeclAs()
Reads a declaration from the given position in the record, advancing Idx.
Definition: ASTReader.h:2541
T * GetLocalDeclAs(ModuleFile &F, uint32_t LocalID)
Reads a declaration with the given local ID in the given module.
Definition: ASTReader.h:1855
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:160
A C++ nested-name-specifier augmented with source location information.
Utility class for loading a ASTContext from an AST file.
Definition: ASTUnit.h:89
static std::string toString(const clang::SanitizerSet &Sanitizers)
Produce a string containing comma-separated names of sanitizers in Sanitizers set.
unsigned getTotalNumDecls() const
Returns the number of declarations found in the chain.
Definition: ASTReader.h:1753
static SourceLocation getFromRawEncoding(unsigned Encoding)
Turn a raw encoding of a SourceLocation object into a real SourceLocation.
Represents a member of a struct/union/class.
Definition: Decl.h:2643
Definition: Format.h:2392
Expr * readExpr()
Reads an expression.
Definition: ASTReader.h:2468
Helper class that saves the current stream position and then restores it when destroyed.
Definition: ASTReader.h:2687
TemplateName ReadTemplateName(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Read a template name.
Definition: ASTReader.cpp:9217
virtual bool ReadLanguageOptions(const LangOptions &LangOpts, bool Complain, bool AllowCompatibleDifferences)
Receives the language options.
Definition: ASTReader.h:144
Token - This structure provides full information about a lexed token.
Definition: Token.h:34
TemplateArgument readTemplateArgument(bool Canonicalize=false)
Read a template argument, advancing Idx.
Definition: ASTReader.h:2583
Sema * getSema()
Retrieve the semantic analysis object used to analyze the translation unit in which the precompiled h...
Definition: ASTReader.h:2331
Stmt * ReadSubStmt()
Reads a sub-statement operand during statement reading.
Definition: ASTReader.h:2274
uint32_t MacroID
An ID number that refers to a macro in an AST file.
Definition: ASTBitCodes.h:140
The signature of a module, which is a hash of the AST content.
Definition: Module.h:54
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:49
static void SkipString(const RecordData &Record, unsigned &Idx)
Definition: ASTReader.h:2239
TypeSourceInfo * getTypeSourceInfo()
Reads a declarator info from the given record, advancing Idx.
Definition: ASTReader.h:2503
Decl * getKeyDeclaration(Decl *D)
Returns the first key declaration for the given declaration.
Definition: ASTReader.h:1232
Describes a module or submodule.
Definition: Module.h:64
size_t size() const
The length of this record.
Definition: ASTReader.h:2404
static VersionTuple ReadVersionTuple(const RecordData &Record, unsigned &Idx)
Read a version tuple.
Definition: ASTReader.cpp:9689
ImportedSubmodule(serialization::SubmoduleID ID, SourceLocation ImportLoc)
Definition: ASTReader.h:905
FileManager & getFileManager() const
Definition: ASTReader.h:1503
TypeSourceInfo * GetTypeSourceInfo(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Reads a declarator info from the given record.
Definition: ASTReader.cpp:7247
static void dump(llvm::raw_ostream &OS, StringRef FunctionName, ArrayRef< CounterExpression > Expressions, ArrayRef< CounterMappingRegion > Regions)
ModuleManager & getModuleManager()
Retrieve the module manager.
Definition: ASTReader.h:1666
void ReadQualifierInfo(ModuleFile &F, QualifierInfo &Info, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.cpp:9203
APValue ReadAPValue(const RecordData &Record, unsigned &Idx)
Read an APValue.
Definition: ASTReader.cpp:9601
serialization::DeclID getGlobalDeclID(ModuleFile &F, serialization::LocalDeclID LocalID) const
Map from a local declaration ID within a given module to a global declaration ID. ...
Definition: ASTReader.cpp:7730
CXXCtorInitializer ** ReadCXXCtorInitializers(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Read a CXXCtorInitializer array.
Definition: ASTReader.cpp:9396
llvm::APSInt ReadAPSInt(const RecordData &Record, unsigned &Idx)
Read a signed integral value.
Definition: ASTReader.cpp:9654
SourceLocation ReadSourceLocation(ModuleFile &ModuleFile, const RecordDataImpl &Record, unsigned &Idx)
Read a source location.
Definition: ASTReader.h:2212
std::string ReadPath(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.cpp:9674
Concrete class used by the front-end to report problems and issues.
Definition: Diagnostic.h:149
serialization::SubmoduleID getGlobalSubmoduleID(ModuleFile &M, unsigned LocalID)
Retrieve the global submodule ID given a module and its local ID number.
Definition: ASTReader.cpp:8968
CXXTemporary * ReadCXXTemporary(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.cpp:9701
TemplateArgument ReadTemplateArgument(ModuleFile &F, const RecordData &Record, unsigned &Idx, bool Canonicalize=false)
Read a template argument.
Definition: ASTReader.cpp:9281
ASTContext & getContext()
Retrieve the AST context that this AST reader supplements.
Definition: ASTReader.h:2319
Defines the Diagnostic-related interfaces.
SourceRange readSourceRange()
Read a source range, advancing Idx.
Definition: ASTReader.h:2624
const Decl * getKeyDeclaration(const Decl *D)
Definition: ASTReader.h:1242
std::string OriginalSourceFileName
The original source file name that was used to build the primary AST file, which may have been modifi...
Definition: Module.h:137
void resetForReload()
Reset reader for a reload try.
Definition: ASTReader.h:1635
TemplateArgumentLocInfo getTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind)
Reads a TemplateArgumentLocInfo appropriate for the given TemplateArgument kind, advancing Idx...
Definition: ASTReader.h:2487
ContinuousRangeMap< uint32_t, int, 2 > SLocRemap
Remapping table for source locations in this module.
Definition: Module.h:260
const ASTTemplateArgumentListInfo * readASTTemplateArgumentListInfo()
Definition: ASTReader.h:2498
Represents an ObjC class declaration.
Definition: DeclObjC.h:1171
This abstract interface provides operations for unwrapping containers for serialized ASTs (precompile...
CXXBaseSpecifier readCXXBaseSpecifier()
Read a C++ base specifier, advancing Idx.
Definition: ASTReader.h:2605
The AST file itself appears corrupted.
Definition: ASTReader.h:386
The preprocessor keeps track of this information for each file that is #included. ...
Definition: HeaderSearch.h:50
virtual Decl * getCanonicalDecl()
Retrieves the "canonical" declaration of the given declaration.
Definition: DeclBase.h:877
const uint64_t & peekInt()
Returns the current value in this record, without advancing.
Definition: ASTReader.h:2417
virtual bool needsInputFileVisitation()
Returns true if this ASTReaderListener wants to receive the input files of the AST file via visitInpu...
Definition: ASTReader.h:212
static std::string ReadString(const RecordData &Record, unsigned &Idx)
Definition: ASTReader.cpp:9667
virtual bool ReadFileSystemOptions(const FileSystemOptions &FSOpts, bool Complain)
Receives the file system options.
Definition: ASTReader.h:173
IdentifierInfo * GetIdentifierInfo(ModuleFile &M, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.h:2052
void ForgetSema() override
Inform the semantic consumer that Sema is no longer available.
Definition: ASTReader.h:1972
Sema - This implements semantic analysis and AST building for C.
Definition: Sema.h:331
A little helper class used to produce diagnostics.
Definition: Diagnostic.h:1043
TemplateParameterList * readTemplateParameterList()
Read a template parameter list, advancing Idx.
Definition: ASTReader.h:2588
virtual bool needsImportVisitation() const
Returns true if this ASTReaderListener wants to receive the imports of the AST file via visitImport...
Definition: ASTReader.h:231
bool operator==(const ModuleDeclIterator &RHS) const
Definition: ASTReader.h:1411
ModuleKind
Specifies the kind of module that has been loaded.
Definition: Module.h:42
StringRef Filename
Definition: Format.cpp:1807
Provides lookups to, and iteration over, IdentiferInfo objects.
void readTemplateArgumentList(SmallVectorImpl< TemplateArgument > &TemplArgs, bool Canonicalize=false)
Read a template argument array, advancing Idx.
Definition: ASTReader.h:2593
Decl * ReadDecl(ModuleFile &F, const RecordData &R, unsigned &I)
Reads a declaration from the given position in a record in the given module.
Definition: ASTReader.h:1877
std::string readPath()
Read a path, advancing Idx.
Definition: ASTReader.h:2651
llvm::pointee_iterator< SmallVectorImpl< std::unique_ptr< ModuleFile > >::reverse_iterator > ModuleReverseIterator
unsigned Offset
Definition: Format.cpp:1809
ASTReaderListener implementation to validate the information of the PCH file against an initialized P...
Definition: ASTReader.h:288
serialization::TypeID getGlobalTypeID(ModuleFile &F, unsigned LocalID) const
Map a local type ID within a given AST file into a global type ID.
Definition: ASTReader.cpp:7518
Abstract interface for external sources of preprocessor information.
Represent the declaration of a variable (in which case it is an lvalue) a function (in which case it ...
Definition: Decl.h:644
This represents one expression.
Definition: Expr.h:108
SwitchCase * getSwitchCaseWithID(unsigned ID)
Retrieve the switch-case statement with the given ID.
Definition: ASTReader.cpp:9731
QualType readType(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Read a type from the current position in the given record, which was read from the given AST file...
Definition: ASTReader.h:1811
RAII object to temporarily add an AST callback listener.
Definition: ASTReader.h:1595
Stmt * ReadStmt(ModuleFile &F)
Reads a statement.
Implements an efficient mapping from strings to IdentifierInfo nodes.
Stmt * readStmt()
Reads a statement.
Definition: ASTReader.h:2465
virtual void readModuleFileExtension(const ModuleFileExtensionMetadata &Metadata)
Indicates that a particular module file extension has been read.
Definition: ASTReader.h:238
Defines version macros and version-related utility functions for Clang.
unsigned getTotalNumSubmodules() const
Returns the number of submodules known.
Definition: ASTReader.h:1758
ArgKind
The kind of template argument we&#39;re storing.
Definition: TemplateBase.h:53
SimpleASTReaderListener(Preprocessor &PP)
Definition: ASTReader.h:321
ASTReaderListenter implementation to set SuggestedPredefines of ASTReader which is required to use a ...
Definition: ASTReader.h:317
SourceRange ReadSourceRange(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Read a source range.
Definition: ASTReader.cpp:9581
IdentifierResolver - Keeps track of shadowed decls on enclosing scopes.
Decl * readDecl()
Reads a declaration from the given position in a record in the given module, advancing Idx...
Definition: ASTReader.h:2531
Represents a C++ template name within the type system.
Definition: TemplateName.h:187
Information about a module that has been loaded by the ASTReader.
Definition: Module.h:107
OMPClauseReader(ASTRecordReader &Record)
Definition: ASTReader.h:2712
const uint64_t & back() const
The last element in this record.
Definition: ASTReader.h:2410
uint32_t IdentifierID
An ID number that refers to an identifier in an AST file.
Definition: ASTBitCodes.h:60
An iterator that walks over all of the known identifiers in the lookup table.
llvm::pointee_iterator< SmallVectorImpl< std::unique_ptr< ModuleFile > >::const_iterator > ModuleConstIterator
Defines the clang::IdentifierInfo, clang::IdentifierTable, and clang::Selector interfaces.
IdentifierInfo * getIdentifierInfo()
Definition: ASTReader.h:2545
SavedStreamPosition(llvm::BitstreamCursor &Cursor)
Definition: ASTReader.h:2688
The result type of a method or function.
std::string readString()
Read a string, advancing Idx.
Definition: ASTReader.h:2646
DiagnosticsEngine & getDiags() const
Definition: ASTReader.h:1504
SmallVector< uint64_t, 16 > PreloadedDeclIDs
Definition: ASTReader.h:2326
void ReadDeclarationNameInfo(ModuleFile &F, DeclarationNameInfo &NameInfo, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.cpp:9193
void skipInts(unsigned N)
Skips the specified number of values.
Definition: ASTReader.h:2420
This file defines OpenMP AST classes for clauses.
const uint64_t & operator[](size_t N)
An arbitrary index in this record.
Definition: ASTReader.h:2407
bool isModule() const
Is this a module file for a module (rather than a PCH or similar).
Definition: ASTReader.h:2395
The AST file was missing.
Definition: ASTReader.h:389
An abstract interface that should be implemented by external AST sources that also provide informatio...
NestedNameSpecifier * ReadNestedNameSpecifier(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.cpp:9462
Attr * ReadAttr(ModuleFile &M, const RecordData &Record, unsigned &Idx)
Reads one attribute from the current stream position.
In-memory cache for modules.
void addInMemoryBuffer(StringRef FileName, std::unique_ptr< llvm::MemoryBuffer > Buffer)
Add an in-memory buffer the list of known buffers.
uint32_t SubmoduleID
An ID number that refers to a submodule in a module file.
Definition: ASTBitCodes.h:171
static void SkipPath(const RecordData &Record, unsigned &Idx)
Definition: ASTReader.h:2251
Defines the clang::OpenCLOptions class.
A struct with extended info about a syntactic name qualifier, to be used for the case of out-of-line ...
Definition: Decl.h:669
The control block was read successfully.
Definition: ASTReader.h:383
Kind
void addListener(std::unique_ptr< ASTReaderListener > L)
Add an AST callback listener.
Definition: ASTReader.h:1587
CXXTemporary * readCXXTemporary()
Definition: ASTReader.h:2614
Encodes a location in the source.
unsigned getTotalNumMacros() const
Returns the number of macros found in the chain.
Definition: ASTReader.h:1743
llvm::APSInt APSInt
Stmt * readSubStmt()
Reads a sub-statement operand during statement reading.
Definition: ASTReader.h:2471
Represents a C++ temporary.
Definition: ExprCXX.h:1341
CXXCtorInitializer ** readCXXCtorInitializers()
Read a CXXCtorInitializer array, advancing Idx.
Definition: ASTReader.h:2610
An identifier-lookup iterator that enumerates all of the identifiers stored within a set of AST files...
Definition: ASTReader.cpp:8410
std::unique_ptr< ASTReaderListener > takeListener()
Take the AST callbacks listener.
Definition: ASTReader.h:1575
bool readLexicalDeclContextStorage(uint64_t Offset, DeclContext *DC)
Read the record that describes the lexical contents of a DC.
Definition: ASTReader.h:2434
Cached information about one file (either on disk or in the virtual file system). ...
Definition: FileManager.h:78
bool isModule() const
Is this a module file for a module (rather than a PCH or similar).
Definition: Module.h:476
bool isProcessingUpdateRecords()
Definition: ASTReader.h:2370
void readDeclarationNameInfo(DeclarationNameInfo &NameInfo)
Definition: ASTReader.h:2561
ASTDeserializationListener * getDeserializationListener()
Get the AST deserialization listener.
Definition: ASTReader.h:1624
TemplateParameterList * ReadTemplateParameterList(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Read a template parameter list.
Definition: ASTReader.cpp:9336
An abstract class that should be subclassed by any external source of preprocessing record entries...
Expr * readSubExpr()
Reads a sub-expression operand during statement reading.
Definition: ASTReader.h:2474
T * GetLocalDeclAs(uint32_t LocalID)
Reads a declaration with the given local ID in the given module.
Definition: ASTReader.h:2480
Represents a C++ nested name specifier, such as "\::std::vector<int>::".
std::string getClangFullRepositoryVersion()
Retrieves the full repository version that is an amalgamation of the information in getClangRepositor...
Definition: Version.cpp:89
virtual bool ReadFullVersionInformation(StringRef FullVersion)
Receives the full Clang version information.
Definition: ASTReader.h:134
void readDeclarationNameLoc(DeclarationNameLoc &DNLoc, DeclarationName Name)
Definition: ASTReader.h:2558
void addInMemoryBuffer(StringRef &FileName, std::unique_ptr< llvm::MemoryBuffer > Buffer)
Add in-memory (virtual file) buffer.
Definition: ASTReader.h:1653
PCHValidator(Preprocessor &PP, ASTReader &Reader)
Definition: ASTReader.h:293
unsigned getIdx() const
The current position in this record.
Definition: ASTReader.h:2401
llvm::APInt APInt
Definition: Integral.h:27
ASTContext & getContext()
Retrieve the AST context that this AST reader supplements.
Definition: ASTReader.h:2398
bool isFromASTFile() const
Determine whether this declaration came from an AST file (such as a precompiled header or module) rat...
Definition: DeclBase.h:702
uint32_t TypeID
An ID number that refers to a type in an AST file.
Definition: ASTBitCodes.h:85
void setListener(std::unique_ptr< ASTReaderListener > Listener)
Set the AST callbacks listener.
Definition: ASTReader.h:1580
void readExceptionSpec(SmallVectorImpl< QualType > &ExceptionStorage, FunctionProtoType::ExceptionSpecInfo &ESI)
Definition: ASTReader.h:2454
serialization::SubmoduleID getGlobalSubmoduleID(unsigned LocalID)
Retrieve the global submodule ID its local ID number.
Definition: ASTReader.h:2424
External source of source location entries.
serialization::SubmoduleID ID
Definition: ASTReader.h:902
virtual void visitImport(StringRef ModuleName, StringRef Filename)
If needsImportVisitation returns true, this is called for each AST file imported by this AST file...
Definition: ASTReader.h:235
A global index for a set of module files, providing information about the identifiers within those mo...
uint32_t PreprocessedEntityID
An ID number that refers to an entity in the detailed preprocessing record.
Definition: ASTBitCodes.h:168
DeclarationName ReadDeclarationName(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Read a declaration name.
Definition: ASTReader.cpp:9116
unsigned getTotalNumSelectors() const
Returns the number of selectors found in the chain.
Definition: ASTReader.h:1763
The AST file was writtten with a different language/target configuration.
Definition: ASTReader.h:400
llvm::APFloat ReadAPFloat(const RecordData &Record, const llvm::fltSemantics &Sem, unsigned &Idx)
Read a floating-point value.
Definition: ASTReader.cpp:9660
The input file that has been loaded from this AST file, along with bools indicating whether this was ...
Definition: Module.h:65
serialization::DeclID readDeclID()
Reads a declaration ID from the given position in this record.
Definition: ASTReader.h:2525
void readAttributes(AttrVec &Attrs)
Reads attributes from the current stream position, advancing Idx.
Definition: ASTReader.h:2666
DeclarationNameLoc - Additional source/type location info for a declaration name. ...
ChainedASTReaderListener(std::unique_ptr< ASTReaderListener > First, std::unique_ptr< ASTReaderListener > Second)
Takes ownership of First and Second.
Definition: ASTReader.h:249
unsigned getTotalNumTypes() const
Returns the number of types found in the chain.
Definition: ASTReader.h:1748
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
Represents a template argument.
Definition: TemplateBase.h:50
const ASTTemplateArgumentListInfo * ReadASTTemplateArgumentListInfo(ModuleFile &F, const RecordData &Record, unsigned &Index)
Definition: ASTReader.cpp:7586
uint32_t SelectorID
An ID number that refers to an ObjC selector in an AST file.
Definition: ASTBitCodes.h:153
Dataflow Directional Tag Classes.
llvm::BitstreamCursor DeclsCursor
DeclsCursor - This is a cursor to the start of the DECLS_BLOCK block.
Definition: Module.h:405
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Definition: DeclBase.h:1271
An external source of header file information, which may supply information about header files alread...
Definition: HeaderSearch.h:133
SourceLocation TranslateSourceLocation(ModuleFile &ModuleFile, SourceLocation Loc) const
Translate a source location from another module file&#39;s source location space into ours...
Definition: ASTReader.h:2200
Reads an AST files chain containing the contents of a translation unit.
Definition: ASTReader.h:354
Selector readSelector()
Read a selector from the Record, advancing Idx.
Definition: ASTReader.h:2550
Expr * ReadExpr(ModuleFile &F)
Reads an expression.
ListenerScope(ASTReader &Reader, std::unique_ptr< ASTReaderListener > L)
Definition: ASTReader.h:1600
ModuleFile & getPrimaryModule()
Returns the primary module associated with the manager, that is, the first module loaded...
ModuleManager::ModuleIterator ModuleIterator
Definition: ASTReader.h:409
bool hasGlobalIndex() const
Determine whether this AST reader has a global index.
Definition: ASTReader.h:1629
LoadFailureCapabilities
Flags that indicate what kind of AST loading failures the client of the AST reader can directly handl...
Definition: ASTReader.h:1511
The name of a declaration.
virtual void ReadModuleMapFile(StringRef ModuleMapPath)
Definition: ASTReader.h:139
TemplateArgumentLoc readTemplateArgumentLoc()
Reads a TemplateArgumentLoc, advancing Idx.
Definition: ASTReader.h:2493
A map from continuous integer ranges to some value, with a very specialized interface.
Class that performs lookup for an identifier stored in an AST file.
DeclarationNameInfo - A collector data type for bundling together a DeclarationName and the correspnd...
void ReadDeclarationNameLoc(ModuleFile &F, DeclarationNameLoc &DNLoc, DeclarationName Name, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.cpp:9160
uint32_t DeclID
An ID number that refers to a declaration in an AST file.
Definition: ASTBitCodes.h:68
VersionTuple readVersionTuple()
Read a version tuple, advancing Idx.
Definition: ASTReader.h:2656
Encapsulates the data about a macro definition (e.g.
Definition: MacroInfo.h:39
SmallVector< uint64_t, 64 > RecordData
Definition: ASTReader.h:375
void ReadUnresolvedSet(ModuleFile &F, LazyASTUnresolvedSet &Set, const RecordData &Record, unsigned &Idx)
Read a UnresolvedSet structure.
Definition: ASTReader.cpp:9368
Abstract interface for callback invocations by the ASTReader.
Definition: ASTReader.h:126
Location wrapper for a TemplateArgument.
Definition: TemplateBase.h:449
NestedNameSpecifierLoc ReadNestedNameSpecifierLoc(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.cpp:9517
Represents a C++ base or member initializer.
Definition: DeclCXX.h:2137
uint64_t getGlobalBitOffset(uint32_t LocalOffset)
Get the global offset corresponding to a local offset.
Definition: ASTReader.h:2460
void ReadTemplateArgumentList(SmallVectorImpl< TemplateArgument > &TemplArgs, ModuleFile &F, const RecordData &Record, unsigned &Idx, bool Canonicalize=false)
Read a template argument array.
Definition: ASTReader.cpp:9358
llvm::APSInt readAPSInt()
Read a signed integral value, advancing Idx.
Definition: ASTReader.h:2636
void forEachImportedKeyDecl(const Decl *D, Fn Visit)
Run a callback on each imported key declaration of D.
Definition: ASTReader.h:1248
void ReadTypeLoc(ModuleFile &F, const RecordData &Record, unsigned &Idx, TypeLoc TL)
Raad the type locations for the given TInfo.
Definition: ASTReader.cpp:7239
Holds information about the various types of exception specification.
Definition: Type.h:3779
Preprocessor & getPreprocessor() const
Retrieve the preprocessor.
Definition: ASTReader.h:1669
APValue - This class implements a discriminated union of [uninitialized] [APSInt] [APFloat]...
Definition: APValue.h:115
Represents a base class of a C++ class.
Definition: DeclCXX.h:147
Attr * readAttr()
Reads one attribute from the current stream position, advancing Idx.
Definition: ASTReader.h:2661
Metadata for a module file extension.
Keeps track of options that affect how file operations are performed.
virtual bool ReadHeaderSearchOptions(const HeaderSearchOptions &HSOpts, StringRef SpecificModuleCachePath, bool Complain)
Receives the header search options.
Definition: ASTReader.h:182
Defines the C++ Decl subclasses, other than those for templates (found in DeclTemplate.h) and friends (in DeclFriend.h).
TemplateName readTemplateName()
Read a template name, advancing Idx.
Definition: ASTReader.h:2578
SmallVectorImpl< uint64_t > RecordDataImpl
Definition: ASTReader.h:376
Defines the clang::SourceLocation class and associated facilities.
TemplateArgumentLoc ReadTemplateArgumentLoc(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Reads a TemplateArgumentLoc.
Definition: ASTReader.cpp:7573
TemplateArgumentLocInfo GetTemplateArgumentLocInfo(ModuleFile &F, TemplateArgument::ArgKind Kind, const RecordData &Record, unsigned &Idx)
Reads a TemplateArgumentLocInfo appropriate for the given TemplateArgument kind.
Definition: ASTReader.cpp:7537
serialization::DeclID ReadDeclID(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Reads a declaration ID from the given position in a record in the given module.
Definition: ASTReader.cpp:7900
virtual bool needsSystemInputFileVisitation()
Returns true if this ASTReaderListener wants to receive the system input files of the AST file via vi...
Definition: ASTReader.h:216
Expr * ReadSubExpr()
Reads a sub-expression operand during statement reading.
Token ReadToken(ModuleFile &M, const RecordDataImpl &Record, unsigned &Idx)
Reads a token out of a record.
Definition: ASTReader.cpp:1659
IdentifierInfo * GetIdentifier(serialization::IdentifierID ID) override
Definition: ASTReader.h:2057
unsigned getTotalNumSLocs() const
Returns the number of source locations found in the chain.
Definition: ASTReader.h:1733
Location information for a TemplateArgument.
Definition: TemplateBase.h:392
DeclarationName readDeclarationName()
Read a declaration name, advancing Idx.
Definition: ASTReader.h:2555
virtual bool ReadTargetOptions(const TargetOptions &TargetOpts, bool Complain, bool AllowCompatibleDifferences)
Receives the target options.
Definition: ASTReader.h:154
Writes an AST file containing the contents of a translation unit.
Definition: ASTWriter.h:103
virtual void ReadModuleName(StringRef ModuleName)
Definition: ASTReader.h:138
unsigned getTotalNumIdentifiers() const
Returns the number of identifiers found in the chain.
Definition: ASTReader.h:1738
ExplicitSpecifier readExplicitSpec()
Definition: ASTReader.h:2446
llvm::APInt readAPInt()
Read an integral value, advancing Idx.
Definition: ASTReader.h:2631
The AST file is out-of-date relative to its input files, and needs to be regenerated.
Definition: ASTReader.h:393
NameVisibilityKind
Describes the visibility of the various names within a particular module.
Definition: Module.h:273
Simple wrapper class for chaining listeners.
Definition: ASTReader.h:243
An object for streaming information from a record.
Definition: ASTReader.h:2374
bool readVisibleDeclContextStorage(uint64_t Offset, serialization::DeclID ID)
Read the record that describes the visible contents of a DC.
Definition: ASTReader.h:2440
Kind
Lists the kind of concrete classes of Decl.
Definition: DeclBase.h:91
HeaderSearchOptions - Helper class for storing options related to the initialization of the HeaderSea...
The AST file was written by a different version of Clang.
Definition: ASTReader.h:396
void ReadAttributes(ASTRecordReader &Record, AttrVec &Attrs)
Reads attributes from the current stream position.
NestedNameSpecifier * readNestedNameSpecifier()
Definition: ASTReader.h:2569
Token readToken()
Reads a token out of a record, advancing Idx.
Definition: ASTReader.h:2671
std::unique_ptr< ASTReaderListener > takeSecond()
Definition: ASTReader.h:254
const std::string & getSuggestedPredefines()
Returns the suggested contents of the predefines buffer, which contains a (typically-empty) subset of...
Definition: ASTReader.h:1706
A trivial tuple used to represent a source range.
This represents a decl that may have a name.
Definition: Decl.h:248
SwitchCase * getSwitchCaseWithID(unsigned ID)
Retrieve the switch-case statement with the given ID.
Definition: ASTReader.h:2680
llvm::pointee_iterator< SmallVectorImpl< std::unique_ptr< ModuleFile > >::iterator > ModuleIterator
std::unique_ptr< ASTReaderListener > takeFirst()
Definition: ASTReader.h:253
bool isSystem(CharacteristicKind CK)
Determine whether a file / directory characteristic is for system code.
Definition: SourceManager.h:82
This class handles loading and caching of source files into memory.
Attr - This represents one attribute.
Definition: Attr.h:45
virtual bool ReadDiagnosticOptions(IntrusiveRefCntPtr< DiagnosticOptions > DiagOpts, bool Complain)
Receives the diagnostic options.
Definition: ASTReader.h:164
void RecordSwitchCaseID(SwitchCase *SC, unsigned ID)
Record that the given ID maps to the given switch-case statement.
Definition: ASTReader.cpp:9724
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:125
void readUnresolvedSet(LazyASTUnresolvedSet &Set)
Read a UnresolvedSet structure, advancing Idx.
Definition: ASTReader.h:2600