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