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