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