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