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