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(LOCAL_REDECLARATIONS);
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   RECORD(OBJC_CHAINED_CATEGORIES);
802   RECORD(FILE_SORTED_DECLS);
803   RECORD(IMPORTED_MODULES);
804 
805   // SourceManager Block.
806   BLOCK(SOURCE_MANAGER_BLOCK);
807   RECORD(SM_SLOC_FILE_ENTRY);
808   RECORD(SM_SLOC_BUFFER_ENTRY);
809   RECORD(SM_SLOC_BUFFER_BLOB);
810   RECORD(SM_SLOC_EXPANSION_ENTRY);
811 
812   // Preprocessor Block.
813   BLOCK(PREPROCESSOR_BLOCK);
814   RECORD(PP_MACRO_OBJECT_LIKE);
815   RECORD(PP_MACRO_FUNCTION_LIKE);
816   RECORD(PP_TOKEN);
817 
818   // Decls and Types block.
819   BLOCK(DECLTYPES_BLOCK);
820   RECORD(TYPE_EXT_QUAL);
821   RECORD(TYPE_COMPLEX);
822   RECORD(TYPE_POINTER);
823   RECORD(TYPE_BLOCK_POINTER);
824   RECORD(TYPE_LVALUE_REFERENCE);
825   RECORD(TYPE_RVALUE_REFERENCE);
826   RECORD(TYPE_MEMBER_POINTER);
827   RECORD(TYPE_CONSTANT_ARRAY);
828   RECORD(TYPE_INCOMPLETE_ARRAY);
829   RECORD(TYPE_VARIABLE_ARRAY);
830   RECORD(TYPE_VECTOR);
831   RECORD(TYPE_EXT_VECTOR);
832   RECORD(TYPE_FUNCTION_PROTO);
833   RECORD(TYPE_FUNCTION_NO_PROTO);
834   RECORD(TYPE_TYPEDEF);
835   RECORD(TYPE_TYPEOF_EXPR);
836   RECORD(TYPE_TYPEOF);
837   RECORD(TYPE_RECORD);
838   RECORD(TYPE_ENUM);
839   RECORD(TYPE_OBJC_INTERFACE);
840   RECORD(TYPE_OBJC_OBJECT);
841   RECORD(TYPE_OBJC_OBJECT_POINTER);
842   RECORD(TYPE_DECLTYPE);
843   RECORD(TYPE_ELABORATED);
844   RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
845   RECORD(TYPE_UNRESOLVED_USING);
846   RECORD(TYPE_INJECTED_CLASS_NAME);
847   RECORD(TYPE_OBJC_OBJECT);
848   RECORD(TYPE_TEMPLATE_TYPE_PARM);
849   RECORD(TYPE_TEMPLATE_SPECIALIZATION);
850   RECORD(TYPE_DEPENDENT_NAME);
851   RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION);
852   RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
853   RECORD(TYPE_PAREN);
854   RECORD(TYPE_PACK_EXPANSION);
855   RECORD(TYPE_ATTRIBUTED);
856   RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
857   RECORD(TYPE_ATOMIC);
858   RECORD(DECL_TYPEDEF);
859   RECORD(DECL_ENUM);
860   RECORD(DECL_RECORD);
861   RECORD(DECL_ENUM_CONSTANT);
862   RECORD(DECL_FUNCTION);
863   RECORD(DECL_OBJC_METHOD);
864   RECORD(DECL_OBJC_INTERFACE);
865   RECORD(DECL_OBJC_PROTOCOL);
866   RECORD(DECL_OBJC_IVAR);
867   RECORD(DECL_OBJC_AT_DEFS_FIELD);
868   RECORD(DECL_OBJC_CLASS);
869   RECORD(DECL_OBJC_FORWARD_PROTOCOL);
870   RECORD(DECL_OBJC_CATEGORY);
871   RECORD(DECL_OBJC_CATEGORY_IMPL);
872   RECORD(DECL_OBJC_IMPLEMENTATION);
873   RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
874   RECORD(DECL_OBJC_PROPERTY);
875   RECORD(DECL_OBJC_PROPERTY_IMPL);
876   RECORD(DECL_FIELD);
877   RECORD(DECL_VAR);
878   RECORD(DECL_IMPLICIT_PARAM);
879   RECORD(DECL_PARM_VAR);
880   RECORD(DECL_FILE_SCOPE_ASM);
881   RECORD(DECL_BLOCK);
882   RECORD(DECL_CONTEXT_LEXICAL);
883   RECORD(DECL_CONTEXT_VISIBLE);
884   RECORD(DECL_NAMESPACE);
885   RECORD(DECL_NAMESPACE_ALIAS);
886   RECORD(DECL_USING);
887   RECORD(DECL_USING_SHADOW);
888   RECORD(DECL_USING_DIRECTIVE);
889   RECORD(DECL_UNRESOLVED_USING_VALUE);
890   RECORD(DECL_UNRESOLVED_USING_TYPENAME);
891   RECORD(DECL_LINKAGE_SPEC);
892   RECORD(DECL_CXX_RECORD);
893   RECORD(DECL_CXX_METHOD);
894   RECORD(DECL_CXX_CONSTRUCTOR);
895   RECORD(DECL_CXX_DESTRUCTOR);
896   RECORD(DECL_CXX_CONVERSION);
897   RECORD(DECL_ACCESS_SPEC);
898   RECORD(DECL_FRIEND);
899   RECORD(DECL_FRIEND_TEMPLATE);
900   RECORD(DECL_CLASS_TEMPLATE);
901   RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
902   RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
903   RECORD(DECL_FUNCTION_TEMPLATE);
904   RECORD(DECL_TEMPLATE_TYPE_PARM);
905   RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
906   RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
907   RECORD(DECL_STATIC_ASSERT);
908   RECORD(DECL_CXX_BASE_SPECIFIERS);
909   RECORD(DECL_INDIRECTFIELD);
910   RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
911 
912   // Statements and Exprs can occur in the Decls and Types block.
913   AddStmtsExprs(Stream, Record);
914 
915   BLOCK(PREPROCESSOR_DETAIL_BLOCK);
916   RECORD(PPD_MACRO_EXPANSION);
917   RECORD(PPD_MACRO_DEFINITION);
918   RECORD(PPD_INCLUSION_DIRECTIVE);
919 
920 #undef RECORD
921 #undef BLOCK
922   Stream.ExitBlock();
923 }
924 
925 /// \brief Adjusts the given filename to only write out the portion of the
926 /// filename that is not part of the system root directory.
927 ///
928 /// \param Filename the file name to adjust.
929 ///
930 /// \param isysroot When non-NULL, the PCH file is a relocatable PCH file and
931 /// the returned filename will be adjusted by this system root.
932 ///
933 /// \returns either the original filename (if it needs no adjustment) or the
934 /// adjusted filename (which points into the @p Filename parameter).
935 static const char *
936 adjustFilenameForRelocatablePCH(const char *Filename, StringRef isysroot) {
937   assert(Filename && "No file name to adjust?");
938 
939   if (isysroot.empty())
940     return Filename;
941 
942   // Verify that the filename and the system root have the same prefix.
943   unsigned Pos = 0;
944   for (; Filename[Pos] && Pos < isysroot.size(); ++Pos)
945     if (Filename[Pos] != isysroot[Pos])
946       return Filename; // Prefixes don't match.
947 
948   // We hit the end of the filename before we hit the end of the system root.
949   if (!Filename[Pos])
950     return Filename;
951 
952   // If the file name has a '/' at the current position, skip over the '/'.
953   // We distinguish sysroot-based includes from absolute includes by the
954   // absence of '/' at the beginning of sysroot-based includes.
955   if (Filename[Pos] == '/')
956     ++Pos;
957 
958   return Filename + Pos;
959 }
960 
961 /// \brief Write the AST metadata (e.g., i686-apple-darwin9).
962 void ASTWriter::WriteMetadata(ASTContext &Context, StringRef isysroot,
963                               const std::string &OutputFile) {
964   using namespace llvm;
965 
966   // Metadata
967   const TargetInfo &Target = Context.getTargetInfo();
968   BitCodeAbbrev *MetaAbbrev = new BitCodeAbbrev();
969   MetaAbbrev->Add(BitCodeAbbrevOp(METADATA));
970   MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // AST major
971   MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // AST minor
972   MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang major
973   MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang minor
974   MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
975   MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Target triple
976   unsigned MetaAbbrevCode = Stream.EmitAbbrev(MetaAbbrev);
977 
978   RecordData Record;
979   Record.push_back(METADATA);
980   Record.push_back(VERSION_MAJOR);
981   Record.push_back(VERSION_MINOR);
982   Record.push_back(CLANG_VERSION_MAJOR);
983   Record.push_back(CLANG_VERSION_MINOR);
984   Record.push_back(!isysroot.empty());
985   const std::string &Triple = Target.getTriple().getTriple();
986   Stream.EmitRecordWithBlob(MetaAbbrevCode, Record, Triple);
987 
988   if (Chain) {
989     serialization::ModuleManager &Mgr = Chain->getModuleManager();
990     llvm::SmallVector<char, 128> ModulePaths;
991     Record.clear();
992 
993     for (ModuleManager::ModuleIterator M = Mgr.begin(), MEnd = Mgr.end();
994          M != MEnd; ++M) {
995       // Skip modules that weren't directly imported.
996       if (!(*M)->isDirectlyImported())
997         continue;
998 
999       Record.push_back((unsigned)(*M)->Kind); // FIXME: Stable encoding
1000       // FIXME: Write import location, once it matters.
1001       // FIXME: This writes the absolute path for AST files we depend on.
1002       const std::string &FileName = (*M)->FileName;
1003       Record.push_back(FileName.size());
1004       Record.append(FileName.begin(), FileName.end());
1005     }
1006     Stream.EmitRecord(IMPORTS, Record);
1007   }
1008 
1009   // Original file name and file ID
1010   SourceManager &SM = Context.getSourceManager();
1011   if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
1012     BitCodeAbbrev *FileAbbrev = new BitCodeAbbrev();
1013     FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE_NAME));
1014     FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1015     unsigned FileAbbrevCode = Stream.EmitAbbrev(FileAbbrev);
1016 
1017     llvm::SmallString<128> MainFilePath(MainFile->getName());
1018 
1019     llvm::sys::fs::make_absolute(MainFilePath);
1020 
1021     const char *MainFileNameStr = MainFilePath.c_str();
1022     MainFileNameStr = adjustFilenameForRelocatablePCH(MainFileNameStr,
1023                                                       isysroot);
1024     RecordData Record;
1025     Record.push_back(ORIGINAL_FILE_NAME);
1026     Stream.EmitRecordWithBlob(FileAbbrevCode, Record, MainFileNameStr);
1027 
1028     Record.clear();
1029     Record.push_back(SM.getMainFileID().getOpaqueValue());
1030     Stream.EmitRecord(ORIGINAL_FILE_ID, Record);
1031   }
1032 
1033   // Original PCH directory
1034   if (!OutputFile.empty() && OutputFile != "-") {
1035     BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1036     Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR));
1037     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1038     unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1039 
1040     llvm::SmallString<128> OutputPath(OutputFile);
1041 
1042     llvm::sys::fs::make_absolute(OutputPath);
1043     StringRef origDir = llvm::sys::path::parent_path(OutputPath);
1044 
1045     RecordData Record;
1046     Record.push_back(ORIGINAL_PCH_DIR);
1047     Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir);
1048   }
1049 
1050   // Repository branch/version information.
1051   BitCodeAbbrev *RepoAbbrev = new BitCodeAbbrev();
1052   RepoAbbrev->Add(BitCodeAbbrevOp(VERSION_CONTROL_BRANCH_REVISION));
1053   RepoAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
1054   unsigned RepoAbbrevCode = Stream.EmitAbbrev(RepoAbbrev);
1055   Record.clear();
1056   Record.push_back(VERSION_CONTROL_BRANCH_REVISION);
1057   Stream.EmitRecordWithBlob(RepoAbbrevCode, Record,
1058                             getClangFullRepositoryVersion());
1059 }
1060 
1061 /// \brief Write the LangOptions structure.
1062 void ASTWriter::WriteLanguageOptions(const LangOptions &LangOpts) {
1063   RecordData Record;
1064 #define LANGOPT(Name, Bits, Default, Description) \
1065   Record.push_back(LangOpts.Name);
1066 #define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
1067   Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
1068 #include "clang/Basic/LangOptions.def"
1069 
1070   Record.push_back(LangOpts.CurrentModule.size());
1071   Record.append(LangOpts.CurrentModule.begin(), LangOpts.CurrentModule.end());
1072   Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1073 }
1074 
1075 //===----------------------------------------------------------------------===//
1076 // stat cache Serialization
1077 //===----------------------------------------------------------------------===//
1078 
1079 namespace {
1080 // Trait used for the on-disk hash table of stat cache results.
1081 class ASTStatCacheTrait {
1082 public:
1083   typedef const char * key_type;
1084   typedef key_type key_type_ref;
1085 
1086   typedef struct stat data_type;
1087   typedef const data_type &data_type_ref;
1088 
1089   static unsigned ComputeHash(const char *path) {
1090     return llvm::HashString(path);
1091   }
1092 
1093   std::pair<unsigned,unsigned>
1094     EmitKeyDataLength(raw_ostream& Out, const char *path,
1095                       data_type_ref Data) {
1096     unsigned StrLen = strlen(path);
1097     clang::io::Emit16(Out, StrLen);
1098     unsigned DataLen = 4 + 4 + 2 + 8 + 8;
1099     clang::io::Emit8(Out, DataLen);
1100     return std::make_pair(StrLen + 1, DataLen);
1101   }
1102 
1103   void EmitKey(raw_ostream& Out, const char *path, unsigned KeyLen) {
1104     Out.write(path, KeyLen);
1105   }
1106 
1107   void EmitData(raw_ostream &Out, key_type_ref,
1108                 data_type_ref Data, unsigned DataLen) {
1109     using namespace clang::io;
1110     uint64_t Start = Out.tell(); (void)Start;
1111 
1112     Emit32(Out, (uint32_t) Data.st_ino);
1113     Emit32(Out, (uint32_t) Data.st_dev);
1114     Emit16(Out, (uint16_t) Data.st_mode);
1115     Emit64(Out, (uint64_t) Data.st_mtime);
1116     Emit64(Out, (uint64_t) Data.st_size);
1117 
1118     assert(Out.tell() - Start == DataLen && "Wrong data length");
1119   }
1120 };
1121 } // end anonymous namespace
1122 
1123 /// \brief Write the stat() system call cache to the AST file.
1124 void ASTWriter::WriteStatCache(MemorizeStatCalls &StatCalls) {
1125   // Build the on-disk hash table containing information about every
1126   // stat() call.
1127   OnDiskChainedHashTableGenerator<ASTStatCacheTrait> Generator;
1128   unsigned NumStatEntries = 0;
1129   for (MemorizeStatCalls::iterator Stat = StatCalls.begin(),
1130                                 StatEnd = StatCalls.end();
1131        Stat != StatEnd; ++Stat, ++NumStatEntries) {
1132     StringRef Filename = Stat->first();
1133     Generator.insert(Filename.data(), Stat->second);
1134   }
1135 
1136   // Create the on-disk hash table in a buffer.
1137   llvm::SmallString<4096> StatCacheData;
1138   uint32_t BucketOffset;
1139   {
1140     llvm::raw_svector_ostream Out(StatCacheData);
1141     // Make sure that no bucket is at offset 0
1142     clang::io::Emit32(Out, 0);
1143     BucketOffset = Generator.Emit(Out);
1144   }
1145 
1146   // Create a blob abbreviation
1147   using namespace llvm;
1148   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1149   Abbrev->Add(BitCodeAbbrevOp(STAT_CACHE));
1150   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1151   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1152   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1153   unsigned StatCacheAbbrev = Stream.EmitAbbrev(Abbrev);
1154 
1155   // Write the stat cache
1156   RecordData Record;
1157   Record.push_back(STAT_CACHE);
1158   Record.push_back(BucketOffset);
1159   Record.push_back(NumStatEntries);
1160   Stream.EmitRecordWithBlob(StatCacheAbbrev, Record, StatCacheData.str());
1161 }
1162 
1163 //===----------------------------------------------------------------------===//
1164 // Source Manager Serialization
1165 //===----------------------------------------------------------------------===//
1166 
1167 /// \brief Create an abbreviation for the SLocEntry that refers to a
1168 /// file.
1169 static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
1170   using namespace llvm;
1171   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1172   Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
1173   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1174   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1175   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1176   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1177   // FileEntry fields.
1178   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1179   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
1180   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // BufferOverridden
1181   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
1182   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
1183   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
1184   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1185   return Stream.EmitAbbrev(Abbrev);
1186 }
1187 
1188 /// \brief Create an abbreviation for the SLocEntry that refers to a
1189 /// buffer.
1190 static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
1191   using namespace llvm;
1192   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1193   Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
1194   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1195   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1196   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1197   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1198   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
1199   return Stream.EmitAbbrev(Abbrev);
1200 }
1201 
1202 /// \brief Create an abbreviation for the SLocEntry that refers to a
1203 /// buffer's blob.
1204 static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream) {
1205   using namespace llvm;
1206   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1207   Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_BLOB));
1208   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
1209   return Stream.EmitAbbrev(Abbrev);
1210 }
1211 
1212 /// \brief Create an abbreviation for the SLocEntry that refers to a macro
1213 /// expansion.
1214 static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
1215   using namespace llvm;
1216   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1217   Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
1218   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1219   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1220   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1221   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
1222   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
1223   return Stream.EmitAbbrev(Abbrev);
1224 }
1225 
1226 namespace {
1227   // Trait used for the on-disk hash table of header search information.
1228   class HeaderFileInfoTrait {
1229     ASTWriter &Writer;
1230     const HeaderSearch &HS;
1231 
1232     // Keep track of the framework names we've used during serialization.
1233     SmallVector<char, 128> FrameworkStringData;
1234     llvm::StringMap<unsigned> FrameworkNameOffset;
1235 
1236   public:
1237     HeaderFileInfoTrait(ASTWriter &Writer, const HeaderSearch &HS)
1238       : Writer(Writer), HS(HS) { }
1239 
1240     typedef const char *key_type;
1241     typedef key_type key_type_ref;
1242 
1243     typedef HeaderFileInfo data_type;
1244     typedef const data_type &data_type_ref;
1245 
1246     static unsigned ComputeHash(const char *path) {
1247       // The hash is based only on the filename portion of the key, so that the
1248       // reader can match based on filenames when symlinking or excess path
1249       // elements ("foo/../", "../") change the form of the name. However,
1250       // complete path is still the key.
1251       return llvm::HashString(llvm::sys::path::filename(path));
1252     }
1253 
1254     std::pair<unsigned,unsigned>
1255     EmitKeyDataLength(raw_ostream& Out, const char *path,
1256                       data_type_ref Data) {
1257       unsigned StrLen = strlen(path);
1258       clang::io::Emit16(Out, StrLen);
1259       unsigned DataLen = 1 + 2 + 4 + 4;
1260       clang::io::Emit8(Out, DataLen);
1261       return std::make_pair(StrLen + 1, DataLen);
1262     }
1263 
1264     void EmitKey(raw_ostream& Out, const char *path, unsigned KeyLen) {
1265       Out.write(path, KeyLen);
1266     }
1267 
1268     void EmitData(raw_ostream &Out, key_type_ref,
1269                   data_type_ref Data, unsigned DataLen) {
1270       using namespace clang::io;
1271       uint64_t Start = Out.tell(); (void)Start;
1272 
1273       unsigned char Flags = (Data.isImport << 5)
1274                           | (Data.isPragmaOnce << 4)
1275                           | (Data.DirInfo << 2)
1276                           | (Data.Resolved << 1)
1277                           | Data.IndexHeaderMapHeader;
1278       Emit8(Out, (uint8_t)Flags);
1279       Emit16(Out, (uint16_t) Data.NumIncludes);
1280 
1281       if (!Data.ControllingMacro)
1282         Emit32(Out, (uint32_t)Data.ControllingMacroID);
1283       else
1284         Emit32(Out, (uint32_t)Writer.getIdentifierRef(Data.ControllingMacro));
1285 
1286       unsigned Offset = 0;
1287       if (!Data.Framework.empty()) {
1288         // If this header refers into a framework, save the framework name.
1289         llvm::StringMap<unsigned>::iterator Pos
1290           = FrameworkNameOffset.find(Data.Framework);
1291         if (Pos == FrameworkNameOffset.end()) {
1292           Offset = FrameworkStringData.size() + 1;
1293           FrameworkStringData.append(Data.Framework.begin(),
1294                                      Data.Framework.end());
1295           FrameworkStringData.push_back(0);
1296 
1297           FrameworkNameOffset[Data.Framework] = Offset;
1298         } else
1299           Offset = Pos->second;
1300       }
1301       Emit32(Out, Offset);
1302 
1303       assert(Out.tell() - Start == DataLen && "Wrong data length");
1304     }
1305 
1306     const char *strings_begin() const { return FrameworkStringData.begin(); }
1307     const char *strings_end() const { return FrameworkStringData.end(); }
1308   };
1309 } // end anonymous namespace
1310 
1311 /// \brief Write the header search block for the list of files that
1312 ///
1313 /// \param HS The header search structure to save.
1314 ///
1315 /// \param Chain Whether we're creating a chained AST file.
1316 void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS, StringRef isysroot) {
1317   SmallVector<const FileEntry *, 16> FilesByUID;
1318   HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
1319 
1320   if (FilesByUID.size() > HS.header_file_size())
1321     FilesByUID.resize(HS.header_file_size());
1322 
1323   HeaderFileInfoTrait GeneratorTrait(*this, HS);
1324   OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
1325   SmallVector<const char *, 4> SavedStrings;
1326   unsigned NumHeaderSearchEntries = 0;
1327   for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
1328     const FileEntry *File = FilesByUID[UID];
1329     if (!File)
1330       continue;
1331 
1332     // Use HeaderSearch's getFileInfo to make sure we get the HeaderFileInfo
1333     // from the external source if it was not provided already.
1334     const HeaderFileInfo &HFI = HS.getFileInfo(File);
1335     if (HFI.External && Chain)
1336       continue;
1337 
1338     // Turn the file name into an absolute path, if it isn't already.
1339     const char *Filename = File->getName();
1340     Filename = adjustFilenameForRelocatablePCH(Filename, isysroot);
1341 
1342     // If we performed any translation on the file name at all, we need to
1343     // save this string, since the generator will refer to it later.
1344     if (Filename != File->getName()) {
1345       Filename = strdup(Filename);
1346       SavedStrings.push_back(Filename);
1347     }
1348 
1349     Generator.insert(Filename, HFI, GeneratorTrait);
1350     ++NumHeaderSearchEntries;
1351   }
1352 
1353   // Create the on-disk hash table in a buffer.
1354   llvm::SmallString<4096> TableData;
1355   uint32_t BucketOffset;
1356   {
1357     llvm::raw_svector_ostream Out(TableData);
1358     // Make sure that no bucket is at offset 0
1359     clang::io::Emit32(Out, 0);
1360     BucketOffset = Generator.Emit(Out, GeneratorTrait);
1361   }
1362 
1363   // Create a blob abbreviation
1364   using namespace llvm;
1365   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1366   Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
1367   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1368   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1369   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1370   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1371   unsigned TableAbbrev = Stream.EmitAbbrev(Abbrev);
1372 
1373   // Write the header search table
1374   RecordData Record;
1375   Record.push_back(HEADER_SEARCH_TABLE);
1376   Record.push_back(BucketOffset);
1377   Record.push_back(NumHeaderSearchEntries);
1378   Record.push_back(TableData.size());
1379   TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end());
1380   Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData.str());
1381 
1382   // Free all of the strings we had to duplicate.
1383   for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
1384     free((void*)SavedStrings[I]);
1385 }
1386 
1387 /// \brief Writes the block containing the serialized form of the
1388 /// source manager.
1389 ///
1390 /// TODO: We should probably use an on-disk hash table (stored in a
1391 /// blob), indexed based on the file name, so that we only create
1392 /// entries for files that we actually need. In the common case (no
1393 /// errors), we probably won't have to create file entries for any of
1394 /// the files in the AST.
1395 void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
1396                                         const Preprocessor &PP,
1397                                         StringRef isysroot) {
1398   RecordData Record;
1399 
1400   // Enter the source manager block.
1401   Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 3);
1402 
1403   // Abbreviations for the various kinds of source-location entries.
1404   unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
1405   unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
1406   unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream);
1407   unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
1408 
1409   // Write out the source location entry table. We skip the first
1410   // entry, which is always the same dummy entry.
1411   std::vector<uint32_t> SLocEntryOffsets;
1412   // Write out the offsets of only source location file entries.
1413   // We will go through them in ASTReader::validateFileEntries().
1414   std::vector<uint32_t> SLocFileEntryOffsets;
1415   RecordData PreloadSLocs;
1416   SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1);
1417   for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
1418        I != N; ++I) {
1419     // Get this source location entry.
1420     const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
1421 
1422     // Record the offset of this source-location entry.
1423     SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
1424 
1425     // Figure out which record code to use.
1426     unsigned Code;
1427     if (SLoc->isFile()) {
1428       const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
1429       if (Cache->OrigEntry) {
1430         Code = SM_SLOC_FILE_ENTRY;
1431         SLocFileEntryOffsets.push_back(Stream.GetCurrentBitNo());
1432       } else
1433         Code = SM_SLOC_BUFFER_ENTRY;
1434     } else
1435       Code = SM_SLOC_EXPANSION_ENTRY;
1436     Record.clear();
1437     Record.push_back(Code);
1438 
1439     // Starting offset of this entry within this module, so skip the dummy.
1440     Record.push_back(SLoc->getOffset() - 2);
1441     if (SLoc->isFile()) {
1442       const SrcMgr::FileInfo &File = SLoc->getFile();
1443       Record.push_back(File.getIncludeLoc().getRawEncoding());
1444       Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
1445       Record.push_back(File.hasLineDirectives());
1446 
1447       const SrcMgr::ContentCache *Content = File.getContentCache();
1448       if (Content->OrigEntry) {
1449         assert(Content->OrigEntry == Content->ContentsEntry &&
1450                "Writing to AST an overridden file is not supported");
1451 
1452         // The source location entry is a file. The blob associated
1453         // with this entry is the file name.
1454 
1455         // Emit size/modification time for this file.
1456         Record.push_back(Content->OrigEntry->getSize());
1457         Record.push_back(Content->OrigEntry->getModificationTime());
1458         Record.push_back(Content->BufferOverridden);
1459         Record.push_back(File.NumCreatedFIDs);
1460 
1461         FileDeclIDsTy::iterator FDI = FileDeclIDs.find(SLoc);
1462         if (FDI != FileDeclIDs.end()) {
1463           Record.push_back(FDI->second->FirstDeclIndex);
1464           Record.push_back(FDI->second->DeclIDs.size());
1465         } else {
1466           Record.push_back(0);
1467           Record.push_back(0);
1468         }
1469 
1470         // Turn the file name into an absolute path, if it isn't already.
1471         const char *Filename = Content->OrigEntry->getName();
1472         llvm::SmallString<128> FilePath(Filename);
1473 
1474         // Ask the file manager to fixup the relative path for us. This will
1475         // honor the working directory.
1476         SourceMgr.getFileManager().FixupRelativePath(FilePath);
1477 
1478         // FIXME: This call to make_absolute shouldn't be necessary, the
1479         // call to FixupRelativePath should always return an absolute path.
1480         llvm::sys::fs::make_absolute(FilePath);
1481         Filename = FilePath.c_str();
1482 
1483         Filename = adjustFilenameForRelocatablePCH(Filename, isysroot);
1484         Stream.EmitRecordWithBlob(SLocFileAbbrv, Record, Filename);
1485 
1486         if (Content->BufferOverridden) {
1487           Record.clear();
1488           Record.push_back(SM_SLOC_BUFFER_BLOB);
1489           const llvm::MemoryBuffer *Buffer
1490             = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
1491           Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record,
1492                                     StringRef(Buffer->getBufferStart(),
1493                                               Buffer->getBufferSize() + 1));
1494         }
1495       } else {
1496         // The source location entry is a buffer. The blob associated
1497         // with this entry contains the contents of the buffer.
1498 
1499         // We add one to the size so that we capture the trailing NULL
1500         // that is required by llvm::MemoryBuffer::getMemBuffer (on
1501         // the reader side).
1502         const llvm::MemoryBuffer *Buffer
1503           = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
1504         const char *Name = Buffer->getBufferIdentifier();
1505         Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
1506                                   StringRef(Name, strlen(Name) + 1));
1507         Record.clear();
1508         Record.push_back(SM_SLOC_BUFFER_BLOB);
1509         Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record,
1510                                   StringRef(Buffer->getBufferStart(),
1511                                                   Buffer->getBufferSize() + 1));
1512 
1513         if (strcmp(Name, "<built-in>") == 0) {
1514           PreloadSLocs.push_back(SLocEntryOffsets.size());
1515         }
1516       }
1517     } else {
1518       // The source location entry is a macro expansion.
1519       const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
1520       Record.push_back(Expansion.getSpellingLoc().getRawEncoding());
1521       Record.push_back(Expansion.getExpansionLocStart().getRawEncoding());
1522       Record.push_back(Expansion.isMacroArgExpansion() ? 0
1523                              : Expansion.getExpansionLocEnd().getRawEncoding());
1524 
1525       // Compute the token length for this macro expansion.
1526       unsigned NextOffset = SourceMgr.getNextLocalOffset();
1527       if (I + 1 != N)
1528         NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset();
1529       Record.push_back(NextOffset - SLoc->getOffset() - 1);
1530       Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record);
1531     }
1532   }
1533 
1534   Stream.ExitBlock();
1535 
1536   if (SLocEntryOffsets.empty())
1537     return;
1538 
1539   // Write the source-location offsets table into the AST block. This
1540   // table is used for lazily loading source-location information.
1541   using namespace llvm;
1542   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1543   Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
1544   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
1545   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
1546   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
1547   unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(Abbrev);
1548 
1549   Record.clear();
1550   Record.push_back(SOURCE_LOCATION_OFFSETS);
1551   Record.push_back(SLocEntryOffsets.size());
1552   Record.push_back(SourceMgr.getNextLocalOffset() - 1); // skip dummy
1553   Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record, data(SLocEntryOffsets));
1554 
1555   Abbrev = new BitCodeAbbrev();
1556   Abbrev->Add(BitCodeAbbrevOp(FILE_SOURCE_LOCATION_OFFSETS));
1557   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
1558   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
1559   unsigned SLocFileOffsetsAbbrev = Stream.EmitAbbrev(Abbrev);
1560 
1561   Record.clear();
1562   Record.push_back(FILE_SOURCE_LOCATION_OFFSETS);
1563   Record.push_back(SLocFileEntryOffsets.size());
1564   Stream.EmitRecordWithBlob(SLocFileOffsetsAbbrev, Record,
1565                             data(SLocFileEntryOffsets));
1566 
1567   // Write the source location entry preloads array, telling the AST
1568   // reader which source locations entries it should load eagerly.
1569   Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
1570 
1571   // Write the line table. It depends on remapping working, so it must come
1572   // after the source location offsets.
1573   if (SourceMgr.hasLineTable()) {
1574     LineTableInfo &LineTable = SourceMgr.getLineTable();
1575 
1576     Record.clear();
1577     // Emit the file names
1578     Record.push_back(LineTable.getNumFilenames());
1579     for (unsigned I = 0, N = LineTable.getNumFilenames(); I != N; ++I) {
1580       // Emit the file name
1581       const char *Filename = LineTable.getFilename(I);
1582       Filename = adjustFilenameForRelocatablePCH(Filename, isysroot);
1583       unsigned FilenameLen = Filename? strlen(Filename) : 0;
1584       Record.push_back(FilenameLen);
1585       if (FilenameLen)
1586         Record.insert(Record.end(), Filename, Filename + FilenameLen);
1587     }
1588 
1589     // Emit the line entries
1590     for (LineTableInfo::iterator L = LineTable.begin(), LEnd = LineTable.end();
1591          L != LEnd; ++L) {
1592       // Only emit entries for local files.
1593       if (L->first < 0)
1594         continue;
1595 
1596       // Emit the file ID
1597       Record.push_back(L->first);
1598 
1599       // Emit the line entries
1600       Record.push_back(L->second.size());
1601       for (std::vector<LineEntry>::iterator LE = L->second.begin(),
1602                                          LEEnd = L->second.end();
1603            LE != LEEnd; ++LE) {
1604         Record.push_back(LE->FileOffset);
1605         Record.push_back(LE->LineNo);
1606         Record.push_back(LE->FilenameID);
1607         Record.push_back((unsigned)LE->FileKind);
1608         Record.push_back(LE->IncludeOffset);
1609       }
1610     }
1611     Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record);
1612   }
1613 }
1614 
1615 //===----------------------------------------------------------------------===//
1616 // Preprocessor Serialization
1617 //===----------------------------------------------------------------------===//
1618 
1619 static int compareMacroDefinitions(const void *XPtr, const void *YPtr) {
1620   const std::pair<const IdentifierInfo *, MacroInfo *> &X =
1621     *(const std::pair<const IdentifierInfo *, MacroInfo *>*)XPtr;
1622   const std::pair<const IdentifierInfo *, MacroInfo *> &Y =
1623     *(const std::pair<const IdentifierInfo *, MacroInfo *>*)YPtr;
1624   return X.first->getName().compare(Y.first->getName());
1625 }
1626 
1627 /// \brief Writes the block containing the serialized form of the
1628 /// preprocessor.
1629 ///
1630 void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
1631   PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
1632   if (PPRec)
1633     WritePreprocessorDetail(*PPRec);
1634 
1635   RecordData Record;
1636 
1637   // If the preprocessor __COUNTER__ value has been bumped, remember it.
1638   if (PP.getCounterValue() != 0) {
1639     Record.push_back(PP.getCounterValue());
1640     Stream.EmitRecord(PP_COUNTER_VALUE, Record);
1641     Record.clear();
1642   }
1643 
1644   // Enter the preprocessor block.
1645   Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
1646 
1647   // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
1648   // FIXME: use diagnostics subsystem for localization etc.
1649   if (PP.SawDateOrTime())
1650     fprintf(stderr, "warning: precompiled header used __DATE__ or __TIME__.\n");
1651 
1652 
1653   // Loop over all the macro definitions that are live at the end of the file,
1654   // emitting each to the PP section.
1655 
1656   // Construct the list of macro definitions that need to be serialized.
1657   SmallVector<std::pair<const IdentifierInfo *, MacroInfo *>, 2>
1658     MacrosToEmit;
1659   llvm::SmallPtrSet<const IdentifierInfo*, 4> MacroDefinitionsSeen;
1660   for (Preprocessor::macro_iterator I = PP.macro_begin(Chain == 0),
1661                                     E = PP.macro_end(Chain == 0);
1662        I != E; ++I) {
1663     if (!IsModule || I->second->isPublic()) {
1664       MacroDefinitionsSeen.insert(I->first);
1665       MacrosToEmit.push_back(std::make_pair(I->first, I->second));
1666     }
1667   }
1668 
1669   // Sort the set of macro definitions that need to be serialized by the
1670   // name of the macro, to provide a stable ordering.
1671   llvm::array_pod_sort(MacrosToEmit.begin(), MacrosToEmit.end(),
1672                        &compareMacroDefinitions);
1673 
1674   // Resolve any identifiers that defined macros at the time they were
1675   // deserialized, adding them to the list of macros to emit (if appropriate).
1676   for (unsigned I = 0, N = DeserializedMacroNames.size(); I != N; ++I) {
1677     IdentifierInfo *Name
1678       = const_cast<IdentifierInfo *>(DeserializedMacroNames[I]);
1679     if (Name->hasMacroDefinition() && MacroDefinitionsSeen.insert(Name))
1680       MacrosToEmit.push_back(std::make_pair(Name, PP.getMacroInfo(Name)));
1681   }
1682 
1683   for (unsigned I = 0, N = MacrosToEmit.size(); I != N; ++I) {
1684     const IdentifierInfo *Name = MacrosToEmit[I].first;
1685     MacroInfo *MI = MacrosToEmit[I].second;
1686     if (!MI)
1687       continue;
1688 
1689     // Don't emit builtin macros like __LINE__ to the AST file unless they have
1690     // been redefined by the header (in which case they are not isBuiltinMacro).
1691     // Also skip macros from a AST file if we're chaining.
1692 
1693     // FIXME: There is a (probably minor) optimization we could do here, if
1694     // the macro comes from the original PCH but the identifier comes from a
1695     // chained PCH, by storing the offset into the original PCH rather than
1696     // writing the macro definition a second time.
1697     if (MI->isBuiltinMacro() ||
1698         (Chain &&
1699          Name->isFromAST() && !Name->hasChangedSinceDeserialization() &&
1700          MI->isFromAST() && !MI->hasChangedAfterLoad()))
1701       continue;
1702 
1703     AddIdentifierRef(Name, Record);
1704     MacroOffsets[Name] = Stream.GetCurrentBitNo();
1705     Record.push_back(MI->getDefinitionLoc().getRawEncoding());
1706     Record.push_back(MI->isUsed());
1707     Record.push_back(MI->isPublic());
1708     AddSourceLocation(MI->getVisibilityLocation(), Record);
1709     unsigned Code;
1710     if (MI->isObjectLike()) {
1711       Code = PP_MACRO_OBJECT_LIKE;
1712     } else {
1713       Code = PP_MACRO_FUNCTION_LIKE;
1714 
1715       Record.push_back(MI->isC99Varargs());
1716       Record.push_back(MI->isGNUVarargs());
1717       Record.push_back(MI->getNumArgs());
1718       for (MacroInfo::arg_iterator I = MI->arg_begin(), E = MI->arg_end();
1719            I != E; ++I)
1720         AddIdentifierRef(*I, Record);
1721     }
1722 
1723     // If we have a detailed preprocessing record, record the macro definition
1724     // ID that corresponds to this macro.
1725     if (PPRec)
1726       Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
1727 
1728     Stream.EmitRecord(Code, Record);
1729     Record.clear();
1730 
1731     // Emit the tokens array.
1732     for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
1733       // Note that we know that the preprocessor does not have any annotation
1734       // tokens in it because they are created by the parser, and thus can't be
1735       // in a macro definition.
1736       const Token &Tok = MI->getReplacementToken(TokNo);
1737 
1738       Record.push_back(Tok.getLocation().getRawEncoding());
1739       Record.push_back(Tok.getLength());
1740 
1741       // FIXME: When reading literal tokens, reconstruct the literal pointer if
1742       // it is needed.
1743       AddIdentifierRef(Tok.getIdentifierInfo(), Record);
1744       // FIXME: Should translate token kind to a stable encoding.
1745       Record.push_back(Tok.getKind());
1746       // FIXME: Should translate token flags to a stable encoding.
1747       Record.push_back(Tok.getFlags());
1748 
1749       Stream.EmitRecord(PP_TOKEN, Record);
1750       Record.clear();
1751     }
1752     ++NumMacros;
1753   }
1754   Stream.ExitBlock();
1755 }
1756 
1757 void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) {
1758   if (PPRec.local_begin() == PPRec.local_end())
1759     return;
1760 
1761   SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
1762 
1763   // Enter the preprocessor block.
1764   Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3);
1765 
1766   // If the preprocessor has a preprocessing record, emit it.
1767   unsigned NumPreprocessingRecords = 0;
1768   using namespace llvm;
1769 
1770   // Set up the abbreviation for
1771   unsigned InclusionAbbrev = 0;
1772   {
1773     BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1774     Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
1775     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
1776     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
1777     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
1778     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1779     InclusionAbbrev = Stream.EmitAbbrev(Abbrev);
1780   }
1781 
1782   unsigned FirstPreprocessorEntityID
1783     = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0)
1784     + NUM_PREDEF_PP_ENTITY_IDS;
1785   unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
1786   RecordData Record;
1787   for (PreprocessingRecord::iterator E = PPRec.local_begin(),
1788                                   EEnd = PPRec.local_end();
1789        E != EEnd;
1790        (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
1791     Record.clear();
1792 
1793     PreprocessedEntityOffsets.push_back(PPEntityOffset((*E)->getSourceRange(),
1794                                                      Stream.GetCurrentBitNo()));
1795 
1796     if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) {
1797       // Record this macro definition's ID.
1798       MacroDefinitions[MD] = NextPreprocessorEntityID;
1799 
1800       AddIdentifierRef(MD->getName(), Record);
1801       Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
1802       continue;
1803     }
1804 
1805     if (MacroExpansion *ME = dyn_cast<MacroExpansion>(*E)) {
1806       Record.push_back(ME->isBuiltinMacro());
1807       if (ME->isBuiltinMacro())
1808         AddIdentifierRef(ME->getName(), Record);
1809       else
1810         Record.push_back(MacroDefinitions[ME->getDefinition()]);
1811       Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
1812       continue;
1813     }
1814 
1815     if (InclusionDirective *ID = dyn_cast<InclusionDirective>(*E)) {
1816       Record.push_back(PPD_INCLUSION_DIRECTIVE);
1817       Record.push_back(ID->getFileName().size());
1818       Record.push_back(ID->wasInQuotes());
1819       Record.push_back(static_cast<unsigned>(ID->getKind()));
1820       llvm::SmallString<64> Buffer;
1821       Buffer += ID->getFileName();
1822       Buffer += ID->getFile()->getName();
1823       Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
1824       continue;
1825     }
1826 
1827     llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
1828   }
1829   Stream.ExitBlock();
1830 
1831   // Write the offsets table for the preprocessing record.
1832   if (NumPreprocessingRecords > 0) {
1833     assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
1834 
1835     // Write the offsets table for identifier IDs.
1836     using namespace llvm;
1837     BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1838     Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
1839     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity
1840     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1841     unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1842 
1843     Record.clear();
1844     Record.push_back(PPD_ENTITIES_OFFSETS);
1845     Record.push_back(FirstPreprocessorEntityID - NUM_PREDEF_PP_ENTITY_IDS);
1846     Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
1847                               data(PreprocessedEntityOffsets));
1848   }
1849 }
1850 
1851 unsigned ASTWriter::getSubmoduleID(Module *Mod) {
1852   llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod);
1853   if (Known != SubmoduleIDs.end())
1854     return Known->second;
1855 
1856   return SubmoduleIDs[Mod] = NextSubmoduleID++;
1857 }
1858 
1859 /// \brief Compute the number of modules within the given tree (including the
1860 /// given module).
1861 static unsigned getNumberOfModules(Module *Mod) {
1862   unsigned ChildModules = 0;
1863   for (llvm::StringMap<Module *>::iterator Sub = Mod->SubModules.begin(),
1864                                         SubEnd = Mod->SubModules.end();
1865        Sub != SubEnd; ++Sub)
1866     ChildModules += getNumberOfModules(Sub->getValue());
1867 
1868   return ChildModules + 1;
1869 }
1870 
1871 void ASTWriter::WriteSubmodules(Module *WritingModule) {
1872   // Determine the dependencies of our module and each of it's submodules.
1873   // FIXME: This feels like it belongs somewhere else, but there are no
1874   // other consumers of this information.
1875   SourceManager &SrcMgr = PP->getSourceManager();
1876   ModuleMap &ModMap = PP->getHeaderSearchInfo().getModuleMap();
1877   for (ASTContext::import_iterator I = Context->local_import_begin(),
1878                                 IEnd = Context->local_import_end();
1879        I != IEnd; ++I) {
1880     if (Module *ImportedFrom
1881           = ModMap.inferModuleFromLocation(FullSourceLoc(I->getLocation(),
1882                                                          SrcMgr))) {
1883       ImportedFrom->Imports.push_back(I->getImportedModule());
1884     }
1885   }
1886 
1887   // Enter the submodule description block.
1888   Stream.EnterSubblock(SUBMODULE_BLOCK_ID, NUM_ALLOWED_ABBREVS_SIZE);
1889 
1890   // Write the abbreviations needed for the submodules block.
1891   using namespace llvm;
1892   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1893   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
1894   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
1895   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
1896   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
1897   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
1898   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
1899   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
1900   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
1901   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
1902   unsigned DefinitionAbbrev = Stream.EmitAbbrev(Abbrev);
1903 
1904   Abbrev = new BitCodeAbbrev();
1905   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
1906   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
1907   unsigned UmbrellaAbbrev = Stream.EmitAbbrev(Abbrev);
1908 
1909   Abbrev = new BitCodeAbbrev();
1910   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
1911   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
1912   unsigned HeaderAbbrev = Stream.EmitAbbrev(Abbrev);
1913 
1914   Abbrev = new BitCodeAbbrev();
1915   Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
1916   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
1917   unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(Abbrev);
1918 
1919   // Write the submodule metadata block.
1920   RecordData Record;
1921   Record.push_back(getNumberOfModules(WritingModule));
1922   Record.push_back(FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS);
1923   Stream.EmitRecord(SUBMODULE_METADATA, Record);
1924 
1925   // Write all of the submodules.
1926   std::queue<Module *> Q;
1927   Q.push(WritingModule);
1928   while (!Q.empty()) {
1929     Module *Mod = Q.front();
1930     Q.pop();
1931     unsigned ID = getSubmoduleID(Mod);
1932 
1933     // Emit the definition of the block.
1934     Record.clear();
1935     Record.push_back(SUBMODULE_DEFINITION);
1936     Record.push_back(ID);
1937     if (Mod->Parent) {
1938       assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
1939       Record.push_back(SubmoduleIDs[Mod->Parent]);
1940     } else {
1941       Record.push_back(0);
1942     }
1943     Record.push_back(Mod->IsFramework);
1944     Record.push_back(Mod->IsExplicit);
1945     Record.push_back(Mod->InferSubmodules);
1946     Record.push_back(Mod->InferExplicitSubmodules);
1947     Record.push_back(Mod->InferExportWildcard);
1948     Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name);
1949 
1950     // Emit the umbrella header, if there is one.
1951     if (const FileEntry *UmbrellaHeader = Mod->getUmbrellaHeader()) {
1952       Record.clear();
1953       Record.push_back(SUBMODULE_UMBRELLA_HEADER);
1954       Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
1955                                 UmbrellaHeader->getName());
1956     } else if (const DirectoryEntry *UmbrellaDir = Mod->getUmbrellaDir()) {
1957       Record.clear();
1958       Record.push_back(SUBMODULE_UMBRELLA_DIR);
1959       Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
1960                                 UmbrellaDir->getName());
1961     }
1962 
1963     // Emit the headers.
1964     for (unsigned I = 0, N = Mod->Headers.size(); I != N; ++I) {
1965       Record.clear();
1966       Record.push_back(SUBMODULE_HEADER);
1967       Stream.EmitRecordWithBlob(HeaderAbbrev, Record,
1968                                 Mod->Headers[I]->getName());
1969     }
1970 
1971     // Emit the imports.
1972     if (!Mod->Imports.empty()) {
1973       Record.clear();
1974       for (unsigned I = 0, N = Mod->Imports.size(); I != N; ++I) {
1975         unsigned ImportedID = getSubmoduleID(Mod->Imports[I]);
1976         assert(ImportedID && "Unknown submodule!");
1977         Record.push_back(ImportedID);
1978       }
1979       Stream.EmitRecord(SUBMODULE_IMPORTS, Record);
1980     }
1981 
1982     // Emit the exports.
1983     if (!Mod->Exports.empty()) {
1984       Record.clear();
1985       for (unsigned I = 0, N = Mod->Exports.size(); I != N; ++I) {
1986         if (Module *Exported = Mod->Exports[I].getPointer()) {
1987           unsigned ExportedID = SubmoduleIDs[Exported];
1988           assert(ExportedID > 0 && "Unknown submodule ID?");
1989           Record.push_back(ExportedID);
1990         } else {
1991           Record.push_back(0);
1992         }
1993 
1994         Record.push_back(Mod->Exports[I].getInt());
1995       }
1996       Stream.EmitRecord(SUBMODULE_EXPORTS, Record);
1997     }
1998 
1999     // Queue up the submodules of this module.
2000     llvm::SmallVector<StringRef, 2> SubModules;
2001 
2002     // Sort the submodules first, so we get a predictable ordering in the AST
2003     // file.
2004     for (llvm::StringMap<Module *>::iterator
2005               Sub = Mod->SubModules.begin(),
2006            SubEnd = Mod->SubModules.end();
2007          Sub != SubEnd; ++Sub)
2008       SubModules.push_back(Sub->getKey());
2009     llvm::array_pod_sort(SubModules.begin(), SubModules.end());
2010 
2011     for (unsigned I = 0, N = SubModules.size(); I != N; ++I)
2012       Q.push(Mod->SubModules[SubModules[I]]);
2013   }
2014 
2015   Stream.ExitBlock();
2016 
2017   assert((NextSubmoduleID - FirstSubmoduleID
2018             == getNumberOfModules(WritingModule)) && "Wrong # of submodules");
2019 }
2020 
2021 serialization::SubmoduleID
2022 ASTWriter::inferSubmoduleIDFromLocation(SourceLocation Loc) {
2023   if (Loc.isInvalid() || !WritingModule)
2024     return 0; // No submodule
2025 
2026   // Find the module that owns this location.
2027   ModuleMap &ModMap = PP->getHeaderSearchInfo().getModuleMap();
2028   Module *OwningMod
2029     = ModMap.inferModuleFromLocation(FullSourceLoc(Loc,PP->getSourceManager()));
2030   if (!OwningMod)
2031     return 0;
2032 
2033   // Check whether this submodule is part of our own module.
2034   if (WritingModule != OwningMod && !OwningMod->isSubModuleOf(WritingModule))
2035     return 0;
2036 
2037   return getSubmoduleID(OwningMod);
2038 }
2039 
2040 void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag) {
2041   RecordData Record;
2042   for (DiagnosticsEngine::DiagStatePointsTy::const_iterator
2043          I = Diag.DiagStatePoints.begin(), E = Diag.DiagStatePoints.end();
2044          I != E; ++I) {
2045     const DiagnosticsEngine::DiagStatePoint &point = *I;
2046     if (point.Loc.isInvalid())
2047       continue;
2048 
2049     Record.push_back(point.Loc.getRawEncoding());
2050     for (DiagnosticsEngine::DiagState::const_iterator
2051            I = point.State->begin(), E = point.State->end(); I != E; ++I) {
2052       if (I->second.isPragma()) {
2053         Record.push_back(I->first);
2054         Record.push_back(I->second.getMapping());
2055       }
2056     }
2057     Record.push_back(-1); // mark the end of the diag/map pairs for this
2058                           // location.
2059   }
2060 
2061   if (!Record.empty())
2062     Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record);
2063 }
2064 
2065 void ASTWriter::WriteCXXBaseSpecifiersOffsets() {
2066   if (CXXBaseSpecifiersOffsets.empty())
2067     return;
2068 
2069   RecordData Record;
2070 
2071   // Create a blob abbreviation for the C++ base specifiers offsets.
2072   using namespace llvm;
2073 
2074   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2075   Abbrev->Add(BitCodeAbbrevOp(CXX_BASE_SPECIFIER_OFFSETS));
2076   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
2077   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2078   unsigned BaseSpecifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2079 
2080   // Write the base specifier offsets table.
2081   Record.clear();
2082   Record.push_back(CXX_BASE_SPECIFIER_OFFSETS);
2083   Record.push_back(CXXBaseSpecifiersOffsets.size());
2084   Stream.EmitRecordWithBlob(BaseSpecifierOffsetAbbrev, Record,
2085                             data(CXXBaseSpecifiersOffsets));
2086 }
2087 
2088 //===----------------------------------------------------------------------===//
2089 // Type Serialization
2090 //===----------------------------------------------------------------------===//
2091 
2092 /// \brief Write the representation of a type to the AST stream.
2093 void ASTWriter::WriteType(QualType T) {
2094   TypeIdx &Idx = TypeIdxs[T];
2095   if (Idx.getIndex() == 0) // we haven't seen this type before.
2096     Idx = TypeIdx(NextTypeID++);
2097 
2098   assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
2099 
2100   // Record the offset for this type.
2101   unsigned Index = Idx.getIndex() - FirstTypeID;
2102   if (TypeOffsets.size() == Index)
2103     TypeOffsets.push_back(Stream.GetCurrentBitNo());
2104   else if (TypeOffsets.size() < Index) {
2105     TypeOffsets.resize(Index + 1);
2106     TypeOffsets[Index] = Stream.GetCurrentBitNo();
2107   }
2108 
2109   RecordData Record;
2110 
2111   // Emit the type's representation.
2112   ASTTypeWriter W(*this, Record);
2113 
2114   if (T.hasLocalNonFastQualifiers()) {
2115     Qualifiers Qs = T.getLocalQualifiers();
2116     AddTypeRef(T.getLocalUnqualifiedType(), Record);
2117     Record.push_back(Qs.getAsOpaqueValue());
2118     W.Code = TYPE_EXT_QUAL;
2119   } else {
2120     switch (T->getTypeClass()) {
2121       // For all of the concrete, non-dependent types, call the
2122       // appropriate visitor function.
2123 #define TYPE(Class, Base) \
2124     case Type::Class: W.Visit##Class##Type(cast<Class##Type>(T)); break;
2125 #define ABSTRACT_TYPE(Class, Base)
2126 #include "clang/AST/TypeNodes.def"
2127     }
2128   }
2129 
2130   // Emit the serialized record.
2131   Stream.EmitRecord(W.Code, Record);
2132 
2133   // Flush any expressions that were written as part of this type.
2134   FlushStmts();
2135 }
2136 
2137 //===----------------------------------------------------------------------===//
2138 // Declaration Serialization
2139 //===----------------------------------------------------------------------===//
2140 
2141 /// \brief Write the block containing all of the declaration IDs
2142 /// lexically declared within the given DeclContext.
2143 ///
2144 /// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
2145 /// bistream, or 0 if no block was written.
2146 uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
2147                                                  DeclContext *DC) {
2148   if (DC->decls_empty())
2149     return 0;
2150 
2151   uint64_t Offset = Stream.GetCurrentBitNo();
2152   RecordData Record;
2153   Record.push_back(DECL_CONTEXT_LEXICAL);
2154   SmallVector<KindDeclIDPair, 64> Decls;
2155   for (DeclContext::decl_iterator D = DC->decls_begin(), DEnd = DC->decls_end();
2156          D != DEnd; ++D)
2157     Decls.push_back(std::make_pair((*D)->getKind(), GetDeclRef(*D)));
2158 
2159   ++NumLexicalDeclContexts;
2160   Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record, data(Decls));
2161   return Offset;
2162 }
2163 
2164 void ASTWriter::WriteTypeDeclOffsets() {
2165   using namespace llvm;
2166   RecordData Record;
2167 
2168   // Write the type offsets array
2169   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2170   Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
2171   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
2172   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index
2173   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
2174   unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2175   Record.clear();
2176   Record.push_back(TYPE_OFFSET);
2177   Record.push_back(TypeOffsets.size());
2178   Record.push_back(FirstTypeID - NUM_PREDEF_TYPE_IDS);
2179   Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, data(TypeOffsets));
2180 
2181   // Write the declaration offsets array
2182   Abbrev = new BitCodeAbbrev();
2183   Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
2184   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
2185   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID
2186   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
2187   unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2188   Record.clear();
2189   Record.push_back(DECL_OFFSET);
2190   Record.push_back(DeclOffsets.size());
2191   Record.push_back(FirstDeclID - NUM_PREDEF_DECL_IDS);
2192   Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, data(DeclOffsets));
2193 }
2194 
2195 void ASTWriter::WriteFileDeclIDsMap() {
2196   using namespace llvm;
2197   RecordData Record;
2198 
2199   // Join the vectors of DeclIDs from all files.
2200   SmallVector<DeclID, 256> FileSortedIDs;
2201   for (FileDeclIDsTy::iterator
2202          FI = FileDeclIDs.begin(), FE = FileDeclIDs.end(); FI != FE; ++FI) {
2203     DeclIDInFileInfo &Info = *FI->second;
2204     Info.FirstDeclIndex = FileSortedIDs.size();
2205     for (LocDeclIDsTy::iterator
2206            DI = Info.DeclIDs.begin(), DE = Info.DeclIDs.end(); DI != DE; ++DI)
2207       FileSortedIDs.push_back(DI->second);
2208   }
2209 
2210   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2211   Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
2212   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2213   unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
2214   Record.push_back(FILE_SORTED_DECLS);
2215   Stream.EmitRecordWithBlob(AbbrevCode, Record, data(FileSortedIDs));
2216 }
2217 
2218 //===----------------------------------------------------------------------===//
2219 // Global Method Pool and Selector Serialization
2220 //===----------------------------------------------------------------------===//
2221 
2222 namespace {
2223 // Trait used for the on-disk hash table used in the method pool.
2224 class ASTMethodPoolTrait {
2225   ASTWriter &Writer;
2226 
2227 public:
2228   typedef Selector key_type;
2229   typedef key_type key_type_ref;
2230 
2231   struct data_type {
2232     SelectorID ID;
2233     ObjCMethodList Instance, Factory;
2234   };
2235   typedef const data_type& data_type_ref;
2236 
2237   explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) { }
2238 
2239   static unsigned ComputeHash(Selector Sel) {
2240     return serialization::ComputeHash(Sel);
2241   }
2242 
2243   std::pair<unsigned,unsigned>
2244     EmitKeyDataLength(raw_ostream& Out, Selector Sel,
2245                       data_type_ref Methods) {
2246     unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
2247     clang::io::Emit16(Out, KeyLen);
2248     unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
2249     for (const ObjCMethodList *Method = &Methods.Instance; Method;
2250          Method = Method->Next)
2251       if (Method->Method)
2252         DataLen += 4;
2253     for (const ObjCMethodList *Method = &Methods.Factory; Method;
2254          Method = Method->Next)
2255       if (Method->Method)
2256         DataLen += 4;
2257     clang::io::Emit16(Out, DataLen);
2258     return std::make_pair(KeyLen, DataLen);
2259   }
2260 
2261   void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
2262     uint64_t Start = Out.tell();
2263     assert((Start >> 32) == 0 && "Selector key offset too large");
2264     Writer.SetSelectorOffset(Sel, Start);
2265     unsigned N = Sel.getNumArgs();
2266     clang::io::Emit16(Out, N);
2267     if (N == 0)
2268       N = 1;
2269     for (unsigned I = 0; I != N; ++I)
2270       clang::io::Emit32(Out,
2271                     Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
2272   }
2273 
2274   void EmitData(raw_ostream& Out, key_type_ref,
2275                 data_type_ref Methods, unsigned DataLen) {
2276     uint64_t Start = Out.tell(); (void)Start;
2277     clang::io::Emit32(Out, Methods.ID);
2278     unsigned NumInstanceMethods = 0;
2279     for (const ObjCMethodList *Method = &Methods.Instance; Method;
2280          Method = Method->Next)
2281       if (Method->Method)
2282         ++NumInstanceMethods;
2283 
2284     unsigned NumFactoryMethods = 0;
2285     for (const ObjCMethodList *Method = &Methods.Factory; Method;
2286          Method = Method->Next)
2287       if (Method->Method)
2288         ++NumFactoryMethods;
2289 
2290     clang::io::Emit16(Out, NumInstanceMethods);
2291     clang::io::Emit16(Out, NumFactoryMethods);
2292     for (const ObjCMethodList *Method = &Methods.Instance; Method;
2293          Method = Method->Next)
2294       if (Method->Method)
2295         clang::io::Emit32(Out, Writer.getDeclID(Method->Method));
2296     for (const ObjCMethodList *Method = &Methods.Factory; Method;
2297          Method = Method->Next)
2298       if (Method->Method)
2299         clang::io::Emit32(Out, Writer.getDeclID(Method->Method));
2300 
2301     assert(Out.tell() - Start == DataLen && "Data length is wrong");
2302   }
2303 };
2304 } // end anonymous namespace
2305 
2306 /// \brief Write ObjC data: selectors and the method pool.
2307 ///
2308 /// The method pool contains both instance and factory methods, stored
2309 /// in an on-disk hash table indexed by the selector. The hash table also
2310 /// contains an empty entry for every other selector known to Sema.
2311 void ASTWriter::WriteSelectors(Sema &SemaRef) {
2312   using namespace llvm;
2313 
2314   // Do we have to do anything at all?
2315   if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
2316     return;
2317   unsigned NumTableEntries = 0;
2318   // Create and write out the blob that contains selectors and the method pool.
2319   {
2320     OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
2321     ASTMethodPoolTrait Trait(*this);
2322 
2323     // Create the on-disk hash table representation. We walk through every
2324     // selector we've seen and look it up in the method pool.
2325     SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
2326     for (llvm::DenseMap<Selector, SelectorID>::iterator
2327              I = SelectorIDs.begin(), E = SelectorIDs.end();
2328          I != E; ++I) {
2329       Selector S = I->first;
2330       Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
2331       ASTMethodPoolTrait::data_type Data = {
2332         I->second,
2333         ObjCMethodList(),
2334         ObjCMethodList()
2335       };
2336       if (F != SemaRef.MethodPool.end()) {
2337         Data.Instance = F->second.first;
2338         Data.Factory = F->second.second;
2339       }
2340       // Only write this selector if it's not in an existing AST or something
2341       // changed.
2342       if (Chain && I->second < FirstSelectorID) {
2343         // Selector already exists. Did it change?
2344         bool changed = false;
2345         for (ObjCMethodList *M = &Data.Instance; !changed && M && M->Method;
2346              M = M->Next) {
2347           if (!M->Method->isFromASTFile())
2348             changed = true;
2349         }
2350         for (ObjCMethodList *M = &Data.Factory; !changed && M && M->Method;
2351              M = M->Next) {
2352           if (!M->Method->isFromASTFile())
2353             changed = true;
2354         }
2355         if (!changed)
2356           continue;
2357       } else if (Data.Instance.Method || Data.Factory.Method) {
2358         // A new method pool entry.
2359         ++NumTableEntries;
2360       }
2361       Generator.insert(S, Data, Trait);
2362     }
2363 
2364     // Create the on-disk hash table in a buffer.
2365     llvm::SmallString<4096> MethodPool;
2366     uint32_t BucketOffset;
2367     {
2368       ASTMethodPoolTrait Trait(*this);
2369       llvm::raw_svector_ostream Out(MethodPool);
2370       // Make sure that no bucket is at offset 0
2371       clang::io::Emit32(Out, 0);
2372       BucketOffset = Generator.Emit(Out, Trait);
2373     }
2374 
2375     // Create a blob abbreviation
2376     BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2377     Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
2378     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2379     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2380     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2381     unsigned MethodPoolAbbrev = Stream.EmitAbbrev(Abbrev);
2382 
2383     // Write the method pool
2384     RecordData Record;
2385     Record.push_back(METHOD_POOL);
2386     Record.push_back(BucketOffset);
2387     Record.push_back(NumTableEntries);
2388     Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool.str());
2389 
2390     // Create a blob abbreviation for the selector table offsets.
2391     Abbrev = new BitCodeAbbrev();
2392     Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
2393     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
2394     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2395     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2396     unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2397 
2398     // Write the selector offsets table.
2399     Record.clear();
2400     Record.push_back(SELECTOR_OFFSETS);
2401     Record.push_back(SelectorOffsets.size());
2402     Record.push_back(FirstSelectorID - NUM_PREDEF_SELECTOR_IDS);
2403     Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
2404                               data(SelectorOffsets));
2405   }
2406 }
2407 
2408 /// \brief Write the selectors referenced in @selector expression into AST file.
2409 void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
2410   using namespace llvm;
2411   if (SemaRef.ReferencedSelectors.empty())
2412     return;
2413 
2414   RecordData Record;
2415 
2416   // Note: this writes out all references even for a dependent AST. But it is
2417   // very tricky to fix, and given that @selector shouldn't really appear in
2418   // headers, probably not worth it. It's not a correctness issue.
2419   for (DenseMap<Selector, SourceLocation>::iterator S =
2420        SemaRef.ReferencedSelectors.begin(),
2421        E = SemaRef.ReferencedSelectors.end(); S != E; ++S) {
2422     Selector Sel = (*S).first;
2423     SourceLocation Loc = (*S).second;
2424     AddSelectorRef(Sel, Record);
2425     AddSourceLocation(Loc, Record);
2426   }
2427   Stream.EmitRecord(REFERENCED_SELECTOR_POOL, Record);
2428 }
2429 
2430 //===----------------------------------------------------------------------===//
2431 // Identifier Table Serialization
2432 //===----------------------------------------------------------------------===//
2433 
2434 namespace {
2435 class ASTIdentifierTableTrait {
2436   ASTWriter &Writer;
2437   Preprocessor &PP;
2438   IdentifierResolver &IdResolver;
2439   bool IsModule;
2440 
2441   /// \brief Determines whether this is an "interesting" identifier
2442   /// that needs a full IdentifierInfo structure written into the hash
2443   /// table.
2444   bool isInterestingIdentifier(IdentifierInfo *II, MacroInfo *&Macro) {
2445     if (II->isPoisoned() ||
2446         II->isExtensionToken() ||
2447         II->getObjCOrBuiltinID() ||
2448         II->hasRevertedTokenIDToIdentifier() ||
2449         II->getFETokenInfo<void>())
2450       return true;
2451 
2452     return hasMacroDefinition(II, Macro);
2453   }
2454 
2455   bool hasMacroDefinition(IdentifierInfo *II, MacroInfo *&Macro) {
2456     if (!II->hasMacroDefinition())
2457       return false;
2458 
2459     if (Macro || (Macro = PP.getMacroInfo(II)))
2460       return !Macro->isBuiltinMacro() && (!IsModule || Macro->isPublic());
2461 
2462     return false;
2463   }
2464 
2465 public:
2466   typedef IdentifierInfo* key_type;
2467   typedef key_type  key_type_ref;
2468 
2469   typedef IdentID data_type;
2470   typedef data_type data_type_ref;
2471 
2472   ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
2473                           IdentifierResolver &IdResolver, bool IsModule)
2474     : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule) { }
2475 
2476   static unsigned ComputeHash(const IdentifierInfo* II) {
2477     return llvm::HashString(II->getName());
2478   }
2479 
2480   std::pair<unsigned,unsigned>
2481   EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) {
2482     unsigned KeyLen = II->getLength() + 1;
2483     unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
2484     MacroInfo *Macro = 0;
2485     if (isInterestingIdentifier(II, Macro)) {
2486       DataLen += 2; // 2 bytes for builtin ID, flags
2487       if (hasMacroDefinition(II, Macro))
2488         DataLen += 8;
2489 
2490       for (IdentifierResolver::iterator D = IdResolver.begin(II),
2491                                      DEnd = IdResolver.end();
2492            D != DEnd; ++D)
2493         DataLen += sizeof(DeclID);
2494     }
2495     clang::io::Emit16(Out, DataLen);
2496     // We emit the key length after the data length so that every
2497     // string is preceded by a 16-bit length. This matches the PTH
2498     // format for storing identifiers.
2499     clang::io::Emit16(Out, KeyLen);
2500     return std::make_pair(KeyLen, DataLen);
2501   }
2502 
2503   void EmitKey(raw_ostream& Out, const IdentifierInfo* II,
2504                unsigned KeyLen) {
2505     // Record the location of the key data.  This is used when generating
2506     // the mapping from persistent IDs to strings.
2507     Writer.SetIdentifierOffset(II, Out.tell());
2508     Out.write(II->getNameStart(), KeyLen);
2509   }
2510 
2511   void EmitData(raw_ostream& Out, IdentifierInfo* II,
2512                 IdentID ID, unsigned) {
2513     MacroInfo *Macro = 0;
2514     if (!isInterestingIdentifier(II, Macro)) {
2515       clang::io::Emit32(Out, ID << 1);
2516       return;
2517     }
2518 
2519     clang::io::Emit32(Out, (ID << 1) | 0x01);
2520     uint32_t Bits = 0;
2521     bool HasMacroDefinition = hasMacroDefinition(II, Macro);
2522     Bits = (uint32_t)II->getObjCOrBuiltinID();
2523     assert((Bits & 0x7ff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
2524     Bits = (Bits << 1) | unsigned(HasMacroDefinition);
2525     Bits = (Bits << 1) | unsigned(II->isExtensionToken());
2526     Bits = (Bits << 1) | unsigned(II->isPoisoned());
2527     Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
2528     Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
2529     clang::io::Emit16(Out, Bits);
2530 
2531     if (HasMacroDefinition) {
2532       clang::io::Emit32(Out, Writer.getMacroOffset(II));
2533       clang::io::Emit32(Out,
2534         Writer.inferSubmoduleIDFromLocation(Macro->getDefinitionLoc()));
2535     }
2536 
2537     // Emit the declaration IDs in reverse order, because the
2538     // IdentifierResolver provides the declarations as they would be
2539     // visible (e.g., the function "stat" would come before the struct
2540     // "stat"), but the ASTReader adds declarations to the end of the list
2541     // (so we need to see the struct "status" before the function "status").
2542     // Only emit declarations that aren't from a chained PCH, though.
2543     SmallVector<Decl *, 16> Decls(IdResolver.begin(II),
2544                                   IdResolver.end());
2545     for (SmallVector<Decl *, 16>::reverse_iterator D = Decls.rbegin(),
2546                                                 DEnd = Decls.rend();
2547          D != DEnd; ++D)
2548       clang::io::Emit32(Out, Writer.getDeclID(*D));
2549   }
2550 };
2551 } // end anonymous namespace
2552 
2553 /// \brief Write the identifier table into the AST file.
2554 ///
2555 /// The identifier table consists of a blob containing string data
2556 /// (the actual identifiers themselves) and a separate "offsets" index
2557 /// that maps identifier IDs to locations within the blob.
2558 void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
2559                                      IdentifierResolver &IdResolver,
2560                                      bool IsModule) {
2561   using namespace llvm;
2562 
2563   // Create and write out the blob that contains the identifier
2564   // strings.
2565   {
2566     OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
2567     ASTIdentifierTableTrait Trait(*this, PP, IdResolver, IsModule);
2568 
2569     // Look for any identifiers that were named while processing the
2570     // headers, but are otherwise not needed. We add these to the hash
2571     // table to enable checking of the predefines buffer in the case
2572     // where the user adds new macro definitions when building the AST
2573     // file.
2574     for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
2575                                 IDEnd = PP.getIdentifierTable().end();
2576          ID != IDEnd; ++ID)
2577       getIdentifierRef(ID->second);
2578 
2579     // Create the on-disk hash table representation. We only store offsets
2580     // for identifiers that appear here for the first time.
2581     IdentifierOffsets.resize(NextIdentID - FirstIdentID);
2582     for (llvm::DenseMap<const IdentifierInfo *, IdentID>::iterator
2583            ID = IdentifierIDs.begin(), IDEnd = IdentifierIDs.end();
2584          ID != IDEnd; ++ID) {
2585       assert(ID->first && "NULL identifier in identifier table");
2586       if (!Chain || !ID->first->isFromAST() ||
2587           ID->first->hasChangedSinceDeserialization())
2588         Generator.insert(const_cast<IdentifierInfo *>(ID->first), ID->second,
2589                          Trait);
2590     }
2591 
2592     // Create the on-disk hash table in a buffer.
2593     llvm::SmallString<4096> IdentifierTable;
2594     uint32_t BucketOffset;
2595     {
2596       ASTIdentifierTableTrait Trait(*this, PP, IdResolver, IsModule);
2597       llvm::raw_svector_ostream Out(IdentifierTable);
2598       // Make sure that no bucket is at offset 0
2599       clang::io::Emit32(Out, 0);
2600       BucketOffset = Generator.Emit(Out, Trait);
2601     }
2602 
2603     // Create a blob abbreviation
2604     BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2605     Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
2606     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2607     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2608     unsigned IDTableAbbrev = Stream.EmitAbbrev(Abbrev);
2609 
2610     // Write the identifier table
2611     RecordData Record;
2612     Record.push_back(IDENTIFIER_TABLE);
2613     Record.push_back(BucketOffset);
2614     Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable.str());
2615   }
2616 
2617   // Write the offsets table for identifier IDs.
2618   BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2619   Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
2620   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
2621   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2622   Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2623   unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2624 
2625   RecordData Record;
2626   Record.push_back(IDENTIFIER_OFFSET);
2627   Record.push_back(IdentifierOffsets.size());
2628   Record.push_back(FirstIdentID - NUM_PREDEF_IDENT_IDS);
2629   Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
2630                             data(IdentifierOffsets));
2631 }
2632 
2633 //===----------------------------------------------------------------------===//
2634 // DeclContext's Name Lookup Table Serialization
2635 //===----------------------------------------------------------------------===//
2636 
2637 namespace {
2638 // Trait used for the on-disk hash table used in the method pool.
2639 class ASTDeclContextNameLookupTrait {
2640   ASTWriter &Writer;
2641 
2642 public:
2643   typedef DeclarationName key_type;
2644   typedef key_type key_type_ref;
2645 
2646   typedef DeclContext::lookup_result data_type;
2647   typedef const data_type& data_type_ref;
2648 
2649   explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) { }
2650 
2651   unsigned ComputeHash(DeclarationName Name) {
2652     llvm::FoldingSetNodeID ID;
2653     ID.AddInteger(Name.getNameKind());
2654 
2655     switch (Name.getNameKind()) {
2656     case DeclarationName::Identifier:
2657       ID.AddString(Name.getAsIdentifierInfo()->getName());
2658       break;
2659     case DeclarationName::ObjCZeroArgSelector:
2660     case DeclarationName::ObjCOneArgSelector:
2661     case DeclarationName::ObjCMultiArgSelector:
2662       ID.AddInteger(serialization::ComputeHash(Name.getObjCSelector()));
2663       break;
2664     case DeclarationName::CXXConstructorName:
2665     case DeclarationName::CXXDestructorName:
2666     case DeclarationName::CXXConversionFunctionName:
2667       break;
2668     case DeclarationName::CXXOperatorName:
2669       ID.AddInteger(Name.getCXXOverloadedOperator());
2670       break;
2671     case DeclarationName::CXXLiteralOperatorName:
2672       ID.AddString(Name.getCXXLiteralIdentifier()->getName());
2673     case DeclarationName::CXXUsingDirective:
2674       break;
2675     }
2676 
2677     return ID.ComputeHash();
2678   }
2679 
2680   std::pair<unsigned,unsigned>
2681     EmitKeyDataLength(raw_ostream& Out, DeclarationName Name,
2682                       data_type_ref Lookup) {
2683     unsigned KeyLen = 1;
2684     switch (Name.getNameKind()) {
2685     case DeclarationName::Identifier:
2686     case DeclarationName::ObjCZeroArgSelector:
2687     case DeclarationName::ObjCOneArgSelector:
2688     case DeclarationName::ObjCMultiArgSelector:
2689     case DeclarationName::CXXLiteralOperatorName:
2690       KeyLen += 4;
2691       break;
2692     case DeclarationName::CXXOperatorName:
2693       KeyLen += 1;
2694       break;
2695     case DeclarationName::CXXConstructorName:
2696     case DeclarationName::CXXDestructorName:
2697     case DeclarationName::CXXConversionFunctionName:
2698     case DeclarationName::CXXUsingDirective:
2699       break;
2700     }
2701     clang::io::Emit16(Out, KeyLen);
2702 
2703     // 2 bytes for num of decls and 4 for each DeclID.
2704     unsigned DataLen = 2 + 4 * (Lookup.second - Lookup.first);
2705     clang::io::Emit16(Out, DataLen);
2706 
2707     return std::make_pair(KeyLen, DataLen);
2708   }
2709 
2710   void EmitKey(raw_ostream& Out, DeclarationName Name, unsigned) {
2711     using namespace clang::io;
2712 
2713     assert(Name.getNameKind() < 0x100 && "Invalid name kind ?");
2714     Emit8(Out, Name.getNameKind());
2715     switch (Name.getNameKind()) {
2716     case DeclarationName::Identifier:
2717       Emit32(Out, Writer.getIdentifierRef(Name.getAsIdentifierInfo()));
2718       break;
2719     case DeclarationName::ObjCZeroArgSelector:
2720     case DeclarationName::ObjCOneArgSelector:
2721     case DeclarationName::ObjCMultiArgSelector:
2722       Emit32(Out, Writer.getSelectorRef(Name.getObjCSelector()));
2723       break;
2724     case DeclarationName::CXXOperatorName:
2725       assert(Name.getCXXOverloadedOperator() < 0x100 && "Invalid operator ?");
2726       Emit8(Out, Name.getCXXOverloadedOperator());
2727       break;
2728     case DeclarationName::CXXLiteralOperatorName:
2729       Emit32(Out, Writer.getIdentifierRef(Name.getCXXLiteralIdentifier()));
2730       break;
2731     case DeclarationName::CXXConstructorName:
2732     case DeclarationName::CXXDestructorName:
2733     case DeclarationName::CXXConversionFunctionName:
2734     case DeclarationName::CXXUsingDirective:
2735       break;
2736     }
2737   }
2738 
2739   void EmitData(raw_ostream& Out, key_type_ref,
2740                 data_type Lookup, unsigned DataLen) {
2741     uint64_t Start = Out.tell(); (void)Start;
2742     clang::io::Emit16(Out, Lookup.second - Lookup.first);
2743     for (; Lookup.first != Lookup.second; ++Lookup.first)
2744       clang::io::Emit32(Out, Writer.GetDeclRef(*Lookup.first));
2745 
2746     assert(Out.tell() - Start == DataLen && "Data length is wrong");
2747   }
2748 };
2749 } // end anonymous namespace
2750 
2751 /// \brief Write the block containing all of the declaration IDs
2752 /// visible from the given DeclContext.
2753 ///
2754 /// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
2755 /// bitstream, or 0 if no block was written.
2756 uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
2757                                                  DeclContext *DC) {
2758   if (DC->getPrimaryContext() != DC)
2759     return 0;
2760 
2761   // Since there is no name lookup into functions or methods, don't bother to
2762   // build a visible-declarations table for these entities.
2763   if (DC->isFunctionOrMethod())
2764     return 0;
2765 
2766   // If not in C++, we perform name lookup for the translation unit via the
2767   // IdentifierInfo chains, don't bother to build a visible-declarations table.
2768   // FIXME: In C++ we need the visible declarations in order to "see" the
2769   // friend declarations, is there a way to do this without writing the table ?
2770   if (DC->isTranslationUnit() && !Context.getLangOptions().CPlusPlus)
2771     return 0;
2772 
2773   // Force the DeclContext to build a its name-lookup table.
2774   if (!DC->hasExternalVisibleStorage())
2775     DC->lookup(DeclarationName());
2776 
2777   // Serialize the contents of the mapping used for lookup. Note that,
2778   // although we have two very different code paths, the serialized
2779   // representation is the same for both cases: a declaration name,
2780   // followed by a size, followed by references to the visible
2781   // declarations that have that name.
2782   uint64_t Offset = Stream.GetCurrentBitNo();
2783   StoredDeclsMap *Map = static_cast<StoredDeclsMap*>(DC->getLookupPtr());
2784   if (!Map || Map->empty())
2785     return 0;
2786 
2787   OnDiskChainedHashTableGenerator<ASTDeclContextNameLookupTrait> Generator;
2788   ASTDeclContextNameLookupTrait Trait(*this);
2789 
2790   // Create the on-disk hash table representation.
2791   DeclarationName ConversionName;
2792   llvm::SmallVector<NamedDecl *, 4> ConversionDecls;
2793   for (StoredDeclsMap::iterator D = Map->begin(), DEnd = Map->end();
2794        D != DEnd; ++D) {
2795     DeclarationName Name = D->first;
2796     DeclContext::lookup_result Result = D->second.getLookupResult();
2797     if (Result.first != Result.second) {
2798       if (Name.getNameKind() == DeclarationName::CXXConversionFunctionName) {
2799         // Hash all conversion function names to the same name. The actual
2800         // type information in conversion function name is not used in the
2801         // key (since such type information is not stable across different
2802         // modules), so the intended effect is to coalesce all of the conversion
2803         // functions under a single key.
2804         if (!ConversionName)
2805           ConversionName = Name;
2806         ConversionDecls.append(Result.first, Result.second);
2807         continue;
2808       }
2809 
2810       Generator.insert(Name, Result, Trait);
2811     }
2812   }
2813 
2814   // Add the conversion functions
2815   if (!ConversionDecls.empty()) {
2816     Generator.insert(ConversionName,
2817                      DeclContext::lookup_result(ConversionDecls.begin(),
2818                                                 ConversionDecls.end()),
2819                      Trait);
2820   }
2821 
2822   // Create the on-disk hash table in a buffer.
2823   llvm::SmallString<4096> LookupTable;
2824   uint32_t BucketOffset;
2825   {
2826     llvm::raw_svector_ostream Out(LookupTable);
2827     // Make sure that no bucket is at offset 0
2828     clang::io::Emit32(Out, 0);
2829     BucketOffset = Generator.Emit(Out, Trait);
2830   }
2831 
2832   // Write the lookup table
2833   RecordData Record;
2834   Record.push_back(DECL_CONTEXT_VISIBLE);
2835   Record.push_back(BucketOffset);
2836   Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
2837                             LookupTable.str());
2838 
2839   Stream.EmitRecord(DECL_CONTEXT_VISIBLE, Record);
2840   ++NumVisibleDeclContexts;
2841   return Offset;
2842 }
2843 
2844 /// \brief Write an UPDATE_VISIBLE block for the given context.
2845 ///
2846 /// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
2847 /// DeclContext in a dependent AST file. As such, they only exist for the TU
2848 /// (in C++) and for namespaces.
2849 void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
2850   StoredDeclsMap *Map = static_cast<StoredDeclsMap*>(DC->getLookupPtr());
2851   if (!Map || Map->empty())
2852     return;
2853 
2854   OnDiskChainedHashTableGenerator<ASTDeclContextNameLookupTrait> Generator;
2855   ASTDeclContextNameLookupTrait Trait(*this);
2856 
2857   // Create the hash table.
2858   for (StoredDeclsMap::iterator D = Map->begin(), DEnd = Map->end();
2859        D != DEnd; ++D) {
2860     DeclarationName Name = D->first;
2861     DeclContext::lookup_result Result = D->second.getLookupResult();
2862     // For any name that appears in this table, the results are complete, i.e.
2863     // they overwrite results from previous PCHs. Merging is always a mess.
2864     if (Result.first != Result.second)
2865       Generator.insert(Name, Result, Trait);
2866   }
2867 
2868   // Create the on-disk hash table in a buffer.
2869   llvm::SmallString<4096> LookupTable;
2870   uint32_t BucketOffset;
2871   {
2872     llvm::raw_svector_ostream Out(LookupTable);
2873     // Make sure that no bucket is at offset 0
2874     clang::io::Emit32(Out, 0);
2875     BucketOffset = Generator.Emit(Out, Trait);
2876   }
2877 
2878   // Write the lookup table
2879   RecordData Record;
2880   Record.push_back(UPDATE_VISIBLE);
2881   Record.push_back(getDeclID(cast<Decl>(DC)));
2882   Record.push_back(BucketOffset);
2883   Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable.str());
2884 }
2885 
2886 /// \brief Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
2887 void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) {
2888   RecordData Record;
2889   Record.push_back(Opts.fp_contract);
2890   Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
2891 }
2892 
2893 /// \brief Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
2894 void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
2895   if (!SemaRef.Context.getLangOptions().OpenCL)
2896     return;
2897 
2898   const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
2899   RecordData Record;
2900 #define OPENCLEXT(nm)  Record.push_back(Opts.nm);
2901 #include "clang/Basic/OpenCLExtensions.def"
2902   Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
2903 }
2904 
2905 //===----------------------------------------------------------------------===//
2906 // General Serialization Routines
2907 //===----------------------------------------------------------------------===//
2908 
2909 /// \brief Write a record containing the given attributes.
2910 void ASTWriter::WriteAttributes(const AttrVec &Attrs, RecordDataImpl &Record) {
2911   Record.push_back(Attrs.size());
2912   for (AttrVec::const_iterator i = Attrs.begin(), e = Attrs.end(); i != e; ++i){
2913     const Attr * A = *i;
2914     Record.push_back(A->getKind()); // FIXME: stable encoding, target attrs
2915     AddSourceRange(A->getRange(), Record);
2916 
2917 #include "clang/Serialization/AttrPCHWrite.inc"
2918 
2919   }
2920 }
2921 
2922 void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
2923   Record.push_back(Str.size());
2924   Record.insert(Record.end(), Str.begin(), Str.end());
2925 }
2926 
2927 void ASTWriter::AddVersionTuple(const VersionTuple &Version,
2928                                 RecordDataImpl &Record) {
2929   Record.push_back(Version.getMajor());
2930   if (llvm::Optional<unsigned> Minor = Version.getMinor())
2931     Record.push_back(*Minor + 1);
2932   else
2933     Record.push_back(0);
2934   if (llvm::Optional<unsigned> Subminor = Version.getSubminor())
2935     Record.push_back(*Subminor + 1);
2936   else
2937     Record.push_back(0);
2938 }
2939 
2940 /// \brief Note that the identifier II occurs at the given offset
2941 /// within the identifier table.
2942 void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
2943   IdentID ID = IdentifierIDs[II];
2944   // Only store offsets new to this AST file. Other identifier names are looked
2945   // up earlier in the chain and thus don't need an offset.
2946   if (ID >= FirstIdentID)
2947     IdentifierOffsets[ID - FirstIdentID] = Offset;
2948 }
2949 
2950 /// \brief Note that the selector Sel occurs at the given offset
2951 /// within the method pool/selector table.
2952 void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
2953   unsigned ID = SelectorIDs[Sel];
2954   assert(ID && "Unknown selector");
2955   // Don't record offsets for selectors that are also available in a different
2956   // file.
2957   if (ID < FirstSelectorID)
2958     return;
2959   SelectorOffsets[ID - FirstSelectorID] = Offset;
2960 }
2961 
2962 ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream)
2963   : Stream(Stream), Context(0), PP(0), Chain(0), WritingModule(0),
2964     WritingAST(false),
2965     FirstDeclID(NUM_PREDEF_DECL_IDS), NextDeclID(FirstDeclID),
2966     FirstTypeID(NUM_PREDEF_TYPE_IDS), NextTypeID(FirstTypeID),
2967     FirstIdentID(NUM_PREDEF_IDENT_IDS), NextIdentID(FirstIdentID),
2968     FirstSubmoduleID(NUM_PREDEF_SUBMODULE_IDS),
2969     NextSubmoduleID(FirstSubmoduleID),
2970     FirstSelectorID(NUM_PREDEF_SELECTOR_IDS), NextSelectorID(FirstSelectorID),
2971     CollectedStmts(&StmtsToEmit),
2972     NumStatements(0), NumMacros(0), NumLexicalDeclContexts(0),
2973     NumVisibleDeclContexts(0),
2974     NextCXXBaseSpecifiersID(1),
2975     DeclParmVarAbbrev(0), DeclContextLexicalAbbrev(0),
2976     DeclContextVisibleLookupAbbrev(0), UpdateVisibleAbbrev(0),
2977     DeclRefExprAbbrev(0), CharacterLiteralAbbrev(0),
2978     DeclRecordAbbrev(0), IntegerLiteralAbbrev(0),
2979     DeclTypedefAbbrev(0),
2980     DeclVarAbbrev(0), DeclFieldAbbrev(0),
2981     DeclEnumAbbrev(0), DeclObjCIvarAbbrev(0)
2982 {
2983 }
2984 
2985 ASTWriter::~ASTWriter() {
2986   for (FileDeclIDsTy::iterator
2987          I = FileDeclIDs.begin(), E = FileDeclIDs.end(); I != E; ++I)
2988     delete I->second;
2989 }
2990 
2991 void ASTWriter::WriteAST(Sema &SemaRef, MemorizeStatCalls *StatCalls,
2992                          const std::string &OutputFile,
2993                          Module *WritingModule, StringRef isysroot) {
2994   WritingAST = true;
2995 
2996   // Emit the file header.
2997   Stream.Emit((unsigned)'C', 8);
2998   Stream.Emit((unsigned)'P', 8);
2999   Stream.Emit((unsigned)'C', 8);
3000   Stream.Emit((unsigned)'H', 8);
3001 
3002   WriteBlockInfoBlock();
3003 
3004   Context = &SemaRef.Context;
3005   PP = &SemaRef.PP;
3006   this->WritingModule = WritingModule;
3007   WriteASTCore(SemaRef, StatCalls, isysroot, OutputFile, WritingModule);
3008   Context = 0;
3009   PP = 0;
3010   this->WritingModule = 0;
3011 
3012   WritingAST = false;
3013 }
3014 
3015 template<typename Vector>
3016 static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec,
3017                                ASTWriter::RecordData &Record) {
3018   for (typename Vector::iterator I = Vec.begin(0, true), E = Vec.end();
3019        I != E; ++I)  {
3020     Writer.AddDeclRef(*I, Record);
3021   }
3022 }
3023 
3024 void ASTWriter::WriteASTCore(Sema &SemaRef, MemorizeStatCalls *StatCalls,
3025                              StringRef isysroot,
3026                              const std::string &OutputFile,
3027                              Module *WritingModule) {
3028   using namespace llvm;
3029 
3030   // Make sure that the AST reader knows to finalize itself.
3031   if (Chain)
3032     Chain->finalizeForWriting();
3033 
3034   ASTContext &Context = SemaRef.Context;
3035   Preprocessor &PP = SemaRef.PP;
3036 
3037   // Set up predefined declaration IDs.
3038   DeclIDs[Context.getTranslationUnitDecl()] = PREDEF_DECL_TRANSLATION_UNIT_ID;
3039   if (Context.ObjCIdDecl)
3040     DeclIDs[Context.ObjCIdDecl] = PREDEF_DECL_OBJC_ID_ID;
3041   if (Context.ObjCSelDecl)
3042     DeclIDs[Context.ObjCSelDecl] = PREDEF_DECL_OBJC_SEL_ID;
3043   if (Context.ObjCClassDecl)
3044     DeclIDs[Context.ObjCClassDecl] = PREDEF_DECL_OBJC_CLASS_ID;
3045   if (Context.Int128Decl)
3046     DeclIDs[Context.Int128Decl] = PREDEF_DECL_INT_128_ID;
3047   if (Context.UInt128Decl)
3048     DeclIDs[Context.UInt128Decl] = PREDEF_DECL_UNSIGNED_INT_128_ID;
3049   if (Context.ObjCInstanceTypeDecl)
3050     DeclIDs[Context.ObjCInstanceTypeDecl] = PREDEF_DECL_OBJC_INSTANCETYPE_ID;
3051 
3052   if (!Chain) {
3053     // Make sure that we emit IdentifierInfos (and any attached
3054     // declarations) for builtins. We don't need to do this when we're
3055     // emitting chained PCH files, because all of the builtins will be
3056     // in the original PCH file.
3057     // FIXME: Modules won't like this at all.
3058     IdentifierTable &Table = PP.getIdentifierTable();
3059     SmallVector<const char *, 32> BuiltinNames;
3060     Context.BuiltinInfo.GetBuiltinNames(BuiltinNames,
3061                                         Context.getLangOptions().NoBuiltin);
3062     for (unsigned I = 0, N = BuiltinNames.size(); I != N; ++I)
3063       getIdentifierRef(&Table.get(BuiltinNames[I]));
3064   }
3065 
3066   // If there are any out-of-date identifiers, bring them up to date.
3067   if (ExternalPreprocessorSource *ExtSource = PP.getExternalSource()) {
3068     for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
3069                                 IDEnd = PP.getIdentifierTable().end();
3070          ID != IDEnd; ++ID)
3071       if (ID->second->isOutOfDate())
3072         ExtSource->updateOutOfDateIdentifier(*ID->second);
3073   }
3074 
3075   // Build a record containing all of the tentative definitions in this file, in
3076   // TentativeDefinitions order.  Generally, this record will be empty for
3077   // headers.
3078   RecordData TentativeDefinitions;
3079   AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions);
3080 
3081   // Build a record containing all of the file scoped decls in this file.
3082   RecordData UnusedFileScopedDecls;
3083   AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls,
3084                      UnusedFileScopedDecls);
3085 
3086   // Build a record containing all of the delegating constructors we still need
3087   // to resolve.
3088   RecordData DelegatingCtorDecls;
3089   AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls);
3090 
3091   // Write the set of weak, undeclared identifiers. We always write the
3092   // entire table, since later PCH files in a PCH chain are only interested in
3093   // the results at the end of the chain.
3094   RecordData WeakUndeclaredIdentifiers;
3095   if (!SemaRef.WeakUndeclaredIdentifiers.empty()) {
3096     for (llvm::DenseMap<IdentifierInfo*,WeakInfo>::iterator
3097          I = SemaRef.WeakUndeclaredIdentifiers.begin(),
3098          E = SemaRef.WeakUndeclaredIdentifiers.end(); I != E; ++I) {
3099       AddIdentifierRef(I->first, WeakUndeclaredIdentifiers);
3100       AddIdentifierRef(I->second.getAlias(), WeakUndeclaredIdentifiers);
3101       AddSourceLocation(I->second.getLocation(), WeakUndeclaredIdentifiers);
3102       WeakUndeclaredIdentifiers.push_back(I->second.getUsed());
3103     }
3104   }
3105 
3106   // Build a record containing all of the locally-scoped external
3107   // declarations in this header file. Generally, this record will be
3108   // empty.
3109   RecordData LocallyScopedExternalDecls;
3110   // FIXME: This is filling in the AST file in densemap order which is
3111   // nondeterminstic!
3112   for (llvm::DenseMap<DeclarationName, NamedDecl *>::iterator
3113          TD = SemaRef.LocallyScopedExternalDecls.begin(),
3114          TDEnd = SemaRef.LocallyScopedExternalDecls.end();
3115        TD != TDEnd; ++TD) {
3116     if (!TD->second->isFromASTFile())
3117       AddDeclRef(TD->second, LocallyScopedExternalDecls);
3118   }
3119 
3120   // Build a record containing all of the ext_vector declarations.
3121   RecordData ExtVectorDecls;
3122   AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
3123 
3124   // Build a record containing all of the VTable uses information.
3125   RecordData VTableUses;
3126   if (!SemaRef.VTableUses.empty()) {
3127     for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
3128       AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
3129       AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
3130       VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
3131     }
3132   }
3133 
3134   // Build a record containing all of dynamic classes declarations.
3135   RecordData DynamicClasses;
3136   AddLazyVectorDecls(*this, SemaRef.DynamicClasses, DynamicClasses);
3137 
3138   // Build a record containing all of pending implicit instantiations.
3139   RecordData PendingInstantiations;
3140   for (std::deque<Sema::PendingImplicitInstantiation>::iterator
3141          I = SemaRef.PendingInstantiations.begin(),
3142          N = SemaRef.PendingInstantiations.end(); I != N; ++I) {
3143     AddDeclRef(I->first, PendingInstantiations);
3144     AddSourceLocation(I->second, PendingInstantiations);
3145   }
3146   assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
3147          "There are local ones at end of translation unit!");
3148 
3149   // Build a record containing some declaration references.
3150   RecordData SemaDeclRefs;
3151   if (SemaRef.StdNamespace || SemaRef.StdBadAlloc) {
3152     AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
3153     AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
3154   }
3155 
3156   RecordData CUDASpecialDeclRefs;
3157   if (Context.getcudaConfigureCallDecl()) {
3158     AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs);
3159   }
3160 
3161   // Build a record containing all of the known namespaces.
3162   RecordData KnownNamespaces;
3163   for (llvm::DenseMap<NamespaceDecl*, bool>::iterator
3164             I = SemaRef.KnownNamespaces.begin(),
3165          IEnd = SemaRef.KnownNamespaces.end();
3166        I != IEnd; ++I) {
3167     if (!I->second)
3168       AddDeclRef(I->first, KnownNamespaces);
3169   }
3170 
3171   // Write the remaining AST contents.
3172   RecordData Record;
3173   Stream.EnterSubblock(AST_BLOCK_ID, 5);
3174   WriteMetadata(Context, isysroot, OutputFile);
3175   WriteLanguageOptions(Context.getLangOptions());
3176   if (StatCalls && isysroot.empty())
3177     WriteStatCache(*StatCalls);
3178 
3179   // Create a lexical update block containing all of the declarations in the
3180   // translation unit that do not come from other AST files.
3181   const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
3182   SmallVector<KindDeclIDPair, 64> NewGlobalDecls;
3183   for (DeclContext::decl_iterator I = TU->noload_decls_begin(),
3184                                   E = TU->noload_decls_end();
3185        I != E; ++I) {
3186     if (!(*I)->isFromASTFile())
3187       NewGlobalDecls.push_back(std::make_pair((*I)->getKind(), GetDeclRef(*I)));
3188   }
3189 
3190   llvm::BitCodeAbbrev *Abv = new llvm::BitCodeAbbrev();
3191   Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
3192   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
3193   unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(Abv);
3194   Record.clear();
3195   Record.push_back(TU_UPDATE_LEXICAL);
3196   Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
3197                             data(NewGlobalDecls));
3198 
3199   // And a visible updates block for the translation unit.
3200   Abv = new llvm::BitCodeAbbrev();
3201   Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
3202   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
3203   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed, 32));
3204   Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
3205   UpdateVisibleAbbrev = Stream.EmitAbbrev(Abv);
3206   WriteDeclContextVisibleUpdate(TU);
3207 
3208   // If the translation unit has an anonymous namespace, and we don't already
3209   // have an update block for it, write it as an update block.
3210   if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
3211     ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
3212     if (Record.empty()) {
3213       Record.push_back(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE);
3214       Record.push_back(reinterpret_cast<uint64_t>(NS));
3215     }
3216   }
3217 
3218   // Resolve any declaration pointers within the declaration updates block.
3219   ResolveDeclUpdatesBlocks();
3220 
3221   // Form the record of special types.
3222   RecordData SpecialTypes;
3223   AddTypeRef(Context.getBuiltinVaListType(), SpecialTypes);
3224   AddTypeRef(Context.ObjCProtoType, SpecialTypes);
3225   AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes);
3226   AddTypeRef(Context.getFILEType(), SpecialTypes);
3227   AddTypeRef(Context.getjmp_bufType(), SpecialTypes);
3228   AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes);
3229   AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes);
3230   AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes);
3231   AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes);
3232   AddTypeRef(Context.getucontext_tType(), SpecialTypes);
3233 
3234   // Keep writing types and declarations until all types and
3235   // declarations have been written.
3236   Stream.EnterSubblock(DECLTYPES_BLOCK_ID, NUM_ALLOWED_ABBREVS_SIZE);
3237   WriteDeclsBlockAbbrevs();
3238   for (DeclsToRewriteTy::iterator I = DeclsToRewrite.begin(),
3239                                   E = DeclsToRewrite.end();
3240        I != E; ++I)
3241     DeclTypesToEmit.push(const_cast<Decl*>(*I));
3242   while (!DeclTypesToEmit.empty()) {
3243     DeclOrType DOT = DeclTypesToEmit.front();
3244     DeclTypesToEmit.pop();
3245     if (DOT.isType())
3246       WriteType(DOT.getType());
3247     else
3248       WriteDecl(Context, DOT.getDecl());
3249   }
3250   Stream.ExitBlock();
3251 
3252   WriteFileDeclIDsMap();
3253   WriteSourceManagerBlock(Context.getSourceManager(), PP, isysroot);
3254 
3255   if (Chain) {
3256     // Write the mapping information describing our module dependencies and how
3257     // each of those modules were mapped into our own offset/ID space, so that
3258     // the reader can build the appropriate mapping to its own offset/ID space.
3259     // The map consists solely of a blob with the following format:
3260     // *(module-name-len:i16 module-name:len*i8
3261     //   source-location-offset:i32
3262     //   identifier-id:i32
3263     //   preprocessed-entity-id:i32
3264     //   macro-definition-id:i32
3265     //   submodule-id:i32
3266     //   selector-id:i32
3267     //   declaration-id:i32
3268     //   c++-base-specifiers-id:i32
3269     //   type-id:i32)
3270     //
3271     llvm::BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
3272     Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
3273     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3274     unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(Abbrev);
3275     llvm::SmallString<2048> Buffer;
3276     {
3277       llvm::raw_svector_ostream Out(Buffer);
3278       for (ModuleManager::ModuleConstIterator M = Chain->ModuleMgr.begin(),
3279                                            MEnd = Chain->ModuleMgr.end();
3280            M != MEnd; ++M) {
3281         StringRef FileName = (*M)->FileName;
3282         io::Emit16(Out, FileName.size());
3283         Out.write(FileName.data(), FileName.size());
3284         io::Emit32(Out, (*M)->SLocEntryBaseOffset);
3285         io::Emit32(Out, (*M)->BaseIdentifierID);
3286         io::Emit32(Out, (*M)->BasePreprocessedEntityID);
3287         io::Emit32(Out, (*M)->BaseSubmoduleID);
3288         io::Emit32(Out, (*M)->BaseSelectorID);
3289         io::Emit32(Out, (*M)->BaseDeclID);
3290         io::Emit32(Out, (*M)->BaseTypeIndex);
3291       }
3292     }
3293     Record.clear();
3294     Record.push_back(MODULE_OFFSET_MAP);
3295     Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
3296                               Buffer.data(), Buffer.size());
3297   }
3298   WritePreprocessor(PP, WritingModule != 0);
3299   WriteHeaderSearch(PP.getHeaderSearchInfo(), isysroot);
3300   WriteSelectors(SemaRef);
3301   WriteReferencedSelectorsPool(SemaRef);
3302   WriteIdentifierTable(PP, SemaRef.IdResolver, WritingModule != 0);
3303   WriteFPPragmaOptions(SemaRef.getFPOptions());
3304   WriteOpenCLExtensions(SemaRef);
3305 
3306   WriteTypeDeclOffsets();
3307   WritePragmaDiagnosticMappings(Context.getDiagnostics());
3308 
3309   WriteCXXBaseSpecifiersOffsets();
3310 
3311   // If we're emitting a module, write out the submodule information.
3312   if (WritingModule)
3313     WriteSubmodules(WritingModule);
3314 
3315   Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
3316 
3317   // Write the record containing external, unnamed definitions.
3318   if (!ExternalDefinitions.empty())
3319     Stream.EmitRecord(EXTERNAL_DEFINITIONS, ExternalDefinitions);
3320 
3321   // Write the record containing tentative definitions.
3322   if (!TentativeDefinitions.empty())
3323     Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
3324 
3325   // Write the record containing unused file scoped decls.
3326   if (!UnusedFileScopedDecls.empty())
3327     Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
3328 
3329   // Write the record containing weak undeclared identifiers.
3330   if (!WeakUndeclaredIdentifiers.empty())
3331     Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
3332                       WeakUndeclaredIdentifiers);
3333 
3334   // Write the record containing locally-scoped external definitions.
3335   if (!LocallyScopedExternalDecls.empty())
3336     Stream.EmitRecord(LOCALLY_SCOPED_EXTERNAL_DECLS,
3337                       LocallyScopedExternalDecls);
3338 
3339   // Write the record containing ext_vector type names.
3340   if (!ExtVectorDecls.empty())
3341     Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
3342 
3343   // Write the record containing VTable uses information.
3344   if (!VTableUses.empty())
3345     Stream.EmitRecord(VTABLE_USES, VTableUses);
3346 
3347   // Write the record containing dynamic classes declarations.
3348   if (!DynamicClasses.empty())
3349     Stream.EmitRecord(DYNAMIC_CLASSES, DynamicClasses);
3350 
3351   // Write the record containing pending implicit instantiations.
3352   if (!PendingInstantiations.empty())
3353     Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
3354 
3355   // Write the record containing declaration references of Sema.
3356   if (!SemaDeclRefs.empty())
3357     Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
3358 
3359   // Write the record containing CUDA-specific declaration references.
3360   if (!CUDASpecialDeclRefs.empty())
3361     Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
3362 
3363   // Write the delegating constructors.
3364   if (!DelegatingCtorDecls.empty())
3365     Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
3366 
3367   // Write the known namespaces.
3368   if (!KnownNamespaces.empty())
3369     Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
3370 
3371   // Write the visible updates to DeclContexts.
3372   for (llvm::SmallPtrSet<const DeclContext *, 16>::iterator
3373        I = UpdatedDeclContexts.begin(),
3374        E = UpdatedDeclContexts.end();
3375        I != E; ++I)
3376     WriteDeclContextVisibleUpdate(*I);
3377 
3378   if (!WritingModule) {
3379     // Write the submodules that were imported, if any.
3380     RecordData ImportedModules;
3381     for (ASTContext::import_iterator I = Context.local_import_begin(),
3382                                   IEnd = Context.local_import_end();
3383          I != IEnd; ++I) {
3384       assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end());
3385       ImportedModules.push_back(SubmoduleIDs[I->getImportedModule()]);
3386     }
3387     if (!ImportedModules.empty()) {
3388       // Sort module IDs.
3389       llvm::array_pod_sort(ImportedModules.begin(), ImportedModules.end());
3390 
3391       // Unique module IDs.
3392       ImportedModules.erase(std::unique(ImportedModules.begin(),
3393                                         ImportedModules.end()),
3394                             ImportedModules.end());
3395 
3396       Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
3397     }
3398   }
3399 
3400   WriteDeclUpdatesBlocks();
3401   WriteDeclReplacementsBlock();
3402   WriteChainedObjCCategories();
3403 
3404   if (!LocalRedeclarations.empty()) {
3405     // Sort the local redeclarations info by the first declaration ID,
3406     // since the reader will be perforing binary searches on this information.
3407     llvm::array_pod_sort(LocalRedeclarations.begin(),LocalRedeclarations.end());
3408 
3409     llvm::BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
3410     Abbrev->Add(BitCodeAbbrevOp(LOCAL_REDECLARATIONS));
3411     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
3412     Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3413     unsigned AbbrevID = Stream.EmitAbbrev(Abbrev);
3414 
3415     Record.clear();
3416     Record.push_back(LOCAL_REDECLARATIONS);
3417     Record.push_back(LocalRedeclarations.size());
3418     Stream.EmitRecordWithBlob(AbbrevID, Record,
3419       reinterpret_cast<char*>(LocalRedeclarations.data()),
3420       LocalRedeclarations.size() * sizeof(LocalRedeclarationsInfo));
3421   }
3422 
3423   // Some simple statistics
3424   Record.clear();
3425   Record.push_back(NumStatements);
3426   Record.push_back(NumMacros);
3427   Record.push_back(NumLexicalDeclContexts);
3428   Record.push_back(NumVisibleDeclContexts);
3429   Stream.EmitRecord(STATISTICS, Record);
3430   Stream.ExitBlock();
3431 }
3432 
3433 /// \brief Go through the declaration update blocks and resolve declaration
3434 /// pointers into declaration IDs.
3435 void ASTWriter::ResolveDeclUpdatesBlocks() {
3436   for (DeclUpdateMap::iterator
3437        I = DeclUpdates.begin(), E = DeclUpdates.end(); I != E; ++I) {
3438     const Decl *D = I->first;
3439     UpdateRecord &URec = I->second;
3440 
3441     if (isRewritten(D))
3442       continue; // The decl will be written completely
3443 
3444     unsigned Idx = 0, N = URec.size();
3445     while (Idx < N) {
3446       switch ((DeclUpdateKind)URec[Idx++]) {
3447       case UPD_CXX_SET_DEFINITIONDATA:
3448       case UPD_CXX_ADDED_IMPLICIT_MEMBER:
3449       case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION:
3450       case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE:
3451       case UPD_OBJC_SET_CLASS_DEFINITIONDATA:
3452         URec[Idx] = GetDeclRef(reinterpret_cast<Decl *>(URec[Idx]));
3453         ++Idx;
3454         break;
3455 
3456       case UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER:
3457         ++Idx;
3458         break;
3459       }
3460     }
3461   }
3462 }
3463 
3464 void ASTWriter::WriteDeclUpdatesBlocks() {
3465   if (DeclUpdates.empty())
3466     return;
3467 
3468   RecordData OffsetsRecord;
3469   Stream.EnterSubblock(DECL_UPDATES_BLOCK_ID, NUM_ALLOWED_ABBREVS_SIZE);
3470   for (DeclUpdateMap::iterator
3471          I = DeclUpdates.begin(), E = DeclUpdates.end(); I != E; ++I) {
3472     const Decl *D = I->first;
3473     UpdateRecord &URec = I->second;
3474 
3475     if (isRewritten(D))
3476       continue; // The decl will be written completely,no need to store updates.
3477 
3478     uint64_t Offset = Stream.GetCurrentBitNo();
3479     Stream.EmitRecord(DECL_UPDATES, URec);
3480 
3481     OffsetsRecord.push_back(GetDeclRef(D));
3482     OffsetsRecord.push_back(Offset);
3483   }
3484   Stream.ExitBlock();
3485   Stream.EmitRecord(DECL_UPDATE_OFFSETS, OffsetsRecord);
3486 }
3487 
3488 void ASTWriter::WriteDeclReplacementsBlock() {
3489   if (ReplacedDecls.empty())
3490     return;
3491 
3492   RecordData Record;
3493   for (SmallVector<ReplacedDeclInfo, 16>::iterator
3494            I = ReplacedDecls.begin(), E = ReplacedDecls.end(); I != E; ++I) {
3495     Record.push_back(I->ID);
3496     Record.push_back(I->Offset);
3497     Record.push_back(I->Loc);
3498   }
3499   Stream.EmitRecord(DECL_REPLACEMENTS, Record);
3500 }
3501 
3502 void ASTWriter::WriteChainedObjCCategories() {
3503   if (LocalChainedObjCCategories.empty())
3504     return;
3505 
3506   RecordData Record;
3507   for (SmallVector<ChainedObjCCategoriesData, 16>::iterator
3508          I = LocalChainedObjCCategories.begin(),
3509          E = LocalChainedObjCCategories.end(); I != E; ++I) {
3510     ChainedObjCCategoriesData &Data = *I;
3511     if (isRewritten(Data.Interface))
3512       continue;
3513 
3514     assert(Data.Interface->getCategoryList());
3515     serialization::DeclID
3516         HeadCatID = getDeclID(Data.Interface->getCategoryList());
3517 
3518     Record.push_back(getDeclID(Data.Interface));
3519     Record.push_back(HeadCatID);
3520     Record.push_back(getDeclID(Data.TailCategory));
3521   }
3522   Stream.EmitRecord(OBJC_CHAINED_CATEGORIES, Record);
3523 }
3524 
3525 void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
3526   Record.push_back(Loc.getRawEncoding());
3527 }
3528 
3529 void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
3530   AddSourceLocation(Range.getBegin(), Record);
3531   AddSourceLocation(Range.getEnd(), Record);
3532 }
3533 
3534 void ASTWriter::AddAPInt(const llvm::APInt &Value, RecordDataImpl &Record) {
3535   Record.push_back(Value.getBitWidth());
3536   const uint64_t *Words = Value.getRawData();
3537   Record.append(Words, Words + Value.getNumWords());
3538 }
3539 
3540 void ASTWriter::AddAPSInt(const llvm::APSInt &Value, RecordDataImpl &Record) {
3541   Record.push_back(Value.isUnsigned());
3542   AddAPInt(Value, Record);
3543 }
3544 
3545 void ASTWriter::AddAPFloat(const llvm::APFloat &Value, RecordDataImpl &Record) {
3546   AddAPInt(Value.bitcastToAPInt(), Record);
3547 }
3548 
3549 void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
3550   Record.push_back(getIdentifierRef(II));
3551 }
3552 
3553 IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
3554   if (II == 0)
3555     return 0;
3556 
3557   IdentID &ID = IdentifierIDs[II];
3558   if (ID == 0)
3559     ID = NextIdentID++;
3560   return ID;
3561 }
3562 
3563 void ASTWriter::AddSelectorRef(const Selector SelRef, RecordDataImpl &Record) {
3564   Record.push_back(getSelectorRef(SelRef));
3565 }
3566 
3567 SelectorID ASTWriter::getSelectorRef(Selector Sel) {
3568   if (Sel.getAsOpaquePtr() == 0) {
3569     return 0;
3570   }
3571 
3572   SelectorID &SID = SelectorIDs[Sel];
3573   if (SID == 0 && Chain) {
3574     // This might trigger a ReadSelector callback, which will set the ID for
3575     // this selector.
3576     Chain->LoadSelector(Sel);
3577   }
3578   if (SID == 0) {
3579     SID = NextSelectorID++;
3580   }
3581   return SID;
3582 }
3583 
3584 void ASTWriter::AddCXXTemporary(const CXXTemporary *Temp, RecordDataImpl &Record) {
3585   AddDeclRef(Temp->getDestructor(), Record);
3586 }
3587 
3588 void ASTWriter::AddCXXBaseSpecifiersRef(CXXBaseSpecifier const *Bases,
3589                                       CXXBaseSpecifier const *BasesEnd,
3590                                         RecordDataImpl &Record) {
3591   assert(Bases != BasesEnd && "Empty base-specifier sets are not recorded");
3592   CXXBaseSpecifiersToWrite.push_back(
3593                                 QueuedCXXBaseSpecifiers(NextCXXBaseSpecifiersID,
3594                                                         Bases, BasesEnd));
3595   Record.push_back(NextCXXBaseSpecifiersID++);
3596 }
3597 
3598 void ASTWriter::AddTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind,
3599                                            const TemplateArgumentLocInfo &Arg,
3600                                            RecordDataImpl &Record) {
3601   switch (Kind) {
3602   case TemplateArgument::Expression:
3603     AddStmt(Arg.getAsExpr());
3604     break;
3605   case TemplateArgument::Type:
3606     AddTypeSourceInfo(Arg.getAsTypeSourceInfo(), Record);
3607     break;
3608   case TemplateArgument::Template:
3609     AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc(), Record);
3610     AddSourceLocation(Arg.getTemplateNameLoc(), Record);
3611     break;
3612   case TemplateArgument::TemplateExpansion:
3613     AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc(), Record);
3614     AddSourceLocation(Arg.getTemplateNameLoc(), Record);
3615     AddSourceLocation(Arg.getTemplateEllipsisLoc(), Record);
3616     break;
3617   case TemplateArgument::Null:
3618   case TemplateArgument::Integral:
3619   case TemplateArgument::Declaration:
3620   case TemplateArgument::Pack:
3621     break;
3622   }
3623 }
3624 
3625 void ASTWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg,
3626                                        RecordDataImpl &Record) {
3627   AddTemplateArgument(Arg.getArgument(), Record);
3628 
3629   if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
3630     bool InfoHasSameExpr
3631       = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
3632     Record.push_back(InfoHasSameExpr);
3633     if (InfoHasSameExpr)
3634       return; // Avoid storing the same expr twice.
3635   }
3636   AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo(),
3637                              Record);
3638 }
3639 
3640 void ASTWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo,
3641                                   RecordDataImpl &Record) {
3642   if (TInfo == 0) {
3643     AddTypeRef(QualType(), Record);
3644     return;
3645   }
3646 
3647   AddTypeLoc(TInfo->getTypeLoc(), Record);
3648 }
3649 
3650 void ASTWriter::AddTypeLoc(TypeLoc TL, RecordDataImpl &Record) {
3651   AddTypeRef(TL.getType(), Record);
3652 
3653   TypeLocWriter TLW(*this, Record);
3654   for (; !TL.isNull(); TL = TL.getNextTypeLoc())
3655     TLW.Visit(TL);
3656 }
3657 
3658 void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
3659   Record.push_back(GetOrCreateTypeID(T));
3660 }
3661 
3662 TypeID ASTWriter::GetOrCreateTypeID( QualType T) {
3663   return MakeTypeID(*Context, T,
3664               std::bind1st(std::mem_fun(&ASTWriter::GetOrCreateTypeIdx), this));
3665 }
3666 
3667 TypeID ASTWriter::getTypeID(QualType T) const {
3668   return MakeTypeID(*Context, T,
3669               std::bind1st(std::mem_fun(&ASTWriter::getTypeIdx), this));
3670 }
3671 
3672 TypeIdx ASTWriter::GetOrCreateTypeIdx(QualType T) {
3673   if (T.isNull())
3674     return TypeIdx();
3675   assert(!T.getLocalFastQualifiers());
3676 
3677   TypeIdx &Idx = TypeIdxs[T];
3678   if (Idx.getIndex() == 0) {
3679     // We haven't seen this type before. Assign it a new ID and put it
3680     // into the queue of types to emit.
3681     Idx = TypeIdx(NextTypeID++);
3682     DeclTypesToEmit.push(T);
3683   }
3684   return Idx;
3685 }
3686 
3687 TypeIdx ASTWriter::getTypeIdx(QualType T) const {
3688   if (T.isNull())
3689     return TypeIdx();
3690   assert(!T.getLocalFastQualifiers());
3691 
3692   TypeIdxMap::const_iterator I = TypeIdxs.find(T);
3693   assert(I != TypeIdxs.end() && "Type not emitted!");
3694   return I->second;
3695 }
3696 
3697 void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
3698   Record.push_back(GetDeclRef(D));
3699 }
3700 
3701 DeclID ASTWriter::GetDeclRef(const Decl *D) {
3702   assert(WritingAST && "Cannot request a declaration ID before AST writing");
3703 
3704   if (D == 0) {
3705     return 0;
3706   }
3707   assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
3708   DeclID &ID = DeclIDs[D];
3709   if (ID == 0) {
3710     // We haven't seen this declaration before. Give it a new ID and
3711     // enqueue it in the list of declarations to emit.
3712     ID = NextDeclID++;
3713     DeclTypesToEmit.push(const_cast<Decl *>(D));
3714   }
3715 
3716   return ID;
3717 }
3718 
3719 DeclID ASTWriter::getDeclID(const Decl *D) {
3720   if (D == 0)
3721     return 0;
3722 
3723   assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
3724   return DeclIDs[D];
3725 }
3726 
3727 static inline bool compLocDecl(std::pair<unsigned, serialization::DeclID> L,
3728                                std::pair<unsigned, serialization::DeclID> R) {
3729   return L.first < R.first;
3730 }
3731 
3732 void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) {
3733   assert(ID);
3734   assert(D);
3735 
3736   SourceLocation Loc = D->getLocation();
3737   if (Loc.isInvalid())
3738     return;
3739 
3740   // We only keep track of the file-level declarations of each file.
3741   if (!D->getLexicalDeclContext()->isFileContext())
3742     return;
3743 
3744   SourceManager &SM = Context->getSourceManager();
3745   SourceLocation FileLoc = SM.getFileLoc(Loc);
3746   assert(SM.isLocalSourceLocation(FileLoc));
3747   FileID FID;
3748   unsigned Offset;
3749   llvm::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
3750   if (FID.isInvalid())
3751     return;
3752   const SrcMgr::SLocEntry *Entry = &SM.getSLocEntry(FID);
3753   assert(Entry->isFile());
3754 
3755   DeclIDInFileInfo *&Info = FileDeclIDs[Entry];
3756   if (!Info)
3757     Info = new DeclIDInFileInfo();
3758 
3759   std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID);
3760   LocDeclIDsTy &Decls = Info->DeclIDs;
3761 
3762   if (Decls.empty() || Decls.back().first <= Offset) {
3763     Decls.push_back(LocDecl);
3764     return;
3765   }
3766 
3767   LocDeclIDsTy::iterator
3768     I = std::upper_bound(Decls.begin(), Decls.end(), LocDecl, compLocDecl);
3769 
3770   Decls.insert(I, LocDecl);
3771 }
3772 
3773 void ASTWriter::AddDeclarationName(DeclarationName Name, RecordDataImpl &Record) {
3774   // FIXME: Emit a stable enum for NameKind.  0 = Identifier etc.
3775   Record.push_back(Name.getNameKind());
3776   switch (Name.getNameKind()) {
3777   case DeclarationName::Identifier:
3778     AddIdentifierRef(Name.getAsIdentifierInfo(), Record);
3779     break;
3780 
3781   case DeclarationName::ObjCZeroArgSelector:
3782   case DeclarationName::ObjCOneArgSelector:
3783   case DeclarationName::ObjCMultiArgSelector:
3784     AddSelectorRef(Name.getObjCSelector(), Record);
3785     break;
3786 
3787   case DeclarationName::CXXConstructorName:
3788   case DeclarationName::CXXDestructorName:
3789   case DeclarationName::CXXConversionFunctionName:
3790     AddTypeRef(Name.getCXXNameType(), Record);
3791     break;
3792 
3793   case DeclarationName::CXXOperatorName:
3794     Record.push_back(Name.getCXXOverloadedOperator());
3795     break;
3796 
3797   case DeclarationName::CXXLiteralOperatorName:
3798     AddIdentifierRef(Name.getCXXLiteralIdentifier(), Record);
3799     break;
3800 
3801   case DeclarationName::CXXUsingDirective:
3802     // No extra data to emit
3803     break;
3804   }
3805 }
3806 
3807 void ASTWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
3808                                      DeclarationName Name, RecordDataImpl &Record) {
3809   switch (Name.getNameKind()) {
3810   case DeclarationName::CXXConstructorName:
3811   case DeclarationName::CXXDestructorName:
3812   case DeclarationName::CXXConversionFunctionName:
3813     AddTypeSourceInfo(DNLoc.NamedType.TInfo, Record);
3814     break;
3815 
3816   case DeclarationName::CXXOperatorName:
3817     AddSourceLocation(
3818        SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.BeginOpNameLoc),
3819        Record);
3820     AddSourceLocation(
3821         SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc),
3822         Record);
3823     break;
3824 
3825   case DeclarationName::CXXLiteralOperatorName:
3826     AddSourceLocation(
3827      SourceLocation::getFromRawEncoding(DNLoc.CXXLiteralOperatorName.OpNameLoc),
3828      Record);
3829     break;
3830 
3831   case DeclarationName::Identifier:
3832   case DeclarationName::ObjCZeroArgSelector:
3833   case DeclarationName::ObjCOneArgSelector:
3834   case DeclarationName::ObjCMultiArgSelector:
3835   case DeclarationName::CXXUsingDirective:
3836     break;
3837   }
3838 }
3839 
3840 void ASTWriter::AddDeclarationNameInfo(const DeclarationNameInfo &NameInfo,
3841                                        RecordDataImpl &Record) {
3842   AddDeclarationName(NameInfo.getName(), Record);
3843   AddSourceLocation(NameInfo.getLoc(), Record);
3844   AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName(), Record);
3845 }
3846 
3847 void ASTWriter::AddQualifierInfo(const QualifierInfo &Info,
3848                                  RecordDataImpl &Record) {
3849   AddNestedNameSpecifierLoc(Info.QualifierLoc, Record);
3850   Record.push_back(Info.NumTemplParamLists);
3851   for (unsigned i=0, e=Info.NumTemplParamLists; i != e; ++i)
3852     AddTemplateParameterList(Info.TemplParamLists[i], Record);
3853 }
3854 
3855 void ASTWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS,
3856                                        RecordDataImpl &Record) {
3857   // Nested name specifiers usually aren't too long. I think that 8 would
3858   // typically accommodate the vast majority.
3859   SmallVector<NestedNameSpecifier *, 8> NestedNames;
3860 
3861   // Push each of the NNS's onto a stack for serialization in reverse order.
3862   while (NNS) {
3863     NestedNames.push_back(NNS);
3864     NNS = NNS->getPrefix();
3865   }
3866 
3867   Record.push_back(NestedNames.size());
3868   while(!NestedNames.empty()) {
3869     NNS = NestedNames.pop_back_val();
3870     NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
3871     Record.push_back(Kind);
3872     switch (Kind) {
3873     case NestedNameSpecifier::Identifier:
3874       AddIdentifierRef(NNS->getAsIdentifier(), Record);
3875       break;
3876 
3877     case NestedNameSpecifier::Namespace:
3878       AddDeclRef(NNS->getAsNamespace(), Record);
3879       break;
3880 
3881     case NestedNameSpecifier::NamespaceAlias:
3882       AddDeclRef(NNS->getAsNamespaceAlias(), Record);
3883       break;
3884 
3885     case NestedNameSpecifier::TypeSpec:
3886     case NestedNameSpecifier::TypeSpecWithTemplate:
3887       AddTypeRef(QualType(NNS->getAsType(), 0), Record);
3888       Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
3889       break;
3890 
3891     case NestedNameSpecifier::Global:
3892       // Don't need to write an associated value.
3893       break;
3894     }
3895   }
3896 }
3897 
3898 void ASTWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS,
3899                                           RecordDataImpl &Record) {
3900   // Nested name specifiers usually aren't too long. I think that 8 would
3901   // typically accommodate the vast majority.
3902   SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
3903 
3904   // Push each of the nested-name-specifiers's onto a stack for
3905   // serialization in reverse order.
3906   while (NNS) {
3907     NestedNames.push_back(NNS);
3908     NNS = NNS.getPrefix();
3909   }
3910 
3911   Record.push_back(NestedNames.size());
3912   while(!NestedNames.empty()) {
3913     NNS = NestedNames.pop_back_val();
3914     NestedNameSpecifier::SpecifierKind Kind
3915       = NNS.getNestedNameSpecifier()->getKind();
3916     Record.push_back(Kind);
3917     switch (Kind) {
3918     case NestedNameSpecifier::Identifier:
3919       AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier(), Record);
3920       AddSourceRange(NNS.getLocalSourceRange(), Record);
3921       break;
3922 
3923     case NestedNameSpecifier::Namespace:
3924       AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace(), Record);
3925       AddSourceRange(NNS.getLocalSourceRange(), Record);
3926       break;
3927 
3928     case NestedNameSpecifier::NamespaceAlias:
3929       AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias(), Record);
3930       AddSourceRange(NNS.getLocalSourceRange(), Record);
3931       break;
3932 
3933     case NestedNameSpecifier::TypeSpec:
3934     case NestedNameSpecifier::TypeSpecWithTemplate:
3935       Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
3936       AddTypeLoc(NNS.getTypeLoc(), Record);
3937       AddSourceLocation(NNS.getLocalSourceRange().getEnd(), Record);
3938       break;
3939 
3940     case NestedNameSpecifier::Global:
3941       AddSourceLocation(NNS.getLocalSourceRange().getEnd(), Record);
3942       break;
3943     }
3944   }
3945 }
3946 
3947 void ASTWriter::AddTemplateName(TemplateName Name, RecordDataImpl &Record) {
3948   TemplateName::NameKind Kind = Name.getKind();
3949   Record.push_back(Kind);
3950   switch (Kind) {
3951   case TemplateName::Template:
3952     AddDeclRef(Name.getAsTemplateDecl(), Record);
3953     break;
3954 
3955   case TemplateName::OverloadedTemplate: {
3956     OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
3957     Record.push_back(OvT->size());
3958     for (OverloadedTemplateStorage::iterator I = OvT->begin(), E = OvT->end();
3959            I != E; ++I)
3960       AddDeclRef(*I, Record);
3961     break;
3962   }
3963 
3964   case TemplateName::QualifiedTemplate: {
3965     QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
3966     AddNestedNameSpecifier(QualT->getQualifier(), Record);
3967     Record.push_back(QualT->hasTemplateKeyword());
3968     AddDeclRef(QualT->getTemplateDecl(), Record);
3969     break;
3970   }
3971 
3972   case TemplateName::DependentTemplate: {
3973     DependentTemplateName *DepT = Name.getAsDependentTemplateName();
3974     AddNestedNameSpecifier(DepT->getQualifier(), Record);
3975     Record.push_back(DepT->isIdentifier());
3976     if (DepT->isIdentifier())
3977       AddIdentifierRef(DepT->getIdentifier(), Record);
3978     else
3979       Record.push_back(DepT->getOperator());
3980     break;
3981   }
3982 
3983   case TemplateName::SubstTemplateTemplateParm: {
3984     SubstTemplateTemplateParmStorage *subst
3985       = Name.getAsSubstTemplateTemplateParm();
3986     AddDeclRef(subst->getParameter(), Record);
3987     AddTemplateName(subst->getReplacement(), Record);
3988     break;
3989   }
3990 
3991   case TemplateName::SubstTemplateTemplateParmPack: {
3992     SubstTemplateTemplateParmPackStorage *SubstPack
3993       = Name.getAsSubstTemplateTemplateParmPack();
3994     AddDeclRef(SubstPack->getParameterPack(), Record);
3995     AddTemplateArgument(SubstPack->getArgumentPack(), Record);
3996     break;
3997   }
3998   }
3999 }
4000 
4001 void ASTWriter::AddTemplateArgument(const TemplateArgument &Arg,
4002                                     RecordDataImpl &Record) {
4003   Record.push_back(Arg.getKind());
4004   switch (Arg.getKind()) {
4005   case TemplateArgument::Null:
4006     break;
4007   case TemplateArgument::Type:
4008     AddTypeRef(Arg.getAsType(), Record);
4009     break;
4010   case TemplateArgument::Declaration:
4011     AddDeclRef(Arg.getAsDecl(), Record);
4012     break;
4013   case TemplateArgument::Integral:
4014     AddAPSInt(*Arg.getAsIntegral(), Record);
4015     AddTypeRef(Arg.getIntegralType(), Record);
4016     break;
4017   case TemplateArgument::Template:
4018     AddTemplateName(Arg.getAsTemplateOrTemplatePattern(), Record);
4019     break;
4020   case TemplateArgument::TemplateExpansion:
4021     AddTemplateName(Arg.getAsTemplateOrTemplatePattern(), Record);
4022     if (llvm::Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions())
4023       Record.push_back(*NumExpansions + 1);
4024     else
4025       Record.push_back(0);
4026     break;
4027   case TemplateArgument::Expression:
4028     AddStmt(Arg.getAsExpr());
4029     break;
4030   case TemplateArgument::Pack:
4031     Record.push_back(Arg.pack_size());
4032     for (TemplateArgument::pack_iterator I=Arg.pack_begin(), E=Arg.pack_end();
4033            I != E; ++I)
4034       AddTemplateArgument(*I, Record);
4035     break;
4036   }
4037 }
4038 
4039 void
4040 ASTWriter::AddTemplateParameterList(const TemplateParameterList *TemplateParams,
4041                                     RecordDataImpl &Record) {
4042   assert(TemplateParams && "No TemplateParams!");
4043   AddSourceLocation(TemplateParams->getTemplateLoc(), Record);
4044   AddSourceLocation(TemplateParams->getLAngleLoc(), Record);
4045   AddSourceLocation(TemplateParams->getRAngleLoc(), Record);
4046   Record.push_back(TemplateParams->size());
4047   for (TemplateParameterList::const_iterator
4048          P = TemplateParams->begin(), PEnd = TemplateParams->end();
4049          P != PEnd; ++P)
4050     AddDeclRef(*P, Record);
4051 }
4052 
4053 /// \brief Emit a template argument list.
4054 void
4055 ASTWriter::AddTemplateArgumentList(const TemplateArgumentList *TemplateArgs,
4056                                    RecordDataImpl &Record) {
4057   assert(TemplateArgs && "No TemplateArgs!");
4058   Record.push_back(TemplateArgs->size());
4059   for (int i=0, e = TemplateArgs->size(); i != e; ++i)
4060     AddTemplateArgument(TemplateArgs->get(i), Record);
4061 }
4062 
4063 
4064 void
4065 ASTWriter::AddUnresolvedSet(const UnresolvedSetImpl &Set, RecordDataImpl &Record) {
4066   Record.push_back(Set.size());
4067   for (UnresolvedSetImpl::const_iterator
4068          I = Set.begin(), E = Set.end(); I != E; ++I) {
4069     AddDeclRef(I.getDecl(), Record);
4070     Record.push_back(I.getAccess());
4071   }
4072 }
4073 
4074 void ASTWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base,
4075                                     RecordDataImpl &Record) {
4076   Record.push_back(Base.isVirtual());
4077   Record.push_back(Base.isBaseOfClass());
4078   Record.push_back(Base.getAccessSpecifierAsWritten());
4079   Record.push_back(Base.getInheritConstructors());
4080   AddTypeSourceInfo(Base.getTypeSourceInfo(), Record);
4081   AddSourceRange(Base.getSourceRange(), Record);
4082   AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
4083                                           : SourceLocation(),
4084                     Record);
4085 }
4086 
4087 void ASTWriter::FlushCXXBaseSpecifiers() {
4088   RecordData Record;
4089   for (unsigned I = 0, N = CXXBaseSpecifiersToWrite.size(); I != N; ++I) {
4090     Record.clear();
4091 
4092     // Record the offset of this base-specifier set.
4093     unsigned Index = CXXBaseSpecifiersToWrite[I].ID - 1;
4094     if (Index == CXXBaseSpecifiersOffsets.size())
4095       CXXBaseSpecifiersOffsets.push_back(Stream.GetCurrentBitNo());
4096     else {
4097       if (Index > CXXBaseSpecifiersOffsets.size())
4098         CXXBaseSpecifiersOffsets.resize(Index + 1);
4099       CXXBaseSpecifiersOffsets[Index] = Stream.GetCurrentBitNo();
4100     }
4101 
4102     const CXXBaseSpecifier *B = CXXBaseSpecifiersToWrite[I].Bases,
4103                         *BEnd = CXXBaseSpecifiersToWrite[I].BasesEnd;
4104     Record.push_back(BEnd - B);
4105     for (; B != BEnd; ++B)
4106       AddCXXBaseSpecifier(*B, Record);
4107     Stream.EmitRecord(serialization::DECL_CXX_BASE_SPECIFIERS, Record);
4108 
4109     // Flush any expressions that were written as part of the base specifiers.
4110     FlushStmts();
4111   }
4112 
4113   CXXBaseSpecifiersToWrite.clear();
4114 }
4115 
4116 void ASTWriter::AddCXXCtorInitializers(
4117                              const CXXCtorInitializer * const *CtorInitializers,
4118                              unsigned NumCtorInitializers,
4119                              RecordDataImpl &Record) {
4120   Record.push_back(NumCtorInitializers);
4121   for (unsigned i=0; i != NumCtorInitializers; ++i) {
4122     const CXXCtorInitializer *Init = CtorInitializers[i];
4123 
4124     if (Init->isBaseInitializer()) {
4125       Record.push_back(CTOR_INITIALIZER_BASE);
4126       AddTypeSourceInfo(Init->getTypeSourceInfo(), Record);
4127       Record.push_back(Init->isBaseVirtual());
4128     } else if (Init->isDelegatingInitializer()) {
4129       Record.push_back(CTOR_INITIALIZER_DELEGATING);
4130       AddTypeSourceInfo(Init->getTypeSourceInfo(), Record);
4131     } else if (Init->isMemberInitializer()){
4132       Record.push_back(CTOR_INITIALIZER_MEMBER);
4133       AddDeclRef(Init->getMember(), Record);
4134     } else {
4135       Record.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER);
4136       AddDeclRef(Init->getIndirectMember(), Record);
4137     }
4138 
4139     AddSourceLocation(Init->getMemberLocation(), Record);
4140     AddStmt(Init->getInit());
4141     AddSourceLocation(Init->getLParenLoc(), Record);
4142     AddSourceLocation(Init->getRParenLoc(), Record);
4143     Record.push_back(Init->isWritten());
4144     if (Init->isWritten()) {
4145       Record.push_back(Init->getSourceOrder());
4146     } else {
4147       Record.push_back(Init->getNumArrayIndices());
4148       for (unsigned i=0, e=Init->getNumArrayIndices(); i != e; ++i)
4149         AddDeclRef(Init->getArrayIndex(i), Record);
4150     }
4151   }
4152 }
4153 
4154 void ASTWriter::AddCXXDefinitionData(const CXXRecordDecl *D, RecordDataImpl &Record) {
4155   assert(D->DefinitionData);
4156   struct CXXRecordDecl::DefinitionData &Data = *D->DefinitionData;
4157   Record.push_back(Data.UserDeclaredConstructor);
4158   Record.push_back(Data.UserDeclaredCopyConstructor);
4159   Record.push_back(Data.UserDeclaredMoveConstructor);
4160   Record.push_back(Data.UserDeclaredCopyAssignment);
4161   Record.push_back(Data.UserDeclaredMoveAssignment);
4162   Record.push_back(Data.UserDeclaredDestructor);
4163   Record.push_back(Data.Aggregate);
4164   Record.push_back(Data.PlainOldData);
4165   Record.push_back(Data.Empty);
4166   Record.push_back(Data.Polymorphic);
4167   Record.push_back(Data.Abstract);
4168   Record.push_back(Data.IsStandardLayout);
4169   Record.push_back(Data.HasNoNonEmptyBases);
4170   Record.push_back(Data.HasPrivateFields);
4171   Record.push_back(Data.HasProtectedFields);
4172   Record.push_back(Data.HasPublicFields);
4173   Record.push_back(Data.HasMutableFields);
4174   Record.push_back(Data.HasTrivialDefaultConstructor);
4175   Record.push_back(Data.HasConstexprNonCopyMoveConstructor);
4176   Record.push_back(Data.HasTrivialCopyConstructor);
4177   Record.push_back(Data.HasTrivialMoveConstructor);
4178   Record.push_back(Data.HasTrivialCopyAssignment);
4179   Record.push_back(Data.HasTrivialMoveAssignment);
4180   Record.push_back(Data.HasTrivialDestructor);
4181   Record.push_back(Data.HasNonLiteralTypeFieldsOrBases);
4182   Record.push_back(Data.ComputedVisibleConversions);
4183   Record.push_back(Data.UserProvidedDefaultConstructor);
4184   Record.push_back(Data.DeclaredDefaultConstructor);
4185   Record.push_back(Data.DeclaredCopyConstructor);
4186   Record.push_back(Data.DeclaredMoveConstructor);
4187   Record.push_back(Data.DeclaredCopyAssignment);
4188   Record.push_back(Data.DeclaredMoveAssignment);
4189   Record.push_back(Data.DeclaredDestructor);
4190   Record.push_back(Data.FailedImplicitMoveConstructor);
4191   Record.push_back(Data.FailedImplicitMoveAssignment);
4192 
4193   Record.push_back(Data.NumBases);
4194   if (Data.NumBases > 0)
4195     AddCXXBaseSpecifiersRef(Data.getBases(), Data.getBases() + Data.NumBases,
4196                             Record);
4197 
4198   // FIXME: Make VBases lazily computed when needed to avoid storing them.
4199   Record.push_back(Data.NumVBases);
4200   if (Data.NumVBases > 0)
4201     AddCXXBaseSpecifiersRef(Data.getVBases(), Data.getVBases() + Data.NumVBases,
4202                             Record);
4203 
4204   AddUnresolvedSet(Data.Conversions, Record);
4205   AddUnresolvedSet(Data.VisibleConversions, Record);
4206   // Data.Definition is the owning decl, no need to write it.
4207   AddDeclRef(Data.FirstFriend, Record);
4208 }
4209 
4210 void ASTWriter::ReaderInitialized(ASTReader *Reader) {
4211   assert(Reader && "Cannot remove chain");
4212   assert((!Chain || Chain == Reader) && "Cannot replace chain");
4213   assert(FirstDeclID == NextDeclID &&
4214          FirstTypeID == NextTypeID &&
4215          FirstIdentID == NextIdentID &&
4216          FirstSubmoduleID == NextSubmoduleID &&
4217          FirstSelectorID == NextSelectorID &&
4218          "Setting chain after writing has started.");
4219 
4220   Chain = Reader;
4221 
4222   FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls();
4223   FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes();
4224   FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers();
4225   FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
4226   FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
4227   NextDeclID = FirstDeclID;
4228   NextTypeID = FirstTypeID;
4229   NextIdentID = FirstIdentID;
4230   NextSelectorID = FirstSelectorID;
4231   NextSubmoduleID = FirstSubmoduleID;
4232 }
4233 
4234 void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
4235   IdentifierIDs[II] = ID;
4236   if (II->hasMacroDefinition())
4237     DeserializedMacroNames.push_back(II);
4238 }
4239 
4240 void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
4241   // Always take the highest-numbered type index. This copes with an interesting
4242   // case for chained AST writing where we schedule writing the type and then,
4243   // later, deserialize the type from another AST. In this case, we want to
4244   // keep the higher-numbered entry so that we can properly write it out to
4245   // the AST file.
4246   TypeIdx &StoredIdx = TypeIdxs[T];
4247   if (Idx.getIndex() >= StoredIdx.getIndex())
4248     StoredIdx = Idx;
4249 }
4250 
4251 void ASTWriter::DeclRead(DeclID ID, const Decl *D) {
4252   DeclIDs[D] = ID;
4253 }
4254 
4255 void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
4256   SelectorIDs[S] = ID;
4257 }
4258 
4259 void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
4260                                     MacroDefinition *MD) {
4261   assert(MacroDefinitions.find(MD) == MacroDefinitions.end());
4262   MacroDefinitions[MD] = ID;
4263 }
4264 
4265 void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
4266   assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end());
4267   SubmoduleIDs[Mod] = ID;
4268 }
4269 
4270 void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
4271   assert(D->isCompleteDefinition());
4272   assert(!WritingAST && "Already writing the AST!");
4273   if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
4274     // We are interested when a PCH decl is modified.
4275     if (RD->isFromASTFile()) {
4276       // A forward reference was mutated into a definition. Rewrite it.
4277       // FIXME: This happens during template instantiation, should we
4278       // have created a new definition decl instead ?
4279       RewriteDecl(RD);
4280     }
4281 
4282     for (CXXRecordDecl::redecl_iterator
4283            I = RD->redecls_begin(), E = RD->redecls_end(); I != E; ++I) {
4284       CXXRecordDecl *Redecl = cast<CXXRecordDecl>(*I);
4285       if (Redecl == RD)
4286         continue;
4287 
4288       // We are interested when a PCH decl is modified.
4289       if (Redecl->isFromASTFile()) {
4290         UpdateRecord &Record = DeclUpdates[Redecl];
4291         Record.push_back(UPD_CXX_SET_DEFINITIONDATA);
4292         assert(Redecl->DefinitionData);
4293         assert(Redecl->DefinitionData->Definition == D);
4294         Record.push_back(reinterpret_cast<uint64_t>(D)); // the DefinitionDecl
4295       }
4296     }
4297   }
4298 }
4299 void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
4300   assert(!WritingAST && "Already writing the AST!");
4301 
4302   // TU and namespaces are handled elsewhere.
4303   if (isa<TranslationUnitDecl>(DC) || isa<NamespaceDecl>(DC))
4304     return;
4305 
4306   if (!(!D->isFromASTFile() && cast<Decl>(DC)->isFromASTFile()))
4307     return; // Not a source decl added to a DeclContext from PCH.
4308 
4309   AddUpdatedDeclContext(DC);
4310 }
4311 
4312 void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
4313   assert(!WritingAST && "Already writing the AST!");
4314   assert(D->isImplicit());
4315   if (!(!D->isFromASTFile() && RD->isFromASTFile()))
4316     return; // Not a source member added to a class from PCH.
4317   if (!isa<CXXMethodDecl>(D))
4318     return; // We are interested in lazily declared implicit methods.
4319 
4320   // A decl coming from PCH was modified.
4321   assert(RD->isCompleteDefinition());
4322   UpdateRecord &Record = DeclUpdates[RD];
4323   Record.push_back(UPD_CXX_ADDED_IMPLICIT_MEMBER);
4324   Record.push_back(reinterpret_cast<uint64_t>(D));
4325 }
4326 
4327 void ASTWriter::AddedCXXTemplateSpecialization(const ClassTemplateDecl *TD,
4328                                      const ClassTemplateSpecializationDecl *D) {
4329   // The specializations set is kept in the canonical template.
4330   assert(!WritingAST && "Already writing the AST!");
4331   TD = TD->getCanonicalDecl();
4332   if (!(!D->isFromASTFile() && TD->isFromASTFile()))
4333     return; // Not a source specialization added to a template from PCH.
4334 
4335   UpdateRecord &Record = DeclUpdates[TD];
4336   Record.push_back(UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION);
4337   Record.push_back(reinterpret_cast<uint64_t>(D));
4338 }
4339 
4340 void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
4341                                                const FunctionDecl *D) {
4342   // The specializations set is kept in the canonical template.
4343   assert(!WritingAST && "Already writing the AST!");
4344   TD = TD->getCanonicalDecl();
4345   if (!(!D->isFromASTFile() && TD->isFromASTFile()))
4346     return; // Not a source specialization added to a template from PCH.
4347 
4348   UpdateRecord &Record = DeclUpdates[TD];
4349   Record.push_back(UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION);
4350   Record.push_back(reinterpret_cast<uint64_t>(D));
4351 }
4352 
4353 void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
4354   assert(!WritingAST && "Already writing the AST!");
4355   if (!D->isFromASTFile())
4356     return; // Declaration not imported from PCH.
4357 
4358   // Implicit decl from a PCH was defined.
4359   // FIXME: Should implicit definition be a separate FunctionDecl?
4360   RewriteDecl(D);
4361 }
4362 
4363 void ASTWriter::StaticDataMemberInstantiated(const VarDecl *D) {
4364   assert(!WritingAST && "Already writing the AST!");
4365   if (!D->isFromASTFile())
4366     return;
4367 
4368   // Since the actual instantiation is delayed, this really means that we need
4369   // to update the instantiation location.
4370   UpdateRecord &Record = DeclUpdates[D];
4371   Record.push_back(UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER);
4372   AddSourceLocation(
4373       D->getMemberSpecializationInfo()->getPointOfInstantiation(), Record);
4374 }
4375 
4376 void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
4377                                              const ObjCInterfaceDecl *IFD) {
4378   assert(!WritingAST && "Already writing the AST!");
4379   if (!IFD->isFromASTFile())
4380     return; // Declaration not imported from PCH.
4381   if (CatD->getNextClassCategory() &&
4382       !CatD->getNextClassCategory()->isFromASTFile())
4383     return; // We already recorded that the tail of a category chain should be
4384             // attached to an interface.
4385 
4386   ChainedObjCCategoriesData Data =  { IFD, CatD };
4387   LocalChainedObjCCategories.push_back(Data);
4388 }
4389 
4390 void ASTWriter::CompletedObjCForwardRef(const ObjCContainerDecl *D) {
4391   assert(!WritingAST && "Already writing the AST!");
4392   if (D->isFromASTFile())
4393     RewriteDecl(D);
4394 
4395   if (const ObjCInterfaceDecl *ID = dyn_cast<ObjCInterfaceDecl>(D)) {
4396     for (ObjCInterfaceDecl::redecl_iterator I = ID->redecls_begin(),
4397                                             E = ID->redecls_end();
4398          I != E; ++I) {
4399       if (*I == ID)
4400         continue;
4401 
4402       // We are interested when a PCH decl is modified.
4403       if (I->isFromASTFile()) {
4404         UpdateRecord &Record = DeclUpdates[*I];
4405         Record.push_back(UPD_OBJC_SET_CLASS_DEFINITIONDATA);
4406         assert((*I)->hasDefinition());
4407         assert((*I)->getDefinition() == D);
4408         Record.push_back(reinterpret_cast<uint64_t>(D)); // the DefinitionDecl
4409       }
4410     }
4411   }
4412 }
4413 
4414 void ASTWriter::AddedObjCPropertyInClassExtension(const ObjCPropertyDecl *Prop,
4415                                           const ObjCPropertyDecl *OrigProp,
4416                                           const ObjCCategoryDecl *ClassExt) {
4417   const ObjCInterfaceDecl *D = ClassExt->getClassInterface();
4418   if (!D)
4419     return;
4420 
4421   assert(!WritingAST && "Already writing the AST!");
4422   if (!D->isFromASTFile())
4423     return; // Declaration not imported from PCH.
4424 
4425   RewriteDecl(D);
4426 }
4427 
4428 void ASTWriter::UpdatedAttributeList(const Decl *D) {
4429   assert(!WritingAST && "Already writing the AST!");
4430   if (!D->isFromASTFile())
4431     return; // Declaration not imported from PCH.
4432 
4433   RewriteDecl(D);
4434 }
4435