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