clang  8.0.0svn
ASTReader.h
Go to the documentation of this file.
1 //===- ASTReader.h - AST File Reader ----------------------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines the ASTReader class, which reads AST files.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_SERIALIZATION_ASTREADER_H
15 #define LLVM_CLANG_SERIALIZATION_ASTREADER_H
16 
17 #include "clang/AST/DeclCXX.h"
18 #include "clang/AST/DeclObjC.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/Bitcode/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 MemoryBufferCache;
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 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  /// The cache that manages memory buffers for PCM files.
444  MemoryBufferCache &PCMCache;
445 
446  /// A dummy identifier resolver used to merge TU-scope declarations in
447  /// C, for the cases where we don't have a Sema object to provide a real
448  /// identifier resolver.
449  IdentifierResolver DummyIdResolver;
450 
451  /// A mapping from extension block names to module file extensions.
452  llvm::StringMap<std::shared_ptr<ModuleFileExtension>> ModuleFileExtensions;
453 
454  /// A timer used to track the time spent deserializing.
455  std::unique_ptr<llvm::Timer> ReadTimer;
456 
457  /// The location where the module file will be considered as
458  /// imported from. For non-module AST types it should be invalid.
459  SourceLocation CurrentImportLoc;
460 
461  /// The global module index, if loaded.
462  std::unique_ptr<GlobalModuleIndex> GlobalIndex;
463 
464  /// A map of global bit offsets to the module that stores entities
465  /// at those bit offsets.
467 
468  /// A map of negated SLocEntryIDs to the modules containing them.
470 
473 
474  /// A map of reversed (SourceManager::MaxLoadedOffset - SLocOffset)
475  /// SourceLocation offsets to the modules containing them.
476  GlobalSLocOffsetMapType GlobalSLocOffsetMap;
477 
478  /// Types that have already been loaded from the chain.
479  ///
480  /// When the pointer at index I is non-NULL, the type with
481  /// ID = (I + 1) << FastQual::Width has already been loaded
482  std::vector<QualType> TypesLoaded;
483 
484  using GlobalTypeMapType =
486 
487  /// Mapping from global type IDs to the module in which the
488  /// type resides along with the offset that should be added to the
489  /// global type ID to produce a local ID.
490  GlobalTypeMapType GlobalTypeMap;
491 
492  /// Declarations that have already been loaded from the chain.
493  ///
494  /// When the pointer at index I is non-NULL, the declaration with ID
495  /// = I + 1 has already been loaded.
496  std::vector<Decl *> DeclsLoaded;
497 
498  using GlobalDeclMapType =
500 
501  /// Mapping from global declaration IDs to the module in which the
502  /// declaration resides.
503  GlobalDeclMapType GlobalDeclMap;
504 
505  using FileOffset = std::pair<ModuleFile *, uint64_t>;
507  using DeclUpdateOffsetsMap =
508  llvm::DenseMap<serialization::DeclID, FileOffsetsTy>;
509 
510  /// Declarations that have modifications residing in a later file
511  /// in the chain.
512  DeclUpdateOffsetsMap DeclUpdateOffsets;
513 
514  struct PendingUpdateRecord {
515  Decl *D;
517 
518  // Whether the declaration was just deserialized.
519  bool JustLoaded;
520 
521  PendingUpdateRecord(serialization::GlobalDeclID ID, Decl *D,
522  bool JustLoaded)
523  : D(D), ID(ID), JustLoaded(JustLoaded) {}
524  };
525 
526  /// Declaration updates for already-loaded declarations that we need
527  /// to apply once we finish processing an import.
528  llvm::SmallVector<PendingUpdateRecord, 16> PendingUpdateRecords;
529 
530  enum class PendingFakeDefinitionKind { NotFake, Fake, FakeLoaded };
531 
532  /// The DefinitionData pointers that we faked up for class definitions
533  /// that we needed but hadn't loaded yet.
534  llvm::DenseMap<void *, PendingFakeDefinitionKind> PendingFakeDefinitionData;
535 
536  /// Exception specification updates that have been loaded but not yet
537  /// propagated across the relevant redeclaration chain. The map key is the
538  /// canonical declaration (used only for deduplication) and the value is a
539  /// declaration that has an exception specification.
540  llvm::SmallMapVector<Decl *, FunctionDecl *, 4> PendingExceptionSpecUpdates;
541 
542  /// Deduced return type updates that have been loaded but not yet propagated
543  /// across the relevant redeclaration chain. The map key is the canonical
544  /// declaration and the value is the deduced return type.
545  llvm::SmallMapVector<FunctionDecl *, QualType, 4> PendingDeducedTypeUpdates;
546 
547  /// Declarations that have been imported and have typedef names for
548  /// linkage purposes.
549  llvm::DenseMap<std::pair<DeclContext *, IdentifierInfo *>, NamedDecl *>
550  ImportedTypedefNamesForLinkage;
551 
552  /// Mergeable declaration contexts that have anonymous declarations
553  /// within them, and those anonymous declarations.
554  llvm::DenseMap<Decl*, llvm::SmallVector<NamedDecl*, 2>>
555  AnonymousDeclarationsForMerging;
556 
557  struct FileDeclsInfo {
558  ModuleFile *Mod = nullptr;
560 
561  FileDeclsInfo() = default;
562  FileDeclsInfo(ModuleFile *Mod, ArrayRef<serialization::LocalDeclID> Decls)
563  : Mod(Mod), Decls(Decls) {}
564  };
565 
566  /// Map from a FileID to the file-level declarations that it contains.
567  llvm::DenseMap<FileID, FileDeclsInfo> FileDeclIDs;
568 
569  /// An array of lexical contents of a declaration context, as a sequence of
570  /// Decl::Kind, DeclID pairs.
572 
573  /// Map from a DeclContext to its lexical contents.
574  llvm::DenseMap<const DeclContext*, std::pair<ModuleFile*, LexicalContents>>
575  LexicalDecls;
576 
577  /// Map from the TU to its lexical contents from each module file.
578  std::vector<std::pair<ModuleFile*, LexicalContents>> TULexicalDecls;
579 
580  /// Map from a DeclContext to its lookup tables.
581  llvm::DenseMap<const DeclContext *,
583 
584  // Updates for visible decls can occur for other contexts than just the
585  // TU, and when we read those update records, the actual context may not
586  // be available yet, so have this pending map using the ID as a key. It
587  // will be realized when the context is actually loaded.
588  struct PendingVisibleUpdate {
589  ModuleFile *Mod;
590  const unsigned char *Data;
591  };
593 
594  /// Updates to the visible declarations of declaration contexts that
595  /// haven't been loaded yet.
596  llvm::DenseMap<serialization::DeclID, DeclContextVisibleUpdates>
597  PendingVisibleUpdates;
598 
599  /// The set of C++ or Objective-C classes that have forward
600  /// declarations that have not yet been linked to their definitions.
601  llvm::SmallPtrSet<Decl *, 4> PendingDefinitions;
602 
603  using PendingBodiesMap =
604  llvm::MapVector<Decl *, uint64_t,
605  llvm::SmallDenseMap<Decl *, unsigned, 4>,
607 
608  /// Functions or methods that have bodies that will be attached.
609  PendingBodiesMap PendingBodies;
610 
611  /// Definitions for which we have added merged definitions but not yet
612  /// performed deduplication.
613  llvm::SetVector<NamedDecl *> PendingMergedDefinitionsToDeduplicate;
614 
615  /// Read the record that describes the lexical contents of a DC.
616  bool ReadLexicalDeclContextStorage(ModuleFile &M,
617  llvm::BitstreamCursor &Cursor,
618  uint64_t Offset, DeclContext *DC);
619 
620  /// Read the record that describes the visible contents of a DC.
621  bool ReadVisibleDeclContextStorage(ModuleFile &M,
622  llvm::BitstreamCursor &Cursor,
623  uint64_t Offset, serialization::DeclID ID);
624 
625  /// A vector containing identifiers that have already been
626  /// loaded.
627  ///
628  /// If the pointer at index I is non-NULL, then it refers to the
629  /// IdentifierInfo for the identifier with ID=I+1 that has already
630  /// been loaded.
631  std::vector<IdentifierInfo *> IdentifiersLoaded;
632 
635 
636  /// Mapping from global identifier IDs to the module in which the
637  /// identifier resides along with the offset that should be added to the
638  /// global identifier ID to produce a local ID.
639  GlobalIdentifierMapType GlobalIdentifierMap;
640 
641  /// A vector containing macros that have already been
642  /// loaded.
643  ///
644  /// If the pointer at index I is non-NULL, then it refers to the
645  /// MacroInfo for the identifier with ID=I+1 that has already
646  /// been loaded.
647  std::vector<MacroInfo *> MacrosLoaded;
648 
649  using LoadedMacroInfo =
650  std::pair<IdentifierInfo *, serialization::SubmoduleID>;
651 
652  /// A set of #undef directives that we have loaded; used to
653  /// deduplicate the same #undef information coming from multiple module
654  /// files.
655  llvm::DenseSet<LoadedMacroInfo> LoadedUndefs;
656 
657  using GlobalMacroMapType =
659 
660  /// Mapping from global macro IDs to the module in which the
661  /// macro resides along with the offset that should be added to the
662  /// global macro ID to produce a local ID.
663  GlobalMacroMapType GlobalMacroMap;
664 
665  /// A vector containing submodules that have already been loaded.
666  ///
667  /// This vector is indexed by the Submodule ID (-1). NULL submodule entries
668  /// indicate that the particular submodule ID has not yet been loaded.
669  SmallVector<Module *, 2> SubmodulesLoaded;
670 
671  using GlobalSubmoduleMapType =
673 
674  /// Mapping from global submodule IDs to the module file in which the
675  /// submodule resides along with the offset that should be added to the
676  /// global submodule ID to produce a local ID.
677  GlobalSubmoduleMapType GlobalSubmoduleMap;
678 
679  /// A set of hidden declarations.
681  using HiddenNamesMapType = llvm::DenseMap<Module *, HiddenNames>;
682 
683  /// A mapping from each of the hidden submodules to the deserialized
684  /// declarations in that submodule that could be made visible.
685  HiddenNamesMapType HiddenNamesMap;
686 
687  /// A module import, export, or conflict that hasn't yet been resolved.
688  struct UnresolvedModuleRef {
689  /// The file in which this module resides.
690  ModuleFile *File;
691 
692  /// The module that is importing or exporting.
693  Module *Mod;
694 
695  /// The kind of module reference.
696  enum { Import, Export, Conflict } Kind;
697 
698  /// The local ID of the module that is being exported.
699  unsigned ID;
700 
701  /// Whether this is a wildcard export.
702  unsigned IsWildcard : 1;
703 
704  /// String data.
705  StringRef String;
706  };
707 
708  /// The set of module imports and exports that still need to be
709  /// resolved.
710  SmallVector<UnresolvedModuleRef, 2> UnresolvedModuleRefs;
711 
712  /// A vector containing selectors that have already been loaded.
713  ///
714  /// This vector is indexed by the Selector ID (-1). NULL selector
715  /// entries indicate that the particular selector ID has not yet
716  /// been loaded.
717  SmallVector<Selector, 16> SelectorsLoaded;
718 
719  using GlobalSelectorMapType =
721 
722  /// Mapping from global selector IDs to the module in which the
723  /// global selector ID to produce a local ID.
724  GlobalSelectorMapType GlobalSelectorMap;
725 
726  /// The generation number of the last time we loaded data from the
727  /// global method pool for this selector.
728  llvm::DenseMap<Selector, unsigned> SelectorGeneration;
729 
730  /// Whether a selector is out of date. We mark a selector as out of date
731  /// if we load another module after the method pool entry was pulled in.
732  llvm::DenseMap<Selector, bool> SelectorOutOfDate;
733 
734  struct PendingMacroInfo {
735  ModuleFile *M;
736  uint64_t MacroDirectivesOffset;
737 
738  PendingMacroInfo(ModuleFile *M, uint64_t MacroDirectivesOffset)
739  : M(M), MacroDirectivesOffset(MacroDirectivesOffset) {}
740  };
741 
742  using PendingMacroIDsMap =
743  llvm::MapVector<IdentifierInfo *, SmallVector<PendingMacroInfo, 2>>;
744 
745  /// Mapping from identifiers that have a macro history to the global
746  /// IDs have not yet been deserialized to the global IDs of those macros.
747  PendingMacroIDsMap PendingMacroIDs;
748 
751 
752  /// Mapping from global preprocessing entity IDs to the module in
753  /// which the preprocessed entity resides along with the offset that should be
754  /// added to the global preprocessing entity ID to produce a local ID.
755  GlobalPreprocessedEntityMapType GlobalPreprocessedEntityMap;
756 
759 
760  /// Mapping from global skipped range base IDs to the module in which
761  /// the skipped ranges reside.
762  GlobalSkippedRangeMapType GlobalSkippedRangeMap;
763 
764  /// \name CodeGen-relevant special data
765  /// Fields containing data that is relevant to CodeGen.
766  //@{
767 
768  /// The IDs of all declarations that fulfill the criteria of
769  /// "interesting" decls.
770  ///
771  /// This contains the data loaded from all EAGERLY_DESERIALIZED_DECLS blocks
772  /// in the chain. The referenced declarations are deserialized and passed to
773  /// the consumer eagerly.
774  SmallVector<uint64_t, 16> EagerlyDeserializedDecls;
775 
776  /// The IDs of all tentative definitions stored in the chain.
777  ///
778  /// Sema keeps track of all tentative definitions in a TU because it has to
779  /// complete them and pass them on to CodeGen. Thus, tentative definitions in
780  /// the PCH chain must be eagerly deserialized.
781  SmallVector<uint64_t, 16> TentativeDefinitions;
782 
783  /// The IDs of all CXXRecordDecls stored in the chain whose VTables are
784  /// used.
785  ///
786  /// CodeGen has to emit VTables for these records, so they have to be eagerly
787  /// deserialized.
788  SmallVector<uint64_t, 64> VTableUses;
789 
790  /// A snapshot of the pending instantiations in the chain.
791  ///
792  /// This record tracks the instantiations that Sema has to perform at the
793  /// end of the TU. It consists of a pair of values for every pending
794  /// instantiation where the first value is the ID of the decl and the second
795  /// is the instantiation location.
796  SmallVector<uint64_t, 64> PendingInstantiations;
797 
798  //@}
799 
800  /// \name DiagnosticsEngine-relevant special data
801  /// Fields containing data that is used for generating diagnostics
802  //@{
803 
804  /// A snapshot of Sema's unused file-scoped variable tracking, for
805  /// generating warnings.
806  SmallVector<uint64_t, 16> UnusedFileScopedDecls;
807 
808  /// A list of all the delegating constructors we've seen, to diagnose
809  /// cycles.
810  SmallVector<uint64_t, 4> DelegatingCtorDecls;
811 
812  /// Method selectors used in a @selector expression. Used for
813  /// implementation of -Wselector.
814  SmallVector<uint64_t, 64> ReferencedSelectorsData;
815 
816  /// A snapshot of Sema's weak undeclared identifier tracking, for
817  /// generating warnings.
818  SmallVector<uint64_t, 64> WeakUndeclaredIdentifiers;
819 
820  /// The IDs of type aliases for ext_vectors that exist in the chain.
821  ///
822  /// Used by Sema for finding sugared names for ext_vectors in diagnostics.
823  SmallVector<uint64_t, 4> ExtVectorDecls;
824 
825  //@}
826 
827  /// \name Sema-relevant special data
828  /// Fields containing data that is used for semantic analysis
829  //@{
830 
831  /// The IDs of all potentially unused typedef names in the chain.
832  ///
833  /// Sema tracks these to emit warnings.
834  SmallVector<uint64_t, 16> UnusedLocalTypedefNameCandidates;
835 
836  /// Our current depth in #pragma cuda force_host_device begin/end
837  /// macros.
838  unsigned ForceCUDAHostDeviceDepth = 0;
839 
840  /// The IDs of the declarations Sema stores directly.
841  ///
842  /// Sema tracks a few important decls, such as namespace std, directly.
843  SmallVector<uint64_t, 4> SemaDeclRefs;
844 
845  /// The IDs of the types ASTContext stores directly.
846  ///
847  /// The AST context tracks a few important types, such as va_list, directly.
848  SmallVector<uint64_t, 16> SpecialTypes;
849 
850  /// The IDs of CUDA-specific declarations ASTContext stores directly.
851  ///
852  /// The AST context tracks a few important decls, currently cudaConfigureCall,
853  /// directly.
854  SmallVector<uint64_t, 2> CUDASpecialDeclRefs;
855 
856  /// The floating point pragma option settings.
857  SmallVector<uint64_t, 1> FPPragmaOptions;
858 
859  /// The pragma clang optimize location (if the pragma state is "off").
860  SourceLocation OptimizeOffPragmaLocation;
861 
862  /// The PragmaMSStructKind pragma ms_struct state if set, or -1.
863  int PragmaMSStructState = -1;
864 
865  /// The PragmaMSPointersToMembersKind pragma pointers_to_members state.
866  int PragmaMSPointersToMembersState = -1;
867  SourceLocation PointersToMembersPragmaLocation;
868 
869  /// The pragma pack state.
870  Optional<unsigned> PragmaPackCurrentValue;
871  SourceLocation PragmaPackCurrentLocation;
872  struct PragmaPackStackEntry {
873  unsigned Value;
874  SourceLocation Location;
875  SourceLocation PushLocation;
876  StringRef SlotLabel;
877  };
879  llvm::SmallVector<std::string, 2> PragmaPackStrings;
880 
881  /// The OpenCL extension settings.
882  OpenCLOptions OpenCLExtensions;
883 
884  /// Extensions required by an OpenCL type.
885  llvm::DenseMap<const Type *, std::set<std::string>> OpenCLTypeExtMap;
886 
887  /// Extensions required by an OpenCL declaration.
888  llvm::DenseMap<const Decl *, std::set<std::string>> OpenCLDeclExtMap;
889 
890  /// A list of the namespaces we've seen.
891  SmallVector<uint64_t, 4> KnownNamespaces;
892 
893  /// A list of undefined decls with internal linkage followed by the
894  /// SourceLocation of a matching ODR-use.
895  SmallVector<uint64_t, 8> UndefinedButUsed;
896 
897  /// Delete expressions to analyze at the end of translation unit.
898  SmallVector<uint64_t, 8> DelayedDeleteExprs;
899 
900  // A list of late parsed template function data.
901  SmallVector<uint64_t, 1> LateParsedTemplates;
902 
903 public:
907 
909  : ID(ID), ImportLoc(ImportLoc) {}
910  };
911 
912 private:
913  /// A list of modules that were imported by precompiled headers or
914  /// any other non-module AST file.
915  SmallVector<ImportedSubmodule, 2> ImportedModules;
916  //@}
917 
918  /// The system include root to be used when loading the
919  /// precompiled header.
920  std::string isysroot;
921 
922  /// Whether to disable the normal validation performed on precompiled
923  /// headers when they are loaded.
924  bool DisableValidation;
925 
926  /// Whether to accept an AST file with compiler errors.
927  bool AllowASTWithCompilerErrors;
928 
929  /// Whether to accept an AST file that has a different configuration
930  /// from the current compiler instance.
931  bool AllowConfigurationMismatch;
932 
933  /// Whether validate system input files.
934  bool ValidateSystemInputs;
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  off_t StoredSize;
1210  time_t StoredTime;
1211  bool Overridden;
1212  bool Transient;
1213  bool TopLevelModuleMap;
1214  };
1215 
1216  /// Reads the stored information about an input file.
1217  InputFileInfo readInputFileInfo(ModuleFile &F, unsigned ID);
1218 
1219  /// Retrieve the file entry and 'overridden' bit for an input
1220  /// file in the given module file.
1221  serialization::InputFile getInputFile(ModuleFile &F, unsigned ID,
1222  bool Complain = true);
1223 
1224 public:
1225  void ResolveImportedPath(ModuleFile &M, std::string &Filename);
1226  static void ResolveImportedPath(std::string &Filename, StringRef Prefix);
1227 
1228  /// Returns the first key declaration for the given declaration. This
1229  /// is one that is formerly-canonical (or still canonical) and whose module
1230  /// did not import any other key declaration of the entity.
1231  Decl *getKeyDeclaration(Decl *D) {
1232  D = D->getCanonicalDecl();
1233  if (D->isFromASTFile())
1234  return D;
1235 
1236  auto I = KeyDecls.find(D);
1237  if (I == KeyDecls.end() || I->second.empty())
1238  return D;
1239  return GetExistingDecl(I->second[0]);
1240  }
1241  const Decl *getKeyDeclaration(const Decl *D) {
1242  return getKeyDeclaration(const_cast<Decl*>(D));
1243  }
1244 
1245  /// Run a callback on each imported key declaration of \p D.
1246  template <typename Fn>
1247  void forEachImportedKeyDecl(const Decl *D, Fn Visit) {
1248  D = D->getCanonicalDecl();
1249  if (D->isFromASTFile())
1250  Visit(D);
1251 
1252  auto It = KeyDecls.find(const_cast<Decl*>(D));
1253  if (It != KeyDecls.end())
1254  for (auto ID : It->second)
1255  Visit(GetExistingDecl(ID));
1256  }
1257 
1258  /// Get the loaded lookup tables for \p Primary, if any.
1260  getLoadedLookupTables(DeclContext *Primary) const;
1261 
1262 private:
1263  struct ImportedModule {
1264  ModuleFile *Mod;
1265  ModuleFile *ImportedBy;
1266  SourceLocation ImportLoc;
1267 
1268  ImportedModule(ModuleFile *Mod,
1269  ModuleFile *ImportedBy,
1270  SourceLocation ImportLoc)
1271  : Mod(Mod), ImportedBy(ImportedBy), ImportLoc(ImportLoc) {}
1272  };
1273 
1274  ASTReadResult ReadASTCore(StringRef FileName, ModuleKind Type,
1275  SourceLocation ImportLoc, ModuleFile *ImportedBy,
1277  off_t ExpectedSize, time_t ExpectedModTime,
1278  ASTFileSignature ExpectedSignature,
1279  unsigned ClientLoadCapabilities);
1280  ASTReadResult ReadControlBlock(ModuleFile &F,
1282  const ModuleFile *ImportedBy,
1283  unsigned ClientLoadCapabilities);
1284  static ASTReadResult ReadOptionsBlock(
1285  llvm::BitstreamCursor &Stream, unsigned ClientLoadCapabilities,
1286  bool AllowCompatibleConfigurationMismatch, ASTReaderListener &Listener,
1287  std::string &SuggestedPredefines);
1288 
1289  /// Read the unhashed control block.
1290  ///
1291  /// This has no effect on \c F.Stream, instead creating a fresh cursor from
1292  /// \c F.Data and reading ahead.
1293  ASTReadResult readUnhashedControlBlock(ModuleFile &F, bool WasImportedBy,
1294  unsigned ClientLoadCapabilities);
1295 
1296  static ASTReadResult
1297  readUnhashedControlBlockImpl(ModuleFile *F, llvm::StringRef StreamData,
1298  unsigned ClientLoadCapabilities,
1299  bool AllowCompatibleConfigurationMismatch,
1300  ASTReaderListener *Listener,
1301  bool ValidateDiagnosticOptions);
1302 
1303  ASTReadResult ReadASTBlock(ModuleFile &F, unsigned ClientLoadCapabilities);
1304  ASTReadResult ReadExtensionBlock(ModuleFile &F);
1305  void ReadModuleOffsetMap(ModuleFile &F) const;
1306  bool ParseLineTable(ModuleFile &F, const RecordData &Record);
1307  bool ReadSourceManagerBlock(ModuleFile &F);
1308  llvm::BitstreamCursor &SLocCursorForID(int ID);
1309  SourceLocation getImportLocation(ModuleFile *F);
1310  ASTReadResult ReadModuleMapFileBlock(RecordData &Record, ModuleFile &F,
1311  const ModuleFile *ImportedBy,
1312  unsigned ClientLoadCapabilities);
1313  ASTReadResult ReadSubmoduleBlock(ModuleFile &F,
1314  unsigned ClientLoadCapabilities);
1315  static bool ParseLanguageOptions(const RecordData &Record, bool Complain,
1316  ASTReaderListener &Listener,
1317  bool AllowCompatibleDifferences);
1318  static bool ParseTargetOptions(const RecordData &Record, bool Complain,
1319  ASTReaderListener &Listener,
1320  bool AllowCompatibleDifferences);
1321  static bool ParseDiagnosticOptions(const RecordData &Record, bool Complain,
1322  ASTReaderListener &Listener);
1323  static bool ParseFileSystemOptions(const RecordData &Record, bool Complain,
1324  ASTReaderListener &Listener);
1325  static bool ParseHeaderSearchOptions(const RecordData &Record, bool Complain,
1326  ASTReaderListener &Listener);
1327  static bool ParsePreprocessorOptions(const RecordData &Record, bool Complain,
1328  ASTReaderListener &Listener,
1329  std::string &SuggestedPredefines);
1330 
1331  struct RecordLocation {
1332  ModuleFile *F;
1333  uint64_t Offset;
1334 
1335  RecordLocation(ModuleFile *M, uint64_t O) : F(M), Offset(O) {}
1336  };
1337 
1338  QualType readTypeRecord(unsigned Index);
1339  void readExceptionSpec(ModuleFile &ModuleFile,
1340  SmallVectorImpl<QualType> &ExceptionStorage,
1342  const RecordData &Record, unsigned &Index);
1343  RecordLocation TypeCursorForIndex(unsigned Index);
1344  void LoadedDecl(unsigned Index, Decl *D);
1345  Decl *ReadDeclRecord(serialization::DeclID ID);
1346  void markIncompleteDeclChain(Decl *Canon);
1347 
1348  /// Returns the most recent declaration of a declaration (which must be
1349  /// of a redeclarable kind) that is either local or has already been loaded
1350  /// merged into its redecl chain.
1351  Decl *getMostRecentExistingDecl(Decl *D);
1352 
1353  RecordLocation DeclCursorForID(serialization::DeclID ID,
1354  SourceLocation &Location);
1355  void loadDeclUpdateRecords(PendingUpdateRecord &Record);
1356  void loadPendingDeclChain(Decl *D, uint64_t LocalOffset);
1357  void loadObjCCategories(serialization::GlobalDeclID ID, ObjCInterfaceDecl *D,
1358  unsigned PreviousGeneration = 0);
1359 
1360  RecordLocation getLocalBitOffset(uint64_t GlobalOffset);
1361  uint64_t getGlobalBitOffset(ModuleFile &M, uint32_t LocalOffset);
1362 
1363  /// Returns the first preprocessed entity ID that begins or ends after
1364  /// \arg Loc.
1366  findPreprocessedEntity(SourceLocation Loc, bool EndsAfter) const;
1367 
1368  /// Find the next module that contains entities and return the ID
1369  /// of the first entry.
1370  ///
1371  /// \param SLocMapI points at a chunk of a module that contains no
1372  /// preprocessed entities or the entities it contains are not the
1373  /// ones we are looking for.
1375  findNextPreprocessedEntity(
1376  GlobalSLocOffsetMapType::const_iterator SLocMapI) const;
1377 
1378  /// Returns (ModuleFile, Local index) pair for \p GlobalIndex of a
1379  /// preprocessed entity.
1380  std::pair<ModuleFile *, unsigned>
1381  getModulePreprocessedEntity(unsigned GlobalIndex);
1382 
1383  /// Returns (begin, end) pair for the preprocessed entities of a
1384  /// particular module.
1385  llvm::iterator_range<PreprocessingRecord::iterator>
1386  getModulePreprocessedEntities(ModuleFile &Mod) const;
1387 
1388 public:
1390  : public llvm::iterator_adaptor_base<
1391  ModuleDeclIterator, const serialization::LocalDeclID *,
1392  std::random_access_iterator_tag, const Decl *, ptrdiff_t,
1393  const Decl *, const Decl *> {
1394  ASTReader *Reader = nullptr;
1395  ModuleFile *Mod = nullptr;
1396 
1397  public:
1398  ModuleDeclIterator() : iterator_adaptor_base(nullptr) {}
1399 
1400  ModuleDeclIterator(ASTReader *Reader, ModuleFile *Mod,
1401  const serialization::LocalDeclID *Pos)
1402  : iterator_adaptor_base(Pos), Reader(Reader), Mod(Mod) {}
1403 
1404  value_type operator*() const {
1405  return Reader->GetDecl(Reader->getGlobalDeclID(*Mod, *I));
1406  }
1407 
1408  value_type operator->() const { return **this; }
1409 
1410  bool operator==(const ModuleDeclIterator &RHS) const {
1411  assert(Reader == RHS.Reader && Mod == RHS.Mod);
1412  return I == RHS.I;
1413  }
1414  };
1415 
1416  llvm::iterator_range<ModuleDeclIterator>
1417  getModuleFileLevelDecls(ModuleFile &Mod);
1418 
1419 private:
1420  void PassInterestingDeclsToConsumer();
1421  void PassInterestingDeclToConsumer(Decl *D);
1422 
1423  void finishPendingActions();
1424  void diagnoseOdrViolations();
1425 
1426  void pushExternalDeclIntoScope(NamedDecl *D, DeclarationName Name);
1427 
1428  void addPendingDeclContextInfo(Decl *D,
1430  serialization::GlobalDeclID LexicalDC) {
1431  assert(D);
1432  PendingDeclContextInfo Info = { D, SemaDC, LexicalDC };
1433  PendingDeclContextInfos.push_back(Info);
1434  }
1435 
1436  /// Produce an error diagnostic and return true.
1437  ///
1438  /// This routine should only be used for fatal errors that have to
1439  /// do with non-routine failures (e.g., corrupted AST file).
1440  void Error(StringRef Msg) const;
1441  void Error(unsigned DiagID, StringRef Arg1 = StringRef(),
1442  StringRef Arg2 = StringRef()) const;
1443 
1444 public:
1445  /// Load the AST file and validate its contents against the given
1446  /// Preprocessor.
1447  ///
1448  /// \param PP the preprocessor associated with the context in which this
1449  /// precompiled header will be loaded.
1450  ///
1451  /// \param Context the AST context that this precompiled header will be
1452  /// loaded into, if any.
1453  ///
1454  /// \param PCHContainerRdr the PCHContainerOperations to use for loading and
1455  /// creating modules.
1456  ///
1457  /// \param Extensions the list of module file extensions that can be loaded
1458  /// from the AST files.
1459  ///
1460  /// \param isysroot If non-NULL, the system include path specified by the
1461  /// user. This is only used with relocatable PCH files. If non-NULL,
1462  /// a relocatable PCH file will use the default path "/".
1463  ///
1464  /// \param DisableValidation If true, the AST reader will suppress most
1465  /// of its regular consistency checking, allowing the use of precompiled
1466  /// headers that cannot be determined to be compatible.
1467  ///
1468  /// \param AllowASTWithCompilerErrors If true, the AST reader will accept an
1469  /// AST file the was created out of an AST with compiler errors,
1470  /// otherwise it will reject it.
1471  ///
1472  /// \param AllowConfigurationMismatch If true, the AST reader will not check
1473  /// for configuration differences between the AST file and the invocation.
1474  ///
1475  /// \param ValidateSystemInputs If true, the AST reader will validate
1476  /// system input files in addition to user input files. This is only
1477  /// meaningful if \p DisableValidation is false.
1478  ///
1479  /// \param UseGlobalIndex If true, the AST reader will try to load and use
1480  /// the global module index.
1481  ///
1482  /// \param ReadTimer If non-null, a timer used to track the time spent
1483  /// deserializing.
1484  ASTReader(Preprocessor &PP, ASTContext *Context,
1485  const PCHContainerReader &PCHContainerRdr,
1486  ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
1487  StringRef isysroot = "", bool DisableValidation = false,
1488  bool AllowASTWithCompilerErrors = false,
1489  bool AllowConfigurationMismatch = false,
1490  bool ValidateSystemInputs = false, bool UseGlobalIndex = true,
1491  std::unique_ptr<llvm::Timer> ReadTimer = {});
1492  ASTReader(const ASTReader &) = delete;
1493  ASTReader &operator=(const ASTReader &) = delete;
1494  ~ASTReader() override;
1495 
1496  SourceManager &getSourceManager() const { return SourceMgr; }
1497  FileManager &getFileManager() const { return FileMgr; }
1498  DiagnosticsEngine &getDiags() const { return Diags; }
1499 
1500  /// Flags that indicate what kind of AST loading failures the client
1501  /// of the AST reader can directly handle.
1502  ///
1503  /// When a client states that it can handle a particular kind of failure,
1504  /// the AST reader will not emit errors when producing that kind of failure.
1506  /// The client can't handle any AST loading failures.
1507  ARR_None = 0,
1508 
1509  /// The client can handle an AST file that cannot load because it
1510  /// is missing.
1511  ARR_Missing = 0x1,
1512 
1513  /// The client can handle an AST file that cannot load because it
1514  /// is out-of-date relative to its input files.
1515  ARR_OutOfDate = 0x2,
1516 
1517  /// The client can handle an AST file that cannot load because it
1518  /// was built with a different version of Clang.
1519  ARR_VersionMismatch = 0x4,
1520 
1521  /// The client can handle an AST file that cannot load because it's
1522  /// compiled configuration doesn't match that of the context it was
1523  /// loaded into.
1524  ARR_ConfigurationMismatch = 0x8
1525  };
1526 
1527  /// Load the AST file designated by the given file name.
1528  ///
1529  /// \param FileName The name of the AST file to load.
1530  ///
1531  /// \param Type The kind of AST being loaded, e.g., PCH, module, main file,
1532  /// or preamble.
1533  ///
1534  /// \param ImportLoc the location where the module file will be considered as
1535  /// imported from. For non-module AST types it should be invalid.
1536  ///
1537  /// \param ClientLoadCapabilities The set of client load-failure
1538  /// capabilities, represented as a bitset of the enumerators of
1539  /// LoadFailureCapabilities.
1540  ///
1541  /// \param Imported optional out-parameter to append the list of modules
1542  /// that were imported by precompiled headers or any other non-module AST file
1543  ASTReadResult ReadAST(StringRef FileName, ModuleKind Type,
1544  SourceLocation ImportLoc,
1545  unsigned ClientLoadCapabilities,
1546  SmallVectorImpl<ImportedSubmodule> *Imported = nullptr);
1547 
1548  /// Make the entities in the given module and any of its (non-explicit)
1549  /// submodules visible to name lookup.
1550  ///
1551  /// \param Mod The module whose names should be made visible.
1552  ///
1553  /// \param NameVisibility The level of visibility to give the names in the
1554  /// module. Visibility can only be increased over time.
1555  ///
1556  /// \param ImportLoc The location at which the import occurs.
1557  void makeModuleVisible(Module *Mod,
1558  Module::NameVisibilityKind NameVisibility,
1559  SourceLocation ImportLoc);
1560 
1561  /// Make the names within this set of hidden names visible.
1562  void makeNamesVisible(const HiddenNames &Names, Module *Owner);
1563 
1564  /// Note that MergedDef is a redefinition of the canonical definition
1565  /// Def, so Def should be visible whenever MergedDef is.
1566  void mergeDefinitionVisibility(NamedDecl *Def, NamedDecl *MergedDef);
1567 
1568  /// Take the AST callbacks listener.
1569  std::unique_ptr<ASTReaderListener> takeListener() {
1570  return std::move(Listener);
1571  }
1572 
1573  /// Set the AST callbacks listener.
1574  void setListener(std::unique_ptr<ASTReaderListener> Listener) {
1575  this->Listener = std::move(Listener);
1576  }
1577 
1578  /// Add an AST callback listener.
1579  ///
1580  /// Takes ownership of \p L.
1581  void addListener(std::unique_ptr<ASTReaderListener> L) {
1582  if (Listener)
1583  L = llvm::make_unique<ChainedASTReaderListener>(std::move(L),
1584  std::move(Listener));
1585  Listener = std::move(L);
1586  }
1587 
1588  /// RAII object to temporarily add an AST callback listener.
1590  ASTReader &Reader;
1591  bool Chained = false;
1592 
1593  public:
1594  ListenerScope(ASTReader &Reader, std::unique_ptr<ASTReaderListener> L)
1595  : Reader(Reader) {
1596  auto Old = Reader.takeListener();
1597  if (Old) {
1598  Chained = true;
1599  L = llvm::make_unique<ChainedASTReaderListener>(std::move(L),
1600  std::move(Old));
1601  }
1602  Reader.setListener(std::move(L));
1603  }
1604 
1606  auto New = Reader.takeListener();
1607  if (Chained)
1608  Reader.setListener(static_cast<ChainedASTReaderListener *>(New.get())
1609  ->takeSecond());
1610  }
1611  };
1612 
1613  /// Set the AST deserialization listener.
1614  void setDeserializationListener(ASTDeserializationListener *Listener,
1615  bool TakeOwnership = false);
1616 
1617  /// Get the AST deserialization listener.
1619  return DeserializationListener;
1620  }
1621 
1622  /// Determine whether this AST reader has a global index.
1623  bool hasGlobalIndex() const { return (bool)GlobalIndex; }
1624 
1625  /// Return global module index.
1626  GlobalModuleIndex *getGlobalIndex() { return GlobalIndex.get(); }
1627 
1628  /// Reset reader for a reload try.
1629  void resetForReload() { TriedLoadingGlobalIndex = false; }
1630 
1631  /// Attempts to load the global index.
1632  ///
1633  /// \returns true if loading the global index has failed for any reason.
1634  bool loadGlobalIndex();
1635 
1636  /// Determine whether we tried to load the global index, but failed,
1637  /// e.g., because it is out-of-date or does not exist.
1638  bool isGlobalIndexUnavailable() const;
1639 
1640  /// Initializes the ASTContext
1641  void InitializeContext();
1642 
1643  /// Update the state of Sema after loading some additional modules.
1644  void UpdateSema();
1645 
1646  /// Add in-memory (virtual file) buffer.
1647  void addInMemoryBuffer(StringRef &FileName,
1648  std::unique_ptr<llvm::MemoryBuffer> Buffer) {
1649  ModuleMgr.addInMemoryBuffer(FileName, std::move(Buffer));
1650  }
1651 
1652  /// Finalizes the AST reader's state before writing an AST file to
1653  /// disk.
1654  ///
1655  /// This operation may undo temporary state in the AST that should not be
1656  /// emitted.
1657  void finalizeForWriting();
1658 
1659  /// Retrieve the module manager.
1660  ModuleManager &getModuleManager() { return ModuleMgr; }
1661 
1662  /// Retrieve the preprocessor.
1663  Preprocessor &getPreprocessor() const { return PP; }
1664 
1665  /// Retrieve the name of the original source file name for the primary
1666  /// module file.
1668  return ModuleMgr.getPrimaryModule().OriginalSourceFileName;
1669  }
1670 
1671  /// Retrieve the name of the original source file name directly from
1672  /// the AST file, without actually loading the AST file.
1673  static std::string
1674  getOriginalSourceFile(const std::string &ASTFileName, FileManager &FileMgr,
1675  const PCHContainerReader &PCHContainerRdr,
1676  DiagnosticsEngine &Diags);
1677 
1678  /// Read the control block for the named AST file.
1679  ///
1680  /// \returns true if an error occurred, false otherwise.
1681  static bool
1682  readASTFileControlBlock(StringRef Filename, FileManager &FileMgr,
1683  const PCHContainerReader &PCHContainerRdr,
1684  bool FindModuleFileExtensions,
1685  ASTReaderListener &Listener,
1686  bool ValidateDiagnosticOptions);
1687 
1688  /// Determine whether the given AST file is acceptable to load into a
1689  /// translation unit with the given language and target options.
1690  static bool isAcceptableASTFile(StringRef Filename, FileManager &FileMgr,
1691  const PCHContainerReader &PCHContainerRdr,
1692  const LangOptions &LangOpts,
1693  const TargetOptions &TargetOpts,
1694  const PreprocessorOptions &PPOpts,
1695  StringRef ExistingModuleCachePath);
1696 
1697  /// Returns the suggested contents of the predefines buffer,
1698  /// which contains a (typically-empty) subset of the predefines
1699  /// build prior to including the precompiled header.
1700  const std::string &getSuggestedPredefines() { return SuggestedPredefines; }
1701 
1702  /// Read a preallocated preprocessed entity from the external source.
1703  ///
1704  /// \returns null if an error occurred that prevented the preprocessed
1705  /// entity from being loaded.
1706  PreprocessedEntity *ReadPreprocessedEntity(unsigned Index) override;
1707 
1708  /// Returns a pair of [Begin, End) indices of preallocated
1709  /// preprocessed entities that \p Range encompasses.
1710  std::pair<unsigned, unsigned>
1711  findPreprocessedEntitiesInRange(SourceRange Range) override;
1712 
1713  /// Optionally returns true or false if the preallocated preprocessed
1714  /// entity with index \p Index came from file \p FID.
1715  Optional<bool> isPreprocessedEntityInFileID(unsigned Index,
1716  FileID FID) override;
1717 
1718  /// Read a preallocated skipped range from the external source.
1719  SourceRange ReadSkippedRange(unsigned Index) override;
1720 
1721  /// Read the header file information for the given file entry.
1722  HeaderFileInfo GetHeaderFileInfo(const FileEntry *FE) override;
1723 
1724  void ReadPragmaDiagnosticMappings(DiagnosticsEngine &Diag);
1725 
1726  /// Returns the number of source locations found in the chain.
1727  unsigned getTotalNumSLocs() const {
1728  return TotalNumSLocEntries;
1729  }
1730 
1731  /// Returns the number of identifiers found in the chain.
1732  unsigned getTotalNumIdentifiers() const {
1733  return static_cast<unsigned>(IdentifiersLoaded.size());
1734  }
1735 
1736  /// Returns the number of macros found in the chain.
1737  unsigned getTotalNumMacros() const {
1738  return static_cast<unsigned>(MacrosLoaded.size());
1739  }
1740 
1741  /// Returns the number of types found in the chain.
1742  unsigned getTotalNumTypes() const {
1743  return static_cast<unsigned>(TypesLoaded.size());
1744  }
1745 
1746  /// Returns the number of declarations found in the chain.
1747  unsigned getTotalNumDecls() const {
1748  return static_cast<unsigned>(DeclsLoaded.size());
1749  }
1750 
1751  /// Returns the number of submodules known.
1752  unsigned getTotalNumSubmodules() const {
1753  return static_cast<unsigned>(SubmodulesLoaded.size());
1754  }
1755 
1756  /// Returns the number of selectors found in the chain.
1757  unsigned getTotalNumSelectors() const {
1758  return static_cast<unsigned>(SelectorsLoaded.size());
1759  }
1760 
1761  /// Returns the number of preprocessed entities known to the AST
1762  /// reader.
1764  unsigned Result = 0;
1765  for (const auto &M : ModuleMgr)
1766  Result += M.NumPreprocessedEntities;
1767  return Result;
1768  }
1769 
1770  /// Reads a TemplateArgumentLocInfo appropriate for the
1771  /// given TemplateArgument kind.
1773  GetTemplateArgumentLocInfo(ModuleFile &F, TemplateArgument::ArgKind Kind,
1774  const RecordData &Record, unsigned &Idx);
1775 
1776  /// Reads a TemplateArgumentLoc.
1778  ReadTemplateArgumentLoc(ModuleFile &F,
1779  const RecordData &Record, unsigned &Idx);
1780 
1782  ReadASTTemplateArgumentListInfo(ModuleFile &F,
1783  const RecordData &Record, unsigned &Index);
1784 
1785  /// Reads a declarator info from the given record.
1786  TypeSourceInfo *GetTypeSourceInfo(ModuleFile &F,
1787  const RecordData &Record, unsigned &Idx);
1788 
1789  /// Raad the type locations for the given TInfo.
1790  void ReadTypeLoc(ModuleFile &F, const RecordData &Record, unsigned &Idx,
1791  TypeLoc TL);
1792 
1793  /// Resolve a type ID into a type, potentially building a new
1794  /// type.
1795  QualType GetType(serialization::TypeID ID);
1796 
1797  /// Resolve a local type ID within a given AST file into a type.
1798  QualType getLocalType(ModuleFile &F, unsigned LocalID);
1799 
1800  /// Map a local type ID within a given AST file into a global type ID.
1801  serialization::TypeID getGlobalTypeID(ModuleFile &F, unsigned LocalID) const;
1802 
1803  /// Read a type from the current position in the given record, which
1804  /// was read from the given AST file.
1805  QualType readType(ModuleFile &F, const RecordData &Record, unsigned &Idx) {
1806  if (Idx >= Record.size())
1807  return {};
1808 
1809  return getLocalType(F, Record[Idx++]);
1810  }
1811 
1812  /// Map from a local declaration ID within a given module to a
1813  /// global declaration ID.
1814  serialization::DeclID getGlobalDeclID(ModuleFile &F,
1815  serialization::LocalDeclID LocalID) const;
1816 
1817  /// Returns true if global DeclID \p ID originated from module \p M.
1818  bool isDeclIDFromModule(serialization::GlobalDeclID ID, ModuleFile &M) const;
1819 
1820  /// Retrieve the module file that owns the given declaration, or NULL
1821  /// if the declaration is not from a module file.
1822  ModuleFile *getOwningModuleFile(const Decl *D);
1823 
1824  /// Get the best name we know for the module that owns the given
1825  /// declaration, or an empty string if the declaration is not from a module.
1826  std::string getOwningModuleNameForDiagnostic(const Decl *D);
1827 
1828  /// Returns the source location for the decl \p ID.
1829  SourceLocation getSourceLocationForDeclID(serialization::GlobalDeclID ID);
1830 
1831  /// Resolve a declaration ID into a declaration, potentially
1832  /// building a new declaration.
1833  Decl *GetDecl(serialization::DeclID ID);
1834  Decl *GetExternalDecl(uint32_t ID) override;
1835 
1836  /// Resolve a declaration ID into a declaration. Return 0 if it's not
1837  /// been loaded yet.
1838  Decl *GetExistingDecl(serialization::DeclID ID);
1839 
1840  /// Reads a declaration with the given local ID in the given module.
1841  Decl *GetLocalDecl(ModuleFile &F, uint32_t LocalID) {
1842  return GetDecl(getGlobalDeclID(F, LocalID));
1843  }
1844 
1845  /// Reads a declaration with the given local ID in the given module.
1846  ///
1847  /// \returns The requested declaration, casted to the given return type.
1848  template<typename T>
1849  T *GetLocalDeclAs(ModuleFile &F, uint32_t LocalID) {
1850  return cast_or_null<T>(GetLocalDecl(F, LocalID));
1851  }
1852 
1853  /// Map a global declaration ID into the declaration ID used to
1854  /// refer to this declaration within the given module fule.
1855  ///
1856  /// \returns the global ID of the given declaration as known in the given
1857  /// module file.
1859  mapGlobalIDToModuleFileGlobalID(ModuleFile &M,
1860  serialization::DeclID GlobalID);
1861 
1862  /// Reads a declaration ID from the given position in a record in the
1863  /// given module.
1864  ///
1865  /// \returns The declaration ID read from the record, adjusted to a global ID.
1866  serialization::DeclID ReadDeclID(ModuleFile &F, const RecordData &Record,
1867  unsigned &Idx);
1868 
1869  /// Reads a declaration from the given position in a record in the
1870  /// given module.
1871  Decl *ReadDecl(ModuleFile &F, const RecordData &R, unsigned &I) {
1872  return GetDecl(ReadDeclID(F, R, I));
1873  }
1874 
1875  /// Reads a declaration from the given position in a record in the
1876  /// given module.
1877  ///
1878  /// \returns The declaration read from this location, casted to the given
1879  /// result type.
1880  template<typename T>
1881  T *ReadDeclAs(ModuleFile &F, const RecordData &R, unsigned &I) {
1882  return cast_or_null<T>(GetDecl(ReadDeclID(F, R, I)));
1883  }
1884 
1885  /// If any redeclarations of \p D have been imported since it was
1886  /// last checked, this digs out those redeclarations and adds them to the
1887  /// redeclaration chain for \p D.
1888  void CompleteRedeclChain(const Decl *D) override;
1889 
1890  CXXBaseSpecifier *GetExternalCXXBaseSpecifiers(uint64_t Offset) override;
1891 
1892  /// Resolve the offset of a statement into a statement.
1893  ///
1894  /// This operation will read a new statement from the external
1895  /// source each time it is called, and is meant to be used via a
1896  /// LazyOffsetPtr (which is used by Decls for the body of functions, etc).
1897  Stmt *GetExternalDeclStmt(uint64_t Offset) override;
1898 
1899  /// ReadBlockAbbrevs - Enter a subblock of the specified BlockID with the
1900  /// specified cursor. Read the abbreviations that are at the top of the block
1901  /// and then leave the cursor pointing into the block.
1902  static bool ReadBlockAbbrevs(llvm::BitstreamCursor &Cursor, unsigned BlockID);
1903 
1904  /// Finds all the visible declarations with a given name.
1905  /// The current implementation of this method just loads the entire
1906  /// lookup table as unmaterialized references.
1907  bool FindExternalVisibleDeclsByName(const DeclContext *DC,
1908  DeclarationName Name) override;
1909 
1910  /// Read all of the declarations lexically stored in a
1911  /// declaration context.
1912  ///
1913  /// \param DC The declaration context whose declarations will be
1914  /// read.
1915  ///
1916  /// \param IsKindWeWant A predicate indicating which declaration kinds
1917  /// we are interested in.
1918  ///
1919  /// \param Decls Vector that will contain the declarations loaded
1920  /// from the external source. The caller is responsible for merging
1921  /// these declarations with any declarations already stored in the
1922  /// declaration context.
1923  void
1924  FindExternalLexicalDecls(const DeclContext *DC,
1925  llvm::function_ref<bool(Decl::Kind)> IsKindWeWant,
1926  SmallVectorImpl<Decl *> &Decls) override;
1927 
1928  /// Get the decls that are contained in a file in the Offset/Length
1929  /// range. \p Length can be 0 to indicate a point at \p Offset instead of
1930  /// a range.
1931  void FindFileRegionDecls(FileID File, unsigned Offset, unsigned Length,
1932  SmallVectorImpl<Decl *> &Decls) override;
1933 
1934  /// Notify ASTReader that we started deserialization of
1935  /// a decl or type so until FinishedDeserializing is called there may be
1936  /// decls that are initializing. Must be paired with FinishedDeserializing.
1937  void StartedDeserializing() override;
1938 
1939  /// Notify ASTReader that we finished the deserialization of
1940  /// a decl or type. Must be paired with StartedDeserializing.
1941  void FinishedDeserializing() override;
1942 
1943  /// Function that will be invoked when we begin parsing a new
1944  /// translation unit involving this external AST source.
1945  ///
1946  /// This function will provide all of the external definitions to
1947  /// the ASTConsumer.
1948  void StartTranslationUnit(ASTConsumer *Consumer) override;
1949 
1950  /// Print some statistics about AST usage.
1951  void PrintStats() override;
1952 
1953  /// Dump information about the AST reader to standard error.
1954  void dump();
1955 
1956  /// Return the amount of memory used by memory buffers, breaking down
1957  /// by heap-backed versus mmap'ed memory.
1958  void getMemoryBufferSizes(MemoryBufferSizes &sizes) const override;
1959 
1960  /// Initialize the semantic source with the Sema instance
1961  /// being used to perform semantic analysis on the abstract syntax
1962  /// tree.
1963  void InitializeSema(Sema &S) override;
1964 
1965  /// Inform the semantic consumer that Sema is no longer available.
1966  void ForgetSema() override { SemaObj = nullptr; }
1967 
1968  /// Retrieve the IdentifierInfo for the named identifier.
1969  ///
1970  /// This routine builds a new IdentifierInfo for the given identifier. If any
1971  /// declarations with this name are visible from translation unit scope, their
1972  /// declarations will be deserialized and introduced into the declaration
1973  /// chain of the identifier.
1974  IdentifierInfo *get(StringRef Name) override;
1975 
1976  /// Retrieve an iterator into the set of all identifiers
1977  /// in all loaded AST files.
1978  IdentifierIterator *getIdentifiers() override;
1979 
1980  /// Load the contents of the global method pool for a given
1981  /// selector.
1982  void ReadMethodPool(Selector Sel) override;
1983 
1984  /// Load the contents of the global method pool for a given
1985  /// selector if necessary.
1986  void updateOutOfDateSelector(Selector Sel) override;
1987 
1988  /// Load the set of namespaces that are known to the external source,
1989  /// which will be used during typo correction.
1990  void ReadKnownNamespaces(
1991  SmallVectorImpl<NamespaceDecl *> &Namespaces) override;
1992 
1993  void ReadUndefinedButUsed(
1994  llvm::MapVector<NamedDecl *, SourceLocation> &Undefined) override;
1995 
1996  void ReadMismatchingDeleteExpressions(llvm::MapVector<
1997  FieldDecl *, llvm::SmallVector<std::pair<SourceLocation, bool>, 4>> &
1998  Exprs) override;
1999 
2000  void ReadTentativeDefinitions(
2001  SmallVectorImpl<VarDecl *> &TentativeDefs) override;
2002 
2003  void ReadUnusedFileScopedDecls(
2004  SmallVectorImpl<const DeclaratorDecl *> &Decls) override;
2005 
2006  void ReadDelegatingConstructors(
2007  SmallVectorImpl<CXXConstructorDecl *> &Decls) override;
2008 
2009  void ReadExtVectorDecls(SmallVectorImpl<TypedefNameDecl *> &Decls) override;
2010 
2011  void ReadUnusedLocalTypedefNameCandidates(
2013 
2014  void ReadReferencedSelectors(
2015  SmallVectorImpl<std::pair<Selector, SourceLocation>> &Sels) override;
2016 
2017  void ReadWeakUndeclaredIdentifiers(
2018  SmallVectorImpl<std::pair<IdentifierInfo *, WeakInfo>> &WI) override;
2019 
2020  void ReadUsedVTables(SmallVectorImpl<ExternalVTableUse> &VTables) override;
2021 
2022  void ReadPendingInstantiations(
2023  SmallVectorImpl<std::pair<ValueDecl *,
2024  SourceLocation>> &Pending) override;
2025 
2026  void ReadLateParsedTemplates(
2027  llvm::MapVector<const FunctionDecl *, std::unique_ptr<LateParsedTemplate>>
2028  &LPTMap) override;
2029 
2030  /// Load a selector from disk, registering its ID if it exists.
2031  void LoadSelector(Selector Sel);
2032 
2033  void SetIdentifierInfo(unsigned ID, IdentifierInfo *II);
2034  void SetGloballyVisibleDecls(IdentifierInfo *II,
2035  const SmallVectorImpl<uint32_t> &DeclIDs,
2036  SmallVectorImpl<Decl *> *Decls = nullptr);
2037 
2038  /// Report a diagnostic.
2039  DiagnosticBuilder Diag(unsigned DiagID) const;
2040 
2041  /// Report a diagnostic.
2042  DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) const;
2043 
2044  IdentifierInfo *DecodeIdentifierInfo(serialization::IdentifierID ID);
2045 
2046  IdentifierInfo *GetIdentifierInfo(ModuleFile &M, const RecordData &Record,
2047  unsigned &Idx) {
2048  return DecodeIdentifierInfo(getGlobalIdentifierID(M, Record[Idx++]));
2049  }
2050 
2052  // Note that we are loading an identifier.
2053  Deserializing AnIdentifier(this);
2054 
2055  return DecodeIdentifierInfo(ID);
2056  }
2057 
2058  IdentifierInfo *getLocalIdentifier(ModuleFile &M, unsigned LocalID);
2059 
2060  serialization::IdentifierID getGlobalIdentifierID(ModuleFile &M,
2061  unsigned LocalID);
2062 
2063  void resolvePendingMacro(IdentifierInfo *II, const PendingMacroInfo &PMInfo);
2064 
2065  /// Retrieve the macro with the given ID.
2066  MacroInfo *getMacro(serialization::MacroID ID);
2067 
2068  /// Retrieve the global macro ID corresponding to the given local
2069  /// ID within the given module file.
2070  serialization::MacroID getGlobalMacroID(ModuleFile &M, unsigned LocalID);
2071 
2072  /// Read the source location entry with index ID.
2073  bool ReadSLocEntry(int ID) override;
2074 
2075  /// Retrieve the module import location and module name for the
2076  /// given source manager entry ID.
2077  std::pair<SourceLocation, StringRef> getModuleImportLoc(int ID) override;
2078 
2079  /// Retrieve the global submodule ID given a module and its local ID
2080  /// number.
2082  getGlobalSubmoduleID(ModuleFile &M, unsigned LocalID);
2083 
2084  /// Retrieve the submodule that corresponds to a global submodule ID.
2085  ///
2086  Module *getSubmodule(serialization::SubmoduleID GlobalID);
2087 
2088  /// Retrieve the module that corresponds to the given module ID.
2089  ///
2090  /// Note: overrides method in ExternalASTSource
2091  Module *getModule(unsigned ID) override;
2092 
2093  bool DeclIsFromPCHWithObjectFile(const Decl *D) override;
2094 
2095  /// Retrieve the module file with a given local ID within the specified
2096  /// ModuleFile.
2097  ModuleFile *getLocalModuleFile(ModuleFile &M, unsigned ID);
2098 
2099  /// Get an ID for the given module file.
2100  unsigned getModuleFileID(ModuleFile *M);
2101 
2102  /// Return a descriptor for the corresponding module.
2103  llvm::Optional<ASTSourceDescriptor> getSourceDescriptor(unsigned ID) override;
2104 
2105  ExtKind hasExternalDefinitions(const Decl *D) override;
2106 
2107  /// Retrieve a selector from the given module with its local ID
2108  /// number.
2109  Selector getLocalSelector(ModuleFile &M, unsigned LocalID);
2110 
2111  Selector DecodeSelector(serialization::SelectorID Idx);
2112 
2113  Selector GetExternalSelector(serialization::SelectorID ID) override;
2114  uint32_t GetNumExternalSelectors() override;
2115 
2116  Selector ReadSelector(ModuleFile &M, const RecordData &Record, unsigned &Idx) {
2117  return getLocalSelector(M, Record[Idx++]);
2118  }
2119 
2120  /// Retrieve the global selector ID that corresponds to this
2121  /// the local selector ID in a given module.
2122  serialization::SelectorID getGlobalSelectorID(ModuleFile &F,
2123  unsigned LocalID) const;
2124 
2125  /// Read a declaration name.
2126  DeclarationName ReadDeclarationName(ModuleFile &F,
2127  const RecordData &Record, unsigned &Idx);
2128  void ReadDeclarationNameLoc(ModuleFile &F,
2129  DeclarationNameLoc &DNLoc, DeclarationName Name,
2130  const RecordData &Record, unsigned &Idx);
2131  void ReadDeclarationNameInfo(ModuleFile &F, DeclarationNameInfo &NameInfo,
2132  const RecordData &Record, unsigned &Idx);
2133 
2134  void ReadQualifierInfo(ModuleFile &F, QualifierInfo &Info,
2135  const RecordData &Record, unsigned &Idx);
2136 
2137  NestedNameSpecifier *ReadNestedNameSpecifier(ModuleFile &F,
2138  const RecordData &Record,
2139  unsigned &Idx);
2140 
2141  NestedNameSpecifierLoc ReadNestedNameSpecifierLoc(ModuleFile &F,
2142  const RecordData &Record,
2143  unsigned &Idx);
2144 
2145  /// Read a template name.
2146  TemplateName ReadTemplateName(ModuleFile &F, const RecordData &Record,
2147  unsigned &Idx);
2148 
2149  /// Read a template argument.
2150  TemplateArgument ReadTemplateArgument(ModuleFile &F, const RecordData &Record,
2151  unsigned &Idx,
2152  bool Canonicalize = false);
2153 
2154  /// Read a template parameter list.
2155  TemplateParameterList *ReadTemplateParameterList(ModuleFile &F,
2156  const RecordData &Record,
2157  unsigned &Idx);
2158 
2159  /// Read a template argument array.
2160  void ReadTemplateArgumentList(SmallVectorImpl<TemplateArgument> &TemplArgs,
2161  ModuleFile &F, const RecordData &Record,
2162  unsigned &Idx, bool Canonicalize = false);
2163 
2164  /// Read a UnresolvedSet structure.
2165  void ReadUnresolvedSet(ModuleFile &F, LazyASTUnresolvedSet &Set,
2166  const RecordData &Record, unsigned &Idx);
2167 
2168  /// Read a C++ base specifier.
2169  CXXBaseSpecifier ReadCXXBaseSpecifier(ModuleFile &F,
2170  const RecordData &Record,unsigned &Idx);
2171 
2172  /// Read a CXXCtorInitializer array.
2174  ReadCXXCtorInitializers(ModuleFile &F, const RecordData &Record,
2175  unsigned &Idx);
2176 
2177  /// Read the contents of a CXXCtorInitializer array.
2178  CXXCtorInitializer **GetExternalCXXCtorInitializers(uint64_t Offset) override;
2179 
2180  /// Read a source location from raw form and return it in its
2181  /// originating module file's source location space.
2183  return SourceLocation::getFromRawEncoding((Raw >> 1) | (Raw << 31));
2184  }
2185 
2186  /// Read a source location from raw form.
2187  SourceLocation ReadSourceLocation(ModuleFile &ModuleFile, uint32_t Raw) const {
2188  SourceLocation Loc = ReadUntranslatedSourceLocation(Raw);
2189  return TranslateSourceLocation(ModuleFile, Loc);
2190  }
2191 
2192  /// Translate a source location from another module file's source
2193  /// location space into ours.
2194  SourceLocation TranslateSourceLocation(ModuleFile &ModuleFile,
2195  SourceLocation Loc) const {
2196  if (!ModuleFile.ModuleOffsetMap.empty())
2197  ReadModuleOffsetMap(ModuleFile);
2198  assert(ModuleFile.SLocRemap.find(Loc.getOffset()) !=
2199  ModuleFile.SLocRemap.end() &&
2200  "Cannot find offset to remap.");
2201  int Remap = ModuleFile.SLocRemap.find(Loc.getOffset())->second;
2202  return Loc.getLocWithOffset(Remap);
2203  }
2204 
2205  /// Read a source location.
2206  SourceLocation ReadSourceLocation(ModuleFile &ModuleFile,
2207  const RecordDataImpl &Record,
2208  unsigned &Idx) {
2209  return ReadSourceLocation(ModuleFile, Record[Idx++]);
2210  }
2211 
2212  /// Read a source range.
2213  SourceRange ReadSourceRange(ModuleFile &F,
2214  const RecordData &Record, unsigned &Idx);
2215 
2216  /// Read an integral value
2217  llvm::APInt ReadAPInt(const RecordData &Record, unsigned &Idx);
2218 
2219  /// Read a signed integral value
2220  llvm::APSInt ReadAPSInt(const RecordData &Record, unsigned &Idx);
2221 
2222  /// Read a floating-point value
2223  llvm::APFloat ReadAPFloat(const RecordData &Record,
2224  const llvm::fltSemantics &Sem, unsigned &Idx);
2225 
2226  // Read a string
2227  static std::string ReadString(const RecordData &Record, unsigned &Idx);
2228 
2229  // Skip a string
2230  static void SkipString(const RecordData &Record, unsigned &Idx) {
2231  Idx += Record[Idx] + 1;
2232  }
2233 
2234  // Read a path
2235  std::string ReadPath(ModuleFile &F, const RecordData &Record, unsigned &Idx);
2236 
2237  // Skip a path
2238  static void SkipPath(const RecordData &Record, unsigned &Idx) {
2239  SkipString(Record, Idx);
2240  }
2241 
2242  /// Read a version tuple.
2243  static VersionTuple ReadVersionTuple(const RecordData &Record, unsigned &Idx);
2244 
2245  CXXTemporary *ReadCXXTemporary(ModuleFile &F, const RecordData &Record,
2246  unsigned &Idx);
2247 
2248  /// Reads attributes from the current stream position.
2249  void ReadAttributes(ASTRecordReader &Record, AttrVec &Attrs);
2250 
2251  /// Reads a statement.
2252  Stmt *ReadStmt(ModuleFile &F);
2253 
2254  /// Reads an expression.
2255  Expr *ReadExpr(ModuleFile &F);
2256 
2257  /// Reads a sub-statement operand during statement reading.
2259  assert(ReadingKind == Read_Stmt &&
2260  "Should be called only during statement reading!");
2261  // Subexpressions are stored from last to first, so the next Stmt we need
2262  // is at the back of the stack.
2263  assert(!StmtStack.empty() && "Read too many sub-statements!");
2264  return StmtStack.pop_back_val();
2265  }
2266 
2267  /// Reads a sub-expression operand during statement reading.
2268  Expr *ReadSubExpr();
2269 
2270  /// Reads a token out of a record.
2271  Token ReadToken(ModuleFile &M, const RecordDataImpl &Record, unsigned &Idx);
2272 
2273  /// Reads the macro record located at the given offset.
2274  MacroInfo *ReadMacroRecord(ModuleFile &F, uint64_t Offset);
2275 
2276  /// Determine the global preprocessed entity ID that corresponds to
2277  /// the given local ID within the given module.
2279  getGlobalPreprocessedEntityID(ModuleFile &M, unsigned LocalID) const;
2280 
2281  /// Add a macro to deserialize its macro directive history.
2282  ///
2283  /// \param II The name of the macro.
2284  /// \param M The module file.
2285  /// \param MacroDirectivesOffset Offset of the serialized macro directive
2286  /// history.
2287  void addPendingMacro(IdentifierInfo *II, ModuleFile *M,
2288  uint64_t MacroDirectivesOffset);
2289 
2290  /// Read the set of macros defined by this external macro source.
2291  void ReadDefinedMacros() override;
2292 
2293  /// Update an out-of-date identifier.
2294  void updateOutOfDateIdentifier(IdentifierInfo &II) override;
2295 
2296  /// Note that this identifier is up-to-date.
2297  void markIdentifierUpToDate(IdentifierInfo *II);
2298 
2299  /// Load all external visible decls in the given DeclContext.
2300  void completeVisibleDeclsMap(const DeclContext *DC) override;
2301 
2302  /// Retrieve the AST context that this AST reader supplements.
2304  assert(ContextObj && "requested AST context when not loading AST");
2305  return *ContextObj;
2306  }
2307 
2308  // Contains the IDs for declarations that were requested before we have
2309  // access to a Sema object.
2311 
2312  /// Retrieve the semantic analysis object used to analyze the
2313  /// translation unit in which the precompiled header is being
2314  /// imported.
2315  Sema *getSema() { return SemaObj; }
2316 
2317  /// Get the identifier resolver used for name lookup / updates
2318  /// in the translation unit scope. We have one of these even if we don't
2319  /// have a Sema object.
2320  IdentifierResolver &getIdResolver();
2321 
2322  /// Retrieve the identifier table associated with the
2323  /// preprocessor.
2324  IdentifierTable &getIdentifierTable();
2325 
2326  /// Record that the given ID maps to the given switch-case
2327  /// statement.
2328  void RecordSwitchCaseID(SwitchCase *SC, unsigned ID);
2329 
2330  /// Retrieve the switch-case statement with the given ID.
2331  SwitchCase *getSwitchCaseWithID(unsigned ID);
2332 
2333  void ClearSwitchCaseIDs();
2334 
2335  /// Cursors for comments blocks.
2336  SmallVector<std::pair<llvm::BitstreamCursor,
2338 
2339  /// Loads comments ranges.
2340  void ReadComments() override;
2341 
2342  /// Visit all the input files of the given module file.
2343  void visitInputFiles(serialization::ModuleFile &MF,
2344  bool IncludeSystem, bool Complain,
2345  llvm::function_ref<void(const serialization::InputFile &IF,
2346  bool isSystem)> Visitor);
2347 
2348  /// Visit all the top-level module maps loaded when building the given module
2349  /// file.
2350  void visitTopLevelModuleMaps(serialization::ModuleFile &MF,
2351  llvm::function_ref<
2352  void(const FileEntry *)> Visitor);
2353 
2354  bool isProcessingUpdateRecords() { return ProcessingUpdateRecords; }
2355 };
2356 
2357 /// An object for streaming information from a record.
2359  using ModuleFile = serialization::ModuleFile;
2360 
2361  ASTReader *Reader;
2362  ModuleFile *F;
2363  unsigned Idx = 0;
2364  ASTReader::RecordData Record;
2365 
2368 
2369 public:
2370  /// Construct an ASTRecordReader that uses the default encoding scheme.
2371  ASTRecordReader(ASTReader &Reader, ModuleFile &F) : Reader(&Reader), F(&F) {}
2372 
2373  /// Reads a record with id AbbrevID from Cursor, resetting the
2374  /// internal state.
2375  unsigned readRecord(llvm::BitstreamCursor &Cursor, unsigned AbbrevID);
2376 
2377  /// Is this a module file for a module (rather than a PCH or similar).
2378  bool isModule() const { return F->isModule(); }
2379 
2380  /// Retrieve the AST context that this AST reader supplements.
2381  ASTContext &getContext() { return Reader->getContext(); }
2382 
2383  /// The current position in this record.
2384  unsigned getIdx() const { return Idx; }
2385 
2386  /// The length of this record.
2387  size_t size() const { return Record.size(); }
2388 
2389  /// An arbitrary index in this record.
2390  const uint64_t &operator[](size_t N) { return Record[N]; }
2391 
2392  /// The last element in this record.
2393  const uint64_t &back() const { return Record.back(); }
2394 
2395  /// Returns the current value in this record, and advances to the
2396  /// next value.
2397  const uint64_t &readInt() { return Record[Idx++]; }
2398 
2399  /// Returns the current value in this record, without advancing.
2400  const uint64_t &peekInt() { return Record[Idx]; }
2401 
2402  /// Skips the specified number of values.
2403  void skipInts(unsigned N) { Idx += N; }
2404 
2405  /// Retrieve the global submodule ID its local ID number.
2407  getGlobalSubmoduleID(unsigned LocalID) {
2408  return Reader->getGlobalSubmoduleID(*F, LocalID);
2409  }
2410 
2411  /// Retrieve the submodule that corresponds to a global submodule ID.
2413  return Reader->getSubmodule(GlobalID);
2414  }
2415 
2416  /// Read the record that describes the lexical contents of a DC.
2417  bool readLexicalDeclContextStorage(uint64_t Offset, DeclContext *DC) {
2418  return Reader->ReadLexicalDeclContextStorage(*F, F->DeclsCursor, Offset,
2419  DC);
2420  }
2421 
2422  /// Read the record that describes the visible contents of a DC.
2423  bool readVisibleDeclContextStorage(uint64_t Offset,
2424  serialization::DeclID ID) {
2425  return Reader->ReadVisibleDeclContextStorage(*F, F->DeclsCursor, Offset,
2426  ID);
2427  }
2428 
2431  return Reader->readExceptionSpec(*F, ExceptionStorage, ESI, Record, Idx);
2432  }
2433 
2434  /// Get the global offset corresponding to a local offset.
2435  uint64_t getGlobalBitOffset(uint32_t LocalOffset) {
2436  return Reader->getGlobalBitOffset(*F, LocalOffset);
2437  }
2438 
2439  /// Reads a statement.
2440  Stmt *readStmt() { return Reader->ReadStmt(*F); }
2441 
2442  /// Reads an expression.
2443  Expr *readExpr() { return Reader->ReadExpr(*F); }
2444 
2445  /// Reads a sub-statement operand during statement reading.
2446  Stmt *readSubStmt() { return Reader->ReadSubStmt(); }
2447 
2448  /// Reads a sub-expression operand during statement reading.
2449  Expr *readSubExpr() { return Reader->ReadSubExpr(); }
2450 
2451  /// Reads a declaration with the given local ID in the given module.
2452  ///
2453  /// \returns The requested declaration, casted to the given return type.
2454  template<typename T>
2455  T *GetLocalDeclAs(uint32_t LocalID) {
2456  return cast_or_null<T>(Reader->GetLocalDecl(*F, LocalID));
2457  }
2458 
2459  /// Reads a TemplateArgumentLocInfo appropriate for the
2460  /// given TemplateArgument kind, advancing Idx.
2463  return Reader->GetTemplateArgumentLocInfo(*F, Kind, Record, Idx);
2464  }
2465 
2466  /// Reads a TemplateArgumentLoc, advancing Idx.
2469  return Reader->ReadTemplateArgumentLoc(*F, Record, Idx);
2470  }
2471 
2474  return Reader->ReadASTTemplateArgumentListInfo(*F, Record, Idx);
2475  }
2476 
2477  /// Reads a declarator info from the given record, advancing Idx.
2479  return Reader->GetTypeSourceInfo(*F, Record, Idx);
2480  }
2481 
2482  /// Reads the location information for a type.
2484  return Reader->ReadTypeLoc(*F, Record, Idx, TL);
2485  }
2486 
2487  /// Map a local type ID within a given AST file to a global type ID.
2488  serialization::TypeID getGlobalTypeID(unsigned LocalID) const {
2489  return Reader->getGlobalTypeID(*F, LocalID);
2490  }
2491 
2492  /// Read a type from the current position in the record.
2494  return Reader->readType(*F, Record, Idx);
2495  }
2496 
2497  /// Reads a declaration ID from the given position in this record.
2498  ///
2499  /// \returns The declaration ID read from the record, adjusted to a global ID.
2501  return Reader->ReadDeclID(*F, Record, Idx);
2502  }
2503 
2504  /// Reads a declaration from the given position in a record in the
2505  /// given module, advancing Idx.
2506  Decl *readDecl() {
2507  return Reader->ReadDecl(*F, Record, Idx);
2508  }
2509 
2510  /// Reads a declaration from the given position in the record,
2511  /// advancing Idx.
2512  ///
2513  /// \returns The declaration read from this location, casted to the given
2514  /// result type.
2515  template<typename T>
2516  T *readDeclAs() {
2517  return Reader->ReadDeclAs<T>(*F, Record, Idx);
2518  }
2519 
2521  return Reader->GetIdentifierInfo(*F, Record, Idx);
2522  }
2523 
2524  /// Read a selector from the Record, advancing Idx.
2526  return Reader->ReadSelector(*F, Record, Idx);
2527  }
2528 
2529  /// Read a declaration name, advancing Idx.
2531  return Reader->ReadDeclarationName(*F, Record, Idx);
2532  }
2534  return Reader->ReadDeclarationNameLoc(*F, DNLoc, Name, Record, Idx);
2535  }
2537  return Reader->ReadDeclarationNameInfo(*F, NameInfo, Record, Idx);
2538  }
2539 
2541  return Reader->ReadQualifierInfo(*F, Info, Record, Idx);
2542  }
2543 
2545  return Reader->ReadNestedNameSpecifier(*F, Record, Idx);
2546  }
2547 
2549  return Reader->ReadNestedNameSpecifierLoc(*F, Record, Idx);
2550  }
2551 
2552  /// Read a template name, advancing Idx.
2554  return Reader->ReadTemplateName(*F, Record, Idx);
2555  }
2556 
2557  /// Read a template argument, advancing Idx.
2558  TemplateArgument readTemplateArgument(bool Canonicalize = false) {
2559  return Reader->ReadTemplateArgument(*F, Record, Idx, Canonicalize);
2560  }
2561 
2562  /// Read a template parameter list, advancing Idx.
2564  return Reader->ReadTemplateParameterList(*F, Record, Idx);
2565  }
2566 
2567  /// Read a template argument array, advancing Idx.
2569  bool Canonicalize = false) {
2570  return Reader->ReadTemplateArgumentList(TemplArgs, *F, Record, Idx,
2571  Canonicalize);
2572  }
2573 
2574  /// Read a UnresolvedSet structure, advancing Idx.
2576  return Reader->ReadUnresolvedSet(*F, Set, Record, Idx);
2577  }
2578 
2579  /// Read a C++ base specifier, advancing Idx.
2581  return Reader->ReadCXXBaseSpecifier(*F, Record, Idx);
2582  }
2583 
2584  /// Read a CXXCtorInitializer array, advancing Idx.
2586  return Reader->ReadCXXCtorInitializers(*F, Record, Idx);
2587  }
2588 
2590  return Reader->ReadCXXTemporary(*F, Record, Idx);
2591  }
2592 
2593  /// Read a source location, advancing Idx.
2595  return Reader->ReadSourceLocation(*F, Record, Idx);
2596  }
2597 
2598  /// Read a source range, advancing Idx.
2600  return Reader->ReadSourceRange(*F, Record, Idx);
2601  }
2602 
2603  /// Read an integral value, advancing Idx.
2604  llvm::APInt readAPInt() {
2605  return Reader->ReadAPInt(Record, Idx);
2606  }
2607 
2608  /// Read a signed integral value, advancing Idx.
2609  llvm::APSInt readAPSInt() {
2610  return Reader->ReadAPSInt(Record, Idx);
2611  }
2612 
2613  /// Read a floating-point value, advancing Idx.
2614  llvm::APFloat readAPFloat(const llvm::fltSemantics &Sem) {
2615  return Reader->ReadAPFloat(Record, Sem,Idx);
2616  }
2617 
2618  /// Read a string, advancing Idx.
2619  std::string readString() {
2620  return Reader->ReadString(Record, Idx);
2621  }
2622 
2623  /// Read a path, advancing Idx.
2624  std::string readPath() {
2625  return Reader->ReadPath(*F, Record, Idx);
2626  }
2627 
2628  /// Read a version tuple, advancing Idx.
2629  VersionTuple readVersionTuple() {
2630  return ASTReader::ReadVersionTuple(Record, Idx);
2631  }
2632 
2633  /// Reads attributes from the current stream position, advancing Idx.
2634  void readAttributes(AttrVec &Attrs) {
2635  return Reader->ReadAttributes(*this, Attrs);
2636  }
2637 
2638  /// Reads a token out of a record, advancing Idx.
2640  return Reader->ReadToken(*F, Record, Idx);
2641  }
2642 
2643  void recordSwitchCaseID(SwitchCase *SC, unsigned ID) {
2644  Reader->RecordSwitchCaseID(SC, ID);
2645  }
2646 
2647  /// Retrieve the switch-case statement with the given ID.
2649  return Reader->getSwitchCaseWithID(ID);
2650  }
2651 };
2652 
2653 /// Helper class that saves the current stream position and
2654 /// then restores it when destroyed.
2656  explicit SavedStreamPosition(llvm::BitstreamCursor &Cursor)
2657  : Cursor(Cursor), Offset(Cursor.GetCurrentBitNo()) {}
2658 
2660  Cursor.JumpToBit(Offset);
2661  }
2662 
2663 private:
2664  llvm::BitstreamCursor &Cursor;
2665  uint64_t Offset;
2666 };
2667 
2668 inline void PCHValidator::Error(const char *Msg) {
2669  Reader.Error(Msg);
2670 }
2671 
2672 } // namespace clang
2673 
2674 #endif // LLVM_CLANG_SERIALIZATION_ASTREADER_H
llvm::APInt ReadAPInt(const RecordData &Record, unsigned &Idx)
Read an integral value.
Definition: ASTReader.cpp:9073
const uint64_t & readInt()
Returns the current value in this record, and advances to the next value.
Definition: ASTReader.h:2397
SmallVector< std::pair< llvm::BitstreamCursor, serialization::ModuleFile * >, 8 > CommentsCursors
Cursors for comments blocks.
Definition: ASTReader.h:2337
Decl * GetLocalDecl(ModuleFile &F, uint32_t LocalID)
Reads a declaration with the given local ID in the given module.
Definition: ASTReader.h:1841
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:2594
Represents a function declaration or definition.
Definition: Decl.h:1722
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:2182
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:640
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:116
ASTConsumer - This is an abstract interface that should be implemented by clients that read ASTs...
Definition: ASTConsumer.h:34
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:1496
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:2371
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:1626
Module * getSubmodule(serialization::SubmoduleID GlobalID)
Retrieve the submodule that corresponds to a global submodule ID.
Definition: ASTReader.cpp:8474
SourceLocation ReadSourceLocation(ModuleFile &ModuleFile, uint32_t Raw) const
Read a source location from raw form.
Definition: ASTReader.h:2187
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:86
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:2614
The base class of the type hierarchy.
Definition: Type.h:1413
StringRef getOriginalSourceFile()
Retrieve the name of the original source file name for the primary module file.
Definition: ASTReader.h:1667
Decl * GetDecl(serialization::DeclID ID)
Resolve a declaration ID into a declaration, potentially building a new declaration.
Definition: ASTReader.cpp:7354
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
Base class that describes a preprocessed entity, which may be a preprocessor directive or macro expan...
void readQualifierInfo(QualifierInfo &Info)
Definition: ASTReader.h:2540
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:2483
CXXBaseSpecifier ReadCXXBaseSpecifier(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Read a C++ base specifier.
Definition: ASTReader.cpp:8864
ModuleDeclIterator(ASTReader *Reader, ModuleFile *Mod, const serialization::LocalDeclID *Pos)
Definition: ASTReader.h:1400
Manages the set of modules loaded by an AST reader.
Definition: ModuleManager.h:49
Options for controlling the target.
Definition: TargetOptions.h:26
Manage memory buffers across multiple users.
unsigned getTotalNumPreprocessedEntities() const
Returns the number of preprocessed entities known to the AST reader.
Definition: ASTReader.h:1763
void recordSwitchCaseID(SwitchCase *SC, unsigned ID)
Definition: ASTReader.h:2643
QualType readType()
Read a type from the current position in the record.
Definition: ASTReader.h:2493
Represents an explicit template argument list in C++, e.g., the "<int>" in "sort<int>".
Definition: TemplateBase.h:601
Stores a list of template parameters for a TemplateDecl and its derived classes.
Definition: DeclTemplate.h:68
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:1881
Selector ReadSelector(ModuleFile &M, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.h:2116
Module * getSubmodule(serialization::SubmoduleID GlobalID)
Retrieve the submodule that corresponds to a global submodule ID.
Definition: ASTReader.h:2412
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:2488
StringRef ModuleOffsetMap
The module offset map data for this file.
Definition: Module.h:216
NestedNameSpecifierLoc readNestedNameSpecifierLoc()
Definition: ASTReader.h:2548
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:2516
T * GetLocalDeclAs(ModuleFile &F, uint32_t LocalID)
Reads a declaration with the given local ID in the given module.
Definition: ASTReader.h:1849
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:153
A C++ nested-name-specifier augmented with source location information.
Utility class for loading a ASTContext from an AST file.
Definition: ASTUnit.h:88
unsigned getTotalNumDecls() const
Returns the number of declarations found in the chain.
Definition: ASTReader.h:1747
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:2554
Definition: Format.h:2031
Expr * readExpr()
Reads an expression.
Definition: ASTReader.h:2443
Helper class that saves the current stream position and then restores it when destroyed.
Definition: ASTReader.h:2655
TemplateName ReadTemplateName(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Read a template name.
Definition: ASTReader.cpp:8708
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:35
TemplateArgument readTemplateArgument(bool Canonicalize=false)
Read a template argument, advancing Idx.
Definition: ASTReader.h:2558
Sema * getSema()
Retrieve the semantic analysis object used to analyze the translation unit in which the precompiled h...
Definition: ASTReader.h:2315
Stmt * ReadSubStmt()
Reads a sub-statement operand during statement reading.
Definition: ASTReader.h:2258
uint32_t MacroID
An ID number that refers to a macro in an AST file.
Definition: ASTBitCodes.h:141
The signature of a module, which is a hash of the AST content.
Definition: Module.h:55
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:50
static void SkipString(const RecordData &Record, unsigned &Idx)
Definition: ASTReader.h:2230
TypeSourceInfo * getTypeSourceInfo()
Reads a declarator info from the given record, advancing Idx.
Definition: ASTReader.h:2478
Decl * getKeyDeclaration(Decl *D)
Returns the first key declaration for the given declaration.
Definition: ASTReader.h:1231
Describes a module or submodule.
Definition: Module.h:65
size_t size() const
The length of this record.
Definition: ASTReader.h:2387
static VersionTuple ReadVersionTuple(const RecordData &Record, unsigned &Idx)
Read a version tuple.
Definition: ASTReader.cpp:9109
ImportedSubmodule(serialization::SubmoduleID ID, SourceLocation ImportLoc)
Definition: ASTReader.h:908
FileManager & getFileManager() const
Definition: ASTReader.h:1497
TypeSourceInfo * GetTypeSourceInfo(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Reads a declarator info from the given record.
Definition: ASTReader.cpp:6778
uint32_t Offset
Definition: CacheTokens.cpp:43
static void dump(llvm::raw_ostream &OS, StringRef FunctionName, ArrayRef< CounterExpression > Expressions, ArrayRef< CounterMappingRegion > Regions)
ModuleManager & getModuleManager()
Retrieve the module manager.
Definition: ASTReader.h:1660
void ReadQualifierInfo(ModuleFile &F, QualifierInfo &Info, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.cpp:8694
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:7222
CXXCtorInitializer ** ReadCXXCtorInitializers(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Read a CXXCtorInitializer array.
Definition: ASTReader.cpp:8880
llvm::APSInt ReadAPSInt(const RecordData &Record, unsigned &Idx)
Read a signed integral value.
Definition: ASTReader.cpp:9082
SourceLocation ReadSourceLocation(ModuleFile &ModuleFile, const RecordDataImpl &Record, unsigned &Idx)
Read a source location.
Definition: ASTReader.h:2206
std::string ReadPath(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.cpp:9102
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:8459
CXXTemporary * ReadCXXTemporary(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.cpp:9121
TemplateArgument ReadTemplateArgument(ModuleFile &F, const RecordData &Record, unsigned &Idx, bool Canonicalize=false)
Read a template argument.
Definition: ASTReader.cpp:8767
ASTContext & getContext()
Retrieve the AST context that this AST reader supplements.
Definition: ASTReader.h:2303
Defines the Diagnostic-related interfaces.
SourceRange readSourceRange()
Read a source range, advancing Idx.
Definition: ASTReader.h:2599
const Decl * getKeyDeclaration(const Decl *D)
Definition: ASTReader.h:1241
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:138
void resetForReload()
Reset reader for a reload try.
Definition: ASTReader.h:1629
TemplateArgumentLocInfo getTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind)
Reads a TemplateArgumentLocInfo appropriate for the given TemplateArgument kind, advancing Idx...
Definition: ASTReader.h:2462
ContinuousRangeMap< uint32_t, int, 2 > SLocRemap
Remapping table for source locations in this module.
Definition: Module.h:261
const ASTTemplateArgumentListInfo * readASTTemplateArgumentListInfo()
Definition: ASTReader.h:2473
Represents an ObjC class declaration.
Definition: DeclObjC.h:1169
This abstract interface provides operations for unwrapping containers for serialized ASTs (precompile...
CXXBaseSpecifier readCXXBaseSpecifier()
Read a C++ base specifier, advancing Idx.
Definition: ASTReader.h:2580
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:51
virtual Decl * getCanonicalDecl()
Retrieves the "canonical" declaration of the given declaration.
Definition: DeclBase.h:883
const uint64_t & peekInt()
Returns the current value in this record, without advancing.
Definition: ASTReader.h:2400
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:9095
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:2046
void ForgetSema() override
Inform the semantic consumer that Sema is no longer available.
Definition: ASTReader.h:1966
Sema - This implements semantic analysis and AST building for C.
Definition: Sema.h:277
A little helper class used to produce diagnostics.
Definition: Diagnostic.h:1042
TemplateParameterList * readTemplateParameterList()
Read a template parameter list, advancing Idx.
Definition: ASTReader.h:2563
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:1410
ModuleKind
Specifies the kind of module that has been loaded.
Definition: Module.h:43
StringRef Filename
Definition: Format.cpp:1605
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:2568
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:1871
std::string readPath()
Read a path, advancing Idx.
Definition: ASTReader.h:2624
llvm::pointee_iterator< SmallVectorImpl< std::unique_ptr< ModuleFile > >::reverse_iterator > ModuleReverseIterator
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:7039
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:640
Expr - This represents one expression.
Definition: Expr.h:106
SwitchCase * getSwitchCaseWithID(unsigned ID)
Retrieve the switch-case statement with the given ID.
Definition: ASTReader.cpp:9151
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:1805
RAII object to temporarily add an AST callback listener.
Definition: ASTReader.h:1589
Stmt * ReadStmt(ModuleFile &F)
Reads a statement.
Implements an efficient mapping from strings to IdentifierInfo nodes.
Stmt * readStmt()
Reads a statement.
Definition: ASTReader.h:2440
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:1752
ArgKind
The kind of template argument we&#39;re storing.
Definition: TemplateBase.h:54
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:9065
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:2506
Represents a C++ template name within the type system.
Definition: TemplateName.h:178
Information about a module that has been loaded by the ASTReader.
Definition: Module.h:108
const uint64_t & back() const
The last element in this record.
Definition: ASTReader.h:2393
uint32_t IdentifierID
An ID number that refers to an identifier in an AST file.
Definition: ASTBitCodes.h:61
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:2520
SavedStreamPosition(llvm::BitstreamCursor &Cursor)
Definition: ASTReader.h:2656
The result type of a method or function.
std::string readString()
Read a string, advancing Idx.
Definition: ASTReader.h:2619
DiagnosticsEngine & getDiags() const
Definition: ASTReader.h:1498
SmallVector< uint64_t, 16 > PreloadedDeclIDs
Definition: ASTReader.h:2310
void ReadDeclarationNameInfo(ModuleFile &F, DeclarationNameInfo &NameInfo, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.cpp:8684
void skipInts(unsigned N)
Skips the specified number of values.
Definition: ASTReader.h:2403
const uint64_t & operator[](size_t N)
An arbitrary index in this record.
Definition: ASTReader.h:2390
bool isModule() const
Is this a module file for a module (rather than a PCH or similar).
Definition: ASTReader.h:2378
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:8946
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:172
static void SkipPath(const RecordData &Record, unsigned &Idx)
Definition: ASTReader.h:2238
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:665
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:1581
CXXTemporary * readCXXTemporary()
Definition: ASTReader.h:2589
Encodes a location in the source.
unsigned getTotalNumMacros() const
Returns the number of macros found in the chain.
Definition: ASTReader.h:1737
Stmt * readSubStmt()
Reads a sub-statement operand during statement reading.
Definition: ASTReader.h:2446
Represents a C++ temporary.
Definition: ExprCXX.h:1297
CXXCtorInitializer ** readCXXCtorInitializers()
Read a CXXCtorInitializer array, advancing Idx.
Definition: ASTReader.h:2585
An identifier-lookup iterator that enumerates all of the identifiers stored within a set of AST files...
Definition: ASTReader.cpp:7901
std::unique_ptr< ASTReaderListener > takeListener()
Take the AST callbacks listener.
Definition: ASTReader.h:1569
bool readLexicalDeclContextStorage(uint64_t Offset, DeclContext *DC)
Read the record that describes the lexical contents of a DC.
Definition: ASTReader.h:2417
Cached information about one file (either on disk or in the virtual file system). ...
Definition: FileManager.h:59
bool isModule() const
Is this a module file for a module (rather than a PCH or similar).
Definition: Module.h:477
bool isProcessingUpdateRecords()
Definition: ASTReader.h:2354
void readDeclarationNameInfo(DeclarationNameInfo &NameInfo)
Definition: ASTReader.h:2536
ASTDeserializationListener * getDeserializationListener()
Get the AST deserialization listener.
Definition: ASTReader.h:1618
TemplateParameterList * ReadTemplateParameterList(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Read a template parameter list.
Definition: ASTReader.cpp:8822
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:2449
T * GetLocalDeclAs(uint32_t LocalID)
Reads a declaration with the given local ID in the given module.
Definition: ASTReader.h:2455
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:90
virtual bool ReadFullVersionInformation(StringRef FullVersion)
Receives the full Clang version information.
Definition: ASTReader.h:134
void readDeclarationNameLoc(DeclarationNameLoc &DNLoc, DeclarationName Name)
Definition: ASTReader.h:2533
void addInMemoryBuffer(StringRef &FileName, std::unique_ptr< llvm::MemoryBuffer > Buffer)
Add in-memory (virtual file) buffer.
Definition: ASTReader.h:1647
PCHValidator(Preprocessor &PP, ASTReader &Reader)
Definition: ASTReader.h:293
unsigned getIdx() const
The current position in this record.
Definition: ASTReader.h:2384
ASTContext & getContext()
Retrieve the AST context that this AST reader supplements.
Definition: ASTReader.h:2381
bool isFromASTFile() const
Determine whether this declaration came from an AST file (such as a precompiled header or module) rat...
Definition: DeclBase.h:708
uint32_t TypeID
An ID number that refers to a type in an AST file.
Definition: ASTBitCodes.h:86
void setListener(std::unique_ptr< ASTReaderListener > Listener)
Set the AST callbacks listener.
Definition: ASTReader.h:1574
void readExceptionSpec(SmallVectorImpl< QualType > &ExceptionStorage, FunctionProtoType::ExceptionSpecInfo &ESI)
Definition: ASTReader.h:2429
serialization::SubmoduleID getGlobalSubmoduleID(unsigned LocalID)
Retrieve the global submodule ID its local ID number.
Definition: ASTReader.h:2407
External source of source location entries.
virtual void visitImport(StringRef Filename)
If needsImportVisitation returns true, this is called for each AST file imported by this AST file...
Definition: ASTReader.h:235
serialization::SubmoduleID ID
Definition: ASTReader.h:905
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:169
DeclarationName ReadDeclarationName(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Read a declaration name.
Definition: ASTReader.cpp:8607
unsigned getTotalNumSelectors() const
Returns the number of selectors found in the chain.
Definition: ASTReader.h:1757
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:9088
The input file that has been loaded from this AST file, along with bools indicating whether this was ...
Definition: Module.h:66
serialization::DeclID readDeclID()
Reads a declaration ID from the given position in this record.
Definition: ASTReader.h:2500
void readAttributes(AttrVec &Attrs)
Reads attributes from the current stream position, advancing Idx.
Definition: ASTReader.h:2634
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:1742
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
Represents a template argument.
Definition: TemplateBase.h:51
const ASTTemplateArgumentListInfo * ReadASTTemplateArgumentListInfo(ModuleFile &F, const RecordData &Record, unsigned &Index)
Definition: ASTReader.cpp:7107
uint32_t SelectorID
An ID number that refers to an ObjC selector in an AST file.
Definition: ASTBitCodes.h:154
Dataflow Directional Tag Classes.
llvm::BitstreamCursor DeclsCursor
DeclsCursor - This is a cursor to the start of the DECLS_BLOCK block.
Definition: Module.h:406
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Definition: DeclBase.h:1272
An external source of header file information, which may supply information about header files alread...
Definition: HeaderSearch.h:134
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:2194
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:2525
Expr * ReadExpr(ModuleFile &F)
Reads an expression.
ListenerScope(ASTReader &Reader, std::unique_ptr< ASTReaderListener > L)
Definition: ASTReader.h:1594
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:1623
LoadFailureCapabilities
Flags that indicate what kind of AST loading failures the client of the AST reader can directly handl...
Definition: ASTReader.h:1505
DeclarationName - The name of a declaration.
virtual void ReadModuleMapFile(StringRef ModuleMapPath)
Definition: ASTReader.h:139
TemplateArgumentLoc readTemplateArgumentLoc()
Reads a TemplateArgumentLoc, advancing Idx.
Definition: ASTReader.h:2468
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:8651
uint32_t DeclID
An ID number that refers to a declaration in an AST file.
Definition: ASTBitCodes.h:69
VersionTuple readVersionTuple()
Read a version tuple, advancing Idx.
Definition: ASTReader.h:2629
Encapsulates the data about a macro definition (e.g.
Definition: MacroInfo.h:40
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:8852
Abstract interface for callback invocations by the ASTReader.
Definition: ASTReader.h:126
Location wrapper for a TemplateArgument.
Definition: TemplateBase.h:450
NestedNameSpecifierLoc ReadNestedNameSpecifierLoc(ModuleFile &F, const RecordData &Record, unsigned &Idx)
Definition: ASTReader.cpp:9001
Represents a C++ base or member initializer.
Definition: DeclCXX.h:2258
uint64_t getGlobalBitOffset(uint32_t LocalOffset)
Get the global offset corresponding to a local offset.
Definition: ASTReader.h:2435
void ReadTemplateArgumentList(SmallVectorImpl< TemplateArgument > &TemplArgs, ModuleFile &F, const RecordData &Record, unsigned &Idx, bool Canonicalize=false)
Read a template argument array.
Definition: ASTReader.cpp:8842
llvm::APSInt readAPSInt()
Read a signed integral value, advancing Idx.
Definition: ASTReader.h:2609
void forEachImportedKeyDecl(const Decl *D, Fn Visit)
Run a callback on each imported key declaration of D.
Definition: ASTReader.h:1247
void ReadTypeLoc(ModuleFile &F, const RecordData &Record, unsigned &Idx, TypeLoc TL)
Raad the type locations for the given TInfo.
Definition: ASTReader.cpp:6770
Preprocessor & getPreprocessor() const
Retrieve the preprocessor.
Definition: ASTReader.h:1663
Represents a base class of a C++ class.
Definition: DeclCXX.h:192
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:2553
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:7094
TemplateArgumentLocInfo GetTemplateArgumentLocInfo(ModuleFile &F, TemplateArgument::ArgKind Kind, const RecordData &Record, unsigned &Idx)
Reads a TemplateArgumentLocInfo appropriate for the given TemplateArgument kind.
Definition: ASTReader.cpp:7058
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:7392
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:1561
IdentifierInfo * GetIdentifier(serialization::IdentifierID ID) override
Definition: ASTReader.h:2051
unsigned getTotalNumSLocs() const
Returns the number of source locations found in the chain.
Definition: ASTReader.h:1727
Location information for a TemplateArgument.
Definition: TemplateBase.h:393
DeclarationName readDeclarationName()
Read a declaration name, advancing Idx.
Definition: ASTReader.h:2530
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:1732
llvm::APInt readAPInt()
Read an integral value, advancing Idx.
Definition: ASTReader.h:2604
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:267
Simple wrapper class for chaining listeners.
Definition: ASTReader.h:243
An object for streaming information from a record.
Definition: ASTReader.h:2358
bool readVisibleDeclContextStorage(uint64_t Offset, serialization::DeclID ID)
Read the record that describes the visible contents of a DC.
Definition: ASTReader.h:2423
Kind
Lists the kind of concrete classes of Decl.
Definition: DeclBase.h:89
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:2544
Token readToken()
Reads a token out of a record, advancing Idx.
Definition: ASTReader.h:2639
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:1700
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:2648
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:83
This class handles loading and caching of source files into memory.
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:9144
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:127
void readUnresolvedSet(LazyASTUnresolvedSet &Set)
Read a UnresolvedSet structure, advancing Idx.
Definition: ASTReader.h:2575