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