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