1//===- ASTWriter.cpp - AST File Writer ------------------------------------===//
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 AST files.
10//
11//===----------------------------------------------------------------------===//
12
13#include "ASTCommon.h"
14#include "ASTReaderInternals.h"
15#include "MultiOnDiskHashTable.h"
16#include "TemplateArgumentHasher.h"
17#include "clang/AST/ASTContext.h"
18#include "clang/AST/ASTUnresolvedSet.h"
19#include "clang/AST/AbstractTypeWriter.h"
20#include "clang/AST/Attr.h"
21#include "clang/AST/Decl.h"
22#include "clang/AST/DeclBase.h"
23#include "clang/AST/DeclCXX.h"
24#include "clang/AST/DeclContextInternals.h"
25#include "clang/AST/DeclFriend.h"
26#include "clang/AST/DeclObjC.h"
27#include "clang/AST/DeclTemplate.h"
28#include "clang/AST/DeclarationName.h"
29#include "clang/AST/Expr.h"
30#include "clang/AST/ExprCXX.h"
31#include "clang/AST/LambdaCapture.h"
32#include "clang/AST/NestedNameSpecifier.h"
33#include "clang/AST/OpenACCClause.h"
34#include "clang/AST/OpenMPClause.h"
35#include "clang/AST/RawCommentList.h"
36#include "clang/AST/TemplateName.h"
37#include "clang/AST/Type.h"
38#include "clang/AST/TypeLoc.h"
39#include "clang/AST/TypeLocVisitor.h"
40#include "clang/Basic/Diagnostic.h"
41#include "clang/Basic/DiagnosticOptions.h"
42#include "clang/Basic/FileEntry.h"
43#include "clang/Basic/FileManager.h"
44#include "clang/Basic/FileSystemOptions.h"
45#include "clang/Basic/IdentifierTable.h"
46#include "clang/Basic/LLVM.h"
47#include "clang/Basic/Lambda.h"
48#include "clang/Basic/LangOptions.h"
49#include "clang/Basic/Module.h"
50#include "clang/Basic/ObjCRuntime.h"
51#include "clang/Basic/OpenACCKinds.h"
52#include "clang/Basic/OpenCLOptions.h"
53#include "clang/Basic/SourceLocation.h"
54#include "clang/Basic/SourceManager.h"
55#include "clang/Basic/SourceManagerInternals.h"
56#include "clang/Basic/Specifiers.h"
57#include "clang/Basic/TargetInfo.h"
58#include "clang/Basic/TargetOptions.h"
59#include "clang/Basic/Version.h"
60#include "clang/Lex/HeaderSearch.h"
61#include "clang/Lex/HeaderSearchOptions.h"
62#include "clang/Lex/MacroInfo.h"
63#include "clang/Lex/ModuleMap.h"
64#include "clang/Lex/PreprocessingRecord.h"
65#include "clang/Lex/Preprocessor.h"
66#include "clang/Lex/PreprocessorOptions.h"
67#include "clang/Lex/Token.h"
68#include "clang/Sema/IdentifierResolver.h"
69#include "clang/Sema/ObjCMethodList.h"
70#include "clang/Sema/Sema.h"
71#include "clang/Sema/SemaCUDA.h"
72#include "clang/Sema/SemaObjC.h"
73#include "clang/Sema/Weak.h"
74#include "clang/Serialization/ASTBitCodes.h"
75#include "clang/Serialization/ASTReader.h"
76#include "clang/Serialization/ASTRecordWriter.h"
77#include "clang/Serialization/InMemoryModuleCache.h"
78#include "clang/Serialization/ModuleCache.h"
79#include "clang/Serialization/ModuleFile.h"
80#include "clang/Serialization/ModuleFileExtension.h"
81#include "clang/Serialization/SerializationDiagnostic.h"
82#include "llvm/ADT/APFloat.h"
83#include "llvm/ADT/APInt.h"
84#include "llvm/ADT/ArrayRef.h"
85#include "llvm/ADT/DenseMap.h"
86#include "llvm/ADT/DenseSet.h"
87#include "llvm/ADT/PointerIntPair.h"
88#include "llvm/ADT/STLExtras.h"
89#include "llvm/ADT/ScopeExit.h"
90#include "llvm/ADT/SmallPtrSet.h"
91#include "llvm/ADT/SmallString.h"
92#include "llvm/ADT/SmallVector.h"
93#include "llvm/ADT/StringRef.h"
94#include "llvm/Bitstream/BitCodes.h"
95#include "llvm/Bitstream/BitstreamWriter.h"
96#include "llvm/Support/Compression.h"
97#include "llvm/Support/DJB.h"
98#include "llvm/Support/EndianStream.h"
99#include "llvm/Support/ErrorHandling.h"
100#include "llvm/Support/LEB128.h"
101#include "llvm/Support/MemoryBuffer.h"
102#include "llvm/Support/OnDiskHashTable.h"
103#include "llvm/Support/Path.h"
104#include "llvm/Support/SHA1.h"
105#include "llvm/Support/TimeProfiler.h"
106#include "llvm/Support/VersionTuple.h"
107#include "llvm/Support/raw_ostream.h"
108#include <algorithm>
109#include <cassert>
110#include <cstdint>
111#include <cstdlib>
112#include <cstring>
113#include <ctime>
114#include <limits>
115#include <memory>
116#include <optional>
117#include <queue>
118#include <tuple>
119#include <utility>
120#include <vector>
121
122using namespace clang;
123using namespace clang::serialization;
124
125template <typename T, typename Allocator>
126static StringRef bytes(const std::vector<T, Allocator> &v) {
127 if (v.empty()) return StringRef();
128 return StringRef(reinterpret_cast<const char*>(&v[0]),
129 sizeof(T) * v.size());
130}
131
132template <typename T>
133static StringRef bytes(const SmallVectorImpl<T> &v) {
134 return StringRef(reinterpret_cast<const char*>(v.data()),
135 sizeof(T) * v.size());
136}
137
138static std::string bytes(const std::vector<bool> &V) {
139 std::string Str;
140 Str.reserve(res_arg: V.size() / 8);
141 for (unsigned I = 0, E = V.size(); I < E;) {
142 char Byte = 0;
143 for (unsigned Bit = 0; Bit < 8 && I < E; ++Bit, ++I)
144 Byte |= V[I] << Bit;
145 Str += Byte;
146 }
147 return Str;
148}
149
150//===----------------------------------------------------------------------===//
151// Type serialization
152//===----------------------------------------------------------------------===//
153
154static TypeCode getTypeCodeForTypeClass(Type::TypeClass id) {
155 switch (id) {
156#define TYPE_BIT_CODE(CLASS_ID, CODE_ID, CODE_VALUE) \
157 case Type::CLASS_ID: return TYPE_##CODE_ID;
158#include "clang/Serialization/TypeBitCodes.def"
159 case Type::Builtin:
160 llvm_unreachable("shouldn't be serializing a builtin type this way");
161 }
162 llvm_unreachable("bad type kind");
163}
164
165namespace {
166
167struct AffectingModuleMaps {
168 llvm::DenseSet<FileID> DefinitionFileIDs;
169 llvm::DenseSet<const FileEntry *> DefinitionFiles;
170};
171
172std::optional<AffectingModuleMaps>
173GetAffectingModuleMaps(const Preprocessor &PP, Module *RootModule) {
174 if (!PP.getHeaderSearchInfo()
175 .getHeaderSearchOpts()
176 .ModulesPruneNonAffectingModuleMaps)
177 return std::nullopt;
178
179 const HeaderSearch &HS = PP.getHeaderSearchInfo();
180 const SourceManager &SM = PP.getSourceManager();
181 const ModuleMap &MM = HS.getModuleMap();
182
183 // Module maps used only by textual headers are special. Their FileID is
184 // non-affecting, but their FileEntry is (i.e. must be written as InputFile).
185 enum AffectedReason : bool {
186 AR_TextualHeader = 0,
187 AR_ImportOrTextualHeader = 1,
188 };
189 auto AssignMostImportant = [](AffectedReason &LHS, AffectedReason RHS) {
190 LHS = std::max(a: LHS, b: RHS);
191 };
192 llvm::DenseMap<FileID, AffectedReason> ModuleMaps;
193 llvm::DenseMap<const Module *, AffectedReason> ProcessedModules;
194 auto CollectModuleMapsForHierarchy = [&](const Module *M,
195 AffectedReason Reason) {
196 M = M->getTopLevelModule();
197
198 // We need to process the header either when it was not present or when we
199 // previously flagged module map as textual headers and now we found a
200 // proper import.
201 if (auto [It, Inserted] = ProcessedModules.insert(KV: {M, Reason});
202 !Inserted && Reason <= It->second) {
203 return;
204 } else {
205 It->second = Reason;
206 }
207
208 std::queue<const Module *> Q;
209 Q.push(x: M);
210 while (!Q.empty()) {
211 const Module *Mod = Q.front();
212 Q.pop();
213
214 // The containing module map is affecting, because it's being pointed
215 // into by Module::DefinitionLoc.
216 if (auto F = MM.getContainingModuleMapFileID(Module: Mod); F.isValid())
217 AssignMostImportant(ModuleMaps[F], Reason);
218 // For inferred modules, the module map that allowed inferring is not
219 // related to the virtual containing module map file. It did affect the
220 // compilation, though.
221 if (auto UniqF = MM.getModuleMapFileIDForUniquing(M: Mod); UniqF.isValid())
222 AssignMostImportant(ModuleMaps[UniqF], Reason);
223
224 for (auto *SubM : Mod->submodules())
225 Q.push(x: SubM);
226 }
227 };
228
229 // Handle all the affecting modules referenced from the root module.
230
231 CollectModuleMapsForHierarchy(RootModule, AR_ImportOrTextualHeader);
232
233 std::queue<const Module *> Q;
234 Q.push(x: RootModule);
235 while (!Q.empty()) {
236 const Module *CurrentModule = Q.front();
237 Q.pop();
238
239 for (const Module *ImportedModule : CurrentModule->Imports)
240 CollectModuleMapsForHierarchy(ImportedModule, AR_ImportOrTextualHeader);
241 for (const Module *UndeclaredModule : CurrentModule->UndeclaredUses)
242 CollectModuleMapsForHierarchy(UndeclaredModule, AR_ImportOrTextualHeader);
243
244 for (auto *M : CurrentModule->submodules())
245 Q.push(x: M);
246 }
247
248 // Handle textually-included headers that belong to other modules.
249
250 SmallVector<OptionalFileEntryRef, 16> FilesByUID;
251 HS.getFileMgr().GetUniqueIDMapping(UIDToFiles&: FilesByUID);
252
253 if (FilesByUID.size() > HS.header_file_size())
254 FilesByUID.resize(N: HS.header_file_size());
255
256 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
257 OptionalFileEntryRef File = FilesByUID[UID];
258 if (!File)
259 continue;
260
261 const HeaderFileInfo *HFI = HS.getExistingLocalFileInfo(FE: *File);
262 if (!HFI)
263 continue; // We have no information on this being a header file.
264 if (!HFI->isCompilingModuleHeader && HFI->isModuleHeader)
265 continue; // Modular header, handled in the above module-based loop.
266 if (!HFI->isCompilingModuleHeader && !HFI->IsLocallyIncluded)
267 continue; // Non-modular header not included locally is not affecting.
268
269 for (const auto &KH : HS.findResolvedModulesForHeader(File: *File))
270 if (const Module *M = KH.getModule())
271 CollectModuleMapsForHierarchy(M, AR_TextualHeader);
272 }
273
274 // FIXME: This algorithm is not correct for module map hierarchies where
275 // module map file defining a (sub)module of a top-level module X includes
276 // a module map file that defines a (sub)module of another top-level module Y.
277 // Whenever X is affecting and Y is not, "replaying" this PCM file will fail
278 // when parsing module map files for X due to not knowing about the `extern`
279 // module map for Y.
280 //
281 // We don't have a good way to fix it here. We could mark all children of
282 // affecting module map files as being affecting as well, but that's
283 // expensive. SourceManager does not model the edge from parent to child
284 // SLocEntries, so instead, we would need to iterate over leaf module map
285 // files, walk up their include hierarchy and check whether we arrive at an
286 // affecting module map.
287 //
288 // Instead of complicating and slowing down this function, we should probably
289 // just ban module map hierarchies where module map defining a (sub)module X
290 // includes a module map defining a module that's not a submodule of X.
291
292 llvm::DenseSet<const FileEntry *> ModuleFileEntries;
293 llvm::DenseSet<FileID> ModuleFileIDs;
294 for (auto [FID, Reason] : ModuleMaps) {
295 if (Reason == AR_ImportOrTextualHeader)
296 ModuleFileIDs.insert(V: FID);
297 if (auto *FE = SM.getFileEntryForID(FID))
298 ModuleFileEntries.insert(V: FE);
299 }
300
301 AffectingModuleMaps R;
302 R.DefinitionFileIDs = std::move(ModuleFileIDs);
303 R.DefinitionFiles = std::move(ModuleFileEntries);
304 return std::move(R);
305}
306
307class ASTTypeWriter {
308 ASTWriter &Writer;
309 ASTWriter::RecordData Record;
310 ASTRecordWriter BasicWriter;
311
312public:
313 ASTTypeWriter(ASTContext &Context, ASTWriter &Writer)
314 : Writer(Writer), BasicWriter(Context, Writer, Record) {}
315
316 uint64_t write(QualType T) {
317 if (T.hasLocalNonFastQualifiers()) {
318 Qualifiers Qs = T.getLocalQualifiers();
319 BasicWriter.writeQualType(T: T.getLocalUnqualifiedType());
320 BasicWriter.writeQualifiers(value: Qs);
321 return BasicWriter.Emit(Code: TYPE_EXT_QUAL, Abbrev: Writer.getTypeExtQualAbbrev());
322 }
323
324 const Type *typePtr = T.getTypePtr();
325 serialization::AbstractTypeWriter<ASTRecordWriter> atw(BasicWriter);
326 atw.write(node: typePtr);
327 return BasicWriter.Emit(Code: getTypeCodeForTypeClass(id: typePtr->getTypeClass()),
328 /*abbrev*/ Abbrev: 0);
329 }
330};
331
332class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> {
333 ASTRecordWriter &Record;
334
335 void addSourceLocation(SourceLocation Loc) { Record.AddSourceLocation(Loc); }
336 void addSourceRange(SourceRange Range) { Record.AddSourceRange(Range); }
337
338public:
339 TypeLocWriter(ASTRecordWriter &Record) : Record(Record) {}
340
341#define ABSTRACT_TYPELOC(CLASS, PARENT)
342#define TYPELOC(CLASS, PARENT) \
343 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
344#include "clang/AST/TypeLocNodes.def"
345
346 void VisitArrayTypeLoc(ArrayTypeLoc TyLoc);
347 void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc);
348 void VisitTagTypeLoc(TagTypeLoc TL);
349};
350
351} // namespace
352
353void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
354 // nothing to do
355}
356
357void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
358 addSourceLocation(Loc: TL.getBuiltinLoc());
359 if (TL.needsExtraLocalData()) {
360 Record.push_back(N: TL.getWrittenTypeSpec());
361 Record.push_back(N: static_cast<uint64_t>(TL.getWrittenSignSpec()));
362 Record.push_back(N: static_cast<uint64_t>(TL.getWrittenWidthSpec()));
363 Record.push_back(N: TL.hasModeAttr());
364 }
365}
366
367void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
368 addSourceLocation(Loc: TL.getNameLoc());
369}
370
371void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) {
372 addSourceLocation(Loc: TL.getStarLoc());
373}
374
375void TypeLocWriter::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
376 // nothing to do
377}
378
379void TypeLocWriter::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
380 // nothing to do
381}
382
383void TypeLocWriter::VisitArrayParameterTypeLoc(ArrayParameterTypeLoc TL) {
384 // nothing to do
385}
386
387void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
388 addSourceLocation(Loc: TL.getCaretLoc());
389}
390
391void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
392 addSourceLocation(Loc: TL.getAmpLoc());
393}
394
395void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
396 addSourceLocation(Loc: TL.getAmpAmpLoc());
397}
398
399void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
400 addSourceLocation(Loc: TL.getStarLoc());
401 Record.AddNestedNameSpecifierLoc(NNS: TL.getQualifierLoc());
402}
403
404void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) {
405 addSourceLocation(Loc: TL.getLBracketLoc());
406 addSourceLocation(Loc: TL.getRBracketLoc());
407 Record.push_back(N: TL.getSizeExpr() ? 1 : 0);
408 if (TL.getSizeExpr())
409 Record.AddStmt(S: TL.getSizeExpr());
410}
411
412void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
413 VisitArrayTypeLoc(TL);
414}
415
416void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
417 VisitArrayTypeLoc(TL);
418}
419
420void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
421 VisitArrayTypeLoc(TL);
422}
423
424void TypeLocWriter::VisitDependentSizedArrayTypeLoc(
425 DependentSizedArrayTypeLoc TL) {
426 VisitArrayTypeLoc(TL);
427}
428
429void TypeLocWriter::VisitDependentAddressSpaceTypeLoc(
430 DependentAddressSpaceTypeLoc TL) {
431 addSourceLocation(Loc: TL.getAttrNameLoc());
432 SourceRange range = TL.getAttrOperandParensRange();
433 addSourceLocation(Loc: range.getBegin());
434 addSourceLocation(Loc: range.getEnd());
435 Record.AddStmt(S: TL.getAttrExprOperand());
436}
437
438void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc(
439 DependentSizedExtVectorTypeLoc TL) {
440 addSourceLocation(Loc: TL.getNameLoc());
441}
442
443void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) {
444 addSourceLocation(Loc: TL.getNameLoc());
445}
446
447void TypeLocWriter::VisitDependentVectorTypeLoc(
448 DependentVectorTypeLoc TL) {
449 addSourceLocation(Loc: TL.getNameLoc());
450}
451
452void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
453 addSourceLocation(Loc: TL.getNameLoc());
454}
455
456void TypeLocWriter::VisitConstantMatrixTypeLoc(ConstantMatrixTypeLoc TL) {
457 addSourceLocation(Loc: TL.getAttrNameLoc());
458 SourceRange range = TL.getAttrOperandParensRange();
459 addSourceLocation(Loc: range.getBegin());
460 addSourceLocation(Loc: range.getEnd());
461 Record.AddStmt(S: TL.getAttrRowOperand());
462 Record.AddStmt(S: TL.getAttrColumnOperand());
463}
464
465void TypeLocWriter::VisitDependentSizedMatrixTypeLoc(
466 DependentSizedMatrixTypeLoc TL) {
467 addSourceLocation(Loc: TL.getAttrNameLoc());
468 SourceRange range = TL.getAttrOperandParensRange();
469 addSourceLocation(Loc: range.getBegin());
470 addSourceLocation(Loc: range.getEnd());
471 Record.AddStmt(S: TL.getAttrRowOperand());
472 Record.AddStmt(S: TL.getAttrColumnOperand());
473}
474
475void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
476 addSourceLocation(Loc: TL.getLocalRangeBegin());
477 addSourceLocation(Loc: TL.getLParenLoc());
478 addSourceLocation(Loc: TL.getRParenLoc());
479 addSourceRange(Range: TL.getExceptionSpecRange());
480 addSourceLocation(Loc: TL.getLocalRangeEnd());
481 for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i)
482 Record.AddDeclRef(D: TL.getParam(i));
483}
484
485void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
486 VisitFunctionTypeLoc(TL);
487}
488
489void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
490 VisitFunctionTypeLoc(TL);
491}
492
493void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
494 addSourceLocation(Loc: TL.getElaboratedKeywordLoc());
495 Record.AddNestedNameSpecifierLoc(NNS: TL.getQualifierLoc());
496 addSourceLocation(Loc: TL.getNameLoc());
497}
498
499void TypeLocWriter::VisitUsingTypeLoc(UsingTypeLoc TL) {
500 addSourceLocation(Loc: TL.getElaboratedKeywordLoc());
501 Record.AddNestedNameSpecifierLoc(NNS: TL.getQualifierLoc());
502 addSourceLocation(Loc: TL.getNameLoc());
503}
504
505void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
506 addSourceLocation(Loc: TL.getElaboratedKeywordLoc());
507 Record.AddNestedNameSpecifierLoc(NNS: TL.getQualifierLoc());
508 addSourceLocation(Loc: TL.getNameLoc());
509}
510
511void TypeLocWriter::VisitObjCTypeParamTypeLoc(ObjCTypeParamTypeLoc TL) {
512 if (TL.getNumProtocols()) {
513 addSourceLocation(Loc: TL.getProtocolLAngleLoc());
514 addSourceLocation(Loc: TL.getProtocolRAngleLoc());
515 }
516 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
517 addSourceLocation(Loc: TL.getProtocolLoc(i));
518}
519
520void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
521 addSourceLocation(Loc: TL.getTypeofLoc());
522 addSourceLocation(Loc: TL.getLParenLoc());
523 addSourceLocation(Loc: TL.getRParenLoc());
524}
525
526void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
527 addSourceLocation(Loc: TL.getTypeofLoc());
528 addSourceLocation(Loc: TL.getLParenLoc());
529 addSourceLocation(Loc: TL.getRParenLoc());
530 Record.AddTypeSourceInfo(TInfo: TL.getUnmodifiedTInfo());
531}
532
533void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
534 addSourceLocation(Loc: TL.getDecltypeLoc());
535 addSourceLocation(Loc: TL.getRParenLoc());
536}
537
538void TypeLocWriter::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
539 addSourceLocation(Loc: TL.getKWLoc());
540 addSourceLocation(Loc: TL.getLParenLoc());
541 addSourceLocation(Loc: TL.getRParenLoc());
542 Record.AddTypeSourceInfo(TInfo: TL.getUnderlyingTInfo());
543}
544
545void ASTRecordWriter::AddConceptReference(const ConceptReference *CR) {
546 assert(CR);
547 AddNestedNameSpecifierLoc(NNS: CR->getNestedNameSpecifierLoc());
548 AddSourceLocation(Loc: CR->getTemplateKWLoc());
549 AddDeclarationNameInfo(NameInfo: CR->getConceptNameInfo());
550 AddDeclRef(D: CR->getFoundDecl());
551 AddDeclRef(D: CR->getNamedConcept());
552 push_back(N: CR->getTemplateArgsAsWritten() != nullptr);
553 if (CR->getTemplateArgsAsWritten())
554 AddASTTemplateArgumentListInfo(ASTTemplArgList: CR->getTemplateArgsAsWritten());
555}
556
557void TypeLocWriter::VisitPackIndexingTypeLoc(PackIndexingTypeLoc TL) {
558 addSourceLocation(Loc: TL.getEllipsisLoc());
559}
560
561void TypeLocWriter::VisitAutoTypeLoc(AutoTypeLoc TL) {
562 addSourceLocation(Loc: TL.getNameLoc());
563 auto *CR = TL.getConceptReference();
564 Record.push_back(N: TL.isConstrained() && CR);
565 if (TL.isConstrained() && CR)
566 Record.AddConceptReference(CR);
567 Record.push_back(N: TL.isDecltypeAuto());
568 if (TL.isDecltypeAuto())
569 addSourceLocation(Loc: TL.getRParenLoc());
570}
571
572void TypeLocWriter::VisitDeducedTemplateSpecializationTypeLoc(
573 DeducedTemplateSpecializationTypeLoc TL) {
574 addSourceLocation(Loc: TL.getElaboratedKeywordLoc());
575 Record.AddNestedNameSpecifierLoc(NNS: TL.getQualifierLoc());
576 addSourceLocation(Loc: TL.getTemplateNameLoc());
577}
578
579void TypeLocWriter::VisitTagTypeLoc(TagTypeLoc TL) {
580 addSourceLocation(Loc: TL.getElaboratedKeywordLoc());
581 Record.AddNestedNameSpecifierLoc(NNS: TL.getQualifierLoc());
582 addSourceLocation(Loc: TL.getNameLoc());
583}
584
585void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) {
586 VisitTagTypeLoc(TL);
587}
588
589void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
590 VisitTagTypeLoc(TL);
591}
592
593void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) { VisitTagTypeLoc(TL); }
594
595void TypeLocWriter::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
596 Record.AddAttr(A: TL.getAttr());
597}
598
599void TypeLocWriter::VisitCountAttributedTypeLoc(CountAttributedTypeLoc TL) {
600 // Nothing to do
601}
602
603void TypeLocWriter::VisitBTFTagAttributedTypeLoc(BTFTagAttributedTypeLoc TL) {
604 // Nothing to do.
605}
606
607void TypeLocWriter::VisitOverflowBehaviorTypeLoc(OverflowBehaviorTypeLoc TL) {
608 addSourceLocation(Loc: TL.getAttrLoc());
609}
610
611void TypeLocWriter::VisitHLSLAttributedResourceTypeLoc(
612 HLSLAttributedResourceTypeLoc TL) {
613 // Nothing to do.
614}
615
616void TypeLocWriter::VisitHLSLInlineSpirvTypeLoc(HLSLInlineSpirvTypeLoc TL) {
617 // Nothing to do.
618}
619
620void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
621 addSourceLocation(Loc: TL.getNameLoc());
622}
623
624void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
625 SubstTemplateTypeParmTypeLoc TL) {
626 addSourceLocation(Loc: TL.getNameLoc());
627}
628
629void TypeLocWriter::VisitSubstTemplateTypeParmPackTypeLoc(
630 SubstTemplateTypeParmPackTypeLoc TL) {
631 addSourceLocation(Loc: TL.getNameLoc());
632}
633
634void TypeLocWriter::VisitSubstBuiltinTemplatePackTypeLoc(
635 SubstBuiltinTemplatePackTypeLoc TL) {
636 addSourceLocation(Loc: TL.getNameLoc());
637}
638
639void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
640 TemplateSpecializationTypeLoc TL) {
641 addSourceLocation(Loc: TL.getElaboratedKeywordLoc());
642 Record.AddNestedNameSpecifierLoc(NNS: TL.getQualifierLoc());
643 addSourceLocation(Loc: TL.getTemplateKeywordLoc());
644 addSourceLocation(Loc: TL.getTemplateNameLoc());
645 addSourceLocation(Loc: TL.getLAngleLoc());
646 addSourceLocation(Loc: TL.getRAngleLoc());
647 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
648 Record.AddTemplateArgumentLocInfo(Arg: TL.getArgLoc(i));
649}
650
651void TypeLocWriter::VisitParenTypeLoc(ParenTypeLoc TL) {
652 addSourceLocation(Loc: TL.getLParenLoc());
653 addSourceLocation(Loc: TL.getRParenLoc());
654}
655
656void TypeLocWriter::VisitMacroQualifiedTypeLoc(MacroQualifiedTypeLoc TL) {
657 addSourceLocation(Loc: TL.getExpansionLoc());
658}
659
660void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
661 addSourceLocation(Loc: TL.getElaboratedKeywordLoc());
662 Record.AddNestedNameSpecifierLoc(NNS: TL.getQualifierLoc());
663 addSourceLocation(Loc: TL.getNameLoc());
664}
665
666void TypeLocWriter::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
667 addSourceLocation(Loc: TL.getEllipsisLoc());
668}
669
670void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
671 addSourceLocation(Loc: TL.getNameLoc());
672 addSourceLocation(Loc: TL.getNameEndLoc());
673}
674
675void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
676 Record.push_back(N: TL.hasBaseTypeAsWritten());
677 addSourceLocation(Loc: TL.getTypeArgsLAngleLoc());
678 addSourceLocation(Loc: TL.getTypeArgsRAngleLoc());
679 for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
680 Record.AddTypeSourceInfo(TInfo: TL.getTypeArgTInfo(i));
681 addSourceLocation(Loc: TL.getProtocolLAngleLoc());
682 addSourceLocation(Loc: TL.getProtocolRAngleLoc());
683 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
684 addSourceLocation(Loc: TL.getProtocolLoc(i));
685}
686
687void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
688 addSourceLocation(Loc: TL.getStarLoc());
689}
690
691void TypeLocWriter::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
692 addSourceLocation(Loc: TL.getKWLoc());
693 addSourceLocation(Loc: TL.getLParenLoc());
694 addSourceLocation(Loc: TL.getRParenLoc());
695}
696
697void TypeLocWriter::VisitPipeTypeLoc(PipeTypeLoc TL) {
698 addSourceLocation(Loc: TL.getKWLoc());
699}
700void TypeLocWriter::VisitBitIntTypeLoc(clang::BitIntTypeLoc TL) {
701 addSourceLocation(Loc: TL.getNameLoc());
702}
703void TypeLocWriter::VisitDependentBitIntTypeLoc(
704 clang::DependentBitIntTypeLoc TL) {
705 addSourceLocation(Loc: TL.getNameLoc());
706}
707
708void TypeLocWriter::VisitPredefinedSugarTypeLoc(
709 clang::PredefinedSugarTypeLoc TL) {
710 // Nothing to do.
711}
712
713void ASTWriter::WriteTypeAbbrevs() {
714 using namespace llvm;
715
716 std::shared_ptr<BitCodeAbbrev> Abv;
717
718 // Abbreviation for TYPE_EXT_QUAL
719 Abv = std::make_shared<BitCodeAbbrev>();
720 Abv->Add(OpInfo: BitCodeAbbrevOp(serialization::TYPE_EXT_QUAL));
721 Abv->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
722 Abv->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 3)); // Quals
723 TypeExtQualAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abv));
724}
725
726//===----------------------------------------------------------------------===//
727// ASTWriter Implementation
728//===----------------------------------------------------------------------===//
729
730static void EmitBlockID(unsigned ID, const char *Name,
731 llvm::BitstreamWriter &Stream,
732 ASTWriter::RecordDataImpl &Record) {
733 Record.clear();
734 Record.push_back(Elt: ID);
735 Stream.EmitRecord(Code: llvm::bitc::BLOCKINFO_CODE_SETBID, Vals: Record);
736
737 // Emit the block name if present.
738 if (!Name || Name[0] == 0)
739 return;
740 Record.clear();
741 while (*Name)
742 Record.push_back(Elt: *Name++);
743 Stream.EmitRecord(Code: llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Vals: Record);
744}
745
746static void EmitRecordID(unsigned ID, const char *Name,
747 llvm::BitstreamWriter &Stream,
748 ASTWriter::RecordDataImpl &Record) {
749 Record.clear();
750 Record.push_back(Elt: ID);
751 while (*Name)
752 Record.push_back(Elt: *Name++);
753 Stream.EmitRecord(Code: llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Vals: Record);
754}
755
756static void AddStmtsExprs(llvm::BitstreamWriter &Stream,
757 ASTWriter::RecordDataImpl &Record) {
758#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
759 RECORD(STMT_STOP);
760 RECORD(STMT_NULL_PTR);
761 RECORD(STMT_REF_PTR);
762 RECORD(STMT_NULL);
763 RECORD(STMT_COMPOUND);
764 RECORD(STMT_CASE);
765 RECORD(STMT_DEFAULT);
766 RECORD(STMT_LABEL);
767 RECORD(STMT_ATTRIBUTED);
768 RECORD(STMT_IF);
769 RECORD(STMT_SWITCH);
770 RECORD(STMT_WHILE);
771 RECORD(STMT_DO);
772 RECORD(STMT_FOR);
773 RECORD(STMT_GOTO);
774 RECORD(STMT_INDIRECT_GOTO);
775 RECORD(STMT_CONTINUE);
776 RECORD(STMT_BREAK);
777 RECORD(STMT_RETURN);
778 RECORD(STMT_DECL);
779 RECORD(STMT_GCCASM);
780 RECORD(STMT_MSASM);
781 RECORD(EXPR_PREDEFINED);
782 RECORD(EXPR_DECL_REF);
783 RECORD(EXPR_INTEGER_LITERAL);
784 RECORD(EXPR_FIXEDPOINT_LITERAL);
785 RECORD(EXPR_FLOATING_LITERAL);
786 RECORD(EXPR_IMAGINARY_LITERAL);
787 RECORD(EXPR_STRING_LITERAL);
788 RECORD(EXPR_CHARACTER_LITERAL);
789 RECORD(EXPR_PAREN);
790 RECORD(EXPR_PAREN_LIST);
791 RECORD(EXPR_UNARY_OPERATOR);
792 RECORD(EXPR_SIZEOF_ALIGN_OF);
793 RECORD(EXPR_ARRAY_SUBSCRIPT);
794 RECORD(EXPR_CALL);
795 RECORD(EXPR_MEMBER);
796 RECORD(EXPR_BINARY_OPERATOR);
797 RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR);
798 RECORD(EXPR_CONDITIONAL_OPERATOR);
799 RECORD(EXPR_IMPLICIT_CAST);
800 RECORD(EXPR_CSTYLE_CAST);
801 RECORD(EXPR_COMPOUND_LITERAL);
802 RECORD(EXPR_EXT_VECTOR_ELEMENT);
803 RECORD(EXPR_INIT_LIST);
804 RECORD(EXPR_DESIGNATED_INIT);
805 RECORD(EXPR_DESIGNATED_INIT_UPDATE);
806 RECORD(EXPR_IMPLICIT_VALUE_INIT);
807 RECORD(EXPR_NO_INIT);
808 RECORD(EXPR_VA_ARG);
809 RECORD(EXPR_ADDR_LABEL);
810 RECORD(EXPR_STMT);
811 RECORD(EXPR_CHOOSE);
812 RECORD(EXPR_GNU_NULL);
813 RECORD(EXPR_SHUFFLE_VECTOR);
814 RECORD(EXPR_BLOCK);
815 RECORD(EXPR_GENERIC_SELECTION);
816 RECORD(EXPR_OBJC_STRING_LITERAL);
817 RECORD(EXPR_OBJC_BOXED_EXPRESSION);
818 RECORD(EXPR_OBJC_ARRAY_LITERAL);
819 RECORD(EXPR_OBJC_DICTIONARY_LITERAL);
820 RECORD(EXPR_OBJC_ENCODE);
821 RECORD(EXPR_OBJC_SELECTOR_EXPR);
822 RECORD(EXPR_OBJC_PROTOCOL_EXPR);
823 RECORD(EXPR_OBJC_IVAR_REF_EXPR);
824 RECORD(EXPR_OBJC_PROPERTY_REF_EXPR);
825 RECORD(EXPR_OBJC_KVC_REF_EXPR);
826 RECORD(EXPR_OBJC_MESSAGE_EXPR);
827 RECORD(STMT_OBJC_FOR_COLLECTION);
828 RECORD(STMT_OBJC_CATCH);
829 RECORD(STMT_OBJC_FINALLY);
830 RECORD(STMT_OBJC_AT_TRY);
831 RECORD(STMT_OBJC_AT_SYNCHRONIZED);
832 RECORD(STMT_OBJC_AT_THROW);
833 RECORD(EXPR_OBJC_BOOL_LITERAL);
834 RECORD(STMT_CXX_CATCH);
835 RECORD(STMT_CXX_TRY);
836 RECORD(STMT_CXX_FOR_RANGE);
837 RECORD(EXPR_CXX_OPERATOR_CALL);
838 RECORD(EXPR_CXX_MEMBER_CALL);
839 RECORD(EXPR_CXX_REWRITTEN_BINARY_OPERATOR);
840 RECORD(EXPR_CXX_CONSTRUCT);
841 RECORD(EXPR_CXX_TEMPORARY_OBJECT);
842 RECORD(EXPR_CXX_STATIC_CAST);
843 RECORD(EXPR_CXX_DYNAMIC_CAST);
844 RECORD(EXPR_CXX_REINTERPRET_CAST);
845 RECORD(EXPR_CXX_CONST_CAST);
846 RECORD(EXPR_CXX_ADDRSPACE_CAST);
847 RECORD(EXPR_CXX_FUNCTIONAL_CAST);
848 RECORD(EXPR_USER_DEFINED_LITERAL);
849 RECORD(EXPR_CXX_STD_INITIALIZER_LIST);
850 RECORD(EXPR_CXX_BOOL_LITERAL);
851 RECORD(EXPR_CXX_PAREN_LIST_INIT);
852 RECORD(EXPR_CXX_NULL_PTR_LITERAL);
853 RECORD(EXPR_CXX_TYPEID_EXPR);
854 RECORD(EXPR_CXX_TYPEID_TYPE);
855 RECORD(EXPR_CXX_THIS);
856 RECORD(EXPR_CXX_THROW);
857 RECORD(EXPR_CXX_DEFAULT_ARG);
858 RECORD(EXPR_CXX_DEFAULT_INIT);
859 RECORD(EXPR_CXX_BIND_TEMPORARY);
860 RECORD(EXPR_CXX_SCALAR_VALUE_INIT);
861 RECORD(EXPR_CXX_NEW);
862 RECORD(EXPR_CXX_DELETE);
863 RECORD(EXPR_CXX_PSEUDO_DESTRUCTOR);
864 RECORD(EXPR_EXPR_WITH_CLEANUPS);
865 RECORD(EXPR_CXX_DEPENDENT_SCOPE_MEMBER);
866 RECORD(EXPR_CXX_DEPENDENT_SCOPE_DECL_REF);
867 RECORD(EXPR_CXX_UNRESOLVED_CONSTRUCT);
868 RECORD(EXPR_CXX_UNRESOLVED_MEMBER);
869 RECORD(EXPR_CXX_UNRESOLVED_LOOKUP);
870 RECORD(EXPR_CXX_EXPRESSION_TRAIT);
871 RECORD(EXPR_CXX_NOEXCEPT);
872 RECORD(EXPR_OPAQUE_VALUE);
873 RECORD(EXPR_BINARY_CONDITIONAL_OPERATOR);
874 RECORD(EXPR_TYPE_TRAIT);
875 RECORD(EXPR_ARRAY_TYPE_TRAIT);
876 RECORD(EXPR_PACK_EXPANSION);
877 RECORD(EXPR_SIZEOF_PACK);
878 RECORD(EXPR_PACK_INDEXING);
879 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM);
880 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK);
881 RECORD(EXPR_FUNCTION_PARM_PACK);
882 RECORD(EXPR_MATERIALIZE_TEMPORARY);
883 RECORD(EXPR_CUDA_KERNEL_CALL);
884 RECORD(EXPR_CXX_UUIDOF_EXPR);
885 RECORD(EXPR_CXX_UUIDOF_TYPE);
886 RECORD(EXPR_LAMBDA);
887#undef RECORD
888}
889
890void ASTWriter::WriteBlockInfoBlock() {
891 RecordData Record;
892 Stream.EnterBlockInfoBlock();
893
894#define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record)
895#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
896
897 // Control Block.
898 BLOCK(CONTROL_BLOCK);
899 RECORD(METADATA);
900 RECORD(MODULE_NAME);
901 RECORD(MODULE_DIRECTORY);
902 RECORD(MODULE_MAP_FILE);
903 RECORD(IMPORT);
904 RECORD(ORIGINAL_FILE);
905 RECORD(ORIGINAL_FILE_ID);
906 RECORD(INPUT_FILE_OFFSETS);
907
908 BLOCK(OPTIONS_BLOCK);
909 RECORD(LANGUAGE_OPTIONS);
910 RECORD(CODEGEN_OPTIONS);
911 RECORD(TARGET_OPTIONS);
912 RECORD(FILE_SYSTEM_OPTIONS);
913 RECORD(HEADER_SEARCH_OPTIONS);
914 RECORD(PREPROCESSOR_OPTIONS);
915
916 BLOCK(INPUT_FILES_BLOCK);
917 RECORD(INPUT_FILE);
918 RECORD(INPUT_FILE_HASH);
919
920 // AST Top-Level Block.
921 BLOCK(AST_BLOCK);
922 RECORD(TYPE_OFFSET);
923 RECORD(DECL_OFFSET);
924 RECORD(IDENTIFIER_OFFSET);
925 RECORD(IDENTIFIER_TABLE);
926 RECORD(EAGERLY_DESERIALIZED_DECLS);
927 RECORD(MODULAR_CODEGEN_DECLS);
928 RECORD(SPECIAL_TYPES);
929 RECORD(STATISTICS);
930 RECORD(TENTATIVE_DEFINITIONS);
931 RECORD(SELECTOR_OFFSETS);
932 RECORD(METHOD_POOL);
933 RECORD(PP_COUNTER_VALUE);
934 RECORD(SOURCE_LOCATION_OFFSETS);
935 RECORD(EXT_VECTOR_DECLS);
936 RECORD(UNUSED_FILESCOPED_DECLS);
937 RECORD(PPD_ENTITIES_OFFSETS);
938 RECORD(VTABLE_USES);
939 RECORD(PPD_SKIPPED_RANGES);
940 RECORD(REFERENCED_SELECTOR_POOL);
941 RECORD(TU_UPDATE_LEXICAL);
942 RECORD(SEMA_DECL_REFS);
943 RECORD(WEAK_UNDECLARED_IDENTIFIERS);
944 RECORD(PENDING_IMPLICIT_INSTANTIATIONS);
945 RECORD(UPDATE_VISIBLE);
946 RECORD(DELAYED_NAMESPACE_LEXICAL_VISIBLE_RECORD);
947 RECORD(RELATED_DECLS_MAP);
948 RECORD(DECL_UPDATE_OFFSETS);
949 RECORD(DECL_UPDATES);
950 RECORD(CUDA_SPECIAL_DECL_REFS);
951 RECORD(HEADER_SEARCH_TABLE);
952 RECORD(FP_PRAGMA_OPTIONS);
953 RECORD(OPENCL_EXTENSIONS);
954 RECORD(OPENCL_EXTENSION_TYPES);
955 RECORD(OPENCL_EXTENSION_DECLS);
956 RECORD(DELEGATING_CTORS);
957 RECORD(KNOWN_NAMESPACES);
958 RECORD(MODULE_OFFSET_MAP);
959 RECORD(SOURCE_MANAGER_LINE_TABLE);
960 RECORD(OBJC_CATEGORIES_MAP);
961 RECORD(FILE_SORTED_DECLS);
962 RECORD(IMPORTED_MODULES);
963 RECORD(OBJC_CATEGORIES);
964 RECORD(MACRO_OFFSET);
965 RECORD(INTERESTING_IDENTIFIERS);
966 RECORD(UNDEFINED_BUT_USED);
967 RECORD(LATE_PARSED_TEMPLATE);
968 RECORD(OPTIMIZE_PRAGMA_OPTIONS);
969 RECORD(MSSTRUCT_PRAGMA_OPTIONS);
970 RECORD(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS);
971 RECORD(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES);
972 RECORD(DELETE_EXPRS_TO_ANALYZE);
973 RECORD(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH);
974 RECORD(PP_CONDITIONAL_STACK);
975 RECORD(DECLS_TO_CHECK_FOR_DEFERRED_DIAGS);
976 RECORD(PP_ASSUME_NONNULL_LOC);
977 RECORD(PP_UNSAFE_BUFFER_USAGE);
978 RECORD(VTABLES_TO_EMIT);
979 RECORD(RISCV_VECTOR_INTRINSICS_PRAGMA);
980
981 // SourceManager Block.
982 BLOCK(SOURCE_MANAGER_BLOCK);
983 RECORD(SM_SLOC_FILE_ENTRY);
984 RECORD(SM_SLOC_BUFFER_ENTRY);
985 RECORD(SM_SLOC_BUFFER_BLOB);
986 RECORD(SM_SLOC_BUFFER_BLOB_COMPRESSED);
987 RECORD(SM_SLOC_EXPANSION_ENTRY);
988
989 // Preprocessor Block.
990 BLOCK(PREPROCESSOR_BLOCK);
991 RECORD(PP_MACRO_DIRECTIVE_HISTORY);
992 RECORD(PP_MACRO_FUNCTION_LIKE);
993 RECORD(PP_MACRO_OBJECT_LIKE);
994 RECORD(PP_MODULE_MACRO);
995 RECORD(PP_TOKEN);
996
997 // Submodule Block.
998 BLOCK(SUBMODULE_BLOCK);
999 RECORD(SUBMODULE_METADATA);
1000 RECORD(SUBMODULE_DEFINITION);
1001 RECORD(SUBMODULE_UMBRELLA_HEADER);
1002 RECORD(SUBMODULE_HEADER);
1003 RECORD(SUBMODULE_TOPHEADER);
1004 RECORD(SUBMODULE_UMBRELLA_DIR);
1005 RECORD(SUBMODULE_IMPORTS);
1006 RECORD(SUBMODULE_AFFECTING_MODULES);
1007 RECORD(SUBMODULE_EXPORTS);
1008 RECORD(SUBMODULE_REQUIRES);
1009 RECORD(SUBMODULE_EXCLUDED_HEADER);
1010 RECORD(SUBMODULE_LINK_LIBRARY);
1011 RECORD(SUBMODULE_CONFIG_MACRO);
1012 RECORD(SUBMODULE_CONFLICT);
1013 RECORD(SUBMODULE_PRIVATE_HEADER);
1014 RECORD(SUBMODULE_TEXTUAL_HEADER);
1015 RECORD(SUBMODULE_PRIVATE_TEXTUAL_HEADER);
1016 RECORD(SUBMODULE_INITIALIZERS);
1017 RECORD(SUBMODULE_EXPORT_AS);
1018
1019 // Comments Block.
1020 BLOCK(COMMENTS_BLOCK);
1021 RECORD(COMMENTS_RAW_COMMENT);
1022
1023 // Decls and Types block.
1024 BLOCK(DECLTYPES_BLOCK);
1025 RECORD(TYPE_EXT_QUAL);
1026 RECORD(TYPE_COMPLEX);
1027 RECORD(TYPE_POINTER);
1028 RECORD(TYPE_BLOCK_POINTER);
1029 RECORD(TYPE_LVALUE_REFERENCE);
1030 RECORD(TYPE_RVALUE_REFERENCE);
1031 RECORD(TYPE_MEMBER_POINTER);
1032 RECORD(TYPE_CONSTANT_ARRAY);
1033 RECORD(TYPE_INCOMPLETE_ARRAY);
1034 RECORD(TYPE_VARIABLE_ARRAY);
1035 RECORD(TYPE_VECTOR);
1036 RECORD(TYPE_EXT_VECTOR);
1037 RECORD(TYPE_FUNCTION_NO_PROTO);
1038 RECORD(TYPE_FUNCTION_PROTO);
1039 RECORD(TYPE_TYPEDEF);
1040 RECORD(TYPE_TYPEOF_EXPR);
1041 RECORD(TYPE_TYPEOF);
1042 RECORD(TYPE_RECORD);
1043 RECORD(TYPE_ENUM);
1044 RECORD(TYPE_OBJC_INTERFACE);
1045 RECORD(TYPE_OBJC_OBJECT_POINTER);
1046 RECORD(TYPE_DECLTYPE);
1047 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
1048 RECORD(TYPE_UNRESOLVED_USING);
1049 RECORD(TYPE_INJECTED_CLASS_NAME);
1050 RECORD(TYPE_OBJC_OBJECT);
1051 RECORD(TYPE_TEMPLATE_TYPE_PARM);
1052 RECORD(TYPE_TEMPLATE_SPECIALIZATION);
1053 RECORD(TYPE_DEPENDENT_NAME);
1054 RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
1055 RECORD(TYPE_PAREN);
1056 RECORD(TYPE_MACRO_QUALIFIED);
1057 RECORD(TYPE_PACK_EXPANSION);
1058 RECORD(TYPE_ATTRIBUTED);
1059 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
1060 RECORD(TYPE_SUBST_BUILTIN_TEMPLATE_PACK);
1061 RECORD(TYPE_AUTO);
1062 RECORD(TYPE_UNARY_TRANSFORM);
1063 RECORD(TYPE_ATOMIC);
1064 RECORD(TYPE_DECAYED);
1065 RECORD(TYPE_ADJUSTED);
1066 RECORD(TYPE_OBJC_TYPE_PARAM);
1067 RECORD(LOCAL_REDECLARATIONS);
1068 RECORD(DECL_TYPEDEF);
1069 RECORD(DECL_TYPEALIAS);
1070 RECORD(DECL_ENUM);
1071 RECORD(DECL_RECORD);
1072 RECORD(DECL_ENUM_CONSTANT);
1073 RECORD(DECL_FUNCTION);
1074 RECORD(DECL_OBJC_METHOD);
1075 RECORD(DECL_OBJC_INTERFACE);
1076 RECORD(DECL_OBJC_PROTOCOL);
1077 RECORD(DECL_OBJC_IVAR);
1078 RECORD(DECL_OBJC_AT_DEFS_FIELD);
1079 RECORD(DECL_OBJC_CATEGORY);
1080 RECORD(DECL_OBJC_CATEGORY_IMPL);
1081 RECORD(DECL_OBJC_IMPLEMENTATION);
1082 RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
1083 RECORD(DECL_OBJC_PROPERTY);
1084 RECORD(DECL_OBJC_PROPERTY_IMPL);
1085 RECORD(DECL_FIELD);
1086 RECORD(DECL_MS_PROPERTY);
1087 RECORD(DECL_VAR);
1088 RECORD(DECL_IMPLICIT_PARAM);
1089 RECORD(DECL_PARM_VAR);
1090 RECORD(DECL_FILE_SCOPE_ASM);
1091 RECORD(DECL_BLOCK);
1092 RECORD(DECL_CONTEXT_LEXICAL);
1093 RECORD(DECL_CONTEXT_VISIBLE);
1094 RECORD(DECL_CONTEXT_MODULE_LOCAL_VISIBLE);
1095 RECORD(DECL_NAMESPACE);
1096 RECORD(DECL_NAMESPACE_ALIAS);
1097 RECORD(DECL_USING);
1098 RECORD(DECL_USING_SHADOW);
1099 RECORD(DECL_USING_DIRECTIVE);
1100 RECORD(DECL_UNRESOLVED_USING_VALUE);
1101 RECORD(DECL_UNRESOLVED_USING_TYPENAME);
1102 RECORD(DECL_LINKAGE_SPEC);
1103 RECORD(DECL_EXPORT);
1104 RECORD(DECL_CXX_RECORD);
1105 RECORD(DECL_CXX_METHOD);
1106 RECORD(DECL_CXX_CONSTRUCTOR);
1107 RECORD(DECL_CXX_DESTRUCTOR);
1108 RECORD(DECL_CXX_CONVERSION);
1109 RECORD(DECL_ACCESS_SPEC);
1110 RECORD(DECL_FRIEND);
1111 RECORD(DECL_FRIEND_TEMPLATE);
1112 RECORD(DECL_CLASS_TEMPLATE);
1113 RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
1114 RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
1115 RECORD(DECL_VAR_TEMPLATE);
1116 RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION);
1117 RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION);
1118 RECORD(DECL_FUNCTION_TEMPLATE);
1119 RECORD(DECL_TEMPLATE_TYPE_PARM);
1120 RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
1121 RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
1122 RECORD(DECL_CONCEPT);
1123 RECORD(DECL_REQUIRES_EXPR_BODY);
1124 RECORD(DECL_TYPE_ALIAS_TEMPLATE);
1125 RECORD(DECL_STATIC_ASSERT);
1126 RECORD(DECL_CXX_BASE_SPECIFIERS);
1127 RECORD(DECL_CXX_CTOR_INITIALIZERS);
1128 RECORD(DECL_INDIRECTFIELD);
1129 RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
1130 RECORD(DECL_EXPANDED_TEMPLATE_TEMPLATE_PARM_PACK);
1131 RECORD(DECL_IMPORT);
1132 RECORD(DECL_OMP_THREADPRIVATE);
1133 RECORD(DECL_EMPTY);
1134 RECORD(DECL_OBJC_TYPE_PARAM);
1135 RECORD(DECL_OMP_CAPTUREDEXPR);
1136 RECORD(DECL_PRAGMA_COMMENT);
1137 RECORD(DECL_PRAGMA_DETECT_MISMATCH);
1138 RECORD(DECL_OMP_DECLARE_REDUCTION);
1139 RECORD(DECL_OMP_ALLOCATE);
1140 RECORD(DECL_HLSL_BUFFER);
1141 RECORD(DECL_OPENACC_DECLARE);
1142 RECORD(DECL_OPENACC_ROUTINE);
1143
1144 // Statements and Exprs can occur in the Decls and Types block.
1145 AddStmtsExprs(Stream, Record);
1146
1147 BLOCK(PREPROCESSOR_DETAIL_BLOCK);
1148 RECORD(PPD_MACRO_EXPANSION);
1149 RECORD(PPD_MACRO_DEFINITION);
1150 RECORD(PPD_INCLUSION_DIRECTIVE);
1151
1152 // Decls and Types block.
1153 BLOCK(EXTENSION_BLOCK);
1154 RECORD(EXTENSION_METADATA);
1155
1156 BLOCK(UNHASHED_CONTROL_BLOCK);
1157 RECORD(SIGNATURE);
1158 RECORD(AST_BLOCK_HASH);
1159 RECORD(DIAGNOSTIC_OPTIONS);
1160 RECORD(HEADER_SEARCH_PATHS);
1161 RECORD(DIAG_PRAGMA_MAPPINGS);
1162 RECORD(HEADER_SEARCH_ENTRY_USAGE);
1163 RECORD(VFS_USAGE);
1164
1165#undef RECORD
1166#undef BLOCK
1167 Stream.ExitBlock();
1168}
1169
1170/// Adjusts the given filename to only write out the portion of the
1171/// filename that is not part of the system root directory.
1172///
1173/// \param Filename the file name to adjust.
1174///
1175/// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
1176/// the returned filename will be adjusted by this root directory.
1177///
1178/// \returns either the original filename (if it needs no adjustment) or the
1179/// adjusted filename (which points into the @p Filename parameter).
1180static const char *
1181adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
1182 assert(Filename && "No file name to adjust?");
1183
1184 if (BaseDir.empty())
1185 return Filename;
1186
1187 // Verify that the filename and the system root have the same prefix.
1188 unsigned Pos = 0;
1189 for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1190 if (Filename[Pos] != BaseDir[Pos])
1191 return Filename; // Prefixes don't match.
1192
1193 // We hit the end of the filename before we hit the end of the system root.
1194 if (!Filename[Pos])
1195 return Filename;
1196
1197 // If there's not a path separator at the end of the base directory nor
1198 // immediately after it, then this isn't within the base directory.
1199 if (!llvm::sys::path::is_separator(value: Filename[Pos])) {
1200 if (!llvm::sys::path::is_separator(value: BaseDir.back()))
1201 return Filename;
1202 } else {
1203 // If the file name has a '/' at the current position, skip over the '/'.
1204 // We distinguish relative paths from absolute paths by the
1205 // absence of '/' at the beginning of relative paths.
1206 //
1207 // FIXME: This is wrong. We distinguish them by asking if the path is
1208 // absolute, which isn't the same thing. And there might be multiple '/'s
1209 // in a row. Use a better mechanism to indicate whether we have emitted an
1210 // absolute or relative path.
1211 ++Pos;
1212 }
1213
1214 return Filename + Pos;
1215}
1216
1217std::pair<ASTFileSignature, ASTFileSignature>
1218ASTWriter::createSignature() const {
1219 StringRef AllBytes(Buffer.data(), Buffer.size());
1220
1221 llvm::SHA1 Hasher;
1222 Hasher.update(Str: AllBytes.slice(Start: ASTBlockRange.first, End: ASTBlockRange.second));
1223 ASTFileSignature ASTBlockHash = ASTFileSignature::create(Bytes: Hasher.result());
1224
1225 // Add the remaining bytes:
1226 // 1. Before the unhashed control block.
1227 Hasher.update(Str: AllBytes.slice(Start: 0, End: UnhashedControlBlockRange.first));
1228 // 2. Between the unhashed control block and the AST block.
1229 Hasher.update(
1230 Str: AllBytes.slice(Start: UnhashedControlBlockRange.second, End: ASTBlockRange.first));
1231 // 3. After the AST block.
1232 Hasher.update(Str: AllBytes.substr(Start: ASTBlockRange.second));
1233 ASTFileSignature Signature = ASTFileSignature::create(Bytes: Hasher.result());
1234
1235 return std::make_pair(x&: ASTBlockHash, y&: Signature);
1236}
1237
1238ASTFileSignature ASTWriter::createSignatureForNamedModule() const {
1239 llvm::SHA1 Hasher;
1240 Hasher.update(Str: StringRef(Buffer.data(), Buffer.size()));
1241
1242 assert(WritingModule);
1243 assert(WritingModule->isNamedModule());
1244
1245 // We need to combine all the export imported modules no matter
1246 // we used it or not.
1247 for (auto [ExportImported, _] : WritingModule->Exports)
1248 Hasher.update(Data: ExportImported->Signature);
1249
1250 // We combine all the used modules to make sure the signature is precise.
1251 // Consider the case like:
1252 //
1253 // // a.cppm
1254 // export module a;
1255 // export inline int a() { ... }
1256 //
1257 // // b.cppm
1258 // export module b;
1259 // import a;
1260 // export inline int b() { return a(); }
1261 //
1262 // Since both `a()` and `b()` are inline, we need to make sure the BMI of
1263 // `b.pcm` will change after the implementation of `a()` changes. We can't
1264 // get that naturally since we won't record the body of `a()` during the
1265 // writing process. We can't reuse ODRHash here since ODRHash won't calculate
1266 // the called function recursively. So ODRHash will be problematic if `a()`
1267 // calls other inline functions.
1268 //
1269 // Probably we can solve this by a new hash mechanism. But the safety and
1270 // efficiency may a problem too. Here we just combine the hash value of the
1271 // used modules conservatively.
1272 for (Module *M : TouchedTopLevelModules)
1273 Hasher.update(Data: M->Signature);
1274
1275 return ASTFileSignature::create(Bytes: Hasher.result());
1276}
1277
1278static void BackpatchSignatureAt(llvm::BitstreamWriter &Stream,
1279 const ASTFileSignature &S, uint64_t BitNo) {
1280 for (uint8_t Byte : S) {
1281 Stream.BackpatchByte(BitNo, NewByte: Byte);
1282 BitNo += 8;
1283 }
1284}
1285
1286ASTFileSignature ASTWriter::backpatchSignature() {
1287 if (isWritingStdCXXNamedModules()) {
1288 ASTFileSignature Signature = createSignatureForNamedModule();
1289 BackpatchSignatureAt(Stream, S: Signature, BitNo: SignatureOffset);
1290 return Signature;
1291 }
1292
1293 if (!WritingModule ||
1294 !PP->getHeaderSearchInfo().getHeaderSearchOpts().ModulesHashContent)
1295 return {};
1296
1297 // For implicit modules, write the hash of the PCM as its signature.
1298 ASTFileSignature ASTBlockHash;
1299 ASTFileSignature Signature;
1300 std::tie(args&: ASTBlockHash, args&: Signature) = createSignature();
1301
1302 BackpatchSignatureAt(Stream, S: ASTBlockHash, BitNo: ASTBlockHashOffset);
1303 BackpatchSignatureAt(Stream, S: Signature, BitNo: SignatureOffset);
1304
1305 return Signature;
1306}
1307
1308void ASTWriter::writeUnhashedControlBlock(Preprocessor &PP) {
1309 using namespace llvm;
1310
1311 // Flush first to prepare the PCM hash (signature).
1312 Stream.FlushToWord();
1313 UnhashedControlBlockRange.first = Stream.GetCurrentBitNo() >> 3;
1314
1315 // Enter the block and prepare to write records.
1316 RecordData Record;
1317 Stream.EnterSubblock(BlockID: UNHASHED_CONTROL_BLOCK_ID, CodeLen: 5);
1318
1319 // For implicit modules and C++20 named modules, write the hash of the PCM as
1320 // its signature.
1321 if (isWritingStdCXXNamedModules() ||
1322 (WritingModule &&
1323 PP.getHeaderSearchInfo().getHeaderSearchOpts().ModulesHashContent)) {
1324 // At this point, we don't know the actual signature of the file or the AST
1325 // block - we're only able to compute those at the end of the serialization
1326 // process. Let's store dummy signatures for now, and replace them with the
1327 // real ones later on.
1328 // The bitstream VBR-encodes record elements, which makes backpatching them
1329 // really difficult. Let's store the signatures as blobs instead - they are
1330 // guaranteed to be word-aligned, and we control their format/encoding.
1331 auto Dummy = ASTFileSignature::createDummy();
1332 SmallString<128> Blob{Dummy.begin(), Dummy.end()};
1333
1334 // We don't need AST Block hash in named modules.
1335 if (!isWritingStdCXXNamedModules()) {
1336 auto Abbrev = std::make_shared<BitCodeAbbrev>();
1337 Abbrev->Add(OpInfo: BitCodeAbbrevOp(AST_BLOCK_HASH));
1338 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1339 unsigned ASTBlockHashAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
1340
1341 Record.push_back(Elt: AST_BLOCK_HASH);
1342 Stream.EmitRecordWithBlob(Abbrev: ASTBlockHashAbbrev, Vals: Record, Blob);
1343 ASTBlockHashOffset = Stream.GetCurrentBitNo() - Blob.size() * 8;
1344 Record.clear();
1345 }
1346
1347 auto Abbrev = std::make_shared<BitCodeAbbrev>();
1348 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SIGNATURE));
1349 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1350 unsigned SignatureAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
1351
1352 Record.push_back(Elt: SIGNATURE);
1353 Stream.EmitRecordWithBlob(Abbrev: SignatureAbbrev, Vals: Record, Blob);
1354 SignatureOffset = Stream.GetCurrentBitNo() - Blob.size() * 8;
1355 Record.clear();
1356 }
1357
1358 const auto &HSOpts = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1359
1360 // Diagnostic options.
1361 const auto &Diags = PP.getDiagnostics();
1362 const DiagnosticOptions &DiagOpts = Diags.getDiagnosticOptions();
1363 if (!HSOpts.ModulesSkipDiagnosticOptions) {
1364#define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1365#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
1366 Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1367#include "clang/Basic/DiagnosticOptions.def"
1368 Record.push_back(Elt: DiagOpts.Warnings.size());
1369 for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1370 AddString(Str: DiagOpts.Warnings[I], Record);
1371 Record.push_back(Elt: DiagOpts.Remarks.size());
1372 for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1373 AddString(Str: DiagOpts.Remarks[I], Record);
1374 // Note: we don't serialize the log or serialization file names, because
1375 // they are generally transient files and will almost always be overridden.
1376 Stream.EmitRecord(Code: DIAGNOSTIC_OPTIONS, Vals: Record);
1377 Record.clear();
1378 }
1379
1380 // Header search paths.
1381 if (!HSOpts.ModulesSkipHeaderSearchPaths) {
1382 // Include entries.
1383 Record.push_back(Elt: HSOpts.UserEntries.size());
1384 for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1385 const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1386 AddString(Str: Entry.Path, Record);
1387 Record.push_back(Elt: static_cast<unsigned>(Entry.Group));
1388 Record.push_back(Elt: Entry.IsFramework);
1389 Record.push_back(Elt: Entry.IgnoreSysRoot);
1390 }
1391
1392 // System header prefixes.
1393 Record.push_back(Elt: HSOpts.SystemHeaderPrefixes.size());
1394 for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1395 AddString(Str: HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1396 Record.push_back(Elt: HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1397 }
1398
1399 // VFS overlay files.
1400 Record.push_back(Elt: HSOpts.VFSOverlayFiles.size());
1401 for (StringRef VFSOverlayFile : HSOpts.VFSOverlayFiles)
1402 AddString(Str: VFSOverlayFile, Record);
1403
1404 Stream.EmitRecord(Code: HEADER_SEARCH_PATHS, Vals: Record);
1405 }
1406
1407 if (!HSOpts.ModulesSkipPragmaDiagnosticMappings)
1408 WritePragmaDiagnosticMappings(Diag: Diags, /* isModule = */ WritingModule);
1409
1410 // Header search entry usage.
1411 {
1412 auto HSEntryUsage = PP.getHeaderSearchInfo().computeUserEntryUsage();
1413 auto Abbrev = std::make_shared<BitCodeAbbrev>();
1414 Abbrev->Add(OpInfo: BitCodeAbbrevOp(HEADER_SEARCH_ENTRY_USAGE));
1415 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // Number of bits.
1416 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Bit vector.
1417 unsigned HSUsageAbbrevCode = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
1418 RecordData::value_type Record[] = {HEADER_SEARCH_ENTRY_USAGE,
1419 HSEntryUsage.size()};
1420 Stream.EmitRecordWithBlob(Abbrev: HSUsageAbbrevCode, Vals: Record, Blob: bytes(V: HSEntryUsage));
1421 }
1422
1423 // VFS usage.
1424 {
1425 auto VFSUsage = PP.getHeaderSearchInfo().collectVFSUsageAndClear();
1426 auto Abbrev = std::make_shared<BitCodeAbbrev>();
1427 Abbrev->Add(OpInfo: BitCodeAbbrevOp(VFS_USAGE));
1428 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // Number of bits.
1429 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Bit vector.
1430 unsigned VFSUsageAbbrevCode = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
1431 RecordData::value_type Record[] = {VFS_USAGE, VFSUsage.size()};
1432 Stream.EmitRecordWithBlob(Abbrev: VFSUsageAbbrevCode, Vals: Record, Blob: bytes(V: VFSUsage));
1433 }
1434
1435 // Leave the options block.
1436 Stream.ExitBlock();
1437 UnhashedControlBlockRange.second = Stream.GetCurrentBitNo() >> 3;
1438}
1439
1440/// Write the control block.
1441void ASTWriter::WriteControlBlock(Preprocessor &PP, StringRef isysroot) {
1442 using namespace llvm;
1443
1444 SourceManager &SourceMgr = PP.getSourceManager();
1445 FileManager &FileMgr = PP.getFileManager();
1446
1447 Stream.EnterSubblock(BlockID: CONTROL_BLOCK_ID, CodeLen: 5);
1448 RecordData Record;
1449
1450 // Metadata
1451 auto MetadataAbbrev = std::make_shared<BitCodeAbbrev>();
1452 MetadataAbbrev->Add(OpInfo: BitCodeAbbrevOp(METADATA));
1453 MetadataAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1454 MetadataAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1455 MetadataAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1456 MetadataAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1457 MetadataAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
1458 // Standard C++ module
1459 MetadataAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
1460 MetadataAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Timestamps
1461 MetadataAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1462 MetadataAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
1463 unsigned MetadataAbbrevCode = Stream.EmitAbbrev(Abbv: std::move(MetadataAbbrev));
1464 assert((!WritingModule || isysroot.empty()) &&
1465 "writing module as a relocatable PCH?");
1466 {
1467 RecordData::value_type Record[] = {METADATA,
1468 VERSION_MAJOR,
1469 VERSION_MINOR,
1470 CLANG_VERSION_MAJOR,
1471 CLANG_VERSION_MINOR,
1472 !isysroot.empty(),
1473 isWritingStdCXXNamedModules(),
1474 IncludeTimestamps,
1475 ASTHasCompilerErrors};
1476 Stream.EmitRecordWithBlob(Abbrev: MetadataAbbrevCode, Vals: Record,
1477 Blob: getClangFullRepositoryVersion());
1478 }
1479
1480 if (WritingModule) {
1481 // Module name
1482 auto Abbrev = std::make_shared<BitCodeAbbrev>();
1483 Abbrev->Add(OpInfo: BitCodeAbbrevOp(MODULE_NAME));
1484 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
1485 unsigned AbbrevCode = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
1486 RecordData::value_type Record[] = {MODULE_NAME};
1487 Stream.EmitRecordWithBlob(Abbrev: AbbrevCode, Vals: Record, Blob: WritingModule->Name);
1488
1489 auto BaseDir = [&]() -> std::optional<SmallString<128>> {
1490 if (PP.getHeaderSearchInfo().getHeaderSearchOpts().ModuleFileHomeIsCwd) {
1491 // Use the current working directory as the base path for all inputs.
1492 auto CWD = FileMgr.getOptionalDirectoryRef(DirName: ".");
1493 return CWD->getName();
1494 }
1495 if (WritingModule->Directory) {
1496 return WritingModule->Directory->getName();
1497 }
1498 return std::nullopt;
1499 }();
1500 if (BaseDir) {
1501 FileMgr.makeAbsolutePath(Path&: *BaseDir, /*Canonicalize=*/true);
1502
1503 // If the home of the module is the current working directory, then we
1504 // want to pick up the cwd of the build process loading the module, not
1505 // our cwd, when we load this module.
1506 if (!PP.getHeaderSearchInfo().getHeaderSearchOpts().ModuleFileHomeIsCwd &&
1507 (!PP.getHeaderSearchInfo()
1508 .getHeaderSearchOpts()
1509 .ModuleMapFileHomeIsCwd ||
1510 WritingModule->Directory->getName() != ".")) {
1511 // Module directory.
1512 auto Abbrev = std::make_shared<BitCodeAbbrev>();
1513 Abbrev->Add(OpInfo: BitCodeAbbrevOp(MODULE_DIRECTORY));
1514 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
1515 unsigned AbbrevCode = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
1516
1517 RecordData::value_type Record[] = {MODULE_DIRECTORY};
1518 Stream.EmitRecordWithBlob(Abbrev: AbbrevCode, Vals: Record, Blob: *BaseDir);
1519 }
1520
1521 // Write out all other paths relative to the base directory if possible.
1522 BaseDirectory.assign(first: BaseDir->begin(), last: BaseDir->end());
1523 }
1524 } else if (!isysroot.empty()) {
1525 // Write out paths relative to the sysroot if possible.
1526 SmallString<128> CleanedSysroot(isysroot);
1527 PP.getFileManager().makeAbsolutePath(Path&: CleanedSysroot, /*Canonicalize=*/true);
1528 BaseDirectory.assign(first: CleanedSysroot.begin(), last: CleanedSysroot.end());
1529 }
1530
1531 // Module map file
1532 if (WritingModule && WritingModule->Kind == Module::ModuleMapModule) {
1533 Record.clear();
1534
1535 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
1536 AddPath(Path: WritingModule->PresumedModuleMapFile.empty()
1537 ? Map.getModuleMapFileForUniquing(M: WritingModule)
1538 ->getNameAsRequested()
1539 : StringRef(WritingModule->PresumedModuleMapFile),
1540 Record);
1541
1542 // Additional module map files.
1543 if (auto *AdditionalModMaps =
1544 Map.getAdditionalModuleMapFiles(M: WritingModule)) {
1545 Record.push_back(Elt: AdditionalModMaps->size());
1546 SmallVector<FileEntryRef, 1> ModMaps(AdditionalModMaps->begin(),
1547 AdditionalModMaps->end());
1548 llvm::sort(C&: ModMaps, Comp: [](FileEntryRef A, FileEntryRef B) {
1549 return A.getName() < B.getName();
1550 });
1551 for (FileEntryRef F : ModMaps)
1552 AddPath(Path: F.getName(), Record);
1553 } else {
1554 Record.push_back(Elt: 0);
1555 }
1556
1557 Stream.EmitRecord(Code: MODULE_MAP_FILE, Vals: Record);
1558 }
1559
1560 // Imports
1561 if (Chain) {
1562 auto Abbrev = std::make_shared<BitCodeAbbrev>();
1563 Abbrev->Add(OpInfo: BitCodeAbbrevOp(IMPORT));
1564 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Kind
1565 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ImportLoc
1566 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Module name len
1567 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Standard C++ mod
1568 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File size
1569 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File timestamp
1570 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File name len
1571 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Strings
1572 unsigned AbbrevCode = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
1573
1574 SmallString<128> Blob;
1575
1576 for (ModuleFile &M : Chain->getModuleManager()) {
1577 // Skip modules that weren't directly imported.
1578 if (!M.isDirectlyImported())
1579 continue;
1580
1581 Record.clear();
1582 Blob.clear();
1583
1584 Record.push_back(Elt: IMPORT);
1585 Record.push_back(Elt: (unsigned)M.Kind); // FIXME: Stable encoding
1586 AddSourceLocation(Loc: M.ImportLoc, Record);
1587 AddStringBlob(Str: M.ModuleName, Record, Blob);
1588 Record.push_back(Elt: M.StandardCXXModule);
1589
1590 // We don't want to hard code the information about imported modules
1591 // in the C++20 named modules.
1592 if (M.StandardCXXModule) {
1593 Record.push_back(Elt: 0);
1594 Record.push_back(Elt: 0);
1595 Record.push_back(Elt: 0);
1596 } else {
1597 // If we have calculated signature, there is no need to store
1598 // the size or timestamp.
1599 Record.push_back(Elt: M.Signature ? 0 : M.File.getSize());
1600 Record.push_back(Elt: M.Signature ? 0 : getTimestampForOutput(E: M.File));
1601
1602 llvm::append_range(C&: Blob, R&: M.Signature);
1603
1604 AddPathBlob(Str: M.FileName, Record, Blob);
1605 }
1606
1607 Stream.EmitRecordWithBlob(Abbrev: AbbrevCode, Vals: Record, Blob);
1608 }
1609 }
1610
1611 // Write the options block.
1612 Stream.EnterSubblock(BlockID: OPTIONS_BLOCK_ID, CodeLen: 4);
1613
1614 // Language options.
1615 Record.clear();
1616 const LangOptions &LangOpts = PP.getLangOpts();
1617#define LANGOPT(Name, Bits, Default, Compatibility, Description) \
1618 Record.push_back(LangOpts.Name);
1619#define ENUM_LANGOPT(Name, Type, Bits, Default, Compatibility, Description) \
1620 Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
1621#include "clang/Basic/LangOptions.def"
1622#define SANITIZER(NAME, ID) \
1623 Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
1624#include "clang/Basic/Sanitizers.def"
1625
1626 Record.push_back(Elt: LangOpts.ModuleFeatures.size());
1627 for (StringRef Feature : LangOpts.ModuleFeatures)
1628 AddString(Str: Feature, Record);
1629
1630 Record.push_back(Elt: (unsigned) LangOpts.ObjCRuntime.getKind());
1631 AddVersionTuple(Version: LangOpts.ObjCRuntime.getVersion(), Record);
1632
1633 AddString(Str: LangOpts.CurrentModule, Record);
1634
1635 // Comment options.
1636 Record.push_back(Elt: LangOpts.CommentOpts.BlockCommandNames.size());
1637 for (const auto &I : LangOpts.CommentOpts.BlockCommandNames) {
1638 AddString(Str: I, Record);
1639 }
1640 Record.push_back(Elt: LangOpts.CommentOpts.ParseAllComments);
1641
1642 // OpenMP offloading options.
1643 Record.push_back(Elt: LangOpts.OMPTargetTriples.size());
1644 for (auto &T : LangOpts.OMPTargetTriples)
1645 AddString(Str: T.getTriple(), Record);
1646
1647 AddString(Str: LangOpts.OMPHostIRFile, Record);
1648
1649 Stream.EmitRecord(Code: LANGUAGE_OPTIONS, Vals: Record);
1650
1651 // Codegen options.
1652 // FIXME: Replace with C++20 `using enum CodeGenOptions::CompatibilityKind`.
1653 using CK = CodeGenOptions::CompatibilityKind;
1654 Record.clear();
1655 const CodeGenOptions &CGOpts = getCodeGenOpts();
1656#define CODEGENOPT(Name, Bits, Default, Compatibility) \
1657 if constexpr (CK::Compatibility != CK::Benign) \
1658 Record.push_back(static_cast<unsigned>(CGOpts.Name));
1659#define ENUM_CODEGENOPT(Name, Type, Bits, Default, Compatibility) \
1660 if constexpr (CK::Compatibility != CK::Benign) \
1661 Record.push_back(static_cast<unsigned>(CGOpts.get##Name()));
1662#define DEBUGOPT(Name, Bits, Default, Compatibility)
1663#define VALUE_DEBUGOPT(Name, Bits, Default, Compatibility)
1664#define ENUM_DEBUGOPT(Name, Type, Bits, Default, Compatibility)
1665#include "clang/Basic/CodeGenOptions.def"
1666 Stream.EmitRecord(Code: CODEGEN_OPTIONS, Vals: Record);
1667
1668 // Target options.
1669 Record.clear();
1670 const TargetInfo &Target = PP.getTargetInfo();
1671 const TargetOptions &TargetOpts = Target.getTargetOpts();
1672 AddString(Str: TargetOpts.Triple, Record);
1673 AddString(Str: TargetOpts.CPU, Record);
1674 AddString(Str: TargetOpts.TuneCPU, Record);
1675 AddString(Str: TargetOpts.ABI, Record);
1676 Record.push_back(Elt: TargetOpts.FeaturesAsWritten.size());
1677 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1678 AddString(Str: TargetOpts.FeaturesAsWritten[I], Record);
1679 }
1680 Record.push_back(Elt: TargetOpts.Features.size());
1681 for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1682 AddString(Str: TargetOpts.Features[I], Record);
1683 }
1684 Stream.EmitRecord(Code: TARGET_OPTIONS, Vals: Record);
1685
1686 // File system options.
1687 Record.clear();
1688 const FileSystemOptions &FSOpts = FileMgr.getFileSystemOpts();
1689 AddString(Str: FSOpts.WorkingDir, Record);
1690 Stream.EmitRecord(Code: FILE_SYSTEM_OPTIONS, Vals: Record);
1691
1692 // Header search options.
1693 Record.clear();
1694 const HeaderSearchOptions &HSOpts =
1695 PP.getHeaderSearchInfo().getHeaderSearchOpts();
1696
1697 SmallString<256> HSOpts_ModuleCachePath;
1698 normalizeModuleCachePath(FileMgr&: PP.getFileManager(), Path: HSOpts.ModuleCachePath,
1699 NormalizedPath&: HSOpts_ModuleCachePath);
1700
1701 AddString(Str: HSOpts.Sysroot, Record);
1702 AddString(Str: HSOpts.ResourceDir, Record);
1703 AddString(Str: HSOpts_ModuleCachePath, Record);
1704 AddString(Str: HSOpts.ModuleUserBuildPath, Record);
1705 Record.push_back(Elt: HSOpts.DisableModuleHash);
1706 Record.push_back(Elt: HSOpts.ImplicitModuleMaps);
1707 Record.push_back(Elt: HSOpts.ModuleMapFileHomeIsCwd);
1708 Record.push_back(Elt: HSOpts.EnablePrebuiltImplicitModules);
1709 Record.push_back(Elt: HSOpts.UseBuiltinIncludes);
1710 Record.push_back(Elt: HSOpts.UseStandardSystemIncludes);
1711 Record.push_back(Elt: HSOpts.UseStandardCXXIncludes);
1712 Record.push_back(Elt: HSOpts.UseLibcxx);
1713 // Write out the specific module cache path that contains the module files.
1714 // FIXME: We already wrote out the normalized cache path. Just write the
1715 // context hash (unless suppressed).
1716 AddString(Str: PP.getHeaderSearchInfo().getSpecificModuleCachePath(), Record);
1717 Stream.EmitRecord(Code: HEADER_SEARCH_OPTIONS, Vals: Record);
1718
1719 // Preprocessor options.
1720 Record.clear();
1721 const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts();
1722
1723 // If we're building an implicit module with a context hash, the importer is
1724 // guaranteed to have the same macros defined on the command line. Skip
1725 // writing them.
1726 bool SkipMacros = BuildingImplicitModule && !HSOpts.DisableModuleHash;
1727 bool WriteMacros = !SkipMacros;
1728 Record.push_back(Elt: WriteMacros);
1729 if (WriteMacros) {
1730 // Macro definitions.
1731 Record.push_back(Elt: PPOpts.Macros.size());
1732 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1733 AddString(Str: PPOpts.Macros[I].first, Record);
1734 Record.push_back(Elt: PPOpts.Macros[I].second);
1735 }
1736 }
1737
1738 // Includes
1739 Record.push_back(Elt: PPOpts.Includes.size());
1740 for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1741 AddString(Str: PPOpts.Includes[I], Record);
1742
1743 // Macro includes
1744 Record.push_back(Elt: PPOpts.MacroIncludes.size());
1745 for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1746 AddString(Str: PPOpts.MacroIncludes[I], Record);
1747
1748 Record.push_back(Elt: PPOpts.UsePredefines);
1749 // Detailed record is important since it is used for the module cache hash.
1750 Record.push_back(Elt: PPOpts.DetailedRecord);
1751
1752 // FIXME: Using `AddString` to record `ImplicitPCHInclude` does not handle
1753 // relocatable files. We probably should call
1754 // `AddPath(PPOpts.ImplicitPCHInclude, Record)` to properly support chained
1755 // relocatable PCHs.
1756 AddString(Str: PPOpts.ImplicitPCHInclude, Record);
1757 Record.push_back(Elt: static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1758 Stream.EmitRecord(Code: PREPROCESSOR_OPTIONS, Vals: Record);
1759
1760 // Leave the options block.
1761 Stream.ExitBlock();
1762
1763 // Original file name and file ID
1764 if (auto MainFile =
1765 SourceMgr.getFileEntryRefForID(FID: SourceMgr.getMainFileID())) {
1766 auto FileAbbrev = std::make_shared<BitCodeAbbrev>();
1767 FileAbbrev->Add(OpInfo: BitCodeAbbrevOp(ORIGINAL_FILE));
1768 FileAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
1769 FileAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1770 unsigned FileAbbrevCode = Stream.EmitAbbrev(Abbv: std::move(FileAbbrev));
1771
1772 Record.clear();
1773 Record.push_back(Elt: ORIGINAL_FILE);
1774 AddFileID(FID: SourceMgr.getMainFileID(), Record);
1775 EmitRecordWithPath(Abbrev: FileAbbrevCode, Record, Path: MainFile->getName());
1776 }
1777
1778 Record.clear();
1779 AddFileID(FID: SourceMgr.getMainFileID(), Record);
1780 Stream.EmitRecord(Code: ORIGINAL_FILE_ID, Vals: Record);
1781
1782 WriteInputFiles(SourceMgr);
1783 Stream.ExitBlock();
1784}
1785
1786namespace {
1787
1788/// An input file.
1789struct InputFileEntry {
1790 FileEntryRef File;
1791 bool IsSystemFile;
1792 bool IsTransient;
1793 bool BufferOverridden;
1794 bool IsTopLevel;
1795 bool IsModuleMap;
1796 uint32_t ContentHash[2];
1797
1798 InputFileEntry(FileEntryRef File) : File(File) {}
1799
1800 void trySetContentHash(
1801 Preprocessor &PP,
1802 llvm::function_ref<std::optional<llvm::MemoryBufferRef>()> GetMemBuff) {
1803 ContentHash[0] = 0;
1804 ContentHash[1] = 0;
1805
1806 if (!PP.getHeaderSearchInfo()
1807 .getHeaderSearchOpts()
1808 .ValidateASTInputFilesContent)
1809 return;
1810
1811 auto MemBuff = GetMemBuff();
1812 if (!MemBuff) {
1813 PP.Diag(Loc: SourceLocation(), DiagID: diag::err_module_unable_to_hash_content)
1814 << File.getName();
1815 return;
1816 }
1817
1818 uint64_t Hash = xxh3_64bits(data: MemBuff->getBuffer());
1819 ContentHash[0] = uint32_t(Hash);
1820 ContentHash[1] = uint32_t(Hash >> 32);
1821 }
1822};
1823
1824} // namespace
1825
1826SourceLocation ASTWriter::getAffectingIncludeLoc(const SourceManager &SourceMgr,
1827 const SrcMgr::FileInfo &File) {
1828 SourceLocation IncludeLoc = File.getIncludeLoc();
1829 if (IncludeLoc.isValid()) {
1830 FileID IncludeFID = SourceMgr.getFileID(SpellingLoc: IncludeLoc);
1831 assert(IncludeFID.isValid() && "IncludeLoc in invalid file");
1832 if (!IsSLocAffecting[IncludeFID.ID])
1833 IncludeLoc = SourceLocation();
1834 }
1835 return IncludeLoc;
1836}
1837
1838void ASTWriter::WriteInputFiles(SourceManager &SourceMgr) {
1839 using namespace llvm;
1840
1841 Stream.EnterSubblock(BlockID: INPUT_FILES_BLOCK_ID, CodeLen: 4);
1842
1843 // Create input-file abbreviation.
1844 auto IFAbbrev = std::make_shared<BitCodeAbbrev>();
1845 IFAbbrev->Add(OpInfo: BitCodeAbbrevOp(INPUT_FILE));
1846 IFAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
1847 IFAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1848 IFAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
1849 IFAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
1850 IFAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Transient
1851 IFAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Top-level
1852 IFAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Module map
1853 IFAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // Name as req. len
1854 IFAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name as req. + name
1855 unsigned IFAbbrevCode = Stream.EmitAbbrev(Abbv: std::move(IFAbbrev));
1856
1857 // Create input file hash abbreviation.
1858 auto IFHAbbrev = std::make_shared<BitCodeAbbrev>();
1859 IFHAbbrev->Add(OpInfo: BitCodeAbbrevOp(INPUT_FILE_HASH));
1860 IFHAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1861 IFHAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1862 unsigned IFHAbbrevCode = Stream.EmitAbbrev(Abbv: std::move(IFHAbbrev));
1863
1864 uint64_t InputFilesOffsetBase = Stream.GetCurrentBitNo();
1865
1866 // Get all ContentCache objects for files.
1867 std::vector<InputFileEntry> UserFiles;
1868 std::vector<InputFileEntry> SystemFiles;
1869 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
1870 // Get this source location entry.
1871 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(Index: I);
1872 assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc);
1873
1874 // We only care about file entries that were not overridden.
1875 if (!SLoc->isFile())
1876 continue;
1877 const SrcMgr::FileInfo &File = SLoc->getFile();
1878 const SrcMgr::ContentCache *Cache = &File.getContentCache();
1879 if (!Cache->OrigEntry)
1880 continue;
1881
1882 // Do not emit input files that do not affect current module.
1883 if (!IsSLocFileEntryAffecting[I])
1884 continue;
1885
1886 InputFileEntry Entry(*Cache->OrigEntry);
1887 Entry.IsSystemFile = isSystem(CK: File.getFileCharacteristic());
1888 Entry.IsTransient = Cache->IsTransient;
1889 Entry.BufferOverridden = Cache->BufferOverridden;
1890
1891 FileID IncludeFileID = SourceMgr.getFileID(SpellingLoc: File.getIncludeLoc());
1892 Entry.IsTopLevel = IncludeFileID.isInvalid() || IncludeFileID.ID < 0 ||
1893 !IsSLocFileEntryAffecting[IncludeFileID.ID];
1894 Entry.IsModuleMap = isModuleMap(CK: File.getFileCharacteristic());
1895
1896 Entry.trySetContentHash(PP&: *PP, GetMemBuff: [&] { return Cache->getBufferIfLoaded(); });
1897
1898 if (Entry.IsSystemFile)
1899 SystemFiles.push_back(x: Entry);
1900 else
1901 UserFiles.push_back(x: Entry);
1902 }
1903
1904 // FIXME: Make providing input files not in the SourceManager more flexible.
1905 // The SDKSettings.json file is necessary for correct evaluation of
1906 // availability annotations.
1907 StringRef Sysroot = PP->getHeaderSearchInfo().getHeaderSearchOpts().Sysroot;
1908 if (!Sysroot.empty()) {
1909 SmallString<128> SDKSettingsJSON = Sysroot;
1910 llvm::sys::path::append(path&: SDKSettingsJSON, a: "SDKSettings.json");
1911 FileManager &FM = PP->getFileManager();
1912 if (auto FE = FM.getOptionalFileRef(Filename: SDKSettingsJSON)) {
1913 InputFileEntry Entry(*FE);
1914 Entry.IsSystemFile = true;
1915 Entry.IsTransient = false;
1916 Entry.BufferOverridden = false;
1917 Entry.IsTopLevel = true;
1918 Entry.IsModuleMap = false;
1919 std::unique_ptr<MemoryBuffer> MB;
1920 Entry.trySetContentHash(PP&: *PP, GetMemBuff: [&]() -> std::optional<MemoryBufferRef> {
1921 if (auto MBOrErr = FM.getBufferForFile(Entry: Entry.File)) {
1922 MB = std::move(*MBOrErr);
1923 return MB->getMemBufferRef();
1924 }
1925 return std::nullopt;
1926 });
1927 SystemFiles.push_back(x: Entry);
1928 }
1929 }
1930
1931 // User files go at the front, system files at the back.
1932 auto SortedFiles = llvm::concat<InputFileEntry>(Ranges: std::move(UserFiles),
1933 Ranges: std::move(SystemFiles));
1934
1935 unsigned UserFilesNum = 0;
1936 // Write out all of the input files.
1937 std::vector<uint64_t> InputFileOffsets;
1938 for (const auto &Entry : SortedFiles) {
1939 uint32_t &InputFileID = InputFileIDs[Entry.File];
1940 if (InputFileID != 0)
1941 continue; // already recorded this file.
1942
1943 // Record this entry's offset.
1944 InputFileOffsets.push_back(x: Stream.GetCurrentBitNo() - InputFilesOffsetBase);
1945
1946 InputFileID = InputFileOffsets.size();
1947
1948 if (!Entry.IsSystemFile)
1949 ++UserFilesNum;
1950
1951 // Emit size/modification time for this file.
1952 // And whether this file was overridden.
1953 {
1954 SmallString<128> NameAsRequested = Entry.File.getNameAsRequested();
1955 SmallString<128> Name = Entry.File.getName();
1956
1957 PreparePathForOutput(Path&: NameAsRequested);
1958 PreparePathForOutput(Path&: Name);
1959
1960 if (Name == NameAsRequested)
1961 Name.clear();
1962
1963 RecordData::value_type Record[] = {
1964 INPUT_FILE,
1965 InputFileOffsets.size(),
1966 (uint64_t)Entry.File.getSize(),
1967 (uint64_t)getTimestampForOutput(E: Entry.File),
1968 Entry.BufferOverridden,
1969 Entry.IsTransient,
1970 Entry.IsTopLevel,
1971 Entry.IsModuleMap,
1972 NameAsRequested.size()};
1973
1974 Stream.EmitRecordWithBlob(Abbrev: IFAbbrevCode, Vals: Record,
1975 Blob: (NameAsRequested + Name).str());
1976 }
1977
1978 // Emit content hash for this file.
1979 {
1980 RecordData::value_type Record[] = {INPUT_FILE_HASH, Entry.ContentHash[0],
1981 Entry.ContentHash[1]};
1982 Stream.EmitRecordWithAbbrev(Abbrev: IFHAbbrevCode, Vals: Record);
1983 }
1984 }
1985
1986 Stream.ExitBlock();
1987
1988 // Create input file offsets abbreviation.
1989 auto OffsetsAbbrev = std::make_shared<BitCodeAbbrev>();
1990 OffsetsAbbrev->Add(OpInfo: BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1991 OffsetsAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
1992 OffsetsAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1993 // input files
1994 OffsetsAbbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Array
1995 unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(Abbv: std::move(OffsetsAbbrev));
1996
1997 // Write input file offsets.
1998 RecordData::value_type Record[] = {INPUT_FILE_OFFSETS,
1999 InputFileOffsets.size(), UserFilesNum};
2000 Stream.EmitRecordWithBlob(Abbrev: OffsetsAbbrevCode, Vals: Record, Blob: bytes(v: InputFileOffsets));
2001}
2002
2003//===----------------------------------------------------------------------===//
2004// Source Manager Serialization
2005//===----------------------------------------------------------------------===//
2006
2007/// Create an abbreviation for the SLocEntry that refers to a
2008/// file.
2009static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
2010 using namespace llvm;
2011
2012 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2013 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
2014 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
2015 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
2016 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
2017 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
2018 // FileEntry fields.
2019 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
2020 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
2021 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
2022 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
2023 return Stream.EmitAbbrev(Abbv: std::move(Abbrev));
2024}
2025
2026/// Create an abbreviation for the SLocEntry that refers to a
2027/// buffer.
2028static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
2029 using namespace llvm;
2030
2031 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2032 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
2033 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
2034 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
2035 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
2036 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
2037 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
2038 return Stream.EmitAbbrev(Abbv: std::move(Abbrev));
2039}
2040
2041/// Create an abbreviation for the SLocEntry that refers to a
2042/// buffer's blob.
2043static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream,
2044 bool Compressed) {
2045 using namespace llvm;
2046
2047 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2048 Abbrev->Add(OpInfo: BitCodeAbbrevOp(Compressed ? SM_SLOC_BUFFER_BLOB_COMPRESSED
2049 : SM_SLOC_BUFFER_BLOB));
2050 if (Compressed)
2051 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Uncompressed size
2052 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
2053 return Stream.EmitAbbrev(Abbv: std::move(Abbrev));
2054}
2055
2056/// Create an abbreviation for the SLocEntry that refers to a macro
2057/// expansion.
2058static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
2059 using namespace llvm;
2060
2061 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2062 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
2063 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
2064 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
2065 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Start location
2066 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // End location
2067 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Is token range
2068 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
2069 return Stream.EmitAbbrev(Abbv: std::move(Abbrev));
2070}
2071
2072/// Emit key length and data length as ULEB-encoded data, and return them as a
2073/// pair.
2074static std::pair<unsigned, unsigned>
2075emitULEBKeyDataLength(unsigned KeyLen, unsigned DataLen, raw_ostream &Out) {
2076 llvm::encodeULEB128(Value: KeyLen, OS&: Out);
2077 llvm::encodeULEB128(Value: DataLen, OS&: Out);
2078 return std::make_pair(x&: KeyLen, y&: DataLen);
2079}
2080
2081namespace {
2082
2083 // Trait used for the on-disk hash table of header search information.
2084 class HeaderFileInfoTrait {
2085 ASTWriter &Writer;
2086
2087 public:
2088 HeaderFileInfoTrait(ASTWriter &Writer) : Writer(Writer) {}
2089
2090 struct key_type {
2091 StringRef Filename;
2092 off_t Size;
2093 time_t ModTime;
2094 };
2095 using key_type_ref = const key_type &;
2096
2097 using UnresolvedModule =
2098 llvm::PointerIntPair<Module *, 2, ModuleMap::ModuleHeaderRole>;
2099
2100 struct data_type {
2101 data_type(const HeaderFileInfo &HFI, bool AlreadyIncluded,
2102 ArrayRef<ModuleMap::KnownHeader> KnownHeaders,
2103 UnresolvedModule Unresolved)
2104 : HFI(HFI), AlreadyIncluded(AlreadyIncluded),
2105 KnownHeaders(KnownHeaders), Unresolved(Unresolved) {}
2106
2107 HeaderFileInfo HFI;
2108 bool AlreadyIncluded;
2109 SmallVector<ModuleMap::KnownHeader, 1> KnownHeaders;
2110 UnresolvedModule Unresolved;
2111 };
2112 using data_type_ref = const data_type &;
2113
2114 using hash_value_type = unsigned;
2115 using offset_type = unsigned;
2116
2117 hash_value_type ComputeHash(key_type_ref key) {
2118 // The hash is based only on size/time of the file, so that the reader can
2119 // match even when symlinking or excess path elements ("foo/../", "../")
2120 // change the form of the name. However, complete path is still the key.
2121 uint8_t buf[sizeof(key.Size) + sizeof(key.ModTime)];
2122 memcpy(dest: buf, src: &key.Size, n: sizeof(key.Size));
2123 memcpy(dest: buf + sizeof(key.Size), src: &key.ModTime, n: sizeof(key.ModTime));
2124 return llvm::xxh3_64bits(data: buf);
2125 }
2126
2127 std::pair<unsigned, unsigned>
2128 EmitKeyDataLength(raw_ostream& Out, key_type_ref key, data_type_ref Data) {
2129 unsigned KeyLen = key.Filename.size() + 1 + 8 + 8;
2130 unsigned DataLen = 1 + sizeof(IdentifierID);
2131 for (auto ModInfo : Data.KnownHeaders)
2132 if (Writer.getLocalOrImportedSubmoduleID(Mod: ModInfo.getModule()))
2133 DataLen += 4;
2134 if (Data.Unresolved.getPointer())
2135 DataLen += 4;
2136 return emitULEBKeyDataLength(KeyLen, DataLen, Out);
2137 }
2138
2139 void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) {
2140 using namespace llvm::support;
2141
2142 endian::Writer LE(Out, llvm::endianness::little);
2143 LE.write<uint64_t>(Val: key.Size);
2144 KeyLen -= 8;
2145 LE.write<uint64_t>(Val: key.ModTime);
2146 KeyLen -= 8;
2147 Out.write(Ptr: key.Filename.data(), Size: KeyLen);
2148 }
2149
2150 void EmitData(raw_ostream &Out, key_type_ref key,
2151 data_type_ref Data, unsigned DataLen) {
2152 using namespace llvm::support;
2153
2154 endian::Writer LE(Out, llvm::endianness::little);
2155 uint64_t Start = Out.tell(); (void)Start;
2156
2157 unsigned char Flags = (Data.AlreadyIncluded << 6)
2158 | (Data.HFI.isImport << 5)
2159 | (Writer.isWritingStdCXXNamedModules() ? 0 :
2160 Data.HFI.isPragmaOnce << 4)
2161 | (Data.HFI.DirInfo << 1);
2162 LE.write<uint8_t>(Val: Flags);
2163
2164 if (Data.HFI.LazyControllingMacro.isID())
2165 LE.write<IdentifierID>(Val: Data.HFI.LazyControllingMacro.getID());
2166 else
2167 LE.write<IdentifierID>(
2168 Val: Writer.getIdentifierRef(II: Data.HFI.LazyControllingMacro.getPtr()));
2169
2170 auto EmitModule = [&](Module *M, ModuleMap::ModuleHeaderRole Role) {
2171 if (uint32_t ModID = Writer.getLocalOrImportedSubmoduleID(Mod: M)) {
2172 uint32_t Value = (ModID << 3) | (unsigned)Role;
2173 assert((Value >> 3) == ModID && "overflow in header module info");
2174 LE.write<uint32_t>(Val: Value);
2175 }
2176 };
2177
2178 for (auto ModInfo : Data.KnownHeaders)
2179 EmitModule(ModInfo.getModule(), ModInfo.getRole());
2180 if (Data.Unresolved.getPointer())
2181 EmitModule(Data.Unresolved.getPointer(), Data.Unresolved.getInt());
2182
2183 assert(Out.tell() - Start == DataLen && "Wrong data length");
2184 }
2185 };
2186
2187} // namespace
2188
2189/// Write the header search block for the list of files that
2190///
2191/// \param HS The header search structure to save.
2192void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) {
2193 HeaderFileInfoTrait GeneratorTrait(*this);
2194 llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
2195 SmallVector<const char *, 4> SavedStrings;
2196 unsigned NumHeaderSearchEntries = 0;
2197
2198 // Find all unresolved headers for the current module. We generally will
2199 // have resolved them before we get here, but not necessarily: we might be
2200 // compiling a preprocessed module, where there is no requirement for the
2201 // original files to exist any more.
2202 const HeaderFileInfo Empty; // So we can take a reference.
2203 if (WritingModule) {
2204 llvm::SmallVector<Module *, 16> Worklist(1, WritingModule);
2205 while (!Worklist.empty()) {
2206 Module *M = Worklist.pop_back_val();
2207 // We don't care about headers in unimportable submodules.
2208 if (M->isUnimportable())
2209 continue;
2210
2211 // Map to disk files where possible, to pick up any missing stat
2212 // information. This also means we don't need to check the unresolved
2213 // headers list when emitting resolved headers in the first loop below.
2214 // FIXME: It'd be preferable to avoid doing this if we were given
2215 // sufficient stat information in the module map.
2216 HS.getModuleMap().resolveHeaderDirectives(Mod: M, /*File=*/std::nullopt);
2217
2218 // If the file didn't exist, we can still create a module if we were given
2219 // enough information in the module map.
2220 for (const auto &U : M->MissingHeaders) {
2221 // Check that we were given enough information to build a module
2222 // without this file existing on disk.
2223 if (!U.Size || (!U.ModTime && IncludeTimestamps)) {
2224 PP->Diag(Loc: U.FileNameLoc, DiagID: diag::err_module_no_size_mtime_for_header)
2225 << WritingModule->getFullModuleName() << U.Size.has_value()
2226 << U.FileName;
2227 continue;
2228 }
2229
2230 // Form the effective relative pathname for the file.
2231 SmallString<128> Filename(M->Directory->getName());
2232 llvm::sys::path::append(path&: Filename, a: U.FileName);
2233 PreparePathForOutput(Path&: Filename);
2234
2235 StringRef FilenameDup = strdup(s: Filename.c_str());
2236 SavedStrings.push_back(Elt: FilenameDup.data());
2237
2238 HeaderFileInfoTrait::key_type Key = {
2239 .Filename: FilenameDup, .Size: *U.Size, .ModTime: IncludeTimestamps ? *U.ModTime : 0};
2240 HeaderFileInfoTrait::data_type Data = {
2241 Empty, false, {}, {M, ModuleMap::headerKindToRole(Kind: U.Kind)}};
2242 // FIXME: Deal with cases where there are multiple unresolved header
2243 // directives in different submodules for the same header.
2244 Generator.insert(Key, Data, InfoObj&: GeneratorTrait);
2245 ++NumHeaderSearchEntries;
2246 }
2247 auto SubmodulesRange = M->submodules();
2248 Worklist.append(in_start: SubmodulesRange.begin(), in_end: SubmodulesRange.end());
2249 }
2250 }
2251
2252 SmallVector<OptionalFileEntryRef, 16> FilesByUID;
2253 HS.getFileMgr().GetUniqueIDMapping(UIDToFiles&: FilesByUID);
2254
2255 if (FilesByUID.size() > HS.header_file_size())
2256 FilesByUID.resize(N: HS.header_file_size());
2257
2258 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
2259 OptionalFileEntryRef File = FilesByUID[UID];
2260 if (!File)
2261 continue;
2262
2263 const HeaderFileInfo *HFI = HS.getExistingLocalFileInfo(FE: *File);
2264 if (!HFI)
2265 continue; // We have no information on this being a header file.
2266 if (!HFI->isCompilingModuleHeader && HFI->isModuleHeader)
2267 continue; // Header file info is tracked by the owning module file.
2268 if (!HFI->isCompilingModuleHeader && !HFI->IsLocallyIncluded)
2269 continue; // Header file info is tracked by the including module file.
2270
2271 // Massage the file path into an appropriate form.
2272 StringRef Filename = File->getName();
2273 SmallString<128> FilenameTmp(Filename);
2274 if (PreparePathForOutput(Path&: FilenameTmp)) {
2275 // If we performed any translation on the file name at all, we need to
2276 // save this string, since the generator will refer to it later.
2277 Filename = StringRef(strdup(s: FilenameTmp.c_str()));
2278 SavedStrings.push_back(Elt: Filename.data());
2279 }
2280
2281 bool Included = HFI->IsLocallyIncluded || PP->alreadyIncluded(File: *File);
2282
2283 HeaderFileInfoTrait::key_type Key = {
2284 .Filename: Filename, .Size: File->getSize(), .ModTime: getTimestampForOutput(E: *File)
2285 };
2286 HeaderFileInfoTrait::data_type Data = {
2287 *HFI, Included, HS.getModuleMap().findResolvedModulesForHeader(File: *File), {}
2288 };
2289 Generator.insert(Key, Data, InfoObj&: GeneratorTrait);
2290 ++NumHeaderSearchEntries;
2291 }
2292
2293 // Create the on-disk hash table in a buffer.
2294 SmallString<4096> TableData;
2295 uint32_t BucketOffset;
2296 {
2297 using namespace llvm::support;
2298
2299 llvm::raw_svector_ostream Out(TableData);
2300 // Make sure that no bucket is at offset 0
2301 endian::write<uint32_t>(os&: Out, value: 0, endian: llvm::endianness::little);
2302 BucketOffset = Generator.Emit(Out, InfoObj&: GeneratorTrait);
2303 }
2304
2305 // Create a blob abbreviation
2306 using namespace llvm;
2307
2308 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2309 Abbrev->Add(OpInfo: BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
2310 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2311 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2312 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2313 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2314 unsigned TableAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
2315
2316 // Write the header search table
2317 RecordData::value_type Record[] = {HEADER_SEARCH_TABLE, BucketOffset,
2318 NumHeaderSearchEntries, TableData.size()};
2319 Stream.EmitRecordWithBlob(Abbrev: TableAbbrev, Vals: Record, Blob: TableData);
2320
2321 // Free all of the strings we had to duplicate.
2322 for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
2323 free(ptr: const_cast<char *>(SavedStrings[I]));
2324}
2325
2326static void emitBlob(llvm::BitstreamWriter &Stream, StringRef Blob,
2327 unsigned SLocBufferBlobCompressedAbbrv,
2328 unsigned SLocBufferBlobAbbrv) {
2329 using RecordDataType = ASTWriter::RecordData::value_type;
2330
2331 // Compress the buffer if possible. We expect that almost all PCM
2332 // consumers will not want its contents.
2333 SmallVector<uint8_t, 0> CompressedBuffer;
2334 if (llvm::compression::zstd::isAvailable()) {
2335 llvm::compression::zstd::compress(
2336 Input: llvm::arrayRefFromStringRef(Input: Blob.drop_back(N: 1)), CompressedBuffer, Level: 9);
2337 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB_COMPRESSED, Blob.size() - 1};
2338 Stream.EmitRecordWithBlob(Abbrev: SLocBufferBlobCompressedAbbrv, Vals: Record,
2339 Blob: llvm::toStringRef(Input: CompressedBuffer));
2340 return;
2341 }
2342 if (llvm::compression::zlib::isAvailable()) {
2343 llvm::compression::zlib::compress(
2344 Input: llvm::arrayRefFromStringRef(Input: Blob.drop_back(N: 1)), CompressedBuffer);
2345 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB_COMPRESSED, Blob.size() - 1};
2346 Stream.EmitRecordWithBlob(Abbrev: SLocBufferBlobCompressedAbbrv, Vals: Record,
2347 Blob: llvm::toStringRef(Input: CompressedBuffer));
2348 return;
2349 }
2350
2351 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB};
2352 Stream.EmitRecordWithBlob(Abbrev: SLocBufferBlobAbbrv, Vals: Record, Blob);
2353}
2354
2355/// Writes the block containing the serialized form of the
2356/// source manager.
2357///
2358/// TODO: We should probably use an on-disk hash table (stored in a
2359/// blob), indexed based on the file name, so that we only create
2360/// entries for files that we actually need. In the common case (no
2361/// errors), we probably won't have to create file entries for any of
2362/// the files in the AST.
2363void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr) {
2364 RecordData Record;
2365
2366 // Enter the source manager block.
2367 Stream.EnterSubblock(BlockID: SOURCE_MANAGER_BLOCK_ID, CodeLen: 4);
2368 const uint64_t SourceManagerBlockOffset = Stream.GetCurrentBitNo();
2369
2370 // Abbreviations for the various kinds of source-location entries.
2371 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
2372 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
2373 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream, Compressed: false);
2374 unsigned SLocBufferBlobCompressedAbbrv =
2375 CreateSLocBufferBlobAbbrev(Stream, Compressed: true);
2376 unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
2377
2378 // Write out the source location entry table. We skip the first
2379 // entry, which is always the same dummy entry.
2380 std::vector<uint32_t> SLocEntryOffsets;
2381 uint64_t SLocEntryOffsetsBase = Stream.GetCurrentBitNo();
2382 SLocEntryOffsets.reserve(n: SourceMgr.local_sloc_entry_size() - 1);
2383 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
2384 I != N; ++I) {
2385 // Get this source location entry.
2386 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(Index: I);
2387 FileID FID = FileID::get(V: I);
2388 assert(&SourceMgr.getSLocEntry(FID) == SLoc);
2389
2390 // Record the offset of this source-location entry.
2391 uint64_t Offset = Stream.GetCurrentBitNo() - SLocEntryOffsetsBase;
2392 assert((Offset >> 32) == 0 && "SLocEntry offset too large");
2393
2394 // Figure out which record code to use.
2395 unsigned Code;
2396 if (SLoc->isFile()) {
2397 const SrcMgr::ContentCache *Cache = &SLoc->getFile().getContentCache();
2398 if (Cache->OrigEntry) {
2399 Code = SM_SLOC_FILE_ENTRY;
2400 } else
2401 Code = SM_SLOC_BUFFER_ENTRY;
2402 } else
2403 Code = SM_SLOC_EXPANSION_ENTRY;
2404 Record.clear();
2405 Record.push_back(Elt: Code);
2406
2407 if (SLoc->isFile()) {
2408 const SrcMgr::FileInfo &File = SLoc->getFile();
2409 const SrcMgr::ContentCache *Content = &File.getContentCache();
2410 // Do not emit files that were not listed as inputs.
2411 if (!IsSLocAffecting[I])
2412 continue;
2413 SLocEntryOffsets.push_back(x: Offset);
2414 // Starting offset of this entry within this module, so skip the dummy.
2415 Record.push_back(Elt: getAdjustedOffset(Offset: SLoc->getOffset()) - 2);
2416 AddSourceLocation(Loc: getAffectingIncludeLoc(SourceMgr, File), Record);
2417 Record.push_back(Elt: File.getFileCharacteristic()); // FIXME: stable encoding
2418 Record.push_back(Elt: File.hasLineDirectives());
2419
2420 bool EmitBlob = false;
2421 if (Content->OrigEntry) {
2422 assert(Content->OrigEntry == Content->ContentsEntry &&
2423 "Writing to AST an overridden file is not supported");
2424
2425 // The source location entry is a file. Emit input file ID.
2426 assert(InputFileIDs[*Content->OrigEntry] != 0 && "Missed file entry");
2427 Record.push_back(Elt: InputFileIDs[*Content->OrigEntry]);
2428
2429 Record.push_back(Elt: getAdjustedNumCreatedFIDs(FID));
2430
2431 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(Val: FID);
2432 if (FDI != FileDeclIDs.end()) {
2433 Record.push_back(Elt: FDI->second->FirstDeclIndex);
2434 Record.push_back(Elt: FDI->second->DeclIDs.size());
2435 } else {
2436 Record.push_back(Elt: 0);
2437 Record.push_back(Elt: 0);
2438 }
2439
2440 Stream.EmitRecordWithAbbrev(Abbrev: SLocFileAbbrv, Vals: Record);
2441
2442 if (Content->BufferOverridden || Content->IsTransient)
2443 EmitBlob = true;
2444 } else {
2445 // The source location entry is a buffer. The blob associated
2446 // with this entry contains the contents of the buffer.
2447
2448 // We add one to the size so that we capture the trailing NULL
2449 // that is required by llvm::MemoryBuffer::getMemBuffer (on
2450 // the reader side).
2451 std::optional<llvm::MemoryBufferRef> Buffer = Content->getBufferOrNone(
2452 Diag&: SourceMgr.getDiagnostics(), FM&: SourceMgr.getFileManager());
2453 StringRef Name = Buffer ? Buffer->getBufferIdentifier() : "";
2454 Stream.EmitRecordWithBlob(Abbrev: SLocBufferAbbrv, Vals: Record,
2455 Blob: StringRef(Name.data(), Name.size() + 1));
2456 EmitBlob = true;
2457 }
2458
2459 if (EmitBlob) {
2460 // Include the implicit terminating null character in the on-disk buffer
2461 // if we're writing it uncompressed.
2462 std::optional<llvm::MemoryBufferRef> Buffer = Content->getBufferOrNone(
2463 Diag&: SourceMgr.getDiagnostics(), FM&: SourceMgr.getFileManager());
2464 if (!Buffer)
2465 Buffer = llvm::MemoryBufferRef("<<<INVALID BUFFER>>>", "");
2466 StringRef Blob(Buffer->getBufferStart(), Buffer->getBufferSize() + 1);
2467 emitBlob(Stream, Blob, SLocBufferBlobCompressedAbbrv,
2468 SLocBufferBlobAbbrv);
2469 }
2470 } else {
2471 // The source location entry is a macro expansion.
2472 const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
2473 SLocEntryOffsets.push_back(x: Offset);
2474 // Starting offset of this entry within this module, so skip the dummy.
2475 Record.push_back(Elt: getAdjustedOffset(Offset: SLoc->getOffset()) - 2);
2476 AddSourceLocation(Loc: Expansion.getSpellingLoc(), Record);
2477 AddSourceLocation(Loc: Expansion.getExpansionLocStart(), Record);
2478 AddSourceLocation(Loc: Expansion.isMacroArgExpansion()
2479 ? SourceLocation()
2480 : Expansion.getExpansionLocEnd(),
2481 Record);
2482 Record.push_back(Elt: Expansion.isExpansionTokenRange());
2483
2484 // Compute the token length for this macro expansion.
2485 SourceLocation::UIntTy NextOffset = SourceMgr.getNextLocalOffset();
2486 if (I + 1 != N)
2487 NextOffset = SourceMgr.getLocalSLocEntry(Index: I + 1).getOffset();
2488 Record.push_back(Elt: getAdjustedOffset(Offset: NextOffset - SLoc->getOffset()) - 1);
2489 Stream.EmitRecordWithAbbrev(Abbrev: SLocExpansionAbbrv, Vals: Record);
2490 }
2491 }
2492
2493 Stream.ExitBlock();
2494
2495 if (SLocEntryOffsets.empty())
2496 return;
2497
2498 // Write the source-location offsets table into the AST block. This
2499 // table is used for lazily loading source-location information.
2500 using namespace llvm;
2501
2502 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2503 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
2504 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
2505 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
2506 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // base offset
2507 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
2508 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
2509 {
2510 RecordData::value_type Record[] = {
2511 SOURCE_LOCATION_OFFSETS, SLocEntryOffsets.size(),
2512 getAdjustedOffset(Offset: SourceMgr.getNextLocalOffset()) - 1 /* skip dummy */,
2513 SLocEntryOffsetsBase - SourceManagerBlockOffset};
2514 Stream.EmitRecordWithBlob(Abbrev: SLocOffsetsAbbrev, Vals: Record,
2515 Blob: bytes(v: SLocEntryOffsets));
2516 }
2517
2518 // Write the line table. It depends on remapping working, so it must come
2519 // after the source location offsets.
2520 if (SourceMgr.hasLineTable()) {
2521 LineTableInfo &LineTable = SourceMgr.getLineTable();
2522
2523 Record.clear();
2524
2525 // Emit the needed file names.
2526 llvm::DenseMap<int, int> FilenameMap;
2527 FilenameMap[-1] = -1; // For unspecified filenames.
2528 for (const auto &L : LineTable) {
2529 if (L.first.ID < 0)
2530 continue;
2531 for (auto &LE : L.second) {
2532 if (FilenameMap.insert(KV: std::make_pair(x: LE.FilenameID,
2533 y: FilenameMap.size() - 1)).second)
2534 AddPath(Path: LineTable.getFilename(ID: LE.FilenameID), Record);
2535 }
2536 }
2537 Record.push_back(Elt: 0);
2538
2539 // Emit the line entries
2540 for (const auto &L : LineTable) {
2541 // Only emit entries for local files.
2542 if (L.first.ID < 0)
2543 continue;
2544
2545 AddFileID(FID: L.first, Record);
2546
2547 // Emit the line entries
2548 Record.push_back(Elt: L.second.size());
2549 for (const auto &LE : L.second) {
2550 Record.push_back(Elt: LE.FileOffset);
2551 Record.push_back(Elt: LE.LineNo);
2552 Record.push_back(Elt: FilenameMap[LE.FilenameID]);
2553 Record.push_back(Elt: (unsigned)LE.FileKind);
2554 Record.push_back(Elt: LE.IncludeOffset);
2555 }
2556 }
2557
2558 Stream.EmitRecord(Code: SOURCE_MANAGER_LINE_TABLE, Vals: Record);
2559 }
2560}
2561
2562//===----------------------------------------------------------------------===//
2563// Preprocessor Serialization
2564//===----------------------------------------------------------------------===//
2565
2566static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule,
2567 const Preprocessor &PP) {
2568 if (MacroInfo *MI = MD->getMacroInfo())
2569 if (MI->isBuiltinMacro())
2570 return true;
2571
2572 if (IsModule) {
2573 SourceLocation Loc = MD->getLocation();
2574 if (Loc.isInvalid())
2575 return true;
2576 if (PP.getSourceManager().getFileID(SpellingLoc: Loc) == PP.getPredefinesFileID())
2577 return true;
2578 }
2579
2580 return false;
2581}
2582
2583/// Writes the block containing the serialized form of the
2584/// preprocessor.
2585void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
2586 uint64_t MacroOffsetsBase = Stream.GetCurrentBitNo();
2587
2588 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
2589 if (PPRec)
2590 WritePreprocessorDetail(PPRec&: *PPRec, MacroOffsetsBase);
2591
2592 RecordData Record;
2593 RecordData ModuleMacroRecord;
2594
2595 // If the preprocessor __COUNTER__ value has been bumped, remember it.
2596 if (PP.getCounterValue() != 0) {
2597 RecordData::value_type Record[] = {PP.getCounterValue()};
2598 Stream.EmitRecord(Code: PP_COUNTER_VALUE, Vals: Record);
2599 }
2600
2601 // If we have a recorded #pragma assume_nonnull, remember it so it can be
2602 // replayed when the preamble terminates into the main file.
2603 SourceLocation AssumeNonNullLoc =
2604 PP.getPreambleRecordedPragmaAssumeNonNullLoc();
2605 if (AssumeNonNullLoc.isValid()) {
2606 assert(PP.isRecordingPreamble());
2607 AddSourceLocation(Loc: AssumeNonNullLoc, Record);
2608 Stream.EmitRecord(Code: PP_ASSUME_NONNULL_LOC, Vals: Record);
2609 Record.clear();
2610 }
2611
2612 if (PP.isRecordingPreamble() && PP.hasRecordedPreamble()) {
2613 assert(!IsModule);
2614 auto SkipInfo = PP.getPreambleSkipInfo();
2615 if (SkipInfo) {
2616 Record.push_back(Elt: true);
2617 AddSourceLocation(Loc: SkipInfo->HashTokenLoc, Record);
2618 AddSourceLocation(Loc: SkipInfo->IfTokenLoc, Record);
2619 Record.push_back(Elt: SkipInfo->FoundNonSkipPortion);
2620 Record.push_back(Elt: SkipInfo->FoundElse);
2621 AddSourceLocation(Loc: SkipInfo->ElseLoc, Record);
2622 } else {
2623 Record.push_back(Elt: false);
2624 }
2625 for (const auto &Cond : PP.getPreambleConditionalStack()) {
2626 AddSourceLocation(Loc: Cond.IfLoc, Record);
2627 Record.push_back(Elt: Cond.WasSkipping);
2628 Record.push_back(Elt: Cond.FoundNonSkip);
2629 Record.push_back(Elt: Cond.FoundElse);
2630 }
2631 Stream.EmitRecord(Code: PP_CONDITIONAL_STACK, Vals: Record);
2632 Record.clear();
2633 }
2634
2635 // Write the safe buffer opt-out region map in PP
2636 for (SourceLocation &S : PP.serializeSafeBufferOptOutMap())
2637 AddSourceLocation(Loc: S, Record);
2638 Stream.EmitRecord(Code: PP_UNSAFE_BUFFER_USAGE, Vals: Record);
2639 Record.clear();
2640
2641 // Enter the preprocessor block.
2642 Stream.EnterSubblock(BlockID: PREPROCESSOR_BLOCK_ID, CodeLen: 3);
2643
2644 // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
2645 // FIXME: Include a location for the use, and say which one was used.
2646 if (PP.SawDateOrTime())
2647 PP.Diag(Loc: SourceLocation(), DiagID: diag::warn_module_uses_date_time) << IsModule;
2648
2649 // Loop over all the macro directives that are live at the end of the file,
2650 // emitting each to the PP section.
2651
2652 // Construct the list of identifiers with macro directives that need to be
2653 // serialized.
2654 SmallVector<const IdentifierInfo *, 128> MacroIdentifiers;
2655 // It is meaningless to emit macros for named modules. It only wastes times
2656 // and spaces.
2657 if (!isWritingStdCXXNamedModules())
2658 for (auto &Id : PP.getIdentifierTable())
2659 if (Id.second->hadMacroDefinition() &&
2660 (!Id.second->isFromAST() ||
2661 Id.second->hasChangedSinceDeserialization()))
2662 MacroIdentifiers.push_back(Elt: Id.second);
2663 // Sort the set of macro definitions that need to be serialized by the
2664 // name of the macro, to provide a stable ordering.
2665 llvm::sort(C&: MacroIdentifiers, Comp: llvm::deref<std::less<>>());
2666
2667 // Emit the macro directives as a list and associate the offset with the
2668 // identifier they belong to.
2669 for (const IdentifierInfo *Name : MacroIdentifiers) {
2670 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(II: Name);
2671 uint64_t StartOffset = Stream.GetCurrentBitNo() - MacroOffsetsBase;
2672 assert((StartOffset >> 32) == 0 && "Macro identifiers offset too large");
2673
2674 // Write out any exported module macros.
2675 bool EmittedModuleMacros = false;
2676 // C+=20 Header Units are compiled module interfaces, but they preserve
2677 // macros that are live (i.e. have a defined value) at the end of the
2678 // compilation. So when writing a header unit, we preserve only the final
2679 // value of each macro (and discard any that are undefined). Header units
2680 // do not have sub-modules (although they might import other header units).
2681 // PCH files, conversely, retain the history of each macro's define/undef
2682 // and of leaf macros in sub modules.
2683 if (IsModule && WritingModule->isHeaderUnit()) {
2684 // This is for the main TU when it is a C++20 header unit.
2685 // We preserve the final state of defined macros, and we do not emit ones
2686 // that are undefined.
2687 if (!MD || shouldIgnoreMacro(MD, IsModule, PP) ||
2688 MD->getKind() == MacroDirective::MD_Undefine)
2689 continue;
2690 AddSourceLocation(Loc: MD->getLocation(), Record);
2691 Record.push_back(Elt: MD->getKind());
2692 if (auto *DefMD = dyn_cast<DefMacroDirective>(Val: MD)) {
2693 Record.push_back(Elt: getMacroRef(MI: DefMD->getInfo(), Name));
2694 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(Val: MD)) {
2695 Record.push_back(Elt: VisMD->isPublic());
2696 }
2697 ModuleMacroRecord.push_back(Elt: getSubmoduleID(Mod: WritingModule));
2698 AddMacroRef(MI: MD->getMacroInfo(), Name, Record&: ModuleMacroRecord);
2699 Stream.EmitRecord(Code: PP_MODULE_MACRO, Vals: ModuleMacroRecord);
2700 ModuleMacroRecord.clear();
2701 EmittedModuleMacros = true;
2702 } else {
2703 // Emit the macro directives in reverse source order.
2704 for (; MD; MD = MD->getPrevious()) {
2705 // Once we hit an ignored macro, we're done: the rest of the chain
2706 // will all be ignored macros.
2707 if (shouldIgnoreMacro(MD, IsModule, PP))
2708 break;
2709 AddSourceLocation(Loc: MD->getLocation(), Record);
2710 Record.push_back(Elt: MD->getKind());
2711 if (auto *DefMD = dyn_cast<DefMacroDirective>(Val: MD)) {
2712 Record.push_back(Elt: getMacroRef(MI: DefMD->getInfo(), Name));
2713 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(Val: MD)) {
2714 Record.push_back(Elt: VisMD->isPublic());
2715 }
2716 }
2717
2718 // We write out exported module macros for PCH as well.
2719 auto Leafs = PP.getLeafModuleMacros(II: Name);
2720 SmallVector<ModuleMacro *, 8> Worklist(Leafs);
2721 llvm::DenseMap<ModuleMacro *, unsigned> Visits;
2722 while (!Worklist.empty()) {
2723 auto *Macro = Worklist.pop_back_val();
2724
2725 // Emit a record indicating this submodule exports this macro.
2726 ModuleMacroRecord.push_back(Elt: getSubmoduleID(Mod: Macro->getOwningModule()));
2727 AddMacroRef(MI: Macro->getMacroInfo(), Name, Record&: ModuleMacroRecord);
2728 for (auto *M : Macro->overrides())
2729 ModuleMacroRecord.push_back(Elt: getSubmoduleID(Mod: M->getOwningModule()));
2730
2731 Stream.EmitRecord(Code: PP_MODULE_MACRO, Vals: ModuleMacroRecord);
2732 ModuleMacroRecord.clear();
2733
2734 // Enqueue overridden macros once we've visited all their ancestors.
2735 for (auto *M : Macro->overrides())
2736 if (++Visits[M] == M->getNumOverridingMacros())
2737 Worklist.push_back(Elt: M);
2738
2739 EmittedModuleMacros = true;
2740 }
2741 }
2742 if (Record.empty() && !EmittedModuleMacros)
2743 continue;
2744
2745 IdentMacroDirectivesOffsetMap[Name] = StartOffset;
2746 Stream.EmitRecord(Code: PP_MACRO_DIRECTIVE_HISTORY, Vals: Record);
2747 Record.clear();
2748 }
2749
2750 /// Offsets of each of the macros into the bitstream, indexed by
2751 /// the local macro ID
2752 ///
2753 /// For each identifier that is associated with a macro, this map
2754 /// provides the offset into the bitstream where that macro is
2755 /// defined.
2756 std::vector<uint32_t> MacroOffsets;
2757
2758 for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) {
2759 const IdentifierInfo *Name = MacroInfosToEmit[I].Name;
2760 MacroInfo *MI = MacroInfosToEmit[I].MI;
2761 MacroID ID = MacroInfosToEmit[I].ID;
2762
2763 if (ID < FirstMacroID) {
2764 assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?");
2765 continue;
2766 }
2767
2768 // Record the local offset of this macro.
2769 unsigned Index = ID - FirstMacroID;
2770 if (Index >= MacroOffsets.size())
2771 MacroOffsets.resize(new_size: Index + 1);
2772
2773 uint64_t Offset = Stream.GetCurrentBitNo() - MacroOffsetsBase;
2774 assert((Offset >> 32) == 0 && "Macro offset too large");
2775 MacroOffsets[Index] = Offset;
2776
2777 AddIdentifierRef(II: Name, Record);
2778 AddSourceLocation(Loc: MI->getDefinitionLoc(), Record);
2779 AddSourceLocation(Loc: MI->getDefinitionEndLoc(), Record);
2780 Record.push_back(Elt: MI->isUsed());
2781 Record.push_back(Elt: MI->isUsedForHeaderGuard());
2782 Record.push_back(Elt: MI->getNumTokens());
2783 unsigned Code;
2784 if (MI->isObjectLike()) {
2785 Code = PP_MACRO_OBJECT_LIKE;
2786 } else {
2787 Code = PP_MACRO_FUNCTION_LIKE;
2788
2789 Record.push_back(Elt: MI->isC99Varargs());
2790 Record.push_back(Elt: MI->isGNUVarargs());
2791 Record.push_back(Elt: MI->hasCommaPasting());
2792 Record.push_back(Elt: MI->getNumParams());
2793 for (const IdentifierInfo *Param : MI->params())
2794 AddIdentifierRef(II: Param, Record);
2795 }
2796
2797 // If we have a detailed preprocessing record, record the macro definition
2798 // ID that corresponds to this macro.
2799 if (PPRec)
2800 Record.push_back(Elt: MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2801
2802 Stream.EmitRecord(Code, Vals: Record);
2803 Record.clear();
2804
2805 // Emit the tokens array.
2806 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
2807 // Note that we know that the preprocessor does not have any annotation
2808 // tokens in it because they are created by the parser, and thus can't
2809 // be in a macro definition.
2810 const Token &Tok = MI->getReplacementToken(Tok: TokNo);
2811 AddToken(Tok, Record);
2812 Stream.EmitRecord(Code: PP_TOKEN, Vals: Record);
2813 Record.clear();
2814 }
2815 ++NumMacros;
2816 }
2817
2818 Stream.ExitBlock();
2819
2820 // Write the offsets table for macro IDs.
2821 using namespace llvm;
2822
2823 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2824 Abbrev->Add(OpInfo: BitCodeAbbrevOp(MACRO_OFFSET));
2825 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2826 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // base offset
2827 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2828
2829 unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
2830 {
2831 RecordData::value_type Record[] = {MACRO_OFFSET, MacroOffsets.size(),
2832 MacroOffsetsBase - ASTBlockStartOffset};
2833 Stream.EmitRecordWithBlob(Abbrev: MacroOffsetAbbrev, Vals: Record, Blob: bytes(v: MacroOffsets));
2834 }
2835}
2836
2837void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec,
2838 uint64_t MacroOffsetsBase) {
2839 if (PPRec.local_begin() == PPRec.local_end())
2840 return;
2841
2842 SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
2843
2844 // Enter the preprocessor block.
2845 Stream.EnterSubblock(BlockID: PREPROCESSOR_DETAIL_BLOCK_ID, CodeLen: 3);
2846
2847 // If the preprocessor has a preprocessing record, emit it.
2848 unsigned NumPreprocessingRecords = 0;
2849 using namespace llvm;
2850
2851 // Set up the abbreviation for
2852 unsigned InclusionAbbrev = 0;
2853 {
2854 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2855 Abbrev->Add(OpInfo: BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
2856 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2857 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2858 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
2859 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
2860 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2861 InclusionAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
2862 }
2863
2864 unsigned FirstPreprocessorEntityID = NUM_PREDEF_PP_ENTITY_IDS;
2865 unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
2866 RecordData Record;
2867 for (PreprocessingRecord::iterator E = PPRec.local_begin(),
2868 EEnd = PPRec.local_end();
2869 E != EEnd;
2870 (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
2871 Record.clear();
2872
2873 uint64_t Offset = Stream.GetCurrentBitNo() - MacroOffsetsBase;
2874 assert((Offset >> 32) == 0 && "Preprocessed entity offset too large");
2875 SourceRange R = getAdjustedRange(Range: (*E)->getSourceRange());
2876 PreprocessedEntityOffsets.emplace_back(
2877 Args: getRawSourceLocationEncoding(Loc: R.getBegin()),
2878 Args: getRawSourceLocationEncoding(Loc: R.getEnd()), Args&: Offset);
2879
2880 if (auto *MD = dyn_cast<MacroDefinitionRecord>(Val: *E)) {
2881 // Record this macro definition's ID.
2882 MacroDefinitions[MD] = NextPreprocessorEntityID;
2883
2884 AddIdentifierRef(II: MD->getName(), Record);
2885 Stream.EmitRecord(Code: PPD_MACRO_DEFINITION, Vals: Record);
2886 continue;
2887 }
2888
2889 if (auto *ME = dyn_cast<MacroExpansion>(Val: *E)) {
2890 Record.push_back(Elt: ME->isBuiltinMacro());
2891 if (ME->isBuiltinMacro())
2892 AddIdentifierRef(II: ME->getName(), Record);
2893 else
2894 Record.push_back(Elt: MacroDefinitions[ME->getDefinition()]);
2895 Stream.EmitRecord(Code: PPD_MACRO_EXPANSION, Vals: Record);
2896 continue;
2897 }
2898
2899 if (auto *ID = dyn_cast<InclusionDirective>(Val: *E)) {
2900 Record.push_back(Elt: PPD_INCLUSION_DIRECTIVE);
2901 Record.push_back(Elt: ID->getFileName().size());
2902 Record.push_back(Elt: ID->wasInQuotes());
2903 Record.push_back(Elt: static_cast<unsigned>(ID->getKind()));
2904 Record.push_back(Elt: ID->importedModule());
2905 SmallString<64> Buffer;
2906 Buffer += ID->getFileName();
2907 // Check that the FileEntry is not null because it was not resolved and
2908 // we create a PCH even with compiler errors.
2909 if (ID->getFile())
2910 Buffer += ID->getFile()->getName();
2911 Stream.EmitRecordWithBlob(Abbrev: InclusionAbbrev, Vals: Record, Blob: Buffer);
2912 continue;
2913 }
2914
2915 llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
2916 }
2917 Stream.ExitBlock();
2918
2919 // Write the offsets table for the preprocessing record.
2920 if (NumPreprocessingRecords > 0) {
2921 assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
2922
2923 // Write the offsets table for identifier IDs.
2924 using namespace llvm;
2925
2926 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2927 Abbrev->Add(OpInfo: BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
2928 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2929 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
2930
2931 RecordData::value_type Record[] = {PPD_ENTITIES_OFFSETS};
2932 Stream.EmitRecordWithBlob(Abbrev: PPEOffsetAbbrev, Vals: Record,
2933 Blob: bytes(v: PreprocessedEntityOffsets));
2934 }
2935
2936 // Write the skipped region table for the preprocessing record.
2937 ArrayRef<SourceRange> SkippedRanges = PPRec.getSkippedRanges();
2938 if (SkippedRanges.size() > 0) {
2939 std::vector<PPSkippedRange> SerializedSkippedRanges;
2940 SerializedSkippedRanges.reserve(n: SkippedRanges.size());
2941 for (auto const& Range : SkippedRanges)
2942 SerializedSkippedRanges.emplace_back(
2943 args: getRawSourceLocationEncoding(Loc: Range.getBegin()),
2944 args: getRawSourceLocationEncoding(Loc: Range.getEnd()));
2945
2946 using namespace llvm;
2947 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2948 Abbrev->Add(OpInfo: BitCodeAbbrevOp(PPD_SKIPPED_RANGES));
2949 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2950 unsigned PPESkippedRangeAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
2951
2952 Record.clear();
2953 Record.push_back(Elt: PPD_SKIPPED_RANGES);
2954 Stream.EmitRecordWithBlob(Abbrev: PPESkippedRangeAbbrev, Vals: Record,
2955 Blob: bytes(v: SerializedSkippedRanges));
2956 }
2957}
2958
2959unsigned ASTWriter::getLocalOrImportedSubmoduleID(const Module *Mod) {
2960 if (!Mod)
2961 return 0;
2962
2963 auto Known = SubmoduleIDs.find(Val: Mod);
2964 if (Known != SubmoduleIDs.end())
2965 return Known->second;
2966
2967 auto *Top = Mod->getTopLevelModule();
2968 if (Top != WritingModule &&
2969 (getLangOpts().CompilingPCH ||
2970 !Top->fullModuleNameIs(nameParts: StringRef(getLangOpts().CurrentModule))))
2971 return 0;
2972
2973 return SubmoduleIDs[Mod] = NextSubmoduleID++;
2974}
2975
2976unsigned ASTWriter::getSubmoduleID(Module *Mod) {
2977 unsigned ID = getLocalOrImportedSubmoduleID(Mod);
2978 // FIXME: This can easily happen, if we have a reference to a submodule that
2979 // did not result in us loading a module file for that submodule. For
2980 // instance, a cross-top-level-module 'conflict' declaration will hit this.
2981 // assert((ID || !Mod) &&
2982 // "asked for module ID for non-local, non-imported module");
2983 return ID;
2984}
2985
2986/// Compute the number of modules within the given tree (including the
2987/// given module).
2988static unsigned getNumberOfModules(Module *Mod) {
2989 unsigned ChildModules = 0;
2990 for (auto *Submodule : Mod->submodules())
2991 ChildModules += getNumberOfModules(Mod: Submodule);
2992
2993 return ChildModules + 1;
2994}
2995
2996void ASTWriter::WriteSubmodules(Module *WritingModule, ASTContext *Context) {
2997 // Enter the submodule description block.
2998 Stream.EnterSubblock(BlockID: SUBMODULE_BLOCK_ID, /*bits for abbreviations*/CodeLen: 5);
2999
3000 // Write the abbreviations needed for the submodules block.
3001 using namespace llvm;
3002
3003 auto Abbrev = std::make_shared<BitCodeAbbrev>();
3004 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SUBMODULE_DEFINITION));
3005 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
3006 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
3007 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // Kind
3008 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Definition location
3009 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // Inferred allowed by
3010 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
3011 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
3012 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
3013 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
3014 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
3015 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
3016 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
3017 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
3018 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ModuleMapIsPriv...
3019 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // NamedModuleHasN...
3020 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3021 unsigned DefinitionAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3022
3023 Abbrev = std::make_shared<BitCodeAbbrev>();
3024 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
3025 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3026 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3027
3028 Abbrev = std::make_shared<BitCodeAbbrev>();
3029 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SUBMODULE_HEADER));
3030 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3031 unsigned HeaderAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3032
3033 Abbrev = std::make_shared<BitCodeAbbrev>();
3034 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
3035 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3036 unsigned TopHeaderAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3037
3038 Abbrev = std::make_shared<BitCodeAbbrev>();
3039 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
3040 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3041 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3042
3043 Abbrev = std::make_shared<BitCodeAbbrev>();
3044 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SUBMODULE_REQUIRES));
3045 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
3046 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Feature
3047 unsigned RequiresAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3048
3049 Abbrev = std::make_shared<BitCodeAbbrev>();
3050 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
3051 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3052 unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3053
3054 Abbrev = std::make_shared<BitCodeAbbrev>();
3055 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
3056 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3057 unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3058
3059 Abbrev = std::make_shared<BitCodeAbbrev>();
3060 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
3061 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3062 unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3063
3064 Abbrev = std::make_shared<BitCodeAbbrev>();
3065 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
3066 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3067 unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3068
3069 Abbrev = std::make_shared<BitCodeAbbrev>();
3070 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
3071 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
3072 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3073 unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3074
3075 Abbrev = std::make_shared<BitCodeAbbrev>();
3076 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
3077 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
3078 unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3079
3080 Abbrev = std::make_shared<BitCodeAbbrev>();
3081 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SUBMODULE_CONFLICT));
3082 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Other module
3083 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Message
3084 unsigned ConflictAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3085
3086 Abbrev = std::make_shared<BitCodeAbbrev>();
3087 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SUBMODULE_EXPORT_AS));
3088 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
3089 unsigned ExportAsAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3090
3091 // Write the submodule metadata block.
3092 RecordData::value_type Record[] = {
3093 getNumberOfModules(Mod: WritingModule),
3094 FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS};
3095 Stream.EmitRecord(Code: SUBMODULE_METADATA, Vals: Record);
3096
3097 // Write all of the submodules.
3098 std::queue<Module *> Q;
3099 Q.push(x: WritingModule);
3100 while (!Q.empty()) {
3101 Module *Mod = Q.front();
3102 Q.pop();
3103 unsigned ID = getSubmoduleID(Mod);
3104
3105 uint64_t ParentID = 0;
3106 if (Mod->Parent) {
3107 assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
3108 ParentID = SubmoduleIDs[Mod->Parent];
3109 }
3110
3111 SourceLocationEncoding::RawLocEncoding DefinitionLoc =
3112 getRawSourceLocationEncoding(Loc: getAdjustedLocation(Loc: Mod->DefinitionLoc));
3113
3114 ModuleMap &ModMap = PP->getHeaderSearchInfo().getModuleMap();
3115 FileID UnadjustedInferredFID;
3116 if (Mod->IsInferred)
3117 UnadjustedInferredFID = ModMap.getModuleMapFileIDForUniquing(M: Mod);
3118 int InferredFID = getAdjustedFileID(FID: UnadjustedInferredFID).getOpaqueValue();
3119
3120 // Emit the definition of the block.
3121 {
3122 RecordData::value_type Record[] = {SUBMODULE_DEFINITION,
3123 ID,
3124 ParentID,
3125 (RecordData::value_type)Mod->Kind,
3126 DefinitionLoc,
3127 (RecordData::value_type)InferredFID,
3128 Mod->IsFramework,
3129 Mod->IsExplicit,
3130 Mod->IsSystem,
3131 Mod->IsExternC,
3132 Mod->InferSubmodules,
3133 Mod->InferExplicitSubmodules,
3134 Mod->InferExportWildcard,
3135 Mod->ConfigMacrosExhaustive,
3136 Mod->ModuleMapIsPrivate,
3137 Mod->NamedModuleHasInit};
3138 Stream.EmitRecordWithBlob(Abbrev: DefinitionAbbrev, Vals: Record, Blob: Mod->Name);
3139 }
3140
3141 // Emit the requirements.
3142 for (const auto &R : Mod->Requirements) {
3143 RecordData::value_type Record[] = {SUBMODULE_REQUIRES, R.RequiredState};
3144 Stream.EmitRecordWithBlob(Abbrev: RequiresAbbrev, Vals: Record, Blob: R.FeatureName);
3145 }
3146
3147 // Emit the umbrella header, if there is one.
3148 if (std::optional<Module::Header> UmbrellaHeader =
3149 Mod->getUmbrellaHeaderAsWritten()) {
3150 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_HEADER};
3151 Stream.EmitRecordWithBlob(Abbrev: UmbrellaAbbrev, Vals: Record,
3152 Blob: UmbrellaHeader->NameAsWritten);
3153 } else if (std::optional<Module::DirectoryName> UmbrellaDir =
3154 Mod->getUmbrellaDirAsWritten()) {
3155 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_DIR};
3156 Stream.EmitRecordWithBlob(Abbrev: UmbrellaDirAbbrev, Vals: Record,
3157 Blob: UmbrellaDir->NameAsWritten);
3158 }
3159
3160 // Emit the headers.
3161 struct {
3162 unsigned RecordKind;
3163 unsigned Abbrev;
3164 Module::HeaderKind HeaderKind;
3165 } HeaderLists[] = {
3166 {.RecordKind: SUBMODULE_HEADER, .Abbrev: HeaderAbbrev, .HeaderKind: Module::HK_Normal},
3167 {.RecordKind: SUBMODULE_TEXTUAL_HEADER, .Abbrev: TextualHeaderAbbrev, .HeaderKind: Module::HK_Textual},
3168 {.RecordKind: SUBMODULE_PRIVATE_HEADER, .Abbrev: PrivateHeaderAbbrev, .HeaderKind: Module::HK_Private},
3169 {.RecordKind: SUBMODULE_PRIVATE_TEXTUAL_HEADER, .Abbrev: PrivateTextualHeaderAbbrev,
3170 .HeaderKind: Module::HK_PrivateTextual},
3171 {.RecordKind: SUBMODULE_EXCLUDED_HEADER, .Abbrev: ExcludedHeaderAbbrev, .HeaderKind: Module::HK_Excluded}
3172 };
3173 for (const auto &HL : HeaderLists) {
3174 RecordData::value_type Record[] = {HL.RecordKind};
3175 for (const auto &H : Mod->getHeaders(HK: HL.HeaderKind))
3176 Stream.EmitRecordWithBlob(Abbrev: HL.Abbrev, Vals: Record, Blob: H.NameAsWritten);
3177 }
3178
3179 // Emit the top headers.
3180 {
3181 RecordData::value_type Record[] = {SUBMODULE_TOPHEADER};
3182 for (FileEntryRef H : Mod->getTopHeaders(FileMgr&: PP->getFileManager())) {
3183 SmallString<128> HeaderName(H.getName());
3184 PreparePathForOutput(Path&: HeaderName);
3185 Stream.EmitRecordWithBlob(Abbrev: TopHeaderAbbrev, Vals: Record, Blob: HeaderName);
3186 }
3187 }
3188
3189 // Emit the imports.
3190 if (!Mod->Imports.empty()) {
3191 RecordData Record;
3192 for (auto *I : Mod->Imports)
3193 Record.push_back(Elt: getSubmoduleID(Mod: I));
3194 Stream.EmitRecord(Code: SUBMODULE_IMPORTS, Vals: Record);
3195 }
3196
3197 // Emit the modules affecting compilation that were not imported.
3198 if (!Mod->AffectingClangModules.empty()) {
3199 RecordData Record;
3200 for (auto *I : Mod->AffectingClangModules)
3201 Record.push_back(Elt: getSubmoduleID(Mod: I));
3202 Stream.EmitRecord(Code: SUBMODULE_AFFECTING_MODULES, Vals: Record);
3203 }
3204
3205 // Emit the exports.
3206 if (!Mod->Exports.empty()) {
3207 RecordData Record;
3208 for (const auto &E : Mod->Exports) {
3209 // FIXME: This may fail; we don't require that all exported modules
3210 // are local or imported.
3211 Record.push_back(Elt: getSubmoduleID(Mod: E.getPointer()));
3212 Record.push_back(Elt: E.getInt());
3213 }
3214 Stream.EmitRecord(Code: SUBMODULE_EXPORTS, Vals: Record);
3215 }
3216
3217 //FIXME: How do we emit the 'use'd modules? They may not be submodules.
3218 // Might be unnecessary as use declarations are only used to build the
3219 // module itself.
3220
3221 // TODO: Consider serializing undeclared uses of modules.
3222
3223 // Emit the link libraries.
3224 for (const auto &LL : Mod->LinkLibraries) {
3225 RecordData::value_type Record[] = {SUBMODULE_LINK_LIBRARY,
3226 LL.IsFramework};
3227 Stream.EmitRecordWithBlob(Abbrev: LinkLibraryAbbrev, Vals: Record, Blob: LL.Library);
3228 }
3229
3230 // Emit the conflicts.
3231 for (const auto &C : Mod->Conflicts) {
3232 // FIXME: This may fail; we don't require that all conflicting modules
3233 // are local or imported.
3234 RecordData::value_type Record[] = {SUBMODULE_CONFLICT,
3235 getSubmoduleID(Mod: C.Other)};
3236 Stream.EmitRecordWithBlob(Abbrev: ConflictAbbrev, Vals: Record, Blob: C.Message);
3237 }
3238
3239 // Emit the configuration macros.
3240 for (const auto &CM : Mod->ConfigMacros) {
3241 RecordData::value_type Record[] = {SUBMODULE_CONFIG_MACRO};
3242 Stream.EmitRecordWithBlob(Abbrev: ConfigMacroAbbrev, Vals: Record, Blob: CM);
3243 }
3244
3245 // Emit the reachable initializers.
3246 // The initializer may only be unreachable in reduced BMI.
3247 if (Context && !GeneratingReducedBMI) {
3248 RecordData Inits;
3249 for (Decl *D : Context->getModuleInitializers(M: Mod))
3250 if (wasDeclEmitted(D))
3251 AddDeclRef(D, Record&: Inits);
3252 if (!Inits.empty())
3253 Stream.EmitRecord(Code: SUBMODULE_INITIALIZERS, Vals: Inits);
3254 }
3255
3256 // Emit the name of the re-exported module, if any.
3257 if (!Mod->ExportAsModule.empty()) {
3258 RecordData::value_type Record[] = {SUBMODULE_EXPORT_AS};
3259 Stream.EmitRecordWithBlob(Abbrev: ExportAsAbbrev, Vals: Record, Blob: Mod->ExportAsModule);
3260 }
3261
3262 // Queue up the submodules of this module.
3263 for (auto *M : Mod->submodules())
3264 Q.push(x: M);
3265 }
3266
3267 Stream.ExitBlock();
3268
3269 assert((NextSubmoduleID - FirstSubmoduleID ==
3270 getNumberOfModules(WritingModule)) &&
3271 "Wrong # of submodules; found a reference to a non-local, "
3272 "non-imported submodule?");
3273}
3274
3275void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
3276 bool isModule) {
3277 llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64>
3278 DiagStateIDMap;
3279 unsigned CurrID = 0;
3280 RecordData Record;
3281
3282 auto EncodeDiagStateFlags =
3283 [](const DiagnosticsEngine::DiagState *DS) -> unsigned {
3284 unsigned Result = (unsigned)DS->ExtBehavior;
3285 for (unsigned Val :
3286 {(unsigned)DS->IgnoreAllWarnings, (unsigned)DS->EnableAllWarnings,
3287 (unsigned)DS->WarningsAsErrors, (unsigned)DS->ErrorsAsFatal,
3288 (unsigned)DS->SuppressSystemWarnings})
3289 Result = (Result << 1) | Val;
3290 return Result;
3291 };
3292
3293 unsigned Flags = EncodeDiagStateFlags(Diag.DiagStatesByLoc.FirstDiagState);
3294 Record.push_back(Elt: Flags);
3295
3296 auto AddDiagState = [&](const DiagnosticsEngine::DiagState *State,
3297 bool IncludeNonPragmaStates) {
3298 // Ensure that the diagnostic state wasn't modified since it was created.
3299 // We will not correctly round-trip this information otherwise.
3300 assert(Flags == EncodeDiagStateFlags(State) &&
3301 "diag state flags vary in single AST file");
3302
3303 // If we ever serialize non-pragma mappings outside the initial state, the
3304 // code below will need to consider more than getDefaultMapping.
3305 assert(!IncludeNonPragmaStates ||
3306 State == Diag.DiagStatesByLoc.FirstDiagState);
3307
3308 unsigned &DiagStateID = DiagStateIDMap[State];
3309 Record.push_back(Elt: DiagStateID);
3310
3311 if (DiagStateID == 0) {
3312 DiagStateID = ++CurrID;
3313 SmallVector<std::pair<unsigned, DiagnosticMapping>> Mappings;
3314
3315 // Add a placeholder for the number of mappings.
3316 auto SizeIdx = Record.size();
3317 Record.emplace_back();
3318 for (const auto &I : *State) {
3319 // Maybe skip non-pragmas.
3320 if (!I.second.isPragma() && !IncludeNonPragmaStates)
3321 continue;
3322 // Skip default mappings. We have a mapping for every diagnostic ever
3323 // emitted, regardless of whether it was customized.
3324 if (!I.second.isPragma() &&
3325 I.second == Diag.getDiagnosticIDs()->getDefaultMapping(DiagID: I.first))
3326 continue;
3327 Mappings.push_back(Elt: I);
3328 }
3329
3330 // Sort by diag::kind for deterministic output.
3331 llvm::sort(C&: Mappings, Comp: llvm::less_first());
3332
3333 for (const auto &I : Mappings) {
3334 Record.push_back(Elt: I.first);
3335 Record.push_back(Elt: I.second.serialize());
3336 }
3337 // Update the placeholder.
3338 Record[SizeIdx] = (Record.size() - SizeIdx) / 2;
3339 }
3340 };
3341
3342 AddDiagState(Diag.DiagStatesByLoc.FirstDiagState, isModule);
3343
3344 // Reserve a spot for the number of locations with state transitions.
3345 auto NumLocationsIdx = Record.size();
3346 Record.emplace_back();
3347
3348 // Emit the state transitions.
3349 unsigned NumLocations = 0;
3350 for (auto &FileIDAndFile : Diag.DiagStatesByLoc.Files) {
3351 if (!FileIDAndFile.first.isValid() ||
3352 !FileIDAndFile.second.HasLocalTransitions)
3353 continue;
3354 ++NumLocations;
3355
3356 AddFileID(FID: FileIDAndFile.first, Record);
3357
3358 Record.push_back(Elt: FileIDAndFile.second.StateTransitions.size());
3359 for (auto &StatePoint : FileIDAndFile.second.StateTransitions) {
3360 Record.push_back(Elt: getAdjustedOffset(Offset: StatePoint.Offset));
3361 AddDiagState(StatePoint.State, false);
3362 }
3363 }
3364
3365 // Backpatch the number of locations.
3366 Record[NumLocationsIdx] = NumLocations;
3367
3368 // Emit CurDiagStateLoc. Do it last in order to match source order.
3369 //
3370 // This also protects against a hypothetical corner case with simulating
3371 // -Werror settings for implicit modules in the ASTReader, where reading
3372 // CurDiagState out of context could change whether warning pragmas are
3373 // treated as errors.
3374 AddSourceLocation(Loc: Diag.DiagStatesByLoc.CurDiagStateLoc, Record);
3375 AddDiagState(Diag.DiagStatesByLoc.CurDiagState, false);
3376
3377 Stream.EmitRecord(Code: DIAG_PRAGMA_MAPPINGS, Vals: Record);
3378}
3379
3380//===----------------------------------------------------------------------===//
3381// Type Serialization
3382//===----------------------------------------------------------------------===//
3383
3384/// Write the representation of a type to the AST stream.
3385void ASTWriter::WriteType(ASTContext &Context, QualType T) {
3386 TypeIdx &IdxRef = TypeIdxs[T];
3387 if (IdxRef.getValue() == 0) // we haven't seen this type before.
3388 IdxRef = TypeIdx(0, NextTypeID++);
3389 TypeIdx Idx = IdxRef;
3390
3391 assert(Idx.getModuleFileIndex() == 0 && "Re-writing a type from a prior AST");
3392 assert(Idx.getValue() >= FirstTypeID && "Writing predefined type");
3393
3394 // Emit the type's representation.
3395 uint64_t Offset =
3396 ASTTypeWriter(Context, *this).write(T) - DeclTypesBlockStartOffset;
3397
3398 // Record the offset for this type.
3399 uint64_t Index = Idx.getValue() - FirstTypeID;
3400 if (TypeOffsets.size() == Index)
3401 TypeOffsets.emplace_back(args&: Offset);
3402 else if (TypeOffsets.size() < Index) {
3403 TypeOffsets.resize(new_size: Index + 1);
3404 TypeOffsets[Index].set(Offset);
3405 } else {
3406 llvm_unreachable("Types emitted in wrong order");
3407 }
3408}
3409
3410//===----------------------------------------------------------------------===//
3411// Declaration Serialization
3412//===----------------------------------------------------------------------===//
3413
3414static bool IsInternalDeclFromFileContext(const Decl *D) {
3415 auto *ND = dyn_cast<NamedDecl>(Val: D);
3416 if (!ND)
3417 return false;
3418
3419 if (!D->getDeclContext()->getRedeclContext()->isFileContext())
3420 return false;
3421
3422 return ND->getFormalLinkage() == Linkage::Internal;
3423}
3424
3425/// Write the block containing all of the declaration IDs
3426/// lexically declared within the given DeclContext.
3427///
3428/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
3429/// bitstream, or 0 if no block was written.
3430uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
3431 const DeclContext *DC) {
3432 if (DC->decls_empty())
3433 return 0;
3434
3435 // In reduced BMI, we don't care the declarations in functions.
3436 if (GeneratingReducedBMI && DC->isFunctionOrMethod())
3437 return 0;
3438
3439 uint64_t Offset = Stream.GetCurrentBitNo();
3440 SmallVector<DeclID, 128> KindDeclPairs;
3441 for (const auto *D : DC->decls()) {
3442 if (DoneWritingDeclsAndTypes && !wasDeclEmitted(D))
3443 continue;
3444
3445 // We don't need to write decls with internal linkage into reduced BMI.
3446 // If such decls gets emitted due to it get used from inline functions,
3447 // the program illegal. However, there are too many use of static inline
3448 // functions in the global module fragment and it will be breaking change
3449 // to forbid that. So we have to allow to emit such declarations from GMF.
3450 if (GeneratingReducedBMI && !D->isFromExplicitGlobalModule() &&
3451 IsInternalDeclFromFileContext(D))
3452 continue;
3453
3454 KindDeclPairs.push_back(Elt: D->getKind());
3455 KindDeclPairs.push_back(Elt: GetDeclRef(D).getRawValue());
3456 }
3457
3458 ++NumLexicalDeclContexts;
3459 RecordData::value_type Record[] = {DECL_CONTEXT_LEXICAL};
3460 Stream.EmitRecordWithBlob(Abbrev: DeclContextLexicalAbbrev, Vals: Record,
3461 Blob: bytes(v: KindDeclPairs));
3462 return Offset;
3463}
3464
3465void ASTWriter::WriteTypeDeclOffsets() {
3466 using namespace llvm;
3467
3468 // Write the type offsets array
3469 auto Abbrev = std::make_shared<BitCodeAbbrev>();
3470 Abbrev->Add(OpInfo: BitCodeAbbrevOp(TYPE_OFFSET));
3471 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
3472 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
3473 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3474 {
3475 RecordData::value_type Record[] = {TYPE_OFFSET, TypeOffsets.size()};
3476 Stream.EmitRecordWithBlob(Abbrev: TypeOffsetAbbrev, Vals: Record, Blob: bytes(v: TypeOffsets));
3477 }
3478
3479 // Write the declaration offsets array
3480 Abbrev = std::make_shared<BitCodeAbbrev>();
3481 Abbrev->Add(OpInfo: BitCodeAbbrevOp(DECL_OFFSET));
3482 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
3483 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
3484 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3485 {
3486 RecordData::value_type Record[] = {DECL_OFFSET, DeclOffsets.size()};
3487 Stream.EmitRecordWithBlob(Abbrev: DeclOffsetAbbrev, Vals: Record, Blob: bytes(v: DeclOffsets));
3488 }
3489}
3490
3491void ASTWriter::WriteFileDeclIDsMap() {
3492 using namespace llvm;
3493
3494 SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs;
3495 SortedFileDeclIDs.reserve(N: FileDeclIDs.size());
3496 for (const auto &P : FileDeclIDs)
3497 SortedFileDeclIDs.push_back(Elt: std::make_pair(x: P.first, y: P.second.get()));
3498 llvm::sort(C&: SortedFileDeclIDs, Comp: llvm::less_first());
3499
3500 // Join the vectors of DeclIDs from all files.
3501 SmallVector<DeclID, 256> FileGroupedDeclIDs;
3502 for (auto &FileDeclEntry : SortedFileDeclIDs) {
3503 DeclIDInFileInfo &Info = *FileDeclEntry.second;
3504 Info.FirstDeclIndex = FileGroupedDeclIDs.size();
3505 llvm::stable_sort(Range&: Info.DeclIDs);
3506 for (auto &LocDeclEntry : Info.DeclIDs)
3507 FileGroupedDeclIDs.push_back(Elt: LocDeclEntry.second.getRawValue());
3508 }
3509
3510 auto Abbrev = std::make_shared<BitCodeAbbrev>();
3511 Abbrev->Add(OpInfo: BitCodeAbbrevOp(FILE_SORTED_DECLS));
3512 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
3513 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3514 unsigned AbbrevCode = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3515 RecordData::value_type Record[] = {FILE_SORTED_DECLS,
3516 FileGroupedDeclIDs.size()};
3517 Stream.EmitRecordWithBlob(Abbrev: AbbrevCode, Vals: Record, Blob: bytes(v: FileGroupedDeclIDs));
3518}
3519
3520void ASTWriter::WriteComments(ASTContext &Context) {
3521 Stream.EnterSubblock(BlockID: COMMENTS_BLOCK_ID, CodeLen: 3);
3522 llvm::scope_exit _([this] { Stream.ExitBlock(); });
3523 if (!PP->getPreprocessorOpts().WriteCommentListToPCH)
3524 return;
3525
3526 // Don't write comments to BMI to reduce the size of BMI.
3527 // If language services (e.g., clangd) want such abilities,
3528 // we can offer a special option then.
3529 if (isWritingStdCXXNamedModules())
3530 return;
3531
3532 RecordData Record;
3533 for (const auto &FO : Context.Comments.OrderedComments) {
3534 for (const auto &OC : FO.second) {
3535 const RawComment *I = OC.second;
3536 Record.clear();
3537 AddSourceRange(Range: I->getSourceRange(), Record);
3538 Record.push_back(Elt: I->getKind());
3539 Record.push_back(Elt: I->isTrailingComment());
3540 Record.push_back(Elt: I->isAlmostTrailingComment());
3541 Stream.EmitRecord(Code: COMMENTS_RAW_COMMENT, Vals: Record);
3542 }
3543 }
3544}
3545
3546//===----------------------------------------------------------------------===//
3547// Global Method Pool and Selector Serialization
3548//===----------------------------------------------------------------------===//
3549
3550namespace {
3551
3552// Trait used for the on-disk hash table used in the method pool.
3553class ASTMethodPoolTrait {
3554 ASTWriter &Writer;
3555
3556public:
3557 using key_type = Selector;
3558 using key_type_ref = key_type;
3559
3560 struct data_type {
3561 SelectorID ID;
3562 ObjCMethodList Instance, Factory;
3563 };
3564 using data_type_ref = const data_type &;
3565
3566 using hash_value_type = unsigned;
3567 using offset_type = unsigned;
3568
3569 explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) {}
3570
3571 static hash_value_type ComputeHash(Selector Sel) {
3572 return serialization::ComputeHash(Sel);
3573 }
3574
3575 std::pair<unsigned, unsigned>
3576 EmitKeyDataLength(raw_ostream& Out, Selector Sel,
3577 data_type_ref Methods) {
3578 unsigned KeyLen =
3579 2 + (Sel.getNumArgs() ? Sel.getNumArgs() * sizeof(IdentifierID)
3580 : sizeof(IdentifierID));
3581 unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
3582 for (const ObjCMethodList *Method = &Methods.Instance; Method;
3583 Method = Method->getNext())
3584 if (ShouldWriteMethodListNode(Node: Method))
3585 DataLen += sizeof(DeclID);
3586 for (const ObjCMethodList *Method = &Methods.Factory; Method;
3587 Method = Method->getNext())
3588 if (ShouldWriteMethodListNode(Node: Method))
3589 DataLen += sizeof(DeclID);
3590 return emitULEBKeyDataLength(KeyLen, DataLen, Out);
3591 }
3592
3593 void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
3594 using namespace llvm::support;
3595
3596 endian::Writer LE(Out, llvm::endianness::little);
3597 uint64_t Start = Out.tell();
3598 assert((Start >> 32) == 0 && "Selector key offset too large");
3599 Writer.SetSelectorOffset(Sel, Offset: Start);
3600 unsigned N = Sel.getNumArgs();
3601 LE.write<uint16_t>(Val: N);
3602 if (N == 0)
3603 N = 1;
3604 for (unsigned I = 0; I != N; ++I)
3605 LE.write<IdentifierID>(
3606 Val: Writer.getIdentifierRef(II: Sel.getIdentifierInfoForSlot(argIndex: I)));
3607 }
3608
3609 void EmitData(raw_ostream& Out, key_type_ref,
3610 data_type_ref Methods, unsigned DataLen) {
3611 using namespace llvm::support;
3612
3613 endian::Writer LE(Out, llvm::endianness::little);
3614 uint64_t Start = Out.tell(); (void)Start;
3615 LE.write<uint32_t>(Val: Methods.ID);
3616 unsigned NumInstanceMethods = 0;
3617 for (const ObjCMethodList *Method = &Methods.Instance; Method;
3618 Method = Method->getNext())
3619 if (ShouldWriteMethodListNode(Node: Method))
3620 ++NumInstanceMethods;
3621
3622 unsigned NumFactoryMethods = 0;
3623 for (const ObjCMethodList *Method = &Methods.Factory; Method;
3624 Method = Method->getNext())
3625 if (ShouldWriteMethodListNode(Node: Method))
3626 ++NumFactoryMethods;
3627
3628 unsigned InstanceBits = Methods.Instance.getBits();
3629 assert(InstanceBits < 4);
3630 unsigned InstanceHasMoreThanOneDeclBit =
3631 Methods.Instance.hasMoreThanOneDecl();
3632 unsigned FullInstanceBits = (NumInstanceMethods << 3) |
3633 (InstanceHasMoreThanOneDeclBit << 2) |
3634 InstanceBits;
3635 unsigned FactoryBits = Methods.Factory.getBits();
3636 assert(FactoryBits < 4);
3637 unsigned FactoryHasMoreThanOneDeclBit =
3638 Methods.Factory.hasMoreThanOneDecl();
3639 unsigned FullFactoryBits = (NumFactoryMethods << 3) |
3640 (FactoryHasMoreThanOneDeclBit << 2) |
3641 FactoryBits;
3642 LE.write<uint16_t>(Val: FullInstanceBits);
3643 LE.write<uint16_t>(Val: FullFactoryBits);
3644 for (const ObjCMethodList *Method = &Methods.Instance; Method;
3645 Method = Method->getNext())
3646 if (ShouldWriteMethodListNode(Node: Method))
3647 LE.write<DeclID>(Val: (DeclID)Writer.getDeclID(D: Method->getMethod()));
3648 for (const ObjCMethodList *Method = &Methods.Factory; Method;
3649 Method = Method->getNext())
3650 if (ShouldWriteMethodListNode(Node: Method))
3651 LE.write<DeclID>(Val: (DeclID)Writer.getDeclID(D: Method->getMethod()));
3652
3653 assert(Out.tell() - Start == DataLen && "Data length is wrong");
3654 }
3655
3656private:
3657 static bool ShouldWriteMethodListNode(const ObjCMethodList *Node) {
3658 return (Node->getMethod() && !Node->getMethod()->isFromASTFile());
3659 }
3660};
3661
3662} // namespace
3663
3664/// Write ObjC data: selectors and the method pool.
3665///
3666/// The method pool contains both instance and factory methods, stored
3667/// in an on-disk hash table indexed by the selector. The hash table also
3668/// contains an empty entry for every other selector known to Sema.
3669void ASTWriter::WriteSelectors(Sema &SemaRef) {
3670 using namespace llvm;
3671
3672 // Do we have to do anything at all?
3673 if (SemaRef.ObjC().MethodPool.empty() && SelectorIDs.empty())
3674 return;
3675 unsigned NumTableEntries = 0;
3676 // Create and write out the blob that contains selectors and the method pool.
3677 {
3678 llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
3679 ASTMethodPoolTrait Trait(*this);
3680
3681 // Create the on-disk hash table representation. We walk through every
3682 // selector we've seen and look it up in the method pool.
3683 SelectorOffsets.resize(new_size: NextSelectorID - FirstSelectorID);
3684 for (auto &SelectorAndID : SelectorIDs) {
3685 Selector S = SelectorAndID.first;
3686 SelectorID ID = SelectorAndID.second;
3687 SemaObjC::GlobalMethodPool::iterator F =
3688 SemaRef.ObjC().MethodPool.find(Val: S);
3689 ASTMethodPoolTrait::data_type Data = {
3690 .ID: ID,
3691 .Instance: ObjCMethodList(),
3692 .Factory: ObjCMethodList()
3693 };
3694 if (F != SemaRef.ObjC().MethodPool.end()) {
3695 Data.Instance = F->second.first;
3696 Data.Factory = F->second.second;
3697 }
3698 // Only write this selector if it's not in an existing AST or something
3699 // changed.
3700 if (Chain && ID < FirstSelectorID) {
3701 // Selector already exists. Did it change?
3702 bool changed = false;
3703 for (ObjCMethodList *M = &Data.Instance; M && M->getMethod();
3704 M = M->getNext()) {
3705 if (!M->getMethod()->isFromASTFile()) {
3706 changed = true;
3707 Data.Instance = *M;
3708 break;
3709 }
3710 }
3711 for (ObjCMethodList *M = &Data.Factory; M && M->getMethod();
3712 M = M->getNext()) {
3713 if (!M->getMethod()->isFromASTFile()) {
3714 changed = true;
3715 Data.Factory = *M;
3716 break;
3717 }
3718 }
3719 if (!changed)
3720 continue;
3721 } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) {
3722 // A new method pool entry.
3723 ++NumTableEntries;
3724 }
3725 Generator.insert(Key: S, Data, InfoObj&: Trait);
3726 }
3727
3728 // Create the on-disk hash table in a buffer.
3729 SmallString<4096> MethodPool;
3730 uint32_t BucketOffset;
3731 {
3732 using namespace llvm::support;
3733
3734 ASTMethodPoolTrait Trait(*this);
3735 llvm::raw_svector_ostream Out(MethodPool);
3736 // Make sure that no bucket is at offset 0
3737 endian::write<uint32_t>(os&: Out, value: 0, endian: llvm::endianness::little);
3738 BucketOffset = Generator.Emit(Out, InfoObj&: Trait);
3739 }
3740
3741 // Create a blob abbreviation
3742 auto Abbrev = std::make_shared<BitCodeAbbrev>();
3743 Abbrev->Add(OpInfo: BitCodeAbbrevOp(METHOD_POOL));
3744 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
3745 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
3746 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3747 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3748
3749 // Write the method pool
3750 {
3751 RecordData::value_type Record[] = {METHOD_POOL, BucketOffset,
3752 NumTableEntries};
3753 Stream.EmitRecordWithBlob(Abbrev: MethodPoolAbbrev, Vals: Record, Blob: MethodPool);
3754 }
3755
3756 // Create a blob abbreviation for the selector table offsets.
3757 Abbrev = std::make_shared<BitCodeAbbrev>();
3758 Abbrev->Add(OpInfo: BitCodeAbbrevOp(SELECTOR_OFFSETS));
3759 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
3760 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
3761 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3762 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
3763
3764 // Write the selector offsets table.
3765 {
3766 RecordData::value_type Record[] = {
3767 SELECTOR_OFFSETS, SelectorOffsets.size(),
3768 FirstSelectorID - NUM_PREDEF_SELECTOR_IDS};
3769 Stream.EmitRecordWithBlob(Abbrev: SelectorOffsetAbbrev, Vals: Record,
3770 Blob: bytes(v: SelectorOffsets));
3771 }
3772 }
3773}
3774
3775/// Write the selectors referenced in @selector expression into AST file.
3776void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
3777 using namespace llvm;
3778
3779 if (SemaRef.ObjC().ReferencedSelectors.empty())
3780 return;
3781
3782 RecordData Record;
3783 ASTRecordWriter Writer(SemaRef.Context, *this, Record);
3784
3785 // Note: this writes out all references even for a dependent AST. But it is
3786 // very tricky to fix, and given that @selector shouldn't really appear in
3787 // headers, probably not worth it. It's not a correctness issue.
3788 for (auto &SelectorAndLocation : SemaRef.ObjC().ReferencedSelectors) {
3789 Selector Sel = SelectorAndLocation.first;
3790 SourceLocation Loc = SelectorAndLocation.second;
3791 Writer.AddSelectorRef(S: Sel);
3792 Writer.AddSourceLocation(Loc);
3793 }
3794 Writer.Emit(Code: REFERENCED_SELECTOR_POOL);
3795}
3796
3797//===----------------------------------------------------------------------===//
3798// Identifier Table Serialization
3799//===----------------------------------------------------------------------===//
3800
3801/// Determine the declaration that should be put into the name lookup table to
3802/// represent the given declaration in this module. This is usually D itself,
3803/// but if D was imported and merged into a local declaration, we want the most
3804/// recent local declaration instead. The chosen declaration will be the most
3805/// recent declaration in any module that imports this one.
3806static NamedDecl *getDeclForLocalLookup(const LangOptions &LangOpts,
3807 NamedDecl *D) {
3808 if (!LangOpts.Modules || !D->isFromASTFile())
3809 return D;
3810
3811 if (Decl *Redecl = D->getPreviousDecl()) {
3812 // For Redeclarable decls, a prior declaration might be local.
3813 for (; Redecl; Redecl = Redecl->getPreviousDecl()) {
3814 // If we find a local decl, we're done.
3815 if (!Redecl->isFromASTFile()) {
3816 // Exception: in very rare cases (for injected-class-names), not all
3817 // redeclarations are in the same semantic context. Skip ones in a
3818 // different context. They don't go in this lookup table at all.
3819 if (!Redecl->getDeclContext()->getRedeclContext()->Equals(
3820 DC: D->getDeclContext()->getRedeclContext()))
3821 continue;
3822 return cast<NamedDecl>(Val: Redecl);
3823 }
3824
3825 // If we find a decl from a (chained-)PCH stop since we won't find a
3826 // local one.
3827 if (Redecl->getOwningModuleID() == 0)
3828 break;
3829 }
3830 } else if (Decl *First = D->getCanonicalDecl()) {
3831 // For Mergeable decls, the first decl might be local.
3832 if (!First->isFromASTFile())
3833 return cast<NamedDecl>(Val: First);
3834 }
3835
3836 // All declarations are imported. Our most recent declaration will also be
3837 // the most recent one in anyone who imports us.
3838 return D;
3839}
3840
3841namespace {
3842
3843bool IsInterestingIdentifier(const IdentifierInfo *II, uint64_t MacroOffset,
3844 bool IsModule, bool IsCPlusPlus) {
3845 bool NeedDecls = !IsModule || !IsCPlusPlus;
3846
3847 bool IsInteresting =
3848 II->getNotableIdentifierID() != tok::NotableIdentifierKind::not_notable ||
3849 II->getBuiltinID() != Builtin::ID::NotBuiltin ||
3850 II->getObjCKeywordID() != tok::ObjCKeywordKind::objc_not_keyword;
3851 if (MacroOffset ||
3852 (II->hasMacroDefinition() &&
3853 II->hasFETokenInfoChangedSinceDeserialization()) ||
3854 II->isPoisoned() || (!IsModule && IsInteresting) ||
3855 II->hasRevertedTokenIDToIdentifier() ||
3856 (NeedDecls && II->getFETokenInfo()))
3857 return true;
3858
3859 return false;
3860}
3861
3862bool IsInterestingNonMacroIdentifier(const IdentifierInfo *II,
3863 ASTWriter &Writer) {
3864 bool IsModule = Writer.isWritingModule();
3865 bool IsCPlusPlus = Writer.getLangOpts().CPlusPlus;
3866 return IsInterestingIdentifier(II, /*MacroOffset=*/0, IsModule, IsCPlusPlus);
3867}
3868
3869class ASTIdentifierTableTrait {
3870 ASTWriter &Writer;
3871 Preprocessor &PP;
3872 IdentifierResolver *IdResolver;
3873 bool IsModule;
3874 bool NeedDecls;
3875 ASTWriter::RecordData *InterestingIdentifierOffsets;
3876
3877 /// Determines whether this is an "interesting" identifier that needs a
3878 /// full IdentifierInfo structure written into the hash table. Notably, this
3879 /// doesn't check whether the name has macros defined; use PublicMacroIterator
3880 /// to check that.
3881 bool isInterestingIdentifier(const IdentifierInfo *II, uint64_t MacroOffset) {
3882 return IsInterestingIdentifier(II, MacroOffset, IsModule,
3883 IsCPlusPlus: Writer.getLangOpts().CPlusPlus);
3884 }
3885
3886public:
3887 using key_type = const IdentifierInfo *;
3888 using key_type_ref = key_type;
3889
3890 using data_type = IdentifierID;
3891 using data_type_ref = data_type;
3892
3893 using hash_value_type = unsigned;
3894 using offset_type = unsigned;
3895
3896 ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
3897 IdentifierResolver *IdResolver, bool IsModule,
3898 ASTWriter::RecordData *InterestingIdentifierOffsets)
3899 : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule),
3900 NeedDecls(!IsModule || !Writer.getLangOpts().CPlusPlus),
3901 InterestingIdentifierOffsets(InterestingIdentifierOffsets) {}
3902
3903 bool needDecls() const { return NeedDecls; }
3904
3905 static hash_value_type ComputeHash(const IdentifierInfo* II) {
3906 return llvm::djbHash(Buffer: II->getName());
3907 }
3908
3909 bool isInterestingIdentifier(const IdentifierInfo *II) {
3910 auto MacroOffset = Writer.getMacroDirectivesOffset(Name: II);
3911 return isInterestingIdentifier(II, MacroOffset);
3912 }
3913
3914 std::pair<unsigned, unsigned>
3915 EmitKeyDataLength(raw_ostream &Out, const IdentifierInfo *II, IdentifierID ID) {
3916 // Record the location of the identifier data. This is used when generating
3917 // the mapping from persistent IDs to strings.
3918 Writer.SetIdentifierOffset(II, Offset: Out.tell());
3919
3920 auto MacroOffset = Writer.getMacroDirectivesOffset(Name: II);
3921
3922 // Emit the offset of the key/data length information to the interesting
3923 // identifiers table if necessary.
3924 if (InterestingIdentifierOffsets &&
3925 isInterestingIdentifier(II, MacroOffset))
3926 InterestingIdentifierOffsets->push_back(Elt: Out.tell());
3927
3928 unsigned KeyLen = II->getLength() + 1;
3929 unsigned DataLen = sizeof(IdentifierID); // bytes for the persistent ID << 1
3930 if (isInterestingIdentifier(II, MacroOffset)) {
3931 DataLen += 2; // 2 bytes for builtin ID
3932 DataLen += 2; // 2 bytes for flags
3933 if (MacroOffset || (II->hasMacroDefinition() &&
3934 II->hasFETokenInfoChangedSinceDeserialization()))
3935 DataLen += 4; // MacroDirectives offset.
3936
3937 if (NeedDecls && IdResolver)
3938 DataLen += std::distance(first: IdResolver->begin(Name: II), last: IdResolver->end()) *
3939 sizeof(DeclID);
3940 }
3941 return emitULEBKeyDataLength(KeyLen, DataLen, Out);
3942 }
3943
3944 void EmitKey(raw_ostream &Out, const IdentifierInfo *II, unsigned KeyLen) {
3945 Out.write(Ptr: II->getNameStart(), Size: KeyLen);
3946 }
3947
3948 void EmitData(raw_ostream &Out, const IdentifierInfo *II, IdentifierID ID,
3949 unsigned) {
3950 using namespace llvm::support;
3951
3952 endian::Writer LE(Out, llvm::endianness::little);
3953
3954 auto MacroOffset = Writer.getMacroDirectivesOffset(Name: II);
3955 if (!isInterestingIdentifier(II, MacroOffset)) {
3956 LE.write<IdentifierID>(Val: ID << 1);
3957 return;
3958 }
3959
3960 LE.write<IdentifierID>(Val: (ID << 1) | 0x01);
3961 uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID();
3962 assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
3963 LE.write<uint16_t>(Val: Bits);
3964 Bits = 0;
3965 bool HasMacroDefinition =
3966 (MacroOffset != 0) || (II->hasMacroDefinition() &&
3967 II->hasFETokenInfoChangedSinceDeserialization());
3968 Bits = (Bits << 1) | unsigned(HasMacroDefinition);
3969 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
3970 Bits = (Bits << 1) | unsigned(II->isPoisoned());
3971 Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
3972 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
3973 LE.write<uint16_t>(Val: Bits);
3974
3975 if (HasMacroDefinition)
3976 LE.write<uint32_t>(Val: MacroOffset);
3977
3978 if (NeedDecls && IdResolver) {
3979 // Emit the declaration IDs in reverse order, because the
3980 // IdentifierResolver provides the declarations as they would be
3981 // visible (e.g., the function "stat" would come before the struct
3982 // "stat"), but the ASTReader adds declarations to the end of the list
3983 // (so we need to see the struct "stat" before the function "stat").
3984 // Only emit declarations that aren't from a chained PCH, though.
3985 SmallVector<NamedDecl *, 16> Decls(IdResolver->decls(Name: II));
3986 for (NamedDecl *D : llvm::reverse(C&: Decls))
3987 LE.write<DeclID>(Val: (DeclID)Writer.getDeclID(
3988 D: getDeclForLocalLookup(LangOpts: PP.getLangOpts(), D)));
3989 }
3990 }
3991};
3992
3993} // namespace
3994
3995/// If the \param IdentifierID ID is a local Identifier ID. If the higher
3996/// bits of ID is 0, it implies that the ID doesn't come from AST files.
3997static bool isLocalIdentifierID(IdentifierID ID) { return !(ID >> 32); }
3998
3999/// Write the identifier table into the AST file.
4000///
4001/// The identifier table consists of a blob containing string data
4002/// (the actual identifiers themselves) and a separate "offsets" index
4003/// that maps identifier IDs to locations within the blob.
4004void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
4005 IdentifierResolver *IdResolver,
4006 bool IsModule) {
4007 using namespace llvm;
4008
4009 RecordData InterestingIdents;
4010
4011 // Create and write out the blob that contains the identifier
4012 // strings.
4013 {
4014 llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
4015 ASTIdentifierTableTrait Trait(*this, PP, IdResolver, IsModule,
4016 IsModule ? &InterestingIdents : nullptr);
4017
4018 // Create the on-disk hash table representation. We only store offsets
4019 // for identifiers that appear here for the first time.
4020 IdentifierOffsets.resize(new_size: NextIdentID - FirstIdentID);
4021 for (auto IdentIDPair : IdentifierIDs) {
4022 const IdentifierInfo *II = IdentIDPair.first;
4023 IdentifierID ID = IdentIDPair.second;
4024 assert(II && "NULL identifier in identifier table");
4025
4026 // Write out identifiers if either the ID is local or the identifier has
4027 // changed since it was loaded.
4028 if (isLocalIdentifierID(ID) || II->hasChangedSinceDeserialization() ||
4029 (Trait.needDecls() &&
4030 II->hasFETokenInfoChangedSinceDeserialization()))
4031 Generator.insert(Key: II, Data: ID, InfoObj&: Trait);
4032 }
4033
4034 // Create the on-disk hash table in a buffer.
4035 SmallString<4096> IdentifierTable;
4036 uint32_t BucketOffset;
4037 {
4038 using namespace llvm::support;
4039
4040 llvm::raw_svector_ostream Out(IdentifierTable);
4041 // Make sure that no bucket is at offset 0
4042 endian::write<uint32_t>(os&: Out, value: 0, endian: llvm::endianness::little);
4043 BucketOffset = Generator.Emit(Out, InfoObj&: Trait);
4044 }
4045
4046 // Create a blob abbreviation
4047 auto Abbrev = std::make_shared<BitCodeAbbrev>();
4048 Abbrev->Add(OpInfo: BitCodeAbbrevOp(IDENTIFIER_TABLE));
4049 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
4050 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
4051 unsigned IDTableAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
4052
4053 // Write the identifier table
4054 RecordData::value_type Record[] = {IDENTIFIER_TABLE, BucketOffset};
4055 Stream.EmitRecordWithBlob(Abbrev: IDTableAbbrev, Vals: Record, Blob: IdentifierTable);
4056 }
4057
4058 // Write the offsets table for identifier IDs.
4059 auto Abbrev = std::make_shared<BitCodeAbbrev>();
4060 Abbrev->Add(OpInfo: BitCodeAbbrevOp(IDENTIFIER_OFFSET));
4061 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
4062 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
4063 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
4064
4065#ifndef NDEBUG
4066 for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I)
4067 assert(IdentifierOffsets[I] && "Missing identifier offset?");
4068#endif
4069
4070 RecordData::value_type Record[] = {IDENTIFIER_OFFSET,
4071 IdentifierOffsets.size()};
4072 Stream.EmitRecordWithBlob(Abbrev: IdentifierOffsetAbbrev, Vals: Record,
4073 Blob: bytes(v: IdentifierOffsets));
4074
4075 // In C++, write the list of interesting identifiers (those that are
4076 // defined as macros, poisoned, or similar unusual things).
4077 if (!InterestingIdents.empty())
4078 Stream.EmitRecord(Code: INTERESTING_IDENTIFIERS, Vals: InterestingIdents);
4079}
4080
4081void ASTWriter::handleVTable(CXXRecordDecl *RD) {
4082 if (!RD->isInNamedModule())
4083 return;
4084
4085 PendingEmittingVTables.push_back(Elt: RD);
4086}
4087
4088void ASTWriter::addTouchedModuleFile(serialization::ModuleFile *MF) {
4089 TouchedModuleFiles.insert(X: MF);
4090}
4091
4092//===----------------------------------------------------------------------===//
4093// DeclContext's Name Lookup Table Serialization
4094//===----------------------------------------------------------------------===//
4095
4096namespace {
4097
4098class ASTDeclContextNameLookupTraitBase {
4099protected:
4100 ASTWriter &Writer;
4101 using DeclIDsTy = llvm::SmallVector<LocalDeclID, 64>;
4102 DeclIDsTy DeclIDs;
4103
4104public:
4105 /// A start and end index into DeclIDs, representing a sequence of decls.
4106 using data_type = std::pair<unsigned, unsigned>;
4107 using data_type_ref = const data_type &;
4108
4109 using hash_value_type = unsigned;
4110 using offset_type = unsigned;
4111
4112 explicit ASTDeclContextNameLookupTraitBase(ASTWriter &Writer)
4113 : Writer(Writer) {}
4114
4115 data_type getData(const DeclIDsTy &LocalIDs) {
4116 unsigned Start = DeclIDs.size();
4117 for (auto ID : LocalIDs)
4118 DeclIDs.push_back(Elt: ID);
4119 return std::make_pair(x&: Start, y: DeclIDs.size());
4120 }
4121
4122 data_type ImportData(const reader::ASTDeclContextNameLookupTrait::data_type &FromReader) {
4123 unsigned Start = DeclIDs.size();
4124 DeclIDs.insert(
4125 I: DeclIDs.end(),
4126 From: DeclIDIterator<GlobalDeclID, LocalDeclID>(FromReader.begin()),
4127 To: DeclIDIterator<GlobalDeclID, LocalDeclID>(FromReader.end()));
4128 return std::make_pair(x&: Start, y: DeclIDs.size());
4129 }
4130
4131 void EmitFileRef(raw_ostream &Out, ModuleFile *F) const {
4132 assert(Writer.hasChain() &&
4133 "have reference to loaded module file but no chain?");
4134
4135 using namespace llvm::support;
4136 Writer.addTouchedModuleFile(MF: F);
4137 endian::write<uint32_t>(os&: Out, value: Writer.getChain()->getModuleFileID(M: F),
4138 endian: llvm::endianness::little);
4139 }
4140
4141 std::pair<unsigned, unsigned> EmitKeyDataLengthBase(raw_ostream &Out,
4142 DeclarationNameKey Name,
4143 data_type_ref Lookup) {
4144 unsigned KeyLen = 1;
4145 switch (Name.getKind()) {
4146 case DeclarationName::Identifier:
4147 case DeclarationName::CXXLiteralOperatorName:
4148 case DeclarationName::CXXDeductionGuideName:
4149 KeyLen += sizeof(IdentifierID);
4150 break;
4151 case DeclarationName::ObjCZeroArgSelector:
4152 case DeclarationName::ObjCOneArgSelector:
4153 case DeclarationName::ObjCMultiArgSelector:
4154 KeyLen += 4;
4155 break;
4156 case DeclarationName::CXXOperatorName:
4157 KeyLen += 1;
4158 break;
4159 case DeclarationName::CXXConstructorName:
4160 case DeclarationName::CXXDestructorName:
4161 case DeclarationName::CXXConversionFunctionName:
4162 case DeclarationName::CXXUsingDirective:
4163 break;
4164 }
4165
4166 // length of DeclIDs.
4167 unsigned DataLen = sizeof(DeclID) * (Lookup.second - Lookup.first);
4168
4169 return {KeyLen, DataLen};
4170 }
4171
4172 void EmitKeyBase(raw_ostream &Out, DeclarationNameKey Name) {
4173 using namespace llvm::support;
4174
4175 endian::Writer LE(Out, llvm::endianness::little);
4176 LE.write<uint8_t>(Val: Name.getKind());
4177 switch (Name.getKind()) {
4178 case DeclarationName::Identifier:
4179 case DeclarationName::CXXLiteralOperatorName:
4180 case DeclarationName::CXXDeductionGuideName:
4181 LE.write<IdentifierID>(Val: Writer.getIdentifierRef(II: Name.getIdentifier()));
4182 return;
4183 case DeclarationName::ObjCZeroArgSelector:
4184 case DeclarationName::ObjCOneArgSelector:
4185 case DeclarationName::ObjCMultiArgSelector:
4186 LE.write<uint32_t>(Val: Writer.getSelectorRef(Sel: Name.getSelector()));
4187 return;
4188 case DeclarationName::CXXOperatorName:
4189 assert(Name.getOperatorKind() < NUM_OVERLOADED_OPERATORS &&
4190 "Invalid operator?");
4191 LE.write<uint8_t>(Val: Name.getOperatorKind());
4192 return;
4193 case DeclarationName::CXXConstructorName:
4194 case DeclarationName::CXXDestructorName:
4195 case DeclarationName::CXXConversionFunctionName:
4196 case DeclarationName::CXXUsingDirective:
4197 return;
4198 }
4199
4200 llvm_unreachable("Invalid name kind?");
4201 }
4202
4203 void EmitDataBase(raw_ostream &Out, data_type Lookup, unsigned DataLen) {
4204 using namespace llvm::support;
4205
4206 endian::Writer LE(Out, llvm::endianness::little);
4207 uint64_t Start = Out.tell(); (void)Start;
4208 for (unsigned I = Lookup.first, N = Lookup.second; I != N; ++I)
4209 LE.write<DeclID>(Val: (DeclID)DeclIDs[I]);
4210 assert(Out.tell() - Start == DataLen && "Data length is wrong");
4211 }
4212};
4213
4214class ModuleLevelNameLookupTrait : public ASTDeclContextNameLookupTraitBase {
4215public:
4216 using primary_module_hash_type = unsigned;
4217
4218 using key_type = std::pair<DeclarationNameKey, primary_module_hash_type>;
4219 using key_type_ref = key_type;
4220
4221 explicit ModuleLevelNameLookupTrait(ASTWriter &Writer)
4222 : ASTDeclContextNameLookupTraitBase(Writer) {}
4223
4224 static bool EqualKey(key_type_ref a, key_type_ref b) { return a == b; }
4225
4226 hash_value_type ComputeHash(key_type Key) {
4227 llvm::FoldingSetNodeID ID;
4228 ID.AddInteger(I: Key.first.getHash());
4229 ID.AddInteger(I: Key.second);
4230 return ID.computeStableHash();
4231 }
4232
4233 std::pair<unsigned, unsigned>
4234 EmitKeyDataLength(raw_ostream &Out, key_type Key, data_type_ref Lookup) {
4235 auto [KeyLen, DataLen] = EmitKeyDataLengthBase(Out, Name: Key.first, Lookup);
4236 KeyLen += sizeof(Key.second);
4237 return emitULEBKeyDataLength(KeyLen, DataLen, Out);
4238 }
4239
4240 void EmitKey(raw_ostream &Out, key_type Key, unsigned) {
4241 EmitKeyBase(Out, Name: Key.first);
4242 llvm::support::endian::Writer LE(Out, llvm::endianness::little);
4243 LE.write<primary_module_hash_type>(Val: Key.second);
4244 }
4245
4246 void EmitData(raw_ostream &Out, key_type_ref, data_type Lookup,
4247 unsigned DataLen) {
4248 EmitDataBase(Out, Lookup, DataLen);
4249 }
4250};
4251
4252class ASTDeclContextNameTrivialLookupTrait
4253 : public ASTDeclContextNameLookupTraitBase {
4254public:
4255 using key_type = DeclarationNameKey;
4256 using key_type_ref = key_type;
4257
4258public:
4259 using ASTDeclContextNameLookupTraitBase::ASTDeclContextNameLookupTraitBase;
4260
4261 using ASTDeclContextNameLookupTraitBase::getData;
4262
4263 static bool EqualKey(key_type_ref a, key_type_ref b) { return a == b; }
4264
4265 hash_value_type ComputeHash(key_type Name) { return Name.getHash(); }
4266
4267 std::pair<unsigned, unsigned> EmitKeyDataLength(raw_ostream &Out,
4268 DeclarationNameKey Name,
4269 data_type_ref Lookup) {
4270 auto [KeyLen, DataLen] = EmitKeyDataLengthBase(Out, Name, Lookup);
4271 return emitULEBKeyDataLength(KeyLen, DataLen, Out);
4272 }
4273
4274 void EmitKey(raw_ostream &Out, DeclarationNameKey Name, unsigned) {
4275 return EmitKeyBase(Out, Name);
4276 }
4277
4278 void EmitData(raw_ostream &Out, key_type_ref, data_type Lookup,
4279 unsigned DataLen) {
4280 EmitDataBase(Out, Lookup, DataLen);
4281 }
4282};
4283
4284static bool isModuleLocalDecl(NamedDecl *D) {
4285 // For decls not in a file context, they should have the same visibility
4286 // with their parent.
4287 if (auto *Parent = dyn_cast<NamedDecl>(Val: D->getNonTransparentDeclContext());
4288 Parent && !D->getNonTransparentDeclContext()->isFileContext())
4289 return isModuleLocalDecl(D: Parent);
4290
4291 // Deduction Guide are special here. Since their logical parent context are
4292 // not their actual parent.
4293 if (auto *FTD = dyn_cast<FunctionTemplateDecl>(Val: D))
4294 if (auto *CDGD = dyn_cast<CXXDeductionGuideDecl>(Val: FTD->getTemplatedDecl()))
4295 return isModuleLocalDecl(D: CDGD->getDeducedTemplate());
4296
4297 if (D->getFormalLinkage() != Linkage::Module)
4298 return false;
4299
4300 // It is hard for the serializer to judge if the in-class friend declaration
4301 // is visible or not, so we just transfer the task to Sema. It should be a
4302 // safe decision since Sema is able to handle the lookup rules for in-class
4303 // friend declarations good enough already.
4304 if (D->getFriendObjectKind() &&
4305 isa<CXXRecordDecl>(Val: D->getLexicalDeclContext()))
4306 return false;
4307
4308 return true;
4309}
4310
4311static bool isTULocalInNamedModules(NamedDecl *D) {
4312 Module *NamedModule = D->getTopLevelOwningNamedModule();
4313 if (!NamedModule)
4314 return false;
4315
4316 // For none-top level decls, we choose to move it to the general visible
4317 // lookup table. Since the consumer may get its parent somehow and performs
4318 // a lookup in it (considering looking up the operator function in lambda).
4319 // The difference between module local lookup table and TU local lookup table
4320 // is, the consumers still have a chance to lookup in the module local lookup
4321 // table but **now** the consumers won't read the TU local lookup table if
4322 // the consumer is not the original TU.
4323 //
4324 // FIXME: It seems to be an optimization chance (and also a more correct
4325 // semantics) to remain the TULocal lookup table and performing similar lookup
4326 // with the module local lookup table except that we only allow the lookups
4327 // with the same module unit.
4328 if (!D->getNonTransparentDeclContext()->isFileContext())
4329 return false;
4330
4331 return D->getLinkageInternal() == Linkage::Internal;
4332}
4333
4334class ASTDeclContextNameLookupTrait
4335 : public ASTDeclContextNameTrivialLookupTrait {
4336public:
4337 using TULocalDeclsMapTy = llvm::DenseMap<key_type, DeclIDsTy>;
4338
4339 using ModuleLevelDeclsMapTy =
4340 llvm::DenseMap<ModuleLevelNameLookupTrait::key_type, DeclIDsTy>;
4341
4342private:
4343 enum class LookupVisibility {
4344 GenerallyVisibile,
4345 // The decls can only be found by other TU in the same module.
4346 // Note a clang::Module models a module unit instead of logical module
4347 // in C++20.
4348 ModuleLocalVisible,
4349 // The decls can only be found by the TU itself that defines it.
4350 TULocal,
4351 };
4352
4353 LookupVisibility getLookupVisibility(NamedDecl *D) const {
4354 // Only named modules have other lookup visibility.
4355 if (!Writer.isWritingStdCXXNamedModules())
4356 return LookupVisibility::GenerallyVisibile;
4357
4358 if (isModuleLocalDecl(D))
4359 return LookupVisibility::ModuleLocalVisible;
4360 if (isTULocalInNamedModules(D))
4361 return LookupVisibility::TULocal;
4362
4363 // A trick to handle enum constants. The enum constants is special since
4364 // they can be found directly without their parent context. This makes it
4365 // tricky to decide if an EnumConstantDecl is visible or not by their own
4366 // visibilities. E.g., for a class member, we can assume it is visible if
4367 // the user get its parent somehow. But for an enum constant, the users may
4368 // access if without its parent context. Although we can fix the problem in
4369 // Sema lookup process, it might be too complex, we just make a trick here.
4370 // Note that we only removes enum constant from the lookup table from its
4371 // parent of parent. We DON'T remove the enum constant from its parent. So
4372 // we don't need to care about merging problems here.
4373 if (auto *ECD = dyn_cast<EnumConstantDecl>(Val: D);
4374 ECD && DC.isFileContext() && ECD->getTopLevelOwningNamedModule()) {
4375 if (llvm::all_of(
4376 Range: DC.noload_lookup(
4377 Name: cast<EnumDecl>(Val: ECD->getDeclContext())->getDeclName()),
4378 P: [](auto *Found) {
4379 return Found->isInvisibleOutsideTheOwningModule();
4380 }))
4381 return ECD->isFromExplicitGlobalModule() ||
4382 ECD->isInAnonymousNamespace()
4383 ? LookupVisibility::TULocal
4384 : LookupVisibility::ModuleLocalVisible;
4385 }
4386
4387 return LookupVisibility::GenerallyVisibile;
4388 }
4389
4390 DeclContext &DC;
4391 ModuleLevelDeclsMapTy ModuleLocalDeclsMap;
4392 TULocalDeclsMapTy TULocalDeclsMap;
4393
4394public:
4395 using ASTDeclContextNameTrivialLookupTrait::
4396 ASTDeclContextNameTrivialLookupTrait;
4397
4398 ASTDeclContextNameLookupTrait(ASTWriter &Writer, DeclContext &DC)
4399 : ASTDeclContextNameTrivialLookupTrait(Writer), DC(DC) {}
4400
4401 template <typename Coll> data_type getData(const Coll &Decls) {
4402 unsigned Start = DeclIDs.size();
4403 auto AddDecl = [this](NamedDecl *D) {
4404 NamedDecl *DeclForLocalLookup =
4405 getDeclForLocalLookup(LangOpts: Writer.getLangOpts(), D);
4406
4407 if (Writer.getDoneWritingDeclsAndTypes() &&
4408 !Writer.wasDeclEmitted(D: DeclForLocalLookup))
4409 return;
4410
4411 // Try to avoid writing internal decls to reduced BMI.
4412 // See comments in ASTWriter::WriteDeclContextLexicalBlock for details.
4413 if (Writer.isGeneratingReducedBMI() &&
4414 !DeclForLocalLookup->isFromExplicitGlobalModule() &&
4415 IsInternalDeclFromFileContext(D: DeclForLocalLookup))
4416 return;
4417
4418 auto ID = Writer.GetDeclRef(D: DeclForLocalLookup);
4419
4420 switch (getLookupVisibility(D: DeclForLocalLookup)) {
4421 case LookupVisibility::ModuleLocalVisible:
4422 if (UnsignedOrNone PrimaryModuleHash =
4423 getPrimaryModuleHash(M: D->getOwningModule())) {
4424 auto Key = std::make_pair(x: D->getDeclName(), y: *PrimaryModuleHash);
4425 auto Iter = ModuleLocalDeclsMap.find(Val: Key);
4426 if (Iter == ModuleLocalDeclsMap.end())
4427 ModuleLocalDeclsMap.insert(KV: {Key, DeclIDsTy{ID}});
4428 else
4429 Iter->second.push_back(Elt: ID);
4430 return;
4431 }
4432 break;
4433 case LookupVisibility::TULocal: {
4434 auto Iter = TULocalDeclsMap.find(Val: D->getDeclName());
4435 if (Iter == TULocalDeclsMap.end())
4436 TULocalDeclsMap.insert(KV: {D->getDeclName(), DeclIDsTy{ID}});
4437 else
4438 Iter->second.push_back(Elt: ID);
4439 return;
4440 }
4441 case LookupVisibility::GenerallyVisibile:
4442 // Generally visible decls go into the general lookup table.
4443 break;
4444 }
4445
4446 DeclIDs.push_back(Elt: ID);
4447 };
4448 ASTReader *Chain = Writer.getChain();
4449 for (NamedDecl *D : Decls) {
4450 if (Chain && isa<NamespaceDecl>(Val: D) && D->isFromASTFile() &&
4451 D == Chain->getKeyDeclaration(D)) {
4452 // In ASTReader, we stored only the key declaration of a namespace decl
4453 // for this TU. If we have an external namespace decl, this is that
4454 // key declaration and we need to re-expand it to write out the first
4455 // decl from each module.
4456 //
4457 // See comment 'ASTReader::FindExternalVisibleDeclsByName' for details.
4458 auto Firsts =
4459 Writer.CollectFirstDeclFromEachModule(D, /*IncludeLocal=*/false);
4460 for (const auto &[_, First] : Firsts)
4461 AddDecl(cast<NamedDecl>(Val: const_cast<Decl *>(First)));
4462 } else {
4463 AddDecl(D);
4464 }
4465 }
4466 return std::make_pair(x&: Start, y: DeclIDs.size());
4467 }
4468
4469 const ModuleLevelDeclsMapTy &getModuleLocalDecls() {
4470 return ModuleLocalDeclsMap;
4471 }
4472
4473 const TULocalDeclsMapTy &getTULocalDecls() { return TULocalDeclsMap; }
4474};
4475
4476} // namespace
4477
4478namespace {
4479class LazySpecializationInfoLookupTrait {
4480 ASTWriter &Writer;
4481 llvm::SmallVector<serialization::reader::LazySpecializationInfo, 64> Specs;
4482
4483public:
4484 using key_type = unsigned;
4485 using key_type_ref = key_type;
4486
4487 /// A start and end index into Specs, representing a sequence of decls.
4488 using data_type = std::pair<unsigned, unsigned>;
4489 using data_type_ref = const data_type &;
4490
4491 using hash_value_type = unsigned;
4492 using offset_type = unsigned;
4493
4494 explicit LazySpecializationInfoLookupTrait(ASTWriter &Writer)
4495 : Writer(Writer) {}
4496
4497 template <typename Col, typename Col2>
4498 data_type getData(Col &&C, Col2 &ExistingInfo) {
4499 unsigned Start = Specs.size();
4500 for (auto *D : C) {
4501 NamedDecl *ND = getDeclForLocalLookup(LangOpts: Writer.getLangOpts(),
4502 D: const_cast<NamedDecl *>(D));
4503 Specs.push_back(Elt: GlobalDeclID(Writer.GetDeclRef(D: ND).getRawValue()));
4504 }
4505 for (const serialization::reader::LazySpecializationInfo &Info :
4506 ExistingInfo)
4507 Specs.push_back(Elt: Info);
4508 return std::make_pair(x&: Start, y: Specs.size());
4509 }
4510
4511 data_type ImportData(
4512 const reader::LazySpecializationInfoLookupTrait::data_type &FromReader) {
4513 unsigned Start = Specs.size();
4514 for (auto ID : FromReader)
4515 Specs.push_back(Elt: ID);
4516 return std::make_pair(x&: Start, y: Specs.size());
4517 }
4518
4519 static bool EqualKey(key_type_ref a, key_type_ref b) { return a == b; }
4520
4521 hash_value_type ComputeHash(key_type Name) { return Name; }
4522
4523 void EmitFileRef(raw_ostream &Out, ModuleFile *F) const {
4524 assert(Writer.hasChain() &&
4525 "have reference to loaded module file but no chain?");
4526
4527 using namespace llvm::support;
4528 Writer.addTouchedModuleFile(MF: F);
4529 endian::write<uint32_t>(os&: Out, value: Writer.getChain()->getModuleFileID(M: F),
4530 endian: llvm::endianness::little);
4531 }
4532
4533 std::pair<unsigned, unsigned> EmitKeyDataLength(raw_ostream &Out,
4534 key_type HashValue,
4535 data_type_ref Lookup) {
4536 // 4 bytes for each slot.
4537 unsigned KeyLen = 4;
4538 unsigned DataLen = sizeof(serialization::reader::LazySpecializationInfo) *
4539 (Lookup.second - Lookup.first);
4540
4541 return emitULEBKeyDataLength(KeyLen, DataLen, Out);
4542 }
4543
4544 void EmitKey(raw_ostream &Out, key_type HashValue, unsigned) {
4545 using namespace llvm::support;
4546
4547 endian::Writer LE(Out, llvm::endianness::little);
4548 LE.write<uint32_t>(Val: HashValue);
4549 }
4550
4551 void EmitData(raw_ostream &Out, key_type_ref, data_type Lookup,
4552 unsigned DataLen) {
4553 using namespace llvm::support;
4554
4555 endian::Writer LE(Out, llvm::endianness::little);
4556 uint64_t Start = Out.tell();
4557 (void)Start;
4558 for (unsigned I = Lookup.first, N = Lookup.second; I != N; ++I) {
4559 LE.write<DeclID>(Val: Specs[I].getRawValue());
4560 }
4561 assert(Out.tell() - Start == DataLen && "Data length is wrong");
4562 }
4563};
4564
4565unsigned CalculateODRHashForSpecs(const Decl *Spec) {
4566 ArrayRef<TemplateArgument> Args;
4567 if (auto *CTSD = dyn_cast<ClassTemplateSpecializationDecl>(Val: Spec))
4568 Args = CTSD->getTemplateArgs().asArray();
4569 else if (auto *VTSD = dyn_cast<VarTemplateSpecializationDecl>(Val: Spec))
4570 Args = VTSD->getTemplateArgs().asArray();
4571 else if (auto *FD = dyn_cast<FunctionDecl>(Val: Spec))
4572 Args = FD->getTemplateSpecializationArgs()->asArray();
4573 else
4574 llvm_unreachable("New Specialization Kind?");
4575
4576 return StableHashForTemplateArguments(Args);
4577}
4578} // namespace
4579
4580void ASTWriter::GenerateSpecializationInfoLookupTable(
4581 const NamedDecl *D, llvm::SmallVectorImpl<const Decl *> &Specializations,
4582 llvm::SmallVectorImpl<char> &LookupTable, bool IsPartial) {
4583 assert(D->isFirstDecl());
4584
4585 // Create the on-disk hash table representation.
4586 MultiOnDiskHashTableGenerator<reader::LazySpecializationInfoLookupTrait,
4587 LazySpecializationInfoLookupTrait>
4588 Generator;
4589 LazySpecializationInfoLookupTrait Trait(*this);
4590
4591 llvm::MapVector<unsigned, llvm::SmallVector<const NamedDecl *, 4>>
4592 SpecializationMaps;
4593
4594 for (auto *Specialization : Specializations) {
4595 unsigned HashedValue = CalculateODRHashForSpecs(Spec: Specialization);
4596
4597 auto Iter = SpecializationMaps.find(Key: HashedValue);
4598 if (Iter == SpecializationMaps.end())
4599 Iter = SpecializationMaps
4600 .try_emplace(Key: HashedValue,
4601 Args: llvm::SmallVector<const NamedDecl *, 4>())
4602 .first;
4603
4604 Iter->second.push_back(Elt: cast<NamedDecl>(Val: Specialization));
4605 }
4606
4607 auto *Lookups =
4608 Chain ? Chain->getLoadedSpecializationsLookupTables(D, IsPartial)
4609 : nullptr;
4610
4611 for (auto &[HashValue, Specs] : SpecializationMaps) {
4612 SmallVector<serialization::reader::LazySpecializationInfo, 16>
4613 ExisitingSpecs;
4614 // We have to merge the lookup table manually here. We can't depend on the
4615 // merge mechanism offered by
4616 // clang::serialization::MultiOnDiskHashTableGenerator since that generator
4617 // assumes the we'll get the same value with the same key.
4618 // And also underlying llvm::OnDiskChainedHashTableGenerator assumes that we
4619 // won't insert the values with the same key twice. So we have to merge the
4620 // lookup table here manually.
4621 if (Lookups)
4622 ExisitingSpecs = Lookups->Table.find(EKey: HashValue);
4623
4624 Generator.insert(Key: HashValue, Data: Trait.getData(C&: Specs, ExistingInfo&: ExisitingSpecs), Info&: Trait);
4625 }
4626
4627 Generator.emit(Out&: LookupTable, Info&: Trait, Base: Lookups ? &Lookups->Table : nullptr);
4628}
4629
4630uint64_t ASTWriter::WriteSpecializationInfoLookupTable(
4631 const NamedDecl *D, llvm::SmallVectorImpl<const Decl *> &Specializations,
4632 bool IsPartial) {
4633
4634 llvm::SmallString<4096> LookupTable;
4635 GenerateSpecializationInfoLookupTable(D, Specializations, LookupTable,
4636 IsPartial);
4637
4638 uint64_t Offset = Stream.GetCurrentBitNo();
4639 RecordData::value_type Record[] = {static_cast<RecordData::value_type>(
4640 IsPartial ? DECL_PARTIAL_SPECIALIZATIONS : DECL_SPECIALIZATIONS)};
4641 Stream.EmitRecordWithBlob(Abbrev: IsPartial ? DeclPartialSpecializationsAbbrev
4642 : DeclSpecializationsAbbrev,
4643 Vals: Record, Blob: LookupTable);
4644
4645 return Offset;
4646}
4647
4648/// Returns true if all of the lookup result are either external, not emitted or
4649/// predefined. In such cases, the lookup result is not interesting and we don't
4650/// need to record the result in the current being written module. Return false
4651/// otherwise.
4652static bool isLookupResultNotInteresting(ASTWriter &Writer,
4653 StoredDeclsList &Result) {
4654 for (auto *D : Result.getLookupResult()) {
4655 auto *LocalD = getDeclForLocalLookup(LangOpts: Writer.getLangOpts(), D);
4656 if (LocalD->isFromASTFile())
4657 continue;
4658
4659 // We can only be sure whether the local declaration is reachable
4660 // after we done writing the declarations and types.
4661 if (Writer.getDoneWritingDeclsAndTypes() && !Writer.wasDeclEmitted(D: LocalD))
4662 continue;
4663
4664 // We don't need to emit the predefined decls.
4665 if (Writer.isDeclPredefined(D: LocalD))
4666 continue;
4667
4668 return false;
4669 }
4670
4671 return true;
4672}
4673
4674void ASTWriter::GenerateNameLookupTable(
4675 ASTContext &Context, const DeclContext *ConstDC,
4676 llvm::SmallVectorImpl<char> &LookupTable,
4677 llvm::SmallVectorImpl<char> &ModuleLocalLookupTable,
4678 llvm::SmallVectorImpl<char> &TULookupTable) {
4679 assert(!ConstDC->hasLazyLocalLexicalLookups() &&
4680 !ConstDC->hasLazyExternalLexicalLookups() &&
4681 "must call buildLookups first");
4682
4683 // FIXME: We need to build the lookups table, which is logically const.
4684 auto *DC = const_cast<DeclContext*>(ConstDC);
4685 assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
4686
4687 // Create the on-disk hash table representation.
4688 MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait,
4689 ASTDeclContextNameLookupTrait>
4690 Generator;
4691 ASTDeclContextNameLookupTrait Trait(*this, *DC);
4692
4693 // The first step is to collect the declaration names which we need to
4694 // serialize into the name lookup table, and to collect them in a stable
4695 // order.
4696 SmallVector<DeclarationName, 16> Names;
4697
4698 // We also track whether we're writing out the DeclarationNameKey for
4699 // constructors or conversion functions.
4700 bool IncludeConstructorNames = false;
4701 bool IncludeConversionNames = false;
4702
4703 for (auto &[Name, Result] : *DC->buildLookup()) {
4704 // If there are no local declarations in our lookup result, we
4705 // don't need to write an entry for the name at all. If we can't
4706 // write out a lookup set without performing more deserialization,
4707 // just skip this entry.
4708 //
4709 // Also in reduced BMI, we'd like to avoid writing unreachable
4710 // declarations in GMF, so we need to avoid writing declarations
4711 // that entirely external or unreachable.
4712 if (GeneratingReducedBMI && isLookupResultNotInteresting(Writer&: *this, Result))
4713 continue;
4714 // We also skip empty results. If any of the results could be external and
4715 // the currently available results are empty, then all of the results are
4716 // external and we skip it above. So the only way we get here with an empty
4717 // results is when no results could have been external *and* we have
4718 // external results.
4719 //
4720 // FIXME: While we might want to start emitting on-disk entries for negative
4721 // lookups into a decl context as an optimization, today we *have* to skip
4722 // them because there are names with empty lookup results in decl contexts
4723 // which we can't emit in any stable ordering: we lookup constructors and
4724 // conversion functions in the enclosing namespace scope creating empty
4725 // results for them. This in almost certainly a bug in Clang's name lookup,
4726 // but that is likely to be hard or impossible to fix and so we tolerate it
4727 // here by omitting lookups with empty results.
4728 if (Result.getLookupResult().empty())
4729 continue;
4730
4731 switch (Name.getNameKind()) {
4732 default:
4733 Names.push_back(Elt: Name);
4734 break;
4735
4736 case DeclarationName::CXXConstructorName:
4737 IncludeConstructorNames = true;
4738 break;
4739
4740 case DeclarationName::CXXConversionFunctionName:
4741 IncludeConversionNames = true;
4742 break;
4743 }
4744 }
4745
4746 // Sort the names into a stable order.
4747 llvm::sort(C&: Names);
4748
4749 if (IncludeConstructorNames || IncludeConversionNames) {
4750 // We need to establish an ordering of constructor and conversion function
4751 // names, and they don't have an intrinsic ordering. We also need to write
4752 // out all constructor and conversion function results if we write out any
4753 // of them, because they're all tracked under the same lookup key.
4754 llvm::SmallPtrSet<DeclarationName, 8> AddedNames;
4755 for (Decl *ChildD : cast<CXXRecordDecl>(Val: DC)->decls()) {
4756 if (auto *ChildND = dyn_cast<NamedDecl>(Val: ChildD)) {
4757 auto Name = ChildND->getDeclName();
4758 switch (Name.getNameKind()) {
4759 default:
4760 continue;
4761
4762 case DeclarationName::CXXConstructorName:
4763 if (!IncludeConstructorNames)
4764 continue;
4765 break;
4766
4767 case DeclarationName::CXXConversionFunctionName:
4768 if (!IncludeConversionNames)
4769 continue;
4770 break;
4771 }
4772 if (AddedNames.insert(Ptr: Name).second)
4773 Names.push_back(Elt: Name);
4774 }
4775 }
4776 }
4777 // Next we need to do a lookup with each name into this decl context to fully
4778 // populate any results from external sources. We don't actually use the
4779 // results of these lookups because we only want to use the results after all
4780 // results have been loaded and the pointers into them will be stable.
4781 for (auto &Name : Names)
4782 DC->lookup(Name);
4783
4784 // Now we need to insert the results for each name into the hash table. For
4785 // constructor names and conversion function names, we actually need to merge
4786 // all of the results for them into one list of results each and insert
4787 // those.
4788 SmallVector<NamedDecl *, 8> ConstructorDecls;
4789 SmallVector<NamedDecl *, 8> ConversionDecls;
4790
4791 // Now loop over the names, either inserting them or appending for the two
4792 // special cases.
4793 for (auto &Name : Names) {
4794 DeclContext::lookup_result Result = DC->noload_lookup(Name);
4795
4796 switch (Name.getNameKind()) {
4797 default:
4798 Generator.insert(Key: Name, Data: Trait.getData(Decls: Result), Info&: Trait);
4799 break;
4800
4801 case DeclarationName::CXXConstructorName:
4802 ConstructorDecls.append(in_start: Result.begin(), in_end: Result.end());
4803 break;
4804
4805 case DeclarationName::CXXConversionFunctionName:
4806 ConversionDecls.append(in_start: Result.begin(), in_end: Result.end());
4807 break;
4808 }
4809 }
4810
4811 // Handle our two special cases if we ended up having any. We arbitrarily use
4812 // the first declaration's name here because the name itself isn't part of
4813 // the key, only the kind of name is used.
4814 if (!ConstructorDecls.empty())
4815 Generator.insert(Key: ConstructorDecls.front()->getDeclName(),
4816 Data: Trait.getData(Decls: ConstructorDecls), Info&: Trait);
4817 if (!ConversionDecls.empty())
4818 Generator.insert(Key: ConversionDecls.front()->getDeclName(),
4819 Data: Trait.getData(Decls: ConversionDecls), Info&: Trait);
4820
4821 // Create the on-disk hash table. Also emit the existing imported and
4822 // merged table if there is one.
4823 auto *Lookups = Chain ? Chain->getLoadedLookupTables(Primary: DC) : nullptr;
4824 Generator.emit(Out&: LookupTable, Info&: Trait, Base: Lookups ? &Lookups->Table : nullptr);
4825
4826 const auto &ModuleLocalDecls = Trait.getModuleLocalDecls();
4827 if (!ModuleLocalDecls.empty()) {
4828 MultiOnDiskHashTableGenerator<reader::ModuleLocalNameLookupTrait,
4829 ModuleLevelNameLookupTrait>
4830 ModuleLocalLookupGenerator;
4831 ModuleLevelNameLookupTrait ModuleLocalTrait(*this);
4832
4833 for (const auto &ModuleLocalIter : ModuleLocalDecls) {
4834 const auto &Key = ModuleLocalIter.first;
4835 const auto &IDs = ModuleLocalIter.second;
4836 ModuleLocalLookupGenerator.insert(Key, Data: ModuleLocalTrait.getData(LocalIDs: IDs),
4837 Info&: ModuleLocalTrait);
4838 }
4839
4840 auto *ModuleLocalLookups =
4841 Chain ? Chain->getModuleLocalLookupTables(Primary: DC) : nullptr;
4842 ModuleLocalLookupGenerator.emit(
4843 Out&: ModuleLocalLookupTable, Info&: ModuleLocalTrait,
4844 Base: ModuleLocalLookups ? &ModuleLocalLookups->Table : nullptr);
4845 }
4846
4847 const auto &TULocalDecls = Trait.getTULocalDecls();
4848 if (!TULocalDecls.empty() && !isGeneratingReducedBMI()) {
4849 MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait,
4850 ASTDeclContextNameTrivialLookupTrait>
4851 TULookupGenerator;
4852 ASTDeclContextNameTrivialLookupTrait TULocalTrait(*this);
4853
4854 for (const auto &TULocalIter : TULocalDecls) {
4855 const auto &Key = TULocalIter.first;
4856 const auto &IDs = TULocalIter.second;
4857 TULookupGenerator.insert(Key, Data: TULocalTrait.getData(LocalIDs: IDs), Info&: TULocalTrait);
4858 }
4859
4860 auto *TULocalLookups = Chain ? Chain->getTULocalLookupTables(Primary: DC) : nullptr;
4861 TULookupGenerator.emit(Out&: TULookupTable, Info&: TULocalTrait,
4862 Base: TULocalLookups ? &TULocalLookups->Table : nullptr);
4863 }
4864}
4865
4866/// Write the block containing all of the declaration IDs
4867/// visible from the given DeclContext.
4868///
4869/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
4870/// bitstream, or 0 if no block was written.
4871void ASTWriter::WriteDeclContextVisibleBlock(
4872 ASTContext &Context, DeclContext *DC, VisibleLookupBlockOffsets &Offsets) {
4873 assert(!Offsets);
4874
4875 // If we imported a key declaration of this namespace, write the visible
4876 // lookup results as an update record for it rather than including them
4877 // on this declaration. We will only look at key declarations on reload.
4878 if (isa<NamespaceDecl>(Val: DC) && Chain &&
4879 Chain->getKeyDeclaration(D: cast<Decl>(Val: DC))->isFromASTFile()) {
4880 // Only do this once, for the first local declaration of the namespace.
4881 for (auto *Prev = cast<NamespaceDecl>(Val: DC)->getPreviousDecl(); Prev;
4882 Prev = Prev->getPreviousDecl())
4883 if (!Prev->isFromASTFile())
4884 return;
4885
4886 // Note that we need to emit an update record for the primary context.
4887 UpdatedDeclContexts.insert(X: DC->getPrimaryContext());
4888
4889 // Make sure all visible decls are written. They will be recorded later. We
4890 // do this using a side data structure so we can sort the names into
4891 // a deterministic order.
4892 StoredDeclsMap *Map = DC->getPrimaryContext()->buildLookup();
4893 SmallVector<std::pair<DeclarationName, DeclContext::lookup_result>, 16>
4894 LookupResults;
4895 if (Map) {
4896 LookupResults.reserve(N: Map->size());
4897 for (auto &Entry : *Map)
4898 LookupResults.push_back(
4899 Elt: std::make_pair(x&: Entry.first, y: Entry.second.getLookupResult()));
4900 }
4901
4902 llvm::sort(C&: LookupResults, Comp: llvm::less_first());
4903 for (auto &NameAndResult : LookupResults) {
4904 DeclarationName Name = NameAndResult.first;
4905 DeclContext::lookup_result Result = NameAndResult.second;
4906 if (Name.getNameKind() == DeclarationName::CXXConstructorName ||
4907 Name.getNameKind() == DeclarationName::CXXConversionFunctionName) {
4908 // We have to work around a name lookup bug here where negative lookup
4909 // results for these names get cached in namespace lookup tables (these
4910 // names should never be looked up in a namespace).
4911 assert(Result.empty() && "Cannot have a constructor or conversion "
4912 "function name in a namespace!");
4913 continue;
4914 }
4915
4916 for (NamedDecl *ND : Result) {
4917 if (ND->isFromASTFile())
4918 continue;
4919
4920 if (DoneWritingDeclsAndTypes && !wasDeclEmitted(D: ND))
4921 continue;
4922
4923 // We don't need to force emitting internal decls into reduced BMI.
4924 // See comments in ASTWriter::WriteDeclContextLexicalBlock for details.
4925 if (GeneratingReducedBMI && !ND->isFromExplicitGlobalModule() &&
4926 IsInternalDeclFromFileContext(D: ND))
4927 continue;
4928
4929 GetDeclRef(D: ND);
4930 }
4931 }
4932
4933 return;
4934 }
4935
4936 if (DC->getPrimaryContext() != DC)
4937 return;
4938
4939 // Skip contexts which don't support name lookup.
4940 if (!DC->isLookupContext())
4941 return;
4942
4943 // If not in C++, we perform name lookup for the translation unit via the
4944 // IdentifierInfo chains, don't bother to build a visible-declarations table.
4945 if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
4946 return;
4947
4948 // Serialize the contents of the mapping used for lookup. Note that,
4949 // although we have two very different code paths, the serialized
4950 // representation is the same for both cases: a declaration name,
4951 // followed by a size, followed by references to the visible
4952 // declarations that have that name.
4953 StoredDeclsMap *Map = DC->buildLookup();
4954 if (!Map || Map->empty())
4955 return;
4956
4957 Offsets.VisibleOffset = Stream.GetCurrentBitNo();
4958 // Create the on-disk hash table in a buffer.
4959 SmallString<4096> LookupTable;
4960 SmallString<4096> ModuleLocalLookupTable;
4961 SmallString<4096> TULookupTable;
4962 GenerateNameLookupTable(Context, ConstDC: DC, LookupTable, ModuleLocalLookupTable,
4963 TULookupTable);
4964
4965 // Write the lookup table
4966 RecordData::value_type Record[] = {DECL_CONTEXT_VISIBLE};
4967 Stream.EmitRecordWithBlob(Abbrev: DeclContextVisibleLookupAbbrev, Vals: Record,
4968 Blob: LookupTable);
4969 ++NumVisibleDeclContexts;
4970
4971 if (!ModuleLocalLookupTable.empty()) {
4972 Offsets.ModuleLocalOffset = Stream.GetCurrentBitNo();
4973 assert(Offsets.ModuleLocalOffset > Offsets.VisibleOffset);
4974 // Write the lookup table
4975 RecordData::value_type ModuleLocalRecord[] = {
4976 DECL_CONTEXT_MODULE_LOCAL_VISIBLE};
4977 Stream.EmitRecordWithBlob(Abbrev: DeclModuleLocalVisibleLookupAbbrev,
4978 Vals: ModuleLocalRecord, Blob: ModuleLocalLookupTable);
4979 ++NumModuleLocalDeclContexts;
4980 }
4981
4982 if (!TULookupTable.empty()) {
4983 Offsets.TULocalOffset = Stream.GetCurrentBitNo();
4984 // Write the lookup table
4985 RecordData::value_type TULocalDeclsRecord[] = {
4986 DECL_CONTEXT_TU_LOCAL_VISIBLE};
4987 Stream.EmitRecordWithBlob(Abbrev: DeclTULocalLookupAbbrev, Vals: TULocalDeclsRecord,
4988 Blob: TULookupTable);
4989 ++NumTULocalDeclContexts;
4990 }
4991}
4992
4993/// Write an UPDATE_VISIBLE block for the given context.
4994///
4995/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
4996/// DeclContext in a dependent AST file. As such, they only exist for the TU
4997/// (in C++), for namespaces, and for classes with forward-declared unscoped
4998/// enumeration members (in C++11).
4999void ASTWriter::WriteDeclContextVisibleUpdate(ASTContext &Context,
5000 const DeclContext *DC) {
5001 StoredDeclsMap *Map = DC->getLookupPtr();
5002 if (!Map || Map->empty())
5003 return;
5004
5005 // Create the on-disk hash table in a buffer.
5006 SmallString<4096> LookupTable;
5007 SmallString<4096> ModuleLocalLookupTable;
5008 SmallString<4096> TULookupTable;
5009 GenerateNameLookupTable(Context, ConstDC: DC, LookupTable, ModuleLocalLookupTable,
5010 TULookupTable);
5011
5012 // If we're updating a namespace, select a key declaration as the key for the
5013 // update record; those are the only ones that will be checked on reload.
5014 if (isa<NamespaceDecl>(Val: DC))
5015 DC = cast<DeclContext>(Val: Chain->getKeyDeclaration(D: cast<Decl>(Val: DC)));
5016
5017 // Write the lookup table
5018 RecordData::value_type Record[] = {UPDATE_VISIBLE,
5019 getDeclID(D: cast<Decl>(Val: DC)).getRawValue()};
5020 Stream.EmitRecordWithBlob(Abbrev: UpdateVisibleAbbrev, Vals: Record, Blob: LookupTable);
5021
5022 if (!ModuleLocalLookupTable.empty()) {
5023 // Write the module local lookup table
5024 RecordData::value_type ModuleLocalRecord[] = {
5025 UPDATE_MODULE_LOCAL_VISIBLE, getDeclID(D: cast<Decl>(Val: DC)).getRawValue()};
5026 Stream.EmitRecordWithBlob(Abbrev: ModuleLocalUpdateVisibleAbbrev, Vals: ModuleLocalRecord,
5027 Blob: ModuleLocalLookupTable);
5028 }
5029
5030 if (!TULookupTable.empty()) {
5031 RecordData::value_type GMFRecord[] = {
5032 UPDATE_TU_LOCAL_VISIBLE, getDeclID(D: cast<Decl>(Val: DC)).getRawValue()};
5033 Stream.EmitRecordWithBlob(Abbrev: TULocalUpdateVisibleAbbrev, Vals: GMFRecord,
5034 Blob: TULookupTable);
5035 }
5036}
5037
5038/// Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
5039void ASTWriter::WriteFPPragmaOptions(const FPOptionsOverride &Opts) {
5040 RecordData::value_type Record[] = {Opts.getAsOpaqueInt()};
5041 Stream.EmitRecord(Code: FP_PRAGMA_OPTIONS, Vals: Record);
5042}
5043
5044/// Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
5045void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
5046 if (!SemaRef.Context.getLangOpts().OpenCL)
5047 return;
5048
5049 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
5050 RecordData Record;
5051 for (const auto &I:Opts.OptMap) {
5052 AddString(Str: I.getKey(), Record);
5053 auto V = I.getValue();
5054 Record.push_back(Elt: V.Supported ? 1 : 0);
5055 Record.push_back(Elt: V.Enabled ? 1 : 0);
5056 Record.push_back(Elt: V.WithPragma ? 1 : 0);
5057 Record.push_back(Elt: V.Avail);
5058 Record.push_back(Elt: V.Core);
5059 Record.push_back(Elt: V.Opt);
5060 }
5061 Stream.EmitRecord(Code: OPENCL_EXTENSIONS, Vals: Record);
5062}
5063void ASTWriter::WriteCUDAPragmas(Sema &SemaRef) {
5064 if (SemaRef.CUDA().ForceHostDeviceDepth > 0) {
5065 RecordData::value_type Record[] = {SemaRef.CUDA().ForceHostDeviceDepth};
5066 Stream.EmitRecord(Code: CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH, Vals: Record);
5067 }
5068}
5069
5070void ASTWriter::WriteObjCCategories() {
5071 if (ObjCClassesWithCategories.empty())
5072 return;
5073
5074 SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
5075 RecordData Categories;
5076
5077 for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
5078 unsigned Size = 0;
5079 unsigned StartIndex = Categories.size();
5080
5081 ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
5082
5083 // Allocate space for the size.
5084 Categories.push_back(Elt: 0);
5085
5086 // Add the categories.
5087 for (ObjCInterfaceDecl::known_categories_iterator
5088 Cat = Class->known_categories_begin(),
5089 CatEnd = Class->known_categories_end();
5090 Cat != CatEnd; ++Cat, ++Size) {
5091 assert(getDeclID(*Cat).isValid() && "Bogus category");
5092 AddDeclRef(D: *Cat, Record&: Categories);
5093 }
5094
5095 // Update the size.
5096 Categories[StartIndex] = Size;
5097
5098 // Record this interface -> category map.
5099 ObjCCategoriesInfo CatInfo = { getDeclID(D: Class), StartIndex };
5100 CategoriesMap.push_back(Elt: CatInfo);
5101 }
5102
5103 // Sort the categories map by the definition ID, since the reader will be
5104 // performing binary searches on this information.
5105 llvm::array_pod_sort(Start: CategoriesMap.begin(), End: CategoriesMap.end());
5106
5107 // Emit the categories map.
5108 using namespace llvm;
5109
5110 auto Abbrev = std::make_shared<BitCodeAbbrev>();
5111 Abbrev->Add(OpInfo: BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
5112 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
5113 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
5114 unsigned AbbrevID = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
5115
5116 RecordData::value_type Record[] = {OBJC_CATEGORIES_MAP, CategoriesMap.size()};
5117 Stream.EmitRecordWithBlob(Abbrev: AbbrevID, Vals: Record,
5118 BlobData: reinterpret_cast<char *>(CategoriesMap.data()),
5119 BlobLen: CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
5120
5121 // Emit the category lists.
5122 Stream.EmitRecord(Code: OBJC_CATEGORIES, Vals: Categories);
5123}
5124
5125void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
5126 Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap;
5127
5128 if (LPTMap.empty())
5129 return;
5130
5131 RecordData Record;
5132 for (auto &LPTMapEntry : LPTMap) {
5133 const FunctionDecl *FD = LPTMapEntry.first;
5134 LateParsedTemplate &LPT = *LPTMapEntry.second;
5135 AddDeclRef(D: FD, Record);
5136 AddDeclRef(D: LPT.D, Record);
5137 Record.push_back(Elt: LPT.FPO.getAsOpaqueInt());
5138 Record.push_back(Elt: LPT.Toks.size());
5139
5140 for (const auto &Tok : LPT.Toks) {
5141 AddToken(Tok, Record);
5142 }
5143 }
5144 Stream.EmitRecord(Code: LATE_PARSED_TEMPLATE, Vals: Record);
5145}
5146
5147/// Write the state of 'pragma clang optimize' at the end of the module.
5148void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
5149 RecordData Record;
5150 SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
5151 AddSourceLocation(Loc: PragmaLoc, Record);
5152 Stream.EmitRecord(Code: OPTIMIZE_PRAGMA_OPTIONS, Vals: Record);
5153}
5154
5155/// Write the state of 'pragma ms_struct' at the end of the module.
5156void ASTWriter::WriteMSStructPragmaOptions(Sema &SemaRef) {
5157 RecordData Record;
5158 Record.push_back(Elt: SemaRef.MSStructPragmaOn ? PMSST_ON : PMSST_OFF);
5159 Stream.EmitRecord(Code: MSSTRUCT_PRAGMA_OPTIONS, Vals: Record);
5160}
5161
5162/// Write the state of 'pragma pointers_to_members' at the end of the
5163//module.
5164void ASTWriter::WriteMSPointersToMembersPragmaOptions(Sema &SemaRef) {
5165 RecordData Record;
5166 Record.push_back(Elt: SemaRef.MSPointerToMemberRepresentationMethod);
5167 AddSourceLocation(Loc: SemaRef.ImplicitMSInheritanceAttrLoc, Record);
5168 Stream.EmitRecord(Code: POINTERS_TO_MEMBERS_PRAGMA_OPTIONS, Vals: Record);
5169}
5170
5171/// Write the state of 'pragma align/pack' at the end of the module.
5172void ASTWriter::WritePackPragmaOptions(Sema &SemaRef) {
5173 // Don't serialize pragma align/pack state for modules, since it should only
5174 // take effect on a per-submodule basis.
5175 if (WritingModule)
5176 return;
5177
5178 RecordData Record;
5179 AddAlignPackInfo(Info: SemaRef.AlignPackStack.CurrentValue, Record);
5180 AddSourceLocation(Loc: SemaRef.AlignPackStack.CurrentPragmaLocation, Record);
5181 Record.push_back(Elt: SemaRef.AlignPackStack.Stack.size());
5182 for (const auto &StackEntry : SemaRef.AlignPackStack.Stack) {
5183 AddAlignPackInfo(Info: StackEntry.Value, Record);
5184 AddSourceLocation(Loc: StackEntry.PragmaLocation, Record);
5185 AddSourceLocation(Loc: StackEntry.PragmaPushLocation, Record);
5186 AddString(Str: StackEntry.StackSlotLabel, Record);
5187 }
5188 Stream.EmitRecord(Code: ALIGN_PACK_PRAGMA_OPTIONS, Vals: Record);
5189}
5190
5191/// Write the state of 'pragma float_control' at the end of the module.
5192void ASTWriter::WriteFloatControlPragmaOptions(Sema &SemaRef) {
5193 // Don't serialize pragma float_control state for modules,
5194 // since it should only take effect on a per-submodule basis.
5195 if (WritingModule)
5196 return;
5197
5198 RecordData Record;
5199 Record.push_back(Elt: SemaRef.FpPragmaStack.CurrentValue.getAsOpaqueInt());
5200 AddSourceLocation(Loc: SemaRef.FpPragmaStack.CurrentPragmaLocation, Record);
5201 Record.push_back(Elt: SemaRef.FpPragmaStack.Stack.size());
5202 for (const auto &StackEntry : SemaRef.FpPragmaStack.Stack) {
5203 Record.push_back(Elt: StackEntry.Value.getAsOpaqueInt());
5204 AddSourceLocation(Loc: StackEntry.PragmaLocation, Record);
5205 AddSourceLocation(Loc: StackEntry.PragmaPushLocation, Record);
5206 AddString(Str: StackEntry.StackSlotLabel, Record);
5207 }
5208 Stream.EmitRecord(Code: FLOAT_CONTROL_PRAGMA_OPTIONS, Vals: Record);
5209}
5210
5211/// Write Sema's collected list of declarations with unverified effects.
5212void ASTWriter::WriteDeclsWithEffectsToVerify(Sema &SemaRef) {
5213 if (SemaRef.DeclsWithEffectsToVerify.empty())
5214 return;
5215 RecordData Record;
5216 for (const auto *D : SemaRef.DeclsWithEffectsToVerify) {
5217 AddDeclRef(D, Record);
5218 }
5219 Stream.EmitRecord(Code: DECLS_WITH_EFFECTS_TO_VERIFY, Vals: Record);
5220}
5221
5222void ASTWriter::WriteModuleFileExtension(Sema &SemaRef,
5223 ModuleFileExtensionWriter &Writer) {
5224 // Enter the extension block.
5225 Stream.EnterSubblock(BlockID: EXTENSION_BLOCK_ID, CodeLen: 4);
5226
5227 // Emit the metadata record abbreviation.
5228 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
5229 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(EXTENSION_METADATA));
5230 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
5231 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
5232 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
5233 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
5234 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
5235 unsigned Abbrev = Stream.EmitAbbrev(Abbv: std::move(Abv));
5236
5237 // Emit the metadata record.
5238 RecordData Record;
5239 auto Metadata = Writer.getExtension()->getExtensionMetadata();
5240 Record.push_back(Elt: EXTENSION_METADATA);
5241 Record.push_back(Elt: Metadata.MajorVersion);
5242 Record.push_back(Elt: Metadata.MinorVersion);
5243 Record.push_back(Elt: Metadata.BlockName.size());
5244 Record.push_back(Elt: Metadata.UserInfo.size());
5245 SmallString<64> Buffer;
5246 Buffer += Metadata.BlockName;
5247 Buffer += Metadata.UserInfo;
5248 Stream.EmitRecordWithBlob(Abbrev, Vals: Record, Blob: Buffer);
5249
5250 // Emit the contents of the extension block.
5251 Writer.writeExtensionContents(SemaRef, Stream);
5252
5253 // Exit the extension block.
5254 Stream.ExitBlock();
5255}
5256
5257void ASTWriter::WriteRISCVIntrinsicPragmas(Sema &SemaRef) {
5258 RecordData Record;
5259 // Need to update this when new intrinsic class is added.
5260 Record.push_back(/*size*/ Elt: 3);
5261 Record.push_back(Elt: SemaRef.RISCV().DeclareRVVBuiltins);
5262 Record.push_back(Elt: SemaRef.RISCV().DeclareSiFiveVectorBuiltins);
5263 Record.push_back(Elt: SemaRef.RISCV().DeclareAndesVectorBuiltins);
5264 Stream.EmitRecord(Code: RISCV_VECTOR_INTRINSICS_PRAGMA, Vals: Record);
5265}
5266
5267//===----------------------------------------------------------------------===//
5268// General Serialization Routines
5269//===----------------------------------------------------------------------===//
5270
5271void ASTRecordWriter::AddAttr(const Attr *A) {
5272 auto &Record = *this;
5273 // FIXME: Clang can't handle the serialization/deserialization of
5274 // preferred_name properly now. See
5275 // https://github.com/llvm/llvm-project/issues/56490 for example.
5276 if (!A ||
5277 (isa<PreferredNameAttr>(Val: A) && (Writer->isWritingStdCXXNamedModules() ||
5278 Writer->isWritingStdCXXHeaderUnit())))
5279 return Record.push_back(N: 0);
5280
5281 Record.push_back(N: A->getKind() + 1); // FIXME: stable encoding, target attrs
5282
5283 Record.AddIdentifierRef(II: A->getAttrName());
5284 Record.AddIdentifierRef(II: A->getScopeName());
5285 Record.AddSourceRange(Range: A->getRange());
5286 Record.AddSourceLocation(Loc: A->getScopeLoc());
5287 Record.push_back(N: A->getParsedKind());
5288 Record.push_back(N: A->getSyntax());
5289 Record.push_back(N: A->getAttributeSpellingListIndexRaw());
5290 Record.push_back(N: A->isRegularKeywordAttribute());
5291
5292#include "clang/Serialization/AttrPCHWrite.inc"
5293}
5294
5295/// Emit the list of attributes to the specified record.
5296void ASTRecordWriter::AddAttributes(ArrayRef<const Attr *> Attrs) {
5297 push_back(N: Attrs.size());
5298 for (const auto *A : Attrs)
5299 AddAttr(A);
5300}
5301
5302void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) {
5303 AddSourceLocation(Loc: Tok.getLocation(), Record);
5304 // FIXME: Should translate token kind to a stable encoding.
5305 Record.push_back(Elt: Tok.getKind());
5306 // FIXME: Should translate token flags to a stable encoding.
5307 Record.push_back(Elt: Tok.getFlags());
5308
5309 if (Tok.isAnnotation()) {
5310 AddSourceLocation(Loc: Tok.getAnnotationEndLoc(), Record);
5311 switch (Tok.getKind()) {
5312 case tok::annot_pragma_loop_hint: {
5313 auto *Info = static_cast<PragmaLoopHintInfo *>(Tok.getAnnotationValue());
5314 AddToken(Tok: Info->PragmaName, Record);
5315 AddToken(Tok: Info->Option, Record);
5316 Record.push_back(Elt: Info->Toks.size());
5317 for (const auto &T : Info->Toks)
5318 AddToken(Tok: T, Record);
5319 break;
5320 }
5321 case tok::annot_pragma_pack: {
5322 auto *Info =
5323 static_cast<Sema::PragmaPackInfo *>(Tok.getAnnotationValue());
5324 Record.push_back(Elt: static_cast<unsigned>(Info->Action));
5325 AddString(Str: Info->SlotLabel, Record);
5326 AddToken(Tok: Info->Alignment, Record);
5327 break;
5328 }
5329 // Some annotation tokens do not use the PtrData field.
5330 case tok::annot_pragma_openmp:
5331 case tok::annot_pragma_openmp_end:
5332 case tok::annot_pragma_unused:
5333 case tok::annot_pragma_openacc:
5334 case tok::annot_pragma_openacc_end:
5335 case tok::annot_repl_input_end:
5336 break;
5337 default:
5338 llvm_unreachable("missing serialization code for annotation token");
5339 }
5340 } else {
5341 Record.push_back(Elt: Tok.getLength());
5342 // FIXME: When reading literal tokens, reconstruct the literal pointer if it
5343 // is needed.
5344 AddIdentifierRef(II: Tok.getIdentifierInfo(), Record);
5345 }
5346}
5347
5348void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
5349 Record.push_back(Elt: Str.size());
5350 llvm::append_range(C&: Record, R&: Str);
5351}
5352
5353void ASTWriter::AddStringBlob(StringRef Str, RecordDataImpl &Record,
5354 SmallVectorImpl<char> &Blob) {
5355 Record.push_back(Elt: Str.size());
5356 llvm::append_range(C&: Blob, R&: Str);
5357}
5358
5359bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) {
5360 assert(WritingAST && "can't prepare path for output when not writing AST");
5361
5362 // Leave special file names as they are.
5363 StringRef PathStr(Path.data(), Path.size());
5364 if (PathStr == "<built-in>" || PathStr == "<command line>")
5365 return false;
5366
5367 bool Changed =
5368 PP->getFileManager().makeAbsolutePath(Path, /*Canonicalize=*/true);
5369 // Remove a prefix to make the path relative, if relevant.
5370 const char *PathBegin = Path.data();
5371 const char *PathPtr =
5372 adjustFilenameForRelocatableAST(Filename: PathBegin, BaseDir: BaseDirectory);
5373 if (PathPtr != PathBegin) {
5374 Path.erase(CS: Path.begin(), CE: Path.begin() + (PathPtr - PathBegin));
5375 Changed = true;
5376 }
5377
5378 return Changed;
5379}
5380
5381void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) {
5382 SmallString<128> FilePath(Path);
5383 PreparePathForOutput(Path&: FilePath);
5384 AddString(Str: FilePath, Record);
5385}
5386
5387void ASTWriter::AddPathBlob(StringRef Path, RecordDataImpl &Record,
5388 SmallVectorImpl<char> &Blob) {
5389 SmallString<128> FilePath(Path);
5390 PreparePathForOutput(Path&: FilePath);
5391 AddStringBlob(Str: FilePath, Record, Blob);
5392}
5393
5394void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataRef Record,
5395 StringRef Path) {
5396 SmallString<128> FilePath(Path);
5397 PreparePathForOutput(Path&: FilePath);
5398 Stream.EmitRecordWithBlob(Abbrev, Vals: Record, Blob: FilePath);
5399}
5400
5401void ASTWriter::AddVersionTuple(const VersionTuple &Version,
5402 RecordDataImpl &Record) {
5403 Record.push_back(Elt: Version.getMajor());
5404 if (std::optional<unsigned> Minor = Version.getMinor())
5405 Record.push_back(Elt: *Minor + 1);
5406 else
5407 Record.push_back(Elt: 0);
5408 if (std::optional<unsigned> Subminor = Version.getSubminor())
5409 Record.push_back(Elt: *Subminor + 1);
5410 else
5411 Record.push_back(Elt: 0);
5412}
5413
5414/// Note that the identifier II occurs at the given offset
5415/// within the identifier table.
5416void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
5417 IdentifierID ID = IdentifierIDs[II];
5418 // Only store offsets new to this AST file. Other identifier names are looked
5419 // up earlier in the chain and thus don't need an offset.
5420 if (!isLocalIdentifierID(ID))
5421 return;
5422
5423 // For local identifiers, the module file index must be 0.
5424
5425 assert(ID != 0);
5426 ID -= NUM_PREDEF_IDENT_IDS;
5427 assert(ID < IdentifierOffsets.size());
5428 IdentifierOffsets[ID] = Offset;
5429}
5430
5431/// Note that the selector Sel occurs at the given offset
5432/// within the method pool/selector table.
5433void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
5434 unsigned ID = SelectorIDs[Sel];
5435 assert(ID && "Unknown selector");
5436 // Don't record offsets for selectors that are also available in a different
5437 // file.
5438 if (ID < FirstSelectorID)
5439 return;
5440 SelectorOffsets[ID - FirstSelectorID] = Offset;
5441}
5442
5443ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream,
5444 SmallVectorImpl<char> &Buffer, ModuleCache &ModCache,
5445 const CodeGenOptions &CodeGenOpts,
5446 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
5447 bool IncludeTimestamps, bool BuildingImplicitModule,
5448 bool GeneratingReducedBMI)
5449 : Stream(Stream), Buffer(Buffer), ModCache(ModCache),
5450 CodeGenOpts(CodeGenOpts), IncludeTimestamps(IncludeTimestamps),
5451 BuildingImplicitModule(BuildingImplicitModule),
5452 GeneratingReducedBMI(GeneratingReducedBMI) {
5453 for (const auto &Ext : Extensions) {
5454 if (auto Writer = Ext->createExtensionWriter(Writer&: *this))
5455 ModuleFileExtensionWriters.push_back(x: std::move(Writer));
5456 }
5457}
5458
5459ASTWriter::~ASTWriter() = default;
5460
5461const LangOptions &ASTWriter::getLangOpts() const {
5462 assert(WritingAST && "can't determine lang opts when not writing AST");
5463 return PP->getLangOpts();
5464}
5465
5466time_t ASTWriter::getTimestampForOutput(const FileEntry *E) const {
5467 return IncludeTimestamps ? E->getModificationTime() : 0;
5468}
5469
5470ASTFileSignature
5471ASTWriter::WriteAST(llvm::PointerUnion<Sema *, Preprocessor *> Subject,
5472 StringRef OutputFile, Module *WritingModule,
5473 StringRef isysroot, bool ShouldCacheASTInMemory) {
5474 llvm::TimeTraceScope scope("WriteAST", OutputFile);
5475 WritingAST = true;
5476
5477 Sema *SemaPtr = dyn_cast<Sema *>(Val&: Subject);
5478 Preprocessor &PPRef =
5479 SemaPtr ? SemaPtr->getPreprocessor() : *cast<Preprocessor *>(Val&: Subject);
5480
5481 ASTHasCompilerErrors = PPRef.getDiagnostics().hasUncompilableErrorOccurred();
5482
5483 // Emit the file header.
5484 Stream.Emit(Val: (unsigned)'C', NumBits: 8);
5485 Stream.Emit(Val: (unsigned)'P', NumBits: 8);
5486 Stream.Emit(Val: (unsigned)'C', NumBits: 8);
5487 Stream.Emit(Val: (unsigned)'H', NumBits: 8);
5488
5489 WriteBlockInfoBlock();
5490
5491 PP = &PPRef;
5492 this->WritingModule = WritingModule;
5493 ASTFileSignature Signature = WriteASTCore(SemaPtr, isysroot, WritingModule);
5494 PP = nullptr;
5495 this->WritingModule = nullptr;
5496 this->BaseDirectory.clear();
5497
5498 WritingAST = false;
5499
5500 if (ShouldCacheASTInMemory) {
5501 // Construct MemoryBuffer and update buffer manager.
5502 ModCache.getInMemoryModuleCache().addBuiltPCM(
5503 Filename: OutputFile, Buffer: llvm::MemoryBuffer::getMemBufferCopy(
5504 InputData: StringRef(Buffer.begin(), Buffer.size())));
5505 }
5506 return Signature;
5507}
5508
5509template<typename Vector>
5510static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec) {
5511 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
5512 I != E; ++I) {
5513 Writer.GetDeclRef(D: *I);
5514 }
5515}
5516
5517template <typename Vector>
5518static void AddLazyVectorEmiitedDecls(ASTWriter &Writer, Vector &Vec,
5519 ASTWriter::RecordData &Record) {
5520 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
5521 I != E; ++I) {
5522 Writer.AddEmittedDeclRef(D: *I, Record);
5523 }
5524}
5525
5526void ASTWriter::computeNonAffectingInputFiles() {
5527 SourceManager &SrcMgr = PP->getSourceManager();
5528 unsigned N = SrcMgr.local_sloc_entry_size();
5529
5530 IsSLocAffecting.resize(N, t: true);
5531 IsSLocFileEntryAffecting.resize(N, t: true);
5532
5533 if (!WritingModule)
5534 return;
5535
5536 auto AffectingModuleMaps = GetAffectingModuleMaps(PP: *PP, RootModule: WritingModule);
5537
5538 unsigned FileIDAdjustment = 0;
5539 unsigned OffsetAdjustment = 0;
5540
5541 NonAffectingFileIDAdjustments.reserve(n: N);
5542 NonAffectingOffsetAdjustments.reserve(n: N);
5543
5544 NonAffectingFileIDAdjustments.push_back(x: FileIDAdjustment);
5545 NonAffectingOffsetAdjustments.push_back(x: OffsetAdjustment);
5546
5547 for (unsigned I = 1; I != N; ++I) {
5548 const SrcMgr::SLocEntry *SLoc = &SrcMgr.getLocalSLocEntry(Index: I);
5549 FileID FID = FileID::get(V: I);
5550 assert(&SrcMgr.getSLocEntry(FID) == SLoc);
5551
5552 if (!SLoc->isFile())
5553 continue;
5554 const SrcMgr::FileInfo &File = SLoc->getFile();
5555 const SrcMgr::ContentCache *Cache = &File.getContentCache();
5556 if (!Cache->OrigEntry)
5557 continue;
5558
5559 // Don't prune anything other than module maps.
5560 if (!isModuleMap(CK: File.getFileCharacteristic()))
5561 continue;
5562
5563 // Don't prune module maps if all are guaranteed to be affecting.
5564 if (!AffectingModuleMaps)
5565 continue;
5566
5567 // Don't prune module maps that are affecting.
5568 if (AffectingModuleMaps->DefinitionFileIDs.contains(V: FID))
5569 continue;
5570
5571 IsSLocAffecting[I] = false;
5572 IsSLocFileEntryAffecting[I] =
5573 AffectingModuleMaps->DefinitionFiles.contains(V: *Cache->OrigEntry);
5574
5575 FileIDAdjustment += 1;
5576 // Even empty files take up one element in the offset table.
5577 OffsetAdjustment += SrcMgr.getFileIDSize(FID) + 1;
5578
5579 // If the previous file was non-affecting as well, just extend its entry
5580 // with our information.
5581 if (!NonAffectingFileIDs.empty() &&
5582 NonAffectingFileIDs.back().ID == FID.ID - 1) {
5583 NonAffectingFileIDs.back() = FID;
5584 NonAffectingRanges.back().setEnd(SrcMgr.getLocForEndOfFile(FID));
5585 NonAffectingFileIDAdjustments.back() = FileIDAdjustment;
5586 NonAffectingOffsetAdjustments.back() = OffsetAdjustment;
5587 continue;
5588 }
5589
5590 NonAffectingFileIDs.push_back(x: FID);
5591 NonAffectingRanges.emplace_back(args: SrcMgr.getLocForStartOfFile(FID),
5592 args: SrcMgr.getLocForEndOfFile(FID));
5593 NonAffectingFileIDAdjustments.push_back(x: FileIDAdjustment);
5594 NonAffectingOffsetAdjustments.push_back(x: OffsetAdjustment);
5595 }
5596
5597 if (!PP->getHeaderSearchInfo().getHeaderSearchOpts().ModulesIncludeVFSUsage)
5598 return;
5599
5600 FileManager &FileMgr = PP->getFileManager();
5601 FileMgr.trackVFSUsage(Active: true);
5602 // Lookup the paths in the VFS to trigger `-ivfsoverlay` usage tracking.
5603 for (StringRef Path :
5604 PP->getHeaderSearchInfo().getHeaderSearchOpts().VFSOverlayFiles)
5605 FileMgr.getVirtualFileSystem().exists(Path);
5606 for (unsigned I = 1; I != N; ++I) {
5607 if (IsSLocAffecting[I]) {
5608 const SrcMgr::SLocEntry *SLoc = &SrcMgr.getLocalSLocEntry(Index: I);
5609 if (!SLoc->isFile())
5610 continue;
5611 const SrcMgr::FileInfo &File = SLoc->getFile();
5612 const SrcMgr::ContentCache *Cache = &File.getContentCache();
5613 if (!Cache->OrigEntry)
5614 continue;
5615 FileMgr.getVirtualFileSystem().exists(
5616 Path: Cache->OrigEntry->getNameAsRequested());
5617 }
5618 }
5619 FileMgr.trackVFSUsage(Active: false);
5620}
5621
5622void ASTWriter::PrepareWritingSpecialDecls(Sema &SemaRef) {
5623 ASTContext &Context = SemaRef.Context;
5624
5625 bool isModule = WritingModule != nullptr;
5626
5627 // Set up predefined declaration IDs.
5628 auto RegisterPredefDecl = [&] (Decl *D, PredefinedDeclIDs ID) {
5629 if (D) {
5630 assert(D->isCanonicalDecl() && "predefined decl is not canonical");
5631 DeclIDs[D] = ID;
5632 PredefinedDecls.insert(Ptr: D);
5633 }
5634 };
5635 RegisterPredefDecl(Context.getTranslationUnitDecl(),
5636 PREDEF_DECL_TRANSLATION_UNIT_ID);
5637 RegisterPredefDecl(Context.ObjCIdDecl, PREDEF_DECL_OBJC_ID_ID);
5638 RegisterPredefDecl(Context.ObjCSelDecl, PREDEF_DECL_OBJC_SEL_ID);
5639 RegisterPredefDecl(Context.ObjCClassDecl, PREDEF_DECL_OBJC_CLASS_ID);
5640 RegisterPredefDecl(Context.ObjCProtocolClassDecl,
5641 PREDEF_DECL_OBJC_PROTOCOL_ID);
5642 RegisterPredefDecl(Context.Int128Decl, PREDEF_DECL_INT_128_ID);
5643 RegisterPredefDecl(Context.UInt128Decl, PREDEF_DECL_UNSIGNED_INT_128_ID);
5644 RegisterPredefDecl(Context.ObjCInstanceTypeDecl,
5645 PREDEF_DECL_OBJC_INSTANCETYPE_ID);
5646 RegisterPredefDecl(Context.BuiltinVaListDecl, PREDEF_DECL_BUILTIN_VA_LIST_ID);
5647 RegisterPredefDecl(Context.VaListTagDecl, PREDEF_DECL_VA_LIST_TAG);
5648 RegisterPredefDecl(Context.BuiltinMSVaListDecl,
5649 PREDEF_DECL_BUILTIN_MS_VA_LIST_ID);
5650 RegisterPredefDecl(Context.MSGuidTagDecl,
5651 PREDEF_DECL_BUILTIN_MS_GUID_ID);
5652 RegisterPredefDecl(Context.MSTypeInfoTagDecl,
5653 PREDEF_DECL_BUILTIN_MS_TYPE_INFO_TAG_ID);
5654 RegisterPredefDecl(Context.ExternCContext, PREDEF_DECL_EXTERN_C_CONTEXT_ID);
5655 RegisterPredefDecl(Context.CFConstantStringTypeDecl,
5656 PREDEF_DECL_CF_CONSTANT_STRING_ID);
5657 RegisterPredefDecl(Context.CFConstantStringTagDecl,
5658 PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID);
5659#define BuiltinTemplate(BTName) \
5660 RegisterPredefDecl(Context.Decl##BTName, PREDEF_DECL##BTName##_ID);
5661#include "clang/Basic/BuiltinTemplates.inc"
5662
5663 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
5664
5665 // Force all top level declarations to be emitted.
5666 //
5667 // We start emitting top level declarations from the module purview to
5668 // implement the eliding unreachable declaration feature.
5669 for (const auto *D : TU->noload_decls()) {
5670 if (D->isFromASTFile())
5671 continue;
5672
5673 if (GeneratingReducedBMI) {
5674 if (D->isFromExplicitGlobalModule())
5675 continue;
5676
5677 // Don't force emitting static entities.
5678 //
5679 // Technically, all static entities shouldn't be in reduced BMI. The
5680 // language also specifies that the program exposes TU-local entities
5681 // is ill-formed. However, in practice, there are a lot of projects
5682 // uses `static inline` in the headers. So we can't get rid of all
5683 // static entities in reduced BMI now.
5684 if (IsInternalDeclFromFileContext(D))
5685 continue;
5686 }
5687
5688 // If we're writing C++ named modules, don't emit declarations which are
5689 // not from modules by default. They may be built in declarations (be
5690 // handled above) or implcit declarations (see the implementation of
5691 // `Sema::Initialize()` for example).
5692 if (isWritingStdCXXNamedModules() && !D->getOwningModule() &&
5693 D->isImplicit())
5694 continue;
5695
5696 GetDeclRef(D);
5697 }
5698
5699 if (GeneratingReducedBMI)
5700 return;
5701
5702 // Writing all of the tentative definitions in this file, in
5703 // TentativeDefinitions order. Generally, this record will be empty for
5704 // headers.
5705 AddLazyVectorDecls(Writer&: *this, Vec&: SemaRef.TentativeDefinitions);
5706
5707 // Writing all of the file scoped decls in this file.
5708 if (!isModule)
5709 AddLazyVectorDecls(Writer&: *this, Vec&: SemaRef.UnusedFileScopedDecls);
5710
5711 // Writing all of the delegating constructors we still need
5712 // to resolve.
5713 if (!isModule)
5714 AddLazyVectorDecls(Writer&: *this, Vec&: SemaRef.DelegatingCtorDecls);
5715
5716 // Writing all of the ext_vector declarations.
5717 AddLazyVectorDecls(Writer&: *this, Vec&: SemaRef.ExtVectorDecls);
5718
5719 // Writing all of the VTable uses information.
5720 if (!SemaRef.VTableUses.empty())
5721 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I)
5722 GetDeclRef(D: SemaRef.VTableUses[I].first);
5723
5724 // Writing all of the UnusedLocalTypedefNameCandidates.
5725 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
5726 GetDeclRef(D: TD);
5727
5728 // Writing all of pending implicit instantiations.
5729 for (const auto &I : SemaRef.PendingInstantiations)
5730 GetDeclRef(D: I.first);
5731 assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
5732 "There are local ones at end of translation unit!");
5733
5734 // Writing some declaration references.
5735 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc || SemaRef.StdAlignValT) {
5736 GetDeclRef(D: SemaRef.getStdNamespace());
5737 GetDeclRef(D: SemaRef.getStdBadAlloc());
5738 GetDeclRef(D: SemaRef.getStdAlignValT());
5739 }
5740
5741 if (Context.getcudaConfigureCallDecl() ||
5742 Context.getcudaGetParameterBufferDecl() ||
5743 Context.getcudaLaunchDeviceDecl()) {
5744 GetDeclRef(D: Context.getcudaConfigureCallDecl());
5745 GetDeclRef(D: Context.getcudaGetParameterBufferDecl());
5746 GetDeclRef(D: Context.getcudaLaunchDeviceDecl());
5747 }
5748
5749 // Writing all of the known namespaces.
5750 for (const auto &I : SemaRef.KnownNamespaces)
5751 if (!I.second)
5752 GetDeclRef(D: I.first);
5753
5754 // Writing all used, undefined objects that require definitions.
5755 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
5756 SemaRef.getUndefinedButUsed(Undefined);
5757 for (const auto &I : Undefined)
5758 GetDeclRef(D: I.first);
5759
5760 // Writing all delete-expressions that we would like to
5761 // analyze later in AST.
5762 if (!isModule)
5763 for (const auto &DeleteExprsInfo :
5764 SemaRef.getMismatchingDeleteExpressions())
5765 GetDeclRef(D: DeleteExprsInfo.first);
5766
5767 // Make sure visible decls, added to DeclContexts previously loaded from
5768 // an AST file, are registered for serialization. Likewise for template
5769 // specializations added to imported templates.
5770 for (const auto *I : DeclsToEmitEvenIfUnreferenced)
5771 GetDeclRef(D: I);
5772 DeclsToEmitEvenIfUnreferenced.clear();
5773
5774 // Make sure all decls associated with an identifier are registered for
5775 // serialization, if we're storing decls with identifiers.
5776 if (!WritingModule || !getLangOpts().CPlusPlus) {
5777 llvm::SmallVector<const IdentifierInfo*, 256> IIs;
5778 for (const auto &ID : SemaRef.PP.getIdentifierTable()) {
5779 const IdentifierInfo *II = ID.second;
5780 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization() ||
5781 II->hasFETokenInfoChangedSinceDeserialization())
5782 IIs.push_back(Elt: II);
5783 }
5784 // Sort the identifiers to visit based on their name.
5785 llvm::sort(C&: IIs, Comp: llvm::deref<std::less<>>());
5786 const LangOptions &LangOpts = getLangOpts();
5787 for (const IdentifierInfo *II : IIs)
5788 for (NamedDecl *D : SemaRef.IdResolver.decls(Name: II))
5789 GetDeclRef(D: getDeclForLocalLookup(LangOpts, D));
5790 }
5791
5792 // Write all of the DeclsToCheckForDeferredDiags.
5793 for (auto *D : SemaRef.DeclsToCheckForDeferredDiags)
5794 GetDeclRef(D);
5795
5796 // Write all classes that need to emit the vtable definitions if required.
5797 if (isWritingStdCXXNamedModules())
5798 for (CXXRecordDecl *RD : PendingEmittingVTables)
5799 GetDeclRef(D: RD);
5800 else
5801 PendingEmittingVTables.clear();
5802}
5803
5804void ASTWriter::WriteSpecialDeclRecords(Sema &SemaRef) {
5805 ASTContext &Context = SemaRef.Context;
5806
5807 bool isModule = WritingModule != nullptr;
5808
5809 // Write the record containing external, unnamed definitions.
5810 if (!EagerlyDeserializedDecls.empty())
5811 Stream.EmitRecord(Code: EAGERLY_DESERIALIZED_DECLS, Vals: EagerlyDeserializedDecls);
5812
5813 if (!ModularCodegenDecls.empty())
5814 Stream.EmitRecord(Code: MODULAR_CODEGEN_DECLS, Vals: ModularCodegenDecls);
5815
5816 // Write the record containing tentative definitions.
5817 RecordData TentativeDefinitions;
5818 AddLazyVectorEmiitedDecls(Writer&: *this, Vec&: SemaRef.TentativeDefinitions,
5819 Record&: TentativeDefinitions);
5820 if (!TentativeDefinitions.empty())
5821 Stream.EmitRecord(Code: TENTATIVE_DEFINITIONS, Vals: TentativeDefinitions);
5822
5823 // Write the record containing unused file scoped decls.
5824 RecordData UnusedFileScopedDecls;
5825 if (!isModule)
5826 AddLazyVectorEmiitedDecls(Writer&: *this, Vec&: SemaRef.UnusedFileScopedDecls,
5827 Record&: UnusedFileScopedDecls);
5828 if (!UnusedFileScopedDecls.empty())
5829 Stream.EmitRecord(Code: UNUSED_FILESCOPED_DECLS, Vals: UnusedFileScopedDecls);
5830
5831 // Write the record containing ext_vector type names.
5832 RecordData ExtVectorDecls;
5833 AddLazyVectorEmiitedDecls(Writer&: *this, Vec&: SemaRef.ExtVectorDecls, Record&: ExtVectorDecls);
5834 if (!ExtVectorDecls.empty())
5835 Stream.EmitRecord(Code: EXT_VECTOR_DECLS, Vals: ExtVectorDecls);
5836
5837 // Write the record containing VTable uses information.
5838 RecordData VTableUses;
5839 if (!SemaRef.VTableUses.empty()) {
5840 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
5841 CXXRecordDecl *D = SemaRef.VTableUses[I].first;
5842 if (!wasDeclEmitted(D))
5843 continue;
5844
5845 AddDeclRef(D, Record&: VTableUses);
5846 AddSourceLocation(Loc: SemaRef.VTableUses[I].second, Record&: VTableUses);
5847 VTableUses.push_back(Elt: SemaRef.VTablesUsed[D]);
5848 }
5849 Stream.EmitRecord(Code: VTABLE_USES, Vals: VTableUses);
5850 }
5851
5852 // Write the record containing potentially unused local typedefs.
5853 RecordData UnusedLocalTypedefNameCandidates;
5854 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
5855 AddEmittedDeclRef(D: TD, Record&: UnusedLocalTypedefNameCandidates);
5856 if (!UnusedLocalTypedefNameCandidates.empty())
5857 Stream.EmitRecord(Code: UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
5858 Vals: UnusedLocalTypedefNameCandidates);
5859
5860 if (!GeneratingReducedBMI) {
5861 // Write the record containing pending implicit instantiations.
5862 RecordData PendingInstantiations;
5863 for (const auto &I : SemaRef.PendingInstantiations) {
5864 if (!wasDeclEmitted(D: I.first))
5865 continue;
5866
5867 AddDeclRef(D: I.first, Record&: PendingInstantiations);
5868 AddSourceLocation(Loc: I.second, Record&: PendingInstantiations);
5869 }
5870 if (!PendingInstantiations.empty())
5871 Stream.EmitRecord(Code: PENDING_IMPLICIT_INSTANTIATIONS, Vals: PendingInstantiations);
5872 }
5873
5874 auto AddEmittedDeclRefOrZero = [this](RecordData &Refs, Decl *D) {
5875 if (!D || !wasDeclEmitted(D))
5876 Refs.push_back(Elt: 0);
5877 else
5878 AddDeclRef(D, Record&: Refs);
5879 };
5880
5881 // Write the record containing declaration references of Sema.
5882 RecordData SemaDeclRefs;
5883 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc || SemaRef.StdAlignValT) {
5884 AddEmittedDeclRefOrZero(SemaDeclRefs, SemaRef.getStdNamespace());
5885 AddEmittedDeclRefOrZero(SemaDeclRefs, SemaRef.getStdBadAlloc());
5886 AddEmittedDeclRefOrZero(SemaDeclRefs, SemaRef.getStdAlignValT());
5887 }
5888 if (!SemaDeclRefs.empty())
5889 Stream.EmitRecord(Code: SEMA_DECL_REFS, Vals: SemaDeclRefs);
5890
5891 // Write the record containing decls to be checked for deferred diags.
5892 RecordData DeclsToCheckForDeferredDiags;
5893 for (auto *D : SemaRef.DeclsToCheckForDeferredDiags)
5894 if (wasDeclEmitted(D))
5895 AddDeclRef(D, Record&: DeclsToCheckForDeferredDiags);
5896 if (!DeclsToCheckForDeferredDiags.empty())
5897 Stream.EmitRecord(Code: DECLS_TO_CHECK_FOR_DEFERRED_DIAGS,
5898 Vals: DeclsToCheckForDeferredDiags);
5899
5900 // Write the record containing CUDA-specific declaration references.
5901 RecordData CUDASpecialDeclRefs;
5902 if (auto *CudaCallDecl = Context.getcudaConfigureCallDecl(),
5903 *CudaGetParamDecl = Context.getcudaGetParameterBufferDecl(),
5904 *CudaLaunchDecl = Context.getcudaLaunchDeviceDecl();
5905 CudaCallDecl || CudaGetParamDecl || CudaLaunchDecl) {
5906 AddEmittedDeclRefOrZero(CUDASpecialDeclRefs, CudaCallDecl);
5907 AddEmittedDeclRefOrZero(CUDASpecialDeclRefs, CudaGetParamDecl);
5908 AddEmittedDeclRefOrZero(CUDASpecialDeclRefs, CudaLaunchDecl);
5909 Stream.EmitRecord(Code: CUDA_SPECIAL_DECL_REFS, Vals: CUDASpecialDeclRefs);
5910 }
5911
5912 // Write the delegating constructors.
5913 RecordData DelegatingCtorDecls;
5914 if (!isModule)
5915 AddLazyVectorEmiitedDecls(Writer&: *this, Vec&: SemaRef.DelegatingCtorDecls,
5916 Record&: DelegatingCtorDecls);
5917 if (!DelegatingCtorDecls.empty())
5918 Stream.EmitRecord(Code: DELEGATING_CTORS, Vals: DelegatingCtorDecls);
5919
5920 // Write the known namespaces.
5921 RecordData KnownNamespaces;
5922 for (const auto &I : SemaRef.KnownNamespaces) {
5923 if (!I.second && wasDeclEmitted(D: I.first))
5924 AddDeclRef(D: I.first, Record&: KnownNamespaces);
5925 }
5926 if (!KnownNamespaces.empty())
5927 Stream.EmitRecord(Code: KNOWN_NAMESPACES, Vals: KnownNamespaces);
5928
5929 // Write the undefined internal functions and variables, and inline functions.
5930 RecordData UndefinedButUsed;
5931 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
5932 SemaRef.getUndefinedButUsed(Undefined);
5933 for (const auto &I : Undefined) {
5934 if (!wasDeclEmitted(D: I.first))
5935 continue;
5936
5937 AddDeclRef(D: I.first, Record&: UndefinedButUsed);
5938 AddSourceLocation(Loc: I.second, Record&: UndefinedButUsed);
5939 }
5940 if (!UndefinedButUsed.empty())
5941 Stream.EmitRecord(Code: UNDEFINED_BUT_USED, Vals: UndefinedButUsed);
5942
5943 // Write all delete-expressions that we would like to
5944 // analyze later in AST.
5945 RecordData DeleteExprsToAnalyze;
5946 if (!isModule) {
5947 for (const auto &DeleteExprsInfo :
5948 SemaRef.getMismatchingDeleteExpressions()) {
5949 if (!wasDeclEmitted(D: DeleteExprsInfo.first))
5950 continue;
5951
5952 AddDeclRef(D: DeleteExprsInfo.first, Record&: DeleteExprsToAnalyze);
5953 DeleteExprsToAnalyze.push_back(Elt: DeleteExprsInfo.second.size());
5954 for (const auto &DeleteLoc : DeleteExprsInfo.second) {
5955 AddSourceLocation(Loc: DeleteLoc.first, Record&: DeleteExprsToAnalyze);
5956 DeleteExprsToAnalyze.push_back(Elt: DeleteLoc.second);
5957 }
5958 }
5959 }
5960 if (!DeleteExprsToAnalyze.empty())
5961 Stream.EmitRecord(Code: DELETE_EXPRS_TO_ANALYZE, Vals: DeleteExprsToAnalyze);
5962
5963 RecordData VTablesToEmit;
5964 for (CXXRecordDecl *RD : PendingEmittingVTables) {
5965 if (!wasDeclEmitted(D: RD))
5966 continue;
5967
5968 AddDeclRef(D: RD, Record&: VTablesToEmit);
5969 }
5970
5971 if (!VTablesToEmit.empty())
5972 Stream.EmitRecord(Code: VTABLES_TO_EMIT, Vals: VTablesToEmit);
5973}
5974
5975ASTFileSignature ASTWriter::WriteASTCore(Sema *SemaPtr, StringRef isysroot,
5976 Module *WritingModule) {
5977 using namespace llvm;
5978
5979 bool isModule = WritingModule != nullptr;
5980
5981 // Make sure that the AST reader knows to finalize itself.
5982 if (Chain)
5983 Chain->finalizeForWriting();
5984
5985 // This needs to be done very early, since everything that writes
5986 // SourceLocations or FileIDs depends on it.
5987 computeNonAffectingInputFiles();
5988
5989 writeUnhashedControlBlock(PP&: *PP);
5990
5991 // Don't reuse type ID and Identifier ID from readers for C++ standard named
5992 // modules since we want to support no-transitive-change model for named
5993 // modules. The theory for no-transitive-change model is,
5994 // for a user of a named module, the user can only access the indirectly
5995 // imported decls via the directly imported module. So that it is possible to
5996 // control what matters to the users when writing the module. It would be
5997 // problematic if the users can reuse the type IDs and identifier IDs from
5998 // indirectly imported modules arbitrarily. So we choose to clear these ID
5999 // here.
6000 if (isWritingStdCXXNamedModules()) {
6001 TypeIdxs.clear();
6002 IdentifierIDs.clear();
6003 }
6004
6005 // Look for any identifiers that were named while processing the
6006 // headers, but are otherwise not needed. We add these to the hash
6007 // table to enable checking of the predefines buffer in the case
6008 // where the user adds new macro definitions when building the AST
6009 // file.
6010 //
6011 // We do this before emitting any Decl and Types to make sure the
6012 // Identifier ID is stable.
6013 SmallVector<const IdentifierInfo *, 128> IIs;
6014 for (const auto &ID : PP->getIdentifierTable())
6015 if (IsInterestingNonMacroIdentifier(II: ID.second, Writer&: *this))
6016 IIs.push_back(Elt: ID.second);
6017 // Sort the identifiers lexicographically before getting the references so
6018 // that their order is stable.
6019 llvm::sort(C&: IIs, Comp: llvm::deref<std::less<>>());
6020 for (const IdentifierInfo *II : IIs)
6021 getIdentifierRef(II);
6022
6023 // Write the set of weak, undeclared identifiers. We always write the
6024 // entire table, since later PCH files in a PCH chain are only interested in
6025 // the results at the end of the chain.
6026 RecordData WeakUndeclaredIdentifiers;
6027 if (SemaPtr) {
6028 for (const auto &WeakUndeclaredIdentifierList :
6029 SemaPtr->WeakUndeclaredIdentifiers) {
6030 const IdentifierInfo *const II = WeakUndeclaredIdentifierList.first;
6031 for (const auto &WI : WeakUndeclaredIdentifierList.second) {
6032 AddIdentifierRef(II, Record&: WeakUndeclaredIdentifiers);
6033 AddIdentifierRef(II: WI.getAlias(), Record&: WeakUndeclaredIdentifiers);
6034 AddSourceLocation(Loc: WI.getLocation(), Record&: WeakUndeclaredIdentifiers);
6035 }
6036 }
6037 }
6038
6039 // Form the record of special types.
6040 RecordData SpecialTypes;
6041 if (SemaPtr) {
6042 ASTContext &Context = SemaPtr->Context;
6043 AddTypeRef(Context, T: Context.getRawCFConstantStringType(), Record&: SpecialTypes);
6044 AddTypeRef(Context, T: Context.getFILEType(), Record&: SpecialTypes);
6045 AddTypeRef(Context, T: Context.getjmp_bufType(), Record&: SpecialTypes);
6046 AddTypeRef(Context, T: Context.getsigjmp_bufType(), Record&: SpecialTypes);
6047 AddTypeRef(Context, T: Context.ObjCIdRedefinitionType, Record&: SpecialTypes);
6048 AddTypeRef(Context, T: Context.ObjCClassRedefinitionType, Record&: SpecialTypes);
6049 AddTypeRef(Context, T: Context.ObjCSelRedefinitionType, Record&: SpecialTypes);
6050 AddTypeRef(Context, T: Context.getucontext_tType(), Record&: SpecialTypes);
6051 }
6052
6053 if (SemaPtr)
6054 PrepareWritingSpecialDecls(SemaRef&: *SemaPtr);
6055
6056 // Write the control block
6057 WriteControlBlock(PP&: *PP, isysroot);
6058
6059 // Write the remaining AST contents.
6060 Stream.FlushToWord();
6061 ASTBlockRange.first = Stream.GetCurrentBitNo() >> 3;
6062 Stream.EnterSubblock(BlockID: AST_BLOCK_ID, CodeLen: 5);
6063 ASTBlockStartOffset = Stream.GetCurrentBitNo();
6064
6065 // This is so that older clang versions, before the introduction
6066 // of the control block, can read and reject the newer PCH format.
6067 {
6068 RecordData Record = {VERSION_MAJOR};
6069 Stream.EmitRecord(Code: METADATA_OLD_FORMAT, Vals: Record);
6070 }
6071
6072 // For method pool in the module, if it contains an entry for a selector,
6073 // the entry should be complete, containing everything introduced by that
6074 // module and all modules it imports. It's possible that the entry is out of
6075 // date, so we need to pull in the new content here.
6076
6077 // It's possible that updateOutOfDateSelector can update SelectorIDs. To be
6078 // safe, we copy all selectors out.
6079 if (SemaPtr) {
6080 llvm::SmallVector<Selector, 256> AllSelectors;
6081 for (auto &SelectorAndID : SelectorIDs)
6082 AllSelectors.push_back(Elt: SelectorAndID.first);
6083 for (auto &Selector : AllSelectors)
6084 SemaPtr->ObjC().updateOutOfDateSelector(Sel: Selector);
6085 }
6086
6087 if (Chain) {
6088 // Write the mapping information describing our module dependencies and how
6089 // each of those modules were mapped into our own offset/ID space, so that
6090 // the reader can build the appropriate mapping to its own offset/ID space.
6091 // The map consists solely of a blob with the following format:
6092 // *(module-kind:i8
6093 // module-name-len:i16 module-name:len*i8
6094 // source-location-offset:i32
6095 // identifier-id:i32
6096 // preprocessed-entity-id:i32
6097 // macro-definition-id:i32
6098 // submodule-id:i32
6099 // selector-id:i32
6100 // declaration-id:i32
6101 // c++-base-specifiers-id:i32
6102 // type-id:i32)
6103 //
6104 // module-kind is the ModuleKind enum value. If it is MK_PrebuiltModule,
6105 // MK_ExplicitModule or MK_ImplicitModule, then the module-name is the
6106 // module name. Otherwise, it is the module file name.
6107 auto Abbrev = std::make_shared<BitCodeAbbrev>();
6108 Abbrev->Add(OpInfo: BitCodeAbbrevOp(MODULE_OFFSET_MAP));
6109 Abbrev->Add(OpInfo: BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
6110 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abbrev));
6111 SmallString<2048> Buffer;
6112 {
6113 llvm::raw_svector_ostream Out(Buffer);
6114 for (ModuleFile &M : Chain->ModuleMgr) {
6115 using namespace llvm::support;
6116
6117 endian::Writer LE(Out, llvm::endianness::little);
6118 LE.write<uint8_t>(Val: static_cast<uint8_t>(M.Kind));
6119 // FIXME: Storing a PCH's name (M.FileName) as a string does not handle
6120 // relocatable files. We probably should call
6121 // `PreparePathForOutput(M.FileName)` to properly support relocatable
6122 // PCHs.
6123 StringRef Name = M.isModule() ? M.ModuleName : M.FileName;
6124 LE.write<uint16_t>(Val: Name.size());
6125 Out.write(Ptr: Name.data(), Size: Name.size());
6126
6127 // Note: if a base ID was uint max, it would not be possible to load
6128 // another module after it or have more than one entity inside it.
6129 uint32_t None = std::numeric_limits<uint32_t>::max();
6130
6131 auto writeBaseIDOrNone = [&](auto BaseID, bool ShouldWrite) {
6132 assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
6133 if (ShouldWrite)
6134 LE.write<uint32_t>(BaseID);
6135 else
6136 LE.write<uint32_t>(Val: None);
6137 };
6138
6139 // These values should be unique within a chain, since they will be read
6140 // as keys into ContinuousRangeMaps.
6141 writeBaseIDOrNone(M.BaseSubmoduleID, M.LocalNumSubmodules);
6142 writeBaseIDOrNone(M.BaseSelectorID, M.LocalNumSelectors);
6143 }
6144 }
6145 RecordData::value_type Record[] = {MODULE_OFFSET_MAP};
6146 Stream.EmitRecordWithBlob(Abbrev: ModuleOffsetMapAbbrev, Vals: Record,
6147 BlobData: Buffer.data(), BlobLen: Buffer.size());
6148 }
6149
6150 if (SemaPtr)
6151 WriteDeclAndTypes(Context&: SemaPtr->Context);
6152
6153 WriteFileDeclIDsMap();
6154 WriteSourceManagerBlock(SourceMgr&: PP->getSourceManager());
6155 if (SemaPtr)
6156 WriteComments(Context&: SemaPtr->Context);
6157 WritePreprocessor(PP: *PP, IsModule: isModule);
6158 WriteHeaderSearch(HS: PP->getHeaderSearchInfo());
6159 if (SemaPtr) {
6160 WriteSelectors(SemaRef&: *SemaPtr);
6161 WriteReferencedSelectorsPool(SemaRef&: *SemaPtr);
6162 WriteLateParsedTemplates(SemaRef&: *SemaPtr);
6163 }
6164 WriteIdentifierTable(PP&: *PP, IdResolver: SemaPtr ? &SemaPtr->IdResolver : nullptr, IsModule: isModule);
6165 if (SemaPtr) {
6166 WriteFPPragmaOptions(Opts: SemaPtr->CurFPFeatureOverrides());
6167 WriteOpenCLExtensions(SemaRef&: *SemaPtr);
6168 WriteCUDAPragmas(SemaRef&: *SemaPtr);
6169 WriteRISCVIntrinsicPragmas(SemaRef&: *SemaPtr);
6170 }
6171
6172 // If we're emitting a module, write out the submodule information.
6173 if (WritingModule)
6174 WriteSubmodules(WritingModule, Context: SemaPtr ? &SemaPtr->Context : nullptr);
6175
6176 Stream.EmitRecord(Code: SPECIAL_TYPES, Vals: SpecialTypes);
6177
6178 if (SemaPtr)
6179 WriteSpecialDeclRecords(SemaRef&: *SemaPtr);
6180
6181 // Write the record containing weak undeclared identifiers.
6182 if (!WeakUndeclaredIdentifiers.empty())
6183 Stream.EmitRecord(Code: WEAK_UNDECLARED_IDENTIFIERS,
6184 Vals: WeakUndeclaredIdentifiers);
6185
6186 if (!WritingModule) {
6187 // Write the submodules that were imported, if any.
6188 struct ModuleInfo {
6189 uint64_t ID;
6190 Module *M;
6191 ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
6192 };
6193 llvm::SmallVector<ModuleInfo, 64> Imports;
6194 if (SemaPtr) {
6195 for (const auto *I : SemaPtr->Context.local_imports()) {
6196 assert(SubmoduleIDs.contains(I->getImportedModule()));
6197 Imports.push_back(Elt: ModuleInfo(SubmoduleIDs[I->getImportedModule()],
6198 I->getImportedModule()));
6199 }
6200 }
6201
6202 if (!Imports.empty()) {
6203 auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
6204 return A.ID < B.ID;
6205 };
6206 auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
6207 return A.ID == B.ID;
6208 };
6209
6210 // Sort and deduplicate module IDs.
6211 llvm::sort(C&: Imports, Comp: Cmp);
6212 Imports.erase(CS: llvm::unique(R&: Imports, P: Eq), CE: Imports.end());
6213
6214 RecordData ImportedModules;
6215 for (const auto &Import : Imports) {
6216 ImportedModules.push_back(Elt: Import.ID);
6217 // FIXME: If the module has macros imported then later has declarations
6218 // imported, this location won't be the right one as a location for the
6219 // declaration imports.
6220 AddSourceLocation(Loc: PP->getModuleImportLoc(M: Import.M), Record&: ImportedModules);
6221 }
6222
6223 Stream.EmitRecord(Code: IMPORTED_MODULES, Vals: ImportedModules);
6224 }
6225 }
6226
6227 WriteObjCCategories();
6228 if (SemaPtr) {
6229 if (!WritingModule) {
6230 WriteOptimizePragmaOptions(SemaRef&: *SemaPtr);
6231 WriteMSStructPragmaOptions(SemaRef&: *SemaPtr);
6232 WriteMSPointersToMembersPragmaOptions(SemaRef&: *SemaPtr);
6233 }
6234 WritePackPragmaOptions(SemaRef&: *SemaPtr);
6235 WriteFloatControlPragmaOptions(SemaRef&: *SemaPtr);
6236 WriteDeclsWithEffectsToVerify(SemaRef&: *SemaPtr);
6237 }
6238
6239 // Some simple statistics
6240 RecordData::value_type Record[] = {NumStatements,
6241 NumMacros,
6242 NumLexicalDeclContexts,
6243 NumVisibleDeclContexts,
6244 NumModuleLocalDeclContexts,
6245 NumTULocalDeclContexts};
6246 Stream.EmitRecord(Code: STATISTICS, Vals: Record);
6247 Stream.ExitBlock();
6248 Stream.FlushToWord();
6249 ASTBlockRange.second = Stream.GetCurrentBitNo() >> 3;
6250
6251 // Write the module file extension blocks.
6252 if (SemaPtr)
6253 for (const auto &ExtWriter : ModuleFileExtensionWriters)
6254 WriteModuleFileExtension(SemaRef&: *SemaPtr, Writer&: *ExtWriter);
6255
6256 return backpatchSignature();
6257}
6258
6259void ASTWriter::EnteringModulePurview() {
6260 // In C++20 named modules, all entities before entering the module purview
6261 // lives in the GMF.
6262 if (GeneratingReducedBMI)
6263 DeclUpdatesFromGMF.swap(RHS&: DeclUpdates);
6264}
6265
6266// Add update records for all mangling numbers and static local numbers.
6267// These aren't really update records, but this is a convenient way of
6268// tagging this rare extra data onto the declarations.
6269void ASTWriter::AddedManglingNumber(const Decl *D, unsigned Number) {
6270 if (D->isFromASTFile())
6271 return;
6272
6273 DeclUpdates[D].push_back(Elt: DeclUpdate(DeclUpdateKind::ManglingNumber, Number));
6274}
6275void ASTWriter::AddedStaticLocalNumbers(const Decl *D, unsigned Number) {
6276 if (D->isFromASTFile())
6277 return;
6278
6279 DeclUpdates[D].push_back(
6280 Elt: DeclUpdate(DeclUpdateKind::StaticLocalNumber, Number));
6281}
6282
6283void ASTWriter::AddedAnonymousNamespace(const TranslationUnitDecl *TU,
6284 NamespaceDecl *AnonNamespace) {
6285 // If the translation unit has an anonymous namespace, and we don't already
6286 // have an update block for it, write it as an update block.
6287 // FIXME: Why do we not do this if there's already an update block?
6288 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
6289 ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
6290 if (Record.empty())
6291 Record.push_back(
6292 Elt: DeclUpdate(DeclUpdateKind::CXXAddedAnonymousNamespace, NS));
6293 }
6294}
6295
6296void ASTWriter::WriteDeclAndTypes(ASTContext &Context) {
6297 // Keep writing types, declarations, and declaration update records
6298 // until we've emitted all of them.
6299 RecordData DeclUpdatesOffsetsRecord;
6300 Stream.EnterSubblock(BlockID: DECLTYPES_BLOCK_ID, /*bits for abbreviations*/ CodeLen: 6);
6301 DeclTypesBlockStartOffset = Stream.GetCurrentBitNo();
6302 WriteTypeAbbrevs();
6303 WriteDeclAbbrevs();
6304 do {
6305 WriteDeclUpdatesBlocks(Context, OffsetsRecord&: DeclUpdatesOffsetsRecord);
6306 while (!DeclTypesToEmit.empty()) {
6307 DeclOrType DOT = DeclTypesToEmit.front();
6308 DeclTypesToEmit.pop();
6309 if (DOT.isType())
6310 WriteType(Context, T: DOT.getType());
6311 else
6312 WriteDecl(Context, D: DOT.getDecl());
6313 }
6314 } while (!DeclUpdates.empty());
6315
6316 DoneWritingDeclsAndTypes = true;
6317
6318 // DelayedNamespace is only meaningful in reduced BMI.
6319 // See the comments of DelayedNamespace for details.
6320 assert(DelayedNamespace.empty() || GeneratingReducedBMI);
6321 RecordData DelayedNamespaceRecord;
6322 for (NamespaceDecl *NS : DelayedNamespace) {
6323 LookupBlockOffsets Offsets;
6324
6325 Offsets.LexicalOffset = WriteDeclContextLexicalBlock(Context, DC: NS);
6326 WriteDeclContextVisibleBlock(Context, DC: NS, Offsets);
6327
6328 if (Offsets.LexicalOffset)
6329 Offsets.LexicalOffset -= DeclTypesBlockStartOffset;
6330
6331 // Write the offset relative to current block.
6332 if (Offsets.VisibleOffset)
6333 Offsets.VisibleOffset -= DeclTypesBlockStartOffset;
6334
6335 if (Offsets.ModuleLocalOffset)
6336 Offsets.ModuleLocalOffset -= DeclTypesBlockStartOffset;
6337
6338 if (Offsets.TULocalOffset)
6339 Offsets.TULocalOffset -= DeclTypesBlockStartOffset;
6340
6341 AddDeclRef(D: NS, Record&: DelayedNamespaceRecord);
6342 AddLookupOffsets(Offsets, Record&: DelayedNamespaceRecord);
6343 }
6344
6345 // The process of writing lexical and visible block for delayed namespace
6346 // shouldn't introduce any new decls, types or update to emit.
6347 assert(DeclTypesToEmit.empty());
6348 assert(DeclUpdates.empty());
6349
6350 Stream.ExitBlock();
6351
6352 // These things can only be done once we've written out decls and types.
6353 WriteTypeDeclOffsets();
6354 if (!DeclUpdatesOffsetsRecord.empty())
6355 Stream.EmitRecord(Code: DECL_UPDATE_OFFSETS, Vals: DeclUpdatesOffsetsRecord);
6356
6357 if (!DelayedNamespaceRecord.empty())
6358 Stream.EmitRecord(Code: DELAYED_NAMESPACE_LEXICAL_VISIBLE_RECORD,
6359 Vals: DelayedNamespaceRecord);
6360
6361 if (!RelatedDeclsMap.empty()) {
6362 // TODO: on disk hash table for related decls mapping might be more
6363 // efficent becuase it allows lazy deserialization.
6364 RecordData RelatedDeclsMapRecord;
6365 for (const auto &Pair : RelatedDeclsMap) {
6366 RelatedDeclsMapRecord.push_back(Elt: Pair.first.getRawValue());
6367 RelatedDeclsMapRecord.push_back(Elt: Pair.second.size());
6368 for (const auto &Lambda : Pair.second)
6369 RelatedDeclsMapRecord.push_back(Elt: Lambda.getRawValue());
6370 }
6371
6372 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
6373 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(RELATED_DECLS_MAP));
6374 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Array));
6375 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
6376 unsigned FunctionToLambdaMapAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abv));
6377 Stream.EmitRecord(Code: RELATED_DECLS_MAP, Vals: RelatedDeclsMapRecord,
6378 Abbrev: FunctionToLambdaMapAbbrev);
6379 }
6380
6381 if (!SpecializationsUpdates.empty()) {
6382 WriteSpecializationsUpdates(/*IsPartial=*/false);
6383 SpecializationsUpdates.clear();
6384 }
6385
6386 if (!PartialSpecializationsUpdates.empty()) {
6387 WriteSpecializationsUpdates(/*IsPartial=*/true);
6388 PartialSpecializationsUpdates.clear();
6389 }
6390
6391 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
6392 // Create a lexical update block containing all of the declarations in the
6393 // translation unit that do not come from other AST files.
6394 SmallVector<DeclID, 128> NewGlobalKindDeclPairs;
6395 for (const auto *D : TU->noload_decls()) {
6396 if (D->isFromASTFile())
6397 continue;
6398
6399 // In reduced BMI, skip unreached declarations.
6400 if (!wasDeclEmitted(D))
6401 continue;
6402
6403 NewGlobalKindDeclPairs.push_back(Elt: D->getKind());
6404 NewGlobalKindDeclPairs.push_back(Elt: GetDeclRef(D).getRawValue());
6405 }
6406
6407 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
6408 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
6409 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
6410 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abv));
6411
6412 RecordData::value_type Record[] = {TU_UPDATE_LEXICAL};
6413 Stream.EmitRecordWithBlob(Abbrev: TuUpdateLexicalAbbrev, Vals: Record,
6414 Blob: bytes(v: NewGlobalKindDeclPairs));
6415
6416 Abv = std::make_shared<llvm::BitCodeAbbrev>();
6417 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
6418 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
6419 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
6420 UpdateVisibleAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abv));
6421
6422 Abv = std::make_shared<llvm::BitCodeAbbrev>();
6423 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(UPDATE_MODULE_LOCAL_VISIBLE));
6424 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
6425 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
6426 ModuleLocalUpdateVisibleAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abv));
6427
6428 Abv = std::make_shared<llvm::BitCodeAbbrev>();
6429 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(UPDATE_TU_LOCAL_VISIBLE));
6430 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
6431 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
6432 TULocalUpdateVisibleAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abv));
6433
6434 // And a visible updates block for the translation unit.
6435 WriteDeclContextVisibleUpdate(Context, DC: TU);
6436
6437 // If we have any extern "C" names, write out a visible update for them.
6438 if (Context.ExternCContext)
6439 WriteDeclContextVisibleUpdate(Context, DC: Context.ExternCContext);
6440
6441 // Write the visible updates to DeclContexts.
6442 for (auto *DC : UpdatedDeclContexts)
6443 WriteDeclContextVisibleUpdate(Context, DC);
6444}
6445
6446void ASTWriter::WriteSpecializationsUpdates(bool IsPartial) {
6447 auto RecordType = IsPartial ? CXX_ADDED_TEMPLATE_PARTIAL_SPECIALIZATION
6448 : CXX_ADDED_TEMPLATE_SPECIALIZATION;
6449
6450 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
6451 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(RecordType));
6452 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
6453 Abv->Add(OpInfo: llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
6454 auto UpdateSpecializationAbbrev = Stream.EmitAbbrev(Abbv: std::move(Abv));
6455
6456 auto &SpecUpdates =
6457 IsPartial ? PartialSpecializationsUpdates : SpecializationsUpdates;
6458 for (auto &SpecializationUpdate : SpecUpdates) {
6459 const NamedDecl *D = SpecializationUpdate.first;
6460
6461 llvm::SmallString<4096> LookupTable;
6462 GenerateSpecializationInfoLookupTable(D, Specializations&: SpecializationUpdate.second,
6463 LookupTable, IsPartial);
6464
6465 // Write the lookup table
6466 RecordData::value_type Record[] = {
6467 static_cast<RecordData::value_type>(RecordType),
6468 getDeclID(D).getRawValue()};
6469 Stream.EmitRecordWithBlob(Abbrev: UpdateSpecializationAbbrev, Vals: Record, Blob: LookupTable);
6470 }
6471}
6472
6473void ASTWriter::WriteDeclUpdatesBlocks(ASTContext &Context,
6474 RecordDataImpl &OffsetsRecord) {
6475 if (DeclUpdates.empty())
6476 return;
6477
6478 DeclUpdateMap LocalUpdates;
6479 LocalUpdates.swap(RHS&: DeclUpdates);
6480
6481 for (auto &DeclUpdate : LocalUpdates) {
6482 const Decl *D = DeclUpdate.first;
6483
6484 bool HasUpdatedBody = false;
6485 bool HasAddedVarDefinition = false;
6486 RecordData RecordData;
6487 ASTRecordWriter Record(Context, *this, RecordData);
6488 for (auto &Update : DeclUpdate.second) {
6489 DeclUpdateKind Kind = Update.getKind();
6490
6491 // An updated body is emitted last, so that the reader doesn't need
6492 // to skip over the lazy body to reach statements for other records.
6493 if (Kind == DeclUpdateKind::CXXAddedFunctionDefinition)
6494 HasUpdatedBody = true;
6495 else if (Kind == DeclUpdateKind::CXXAddedVarDefinition)
6496 HasAddedVarDefinition = true;
6497 else
6498 Record.push_back(N: llvm::to_underlying(E: Kind));
6499
6500 switch (Kind) {
6501 case DeclUpdateKind::CXXAddedImplicitMember:
6502 case DeclUpdateKind::CXXAddedAnonymousNamespace:
6503 assert(Update.getDecl() && "no decl to add?");
6504 Record.AddDeclRef(D: Update.getDecl());
6505 break;
6506 case DeclUpdateKind::CXXAddedFunctionDefinition:
6507 case DeclUpdateKind::CXXAddedVarDefinition:
6508 break;
6509
6510 case DeclUpdateKind::CXXPointOfInstantiation:
6511 // FIXME: Do we need to also save the template specialization kind here?
6512 Record.AddSourceLocation(Loc: Update.getLoc());
6513 break;
6514
6515 case DeclUpdateKind::CXXInstantiatedDefaultArgument:
6516 Record.writeStmtRef(
6517 S: cast<ParmVarDecl>(Val: Update.getDecl())->getDefaultArg());
6518 break;
6519
6520 case DeclUpdateKind::CXXInstantiatedDefaultMemberInitializer:
6521 Record.AddStmt(
6522 S: cast<FieldDecl>(Val: Update.getDecl())->getInClassInitializer());
6523 break;
6524
6525 case DeclUpdateKind::CXXInstantiatedClassDefinition: {
6526 auto *RD = cast<CXXRecordDecl>(Val: D);
6527 UpdatedDeclContexts.insert(X: RD->getPrimaryContext());
6528 Record.push_back(N: RD->isParamDestroyedInCallee());
6529 Record.push_back(N: llvm::to_underlying(E: RD->getArgPassingRestrictions()));
6530 Record.AddCXXDefinitionData(D: RD);
6531 Record.AddOffset(BitOffset: WriteDeclContextLexicalBlock(Context, DC: RD));
6532
6533 // This state is sometimes updated by template instantiation, when we
6534 // switch from the specialization referring to the template declaration
6535 // to it referring to the template definition.
6536 if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
6537 Record.push_back(N: MSInfo->getTemplateSpecializationKind());
6538 Record.AddSourceLocation(Loc: MSInfo->getPointOfInstantiation());
6539 } else {
6540 auto *Spec = cast<ClassTemplateSpecializationDecl>(Val: RD);
6541 Record.push_back(N: Spec->getTemplateSpecializationKind());
6542 Record.AddSourceLocation(Loc: Spec->getPointOfInstantiation());
6543
6544 // The instantiation might have been resolved to a partial
6545 // specialization. If so, record which one.
6546 auto From = Spec->getInstantiatedFrom();
6547 if (auto PartialSpec =
6548 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
6549 Record.push_back(N: true);
6550 Record.AddDeclRef(D: PartialSpec);
6551 Record.AddTemplateArgumentList(
6552 TemplateArgs: &Spec->getTemplateInstantiationArgs());
6553 } else {
6554 Record.push_back(N: false);
6555 }
6556 }
6557 Record.push_back(N: llvm::to_underlying(E: RD->getTagKind()));
6558 Record.AddSourceLocation(Loc: RD->getLocation());
6559 Record.AddSourceLocation(Loc: RD->getBeginLoc());
6560 Record.AddSourceRange(Range: RD->getBraceRange());
6561
6562 // Instantiation may change attributes; write them all out afresh.
6563 Record.push_back(N: D->hasAttrs());
6564 if (D->hasAttrs())
6565 Record.AddAttributes(Attrs: D->getAttrs());
6566
6567 // FIXME: Ensure we don't get here for explicit instantiations.
6568 break;
6569 }
6570
6571 case DeclUpdateKind::CXXResolvedDtorDelete:
6572 Record.AddDeclRef(D: Update.getDecl());
6573 Record.AddStmt(S: cast<CXXDestructorDecl>(Val: D)->getOperatorDeleteThisArg());
6574 break;
6575
6576 case DeclUpdateKind::CXXResolvedDtorGlobDelete:
6577 Record.AddDeclRef(D: Update.getDecl());
6578 break;
6579
6580 case DeclUpdateKind::CXXResolvedDtorArrayDelete:
6581 Record.AddDeclRef(D: Update.getDecl());
6582 break;
6583
6584 case DeclUpdateKind::CXXResolvedDtorGlobArrayDelete:
6585 Record.AddDeclRef(D: Update.getDecl());
6586 break;
6587
6588 case DeclUpdateKind::CXXResolvedExceptionSpec: {
6589 auto prototype =
6590 cast<FunctionDecl>(Val: D)->getType()->castAs<FunctionProtoType>();
6591 Record.writeExceptionSpecInfo(esi: prototype->getExceptionSpecInfo());
6592 break;
6593 }
6594
6595 case DeclUpdateKind::CXXDeducedReturnType:
6596 Record.push_back(N: GetOrCreateTypeID(Context, T: Update.getType()));
6597 break;
6598
6599 case DeclUpdateKind::DeclMarkedUsed:
6600 break;
6601
6602 case DeclUpdateKind::ManglingNumber:
6603 case DeclUpdateKind::StaticLocalNumber:
6604 Record.push_back(N: Update.getNumber());
6605 break;
6606
6607 case DeclUpdateKind::DeclMarkedOpenMPThreadPrivate:
6608 Record.AddSourceRange(
6609 Range: D->getAttr<OMPThreadPrivateDeclAttr>()->getRange());
6610 break;
6611
6612 case DeclUpdateKind::DeclMarkedOpenMPAllocate: {
6613 auto *A = D->getAttr<OMPAllocateDeclAttr>();
6614 Record.push_back(N: A->getAllocatorType());
6615 Record.AddStmt(S: A->getAllocator());
6616 Record.AddStmt(S: A->getAlignment());
6617 Record.AddSourceRange(Range: A->getRange());
6618 break;
6619 }
6620
6621 case DeclUpdateKind::DeclMarkedOpenMPDeclareTarget:
6622 Record.push_back(N: D->getAttr<OMPDeclareTargetDeclAttr>()->getMapType());
6623 Record.AddSourceRange(
6624 Range: D->getAttr<OMPDeclareTargetDeclAttr>()->getRange());
6625 break;
6626
6627 case DeclUpdateKind::DeclExported:
6628 Record.push_back(N: getSubmoduleID(Mod: Update.getModule()));
6629 break;
6630
6631 case DeclUpdateKind::AddedAttrToRecord:
6632 Record.AddAttributes(Attrs: llvm::ArrayRef(Update.getAttr()));
6633 break;
6634 }
6635 }
6636
6637 // Add a trailing update record, if any. These must go last because we
6638 // lazily load their attached statement.
6639 if (!GeneratingReducedBMI || !CanElideDeclDef(D)) {
6640 if (HasUpdatedBody) {
6641 const auto *Def = cast<FunctionDecl>(Val: D);
6642 Record.push_back(
6643 N: llvm::to_underlying(E: DeclUpdateKind::CXXAddedFunctionDefinition));
6644 Record.push_back(N: Def->isInlined());
6645 Record.AddSourceLocation(Loc: Def->getInnerLocStart());
6646 Record.AddFunctionDefinition(FD: Def);
6647 } else if (HasAddedVarDefinition) {
6648 const auto *VD = cast<VarDecl>(Val: D);
6649 Record.push_back(
6650 N: llvm::to_underlying(E: DeclUpdateKind::CXXAddedVarDefinition));
6651 Record.push_back(N: VD->isInline());
6652 Record.push_back(N: VD->isInlineSpecified());
6653 Record.AddVarDeclInit(VD);
6654 }
6655 }
6656
6657 AddDeclRef(D, Record&: OffsetsRecord);
6658 OffsetsRecord.push_back(Elt: Record.Emit(Code: DECL_UPDATES));
6659 }
6660}
6661
6662void ASTWriter::AddAlignPackInfo(const Sema::AlignPackInfo &Info,
6663 RecordDataImpl &Record) {
6664 uint32_t Raw = Sema::AlignPackInfo::getRawEncoding(Info);
6665 Record.push_back(Elt: Raw);
6666}
6667
6668FileID ASTWriter::getAdjustedFileID(FileID FID) const {
6669 if (FID.isInvalid() || PP->getSourceManager().isLoadedFileID(FID) ||
6670 NonAffectingFileIDs.empty())
6671 return FID;
6672 auto It = llvm::lower_bound(Range: NonAffectingFileIDs, Value&: FID);
6673 unsigned Idx = std::distance(first: NonAffectingFileIDs.begin(), last: It);
6674 unsigned Offset = NonAffectingFileIDAdjustments[Idx];
6675 return FileID::get(V: FID.getOpaqueValue() - Offset);
6676}
6677
6678unsigned ASTWriter::getAdjustedNumCreatedFIDs(FileID FID) const {
6679 unsigned NumCreatedFIDs = PP->getSourceManager()
6680 .getLocalSLocEntry(Index: FID.ID)
6681 .getFile()
6682 .NumCreatedFIDs;
6683
6684 unsigned AdjustedNumCreatedFIDs = 0;
6685 for (unsigned I = FID.ID, N = I + NumCreatedFIDs; I != N; ++I)
6686 if (IsSLocAffecting[I])
6687 ++AdjustedNumCreatedFIDs;
6688 return AdjustedNumCreatedFIDs;
6689}
6690
6691SourceLocation ASTWriter::getAdjustedLocation(SourceLocation Loc) const {
6692 if (Loc.isInvalid())
6693 return Loc;
6694 return Loc.getLocWithOffset(Offset: -getAdjustment(Offset: Loc.getOffset()));
6695}
6696
6697SourceRange ASTWriter::getAdjustedRange(SourceRange Range) const {
6698 return SourceRange(getAdjustedLocation(Loc: Range.getBegin()),
6699 getAdjustedLocation(Loc: Range.getEnd()));
6700}
6701
6702SourceLocation::UIntTy
6703ASTWriter::getAdjustedOffset(SourceLocation::UIntTy Offset) const {
6704 return Offset - getAdjustment(Offset);
6705}
6706
6707SourceLocation::UIntTy
6708ASTWriter::getAdjustment(SourceLocation::UIntTy Offset) const {
6709 if (NonAffectingRanges.empty())
6710 return 0;
6711
6712 if (PP->getSourceManager().isLoadedOffset(SLocOffset: Offset))
6713 return 0;
6714
6715 if (Offset > NonAffectingRanges.back().getEnd().getOffset())
6716 return NonAffectingOffsetAdjustments.back();
6717
6718 if (Offset < NonAffectingRanges.front().getBegin().getOffset())
6719 return 0;
6720
6721 auto Contains = [](const SourceRange &Range, SourceLocation::UIntTy Offset) {
6722 return Range.getEnd().getOffset() < Offset;
6723 };
6724
6725 auto It = llvm::lower_bound(Range: NonAffectingRanges, Value&: Offset, C: Contains);
6726 unsigned Idx = std::distance(first: NonAffectingRanges.begin(), last: It);
6727 return NonAffectingOffsetAdjustments[Idx];
6728}
6729
6730void ASTWriter::AddFileID(FileID FID, RecordDataImpl &Record) {
6731 Record.push_back(Elt: getAdjustedFileID(FID).getOpaqueValue());
6732}
6733
6734SourceLocationEncoding::RawLocEncoding
6735ASTWriter::getRawSourceLocationEncoding(SourceLocation Loc) {
6736 SourceLocation::UIntTy BaseOffset = 0;
6737 unsigned ModuleFileIndex = 0;
6738
6739 // See SourceLocationEncoding.h for the encoding details.
6740 if (PP->getSourceManager().isLoadedSourceLocation(Loc) && Loc.isValid()) {
6741 assert(getChain());
6742 auto SLocMapI = getChain()->GlobalSLocOffsetMap.find(
6743 K: SourceManager::MaxLoadedOffset - Loc.getOffset() - 1);
6744 assert(SLocMapI != getChain()->GlobalSLocOffsetMap.end() &&
6745 "Corrupted global sloc offset map");
6746 ModuleFile *F = SLocMapI->second;
6747 BaseOffset = F->SLocEntryBaseOffset - 2;
6748 // 0 means the location is not loaded. So we need to add 1 to the index to
6749 // make it clear.
6750 ModuleFileIndex = F->Index + 1;
6751 assert(&getChain()->getModuleManager()[F->Index] == F);
6752 }
6753
6754 return SourceLocationEncoding::encode(Loc, BaseOffset, BaseModuleFileIndex: ModuleFileIndex);
6755}
6756
6757void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
6758 Loc = getAdjustedLocation(Loc);
6759 Record.push_back(Elt: getRawSourceLocationEncoding(Loc));
6760}
6761
6762void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
6763 AddSourceLocation(Loc: Range.getBegin(), Record);
6764 AddSourceLocation(Loc: Range.getEnd(), Record);
6765}
6766
6767void ASTRecordWriter::AddAPFloat(const llvm::APFloat &Value) {
6768 AddAPInt(Value: Value.bitcastToAPInt());
6769}
6770
6771void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
6772 Record.push_back(Elt: getIdentifierRef(II));
6773}
6774
6775IdentifierID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
6776 if (!II)
6777 return 0;
6778
6779 IdentifierID &ID = IdentifierIDs[II];
6780 if (ID == 0)
6781 ID = NextIdentID++;
6782 return ID;
6783}
6784
6785MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) {
6786 // Don't emit builtin macros like __LINE__ to the AST file unless they
6787 // have been redefined by the header (in which case they are not
6788 // isBuiltinMacro).
6789 if (!MI || MI->isBuiltinMacro())
6790 return 0;
6791
6792 MacroID &ID = MacroIDs[MI];
6793 if (ID == 0) {
6794 ID = NextMacroID++;
6795 MacroInfoToEmitData Info = { .Name: Name, .MI: MI, .ID: ID };
6796 MacroInfosToEmit.push_back(x: Info);
6797 }
6798 return ID;
6799}
6800
6801uint32_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) {
6802 return IdentMacroDirectivesOffsetMap.lookup(Val: Name);
6803}
6804
6805void ASTRecordWriter::AddSelectorRef(const Selector SelRef) {
6806 Record->push_back(Elt: Writer->getSelectorRef(Sel: SelRef));
6807}
6808
6809SelectorID ASTWriter::getSelectorRef(Selector Sel) {
6810 if (Sel.getAsOpaquePtr() == nullptr) {
6811 return 0;
6812 }
6813
6814 SelectorID SID = SelectorIDs[Sel];
6815 if (SID == 0 && Chain) {
6816 // This might trigger a ReadSelector callback, which will set the ID for
6817 // this selector.
6818 Chain->LoadSelector(Sel);
6819 SID = SelectorIDs[Sel];
6820 }
6821 if (SID == 0) {
6822 SID = NextSelectorID++;
6823 SelectorIDs[Sel] = SID;
6824 }
6825 return SID;
6826}
6827
6828void ASTRecordWriter::AddCXXTemporary(const CXXTemporary *Temp) {
6829 AddDeclRef(D: Temp->getDestructor());
6830}
6831
6832void ASTRecordWriter::AddTemplateArgumentLocInfo(
6833 const TemplateArgumentLoc &Arg) {
6834 const TemplateArgumentLocInfo &Info = Arg.getLocInfo();
6835 switch (auto K = Arg.getArgument().getKind()) {
6836 case TemplateArgument::Expression:
6837 AddStmt(S: Info.getAsExpr());
6838 break;
6839 case TemplateArgument::Type:
6840 AddTypeSourceInfo(TInfo: Info.getAsTypeSourceInfo());
6841 break;
6842 case TemplateArgument::Template:
6843 case TemplateArgument::TemplateExpansion:
6844 AddSourceLocation(Loc: Arg.getTemplateKWLoc());
6845 AddNestedNameSpecifierLoc(NNS: Arg.getTemplateQualifierLoc());
6846 AddSourceLocation(Loc: Arg.getTemplateNameLoc());
6847 if (K == TemplateArgument::TemplateExpansion)
6848 AddSourceLocation(Loc: Arg.getTemplateEllipsisLoc());
6849 break;
6850 case TemplateArgument::Null:
6851 case TemplateArgument::Integral:
6852 case TemplateArgument::Declaration:
6853 case TemplateArgument::NullPtr:
6854 case TemplateArgument::StructuralValue:
6855 case TemplateArgument::Pack:
6856 // FIXME: Is this right?
6857 break;
6858 }
6859}
6860
6861void ASTRecordWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg) {
6862 AddTemplateArgument(Arg: Arg.getArgument());
6863
6864 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
6865 bool InfoHasSameExpr
6866 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
6867 Record->push_back(Elt: InfoHasSameExpr);
6868 if (InfoHasSameExpr)
6869 return; // Avoid storing the same expr twice.
6870 }
6871 AddTemplateArgumentLocInfo(Arg);
6872}
6873
6874void ASTRecordWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo) {
6875 if (!TInfo) {
6876 AddTypeRef(T: QualType());
6877 return;
6878 }
6879
6880 AddTypeRef(T: TInfo->getType());
6881 AddTypeLoc(TL: TInfo->getTypeLoc());
6882}
6883
6884void ASTRecordWriter::AddTypeLoc(TypeLoc TL) {
6885 TypeLocWriter TLW(*this);
6886 for (; !TL.isNull(); TL = TL.getNextTypeLoc())
6887 TLW.Visit(TyLoc: TL);
6888}
6889
6890void ASTWriter::AddTypeRef(ASTContext &Context, QualType T,
6891 RecordDataImpl &Record) {
6892 Record.push_back(Elt: GetOrCreateTypeID(Context, T));
6893}
6894
6895template <typename IdxForTypeTy>
6896static TypeID MakeTypeID(ASTContext &Context, QualType T,
6897 IdxForTypeTy IdxForType) {
6898 if (T.isNull())
6899 return PREDEF_TYPE_NULL_ID;
6900
6901 unsigned FastQuals = T.getLocalFastQualifiers();
6902 T.removeLocalFastQualifiers();
6903
6904 if (T.hasLocalNonFastQualifiers())
6905 return IdxForType(T).asTypeID(FastQuals);
6906
6907 assert(!T.hasLocalQualifiers());
6908
6909 if (const BuiltinType *BT = dyn_cast<BuiltinType>(Val: T.getTypePtr()))
6910 return TypeIdxFromBuiltin(BT).asTypeID(FastQuals);
6911
6912 if (T == Context.AutoDeductTy)
6913 return TypeIdx(0, PREDEF_TYPE_AUTO_DEDUCT).asTypeID(FastQuals);
6914 if (T == Context.AutoRRefDeductTy)
6915 return TypeIdx(0, PREDEF_TYPE_AUTO_RREF_DEDUCT).asTypeID(FastQuals);
6916
6917 return IdxForType(T).asTypeID(FastQuals);
6918}
6919
6920TypeID ASTWriter::GetOrCreateTypeID(ASTContext &Context, QualType T) {
6921 return MakeTypeID(Context, T, IdxForType: [&](QualType T) -> TypeIdx {
6922 if (T.isNull())
6923 return TypeIdx();
6924 assert(!T.getLocalFastQualifiers());
6925
6926 TypeIdx &Idx = TypeIdxs[T];
6927 if (Idx.getValue() == 0) {
6928 if (DoneWritingDeclsAndTypes) {
6929 assert(0 && "New type seen after serializing all the types to emit!");
6930 return TypeIdx();
6931 }
6932
6933 // We haven't seen this type before. Assign it a new ID and put it
6934 // into the queue of types to emit.
6935 Idx = TypeIdx(0, NextTypeID++);
6936 DeclTypesToEmit.push(x: T);
6937 }
6938 return Idx;
6939 });
6940}
6941
6942llvm::MapVector<ModuleFile *, const Decl *>
6943ASTWriter::CollectFirstDeclFromEachModule(const Decl *D, bool IncludeLocal) {
6944 llvm::MapVector<ModuleFile *, const Decl *> Firsts;
6945 // FIXME: We can skip entries that we know are implied by others.
6946 for (const Decl *R = D->getMostRecentDecl(); R; R = R->getPreviousDecl()) {
6947 if (R->isFromASTFile())
6948 Firsts[Chain->getOwningModuleFile(D: R)] = R;
6949 else if (IncludeLocal)
6950 Firsts[nullptr] = R;
6951 }
6952 return Firsts;
6953}
6954
6955void ASTWriter::AddLookupOffsets(const LookupBlockOffsets &Offsets,
6956 RecordDataImpl &Record) {
6957 Record.push_back(Elt: Offsets.LexicalOffset);
6958 Record.push_back(Elt: Offsets.VisibleOffset);
6959 Record.push_back(Elt: Offsets.ModuleLocalOffset);
6960 Record.push_back(Elt: Offsets.TULocalOffset);
6961}
6962
6963void ASTWriter::AddMacroRef(MacroInfo *MI, const IdentifierInfo *Name,
6964 RecordDataImpl &Record) {
6965 MacroID MacroRef = getMacroRef(MI, Name);
6966 Record.push_back(Elt: MacroRef >> 32);
6967 Record.push_back(Elt: MacroRef & llvm::maskTrailingOnes<MacroID>(N: 32));
6968}
6969
6970void ASTWriter::AddEmittedDeclRef(const Decl *D, RecordDataImpl &Record) {
6971 if (!wasDeclEmitted(D))
6972 return;
6973
6974 AddDeclRef(D, Record);
6975}
6976
6977void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
6978 Record.push_back(Elt: GetDeclRef(D).getRawValue());
6979}
6980
6981LocalDeclID ASTWriter::GetDeclRef(const Decl *D) {
6982 assert(WritingAST && "Cannot request a declaration ID before AST writing");
6983
6984 if (!D) {
6985 return LocalDeclID();
6986 }
6987
6988 // If the DeclUpdate from the GMF gets touched, emit it.
6989 if (auto *Iter = DeclUpdatesFromGMF.find(Key: D);
6990 Iter != DeclUpdatesFromGMF.end()) {
6991 for (DeclUpdate &Update : Iter->second)
6992 DeclUpdates[D].push_back(Elt: Update);
6993 DeclUpdatesFromGMF.erase(Iterator: Iter);
6994 }
6995
6996 // If D comes from an AST file, its declaration ID is already known and
6997 // fixed.
6998 if (D->isFromASTFile()) {
6999 if (isWritingStdCXXNamedModules() && D->getOwningModule())
7000 TouchedTopLevelModules.insert(X: D->getOwningModule()->getTopLevelModule());
7001
7002 return LocalDeclID(D->getGlobalID());
7003 }
7004
7005 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
7006 LocalDeclID &ID = DeclIDs[D];
7007 if (ID.isInvalid()) {
7008 if (DoneWritingDeclsAndTypes) {
7009 assert(0 && "New decl seen after serializing all the decls to emit!");
7010 return LocalDeclID();
7011 }
7012
7013 // We haven't seen this declaration before. Give it a new ID and
7014 // enqueue it in the list of declarations to emit.
7015 ID = NextDeclID++;
7016 DeclTypesToEmit.push(x: const_cast<Decl *>(D));
7017 }
7018
7019 return ID;
7020}
7021
7022LocalDeclID ASTWriter::getDeclID(const Decl *D) {
7023 if (!D)
7024 return LocalDeclID();
7025
7026 // If D comes from an AST file, its declaration ID is already known and
7027 // fixed.
7028 if (D->isFromASTFile())
7029 return LocalDeclID(D->getGlobalID());
7030
7031 assert(DeclIDs.contains(D) && "Declaration not emitted!");
7032 return DeclIDs[D];
7033}
7034
7035bool ASTWriter::wasDeclEmitted(const Decl *D) const {
7036 assert(D);
7037
7038 assert(DoneWritingDeclsAndTypes &&
7039 "wasDeclEmitted should only be called after writing declarations");
7040
7041 if (D->isFromASTFile())
7042 return true;
7043
7044 bool Emitted = DeclIDs.contains(Val: D);
7045 assert((Emitted || (!D->getOwningModule() && isWritingStdCXXNamedModules()) ||
7046 GeneratingReducedBMI) &&
7047 "The declaration within modules can only be omitted in reduced BMI.");
7048 return Emitted;
7049}
7050
7051void ASTWriter::associateDeclWithFile(const Decl *D, LocalDeclID ID) {
7052 assert(ID.isValid());
7053 assert(D);
7054
7055 SourceLocation Loc = D->getLocation();
7056 if (Loc.isInvalid())
7057 return;
7058
7059 // We only keep track of the file-level declarations of each file.
7060 if (!D->getLexicalDeclContext()->isFileContext())
7061 return;
7062 // FIXME: ParmVarDecls that are part of a function type of a parameter of
7063 // a function/objc method, should not have TU as lexical context.
7064 // TemplateTemplateParmDecls that are part of an alias template, should not
7065 // have TU as lexical context.
7066 if (isa<ParmVarDecl, TemplateTemplateParmDecl>(Val: D))
7067 return;
7068
7069 SourceManager &SM = PP->getSourceManager();
7070 SourceLocation FileLoc = SM.getFileLoc(Loc);
7071 assert(SM.isLocalSourceLocation(FileLoc));
7072 auto [FID, Offset] = SM.getDecomposedLoc(Loc: FileLoc);
7073 if (FID.isInvalid())
7074 return;
7075 assert(SM.getSLocEntry(FID).isFile());
7076 assert(IsSLocAffecting[FID.ID]);
7077
7078 std::unique_ptr<DeclIDInFileInfo> &Info = FileDeclIDs[FID];
7079 if (!Info)
7080 Info = std::make_unique<DeclIDInFileInfo>();
7081
7082 std::pair<unsigned, LocalDeclID> LocDecl(Offset, ID);
7083 LocDeclIDsTy &Decls = Info->DeclIDs;
7084 Decls.push_back(Elt: LocDecl);
7085}
7086
7087unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) {
7088 assert(needsAnonymousDeclarationNumber(D) &&
7089 "expected an anonymous declaration");
7090
7091 // Number the anonymous declarations within this context, if we've not
7092 // already done so.
7093 auto It = AnonymousDeclarationNumbers.find(Val: D);
7094 if (It == AnonymousDeclarationNumbers.end()) {
7095 auto *DC = D->getLexicalDeclContext();
7096 numberAnonymousDeclsWithin(DC, Visit: [&](const NamedDecl *ND, unsigned Number) {
7097 AnonymousDeclarationNumbers[ND] = Number;
7098 });
7099
7100 It = AnonymousDeclarationNumbers.find(Val: D);
7101 assert(It != AnonymousDeclarationNumbers.end() &&
7102 "declaration not found within its lexical context");
7103 }
7104
7105 return It->second;
7106}
7107
7108void ASTRecordWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
7109 DeclarationName Name) {
7110 switch (Name.getNameKind()) {
7111 case DeclarationName::CXXConstructorName:
7112 case DeclarationName::CXXDestructorName:
7113 case DeclarationName::CXXConversionFunctionName:
7114 AddTypeSourceInfo(TInfo: DNLoc.getNamedTypeInfo());
7115 break;
7116
7117 case DeclarationName::CXXOperatorName:
7118 AddSourceRange(Range: DNLoc.getCXXOperatorNameRange());
7119 break;
7120
7121 case DeclarationName::CXXLiteralOperatorName:
7122 AddSourceLocation(Loc: DNLoc.getCXXLiteralOperatorNameLoc());
7123 break;
7124
7125 case DeclarationName::Identifier:
7126 case DeclarationName::ObjCZeroArgSelector:
7127 case DeclarationName::ObjCOneArgSelector:
7128 case DeclarationName::ObjCMultiArgSelector:
7129 case DeclarationName::CXXUsingDirective:
7130 case DeclarationName::CXXDeductionGuideName:
7131 break;
7132 }
7133}
7134
7135void ASTRecordWriter::AddDeclarationNameInfo(
7136 const DeclarationNameInfo &NameInfo) {
7137 AddDeclarationName(Name: NameInfo.getName());
7138 AddSourceLocation(Loc: NameInfo.getLoc());
7139 AddDeclarationNameLoc(DNLoc: NameInfo.getInfo(), Name: NameInfo.getName());
7140}
7141
7142void ASTRecordWriter::AddQualifierInfo(const QualifierInfo &Info) {
7143 AddNestedNameSpecifierLoc(NNS: Info.QualifierLoc);
7144 Record->push_back(Elt: Info.NumTemplParamLists);
7145 for (unsigned i = 0, e = Info.NumTemplParamLists; i != e; ++i)
7146 AddTemplateParameterList(TemplateParams: Info.TemplParamLists[i]);
7147}
7148
7149void ASTRecordWriter::AddNestedNameSpecifierLoc(
7150 NestedNameSpecifierLoc QualifierLoc) {
7151 // Nested name specifiers usually aren't too long. I think that 8 would
7152 // typically accommodate the vast majority.
7153 SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
7154
7155 // Push each of the nested-name-specifiers's onto a stack for
7156 // serialization in reverse order.
7157 while (QualifierLoc) {
7158 NestedNames.push_back(Elt: QualifierLoc);
7159 QualifierLoc = QualifierLoc.getAsNamespaceAndPrefix().Prefix;
7160 }
7161
7162 Record->push_back(Elt: NestedNames.size());
7163 while(!NestedNames.empty()) {
7164 QualifierLoc = NestedNames.pop_back_val();
7165 NestedNameSpecifier Qualifier = QualifierLoc.getNestedNameSpecifier();
7166 NestedNameSpecifier::Kind Kind = Qualifier.getKind();
7167 Record->push_back(Elt: llvm::to_underlying(E: Kind));
7168 switch (Kind) {
7169 case NestedNameSpecifier::Kind::Namespace:
7170 AddDeclRef(D: Qualifier.getAsNamespaceAndPrefix().Namespace);
7171 AddSourceRange(Range: QualifierLoc.getLocalSourceRange());
7172 break;
7173
7174 case NestedNameSpecifier::Kind::Type: {
7175 TypeLoc TL = QualifierLoc.castAsTypeLoc();
7176 AddTypeRef(T: TL.getType());
7177 AddTypeLoc(TL);
7178 AddSourceLocation(Loc: QualifierLoc.getLocalSourceRange().getEnd());
7179 break;
7180 }
7181
7182 case NestedNameSpecifier::Kind::Global:
7183 AddSourceLocation(Loc: QualifierLoc.getLocalSourceRange().getEnd());
7184 break;
7185
7186 case NestedNameSpecifier::Kind::MicrosoftSuper:
7187 AddDeclRef(D: Qualifier.getAsMicrosoftSuper());
7188 AddSourceRange(Range: QualifierLoc.getLocalSourceRange());
7189 break;
7190
7191 case NestedNameSpecifier::Kind::Null:
7192 llvm_unreachable("unexpected null nested name specifier");
7193 }
7194 }
7195}
7196
7197void ASTRecordWriter::AddTemplateParameterList(
7198 const TemplateParameterList *TemplateParams) {
7199 assert(TemplateParams && "No TemplateParams!");
7200 AddSourceLocation(Loc: TemplateParams->getTemplateLoc());
7201 AddSourceLocation(Loc: TemplateParams->getLAngleLoc());
7202 AddSourceLocation(Loc: TemplateParams->getRAngleLoc());
7203
7204 Record->push_back(Elt: TemplateParams->size());
7205 for (const auto &P : *TemplateParams)
7206 AddDeclRef(D: P);
7207 if (const Expr *RequiresClause = TemplateParams->getRequiresClause()) {
7208 Record->push_back(Elt: true);
7209 writeStmtRef(S: RequiresClause);
7210 } else {
7211 Record->push_back(Elt: false);
7212 }
7213}
7214
7215/// Emit a template argument list.
7216void ASTRecordWriter::AddTemplateArgumentList(
7217 const TemplateArgumentList *TemplateArgs) {
7218 assert(TemplateArgs && "No TemplateArgs!");
7219 Record->push_back(Elt: TemplateArgs->size());
7220 for (int i = 0, e = TemplateArgs->size(); i != e; ++i)
7221 AddTemplateArgument(Arg: TemplateArgs->get(Idx: i));
7222}
7223
7224void ASTRecordWriter::AddASTTemplateArgumentListInfo(
7225 const ASTTemplateArgumentListInfo *ASTTemplArgList) {
7226 assert(ASTTemplArgList && "No ASTTemplArgList!");
7227 AddSourceLocation(Loc: ASTTemplArgList->LAngleLoc);
7228 AddSourceLocation(Loc: ASTTemplArgList->RAngleLoc);
7229 Record->push_back(Elt: ASTTemplArgList->NumTemplateArgs);
7230 const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
7231 for (int i = 0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
7232 AddTemplateArgumentLoc(Arg: TemplArgs[i]);
7233}
7234
7235void ASTRecordWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set) {
7236 Record->push_back(Elt: Set.size());
7237 for (ASTUnresolvedSet::const_iterator
7238 I = Set.begin(), E = Set.end(); I != E; ++I) {
7239 AddDeclRef(D: I.getDecl());
7240 Record->push_back(Elt: I.getAccess());
7241 }
7242}
7243
7244// FIXME: Move this out of the main ASTRecordWriter interface.
7245void ASTRecordWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base) {
7246 Record->push_back(Elt: Base.isVirtual());
7247 Record->push_back(Elt: Base.isBaseOfClass());
7248 Record->push_back(Elt: Base.getAccessSpecifierAsWritten());
7249 Record->push_back(Elt: Base.getInheritConstructors());
7250 AddTypeSourceInfo(TInfo: Base.getTypeSourceInfo());
7251 AddSourceRange(Range: Base.getSourceRange());
7252 AddSourceLocation(Loc: Base.isPackExpansion()? Base.getEllipsisLoc()
7253 : SourceLocation());
7254}
7255
7256static uint64_t EmitCXXBaseSpecifiers(ASTContext &Context, ASTWriter &W,
7257 ArrayRef<CXXBaseSpecifier> Bases) {
7258 ASTWriter::RecordData Record;
7259 ASTRecordWriter Writer(Context, W, Record);
7260 Writer.push_back(N: Bases.size());
7261
7262 for (auto &Base : Bases)
7263 Writer.AddCXXBaseSpecifier(Base);
7264
7265 return Writer.Emit(Code: serialization::DECL_CXX_BASE_SPECIFIERS);
7266}
7267
7268// FIXME: Move this out of the main ASTRecordWriter interface.
7269void ASTRecordWriter::AddCXXBaseSpecifiers(ArrayRef<CXXBaseSpecifier> Bases) {
7270 AddOffset(BitOffset: EmitCXXBaseSpecifiers(Context&: getASTContext(), W&: *Writer, Bases));
7271}
7272
7273static uint64_t
7274EmitCXXCtorInitializers(ASTContext &Context, ASTWriter &W,
7275 ArrayRef<CXXCtorInitializer *> CtorInits) {
7276 ASTWriter::RecordData Record;
7277 ASTRecordWriter Writer(Context, W, Record);
7278 Writer.push_back(N: CtorInits.size());
7279
7280 for (auto *Init : CtorInits) {
7281 if (Init->isBaseInitializer()) {
7282 Writer.push_back(N: CTOR_INITIALIZER_BASE);
7283 Writer.AddTypeSourceInfo(TInfo: Init->getTypeSourceInfo());
7284 Writer.push_back(N: Init->isBaseVirtual());
7285 } else if (Init->isDelegatingInitializer()) {
7286 Writer.push_back(N: CTOR_INITIALIZER_DELEGATING);
7287 Writer.AddTypeSourceInfo(TInfo: Init->getTypeSourceInfo());
7288 } else if (Init->isMemberInitializer()){
7289 Writer.push_back(N: CTOR_INITIALIZER_MEMBER);
7290 Writer.AddDeclRef(D: Init->getMember());
7291 } else {
7292 Writer.push_back(N: CTOR_INITIALIZER_INDIRECT_MEMBER);
7293 Writer.AddDeclRef(D: Init->getIndirectMember());
7294 }
7295
7296 Writer.AddSourceLocation(Loc: Init->getMemberLocation());
7297 Writer.AddStmt(S: Init->getInit());
7298 Writer.AddSourceLocation(Loc: Init->getLParenLoc());
7299 Writer.AddSourceLocation(Loc: Init->getRParenLoc());
7300 Writer.push_back(N: Init->isWritten());
7301 if (Init->isWritten())
7302 Writer.push_back(N: Init->getSourceOrder());
7303 }
7304
7305 return Writer.Emit(Code: serialization::DECL_CXX_CTOR_INITIALIZERS);
7306}
7307
7308// FIXME: Move this out of the main ASTRecordWriter interface.
7309void ASTRecordWriter::AddCXXCtorInitializers(
7310 ArrayRef<CXXCtorInitializer *> CtorInits) {
7311 AddOffset(BitOffset: EmitCXXCtorInitializers(Context&: getASTContext(), W&: *Writer, CtorInits));
7312}
7313
7314void ASTRecordWriter::AddCXXDefinitionData(const CXXRecordDecl *D) {
7315 auto &Data = D->data();
7316
7317 Record->push_back(Elt: Data.IsLambda);
7318
7319 BitsPacker DefinitionBits;
7320
7321#define FIELD(Name, Width, Merge) \
7322 if (!DefinitionBits.canWriteNextNBits(Width)) { \
7323 Record->push_back(DefinitionBits); \
7324 DefinitionBits.reset(0); \
7325 } \
7326 DefinitionBits.addBits(Data.Name, Width);
7327
7328#include "clang/AST/CXXRecordDeclDefinitionBits.def"
7329#undef FIELD
7330
7331 Record->push_back(Elt: DefinitionBits);
7332
7333 // getODRHash will compute the ODRHash if it has not been previously
7334 // computed.
7335 Record->push_back(Elt: D->getODRHash());
7336
7337 bool ModulesCodegen =
7338 !D->isDependentType() &&
7339 D->getTemplateSpecializationKind() !=
7340 TSK_ExplicitInstantiationDeclaration &&
7341 (Writer->getLangOpts().ModulesDebugInfo || D->isInNamedModule());
7342 Record->push_back(Elt: ModulesCodegen);
7343 if (ModulesCodegen)
7344 Writer->AddDeclRef(D, Record&: Writer->ModularCodegenDecls);
7345
7346 // IsLambda bit is already saved.
7347
7348 AddUnresolvedSet(Set: Data.Conversions.get(C&: getASTContext()));
7349 Record->push_back(Elt: Data.ComputedVisibleConversions);
7350 if (Data.ComputedVisibleConversions)
7351 AddUnresolvedSet(Set: Data.VisibleConversions.get(C&: getASTContext()));
7352 // Data.Definition is the owning decl, no need to write it.
7353
7354 if (!Data.IsLambda) {
7355 Record->push_back(Elt: Data.NumBases);
7356 if (Data.NumBases > 0)
7357 AddCXXBaseSpecifiers(Bases: Data.bases());
7358
7359 // FIXME: Make VBases lazily computed when needed to avoid storing them.
7360 Record->push_back(Elt: Data.NumVBases);
7361 if (Data.NumVBases > 0)
7362 AddCXXBaseSpecifiers(Bases: Data.vbases());
7363
7364 AddDeclRef(D: D->getFirstFriend());
7365 } else {
7366 auto &Lambda = D->getLambdaData();
7367
7368 BitsPacker LambdaBits;
7369 LambdaBits.addBits(Value: Lambda.DependencyKind, /*Width=*/BitsWidth: 2);
7370 LambdaBits.addBit(Value: Lambda.IsGenericLambda);
7371 LambdaBits.addBits(Value: Lambda.CaptureDefault, /*Width=*/BitsWidth: 2);
7372 LambdaBits.addBits(Value: Lambda.NumCaptures, /*Width=*/BitsWidth: 15);
7373 LambdaBits.addBit(Value: Lambda.HasKnownInternalLinkage);
7374 Record->push_back(Elt: LambdaBits);
7375
7376 Record->push_back(Elt: Lambda.NumExplicitCaptures);
7377 Record->push_back(Elt: Lambda.ManglingNumber);
7378 Record->push_back(Elt: D->getDeviceLambdaManglingNumber());
7379 // The lambda context declaration and index within the context are provided
7380 // separately, so that they can be used for merging.
7381 AddTypeSourceInfo(TInfo: Lambda.MethodTyInfo);
7382 for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
7383 const LambdaCapture &Capture = Lambda.Captures.front()[I];
7384 AddSourceLocation(Loc: Capture.getLocation());
7385
7386 BitsPacker CaptureBits;
7387 CaptureBits.addBit(Value: Capture.isImplicit());
7388 CaptureBits.addBits(Value: Capture.getCaptureKind(), /*Width=*/BitsWidth: 3);
7389 Record->push_back(Elt: CaptureBits);
7390
7391 switch (Capture.getCaptureKind()) {
7392 case LCK_StarThis:
7393 case LCK_This:
7394 case LCK_VLAType:
7395 break;
7396 case LCK_ByCopy:
7397 case LCK_ByRef:
7398 ValueDecl *Var =
7399 Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
7400 AddDeclRef(D: Var);
7401 AddSourceLocation(Loc: Capture.isPackExpansion() ? Capture.getEllipsisLoc()
7402 : SourceLocation());
7403 break;
7404 }
7405 }
7406 }
7407}
7408
7409void ASTRecordWriter::AddVarDeclInit(const VarDecl *VD) {
7410 const Expr *Init = VD->getInit();
7411 if (!Init) {
7412 push_back(N: 0);
7413 return;
7414 }
7415
7416 uint64_t Val = 1;
7417 if (EvaluatedStmt *ES = VD->getEvaluatedStmt()) {
7418 // This may trigger evaluation, so run it first
7419 if (VD->hasInitWithSideEffects())
7420 Val |= 16;
7421 assert(ES->CheckedForSideEffects);
7422 Val |= (ES->HasConstantInitialization ? 2 : 0);
7423 Val |= (ES->HasConstantDestruction ? 4 : 0);
7424 APValue *Evaluated = VD->getEvaluatedValue();
7425 // If the evaluated result is constant, emit it.
7426 if (Evaluated && (Evaluated->isInt() || Evaluated->isFloat()))
7427 Val |= 8;
7428 }
7429 push_back(N: Val);
7430 if (Val & 8) {
7431 AddAPValue(Value: *VD->getEvaluatedValue());
7432 }
7433
7434 writeStmtRef(S: Init);
7435}
7436
7437void ASTWriter::ReaderInitialized(ASTReader *Reader) {
7438 assert(Reader && "Cannot remove chain");
7439 assert((!Chain || Chain == Reader) && "Cannot replace chain");
7440 assert(FirstDeclID == NextDeclID &&
7441 FirstTypeID == NextTypeID &&
7442 FirstIdentID == NextIdentID &&
7443 FirstMacroID == NextMacroID &&
7444 FirstSubmoduleID == NextSubmoduleID &&
7445 FirstSelectorID == NextSelectorID &&
7446 "Setting chain after writing has started.");
7447
7448 Chain = Reader;
7449
7450 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
7451 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
7452 NextSelectorID = FirstSelectorID;
7453 NextSubmoduleID = FirstSubmoduleID;
7454}
7455
7456void ASTWriter::IdentifierRead(IdentifierID ID, IdentifierInfo *II) {
7457 // Don't reuse Type ID from external modules for named modules. See the
7458 // comments in WriteASTCore for details.
7459 if (isWritingStdCXXNamedModules())
7460 return;
7461
7462 IdentifierID &StoredID = IdentifierIDs[II];
7463 unsigned OriginalModuleFileIndex = StoredID >> 32;
7464
7465 // Always keep the local identifier ID. See \p TypeRead() for more
7466 // information.
7467 if (OriginalModuleFileIndex == 0 && StoredID)
7468 return;
7469
7470 // Otherwise, keep the highest ID since the module file comes later has
7471 // higher module file indexes.
7472 if (ID > StoredID)
7473 StoredID = ID;
7474}
7475
7476void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
7477 // Always keep the highest ID. See \p TypeRead() for more information.
7478 MacroID &StoredID = MacroIDs[MI];
7479 unsigned OriginalModuleFileIndex = StoredID >> 32;
7480
7481 // Always keep the local macro ID. See \p TypeRead() for more information.
7482 if (OriginalModuleFileIndex == 0 && StoredID)
7483 return;
7484
7485 // Otherwise, keep the highest ID since the module file comes later has
7486 // higher module file indexes.
7487 if (ID > StoredID)
7488 StoredID = ID;
7489}
7490
7491void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
7492 // Don't reuse Type ID from external modules for named modules. See the
7493 // comments in WriteASTCore for details.
7494 if (isWritingStdCXXNamedModules())
7495 return;
7496
7497 // Always take the type index that comes in later module files.
7498 // This copes with an interesting
7499 // case for chained AST writing where we schedule writing the type and then,
7500 // later, deserialize the type from another AST. In this case, we want to
7501 // keep the entry from a later module so that we can properly write it out to
7502 // the AST file.
7503 TypeIdx &StoredIdx = TypeIdxs[T];
7504
7505 // Ignore it if the type comes from the current being written module file.
7506 // Since the current module file being written logically has the highest
7507 // index.
7508 unsigned ModuleFileIndex = StoredIdx.getModuleFileIndex();
7509 if (ModuleFileIndex == 0 && StoredIdx.getValue())
7510 return;
7511
7512 // Otherwise, keep the highest ID since the module file comes later has
7513 // higher module file indexes.
7514 if (Idx.getModuleFileIndex() >= StoredIdx.getModuleFileIndex())
7515 StoredIdx = Idx;
7516}
7517
7518void ASTWriter::PredefinedDeclBuilt(PredefinedDeclIDs ID, const Decl *D) {
7519 assert(D->isCanonicalDecl() && "predefined decl is not canonical");
7520 DeclIDs[D] = LocalDeclID(ID);
7521 PredefinedDecls.insert(Ptr: D);
7522}
7523
7524void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
7525 // Always keep the highest ID. See \p TypeRead() for more information.
7526 SelectorID &StoredID = SelectorIDs[S];
7527 if (ID > StoredID)
7528 StoredID = ID;
7529}
7530
7531void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
7532 MacroDefinitionRecord *MD) {
7533 assert(!MacroDefinitions.contains(MD));
7534 MacroDefinitions[MD] = ID;
7535}
7536
7537void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
7538 assert(!SubmoduleIDs.contains(Mod));
7539 SubmoduleIDs[Mod] = ID;
7540}
7541
7542void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
7543 if (Chain && Chain->isProcessingUpdateRecords()) return;
7544 assert(D->isCompleteDefinition());
7545 assert(!WritingAST && "Already writing the AST!");
7546 if (auto *RD = dyn_cast<CXXRecordDecl>(Val: D)) {
7547 // We are interested when a PCH decl is modified.
7548 if (RD->isFromASTFile()) {
7549 // A forward reference was mutated into a definition. Rewrite it.
7550 // FIXME: This happens during template instantiation, should we
7551 // have created a new definition decl instead ?
7552 assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
7553 "completed a tag from another module but not by instantiation?");
7554 DeclUpdates[RD].push_back(
7555 Elt: DeclUpdate(DeclUpdateKind::CXXInstantiatedClassDefinition));
7556 }
7557 }
7558}
7559
7560static bool isImportedDeclContext(ASTReader *Chain, const Decl *D) {
7561 if (D->isFromASTFile())
7562 return true;
7563
7564 // The predefined __va_list_tag struct is imported if we imported any decls.
7565 // FIXME: This is a gross hack.
7566 return D == D->getASTContext().getVaListTagDecl();
7567}
7568
7569void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
7570 if (Chain && Chain->isProcessingUpdateRecords()) return;
7571 assert(DC->isLookupContext() &&
7572 "Should not add lookup results to non-lookup contexts!");
7573
7574 // TU is handled elsewhere.
7575 if (isa<TranslationUnitDecl>(Val: DC))
7576 return;
7577
7578 // Namespaces are handled elsewhere, except for template instantiations of
7579 // FunctionTemplateDecls in namespaces. We are interested in cases where the
7580 // local instantiations are added to an imported context. Only happens when
7581 // adding ADL lookup candidates, for example templated friends.
7582 if (isa<NamespaceDecl>(Val: DC) && D->getFriendObjectKind() == Decl::FOK_None &&
7583 !isa<FunctionTemplateDecl>(Val: D))
7584 return;
7585
7586 // We're only interested in cases where a local declaration is added to an
7587 // imported context.
7588 if (D->isFromASTFile() || !isImportedDeclContext(Chain, D: cast<Decl>(Val: DC)))
7589 return;
7590
7591 assert(DC == DC->getPrimaryContext() && "added to non-primary context");
7592 assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
7593 assert(!WritingAST && "Already writing the AST!");
7594 if (UpdatedDeclContexts.insert(X: DC) && !cast<Decl>(Val: DC)->isFromASTFile()) {
7595 // We're adding a visible declaration to a predefined decl context. Ensure
7596 // that we write out all of its lookup results so we don't get a nasty
7597 // surprise when we try to emit its lookup table.
7598 llvm::append_range(C&: DeclsToEmitEvenIfUnreferenced, R: DC->decls());
7599 }
7600 DeclsToEmitEvenIfUnreferenced.push_back(Elt: D);
7601}
7602
7603void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
7604 if (Chain && Chain->isProcessingUpdateRecords()) return;
7605 assert(D->isImplicit());
7606
7607 // We're only interested in cases where a local declaration is added to an
7608 // imported context.
7609 if (D->isFromASTFile() || !isImportedDeclContext(Chain, D: RD))
7610 return;
7611
7612 if (!isa<CXXMethodDecl>(Val: D))
7613 return;
7614
7615 // A decl coming from PCH was modified.
7616 assert(RD->isCompleteDefinition());
7617 assert(!WritingAST && "Already writing the AST!");
7618 DeclUpdates[RD].push_back(
7619 Elt: DeclUpdate(DeclUpdateKind::CXXAddedImplicitMember, D));
7620}
7621
7622void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
7623 if (Chain && Chain->isProcessingUpdateRecords()) return;
7624 assert(!DoneWritingDeclsAndTypes && "Already done writing updates!");
7625 if (!Chain) return;
7626 Chain->forEachImportedKeyDecl(D: FD, Visit: [&](const Decl *D) {
7627 // If we don't already know the exception specification for this redecl
7628 // chain, add an update record for it.
7629 if (isUnresolvedExceptionSpec(ESpecType: cast<FunctionDecl>(Val: D)
7630 ->getType()
7631 ->castAs<FunctionProtoType>()
7632 ->getExceptionSpecType()))
7633 DeclUpdates[D].push_back(Elt: DeclUpdateKind::CXXResolvedExceptionSpec);
7634 });
7635}
7636
7637void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
7638 if (Chain && Chain->isProcessingUpdateRecords()) return;
7639 assert(!WritingAST && "Already writing the AST!");
7640 if (!Chain) return;
7641 Chain->forEachImportedKeyDecl(D: FD, Visit: [&](const Decl *D) {
7642 DeclUpdates[D].push_back(
7643 Elt: DeclUpdate(DeclUpdateKind::CXXDeducedReturnType, ReturnType));
7644 });
7645}
7646
7647void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD,
7648 const FunctionDecl *Delete,
7649 Expr *ThisArg) {
7650 if (Chain && Chain->isProcessingUpdateRecords()) return;
7651 assert(!WritingAST && "Already writing the AST!");
7652 assert(Delete && "Not given an operator delete");
7653 if (!Chain) return;
7654 Chain->forEachImportedKeyDecl(D: DD, Visit: [&](const Decl *D) {
7655 DeclUpdates[D].push_back(
7656 Elt: DeclUpdate(DeclUpdateKind::CXXResolvedDtorDelete, Delete));
7657 });
7658}
7659
7660void ASTWriter::ResolvedOperatorGlobDelete(const CXXDestructorDecl *DD,
7661 const FunctionDecl *GlobDelete) {
7662 if (Chain && Chain->isProcessingUpdateRecords())
7663 return;
7664 assert(!WritingAST && "Already writing the AST!");
7665 assert(GlobDelete && "Not given an operator delete");
7666 if (!Chain)
7667 return;
7668 Chain->forEachImportedKeyDecl(D: DD, Visit: [&](const Decl *D) {
7669 DeclUpdates[D].push_back(
7670 Elt: DeclUpdate(DeclUpdateKind::CXXResolvedDtorGlobDelete, GlobDelete));
7671 });
7672}
7673
7674void ASTWriter::ResolvedOperatorArrayDelete(const CXXDestructorDecl *DD,
7675 const FunctionDecl *ArrayDelete) {
7676 if (Chain && Chain->isProcessingUpdateRecords())
7677 return;
7678 assert(!WritingAST && "Already writing the AST!");
7679 assert(ArrayDelete && "Not given an operator delete");
7680 if (!Chain)
7681 return;
7682 Chain->forEachImportedKeyDecl(D: DD, Visit: [&](const Decl *D) {
7683 DeclUpdates[D].push_back(
7684 Elt: DeclUpdate(DeclUpdateKind::CXXResolvedDtorArrayDelete, ArrayDelete));
7685 });
7686}
7687
7688void ASTWriter::ResolvedOperatorGlobArrayDelete(
7689 const CXXDestructorDecl *DD, const FunctionDecl *GlobArrayDelete) {
7690 if (Chain && Chain->isProcessingUpdateRecords())
7691 return;
7692 assert(!WritingAST && "Already writing the AST!");
7693 assert(GlobArrayDelete && "Not given an operator delete");
7694 if (!Chain)
7695 return;
7696 Chain->forEachImportedKeyDecl(D: DD, Visit: [&](const Decl *D) {
7697 DeclUpdates[D].push_back(Elt: DeclUpdate(
7698 DeclUpdateKind::CXXResolvedDtorGlobArrayDelete, GlobArrayDelete));
7699 });
7700}
7701
7702void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
7703 if (Chain && Chain->isProcessingUpdateRecords()) return;
7704 assert(!WritingAST && "Already writing the AST!");
7705 if (!D->isFromASTFile())
7706 return; // Declaration not imported from PCH.
7707
7708 // The function definition may not have a body due to parsing errors.
7709 if (!D->doesThisDeclarationHaveABody())
7710 return;
7711
7712 // Implicit function decl from a PCH was defined.
7713 DeclUpdates[D].push_back(
7714 Elt: DeclUpdate(DeclUpdateKind::CXXAddedFunctionDefinition));
7715}
7716
7717void ASTWriter::VariableDefinitionInstantiated(const VarDecl *D) {
7718 if (Chain && Chain->isProcessingUpdateRecords()) return;
7719 assert(!WritingAST && "Already writing the AST!");
7720 if (!D->isFromASTFile())
7721 return;
7722
7723 DeclUpdates[D].push_back(Elt: DeclUpdate(DeclUpdateKind::CXXAddedVarDefinition));
7724}
7725
7726void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
7727 if (Chain && Chain->isProcessingUpdateRecords()) return;
7728 assert(!WritingAST && "Already writing the AST!");
7729 if (!D->isFromASTFile())
7730 return;
7731
7732 // The function definition may not have a body due to parsing errors.
7733 if (!D->doesThisDeclarationHaveABody())
7734 return;
7735
7736 DeclUpdates[D].push_back(
7737 Elt: DeclUpdate(DeclUpdateKind::CXXAddedFunctionDefinition));
7738}
7739
7740void ASTWriter::InstantiationRequested(const ValueDecl *D) {
7741 if (Chain && Chain->isProcessingUpdateRecords()) return;
7742 assert(!WritingAST && "Already writing the AST!");
7743 if (!D->isFromASTFile())
7744 return;
7745
7746 // Since the actual instantiation is delayed, this really means that we need
7747 // to update the instantiation location.
7748 SourceLocation POI;
7749 if (auto *VD = dyn_cast<VarDecl>(Val: D))
7750 POI = VD->getPointOfInstantiation();
7751 else
7752 POI = cast<FunctionDecl>(Val: D)->getPointOfInstantiation();
7753 DeclUpdates[D].push_back(
7754 Elt: DeclUpdate(DeclUpdateKind::CXXPointOfInstantiation, POI));
7755}
7756
7757void ASTWriter::DefaultArgumentInstantiated(const ParmVarDecl *D) {
7758 if (Chain && Chain->isProcessingUpdateRecords()) return;
7759 assert(!WritingAST && "Already writing the AST!");
7760 if (!D->isFromASTFile())
7761 return;
7762
7763 DeclUpdates[D].push_back(
7764 Elt: DeclUpdate(DeclUpdateKind::CXXInstantiatedDefaultArgument, D));
7765}
7766
7767void ASTWriter::DefaultMemberInitializerInstantiated(const FieldDecl *D) {
7768 assert(!WritingAST && "Already writing the AST!");
7769 if (!D->isFromASTFile())
7770 return;
7771
7772 DeclUpdates[D].push_back(
7773 Elt: DeclUpdate(DeclUpdateKind::CXXInstantiatedDefaultMemberInitializer, D));
7774}
7775
7776void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
7777 const ObjCInterfaceDecl *IFD) {
7778 if (Chain && Chain->isProcessingUpdateRecords()) return;
7779 assert(!WritingAST && "Already writing the AST!");
7780 if (!IFD->isFromASTFile())
7781 return; // Declaration not imported from PCH.
7782
7783 assert(IFD->getDefinition() && "Category on a class without a definition?");
7784 ObjCClassesWithCategories.insert(
7785 X: const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
7786}
7787
7788void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
7789 if (Chain && Chain->isProcessingUpdateRecords()) return;
7790 assert(!WritingAST && "Already writing the AST!");
7791
7792 // If there is *any* declaration of the entity that's not from an AST file,
7793 // we can skip writing the update record. We make sure that isUsed() triggers
7794 // completion of the redeclaration chain of the entity.
7795 for (auto Prev = D->getMostRecentDecl(); Prev; Prev = Prev->getPreviousDecl())
7796 if (IsLocalDecl(D: Prev))
7797 return;
7798
7799 DeclUpdates[D].push_back(Elt: DeclUpdate(DeclUpdateKind::DeclMarkedUsed));
7800}
7801
7802void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
7803 if (Chain && Chain->isProcessingUpdateRecords()) return;
7804 assert(!WritingAST && "Already writing the AST!");
7805 if (!D->isFromASTFile())
7806 return;
7807
7808 DeclUpdates[D].push_back(
7809 Elt: DeclUpdate(DeclUpdateKind::DeclMarkedOpenMPThreadPrivate));
7810}
7811
7812void ASTWriter::DeclarationMarkedOpenMPAllocate(const Decl *D, const Attr *A) {
7813 if (Chain && Chain->isProcessingUpdateRecords()) return;
7814 assert(!WritingAST && "Already writing the AST!");
7815 if (!D->isFromASTFile())
7816 return;
7817
7818 DeclUpdates[D].push_back(
7819 Elt: DeclUpdate(DeclUpdateKind::DeclMarkedOpenMPAllocate, A));
7820}
7821
7822void ASTWriter::DeclarationMarkedOpenMPDeclareTarget(const Decl *D,
7823 const Attr *Attr) {
7824 if (Chain && Chain->isProcessingUpdateRecords()) return;
7825 assert(!WritingAST && "Already writing the AST!");
7826 if (!D->isFromASTFile())
7827 return;
7828
7829 DeclUpdates[D].push_back(
7830 Elt: DeclUpdate(DeclUpdateKind::DeclMarkedOpenMPDeclareTarget, Attr));
7831}
7832
7833void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) {
7834 if (Chain && Chain->isProcessingUpdateRecords()) return;
7835 assert(!WritingAST && "Already writing the AST!");
7836 assert(!D->isUnconditionallyVisible() && "expected a hidden declaration");
7837 DeclUpdates[D].push_back(Elt: DeclUpdate(DeclUpdateKind::DeclExported, M));
7838}
7839
7840void ASTWriter::AddedAttributeToRecord(const Attr *Attr,
7841 const RecordDecl *Record) {
7842 if (Chain && Chain->isProcessingUpdateRecords()) return;
7843 assert(!WritingAST && "Already writing the AST!");
7844 if (!Record->isFromASTFile())
7845 return;
7846 DeclUpdates[Record].push_back(
7847 Elt: DeclUpdate(DeclUpdateKind::AddedAttrToRecord, Attr));
7848}
7849
7850void ASTWriter::AddedCXXTemplateSpecialization(
7851 const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) {
7852 assert(!WritingAST && "Already writing the AST!");
7853
7854 if (!TD->getFirstDecl()->isFromASTFile())
7855 return;
7856 if (Chain && Chain->isProcessingUpdateRecords())
7857 return;
7858
7859 DeclsToEmitEvenIfUnreferenced.push_back(Elt: D);
7860}
7861
7862void ASTWriter::AddedCXXTemplateSpecialization(
7863 const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
7864 assert(!WritingAST && "Already writing the AST!");
7865
7866 if (!TD->getFirstDecl()->isFromASTFile())
7867 return;
7868 if (Chain && Chain->isProcessingUpdateRecords())
7869 return;
7870
7871 DeclsToEmitEvenIfUnreferenced.push_back(Elt: D);
7872}
7873
7874void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
7875 const FunctionDecl *D) {
7876 assert(!WritingAST && "Already writing the AST!");
7877
7878 if (!TD->getFirstDecl()->isFromASTFile())
7879 return;
7880 if (Chain && Chain->isProcessingUpdateRecords())
7881 return;
7882
7883 DeclsToEmitEvenIfUnreferenced.push_back(Elt: D);
7884}
7885
7886//===----------------------------------------------------------------------===//
7887//// OMPClause Serialization
7888////===----------------------------------------------------------------------===//
7889
7890namespace {
7891
7892class OMPClauseWriter : public OMPClauseVisitor<OMPClauseWriter> {
7893 ASTRecordWriter &Record;
7894
7895public:
7896 OMPClauseWriter(ASTRecordWriter &Record) : Record(Record) {}
7897#define GEN_CLANG_CLAUSE_CLASS
7898#define CLAUSE_CLASS(Enum, Str, Class) void Visit##Class(Class *S);
7899#include "llvm/Frontend/OpenMP/OMP.inc"
7900 void writeClause(OMPClause *C);
7901 void VisitOMPClauseWithPreInit(OMPClauseWithPreInit *C);
7902 void VisitOMPClauseWithPostUpdate(OMPClauseWithPostUpdate *C);
7903};
7904
7905}
7906
7907void ASTRecordWriter::writeOMPClause(OMPClause *C) {
7908 OMPClauseWriter(*this).writeClause(C);
7909}
7910
7911void OMPClauseWriter::writeClause(OMPClause *C) {
7912 Record.push_back(N: unsigned(C->getClauseKind()));
7913 Visit(S: C);
7914 Record.AddSourceLocation(Loc: C->getBeginLoc());
7915 Record.AddSourceLocation(Loc: C->getEndLoc());
7916}
7917
7918void OMPClauseWriter::VisitOMPClauseWithPreInit(OMPClauseWithPreInit *C) {
7919 Record.push_back(N: uint64_t(C->getCaptureRegion()));
7920 Record.AddStmt(S: C->getPreInitStmt());
7921}
7922
7923void OMPClauseWriter::VisitOMPClauseWithPostUpdate(OMPClauseWithPostUpdate *C) {
7924 VisitOMPClauseWithPreInit(C);
7925 Record.AddStmt(S: C->getPostUpdateExpr());
7926}
7927
7928void OMPClauseWriter::VisitOMPIfClause(OMPIfClause *C) {
7929 VisitOMPClauseWithPreInit(C);
7930 Record.push_back(N: uint64_t(C->getNameModifier()));
7931 Record.AddSourceLocation(Loc: C->getNameModifierLoc());
7932 Record.AddSourceLocation(Loc: C->getColonLoc());
7933 Record.AddStmt(S: C->getCondition());
7934 Record.AddSourceLocation(Loc: C->getLParenLoc());
7935}
7936
7937void OMPClauseWriter::VisitOMPFinalClause(OMPFinalClause *C) {
7938 VisitOMPClauseWithPreInit(C);
7939 Record.AddStmt(S: C->getCondition());
7940 Record.AddSourceLocation(Loc: C->getLParenLoc());
7941}
7942
7943void OMPClauseWriter::VisitOMPNumThreadsClause(OMPNumThreadsClause *C) {
7944 VisitOMPClauseWithPreInit(C);
7945 Record.writeEnum(value: C->getModifier());
7946 Record.AddStmt(S: C->getNumThreads());
7947 Record.AddSourceLocation(Loc: C->getModifierLoc());
7948 Record.AddSourceLocation(Loc: C->getLParenLoc());
7949}
7950
7951void OMPClauseWriter::VisitOMPSafelenClause(OMPSafelenClause *C) {
7952 Record.AddStmt(S: C->getSafelen());
7953 Record.AddSourceLocation(Loc: C->getLParenLoc());
7954}
7955
7956void OMPClauseWriter::VisitOMPSimdlenClause(OMPSimdlenClause *C) {
7957 Record.AddStmt(S: C->getSimdlen());
7958 Record.AddSourceLocation(Loc: C->getLParenLoc());
7959}
7960
7961void OMPClauseWriter::VisitOMPSizesClause(OMPSizesClause *C) {
7962 Record.push_back(N: C->getNumSizes());
7963 for (Expr *Size : C->getSizesRefs())
7964 Record.AddStmt(S: Size);
7965 Record.AddSourceLocation(Loc: C->getLParenLoc());
7966}
7967
7968void OMPClauseWriter::VisitOMPPermutationClause(OMPPermutationClause *C) {
7969 Record.push_back(N: C->getNumLoops());
7970 for (Expr *Size : C->getArgsRefs())
7971 Record.AddStmt(S: Size);
7972 Record.AddSourceLocation(Loc: C->getLParenLoc());
7973}
7974
7975void OMPClauseWriter::VisitOMPFullClause(OMPFullClause *C) {}
7976
7977void OMPClauseWriter::VisitOMPPartialClause(OMPPartialClause *C) {
7978 Record.AddStmt(S: C->getFactor());
7979 Record.AddSourceLocation(Loc: C->getLParenLoc());
7980}
7981
7982void OMPClauseWriter::VisitOMPLoopRangeClause(OMPLoopRangeClause *C) {
7983 Record.AddStmt(S: C->getFirst());
7984 Record.AddStmt(S: C->getCount());
7985 Record.AddSourceLocation(Loc: C->getLParenLoc());
7986 Record.AddSourceLocation(Loc: C->getFirstLoc());
7987 Record.AddSourceLocation(Loc: C->getCountLoc());
7988}
7989
7990void OMPClauseWriter::VisitOMPAllocatorClause(OMPAllocatorClause *C) {
7991 Record.AddStmt(S: C->getAllocator());
7992 Record.AddSourceLocation(Loc: C->getLParenLoc());
7993}
7994
7995void OMPClauseWriter::VisitOMPCollapseClause(OMPCollapseClause *C) {
7996 Record.AddStmt(S: C->getNumForLoops());
7997 Record.AddSourceLocation(Loc: C->getLParenLoc());
7998}
7999
8000void OMPClauseWriter::VisitOMPDetachClause(OMPDetachClause *C) {
8001 Record.AddStmt(S: C->getEventHandler());
8002 Record.AddSourceLocation(Loc: C->getLParenLoc());
8003}
8004
8005void OMPClauseWriter::VisitOMPDefaultClause(OMPDefaultClause *C) {
8006 Record.push_back(N: unsigned(C->getDefaultKind()));
8007 Record.AddSourceLocation(Loc: C->getLParenLoc());
8008 Record.AddSourceLocation(Loc: C->getDefaultKindKwLoc());
8009 Record.push_back(N: unsigned(C->getDefaultVC()));
8010 Record.AddSourceLocation(Loc: C->getDefaultVCLoc());
8011}
8012
8013void OMPClauseWriter::VisitOMPThreadsetClause(OMPThreadsetClause *C) {
8014 Record.AddSourceLocation(Loc: C->getLParenLoc());
8015 Record.AddSourceLocation(Loc: C->getThreadsetKindLoc());
8016 Record.writeEnum(value: C->getThreadsetKind());
8017}
8018
8019void OMPClauseWriter::VisitOMPTransparentClause(OMPTransparentClause *C) {
8020 Record.AddSourceLocation(Loc: C->getLParenLoc());
8021 Record.AddStmt(S: C->getImpexType());
8022}
8023
8024void OMPClauseWriter::VisitOMPProcBindClause(OMPProcBindClause *C) {
8025 Record.push_back(N: unsigned(C->getProcBindKind()));
8026 Record.AddSourceLocation(Loc: C->getLParenLoc());
8027 Record.AddSourceLocation(Loc: C->getProcBindKindKwLoc());
8028}
8029
8030void OMPClauseWriter::VisitOMPScheduleClause(OMPScheduleClause *C) {
8031 VisitOMPClauseWithPreInit(C);
8032 Record.push_back(N: C->getScheduleKind());
8033 Record.push_back(N: C->getFirstScheduleModifier());
8034 Record.push_back(N: C->getSecondScheduleModifier());
8035 Record.AddStmt(S: C->getChunkSize());
8036 Record.AddSourceLocation(Loc: C->getLParenLoc());
8037 Record.AddSourceLocation(Loc: C->getFirstScheduleModifierLoc());
8038 Record.AddSourceLocation(Loc: C->getSecondScheduleModifierLoc());
8039 Record.AddSourceLocation(Loc: C->getScheduleKindLoc());
8040 Record.AddSourceLocation(Loc: C->getCommaLoc());
8041}
8042
8043void OMPClauseWriter::VisitOMPOrderedClause(OMPOrderedClause *C) {
8044 Record.push_back(N: C->getLoopNumIterations().size());
8045 Record.AddStmt(S: C->getNumForLoops());
8046 for (Expr *NumIter : C->getLoopNumIterations())
8047 Record.AddStmt(S: NumIter);
8048 for (unsigned I = 0, E = C->getLoopNumIterations().size(); I <E; ++I)
8049 Record.AddStmt(S: C->getLoopCounter(NumLoop: I));
8050 Record.AddSourceLocation(Loc: C->getLParenLoc());
8051}
8052
8053void OMPClauseWriter::VisitOMPNowaitClause(OMPNowaitClause *C) {
8054 Record.AddStmt(S: C->getCondition());
8055 Record.AddSourceLocation(Loc: C->getLParenLoc());
8056}
8057
8058void OMPClauseWriter::VisitOMPUntiedClause(OMPUntiedClause *) {}
8059
8060void OMPClauseWriter::VisitOMPMergeableClause(OMPMergeableClause *) {}
8061
8062void OMPClauseWriter::VisitOMPReadClause(OMPReadClause *) {}
8063
8064void OMPClauseWriter::VisitOMPWriteClause(OMPWriteClause *) {}
8065
8066void OMPClauseWriter::VisitOMPUpdateClause(OMPUpdateClause *C) {
8067 Record.push_back(N: C->isExtended() ? 1 : 0);
8068 if (C->isExtended()) {
8069 Record.AddSourceLocation(Loc: C->getLParenLoc());
8070 Record.AddSourceLocation(Loc: C->getArgumentLoc());
8071 Record.writeEnum(value: C->getDependencyKind());
8072 }
8073}
8074
8075void OMPClauseWriter::VisitOMPCaptureClause(OMPCaptureClause *) {}
8076
8077void OMPClauseWriter::VisitOMPCompareClause(OMPCompareClause *) {}
8078
8079// Save the parameter of fail clause.
8080void OMPClauseWriter::VisitOMPFailClause(OMPFailClause *C) {
8081 Record.AddSourceLocation(Loc: C->getLParenLoc());
8082 Record.AddSourceLocation(Loc: C->getFailParameterLoc());
8083 Record.writeEnum(value: C->getFailParameter());
8084}
8085
8086void OMPClauseWriter::VisitOMPSeqCstClause(OMPSeqCstClause *) {}
8087
8088void OMPClauseWriter::VisitOMPAcqRelClause(OMPAcqRelClause *) {}
8089
8090void OMPClauseWriter::VisitOMPAbsentClause(OMPAbsentClause *C) {
8091 Record.push_back(N: static_cast<uint64_t>(C->getDirectiveKinds().size()));
8092 Record.AddSourceLocation(Loc: C->getLParenLoc());
8093 for (auto K : C->getDirectiveKinds()) {
8094 Record.writeEnum(value: K);
8095 }
8096}
8097
8098void OMPClauseWriter::VisitOMPHoldsClause(OMPHoldsClause *C) {
8099 Record.AddStmt(S: C->getExpr());
8100 Record.AddSourceLocation(Loc: C->getLParenLoc());
8101}
8102
8103void OMPClauseWriter::VisitOMPContainsClause(OMPContainsClause *C) {
8104 Record.push_back(N: static_cast<uint64_t>(C->getDirectiveKinds().size()));
8105 Record.AddSourceLocation(Loc: C->getLParenLoc());
8106 for (auto K : C->getDirectiveKinds()) {
8107 Record.writeEnum(value: K);
8108 }
8109}
8110
8111void OMPClauseWriter::VisitOMPNoOpenMPClause(OMPNoOpenMPClause *) {}
8112
8113void OMPClauseWriter::VisitOMPNoOpenMPRoutinesClause(
8114 OMPNoOpenMPRoutinesClause *) {}
8115
8116void OMPClauseWriter::VisitOMPNoOpenMPConstructsClause(
8117 OMPNoOpenMPConstructsClause *) {}
8118
8119void OMPClauseWriter::VisitOMPNoParallelismClause(OMPNoParallelismClause *) {}
8120
8121void OMPClauseWriter::VisitOMPAcquireClause(OMPAcquireClause *) {}
8122
8123void OMPClauseWriter::VisitOMPReleaseClause(OMPReleaseClause *) {}
8124
8125void OMPClauseWriter::VisitOMPRelaxedClause(OMPRelaxedClause *) {}
8126
8127void OMPClauseWriter::VisitOMPWeakClause(OMPWeakClause *) {}
8128
8129void OMPClauseWriter::VisitOMPThreadsClause(OMPThreadsClause *) {}
8130
8131void OMPClauseWriter::VisitOMPSIMDClause(OMPSIMDClause *) {}
8132
8133void OMPClauseWriter::VisitOMPNogroupClause(OMPNogroupClause *) {}
8134
8135void OMPClauseWriter::VisitOMPInitClause(OMPInitClause *C) {
8136 Record.push_back(N: C->varlist_size());
8137 for (Expr *VE : C->varlist())
8138 Record.AddStmt(S: VE);
8139 Record.writeBool(Value: C->getIsTarget());
8140 Record.writeBool(Value: C->getIsTargetSync());
8141 Record.AddSourceLocation(Loc: C->getLParenLoc());
8142 Record.AddSourceLocation(Loc: C->getVarLoc());
8143}
8144
8145void OMPClauseWriter::VisitOMPUseClause(OMPUseClause *C) {
8146 Record.AddStmt(S: C->getInteropVar());
8147 Record.AddSourceLocation(Loc: C->getLParenLoc());
8148 Record.AddSourceLocation(Loc: C->getVarLoc());
8149}
8150
8151void OMPClauseWriter::VisitOMPDestroyClause(OMPDestroyClause *C) {
8152 Record.AddStmt(S: C->getInteropVar());
8153 Record.AddSourceLocation(Loc: C->getLParenLoc());
8154 Record.AddSourceLocation(Loc: C->getVarLoc());
8155}
8156
8157void OMPClauseWriter::VisitOMPNovariantsClause(OMPNovariantsClause *C) {
8158 VisitOMPClauseWithPreInit(C);
8159 Record.AddStmt(S: C->getCondition());
8160 Record.AddSourceLocation(Loc: C->getLParenLoc());
8161}
8162
8163void OMPClauseWriter::VisitOMPNocontextClause(OMPNocontextClause *C) {
8164 VisitOMPClauseWithPreInit(C);
8165 Record.AddStmt(S: C->getCondition());
8166 Record.AddSourceLocation(Loc: C->getLParenLoc());
8167}
8168
8169void OMPClauseWriter::VisitOMPFilterClause(OMPFilterClause *C) {
8170 VisitOMPClauseWithPreInit(C);
8171 Record.AddStmt(S: C->getThreadID());
8172 Record.AddSourceLocation(Loc: C->getLParenLoc());
8173}
8174
8175void OMPClauseWriter::VisitOMPAlignClause(OMPAlignClause *C) {
8176 Record.AddStmt(S: C->getAlignment());
8177 Record.AddSourceLocation(Loc: C->getLParenLoc());
8178}
8179
8180void OMPClauseWriter::VisitOMPPrivateClause(OMPPrivateClause *C) {
8181 Record.push_back(N: C->varlist_size());
8182 Record.AddSourceLocation(Loc: C->getLParenLoc());
8183 for (auto *VE : C->varlist()) {
8184 Record.AddStmt(S: VE);
8185 }
8186 for (auto *VE : C->private_copies()) {
8187 Record.AddStmt(S: VE);
8188 }
8189}
8190
8191void OMPClauseWriter::VisitOMPFirstprivateClause(OMPFirstprivateClause *C) {
8192 Record.push_back(N: C->varlist_size());
8193 VisitOMPClauseWithPreInit(C);
8194 Record.AddSourceLocation(Loc: C->getLParenLoc());
8195 for (auto *VE : C->varlist()) {
8196 Record.AddStmt(S: VE);
8197 }
8198 for (auto *VE : C->private_copies()) {
8199 Record.AddStmt(S: VE);
8200 }
8201 for (auto *VE : C->inits()) {
8202 Record.AddStmt(S: VE);
8203 }
8204}
8205
8206void OMPClauseWriter::VisitOMPLastprivateClause(OMPLastprivateClause *C) {
8207 Record.push_back(N: C->varlist_size());
8208 VisitOMPClauseWithPostUpdate(C);
8209 Record.AddSourceLocation(Loc: C->getLParenLoc());
8210 Record.writeEnum(value: C->getKind());
8211 Record.AddSourceLocation(Loc: C->getKindLoc());
8212 Record.AddSourceLocation(Loc: C->getColonLoc());
8213 for (auto *VE : C->varlist())
8214 Record.AddStmt(S: VE);
8215 for (auto *E : C->private_copies())
8216 Record.AddStmt(S: E);
8217 for (auto *E : C->source_exprs())
8218 Record.AddStmt(S: E);
8219 for (auto *E : C->destination_exprs())
8220 Record.AddStmt(S: E);
8221 for (auto *E : C->assignment_ops())
8222 Record.AddStmt(S: E);
8223}
8224
8225void OMPClauseWriter::VisitOMPSharedClause(OMPSharedClause *C) {
8226 Record.push_back(N: C->varlist_size());
8227 Record.AddSourceLocation(Loc: C->getLParenLoc());
8228 for (auto *VE : C->varlist())
8229 Record.AddStmt(S: VE);
8230}
8231
8232void OMPClauseWriter::VisitOMPReductionClause(OMPReductionClause *C) {
8233 Record.push_back(N: C->varlist_size());
8234 Record.writeEnum(value: C->getModifier());
8235 VisitOMPClauseWithPostUpdate(C);
8236 Record.AddSourceLocation(Loc: C->getLParenLoc());
8237 Record.AddSourceLocation(Loc: C->getModifierLoc());
8238 Record.AddSourceLocation(Loc: C->getColonLoc());
8239 Record.AddNestedNameSpecifierLoc(QualifierLoc: C->getQualifierLoc());
8240 Record.AddDeclarationNameInfo(NameInfo: C->getNameInfo());
8241 for (auto *VE : C->varlist())
8242 Record.AddStmt(S: VE);
8243 for (auto *VE : C->privates())
8244 Record.AddStmt(S: VE);
8245 for (auto *E : C->lhs_exprs())
8246 Record.AddStmt(S: E);
8247 for (auto *E : C->rhs_exprs())
8248 Record.AddStmt(S: E);
8249 for (auto *E : C->reduction_ops())
8250 Record.AddStmt(S: E);
8251 if (C->getModifier() == clang::OMPC_REDUCTION_inscan) {
8252 for (auto *E : C->copy_ops())
8253 Record.AddStmt(S: E);
8254 for (auto *E : C->copy_array_temps())
8255 Record.AddStmt(S: E);
8256 for (auto *E : C->copy_array_elems())
8257 Record.AddStmt(S: E);
8258 }
8259 auto PrivateFlags = C->private_var_reduction_flags();
8260 Record.push_back(N: std::distance(first: PrivateFlags.begin(), last: PrivateFlags.end()));
8261 for (bool Flag : PrivateFlags)
8262 Record.push_back(N: Flag);
8263}
8264
8265void OMPClauseWriter::VisitOMPTaskReductionClause(OMPTaskReductionClause *C) {
8266 Record.push_back(N: C->varlist_size());
8267 VisitOMPClauseWithPostUpdate(C);
8268 Record.AddSourceLocation(Loc: C->getLParenLoc());
8269 Record.AddSourceLocation(Loc: C->getColonLoc());
8270 Record.AddNestedNameSpecifierLoc(QualifierLoc: C->getQualifierLoc());
8271 Record.AddDeclarationNameInfo(NameInfo: C->getNameInfo());
8272 for (auto *VE : C->varlist())
8273 Record.AddStmt(S: VE);
8274 for (auto *VE : C->privates())
8275 Record.AddStmt(S: VE);
8276 for (auto *E : C->lhs_exprs())
8277 Record.AddStmt(S: E);
8278 for (auto *E : C->rhs_exprs())
8279 Record.AddStmt(S: E);
8280 for (auto *E : C->reduction_ops())
8281 Record.AddStmt(S: E);
8282}
8283
8284void OMPClauseWriter::VisitOMPInReductionClause(OMPInReductionClause *C) {
8285 Record.push_back(N: C->varlist_size());
8286 VisitOMPClauseWithPostUpdate(C);
8287 Record.AddSourceLocation(Loc: C->getLParenLoc());
8288 Record.AddSourceLocation(Loc: C->getColonLoc());
8289 Record.AddNestedNameSpecifierLoc(QualifierLoc: C->getQualifierLoc());
8290 Record.AddDeclarationNameInfo(NameInfo: C->getNameInfo());
8291 for (auto *VE : C->varlist())
8292 Record.AddStmt(S: VE);
8293 for (auto *VE : C->privates())
8294 Record.AddStmt(S: VE);
8295 for (auto *E : C->lhs_exprs())
8296 Record.AddStmt(S: E);
8297 for (auto *E : C->rhs_exprs())
8298 Record.AddStmt(S: E);
8299 for (auto *E : C->reduction_ops())
8300 Record.AddStmt(S: E);
8301 for (auto *E : C->taskgroup_descriptors())
8302 Record.AddStmt(S: E);
8303}
8304
8305void OMPClauseWriter::VisitOMPLinearClause(OMPLinearClause *C) {
8306 Record.push_back(N: C->varlist_size());
8307 VisitOMPClauseWithPostUpdate(C);
8308 Record.AddSourceLocation(Loc: C->getLParenLoc());
8309 Record.AddSourceLocation(Loc: C->getColonLoc());
8310 Record.push_back(N: C->getModifier());
8311 Record.AddSourceLocation(Loc: C->getModifierLoc());
8312 for (auto *VE : C->varlist()) {
8313 Record.AddStmt(S: VE);
8314 }
8315 for (auto *VE : C->privates()) {
8316 Record.AddStmt(S: VE);
8317 }
8318 for (auto *VE : C->inits()) {
8319 Record.AddStmt(S: VE);
8320 }
8321 for (auto *VE : C->updates()) {
8322 Record.AddStmt(S: VE);
8323 }
8324 for (auto *VE : C->finals()) {
8325 Record.AddStmt(S: VE);
8326 }
8327 Record.AddStmt(S: C->getStep());
8328 Record.AddStmt(S: C->getCalcStep());
8329 for (auto *VE : C->used_expressions())
8330 Record.AddStmt(S: VE);
8331}
8332
8333void OMPClauseWriter::VisitOMPAlignedClause(OMPAlignedClause *C) {
8334 Record.push_back(N: C->varlist_size());
8335 Record.AddSourceLocation(Loc: C->getLParenLoc());
8336 Record.AddSourceLocation(Loc: C->getColonLoc());
8337 for (auto *VE : C->varlist())
8338 Record.AddStmt(S: VE);
8339 Record.AddStmt(S: C->getAlignment());
8340}
8341
8342void OMPClauseWriter::VisitOMPCopyinClause(OMPCopyinClause *C) {
8343 Record.push_back(N: C->varlist_size());
8344 Record.AddSourceLocation(Loc: C->getLParenLoc());
8345 for (auto *VE : C->varlist())
8346 Record.AddStmt(S: VE);
8347 for (auto *E : C->source_exprs())
8348 Record.AddStmt(S: E);
8349 for (auto *E : C->destination_exprs())
8350 Record.AddStmt(S: E);
8351 for (auto *E : C->assignment_ops())
8352 Record.AddStmt(S: E);
8353}
8354
8355void OMPClauseWriter::VisitOMPCopyprivateClause(OMPCopyprivateClause *C) {
8356 Record.push_back(N: C->varlist_size());
8357 Record.AddSourceLocation(Loc: C->getLParenLoc());
8358 for (auto *VE : C->varlist())
8359 Record.AddStmt(S: VE);
8360 for (auto *E : C->source_exprs())
8361 Record.AddStmt(S: E);
8362 for (auto *E : C->destination_exprs())
8363 Record.AddStmt(S: E);
8364 for (auto *E : C->assignment_ops())
8365 Record.AddStmt(S: E);
8366}
8367
8368void OMPClauseWriter::VisitOMPFlushClause(OMPFlushClause *C) {
8369 Record.push_back(N: C->varlist_size());
8370 Record.AddSourceLocation(Loc: C->getLParenLoc());
8371 for (auto *VE : C->varlist())
8372 Record.AddStmt(S: VE);
8373}
8374
8375void OMPClauseWriter::VisitOMPDepobjClause(OMPDepobjClause *C) {
8376 Record.AddStmt(S: C->getDepobj());
8377 Record.AddSourceLocation(Loc: C->getLParenLoc());
8378}
8379
8380void OMPClauseWriter::VisitOMPDependClause(OMPDependClause *C) {
8381 Record.push_back(N: C->varlist_size());
8382 Record.push_back(N: C->getNumLoops());
8383 Record.AddSourceLocation(Loc: C->getLParenLoc());
8384 Record.AddStmt(S: C->getModifier());
8385 Record.push_back(N: C->getDependencyKind());
8386 Record.AddSourceLocation(Loc: C->getDependencyLoc());
8387 Record.AddSourceLocation(Loc: C->getColonLoc());
8388 Record.AddSourceLocation(Loc: C->getOmpAllMemoryLoc());
8389 for (auto *VE : C->varlist())
8390 Record.AddStmt(S: VE);
8391 for (unsigned I = 0, E = C->getNumLoops(); I < E; ++I)
8392 Record.AddStmt(S: C->getLoopData(NumLoop: I));
8393}
8394
8395void OMPClauseWriter::VisitOMPDeviceClause(OMPDeviceClause *C) {
8396 VisitOMPClauseWithPreInit(C);
8397 Record.writeEnum(value: C->getModifier());
8398 Record.AddStmt(S: C->getDevice());
8399 Record.AddSourceLocation(Loc: C->getModifierLoc());
8400 Record.AddSourceLocation(Loc: C->getLParenLoc());
8401}
8402
8403void OMPClauseWriter::VisitOMPMapClause(OMPMapClause *C) {
8404 Record.push_back(N: C->varlist_size());
8405 Record.push_back(N: C->getUniqueDeclarationsNum());
8406 Record.push_back(N: C->getTotalComponentListNum());
8407 Record.push_back(N: C->getTotalComponentsNum());
8408 Record.AddSourceLocation(Loc: C->getLParenLoc());
8409 bool HasIteratorModifier = false;
8410 for (unsigned I = 0; I < NumberOfOMPMapClauseModifiers; ++I) {
8411 Record.push_back(N: C->getMapTypeModifier(Cnt: I));
8412 Record.AddSourceLocation(Loc: C->getMapTypeModifierLoc(Cnt: I));
8413 if (C->getMapTypeModifier(Cnt: I) == OMPC_MAP_MODIFIER_iterator)
8414 HasIteratorModifier = true;
8415 }
8416 Record.AddNestedNameSpecifierLoc(QualifierLoc: C->getMapperQualifierLoc());
8417 Record.AddDeclarationNameInfo(NameInfo: C->getMapperIdInfo());
8418 Record.push_back(N: C->getMapType());
8419 Record.AddSourceLocation(Loc: C->getMapLoc());
8420 Record.AddSourceLocation(Loc: C->getColonLoc());
8421 for (auto *E : C->varlist())
8422 Record.AddStmt(S: E);
8423 for (auto *E : C->mapperlists())
8424 Record.AddStmt(S: E);
8425 if (HasIteratorModifier)
8426 Record.AddStmt(S: C->getIteratorModifier());
8427 for (auto *D : C->all_decls())
8428 Record.AddDeclRef(D);
8429 for (auto N : C->all_num_lists())
8430 Record.push_back(N);
8431 for (auto N : C->all_lists_sizes())
8432 Record.push_back(N);
8433 for (auto &M : C->all_components()) {
8434 Record.AddStmt(S: M.getAssociatedExpression());
8435 Record.AddDeclRef(D: M.getAssociatedDeclaration());
8436 }
8437}
8438
8439void OMPClauseWriter::VisitOMPAllocateClause(OMPAllocateClause *C) {
8440 Record.push_back(N: C->varlist_size());
8441 Record.writeEnum(value: C->getFirstAllocateModifier());
8442 Record.writeEnum(value: C->getSecondAllocateModifier());
8443 Record.AddSourceLocation(Loc: C->getLParenLoc());
8444 Record.AddSourceLocation(Loc: C->getColonLoc());
8445 Record.AddStmt(S: C->getAllocator());
8446 Record.AddStmt(S: C->getAlignment());
8447 for (auto *VE : C->varlist())
8448 Record.AddStmt(S: VE);
8449}
8450
8451void OMPClauseWriter::VisitOMPNumTeamsClause(OMPNumTeamsClause *C) {
8452 Record.push_back(N: C->varlist_size());
8453 VisitOMPClauseWithPreInit(C);
8454 Record.AddSourceLocation(Loc: C->getLParenLoc());
8455 for (auto *VE : C->varlist())
8456 Record.AddStmt(S: VE);
8457}
8458
8459void OMPClauseWriter::VisitOMPThreadLimitClause(OMPThreadLimitClause *C) {
8460 Record.push_back(N: C->varlist_size());
8461 VisitOMPClauseWithPreInit(C);
8462 Record.AddSourceLocation(Loc: C->getLParenLoc());
8463 for (auto *VE : C->varlist())
8464 Record.AddStmt(S: VE);
8465}
8466
8467void OMPClauseWriter::VisitOMPPriorityClause(OMPPriorityClause *C) {
8468 VisitOMPClauseWithPreInit(C);
8469 Record.AddStmt(S: C->getPriority());
8470 Record.AddSourceLocation(Loc: C->getLParenLoc());
8471}
8472
8473void OMPClauseWriter::VisitOMPGrainsizeClause(OMPGrainsizeClause *C) {
8474 VisitOMPClauseWithPreInit(C);
8475 Record.writeEnum(value: C->getModifier());
8476 Record.AddStmt(S: C->getGrainsize());
8477 Record.AddSourceLocation(Loc: C->getModifierLoc());
8478 Record.AddSourceLocation(Loc: C->getLParenLoc());
8479}
8480
8481void OMPClauseWriter::VisitOMPNumTasksClause(OMPNumTasksClause *C) {
8482 VisitOMPClauseWithPreInit(C);
8483 Record.writeEnum(value: C->getModifier());
8484 Record.AddStmt(S: C->getNumTasks());
8485 Record.AddSourceLocation(Loc: C->getModifierLoc());
8486 Record.AddSourceLocation(Loc: C->getLParenLoc());
8487}
8488
8489void OMPClauseWriter::VisitOMPHintClause(OMPHintClause *C) {
8490 Record.AddStmt(S: C->getHint());
8491 Record.AddSourceLocation(Loc: C->getLParenLoc());
8492}
8493
8494void OMPClauseWriter::VisitOMPDistScheduleClause(OMPDistScheduleClause *C) {
8495 VisitOMPClauseWithPreInit(C);
8496 Record.push_back(N: C->getDistScheduleKind());
8497 Record.AddStmt(S: C->getChunkSize());
8498 Record.AddSourceLocation(Loc: C->getLParenLoc());
8499 Record.AddSourceLocation(Loc: C->getDistScheduleKindLoc());
8500 Record.AddSourceLocation(Loc: C->getCommaLoc());
8501}
8502
8503void OMPClauseWriter::VisitOMPDefaultmapClause(OMPDefaultmapClause *C) {
8504 Record.push_back(N: C->getDefaultmapKind());
8505 Record.push_back(N: C->getDefaultmapModifier());
8506 Record.AddSourceLocation(Loc: C->getLParenLoc());
8507 Record.AddSourceLocation(Loc: C->getDefaultmapModifierLoc());
8508 Record.AddSourceLocation(Loc: C->getDefaultmapKindLoc());
8509}
8510
8511void OMPClauseWriter::VisitOMPToClause(OMPToClause *C) {
8512 Record.push_back(N: C->varlist_size());
8513 Record.push_back(N: C->getUniqueDeclarationsNum());
8514 Record.push_back(N: C->getTotalComponentListNum());
8515 Record.push_back(N: C->getTotalComponentsNum());
8516 Record.AddSourceLocation(Loc: C->getLParenLoc());
8517 for (unsigned I = 0; I < NumberOfOMPMotionModifiers; ++I) {
8518 Record.push_back(N: C->getMotionModifier(Cnt: I));
8519 Record.AddSourceLocation(Loc: C->getMotionModifierLoc(Cnt: I));
8520 if (C->getMotionModifier(Cnt: I) == OMPC_MOTION_MODIFIER_iterator)
8521 Record.AddStmt(S: C->getIteratorModifier());
8522 }
8523 Record.AddNestedNameSpecifierLoc(QualifierLoc: C->getMapperQualifierLoc());
8524 Record.AddDeclarationNameInfo(NameInfo: C->getMapperIdInfo());
8525 Record.AddSourceLocation(Loc: C->getColonLoc());
8526 for (auto *E : C->varlist())
8527 Record.AddStmt(S: E);
8528 for (auto *E : C->mapperlists())
8529 Record.AddStmt(S: E);
8530 for (auto *D : C->all_decls())
8531 Record.AddDeclRef(D);
8532 for (auto N : C->all_num_lists())
8533 Record.push_back(N);
8534 for (auto N : C->all_lists_sizes())
8535 Record.push_back(N);
8536 for (auto &M : C->all_components()) {
8537 Record.AddStmt(S: M.getAssociatedExpression());
8538 Record.writeBool(Value: M.isNonContiguous());
8539 Record.AddDeclRef(D: M.getAssociatedDeclaration());
8540 }
8541}
8542
8543void OMPClauseWriter::VisitOMPFromClause(OMPFromClause *C) {
8544 Record.push_back(N: C->varlist_size());
8545 Record.push_back(N: C->getUniqueDeclarationsNum());
8546 Record.push_back(N: C->getTotalComponentListNum());
8547 Record.push_back(N: C->getTotalComponentsNum());
8548 Record.AddSourceLocation(Loc: C->getLParenLoc());
8549 for (unsigned I = 0; I < NumberOfOMPMotionModifiers; ++I) {
8550 Record.push_back(N: C->getMotionModifier(Cnt: I));
8551 Record.AddSourceLocation(Loc: C->getMotionModifierLoc(Cnt: I));
8552 if (C->getMotionModifier(Cnt: I) == OMPC_MOTION_MODIFIER_iterator)
8553 Record.AddStmt(S: C->getIteratorModifier());
8554 }
8555 Record.AddNestedNameSpecifierLoc(QualifierLoc: C->getMapperQualifierLoc());
8556 Record.AddDeclarationNameInfo(NameInfo: C->getMapperIdInfo());
8557 Record.AddSourceLocation(Loc: C->getColonLoc());
8558 for (auto *E : C->varlist())
8559 Record.AddStmt(S: E);
8560 for (auto *E : C->mapperlists())
8561 Record.AddStmt(S: E);
8562 for (auto *D : C->all_decls())
8563 Record.AddDeclRef(D);
8564 for (auto N : C->all_num_lists())
8565 Record.push_back(N);
8566 for (auto N : C->all_lists_sizes())
8567 Record.push_back(N);
8568 for (auto &M : C->all_components()) {
8569 Record.AddStmt(S: M.getAssociatedExpression());
8570 Record.writeBool(Value: M.isNonContiguous());
8571 Record.AddDeclRef(D: M.getAssociatedDeclaration());
8572 }
8573}
8574
8575void OMPClauseWriter::VisitOMPUseDevicePtrClause(OMPUseDevicePtrClause *C) {
8576 Record.push_back(N: C->varlist_size());
8577 Record.push_back(N: C->getUniqueDeclarationsNum());
8578 Record.push_back(N: C->getTotalComponentListNum());
8579 Record.push_back(N: C->getTotalComponentsNum());
8580 Record.AddSourceLocation(Loc: C->getLParenLoc());
8581 Record.writeEnum(value: C->getFallbackModifier());
8582 Record.AddSourceLocation(Loc: C->getFallbackModifierLoc());
8583 for (auto *E : C->varlist())
8584 Record.AddStmt(S: E);
8585 for (auto *VE : C->private_copies())
8586 Record.AddStmt(S: VE);
8587 for (auto *VE : C->inits())
8588 Record.AddStmt(S: VE);
8589 for (auto *D : C->all_decls())
8590 Record.AddDeclRef(D);
8591 for (auto N : C->all_num_lists())
8592 Record.push_back(N);
8593 for (auto N : C->all_lists_sizes())
8594 Record.push_back(N);
8595 for (auto &M : C->all_components()) {
8596 Record.AddStmt(S: M.getAssociatedExpression());
8597 Record.AddDeclRef(D: M.getAssociatedDeclaration());
8598 }
8599}
8600
8601void OMPClauseWriter::VisitOMPUseDeviceAddrClause(OMPUseDeviceAddrClause *C) {
8602 Record.push_back(N: C->varlist_size());
8603 Record.push_back(N: C->getUniqueDeclarationsNum());
8604 Record.push_back(N: C->getTotalComponentListNum());
8605 Record.push_back(N: C->getTotalComponentsNum());
8606 Record.AddSourceLocation(Loc: C->getLParenLoc());
8607 for (auto *E : C->varlist())
8608 Record.AddStmt(S: E);
8609 for (auto *D : C->all_decls())
8610 Record.AddDeclRef(D);
8611 for (auto N : C->all_num_lists())
8612 Record.push_back(N);
8613 for (auto N : C->all_lists_sizes())
8614 Record.push_back(N);
8615 for (auto &M : C->all_components()) {
8616 Record.AddStmt(S: M.getAssociatedExpression());
8617 Record.AddDeclRef(D: M.getAssociatedDeclaration());
8618 }
8619}
8620
8621void OMPClauseWriter::VisitOMPIsDevicePtrClause(OMPIsDevicePtrClause *C) {
8622 Record.push_back(N: C->varlist_size());
8623 Record.push_back(N: C->getUniqueDeclarationsNum());
8624 Record.push_back(N: C->getTotalComponentListNum());
8625 Record.push_back(N: C->getTotalComponentsNum());
8626 Record.AddSourceLocation(Loc: C->getLParenLoc());
8627 for (auto *E : C->varlist())
8628 Record.AddStmt(S: E);
8629 for (auto *D : C->all_decls())
8630 Record.AddDeclRef(D);
8631 for (auto N : C->all_num_lists())
8632 Record.push_back(N);
8633 for (auto N : C->all_lists_sizes())
8634 Record.push_back(N);
8635 for (auto &M : C->all_components()) {
8636 Record.AddStmt(S: M.getAssociatedExpression());
8637 Record.AddDeclRef(D: M.getAssociatedDeclaration());
8638 }
8639}
8640
8641void OMPClauseWriter::VisitOMPHasDeviceAddrClause(OMPHasDeviceAddrClause *C) {
8642 Record.push_back(N: C->varlist_size());
8643 Record.push_back(N: C->getUniqueDeclarationsNum());
8644 Record.push_back(N: C->getTotalComponentListNum());
8645 Record.push_back(N: C->getTotalComponentsNum());
8646 Record.AddSourceLocation(Loc: C->getLParenLoc());
8647 for (auto *E : C->varlist())
8648 Record.AddStmt(S: E);
8649 for (auto *D : C->all_decls())
8650 Record.AddDeclRef(D);
8651 for (auto N : C->all_num_lists())
8652 Record.push_back(N);
8653 for (auto N : C->all_lists_sizes())
8654 Record.push_back(N);
8655 for (auto &M : C->all_components()) {
8656 Record.AddStmt(S: M.getAssociatedExpression());
8657 Record.AddDeclRef(D: M.getAssociatedDeclaration());
8658 }
8659}
8660
8661void OMPClauseWriter::VisitOMPUnifiedAddressClause(OMPUnifiedAddressClause *) {}
8662
8663void OMPClauseWriter::VisitOMPUnifiedSharedMemoryClause(
8664 OMPUnifiedSharedMemoryClause *) {}
8665
8666void OMPClauseWriter::VisitOMPReverseOffloadClause(OMPReverseOffloadClause *) {}
8667
8668void
8669OMPClauseWriter::VisitOMPDynamicAllocatorsClause(OMPDynamicAllocatorsClause *) {
8670}
8671
8672void OMPClauseWriter::VisitOMPAtomicDefaultMemOrderClause(
8673 OMPAtomicDefaultMemOrderClause *C) {
8674 Record.push_back(N: C->getAtomicDefaultMemOrderKind());
8675 Record.AddSourceLocation(Loc: C->getLParenLoc());
8676 Record.AddSourceLocation(Loc: C->getAtomicDefaultMemOrderKindKwLoc());
8677}
8678
8679void OMPClauseWriter::VisitOMPSelfMapsClause(OMPSelfMapsClause *) {}
8680
8681void OMPClauseWriter::VisitOMPAtClause(OMPAtClause *C) {
8682 Record.push_back(N: C->getAtKind());
8683 Record.AddSourceLocation(Loc: C->getLParenLoc());
8684 Record.AddSourceLocation(Loc: C->getAtKindKwLoc());
8685}
8686
8687void OMPClauseWriter::VisitOMPSeverityClause(OMPSeverityClause *C) {
8688 Record.push_back(N: C->getSeverityKind());
8689 Record.AddSourceLocation(Loc: C->getLParenLoc());
8690 Record.AddSourceLocation(Loc: C->getSeverityKindKwLoc());
8691}
8692
8693void OMPClauseWriter::VisitOMPMessageClause(OMPMessageClause *C) {
8694 VisitOMPClauseWithPreInit(C);
8695 Record.AddStmt(S: C->getMessageString());
8696 Record.AddSourceLocation(Loc: C->getLParenLoc());
8697}
8698
8699void OMPClauseWriter::VisitOMPNontemporalClause(OMPNontemporalClause *C) {
8700 Record.push_back(N: C->varlist_size());
8701 Record.AddSourceLocation(Loc: C->getLParenLoc());
8702 for (auto *VE : C->varlist())
8703 Record.AddStmt(S: VE);
8704 for (auto *E : C->private_refs())
8705 Record.AddStmt(S: E);
8706}
8707
8708void OMPClauseWriter::VisitOMPInclusiveClause(OMPInclusiveClause *C) {
8709 Record.push_back(N: C->varlist_size());
8710 Record.AddSourceLocation(Loc: C->getLParenLoc());
8711 for (auto *VE : C->varlist())
8712 Record.AddStmt(S: VE);
8713}
8714
8715void OMPClauseWriter::VisitOMPExclusiveClause(OMPExclusiveClause *C) {
8716 Record.push_back(N: C->varlist_size());
8717 Record.AddSourceLocation(Loc: C->getLParenLoc());
8718 for (auto *VE : C->varlist())
8719 Record.AddStmt(S: VE);
8720}
8721
8722void OMPClauseWriter::VisitOMPOrderClause(OMPOrderClause *C) {
8723 Record.writeEnum(value: C->getKind());
8724 Record.writeEnum(value: C->getModifier());
8725 Record.AddSourceLocation(Loc: C->getLParenLoc());
8726 Record.AddSourceLocation(Loc: C->getKindKwLoc());
8727 Record.AddSourceLocation(Loc: C->getModifierKwLoc());
8728}
8729
8730void OMPClauseWriter::VisitOMPUsesAllocatorsClause(OMPUsesAllocatorsClause *C) {
8731 Record.push_back(N: C->getNumberOfAllocators());
8732 Record.AddSourceLocation(Loc: C->getLParenLoc());
8733 for (unsigned I = 0, E = C->getNumberOfAllocators(); I < E; ++I) {
8734 OMPUsesAllocatorsClause::Data Data = C->getAllocatorData(I);
8735 Record.AddStmt(S: Data.Allocator);
8736 Record.AddStmt(S: Data.AllocatorTraits);
8737 Record.AddSourceLocation(Loc: Data.LParenLoc);
8738 Record.AddSourceLocation(Loc: Data.RParenLoc);
8739 }
8740}
8741
8742void OMPClauseWriter::VisitOMPAffinityClause(OMPAffinityClause *C) {
8743 Record.push_back(N: C->varlist_size());
8744 Record.AddSourceLocation(Loc: C->getLParenLoc());
8745 Record.AddStmt(S: C->getModifier());
8746 Record.AddSourceLocation(Loc: C->getColonLoc());
8747 for (Expr *E : C->varlist())
8748 Record.AddStmt(S: E);
8749}
8750
8751void OMPClauseWriter::VisitOMPBindClause(OMPBindClause *C) {
8752 Record.writeEnum(value: C->getBindKind());
8753 Record.AddSourceLocation(Loc: C->getLParenLoc());
8754 Record.AddSourceLocation(Loc: C->getBindKindLoc());
8755}
8756
8757void OMPClauseWriter::VisitOMPXDynCGroupMemClause(OMPXDynCGroupMemClause *C) {
8758 VisitOMPClauseWithPreInit(C);
8759 Record.AddStmt(S: C->getSize());
8760 Record.AddSourceLocation(Loc: C->getLParenLoc());
8761}
8762
8763void OMPClauseWriter::VisitOMPDynGroupprivateClause(
8764 OMPDynGroupprivateClause *C) {
8765 VisitOMPClauseWithPreInit(C);
8766 Record.push_back(N: C->getDynGroupprivateModifier());
8767 Record.push_back(N: C->getDynGroupprivateFallbackModifier());
8768 Record.AddStmt(S: C->getSize());
8769 Record.AddSourceLocation(Loc: C->getLParenLoc());
8770 Record.AddSourceLocation(Loc: C->getDynGroupprivateModifierLoc());
8771 Record.AddSourceLocation(Loc: C->getDynGroupprivateFallbackModifierLoc());
8772}
8773
8774void OMPClauseWriter::VisitOMPDoacrossClause(OMPDoacrossClause *C) {
8775 Record.push_back(N: C->varlist_size());
8776 Record.push_back(N: C->getNumLoops());
8777 Record.AddSourceLocation(Loc: C->getLParenLoc());
8778 Record.push_back(N: C->getDependenceType());
8779 Record.AddSourceLocation(Loc: C->getDependenceLoc());
8780 Record.AddSourceLocation(Loc: C->getColonLoc());
8781 for (auto *VE : C->varlist())
8782 Record.AddStmt(S: VE);
8783 for (unsigned I = 0, E = C->getNumLoops(); I < E; ++I)
8784 Record.AddStmt(S: C->getLoopData(NumLoop: I));
8785}
8786
8787void OMPClauseWriter::VisitOMPXAttributeClause(OMPXAttributeClause *C) {
8788 Record.AddAttributes(Attrs: C->getAttrs());
8789 Record.AddSourceLocation(Loc: C->getBeginLoc());
8790 Record.AddSourceLocation(Loc: C->getLParenLoc());
8791 Record.AddSourceLocation(Loc: C->getEndLoc());
8792}
8793
8794void OMPClauseWriter::VisitOMPXBareClause(OMPXBareClause *C) {}
8795
8796void ASTRecordWriter::writeOMPTraitInfo(const OMPTraitInfo *TI) {
8797 writeUInt32(Value: TI->Sets.size());
8798 for (const auto &Set : TI->Sets) {
8799 writeEnum(value: Set.Kind);
8800 writeUInt32(Value: Set.Selectors.size());
8801 for (const auto &Selector : Set.Selectors) {
8802 writeEnum(value: Selector.Kind);
8803 writeBool(Value: Selector.ScoreOrCondition);
8804 if (Selector.ScoreOrCondition)
8805 writeExprRef(value: Selector.ScoreOrCondition);
8806 writeUInt32(Value: Selector.Properties.size());
8807 for (const auto &Property : Selector.Properties)
8808 writeEnum(value: Property.Kind);
8809 }
8810 }
8811}
8812
8813void ASTRecordWriter::writeOMPChildren(OMPChildren *Data) {
8814 if (!Data)
8815 return;
8816 writeUInt32(Value: Data->getNumClauses());
8817 writeUInt32(Value: Data->getNumChildren());
8818 writeBool(Value: Data->hasAssociatedStmt());
8819 for (unsigned I = 0, E = Data->getNumClauses(); I < E; ++I)
8820 writeOMPClause(C: Data->getClauses()[I]);
8821 if (Data->hasAssociatedStmt())
8822 AddStmt(S: Data->getAssociatedStmt());
8823 for (unsigned I = 0, E = Data->getNumChildren(); I < E; ++I)
8824 AddStmt(S: Data->getChildren()[I]);
8825}
8826
8827void ASTRecordWriter::writeOpenACCVarList(const OpenACCClauseWithVarList *C) {
8828 writeUInt32(Value: C->getVarList().size());
8829 for (Expr *E : C->getVarList())
8830 AddStmt(S: E);
8831}
8832
8833void ASTRecordWriter::writeOpenACCIntExprList(ArrayRef<Expr *> Exprs) {
8834 writeUInt32(Value: Exprs.size());
8835 for (Expr *E : Exprs)
8836 AddStmt(S: E);
8837}
8838
8839void ASTRecordWriter::writeOpenACCClause(const OpenACCClause *C) {
8840 writeEnum(value: C->getClauseKind());
8841 writeSourceLocation(Loc: C->getBeginLoc());
8842 writeSourceLocation(Loc: C->getEndLoc());
8843
8844 switch (C->getClauseKind()) {
8845 case OpenACCClauseKind::Default: {
8846 const auto *DC = cast<OpenACCDefaultClause>(Val: C);
8847 writeSourceLocation(Loc: DC->getLParenLoc());
8848 writeEnum(value: DC->getDefaultClauseKind());
8849 return;
8850 }
8851 case OpenACCClauseKind::If: {
8852 const auto *IC = cast<OpenACCIfClause>(Val: C);
8853 writeSourceLocation(Loc: IC->getLParenLoc());
8854 AddStmt(S: const_cast<Expr*>(IC->getConditionExpr()));
8855 return;
8856 }
8857 case OpenACCClauseKind::Self: {
8858 const auto *SC = cast<OpenACCSelfClause>(Val: C);
8859 writeSourceLocation(Loc: SC->getLParenLoc());
8860 writeBool(Value: SC->isConditionExprClause());
8861 if (SC->isConditionExprClause()) {
8862 writeBool(Value: SC->hasConditionExpr());
8863 if (SC->hasConditionExpr())
8864 AddStmt(S: const_cast<Expr *>(SC->getConditionExpr()));
8865 } else {
8866 writeUInt32(Value: SC->getVarList().size());
8867 for (Expr *E : SC->getVarList())
8868 AddStmt(S: E);
8869 }
8870 return;
8871 }
8872 case OpenACCClauseKind::NumGangs: {
8873 const auto *NGC = cast<OpenACCNumGangsClause>(Val: C);
8874 writeSourceLocation(Loc: NGC->getLParenLoc());
8875 writeUInt32(Value: NGC->getIntExprs().size());
8876 for (Expr *E : NGC->getIntExprs())
8877 AddStmt(S: E);
8878 return;
8879 }
8880 case OpenACCClauseKind::DeviceNum: {
8881 const auto *DNC = cast<OpenACCDeviceNumClause>(Val: C);
8882 writeSourceLocation(Loc: DNC->getLParenLoc());
8883 AddStmt(S: const_cast<Expr*>(DNC->getIntExpr()));
8884 return;
8885 }
8886 case OpenACCClauseKind::DefaultAsync: {
8887 const auto *DAC = cast<OpenACCDefaultAsyncClause>(Val: C);
8888 writeSourceLocation(Loc: DAC->getLParenLoc());
8889 AddStmt(S: const_cast<Expr *>(DAC->getIntExpr()));
8890 return;
8891 }
8892 case OpenACCClauseKind::NumWorkers: {
8893 const auto *NWC = cast<OpenACCNumWorkersClause>(Val: C);
8894 writeSourceLocation(Loc: NWC->getLParenLoc());
8895 AddStmt(S: const_cast<Expr*>(NWC->getIntExpr()));
8896 return;
8897 }
8898 case OpenACCClauseKind::VectorLength: {
8899 const auto *NWC = cast<OpenACCVectorLengthClause>(Val: C);
8900 writeSourceLocation(Loc: NWC->getLParenLoc());
8901 AddStmt(S: const_cast<Expr*>(NWC->getIntExpr()));
8902 return;
8903 }
8904 case OpenACCClauseKind::Private: {
8905 const auto *PC = cast<OpenACCPrivateClause>(Val: C);
8906 writeSourceLocation(Loc: PC->getLParenLoc());
8907 writeOpenACCVarList(C: PC);
8908
8909 for (const OpenACCPrivateRecipe &R : PC->getInitRecipes()) {
8910 static_assert(sizeof(R) == 1 * sizeof(int *));
8911 AddDeclRef(D: R.AllocaDecl);
8912 }
8913 return;
8914 }
8915 case OpenACCClauseKind::Host: {
8916 const auto *HC = cast<OpenACCHostClause>(Val: C);
8917 writeSourceLocation(Loc: HC->getLParenLoc());
8918 writeOpenACCVarList(C: HC);
8919 return;
8920 }
8921 case OpenACCClauseKind::Device: {
8922 const auto *DC = cast<OpenACCDeviceClause>(Val: C);
8923 writeSourceLocation(Loc: DC->getLParenLoc());
8924 writeOpenACCVarList(C: DC);
8925 return;
8926 }
8927 case OpenACCClauseKind::FirstPrivate: {
8928 const auto *FPC = cast<OpenACCFirstPrivateClause>(Val: C);
8929 writeSourceLocation(Loc: FPC->getLParenLoc());
8930 writeOpenACCVarList(C: FPC);
8931
8932 for (const OpenACCFirstPrivateRecipe &R : FPC->getInitRecipes()) {
8933 static_assert(sizeof(R) == 2 * sizeof(int *));
8934 AddDeclRef(D: R.AllocaDecl);
8935 AddDeclRef(D: R.InitFromTemporary);
8936 }
8937 return;
8938 }
8939 case OpenACCClauseKind::Attach: {
8940 const auto *AC = cast<OpenACCAttachClause>(Val: C);
8941 writeSourceLocation(Loc: AC->getLParenLoc());
8942 writeOpenACCVarList(C: AC);
8943 return;
8944 }
8945 case OpenACCClauseKind::Detach: {
8946 const auto *DC = cast<OpenACCDetachClause>(Val: C);
8947 writeSourceLocation(Loc: DC->getLParenLoc());
8948 writeOpenACCVarList(C: DC);
8949 return;
8950 }
8951 case OpenACCClauseKind::Delete: {
8952 const auto *DC = cast<OpenACCDeleteClause>(Val: C);
8953 writeSourceLocation(Loc: DC->getLParenLoc());
8954 writeOpenACCVarList(C: DC);
8955 return;
8956 }
8957 case OpenACCClauseKind::UseDevice: {
8958 const auto *UDC = cast<OpenACCUseDeviceClause>(Val: C);
8959 writeSourceLocation(Loc: UDC->getLParenLoc());
8960 writeOpenACCVarList(C: UDC);
8961 return;
8962 }
8963 case OpenACCClauseKind::DevicePtr: {
8964 const auto *DPC = cast<OpenACCDevicePtrClause>(Val: C);
8965 writeSourceLocation(Loc: DPC->getLParenLoc());
8966 writeOpenACCVarList(C: DPC);
8967 return;
8968 }
8969 case OpenACCClauseKind::NoCreate: {
8970 const auto *NCC = cast<OpenACCNoCreateClause>(Val: C);
8971 writeSourceLocation(Loc: NCC->getLParenLoc());
8972 writeOpenACCVarList(C: NCC);
8973 return;
8974 }
8975 case OpenACCClauseKind::Present: {
8976 const auto *PC = cast<OpenACCPresentClause>(Val: C);
8977 writeSourceLocation(Loc: PC->getLParenLoc());
8978 writeOpenACCVarList(C: PC);
8979 return;
8980 }
8981 case OpenACCClauseKind::Copy:
8982 case OpenACCClauseKind::PCopy:
8983 case OpenACCClauseKind::PresentOrCopy: {
8984 const auto *CC = cast<OpenACCCopyClause>(Val: C);
8985 writeSourceLocation(Loc: CC->getLParenLoc());
8986 writeEnum(value: CC->getModifierList());
8987 writeOpenACCVarList(C: CC);
8988 return;
8989 }
8990 case OpenACCClauseKind::CopyIn:
8991 case OpenACCClauseKind::PCopyIn:
8992 case OpenACCClauseKind::PresentOrCopyIn: {
8993 const auto *CIC = cast<OpenACCCopyInClause>(Val: C);
8994 writeSourceLocation(Loc: CIC->getLParenLoc());
8995 writeEnum(value: CIC->getModifierList());
8996 writeOpenACCVarList(C: CIC);
8997 return;
8998 }
8999 case OpenACCClauseKind::CopyOut:
9000 case OpenACCClauseKind::PCopyOut:
9001 case OpenACCClauseKind::PresentOrCopyOut: {
9002 const auto *COC = cast<OpenACCCopyOutClause>(Val: C);
9003 writeSourceLocation(Loc: COC->getLParenLoc());
9004 writeEnum(value: COC->getModifierList());
9005 writeOpenACCVarList(C: COC);
9006 return;
9007 }
9008 case OpenACCClauseKind::Create:
9009 case OpenACCClauseKind::PCreate:
9010 case OpenACCClauseKind::PresentOrCreate: {
9011 const auto *CC = cast<OpenACCCreateClause>(Val: C);
9012 writeSourceLocation(Loc: CC->getLParenLoc());
9013 writeEnum(value: CC->getModifierList());
9014 writeOpenACCVarList(C: CC);
9015 return;
9016 }
9017 case OpenACCClauseKind::Async: {
9018 const auto *AC = cast<OpenACCAsyncClause>(Val: C);
9019 writeSourceLocation(Loc: AC->getLParenLoc());
9020 writeBool(Value: AC->hasIntExpr());
9021 if (AC->hasIntExpr())
9022 AddStmt(S: const_cast<Expr*>(AC->getIntExpr()));
9023 return;
9024 }
9025 case OpenACCClauseKind::Wait: {
9026 const auto *WC = cast<OpenACCWaitClause>(Val: C);
9027 writeSourceLocation(Loc: WC->getLParenLoc());
9028 writeBool(Value: WC->getDevNumExpr());
9029 if (Expr *DNE = WC->getDevNumExpr())
9030 AddStmt(S: DNE);
9031 writeSourceLocation(Loc: WC->getQueuesLoc());
9032
9033 writeOpenACCIntExprList(Exprs: WC->getQueueIdExprs());
9034 return;
9035 }
9036 case OpenACCClauseKind::DeviceType:
9037 case OpenACCClauseKind::DType: {
9038 const auto *DTC = cast<OpenACCDeviceTypeClause>(Val: C);
9039 writeSourceLocation(Loc: DTC->getLParenLoc());
9040 writeUInt32(Value: DTC->getArchitectures().size());
9041 for (const DeviceTypeArgument &Arg : DTC->getArchitectures()) {
9042 writeBool(Value: Arg.getIdentifierInfo());
9043 if (Arg.getIdentifierInfo())
9044 AddIdentifierRef(II: Arg.getIdentifierInfo());
9045 writeSourceLocation(Loc: Arg.getLoc());
9046 }
9047 return;
9048 }
9049 case OpenACCClauseKind::Reduction: {
9050 const auto *RC = cast<OpenACCReductionClause>(Val: C);
9051 writeSourceLocation(Loc: RC->getLParenLoc());
9052 writeEnum(value: RC->getReductionOp());
9053 writeOpenACCVarList(C: RC);
9054
9055 for (const OpenACCReductionRecipe &R : RC->getRecipes()) {
9056 AddDeclRef(D: R.AllocaDecl);
9057
9058 static_assert(sizeof(OpenACCReductionRecipe::CombinerRecipe) ==
9059 3 * sizeof(int *));
9060 writeUInt32(Value: R.CombinerRecipes.size());
9061
9062 for (auto &CombinerRecipe : R.CombinerRecipes) {
9063 AddDeclRef(D: CombinerRecipe.LHS);
9064 AddDeclRef(D: CombinerRecipe.RHS);
9065 AddStmt(S: CombinerRecipe.Op);
9066 }
9067 }
9068 return;
9069 }
9070 case OpenACCClauseKind::Seq:
9071 case OpenACCClauseKind::Independent:
9072 case OpenACCClauseKind::NoHost:
9073 case OpenACCClauseKind::Auto:
9074 case OpenACCClauseKind::Finalize:
9075 case OpenACCClauseKind::IfPresent:
9076 // Nothing to do here, there is no additional information beyond the
9077 // begin/end loc and clause kind.
9078 return;
9079 case OpenACCClauseKind::Collapse: {
9080 const auto *CC = cast<OpenACCCollapseClause>(Val: C);
9081 writeSourceLocation(Loc: CC->getLParenLoc());
9082 writeBool(Value: CC->hasForce());
9083 AddStmt(S: const_cast<Expr *>(CC->getLoopCount()));
9084 return;
9085 }
9086 case OpenACCClauseKind::Tile: {
9087 const auto *TC = cast<OpenACCTileClause>(Val: C);
9088 writeSourceLocation(Loc: TC->getLParenLoc());
9089 writeUInt32(Value: TC->getSizeExprs().size());
9090 for (Expr *E : TC->getSizeExprs())
9091 AddStmt(S: E);
9092 return;
9093 }
9094 case OpenACCClauseKind::Gang: {
9095 const auto *GC = cast<OpenACCGangClause>(Val: C);
9096 writeSourceLocation(Loc: GC->getLParenLoc());
9097 writeUInt32(Value: GC->getNumExprs());
9098 for (unsigned I = 0; I < GC->getNumExprs(); ++I) {
9099 writeEnum(value: GC->getExpr(I).first);
9100 AddStmt(S: const_cast<Expr *>(GC->getExpr(I).second));
9101 }
9102 return;
9103 }
9104 case OpenACCClauseKind::Worker: {
9105 const auto *WC = cast<OpenACCWorkerClause>(Val: C);
9106 writeSourceLocation(Loc: WC->getLParenLoc());
9107 writeBool(Value: WC->hasIntExpr());
9108 if (WC->hasIntExpr())
9109 AddStmt(S: const_cast<Expr *>(WC->getIntExpr()));
9110 return;
9111 }
9112 case OpenACCClauseKind::Vector: {
9113 const auto *VC = cast<OpenACCVectorClause>(Val: C);
9114 writeSourceLocation(Loc: VC->getLParenLoc());
9115 writeBool(Value: VC->hasIntExpr());
9116 if (VC->hasIntExpr())
9117 AddStmt(S: const_cast<Expr *>(VC->getIntExpr()));
9118 return;
9119 }
9120 case OpenACCClauseKind::Link: {
9121 const auto *LC = cast<OpenACCLinkClause>(Val: C);
9122 writeSourceLocation(Loc: LC->getLParenLoc());
9123 writeOpenACCVarList(C: LC);
9124 return;
9125 }
9126 case OpenACCClauseKind::DeviceResident: {
9127 const auto *DRC = cast<OpenACCDeviceResidentClause>(Val: C);
9128 writeSourceLocation(Loc: DRC->getLParenLoc());
9129 writeOpenACCVarList(C: DRC);
9130 return;
9131 }
9132
9133 case OpenACCClauseKind::Bind: {
9134 const auto *BC = cast<OpenACCBindClause>(Val: C);
9135 writeSourceLocation(Loc: BC->getLParenLoc());
9136 writeBool(Value: BC->isStringArgument());
9137 if (BC->isStringArgument())
9138 AddStmt(S: const_cast<StringLiteral *>(BC->getStringArgument()));
9139 else
9140 AddIdentifierRef(II: BC->getIdentifierArgument());
9141
9142 return;
9143 }
9144 case OpenACCClauseKind::Invalid:
9145 case OpenACCClauseKind::Shortloop:
9146 llvm_unreachable("Clause serialization not yet implemented");
9147 }
9148 llvm_unreachable("Invalid Clause Kind");
9149}
9150
9151void ASTRecordWriter::writeOpenACCClauseList(
9152 ArrayRef<const OpenACCClause *> Clauses) {
9153 for (const OpenACCClause *Clause : Clauses)
9154 writeOpenACCClause(C: Clause);
9155}
9156void ASTRecordWriter::AddOpenACCRoutineDeclAttr(
9157 const OpenACCRoutineDeclAttr *A) {
9158 // We have to write the size so that the reader can do a resize. Unlike the
9159 // Decl version of this, we can't count on trailing storage to get this right.
9160 writeUInt32(Value: A->Clauses.size());
9161 writeOpenACCClauseList(Clauses: A->Clauses);
9162}
9163