Coverage Report

Created: 2021-08-24 07:12

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/include/clang/Serialization/ASTWriter.h
Line
Count
Source (jump to first uncovered line)
1
//===- ASTWriter.h - AST File Writer ----------------------------*- 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 ASTWriter class, which writes an AST file
10
//  containing a serialized representation of a translation unit.
11
//
12
//===----------------------------------------------------------------------===//
13
14
#ifndef LLVM_CLANG_SERIALIZATION_ASTWRITER_H
15
#define LLVM_CLANG_SERIALIZATION_ASTWRITER_H
16
17
#include "clang/AST/ASTMutationListener.h"
18
#include "clang/AST/Decl.h"
19
#include "clang/AST/Type.h"
20
#include "clang/Basic/LLVM.h"
21
#include "clang/Basic/SourceLocation.h"
22
#include "clang/Sema/Sema.h"
23
#include "clang/Sema/SemaConsumer.h"
24
#include "clang/Serialization/ASTBitCodes.h"
25
#include "clang/Serialization/ASTDeserializationListener.h"
26
#include "clang/Serialization/PCHContainerOperations.h"
27
#include "llvm/ADT/ArrayRef.h"
28
#include "llvm/ADT/DenseMap.h"
29
#include "llvm/ADT/DenseSet.h"
30
#include "llvm/ADT/MapVector.h"
31
#include "llvm/ADT/STLExtras.h"
32
#include "llvm/ADT/SetVector.h"
33
#include "llvm/ADT/SmallVector.h"
34
#include "llvm/ADT/StringRef.h"
35
#include "llvm/Bitstream/BitstreamWriter.h"
36
#include <cassert>
37
#include <cstddef>
38
#include <cstdint>
39
#include <ctime>
40
#include <memory>
41
#include <queue>
42
#include <string>
43
#include <utility>
44
#include <vector>
45
46
namespace llvm {
47
48
class APFloat;
49
class APInt;
50
class APSInt;
51
52
} // namespace llvm
53
54
namespace clang {
55
56
class ASTContext;
57
class ASTReader;
58
class ASTUnresolvedSet;
59
class Attr;
60
class CXXBaseSpecifier;
61
class CXXCtorInitializer;
62
class CXXRecordDecl;
63
class CXXTemporary;
64
class FileEntry;
65
class FPOptions;
66
class FPOptionsOverride;
67
class FunctionDecl;
68
class HeaderSearch;
69
class HeaderSearchOptions;
70
class IdentifierResolver;
71
class LangOptions;
72
class MacroDefinitionRecord;
73
class MacroInfo;
74
class Module;
75
class InMemoryModuleCache;
76
class ModuleFileExtension;
77
class ModuleFileExtensionWriter;
78
class NamedDecl;
79
class ObjCInterfaceDecl;
80
class PreprocessingRecord;
81
class Preprocessor;
82
struct QualifierInfo;
83
class RecordDecl;
84
class Sema;
85
class SourceManager;
86
class Stmt;
87
class StoredDeclsList;
88
class SwitchCase;
89
class TemplateParameterList;
90
class Token;
91
class TypeSourceInfo;
92
93
/// Writes an AST file containing the contents of a translation unit.
94
///
95
/// The ASTWriter class produces a bitstream containing the serialized
96
/// representation of a given abstract syntax tree and its supporting
97
/// data structures. This bitstream can be de-serialized via an
98
/// instance of the ASTReader class.
99
class ASTWriter : public ASTDeserializationListener,
100
                  public ASTMutationListener {
101
public:
102
  friend class ASTDeclWriter;
103
  friend class ASTRecordWriter;
104
105
  using RecordData = SmallVector<uint64_t, 64>;
106
  using RecordDataImpl = SmallVectorImpl<uint64_t>;
107
  using RecordDataRef = ArrayRef<uint64_t>;
108
109
private:
110
  /// Map that provides the ID numbers of each type within the
111
  /// output stream, plus those deserialized from a chained PCH.
112
  ///
113
  /// The ID numbers of types are consecutive (in order of discovery)
114
  /// and start at 1. 0 is reserved for NULL. When types are actually
115
  /// stored in the stream, the ID number is shifted by 2 bits to
116
  /// allow for the const/volatile qualifiers.
117
  ///
118
  /// Keys in the map never have const/volatile qualifiers.
119
  using TypeIdxMap = llvm::DenseMap<QualType, serialization::TypeIdx,
120
                                    serialization::UnsafeQualTypeDenseMapInfo>;
121
122
  /// The bitstream writer used to emit this precompiled header.
123
  llvm::BitstreamWriter &Stream;
124
125
  /// The buffer associated with the bitstream.
126
  const SmallVectorImpl<char> &Buffer;
127
128
  /// The PCM manager which manages memory buffers for pcm files.
129
  InMemoryModuleCache &ModuleCache;
130
131
  /// The ASTContext we're writing.
132
  ASTContext *Context = nullptr;
133
134
  /// The preprocessor we're writing.
135
  Preprocessor *PP = nullptr;
136
137
  /// The reader of existing AST files, if we're chaining.
138
  ASTReader *Chain = nullptr;
139
140
  /// The module we're currently writing, if any.
141
  Module *WritingModule = nullptr;
142
143
  /// The offset of the first bit inside the AST_BLOCK.
144
  uint64_t ASTBlockStartOffset = 0;
145
146
  /// The range representing all the AST_BLOCK.
147
  std::pair<uint64_t, uint64_t> ASTBlockRange;
148
149
  /// The base directory for any relative paths we emit.
150
  std::string BaseDirectory;
151
152
  /// Indicates whether timestamps should be written to the produced
153
  /// module file. This is the case for files implicitly written to the
154
  /// module cache, where we need the timestamps to determine if the module
155
  /// file is up to date, but not otherwise.
156
  bool IncludeTimestamps;
157
158
  /// Indicates when the AST writing is actively performing
159
  /// serialization, rather than just queueing updates.
160
  bool WritingAST = false;
161
162
  /// Indicates that we are done serializing the collection of decls
163
  /// and types to emit.
164
  bool DoneWritingDeclsAndTypes = false;
165
166
  /// Indicates that the AST contained compiler errors.
167
  bool ASTHasCompilerErrors = false;
168
169
  /// Mapping from input file entries to the index into the
170
  /// offset table where information about that input file is stored.
171
  llvm::DenseMap<const FileEntry *, uint32_t> InputFileIDs;
172
173
  /// Stores a declaration or a type to be written to the AST file.
174
  class DeclOrType {
175
  public:
176
3.02M
    DeclOrType(Decl *D) : Stored(D), IsType(false) {}
177
1.55M
    DeclOrType(QualType T) : Stored(T.getAsOpaquePtr()), IsType(true) {}
178
179
6.12M
    bool isType() const { return IsType; }
180
3.02M
    bool isDecl() const { return !IsType; }
181
182
1.55M
    QualType getType() const {
183
1.55M
      assert(isType() && "Not a type!");
184
0
      return QualType::getFromOpaquePtr(Stored);
185
1.55M
    }
186
187
3.02M
    Decl *getDecl() const {
188
3.02M
      assert(isDecl() && "Not a decl!");
189
0
      return static_cast<Decl *>(Stored);
190
3.02M
    }
191
192
  private:
193
    void *Stored;
194
    bool IsType;
195
  };
196
197
  /// The declarations and types to emit.
198
  std::queue<DeclOrType> DeclTypesToEmit;
199
200
  /// The first ID number we can use for our own declarations.
201
  serialization::DeclID FirstDeclID = serialization::NUM_PREDEF_DECL_IDS;
202
203
  /// The decl ID that will be assigned to the next new decl.
204
  serialization::DeclID NextDeclID = FirstDeclID;
205
206
  /// Map that provides the ID numbers of each declaration within
207
  /// the output stream, as well as those deserialized from a chained PCH.
208
  ///
209
  /// The ID numbers of declarations are consecutive (in order of
210
  /// discovery) and start at 2. 1 is reserved for the translation
211
  /// unit, while 0 is reserved for NULL.
212
  llvm::DenseMap<const Decl *, serialization::DeclID> DeclIDs;
213
214
  /// Offset of each declaration in the bitstream, indexed by
215
  /// the declaration's ID.
216
  std::vector<serialization::DeclOffset> DeclOffsets;
217
218
  /// The offset of the DECLTYPES_BLOCK. The offsets in DeclOffsets
219
  /// are relative to this value.
220
  uint64_t DeclTypesBlockStartOffset = 0;
221
222
  /// Sorted (by file offset) vector of pairs of file offset/DeclID.
223
  using LocDeclIDsTy =
224
      SmallVector<std::pair<unsigned, serialization::DeclID>, 64>;
225
  struct DeclIDInFileInfo {
226
    LocDeclIDsTy DeclIDs;
227
228
    /// Set when the DeclIDs vectors from all files are joined, this
229
    /// indicates the index that this particular vector has in the global one.
230
    unsigned FirstDeclIndex;
231
  };
232
  using FileDeclIDsTy =
233
      llvm::DenseMap<FileID, std::unique_ptr<DeclIDInFileInfo>>;
234
235
  /// Map from file SLocEntries to info about the file-level declarations
236
  /// that it contains.
237
  FileDeclIDsTy FileDeclIDs;
238
239
  void associateDeclWithFile(const Decl *D, serialization::DeclID);
240
241
  /// The first ID number we can use for our own types.
242
  serialization::TypeID FirstTypeID = serialization::NUM_PREDEF_TYPE_IDS;
243
244
  /// The type ID that will be assigned to the next new type.
245
  serialization::TypeID NextTypeID = FirstTypeID;
246
247
  /// Map that provides the ID numbers of each type within the
248
  /// output stream, plus those deserialized from a chained PCH.
249
  ///
250
  /// The ID numbers of types are consecutive (in order of discovery)
251
  /// and start at 1. 0 is reserved for NULL. When types are actually
252
  /// stored in the stream, the ID number is shifted by 2 bits to
253
  /// allow for the const/volatile qualifiers.
254
  ///
255
  /// Keys in the map never have const/volatile qualifiers.
256
  TypeIdxMap TypeIdxs;
257
258
  /// Offset of each type in the bitstream, indexed by
259
  /// the type's ID.
260
  std::vector<serialization::UnderalignedInt64> TypeOffsets;
261
262
  /// The first ID number we can use for our own identifiers.
263
  serialization::IdentID FirstIdentID = serialization::NUM_PREDEF_IDENT_IDS;
264
265
  /// The identifier ID that will be assigned to the next new identifier.
266
  serialization::IdentID NextIdentID = FirstIdentID;
267
268
  /// Map that provides the ID numbers of each identifier in
269
  /// the output stream.
270
  ///
271
  /// The ID numbers for identifiers are consecutive (in order of
272
  /// discovery), starting at 1. An ID of zero refers to a NULL
273
  /// IdentifierInfo.
274
  llvm::MapVector<const IdentifierInfo *, serialization::IdentID> IdentifierIDs;
275
276
  /// The first ID number we can use for our own macros.
277
  serialization::MacroID FirstMacroID = serialization::NUM_PREDEF_MACRO_IDS;
278
279
  /// The identifier ID that will be assigned to the next new identifier.
280
  serialization::MacroID NextMacroID = FirstMacroID;
281
282
  /// Map that provides the ID numbers of each macro.
283
  llvm::DenseMap<MacroInfo *, serialization::MacroID> MacroIDs;
284
285
  struct MacroInfoToEmitData {
286
    const IdentifierInfo *Name;
287
    MacroInfo *MI;
288
    serialization::MacroID ID;
289
  };
290
291
  /// The macro infos to emit.
292
  std::vector<MacroInfoToEmitData> MacroInfosToEmit;
293
294
  llvm::DenseMap<const IdentifierInfo *, uint32_t>
295
      IdentMacroDirectivesOffsetMap;
296
297
  /// @name FlushStmt Caches
298
  /// @{
299
300
  /// Set of parent Stmts for the currently serializing sub-stmt.
301
  llvm::DenseSet<Stmt *> ParentStmts;
302
303
  /// Offsets of sub-stmts already serialized. The offset points
304
  /// just after the stmt record.
305
  llvm::DenseMap<Stmt *, uint64_t> SubStmtEntries;
306
307
  /// @}
308
309
  /// Offsets of each of the identifier IDs into the identifier
310
  /// table.
311
  std::vector<uint32_t> IdentifierOffsets;
312
313
  /// The first ID number we can use for our own submodules.
314
  serialization::SubmoduleID FirstSubmoduleID =
315
      serialization::NUM_PREDEF_SUBMODULE_IDS;
316
317
  /// The submodule ID that will be assigned to the next new submodule.
318
  serialization::SubmoduleID NextSubmoduleID = FirstSubmoduleID;
319
320
  /// The first ID number we can use for our own selectors.
321
  serialization::SelectorID FirstSelectorID =
322
      serialization::NUM_PREDEF_SELECTOR_IDS;
323
324
  /// The selector ID that will be assigned to the next new selector.
325
  serialization::SelectorID NextSelectorID = FirstSelectorID;
326
327
  /// Map that provides the ID numbers of each Selector.
328
  llvm::MapVector<Selector, serialization::SelectorID> SelectorIDs;
329
330
  /// Offset of each selector within the method pool/selector
331
  /// table, indexed by the Selector ID (-1).
332
  std::vector<uint32_t> SelectorOffsets;
333
334
  /// Mapping from macro definitions (as they occur in the preprocessing
335
  /// record) to the macro IDs.
336
  llvm::DenseMap<const MacroDefinitionRecord *,
337
                 serialization::PreprocessedEntityID> MacroDefinitions;
338
339
  /// Cache of indices of anonymous declarations within their lexical
340
  /// contexts.
341
  llvm::DenseMap<const Decl *, unsigned> AnonymousDeclarationNumbers;
342
343
  /// An update to a Decl.
344
  class DeclUpdate {
345
    /// A DeclUpdateKind.
346
    unsigned Kind;
347
    union {
348
      const Decl *Dcl;
349
      void *Type;
350
      SourceLocation::UIntTy Loc;
351
      unsigned Val;
352
      Module *Mod;
353
      const Attr *Attribute;
354
    };
355
356
  public:
357
1.90k
    DeclUpdate(unsigned Kind) : Kind(Kind), Dcl(nullptr) {}
358
719
    DeclUpdate(unsigned Kind, const Decl *Dcl) : Kind(Kind), Dcl(Dcl) {}
359
    DeclUpdate(unsigned Kind, QualType Type)
360
2
        : Kind(Kind), Type(Type.getAsOpaquePtr()) {}
361
    DeclUpdate(unsigned Kind, SourceLocation Loc)
362
7
        : Kind(Kind), Loc(Loc.getRawEncoding()) {}
363
1.31k
    DeclUpdate(unsigned Kind, unsigned Val) : Kind(Kind), Val(Val) {}
364
520
    DeclUpdate(unsigned Kind, Module *M) : Kind(Kind), Mod(M) {}
365
    DeclUpdate(unsigned Kind, const Attr *Attribute)
366
4
          : Kind(Kind), Attribute(Attribute) {}
367
368
4.46k
    unsigned getKind() const { return Kind; }
369
1.43k
    const Decl *getDecl() const { return Dcl; }
370
2
    QualType getType() const { return QualType::getFromOpaquePtr(Type); }
371
372
7
    SourceLocation getLoc() const {
373
7
      return SourceLocation::getFromRawEncoding(Loc);
374
7
    }
375
376
1.31k
    unsigned getNumber() const { return Val; }
377
520
    Module *getModule() const { return Mod; }
378
1
    const Attr *getAttr() const { return Attribute; }
379
  };
380
381
  using UpdateRecord = SmallVector<DeclUpdate, 1>;
382
  using DeclUpdateMap = llvm::MapVector<const Decl *, UpdateRecord>;
383
384
  /// Mapping from declarations that came from a chained PCH to the
385
  /// record containing modifications to them.
386
  DeclUpdateMap DeclUpdates;
387
388
  using FirstLatestDeclMap = llvm::DenseMap<Decl *, Decl *>;
389
390
  /// Map of first declarations from a chained PCH that point to the
391
  /// most recent declarations in another PCH.
392
  FirstLatestDeclMap FirstLatestDecls;
393
394
  /// Declarations encountered that might be external
395
  /// definitions.
396
  ///
397
  /// We keep track of external definitions and other 'interesting' declarations
398
  /// as we are emitting declarations to the AST file. The AST file contains a
399
  /// separate record for these declarations, which are provided to the AST
400
  /// consumer by the AST reader. This is behavior is required to properly cope with,
401
  /// e.g., tentative variable definitions that occur within
402
  /// headers. The declarations themselves are stored as declaration
403
  /// IDs, since they will be written out to an EAGERLY_DESERIALIZED_DECLS
404
  /// record.
405
  SmallVector<serialization::DeclID, 16> EagerlyDeserializedDecls;
406
  SmallVector<serialization::DeclID, 16> ModularCodegenDecls;
407
408
  /// DeclContexts that have received extensions since their serialized
409
  /// form.
410
  ///
411
  /// For namespaces, when we're chaining and encountering a namespace, we check
412
  /// if its primary namespace comes from the chain. If it does, we add the
413
  /// primary to this set, so that we can write out lexical content updates for
414
  /// it.
415
  llvm::SmallSetVector<const DeclContext *, 16> UpdatedDeclContexts;
416
417
  /// Keeps track of declarations that we must emit, even though we're
418
  /// not guaranteed to be able to find them by walking the AST starting at the
419
  /// translation unit.
420
  SmallVector<const Decl *, 16> DeclsToEmitEvenIfUnreferenced;
421
422
  /// The set of Objective-C class that have categories we
423
  /// should serialize.
424
  llvm::SetVector<ObjCInterfaceDecl *> ObjCClassesWithCategories;
425
426
  /// The set of declarations that may have redeclaration chains that
427
  /// need to be serialized.
428
  llvm::SmallVector<const Decl *, 16> Redeclarations;
429
430
  /// A cache of the first local declaration for "interesting"
431
  /// redeclaration chains.
432
  llvm::DenseMap<const Decl *, const Decl *> FirstLocalDeclCache;
433
434
  /// Mapping from SwitchCase statements to IDs.
435
  llvm::DenseMap<SwitchCase *, unsigned> SwitchCaseIDs;
436
437
  /// The number of statements written to the AST file.
438
  unsigned NumStatements = 0;
439
440
  /// The number of macros written to the AST file.
441
  unsigned NumMacros = 0;
442
443
  /// The number of lexical declcontexts written to the AST
444
  /// file.
445
  unsigned NumLexicalDeclContexts = 0;
446
447
  /// The number of visible declcontexts written to the AST
448
  /// file.
449
  unsigned NumVisibleDeclContexts = 0;
450
451
  /// A mapping from each known submodule to its ID number, which will
452
  /// be a positive integer.
453
  llvm::DenseMap<const Module *, unsigned> SubmoduleIDs;
454
455
  /// A list of the module file extension writers.
456
  std::vector<std::unique_ptr<ModuleFileExtensionWriter>>
457
      ModuleFileExtensionWriters;
458
459
  /// Retrieve or create a submodule ID for this module.
460
  unsigned getSubmoduleID(Module *Mod);
461
462
  /// Write the given subexpression to the bitstream.
463
  void WriteSubStmt(Stmt *S);
464
465
  void WriteBlockInfoBlock();
466
  void WriteControlBlock(Preprocessor &PP, ASTContext &Context,
467
                         StringRef isysroot, const std::string &OutputFile);
468
469
  /// Write out the signature and diagnostic options, and return the signature.
470
  ASTFileSignature writeUnhashedControlBlock(Preprocessor &PP,
471
                                             ASTContext &Context);
472
473
  /// Calculate hash of the pcm content.
474
  static std::pair<ASTFileSignature, ASTFileSignature>
475
  createSignature(StringRef AllBytes, StringRef ASTBlockBytes);
476
477
  void WriteInputFiles(SourceManager &SourceMgr, HeaderSearchOptions &HSOpts,
478
                       bool Modules);
479
  void WriteSourceManagerBlock(SourceManager &SourceMgr,
480
                               const Preprocessor &PP);
481
  void WritePreprocessor(const Preprocessor &PP, bool IsModule);
482
  void WriteHeaderSearch(const HeaderSearch &HS);
483
  void WritePreprocessorDetail(PreprocessingRecord &PPRec,
484
                               uint64_t MacroOffsetsBase);
485
  void WriteSubmodules(Module *WritingModule);
486
487
  void WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
488
                                     bool isModule);
489
490
  unsigned TypeExtQualAbbrev = 0;
491
  unsigned TypeFunctionProtoAbbrev = 0;
492
  void WriteTypeAbbrevs();
493
  void WriteType(QualType T);
494
495
  bool isLookupResultExternal(StoredDeclsList &Result, DeclContext *DC);
496
  bool isLookupResultEntirelyExternal(StoredDeclsList &Result, DeclContext *DC);
497
498
  void GenerateNameLookupTable(const DeclContext *DC,
499
                               llvm::SmallVectorImpl<char> &LookupTable);
500
  uint64_t WriteDeclContextLexicalBlock(ASTContext &Context, DeclContext *DC);
501
  uint64_t WriteDeclContextVisibleBlock(ASTContext &Context, DeclContext *DC);
502
  void WriteTypeDeclOffsets();
503
  void WriteFileDeclIDsMap();
504
  void WriteComments();
505
  void WriteSelectors(Sema &SemaRef);
506
  void WriteReferencedSelectorsPool(Sema &SemaRef);
507
  void WriteIdentifierTable(Preprocessor &PP, IdentifierResolver &IdResolver,
508
                            bool IsModule);
509
  void WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord);
510
  void WriteDeclContextVisibleUpdate(const DeclContext *DC);
511
  void WriteFPPragmaOptions(const FPOptionsOverride &Opts);
512
  void WriteOpenCLExtensions(Sema &SemaRef);
513
  void WriteCUDAPragmas(Sema &SemaRef);
514
  void WriteObjCCategories();
515
  void WriteLateParsedTemplates(Sema &SemaRef);
516
  void WriteOptimizePragmaOptions(Sema &SemaRef);
517
  void WriteMSStructPragmaOptions(Sema &SemaRef);
518
  void WriteMSPointersToMembersPragmaOptions(Sema &SemaRef);
519
  void WritePackPragmaOptions(Sema &SemaRef);
520
  void WriteFloatControlPragmaOptions(Sema &SemaRef);
521
  void WriteModuleFileExtension(Sema &SemaRef,
522
                                ModuleFileExtensionWriter &Writer);
523
524
  unsigned DeclParmVarAbbrev = 0;
525
  unsigned DeclContextLexicalAbbrev = 0;
526
  unsigned DeclContextVisibleLookupAbbrev = 0;
527
  unsigned UpdateVisibleAbbrev = 0;
528
  unsigned DeclRecordAbbrev = 0;
529
  unsigned DeclTypedefAbbrev = 0;
530
  unsigned DeclVarAbbrev = 0;
531
  unsigned DeclFieldAbbrev = 0;
532
  unsigned DeclEnumAbbrev = 0;
533
  unsigned DeclObjCIvarAbbrev = 0;
534
  unsigned DeclCXXMethodAbbrev = 0;
535
536
  unsigned DeclRefExprAbbrev = 0;
537
  unsigned CharacterLiteralAbbrev = 0;
538
  unsigned IntegerLiteralAbbrev = 0;
539
  unsigned ExprImplicitCastAbbrev = 0;
540
541
  void WriteDeclAbbrevs();
542
  void WriteDecl(ASTContext &Context, Decl *D);
543
544
  ASTFileSignature WriteASTCore(Sema &SemaRef, StringRef isysroot,
545
                                const std::string &OutputFile,
546
                                Module *WritingModule);
547
548
public:
549
  /// Create a new precompiled header writer that outputs to
550
  /// the given bitstream.
551
  ASTWriter(llvm::BitstreamWriter &Stream, SmallVectorImpl<char> &Buffer,
552
            InMemoryModuleCache &ModuleCache,
553
            ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
554
            bool IncludeTimestamps = true);
555
  ~ASTWriter() override;
556
557
9.96M
  ASTContext &getASTContext() const {
558
9.96M
    assert(Context && "requested AST context when not writing AST");
559
0
    return *Context;
560
9.96M
  }
561
562
  const LangOptions &getLangOpts() const;
563
564
  /// Get a timestamp for output into the AST file. The actual timestamp
565
  /// of the specified file may be ignored if we have been instructed to not
566
  /// include timestamps in the output file.
567
  time_t getTimestampForOutput(const FileEntry *E) const;
568
569
  /// Write a precompiled header for the given semantic analysis.
570
  ///
571
  /// \param SemaRef a reference to the semantic analysis object that processed
572
  /// the AST to be written into the precompiled header.
573
  ///
574
  /// \param WritingModule The module that we are writing. If null, we are
575
  /// writing a precompiled header.
576
  ///
577
  /// \param isysroot if non-empty, write a relocatable file whose headers
578
  /// are relative to the given system root. If we're writing a module, its
579
  /// build directory will be used in preference to this if both are available.
580
  ///
581
  /// \return the module signature, which eventually will be a hash of
582
  /// the module but currently is merely a random 32-bit number.
583
  ASTFileSignature WriteAST(Sema &SemaRef, const std::string &OutputFile,
584
                            Module *WritingModule, StringRef isysroot,
585
                            bool hasErrors = false,
586
                            bool ShouldCacheASTInMemory = false);
587
588
  /// Emit a token.
589
  void AddToken(const Token &Tok, RecordDataImpl &Record);
590
591
  /// Emit a AlignPackInfo.
592
  void AddAlignPackInfo(const Sema::AlignPackInfo &Info,
593
                        RecordDataImpl &Record);
594
595
  /// Emit a source location.
596
  void AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record);
597
598
  /// Emit a source range.
599
  void AddSourceRange(SourceRange Range, RecordDataImpl &Record);
600
601
  /// Emit a reference to an identifier.
602
  void AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record);
603
604
  /// Get the unique number used to refer to the given selector.
605
  serialization::SelectorID getSelectorRef(Selector Sel);
606
607
  /// Get the unique number used to refer to the given identifier.
608
  serialization::IdentID getIdentifierRef(const IdentifierInfo *II);
609
610
  /// Get the unique number used to refer to the given macro.
611
  serialization::MacroID getMacroRef(MacroInfo *MI, const IdentifierInfo *Name);
612
613
  /// Determine the ID of an already-emitted macro.
614
  serialization::MacroID getMacroID(MacroInfo *MI);
615
616
  uint32_t getMacroDirectivesOffset(const IdentifierInfo *Name);
617
618
  /// Emit a reference to a type.
619
  void AddTypeRef(QualType T, RecordDataImpl &Record);
620
621
  /// Force a type to be emitted and get its ID.
622
  serialization::TypeID GetOrCreateTypeID(QualType T);
623
624
  /// Determine the type ID of an already-emitted type.
625
  serialization::TypeID getTypeID(QualType T) const;
626
627
  /// Find the first local declaration of a given local redeclarable
628
  /// decl.
629
  const Decl *getFirstLocalDecl(const Decl *D);
630
631
  /// Is this a local declaration (that is, one that will be written to
632
  /// our AST file)? This is the case for declarations that are neither imported
633
  /// from another AST file nor predefined.
634
649k
  bool IsLocalDecl(const Decl *D) {
635
649k
    if (D->isFromASTFile())
636
18.2k
      return false;
637
631k
    auto I = DeclIDs.find(D);
638
631k
    return (I == DeclIDs.end() ||
639
631k
            
I->second >= serialization::NUM_PREDEF_DECL_IDS328k
);
640
649k
  };
641
642
  /// Emit a reference to a declaration.
643
  void AddDeclRef(const Decl *D, RecordDataImpl &Record);
644
645
  /// Force a declaration to be emitted and get its ID.
646
  serialization::DeclID GetDeclRef(const Decl *D);
647
648
  /// Determine the declaration ID of an already-emitted
649
  /// declaration.
650
  serialization::DeclID getDeclID(const Decl *D);
651
652
  unsigned getAnonymousDeclarationNumber(const NamedDecl *D);
653
654
  /// Add a string to the given record.
655
  void AddString(StringRef Str, RecordDataImpl &Record);
656
657
  /// Convert a path from this build process into one that is appropriate
658
  /// for emission in the module file.
659
  bool PreparePathForOutput(SmallVectorImpl<char> &Path);
660
661
  /// Add a path to the given record.
662
  void AddPath(StringRef Path, RecordDataImpl &Record);
663
664
  /// Emit the current record with the given path as a blob.
665
  void EmitRecordWithPath(unsigned Abbrev, RecordDataRef Record,
666
                          StringRef Path);
667
668
  /// Add a version tuple to the given record
669
  void AddVersionTuple(const VersionTuple &Version, RecordDataImpl &Record);
670
671
  /// Retrieve or create a submodule ID for this module, or return 0 if
672
  /// the submodule is neither local (a submodle of the currently-written module)
673
  /// nor from an imported module.
674
  unsigned getLocalOrImportedSubmoduleID(const Module *Mod);
675
676
  /// Note that the identifier II occurs at the given offset
677
  /// within the identifier table.
678
  void SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset);
679
680
  /// Note that the selector Sel occurs at the given offset
681
  /// within the method pool/selector table.
682
  void SetSelectorOffset(Selector Sel, uint32_t Offset);
683
684
  /// Record an ID for the given switch-case statement.
685
  unsigned RecordSwitchCaseID(SwitchCase *S);
686
687
  /// Retrieve the ID for the given switch-case statement.
688
  unsigned getSwitchCaseID(SwitchCase *S);
689
690
  void ClearSwitchCaseIDs();
691
692
6.22k
  unsigned getTypeExtQualAbbrev() const {
693
6.22k
    return TypeExtQualAbbrev;
694
6.22k
  }
695
696
0
  unsigned getTypeFunctionProtoAbbrev() const {
697
0
    return TypeFunctionProtoAbbrev;
698
0
  }
699
700
599k
  unsigned getDeclParmVarAbbrev() const { return DeclParmVarAbbrev; }
701
6.54k
  unsigned getDeclRecordAbbrev() const { return DeclRecordAbbrev; }
702
100k
  unsigned getDeclTypedefAbbrev() const { return DeclTypedefAbbrev; }
703
2.32k
  unsigned getDeclVarAbbrev() const { return DeclVarAbbrev; }
704
201k
  unsigned getDeclFieldAbbrev() const { return DeclFieldAbbrev; }
705
12.2k
  unsigned getDeclEnumAbbrev() const { return DeclEnumAbbrev; }
706
2.57k
  unsigned getDeclObjCIvarAbbrev() const { return DeclObjCIvarAbbrev; }
707
20.9k
  unsigned getDeclCXXMethodAbbrev() const { return DeclCXXMethodAbbrev; }
708
709
824k
  unsigned getDeclRefExprAbbrev() const { return DeclRefExprAbbrev; }
710
20.2k
  unsigned getCharacterLiteralAbbrev() const { return CharacterLiteralAbbrev; }
711
354k
  unsigned getIntegerLiteralAbbrev() const { return IntegerLiteralAbbrev; }
712
751k
  unsigned getExprImplicitCastAbbrev() const { return ExprImplicitCastAbbrev; }
713
714
9.64k
  bool hasChain() const { return Chain; }
715
406
  ASTReader *getChain() const { return Chain; }
716
717
private:
718
  // ASTDeserializationListener implementation
719
  void ReaderInitialized(ASTReader *Reader) override;
720
  void IdentifierRead(serialization::IdentID ID, IdentifierInfo *II) override;
721
  void MacroRead(serialization::MacroID ID, MacroInfo *MI) override;
722
  void TypeRead(serialization::TypeIdx Idx, QualType T) override;
723
  void SelectorRead(serialization::SelectorID ID, Selector Sel) override;
724
  void MacroDefinitionRead(serialization::PreprocessedEntityID ID,
725
                           MacroDefinitionRecord *MD) override;
726
  void ModuleRead(serialization::SubmoduleID ID, Module *Mod) override;
727
728
  // ASTMutationListener implementation.
729
  void CompletedTagDefinition(const TagDecl *D) override;
730
  void AddedVisibleDecl(const DeclContext *DC, const Decl *D) override;
731
  void AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) override;
732
  void AddedCXXTemplateSpecialization(
733
      const ClassTemplateDecl *TD,
734
      const ClassTemplateSpecializationDecl *D) override;
735
  void AddedCXXTemplateSpecialization(
736
      const VarTemplateDecl *TD,
737
      const VarTemplateSpecializationDecl *D) override;
738
  void AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
739
                                      const FunctionDecl *D) override;
740
  void ResolvedExceptionSpec(const FunctionDecl *FD) override;
741
  void DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) override;
742
  void ResolvedOperatorDelete(const CXXDestructorDecl *DD,
743
                              const FunctionDecl *Delete,
744
                              Expr *ThisArg) override;
745
  void CompletedImplicitDefinition(const FunctionDecl *D) override;
746
  void InstantiationRequested(const ValueDecl *D) override;
747
  void VariableDefinitionInstantiated(const VarDecl *D) override;
748
  void FunctionDefinitionInstantiated(const FunctionDecl *D) override;
749
  void DefaultArgumentInstantiated(const ParmVarDecl *D) override;
750
  void DefaultMemberInitializerInstantiated(const FieldDecl *D) override;
751
  void AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
752
                                    const ObjCInterfaceDecl *IFD) override;
753
  void DeclarationMarkedUsed(const Decl *D) override;
754
  void DeclarationMarkedOpenMPThreadPrivate(const Decl *D) override;
755
  void DeclarationMarkedOpenMPDeclareTarget(const Decl *D,
756
                                            const Attr *Attr) override;
757
  void DeclarationMarkedOpenMPAllocate(const Decl *D, const Attr *A) override;
758
  void RedefinedHiddenDefinition(const NamedDecl *D, Module *M) override;
759
  void AddedAttributeToRecord(const Attr *Attr,
760
                              const RecordDecl *Record) override;
761
};
762
763
/// AST and semantic-analysis consumer that generates a
764
/// precompiled header from the parsed source code.
765
class PCHGenerator : public SemaConsumer {
766
  const Preprocessor &PP;
767
  std::string OutputFile;
768
  std::string isysroot;
769
  Sema *SemaPtr;
770
  std::shared_ptr<PCHBuffer> Buffer;
771
  llvm::BitstreamWriter Stream;
772
  ASTWriter Writer;
773
  bool AllowASTWithErrors;
774
  bool ShouldCacheASTInMemory;
775
776
protected:
777
90
  ASTWriter &getWriter() { return Writer; }
778
0
  const ASTWriter &getWriter() const { return Writer; }
779
180
  SmallVectorImpl<char> &getPCH() const { return Buffer->Data; }
780
781
public:
782
  PCHGenerator(const Preprocessor &PP, InMemoryModuleCache &ModuleCache,
783
               StringRef OutputFile, StringRef isysroot,
784
               std::shared_ptr<PCHBuffer> Buffer,
785
               ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
786
               bool AllowASTWithErrors = false, bool IncludeTimestamps = true,
787
               bool ShouldCacheASTInMemory = false);
788
  ~PCHGenerator() override;
789
790
5.25k
  void InitializeSema(Sema &S) override { SemaPtr = &S; }
791
  void HandleTranslationUnit(ASTContext &Ctx) override;
792
  ASTMutationListener *GetASTMutationListener() override;
793
  ASTDeserializationListener *GetASTDeserializationListener() override;
794
90
  bool hasEmittedPCH() const { return Buffer->IsComplete; }
795
};
796
797
} // namespace clang
798
799
#endif // LLVM_CLANG_SERIALIZATION_ASTWRITER_H