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