1 //===--- ASTWriter.cpp - AST File Writer ----------------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 //  This file defines the ASTWriter class, which writes AST files.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "clang/Serialization/ASTWriter.h"
15 #include "clang/Serialization/ModuleFileExtension.h"
16 #include "ASTCommon.h"
17 #include "ASTReaderInternals.h"
18 #include "MultiOnDiskHashTable.h"
19 #include "clang/AST/ASTContext.h"
20 #include "clang/AST/Decl.h"
21 #include "clang/AST/DeclContextInternals.h"
22 #include "clang/AST/DeclFriend.h"
23 #include "clang/AST/DeclLookups.h"
24 #include "clang/AST/DeclTemplate.h"
25 #include "clang/AST/Expr.h"
26 #include "clang/AST/ExprCXX.h"
27 #include "clang/AST/Type.h"
28 #include "clang/AST/TypeLocVisitor.h"
29 #include "clang/Basic/DiagnosticOptions.h"
30 #include "clang/Basic/FileManager.h"
31 #include "clang/Basic/FileSystemStatCache.h"
32 #include "clang/Basic/SourceManager.h"
33 #include "clang/Basic/SourceManagerInternals.h"
34 #include "clang/Basic/TargetInfo.h"
35 #include "clang/Basic/TargetOptions.h"
36 #include "clang/Basic/Version.h"
37 #include "clang/Basic/VersionTuple.h"
38 #include "clang/Lex/HeaderSearch.h"
39 #include "clang/Lex/HeaderSearchOptions.h"
40 #include "clang/Lex/MacroInfo.h"
41 #include "clang/Lex/PreprocessingRecord.h"
42 #include "clang/Lex/Preprocessor.h"
43 #include "clang/Lex/PreprocessorOptions.h"
44 #include "clang/Sema/IdentifierResolver.h"
45 #include "clang/Sema/Sema.h"
46 #include "clang/Serialization/ASTReader.h"
47 #include "clang/Serialization/SerializationDiagnostic.h"
48 #include "llvm/ADT/APFloat.h"
49 #include "llvm/ADT/APInt.h"
50 #include "llvm/ADT/Hashing.h"
51 #include "llvm/ADT/StringExtras.h"
52 #include "llvm/Bitcode/BitstreamWriter.h"
53 #include "llvm/Support/EndianStream.h"
54 #include "llvm/Support/FileSystem.h"
55 #include "llvm/Support/MemoryBuffer.h"
56 #include "llvm/Support/OnDiskHashTable.h"
57 #include "llvm/Support/Path.h"
58 #include "llvm/Support/Process.h"
59 #include <algorithm>
60 #include <cstdio>
61 #include <string.h>
62 #include <utility>
63 using namespace clang;
64 using namespace clang::serialization;
65 
66 template <typename T, typename Allocator>
67 static StringRef bytes(const std::vector<T, Allocator> &v) {
68   if (v.empty()) return StringRef();
69   return StringRef(reinterpret_cast<const char*>(&v[0]),
70                          sizeof(T) * v.size());
71 }
72 
73 template <typename T>
74 static StringRef bytes(const SmallVectorImpl<T> &v) {
75   return StringRef(reinterpret_cast<const char*>(v.data()),
76                          sizeof(T) * v.size());
77 }
78 
79 //===----------------------------------------------------------------------===//
80 // Type serialization
81 //===----------------------------------------------------------------------===//
82 
83 namespace {
84   class ASTTypeWriter {
85     ASTWriter &Writer;
86     ASTWriter::RecordDataImpl &Record;
87 
88   public:
89     /// \brief Type code that corresponds to the record generated.
90     TypeCode Code;
91     /// \brief Abbreviation to use for the record, if any.
92     unsigned AbbrevToUse;
93 
94     ASTTypeWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record)
95       : Writer(Writer), Record(Record), Code(TYPE_EXT_QUAL) { }
96 
97     void VisitArrayType(const ArrayType *T);
98     void VisitFunctionType(const FunctionType *T);
99     void VisitTagType(const TagType *T);
100 
101 #define TYPE(Class, Base) void Visit##Class##Type(const Class##Type *T);
102 #define ABSTRACT_TYPE(Class, Base)
103 #include "clang/AST/TypeNodes.def"
104   };
105 }
106 
107 void ASTTypeWriter::VisitBuiltinType(const BuiltinType *T) {
108   llvm_unreachable("Built-in types are never serialized");
109 }
110 
111 void ASTTypeWriter::VisitComplexType(const ComplexType *T) {
112   Writer.AddTypeRef(T->getElementType(), Record);
113   Code = TYPE_COMPLEX;
114 }
115 
116 void ASTTypeWriter::VisitPointerType(const PointerType *T) {
117   Writer.AddTypeRef(T->getPointeeType(), Record);
118   Code = TYPE_POINTER;
119 }
120 
121 void ASTTypeWriter::VisitDecayedType(const DecayedType *T) {
122   Writer.AddTypeRef(T->getOriginalType(), Record);
123   Code = TYPE_DECAYED;
124 }
125 
126 void ASTTypeWriter::VisitAdjustedType(const AdjustedType *T) {
127   Writer.AddTypeRef(T->getOriginalType(), Record);
128   Writer.AddTypeRef(T->getAdjustedType(), Record);
129   Code = TYPE_ADJUSTED;
130 }
131 
132 void ASTTypeWriter::VisitBlockPointerType(const BlockPointerType *T) {
133   Writer.AddTypeRef(T->getPointeeType(), Record);
134   Code = TYPE_BLOCK_POINTER;
135 }
136 
137 void ASTTypeWriter::VisitLValueReferenceType(const LValueReferenceType *T) {
138   Writer.AddTypeRef(T->getPointeeTypeAsWritten(), Record);
139   Record.push_back(T->isSpelledAsLValue());
140   Code = TYPE_LVALUE_REFERENCE;
141 }
142 
143 void ASTTypeWriter::VisitRValueReferenceType(const RValueReferenceType *T) {
144   Writer.AddTypeRef(T->getPointeeTypeAsWritten(), Record);
145   Code = TYPE_RVALUE_REFERENCE;
146 }
147 
148 void ASTTypeWriter::VisitMemberPointerType(const MemberPointerType *T) {
149   Writer.AddTypeRef(T->getPointeeType(), Record);
150   Writer.AddTypeRef(QualType(T->getClass(), 0), Record);
151   Code = TYPE_MEMBER_POINTER;
152 }
153 
154 void ASTTypeWriter::VisitArrayType(const ArrayType *T) {
155   Writer.AddTypeRef(T->getElementType(), Record);
156   Record.push_back(T->getSizeModifier()); // FIXME: stable values
157   Record.push_back(T->getIndexTypeCVRQualifiers()); // FIXME: stable values
158 }
159 
160 void ASTTypeWriter::VisitConstantArrayType(const ConstantArrayType *T) {
161   VisitArrayType(T);
162   Writer.AddAPInt(T->getSize(), Record);
163   Code = TYPE_CONSTANT_ARRAY;
164 }
165 
166 void ASTTypeWriter::VisitIncompleteArrayType(const IncompleteArrayType *T) {
167   VisitArrayType(T);
168   Code = TYPE_INCOMPLETE_ARRAY;
169 }
170 
171 void ASTTypeWriter::VisitVariableArrayType(const VariableArrayType *T) {
172   VisitArrayType(T);
173   Writer.AddSourceLocation(T->getLBracketLoc(), Record);
174   Writer.AddSourceLocation(T->getRBracketLoc(), Record);
175   Writer.AddStmt(T->getSizeExpr());
176   Code = TYPE_VARIABLE_ARRAY;
177 }
178 
179 void ASTTypeWriter::VisitVectorType(const VectorType *T) {
180   Writer.AddTypeRef(T->getElementType(), Record);
181   Record.push_back(T->getNumElements());
182   Record.push_back(T->getVectorKind());
183   Code = TYPE_VECTOR;
184 }
185 
186 void ASTTypeWriter::VisitExtVectorType(const ExtVectorType *T) {
187   VisitVectorType(T);
188   Code = TYPE_EXT_VECTOR;
189 }
190 
191 void ASTTypeWriter::VisitFunctionType(const FunctionType *T) {
192   Writer.AddTypeRef(T->getReturnType(), Record);
193   FunctionType::ExtInfo C = T->getExtInfo();
194   Record.push_back(C.getNoReturn());
195   Record.push_back(C.getHasRegParm());
196   Record.push_back(C.getRegParm());
197   // FIXME: need to stabilize encoding of calling convention...
198   Record.push_back(C.getCC());
199   Record.push_back(C.getProducesResult());
200 
201   if (C.getHasRegParm() || C.getRegParm() || C.getProducesResult())
202     AbbrevToUse = 0;
203 }
204 
205 void ASTTypeWriter::VisitFunctionNoProtoType(const FunctionNoProtoType *T) {
206   VisitFunctionType(T);
207   Code = TYPE_FUNCTION_NO_PROTO;
208 }
209 
210 static void addExceptionSpec(ASTWriter &Writer, const FunctionProtoType *T,
211                              ASTWriter::RecordDataImpl &Record) {
212   Record.push_back(T->getExceptionSpecType());
213   if (T->getExceptionSpecType() == EST_Dynamic) {
214     Record.push_back(T->getNumExceptions());
215     for (unsigned I = 0, N = T->getNumExceptions(); I != N; ++I)
216       Writer.AddTypeRef(T->getExceptionType(I), Record);
217   } else if (T->getExceptionSpecType() == EST_ComputedNoexcept) {
218     Writer.AddStmt(T->getNoexceptExpr());
219   } else if (T->getExceptionSpecType() == EST_Uninstantiated) {
220     Writer.AddDeclRef(T->getExceptionSpecDecl(), Record);
221     Writer.AddDeclRef(T->getExceptionSpecTemplate(), Record);
222   } else if (T->getExceptionSpecType() == EST_Unevaluated) {
223     Writer.AddDeclRef(T->getExceptionSpecDecl(), Record);
224   }
225 }
226 
227 void ASTTypeWriter::VisitFunctionProtoType(const FunctionProtoType *T) {
228   VisitFunctionType(T);
229 
230   Record.push_back(T->isVariadic());
231   Record.push_back(T->hasTrailingReturn());
232   Record.push_back(T->getTypeQuals());
233   Record.push_back(static_cast<unsigned>(T->getRefQualifier()));
234   addExceptionSpec(Writer, T, Record);
235 
236   Record.push_back(T->getNumParams());
237   for (unsigned I = 0, N = T->getNumParams(); I != N; ++I)
238     Writer.AddTypeRef(T->getParamType(I), Record);
239 
240   if (T->isVariadic() || T->hasTrailingReturn() || T->getTypeQuals() ||
241       T->getRefQualifier() || T->getExceptionSpecType() != EST_None)
242     AbbrevToUse = 0;
243 
244   Code = TYPE_FUNCTION_PROTO;
245 }
246 
247 void ASTTypeWriter::VisitUnresolvedUsingType(const UnresolvedUsingType *T) {
248   Writer.AddDeclRef(T->getDecl(), Record);
249   Code = TYPE_UNRESOLVED_USING;
250 }
251 
252 void ASTTypeWriter::VisitTypedefType(const TypedefType *T) {
253   Writer.AddDeclRef(T->getDecl(), Record);
254   assert(!T->isCanonicalUnqualified() && "Invalid typedef ?");
255   Writer.AddTypeRef(T->getCanonicalTypeInternal(), Record);
256   Code = TYPE_TYPEDEF;
257 }
258 
259 void ASTTypeWriter::VisitTypeOfExprType(const TypeOfExprType *T) {
260   Writer.AddStmt(T->getUnderlyingExpr());
261   Code = TYPE_TYPEOF_EXPR;
262 }
263 
264 void ASTTypeWriter::VisitTypeOfType(const TypeOfType *T) {
265   Writer.AddTypeRef(T->getUnderlyingType(), Record);
266   Code = TYPE_TYPEOF;
267 }
268 
269 void ASTTypeWriter::VisitDecltypeType(const DecltypeType *T) {
270   Writer.AddTypeRef(T->getUnderlyingType(), Record);
271   Writer.AddStmt(T->getUnderlyingExpr());
272   Code = TYPE_DECLTYPE;
273 }
274 
275 void ASTTypeWriter::VisitUnaryTransformType(const UnaryTransformType *T) {
276   Writer.AddTypeRef(T->getBaseType(), Record);
277   Writer.AddTypeRef(T->getUnderlyingType(), Record);
278   Record.push_back(T->getUTTKind());
279   Code = TYPE_UNARY_TRANSFORM;
280 }
281 
282 void ASTTypeWriter::VisitAutoType(const AutoType *T) {
283   Writer.AddTypeRef(T->getDeducedType(), Record);
284   Record.push_back((unsigned)T->getKeyword());
285   if (T->getDeducedType().isNull())
286     Record.push_back(T->isDependentType());
287   Code = TYPE_AUTO;
288 }
289 
290 void ASTTypeWriter::VisitTagType(const TagType *T) {
291   Record.push_back(T->isDependentType());
292   Writer.AddDeclRef(T->getDecl()->getCanonicalDecl(), Record);
293   assert(!T->isBeingDefined() &&
294          "Cannot serialize in the middle of a type definition");
295 }
296 
297 void ASTTypeWriter::VisitRecordType(const RecordType *T) {
298   VisitTagType(T);
299   Code = TYPE_RECORD;
300 }
301 
302 void ASTTypeWriter::VisitEnumType(const EnumType *T) {
303   VisitTagType(T);
304   Code = TYPE_ENUM;
305 }
306 
307 void ASTTypeWriter::VisitAttributedType(const AttributedType *T) {
308   Writer.AddTypeRef(T->getModifiedType(), Record);
309   Writer.AddTypeRef(T->getEquivalentType(), Record);
310   Record.push_back(T->getAttrKind());
311   Code = TYPE_ATTRIBUTED;
312 }
313 
314 void
315 ASTTypeWriter::VisitSubstTemplateTypeParmType(
316                                         const SubstTemplateTypeParmType *T) {
317   Writer.AddTypeRef(QualType(T->getReplacedParameter(), 0), Record);
318   Writer.AddTypeRef(T->getReplacementType(), Record);
319   Code = TYPE_SUBST_TEMPLATE_TYPE_PARM;
320 }
321 
322 void
323 ASTTypeWriter::VisitSubstTemplateTypeParmPackType(
324                                       const SubstTemplateTypeParmPackType *T) {
325   Writer.AddTypeRef(QualType(T->getReplacedParameter(), 0), Record);
326   Writer.AddTemplateArgument(T->getArgumentPack(), Record);
327   Code = TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK;
328 }
329 
330 void
331 ASTTypeWriter::VisitTemplateSpecializationType(
332                                        const TemplateSpecializationType *T) {
333   Record.push_back(T->isDependentType());
334   Writer.AddTemplateName(T->getTemplateName(), Record);
335   Record.push_back(T->getNumArgs());
336   for (TemplateSpecializationType::iterator ArgI = T->begin(), ArgE = T->end();
337          ArgI != ArgE; ++ArgI)
338     Writer.AddTemplateArgument(*ArgI, Record);
339   Writer.AddTypeRef(T->isTypeAlias() ? T->getAliasedType() :
340                     T->isCanonicalUnqualified() ? QualType()
341                                                 : T->getCanonicalTypeInternal(),
342                     Record);
343   Code = TYPE_TEMPLATE_SPECIALIZATION;
344 }
345 
346 void
347 ASTTypeWriter::VisitDependentSizedArrayType(const DependentSizedArrayType *T) {
348   VisitArrayType(T);
349   Writer.AddStmt(T->getSizeExpr());
350   Writer.AddSourceRange(T->getBracketsRange(), Record);
351   Code = TYPE_DEPENDENT_SIZED_ARRAY;
352 }
353 
354 void
355 ASTTypeWriter::VisitDependentSizedExtVectorType(
356                                         const DependentSizedExtVectorType *T) {
357   // FIXME: Serialize this type (C++ only)
358   llvm_unreachable("Cannot serialize dependent sized extended vector types");
359 }
360 
361 void
362 ASTTypeWriter::VisitTemplateTypeParmType(const TemplateTypeParmType *T) {
363   Record.push_back(T->getDepth());
364   Record.push_back(T->getIndex());
365   Record.push_back(T->isParameterPack());
366   Writer.AddDeclRef(T->getDecl(), Record);
367   Code = TYPE_TEMPLATE_TYPE_PARM;
368 }
369 
370 void
371 ASTTypeWriter::VisitDependentNameType(const DependentNameType *T) {
372   Record.push_back(T->getKeyword());
373   Writer.AddNestedNameSpecifier(T->getQualifier(), Record);
374   Writer.AddIdentifierRef(T->getIdentifier(), Record);
375   Writer.AddTypeRef(T->isCanonicalUnqualified() ? QualType()
376                                                 : T->getCanonicalTypeInternal(),
377                     Record);
378   Code = TYPE_DEPENDENT_NAME;
379 }
380 
381 void
382 ASTTypeWriter::VisitDependentTemplateSpecializationType(
383                                 const DependentTemplateSpecializationType *T) {
384   Record.push_back(T->getKeyword());
385   Writer.AddNestedNameSpecifier(T->getQualifier(), Record);
386   Writer.AddIdentifierRef(T->getIdentifier(), Record);
387   Record.push_back(T->getNumArgs());
388   for (DependentTemplateSpecializationType::iterator
389          I = T->begin(), E = T->end(); I != E; ++I)
390     Writer.AddTemplateArgument(*I, Record);
391   Code = TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION;
392 }
393 
394 void ASTTypeWriter::VisitPackExpansionType(const PackExpansionType *T) {
395   Writer.AddTypeRef(T->getPattern(), Record);
396   if (Optional<unsigned> NumExpansions = T->getNumExpansions())
397     Record.push_back(*NumExpansions + 1);
398   else
399     Record.push_back(0);
400   Code = TYPE_PACK_EXPANSION;
401 }
402 
403 void ASTTypeWriter::VisitParenType(const ParenType *T) {
404   Writer.AddTypeRef(T->getInnerType(), Record);
405   Code = TYPE_PAREN;
406 }
407 
408 void ASTTypeWriter::VisitElaboratedType(const ElaboratedType *T) {
409   Record.push_back(T->getKeyword());
410   Writer.AddNestedNameSpecifier(T->getQualifier(), Record);
411   Writer.AddTypeRef(T->getNamedType(), Record);
412   Code = TYPE_ELABORATED;
413 }
414 
415 void ASTTypeWriter::VisitInjectedClassNameType(const InjectedClassNameType *T) {
416   Writer.AddDeclRef(T->getDecl()->getCanonicalDecl(), Record);
417   Writer.AddTypeRef(T->getInjectedSpecializationType(), Record);
418   Code = TYPE_INJECTED_CLASS_NAME;
419 }
420 
421 void ASTTypeWriter::VisitObjCInterfaceType(const ObjCInterfaceType *T) {
422   Writer.AddDeclRef(T->getDecl()->getCanonicalDecl(), Record);
423   Code = TYPE_OBJC_INTERFACE;
424 }
425 
426 void ASTTypeWriter::VisitObjCObjectType(const ObjCObjectType *T) {
427   Writer.AddTypeRef(T->getBaseType(), Record);
428   Record.push_back(T->getTypeArgsAsWritten().size());
429   for (auto TypeArg : T->getTypeArgsAsWritten())
430     Writer.AddTypeRef(TypeArg, Record);
431   Record.push_back(T->getNumProtocols());
432   for (const auto *I : T->quals())
433     Writer.AddDeclRef(I, Record);
434   Record.push_back(T->isKindOfTypeAsWritten());
435   Code = TYPE_OBJC_OBJECT;
436 }
437 
438 void
439 ASTTypeWriter::VisitObjCObjectPointerType(const ObjCObjectPointerType *T) {
440   Writer.AddTypeRef(T->getPointeeType(), Record);
441   Code = TYPE_OBJC_OBJECT_POINTER;
442 }
443 
444 void
445 ASTTypeWriter::VisitAtomicType(const AtomicType *T) {
446   Writer.AddTypeRef(T->getValueType(), Record);
447   Code = TYPE_ATOMIC;
448 }
449 
450 namespace {
451 
452 class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> {
453   ASTWriter &Writer;
454   ASTWriter::RecordDataImpl &Record;
455 
456 public:
457   TypeLocWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record)
458     : Writer(Writer), Record(Record) { }
459 
460 #define ABSTRACT_TYPELOC(CLASS, PARENT)
461 #define TYPELOC(CLASS, PARENT) \
462     void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
463 #include "clang/AST/TypeLocNodes.def"
464 
465   void VisitArrayTypeLoc(ArrayTypeLoc TyLoc);
466   void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc);
467 };
468 
469 }
470 
471 void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
472   // nothing to do
473 }
474 void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
475   Writer.AddSourceLocation(TL.getBuiltinLoc(), Record);
476   if (TL.needsExtraLocalData()) {
477     Record.push_back(TL.getWrittenTypeSpec());
478     Record.push_back(TL.getWrittenSignSpec());
479     Record.push_back(TL.getWrittenWidthSpec());
480     Record.push_back(TL.hasModeAttr());
481   }
482 }
483 void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
484   Writer.AddSourceLocation(TL.getNameLoc(), Record);
485 }
486 void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) {
487   Writer.AddSourceLocation(TL.getStarLoc(), Record);
488 }
489 void TypeLocWriter::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
490   // nothing to do
491 }
492 void TypeLocWriter::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
493   // nothing to do
494 }
495 void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
496   Writer.AddSourceLocation(TL.getCaretLoc(), Record);
497 }
498 void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
499   Writer.AddSourceLocation(TL.getAmpLoc(), Record);
500 }
501 void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
502   Writer.AddSourceLocation(TL.getAmpAmpLoc(), Record);
503 }
504 void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
505   Writer.AddSourceLocation(TL.getStarLoc(), Record);
506   Writer.AddTypeSourceInfo(TL.getClassTInfo(), Record);
507 }
508 void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) {
509   Writer.AddSourceLocation(TL.getLBracketLoc(), Record);
510   Writer.AddSourceLocation(TL.getRBracketLoc(), Record);
511   Record.push_back(TL.getSizeExpr() ? 1 : 0);
512   if (TL.getSizeExpr())
513     Writer.AddStmt(TL.getSizeExpr());
514 }
515 void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
516   VisitArrayTypeLoc(TL);
517 }
518 void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
519   VisitArrayTypeLoc(TL);
520 }
521 void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
522   VisitArrayTypeLoc(TL);
523 }
524 void TypeLocWriter::VisitDependentSizedArrayTypeLoc(
525                                             DependentSizedArrayTypeLoc TL) {
526   VisitArrayTypeLoc(TL);
527 }
528 void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc(
529                                         DependentSizedExtVectorTypeLoc TL) {
530   Writer.AddSourceLocation(TL.getNameLoc(), Record);
531 }
532 void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) {
533   Writer.AddSourceLocation(TL.getNameLoc(), Record);
534 }
535 void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
536   Writer.AddSourceLocation(TL.getNameLoc(), Record);
537 }
538 void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
539   Writer.AddSourceLocation(TL.getLocalRangeBegin(), Record);
540   Writer.AddSourceLocation(TL.getLParenLoc(), Record);
541   Writer.AddSourceLocation(TL.getRParenLoc(), Record);
542   Writer.AddSourceLocation(TL.getLocalRangeEnd(), Record);
543   for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i)
544     Writer.AddDeclRef(TL.getParam(i), Record);
545 }
546 void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
547   VisitFunctionTypeLoc(TL);
548 }
549 void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
550   VisitFunctionTypeLoc(TL);
551 }
552 void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
553   Writer.AddSourceLocation(TL.getNameLoc(), Record);
554 }
555 void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
556   Writer.AddSourceLocation(TL.getNameLoc(), Record);
557 }
558 void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
559   Writer.AddSourceLocation(TL.getTypeofLoc(), Record);
560   Writer.AddSourceLocation(TL.getLParenLoc(), Record);
561   Writer.AddSourceLocation(TL.getRParenLoc(), Record);
562 }
563 void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
564   Writer.AddSourceLocation(TL.getTypeofLoc(), Record);
565   Writer.AddSourceLocation(TL.getLParenLoc(), Record);
566   Writer.AddSourceLocation(TL.getRParenLoc(), Record);
567   Writer.AddTypeSourceInfo(TL.getUnderlyingTInfo(), Record);
568 }
569 void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
570   Writer.AddSourceLocation(TL.getNameLoc(), Record);
571 }
572 void TypeLocWriter::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
573   Writer.AddSourceLocation(TL.getKWLoc(), Record);
574   Writer.AddSourceLocation(TL.getLParenLoc(), Record);
575   Writer.AddSourceLocation(TL.getRParenLoc(), Record);
576   Writer.AddTypeSourceInfo(TL.getUnderlyingTInfo(), Record);
577 }
578 void TypeLocWriter::VisitAutoTypeLoc(AutoTypeLoc TL) {
579   Writer.AddSourceLocation(TL.getNameLoc(), Record);
580 }
581 void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) {
582   Writer.AddSourceLocation(TL.getNameLoc(), Record);
583 }
584 void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) {
585   Writer.AddSourceLocation(TL.getNameLoc(), Record);
586 }
587 void TypeLocWriter::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
588   Writer.AddSourceLocation(TL.getAttrNameLoc(), Record);
589   if (TL.hasAttrOperand()) {
590     SourceRange range = TL.getAttrOperandParensRange();
591     Writer.AddSourceLocation(range.getBegin(), Record);
592     Writer.AddSourceLocation(range.getEnd(), Record);
593   }
594   if (TL.hasAttrExprOperand()) {
595     Expr *operand = TL.getAttrExprOperand();
596     Record.push_back(operand ? 1 : 0);
597     if (operand) Writer.AddStmt(operand);
598   } else if (TL.hasAttrEnumOperand()) {
599     Writer.AddSourceLocation(TL.getAttrEnumOperandLoc(), Record);
600   }
601 }
602 void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
603   Writer.AddSourceLocation(TL.getNameLoc(), Record);
604 }
605 void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
606                                             SubstTemplateTypeParmTypeLoc TL) {
607   Writer.AddSourceLocation(TL.getNameLoc(), Record);
608 }
609 void TypeLocWriter::VisitSubstTemplateTypeParmPackTypeLoc(
610                                           SubstTemplateTypeParmPackTypeLoc TL) {
611   Writer.AddSourceLocation(TL.getNameLoc(), Record);
612 }
613 void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
614                                            TemplateSpecializationTypeLoc TL) {
615   Writer.AddSourceLocation(TL.getTemplateKeywordLoc(), Record);
616   Writer.AddSourceLocation(TL.getTemplateNameLoc(), Record);
617   Writer.AddSourceLocation(TL.getLAngleLoc(), Record);
618   Writer.AddSourceLocation(TL.getRAngleLoc(), Record);
619   for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
620     Writer.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(),
621                                       TL.getArgLoc(i).getLocInfo(), Record);
622 }
623 void TypeLocWriter::VisitParenTypeLoc(ParenTypeLoc TL) {
624   Writer.AddSourceLocation(TL.getLParenLoc(), Record);
625   Writer.AddSourceLocation(TL.getRParenLoc(), Record);
626 }
627 void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
628   Writer.AddSourceLocation(TL.getElaboratedKeywordLoc(), Record);
629   Writer.AddNestedNameSpecifierLoc(TL.getQualifierLoc(), Record);
630 }
631 void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
632   Writer.AddSourceLocation(TL.getNameLoc(), Record);
633 }
634 void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
635   Writer.AddSourceLocation(TL.getElaboratedKeywordLoc(), Record);
636   Writer.AddNestedNameSpecifierLoc(TL.getQualifierLoc(), Record);
637   Writer.AddSourceLocation(TL.getNameLoc(), Record);
638 }
639 void TypeLocWriter::VisitDependentTemplateSpecializationTypeLoc(
640        DependentTemplateSpecializationTypeLoc TL) {
641   Writer.AddSourceLocation(TL.getElaboratedKeywordLoc(), Record);
642   Writer.AddNestedNameSpecifierLoc(TL.getQualifierLoc(), Record);
643   Writer.AddSourceLocation(TL.getTemplateKeywordLoc(), Record);
644   Writer.AddSourceLocation(TL.getTemplateNameLoc(), Record);
645   Writer.AddSourceLocation(TL.getLAngleLoc(), Record);
646   Writer.AddSourceLocation(TL.getRAngleLoc(), Record);
647   for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
648     Writer.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(),
649                                       TL.getArgLoc(I).getLocInfo(), Record);
650 }
651 void TypeLocWriter::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
652   Writer.AddSourceLocation(TL.getEllipsisLoc(), Record);
653 }
654 void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
655   Writer.AddSourceLocation(TL.getNameLoc(), Record);
656 }
657 void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
658   Record.push_back(TL.hasBaseTypeAsWritten());
659   Writer.AddSourceLocation(TL.getTypeArgsLAngleLoc(), Record);
660   Writer.AddSourceLocation(TL.getTypeArgsRAngleLoc(), Record);
661   for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
662     Writer.AddTypeSourceInfo(TL.getTypeArgTInfo(i), Record);
663   Writer.AddSourceLocation(TL.getProtocolLAngleLoc(), Record);
664   Writer.AddSourceLocation(TL.getProtocolRAngleLoc(), Record);
665   for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
666     Writer.AddSourceLocation(TL.getProtocolLoc(i), Record);
667 }
668 void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
669   Writer.AddSourceLocation(TL.getStarLoc(), Record);
670 }
671 void TypeLocWriter::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
672   Writer.AddSourceLocation(TL.getKWLoc(), Record);
673   Writer.AddSourceLocation(TL.getLParenLoc(), Record);
674   Writer.AddSourceLocation(TL.getRParenLoc(), Record);
675 }
676 
677 void ASTWriter::WriteTypeAbbrevs() {
678   using namespace llvm;
679 
680   BitCodeAbbrev *Abv;
681 
682   // Abbreviation for TYPE_EXT_QUAL
683   Abv = new BitCodeAbbrev();
684   Abv->Add(BitCodeAbbrevOp(serialization::TYPE_EXT_QUAL));
685   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // Type
686   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 3));   // Quals
687   TypeExtQualAbbrev = Stream.EmitAbbrev(Abv);
688 
689   // Abbreviation for TYPE_FUNCTION_PROTO
690   Abv = new BitCodeAbbrev();
691   Abv->Add(BitCodeAbbrevOp(serialization::TYPE_FUNCTION_PROTO));
692   // FunctionType
693   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // ReturnType
694   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // NoReturn
695   Abv->Add(BitCodeAbbrevOp(0));                         // HasRegParm
696   Abv->Add(BitCodeAbbrevOp(0));                         // RegParm
697   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // CC
698   Abv->Add(BitCodeAbbrevOp(0));                         // ProducesResult
699   // FunctionProtoType
700   Abv->Add(BitCodeAbbrevOp(0));                         // IsVariadic
701   Abv->Add(BitCodeAbbrevOp(0));                         // HasTrailingReturn
702   Abv->Add(BitCodeAbbrevOp(0));                         // TypeQuals
703   Abv->Add(BitCodeAbbrevOp(0));                         // RefQualifier
704   Abv->Add(BitCodeAbbrevOp(EST_None));                  // ExceptionSpec
705   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // NumParams
706   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
707   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // Params
708   TypeFunctionProtoAbbrev = Stream.EmitAbbrev(Abv);
709 }
710 
711 //===----------------------------------------------------------------------===//
712 // ASTWriter Implementation
713 //===----------------------------------------------------------------------===//
714 
715 static void EmitBlockID(unsigned ID, const char *Name,
716                         llvm::BitstreamWriter &Stream,
717                         ASTWriter::RecordDataImpl &Record) {
718   Record.clear();
719   Record.push_back(ID);
720   Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
721 
722   // Emit the block name if present.
723   if (!Name || Name[0] == 0)
724     return;
725   Record.clear();
726   while (*Name)
727     Record.push_back(*Name++);
728   Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record);
729 }
730 
731 static void EmitRecordID(unsigned ID, const char *Name,
732                          llvm::BitstreamWriter &Stream,
733                          ASTWriter::RecordDataImpl &Record) {
734   Record.clear();
735   Record.push_back(ID);
736   while (*Name)
737     Record.push_back(*Name++);
738   Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
739 }
740 
741 static void AddStmtsExprs(llvm::BitstreamWriter &Stream,
742                           ASTWriter::RecordDataImpl &Record) {
743 #define RECORD(X) EmitRecordID(X, #X, Stream, Record)
744   RECORD(STMT_STOP);
745   RECORD(STMT_NULL_PTR);
746   RECORD(STMT_REF_PTR);
747   RECORD(STMT_NULL);
748   RECORD(STMT_COMPOUND);
749   RECORD(STMT_CASE);
750   RECORD(STMT_DEFAULT);
751   RECORD(STMT_LABEL);
752   RECORD(STMT_ATTRIBUTED);
753   RECORD(STMT_IF);
754   RECORD(STMT_SWITCH);
755   RECORD(STMT_WHILE);
756   RECORD(STMT_DO);
757   RECORD(STMT_FOR);
758   RECORD(STMT_GOTO);
759   RECORD(STMT_INDIRECT_GOTO);
760   RECORD(STMT_CONTINUE);
761   RECORD(STMT_BREAK);
762   RECORD(STMT_RETURN);
763   RECORD(STMT_DECL);
764   RECORD(STMT_GCCASM);
765   RECORD(STMT_MSASM);
766   RECORD(EXPR_PREDEFINED);
767   RECORD(EXPR_DECL_REF);
768   RECORD(EXPR_INTEGER_LITERAL);
769   RECORD(EXPR_FLOATING_LITERAL);
770   RECORD(EXPR_IMAGINARY_LITERAL);
771   RECORD(EXPR_STRING_LITERAL);
772   RECORD(EXPR_CHARACTER_LITERAL);
773   RECORD(EXPR_PAREN);
774   RECORD(EXPR_PAREN_LIST);
775   RECORD(EXPR_UNARY_OPERATOR);
776   RECORD(EXPR_SIZEOF_ALIGN_OF);
777   RECORD(EXPR_ARRAY_SUBSCRIPT);
778   RECORD(EXPR_CALL);
779   RECORD(EXPR_MEMBER);
780   RECORD(EXPR_BINARY_OPERATOR);
781   RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR);
782   RECORD(EXPR_CONDITIONAL_OPERATOR);
783   RECORD(EXPR_IMPLICIT_CAST);
784   RECORD(EXPR_CSTYLE_CAST);
785   RECORD(EXPR_COMPOUND_LITERAL);
786   RECORD(EXPR_EXT_VECTOR_ELEMENT);
787   RECORD(EXPR_INIT_LIST);
788   RECORD(EXPR_DESIGNATED_INIT);
789   RECORD(EXPR_DESIGNATED_INIT_UPDATE);
790   RECORD(EXPR_IMPLICIT_VALUE_INIT);
791   RECORD(EXPR_NO_INIT);
792   RECORD(EXPR_VA_ARG);
793   RECORD(EXPR_ADDR_LABEL);
794   RECORD(EXPR_STMT);
795   RECORD(EXPR_CHOOSE);
796   RECORD(EXPR_GNU_NULL);
797   RECORD(EXPR_SHUFFLE_VECTOR);
798   RECORD(EXPR_BLOCK);
799   RECORD(EXPR_GENERIC_SELECTION);
800   RECORD(EXPR_OBJC_STRING_LITERAL);
801   RECORD(EXPR_OBJC_BOXED_EXPRESSION);
802   RECORD(EXPR_OBJC_ARRAY_LITERAL);
803   RECORD(EXPR_OBJC_DICTIONARY_LITERAL);
804   RECORD(EXPR_OBJC_ENCODE);
805   RECORD(EXPR_OBJC_SELECTOR_EXPR);
806   RECORD(EXPR_OBJC_PROTOCOL_EXPR);
807   RECORD(EXPR_OBJC_IVAR_REF_EXPR);
808   RECORD(EXPR_OBJC_PROPERTY_REF_EXPR);
809   RECORD(EXPR_OBJC_KVC_REF_EXPR);
810   RECORD(EXPR_OBJC_MESSAGE_EXPR);
811   RECORD(STMT_OBJC_FOR_COLLECTION);
812   RECORD(STMT_OBJC_CATCH);
813   RECORD(STMT_OBJC_FINALLY);
814   RECORD(STMT_OBJC_AT_TRY);
815   RECORD(STMT_OBJC_AT_SYNCHRONIZED);
816   RECORD(STMT_OBJC_AT_THROW);
817   RECORD(EXPR_OBJC_BOOL_LITERAL);
818   RECORD(STMT_CXX_CATCH);
819   RECORD(STMT_CXX_TRY);
820   RECORD(STMT_CXX_FOR_RANGE);
821   RECORD(EXPR_CXX_OPERATOR_CALL);
822   RECORD(EXPR_CXX_MEMBER_CALL);
823   RECORD(EXPR_CXX_CONSTRUCT);
824   RECORD(EXPR_CXX_TEMPORARY_OBJECT);
825   RECORD(EXPR_CXX_STATIC_CAST);
826   RECORD(EXPR_CXX_DYNAMIC_CAST);
827   RECORD(EXPR_CXX_REINTERPRET_CAST);
828   RECORD(EXPR_CXX_CONST_CAST);
829   RECORD(EXPR_CXX_FUNCTIONAL_CAST);
830   RECORD(EXPR_USER_DEFINED_LITERAL);
831   RECORD(EXPR_CXX_STD_INITIALIZER_LIST);
832   RECORD(EXPR_CXX_BOOL_LITERAL);
833   RECORD(EXPR_CXX_NULL_PTR_LITERAL);
834   RECORD(EXPR_CXX_TYPEID_EXPR);
835   RECORD(EXPR_CXX_TYPEID_TYPE);
836   RECORD(EXPR_CXX_THIS);
837   RECORD(EXPR_CXX_THROW);
838   RECORD(EXPR_CXX_DEFAULT_ARG);
839   RECORD(EXPR_CXX_DEFAULT_INIT);
840   RECORD(EXPR_CXX_BIND_TEMPORARY);
841   RECORD(EXPR_CXX_SCALAR_VALUE_INIT);
842   RECORD(EXPR_CXX_NEW);
843   RECORD(EXPR_CXX_DELETE);
844   RECORD(EXPR_CXX_PSEUDO_DESTRUCTOR);
845   RECORD(EXPR_EXPR_WITH_CLEANUPS);
846   RECORD(EXPR_CXX_DEPENDENT_SCOPE_MEMBER);
847   RECORD(EXPR_CXX_DEPENDENT_SCOPE_DECL_REF);
848   RECORD(EXPR_CXX_UNRESOLVED_CONSTRUCT);
849   RECORD(EXPR_CXX_UNRESOLVED_MEMBER);
850   RECORD(EXPR_CXX_UNRESOLVED_LOOKUP);
851   RECORD(EXPR_CXX_EXPRESSION_TRAIT);
852   RECORD(EXPR_CXX_NOEXCEPT);
853   RECORD(EXPR_OPAQUE_VALUE);
854   RECORD(EXPR_BINARY_CONDITIONAL_OPERATOR);
855   RECORD(EXPR_TYPE_TRAIT);
856   RECORD(EXPR_ARRAY_TYPE_TRAIT);
857   RECORD(EXPR_PACK_EXPANSION);
858   RECORD(EXPR_SIZEOF_PACK);
859   RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM);
860   RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK);
861   RECORD(EXPR_FUNCTION_PARM_PACK);
862   RECORD(EXPR_MATERIALIZE_TEMPORARY);
863   RECORD(EXPR_CUDA_KERNEL_CALL);
864   RECORD(EXPR_CXX_UUIDOF_EXPR);
865   RECORD(EXPR_CXX_UUIDOF_TYPE);
866   RECORD(EXPR_LAMBDA);
867 #undef RECORD
868 }
869 
870 void ASTWriter::WriteBlockInfoBlock() {
871   RecordData Record;
872   Stream.EnterSubblock(llvm::bitc::BLOCKINFO_BLOCK_ID, 3);
873 
874 #define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record)
875 #define RECORD(X) EmitRecordID(X, #X, Stream, Record)
876 
877   // Control Block.
878   BLOCK(CONTROL_BLOCK);
879   RECORD(METADATA);
880   RECORD(SIGNATURE);
881   RECORD(MODULE_NAME);
882   RECORD(MODULE_DIRECTORY);
883   RECORD(MODULE_MAP_FILE);
884   RECORD(IMPORTS);
885   RECORD(ORIGINAL_FILE);
886   RECORD(ORIGINAL_PCH_DIR);
887   RECORD(ORIGINAL_FILE_ID);
888   RECORD(INPUT_FILE_OFFSETS);
889 
890   BLOCK(OPTIONS_BLOCK);
891   RECORD(LANGUAGE_OPTIONS);
892   RECORD(TARGET_OPTIONS);
893   RECORD(DIAGNOSTIC_OPTIONS);
894   RECORD(FILE_SYSTEM_OPTIONS);
895   RECORD(HEADER_SEARCH_OPTIONS);
896   RECORD(PREPROCESSOR_OPTIONS);
897 
898   BLOCK(INPUT_FILES_BLOCK);
899   RECORD(INPUT_FILE);
900 
901   // AST Top-Level Block.
902   BLOCK(AST_BLOCK);
903   RECORD(TYPE_OFFSET);
904   RECORD(DECL_OFFSET);
905   RECORD(IDENTIFIER_OFFSET);
906   RECORD(IDENTIFIER_TABLE);
907   RECORD(EAGERLY_DESERIALIZED_DECLS);
908   RECORD(SPECIAL_TYPES);
909   RECORD(STATISTICS);
910   RECORD(TENTATIVE_DEFINITIONS);
911   RECORD(SELECTOR_OFFSETS);
912   RECORD(METHOD_POOL);
913   RECORD(PP_COUNTER_VALUE);
914   RECORD(SOURCE_LOCATION_OFFSETS);
915   RECORD(SOURCE_LOCATION_PRELOADS);
916   RECORD(EXT_VECTOR_DECLS);
917   RECORD(UNUSED_FILESCOPED_DECLS);
918   RECORD(PPD_ENTITIES_OFFSETS);
919   RECORD(VTABLE_USES);
920   RECORD(REFERENCED_SELECTOR_POOL);
921   RECORD(TU_UPDATE_LEXICAL);
922   RECORD(SEMA_DECL_REFS);
923   RECORD(WEAK_UNDECLARED_IDENTIFIERS);
924   RECORD(PENDING_IMPLICIT_INSTANTIATIONS);
925   RECORD(DECL_REPLACEMENTS);
926   RECORD(UPDATE_VISIBLE);
927   RECORD(DECL_UPDATE_OFFSETS);
928   RECORD(DECL_UPDATES);
929   RECORD(CXX_BASE_SPECIFIER_OFFSETS);
930   RECORD(DIAG_PRAGMA_MAPPINGS);
931   RECORD(CUDA_SPECIAL_DECL_REFS);
932   RECORD(HEADER_SEARCH_TABLE);
933   RECORD(FP_PRAGMA_OPTIONS);
934   RECORD(OPENCL_EXTENSIONS);
935   RECORD(DELEGATING_CTORS);
936   RECORD(KNOWN_NAMESPACES);
937   RECORD(MODULE_OFFSET_MAP);
938   RECORD(SOURCE_MANAGER_LINE_TABLE);
939   RECORD(OBJC_CATEGORIES_MAP);
940   RECORD(FILE_SORTED_DECLS);
941   RECORD(IMPORTED_MODULES);
942   RECORD(OBJC_CATEGORIES);
943   RECORD(MACRO_OFFSET);
944   RECORD(INTERESTING_IDENTIFIERS);
945   RECORD(UNDEFINED_BUT_USED);
946   RECORD(LATE_PARSED_TEMPLATE);
947   RECORD(OPTIMIZE_PRAGMA_OPTIONS);
948   RECORD(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES);
949   RECORD(CXX_CTOR_INITIALIZERS_OFFSETS);
950   RECORD(DELETE_EXPRS_TO_ANALYZE);
951 
952   // SourceManager Block.
953   BLOCK(SOURCE_MANAGER_BLOCK);
954   RECORD(SM_SLOC_FILE_ENTRY);
955   RECORD(SM_SLOC_BUFFER_ENTRY);
956   RECORD(SM_SLOC_BUFFER_BLOB);
957   RECORD(SM_SLOC_EXPANSION_ENTRY);
958 
959   // Preprocessor Block.
960   BLOCK(PREPROCESSOR_BLOCK);
961   RECORD(PP_MACRO_DIRECTIVE_HISTORY);
962   RECORD(PP_MACRO_FUNCTION_LIKE);
963   RECORD(PP_MACRO_OBJECT_LIKE);
964   RECORD(PP_MODULE_MACRO);
965   RECORD(PP_TOKEN);
966 
967   // Submodule Block.
968   BLOCK(SUBMODULE_BLOCK);
969   RECORD(SUBMODULE_METADATA);
970   RECORD(SUBMODULE_DEFINITION);
971   RECORD(SUBMODULE_UMBRELLA_HEADER);
972   RECORD(SUBMODULE_HEADER);
973   RECORD(SUBMODULE_TOPHEADER);
974   RECORD(SUBMODULE_UMBRELLA_DIR);
975   RECORD(SUBMODULE_IMPORTS);
976   RECORD(SUBMODULE_EXPORTS);
977   RECORD(SUBMODULE_REQUIRES);
978   RECORD(SUBMODULE_EXCLUDED_HEADER);
979   RECORD(SUBMODULE_LINK_LIBRARY);
980   RECORD(SUBMODULE_CONFIG_MACRO);
981   RECORD(SUBMODULE_CONFLICT);
982   RECORD(SUBMODULE_PRIVATE_HEADER);
983   RECORD(SUBMODULE_TEXTUAL_HEADER);
984   RECORD(SUBMODULE_PRIVATE_TEXTUAL_HEADER);
985 
986   // Comments Block.
987   BLOCK(COMMENTS_BLOCK);
988   RECORD(COMMENTS_RAW_COMMENT);
989 
990   // Decls and Types block.
991   BLOCK(DECLTYPES_BLOCK);
992   RECORD(TYPE_EXT_QUAL);
993   RECORD(TYPE_COMPLEX);
994   RECORD(TYPE_POINTER);
995   RECORD(TYPE_BLOCK_POINTER);
996   RECORD(TYPE_LVALUE_REFERENCE);
997   RECORD(TYPE_RVALUE_REFERENCE);
998   RECORD(TYPE_MEMBER_POINTER);
999   RECORD(TYPE_CONSTANT_ARRAY);
1000   RECORD(TYPE_INCOMPLETE_ARRAY);
1001   RECORD(TYPE_VARIABLE_ARRAY);
1002   RECORD(TYPE_VECTOR);
1003   RECORD(TYPE_EXT_VECTOR);
1004   RECORD(TYPE_FUNCTION_NO_PROTO);
1005   RECORD(TYPE_FUNCTION_PROTO);
1006   RECORD(TYPE_TYPEDEF);
1007   RECORD(TYPE_TYPEOF_EXPR);
1008   RECORD(TYPE_TYPEOF);
1009   RECORD(TYPE_RECORD);
1010   RECORD(TYPE_ENUM);
1011   RECORD(TYPE_OBJC_INTERFACE);
1012   RECORD(TYPE_OBJC_OBJECT_POINTER);
1013   RECORD(TYPE_DECLTYPE);
1014   RECORD(TYPE_ELABORATED);
1015   RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
1016   RECORD(TYPE_UNRESOLVED_USING);
1017   RECORD(TYPE_INJECTED_CLASS_NAME);
1018   RECORD(TYPE_OBJC_OBJECT);
1019   RECORD(TYPE_TEMPLATE_TYPE_PARM);
1020   RECORD(TYPE_TEMPLATE_SPECIALIZATION);
1021   RECORD(TYPE_DEPENDENT_NAME);
1022   RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION);
1023   RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
1024   RECORD(TYPE_PAREN);
1025   RECORD(TYPE_PACK_EXPANSION);
1026   RECORD(TYPE_ATTRIBUTED);
1027   RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
1028   RECORD(TYPE_AUTO);
1029   RECORD(TYPE_UNARY_TRANSFORM);
1030   RECORD(TYPE_ATOMIC);
1031   RECORD(TYPE_DECAYED);
1032   RECORD(TYPE_ADJUSTED);
1033   RECORD(LOCAL_REDECLARATIONS);
1034   RECORD(DECL_TYPEDEF);
1035   RECORD(DECL_TYPEALIAS);
1036   RECORD(DECL_ENUM);
1037   RECORD(DECL_RECORD);
1038   RECORD(DECL_ENUM_CONSTANT);
1039   RECORD(DECL_FUNCTION);
1040   RECORD(DECL_OBJC_METHOD);
1041   RECORD(DECL_OBJC_INTERFACE);
1042   RECORD(DECL_OBJC_PROTOCOL);
1043   RECORD(DECL_OBJC_IVAR);
1044   RECORD(DECL_OBJC_AT_DEFS_FIELD);
1045   RECORD(DECL_OBJC_CATEGORY);
1046   RECORD(DECL_OBJC_CATEGORY_IMPL);
1047   RECORD(DECL_OBJC_IMPLEMENTATION);
1048   RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
1049   RECORD(DECL_OBJC_PROPERTY);
1050   RECORD(DECL_OBJC_PROPERTY_IMPL);
1051   RECORD(DECL_FIELD);
1052   RECORD(DECL_MS_PROPERTY);
1053   RECORD(DECL_VAR);
1054   RECORD(DECL_IMPLICIT_PARAM);
1055   RECORD(DECL_PARM_VAR);
1056   RECORD(DECL_FILE_SCOPE_ASM);
1057   RECORD(DECL_BLOCK);
1058   RECORD(DECL_CONTEXT_LEXICAL);
1059   RECORD(DECL_CONTEXT_VISIBLE);
1060   RECORD(DECL_NAMESPACE);
1061   RECORD(DECL_NAMESPACE_ALIAS);
1062   RECORD(DECL_USING);
1063   RECORD(DECL_USING_SHADOW);
1064   RECORD(DECL_USING_DIRECTIVE);
1065   RECORD(DECL_UNRESOLVED_USING_VALUE);
1066   RECORD(DECL_UNRESOLVED_USING_TYPENAME);
1067   RECORD(DECL_LINKAGE_SPEC);
1068   RECORD(DECL_CXX_RECORD);
1069   RECORD(DECL_CXX_METHOD);
1070   RECORD(DECL_CXX_CONSTRUCTOR);
1071   RECORD(DECL_CXX_DESTRUCTOR);
1072   RECORD(DECL_CXX_CONVERSION);
1073   RECORD(DECL_ACCESS_SPEC);
1074   RECORD(DECL_FRIEND);
1075   RECORD(DECL_FRIEND_TEMPLATE);
1076   RECORD(DECL_CLASS_TEMPLATE);
1077   RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
1078   RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
1079   RECORD(DECL_VAR_TEMPLATE);
1080   RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION);
1081   RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION);
1082   RECORD(DECL_FUNCTION_TEMPLATE);
1083   RECORD(DECL_TEMPLATE_TYPE_PARM);
1084   RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
1085   RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
1086   RECORD(DECL_STATIC_ASSERT);
1087   RECORD(DECL_CXX_BASE_SPECIFIERS);
1088   RECORD(DECL_INDIRECTFIELD);
1089   RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
1090 
1091   // Statements and Exprs can occur in the Decls and Types block.
1092   AddStmtsExprs(Stream, Record);
1093 
1094   BLOCK(PREPROCESSOR_DETAIL_BLOCK);
1095   RECORD(PPD_MACRO_EXPANSION);
1096   RECORD(PPD_MACRO_DEFINITION);
1097   RECORD(PPD_INCLUSION_DIRECTIVE);
1098 
1099   // Decls and Types block.
1100   BLOCK(EXTENSION_BLOCK);
1101   RECORD(EXTENSION_METADATA);
1102 
1103 #undef RECORD
1104 #undef BLOCK
1105   Stream.ExitBlock();
1106 }
1107 
1108 /// \brief Prepares a path for being written to an AST file by converting it
1109 /// to an absolute path and removing nested './'s.
1110 ///
1111 /// \return \c true if the path was changed.
1112 static bool cleanPathForOutput(FileManager &FileMgr,
1113                                SmallVectorImpl<char> &Path) {
1114   bool Changed = FileMgr.makeAbsolutePath(Path);
1115   return Changed | llvm::sys::path::remove_dots(Path);
1116 }
1117 
1118 /// \brief Adjusts the given filename to only write out the portion of the
1119 /// filename that is not part of the system root directory.
1120 ///
1121 /// \param Filename the file name to adjust.
1122 ///
1123 /// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
1124 /// the returned filename will be adjusted by this root directory.
1125 ///
1126 /// \returns either the original filename (if it needs no adjustment) or the
1127 /// adjusted filename (which points into the @p Filename parameter).
1128 static const char *
1129 adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
1130   assert(Filename && "No file name to adjust?");
1131 
1132   if (BaseDir.empty())
1133     return Filename;
1134 
1135   // Verify that the filename and the system root have the same prefix.
1136   unsigned Pos = 0;
1137   for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1138     if (Filename[Pos] != BaseDir[Pos])
1139       return Filename; // Prefixes don't match.
1140 
1141   // We hit the end of the filename before we hit the end of the system root.
1142   if (!Filename[Pos])
1143     return Filename;
1144 
1145   // If there's not a path separator at the end of the base directory nor
1146   // immediately after it, then this isn't within the base directory.
1147   if (!llvm::sys::path::is_separator(Filename[Pos])) {
1148     if (!llvm::sys::path::is_separator(BaseDir.back()))
1149       return Filename;
1150   } else {
1151     // If the file name has a '/' at the current position, skip over the '/'.
1152     // We distinguish relative paths from absolute paths by the
1153     // absence of '/' at the beginning of relative paths.
1154     //
1155     // FIXME: This is wrong. We distinguish them by asking if the path is
1156     // absolute, which isn't the same thing. And there might be multiple '/'s
1157     // in a row. Use a better mechanism to indicate whether we have emitted an
1158     // absolute or relative path.
1159     ++Pos;
1160   }
1161 
1162   return Filename + Pos;
1163 }
1164 
1165 static ASTFileSignature getSignature() {
1166   while (1) {
1167     if (ASTFileSignature S = llvm::sys::Process::GetRandomNumber())
1168       return S;
1169     // Rely on GetRandomNumber to eventually return non-zero...
1170   }
1171 }
1172 
1173 /// \brief Write the control block.
1174 uint64_t ASTWriter::WriteControlBlock(Preprocessor &PP,
1175                                       ASTContext &Context,
1176                                       StringRef isysroot,
1177                                       const std::string &OutputFile) {
1178   ASTFileSignature Signature = 0;
1179 
1180   using namespace llvm;
1181   Stream.EnterSubblock(CONTROL_BLOCK_ID, 5);
1182   RecordData Record;
1183 
1184   // Metadata
1185   BitCodeAbbrev *MetadataAbbrev = new BitCodeAbbrev();
1186   MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA));
1187   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1188   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1189   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1190   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1191   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
1192   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Timestamps
1193   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1194   MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
1195   unsigned MetadataAbbrevCode = Stream.EmitAbbrev(MetadataAbbrev);
1196   assert((!WritingModule || isysroot.empty()) &&
1197          "writing module as a relocatable PCH?");
1198   {
1199     RecordData::value_type Record[] = {METADATA, VERSION_MAJOR, VERSION_MINOR,
1200                                        CLANG_VERSION_MAJOR, CLANG_VERSION_MINOR,
1201                                        !isysroot.empty(), IncludeTimestamps,
1202                                        ASTHasCompilerErrors};
1203     Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record,
1204                               getClangFullRepositoryVersion());
1205   }
1206   if (WritingModule) {
1207     // For implicit modules we output a signature that we can use to ensure
1208     // duplicate module builds don't collide in the cache as their output order
1209     // is non-deterministic.
1210     // FIXME: Remove this when output is deterministic.
1211     if (Context.getLangOpts().ImplicitModules) {
1212       Signature = getSignature();
1213       RecordData::value_type Record[] = {Signature};
1214       Stream.EmitRecord(SIGNATURE, Record);
1215     }
1216 
1217     // Module name
1218     BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1219     Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME));
1220     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
1221     unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1222     RecordData::value_type Record[] = {MODULE_NAME};
1223     Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name);
1224   }
1225 
1226   if (WritingModule && WritingModule->Directory) {
1227     SmallString<128> BaseDir(WritingModule->Directory->getName());
1228     cleanPathForOutput(Context.getSourceManager().getFileManager(), BaseDir);
1229 
1230     // If the home of the module is the current working directory, then we
1231     // want to pick up the cwd of the build process loading the module, not
1232     // our cwd, when we load this module.
1233     if (!PP.getHeaderSearchInfo()
1234              .getHeaderSearchOpts()
1235              .ModuleMapFileHomeIsCwd ||
1236         WritingModule->Directory->getName() != StringRef(".")) {
1237       // Module directory.
1238       BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1239       Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY));
1240       Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
1241       unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1242 
1243       RecordData::value_type Record[] = {MODULE_DIRECTORY};
1244       Stream.EmitRecordWithBlob(AbbrevCode, Record, BaseDir);
1245     }
1246 
1247     // Write out all other paths relative to the base directory if possible.
1248     BaseDirectory.assign(BaseDir.begin(), BaseDir.end());
1249   } else if (!isysroot.empty()) {
1250     // Write out paths relative to the sysroot if possible.
1251     BaseDirectory = isysroot;
1252   }
1253 
1254   // Module map file
1255   if (WritingModule) {
1256     Record.clear();
1257 
1258     auto &Map = PP.getHeaderSearchInfo().getModuleMap();
1259 
1260     // Primary module map file.
1261     AddPath(Map.getModuleMapFileForUniquing(WritingModule)->getName(), Record);
1262 
1263     // Additional module map files.
1264     if (auto *AdditionalModMaps =
1265             Map.getAdditionalModuleMapFiles(WritingModule)) {
1266       Record.push_back(AdditionalModMaps->size());
1267       for (const FileEntry *F : *AdditionalModMaps)
1268         AddPath(F->getName(), Record);
1269     } else {
1270       Record.push_back(0);
1271     }
1272 
1273     Stream.EmitRecord(MODULE_MAP_FILE, Record);
1274   }
1275 
1276   // Imports
1277   if (Chain) {
1278     serialization::ModuleManager &Mgr = Chain->getModuleManager();
1279     Record.clear();
1280 
1281     for (auto *M : Mgr) {
1282       // Skip modules that weren't directly imported.
1283       if (!M->isDirectlyImported())
1284         continue;
1285 
1286       Record.push_back((unsigned)M->Kind); // FIXME: Stable encoding
1287       AddSourceLocation(M->ImportLoc, Record);
1288       Record.push_back(M->File->getSize());
1289       Record.push_back(getTimestampForOutput(M->File));
1290       Record.push_back(M->Signature);
1291       AddPath(M->FileName, Record);
1292     }
1293     Stream.EmitRecord(IMPORTS, Record);
1294   }
1295 
1296   // Write the options block.
1297   Stream.EnterSubblock(OPTIONS_BLOCK_ID, 4);
1298 
1299   // Language options.
1300   Record.clear();
1301   const LangOptions &LangOpts = Context.getLangOpts();
1302 #define LANGOPT(Name, Bits, Default, Description) \
1303   Record.push_back(LangOpts.Name);
1304 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
1305   Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
1306 #include "clang/Basic/LangOptions.def"
1307 #define SANITIZER(NAME, ID)                                                    \
1308   Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
1309 #include "clang/Basic/Sanitizers.def"
1310 
1311   Record.push_back(LangOpts.ModuleFeatures.size());
1312   for (StringRef Feature : LangOpts.ModuleFeatures)
1313     AddString(Feature, Record);
1314 
1315   Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind());
1316   AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record);
1317 
1318   AddString(LangOpts.CurrentModule, Record);
1319 
1320   // Comment options.
1321   Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size());
1322   for (CommentOptions::BlockCommandNamesTy::const_iterator
1323            I = LangOpts.CommentOpts.BlockCommandNames.begin(),
1324            IEnd = LangOpts.CommentOpts.BlockCommandNames.end();
1325        I != IEnd; ++I) {
1326     AddString(*I, Record);
1327   }
1328   Record.push_back(LangOpts.CommentOpts.ParseAllComments);
1329 
1330   Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1331 
1332   // Target options.
1333   Record.clear();
1334   const TargetInfo &Target = Context.getTargetInfo();
1335   const TargetOptions &TargetOpts = Target.getTargetOpts();
1336   AddString(TargetOpts.Triple, Record);
1337   AddString(TargetOpts.CPU, Record);
1338   AddString(TargetOpts.ABI, Record);
1339   Record.push_back(TargetOpts.FeaturesAsWritten.size());
1340   for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1341     AddString(TargetOpts.FeaturesAsWritten[I], Record);
1342   }
1343   Record.push_back(TargetOpts.Features.size());
1344   for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1345     AddString(TargetOpts.Features[I], Record);
1346   }
1347   Stream.EmitRecord(TARGET_OPTIONS, Record);
1348 
1349   // Diagnostic options.
1350   Record.clear();
1351   const DiagnosticOptions &DiagOpts
1352     = Context.getDiagnostics().getDiagnosticOptions();
1353 #define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1354 #define ENUM_DIAGOPT(Name, Type, Bits, Default) \
1355   Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1356 #include "clang/Basic/DiagnosticOptions.def"
1357   Record.push_back(DiagOpts.Warnings.size());
1358   for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1359     AddString(DiagOpts.Warnings[I], Record);
1360   Record.push_back(DiagOpts.Remarks.size());
1361   for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1362     AddString(DiagOpts.Remarks[I], Record);
1363   // Note: we don't serialize the log or serialization file names, because they
1364   // are generally transient files and will almost always be overridden.
1365   Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record);
1366 
1367   // File system options.
1368   Record.clear();
1369   const FileSystemOptions &FSOpts =
1370       Context.getSourceManager().getFileManager().getFileSystemOpts();
1371   AddString(FSOpts.WorkingDir, Record);
1372   Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record);
1373 
1374   // Header search options.
1375   Record.clear();
1376   const HeaderSearchOptions &HSOpts
1377     = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1378   AddString(HSOpts.Sysroot, Record);
1379 
1380   // Include entries.
1381   Record.push_back(HSOpts.UserEntries.size());
1382   for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1383     const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1384     AddString(Entry.Path, Record);
1385     Record.push_back(static_cast<unsigned>(Entry.Group));
1386     Record.push_back(Entry.IsFramework);
1387     Record.push_back(Entry.IgnoreSysRoot);
1388   }
1389 
1390   // System header prefixes.
1391   Record.push_back(HSOpts.SystemHeaderPrefixes.size());
1392   for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1393     AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1394     Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1395   }
1396 
1397   AddString(HSOpts.ResourceDir, Record);
1398   AddString(HSOpts.ModuleCachePath, Record);
1399   AddString(HSOpts.ModuleUserBuildPath, Record);
1400   Record.push_back(HSOpts.DisableModuleHash);
1401   Record.push_back(HSOpts.UseBuiltinIncludes);
1402   Record.push_back(HSOpts.UseStandardSystemIncludes);
1403   Record.push_back(HSOpts.UseStandardCXXIncludes);
1404   Record.push_back(HSOpts.UseLibcxx);
1405   // Write out the specific module cache path that contains the module files.
1406   AddString(PP.getHeaderSearchInfo().getModuleCachePath(), Record);
1407   Stream.EmitRecord(HEADER_SEARCH_OPTIONS, Record);
1408 
1409   // Preprocessor options.
1410   Record.clear();
1411   const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts();
1412 
1413   // Macro definitions.
1414   Record.push_back(PPOpts.Macros.size());
1415   for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1416     AddString(PPOpts.Macros[I].first, Record);
1417     Record.push_back(PPOpts.Macros[I].second);
1418   }
1419 
1420   // Includes
1421   Record.push_back(PPOpts.Includes.size());
1422   for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1423     AddString(PPOpts.Includes[I], Record);
1424 
1425   // Macro includes
1426   Record.push_back(PPOpts.MacroIncludes.size());
1427   for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1428     AddString(PPOpts.MacroIncludes[I], Record);
1429 
1430   Record.push_back(PPOpts.UsePredefines);
1431   // Detailed record is important since it is used for the module cache hash.
1432   Record.push_back(PPOpts.DetailedRecord);
1433   AddString(PPOpts.ImplicitPCHInclude, Record);
1434   AddString(PPOpts.ImplicitPTHInclude, Record);
1435   Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1436   Stream.EmitRecord(PREPROCESSOR_OPTIONS, Record);
1437 
1438   // Leave the options block.
1439   Stream.ExitBlock();
1440 
1441   // Original file name and file ID
1442   SourceManager &SM = Context.getSourceManager();
1443   if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
1444     BitCodeAbbrev *FileAbbrev = new BitCodeAbbrev();
1445     FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE));
1446     FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
1447     FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1448     unsigned FileAbbrevCode = Stream.EmitAbbrev(FileAbbrev);
1449 
1450     Record.clear();
1451     Record.push_back(ORIGINAL_FILE);
1452     Record.push_back(SM.getMainFileID().getOpaqueValue());
1453     EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName());
1454   }
1455 
1456   Record.clear();
1457   Record.push_back(SM.getMainFileID().getOpaqueValue());
1458   Stream.EmitRecord(ORIGINAL_FILE_ID, Record);
1459 
1460   // Original PCH directory
1461   if (!OutputFile.empty() && OutputFile != "-") {
1462     BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1463     Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR));
1464     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1465     unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1466 
1467     SmallString<128> OutputPath(OutputFile);
1468 
1469     SM.getFileManager().makeAbsolutePath(OutputPath);
1470     StringRef origDir = llvm::sys::path::parent_path(OutputPath);
1471 
1472     RecordData::value_type Record[] = {ORIGINAL_PCH_DIR};
1473     Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir);
1474   }
1475 
1476   WriteInputFiles(Context.SourceMgr,
1477                   PP.getHeaderSearchInfo().getHeaderSearchOpts(),
1478                   PP.getLangOpts().Modules);
1479   Stream.ExitBlock();
1480   return Signature;
1481 }
1482 
1483 namespace  {
1484   /// \brief An input file.
1485   struct InputFileEntry {
1486     const FileEntry *File;
1487     bool IsSystemFile;
1488     bool BufferOverridden;
1489   };
1490 }
1491 
1492 void ASTWriter::WriteInputFiles(SourceManager &SourceMgr,
1493                                 HeaderSearchOptions &HSOpts,
1494                                 bool Modules) {
1495   using namespace llvm;
1496   Stream.EnterSubblock(INPUT_FILES_BLOCK_ID, 4);
1497 
1498   // Create input-file abbreviation.
1499   BitCodeAbbrev *IFAbbrev = new BitCodeAbbrev();
1500   IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE));
1501   IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
1502   IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1503   IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
1504   IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
1505   IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1506   unsigned IFAbbrevCode = Stream.EmitAbbrev(IFAbbrev);
1507 
1508   // Get all ContentCache objects for files, sorted by whether the file is a
1509   // system one or not. System files go at the back, users files at the front.
1510   std::deque<InputFileEntry> SortedFiles;
1511   for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
1512     // Get this source location entry.
1513     const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
1514     assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc);
1515 
1516     // We only care about file entries that were not overridden.
1517     if (!SLoc->isFile())
1518       continue;
1519     const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
1520     if (!Cache->OrigEntry)
1521       continue;
1522 
1523     InputFileEntry Entry;
1524     Entry.File = Cache->OrigEntry;
1525     Entry.IsSystemFile = Cache->IsSystemFile;
1526     Entry.BufferOverridden = Cache->BufferOverridden;
1527     if (Cache->IsSystemFile)
1528       SortedFiles.push_back(Entry);
1529     else
1530       SortedFiles.push_front(Entry);
1531   }
1532 
1533   unsigned UserFilesNum = 0;
1534   // Write out all of the input files.
1535   std::vector<uint64_t> InputFileOffsets;
1536   for (std::deque<InputFileEntry>::iterator
1537          I = SortedFiles.begin(), E = SortedFiles.end(); I != E; ++I) {
1538     const InputFileEntry &Entry = *I;
1539 
1540     uint32_t &InputFileID = InputFileIDs[Entry.File];
1541     if (InputFileID != 0)
1542       continue; // already recorded this file.
1543 
1544     // Record this entry's offset.
1545     InputFileOffsets.push_back(Stream.GetCurrentBitNo());
1546 
1547     InputFileID = InputFileOffsets.size();
1548 
1549     if (!Entry.IsSystemFile)
1550       ++UserFilesNum;
1551 
1552     // Emit size/modification time for this file.
1553     // And whether this file was overridden.
1554     RecordData::value_type Record[] = {
1555         INPUT_FILE, InputFileOffsets.size(), (uint64_t)Entry.File->getSize(),
1556         (uint64_t)getTimestampForOutput(Entry.File), Entry.BufferOverridden};
1557 
1558     EmitRecordWithPath(IFAbbrevCode, Record, Entry.File->getName());
1559   }
1560 
1561   Stream.ExitBlock();
1562 
1563   // Create input file offsets abbreviation.
1564   BitCodeAbbrev *OffsetsAbbrev = new BitCodeAbbrev();
1565   OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1566   OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
1567   OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1568                                                                 //   input files
1569   OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));   // Array
1570   unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(OffsetsAbbrev);
1571 
1572   // Write input file offsets.
1573   RecordData::value_type Record[] = {INPUT_FILE_OFFSETS,
1574                                      InputFileOffsets.size(), UserFilesNum};
1575   Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, bytes(InputFileOffsets));
1576 }
1577 
1578 //===----------------------------------------------------------------------===//
1579 // Source Manager Serialization
1580 //===----------------------------------------------------------------------===//
1581 
1582 /// \brief Create an abbreviation for the SLocEntry that refers to a
1583 /// file.
1584 static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
1585   using namespace llvm;
1586   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1587   Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
1588   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1589   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1590   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1591   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1592   // FileEntry fields.
1593   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
1594   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
1595   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
1596   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
1597   return Stream.EmitAbbrev(Abbrev);
1598 }
1599 
1600 /// \brief Create an abbreviation for the SLocEntry that refers to a
1601 /// buffer.
1602 static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
1603   using namespace llvm;
1604   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1605   Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
1606   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1607   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1608   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1609   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1610   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
1611   return Stream.EmitAbbrev(Abbrev);
1612 }
1613 
1614 /// \brief Create an abbreviation for the SLocEntry that refers to a
1615 /// buffer's blob.
1616 static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream) {
1617   using namespace llvm;
1618   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1619   Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_BLOB));
1620   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
1621   return Stream.EmitAbbrev(Abbrev);
1622 }
1623 
1624 /// \brief Create an abbreviation for the SLocEntry that refers to a macro
1625 /// expansion.
1626 static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
1627   using namespace llvm;
1628   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1629   Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
1630   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1631   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1632   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1633   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
1634   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
1635   return Stream.EmitAbbrev(Abbrev);
1636 }
1637 
1638 namespace {
1639   // Trait used for the on-disk hash table of header search information.
1640   class HeaderFileInfoTrait {
1641     ASTWriter &Writer;
1642     const HeaderSearch &HS;
1643 
1644     // Keep track of the framework names we've used during serialization.
1645     SmallVector<char, 128> FrameworkStringData;
1646     llvm::StringMap<unsigned> FrameworkNameOffset;
1647 
1648   public:
1649     HeaderFileInfoTrait(ASTWriter &Writer, const HeaderSearch &HS)
1650       : Writer(Writer), HS(HS) { }
1651 
1652     struct key_type {
1653       const FileEntry *FE;
1654       const char *Filename;
1655     };
1656     typedef const key_type &key_type_ref;
1657 
1658     typedef HeaderFileInfo data_type;
1659     typedef const data_type &data_type_ref;
1660     typedef unsigned hash_value_type;
1661     typedef unsigned offset_type;
1662 
1663     hash_value_type ComputeHash(key_type_ref key) {
1664       // The hash is based only on size/time of the file, so that the reader can
1665       // match even when symlinking or excess path elements ("foo/../", "../")
1666       // change the form of the name. However, complete path is still the key.
1667       return llvm::hash_combine(key.FE->getSize(),
1668                                 Writer.getTimestampForOutput(key.FE));
1669     }
1670 
1671     std::pair<unsigned,unsigned>
1672     EmitKeyDataLength(raw_ostream& Out, key_type_ref key, data_type_ref Data) {
1673       using namespace llvm::support;
1674       endian::Writer<little> LE(Out);
1675       unsigned KeyLen = strlen(key.Filename) + 1 + 8 + 8;
1676       LE.write<uint16_t>(KeyLen);
1677       unsigned DataLen = 1 + 2 + 4 + 4;
1678       for (auto ModInfo : HS.getModuleMap().findAllModulesForHeader(key.FE))
1679         if (Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule()))
1680           DataLen += 4;
1681       LE.write<uint8_t>(DataLen);
1682       return std::make_pair(KeyLen, DataLen);
1683     }
1684 
1685     void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) {
1686       using namespace llvm::support;
1687       endian::Writer<little> LE(Out);
1688       LE.write<uint64_t>(key.FE->getSize());
1689       KeyLen -= 8;
1690       LE.write<uint64_t>(Writer.getTimestampForOutput(key.FE));
1691       KeyLen -= 8;
1692       Out.write(key.Filename, KeyLen);
1693     }
1694 
1695     void EmitData(raw_ostream &Out, key_type_ref key,
1696                   data_type_ref Data, unsigned DataLen) {
1697       using namespace llvm::support;
1698       endian::Writer<little> LE(Out);
1699       uint64_t Start = Out.tell(); (void)Start;
1700 
1701       unsigned char Flags = (Data.isImport << 4)
1702                           | (Data.isPragmaOnce << 3)
1703                           | (Data.DirInfo << 1)
1704                           | Data.IndexHeaderMapHeader;
1705       LE.write<uint8_t>(Flags);
1706       LE.write<uint16_t>(Data.NumIncludes);
1707 
1708       if (!Data.ControllingMacro)
1709         LE.write<uint32_t>(Data.ControllingMacroID);
1710       else
1711         LE.write<uint32_t>(Writer.getIdentifierRef(Data.ControllingMacro));
1712 
1713       unsigned Offset = 0;
1714       if (!Data.Framework.empty()) {
1715         // If this header refers into a framework, save the framework name.
1716         llvm::StringMap<unsigned>::iterator Pos
1717           = FrameworkNameOffset.find(Data.Framework);
1718         if (Pos == FrameworkNameOffset.end()) {
1719           Offset = FrameworkStringData.size() + 1;
1720           FrameworkStringData.append(Data.Framework.begin(),
1721                                      Data.Framework.end());
1722           FrameworkStringData.push_back(0);
1723 
1724           FrameworkNameOffset[Data.Framework] = Offset;
1725         } else
1726           Offset = Pos->second;
1727       }
1728       LE.write<uint32_t>(Offset);
1729 
1730       // FIXME: If the header is excluded, we should write out some
1731       // record of that fact.
1732       for (auto ModInfo : HS.getModuleMap().findAllModulesForHeader(key.FE)) {
1733         if (uint32_t ModID =
1734                 Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule())) {
1735           uint32_t Value = (ModID << 2) | (unsigned)ModInfo.getRole();
1736           assert((Value >> 2) == ModID && "overflow in header module info");
1737           LE.write<uint32_t>(Value);
1738         }
1739       }
1740 
1741       assert(Out.tell() - Start == DataLen && "Wrong data length");
1742     }
1743 
1744     const char *strings_begin() const { return FrameworkStringData.begin(); }
1745     const char *strings_end() const { return FrameworkStringData.end(); }
1746   };
1747 } // end anonymous namespace
1748 
1749 /// \brief Write the header search block for the list of files that
1750 ///
1751 /// \param HS The header search structure to save.
1752 void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) {
1753   SmallVector<const FileEntry *, 16> FilesByUID;
1754   HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
1755 
1756   if (FilesByUID.size() > HS.header_file_size())
1757     FilesByUID.resize(HS.header_file_size());
1758 
1759   HeaderFileInfoTrait GeneratorTrait(*this, HS);
1760   llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
1761   SmallVector<const char *, 4> SavedStrings;
1762   unsigned NumHeaderSearchEntries = 0;
1763   for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
1764     const FileEntry *File = FilesByUID[UID];
1765     if (!File)
1766       continue;
1767 
1768     // Get the file info. This will load info from the external source if
1769     // necessary. Skip emitting this file if we have no information on it
1770     // as a header file (in which case HFI will be null) or if it hasn't
1771     // changed since it was loaded. Also skip it if it's for a modular header
1772     // from a different module; in that case, we rely on the module(s)
1773     // containing the header to provide this information.
1774     const HeaderFileInfo *HFI =
1775         HS.getExistingFileInfo(File, /*WantExternal*/!Chain);
1776     if (!HFI || (HFI->isModuleHeader && !HFI->isCompilingModuleHeader))
1777       continue;
1778 
1779     // Massage the file path into an appropriate form.
1780     const char *Filename = File->getName();
1781     SmallString<128> FilenameTmp(Filename);
1782     if (PreparePathForOutput(FilenameTmp)) {
1783       // If we performed any translation on the file name at all, we need to
1784       // save this string, since the generator will refer to it later.
1785       Filename = strdup(FilenameTmp.c_str());
1786       SavedStrings.push_back(Filename);
1787     }
1788 
1789     HeaderFileInfoTrait::key_type key = { File, Filename };
1790     Generator.insert(key, *HFI, GeneratorTrait);
1791     ++NumHeaderSearchEntries;
1792   }
1793 
1794   // Create the on-disk hash table in a buffer.
1795   SmallString<4096> TableData;
1796   uint32_t BucketOffset;
1797   {
1798     using namespace llvm::support;
1799     llvm::raw_svector_ostream Out(TableData);
1800     // Make sure that no bucket is at offset 0
1801     endian::Writer<little>(Out).write<uint32_t>(0);
1802     BucketOffset = Generator.Emit(Out, GeneratorTrait);
1803   }
1804 
1805   // Create a blob abbreviation
1806   using namespace llvm;
1807   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1808   Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
1809   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1810   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1811   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1812   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1813   unsigned TableAbbrev = Stream.EmitAbbrev(Abbrev);
1814 
1815   // Write the header search table
1816   RecordData::value_type Record[] = {HEADER_SEARCH_TABLE, BucketOffset,
1817                                      NumHeaderSearchEntries, TableData.size()};
1818   TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end());
1819   Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData);
1820 
1821   // Free all of the strings we had to duplicate.
1822   for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
1823     free(const_cast<char *>(SavedStrings[I]));
1824 }
1825 
1826 /// \brief Writes the block containing the serialized form of the
1827 /// source manager.
1828 ///
1829 /// TODO: We should probably use an on-disk hash table (stored in a
1830 /// blob), indexed based on the file name, so that we only create
1831 /// entries for files that we actually need. In the common case (no
1832 /// errors), we probably won't have to create file entries for any of
1833 /// the files in the AST.
1834 void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
1835                                         const Preprocessor &PP) {
1836   RecordData Record;
1837 
1838   // Enter the source manager block.
1839   Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 3);
1840 
1841   // Abbreviations for the various kinds of source-location entries.
1842   unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
1843   unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
1844   unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream);
1845   unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
1846 
1847   // Write out the source location entry table. We skip the first
1848   // entry, which is always the same dummy entry.
1849   std::vector<uint32_t> SLocEntryOffsets;
1850   RecordData PreloadSLocs;
1851   SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1);
1852   for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
1853        I != N; ++I) {
1854     // Get this source location entry.
1855     const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
1856     FileID FID = FileID::get(I);
1857     assert(&SourceMgr.getSLocEntry(FID) == SLoc);
1858 
1859     // Record the offset of this source-location entry.
1860     SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
1861 
1862     // Figure out which record code to use.
1863     unsigned Code;
1864     if (SLoc->isFile()) {
1865       const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
1866       if (Cache->OrigEntry) {
1867         Code = SM_SLOC_FILE_ENTRY;
1868       } else
1869         Code = SM_SLOC_BUFFER_ENTRY;
1870     } else
1871       Code = SM_SLOC_EXPANSION_ENTRY;
1872     Record.clear();
1873     Record.push_back(Code);
1874 
1875     // Starting offset of this entry within this module, so skip the dummy.
1876     Record.push_back(SLoc->getOffset() - 2);
1877     if (SLoc->isFile()) {
1878       const SrcMgr::FileInfo &File = SLoc->getFile();
1879       Record.push_back(File.getIncludeLoc().getRawEncoding());
1880       Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
1881       Record.push_back(File.hasLineDirectives());
1882 
1883       const SrcMgr::ContentCache *Content = File.getContentCache();
1884       if (Content->OrigEntry) {
1885         assert(Content->OrigEntry == Content->ContentsEntry &&
1886                "Writing to AST an overridden file is not supported");
1887 
1888         // The source location entry is a file. Emit input file ID.
1889         assert(InputFileIDs[Content->OrigEntry] != 0 && "Missed file entry");
1890         Record.push_back(InputFileIDs[Content->OrigEntry]);
1891 
1892         Record.push_back(File.NumCreatedFIDs);
1893 
1894         FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID);
1895         if (FDI != FileDeclIDs.end()) {
1896           Record.push_back(FDI->second->FirstDeclIndex);
1897           Record.push_back(FDI->second->DeclIDs.size());
1898         } else {
1899           Record.push_back(0);
1900           Record.push_back(0);
1901         }
1902 
1903         Stream.EmitRecordWithAbbrev(SLocFileAbbrv, Record);
1904 
1905         if (Content->BufferOverridden) {
1906           RecordData::value_type Record[] = {SM_SLOC_BUFFER_BLOB};
1907           const llvm::MemoryBuffer *Buffer
1908             = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
1909           Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record,
1910                                     StringRef(Buffer->getBufferStart(),
1911                                               Buffer->getBufferSize() + 1));
1912         }
1913       } else {
1914         // The source location entry is a buffer. The blob associated
1915         // with this entry contains the contents of the buffer.
1916 
1917         // We add one to the size so that we capture the trailing NULL
1918         // that is required by llvm::MemoryBuffer::getMemBuffer (on
1919         // the reader side).
1920         const llvm::MemoryBuffer *Buffer
1921           = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
1922         const char *Name = Buffer->getBufferIdentifier();
1923         Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
1924                                   StringRef(Name, strlen(Name) + 1));
1925         RecordData::value_type Record[] = {SM_SLOC_BUFFER_BLOB};
1926         Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record,
1927                                   StringRef(Buffer->getBufferStart(),
1928                                                   Buffer->getBufferSize() + 1));
1929 
1930         if (strcmp(Name, "<built-in>") == 0) {
1931           PreloadSLocs.push_back(SLocEntryOffsets.size());
1932         }
1933       }
1934     } else {
1935       // The source location entry is a macro expansion.
1936       const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
1937       Record.push_back(Expansion.getSpellingLoc().getRawEncoding());
1938       Record.push_back(Expansion.getExpansionLocStart().getRawEncoding());
1939       Record.push_back(Expansion.isMacroArgExpansion() ? 0
1940                              : Expansion.getExpansionLocEnd().getRawEncoding());
1941 
1942       // Compute the token length for this macro expansion.
1943       unsigned NextOffset = SourceMgr.getNextLocalOffset();
1944       if (I + 1 != N)
1945         NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset();
1946       Record.push_back(NextOffset - SLoc->getOffset() - 1);
1947       Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record);
1948     }
1949   }
1950 
1951   Stream.ExitBlock();
1952 
1953   if (SLocEntryOffsets.empty())
1954     return;
1955 
1956   // Write the source-location offsets table into the AST block. This
1957   // table is used for lazily loading source-location information.
1958   using namespace llvm;
1959   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1960   Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
1961   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
1962   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
1963   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
1964   unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(Abbrev);
1965   {
1966     RecordData::value_type Record[] = {
1967         SOURCE_LOCATION_OFFSETS, SLocEntryOffsets.size(),
1968         SourceMgr.getNextLocalOffset() - 1 /* skip dummy */};
1969     Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
1970                               bytes(SLocEntryOffsets));
1971   }
1972   // Write the source location entry preloads array, telling the AST
1973   // reader which source locations entries it should load eagerly.
1974   Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
1975 
1976   // Write the line table. It depends on remapping working, so it must come
1977   // after the source location offsets.
1978   if (SourceMgr.hasLineTable()) {
1979     LineTableInfo &LineTable = SourceMgr.getLineTable();
1980 
1981     Record.clear();
1982 
1983     // Emit the needed file names.
1984     llvm::DenseMap<int, int> FilenameMap;
1985     for (const auto &L : LineTable) {
1986       if (L.first.ID < 0)
1987         continue;
1988       for (auto &LE : L.second) {
1989         if (FilenameMap.insert(std::make_pair(LE.FilenameID,
1990                                               FilenameMap.size())).second)
1991           AddPath(LineTable.getFilename(LE.FilenameID), Record);
1992       }
1993     }
1994     Record.push_back(0);
1995 
1996     // Emit the line entries
1997     for (LineTableInfo::iterator L = LineTable.begin(), LEnd = LineTable.end();
1998          L != LEnd; ++L) {
1999       // Only emit entries for local files.
2000       if (L->first.ID < 0)
2001         continue;
2002 
2003       // Emit the file ID
2004       Record.push_back(L->first.ID);
2005 
2006       // Emit the line entries
2007       Record.push_back(L->second.size());
2008       for (std::vector<LineEntry>::iterator LE = L->second.begin(),
2009                                          LEEnd = L->second.end();
2010            LE != LEEnd; ++LE) {
2011         Record.push_back(LE->FileOffset);
2012         Record.push_back(LE->LineNo);
2013         Record.push_back(FilenameMap[LE->FilenameID]);
2014         Record.push_back((unsigned)LE->FileKind);
2015         Record.push_back(LE->IncludeOffset);
2016       }
2017     }
2018 
2019     Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record);
2020   }
2021 }
2022 
2023 //===----------------------------------------------------------------------===//
2024 // Preprocessor Serialization
2025 //===----------------------------------------------------------------------===//
2026 
2027 static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule,
2028                               const Preprocessor &PP) {
2029   if (MacroInfo *MI = MD->getMacroInfo())
2030     if (MI->isBuiltinMacro())
2031       return true;
2032 
2033   if (IsModule) {
2034     SourceLocation Loc = MD->getLocation();
2035     if (Loc.isInvalid())
2036       return true;
2037     if (PP.getSourceManager().getFileID(Loc) == PP.getPredefinesFileID())
2038       return true;
2039   }
2040 
2041   return false;
2042 }
2043 
2044 /// \brief Writes the block containing the serialized form of the
2045 /// preprocessor.
2046 ///
2047 void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
2048   PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
2049   if (PPRec)
2050     WritePreprocessorDetail(*PPRec);
2051 
2052   RecordData Record;
2053   RecordData ModuleMacroRecord;
2054 
2055   // If the preprocessor __COUNTER__ value has been bumped, remember it.
2056   if (PP.getCounterValue() != 0) {
2057     RecordData::value_type Record[] = {PP.getCounterValue()};
2058     Stream.EmitRecord(PP_COUNTER_VALUE, Record);
2059   }
2060 
2061   // Enter the preprocessor block.
2062   Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
2063 
2064   // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
2065   // FIXME: Include a location for the use, and say which one was used.
2066   if (PP.SawDateOrTime())
2067     PP.Diag(SourceLocation(), diag::warn_module_uses_date_time) << IsModule;
2068 
2069   // Loop over all the macro directives that are live at the end of the file,
2070   // emitting each to the PP section.
2071 
2072   // Construct the list of identifiers with macro directives that need to be
2073   // serialized.
2074   SmallVector<const IdentifierInfo *, 128> MacroIdentifiers;
2075   for (auto &Id : PP.getIdentifierTable())
2076     if (Id.second->hadMacroDefinition() &&
2077         (!Id.second->isFromAST() ||
2078          Id.second->hasChangedSinceDeserialization()))
2079       MacroIdentifiers.push_back(Id.second);
2080   // Sort the set of macro definitions that need to be serialized by the
2081   // name of the macro, to provide a stable ordering.
2082   std::sort(MacroIdentifiers.begin(), MacroIdentifiers.end(),
2083             llvm::less_ptr<IdentifierInfo>());
2084 
2085   // Emit the macro directives as a list and associate the offset with the
2086   // identifier they belong to.
2087   for (const IdentifierInfo *Name : MacroIdentifiers) {
2088     MacroDirective *MD = PP.getLocalMacroDirectiveHistory(Name);
2089     auto StartOffset = Stream.GetCurrentBitNo();
2090 
2091     // Emit the macro directives in reverse source order.
2092     for (; MD; MD = MD->getPrevious()) {
2093       // Once we hit an ignored macro, we're done: the rest of the chain
2094       // will all be ignored macros.
2095       if (shouldIgnoreMacro(MD, IsModule, PP))
2096         break;
2097 
2098       AddSourceLocation(MD->getLocation(), Record);
2099       Record.push_back(MD->getKind());
2100       if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
2101         Record.push_back(getMacroRef(DefMD->getInfo(), Name));
2102       } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
2103         Record.push_back(VisMD->isPublic());
2104       }
2105     }
2106 
2107     // Write out any exported module macros.
2108     bool EmittedModuleMacros = false;
2109     if (IsModule) {
2110       auto Leafs = PP.getLeafModuleMacros(Name);
2111       SmallVector<ModuleMacro*, 8> Worklist(Leafs.begin(), Leafs.end());
2112       llvm::DenseMap<ModuleMacro*, unsigned> Visits;
2113       while (!Worklist.empty()) {
2114         auto *Macro = Worklist.pop_back_val();
2115 
2116         // Emit a record indicating this submodule exports this macro.
2117         ModuleMacroRecord.push_back(
2118             getSubmoduleID(Macro->getOwningModule()));
2119         ModuleMacroRecord.push_back(getMacroRef(Macro->getMacroInfo(), Name));
2120         for (auto *M : Macro->overrides())
2121           ModuleMacroRecord.push_back(getSubmoduleID(M->getOwningModule()));
2122 
2123         Stream.EmitRecord(PP_MODULE_MACRO, ModuleMacroRecord);
2124         ModuleMacroRecord.clear();
2125 
2126         // Enqueue overridden macros once we've visited all their ancestors.
2127         for (auto *M : Macro->overrides())
2128           if (++Visits[M] == M->getNumOverridingMacros())
2129             Worklist.push_back(M);
2130 
2131         EmittedModuleMacros = true;
2132       }
2133     }
2134 
2135     if (Record.empty() && !EmittedModuleMacros)
2136       continue;
2137 
2138     IdentMacroDirectivesOffsetMap[Name] = StartOffset;
2139     Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, Record);
2140     Record.clear();
2141   }
2142 
2143   /// \brief Offsets of each of the macros into the bitstream, indexed by
2144   /// the local macro ID
2145   ///
2146   /// For each identifier that is associated with a macro, this map
2147   /// provides the offset into the bitstream where that macro is
2148   /// defined.
2149   std::vector<uint32_t> MacroOffsets;
2150 
2151   for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) {
2152     const IdentifierInfo *Name = MacroInfosToEmit[I].Name;
2153     MacroInfo *MI = MacroInfosToEmit[I].MI;
2154     MacroID ID = MacroInfosToEmit[I].ID;
2155 
2156     if (ID < FirstMacroID) {
2157       assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?");
2158       continue;
2159     }
2160 
2161     // Record the local offset of this macro.
2162     unsigned Index = ID - FirstMacroID;
2163     if (Index == MacroOffsets.size())
2164       MacroOffsets.push_back(Stream.GetCurrentBitNo());
2165     else {
2166       if (Index > MacroOffsets.size())
2167         MacroOffsets.resize(Index + 1);
2168 
2169       MacroOffsets[Index] = Stream.GetCurrentBitNo();
2170     }
2171 
2172     AddIdentifierRef(Name, Record);
2173     Record.push_back(inferSubmoduleIDFromLocation(MI->getDefinitionLoc()));
2174     AddSourceLocation(MI->getDefinitionLoc(), Record);
2175     AddSourceLocation(MI->getDefinitionEndLoc(), Record);
2176     Record.push_back(MI->isUsed());
2177     Record.push_back(MI->isUsedForHeaderGuard());
2178     unsigned Code;
2179     if (MI->isObjectLike()) {
2180       Code = PP_MACRO_OBJECT_LIKE;
2181     } else {
2182       Code = PP_MACRO_FUNCTION_LIKE;
2183 
2184       Record.push_back(MI->isC99Varargs());
2185       Record.push_back(MI->isGNUVarargs());
2186       Record.push_back(MI->hasCommaPasting());
2187       Record.push_back(MI->getNumArgs());
2188       for (const IdentifierInfo *Arg : MI->args())
2189         AddIdentifierRef(Arg, Record);
2190     }
2191 
2192     // If we have a detailed preprocessing record, record the macro definition
2193     // ID that corresponds to this macro.
2194     if (PPRec)
2195       Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2196 
2197     Stream.EmitRecord(Code, Record);
2198     Record.clear();
2199 
2200     // Emit the tokens array.
2201     for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
2202       // Note that we know that the preprocessor does not have any annotation
2203       // tokens in it because they are created by the parser, and thus can't
2204       // be in a macro definition.
2205       const Token &Tok = MI->getReplacementToken(TokNo);
2206       AddToken(Tok, Record);
2207       Stream.EmitRecord(PP_TOKEN, Record);
2208       Record.clear();
2209     }
2210     ++NumMacros;
2211   }
2212 
2213   Stream.ExitBlock();
2214 
2215   // Write the offsets table for macro IDs.
2216   using namespace llvm;
2217   auto *Abbrev = new BitCodeAbbrev();
2218   Abbrev->Add(BitCodeAbbrevOp(MACRO_OFFSET));
2219   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2220   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2221   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2222 
2223   unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2224   {
2225     RecordData::value_type Record[] = {MACRO_OFFSET, MacroOffsets.size(),
2226                                        FirstMacroID - NUM_PREDEF_MACRO_IDS};
2227     Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record, bytes(MacroOffsets));
2228   }
2229 }
2230 
2231 void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) {
2232   if (PPRec.local_begin() == PPRec.local_end())
2233     return;
2234 
2235   SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
2236 
2237   // Enter the preprocessor block.
2238   Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3);
2239 
2240   // If the preprocessor has a preprocessing record, emit it.
2241   unsigned NumPreprocessingRecords = 0;
2242   using namespace llvm;
2243 
2244   // Set up the abbreviation for
2245   unsigned InclusionAbbrev = 0;
2246   {
2247     BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2248     Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
2249     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2250     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2251     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
2252     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
2253     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2254     InclusionAbbrev = Stream.EmitAbbrev(Abbrev);
2255   }
2256 
2257   unsigned FirstPreprocessorEntityID
2258     = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0)
2259     + NUM_PREDEF_PP_ENTITY_IDS;
2260   unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
2261   RecordData Record;
2262   for (PreprocessingRecord::iterator E = PPRec.local_begin(),
2263                                   EEnd = PPRec.local_end();
2264        E != EEnd;
2265        (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
2266     Record.clear();
2267 
2268     PreprocessedEntityOffsets.push_back(
2269         PPEntityOffset((*E)->getSourceRange(), Stream.GetCurrentBitNo()));
2270 
2271     if (MacroDefinitionRecord *MD = dyn_cast<MacroDefinitionRecord>(*E)) {
2272       // Record this macro definition's ID.
2273       MacroDefinitions[MD] = NextPreprocessorEntityID;
2274 
2275       AddIdentifierRef(MD->getName(), Record);
2276       Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
2277       continue;
2278     }
2279 
2280     if (MacroExpansion *ME = dyn_cast<MacroExpansion>(*E)) {
2281       Record.push_back(ME->isBuiltinMacro());
2282       if (ME->isBuiltinMacro())
2283         AddIdentifierRef(ME->getName(), Record);
2284       else
2285         Record.push_back(MacroDefinitions[ME->getDefinition()]);
2286       Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
2287       continue;
2288     }
2289 
2290     if (InclusionDirective *ID = dyn_cast<InclusionDirective>(*E)) {
2291       Record.push_back(PPD_INCLUSION_DIRECTIVE);
2292       Record.push_back(ID->getFileName().size());
2293       Record.push_back(ID->wasInQuotes());
2294       Record.push_back(static_cast<unsigned>(ID->getKind()));
2295       Record.push_back(ID->importedModule());
2296       SmallString<64> Buffer;
2297       Buffer += ID->getFileName();
2298       // Check that the FileEntry is not null because it was not resolved and
2299       // we create a PCH even with compiler errors.
2300       if (ID->getFile())
2301         Buffer += ID->getFile()->getName();
2302       Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
2303       continue;
2304     }
2305 
2306     llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
2307   }
2308   Stream.ExitBlock();
2309 
2310   // Write the offsets table for the preprocessing record.
2311   if (NumPreprocessingRecords > 0) {
2312     assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
2313 
2314     // Write the offsets table for identifier IDs.
2315     using namespace llvm;
2316     BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2317     Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
2318     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity
2319     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2320     unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2321 
2322     RecordData::value_type Record[] = {PPD_ENTITIES_OFFSETS,
2323                                        FirstPreprocessorEntityID -
2324                                            NUM_PREDEF_PP_ENTITY_IDS};
2325     Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
2326                               bytes(PreprocessedEntityOffsets));
2327   }
2328 }
2329 
2330 unsigned ASTWriter::getLocalOrImportedSubmoduleID(Module *Mod) {
2331   if (!Mod)
2332     return 0;
2333 
2334   llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod);
2335   if (Known != SubmoduleIDs.end())
2336     return Known->second;
2337 
2338   if (Mod->getTopLevelModule() != WritingModule)
2339     return 0;
2340 
2341   return SubmoduleIDs[Mod] = NextSubmoduleID++;
2342 }
2343 
2344 unsigned ASTWriter::getSubmoduleID(Module *Mod) {
2345   // FIXME: This can easily happen, if we have a reference to a submodule that
2346   // did not result in us loading a module file for that submodule. For
2347   // instance, a cross-top-level-module 'conflict' declaration will hit this.
2348   unsigned ID = getLocalOrImportedSubmoduleID(Mod);
2349   assert((ID || !Mod) &&
2350          "asked for module ID for non-local, non-imported module");
2351   return ID;
2352 }
2353 
2354 /// \brief Compute the number of modules within the given tree (including the
2355 /// given module).
2356 static unsigned getNumberOfModules(Module *Mod) {
2357   unsigned ChildModules = 0;
2358   for (Module::submodule_iterator Sub = Mod->submodule_begin(),
2359                                SubEnd = Mod->submodule_end();
2360        Sub != SubEnd; ++Sub)
2361     ChildModules += getNumberOfModules(*Sub);
2362 
2363   return ChildModules + 1;
2364 }
2365 
2366 void ASTWriter::WriteSubmodules(Module *WritingModule) {
2367   // Enter the submodule description block.
2368   Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/5);
2369 
2370   // Write the abbreviations needed for the submodules block.
2371   using namespace llvm;
2372   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2373   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
2374   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
2375   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
2376   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2377   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
2378   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
2379   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
2380   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
2381   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
2382   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
2383   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
2384   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2385   unsigned DefinitionAbbrev = Stream.EmitAbbrev(Abbrev);
2386 
2387   Abbrev = new BitCodeAbbrev();
2388   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
2389   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2390   unsigned UmbrellaAbbrev = Stream.EmitAbbrev(Abbrev);
2391 
2392   Abbrev = new BitCodeAbbrev();
2393   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
2394   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2395   unsigned HeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2396 
2397   Abbrev = new BitCodeAbbrev();
2398   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
2399   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2400   unsigned TopHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2401 
2402   Abbrev = new BitCodeAbbrev();
2403   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
2404   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2405   unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(Abbrev);
2406 
2407   Abbrev = new BitCodeAbbrev();
2408   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES));
2409   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
2410   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));     // Feature
2411   unsigned RequiresAbbrev = Stream.EmitAbbrev(Abbrev);
2412 
2413   Abbrev = new BitCodeAbbrev();
2414   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
2415   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2416   unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2417 
2418   Abbrev = new BitCodeAbbrev();
2419   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
2420   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2421   unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2422 
2423   Abbrev = new BitCodeAbbrev();
2424   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
2425   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2426   unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2427 
2428   Abbrev = new BitCodeAbbrev();
2429   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
2430   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2431   unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2432 
2433   Abbrev = new BitCodeAbbrev();
2434   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
2435   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2436   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));     // Name
2437   unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(Abbrev);
2438 
2439   Abbrev = new BitCodeAbbrev();
2440   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
2441   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));    // Macro name
2442   unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(Abbrev);
2443 
2444   Abbrev = new BitCodeAbbrev();
2445   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT));
2446   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));  // Other module
2447   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));    // Message
2448   unsigned ConflictAbbrev = Stream.EmitAbbrev(Abbrev);
2449 
2450   // Write the submodule metadata block.
2451   RecordData::value_type Record[] = {getNumberOfModules(WritingModule),
2452                                      FirstSubmoduleID -
2453                                          NUM_PREDEF_SUBMODULE_IDS};
2454   Stream.EmitRecord(SUBMODULE_METADATA, Record);
2455 
2456   // Write all of the submodules.
2457   std::queue<Module *> Q;
2458   Q.push(WritingModule);
2459   while (!Q.empty()) {
2460     Module *Mod = Q.front();
2461     Q.pop();
2462     unsigned ID = getSubmoduleID(Mod);
2463 
2464     uint64_t ParentID = 0;
2465     if (Mod->Parent) {
2466       assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
2467       ParentID = SubmoduleIDs[Mod->Parent];
2468     }
2469 
2470     // Emit the definition of the block.
2471     {
2472       RecordData::value_type Record[] = {
2473           SUBMODULE_DEFINITION, ID, ParentID, Mod->IsFramework, Mod->IsExplicit,
2474           Mod->IsSystem, Mod->IsExternC, Mod->InferSubmodules,
2475           Mod->InferExplicitSubmodules, Mod->InferExportWildcard,
2476           Mod->ConfigMacrosExhaustive};
2477       Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name);
2478     }
2479 
2480     // Emit the requirements.
2481     for (const auto &R : Mod->Requirements) {
2482       RecordData::value_type Record[] = {SUBMODULE_REQUIRES, R.second};
2483       Stream.EmitRecordWithBlob(RequiresAbbrev, Record, R.first);
2484     }
2485 
2486     // Emit the umbrella header, if there is one.
2487     if (auto UmbrellaHeader = Mod->getUmbrellaHeader()) {
2488       RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_HEADER};
2489       Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
2490                                 UmbrellaHeader.NameAsWritten);
2491     } else if (auto UmbrellaDir = Mod->getUmbrellaDir()) {
2492       RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_DIR};
2493       Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
2494                                 UmbrellaDir.NameAsWritten);
2495     }
2496 
2497     // Emit the headers.
2498     struct {
2499       unsigned RecordKind;
2500       unsigned Abbrev;
2501       Module::HeaderKind HeaderKind;
2502     } HeaderLists[] = {
2503       {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal},
2504       {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual},
2505       {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private},
2506       {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev,
2507         Module::HK_PrivateTextual},
2508       {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded}
2509     };
2510     for (auto &HL : HeaderLists) {
2511       RecordData::value_type Record[] = {HL.RecordKind};
2512       for (auto &H : Mod->Headers[HL.HeaderKind])
2513         Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten);
2514     }
2515 
2516     // Emit the top headers.
2517     {
2518       auto TopHeaders = Mod->getTopHeaders(PP->getFileManager());
2519       RecordData::value_type Record[] = {SUBMODULE_TOPHEADER};
2520       for (auto *H : TopHeaders)
2521         Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, H->getName());
2522     }
2523 
2524     // Emit the imports.
2525     if (!Mod->Imports.empty()) {
2526       RecordData Record;
2527       for (auto *I : Mod->Imports)
2528         Record.push_back(getSubmoduleID(I));
2529       Stream.EmitRecord(SUBMODULE_IMPORTS, Record);
2530     }
2531 
2532     // Emit the exports.
2533     if (!Mod->Exports.empty()) {
2534       RecordData Record;
2535       for (const auto &E : Mod->Exports) {
2536         // FIXME: This may fail; we don't require that all exported modules
2537         // are local or imported.
2538         Record.push_back(getSubmoduleID(E.getPointer()));
2539         Record.push_back(E.getInt());
2540       }
2541       Stream.EmitRecord(SUBMODULE_EXPORTS, Record);
2542     }
2543 
2544     //FIXME: How do we emit the 'use'd modules?  They may not be submodules.
2545     // Might be unnecessary as use declarations are only used to build the
2546     // module itself.
2547 
2548     // Emit the link libraries.
2549     for (const auto &LL : Mod->LinkLibraries) {
2550       RecordData::value_type Record[] = {SUBMODULE_LINK_LIBRARY,
2551                                          LL.IsFramework};
2552       Stream.EmitRecordWithBlob(LinkLibraryAbbrev, Record, LL.Library);
2553     }
2554 
2555     // Emit the conflicts.
2556     for (const auto &C : Mod->Conflicts) {
2557       // FIXME: This may fail; we don't require that all conflicting modules
2558       // are local or imported.
2559       RecordData::value_type Record[] = {SUBMODULE_CONFLICT,
2560                                          getSubmoduleID(C.Other)};
2561       Stream.EmitRecordWithBlob(ConflictAbbrev, Record, C.Message);
2562     }
2563 
2564     // Emit the configuration macros.
2565     for (const auto &CM : Mod->ConfigMacros) {
2566       RecordData::value_type Record[] = {SUBMODULE_CONFIG_MACRO};
2567       Stream.EmitRecordWithBlob(ConfigMacroAbbrev, Record, CM);
2568     }
2569 
2570     // Queue up the submodules of this module.
2571     for (auto *M : Mod->submodules())
2572       Q.push(M);
2573   }
2574 
2575   Stream.ExitBlock();
2576 
2577   assert((NextSubmoduleID - FirstSubmoduleID ==
2578           getNumberOfModules(WritingModule)) &&
2579          "Wrong # of submodules; found a reference to a non-local, "
2580          "non-imported submodule?");
2581 }
2582 
2583 serialization::SubmoduleID
2584 ASTWriter::inferSubmoduleIDFromLocation(SourceLocation Loc) {
2585   if (Loc.isInvalid() || !WritingModule)
2586     return 0; // No submodule
2587 
2588   // Find the module that owns this location.
2589   ModuleMap &ModMap = PP->getHeaderSearchInfo().getModuleMap();
2590   Module *OwningMod
2591     = ModMap.inferModuleFromLocation(FullSourceLoc(Loc,PP->getSourceManager()));
2592   if (!OwningMod)
2593     return 0;
2594 
2595   // Check whether this submodule is part of our own module.
2596   if (WritingModule != OwningMod && !OwningMod->isSubModuleOf(WritingModule))
2597     return 0;
2598 
2599   return getSubmoduleID(OwningMod);
2600 }
2601 
2602 void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
2603                                               bool isModule) {
2604   // Make sure set diagnostic pragmas don't affect the translation unit that
2605   // imports the module.
2606   // FIXME: Make diagnostic pragma sections work properly with modules.
2607   if (isModule)
2608     return;
2609 
2610   llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64>
2611       DiagStateIDMap;
2612   unsigned CurrID = 0;
2613   DiagStateIDMap[&Diag.DiagStates.front()] = ++CurrID; // the command-line one.
2614   RecordData Record;
2615   for (DiagnosticsEngine::DiagStatePointsTy::const_iterator
2616          I = Diag.DiagStatePoints.begin(), E = Diag.DiagStatePoints.end();
2617          I != E; ++I) {
2618     const DiagnosticsEngine::DiagStatePoint &point = *I;
2619     if (point.Loc.isInvalid())
2620       continue;
2621 
2622     Record.push_back(point.Loc.getRawEncoding());
2623     unsigned &DiagStateID = DiagStateIDMap[point.State];
2624     Record.push_back(DiagStateID);
2625 
2626     if (DiagStateID == 0) {
2627       DiagStateID = ++CurrID;
2628       for (DiagnosticsEngine::DiagState::const_iterator
2629              I = point.State->begin(), E = point.State->end(); I != E; ++I) {
2630         if (I->second.isPragma()) {
2631           Record.push_back(I->first);
2632           Record.push_back((unsigned)I->second.getSeverity());
2633         }
2634       }
2635       Record.push_back(-1); // mark the end of the diag/map pairs for this
2636                             // location.
2637     }
2638   }
2639 
2640   if (!Record.empty())
2641     Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record);
2642 }
2643 
2644 void ASTWriter::WriteCXXCtorInitializersOffsets() {
2645   if (CXXCtorInitializersOffsets.empty())
2646     return;
2647 
2648   // Create a blob abbreviation for the C++ ctor initializer offsets.
2649   using namespace llvm;
2650 
2651   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2652   Abbrev->Add(BitCodeAbbrevOp(CXX_CTOR_INITIALIZERS_OFFSETS));
2653   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
2654   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2655   unsigned CtorInitializersOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2656 
2657   // Write the base specifier offsets table.
2658   RecordData::value_type Record[] = {CXX_CTOR_INITIALIZERS_OFFSETS,
2659                                      CXXCtorInitializersOffsets.size()};
2660   Stream.EmitRecordWithBlob(CtorInitializersOffsetAbbrev, Record,
2661                             bytes(CXXCtorInitializersOffsets));
2662 }
2663 
2664 void ASTWriter::WriteCXXBaseSpecifiersOffsets() {
2665   if (CXXBaseSpecifiersOffsets.empty())
2666     return;
2667 
2668   // Create a blob abbreviation for the C++ base specifiers offsets.
2669   using namespace llvm;
2670 
2671   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2672   Abbrev->Add(BitCodeAbbrevOp(CXX_BASE_SPECIFIER_OFFSETS));
2673   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
2674   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2675   unsigned BaseSpecifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2676 
2677   // Write the base specifier offsets table.
2678   RecordData::value_type Record[] = {CXX_BASE_SPECIFIER_OFFSETS,
2679                                      CXXBaseSpecifiersOffsets.size()};
2680   Stream.EmitRecordWithBlob(BaseSpecifierOffsetAbbrev, Record,
2681                             bytes(CXXBaseSpecifiersOffsets));
2682 }
2683 
2684 //===----------------------------------------------------------------------===//
2685 // Type Serialization
2686 //===----------------------------------------------------------------------===//
2687 
2688 /// \brief Write the representation of a type to the AST stream.
2689 void ASTWriter::WriteType(QualType T) {
2690   TypeIdx &Idx = TypeIdxs[T];
2691   if (Idx.getIndex() == 0) // we haven't seen this type before.
2692     Idx = TypeIdx(NextTypeID++);
2693 
2694   assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
2695 
2696   // Record the offset for this type.
2697   unsigned Index = Idx.getIndex() - FirstTypeID;
2698   if (TypeOffsets.size() == Index)
2699     TypeOffsets.push_back(Stream.GetCurrentBitNo());
2700   else if (TypeOffsets.size() < Index) {
2701     TypeOffsets.resize(Index + 1);
2702     TypeOffsets[Index] = Stream.GetCurrentBitNo();
2703   }
2704 
2705   RecordData Record;
2706 
2707   // Emit the type's representation.
2708   ASTTypeWriter W(*this, Record);
2709   W.AbbrevToUse = 0;
2710 
2711   if (T.hasLocalNonFastQualifiers()) {
2712     Qualifiers Qs = T.getLocalQualifiers();
2713     AddTypeRef(T.getLocalUnqualifiedType(), Record);
2714     Record.push_back(Qs.getAsOpaqueValue());
2715     W.Code = TYPE_EXT_QUAL;
2716     W.AbbrevToUse = TypeExtQualAbbrev;
2717   } else {
2718     switch (T->getTypeClass()) {
2719       // For all of the concrete, non-dependent types, call the
2720       // appropriate visitor function.
2721 #define TYPE(Class, Base) \
2722     case Type::Class: W.Visit##Class##Type(cast<Class##Type>(T)); break;
2723 #define ABSTRACT_TYPE(Class, Base)
2724 #include "clang/AST/TypeNodes.def"
2725     }
2726   }
2727 
2728   // Emit the serialized record.
2729   Stream.EmitRecord(W.Code, Record, W.AbbrevToUse);
2730 
2731   // Flush any expressions that were written as part of this type.
2732   FlushStmts();
2733 }
2734 
2735 //===----------------------------------------------------------------------===//
2736 // Declaration Serialization
2737 //===----------------------------------------------------------------------===//
2738 
2739 /// \brief Write the block containing all of the declaration IDs
2740 /// lexically declared within the given DeclContext.
2741 ///
2742 /// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
2743 /// bistream, or 0 if no block was written.
2744 uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
2745                                                  DeclContext *DC) {
2746   if (DC->decls_empty())
2747     return 0;
2748 
2749   uint64_t Offset = Stream.GetCurrentBitNo();
2750   SmallVector<uint32_t, 128> KindDeclPairs;
2751   for (const auto *D : DC->decls()) {
2752     KindDeclPairs.push_back(D->getKind());
2753     KindDeclPairs.push_back(GetDeclRef(D));
2754   }
2755 
2756   ++NumLexicalDeclContexts;
2757   RecordData::value_type Record[] = {DECL_CONTEXT_LEXICAL};
2758   Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record,
2759                             bytes(KindDeclPairs));
2760   return Offset;
2761 }
2762 
2763 void ASTWriter::WriteTypeDeclOffsets() {
2764   using namespace llvm;
2765 
2766   // Write the type offsets array
2767   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2768   Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
2769   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
2770   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index
2771   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
2772   unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2773   {
2774     RecordData::value_type Record[] = {TYPE_OFFSET, TypeOffsets.size(),
2775                                        FirstTypeID - NUM_PREDEF_TYPE_IDS};
2776     Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, bytes(TypeOffsets));
2777   }
2778 
2779   // Write the declaration offsets array
2780   Abbrev = new BitCodeAbbrev();
2781   Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
2782   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
2783   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID
2784   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
2785   unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2786   {
2787     RecordData::value_type Record[] = {DECL_OFFSET, DeclOffsets.size(),
2788                                        FirstDeclID - NUM_PREDEF_DECL_IDS};
2789     Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, bytes(DeclOffsets));
2790   }
2791 }
2792 
2793 void ASTWriter::WriteFileDeclIDsMap() {
2794   using namespace llvm;
2795 
2796   SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs(
2797       FileDeclIDs.begin(), FileDeclIDs.end());
2798   std::sort(SortedFileDeclIDs.begin(), SortedFileDeclIDs.end(),
2799             llvm::less_first());
2800 
2801   // Join the vectors of DeclIDs from all files.
2802   SmallVector<DeclID, 256> FileGroupedDeclIDs;
2803   for (auto &FileDeclEntry : SortedFileDeclIDs) {
2804     DeclIDInFileInfo &Info = *FileDeclEntry.second;
2805     Info.FirstDeclIndex = FileGroupedDeclIDs.size();
2806     for (auto &LocDeclEntry : Info.DeclIDs)
2807       FileGroupedDeclIDs.push_back(LocDeclEntry.second);
2808   }
2809 
2810   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2811   Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
2812   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2813   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2814   unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
2815   RecordData::value_type Record[] = {FILE_SORTED_DECLS,
2816                                      FileGroupedDeclIDs.size()};
2817   Stream.EmitRecordWithBlob(AbbrevCode, Record, bytes(FileGroupedDeclIDs));
2818 }
2819 
2820 void ASTWriter::WriteComments() {
2821   Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3);
2822   ArrayRef<RawComment *> RawComments = Context->Comments.getComments();
2823   RecordData Record;
2824   for (ArrayRef<RawComment *>::iterator I = RawComments.begin(),
2825                                         E = RawComments.end();
2826        I != E; ++I) {
2827     Record.clear();
2828     AddSourceRange((*I)->getSourceRange(), Record);
2829     Record.push_back((*I)->getKind());
2830     Record.push_back((*I)->isTrailingComment());
2831     Record.push_back((*I)->isAlmostTrailingComment());
2832     Stream.EmitRecord(COMMENTS_RAW_COMMENT, Record);
2833   }
2834   Stream.ExitBlock();
2835 }
2836 
2837 //===----------------------------------------------------------------------===//
2838 // Global Method Pool and Selector Serialization
2839 //===----------------------------------------------------------------------===//
2840 
2841 namespace {
2842 // Trait used for the on-disk hash table used in the method pool.
2843 class ASTMethodPoolTrait {
2844   ASTWriter &Writer;
2845 
2846 public:
2847   typedef Selector key_type;
2848   typedef key_type key_type_ref;
2849 
2850   struct data_type {
2851     SelectorID ID;
2852     ObjCMethodList Instance, Factory;
2853   };
2854   typedef const data_type& data_type_ref;
2855 
2856   typedef unsigned hash_value_type;
2857   typedef unsigned offset_type;
2858 
2859   explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) { }
2860 
2861   static hash_value_type ComputeHash(Selector Sel) {
2862     return serialization::ComputeHash(Sel);
2863   }
2864 
2865   std::pair<unsigned,unsigned>
2866     EmitKeyDataLength(raw_ostream& Out, Selector Sel,
2867                       data_type_ref Methods) {
2868     using namespace llvm::support;
2869     endian::Writer<little> LE(Out);
2870     unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
2871     LE.write<uint16_t>(KeyLen);
2872     unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
2873     for (const ObjCMethodList *Method = &Methods.Instance; Method;
2874          Method = Method->getNext())
2875       if (Method->getMethod())
2876         DataLen += 4;
2877     for (const ObjCMethodList *Method = &Methods.Factory; Method;
2878          Method = Method->getNext())
2879       if (Method->getMethod())
2880         DataLen += 4;
2881     LE.write<uint16_t>(DataLen);
2882     return std::make_pair(KeyLen, DataLen);
2883   }
2884 
2885   void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
2886     using namespace llvm::support;
2887     endian::Writer<little> LE(Out);
2888     uint64_t Start = Out.tell();
2889     assert((Start >> 32) == 0 && "Selector key offset too large");
2890     Writer.SetSelectorOffset(Sel, Start);
2891     unsigned N = Sel.getNumArgs();
2892     LE.write<uint16_t>(N);
2893     if (N == 0)
2894       N = 1;
2895     for (unsigned I = 0; I != N; ++I)
2896       LE.write<uint32_t>(
2897           Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
2898   }
2899 
2900   void EmitData(raw_ostream& Out, key_type_ref,
2901                 data_type_ref Methods, unsigned DataLen) {
2902     using namespace llvm::support;
2903     endian::Writer<little> LE(Out);
2904     uint64_t Start = Out.tell(); (void)Start;
2905     LE.write<uint32_t>(Methods.ID);
2906     unsigned NumInstanceMethods = 0;
2907     for (const ObjCMethodList *Method = &Methods.Instance; Method;
2908          Method = Method->getNext())
2909       if (Method->getMethod())
2910         ++NumInstanceMethods;
2911 
2912     unsigned NumFactoryMethods = 0;
2913     for (const ObjCMethodList *Method = &Methods.Factory; Method;
2914          Method = Method->getNext())
2915       if (Method->getMethod())
2916         ++NumFactoryMethods;
2917 
2918     unsigned InstanceBits = Methods.Instance.getBits();
2919     assert(InstanceBits < 4);
2920     unsigned InstanceHasMoreThanOneDeclBit =
2921         Methods.Instance.hasMoreThanOneDecl();
2922     unsigned FullInstanceBits = (NumInstanceMethods << 3) |
2923                                 (InstanceHasMoreThanOneDeclBit << 2) |
2924                                 InstanceBits;
2925     unsigned FactoryBits = Methods.Factory.getBits();
2926     assert(FactoryBits < 4);
2927     unsigned FactoryHasMoreThanOneDeclBit =
2928         Methods.Factory.hasMoreThanOneDecl();
2929     unsigned FullFactoryBits = (NumFactoryMethods << 3) |
2930                                (FactoryHasMoreThanOneDeclBit << 2) |
2931                                FactoryBits;
2932     LE.write<uint16_t>(FullInstanceBits);
2933     LE.write<uint16_t>(FullFactoryBits);
2934     for (const ObjCMethodList *Method = &Methods.Instance; Method;
2935          Method = Method->getNext())
2936       if (Method->getMethod())
2937         LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
2938     for (const ObjCMethodList *Method = &Methods.Factory; Method;
2939          Method = Method->getNext())
2940       if (Method->getMethod())
2941         LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
2942 
2943     assert(Out.tell() - Start == DataLen && "Data length is wrong");
2944   }
2945 };
2946 } // end anonymous namespace
2947 
2948 /// \brief Write ObjC data: selectors and the method pool.
2949 ///
2950 /// The method pool contains both instance and factory methods, stored
2951 /// in an on-disk hash table indexed by the selector. The hash table also
2952 /// contains an empty entry for every other selector known to Sema.
2953 void ASTWriter::WriteSelectors(Sema &SemaRef) {
2954   using namespace llvm;
2955 
2956   // Do we have to do anything at all?
2957   if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
2958     return;
2959   unsigned NumTableEntries = 0;
2960   // Create and write out the blob that contains selectors and the method pool.
2961   {
2962     llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
2963     ASTMethodPoolTrait Trait(*this);
2964 
2965     // Create the on-disk hash table representation. We walk through every
2966     // selector we've seen and look it up in the method pool.
2967     SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
2968     for (auto &SelectorAndID : SelectorIDs) {
2969       Selector S = SelectorAndID.first;
2970       SelectorID ID = SelectorAndID.second;
2971       Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
2972       ASTMethodPoolTrait::data_type Data = {
2973         ID,
2974         ObjCMethodList(),
2975         ObjCMethodList()
2976       };
2977       if (F != SemaRef.MethodPool.end()) {
2978         Data.Instance = F->second.first;
2979         Data.Factory = F->second.second;
2980       }
2981       // Only write this selector if it's not in an existing AST or something
2982       // changed.
2983       if (Chain && ID < FirstSelectorID) {
2984         // Selector already exists. Did it change?
2985         bool changed = false;
2986         for (ObjCMethodList *M = &Data.Instance;
2987              !changed && M && M->getMethod(); M = M->getNext()) {
2988           if (!M->getMethod()->isFromASTFile())
2989             changed = true;
2990         }
2991         for (ObjCMethodList *M = &Data.Factory; !changed && M && M->getMethod();
2992              M = M->getNext()) {
2993           if (!M->getMethod()->isFromASTFile())
2994             changed = true;
2995         }
2996         if (!changed)
2997           continue;
2998       } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) {
2999         // A new method pool entry.
3000         ++NumTableEntries;
3001       }
3002       Generator.insert(S, Data, Trait);
3003     }
3004 
3005     // Create the on-disk hash table in a buffer.
3006     SmallString<4096> MethodPool;
3007     uint32_t BucketOffset;
3008     {
3009       using namespace llvm::support;
3010       ASTMethodPoolTrait Trait(*this);
3011       llvm::raw_svector_ostream Out(MethodPool);
3012       // Make sure that no bucket is at offset 0
3013       endian::Writer<little>(Out).write<uint32_t>(0);
3014       BucketOffset = Generator.Emit(Out, Trait);
3015     }
3016 
3017     // Create a blob abbreviation
3018     BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
3019     Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
3020     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
3021     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
3022     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3023     unsigned MethodPoolAbbrev = Stream.EmitAbbrev(Abbrev);
3024 
3025     // Write the method pool
3026     {
3027       RecordData::value_type Record[] = {METHOD_POOL, BucketOffset,
3028                                          NumTableEntries};
3029       Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool);
3030     }
3031 
3032     // Create a blob abbreviation for the selector table offsets.
3033     Abbrev = new BitCodeAbbrev();
3034     Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
3035     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
3036     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
3037     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3038     unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
3039 
3040     // Write the selector offsets table.
3041     {
3042       RecordData::value_type Record[] = {
3043           SELECTOR_OFFSETS, SelectorOffsets.size(),
3044           FirstSelectorID - NUM_PREDEF_SELECTOR_IDS};
3045       Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
3046                                 bytes(SelectorOffsets));
3047     }
3048   }
3049 }
3050 
3051 /// \brief Write the selectors referenced in @selector expression into AST file.
3052 void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
3053   using namespace llvm;
3054   if (SemaRef.ReferencedSelectors.empty())
3055     return;
3056 
3057   RecordData Record;
3058 
3059   // Note: this writes out all references even for a dependent AST. But it is
3060   // very tricky to fix, and given that @selector shouldn't really appear in
3061   // headers, probably not worth it. It's not a correctness issue.
3062   for (auto &SelectorAndLocation : SemaRef.ReferencedSelectors) {
3063     Selector Sel = SelectorAndLocation.first;
3064     SourceLocation Loc = SelectorAndLocation.second;
3065     AddSelectorRef(Sel, Record);
3066     AddSourceLocation(Loc, Record);
3067   }
3068   Stream.EmitRecord(REFERENCED_SELECTOR_POOL, Record);
3069 }
3070 
3071 //===----------------------------------------------------------------------===//
3072 // Identifier Table Serialization
3073 //===----------------------------------------------------------------------===//
3074 
3075 /// Determine the declaration that should be put into the name lookup table to
3076 /// represent the given declaration in this module. This is usually D itself,
3077 /// but if D was imported and merged into a local declaration, we want the most
3078 /// recent local declaration instead. The chosen declaration will be the most
3079 /// recent declaration in any module that imports this one.
3080 static NamedDecl *getDeclForLocalLookup(const LangOptions &LangOpts,
3081                                         NamedDecl *D) {
3082   if (!LangOpts.Modules || !D->isFromASTFile())
3083     return D;
3084 
3085   if (Decl *Redecl = D->getPreviousDecl()) {
3086     // For Redeclarable decls, a prior declaration might be local.
3087     for (; Redecl; Redecl = Redecl->getPreviousDecl()) {
3088       if (!Redecl->isFromASTFile())
3089         return cast<NamedDecl>(Redecl);
3090       // If we find a decl from a (chained-)PCH stop since we won't find a
3091       // local one.
3092       if (D->getOwningModuleID() == 0)
3093         break;
3094     }
3095   } else if (Decl *First = D->getCanonicalDecl()) {
3096     // For Mergeable decls, the first decl might be local.
3097     if (!First->isFromASTFile())
3098       return cast<NamedDecl>(First);
3099   }
3100 
3101   // All declarations are imported. Our most recent declaration will also be
3102   // the most recent one in anyone who imports us.
3103   return D;
3104 }
3105 
3106 namespace {
3107 class ASTIdentifierTableTrait {
3108   ASTWriter &Writer;
3109   Preprocessor &PP;
3110   IdentifierResolver &IdResolver;
3111   bool IsModule;
3112   bool NeedDecls;
3113   ASTWriter::RecordData *InterestingIdentifierOffsets;
3114 
3115   /// \brief Determines whether this is an "interesting" identifier that needs a
3116   /// full IdentifierInfo structure written into the hash table. Notably, this
3117   /// doesn't check whether the name has macros defined; use PublicMacroIterator
3118   /// to check that.
3119   bool isInterestingIdentifier(const IdentifierInfo *II, uint64_t MacroOffset) {
3120     if (MacroOffset ||
3121         II->isPoisoned() ||
3122         (IsModule ? II->hasRevertedBuiltin() : II->getObjCOrBuiltinID()) ||
3123         II->hasRevertedTokenIDToIdentifier() ||
3124         (NeedDecls && II->getFETokenInfo<void>()))
3125       return true;
3126 
3127     return false;
3128   }
3129 
3130 public:
3131   typedef IdentifierInfo* key_type;
3132   typedef key_type  key_type_ref;
3133 
3134   typedef IdentID data_type;
3135   typedef data_type data_type_ref;
3136 
3137   typedef unsigned hash_value_type;
3138   typedef unsigned offset_type;
3139 
3140   ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
3141                           IdentifierResolver &IdResolver, bool IsModule,
3142                           ASTWriter::RecordData *InterestingIdentifierOffsets)
3143       : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule),
3144         NeedDecls(!IsModule || !Writer.getLangOpts().CPlusPlus),
3145         InterestingIdentifierOffsets(InterestingIdentifierOffsets) {}
3146 
3147   static hash_value_type ComputeHash(const IdentifierInfo* II) {
3148     return llvm::HashString(II->getName());
3149   }
3150 
3151   bool isInterestingIdentifier(const IdentifierInfo *II) {
3152     auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3153     return isInterestingIdentifier(II, MacroOffset);
3154   }
3155   bool isInterestingNonMacroIdentifier(const IdentifierInfo *II) {
3156     return isInterestingIdentifier(II, 0);
3157   }
3158 
3159   std::pair<unsigned,unsigned>
3160   EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) {
3161     unsigned KeyLen = II->getLength() + 1;
3162     unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
3163     auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3164     if (isInterestingIdentifier(II, MacroOffset)) {
3165       DataLen += 2; // 2 bytes for builtin ID
3166       DataLen += 2; // 2 bytes for flags
3167       if (MacroOffset)
3168         DataLen += 4; // MacroDirectives offset.
3169 
3170       if (NeedDecls) {
3171         for (IdentifierResolver::iterator D = IdResolver.begin(II),
3172                                        DEnd = IdResolver.end();
3173              D != DEnd; ++D)
3174           DataLen += 4;
3175       }
3176     }
3177     using namespace llvm::support;
3178     endian::Writer<little> LE(Out);
3179 
3180     assert((uint16_t)DataLen == DataLen && (uint16_t)KeyLen == KeyLen);
3181     LE.write<uint16_t>(DataLen);
3182     // We emit the key length after the data length so that every
3183     // string is preceded by a 16-bit length. This matches the PTH
3184     // format for storing identifiers.
3185     LE.write<uint16_t>(KeyLen);
3186     return std::make_pair(KeyLen, DataLen);
3187   }
3188 
3189   void EmitKey(raw_ostream& Out, const IdentifierInfo* II,
3190                unsigned KeyLen) {
3191     // Record the location of the key data.  This is used when generating
3192     // the mapping from persistent IDs to strings.
3193     Writer.SetIdentifierOffset(II, Out.tell());
3194 
3195     // Emit the offset of the key/data length information to the interesting
3196     // identifiers table if necessary.
3197     if (InterestingIdentifierOffsets && isInterestingIdentifier(II))
3198       InterestingIdentifierOffsets->push_back(Out.tell() - 4);
3199 
3200     Out.write(II->getNameStart(), KeyLen);
3201   }
3202 
3203   void EmitData(raw_ostream& Out, IdentifierInfo* II,
3204                 IdentID ID, unsigned) {
3205     using namespace llvm::support;
3206     endian::Writer<little> LE(Out);
3207 
3208     auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3209     if (!isInterestingIdentifier(II, MacroOffset)) {
3210       LE.write<uint32_t>(ID << 1);
3211       return;
3212     }
3213 
3214     LE.write<uint32_t>((ID << 1) | 0x01);
3215     uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID();
3216     assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
3217     LE.write<uint16_t>(Bits);
3218     Bits = 0;
3219     bool HadMacroDefinition = MacroOffset != 0;
3220     Bits = (Bits << 1) | unsigned(HadMacroDefinition);
3221     Bits = (Bits << 1) | unsigned(II->isExtensionToken());
3222     Bits = (Bits << 1) | unsigned(II->isPoisoned());
3223     Bits = (Bits << 1) | unsigned(II->hasRevertedBuiltin());
3224     Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
3225     Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
3226     LE.write<uint16_t>(Bits);
3227 
3228     if (HadMacroDefinition)
3229       LE.write<uint32_t>(MacroOffset);
3230 
3231     if (NeedDecls) {
3232       // Emit the declaration IDs in reverse order, because the
3233       // IdentifierResolver provides the declarations as they would be
3234       // visible (e.g., the function "stat" would come before the struct
3235       // "stat"), but the ASTReader adds declarations to the end of the list
3236       // (so we need to see the struct "stat" before the function "stat").
3237       // Only emit declarations that aren't from a chained PCH, though.
3238       SmallVector<NamedDecl *, 16> Decls(IdResolver.begin(II),
3239                                          IdResolver.end());
3240       for (SmallVectorImpl<NamedDecl *>::reverse_iterator D = Decls.rbegin(),
3241                                                           DEnd = Decls.rend();
3242            D != DEnd; ++D)
3243         LE.write<uint32_t>(
3244             Writer.getDeclID(getDeclForLocalLookup(PP.getLangOpts(), *D)));
3245     }
3246   }
3247 };
3248 } // end anonymous namespace
3249 
3250 /// \brief Write the identifier table into the AST file.
3251 ///
3252 /// The identifier table consists of a blob containing string data
3253 /// (the actual identifiers themselves) and a separate "offsets" index
3254 /// that maps identifier IDs to locations within the blob.
3255 void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
3256                                      IdentifierResolver &IdResolver,
3257                                      bool IsModule) {
3258   using namespace llvm;
3259 
3260   RecordData InterestingIdents;
3261 
3262   // Create and write out the blob that contains the identifier
3263   // strings.
3264   {
3265     llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
3266     ASTIdentifierTableTrait Trait(
3267         *this, PP, IdResolver, IsModule,
3268         (getLangOpts().CPlusPlus && IsModule) ? &InterestingIdents : nullptr);
3269 
3270     // Look for any identifiers that were named while processing the
3271     // headers, but are otherwise not needed. We add these to the hash
3272     // table to enable checking of the predefines buffer in the case
3273     // where the user adds new macro definitions when building the AST
3274     // file.
3275     SmallVector<const IdentifierInfo *, 128> IIs;
3276     for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
3277                                 IDEnd = PP.getIdentifierTable().end();
3278          ID != IDEnd; ++ID)
3279       IIs.push_back(ID->second);
3280     // Sort the identifiers lexicographically before getting them references so
3281     // that their order is stable.
3282     std::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>());
3283     for (const IdentifierInfo *II : IIs)
3284       if (Trait.isInterestingNonMacroIdentifier(II))
3285         getIdentifierRef(II);
3286 
3287     // Create the on-disk hash table representation. We only store offsets
3288     // for identifiers that appear here for the first time.
3289     IdentifierOffsets.resize(NextIdentID - FirstIdentID);
3290     for (auto IdentIDPair : IdentifierIDs) {
3291       IdentifierInfo *II = const_cast<IdentifierInfo *>(IdentIDPair.first);
3292       IdentID ID = IdentIDPair.second;
3293       assert(II && "NULL identifier in identifier table");
3294       if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
3295         Generator.insert(II, ID, Trait);
3296     }
3297 
3298     // Create the on-disk hash table in a buffer.
3299     SmallString<4096> IdentifierTable;
3300     uint32_t BucketOffset;
3301     {
3302       using namespace llvm::support;
3303       llvm::raw_svector_ostream Out(IdentifierTable);
3304       // Make sure that no bucket is at offset 0
3305       endian::Writer<little>(Out).write<uint32_t>(0);
3306       BucketOffset = Generator.Emit(Out, Trait);
3307     }
3308 
3309     // Create a blob abbreviation
3310     BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
3311     Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
3312     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
3313     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3314     unsigned IDTableAbbrev = Stream.EmitAbbrev(Abbrev);
3315 
3316     // Write the identifier table
3317     RecordData::value_type Record[] = {IDENTIFIER_TABLE, BucketOffset};
3318     Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable);
3319   }
3320 
3321   // Write the offsets table for identifier IDs.
3322   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
3323   Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
3324   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
3325   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
3326   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3327   unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
3328 
3329 #ifndef NDEBUG
3330   for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I)
3331     assert(IdentifierOffsets[I] && "Missing identifier offset?");
3332 #endif
3333 
3334   RecordData::value_type Record[] = {IDENTIFIER_OFFSET,
3335                                      IdentifierOffsets.size(),
3336                                      FirstIdentID - NUM_PREDEF_IDENT_IDS};
3337   Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
3338                             bytes(IdentifierOffsets));
3339 
3340   // In C++, write the list of interesting identifiers (those that are
3341   // defined as macros, poisoned, or similar unusual things).
3342   if (!InterestingIdents.empty())
3343     Stream.EmitRecord(INTERESTING_IDENTIFIERS, InterestingIdents);
3344 }
3345 
3346 //===----------------------------------------------------------------------===//
3347 // DeclContext's Name Lookup Table Serialization
3348 //===----------------------------------------------------------------------===//
3349 
3350 namespace {
3351 // Trait used for the on-disk hash table used in the method pool.
3352 class ASTDeclContextNameLookupTrait {
3353   ASTWriter &Writer;
3354   llvm::SmallVector<DeclID, 64> DeclIDs;
3355 
3356 public:
3357   typedef DeclarationNameKey key_type;
3358   typedef key_type key_type_ref;
3359 
3360   /// A start and end index into DeclIDs, representing a sequence of decls.
3361   typedef std::pair<unsigned, unsigned> data_type;
3362   typedef const data_type& data_type_ref;
3363 
3364   typedef unsigned hash_value_type;
3365   typedef unsigned offset_type;
3366 
3367   explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) { }
3368 
3369   template<typename Coll>
3370   data_type getData(const Coll &Decls) {
3371     unsigned Start = DeclIDs.size();
3372     for (NamedDecl *D : Decls) {
3373       DeclIDs.push_back(
3374           Writer.GetDeclRef(getDeclForLocalLookup(Writer.getLangOpts(), D)));
3375     }
3376     return std::make_pair(Start, DeclIDs.size());
3377   }
3378 
3379   data_type ImportData(const reader::ASTDeclContextNameLookupTrait::data_type &FromReader) {
3380     unsigned Start = DeclIDs.size();
3381     for (auto ID : FromReader)
3382       DeclIDs.push_back(ID);
3383     return std::make_pair(Start, DeclIDs.size());
3384   }
3385 
3386   static bool EqualKey(key_type_ref a, key_type_ref b) {
3387     return a == b;
3388   }
3389 
3390   hash_value_type ComputeHash(DeclarationNameKey Name) {
3391     return Name.getHash();
3392   }
3393 
3394   void EmitFileRef(raw_ostream &Out, ModuleFile *F) const {
3395     assert(Writer.hasChain() &&
3396            "have reference to loaded module file but no chain?");
3397 
3398     using namespace llvm::support;
3399     endian::Writer<little>(Out)
3400         .write<uint32_t>(Writer.getChain()->getModuleFileID(F));
3401   }
3402 
3403   std::pair<unsigned, unsigned> EmitKeyDataLength(raw_ostream &Out,
3404                                                   DeclarationNameKey Name,
3405                                                   data_type_ref Lookup) {
3406     using namespace llvm::support;
3407     endian::Writer<little> LE(Out);
3408     unsigned KeyLen = 1;
3409     switch (Name.getKind()) {
3410     case DeclarationName::Identifier:
3411     case DeclarationName::ObjCZeroArgSelector:
3412     case DeclarationName::ObjCOneArgSelector:
3413     case DeclarationName::ObjCMultiArgSelector:
3414     case DeclarationName::CXXLiteralOperatorName:
3415       KeyLen += 4;
3416       break;
3417     case DeclarationName::CXXOperatorName:
3418       KeyLen += 1;
3419       break;
3420     case DeclarationName::CXXConstructorName:
3421     case DeclarationName::CXXDestructorName:
3422     case DeclarationName::CXXConversionFunctionName:
3423     case DeclarationName::CXXUsingDirective:
3424       break;
3425     }
3426     LE.write<uint16_t>(KeyLen);
3427 
3428     // 4 bytes for each DeclID.
3429     unsigned DataLen = 4 * (Lookup.second - Lookup.first);
3430     assert(uint16_t(DataLen) == DataLen &&
3431            "too many decls for serialized lookup result");
3432     LE.write<uint16_t>(DataLen);
3433 
3434     return std::make_pair(KeyLen, DataLen);
3435   }
3436 
3437   void EmitKey(raw_ostream &Out, DeclarationNameKey Name, unsigned) {
3438     using namespace llvm::support;
3439     endian::Writer<little> LE(Out);
3440     LE.write<uint8_t>(Name.getKind());
3441     switch (Name.getKind()) {
3442     case DeclarationName::Identifier:
3443     case DeclarationName::CXXLiteralOperatorName:
3444       LE.write<uint32_t>(Writer.getIdentifierRef(Name.getIdentifier()));
3445       return;
3446     case DeclarationName::ObjCZeroArgSelector:
3447     case DeclarationName::ObjCOneArgSelector:
3448     case DeclarationName::ObjCMultiArgSelector:
3449       LE.write<uint32_t>(Writer.getSelectorRef(Name.getSelector()));
3450       return;
3451     case DeclarationName::CXXOperatorName:
3452       assert(Name.getOperatorKind() < NUM_OVERLOADED_OPERATORS &&
3453              "Invalid operator?");
3454       LE.write<uint8_t>(Name.getOperatorKind());
3455       return;
3456     case DeclarationName::CXXConstructorName:
3457     case DeclarationName::CXXDestructorName:
3458     case DeclarationName::CXXConversionFunctionName:
3459     case DeclarationName::CXXUsingDirective:
3460       return;
3461     }
3462 
3463     llvm_unreachable("Invalid name kind?");
3464   }
3465 
3466   void EmitData(raw_ostream &Out, key_type_ref, data_type Lookup,
3467                 unsigned DataLen) {
3468     using namespace llvm::support;
3469     endian::Writer<little> LE(Out);
3470     uint64_t Start = Out.tell(); (void)Start;
3471     for (unsigned I = Lookup.first, N = Lookup.second; I != N; ++I)
3472       LE.write<uint32_t>(DeclIDs[I]);
3473     assert(Out.tell() - Start == DataLen && "Data length is wrong");
3474   }
3475 };
3476 } // end anonymous namespace
3477 
3478 bool ASTWriter::isLookupResultExternal(StoredDeclsList &Result,
3479                                        DeclContext *DC) {
3480   return Result.hasExternalDecls() && DC->NeedToReconcileExternalVisibleStorage;
3481 }
3482 
3483 bool ASTWriter::isLookupResultEntirelyExternal(StoredDeclsList &Result,
3484                                                DeclContext *DC) {
3485   for (auto *D : Result.getLookupResult())
3486     if (!getDeclForLocalLookup(getLangOpts(), D)->isFromASTFile())
3487       return false;
3488 
3489   return true;
3490 }
3491 
3492 void
3493 ASTWriter::GenerateNameLookupTable(const DeclContext *ConstDC,
3494                                    llvm::SmallVectorImpl<char> &LookupTable) {
3495   assert(!ConstDC->HasLazyLocalLexicalLookups &&
3496          !ConstDC->HasLazyExternalLexicalLookups &&
3497          "must call buildLookups first");
3498 
3499   // FIXME: We need to build the lookups table, which is logically const.
3500   DeclContext *DC = const_cast<DeclContext*>(ConstDC);
3501   assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
3502 
3503   // Create the on-disk hash table representation.
3504   MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait,
3505                                 ASTDeclContextNameLookupTrait> Generator;
3506   ASTDeclContextNameLookupTrait Trait(*this);
3507 
3508   // The first step is to collect the declaration names which we need to
3509   // serialize into the name lookup table, and to collect them in a stable
3510   // order.
3511   SmallVector<DeclarationName, 16> Names;
3512 
3513   // We also build up small sets of the constructor and conversion function
3514   // names which are visible.
3515   llvm::SmallSet<DeclarationName, 8> ConstructorNameSet, ConversionNameSet;
3516 
3517   for (auto &Lookup : *DC->buildLookup()) {
3518     auto &Name = Lookup.first;
3519     auto &Result = Lookup.second;
3520 
3521     // If there are no local declarations in our lookup result, we
3522     // don't need to write an entry for the name at all. If we can't
3523     // write out a lookup set without performing more deserialization,
3524     // just skip this entry.
3525     if (isLookupResultExternal(Result, DC) &&
3526         isLookupResultEntirelyExternal(Result, DC))
3527       continue;
3528 
3529     // We also skip empty results. If any of the results could be external and
3530     // the currently available results are empty, then all of the results are
3531     // external and we skip it above. So the only way we get here with an empty
3532     // results is when no results could have been external *and* we have
3533     // external results.
3534     //
3535     // FIXME: While we might want to start emitting on-disk entries for negative
3536     // lookups into a decl context as an optimization, today we *have* to skip
3537     // them because there are names with empty lookup results in decl contexts
3538     // which we can't emit in any stable ordering: we lookup constructors and
3539     // conversion functions in the enclosing namespace scope creating empty
3540     // results for them. This in almost certainly a bug in Clang's name lookup,
3541     // but that is likely to be hard or impossible to fix and so we tolerate it
3542     // here by omitting lookups with empty results.
3543     if (Lookup.second.getLookupResult().empty())
3544       continue;
3545 
3546     switch (Lookup.first.getNameKind()) {
3547     default:
3548       Names.push_back(Lookup.first);
3549       break;
3550 
3551     case DeclarationName::CXXConstructorName:
3552       assert(isa<CXXRecordDecl>(DC) &&
3553              "Cannot have a constructor name outside of a class!");
3554       ConstructorNameSet.insert(Name);
3555       break;
3556 
3557     case DeclarationName::CXXConversionFunctionName:
3558       assert(isa<CXXRecordDecl>(DC) &&
3559              "Cannot have a conversion function name outside of a class!");
3560       ConversionNameSet.insert(Name);
3561       break;
3562     }
3563   }
3564 
3565   // Sort the names into a stable order.
3566   std::sort(Names.begin(), Names.end());
3567 
3568   if (auto *D = dyn_cast<CXXRecordDecl>(DC)) {
3569     // We need to establish an ordering of constructor and conversion function
3570     // names, and they don't have an intrinsic ordering.
3571 
3572     // First we try the easy case by forming the current context's constructor
3573     // name and adding that name first. This is a very useful optimization to
3574     // avoid walking the lexical declarations in many cases, and it also
3575     // handles the only case where a constructor name can come from some other
3576     // lexical context -- when that name is an implicit constructor merged from
3577     // another declaration in the redecl chain. Any non-implicit constructor or
3578     // conversion function which doesn't occur in all the lexical contexts
3579     // would be an ODR violation.
3580     auto ImplicitCtorName = Context->DeclarationNames.getCXXConstructorName(
3581         Context->getCanonicalType(Context->getRecordType(D)));
3582     if (ConstructorNameSet.erase(ImplicitCtorName))
3583       Names.push_back(ImplicitCtorName);
3584 
3585     // If we still have constructors or conversion functions, we walk all the
3586     // names in the decl and add the constructors and conversion functions
3587     // which are visible in the order they lexically occur within the context.
3588     if (!ConstructorNameSet.empty() || !ConversionNameSet.empty())
3589       for (Decl *ChildD : cast<CXXRecordDecl>(DC)->decls())
3590         if (auto *ChildND = dyn_cast<NamedDecl>(ChildD)) {
3591           auto Name = ChildND->getDeclName();
3592           switch (Name.getNameKind()) {
3593           default:
3594             continue;
3595 
3596           case DeclarationName::CXXConstructorName:
3597             if (ConstructorNameSet.erase(Name))
3598               Names.push_back(Name);
3599             break;
3600 
3601           case DeclarationName::CXXConversionFunctionName:
3602             if (ConversionNameSet.erase(Name))
3603               Names.push_back(Name);
3604             break;
3605           }
3606 
3607           if (ConstructorNameSet.empty() && ConversionNameSet.empty())
3608             break;
3609         }
3610 
3611     assert(ConstructorNameSet.empty() && "Failed to find all of the visible "
3612                                          "constructors by walking all the "
3613                                          "lexical members of the context.");
3614     assert(ConversionNameSet.empty() && "Failed to find all of the visible "
3615                                         "conversion functions by walking all "
3616                                         "the lexical members of the context.");
3617   }
3618 
3619   // Next we need to do a lookup with each name into this decl context to fully
3620   // populate any results from external sources. We don't actually use the
3621   // results of these lookups because we only want to use the results after all
3622   // results have been loaded and the pointers into them will be stable.
3623   for (auto &Name : Names)
3624     DC->lookup(Name);
3625 
3626   // Now we need to insert the results for each name into the hash table. For
3627   // constructor names and conversion function names, we actually need to merge
3628   // all of the results for them into one list of results each and insert
3629   // those.
3630   SmallVector<NamedDecl *, 8> ConstructorDecls;
3631   SmallVector<NamedDecl *, 8> ConversionDecls;
3632 
3633   // Now loop over the names, either inserting them or appending for the two
3634   // special cases.
3635   for (auto &Name : Names) {
3636     DeclContext::lookup_result Result = DC->noload_lookup(Name);
3637 
3638     switch (Name.getNameKind()) {
3639     default:
3640       Generator.insert(Name, Trait.getData(Result), Trait);
3641       break;
3642 
3643     case DeclarationName::CXXConstructorName:
3644       ConstructorDecls.append(Result.begin(), Result.end());
3645       break;
3646 
3647     case DeclarationName::CXXConversionFunctionName:
3648       ConversionDecls.append(Result.begin(), Result.end());
3649       break;
3650     }
3651   }
3652 
3653   // Handle our two special cases if we ended up having any. We arbitrarily use
3654   // the first declaration's name here because the name itself isn't part of
3655   // the key, only the kind of name is used.
3656   if (!ConstructorDecls.empty())
3657     Generator.insert(ConstructorDecls.front()->getDeclName(),
3658                      Trait.getData(ConstructorDecls), Trait);
3659   if (!ConversionDecls.empty())
3660     Generator.insert(ConversionDecls.front()->getDeclName(),
3661                      Trait.getData(ConversionDecls), Trait);
3662 
3663   // Create the on-disk hash table. Also emit the existing imported and
3664   // merged table if there is one.
3665   auto *Lookups = Chain ? Chain->getLoadedLookupTables(DC) : nullptr;
3666   Generator.emit(LookupTable, Trait, Lookups ? &Lookups->Table : nullptr);
3667 }
3668 
3669 /// \brief Write the block containing all of the declaration IDs
3670 /// visible from the given DeclContext.
3671 ///
3672 /// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
3673 /// bitstream, or 0 if no block was written.
3674 uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
3675                                                  DeclContext *DC) {
3676   // If we imported a key declaration of this namespace, write the visible
3677   // lookup results as an update record for it rather than including them
3678   // on this declaration. We will only look at key declarations on reload.
3679   if (isa<NamespaceDecl>(DC) && Chain &&
3680       Chain->getKeyDeclaration(cast<Decl>(DC))->isFromASTFile()) {
3681     // Only do this once, for the first local declaration of the namespace.
3682     for (NamespaceDecl *Prev = cast<NamespaceDecl>(DC)->getPreviousDecl(); Prev;
3683          Prev = Prev->getPreviousDecl())
3684       if (!Prev->isFromASTFile())
3685         return 0;
3686 
3687     // Note that we need to emit an update record for the primary context.
3688     UpdatedDeclContexts.insert(DC->getPrimaryContext());
3689 
3690     // Make sure all visible decls are written. They will be recorded later. We
3691     // do this using a side data structure so we can sort the names into
3692     // a deterministic order.
3693     StoredDeclsMap *Map = DC->getPrimaryContext()->buildLookup();
3694     SmallVector<std::pair<DeclarationName, DeclContext::lookup_result>, 16>
3695         LookupResults;
3696     if (Map) {
3697       LookupResults.reserve(Map->size());
3698       for (auto &Entry : *Map)
3699         LookupResults.push_back(
3700             std::make_pair(Entry.first, Entry.second.getLookupResult()));
3701     }
3702 
3703     std::sort(LookupResults.begin(), LookupResults.end(), llvm::less_first());
3704     for (auto &NameAndResult : LookupResults) {
3705       DeclarationName Name = NameAndResult.first;
3706       DeclContext::lookup_result Result = NameAndResult.second;
3707       if (Name.getNameKind() == DeclarationName::CXXConstructorName ||
3708           Name.getNameKind() == DeclarationName::CXXConversionFunctionName) {
3709         // We have to work around a name lookup bug here where negative lookup
3710         // results for these names get cached in namespace lookup tables (these
3711         // names should never be looked up in a namespace).
3712         assert(Result.empty() && "Cannot have a constructor or conversion "
3713                                  "function name in a namespace!");
3714         continue;
3715       }
3716 
3717       for (NamedDecl *ND : Result)
3718         if (!ND->isFromASTFile())
3719           GetDeclRef(ND);
3720     }
3721 
3722     return 0;
3723   }
3724 
3725   if (DC->getPrimaryContext() != DC)
3726     return 0;
3727 
3728   // Skip contexts which don't support name lookup.
3729   if (!DC->isLookupContext())
3730     return 0;
3731 
3732   // If not in C++, we perform name lookup for the translation unit via the
3733   // IdentifierInfo chains, don't bother to build a visible-declarations table.
3734   if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
3735     return 0;
3736 
3737   // Serialize the contents of the mapping used for lookup. Note that,
3738   // although we have two very different code paths, the serialized
3739   // representation is the same for both cases: a declaration name,
3740   // followed by a size, followed by references to the visible
3741   // declarations that have that name.
3742   uint64_t Offset = Stream.GetCurrentBitNo();
3743   StoredDeclsMap *Map = DC->buildLookup();
3744   if (!Map || Map->empty())
3745     return 0;
3746 
3747   // Create the on-disk hash table in a buffer.
3748   SmallString<4096> LookupTable;
3749   GenerateNameLookupTable(DC, LookupTable);
3750 
3751   // Write the lookup table
3752   RecordData::value_type Record[] = {DECL_CONTEXT_VISIBLE};
3753   Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
3754                             LookupTable);
3755   ++NumVisibleDeclContexts;
3756   return Offset;
3757 }
3758 
3759 /// \brief Write an UPDATE_VISIBLE block for the given context.
3760 ///
3761 /// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
3762 /// DeclContext in a dependent AST file. As such, they only exist for the TU
3763 /// (in C++), for namespaces, and for classes with forward-declared unscoped
3764 /// enumeration members (in C++11).
3765 void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
3766   StoredDeclsMap *Map = DC->getLookupPtr();
3767   if (!Map || Map->empty())
3768     return;
3769 
3770   // Create the on-disk hash table in a buffer.
3771   SmallString<4096> LookupTable;
3772   GenerateNameLookupTable(DC, LookupTable);
3773 
3774   // If we're updating a namespace, select a key declaration as the key for the
3775   // update record; those are the only ones that will be checked on reload.
3776   if (isa<NamespaceDecl>(DC))
3777     DC = cast<DeclContext>(Chain->getKeyDeclaration(cast<Decl>(DC)));
3778 
3779   // Write the lookup table
3780   RecordData::value_type Record[] = {UPDATE_VISIBLE, getDeclID(cast<Decl>(DC))};
3781   Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable);
3782 }
3783 
3784 /// \brief Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
3785 void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) {
3786   RecordData::value_type Record[] = {Opts.fp_contract};
3787   Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
3788 }
3789 
3790 /// \brief Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
3791 void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
3792   if (!SemaRef.Context.getLangOpts().OpenCL)
3793     return;
3794 
3795   const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
3796   RecordData Record;
3797 #define OPENCLEXT(nm)  Record.push_back(Opts.nm);
3798 #include "clang/Basic/OpenCLExtensions.def"
3799   Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
3800 }
3801 
3802 void ASTWriter::WriteObjCCategories() {
3803   SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
3804   RecordData Categories;
3805 
3806   for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
3807     unsigned Size = 0;
3808     unsigned StartIndex = Categories.size();
3809 
3810     ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
3811 
3812     // Allocate space for the size.
3813     Categories.push_back(0);
3814 
3815     // Add the categories.
3816     for (ObjCInterfaceDecl::known_categories_iterator
3817            Cat = Class->known_categories_begin(),
3818            CatEnd = Class->known_categories_end();
3819          Cat != CatEnd; ++Cat, ++Size) {
3820       assert(getDeclID(*Cat) != 0 && "Bogus category");
3821       AddDeclRef(*Cat, Categories);
3822     }
3823 
3824     // Update the size.
3825     Categories[StartIndex] = Size;
3826 
3827     // Record this interface -> category map.
3828     ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex };
3829     CategoriesMap.push_back(CatInfo);
3830   }
3831 
3832   // Sort the categories map by the definition ID, since the reader will be
3833   // performing binary searches on this information.
3834   llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end());
3835 
3836   // Emit the categories map.
3837   using namespace llvm;
3838   llvm::BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
3839   Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
3840   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
3841   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3842   unsigned AbbrevID = Stream.EmitAbbrev(Abbrev);
3843 
3844   RecordData::value_type Record[] = {OBJC_CATEGORIES_MAP, CategoriesMap.size()};
3845   Stream.EmitRecordWithBlob(AbbrevID, Record,
3846                             reinterpret_cast<char *>(CategoriesMap.data()),
3847                             CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
3848 
3849   // Emit the category lists.
3850   Stream.EmitRecord(OBJC_CATEGORIES, Categories);
3851 }
3852 
3853 void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
3854   Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap;
3855 
3856   if (LPTMap.empty())
3857     return;
3858 
3859   RecordData Record;
3860   for (auto LPTMapEntry : LPTMap) {
3861     const FunctionDecl *FD = LPTMapEntry.first;
3862     LateParsedTemplate *LPT = LPTMapEntry.second;
3863     AddDeclRef(FD, Record);
3864     AddDeclRef(LPT->D, Record);
3865     Record.push_back(LPT->Toks.size());
3866 
3867     for (CachedTokens::iterator TokIt = LPT->Toks.begin(),
3868                                 TokEnd = LPT->Toks.end();
3869          TokIt != TokEnd; ++TokIt) {
3870       AddToken(*TokIt, Record);
3871     }
3872   }
3873   Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record);
3874 }
3875 
3876 /// \brief Write the state of 'pragma clang optimize' at the end of the module.
3877 void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
3878   RecordData Record;
3879   SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
3880   AddSourceLocation(PragmaLoc, Record);
3881   Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record);
3882 }
3883 
3884 void ASTWriter::WriteModuleFileExtension(ModuleFileExtensionWriter &Writer) {
3885   // Enter the extension block.
3886   Stream.EnterSubblock(EXTENSION_BLOCK_ID, 4);
3887 
3888   // Emit the metadata record abbreviation.
3889   llvm::BitCodeAbbrev *Abv = new llvm::BitCodeAbbrev();
3890   Abv->Add(llvm::BitCodeAbbrevOp(EXTENSION_METADATA));
3891   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
3892   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
3893   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
3894   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
3895   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
3896   unsigned Abbrev = Stream.EmitAbbrev(Abv);
3897 
3898   // Emit the metadata record.
3899   RecordData Record;
3900   auto Metadata = Writer.getExtension()->getExtensionMetadata();
3901   Record.push_back(EXTENSION_METADATA);
3902   Record.push_back(Metadata.MajorVersion);
3903   Record.push_back(Metadata.MinorVersion);
3904   Record.push_back(Metadata.BlockName.size());
3905   Record.push_back(Metadata.UserInfo.size());
3906   SmallString<64> Buffer;
3907   Buffer += Metadata.BlockName;
3908   Buffer += Metadata.UserInfo;
3909   Stream.EmitRecordWithBlob(Abbrev, Record, Buffer);
3910 
3911   // Emit the contents of the extension block.
3912   Writer.writeExtensionContents(Stream);
3913 
3914   // Exit the extension block.
3915   Stream.ExitBlock();
3916 }
3917 
3918 //===----------------------------------------------------------------------===//
3919 // General Serialization Routines
3920 //===----------------------------------------------------------------------===//
3921 
3922 /// \brief Write a record containing the given attributes.
3923 void ASTWriter::WriteAttributes(ArrayRef<const Attr*> Attrs,
3924                                 RecordDataImpl &Record) {
3925   Record.push_back(Attrs.size());
3926   for (ArrayRef<const Attr *>::iterator i = Attrs.begin(),
3927                                         e = Attrs.end(); i != e; ++i){
3928     const Attr *A = *i;
3929     Record.push_back(A->getKind()); // FIXME: stable encoding, target attrs
3930     AddSourceRange(A->getRange(), Record);
3931 
3932 #include "clang/Serialization/AttrPCHWrite.inc"
3933 
3934   }
3935 }
3936 
3937 void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) {
3938   AddSourceLocation(Tok.getLocation(), Record);
3939   Record.push_back(Tok.getLength());
3940 
3941   // FIXME: When reading literal tokens, reconstruct the literal pointer
3942   // if it is needed.
3943   AddIdentifierRef(Tok.getIdentifierInfo(), Record);
3944   // FIXME: Should translate token kind to a stable encoding.
3945   Record.push_back(Tok.getKind());
3946   // FIXME: Should translate token flags to a stable encoding.
3947   Record.push_back(Tok.getFlags());
3948 }
3949 
3950 void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
3951   Record.push_back(Str.size());
3952   Record.insert(Record.end(), Str.begin(), Str.end());
3953 }
3954 
3955 bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) {
3956   assert(Context && "should have context when outputting path");
3957 
3958   bool Changed =
3959       cleanPathForOutput(Context->getSourceManager().getFileManager(), Path);
3960 
3961   // Remove a prefix to make the path relative, if relevant.
3962   const char *PathBegin = Path.data();
3963   const char *PathPtr =
3964       adjustFilenameForRelocatableAST(PathBegin, BaseDirectory);
3965   if (PathPtr != PathBegin) {
3966     Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin));
3967     Changed = true;
3968   }
3969 
3970   return Changed;
3971 }
3972 
3973 void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) {
3974   SmallString<128> FilePath(Path);
3975   PreparePathForOutput(FilePath);
3976   AddString(FilePath, Record);
3977 }
3978 
3979 void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataRef Record,
3980                                    StringRef Path) {
3981   SmallString<128> FilePath(Path);
3982   PreparePathForOutput(FilePath);
3983   Stream.EmitRecordWithBlob(Abbrev, Record, FilePath);
3984 }
3985 
3986 void ASTWriter::AddVersionTuple(const VersionTuple &Version,
3987                                 RecordDataImpl &Record) {
3988   Record.push_back(Version.getMajor());
3989   if (Optional<unsigned> Minor = Version.getMinor())
3990     Record.push_back(*Minor + 1);
3991   else
3992     Record.push_back(0);
3993   if (Optional<unsigned> Subminor = Version.getSubminor())
3994     Record.push_back(*Subminor + 1);
3995   else
3996     Record.push_back(0);
3997 }
3998 
3999 /// \brief Note that the identifier II occurs at the given offset
4000 /// within the identifier table.
4001 void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
4002   IdentID ID = IdentifierIDs[II];
4003   // Only store offsets new to this AST file. Other identifier names are looked
4004   // up earlier in the chain and thus don't need an offset.
4005   if (ID >= FirstIdentID)
4006     IdentifierOffsets[ID - FirstIdentID] = Offset;
4007 }
4008 
4009 /// \brief Note that the selector Sel occurs at the given offset
4010 /// within the method pool/selector table.
4011 void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
4012   unsigned ID = SelectorIDs[Sel];
4013   assert(ID && "Unknown selector");
4014   // Don't record offsets for selectors that are also available in a different
4015   // file.
4016   if (ID < FirstSelectorID)
4017     return;
4018   SelectorOffsets[ID - FirstSelectorID] = Offset;
4019 }
4020 
4021 ASTWriter::ASTWriter(
4022   llvm::BitstreamWriter &Stream,
4023   ArrayRef<llvm::IntrusiveRefCntPtr<ModuleFileExtension>> Extensions,
4024   bool IncludeTimestamps)
4025     : Stream(Stream), Context(nullptr), PP(nullptr), Chain(nullptr),
4026       WritingModule(nullptr), IncludeTimestamps(IncludeTimestamps),
4027       WritingAST(false), DoneWritingDeclsAndTypes(false),
4028       ASTHasCompilerErrors(false), FirstDeclID(NUM_PREDEF_DECL_IDS),
4029       NextDeclID(FirstDeclID), FirstTypeID(NUM_PREDEF_TYPE_IDS),
4030       NextTypeID(FirstTypeID), FirstIdentID(NUM_PREDEF_IDENT_IDS),
4031       NextIdentID(FirstIdentID), FirstMacroID(NUM_PREDEF_MACRO_IDS),
4032       NextMacroID(FirstMacroID), FirstSubmoduleID(NUM_PREDEF_SUBMODULE_IDS),
4033       NextSubmoduleID(FirstSubmoduleID),
4034       FirstSelectorID(NUM_PREDEF_SELECTOR_IDS), NextSelectorID(FirstSelectorID),
4035       CollectedStmts(&StmtsToEmit), NumStatements(0), NumMacros(0),
4036       NumLexicalDeclContexts(0), NumVisibleDeclContexts(0),
4037       NextCXXBaseSpecifiersID(1), NextCXXCtorInitializersID(1),
4038       TypeExtQualAbbrev(0), TypeFunctionProtoAbbrev(0), DeclParmVarAbbrev(0),
4039       DeclContextLexicalAbbrev(0), DeclContextVisibleLookupAbbrev(0),
4040       UpdateVisibleAbbrev(0), DeclRecordAbbrev(0), DeclTypedefAbbrev(0),
4041       DeclVarAbbrev(0), DeclFieldAbbrev(0), DeclEnumAbbrev(0),
4042       DeclObjCIvarAbbrev(0), DeclCXXMethodAbbrev(0), DeclRefExprAbbrev(0),
4043       CharacterLiteralAbbrev(0), IntegerLiteralAbbrev(0),
4044       ExprImplicitCastAbbrev(0) {
4045   for (const auto &Ext : Extensions) {
4046     if (auto Writer = Ext->createExtensionWriter(*this))
4047       ModuleFileExtensionWriters.push_back(std::move(Writer));
4048   }
4049 }
4050 
4051 ASTWriter::~ASTWriter() {
4052   llvm::DeleteContainerSeconds(FileDeclIDs);
4053 }
4054 
4055 const LangOptions &ASTWriter::getLangOpts() const {
4056   assert(WritingAST && "can't determine lang opts when not writing AST");
4057   return Context->getLangOpts();
4058 }
4059 
4060 time_t ASTWriter::getTimestampForOutput(const FileEntry *E) const {
4061   return IncludeTimestamps ? E->getModificationTime() : 0;
4062 }
4063 
4064 uint64_t ASTWriter::WriteAST(Sema &SemaRef, const std::string &OutputFile,
4065                              Module *WritingModule, StringRef isysroot,
4066                              bool hasErrors) {
4067   WritingAST = true;
4068 
4069   ASTHasCompilerErrors = hasErrors;
4070 
4071   // Emit the file header.
4072   Stream.Emit((unsigned)'C', 8);
4073   Stream.Emit((unsigned)'P', 8);
4074   Stream.Emit((unsigned)'C', 8);
4075   Stream.Emit((unsigned)'H', 8);
4076 
4077   WriteBlockInfoBlock();
4078 
4079   Context = &SemaRef.Context;
4080   PP = &SemaRef.PP;
4081   this->WritingModule = WritingModule;
4082   ASTFileSignature Signature =
4083       WriteASTCore(SemaRef, isysroot, OutputFile, WritingModule);
4084   Context = nullptr;
4085   PP = nullptr;
4086   this->WritingModule = nullptr;
4087   this->BaseDirectory.clear();
4088 
4089   WritingAST = false;
4090   return Signature;
4091 }
4092 
4093 template<typename Vector>
4094 static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec,
4095                                ASTWriter::RecordData &Record) {
4096   for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
4097        I != E; ++I) {
4098     Writer.AddDeclRef(*I, Record);
4099   }
4100 }
4101 
4102 uint64_t ASTWriter::WriteASTCore(Sema &SemaRef, StringRef isysroot,
4103                                  const std::string &OutputFile,
4104                                  Module *WritingModule) {
4105   using namespace llvm;
4106 
4107   bool isModule = WritingModule != nullptr;
4108 
4109   // Make sure that the AST reader knows to finalize itself.
4110   if (Chain)
4111     Chain->finalizeForWriting();
4112 
4113   ASTContext &Context = SemaRef.Context;
4114   Preprocessor &PP = SemaRef.PP;
4115 
4116   // Set up predefined declaration IDs.
4117   auto RegisterPredefDecl = [&] (Decl *D, PredefinedDeclIDs ID) {
4118     if (D) {
4119       assert(D->isCanonicalDecl() && "predefined decl is not canonical");
4120       DeclIDs[D] = ID;
4121     }
4122   };
4123   RegisterPredefDecl(Context.getTranslationUnitDecl(),
4124                      PREDEF_DECL_TRANSLATION_UNIT_ID);
4125   RegisterPredefDecl(Context.ObjCIdDecl, PREDEF_DECL_OBJC_ID_ID);
4126   RegisterPredefDecl(Context.ObjCSelDecl, PREDEF_DECL_OBJC_SEL_ID);
4127   RegisterPredefDecl(Context.ObjCClassDecl, PREDEF_DECL_OBJC_CLASS_ID);
4128   RegisterPredefDecl(Context.ObjCProtocolClassDecl,
4129                      PREDEF_DECL_OBJC_PROTOCOL_ID);
4130   RegisterPredefDecl(Context.Int128Decl, PREDEF_DECL_INT_128_ID);
4131   RegisterPredefDecl(Context.UInt128Decl, PREDEF_DECL_UNSIGNED_INT_128_ID);
4132   RegisterPredefDecl(Context.ObjCInstanceTypeDecl,
4133                      PREDEF_DECL_OBJC_INSTANCETYPE_ID);
4134   RegisterPredefDecl(Context.BuiltinVaListDecl, PREDEF_DECL_BUILTIN_VA_LIST_ID);
4135   RegisterPredefDecl(Context.VaListTagDecl, PREDEF_DECL_VA_LIST_TAG);
4136   RegisterPredefDecl(Context.BuiltinMSVaListDecl,
4137                      PREDEF_DECL_BUILTIN_MS_VA_LIST_ID);
4138   RegisterPredefDecl(Context.ExternCContext, PREDEF_DECL_EXTERN_C_CONTEXT_ID);
4139   RegisterPredefDecl(Context.MakeIntegerSeqDecl,
4140                      PREDEF_DECL_MAKE_INTEGER_SEQ_ID);
4141 
4142   // Build a record containing all of the tentative definitions in this file, in
4143   // TentativeDefinitions order.  Generally, this record will be empty for
4144   // headers.
4145   RecordData TentativeDefinitions;
4146   AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions);
4147 
4148   // Build a record containing all of the file scoped decls in this file.
4149   RecordData UnusedFileScopedDecls;
4150   if (!isModule)
4151     AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls,
4152                        UnusedFileScopedDecls);
4153 
4154   // Build a record containing all of the delegating constructors we still need
4155   // to resolve.
4156   RecordData DelegatingCtorDecls;
4157   if (!isModule)
4158     AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls);
4159 
4160   // Write the set of weak, undeclared identifiers. We always write the
4161   // entire table, since later PCH files in a PCH chain are only interested in
4162   // the results at the end of the chain.
4163   RecordData WeakUndeclaredIdentifiers;
4164   for (auto &WeakUndeclaredIdentifier : SemaRef.WeakUndeclaredIdentifiers) {
4165     IdentifierInfo *II = WeakUndeclaredIdentifier.first;
4166     WeakInfo &WI = WeakUndeclaredIdentifier.second;
4167     AddIdentifierRef(II, WeakUndeclaredIdentifiers);
4168     AddIdentifierRef(WI.getAlias(), WeakUndeclaredIdentifiers);
4169     AddSourceLocation(WI.getLocation(), WeakUndeclaredIdentifiers);
4170     WeakUndeclaredIdentifiers.push_back(WI.getUsed());
4171   }
4172 
4173   // Build a record containing all of the ext_vector declarations.
4174   RecordData ExtVectorDecls;
4175   AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
4176 
4177   // Build a record containing all of the VTable uses information.
4178   RecordData VTableUses;
4179   if (!SemaRef.VTableUses.empty()) {
4180     for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
4181       AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
4182       AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
4183       VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
4184     }
4185   }
4186 
4187   // Build a record containing all of the UnusedLocalTypedefNameCandidates.
4188   RecordData UnusedLocalTypedefNameCandidates;
4189   for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
4190     AddDeclRef(TD, UnusedLocalTypedefNameCandidates);
4191 
4192   // Build a record containing all of pending implicit instantiations.
4193   RecordData PendingInstantiations;
4194   for (std::deque<Sema::PendingImplicitInstantiation>::iterator
4195          I = SemaRef.PendingInstantiations.begin(),
4196          N = SemaRef.PendingInstantiations.end(); I != N; ++I) {
4197     AddDeclRef(I->first, PendingInstantiations);
4198     AddSourceLocation(I->second, PendingInstantiations);
4199   }
4200   assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
4201          "There are local ones at end of translation unit!");
4202 
4203   // Build a record containing some declaration references.
4204   RecordData SemaDeclRefs;
4205   if (SemaRef.StdNamespace || SemaRef.StdBadAlloc) {
4206     AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
4207     AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
4208   }
4209 
4210   RecordData CUDASpecialDeclRefs;
4211   if (Context.getcudaConfigureCallDecl()) {
4212     AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs);
4213   }
4214 
4215   // Build a record containing all of the known namespaces.
4216   RecordData KnownNamespaces;
4217   for (llvm::MapVector<NamespaceDecl*, bool>::iterator
4218             I = SemaRef.KnownNamespaces.begin(),
4219          IEnd = SemaRef.KnownNamespaces.end();
4220        I != IEnd; ++I) {
4221     if (!I->second)
4222       AddDeclRef(I->first, KnownNamespaces);
4223   }
4224 
4225   // Build a record of all used, undefined objects that require definitions.
4226   RecordData UndefinedButUsed;
4227 
4228   SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
4229   SemaRef.getUndefinedButUsed(Undefined);
4230   for (SmallVectorImpl<std::pair<NamedDecl *, SourceLocation> >::iterator
4231          I = Undefined.begin(), E = Undefined.end(); I != E; ++I) {
4232     AddDeclRef(I->first, UndefinedButUsed);
4233     AddSourceLocation(I->second, UndefinedButUsed);
4234   }
4235 
4236   // Build a record containing all delete-expressions that we would like to
4237   // analyze later in AST.
4238   RecordData DeleteExprsToAnalyze;
4239 
4240   for (const auto &DeleteExprsInfo :
4241        SemaRef.getMismatchingDeleteExpressions()) {
4242     AddDeclRef(DeleteExprsInfo.first, DeleteExprsToAnalyze);
4243     DeleteExprsToAnalyze.push_back(DeleteExprsInfo.second.size());
4244     for (const auto &DeleteLoc : DeleteExprsInfo.second) {
4245       AddSourceLocation(DeleteLoc.first, DeleteExprsToAnalyze);
4246       DeleteExprsToAnalyze.push_back(DeleteLoc.second);
4247     }
4248   }
4249 
4250   // Write the control block
4251   uint64_t Signature = WriteControlBlock(PP, Context, isysroot, OutputFile);
4252 
4253   // Write the remaining AST contents.
4254   Stream.EnterSubblock(AST_BLOCK_ID, 5);
4255 
4256   // This is so that older clang versions, before the introduction
4257   // of the control block, can read and reject the newer PCH format.
4258   {
4259     RecordData Record = {VERSION_MAJOR};
4260     Stream.EmitRecord(METADATA_OLD_FORMAT, Record);
4261   }
4262 
4263   // Create a lexical update block containing all of the declarations in the
4264   // translation unit that do not come from other AST files.
4265   const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
4266   SmallVector<uint32_t, 128> NewGlobalKindDeclPairs;
4267   for (const auto *D : TU->noload_decls()) {
4268     if (!D->isFromASTFile()) {
4269       NewGlobalKindDeclPairs.push_back(D->getKind());
4270       NewGlobalKindDeclPairs.push_back(GetDeclRef(D));
4271     }
4272   }
4273 
4274   llvm::BitCodeAbbrev *Abv = new llvm::BitCodeAbbrev();
4275   Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
4276   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4277   unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(Abv);
4278   {
4279     RecordData::value_type Record[] = {TU_UPDATE_LEXICAL};
4280     Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
4281                               bytes(NewGlobalKindDeclPairs));
4282   }
4283 
4284   // And a visible updates block for the translation unit.
4285   Abv = new llvm::BitCodeAbbrev();
4286   Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
4287   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4288   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4289   UpdateVisibleAbbrev = Stream.EmitAbbrev(Abv);
4290   WriteDeclContextVisibleUpdate(TU);
4291 
4292   // If we have any extern "C" names, write out a visible update for them.
4293   if (Context.ExternCContext)
4294     WriteDeclContextVisibleUpdate(Context.ExternCContext);
4295 
4296   // If the translation unit has an anonymous namespace, and we don't already
4297   // have an update block for it, write it as an update block.
4298   // FIXME: Why do we not do this if there's already an update block?
4299   if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
4300     ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
4301     if (Record.empty())
4302       Record.push_back(DeclUpdate(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE, NS));
4303   }
4304 
4305   // Add update records for all mangling numbers and static local numbers.
4306   // These aren't really update records, but this is a convenient way of
4307   // tagging this rare extra data onto the declarations.
4308   for (const auto &Number : Context.MangleNumbers)
4309     if (!Number.first->isFromASTFile())
4310       DeclUpdates[Number.first].push_back(DeclUpdate(UPD_MANGLING_NUMBER,
4311                                                      Number.second));
4312   for (const auto &Number : Context.StaticLocalNumbers)
4313     if (!Number.first->isFromASTFile())
4314       DeclUpdates[Number.first].push_back(DeclUpdate(UPD_STATIC_LOCAL_NUMBER,
4315                                                      Number.second));
4316 
4317   // Make sure visible decls, added to DeclContexts previously loaded from
4318   // an AST file, are registered for serialization.
4319   for (SmallVectorImpl<const Decl *>::iterator
4320          I = UpdatingVisibleDecls.begin(),
4321          E = UpdatingVisibleDecls.end(); I != E; ++I) {
4322     GetDeclRef(*I);
4323   }
4324 
4325   // Make sure all decls associated with an identifier are registered for
4326   // serialization, if we're storing decls with identifiers.
4327   if (!WritingModule || !getLangOpts().CPlusPlus) {
4328     llvm::SmallVector<const IdentifierInfo*, 256> IIs;
4329     for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
4330                                 IDEnd = PP.getIdentifierTable().end();
4331          ID != IDEnd; ++ID) {
4332       const IdentifierInfo *II = ID->second;
4333       if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
4334         IIs.push_back(II);
4335     }
4336     // Sort the identifiers to visit based on their name.
4337     std::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>());
4338     for (const IdentifierInfo *II : IIs) {
4339       for (IdentifierResolver::iterator D = SemaRef.IdResolver.begin(II),
4340                                      DEnd = SemaRef.IdResolver.end();
4341            D != DEnd; ++D) {
4342         GetDeclRef(*D);
4343       }
4344     }
4345   }
4346 
4347   // Form the record of special types.
4348   RecordData SpecialTypes;
4349   AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes);
4350   AddTypeRef(Context.getFILEType(), SpecialTypes);
4351   AddTypeRef(Context.getjmp_bufType(), SpecialTypes);
4352   AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes);
4353   AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes);
4354   AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes);
4355   AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes);
4356   AddTypeRef(Context.getucontext_tType(), SpecialTypes);
4357 
4358   if (Chain) {
4359     // Write the mapping information describing our module dependencies and how
4360     // each of those modules were mapped into our own offset/ID space, so that
4361     // the reader can build the appropriate mapping to its own offset/ID space.
4362     // The map consists solely of a blob with the following format:
4363     // *(module-name-len:i16 module-name:len*i8
4364     //   source-location-offset:i32
4365     //   identifier-id:i32
4366     //   preprocessed-entity-id:i32
4367     //   macro-definition-id:i32
4368     //   submodule-id:i32
4369     //   selector-id:i32
4370     //   declaration-id:i32
4371     //   c++-base-specifiers-id:i32
4372     //   type-id:i32)
4373     //
4374     llvm::BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
4375     Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
4376     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
4377     unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(Abbrev);
4378     SmallString<2048> Buffer;
4379     {
4380       llvm::raw_svector_ostream Out(Buffer);
4381       for (ModuleFile *M : Chain->ModuleMgr) {
4382         using namespace llvm::support;
4383         endian::Writer<little> LE(Out);
4384         StringRef FileName = M->FileName;
4385         LE.write<uint16_t>(FileName.size());
4386         Out.write(FileName.data(), FileName.size());
4387 
4388         // Note: if a base ID was uint max, it would not be possible to load
4389         // another module after it or have more than one entity inside it.
4390         uint32_t None = std::numeric_limits<uint32_t>::max();
4391 
4392         auto writeBaseIDOrNone = [&](uint32_t BaseID, bool ShouldWrite) {
4393           assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
4394           if (ShouldWrite)
4395             LE.write<uint32_t>(BaseID);
4396           else
4397             LE.write<uint32_t>(None);
4398         };
4399 
4400         // These values should be unique within a chain, since they will be read
4401         // as keys into ContinuousRangeMaps.
4402         writeBaseIDOrNone(M->SLocEntryBaseOffset, M->LocalNumSLocEntries);
4403         writeBaseIDOrNone(M->BaseIdentifierID, M->LocalNumIdentifiers);
4404         writeBaseIDOrNone(M->BaseMacroID, M->LocalNumMacros);
4405         writeBaseIDOrNone(M->BasePreprocessedEntityID,
4406                           M->NumPreprocessedEntities);
4407         writeBaseIDOrNone(M->BaseSubmoduleID, M->LocalNumSubmodules);
4408         writeBaseIDOrNone(M->BaseSelectorID, M->LocalNumSelectors);
4409         writeBaseIDOrNone(M->BaseDeclID, M->LocalNumDecls);
4410         writeBaseIDOrNone(M->BaseTypeIndex, M->LocalNumTypes);
4411       }
4412     }
4413     RecordData::value_type Record[] = {MODULE_OFFSET_MAP};
4414     Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
4415                               Buffer.data(), Buffer.size());
4416   }
4417 
4418   RecordData DeclUpdatesOffsetsRecord;
4419 
4420   // Keep writing types, declarations, and declaration update records
4421   // until we've emitted all of them.
4422   Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/5);
4423   WriteTypeAbbrevs();
4424   WriteDeclAbbrevs();
4425   do {
4426     WriteDeclUpdatesBlocks(DeclUpdatesOffsetsRecord);
4427     while (!DeclTypesToEmit.empty()) {
4428       DeclOrType DOT = DeclTypesToEmit.front();
4429       DeclTypesToEmit.pop();
4430       if (DOT.isType())
4431         WriteType(DOT.getType());
4432       else
4433         WriteDecl(Context, DOT.getDecl());
4434     }
4435   } while (!DeclUpdates.empty());
4436   Stream.ExitBlock();
4437 
4438   DoneWritingDeclsAndTypes = true;
4439 
4440   // These things can only be done once we've written out decls and types.
4441   WriteTypeDeclOffsets();
4442   if (!DeclUpdatesOffsetsRecord.empty())
4443     Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord);
4444   WriteCXXBaseSpecifiersOffsets();
4445   WriteCXXCtorInitializersOffsets();
4446   WriteFileDeclIDsMap();
4447   WriteSourceManagerBlock(Context.getSourceManager(), PP);
4448   WriteComments();
4449   WritePreprocessor(PP, isModule);
4450   WriteHeaderSearch(PP.getHeaderSearchInfo());
4451   WriteSelectors(SemaRef);
4452   WriteReferencedSelectorsPool(SemaRef);
4453   WriteLateParsedTemplates(SemaRef);
4454   WriteIdentifierTable(PP, SemaRef.IdResolver, isModule);
4455   WriteFPPragmaOptions(SemaRef.getFPOptions());
4456   WriteOpenCLExtensions(SemaRef);
4457   WritePragmaDiagnosticMappings(Context.getDiagnostics(), isModule);
4458 
4459   // If we're emitting a module, write out the submodule information.
4460   if (WritingModule)
4461     WriteSubmodules(WritingModule);
4462 
4463   Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
4464 
4465   // Write the record containing external, unnamed definitions.
4466   if (!EagerlyDeserializedDecls.empty())
4467     Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls);
4468 
4469   // Write the record containing tentative definitions.
4470   if (!TentativeDefinitions.empty())
4471     Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
4472 
4473   // Write the record containing unused file scoped decls.
4474   if (!UnusedFileScopedDecls.empty())
4475     Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
4476 
4477   // Write the record containing weak undeclared identifiers.
4478   if (!WeakUndeclaredIdentifiers.empty())
4479     Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
4480                       WeakUndeclaredIdentifiers);
4481 
4482   // Write the record containing ext_vector type names.
4483   if (!ExtVectorDecls.empty())
4484     Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
4485 
4486   // Write the record containing VTable uses information.
4487   if (!VTableUses.empty())
4488     Stream.EmitRecord(VTABLE_USES, VTableUses);
4489 
4490   // Write the record containing potentially unused local typedefs.
4491   if (!UnusedLocalTypedefNameCandidates.empty())
4492     Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
4493                       UnusedLocalTypedefNameCandidates);
4494 
4495   // Write the record containing pending implicit instantiations.
4496   if (!PendingInstantiations.empty())
4497     Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
4498 
4499   // Write the record containing declaration references of Sema.
4500   if (!SemaDeclRefs.empty())
4501     Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
4502 
4503   // Write the record containing CUDA-specific declaration references.
4504   if (!CUDASpecialDeclRefs.empty())
4505     Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
4506 
4507   // Write the delegating constructors.
4508   if (!DelegatingCtorDecls.empty())
4509     Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
4510 
4511   // Write the known namespaces.
4512   if (!KnownNamespaces.empty())
4513     Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
4514 
4515   // Write the undefined internal functions and variables, and inline functions.
4516   if (!UndefinedButUsed.empty())
4517     Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed);
4518 
4519   if (!DeleteExprsToAnalyze.empty())
4520     Stream.EmitRecord(DELETE_EXPRS_TO_ANALYZE, DeleteExprsToAnalyze);
4521 
4522   // Write the visible updates to DeclContexts.
4523   for (auto *DC : UpdatedDeclContexts)
4524     WriteDeclContextVisibleUpdate(DC);
4525 
4526   if (!WritingModule) {
4527     // Write the submodules that were imported, if any.
4528     struct ModuleInfo {
4529       uint64_t ID;
4530       Module *M;
4531       ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
4532     };
4533     llvm::SmallVector<ModuleInfo, 64> Imports;
4534     for (const auto *I : Context.local_imports()) {
4535       assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end());
4536       Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()],
4537                          I->getImportedModule()));
4538     }
4539 
4540     if (!Imports.empty()) {
4541       auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
4542         return A.ID < B.ID;
4543       };
4544       auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
4545         return A.ID == B.ID;
4546       };
4547 
4548       // Sort and deduplicate module IDs.
4549       std::sort(Imports.begin(), Imports.end(), Cmp);
4550       Imports.erase(std::unique(Imports.begin(), Imports.end(), Eq),
4551                     Imports.end());
4552 
4553       RecordData ImportedModules;
4554       for (const auto &Import : Imports) {
4555         ImportedModules.push_back(Import.ID);
4556         // FIXME: If the module has macros imported then later has declarations
4557         // imported, this location won't be the right one as a location for the
4558         // declaration imports.
4559         AddSourceLocation(PP.getModuleImportLoc(Import.M), ImportedModules);
4560       }
4561 
4562       Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
4563     }
4564   }
4565 
4566   WriteDeclReplacementsBlock();
4567   WriteObjCCategories();
4568   if(!WritingModule)
4569     WriteOptimizePragmaOptions(SemaRef);
4570 
4571   // Some simple statistics
4572   RecordData::value_type Record[] = {
4573       NumStatements, NumMacros, NumLexicalDeclContexts, NumVisibleDeclContexts};
4574   Stream.EmitRecord(STATISTICS, Record);
4575   Stream.ExitBlock();
4576 
4577   // Write the module file extension blocks.
4578   for (const auto &ExtWriter : ModuleFileExtensionWriters)
4579     WriteModuleFileExtension(*ExtWriter);
4580 
4581   return Signature;
4582 }
4583 
4584 void ASTWriter::WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord) {
4585   if (DeclUpdates.empty())
4586     return;
4587 
4588   DeclUpdateMap LocalUpdates;
4589   LocalUpdates.swap(DeclUpdates);
4590 
4591   for (auto &DeclUpdate : LocalUpdates) {
4592     const Decl *D = DeclUpdate.first;
4593 
4594     bool HasUpdatedBody = false;
4595     RecordData Record;
4596     for (auto &Update : DeclUpdate.second) {
4597       DeclUpdateKind Kind = (DeclUpdateKind)Update.getKind();
4598 
4599       Record.push_back(Kind);
4600       switch (Kind) {
4601       case UPD_CXX_ADDED_IMPLICIT_MEMBER:
4602       case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION:
4603       case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE:
4604         assert(Update.getDecl() && "no decl to add?");
4605         Record.push_back(GetDeclRef(Update.getDecl()));
4606         break;
4607 
4608       case UPD_CXX_ADDED_FUNCTION_DEFINITION:
4609         // An updated body is emitted last, so that the reader doesn't need
4610         // to skip over the lazy body to reach statements for other records.
4611         Record.pop_back();
4612         HasUpdatedBody = true;
4613         break;
4614 
4615       case UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER:
4616         AddSourceLocation(Update.getLoc(), Record);
4617         break;
4618 
4619       case UPD_CXX_INSTANTIATED_CLASS_DEFINITION: {
4620         auto *RD = cast<CXXRecordDecl>(D);
4621         UpdatedDeclContexts.insert(RD->getPrimaryContext());
4622         AddCXXDefinitionData(RD, Record);
4623         Record.push_back(WriteDeclContextLexicalBlock(
4624             *Context, const_cast<CXXRecordDecl *>(RD)));
4625 
4626         // This state is sometimes updated by template instantiation, when we
4627         // switch from the specialization referring to the template declaration
4628         // to it referring to the template definition.
4629         if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
4630           Record.push_back(MSInfo->getTemplateSpecializationKind());
4631           AddSourceLocation(MSInfo->getPointOfInstantiation(), Record);
4632         } else {
4633           auto *Spec = cast<ClassTemplateSpecializationDecl>(RD);
4634           Record.push_back(Spec->getTemplateSpecializationKind());
4635           AddSourceLocation(Spec->getPointOfInstantiation(), Record);
4636 
4637           // The instantiation might have been resolved to a partial
4638           // specialization. If so, record which one.
4639           auto From = Spec->getInstantiatedFrom();
4640           if (auto PartialSpec =
4641                 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
4642             Record.push_back(true);
4643             AddDeclRef(PartialSpec, Record);
4644             AddTemplateArgumentList(&Spec->getTemplateInstantiationArgs(),
4645                                     Record);
4646           } else {
4647             Record.push_back(false);
4648           }
4649         }
4650         Record.push_back(RD->getTagKind());
4651         AddSourceLocation(RD->getLocation(), Record);
4652         AddSourceLocation(RD->getLocStart(), Record);
4653         AddSourceLocation(RD->getRBraceLoc(), Record);
4654 
4655         // Instantiation may change attributes; write them all out afresh.
4656         Record.push_back(D->hasAttrs());
4657         if (Record.back())
4658           WriteAttributes(llvm::makeArrayRef(D->getAttrs().begin(),
4659                                              D->getAttrs().size()), Record);
4660 
4661         // FIXME: Ensure we don't get here for explicit instantiations.
4662         break;
4663       }
4664 
4665       case UPD_CXX_RESOLVED_DTOR_DELETE:
4666         AddDeclRef(Update.getDecl(), Record);
4667         break;
4668 
4669       case UPD_CXX_RESOLVED_EXCEPTION_SPEC:
4670         addExceptionSpec(
4671             *this,
4672             cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>(),
4673             Record);
4674         break;
4675 
4676       case UPD_CXX_DEDUCED_RETURN_TYPE:
4677         Record.push_back(GetOrCreateTypeID(Update.getType()));
4678         break;
4679 
4680       case UPD_DECL_MARKED_USED:
4681         break;
4682 
4683       case UPD_MANGLING_NUMBER:
4684       case UPD_STATIC_LOCAL_NUMBER:
4685         Record.push_back(Update.getNumber());
4686         break;
4687 
4688       case UPD_DECL_MARKED_OPENMP_THREADPRIVATE:
4689         AddSourceRange(D->getAttr<OMPThreadPrivateDeclAttr>()->getRange(),
4690                        Record);
4691         break;
4692 
4693       case UPD_DECL_EXPORTED:
4694         Record.push_back(getSubmoduleID(Update.getModule()));
4695         break;
4696 
4697       case UPD_ADDED_ATTR_TO_RECORD:
4698         WriteAttributes(llvm::makeArrayRef(Update.getAttr()), Record);
4699         break;
4700       }
4701     }
4702 
4703     if (HasUpdatedBody) {
4704       const FunctionDecl *Def = cast<FunctionDecl>(D);
4705       Record.push_back(UPD_CXX_ADDED_FUNCTION_DEFINITION);
4706       Record.push_back(Def->isInlined());
4707       AddSourceLocation(Def->getInnerLocStart(), Record);
4708       AddFunctionDefinition(Def, Record);
4709     }
4710 
4711     OffsetsRecord.push_back(GetDeclRef(D));
4712     OffsetsRecord.push_back(Stream.GetCurrentBitNo());
4713 
4714     Stream.EmitRecord(DECL_UPDATES, Record);
4715 
4716     FlushPendingAfterDecl();
4717   }
4718 }
4719 
4720 void ASTWriter::WriteDeclReplacementsBlock() {
4721   if (ReplacedDecls.empty())
4722     return;
4723 
4724   RecordData Record;
4725   for (SmallVectorImpl<ReplacedDeclInfo>::iterator
4726          I = ReplacedDecls.begin(), E = ReplacedDecls.end(); I != E; ++I) {
4727     Record.push_back(I->ID);
4728     Record.push_back(I->Offset);
4729     Record.push_back(I->Loc);
4730   }
4731   Stream.EmitRecord(DECL_REPLACEMENTS, Record);
4732 }
4733 
4734 void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
4735   Record.push_back(Loc.getRawEncoding());
4736 }
4737 
4738 void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
4739   AddSourceLocation(Range.getBegin(), Record);
4740   AddSourceLocation(Range.getEnd(), Record);
4741 }
4742 
4743 void ASTWriter::AddAPInt(const llvm::APInt &Value, RecordDataImpl &Record) {
4744   Record.push_back(Value.getBitWidth());
4745   const uint64_t *Words = Value.getRawData();
4746   Record.append(Words, Words + Value.getNumWords());
4747 }
4748 
4749 void ASTWriter::AddAPSInt(const llvm::APSInt &Value, RecordDataImpl &Record) {
4750   Record.push_back(Value.isUnsigned());
4751   AddAPInt(Value, Record);
4752 }
4753 
4754 void ASTWriter::AddAPFloat(const llvm::APFloat &Value, RecordDataImpl &Record) {
4755   AddAPInt(Value.bitcastToAPInt(), Record);
4756 }
4757 
4758 void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
4759   Record.push_back(getIdentifierRef(II));
4760 }
4761 
4762 IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
4763   if (!II)
4764     return 0;
4765 
4766   IdentID &ID = IdentifierIDs[II];
4767   if (ID == 0)
4768     ID = NextIdentID++;
4769   return ID;
4770 }
4771 
4772 MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) {
4773   // Don't emit builtin macros like __LINE__ to the AST file unless they
4774   // have been redefined by the header (in which case they are not
4775   // isBuiltinMacro).
4776   if (!MI || MI->isBuiltinMacro())
4777     return 0;
4778 
4779   MacroID &ID = MacroIDs[MI];
4780   if (ID == 0) {
4781     ID = NextMacroID++;
4782     MacroInfoToEmitData Info = { Name, MI, ID };
4783     MacroInfosToEmit.push_back(Info);
4784   }
4785   return ID;
4786 }
4787 
4788 MacroID ASTWriter::getMacroID(MacroInfo *MI) {
4789   if (!MI || MI->isBuiltinMacro())
4790     return 0;
4791 
4792   assert(MacroIDs.find(MI) != MacroIDs.end() && "Macro not emitted!");
4793   return MacroIDs[MI];
4794 }
4795 
4796 uint64_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) {
4797   return IdentMacroDirectivesOffsetMap.lookup(Name);
4798 }
4799 
4800 void ASTWriter::AddSelectorRef(const Selector SelRef, RecordDataImpl &Record) {
4801   Record.push_back(getSelectorRef(SelRef));
4802 }
4803 
4804 SelectorID ASTWriter::getSelectorRef(Selector Sel) {
4805   if (Sel.getAsOpaquePtr() == nullptr) {
4806     return 0;
4807   }
4808 
4809   SelectorID SID = SelectorIDs[Sel];
4810   if (SID == 0 && Chain) {
4811     // This might trigger a ReadSelector callback, which will set the ID for
4812     // this selector.
4813     Chain->LoadSelector(Sel);
4814     SID = SelectorIDs[Sel];
4815   }
4816   if (SID == 0) {
4817     SID = NextSelectorID++;
4818     SelectorIDs[Sel] = SID;
4819   }
4820   return SID;
4821 }
4822 
4823 void ASTWriter::AddCXXTemporary(const CXXTemporary *Temp, RecordDataImpl &Record) {
4824   AddDeclRef(Temp->getDestructor(), Record);
4825 }
4826 
4827 void ASTWriter::AddCXXCtorInitializersRef(ArrayRef<CXXCtorInitializer *> Inits,
4828                                           RecordDataImpl &Record) {
4829   assert(!Inits.empty() && "Empty ctor initializer sets are not recorded");
4830   CXXCtorInitializersToWrite.push_back(
4831       QueuedCXXCtorInitializers(NextCXXCtorInitializersID, Inits));
4832   Record.push_back(NextCXXCtorInitializersID++);
4833 }
4834 
4835 void ASTWriter::AddCXXBaseSpecifiersRef(CXXBaseSpecifier const *Bases,
4836                                         CXXBaseSpecifier const *BasesEnd,
4837                                         RecordDataImpl &Record) {
4838   assert(Bases != BasesEnd && "Empty base-specifier sets are not recorded");
4839   CXXBaseSpecifiersToWrite.push_back(
4840                                 QueuedCXXBaseSpecifiers(NextCXXBaseSpecifiersID,
4841                                                         Bases, BasesEnd));
4842   Record.push_back(NextCXXBaseSpecifiersID++);
4843 }
4844 
4845 void ASTWriter::AddTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind,
4846                                            const TemplateArgumentLocInfo &Arg,
4847                                            RecordDataImpl &Record) {
4848   switch (Kind) {
4849   case TemplateArgument::Expression:
4850     AddStmt(Arg.getAsExpr());
4851     break;
4852   case TemplateArgument::Type:
4853     AddTypeSourceInfo(Arg.getAsTypeSourceInfo(), Record);
4854     break;
4855   case TemplateArgument::Template:
4856     AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc(), Record);
4857     AddSourceLocation(Arg.getTemplateNameLoc(), Record);
4858     break;
4859   case TemplateArgument::TemplateExpansion:
4860     AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc(), Record);
4861     AddSourceLocation(Arg.getTemplateNameLoc(), Record);
4862     AddSourceLocation(Arg.getTemplateEllipsisLoc(), Record);
4863     break;
4864   case TemplateArgument::Null:
4865   case TemplateArgument::Integral:
4866   case TemplateArgument::Declaration:
4867   case TemplateArgument::NullPtr:
4868   case TemplateArgument::Pack:
4869     // FIXME: Is this right?
4870     break;
4871   }
4872 }
4873 
4874 void ASTWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg,
4875                                        RecordDataImpl &Record) {
4876   AddTemplateArgument(Arg.getArgument(), Record);
4877 
4878   if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
4879     bool InfoHasSameExpr
4880       = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
4881     Record.push_back(InfoHasSameExpr);
4882     if (InfoHasSameExpr)
4883       return; // Avoid storing the same expr twice.
4884   }
4885   AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo(),
4886                              Record);
4887 }
4888 
4889 void ASTWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo,
4890                                   RecordDataImpl &Record) {
4891   if (!TInfo) {
4892     AddTypeRef(QualType(), Record);
4893     return;
4894   }
4895 
4896   AddTypeLoc(TInfo->getTypeLoc(), Record);
4897 }
4898 
4899 void ASTWriter::AddTypeLoc(TypeLoc TL, RecordDataImpl &Record) {
4900   AddTypeRef(TL.getType(), Record);
4901 
4902   TypeLocWriter TLW(*this, Record);
4903   for (; !TL.isNull(); TL = TL.getNextTypeLoc())
4904     TLW.Visit(TL);
4905 }
4906 
4907 void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
4908   Record.push_back(GetOrCreateTypeID(T));
4909 }
4910 
4911 TypeID ASTWriter::GetOrCreateTypeID(QualType T) {
4912   assert(Context);
4913   return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
4914     if (T.isNull())
4915       return TypeIdx();
4916     assert(!T.getLocalFastQualifiers());
4917 
4918     TypeIdx &Idx = TypeIdxs[T];
4919     if (Idx.getIndex() == 0) {
4920       if (DoneWritingDeclsAndTypes) {
4921         assert(0 && "New type seen after serializing all the types to emit!");
4922         return TypeIdx();
4923       }
4924 
4925       // We haven't seen this type before. Assign it a new ID and put it
4926       // into the queue of types to emit.
4927       Idx = TypeIdx(NextTypeID++);
4928       DeclTypesToEmit.push(T);
4929     }
4930     return Idx;
4931   });
4932 }
4933 
4934 TypeID ASTWriter::getTypeID(QualType T) const {
4935   assert(Context);
4936   return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
4937     if (T.isNull())
4938       return TypeIdx();
4939     assert(!T.getLocalFastQualifiers());
4940 
4941     TypeIdxMap::const_iterator I = TypeIdxs.find(T);
4942     assert(I != TypeIdxs.end() && "Type not emitted!");
4943     return I->second;
4944   });
4945 }
4946 
4947 void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
4948   Record.push_back(GetDeclRef(D));
4949 }
4950 
4951 DeclID ASTWriter::GetDeclRef(const Decl *D) {
4952   assert(WritingAST && "Cannot request a declaration ID before AST writing");
4953 
4954   if (!D) {
4955     return 0;
4956   }
4957 
4958   // If D comes from an AST file, its declaration ID is already known and
4959   // fixed.
4960   if (D->isFromASTFile())
4961     return D->getGlobalID();
4962 
4963   assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
4964   DeclID &ID = DeclIDs[D];
4965   if (ID == 0) {
4966     if (DoneWritingDeclsAndTypes) {
4967       assert(0 && "New decl seen after serializing all the decls to emit!");
4968       return 0;
4969     }
4970 
4971     // We haven't seen this declaration before. Give it a new ID and
4972     // enqueue it in the list of declarations to emit.
4973     ID = NextDeclID++;
4974     DeclTypesToEmit.push(const_cast<Decl *>(D));
4975   }
4976 
4977   return ID;
4978 }
4979 
4980 DeclID ASTWriter::getDeclID(const Decl *D) {
4981   if (!D)
4982     return 0;
4983 
4984   // If D comes from an AST file, its declaration ID is already known and
4985   // fixed.
4986   if (D->isFromASTFile())
4987     return D->getGlobalID();
4988 
4989   assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
4990   return DeclIDs[D];
4991 }
4992 
4993 void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) {
4994   assert(ID);
4995   assert(D);
4996 
4997   SourceLocation Loc = D->getLocation();
4998   if (Loc.isInvalid())
4999     return;
5000 
5001   // We only keep track of the file-level declarations of each file.
5002   if (!D->getLexicalDeclContext()->isFileContext())
5003     return;
5004   // FIXME: ParmVarDecls that are part of a function type of a parameter of
5005   // a function/objc method, should not have TU as lexical context.
5006   if (isa<ParmVarDecl>(D))
5007     return;
5008 
5009   SourceManager &SM = Context->getSourceManager();
5010   SourceLocation FileLoc = SM.getFileLoc(Loc);
5011   assert(SM.isLocalSourceLocation(FileLoc));
5012   FileID FID;
5013   unsigned Offset;
5014   std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
5015   if (FID.isInvalid())
5016     return;
5017   assert(SM.getSLocEntry(FID).isFile());
5018 
5019   DeclIDInFileInfo *&Info = FileDeclIDs[FID];
5020   if (!Info)
5021     Info = new DeclIDInFileInfo();
5022 
5023   std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID);
5024   LocDeclIDsTy &Decls = Info->DeclIDs;
5025 
5026   if (Decls.empty() || Decls.back().first <= Offset) {
5027     Decls.push_back(LocDecl);
5028     return;
5029   }
5030 
5031   LocDeclIDsTy::iterator I =
5032       std::upper_bound(Decls.begin(), Decls.end(), LocDecl, llvm::less_first());
5033 
5034   Decls.insert(I, LocDecl);
5035 }
5036 
5037 void ASTWriter::AddDeclarationName(DeclarationName Name, RecordDataImpl &Record) {
5038   // FIXME: Emit a stable enum for NameKind.  0 = Identifier etc.
5039   Record.push_back(Name.getNameKind());
5040   switch (Name.getNameKind()) {
5041   case DeclarationName::Identifier:
5042     AddIdentifierRef(Name.getAsIdentifierInfo(), Record);
5043     break;
5044 
5045   case DeclarationName::ObjCZeroArgSelector:
5046   case DeclarationName::ObjCOneArgSelector:
5047   case DeclarationName::ObjCMultiArgSelector:
5048     AddSelectorRef(Name.getObjCSelector(), Record);
5049     break;
5050 
5051   case DeclarationName::CXXConstructorName:
5052   case DeclarationName::CXXDestructorName:
5053   case DeclarationName::CXXConversionFunctionName:
5054     AddTypeRef(Name.getCXXNameType(), Record);
5055     break;
5056 
5057   case DeclarationName::CXXOperatorName:
5058     Record.push_back(Name.getCXXOverloadedOperator());
5059     break;
5060 
5061   case DeclarationName::CXXLiteralOperatorName:
5062     AddIdentifierRef(Name.getCXXLiteralIdentifier(), Record);
5063     break;
5064 
5065   case DeclarationName::CXXUsingDirective:
5066     // No extra data to emit
5067     break;
5068   }
5069 }
5070 
5071 unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) {
5072   assert(needsAnonymousDeclarationNumber(D) &&
5073          "expected an anonymous declaration");
5074 
5075   // Number the anonymous declarations within this context, if we've not
5076   // already done so.
5077   auto It = AnonymousDeclarationNumbers.find(D);
5078   if (It == AnonymousDeclarationNumbers.end()) {
5079     auto *DC = D->getLexicalDeclContext();
5080     numberAnonymousDeclsWithin(DC, [&](const NamedDecl *ND, unsigned Number) {
5081       AnonymousDeclarationNumbers[ND] = Number;
5082     });
5083 
5084     It = AnonymousDeclarationNumbers.find(D);
5085     assert(It != AnonymousDeclarationNumbers.end() &&
5086            "declaration not found within its lexical context");
5087   }
5088 
5089   return It->second;
5090 }
5091 
5092 void ASTWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
5093                                      DeclarationName Name, RecordDataImpl &Record) {
5094   switch (Name.getNameKind()) {
5095   case DeclarationName::CXXConstructorName:
5096   case DeclarationName::CXXDestructorName:
5097   case DeclarationName::CXXConversionFunctionName:
5098     AddTypeSourceInfo(DNLoc.NamedType.TInfo, Record);
5099     break;
5100 
5101   case DeclarationName::CXXOperatorName:
5102     AddSourceLocation(
5103        SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.BeginOpNameLoc),
5104        Record);
5105     AddSourceLocation(
5106         SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc),
5107         Record);
5108     break;
5109 
5110   case DeclarationName::CXXLiteralOperatorName:
5111     AddSourceLocation(
5112      SourceLocation::getFromRawEncoding(DNLoc.CXXLiteralOperatorName.OpNameLoc),
5113      Record);
5114     break;
5115 
5116   case DeclarationName::Identifier:
5117   case DeclarationName::ObjCZeroArgSelector:
5118   case DeclarationName::ObjCOneArgSelector:
5119   case DeclarationName::ObjCMultiArgSelector:
5120   case DeclarationName::CXXUsingDirective:
5121     break;
5122   }
5123 }
5124 
5125 void ASTWriter::AddDeclarationNameInfo(const DeclarationNameInfo &NameInfo,
5126                                        RecordDataImpl &Record) {
5127   AddDeclarationName(NameInfo.getName(), Record);
5128   AddSourceLocation(NameInfo.getLoc(), Record);
5129   AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName(), Record);
5130 }
5131 
5132 void ASTWriter::AddQualifierInfo(const QualifierInfo &Info,
5133                                  RecordDataImpl &Record) {
5134   AddNestedNameSpecifierLoc(Info.QualifierLoc, Record);
5135   Record.push_back(Info.NumTemplParamLists);
5136   for (unsigned i=0, e=Info.NumTemplParamLists; i != e; ++i)
5137     AddTemplateParameterList(Info.TemplParamLists[i], Record);
5138 }
5139 
5140 void ASTWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS,
5141                                        RecordDataImpl &Record) {
5142   // Nested name specifiers usually aren't too long. I think that 8 would
5143   // typically accommodate the vast majority.
5144   SmallVector<NestedNameSpecifier *, 8> NestedNames;
5145 
5146   // Push each of the NNS's onto a stack for serialization in reverse order.
5147   while (NNS) {
5148     NestedNames.push_back(NNS);
5149     NNS = NNS->getPrefix();
5150   }
5151 
5152   Record.push_back(NestedNames.size());
5153   while(!NestedNames.empty()) {
5154     NNS = NestedNames.pop_back_val();
5155     NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
5156     Record.push_back(Kind);
5157     switch (Kind) {
5158     case NestedNameSpecifier::Identifier:
5159       AddIdentifierRef(NNS->getAsIdentifier(), Record);
5160       break;
5161 
5162     case NestedNameSpecifier::Namespace:
5163       AddDeclRef(NNS->getAsNamespace(), Record);
5164       break;
5165 
5166     case NestedNameSpecifier::NamespaceAlias:
5167       AddDeclRef(NNS->getAsNamespaceAlias(), Record);
5168       break;
5169 
5170     case NestedNameSpecifier::TypeSpec:
5171     case NestedNameSpecifier::TypeSpecWithTemplate:
5172       AddTypeRef(QualType(NNS->getAsType(), 0), Record);
5173       Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5174       break;
5175 
5176     case NestedNameSpecifier::Global:
5177       // Don't need to write an associated value.
5178       break;
5179 
5180     case NestedNameSpecifier::Super:
5181       AddDeclRef(NNS->getAsRecordDecl(), Record);
5182       break;
5183     }
5184   }
5185 }
5186 
5187 void ASTWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS,
5188                                           RecordDataImpl &Record) {
5189   // Nested name specifiers usually aren't too long. I think that 8 would
5190   // typically accommodate the vast majority.
5191   SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
5192 
5193   // Push each of the nested-name-specifiers's onto a stack for
5194   // serialization in reverse order.
5195   while (NNS) {
5196     NestedNames.push_back(NNS);
5197     NNS = NNS.getPrefix();
5198   }
5199 
5200   Record.push_back(NestedNames.size());
5201   while(!NestedNames.empty()) {
5202     NNS = NestedNames.pop_back_val();
5203     NestedNameSpecifier::SpecifierKind Kind
5204       = NNS.getNestedNameSpecifier()->getKind();
5205     Record.push_back(Kind);
5206     switch (Kind) {
5207     case NestedNameSpecifier::Identifier:
5208       AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier(), Record);
5209       AddSourceRange(NNS.getLocalSourceRange(), Record);
5210       break;
5211 
5212     case NestedNameSpecifier::Namespace:
5213       AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace(), Record);
5214       AddSourceRange(NNS.getLocalSourceRange(), Record);
5215       break;
5216 
5217     case NestedNameSpecifier::NamespaceAlias:
5218       AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias(), Record);
5219       AddSourceRange(NNS.getLocalSourceRange(), Record);
5220       break;
5221 
5222     case NestedNameSpecifier::TypeSpec:
5223     case NestedNameSpecifier::TypeSpecWithTemplate:
5224       Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5225       AddTypeLoc(NNS.getTypeLoc(), Record);
5226       AddSourceLocation(NNS.getLocalSourceRange().getEnd(), Record);
5227       break;
5228 
5229     case NestedNameSpecifier::Global:
5230       AddSourceLocation(NNS.getLocalSourceRange().getEnd(), Record);
5231       break;
5232 
5233     case NestedNameSpecifier::Super:
5234       AddDeclRef(NNS.getNestedNameSpecifier()->getAsRecordDecl(), Record);
5235       AddSourceRange(NNS.getLocalSourceRange(), Record);
5236       break;
5237     }
5238   }
5239 }
5240 
5241 void ASTWriter::AddTemplateName(TemplateName Name, RecordDataImpl &Record) {
5242   TemplateName::NameKind Kind = Name.getKind();
5243   Record.push_back(Kind);
5244   switch (Kind) {
5245   case TemplateName::Template:
5246     AddDeclRef(Name.getAsTemplateDecl(), Record);
5247     break;
5248 
5249   case TemplateName::OverloadedTemplate: {
5250     OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
5251     Record.push_back(OvT->size());
5252     for (OverloadedTemplateStorage::iterator I = OvT->begin(), E = OvT->end();
5253            I != E; ++I)
5254       AddDeclRef(*I, Record);
5255     break;
5256   }
5257 
5258   case TemplateName::QualifiedTemplate: {
5259     QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
5260     AddNestedNameSpecifier(QualT->getQualifier(), Record);
5261     Record.push_back(QualT->hasTemplateKeyword());
5262     AddDeclRef(QualT->getTemplateDecl(), Record);
5263     break;
5264   }
5265 
5266   case TemplateName::DependentTemplate: {
5267     DependentTemplateName *DepT = Name.getAsDependentTemplateName();
5268     AddNestedNameSpecifier(DepT->getQualifier(), Record);
5269     Record.push_back(DepT->isIdentifier());
5270     if (DepT->isIdentifier())
5271       AddIdentifierRef(DepT->getIdentifier(), Record);
5272     else
5273       Record.push_back(DepT->getOperator());
5274     break;
5275   }
5276 
5277   case TemplateName::SubstTemplateTemplateParm: {
5278     SubstTemplateTemplateParmStorage *subst
5279       = Name.getAsSubstTemplateTemplateParm();
5280     AddDeclRef(subst->getParameter(), Record);
5281     AddTemplateName(subst->getReplacement(), Record);
5282     break;
5283   }
5284 
5285   case TemplateName::SubstTemplateTemplateParmPack: {
5286     SubstTemplateTemplateParmPackStorage *SubstPack
5287       = Name.getAsSubstTemplateTemplateParmPack();
5288     AddDeclRef(SubstPack->getParameterPack(), Record);
5289     AddTemplateArgument(SubstPack->getArgumentPack(), Record);
5290     break;
5291   }
5292   }
5293 }
5294 
5295 void ASTWriter::AddTemplateArgument(const TemplateArgument &Arg,
5296                                     RecordDataImpl &Record) {
5297   Record.push_back(Arg.getKind());
5298   switch (Arg.getKind()) {
5299   case TemplateArgument::Null:
5300     break;
5301   case TemplateArgument::Type:
5302     AddTypeRef(Arg.getAsType(), Record);
5303     break;
5304   case TemplateArgument::Declaration:
5305     AddDeclRef(Arg.getAsDecl(), Record);
5306     AddTypeRef(Arg.getParamTypeForDecl(), Record);
5307     break;
5308   case TemplateArgument::NullPtr:
5309     AddTypeRef(Arg.getNullPtrType(), Record);
5310     break;
5311   case TemplateArgument::Integral:
5312     AddAPSInt(Arg.getAsIntegral(), Record);
5313     AddTypeRef(Arg.getIntegralType(), Record);
5314     break;
5315   case TemplateArgument::Template:
5316     AddTemplateName(Arg.getAsTemplateOrTemplatePattern(), Record);
5317     break;
5318   case TemplateArgument::TemplateExpansion:
5319     AddTemplateName(Arg.getAsTemplateOrTemplatePattern(), Record);
5320     if (Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions())
5321       Record.push_back(*NumExpansions + 1);
5322     else
5323       Record.push_back(0);
5324     break;
5325   case TemplateArgument::Expression:
5326     AddStmt(Arg.getAsExpr());
5327     break;
5328   case TemplateArgument::Pack:
5329     Record.push_back(Arg.pack_size());
5330     for (const auto &P : Arg.pack_elements())
5331       AddTemplateArgument(P, Record);
5332     break;
5333   }
5334 }
5335 
5336 void
5337 ASTWriter::AddTemplateParameterList(const TemplateParameterList *TemplateParams,
5338                                     RecordDataImpl &Record) {
5339   assert(TemplateParams && "No TemplateParams!");
5340   AddSourceLocation(TemplateParams->getTemplateLoc(), Record);
5341   AddSourceLocation(TemplateParams->getLAngleLoc(), Record);
5342   AddSourceLocation(TemplateParams->getRAngleLoc(), Record);
5343   Record.push_back(TemplateParams->size());
5344   for (TemplateParameterList::const_iterator
5345          P = TemplateParams->begin(), PEnd = TemplateParams->end();
5346          P != PEnd; ++P)
5347     AddDeclRef(*P, Record);
5348 }
5349 
5350 /// \brief Emit a template argument list.
5351 void
5352 ASTWriter::AddTemplateArgumentList(const TemplateArgumentList *TemplateArgs,
5353                                    RecordDataImpl &Record) {
5354   assert(TemplateArgs && "No TemplateArgs!");
5355   Record.push_back(TemplateArgs->size());
5356   for (int i=0, e = TemplateArgs->size(); i != e; ++i)
5357     AddTemplateArgument(TemplateArgs->get(i), Record);
5358 }
5359 
5360 void
5361 ASTWriter::AddASTTemplateArgumentListInfo
5362 (const ASTTemplateArgumentListInfo *ASTTemplArgList, RecordDataImpl &Record) {
5363   assert(ASTTemplArgList && "No ASTTemplArgList!");
5364   AddSourceLocation(ASTTemplArgList->LAngleLoc, Record);
5365   AddSourceLocation(ASTTemplArgList->RAngleLoc, Record);
5366   Record.push_back(ASTTemplArgList->NumTemplateArgs);
5367   const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
5368   for (int i=0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
5369     AddTemplateArgumentLoc(TemplArgs[i], Record);
5370 }
5371 
5372 void
5373 ASTWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set, RecordDataImpl &Record) {
5374   Record.push_back(Set.size());
5375   for (ASTUnresolvedSet::const_iterator
5376          I = Set.begin(), E = Set.end(); I != E; ++I) {
5377     AddDeclRef(I.getDecl(), Record);
5378     Record.push_back(I.getAccess());
5379   }
5380 }
5381 
5382 void ASTWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base,
5383                                     RecordDataImpl &Record) {
5384   Record.push_back(Base.isVirtual());
5385   Record.push_back(Base.isBaseOfClass());
5386   Record.push_back(Base.getAccessSpecifierAsWritten());
5387   Record.push_back(Base.getInheritConstructors());
5388   AddTypeSourceInfo(Base.getTypeSourceInfo(), Record);
5389   AddSourceRange(Base.getSourceRange(), Record);
5390   AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
5391                                           : SourceLocation(),
5392                     Record);
5393 }
5394 
5395 void ASTWriter::FlushCXXBaseSpecifiers() {
5396   RecordData Record;
5397   unsigned N = CXXBaseSpecifiersToWrite.size();
5398   for (unsigned I = 0; I != N; ++I) {
5399     Record.clear();
5400 
5401     // Record the offset of this base-specifier set.
5402     unsigned Index = CXXBaseSpecifiersToWrite[I].ID - 1;
5403     if (Index == CXXBaseSpecifiersOffsets.size())
5404       CXXBaseSpecifiersOffsets.push_back(Stream.GetCurrentBitNo());
5405     else {
5406       if (Index > CXXBaseSpecifiersOffsets.size())
5407         CXXBaseSpecifiersOffsets.resize(Index + 1);
5408       CXXBaseSpecifiersOffsets[Index] = Stream.GetCurrentBitNo();
5409     }
5410 
5411     const CXXBaseSpecifier *B = CXXBaseSpecifiersToWrite[I].Bases,
5412                         *BEnd = CXXBaseSpecifiersToWrite[I].BasesEnd;
5413     Record.push_back(BEnd - B);
5414     for (; B != BEnd; ++B)
5415       AddCXXBaseSpecifier(*B, Record);
5416     Stream.EmitRecord(serialization::DECL_CXX_BASE_SPECIFIERS, Record);
5417 
5418     // Flush any expressions that were written as part of the base specifiers.
5419     FlushStmts();
5420   }
5421 
5422   assert(N == CXXBaseSpecifiersToWrite.size() &&
5423          "added more base specifiers while writing base specifiers");
5424   CXXBaseSpecifiersToWrite.clear();
5425 }
5426 
5427 void ASTWriter::AddCXXCtorInitializers(
5428                              const CXXCtorInitializer * const *CtorInitializers,
5429                              unsigned NumCtorInitializers,
5430                              RecordDataImpl &Record) {
5431   Record.push_back(NumCtorInitializers);
5432   for (unsigned i=0; i != NumCtorInitializers; ++i) {
5433     const CXXCtorInitializer *Init = CtorInitializers[i];
5434 
5435     if (Init->isBaseInitializer()) {
5436       Record.push_back(CTOR_INITIALIZER_BASE);
5437       AddTypeSourceInfo(Init->getTypeSourceInfo(), Record);
5438       Record.push_back(Init->isBaseVirtual());
5439     } else if (Init->isDelegatingInitializer()) {
5440       Record.push_back(CTOR_INITIALIZER_DELEGATING);
5441       AddTypeSourceInfo(Init->getTypeSourceInfo(), Record);
5442     } else if (Init->isMemberInitializer()){
5443       Record.push_back(CTOR_INITIALIZER_MEMBER);
5444       AddDeclRef(Init->getMember(), Record);
5445     } else {
5446       Record.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER);
5447       AddDeclRef(Init->getIndirectMember(), Record);
5448     }
5449 
5450     AddSourceLocation(Init->getMemberLocation(), Record);
5451     AddStmt(Init->getInit());
5452     AddSourceLocation(Init->getLParenLoc(), Record);
5453     AddSourceLocation(Init->getRParenLoc(), Record);
5454     Record.push_back(Init->isWritten());
5455     if (Init->isWritten()) {
5456       Record.push_back(Init->getSourceOrder());
5457     } else {
5458       Record.push_back(Init->getNumArrayIndices());
5459       for (unsigned i=0, e=Init->getNumArrayIndices(); i != e; ++i)
5460         AddDeclRef(Init->getArrayIndex(i), Record);
5461     }
5462   }
5463 }
5464 
5465 void ASTWriter::FlushCXXCtorInitializers() {
5466   RecordData Record;
5467 
5468   unsigned N = CXXCtorInitializersToWrite.size();
5469   (void)N; // Silence unused warning in non-assert builds.
5470   for (auto &Init : CXXCtorInitializersToWrite) {
5471     Record.clear();
5472 
5473     // Record the offset of this mem-initializer list.
5474     unsigned Index = Init.ID - 1;
5475     if (Index == CXXCtorInitializersOffsets.size())
5476       CXXCtorInitializersOffsets.push_back(Stream.GetCurrentBitNo());
5477     else {
5478       if (Index > CXXCtorInitializersOffsets.size())
5479         CXXCtorInitializersOffsets.resize(Index + 1);
5480       CXXCtorInitializersOffsets[Index] = Stream.GetCurrentBitNo();
5481     }
5482 
5483     AddCXXCtorInitializers(Init.Inits.data(), Init.Inits.size(), Record);
5484     Stream.EmitRecord(serialization::DECL_CXX_CTOR_INITIALIZERS, Record);
5485 
5486     // Flush any expressions that were written as part of the initializers.
5487     FlushStmts();
5488   }
5489 
5490   assert(N == CXXCtorInitializersToWrite.size() &&
5491          "added more ctor initializers while writing ctor initializers");
5492   CXXCtorInitializersToWrite.clear();
5493 }
5494 
5495 void ASTWriter::AddCXXDefinitionData(const CXXRecordDecl *D, RecordDataImpl &Record) {
5496   auto &Data = D->data();
5497   Record.push_back(Data.IsLambda);
5498   Record.push_back(Data.UserDeclaredConstructor);
5499   Record.push_back(Data.UserDeclaredSpecialMembers);
5500   Record.push_back(Data.Aggregate);
5501   Record.push_back(Data.PlainOldData);
5502   Record.push_back(Data.Empty);
5503   Record.push_back(Data.Polymorphic);
5504   Record.push_back(Data.Abstract);
5505   Record.push_back(Data.IsStandardLayout);
5506   Record.push_back(Data.HasNoNonEmptyBases);
5507   Record.push_back(Data.HasPrivateFields);
5508   Record.push_back(Data.HasProtectedFields);
5509   Record.push_back(Data.HasPublicFields);
5510   Record.push_back(Data.HasMutableFields);
5511   Record.push_back(Data.HasVariantMembers);
5512   Record.push_back(Data.HasOnlyCMembers);
5513   Record.push_back(Data.HasInClassInitializer);
5514   Record.push_back(Data.HasUninitializedReferenceMember);
5515   Record.push_back(Data.NeedOverloadResolutionForMoveConstructor);
5516   Record.push_back(Data.NeedOverloadResolutionForMoveAssignment);
5517   Record.push_back(Data.NeedOverloadResolutionForDestructor);
5518   Record.push_back(Data.DefaultedMoveConstructorIsDeleted);
5519   Record.push_back(Data.DefaultedMoveAssignmentIsDeleted);
5520   Record.push_back(Data.DefaultedDestructorIsDeleted);
5521   Record.push_back(Data.HasTrivialSpecialMembers);
5522   Record.push_back(Data.DeclaredNonTrivialSpecialMembers);
5523   Record.push_back(Data.HasIrrelevantDestructor);
5524   Record.push_back(Data.HasConstexprNonCopyMoveConstructor);
5525   Record.push_back(Data.DefaultedDefaultConstructorIsConstexpr);
5526   Record.push_back(Data.HasConstexprDefaultConstructor);
5527   Record.push_back(Data.HasNonLiteralTypeFieldsOrBases);
5528   Record.push_back(Data.ComputedVisibleConversions);
5529   Record.push_back(Data.UserProvidedDefaultConstructor);
5530   Record.push_back(Data.DeclaredSpecialMembers);
5531   Record.push_back(Data.ImplicitCopyConstructorHasConstParam);
5532   Record.push_back(Data.ImplicitCopyAssignmentHasConstParam);
5533   Record.push_back(Data.HasDeclaredCopyConstructorWithConstParam);
5534   Record.push_back(Data.HasDeclaredCopyAssignmentWithConstParam);
5535   // IsLambda bit is already saved.
5536 
5537   Record.push_back(Data.NumBases);
5538   if (Data.NumBases > 0)
5539     AddCXXBaseSpecifiersRef(Data.getBases(), Data.getBases() + Data.NumBases,
5540                             Record);
5541 
5542   // FIXME: Make VBases lazily computed when needed to avoid storing them.
5543   Record.push_back(Data.NumVBases);
5544   if (Data.NumVBases > 0)
5545     AddCXXBaseSpecifiersRef(Data.getVBases(), Data.getVBases() + Data.NumVBases,
5546                             Record);
5547 
5548   AddUnresolvedSet(Data.Conversions.get(*Context), Record);
5549   AddUnresolvedSet(Data.VisibleConversions.get(*Context), Record);
5550   // Data.Definition is the owning decl, no need to write it.
5551   AddDeclRef(D->getFirstFriend(), Record);
5552 
5553   // Add lambda-specific data.
5554   if (Data.IsLambda) {
5555     auto &Lambda = D->getLambdaData();
5556     Record.push_back(Lambda.Dependent);
5557     Record.push_back(Lambda.IsGenericLambda);
5558     Record.push_back(Lambda.CaptureDefault);
5559     Record.push_back(Lambda.NumCaptures);
5560     Record.push_back(Lambda.NumExplicitCaptures);
5561     Record.push_back(Lambda.ManglingNumber);
5562     AddDeclRef(Lambda.ContextDecl, Record);
5563     AddTypeSourceInfo(Lambda.MethodTyInfo, Record);
5564     for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
5565       const LambdaCapture &Capture = Lambda.Captures[I];
5566       AddSourceLocation(Capture.getLocation(), Record);
5567       Record.push_back(Capture.isImplicit());
5568       Record.push_back(Capture.getCaptureKind());
5569       switch (Capture.getCaptureKind()) {
5570       case LCK_This:
5571       case LCK_VLAType:
5572         break;
5573       case LCK_ByCopy:
5574       case LCK_ByRef:
5575         VarDecl *Var =
5576             Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
5577         AddDeclRef(Var, Record);
5578         AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc()
5579                                                     : SourceLocation(),
5580                           Record);
5581         break;
5582       }
5583     }
5584   }
5585 }
5586 
5587 void ASTWriter::ReaderInitialized(ASTReader *Reader) {
5588   assert(Reader && "Cannot remove chain");
5589   assert((!Chain || Chain == Reader) && "Cannot replace chain");
5590   assert(FirstDeclID == NextDeclID &&
5591          FirstTypeID == NextTypeID &&
5592          FirstIdentID == NextIdentID &&
5593          FirstMacroID == NextMacroID &&
5594          FirstSubmoduleID == NextSubmoduleID &&
5595          FirstSelectorID == NextSelectorID &&
5596          "Setting chain after writing has started.");
5597 
5598   Chain = Reader;
5599 
5600   // Note, this will get called multiple times, once one the reader starts up
5601   // and again each time it's done reading a PCH or module.
5602   FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls();
5603   FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes();
5604   FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers();
5605   FirstMacroID = NUM_PREDEF_MACRO_IDS + Chain->getTotalNumMacros();
5606   FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
5607   FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
5608   NextDeclID = FirstDeclID;
5609   NextTypeID = FirstTypeID;
5610   NextIdentID = FirstIdentID;
5611   NextMacroID = FirstMacroID;
5612   NextSelectorID = FirstSelectorID;
5613   NextSubmoduleID = FirstSubmoduleID;
5614 }
5615 
5616 void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
5617   // Always keep the highest ID. See \p TypeRead() for more information.
5618   IdentID &StoredID = IdentifierIDs[II];
5619   if (ID > StoredID)
5620     StoredID = ID;
5621 }
5622 
5623 void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
5624   // Always keep the highest ID. See \p TypeRead() for more information.
5625   MacroID &StoredID = MacroIDs[MI];
5626   if (ID > StoredID)
5627     StoredID = ID;
5628 }
5629 
5630 void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
5631   // Always take the highest-numbered type index. This copes with an interesting
5632   // case for chained AST writing where we schedule writing the type and then,
5633   // later, deserialize the type from another AST. In this case, we want to
5634   // keep the higher-numbered entry so that we can properly write it out to
5635   // the AST file.
5636   TypeIdx &StoredIdx = TypeIdxs[T];
5637   if (Idx.getIndex() >= StoredIdx.getIndex())
5638     StoredIdx = Idx;
5639 }
5640 
5641 void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
5642   // Always keep the highest ID. See \p TypeRead() for more information.
5643   SelectorID &StoredID = SelectorIDs[S];
5644   if (ID > StoredID)
5645     StoredID = ID;
5646 }
5647 
5648 void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
5649                                     MacroDefinitionRecord *MD) {
5650   assert(MacroDefinitions.find(MD) == MacroDefinitions.end());
5651   MacroDefinitions[MD] = ID;
5652 }
5653 
5654 void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
5655   assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end());
5656   SubmoduleIDs[Mod] = ID;
5657 }
5658 
5659 void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
5660   assert(D->isCompleteDefinition());
5661   assert(!WritingAST && "Already writing the AST!");
5662   if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
5663     // We are interested when a PCH decl is modified.
5664     if (RD->isFromASTFile()) {
5665       // A forward reference was mutated into a definition. Rewrite it.
5666       // FIXME: This happens during template instantiation, should we
5667       // have created a new definition decl instead ?
5668       assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
5669              "completed a tag from another module but not by instantiation?");
5670       DeclUpdates[RD].push_back(
5671           DeclUpdate(UPD_CXX_INSTANTIATED_CLASS_DEFINITION));
5672     }
5673   }
5674 }
5675 
5676 static bool isImportedDeclContext(ASTReader *Chain, const Decl *D) {
5677   if (D->isFromASTFile())
5678     return true;
5679 
5680   // If we've not loaded any modules, this can't be imported.
5681   if (!Chain || !Chain->getModuleManager().size())
5682     return false;
5683 
5684   // The predefined __va_list_tag struct is imported if we imported any decls.
5685   // FIXME: This is a gross hack.
5686   return D == D->getASTContext().getVaListTagDecl();
5687 }
5688 
5689 void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
5690   // TU and namespaces are handled elsewhere.
5691   if (isa<TranslationUnitDecl>(DC) || isa<NamespaceDecl>(DC))
5692     return;
5693 
5694   // We're only interested in cases where a local declaration is added to an
5695   // imported context.
5696   if (D->isFromASTFile() || !isImportedDeclContext(Chain, cast<Decl>(DC)))
5697     return;
5698 
5699   assert(DC == DC->getPrimaryContext() && "added to non-primary context");
5700   assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
5701   assert(!WritingAST && "Already writing the AST!");
5702   if (UpdatedDeclContexts.insert(DC) && !cast<Decl>(DC)->isFromASTFile()) {
5703     // We're adding a visible declaration to a predefined decl context. Ensure
5704     // that we write out all of its lookup results so we don't get a nasty
5705     // surprise when we try to emit its lookup table.
5706     for (auto *Child : DC->decls())
5707       UpdatingVisibleDecls.push_back(Child);
5708   }
5709   UpdatingVisibleDecls.push_back(D);
5710 }
5711 
5712 void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
5713   assert(D->isImplicit());
5714 
5715   // We're only interested in cases where a local declaration is added to an
5716   // imported context.
5717   if (D->isFromASTFile() || !isImportedDeclContext(Chain, RD))
5718     return;
5719 
5720   if (!isa<CXXMethodDecl>(D))
5721     return;
5722 
5723   // A decl coming from PCH was modified.
5724   assert(RD->isCompleteDefinition());
5725   assert(!WritingAST && "Already writing the AST!");
5726   DeclUpdates[RD].push_back(DeclUpdate(UPD_CXX_ADDED_IMPLICIT_MEMBER, D));
5727 }
5728 
5729 void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
5730   assert(!DoneWritingDeclsAndTypes && "Already done writing updates!");
5731   if (!Chain) return;
5732   Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
5733     // If we don't already know the exception specification for this redecl
5734     // chain, add an update record for it.
5735     if (isUnresolvedExceptionSpec(cast<FunctionDecl>(D)
5736                                       ->getType()
5737                                       ->castAs<FunctionProtoType>()
5738                                       ->getExceptionSpecType()))
5739       DeclUpdates[D].push_back(UPD_CXX_RESOLVED_EXCEPTION_SPEC);
5740   });
5741 }
5742 
5743 void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
5744   assert(!WritingAST && "Already writing the AST!");
5745   if (!Chain) return;
5746   Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
5747     DeclUpdates[D].push_back(
5748         DeclUpdate(UPD_CXX_DEDUCED_RETURN_TYPE, ReturnType));
5749   });
5750 }
5751 
5752 void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD,
5753                                        const FunctionDecl *Delete) {
5754   assert(!WritingAST && "Already writing the AST!");
5755   assert(Delete && "Not given an operator delete");
5756   if (!Chain) return;
5757   Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
5758     DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_RESOLVED_DTOR_DELETE, Delete));
5759   });
5760 }
5761 
5762 void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
5763   assert(!WritingAST && "Already writing the AST!");
5764   if (!D->isFromASTFile())
5765     return; // Declaration not imported from PCH.
5766 
5767   // Implicit function decl from a PCH was defined.
5768   DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
5769 }
5770 
5771 void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
5772   assert(!WritingAST && "Already writing the AST!");
5773   if (!D->isFromASTFile())
5774     return;
5775 
5776   DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
5777 }
5778 
5779 void ASTWriter::StaticDataMemberInstantiated(const VarDecl *D) {
5780   assert(!WritingAST && "Already writing the AST!");
5781   if (!D->isFromASTFile())
5782     return;
5783 
5784   // Since the actual instantiation is delayed, this really means that we need
5785   // to update the instantiation location.
5786   DeclUpdates[D].push_back(
5787       DeclUpdate(UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER,
5788        D->getMemberSpecializationInfo()->getPointOfInstantiation()));
5789 }
5790 
5791 void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
5792                                              const ObjCInterfaceDecl *IFD) {
5793   assert(!WritingAST && "Already writing the AST!");
5794   if (!IFD->isFromASTFile())
5795     return; // Declaration not imported from PCH.
5796 
5797   assert(IFD->getDefinition() && "Category on a class without a definition?");
5798   ObjCClassesWithCategories.insert(
5799     const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
5800 }
5801 
5802 void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
5803   assert(!WritingAST && "Already writing the AST!");
5804   if (!D->isFromASTFile())
5805     return;
5806 
5807   DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_USED));
5808 }
5809 
5810 void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
5811   assert(!WritingAST && "Already writing the AST!");
5812   if (!D->isFromASTFile())
5813     return;
5814 
5815   DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_THREADPRIVATE));
5816 }
5817 
5818 void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) {
5819   assert(!WritingAST && "Already writing the AST!");
5820   assert(D->isHidden() && "expected a hidden declaration");
5821   DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_EXPORTED, M));
5822 }
5823 
5824 void ASTWriter::AddedAttributeToRecord(const Attr *Attr,
5825                                        const RecordDecl *Record) {
5826   assert(!WritingAST && "Already writing the AST!");
5827   if (!Record->isFromASTFile())
5828     return;
5829   DeclUpdates[Record].push_back(DeclUpdate(UPD_ADDED_ATTR_TO_RECORD, Attr));
5830 }
5831