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