1 //===- ASTWriter.cpp - AST File Writer ------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 //  This file defines the ASTWriter class, which writes AST files.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "ASTCommon.h"
14 #include "ASTReaderInternals.h"
15 #include "MultiOnDiskHashTable.h"
16 #include "clang/AST/ASTContext.h"
17 #include "clang/AST/ASTUnresolvedSet.h"
18 #include "clang/AST/AbstractTypeWriter.h"
19 #include "clang/AST/Attr.h"
20 #include "clang/AST/Decl.h"
21 #include "clang/AST/DeclBase.h"
22 #include "clang/AST/DeclCXX.h"
23 #include "clang/AST/DeclContextInternals.h"
24 #include "clang/AST/DeclFriend.h"
25 #include "clang/AST/DeclObjC.h"
26 #include "clang/AST/DeclTemplate.h"
27 #include "clang/AST/DeclarationName.h"
28 #include "clang/AST/Expr.h"
29 #include "clang/AST/ExprCXX.h"
30 #include "clang/AST/LambdaCapture.h"
31 #include "clang/AST/NestedNameSpecifier.h"
32 #include "clang/AST/OpenMPClause.h"
33 #include "clang/AST/RawCommentList.h"
34 #include "clang/AST/TemplateName.h"
35 #include "clang/AST/Type.h"
36 #include "clang/AST/TypeLocVisitor.h"
37 #include "clang/Basic/Diagnostic.h"
38 #include "clang/Basic/DiagnosticOptions.h"
39 #include "clang/Basic/FileManager.h"
40 #include "clang/Basic/FileSystemOptions.h"
41 #include "clang/Basic/IdentifierTable.h"
42 #include "clang/Basic/LLVM.h"
43 #include "clang/Basic/Lambda.h"
44 #include "clang/Basic/LangOptions.h"
45 #include "clang/Basic/Module.h"
46 #include "clang/Basic/ObjCRuntime.h"
47 #include "clang/Basic/OpenCLOptions.h"
48 #include "clang/Basic/SourceLocation.h"
49 #include "clang/Basic/SourceManager.h"
50 #include "clang/Basic/SourceManagerInternals.h"
51 #include "clang/Basic/Specifiers.h"
52 #include "clang/Basic/TargetInfo.h"
53 #include "clang/Basic/TargetOptions.h"
54 #include "clang/Basic/Version.h"
55 #include "clang/Lex/HeaderSearch.h"
56 #include "clang/Lex/HeaderSearchOptions.h"
57 #include "clang/Lex/MacroInfo.h"
58 #include "clang/Lex/ModuleMap.h"
59 #include "clang/Lex/PreprocessingRecord.h"
60 #include "clang/Lex/Preprocessor.h"
61 #include "clang/Lex/PreprocessorOptions.h"
62 #include "clang/Lex/Token.h"
63 #include "clang/Sema/IdentifierResolver.h"
64 #include "clang/Sema/ObjCMethodList.h"
65 #include "clang/Sema/Sema.h"
66 #include "clang/Sema/Weak.h"
67 #include "clang/Serialization/ASTBitCodes.h"
68 #include "clang/Serialization/ASTReader.h"
69 #include "clang/Serialization/ASTRecordWriter.h"
70 #include "clang/Serialization/InMemoryModuleCache.h"
71 #include "clang/Serialization/ModuleFile.h"
72 #include "clang/Serialization/ModuleFileExtension.h"
73 #include "clang/Serialization/SerializationDiagnostic.h"
74 #include "llvm/ADT/APFloat.h"
75 #include "llvm/ADT/APInt.h"
76 #include "llvm/ADT/APSInt.h"
77 #include "llvm/ADT/ArrayRef.h"
78 #include "llvm/ADT/DenseMap.h"
79 #include "llvm/ADT/Hashing.h"
80 #include "llvm/ADT/Optional.h"
81 #include "llvm/ADT/PointerIntPair.h"
82 #include "llvm/ADT/STLExtras.h"
83 #include "llvm/ADT/ScopeExit.h"
84 #include "llvm/ADT/SmallPtrSet.h"
85 #include "llvm/ADT/SmallString.h"
86 #include "llvm/ADT/SmallVector.h"
87 #include "llvm/ADT/StringMap.h"
88 #include "llvm/ADT/StringRef.h"
89 #include "llvm/Bitstream/BitCodes.h"
90 #include "llvm/Bitstream/BitstreamWriter.h"
91 #include "llvm/Support/Casting.h"
92 #include "llvm/Support/Compression.h"
93 #include "llvm/Support/DJB.h"
94 #include "llvm/Support/Endian.h"
95 #include "llvm/Support/EndianStream.h"
96 #include "llvm/Support/Error.h"
97 #include "llvm/Support/ErrorHandling.h"
98 #include "llvm/Support/MemoryBuffer.h"
99 #include "llvm/Support/OnDiskHashTable.h"
100 #include "llvm/Support/Path.h"
101 #include "llvm/Support/SHA1.h"
102 #include "llvm/Support/VersionTuple.h"
103 #include "llvm/Support/raw_ostream.h"
104 #include <algorithm>
105 #include <cassert>
106 #include <cstdint>
107 #include <cstdlib>
108 #include <cstring>
109 #include <ctime>
110 #include <deque>
111 #include <limits>
112 #include <memory>
113 #include <queue>
114 #include <tuple>
115 #include <utility>
116 #include <vector>
117 
118 using namespace clang;
119 using namespace clang::serialization;
120 
121 template <typename T, typename Allocator>
122 static StringRef bytes(const std::vector<T, Allocator> &v) {
123   if (v.empty()) return StringRef();
124   return StringRef(reinterpret_cast<const char*>(&v[0]),
125                          sizeof(T) * v.size());
126 }
127 
128 template <typename T>
129 static StringRef bytes(const SmallVectorImpl<T> &v) {
130   return StringRef(reinterpret_cast<const char*>(v.data()),
131                          sizeof(T) * v.size());
132 }
133 
134 //===----------------------------------------------------------------------===//
135 // Type serialization
136 //===----------------------------------------------------------------------===//
137 
138 static TypeCode getTypeCodeForTypeClass(Type::TypeClass id) {
139   switch (id) {
140 #define TYPE_BIT_CODE(CLASS_ID, CODE_ID, CODE_VALUE) \
141   case Type::CLASS_ID: return TYPE_##CODE_ID;
142 #include "clang/Serialization/TypeBitCodes.def"
143   case Type::Builtin:
144     llvm_unreachable("shouldn't be serializing a builtin type this way");
145   }
146   llvm_unreachable("bad type kind");
147 }
148 
149 namespace {
150 
151 class ASTTypeWriter {
152   ASTWriter &Writer;
153   ASTWriter::RecordData Record;
154   ASTRecordWriter BasicWriter;
155 
156 public:
157   ASTTypeWriter(ASTWriter &Writer)
158     : Writer(Writer), BasicWriter(Writer, Record) {}
159 
160   uint64_t write(QualType T) {
161     if (T.hasLocalNonFastQualifiers()) {
162       Qualifiers Qs = T.getLocalQualifiers();
163       BasicWriter.writeQualType(T.getLocalUnqualifiedType());
164       BasicWriter.writeQualifiers(Qs);
165       return BasicWriter.Emit(TYPE_EXT_QUAL, Writer.getTypeExtQualAbbrev());
166     }
167 
168     const Type *typePtr = T.getTypePtr();
169     serialization::AbstractTypeWriter<ASTRecordWriter> atw(BasicWriter);
170     atw.write(typePtr);
171     return BasicWriter.Emit(getTypeCodeForTypeClass(typePtr->getTypeClass()),
172                             /*abbrev*/ 0);
173   }
174 };
175 
176 class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> {
177   ASTRecordWriter &Record;
178 
179 public:
180   TypeLocWriter(ASTRecordWriter &Record) : Record(Record) {}
181 
182 #define ABSTRACT_TYPELOC(CLASS, PARENT)
183 #define TYPELOC(CLASS, PARENT) \
184     void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
185 #include "clang/AST/TypeLocNodes.def"
186 
187   void VisitArrayTypeLoc(ArrayTypeLoc TyLoc);
188   void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc);
189 };
190 
191 } // namespace
192 
193 void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
194   // nothing to do
195 }
196 
197 void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
198   Record.AddSourceLocation(TL.getBuiltinLoc());
199   if (TL.needsExtraLocalData()) {
200     Record.push_back(TL.getWrittenTypeSpec());
201     Record.push_back(TL.getWrittenSignSpec());
202     Record.push_back(TL.getWrittenWidthSpec());
203     Record.push_back(TL.hasModeAttr());
204   }
205 }
206 
207 void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
208   Record.AddSourceLocation(TL.getNameLoc());
209 }
210 
211 void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) {
212   Record.AddSourceLocation(TL.getStarLoc());
213 }
214 
215 void TypeLocWriter::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
216   // nothing to do
217 }
218 
219 void TypeLocWriter::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
220   // nothing to do
221 }
222 
223 void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
224   Record.AddSourceLocation(TL.getCaretLoc());
225 }
226 
227 void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
228   Record.AddSourceLocation(TL.getAmpLoc());
229 }
230 
231 void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
232   Record.AddSourceLocation(TL.getAmpAmpLoc());
233 }
234 
235 void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
236   Record.AddSourceLocation(TL.getStarLoc());
237   Record.AddTypeSourceInfo(TL.getClassTInfo());
238 }
239 
240 void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) {
241   Record.AddSourceLocation(TL.getLBracketLoc());
242   Record.AddSourceLocation(TL.getRBracketLoc());
243   Record.push_back(TL.getSizeExpr() ? 1 : 0);
244   if (TL.getSizeExpr())
245     Record.AddStmt(TL.getSizeExpr());
246 }
247 
248 void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
249   VisitArrayTypeLoc(TL);
250 }
251 
252 void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
253   VisitArrayTypeLoc(TL);
254 }
255 
256 void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
257   VisitArrayTypeLoc(TL);
258 }
259 
260 void TypeLocWriter::VisitDependentSizedArrayTypeLoc(
261                                             DependentSizedArrayTypeLoc TL) {
262   VisitArrayTypeLoc(TL);
263 }
264 
265 void TypeLocWriter::VisitDependentAddressSpaceTypeLoc(
266     DependentAddressSpaceTypeLoc TL) {
267   Record.AddSourceLocation(TL.getAttrNameLoc());
268   SourceRange range = TL.getAttrOperandParensRange();
269   Record.AddSourceLocation(range.getBegin());
270   Record.AddSourceLocation(range.getEnd());
271   Record.AddStmt(TL.getAttrExprOperand());
272 }
273 
274 void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc(
275                                         DependentSizedExtVectorTypeLoc TL) {
276   Record.AddSourceLocation(TL.getNameLoc());
277 }
278 
279 void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) {
280   Record.AddSourceLocation(TL.getNameLoc());
281 }
282 
283 void TypeLocWriter::VisitDependentVectorTypeLoc(
284     DependentVectorTypeLoc TL) {
285   Record.AddSourceLocation(TL.getNameLoc());
286 }
287 
288 void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
289   Record.AddSourceLocation(TL.getNameLoc());
290 }
291 
292 void TypeLocWriter::VisitConstantMatrixTypeLoc(ConstantMatrixTypeLoc TL) {
293   Record.AddSourceLocation(TL.getAttrNameLoc());
294   SourceRange range = TL.getAttrOperandParensRange();
295   Record.AddSourceLocation(range.getBegin());
296   Record.AddSourceLocation(range.getEnd());
297   Record.AddStmt(TL.getAttrRowOperand());
298   Record.AddStmt(TL.getAttrColumnOperand());
299 }
300 
301 void TypeLocWriter::VisitDependentSizedMatrixTypeLoc(
302     DependentSizedMatrixTypeLoc TL) {
303   Record.AddSourceLocation(TL.getAttrNameLoc());
304   SourceRange range = TL.getAttrOperandParensRange();
305   Record.AddSourceLocation(range.getBegin());
306   Record.AddSourceLocation(range.getEnd());
307   Record.AddStmt(TL.getAttrRowOperand());
308   Record.AddStmt(TL.getAttrColumnOperand());
309 }
310 
311 void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
312   Record.AddSourceLocation(TL.getLocalRangeBegin());
313   Record.AddSourceLocation(TL.getLParenLoc());
314   Record.AddSourceLocation(TL.getRParenLoc());
315   Record.AddSourceRange(TL.getExceptionSpecRange());
316   Record.AddSourceLocation(TL.getLocalRangeEnd());
317   for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i)
318     Record.AddDeclRef(TL.getParam(i));
319 }
320 
321 void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
322   VisitFunctionTypeLoc(TL);
323 }
324 
325 void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
326   VisitFunctionTypeLoc(TL);
327 }
328 
329 void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
330   Record.AddSourceLocation(TL.getNameLoc());
331 }
332 
333 void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
334   Record.AddSourceLocation(TL.getNameLoc());
335 }
336 
337 void TypeLocWriter::VisitObjCTypeParamTypeLoc(ObjCTypeParamTypeLoc TL) {
338   if (TL.getNumProtocols()) {
339     Record.AddSourceLocation(TL.getProtocolLAngleLoc());
340     Record.AddSourceLocation(TL.getProtocolRAngleLoc());
341   }
342   for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
343     Record.AddSourceLocation(TL.getProtocolLoc(i));
344 }
345 
346 void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
347   Record.AddSourceLocation(TL.getTypeofLoc());
348   Record.AddSourceLocation(TL.getLParenLoc());
349   Record.AddSourceLocation(TL.getRParenLoc());
350 }
351 
352 void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
353   Record.AddSourceLocation(TL.getTypeofLoc());
354   Record.AddSourceLocation(TL.getLParenLoc());
355   Record.AddSourceLocation(TL.getRParenLoc());
356   Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
357 }
358 
359 void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
360   Record.AddSourceLocation(TL.getNameLoc());
361 }
362 
363 void TypeLocWriter::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
364   Record.AddSourceLocation(TL.getKWLoc());
365   Record.AddSourceLocation(TL.getLParenLoc());
366   Record.AddSourceLocation(TL.getRParenLoc());
367   Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
368 }
369 
370 void TypeLocWriter::VisitAutoTypeLoc(AutoTypeLoc TL) {
371   Record.AddSourceLocation(TL.getNameLoc());
372   Record.push_back(TL.isConstrained());
373   if (TL.isConstrained()) {
374     Record.AddNestedNameSpecifierLoc(TL.getNestedNameSpecifierLoc());
375     Record.AddSourceLocation(TL.getTemplateKWLoc());
376     Record.AddSourceLocation(TL.getConceptNameLoc());
377     Record.AddDeclRef(TL.getFoundDecl());
378     Record.AddSourceLocation(TL.getLAngleLoc());
379     Record.AddSourceLocation(TL.getRAngleLoc());
380     for (unsigned I = 0; I < TL.getNumArgs(); ++I)
381       Record.AddTemplateArgumentLocInfo(TL.getTypePtr()->getArg(I).getKind(),
382                                         TL.getArgLocInfo(I));
383   }
384 }
385 
386 void TypeLocWriter::VisitDeducedTemplateSpecializationTypeLoc(
387     DeducedTemplateSpecializationTypeLoc TL) {
388   Record.AddSourceLocation(TL.getTemplateNameLoc());
389 }
390 
391 void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) {
392   Record.AddSourceLocation(TL.getNameLoc());
393 }
394 
395 void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) {
396   Record.AddSourceLocation(TL.getNameLoc());
397 }
398 
399 void TypeLocWriter::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
400   Record.AddAttr(TL.getAttr());
401 }
402 
403 void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
404   Record.AddSourceLocation(TL.getNameLoc());
405 }
406 
407 void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
408                                             SubstTemplateTypeParmTypeLoc TL) {
409   Record.AddSourceLocation(TL.getNameLoc());
410 }
411 
412 void TypeLocWriter::VisitSubstTemplateTypeParmPackTypeLoc(
413                                           SubstTemplateTypeParmPackTypeLoc TL) {
414   Record.AddSourceLocation(TL.getNameLoc());
415 }
416 
417 void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
418                                            TemplateSpecializationTypeLoc TL) {
419   Record.AddSourceLocation(TL.getTemplateKeywordLoc());
420   Record.AddSourceLocation(TL.getTemplateNameLoc());
421   Record.AddSourceLocation(TL.getLAngleLoc());
422   Record.AddSourceLocation(TL.getRAngleLoc());
423   for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
424     Record.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(),
425                                       TL.getArgLoc(i).getLocInfo());
426 }
427 
428 void TypeLocWriter::VisitParenTypeLoc(ParenTypeLoc TL) {
429   Record.AddSourceLocation(TL.getLParenLoc());
430   Record.AddSourceLocation(TL.getRParenLoc());
431 }
432 
433 void TypeLocWriter::VisitMacroQualifiedTypeLoc(MacroQualifiedTypeLoc TL) {
434   Record.AddSourceLocation(TL.getExpansionLoc());
435 }
436 
437 void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
438   Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
439   Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
440 }
441 
442 void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
443   Record.AddSourceLocation(TL.getNameLoc());
444 }
445 
446 void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
447   Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
448   Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
449   Record.AddSourceLocation(TL.getNameLoc());
450 }
451 
452 void TypeLocWriter::VisitDependentTemplateSpecializationTypeLoc(
453        DependentTemplateSpecializationTypeLoc TL) {
454   Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
455   Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
456   Record.AddSourceLocation(TL.getTemplateKeywordLoc());
457   Record.AddSourceLocation(TL.getTemplateNameLoc());
458   Record.AddSourceLocation(TL.getLAngleLoc());
459   Record.AddSourceLocation(TL.getRAngleLoc());
460   for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
461     Record.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(),
462                                       TL.getArgLoc(I).getLocInfo());
463 }
464 
465 void TypeLocWriter::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
466   Record.AddSourceLocation(TL.getEllipsisLoc());
467 }
468 
469 void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
470   Record.AddSourceLocation(TL.getNameLoc());
471 }
472 
473 void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
474   Record.push_back(TL.hasBaseTypeAsWritten());
475   Record.AddSourceLocation(TL.getTypeArgsLAngleLoc());
476   Record.AddSourceLocation(TL.getTypeArgsRAngleLoc());
477   for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
478     Record.AddTypeSourceInfo(TL.getTypeArgTInfo(i));
479   Record.AddSourceLocation(TL.getProtocolLAngleLoc());
480   Record.AddSourceLocation(TL.getProtocolRAngleLoc());
481   for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
482     Record.AddSourceLocation(TL.getProtocolLoc(i));
483 }
484 
485 void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
486   Record.AddSourceLocation(TL.getStarLoc());
487 }
488 
489 void TypeLocWriter::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
490   Record.AddSourceLocation(TL.getKWLoc());
491   Record.AddSourceLocation(TL.getLParenLoc());
492   Record.AddSourceLocation(TL.getRParenLoc());
493 }
494 
495 void TypeLocWriter::VisitPipeTypeLoc(PipeTypeLoc TL) {
496   Record.AddSourceLocation(TL.getKWLoc());
497 }
498 
499 void TypeLocWriter::VisitExtIntTypeLoc(clang::ExtIntTypeLoc TL) {
500   Record.AddSourceLocation(TL.getNameLoc());
501 }
502 void TypeLocWriter::VisitDependentExtIntTypeLoc(
503     clang::DependentExtIntTypeLoc TL) {
504   Record.AddSourceLocation(TL.getNameLoc());
505 }
506 
507 void ASTWriter::WriteTypeAbbrevs() {
508   using namespace llvm;
509 
510   std::shared_ptr<BitCodeAbbrev> Abv;
511 
512   // Abbreviation for TYPE_EXT_QUAL
513   Abv = std::make_shared<BitCodeAbbrev>();
514   Abv->Add(BitCodeAbbrevOp(serialization::TYPE_EXT_QUAL));
515   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // Type
516   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 3));   // Quals
517   TypeExtQualAbbrev = Stream.EmitAbbrev(std::move(Abv));
518 
519   // Abbreviation for TYPE_FUNCTION_PROTO
520   Abv = std::make_shared<BitCodeAbbrev>();
521   Abv->Add(BitCodeAbbrevOp(serialization::TYPE_FUNCTION_PROTO));
522   // FunctionType
523   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // ReturnType
524   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // NoReturn
525   Abv->Add(BitCodeAbbrevOp(0));                         // HasRegParm
526   Abv->Add(BitCodeAbbrevOp(0));                         // RegParm
527   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // CC
528   Abv->Add(BitCodeAbbrevOp(0));                         // ProducesResult
529   Abv->Add(BitCodeAbbrevOp(0));                         // NoCallerSavedRegs
530   Abv->Add(BitCodeAbbrevOp(0));                         // NoCfCheck
531   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // CmseNSCall
532   // FunctionProtoType
533   Abv->Add(BitCodeAbbrevOp(0));                         // IsVariadic
534   Abv->Add(BitCodeAbbrevOp(0));                         // HasTrailingReturn
535   Abv->Add(BitCodeAbbrevOp(0));                         // TypeQuals
536   Abv->Add(BitCodeAbbrevOp(0));                         // RefQualifier
537   Abv->Add(BitCodeAbbrevOp(EST_None));                  // ExceptionSpec
538   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // NumParams
539   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
540   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // Params
541   TypeFunctionProtoAbbrev = Stream.EmitAbbrev(std::move(Abv));
542 }
543 
544 //===----------------------------------------------------------------------===//
545 // ASTWriter Implementation
546 //===----------------------------------------------------------------------===//
547 
548 static void EmitBlockID(unsigned ID, const char *Name,
549                         llvm::BitstreamWriter &Stream,
550                         ASTWriter::RecordDataImpl &Record) {
551   Record.clear();
552   Record.push_back(ID);
553   Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
554 
555   // Emit the block name if present.
556   if (!Name || Name[0] == 0)
557     return;
558   Record.clear();
559   while (*Name)
560     Record.push_back(*Name++);
561   Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record);
562 }
563 
564 static void EmitRecordID(unsigned ID, const char *Name,
565                          llvm::BitstreamWriter &Stream,
566                          ASTWriter::RecordDataImpl &Record) {
567   Record.clear();
568   Record.push_back(ID);
569   while (*Name)
570     Record.push_back(*Name++);
571   Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
572 }
573 
574 static void AddStmtsExprs(llvm::BitstreamWriter &Stream,
575                           ASTWriter::RecordDataImpl &Record) {
576 #define RECORD(X) EmitRecordID(X, #X, Stream, Record)
577   RECORD(STMT_STOP);
578   RECORD(STMT_NULL_PTR);
579   RECORD(STMT_REF_PTR);
580   RECORD(STMT_NULL);
581   RECORD(STMT_COMPOUND);
582   RECORD(STMT_CASE);
583   RECORD(STMT_DEFAULT);
584   RECORD(STMT_LABEL);
585   RECORD(STMT_ATTRIBUTED);
586   RECORD(STMT_IF);
587   RECORD(STMT_SWITCH);
588   RECORD(STMT_WHILE);
589   RECORD(STMT_DO);
590   RECORD(STMT_FOR);
591   RECORD(STMT_GOTO);
592   RECORD(STMT_INDIRECT_GOTO);
593   RECORD(STMT_CONTINUE);
594   RECORD(STMT_BREAK);
595   RECORD(STMT_RETURN);
596   RECORD(STMT_DECL);
597   RECORD(STMT_GCCASM);
598   RECORD(STMT_MSASM);
599   RECORD(EXPR_PREDEFINED);
600   RECORD(EXPR_DECL_REF);
601   RECORD(EXPR_INTEGER_LITERAL);
602   RECORD(EXPR_FIXEDPOINT_LITERAL);
603   RECORD(EXPR_FLOATING_LITERAL);
604   RECORD(EXPR_IMAGINARY_LITERAL);
605   RECORD(EXPR_STRING_LITERAL);
606   RECORD(EXPR_CHARACTER_LITERAL);
607   RECORD(EXPR_PAREN);
608   RECORD(EXPR_PAREN_LIST);
609   RECORD(EXPR_UNARY_OPERATOR);
610   RECORD(EXPR_SIZEOF_ALIGN_OF);
611   RECORD(EXPR_ARRAY_SUBSCRIPT);
612   RECORD(EXPR_CALL);
613   RECORD(EXPR_MEMBER);
614   RECORD(EXPR_BINARY_OPERATOR);
615   RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR);
616   RECORD(EXPR_CONDITIONAL_OPERATOR);
617   RECORD(EXPR_IMPLICIT_CAST);
618   RECORD(EXPR_CSTYLE_CAST);
619   RECORD(EXPR_COMPOUND_LITERAL);
620   RECORD(EXPR_EXT_VECTOR_ELEMENT);
621   RECORD(EXPR_INIT_LIST);
622   RECORD(EXPR_DESIGNATED_INIT);
623   RECORD(EXPR_DESIGNATED_INIT_UPDATE);
624   RECORD(EXPR_IMPLICIT_VALUE_INIT);
625   RECORD(EXPR_NO_INIT);
626   RECORD(EXPR_VA_ARG);
627   RECORD(EXPR_ADDR_LABEL);
628   RECORD(EXPR_STMT);
629   RECORD(EXPR_CHOOSE);
630   RECORD(EXPR_GNU_NULL);
631   RECORD(EXPR_SHUFFLE_VECTOR);
632   RECORD(EXPR_BLOCK);
633   RECORD(EXPR_GENERIC_SELECTION);
634   RECORD(EXPR_OBJC_STRING_LITERAL);
635   RECORD(EXPR_OBJC_BOXED_EXPRESSION);
636   RECORD(EXPR_OBJC_ARRAY_LITERAL);
637   RECORD(EXPR_OBJC_DICTIONARY_LITERAL);
638   RECORD(EXPR_OBJC_ENCODE);
639   RECORD(EXPR_OBJC_SELECTOR_EXPR);
640   RECORD(EXPR_OBJC_PROTOCOL_EXPR);
641   RECORD(EXPR_OBJC_IVAR_REF_EXPR);
642   RECORD(EXPR_OBJC_PROPERTY_REF_EXPR);
643   RECORD(EXPR_OBJC_KVC_REF_EXPR);
644   RECORD(EXPR_OBJC_MESSAGE_EXPR);
645   RECORD(STMT_OBJC_FOR_COLLECTION);
646   RECORD(STMT_OBJC_CATCH);
647   RECORD(STMT_OBJC_FINALLY);
648   RECORD(STMT_OBJC_AT_TRY);
649   RECORD(STMT_OBJC_AT_SYNCHRONIZED);
650   RECORD(STMT_OBJC_AT_THROW);
651   RECORD(EXPR_OBJC_BOOL_LITERAL);
652   RECORD(STMT_CXX_CATCH);
653   RECORD(STMT_CXX_TRY);
654   RECORD(STMT_CXX_FOR_RANGE);
655   RECORD(EXPR_CXX_OPERATOR_CALL);
656   RECORD(EXPR_CXX_MEMBER_CALL);
657   RECORD(EXPR_CXX_REWRITTEN_BINARY_OPERATOR);
658   RECORD(EXPR_CXX_CONSTRUCT);
659   RECORD(EXPR_CXX_TEMPORARY_OBJECT);
660   RECORD(EXPR_CXX_STATIC_CAST);
661   RECORD(EXPR_CXX_DYNAMIC_CAST);
662   RECORD(EXPR_CXX_REINTERPRET_CAST);
663   RECORD(EXPR_CXX_CONST_CAST);
664   RECORD(EXPR_CXX_ADDRSPACE_CAST);
665   RECORD(EXPR_CXX_FUNCTIONAL_CAST);
666   RECORD(EXPR_USER_DEFINED_LITERAL);
667   RECORD(EXPR_CXX_STD_INITIALIZER_LIST);
668   RECORD(EXPR_CXX_BOOL_LITERAL);
669   RECORD(EXPR_CXX_NULL_PTR_LITERAL);
670   RECORD(EXPR_CXX_TYPEID_EXPR);
671   RECORD(EXPR_CXX_TYPEID_TYPE);
672   RECORD(EXPR_CXX_THIS);
673   RECORD(EXPR_CXX_THROW);
674   RECORD(EXPR_CXX_DEFAULT_ARG);
675   RECORD(EXPR_CXX_DEFAULT_INIT);
676   RECORD(EXPR_CXX_BIND_TEMPORARY);
677   RECORD(EXPR_CXX_SCALAR_VALUE_INIT);
678   RECORD(EXPR_CXX_NEW);
679   RECORD(EXPR_CXX_DELETE);
680   RECORD(EXPR_CXX_PSEUDO_DESTRUCTOR);
681   RECORD(EXPR_EXPR_WITH_CLEANUPS);
682   RECORD(EXPR_CXX_DEPENDENT_SCOPE_MEMBER);
683   RECORD(EXPR_CXX_DEPENDENT_SCOPE_DECL_REF);
684   RECORD(EXPR_CXX_UNRESOLVED_CONSTRUCT);
685   RECORD(EXPR_CXX_UNRESOLVED_MEMBER);
686   RECORD(EXPR_CXX_UNRESOLVED_LOOKUP);
687   RECORD(EXPR_CXX_EXPRESSION_TRAIT);
688   RECORD(EXPR_CXX_NOEXCEPT);
689   RECORD(EXPR_OPAQUE_VALUE);
690   RECORD(EXPR_BINARY_CONDITIONAL_OPERATOR);
691   RECORD(EXPR_TYPE_TRAIT);
692   RECORD(EXPR_ARRAY_TYPE_TRAIT);
693   RECORD(EXPR_PACK_EXPANSION);
694   RECORD(EXPR_SIZEOF_PACK);
695   RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM);
696   RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK);
697   RECORD(EXPR_FUNCTION_PARM_PACK);
698   RECORD(EXPR_MATERIALIZE_TEMPORARY);
699   RECORD(EXPR_CUDA_KERNEL_CALL);
700   RECORD(EXPR_CXX_UUIDOF_EXPR);
701   RECORD(EXPR_CXX_UUIDOF_TYPE);
702   RECORD(EXPR_LAMBDA);
703 #undef RECORD
704 }
705 
706 void ASTWriter::WriteBlockInfoBlock() {
707   RecordData Record;
708   Stream.EnterBlockInfoBlock();
709 
710 #define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record)
711 #define RECORD(X) EmitRecordID(X, #X, Stream, Record)
712 
713   // Control Block.
714   BLOCK(CONTROL_BLOCK);
715   RECORD(METADATA);
716   RECORD(MODULE_NAME);
717   RECORD(MODULE_DIRECTORY);
718   RECORD(MODULE_MAP_FILE);
719   RECORD(IMPORTS);
720   RECORD(ORIGINAL_FILE);
721   RECORD(ORIGINAL_PCH_DIR);
722   RECORD(ORIGINAL_FILE_ID);
723   RECORD(INPUT_FILE_OFFSETS);
724 
725   BLOCK(OPTIONS_BLOCK);
726   RECORD(LANGUAGE_OPTIONS);
727   RECORD(TARGET_OPTIONS);
728   RECORD(FILE_SYSTEM_OPTIONS);
729   RECORD(HEADER_SEARCH_OPTIONS);
730   RECORD(PREPROCESSOR_OPTIONS);
731 
732   BLOCK(INPUT_FILES_BLOCK);
733   RECORD(INPUT_FILE);
734   RECORD(INPUT_FILE_HASH);
735 
736   // AST Top-Level Block.
737   BLOCK(AST_BLOCK);
738   RECORD(TYPE_OFFSET);
739   RECORD(DECL_OFFSET);
740   RECORD(IDENTIFIER_OFFSET);
741   RECORD(IDENTIFIER_TABLE);
742   RECORD(EAGERLY_DESERIALIZED_DECLS);
743   RECORD(MODULAR_CODEGEN_DECLS);
744   RECORD(SPECIAL_TYPES);
745   RECORD(STATISTICS);
746   RECORD(TENTATIVE_DEFINITIONS);
747   RECORD(SELECTOR_OFFSETS);
748   RECORD(METHOD_POOL);
749   RECORD(PP_COUNTER_VALUE);
750   RECORD(SOURCE_LOCATION_OFFSETS);
751   RECORD(SOURCE_LOCATION_PRELOADS);
752   RECORD(EXT_VECTOR_DECLS);
753   RECORD(UNUSED_FILESCOPED_DECLS);
754   RECORD(PPD_ENTITIES_OFFSETS);
755   RECORD(VTABLE_USES);
756   RECORD(PPD_SKIPPED_RANGES);
757   RECORD(REFERENCED_SELECTOR_POOL);
758   RECORD(TU_UPDATE_LEXICAL);
759   RECORD(SEMA_DECL_REFS);
760   RECORD(WEAK_UNDECLARED_IDENTIFIERS);
761   RECORD(PENDING_IMPLICIT_INSTANTIATIONS);
762   RECORD(UPDATE_VISIBLE);
763   RECORD(DECL_UPDATE_OFFSETS);
764   RECORD(DECL_UPDATES);
765   RECORD(CUDA_SPECIAL_DECL_REFS);
766   RECORD(HEADER_SEARCH_TABLE);
767   RECORD(FP_PRAGMA_OPTIONS);
768   RECORD(OPENCL_EXTENSIONS);
769   RECORD(OPENCL_EXTENSION_TYPES);
770   RECORD(OPENCL_EXTENSION_DECLS);
771   RECORD(DELEGATING_CTORS);
772   RECORD(KNOWN_NAMESPACES);
773   RECORD(MODULE_OFFSET_MAP);
774   RECORD(SOURCE_MANAGER_LINE_TABLE);
775   RECORD(OBJC_CATEGORIES_MAP);
776   RECORD(FILE_SORTED_DECLS);
777   RECORD(IMPORTED_MODULES);
778   RECORD(OBJC_CATEGORIES);
779   RECORD(MACRO_OFFSET);
780   RECORD(INTERESTING_IDENTIFIERS);
781   RECORD(UNDEFINED_BUT_USED);
782   RECORD(LATE_PARSED_TEMPLATE);
783   RECORD(OPTIMIZE_PRAGMA_OPTIONS);
784   RECORD(MSSTRUCT_PRAGMA_OPTIONS);
785   RECORD(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS);
786   RECORD(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES);
787   RECORD(DELETE_EXPRS_TO_ANALYZE);
788   RECORD(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH);
789   RECORD(PP_CONDITIONAL_STACK);
790   RECORD(DECLS_TO_CHECK_FOR_DEFERRED_DIAGS);
791 
792   // SourceManager Block.
793   BLOCK(SOURCE_MANAGER_BLOCK);
794   RECORD(SM_SLOC_FILE_ENTRY);
795   RECORD(SM_SLOC_BUFFER_ENTRY);
796   RECORD(SM_SLOC_BUFFER_BLOB);
797   RECORD(SM_SLOC_BUFFER_BLOB_COMPRESSED);
798   RECORD(SM_SLOC_EXPANSION_ENTRY);
799 
800   // Preprocessor Block.
801   BLOCK(PREPROCESSOR_BLOCK);
802   RECORD(PP_MACRO_DIRECTIVE_HISTORY);
803   RECORD(PP_MACRO_FUNCTION_LIKE);
804   RECORD(PP_MACRO_OBJECT_LIKE);
805   RECORD(PP_MODULE_MACRO);
806   RECORD(PP_TOKEN);
807 
808   // Submodule Block.
809   BLOCK(SUBMODULE_BLOCK);
810   RECORD(SUBMODULE_METADATA);
811   RECORD(SUBMODULE_DEFINITION);
812   RECORD(SUBMODULE_UMBRELLA_HEADER);
813   RECORD(SUBMODULE_HEADER);
814   RECORD(SUBMODULE_TOPHEADER);
815   RECORD(SUBMODULE_UMBRELLA_DIR);
816   RECORD(SUBMODULE_IMPORTS);
817   RECORD(SUBMODULE_EXPORTS);
818   RECORD(SUBMODULE_REQUIRES);
819   RECORD(SUBMODULE_EXCLUDED_HEADER);
820   RECORD(SUBMODULE_LINK_LIBRARY);
821   RECORD(SUBMODULE_CONFIG_MACRO);
822   RECORD(SUBMODULE_CONFLICT);
823   RECORD(SUBMODULE_PRIVATE_HEADER);
824   RECORD(SUBMODULE_TEXTUAL_HEADER);
825   RECORD(SUBMODULE_PRIVATE_TEXTUAL_HEADER);
826   RECORD(SUBMODULE_INITIALIZERS);
827   RECORD(SUBMODULE_EXPORT_AS);
828 
829   // Comments Block.
830   BLOCK(COMMENTS_BLOCK);
831   RECORD(COMMENTS_RAW_COMMENT);
832 
833   // Decls and Types block.
834   BLOCK(DECLTYPES_BLOCK);
835   RECORD(TYPE_EXT_QUAL);
836   RECORD(TYPE_COMPLEX);
837   RECORD(TYPE_POINTER);
838   RECORD(TYPE_BLOCK_POINTER);
839   RECORD(TYPE_LVALUE_REFERENCE);
840   RECORD(TYPE_RVALUE_REFERENCE);
841   RECORD(TYPE_MEMBER_POINTER);
842   RECORD(TYPE_CONSTANT_ARRAY);
843   RECORD(TYPE_INCOMPLETE_ARRAY);
844   RECORD(TYPE_VARIABLE_ARRAY);
845   RECORD(TYPE_VECTOR);
846   RECORD(TYPE_EXT_VECTOR);
847   RECORD(TYPE_FUNCTION_NO_PROTO);
848   RECORD(TYPE_FUNCTION_PROTO);
849   RECORD(TYPE_TYPEDEF);
850   RECORD(TYPE_TYPEOF_EXPR);
851   RECORD(TYPE_TYPEOF);
852   RECORD(TYPE_RECORD);
853   RECORD(TYPE_ENUM);
854   RECORD(TYPE_OBJC_INTERFACE);
855   RECORD(TYPE_OBJC_OBJECT_POINTER);
856   RECORD(TYPE_DECLTYPE);
857   RECORD(TYPE_ELABORATED);
858   RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
859   RECORD(TYPE_UNRESOLVED_USING);
860   RECORD(TYPE_INJECTED_CLASS_NAME);
861   RECORD(TYPE_OBJC_OBJECT);
862   RECORD(TYPE_TEMPLATE_TYPE_PARM);
863   RECORD(TYPE_TEMPLATE_SPECIALIZATION);
864   RECORD(TYPE_DEPENDENT_NAME);
865   RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION);
866   RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
867   RECORD(TYPE_PAREN);
868   RECORD(TYPE_MACRO_QUALIFIED);
869   RECORD(TYPE_PACK_EXPANSION);
870   RECORD(TYPE_ATTRIBUTED);
871   RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
872   RECORD(TYPE_AUTO);
873   RECORD(TYPE_UNARY_TRANSFORM);
874   RECORD(TYPE_ATOMIC);
875   RECORD(TYPE_DECAYED);
876   RECORD(TYPE_ADJUSTED);
877   RECORD(TYPE_OBJC_TYPE_PARAM);
878   RECORD(LOCAL_REDECLARATIONS);
879   RECORD(DECL_TYPEDEF);
880   RECORD(DECL_TYPEALIAS);
881   RECORD(DECL_ENUM);
882   RECORD(DECL_RECORD);
883   RECORD(DECL_ENUM_CONSTANT);
884   RECORD(DECL_FUNCTION);
885   RECORD(DECL_OBJC_METHOD);
886   RECORD(DECL_OBJC_INTERFACE);
887   RECORD(DECL_OBJC_PROTOCOL);
888   RECORD(DECL_OBJC_IVAR);
889   RECORD(DECL_OBJC_AT_DEFS_FIELD);
890   RECORD(DECL_OBJC_CATEGORY);
891   RECORD(DECL_OBJC_CATEGORY_IMPL);
892   RECORD(DECL_OBJC_IMPLEMENTATION);
893   RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
894   RECORD(DECL_OBJC_PROPERTY);
895   RECORD(DECL_OBJC_PROPERTY_IMPL);
896   RECORD(DECL_FIELD);
897   RECORD(DECL_MS_PROPERTY);
898   RECORD(DECL_VAR);
899   RECORD(DECL_IMPLICIT_PARAM);
900   RECORD(DECL_PARM_VAR);
901   RECORD(DECL_FILE_SCOPE_ASM);
902   RECORD(DECL_BLOCK);
903   RECORD(DECL_CONTEXT_LEXICAL);
904   RECORD(DECL_CONTEXT_VISIBLE);
905   RECORD(DECL_NAMESPACE);
906   RECORD(DECL_NAMESPACE_ALIAS);
907   RECORD(DECL_USING);
908   RECORD(DECL_USING_SHADOW);
909   RECORD(DECL_USING_DIRECTIVE);
910   RECORD(DECL_UNRESOLVED_USING_VALUE);
911   RECORD(DECL_UNRESOLVED_USING_TYPENAME);
912   RECORD(DECL_LINKAGE_SPEC);
913   RECORD(DECL_CXX_RECORD);
914   RECORD(DECL_CXX_METHOD);
915   RECORD(DECL_CXX_CONSTRUCTOR);
916   RECORD(DECL_CXX_DESTRUCTOR);
917   RECORD(DECL_CXX_CONVERSION);
918   RECORD(DECL_ACCESS_SPEC);
919   RECORD(DECL_FRIEND);
920   RECORD(DECL_FRIEND_TEMPLATE);
921   RECORD(DECL_CLASS_TEMPLATE);
922   RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
923   RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
924   RECORD(DECL_VAR_TEMPLATE);
925   RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION);
926   RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION);
927   RECORD(DECL_FUNCTION_TEMPLATE);
928   RECORD(DECL_TEMPLATE_TYPE_PARM);
929   RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
930   RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
931   RECORD(DECL_CONCEPT);
932   RECORD(DECL_REQUIRES_EXPR_BODY);
933   RECORD(DECL_TYPE_ALIAS_TEMPLATE);
934   RECORD(DECL_STATIC_ASSERT);
935   RECORD(DECL_CXX_BASE_SPECIFIERS);
936   RECORD(DECL_CXX_CTOR_INITIALIZERS);
937   RECORD(DECL_INDIRECTFIELD);
938   RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
939   RECORD(DECL_EXPANDED_TEMPLATE_TEMPLATE_PARM_PACK);
940   RECORD(DECL_CLASS_SCOPE_FUNCTION_SPECIALIZATION);
941   RECORD(DECL_IMPORT);
942   RECORD(DECL_OMP_THREADPRIVATE);
943   RECORD(DECL_EMPTY);
944   RECORD(DECL_OBJC_TYPE_PARAM);
945   RECORD(DECL_OMP_CAPTUREDEXPR);
946   RECORD(DECL_PRAGMA_COMMENT);
947   RECORD(DECL_PRAGMA_DETECT_MISMATCH);
948   RECORD(DECL_OMP_DECLARE_REDUCTION);
949   RECORD(DECL_OMP_ALLOCATE);
950 
951   // Statements and Exprs can occur in the Decls and Types block.
952   AddStmtsExprs(Stream, Record);
953 
954   BLOCK(PREPROCESSOR_DETAIL_BLOCK);
955   RECORD(PPD_MACRO_EXPANSION);
956   RECORD(PPD_MACRO_DEFINITION);
957   RECORD(PPD_INCLUSION_DIRECTIVE);
958 
959   // Decls and Types block.
960   BLOCK(EXTENSION_BLOCK);
961   RECORD(EXTENSION_METADATA);
962 
963   BLOCK(UNHASHED_CONTROL_BLOCK);
964   RECORD(SIGNATURE);
965   RECORD(AST_BLOCK_HASH);
966   RECORD(DIAGNOSTIC_OPTIONS);
967   RECORD(DIAG_PRAGMA_MAPPINGS);
968 
969 #undef RECORD
970 #undef BLOCK
971   Stream.ExitBlock();
972 }
973 
974 /// Prepares a path for being written to an AST file by converting it
975 /// to an absolute path and removing nested './'s.
976 ///
977 /// \return \c true if the path was changed.
978 static bool cleanPathForOutput(FileManager &FileMgr,
979                                SmallVectorImpl<char> &Path) {
980   bool Changed = FileMgr.makeAbsolutePath(Path);
981   return Changed | llvm::sys::path::remove_dots(Path);
982 }
983 
984 /// Adjusts the given filename to only write out the portion of the
985 /// filename that is not part of the system root directory.
986 ///
987 /// \param Filename the file name to adjust.
988 ///
989 /// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
990 /// the returned filename will be adjusted by this root directory.
991 ///
992 /// \returns either the original filename (if it needs no adjustment) or the
993 /// adjusted filename (which points into the @p Filename parameter).
994 static const char *
995 adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
996   assert(Filename && "No file name to adjust?");
997 
998   if (BaseDir.empty())
999     return Filename;
1000 
1001   // Verify that the filename and the system root have the same prefix.
1002   unsigned Pos = 0;
1003   for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1004     if (Filename[Pos] != BaseDir[Pos])
1005       return Filename; // Prefixes don't match.
1006 
1007   // We hit the end of the filename before we hit the end of the system root.
1008   if (!Filename[Pos])
1009     return Filename;
1010 
1011   // If there's not a path separator at the end of the base directory nor
1012   // immediately after it, then this isn't within the base directory.
1013   if (!llvm::sys::path::is_separator(Filename[Pos])) {
1014     if (!llvm::sys::path::is_separator(BaseDir.back()))
1015       return Filename;
1016   } else {
1017     // If the file name has a '/' at the current position, skip over the '/'.
1018     // We distinguish relative paths from absolute paths by the
1019     // absence of '/' at the beginning of relative paths.
1020     //
1021     // FIXME: This is wrong. We distinguish them by asking if the path is
1022     // absolute, which isn't the same thing. And there might be multiple '/'s
1023     // in a row. Use a better mechanism to indicate whether we have emitted an
1024     // absolute or relative path.
1025     ++Pos;
1026   }
1027 
1028   return Filename + Pos;
1029 }
1030 
1031 std::pair<ASTFileSignature, ASTFileSignature>
1032 ASTWriter::createSignature(StringRef AllBytes, StringRef ASTBlockBytes) {
1033   llvm::SHA1 Hasher;
1034   Hasher.update(ASTBlockBytes);
1035   auto Hash = Hasher.result();
1036   ASTFileSignature ASTBlockHash = ASTFileSignature::create(Hash);
1037 
1038   // Add the remaining bytes (i.e. bytes before the unhashed control block that
1039   // are not part of the AST block).
1040   Hasher.update(
1041       AllBytes.take_front(ASTBlockBytes.bytes_end() - AllBytes.bytes_begin()));
1042   Hasher.update(
1043       AllBytes.take_back(AllBytes.bytes_end() - ASTBlockBytes.bytes_end()));
1044   Hash = Hasher.result();
1045   ASTFileSignature Signature = ASTFileSignature::create(Hash);
1046 
1047   return std::make_pair(ASTBlockHash, Signature);
1048 }
1049 
1050 ASTFileSignature ASTWriter::writeUnhashedControlBlock(Preprocessor &PP,
1051                                                       ASTContext &Context) {
1052   // Flush first to prepare the PCM hash (signature).
1053   Stream.FlushToWord();
1054   auto StartOfUnhashedControl = Stream.GetCurrentBitNo() >> 3;
1055 
1056   // Enter the block and prepare to write records.
1057   RecordData Record;
1058   Stream.EnterSubblock(UNHASHED_CONTROL_BLOCK_ID, 5);
1059 
1060   // For implicit modules, write the hash of the PCM as its signature.
1061   ASTFileSignature Signature;
1062   if (WritingModule &&
1063       PP.getHeaderSearchInfo().getHeaderSearchOpts().ModulesHashContent) {
1064     ASTFileSignature ASTBlockHash;
1065     auto ASTBlockStartByte = ASTBlockRange.first >> 3;
1066     auto ASTBlockByteLength = (ASTBlockRange.second >> 3) - ASTBlockStartByte;
1067     std::tie(ASTBlockHash, Signature) = createSignature(
1068         StringRef(Buffer.begin(), StartOfUnhashedControl),
1069         StringRef(Buffer.begin() + ASTBlockStartByte, ASTBlockByteLength));
1070 
1071     Record.append(ASTBlockHash.begin(), ASTBlockHash.end());
1072     Stream.EmitRecord(AST_BLOCK_HASH, Record);
1073     Record.clear();
1074     Record.append(Signature.begin(), Signature.end());
1075     Stream.EmitRecord(SIGNATURE, Record);
1076     Record.clear();
1077   }
1078 
1079   // Diagnostic options.
1080   const auto &Diags = Context.getDiagnostics();
1081   const DiagnosticOptions &DiagOpts = Diags.getDiagnosticOptions();
1082 #define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1083 #define ENUM_DIAGOPT(Name, Type, Bits, Default)                                \
1084   Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1085 #include "clang/Basic/DiagnosticOptions.def"
1086   Record.push_back(DiagOpts.Warnings.size());
1087   for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1088     AddString(DiagOpts.Warnings[I], Record);
1089   Record.push_back(DiagOpts.Remarks.size());
1090   for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1091     AddString(DiagOpts.Remarks[I], Record);
1092   // Note: we don't serialize the log or serialization file names, because they
1093   // are generally transient files and will almost always be overridden.
1094   Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record);
1095 
1096   // Write out the diagnostic/pragma mappings.
1097   WritePragmaDiagnosticMappings(Diags, /* isModule = */ WritingModule);
1098 
1099   // Leave the options block.
1100   Stream.ExitBlock();
1101   return Signature;
1102 }
1103 
1104 /// Write the control block.
1105 void ASTWriter::WriteControlBlock(Preprocessor &PP, ASTContext &Context,
1106                                   StringRef isysroot,
1107                                   const std::string &OutputFile) {
1108   using namespace llvm;
1109 
1110   Stream.EnterSubblock(CONTROL_BLOCK_ID, 5);
1111   RecordData Record;
1112 
1113   // Metadata
1114   auto MetadataAbbrev = std::make_shared<BitCodeAbbrev>();
1115   MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA));
1116   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1117   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1118   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1119   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1120   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
1121   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Timestamps
1122   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1123   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
1124   unsigned MetadataAbbrevCode = Stream.EmitAbbrev(std::move(MetadataAbbrev));
1125   assert((!WritingModule || isysroot.empty()) &&
1126          "writing module as a relocatable PCH?");
1127   {
1128     RecordData::value_type Record[] = {
1129         METADATA,
1130         VERSION_MAJOR,
1131         VERSION_MINOR,
1132         CLANG_VERSION_MAJOR,
1133         CLANG_VERSION_MINOR,
1134         !isysroot.empty(),
1135         IncludeTimestamps,
1136         ASTHasCompilerErrors};
1137     Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record,
1138                               getClangFullRepositoryVersion());
1139   }
1140 
1141   if (WritingModule) {
1142     // Module name
1143     auto Abbrev = std::make_shared<BitCodeAbbrev>();
1144     Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME));
1145     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
1146     unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
1147     RecordData::value_type Record[] = {MODULE_NAME};
1148     Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name);
1149   }
1150 
1151   if (WritingModule && WritingModule->Directory) {
1152     SmallString<128> BaseDir(WritingModule->Directory->getName());
1153     cleanPathForOutput(Context.getSourceManager().getFileManager(), BaseDir);
1154 
1155     // If the home of the module is the current working directory, then we
1156     // want to pick up the cwd of the build process loading the module, not
1157     // our cwd, when we load this module.
1158     if (!PP.getHeaderSearchInfo()
1159              .getHeaderSearchOpts()
1160              .ModuleMapFileHomeIsCwd ||
1161         WritingModule->Directory->getName() != StringRef(".")) {
1162       // Module directory.
1163       auto Abbrev = std::make_shared<BitCodeAbbrev>();
1164       Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY));
1165       Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
1166       unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
1167 
1168       RecordData::value_type Record[] = {MODULE_DIRECTORY};
1169       Stream.EmitRecordWithBlob(AbbrevCode, Record, BaseDir);
1170     }
1171 
1172     // Write out all other paths relative to the base directory if possible.
1173     BaseDirectory.assign(BaseDir.begin(), BaseDir.end());
1174   } else if (!isysroot.empty()) {
1175     // Write out paths relative to the sysroot if possible.
1176     BaseDirectory = std::string(isysroot);
1177   }
1178 
1179   // Module map file
1180   if (WritingModule && WritingModule->Kind == Module::ModuleMapModule) {
1181     Record.clear();
1182 
1183     auto &Map = PP.getHeaderSearchInfo().getModuleMap();
1184     AddPath(WritingModule->PresumedModuleMapFile.empty()
1185                 ? Map.getModuleMapFileForUniquing(WritingModule)->getName()
1186                 : StringRef(WritingModule->PresumedModuleMapFile),
1187             Record);
1188 
1189     // Additional module map files.
1190     if (auto *AdditionalModMaps =
1191             Map.getAdditionalModuleMapFiles(WritingModule)) {
1192       Record.push_back(AdditionalModMaps->size());
1193       for (const FileEntry *F : *AdditionalModMaps)
1194         AddPath(F->getName(), Record);
1195     } else {
1196       Record.push_back(0);
1197     }
1198 
1199     Stream.EmitRecord(MODULE_MAP_FILE, Record);
1200   }
1201 
1202   // Imports
1203   if (Chain) {
1204     serialization::ModuleManager &Mgr = Chain->getModuleManager();
1205     Record.clear();
1206 
1207     for (ModuleFile &M : Mgr) {
1208       // Skip modules that weren't directly imported.
1209       if (!M.isDirectlyImported())
1210         continue;
1211 
1212       Record.push_back((unsigned)M.Kind); // FIXME: Stable encoding
1213       AddSourceLocation(M.ImportLoc, Record);
1214 
1215       // If we have calculated signature, there is no need to store
1216       // the size or timestamp.
1217       Record.push_back(M.Signature ? 0 : M.File->getSize());
1218       Record.push_back(M.Signature ? 0 : getTimestampForOutput(M.File));
1219 
1220       for (auto I : M.Signature)
1221         Record.push_back(I);
1222 
1223       AddString(M.ModuleName, Record);
1224       AddPath(M.FileName, Record);
1225     }
1226     Stream.EmitRecord(IMPORTS, Record);
1227   }
1228 
1229   // Write the options block.
1230   Stream.EnterSubblock(OPTIONS_BLOCK_ID, 4);
1231 
1232   // Language options.
1233   Record.clear();
1234   const LangOptions &LangOpts = Context.getLangOpts();
1235 #define LANGOPT(Name, Bits, Default, Description) \
1236   Record.push_back(LangOpts.Name);
1237 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
1238   Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
1239 #include "clang/Basic/LangOptions.def"
1240 #define SANITIZER(NAME, ID)                                                    \
1241   Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
1242 #include "clang/Basic/Sanitizers.def"
1243 
1244   Record.push_back(LangOpts.ModuleFeatures.size());
1245   for (StringRef Feature : LangOpts.ModuleFeatures)
1246     AddString(Feature, Record);
1247 
1248   Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind());
1249   AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record);
1250 
1251   AddString(LangOpts.CurrentModule, Record);
1252 
1253   // Comment options.
1254   Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size());
1255   for (const auto &I : LangOpts.CommentOpts.BlockCommandNames) {
1256     AddString(I, Record);
1257   }
1258   Record.push_back(LangOpts.CommentOpts.ParseAllComments);
1259 
1260   // OpenMP offloading options.
1261   Record.push_back(LangOpts.OMPTargetTriples.size());
1262   for (auto &T : LangOpts.OMPTargetTriples)
1263     AddString(T.getTriple(), Record);
1264 
1265   AddString(LangOpts.OMPHostIRFile, Record);
1266 
1267   Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1268 
1269   // Target options.
1270   Record.clear();
1271   const TargetInfo &Target = Context.getTargetInfo();
1272   const TargetOptions &TargetOpts = Target.getTargetOpts();
1273   AddString(TargetOpts.Triple, Record);
1274   AddString(TargetOpts.CPU, Record);
1275   AddString(TargetOpts.TuneCPU, Record);
1276   AddString(TargetOpts.ABI, Record);
1277   Record.push_back(TargetOpts.FeaturesAsWritten.size());
1278   for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1279     AddString(TargetOpts.FeaturesAsWritten[I], Record);
1280   }
1281   Record.push_back(TargetOpts.Features.size());
1282   for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1283     AddString(TargetOpts.Features[I], Record);
1284   }
1285   Stream.EmitRecord(TARGET_OPTIONS, Record);
1286 
1287   // File system options.
1288   Record.clear();
1289   const FileSystemOptions &FSOpts =
1290       Context.getSourceManager().getFileManager().getFileSystemOpts();
1291   AddString(FSOpts.WorkingDir, Record);
1292   Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record);
1293 
1294   // Header search options.
1295   Record.clear();
1296   const HeaderSearchOptions &HSOpts
1297     = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1298   AddString(HSOpts.Sysroot, Record);
1299 
1300   // Include entries.
1301   Record.push_back(HSOpts.UserEntries.size());
1302   for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1303     const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1304     AddString(Entry.Path, Record);
1305     Record.push_back(static_cast<unsigned>(Entry.Group));
1306     Record.push_back(Entry.IsFramework);
1307     Record.push_back(Entry.IgnoreSysRoot);
1308   }
1309 
1310   // System header prefixes.
1311   Record.push_back(HSOpts.SystemHeaderPrefixes.size());
1312   for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1313     AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1314     Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1315   }
1316 
1317   AddString(HSOpts.ResourceDir, Record);
1318   AddString(HSOpts.ModuleCachePath, Record);
1319   AddString(HSOpts.ModuleUserBuildPath, Record);
1320   Record.push_back(HSOpts.DisableModuleHash);
1321   Record.push_back(HSOpts.ImplicitModuleMaps);
1322   Record.push_back(HSOpts.ModuleMapFileHomeIsCwd);
1323   Record.push_back(HSOpts.UseBuiltinIncludes);
1324   Record.push_back(HSOpts.UseStandardSystemIncludes);
1325   Record.push_back(HSOpts.UseStandardCXXIncludes);
1326   Record.push_back(HSOpts.UseLibcxx);
1327   // Write out the specific module cache path that contains the module files.
1328   AddString(PP.getHeaderSearchInfo().getModuleCachePath(), Record);
1329   Stream.EmitRecord(HEADER_SEARCH_OPTIONS, Record);
1330 
1331   // Preprocessor options.
1332   Record.clear();
1333   const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts();
1334 
1335   // Macro definitions.
1336   Record.push_back(PPOpts.Macros.size());
1337   for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1338     AddString(PPOpts.Macros[I].first, Record);
1339     Record.push_back(PPOpts.Macros[I].second);
1340   }
1341 
1342   // Includes
1343   Record.push_back(PPOpts.Includes.size());
1344   for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1345     AddString(PPOpts.Includes[I], Record);
1346 
1347   // Macro includes
1348   Record.push_back(PPOpts.MacroIncludes.size());
1349   for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1350     AddString(PPOpts.MacroIncludes[I], Record);
1351 
1352   Record.push_back(PPOpts.UsePredefines);
1353   // Detailed record is important since it is used for the module cache hash.
1354   Record.push_back(PPOpts.DetailedRecord);
1355   AddString(PPOpts.ImplicitPCHInclude, Record);
1356   Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1357   Stream.EmitRecord(PREPROCESSOR_OPTIONS, Record);
1358 
1359   // Leave the options block.
1360   Stream.ExitBlock();
1361 
1362   // Original file name and file ID
1363   SourceManager &SM = Context.getSourceManager();
1364   if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
1365     auto FileAbbrev = std::make_shared<BitCodeAbbrev>();
1366     FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE));
1367     FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
1368     FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1369     unsigned FileAbbrevCode = Stream.EmitAbbrev(std::move(FileAbbrev));
1370 
1371     Record.clear();
1372     Record.push_back(ORIGINAL_FILE);
1373     Record.push_back(SM.getMainFileID().getOpaqueValue());
1374     EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName());
1375   }
1376 
1377   Record.clear();
1378   Record.push_back(SM.getMainFileID().getOpaqueValue());
1379   Stream.EmitRecord(ORIGINAL_FILE_ID, Record);
1380 
1381   // Original PCH directory
1382   if (!OutputFile.empty() && OutputFile != "-") {
1383     auto Abbrev = std::make_shared<BitCodeAbbrev>();
1384     Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR));
1385     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1386     unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
1387 
1388     SmallString<128> OutputPath(OutputFile);
1389 
1390     SM.getFileManager().makeAbsolutePath(OutputPath);
1391     StringRef origDir = llvm::sys::path::parent_path(OutputPath);
1392 
1393     RecordData::value_type Record[] = {ORIGINAL_PCH_DIR};
1394     Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir);
1395   }
1396 
1397   WriteInputFiles(Context.SourceMgr,
1398                   PP.getHeaderSearchInfo().getHeaderSearchOpts(),
1399                   PP.getLangOpts().Modules);
1400   Stream.ExitBlock();
1401 }
1402 
1403 namespace  {
1404 
1405 /// An input file.
1406 struct InputFileEntry {
1407   const FileEntry *File;
1408   bool IsSystemFile;
1409   bool IsTransient;
1410   bool BufferOverridden;
1411   bool IsTopLevelModuleMap;
1412   uint32_t ContentHash[2];
1413 };
1414 
1415 } // namespace
1416 
1417 void ASTWriter::WriteInputFiles(SourceManager &SourceMgr,
1418                                 HeaderSearchOptions &HSOpts,
1419                                 bool Modules) {
1420   using namespace llvm;
1421 
1422   Stream.EnterSubblock(INPUT_FILES_BLOCK_ID, 4);
1423 
1424   // Create input-file abbreviation.
1425   auto IFAbbrev = std::make_shared<BitCodeAbbrev>();
1426   IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE));
1427   IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
1428   IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1429   IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
1430   IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
1431   IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Transient
1432   IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Module map
1433   IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1434   unsigned IFAbbrevCode = Stream.EmitAbbrev(std::move(IFAbbrev));
1435 
1436   // Create input file hash abbreviation.
1437   auto IFHAbbrev = std::make_shared<BitCodeAbbrev>();
1438   IFHAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_HASH));
1439   IFHAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1440   IFHAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1441   unsigned IFHAbbrevCode = Stream.EmitAbbrev(std::move(IFHAbbrev));
1442 
1443   // Get all ContentCache objects for files, sorted by whether the file is a
1444   // system one or not. System files go at the back, users files at the front.
1445   std::deque<InputFileEntry> SortedFiles;
1446   for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
1447     // Get this source location entry.
1448     const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
1449     assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc);
1450 
1451     // We only care about file entries that were not overridden.
1452     if (!SLoc->isFile())
1453       continue;
1454     const SrcMgr::FileInfo &File = SLoc->getFile();
1455     const SrcMgr::ContentCache *Cache = File.getContentCache();
1456     if (!Cache->OrigEntry)
1457       continue;
1458 
1459     InputFileEntry Entry;
1460     Entry.File = Cache->OrigEntry;
1461     Entry.IsSystemFile = isSystem(File.getFileCharacteristic());
1462     Entry.IsTransient = Cache->IsTransient;
1463     Entry.BufferOverridden = Cache->BufferOverridden;
1464     Entry.IsTopLevelModuleMap = isModuleMap(File.getFileCharacteristic()) &&
1465                                 File.getIncludeLoc().isInvalid();
1466 
1467     auto ContentHash = hash_code(-1);
1468     if (PP->getHeaderSearchInfo()
1469             .getHeaderSearchOpts()
1470             .ValidateASTInputFilesContent) {
1471       auto *MemBuff = Cache->getRawBuffer();
1472       if (MemBuff)
1473         ContentHash = hash_value(MemBuff->getBuffer());
1474       else
1475         // FIXME: The path should be taken from the FileEntryRef.
1476         PP->Diag(SourceLocation(), diag::err_module_unable_to_hash_content)
1477             << Entry.File->getName();
1478     }
1479     auto CH = llvm::APInt(64, ContentHash);
1480     Entry.ContentHash[0] =
1481         static_cast<uint32_t>(CH.getLoBits(32).getZExtValue());
1482     Entry.ContentHash[1] =
1483         static_cast<uint32_t>(CH.getHiBits(32).getZExtValue());
1484 
1485     if (Entry.IsSystemFile)
1486       SortedFiles.push_back(Entry);
1487     else
1488       SortedFiles.push_front(Entry);
1489   }
1490 
1491   unsigned UserFilesNum = 0;
1492   // Write out all of the input files.
1493   std::vector<uint64_t> InputFileOffsets;
1494   for (const auto &Entry : SortedFiles) {
1495     uint32_t &InputFileID = InputFileIDs[Entry.File];
1496     if (InputFileID != 0)
1497       continue; // already recorded this file.
1498 
1499     // Record this entry's offset.
1500     InputFileOffsets.push_back(Stream.GetCurrentBitNo());
1501 
1502     InputFileID = InputFileOffsets.size();
1503 
1504     if (!Entry.IsSystemFile)
1505       ++UserFilesNum;
1506 
1507     // Emit size/modification time for this file.
1508     // And whether this file was overridden.
1509     {
1510       RecordData::value_type Record[] = {
1511           INPUT_FILE,
1512           InputFileOffsets.size(),
1513           (uint64_t)Entry.File->getSize(),
1514           (uint64_t)getTimestampForOutput(Entry.File),
1515           Entry.BufferOverridden,
1516           Entry.IsTransient,
1517           Entry.IsTopLevelModuleMap};
1518 
1519       // FIXME: The path should be taken from the FileEntryRef.
1520       EmitRecordWithPath(IFAbbrevCode, Record, Entry.File->getName());
1521     }
1522 
1523     // Emit content hash for this file.
1524     {
1525       RecordData::value_type Record[] = {INPUT_FILE_HASH, Entry.ContentHash[0],
1526                                          Entry.ContentHash[1]};
1527       Stream.EmitRecordWithAbbrev(IFHAbbrevCode, Record);
1528     }
1529   }
1530 
1531   Stream.ExitBlock();
1532 
1533   // Create input file offsets abbreviation.
1534   auto OffsetsAbbrev = std::make_shared<BitCodeAbbrev>();
1535   OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1536   OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
1537   OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1538                                                                 //   input files
1539   OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));   // Array
1540   unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(std::move(OffsetsAbbrev));
1541 
1542   // Write input file offsets.
1543   RecordData::value_type Record[] = {INPUT_FILE_OFFSETS,
1544                                      InputFileOffsets.size(), UserFilesNum};
1545   Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, bytes(InputFileOffsets));
1546 }
1547 
1548 //===----------------------------------------------------------------------===//
1549 // Source Manager Serialization
1550 //===----------------------------------------------------------------------===//
1551 
1552 /// Create an abbreviation for the SLocEntry that refers to a
1553 /// file.
1554 static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
1555   using namespace llvm;
1556 
1557   auto Abbrev = std::make_shared<BitCodeAbbrev>();
1558   Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
1559   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1560   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1561   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
1562   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1563   // FileEntry fields.
1564   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
1565   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
1566   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
1567   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
1568   return Stream.EmitAbbrev(std::move(Abbrev));
1569 }
1570 
1571 /// Create an abbreviation for the SLocEntry that refers to a
1572 /// buffer.
1573 static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
1574   using namespace llvm;
1575 
1576   auto Abbrev = std::make_shared<BitCodeAbbrev>();
1577   Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
1578   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1579   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1580   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
1581   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1582   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
1583   return Stream.EmitAbbrev(std::move(Abbrev));
1584 }
1585 
1586 /// Create an abbreviation for the SLocEntry that refers to a
1587 /// buffer's blob.
1588 static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream,
1589                                            bool Compressed) {
1590   using namespace llvm;
1591 
1592   auto Abbrev = std::make_shared<BitCodeAbbrev>();
1593   Abbrev->Add(BitCodeAbbrevOp(Compressed ? SM_SLOC_BUFFER_BLOB_COMPRESSED
1594                                          : SM_SLOC_BUFFER_BLOB));
1595   if (Compressed)
1596     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Uncompressed size
1597   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
1598   return Stream.EmitAbbrev(std::move(Abbrev));
1599 }
1600 
1601 /// Create an abbreviation for the SLocEntry that refers to a macro
1602 /// expansion.
1603 static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
1604   using namespace llvm;
1605 
1606   auto Abbrev = std::make_shared<BitCodeAbbrev>();
1607   Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
1608   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1609   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1610   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1611   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
1612   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Is token range
1613   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
1614   return Stream.EmitAbbrev(std::move(Abbrev));
1615 }
1616 
1617 namespace {
1618 
1619   // Trait used for the on-disk hash table of header search information.
1620   class HeaderFileInfoTrait {
1621     ASTWriter &Writer;
1622 
1623     // Keep track of the framework names we've used during serialization.
1624     SmallVector<char, 128> FrameworkStringData;
1625     llvm::StringMap<unsigned> FrameworkNameOffset;
1626 
1627   public:
1628     HeaderFileInfoTrait(ASTWriter &Writer) : Writer(Writer) {}
1629 
1630     struct key_type {
1631       StringRef Filename;
1632       off_t Size;
1633       time_t ModTime;
1634     };
1635     using key_type_ref = const key_type &;
1636 
1637     using UnresolvedModule =
1638         llvm::PointerIntPair<Module *, 2, ModuleMap::ModuleHeaderRole>;
1639 
1640     struct data_type {
1641       const HeaderFileInfo &HFI;
1642       ArrayRef<ModuleMap::KnownHeader> KnownHeaders;
1643       UnresolvedModule Unresolved;
1644     };
1645     using data_type_ref = const data_type &;
1646 
1647     using hash_value_type = unsigned;
1648     using offset_type = unsigned;
1649 
1650     hash_value_type ComputeHash(key_type_ref key) {
1651       // The hash is based only on size/time of the file, so that the reader can
1652       // match even when symlinking or excess path elements ("foo/../", "../")
1653       // change the form of the name. However, complete path is still the key.
1654       return llvm::hash_combine(key.Size, key.ModTime);
1655     }
1656 
1657     std::pair<unsigned, unsigned>
1658     EmitKeyDataLength(raw_ostream& Out, key_type_ref key, data_type_ref Data) {
1659       using namespace llvm::support;
1660 
1661       endian::Writer LE(Out, little);
1662       unsigned KeyLen = key.Filename.size() + 1 + 8 + 8;
1663       LE.write<uint16_t>(KeyLen);
1664       unsigned DataLen = 1 + 2 + 4 + 4;
1665       for (auto ModInfo : Data.KnownHeaders)
1666         if (Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule()))
1667           DataLen += 4;
1668       if (Data.Unresolved.getPointer())
1669         DataLen += 4;
1670       LE.write<uint8_t>(DataLen);
1671       return std::make_pair(KeyLen, DataLen);
1672     }
1673 
1674     void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) {
1675       using namespace llvm::support;
1676 
1677       endian::Writer LE(Out, little);
1678       LE.write<uint64_t>(key.Size);
1679       KeyLen -= 8;
1680       LE.write<uint64_t>(key.ModTime);
1681       KeyLen -= 8;
1682       Out.write(key.Filename.data(), KeyLen);
1683     }
1684 
1685     void EmitData(raw_ostream &Out, key_type_ref key,
1686                   data_type_ref Data, unsigned DataLen) {
1687       using namespace llvm::support;
1688 
1689       endian::Writer LE(Out, little);
1690       uint64_t Start = Out.tell(); (void)Start;
1691 
1692       unsigned char Flags = (Data.HFI.isImport << 5)
1693                           | (Data.HFI.isPragmaOnce << 4)
1694                           | (Data.HFI.DirInfo << 1)
1695                           | Data.HFI.IndexHeaderMapHeader;
1696       LE.write<uint8_t>(Flags);
1697       LE.write<uint16_t>(Data.HFI.NumIncludes);
1698 
1699       if (!Data.HFI.ControllingMacro)
1700         LE.write<uint32_t>(Data.HFI.ControllingMacroID);
1701       else
1702         LE.write<uint32_t>(Writer.getIdentifierRef(Data.HFI.ControllingMacro));
1703 
1704       unsigned Offset = 0;
1705       if (!Data.HFI.Framework.empty()) {
1706         // If this header refers into a framework, save the framework name.
1707         llvm::StringMap<unsigned>::iterator Pos
1708           = FrameworkNameOffset.find(Data.HFI.Framework);
1709         if (Pos == FrameworkNameOffset.end()) {
1710           Offset = FrameworkStringData.size() + 1;
1711           FrameworkStringData.append(Data.HFI.Framework.begin(),
1712                                      Data.HFI.Framework.end());
1713           FrameworkStringData.push_back(0);
1714 
1715           FrameworkNameOffset[Data.HFI.Framework] = Offset;
1716         } else
1717           Offset = Pos->second;
1718       }
1719       LE.write<uint32_t>(Offset);
1720 
1721       auto EmitModule = [&](Module *M, ModuleMap::ModuleHeaderRole Role) {
1722         if (uint32_t ModID = Writer.getLocalOrImportedSubmoduleID(M)) {
1723           uint32_t Value = (ModID << 2) | (unsigned)Role;
1724           assert((Value >> 2) == ModID && "overflow in header module info");
1725           LE.write<uint32_t>(Value);
1726         }
1727       };
1728 
1729       // FIXME: If the header is excluded, we should write out some
1730       // record of that fact.
1731       for (auto ModInfo : Data.KnownHeaders)
1732         EmitModule(ModInfo.getModule(), ModInfo.getRole());
1733       if (Data.Unresolved.getPointer())
1734         EmitModule(Data.Unresolved.getPointer(), Data.Unresolved.getInt());
1735 
1736       assert(Out.tell() - Start == DataLen && "Wrong data length");
1737     }
1738 
1739     const char *strings_begin() const { return FrameworkStringData.begin(); }
1740     const char *strings_end() const { return FrameworkStringData.end(); }
1741   };
1742 
1743 } // namespace
1744 
1745 /// Write the header search block for the list of files that
1746 ///
1747 /// \param HS The header search structure to save.
1748 void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) {
1749   HeaderFileInfoTrait GeneratorTrait(*this);
1750   llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
1751   SmallVector<const char *, 4> SavedStrings;
1752   unsigned NumHeaderSearchEntries = 0;
1753 
1754   // Find all unresolved headers for the current module. We generally will
1755   // have resolved them before we get here, but not necessarily: we might be
1756   // compiling a preprocessed module, where there is no requirement for the
1757   // original files to exist any more.
1758   const HeaderFileInfo Empty; // So we can take a reference.
1759   if (WritingModule) {
1760     llvm::SmallVector<Module *, 16> Worklist(1, WritingModule);
1761     while (!Worklist.empty()) {
1762       Module *M = Worklist.pop_back_val();
1763       // We don't care about headers in unimportable submodules.
1764       if (M->isUnimportable())
1765         continue;
1766 
1767       // Map to disk files where possible, to pick up any missing stat
1768       // information. This also means we don't need to check the unresolved
1769       // headers list when emitting resolved headers in the first loop below.
1770       // FIXME: It'd be preferable to avoid doing this if we were given
1771       // sufficient stat information in the module map.
1772       HS.getModuleMap().resolveHeaderDirectives(M);
1773 
1774       // If the file didn't exist, we can still create a module if we were given
1775       // enough information in the module map.
1776       for (auto U : M->MissingHeaders) {
1777         // Check that we were given enough information to build a module
1778         // without this file existing on disk.
1779         if (!U.Size || (!U.ModTime && IncludeTimestamps)) {
1780           PP->Diag(U.FileNameLoc, diag::err_module_no_size_mtime_for_header)
1781             << WritingModule->getFullModuleName() << U.Size.hasValue()
1782             << U.FileName;
1783           continue;
1784         }
1785 
1786         // Form the effective relative pathname for the file.
1787         SmallString<128> Filename(M->Directory->getName());
1788         llvm::sys::path::append(Filename, U.FileName);
1789         PreparePathForOutput(Filename);
1790 
1791         StringRef FilenameDup = strdup(Filename.c_str());
1792         SavedStrings.push_back(FilenameDup.data());
1793 
1794         HeaderFileInfoTrait::key_type Key = {
1795           FilenameDup, *U.Size, IncludeTimestamps ? *U.ModTime : 0
1796         };
1797         HeaderFileInfoTrait::data_type Data = {
1798           Empty, {}, {M, ModuleMap::headerKindToRole(U.Kind)}
1799         };
1800         // FIXME: Deal with cases where there are multiple unresolved header
1801         // directives in different submodules for the same header.
1802         Generator.insert(Key, Data, GeneratorTrait);
1803         ++NumHeaderSearchEntries;
1804       }
1805 
1806       Worklist.append(M->submodule_begin(), M->submodule_end());
1807     }
1808   }
1809 
1810   SmallVector<const FileEntry *, 16> FilesByUID;
1811   HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
1812 
1813   if (FilesByUID.size() > HS.header_file_size())
1814     FilesByUID.resize(HS.header_file_size());
1815 
1816   for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
1817     const FileEntry *File = FilesByUID[UID];
1818     if (!File)
1819       continue;
1820 
1821     // Get the file info. This will load info from the external source if
1822     // necessary. Skip emitting this file if we have no information on it
1823     // as a header file (in which case HFI will be null) or if it hasn't
1824     // changed since it was loaded. Also skip it if it's for a modular header
1825     // from a different module; in that case, we rely on the module(s)
1826     // containing the header to provide this information.
1827     const HeaderFileInfo *HFI =
1828         HS.getExistingFileInfo(File, /*WantExternal*/!Chain);
1829     if (!HFI || (HFI->isModuleHeader && !HFI->isCompilingModuleHeader))
1830       continue;
1831 
1832     // Massage the file path into an appropriate form.
1833     StringRef Filename = File->getName();
1834     SmallString<128> FilenameTmp(Filename);
1835     if (PreparePathForOutput(FilenameTmp)) {
1836       // If we performed any translation on the file name at all, we need to
1837       // save this string, since the generator will refer to it later.
1838       Filename = StringRef(strdup(FilenameTmp.c_str()));
1839       SavedStrings.push_back(Filename.data());
1840     }
1841 
1842     HeaderFileInfoTrait::key_type Key = {
1843       Filename, File->getSize(), getTimestampForOutput(File)
1844     };
1845     HeaderFileInfoTrait::data_type Data = {
1846       *HFI, HS.getModuleMap().findResolvedModulesForHeader(File), {}
1847     };
1848     Generator.insert(Key, Data, GeneratorTrait);
1849     ++NumHeaderSearchEntries;
1850   }
1851 
1852   // Create the on-disk hash table in a buffer.
1853   SmallString<4096> TableData;
1854   uint32_t BucketOffset;
1855   {
1856     using namespace llvm::support;
1857 
1858     llvm::raw_svector_ostream Out(TableData);
1859     // Make sure that no bucket is at offset 0
1860     endian::write<uint32_t>(Out, 0, little);
1861     BucketOffset = Generator.Emit(Out, GeneratorTrait);
1862   }
1863 
1864   // Create a blob abbreviation
1865   using namespace llvm;
1866 
1867   auto Abbrev = std::make_shared<BitCodeAbbrev>();
1868   Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
1869   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1870   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1871   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1872   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1873   unsigned TableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
1874 
1875   // Write the header search table
1876   RecordData::value_type Record[] = {HEADER_SEARCH_TABLE, BucketOffset,
1877                                      NumHeaderSearchEntries, TableData.size()};
1878   TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end());
1879   Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData);
1880 
1881   // Free all of the strings we had to duplicate.
1882   for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
1883     free(const_cast<char *>(SavedStrings[I]));
1884 }
1885 
1886 static void emitBlob(llvm::BitstreamWriter &Stream, StringRef Blob,
1887                      unsigned SLocBufferBlobCompressedAbbrv,
1888                      unsigned SLocBufferBlobAbbrv) {
1889   using RecordDataType = ASTWriter::RecordData::value_type;
1890 
1891   // Compress the buffer if possible. We expect that almost all PCM
1892   // consumers will not want its contents.
1893   SmallString<0> CompressedBuffer;
1894   if (llvm::zlib::isAvailable()) {
1895     llvm::Error E = llvm::zlib::compress(Blob.drop_back(1), CompressedBuffer);
1896     if (!E) {
1897       RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB_COMPRESSED,
1898                                  Blob.size() - 1};
1899       Stream.EmitRecordWithBlob(SLocBufferBlobCompressedAbbrv, Record,
1900                                 CompressedBuffer);
1901       return;
1902     }
1903     llvm::consumeError(std::move(E));
1904   }
1905 
1906   RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB};
1907   Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record, Blob);
1908 }
1909 
1910 /// Writes the block containing the serialized form of the
1911 /// source manager.
1912 ///
1913 /// TODO: We should probably use an on-disk hash table (stored in a
1914 /// blob), indexed based on the file name, so that we only create
1915 /// entries for files that we actually need. In the common case (no
1916 /// errors), we probably won't have to create file entries for any of
1917 /// the files in the AST.
1918 void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
1919                                         const Preprocessor &PP) {
1920   RecordData Record;
1921 
1922   // Enter the source manager block.
1923   Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 4);
1924   const uint64_t SourceManagerBlockOffset = Stream.GetCurrentBitNo();
1925 
1926   // Abbreviations for the various kinds of source-location entries.
1927   unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
1928   unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
1929   unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream, false);
1930   unsigned SLocBufferBlobCompressedAbbrv =
1931       CreateSLocBufferBlobAbbrev(Stream, true);
1932   unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
1933 
1934   // Write out the source location entry table. We skip the first
1935   // entry, which is always the same dummy entry.
1936   std::vector<uint32_t> SLocEntryOffsets;
1937   uint64_t SLocEntryOffsetsBase = Stream.GetCurrentBitNo();
1938   RecordData PreloadSLocs;
1939   SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1);
1940   for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
1941        I != N; ++I) {
1942     // Get this source location entry.
1943     const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
1944     FileID FID = FileID::get(I);
1945     assert(&SourceMgr.getSLocEntry(FID) == SLoc);
1946 
1947     // Record the offset of this source-location entry.
1948     uint64_t Offset = Stream.GetCurrentBitNo() - SLocEntryOffsetsBase;
1949     assert((Offset >> 32) == 0 && "SLocEntry offset too large");
1950     SLocEntryOffsets.push_back(Offset);
1951 
1952     // Figure out which record code to use.
1953     unsigned Code;
1954     if (SLoc->isFile()) {
1955       const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
1956       if (Cache->OrigEntry) {
1957         Code = SM_SLOC_FILE_ENTRY;
1958       } else
1959         Code = SM_SLOC_BUFFER_ENTRY;
1960     } else
1961       Code = SM_SLOC_EXPANSION_ENTRY;
1962     Record.clear();
1963     Record.push_back(Code);
1964 
1965     // Starting offset of this entry within this module, so skip the dummy.
1966     Record.push_back(SLoc->getOffset() - 2);
1967     if (SLoc->isFile()) {
1968       const SrcMgr::FileInfo &File = SLoc->getFile();
1969       AddSourceLocation(File.getIncludeLoc(), Record);
1970       Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
1971       Record.push_back(File.hasLineDirectives());
1972 
1973       const SrcMgr::ContentCache *Content = File.getContentCache();
1974       bool EmitBlob = false;
1975       if (Content->OrigEntry) {
1976         assert(Content->OrigEntry == Content->ContentsEntry &&
1977                "Writing to AST an overridden file is not supported");
1978 
1979         // The source location entry is a file. Emit input file ID.
1980         assert(InputFileIDs[Content->OrigEntry] != 0 && "Missed file entry");
1981         Record.push_back(InputFileIDs[Content->OrigEntry]);
1982 
1983         Record.push_back(File.NumCreatedFIDs);
1984 
1985         FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID);
1986         if (FDI != FileDeclIDs.end()) {
1987           Record.push_back(FDI->second->FirstDeclIndex);
1988           Record.push_back(FDI->second->DeclIDs.size());
1989         } else {
1990           Record.push_back(0);
1991           Record.push_back(0);
1992         }
1993 
1994         Stream.EmitRecordWithAbbrev(SLocFileAbbrv, Record);
1995 
1996         if (Content->BufferOverridden || Content->IsTransient)
1997           EmitBlob = true;
1998       } else {
1999         // The source location entry is a buffer. The blob associated
2000         // with this entry contains the contents of the buffer.
2001 
2002         // We add one to the size so that we capture the trailing NULL
2003         // that is required by llvm::MemoryBuffer::getMemBuffer (on
2004         // the reader side).
2005         const llvm::MemoryBuffer *Buffer =
2006             Content->getBuffer(PP.getDiagnostics(), PP.getFileManager());
2007         StringRef Name = Buffer->getBufferIdentifier();
2008         Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
2009                                   StringRef(Name.data(), Name.size() + 1));
2010         EmitBlob = true;
2011 
2012         if (Name == "<built-in>")
2013           PreloadSLocs.push_back(SLocEntryOffsets.size());
2014       }
2015 
2016       if (EmitBlob) {
2017         // Include the implicit terminating null character in the on-disk buffer
2018         // if we're writing it uncompressed.
2019         const llvm::MemoryBuffer *Buffer =
2020             Content->getBuffer(PP.getDiagnostics(), PP.getFileManager());
2021         StringRef Blob(Buffer->getBufferStart(), Buffer->getBufferSize() + 1);
2022         emitBlob(Stream, Blob, SLocBufferBlobCompressedAbbrv,
2023                  SLocBufferBlobAbbrv);
2024       }
2025     } else {
2026       // The source location entry is a macro expansion.
2027       const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
2028       AddSourceLocation(Expansion.getSpellingLoc(), Record);
2029       AddSourceLocation(Expansion.getExpansionLocStart(), Record);
2030       AddSourceLocation(Expansion.isMacroArgExpansion()
2031                             ? SourceLocation()
2032                             : Expansion.getExpansionLocEnd(),
2033                         Record);
2034       Record.push_back(Expansion.isExpansionTokenRange());
2035 
2036       // Compute the token length for this macro expansion.
2037       unsigned NextOffset = SourceMgr.getNextLocalOffset();
2038       if (I + 1 != N)
2039         NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset();
2040       Record.push_back(NextOffset - SLoc->getOffset() - 1);
2041       Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record);
2042     }
2043   }
2044 
2045   Stream.ExitBlock();
2046 
2047   if (SLocEntryOffsets.empty())
2048     return;
2049 
2050   // Write the source-location offsets table into the AST block. This
2051   // table is used for lazily loading source-location information.
2052   using namespace llvm;
2053 
2054   auto Abbrev = std::make_shared<BitCodeAbbrev>();
2055   Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
2056   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
2057   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
2058   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // base offset
2059   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
2060   unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2061   {
2062     RecordData::value_type Record[] = {
2063         SOURCE_LOCATION_OFFSETS, SLocEntryOffsets.size(),
2064         SourceMgr.getNextLocalOffset() - 1 /* skip dummy */,
2065         SLocEntryOffsetsBase - SourceManagerBlockOffset};
2066     Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
2067                               bytes(SLocEntryOffsets));
2068   }
2069   // Write the source location entry preloads array, telling the AST
2070   // reader which source locations entries it should load eagerly.
2071   Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
2072 
2073   // Write the line table. It depends on remapping working, so it must come
2074   // after the source location offsets.
2075   if (SourceMgr.hasLineTable()) {
2076     LineTableInfo &LineTable = SourceMgr.getLineTable();
2077 
2078     Record.clear();
2079 
2080     // Emit the needed file names.
2081     llvm::DenseMap<int, int> FilenameMap;
2082     FilenameMap[-1] = -1; // For unspecified filenames.
2083     for (const auto &L : LineTable) {
2084       if (L.first.ID < 0)
2085         continue;
2086       for (auto &LE : L.second) {
2087         if (FilenameMap.insert(std::make_pair(LE.FilenameID,
2088                                               FilenameMap.size() - 1)).second)
2089           AddPath(LineTable.getFilename(LE.FilenameID), Record);
2090       }
2091     }
2092     Record.push_back(0);
2093 
2094     // Emit the line entries
2095     for (const auto &L : LineTable) {
2096       // Only emit entries for local files.
2097       if (L.first.ID < 0)
2098         continue;
2099 
2100       // Emit the file ID
2101       Record.push_back(L.first.ID);
2102 
2103       // Emit the line entries
2104       Record.push_back(L.second.size());
2105       for (const auto &LE : L.second) {
2106         Record.push_back(LE.FileOffset);
2107         Record.push_back(LE.LineNo);
2108         Record.push_back(FilenameMap[LE.FilenameID]);
2109         Record.push_back((unsigned)LE.FileKind);
2110         Record.push_back(LE.IncludeOffset);
2111       }
2112     }
2113 
2114     Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record);
2115   }
2116 }
2117 
2118 //===----------------------------------------------------------------------===//
2119 // Preprocessor Serialization
2120 //===----------------------------------------------------------------------===//
2121 
2122 static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule,
2123                               const Preprocessor &PP) {
2124   if (MacroInfo *MI = MD->getMacroInfo())
2125     if (MI->isBuiltinMacro())
2126       return true;
2127 
2128   if (IsModule) {
2129     SourceLocation Loc = MD->getLocation();
2130     if (Loc.isInvalid())
2131       return true;
2132     if (PP.getSourceManager().getFileID(Loc) == PP.getPredefinesFileID())
2133       return true;
2134   }
2135 
2136   return false;
2137 }
2138 
2139 /// Writes the block containing the serialized form of the
2140 /// preprocessor.
2141 void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
2142   uint64_t MacroOffsetsBase = Stream.GetCurrentBitNo();
2143 
2144   PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
2145   if (PPRec)
2146     WritePreprocessorDetail(*PPRec, MacroOffsetsBase);
2147 
2148   RecordData Record;
2149   RecordData ModuleMacroRecord;
2150 
2151   // If the preprocessor __COUNTER__ value has been bumped, remember it.
2152   if (PP.getCounterValue() != 0) {
2153     RecordData::value_type Record[] = {PP.getCounterValue()};
2154     Stream.EmitRecord(PP_COUNTER_VALUE, Record);
2155   }
2156 
2157   if (PP.isRecordingPreamble() && PP.hasRecordedPreamble()) {
2158     assert(!IsModule);
2159     auto SkipInfo = PP.getPreambleSkipInfo();
2160     if (SkipInfo.hasValue()) {
2161       Record.push_back(true);
2162       AddSourceLocation(SkipInfo->HashTokenLoc, Record);
2163       AddSourceLocation(SkipInfo->IfTokenLoc, Record);
2164       Record.push_back(SkipInfo->FoundNonSkipPortion);
2165       Record.push_back(SkipInfo->FoundElse);
2166       AddSourceLocation(SkipInfo->ElseLoc, Record);
2167     } else {
2168       Record.push_back(false);
2169     }
2170     for (const auto &Cond : PP.getPreambleConditionalStack()) {
2171       AddSourceLocation(Cond.IfLoc, Record);
2172       Record.push_back(Cond.WasSkipping);
2173       Record.push_back(Cond.FoundNonSkip);
2174       Record.push_back(Cond.FoundElse);
2175     }
2176     Stream.EmitRecord(PP_CONDITIONAL_STACK, Record);
2177     Record.clear();
2178   }
2179 
2180   // Enter the preprocessor block.
2181   Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
2182 
2183   // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
2184   // FIXME: Include a location for the use, and say which one was used.
2185   if (PP.SawDateOrTime())
2186     PP.Diag(SourceLocation(), diag::warn_module_uses_date_time) << IsModule;
2187 
2188   // Loop over all the macro directives that are live at the end of the file,
2189   // emitting each to the PP section.
2190 
2191   // Construct the list of identifiers with macro directives that need to be
2192   // serialized.
2193   SmallVector<const IdentifierInfo *, 128> MacroIdentifiers;
2194   for (auto &Id : PP.getIdentifierTable())
2195     if (Id.second->hadMacroDefinition() &&
2196         (!Id.second->isFromAST() ||
2197          Id.second->hasChangedSinceDeserialization()))
2198       MacroIdentifiers.push_back(Id.second);
2199   // Sort the set of macro definitions that need to be serialized by the
2200   // name of the macro, to provide a stable ordering.
2201   llvm::sort(MacroIdentifiers, llvm::deref<std::less<>>());
2202 
2203   // Emit the macro directives as a list and associate the offset with the
2204   // identifier they belong to.
2205   for (const IdentifierInfo *Name : MacroIdentifiers) {
2206     MacroDirective *MD = PP.getLocalMacroDirectiveHistory(Name);
2207     uint64_t StartOffset = Stream.GetCurrentBitNo() - MacroOffsetsBase;
2208     assert((StartOffset >> 32) == 0 && "Macro identifiers offset too large");
2209 
2210     // Emit the macro directives in reverse source order.
2211     for (; MD; MD = MD->getPrevious()) {
2212       // Once we hit an ignored macro, we're done: the rest of the chain
2213       // will all be ignored macros.
2214       if (shouldIgnoreMacro(MD, IsModule, PP))
2215         break;
2216 
2217       AddSourceLocation(MD->getLocation(), Record);
2218       Record.push_back(MD->getKind());
2219       if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
2220         Record.push_back(getMacroRef(DefMD->getInfo(), Name));
2221       } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
2222         Record.push_back(VisMD->isPublic());
2223       }
2224     }
2225 
2226     // Write out any exported module macros.
2227     bool EmittedModuleMacros = false;
2228     // We write out exported module macros for PCH as well.
2229     auto Leafs = PP.getLeafModuleMacros(Name);
2230     SmallVector<ModuleMacro*, 8> Worklist(Leafs.begin(), Leafs.end());
2231     llvm::DenseMap<ModuleMacro*, unsigned> Visits;
2232     while (!Worklist.empty()) {
2233       auto *Macro = Worklist.pop_back_val();
2234 
2235       // Emit a record indicating this submodule exports this macro.
2236       ModuleMacroRecord.push_back(
2237           getSubmoduleID(Macro->getOwningModule()));
2238       ModuleMacroRecord.push_back(getMacroRef(Macro->getMacroInfo(), Name));
2239       for (auto *M : Macro->overrides())
2240         ModuleMacroRecord.push_back(getSubmoduleID(M->getOwningModule()));
2241 
2242       Stream.EmitRecord(PP_MODULE_MACRO, ModuleMacroRecord);
2243       ModuleMacroRecord.clear();
2244 
2245       // Enqueue overridden macros once we've visited all their ancestors.
2246       for (auto *M : Macro->overrides())
2247         if (++Visits[M] == M->getNumOverridingMacros())
2248           Worklist.push_back(M);
2249 
2250       EmittedModuleMacros = true;
2251     }
2252 
2253     if (Record.empty() && !EmittedModuleMacros)
2254       continue;
2255 
2256     IdentMacroDirectivesOffsetMap[Name] = StartOffset;
2257     Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, Record);
2258     Record.clear();
2259   }
2260 
2261   /// Offsets of each of the macros into the bitstream, indexed by
2262   /// the local macro ID
2263   ///
2264   /// For each identifier that is associated with a macro, this map
2265   /// provides the offset into the bitstream where that macro is
2266   /// defined.
2267   std::vector<uint32_t> MacroOffsets;
2268 
2269   for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) {
2270     const IdentifierInfo *Name = MacroInfosToEmit[I].Name;
2271     MacroInfo *MI = MacroInfosToEmit[I].MI;
2272     MacroID ID = MacroInfosToEmit[I].ID;
2273 
2274     if (ID < FirstMacroID) {
2275       assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?");
2276       continue;
2277     }
2278 
2279     // Record the local offset of this macro.
2280     unsigned Index = ID - FirstMacroID;
2281     if (Index >= MacroOffsets.size())
2282       MacroOffsets.resize(Index + 1);
2283 
2284     uint64_t Offset = Stream.GetCurrentBitNo() - MacroOffsetsBase;
2285     assert((Offset >> 32) == 0 && "Macro offset too large");
2286     MacroOffsets[Index] = Offset;
2287 
2288     AddIdentifierRef(Name, Record);
2289     AddSourceLocation(MI->getDefinitionLoc(), Record);
2290     AddSourceLocation(MI->getDefinitionEndLoc(), Record);
2291     Record.push_back(MI->isUsed());
2292     Record.push_back(MI->isUsedForHeaderGuard());
2293     unsigned Code;
2294     if (MI->isObjectLike()) {
2295       Code = PP_MACRO_OBJECT_LIKE;
2296     } else {
2297       Code = PP_MACRO_FUNCTION_LIKE;
2298 
2299       Record.push_back(MI->isC99Varargs());
2300       Record.push_back(MI->isGNUVarargs());
2301       Record.push_back(MI->hasCommaPasting());
2302       Record.push_back(MI->getNumParams());
2303       for (const IdentifierInfo *Param : MI->params())
2304         AddIdentifierRef(Param, Record);
2305     }
2306 
2307     // If we have a detailed preprocessing record, record the macro definition
2308     // ID that corresponds to this macro.
2309     if (PPRec)
2310       Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2311 
2312     Stream.EmitRecord(Code, Record);
2313     Record.clear();
2314 
2315     // Emit the tokens array.
2316     for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
2317       // Note that we know that the preprocessor does not have any annotation
2318       // tokens in it because they are created by the parser, and thus can't
2319       // be in a macro definition.
2320       const Token &Tok = MI->getReplacementToken(TokNo);
2321       AddToken(Tok, Record);
2322       Stream.EmitRecord(PP_TOKEN, Record);
2323       Record.clear();
2324     }
2325     ++NumMacros;
2326   }
2327 
2328   Stream.ExitBlock();
2329 
2330   // Write the offsets table for macro IDs.
2331   using namespace llvm;
2332 
2333   auto Abbrev = std::make_shared<BitCodeAbbrev>();
2334   Abbrev->Add(BitCodeAbbrevOp(MACRO_OFFSET));
2335   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2336   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2337   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32));   // base offset
2338   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2339 
2340   unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2341   {
2342     RecordData::value_type Record[] = {MACRO_OFFSET, MacroOffsets.size(),
2343                                        FirstMacroID - NUM_PREDEF_MACRO_IDS,
2344                                        MacroOffsetsBase - ASTBlockStartOffset};
2345     Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record, bytes(MacroOffsets));
2346   }
2347 }
2348 
2349 void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec,
2350                                         uint64_t MacroOffsetsBase) {
2351   if (PPRec.local_begin() == PPRec.local_end())
2352     return;
2353 
2354   SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
2355 
2356   // Enter the preprocessor block.
2357   Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3);
2358 
2359   // If the preprocessor has a preprocessing record, emit it.
2360   unsigned NumPreprocessingRecords = 0;
2361   using namespace llvm;
2362 
2363   // Set up the abbreviation for
2364   unsigned InclusionAbbrev = 0;
2365   {
2366     auto Abbrev = std::make_shared<BitCodeAbbrev>();
2367     Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
2368     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2369     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2370     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
2371     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
2372     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2373     InclusionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2374   }
2375 
2376   unsigned FirstPreprocessorEntityID
2377     = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0)
2378     + NUM_PREDEF_PP_ENTITY_IDS;
2379   unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
2380   RecordData Record;
2381   for (PreprocessingRecord::iterator E = PPRec.local_begin(),
2382                                   EEnd = PPRec.local_end();
2383        E != EEnd;
2384        (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
2385     Record.clear();
2386 
2387     uint64_t Offset = Stream.GetCurrentBitNo() - MacroOffsetsBase;
2388     assert((Offset >> 32) == 0 && "Preprocessed entity offset too large");
2389     PreprocessedEntityOffsets.push_back(
2390         PPEntityOffset((*E)->getSourceRange(), Offset));
2391 
2392     if (auto *MD = dyn_cast<MacroDefinitionRecord>(*E)) {
2393       // Record this macro definition's ID.
2394       MacroDefinitions[MD] = NextPreprocessorEntityID;
2395 
2396       AddIdentifierRef(MD->getName(), Record);
2397       Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
2398       continue;
2399     }
2400 
2401     if (auto *ME = dyn_cast<MacroExpansion>(*E)) {
2402       Record.push_back(ME->isBuiltinMacro());
2403       if (ME->isBuiltinMacro())
2404         AddIdentifierRef(ME->getName(), Record);
2405       else
2406         Record.push_back(MacroDefinitions[ME->getDefinition()]);
2407       Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
2408       continue;
2409     }
2410 
2411     if (auto *ID = dyn_cast<InclusionDirective>(*E)) {
2412       Record.push_back(PPD_INCLUSION_DIRECTIVE);
2413       Record.push_back(ID->getFileName().size());
2414       Record.push_back(ID->wasInQuotes());
2415       Record.push_back(static_cast<unsigned>(ID->getKind()));
2416       Record.push_back(ID->importedModule());
2417       SmallString<64> Buffer;
2418       Buffer += ID->getFileName();
2419       // Check that the FileEntry is not null because it was not resolved and
2420       // we create a PCH even with compiler errors.
2421       if (ID->getFile())
2422         Buffer += ID->getFile()->getName();
2423       Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
2424       continue;
2425     }
2426 
2427     llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
2428   }
2429   Stream.ExitBlock();
2430 
2431   // Write the offsets table for the preprocessing record.
2432   if (NumPreprocessingRecords > 0) {
2433     assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
2434 
2435     // Write the offsets table for identifier IDs.
2436     using namespace llvm;
2437 
2438     auto Abbrev = std::make_shared<BitCodeAbbrev>();
2439     Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
2440     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity
2441     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2442     unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2443 
2444     RecordData::value_type Record[] = {PPD_ENTITIES_OFFSETS,
2445                                        FirstPreprocessorEntityID -
2446                                            NUM_PREDEF_PP_ENTITY_IDS};
2447     Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
2448                               bytes(PreprocessedEntityOffsets));
2449   }
2450 
2451   // Write the skipped region table for the preprocessing record.
2452   ArrayRef<SourceRange> SkippedRanges = PPRec.getSkippedRanges();
2453   if (SkippedRanges.size() > 0) {
2454     std::vector<PPSkippedRange> SerializedSkippedRanges;
2455     SerializedSkippedRanges.reserve(SkippedRanges.size());
2456     for (auto const& Range : SkippedRanges)
2457       SerializedSkippedRanges.emplace_back(Range);
2458 
2459     using namespace llvm;
2460     auto Abbrev = std::make_shared<BitCodeAbbrev>();
2461     Abbrev->Add(BitCodeAbbrevOp(PPD_SKIPPED_RANGES));
2462     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2463     unsigned PPESkippedRangeAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2464 
2465     Record.clear();
2466     Record.push_back(PPD_SKIPPED_RANGES);
2467     Stream.EmitRecordWithBlob(PPESkippedRangeAbbrev, Record,
2468                               bytes(SerializedSkippedRanges));
2469   }
2470 }
2471 
2472 unsigned ASTWriter::getLocalOrImportedSubmoduleID(Module *Mod) {
2473   if (!Mod)
2474     return 0;
2475 
2476   llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod);
2477   if (Known != SubmoduleIDs.end())
2478     return Known->second;
2479 
2480   auto *Top = Mod->getTopLevelModule();
2481   if (Top != WritingModule &&
2482       (getLangOpts().CompilingPCH ||
2483        !Top->fullModuleNameIs(StringRef(getLangOpts().CurrentModule))))
2484     return 0;
2485 
2486   return SubmoduleIDs[Mod] = NextSubmoduleID++;
2487 }
2488 
2489 unsigned ASTWriter::getSubmoduleID(Module *Mod) {
2490   // FIXME: This can easily happen, if we have a reference to a submodule that
2491   // did not result in us loading a module file for that submodule. For
2492   // instance, a cross-top-level-module 'conflict' declaration will hit this.
2493   unsigned ID = getLocalOrImportedSubmoduleID(Mod);
2494   assert((ID || !Mod) &&
2495          "asked for module ID for non-local, non-imported module");
2496   return ID;
2497 }
2498 
2499 /// Compute the number of modules within the given tree (including the
2500 /// given module).
2501 static unsigned getNumberOfModules(Module *Mod) {
2502   unsigned ChildModules = 0;
2503   for (auto Sub = Mod->submodule_begin(), SubEnd = Mod->submodule_end();
2504        Sub != SubEnd; ++Sub)
2505     ChildModules += getNumberOfModules(*Sub);
2506 
2507   return ChildModules + 1;
2508 }
2509 
2510 void ASTWriter::WriteSubmodules(Module *WritingModule) {
2511   // Enter the submodule description block.
2512   Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/5);
2513 
2514   // Write the abbreviations needed for the submodules block.
2515   using namespace llvm;
2516 
2517   auto Abbrev = std::make_shared<BitCodeAbbrev>();
2518   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
2519   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
2520   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
2521   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Kind
2522   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2523   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
2524   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
2525   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
2526   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
2527   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
2528   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
2529   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
2530   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ModuleMapIsPriv...
2531   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2532   unsigned DefinitionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2533 
2534   Abbrev = std::make_shared<BitCodeAbbrev>();
2535   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
2536   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2537   unsigned UmbrellaAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2538 
2539   Abbrev = std::make_shared<BitCodeAbbrev>();
2540   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
2541   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2542   unsigned HeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2543 
2544   Abbrev = std::make_shared<BitCodeAbbrev>();
2545   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
2546   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2547   unsigned TopHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2548 
2549   Abbrev = std::make_shared<BitCodeAbbrev>();
2550   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
2551   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2552   unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2553 
2554   Abbrev = std::make_shared<BitCodeAbbrev>();
2555   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES));
2556   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
2557   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));     // Feature
2558   unsigned RequiresAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2559 
2560   Abbrev = std::make_shared<BitCodeAbbrev>();
2561   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
2562   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2563   unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2564 
2565   Abbrev = std::make_shared<BitCodeAbbrev>();
2566   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
2567   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2568   unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2569 
2570   Abbrev = std::make_shared<BitCodeAbbrev>();
2571   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
2572   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2573   unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2574 
2575   Abbrev = std::make_shared<BitCodeAbbrev>();
2576   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
2577   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2578   unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2579 
2580   Abbrev = std::make_shared<BitCodeAbbrev>();
2581   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
2582   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2583   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));     // Name
2584   unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2585 
2586   Abbrev = std::make_shared<BitCodeAbbrev>();
2587   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
2588   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));    // Macro name
2589   unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2590 
2591   Abbrev = std::make_shared<BitCodeAbbrev>();
2592   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT));
2593   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));  // Other module
2594   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));    // Message
2595   unsigned ConflictAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2596 
2597   Abbrev = std::make_shared<BitCodeAbbrev>();
2598   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXPORT_AS));
2599   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));    // Macro name
2600   unsigned ExportAsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2601 
2602   // Write the submodule metadata block.
2603   RecordData::value_type Record[] = {
2604       getNumberOfModules(WritingModule),
2605       FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS};
2606   Stream.EmitRecord(SUBMODULE_METADATA, Record);
2607 
2608   // Write all of the submodules.
2609   std::queue<Module *> Q;
2610   Q.push(WritingModule);
2611   while (!Q.empty()) {
2612     Module *Mod = Q.front();
2613     Q.pop();
2614     unsigned ID = getSubmoduleID(Mod);
2615 
2616     uint64_t ParentID = 0;
2617     if (Mod->Parent) {
2618       assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
2619       ParentID = SubmoduleIDs[Mod->Parent];
2620     }
2621 
2622     // Emit the definition of the block.
2623     {
2624       RecordData::value_type Record[] = {SUBMODULE_DEFINITION,
2625                                          ID,
2626                                          ParentID,
2627                                          (RecordData::value_type)Mod->Kind,
2628                                          Mod->IsFramework,
2629                                          Mod->IsExplicit,
2630                                          Mod->IsSystem,
2631                                          Mod->IsExternC,
2632                                          Mod->InferSubmodules,
2633                                          Mod->InferExplicitSubmodules,
2634                                          Mod->InferExportWildcard,
2635                                          Mod->ConfigMacrosExhaustive,
2636                                          Mod->ModuleMapIsPrivate};
2637       Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name);
2638     }
2639 
2640     // Emit the requirements.
2641     for (const auto &R : Mod->Requirements) {
2642       RecordData::value_type Record[] = {SUBMODULE_REQUIRES, R.second};
2643       Stream.EmitRecordWithBlob(RequiresAbbrev, Record, R.first);
2644     }
2645 
2646     // Emit the umbrella header, if there is one.
2647     if (auto UmbrellaHeader = Mod->getUmbrellaHeader()) {
2648       RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_HEADER};
2649       Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
2650                                 UmbrellaHeader.NameAsWritten);
2651     } else if (auto UmbrellaDir = Mod->getUmbrellaDir()) {
2652       RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_DIR};
2653       Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
2654                                 UmbrellaDir.NameAsWritten);
2655     }
2656 
2657     // Emit the headers.
2658     struct {
2659       unsigned RecordKind;
2660       unsigned Abbrev;
2661       Module::HeaderKind HeaderKind;
2662     } HeaderLists[] = {
2663       {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal},
2664       {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual},
2665       {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private},
2666       {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev,
2667         Module::HK_PrivateTextual},
2668       {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded}
2669     };
2670     for (auto &HL : HeaderLists) {
2671       RecordData::value_type Record[] = {HL.RecordKind};
2672       for (auto &H : Mod->Headers[HL.HeaderKind])
2673         Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten);
2674     }
2675 
2676     // Emit the top headers.
2677     {
2678       auto TopHeaders = Mod->getTopHeaders(PP->getFileManager());
2679       RecordData::value_type Record[] = {SUBMODULE_TOPHEADER};
2680       for (auto *H : TopHeaders)
2681         Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, H->getName());
2682     }
2683 
2684     // Emit the imports.
2685     if (!Mod->Imports.empty()) {
2686       RecordData Record;
2687       for (auto *I : Mod->Imports)
2688         Record.push_back(getSubmoduleID(I));
2689       Stream.EmitRecord(SUBMODULE_IMPORTS, Record);
2690     }
2691 
2692     // Emit the exports.
2693     if (!Mod->Exports.empty()) {
2694       RecordData Record;
2695       for (const auto &E : Mod->Exports) {
2696         // FIXME: This may fail; we don't require that all exported modules
2697         // are local or imported.
2698         Record.push_back(getSubmoduleID(E.getPointer()));
2699         Record.push_back(E.getInt());
2700       }
2701       Stream.EmitRecord(SUBMODULE_EXPORTS, Record);
2702     }
2703 
2704     //FIXME: How do we emit the 'use'd modules?  They may not be submodules.
2705     // Might be unnecessary as use declarations are only used to build the
2706     // module itself.
2707 
2708     // Emit the link libraries.
2709     for (const auto &LL : Mod->LinkLibraries) {
2710       RecordData::value_type Record[] = {SUBMODULE_LINK_LIBRARY,
2711                                          LL.IsFramework};
2712       Stream.EmitRecordWithBlob(LinkLibraryAbbrev, Record, LL.Library);
2713     }
2714 
2715     // Emit the conflicts.
2716     for (const auto &C : Mod->Conflicts) {
2717       // FIXME: This may fail; we don't require that all conflicting modules
2718       // are local or imported.
2719       RecordData::value_type Record[] = {SUBMODULE_CONFLICT,
2720                                          getSubmoduleID(C.Other)};
2721       Stream.EmitRecordWithBlob(ConflictAbbrev, Record, C.Message);
2722     }
2723 
2724     // Emit the configuration macros.
2725     for (const auto &CM : Mod->ConfigMacros) {
2726       RecordData::value_type Record[] = {SUBMODULE_CONFIG_MACRO};
2727       Stream.EmitRecordWithBlob(ConfigMacroAbbrev, Record, CM);
2728     }
2729 
2730     // Emit the initializers, if any.
2731     RecordData Inits;
2732     for (Decl *D : Context->getModuleInitializers(Mod))
2733       Inits.push_back(GetDeclRef(D));
2734     if (!Inits.empty())
2735       Stream.EmitRecord(SUBMODULE_INITIALIZERS, Inits);
2736 
2737     // Emit the name of the re-exported module, if any.
2738     if (!Mod->ExportAsModule.empty()) {
2739       RecordData::value_type Record[] = {SUBMODULE_EXPORT_AS};
2740       Stream.EmitRecordWithBlob(ExportAsAbbrev, Record, Mod->ExportAsModule);
2741     }
2742 
2743     // Queue up the submodules of this module.
2744     for (auto *M : Mod->submodules())
2745       Q.push(M);
2746   }
2747 
2748   Stream.ExitBlock();
2749 
2750   assert((NextSubmoduleID - FirstSubmoduleID ==
2751           getNumberOfModules(WritingModule)) &&
2752          "Wrong # of submodules; found a reference to a non-local, "
2753          "non-imported submodule?");
2754 }
2755 
2756 void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
2757                                               bool isModule) {
2758   llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64>
2759       DiagStateIDMap;
2760   unsigned CurrID = 0;
2761   RecordData Record;
2762 
2763   auto EncodeDiagStateFlags =
2764       [](const DiagnosticsEngine::DiagState *DS) -> unsigned {
2765     unsigned Result = (unsigned)DS->ExtBehavior;
2766     for (unsigned Val :
2767          {(unsigned)DS->IgnoreAllWarnings, (unsigned)DS->EnableAllWarnings,
2768           (unsigned)DS->WarningsAsErrors, (unsigned)DS->ErrorsAsFatal,
2769           (unsigned)DS->SuppressSystemWarnings})
2770       Result = (Result << 1) | Val;
2771     return Result;
2772   };
2773 
2774   unsigned Flags = EncodeDiagStateFlags(Diag.DiagStatesByLoc.FirstDiagState);
2775   Record.push_back(Flags);
2776 
2777   auto AddDiagState = [&](const DiagnosticsEngine::DiagState *State,
2778                           bool IncludeNonPragmaStates) {
2779     // Ensure that the diagnostic state wasn't modified since it was created.
2780     // We will not correctly round-trip this information otherwise.
2781     assert(Flags == EncodeDiagStateFlags(State) &&
2782            "diag state flags vary in single AST file");
2783 
2784     unsigned &DiagStateID = DiagStateIDMap[State];
2785     Record.push_back(DiagStateID);
2786 
2787     if (DiagStateID == 0) {
2788       DiagStateID = ++CurrID;
2789 
2790       // Add a placeholder for the number of mappings.
2791       auto SizeIdx = Record.size();
2792       Record.emplace_back();
2793       for (const auto &I : *State) {
2794         if (I.second.isPragma() || IncludeNonPragmaStates) {
2795           Record.push_back(I.first);
2796           Record.push_back(I.second.serialize());
2797         }
2798       }
2799       // Update the placeholder.
2800       Record[SizeIdx] = (Record.size() - SizeIdx) / 2;
2801     }
2802   };
2803 
2804   AddDiagState(Diag.DiagStatesByLoc.FirstDiagState, isModule);
2805 
2806   // Reserve a spot for the number of locations with state transitions.
2807   auto NumLocationsIdx = Record.size();
2808   Record.emplace_back();
2809 
2810   // Emit the state transitions.
2811   unsigned NumLocations = 0;
2812   for (auto &FileIDAndFile : Diag.DiagStatesByLoc.Files) {
2813     if (!FileIDAndFile.first.isValid() ||
2814         !FileIDAndFile.second.HasLocalTransitions)
2815       continue;
2816     ++NumLocations;
2817 
2818     SourceLocation Loc = Diag.SourceMgr->getComposedLoc(FileIDAndFile.first, 0);
2819     assert(!Loc.isInvalid() && "start loc for valid FileID is invalid");
2820     AddSourceLocation(Loc, Record);
2821 
2822     Record.push_back(FileIDAndFile.second.StateTransitions.size());
2823     for (auto &StatePoint : FileIDAndFile.second.StateTransitions) {
2824       Record.push_back(StatePoint.Offset);
2825       AddDiagState(StatePoint.State, false);
2826     }
2827   }
2828 
2829   // Backpatch the number of locations.
2830   Record[NumLocationsIdx] = NumLocations;
2831 
2832   // Emit CurDiagStateLoc.  Do it last in order to match source order.
2833   //
2834   // This also protects against a hypothetical corner case with simulating
2835   // -Werror settings for implicit modules in the ASTReader, where reading
2836   // CurDiagState out of context could change whether warning pragmas are
2837   // treated as errors.
2838   AddSourceLocation(Diag.DiagStatesByLoc.CurDiagStateLoc, Record);
2839   AddDiagState(Diag.DiagStatesByLoc.CurDiagState, false);
2840 
2841   Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record);
2842 }
2843 
2844 //===----------------------------------------------------------------------===//
2845 // Type Serialization
2846 //===----------------------------------------------------------------------===//
2847 
2848 /// Write the representation of a type to the AST stream.
2849 void ASTWriter::WriteType(QualType T) {
2850   TypeIdx &IdxRef = TypeIdxs[T];
2851   if (IdxRef.getIndex() == 0) // we haven't seen this type before.
2852     IdxRef = TypeIdx(NextTypeID++);
2853   TypeIdx Idx = IdxRef;
2854 
2855   assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
2856 
2857   // Emit the type's representation.
2858   uint64_t Offset = ASTTypeWriter(*this).write(T) - DeclTypesBlockStartOffset;
2859 
2860   // Record the offset for this type.
2861   unsigned Index = Idx.getIndex() - FirstTypeID;
2862   if (TypeOffsets.size() == Index)
2863     TypeOffsets.emplace_back(Offset);
2864   else if (TypeOffsets.size() < Index) {
2865     TypeOffsets.resize(Index + 1);
2866     TypeOffsets[Index].setBitOffset(Offset);
2867   } else {
2868     llvm_unreachable("Types emitted in wrong order");
2869   }
2870 }
2871 
2872 //===----------------------------------------------------------------------===//
2873 // Declaration Serialization
2874 //===----------------------------------------------------------------------===//
2875 
2876 /// Write the block containing all of the declaration IDs
2877 /// lexically declared within the given DeclContext.
2878 ///
2879 /// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
2880 /// bitstream, or 0 if no block was written.
2881 uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
2882                                                  DeclContext *DC) {
2883   if (DC->decls_empty())
2884     return 0;
2885 
2886   uint64_t Offset = Stream.GetCurrentBitNo();
2887   SmallVector<uint32_t, 128> KindDeclPairs;
2888   for (const auto *D : DC->decls()) {
2889     KindDeclPairs.push_back(D->getKind());
2890     KindDeclPairs.push_back(GetDeclRef(D));
2891   }
2892 
2893   ++NumLexicalDeclContexts;
2894   RecordData::value_type Record[] = {DECL_CONTEXT_LEXICAL};
2895   Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record,
2896                             bytes(KindDeclPairs));
2897   return Offset;
2898 }
2899 
2900 void ASTWriter::WriteTypeDeclOffsets() {
2901   using namespace llvm;
2902 
2903   // Write the type offsets array
2904   auto Abbrev = std::make_shared<BitCodeAbbrev>();
2905   Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
2906   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
2907   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index
2908   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
2909   unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2910   {
2911     RecordData::value_type Record[] = {TYPE_OFFSET, TypeOffsets.size(),
2912                                        FirstTypeID - NUM_PREDEF_TYPE_IDS};
2913     Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, bytes(TypeOffsets));
2914   }
2915 
2916   // Write the declaration offsets array
2917   Abbrev = std::make_shared<BitCodeAbbrev>();
2918   Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
2919   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
2920   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID
2921   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
2922   unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2923   {
2924     RecordData::value_type Record[] = {DECL_OFFSET, DeclOffsets.size(),
2925                                        FirstDeclID - NUM_PREDEF_DECL_IDS};
2926     Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, bytes(DeclOffsets));
2927   }
2928 }
2929 
2930 void ASTWriter::WriteFileDeclIDsMap() {
2931   using namespace llvm;
2932 
2933   SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs;
2934   SortedFileDeclIDs.reserve(FileDeclIDs.size());
2935   for (const auto &P : FileDeclIDs)
2936     SortedFileDeclIDs.push_back(std::make_pair(P.first, P.second.get()));
2937   llvm::sort(SortedFileDeclIDs, llvm::less_first());
2938 
2939   // Join the vectors of DeclIDs from all files.
2940   SmallVector<DeclID, 256> FileGroupedDeclIDs;
2941   for (auto &FileDeclEntry : SortedFileDeclIDs) {
2942     DeclIDInFileInfo &Info = *FileDeclEntry.second;
2943     Info.FirstDeclIndex = FileGroupedDeclIDs.size();
2944     for (auto &LocDeclEntry : Info.DeclIDs)
2945       FileGroupedDeclIDs.push_back(LocDeclEntry.second);
2946   }
2947 
2948   auto Abbrev = std::make_shared<BitCodeAbbrev>();
2949   Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
2950   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2951   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2952   unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
2953   RecordData::value_type Record[] = {FILE_SORTED_DECLS,
2954                                      FileGroupedDeclIDs.size()};
2955   Stream.EmitRecordWithBlob(AbbrevCode, Record, bytes(FileGroupedDeclIDs));
2956 }
2957 
2958 void ASTWriter::WriteComments() {
2959   Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3);
2960   auto _ = llvm::make_scope_exit([this] { Stream.ExitBlock(); });
2961   if (!PP->getPreprocessorOpts().WriteCommentListToPCH)
2962     return;
2963   RecordData Record;
2964   for (const auto &FO : Context->Comments.OrderedComments) {
2965     for (const auto &OC : FO.second) {
2966       const RawComment *I = OC.second;
2967       Record.clear();
2968       AddSourceRange(I->getSourceRange(), Record);
2969       Record.push_back(I->getKind());
2970       Record.push_back(I->isTrailingComment());
2971       Record.push_back(I->isAlmostTrailingComment());
2972       Stream.EmitRecord(COMMENTS_RAW_COMMENT, Record);
2973     }
2974   }
2975 }
2976 
2977 //===----------------------------------------------------------------------===//
2978 // Global Method Pool and Selector Serialization
2979 //===----------------------------------------------------------------------===//
2980 
2981 namespace {
2982 
2983 // Trait used for the on-disk hash table used in the method pool.
2984 class ASTMethodPoolTrait {
2985   ASTWriter &Writer;
2986 
2987 public:
2988   using key_type = Selector;
2989   using key_type_ref = key_type;
2990 
2991   struct data_type {
2992     SelectorID ID;
2993     ObjCMethodList Instance, Factory;
2994   };
2995   using data_type_ref = const data_type &;
2996 
2997   using hash_value_type = unsigned;
2998   using offset_type = unsigned;
2999 
3000   explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) {}
3001 
3002   static hash_value_type ComputeHash(Selector Sel) {
3003     return serialization::ComputeHash(Sel);
3004   }
3005 
3006   std::pair<unsigned, unsigned>
3007     EmitKeyDataLength(raw_ostream& Out, Selector Sel,
3008                       data_type_ref Methods) {
3009     using namespace llvm::support;
3010 
3011     endian::Writer LE(Out, little);
3012     unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
3013     LE.write<uint16_t>(KeyLen);
3014     unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
3015     for (const ObjCMethodList *Method = &Methods.Instance; Method;
3016          Method = Method->getNext())
3017       if (Method->getMethod())
3018         DataLen += 4;
3019     for (const ObjCMethodList *Method = &Methods.Factory; Method;
3020          Method = Method->getNext())
3021       if (Method->getMethod())
3022         DataLen += 4;
3023     LE.write<uint16_t>(DataLen);
3024     return std::make_pair(KeyLen, DataLen);
3025   }
3026 
3027   void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
3028     using namespace llvm::support;
3029 
3030     endian::Writer LE(Out, little);
3031     uint64_t Start = Out.tell();
3032     assert((Start >> 32) == 0 && "Selector key offset too large");
3033     Writer.SetSelectorOffset(Sel, Start);
3034     unsigned N = Sel.getNumArgs();
3035     LE.write<uint16_t>(N);
3036     if (N == 0)
3037       N = 1;
3038     for (unsigned I = 0; I != N; ++I)
3039       LE.write<uint32_t>(
3040           Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
3041   }
3042 
3043   void EmitData(raw_ostream& Out, key_type_ref,
3044                 data_type_ref Methods, unsigned DataLen) {
3045     using namespace llvm::support;
3046 
3047     endian::Writer LE(Out, little);
3048     uint64_t Start = Out.tell(); (void)Start;
3049     LE.write<uint32_t>(Methods.ID);
3050     unsigned NumInstanceMethods = 0;
3051     for (const ObjCMethodList *Method = &Methods.Instance; Method;
3052          Method = Method->getNext())
3053       if (Method->getMethod())
3054         ++NumInstanceMethods;
3055 
3056     unsigned NumFactoryMethods = 0;
3057     for (const ObjCMethodList *Method = &Methods.Factory; Method;
3058          Method = Method->getNext())
3059       if (Method->getMethod())
3060         ++NumFactoryMethods;
3061 
3062     unsigned InstanceBits = Methods.Instance.getBits();
3063     assert(InstanceBits < 4);
3064     unsigned InstanceHasMoreThanOneDeclBit =
3065         Methods.Instance.hasMoreThanOneDecl();
3066     unsigned FullInstanceBits = (NumInstanceMethods << 3) |
3067                                 (InstanceHasMoreThanOneDeclBit << 2) |
3068                                 InstanceBits;
3069     unsigned FactoryBits = Methods.Factory.getBits();
3070     assert(FactoryBits < 4);
3071     unsigned FactoryHasMoreThanOneDeclBit =
3072         Methods.Factory.hasMoreThanOneDecl();
3073     unsigned FullFactoryBits = (NumFactoryMethods << 3) |
3074                                (FactoryHasMoreThanOneDeclBit << 2) |
3075                                FactoryBits;
3076     LE.write<uint16_t>(FullInstanceBits);
3077     LE.write<uint16_t>(FullFactoryBits);
3078     for (const ObjCMethodList *Method = &Methods.Instance; Method;
3079          Method = Method->getNext())
3080       if (Method->getMethod())
3081         LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
3082     for (const ObjCMethodList *Method = &Methods.Factory; Method;
3083          Method = Method->getNext())
3084       if (Method->getMethod())
3085         LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
3086 
3087     assert(Out.tell() - Start == DataLen && "Data length is wrong");
3088   }
3089 };
3090 
3091 } // namespace
3092 
3093 /// Write ObjC data: selectors and the method pool.
3094 ///
3095 /// The method pool contains both instance and factory methods, stored
3096 /// in an on-disk hash table indexed by the selector. The hash table also
3097 /// contains an empty entry for every other selector known to Sema.
3098 void ASTWriter::WriteSelectors(Sema &SemaRef) {
3099   using namespace llvm;
3100 
3101   // Do we have to do anything at all?
3102   if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
3103     return;
3104   unsigned NumTableEntries = 0;
3105   // Create and write out the blob that contains selectors and the method pool.
3106   {
3107     llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
3108     ASTMethodPoolTrait Trait(*this);
3109 
3110     // Create the on-disk hash table representation. We walk through every
3111     // selector we've seen and look it up in the method pool.
3112     SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
3113     for (auto &SelectorAndID : SelectorIDs) {
3114       Selector S = SelectorAndID.first;
3115       SelectorID ID = SelectorAndID.second;
3116       Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
3117       ASTMethodPoolTrait::data_type Data = {
3118         ID,
3119         ObjCMethodList(),
3120         ObjCMethodList()
3121       };
3122       if (F != SemaRef.MethodPool.end()) {
3123         Data.Instance = F->second.first;
3124         Data.Factory = F->second.second;
3125       }
3126       // Only write this selector if it's not in an existing AST or something
3127       // changed.
3128       if (Chain && ID < FirstSelectorID) {
3129         // Selector already exists. Did it change?
3130         bool changed = false;
3131         for (ObjCMethodList *M = &Data.Instance;
3132              !changed && M && M->getMethod(); M = M->getNext()) {
3133           if (!M->getMethod()->isFromASTFile())
3134             changed = true;
3135         }
3136         for (ObjCMethodList *M = &Data.Factory; !changed && M && M->getMethod();
3137              M = M->getNext()) {
3138           if (!M->getMethod()->isFromASTFile())
3139             changed = true;
3140         }
3141         if (!changed)
3142           continue;
3143       } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) {
3144         // A new method pool entry.
3145         ++NumTableEntries;
3146       }
3147       Generator.insert(S, Data, Trait);
3148     }
3149 
3150     // Create the on-disk hash table in a buffer.
3151     SmallString<4096> MethodPool;
3152     uint32_t BucketOffset;
3153     {
3154       using namespace llvm::support;
3155 
3156       ASTMethodPoolTrait Trait(*this);
3157       llvm::raw_svector_ostream Out(MethodPool);
3158       // Make sure that no bucket is at offset 0
3159       endian::write<uint32_t>(Out, 0, little);
3160       BucketOffset = Generator.Emit(Out, Trait);
3161     }
3162 
3163     // Create a blob abbreviation
3164     auto Abbrev = std::make_shared<BitCodeAbbrev>();
3165     Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
3166     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
3167     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
3168     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3169     unsigned MethodPoolAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3170 
3171     // Write the method pool
3172     {
3173       RecordData::value_type Record[] = {METHOD_POOL, BucketOffset,
3174                                          NumTableEntries};
3175       Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool);
3176     }
3177 
3178     // Create a blob abbreviation for the selector table offsets.
3179     Abbrev = std::make_shared<BitCodeAbbrev>();
3180     Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
3181     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
3182     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
3183     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3184     unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3185 
3186     // Write the selector offsets table.
3187     {
3188       RecordData::value_type Record[] = {
3189           SELECTOR_OFFSETS, SelectorOffsets.size(),
3190           FirstSelectorID - NUM_PREDEF_SELECTOR_IDS};
3191       Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
3192                                 bytes(SelectorOffsets));
3193     }
3194   }
3195 }
3196 
3197 /// Write the selectors referenced in @selector expression into AST file.
3198 void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
3199   using namespace llvm;
3200 
3201   if (SemaRef.ReferencedSelectors.empty())
3202     return;
3203 
3204   RecordData Record;
3205   ASTRecordWriter Writer(*this, Record);
3206 
3207   // Note: this writes out all references even for a dependent AST. But it is
3208   // very tricky to fix, and given that @selector shouldn't really appear in
3209   // headers, probably not worth it. It's not a correctness issue.
3210   for (auto &SelectorAndLocation : SemaRef.ReferencedSelectors) {
3211     Selector Sel = SelectorAndLocation.first;
3212     SourceLocation Loc = SelectorAndLocation.second;
3213     Writer.AddSelectorRef(Sel);
3214     Writer.AddSourceLocation(Loc);
3215   }
3216   Writer.Emit(REFERENCED_SELECTOR_POOL);
3217 }
3218 
3219 //===----------------------------------------------------------------------===//
3220 // Identifier Table Serialization
3221 //===----------------------------------------------------------------------===//
3222 
3223 /// Determine the declaration that should be put into the name lookup table to
3224 /// represent the given declaration in this module. This is usually D itself,
3225 /// but if D was imported and merged into a local declaration, we want the most
3226 /// recent local declaration instead. The chosen declaration will be the most
3227 /// recent declaration in any module that imports this one.
3228 static NamedDecl *getDeclForLocalLookup(const LangOptions &LangOpts,
3229                                         NamedDecl *D) {
3230   if (!LangOpts.Modules || !D->isFromASTFile())
3231     return D;
3232 
3233   if (Decl *Redecl = D->getPreviousDecl()) {
3234     // For Redeclarable decls, a prior declaration might be local.
3235     for (; Redecl; Redecl = Redecl->getPreviousDecl()) {
3236       // If we find a local decl, we're done.
3237       if (!Redecl->isFromASTFile()) {
3238         // Exception: in very rare cases (for injected-class-names), not all
3239         // redeclarations are in the same semantic context. Skip ones in a
3240         // different context. They don't go in this lookup table at all.
3241         if (!Redecl->getDeclContext()->getRedeclContext()->Equals(
3242                 D->getDeclContext()->getRedeclContext()))
3243           continue;
3244         return cast<NamedDecl>(Redecl);
3245       }
3246 
3247       // If we find a decl from a (chained-)PCH stop since we won't find a
3248       // local one.
3249       if (Redecl->getOwningModuleID() == 0)
3250         break;
3251     }
3252   } else if (Decl *First = D->getCanonicalDecl()) {
3253     // For Mergeable decls, the first decl might be local.
3254     if (!First->isFromASTFile())
3255       return cast<NamedDecl>(First);
3256   }
3257 
3258   // All declarations are imported. Our most recent declaration will also be
3259   // the most recent one in anyone who imports us.
3260   return D;
3261 }
3262 
3263 namespace {
3264 
3265 class ASTIdentifierTableTrait {
3266   ASTWriter &Writer;
3267   Preprocessor &PP;
3268   IdentifierResolver &IdResolver;
3269   bool IsModule;
3270   bool NeedDecls;
3271   ASTWriter::RecordData *InterestingIdentifierOffsets;
3272 
3273   /// Determines whether this is an "interesting" identifier that needs a
3274   /// full IdentifierInfo structure written into the hash table. Notably, this
3275   /// doesn't check whether the name has macros defined; use PublicMacroIterator
3276   /// to check that.
3277   bool isInterestingIdentifier(const IdentifierInfo *II, uint64_t MacroOffset) {
3278     if (MacroOffset ||
3279         II->isPoisoned() ||
3280         (IsModule ? II->hasRevertedBuiltin() : II->getObjCOrBuiltinID()) ||
3281         II->hasRevertedTokenIDToIdentifier() ||
3282         (NeedDecls && II->getFETokenInfo()))
3283       return true;
3284 
3285     return false;
3286   }
3287 
3288 public:
3289   using key_type = IdentifierInfo *;
3290   using key_type_ref = key_type;
3291 
3292   using data_type = IdentID;
3293   using data_type_ref = data_type;
3294 
3295   using hash_value_type = unsigned;
3296   using offset_type = unsigned;
3297 
3298   ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
3299                           IdentifierResolver &IdResolver, bool IsModule,
3300                           ASTWriter::RecordData *InterestingIdentifierOffsets)
3301       : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule),
3302         NeedDecls(!IsModule || !Writer.getLangOpts().CPlusPlus),
3303         InterestingIdentifierOffsets(InterestingIdentifierOffsets) {}
3304 
3305   bool needDecls() const { return NeedDecls; }
3306 
3307   static hash_value_type ComputeHash(const IdentifierInfo* II) {
3308     return llvm::djbHash(II->getName());
3309   }
3310 
3311   bool isInterestingIdentifier(const IdentifierInfo *II) {
3312     auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3313     return isInterestingIdentifier(II, MacroOffset);
3314   }
3315 
3316   bool isInterestingNonMacroIdentifier(const IdentifierInfo *II) {
3317     return isInterestingIdentifier(II, 0);
3318   }
3319 
3320   std::pair<unsigned, unsigned>
3321   EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) {
3322     unsigned KeyLen = II->getLength() + 1;
3323     unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
3324     auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3325     if (isInterestingIdentifier(II, MacroOffset)) {
3326       DataLen += 2; // 2 bytes for builtin ID
3327       DataLen += 2; // 2 bytes for flags
3328       if (MacroOffset)
3329         DataLen += 4; // MacroDirectives offset.
3330 
3331       if (NeedDecls) {
3332         for (IdentifierResolver::iterator D = IdResolver.begin(II),
3333                                        DEnd = IdResolver.end();
3334              D != DEnd; ++D)
3335           DataLen += 4;
3336       }
3337     }
3338 
3339     using namespace llvm::support;
3340 
3341     endian::Writer LE(Out, little);
3342 
3343     assert((uint16_t)DataLen == DataLen && (uint16_t)KeyLen == KeyLen);
3344     LE.write<uint16_t>(DataLen);
3345     // We emit the key length after the data length so that every
3346     // string is preceded by a 16-bit length. This matches the PTH
3347     // format for storing identifiers.
3348     LE.write<uint16_t>(KeyLen);
3349     return std::make_pair(KeyLen, DataLen);
3350   }
3351 
3352   void EmitKey(raw_ostream& Out, const IdentifierInfo* II,
3353                unsigned KeyLen) {
3354     // Record the location of the key data.  This is used when generating
3355     // the mapping from persistent IDs to strings.
3356     Writer.SetIdentifierOffset(II, Out.tell());
3357 
3358     // Emit the offset of the key/data length information to the interesting
3359     // identifiers table if necessary.
3360     if (InterestingIdentifierOffsets && isInterestingIdentifier(II))
3361       InterestingIdentifierOffsets->push_back(Out.tell() - 4);
3362 
3363     Out.write(II->getNameStart(), KeyLen);
3364   }
3365 
3366   void EmitData(raw_ostream& Out, IdentifierInfo* II,
3367                 IdentID ID, unsigned) {
3368     using namespace llvm::support;
3369 
3370     endian::Writer LE(Out, little);
3371 
3372     auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3373     if (!isInterestingIdentifier(II, MacroOffset)) {
3374       LE.write<uint32_t>(ID << 1);
3375       return;
3376     }
3377 
3378     LE.write<uint32_t>((ID << 1) | 0x01);
3379     uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID();
3380     assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
3381     LE.write<uint16_t>(Bits);
3382     Bits = 0;
3383     bool HadMacroDefinition = MacroOffset != 0;
3384     Bits = (Bits << 1) | unsigned(HadMacroDefinition);
3385     Bits = (Bits << 1) | unsigned(II->isExtensionToken());
3386     Bits = (Bits << 1) | unsigned(II->isPoisoned());
3387     Bits = (Bits << 1) | unsigned(II->hasRevertedBuiltin());
3388     Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
3389     Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
3390     LE.write<uint16_t>(Bits);
3391 
3392     if (HadMacroDefinition)
3393       LE.write<uint32_t>(MacroOffset);
3394 
3395     if (NeedDecls) {
3396       // Emit the declaration IDs in reverse order, because the
3397       // IdentifierResolver provides the declarations as they would be
3398       // visible (e.g., the function "stat" would come before the struct
3399       // "stat"), but the ASTReader adds declarations to the end of the list
3400       // (so we need to see the struct "stat" before the function "stat").
3401       // Only emit declarations that aren't from a chained PCH, though.
3402       SmallVector<NamedDecl *, 16> Decls(IdResolver.begin(II),
3403                                          IdResolver.end());
3404       for (SmallVectorImpl<NamedDecl *>::reverse_iterator D = Decls.rbegin(),
3405                                                           DEnd = Decls.rend();
3406            D != DEnd; ++D)
3407         LE.write<uint32_t>(
3408             Writer.getDeclID(getDeclForLocalLookup(PP.getLangOpts(), *D)));
3409     }
3410   }
3411 };
3412 
3413 } // namespace
3414 
3415 /// Write the identifier table into the AST file.
3416 ///
3417 /// The identifier table consists of a blob containing string data
3418 /// (the actual identifiers themselves) and a separate "offsets" index
3419 /// that maps identifier IDs to locations within the blob.
3420 void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
3421                                      IdentifierResolver &IdResolver,
3422                                      bool IsModule) {
3423   using namespace llvm;
3424 
3425   RecordData InterestingIdents;
3426 
3427   // Create and write out the blob that contains the identifier
3428   // strings.
3429   {
3430     llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
3431     ASTIdentifierTableTrait Trait(
3432         *this, PP, IdResolver, IsModule,
3433         (getLangOpts().CPlusPlus && IsModule) ? &InterestingIdents : nullptr);
3434 
3435     // Look for any identifiers that were named while processing the
3436     // headers, but are otherwise not needed. We add these to the hash
3437     // table to enable checking of the predefines buffer in the case
3438     // where the user adds new macro definitions when building the AST
3439     // file.
3440     SmallVector<const IdentifierInfo *, 128> IIs;
3441     for (const auto &ID : PP.getIdentifierTable())
3442       IIs.push_back(ID.second);
3443     // Sort the identifiers lexicographically before getting them references so
3444     // that their order is stable.
3445     llvm::sort(IIs, llvm::deref<std::less<>>());
3446     for (const IdentifierInfo *II : IIs)
3447       if (Trait.isInterestingNonMacroIdentifier(II))
3448         getIdentifierRef(II);
3449 
3450     // Create the on-disk hash table representation. We only store offsets
3451     // for identifiers that appear here for the first time.
3452     IdentifierOffsets.resize(NextIdentID - FirstIdentID);
3453     for (auto IdentIDPair : IdentifierIDs) {
3454       auto *II = const_cast<IdentifierInfo *>(IdentIDPair.first);
3455       IdentID ID = IdentIDPair.second;
3456       assert(II && "NULL identifier in identifier table");
3457       // Write out identifiers if either the ID is local or the identifier has
3458       // changed since it was loaded.
3459       if (ID >= FirstIdentID || !Chain || !II->isFromAST()
3460           || II->hasChangedSinceDeserialization() ||
3461           (Trait.needDecls() &&
3462            II->hasFETokenInfoChangedSinceDeserialization()))
3463         Generator.insert(II, ID, Trait);
3464     }
3465 
3466     // Create the on-disk hash table in a buffer.
3467     SmallString<4096> IdentifierTable;
3468     uint32_t BucketOffset;
3469     {
3470       using namespace llvm::support;
3471 
3472       llvm::raw_svector_ostream Out(IdentifierTable);
3473       // Make sure that no bucket is at offset 0
3474       endian::write<uint32_t>(Out, 0, little);
3475       BucketOffset = Generator.Emit(Out, Trait);
3476     }
3477 
3478     // Create a blob abbreviation
3479     auto Abbrev = std::make_shared<BitCodeAbbrev>();
3480     Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
3481     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
3482     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3483     unsigned IDTableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3484 
3485     // Write the identifier table
3486     RecordData::value_type Record[] = {IDENTIFIER_TABLE, BucketOffset};
3487     Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable);
3488   }
3489 
3490   // Write the offsets table for identifier IDs.
3491   auto Abbrev = std::make_shared<BitCodeAbbrev>();
3492   Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
3493   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
3494   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
3495   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3496   unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
3497 
3498 #ifndef NDEBUG
3499   for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I)
3500     assert(IdentifierOffsets[I] && "Missing identifier offset?");
3501 #endif
3502 
3503   RecordData::value_type Record[] = {IDENTIFIER_OFFSET,
3504                                      IdentifierOffsets.size(),
3505                                      FirstIdentID - NUM_PREDEF_IDENT_IDS};
3506   Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
3507                             bytes(IdentifierOffsets));
3508 
3509   // In C++, write the list of interesting identifiers (those that are
3510   // defined as macros, poisoned, or similar unusual things).
3511   if (!InterestingIdents.empty())
3512     Stream.EmitRecord(INTERESTING_IDENTIFIERS, InterestingIdents);
3513 }
3514 
3515 //===----------------------------------------------------------------------===//
3516 // DeclContext's Name Lookup Table Serialization
3517 //===----------------------------------------------------------------------===//
3518 
3519 namespace {
3520 
3521 // Trait used for the on-disk hash table used in the method pool.
3522 class ASTDeclContextNameLookupTrait {
3523   ASTWriter &Writer;
3524   llvm::SmallVector<DeclID, 64> DeclIDs;
3525 
3526 public:
3527   using key_type = DeclarationNameKey;
3528   using key_type_ref = key_type;
3529 
3530   /// A start and end index into DeclIDs, representing a sequence of decls.
3531   using data_type = std::pair<unsigned, unsigned>;
3532   using data_type_ref = const data_type &;
3533 
3534   using hash_value_type = unsigned;
3535   using offset_type = unsigned;
3536 
3537   explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) {}
3538 
3539   template<typename Coll>
3540   data_type getData(const Coll &Decls) {
3541     unsigned Start = DeclIDs.size();
3542     for (NamedDecl *D : Decls) {
3543       DeclIDs.push_back(
3544           Writer.GetDeclRef(getDeclForLocalLookup(Writer.getLangOpts(), D)));
3545     }
3546     return std::make_pair(Start, DeclIDs.size());
3547   }
3548 
3549   data_type ImportData(const reader::ASTDeclContextNameLookupTrait::data_type &FromReader) {
3550     unsigned Start = DeclIDs.size();
3551     for (auto ID : FromReader)
3552       DeclIDs.push_back(ID);
3553     return std::make_pair(Start, DeclIDs.size());
3554   }
3555 
3556   static bool EqualKey(key_type_ref a, key_type_ref b) {
3557     return a == b;
3558   }
3559 
3560   hash_value_type ComputeHash(DeclarationNameKey Name) {
3561     return Name.getHash();
3562   }
3563 
3564   void EmitFileRef(raw_ostream &Out, ModuleFile *F) const {
3565     assert(Writer.hasChain() &&
3566            "have reference to loaded module file but no chain?");
3567 
3568     using namespace llvm::support;
3569 
3570     endian::write<uint32_t>(Out, Writer.getChain()->getModuleFileID(F), little);
3571   }
3572 
3573   std::pair<unsigned, unsigned> EmitKeyDataLength(raw_ostream &Out,
3574                                                   DeclarationNameKey Name,
3575                                                   data_type_ref Lookup) {
3576     using namespace llvm::support;
3577 
3578     endian::Writer LE(Out, little);
3579     unsigned KeyLen = 1;
3580     switch (Name.getKind()) {
3581     case DeclarationName::Identifier:
3582     case DeclarationName::ObjCZeroArgSelector:
3583     case DeclarationName::ObjCOneArgSelector:
3584     case DeclarationName::ObjCMultiArgSelector:
3585     case DeclarationName::CXXLiteralOperatorName:
3586     case DeclarationName::CXXDeductionGuideName:
3587       KeyLen += 4;
3588       break;
3589     case DeclarationName::CXXOperatorName:
3590       KeyLen += 1;
3591       break;
3592     case DeclarationName::CXXConstructorName:
3593     case DeclarationName::CXXDestructorName:
3594     case DeclarationName::CXXConversionFunctionName:
3595     case DeclarationName::CXXUsingDirective:
3596       break;
3597     }
3598     LE.write<uint16_t>(KeyLen);
3599 
3600     // 4 bytes for each DeclID.
3601     unsigned DataLen = 4 * (Lookup.second - Lookup.first);
3602     assert(uint16_t(DataLen) == DataLen &&
3603            "too many decls for serialized lookup result");
3604     LE.write<uint16_t>(DataLen);
3605 
3606     return std::make_pair(KeyLen, DataLen);
3607   }
3608 
3609   void EmitKey(raw_ostream &Out, DeclarationNameKey Name, unsigned) {
3610     using namespace llvm::support;
3611 
3612     endian::Writer LE(Out, little);
3613     LE.write<uint8_t>(Name.getKind());
3614     switch (Name.getKind()) {
3615     case DeclarationName::Identifier:
3616     case DeclarationName::CXXLiteralOperatorName:
3617     case DeclarationName::CXXDeductionGuideName:
3618       LE.write<uint32_t>(Writer.getIdentifierRef(Name.getIdentifier()));
3619       return;
3620     case DeclarationName::ObjCZeroArgSelector:
3621     case DeclarationName::ObjCOneArgSelector:
3622     case DeclarationName::ObjCMultiArgSelector:
3623       LE.write<uint32_t>(Writer.getSelectorRef(Name.getSelector()));
3624       return;
3625     case DeclarationName::CXXOperatorName:
3626       assert(Name.getOperatorKind() < NUM_OVERLOADED_OPERATORS &&
3627              "Invalid operator?");
3628       LE.write<uint8_t>(Name.getOperatorKind());
3629       return;
3630     case DeclarationName::CXXConstructorName:
3631     case DeclarationName::CXXDestructorName:
3632     case DeclarationName::CXXConversionFunctionName:
3633     case DeclarationName::CXXUsingDirective:
3634       return;
3635     }
3636 
3637     llvm_unreachable("Invalid name kind?");
3638   }
3639 
3640   void EmitData(raw_ostream &Out, key_type_ref, data_type Lookup,
3641                 unsigned DataLen) {
3642     using namespace llvm::support;
3643 
3644     endian::Writer LE(Out, little);
3645     uint64_t Start = Out.tell(); (void)Start;
3646     for (unsigned I = Lookup.first, N = Lookup.second; I != N; ++I)
3647       LE.write<uint32_t>(DeclIDs[I]);
3648     assert(Out.tell() - Start == DataLen && "Data length is wrong");
3649   }
3650 };
3651 
3652 } // namespace
3653 
3654 bool ASTWriter::isLookupResultExternal(StoredDeclsList &Result,
3655                                        DeclContext *DC) {
3656   return Result.hasExternalDecls() &&
3657          DC->hasNeedToReconcileExternalVisibleStorage();
3658 }
3659 
3660 bool ASTWriter::isLookupResultEntirelyExternal(StoredDeclsList &Result,
3661                                                DeclContext *DC) {
3662   for (auto *D : Result.getLookupResult())
3663     if (!getDeclForLocalLookup(getLangOpts(), D)->isFromASTFile())
3664       return false;
3665 
3666   return true;
3667 }
3668 
3669 void
3670 ASTWriter::GenerateNameLookupTable(const DeclContext *ConstDC,
3671                                    llvm::SmallVectorImpl<char> &LookupTable) {
3672   assert(!ConstDC->hasLazyLocalLexicalLookups() &&
3673          !ConstDC->hasLazyExternalLexicalLookups() &&
3674          "must call buildLookups first");
3675 
3676   // FIXME: We need to build the lookups table, which is logically const.
3677   auto *DC = const_cast<DeclContext*>(ConstDC);
3678   assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
3679 
3680   // Create the on-disk hash table representation.
3681   MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait,
3682                                 ASTDeclContextNameLookupTrait> Generator;
3683   ASTDeclContextNameLookupTrait Trait(*this);
3684 
3685   // The first step is to collect the declaration names which we need to
3686   // serialize into the name lookup table, and to collect them in a stable
3687   // order.
3688   SmallVector<DeclarationName, 16> Names;
3689 
3690   // We also build up small sets of the constructor and conversion function
3691   // names which are visible.
3692   llvm::SmallPtrSet<DeclarationName, 8> ConstructorNameSet, ConversionNameSet;
3693 
3694   for (auto &Lookup : *DC->buildLookup()) {
3695     auto &Name = Lookup.first;
3696     auto &Result = Lookup.second;
3697 
3698     // If there are no local declarations in our lookup result, we
3699     // don't need to write an entry for the name at all. If we can't
3700     // write out a lookup set without performing more deserialization,
3701     // just skip this entry.
3702     if (isLookupResultExternal(Result, DC) &&
3703         isLookupResultEntirelyExternal(Result, DC))
3704       continue;
3705 
3706     // We also skip empty results. If any of the results could be external and
3707     // the currently available results are empty, then all of the results are
3708     // external and we skip it above. So the only way we get here with an empty
3709     // results is when no results could have been external *and* we have
3710     // external results.
3711     //
3712     // FIXME: While we might want to start emitting on-disk entries for negative
3713     // lookups into a decl context as an optimization, today we *have* to skip
3714     // them because there are names with empty lookup results in decl contexts
3715     // which we can't emit in any stable ordering: we lookup constructors and
3716     // conversion functions in the enclosing namespace scope creating empty
3717     // results for them. This in almost certainly a bug in Clang's name lookup,
3718     // but that is likely to be hard or impossible to fix and so we tolerate it
3719     // here by omitting lookups with empty results.
3720     if (Lookup.second.getLookupResult().empty())
3721       continue;
3722 
3723     switch (Lookup.first.getNameKind()) {
3724     default:
3725       Names.push_back(Lookup.first);
3726       break;
3727 
3728     case DeclarationName::CXXConstructorName:
3729       assert(isa<CXXRecordDecl>(DC) &&
3730              "Cannot have a constructor name outside of a class!");
3731       ConstructorNameSet.insert(Name);
3732       break;
3733 
3734     case DeclarationName::CXXConversionFunctionName:
3735       assert(isa<CXXRecordDecl>(DC) &&
3736              "Cannot have a conversion function name outside of a class!");
3737       ConversionNameSet.insert(Name);
3738       break;
3739     }
3740   }
3741 
3742   // Sort the names into a stable order.
3743   llvm::sort(Names);
3744 
3745   if (auto *D = dyn_cast<CXXRecordDecl>(DC)) {
3746     // We need to establish an ordering of constructor and conversion function
3747     // names, and they don't have an intrinsic ordering.
3748 
3749     // First we try the easy case by forming the current context's constructor
3750     // name and adding that name first. This is a very useful optimization to
3751     // avoid walking the lexical declarations in many cases, and it also
3752     // handles the only case where a constructor name can come from some other
3753     // lexical context -- when that name is an implicit constructor merged from
3754     // another declaration in the redecl chain. Any non-implicit constructor or
3755     // conversion function which doesn't occur in all the lexical contexts
3756     // would be an ODR violation.
3757     auto ImplicitCtorName = Context->DeclarationNames.getCXXConstructorName(
3758         Context->getCanonicalType(Context->getRecordType(D)));
3759     if (ConstructorNameSet.erase(ImplicitCtorName))
3760       Names.push_back(ImplicitCtorName);
3761 
3762     // If we still have constructors or conversion functions, we walk all the
3763     // names in the decl and add the constructors and conversion functions
3764     // which are visible in the order they lexically occur within the context.
3765     if (!ConstructorNameSet.empty() || !ConversionNameSet.empty())
3766       for (Decl *ChildD : cast<CXXRecordDecl>(DC)->decls())
3767         if (auto *ChildND = dyn_cast<NamedDecl>(ChildD)) {
3768           auto Name = ChildND->getDeclName();
3769           switch (Name.getNameKind()) {
3770           default:
3771             continue;
3772 
3773           case DeclarationName::CXXConstructorName:
3774             if (ConstructorNameSet.erase(Name))
3775               Names.push_back(Name);
3776             break;
3777 
3778           case DeclarationName::CXXConversionFunctionName:
3779             if (ConversionNameSet.erase(Name))
3780               Names.push_back(Name);
3781             break;
3782           }
3783 
3784           if (ConstructorNameSet.empty() && ConversionNameSet.empty())
3785             break;
3786         }
3787 
3788     assert(ConstructorNameSet.empty() && "Failed to find all of the visible "
3789                                          "constructors by walking all the "
3790                                          "lexical members of the context.");
3791     assert(ConversionNameSet.empty() && "Failed to find all of the visible "
3792                                         "conversion functions by walking all "
3793                                         "the lexical members of the context.");
3794   }
3795 
3796   // Next we need to do a lookup with each name into this decl context to fully
3797   // populate any results from external sources. We don't actually use the
3798   // results of these lookups because we only want to use the results after all
3799   // results have been loaded and the pointers into them will be stable.
3800   for (auto &Name : Names)
3801     DC->lookup(Name);
3802 
3803   // Now we need to insert the results for each name into the hash table. For
3804   // constructor names and conversion function names, we actually need to merge
3805   // all of the results for them into one list of results each and insert
3806   // those.
3807   SmallVector<NamedDecl *, 8> ConstructorDecls;
3808   SmallVector<NamedDecl *, 8> ConversionDecls;
3809 
3810   // Now loop over the names, either inserting them or appending for the two
3811   // special cases.
3812   for (auto &Name : Names) {
3813     DeclContext::lookup_result Result = DC->noload_lookup(Name);
3814 
3815     switch (Name.getNameKind()) {
3816     default:
3817       Generator.insert(Name, Trait.getData(Result), Trait);
3818       break;
3819 
3820     case DeclarationName::CXXConstructorName:
3821       ConstructorDecls.append(Result.begin(), Result.end());
3822       break;
3823 
3824     case DeclarationName::CXXConversionFunctionName:
3825       ConversionDecls.append(Result.begin(), Result.end());
3826       break;
3827     }
3828   }
3829 
3830   // Handle our two special cases if we ended up having any. We arbitrarily use
3831   // the first declaration's name here because the name itself isn't part of
3832   // the key, only the kind of name is used.
3833   if (!ConstructorDecls.empty())
3834     Generator.insert(ConstructorDecls.front()->getDeclName(),
3835                      Trait.getData(ConstructorDecls), Trait);
3836   if (!ConversionDecls.empty())
3837     Generator.insert(ConversionDecls.front()->getDeclName(),
3838                      Trait.getData(ConversionDecls), Trait);
3839 
3840   // Create the on-disk hash table. Also emit the existing imported and
3841   // merged table if there is one.
3842   auto *Lookups = Chain ? Chain->getLoadedLookupTables(DC) : nullptr;
3843   Generator.emit(LookupTable, Trait, Lookups ? &Lookups->Table : nullptr);
3844 }
3845 
3846 /// Write the block containing all of the declaration IDs
3847 /// visible from the given DeclContext.
3848 ///
3849 /// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
3850 /// bitstream, or 0 if no block was written.
3851 uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
3852                                                  DeclContext *DC) {
3853   // If we imported a key declaration of this namespace, write the visible
3854   // lookup results as an update record for it rather than including them
3855   // on this declaration. We will only look at key declarations on reload.
3856   if (isa<NamespaceDecl>(DC) && Chain &&
3857       Chain->getKeyDeclaration(cast<Decl>(DC))->isFromASTFile()) {
3858     // Only do this once, for the first local declaration of the namespace.
3859     for (auto *Prev = cast<NamespaceDecl>(DC)->getPreviousDecl(); Prev;
3860          Prev = Prev->getPreviousDecl())
3861       if (!Prev->isFromASTFile())
3862         return 0;
3863 
3864     // Note that we need to emit an update record for the primary context.
3865     UpdatedDeclContexts.insert(DC->getPrimaryContext());
3866 
3867     // Make sure all visible decls are written. They will be recorded later. We
3868     // do this using a side data structure so we can sort the names into
3869     // a deterministic order.
3870     StoredDeclsMap *Map = DC->getPrimaryContext()->buildLookup();
3871     SmallVector<std::pair<DeclarationName, DeclContext::lookup_result>, 16>
3872         LookupResults;
3873     if (Map) {
3874       LookupResults.reserve(Map->size());
3875       for (auto &Entry : *Map)
3876         LookupResults.push_back(
3877             std::make_pair(Entry.first, Entry.second.getLookupResult()));
3878     }
3879 
3880     llvm::sort(LookupResults, llvm::less_first());
3881     for (auto &NameAndResult : LookupResults) {
3882       DeclarationName Name = NameAndResult.first;
3883       DeclContext::lookup_result Result = NameAndResult.second;
3884       if (Name.getNameKind() == DeclarationName::CXXConstructorName ||
3885           Name.getNameKind() == DeclarationName::CXXConversionFunctionName) {
3886         // We have to work around a name lookup bug here where negative lookup
3887         // results for these names get cached in namespace lookup tables (these
3888         // names should never be looked up in a namespace).
3889         assert(Result.empty() && "Cannot have a constructor or conversion "
3890                                  "function name in a namespace!");
3891         continue;
3892       }
3893 
3894       for (NamedDecl *ND : Result)
3895         if (!ND->isFromASTFile())
3896           GetDeclRef(ND);
3897     }
3898 
3899     return 0;
3900   }
3901 
3902   if (DC->getPrimaryContext() != DC)
3903     return 0;
3904 
3905   // Skip contexts which don't support name lookup.
3906   if (!DC->isLookupContext())
3907     return 0;
3908 
3909   // If not in C++, we perform name lookup for the translation unit via the
3910   // IdentifierInfo chains, don't bother to build a visible-declarations table.
3911   if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
3912     return 0;
3913 
3914   // Serialize the contents of the mapping used for lookup. Note that,
3915   // although we have two very different code paths, the serialized
3916   // representation is the same for both cases: a declaration name,
3917   // followed by a size, followed by references to the visible
3918   // declarations that have that name.
3919   uint64_t Offset = Stream.GetCurrentBitNo();
3920   StoredDeclsMap *Map = DC->buildLookup();
3921   if (!Map || Map->empty())
3922     return 0;
3923 
3924   // Create the on-disk hash table in a buffer.
3925   SmallString<4096> LookupTable;
3926   GenerateNameLookupTable(DC, LookupTable);
3927 
3928   // Write the lookup table
3929   RecordData::value_type Record[] = {DECL_CONTEXT_VISIBLE};
3930   Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
3931                             LookupTable);
3932   ++NumVisibleDeclContexts;
3933   return Offset;
3934 }
3935 
3936 /// Write an UPDATE_VISIBLE block for the given context.
3937 ///
3938 /// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
3939 /// DeclContext in a dependent AST file. As such, they only exist for the TU
3940 /// (in C++), for namespaces, and for classes with forward-declared unscoped
3941 /// enumeration members (in C++11).
3942 void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
3943   StoredDeclsMap *Map = DC->getLookupPtr();
3944   if (!Map || Map->empty())
3945     return;
3946 
3947   // Create the on-disk hash table in a buffer.
3948   SmallString<4096> LookupTable;
3949   GenerateNameLookupTable(DC, LookupTable);
3950 
3951   // If we're updating a namespace, select a key declaration as the key for the
3952   // update record; those are the only ones that will be checked on reload.
3953   if (isa<NamespaceDecl>(DC))
3954     DC = cast<DeclContext>(Chain->getKeyDeclaration(cast<Decl>(DC)));
3955 
3956   // Write the lookup table
3957   RecordData::value_type Record[] = {UPDATE_VISIBLE, getDeclID(cast<Decl>(DC))};
3958   Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable);
3959 }
3960 
3961 /// Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
3962 void ASTWriter::WriteFPPragmaOptions(const FPOptionsOverride &Opts) {
3963   RecordData::value_type Record[] = {Opts.getAsOpaqueInt()};
3964   Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
3965 }
3966 
3967 /// Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
3968 void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
3969   if (!SemaRef.Context.getLangOpts().OpenCL)
3970     return;
3971 
3972   const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
3973   RecordData Record;
3974   for (const auto &I:Opts.OptMap) {
3975     AddString(I.getKey(), Record);
3976     auto V = I.getValue();
3977     Record.push_back(V.Supported ? 1 : 0);
3978     Record.push_back(V.Enabled ? 1 : 0);
3979     Record.push_back(V.Avail);
3980     Record.push_back(V.Core);
3981   }
3982   Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
3983 }
3984 
3985 void ASTWriter::WriteOpenCLExtensionTypes(Sema &SemaRef) {
3986   if (!SemaRef.Context.getLangOpts().OpenCL)
3987     return;
3988 
3989   // Sort the elements of the map OpenCLTypeExtMap by TypeIDs,
3990   // without copying them.
3991   const llvm::DenseMap<const Type *, std::set<std::string>> &OpenCLTypeExtMap =
3992       SemaRef.OpenCLTypeExtMap;
3993   using ElementTy = std::pair<TypeID, const std::set<std::string> *>;
3994   llvm::SmallVector<ElementTy, 8> StableOpenCLTypeExtMap;
3995   StableOpenCLTypeExtMap.reserve(OpenCLTypeExtMap.size());
3996 
3997   for (const auto &I : OpenCLTypeExtMap)
3998     StableOpenCLTypeExtMap.emplace_back(
3999         getTypeID(I.first->getCanonicalTypeInternal()), &I.second);
4000 
4001   auto CompareByTypeID = [](const ElementTy &E1, const ElementTy &E2) -> bool {
4002     return E1.first < E2.first;
4003   };
4004   llvm::sort(StableOpenCLTypeExtMap, CompareByTypeID);
4005 
4006   RecordData Record;
4007   for (const ElementTy &E : StableOpenCLTypeExtMap) {
4008     Record.push_back(E.first); // TypeID
4009     const std::set<std::string> *ExtSet = E.second;
4010     Record.push_back(static_cast<unsigned>(ExtSet->size()));
4011     for (const std::string &Ext : *ExtSet)
4012       AddString(Ext, Record);
4013   }
4014 
4015   Stream.EmitRecord(OPENCL_EXTENSION_TYPES, Record);
4016 }
4017 
4018 void ASTWriter::WriteOpenCLExtensionDecls(Sema &SemaRef) {
4019   if (!SemaRef.Context.getLangOpts().OpenCL)
4020     return;
4021 
4022   // Sort the elements of the map OpenCLDeclExtMap by DeclIDs,
4023   // without copying them.
4024   const llvm::DenseMap<const Decl *, std::set<std::string>> &OpenCLDeclExtMap =
4025       SemaRef.OpenCLDeclExtMap;
4026   using ElementTy = std::pair<DeclID, const std::set<std::string> *>;
4027   llvm::SmallVector<ElementTy, 8> StableOpenCLDeclExtMap;
4028   StableOpenCLDeclExtMap.reserve(OpenCLDeclExtMap.size());
4029 
4030   for (const auto &I : OpenCLDeclExtMap)
4031     StableOpenCLDeclExtMap.emplace_back(getDeclID(I.first), &I.second);
4032 
4033   auto CompareByDeclID = [](const ElementTy &E1, const ElementTy &E2) -> bool {
4034     return E1.first < E2.first;
4035   };
4036   llvm::sort(StableOpenCLDeclExtMap, CompareByDeclID);
4037 
4038   RecordData Record;
4039   for (const ElementTy &E : StableOpenCLDeclExtMap) {
4040     Record.push_back(E.first); // DeclID
4041     const std::set<std::string> *ExtSet = E.second;
4042     Record.push_back(static_cast<unsigned>(ExtSet->size()));
4043     for (const std::string &Ext : *ExtSet)
4044       AddString(Ext, Record);
4045   }
4046 
4047   Stream.EmitRecord(OPENCL_EXTENSION_DECLS, Record);
4048 }
4049 
4050 void ASTWriter::WriteCUDAPragmas(Sema &SemaRef) {
4051   if (SemaRef.ForceCUDAHostDeviceDepth > 0) {
4052     RecordData::value_type Record[] = {SemaRef.ForceCUDAHostDeviceDepth};
4053     Stream.EmitRecord(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH, Record);
4054   }
4055 }
4056 
4057 void ASTWriter::WriteObjCCategories() {
4058   SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
4059   RecordData Categories;
4060 
4061   for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
4062     unsigned Size = 0;
4063     unsigned StartIndex = Categories.size();
4064 
4065     ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
4066 
4067     // Allocate space for the size.
4068     Categories.push_back(0);
4069 
4070     // Add the categories.
4071     for (ObjCInterfaceDecl::known_categories_iterator
4072            Cat = Class->known_categories_begin(),
4073            CatEnd = Class->known_categories_end();
4074          Cat != CatEnd; ++Cat, ++Size) {
4075       assert(getDeclID(*Cat) != 0 && "Bogus category");
4076       AddDeclRef(*Cat, Categories);
4077     }
4078 
4079     // Update the size.
4080     Categories[StartIndex] = Size;
4081 
4082     // Record this interface -> category map.
4083     ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex };
4084     CategoriesMap.push_back(CatInfo);
4085   }
4086 
4087   // Sort the categories map by the definition ID, since the reader will be
4088   // performing binary searches on this information.
4089   llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end());
4090 
4091   // Emit the categories map.
4092   using namespace llvm;
4093 
4094   auto Abbrev = std::make_shared<BitCodeAbbrev>();
4095   Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
4096   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
4097   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
4098   unsigned AbbrevID = Stream.EmitAbbrev(std::move(Abbrev));
4099 
4100   RecordData::value_type Record[] = {OBJC_CATEGORIES_MAP, CategoriesMap.size()};
4101   Stream.EmitRecordWithBlob(AbbrevID, Record,
4102                             reinterpret_cast<char *>(CategoriesMap.data()),
4103                             CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
4104 
4105   // Emit the category lists.
4106   Stream.EmitRecord(OBJC_CATEGORIES, Categories);
4107 }
4108 
4109 void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
4110   Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap;
4111 
4112   if (LPTMap.empty())
4113     return;
4114 
4115   RecordData Record;
4116   for (auto &LPTMapEntry : LPTMap) {
4117     const FunctionDecl *FD = LPTMapEntry.first;
4118     LateParsedTemplate &LPT = *LPTMapEntry.second;
4119     AddDeclRef(FD, Record);
4120     AddDeclRef(LPT.D, Record);
4121     Record.push_back(LPT.Toks.size());
4122 
4123     for (const auto &Tok : LPT.Toks) {
4124       AddToken(Tok, Record);
4125     }
4126   }
4127   Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record);
4128 }
4129 
4130 /// Write the state of 'pragma clang optimize' at the end of the module.
4131 void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
4132   RecordData Record;
4133   SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
4134   AddSourceLocation(PragmaLoc, Record);
4135   Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record);
4136 }
4137 
4138 /// Write the state of 'pragma ms_struct' at the end of the module.
4139 void ASTWriter::WriteMSStructPragmaOptions(Sema &SemaRef) {
4140   RecordData Record;
4141   Record.push_back(SemaRef.MSStructPragmaOn ? PMSST_ON : PMSST_OFF);
4142   Stream.EmitRecord(MSSTRUCT_PRAGMA_OPTIONS, Record);
4143 }
4144 
4145 /// Write the state of 'pragma pointers_to_members' at the end of the
4146 //module.
4147 void ASTWriter::WriteMSPointersToMembersPragmaOptions(Sema &SemaRef) {
4148   RecordData Record;
4149   Record.push_back(SemaRef.MSPointerToMemberRepresentationMethod);
4150   AddSourceLocation(SemaRef.ImplicitMSInheritanceAttrLoc, Record);
4151   Stream.EmitRecord(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS, Record);
4152 }
4153 
4154 /// Write the state of 'pragma pack' at the end of the module.
4155 void ASTWriter::WritePackPragmaOptions(Sema &SemaRef) {
4156   // Don't serialize pragma pack state for modules, since it should only take
4157   // effect on a per-submodule basis.
4158   if (WritingModule)
4159     return;
4160 
4161   RecordData Record;
4162   Record.push_back(SemaRef.PackStack.CurrentValue);
4163   AddSourceLocation(SemaRef.PackStack.CurrentPragmaLocation, Record);
4164   Record.push_back(SemaRef.PackStack.Stack.size());
4165   for (const auto &StackEntry : SemaRef.PackStack.Stack) {
4166     Record.push_back(StackEntry.Value);
4167     AddSourceLocation(StackEntry.PragmaLocation, Record);
4168     AddSourceLocation(StackEntry.PragmaPushLocation, Record);
4169     AddString(StackEntry.StackSlotLabel, Record);
4170   }
4171   Stream.EmitRecord(PACK_PRAGMA_OPTIONS, Record);
4172 }
4173 
4174 /// Write the state of 'pragma float_control' at the end of the module.
4175 void ASTWriter::WriteFloatControlPragmaOptions(Sema &SemaRef) {
4176   // Don't serialize pragma float_control state for modules,
4177   // since it should only take effect on a per-submodule basis.
4178   if (WritingModule)
4179     return;
4180 
4181   RecordData Record;
4182   Record.push_back(SemaRef.FpPragmaStack.CurrentValue.getAsOpaqueInt());
4183   AddSourceLocation(SemaRef.FpPragmaStack.CurrentPragmaLocation, Record);
4184   Record.push_back(SemaRef.FpPragmaStack.Stack.size());
4185   for (const auto &StackEntry : SemaRef.FpPragmaStack.Stack) {
4186     Record.push_back(StackEntry.Value.getAsOpaqueInt());
4187     AddSourceLocation(StackEntry.PragmaLocation, Record);
4188     AddSourceLocation(StackEntry.PragmaPushLocation, Record);
4189     AddString(StackEntry.StackSlotLabel, Record);
4190   }
4191   Stream.EmitRecord(FLOAT_CONTROL_PRAGMA_OPTIONS, Record);
4192 }
4193 
4194 void ASTWriter::WriteModuleFileExtension(Sema &SemaRef,
4195                                          ModuleFileExtensionWriter &Writer) {
4196   // Enter the extension block.
4197   Stream.EnterSubblock(EXTENSION_BLOCK_ID, 4);
4198 
4199   // Emit the metadata record abbreviation.
4200   auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
4201   Abv->Add(llvm::BitCodeAbbrevOp(EXTENSION_METADATA));
4202   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4203   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4204   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4205   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4206   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4207   unsigned Abbrev = Stream.EmitAbbrev(std::move(Abv));
4208 
4209   // Emit the metadata record.
4210   RecordData Record;
4211   auto Metadata = Writer.getExtension()->getExtensionMetadata();
4212   Record.push_back(EXTENSION_METADATA);
4213   Record.push_back(Metadata.MajorVersion);
4214   Record.push_back(Metadata.MinorVersion);
4215   Record.push_back(Metadata.BlockName.size());
4216   Record.push_back(Metadata.UserInfo.size());
4217   SmallString<64> Buffer;
4218   Buffer += Metadata.BlockName;
4219   Buffer += Metadata.UserInfo;
4220   Stream.EmitRecordWithBlob(Abbrev, Record, Buffer);
4221 
4222   // Emit the contents of the extension block.
4223   Writer.writeExtensionContents(SemaRef, Stream);
4224 
4225   // Exit the extension block.
4226   Stream.ExitBlock();
4227 }
4228 
4229 //===----------------------------------------------------------------------===//
4230 // General Serialization Routines
4231 //===----------------------------------------------------------------------===//
4232 
4233 void ASTRecordWriter::AddAttr(const Attr *A) {
4234   auto &Record = *this;
4235   if (!A)
4236     return Record.push_back(0);
4237   Record.push_back(A->getKind() + 1); // FIXME: stable encoding, target attrs
4238 
4239   Record.AddIdentifierRef(A->getAttrName());
4240   Record.AddIdentifierRef(A->getScopeName());
4241   Record.AddSourceRange(A->getRange());
4242   Record.AddSourceLocation(A->getScopeLoc());
4243   Record.push_back(A->getParsedKind());
4244   Record.push_back(A->getSyntax());
4245   Record.push_back(A->getAttributeSpellingListIndexRaw());
4246 
4247 #include "clang/Serialization/AttrPCHWrite.inc"
4248 }
4249 
4250 /// Emit the list of attributes to the specified record.
4251 void ASTRecordWriter::AddAttributes(ArrayRef<const Attr *> Attrs) {
4252   push_back(Attrs.size());
4253   for (const auto *A : Attrs)
4254     AddAttr(A);
4255 }
4256 
4257 void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) {
4258   AddSourceLocation(Tok.getLocation(), Record);
4259   Record.push_back(Tok.getLength());
4260 
4261   // FIXME: When reading literal tokens, reconstruct the literal pointer
4262   // if it is needed.
4263   AddIdentifierRef(Tok.getIdentifierInfo(), Record);
4264   // FIXME: Should translate token kind to a stable encoding.
4265   Record.push_back(Tok.getKind());
4266   // FIXME: Should translate token flags to a stable encoding.
4267   Record.push_back(Tok.getFlags());
4268 }
4269 
4270 void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
4271   Record.push_back(Str.size());
4272   Record.insert(Record.end(), Str.begin(), Str.end());
4273 }
4274 
4275 bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) {
4276   assert(Context && "should have context when outputting path");
4277 
4278   bool Changed =
4279       cleanPathForOutput(Context->getSourceManager().getFileManager(), Path);
4280 
4281   // Remove a prefix to make the path relative, if relevant.
4282   const char *PathBegin = Path.data();
4283   const char *PathPtr =
4284       adjustFilenameForRelocatableAST(PathBegin, BaseDirectory);
4285   if (PathPtr != PathBegin) {
4286     Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin));
4287     Changed = true;
4288   }
4289 
4290   return Changed;
4291 }
4292 
4293 void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) {
4294   SmallString<128> FilePath(Path);
4295   PreparePathForOutput(FilePath);
4296   AddString(FilePath, Record);
4297 }
4298 
4299 void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataRef Record,
4300                                    StringRef Path) {
4301   SmallString<128> FilePath(Path);
4302   PreparePathForOutput(FilePath);
4303   Stream.EmitRecordWithBlob(Abbrev, Record, FilePath);
4304 }
4305 
4306 void ASTWriter::AddVersionTuple(const VersionTuple &Version,
4307                                 RecordDataImpl &Record) {
4308   Record.push_back(Version.getMajor());
4309   if (Optional<unsigned> Minor = Version.getMinor())
4310     Record.push_back(*Minor + 1);
4311   else
4312     Record.push_back(0);
4313   if (Optional<unsigned> Subminor = Version.getSubminor())
4314     Record.push_back(*Subminor + 1);
4315   else
4316     Record.push_back(0);
4317 }
4318 
4319 /// Note that the identifier II occurs at the given offset
4320 /// within the identifier table.
4321 void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
4322   IdentID ID = IdentifierIDs[II];
4323   // Only store offsets new to this AST file. Other identifier names are looked
4324   // up earlier in the chain and thus don't need an offset.
4325   if (ID >= FirstIdentID)
4326     IdentifierOffsets[ID - FirstIdentID] = Offset;
4327 }
4328 
4329 /// Note that the selector Sel occurs at the given offset
4330 /// within the method pool/selector table.
4331 void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
4332   unsigned ID = SelectorIDs[Sel];
4333   assert(ID && "Unknown selector");
4334   // Don't record offsets for selectors that are also available in a different
4335   // file.
4336   if (ID < FirstSelectorID)
4337     return;
4338   SelectorOffsets[ID - FirstSelectorID] = Offset;
4339 }
4340 
4341 ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream,
4342                      SmallVectorImpl<char> &Buffer,
4343                      InMemoryModuleCache &ModuleCache,
4344                      ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
4345                      bool IncludeTimestamps)
4346     : Stream(Stream), Buffer(Buffer), ModuleCache(ModuleCache),
4347       IncludeTimestamps(IncludeTimestamps) {
4348   for (const auto &Ext : Extensions) {
4349     if (auto Writer = Ext->createExtensionWriter(*this))
4350       ModuleFileExtensionWriters.push_back(std::move(Writer));
4351   }
4352 }
4353 
4354 ASTWriter::~ASTWriter() = default;
4355 
4356 const LangOptions &ASTWriter::getLangOpts() const {
4357   assert(WritingAST && "can't determine lang opts when not writing AST");
4358   return Context->getLangOpts();
4359 }
4360 
4361 time_t ASTWriter::getTimestampForOutput(const FileEntry *E) const {
4362   return IncludeTimestamps ? E->getModificationTime() : 0;
4363 }
4364 
4365 ASTFileSignature ASTWriter::WriteAST(Sema &SemaRef,
4366                                      const std::string &OutputFile,
4367                                      Module *WritingModule, StringRef isysroot,
4368                                      bool hasErrors,
4369                                      bool ShouldCacheASTInMemory) {
4370   WritingAST = true;
4371 
4372   ASTHasCompilerErrors = hasErrors;
4373 
4374   // Emit the file header.
4375   Stream.Emit((unsigned)'C', 8);
4376   Stream.Emit((unsigned)'P', 8);
4377   Stream.Emit((unsigned)'C', 8);
4378   Stream.Emit((unsigned)'H', 8);
4379 
4380   WriteBlockInfoBlock();
4381 
4382   Context = &SemaRef.Context;
4383   PP = &SemaRef.PP;
4384   this->WritingModule = WritingModule;
4385   ASTFileSignature Signature =
4386       WriteASTCore(SemaRef, isysroot, OutputFile, WritingModule);
4387   Context = nullptr;
4388   PP = nullptr;
4389   this->WritingModule = nullptr;
4390   this->BaseDirectory.clear();
4391 
4392   WritingAST = false;
4393   if (ShouldCacheASTInMemory) {
4394     // Construct MemoryBuffer and update buffer manager.
4395     ModuleCache.addBuiltPCM(OutputFile,
4396                             llvm::MemoryBuffer::getMemBufferCopy(
4397                                 StringRef(Buffer.begin(), Buffer.size())));
4398   }
4399   return Signature;
4400 }
4401 
4402 template<typename Vector>
4403 static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec,
4404                                ASTWriter::RecordData &Record) {
4405   for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
4406        I != E; ++I) {
4407     Writer.AddDeclRef(*I, Record);
4408   }
4409 }
4410 
4411 ASTFileSignature ASTWriter::WriteASTCore(Sema &SemaRef, StringRef isysroot,
4412                                          const std::string &OutputFile,
4413                                          Module *WritingModule) {
4414   using namespace llvm;
4415 
4416   bool isModule = WritingModule != nullptr;
4417 
4418   // Make sure that the AST reader knows to finalize itself.
4419   if (Chain)
4420     Chain->finalizeForWriting();
4421 
4422   ASTContext &Context = SemaRef.Context;
4423   Preprocessor &PP = SemaRef.PP;
4424 
4425   // Set up predefined declaration IDs.
4426   auto RegisterPredefDecl = [&] (Decl *D, PredefinedDeclIDs ID) {
4427     if (D) {
4428       assert(D->isCanonicalDecl() && "predefined decl is not canonical");
4429       DeclIDs[D] = ID;
4430     }
4431   };
4432   RegisterPredefDecl(Context.getTranslationUnitDecl(),
4433                      PREDEF_DECL_TRANSLATION_UNIT_ID);
4434   RegisterPredefDecl(Context.ObjCIdDecl, PREDEF_DECL_OBJC_ID_ID);
4435   RegisterPredefDecl(Context.ObjCSelDecl, PREDEF_DECL_OBJC_SEL_ID);
4436   RegisterPredefDecl(Context.ObjCClassDecl, PREDEF_DECL_OBJC_CLASS_ID);
4437   RegisterPredefDecl(Context.ObjCProtocolClassDecl,
4438                      PREDEF_DECL_OBJC_PROTOCOL_ID);
4439   RegisterPredefDecl(Context.Int128Decl, PREDEF_DECL_INT_128_ID);
4440   RegisterPredefDecl(Context.UInt128Decl, PREDEF_DECL_UNSIGNED_INT_128_ID);
4441   RegisterPredefDecl(Context.ObjCInstanceTypeDecl,
4442                      PREDEF_DECL_OBJC_INSTANCETYPE_ID);
4443   RegisterPredefDecl(Context.BuiltinVaListDecl, PREDEF_DECL_BUILTIN_VA_LIST_ID);
4444   RegisterPredefDecl(Context.VaListTagDecl, PREDEF_DECL_VA_LIST_TAG);
4445   RegisterPredefDecl(Context.BuiltinMSVaListDecl,
4446                      PREDEF_DECL_BUILTIN_MS_VA_LIST_ID);
4447   RegisterPredefDecl(Context.MSGuidTagDecl,
4448                      PREDEF_DECL_BUILTIN_MS_GUID_ID);
4449   RegisterPredefDecl(Context.ExternCContext, PREDEF_DECL_EXTERN_C_CONTEXT_ID);
4450   RegisterPredefDecl(Context.MakeIntegerSeqDecl,
4451                      PREDEF_DECL_MAKE_INTEGER_SEQ_ID);
4452   RegisterPredefDecl(Context.CFConstantStringTypeDecl,
4453                      PREDEF_DECL_CF_CONSTANT_STRING_ID);
4454   RegisterPredefDecl(Context.CFConstantStringTagDecl,
4455                      PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID);
4456   RegisterPredefDecl(Context.TypePackElementDecl,
4457                      PREDEF_DECL_TYPE_PACK_ELEMENT_ID);
4458 
4459   // Build a record containing all of the tentative definitions in this file, in
4460   // TentativeDefinitions order.  Generally, this record will be empty for
4461   // headers.
4462   RecordData TentativeDefinitions;
4463   AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions);
4464 
4465   // Build a record containing all of the file scoped decls in this file.
4466   RecordData UnusedFileScopedDecls;
4467   if (!isModule)
4468     AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls,
4469                        UnusedFileScopedDecls);
4470 
4471   // Build a record containing all of the delegating constructors we still need
4472   // to resolve.
4473   RecordData DelegatingCtorDecls;
4474   if (!isModule)
4475     AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls);
4476 
4477   // Write the set of weak, undeclared identifiers. We always write the
4478   // entire table, since later PCH files in a PCH chain are only interested in
4479   // the results at the end of the chain.
4480   RecordData WeakUndeclaredIdentifiers;
4481   for (auto &WeakUndeclaredIdentifier : SemaRef.WeakUndeclaredIdentifiers) {
4482     IdentifierInfo *II = WeakUndeclaredIdentifier.first;
4483     WeakInfo &WI = WeakUndeclaredIdentifier.second;
4484     AddIdentifierRef(II, WeakUndeclaredIdentifiers);
4485     AddIdentifierRef(WI.getAlias(), WeakUndeclaredIdentifiers);
4486     AddSourceLocation(WI.getLocation(), WeakUndeclaredIdentifiers);
4487     WeakUndeclaredIdentifiers.push_back(WI.getUsed());
4488   }
4489 
4490   // Build a record containing all of the ext_vector declarations.
4491   RecordData ExtVectorDecls;
4492   AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
4493 
4494   // Build a record containing all of the VTable uses information.
4495   RecordData VTableUses;
4496   if (!SemaRef.VTableUses.empty()) {
4497     for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
4498       AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
4499       AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
4500       VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
4501     }
4502   }
4503 
4504   // Build a record containing all of the UnusedLocalTypedefNameCandidates.
4505   RecordData UnusedLocalTypedefNameCandidates;
4506   for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
4507     AddDeclRef(TD, UnusedLocalTypedefNameCandidates);
4508 
4509   // Build a record containing all of pending implicit instantiations.
4510   RecordData PendingInstantiations;
4511   for (const auto &I : SemaRef.PendingInstantiations) {
4512     AddDeclRef(I.first, PendingInstantiations);
4513     AddSourceLocation(I.second, PendingInstantiations);
4514   }
4515   assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
4516          "There are local ones at end of translation unit!");
4517 
4518   // Build a record containing some declaration references.
4519   RecordData SemaDeclRefs;
4520   if (SemaRef.StdNamespace || SemaRef.StdBadAlloc || SemaRef.StdAlignValT) {
4521     AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
4522     AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
4523     AddDeclRef(SemaRef.getStdAlignValT(), SemaDeclRefs);
4524   }
4525 
4526   RecordData CUDASpecialDeclRefs;
4527   if (Context.getcudaConfigureCallDecl()) {
4528     AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs);
4529   }
4530 
4531   // Build a record containing all of the known namespaces.
4532   RecordData KnownNamespaces;
4533   for (const auto &I : SemaRef.KnownNamespaces) {
4534     if (!I.second)
4535       AddDeclRef(I.first, KnownNamespaces);
4536   }
4537 
4538   // Build a record of all used, undefined objects that require definitions.
4539   RecordData UndefinedButUsed;
4540 
4541   SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
4542   SemaRef.getUndefinedButUsed(Undefined);
4543   for (const auto &I : Undefined) {
4544     AddDeclRef(I.first, UndefinedButUsed);
4545     AddSourceLocation(I.second, UndefinedButUsed);
4546   }
4547 
4548   // Build a record containing all delete-expressions that we would like to
4549   // analyze later in AST.
4550   RecordData DeleteExprsToAnalyze;
4551 
4552   if (!isModule) {
4553     for (const auto &DeleteExprsInfo :
4554          SemaRef.getMismatchingDeleteExpressions()) {
4555       AddDeclRef(DeleteExprsInfo.first, DeleteExprsToAnalyze);
4556       DeleteExprsToAnalyze.push_back(DeleteExprsInfo.second.size());
4557       for (const auto &DeleteLoc : DeleteExprsInfo.second) {
4558         AddSourceLocation(DeleteLoc.first, DeleteExprsToAnalyze);
4559         DeleteExprsToAnalyze.push_back(DeleteLoc.second);
4560       }
4561     }
4562   }
4563 
4564   // Write the control block
4565   WriteControlBlock(PP, Context, isysroot, OutputFile);
4566 
4567   // Write the remaining AST contents.
4568   Stream.FlushToWord();
4569   ASTBlockRange.first = Stream.GetCurrentBitNo();
4570   Stream.EnterSubblock(AST_BLOCK_ID, 5);
4571   ASTBlockStartOffset = Stream.GetCurrentBitNo();
4572 
4573   // This is so that older clang versions, before the introduction
4574   // of the control block, can read and reject the newer PCH format.
4575   {
4576     RecordData Record = {VERSION_MAJOR};
4577     Stream.EmitRecord(METADATA_OLD_FORMAT, Record);
4578   }
4579 
4580   // Create a lexical update block containing all of the declarations in the
4581   // translation unit that do not come from other AST files.
4582   const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
4583   SmallVector<uint32_t, 128> NewGlobalKindDeclPairs;
4584   for (const auto *D : TU->noload_decls()) {
4585     if (!D->isFromASTFile()) {
4586       NewGlobalKindDeclPairs.push_back(D->getKind());
4587       NewGlobalKindDeclPairs.push_back(GetDeclRef(D));
4588     }
4589   }
4590 
4591   auto Abv = std::make_shared<BitCodeAbbrev>();
4592   Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
4593   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4594   unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(std::move(Abv));
4595   {
4596     RecordData::value_type Record[] = {TU_UPDATE_LEXICAL};
4597     Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
4598                               bytes(NewGlobalKindDeclPairs));
4599   }
4600 
4601   // And a visible updates block for the translation unit.
4602   Abv = std::make_shared<BitCodeAbbrev>();
4603   Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
4604   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4605   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4606   UpdateVisibleAbbrev = Stream.EmitAbbrev(std::move(Abv));
4607   WriteDeclContextVisibleUpdate(TU);
4608 
4609   // If we have any extern "C" names, write out a visible update for them.
4610   if (Context.ExternCContext)
4611     WriteDeclContextVisibleUpdate(Context.ExternCContext);
4612 
4613   // If the translation unit has an anonymous namespace, and we don't already
4614   // have an update block for it, write it as an update block.
4615   // FIXME: Why do we not do this if there's already an update block?
4616   if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
4617     ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
4618     if (Record.empty())
4619       Record.push_back(DeclUpdate(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE, NS));
4620   }
4621 
4622   // Add update records for all mangling numbers and static local numbers.
4623   // These aren't really update records, but this is a convenient way of
4624   // tagging this rare extra data onto the declarations.
4625   for (const auto &Number : Context.MangleNumbers)
4626     if (!Number.first->isFromASTFile())
4627       DeclUpdates[Number.first].push_back(DeclUpdate(UPD_MANGLING_NUMBER,
4628                                                      Number.second));
4629   for (const auto &Number : Context.StaticLocalNumbers)
4630     if (!Number.first->isFromASTFile())
4631       DeclUpdates[Number.first].push_back(DeclUpdate(UPD_STATIC_LOCAL_NUMBER,
4632                                                      Number.second));
4633 
4634   // Make sure visible decls, added to DeclContexts previously loaded from
4635   // an AST file, are registered for serialization. Likewise for template
4636   // specializations added to imported templates.
4637   for (const auto *I : DeclsToEmitEvenIfUnreferenced) {
4638     GetDeclRef(I);
4639   }
4640 
4641   // Make sure all decls associated with an identifier are registered for
4642   // serialization, if we're storing decls with identifiers.
4643   if (!WritingModule || !getLangOpts().CPlusPlus) {
4644     llvm::SmallVector<const IdentifierInfo*, 256> IIs;
4645     for (const auto &ID : PP.getIdentifierTable()) {
4646       const IdentifierInfo *II = ID.second;
4647       if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
4648         IIs.push_back(II);
4649     }
4650     // Sort the identifiers to visit based on their name.
4651     llvm::sort(IIs, llvm::deref<std::less<>>());
4652     for (const IdentifierInfo *II : IIs) {
4653       for (IdentifierResolver::iterator D = SemaRef.IdResolver.begin(II),
4654                                      DEnd = SemaRef.IdResolver.end();
4655            D != DEnd; ++D) {
4656         GetDeclRef(*D);
4657       }
4658     }
4659   }
4660 
4661   // For method pool in the module, if it contains an entry for a selector,
4662   // the entry should be complete, containing everything introduced by that
4663   // module and all modules it imports. It's possible that the entry is out of
4664   // date, so we need to pull in the new content here.
4665 
4666   // It's possible that updateOutOfDateSelector can update SelectorIDs. To be
4667   // safe, we copy all selectors out.
4668   llvm::SmallVector<Selector, 256> AllSelectors;
4669   for (auto &SelectorAndID : SelectorIDs)
4670     AllSelectors.push_back(SelectorAndID.first);
4671   for (auto &Selector : AllSelectors)
4672     SemaRef.updateOutOfDateSelector(Selector);
4673 
4674   // Form the record of special types.
4675   RecordData SpecialTypes;
4676   AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes);
4677   AddTypeRef(Context.getFILEType(), SpecialTypes);
4678   AddTypeRef(Context.getjmp_bufType(), SpecialTypes);
4679   AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes);
4680   AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes);
4681   AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes);
4682   AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes);
4683   AddTypeRef(Context.getucontext_tType(), SpecialTypes);
4684 
4685   if (Chain) {
4686     // Write the mapping information describing our module dependencies and how
4687     // each of those modules were mapped into our own offset/ID space, so that
4688     // the reader can build the appropriate mapping to its own offset/ID space.
4689     // The map consists solely of a blob with the following format:
4690     // *(module-kind:i8
4691     //   module-name-len:i16 module-name:len*i8
4692     //   source-location-offset:i32
4693     //   identifier-id:i32
4694     //   preprocessed-entity-id:i32
4695     //   macro-definition-id:i32
4696     //   submodule-id:i32
4697     //   selector-id:i32
4698     //   declaration-id:i32
4699     //   c++-base-specifiers-id:i32
4700     //   type-id:i32)
4701     //
4702     // module-kind is the ModuleKind enum value. If it is MK_PrebuiltModule,
4703     // MK_ExplicitModule or MK_ImplicitModule, then the module-name is the
4704     // module name. Otherwise, it is the module file name.
4705     auto Abbrev = std::make_shared<BitCodeAbbrev>();
4706     Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
4707     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
4708     unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
4709     SmallString<2048> Buffer;
4710     {
4711       llvm::raw_svector_ostream Out(Buffer);
4712       for (ModuleFile &M : Chain->ModuleMgr) {
4713         using namespace llvm::support;
4714 
4715         endian::Writer LE(Out, little);
4716         LE.write<uint8_t>(static_cast<uint8_t>(M.Kind));
4717         StringRef Name = M.isModule() ? M.ModuleName : M.FileName;
4718         LE.write<uint16_t>(Name.size());
4719         Out.write(Name.data(), Name.size());
4720 
4721         // Note: if a base ID was uint max, it would not be possible to load
4722         // another module after it or have more than one entity inside it.
4723         uint32_t None = std::numeric_limits<uint32_t>::max();
4724 
4725         auto writeBaseIDOrNone = [&](uint32_t BaseID, bool ShouldWrite) {
4726           assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
4727           if (ShouldWrite)
4728             LE.write<uint32_t>(BaseID);
4729           else
4730             LE.write<uint32_t>(None);
4731         };
4732 
4733         // These values should be unique within a chain, since they will be read
4734         // as keys into ContinuousRangeMaps.
4735         writeBaseIDOrNone(M.SLocEntryBaseOffset, M.LocalNumSLocEntries);
4736         writeBaseIDOrNone(M.BaseIdentifierID, M.LocalNumIdentifiers);
4737         writeBaseIDOrNone(M.BaseMacroID, M.LocalNumMacros);
4738         writeBaseIDOrNone(M.BasePreprocessedEntityID,
4739                           M.NumPreprocessedEntities);
4740         writeBaseIDOrNone(M.BaseSubmoduleID, M.LocalNumSubmodules);
4741         writeBaseIDOrNone(M.BaseSelectorID, M.LocalNumSelectors);
4742         writeBaseIDOrNone(M.BaseDeclID, M.LocalNumDecls);
4743         writeBaseIDOrNone(M.BaseTypeIndex, M.LocalNumTypes);
4744       }
4745     }
4746     RecordData::value_type Record[] = {MODULE_OFFSET_MAP};
4747     Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
4748                               Buffer.data(), Buffer.size());
4749   }
4750 
4751   // Build a record containing all of the DeclsToCheckForDeferredDiags.
4752   RecordData DeclsToCheckForDeferredDiags;
4753   for (auto *D : SemaRef.DeclsToCheckForDeferredDiags)
4754     AddDeclRef(D, DeclsToCheckForDeferredDiags);
4755 
4756   RecordData DeclUpdatesOffsetsRecord;
4757 
4758   // Keep writing types, declarations, and declaration update records
4759   // until we've emitted all of them.
4760   Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/5);
4761   DeclTypesBlockStartOffset = Stream.GetCurrentBitNo();
4762   WriteTypeAbbrevs();
4763   WriteDeclAbbrevs();
4764   do {
4765     WriteDeclUpdatesBlocks(DeclUpdatesOffsetsRecord);
4766     while (!DeclTypesToEmit.empty()) {
4767       DeclOrType DOT = DeclTypesToEmit.front();
4768       DeclTypesToEmit.pop();
4769       if (DOT.isType())
4770         WriteType(DOT.getType());
4771       else
4772         WriteDecl(Context, DOT.getDecl());
4773     }
4774   } while (!DeclUpdates.empty());
4775   Stream.ExitBlock();
4776 
4777   DoneWritingDeclsAndTypes = true;
4778 
4779   // These things can only be done once we've written out decls and types.
4780   WriteTypeDeclOffsets();
4781   if (!DeclUpdatesOffsetsRecord.empty())
4782     Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord);
4783   WriteFileDeclIDsMap();
4784   WriteSourceManagerBlock(Context.getSourceManager(), PP);
4785   WriteComments();
4786   WritePreprocessor(PP, isModule);
4787   WriteHeaderSearch(PP.getHeaderSearchInfo());
4788   WriteSelectors(SemaRef);
4789   WriteReferencedSelectorsPool(SemaRef);
4790   WriteLateParsedTemplates(SemaRef);
4791   WriteIdentifierTable(PP, SemaRef.IdResolver, isModule);
4792   WriteFPPragmaOptions(SemaRef.CurFPFeatureOverrides());
4793   WriteOpenCLExtensions(SemaRef);
4794   WriteOpenCLExtensionTypes(SemaRef);
4795   WriteCUDAPragmas(SemaRef);
4796 
4797   // If we're emitting a module, write out the submodule information.
4798   if (WritingModule)
4799     WriteSubmodules(WritingModule);
4800 
4801   // We need to have information about submodules to correctly deserialize
4802   // decls from OpenCLExtensionDecls block
4803   WriteOpenCLExtensionDecls(SemaRef);
4804 
4805   Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
4806 
4807   // Write the record containing external, unnamed definitions.
4808   if (!EagerlyDeserializedDecls.empty())
4809     Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls);
4810 
4811   if (!ModularCodegenDecls.empty())
4812     Stream.EmitRecord(MODULAR_CODEGEN_DECLS, ModularCodegenDecls);
4813 
4814   // Write the record containing tentative definitions.
4815   if (!TentativeDefinitions.empty())
4816     Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
4817 
4818   // Write the record containing unused file scoped decls.
4819   if (!UnusedFileScopedDecls.empty())
4820     Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
4821 
4822   // Write the record containing weak undeclared identifiers.
4823   if (!WeakUndeclaredIdentifiers.empty())
4824     Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
4825                       WeakUndeclaredIdentifiers);
4826 
4827   // Write the record containing ext_vector type names.
4828   if (!ExtVectorDecls.empty())
4829     Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
4830 
4831   // Write the record containing VTable uses information.
4832   if (!VTableUses.empty())
4833     Stream.EmitRecord(VTABLE_USES, VTableUses);
4834 
4835   // Write the record containing potentially unused local typedefs.
4836   if (!UnusedLocalTypedefNameCandidates.empty())
4837     Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
4838                       UnusedLocalTypedefNameCandidates);
4839 
4840   // Write the record containing pending implicit instantiations.
4841   if (!PendingInstantiations.empty())
4842     Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
4843 
4844   // Write the record containing declaration references of Sema.
4845   if (!SemaDeclRefs.empty())
4846     Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
4847 
4848   // Write the record containing decls to be checked for deferred diags.
4849   if (!DeclsToCheckForDeferredDiags.empty())
4850     Stream.EmitRecord(DECLS_TO_CHECK_FOR_DEFERRED_DIAGS,
4851         DeclsToCheckForDeferredDiags);
4852 
4853   // Write the record containing CUDA-specific declaration references.
4854   if (!CUDASpecialDeclRefs.empty())
4855     Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
4856 
4857   // Write the delegating constructors.
4858   if (!DelegatingCtorDecls.empty())
4859     Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
4860 
4861   // Write the known namespaces.
4862   if (!KnownNamespaces.empty())
4863     Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
4864 
4865   // Write the undefined internal functions and variables, and inline functions.
4866   if (!UndefinedButUsed.empty())
4867     Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed);
4868 
4869   if (!DeleteExprsToAnalyze.empty())
4870     Stream.EmitRecord(DELETE_EXPRS_TO_ANALYZE, DeleteExprsToAnalyze);
4871 
4872   // Write the visible updates to DeclContexts.
4873   for (auto *DC : UpdatedDeclContexts)
4874     WriteDeclContextVisibleUpdate(DC);
4875 
4876   if (!WritingModule) {
4877     // Write the submodules that were imported, if any.
4878     struct ModuleInfo {
4879       uint64_t ID;
4880       Module *M;
4881       ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
4882     };
4883     llvm::SmallVector<ModuleInfo, 64> Imports;
4884     for (const auto *I : Context.local_imports()) {
4885       assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end());
4886       Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()],
4887                          I->getImportedModule()));
4888     }
4889 
4890     if (!Imports.empty()) {
4891       auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
4892         return A.ID < B.ID;
4893       };
4894       auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
4895         return A.ID == B.ID;
4896       };
4897 
4898       // Sort and deduplicate module IDs.
4899       llvm::sort(Imports, Cmp);
4900       Imports.erase(std::unique(Imports.begin(), Imports.end(), Eq),
4901                     Imports.end());
4902 
4903       RecordData ImportedModules;
4904       for (const auto &Import : Imports) {
4905         ImportedModules.push_back(Import.ID);
4906         // FIXME: If the module has macros imported then later has declarations
4907         // imported, this location won't be the right one as a location for the
4908         // declaration imports.
4909         AddSourceLocation(PP.getModuleImportLoc(Import.M), ImportedModules);
4910       }
4911 
4912       Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
4913     }
4914   }
4915 
4916   WriteObjCCategories();
4917   if(!WritingModule) {
4918     WriteOptimizePragmaOptions(SemaRef);
4919     WriteMSStructPragmaOptions(SemaRef);
4920     WriteMSPointersToMembersPragmaOptions(SemaRef);
4921   }
4922   WritePackPragmaOptions(SemaRef);
4923   WriteFloatControlPragmaOptions(SemaRef);
4924 
4925   // Some simple statistics
4926   RecordData::value_type Record[] = {
4927       NumStatements, NumMacros, NumLexicalDeclContexts, NumVisibleDeclContexts};
4928   Stream.EmitRecord(STATISTICS, Record);
4929   Stream.ExitBlock();
4930   Stream.FlushToWord();
4931   ASTBlockRange.second = Stream.GetCurrentBitNo();
4932 
4933   // Write the module file extension blocks.
4934   for (const auto &ExtWriter : ModuleFileExtensionWriters)
4935     WriteModuleFileExtension(SemaRef, *ExtWriter);
4936 
4937   return writeUnhashedControlBlock(PP, Context);
4938 }
4939 
4940 void ASTWriter::WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord) {
4941   if (DeclUpdates.empty())
4942     return;
4943 
4944   DeclUpdateMap LocalUpdates;
4945   LocalUpdates.swap(DeclUpdates);
4946 
4947   for (auto &DeclUpdate : LocalUpdates) {
4948     const Decl *D = DeclUpdate.first;
4949 
4950     bool HasUpdatedBody = false;
4951     RecordData RecordData;
4952     ASTRecordWriter Record(*this, RecordData);
4953     for (auto &Update : DeclUpdate.second) {
4954       DeclUpdateKind Kind = (DeclUpdateKind)Update.getKind();
4955 
4956       // An updated body is emitted last, so that the reader doesn't need
4957       // to skip over the lazy body to reach statements for other records.
4958       if (Kind == UPD_CXX_ADDED_FUNCTION_DEFINITION)
4959         HasUpdatedBody = true;
4960       else
4961         Record.push_back(Kind);
4962 
4963       switch (Kind) {
4964       case UPD_CXX_ADDED_IMPLICIT_MEMBER:
4965       case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION:
4966       case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE:
4967         assert(Update.getDecl() && "no decl to add?");
4968         Record.push_back(GetDeclRef(Update.getDecl()));
4969         break;
4970 
4971       case UPD_CXX_ADDED_FUNCTION_DEFINITION:
4972         break;
4973 
4974       case UPD_CXX_POINT_OF_INSTANTIATION:
4975         // FIXME: Do we need to also save the template specialization kind here?
4976         Record.AddSourceLocation(Update.getLoc());
4977         break;
4978 
4979       case UPD_CXX_ADDED_VAR_DEFINITION: {
4980         const VarDecl *VD = cast<VarDecl>(D);
4981         Record.push_back(VD->isInline());
4982         Record.push_back(VD->isInlineSpecified());
4983         if (VD->getInit()) {
4984           Record.push_back(!VD->isInitKnownICE() ? 1
4985                                                  : (VD->isInitICE() ? 3 : 2));
4986           Record.AddStmt(const_cast<Expr*>(VD->getInit()));
4987         } else {
4988           Record.push_back(0);
4989         }
4990         break;
4991       }
4992 
4993       case UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT:
4994         Record.AddStmt(const_cast<Expr *>(
4995             cast<ParmVarDecl>(Update.getDecl())->getDefaultArg()));
4996         break;
4997 
4998       case UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER:
4999         Record.AddStmt(
5000             cast<FieldDecl>(Update.getDecl())->getInClassInitializer());
5001         break;
5002 
5003       case UPD_CXX_INSTANTIATED_CLASS_DEFINITION: {
5004         auto *RD = cast<CXXRecordDecl>(D);
5005         UpdatedDeclContexts.insert(RD->getPrimaryContext());
5006         Record.push_back(RD->isParamDestroyedInCallee());
5007         Record.push_back(RD->getArgPassingRestrictions());
5008         Record.AddCXXDefinitionData(RD);
5009         Record.AddOffset(WriteDeclContextLexicalBlock(
5010             *Context, const_cast<CXXRecordDecl *>(RD)));
5011 
5012         // This state is sometimes updated by template instantiation, when we
5013         // switch from the specialization referring to the template declaration
5014         // to it referring to the template definition.
5015         if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
5016           Record.push_back(MSInfo->getTemplateSpecializationKind());
5017           Record.AddSourceLocation(MSInfo->getPointOfInstantiation());
5018         } else {
5019           auto *Spec = cast<ClassTemplateSpecializationDecl>(RD);
5020           Record.push_back(Spec->getTemplateSpecializationKind());
5021           Record.AddSourceLocation(Spec->getPointOfInstantiation());
5022 
5023           // The instantiation might have been resolved to a partial
5024           // specialization. If so, record which one.
5025           auto From = Spec->getInstantiatedFrom();
5026           if (auto PartialSpec =
5027                 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
5028             Record.push_back(true);
5029             Record.AddDeclRef(PartialSpec);
5030             Record.AddTemplateArgumentList(
5031                 &Spec->getTemplateInstantiationArgs());
5032           } else {
5033             Record.push_back(false);
5034           }
5035         }
5036         Record.push_back(RD->getTagKind());
5037         Record.AddSourceLocation(RD->getLocation());
5038         Record.AddSourceLocation(RD->getBeginLoc());
5039         Record.AddSourceRange(RD->getBraceRange());
5040 
5041         // Instantiation may change attributes; write them all out afresh.
5042         Record.push_back(D->hasAttrs());
5043         if (D->hasAttrs())
5044           Record.AddAttributes(D->getAttrs());
5045 
5046         // FIXME: Ensure we don't get here for explicit instantiations.
5047         break;
5048       }
5049 
5050       case UPD_CXX_RESOLVED_DTOR_DELETE:
5051         Record.AddDeclRef(Update.getDecl());
5052         Record.AddStmt(cast<CXXDestructorDecl>(D)->getOperatorDeleteThisArg());
5053         break;
5054 
5055       case UPD_CXX_RESOLVED_EXCEPTION_SPEC: {
5056         auto prototype =
5057           cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>();
5058         Record.writeExceptionSpecInfo(prototype->getExceptionSpecInfo());
5059         break;
5060       }
5061 
5062       case UPD_CXX_DEDUCED_RETURN_TYPE:
5063         Record.push_back(GetOrCreateTypeID(Update.getType()));
5064         break;
5065 
5066       case UPD_DECL_MARKED_USED:
5067         break;
5068 
5069       case UPD_MANGLING_NUMBER:
5070       case UPD_STATIC_LOCAL_NUMBER:
5071         Record.push_back(Update.getNumber());
5072         break;
5073 
5074       case UPD_DECL_MARKED_OPENMP_THREADPRIVATE:
5075         Record.AddSourceRange(
5076             D->getAttr<OMPThreadPrivateDeclAttr>()->getRange());
5077         break;
5078 
5079       case UPD_DECL_MARKED_OPENMP_ALLOCATE: {
5080         auto *A = D->getAttr<OMPAllocateDeclAttr>();
5081         Record.push_back(A->getAllocatorType());
5082         Record.AddStmt(A->getAllocator());
5083         Record.AddSourceRange(A->getRange());
5084         break;
5085       }
5086 
5087       case UPD_DECL_MARKED_OPENMP_DECLARETARGET:
5088         Record.push_back(D->getAttr<OMPDeclareTargetDeclAttr>()->getMapType());
5089         Record.AddSourceRange(
5090             D->getAttr<OMPDeclareTargetDeclAttr>()->getRange());
5091         break;
5092 
5093       case UPD_DECL_EXPORTED:
5094         Record.push_back(getSubmoduleID(Update.getModule()));
5095         break;
5096 
5097       case UPD_ADDED_ATTR_TO_RECORD:
5098         Record.AddAttributes(llvm::makeArrayRef(Update.getAttr()));
5099         break;
5100       }
5101     }
5102 
5103     if (HasUpdatedBody) {
5104       const auto *Def = cast<FunctionDecl>(D);
5105       Record.push_back(UPD_CXX_ADDED_FUNCTION_DEFINITION);
5106       Record.push_back(Def->isInlined());
5107       Record.AddSourceLocation(Def->getInnerLocStart());
5108       Record.AddFunctionDefinition(Def);
5109     }
5110 
5111     OffsetsRecord.push_back(GetDeclRef(D));
5112     OffsetsRecord.push_back(Record.Emit(DECL_UPDATES));
5113   }
5114 }
5115 
5116 void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
5117   uint32_t Raw = Loc.getRawEncoding();
5118   Record.push_back((Raw << 1) | (Raw >> 31));
5119 }
5120 
5121 void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
5122   AddSourceLocation(Range.getBegin(), Record);
5123   AddSourceLocation(Range.getEnd(), Record);
5124 }
5125 
5126 void ASTRecordWriter::AddAPFloat(const llvm::APFloat &Value) {
5127   AddAPInt(Value.bitcastToAPInt());
5128 }
5129 
5130 static void WriteFixedPointSemantics(ASTRecordWriter &Record,
5131                                      llvm::FixedPointSemantics FPSema) {
5132   Record.push_back(FPSema.getWidth());
5133   Record.push_back(FPSema.getScale());
5134   Record.push_back(FPSema.isSigned() | FPSema.isSaturated() << 1 |
5135                    FPSema.hasUnsignedPadding() << 2);
5136 }
5137 
5138 void ASTRecordWriter::AddAPValue(const APValue &Value) {
5139   APValue::ValueKind Kind = Value.getKind();
5140   push_back(static_cast<uint64_t>(Kind));
5141   switch (Kind) {
5142   case APValue::None:
5143   case APValue::Indeterminate:
5144     return;
5145   case APValue::Int:
5146     AddAPSInt(Value.getInt());
5147     return;
5148   case APValue::Float:
5149     push_back(static_cast<uint64_t>(
5150         llvm::APFloatBase::SemanticsToEnum(Value.getFloat().getSemantics())));
5151     AddAPFloat(Value.getFloat());
5152     return;
5153   case APValue::FixedPoint: {
5154     WriteFixedPointSemantics(*this, Value.getFixedPoint().getSemantics());
5155     AddAPSInt(Value.getFixedPoint().getValue());
5156     return;
5157   }
5158   case APValue::ComplexInt: {
5159     AddAPSInt(Value.getComplexIntReal());
5160     AddAPSInt(Value.getComplexIntImag());
5161     return;
5162   }
5163   case APValue::ComplexFloat: {
5164     push_back(static_cast<uint64_t>(llvm::APFloatBase::SemanticsToEnum(
5165         Value.getComplexFloatReal().getSemantics())));
5166     AddAPFloat(Value.getComplexFloatReal());
5167     push_back(static_cast<uint64_t>(llvm::APFloatBase::SemanticsToEnum(
5168         Value.getComplexFloatImag().getSemantics())));
5169     AddAPFloat(Value.getComplexFloatImag());
5170     return;
5171   }
5172   case APValue::LValue:
5173   case APValue::Vector:
5174   case APValue::Array:
5175   case APValue::Struct:
5176   case APValue::Union:
5177   case APValue::MemberPointer:
5178   case APValue::AddrLabelDiff:
5179     // TODO : Handle all these APValue::ValueKind.
5180     return;
5181   }
5182   llvm_unreachable("Invalid APValue::ValueKind");
5183 }
5184 
5185 void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
5186   Record.push_back(getIdentifierRef(II));
5187 }
5188 
5189 IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
5190   if (!II)
5191     return 0;
5192 
5193   IdentID &ID = IdentifierIDs[II];
5194   if (ID == 0)
5195     ID = NextIdentID++;
5196   return ID;
5197 }
5198 
5199 MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) {
5200   // Don't emit builtin macros like __LINE__ to the AST file unless they
5201   // have been redefined by the header (in which case they are not
5202   // isBuiltinMacro).
5203   if (!MI || MI->isBuiltinMacro())
5204     return 0;
5205 
5206   MacroID &ID = MacroIDs[MI];
5207   if (ID == 0) {
5208     ID = NextMacroID++;
5209     MacroInfoToEmitData Info = { Name, MI, ID };
5210     MacroInfosToEmit.push_back(Info);
5211   }
5212   return ID;
5213 }
5214 
5215 MacroID ASTWriter::getMacroID(MacroInfo *MI) {
5216   if (!MI || MI->isBuiltinMacro())
5217     return 0;
5218 
5219   assert(MacroIDs.find(MI) != MacroIDs.end() && "Macro not emitted!");
5220   return MacroIDs[MI];
5221 }
5222 
5223 uint32_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) {
5224   return IdentMacroDirectivesOffsetMap.lookup(Name);
5225 }
5226 
5227 void ASTRecordWriter::AddSelectorRef(const Selector SelRef) {
5228   Record->push_back(Writer->getSelectorRef(SelRef));
5229 }
5230 
5231 SelectorID ASTWriter::getSelectorRef(Selector Sel) {
5232   if (Sel.getAsOpaquePtr() == nullptr) {
5233     return 0;
5234   }
5235 
5236   SelectorID SID = SelectorIDs[Sel];
5237   if (SID == 0 && Chain) {
5238     // This might trigger a ReadSelector callback, which will set the ID for
5239     // this selector.
5240     Chain->LoadSelector(Sel);
5241     SID = SelectorIDs[Sel];
5242   }
5243   if (SID == 0) {
5244     SID = NextSelectorID++;
5245     SelectorIDs[Sel] = SID;
5246   }
5247   return SID;
5248 }
5249 
5250 void ASTRecordWriter::AddCXXTemporary(const CXXTemporary *Temp) {
5251   AddDeclRef(Temp->getDestructor());
5252 }
5253 
5254 void ASTRecordWriter::AddTemplateArgumentLocInfo(
5255     TemplateArgument::ArgKind Kind, const TemplateArgumentLocInfo &Arg) {
5256   switch (Kind) {
5257   case TemplateArgument::Expression:
5258     AddStmt(Arg.getAsExpr());
5259     break;
5260   case TemplateArgument::Type:
5261     AddTypeSourceInfo(Arg.getAsTypeSourceInfo());
5262     break;
5263   case TemplateArgument::Template:
5264     AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
5265     AddSourceLocation(Arg.getTemplateNameLoc());
5266     break;
5267   case TemplateArgument::TemplateExpansion:
5268     AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
5269     AddSourceLocation(Arg.getTemplateNameLoc());
5270     AddSourceLocation(Arg.getTemplateEllipsisLoc());
5271     break;
5272   case TemplateArgument::Null:
5273   case TemplateArgument::Integral:
5274   case TemplateArgument::Declaration:
5275   case TemplateArgument::NullPtr:
5276   case TemplateArgument::Pack:
5277     // FIXME: Is this right?
5278     break;
5279   }
5280 }
5281 
5282 void ASTRecordWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg) {
5283   AddTemplateArgument(Arg.getArgument());
5284 
5285   if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
5286     bool InfoHasSameExpr
5287       = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
5288     Record->push_back(InfoHasSameExpr);
5289     if (InfoHasSameExpr)
5290       return; // Avoid storing the same expr twice.
5291   }
5292   AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo());
5293 }
5294 
5295 void ASTRecordWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo) {
5296   if (!TInfo) {
5297     AddTypeRef(QualType());
5298     return;
5299   }
5300 
5301   AddTypeRef(TInfo->getType());
5302   AddTypeLoc(TInfo->getTypeLoc());
5303 }
5304 
5305 void ASTRecordWriter::AddTypeLoc(TypeLoc TL) {
5306   TypeLocWriter TLW(*this);
5307   for (; !TL.isNull(); TL = TL.getNextTypeLoc())
5308     TLW.Visit(TL);
5309 }
5310 
5311 void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
5312   Record.push_back(GetOrCreateTypeID(T));
5313 }
5314 
5315 TypeID ASTWriter::GetOrCreateTypeID(QualType T) {
5316   assert(Context);
5317   return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
5318     if (T.isNull())
5319       return TypeIdx();
5320     assert(!T.getLocalFastQualifiers());
5321 
5322     TypeIdx &Idx = TypeIdxs[T];
5323     if (Idx.getIndex() == 0) {
5324       if (DoneWritingDeclsAndTypes) {
5325         assert(0 && "New type seen after serializing all the types to emit!");
5326         return TypeIdx();
5327       }
5328 
5329       // We haven't seen this type before. Assign it a new ID and put it
5330       // into the queue of types to emit.
5331       Idx = TypeIdx(NextTypeID++);
5332       DeclTypesToEmit.push(T);
5333     }
5334     return Idx;
5335   });
5336 }
5337 
5338 TypeID ASTWriter::getTypeID(QualType T) const {
5339   assert(Context);
5340   return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
5341     if (T.isNull())
5342       return TypeIdx();
5343     assert(!T.getLocalFastQualifiers());
5344 
5345     TypeIdxMap::const_iterator I = TypeIdxs.find(T);
5346     assert(I != TypeIdxs.end() && "Type not emitted!");
5347     return I->second;
5348   });
5349 }
5350 
5351 void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
5352   Record.push_back(GetDeclRef(D));
5353 }
5354 
5355 DeclID ASTWriter::GetDeclRef(const Decl *D) {
5356   assert(WritingAST && "Cannot request a declaration ID before AST writing");
5357 
5358   if (!D) {
5359     return 0;
5360   }
5361 
5362   // If D comes from an AST file, its declaration ID is already known and
5363   // fixed.
5364   if (D->isFromASTFile())
5365     return D->getGlobalID();
5366 
5367   assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
5368   DeclID &ID = DeclIDs[D];
5369   if (ID == 0) {
5370     if (DoneWritingDeclsAndTypes) {
5371       assert(0 && "New decl seen after serializing all the decls to emit!");
5372       return 0;
5373     }
5374 
5375     // We haven't seen this declaration before. Give it a new ID and
5376     // enqueue it in the list of declarations to emit.
5377     ID = NextDeclID++;
5378     DeclTypesToEmit.push(const_cast<Decl *>(D));
5379   }
5380 
5381   return ID;
5382 }
5383 
5384 DeclID ASTWriter::getDeclID(const Decl *D) {
5385   if (!D)
5386     return 0;
5387 
5388   // If D comes from an AST file, its declaration ID is already known and
5389   // fixed.
5390   if (D->isFromASTFile())
5391     return D->getGlobalID();
5392 
5393   assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
5394   return DeclIDs[D];
5395 }
5396 
5397 void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) {
5398   assert(ID);
5399   assert(D);
5400 
5401   SourceLocation Loc = D->getLocation();
5402   if (Loc.isInvalid())
5403     return;
5404 
5405   // We only keep track of the file-level declarations of each file.
5406   if (!D->getLexicalDeclContext()->isFileContext())
5407     return;
5408   // FIXME: ParmVarDecls that are part of a function type of a parameter of
5409   // a function/objc method, should not have TU as lexical context.
5410   // TemplateTemplateParmDecls that are part of an alias template, should not
5411   // have TU as lexical context.
5412   if (isa<ParmVarDecl>(D) || isa<TemplateTemplateParmDecl>(D))
5413     return;
5414 
5415   SourceManager &SM = Context->getSourceManager();
5416   SourceLocation FileLoc = SM.getFileLoc(Loc);
5417   assert(SM.isLocalSourceLocation(FileLoc));
5418   FileID FID;
5419   unsigned Offset;
5420   std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
5421   if (FID.isInvalid())
5422     return;
5423   assert(SM.getSLocEntry(FID).isFile());
5424 
5425   std::unique_ptr<DeclIDInFileInfo> &Info = FileDeclIDs[FID];
5426   if (!Info)
5427     Info = std::make_unique<DeclIDInFileInfo>();
5428 
5429   std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID);
5430   LocDeclIDsTy &Decls = Info->DeclIDs;
5431 
5432   if (Decls.empty() || Decls.back().first <= Offset) {
5433     Decls.push_back(LocDecl);
5434     return;
5435   }
5436 
5437   LocDeclIDsTy::iterator I =
5438       llvm::upper_bound(Decls, LocDecl, llvm::less_first());
5439 
5440   Decls.insert(I, LocDecl);
5441 }
5442 
5443 unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) {
5444   assert(needsAnonymousDeclarationNumber(D) &&
5445          "expected an anonymous declaration");
5446 
5447   // Number the anonymous declarations within this context, if we've not
5448   // already done so.
5449   auto It = AnonymousDeclarationNumbers.find(D);
5450   if (It == AnonymousDeclarationNumbers.end()) {
5451     auto *DC = D->getLexicalDeclContext();
5452     numberAnonymousDeclsWithin(DC, [&](const NamedDecl *ND, unsigned Number) {
5453       AnonymousDeclarationNumbers[ND] = Number;
5454     });
5455 
5456     It = AnonymousDeclarationNumbers.find(D);
5457     assert(It != AnonymousDeclarationNumbers.end() &&
5458            "declaration not found within its lexical context");
5459   }
5460 
5461   return It->second;
5462 }
5463 
5464 void ASTRecordWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
5465                                             DeclarationName Name) {
5466   switch (Name.getNameKind()) {
5467   case DeclarationName::CXXConstructorName:
5468   case DeclarationName::CXXDestructorName:
5469   case DeclarationName::CXXConversionFunctionName:
5470     AddTypeSourceInfo(DNLoc.NamedType.TInfo);
5471     break;
5472 
5473   case DeclarationName::CXXOperatorName:
5474     AddSourceLocation(SourceLocation::getFromRawEncoding(
5475         DNLoc.CXXOperatorName.BeginOpNameLoc));
5476     AddSourceLocation(
5477         SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc));
5478     break;
5479 
5480   case DeclarationName::CXXLiteralOperatorName:
5481     AddSourceLocation(SourceLocation::getFromRawEncoding(
5482         DNLoc.CXXLiteralOperatorName.OpNameLoc));
5483     break;
5484 
5485   case DeclarationName::Identifier:
5486   case DeclarationName::ObjCZeroArgSelector:
5487   case DeclarationName::ObjCOneArgSelector:
5488   case DeclarationName::ObjCMultiArgSelector:
5489   case DeclarationName::CXXUsingDirective:
5490   case DeclarationName::CXXDeductionGuideName:
5491     break;
5492   }
5493 }
5494 
5495 void ASTRecordWriter::AddDeclarationNameInfo(
5496     const DeclarationNameInfo &NameInfo) {
5497   AddDeclarationName(NameInfo.getName());
5498   AddSourceLocation(NameInfo.getLoc());
5499   AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName());
5500 }
5501 
5502 void ASTRecordWriter::AddQualifierInfo(const QualifierInfo &Info) {
5503   AddNestedNameSpecifierLoc(Info.QualifierLoc);
5504   Record->push_back(Info.NumTemplParamLists);
5505   for (unsigned i = 0, e = Info.NumTemplParamLists; i != e; ++i)
5506     AddTemplateParameterList(Info.TemplParamLists[i]);
5507 }
5508 
5509 void ASTRecordWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
5510   // Nested name specifiers usually aren't too long. I think that 8 would
5511   // typically accommodate the vast majority.
5512   SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
5513 
5514   // Push each of the nested-name-specifiers's onto a stack for
5515   // serialization in reverse order.
5516   while (NNS) {
5517     NestedNames.push_back(NNS);
5518     NNS = NNS.getPrefix();
5519   }
5520 
5521   Record->push_back(NestedNames.size());
5522   while(!NestedNames.empty()) {
5523     NNS = NestedNames.pop_back_val();
5524     NestedNameSpecifier::SpecifierKind Kind
5525       = NNS.getNestedNameSpecifier()->getKind();
5526     Record->push_back(Kind);
5527     switch (Kind) {
5528     case NestedNameSpecifier::Identifier:
5529       AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier());
5530       AddSourceRange(NNS.getLocalSourceRange());
5531       break;
5532 
5533     case NestedNameSpecifier::Namespace:
5534       AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace());
5535       AddSourceRange(NNS.getLocalSourceRange());
5536       break;
5537 
5538     case NestedNameSpecifier::NamespaceAlias:
5539       AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias());
5540       AddSourceRange(NNS.getLocalSourceRange());
5541       break;
5542 
5543     case NestedNameSpecifier::TypeSpec:
5544     case NestedNameSpecifier::TypeSpecWithTemplate:
5545       Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5546       AddTypeRef(NNS.getTypeLoc().getType());
5547       AddTypeLoc(NNS.getTypeLoc());
5548       AddSourceLocation(NNS.getLocalSourceRange().getEnd());
5549       break;
5550 
5551     case NestedNameSpecifier::Global:
5552       AddSourceLocation(NNS.getLocalSourceRange().getEnd());
5553       break;
5554 
5555     case NestedNameSpecifier::Super:
5556       AddDeclRef(NNS.getNestedNameSpecifier()->getAsRecordDecl());
5557       AddSourceRange(NNS.getLocalSourceRange());
5558       break;
5559     }
5560   }
5561 }
5562 
5563 void ASTRecordWriter::AddTemplateParameterList(
5564     const TemplateParameterList *TemplateParams) {
5565   assert(TemplateParams && "No TemplateParams!");
5566   AddSourceLocation(TemplateParams->getTemplateLoc());
5567   AddSourceLocation(TemplateParams->getLAngleLoc());
5568   AddSourceLocation(TemplateParams->getRAngleLoc());
5569 
5570   Record->push_back(TemplateParams->size());
5571   for (const auto &P : *TemplateParams)
5572     AddDeclRef(P);
5573   if (const Expr *RequiresClause = TemplateParams->getRequiresClause()) {
5574     Record->push_back(true);
5575     AddStmt(const_cast<Expr*>(RequiresClause));
5576   } else {
5577     Record->push_back(false);
5578   }
5579 }
5580 
5581 /// Emit a template argument list.
5582 void ASTRecordWriter::AddTemplateArgumentList(
5583     const TemplateArgumentList *TemplateArgs) {
5584   assert(TemplateArgs && "No TemplateArgs!");
5585   Record->push_back(TemplateArgs->size());
5586   for (int i = 0, e = TemplateArgs->size(); i != e; ++i)
5587     AddTemplateArgument(TemplateArgs->get(i));
5588 }
5589 
5590 void ASTRecordWriter::AddASTTemplateArgumentListInfo(
5591     const ASTTemplateArgumentListInfo *ASTTemplArgList) {
5592   assert(ASTTemplArgList && "No ASTTemplArgList!");
5593   AddSourceLocation(ASTTemplArgList->LAngleLoc);
5594   AddSourceLocation(ASTTemplArgList->RAngleLoc);
5595   Record->push_back(ASTTemplArgList->NumTemplateArgs);
5596   const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
5597   for (int i = 0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
5598     AddTemplateArgumentLoc(TemplArgs[i]);
5599 }
5600 
5601 void ASTRecordWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set) {
5602   Record->push_back(Set.size());
5603   for (ASTUnresolvedSet::const_iterator
5604          I = Set.begin(), E = Set.end(); I != E; ++I) {
5605     AddDeclRef(I.getDecl());
5606     Record->push_back(I.getAccess());
5607   }
5608 }
5609 
5610 // FIXME: Move this out of the main ASTRecordWriter interface.
5611 void ASTRecordWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base) {
5612   Record->push_back(Base.isVirtual());
5613   Record->push_back(Base.isBaseOfClass());
5614   Record->push_back(Base.getAccessSpecifierAsWritten());
5615   Record->push_back(Base.getInheritConstructors());
5616   AddTypeSourceInfo(Base.getTypeSourceInfo());
5617   AddSourceRange(Base.getSourceRange());
5618   AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
5619                                           : SourceLocation());
5620 }
5621 
5622 static uint64_t EmitCXXBaseSpecifiers(ASTWriter &W,
5623                                       ArrayRef<CXXBaseSpecifier> Bases) {
5624   ASTWriter::RecordData Record;
5625   ASTRecordWriter Writer(W, Record);
5626   Writer.push_back(Bases.size());
5627 
5628   for (auto &Base : Bases)
5629     Writer.AddCXXBaseSpecifier(Base);
5630 
5631   return Writer.Emit(serialization::DECL_CXX_BASE_SPECIFIERS);
5632 }
5633 
5634 // FIXME: Move this out of the main ASTRecordWriter interface.
5635 void ASTRecordWriter::AddCXXBaseSpecifiers(ArrayRef<CXXBaseSpecifier> Bases) {
5636   AddOffset(EmitCXXBaseSpecifiers(*Writer, Bases));
5637 }
5638 
5639 static uint64_t
5640 EmitCXXCtorInitializers(ASTWriter &W,
5641                         ArrayRef<CXXCtorInitializer *> CtorInits) {
5642   ASTWriter::RecordData Record;
5643   ASTRecordWriter Writer(W, Record);
5644   Writer.push_back(CtorInits.size());
5645 
5646   for (auto *Init : CtorInits) {
5647     if (Init->isBaseInitializer()) {
5648       Writer.push_back(CTOR_INITIALIZER_BASE);
5649       Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
5650       Writer.push_back(Init->isBaseVirtual());
5651     } else if (Init->isDelegatingInitializer()) {
5652       Writer.push_back(CTOR_INITIALIZER_DELEGATING);
5653       Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
5654     } else if (Init->isMemberInitializer()){
5655       Writer.push_back(CTOR_INITIALIZER_MEMBER);
5656       Writer.AddDeclRef(Init->getMember());
5657     } else {
5658       Writer.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER);
5659       Writer.AddDeclRef(Init->getIndirectMember());
5660     }
5661 
5662     Writer.AddSourceLocation(Init->getMemberLocation());
5663     Writer.AddStmt(Init->getInit());
5664     Writer.AddSourceLocation(Init->getLParenLoc());
5665     Writer.AddSourceLocation(Init->getRParenLoc());
5666     Writer.push_back(Init->isWritten());
5667     if (Init->isWritten())
5668       Writer.push_back(Init->getSourceOrder());
5669   }
5670 
5671   return Writer.Emit(serialization::DECL_CXX_CTOR_INITIALIZERS);
5672 }
5673 
5674 // FIXME: Move this out of the main ASTRecordWriter interface.
5675 void ASTRecordWriter::AddCXXCtorInitializers(
5676     ArrayRef<CXXCtorInitializer *> CtorInits) {
5677   AddOffset(EmitCXXCtorInitializers(*Writer, CtorInits));
5678 }
5679 
5680 void ASTRecordWriter::AddCXXDefinitionData(const CXXRecordDecl *D) {
5681   auto &Data = D->data();
5682   Record->push_back(Data.IsLambda);
5683 
5684   #define FIELD(Name, Width, Merge) \
5685   Record->push_back(Data.Name);
5686   #include "clang/AST/CXXRecordDeclDefinitionBits.def"
5687 
5688   // getODRHash will compute the ODRHash if it has not been previously computed.
5689   Record->push_back(D->getODRHash());
5690   bool ModulesDebugInfo =
5691       Writer->Context->getLangOpts().ModulesDebugInfo && !D->isDependentType();
5692   Record->push_back(ModulesDebugInfo);
5693   if (ModulesDebugInfo)
5694     Writer->ModularCodegenDecls.push_back(Writer->GetDeclRef(D));
5695 
5696   // IsLambda bit is already saved.
5697 
5698   Record->push_back(Data.NumBases);
5699   if (Data.NumBases > 0)
5700     AddCXXBaseSpecifiers(Data.bases());
5701 
5702   // FIXME: Make VBases lazily computed when needed to avoid storing them.
5703   Record->push_back(Data.NumVBases);
5704   if (Data.NumVBases > 0)
5705     AddCXXBaseSpecifiers(Data.vbases());
5706 
5707   AddUnresolvedSet(Data.Conversions.get(*Writer->Context));
5708   Record->push_back(Data.ComputedVisibleConversions);
5709   if (Data.ComputedVisibleConversions)
5710     AddUnresolvedSet(Data.VisibleConversions.get(*Writer->Context));
5711   // Data.Definition is the owning decl, no need to write it.
5712   AddDeclRef(D->getFirstFriend());
5713 
5714   // Add lambda-specific data.
5715   if (Data.IsLambda) {
5716     auto &Lambda = D->getLambdaData();
5717     Record->push_back(Lambda.Dependent);
5718     Record->push_back(Lambda.IsGenericLambda);
5719     Record->push_back(Lambda.CaptureDefault);
5720     Record->push_back(Lambda.NumCaptures);
5721     Record->push_back(Lambda.NumExplicitCaptures);
5722     Record->push_back(Lambda.HasKnownInternalLinkage);
5723     Record->push_back(Lambda.ManglingNumber);
5724     AddDeclRef(D->getLambdaContextDecl());
5725     AddTypeSourceInfo(Lambda.MethodTyInfo);
5726     for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
5727       const LambdaCapture &Capture = Lambda.Captures[I];
5728       AddSourceLocation(Capture.getLocation());
5729       Record->push_back(Capture.isImplicit());
5730       Record->push_back(Capture.getCaptureKind());
5731       switch (Capture.getCaptureKind()) {
5732       case LCK_StarThis:
5733       case LCK_This:
5734       case LCK_VLAType:
5735         break;
5736       case LCK_ByCopy:
5737       case LCK_ByRef:
5738         VarDecl *Var =
5739             Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
5740         AddDeclRef(Var);
5741         AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc()
5742                                                     : SourceLocation());
5743         break;
5744       }
5745     }
5746   }
5747 }
5748 
5749 void ASTWriter::ReaderInitialized(ASTReader *Reader) {
5750   assert(Reader && "Cannot remove chain");
5751   assert((!Chain || Chain == Reader) && "Cannot replace chain");
5752   assert(FirstDeclID == NextDeclID &&
5753          FirstTypeID == NextTypeID &&
5754          FirstIdentID == NextIdentID &&
5755          FirstMacroID == NextMacroID &&
5756          FirstSubmoduleID == NextSubmoduleID &&
5757          FirstSelectorID == NextSelectorID &&
5758          "Setting chain after writing has started.");
5759 
5760   Chain = Reader;
5761 
5762   // Note, this will get called multiple times, once one the reader starts up
5763   // and again each time it's done reading a PCH or module.
5764   FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls();
5765   FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes();
5766   FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers();
5767   FirstMacroID = NUM_PREDEF_MACRO_IDS + Chain->getTotalNumMacros();
5768   FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
5769   FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
5770   NextDeclID = FirstDeclID;
5771   NextTypeID = FirstTypeID;
5772   NextIdentID = FirstIdentID;
5773   NextMacroID = FirstMacroID;
5774   NextSelectorID = FirstSelectorID;
5775   NextSubmoduleID = FirstSubmoduleID;
5776 }
5777 
5778 void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
5779   // Always keep the highest ID. See \p TypeRead() for more information.
5780   IdentID &StoredID = IdentifierIDs[II];
5781   if (ID > StoredID)
5782     StoredID = ID;
5783 }
5784 
5785 void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
5786   // Always keep the highest ID. See \p TypeRead() for more information.
5787   MacroID &StoredID = MacroIDs[MI];
5788   if (ID > StoredID)
5789     StoredID = ID;
5790 }
5791 
5792 void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
5793   // Always take the highest-numbered type index. This copes with an interesting
5794   // case for chained AST writing where we schedule writing the type and then,
5795   // later, deserialize the type from another AST. In this case, we want to
5796   // keep the higher-numbered entry so that we can properly write it out to
5797   // the AST file.
5798   TypeIdx &StoredIdx = TypeIdxs[T];
5799   if (Idx.getIndex() >= StoredIdx.getIndex())
5800     StoredIdx = Idx;
5801 }
5802 
5803 void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
5804   // Always keep the highest ID. See \p TypeRead() for more information.
5805   SelectorID &StoredID = SelectorIDs[S];
5806   if (ID > StoredID)
5807     StoredID = ID;
5808 }
5809 
5810 void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
5811                                     MacroDefinitionRecord *MD) {
5812   assert(MacroDefinitions.find(MD) == MacroDefinitions.end());
5813   MacroDefinitions[MD] = ID;
5814 }
5815 
5816 void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
5817   assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end());
5818   SubmoduleIDs[Mod] = ID;
5819 }
5820 
5821 void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
5822   if (Chain && Chain->isProcessingUpdateRecords()) return;
5823   assert(D->isCompleteDefinition());
5824   assert(!WritingAST && "Already writing the AST!");
5825   if (auto *RD = dyn_cast<CXXRecordDecl>(D)) {
5826     // We are interested when a PCH decl is modified.
5827     if (RD->isFromASTFile()) {
5828       // A forward reference was mutated into a definition. Rewrite it.
5829       // FIXME: This happens during template instantiation, should we
5830       // have created a new definition decl instead ?
5831       assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
5832              "completed a tag from another module but not by instantiation?");
5833       DeclUpdates[RD].push_back(
5834           DeclUpdate(UPD_CXX_INSTANTIATED_CLASS_DEFINITION));
5835     }
5836   }
5837 }
5838 
5839 static bool isImportedDeclContext(ASTReader *Chain, const Decl *D) {
5840   if (D->isFromASTFile())
5841     return true;
5842 
5843   // The predefined __va_list_tag struct is imported if we imported any decls.
5844   // FIXME: This is a gross hack.
5845   return D == D->getASTContext().getVaListTagDecl();
5846 }
5847 
5848 void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
5849   if (Chain && Chain->isProcessingUpdateRecords()) return;
5850   assert(DC->isLookupContext() &&
5851           "Should not add lookup results to non-lookup contexts!");
5852 
5853   // TU is handled elsewhere.
5854   if (isa<TranslationUnitDecl>(DC))
5855     return;
5856 
5857   // Namespaces are handled elsewhere, except for template instantiations of
5858   // FunctionTemplateDecls in namespaces. We are interested in cases where the
5859   // local instantiations are added to an imported context. Only happens when
5860   // adding ADL lookup candidates, for example templated friends.
5861   if (isa<NamespaceDecl>(DC) && D->getFriendObjectKind() == Decl::FOK_None &&
5862       !isa<FunctionTemplateDecl>(D))
5863     return;
5864 
5865   // We're only interested in cases where a local declaration is added to an
5866   // imported context.
5867   if (D->isFromASTFile() || !isImportedDeclContext(Chain, cast<Decl>(DC)))
5868     return;
5869 
5870   assert(DC == DC->getPrimaryContext() && "added to non-primary context");
5871   assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
5872   assert(!WritingAST && "Already writing the AST!");
5873   if (UpdatedDeclContexts.insert(DC) && !cast<Decl>(DC)->isFromASTFile()) {
5874     // We're adding a visible declaration to a predefined decl context. Ensure
5875     // that we write out all of its lookup results so we don't get a nasty
5876     // surprise when we try to emit its lookup table.
5877     for (auto *Child : DC->decls())
5878       DeclsToEmitEvenIfUnreferenced.push_back(Child);
5879   }
5880   DeclsToEmitEvenIfUnreferenced.push_back(D);
5881 }
5882 
5883 void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
5884   if (Chain && Chain->isProcessingUpdateRecords()) return;
5885   assert(D->isImplicit());
5886 
5887   // We're only interested in cases where a local declaration is added to an
5888   // imported context.
5889   if (D->isFromASTFile() || !isImportedDeclContext(Chain, RD))
5890     return;
5891 
5892   if (!isa<CXXMethodDecl>(D))
5893     return;
5894 
5895   // A decl coming from PCH was modified.
5896   assert(RD->isCompleteDefinition());
5897   assert(!WritingAST && "Already writing the AST!");
5898   DeclUpdates[RD].push_back(DeclUpdate(UPD_CXX_ADDED_IMPLICIT_MEMBER, D));
5899 }
5900 
5901 void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
5902   if (Chain && Chain->isProcessingUpdateRecords()) return;
5903   assert(!DoneWritingDeclsAndTypes && "Already done writing updates!");
5904   if (!Chain) return;
5905   Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
5906     // If we don't already know the exception specification for this redecl
5907     // chain, add an update record for it.
5908     if (isUnresolvedExceptionSpec(cast<FunctionDecl>(D)
5909                                       ->getType()
5910                                       ->castAs<FunctionProtoType>()
5911                                       ->getExceptionSpecType()))
5912       DeclUpdates[D].push_back(UPD_CXX_RESOLVED_EXCEPTION_SPEC);
5913   });
5914 }
5915 
5916 void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
5917   if (Chain && Chain->isProcessingUpdateRecords()) return;
5918   assert(!WritingAST && "Already writing the AST!");
5919   if (!Chain) return;
5920   Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
5921     DeclUpdates[D].push_back(
5922         DeclUpdate(UPD_CXX_DEDUCED_RETURN_TYPE, ReturnType));
5923   });
5924 }
5925 
5926 void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD,
5927                                        const FunctionDecl *Delete,
5928                                        Expr *ThisArg) {
5929   if (Chain && Chain->isProcessingUpdateRecords()) return;
5930   assert(!WritingAST && "Already writing the AST!");
5931   assert(Delete && "Not given an operator delete");
5932   if (!Chain) return;
5933   Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
5934     DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_RESOLVED_DTOR_DELETE, Delete));
5935   });
5936 }
5937 
5938 void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
5939   if (Chain && Chain->isProcessingUpdateRecords()) return;
5940   assert(!WritingAST && "Already writing the AST!");
5941   if (!D->isFromASTFile())
5942     return; // Declaration not imported from PCH.
5943 
5944   // Implicit function decl from a PCH was defined.
5945   DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
5946 }
5947 
5948 void ASTWriter::VariableDefinitionInstantiated(const VarDecl *D) {
5949   if (Chain && Chain->isProcessingUpdateRecords()) return;
5950   assert(!WritingAST && "Already writing the AST!");
5951   if (!D->isFromASTFile())
5952     return;
5953 
5954   DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_VAR_DEFINITION));
5955 }
5956 
5957 void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
5958   if (Chain && Chain->isProcessingUpdateRecords()) return;
5959   assert(!WritingAST && "Already writing the AST!");
5960   if (!D->isFromASTFile())
5961     return;
5962 
5963   DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
5964 }
5965 
5966 void ASTWriter::InstantiationRequested(const ValueDecl *D) {
5967   if (Chain && Chain->isProcessingUpdateRecords()) return;
5968   assert(!WritingAST && "Already writing the AST!");
5969   if (!D->isFromASTFile())
5970     return;
5971 
5972   // Since the actual instantiation is delayed, this really means that we need
5973   // to update the instantiation location.
5974   SourceLocation POI;
5975   if (auto *VD = dyn_cast<VarDecl>(D))
5976     POI = VD->getPointOfInstantiation();
5977   else
5978     POI = cast<FunctionDecl>(D)->getPointOfInstantiation();
5979   DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_POINT_OF_INSTANTIATION, POI));
5980 }
5981 
5982 void ASTWriter::DefaultArgumentInstantiated(const ParmVarDecl *D) {
5983   if (Chain && Chain->isProcessingUpdateRecords()) return;
5984   assert(!WritingAST && "Already writing the AST!");
5985   if (!D->isFromASTFile())
5986     return;
5987 
5988   DeclUpdates[D].push_back(
5989       DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT, D));
5990 }
5991 
5992 void ASTWriter::DefaultMemberInitializerInstantiated(const FieldDecl *D) {
5993   assert(!WritingAST && "Already writing the AST!");
5994   if (!D->isFromASTFile())
5995     return;
5996 
5997   DeclUpdates[D].push_back(
5998       DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER, D));
5999 }
6000 
6001 void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
6002                                              const ObjCInterfaceDecl *IFD) {
6003   if (Chain && Chain->isProcessingUpdateRecords()) return;
6004   assert(!WritingAST && "Already writing the AST!");
6005   if (!IFD->isFromASTFile())
6006     return; // Declaration not imported from PCH.
6007 
6008   assert(IFD->getDefinition() && "Category on a class without a definition?");
6009   ObjCClassesWithCategories.insert(
6010     const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
6011 }
6012 
6013 void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
6014   if (Chain && Chain->isProcessingUpdateRecords()) return;
6015   assert(!WritingAST && "Already writing the AST!");
6016 
6017   // If there is *any* declaration of the entity that's not from an AST file,
6018   // we can skip writing the update record. We make sure that isUsed() triggers
6019   // completion of the redeclaration chain of the entity.
6020   for (auto Prev = D->getMostRecentDecl(); Prev; Prev = Prev->getPreviousDecl())
6021     if (IsLocalDecl(Prev))
6022       return;
6023 
6024   DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_USED));
6025 }
6026 
6027 void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
6028   if (Chain && Chain->isProcessingUpdateRecords()) return;
6029   assert(!WritingAST && "Already writing the AST!");
6030   if (!D->isFromASTFile())
6031     return;
6032 
6033   DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_THREADPRIVATE));
6034 }
6035 
6036 void ASTWriter::DeclarationMarkedOpenMPAllocate(const Decl *D, const Attr *A) {
6037   if (Chain && Chain->isProcessingUpdateRecords()) return;
6038   assert(!WritingAST && "Already writing the AST!");
6039   if (!D->isFromASTFile())
6040     return;
6041 
6042   DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_ALLOCATE, A));
6043 }
6044 
6045 void ASTWriter::DeclarationMarkedOpenMPDeclareTarget(const Decl *D,
6046                                                      const Attr *Attr) {
6047   if (Chain && Chain->isProcessingUpdateRecords()) return;
6048   assert(!WritingAST && "Already writing the AST!");
6049   if (!D->isFromASTFile())
6050     return;
6051 
6052   DeclUpdates[D].push_back(
6053       DeclUpdate(UPD_DECL_MARKED_OPENMP_DECLARETARGET, Attr));
6054 }
6055 
6056 void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) {
6057   if (Chain && Chain->isProcessingUpdateRecords()) return;
6058   assert(!WritingAST && "Already writing the AST!");
6059   assert(!D->isUnconditionallyVisible() && "expected a hidden declaration");
6060   DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_EXPORTED, M));
6061 }
6062 
6063 void ASTWriter::AddedAttributeToRecord(const Attr *Attr,
6064                                        const RecordDecl *Record) {
6065   if (Chain && Chain->isProcessingUpdateRecords()) return;
6066   assert(!WritingAST && "Already writing the AST!");
6067   if (!Record->isFromASTFile())
6068     return;
6069   DeclUpdates[Record].push_back(DeclUpdate(UPD_ADDED_ATTR_TO_RECORD, Attr));
6070 }
6071 
6072 void ASTWriter::AddedCXXTemplateSpecialization(
6073     const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) {
6074   assert(!WritingAST && "Already writing the AST!");
6075 
6076   if (!TD->getFirstDecl()->isFromASTFile())
6077     return;
6078   if (Chain && Chain->isProcessingUpdateRecords())
6079     return;
6080 
6081   DeclsToEmitEvenIfUnreferenced.push_back(D);
6082 }
6083 
6084 void ASTWriter::AddedCXXTemplateSpecialization(
6085     const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
6086   assert(!WritingAST && "Already writing the AST!");
6087 
6088   if (!TD->getFirstDecl()->isFromASTFile())
6089     return;
6090   if (Chain && Chain->isProcessingUpdateRecords())
6091     return;
6092 
6093   DeclsToEmitEvenIfUnreferenced.push_back(D);
6094 }
6095 
6096 void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
6097                                                const FunctionDecl *D) {
6098   assert(!WritingAST && "Already writing the AST!");
6099 
6100   if (!TD->getFirstDecl()->isFromASTFile())
6101     return;
6102   if (Chain && Chain->isProcessingUpdateRecords())
6103     return;
6104 
6105   DeclsToEmitEvenIfUnreferenced.push_back(D);
6106 }
6107 
6108 //===----------------------------------------------------------------------===//
6109 //// OMPClause Serialization
6110 ////===----------------------------------------------------------------------===//
6111 
6112 namespace {
6113 
6114 class OMPClauseWriter : public OMPClauseVisitor<OMPClauseWriter> {
6115   ASTRecordWriter &Record;
6116 
6117 public:
6118   OMPClauseWriter(ASTRecordWriter &Record) : Record(Record) {}
6119 #define OMP_CLAUSE_CLASS(Enum, Str, Class) void Visit##Class(Class *S);
6120 #include "llvm/Frontend/OpenMP/OMPKinds.def"
6121   void writeClause(OMPClause *C);
6122   void VisitOMPClauseWithPreInit(OMPClauseWithPreInit *C);
6123   void VisitOMPClauseWithPostUpdate(OMPClauseWithPostUpdate *C);
6124 };
6125 
6126 }
6127 
6128 void ASTRecordWriter::writeOMPClause(OMPClause *C) {
6129   OMPClauseWriter(*this).writeClause(C);
6130 }
6131 
6132 void OMPClauseWriter::writeClause(OMPClause *C) {
6133   Record.push_back(unsigned(C->getClauseKind()));
6134   Visit(C);
6135   Record.AddSourceLocation(C->getBeginLoc());
6136   Record.AddSourceLocation(C->getEndLoc());
6137 }
6138 
6139 void OMPClauseWriter::VisitOMPClauseWithPreInit(OMPClauseWithPreInit *C) {
6140   Record.push_back(uint64_t(C->getCaptureRegion()));
6141   Record.AddStmt(C->getPreInitStmt());
6142 }
6143 
6144 void OMPClauseWriter::VisitOMPClauseWithPostUpdate(OMPClauseWithPostUpdate *C) {
6145   VisitOMPClauseWithPreInit(C);
6146   Record.AddStmt(C->getPostUpdateExpr());
6147 }
6148 
6149 void OMPClauseWriter::VisitOMPIfClause(OMPIfClause *C) {
6150   VisitOMPClauseWithPreInit(C);
6151   Record.push_back(uint64_t(C->getNameModifier()));
6152   Record.AddSourceLocation(C->getNameModifierLoc());
6153   Record.AddSourceLocation(C->getColonLoc());
6154   Record.AddStmt(C->getCondition());
6155   Record.AddSourceLocation(C->getLParenLoc());
6156 }
6157 
6158 void OMPClauseWriter::VisitOMPFinalClause(OMPFinalClause *C) {
6159   VisitOMPClauseWithPreInit(C);
6160   Record.AddStmt(C->getCondition());
6161   Record.AddSourceLocation(C->getLParenLoc());
6162 }
6163 
6164 void OMPClauseWriter::VisitOMPNumThreadsClause(OMPNumThreadsClause *C) {
6165   VisitOMPClauseWithPreInit(C);
6166   Record.AddStmt(C->getNumThreads());
6167   Record.AddSourceLocation(C->getLParenLoc());
6168 }
6169 
6170 void OMPClauseWriter::VisitOMPSafelenClause(OMPSafelenClause *C) {
6171   Record.AddStmt(C->getSafelen());
6172   Record.AddSourceLocation(C->getLParenLoc());
6173 }
6174 
6175 void OMPClauseWriter::VisitOMPSimdlenClause(OMPSimdlenClause *C) {
6176   Record.AddStmt(C->getSimdlen());
6177   Record.AddSourceLocation(C->getLParenLoc());
6178 }
6179 
6180 void OMPClauseWriter::VisitOMPAllocatorClause(OMPAllocatorClause *C) {
6181   Record.AddStmt(C->getAllocator());
6182   Record.AddSourceLocation(C->getLParenLoc());
6183 }
6184 
6185 void OMPClauseWriter::VisitOMPCollapseClause(OMPCollapseClause *C) {
6186   Record.AddStmt(C->getNumForLoops());
6187   Record.AddSourceLocation(C->getLParenLoc());
6188 }
6189 
6190 void OMPClauseWriter::VisitOMPDetachClause(OMPDetachClause *C) {
6191   Record.AddStmt(C->getEventHandler());
6192   Record.AddSourceLocation(C->getLParenLoc());
6193 }
6194 
6195 void OMPClauseWriter::VisitOMPDefaultClause(OMPDefaultClause *C) {
6196   Record.push_back(unsigned(C->getDefaultKind()));
6197   Record.AddSourceLocation(C->getLParenLoc());
6198   Record.AddSourceLocation(C->getDefaultKindKwLoc());
6199 }
6200 
6201 void OMPClauseWriter::VisitOMPProcBindClause(OMPProcBindClause *C) {
6202   Record.push_back(unsigned(C->getProcBindKind()));
6203   Record.AddSourceLocation(C->getLParenLoc());
6204   Record.AddSourceLocation(C->getProcBindKindKwLoc());
6205 }
6206 
6207 void OMPClauseWriter::VisitOMPScheduleClause(OMPScheduleClause *C) {
6208   VisitOMPClauseWithPreInit(C);
6209   Record.push_back(C->getScheduleKind());
6210   Record.push_back(C->getFirstScheduleModifier());
6211   Record.push_back(C->getSecondScheduleModifier());
6212   Record.AddStmt(C->getChunkSize());
6213   Record.AddSourceLocation(C->getLParenLoc());
6214   Record.AddSourceLocation(C->getFirstScheduleModifierLoc());
6215   Record.AddSourceLocation(C->getSecondScheduleModifierLoc());
6216   Record.AddSourceLocation(C->getScheduleKindLoc());
6217   Record.AddSourceLocation(C->getCommaLoc());
6218 }
6219 
6220 void OMPClauseWriter::VisitOMPOrderedClause(OMPOrderedClause *C) {
6221   Record.push_back(C->getLoopNumIterations().size());
6222   Record.AddStmt(C->getNumForLoops());
6223   for (Expr *NumIter : C->getLoopNumIterations())
6224     Record.AddStmt(NumIter);
6225   for (unsigned I = 0, E = C->getLoopNumIterations().size(); I <E; ++I)
6226     Record.AddStmt(C->getLoopCounter(I));
6227   Record.AddSourceLocation(C->getLParenLoc());
6228 }
6229 
6230 void OMPClauseWriter::VisitOMPNowaitClause(OMPNowaitClause *) {}
6231 
6232 void OMPClauseWriter::VisitOMPUntiedClause(OMPUntiedClause *) {}
6233 
6234 void OMPClauseWriter::VisitOMPMergeableClause(OMPMergeableClause *) {}
6235 
6236 void OMPClauseWriter::VisitOMPReadClause(OMPReadClause *) {}
6237 
6238 void OMPClauseWriter::VisitOMPWriteClause(OMPWriteClause *) {}
6239 
6240 void OMPClauseWriter::VisitOMPUpdateClause(OMPUpdateClause *C) {
6241   Record.push_back(C->isExtended() ? 1 : 0);
6242   if (C->isExtended()) {
6243     Record.AddSourceLocation(C->getLParenLoc());
6244     Record.AddSourceLocation(C->getArgumentLoc());
6245     Record.writeEnum(C->getDependencyKind());
6246   }
6247 }
6248 
6249 void OMPClauseWriter::VisitOMPCaptureClause(OMPCaptureClause *) {}
6250 
6251 void OMPClauseWriter::VisitOMPSeqCstClause(OMPSeqCstClause *) {}
6252 
6253 void OMPClauseWriter::VisitOMPAcqRelClause(OMPAcqRelClause *) {}
6254 
6255 void OMPClauseWriter::VisitOMPAcquireClause(OMPAcquireClause *) {}
6256 
6257 void OMPClauseWriter::VisitOMPReleaseClause(OMPReleaseClause *) {}
6258 
6259 void OMPClauseWriter::VisitOMPRelaxedClause(OMPRelaxedClause *) {}
6260 
6261 void OMPClauseWriter::VisitOMPThreadsClause(OMPThreadsClause *) {}
6262 
6263 void OMPClauseWriter::VisitOMPSIMDClause(OMPSIMDClause *) {}
6264 
6265 void OMPClauseWriter::VisitOMPNogroupClause(OMPNogroupClause *) {}
6266 
6267 void OMPClauseWriter::VisitOMPDestroyClause(OMPDestroyClause *) {}
6268 
6269 void OMPClauseWriter::VisitOMPPrivateClause(OMPPrivateClause *C) {
6270   Record.push_back(C->varlist_size());
6271   Record.AddSourceLocation(C->getLParenLoc());
6272   for (auto *VE : C->varlists()) {
6273     Record.AddStmt(VE);
6274   }
6275   for (auto *VE : C->private_copies()) {
6276     Record.AddStmt(VE);
6277   }
6278 }
6279 
6280 void OMPClauseWriter::VisitOMPFirstprivateClause(OMPFirstprivateClause *C) {
6281   Record.push_back(C->varlist_size());
6282   VisitOMPClauseWithPreInit(C);
6283   Record.AddSourceLocation(C->getLParenLoc());
6284   for (auto *VE : C->varlists()) {
6285     Record.AddStmt(VE);
6286   }
6287   for (auto *VE : C->private_copies()) {
6288     Record.AddStmt(VE);
6289   }
6290   for (auto *VE : C->inits()) {
6291     Record.AddStmt(VE);
6292   }
6293 }
6294 
6295 void OMPClauseWriter::VisitOMPLastprivateClause(OMPLastprivateClause *C) {
6296   Record.push_back(C->varlist_size());
6297   VisitOMPClauseWithPostUpdate(C);
6298   Record.AddSourceLocation(C->getLParenLoc());
6299   Record.writeEnum(C->getKind());
6300   Record.AddSourceLocation(C->getKindLoc());
6301   Record.AddSourceLocation(C->getColonLoc());
6302   for (auto *VE : C->varlists())
6303     Record.AddStmt(VE);
6304   for (auto *E : C->private_copies())
6305     Record.AddStmt(E);
6306   for (auto *E : C->source_exprs())
6307     Record.AddStmt(E);
6308   for (auto *E : C->destination_exprs())
6309     Record.AddStmt(E);
6310   for (auto *E : C->assignment_ops())
6311     Record.AddStmt(E);
6312 }
6313 
6314 void OMPClauseWriter::VisitOMPSharedClause(OMPSharedClause *C) {
6315   Record.push_back(C->varlist_size());
6316   Record.AddSourceLocation(C->getLParenLoc());
6317   for (auto *VE : C->varlists())
6318     Record.AddStmt(VE);
6319 }
6320 
6321 void OMPClauseWriter::VisitOMPReductionClause(OMPReductionClause *C) {
6322   Record.push_back(C->varlist_size());
6323   Record.writeEnum(C->getModifier());
6324   VisitOMPClauseWithPostUpdate(C);
6325   Record.AddSourceLocation(C->getLParenLoc());
6326   Record.AddSourceLocation(C->getModifierLoc());
6327   Record.AddSourceLocation(C->getColonLoc());
6328   Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6329   Record.AddDeclarationNameInfo(C->getNameInfo());
6330   for (auto *VE : C->varlists())
6331     Record.AddStmt(VE);
6332   for (auto *VE : C->privates())
6333     Record.AddStmt(VE);
6334   for (auto *E : C->lhs_exprs())
6335     Record.AddStmt(E);
6336   for (auto *E : C->rhs_exprs())
6337     Record.AddStmt(E);
6338   for (auto *E : C->reduction_ops())
6339     Record.AddStmt(E);
6340   if (C->getModifier() == clang::OMPC_REDUCTION_inscan) {
6341     for (auto *E : C->copy_ops())
6342       Record.AddStmt(E);
6343     for (auto *E : C->copy_array_temps())
6344       Record.AddStmt(E);
6345     for (auto *E : C->copy_array_elems())
6346       Record.AddStmt(E);
6347   }
6348 }
6349 
6350 void OMPClauseWriter::VisitOMPTaskReductionClause(OMPTaskReductionClause *C) {
6351   Record.push_back(C->varlist_size());
6352   VisitOMPClauseWithPostUpdate(C);
6353   Record.AddSourceLocation(C->getLParenLoc());
6354   Record.AddSourceLocation(C->getColonLoc());
6355   Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6356   Record.AddDeclarationNameInfo(C->getNameInfo());
6357   for (auto *VE : C->varlists())
6358     Record.AddStmt(VE);
6359   for (auto *VE : C->privates())
6360     Record.AddStmt(VE);
6361   for (auto *E : C->lhs_exprs())
6362     Record.AddStmt(E);
6363   for (auto *E : C->rhs_exprs())
6364     Record.AddStmt(E);
6365   for (auto *E : C->reduction_ops())
6366     Record.AddStmt(E);
6367 }
6368 
6369 void OMPClauseWriter::VisitOMPInReductionClause(OMPInReductionClause *C) {
6370   Record.push_back(C->varlist_size());
6371   VisitOMPClauseWithPostUpdate(C);
6372   Record.AddSourceLocation(C->getLParenLoc());
6373   Record.AddSourceLocation(C->getColonLoc());
6374   Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6375   Record.AddDeclarationNameInfo(C->getNameInfo());
6376   for (auto *VE : C->varlists())
6377     Record.AddStmt(VE);
6378   for (auto *VE : C->privates())
6379     Record.AddStmt(VE);
6380   for (auto *E : C->lhs_exprs())
6381     Record.AddStmt(E);
6382   for (auto *E : C->rhs_exprs())
6383     Record.AddStmt(E);
6384   for (auto *E : C->reduction_ops())
6385     Record.AddStmt(E);
6386   for (auto *E : C->taskgroup_descriptors())
6387     Record.AddStmt(E);
6388 }
6389 
6390 void OMPClauseWriter::VisitOMPLinearClause(OMPLinearClause *C) {
6391   Record.push_back(C->varlist_size());
6392   VisitOMPClauseWithPostUpdate(C);
6393   Record.AddSourceLocation(C->getLParenLoc());
6394   Record.AddSourceLocation(C->getColonLoc());
6395   Record.push_back(C->getModifier());
6396   Record.AddSourceLocation(C->getModifierLoc());
6397   for (auto *VE : C->varlists()) {
6398     Record.AddStmt(VE);
6399   }
6400   for (auto *VE : C->privates()) {
6401     Record.AddStmt(VE);
6402   }
6403   for (auto *VE : C->inits()) {
6404     Record.AddStmt(VE);
6405   }
6406   for (auto *VE : C->updates()) {
6407     Record.AddStmt(VE);
6408   }
6409   for (auto *VE : C->finals()) {
6410     Record.AddStmt(VE);
6411   }
6412   Record.AddStmt(C->getStep());
6413   Record.AddStmt(C->getCalcStep());
6414   for (auto *VE : C->used_expressions())
6415     Record.AddStmt(VE);
6416 }
6417 
6418 void OMPClauseWriter::VisitOMPAlignedClause(OMPAlignedClause *C) {
6419   Record.push_back(C->varlist_size());
6420   Record.AddSourceLocation(C->getLParenLoc());
6421   Record.AddSourceLocation(C->getColonLoc());
6422   for (auto *VE : C->varlists())
6423     Record.AddStmt(VE);
6424   Record.AddStmt(C->getAlignment());
6425 }
6426 
6427 void OMPClauseWriter::VisitOMPCopyinClause(OMPCopyinClause *C) {
6428   Record.push_back(C->varlist_size());
6429   Record.AddSourceLocation(C->getLParenLoc());
6430   for (auto *VE : C->varlists())
6431     Record.AddStmt(VE);
6432   for (auto *E : C->source_exprs())
6433     Record.AddStmt(E);
6434   for (auto *E : C->destination_exprs())
6435     Record.AddStmt(E);
6436   for (auto *E : C->assignment_ops())
6437     Record.AddStmt(E);
6438 }
6439 
6440 void OMPClauseWriter::VisitOMPCopyprivateClause(OMPCopyprivateClause *C) {
6441   Record.push_back(C->varlist_size());
6442   Record.AddSourceLocation(C->getLParenLoc());
6443   for (auto *VE : C->varlists())
6444     Record.AddStmt(VE);
6445   for (auto *E : C->source_exprs())
6446     Record.AddStmt(E);
6447   for (auto *E : C->destination_exprs())
6448     Record.AddStmt(E);
6449   for (auto *E : C->assignment_ops())
6450     Record.AddStmt(E);
6451 }
6452 
6453 void OMPClauseWriter::VisitOMPFlushClause(OMPFlushClause *C) {
6454   Record.push_back(C->varlist_size());
6455   Record.AddSourceLocation(C->getLParenLoc());
6456   for (auto *VE : C->varlists())
6457     Record.AddStmt(VE);
6458 }
6459 
6460 void OMPClauseWriter::VisitOMPDepobjClause(OMPDepobjClause *C) {
6461   Record.AddStmt(C->getDepobj());
6462   Record.AddSourceLocation(C->getLParenLoc());
6463 }
6464 
6465 void OMPClauseWriter::VisitOMPDependClause(OMPDependClause *C) {
6466   Record.push_back(C->varlist_size());
6467   Record.push_back(C->getNumLoops());
6468   Record.AddSourceLocation(C->getLParenLoc());
6469   Record.AddStmt(C->getModifier());
6470   Record.push_back(C->getDependencyKind());
6471   Record.AddSourceLocation(C->getDependencyLoc());
6472   Record.AddSourceLocation(C->getColonLoc());
6473   for (auto *VE : C->varlists())
6474     Record.AddStmt(VE);
6475   for (unsigned I = 0, E = C->getNumLoops(); I < E; ++I)
6476     Record.AddStmt(C->getLoopData(I));
6477 }
6478 
6479 void OMPClauseWriter::VisitOMPDeviceClause(OMPDeviceClause *C) {
6480   VisitOMPClauseWithPreInit(C);
6481   Record.writeEnum(C->getModifier());
6482   Record.AddStmt(C->getDevice());
6483   Record.AddSourceLocation(C->getModifierLoc());
6484   Record.AddSourceLocation(C->getLParenLoc());
6485 }
6486 
6487 void OMPClauseWriter::VisitOMPMapClause(OMPMapClause *C) {
6488   Record.push_back(C->varlist_size());
6489   Record.push_back(C->getUniqueDeclarationsNum());
6490   Record.push_back(C->getTotalComponentListNum());
6491   Record.push_back(C->getTotalComponentsNum());
6492   Record.AddSourceLocation(C->getLParenLoc());
6493   for (unsigned I = 0; I < NumberOfOMPMapClauseModifiers; ++I) {
6494     Record.push_back(C->getMapTypeModifier(I));
6495     Record.AddSourceLocation(C->getMapTypeModifierLoc(I));
6496   }
6497   Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
6498   Record.AddDeclarationNameInfo(C->getMapperIdInfo());
6499   Record.push_back(C->getMapType());
6500   Record.AddSourceLocation(C->getMapLoc());
6501   Record.AddSourceLocation(C->getColonLoc());
6502   for (auto *E : C->varlists())
6503     Record.AddStmt(E);
6504   for (auto *E : C->mapperlists())
6505     Record.AddStmt(E);
6506   for (auto *D : C->all_decls())
6507     Record.AddDeclRef(D);
6508   for (auto N : C->all_num_lists())
6509     Record.push_back(N);
6510   for (auto N : C->all_lists_sizes())
6511     Record.push_back(N);
6512   for (auto &M : C->all_components()) {
6513     Record.AddStmt(M.getAssociatedExpression());
6514     Record.AddDeclRef(M.getAssociatedDeclaration());
6515   }
6516 }
6517 
6518 void OMPClauseWriter::VisitOMPAllocateClause(OMPAllocateClause *C) {
6519   Record.push_back(C->varlist_size());
6520   Record.AddSourceLocation(C->getLParenLoc());
6521   Record.AddSourceLocation(C->getColonLoc());
6522   Record.AddStmt(C->getAllocator());
6523   for (auto *VE : C->varlists())
6524     Record.AddStmt(VE);
6525 }
6526 
6527 void OMPClauseWriter::VisitOMPNumTeamsClause(OMPNumTeamsClause *C) {
6528   VisitOMPClauseWithPreInit(C);
6529   Record.AddStmt(C->getNumTeams());
6530   Record.AddSourceLocation(C->getLParenLoc());
6531 }
6532 
6533 void OMPClauseWriter::VisitOMPThreadLimitClause(OMPThreadLimitClause *C) {
6534   VisitOMPClauseWithPreInit(C);
6535   Record.AddStmt(C->getThreadLimit());
6536   Record.AddSourceLocation(C->getLParenLoc());
6537 }
6538 
6539 void OMPClauseWriter::VisitOMPPriorityClause(OMPPriorityClause *C) {
6540   VisitOMPClauseWithPreInit(C);
6541   Record.AddStmt(C->getPriority());
6542   Record.AddSourceLocation(C->getLParenLoc());
6543 }
6544 
6545 void OMPClauseWriter::VisitOMPGrainsizeClause(OMPGrainsizeClause *C) {
6546   VisitOMPClauseWithPreInit(C);
6547   Record.AddStmt(C->getGrainsize());
6548   Record.AddSourceLocation(C->getLParenLoc());
6549 }
6550 
6551 void OMPClauseWriter::VisitOMPNumTasksClause(OMPNumTasksClause *C) {
6552   VisitOMPClauseWithPreInit(C);
6553   Record.AddStmt(C->getNumTasks());
6554   Record.AddSourceLocation(C->getLParenLoc());
6555 }
6556 
6557 void OMPClauseWriter::VisitOMPHintClause(OMPHintClause *C) {
6558   Record.AddStmt(C->getHint());
6559   Record.AddSourceLocation(C->getLParenLoc());
6560 }
6561 
6562 void OMPClauseWriter::VisitOMPDistScheduleClause(OMPDistScheduleClause *C) {
6563   VisitOMPClauseWithPreInit(C);
6564   Record.push_back(C->getDistScheduleKind());
6565   Record.AddStmt(C->getChunkSize());
6566   Record.AddSourceLocation(C->getLParenLoc());
6567   Record.AddSourceLocation(C->getDistScheduleKindLoc());
6568   Record.AddSourceLocation(C->getCommaLoc());
6569 }
6570 
6571 void OMPClauseWriter::VisitOMPDefaultmapClause(OMPDefaultmapClause *C) {
6572   Record.push_back(C->getDefaultmapKind());
6573   Record.push_back(C->getDefaultmapModifier());
6574   Record.AddSourceLocation(C->getLParenLoc());
6575   Record.AddSourceLocation(C->getDefaultmapModifierLoc());
6576   Record.AddSourceLocation(C->getDefaultmapKindLoc());
6577 }
6578 
6579 void OMPClauseWriter::VisitOMPToClause(OMPToClause *C) {
6580   Record.push_back(C->varlist_size());
6581   Record.push_back(C->getUniqueDeclarationsNum());
6582   Record.push_back(C->getTotalComponentListNum());
6583   Record.push_back(C->getTotalComponentsNum());
6584   Record.AddSourceLocation(C->getLParenLoc());
6585   for (unsigned I = 0; I < NumberOfOMPMotionModifiers; ++I) {
6586     Record.push_back(C->getMotionModifier(I));
6587     Record.AddSourceLocation(C->getMotionModifierLoc(I));
6588   }
6589   Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
6590   Record.AddDeclarationNameInfo(C->getMapperIdInfo());
6591   Record.AddSourceLocation(C->getColonLoc());
6592   for (auto *E : C->varlists())
6593     Record.AddStmt(E);
6594   for (auto *E : C->mapperlists())
6595     Record.AddStmt(E);
6596   for (auto *D : C->all_decls())
6597     Record.AddDeclRef(D);
6598   for (auto N : C->all_num_lists())
6599     Record.push_back(N);
6600   for (auto N : C->all_lists_sizes())
6601     Record.push_back(N);
6602   for (auto &M : C->all_components()) {
6603     Record.AddStmt(M.getAssociatedExpression());
6604     Record.AddDeclRef(M.getAssociatedDeclaration());
6605   }
6606 }
6607 
6608 void OMPClauseWriter::VisitOMPFromClause(OMPFromClause *C) {
6609   Record.push_back(C->varlist_size());
6610   Record.push_back(C->getUniqueDeclarationsNum());
6611   Record.push_back(C->getTotalComponentListNum());
6612   Record.push_back(C->getTotalComponentsNum());
6613   Record.AddSourceLocation(C->getLParenLoc());
6614   for (unsigned I = 0; I < NumberOfOMPMotionModifiers; ++I) {
6615     Record.push_back(C->getMotionModifier(I));
6616     Record.AddSourceLocation(C->getMotionModifierLoc(I));
6617   }
6618   Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
6619   Record.AddDeclarationNameInfo(C->getMapperIdInfo());
6620   Record.AddSourceLocation(C->getColonLoc());
6621   for (auto *E : C->varlists())
6622     Record.AddStmt(E);
6623   for (auto *E : C->mapperlists())
6624     Record.AddStmt(E);
6625   for (auto *D : C->all_decls())
6626     Record.AddDeclRef(D);
6627   for (auto N : C->all_num_lists())
6628     Record.push_back(N);
6629   for (auto N : C->all_lists_sizes())
6630     Record.push_back(N);
6631   for (auto &M : C->all_components()) {
6632     Record.AddStmt(M.getAssociatedExpression());
6633     Record.AddDeclRef(M.getAssociatedDeclaration());
6634   }
6635 }
6636 
6637 void OMPClauseWriter::VisitOMPUseDevicePtrClause(OMPUseDevicePtrClause *C) {
6638   Record.push_back(C->varlist_size());
6639   Record.push_back(C->getUniqueDeclarationsNum());
6640   Record.push_back(C->getTotalComponentListNum());
6641   Record.push_back(C->getTotalComponentsNum());
6642   Record.AddSourceLocation(C->getLParenLoc());
6643   for (auto *E : C->varlists())
6644     Record.AddStmt(E);
6645   for (auto *VE : C->private_copies())
6646     Record.AddStmt(VE);
6647   for (auto *VE : C->inits())
6648     Record.AddStmt(VE);
6649   for (auto *D : C->all_decls())
6650     Record.AddDeclRef(D);
6651   for (auto N : C->all_num_lists())
6652     Record.push_back(N);
6653   for (auto N : C->all_lists_sizes())
6654     Record.push_back(N);
6655   for (auto &M : C->all_components()) {
6656     Record.AddStmt(M.getAssociatedExpression());
6657     Record.AddDeclRef(M.getAssociatedDeclaration());
6658   }
6659 }
6660 
6661 void OMPClauseWriter::VisitOMPUseDeviceAddrClause(OMPUseDeviceAddrClause *C) {
6662   Record.push_back(C->varlist_size());
6663   Record.push_back(C->getUniqueDeclarationsNum());
6664   Record.push_back(C->getTotalComponentListNum());
6665   Record.push_back(C->getTotalComponentsNum());
6666   Record.AddSourceLocation(C->getLParenLoc());
6667   for (auto *E : C->varlists())
6668     Record.AddStmt(E);
6669   for (auto *D : C->all_decls())
6670     Record.AddDeclRef(D);
6671   for (auto N : C->all_num_lists())
6672     Record.push_back(N);
6673   for (auto N : C->all_lists_sizes())
6674     Record.push_back(N);
6675   for (auto &M : C->all_components()) {
6676     Record.AddStmt(M.getAssociatedExpression());
6677     Record.AddDeclRef(M.getAssociatedDeclaration());
6678   }
6679 }
6680 
6681 void OMPClauseWriter::VisitOMPIsDevicePtrClause(OMPIsDevicePtrClause *C) {
6682   Record.push_back(C->varlist_size());
6683   Record.push_back(C->getUniqueDeclarationsNum());
6684   Record.push_back(C->getTotalComponentListNum());
6685   Record.push_back(C->getTotalComponentsNum());
6686   Record.AddSourceLocation(C->getLParenLoc());
6687   for (auto *E : C->varlists())
6688     Record.AddStmt(E);
6689   for (auto *D : C->all_decls())
6690     Record.AddDeclRef(D);
6691   for (auto N : C->all_num_lists())
6692     Record.push_back(N);
6693   for (auto N : C->all_lists_sizes())
6694     Record.push_back(N);
6695   for (auto &M : C->all_components()) {
6696     Record.AddStmt(M.getAssociatedExpression());
6697     Record.AddDeclRef(M.getAssociatedDeclaration());
6698   }
6699 }
6700 
6701 void OMPClauseWriter::VisitOMPUnifiedAddressClause(OMPUnifiedAddressClause *) {}
6702 
6703 void OMPClauseWriter::VisitOMPUnifiedSharedMemoryClause(
6704     OMPUnifiedSharedMemoryClause *) {}
6705 
6706 void OMPClauseWriter::VisitOMPReverseOffloadClause(OMPReverseOffloadClause *) {}
6707 
6708 void
6709 OMPClauseWriter::VisitOMPDynamicAllocatorsClause(OMPDynamicAllocatorsClause *) {
6710 }
6711 
6712 void OMPClauseWriter::VisitOMPAtomicDefaultMemOrderClause(
6713     OMPAtomicDefaultMemOrderClause *C) {
6714   Record.push_back(C->getAtomicDefaultMemOrderKind());
6715   Record.AddSourceLocation(C->getLParenLoc());
6716   Record.AddSourceLocation(C->getAtomicDefaultMemOrderKindKwLoc());
6717 }
6718 
6719 void OMPClauseWriter::VisitOMPNontemporalClause(OMPNontemporalClause *C) {
6720   Record.push_back(C->varlist_size());
6721   Record.AddSourceLocation(C->getLParenLoc());
6722   for (auto *VE : C->varlists())
6723     Record.AddStmt(VE);
6724   for (auto *E : C->private_refs())
6725     Record.AddStmt(E);
6726 }
6727 
6728 void OMPClauseWriter::VisitOMPInclusiveClause(OMPInclusiveClause *C) {
6729   Record.push_back(C->varlist_size());
6730   Record.AddSourceLocation(C->getLParenLoc());
6731   for (auto *VE : C->varlists())
6732     Record.AddStmt(VE);
6733 }
6734 
6735 void OMPClauseWriter::VisitOMPExclusiveClause(OMPExclusiveClause *C) {
6736   Record.push_back(C->varlist_size());
6737   Record.AddSourceLocation(C->getLParenLoc());
6738   for (auto *VE : C->varlists())
6739     Record.AddStmt(VE);
6740 }
6741 
6742 void OMPClauseWriter::VisitOMPOrderClause(OMPOrderClause *C) {
6743   Record.writeEnum(C->getKind());
6744   Record.AddSourceLocation(C->getLParenLoc());
6745   Record.AddSourceLocation(C->getKindKwLoc());
6746 }
6747 
6748 void OMPClauseWriter::VisitOMPUsesAllocatorsClause(OMPUsesAllocatorsClause *C) {
6749   Record.push_back(C->getNumberOfAllocators());
6750   Record.AddSourceLocation(C->getLParenLoc());
6751   for (unsigned I = 0, E = C->getNumberOfAllocators(); I < E; ++I) {
6752     OMPUsesAllocatorsClause::Data Data = C->getAllocatorData(I);
6753     Record.AddStmt(Data.Allocator);
6754     Record.AddStmt(Data.AllocatorTraits);
6755     Record.AddSourceLocation(Data.LParenLoc);
6756     Record.AddSourceLocation(Data.RParenLoc);
6757   }
6758 }
6759 
6760 void OMPClauseWriter::VisitOMPAffinityClause(OMPAffinityClause *C) {
6761   Record.push_back(C->varlist_size());
6762   Record.AddSourceLocation(C->getLParenLoc());
6763   Record.AddStmt(C->getModifier());
6764   Record.AddSourceLocation(C->getColonLoc());
6765   for (Expr *E : C->varlists())
6766     Record.AddStmt(E);
6767 }
6768 
6769 void ASTRecordWriter::writeOMPTraitInfo(const OMPTraitInfo *TI) {
6770   writeUInt32(TI->Sets.size());
6771   for (const auto &Set : TI->Sets) {
6772     writeEnum(Set.Kind);
6773     writeUInt32(Set.Selectors.size());
6774     for (const auto &Selector : Set.Selectors) {
6775       writeEnum(Selector.Kind);
6776       writeBool(Selector.ScoreOrCondition);
6777       if (Selector.ScoreOrCondition)
6778         writeExprRef(Selector.ScoreOrCondition);
6779       writeUInt32(Selector.Properties.size());
6780       for (const auto &Property : Selector.Properties)
6781         writeEnum(Property.Kind);
6782     }
6783   }
6784 }
6785 
6786 void ASTRecordWriter::writeOMPChildren(OMPChildren *Data) {
6787   if (!Data)
6788     return;
6789   writeUInt32(Data->getNumClauses());
6790   writeUInt32(Data->getNumChildren());
6791   writeBool(Data->hasAssociatedStmt());
6792   for (unsigned I = 0, E = Data->getNumClauses(); I < E; ++I)
6793     writeOMPClause(Data->getClauses()[I]);
6794   if (Data->hasAssociatedStmt())
6795     AddStmt(Data->getAssociatedStmt());
6796   for (unsigned I = 0, E = Data->getNumChildren(); I < E; ++I)
6797     AddStmt(Data->getChildren()[I]);
6798 }
6799