clang 23.0.0git
ASTWriter.cpp
Go to the documentation of this file.
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"
20#include "clang/AST/Attr.h"
21#include "clang/AST/Decl.h"
22#include "clang/AST/DeclBase.h"
23#include "clang/AST/DeclCXX.h"
26#include "clang/AST/DeclObjC.h"
29#include "clang/AST/Expr.h"
30#include "clang/AST/ExprCXX.h"
37#include "clang/AST/Type.h"
38#include "clang/AST/TypeLoc.h"
46#include "clang/Basic/LLVM.h"
47#include "clang/Basic/Lambda.h"
49#include "clang/Basic/Module.h"
59#include "clang/Basic/Version.h"
62#include "clang/Lex/MacroInfo.h"
63#include "clang/Lex/ModuleMap.h"
67#include "clang/Lex/Token.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"
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(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
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()
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(LHS, 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({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(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(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(Mod); UniqF.isValid())
222 AssignMostImportant(ModuleMaps[UniqF], Reason);
223
224 for (auto *SubM : Mod->submodules())
225 Q.push(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(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(M);
246 }
247
248 // Handle textually-included headers that belong to other modules.
249
251 HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
252
253 if (FilesByUID.size() > HS.header_file_size())
254 FilesByUID.resize(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
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.
267 continue; // Non-modular header not included locally is not affecting.
268
269 for (const auto &KH : HS.findResolvedModulesForHeader(*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(FID);
297 if (auto *FE = SM.getFileEntryForID(FID))
298 ModuleFileEntries.insert(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;
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) {
318 Qualifiers Qs = T.getLocalQualifiers();
319 BasicWriter.writeQualType(T.getLocalUnqualifiedType());
320 BasicWriter.writeQualifiers(Qs);
321 return BasicWriter.Emit(TYPE_EXT_QUAL, Writer.getTypeExtQualAbbrev());
322 }
323
324 const Type *typePtr = T.getTypePtr();
325 serialization::AbstractTypeWriter<ASTRecordWriter> atw(BasicWriter);
326 atw.write(typePtr);
327 return BasicWriter.Emit(getTypeCodeForTypeClass(typePtr->getTypeClass()),
328 /*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(TL.getBuiltinLoc());
359 if (TL.needsExtraLocalData()) {
360 Record.push_back(TL.getWrittenTypeSpec());
361 Record.push_back(static_cast<uint64_t>(TL.getWrittenSignSpec()));
362 Record.push_back(static_cast<uint64_t>(TL.getWrittenWidthSpec()));
363 Record.push_back(TL.hasModeAttr());
364 }
365}
366
367void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
368 addSourceLocation(TL.getNameLoc());
369}
370
371void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) {
372 addSourceLocation(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(TL.getCaretLoc());
389}
390
391void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
392 addSourceLocation(TL.getAmpLoc());
393}
394
395void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
396 addSourceLocation(TL.getAmpAmpLoc());
397}
398
399void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
400 addSourceLocation(TL.getStarLoc());
401 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
402}
403
404void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) {
405 addSourceLocation(TL.getLBracketLoc());
406 addSourceLocation(TL.getRBracketLoc());
407 Record.push_back(TL.getSizeExpr() ? 1 : 0);
408 if (TL.getSizeExpr())
409 Record.AddStmt(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(TL.getAttrNameLoc());
432 SourceRange range = TL.getAttrOperandParensRange();
433 addSourceLocation(range.getBegin());
434 addSourceLocation(range.getEnd());
435 Record.AddStmt(TL.getAttrExprOperand());
436}
437
438void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc(
439 DependentSizedExtVectorTypeLoc TL) {
440 addSourceLocation(TL.getNameLoc());
441}
442
443void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) {
444 addSourceLocation(TL.getNameLoc());
445}
446
447void TypeLocWriter::VisitDependentVectorTypeLoc(
448 DependentVectorTypeLoc TL) {
449 addSourceLocation(TL.getNameLoc());
450}
451
452void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
453 addSourceLocation(TL.getNameLoc());
454}
455
456void TypeLocWriter::VisitConstantMatrixTypeLoc(ConstantMatrixTypeLoc TL) {
457 addSourceLocation(TL.getAttrNameLoc());
458 SourceRange range = TL.getAttrOperandParensRange();
459 addSourceLocation(range.getBegin());
460 addSourceLocation(range.getEnd());
461 Record.AddStmt(TL.getAttrRowOperand());
462 Record.AddStmt(TL.getAttrColumnOperand());
463}
464
465void TypeLocWriter::VisitDependentSizedMatrixTypeLoc(
466 DependentSizedMatrixTypeLoc TL) {
467 addSourceLocation(TL.getAttrNameLoc());
468 SourceRange range = TL.getAttrOperandParensRange();
469 addSourceLocation(range.getBegin());
470 addSourceLocation(range.getEnd());
471 Record.AddStmt(TL.getAttrRowOperand());
472 Record.AddStmt(TL.getAttrColumnOperand());
473}
474
475void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
476 addSourceLocation(TL.getLocalRangeBegin());
477 addSourceLocation(TL.getLParenLoc());
478 addSourceLocation(TL.getRParenLoc());
479 addSourceRange(TL.getExceptionSpecRange());
480 addSourceLocation(TL.getLocalRangeEnd());
481 for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i)
482 Record.AddDeclRef(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(TL.getElaboratedKeywordLoc());
495 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
496 addSourceLocation(TL.getNameLoc());
497}
498
499void TypeLocWriter::VisitUsingTypeLoc(UsingTypeLoc TL) {
500 addSourceLocation(TL.getElaboratedKeywordLoc());
501 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
502 addSourceLocation(TL.getNameLoc());
503}
504
505void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
506 addSourceLocation(TL.getElaboratedKeywordLoc());
507 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
508 addSourceLocation(TL.getNameLoc());
509}
510
511void TypeLocWriter::VisitObjCTypeParamTypeLoc(ObjCTypeParamTypeLoc TL) {
512 if (TL.getNumProtocols()) {
513 addSourceLocation(TL.getProtocolLAngleLoc());
514 addSourceLocation(TL.getProtocolRAngleLoc());
515 }
516 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
517 addSourceLocation(TL.getProtocolLoc(i));
518}
519
520void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
521 addSourceLocation(TL.getTypeofLoc());
522 addSourceLocation(TL.getLParenLoc());
523 addSourceLocation(TL.getRParenLoc());
524}
525
526void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
527 addSourceLocation(TL.getTypeofLoc());
528 addSourceLocation(TL.getLParenLoc());
529 addSourceLocation(TL.getRParenLoc());
530 Record.AddTypeSourceInfo(TL.getUnmodifiedTInfo());
531}
532
533void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
534 addSourceLocation(TL.getDecltypeLoc());
535 addSourceLocation(TL.getRParenLoc());
536}
537
538void TypeLocWriter::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
539 addSourceLocation(TL.getKWLoc());
540 addSourceLocation(TL.getLParenLoc());
541 addSourceLocation(TL.getRParenLoc());
542 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
543}
544
556
557void TypeLocWriter::VisitPackIndexingTypeLoc(PackIndexingTypeLoc TL) {
558 addSourceLocation(TL.getEllipsisLoc());
559}
560
561void TypeLocWriter::VisitAutoTypeLoc(AutoTypeLoc TL) {
562 addSourceLocation(TL.getNameLoc());
563 auto *CR = TL.getConceptReference();
564 Record.push_back(TL.isConstrained() && CR);
565 if (TL.isConstrained() && CR)
566 Record.AddConceptReference(CR);
567 Record.push_back(TL.isDecltypeAuto());
568 if (TL.isDecltypeAuto())
569 addSourceLocation(TL.getRParenLoc());
570}
571
572void TypeLocWriter::VisitDeducedTemplateSpecializationTypeLoc(
573 DeducedTemplateSpecializationTypeLoc TL) {
574 addSourceLocation(TL.getElaboratedKeywordLoc());
575 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
576 addSourceLocation(TL.getTemplateNameLoc());
577}
578
579void TypeLocWriter::VisitTagTypeLoc(TagTypeLoc TL) {
580 addSourceLocation(TL.getElaboratedKeywordLoc());
581 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
582 addSourceLocation(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(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(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(TL.getNameLoc());
622}
623
624void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
625 SubstTemplateTypeParmTypeLoc TL) {
626 addSourceLocation(TL.getNameLoc());
627}
628
629void TypeLocWriter::VisitSubstTemplateTypeParmPackTypeLoc(
630 SubstTemplateTypeParmPackTypeLoc TL) {
631 addSourceLocation(TL.getNameLoc());
632}
633
634void TypeLocWriter::VisitSubstBuiltinTemplatePackTypeLoc(
635 SubstBuiltinTemplatePackTypeLoc TL) {
636 addSourceLocation(TL.getNameLoc());
637}
638
639void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
640 TemplateSpecializationTypeLoc TL) {
641 addSourceLocation(TL.getElaboratedKeywordLoc());
642 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
643 addSourceLocation(TL.getTemplateKeywordLoc());
644 addSourceLocation(TL.getTemplateNameLoc());
645 addSourceLocation(TL.getLAngleLoc());
646 addSourceLocation(TL.getRAngleLoc());
647 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
648 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(i));
649}
650
651void TypeLocWriter::VisitParenTypeLoc(ParenTypeLoc TL) {
652 addSourceLocation(TL.getLParenLoc());
653 addSourceLocation(TL.getRParenLoc());
654}
655
656void TypeLocWriter::VisitMacroQualifiedTypeLoc(MacroQualifiedTypeLoc TL) {
657 addSourceLocation(TL.getExpansionLoc());
658}
659
660void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
661 addSourceLocation(TL.getElaboratedKeywordLoc());
662 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
663 addSourceLocation(TL.getNameLoc());
664}
665
666void TypeLocWriter::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
667 addSourceLocation(TL.getEllipsisLoc());
668}
669
670void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
671 addSourceLocation(TL.getNameLoc());
672 addSourceLocation(TL.getNameEndLoc());
673}
674
675void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
676 Record.push_back(TL.hasBaseTypeAsWritten());
677 addSourceLocation(TL.getTypeArgsLAngleLoc());
678 addSourceLocation(TL.getTypeArgsRAngleLoc());
679 for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
680 Record.AddTypeSourceInfo(TL.getTypeArgTInfo(i));
681 addSourceLocation(TL.getProtocolLAngleLoc());
682 addSourceLocation(TL.getProtocolRAngleLoc());
683 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
684 addSourceLocation(TL.getProtocolLoc(i));
685}
686
687void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
688 addSourceLocation(TL.getStarLoc());
689}
690
691void TypeLocWriter::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
692 addSourceLocation(TL.getKWLoc());
693 addSourceLocation(TL.getLParenLoc());
694 addSourceLocation(TL.getRParenLoc());
695}
696
697void TypeLocWriter::VisitPipeTypeLoc(PipeTypeLoc TL) {
698 addSourceLocation(TL.getKWLoc());
699}
700void TypeLocWriter::VisitBitIntTypeLoc(clang::BitIntTypeLoc TL) {
701 addSourceLocation(TL.getNameLoc());
702}
703void TypeLocWriter::VisitDependentBitIntTypeLoc(
704 clang::DependentBitIntTypeLoc TL) {
705 addSourceLocation(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(BitCodeAbbrevOp(serialization::TYPE_EXT_QUAL));
721 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
722 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 3)); // Quals
723 TypeExtQualAbbrev = Stream.EmitAbbrev(std::move(Abv));
724}
725
726//===----------------------------------------------------------------------===//
727// ASTWriter Implementation
728//===----------------------------------------------------------------------===//
729
730static void EmitBlockID(unsigned ID, const char *Name,
731 llvm::BitstreamWriter &Stream,
733 Record.clear();
734 Record.push_back(ID);
735 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, 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(*Name++);
743 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record);
744}
745
746static void EmitRecordID(unsigned ID, const char *Name,
747 llvm::BitstreamWriter &Stream,
749 Record.clear();
750 Record.push_back(ID);
751 while (*Name)
752 Record.push_back(*Name++);
753 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
754}
755
756static void AddStmtsExprs(llvm::BitstreamWriter &Stream,
758#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
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);
903 RECORD(IMPORT);
907
908 BLOCK(OPTIONS_BLOCK);
915
916 BLOCK(INPUT_FILES_BLOCK);
919
920 // AST Top-Level Block.
921 BLOCK(AST_BLOCK);
981
982 // SourceManager Block.
983 BLOCK(SOURCE_MANAGER_BLOCK);
989
990 // Preprocessor Block.
991 BLOCK(PREPROCESSOR_BLOCK);
997
998 // Submodule Block.
999 BLOCK(SUBMODULE_BLOCK);
1019
1020 // Comments Block.
1021 BLOCK(COMMENTS_BLOCK);
1023
1024 // Decls and Types block.
1025 BLOCK(DECLTYPES_BLOCK);
1027 RECORD(TYPE_COMPLEX);
1028 RECORD(TYPE_POINTER);
1029 RECORD(TYPE_BLOCK_POINTER);
1030 RECORD(TYPE_LVALUE_REFERENCE);
1031 RECORD(TYPE_RVALUE_REFERENCE);
1032 RECORD(TYPE_MEMBER_POINTER);
1033 RECORD(TYPE_CONSTANT_ARRAY);
1034 RECORD(TYPE_INCOMPLETE_ARRAY);
1035 RECORD(TYPE_VARIABLE_ARRAY);
1036 RECORD(TYPE_VECTOR);
1037 RECORD(TYPE_EXT_VECTOR);
1038 RECORD(TYPE_FUNCTION_NO_PROTO);
1039 RECORD(TYPE_FUNCTION_PROTO);
1040 RECORD(TYPE_TYPEDEF);
1041 RECORD(TYPE_TYPEOF_EXPR);
1042 RECORD(TYPE_TYPEOF);
1043 RECORD(TYPE_RECORD);
1044 RECORD(TYPE_ENUM);
1045 RECORD(TYPE_OBJC_INTERFACE);
1046 RECORD(TYPE_OBJC_OBJECT_POINTER);
1047 RECORD(TYPE_DECLTYPE);
1048 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
1049 RECORD(TYPE_UNRESOLVED_USING);
1050 RECORD(TYPE_INJECTED_CLASS_NAME);
1051 RECORD(TYPE_OBJC_OBJECT);
1052 RECORD(TYPE_TEMPLATE_TYPE_PARM);
1053 RECORD(TYPE_TEMPLATE_SPECIALIZATION);
1054 RECORD(TYPE_DEPENDENT_NAME);
1055 RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
1056 RECORD(TYPE_PAREN);
1057 RECORD(TYPE_MACRO_QUALIFIED);
1058 RECORD(TYPE_PACK_EXPANSION);
1059 RECORD(TYPE_ATTRIBUTED);
1060 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
1061 RECORD(TYPE_SUBST_BUILTIN_TEMPLATE_PACK);
1062 RECORD(TYPE_AUTO);
1063 RECORD(TYPE_UNARY_TRANSFORM);
1064 RECORD(TYPE_ATOMIC);
1065 RECORD(TYPE_DECAYED);
1066 RECORD(TYPE_ADJUSTED);
1067 RECORD(TYPE_OBJC_TYPE_PARAM);
1144
1145 // Statements and Exprs can occur in the Decls and Types block.
1146 AddStmtsExprs(Stream, Record);
1147
1148 BLOCK(PREPROCESSOR_DETAIL_BLOCK);
1152
1153 // Decls and Types block.
1154 BLOCK(EXTENSION_BLOCK);
1156
1157 BLOCK(UNHASHED_CONTROL_BLOCK);
1165
1166#undef RECORD
1167#undef BLOCK
1168 Stream.ExitBlock();
1169}
1170
1171/// Adjusts the given filename to only write out the portion of the
1172/// filename that is not part of the system root directory.
1173///
1174/// \param Filename the file name to adjust.
1175///
1176/// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
1177/// the returned filename will be adjusted by this root directory.
1178///
1179/// \returns either the original filename (if it needs no adjustment) or the
1180/// adjusted filename (which points into the @p Filename parameter).
1181static const char *
1182adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
1183 assert(Filename && "No file name to adjust?");
1184
1185 if (BaseDir.empty())
1186 return Filename;
1187
1188 // Verify that the filename and the system root have the same prefix.
1189 unsigned Pos = 0;
1190 for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1191 if (Filename[Pos] != BaseDir[Pos])
1192 return Filename; // Prefixes don't match.
1193
1194 // We hit the end of the filename before we hit the end of the system root.
1195 if (!Filename[Pos])
1196 return Filename;
1197
1198 // If there's not a path separator at the end of the base directory nor
1199 // immediately after it, then this isn't within the base directory.
1200 if (!llvm::sys::path::is_separator(Filename[Pos])) {
1201 if (!llvm::sys::path::is_separator(BaseDir.back()))
1202 return Filename;
1203 } else {
1204 // If the file name has a '/' at the current position, skip over the '/'.
1205 // We distinguish relative paths from absolute paths by the
1206 // absence of '/' at the beginning of relative paths.
1207 //
1208 // FIXME: This is wrong. We distinguish them by asking if the path is
1209 // absolute, which isn't the same thing. And there might be multiple '/'s
1210 // in a row. Use a better mechanism to indicate whether we have emitted an
1211 // absolute or relative path.
1212 ++Pos;
1213 }
1214
1215 return Filename + Pos;
1216}
1217
1218std::pair<ASTFileSignature, ASTFileSignature>
1219ASTWriter::createSignature() const {
1220 StringRef AllBytes(Buffer.data(), Buffer.size());
1221
1222 llvm::SHA1 Hasher;
1223 Hasher.update(AllBytes.slice(ASTBlockRange.first, ASTBlockRange.second));
1224 ASTFileSignature ASTBlockHash = ASTFileSignature::create(Hasher.result());
1225
1226 // Add the remaining bytes:
1227 // 1. Before the unhashed control block.
1228 Hasher.update(AllBytes.slice(0, UnhashedControlBlockRange.first));
1229 // 2. Between the unhashed control block and the AST block.
1230 Hasher.update(
1231 AllBytes.slice(UnhashedControlBlockRange.second, ASTBlockRange.first));
1232 // 3. After the AST block.
1233 Hasher.update(AllBytes.substr(ASTBlockRange.second));
1234 ASTFileSignature Signature = ASTFileSignature::create(Hasher.result());
1235
1236 return std::make_pair(ASTBlockHash, Signature);
1237}
1238
1239ASTFileSignature ASTWriter::createSignatureForNamedModule() const {
1240 llvm::SHA1 Hasher;
1241 Hasher.update(StringRef(Buffer.data(), Buffer.size()));
1242
1243 assert(WritingModule);
1244 assert(WritingModule->isNamedModule());
1245
1246 // We need to combine all the export imported modules no matter
1247 // we used it or not.
1248 for (auto [ExportImported, _] : WritingModule->Exports)
1249 Hasher.update(ExportImported->Signature);
1250
1251 // We combine all the used modules to make sure the signature is precise.
1252 // Consider the case like:
1253 //
1254 // // a.cppm
1255 // export module a;
1256 // export inline int a() { ... }
1257 //
1258 // // b.cppm
1259 // export module b;
1260 // import a;
1261 // export inline int b() { return a(); }
1262 //
1263 // Since both `a()` and `b()` are inline, we need to make sure the BMI of
1264 // `b.pcm` will change after the implementation of `a()` changes. We can't
1265 // get that naturally since we won't record the body of `a()` during the
1266 // writing process. We can't reuse ODRHash here since ODRHash won't calculate
1267 // the called function recursively. So ODRHash will be problematic if `a()`
1268 // calls other inline functions.
1269 //
1270 // Probably we can solve this by a new hash mechanism. But the safety and
1271 // efficiency may a problem too. Here we just combine the hash value of the
1272 // used modules conservatively.
1273 for (Module *M : TouchedTopLevelModules)
1274 Hasher.update(M->Signature);
1275
1276 return ASTFileSignature::create(Hasher.result());
1277}
1278
1279static void BackpatchSignatureAt(llvm::BitstreamWriter &Stream,
1280 const ASTFileSignature &S, uint64_t BitNo) {
1281 for (uint8_t Byte : S) {
1282 Stream.BackpatchByte(BitNo, Byte);
1283 BitNo += 8;
1284 }
1285}
1286
1287ASTFileSignature ASTWriter::backpatchSignature() {
1288 if (isWritingStdCXXNamedModules()) {
1289 ASTFileSignature Signature = createSignatureForNamedModule();
1290 BackpatchSignatureAt(Stream, Signature, SignatureOffset);
1291 return Signature;
1292 }
1293
1294 if (!WritingModule ||
1296 return {};
1297
1298 // For implicit modules, write the hash of the PCM as its signature.
1299 ASTFileSignature ASTBlockHash;
1300 ASTFileSignature Signature;
1301 std::tie(ASTBlockHash, Signature) = createSignature();
1302
1303 BackpatchSignatureAt(Stream, ASTBlockHash, ASTBlockHashOffset);
1304 BackpatchSignatureAt(Stream, Signature, SignatureOffset);
1305
1306 return Signature;
1307}
1308
1309void ASTWriter::writeUnhashedControlBlock(Preprocessor &PP) {
1310 using namespace llvm;
1311
1312 // Flush first to prepare the PCM hash (signature).
1313 Stream.FlushToWord();
1314 UnhashedControlBlockRange.first = Stream.GetCurrentBitNo() >> 3;
1315
1316 // Enter the block and prepare to write records.
1317 RecordData Record;
1318 Stream.EnterSubblock(UNHASHED_CONTROL_BLOCK_ID, 5);
1319
1320 // For implicit modules and C++20 named modules, write the hash of the PCM as
1321 // its signature.
1322 if (isWritingStdCXXNamedModules() ||
1323 (WritingModule &&
1325 // At this point, we don't know the actual signature of the file or the AST
1326 // block - we're only able to compute those at the end of the serialization
1327 // process. Let's store dummy signatures for now, and replace them with the
1328 // real ones later on.
1329 // The bitstream VBR-encodes record elements, which makes backpatching them
1330 // really difficult. Let's store the signatures as blobs instead - they are
1331 // guaranteed to be word-aligned, and we control their format/encoding.
1332 auto Dummy = ASTFileSignature::createDummy();
1333 SmallString<128> Blob{Dummy.begin(), Dummy.end()};
1334
1335 // We don't need AST Block hash in named modules.
1336 if (!isWritingStdCXXNamedModules()) {
1337 auto Abbrev = std::make_shared<BitCodeAbbrev>();
1338 Abbrev->Add(BitCodeAbbrevOp(AST_BLOCK_HASH));
1339 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1340 unsigned ASTBlockHashAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
1341
1342 Record.push_back(AST_BLOCK_HASH);
1343 Stream.EmitRecordWithBlob(ASTBlockHashAbbrev, Record, Blob);
1344 ASTBlockHashOffset = Stream.GetCurrentBitNo() - Blob.size() * 8;
1345 Record.clear();
1346 }
1347
1348 auto Abbrev = std::make_shared<BitCodeAbbrev>();
1349 Abbrev->Add(BitCodeAbbrevOp(SIGNATURE));
1350 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1351 unsigned SignatureAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
1352
1353 Record.push_back(SIGNATURE);
1354 Stream.EmitRecordWithBlob(SignatureAbbrev, Record, Blob);
1355 SignatureOffset = Stream.GetCurrentBitNo() - Blob.size() * 8;
1356 Record.clear();
1357 }
1358
1359 const auto &HSOpts = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1360
1361 // Diagnostic options.
1362 const auto &Diags = PP.getDiagnostics();
1363 const DiagnosticOptions &DiagOpts = Diags.getDiagnosticOptions();
1364 if (!HSOpts.ModulesSkipDiagnosticOptions) {
1365#define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1366#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
1367 Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1368#include "clang/Basic/DiagnosticOptions.def"
1369 Record.push_back(DiagOpts.Warnings.size());
1370 for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1371 AddString(DiagOpts.Warnings[I], Record);
1372 Record.push_back(DiagOpts.Remarks.size());
1373 for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1374 AddString(DiagOpts.Remarks[I], Record);
1375 // Note: we don't serialize the log or serialization file names, because
1376 // they are generally transient files and will almost always be overridden.
1377 Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record);
1378 Record.clear();
1379 }
1380
1381 // Header search paths.
1382 if (!HSOpts.ModulesSkipHeaderSearchPaths) {
1383 // Include entries.
1384 Record.push_back(HSOpts.UserEntries.size());
1385 for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1386 const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1387 AddString(Entry.Path, Record);
1388 Record.push_back(static_cast<unsigned>(Entry.Group));
1389 Record.push_back(Entry.IsFramework);
1390 Record.push_back(Entry.IgnoreSysRoot);
1391 }
1392
1393 // System header prefixes.
1394 Record.push_back(HSOpts.SystemHeaderPrefixes.size());
1395 for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1396 AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1397 Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1398 }
1399
1400 // VFS overlay files.
1401 Record.push_back(HSOpts.VFSOverlayFiles.size());
1402 for (StringRef VFSOverlayFile : HSOpts.VFSOverlayFiles)
1403 AddString(VFSOverlayFile, Record);
1404
1405 Stream.EmitRecord(HEADER_SEARCH_PATHS, Record);
1406 }
1407
1408 if (!HSOpts.ModulesSkipPragmaDiagnosticMappings)
1409 WritePragmaDiagnosticMappings(Diags, /* isModule = */ WritingModule);
1410
1411 // Header search entry usage.
1412 {
1413 auto HSEntryUsage = PP.getHeaderSearchInfo().computeUserEntryUsage();
1414 auto Abbrev = std::make_shared<BitCodeAbbrev>();
1415 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_ENTRY_USAGE));
1416 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // Number of bits.
1417 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Bit vector.
1418 unsigned HSUsageAbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
1419 RecordData::value_type Record[] = {HEADER_SEARCH_ENTRY_USAGE,
1420 HSEntryUsage.size()};
1421 Stream.EmitRecordWithBlob(HSUsageAbbrevCode, Record, bytes(HSEntryUsage));
1422 }
1423
1424 // VFS usage.
1425 {
1426 auto VFSUsage = PP.getHeaderSearchInfo().collectVFSUsageAndClear();
1427 auto Abbrev = std::make_shared<BitCodeAbbrev>();
1428 Abbrev->Add(BitCodeAbbrevOp(VFS_USAGE));
1429 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // Number of bits.
1430 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Bit vector.
1431 unsigned VFSUsageAbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
1432 RecordData::value_type Record[] = {VFS_USAGE, VFSUsage.size()};
1433 Stream.EmitRecordWithBlob(VFSUsageAbbrevCode, Record, bytes(VFSUsage));
1434 }
1435
1436 // Leave the options block.
1437 Stream.ExitBlock();
1438 UnhashedControlBlockRange.second = Stream.GetCurrentBitNo() >> 3;
1439}
1440
1441/// Write the control block.
1442void ASTWriter::WriteControlBlock(Preprocessor &PP, StringRef isysroot) {
1443 using namespace llvm;
1444
1445 SourceManager &SourceMgr = PP.getSourceManager();
1446 FileManager &FileMgr = PP.getFileManager();
1447
1448 Stream.EnterSubblock(CONTROL_BLOCK_ID, 5);
1449 RecordData Record;
1450
1451 // Metadata
1452 auto MetadataAbbrev = std::make_shared<BitCodeAbbrev>();
1453 MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA));
1454 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1455 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1456 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1457 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1458 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
1459 // Standard C++ module
1460 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1));
1461 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Timestamps
1462 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1463 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
1464 unsigned MetadataAbbrevCode = Stream.EmitAbbrev(std::move(MetadataAbbrev));
1465 assert((!WritingModule || isysroot.empty()) &&
1466 "writing module as a relocatable PCH?");
1467 {
1468 RecordData::value_type Record[] = {METADATA,
1471 CLANG_VERSION_MAJOR,
1472 CLANG_VERSION_MINOR,
1473 !isysroot.empty(),
1474 isWritingStdCXXNamedModules(),
1475 IncludeTimestamps,
1476 ASTHasCompilerErrors};
1477 Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record,
1479 }
1480
1481 if (WritingModule) {
1482 // Module name
1483 auto Abbrev = std::make_shared<BitCodeAbbrev>();
1484 Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME));
1485 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
1486 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
1487 RecordData::value_type Record[] = {MODULE_NAME};
1488 Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name);
1489
1490 auto BaseDir = [&]() -> std::optional<SmallString<128>> {
1492 // Use the current working directory as the base path for all inputs.
1493 auto CWD = FileMgr.getOptionalDirectoryRef(".");
1494 return CWD->getName();
1495 }
1496 if (WritingModule->Directory) {
1497 return WritingModule->Directory->getName();
1498 }
1499 return std::nullopt;
1500 }();
1501 if (BaseDir) {
1502 FileMgr.makeAbsolutePath(*BaseDir, /*Canonicalize=*/true);
1503
1504 // If the home of the module is the current working directory, then we
1505 // want to pick up the cwd of the build process loading the module, not
1506 // our cwd, when we load this module.
1508 (!PP.getHeaderSearchInfo()
1511 WritingModule->Directory->getName() != ".")) {
1512 // Module directory.
1513 auto Abbrev = std::make_shared<BitCodeAbbrev>();
1514 Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY));
1515 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
1516 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
1517
1518 RecordData::value_type Record[] = {MODULE_DIRECTORY};
1519 Stream.EmitRecordWithBlob(AbbrevCode, Record, *BaseDir);
1520 }
1521
1522 // Write out all other paths relative to the base directory if possible.
1523 BaseDirectory.assign(BaseDir->begin(), BaseDir->end());
1524 }
1525 } else if (!isysroot.empty()) {
1526 // Write out paths relative to the sysroot if possible.
1527 SmallString<128> CleanedSysroot(isysroot);
1528 PP.getFileManager().makeAbsolutePath(CleanedSysroot, /*Canonicalize=*/true);
1529 BaseDirectory.assign(CleanedSysroot.begin(), CleanedSysroot.end());
1530 }
1531
1532 // Module map file
1533 if (WritingModule && WritingModule->Kind == Module::ModuleMapModule) {
1534 Record.clear();
1535
1536 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
1537 AddPath(WritingModule->PresumedModuleMapFile.empty()
1538 ? Map.getModuleMapFileForUniquing(WritingModule)
1539 ->getNameAsRequested()
1540 : StringRef(WritingModule->PresumedModuleMapFile),
1541 Record);
1542
1543 // Additional module map files.
1544 if (auto *AdditionalModMaps =
1545 Map.getAdditionalModuleMapFiles(WritingModule)) {
1546 Record.push_back(AdditionalModMaps->size());
1547 SmallVector<FileEntryRef, 1> ModMaps(AdditionalModMaps->begin(),
1548 AdditionalModMaps->end());
1549 llvm::sort(ModMaps, [](FileEntryRef A, FileEntryRef B) {
1550 return A.getName() < B.getName();
1551 });
1552 for (FileEntryRef F : ModMaps)
1553 AddPath(F.getName(), Record);
1554 } else {
1555 Record.push_back(0);
1556 }
1557
1558 Stream.EmitRecord(MODULE_MAP_FILE, Record);
1559 }
1560
1561 // Imports
1562 if (Chain) {
1563 auto Abbrev = std::make_shared<BitCodeAbbrev>();
1564 Abbrev->Add(BitCodeAbbrevOp(IMPORT));
1565 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Kind
1566 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ImportLoc
1567 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Module name len
1568 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Standard C++ mod
1569 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File size
1570 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File timestamp
1571 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Implicit suff len
1572 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File name len
1573 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Strings
1574 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
1575
1576 SmallString<128> Blob;
1577
1578 for (ModuleFile &M : Chain->getModuleManager()) {
1579 // Skip modules that weren't directly imported.
1580 if (!M.isDirectlyImported())
1581 continue;
1582
1583 Record.clear();
1584 Blob.clear();
1585
1586 Record.push_back(IMPORT);
1587 Record.push_back((unsigned)M.Kind); // FIXME: Stable encoding
1588 AddSourceLocation(M.ImportLoc, Record);
1589 AddStringBlob(M.ModuleName, Record, Blob);
1590 Record.push_back(M.StandardCXXModule);
1591
1592 // We don't want to hard code the information about imported modules
1593 // in the C++20 named modules.
1594 if (M.StandardCXXModule) {
1595 Record.push_back(0);
1596 Record.push_back(0);
1597 Record.push_back(0);
1598 Record.push_back(0);
1599 } else {
1600 // If we have calculated signature, there is no need to store
1601 // the size or timestamp.
1602 Record.push_back(M.Signature ? 0 : M.Size);
1603 Record.push_back(M.Signature ? 0 : getTimestampForOutput(M.ModTime));
1604
1605 llvm::append_range(Blob, M.Signature);
1606
1607 Record.push_back(M.FileName.getImplicitModuleSuffixLength());
1608 AddPathBlob(M.FileName, Record, Blob);
1609 }
1610
1611 Stream.EmitRecordWithBlob(AbbrevCode, Record, Blob);
1612 }
1613 }
1614
1615 // Write the options block.
1616 Stream.EnterSubblock(OPTIONS_BLOCK_ID, 4);
1617
1618 // Language options.
1619 Record.clear();
1620 const LangOptions &LangOpts = PP.getLangOpts();
1621#define LANGOPT(Name, Bits, Default, Compatibility, Description) \
1622 Record.push_back(LangOpts.Name);
1623#define ENUM_LANGOPT(Name, Type, Bits, Default, Compatibility, Description) \
1624 Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
1625#include "clang/Basic/LangOptions.def"
1626#define SANITIZER(NAME, ID) \
1627 Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
1628#include "clang/Basic/Sanitizers.def"
1629
1630 Record.push_back(LangOpts.ModuleFeatures.size());
1631 for (StringRef Feature : LangOpts.ModuleFeatures)
1632 AddString(Feature, Record);
1633
1634 Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind());
1635 AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record);
1636
1637 AddString(LangOpts.CurrentModule, Record);
1638
1639 // Comment options.
1640 Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size());
1641 for (const auto &I : LangOpts.CommentOpts.BlockCommandNames) {
1642 AddString(I, Record);
1643 }
1644 Record.push_back(LangOpts.CommentOpts.ParseAllComments);
1645
1646 // OpenMP offloading options.
1647 Record.push_back(LangOpts.OMPTargetTriples.size());
1648 for (auto &T : LangOpts.OMPTargetTriples)
1649 AddString(T.getTriple(), Record);
1650
1651 AddString(LangOpts.OMPHostIRFile, Record);
1652
1653 Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1654
1655 // Codegen options.
1656 // FIXME: Replace with C++20 `using enum CodeGenOptions::CompatibilityKind`.
1657 using CK = CodeGenOptions::CompatibilityKind;
1658 Record.clear();
1659 const CodeGenOptions &CGOpts = getCodeGenOpts();
1660#define CODEGENOPT(Name, Bits, Default, Compatibility) \
1661 if constexpr (CK::Compatibility != CK::Benign) \
1662 Record.push_back(static_cast<unsigned>(CGOpts.Name));
1663#define ENUM_CODEGENOPT(Name, Type, Bits, Default, Compatibility) \
1664 if constexpr (CK::Compatibility != CK::Benign) \
1665 Record.push_back(static_cast<unsigned>(CGOpts.get##Name()));
1666#define DEBUGOPT(Name, Bits, Default, Compatibility)
1667#define VALUE_DEBUGOPT(Name, Bits, Default, Compatibility)
1668#define ENUM_DEBUGOPT(Name, Type, Bits, Default, Compatibility)
1669#include "clang/Basic/CodeGenOptions.def"
1670 Stream.EmitRecord(CODEGEN_OPTIONS, Record);
1671
1672 // Target options.
1673 Record.clear();
1674 const TargetInfo &Target = PP.getTargetInfo();
1675 const TargetOptions &TargetOpts = Target.getTargetOpts();
1676 AddString(TargetOpts.Triple, Record);
1677 AddString(TargetOpts.CPU, Record);
1678 AddString(TargetOpts.TuneCPU, Record);
1679 AddString(TargetOpts.ABI, Record);
1680 Record.push_back(TargetOpts.FeaturesAsWritten.size());
1681 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1682 AddString(TargetOpts.FeaturesAsWritten[I], Record);
1683 }
1684 Record.push_back(TargetOpts.Features.size());
1685 for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1686 AddString(TargetOpts.Features[I], Record);
1687 }
1688 Stream.EmitRecord(TARGET_OPTIONS, Record);
1689
1690 // File system options.
1691 Record.clear();
1692 const FileSystemOptions &FSOpts = FileMgr.getFileSystemOpts();
1693 AddString(FSOpts.WorkingDir, Record);
1694 Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record);
1695
1696 // Header search options.
1697 Record.clear();
1698 const HeaderSearchOptions &HSOpts =
1700
1701 StringRef HSOpts_ModuleCachePath =
1703
1704 AddString(HSOpts.Sysroot, Record);
1705 AddString(HSOpts.ResourceDir, Record);
1706 AddString(HSOpts_ModuleCachePath, Record);
1707 AddString(HSOpts.ModuleUserBuildPath, Record);
1708 Record.push_back(HSOpts.DisableModuleHash);
1709 Record.push_back(HSOpts.ImplicitModuleMaps);
1710 Record.push_back(HSOpts.ModuleMapFileHomeIsCwd);
1711 Record.push_back(HSOpts.EnablePrebuiltImplicitModules);
1712 Record.push_back(HSOpts.UseBuiltinIncludes);
1713 Record.push_back(HSOpts.UseStandardSystemIncludes);
1714 Record.push_back(HSOpts.UseStandardCXXIncludes);
1715 Record.push_back(HSOpts.UseLibcxx);
1716 AddString(PP.getHeaderSearchInfo().getContextHash(), Record);
1717 Stream.EmitRecord(HEADER_SEARCH_OPTIONS, 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(WriteMacros);
1729 if (WriteMacros) {
1730 // Macro definitions.
1731 Record.push_back(PPOpts.Macros.size());
1732 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1733 AddString(PPOpts.Macros[I].first, Record);
1734 Record.push_back(PPOpts.Macros[I].second);
1735 }
1736 }
1737
1738 // Includes
1739 Record.push_back(PPOpts.Includes.size());
1740 for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1741 AddString(PPOpts.Includes[I], Record);
1742
1743 // Macro includes
1744 Record.push_back(PPOpts.MacroIncludes.size());
1745 for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1746 AddString(PPOpts.MacroIncludes[I], Record);
1747
1748 Record.push_back(PPOpts.UsePredefines);
1749 // Detailed record is important since it is used for the module cache hash.
1750 Record.push_back(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(PPOpts.ImplicitPCHInclude, Record);
1757 Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1758 Stream.EmitRecord(PREPROCESSOR_OPTIONS, 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(SourceMgr.getMainFileID())) {
1766 auto FileAbbrev = std::make_shared<BitCodeAbbrev>();
1767 FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE));
1768 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
1769 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1770 unsigned FileAbbrevCode = Stream.EmitAbbrev(std::move(FileAbbrev));
1771
1772 Record.clear();
1773 Record.push_back(ORIGINAL_FILE);
1774 AddFileID(SourceMgr.getMainFileID(), Record);
1775 EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName());
1776 }
1777
1778 Record.clear();
1779 AddFileID(SourceMgr.getMainFileID(), Record);
1780 Stream.EmitRecord(ORIGINAL_FILE_ID, 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()
1809 return;
1810
1811 auto MemBuff = GetMemBuff();
1812 if (!MemBuff) {
1813 PP.Diag(SourceLocation(), diag::err_module_unable_to_hash_content)
1814 << File.getName();
1815 return;
1816 }
1817
1818 uint64_t Hash = xxh3_64bits(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(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(INPUT_FILES_BLOCK_ID, 4);
1842
1843 // Create input-file abbreviation.
1844 auto IFAbbrev = std::make_shared<BitCodeAbbrev>();
1845 IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE));
1846 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
1847 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1848 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
1849 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
1850 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Transient
1851 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Top-level
1852 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Module map
1853 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // Name as req. len
1854 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name as req. + name
1855 unsigned IFAbbrevCode = Stream.EmitAbbrev(std::move(IFAbbrev));
1856
1857 // Create input file hash abbreviation.
1858 auto IFHAbbrev = std::make_shared<BitCodeAbbrev>();
1859 IFHAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_HASH));
1860 IFHAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1861 IFHAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1862 unsigned IFHAbbrevCode = Stream.EmitAbbrev(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(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(File.getFileCharacteristic());
1888 Entry.IsTransient = Cache->IsTransient;
1889 Entry.BufferOverridden = Cache->BufferOverridden;
1890
1891 FileID IncludeFileID = SourceMgr.getFileID(File.getIncludeLoc());
1892 Entry.IsTopLevel = IncludeFileID.isInvalid() || IncludeFileID.ID < 0 ||
1893 !IsSLocFileEntryAffecting[IncludeFileID.ID];
1894 Entry.IsModuleMap = isModuleMap(File.getFileCharacteristic());
1895
1896 Entry.trySetContentHash(*PP, [&] { return Cache->getBufferIfLoaded(); });
1897
1898 if (Entry.IsSystemFile)
1899 SystemFiles.push_back(Entry);
1900 else
1901 UserFiles.push_back(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(SDKSettingsJSON, "SDKSettings.json");
1911 FileManager &FM = PP->getFileManager();
1912 if (auto FE = FM.getOptionalFileRef(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, [&]() -> std::optional<MemoryBufferRef> {
1921 if (auto MBOrErr = FM.getBufferForFile(Entry.File)) {
1922 MB = std::move(*MBOrErr);
1923 return MB->getMemBufferRef();
1924 }
1925 return std::nullopt;
1926 });
1927 SystemFiles.push_back(Entry);
1928 }
1929 }
1930
1931 // User files go at the front, system files at the back.
1932 auto SortedFiles = llvm::concat<InputFileEntry>(std::move(UserFiles),
1933 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(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(NameAsRequested);
1958 PreparePathForOutput(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(Entry.File.getModificationTime()),
1968 Entry.BufferOverridden,
1969 Entry.IsTransient,
1970 Entry.IsTopLevel,
1971 Entry.IsModuleMap,
1972 NameAsRequested.size()};
1973
1974 Stream.EmitRecordWithBlob(IFAbbrevCode, Record,
1975 (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(IFHAbbrevCode, Record);
1983 }
1984 }
1985
1986 Stream.ExitBlock();
1987
1988 // Create input file offsets abbreviation.
1989 auto OffsetsAbbrev = std::make_shared<BitCodeAbbrev>();
1990 OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1991 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
1992 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1993 // input files
1994 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Array
1995 unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(std::move(OffsetsAbbrev));
1996
1997 // Write input file offsets.
1998 RecordData::value_type Record[] = {INPUT_FILE_OFFSETS,
1999 InputFileOffsets.size(), UserFilesNum};
2000 Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, bytes(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(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
2014 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
2015 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
2016 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
2017 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
2018 // FileEntry fields.
2019 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
2020 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
2021 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
2022 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
2023 return Stream.EmitAbbrev(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(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
2033 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
2034 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
2035 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
2036 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
2037 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
2038 return Stream.EmitAbbrev(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(BitCodeAbbrevOp(Compressed ? SM_SLOC_BUFFER_BLOB_COMPRESSED
2050 if (Compressed)
2051 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Uncompressed size
2052 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
2053 return Stream.EmitAbbrev(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(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
2063 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
2064 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
2065 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Start location
2066 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // End location
2067 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Is token range
2068 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
2069 return Stream.EmitAbbrev(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(KeyLen, Out);
2077 llvm::encodeULEB128(DataLen, Out);
2078 return std::make_pair(KeyLen, 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(buf, &key.Size, sizeof(key.Size));
2123 memcpy(buf + sizeof(key.Size), &key.ModTime, sizeof(key.ModTime));
2124 return llvm::xxh3_64bits(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(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>(key.Size);
2144 KeyLen -= 8;
2145 LE.write<uint64_t>(key.ModTime);
2146 KeyLen -= 8;
2147 Out.write(key.Filename.data(), 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>(Flags);
2163
2164 if (Data.HFI.LazyControllingMacro.isID())
2165 LE.write<IdentifierID>(Data.HFI.LazyControllingMacro.getID());
2166 else
2167 LE.write<IdentifierID>(
2168 Writer.getIdentifierRef(Data.HFI.LazyControllingMacro.getPtr()));
2169
2170 auto EmitModule = [&](Module *M, ModuleMap::ModuleHeaderRole Role) {
2171 if (uint32_t ModID = Writer.getLocalOrImportedSubmoduleID(M)) {
2172 uint32_t Value = (ModID << 3) | (unsigned)Role;
2173 assert((Value >> 3) == ModID && "overflow in header module info");
2174 LE.write<uint32_t>(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(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(U.FileNameLoc, 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(Filename, U.FileName);
2233 PreparePathForOutput(Filename);
2234
2235 StringRef FilenameDup = strdup(Filename.c_str());
2236 SavedStrings.push_back(FilenameDup.data());
2237
2238 HeaderFileInfoTrait::key_type Key = {
2239 FilenameDup, *U.Size, IncludeTimestamps ? *U.ModTime : 0};
2240 HeaderFileInfoTrait::data_type Data = {
2241 Empty, false, {}, {M, ModuleMap::headerKindToRole(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, GeneratorTrait);
2245 ++NumHeaderSearchEntries;
2246 }
2247 auto SubmodulesRange = M->submodules();
2248 Worklist.append(SubmodulesRange.begin(), SubmodulesRange.end());
2249 }
2250 }
2251
2252 SmallVector<OptionalFileEntryRef, 16> FilesByUID;
2253 HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
2254
2255 if (FilesByUID.size() > HS.header_file_size())
2256 FilesByUID.resize(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(*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(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(FilenameTmp.c_str()));
2278 SavedStrings.push_back(Filename.data());
2279 }
2280
2281 bool Included = HFI->IsLocallyIncluded || PP->alreadyIncluded(*File);
2282
2283 HeaderFileInfoTrait::key_type Key = {
2284 Filename, File->getSize(),
2285 getTimestampForOutput(File->getModificationTime())};
2286 HeaderFileInfoTrait::data_type Data = {
2287 *HFI, Included, HS.getModuleMap().findResolvedModulesForHeader(*File), {}
2288 };
2289 Generator.insert(Key, Data, 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>(Out, 0, llvm::endianness::little);
2302 BucketOffset = Generator.Emit(Out, GeneratorTrait);
2303 }
2304
2305 // Create a blob abbreviation
2306 using namespace llvm;
2307
2308 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2309 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
2310 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2311 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2312 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2313 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2314 unsigned TableAbbrev = Stream.EmitAbbrev(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(TableAbbrev, Record, 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(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 llvm::arrayRefFromStringRef(Blob.drop_back(1)), CompressedBuffer, 9);
2337 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB_COMPRESSED, Blob.size() - 1};
2338 Stream.EmitRecordWithBlob(SLocBufferBlobCompressedAbbrv, Record,
2339 llvm::toStringRef(CompressedBuffer));
2340 return;
2341 }
2342 if (llvm::compression::zlib::isAvailable()) {
2343 llvm::compression::zlib::compress(
2344 llvm::arrayRefFromStringRef(Blob.drop_back(1)), CompressedBuffer);
2345 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB_COMPRESSED, Blob.size() - 1};
2346 Stream.EmitRecordWithBlob(SLocBufferBlobCompressedAbbrv, Record,
2347 llvm::toStringRef(CompressedBuffer));
2348 return;
2349 }
2350
2351 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB};
2352 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, 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(SOURCE_MANAGER_BLOCK_ID, 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, false);
2374 unsigned SLocBufferBlobCompressedAbbrv =
2375 CreateSLocBufferBlobAbbrev(Stream, 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(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(I);
2387 FileID FID = FileID::get(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
2404 Record.clear();
2405 Record.push_back(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(Offset);
2414 // Starting offset of this entry within this module, so skip the dummy.
2415 Record.push_back(getAdjustedOffset(SLoc->getOffset()) - 2);
2416 AddSourceLocation(getAffectingIncludeLoc(SourceMgr, File), Record);
2417 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
2418 Record.push_back(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(InputFileIDs[*Content->OrigEntry]);
2428
2429 Record.push_back(getAdjustedNumCreatedFIDs(FID));
2430
2431 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID);
2432 if (FDI != FileDeclIDs.end()) {
2433 Record.push_back(FDI->second->FirstDeclIndex);
2434 Record.push_back(FDI->second->DeclIDs.size());
2435 } else {
2436 Record.push_back(0);
2437 Record.push_back(0);
2438 }
2439
2440 Stream.EmitRecordWithAbbrev(SLocFileAbbrv, 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 SourceMgr.getDiagnostics(), SourceMgr.getFileManager());
2453 StringRef Name = Buffer ? Buffer->getBufferIdentifier() : "";
2454 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
2455 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 SourceMgr.getDiagnostics(), 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(Offset);
2474 // Starting offset of this entry within this module, so skip the dummy.
2475 Record.push_back(getAdjustedOffset(SLoc->getOffset()) - 2);
2476 AddSourceLocation(Expansion.getSpellingLoc(), Record);
2477 AddSourceLocation(Expansion.getExpansionLocStart(), Record);
2478 AddSourceLocation(Expansion.isMacroArgExpansion()
2479 ? SourceLocation()
2480 : Expansion.getExpansionLocEnd(),
2481 Record);
2482 Record.push_back(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(I + 1).getOffset();
2488 Record.push_back(getAdjustedOffset(NextOffset - SLoc->getOffset()) - 1);
2489 Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, 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(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
2504 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
2505 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
2506 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // base offset
2507 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
2508 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2509 {
2510 RecordData::value_type Record[] = {
2511 SOURCE_LOCATION_OFFSETS, SLocEntryOffsets.size(),
2512 getAdjustedOffset(SourceMgr.getNextLocalOffset()) - 1 /* skip dummy */,
2513 SLocEntryOffsetsBase - SourceManagerBlockOffset};
2514 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
2515 bytes(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(std::make_pair(LE.FilenameID,
2533 FilenameMap.size() - 1)).second)
2534 AddPath(LineTable.getFilename(LE.FilenameID), Record);
2535 }
2536 }
2537 Record.push_back(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(L.first, Record);
2546
2547 // Emit the line entries
2548 Record.push_back(L.second.size());
2549 for (const auto &LE : L.second) {
2550 Record.push_back(LE.FileOffset);
2551 Record.push_back(LE.LineNo);
2552 Record.push_back(FilenameMap[LE.FilenameID]);
2553 Record.push_back((unsigned)LE.FileKind);
2554 Record.push_back(LE.IncludeOffset);
2555 }
2556 }
2557
2558 Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, 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(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, 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(PP_COUNTER_VALUE, 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 =
2605 if (AssumeNonNullLoc.isValid()) {
2606 assert(PP.isRecordingPreamble());
2607 AddSourceLocation(AssumeNonNullLoc, Record);
2608 Stream.EmitRecord(PP_ASSUME_NONNULL_LOC, 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(true);
2617 AddSourceLocation(SkipInfo->HashTokenLoc, Record);
2618 AddSourceLocation(SkipInfo->IfTokenLoc, Record);
2619 Record.push_back(SkipInfo->FoundNonSkipPortion);
2620 Record.push_back(SkipInfo->FoundElse);
2621 AddSourceLocation(SkipInfo->ElseLoc, Record);
2622 } else {
2623 Record.push_back(false);
2624 }
2625 for (const auto &Cond : PP.getPreambleConditionalStack()) {
2626 AddSourceLocation(Cond.IfLoc, Record);
2627 Record.push_back(Cond.WasSkipping);
2628 Record.push_back(Cond.FoundNonSkip);
2629 Record.push_back(Cond.FoundElse);
2630 }
2631 Stream.EmitRecord(PP_CONDITIONAL_STACK, 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(S, Record);
2638 Stream.EmitRecord(PP_UNSAFE_BUFFER_USAGE, Record);
2639 Record.clear();
2640
2641 // Enter the preprocessor block.
2642 Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 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(SourceLocation(), 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(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(MacroIdentifiers, 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(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) ||
2689 continue;
2690 AddSourceLocation(MD->getLocation(), Record);
2691 Record.push_back(MD->getKind());
2692 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
2693 Record.push_back(getMacroRef(DefMD->getInfo(), Name));
2694 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
2695 Record.push_back(VisMD->isPublic());
2696 }
2697 ModuleMacroRecord.push_back(getSubmoduleID(WritingModule));
2698 AddMacroRef(MD->getMacroInfo(), Name, ModuleMacroRecord);
2699 Stream.EmitRecord(PP_MODULE_MACRO, 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(MD->getLocation(), Record);
2710 Record.push_back(MD->getKind());
2711 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
2712 Record.push_back(getMacroRef(DefMD->getInfo(), Name));
2713 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
2714 Record.push_back(VisMD->isPublic());
2715 }
2716 }
2717
2718 // We write out exported module macros for PCH as well.
2719 auto Leafs = PP.getLeafModuleMacros(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(getSubmoduleID(Macro->getOwningModule()));
2727 AddMacroRef(Macro->getMacroInfo(), Name, ModuleMacroRecord);
2728 for (auto *M : Macro->overrides())
2729 ModuleMacroRecord.push_back(getSubmoduleID(M->getOwningModule()));
2730
2731 Stream.EmitRecord(PP_MODULE_MACRO, 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(M);
2738
2739 EmittedModuleMacros = true;
2740 }
2741 }
2742 if (Record.empty() && !EmittedModuleMacros)
2743 continue;
2744
2745 IdentMacroDirectivesOffsetMap[Name] = StartOffset;
2746 Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, 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(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(Name, Record);
2778 AddSourceLocation(MI->getDefinitionLoc(), Record);
2779 AddSourceLocation(MI->getDefinitionEndLoc(), Record);
2780 Record.push_back(MI->isUsed());
2781 Record.push_back(MI->isUsedForHeaderGuard());
2782 Record.push_back(MI->getNumTokens());
2783 unsigned Code;
2784 if (MI->isObjectLike()) {
2785 Code = PP_MACRO_OBJECT_LIKE;
2786 } else {
2788
2789 Record.push_back(MI->isC99Varargs());
2790 Record.push_back(MI->isGNUVarargs());
2791 Record.push_back(MI->hasCommaPasting());
2792 Record.push_back(MI->getNumParams());
2793 for (const IdentifierInfo *Param : MI->params())
2794 AddIdentifierRef(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(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2801
2802 Stream.EmitRecord(Code, 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(TokNo);
2811 AddToken(Tok, Record);
2812 Stream.EmitRecord(PP_TOKEN, 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(BitCodeAbbrevOp(MACRO_OFFSET));
2825 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2826 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // base offset
2827 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2828
2829 unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2830 {
2831 RecordData::value_type Record[] = {MACRO_OFFSET, MacroOffsets.size(),
2832 MacroOffsetsBase - ASTBlockStartOffset};
2833 Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record, bytes(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(PREPROCESSOR_DETAIL_BLOCK_ID, 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(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
2856 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2857 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2858 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
2859 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
2860 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2861 InclusionAbbrev = Stream.EmitAbbrev(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((*E)->getSourceRange());
2876 PreprocessedEntityOffsets.emplace_back(
2877 getRawSourceLocationEncoding(R.getBegin()),
2878 getRawSourceLocationEncoding(R.getEnd()), Offset);
2879
2880 if (auto *MD = dyn_cast<MacroDefinitionRecord>(*E)) {
2881 // Record this macro definition's ID.
2882 MacroDefinitions[MD] = NextPreprocessorEntityID;
2883
2884 AddIdentifierRef(MD->getName(), Record);
2885 Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
2886 continue;
2887 }
2888
2889 if (auto *ME = dyn_cast<MacroExpansion>(*E)) {
2890 Record.push_back(ME->isBuiltinMacro());
2891 if (ME->isBuiltinMacro())
2892 AddIdentifierRef(ME->getName(), Record);
2893 else
2894 Record.push_back(MacroDefinitions[ME->getDefinition()]);
2895 Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
2896 continue;
2897 }
2898
2899 if (auto *ID = dyn_cast<InclusionDirective>(*E)) {
2901 Record.push_back(ID->getFileName().size());
2902 Record.push_back(ID->wasInQuotes());
2903 Record.push_back(static_cast<unsigned>(ID->getKind()));
2904 Record.push_back(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(InclusionAbbrev, Record, 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(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
2928 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2929 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2930
2931 RecordData::value_type Record[] = {PPD_ENTITIES_OFFSETS};
2932 Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
2933 bytes(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(SkippedRanges.size());
2941 for (auto const& Range : SkippedRanges)
2942 SerializedSkippedRanges.emplace_back(
2943 getRawSourceLocationEncoding(Range.getBegin()),
2944 getRawSourceLocationEncoding(Range.getEnd()));
2945
2946 using namespace llvm;
2947 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2948 Abbrev->Add(BitCodeAbbrevOp(PPD_SKIPPED_RANGES));
2949 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2950 unsigned PPESkippedRangeAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2951
2952 Record.clear();
2953 Record.push_back(PPD_SKIPPED_RANGES);
2954 Stream.EmitRecordWithBlob(PPESkippedRangeAbbrev, Record,
2955 bytes(SerializedSkippedRanges));
2956 }
2957}
2958
2960 if (!Mod)
2961 return 0;
2962
2963 auto Known = SubmoduleIDs.find(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(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(Submodule);
2992
2993 return ChildModules + 1;
2994}
2995
2996void ASTWriter::WriteSubmodules(Module *WritingModule, ASTContext *Context) {
2997 // Enter the submodule description block.
2998 Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/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(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
3005 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
3006 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
3007 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // Kind
3008 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Definition location
3009 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 4)); // Inferred allowed by
3010 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
3011 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
3012 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
3013 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
3014 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
3015 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
3016 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
3017 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
3018 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ModuleMapIsPriv...
3019 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // NamedModuleHasN...
3020 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3021 unsigned DefinitionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3022
3023 Abbrev = std::make_shared<BitCodeAbbrev>();
3024 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
3025 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3026 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3027
3028 Abbrev = std::make_shared<BitCodeAbbrev>();
3029 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
3030 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3031 unsigned HeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3032
3033 Abbrev = std::make_shared<BitCodeAbbrev>();
3034 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
3035 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3036 unsigned TopHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3037
3038 Abbrev = std::make_shared<BitCodeAbbrev>();
3039 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
3040 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3041 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3042
3043 Abbrev = std::make_shared<BitCodeAbbrev>();
3044 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES));
3045 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
3046 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Feature
3047 unsigned RequiresAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3048
3049 Abbrev = std::make_shared<BitCodeAbbrev>();
3050 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
3051 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3052 unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3053
3054 Abbrev = std::make_shared<BitCodeAbbrev>();
3055 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
3056 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3057 unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3058
3059 Abbrev = std::make_shared<BitCodeAbbrev>();
3060 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
3061 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3062 unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3063
3064 Abbrev = std::make_shared<BitCodeAbbrev>();
3065 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
3066 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3067 unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3068
3069 Abbrev = std::make_shared<BitCodeAbbrev>();
3070 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
3071 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
3072 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
3073 unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3074
3075 Abbrev = std::make_shared<BitCodeAbbrev>();
3076 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
3077 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
3078 unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3079
3080 Abbrev = std::make_shared<BitCodeAbbrev>();
3081 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT));
3082 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Other module
3083 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Message
3084 unsigned ConflictAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3085
3086 Abbrev = std::make_shared<BitCodeAbbrev>();
3087 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXPORT_AS));
3088 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
3089 unsigned ExportAsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3090
3091 // Write the submodule metadata block.
3092 RecordData::value_type Record[] = {
3093 getNumberOfModules(WritingModule),
3094 FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS};
3095 Stream.EmitRecord(SUBMODULE_METADATA, Record);
3096
3097 // Write all of the submodules.
3098 std::queue<Module *> Q;
3099 Q.push(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
3112 getRawSourceLocationEncoding(getAdjustedLocation(Mod->DefinitionLoc));
3113
3114 ModuleMap &ModMap = PP->getHeaderSearchInfo().getModuleMap();
3115 FileID UnadjustedInferredFID;
3116 if (Mod->IsInferred)
3117 UnadjustedInferredFID = ModMap.getModuleMapFileIDForUniquing(Mod);
3118 int InferredFID = getAdjustedFileID(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,
3136 Mod->ModuleMapIsPrivate,
3137 Mod->NamedModuleHasInit};
3138 Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, 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(RequiresAbbrev, Record, R.FeatureName);
3145 }
3146
3147 // Emit the umbrella header, if there is one.
3148 if (std::optional<Module::Header> UmbrellaHeader =
3150 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_HEADER};
3151 Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
3152 UmbrellaHeader->NameAsWritten);
3153 } else if (std::optional<Module::DirectoryName> UmbrellaDir =
3154 Mod->getUmbrellaDirAsWritten()) {
3155 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_DIR};
3156 Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
3157 UmbrellaDir->NameAsWritten);
3158 }
3159
3160 // Emit the headers.
3161 struct {
3162 unsigned RecordKind;
3163 unsigned Abbrev;
3164 Module::HeaderKind HeaderKind;
3165 } HeaderLists[] = {
3166 {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal},
3167 {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual},
3168 {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private},
3169 {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev,
3170 Module::HK_PrivateTextual},
3171 {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded}
3172 };
3173 for (const auto &HL : HeaderLists) {
3174 RecordData::value_type Record[] = {HL.RecordKind};
3175 for (const auto &H : Mod->getHeaders(HL.HeaderKind))
3176 Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten);
3177 }
3178
3179 // Emit the top headers.
3180 {
3181 RecordData::value_type Record[] = {SUBMODULE_TOPHEADER};
3182 for (FileEntryRef H : Mod->getTopHeaders(PP->getFileManager())) {
3183 SmallString<128> HeaderName(H.getName());
3184 PreparePathForOutput(HeaderName);
3185 Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, 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(getSubmoduleID(I));
3194 Stream.EmitRecord(SUBMODULE_IMPORTS, 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(getSubmoduleID(I));
3202 Stream.EmitRecord(SUBMODULE_AFFECTING_MODULES, 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(getSubmoduleID(E.getPointer()));
3212 Record.push_back(E.getInt());
3213 }
3214 Stream.EmitRecord(SUBMODULE_EXPORTS, 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(LinkLibraryAbbrev, Record, 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(C.Other)};
3236 Stream.EmitRecordWithBlob(ConflictAbbrev, Record, 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(ConfigMacroAbbrev, Record, 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(Mod))
3250 if (wasDeclEmitted(D))
3251 AddDeclRef(D, Inits);
3252 if (!Inits.empty())
3253 Stream.EmitRecord(SUBMODULE_INITIALIZERS, 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(ExportAsAbbrev, Record, Mod->ExportAsModule);
3260 }
3261
3262 // Queue up the submodules of this module.
3263 for (auto *M : Mod->submodules())
3264 Q.push(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(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(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(I.first))
3326 continue;
3327 Mappings.push_back(I);
3328 }
3329
3330 // Sort by diag::kind for deterministic output.
3331 llvm::sort(Mappings, llvm::less_first());
3332
3333 for (const auto &I : Mappings) {
3334 Record.push_back(I.first);
3335 Record.push_back(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(FileIDAndFile.first, Record);
3357
3358 Record.push_back(FileIDAndFile.second.StateTransitions.size());
3359 for (auto &StatePoint : FileIDAndFile.second.StateTransitions) {
3360 Record.push_back(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(Diag.DiagStatesByLoc.CurDiagStateLoc, Record);
3375 AddDiagState(Diag.DiagStatesByLoc.CurDiagState, false);
3376
3377 Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, 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(Offset);
3402 else if (TypeOffsets.size() < Index) {
3403 TypeOffsets.resize(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
3415 auto *ND = dyn_cast<NamedDecl>(D);
3416 if (!ND)
3417 return false;
3418
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() &&
3452 continue;
3453
3454 KindDeclPairs.push_back(D->getKind());
3455 KindDeclPairs.push_back(GetDeclRef(D).getRawValue());
3456 }
3457
3458 ++NumLexicalDeclContexts;
3459 RecordData::value_type Record[] = {DECL_CONTEXT_LEXICAL};
3460 Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record,
3461 bytes(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(BitCodeAbbrevOp(TYPE_OFFSET));
3471 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
3472 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
3473 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3474 {
3475 RecordData::value_type Record[] = {TYPE_OFFSET, TypeOffsets.size()};
3476 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, bytes(TypeOffsets));
3477 }
3478
3479 // Write the declaration offsets array
3480 Abbrev = std::make_shared<BitCodeAbbrev>();
3481 Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
3482 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
3483 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
3484 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3485 {
3486 RecordData::value_type Record[] = {DECL_OFFSET, DeclOffsets.size()};
3487 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, bytes(DeclOffsets));
3488 }
3489}
3490
3491void ASTWriter::WriteFileDeclIDsMap() {
3492 using namespace llvm;
3493
3494 SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs;
3495 SortedFileDeclIDs.reserve(FileDeclIDs.size());
3496 for (const auto &P : FileDeclIDs)
3497 SortedFileDeclIDs.push_back(std::make_pair(P.first, P.second.get()));
3498 llvm::sort(SortedFileDeclIDs, 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(Info.DeclIDs);
3506 for (auto &LocDeclEntry : Info.DeclIDs)
3507 FileGroupedDeclIDs.push_back(LocDeclEntry.second.getRawValue());
3508 }
3509
3510 auto Abbrev = std::make_shared<BitCodeAbbrev>();
3511 Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
3512 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
3513 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3514 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
3515 RecordData::value_type Record[] = {FILE_SORTED_DECLS,
3516 FileGroupedDeclIDs.size()};
3517 Stream.EmitRecordWithBlob(AbbrevCode, Record, bytes(FileGroupedDeclIDs));
3518}
3519
3520void ASTWriter::WriteComments(ASTContext &Context) {
3521 Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3);
3522 llvm::scope_exit _([this] { Stream.ExitBlock(); });
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(I->getSourceRange(), Record);
3538 Record.push_back(I->getKind());
3539 Record.push_back(I->isTrailingComment());
3540 Record.push_back(I->isAlmostTrailingComment());
3541 Stream.EmitRecord(COMMENTS_RAW_COMMENT, 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(Method))
3585 DataLen += sizeof(DeclID);
3586 for (const ObjCMethodList *Method = &Methods.Factory; Method;
3587 Method = Method->getNext())
3588 if (ShouldWriteMethodListNode(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, Start);
3600 unsigned N = Sel.getNumArgs();
3601 LE.write<uint16_t>(N);
3602 if (N == 0)
3603 N = 1;
3604 for (unsigned I = 0; I != N; ++I)
3605 LE.write<IdentifierID>(
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>(Methods.ID);
3616 unsigned NumInstanceMethods = 0;
3617 for (const ObjCMethodList *Method = &Methods.Instance; Method;
3618 Method = Method->getNext())
3619 if (ShouldWriteMethodListNode(Method))
3620 ++NumInstanceMethods;
3621
3622 unsigned NumFactoryMethods = 0;
3623 for (const ObjCMethodList *Method = &Methods.Factory; Method;
3624 Method = Method->getNext())
3625 if (ShouldWriteMethodListNode(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>(FullInstanceBits);
3643 LE.write<uint16_t>(FullFactoryBits);
3644 for (const ObjCMethodList *Method = &Methods.Instance; Method;
3645 Method = Method->getNext())
3646 if (ShouldWriteMethodListNode(Method))
3647 LE.write<DeclID>((DeclID)Writer.getDeclID(Method->getMethod()));
3648 for (const ObjCMethodList *Method = &Methods.Factory; Method;
3649 Method = Method->getNext())
3650 if (ShouldWriteMethodListNode(Method))
3651 LE.write<DeclID>((DeclID)Writer.getDeclID(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(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(S);
3689 ASTMethodPoolTrait::data_type Data = {
3690 ID,
3691 ObjCMethodList(),
3692 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(S, Data, 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>(Out, 0, llvm::endianness::little);
3738 BucketOffset = Generator.Emit(Out, Trait);
3739 }
3740
3741 // Create a blob abbreviation
3742 auto Abbrev = std::make_shared<BitCodeAbbrev>();
3743 Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
3744 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
3745 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
3746 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3747 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3748
3749 // Write the method pool
3750 {
3751 RecordData::value_type Record[] = {METHOD_POOL, BucketOffset,
3752 NumTableEntries};
3753 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool);
3754 }
3755
3756 // Create a blob abbreviation for the selector table offsets.
3757 Abbrev = std::make_shared<BitCodeAbbrev>();
3758 Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
3759 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
3760 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
3761 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3762 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(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(SelectorOffsetAbbrev, Record,
3770 bytes(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(Sel);
3792 Writer.AddSourceLocation(Loc);
3793 }
3794 Writer.Emit(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.
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(
3821 continue;
3822 return cast<NamedDecl>(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>(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() &&
3854 II->isPoisoned() || (!IsModule && IsInteresting) ||
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 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(II->getName());
3907 }
3908
3909 bool isInterestingIdentifier(const IdentifierInfo *II) {
3910 auto MacroOffset = Writer.getMacroDirectivesOffset(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, Out.tell());
3919
3920 auto MacroOffset = Writer.getMacroDirectivesOffset(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(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() &&
3935 DataLen += 4; // MacroDirectives offset.
3936
3937 if (NeedDecls && IdResolver)
3938 DataLen += std::distance(IdResolver->begin(II), 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(II->getNameStart(), 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(II);
3955 if (!isInterestingIdentifier(II, MacroOffset)) {
3956 LE.write<IdentifierID>(ID << 1);
3957 return;
3958 }
3959
3960 LE.write<IdentifierID>((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>(Bits);
3964 Bits = 0;
3965 bool HasMacroDefinition =
3966 (MacroOffset != 0) || (II->hasMacroDefinition() &&
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>(Bits);
3974
3975 if (HasMacroDefinition)
3976 LE.write<uint32_t>(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(II));
3986 for (NamedDecl *D : llvm::reverse(Decls))
3987 LE.write<DeclID>((DeclID)Writer.getDeclID(
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(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.
4029 (Trait.needDecls() &&
4031 Generator.insert(II, ID, 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>(Out, 0, llvm::endianness::little);
4043 BucketOffset = Generator.Emit(Out, Trait);
4044 }
4045
4046 // Create a blob abbreviation
4047 auto Abbrev = std::make_shared<BitCodeAbbrev>();
4048 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
4049 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
4050 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
4051 unsigned IDTableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
4052
4053 // Write the identifier table
4054 RecordData::value_type Record[] = {IDENTIFIER_TABLE, BucketOffset};
4055 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable);
4056 }
4057
4058 // Write the offsets table for identifier IDs.
4059 auto Abbrev = std::make_shared<BitCodeAbbrev>();
4060 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
4061 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
4062 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
4063 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(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(IdentifierOffsetAbbrev, Record,
4073 bytes(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(INTERESTING_IDENTIFIERS, InterestingIdents);
4079}
4080
4082 if (!RD->isInNamedModule())
4083 return;
4084
4085 PendingEmittingVTables.push_back(RD);
4086}
4087
4089 TouchedModuleFiles.insert(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(ID);
4119 return std::make_pair(Start, DeclIDs.size());
4120 }
4121
4122 data_type ImportData(const reader::ASTDeclContextNameLookupTrait::data_type &FromReader) {
4123 unsigned Start = DeclIDs.size();
4124 DeclIDs.insert(
4125 DeclIDs.end(),
4126 DeclIDIterator<GlobalDeclID, LocalDeclID>(FromReader.begin()),
4127 DeclIDIterator<GlobalDeclID, LocalDeclID>(FromReader.end()));
4128 return std::make_pair(Start, 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(F);
4137 endian::write<uint32_t>(Out, Writer.getChain()->getModuleFileID(F),
4138 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()) {
4149 KeyLen += sizeof(IdentifierID);
4150 break;
4154 KeyLen += 4;
4155 break;
4157 KeyLen += 1;
4158 break;
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>(Name.getKind());
4177 switch (Name.getKind()) {
4181 LE.write<IdentifierID>(Writer.getIdentifierRef(Name.getIdentifier()));
4182 return;
4186 LE.write<uint32_t>(Writer.getSelectorRef(Name.getSelector()));
4187 return;
4189 assert(Name.getOperatorKind() < NUM_OVERLOADED_OPERATORS &&
4190 "Invalid operator?");
4191 LE.write<uint8_t>(Name.getOperatorKind());
4192 return;
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>((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(Key.first.getHash());
4229 ID.AddInteger(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, 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, Key.first);
4242 llvm::support::endian::Writer LE(Out, llvm::endianness::little);
4243 LE.write<primary_module_hash_type>(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>(D->getNonTransparentDeclContext());
4289 return isModuleLocalDecl(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>(D))
4294 if (auto *CDGD = dyn_cast<CXXDeductionGuideDecl>(FTD->getTemplatedDecl()))
4295 return isModuleLocalDecl(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() &&
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.
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>(D);
4374 ECD && DC.isFileContext() && ECD->getTopLevelOwningNamedModule()) {
4375 if (llvm::all_of(
4376 DC.noload_lookup(
4377 cast<EnumDecl>(ECD->getDeclContext())->getDeclName()),
4378 [](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 =
4406
4407 if (Writer.getDoneWritingDeclsAndTypes() &&
4408 !Writer.wasDeclEmitted(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(DeclForLocalLookup))
4416 return;
4417
4418 auto ID = Writer.GetDeclRef(DeclForLocalLookup);
4419
4420 switch (getLookupVisibility(DeclForLocalLookup)) {
4421 case LookupVisibility::ModuleLocalVisible:
4422 if (UnsignedOrNone PrimaryModuleHash =
4424 auto Key = std::make_pair(D->getDeclName(), *PrimaryModuleHash);
4425 auto Iter = ModuleLocalDeclsMap.find(Key);
4426 if (Iter == ModuleLocalDeclsMap.end())
4427 ModuleLocalDeclsMap.insert({Key, DeclIDsTy{ID}});
4428 else
4429 Iter->second.push_back(ID);
4430 return;
4431 }
4432 break;
4433 case LookupVisibility::TULocal: {
4434 auto Iter = TULocalDeclsMap.find(D->getDeclName());
4435 if (Iter == TULocalDeclsMap.end())
4436 TULocalDeclsMap.insert({D->getDeclName(), DeclIDsTy{ID}});
4437 else
4438 Iter->second.push_back(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(ID);
4447 };
4448 ASTReader *Chain = Writer.getChain();
4449 for (NamedDecl *D : Decls) {
4450 if (Chain && isa<NamespaceDecl>(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>(const_cast<Decl *>(First)));
4462 } else {
4463 AddDecl(D);
4464 }
4465 }
4466 return std::make_pair(Start, 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(Writer.getLangOpts(),
4502 const_cast<NamedDecl *>(D));
4503 Specs.push_back(GlobalDeclID(Writer.GetDeclRef(ND).getRawValue()));
4504 }
4506 ExistingInfo)
4507 Specs.push_back(Info);
4508 return std::make_pair(Start, Specs.size());
4509 }
4510
4511 data_type ImportData(
4513 unsigned Start = Specs.size();
4514 for (auto ID : FromReader)
4515 Specs.push_back(ID);
4516 return std::make_pair(Start, 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(F);
4529 endian::write<uint32_t>(Out, Writer.getChain()->getModuleFileID(F),
4530 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>(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>(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>(Spec))
4568 Args = CTSD->getTemplateArgs().asArray();
4569 else if (auto *VTSD = dyn_cast<VarTemplateSpecializationDecl>(Spec))
4570 Args = VTSD->getTemplateArgs().asArray();
4571 else if (auto *FD = dyn_cast<FunctionDecl>(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(Specialization);
4596
4597 auto Iter = SpecializationMaps.find(HashedValue);
4598 if (Iter == SpecializationMaps.end())
4599 Iter = SpecializationMaps
4600 .try_emplace(HashedValue,
4601 llvm::SmallVector<const NamedDecl *, 4>())
4602 .first;
4603
4604 Iter->second.push_back(cast<NamedDecl>(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(HashValue);
4623
4624 Generator.insert(HashValue, Trait.getData(Specs, ExisitingSpecs), Trait);
4625 }
4626
4627 // Reduced BMI may not emit everything in the lookup table,
4628 // If Reduced BMI **partially** emits some decls,
4629 // then the generator may not emit the corresponding entry for the
4630 // corresponding name is already there. See
4631 // MultiOnDiskHashTableGenerator::insert and
4632 // MultiOnDiskHashTableGenerator::emit for details.
4633 // So we won't emit the lookup table if we're generating reduced BMI.
4634 auto *ToEmitMaybeMergedLookupTable =
4635 (!isGeneratingReducedBMI() && Lookups) ? &Lookups->Table : nullptr;
4636 Generator.emit(LookupTable, Trait, ToEmitMaybeMergedLookupTable);
4637}
4638
4639uint64_t ASTWriter::WriteSpecializationInfoLookupTable(
4640 const NamedDecl *D, llvm::SmallVectorImpl<const Decl *> &Specializations,
4641 bool IsPartial) {
4642
4643 llvm::SmallString<4096> LookupTable;
4644 GenerateSpecializationInfoLookupTable(D, Specializations, LookupTable,
4645 IsPartial);
4646
4647 uint64_t Offset = Stream.GetCurrentBitNo();
4648 RecordData::value_type Record[] = {static_cast<RecordData::value_type>(
4650 Stream.EmitRecordWithBlob(IsPartial ? DeclPartialSpecializationsAbbrev
4651 : DeclSpecializationsAbbrev,
4652 Record, LookupTable);
4653
4654 return Offset;
4655}
4656
4657/// Returns true if all of the lookup result are either external, not emitted or
4658/// predefined. In such cases, the lookup result is not interesting and we don't
4659/// need to record the result in the current being written module. Return false
4660/// otherwise.
4662 StoredDeclsList &Result) {
4663 for (auto *D : Result.getLookupResult()) {
4664 auto *LocalD = getDeclForLocalLookup(Writer.getLangOpts(), D);
4665 if (LocalD->isFromASTFile())
4666 continue;
4667
4668 // We can only be sure whether the local declaration is reachable
4669 // after we done writing the declarations and types.
4670 if (Writer.getDoneWritingDeclsAndTypes() && !Writer.wasDeclEmitted(LocalD))
4671 continue;
4672
4673 // We don't need to emit the predefined decls.
4674 if (Writer.isDeclPredefined(LocalD))
4675 continue;
4676
4677 return false;
4678 }
4679
4680 return true;
4681}
4682
4683void ASTWriter::GenerateNameLookupTable(
4684 ASTContext &Context, const DeclContext *ConstDC,
4685 llvm::SmallVectorImpl<char> &LookupTable,
4686 llvm::SmallVectorImpl<char> &ModuleLocalLookupTable,
4687 llvm::SmallVectorImpl<char> &TULookupTable) {
4688 assert(!ConstDC->hasLazyLocalLexicalLookups() &&
4689 !ConstDC->hasLazyExternalLexicalLookups() &&
4690 "must call buildLookups first");
4691
4692 // FIXME: We need to build the lookups table, which is logically const.
4693 auto *DC = const_cast<DeclContext*>(ConstDC);
4694 assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
4695
4696 // Create the on-disk hash table representation.
4697 MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait,
4698 ASTDeclContextNameLookupTrait>
4699 Generator;
4700 ASTDeclContextNameLookupTrait Trait(*this, *DC);
4701
4702 // The first step is to collect the declaration names which we need to
4703 // serialize into the name lookup table, and to collect them in a stable
4704 // order.
4705 SmallVector<DeclarationName, 16> Names;
4706
4707 // We also track whether we're writing out the DeclarationNameKey for
4708 // constructors or conversion functions.
4709 bool IncludeConstructorNames = false;
4710 bool IncludeConversionNames = false;
4711
4712 for (auto &[Name, Result] : *DC->buildLookup()) {
4713 // If there are no local declarations in our lookup result, we
4714 // don't need to write an entry for the name at all. If we can't
4715 // write out a lookup set without performing more deserialization,
4716 // just skip this entry.
4717 //
4718 // Also in reduced BMI, we'd like to avoid writing unreachable
4719 // declarations in GMF, so we need to avoid writing declarations
4720 // that entirely external or unreachable.
4721 if (GeneratingReducedBMI && isLookupResultNotInteresting(*this, Result))
4722 continue;
4723 // We also skip empty results. If any of the results could be external and
4724 // the currently available results are empty, then all of the results are
4725 // external and we skip it above. So the only way we get here with an empty
4726 // results is when no results could have been external *and* we have
4727 // external results.
4728 //
4729 // FIXME: While we might want to start emitting on-disk entries for negative
4730 // lookups into a decl context as an optimization, today we *have* to skip
4731 // them because there are names with empty lookup results in decl contexts
4732 // which we can't emit in any stable ordering: we lookup constructors and
4733 // conversion functions in the enclosing namespace scope creating empty
4734 // results for them. This in almost certainly a bug in Clang's name lookup,
4735 // but that is likely to be hard or impossible to fix and so we tolerate it
4736 // here by omitting lookups with empty results.
4737 if (Result.getLookupResult().empty())
4738 continue;
4739
4740 switch (Name.getNameKind()) {
4741 default:
4742 Names.push_back(Name);
4743 break;
4744
4746 IncludeConstructorNames = true;
4747 break;
4748
4750 IncludeConversionNames = true;
4751 break;
4752 }
4753 }
4754
4755 // Sort the names into a stable order.
4756 llvm::sort(Names);
4757
4758 if (IncludeConstructorNames || IncludeConversionNames) {
4759 // We need to establish an ordering of constructor and conversion function
4760 // names, and they don't have an intrinsic ordering. We also need to write
4761 // out all constructor and conversion function results if we write out any
4762 // of them, because they're all tracked under the same lookup key.
4763 llvm::SmallPtrSet<DeclarationName, 8> AddedNames;
4764 for (Decl *ChildD : cast<CXXRecordDecl>(DC)->decls()) {
4765 if (auto *ChildND = dyn_cast<NamedDecl>(ChildD)) {
4766 auto Name = ChildND->getDeclName();
4767 switch (Name.getNameKind()) {
4768 default:
4769 continue;
4770
4772 if (!IncludeConstructorNames)
4773 continue;
4774 break;
4775
4777 if (!IncludeConversionNames)
4778 continue;
4779 break;
4780 }
4781 if (AddedNames.insert(Name).second)
4782 Names.push_back(Name);
4783 }
4784 }
4785 }
4786 // Next we need to do a lookup with each name into this decl context to fully
4787 // populate any results from external sources. We don't actually use the
4788 // results of these lookups because we only want to use the results after all
4789 // results have been loaded and the pointers into them will be stable.
4790 for (auto &Name : Names)
4791 DC->lookup(Name);
4792
4793 // Now we need to insert the results for each name into the hash table. For
4794 // constructor names and conversion function names, we actually need to merge
4795 // all of the results for them into one list of results each and insert
4796 // those.
4797 SmallVector<NamedDecl *, 8> ConstructorDecls;
4798 SmallVector<NamedDecl *, 8> ConversionDecls;
4799
4800 // Now loop over the names, either inserting them or appending for the two
4801 // special cases.
4802 for (auto &Name : Names) {
4804
4805 switch (Name.getNameKind()) {
4806 default:
4807 Generator.insert(Name, Trait.getData(Result), Trait);
4808 break;
4809
4811 ConstructorDecls.append(Result.begin(), Result.end());
4812 break;
4813
4815 ConversionDecls.append(Result.begin(), Result.end());
4816 break;
4817 }
4818 }
4819
4820 // Handle our two special cases if we ended up having any. We arbitrarily use
4821 // the first declaration's name here because the name itself isn't part of
4822 // the key, only the kind of name is used.
4823 if (!ConstructorDecls.empty())
4824 Generator.insert(ConstructorDecls.front()->getDeclName(),
4825 Trait.getData(ConstructorDecls), Trait);
4826 if (!ConversionDecls.empty())
4827 Generator.insert(ConversionDecls.front()->getDeclName(),
4828 Trait.getData(ConversionDecls), Trait);
4829
4830 // Create the on-disk hash table. Also emit the existing imported and
4831 // merged table if there is one.
4832 auto *Lookups = Chain ? Chain->getLoadedLookupTables(DC) : nullptr;
4833 // Reduced BMI may not emit everything in the lookup table,
4834 // If Reduced BMI **partially** emits some decls,
4835 // then the generator may not emit the corresponding entry for the
4836 // corresponding name is already there. See
4837 // MultiOnDiskHashTableGenerator::insert and
4838 // MultiOnDiskHashTableGenerator::emit for details.
4839 // So we won't emit the lookup table if we're generating reduced BMI.
4840 auto *ToEmitMaybeMergedLookupTable =
4841 (!isGeneratingReducedBMI() && Lookups) ? &Lookups->Table : nullptr;
4842 Generator.emit(LookupTable, Trait, ToEmitMaybeMergedLookupTable);
4843
4844 const auto &ModuleLocalDecls = Trait.getModuleLocalDecls();
4845 if (!ModuleLocalDecls.empty()) {
4846 MultiOnDiskHashTableGenerator<reader::ModuleLocalNameLookupTrait,
4847 ModuleLevelNameLookupTrait>
4848 ModuleLocalLookupGenerator;
4849 ModuleLevelNameLookupTrait ModuleLocalTrait(*this);
4850
4851 for (const auto &ModuleLocalIter : ModuleLocalDecls) {
4852 const auto &Key = ModuleLocalIter.first;
4853 const auto &IDs = ModuleLocalIter.second;
4854 ModuleLocalLookupGenerator.insert(Key, ModuleLocalTrait.getData(IDs),
4855 ModuleLocalTrait);
4856 }
4857
4858 // See the above comment. We won't emit the merged table if we're generating
4859 // reduced BMI.
4860 auto *ModuleLocalLookups =
4861 (isGeneratingReducedBMI() && Chain &&
4862 Chain->getModuleLocalLookupTables(DC))
4863 ? &Chain->getModuleLocalLookupTables(DC)->Table
4864 : nullptr;
4865 ModuleLocalLookupGenerator.emit(ModuleLocalLookupTable, ModuleLocalTrait,
4866 ModuleLocalLookups);
4867 }
4868
4869 const auto &TULocalDecls = Trait.getTULocalDecls();
4870 if (!TULocalDecls.empty() && !isGeneratingReducedBMI()) {
4871 MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait,
4872 ASTDeclContextNameTrivialLookupTrait>
4873 TULookupGenerator;
4874 ASTDeclContextNameTrivialLookupTrait TULocalTrait(*this);
4875
4876 for (const auto &TULocalIter : TULocalDecls) {
4877 const auto &Key = TULocalIter.first;
4878 const auto &IDs = TULocalIter.second;
4879 TULookupGenerator.insert(Key, TULocalTrait.getData(IDs), TULocalTrait);
4880 }
4881
4882 // See the above comment. We won't emit the merged table if we're generating
4883 // reduced BMI.
4884 auto *TULocalLookups =
4885 (isGeneratingReducedBMI() && Chain && Chain->getTULocalLookupTables(DC))
4886 ? &Chain->getTULocalLookupTables(DC)->Table
4887 : nullptr;
4888 TULookupGenerator.emit(TULookupTable, TULocalTrait, TULocalLookups);
4889 }
4890}
4891
4892/// Write the block containing all of the declaration IDs
4893/// visible from the given DeclContext.
4894///
4895/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
4896/// bitstream, or 0 if no block was written.
4897void ASTWriter::WriteDeclContextVisibleBlock(
4898 ASTContext &Context, DeclContext *DC, VisibleLookupBlockOffsets &Offsets) {
4899 assert(!Offsets);
4900
4901 // If we imported a key declaration of this namespace, write the visible
4902 // lookup results as an update record for it rather than including them
4903 // on this declaration. We will only look at key declarations on reload.
4904 if (isa<NamespaceDecl>(DC) && Chain &&
4906 // Only do this once, for the first local declaration of the namespace.
4907 for (auto *Prev = cast<NamespaceDecl>(DC)->getPreviousDecl(); Prev;
4908 Prev = Prev->getPreviousDecl())
4909 if (!Prev->isFromASTFile())
4910 return;
4911
4912 // Note that we need to emit an update record for the primary context.
4913 UpdatedDeclContexts.insert(DC->getPrimaryContext());
4914
4915 // Make sure all visible decls are written. They will be recorded later. We
4916 // do this using a side data structure so we can sort the names into
4917 // a deterministic order.
4918 StoredDeclsMap *Map = DC->getPrimaryContext()->buildLookup();
4919 SmallVector<std::pair<DeclarationName, DeclContext::lookup_result>, 16>
4920 LookupResults;
4921 if (Map) {
4922 LookupResults.reserve(Map->size());
4923 for (auto &Entry : *Map)
4924 LookupResults.push_back(
4925 std::make_pair(Entry.first, Entry.second.getLookupResult()));
4926 }
4927
4928 llvm::sort(LookupResults, llvm::less_first());
4929 for (auto &NameAndResult : LookupResults) {
4930 DeclarationName Name = NameAndResult.first;
4931 DeclContext::lookup_result Result = NameAndResult.second;
4934 // We have to work around a name lookup bug here where negative lookup
4935 // results for these names get cached in namespace lookup tables (these
4936 // names should never be looked up in a namespace).
4937 assert(Result.empty() && "Cannot have a constructor or conversion "
4938 "function name in a namespace!");
4939 continue;
4940 }
4941
4942 for (NamedDecl *ND : Result) {
4943 if (ND->isFromASTFile())
4944 continue;
4945
4946 if (DoneWritingDeclsAndTypes && !wasDeclEmitted(ND))
4947 continue;
4948
4949 // We don't need to force emitting internal decls into reduced BMI.
4950 // See comments in ASTWriter::WriteDeclContextLexicalBlock for details.
4951 if (GeneratingReducedBMI && !ND->isFromExplicitGlobalModule() &&
4953 continue;
4954
4955 GetDeclRef(ND);
4956 }
4957 }
4958
4959 return;
4960 }
4961
4962 if (DC->getPrimaryContext() != DC)
4963 return;
4964
4965 // Skip contexts which don't support name lookup.
4966 if (!DC->isLookupContext())
4967 return;
4968
4969 // If not in C++, we perform name lookup for the translation unit via the
4970 // IdentifierInfo chains, don't bother to build a visible-declarations table.
4971 if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
4972 return;
4973
4974 // Serialize the contents of the mapping used for lookup. Note that,
4975 // although we have two very different code paths, the serialized
4976 // representation is the same for both cases: a declaration name,
4977 // followed by a size, followed by references to the visible
4978 // declarations that have that name.
4979 StoredDeclsMap *Map = DC->buildLookup();
4980 if (!Map || Map->empty())
4981 return;
4982
4983 Offsets.VisibleOffset = Stream.GetCurrentBitNo();
4984 // Create the on-disk hash table in a buffer.
4985 SmallString<4096> LookupTable;
4986 SmallString<4096> ModuleLocalLookupTable;
4987 SmallString<4096> TULookupTable;
4988 GenerateNameLookupTable(Context, DC, LookupTable, ModuleLocalLookupTable,
4989 TULookupTable);
4990
4991 // Write the lookup table
4992 RecordData::value_type Record[] = {DECL_CONTEXT_VISIBLE};
4993 Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
4994 LookupTable);
4995 ++NumVisibleDeclContexts;
4996
4997 if (!ModuleLocalLookupTable.empty()) {
4998 Offsets.ModuleLocalOffset = Stream.GetCurrentBitNo();
4999 assert(Offsets.ModuleLocalOffset > Offsets.VisibleOffset);
5000 // Write the lookup table
5001 RecordData::value_type ModuleLocalRecord[] = {
5003 Stream.EmitRecordWithBlob(DeclModuleLocalVisibleLookupAbbrev,
5004 ModuleLocalRecord, ModuleLocalLookupTable);
5005 ++NumModuleLocalDeclContexts;
5006 }
5007
5008 if (!TULookupTable.empty()) {
5009 Offsets.TULocalOffset = Stream.GetCurrentBitNo();
5010 // Write the lookup table
5011 RecordData::value_type TULocalDeclsRecord[] = {
5013 Stream.EmitRecordWithBlob(DeclTULocalLookupAbbrev, TULocalDeclsRecord,
5014 TULookupTable);
5015 ++NumTULocalDeclContexts;
5016 }
5017}
5018
5019/// Write an UPDATE_VISIBLE block for the given context.
5020///
5021/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
5022/// DeclContext in a dependent AST file. As such, they only exist for the TU
5023/// (in C++), for namespaces, and for classes with forward-declared unscoped
5024/// enumeration members (in C++11).
5025void ASTWriter::WriteDeclContextVisibleUpdate(ASTContext &Context,
5026 const DeclContext *DC) {
5027 StoredDeclsMap *Map = DC->getLookupPtr();
5028 if (!Map || Map->empty())
5029 return;
5030
5031 // Create the on-disk hash table in a buffer.
5032 SmallString<4096> LookupTable;
5033 SmallString<4096> ModuleLocalLookupTable;
5034 SmallString<4096> TULookupTable;
5035 GenerateNameLookupTable(Context, DC, LookupTable, ModuleLocalLookupTable,
5036 TULookupTable);
5037
5038 // If we're updating a namespace, select a key declaration as the key for the
5039 // update record; those are the only ones that will be checked on reload.
5040 if (isa<NamespaceDecl>(DC))
5042
5043 // Write the lookup table
5044 RecordData::value_type Record[] = {UPDATE_VISIBLE,
5045 getDeclID(cast<Decl>(DC)).getRawValue()};
5046 Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable);
5047
5048 if (!ModuleLocalLookupTable.empty()) {
5049 // Write the module local lookup table
5050 RecordData::value_type ModuleLocalRecord[] = {
5051 UPDATE_MODULE_LOCAL_VISIBLE, getDeclID(cast<Decl>(DC)).getRawValue()};
5052 Stream.EmitRecordWithBlob(ModuleLocalUpdateVisibleAbbrev, ModuleLocalRecord,
5053 ModuleLocalLookupTable);
5054 }
5055
5056 if (!TULookupTable.empty()) {
5057 RecordData::value_type GMFRecord[] = {
5058 UPDATE_TU_LOCAL_VISIBLE, getDeclID(cast<Decl>(DC)).getRawValue()};
5059 Stream.EmitRecordWithBlob(TULocalUpdateVisibleAbbrev, GMFRecord,
5060 TULookupTable);
5061 }
5062}
5063
5064/// Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
5065void ASTWriter::WriteFPPragmaOptions(const FPOptionsOverride &Opts) {
5066 RecordData::value_type Record[] = {Opts.getAsOpaqueInt()};
5067 Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
5068}
5069
5070/// Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
5071void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
5072 if (!SemaRef.Context.getLangOpts().OpenCL)
5073 return;
5074
5075 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
5076 RecordData Record;
5077 for (const auto &I:Opts.OptMap) {
5078 AddString(I.getKey(), Record);
5079 auto V = I.getValue();
5080 Record.push_back(V.Supported ? 1 : 0);
5081 Record.push_back(V.Enabled ? 1 : 0);
5082 Record.push_back(V.WithPragma ? 1 : 0);
5083 Record.push_back(V.Avail);
5084 Record.push_back(V.Core);
5085 Record.push_back(V.Opt);
5086 }
5087 Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
5088}
5089void ASTWriter::WriteCUDAPragmas(Sema &SemaRef) {
5090 if (SemaRef.CUDA().ForceHostDeviceDepth > 0) {
5091 RecordData::value_type Record[] = {SemaRef.CUDA().ForceHostDeviceDepth};
5092 Stream.EmitRecord(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH, Record);
5093 }
5094}
5095
5096void ASTWriter::WriteObjCCategories() {
5097 if (ObjCClassesWithCategories.empty())
5098 return;
5099
5100 SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
5101 RecordData Categories;
5102
5103 for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
5104 unsigned Size = 0;
5105 unsigned StartIndex = Categories.size();
5106
5107 ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
5108
5109 // Allocate space for the size.
5110 Categories.push_back(0);
5111
5112 // Add the categories.
5114 Cat = Class->known_categories_begin(),
5115 CatEnd = Class->known_categories_end();
5116 Cat != CatEnd; ++Cat, ++Size) {
5117 assert(getDeclID(*Cat).isValid() && "Bogus category");
5118 AddDeclRef(*Cat, Categories);
5119 }
5120
5121 // Update the size.
5122 Categories[StartIndex] = Size;
5123
5124 // Record this interface -> category map.
5125 ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex };
5126 CategoriesMap.push_back(CatInfo);
5127 }
5128
5129 // Sort the categories map by the definition ID, since the reader will be
5130 // performing binary searches on this information.
5131 llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end());
5132
5133 // Emit the categories map.
5134 using namespace llvm;
5135
5136 auto Abbrev = std::make_shared<BitCodeAbbrev>();
5137 Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
5138 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
5139 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
5140 unsigned AbbrevID = Stream.EmitAbbrev(std::move(Abbrev));
5141
5142 RecordData::value_type Record[] = {OBJC_CATEGORIES_MAP, CategoriesMap.size()};
5143 Stream.EmitRecordWithBlob(AbbrevID, Record,
5144 reinterpret_cast<char *>(CategoriesMap.data()),
5145 CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
5146
5147 // Emit the category lists.
5148 Stream.EmitRecord(OBJC_CATEGORIES, Categories);
5149}
5150
5151void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
5153
5154 if (LPTMap.empty())
5155 return;
5156
5157 RecordData Record;
5158 for (auto &LPTMapEntry : LPTMap) {
5159 const FunctionDecl *FD = LPTMapEntry.first;
5160 LateParsedTemplate &LPT = *LPTMapEntry.second;
5161 AddDeclRef(FD, Record);
5162 AddDeclRef(LPT.D, Record);
5163 Record.push_back(LPT.FPO.getAsOpaqueInt());
5164 Record.push_back(LPT.Toks.size());
5165
5166 for (const auto &Tok : LPT.Toks) {
5167 AddToken(Tok, Record);
5168 }
5169 }
5170 Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record);
5171}
5172
5173/// Write the state of 'pragma clang optimize' at the end of the module.
5174void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
5175 RecordData Record;
5176 SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
5177 AddSourceLocation(PragmaLoc, Record);
5178 Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record);
5179}
5180
5181/// Write the state of 'pragma ms_struct' at the end of the module.
5182void ASTWriter::WriteMSStructPragmaOptions(Sema &SemaRef) {
5183 RecordData Record;
5184 Record.push_back(SemaRef.MSStructPragmaOn ? PMSST_ON : PMSST_OFF);
5185 Stream.EmitRecord(MSSTRUCT_PRAGMA_OPTIONS, Record);
5186}
5187
5188/// Write the state of 'pragma pointers_to_members' at the end of the
5189//module.
5190void ASTWriter::WriteMSPointersToMembersPragmaOptions(Sema &SemaRef) {
5191 RecordData Record;
5193 AddSourceLocation(SemaRef.ImplicitMSInheritanceAttrLoc, Record);
5194 Stream.EmitRecord(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS, Record);
5195}
5196
5197/// Write the state of 'pragma align/pack' at the end of the module.
5198void ASTWriter::WritePackPragmaOptions(Sema &SemaRef) {
5199 // Don't serialize pragma align/pack state for modules, since it should only
5200 // take effect on a per-submodule basis.
5201 if (WritingModule)
5202 return;
5203
5204 RecordData Record;
5205 AddAlignPackInfo(SemaRef.AlignPackStack.CurrentValue, Record);
5206 AddSourceLocation(SemaRef.AlignPackStack.CurrentPragmaLocation, Record);
5207 Record.push_back(SemaRef.AlignPackStack.Stack.size());
5208 for (const auto &StackEntry : SemaRef.AlignPackStack.Stack) {
5209 AddAlignPackInfo(StackEntry.Value, Record);
5210 AddSourceLocation(StackEntry.PragmaLocation, Record);
5211 AddSourceLocation(StackEntry.PragmaPushLocation, Record);
5212 AddString(StackEntry.StackSlotLabel, Record);
5213 }
5214 Stream.EmitRecord(ALIGN_PACK_PRAGMA_OPTIONS, Record);
5215}
5216
5217/// Write the state of 'pragma float_control' at the end of the module.
5218void ASTWriter::WriteFloatControlPragmaOptions(Sema &SemaRef) {
5219 // Don't serialize pragma float_control state for modules,
5220 // since it should only take effect on a per-submodule basis.
5221 if (WritingModule)
5222 return;
5223
5224 RecordData Record;
5225 Record.push_back(SemaRef.FpPragmaStack.CurrentValue.getAsOpaqueInt());
5226 AddSourceLocation(SemaRef.FpPragmaStack.CurrentPragmaLocation, Record);
5227 Record.push_back(SemaRef.FpPragmaStack.Stack.size());
5228 for (const auto &StackEntry : SemaRef.FpPragmaStack.Stack) {
5229 Record.push_back(StackEntry.Value.getAsOpaqueInt());
5230 AddSourceLocation(StackEntry.PragmaLocation, Record);
5231 AddSourceLocation(StackEntry.PragmaPushLocation, Record);
5232 AddString(StackEntry.StackSlotLabel, Record);
5233 }
5234 Stream.EmitRecord(FLOAT_CONTROL_PRAGMA_OPTIONS, Record);
5235}
5236
5237/// Write Sema's collected list of declarations with unverified effects.
5238void ASTWriter::WriteDeclsWithEffectsToVerify(Sema &SemaRef) {
5239 if (SemaRef.DeclsWithEffectsToVerify.empty())
5240 return;
5241 RecordData Record;
5242 for (const auto *D : SemaRef.DeclsWithEffectsToVerify) {
5243 AddDeclRef(D, Record);
5244 }
5245 Stream.EmitRecord(DECLS_WITH_EFFECTS_TO_VERIFY, Record);
5246}
5247
5248void ASTWriter::WriteModuleFileExtension(Sema &SemaRef,
5249 ModuleFileExtensionWriter &Writer) {
5250 // Enter the extension block.
5251 Stream.EnterSubblock(EXTENSION_BLOCK_ID, 4);
5252
5253 // Emit the metadata record abbreviation.
5254 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
5255 Abv->Add(llvm::BitCodeAbbrevOp(EXTENSION_METADATA));
5256 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
5257 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
5258 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
5259 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
5260 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
5261 unsigned Abbrev = Stream.EmitAbbrev(std::move(Abv));
5262
5263 // Emit the metadata record.
5264 RecordData Record;
5265 auto Metadata = Writer.getExtension()->getExtensionMetadata();
5266 Record.push_back(EXTENSION_METADATA);
5267 Record.push_back(Metadata.MajorVersion);
5268 Record.push_back(Metadata.MinorVersion);
5269 Record.push_back(Metadata.BlockName.size());
5270 Record.push_back(Metadata.UserInfo.size());
5271 SmallString<64> Buffer;
5272 Buffer += Metadata.BlockName;
5273 Buffer += Metadata.UserInfo;
5274 Stream.EmitRecordWithBlob(Abbrev, Record, Buffer);
5275
5276 // Emit the contents of the extension block.
5277 Writer.writeExtensionContents(SemaRef, Stream);
5278
5279 // Exit the extension block.
5280 Stream.ExitBlock();
5281}
5282
5283void ASTWriter::WriteRISCVIntrinsicPragmas(Sema &SemaRef) {
5284 RecordData Record;
5285 // Need to update this when new intrinsic class is added.
5286 Record.push_back(/*size*/ 3);
5287 Record.push_back(SemaRef.RISCV().DeclareRVVBuiltins);
5288 Record.push_back(SemaRef.RISCV().DeclareSiFiveVectorBuiltins);
5289 Record.push_back(SemaRef.RISCV().DeclareAndesVectorBuiltins);
5290 Stream.EmitRecord(RISCV_VECTOR_INTRINSICS_PRAGMA, Record);
5291}
5292
5293//===----------------------------------------------------------------------===//
5294// General Serialization Routines
5295//===----------------------------------------------------------------------===//
5296
5298 auto &Record = *this;
5299 // FIXME: Clang can't handle the serialization/deserialization of
5300 // preferred_name properly now. See
5301 // https://github.com/llvm/llvm-project/issues/56490 for example.
5302 if (!A ||
5303 (isa<PreferredNameAttr>(A) && (Writer->isWritingStdCXXNamedModules() ||
5304 Writer->isWritingStdCXXHeaderUnit())))
5305 return Record.push_back(0);
5306
5307 Record.push_back(A->getKind() + 1); // FIXME: stable encoding, target attrs
5308
5309 Record.AddIdentifierRef(A->getAttrName());
5310 Record.AddIdentifierRef(A->getScopeName());
5311 Record.AddSourceRange(A->getRange());
5312 Record.AddSourceLocation(A->getScopeLoc());
5313 Record.push_back(A->getParsedKind());
5314 Record.push_back(A->getSyntax());
5315 Record.push_back(A->getAttributeSpellingListIndexRaw());
5316 Record.push_back(A->isRegularKeywordAttribute());
5317
5318#include "clang/Serialization/AttrPCHWrite.inc"
5319}
5320
5321/// Emit the list of attributes to the specified record.
5323 push_back(Attrs.size());
5324 for (const auto *A : Attrs)
5325 AddAttr(A);
5326}
5327
5329 AddSourceLocation(Tok.getLocation(), Record);
5330 // FIXME: Should translate token kind to a stable encoding.
5331 Record.push_back(Tok.getKind());
5332 // FIXME: Should translate token flags to a stable encoding.
5333 Record.push_back(Tok.getFlags());
5334
5335 if (Tok.isAnnotation()) {
5336 AddSourceLocation(Tok.getAnnotationEndLoc(), Record);
5337 switch (Tok.getKind()) {
5338 case tok::annot_pragma_loop_hint: {
5339 auto *Info = static_cast<PragmaLoopHintInfo *>(Tok.getAnnotationValue());
5340 AddToken(Info->PragmaName, Record);
5341 AddToken(Info->Option, Record);
5342 Record.push_back(Info->Toks.size());
5343 for (const auto &T : Info->Toks)
5344 AddToken(T, Record);
5345 break;
5346 }
5347 case tok::annot_pragma_pack: {
5348 auto *Info =
5349 static_cast<Sema::PragmaPackInfo *>(Tok.getAnnotationValue());
5350 Record.push_back(static_cast<unsigned>(Info->Action));
5351 AddString(Info->SlotLabel, Record);
5352 AddToken(Info->Alignment, Record);
5353 break;
5354 }
5355 // Some annotation tokens do not use the PtrData field.
5356 case tok::annot_pragma_openmp:
5357 case tok::annot_pragma_openmp_end:
5358 case tok::annot_pragma_unused:
5359 case tok::annot_pragma_openacc:
5360 case tok::annot_pragma_openacc_end:
5361 case tok::annot_repl_input_end:
5362 break;
5363 default:
5364 llvm_unreachable("missing serialization code for annotation token");
5365 }
5366 } else {
5367 Record.push_back(Tok.getLength());
5368 // FIXME: When reading literal tokens, reconstruct the literal pointer if it
5369 // is needed.
5370 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
5371 }
5372}
5373
5375 Record.push_back(Str.size());
5376 llvm::append_range(Record, Str);
5377}
5378
5380 SmallVectorImpl<char> &Blob) {
5381 Record.push_back(Str.size());
5382 llvm::append_range(Blob, Str);
5383}
5384
5386 assert(WritingAST && "can't prepare path for output when not writing AST");
5387
5388 // Leave special file names as they are.
5389 StringRef PathStr(Path.data(), Path.size());
5390 if (PathStr == "<built-in>" || PathStr == "<command line>")
5391 return false;
5392
5393 bool Changed =
5394 PP->getFileManager().makeAbsolutePath(Path, /*Canonicalize=*/true);
5395 // Remove a prefix to make the path relative, if relevant.
5396 const char *PathBegin = Path.data();
5397 const char *PathPtr =
5398 adjustFilenameForRelocatableAST(PathBegin, BaseDirectory);
5399 if (PathPtr != PathBegin) {
5400 Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin));
5401 Changed = true;
5402 }
5403
5404 return Changed;
5405}
5406
5408 SmallString<128> FilePath(Path);
5409 PreparePathForOutput(FilePath);
5410 AddString(FilePath, Record);
5411}
5412
5414 SmallVectorImpl<char> &Blob) {
5415 SmallString<128> FilePath(Path);
5416 PreparePathForOutput(FilePath);
5417 AddStringBlob(FilePath, Record, Blob);
5418}
5419
5421 StringRef Path) {
5422 SmallString<128> FilePath(Path);
5423 PreparePathForOutput(FilePath);
5424 Stream.EmitRecordWithBlob(Abbrev, Record, FilePath);
5425}
5426
5427void ASTWriter::AddVersionTuple(const VersionTuple &Version,
5429 Record.push_back(Version.getMajor());
5430 if (std::optional<unsigned> Minor = Version.getMinor())
5431 Record.push_back(*Minor + 1);
5432 else
5433 Record.push_back(0);
5434 if (std::optional<unsigned> Subminor = Version.getSubminor())
5435 Record.push_back(*Subminor + 1);
5436 else
5437 Record.push_back(0);
5438}
5439
5440/// Note that the identifier II occurs at the given offset
5441/// within the identifier table.
5442void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
5443 IdentifierID ID = IdentifierIDs[II];
5444 // Only store offsets new to this AST file. Other identifier names are looked
5445 // up earlier in the chain and thus don't need an offset.
5446 if (!isLocalIdentifierID(ID))
5447 return;
5448
5449 // For local identifiers, the module file index must be 0.
5450
5451 assert(ID != 0);
5453 assert(ID < IdentifierOffsets.size());
5454 IdentifierOffsets[ID] = Offset;
5455}
5456
5457/// Note that the selector Sel occurs at the given offset
5458/// within the method pool/selector table.
5459void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
5460 unsigned ID = SelectorIDs[Sel];
5461 assert(ID && "Unknown selector");
5462 // Don't record offsets for selectors that are also available in a different
5463 // file.
5464 if (ID < FirstSelectorID)
5465 return;
5466 SelectorOffsets[ID - FirstSelectorID] = Offset;
5467}
5468
5469ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream,
5470 SmallVectorImpl<char> &Buffer, ModuleCache &ModCache,
5471 const CodeGenOptions &CodeGenOpts,
5472 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
5473 bool IncludeTimestamps, bool BuildingImplicitModule,
5474 bool GeneratingReducedBMI)
5475 : Stream(Stream), Buffer(Buffer), ModCache(ModCache),
5476 CodeGenOpts(CodeGenOpts), IncludeTimestamps(IncludeTimestamps),
5477 BuildingImplicitModule(BuildingImplicitModule),
5478 GeneratingReducedBMI(GeneratingReducedBMI) {
5479 for (const auto &Ext : Extensions) {
5480 if (auto Writer = Ext->createExtensionWriter(*this))
5481 ModuleFileExtensionWriters.push_back(std::move(Writer));
5482 }
5483}
5484
5485ASTWriter::~ASTWriter() = default;
5486
5488 assert(WritingAST && "can't determine lang opts when not writing AST");
5489 return PP->getLangOpts();
5490}
5491
5492time_t ASTWriter::getTimestampForOutput(time_t ModTime) const {
5493 return IncludeTimestamps ? ModTime : 0;
5494}
5495
5497ASTWriter::WriteAST(llvm::PointerUnion<Sema *, Preprocessor *> Subject,
5498 StringRef OutputFile, Module *WritingModule,
5499 StringRef isysroot, bool ShouldCacheASTInMemory) {
5500 llvm::TimeTraceScope scope("WriteAST", OutputFile);
5501 WritingAST = true;
5502
5503 Sema *SemaPtr = dyn_cast<Sema *>(Subject);
5504 Preprocessor &PPRef =
5505 SemaPtr ? SemaPtr->getPreprocessor() : *cast<Preprocessor *>(Subject);
5506
5507 ASTHasCompilerErrors = PPRef.getDiagnostics().hasUncompilableErrorOccurred();
5508
5509 // Emit the file header.
5510 Stream.Emit((unsigned)'C', 8);
5511 Stream.Emit((unsigned)'P', 8);
5512 Stream.Emit((unsigned)'C', 8);
5513 Stream.Emit((unsigned)'H', 8);
5514
5515 WriteBlockInfoBlock();
5516
5517 PP = &PPRef;
5518 this->WritingModule = WritingModule;
5519 ASTFileSignature Signature = WriteASTCore(SemaPtr, isysroot, WritingModule);
5520 PP = nullptr;
5521 this->WritingModule = nullptr;
5522 this->BaseDirectory.clear();
5523
5524 WritingAST = false;
5525
5526 if (ShouldCacheASTInMemory) {
5527 // Construct MemoryBuffer and update buffer manager.
5528 ModCache.getInMemoryModuleCache().addBuiltPCM(
5529 OutputFile, llvm::MemoryBuffer::getMemBufferCopy(
5530 StringRef(Buffer.begin(), Buffer.size())));
5531 }
5532 return Signature;
5533}
5534
5535template<typename Vector>
5536static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec) {
5537 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
5538 I != E; ++I) {
5539 Writer.GetDeclRef(*I);
5540 }
5541}
5542
5543template <typename Vector>
5546 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
5547 I != E; ++I) {
5548 Writer.AddEmittedDeclRef(*I, Record);
5549 }
5550}
5551
5552void ASTWriter::computeNonAffectingInputFiles() {
5553 SourceManager &SrcMgr = PP->getSourceManager();
5554 unsigned N = SrcMgr.local_sloc_entry_size();
5555
5556 IsSLocAffecting.resize(N, true);
5557 IsSLocFileEntryAffecting.resize(N, true);
5558
5559 if (!WritingModule)
5560 return;
5561
5562 auto AffectingModuleMaps = GetAffectingModuleMaps(*PP, WritingModule);
5563
5564 unsigned FileIDAdjustment = 0;
5565 unsigned OffsetAdjustment = 0;
5566
5567 NonAffectingFileIDAdjustments.reserve(N);
5568 NonAffectingOffsetAdjustments.reserve(N);
5569
5570 NonAffectingFileIDAdjustments.push_back(FileIDAdjustment);
5571 NonAffectingOffsetAdjustments.push_back(OffsetAdjustment);
5572
5573 for (unsigned I = 1; I != N; ++I) {
5574 const SrcMgr::SLocEntry *SLoc = &SrcMgr.getLocalSLocEntry(I);
5575 FileID FID = FileID::get(I);
5576 assert(&SrcMgr.getSLocEntry(FID) == SLoc);
5577
5578 if (!SLoc->isFile())
5579 continue;
5580 const SrcMgr::FileInfo &File = SLoc->getFile();
5581 const SrcMgr::ContentCache *Cache = &File.getContentCache();
5582 if (!Cache->OrigEntry)
5583 continue;
5584
5585 // Don't prune anything other than module maps.
5586 if (!isModuleMap(File.getFileCharacteristic()))
5587 continue;
5588
5589 // Don't prune module maps if all are guaranteed to be affecting.
5590 if (!AffectingModuleMaps)
5591 continue;
5592
5593 // Don't prune module maps that are affecting.
5594 if (AffectingModuleMaps->DefinitionFileIDs.contains(FID))
5595 continue;
5596
5597 IsSLocAffecting[I] = false;
5598 IsSLocFileEntryAffecting[I] =
5599 AffectingModuleMaps->DefinitionFiles.contains(*Cache->OrigEntry);
5600
5601 FileIDAdjustment += 1;
5602 // Even empty files take up one element in the offset table.
5603 OffsetAdjustment += SrcMgr.getFileIDSize(FID) + 1;
5604
5605 // If the previous file was non-affecting as well, just extend its entry
5606 // with our information.
5607 if (!NonAffectingFileIDs.empty() &&
5608 NonAffectingFileIDs.back().ID == FID.ID - 1) {
5609 NonAffectingFileIDs.back() = FID;
5610 NonAffectingRanges.back().setEnd(SrcMgr.getLocForEndOfFile(FID));
5611 NonAffectingFileIDAdjustments.back() = FileIDAdjustment;
5612 NonAffectingOffsetAdjustments.back() = OffsetAdjustment;
5613 continue;
5614 }
5615
5616 NonAffectingFileIDs.push_back(FID);
5617 NonAffectingRanges.emplace_back(SrcMgr.getLocForStartOfFile(FID),
5618 SrcMgr.getLocForEndOfFile(FID));
5619 NonAffectingFileIDAdjustments.push_back(FileIDAdjustment);
5620 NonAffectingOffsetAdjustments.push_back(OffsetAdjustment);
5621 }
5622
5623 if (!PP->getHeaderSearchInfo().getHeaderSearchOpts().ModulesIncludeVFSUsage)
5624 return;
5625
5626 FileManager &FileMgr = PP->getFileManager();
5627 FileMgr.trackVFSUsage(true);
5628 // Lookup the paths in the VFS to trigger `-ivfsoverlay` usage tracking.
5629 for (StringRef Path :
5630 PP->getHeaderSearchInfo().getHeaderSearchOpts().VFSOverlayFiles)
5631 FileMgr.getVirtualFileSystem().exists(Path);
5632 for (unsigned I = 1; I != N; ++I) {
5633 if (IsSLocAffecting[I]) {
5634 const SrcMgr::SLocEntry *SLoc = &SrcMgr.getLocalSLocEntry(I);
5635 if (!SLoc->isFile())
5636 continue;
5637 const SrcMgr::FileInfo &File = SLoc->getFile();
5638 const SrcMgr::ContentCache *Cache = &File.getContentCache();
5639 if (!Cache->OrigEntry)
5640 continue;
5641 FileMgr.getVirtualFileSystem().exists(
5642 Cache->OrigEntry->getNameAsRequested());
5643 }
5644 }
5645 FileMgr.trackVFSUsage(false);
5646}
5647
5648void ASTWriter::prepareLazyUpdates() {
5649 // In C++20 named modules with reduced BMI, we only apply the update
5650 // if these updates are touched.
5651 if (!GeneratingReducedBMI)
5652 return;
5653
5654 DeclUpdateMap DeclUpdatesTmp;
5655 // Move updates to DeclUpdatesLazy but leave CXXAddedFunctionDefinition as is.
5656 // Since added function definition is critical to the AST. If we don't take
5657 // care of it, user might meet missing definition error at linking time.
5658 // Here we leave all CXXAddedFunctionDefinition unconditionally to avoid
5659 // potential issues.
5660 // TODO: Try to refine the strategy to handle CXXAddedFunctionDefinition
5661 // precisely.
5662 for (auto &DeclUpdate : DeclUpdates) {
5663 const Decl *D = DeclUpdate.first;
5664
5665 for (auto &Update : DeclUpdate.second) {
5666 DeclUpdateKind Kind = Update.getKind();
5667
5668 if (Kind == DeclUpdateKind::CXXAddedFunctionDefinition)
5669 DeclUpdatesTmp[D].push_back(
5670 ASTWriter::DeclUpdate(DeclUpdateKind::CXXAddedFunctionDefinition));
5671 else
5672 DeclUpdatesLazy[D].push_back(Update);
5673 }
5674 }
5675 DeclUpdates.swap(DeclUpdatesTmp);
5676
5677 UpdatedDeclContextsLazy.swap(UpdatedDeclContexts);
5678 // In reduced BMI, we don't have decls have to emit even if unreferenced.
5679 DeclsToEmitEvenIfUnreferenced.clear();
5680}
5681
5682void ASTWriter::PrepareWritingSpecialDecls(Sema &SemaRef) {
5683 ASTContext &Context = SemaRef.Context;
5684
5685 bool isModule = WritingModule != nullptr;
5686
5687 prepareLazyUpdates();
5688
5689 // Set up predefined declaration IDs.
5690 auto RegisterPredefDecl = [&] (Decl *D, PredefinedDeclIDs ID) {
5691 if (D) {
5692 assert(D->isCanonicalDecl() && "predefined decl is not canonical");
5693 DeclIDs[D] = ID;
5694 PredefinedDecls.insert(D);
5695 }
5696 };
5697 RegisterPredefDecl(Context.getTranslationUnitDecl(),
5699 RegisterPredefDecl(Context.ObjCIdDecl, PREDEF_DECL_OBJC_ID_ID);
5700 RegisterPredefDecl(Context.ObjCSelDecl, PREDEF_DECL_OBJC_SEL_ID);
5701 RegisterPredefDecl(Context.ObjCClassDecl, PREDEF_DECL_OBJC_CLASS_ID);
5702 RegisterPredefDecl(Context.ObjCProtocolClassDecl,
5704 RegisterPredefDecl(Context.Int128Decl, PREDEF_DECL_INT_128_ID);
5705 RegisterPredefDecl(Context.UInt128Decl, PREDEF_DECL_UNSIGNED_INT_128_ID);
5706 RegisterPredefDecl(Context.ObjCInstanceTypeDecl,
5708 RegisterPredefDecl(Context.BuiltinVaListDecl, PREDEF_DECL_BUILTIN_VA_LIST_ID);
5709 RegisterPredefDecl(Context.VaListTagDecl, PREDEF_DECL_VA_LIST_TAG);
5710 RegisterPredefDecl(Context.BuiltinMSVaListDecl,
5712 RegisterPredefDecl(Context.MSGuidTagDecl,
5714 RegisterPredefDecl(Context.MSTypeInfoTagDecl,
5716 RegisterPredefDecl(Context.ExternCContext, PREDEF_DECL_EXTERN_C_CONTEXT_ID);
5717 RegisterPredefDecl(Context.CFConstantStringTypeDecl,
5719 RegisterPredefDecl(Context.CFConstantStringTagDecl,
5721#define BuiltinTemplate(BTName) \
5722 RegisterPredefDecl(Context.Decl##BTName, PREDEF_DECL##BTName##_ID);
5723#include "clang/Basic/BuiltinTemplates.inc"
5724
5725 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
5726
5727 // Force all top level declarations to be emitted.
5728 //
5729 // We start emitting top level declarations from the module purview to
5730 // implement the eliding unreachable declaration feature.
5731 for (const auto *D : TU->noload_decls()) {
5732 if (D->isFromASTFile())
5733 continue;
5734
5735 if (GeneratingReducedBMI) {
5737 continue;
5738
5739 // Don't force emitting static entities.
5740 //
5741 // Technically, all static entities shouldn't be in reduced BMI. The
5742 // language also specifies that the program exposes TU-local entities
5743 // is ill-formed. However, in practice, there are a lot of projects
5744 // uses `static inline` in the headers. So we can't get rid of all
5745 // static entities in reduced BMI now.
5747 continue;
5748 }
5749
5750 // If we're writing C++ named modules, don't emit declarations which are
5751 // not from modules by default. They may be built in declarations (be
5752 // handled above) or implcit declarations (see the implementation of
5753 // `Sema::Initialize()` for example).
5755 D->isImplicit())
5756 continue;
5757
5758 GetDeclRef(D);
5759 }
5760
5761 if (GeneratingReducedBMI)
5762 return;
5763
5764 // Writing all of the tentative definitions in this file, in
5765 // TentativeDefinitions order. Generally, this record will be empty for
5766 // headers.
5768
5769 // Writing all of the file scoped decls in this file.
5770 if (!isModule)
5772
5773 // Writing all of the delegating constructors we still need
5774 // to resolve.
5775 if (!isModule)
5777
5778 // Writing all of the ext_vector declarations.
5779 AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls);
5780
5781 // Writing all of the VTable uses information.
5782 if (!SemaRef.VTableUses.empty())
5783 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I)
5784 GetDeclRef(SemaRef.VTableUses[I].first);
5785
5786 // Writing all of the UnusedLocalTypedefNameCandidates.
5787 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
5788 GetDeclRef(TD);
5789
5790 // Writing all of pending implicit instantiations.
5791 for (const auto &I : SemaRef.PendingInstantiations)
5792 GetDeclRef(I.first);
5793 assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
5794 "There are local ones at end of translation unit!");
5795
5796 // Writing some declaration references.
5797 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc || SemaRef.StdAlignValT) {
5798 GetDeclRef(SemaRef.getStdNamespace());
5799 GetDeclRef(SemaRef.getStdBadAlloc());
5800 GetDeclRef(SemaRef.getStdAlignValT());
5801 }
5802
5803 if (Context.getcudaConfigureCallDecl() ||
5805 Context.getcudaLaunchDeviceDecl()) {
5809 }
5810
5811 // Writing all of the known namespaces.
5812 for (const auto &I : SemaRef.KnownNamespaces)
5813 if (!I.second)
5814 GetDeclRef(I.first);
5815
5816 // Writing all used, undefined objects that require definitions.
5817 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
5819 for (const auto &I : Undefined)
5820 GetDeclRef(I.first);
5821
5822 // Writing all delete-expressions that we would like to
5823 // analyze later in AST.
5824 if (!isModule)
5825 for (const auto &DeleteExprsInfo :
5827 GetDeclRef(DeleteExprsInfo.first);
5828
5829 // Make sure visible decls, added to DeclContexts previously loaded from
5830 // an AST file, are registered for serialization. Likewise for template
5831 // specializations added to imported templates.
5832 for (const auto *I : DeclsToEmitEvenIfUnreferenced)
5833 GetDeclRef(I);
5834 DeclsToEmitEvenIfUnreferenced.clear();
5835
5836 // Make sure all decls associated with an identifier are registered for
5837 // serialization, if we're storing decls with identifiers.
5838 if (!WritingModule || !getLangOpts().CPlusPlus) {
5839 llvm::SmallVector<const IdentifierInfo*, 256> IIs;
5840 for (const auto &ID : SemaRef.PP.getIdentifierTable()) {
5841 const IdentifierInfo *II = ID.second;
5842 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization() ||
5844 IIs.push_back(II);
5845 }
5846 // Sort the identifiers to visit based on their name.
5847 llvm::sort(IIs, llvm::deref<std::less<>>());
5848 const LangOptions &LangOpts = getLangOpts();
5849 for (const IdentifierInfo *II : IIs)
5850 for (NamedDecl *D : SemaRef.IdResolver.decls(II))
5851 GetDeclRef(getDeclForLocalLookup(LangOpts, D));
5852 }
5853
5854 // Write all of the DeclsToCheckForDeferredDiags.
5855 for (auto *D : SemaRef.DeclsToCheckForDeferredDiags)
5856 GetDeclRef(D);
5857
5858 // Write all classes that need to emit the vtable definitions if required.
5860 for (CXXRecordDecl *RD : PendingEmittingVTables)
5861 GetDeclRef(RD);
5862 else
5863 PendingEmittingVTables.clear();
5864}
5865
5866void ASTWriter::WriteSpecialDeclRecords(Sema &SemaRef) {
5867 ASTContext &Context = SemaRef.Context;
5868
5869 bool isModule = WritingModule != nullptr;
5870
5871 // Write the record containing external, unnamed definitions.
5872 if (!EagerlyDeserializedDecls.empty())
5873 Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls);
5874
5875 if (!ModularCodegenDecls.empty())
5876 Stream.EmitRecord(MODULAR_CODEGEN_DECLS, ModularCodegenDecls);
5877
5878 // Write the record containing tentative definitions.
5879 RecordData TentativeDefinitions;
5881 TentativeDefinitions);
5882 if (!TentativeDefinitions.empty())
5883 Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
5884
5885 // Write the record containing unused file scoped decls.
5886 RecordData UnusedFileScopedDecls;
5887 if (!isModule)
5889 UnusedFileScopedDecls);
5890 if (!UnusedFileScopedDecls.empty())
5891 Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
5892
5893 // Write the record containing ext_vector type names.
5894 RecordData ExtVectorDecls;
5895 AddLazyVectorEmiitedDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
5896 if (!ExtVectorDecls.empty())
5897 Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
5898
5899 // Write the record containing VTable uses information.
5900 RecordData VTableUses;
5901 if (!SemaRef.VTableUses.empty()) {
5902 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
5903 CXXRecordDecl *D = SemaRef.VTableUses[I].first;
5904 if (!wasDeclEmitted(D))
5905 continue;
5906
5907 AddDeclRef(D, VTableUses);
5908 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
5909 VTableUses.push_back(SemaRef.VTablesUsed[D]);
5910 }
5911 Stream.EmitRecord(VTABLE_USES, VTableUses);
5912 }
5913
5914 // Write the record containing potentially unused local typedefs.
5915 RecordData UnusedLocalTypedefNameCandidates;
5916 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
5917 AddEmittedDeclRef(TD, UnusedLocalTypedefNameCandidates);
5918 if (!UnusedLocalTypedefNameCandidates.empty())
5919 Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
5920 UnusedLocalTypedefNameCandidates);
5921
5922 if (!GeneratingReducedBMI) {
5923 // Write the record containing pending implicit instantiations.
5924 RecordData PendingInstantiations;
5925 for (const auto &I : SemaRef.PendingInstantiations) {
5926 if (!wasDeclEmitted(I.first))
5927 continue;
5928
5929 AddDeclRef(I.first, PendingInstantiations);
5930 AddSourceLocation(I.second, PendingInstantiations);
5931 }
5932 if (!PendingInstantiations.empty())
5933 Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
5934 }
5935
5936 auto AddEmittedDeclRefOrZero = [this](RecordData &Refs, Decl *D) {
5937 if (!D || !wasDeclEmitted(D))
5938 Refs.push_back(0);
5939 else
5940 AddDeclRef(D, Refs);
5941 };
5942
5943 // Write the record containing declaration references of Sema.
5944 RecordData SemaDeclRefs;
5945 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc || SemaRef.StdAlignValT) {
5946 AddEmittedDeclRefOrZero(SemaDeclRefs, SemaRef.getStdNamespace());
5947 AddEmittedDeclRefOrZero(SemaDeclRefs, SemaRef.getStdBadAlloc());
5948 AddEmittedDeclRefOrZero(SemaDeclRefs, SemaRef.getStdAlignValT());
5949 }
5950 if (!SemaDeclRefs.empty())
5951 Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
5952
5953 // Write the record containing decls to be checked for deferred diags.
5954 RecordData DeclsToCheckForDeferredDiags;
5955 for (auto *D : SemaRef.DeclsToCheckForDeferredDiags)
5956 if (wasDeclEmitted(D))
5957 AddDeclRef(D, DeclsToCheckForDeferredDiags);
5958 if (!DeclsToCheckForDeferredDiags.empty())
5959 Stream.EmitRecord(DECLS_TO_CHECK_FOR_DEFERRED_DIAGS,
5960 DeclsToCheckForDeferredDiags);
5961
5962 // Write the record containing CUDA-specific declaration references.
5963 RecordData CUDASpecialDeclRefs;
5964 if (auto *CudaCallDecl = Context.getcudaConfigureCallDecl(),
5965 *CudaGetParamDecl = Context.getcudaGetParameterBufferDecl(),
5966 *CudaLaunchDecl = Context.getcudaLaunchDeviceDecl();
5967 CudaCallDecl || CudaGetParamDecl || CudaLaunchDecl) {
5968 AddEmittedDeclRefOrZero(CUDASpecialDeclRefs, CudaCallDecl);
5969 AddEmittedDeclRefOrZero(CUDASpecialDeclRefs, CudaGetParamDecl);
5970 AddEmittedDeclRefOrZero(CUDASpecialDeclRefs, CudaLaunchDecl);
5971 Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
5972 }
5973
5974 // Write the delegating constructors.
5975 RecordData DelegatingCtorDecls;
5976 if (!isModule)
5978 DelegatingCtorDecls);
5979 if (!DelegatingCtorDecls.empty())
5980 Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
5981
5982 // Write the known namespaces.
5983 RecordData KnownNamespaces;
5984 for (const auto &I : SemaRef.KnownNamespaces) {
5985 if (!I.second && wasDeclEmitted(I.first))
5986 AddDeclRef(I.first, KnownNamespaces);
5987 }
5988 if (!KnownNamespaces.empty())
5989 Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
5990
5991 // Write the undefined internal functions and variables, and inline functions.
5992 RecordData UndefinedButUsed;
5993 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
5995 for (const auto &I : Undefined) {
5996 if (!wasDeclEmitted(I.first))
5997 continue;
5998
5999 AddDeclRef(I.first, UndefinedButUsed);
6000 AddSourceLocation(I.second, UndefinedButUsed);
6001 }
6002 if (!UndefinedButUsed.empty())
6003 Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed);
6004
6005 // Write all delete-expressions that we would like to
6006 // analyze later in AST.
6007 RecordData DeleteExprsToAnalyze;
6008 if (!isModule) {
6009 for (const auto &DeleteExprsInfo :
6011 if (!wasDeclEmitted(DeleteExprsInfo.first))
6012 continue;
6013
6014 AddDeclRef(DeleteExprsInfo.first, DeleteExprsToAnalyze);
6015 DeleteExprsToAnalyze.push_back(DeleteExprsInfo.second.size());
6016 for (const auto &DeleteLoc : DeleteExprsInfo.second) {
6017 AddSourceLocation(DeleteLoc.first, DeleteExprsToAnalyze);
6018 DeleteExprsToAnalyze.push_back(DeleteLoc.second);
6019 }
6020 }
6021 }
6022 if (!DeleteExprsToAnalyze.empty())
6023 Stream.EmitRecord(DELETE_EXPRS_TO_ANALYZE, DeleteExprsToAnalyze);
6024
6025 RecordData VTablesToEmit;
6026 for (CXXRecordDecl *RD : PendingEmittingVTables) {
6027 if (!wasDeclEmitted(RD))
6028 continue;
6029
6030 AddDeclRef(RD, VTablesToEmit);
6031 }
6032
6033 if (!VTablesToEmit.empty())
6034 Stream.EmitRecord(VTABLES_TO_EMIT, VTablesToEmit);
6035}
6036
6037ASTFileSignature ASTWriter::WriteASTCore(Sema *SemaPtr, StringRef isysroot,
6038 Module *WritingModule) {
6039 using namespace llvm;
6040
6041 bool isModule = WritingModule != nullptr;
6042
6043 // Make sure that the AST reader knows to finalize itself.
6044 if (Chain)
6045 Chain->finalizeForWriting();
6046
6047 // This needs to be done very early, since everything that writes
6048 // SourceLocations or FileIDs depends on it.
6049 computeNonAffectingInputFiles();
6050
6051 writeUnhashedControlBlock(*PP);
6052
6053 // Don't reuse type ID and Identifier ID from readers for C++ standard named
6054 // modules since we want to support no-transitive-change model for named
6055 // modules. The theory for no-transitive-change model is,
6056 // for a user of a named module, the user can only access the indirectly
6057 // imported decls via the directly imported module. So that it is possible to
6058 // control what matters to the users when writing the module. It would be
6059 // problematic if the users can reuse the type IDs and identifier IDs from
6060 // indirectly imported modules arbitrarily. So we choose to clear these ID
6061 // here.
6063 TypeIdxs.clear();
6064 IdentifierIDs.clear();
6065 }
6066
6067 // Look for any identifiers that were named while processing the
6068 // headers, but are otherwise not needed. We add these to the hash
6069 // table to enable checking of the predefines buffer in the case
6070 // where the user adds new macro definitions when building the AST
6071 // file.
6072 //
6073 // We do this before emitting any Decl and Types to make sure the
6074 // Identifier ID is stable.
6075 SmallVector<const IdentifierInfo *, 128> IIs;
6076 for (const auto &ID : PP->getIdentifierTable())
6077 if (IsInterestingNonMacroIdentifier(ID.second, *this))
6078 IIs.push_back(ID.second);
6079 // Sort the identifiers lexicographically before getting the references so
6080 // that their order is stable.
6081 llvm::sort(IIs, llvm::deref<std::less<>>());
6082 for (const IdentifierInfo *II : IIs)
6083 getIdentifierRef(II);
6084
6085 // Write the set of weak, undeclared identifiers. We always write the
6086 // entire table, since later PCH files in a PCH chain are only interested in
6087 // the results at the end of the chain.
6088 RecordData WeakUndeclaredIdentifiers;
6089 if (SemaPtr) {
6090 for (const auto &WeakUndeclaredIdentifierList :
6091 SemaPtr->WeakUndeclaredIdentifiers) {
6092 const IdentifierInfo *const II = WeakUndeclaredIdentifierList.first;
6093 for (const auto &WI : WeakUndeclaredIdentifierList.second) {
6094 AddIdentifierRef(II, WeakUndeclaredIdentifiers);
6095 AddIdentifierRef(WI.getAlias(), WeakUndeclaredIdentifiers);
6096 AddSourceLocation(WI.getLocation(), WeakUndeclaredIdentifiers);
6097 }
6098 }
6099 }
6100
6101 // Write the set of #pragma redefine_extname'd, undeclared identifiers. We
6102 // always write the entire table, since later PCH files in a PCH chain are
6103 // only interested in the results at the end of the chain.
6104 RecordData ExtnameUndeclaredIdentifiers;
6105 if (SemaPtr && !isWritingStdCXXNamedModules()) {
6106 ASTContext &Context = SemaPtr->Context;
6107 ASTRecordWriter ExtnameUndeclaredIdentifiersWriter(
6108 Context, *this, ExtnameUndeclaredIdentifiers);
6109 for (const auto &[II, AL] : SemaPtr->ExtnameUndeclaredIdentifiers) {
6110 ExtnameUndeclaredIdentifiersWriter.AddIdentifierRef(II);
6111 ExtnameUndeclaredIdentifiersWriter.AddIdentifierRef(
6112 &Context.Idents.get(AL->getLabel()));
6113 ExtnameUndeclaredIdentifiersWriter.AddSourceLocation(AL->getLocation());
6114 }
6115 }
6116
6117 // Form the record of special types.
6118 RecordData SpecialTypes;
6119 if (SemaPtr) {
6120 ASTContext &Context = SemaPtr->Context;
6121 AddTypeRef(Context, Context.getRawCFConstantStringType(), SpecialTypes);
6122 AddTypeRef(Context, Context.getFILEType(), SpecialTypes);
6123 AddTypeRef(Context, Context.getjmp_bufType(), SpecialTypes);
6124 AddTypeRef(Context, Context.getsigjmp_bufType(), SpecialTypes);
6125 AddTypeRef(Context, Context.ObjCIdRedefinitionType, SpecialTypes);
6126 AddTypeRef(Context, Context.ObjCClassRedefinitionType, SpecialTypes);
6127 AddTypeRef(Context, Context.ObjCSelRedefinitionType, SpecialTypes);
6128 AddTypeRef(Context, Context.getucontext_tType(), SpecialTypes);
6129 }
6130
6131 if (SemaPtr)
6132 PrepareWritingSpecialDecls(*SemaPtr);
6133
6134 // Write the control block
6135 WriteControlBlock(*PP, isysroot);
6136
6137 // Write the remaining AST contents.
6138 Stream.FlushToWord();
6139 ASTBlockRange.first = Stream.GetCurrentBitNo() >> 3;
6140 Stream.EnterSubblock(AST_BLOCK_ID, 5);
6141 ASTBlockStartOffset = Stream.GetCurrentBitNo();
6142
6143 // This is so that older clang versions, before the introduction
6144 // of the control block, can read and reject the newer PCH format.
6145 {
6147 Stream.EmitRecord(METADATA_OLD_FORMAT, Record);
6148 }
6149
6150 // For method pool in the module, if it contains an entry for a selector,
6151 // the entry should be complete, containing everything introduced by that
6152 // module and all modules it imports. It's possible that the entry is out of
6153 // date, so we need to pull in the new content here.
6154
6155 // It's possible that updateOutOfDateSelector can update SelectorIDs. To be
6156 // safe, we copy all selectors out.
6157 if (SemaPtr) {
6158 llvm::SmallVector<Selector, 256> AllSelectors;
6159 for (auto &SelectorAndID : SelectorIDs)
6160 AllSelectors.push_back(SelectorAndID.first);
6161 for (auto &Selector : AllSelectors)
6162 SemaPtr->ObjC().updateOutOfDateSelector(Selector);
6163 }
6164
6165 if (Chain) {
6166 // Write the mapping information describing our module dependencies and how
6167 // each of those modules were mapped into our own offset/ID space, so that
6168 // the reader can build the appropriate mapping to its own offset/ID space.
6169 // The map consists solely of a blob with the following format:
6170 // *(module-kind:i8
6171 // module-name-len:i16 module-name:len*i8
6172 // source-location-offset:i32
6173 // identifier-id:i32
6174 // preprocessed-entity-id:i32
6175 // macro-definition-id:i32
6176 // submodule-id:i32
6177 // selector-id:i32
6178 // declaration-id:i32
6179 // c++-base-specifiers-id:i32
6180 // type-id:i32)
6181 //
6182 // module-kind is the ModuleKind enum value. If it is MK_PrebuiltModule,
6183 // MK_ExplicitModule or MK_ImplicitModule, then the module-name is the
6184 // module name. Otherwise, it is the module file name.
6185 auto Abbrev = std::make_shared<BitCodeAbbrev>();
6186 Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
6187 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
6188 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
6189 SmallString<2048> Buffer;
6190 {
6191 llvm::raw_svector_ostream Out(Buffer);
6192 for (ModuleFile &M : Chain->ModuleMgr) {
6193 using namespace llvm::support;
6194
6195 endian::Writer LE(Out, llvm::endianness::little);
6196 LE.write<uint8_t>(static_cast<uint8_t>(M.Kind));
6197 // FIXME: Storing a PCH's name (M.FileName) as a string does not handle
6198 // relocatable files. We probably should call
6199 // `PreparePathForOutput(M.FileName)` to properly support relocatable
6200 // PCHs.
6201 StringRef Name = M.isModule() ? M.ModuleName : M.FileName.str();
6202 LE.write<uint16_t>(Name.size());
6203 Out.write(Name.data(), Name.size());
6204
6205 // Note: if a base ID was uint max, it would not be possible to load
6206 // another module after it or have more than one entity inside it.
6207 uint32_t None = std::numeric_limits<uint32_t>::max();
6208
6209 auto writeBaseIDOrNone = [&](auto BaseID, bool ShouldWrite) {
6210 assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
6211 if (ShouldWrite)
6212 LE.write<uint32_t>(BaseID);
6213 else
6214 LE.write<uint32_t>(None);
6215 };
6216
6217 // These values should be unique within a chain, since they will be read
6218 // as keys into ContinuousRangeMaps.
6219 writeBaseIDOrNone(M.BaseSubmoduleID, M.LocalNumSubmodules);
6220 writeBaseIDOrNone(M.BaseSelectorID, M.LocalNumSelectors);
6221 }
6222 }
6223 RecordData::value_type Record[] = {MODULE_OFFSET_MAP};
6224 Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
6225 Buffer.data(), Buffer.size());
6226 }
6227
6228 if (SemaPtr)
6229 WriteDeclAndTypes(SemaPtr->Context);
6230
6231 WriteFileDeclIDsMap();
6232 WriteSourceManagerBlock(PP->getSourceManager());
6233 if (SemaPtr)
6234 WriteComments(SemaPtr->Context);
6235 WritePreprocessor(*PP, isModule);
6236 WriteHeaderSearch(PP->getHeaderSearchInfo());
6237 if (SemaPtr) {
6238 WriteSelectors(*SemaPtr);
6239 WriteReferencedSelectorsPool(*SemaPtr);
6240 WriteLateParsedTemplates(*SemaPtr);
6241 }
6242 WriteIdentifierTable(*PP, SemaPtr ? &SemaPtr->IdResolver : nullptr, isModule);
6243 if (SemaPtr) {
6244 WriteFPPragmaOptions(SemaPtr->CurFPFeatureOverrides());
6245 WriteOpenCLExtensions(*SemaPtr);
6246 WriteCUDAPragmas(*SemaPtr);
6247 WriteRISCVIntrinsicPragmas(*SemaPtr);
6248 }
6249
6250 // If we're emitting a module, write out the submodule information.
6251 if (WritingModule)
6252 WriteSubmodules(WritingModule, SemaPtr ? &SemaPtr->Context : nullptr);
6253
6254 Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
6255
6256 if (SemaPtr)
6257 WriteSpecialDeclRecords(*SemaPtr);
6258
6259 // Write the record containing weak undeclared identifiers.
6260 if (!WeakUndeclaredIdentifiers.empty())
6261 Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
6262 WeakUndeclaredIdentifiers);
6263
6264 // Write the record containing #pragma redefine_extname'd undeclared
6265 // identifiers.
6266 if (!ExtnameUndeclaredIdentifiers.empty())
6267 Stream.EmitRecord(EXTNAME_UNDECLARED_IDENTIFIERS,
6268 ExtnameUndeclaredIdentifiers);
6269
6270 if (!WritingModule) {
6271 // Write the submodules that were imported, if any.
6272 struct ModuleInfo {
6273 uint64_t ID;
6274 Module *M;
6275 ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
6276 };
6277 llvm::SmallVector<ModuleInfo, 64> Imports;
6278 if (SemaPtr) {
6279 for (const auto *I : SemaPtr->Context.local_imports()) {
6280 assert(SubmoduleIDs.contains(I->getImportedModule()));
6281 Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()],
6282 I->getImportedModule()));
6283 }
6284 }
6285
6286 if (!Imports.empty()) {
6287 auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
6288 return A.ID < B.ID;
6289 };
6290 auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
6291 return A.ID == B.ID;
6292 };
6293
6294 // Sort and deduplicate module IDs.
6295 llvm::sort(Imports, Cmp);
6296 Imports.erase(llvm::unique(Imports, Eq), Imports.end());
6297
6298 RecordData ImportedModules;
6299 for (const auto &Import : Imports) {
6300 ImportedModules.push_back(Import.ID);
6301 // FIXME: If the module has macros imported then later has declarations
6302 // imported, this location won't be the right one as a location for the
6303 // declaration imports.
6304 AddSourceLocation(PP->getModuleImportLoc(Import.M), ImportedModules);
6305 }
6306
6307 Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
6308 }
6309 }
6310
6311 WriteObjCCategories();
6312 if (SemaPtr) {
6313 if (!WritingModule) {
6314 WriteOptimizePragmaOptions(*SemaPtr);
6315 WriteMSStructPragmaOptions(*SemaPtr);
6316 WriteMSPointersToMembersPragmaOptions(*SemaPtr);
6317 }
6318 WritePackPragmaOptions(*SemaPtr);
6319 WriteFloatControlPragmaOptions(*SemaPtr);
6320 WriteDeclsWithEffectsToVerify(*SemaPtr);
6321 }
6322
6323 // Some simple statistics
6324 RecordData::value_type Record[] = {NumStatements,
6325 NumMacros,
6326 NumLexicalDeclContexts,
6327 NumVisibleDeclContexts,
6328 NumModuleLocalDeclContexts,
6329 NumTULocalDeclContexts};
6330 Stream.EmitRecord(STATISTICS, Record);
6331 Stream.ExitBlock();
6332 Stream.FlushToWord();
6333 ASTBlockRange.second = Stream.GetCurrentBitNo() >> 3;
6334
6335 // Write the module file extension blocks.
6336 if (SemaPtr)
6337 for (const auto &ExtWriter : ModuleFileExtensionWriters)
6338 WriteModuleFileExtension(*SemaPtr, *ExtWriter);
6339
6340 return backpatchSignature();
6341}
6342
6343// Add update records for all mangling numbers and static local numbers.
6344// These aren't really update records, but this is a convenient way of
6345// tagging this rare extra data onto the declarations.
6346void ASTWriter::AddedManglingNumber(const Decl *D, unsigned Number) {
6347 if (D->isFromASTFile())
6348 return;
6349
6350 DeclUpdates[D].push_back(DeclUpdate(DeclUpdateKind::ManglingNumber, Number));
6351}
6352void ASTWriter::AddedStaticLocalNumbers(const Decl *D, unsigned Number) {
6353 if (D->isFromASTFile())
6354 return;
6355
6356 DeclUpdates[D].push_back(
6357 DeclUpdate(DeclUpdateKind::StaticLocalNumber, Number));
6358}
6359
6360void ASTWriter::AddedAnonymousNamespace(const TranslationUnitDecl *TU,
6361 NamespaceDecl *AnonNamespace) {
6362 // If the translation unit has an anonymous namespace, and we don't already
6363 // have an update block for it, write it as an update block.
6364 // FIXME: Why do we not do this if there's already an update block?
6365 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
6366 ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
6367 if (Record.empty())
6368 Record.push_back(
6369 DeclUpdate(DeclUpdateKind::CXXAddedAnonymousNamespace, NS));
6370 }
6371}
6372
6373void ASTWriter::WriteDeclAndTypes(ASTContext &Context) {
6374 // Keep writing types, declarations, and declaration update records
6375 // until we've emitted all of them.
6376 RecordData DeclUpdatesOffsetsRecord;
6377 Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/ 6);
6378 DeclTypesBlockStartOffset = Stream.GetCurrentBitNo();
6379 WriteTypeAbbrevs();
6380 WriteDeclAbbrevs();
6381 do {
6382 WriteDeclUpdatesBlocks(Context, DeclUpdatesOffsetsRecord);
6383 while (!DeclTypesToEmit.empty()) {
6384 DeclOrType DOT = DeclTypesToEmit.front();
6385 DeclTypesToEmit.pop();
6386 if (DOT.isType())
6387 WriteType(Context, DOT.getType());
6388 else
6389 WriteDecl(Context, DOT.getDecl());
6390 }
6391 } while (!DeclUpdates.empty());
6392
6393 DoneWritingDeclsAndTypes = true;
6394
6395 // DelayedNamespace is only meaningful in reduced BMI.
6396 // See the comments of DelayedNamespace for details.
6397 assert(DelayedNamespace.empty() || GeneratingReducedBMI);
6398 RecordData DelayedNamespaceRecord;
6399 for (NamespaceDecl *NS : DelayedNamespace) {
6400 LookupBlockOffsets Offsets;
6401
6402 Offsets.LexicalOffset = WriteDeclContextLexicalBlock(Context, NS);
6403 WriteDeclContextVisibleBlock(Context, NS, Offsets);
6404
6405 if (Offsets.LexicalOffset)
6406 Offsets.LexicalOffset -= DeclTypesBlockStartOffset;
6407
6408 // Write the offset relative to current block.
6409 if (Offsets.VisibleOffset)
6410 Offsets.VisibleOffset -= DeclTypesBlockStartOffset;
6411
6412 if (Offsets.ModuleLocalOffset)
6413 Offsets.ModuleLocalOffset -= DeclTypesBlockStartOffset;
6414
6415 if (Offsets.TULocalOffset)
6416 Offsets.TULocalOffset -= DeclTypesBlockStartOffset;
6417
6418 AddDeclRef(NS, DelayedNamespaceRecord);
6419 AddLookupOffsets(Offsets, DelayedNamespaceRecord);
6420 }
6421
6422 // The process of writing lexical and visible block for delayed namespace
6423 // shouldn't introduce any new decls, types or update to emit.
6424 assert(DeclTypesToEmit.empty());
6425 assert(DeclUpdates.empty());
6426
6427 Stream.ExitBlock();
6428
6429 // These things can only be done once we've written out decls and types.
6430 WriteTypeDeclOffsets();
6431 if (!DeclUpdatesOffsetsRecord.empty())
6432 Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord);
6433
6434 if (!DelayedNamespaceRecord.empty())
6436 DelayedNamespaceRecord);
6437
6438 if (!RelatedDeclsMap.empty()) {
6439 // TODO: on disk hash table for related decls mapping might be more
6440 // efficent becuase it allows lazy deserialization.
6441 RecordData RelatedDeclsMapRecord;
6442 for (const auto &Pair : RelatedDeclsMap) {
6443 RelatedDeclsMapRecord.push_back(Pair.first.getRawValue());
6444 RelatedDeclsMapRecord.push_back(Pair.second.size());
6445 for (const auto &Lambda : Pair.second)
6446 RelatedDeclsMapRecord.push_back(Lambda.getRawValue());
6447 }
6448
6449 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
6450 Abv->Add(llvm::BitCodeAbbrevOp(RELATED_DECLS_MAP));
6451 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Array));
6452 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
6453 unsigned FunctionToLambdaMapAbbrev = Stream.EmitAbbrev(std::move(Abv));
6454 Stream.EmitRecord(RELATED_DECLS_MAP, RelatedDeclsMapRecord,
6455 FunctionToLambdaMapAbbrev);
6456 }
6457
6458 if (!SpecializationsUpdates.empty()) {
6459 WriteSpecializationsUpdates(/*IsPartial=*/false);
6460 SpecializationsUpdates.clear();
6461 }
6462
6463 if (!PartialSpecializationsUpdates.empty()) {
6464 WriteSpecializationsUpdates(/*IsPartial=*/true);
6465 PartialSpecializationsUpdates.clear();
6466 }
6467
6468 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
6469 // Create a lexical update block containing all of the declarations in the
6470 // translation unit that do not come from other AST files.
6471 SmallVector<DeclID, 128> NewGlobalKindDeclPairs;
6472 for (const auto *D : TU->noload_decls()) {
6473 if (D->isFromASTFile())
6474 continue;
6475
6476 // In reduced BMI, skip unreached declarations.
6477 if (!wasDeclEmitted(D))
6478 continue;
6479
6480 NewGlobalKindDeclPairs.push_back(D->getKind());
6481 NewGlobalKindDeclPairs.push_back(GetDeclRef(D).getRawValue());
6482 }
6483
6484 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
6485 Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
6486 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
6487 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(std::move(Abv));
6488
6489 RecordData::value_type Record[] = {TU_UPDATE_LEXICAL};
6490 Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
6491 bytes(NewGlobalKindDeclPairs));
6492
6493 Abv = std::make_shared<llvm::BitCodeAbbrev>();
6494 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
6495 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
6496 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
6497 UpdateVisibleAbbrev = Stream.EmitAbbrev(std::move(Abv));
6498
6499 Abv = std::make_shared<llvm::BitCodeAbbrev>();
6500 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_MODULE_LOCAL_VISIBLE));
6501 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
6502 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
6503 ModuleLocalUpdateVisibleAbbrev = Stream.EmitAbbrev(std::move(Abv));
6504
6505 Abv = std::make_shared<llvm::BitCodeAbbrev>();
6506 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_TU_LOCAL_VISIBLE));
6507 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
6508 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
6509 TULocalUpdateVisibleAbbrev = Stream.EmitAbbrev(std::move(Abv));
6510
6511 // And a visible updates block for the translation unit.
6512 WriteDeclContextVisibleUpdate(Context, TU);
6513
6514 // If we have any extern "C" names, write out a visible update for them.
6515 if (Context.ExternCContext)
6516 WriteDeclContextVisibleUpdate(Context, Context.ExternCContext);
6517
6518 // Write the visible updates to DeclContexts.
6519 for (auto *DC : UpdatedDeclContexts)
6520 WriteDeclContextVisibleUpdate(Context, DC);
6521}
6522
6523void ASTWriter::WriteSpecializationsUpdates(bool IsPartial) {
6524 auto RecordType = IsPartial ? CXX_ADDED_TEMPLATE_PARTIAL_SPECIALIZATION
6526
6527 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
6528 Abv->Add(llvm::BitCodeAbbrevOp(RecordType));
6529 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
6530 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
6531 auto UpdateSpecializationAbbrev = Stream.EmitAbbrev(std::move(Abv));
6532
6533 auto &SpecUpdates =
6534 IsPartial ? PartialSpecializationsUpdates : SpecializationsUpdates;
6535 for (auto &SpecializationUpdate : SpecUpdates) {
6536 const NamedDecl *D = SpecializationUpdate.first;
6537
6538 llvm::SmallString<4096> LookupTable;
6539 GenerateSpecializationInfoLookupTable(D, SpecializationUpdate.second,
6540 LookupTable, IsPartial);
6541
6542 // Write the lookup table
6543 RecordData::value_type Record[] = {
6544 static_cast<RecordData::value_type>(RecordType),
6545 getDeclID(D).getRawValue()};
6546 Stream.EmitRecordWithBlob(UpdateSpecializationAbbrev, Record, LookupTable);
6547 }
6548}
6549
6550void ASTWriter::WriteDeclUpdatesBlocks(ASTContext &Context,
6551 RecordDataImpl &OffsetsRecord) {
6552 if (DeclUpdates.empty())
6553 return;
6554
6555 DeclUpdateMap LocalUpdates;
6556 LocalUpdates.swap(DeclUpdates);
6557
6558 for (auto &DeclUpdate : LocalUpdates) {
6559 const Decl *D = DeclUpdate.first;
6560
6561 bool HasUpdatedBody = false;
6562 bool HasAddedVarDefinition = false;
6564 ASTRecordWriter Record(Context, *this, RecordData);
6565 for (auto &Update : DeclUpdate.second) {
6566 DeclUpdateKind Kind = Update.getKind();
6567
6568 // An updated body is emitted last, so that the reader doesn't need
6569 // to skip over the lazy body to reach statements for other records.
6570 if (Kind == DeclUpdateKind::CXXAddedFunctionDefinition)
6571 HasUpdatedBody = true;
6572 else if (Kind == DeclUpdateKind::CXXAddedVarDefinition)
6573 HasAddedVarDefinition = true;
6574 else
6575 Record.push_back(llvm::to_underlying(Kind));
6576
6577 switch (Kind) {
6578 case DeclUpdateKind::CXXAddedImplicitMember:
6579 case DeclUpdateKind::CXXAddedAnonymousNamespace:
6580 assert(Update.getDecl() && "no decl to add?");
6581 Record.AddDeclRef(Update.getDecl());
6582 break;
6583 case DeclUpdateKind::CXXAddedFunctionDefinition:
6584 case DeclUpdateKind::CXXAddedVarDefinition:
6585 break;
6586
6587 case DeclUpdateKind::CXXPointOfInstantiation:
6588 // FIXME: Do we need to also save the template specialization kind here?
6589 Record.AddSourceLocation(Update.getLoc());
6590 break;
6591
6592 case DeclUpdateKind::CXXInstantiatedDefaultArgument:
6593 Record.writeStmtRef(
6594 cast<ParmVarDecl>(Update.getDecl())->getDefaultArg());
6595 break;
6596
6597 case DeclUpdateKind::CXXInstantiatedDefaultMemberInitializer:
6598 Record.AddStmt(
6599 cast<FieldDecl>(Update.getDecl())->getInClassInitializer());
6600 break;
6601
6602 case DeclUpdateKind::CXXInstantiatedClassDefinition: {
6603 auto *RD = cast<CXXRecordDecl>(D);
6604 UpdatedDeclContexts.insert(RD->getPrimaryContext());
6605 Record.push_back(RD->isParamDestroyedInCallee());
6606 Record.push_back(llvm::to_underlying(RD->getArgPassingRestrictions()));
6607 Record.AddCXXDefinitionData(RD);
6608 Record.AddOffset(WriteDeclContextLexicalBlock(Context, RD));
6609
6610 // This state is sometimes updated by template instantiation, when we
6611 // switch from the specialization referring to the template declaration
6612 // to it referring to the template definition.
6613 if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
6614 Record.push_back(MSInfo->getTemplateSpecializationKind());
6615 Record.AddSourceLocation(MSInfo->getPointOfInstantiation());
6616 } else {
6618 Record.push_back(Spec->getTemplateSpecializationKind());
6619 Record.AddSourceLocation(Spec->getPointOfInstantiation());
6620
6621 // The instantiation might have been resolved to a partial
6622 // specialization. If so, record which one.
6623 auto From = Spec->getInstantiatedFrom();
6624 if (auto PartialSpec =
6625 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
6626 Record.push_back(true);
6627 Record.AddDeclRef(PartialSpec);
6628 Record.AddTemplateArgumentList(
6629 &Spec->getTemplateInstantiationArgs());
6630 } else {
6631 Record.push_back(false);
6632 }
6633 }
6634 Record.push_back(llvm::to_underlying(RD->getTagKind()));
6635 Record.AddSourceLocation(RD->getLocation());
6636 Record.AddSourceLocation(RD->getBeginLoc());
6637 Record.AddSourceRange(RD->getBraceRange());
6638
6639 // Instantiation may change attributes; write them all out afresh.
6640 Record.push_back(D->hasAttrs());
6641 if (D->hasAttrs())
6642 Record.AddAttributes(D->getAttrs());
6643
6644 // FIXME: Ensure we don't get here for explicit instantiations.
6645 break;
6646 }
6647
6648 case DeclUpdateKind::CXXResolvedDtorDelete:
6649 Record.AddDeclRef(Update.getDecl());
6650 Record.AddStmt(cast<CXXDestructorDecl>(D)->getOperatorDeleteThisArg());
6651 break;
6652
6653 case DeclUpdateKind::CXXResolvedDtorGlobDelete:
6654 Record.AddDeclRef(Update.getDecl());
6655 break;
6656
6657 case DeclUpdateKind::CXXResolvedDtorArrayDelete:
6658 Record.AddDeclRef(Update.getDecl());
6659 break;
6660
6661 case DeclUpdateKind::CXXResolvedDtorGlobArrayDelete:
6662 Record.AddDeclRef(Update.getDecl());
6663 break;
6664
6665 case DeclUpdateKind::CXXResolvedExceptionSpec: {
6666 auto prototype =
6667 cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>();
6668 Record.writeExceptionSpecInfo(prototype->getExceptionSpecInfo());
6669 break;
6670 }
6671
6672 case DeclUpdateKind::CXXDeducedReturnType:
6673 Record.push_back(GetOrCreateTypeID(Context, Update.getType()));
6674 break;
6675
6676 case DeclUpdateKind::DeclMarkedUsed:
6677 break;
6678
6679 case DeclUpdateKind::ManglingNumber:
6680 case DeclUpdateKind::StaticLocalNumber:
6681 Record.push_back(Update.getNumber());
6682 break;
6683
6684 case DeclUpdateKind::DeclMarkedOpenMPThreadPrivate:
6685 Record.AddSourceRange(
6686 D->getAttr<OMPThreadPrivateDeclAttr>()->getRange());
6687 break;
6688
6689 case DeclUpdateKind::DeclMarkedOpenMPAllocate: {
6690 auto *A = D->getAttr<OMPAllocateDeclAttr>();
6691 Record.push_back(A->getAllocatorType());
6692 Record.AddStmt(A->getAllocator());
6693 Record.AddStmt(A->getAlignment());
6694 Record.AddSourceRange(A->getRange());
6695 break;
6696 }
6697
6698 case DeclUpdateKind::DeclMarkedOpenMPIndirectCall:
6699 Record.AddSourceRange(
6700 D->getAttr<OMPTargetIndirectCallAttr>()->getRange());
6701 break;
6702
6703 case DeclUpdateKind::DeclMarkedOpenMPDeclareTarget:
6704 Record.push_back(D->getAttr<OMPDeclareTargetDeclAttr>()->getMapType());
6705 Record.AddSourceRange(
6706 D->getAttr<OMPDeclareTargetDeclAttr>()->getRange());
6707 break;
6708
6709 case DeclUpdateKind::DeclExported:
6710 Record.push_back(getSubmoduleID(Update.getModule()));
6711 break;
6712
6713 case DeclUpdateKind::AddedAttrToRecord:
6714 Record.AddAttributes(llvm::ArrayRef(Update.getAttr()));
6715 break;
6716 }
6717 }
6718
6719 // Add a trailing update record, if any. These must go last because we
6720 // lazily load their attached statement.
6721 if (!GeneratingReducedBMI || !CanElideDeclDef(D)) {
6722 if (HasUpdatedBody) {
6723 const auto *Def = cast<FunctionDecl>(D);
6724 Record.push_back(
6725 llvm::to_underlying(DeclUpdateKind::CXXAddedFunctionDefinition));
6726 Record.push_back(Def->isInlined());
6727 Record.AddSourceLocation(Def->getInnerLocStart());
6728 Record.AddFunctionDefinition(Def);
6729 } else if (HasAddedVarDefinition) {
6730 const auto *VD = cast<VarDecl>(D);
6731 Record.push_back(
6732 llvm::to_underlying(DeclUpdateKind::CXXAddedVarDefinition));
6733 Record.push_back(VD->isInline());
6734 Record.push_back(VD->isInlineSpecified());
6735 Record.AddVarDeclInit(VD);
6736 }
6737 }
6738
6739 AddDeclRef(D, OffsetsRecord);
6740 OffsetsRecord.push_back(Record.Emit(DECL_UPDATES));
6741 }
6742}
6743
6746 uint32_t Raw = Sema::AlignPackInfo::getRawEncoding(Info);
6747 Record.push_back(Raw);
6748}
6749
6750FileID ASTWriter::getAdjustedFileID(FileID FID) const {
6751 if (FID.isInvalid() || PP->getSourceManager().isLoadedFileID(FID) ||
6752 NonAffectingFileIDs.empty())
6753 return FID;
6754 auto It = llvm::lower_bound(NonAffectingFileIDs, FID);
6755 unsigned Idx = std::distance(NonAffectingFileIDs.begin(), It);
6756 unsigned Offset = NonAffectingFileIDAdjustments[Idx];
6757 return FileID::get(FID.getOpaqueValue() - Offset);
6758}
6759
6760unsigned ASTWriter::getAdjustedNumCreatedFIDs(FileID FID) const {
6761 unsigned NumCreatedFIDs = PP->getSourceManager()
6762 .getLocalSLocEntry(FID.ID)
6763 .getFile()
6764 .NumCreatedFIDs;
6765
6766 unsigned AdjustedNumCreatedFIDs = 0;
6767 for (unsigned I = FID.ID, N = I + NumCreatedFIDs; I != N; ++I)
6768 if (IsSLocAffecting[I])
6769 ++AdjustedNumCreatedFIDs;
6770 return AdjustedNumCreatedFIDs;
6771}
6772
6773SourceLocation ASTWriter::getAdjustedLocation(SourceLocation Loc) const {
6774 if (Loc.isInvalid())
6775 return Loc;
6776 return Loc.getLocWithOffset(-getAdjustment(Loc.getOffset()));
6777}
6778
6779SourceRange ASTWriter::getAdjustedRange(SourceRange Range) const {
6780 return SourceRange(getAdjustedLocation(Range.getBegin()),
6781 getAdjustedLocation(Range.getEnd()));
6782}
6783
6785ASTWriter::getAdjustedOffset(SourceLocation::UIntTy Offset) const {
6786 return Offset - getAdjustment(Offset);
6787}
6788
6790ASTWriter::getAdjustment(SourceLocation::UIntTy Offset) const {
6791 if (NonAffectingRanges.empty())
6792 return 0;
6793
6794 if (PP->getSourceManager().isLoadedOffset(Offset))
6795 return 0;
6796
6797 if (Offset > NonAffectingRanges.back().getEnd().getOffset())
6798 return NonAffectingOffsetAdjustments.back();
6799
6800 if (Offset < NonAffectingRanges.front().getBegin().getOffset())
6801 return 0;
6802
6803 auto Contains = [](const SourceRange &Range, SourceLocation::UIntTy Offset) {
6804 return Range.getEnd().getOffset() < Offset;
6805 };
6806
6807 auto It = llvm::lower_bound(NonAffectingRanges, Offset, Contains);
6808 unsigned Idx = std::distance(NonAffectingRanges.begin(), It);
6809 return NonAffectingOffsetAdjustments[Idx];
6810}
6811
6813 Record.push_back(getAdjustedFileID(FID).getOpaqueValue());
6814}
6815
6818 SourceLocation::UIntTy BaseOffset = 0;
6819 unsigned ModuleFileIndex = 0;
6820
6821 // See SourceLocationEncoding.h for the encoding details.
6822 if (PP->getSourceManager().isLoadedSourceLocation(Loc) && Loc.isValid()) {
6823 assert(getChain());
6824 auto SLocMapI = getChain()->GlobalSLocOffsetMap.find(
6825 SourceManager::MaxLoadedOffset - Loc.getOffset() - 1);
6826 assert(SLocMapI != getChain()->GlobalSLocOffsetMap.end() &&
6827 "Corrupted global sloc offset map");
6828 ModuleFile *F = SLocMapI->second;
6829 BaseOffset = F->SLocEntryBaseOffset - 2;
6830 // 0 means the location is not loaded. So we need to add 1 to the index to
6831 // make it clear.
6832 ModuleFileIndex = F->Index + 1;
6833 assert(&getChain()->getModuleManager()[F->Index] == F);
6834 }
6835
6836 return SourceLocationEncoding::encode(Loc, BaseOffset, ModuleFileIndex);
6837}
6838
6840 Loc = getAdjustedLocation(Loc);
6841 Record.push_back(getRawSourceLocationEncoding(Loc));
6842}
6843
6845 AddSourceLocation(Range.getBegin(), Record);
6846 AddSourceLocation(Range.getEnd(), Record);
6847}
6848
6849void ASTRecordWriter::AddAPFloat(const llvm::APFloat &Value) {
6850 AddAPInt(Value.bitcastToAPInt());
6851}
6852
6856
6858 if (!II)
6859 return 0;
6860
6861 IdentifierID &ID = IdentifierIDs[II];
6862 if (ID == 0)
6863 ID = NextIdentID++;
6864 return ID;
6865}
6866
6868 // Don't emit builtin macros like __LINE__ to the AST file unless they
6869 // have been redefined by the header (in which case they are not
6870 // isBuiltinMacro).
6871 if (!MI || MI->isBuiltinMacro())
6872 return 0;
6873
6874 MacroID &ID = MacroIDs[MI];
6875 if (ID == 0) {
6876 ID = NextMacroID++;
6877 MacroInfoToEmitData Info = { Name, MI, ID };
6878 MacroInfosToEmit.push_back(Info);
6879 }
6880 return ID;
6881}
6882
6884 return IdentMacroDirectivesOffsetMap.lookup(Name);
6885}
6886
6888 Record->push_back(Writer->getSelectorRef(SelRef));
6889}
6890
6892 if (Sel.getAsOpaquePtr() == nullptr) {
6893 return 0;
6894 }
6895
6896 SelectorID SID = SelectorIDs[Sel];
6897 if (SID == 0 && Chain) {
6898 // This might trigger a ReadSelector callback, which will set the ID for
6899 // this selector.
6900 Chain->LoadSelector(Sel);
6901 SID = SelectorIDs[Sel];
6902 }
6903 if (SID == 0) {
6904 SID = NextSelectorID++;
6905 SelectorIDs[Sel] = SID;
6906 }
6907 return SID;
6908}
6909
6913
6942
6945
6947 bool InfoHasSameExpr
6948 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
6949 Record->push_back(InfoHasSameExpr);
6950 if (InfoHasSameExpr)
6951 return; // Avoid storing the same expr twice.
6952 }
6954}
6955
6957 if (!TInfo) {
6959 return;
6960 }
6961
6962 AddTypeRef(TInfo->getType());
6963 AddTypeLoc(TInfo->getTypeLoc());
6964}
6965
6967 TypeLocWriter TLW(*this);
6968 for (; !TL.isNull(); TL = TL.getNextTypeLoc())
6969 TLW.Visit(TL);
6970}
6971
6974 Record.push_back(GetOrCreateTypeID(Context, T));
6975}
6976
6977template <typename IdxForTypeTy>
6979 IdxForTypeTy IdxForType) {
6980 if (T.isNull())
6981 return PREDEF_TYPE_NULL_ID;
6982
6983 unsigned FastQuals = T.getLocalFastQualifiers();
6984 T.removeLocalFastQualifiers();
6985
6986 if (T.hasLocalNonFastQualifiers())
6987 return IdxForType(T).asTypeID(FastQuals);
6988
6989 assert(!T.hasLocalQualifiers());
6990
6991 if (const BuiltinType *BT = dyn_cast<BuiltinType>(T.getTypePtr()))
6992 return TypeIdxFromBuiltin(BT).asTypeID(FastQuals);
6993
6994 if (T == Context.AutoDeductTy)
6995 return TypeIdx(0, PREDEF_TYPE_AUTO_DEDUCT).asTypeID(FastQuals);
6996 if (T == Context.AutoRRefDeductTy)
6997 return TypeIdx(0, PREDEF_TYPE_AUTO_RREF_DEDUCT).asTypeID(FastQuals);
6998
6999 return IdxForType(T).asTypeID(FastQuals);
7000}
7001
7003 return MakeTypeID(Context, T, [&](QualType T) -> TypeIdx {
7004 if (T.isNull())
7005 return TypeIdx();
7006 assert(!T.getLocalFastQualifiers());
7007
7008 TypeIdx &Idx = TypeIdxs[T];
7009 if (Idx.getValue() == 0) {
7010 if (DoneWritingDeclsAndTypes) {
7011 assert(0 && "New type seen after serializing all the types to emit!");
7012 return TypeIdx();
7013 }
7014
7015 // We haven't seen this type before. Assign it a new ID and put it
7016 // into the queue of types to emit.
7017 Idx = TypeIdx(0, NextTypeID++);
7018 DeclTypesToEmit.push(T);
7019 }
7020 return Idx;
7021 });
7022}
7023
7024llvm::MapVector<ModuleFile *, const Decl *>
7026 llvm::MapVector<ModuleFile *, const Decl *> Firsts;
7027 // FIXME: We can skip entries that we know are implied by others.
7028 for (const Decl *R = D->getMostRecentDecl(); R; R = R->getPreviousDecl()) {
7029 if (R->isFromASTFile())
7030 Firsts[Chain->getOwningModuleFile(R)] = R;
7031 else if (IncludeLocal)
7032 Firsts[nullptr] = R;
7033 }
7034 return Firsts;
7035}
7036
7039 Record.push_back(Offsets.LexicalOffset);
7040 Record.push_back(Offsets.VisibleOffset);
7041 Record.push_back(Offsets.ModuleLocalOffset);
7042 Record.push_back(Offsets.TULocalOffset);
7043}
7044
7047 MacroID MacroRef = getMacroRef(MI, Name);
7048 Record.push_back(MacroRef >> 32);
7049 Record.push_back(MacroRef & llvm::maskTrailingOnes<MacroID>(32));
7050}
7051
7053 if (!wasDeclEmitted(D))
7054 return;
7055
7056 AddDeclRef(D, Record);
7057}
7058
7060 Record.push_back(GetDeclRef(D).getRawValue());
7061}
7062
7064 assert(WritingAST && "Cannot request a declaration ID before AST writing");
7065
7066 if (!D) {
7067 return LocalDeclID();
7068 }
7069
7070 getLazyUpdates(D);
7071
7072 // If D comes from an AST file, its declaration ID is already known and
7073 // fixed.
7074 if (D->isFromASTFile()) {
7076 TouchedTopLevelModules.insert(D->getOwningModule()->getTopLevelModule());
7077
7078 return LocalDeclID(D->getGlobalID());
7079 }
7080
7081 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
7082 LocalDeclID &ID = DeclIDs[D];
7083 if (ID.isInvalid()) {
7084 if (DoneWritingDeclsAndTypes) {
7085 assert(0 && "New decl seen after serializing all the decls to emit!");
7086 return LocalDeclID();
7087 }
7088
7089 // We haven't seen this declaration before. Give it a new ID and
7090 // enqueue it in the list of declarations to emit.
7091 ID = NextDeclID++;
7092 DeclTypesToEmit.push(const_cast<Decl *>(D));
7093 }
7094
7095 return ID;
7096}
7097
7099 if (!D)
7100 return LocalDeclID();
7101
7102 // If D comes from an AST file, its declaration ID is already known and
7103 // fixed.
7104 if (D->isFromASTFile())
7105 return LocalDeclID(D->getGlobalID());
7106
7107 assert(DeclIDs.contains(D) && "Declaration not emitted!");
7108 return DeclIDs[D];
7109}
7110
7111bool ASTWriter::wasDeclEmitted(const Decl *D) const {
7112 assert(D);
7113
7114 assert(DoneWritingDeclsAndTypes &&
7115 "wasDeclEmitted should only be called after writing declarations");
7116
7117 if (D->isFromASTFile())
7118 return true;
7119
7120 bool Emitted = DeclIDs.contains(D);
7121 assert((Emitted || (!D->getOwningModule() && isWritingStdCXXNamedModules()) ||
7122 GeneratingReducedBMI) &&
7123 "The declaration within modules can only be omitted in reduced BMI.");
7124 return Emitted;
7125}
7126
7127void ASTWriter::getLazyUpdates(const Decl *D) {
7128 if (!GeneratingReducedBMI)
7129 return;
7130
7131 if (auto *Iter = DeclUpdatesLazy.find(D); Iter != DeclUpdatesLazy.end()) {
7132 for (DeclUpdate &Update : Iter->second)
7133 DeclUpdates[D].push_back(Update);
7134 DeclUpdatesLazy.erase(Iter);
7135 }
7136
7137 // If the Decl in DeclUpdatesLazy gets touched, emit the update.
7138 if (auto *DC = dyn_cast<DeclContext>(D);
7139 DC && UpdatedDeclContextsLazy.count(DC)) {
7140 UpdatedDeclContexts.insert(DC);
7141 UpdatedDeclContextsLazy.remove(DC);
7142 }
7143}
7144
7145void ASTWriter::associateDeclWithFile(const Decl *D, LocalDeclID ID) {
7146 assert(ID.isValid());
7147 assert(D);
7148
7149 SourceLocation Loc = D->getLocation();
7150 if (Loc.isInvalid())
7151 return;
7152
7153 // We only keep track of the file-level declarations of each file.
7155 return;
7156 // FIXME: ParmVarDecls that are part of a function type of a parameter of
7157 // a function/objc method, should not have TU as lexical context.
7158 // TemplateTemplateParmDecls that are part of an alias template, should not
7159 // have TU as lexical context.
7161 return;
7162
7163 SourceManager &SM = PP->getSourceManager();
7164 SourceLocation FileLoc = SM.getFileLoc(Loc);
7165 assert(SM.isLocalSourceLocation(FileLoc));
7166 auto [FID, Offset] = SM.getDecomposedLoc(FileLoc);
7167 if (FID.isInvalid())
7168 return;
7169 assert(SM.getSLocEntry(FID).isFile());
7170 assert(IsSLocAffecting[FID.ID]);
7171
7172 std::unique_ptr<DeclIDInFileInfo> &Info = FileDeclIDs[FID];
7173 if (!Info)
7174 Info = std::make_unique<DeclIDInFileInfo>();
7175
7176 std::pair<unsigned, LocalDeclID> LocDecl(Offset, ID);
7177 LocDeclIDsTy &Decls = Info->DeclIDs;
7178 Decls.push_back(LocDecl);
7179}
7180
7183 "expected an anonymous declaration");
7184
7185 // Number the anonymous declarations within this context, if we've not
7186 // already done so.
7187 auto It = AnonymousDeclarationNumbers.find(D);
7188 if (It == AnonymousDeclarationNumbers.end()) {
7189 auto *DC = D->getLexicalDeclContext();
7190 numberAnonymousDeclsWithin(DC, [&](const NamedDecl *ND, unsigned Number) {
7191 AnonymousDeclarationNumbers[ND] = Number;
7192 });
7193
7194 It = AnonymousDeclarationNumbers.find(D);
7195 assert(It != AnonymousDeclarationNumbers.end() &&
7196 "declaration not found within its lexical context");
7197 }
7198
7199 return It->second;
7200}
7201
7228
7230 const DeclarationNameInfo &NameInfo) {
7231 AddDeclarationName(NameInfo.getName());
7232 AddSourceLocation(NameInfo.getLoc());
7233 AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName());
7234}
7235
7238 Record->push_back(Info.NumTemplParamLists);
7239 for (unsigned i = 0, e = Info.NumTemplParamLists; i != e; ++i)
7241}
7242
7244 NestedNameSpecifierLoc QualifierLoc) {
7245 // Nested name specifiers usually aren't too long. I think that 8 would
7246 // typically accommodate the vast majority.
7248
7249 // Push each of the nested-name-specifiers's onto a stack for
7250 // serialization in reverse order.
7251 while (QualifierLoc) {
7252 NestedNames.push_back(QualifierLoc);
7253 QualifierLoc = QualifierLoc.getAsNamespaceAndPrefix().Prefix;
7254 }
7255
7256 Record->push_back(NestedNames.size());
7257 while(!NestedNames.empty()) {
7258 QualifierLoc = NestedNames.pop_back_val();
7259 NestedNameSpecifier Qualifier = QualifierLoc.getNestedNameSpecifier();
7260 NestedNameSpecifier::Kind Kind = Qualifier.getKind();
7261 Record->push_back(llvm::to_underlying(Kind));
7262 switch (Kind) {
7264 AddDeclRef(Qualifier.getAsNamespaceAndPrefix().Namespace);
7265 AddSourceRange(QualifierLoc.getLocalSourceRange());
7266 break;
7267
7269 TypeLoc TL = QualifierLoc.castAsTypeLoc();
7270 AddTypeRef(TL.getType());
7271 AddTypeLoc(TL);
7273 break;
7274 }
7275
7278 break;
7279
7281 AddDeclRef(Qualifier.getAsMicrosoftSuper());
7282 AddSourceRange(QualifierLoc.getLocalSourceRange());
7283 break;
7284
7286 llvm_unreachable("unexpected null nested name specifier");
7287 }
7288 }
7289}
7290
7292 const TemplateParameterList *TemplateParams) {
7293 assert(TemplateParams && "No TemplateParams!");
7294 AddSourceLocation(TemplateParams->getTemplateLoc());
7295 AddSourceLocation(TemplateParams->getLAngleLoc());
7296 AddSourceLocation(TemplateParams->getRAngleLoc());
7297
7298 Record->push_back(TemplateParams->size());
7299 for (const auto &P : *TemplateParams)
7300 AddDeclRef(P);
7301 if (const Expr *RequiresClause = TemplateParams->getRequiresClause()) {
7302 Record->push_back(true);
7303 writeStmtRef(RequiresClause);
7304 } else {
7305 Record->push_back(false);
7306 }
7307}
7308
7309/// Emit a template argument list.
7311 const TemplateArgumentList *TemplateArgs) {
7312 assert(TemplateArgs && "No TemplateArgs!");
7313 Record->push_back(TemplateArgs->size());
7314 for (int i = 0, e = TemplateArgs->size(); i != e; ++i)
7315 AddTemplateArgument(TemplateArgs->get(i));
7316}
7317
7319 const ASTTemplateArgumentListInfo *ASTTemplArgList) {
7320 assert(ASTTemplArgList && "No ASTTemplArgList!");
7321 AddSourceLocation(ASTTemplArgList->LAngleLoc);
7322 AddSourceLocation(ASTTemplArgList->RAngleLoc);
7323 Record->push_back(ASTTemplArgList->NumTemplateArgs);
7324 const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
7325 for (int i = 0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
7326 AddTemplateArgumentLoc(TemplArgs[i]);
7327}
7328
7330 Record->push_back(Set.size());
7332 I = Set.begin(), E = Set.end(); I != E; ++I) {
7333 AddDeclRef(I.getDecl());
7334 Record->push_back(I.getAccess());
7335 }
7336}
7337
7338// FIXME: Move this out of the main ASTRecordWriter interface.
7340 Record->push_back(Base.isVirtual());
7341 Record->push_back(Base.isBaseOfClass());
7342 Record->push_back(Base.getAccessSpecifierAsWritten());
7343 Record->push_back(Base.getInheritConstructors());
7344 AddTypeSourceInfo(Base.getTypeSourceInfo());
7345 AddSourceRange(Base.getSourceRange());
7346 AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
7347 : SourceLocation());
7348}
7349
7350static uint64_t EmitCXXBaseSpecifiers(ASTContext &Context, ASTWriter &W,
7353 ASTRecordWriter Writer(Context, W, Record);
7354 Writer.push_back(Bases.size());
7355
7356 for (auto &Base : Bases)
7357 Writer.AddCXXBaseSpecifier(Base);
7358
7360}
7361
7362// FIXME: Move this out of the main ASTRecordWriter interface.
7366
7367static uint64_t
7371 ASTRecordWriter Writer(Context, W, Record);
7372 Writer.push_back(CtorInits.size());
7373
7374 for (auto *Init : CtorInits) {
7375 if (Init->isBaseInitializer()) {
7377 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
7378 Writer.push_back(Init->isBaseVirtual());
7379 } else if (Init->isDelegatingInitializer()) {
7381 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
7382 } else if (Init->isMemberInitializer()){
7384 Writer.AddDeclRef(Init->getMember());
7385 } else {
7387 Writer.AddDeclRef(Init->getIndirectMember());
7388 }
7389
7390 Writer.AddSourceLocation(Init->getMemberLocation());
7391 Writer.AddStmt(Init->getInit());
7392 Writer.AddSourceLocation(Init->getLParenLoc());
7393 Writer.AddSourceLocation(Init->getRParenLoc());
7394 Writer.push_back(Init->isWritten());
7395 if (Init->isWritten())
7396 Writer.push_back(Init->getSourceOrder());
7397 }
7398
7400}
7401
7402// FIXME: Move this out of the main ASTRecordWriter interface.
7405 AddOffset(EmitCXXCtorInitializers(getASTContext(), *Writer, CtorInits));
7406}
7407
7409 auto &Data = D->data();
7410
7411 Record->push_back(Data.IsLambda);
7412
7413 BitsPacker DefinitionBits;
7414
7415#define FIELD(Name, Width, Merge) \
7416 if (!DefinitionBits.canWriteNextNBits(Width)) { \
7417 Record->push_back(DefinitionBits); \
7418 DefinitionBits.reset(0); \
7419 } \
7420 DefinitionBits.addBits(Data.Name, Width);
7421
7422#include "clang/AST/CXXRecordDeclDefinitionBits.def"
7423#undef FIELD
7424
7425 Record->push_back(DefinitionBits);
7426
7427 // getODRHash will compute the ODRHash if it has not been previously
7428 // computed.
7429 Record->push_back(D->getODRHash());
7430
7431 bool ModulesCodegen =
7432 !D->isDependentType() &&
7435 (Writer->getLangOpts().ModulesDebugInfo || D->isInNamedModule());
7436 Record->push_back(ModulesCodegen);
7437 if (ModulesCodegen)
7438 Writer->AddDeclRef(D, Writer->ModularCodegenDecls);
7439
7440 // IsLambda bit is already saved.
7441
7442 AddUnresolvedSet(Data.Conversions.get(getASTContext()));
7443 Record->push_back(Data.ComputedVisibleConversions);
7444 if (Data.ComputedVisibleConversions)
7445 AddUnresolvedSet(Data.VisibleConversions.get(getASTContext()));
7446 // Data.Definition is the owning decl, no need to write it.
7447
7448 if (!Data.IsLambda) {
7449 Record->push_back(Data.NumBases);
7450 if (Data.NumBases > 0)
7451 AddCXXBaseSpecifiers(Data.bases());
7452
7453 // FIXME: Make VBases lazily computed when needed to avoid storing them.
7454 Record->push_back(Data.NumVBases);
7455 if (Data.NumVBases > 0)
7456 AddCXXBaseSpecifiers(Data.vbases());
7457
7458 AddDeclRef(D->getFirstFriend());
7459 } else {
7460 auto &Lambda = D->getLambdaData();
7461
7462 BitsPacker LambdaBits;
7463 LambdaBits.addBits(Lambda.DependencyKind, /*Width=*/2);
7464 LambdaBits.addBit(Lambda.IsGenericLambda);
7465 LambdaBits.addBits(Lambda.CaptureDefault, /*Width=*/2);
7466 LambdaBits.addBits(Lambda.NumCaptures, /*Width=*/15);
7467 LambdaBits.addBit(Lambda.HasKnownInternalLinkage);
7468 Record->push_back(LambdaBits);
7469
7470 Record->push_back(Lambda.NumExplicitCaptures);
7471 Record->push_back(Lambda.ManglingNumber);
7472 Record->push_back(D->getDeviceLambdaManglingNumber());
7473 // The lambda context declaration and index within the context are provided
7474 // separately, so that they can be used for merging.
7475 AddTypeSourceInfo(Lambda.MethodTyInfo);
7476 for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
7477 const LambdaCapture &Capture = Lambda.Captures.front()[I];
7479
7480 BitsPacker CaptureBits;
7481 CaptureBits.addBit(Capture.isImplicit());
7482 CaptureBits.addBits(Capture.getCaptureKind(), /*Width=*/3);
7483 Record->push_back(CaptureBits);
7484
7485 switch (Capture.getCaptureKind()) {
7486 case LCK_StarThis:
7487 case LCK_This:
7488 case LCK_VLAType:
7489 break;
7490 case LCK_ByCopy:
7491 case LCK_ByRef:
7492 ValueDecl *Var =
7493 Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
7494 AddDeclRef(Var);
7495 AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc()
7496 : SourceLocation());
7497 break;
7498 }
7499 }
7500 }
7501}
7502
7504 const Expr *Init = VD->getInit();
7505 if (!Init) {
7506 push_back(0);
7507 return;
7508 }
7509
7510 uint64_t Val = 1;
7511 if (EvaluatedStmt *ES = VD->getEvaluatedStmt()) {
7512 // This may trigger evaluation, so run it first
7513 if (VD->hasInitWithSideEffects())
7514 Val |= 16;
7515 assert(ES->CheckedForSideEffects);
7516 Val |= (ES->HasConstantInitialization ? 2 : 0);
7517 Val |= (ES->HasConstantDestruction ? 4 : 0);
7519 // If the evaluated result is constant, emit it.
7520 if (Evaluated && (Evaluated->isInt() || Evaluated->isFloat()))
7521 Val |= 8;
7522 }
7523 push_back(Val);
7524 if (Val & 8) {
7526 }
7527
7529}
7530
7531void ASTWriter::ReaderInitialized(ASTReader *Reader) {
7532 assert(Reader && "Cannot remove chain");
7533 assert((!Chain || Chain == Reader) && "Cannot replace chain");
7534 assert(FirstDeclID == NextDeclID &&
7535 FirstTypeID == NextTypeID &&
7536 FirstIdentID == NextIdentID &&
7537 FirstMacroID == NextMacroID &&
7538 FirstSubmoduleID == NextSubmoduleID &&
7539 FirstSelectorID == NextSelectorID &&
7540 "Setting chain after writing has started.");
7541
7542 Chain = Reader;
7543
7544 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
7545 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
7546 NextSelectorID = FirstSelectorID;
7547 NextSubmoduleID = FirstSubmoduleID;
7548}
7549
7550void ASTWriter::IdentifierRead(IdentifierID ID, IdentifierInfo *II) {
7551 // Don't reuse Type ID from external modules for named modules. See the
7552 // comments in WriteASTCore for details.
7554 return;
7555
7556 IdentifierID &StoredID = IdentifierIDs[II];
7557 unsigned OriginalModuleFileIndex = StoredID >> 32;
7558
7559 // Always keep the local identifier ID. See \p TypeRead() for more
7560 // information.
7561 if (OriginalModuleFileIndex == 0 && StoredID)
7562 return;
7563
7564 // Otherwise, keep the highest ID since the module file comes later has
7565 // higher module file indexes.
7566 if (ID > StoredID)
7567 StoredID = ID;
7568}
7569
7570void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
7571 // Always keep the highest ID. See \p TypeRead() for more information.
7572 MacroID &StoredID = MacroIDs[MI];
7573 unsigned OriginalModuleFileIndex = StoredID >> 32;
7574
7575 // Always keep the local macro ID. See \p TypeRead() for more information.
7576 if (OriginalModuleFileIndex == 0 && StoredID)
7577 return;
7578
7579 // Otherwise, keep the highest ID since the module file comes later has
7580 // higher module file indexes.
7581 if (ID > StoredID)
7582 StoredID = ID;
7583}
7584
7585void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
7586 // Don't reuse Type ID from external modules for named modules. See the
7587 // comments in WriteASTCore for details.
7589 return;
7590
7591 // Always take the type index that comes in later module files.
7592 // This copes with an interesting
7593 // case for chained AST writing where we schedule writing the type and then,
7594 // later, deserialize the type from another AST. In this case, we want to
7595 // keep the entry from a later module so that we can properly write it out to
7596 // the AST file.
7597 TypeIdx &StoredIdx = TypeIdxs[T];
7598
7599 // Ignore it if the type comes from the current being written module file.
7600 // Since the current module file being written logically has the highest
7601 // index.
7602 unsigned ModuleFileIndex = StoredIdx.getModuleFileIndex();
7603 if (ModuleFileIndex == 0 && StoredIdx.getValue())
7604 return;
7605
7606 // Otherwise, keep the highest ID since the module file comes later has
7607 // higher module file indexes.
7608 if (Idx.getModuleFileIndex() >= StoredIdx.getModuleFileIndex())
7609 StoredIdx = Idx;
7610}
7611
7612void ASTWriter::PredefinedDeclBuilt(PredefinedDeclIDs ID, const Decl *D) {
7613 assert(D->isCanonicalDecl() && "predefined decl is not canonical");
7614 DeclIDs[D] = LocalDeclID(ID);
7615 PredefinedDecls.insert(D);
7616}
7617
7618void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
7619 // Always keep the highest ID. See \p TypeRead() for more information.
7620 SelectorID &StoredID = SelectorIDs[S];
7621 if (ID > StoredID)
7622 StoredID = ID;
7623}
7624
7625void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
7627 assert(!MacroDefinitions.contains(MD));
7628 MacroDefinitions[MD] = ID;
7629}
7630
7631void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
7632 assert(!SubmoduleIDs.contains(Mod));
7633 SubmoduleIDs[Mod] = ID;
7634}
7635
7636void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
7637 if (Chain && Chain->isProcessingUpdateRecords()) return;
7638 assert(D->isCompleteDefinition());
7639 assert(!WritingAST && "Already writing the AST!");
7640 if (auto *RD = dyn_cast<CXXRecordDecl>(D)) {
7641 // We are interested when a PCH decl is modified.
7642 if (RD->isFromASTFile()) {
7643 // A forward reference was mutated into a definition. Rewrite it.
7644 // FIXME: This happens during template instantiation, should we
7645 // have created a new definition decl instead ?
7646 assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
7647 "completed a tag from another module but not by instantiation?");
7648 DeclUpdates[RD].push_back(
7649 DeclUpdate(DeclUpdateKind::CXXInstantiatedClassDefinition));
7650 }
7651 }
7652}
7653
7654static bool isImportedDeclContext(ASTReader *Chain, const Decl *D) {
7655 if (D->isFromASTFile())
7656 return true;
7657
7658 // The predefined __va_list_tag struct is imported if we imported any decls.
7659 // FIXME: This is a gross hack.
7660 return D == D->getASTContext().getVaListTagDecl();
7661}
7662
7663void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
7664 if (Chain && Chain->isProcessingUpdateRecords()) return;
7665 assert(DC->isLookupContext() &&
7666 "Should not add lookup results to non-lookup contexts!");
7667
7668 // TU is handled elsewhere.
7670 return;
7671
7672 // Namespaces are handled elsewhere, except for template instantiations of
7673 // FunctionTemplateDecls in namespaces. We are interested in cases where the
7674 // local instantiations are added to an imported context. Only happens when
7675 // adding ADL lookup candidates, for example templated friends.
7678 return;
7679
7680 // We're only interested in cases where a local declaration is added to an
7681 // imported context.
7682 if (D->isFromASTFile() || !isImportedDeclContext(Chain, cast<Decl>(DC)))
7683 return;
7684
7685 assert(DC == DC->getPrimaryContext() && "added to non-primary context");
7686 assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
7687 assert(!WritingAST && "Already writing the AST!");
7688 if (UpdatedDeclContexts.insert(DC) && !cast<Decl>(DC)->isFromASTFile()) {
7689 // We're adding a visible declaration to a predefined decl context. Ensure
7690 // that we write out all of its lookup results so we don't get a nasty
7691 // surprise when we try to emit its lookup table.
7692 llvm::append_range(DeclsToEmitEvenIfUnreferenced, DC->decls());
7693 }
7694 DeclsToEmitEvenIfUnreferenced.push_back(D);
7695}
7696
7697void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
7698 if (Chain && Chain->isProcessingUpdateRecords()) return;
7699 assert(D->isImplicit());
7700
7701 // We're only interested in cases where a local declaration is added to an
7702 // imported context.
7703 if (D->isFromASTFile() || !isImportedDeclContext(Chain, RD))
7704 return;
7705
7706 if (!isa<CXXMethodDecl>(D))
7707 return;
7708
7709 // A decl coming from PCH was modified.
7710 assert(RD->isCompleteDefinition());
7711 assert(!WritingAST && "Already writing the AST!");
7712 DeclUpdates[RD].push_back(
7713 DeclUpdate(DeclUpdateKind::CXXAddedImplicitMember, D));
7714}
7715
7716void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
7717 if (Chain && Chain->isProcessingUpdateRecords()) return;
7718 assert(!DoneWritingDeclsAndTypes && "Already done writing updates!");
7719 if (!Chain) return;
7720 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
7721 // If we don't already know the exception specification for this redecl
7722 // chain, add an update record for it.
7724 ->getType()
7725 ->castAs<FunctionProtoType>()
7726 ->getExceptionSpecType()))
7727 DeclUpdates[D].push_back(DeclUpdateKind::CXXResolvedExceptionSpec);
7728 });
7729}
7730
7731void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
7732 if (Chain && Chain->isProcessingUpdateRecords()) return;
7733 assert(!WritingAST && "Already writing the AST!");
7734 if (!Chain) return;
7735 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
7736 DeclUpdates[D].push_back(
7737 DeclUpdate(DeclUpdateKind::CXXDeducedReturnType, ReturnType));
7738 });
7739}
7740
7741void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD,
7742 const FunctionDecl *Delete,
7743 Expr *ThisArg) {
7744 if (Chain && Chain->isProcessingUpdateRecords()) return;
7745 assert(!WritingAST && "Already writing the AST!");
7746 assert(Delete && "Not given an operator delete");
7747 if (!Chain) return;
7748 Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
7749 DeclUpdates[D].push_back(
7750 DeclUpdate(DeclUpdateKind::CXXResolvedDtorDelete, Delete));
7751 });
7752}
7753
7754void ASTWriter::ResolvedOperatorGlobDelete(const CXXDestructorDecl *DD,
7755 const FunctionDecl *GlobDelete) {
7756 if (Chain && Chain->isProcessingUpdateRecords())
7757 return;
7758 assert(!WritingAST && "Already writing the AST!");
7759 assert(GlobDelete && "Not given an operator delete");
7760 if (!Chain)
7761 return;
7762 Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
7763 DeclUpdates[D].push_back(
7764 DeclUpdate(DeclUpdateKind::CXXResolvedDtorGlobDelete, GlobDelete));
7765 });
7766}
7767
7768void ASTWriter::ResolvedOperatorArrayDelete(const CXXDestructorDecl *DD,
7769 const FunctionDecl *ArrayDelete) {
7770 if (Chain && Chain->isProcessingUpdateRecords())
7771 return;
7772 assert(!WritingAST && "Already writing the AST!");
7773 assert(ArrayDelete && "Not given an operator delete");
7774 if (!Chain)
7775 return;
7776 Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
7777 DeclUpdates[D].push_back(
7778 DeclUpdate(DeclUpdateKind::CXXResolvedDtorArrayDelete, ArrayDelete));
7779 });
7780}
7781
7782void ASTWriter::ResolvedOperatorGlobArrayDelete(
7783 const CXXDestructorDecl *DD, const FunctionDecl *GlobArrayDelete) {
7784 if (Chain && Chain->isProcessingUpdateRecords())
7785 return;
7786 assert(!WritingAST && "Already writing the AST!");
7787 assert(GlobArrayDelete && "Not given an operator delete");
7788 if (!Chain)
7789 return;
7790 Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
7791 DeclUpdates[D].push_back(DeclUpdate(
7792 DeclUpdateKind::CXXResolvedDtorGlobArrayDelete, GlobArrayDelete));
7793 });
7794}
7795
7796void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
7797 if (Chain && Chain->isProcessingUpdateRecords()) return;
7798 assert(!WritingAST && "Already writing the AST!");
7799 if (!D->isFromASTFile())
7800 return; // Declaration not imported from PCH.
7801
7802 // The function definition may not have a body due to parsing errors.
7804 return;
7805
7806 // Implicit function decl from a PCH was defined.
7807 DeclUpdates[D].push_back(
7808 DeclUpdate(DeclUpdateKind::CXXAddedFunctionDefinition));
7809}
7810
7811void ASTWriter::VariableDefinitionInstantiated(const VarDecl *D) {
7812 if (Chain && Chain->isProcessingUpdateRecords()) return;
7813 assert(!WritingAST && "Already writing the AST!");
7814 if (!D->isFromASTFile())
7815 return;
7816
7817 DeclUpdates[D].push_back(DeclUpdate(DeclUpdateKind::CXXAddedVarDefinition));
7818}
7819
7820void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
7821 if (Chain && Chain->isProcessingUpdateRecords()) return;
7822 assert(!WritingAST && "Already writing the AST!");
7823 if (!D->isFromASTFile())
7824 return;
7825
7826 // The function definition may not have a body due to parsing errors.
7828 return;
7829
7830 DeclUpdates[D].push_back(
7831 DeclUpdate(DeclUpdateKind::CXXAddedFunctionDefinition));
7832}
7833
7834void ASTWriter::InstantiationRequested(const ValueDecl *D) {
7835 if (Chain && Chain->isProcessingUpdateRecords()) return;
7836 assert(!WritingAST && "Already writing the AST!");
7837 if (!D->isFromASTFile())
7838 return;
7839
7840 // Since the actual instantiation is delayed, this really means that we need
7841 // to update the instantiation location.
7842 SourceLocation POI;
7843 if (auto *VD = dyn_cast<VarDecl>(D))
7844 POI = VD->getPointOfInstantiation();
7845 else
7846 POI = cast<FunctionDecl>(D)->getPointOfInstantiation();
7847 DeclUpdates[D].push_back(
7848 DeclUpdate(DeclUpdateKind::CXXPointOfInstantiation, POI));
7849}
7850
7851void ASTWriter::DefaultArgumentInstantiated(const ParmVarDecl *D) {
7852 if (Chain && Chain->isProcessingUpdateRecords()) return;
7853 assert(!WritingAST && "Already writing the AST!");
7854 if (!D->isFromASTFile())
7855 return;
7856
7857 DeclUpdates[D].push_back(
7858 DeclUpdate(DeclUpdateKind::CXXInstantiatedDefaultArgument, D));
7859}
7860
7861void ASTWriter::DefaultMemberInitializerInstantiated(const FieldDecl *D) {
7862 assert(!WritingAST && "Already writing the AST!");
7863 if (!D->isFromASTFile())
7864 return;
7865
7866 DeclUpdates[D].push_back(
7867 DeclUpdate(DeclUpdateKind::CXXInstantiatedDefaultMemberInitializer, D));
7868}
7869
7870void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
7871 const ObjCInterfaceDecl *IFD) {
7872 if (Chain && Chain->isProcessingUpdateRecords()) return;
7873 assert(!WritingAST && "Already writing the AST!");
7874 if (!IFD->isFromASTFile())
7875 return; // Declaration not imported from PCH.
7876
7877 assert(IFD->getDefinition() && "Category on a class without a definition?");
7878 ObjCClassesWithCategories.insert(
7879 const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
7880}
7881
7882void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
7883 if (Chain && Chain->isProcessingUpdateRecords()) return;
7884 assert(!WritingAST && "Already writing the AST!");
7885
7886 // If there is *any* declaration of the entity that's not from an AST file,
7887 // we can skip writing the update record. We make sure that isUsed() triggers
7888 // completion of the redeclaration chain of the entity.
7889 for (auto Prev = D->getMostRecentDecl(); Prev; Prev = Prev->getPreviousDecl())
7890 if (IsLocalDecl(Prev))
7891 return;
7892
7893 DeclUpdates[D].push_back(DeclUpdate(DeclUpdateKind::DeclMarkedUsed));
7894}
7895
7896void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
7897 if (Chain && Chain->isProcessingUpdateRecords()) return;
7898 assert(!WritingAST && "Already writing the AST!");
7899 if (!D->isFromASTFile())
7900 return;
7901
7902 DeclUpdates[D].push_back(
7903 DeclUpdate(DeclUpdateKind::DeclMarkedOpenMPThreadPrivate));
7904}
7905
7906void ASTWriter::DeclarationMarkedOpenMPAllocate(const Decl *D, const Attr *A) {
7907 if (Chain && Chain->isProcessingUpdateRecords()) return;
7908 assert(!WritingAST && "Already writing the AST!");
7909 if (!D->isFromASTFile())
7910 return;
7911
7912 DeclUpdates[D].push_back(
7913 DeclUpdate(DeclUpdateKind::DeclMarkedOpenMPAllocate, A));
7914}
7915
7916void ASTWriter::DeclarationMarkedOpenMPIndirectCall(const Decl *D) {
7917 if (Chain && Chain->isProcessingUpdateRecords())
7918 return;
7919 assert(!WritingAST && "Already writing the AST!");
7920 if (!D->isFromASTFile())
7921 return;
7922
7923 DeclUpdates[D].push_back(
7924 DeclUpdate(DeclUpdateKind::DeclMarkedOpenMPIndirectCall));
7925}
7926
7927void ASTWriter::DeclarationMarkedOpenMPDeclareTarget(const Decl *D,
7928 const Attr *Attr) {
7929 if (Chain && Chain->isProcessingUpdateRecords()) return;
7930 assert(!WritingAST && "Already writing the AST!");
7931 if (!D->isFromASTFile())
7932 return;
7933
7934 DeclUpdates[D].push_back(
7935 DeclUpdate(DeclUpdateKind::DeclMarkedOpenMPDeclareTarget, Attr));
7936}
7937
7938void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) {
7939 if (Chain && Chain->isProcessingUpdateRecords()) return;
7940 assert(!WritingAST && "Already writing the AST!");
7941 assert(!D->isUnconditionallyVisible() && "expected a hidden declaration");
7942 DeclUpdates[D].push_back(DeclUpdate(DeclUpdateKind::DeclExported, M));
7943}
7944
7945void ASTWriter::AddedAttributeToRecord(const Attr *Attr,
7946 const RecordDecl *Record) {
7947 if (Chain && Chain->isProcessingUpdateRecords()) return;
7948 assert(!WritingAST && "Already writing the AST!");
7949 if (!Record->isFromASTFile())
7950 return;
7951 DeclUpdates[Record].push_back(
7952 DeclUpdate(DeclUpdateKind::AddedAttrToRecord, Attr));
7953}
7954
7955void ASTWriter::AddedCXXTemplateSpecialization(
7957 assert(!WritingAST && "Already writing the AST!");
7958
7959 if (!TD->getFirstDecl()->isFromASTFile())
7960 return;
7961 if (Chain && Chain->isProcessingUpdateRecords())
7962 return;
7963
7964 DeclsToEmitEvenIfUnreferenced.push_back(D);
7965}
7966
7967void ASTWriter::AddedCXXTemplateSpecialization(
7968 const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
7969 assert(!WritingAST && "Already writing the AST!");
7970
7971 if (!TD->getFirstDecl()->isFromASTFile())
7972 return;
7973 if (Chain && Chain->isProcessingUpdateRecords())
7974 return;
7975
7976 DeclsToEmitEvenIfUnreferenced.push_back(D);
7977}
7978
7979void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
7980 const FunctionDecl *D) {
7981 assert(!WritingAST && "Already writing the AST!");
7982
7983 if (!TD->getFirstDecl()->isFromASTFile())
7984 return;
7985 if (Chain && Chain->isProcessingUpdateRecords())
7986 return;
7987
7988 DeclsToEmitEvenIfUnreferenced.push_back(D);
7989}
7990
7991//===----------------------------------------------------------------------===//
7992//// OMPClause Serialization
7993////===----------------------------------------------------------------------===//
7994
7995namespace {
7996
7997class OMPClauseWriter : public OMPClauseVisitor<OMPClauseWriter> {
7998 ASTRecordWriter &Record;
7999
8000public:
8001 OMPClauseWriter(ASTRecordWriter &Record) : Record(Record) {}
8002#define GEN_CLANG_CLAUSE_CLASS
8003#define CLAUSE_CLASS(Enum, Str, Class) void Visit##Class(Class *S);
8004#include "llvm/Frontend/OpenMP/OMP.inc"
8005 void writeClause(OMPClause *C);
8006 void VisitOMPClauseWithPreInit(OMPClauseWithPreInit *C);
8007 void VisitOMPClauseWithPostUpdate(OMPClauseWithPostUpdate *C);
8008};
8009
8010}
8011
8013 OMPClauseWriter(*this).writeClause(C);
8014}
8015
8016void OMPClauseWriter::writeClause(OMPClause *C) {
8017 Record.push_back(unsigned(C->getClauseKind()));
8018 Visit(C);
8019 Record.AddSourceLocation(C->getBeginLoc());
8020 Record.AddSourceLocation(C->getEndLoc());
8021}
8022
8023void OMPClauseWriter::VisitOMPClauseWithPreInit(OMPClauseWithPreInit *C) {
8024 Record.push_back(uint64_t(C->getCaptureRegion()));
8025 Record.AddStmt(C->getPreInitStmt());
8026}
8027
8028void OMPClauseWriter::VisitOMPClauseWithPostUpdate(OMPClauseWithPostUpdate *C) {
8029 VisitOMPClauseWithPreInit(C);
8030 Record.AddStmt(C->getPostUpdateExpr());
8031}
8032
8033void OMPClauseWriter::VisitOMPIfClause(OMPIfClause *C) {
8034 VisitOMPClauseWithPreInit(C);
8035 Record.push_back(uint64_t(C->getNameModifier()));
8036 Record.AddSourceLocation(C->getNameModifierLoc());
8037 Record.AddSourceLocation(C->getColonLoc());
8038 Record.AddStmt(C->getCondition());
8039 Record.AddSourceLocation(C->getLParenLoc());
8040}
8041
8042void OMPClauseWriter::VisitOMPFinalClause(OMPFinalClause *C) {
8043 VisitOMPClauseWithPreInit(C);
8044 Record.AddStmt(C->getCondition());
8045 Record.AddSourceLocation(C->getLParenLoc());
8046}
8047
8048void OMPClauseWriter::VisitOMPNumThreadsClause(OMPNumThreadsClause *C) {
8049 VisitOMPClauseWithPreInit(C);
8050 Record.writeEnum(C->getModifier());
8051 Record.AddStmt(C->getNumThreads());
8052 Record.AddSourceLocation(C->getModifierLoc());
8053 Record.AddSourceLocation(C->getLParenLoc());
8054}
8055
8056void OMPClauseWriter::VisitOMPSafelenClause(OMPSafelenClause *C) {
8057 Record.AddStmt(C->getSafelen());
8058 Record.AddSourceLocation(C->getLParenLoc());
8059}
8060
8061void OMPClauseWriter::VisitOMPSimdlenClause(OMPSimdlenClause *C) {
8062 Record.AddStmt(C->getSimdlen());
8063 Record.AddSourceLocation(C->getLParenLoc());
8064}
8065
8066void OMPClauseWriter::VisitOMPSizesClause(OMPSizesClause *C) {
8067 Record.push_back(C->getNumSizes());
8068 for (Expr *Size : C->getSizesRefs())
8069 Record.AddStmt(Size);
8070 Record.AddSourceLocation(C->getLParenLoc());
8071}
8072
8073void OMPClauseWriter::VisitOMPPermutationClause(OMPPermutationClause *C) {
8074 Record.push_back(C->getNumLoops());
8075 for (Expr *Size : C->getArgsRefs())
8076 Record.AddStmt(Size);
8077 Record.AddSourceLocation(C->getLParenLoc());
8078}
8079
8080void OMPClauseWriter::VisitOMPFullClause(OMPFullClause *C) {}
8081
8082void OMPClauseWriter::VisitOMPPartialClause(OMPPartialClause *C) {
8083 Record.AddStmt(C->getFactor());
8084 Record.AddSourceLocation(C->getLParenLoc());
8085}
8086
8087void OMPClauseWriter::VisitOMPLoopRangeClause(OMPLoopRangeClause *C) {
8088 Record.AddStmt(C->getFirst());
8089 Record.AddStmt(C->getCount());
8090 Record.AddSourceLocation(C->getLParenLoc());
8091 Record.AddSourceLocation(C->getFirstLoc());
8092 Record.AddSourceLocation(C->getCountLoc());
8093}
8094
8095void OMPClauseWriter::VisitOMPAllocatorClause(OMPAllocatorClause *C) {
8096 Record.AddStmt(C->getAllocator());
8097 Record.AddSourceLocation(C->getLParenLoc());
8098}
8099
8100void OMPClauseWriter::VisitOMPCollapseClause(OMPCollapseClause *C) {
8101 Record.AddStmt(C->getNumForLoops());
8102 Record.AddSourceLocation(C->getLParenLoc());
8103}
8104
8105void OMPClauseWriter::VisitOMPDetachClause(OMPDetachClause *C) {
8106 Record.AddStmt(C->getEventHandler());
8107 Record.AddSourceLocation(C->getLParenLoc());
8108}
8109
8110void OMPClauseWriter::VisitOMPDefaultClause(OMPDefaultClause *C) {
8111 Record.push_back(unsigned(C->getDefaultKind()));
8112 Record.AddSourceLocation(C->getLParenLoc());
8113 Record.AddSourceLocation(C->getDefaultKindKwLoc());
8114 Record.push_back(unsigned(C->getDefaultVC()));
8115 Record.AddSourceLocation(C->getDefaultVCLoc());
8116}
8117
8118void OMPClauseWriter::VisitOMPThreadsetClause(OMPThreadsetClause *C) {
8119 Record.AddSourceLocation(C->getLParenLoc());
8120 Record.AddSourceLocation(C->getThreadsetKindLoc());
8121 Record.writeEnum(C->getThreadsetKind());
8122}
8123
8124void OMPClauseWriter::VisitOMPTransparentClause(OMPTransparentClause *C) {
8125 Record.AddSourceLocation(C->getLParenLoc());
8126 Record.AddStmt(C->getImpexType());
8127}
8128
8129void OMPClauseWriter::VisitOMPProcBindClause(OMPProcBindClause *C) {
8130 Record.push_back(unsigned(C->getProcBindKind()));
8131 Record.AddSourceLocation(C->getLParenLoc());
8132 Record.AddSourceLocation(C->getProcBindKindKwLoc());
8133}
8134
8135void OMPClauseWriter::VisitOMPScheduleClause(OMPScheduleClause *C) {
8136 VisitOMPClauseWithPreInit(C);
8137 Record.push_back(C->getScheduleKind());
8138 Record.push_back(C->getFirstScheduleModifier());
8139 Record.push_back(C->getSecondScheduleModifier());
8140 Record.AddStmt(C->getChunkSize());
8141 Record.AddSourceLocation(C->getLParenLoc());
8142 Record.AddSourceLocation(C->getFirstScheduleModifierLoc());
8143 Record.AddSourceLocation(C->getSecondScheduleModifierLoc());
8144 Record.AddSourceLocation(C->getScheduleKindLoc());
8145 Record.AddSourceLocation(C->getCommaLoc());
8146}
8147
8148void OMPClauseWriter::VisitOMPOrderedClause(OMPOrderedClause *C) {
8149 Record.push_back(C->getLoopNumIterations().size());
8150 Record.AddStmt(C->getNumForLoops());
8151 for (Expr *NumIter : C->getLoopNumIterations())
8152 Record.AddStmt(NumIter);
8153 for (unsigned I = 0, E = C->getLoopNumIterations().size(); I <E; ++I)
8154 Record.AddStmt(C->getLoopCounter(I));
8155 Record.AddSourceLocation(C->getLParenLoc());
8156}
8157
8158void OMPClauseWriter::VisitOMPNowaitClause(OMPNowaitClause *C) {
8159 Record.AddStmt(C->getCondition());
8160 Record.AddSourceLocation(C->getLParenLoc());
8161}
8162
8163void OMPClauseWriter::VisitOMPUntiedClause(OMPUntiedClause *) {}
8164
8165void OMPClauseWriter::VisitOMPMergeableClause(OMPMergeableClause *) {}
8166
8167void OMPClauseWriter::VisitOMPReadClause(OMPReadClause *) {}
8168
8169void OMPClauseWriter::VisitOMPWriteClause(OMPWriteClause *) {}
8170
8171void OMPClauseWriter::VisitOMPUpdateClause(OMPUpdateClause *C) {
8172 Record.push_back(C->isExtended() ? 1 : 0);
8173 if (C->isExtended()) {
8174 Record.AddSourceLocation(C->getLParenLoc());
8175 Record.AddSourceLocation(C->getArgumentLoc());
8176 Record.writeEnum(C->getDependencyKind());
8177 }
8178}
8179
8180void OMPClauseWriter::VisitOMPCaptureClause(OMPCaptureClause *) {}
8181
8182void OMPClauseWriter::VisitOMPCompareClause(OMPCompareClause *) {}
8183
8184// Save the parameter of fail clause.
8185void OMPClauseWriter::VisitOMPFailClause(OMPFailClause *C) {
8186 Record.AddSourceLocation(C->getLParenLoc());
8187 Record.AddSourceLocation(C->getFailParameterLoc());
8188 Record.writeEnum(C->getFailParameter());
8189}
8190
8191void OMPClauseWriter::VisitOMPSeqCstClause(OMPSeqCstClause *) {}
8192
8193void OMPClauseWriter::VisitOMPAcqRelClause(OMPAcqRelClause *) {}
8194
8195void OMPClauseWriter::VisitOMPAbsentClause(OMPAbsentClause *C) {
8196 Record.push_back(static_cast<uint64_t>(C->getDirectiveKinds().size()));
8197 Record.AddSourceLocation(C->getLParenLoc());
8198 for (auto K : C->getDirectiveKinds()) {
8199 Record.writeEnum(K);
8200 }
8201}
8202
8203void OMPClauseWriter::VisitOMPHoldsClause(OMPHoldsClause *C) {
8204 Record.AddStmt(C->getExpr());
8205 Record.AddSourceLocation(C->getLParenLoc());
8206}
8207
8208void OMPClauseWriter::VisitOMPContainsClause(OMPContainsClause *C) {
8209 Record.push_back(static_cast<uint64_t>(C->getDirectiveKinds().size()));
8210 Record.AddSourceLocation(C->getLParenLoc());
8211 for (auto K : C->getDirectiveKinds()) {
8212 Record.writeEnum(K);
8213 }
8214}
8215
8216void OMPClauseWriter::VisitOMPNoOpenMPClause(OMPNoOpenMPClause *) {}
8217
8218void OMPClauseWriter::VisitOMPNoOpenMPRoutinesClause(
8219 OMPNoOpenMPRoutinesClause *) {}
8220
8221void OMPClauseWriter::VisitOMPNoOpenMPConstructsClause(
8222 OMPNoOpenMPConstructsClause *) {}
8223
8224void OMPClauseWriter::VisitOMPNoParallelismClause(OMPNoParallelismClause *) {}
8225
8226void OMPClauseWriter::VisitOMPAcquireClause(OMPAcquireClause *) {}
8227
8228void OMPClauseWriter::VisitOMPReleaseClause(OMPReleaseClause *) {}
8229
8230void OMPClauseWriter::VisitOMPRelaxedClause(OMPRelaxedClause *) {}
8231
8232void OMPClauseWriter::VisitOMPWeakClause(OMPWeakClause *) {}
8233
8234void OMPClauseWriter::VisitOMPThreadsClause(OMPThreadsClause *) {}
8235
8236void OMPClauseWriter::VisitOMPSIMDClause(OMPSIMDClause *) {}
8237
8238void OMPClauseWriter::VisitOMPNogroupClause(OMPNogroupClause *) {}
8239
8240void OMPClauseWriter::VisitOMPInitClause(OMPInitClause *C) {
8241 Record.push_back(C->varlist_size());
8242 for (Expr *VE : C->varlist())
8243 Record.AddStmt(VE);
8244 Record.writeBool(C->getIsTarget());
8245 Record.writeBool(C->getIsTargetSync());
8246 Record.AddSourceLocation(C->getLParenLoc());
8247 Record.AddSourceLocation(C->getVarLoc());
8248}
8249
8250void OMPClauseWriter::VisitOMPUseClause(OMPUseClause *C) {
8251 Record.AddStmt(C->getInteropVar());
8252 Record.AddSourceLocation(C->getLParenLoc());
8253 Record.AddSourceLocation(C->getVarLoc());
8254}
8255
8256void OMPClauseWriter::VisitOMPDestroyClause(OMPDestroyClause *C) {
8257 Record.AddStmt(C->getInteropVar());
8258 Record.AddSourceLocation(C->getLParenLoc());
8259 Record.AddSourceLocation(C->getVarLoc());
8260}
8261
8262void OMPClauseWriter::VisitOMPNovariantsClause(OMPNovariantsClause *C) {
8263 VisitOMPClauseWithPreInit(C);
8264 Record.AddStmt(C->getCondition());
8265 Record.AddSourceLocation(C->getLParenLoc());
8266}
8267
8268void OMPClauseWriter::VisitOMPNocontextClause(OMPNocontextClause *C) {
8269 VisitOMPClauseWithPreInit(C);
8270 Record.AddStmt(C->getCondition());
8271 Record.AddSourceLocation(C->getLParenLoc());
8272}
8273
8274void OMPClauseWriter::VisitOMPFilterClause(OMPFilterClause *C) {
8275 VisitOMPClauseWithPreInit(C);
8276 Record.AddStmt(C->getThreadID());
8277 Record.AddSourceLocation(C->getLParenLoc());
8278}
8279
8280void OMPClauseWriter::VisitOMPAlignClause(OMPAlignClause *C) {
8281 Record.AddStmt(C->getAlignment());
8282 Record.AddSourceLocation(C->getLParenLoc());
8283}
8284
8285void OMPClauseWriter::VisitOMPPrivateClause(OMPPrivateClause *C) {
8286 Record.push_back(C->varlist_size());
8287 Record.AddSourceLocation(C->getLParenLoc());
8288 for (auto *VE : C->varlist()) {
8289 Record.AddStmt(VE);
8290 }
8291 for (auto *VE : C->private_copies()) {
8292 Record.AddStmt(VE);
8293 }
8294}
8295
8296void OMPClauseWriter::VisitOMPFirstprivateClause(OMPFirstprivateClause *C) {
8297 Record.push_back(C->varlist_size());
8298 VisitOMPClauseWithPreInit(C);
8299 Record.AddSourceLocation(C->getLParenLoc());
8300 for (auto *VE : C->varlist()) {
8301 Record.AddStmt(VE);
8302 }
8303 for (auto *VE : C->private_copies()) {
8304 Record.AddStmt(VE);
8305 }
8306 for (auto *VE : C->inits()) {
8307 Record.AddStmt(VE);
8308 }
8309}
8310
8311void OMPClauseWriter::VisitOMPLastprivateClause(OMPLastprivateClause *C) {
8312 Record.push_back(C->varlist_size());
8313 VisitOMPClauseWithPostUpdate(C);
8314 Record.AddSourceLocation(C->getLParenLoc());
8315 Record.writeEnum(C->getKind());
8316 Record.AddSourceLocation(C->getKindLoc());
8317 Record.AddSourceLocation(C->getColonLoc());
8318 for (auto *VE : C->varlist())
8319 Record.AddStmt(VE);
8320 for (auto *E : C->private_copies())
8321 Record.AddStmt(E);
8322 for (auto *E : C->source_exprs())
8323 Record.AddStmt(E);
8324 for (auto *E : C->destination_exprs())
8325 Record.AddStmt(E);
8326 for (auto *E : C->assignment_ops())
8327 Record.AddStmt(E);
8328}
8329
8330void OMPClauseWriter::VisitOMPSharedClause(OMPSharedClause *C) {
8331 Record.push_back(C->varlist_size());
8332 Record.AddSourceLocation(C->getLParenLoc());
8333 for (auto *VE : C->varlist())
8334 Record.AddStmt(VE);
8335}
8336
8337void OMPClauseWriter::VisitOMPReductionClause(OMPReductionClause *C) {
8338 Record.push_back(C->varlist_size());
8339 Record.writeEnum(C->getModifier());
8340 VisitOMPClauseWithPostUpdate(C);
8341 Record.AddSourceLocation(C->getLParenLoc());
8342 Record.AddSourceLocation(C->getModifierLoc());
8343 Record.AddSourceLocation(C->getColonLoc());
8344 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
8345 Record.AddDeclarationNameInfo(C->getNameInfo());
8346 for (auto *VE : C->varlist())
8347 Record.AddStmt(VE);
8348 for (auto *VE : C->privates())
8349 Record.AddStmt(VE);
8350 for (auto *E : C->lhs_exprs())
8351 Record.AddStmt(E);
8352 for (auto *E : C->rhs_exprs())
8353 Record.AddStmt(E);
8354 for (auto *E : C->reduction_ops())
8355 Record.AddStmt(E);
8356 if (C->getModifier() == clang::OMPC_REDUCTION_inscan) {
8357 for (auto *E : C->copy_ops())
8358 Record.AddStmt(E);
8359 for (auto *E : C->copy_array_temps())
8360 Record.AddStmt(E);
8361 for (auto *E : C->copy_array_elems())
8362 Record.AddStmt(E);
8363 }
8364 auto PrivateFlags = C->private_var_reduction_flags();
8365 Record.push_back(std::distance(PrivateFlags.begin(), PrivateFlags.end()));
8366 for (bool Flag : PrivateFlags)
8367 Record.push_back(Flag);
8368}
8369
8370void OMPClauseWriter::VisitOMPTaskReductionClause(OMPTaskReductionClause *C) {
8371 Record.push_back(C->varlist_size());
8372 VisitOMPClauseWithPostUpdate(C);
8373 Record.AddSourceLocation(C->getLParenLoc());
8374 Record.AddSourceLocation(C->getColonLoc());
8375 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
8376 Record.AddDeclarationNameInfo(C->getNameInfo());
8377 for (auto *VE : C->varlist())
8378 Record.AddStmt(VE);
8379 for (auto *VE : C->privates())
8380 Record.AddStmt(VE);
8381 for (auto *E : C->lhs_exprs())
8382 Record.AddStmt(E);
8383 for (auto *E : C->rhs_exprs())
8384 Record.AddStmt(E);
8385 for (auto *E : C->reduction_ops())
8386 Record.AddStmt(E);
8387}
8388
8389void OMPClauseWriter::VisitOMPInReductionClause(OMPInReductionClause *C) {
8390 Record.push_back(C->varlist_size());
8391 VisitOMPClauseWithPostUpdate(C);
8392 Record.AddSourceLocation(C->getLParenLoc());
8393 Record.AddSourceLocation(C->getColonLoc());
8394 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
8395 Record.AddDeclarationNameInfo(C->getNameInfo());
8396 for (auto *VE : C->varlist())
8397 Record.AddStmt(VE);
8398 for (auto *VE : C->privates())
8399 Record.AddStmt(VE);
8400 for (auto *E : C->lhs_exprs())
8401 Record.AddStmt(E);
8402 for (auto *E : C->rhs_exprs())
8403 Record.AddStmt(E);
8404 for (auto *E : C->reduction_ops())
8405 Record.AddStmt(E);
8406 for (auto *E : C->taskgroup_descriptors())
8407 Record.AddStmt(E);
8408}
8409
8410void OMPClauseWriter::VisitOMPLinearClause(OMPLinearClause *C) {
8411 Record.push_back(C->varlist_size());
8412 VisitOMPClauseWithPostUpdate(C);
8413 Record.AddSourceLocation(C->getLParenLoc());
8414 Record.AddSourceLocation(C->getColonLoc());
8415 Record.push_back(C->getModifier());
8416 Record.AddSourceLocation(C->getModifierLoc());
8417 for (auto *VE : C->varlist()) {
8418 Record.AddStmt(VE);
8419 }
8420 for (auto *VE : C->privates()) {
8421 Record.AddStmt(VE);
8422 }
8423 for (auto *VE : C->inits()) {
8424 Record.AddStmt(VE);
8425 }
8426 for (auto *VE : C->updates()) {
8427 Record.AddStmt(VE);
8428 }
8429 for (auto *VE : C->finals()) {
8430 Record.AddStmt(VE);
8431 }
8432 Record.AddStmt(C->getStep());
8433 Record.AddStmt(C->getCalcStep());
8434 for (auto *VE : C->used_expressions())
8435 Record.AddStmt(VE);
8436}
8437
8438void OMPClauseWriter::VisitOMPAlignedClause(OMPAlignedClause *C) {
8439 Record.push_back(C->varlist_size());
8440 Record.AddSourceLocation(C->getLParenLoc());
8441 Record.AddSourceLocation(C->getColonLoc());
8442 for (auto *VE : C->varlist())
8443 Record.AddStmt(VE);
8444 Record.AddStmt(C->getAlignment());
8445}
8446
8447void OMPClauseWriter::VisitOMPCopyinClause(OMPCopyinClause *C) {
8448 Record.push_back(C->varlist_size());
8449 Record.AddSourceLocation(C->getLParenLoc());
8450 for (auto *VE : C->varlist())
8451 Record.AddStmt(VE);
8452 for (auto *E : C->source_exprs())
8453 Record.AddStmt(E);
8454 for (auto *E : C->destination_exprs())
8455 Record.AddStmt(E);
8456 for (auto *E : C->assignment_ops())
8457 Record.AddStmt(E);
8458}
8459
8460void OMPClauseWriter::VisitOMPCopyprivateClause(OMPCopyprivateClause *C) {
8461 Record.push_back(C->varlist_size());
8462 Record.AddSourceLocation(C->getLParenLoc());
8463 for (auto *VE : C->varlist())
8464 Record.AddStmt(VE);
8465 for (auto *E : C->source_exprs())
8466 Record.AddStmt(E);
8467 for (auto *E : C->destination_exprs())
8468 Record.AddStmt(E);
8469 for (auto *E : C->assignment_ops())
8470 Record.AddStmt(E);
8471}
8472
8473void OMPClauseWriter::VisitOMPFlushClause(OMPFlushClause *C) {
8474 Record.push_back(C->varlist_size());
8475 Record.AddSourceLocation(C->getLParenLoc());
8476 for (auto *VE : C->varlist())
8477 Record.AddStmt(VE);
8478}
8479
8480void OMPClauseWriter::VisitOMPDepobjClause(OMPDepobjClause *C) {
8481 Record.AddStmt(C->getDepobj());
8482 Record.AddSourceLocation(C->getLParenLoc());
8483}
8484
8485void OMPClauseWriter::VisitOMPDependClause(OMPDependClause *C) {
8486 Record.push_back(C->varlist_size());
8487 Record.push_back(C->getNumLoops());
8488 Record.AddSourceLocation(C->getLParenLoc());
8489 Record.AddStmt(C->getModifier());
8490 Record.push_back(C->getDependencyKind());
8491 Record.AddSourceLocation(C->getDependencyLoc());
8492 Record.AddSourceLocation(C->getColonLoc());
8493 Record.AddSourceLocation(C->getOmpAllMemoryLoc());
8494 for (auto *VE : C->varlist())
8495 Record.AddStmt(VE);
8496 for (unsigned I = 0, E = C->getNumLoops(); I < E; ++I)
8497 Record.AddStmt(C->getLoopData(I));
8498}
8499
8500void OMPClauseWriter::VisitOMPDeviceClause(OMPDeviceClause *C) {
8501 VisitOMPClauseWithPreInit(C);
8502 Record.writeEnum(C->getModifier());
8503 Record.AddStmt(C->getDevice());
8504 Record.AddSourceLocation(C->getModifierLoc());
8505 Record.AddSourceLocation(C->getLParenLoc());
8506}
8507
8508void OMPClauseWriter::VisitOMPMapClause(OMPMapClause *C) {
8509 Record.push_back(C->varlist_size());
8510 Record.push_back(C->getUniqueDeclarationsNum());
8511 Record.push_back(C->getTotalComponentListNum());
8512 Record.push_back(C->getTotalComponentsNum());
8513 Record.AddSourceLocation(C->getLParenLoc());
8514 bool HasIteratorModifier = false;
8515 for (unsigned I = 0; I < NumberOfOMPMapClauseModifiers; ++I) {
8516 Record.push_back(C->getMapTypeModifier(I));
8517 Record.AddSourceLocation(C->getMapTypeModifierLoc(I));
8518 if (C->getMapTypeModifier(I) == OMPC_MAP_MODIFIER_iterator)
8519 HasIteratorModifier = true;
8520 }
8521 Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
8522 Record.AddDeclarationNameInfo(C->getMapperIdInfo());
8523 Record.push_back(C->getMapType());
8524 Record.AddSourceLocation(C->getMapLoc());
8525 Record.AddSourceLocation(C->getColonLoc());
8526 for (auto *E : C->varlist())
8527 Record.AddStmt(E);
8528 for (auto *E : C->mapperlists())
8529 Record.AddStmt(E);
8530 if (HasIteratorModifier)
8531 Record.AddStmt(C->getIteratorModifier());
8532 for (auto *D : C->all_decls())
8533 Record.AddDeclRef(D);
8534 for (auto N : C->all_num_lists())
8535 Record.push_back(N);
8536 for (auto N : C->all_lists_sizes())
8537 Record.push_back(N);
8538 for (auto &M : C->all_components()) {
8539 Record.AddStmt(M.getAssociatedExpression());
8540 Record.AddDeclRef(M.getAssociatedDeclaration());
8541 }
8542}
8543
8544void OMPClauseWriter::VisitOMPAllocateClause(OMPAllocateClause *C) {
8545 Record.push_back(C->varlist_size());
8546 Record.writeEnum(C->getFirstAllocateModifier());
8547 Record.writeEnum(C->getSecondAllocateModifier());
8548 Record.AddSourceLocation(C->getLParenLoc());
8549 Record.AddSourceLocation(C->getColonLoc());
8550 Record.AddStmt(C->getAllocator());
8551 Record.AddStmt(C->getAlignment());
8552 for (auto *VE : C->varlist())
8553 Record.AddStmt(VE);
8554}
8555
8556void OMPClauseWriter::VisitOMPNumTeamsClause(OMPNumTeamsClause *C) {
8557 Record.push_back(C->varlist_size());
8558 VisitOMPClauseWithPreInit(C);
8559 Record.AddSourceLocation(C->getLParenLoc());
8560 for (auto *VE : C->varlist())
8561 Record.AddStmt(VE);
8562}
8563
8564void OMPClauseWriter::VisitOMPThreadLimitClause(OMPThreadLimitClause *C) {
8565 Record.push_back(C->varlist_size());
8566 VisitOMPClauseWithPreInit(C);
8567 Record.AddSourceLocation(C->getLParenLoc());
8568 for (auto *VE : C->varlist())
8569 Record.AddStmt(VE);
8570}
8571
8572void OMPClauseWriter::VisitOMPPriorityClause(OMPPriorityClause *C) {
8573 VisitOMPClauseWithPreInit(C);
8574 Record.AddStmt(C->getPriority());
8575 Record.AddSourceLocation(C->getLParenLoc());
8576}
8577
8578void OMPClauseWriter::VisitOMPGrainsizeClause(OMPGrainsizeClause *C) {
8579 VisitOMPClauseWithPreInit(C);
8580 Record.writeEnum(C->getModifier());
8581 Record.AddStmt(C->getGrainsize());
8582 Record.AddSourceLocation(C->getModifierLoc());
8583 Record.AddSourceLocation(C->getLParenLoc());
8584}
8585
8586void OMPClauseWriter::VisitOMPNumTasksClause(OMPNumTasksClause *C) {
8587 VisitOMPClauseWithPreInit(C);
8588 Record.writeEnum(C->getModifier());
8589 Record.AddStmt(C->getNumTasks());
8590 Record.AddSourceLocation(C->getModifierLoc());
8591 Record.AddSourceLocation(C->getLParenLoc());
8592}
8593
8594void OMPClauseWriter::VisitOMPHintClause(OMPHintClause *C) {
8595 Record.AddStmt(C->getHint());
8596 Record.AddSourceLocation(C->getLParenLoc());
8597}
8598
8599void OMPClauseWriter::VisitOMPDistScheduleClause(OMPDistScheduleClause *C) {
8600 VisitOMPClauseWithPreInit(C);
8601 Record.push_back(C->getDistScheduleKind());
8602 Record.AddStmt(C->getChunkSize());
8603 Record.AddSourceLocation(C->getLParenLoc());
8604 Record.AddSourceLocation(C->getDistScheduleKindLoc());
8605 Record.AddSourceLocation(C->getCommaLoc());
8606}
8607
8608void OMPClauseWriter::VisitOMPDefaultmapClause(OMPDefaultmapClause *C) {
8609 Record.push_back(C->getDefaultmapKind());
8610 Record.push_back(C->getDefaultmapModifier());
8611 Record.AddSourceLocation(C->getLParenLoc());
8612 Record.AddSourceLocation(C->getDefaultmapModifierLoc());
8613 Record.AddSourceLocation(C->getDefaultmapKindLoc());
8614}
8615
8616void OMPClauseWriter::VisitOMPToClause(OMPToClause *C) {
8617 Record.push_back(C->varlist_size());
8618 Record.push_back(C->getUniqueDeclarationsNum());
8619 Record.push_back(C->getTotalComponentListNum());
8620 Record.push_back(C->getTotalComponentsNum());
8621 Record.AddSourceLocation(C->getLParenLoc());
8622 for (unsigned I = 0; I < NumberOfOMPMotionModifiers; ++I) {
8623 Record.push_back(C->getMotionModifier(I));
8624 Record.AddSourceLocation(C->getMotionModifierLoc(I));
8625 if (C->getMotionModifier(I) == OMPC_MOTION_MODIFIER_iterator)
8626 Record.AddStmt(C->getIteratorModifier());
8627 }
8628 Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
8629 Record.AddDeclarationNameInfo(C->getMapperIdInfo());
8630 Record.AddSourceLocation(C->getColonLoc());
8631 for (auto *E : C->varlist())
8632 Record.AddStmt(E);
8633 for (auto *E : C->mapperlists())
8634 Record.AddStmt(E);
8635 for (auto *D : C->all_decls())
8636 Record.AddDeclRef(D);
8637 for (auto N : C->all_num_lists())
8638 Record.push_back(N);
8639 for (auto N : C->all_lists_sizes())
8640 Record.push_back(N);
8641 for (auto &M : C->all_components()) {
8642 Record.AddStmt(M.getAssociatedExpression());
8643 Record.writeBool(M.isNonContiguous());
8644 Record.AddDeclRef(M.getAssociatedDeclaration());
8645 }
8646}
8647
8648void OMPClauseWriter::VisitOMPFromClause(OMPFromClause *C) {
8649 Record.push_back(C->varlist_size());
8650 Record.push_back(C->getUniqueDeclarationsNum());
8651 Record.push_back(C->getTotalComponentListNum());
8652 Record.push_back(C->getTotalComponentsNum());
8653 Record.AddSourceLocation(C->getLParenLoc());
8654 for (unsigned I = 0; I < NumberOfOMPMotionModifiers; ++I) {
8655 Record.push_back(C->getMotionModifier(I));
8656 Record.AddSourceLocation(C->getMotionModifierLoc(I));
8657 if (C->getMotionModifier(I) == OMPC_MOTION_MODIFIER_iterator)
8658 Record.AddStmt(C->getIteratorModifier());
8659 }
8660 Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
8661 Record.AddDeclarationNameInfo(C->getMapperIdInfo());
8662 Record.AddSourceLocation(C->getColonLoc());
8663 for (auto *E : C->varlist())
8664 Record.AddStmt(E);
8665 for (auto *E : C->mapperlists())
8666 Record.AddStmt(E);
8667 for (auto *D : C->all_decls())
8668 Record.AddDeclRef(D);
8669 for (auto N : C->all_num_lists())
8670 Record.push_back(N);
8671 for (auto N : C->all_lists_sizes())
8672 Record.push_back(N);
8673 for (auto &M : C->all_components()) {
8674 Record.AddStmt(M.getAssociatedExpression());
8675 Record.writeBool(M.isNonContiguous());
8676 Record.AddDeclRef(M.getAssociatedDeclaration());
8677 }
8678}
8679
8680void OMPClauseWriter::VisitOMPUseDevicePtrClause(OMPUseDevicePtrClause *C) {
8681 Record.push_back(C->varlist_size());
8682 Record.push_back(C->getUniqueDeclarationsNum());
8683 Record.push_back(C->getTotalComponentListNum());
8684 Record.push_back(C->getTotalComponentsNum());
8685 Record.AddSourceLocation(C->getLParenLoc());
8686 Record.writeEnum(C->getFallbackModifier());
8687 Record.AddSourceLocation(C->getFallbackModifierLoc());
8688 for (auto *E : C->varlist())
8689 Record.AddStmt(E);
8690 for (auto *VE : C->private_copies())
8691 Record.AddStmt(VE);
8692 for (auto *VE : C->inits())
8693 Record.AddStmt(VE);
8694 for (auto *D : C->all_decls())
8695 Record.AddDeclRef(D);
8696 for (auto N : C->all_num_lists())
8697 Record.push_back(N);
8698 for (auto N : C->all_lists_sizes())
8699 Record.push_back(N);
8700 for (auto &M : C->all_components()) {
8701 Record.AddStmt(M.getAssociatedExpression());
8702 Record.AddDeclRef(M.getAssociatedDeclaration());
8703 }
8704}
8705
8706void OMPClauseWriter::VisitOMPUseDeviceAddrClause(OMPUseDeviceAddrClause *C) {
8707 Record.push_back(C->varlist_size());
8708 Record.push_back(C->getUniqueDeclarationsNum());
8709 Record.push_back(C->getTotalComponentListNum());
8710 Record.push_back(C->getTotalComponentsNum());
8711 Record.AddSourceLocation(C->getLParenLoc());
8712 for (auto *E : C->varlist())
8713 Record.AddStmt(E);
8714 for (auto *D : C->all_decls())
8715 Record.AddDeclRef(D);
8716 for (auto N : C->all_num_lists())
8717 Record.push_back(N);
8718 for (auto N : C->all_lists_sizes())
8719 Record.push_back(N);
8720 for (auto &M : C->all_components()) {
8721 Record.AddStmt(M.getAssociatedExpression());
8722 Record.AddDeclRef(M.getAssociatedDeclaration());
8723 }
8724}
8725
8726void OMPClauseWriter::VisitOMPIsDevicePtrClause(OMPIsDevicePtrClause *C) {
8727 Record.push_back(C->varlist_size());
8728 Record.push_back(C->getUniqueDeclarationsNum());
8729 Record.push_back(C->getTotalComponentListNum());
8730 Record.push_back(C->getTotalComponentsNum());
8731 Record.AddSourceLocation(C->getLParenLoc());
8732 for (auto *E : C->varlist())
8733 Record.AddStmt(E);
8734 for (auto *D : C->all_decls())
8735 Record.AddDeclRef(D);
8736 for (auto N : C->all_num_lists())
8737 Record.push_back(N);
8738 for (auto N : C->all_lists_sizes())
8739 Record.push_back(N);
8740 for (auto &M : C->all_components()) {
8741 Record.AddStmt(M.getAssociatedExpression());
8742 Record.AddDeclRef(M.getAssociatedDeclaration());
8743 }
8744}
8745
8746void OMPClauseWriter::VisitOMPHasDeviceAddrClause(OMPHasDeviceAddrClause *C) {
8747 Record.push_back(C->varlist_size());
8748 Record.push_back(C->getUniqueDeclarationsNum());
8749 Record.push_back(C->getTotalComponentListNum());
8750 Record.push_back(C->getTotalComponentsNum());
8751 Record.AddSourceLocation(C->getLParenLoc());
8752 for (auto *E : C->varlist())
8753 Record.AddStmt(E);
8754 for (auto *D : C->all_decls())
8755 Record.AddDeclRef(D);
8756 for (auto N : C->all_num_lists())
8757 Record.push_back(N);
8758 for (auto N : C->all_lists_sizes())
8759 Record.push_back(N);
8760 for (auto &M : C->all_components()) {
8761 Record.AddStmt(M.getAssociatedExpression());
8762 Record.AddDeclRef(M.getAssociatedDeclaration());
8763 }
8764}
8765
8766void OMPClauseWriter::VisitOMPUnifiedAddressClause(OMPUnifiedAddressClause *) {}
8767
8768void OMPClauseWriter::VisitOMPUnifiedSharedMemoryClause(
8769 OMPUnifiedSharedMemoryClause *) {}
8770
8771void OMPClauseWriter::VisitOMPReverseOffloadClause(OMPReverseOffloadClause *) {}
8772
8773void
8774OMPClauseWriter::VisitOMPDynamicAllocatorsClause(OMPDynamicAllocatorsClause *) {
8775}
8776
8777void OMPClauseWriter::VisitOMPAtomicDefaultMemOrderClause(
8778 OMPAtomicDefaultMemOrderClause *C) {
8779 Record.push_back(C->getAtomicDefaultMemOrderKind());
8780 Record.AddSourceLocation(C->getLParenLoc());
8781 Record.AddSourceLocation(C->getAtomicDefaultMemOrderKindKwLoc());
8782}
8783
8784void OMPClauseWriter::VisitOMPSelfMapsClause(OMPSelfMapsClause *) {}
8785
8786void OMPClauseWriter::VisitOMPAtClause(OMPAtClause *C) {
8787 Record.push_back(C->getAtKind());
8788 Record.AddSourceLocation(C->getLParenLoc());
8789 Record.AddSourceLocation(C->getAtKindKwLoc());
8790}
8791
8792void OMPClauseWriter::VisitOMPSeverityClause(OMPSeverityClause *C) {
8793 Record.push_back(C->getSeverityKind());
8794 Record.AddSourceLocation(C->getLParenLoc());
8795 Record.AddSourceLocation(C->getSeverityKindKwLoc());
8796}
8797
8798void OMPClauseWriter::VisitOMPMessageClause(OMPMessageClause *C) {
8799 VisitOMPClauseWithPreInit(C);
8800 Record.AddStmt(C->getMessageString());
8801 Record.AddSourceLocation(C->getLParenLoc());
8802}
8803
8804void OMPClauseWriter::VisitOMPNontemporalClause(OMPNontemporalClause *C) {
8805 Record.push_back(C->varlist_size());
8806 Record.AddSourceLocation(C->getLParenLoc());
8807 for (auto *VE : C->varlist())
8808 Record.AddStmt(VE);
8809 for (auto *E : C->private_refs())
8810 Record.AddStmt(E);
8811}
8812
8813void OMPClauseWriter::VisitOMPInclusiveClause(OMPInclusiveClause *C) {
8814 Record.push_back(C->varlist_size());
8815 Record.AddSourceLocation(C->getLParenLoc());
8816 for (auto *VE : C->varlist())
8817 Record.AddStmt(VE);
8818}
8819
8820void OMPClauseWriter::VisitOMPExclusiveClause(OMPExclusiveClause *C) {
8821 Record.push_back(C->varlist_size());
8822 Record.AddSourceLocation(C->getLParenLoc());
8823 for (auto *VE : C->varlist())
8824 Record.AddStmt(VE);
8825}
8826
8827void OMPClauseWriter::VisitOMPOrderClause(OMPOrderClause *C) {
8828 Record.writeEnum(C->getKind());
8829 Record.writeEnum(C->getModifier());
8830 Record.AddSourceLocation(C->getLParenLoc());
8831 Record.AddSourceLocation(C->getKindKwLoc());
8832 Record.AddSourceLocation(C->getModifierKwLoc());
8833}
8834
8835void OMPClauseWriter::VisitOMPUsesAllocatorsClause(OMPUsesAllocatorsClause *C) {
8836 Record.push_back(C->getNumberOfAllocators());
8837 Record.AddSourceLocation(C->getLParenLoc());
8838 for (unsigned I = 0, E = C->getNumberOfAllocators(); I < E; ++I) {
8839 OMPUsesAllocatorsClause::Data Data = C->getAllocatorData(I);
8840 Record.AddStmt(Data.Allocator);
8841 Record.AddStmt(Data.AllocatorTraits);
8842 Record.AddSourceLocation(Data.LParenLoc);
8843 Record.AddSourceLocation(Data.RParenLoc);
8844 }
8845}
8846
8847void OMPClauseWriter::VisitOMPAffinityClause(OMPAffinityClause *C) {
8848 Record.push_back(C->varlist_size());
8849 Record.AddSourceLocation(C->getLParenLoc());
8850 Record.AddStmt(C->getModifier());
8851 Record.AddSourceLocation(C->getColonLoc());
8852 for (Expr *E : C->varlist())
8853 Record.AddStmt(E);
8854}
8855
8856void OMPClauseWriter::VisitOMPBindClause(OMPBindClause *C) {
8857 Record.writeEnum(C->getBindKind());
8858 Record.AddSourceLocation(C->getLParenLoc());
8859 Record.AddSourceLocation(C->getBindKindLoc());
8860}
8861
8862void OMPClauseWriter::VisitOMPXDynCGroupMemClause(OMPXDynCGroupMemClause *C) {
8863 VisitOMPClauseWithPreInit(C);
8864 Record.AddStmt(C->getSize());
8865 Record.AddSourceLocation(C->getLParenLoc());
8866}
8867
8868void OMPClauseWriter::VisitOMPDynGroupprivateClause(
8869 OMPDynGroupprivateClause *C) {
8870 VisitOMPClauseWithPreInit(C);
8871 Record.push_back(C->getDynGroupprivateModifier());
8872 Record.push_back(C->getDynGroupprivateFallbackModifier());
8873 Record.AddStmt(C->getSize());
8874 Record.AddSourceLocation(C->getLParenLoc());
8875 Record.AddSourceLocation(C->getDynGroupprivateModifierLoc());
8876 Record.AddSourceLocation(C->getDynGroupprivateFallbackModifierLoc());
8877}
8878
8879void OMPClauseWriter::VisitOMPDoacrossClause(OMPDoacrossClause *C) {
8880 Record.push_back(C->varlist_size());
8881 Record.push_back(C->getNumLoops());
8882 Record.AddSourceLocation(C->getLParenLoc());
8883 Record.push_back(C->getDependenceType());
8884 Record.AddSourceLocation(C->getDependenceLoc());
8885 Record.AddSourceLocation(C->getColonLoc());
8886 for (auto *VE : C->varlist())
8887 Record.AddStmt(VE);
8888 for (unsigned I = 0, E = C->getNumLoops(); I < E; ++I)
8889 Record.AddStmt(C->getLoopData(I));
8890}
8891
8892void OMPClauseWriter::VisitOMPXAttributeClause(OMPXAttributeClause *C) {
8893 Record.AddAttributes(C->getAttrs());
8894 Record.AddSourceLocation(C->getBeginLoc());
8895 Record.AddSourceLocation(C->getLParenLoc());
8896 Record.AddSourceLocation(C->getEndLoc());
8897}
8898
8899void OMPClauseWriter::VisitOMPXBareClause(OMPXBareClause *C) {}
8900
8902 writeUInt32(TI->Sets.size());
8903 for (const auto &Set : TI->Sets) {
8904 writeEnum(Set.Kind);
8905 writeUInt32(Set.Selectors.size());
8906 for (const auto &Selector : Set.Selectors) {
8907 writeEnum(Selector.Kind);
8908 writeBool(Selector.ScoreOrCondition);
8909 if (Selector.ScoreOrCondition)
8910 writeExprRef(Selector.ScoreOrCondition);
8911 writeUInt32(Selector.Properties.size());
8912 for (const auto &Property : Selector.Properties)
8913 writeEnum(Property.Kind);
8914 }
8915 }
8916}
8917
8919 if (!Data)
8920 return;
8921 writeUInt32(Data->getNumClauses());
8922 writeUInt32(Data->getNumChildren());
8923 writeBool(Data->hasAssociatedStmt());
8924 for (unsigned I = 0, E = Data->getNumClauses(); I < E; ++I)
8925 writeOMPClause(Data->getClauses()[I]);
8926 if (Data->hasAssociatedStmt())
8927 AddStmt(Data->getAssociatedStmt());
8928 for (unsigned I = 0, E = Data->getNumChildren(); I < E; ++I)
8929 AddStmt(Data->getChildren()[I]);
8930}
8931
8933 writeUInt32(C->getVarList().size());
8934 for (Expr *E : C->getVarList())
8935 AddStmt(E);
8936}
8937
8939 writeUInt32(Exprs.size());
8940 for (Expr *E : Exprs)
8941 AddStmt(E);
8942}
8943
8945 writeEnum(C->getClauseKind());
8946 writeSourceLocation(C->getBeginLoc());
8947 writeSourceLocation(C->getEndLoc());
8948
8949 switch (C->getClauseKind()) {
8951 const auto *DC = cast<OpenACCDefaultClause>(C);
8952 writeSourceLocation(DC->getLParenLoc());
8953 writeEnum(DC->getDefaultClauseKind());
8954 return;
8955 }
8956 case OpenACCClauseKind::If: {
8957 const auto *IC = cast<OpenACCIfClause>(C);
8958 writeSourceLocation(IC->getLParenLoc());
8959 AddStmt(const_cast<Expr*>(IC->getConditionExpr()));
8960 return;
8961 }
8963 const auto *SC = cast<OpenACCSelfClause>(C);
8964 writeSourceLocation(SC->getLParenLoc());
8965 writeBool(SC->isConditionExprClause());
8966 if (SC->isConditionExprClause()) {
8967 writeBool(SC->hasConditionExpr());
8968 if (SC->hasConditionExpr())
8969 AddStmt(const_cast<Expr *>(SC->getConditionExpr()));
8970 } else {
8971 writeUInt32(SC->getVarList().size());
8972 for (Expr *E : SC->getVarList())
8973 AddStmt(E);
8974 }
8975 return;
8976 }
8978 const auto *NGC = cast<OpenACCNumGangsClause>(C);
8979 writeSourceLocation(NGC->getLParenLoc());
8980 writeUInt32(NGC->getIntExprs().size());
8981 for (Expr *E : NGC->getIntExprs())
8982 AddStmt(E);
8983 return;
8984 }
8986 const auto *DNC = cast<OpenACCDeviceNumClause>(C);
8987 writeSourceLocation(DNC->getLParenLoc());
8988 AddStmt(const_cast<Expr*>(DNC->getIntExpr()));
8989 return;
8990 }
8992 const auto *DAC = cast<OpenACCDefaultAsyncClause>(C);
8993 writeSourceLocation(DAC->getLParenLoc());
8994 AddStmt(const_cast<Expr *>(DAC->getIntExpr()));
8995 return;
8996 }
8998 const auto *NWC = cast<OpenACCNumWorkersClause>(C);
8999 writeSourceLocation(NWC->getLParenLoc());
9000 AddStmt(const_cast<Expr*>(NWC->getIntExpr()));
9001 return;
9002 }
9004 const auto *NWC = cast<OpenACCVectorLengthClause>(C);
9005 writeSourceLocation(NWC->getLParenLoc());
9006 AddStmt(const_cast<Expr*>(NWC->getIntExpr()));
9007 return;
9008 }
9010 const auto *PC = cast<OpenACCPrivateClause>(C);
9011 writeSourceLocation(PC->getLParenLoc());
9013
9014 for (const OpenACCPrivateRecipe &R : PC->getInitRecipes()) {
9015 static_assert(sizeof(R) == 1 * sizeof(int *));
9016 AddDeclRef(R.AllocaDecl);
9017 }
9018 return;
9019 }
9021 const auto *HC = cast<OpenACCHostClause>(C);
9022 writeSourceLocation(HC->getLParenLoc());
9024 return;
9025 }
9027 const auto *DC = cast<OpenACCDeviceClause>(C);
9028 writeSourceLocation(DC->getLParenLoc());
9030 return;
9031 }
9033 const auto *FPC = cast<OpenACCFirstPrivateClause>(C);
9034 writeSourceLocation(FPC->getLParenLoc());
9036
9037 for (const OpenACCFirstPrivateRecipe &R : FPC->getInitRecipes()) {
9038 static_assert(sizeof(R) == 2 * sizeof(int *));
9039 AddDeclRef(R.AllocaDecl);
9040 AddDeclRef(R.InitFromTemporary);
9041 }
9042 return;
9043 }
9045 const auto *AC = cast<OpenACCAttachClause>(C);
9046 writeSourceLocation(AC->getLParenLoc());
9048 return;
9049 }
9051 const auto *DC = cast<OpenACCDetachClause>(C);
9052 writeSourceLocation(DC->getLParenLoc());
9054 return;
9055 }
9057 const auto *DC = cast<OpenACCDeleteClause>(C);
9058 writeSourceLocation(DC->getLParenLoc());
9060 return;
9061 }
9063 const auto *UDC = cast<OpenACCUseDeviceClause>(C);
9064 writeSourceLocation(UDC->getLParenLoc());
9066 return;
9067 }
9069 const auto *DPC = cast<OpenACCDevicePtrClause>(C);
9070 writeSourceLocation(DPC->getLParenLoc());
9072 return;
9073 }
9075 const auto *NCC = cast<OpenACCNoCreateClause>(C);
9076 writeSourceLocation(NCC->getLParenLoc());
9078 return;
9079 }
9081 const auto *PC = cast<OpenACCPresentClause>(C);
9082 writeSourceLocation(PC->getLParenLoc());
9084 return;
9085 }
9089 const auto *CC = cast<OpenACCCopyClause>(C);
9090 writeSourceLocation(CC->getLParenLoc());
9091 writeEnum(CC->getModifierList());
9093 return;
9094 }
9098 const auto *CIC = cast<OpenACCCopyInClause>(C);
9099 writeSourceLocation(CIC->getLParenLoc());
9100 writeEnum(CIC->getModifierList());
9102 return;
9103 }
9107 const auto *COC = cast<OpenACCCopyOutClause>(C);
9108 writeSourceLocation(COC->getLParenLoc());
9109 writeEnum(COC->getModifierList());
9111 return;
9112 }
9116 const auto *CC = cast<OpenACCCreateClause>(C);
9117 writeSourceLocation(CC->getLParenLoc());
9118 writeEnum(CC->getModifierList());
9120 return;
9121 }
9123 const auto *AC = cast<OpenACCAsyncClause>(C);
9124 writeSourceLocation(AC->getLParenLoc());
9125 writeBool(AC->hasIntExpr());
9126 if (AC->hasIntExpr())
9127 AddStmt(const_cast<Expr*>(AC->getIntExpr()));
9128 return;
9129 }
9131 const auto *WC = cast<OpenACCWaitClause>(C);
9132 writeSourceLocation(WC->getLParenLoc());
9133 writeBool(WC->getDevNumExpr());
9134 if (Expr *DNE = WC->getDevNumExpr())
9135 AddStmt(DNE);
9136 writeSourceLocation(WC->getQueuesLoc());
9137
9138 writeOpenACCIntExprList(WC->getQueueIdExprs());
9139 return;
9140 }
9143 const auto *DTC = cast<OpenACCDeviceTypeClause>(C);
9144 writeSourceLocation(DTC->getLParenLoc());
9145 writeUInt32(DTC->getArchitectures().size());
9146 for (const DeviceTypeArgument &Arg : DTC->getArchitectures()) {
9147 writeBool(Arg.getIdentifierInfo());
9148 if (Arg.getIdentifierInfo())
9149 AddIdentifierRef(Arg.getIdentifierInfo());
9150 writeSourceLocation(Arg.getLoc());
9151 }
9152 return;
9153 }
9155 const auto *RC = cast<OpenACCReductionClause>(C);
9156 writeSourceLocation(RC->getLParenLoc());
9157 writeEnum(RC->getReductionOp());
9159
9160 for (const OpenACCReductionRecipe &R : RC->getRecipes()) {
9161 AddDeclRef(R.AllocaDecl);
9162
9163 static_assert(sizeof(OpenACCReductionRecipe::CombinerRecipe) ==
9164 3 * sizeof(int *));
9165 writeUInt32(R.CombinerRecipes.size());
9166
9167 for (auto &CombinerRecipe : R.CombinerRecipes) {
9168 AddDeclRef(CombinerRecipe.LHS);
9169 AddDeclRef(CombinerRecipe.RHS);
9170 AddStmt(CombinerRecipe.Op);
9171 }
9172 }
9173 return;
9174 }
9181 // Nothing to do here, there is no additional information beyond the
9182 // begin/end loc and clause kind.
9183 return;
9185 const auto *CC = cast<OpenACCCollapseClause>(C);
9186 writeSourceLocation(CC->getLParenLoc());
9187 writeBool(CC->hasForce());
9188 AddStmt(const_cast<Expr *>(CC->getLoopCount()));
9189 return;
9190 }
9192 const auto *TC = cast<OpenACCTileClause>(C);
9193 writeSourceLocation(TC->getLParenLoc());
9194 writeUInt32(TC->getSizeExprs().size());
9195 for (Expr *E : TC->getSizeExprs())
9196 AddStmt(E);
9197 return;
9198 }
9200 const auto *GC = cast<OpenACCGangClause>(C);
9201 writeSourceLocation(GC->getLParenLoc());
9202 writeUInt32(GC->getNumExprs());
9203 for (unsigned I = 0; I < GC->getNumExprs(); ++I) {
9204 writeEnum(GC->getExpr(I).first);
9205 AddStmt(const_cast<Expr *>(GC->getExpr(I).second));
9206 }
9207 return;
9208 }
9210 const auto *WC = cast<OpenACCWorkerClause>(C);
9211 writeSourceLocation(WC->getLParenLoc());
9212 writeBool(WC->hasIntExpr());
9213 if (WC->hasIntExpr())
9214 AddStmt(const_cast<Expr *>(WC->getIntExpr()));
9215 return;
9216 }
9218 const auto *VC = cast<OpenACCVectorClause>(C);
9219 writeSourceLocation(VC->getLParenLoc());
9220 writeBool(VC->hasIntExpr());
9221 if (VC->hasIntExpr())
9222 AddStmt(const_cast<Expr *>(VC->getIntExpr()));
9223 return;
9224 }
9226 const auto *LC = cast<OpenACCLinkClause>(C);
9227 writeSourceLocation(LC->getLParenLoc());
9229 return;
9230 }
9232 const auto *DRC = cast<OpenACCDeviceResidentClause>(C);
9233 writeSourceLocation(DRC->getLParenLoc());
9235 return;
9236 }
9237
9239 const auto *BC = cast<OpenACCBindClause>(C);
9240 writeSourceLocation(BC->getLParenLoc());
9241 writeBool(BC->isStringArgument());
9242 if (BC->isStringArgument())
9243 AddStmt(const_cast<StringLiteral *>(BC->getStringArgument()));
9244 else
9245 AddIdentifierRef(BC->getIdentifierArgument());
9246
9247 return;
9248 }
9251 llvm_unreachable("Clause serialization not yet implemented");
9252 }
9253 llvm_unreachable("Invalid Clause Kind");
9254}
9255
9258 for (const OpenACCClause *Clause : Clauses)
9259 writeOpenACCClause(Clause);
9260}
9262 const OpenACCRoutineDeclAttr *A) {
9263 // We have to write the size so that the reader can do a resize. Unlike the
9264 // Decl version of this, we can't count on trailing storage to get this right.
9265 writeUInt32(A->Clauses.size());
9266 writeOpenACCClauseList(A->Clauses);
9267}
#define RECORD(CLASS, BASE)
Defines the clang::ASTContext interface.
#define V(N, I)
static bool isInterestingIdentifier(ASTReader &Reader, const IdentifierInfo &II, bool IsModule)
Whether the given identifier is "interesting".
static NamedDecl * getDeclForLocalLookup(const LangOptions &LangOpts, NamedDecl *D)
Determine the declaration that should be put into the name lookup table to represent the given declar...
static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream)
Create an abbreviation for the SLocEntry that refers to a buffer.
static bool isLookupResultNotInteresting(ASTWriter &Writer, StoredDeclsList &Result)
Returns true if all of the lookup result are either external, not emitted or predefined.
static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec)
static bool IsInternalDeclFromFileContext(const Decl *D)
static TypeID MakeTypeID(ASTContext &Context, QualType T, IdxForTypeTy IdxForType)
static void AddLazyVectorEmiitedDecls(ASTWriter &Writer, Vector &Vec, ASTWriter::RecordData &Record)
static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream)
Create an abbreviation for the SLocEntry that refers to a macro expansion.
static StringRef bytes(const std::vector< T, Allocator > &v)
static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream, bool Compressed)
Create an abbreviation for the SLocEntry that refers to a buffer's blob.
static void BackpatchSignatureAt(llvm::BitstreamWriter &Stream, const ASTFileSignature &S, uint64_t BitNo)
static const char * adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir)
Adjusts the given filename to only write out the portion of the filename that is not part of the syst...
static bool isLocalIdentifierID(IdentifierID ID)
If the.
static unsigned getNumberOfModules(Module *Mod)
Compute the number of modules within the given tree (including the given module).
static bool isImportedDeclContext(ASTReader *Chain, const Decl *D)
static TypeCode getTypeCodeForTypeClass(Type::TypeClass id)
static void AddStmtsExprs(llvm::BitstreamWriter &Stream, ASTWriter::RecordDataImpl &Record)
static void emitBlob(llvm::BitstreamWriter &Stream, StringRef Blob, unsigned SLocBufferBlobCompressedAbbrv, unsigned SLocBufferBlobAbbrv)
static uint64_t EmitCXXBaseSpecifiers(ASTContext &Context, ASTWriter &W, ArrayRef< CXXBaseSpecifier > Bases)
static std::pair< unsigned, unsigned > emitULEBKeyDataLength(unsigned KeyLen, unsigned DataLen, raw_ostream &Out)
Emit key length and data length as ULEB-encoded data, and return them as a pair.
static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule, const Preprocessor &PP)
static uint64_t EmitCXXCtorInitializers(ASTContext &Context, ASTWriter &W, ArrayRef< CXXCtorInitializer * > CtorInits)
static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream)
Create an abbreviation for the SLocEntry that refers to a file.
Defines the Diagnostic-related interfaces.
Defines the C++ Decl subclasses, other than those for templates (found in DeclTemplate....
Defines the C++ template declaration subclasses.
Defines the clang::Expr interface and subclasses for C++ expressions.
Defines interfaces for clang::FileEntry and clang::FileEntryRef.
Defines the clang::FileManager interface and associated types.
Defines the clang::FileSystemOptions interface.
TokenType getType() const
Returns the token's type, e.g.
std::shared_ptr< TokenRole > Role
A token can have a special role that can carry extra information about the token's formatting.
Token Tok
The Token.
Defines the clang::IdentifierInfo, clang::IdentifierTable, and clang::Selector interfaces.
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified.
Defines the LambdaCapture class.
Defines several types used to describe C++ lambda expressions that are shared between the parser and ...
Defines the clang::LangOptions interface.
static DiagnosticBuilder Diag(DiagnosticsEngine *Diags, const LangOptions &Features, FullSourceLoc TokLoc, const char *TokBegin, const char *TokRangeBegin, const char *TokRangeEnd, unsigned DiagID)
Produce a diagnostic highlighting some portion of a literal.
llvm::MachO::Target Target
Definition MachO.h:51
llvm::MachO::Record Record
Definition MachO.h:31
Defines the clang::MacroInfo and clang::MacroDirective classes.
Defines the clang::Module class, which describes a module in the source code.
Defines types useful for describing an Objective-C runtime.
#define SM(sm)
Defines some OpenACC-specific enums and functions.
Defines the clang::OpenCLOptions class.
This file defines OpenMP AST classes for clauses.
Defines the clang::Preprocessor interface.
This file declares semantic analysis for CUDA constructs.
This file declares semantic analysis for Objective-C.
static void EmitBlockID(unsigned ID, const char *Name, llvm::BitstreamWriter &Stream, RecordDataImpl &Record)
Emits a block ID in the BLOCKINFO block.
static void EmitRecordID(unsigned ID, const char *Name, llvm::BitstreamWriter &Stream, RecordDataImpl &Record)
Emits a record ID in the BLOCKINFO block.
Defines the clang::SourceLocation class and associated facilities.
Defines implementation details of the clang::SourceManager class.
Defines the SourceManager interface.
Defines various enumerations that describe declaration and type specifiers.
Defines the clang::TargetOptions class.
#define IMPORT(DERIVED, BASE)
Definition Template.h:630
#define BLOCK(DERIVED, BASE)
Definition Template.h:646
Defines the clang::TypeLoc interface and its subclasses.
TypePropertyCache< Private > Cache
Definition Type.cpp:4864
C Language Family Type Representation.
Defines version macros and version-related utility functions for Clang.
__DEVICE__ void * memcpy(void *__a, const void *__b, size_t __c)
__device__ __2f16 b
Contains data for OpenMP directives: clauses, children expressions/statements (helpers for codegen) a...
llvm::SmallVector< OMPTraitSet, 2 > Sets
The outermost level of selector sets.
APValue - This class implements a discriminated union of [uninitialized] [APSInt] [APFloat],...
Definition APValue.h:122
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition ASTContext.h:226
TranslationUnitDecl * getTranslationUnitDecl() const
QualType getRawCFConstantStringType() const
Get the structure type used to representation CFStrings, or NULL if it hasn't yet been built.
QualType getucontext_tType() const
Retrieve the C ucontext_t type.
FunctionDecl * getcudaGetParameterBufferDecl()
QualType getFILEType() const
Retrieve the C FILE type.
ArrayRef< Decl * > getModuleInitializers(Module *M)
Get the initializations to perform when importing a module, if any.
IdentifierTable & Idents
Definition ASTContext.h:798
const LangOptions & getLangOpts() const
Definition ASTContext.h:952
RawCommentList Comments
All comments in this translation unit.
Definition ASTContext.h:987
TagDecl * MSTypeInfoTagDecl
QualType getjmp_bufType() const
Retrieve the C jmp_buf type.
QualType getsigjmp_bufType() const
Retrieve the C sigjmp_buf type.
TagDecl * MSGuidTagDecl
Decl * getVaListTagDecl() const
Retrieve the C type declaration corresponding to the predefined __va_list_tag type used to help defin...
FunctionDecl * getcudaConfigureCallDecl()
import_range local_imports() const
FunctionDecl * getcudaLaunchDeviceDecl()
Reads an AST files chain containing the contents of a translation unit.
Definition ASTReader.h:427
const serialization::reader::DeclContextLookupTable * getLoadedLookupTables(DeclContext *Primary) const
Get the loaded lookup tables for Primary, if any.
const serialization::reader::ModuleLocalLookupTable * getModuleLocalLookupTables(DeclContext *Primary) const
unsigned getTotalNumSubmodules() const
Returns the number of submodules known.
Definition ASTReader.h:2105
unsigned getTotalNumSelectors() const
Returns the number of selectors found in the chain.
Definition ASTReader.h:2110
unsigned getModuleFileID(ModuleFile *M)
Get an ID for the given module file.
Decl * getKeyDeclaration(Decl *D)
Returns the first key declaration for the given declaration.
Definition ASTReader.h:1502
serialization::reader::LazySpecializationInfoLookupTable * getLoadedSpecializationsLookupTables(const Decl *D, bool IsPartial)
Get the loaded specializations lookup tables for D, if any.
const serialization::reader::DeclContextLookupTable * getTULocalLookupTables(DeclContext *Primary) const
An object for streaming information to a record.
void AddDeclarationNameInfo(const DeclarationNameInfo &NameInfo)
void AddCXXBaseSpecifiers(ArrayRef< CXXBaseSpecifier > Bases)
Emit a set of C++ base specifiers.
void AddTemplateArgumentList(const TemplateArgumentList *TemplateArgs)
Emit a template argument list.
uint64_t Emit(unsigned Code, unsigned Abbrev=0)
Emit the record to the stream, followed by its substatements, and return its offset.
void AddCXXTemporary(const CXXTemporary *Temp)
Emit a CXXTemporary.
void writeOMPTraitInfo(const OMPTraitInfo *TI)
Write an OMPTraitInfo object.
void AddCXXBaseSpecifier(const CXXBaseSpecifier &Base)
Emit a C++ base specifier.
void writeOMPClause(OMPClause *C)
void writeBool(bool Value)
void AddAPValue(const APValue &Value)
Emit an APvalue.
void AddUnresolvedSet(const ASTUnresolvedSet &Set)
Emit a UnresolvedSet structure.
void AddIdentifierRef(const IdentifierInfo *II)
Emit a reference to an identifier.
void AddStmt(Stmt *S)
Add the given statement or expression to the queue of statements to emit.
void AddDeclarationName(DeclarationName Name)
Emit a declaration name.
void AddTemplateArgumentLocInfo(const TemplateArgumentLoc &Arg)
Emits a template argument location info.
void AddTypeLoc(TypeLoc TL)
Emits source location information for a type. Does not emit the type.
void AddSelectorRef(Selector S)
Emit a Selector (which is a smart pointer reference).
void writeSourceLocation(SourceLocation Loc)
void AddOffset(uint64_t BitOffset)
Add a bit offset into the record.
void AddTypeRef(QualType T)
Emit a reference to a type.
void writeOpenACCClauseList(ArrayRef< const OpenACCClause * > Clauses)
Writes out a list of OpenACC clauses.
void push_back(uint64_t N)
Minimal vector-like interface.
void AddCXXCtorInitializers(ArrayRef< CXXCtorInitializer * > CtorInits)
Emit a CXXCtorInitializer array.
void AddTemplateParameterList(const TemplateParameterList *TemplateParams)
Emit a template parameter list.
void AddTemplateArgument(const TemplateArgument &Arg)
Emit a template argument.
void AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc, DeclarationName Name)
void writeOpenACCIntExprList(ArrayRef< Expr * > Exprs)
void AddAPFloat(const llvm::APFloat &Value)
Emit a floating-point value.
void AddTypeSourceInfo(TypeSourceInfo *TInfo)
Emits a reference to a declarator info.
void AddQualifierInfo(const QualifierInfo &Info)
void writeUInt32(uint32_t Value)
void AddDeclRef(const Decl *D)
Emit a reference to a declaration.
void writeOMPChildren(OMPChildren *Data)
Writes data related to the OpenMP directives.
void AddConceptReference(const ConceptReference *CR)
void AddSourceRange(SourceRange Range)
Emit a source range.
void AddAPInt(const llvm::APInt &Value)
Emit an integral value.
void AddSourceLocation(SourceLocation Loc)
Emit a source location.
void writeOpenACCVarList(const OpenACCClauseWithVarList *C)
void AddAttributes(ArrayRef< const Attr * > Attrs)
Emit a list of attributes.
void AddASTTemplateArgumentListInfo(const ASTTemplateArgumentListInfo *ASTTemplArgList)
Emits an AST template argument list info.
void AddCXXDefinitionData(const CXXRecordDecl *D)
void AddVarDeclInit(const VarDecl *VD)
Emit information about the initializer of a VarDecl.
void writeStmtRef(const Stmt *S)
void AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg)
Emits a template argument location.
void AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS)
Emit a nested name specifier with source-location information.
void AddOpenACCRoutineDeclAttr(const OpenACCRoutineDeclAttr *A)
void writeOpenACCClause(const OpenACCClause *C)
Writes out a single OpenACC Clause.
void AddAttr(const Attr *A)
An UnresolvedSet-like class which uses the ASTContext's allocator.
UnresolvedSetIterator const_iterator
Writes an AST file containing the contents of a translation unit.
Definition ASTWriter.h:97
void AddEmittedDeclRef(const Decl *D, RecordDataImpl &Record)
friend class ASTRecordWriter
Definition ASTWriter.h:100
bool isWritingStdCXXNamedModules() const
Definition ASTWriter.h:923
ArrayRef< uint64_t > RecordDataRef
Definition ASTWriter.h:104
void EmitRecordWithPath(unsigned Abbrev, RecordDataRef Record, StringRef Path)
Emit the current record with the given path as a blob.
void AddFileID(FileID FID, RecordDataImpl &Record)
Emit a FileID.
bool isDeclPredefined(const Decl *D) const
Definition ASTWriter.h:935
bool IsLocalDecl(const Decl *D) const
Is this a local declaration (that is, one that will be written to our AST file)?
Definition ASTWriter.h:786
bool hasChain() const
Definition ASTWriter.h:918
void AddPath(StringRef Path, RecordDataImpl &Record)
Add a path to the given record.
SmallVectorImpl< uint64_t > RecordDataImpl
Definition ASTWriter.h:103
void AddVersionTuple(const VersionTuple &Version, RecordDataImpl &Record)
Add a version tuple to the given record.
bool isGeneratingReducedBMI() const
Definition ASTWriter.h:931
uint32_t getMacroDirectivesOffset(const IdentifierInfo *Name)
void AddAlignPackInfo(const Sema::AlignPackInfo &Info, RecordDataImpl &Record)
Emit a AlignPackInfo.
void AddPathBlob(StringRef Str, RecordDataImpl &Record, SmallVectorImpl< char > &Blob)
llvm::MapVector< serialization::ModuleFile *, const Decl * > CollectFirstDeclFromEachModule(const Decl *D, bool IncludeLocal)
Collect the first declaration from each module file that provides a declaration of D.
void AddTypeRef(ASTContext &Context, QualType T, RecordDataImpl &Record)
Emit a reference to a type.
bool wasDeclEmitted(const Decl *D) const
Whether or not the declaration got emitted.
void AddString(StringRef Str, RecordDataImpl &Record)
Add a string to the given record.
~ASTWriter() override
bool isWritingModule() const
Definition ASTWriter.h:921
LocalDeclID GetDeclRef(const Decl *D)
Force a declaration to be emitted and get its local ID to the module file been writing.
void AddSourceRange(SourceRange Range, RecordDataImpl &Record)
Emit a source range.
LocalDeclID getDeclID(const Decl *D)
Determine the local declaration ID of an already-emitted declaration.
void AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record)
Emit a source location.
void addTouchedModuleFile(serialization::ModuleFile *)
void AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record)
Emit a reference to an identifier.
serialization::MacroID getMacroRef(MacroInfo *MI, const IdentifierInfo *Name)
Get the unique number used to refer to the given macro.
SourceLocationEncoding::RawLocEncoding getRawSourceLocationEncoding(SourceLocation Loc)
Return the raw encodings for source locations.
ASTFileSignature WriteAST(llvm::PointerUnion< Sema *, Preprocessor * > Subject, StringRef OutputFile, Module *WritingModule, StringRef isysroot, bool ShouldCacheASTInMemory=false)
Write a precompiled header or a module with the AST produced by the Sema object, or a dependency scan...
ASTReader * getChain() const
Definition ASTWriter.h:919
bool getDoneWritingDeclsAndTypes() const
Definition ASTWriter.h:933
serialization::IdentifierID getIdentifierRef(const IdentifierInfo *II)
Get the unique number used to refer to the given identifier.
ASTWriter(llvm::BitstreamWriter &Stream, SmallVectorImpl< char > &Buffer, ModuleCache &ModCache, const CodeGenOptions &CodeGenOpts, ArrayRef< std::shared_ptr< ModuleFileExtension > > Extensions, bool IncludeTimestamps=true, bool BuildingImplicitModule=false, bool GeneratingReducedBMI=false)
Create a new precompiled header writer that outputs to the given bitstream.
time_t getTimestampForOutput(time_t ModTime) const
Get a timestamp for output into the AST file.
void handleVTable(CXXRecordDecl *RD)
unsigned getLocalOrImportedSubmoduleID(const Module *Mod)
Retrieve or create a submodule ID for this module, or return 0 if the submodule is neither local (a s...
void AddToken(const Token &Tok, RecordDataImpl &Record)
Emit a token.
void AddLookupOffsets(const LookupBlockOffsets &Offsets, RecordDataImpl &Record)
serialization::SelectorID getSelectorRef(Selector Sel)
Get the unique number used to refer to the given selector.
SmallVector< uint64_t, 64 > RecordData
Definition ASTWriter.h:102
serialization::TypeID GetOrCreateTypeID(ASTContext &Context, QualType T)
Force a type to be emitted and get its ID.
unsigned getAnonymousDeclarationNumber(const NamedDecl *D)
void AddMacroRef(MacroInfo *MI, const IdentifierInfo *Name, RecordDataImpl &Record)
Emit a reference to a macro.
const LangOptions & getLangOpts() const
void SetSelectorOffset(Selector Sel, uint32_t Offset)
Note that the selector Sel occurs at the given offset within the method pool/selector table.
bool PreparePathForOutput(SmallVectorImpl< char > &Path)
Convert a path from this build process into one that is appropriate for emission in the module file.
void SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset)
Note that the identifier II occurs at the given offset within the identifier table.
void AddDeclRef(const Decl *D, RecordDataImpl &Record)
Emit a reference to a declaration.
void AddStringBlob(StringRef Str, RecordDataImpl &Record, SmallVectorImpl< char > &Blob)
Wrapper for source info for arrays.
Definition TypeLoc.h:1777
SourceLocation getLBracketLoc() const
Definition TypeLoc.h:1779
Expr * getSizeExpr() const
Definition TypeLoc.h:1799
SourceLocation getRBracketLoc() const
Definition TypeLoc.h:1787
SourceLocation getRParenLoc() const
Definition TypeLoc.h:2685
SourceLocation getKWLoc() const
Definition TypeLoc.h:2669
SourceLocation getLParenLoc() const
Definition TypeLoc.h:2677
Attr - This represents one attribute.
Definition Attr.h:46
attr::Kind getKind() const
Definition Attr.h:92
SourceLocation getScopeLoc() const
const IdentifierInfo * getScopeName() const
const IdentifierInfo * getAttrName() const
const Attr * getAttr() const
The type attribute.
Definition TypeLoc.h:1031
SourceLocation getRParenLoc() const
Definition TypeLoc.h:2398
bool isDecltypeAuto() const
Definition TypeLoc.h:2397
bool isConstrained() const
Definition TypeLoc.h:2401
ConceptReference * getConceptReference() const
Definition TypeLoc.h:2407
A simple helper class to pack several bits in order into (a) 32 bit integer(s).
Definition ASTWriter.h:1089
void addBit(bool Value)
Definition ASTWriter.h:1109
void addBits(uint32_t Value, uint32_t BitsWidth)
Definition ASTWriter.h:1110
SourceLocation getCaretLoc() const
Definition TypeLoc.h:1528
SourceLocation getBuiltinLoc() const
Definition TypeLoc.h:579
TypeSpecifierType getWrittenTypeSpec() const
Definition TypeLoc.cpp:321
TypeSpecifierWidth getWrittenWidthSpec() const
Definition TypeLoc.h:641
bool needsExtraLocalData() const
Definition TypeLoc.h:606
bool hasModeAttr() const
Definition TypeLoc.h:668
TypeSpecifierSign getWrittenSignSpec() const
Definition TypeLoc.h:625
This class is used for builtin types like 'int'.
Definition TypeBase.h:3214
Represents a base class of a C++ class.
Definition DeclCXX.h:146
Represents a C++ destructor within a class.
Definition DeclCXX.h:2876
Represents a C++ struct/union/class.
Definition DeclCXX.h:258
unsigned getDeviceLambdaManglingNumber() const
Retrieve the device side mangling number.
Definition DeclCXX.cpp:1855
TemplateSpecializationKind getTemplateSpecializationKind() const
Determine whether this particular class is a specialization or instantiation of a class template or m...
Definition DeclCXX.cpp:2060
unsigned getODRHash() const
Definition DeclCXX.cpp:493
Represents a C++ temporary.
Definition ExprCXX.h:1460
const CXXDestructorDecl * getDestructor() const
Definition ExprCXX.h:1471
Declaration of a class template.
Represents a class template specialization, which refers to a class template with a given set of temp...
CodeGenOptions - Track various options which control how the code is optimized and passed to the back...
A reference to a concept and its template args, as it appears in the code.
Definition ASTConcept.h:130
const NestedNameSpecifierLoc & getNestedNameSpecifierLoc() const
Definition ASTConcept.h:170
NamedDecl * getFoundDecl() const
Definition ASTConcept.h:197
const DeclarationNameInfo & getConceptNameInfo() const
Definition ASTConcept.h:174
const ASTTemplateArgumentListInfo * getTemplateArgsAsWritten() const
Definition ASTConcept.h:203
TemplateDecl * getNamedConcept() const
Definition ASTConcept.h:201
SourceLocation getTemplateKWLoc() const
Definition ASTConcept.h:180
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Definition DeclBase.h:1449
bool isFileContext() const
Definition DeclBase.h:2180
DeclContextLookupResult lookup_result
Definition DeclBase.h:2577
lookup_result lookup(DeclarationName Name) const
lookup - Find the declarations (if any) with the given Name in this context.
bool isLookupContext() const
Test whether the context supports looking up names.
Definition DeclBase.h:2175
bool isTranslationUnit() const
Definition DeclBase.h:2185
DeclContext * getRedeclContext()
getRedeclContext - Retrieve the context in which an entity conflicts with other entities of the same ...
StoredDeclsMap * buildLookup()
Ensure the lookup structure is fully-built and return it.
lookup_result noload_lookup(DeclarationName Name)
Find the declarations with the given name that are visible within this context; don't attempt to retr...
decl_range noload_decls() const
noload_decls_begin/end - Iterate over the declarations stored in this context that are currently load...
Definition DeclBase.h:2381
DeclContext * getPrimaryContext()
getPrimaryContext - There may be many different declarations of the same entity (including forward de...
bool decls_empty() const
decl_range decls() const
decls_begin/decls_end - Iterate over the declarations stored in this context.
Definition DeclBase.h:2373
bool isFunctionOrMethod() const
Definition DeclBase.h:2161
StoredDeclsMap * getLookupPtr() const
Retrieve the internal representation of the lookup structure.
Definition DeclBase.h:2681
DeclID getRawValue() const
Definition DeclID.h:115
Decl - This represents one declaration (or definition), e.g.
Definition DeclBase.h:86
Decl * getPreviousDecl()
Retrieve the previous declaration that declares the same entity as this declaration,...
Definition DeclBase.h:1061
Decl * getMostRecentDecl()
Retrieve the most recent declaration that declares the same entity as this declaration (which may be ...
Definition DeclBase.h:1076
Module * getTopLevelOwningNamedModule() const
Get the top level owning named module that owns this declaration if any.
Definition DeclBase.cpp:152
FriendObjectKind getFriendObjectKind() const
Determines whether this declaration is the object of a friend declaration and, if so,...
Definition DeclBase.h:1226
T * getAttr() const
Definition DeclBase.h:573
bool hasAttrs() const
Definition DeclBase.h:518
ASTContext & getASTContext() const LLVM_READONLY
Definition DeclBase.cpp:546
bool isImplicit() const
isImplicit - Indicates whether the declaration was implicitly generated by the implementation.
Definition DeclBase.h:593
bool isInNamedModule() const
Whether this declaration comes from a named module.
bool isUnconditionallyVisible() const
Determine whether this declaration is definitely visible to name lookup, independent of whether the o...
Definition DeclBase.h:859
@ FOK_None
Not a friend object.
Definition DeclBase.h:1217
bool isCanonicalDecl() const
Whether this particular Decl is a canonical one.
Definition DeclBase.h:984
Module * getOwningModule() const
Get the module that owns this declaration (for visibility purposes).
Definition DeclBase.h:842
bool isFirstDecl() const
True if this is the first declaration in its redeclaration chain.
Definition DeclBase.h:1070
bool isFromExplicitGlobalModule() const
Whether this declaration comes from explicit global module.
bool isFromASTFile() const
Determine whether this declaration came from an AST file (such as a precompiled header or module) rat...
Definition DeclBase.h:793
DeclContext * getNonTransparentDeclContext()
Return the non transparent context.
SourceLocation getLocation() const
Definition DeclBase.h:439
DeclContext * getDeclContext()
Definition DeclBase.h:448
AttrVec & getAttrs()
Definition DeclBase.h:524
DeclContext * getLexicalDeclContext()
getLexicalDeclContext - The declaration context where this Decl was lexically declared (LexicalDC).
Definition DeclBase.h:918
virtual Decl * getCanonicalDecl()
Retrieves the "canonical" declaration of the given declaration.
Definition DeclBase.h:978
Kind getKind() const
Definition DeclBase.h:442
GlobalDeclID getGlobalID() const
Retrieve the global declaration ID associated with this declaration, which specifies where this Decl ...
Definition DeclBase.cpp:110
DeclarationNameLoc - Additional source/type location info for a declaration name.
SourceLocation getCXXLiteralOperatorNameLoc() const
Return the location of the literal operator name (without the operator keyword).
TypeSourceInfo * getNamedTypeInfo() const
Returns the source type info.
SourceRange getCXXOperatorNameRange() const
Return the range of the operator name (without the operator keyword).
The name of a declaration.
NameKind getNameKind() const
Determine what kind of name this is.
SourceLocation getDecltypeLoc() const
Definition TypeLoc.h:2287
SourceLocation getRParenLoc() const
Definition TypeLoc.h:2290
SourceLocation getElaboratedKeywordLoc() const
Definition TypeLoc.h:2509
SourceLocation getTemplateNameLoc() const
Definition TypeLoc.h:2517
NestedNameSpecifierLoc getQualifierLoc() const
Definition TypeLoc.h:2521
Expr * getAttrExprOperand() const
The attribute's expression operand, if it has one.
Definition TypeLoc.h:1984
SourceRange getAttrOperandParensRange() const
The location of the parentheses around the operand, if there is an operand.
Definition TypeLoc.h:1995
SourceLocation getAttrNameLoc() const
The location of the attribute name, i.e.
Definition TypeLoc.h:1974
NestedNameSpecifierLoc getQualifierLoc() const
Definition TypeLoc.h:2585
SourceLocation getNameLoc() const
Definition TypeLoc.h:2597
SourceLocation getElaboratedKeywordLoc() const
Definition TypeLoc.h:2577
SourceLocation getNameLoc() const
Definition TypeLoc.h:2094
SourceLocation getNameLoc() const
Definition TypeLoc.h:2066
std::vector< std::string > Remarks
The list of -R... options used to alter the diagnostic mappings, with the prefixes removed.
std::vector< std::string > Warnings
The list of -W... options used to alter the diagnostic mappings, with the prefixes removed.
DiagnosticOptions & getDiagnosticOptions() const
Retrieve the diagnostic options.
Definition Diagnostic.h:602
bool hasUncompilableErrorOccurred() const
Errors that actually prevent compilation, not those that are upgraded from a warning by -Werror.
Definition Diagnostic.h:884
StringRef getName() const
SourceLocation getElaboratedKeywordLoc() const
Definition TypeLoc.h:752
SourceLocation getNameLoc() const
Definition TypeLoc.h:761
NestedNameSpecifierLoc getQualifierLoc() const
Definition TypeLoc.h:756
This represents one expression.
Definition Expr.h:112
storage_type getAsOpaqueInt() const
storage_type getAsOpaqueInt() const
Represents a member of a struct/union/class.
Definition Decl.h:3175
StringRef getName() const
The name of this FileEntry.
Definition FileEntry.h:61
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
bool isValid() const
bool isInvalid() const
void trackVFSUsage(bool Active)
Enable or disable tracking of VFS usage.
llvm::vfs::FileSystem & getVirtualFileSystem() const
llvm::ErrorOr< std::unique_ptr< llvm::MemoryBuffer > > getBufferForFile(FileEntryRef Entry, bool isVolatile=false, bool RequiresNullTerminator=true, std::optional< int64_t > MaybeLimit=std::nullopt, bool IsText=true)
Open the specified file as a MemoryBuffer, returning a new MemoryBuffer if successful,...
OptionalFileEntryRef getOptionalFileRef(StringRef Filename, bool OpenFile=false, bool CacheFailure=true)
Get a FileEntryRef if it exists, without doing anything on error.
void GetUniqueIDMapping(SmallVectorImpl< OptionalFileEntryRef > &UIDToFiles) const
Produce an array mapping from the unique IDs assigned to each file to the corresponding FileEntryRef.
FileSystemOptions & getFileSystemOpts()
Returns the current file system options.
bool makeAbsolutePath(SmallVectorImpl< char > &Path, bool Canonicalize=false) const
Makes Path absolute taking into account FileSystemOptions and the working directory option,...
OptionalDirectoryEntryRef getOptionalDirectoryRef(StringRef DirName, bool CacheFailure=true)
Get a DirectoryEntryRef if it exists, without doing anything on error.
std::string WorkingDir
If set, paths are resolved as if the working directory was set to the value of WorkingDir.
Represents a function declaration or definition.
Definition Decl.h:2015
bool doesThisDeclarationHaveABody() const
Returns whether this specific declaration of the function has a body.
Definition Decl.h:2341
Declaration of a template function.
Wrapper for source info for functions.
Definition TypeLoc.h:1644
unsigned getNumParams() const
Definition TypeLoc.h:1716
ParmVarDecl * getParam(unsigned i) const
Definition TypeLoc.h:1722
SourceLocation getLocalRangeEnd() const
Definition TypeLoc.h:1668
SourceRange getExceptionSpecRange() const
Definition TypeLoc.h:1696
SourceLocation getLocalRangeBegin() const
Definition TypeLoc.h:1660
SourceLocation getLParenLoc() const
Definition TypeLoc.h:1676
SourceLocation getRParenLoc() const
Definition TypeLoc.h:1684
unsigned ModulesPruneNonAffectingModuleMaps
Whether to prune non-affecting module map files from PCM files.
unsigned ImplicitModuleMaps
Implicit module maps.
unsigned EnablePrebuiltImplicitModules
Also search for prebuilt implicit modules in the prebuilt module cache path.
unsigned ModuleMapFileHomeIsCwd
Set the 'home directory' of a module map file to the current working directory (or the home directory...
std::string Sysroot
If non-empty, the directory to use as a "virtual system root" for include paths.
std::string ModuleUserBuildPath
The directory used for a user build.
unsigned UseLibcxx
Use libc++ instead of the default libstdc++.
unsigned UseBuiltinIncludes
Include the compiler builtin includes.
unsigned ModuleFileHomeIsCwd
Set the base path of a built module file to be the current working directory.
unsigned UseStandardCXXIncludes
Include the system standard C++ library include search directories.
std::string ResourceDir
The directory which holds the compiler resource files (builtin includes, etc.).
unsigned UseStandardSystemIncludes
Include the system standard include search directories.
unsigned DisableModuleHash
Whether we should disable the use of the hash string within the module cache.
Encapsulates the information needed to find the file referenced by a #include or #include_next,...
std::vector< bool > collectVFSUsageAndClear() const
Collect which HeaderSearchOptions::VFSOverlayFiles have been meaningfully used so far and mark their ...
FileManager & getFileMgr() const
const HeaderFileInfo * getExistingLocalFileInfo(FileEntryRef FE) const
Return the headerFileInfo structure for the specified FileEntry, if it has ever been filled in locall...
StringRef getNormalizedModuleCachePath() const
Retrieve the normalized module cache path.
std::vector< bool > computeUserEntryUsage() const
Determine which HeaderSearchOptions::UserEntries have been successfully used so far and mark their in...
ArrayRef< ModuleMap::KnownHeader > findResolvedModulesForHeader(FileEntryRef File) const
Like findAllModulesForHeader, but do not attempt to infer module ownership from umbrella headers if w...
const HeaderSearchOptions & getHeaderSearchOpts() const
Retrieve the header-search options with which this header search was initialized.
ModuleMap & getModuleMap()
Retrieve the module map.
unsigned header_file_size() const
StringRef getContextHash() const
Retrieve the context hash.
One of these records is kept for each identifier that is lexed.
unsigned getLength() const
Efficiently return the length of this identifier info.
unsigned getBuiltinID() const
Return a value indicating whether this is a builtin function.
bool hasChangedSinceDeserialization() const
Determine whether this identifier has changed since it was loaded from an AST file.
bool isCPlusPlusOperatorKeyword() const
bool hasFETokenInfoChangedSinceDeserialization() const
Determine whether the frontend token information for this identifier has changed since it was loaded ...
bool hasMacroDefinition() const
Return true if this identifier is #defined to some other value.
bool isFromAST() const
Return true if the identifier in its current state was loaded from an AST file.
bool isPoisoned() const
Return true if this token has been poisoned.
bool hasRevertedTokenIDToIdentifier() const
True if revertTokenIDToIdentifier() was called.
const char * getNameStart() const
Return the beginning of the actual null-terminated string for this identifier.
tok::NotableIdentifierKind getNotableIdentifierID() const
unsigned getObjCOrBuiltinID() const
tok::ObjCKeywordKind getObjCKeywordID() const
Return the Objective-C keyword ID for the this identifier.
void * getFETokenInfo() const
Get and set FETokenInfo.
StringRef getName() const
Return the actual identifier string.
bool isExtensionToken() const
get/setExtension - Initialize information about whether or not this language token is an extension.
iterator begin(DeclarationName Name)
Returns an iterator over decls with the name 'Name'.
iterator end()
Returns the end iterator.
llvm::iterator_range< iterator > decls(DeclarationName Name)
Returns a range of decls with the name 'Name'.
IdentifierInfo & get(StringRef Name)
Return the identifier token info for the specified named identifier.
SourceLocation getAmpLoc() const
Definition TypeLoc.h:1610
Describes the capture of a variable or of this, or of a C++1y init-capture.
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
clang::ObjCRuntime ObjCRuntime
CommentOptions CommentOpts
Options for parsing comments.
std::string OMPHostIRFile
Name of the IR file that contains the result of the OpenMP target host code generation.
std::vector< llvm::Triple > OMPTargetTriples
Triples of the OpenMP targets that the host code codegen should take into account in order to generat...
std::string CurrentModule
The name of the current module, of which the main source file is a part.
std::vector< std::string > ModuleFeatures
The names of any features to enable in module 'requires' decls in addition to the hard-coded list in ...
Record the location of a macro definition.
Encapsulates changes to the "macros namespace" (the location where the macro name became active,...
Definition MacroInfo.h:313
const MacroDirective * getPrevious() const
Get previous definition of the macro with the same name.
Definition MacroInfo.h:354
const MacroInfo * getMacroInfo() const
Definition MacroInfo.h:416
Kind getKind() const
Definition MacroInfo.h:346
SourceLocation getLocation() const
Definition MacroInfo.h:348
Encapsulates the data about a macro definition (e.g.
Definition MacroInfo.h:39
bool isUsed() const
Return false if this macro is defined in the main file and has not yet been used.
Definition MacroInfo.h:224
bool isC99Varargs() const
Definition MacroInfo.h:207
SourceLocation getDefinitionEndLoc() const
Return the location of the last token in the macro.
Definition MacroInfo.h:131
ArrayRef< const IdentifierInfo * > params() const
Definition MacroInfo.h:185
unsigned getNumTokens() const
Return the number of tokens that this macro expands to.
Definition MacroInfo.h:235
unsigned getNumParams() const
Definition MacroInfo.h:184
const Token & getReplacementToken(unsigned Tok) const
Definition MacroInfo.h:237
bool isBuiltinMacro() const
Return true if this macro requires processing before expansion.
Definition MacroInfo.h:217
SourceLocation getDefinitionLoc() const
Return the location that the macro was defined at.
Definition MacroInfo.h:125
bool hasCommaPasting() const
Definition MacroInfo.h:219
bool isObjectLike() const
Definition MacroInfo.h:202
bool isUsedForHeaderGuard() const
Determine whether this macro was used for a header guard.
Definition MacroInfo.h:294
bool isGNUVarargs() const
Definition MacroInfo.h:208
SourceLocation getExpansionLoc() const
Definition TypeLoc.h:1379
Expr * getAttrColumnOperand() const
The attribute's column operand, if it has one.
Definition TypeLoc.h:2136
SourceRange getAttrOperandParensRange() const
The location of the parentheses around the operand, if there is an operand.
Definition TypeLoc.h:2143
SourceLocation getAttrNameLoc() const
The location of the attribute name, i.e.
Definition TypeLoc.h:2124
Expr * getAttrRowOperand() const
The attribute's row operand, if it has one.
Definition TypeLoc.h:2130
NestedNameSpecifierLoc getQualifierLoc() const
Definition TypeLoc.h:1554
SourceLocation getStarLoc() const
Definition TypeLoc.h:1546
The module cache used for compiling modules implicitly.
Definition ModuleCache.h:25
virtual void writeExtensionContents(Sema &SemaRef, llvm::BitstreamWriter &Stream)=0
Write the contents of the extension block into the given bitstream.
ModuleFileExtension * getExtension() const
Retrieve the module file extension with which this writer is associated.
virtual ModuleFileExtensionMetadata getExtensionMetadata() const =0
Retrieves the metadata for this module file extension.
StringRef str() const
Returns the plain module file name.
Definition Module.h:144
void resolveHeaderDirectives(const FileEntry *File) const
Resolve all lazy header directives for the specified file.
ArrayRef< KnownHeader > findResolvedModulesForHeader(FileEntryRef File) const
Like findAllModulesForHeader, but do not attempt to infer module ownership from umbrella headers if w...
FileID getModuleMapFileIDForUniquing(const Module *M) const
Get the module map file that (along with the module name) uniquely identifies this module.
FileID getContainingModuleMapFileID(const Module *Module) const
Retrieve the module map file containing the definition of the given module.
ModuleHeaderRole
Flags describing the role of a module header.
Definition ModuleMap.h:126
static ModuleHeaderRole headerKindToRole(Module::HeaderKind Kind)
Convert a header kind to a role. Requires Kind to not be HK_Excluded.
Definition ModuleMap.cpp:86
Describes a module or submodule.
Definition Module.h:246
unsigned IsExplicit
Whether this is an explicit submodule.
Definition Module.h:487
SmallVector< ExportDecl, 2 > Exports
The set of export declarations.
Definition Module.h:574
unsigned InferSubmodules
Whether we should infer submodules for this module based on the headers.
Definition Module.h:509
std::vector< std::string > ConfigMacros
The set of "configuration macros", which are macros that (intentionally) change how this module is bu...
Definition Module.h:631
SourceLocation DefinitionLoc
The location of the module definition.
Definition Module.h:252
SmallVector< UnresolvedHeaderDirective, 1 > MissingHeaders
Headers that are mentioned in the module map file but could not be found on the file system.
Definition Module.h:444
Module * Parent
The parent of this module.
Definition Module.h:295
ModuleKind Kind
The kind of this module.
Definition Module.h:291
bool isUnimportable() const
Determine whether this module has been declared unimportable.
Definition Module.h:666
unsigned IsInferred
Whether this is an inferred submodule (module * { ... }).
Definition Module.h:502
llvm::SmallSetVector< Module *, 2 > Imports
The set of modules imported by this module, and on which this module depends.
Definition Module.h:561
unsigned IsSystem
Whether this is a "system" module (which assumes that all headers in it are system headers).
Definition Module.h:492
std::string Name
The name of this module.
Definition Module.h:249
llvm::iterator_range< submodule_iterator > submodules()
Definition Module.h:952
unsigned IsExternC
Whether this is an 'extern "C"' module (which implicitly puts all headers in it within an 'extern "C"...
Definition Module.h:498
unsigned ModuleMapIsPrivate
Whether this module came from a "private" module map, found next to a regular (public) module map.
Definition Module.h:537
llvm::SmallVector< LinkLibrary, 2 > LinkLibraries
The set of libraries or frameworks to link against when an entity from this module is used.
Definition Module.h:623
std::optional< Header > getUmbrellaHeaderAsWritten() const
Retrieve the umbrella header as written.
Definition Module.h:870
SmallVector< Requirement, 2 > Requirements
The set of language features required to use this module.
Definition Module.h:455
llvm::SmallSetVector< const Module *, 2 > UndeclaredUses
When NoUndeclaredIncludes is true, the set of modules this module tried to import but didn't because ...
Definition Module.h:602
OptionalDirectoryEntryRef Directory
The build directory of this module.
Definition Module.h:300
unsigned NamedModuleHasInit
Whether this C++20 named modules doesn't need an initializer.
Definition Module.h:542
llvm::SmallSetVector< Module *, 2 > AffectingClangModules
The set of top-level modules that affected the compilation of this module, but were not imported.
Definition Module.h:565
unsigned ConfigMacrosExhaustive
Whether the set of configuration macros is exhaustive.
Definition Module.h:527
ASTFileSignature Signature
The module signature.
Definition Module.h:310
ArrayRef< Header > getHeaders(HeaderKind HK) const
Definition Module.h:405
unsigned InferExportWildcard
Whether, when inferring submodules, the inferr submodules should export all modules they import (e....
Definition Module.h:519
ArrayRef< FileEntryRef > getTopHeaders(FileManager &FileMgr)
The top-level headers associated with this module.
Definition Module.cpp:295
std::optional< DirectoryName > getUmbrellaDirAsWritten() const
Retrieve the umbrella directory as written.
Definition Module.h:862
unsigned IsFramework
Whether this is a framework module.
Definition Module.h:483
std::string ExportAsModule
The module through which entities defined in this module will eventually be exposed,...
Definition Module.h:320
unsigned InferExplicitSubmodules
Whether, when inferring submodules, the inferred submodules should be explicit.
Definition Module.h:514
Module * getTopLevelModule()
Retrieve the top-level module for this (sub)module, which may be this module.
Definition Module.h:825
std::vector< Conflict > Conflicts
The list of conflicts.
Definition Module.h:656
This represents a decl that may have a name.
Definition Decl.h:274
Linkage getLinkageInternal() const
Determine what kind of linkage this entity has.
Definition Decl.cpp:1182
DeclarationName getDeclName() const
Get the actual, stored name of the declaration, which may be a special name.
Definition Decl.h:340
Linkage getFormalLinkage() const
Get the linkage from a semantic point of view.
Definition Decl.cpp:1206
Represent a C++ namespace.
Definition Decl.h:592
A C++ nested-name-specifier augmented with source location information.
NamespaceAndPrefixLoc getAsNamespaceAndPrefix() const
NestedNameSpecifier getNestedNameSpecifier() const
Retrieve the nested-name-specifier to which this instance refers.
TypeLoc castAsTypeLoc() const
For a nested-name-specifier that refers to a type, retrieve the type with source-location information...
SourceRange getLocalSourceRange() const
Retrieve the source range covering just the last part of this nested-name-specifier,...
Represents a C++ nested name specifier, such as "\::std::vector<int>::".
Kind
The kind of specifier that completes this nested name specifier.
@ MicrosoftSuper
Microsoft's '__super' specifier, stored as a CXXRecordDecl* of the class it appeared in.
@ Global
The global specifier '::'. There is no stored value.
@ Namespace
A namespace-like entity, stored as a NamespaceBaseDecl*.
This represents the 'align' clause in the 'pragma omp allocate' directive.
This represents clause 'allocate' in the 'pragma omp ...' directives.
This represents 'allocator' clause in the 'pragma omp ...' directive.
Class that handles post-update expression for some clauses, like 'lastprivate', 'reduction' etc.
Class that handles pre-initialization statement for some clauses, like 'schedule',...
This is a basic class for representing single OpenMP clause.
This represents 'collapse' clause in the 'pragma omp ...' directive.
This represents 'default' clause in the 'pragma omp ...' directive.
This represents 'final' clause in the 'pragma omp ...' directive.
Representation of the 'full' clause of the 'pragma omp unroll' directive.
This represents 'if' clause in the 'pragma omp ...' directive.
This class represents the 'looprange' clause in the 'pragma omp fuse' directive.
This represents 'num_threads' clause in the 'pragma omp ...' directive.
Representation of the 'partial' clause of the 'pragma omp unroll' directive.
This class represents the 'permutation' clause in the 'pragma omp interchange' directive.
This represents 'safelen' clause in the 'pragma omp ...' directive.
This represents 'simdlen' clause in the 'pragma omp ...' directive.
This represents the 'sizes' clause in the 'pragma omp tile' directive.
This represents 'threadset' clause in the 'pragma omp task ...' directive.
ObjCCategoryDecl - Represents a category declaration.
Definition DeclObjC.h:2329
Represents an ObjC class declaration.
Definition DeclObjC.h:1154
filtered_category_iterator< isKnownCategory > known_categories_iterator
Iterator that walks over all of the known categories and extensions, including those that are hidden.
Definition DeclObjC.h:1683
ObjCInterfaceDecl * getDefinition()
Retrieve the definition of this class, or NULL if this class has been forward-declared (with @class) ...
Definition DeclObjC.h:1542
SourceLocation getNameEndLoc() const
Definition TypeLoc.h:1321
SourceLocation getNameLoc() const
Definition TypeLoc.h:1309
SourceLocation getStarLoc() const
Definition TypeLoc.h:1588
bool hasBaseTypeAsWritten() const
Definition TypeLoc.h:1254
SourceLocation getTypeArgsLAngleLoc() const
Definition TypeLoc.h:1184
unsigned getNumTypeArgs() const
Definition TypeLoc.h:1200
unsigned getNumProtocols() const
Definition TypeLoc.h:1230
TypeSourceInfo * getTypeArgTInfo(unsigned i) const
Definition TypeLoc.h:1204
SourceLocation getProtocolRAngleLoc() const
Definition TypeLoc.h:1222
SourceLocation getProtocolLoc(unsigned i) const
Definition TypeLoc.h:1234
SourceLocation getProtocolLAngleLoc() const
Definition TypeLoc.h:1214
SourceLocation getTypeArgsRAngleLoc() const
Definition TypeLoc.h:1192
Kind getKind() const
Definition ObjCRuntime.h:77
const VersionTuple & getVersion() const
Definition ObjCRuntime.h:78
unsigned getNumProtocols() const
Definition TypeLoc.h:932
SourceLocation getProtocolLoc(unsigned i) const
Definition TypeLoc.h:936
SourceLocation getProtocolLAngleLoc() const
Definition TypeLoc.h:912
SourceLocation getProtocolRAngleLoc() const
Definition TypeLoc.h:922
Represents a clause with one or more 'var' objects, represented as an expr, as its arguments.
This is the base type for all OpenACC Clauses.
SourceLocation getAttrLoc() const
Definition TypeLoc.h:1097
SourceLocation getEllipsisLoc() const
Definition TypeLoc.h:2629
SourceLocation getEllipsisLoc() const
Definition TypeLoc.h:2315
SourceLocation getRParenLoc() const
Definition TypeLoc.h:1407
SourceLocation getLParenLoc() const
Definition TypeLoc.h:1403
Represents a parameter to a function.
Definition Decl.h:1805
SourceLocation getKWLoc() const
Definition TypeLoc.h:2724
SourceLocation getStarLoc() const
Definition TypeLoc.h:1515
MacroDefinitionRecord * findMacroDefinition(const MacroInfo *MI)
Retrieve the macro definition that corresponds to the given MacroInfo.
const std::vector< SourceRange > & getSkippedRanges()
Retrieve all ranges that got skipped while preprocessing.
iterator local_begin()
Begin iterator for local, non-loaded, preprocessed entities.
iterator local_end()
End iterator for local, non-loaded, preprocessed entities.
std::vector< std::string > MacroIncludes
std::vector< std::string > Includes
bool WriteCommentListToPCH
Whether to write comment locations into the PCH when building it.
ObjCXXARCStandardLibraryKind ObjCXXARCStandardLibrary
The Objective-C++ ARC standard library that we should support, by providing appropriate definitions t...
bool DetailedRecord
Whether we should maintain a detailed record of all macro definitions and expansions.
std::string ImplicitPCHInclude
The implicit PCH included at the start of the translation unit, or empty.
bool UsePredefines
Initialize the preprocessor with the compiler and target specific predefines.
std::vector< std::pair< std::string, bool > > Macros
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
ArrayRef< ModuleMacro * > getLeafModuleMacros(const IdentifierInfo *II) const
Get the list of leaf (non-overridden) module macros for a name.
ArrayRef< PPConditionalInfo > getPreambleConditionalStack() const
bool isRecordingPreamble() const
MacroDirective * getLocalMacroDirectiveHistory(const IdentifierInfo *II) const
Given an identifier, return the latest non-imported macro directive for that identifier.
bool SawDateOrTime() const
Returns true if the preprocessor has seen a use of DATE or TIME in the file so far.
SourceManager & getSourceManager() const
std::optional< PreambleSkipInfo > getPreambleSkipInfo() const
bool hasRecordedPreamble() const
const TargetInfo & getTargetInfo() const
FileManager & getFileManager() const
bool alreadyIncluded(FileEntryRef File) const
Return true if this header has already been included.
FileID getPredefinesFileID() const
Returns the FileID for the preprocessor predefines.
HeaderSearch & getHeaderSearchInfo() const
SmallVector< SourceLocation, 64 > serializeSafeBufferOptOutMap() const
IdentifierTable & getIdentifierTable()
const PreprocessorOptions & getPreprocessorOpts() const
Retrieve the preprocessor options used to initialize this preprocessor.
const LangOptions & getLangOpts() const
PreprocessingRecord * getPreprocessingRecord() const
Retrieve the preprocessing record, or NULL if there is no preprocessing record.
DiagnosticsEngine & getDiagnostics() const
uint32_t getCounterValue() const
SourceLocation getPreambleRecordedPragmaAssumeNonNullLoc() const
Get the location of the recorded unterminated #pragma clang assume_nonnull begin in the preamble,...
DiagnosticBuilder Diag(SourceLocation Loc, unsigned DiagID) const
Forwarding function for diagnostics.
A (possibly-)qualified type.
Definition TypeBase.h:937
bool hasLocalNonFastQualifiers() const
Determine whether this particular QualType instance has any "non-fast" qualifiers,...
Definition TypeBase.h:1074
QualType getLocalUnqualifiedType() const
Return this type with all of the instance-specific qualifiers removed, but without removing any quali...
Definition TypeBase.h:1231
const Type * getTypePtr() const
Retrieves a pointer to the underlying (unqualified) type.
Definition TypeBase.h:8431
Qualifiers getLocalQualifiers() const
Retrieve the set of qualifiers local to this particular QualType instance, not including any qualifie...
Definition TypeBase.h:8463
Wrapper of type source information for a type with non-trivial direct qualifiers.
Definition TypeLoc.h:300
SourceLocation getAmpAmpLoc() const
Definition TypeLoc.h:1624
bool isTrailingComment() const LLVM_READONLY
Returns true if it is a comment that should be put after a member:
bool isAlmostTrailingComment() const LLVM_READONLY
Returns true if it is a probable typo:
CommentKind getKind() const LLVM_READONLY
SourceRange getSourceRange() const LLVM_READONLY
Represents a struct/union/class.
Definition Decl.h:4342
decl_type * getFirstDecl()
Return the first declaration of this declaration or itself if this is the only declaration.
Smart pointer class that efficiently represents Objective-C method names.
const IdentifierInfo * getIdentifierInfoForSlot(unsigned argIndex) const
Retrieve the identifier at a given position in the selector.
void * getAsOpaquePtr() const
unsigned getNumArgs() const
void updateOutOfDateSelector(Selector Sel)
llvm::MapVector< Selector, SourceLocation > ReferencedSelectors
Method selectors used in a @selector expression.
Definition SemaObjC.h:209
GlobalMethodPool MethodPool
Method Pool - allows efficient lookup when typechecking messages to "id".
Definition SemaObjC.h:220
bool DeclareAndesVectorBuiltins
Indicate RISC-V Andes vector builtin functions enabled or not.
Definition SemaRISCV.h:55
bool DeclareSiFiveVectorBuiltins
Indicate RISC-V SiFive vector builtin functions enabled or not.
Definition SemaRISCV.h:52
bool DeclareRVVBuiltins
Indicate RISC-V vector builtin functions enabled or not.
Definition SemaRISCV.h:49
static uint32_t getRawEncoding(const AlignPackInfo &Info)
Definition Sema.h:1890
Sema - This implements semantic analysis and AST building for C.
Definition Sema.h:868
llvm::SmallSetVector< const TypedefNameDecl *, 4 > UnusedLocalTypedefNameCandidates
Set containing all typedefs that are likely unused.
Definition Sema.h:3606
DelegatingCtorDeclsType DelegatingCtorDecls
All the delegating constructors seen so far in the file, used for cycle detection at the end of the T...
Definition Sema.h:6588
SemaCUDA & CUDA()
Definition Sema.h:1473
Preprocessor & getPreprocessor() const
Definition Sema.h:938
PragmaStack< FPOptionsOverride > FpPragmaStack
Definition Sema.h:2076
ExtVectorDeclsType ExtVectorDecls
ExtVectorDecls - This is a list all the extended vector types.
Definition Sema.h:4954
SourceLocation getOptimizeOffPragmaLocation() const
Get the location for the currently active "\#pragma clang optimizeoff". If this location is invalid,...
Definition Sema.h:2150
FPOptionsOverride CurFPFeatureOverrides()
Definition Sema.h:2077
LateParsedTemplateMapT LateParsedTemplateMap
Definition Sema.h:11454
ASTContext & Context
Definition Sema.h:1308
SemaObjC & ObjC()
Definition Sema.h:1518
UnusedFileScopedDeclsType UnusedFileScopedDecls
The set of file scoped decls seen so far that have not been used and must warn if not used.
Definition Sema.h:3614
SmallVector< const Decl * > DeclsWithEffectsToVerify
All functions/lambdas/blocks which have bodies and which have a non-empty FunctionEffectsRef to be ve...
Definition Sema.h:15760
EnumDecl * getStdAlignValT() const
LazyDeclPtr StdBadAlloc
The C++ "std::bad_alloc" class, which is defined by the C++ standard library.
Definition Sema.h:8437
SmallVector< VTableUse, 16 > VTableUses
The list of vtables that are required but have not yet been materialized.
Definition Sema.h:5926
Preprocessor & PP
Definition Sema.h:1307
llvm::MapVector< const FunctionDecl *, std::unique_ptr< LateParsedTemplate > > LateParsedTemplateMapT
Definition Sema.h:11453
CXXRecordDecl * getStdBadAlloc() const
SemaRISCV & RISCV()
Definition Sema.h:1548
SourceLocation ImplicitMSInheritanceAttrLoc
Source location for newly created implicit MSInheritanceAttrs.
Definition Sema.h:1835
llvm::DenseMap< CXXRecordDecl *, bool > VTablesUsed
The set of classes whose vtables have been used within this translation unit, and a bit that will be ...
Definition Sema.h:5932
PragmaStack< AlignPackInfo > AlignPackStack
Definition Sema.h:2058
llvm::SmallSetVector< Decl *, 4 > DeclsToCheckForDeferredDiags
Function or variable declarations to be checked for whether the deferred diagnostics should be emitte...
Definition Sema.h:4811
std::deque< PendingImplicitInstantiation > PendingLocalImplicitInstantiations
The queue of implicit template instantiations that are required and must be performed within the curr...
Definition Sema.h:14116
bool MSStructPragmaOn
Definition Sema.h:1832
void getUndefinedButUsed(SmallVectorImpl< std::pair< NamedDecl *, SourceLocation > > &Undefined)
Obtain a sorted list of functions that are undefined but ODR-used.
Definition Sema.cpp:967
LazyDeclPtr StdNamespace
The C++ "std" namespace, where the standard library resides.
Definition Sema.h:6591
llvm::DenseMap< IdentifierInfo *, AsmLabelAttr * > ExtnameUndeclaredIdentifiers
ExtnameUndeclaredIdentifiers - Identifiers contained in #pragma redefine_extname before declared.
Definition Sema.h:3602
std::deque< PendingImplicitInstantiation > PendingInstantiations
The queue of implicit template instantiations that are required but have not yet been performed.
Definition Sema.h:14099
TentativeDefinitionsType TentativeDefinitions
All the tentative definitions encountered in the TU.
Definition Sema.h:3621
const llvm::MapVector< FieldDecl *, DeleteLocs > & getMismatchingDeleteExpressions() const
Retrieves list of suspicious delete-expressions that will be checked at the end of translation unit.
Definition Sema.cpp:2978
OpenCLOptions & getOpenCLOptions()
Definition Sema.h:933
NamespaceDecl * getStdNamespace() const
LangOptions::PragmaMSPointersToMembersKind MSPointerToMemberRepresentationMethod
Controls member pointer representation format under the MS ABI.
Definition Sema.h:1830
llvm::MapVector< IdentifierInfo *, llvm::SetVector< WeakInfo, llvm::SmallVector< WeakInfo, 1u >, llvm::SmallDenseSet< WeakInfo, 2u, WeakInfo::DenseMapInfoByAliasOnly > > > WeakUndeclaredIdentifiers
WeakUndeclaredIdentifiers - Identifiers contained in #pragma weak before declared.
Definition Sema.h:3596
LazyDeclPtr StdAlignValT
The C++ "std::align_val_t" enum class, which is defined by the C++ standard library.
Definition Sema.h:8441
IdentifierResolver IdResolver
Definition Sema.h:3519
static RawLocEncoding encode(SourceLocation Loc, UIntTy BaseOffset, unsigned BaseModuleFileIndex)
Encodes a location in the source.
bool isValid() const
Return true if this is a valid SourceLocation object.
SourceLocation getLocWithOffset(IntTy Offset) const
Return a source location with the specified offset from this SourceLocation.
This class handles loading and caching of source files into memory.
FileID getFileID(SourceLocation SpellingLoc) const
Return the FileID for a SourceLocation.
DiagnosticsEngine & getDiagnostics() const
SourceLocation::UIntTy getNextLocalOffset() const
OptionalFileEntryRef getFileEntryRefForID(FileID FID) const
Returns the FileEntryRef for the provided FileID.
const SrcMgr::SLocEntry & getLocalSLocEntry(unsigned Index) const
Get a local SLocEntry. This is exposed for indexing.
FileManager & getFileManager() const
unsigned local_sloc_entry_size() const
Get the number of local SLocEntries we have.
SourceLocation getLocForEndOfFile(FileID FID) const
Return the source location corresponding to the last byte of the specified file.
FileID getMainFileID() const
Returns the FileID of the main source file.
unsigned getFileIDSize(FileID FID) const
The size of the SLocEntry that FID represents.
bool hasLineTable() const
Determine if the source manager has a line table.
bool isLoadedFileID(FileID FID) const
Returns true if FID came from a PCH/Module.
SourceLocation getLocForStartOfFile(FileID FID) const
Return the source location corresponding to the first byte of the specified file.
LineTableInfo & getLineTable()
Retrieve the stored line table.
const SrcMgr::SLocEntry & getSLocEntry(FileID FID, bool *Invalid=nullptr) const
A trivial tuple used to represent a source range.
SourceLocation getEnd() const
OptionalFileEntryRef ContentsEntry
References the file which the contents were actually loaded from.
unsigned IsTransient
True if this file may be transient, that is, if it might not exist at some later point in time when t...
std::optional< llvm::MemoryBufferRef > getBufferOrNone(DiagnosticsEngine &Diag, FileManager &FM, SourceLocation Loc=SourceLocation()) const
Returns the memory buffer for the associated content.
unsigned BufferOverridden
Indicates whether the buffer itself was provided to override the actual file contents.
OptionalFileEntryRef OrigEntry
Reference to the file entry representing this ContentCache.
SourceLocation getExpansionLocStart() const
SourceLocation getSpellingLoc() const
SourceLocation getExpansionLocEnd() const
const ContentCache & getContentCache() const
SourceLocation::UIntTy getOffset() const
const FileInfo & getFile() const
const ExpansionInfo & getExpansion() const
An array of decls optimized for the common case of only containing one entry.
StringLiteral - This represents a string literal expression, e.g.
Definition Expr.h:1802
Represents the declaration of a struct/union/class/enum.
Definition Decl.h:3732
bool isCompleteDefinition() const
Return true if this decl has its body fully specified.
Definition Decl.h:3833
bool isDependentType() const
Whether this declaration declares a type that is dependent, i.e., a type that somehow depends on temp...
Definition Decl.h:3878
SourceLocation getNameLoc() const
Definition TypeLoc.h:822
SourceLocation getElaboratedKeywordLoc() const
Definition TypeLoc.h:801
NestedNameSpecifierLoc getQualifierLoc() const
Definition TypeLoc.h:809
TargetOptions & getTargetOpts() const
Retrieve the target options.
Definition TargetInfo.h:327
std::string Triple
The name of the target triple to compile for.
std::vector< std::string > Features
The list of target specific features to enable or disable – this should be a list of strings starting...
std::string ABI
If given, the name of the target ABI to use.
std::string TuneCPU
If given, the name of the target CPU to tune code for.
std::string CPU
If given, the name of the target CPU to generate code for.
std::vector< std::string > FeaturesAsWritten
The list of target specific features to enable or disable, as written on the command line.
A template argument list.
unsigned size() const
Retrieve the number of template arguments in this template argument list.
const TemplateArgument & get(unsigned Idx) const
Retrieve the template argument at a given index.
Location wrapper for a TemplateArgument.
SourceLocation getTemplateEllipsisLoc() const
TemplateArgumentLocInfo getLocInfo() const
const TemplateArgument & getArgument() const
SourceLocation getTemplateNameLoc() const
SourceLocation getTemplateKWLoc() const
NestedNameSpecifierLoc getTemplateQualifierLoc() const
Expr * getAsExpr() const
Retrieve the template argument as an expression.
@ Declaration
The template argument is a declaration that was provided for a pointer, reference,...
@ Template
The template argument is a template name that was provided for a template template parameter.
@ StructuralValue
The template argument is a non-type template argument that can't be represented by the special-case D...
@ Pack
The template argument is actually a parameter pack.
@ TemplateExpansion
The template argument is a pack expansion of a template name that was provided for a template templat...
@ NullPtr
The template argument is a null pointer or null pointer to member that was provided for a non-type te...
@ Type
The template argument is a type.
@ Null
Represents an empty template argument, e.g., one that has not been deduced.
@ Integral
The template argument is an integral value stored in an llvm::APSInt that was provided for an integra...
@ Expression
The template argument is an expression, and we've not resolved it to one of the other forms yet,...
ArgKind getKind() const
Return the kind of stored template argument.
Stores a list of template parameters for a TemplateDecl and its derived classes.
Expr * getRequiresClause()
The constraint-expression of the associated requires-clause.
SourceLocation getRAngleLoc() const
SourceLocation getLAngleLoc() const
SourceLocation getTemplateLoc() const
SourceLocation getLAngleLoc() const
Definition TypeLoc.h:1907
TemplateArgumentLoc getArgLoc(unsigned i) const
Definition TypeLoc.h:1917
SourceLocation getRAngleLoc() const
Definition TypeLoc.h:1922
SourceLocation getTemplateNameLoc() const
Definition TypeLoc.h:1905
SourceLocation getTemplateKeywordLoc() const
Definition TypeLoc.h:1901
NestedNameSpecifierLoc getQualifierLoc() const
Definition TypeLoc.h:1891
SourceLocation getElaboratedKeywordLoc() const
Definition TypeLoc.h:1887
Token - This structure provides full information about a lexed token.
Definition Token.h:36
The top declaration context.
Definition Decl.h:105
NamespaceDecl * getAnonymousNamespace() const
Definition Decl.h:143
Base wrapper for a particular "section" of type source info.
Definition TypeLoc.h:59
QualType getType() const
Get the type for which this source info wrapper provides information.
Definition TypeLoc.h:133
TypeLoc getNextTypeLoc() const
Get the next TypeLoc pointed by this TypeLoc, e.g for "int*" the TypeLoc is a PointerLoc and next Typ...
Definition TypeLoc.h:171
bool isNull() const
Definition TypeLoc.h:121
TypeSourceInfo * getUnmodifiedTInfo() const
Definition TypeLoc.h:2261
A container of type source information.
Definition TypeBase.h:8402
TypeLoc getTypeLoc() const
Return the TypeLoc wrapper for the type source info.
Definition TypeLoc.h:267
QualType getType() const
Return the type wrapped by this type source info.
Definition TypeBase.h:8413
SourceLocation getNameLoc() const
Definition TypeLoc.h:547
TypeClass getTypeClass() const
Definition TypeBase.h:2433
SourceLocation getLParenLoc() const
Definition TypeLoc.h:2204
SourceLocation getRParenLoc() const
Definition TypeLoc.h:2212
SourceLocation getTypeofLoc() const
Definition TypeLoc.h:2196
SourceLocation getKWLoc() const
Definition TypeLoc.h:2343
SourceLocation getRParenLoc() const
Definition TypeLoc.h:2349
TypeSourceInfo * getUnderlyingTInfo() const
Definition TypeLoc.h:2352
SourceLocation getLParenLoc() const
Definition TypeLoc.h:2346
Represent the declaration of a variable (in which case it is an lvalue) a function (in which case it ...
Definition Decl.h:712
Represents a variable declaration or definition.
Definition Decl.h:926
bool hasInitWithSideEffects() const
Checks whether this declaration has an initializer with side effects.
Definition Decl.cpp:2456
EvaluatedStmt * getEvaluatedStmt() const
Definition Decl.cpp:2583
const Expr * getInit() const
Definition Decl.h:1383
APValue * getEvaluatedValue() const
Return the already-evaluated value of this variable's initializer, or NULL if the value is not yet kn...
Definition Decl.cpp:2640
Declaration of a variable template.
Represents a variable template specialization, which refers to a variable template with a given set o...
SourceLocation getNameLoc() const
Definition TypeLoc.h:2043
SourceLocation getLocation() const
Retrieve the location at which this variable was captured.
Definition ScopeInfo.h:690
SourceLocation getEllipsisLoc() const
Retrieve the source location of the ellipsis, whose presence indicates that the capture is a pack exp...
Definition ScopeInfo.h:694
OverloadedOperatorKind getOperatorKind() const
IdentifierInfo * getIdentifier() const
Information about a module that has been loaded by the ASTReader.
Definition ModuleFile.h:145
serialization::SelectorID BaseSelectorID
Base selector ID for selectors local to this module.
Definition ModuleFile.h:449
unsigned LocalNumSubmodules
The number of submodules in this module.
Definition ModuleFile.h:429
bool isModule() const
Is this a module file for a module (rather than a PCH or similar).
Definition ModuleFile.h:538
unsigned Index
The index of this module in the list of modules.
Definition ModuleFile.h:154
serialization::SubmoduleID BaseSubmoduleID
Base submodule ID for submodules local to this module.
Definition ModuleFile.h:432
SourceLocation::UIntTy SLocEntryBaseOffset
The base offset in the source manager's view of this module.
Definition ModuleFile.h:323
ModuleFileName FileName
The file name of the module file.
Definition ModuleFile.h:160
unsigned LocalNumSelectors
The number of selectors new to this file.
Definition ModuleFile.h:442
ModuleKind Kind
The type of this module.
Definition ModuleFile.h:157
std::string ModuleName
The name of the module.
Definition ModuleFile.h:166
A type index; the type ID with the qualifier bits removed.
Definition ASTBitCodes.h:99
uint32_t getModuleFileIndex() const
TypeID asTypeID(unsigned FastQuals) const
SmallVector< LazySpecializationInfo, 4 > data_type
The lookup result is a list of global declaration IDs.
const unsigned int LOCAL_REDECLARATIONS
Record code for a list of local redeclarations of a declaration.
TypeCode
Record codes for each kind of type.
const unsigned int DECL_UPDATES
Record of updates for a declaration that was modified after being deserialized.
@ PREDEF_TYPE_AUTO_RREF_DEDUCT
The "auto &&" deduction type.
@ PREDEF_TYPE_NULL_ID
The NULL type.
@ PREDEF_TYPE_AUTO_DEDUCT
The "auto" deduction type.
@ DECL_EMPTY
An EmptyDecl record.
@ DECL_CXX_BASE_SPECIFIERS
A record containing CXXBaseSpecifiers.
@ DECL_CXX_RECORD
A CXXRecordDecl record.
@ DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION
A VarTemplatePartialSpecializationDecl record.
@ DECL_OMP_ALLOCATE
An OMPAllocateDcl record.
@ DECL_MS_PROPERTY
A MSPropertyDecl record.
@ DECL_REQUIRES_EXPR_BODY
A RequiresExprBodyDecl record.
@ DECL_STATIC_ASSERT
A StaticAssertDecl record.
@ DECL_INDIRECTFIELD
A IndirectFieldDecl record.
@ DECL_TEMPLATE_TEMPLATE_PARM
A TemplateTemplateParmDecl record.
@ DECL_IMPORT
An ImportDecl recording a module import.
@ DECL_ACCESS_SPEC
An AccessSpecDecl record.
@ DECL_OBJC_TYPE_PARAM
An ObjCTypeParamDecl record.
@ DECL_OBJC_CATEGORY_IMPL
A ObjCCategoryImplDecl record.
@ DECL_ENUM_CONSTANT
An EnumConstantDecl record.
@ DECL_PARM_VAR
A ParmVarDecl record.
@ DECL_TYPEDEF
A TypedefDecl record.
@ DECL_EXPANDED_TEMPLATE_TEMPLATE_PARM_PACK
A TemplateTemplateParmDecl record that stores an expanded template template parameter pack.
@ DECL_HLSL_BUFFER
A HLSLBufferDecl record.
@ DECL_NAMESPACE_ALIAS
A NamespaceAliasDecl record.
@ DECL_TYPEALIAS
A TypeAliasDecl record.
@ DECL_FUNCTION_TEMPLATE
A FunctionTemplateDecl record.
@ DECL_UNRESOLVED_USING_TYPENAME
An UnresolvedUsingTypenameDecl record.
@ DECL_CLASS_TEMPLATE_SPECIALIZATION
A ClassTemplateSpecializationDecl record.
@ DECL_FILE_SCOPE_ASM
A FileScopeAsmDecl record.
@ DECL_CXX_CONSTRUCTOR
A CXXConstructorDecl record.
@ DECL_CXX_CONVERSION
A CXXConversionDecl record.
@ DECL_FIELD
A FieldDecl record.
@ DECL_LINKAGE_SPEC
A LinkageSpecDecl record.
@ DECL_CONTEXT_TU_LOCAL_VISIBLE
A record that stores the set of declarations that are only visible to the TU.
@ DECL_NAMESPACE
A NamespaceDecl record.
@ DECL_NON_TYPE_TEMPLATE_PARM
A NonTypeTemplateParmDecl record.
@ DECL_FUNCTION
A FunctionDecl record.
@ DECL_USING_DIRECTIVE
A UsingDirecitveDecl record.
@ DECL_RECORD
A RecordDecl record.
@ DECL_CONTEXT_LEXICAL
A record that stores the set of declarations that are lexically stored within a given DeclContext.
@ DECL_BLOCK
A BlockDecl record.
@ DECL_UNRESOLVED_USING_VALUE
An UnresolvedUsingValueDecl record.
@ DECL_TYPE_ALIAS_TEMPLATE
A TypeAliasTemplateDecl record.
@ DECL_CXX_CTOR_INITIALIZERS
A record containing CXXCtorInitializers.
@ DECL_OBJC_CATEGORY
A ObjCCategoryDecl record.
@ DECL_VAR
A VarDecl record.
@ DECL_USING
A UsingDecl record.
@ DECL_OBJC_PROTOCOL
A ObjCProtocolDecl record.
@ DECL_TEMPLATE_TYPE_PARM
A TemplateTypeParmDecl record.
@ DECL_VAR_TEMPLATE_SPECIALIZATION
A VarTemplateSpecializationDecl record.
@ DECL_OBJC_IMPLEMENTATION
A ObjCImplementationDecl record.
@ DECL_OBJC_COMPATIBLE_ALIAS
A ObjCCompatibleAliasDecl record.
@ DECL_FRIEND_TEMPLATE
A FriendTemplateDecl record.
@ DECL_PRAGMA_DETECT_MISMATCH
A PragmaDetectMismatchDecl record.
@ DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK
A NonTypeTemplateParmDecl record that stores an expanded non-type template parameter pack.
@ DECL_OBJC_AT_DEFS_FIELD
A ObjCAtDefsFieldDecl record.
@ DECL_IMPLICIT_PARAM
An ImplicitParamDecl record.
@ DECL_FRIEND
A FriendDecl record.
@ DECL_CXX_METHOD
A CXXMethodDecl record.
@ DECL_EXPORT
An ExportDecl record.
@ DECL_PRAGMA_COMMENT
A PragmaCommentDecl record.
@ DECL_ENUM
An EnumDecl record.
@ DECL_CONTEXT_MODULE_LOCAL_VISIBLE
A record containing the set of declarations that are only visible from DeclContext in the same module...
@ DECL_OMP_DECLARE_REDUCTION
An OMPDeclareReductionDecl record.
@ DECL_OMP_THREADPRIVATE
An OMPThreadPrivateDecl record.
@ DECL_OBJC_METHOD
A ObjCMethodDecl record.
@ DECL_CXX_DESTRUCTOR
A CXXDestructorDecl record.
@ DECL_OMP_CAPTUREDEXPR
An OMPCapturedExprDecl record.
@ DECL_CLASS_TEMPLATE
A ClassTemplateDecl record.
@ DECL_USING_SHADOW
A UsingShadowDecl record.
@ DECL_CONCEPT
A ConceptDecl record.
@ DECL_OBJC_IVAR
A ObjCIvarDecl record.
@ DECL_OBJC_PROPERTY
A ObjCPropertyDecl record.
@ DECL_OBJC_INTERFACE
A ObjCInterfaceDecl record.
@ DECL_VAR_TEMPLATE
A VarTemplateDecl record.
@ DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION
A ClassTemplatePartialSpecializationDecl record.
@ DECL_CONTEXT_VISIBLE
A record that stores the set of declarations that are visible from a given DeclContext.
@ DECL_OBJC_PROPERTY_IMPL
A ObjCPropertyImplDecl record.
@ TYPE_EXT_QUAL
An ExtQualType record.
@ EXPR_DESIGNATED_INIT
A DesignatedInitExpr record.
@ EXPR_COMPOUND_LITERAL
A CompoundLiteralExpr record.
@ EXPR_OBJC_IVAR_REF_EXPR
An ObjCIvarRefExpr record.
@ EXPR_MEMBER
A MemberExpr record.
@ EXPR_CXX_TEMPORARY_OBJECT
A CXXTemporaryObjectExpr record.
@ EXPR_COMPOUND_ASSIGN_OPERATOR
A CompoundAssignOperator record.
@ EXPR_CXX_STATIC_CAST
A CXXStaticCastExpr record.
@ EXPR_OBJC_STRING_LITERAL
An ObjCStringLiteral record.
@ EXPR_VA_ARG
A VAArgExpr record.
@ EXPR_CXX_OPERATOR_CALL
A CXXOperatorCallExpr record.
@ STMT_OBJC_AT_TRY
An ObjCAtTryStmt record.
@ STMT_DO
A DoStmt record.
@ STMT_OBJC_CATCH
An ObjCAtCatchStmt record.
@ STMT_IF
An IfStmt record.
@ EXPR_STRING_LITERAL
A StringLiteral record.
@ EXPR_IMPLICIT_CAST
An ImplicitCastExpr record.
@ STMT_GCCASM
A GCC-style AsmStmt record.
@ EXPR_IMAGINARY_LITERAL
An ImaginaryLiteral record.
@ STMT_WHILE
A WhileStmt record.
@ EXPR_STMT
A StmtExpr record.
@ EXPR_CXX_REINTERPRET_CAST
A CXXReinterpretCastExpr record.
@ EXPR_DESIGNATED_INIT_UPDATE
A DesignatedInitUpdateExpr record.
@ STMT_OBJC_AT_SYNCHRONIZED
An ObjCAtSynchronizedStmt record.
@ EXPR_CHARACTER_LITERAL
A CharacterLiteral record.
@ EXPR_OBJC_ENCODE
An ObjCEncodeExpr record.
@ EXPR_CSTYLE_CAST
A CStyleCastExpr record.
@ EXPR_OBJC_BOOL_LITERAL
An ObjCBoolLiteralExpr record.
@ EXPR_EXT_VECTOR_ELEMENT
An ExtVectorElementExpr record.
@ STMT_RETURN
A ReturnStmt record.
@ STMT_OBJC_FOR_COLLECTION
An ObjCForCollectionStmt record.
@ STMT_CONTINUE
A ContinueStmt record.
@ EXPR_PREDEFINED
A PredefinedExpr record.
@ EXPR_CXX_BOOL_LITERAL
A CXXBoolLiteralExpr record.
@ EXPR_PAREN_LIST
A ParenListExpr record.
@ EXPR_CXX_PAREN_LIST_INIT
A CXXParenListInitExpr record.
@ STMT_COMPOUND
A CompoundStmt record.
@ STMT_FOR
A ForStmt record.
@ STMT_ATTRIBUTED
An AttributedStmt record.
@ EXPR_CXX_REWRITTEN_BINARY_OPERATOR
A CXXRewrittenBinaryOperator record.
@ STMT_GOTO
A GotoStmt record.
@ EXPR_NO_INIT
An NoInitExpr record.
@ EXPR_OBJC_PROTOCOL_EXPR
An ObjCProtocolExpr record.
@ EXPR_CXX_CONSTRUCT
A CXXConstructExpr record.
@ EXPR_CXX_DYNAMIC_CAST
A CXXDynamicCastExpr record.
@ STMT_CXX_TRY
A CXXTryStmt record.
@ EXPR_GENERIC_SELECTION
A GenericSelectionExpr record.
@ EXPR_CALL
A CallExpr record.
@ EXPR_GNU_NULL
A GNUNullExpr record.
@ EXPR_OBJC_PROPERTY_REF_EXPR
An ObjCPropertyRefExpr record.
@ EXPR_CXX_CONST_CAST
A CXXConstCastExpr record.
@ STMT_REF_PTR
A reference to a previously [de]serialized Stmt record.
@ EXPR_OBJC_MESSAGE_EXPR
An ObjCMessageExpr record.
@ STMT_CASE
A CaseStmt record.
@ STMT_STOP
A marker record that indicates that we are at the end of an expression.
@ STMT_MSASM
A MS-style AsmStmt record.
@ EXPR_CONDITIONAL_OPERATOR
A ConditionOperator record.
@ EXPR_BINARY_OPERATOR
A BinaryOperator record.
@ EXPR_CXX_STD_INITIALIZER_LIST
A CXXStdInitializerListExpr record.
@ EXPR_SHUFFLE_VECTOR
A ShuffleVectorExpr record.
@ STMT_OBJC_FINALLY
An ObjCAtFinallyStmt record.
@ EXPR_OBJC_SELECTOR_EXPR
An ObjCSelectorExpr record.
@ EXPR_FLOATING_LITERAL
A FloatingLiteral record.
@ STMT_NULL_PTR
A NULL expression.
@ STMT_DEFAULT
A DefaultStmt record.
@ EXPR_CHOOSE
A ChooseExpr record.
@ STMT_NULL
A NullStmt record.
@ EXPR_DECL_REF
A DeclRefExpr record.
@ EXPR_INIT_LIST
An InitListExpr record.
@ EXPR_IMPLICIT_VALUE_INIT
An ImplicitValueInitExpr record.
@ EXPR_PAREN
A ParenExpr record.
@ STMT_LABEL
A LabelStmt record.
@ EXPR_CXX_FUNCTIONAL_CAST
A CXXFunctionalCastExpr record.
@ EXPR_USER_DEFINED_LITERAL
A UserDefinedLiteral record.
@ EXPR_INTEGER_LITERAL
An IntegerLiteral record.
@ EXPR_CXX_MEMBER_CALL
A CXXMemberCallExpr record.
@ STMT_SWITCH
A SwitchStmt record.
@ STMT_DECL
A DeclStmt record.
@ EXPR_OBJC_KVC_REF_EXPR
UNUSED.
@ EXPR_SIZEOF_ALIGN_OF
A SizefAlignOfExpr record.
@ STMT_BREAK
A BreakStmt record.
@ STMT_OBJC_AT_THROW
An ObjCAtThrowStmt record.
@ EXPR_ADDR_LABEL
An AddrLabelExpr record.
@ STMT_CXX_FOR_RANGE
A CXXForRangeStmt record.
@ EXPR_CXX_ADDRSPACE_CAST
A CXXAddrspaceCastExpr record.
@ EXPR_ARRAY_SUBSCRIPT
An ArraySubscriptExpr record.
@ EXPR_UNARY_OPERATOR
A UnaryOperator record.
@ STMT_CXX_CATCH
A CXXCatchStmt record.
@ STMT_INDIRECT_GOTO
An IndirectGotoStmt record.
Defines the clang::TargetInfo interface.
bool isSystem(CharacteristicKind CK)
Determine whether a file / directory characteristic is for system code.
bool isModuleMap(CharacteristicKind CK)
Determine whether a file characteristic is for a module map.
VE builtins.
bool LE(InterpState &S, CodePtr OpPC)
Definition Interp.h:1338
std::variant< struct RequiresDecl, struct HeaderDecl, struct UmbrellaDirDecl, struct ModuleDecl, struct ExcludeDecl, struct ExportDecl, struct ExportAsDecl, struct ExternModuleDecl, struct UseDecl, struct LinkDecl, struct ConfigMacrosDecl, struct ConflictDecl > Decl
All declarations that can appear in a module declaration.
@ EXTENSION_METADATA
Metadata describing this particular extension.
@ SUBMODULE_EXCLUDED_HEADER
Specifies a header that has been explicitly excluded from this submodule.
@ SUBMODULE_TOPHEADER
Specifies a top-level header that falls into this (sub)module.
@ SUBMODULE_PRIVATE_TEXTUAL_HEADER
Specifies a header that is private to this submodule but must be textually included.
@ SUBMODULE_HEADER
Specifies a header that falls into this (sub)module.
@ SUBMODULE_EXPORT_AS
Specifies the name of the module that will eventually re-export the entities in this module.
@ SUBMODULE_UMBRELLA_DIR
Specifies an umbrella directory.
@ SUBMODULE_UMBRELLA_HEADER
Specifies the umbrella header used to create this module, if any.
@ SUBMODULE_METADATA
Metadata for submodules as a whole.
@ SUBMODULE_REQUIRES
Specifies a required feature.
@ SUBMODULE_PRIVATE_HEADER
Specifies a header that is private to this submodule.
@ SUBMODULE_IMPORTS
Specifies the submodules that are imported by this submodule.
@ SUBMODULE_CONFLICT
Specifies a conflict with another module.
@ SUBMODULE_INITIALIZERS
Specifies some declarations with initializers that must be emitted to initialize the module.
@ SUBMODULE_DEFINITION
Defines the major attributes of a submodule, including its name and parent.
@ SUBMODULE_LINK_LIBRARY
Specifies a library or framework to link against.
@ SUBMODULE_CONFIG_MACRO
Specifies a configuration macro for this module.
@ SUBMODULE_EXPORTS
Specifies the submodules that are re-exported from this submodule.
@ SUBMODULE_TEXTUAL_HEADER
Specifies a header that is part of the module but must be textually included.
@ SUBMODULE_AFFECTING_MODULES
Specifies affecting modules that were not imported.
TypeIdx TypeIdxFromBuiltin(const BuiltinType *BT)
Definition ASTCommon.cpp:26
uint32_t SelectorID
An ID number that refers to an ObjC selector in an AST file.
@ UserFiles
When the validation is done only for user files as an optimization.
Definition ModuleFile.h:133
const unsigned int NUM_PREDEF_IDENT_IDS
The number of predefined identifier IDs.
Definition ASTBitCodes.h:66
@ FILE_SYSTEM_OPTIONS
Record code for the filesystem options table.
@ TARGET_OPTIONS
Record code for the target options table.
@ PREPROCESSOR_OPTIONS
Record code for the preprocessor options table.
@ HEADER_SEARCH_OPTIONS
Record code for the headers search options table.
@ CODEGEN_OPTIONS
Record code for the codegen options table.
@ LANGUAGE_OPTIONS
Record code for the language options table.
const unsigned int NUM_PREDEF_PP_ENTITY_IDS
The number of predefined preprocessed entity IDs.
const unsigned int NUM_PREDEF_SUBMODULE_IDS
The number of predefined submodule IDs.
@ SUBMODULE_BLOCK_ID
The block containing the submodule structure.
@ PREPROCESSOR_DETAIL_BLOCK_ID
The block containing the detailed preprocessing record.
@ AST_BLOCK_ID
The AST block, which acts as a container around the full AST block.
@ SOURCE_MANAGER_BLOCK_ID
The block containing information about the source manager.
@ CONTROL_BLOCK_ID
The control block, which contains all of the information that needs to be validated prior to committi...
@ DECLTYPES_BLOCK_ID
The block containing the definitions of all of the types and decls used within the AST file.
@ PREPROCESSOR_BLOCK_ID
The block containing information about the preprocessor.
@ COMMENTS_BLOCK_ID
The block containing comments.
@ UNHASHED_CONTROL_BLOCK_ID
A block with unhashed content.
@ EXTENSION_BLOCK_ID
A block containing a module file extension.
@ OPTIONS_BLOCK_ID
The block of configuration options, used to check that a module is being used in a configuration comp...
@ INPUT_FILES_BLOCK_ID
The block of input files, which were used as inputs to create this AST file.
unsigned StableHashForTemplateArguments(llvm::ArrayRef< TemplateArgument > Args)
Calculate a stable hash value for template arguments.
DeclIDBase::DeclID DeclID
An ID number that refers to a declaration in an AST file.
Definition ASTBitCodes.h:70
const unsigned VERSION_MINOR
AST file minor version number supported by this version of Clang.
Definition ASTBitCodes.h:57
@ SM_SLOC_FILE_ENTRY
Describes a source location entry (SLocEntry) for a file.
@ SM_SLOC_BUFFER_BLOB_COMPRESSED
Describes a zlib-compressed blob that contains the data for a buffer entry.
@ SM_SLOC_BUFFER_ENTRY
Describes a source location entry (SLocEntry) for a buffer.
@ SM_SLOC_BUFFER_BLOB
Describes a blob that contains the data for a buffer entry.
@ SM_SLOC_EXPANSION_ENTRY
Describes a source location entry (SLocEntry) for a macro expansion.
const unsigned int NUM_PREDEF_SELECTOR_IDS
The number of predefined selector IDs.
bool needsAnonymousDeclarationNumber(const NamedDecl *D)
Determine whether the given declaration needs an anonymous declaration number.
const unsigned VERSION_MAJOR
AST file major version number supported by this version of Clang.
Definition ASTBitCodes.h:47
uint64_t PreprocessedEntityID
An ID number that refers to an entity in the detailed preprocessing record.
@ PP_TOKEN
Describes one token.
@ PP_MACRO_FUNCTION_LIKE
A function-like macro definition.
@ PP_MACRO_OBJECT_LIKE
An object-like macro definition.
@ PP_MACRO_DIRECTIVE_HISTORY
The macro directives history for a particular identifier.
@ PP_MODULE_MACRO
A macro directive exported by a module.
void numberAnonymousDeclsWithin(const DeclContext *DC, Fn Visit)
Visit each declaration within DC that needs an anonymous declaration number and call Visit with the d...
Definition ASTCommon.h:76
@ MODULE_MAP_FILE
Record code for the module map file that was used to build this AST file.
@ MODULE_DIRECTORY
Record code for the module build directory.
@ ORIGINAL_FILE_ID
Record code for file ID of the file or buffer that was used to generate the AST file.
@ MODULE_NAME
Record code for the module name.
@ ORIGINAL_FILE
Record code for the original file that was used to generate the AST file, including both its file ID ...
@ INPUT_FILE_OFFSETS
Offsets into the input-files block where input files reside.
@ METADATA
AST file metadata, including the AST file version number and information about the compiler used to b...
@ DIAGNOSTIC_OPTIONS
Record code for the diagnostic options table.
@ HEADER_SEARCH_ENTRY_USAGE
Record code for the indices of used header search entries.
@ AST_BLOCK_HASH
Record code for the content hash of the AST block.
@ DIAG_PRAGMA_MAPPINGS
Record code for #pragma diagnostic mappings.
@ SIGNATURE
Record code for the signature that identifiers this AST file.
@ HEADER_SEARCH_PATHS
Record code for the headers search paths.
@ VFS_USAGE
Record code for the indices of used VFSs.
uint64_t MacroID
An ID number that refers to a macro in an AST file.
@ INPUT_FILE_HASH
The input file content hash.
@ INPUT_FILE
An input file.
const DeclContext * getDefinitiveDeclContext(const DeclContext *DC)
Retrieve the "definitive" declaration that provides all of the visible entries for the given declarat...
uint64_t TypeID
An ID number that refers to a type in an AST file.
Definition ASTBitCodes.h:88
@ PPD_INCLUSION_DIRECTIVE
Describes an inclusion directive within the preprocessing record.
@ PPD_MACRO_EXPANSION
Describes a macro expansion within the preprocessing record.
@ PPD_MACRO_DEFINITION
Describes a macro definition within the preprocessing record.
uint32_t SubmoduleID
An ID number that refers to a submodule in a module file.
@ DECL_UPDATE_OFFSETS
Record for offsets of DECL_UPDATES records for declarations that were modified after being deserializ...
@ STATISTICS
Record code for the extra statistics we gather while generating an AST file.
@ FLOAT_CONTROL_PRAGMA_OPTIONS
Record code for #pragma float_control options.
@ KNOWN_NAMESPACES
Record code for the set of known namespaces, which are used for typo correction.
@ SPECIAL_TYPES
Record code for the set of non-builtin, special types.
@ PENDING_IMPLICIT_INSTANTIATIONS
Record code for pending implicit instantiations.
@ TYPE_OFFSET
Record code for the offsets of each type.
@ DELEGATING_CTORS
The list of delegating constructor declarations.
@ PP_ASSUME_NONNULL_LOC
ID 66 used to be the list of included files.
@ EXT_VECTOR_DECLS
Record code for the set of ext_vector type names.
@ OPENCL_EXTENSIONS
Record code for enabled OpenCL extensions.
@ FP_PRAGMA_OPTIONS
Record code for floating point #pragma options.
@ PP_UNSAFE_BUFFER_USAGE
Record code for #pragma clang unsafe_buffer_usage begin/end.
@ CXX_ADDED_TEMPLATE_PARTIAL_SPECIALIZATION
@ DECLS_WITH_EFFECTS_TO_VERIFY
Record code for Sema's vector of functions/blocks with effects to be verified.
@ VTABLE_USES
Record code for the array of VTable uses.
@ LATE_PARSED_TEMPLATE
Record code for late parsed template functions.
@ DECLS_TO_CHECK_FOR_DEFERRED_DIAGS
Record code for the Decls to be checked for deferred diags.
@ DECL_OFFSET
Record code for the offsets of each decl.
@ SOURCE_MANAGER_LINE_TABLE
Record code for the source manager line table information, which stores information about #line direc...
@ PP_COUNTER_VALUE
The value of the next COUNTER to dispense.
@ DELETE_EXPRS_TO_ANALYZE
Delete expressions that will be analyzed later.
@ EXTNAME_UNDECLARED_IDENTIFIERS
Record code for extname-redefined undeclared identifiers.
@ RELATED_DECLS_MAP
Record code for related declarations that have to be deserialized together from the same module.
@ UPDATE_VISIBLE
Record code for an update to a decl context's lookup table.
@ CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH
Number of unmatched pragma clang cuda_force_host_device begin directives we've seen.
@ MACRO_OFFSET
Record code for the table of offsets of each macro ID.
@ PPD_ENTITIES_OFFSETS
Record code for the table of offsets to entries in the preprocessing record.
@ RISCV_VECTOR_INTRINSICS_PRAGMA
Record code for pragma clang riscv intrinsic vector.
@ OPENCL_EXTENSION_DECLS
Record code for declarations associated with OpenCL extensions.
@ VTABLES_TO_EMIT
Record code for vtables to emit.
@ IDENTIFIER_OFFSET
Record code for the table of offsets of each identifier ID.
@ OBJC_CATEGORIES
Record code for the array of Objective-C categories (including extensions).
@ METHOD_POOL
Record code for the Objective-C method pool,.
@ DELAYED_NAMESPACE_LEXICAL_VISIBLE_RECORD
Record code for lexical and visible block for delayed namespace in reduced BMI.
@ PP_CONDITIONAL_STACK
The stack of open ifs/ifdefs recorded in a preamble.
@ REFERENCED_SELECTOR_POOL
Record code for referenced selector pool.
@ SOURCE_LOCATION_OFFSETS
Record code for the table of offsets into the block of source-location information.
@ WEAK_UNDECLARED_IDENTIFIERS
Record code for weak undeclared identifiers.
@ UNDEFINED_BUT_USED
Record code for undefined but used functions and variables that need a definition in this TU.
@ FILE_SORTED_DECLS
Record code for a file sorted array of DeclIDs in a module.
@ MSSTRUCT_PRAGMA_OPTIONS
Record code for #pragma ms_struct options.
@ TENTATIVE_DEFINITIONS
Record code for the array of tentative definitions.
@ UNUSED_FILESCOPED_DECLS
Record code for the array of unused file scoped decls.
@ ALIGN_PACK_PRAGMA_OPTIONS
Record code for #pragma align/pack options.
@ IMPORTED_MODULES
Record code for an array of all of the (sub)modules that were imported by the AST file.
@ SELECTOR_OFFSETS
Record code for the table of offsets into the Objective-C method pool.
@ UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES
Record code for potentially unused local typedef names.
@ OPENCL_EXTENSION_TYPES
Record code for types associated with OpenCL extensions.
@ EAGERLY_DESERIALIZED_DECLS
Record code for the array of eagerly deserialized decls.
@ INTERESTING_IDENTIFIERS
A list of "interesting" identifiers.
@ HEADER_SEARCH_TABLE
Record code for header search information.
@ OBJC_CATEGORIES_MAP
Record code for map of Objective-C class definition IDs to the ObjC categories in a module that are a...
@ METADATA_OLD_FORMAT
This is so that older clang versions, before the introduction of the control block,...
@ CUDA_SPECIAL_DECL_REFS
Record code for special CUDA declarations.
@ TU_UPDATE_LEXICAL
Record code for an update to the TU's lexically contained declarations.
@ PPD_SKIPPED_RANGES
A table of skipped ranges within the preprocessing record.
@ IDENTIFIER_TABLE
Record code for the identifier table.
@ SEMA_DECL_REFS
Record code for declarations that Sema keeps references of.
@ OPTIMIZE_PRAGMA_OPTIONS
Record code for #pragma optimize options.
@ MODULE_OFFSET_MAP
Record code for the remapping information used to relate loaded modules to the various offsets and ID...
@ POINTERS_TO_MEMBERS_PRAGMA_OPTIONS
Record code for #pragma ms_struct options.
unsigned ComputeHash(Selector Sel)
uint64_t IdentifierID
An ID number that refers to an identifier in an AST file.
Definition ASTBitCodes.h:63
std::shared_ptr< MatchComputation< T > > Generator
Definition RewriteRule.h:65
RangeSelector range(RangeSelector Begin, RangeSelector End)
DEPRECATED. Use enclose.
The JSON file list parser is used to communicate input to InstallAPI.
@ NUM_OVERLOADED_OPERATORS
bool isa(CodeGen::Address addr)
Definition Address.h:330
bool isTemplateInstantiation(TemplateSpecializationKind Kind)
Determine whether this template specialization kind refers to an instantiation of an entity (as oppos...
Definition Specifiers.h:212
CustomizableOptional< FileEntryRef > OptionalFileEntryRef
Definition FileEntry.h:208
@ CPlusPlus
@ Specialization
We are substituting template parameters for template arguments in order to form a template specializa...
Definition Template.h:50
bool isUnresolvedExceptionSpec(ExceptionSpecificationType ESpecType)
@ LCK_ByCopy
Capturing by copy (a.k.a., by value)
Definition Lambda.h:36
@ LCK_ByRef
Capturing by reference.
Definition Lambda.h:37
@ LCK_VLAType
Capturing variable-length array type.
Definition Lambda.h:38
@ LCK_StarThis
Capturing the *this object by copy.
Definition Lambda.h:35
@ LCK_This
Capturing the *this object by reference.
Definition Lambda.h:34
@ Auto
'auto' clause, allowed on 'loop' directives.
@ Bind
'bind' clause, allowed on routine constructs.
@ Gang
'gang' clause, allowed on 'loop' and Combined constructs.
@ Wait
'wait' clause, allowed on Compute, Data, 'update', and Combined constructs.
@ DevicePtr
'deviceptr' clause, allowed on Compute and Combined Constructs, plus 'data' and 'declare'.
@ PCopyOut
'copyout' clause alias 'pcopyout'. Preserved for diagnostic purposes.
@ VectorLength
'vector_length' clause, allowed on 'parallel', 'kernels', 'parallel loop', and 'kernels loop' constru...
@ Async
'async' clause, allowed on Compute, Data, 'update', 'wait', and Combined constructs.
@ PresentOrCreate
'create' clause alias 'present_or_create'.
@ Collapse
'collapse' clause, allowed on 'loop' and Combined constructs.
@ NoHost
'nohost' clause, allowed on 'routine' directives.
@ PresentOrCopy
'copy' clause alias 'present_or_copy'. Preserved for diagnostic purposes.
@ DeviceNum
'device_num' clause, allowed on 'init', 'shutdown', and 'set' constructs.
@ Private
'private' clause, allowed on 'parallel', 'serial', 'loop', 'parallel loop', and 'serial loop' constru...
@ Invalid
Represents an invalid clause, for the purposes of parsing.
@ Vector
'vector' clause, allowed on 'loop', Combined, and 'routine' directives.
@ Copy
'copy' clause, allowed on Compute and Combined Constructs, plus 'data' and 'declare'.
@ Worker
'worker' clause, allowed on 'loop', Combined, and 'routine' directives.
@ Create
'create' clause, allowed on Compute and Combined constructs, plus 'data', 'enter data',...
@ DeviceType
'device_type' clause, allowed on Compute, 'data', 'init', 'shutdown', 'set', update',...
@ DefaultAsync
'default_async' clause, allowed on 'set' construct.
@ Attach
'attach' clause, allowed on Compute and Combined constructs, plus 'data' and 'enter data'.
@ Shortloop
'shortloop' is represented in the ACC.td file, but isn't present in the standard.
@ NumGangs
'num_gangs' clause, allowed on 'parallel', 'kernels', parallel loop', and 'kernels loop' constructs.
@ If
'if' clause, allowed on all the Compute Constructs, Data Constructs, Executable Constructs,...
@ Default
'default' clause, allowed on parallel, serial, kernel (and compound) constructs.
@ UseDevice
'use_device' clause, allowed on 'host_data' construct.
@ NoCreate
'no_create' clause, allowed on allowed on Compute and Combined constructs, plus 'data'.
@ PresentOrCopyOut
'copyout' clause alias 'present_or_copyout'.
@ Link
'link' clause, allowed on 'declare' construct.
@ Reduction
'reduction' clause, allowed on Parallel, Serial, Loop, and the combined constructs.
@ Self
'self' clause, allowed on Compute and Combined Constructs, plus 'update'.
@ CopyOut
'copyout' clause, allowed on Compute and Combined constructs, plus 'data', 'exit data',...
@ Seq
'seq' clause, allowed on 'loop' and 'routine' directives.
@ FirstPrivate
'firstprivate' clause, allowed on 'parallel', 'serial', 'parallel loop', and 'serial loop' constructs...
@ Host
'host' clause, allowed on 'update' construct.
@ PCopy
'copy' clause alias 'pcopy'. Preserved for diagnostic purposes.
@ Tile
'tile' clause, allowed on 'loop' and Combined constructs.
@ PCopyIn
'copyin' clause alias 'pcopyin'. Preserved for diagnostic purposes.
@ DeviceResident
'device_resident' clause, allowed on the 'declare' construct.
@ PCreate
'create' clause alias 'pcreate'. Preserved for diagnostic purposes.
@ Present
'present' clause, allowed on Compute and Combined constructs, plus 'data' and 'declare'.
@ DType
'dtype' clause, an alias for 'device_type', stored separately for diagnostic purposes.
@ CopyIn
'copyin' clause, allowed on Compute and Combined constructs, plus 'data', 'enter data',...
@ Device
'device' clause, allowed on the 'update' construct.
@ Independent
'independent' clause, allowed on 'loop' directives.
@ NumWorkers
'num_workers' clause, allowed on 'parallel', 'kernels', parallel loop', and 'kernels loop' constructs...
@ IfPresent
'if_present' clause, allowed on 'host_data' and 'update' directives.
@ Detach
'detach' clause, allowed on the 'exit data' construct.
@ Delete
'delete' clause, allowed on the 'exit data' construct.
@ PresentOrCopyIn
'copyin' clause alias 'present_or_copyin'.
@ Finalize
'finalize' clause, allowed on 'exit data' directive.
nullptr
This class represents a compute construct, representing a 'Kind' of ‘parallel’, 'serial',...
Expr * Cond
};
IdentifierLoc DeviceTypeArgument
static constexpr unsigned NumberOfOMPMapClauseModifiers
Number of allowed map-type-modifiers.
Definition OpenMPKinds.h:88
@ Internal
Internal linkage, which indicates that the entity can be referred to from within the translation unit...
Definition Linkage.h:35
@ Module
Module linkage, which indicates that the entity can be referred to from other translation units withi...
Definition Linkage.h:54
PredefinedDeclIDs
Predefined declaration IDs.
Definition DeclID.h:31
@ PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID
The internal '__NSConstantString' tag type.
Definition DeclID.h:78
@ PREDEF_DECL_TRANSLATION_UNIT_ID
The translation unit.
Definition DeclID.h:36
@ PREDEF_DECL_OBJC_CLASS_ID
The Objective-C 'Class' type.
Definition DeclID.h:45
@ PREDEF_DECL_BUILTIN_MS_GUID_ID
The predeclared '_GUID' struct.
Definition DeclID.h:69
@ PREDEF_DECL_BUILTIN_MS_TYPE_INFO_TAG_ID
The predeclared 'type_info' struct.
Definition DeclID.h:81
@ PREDEF_DECL_OBJC_INSTANCETYPE_ID
The internal 'instancetype' typedef.
Definition DeclID.h:57
@ PREDEF_DECL_OBJC_PROTOCOL_ID
The Objective-C 'Protocol' type.
Definition DeclID.h:48
@ PREDEF_DECL_UNSIGNED_INT_128_ID
The unsigned 128-bit integer type.
Definition DeclID.h:54
@ PREDEF_DECL_OBJC_SEL_ID
The Objective-C 'SEL' type.
Definition DeclID.h:42
@ PREDEF_DECL_INT_128_ID
The signed 128-bit integer type.
Definition DeclID.h:51
@ PREDEF_DECL_VA_LIST_TAG
The internal '__va_list_tag' struct, if any.
Definition DeclID.h:63
@ PREDEF_DECL_BUILTIN_MS_VA_LIST_ID
The internal '__builtin_ms_va_list' typedef.
Definition DeclID.h:66
@ PREDEF_DECL_CF_CONSTANT_STRING_ID
The internal '__NSConstantString' typedef.
Definition DeclID.h:75
@ PREDEF_DECL_BUILTIN_VA_LIST_ID
The internal '__builtin_va_list' typedef.
Definition DeclID.h:60
@ PREDEF_DECL_EXTERN_C_CONTEXT_ID
The extern "C" context.
Definition DeclID.h:72
@ PREDEF_DECL_OBJC_ID_ID
The Objective-C 'id' type.
Definition DeclID.h:39
@ Property
The type of a property.
Definition TypeBase.h:911
@ Result
The result type of a method or function.
Definition TypeBase.h:905
@ Type
The name was classified as a type.
Definition Sema.h:564
bool CanElideDeclDef(const Decl *D)
If we can elide the definition of.
static constexpr unsigned NumberOfOMPMotionModifiers
Number of allowed motion-modifiers.
@ PMSST_ON
Definition PragmaKinds.h:25
@ PMSST_OFF
Definition PragmaKinds.h:24
std::string getClangFullRepositoryVersion()
Retrieves the full repository version that is an amalgamation of the information in getClangRepositor...
Definition Version.cpp:68
@ TSK_ExplicitInstantiationDeclaration
This template specialization was instantiated from a template due to an explicit instantiation declar...
Definition Specifiers.h:202
U cast(CodeGen::Address addr)
Definition Address.h:327
@ None
The alignment was not explicit in code.
Definition ASTContext.h:179
@ Class
The "class" keyword introduces the elaborated-type-specifier.
Definition TypeBase.h:5967
UnsignedOrNone getPrimaryModuleHash(const Module *M)
Calculate a hash value for the primary module name of the given module.
unsigned long uint64_t
unsigned int uint32_t
Diagnostic wrappers for TextAPI types for error reporting.
Definition Dominators.h:30
__UINTPTR_TYPE__ uintptr_t
An unsigned integer type with the property that any valid pointer to void can be converted to this ty...
The signature of a module, which is a hash of the AST content.
Definition Module.h:160
static ASTFileSignature create(std::array< uint8_t, 20 > Bytes)
Definition Module.h:183
static ASTFileSignature createDummy()
Definition Module.h:193
Represents an explicit template argument list in C++, e.g., the "<int>" in "sort<int>".
SourceLocation RAngleLoc
The source location of the right angle bracket ('>').
const TemplateArgumentLoc * getTemplateArgs() const
Retrieve the template arguments.
SourceLocation LAngleLoc
The source location of the left angle bracket ('<').
unsigned NumTemplateArgs
The number of template arguments in TemplateArgs.
bool ParseAllComments
Treat ordinary comments as documentation comments.
BlockCommandNamesTy BlockCommandNames
Command names to treat as block commands in comments.
DeclarationNameInfo - A collector data type for bundling together a DeclarationName and the correspon...
SourceLocation getLoc() const
getLoc - Returns the main location of the declaration name.
DeclarationName getName() const
getName - Returns the embedded declaration name.
const DeclarationNameLoc & getInfo() const
Structure used to store a statement, the constant value to which it was evaluated (if any),...
Definition Decl.h:887
The preprocessor keeps track of this information for each file that is #included.
unsigned isModuleHeader
Whether this header is part of and built with a module.
unsigned isCompilingModuleHeader
Whether this header is part of the module that we are building, even if it doesn't build with the mod...
unsigned IsLocallyIncluded
True if this file has been included (or imported) locally.
unsigned IgnoreSysRoot
IgnoreSysRoot - This is false if an absolute path should be treated relative to the sysroot,...
FPOptions FPO
Floating-point options in the point of definition.
Definition Sema.h:15811
Decl * D
The template function declaration to be late parsed.
Definition Sema.h:15809
ObjCMethodDecl * getMethod() const
A struct with extended info about a syntactic name qualifier, to be used for the case of out-of-line ...
Definition Decl.h:753
TemplateParameterList ** TemplParamLists
A new-allocated array of size NumTemplParamLists, containing pointers to the "outer" template paramet...
Definition Decl.h:767
NestedNameSpecifierLoc QualifierLoc
Definition Decl.h:754
unsigned NumTemplParamLists
The number of "outer" template parameter lists.
Definition Decl.h:760
Location information for a TemplateArgument.
TypeSourceInfo * getAsTypeSourceInfo() const
MultiOnDiskHashTable< ASTDeclContextNameLookupTrait > Table
MultiOnDiskHashTable< LazySpecializationInfoLookupTrait > Table
MultiOnDiskHashTable< ModuleLocalNameLookupTrait > Table