ASTWriter.cpp revision aacdd02e5865aa410c1418d7ef77f445b5bb5cba
15f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)//===--- ASTWriter.cpp - AST File Writer ----------------------------------===//
25f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)//
35f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)//                     The LLVM Compiler Infrastructure
45f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)//
55f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)// This file is distributed under the University of Illinois Open Source
65f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)// License. See LICENSE.TXT for details.
75f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)//
85f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)//===----------------------------------------------------------------------===//
95f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)//
105f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)//  This file defines the ASTWriter class, which writes AST files.
115f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)//
125f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)//===----------------------------------------------------------------------===//
135f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)
145f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "clang/Serialization/ASTWriter.h"
155f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "ASTCommon.h"
165f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "clang/Sema/Sema.h"
175f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "clang/Sema/IdentifierResolver.h"
185f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "clang/AST/ASTContext.h"
195f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "clang/AST/Decl.h"
205f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "clang/AST/DeclContextInternals.h"
215f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "clang/AST/DeclTemplate.h"
225f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "clang/AST/DeclFriend.h"
235f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "clang/AST/Expr.h"
241320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/AST/ExprCXX.h"
251320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/AST/Type.h"
261320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/AST/TypeLocVisitor.h"
271320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Serialization/ASTReader.h"
281320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Lex/MacroInfo.h"
295f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "clang/Lex/PreprocessingRecord.h"
301320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Lex/Preprocessor.h"
311320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Lex/HeaderSearch.h"
321320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/FileManager.h"
331320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/OnDiskHashTable.h"
341320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/SourceManager.h"
351320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/SourceManagerInternals.h"
361320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/TargetInfo.h"
371320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "clang/Basic/Version.h"
385f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "llvm/ADT/APFloat.h"
391320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "llvm/ADT/APInt.h"
401320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "llvm/ADT/StringExtras.h"
411320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "llvm/Bitcode/BitstreamWriter.h"
425f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "llvm/Support/MemoryBuffer.h"
435f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "llvm/System/Path.h"
441320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include <cstdio>
455f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)using namespace clang;
465f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)using namespace clang::serialization;
475f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)
485f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)template <typename T, typename Allocator>
495f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)T *data(std::vector<T, Allocator> &v) {
505f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  return v.empty() ? 0 : &v.front();
515f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)}
525f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)template <typename T, typename Allocator>
535f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)const T *data(const std::vector<T, Allocator> &v) {
545f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)  return v.empty() ? 0 : &v.front();
555f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)}
565f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)
575f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)//===----------------------------------------------------------------------===//
585f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)// Type serialization
595f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)//===----------------------------------------------------------------------===//
605f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)
61namespace {
62  class ASTTypeWriter {
63    ASTWriter &Writer;
64    ASTWriter::RecordDataImpl &Record;
65
66  public:
67    /// \brief Type code that corresponds to the record generated.
68    TypeCode Code;
69
70    ASTTypeWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record)
71      : Writer(Writer), Record(Record), Code(TYPE_EXT_QUAL) { }
72
73    void VisitArrayType(const ArrayType *T);
74    void VisitFunctionType(const FunctionType *T);
75    void VisitTagType(const TagType *T);
76
77#define TYPE(Class, Base) void Visit##Class##Type(const Class##Type *T);
78#define ABSTRACT_TYPE(Class, Base)
79#include "clang/AST/TypeNodes.def"
80  };
81}
82
83void ASTTypeWriter::VisitBuiltinType(const BuiltinType *T) {
84  assert(false && "Built-in types are never serialized");
85}
86
87void ASTTypeWriter::VisitComplexType(const ComplexType *T) {
88  Writer.AddTypeRef(T->getElementType(), Record);
89  Code = TYPE_COMPLEX;
90}
91
92void ASTTypeWriter::VisitPointerType(const PointerType *T) {
93  Writer.AddTypeRef(T->getPointeeType(), Record);
94  Code = TYPE_POINTER;
95}
96
97void ASTTypeWriter::VisitBlockPointerType(const BlockPointerType *T) {
98  Writer.AddTypeRef(T->getPointeeType(), Record);
99  Code = TYPE_BLOCK_POINTER;
100}
101
102void ASTTypeWriter::VisitLValueReferenceType(const LValueReferenceType *T) {
103  Writer.AddTypeRef(T->getPointeeType(), Record);
104  Code = TYPE_LVALUE_REFERENCE;
105}
106
107void ASTTypeWriter::VisitRValueReferenceType(const RValueReferenceType *T) {
108  Writer.AddTypeRef(T->getPointeeType(), Record);
109  Code = TYPE_RVALUE_REFERENCE;
110}
111
112void ASTTypeWriter::VisitMemberPointerType(const MemberPointerType *T) {
113  Writer.AddTypeRef(T->getPointeeType(), Record);
114  Writer.AddTypeRef(QualType(T->getClass(), 0), Record);
115  Code = TYPE_MEMBER_POINTER;
116}
117
118void ASTTypeWriter::VisitArrayType(const ArrayType *T) {
119  Writer.AddTypeRef(T->getElementType(), Record);
120  Record.push_back(T->getSizeModifier()); // FIXME: stable values
121  Record.push_back(T->getIndexTypeCVRQualifiers()); // FIXME: stable values
122}
123
124void ASTTypeWriter::VisitConstantArrayType(const ConstantArrayType *T) {
125  VisitArrayType(T);
126  Writer.AddAPInt(T->getSize(), Record);
127  Code = TYPE_CONSTANT_ARRAY;
128}
129
130void ASTTypeWriter::VisitIncompleteArrayType(const IncompleteArrayType *T) {
131  VisitArrayType(T);
132  Code = TYPE_INCOMPLETE_ARRAY;
133}
134
135void ASTTypeWriter::VisitVariableArrayType(const VariableArrayType *T) {
136  VisitArrayType(T);
137  Writer.AddSourceLocation(T->getLBracketLoc(), Record);
138  Writer.AddSourceLocation(T->getRBracketLoc(), Record);
139  Writer.AddStmt(T->getSizeExpr());
140  Code = TYPE_VARIABLE_ARRAY;
141}
142
143void ASTTypeWriter::VisitVectorType(const VectorType *T) {
144  Writer.AddTypeRef(T->getElementType(), Record);
145  Record.push_back(T->getNumElements());
146  Record.push_back(T->getAltiVecSpecific());
147  Code = TYPE_VECTOR;
148}
149
150void ASTTypeWriter::VisitExtVectorType(const ExtVectorType *T) {
151  VisitVectorType(T);
152  Code = TYPE_EXT_VECTOR;
153}
154
155void ASTTypeWriter::VisitFunctionType(const FunctionType *T) {
156  Writer.AddTypeRef(T->getResultType(), Record);
157  FunctionType::ExtInfo C = T->getExtInfo();
158  Record.push_back(C.getNoReturn());
159  Record.push_back(C.getRegParm());
160  // FIXME: need to stabilize encoding of calling convention...
161  Record.push_back(C.getCC());
162}
163
164void ASTTypeWriter::VisitFunctionNoProtoType(const FunctionNoProtoType *T) {
165  VisitFunctionType(T);
166  Code = TYPE_FUNCTION_NO_PROTO;
167}
168
169void ASTTypeWriter::VisitFunctionProtoType(const FunctionProtoType *T) {
170  VisitFunctionType(T);
171  Record.push_back(T->getNumArgs());
172  for (unsigned I = 0, N = T->getNumArgs(); I != N; ++I)
173    Writer.AddTypeRef(T->getArgType(I), Record);
174  Record.push_back(T->isVariadic());
175  Record.push_back(T->getTypeQuals());
176  Record.push_back(T->hasExceptionSpec());
177  Record.push_back(T->hasAnyExceptionSpec());
178  Record.push_back(T->getNumExceptions());
179  for (unsigned I = 0, N = T->getNumExceptions(); I != N; ++I)
180    Writer.AddTypeRef(T->getExceptionType(I), Record);
181  Code = TYPE_FUNCTION_PROTO;
182}
183
184void ASTTypeWriter::VisitUnresolvedUsingType(const UnresolvedUsingType *T) {
185  Writer.AddDeclRef(T->getDecl(), Record);
186  Code = TYPE_UNRESOLVED_USING;
187}
188
189void ASTTypeWriter::VisitTypedefType(const TypedefType *T) {
190  Writer.AddDeclRef(T->getDecl(), Record);
191  assert(!T->isCanonicalUnqualified() && "Invalid typedef ?");
192  Writer.AddTypeRef(T->getCanonicalTypeInternal(), Record);
193  Code = TYPE_TYPEDEF;
194}
195
196void ASTTypeWriter::VisitTypeOfExprType(const TypeOfExprType *T) {
197  Writer.AddStmt(T->getUnderlyingExpr());
198  Code = TYPE_TYPEOF_EXPR;
199}
200
201void ASTTypeWriter::VisitTypeOfType(const TypeOfType *T) {
202  Writer.AddTypeRef(T->getUnderlyingType(), Record);
203  Code = TYPE_TYPEOF;
204}
205
206void ASTTypeWriter::VisitDecltypeType(const DecltypeType *T) {
207  Writer.AddStmt(T->getUnderlyingExpr());
208  Code = TYPE_DECLTYPE;
209}
210
211void ASTTypeWriter::VisitTagType(const TagType *T) {
212  Record.push_back(T->isDependentType());
213  Writer.AddDeclRef(T->getDecl(), Record);
214  assert(!T->isBeingDefined() &&
215         "Cannot serialize in the middle of a type definition");
216}
217
218void ASTTypeWriter::VisitRecordType(const RecordType *T) {
219  VisitTagType(T);
220  Code = TYPE_RECORD;
221}
222
223void ASTTypeWriter::VisitEnumType(const EnumType *T) {
224  VisitTagType(T);
225  Code = TYPE_ENUM;
226}
227
228void
229ASTTypeWriter::VisitSubstTemplateTypeParmType(
230                                        const SubstTemplateTypeParmType *T) {
231  Writer.AddTypeRef(QualType(T->getReplacedParameter(), 0), Record);
232  Writer.AddTypeRef(T->getReplacementType(), Record);
233  Code = TYPE_SUBST_TEMPLATE_TYPE_PARM;
234}
235
236void
237ASTTypeWriter::VisitTemplateSpecializationType(
238                                       const TemplateSpecializationType *T) {
239  Record.push_back(T->isDependentType());
240  Writer.AddTemplateName(T->getTemplateName(), Record);
241  Record.push_back(T->getNumArgs());
242  for (TemplateSpecializationType::iterator ArgI = T->begin(), ArgE = T->end();
243         ArgI != ArgE; ++ArgI)
244    Writer.AddTemplateArgument(*ArgI, Record);
245  Writer.AddTypeRef(T->isCanonicalUnqualified() ? QualType()
246                                                : T->getCanonicalTypeInternal(),
247                    Record);
248  Code = TYPE_TEMPLATE_SPECIALIZATION;
249}
250
251void
252ASTTypeWriter::VisitDependentSizedArrayType(const DependentSizedArrayType *T) {
253  VisitArrayType(T);
254  Writer.AddStmt(T->getSizeExpr());
255  Writer.AddSourceRange(T->getBracketsRange(), Record);
256  Code = TYPE_DEPENDENT_SIZED_ARRAY;
257}
258
259void
260ASTTypeWriter::VisitDependentSizedExtVectorType(
261                                        const DependentSizedExtVectorType *T) {
262  // FIXME: Serialize this type (C++ only)
263  assert(false && "Cannot serialize dependent sized extended vector types");
264}
265
266void
267ASTTypeWriter::VisitTemplateTypeParmType(const TemplateTypeParmType *T) {
268  Record.push_back(T->getDepth());
269  Record.push_back(T->getIndex());
270  Record.push_back(T->isParameterPack());
271  Writer.AddIdentifierRef(T->getName(), Record);
272  Code = TYPE_TEMPLATE_TYPE_PARM;
273}
274
275void
276ASTTypeWriter::VisitDependentNameType(const DependentNameType *T) {
277  Record.push_back(T->getKeyword());
278  Writer.AddNestedNameSpecifier(T->getQualifier(), Record);
279  Writer.AddIdentifierRef(T->getIdentifier(), Record);
280  Writer.AddTypeRef(T->isCanonicalUnqualified() ? QualType()
281                                                : T->getCanonicalTypeInternal(),
282                    Record);
283  Code = TYPE_DEPENDENT_NAME;
284}
285
286void
287ASTTypeWriter::VisitDependentTemplateSpecializationType(
288                                const DependentTemplateSpecializationType *T) {
289  Record.push_back(T->getKeyword());
290  Writer.AddNestedNameSpecifier(T->getQualifier(), Record);
291  Writer.AddIdentifierRef(T->getIdentifier(), Record);
292  Record.push_back(T->getNumArgs());
293  for (DependentTemplateSpecializationType::iterator
294         I = T->begin(), E = T->end(); I != E; ++I)
295    Writer.AddTemplateArgument(*I, Record);
296  Code = TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION;
297}
298
299void ASTTypeWriter::VisitElaboratedType(const ElaboratedType *T) {
300  Record.push_back(T->getKeyword());
301  Writer.AddNestedNameSpecifier(T->getQualifier(), Record);
302  Writer.AddTypeRef(T->getNamedType(), Record);
303  Code = TYPE_ELABORATED;
304}
305
306void ASTTypeWriter::VisitInjectedClassNameType(const InjectedClassNameType *T) {
307  Writer.AddDeclRef(T->getDecl(), Record);
308  Writer.AddTypeRef(T->getInjectedSpecializationType(), Record);
309  Code = TYPE_INJECTED_CLASS_NAME;
310}
311
312void ASTTypeWriter::VisitObjCInterfaceType(const ObjCInterfaceType *T) {
313  Writer.AddDeclRef(T->getDecl(), Record);
314  Code = TYPE_OBJC_INTERFACE;
315}
316
317void ASTTypeWriter::VisitObjCObjectType(const ObjCObjectType *T) {
318  Writer.AddTypeRef(T->getBaseType(), Record);
319  Record.push_back(T->getNumProtocols());
320  for (ObjCObjectType::qual_iterator I = T->qual_begin(),
321       E = T->qual_end(); I != E; ++I)
322    Writer.AddDeclRef(*I, Record);
323  Code = TYPE_OBJC_OBJECT;
324}
325
326void
327ASTTypeWriter::VisitObjCObjectPointerType(const ObjCObjectPointerType *T) {
328  Writer.AddTypeRef(T->getPointeeType(), Record);
329  Code = TYPE_OBJC_OBJECT_POINTER;
330}
331
332namespace {
333
334class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> {
335  ASTWriter &Writer;
336  ASTWriter::RecordDataImpl &Record;
337
338public:
339  TypeLocWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record)
340    : Writer(Writer), Record(Record) { }
341
342#define ABSTRACT_TYPELOC(CLASS, PARENT)
343#define TYPELOC(CLASS, PARENT) \
344    void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
345#include "clang/AST/TypeLocNodes.def"
346
347  void VisitArrayTypeLoc(ArrayTypeLoc TyLoc);
348  void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc);
349};
350
351}
352
353void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
354  // nothing to do
355}
356void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
357  Writer.AddSourceLocation(TL.getBuiltinLoc(), Record);
358  if (TL.needsExtraLocalData()) {
359    Record.push_back(TL.getWrittenTypeSpec());
360    Record.push_back(TL.getWrittenSignSpec());
361    Record.push_back(TL.getWrittenWidthSpec());
362    Record.push_back(TL.hasModeAttr());
363  }
364}
365void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
366  Writer.AddSourceLocation(TL.getNameLoc(), Record);
367}
368void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) {
369  Writer.AddSourceLocation(TL.getStarLoc(), Record);
370}
371void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
372  Writer.AddSourceLocation(TL.getCaretLoc(), Record);
373}
374void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
375  Writer.AddSourceLocation(TL.getAmpLoc(), Record);
376}
377void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
378  Writer.AddSourceLocation(TL.getAmpAmpLoc(), Record);
379}
380void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
381  Writer.AddSourceLocation(TL.getStarLoc(), Record);
382}
383void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) {
384  Writer.AddSourceLocation(TL.getLBracketLoc(), Record);
385  Writer.AddSourceLocation(TL.getRBracketLoc(), Record);
386  Record.push_back(TL.getSizeExpr() ? 1 : 0);
387  if (TL.getSizeExpr())
388    Writer.AddStmt(TL.getSizeExpr());
389}
390void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
391  VisitArrayTypeLoc(TL);
392}
393void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
394  VisitArrayTypeLoc(TL);
395}
396void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
397  VisitArrayTypeLoc(TL);
398}
399void TypeLocWriter::VisitDependentSizedArrayTypeLoc(
400                                            DependentSizedArrayTypeLoc TL) {
401  VisitArrayTypeLoc(TL);
402}
403void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc(
404                                        DependentSizedExtVectorTypeLoc TL) {
405  Writer.AddSourceLocation(TL.getNameLoc(), Record);
406}
407void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) {
408  Writer.AddSourceLocation(TL.getNameLoc(), Record);
409}
410void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
411  Writer.AddSourceLocation(TL.getNameLoc(), Record);
412}
413void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
414  Writer.AddSourceLocation(TL.getLParenLoc(), Record);
415  Writer.AddSourceLocation(TL.getRParenLoc(), Record);
416  Record.push_back(TL.getTrailingReturn());
417  for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
418    Writer.AddDeclRef(TL.getArg(i), Record);
419}
420void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
421  VisitFunctionTypeLoc(TL);
422}
423void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
424  VisitFunctionTypeLoc(TL);
425}
426void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
427  Writer.AddSourceLocation(TL.getNameLoc(), Record);
428}
429void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
430  Writer.AddSourceLocation(TL.getNameLoc(), Record);
431}
432void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
433  Writer.AddSourceLocation(TL.getTypeofLoc(), Record);
434  Writer.AddSourceLocation(TL.getLParenLoc(), Record);
435  Writer.AddSourceLocation(TL.getRParenLoc(), Record);
436}
437void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
438  Writer.AddSourceLocation(TL.getTypeofLoc(), Record);
439  Writer.AddSourceLocation(TL.getLParenLoc(), Record);
440  Writer.AddSourceLocation(TL.getRParenLoc(), Record);
441  Writer.AddTypeSourceInfo(TL.getUnderlyingTInfo(), Record);
442}
443void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
444  Writer.AddSourceLocation(TL.getNameLoc(), Record);
445}
446void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) {
447  Writer.AddSourceLocation(TL.getNameLoc(), Record);
448}
449void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) {
450  Writer.AddSourceLocation(TL.getNameLoc(), Record);
451}
452void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
453  Writer.AddSourceLocation(TL.getNameLoc(), Record);
454}
455void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
456                                            SubstTemplateTypeParmTypeLoc TL) {
457  Writer.AddSourceLocation(TL.getNameLoc(), Record);
458}
459void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
460                                           TemplateSpecializationTypeLoc TL) {
461  Writer.AddSourceLocation(TL.getTemplateNameLoc(), Record);
462  Writer.AddSourceLocation(TL.getLAngleLoc(), Record);
463  Writer.AddSourceLocation(TL.getRAngleLoc(), Record);
464  for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
465    Writer.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(),
466                                      TL.getArgLoc(i).getLocInfo(), Record);
467}
468void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
469  Writer.AddSourceLocation(TL.getKeywordLoc(), Record);
470  Writer.AddSourceRange(TL.getQualifierRange(), Record);
471}
472void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
473  Writer.AddSourceLocation(TL.getNameLoc(), Record);
474}
475void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
476  Writer.AddSourceLocation(TL.getKeywordLoc(), Record);
477  Writer.AddSourceRange(TL.getQualifierRange(), Record);
478  Writer.AddSourceLocation(TL.getNameLoc(), Record);
479}
480void TypeLocWriter::VisitDependentTemplateSpecializationTypeLoc(
481       DependentTemplateSpecializationTypeLoc TL) {
482  Writer.AddSourceLocation(TL.getKeywordLoc(), Record);
483  Writer.AddSourceRange(TL.getQualifierRange(), Record);
484  Writer.AddSourceLocation(TL.getNameLoc(), Record);
485  Writer.AddSourceLocation(TL.getLAngleLoc(), Record);
486  Writer.AddSourceLocation(TL.getRAngleLoc(), Record);
487  for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
488    Writer.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(),
489                                      TL.getArgLoc(I).getLocInfo(), Record);
490}
491void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
492  Writer.AddSourceLocation(TL.getNameLoc(), Record);
493}
494void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
495  Record.push_back(TL.hasBaseTypeAsWritten());
496  Writer.AddSourceLocation(TL.getLAngleLoc(), Record);
497  Writer.AddSourceLocation(TL.getRAngleLoc(), Record);
498  for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
499    Writer.AddSourceLocation(TL.getProtocolLoc(i), Record);
500}
501void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
502  Writer.AddSourceLocation(TL.getStarLoc(), Record);
503}
504
505//===----------------------------------------------------------------------===//
506// ASTWriter Implementation
507//===----------------------------------------------------------------------===//
508
509static void EmitBlockID(unsigned ID, const char *Name,
510                        llvm::BitstreamWriter &Stream,
511                        ASTWriter::RecordDataImpl &Record) {
512  Record.clear();
513  Record.push_back(ID);
514  Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
515
516  // Emit the block name if present.
517  if (Name == 0 || Name[0] == 0) return;
518  Record.clear();
519  while (*Name)
520    Record.push_back(*Name++);
521  Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record);
522}
523
524static void EmitRecordID(unsigned ID, const char *Name,
525                         llvm::BitstreamWriter &Stream,
526                         ASTWriter::RecordDataImpl &Record) {
527  Record.clear();
528  Record.push_back(ID);
529  while (*Name)
530    Record.push_back(*Name++);
531  Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
532}
533
534static void AddStmtsExprs(llvm::BitstreamWriter &Stream,
535                          ASTWriter::RecordDataImpl &Record) {
536#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
537  RECORD(STMT_STOP);
538  RECORD(STMT_NULL_PTR);
539  RECORD(STMT_NULL);
540  RECORD(STMT_COMPOUND);
541  RECORD(STMT_CASE);
542  RECORD(STMT_DEFAULT);
543  RECORD(STMT_LABEL);
544  RECORD(STMT_IF);
545  RECORD(STMT_SWITCH);
546  RECORD(STMT_WHILE);
547  RECORD(STMT_DO);
548  RECORD(STMT_FOR);
549  RECORD(STMT_GOTO);
550  RECORD(STMT_INDIRECT_GOTO);
551  RECORD(STMT_CONTINUE);
552  RECORD(STMT_BREAK);
553  RECORD(STMT_RETURN);
554  RECORD(STMT_DECL);
555  RECORD(STMT_ASM);
556  RECORD(EXPR_PREDEFINED);
557  RECORD(EXPR_DECL_REF);
558  RECORD(EXPR_INTEGER_LITERAL);
559  RECORD(EXPR_FLOATING_LITERAL);
560  RECORD(EXPR_IMAGINARY_LITERAL);
561  RECORD(EXPR_STRING_LITERAL);
562  RECORD(EXPR_CHARACTER_LITERAL);
563  RECORD(EXPR_PAREN);
564  RECORD(EXPR_UNARY_OPERATOR);
565  RECORD(EXPR_SIZEOF_ALIGN_OF);
566  RECORD(EXPR_ARRAY_SUBSCRIPT);
567  RECORD(EXPR_CALL);
568  RECORD(EXPR_MEMBER);
569  RECORD(EXPR_BINARY_OPERATOR);
570  RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR);
571  RECORD(EXPR_CONDITIONAL_OPERATOR);
572  RECORD(EXPR_IMPLICIT_CAST);
573  RECORD(EXPR_CSTYLE_CAST);
574  RECORD(EXPR_COMPOUND_LITERAL);
575  RECORD(EXPR_EXT_VECTOR_ELEMENT);
576  RECORD(EXPR_INIT_LIST);
577  RECORD(EXPR_DESIGNATED_INIT);
578  RECORD(EXPR_IMPLICIT_VALUE_INIT);
579  RECORD(EXPR_VA_ARG);
580  RECORD(EXPR_ADDR_LABEL);
581  RECORD(EXPR_STMT);
582  RECORD(EXPR_TYPES_COMPATIBLE);
583  RECORD(EXPR_CHOOSE);
584  RECORD(EXPR_GNU_NULL);
585  RECORD(EXPR_SHUFFLE_VECTOR);
586  RECORD(EXPR_BLOCK);
587  RECORD(EXPR_BLOCK_DECL_REF);
588  RECORD(EXPR_OBJC_STRING_LITERAL);
589  RECORD(EXPR_OBJC_ENCODE);
590  RECORD(EXPR_OBJC_SELECTOR_EXPR);
591  RECORD(EXPR_OBJC_PROTOCOL_EXPR);
592  RECORD(EXPR_OBJC_IVAR_REF_EXPR);
593  RECORD(EXPR_OBJC_PROPERTY_REF_EXPR);
594  RECORD(EXPR_OBJC_KVC_REF_EXPR);
595  RECORD(EXPR_OBJC_MESSAGE_EXPR);
596  RECORD(STMT_OBJC_FOR_COLLECTION);
597  RECORD(STMT_OBJC_CATCH);
598  RECORD(STMT_OBJC_FINALLY);
599  RECORD(STMT_OBJC_AT_TRY);
600  RECORD(STMT_OBJC_AT_SYNCHRONIZED);
601  RECORD(STMT_OBJC_AT_THROW);
602  RECORD(EXPR_CXX_OPERATOR_CALL);
603  RECORD(EXPR_CXX_CONSTRUCT);
604  RECORD(EXPR_CXX_STATIC_CAST);
605  RECORD(EXPR_CXX_DYNAMIC_CAST);
606  RECORD(EXPR_CXX_REINTERPRET_CAST);
607  RECORD(EXPR_CXX_CONST_CAST);
608  RECORD(EXPR_CXX_FUNCTIONAL_CAST);
609  RECORD(EXPR_CXX_BOOL_LITERAL);
610  RECORD(EXPR_CXX_NULL_PTR_LITERAL);
611#undef RECORD
612}
613
614void ASTWriter::WriteBlockInfoBlock() {
615  RecordData Record;
616  Stream.EnterSubblock(llvm::bitc::BLOCKINFO_BLOCK_ID, 3);
617
618#define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record)
619#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
620
621  // AST Top-Level Block.
622  BLOCK(AST_BLOCK);
623  RECORD(ORIGINAL_FILE_NAME);
624  RECORD(TYPE_OFFSET);
625  RECORD(DECL_OFFSET);
626  RECORD(LANGUAGE_OPTIONS);
627  RECORD(METADATA);
628  RECORD(IDENTIFIER_OFFSET);
629  RECORD(IDENTIFIER_TABLE);
630  RECORD(EXTERNAL_DEFINITIONS);
631  RECORD(SPECIAL_TYPES);
632  RECORD(STATISTICS);
633  RECORD(TENTATIVE_DEFINITIONS);
634  RECORD(UNUSED_FILESCOPED_DECLS);
635  RECORD(LOCALLY_SCOPED_EXTERNAL_DECLS);
636  RECORD(SELECTOR_OFFSETS);
637  RECORD(METHOD_POOL);
638  RECORD(PP_COUNTER_VALUE);
639  RECORD(SOURCE_LOCATION_OFFSETS);
640  RECORD(SOURCE_LOCATION_PRELOADS);
641  RECORD(STAT_CACHE);
642  RECORD(EXT_VECTOR_DECLS);
643  RECORD(VERSION_CONTROL_BRANCH_REVISION);
644  RECORD(MACRO_DEFINITION_OFFSETS);
645  RECORD(CHAINED_METADATA);
646  RECORD(REFERENCED_SELECTOR_POOL);
647
648  // SourceManager Block.
649  BLOCK(SOURCE_MANAGER_BLOCK);
650  RECORD(SM_SLOC_FILE_ENTRY);
651  RECORD(SM_SLOC_BUFFER_ENTRY);
652  RECORD(SM_SLOC_BUFFER_BLOB);
653  RECORD(SM_SLOC_INSTANTIATION_ENTRY);
654  RECORD(SM_LINE_TABLE);
655
656  // Preprocessor Block.
657  BLOCK(PREPROCESSOR_BLOCK);
658  RECORD(PP_MACRO_OBJECT_LIKE);
659  RECORD(PP_MACRO_FUNCTION_LIKE);
660  RECORD(PP_TOKEN);
661  RECORD(PP_MACRO_INSTANTIATION);
662  RECORD(PP_MACRO_DEFINITION);
663
664  // Decls and Types block.
665  BLOCK(DECLTYPES_BLOCK);
666  RECORD(TYPE_EXT_QUAL);
667  RECORD(TYPE_COMPLEX);
668  RECORD(TYPE_POINTER);
669  RECORD(TYPE_BLOCK_POINTER);
670  RECORD(TYPE_LVALUE_REFERENCE);
671  RECORD(TYPE_RVALUE_REFERENCE);
672  RECORD(TYPE_MEMBER_POINTER);
673  RECORD(TYPE_CONSTANT_ARRAY);
674  RECORD(TYPE_INCOMPLETE_ARRAY);
675  RECORD(TYPE_VARIABLE_ARRAY);
676  RECORD(TYPE_VECTOR);
677  RECORD(TYPE_EXT_VECTOR);
678  RECORD(TYPE_FUNCTION_PROTO);
679  RECORD(TYPE_FUNCTION_NO_PROTO);
680  RECORD(TYPE_TYPEDEF);
681  RECORD(TYPE_TYPEOF_EXPR);
682  RECORD(TYPE_TYPEOF);
683  RECORD(TYPE_RECORD);
684  RECORD(TYPE_ENUM);
685  RECORD(TYPE_OBJC_INTERFACE);
686  RECORD(TYPE_OBJC_OBJECT);
687  RECORD(TYPE_OBJC_OBJECT_POINTER);
688  RECORD(DECL_TRANSLATION_UNIT);
689  RECORD(DECL_TYPEDEF);
690  RECORD(DECL_ENUM);
691  RECORD(DECL_RECORD);
692  RECORD(DECL_ENUM_CONSTANT);
693  RECORD(DECL_FUNCTION);
694  RECORD(DECL_OBJC_METHOD);
695  RECORD(DECL_OBJC_INTERFACE);
696  RECORD(DECL_OBJC_PROTOCOL);
697  RECORD(DECL_OBJC_IVAR);
698  RECORD(DECL_OBJC_AT_DEFS_FIELD);
699  RECORD(DECL_OBJC_CLASS);
700  RECORD(DECL_OBJC_FORWARD_PROTOCOL);
701  RECORD(DECL_OBJC_CATEGORY);
702  RECORD(DECL_OBJC_CATEGORY_IMPL);
703  RECORD(DECL_OBJC_IMPLEMENTATION);
704  RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
705  RECORD(DECL_OBJC_PROPERTY);
706  RECORD(DECL_OBJC_PROPERTY_IMPL);
707  RECORD(DECL_FIELD);
708  RECORD(DECL_VAR);
709  RECORD(DECL_IMPLICIT_PARAM);
710  RECORD(DECL_PARM_VAR);
711  RECORD(DECL_FILE_SCOPE_ASM);
712  RECORD(DECL_BLOCK);
713  RECORD(DECL_CONTEXT_LEXICAL);
714  RECORD(DECL_CONTEXT_VISIBLE);
715  // Statements and Exprs can occur in the Decls and Types block.
716  AddStmtsExprs(Stream, Record);
717#undef RECORD
718#undef BLOCK
719  Stream.ExitBlock();
720}
721
722/// \brief Adjusts the given filename to only write out the portion of the
723/// filename that is not part of the system root directory.
724///
725/// \param Filename the file name to adjust.
726///
727/// \param isysroot When non-NULL, the PCH file is a relocatable PCH file and
728/// the returned filename will be adjusted by this system root.
729///
730/// \returns either the original filename (if it needs no adjustment) or the
731/// adjusted filename (which points into the @p Filename parameter).
732static const char *
733adjustFilenameForRelocatablePCH(const char *Filename, const char *isysroot) {
734  assert(Filename && "No file name to adjust?");
735
736  if (!isysroot)
737    return Filename;
738
739  // Verify that the filename and the system root have the same prefix.
740  unsigned Pos = 0;
741  for (; Filename[Pos] && isysroot[Pos]; ++Pos)
742    if (Filename[Pos] != isysroot[Pos])
743      return Filename; // Prefixes don't match.
744
745  // We hit the end of the filename before we hit the end of the system root.
746  if (!Filename[Pos])
747    return Filename;
748
749  // If the file name has a '/' at the current position, skip over the '/'.
750  // We distinguish sysroot-based includes from absolute includes by the
751  // absence of '/' at the beginning of sysroot-based includes.
752  if (Filename[Pos] == '/')
753    ++Pos;
754
755  return Filename + Pos;
756}
757
758/// \brief Write the AST metadata (e.g., i686-apple-darwin9).
759void ASTWriter::WriteMetadata(ASTContext &Context, const char *isysroot) {
760  using namespace llvm;
761
762  // Metadata
763  const TargetInfo &Target = Context.Target;
764  BitCodeAbbrev *MetaAbbrev = new BitCodeAbbrev();
765  MetaAbbrev->Add(BitCodeAbbrevOp(
766                    Chain ? CHAINED_METADATA : METADATA));
767  MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // AST major
768  MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // AST minor
769  MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang major
770  MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang minor
771  MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
772  // Target triple or chained PCH name
773  MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
774  unsigned MetaAbbrevCode = Stream.EmitAbbrev(MetaAbbrev);
775
776  RecordData Record;
777  Record.push_back(Chain ? CHAINED_METADATA : METADATA);
778  Record.push_back(VERSION_MAJOR);
779  Record.push_back(VERSION_MINOR);
780  Record.push_back(CLANG_VERSION_MAJOR);
781  Record.push_back(CLANG_VERSION_MINOR);
782  Record.push_back(isysroot != 0);
783  // FIXME: This writes the absolute path for chained headers.
784  const std::string &BlobStr = Chain ? Chain->getFileName() : Target.getTriple().getTriple();
785  Stream.EmitRecordWithBlob(MetaAbbrevCode, Record, BlobStr);
786
787  // Original file name
788  SourceManager &SM = Context.getSourceManager();
789  if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
790    BitCodeAbbrev *FileAbbrev = new BitCodeAbbrev();
791    FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE_NAME));
792    FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
793    unsigned FileAbbrevCode = Stream.EmitAbbrev(FileAbbrev);
794
795    llvm::sys::Path MainFilePath(MainFile->getName());
796
797    MainFilePath.makeAbsolute();
798
799    const char *MainFileNameStr = MainFilePath.c_str();
800    MainFileNameStr = adjustFilenameForRelocatablePCH(MainFileNameStr,
801                                                      isysroot);
802    RecordData Record;
803    Record.push_back(ORIGINAL_FILE_NAME);
804    Stream.EmitRecordWithBlob(FileAbbrevCode, Record, MainFileNameStr);
805  }
806
807  // Repository branch/version information.
808  BitCodeAbbrev *RepoAbbrev = new BitCodeAbbrev();
809  RepoAbbrev->Add(BitCodeAbbrevOp(VERSION_CONTROL_BRANCH_REVISION));
810  RepoAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
811  unsigned RepoAbbrevCode = Stream.EmitAbbrev(RepoAbbrev);
812  Record.clear();
813  Record.push_back(VERSION_CONTROL_BRANCH_REVISION);
814  Stream.EmitRecordWithBlob(RepoAbbrevCode, Record,
815                            getClangFullRepositoryVersion());
816}
817
818/// \brief Write the LangOptions structure.
819void ASTWriter::WriteLanguageOptions(const LangOptions &LangOpts) {
820  RecordData Record;
821  Record.push_back(LangOpts.Trigraphs);
822  Record.push_back(LangOpts.BCPLComment);  // BCPL-style '//' comments.
823  Record.push_back(LangOpts.DollarIdents);  // '$' allowed in identifiers.
824  Record.push_back(LangOpts.AsmPreprocessor);  // Preprocessor in asm mode.
825  Record.push_back(LangOpts.GNUMode);  // True in gnu99 mode false in c99 mode (etc)
826  Record.push_back(LangOpts.GNUKeywords);  // Allow GNU-extension keywords
827  Record.push_back(LangOpts.ImplicitInt);  // C89 implicit 'int'.
828  Record.push_back(LangOpts.Digraphs);  // C94, C99 and C++
829  Record.push_back(LangOpts.HexFloats);  // C99 Hexadecimal float constants.
830  Record.push_back(LangOpts.C99);  // C99 Support
831  Record.push_back(LangOpts.Microsoft);  // Microsoft extensions.
832  // LangOpts.MSCVersion is ignored because all it does it set a macro, which is
833  // already saved elsewhere.
834  Record.push_back(LangOpts.CPlusPlus);  // C++ Support
835  Record.push_back(LangOpts.CPlusPlus0x);  // C++0x Support
836  Record.push_back(LangOpts.CXXOperatorNames);  // Treat C++ operator names as keywords.
837
838  Record.push_back(LangOpts.ObjC1);  // Objective-C 1 support enabled.
839  Record.push_back(LangOpts.ObjC2);  // Objective-C 2 support enabled.
840  Record.push_back(LangOpts.ObjCNonFragileABI);  // Objective-C
841                                                 // modern abi enabled.
842  Record.push_back(LangOpts.ObjCNonFragileABI2); // Objective-C enhanced
843                                                 // modern abi enabled.
844  Record.push_back(LangOpts.NoConstantCFStrings); // non cfstring generation enabled..
845
846  Record.push_back(LangOpts.PascalStrings);  // Allow Pascal strings
847  Record.push_back(LangOpts.WritableStrings);  // Allow writable strings
848  Record.push_back(LangOpts.LaxVectorConversions);
849  Record.push_back(LangOpts.AltiVec);
850  Record.push_back(LangOpts.Exceptions);  // Support exception handling.
851  Record.push_back(LangOpts.SjLjExceptions);
852
853  Record.push_back(LangOpts.NeXTRuntime); // Use NeXT runtime.
854  Record.push_back(LangOpts.Freestanding); // Freestanding implementation
855  Record.push_back(LangOpts.NoBuiltin); // Do not use builtin functions (-fno-builtin)
856
857  // Whether static initializers are protected by locks.
858  Record.push_back(LangOpts.ThreadsafeStatics);
859  Record.push_back(LangOpts.POSIXThreads);
860  Record.push_back(LangOpts.Blocks); // block extension to C
861  Record.push_back(LangOpts.EmitAllDecls); // Emit all declarations, even if
862                                  // they are unused.
863  Record.push_back(LangOpts.MathErrno); // Math functions must respect errno
864                                  // (modulo the platform support).
865
866  Record.push_back(LangOpts.getSignedOverflowBehavior());
867  Record.push_back(LangOpts.HeinousExtensions);
868
869  Record.push_back(LangOpts.Optimize); // Whether __OPTIMIZE__ should be defined.
870  Record.push_back(LangOpts.OptimizeSize); // Whether __OPTIMIZE_SIZE__ should be
871                                  // defined.
872  Record.push_back(LangOpts.Static); // Should __STATIC__ be defined (as
873                                  // opposed to __DYNAMIC__).
874  Record.push_back(LangOpts.PICLevel); // The value for __PIC__, if non-zero.
875
876  Record.push_back(LangOpts.GNUInline); // Should GNU inline semantics be
877                                  // used (instead of C99 semantics).
878  Record.push_back(LangOpts.NoInline); // Should __NO_INLINE__ be defined.
879  Record.push_back(LangOpts.AccessControl); // Whether C++ access control should
880                                            // be enabled.
881  Record.push_back(LangOpts.CharIsSigned); // Whether char is a signed or
882                                           // unsigned type
883  Record.push_back(LangOpts.ShortWChar);  // force wchar_t to be unsigned short
884  Record.push_back(LangOpts.getGCMode());
885  Record.push_back(LangOpts.getVisibilityMode());
886  Record.push_back(LangOpts.getStackProtectorMode());
887  Record.push_back(LangOpts.InstantiationDepth);
888  Record.push_back(LangOpts.OpenCL);
889  Record.push_back(LangOpts.CatchUndefined);
890  Record.push_back(LangOpts.ElideConstructors);
891  Record.push_back(LangOpts.SpellChecking);
892  Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
893}
894
895//===----------------------------------------------------------------------===//
896// stat cache Serialization
897//===----------------------------------------------------------------------===//
898
899namespace {
900// Trait used for the on-disk hash table of stat cache results.
901class ASTStatCacheTrait {
902public:
903  typedef const char * key_type;
904  typedef key_type key_type_ref;
905
906  typedef std::pair<int, struct stat> data_type;
907  typedef const data_type& data_type_ref;
908
909  static unsigned ComputeHash(const char *path) {
910    return llvm::HashString(path);
911  }
912
913  std::pair<unsigned,unsigned>
914    EmitKeyDataLength(llvm::raw_ostream& Out, const char *path,
915                      data_type_ref Data) {
916    unsigned StrLen = strlen(path);
917    clang::io::Emit16(Out, StrLen);
918    unsigned DataLen = 1; // result value
919    if (Data.first == 0)
920      DataLen += 4 + 4 + 2 + 8 + 8;
921    clang::io::Emit8(Out, DataLen);
922    return std::make_pair(StrLen + 1, DataLen);
923  }
924
925  void EmitKey(llvm::raw_ostream& Out, const char *path, unsigned KeyLen) {
926    Out.write(path, KeyLen);
927  }
928
929  void EmitData(llvm::raw_ostream& Out, key_type_ref,
930                data_type_ref Data, unsigned DataLen) {
931    using namespace clang::io;
932    uint64_t Start = Out.tell(); (void)Start;
933
934    // Result of stat()
935    Emit8(Out, Data.first? 1 : 0);
936
937    if (Data.first == 0) {
938      Emit32(Out, (uint32_t) Data.second.st_ino);
939      Emit32(Out, (uint32_t) Data.second.st_dev);
940      Emit16(Out, (uint16_t) Data.second.st_mode);
941      Emit64(Out, (uint64_t) Data.second.st_mtime);
942      Emit64(Out, (uint64_t) Data.second.st_size);
943    }
944
945    assert(Out.tell() - Start == DataLen && "Wrong data length");
946  }
947};
948} // end anonymous namespace
949
950/// \brief Write the stat() system call cache to the AST file.
951void ASTWriter::WriteStatCache(MemorizeStatCalls &StatCalls) {
952  // Build the on-disk hash table containing information about every
953  // stat() call.
954  OnDiskChainedHashTableGenerator<ASTStatCacheTrait> Generator;
955  unsigned NumStatEntries = 0;
956  for (MemorizeStatCalls::iterator Stat = StatCalls.begin(),
957                                StatEnd = StatCalls.end();
958       Stat != StatEnd; ++Stat, ++NumStatEntries) {
959    const char *Filename = Stat->first();
960    Generator.insert(Filename, Stat->second);
961  }
962
963  // Create the on-disk hash table in a buffer.
964  llvm::SmallString<4096> StatCacheData;
965  uint32_t BucketOffset;
966  {
967    llvm::raw_svector_ostream Out(StatCacheData);
968    // Make sure that no bucket is at offset 0
969    clang::io::Emit32(Out, 0);
970    BucketOffset = Generator.Emit(Out);
971  }
972
973  // Create a blob abbreviation
974  using namespace llvm;
975  BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
976  Abbrev->Add(BitCodeAbbrevOp(STAT_CACHE));
977  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
978  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
979  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
980  unsigned StatCacheAbbrev = Stream.EmitAbbrev(Abbrev);
981
982  // Write the stat cache
983  RecordData Record;
984  Record.push_back(STAT_CACHE);
985  Record.push_back(BucketOffset);
986  Record.push_back(NumStatEntries);
987  Stream.EmitRecordWithBlob(StatCacheAbbrev, Record, StatCacheData.str());
988}
989
990//===----------------------------------------------------------------------===//
991// Source Manager Serialization
992//===----------------------------------------------------------------------===//
993
994/// \brief Create an abbreviation for the SLocEntry that refers to a
995/// file.
996static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
997  using namespace llvm;
998  BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
999  Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
1000  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1001  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1002  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1003  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1004  // FileEntry fields.
1005  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1006  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
1007  // HeaderFileInfo fields.
1008  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isImport
1009  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // DirInfo
1010  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumIncludes
1011  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // ControllingMacro
1012  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1013  return Stream.EmitAbbrev(Abbrev);
1014}
1015
1016/// \brief Create an abbreviation for the SLocEntry that refers to a
1017/// buffer.
1018static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
1019  using namespace llvm;
1020  BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1021  Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
1022  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1023  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1024  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1025  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1026  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
1027  return Stream.EmitAbbrev(Abbrev);
1028}
1029
1030/// \brief Create an abbreviation for the SLocEntry that refers to a
1031/// buffer's blob.
1032static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream) {
1033  using namespace llvm;
1034  BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1035  Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_BLOB));
1036  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
1037  return Stream.EmitAbbrev(Abbrev);
1038}
1039
1040/// \brief Create an abbreviation for the SLocEntry that refers to an
1041/// buffer.
1042static unsigned CreateSLocInstantiationAbbrev(llvm::BitstreamWriter &Stream) {
1043  using namespace llvm;
1044  BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1045  Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_INSTANTIATION_ENTRY));
1046  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1047  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1048  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1049  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
1050  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
1051  return Stream.EmitAbbrev(Abbrev);
1052}
1053
1054/// \brief Writes the block containing the serialized form of the
1055/// source manager.
1056///
1057/// TODO: We should probably use an on-disk hash table (stored in a
1058/// blob), indexed based on the file name, so that we only create
1059/// entries for files that we actually need. In the common case (no
1060/// errors), we probably won't have to create file entries for any of
1061/// the files in the AST.
1062void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
1063                                        const Preprocessor &PP,
1064                                        const char *isysroot) {
1065  RecordData Record;
1066
1067  // Enter the source manager block.
1068  Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 3);
1069
1070  // Abbreviations for the various kinds of source-location entries.
1071  unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
1072  unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
1073  unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream);
1074  unsigned SLocInstantiationAbbrv = CreateSLocInstantiationAbbrev(Stream);
1075
1076  // Write the line table.
1077  if (SourceMgr.hasLineTable()) {
1078    LineTableInfo &LineTable = SourceMgr.getLineTable();
1079
1080    // Emit the file names
1081    Record.push_back(LineTable.getNumFilenames());
1082    for (unsigned I = 0, N = LineTable.getNumFilenames(); I != N; ++I) {
1083      // Emit the file name
1084      const char *Filename = LineTable.getFilename(I);
1085      Filename = adjustFilenameForRelocatablePCH(Filename, isysroot);
1086      unsigned FilenameLen = Filename? strlen(Filename) : 0;
1087      Record.push_back(FilenameLen);
1088      if (FilenameLen)
1089        Record.insert(Record.end(), Filename, Filename + FilenameLen);
1090    }
1091
1092    // Emit the line entries
1093    for (LineTableInfo::iterator L = LineTable.begin(), LEnd = LineTable.end();
1094         L != LEnd; ++L) {
1095      // Emit the file ID
1096      Record.push_back(L->first);
1097
1098      // Emit the line entries
1099      Record.push_back(L->second.size());
1100      for (std::vector<LineEntry>::iterator LE = L->second.begin(),
1101                                         LEEnd = L->second.end();
1102           LE != LEEnd; ++LE) {
1103        Record.push_back(LE->FileOffset);
1104        Record.push_back(LE->LineNo);
1105        Record.push_back(LE->FilenameID);
1106        Record.push_back((unsigned)LE->FileKind);
1107        Record.push_back(LE->IncludeOffset);
1108      }
1109    }
1110    Stream.EmitRecord(SM_LINE_TABLE, Record);
1111  }
1112
1113  // Write out the source location entry table. We skip the first
1114  // entry, which is always the same dummy entry.
1115  std::vector<uint32_t> SLocEntryOffsets;
1116  RecordData PreloadSLocs;
1117  unsigned BaseSLocID = Chain ? Chain->getTotalNumSLocs() : 0;
1118  SLocEntryOffsets.reserve(SourceMgr.sloc_entry_size() - 1 - BaseSLocID);
1119  for (unsigned I = BaseSLocID + 1, N = SourceMgr.sloc_entry_size();
1120       I != N; ++I) {
1121    // Get this source location entry.
1122    const SrcMgr::SLocEntry *SLoc = &SourceMgr.getSLocEntry(I);
1123
1124    // Record the offset of this source-location entry.
1125    SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
1126
1127    // Figure out which record code to use.
1128    unsigned Code;
1129    if (SLoc->isFile()) {
1130      if (SLoc->getFile().getContentCache()->Entry)
1131        Code = SM_SLOC_FILE_ENTRY;
1132      else
1133        Code = SM_SLOC_BUFFER_ENTRY;
1134    } else
1135      Code = SM_SLOC_INSTANTIATION_ENTRY;
1136    Record.clear();
1137    Record.push_back(Code);
1138
1139    Record.push_back(SLoc->getOffset());
1140    if (SLoc->isFile()) {
1141      const SrcMgr::FileInfo &File = SLoc->getFile();
1142      Record.push_back(File.getIncludeLoc().getRawEncoding());
1143      Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
1144      Record.push_back(File.hasLineDirectives());
1145
1146      const SrcMgr::ContentCache *Content = File.getContentCache();
1147      if (Content->Entry) {
1148        // The source location entry is a file. The blob associated
1149        // with this entry is the file name.
1150
1151        // Emit size/modification time for this file.
1152        Record.push_back(Content->Entry->getSize());
1153        Record.push_back(Content->Entry->getModificationTime());
1154
1155        // Emit header-search information associated with this file.
1156        HeaderFileInfo HFI;
1157        HeaderSearch &HS = PP.getHeaderSearchInfo();
1158        if (Content->Entry->getUID() < HS.header_file_size())
1159          HFI = HS.header_file_begin()[Content->Entry->getUID()];
1160        Record.push_back(HFI.isImport);
1161        Record.push_back(HFI.DirInfo);
1162        Record.push_back(HFI.NumIncludes);
1163        AddIdentifierRef(HFI.ControllingMacro, Record);
1164
1165        // Turn the file name into an absolute path, if it isn't already.
1166        const char *Filename = Content->Entry->getName();
1167        llvm::sys::Path FilePath(Filename, strlen(Filename));
1168        FilePath.makeAbsolute();
1169        Filename = FilePath.c_str();
1170
1171        Filename = adjustFilenameForRelocatablePCH(Filename, isysroot);
1172        Stream.EmitRecordWithBlob(SLocFileAbbrv, Record, Filename);
1173
1174        // FIXME: For now, preload all file source locations, so that
1175        // we get the appropriate File entries in the reader. This is
1176        // a temporary measure.
1177        PreloadSLocs.push_back(BaseSLocID + SLocEntryOffsets.size());
1178      } else {
1179        // The source location entry is a buffer. The blob associated
1180        // with this entry contains the contents of the buffer.
1181
1182        // We add one to the size so that we capture the trailing NULL
1183        // that is required by llvm::MemoryBuffer::getMemBuffer (on
1184        // the reader side).
1185        const llvm::MemoryBuffer *Buffer
1186          = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
1187        const char *Name = Buffer->getBufferIdentifier();
1188        Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
1189                                  llvm::StringRef(Name, strlen(Name) + 1));
1190        Record.clear();
1191        Record.push_back(SM_SLOC_BUFFER_BLOB);
1192        Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record,
1193                                  llvm::StringRef(Buffer->getBufferStart(),
1194                                                  Buffer->getBufferSize() + 1));
1195
1196        if (strcmp(Name, "<built-in>") == 0)
1197          PreloadSLocs.push_back(BaseSLocID + SLocEntryOffsets.size());
1198      }
1199    } else {
1200      // The source location entry is an instantiation.
1201      const SrcMgr::InstantiationInfo &Inst = SLoc->getInstantiation();
1202      Record.push_back(Inst.getSpellingLoc().getRawEncoding());
1203      Record.push_back(Inst.getInstantiationLocStart().getRawEncoding());
1204      Record.push_back(Inst.getInstantiationLocEnd().getRawEncoding());
1205
1206      // Compute the token length for this macro expansion.
1207      unsigned NextOffset = SourceMgr.getNextOffset();
1208      if (I + 1 != N)
1209        NextOffset = SourceMgr.getSLocEntry(I + 1).getOffset();
1210      Record.push_back(NextOffset - SLoc->getOffset() - 1);
1211      Stream.EmitRecordWithAbbrev(SLocInstantiationAbbrv, Record);
1212    }
1213  }
1214
1215  Stream.ExitBlock();
1216
1217  if (SLocEntryOffsets.empty())
1218    return;
1219
1220  // Write the source-location offsets table into the AST block. This
1221  // table is used for lazily loading source-location information.
1222  using namespace llvm;
1223  BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1224  Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
1225  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
1226  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // next offset
1227  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
1228  unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(Abbrev);
1229
1230  Record.clear();
1231  Record.push_back(SOURCE_LOCATION_OFFSETS);
1232  Record.push_back(SLocEntryOffsets.size());
1233  unsigned BaseOffset = Chain ? Chain->getNextSLocOffset() : 0;
1234  Record.push_back(SourceMgr.getNextOffset() - BaseOffset);
1235  Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
1236                            (const char *)data(SLocEntryOffsets),
1237                           SLocEntryOffsets.size()*sizeof(SLocEntryOffsets[0]));
1238
1239  // Write the source location entry preloads array, telling the AST
1240  // reader which source locations entries it should load eagerly.
1241  Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
1242}
1243
1244//===----------------------------------------------------------------------===//
1245// Preprocessor Serialization
1246//===----------------------------------------------------------------------===//
1247
1248/// \brief Writes the block containing the serialized form of the
1249/// preprocessor.
1250///
1251void ASTWriter::WritePreprocessor(const Preprocessor &PP) {
1252  RecordData Record;
1253
1254  // If the preprocessor __COUNTER__ value has been bumped, remember it.
1255  if (PP.getCounterValue() != 0) {
1256    Record.push_back(PP.getCounterValue());
1257    Stream.EmitRecord(PP_COUNTER_VALUE, Record);
1258    Record.clear();
1259  }
1260
1261  // Enter the preprocessor block.
1262  Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
1263
1264  // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
1265  // FIXME: use diagnostics subsystem for localization etc.
1266  if (PP.SawDateOrTime())
1267    fprintf(stderr, "warning: precompiled header used __DATE__ or __TIME__.\n");
1268
1269
1270  // Loop over all the macro definitions that are live at the end of the file,
1271  // emitting each to the PP section.
1272  PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
1273  unsigned InclusionAbbrev = 0;
1274  if (PPRec) {
1275    using namespace llvm;
1276    BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1277    Abbrev->Add(BitCodeAbbrevOp(PP_INCLUSION_DIRECTIVE));
1278    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // index
1279    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // start location
1280    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // end location
1281    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
1282    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
1283    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
1284    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1285    InclusionAbbrev = Stream.EmitAbbrev(Abbrev);
1286  }
1287
1288  for (Preprocessor::macro_iterator I = PP.macro_begin(), E = PP.macro_end();
1289       I != E; ++I) {
1290    // FIXME: This emits macros in hash table order, we should do it in a stable
1291    // order so that output is reproducible.
1292    MacroInfo *MI = I->second;
1293
1294    // Don't emit builtin macros like __LINE__ to the AST file unless they have
1295    // been redefined by the header (in which case they are not isBuiltinMacro).
1296    // Also skip macros from a AST file if we're chaining.
1297
1298    // FIXME: There is a (probably minor) optimization we could do here, if
1299    // the macro comes from the original PCH but the identifier comes from a
1300    // chained PCH, by storing the offset into the original PCH rather than
1301    // writing the macro definition a second time.
1302    if (MI->isBuiltinMacro() ||
1303        (Chain && I->first->isFromAST() && MI->isFromAST()))
1304      continue;
1305
1306    AddIdentifierRef(I->first, Record);
1307    MacroOffsets[I->first] = Stream.GetCurrentBitNo();
1308    Record.push_back(MI->getDefinitionLoc().getRawEncoding());
1309    Record.push_back(MI->isUsed());
1310
1311    unsigned Code;
1312    if (MI->isObjectLike()) {
1313      Code = PP_MACRO_OBJECT_LIKE;
1314    } else {
1315      Code = PP_MACRO_FUNCTION_LIKE;
1316
1317      Record.push_back(MI->isC99Varargs());
1318      Record.push_back(MI->isGNUVarargs());
1319      Record.push_back(MI->getNumArgs());
1320      for (MacroInfo::arg_iterator I = MI->arg_begin(), E = MI->arg_end();
1321           I != E; ++I)
1322        AddIdentifierRef(*I, Record);
1323    }
1324
1325    // If we have a detailed preprocessing record, record the macro definition
1326    // ID that corresponds to this macro.
1327    if (PPRec)
1328      Record.push_back(getMacroDefinitionID(PPRec->findMacroDefinition(MI)));
1329
1330    Stream.EmitRecord(Code, Record);
1331    Record.clear();
1332
1333    // Emit the tokens array.
1334    for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
1335      // Note that we know that the preprocessor does not have any annotation
1336      // tokens in it because they are created by the parser, and thus can't be
1337      // in a macro definition.
1338      const Token &Tok = MI->getReplacementToken(TokNo);
1339
1340      Record.push_back(Tok.getLocation().getRawEncoding());
1341      Record.push_back(Tok.getLength());
1342
1343      // FIXME: When reading literal tokens, reconstruct the literal pointer if
1344      // it is needed.
1345      AddIdentifierRef(Tok.getIdentifierInfo(), Record);
1346
1347      // FIXME: Should translate token kind to a stable encoding.
1348      Record.push_back(Tok.getKind());
1349      // FIXME: Should translate token flags to a stable encoding.
1350      Record.push_back(Tok.getFlags());
1351
1352      Stream.EmitRecord(PP_TOKEN, Record);
1353      Record.clear();
1354    }
1355    ++NumMacros;
1356  }
1357
1358  // If the preprocessor has a preprocessing record, emit it.
1359  unsigned NumPreprocessingRecords = 0;
1360  if (PPRec) {
1361    unsigned IndexBase = Chain ? PPRec->getNumPreallocatedEntities() : 0;
1362    for (PreprocessingRecord::iterator E = PPRec->begin(Chain),
1363                                       EEnd = PPRec->end(Chain);
1364         E != EEnd; ++E) {
1365      Record.clear();
1366
1367      if (MacroInstantiation *MI = dyn_cast<MacroInstantiation>(*E)) {
1368        Record.push_back(IndexBase + NumPreprocessingRecords++);
1369        AddSourceLocation(MI->getSourceRange().getBegin(), Record);
1370        AddSourceLocation(MI->getSourceRange().getEnd(), Record);
1371        AddIdentifierRef(MI->getName(), Record);
1372        Record.push_back(getMacroDefinitionID(MI->getDefinition()));
1373        Stream.EmitRecord(PP_MACRO_INSTANTIATION, Record);
1374        continue;
1375      }
1376
1377      if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) {
1378        // Record this macro definition's location.
1379        MacroID ID = getMacroDefinitionID(MD);
1380
1381        // Don't write the macro definition if it is from another AST file.
1382        if (ID < FirstMacroID)
1383          continue;
1384
1385        unsigned Position = ID - FirstMacroID;
1386        if (Position != MacroDefinitionOffsets.size()) {
1387          if (Position > MacroDefinitionOffsets.size())
1388            MacroDefinitionOffsets.resize(Position + 1);
1389
1390          MacroDefinitionOffsets[Position] = Stream.GetCurrentBitNo();
1391        } else
1392          MacroDefinitionOffsets.push_back(Stream.GetCurrentBitNo());
1393
1394        Record.push_back(IndexBase + NumPreprocessingRecords++);
1395        Record.push_back(ID);
1396        AddSourceLocation(MD->getSourceRange().getBegin(), Record);
1397        AddSourceLocation(MD->getSourceRange().getEnd(), Record);
1398        AddIdentifierRef(MD->getName(), Record);
1399        AddSourceLocation(MD->getLocation(), Record);
1400        Stream.EmitRecord(PP_MACRO_DEFINITION, Record);
1401        continue;
1402      }
1403
1404      if (InclusionDirective *ID = dyn_cast<InclusionDirective>(*E)) {
1405        Record.push_back(PP_INCLUSION_DIRECTIVE);
1406        Record.push_back(IndexBase + NumPreprocessingRecords++);
1407        AddSourceLocation(ID->getSourceRange().getBegin(), Record);
1408        AddSourceLocation(ID->getSourceRange().getEnd(), Record);
1409        Record.push_back(ID->getFileName().size());
1410        Record.push_back(ID->wasInQuotes());
1411        Record.push_back(static_cast<unsigned>(ID->getKind()));
1412        llvm::SmallString<64> Buffer;
1413        Buffer += ID->getFileName();
1414        Buffer += ID->getFile()->getName();
1415        Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
1416        continue;
1417      }
1418    }
1419  }
1420
1421  Stream.ExitBlock();
1422
1423  // Write the offsets table for the preprocessing record.
1424  if (NumPreprocessingRecords > 0) {
1425    // Write the offsets table for identifier IDs.
1426    using namespace llvm;
1427    BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1428    Abbrev->Add(BitCodeAbbrevOp(MACRO_DEFINITION_OFFSETS));
1429    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of records
1430    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macro defs
1431    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1432    unsigned MacroDefOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1433
1434    Record.clear();
1435    Record.push_back(MACRO_DEFINITION_OFFSETS);
1436    Record.push_back(NumPreprocessingRecords);
1437    Record.push_back(MacroDefinitionOffsets.size());
1438    Stream.EmitRecordWithBlob(MacroDefOffsetAbbrev, Record,
1439                              (const char *)data(MacroDefinitionOffsets),
1440                              MacroDefinitionOffsets.size() * sizeof(uint32_t));
1441  }
1442}
1443
1444//===----------------------------------------------------------------------===//
1445// Type Serialization
1446//===----------------------------------------------------------------------===//
1447
1448/// \brief Write the representation of a type to the AST stream.
1449void ASTWriter::WriteType(QualType T) {
1450  TypeIdx &Idx = TypeIdxs[T];
1451  if (Idx.getIndex() == 0) // we haven't seen this type before.
1452    Idx = TypeIdx(NextTypeID++);
1453
1454  assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
1455
1456  // Record the offset for this type.
1457  unsigned Index = Idx.getIndex() - FirstTypeID;
1458  if (TypeOffsets.size() == Index)
1459    TypeOffsets.push_back(Stream.GetCurrentBitNo());
1460  else if (TypeOffsets.size() < Index) {
1461    TypeOffsets.resize(Index + 1);
1462    TypeOffsets[Index] = Stream.GetCurrentBitNo();
1463  }
1464
1465  RecordData Record;
1466
1467  // Emit the type's representation.
1468  ASTTypeWriter W(*this, Record);
1469
1470  if (T.hasLocalNonFastQualifiers()) {
1471    Qualifiers Qs = T.getLocalQualifiers();
1472    AddTypeRef(T.getLocalUnqualifiedType(), Record);
1473    Record.push_back(Qs.getAsOpaqueValue());
1474    W.Code = TYPE_EXT_QUAL;
1475  } else {
1476    switch (T->getTypeClass()) {
1477      // For all of the concrete, non-dependent types, call the
1478      // appropriate visitor function.
1479#define TYPE(Class, Base) \
1480    case Type::Class: W.Visit##Class##Type(cast<Class##Type>(T)); break;
1481#define ABSTRACT_TYPE(Class, Base)
1482#include "clang/AST/TypeNodes.def"
1483    }
1484  }
1485
1486  // Emit the serialized record.
1487  Stream.EmitRecord(W.Code, Record);
1488
1489  // Flush any expressions that were written as part of this type.
1490  FlushStmts();
1491}
1492
1493//===----------------------------------------------------------------------===//
1494// Declaration Serialization
1495//===----------------------------------------------------------------------===//
1496
1497/// \brief Write the block containing all of the declaration IDs
1498/// lexically declared within the given DeclContext.
1499///
1500/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
1501/// bistream, or 0 if no block was written.
1502uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
1503                                                 DeclContext *DC) {
1504  if (DC->decls_empty())
1505    return 0;
1506
1507  uint64_t Offset = Stream.GetCurrentBitNo();
1508  RecordData Record;
1509  Record.push_back(DECL_CONTEXT_LEXICAL);
1510  llvm::SmallVector<KindDeclIDPair, 64> Decls;
1511  for (DeclContext::decl_iterator D = DC->decls_begin(), DEnd = DC->decls_end();
1512         D != DEnd; ++D)
1513    Decls.push_back(std::make_pair((*D)->getKind(), GetDeclRef(*D)));
1514
1515  ++NumLexicalDeclContexts;
1516  Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record,
1517                            reinterpret_cast<char*>(Decls.data()),
1518                            Decls.size() * sizeof(KindDeclIDPair));
1519  return Offset;
1520}
1521
1522void ASTWriter::WriteTypeDeclOffsets() {
1523  using namespace llvm;
1524  RecordData Record;
1525
1526  // Write the type offsets array
1527  BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1528  Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
1529  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
1530  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
1531  unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1532  Record.clear();
1533  Record.push_back(TYPE_OFFSET);
1534  Record.push_back(TypeOffsets.size());
1535  Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record,
1536                            (const char *)data(TypeOffsets),
1537                            TypeOffsets.size() * sizeof(TypeOffsets[0]));
1538
1539  // Write the declaration offsets array
1540  Abbrev = new BitCodeAbbrev();
1541  Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
1542  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
1543  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
1544  unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1545  Record.clear();
1546  Record.push_back(DECL_OFFSET);
1547  Record.push_back(DeclOffsets.size());
1548  Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record,
1549                            (const char *)data(DeclOffsets),
1550                            DeclOffsets.size() * sizeof(DeclOffsets[0]));
1551}
1552
1553//===----------------------------------------------------------------------===//
1554// Global Method Pool and Selector Serialization
1555//===----------------------------------------------------------------------===//
1556
1557namespace {
1558// Trait used for the on-disk hash table used in the method pool.
1559class ASTMethodPoolTrait {
1560  ASTWriter &Writer;
1561
1562public:
1563  typedef Selector key_type;
1564  typedef key_type key_type_ref;
1565
1566  struct data_type {
1567    SelectorID ID;
1568    ObjCMethodList Instance, Factory;
1569  };
1570  typedef const data_type& data_type_ref;
1571
1572  explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) { }
1573
1574  static unsigned ComputeHash(Selector Sel) {
1575    return serialization::ComputeHash(Sel);
1576  }
1577
1578  std::pair<unsigned,unsigned>
1579    EmitKeyDataLength(llvm::raw_ostream& Out, Selector Sel,
1580                      data_type_ref Methods) {
1581    unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
1582    clang::io::Emit16(Out, KeyLen);
1583    unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
1584    for (const ObjCMethodList *Method = &Methods.Instance; Method;
1585         Method = Method->Next)
1586      if (Method->Method)
1587        DataLen += 4;
1588    for (const ObjCMethodList *Method = &Methods.Factory; Method;
1589         Method = Method->Next)
1590      if (Method->Method)
1591        DataLen += 4;
1592    clang::io::Emit16(Out, DataLen);
1593    return std::make_pair(KeyLen, DataLen);
1594  }
1595
1596  void EmitKey(llvm::raw_ostream& Out, Selector Sel, unsigned) {
1597    uint64_t Start = Out.tell();
1598    assert((Start >> 32) == 0 && "Selector key offset too large");
1599    Writer.SetSelectorOffset(Sel, Start);
1600    unsigned N = Sel.getNumArgs();
1601    clang::io::Emit16(Out, N);
1602    if (N == 0)
1603      N = 1;
1604    for (unsigned I = 0; I != N; ++I)
1605      clang::io::Emit32(Out,
1606                    Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
1607  }
1608
1609  void EmitData(llvm::raw_ostream& Out, key_type_ref,
1610                data_type_ref Methods, unsigned DataLen) {
1611    uint64_t Start = Out.tell(); (void)Start;
1612    clang::io::Emit32(Out, Methods.ID);
1613    unsigned NumInstanceMethods = 0;
1614    for (const ObjCMethodList *Method = &Methods.Instance; Method;
1615         Method = Method->Next)
1616      if (Method->Method)
1617        ++NumInstanceMethods;
1618
1619    unsigned NumFactoryMethods = 0;
1620    for (const ObjCMethodList *Method = &Methods.Factory; Method;
1621         Method = Method->Next)
1622      if (Method->Method)
1623        ++NumFactoryMethods;
1624
1625    clang::io::Emit16(Out, NumInstanceMethods);
1626    clang::io::Emit16(Out, NumFactoryMethods);
1627    for (const ObjCMethodList *Method = &Methods.Instance; Method;
1628         Method = Method->Next)
1629      if (Method->Method)
1630        clang::io::Emit32(Out, Writer.getDeclID(Method->Method));
1631    for (const ObjCMethodList *Method = &Methods.Factory; Method;
1632         Method = Method->Next)
1633      if (Method->Method)
1634        clang::io::Emit32(Out, Writer.getDeclID(Method->Method));
1635
1636    assert(Out.tell() - Start == DataLen && "Data length is wrong");
1637  }
1638};
1639} // end anonymous namespace
1640
1641/// \brief Write ObjC data: selectors and the method pool.
1642///
1643/// The method pool contains both instance and factory methods, stored
1644/// in an on-disk hash table indexed by the selector. The hash table also
1645/// contains an empty entry for every other selector known to Sema.
1646void ASTWriter::WriteSelectors(Sema &SemaRef) {
1647  using namespace llvm;
1648
1649  // Do we have to do anything at all?
1650  if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
1651    return;
1652  unsigned NumTableEntries = 0;
1653  // Create and write out the blob that contains selectors and the method pool.
1654  {
1655    OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
1656    ASTMethodPoolTrait Trait(*this);
1657
1658    // Create the on-disk hash table representation. We walk through every
1659    // selector we've seen and look it up in the method pool.
1660    SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
1661    for (llvm::DenseMap<Selector, SelectorID>::iterator
1662             I = SelectorIDs.begin(), E = SelectorIDs.end();
1663         I != E; ++I) {
1664      Selector S = I->first;
1665      Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
1666      ASTMethodPoolTrait::data_type Data = {
1667        I->second,
1668        ObjCMethodList(),
1669        ObjCMethodList()
1670      };
1671      if (F != SemaRef.MethodPool.end()) {
1672        Data.Instance = F->second.first;
1673        Data.Factory = F->second.second;
1674      }
1675      // Only write this selector if it's not in an existing AST or something
1676      // changed.
1677      if (Chain && I->second < FirstSelectorID) {
1678        // Selector already exists. Did it change?
1679        bool changed = false;
1680        for (ObjCMethodList *M = &Data.Instance; !changed && M && M->Method;
1681             M = M->Next) {
1682          if (M->Method->getPCHLevel() == 0)
1683            changed = true;
1684        }
1685        for (ObjCMethodList *M = &Data.Factory; !changed && M && M->Method;
1686             M = M->Next) {
1687          if (M->Method->getPCHLevel() == 0)
1688            changed = true;
1689        }
1690        if (!changed)
1691          continue;
1692      } else if (Data.Instance.Method || Data.Factory.Method) {
1693        // A new method pool entry.
1694        ++NumTableEntries;
1695      }
1696      Generator.insert(S, Data, Trait);
1697    }
1698
1699    // Create the on-disk hash table in a buffer.
1700    llvm::SmallString<4096> MethodPool;
1701    uint32_t BucketOffset;
1702    {
1703      ASTMethodPoolTrait Trait(*this);
1704      llvm::raw_svector_ostream Out(MethodPool);
1705      // Make sure that no bucket is at offset 0
1706      clang::io::Emit32(Out, 0);
1707      BucketOffset = Generator.Emit(Out, Trait);
1708    }
1709
1710    // Create a blob abbreviation
1711    BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1712    Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
1713    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1714    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1715    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1716    unsigned MethodPoolAbbrev = Stream.EmitAbbrev(Abbrev);
1717
1718    // Write the method pool
1719    RecordData Record;
1720    Record.push_back(METHOD_POOL);
1721    Record.push_back(BucketOffset);
1722    Record.push_back(NumTableEntries);
1723    Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool.str());
1724
1725    // Create a blob abbreviation for the selector table offsets.
1726    Abbrev = new BitCodeAbbrev();
1727    Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
1728    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // index
1729    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1730    unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1731
1732    // Write the selector offsets table.
1733    Record.clear();
1734    Record.push_back(SELECTOR_OFFSETS);
1735    Record.push_back(SelectorOffsets.size());
1736    Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
1737                              (const char *)data(SelectorOffsets),
1738                              SelectorOffsets.size() * 4);
1739  }
1740}
1741
1742/// \brief Write the selectors referenced in @selector expression into AST file.
1743void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
1744  using namespace llvm;
1745  if (SemaRef.ReferencedSelectors.empty())
1746    return;
1747
1748  RecordData Record;
1749
1750  // Note: this writes out all references even for a dependent AST. But it is
1751  // very tricky to fix, and given that @selector shouldn't really appear in
1752  // headers, probably not worth it. It's not a correctness issue.
1753  for (DenseMap<Selector, SourceLocation>::iterator S =
1754       SemaRef.ReferencedSelectors.begin(),
1755       E = SemaRef.ReferencedSelectors.end(); S != E; ++S) {
1756    Selector Sel = (*S).first;
1757    SourceLocation Loc = (*S).second;
1758    AddSelectorRef(Sel, Record);
1759    AddSourceLocation(Loc, Record);
1760  }
1761  Stream.EmitRecord(REFERENCED_SELECTOR_POOL, Record);
1762}
1763
1764//===----------------------------------------------------------------------===//
1765// Identifier Table Serialization
1766//===----------------------------------------------------------------------===//
1767
1768namespace {
1769class ASTIdentifierTableTrait {
1770  ASTWriter &Writer;
1771  Preprocessor &PP;
1772
1773  /// \brief Determines whether this is an "interesting" identifier
1774  /// that needs a full IdentifierInfo structure written into the hash
1775  /// table.
1776  static bool isInterestingIdentifier(const IdentifierInfo *II) {
1777    return II->isPoisoned() ||
1778      II->isExtensionToken() ||
1779      II->hasMacroDefinition() ||
1780      II->getObjCOrBuiltinID() ||
1781      II->getFETokenInfo<void>();
1782  }
1783
1784public:
1785  typedef const IdentifierInfo* key_type;
1786  typedef key_type  key_type_ref;
1787
1788  typedef IdentID data_type;
1789  typedef data_type data_type_ref;
1790
1791  ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP)
1792    : Writer(Writer), PP(PP) { }
1793
1794  static unsigned ComputeHash(const IdentifierInfo* II) {
1795    return llvm::HashString(II->getName());
1796  }
1797
1798  std::pair<unsigned,unsigned>
1799    EmitKeyDataLength(llvm::raw_ostream& Out, const IdentifierInfo* II,
1800                      IdentID ID) {
1801    unsigned KeyLen = II->getLength() + 1;
1802    unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
1803    if (isInterestingIdentifier(II)) {
1804      DataLen += 2; // 2 bytes for builtin ID, flags
1805      if (II->hasMacroDefinition() &&
1806          !PP.getMacroInfo(const_cast<IdentifierInfo *>(II))->isBuiltinMacro())
1807        DataLen += 4;
1808      for (IdentifierResolver::iterator D = IdentifierResolver::begin(II),
1809                                     DEnd = IdentifierResolver::end();
1810           D != DEnd; ++D)
1811        DataLen += sizeof(DeclID);
1812    }
1813    clang::io::Emit16(Out, DataLen);
1814    // We emit the key length after the data length so that every
1815    // string is preceded by a 16-bit length. This matches the PTH
1816    // format for storing identifiers.
1817    clang::io::Emit16(Out, KeyLen);
1818    return std::make_pair(KeyLen, DataLen);
1819  }
1820
1821  void EmitKey(llvm::raw_ostream& Out, const IdentifierInfo* II,
1822               unsigned KeyLen) {
1823    // Record the location of the key data.  This is used when generating
1824    // the mapping from persistent IDs to strings.
1825    Writer.SetIdentifierOffset(II, Out.tell());
1826    Out.write(II->getNameStart(), KeyLen);
1827  }
1828
1829  void EmitData(llvm::raw_ostream& Out, const IdentifierInfo* II,
1830                IdentID ID, unsigned) {
1831    if (!isInterestingIdentifier(II)) {
1832      clang::io::Emit32(Out, ID << 1);
1833      return;
1834    }
1835
1836    clang::io::Emit32(Out, (ID << 1) | 0x01);
1837    uint32_t Bits = 0;
1838    bool hasMacroDefinition =
1839      II->hasMacroDefinition() &&
1840      !PP.getMacroInfo(const_cast<IdentifierInfo *>(II))->isBuiltinMacro();
1841    Bits = (uint32_t)II->getObjCOrBuiltinID();
1842    Bits = (Bits << 1) | unsigned(hasMacroDefinition);
1843    Bits = (Bits << 1) | unsigned(II->isExtensionToken());
1844    Bits = (Bits << 1) | unsigned(II->isPoisoned());
1845    Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
1846    Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
1847    clang::io::Emit16(Out, Bits);
1848
1849    if (hasMacroDefinition)
1850      clang::io::Emit32(Out, Writer.getMacroOffset(II));
1851
1852    // Emit the declaration IDs in reverse order, because the
1853    // IdentifierResolver provides the declarations as they would be
1854    // visible (e.g., the function "stat" would come before the struct
1855    // "stat"), but IdentifierResolver::AddDeclToIdentifierChain()
1856    // adds declarations to the end of the list (so we need to see the
1857    // struct "status" before the function "status").
1858    // Only emit declarations that aren't from a chained PCH, though.
1859    llvm::SmallVector<Decl *, 16> Decls(IdentifierResolver::begin(II),
1860                                        IdentifierResolver::end());
1861    for (llvm::SmallVector<Decl *, 16>::reverse_iterator D = Decls.rbegin(),
1862                                                      DEnd = Decls.rend();
1863         D != DEnd; ++D)
1864      clang::io::Emit32(Out, Writer.getDeclID(*D));
1865  }
1866};
1867} // end anonymous namespace
1868
1869/// \brief Write the identifier table into the AST file.
1870///
1871/// The identifier table consists of a blob containing string data
1872/// (the actual identifiers themselves) and a separate "offsets" index
1873/// that maps identifier IDs to locations within the blob.
1874void ASTWriter::WriteIdentifierTable(Preprocessor &PP) {
1875  using namespace llvm;
1876
1877  // Create and write out the blob that contains the identifier
1878  // strings.
1879  {
1880    OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
1881    ASTIdentifierTableTrait Trait(*this, PP);
1882
1883    // Look for any identifiers that were named while processing the
1884    // headers, but are otherwise not needed. We add these to the hash
1885    // table to enable checking of the predefines buffer in the case
1886    // where the user adds new macro definitions when building the AST
1887    // file.
1888    for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
1889                                IDEnd = PP.getIdentifierTable().end();
1890         ID != IDEnd; ++ID)
1891      getIdentifierRef(ID->second);
1892
1893    // Create the on-disk hash table representation. We only store offsets
1894    // for identifiers that appear here for the first time.
1895    IdentifierOffsets.resize(NextIdentID - FirstIdentID);
1896    for (llvm::DenseMap<const IdentifierInfo *, IdentID>::iterator
1897           ID = IdentifierIDs.begin(), IDEnd = IdentifierIDs.end();
1898         ID != IDEnd; ++ID) {
1899      assert(ID->first && "NULL identifier in identifier table");
1900      if (!Chain || !ID->first->isFromAST())
1901        Generator.insert(ID->first, ID->second, Trait);
1902    }
1903
1904    // Create the on-disk hash table in a buffer.
1905    llvm::SmallString<4096> IdentifierTable;
1906    uint32_t BucketOffset;
1907    {
1908      ASTIdentifierTableTrait Trait(*this, PP);
1909      llvm::raw_svector_ostream Out(IdentifierTable);
1910      // Make sure that no bucket is at offset 0
1911      clang::io::Emit32(Out, 0);
1912      BucketOffset = Generator.Emit(Out, Trait);
1913    }
1914
1915    // Create a blob abbreviation
1916    BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1917    Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
1918    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1919    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1920    unsigned IDTableAbbrev = Stream.EmitAbbrev(Abbrev);
1921
1922    // Write the identifier table
1923    RecordData Record;
1924    Record.push_back(IDENTIFIER_TABLE);
1925    Record.push_back(BucketOffset);
1926    Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable.str());
1927  }
1928
1929  // Write the offsets table for identifier IDs.
1930  BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1931  Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
1932  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
1933  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1934  unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1935
1936  RecordData Record;
1937  Record.push_back(IDENTIFIER_OFFSET);
1938  Record.push_back(IdentifierOffsets.size());
1939  Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
1940                            (const char *)data(IdentifierOffsets),
1941                            IdentifierOffsets.size() * sizeof(uint32_t));
1942}
1943
1944//===----------------------------------------------------------------------===//
1945// DeclContext's Name Lookup Table Serialization
1946//===----------------------------------------------------------------------===//
1947
1948namespace {
1949// Trait used for the on-disk hash table used in the method pool.
1950class ASTDeclContextNameLookupTrait {
1951  ASTWriter &Writer;
1952
1953public:
1954  typedef DeclarationName key_type;
1955  typedef key_type key_type_ref;
1956
1957  typedef DeclContext::lookup_result data_type;
1958  typedef const data_type& data_type_ref;
1959
1960  explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) { }
1961
1962  unsigned ComputeHash(DeclarationName Name) {
1963    llvm::FoldingSetNodeID ID;
1964    ID.AddInteger(Name.getNameKind());
1965
1966    switch (Name.getNameKind()) {
1967    case DeclarationName::Identifier:
1968      ID.AddString(Name.getAsIdentifierInfo()->getName());
1969      break;
1970    case DeclarationName::ObjCZeroArgSelector:
1971    case DeclarationName::ObjCOneArgSelector:
1972    case DeclarationName::ObjCMultiArgSelector:
1973      ID.AddInteger(serialization::ComputeHash(Name.getObjCSelector()));
1974      break;
1975    case DeclarationName::CXXConstructorName:
1976    case DeclarationName::CXXDestructorName:
1977    case DeclarationName::CXXConversionFunctionName:
1978      ID.AddInteger(Writer.GetOrCreateTypeID(Name.getCXXNameType()));
1979      break;
1980    case DeclarationName::CXXOperatorName:
1981      ID.AddInteger(Name.getCXXOverloadedOperator());
1982      break;
1983    case DeclarationName::CXXLiteralOperatorName:
1984      ID.AddString(Name.getCXXLiteralIdentifier()->getName());
1985    case DeclarationName::CXXUsingDirective:
1986      break;
1987    }
1988
1989    return ID.ComputeHash();
1990  }
1991
1992  std::pair<unsigned,unsigned>
1993    EmitKeyDataLength(llvm::raw_ostream& Out, DeclarationName Name,
1994                      data_type_ref Lookup) {
1995    unsigned KeyLen = 1;
1996    switch (Name.getNameKind()) {
1997    case DeclarationName::Identifier:
1998    case DeclarationName::ObjCZeroArgSelector:
1999    case DeclarationName::ObjCOneArgSelector:
2000    case DeclarationName::ObjCMultiArgSelector:
2001    case DeclarationName::CXXConstructorName:
2002    case DeclarationName::CXXDestructorName:
2003    case DeclarationName::CXXConversionFunctionName:
2004    case DeclarationName::CXXLiteralOperatorName:
2005      KeyLen += 4;
2006      break;
2007    case DeclarationName::CXXOperatorName:
2008      KeyLen += 1;
2009      break;
2010    case DeclarationName::CXXUsingDirective:
2011      break;
2012    }
2013    clang::io::Emit16(Out, KeyLen);
2014
2015    // 2 bytes for num of decls and 4 for each DeclID.
2016    unsigned DataLen = 2 + 4 * (Lookup.second - Lookup.first);
2017    clang::io::Emit16(Out, DataLen);
2018
2019    return std::make_pair(KeyLen, DataLen);
2020  }
2021
2022  void EmitKey(llvm::raw_ostream& Out, DeclarationName Name, unsigned) {
2023    using namespace clang::io;
2024
2025    assert(Name.getNameKind() < 0x100 && "Invalid name kind ?");
2026    Emit8(Out, Name.getNameKind());
2027    switch (Name.getNameKind()) {
2028    case DeclarationName::Identifier:
2029      Emit32(Out, Writer.getIdentifierRef(Name.getAsIdentifierInfo()));
2030      break;
2031    case DeclarationName::ObjCZeroArgSelector:
2032    case DeclarationName::ObjCOneArgSelector:
2033    case DeclarationName::ObjCMultiArgSelector:
2034      Emit32(Out, Writer.getSelectorRef(Name.getObjCSelector()));
2035      break;
2036    case DeclarationName::CXXConstructorName:
2037    case DeclarationName::CXXDestructorName:
2038    case DeclarationName::CXXConversionFunctionName:
2039      Emit32(Out, Writer.getTypeID(Name.getCXXNameType()));
2040      break;
2041    case DeclarationName::CXXOperatorName:
2042      assert(Name.getCXXOverloadedOperator() < 0x100 && "Invalid operator ?");
2043      Emit8(Out, Name.getCXXOverloadedOperator());
2044      break;
2045    case DeclarationName::CXXLiteralOperatorName:
2046      Emit32(Out, Writer.getIdentifierRef(Name.getCXXLiteralIdentifier()));
2047      break;
2048    case DeclarationName::CXXUsingDirective:
2049      break;
2050    }
2051  }
2052
2053  void EmitData(llvm::raw_ostream& Out, key_type_ref,
2054                data_type Lookup, unsigned DataLen) {
2055    uint64_t Start = Out.tell(); (void)Start;
2056    clang::io::Emit16(Out, Lookup.second - Lookup.first);
2057    for (; Lookup.first != Lookup.second; ++Lookup.first)
2058      clang::io::Emit32(Out, Writer.GetDeclRef(*Lookup.first));
2059
2060    assert(Out.tell() - Start == DataLen && "Data length is wrong");
2061  }
2062};
2063} // end anonymous namespace
2064
2065/// \brief Write the block containing all of the declaration IDs
2066/// visible from the given DeclContext.
2067///
2068/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
2069/// bitstream, or 0 if no block was written.
2070uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
2071                                                 DeclContext *DC) {
2072  if (DC->getPrimaryContext() != DC)
2073    return 0;
2074
2075  // Since there is no name lookup into functions or methods, don't bother to
2076  // build a visible-declarations table for these entities.
2077  if (DC->isFunctionOrMethod())
2078    return 0;
2079
2080  // If not in C++, we perform name lookup for the translation unit via the
2081  // IdentifierInfo chains, don't bother to build a visible-declarations table.
2082  // FIXME: In C++ we need the visible declarations in order to "see" the
2083  // friend declarations, is there a way to do this without writing the table ?
2084  if (DC->isTranslationUnit() && !Context.getLangOptions().CPlusPlus)
2085    return 0;
2086
2087  // Force the DeclContext to build a its name-lookup table.
2088  if (DC->hasExternalVisibleStorage())
2089    DC->MaterializeVisibleDeclsFromExternalStorage();
2090  else
2091    DC->lookup(DeclarationName());
2092
2093  // Serialize the contents of the mapping used for lookup. Note that,
2094  // although we have two very different code paths, the serialized
2095  // representation is the same for both cases: a declaration name,
2096  // followed by a size, followed by references to the visible
2097  // declarations that have that name.
2098  uint64_t Offset = Stream.GetCurrentBitNo();
2099  StoredDeclsMap *Map = static_cast<StoredDeclsMap*>(DC->getLookupPtr());
2100  if (!Map || Map->empty())
2101    return 0;
2102
2103  OnDiskChainedHashTableGenerator<ASTDeclContextNameLookupTrait> Generator;
2104  ASTDeclContextNameLookupTrait Trait(*this);
2105
2106  // Create the on-disk hash table representation.
2107  for (StoredDeclsMap::iterator D = Map->begin(), DEnd = Map->end();
2108       D != DEnd; ++D) {
2109    DeclarationName Name = D->first;
2110    DeclContext::lookup_result Result = D->second.getLookupResult();
2111    Generator.insert(Name, Result, Trait);
2112  }
2113
2114  // Create the on-disk hash table in a buffer.
2115  llvm::SmallString<4096> LookupTable;
2116  uint32_t BucketOffset;
2117  {
2118    llvm::raw_svector_ostream Out(LookupTable);
2119    // Make sure that no bucket is at offset 0
2120    clang::io::Emit32(Out, 0);
2121    BucketOffset = Generator.Emit(Out, Trait);
2122  }
2123
2124  // Write the lookup table
2125  RecordData Record;
2126  Record.push_back(DECL_CONTEXT_VISIBLE);
2127  Record.push_back(BucketOffset);
2128  Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
2129                            LookupTable.str());
2130
2131  Stream.EmitRecord(DECL_CONTEXT_VISIBLE, Record);
2132  ++NumVisibleDeclContexts;
2133  return Offset;
2134}
2135
2136/// \brief Write an UPDATE_VISIBLE block for the given context.
2137///
2138/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
2139/// DeclContext in a dependent AST file. As such, they only exist for the TU
2140/// (in C++) and for namespaces.
2141void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
2142  assert((DC->isTranslationUnit() || DC->isNamespace()) &&
2143         "Only TU and namespaces should have visible decl updates.");
2144
2145  // Make the context build its lookup table, but don't make it load external
2146  // decls.
2147  DC->lookup(DeclarationName());
2148
2149  StoredDeclsMap *Map = static_cast<StoredDeclsMap*>(DC->getLookupPtr());
2150  if (!Map || Map->empty())
2151    return;
2152
2153  OnDiskChainedHashTableGenerator<ASTDeclContextNameLookupTrait> Generator;
2154  ASTDeclContextNameLookupTrait Trait(*this);
2155
2156  // Create the hash table.
2157  for (StoredDeclsMap::iterator D = Map->begin(), DEnd = Map->end();
2158       D != DEnd; ++D) {
2159    DeclarationName Name = D->first;
2160    DeclContext::lookup_result Result = D->second.getLookupResult();
2161    // For any name that appears in this table, the results are complete, i.e.
2162    // they overwrite results from previous PCHs. Merging is always a mess.
2163    Generator.insert(Name, Result, Trait);
2164  }
2165
2166  // Create the on-disk hash table in a buffer.
2167  llvm::SmallString<4096> LookupTable;
2168  uint32_t BucketOffset;
2169  {
2170    llvm::raw_svector_ostream Out(LookupTable);
2171    // Make sure that no bucket is at offset 0
2172    clang::io::Emit32(Out, 0);
2173    BucketOffset = Generator.Emit(Out, Trait);
2174  }
2175
2176  // Write the lookup table
2177  RecordData Record;
2178  Record.push_back(UPDATE_VISIBLE);
2179  Record.push_back(getDeclID(cast<Decl>(DC)));
2180  Record.push_back(BucketOffset);
2181  Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable.str());
2182}
2183
2184/// \brief Write ADDITIONAL_TEMPLATE_SPECIALIZATIONS blocks for all templates
2185/// that have new specializations in the current AST file.
2186void ASTWriter::WriteAdditionalTemplateSpecializations() {
2187  RecordData Record;
2188  for (AdditionalTemplateSpecializationsMap::iterator
2189           I = AdditionalTemplateSpecializations.begin(),
2190           E = AdditionalTemplateSpecializations.end();
2191       I != E; ++I) {
2192    Record.clear();
2193    Record.push_back(I->first);
2194    Record.insert(Record.end(), I->second.begin(), I->second.end());
2195    Stream.EmitRecord(ADDITIONAL_TEMPLATE_SPECIALIZATIONS, Record);
2196  }
2197}
2198
2199//===----------------------------------------------------------------------===//
2200// General Serialization Routines
2201//===----------------------------------------------------------------------===//
2202
2203/// \brief Write a record containing the given attributes.
2204void ASTWriter::WriteAttributes(const AttrVec &Attrs, RecordDataImpl &Record) {
2205  Record.push_back(Attrs.size());
2206  for (AttrVec::const_iterator i = Attrs.begin(), e = Attrs.end(); i != e; ++i){
2207    const Attr * A = *i;
2208    Record.push_back(A->getKind()); // FIXME: stable encoding, target attrs
2209    AddSourceLocation(A->getLocation(), Record);
2210    Record.push_back(A->isInherited());
2211
2212#include "clang/Serialization/AttrPCHWrite.inc"
2213
2214  }
2215}
2216
2217void ASTWriter::AddString(llvm::StringRef Str, RecordDataImpl &Record) {
2218  Record.push_back(Str.size());
2219  Record.insert(Record.end(), Str.begin(), Str.end());
2220}
2221
2222/// \brief Note that the identifier II occurs at the given offset
2223/// within the identifier table.
2224void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
2225  IdentID ID = IdentifierIDs[II];
2226  // Only store offsets new to this AST file. Other identifier names are looked
2227  // up earlier in the chain and thus don't need an offset.
2228  if (ID >= FirstIdentID)
2229    IdentifierOffsets[ID - FirstIdentID] = Offset;
2230}
2231
2232/// \brief Note that the selector Sel occurs at the given offset
2233/// within the method pool/selector table.
2234void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
2235  unsigned ID = SelectorIDs[Sel];
2236  assert(ID && "Unknown selector");
2237  // Don't record offsets for selectors that are also available in a different
2238  // file.
2239  if (ID < FirstSelectorID)
2240    return;
2241  SelectorOffsets[ID - FirstSelectorID] = Offset;
2242}
2243
2244ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream)
2245  : Stream(Stream), Chain(0), FirstDeclID(1), NextDeclID(FirstDeclID),
2246    FirstTypeID(NUM_PREDEF_TYPE_IDS), NextTypeID(FirstTypeID),
2247    FirstIdentID(1), NextIdentID(FirstIdentID), FirstSelectorID(1),
2248    NextSelectorID(FirstSelectorID), FirstMacroID(1), NextMacroID(FirstMacroID),
2249    CollectedStmts(&StmtsToEmit),
2250    NumStatements(0), NumMacros(0), NumLexicalDeclContexts(0),
2251    NumVisibleDeclContexts(0) {
2252}
2253
2254void ASTWriter::WriteAST(Sema &SemaRef, MemorizeStatCalls *StatCalls,
2255                         const char *isysroot) {
2256  // Emit the file header.
2257  Stream.Emit((unsigned)'C', 8);
2258  Stream.Emit((unsigned)'P', 8);
2259  Stream.Emit((unsigned)'C', 8);
2260  Stream.Emit((unsigned)'H', 8);
2261
2262  WriteBlockInfoBlock();
2263
2264  if (Chain)
2265    WriteASTChain(SemaRef, StatCalls, isysroot);
2266  else
2267    WriteASTCore(SemaRef, StatCalls, isysroot);
2268}
2269
2270void ASTWriter::WriteASTCore(Sema &SemaRef, MemorizeStatCalls *StatCalls,
2271                             const char *isysroot) {
2272  using namespace llvm;
2273
2274  ASTContext &Context = SemaRef.Context;
2275  Preprocessor &PP = SemaRef.PP;
2276
2277  // The translation unit is the first declaration we'll emit.
2278  DeclIDs[Context.getTranslationUnitDecl()] = 1;
2279  ++NextDeclID;
2280  DeclTypesToEmit.push(Context.getTranslationUnitDecl());
2281
2282  // Make sure that we emit IdentifierInfos (and any attached
2283  // declarations) for builtins.
2284  {
2285    IdentifierTable &Table = PP.getIdentifierTable();
2286    llvm::SmallVector<const char *, 32> BuiltinNames;
2287    Context.BuiltinInfo.GetBuiltinNames(BuiltinNames,
2288                                        Context.getLangOptions().NoBuiltin);
2289    for (unsigned I = 0, N = BuiltinNames.size(); I != N; ++I)
2290      getIdentifierRef(&Table.get(BuiltinNames[I]));
2291  }
2292
2293  // Build a record containing all of the tentative definitions in this file, in
2294  // TentativeDefinitions order.  Generally, this record will be empty for
2295  // headers.
2296  RecordData TentativeDefinitions;
2297  for (unsigned i = 0, e = SemaRef.TentativeDefinitions.size(); i != e; ++i) {
2298    AddDeclRef(SemaRef.TentativeDefinitions[i], TentativeDefinitions);
2299  }
2300
2301  // Build a record containing all of the file scoped decls in this file.
2302  RecordData UnusedFileScopedDecls;
2303  for (unsigned i=0, e = SemaRef.UnusedFileScopedDecls.size(); i !=e; ++i)
2304    AddDeclRef(SemaRef.UnusedFileScopedDecls[i], UnusedFileScopedDecls);
2305
2306  RecordData WeakUndeclaredIdentifiers;
2307  if (!SemaRef.WeakUndeclaredIdentifiers.empty()) {
2308    WeakUndeclaredIdentifiers.push_back(
2309                                      SemaRef.WeakUndeclaredIdentifiers.size());
2310    for (llvm::DenseMap<IdentifierInfo*,Sema::WeakInfo>::iterator
2311         I = SemaRef.WeakUndeclaredIdentifiers.begin(),
2312         E = SemaRef.WeakUndeclaredIdentifiers.end(); I != E; ++I) {
2313      AddIdentifierRef(I->first, WeakUndeclaredIdentifiers);
2314      AddIdentifierRef(I->second.getAlias(), WeakUndeclaredIdentifiers);
2315      AddSourceLocation(I->second.getLocation(), WeakUndeclaredIdentifiers);
2316      WeakUndeclaredIdentifiers.push_back(I->second.getUsed());
2317    }
2318  }
2319
2320  // Build a record containing all of the locally-scoped external
2321  // declarations in this header file. Generally, this record will be
2322  // empty.
2323  RecordData LocallyScopedExternalDecls;
2324  // FIXME: This is filling in the AST file in densemap order which is
2325  // nondeterminstic!
2326  for (llvm::DenseMap<DeclarationName, NamedDecl *>::iterator
2327         TD = SemaRef.LocallyScopedExternalDecls.begin(),
2328         TDEnd = SemaRef.LocallyScopedExternalDecls.end();
2329       TD != TDEnd; ++TD)
2330    AddDeclRef(TD->second, LocallyScopedExternalDecls);
2331
2332  // Build a record containing all of the ext_vector declarations.
2333  RecordData ExtVectorDecls;
2334  for (unsigned I = 0, N = SemaRef.ExtVectorDecls.size(); I != N; ++I)
2335    AddDeclRef(SemaRef.ExtVectorDecls[I], ExtVectorDecls);
2336
2337  // Build a record containing all of the VTable uses information.
2338  RecordData VTableUses;
2339  if (!SemaRef.VTableUses.empty()) {
2340    VTableUses.push_back(SemaRef.VTableUses.size());
2341    for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
2342      AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
2343      AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
2344      VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
2345    }
2346  }
2347
2348  // Build a record containing all of dynamic classes declarations.
2349  RecordData DynamicClasses;
2350  for (unsigned I = 0, N = SemaRef.DynamicClasses.size(); I != N; ++I)
2351    AddDeclRef(SemaRef.DynamicClasses[I], DynamicClasses);
2352
2353  // Build a record containing all of pending implicit instantiations.
2354  RecordData PendingInstantiations;
2355  for (std::deque<Sema::PendingImplicitInstantiation>::iterator
2356         I = SemaRef.PendingInstantiations.begin(),
2357         N = SemaRef.PendingInstantiations.end(); I != N; ++I) {
2358    AddDeclRef(I->first, PendingInstantiations);
2359    AddSourceLocation(I->second, PendingInstantiations);
2360  }
2361  assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
2362         "There are local ones at end of translation unit!");
2363
2364  // Build a record containing some declaration references.
2365  RecordData SemaDeclRefs;
2366  if (SemaRef.StdNamespace || SemaRef.StdBadAlloc) {
2367    AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
2368    AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
2369  }
2370
2371  // Write the remaining AST contents.
2372  RecordData Record;
2373  Stream.EnterSubblock(AST_BLOCK_ID, 5);
2374  WriteMetadata(Context, isysroot);
2375  WriteLanguageOptions(Context.getLangOptions());
2376  if (StatCalls && !isysroot)
2377    WriteStatCache(*StatCalls);
2378  WriteSourceManagerBlock(Context.getSourceManager(), PP, isysroot);
2379  // Write the record of special types.
2380  Record.clear();
2381
2382  AddTypeRef(Context.getBuiltinVaListType(), Record);
2383  AddTypeRef(Context.getObjCIdType(), Record);
2384  AddTypeRef(Context.getObjCSelType(), Record);
2385  AddTypeRef(Context.getObjCProtoType(), Record);
2386  AddTypeRef(Context.getObjCClassType(), Record);
2387  AddTypeRef(Context.getRawCFConstantStringType(), Record);
2388  AddTypeRef(Context.getRawObjCFastEnumerationStateType(), Record);
2389  AddTypeRef(Context.getFILEType(), Record);
2390  AddTypeRef(Context.getjmp_bufType(), Record);
2391  AddTypeRef(Context.getsigjmp_bufType(), Record);
2392  AddTypeRef(Context.ObjCIdRedefinitionType, Record);
2393  AddTypeRef(Context.ObjCClassRedefinitionType, Record);
2394  AddTypeRef(Context.getRawBlockdescriptorType(), Record);
2395  AddTypeRef(Context.getRawBlockdescriptorExtendedType(), Record);
2396  AddTypeRef(Context.ObjCSelRedefinitionType, Record);
2397  AddTypeRef(Context.getRawNSConstantStringType(), Record);
2398  Record.push_back(Context.isInt128Installed());
2399  Stream.EmitRecord(SPECIAL_TYPES, Record);
2400
2401  // Keep writing types and declarations until all types and
2402  // declarations have been written.
2403  Stream.EnterSubblock(DECLTYPES_BLOCK_ID, 3);
2404  WriteDeclsBlockAbbrevs();
2405  while (!DeclTypesToEmit.empty()) {
2406    DeclOrType DOT = DeclTypesToEmit.front();
2407    DeclTypesToEmit.pop();
2408    if (DOT.isType())
2409      WriteType(DOT.getType());
2410    else
2411      WriteDecl(Context, DOT.getDecl());
2412  }
2413  Stream.ExitBlock();
2414
2415  WritePreprocessor(PP);
2416  WriteSelectors(SemaRef);
2417  WriteReferencedSelectorsPool(SemaRef);
2418  WriteIdentifierTable(PP);
2419
2420  WriteTypeDeclOffsets();
2421
2422  // Write the record containing external, unnamed definitions.
2423  if (!ExternalDefinitions.empty())
2424    Stream.EmitRecord(EXTERNAL_DEFINITIONS, ExternalDefinitions);
2425
2426  // Write the record containing tentative definitions.
2427  if (!TentativeDefinitions.empty())
2428    Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
2429
2430  // Write the record containing unused file scoped decls.
2431  if (!UnusedFileScopedDecls.empty())
2432    Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
2433
2434  // Write the record containing weak undeclared identifiers.
2435  if (!WeakUndeclaredIdentifiers.empty())
2436    Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
2437                      WeakUndeclaredIdentifiers);
2438
2439  // Write the record containing locally-scoped external definitions.
2440  if (!LocallyScopedExternalDecls.empty())
2441    Stream.EmitRecord(LOCALLY_SCOPED_EXTERNAL_DECLS,
2442                      LocallyScopedExternalDecls);
2443
2444  // Write the record containing ext_vector type names.
2445  if (!ExtVectorDecls.empty())
2446    Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
2447
2448  // Write the record containing VTable uses information.
2449  if (!VTableUses.empty())
2450    Stream.EmitRecord(VTABLE_USES, VTableUses);
2451
2452  // Write the record containing dynamic classes declarations.
2453  if (!DynamicClasses.empty())
2454    Stream.EmitRecord(DYNAMIC_CLASSES, DynamicClasses);
2455
2456  // Write the record containing pending implicit instantiations.
2457  if (!PendingInstantiations.empty())
2458    Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
2459
2460  // Write the record containing declaration references of Sema.
2461  if (!SemaDeclRefs.empty())
2462    Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
2463
2464  // Some simple statistics
2465  Record.clear();
2466  Record.push_back(NumStatements);
2467  Record.push_back(NumMacros);
2468  Record.push_back(NumLexicalDeclContexts);
2469  Record.push_back(NumVisibleDeclContexts);
2470  Stream.EmitRecord(STATISTICS, Record);
2471  Stream.ExitBlock();
2472}
2473
2474void ASTWriter::WriteASTChain(Sema &SemaRef, MemorizeStatCalls *StatCalls,
2475                              const char *isysroot) {
2476  using namespace llvm;
2477
2478  ASTContext &Context = SemaRef.Context;
2479  Preprocessor &PP = SemaRef.PP;
2480
2481  RecordData Record;
2482  Stream.EnterSubblock(AST_BLOCK_ID, 5);
2483  WriteMetadata(Context, isysroot);
2484  if (StatCalls && !isysroot)
2485    WriteStatCache(*StatCalls);
2486  // FIXME: Source manager block should only write new stuff, which could be
2487  // done by tracking the largest ID in the chain
2488  WriteSourceManagerBlock(Context.getSourceManager(), PP, isysroot);
2489
2490  // The special types are in the chained PCH.
2491
2492  // We don't start with the translation unit, but with its decls that
2493  // don't come from the chained PCH.
2494  const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
2495  llvm::SmallVector<KindDeclIDPair, 64> NewGlobalDecls;
2496  for (DeclContext::decl_iterator I = TU->noload_decls_begin(),
2497                                  E = TU->noload_decls_end();
2498       I != E; ++I) {
2499    if ((*I)->getPCHLevel() == 0)
2500      NewGlobalDecls.push_back(std::make_pair((*I)->getKind(), GetDeclRef(*I)));
2501    else if ((*I)->isChangedSinceDeserialization())
2502      (void)GetDeclRef(*I); // Make sure it's written, but don't record it.
2503  }
2504  // We also need to write a lexical updates block for the TU.
2505  llvm::BitCodeAbbrev *Abv = new llvm::BitCodeAbbrev();
2506  Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
2507  Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
2508  unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(Abv);
2509  Record.clear();
2510  Record.push_back(TU_UPDATE_LEXICAL);
2511  Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
2512                          reinterpret_cast<const char*>(NewGlobalDecls.data()),
2513                          NewGlobalDecls.size() * sizeof(KindDeclIDPair));
2514  // And in C++, a visible updates block for the TU.
2515  if (Context.getLangOptions().CPlusPlus) {
2516    Abv = new llvm::BitCodeAbbrev();
2517    Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
2518    Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
2519    Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed, 32));
2520    Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
2521    UpdateVisibleAbbrev = Stream.EmitAbbrev(Abv);
2522    WriteDeclContextVisibleUpdate(TU);
2523  }
2524
2525  // Build a record containing all of the new tentative definitions in this
2526  // file, in TentativeDefinitions order.
2527  RecordData TentativeDefinitions;
2528  for (unsigned i = 0, e = SemaRef.TentativeDefinitions.size(); i != e; ++i) {
2529    if (SemaRef.TentativeDefinitions[i]->getPCHLevel() == 0)
2530      AddDeclRef(SemaRef.TentativeDefinitions[i], TentativeDefinitions);
2531  }
2532
2533  // Build a record containing all of the file scoped decls in this file.
2534  RecordData UnusedFileScopedDecls;
2535  for (unsigned i=0, e = SemaRef.UnusedFileScopedDecls.size(); i !=e; ++i) {
2536    if (SemaRef.UnusedFileScopedDecls[i]->getPCHLevel() == 0)
2537      AddDeclRef(SemaRef.UnusedFileScopedDecls[i], UnusedFileScopedDecls);
2538  }
2539
2540  // We write the entire table, overwriting the tables from the chain.
2541  RecordData WeakUndeclaredIdentifiers;
2542  if (!SemaRef.WeakUndeclaredIdentifiers.empty()) {
2543    WeakUndeclaredIdentifiers.push_back(
2544                                      SemaRef.WeakUndeclaredIdentifiers.size());
2545    for (llvm::DenseMap<IdentifierInfo*,Sema::WeakInfo>::iterator
2546         I = SemaRef.WeakUndeclaredIdentifiers.begin(),
2547         E = SemaRef.WeakUndeclaredIdentifiers.end(); I != E; ++I) {
2548      AddIdentifierRef(I->first, WeakUndeclaredIdentifiers);
2549      AddIdentifierRef(I->second.getAlias(), WeakUndeclaredIdentifiers);
2550      AddSourceLocation(I->second.getLocation(), WeakUndeclaredIdentifiers);
2551      WeakUndeclaredIdentifiers.push_back(I->second.getUsed());
2552    }
2553  }
2554
2555  // Build a record containing all of the locally-scoped external
2556  // declarations in this header file. Generally, this record will be
2557  // empty.
2558  RecordData LocallyScopedExternalDecls;
2559  // FIXME: This is filling in the AST file in densemap order which is
2560  // nondeterminstic!
2561  for (llvm::DenseMap<DeclarationName, NamedDecl *>::iterator
2562         TD = SemaRef.LocallyScopedExternalDecls.begin(),
2563         TDEnd = SemaRef.LocallyScopedExternalDecls.end();
2564       TD != TDEnd; ++TD) {
2565    if (TD->second->getPCHLevel() == 0)
2566      AddDeclRef(TD->second, LocallyScopedExternalDecls);
2567  }
2568
2569  // Build a record containing all of the ext_vector declarations.
2570  RecordData ExtVectorDecls;
2571  for (unsigned I = 0, N = SemaRef.ExtVectorDecls.size(); I != N; ++I) {
2572    if (SemaRef.ExtVectorDecls[I]->getPCHLevel() == 0)
2573      AddDeclRef(SemaRef.ExtVectorDecls[I], ExtVectorDecls);
2574  }
2575
2576  // Build a record containing all of the VTable uses information.
2577  // We write everything here, because it's too hard to determine whether
2578  // a use is new to this part.
2579  RecordData VTableUses;
2580  if (!SemaRef.VTableUses.empty()) {
2581    VTableUses.push_back(SemaRef.VTableUses.size());
2582    for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
2583      AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
2584      AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
2585      VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
2586    }
2587  }
2588
2589  // Build a record containing all of dynamic classes declarations.
2590  RecordData DynamicClasses;
2591  for (unsigned I = 0, N = SemaRef.DynamicClasses.size(); I != N; ++I)
2592    if (SemaRef.DynamicClasses[I]->getPCHLevel() == 0)
2593      AddDeclRef(SemaRef.DynamicClasses[I], DynamicClasses);
2594
2595  // Build a record containing all of pending implicit instantiations.
2596  RecordData PendingInstantiations;
2597  for (std::deque<Sema::PendingImplicitInstantiation>::iterator
2598         I = SemaRef.PendingInstantiations.begin(),
2599         N = SemaRef.PendingInstantiations.end(); I != N; ++I) {
2600    if (I->first->getPCHLevel() == 0) {
2601      AddDeclRef(I->first, PendingInstantiations);
2602      AddSourceLocation(I->second, PendingInstantiations);
2603    }
2604  }
2605  assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
2606         "There are local ones at end of translation unit!");
2607
2608  // Build a record containing some declaration references.
2609  // It's not worth the effort to avoid duplication here.
2610  RecordData SemaDeclRefs;
2611  if (SemaRef.StdNamespace || SemaRef.StdBadAlloc) {
2612    AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
2613    AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
2614  }
2615
2616  Stream.EnterSubblock(DECLTYPES_BLOCK_ID, 3);
2617  WriteDeclsBlockAbbrevs();
2618  while (!DeclTypesToEmit.empty()) {
2619    DeclOrType DOT = DeclTypesToEmit.front();
2620    DeclTypesToEmit.pop();
2621    if (DOT.isType())
2622      WriteType(DOT.getType());
2623    else
2624      WriteDecl(Context, DOT.getDecl());
2625  }
2626  Stream.ExitBlock();
2627
2628  WritePreprocessor(PP);
2629  WriteSelectors(SemaRef);
2630  WriteReferencedSelectorsPool(SemaRef);
2631  WriteIdentifierTable(PP);
2632  WriteTypeDeclOffsets();
2633
2634  /// Build a record containing first declarations from a chained PCH and the
2635  /// most recent declarations in this AST that they point to.
2636  RecordData FirstLatestDeclIDs;
2637  for (FirstLatestDeclMap::iterator
2638        I = FirstLatestDecls.begin(), E = FirstLatestDecls.end(); I != E; ++I) {
2639    assert(I->first->getPCHLevel() > I->second->getPCHLevel() &&
2640           "Expected first & second to be in different PCHs");
2641    AddDeclRef(I->first, FirstLatestDeclIDs);
2642    AddDeclRef(I->second, FirstLatestDeclIDs);
2643  }
2644  if (!FirstLatestDeclIDs.empty())
2645    Stream.EmitRecord(REDECLS_UPDATE_LATEST, FirstLatestDeclIDs);
2646
2647  // Write the record containing external, unnamed definitions.
2648  if (!ExternalDefinitions.empty())
2649    Stream.EmitRecord(EXTERNAL_DEFINITIONS, ExternalDefinitions);
2650
2651  // Write the record containing tentative definitions.
2652  if (!TentativeDefinitions.empty())
2653    Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
2654
2655  // Write the record containing unused file scoped decls.
2656  if (!UnusedFileScopedDecls.empty())
2657    Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
2658
2659  // Write the record containing weak undeclared identifiers.
2660  if (!WeakUndeclaredIdentifiers.empty())
2661    Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
2662                      WeakUndeclaredIdentifiers);
2663
2664  // Write the record containing locally-scoped external definitions.
2665  if (!LocallyScopedExternalDecls.empty())
2666    Stream.EmitRecord(LOCALLY_SCOPED_EXTERNAL_DECLS,
2667                      LocallyScopedExternalDecls);
2668
2669  // Write the record containing ext_vector type names.
2670  if (!ExtVectorDecls.empty())
2671    Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
2672
2673  // Write the record containing VTable uses information.
2674  if (!VTableUses.empty())
2675    Stream.EmitRecord(VTABLE_USES, VTableUses);
2676
2677  // Write the record containing dynamic classes declarations.
2678  if (!DynamicClasses.empty())
2679    Stream.EmitRecord(DYNAMIC_CLASSES, DynamicClasses);
2680
2681  // Write the record containing pending implicit instantiations.
2682  if (!PendingInstantiations.empty())
2683    Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
2684
2685  // Write the record containing declaration references of Sema.
2686  if (!SemaDeclRefs.empty())
2687    Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
2688
2689  // Write the updates to C++ namespaces.
2690  for (llvm::SmallPtrSet<const NamespaceDecl *, 16>::iterator
2691           I = UpdatedNamespaces.begin(),
2692           E = UpdatedNamespaces.end();
2693         I != E; ++I)
2694    WriteDeclContextVisibleUpdate(*I);
2695
2696  // Write the updates to C++ template specialization lists.
2697  if (!AdditionalTemplateSpecializations.empty())
2698    WriteAdditionalTemplateSpecializations();
2699
2700  WriteDeclUpdatesBlocks();
2701
2702  Record.clear();
2703  Record.push_back(NumStatements);
2704  Record.push_back(NumMacros);
2705  Record.push_back(NumLexicalDeclContexts);
2706  Record.push_back(NumVisibleDeclContexts);
2707  WriteDeclReplacementsBlock();
2708  Stream.EmitRecord(STATISTICS, Record);
2709  Stream.ExitBlock();
2710}
2711
2712void ASTWriter::WriteDeclUpdatesBlocks() {
2713  if (DeclUpdates.empty())
2714    return;
2715
2716  RecordData OffsetsRecord;
2717  Stream.EnterSubblock(DECL_UPDATES_BLOCK_ID, 3);
2718  for (DeclUpdateMap::iterator
2719         I = DeclUpdates.begin(), E = DeclUpdates.end(); I != E; ++I) {
2720    const Decl *D = I->first;
2721    UpdateRecord &URec = I->second;
2722
2723    uint64_t Offset = Stream.GetCurrentBitNo();
2724    Stream.EmitRecord(DECL_UPDATES, URec);
2725
2726    OffsetsRecord.push_back(GetDeclRef(D));
2727    OffsetsRecord.push_back(Offset);
2728  }
2729  Stream.ExitBlock();
2730  Stream.EmitRecord(DECL_UPDATE_OFFSETS, OffsetsRecord);
2731}
2732
2733void ASTWriter::WriteDeclReplacementsBlock() {
2734  if (ReplacedDecls.empty())
2735    return;
2736
2737  RecordData Record;
2738  for (llvm::SmallVector<std::pair<DeclID, uint64_t>, 16>::iterator
2739           I = ReplacedDecls.begin(), E = ReplacedDecls.end(); I != E; ++I) {
2740    Record.push_back(I->first);
2741    Record.push_back(I->second);
2742  }
2743  Stream.EmitRecord(DECL_REPLACEMENTS, Record);
2744}
2745
2746void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
2747  Record.push_back(Loc.getRawEncoding());
2748}
2749
2750void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
2751  AddSourceLocation(Range.getBegin(), Record);
2752  AddSourceLocation(Range.getEnd(), Record);
2753}
2754
2755void ASTWriter::AddAPInt(const llvm::APInt &Value, RecordDataImpl &Record) {
2756  Record.push_back(Value.getBitWidth());
2757  const uint64_t *Words = Value.getRawData();
2758  Record.append(Words, Words + Value.getNumWords());
2759}
2760
2761void ASTWriter::AddAPSInt(const llvm::APSInt &Value, RecordDataImpl &Record) {
2762  Record.push_back(Value.isUnsigned());
2763  AddAPInt(Value, Record);
2764}
2765
2766void ASTWriter::AddAPFloat(const llvm::APFloat &Value, RecordDataImpl &Record) {
2767  AddAPInt(Value.bitcastToAPInt(), Record);
2768}
2769
2770void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
2771  Record.push_back(getIdentifierRef(II));
2772}
2773
2774IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
2775  if (II == 0)
2776    return 0;
2777
2778  IdentID &ID = IdentifierIDs[II];
2779  if (ID == 0)
2780    ID = NextIdentID++;
2781  return ID;
2782}
2783
2784MacroID ASTWriter::getMacroDefinitionID(MacroDefinition *MD) {
2785  if (MD == 0)
2786    return 0;
2787
2788  MacroID &ID = MacroDefinitions[MD];
2789  if (ID == 0)
2790    ID = NextMacroID++;
2791  return ID;
2792}
2793
2794void ASTWriter::AddSelectorRef(const Selector SelRef, RecordDataImpl &Record) {
2795  Record.push_back(getSelectorRef(SelRef));
2796}
2797
2798SelectorID ASTWriter::getSelectorRef(Selector Sel) {
2799  if (Sel.getAsOpaquePtr() == 0) {
2800    return 0;
2801  }
2802
2803  SelectorID &SID = SelectorIDs[Sel];
2804  if (SID == 0 && Chain) {
2805    // This might trigger a ReadSelector callback, which will set the ID for
2806    // this selector.
2807    Chain->LoadSelector(Sel);
2808  }
2809  if (SID == 0) {
2810    SID = NextSelectorID++;
2811  }
2812  return SID;
2813}
2814
2815void ASTWriter::AddCXXTemporary(const CXXTemporary *Temp, RecordDataImpl &Record) {
2816  AddDeclRef(Temp->getDestructor(), Record);
2817}
2818
2819void ASTWriter::AddTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind,
2820                                           const TemplateArgumentLocInfo &Arg,
2821                                           RecordDataImpl &Record) {
2822  switch (Kind) {
2823  case TemplateArgument::Expression:
2824    AddStmt(Arg.getAsExpr());
2825    break;
2826  case TemplateArgument::Type:
2827    AddTypeSourceInfo(Arg.getAsTypeSourceInfo(), Record);
2828    break;
2829  case TemplateArgument::Template:
2830    AddSourceRange(Arg.getTemplateQualifierRange(), Record);
2831    AddSourceLocation(Arg.getTemplateNameLoc(), Record);
2832    break;
2833  case TemplateArgument::Null:
2834  case TemplateArgument::Integral:
2835  case TemplateArgument::Declaration:
2836  case TemplateArgument::Pack:
2837    break;
2838  }
2839}
2840
2841void ASTWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg,
2842                                       RecordDataImpl &Record) {
2843  AddTemplateArgument(Arg.getArgument(), Record);
2844
2845  if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
2846    bool InfoHasSameExpr
2847      = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
2848    Record.push_back(InfoHasSameExpr);
2849    if (InfoHasSameExpr)
2850      return; // Avoid storing the same expr twice.
2851  }
2852  AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo(),
2853                             Record);
2854}
2855
2856void ASTWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo, RecordDataImpl &Record) {
2857  if (TInfo == 0) {
2858    AddTypeRef(QualType(), Record);
2859    return;
2860  }
2861
2862  AddTypeRef(TInfo->getType(), Record);
2863  TypeLocWriter TLW(*this, Record);
2864  for (TypeLoc TL = TInfo->getTypeLoc(); !TL.isNull(); TL = TL.getNextTypeLoc())
2865    TLW.Visit(TL);
2866}
2867
2868void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
2869  Record.push_back(GetOrCreateTypeID(T));
2870}
2871
2872TypeID ASTWriter::GetOrCreateTypeID(QualType T) {
2873  return MakeTypeID(T,
2874              std::bind1st(std::mem_fun(&ASTWriter::GetOrCreateTypeIdx), this));
2875}
2876
2877TypeID ASTWriter::getTypeID(QualType T) const {
2878  return MakeTypeID(T,
2879              std::bind1st(std::mem_fun(&ASTWriter::getTypeIdx), this));
2880}
2881
2882TypeIdx ASTWriter::GetOrCreateTypeIdx(QualType T) {
2883  if (T.isNull())
2884    return TypeIdx();
2885  assert(!T.getLocalFastQualifiers());
2886
2887  TypeIdx &Idx = TypeIdxs[T];
2888  if (Idx.getIndex() == 0) {
2889    // We haven't seen this type before. Assign it a new ID and put it
2890    // into the queue of types to emit.
2891    Idx = TypeIdx(NextTypeID++);
2892    DeclTypesToEmit.push(T);
2893  }
2894  return Idx;
2895}
2896
2897TypeIdx ASTWriter::getTypeIdx(QualType T) const {
2898  if (T.isNull())
2899    return TypeIdx();
2900  assert(!T.getLocalFastQualifiers());
2901
2902  TypeIdxMap::const_iterator I = TypeIdxs.find(T);
2903  assert(I != TypeIdxs.end() && "Type not emitted!");
2904  return I->second;
2905}
2906
2907void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
2908  Record.push_back(GetDeclRef(D));
2909}
2910
2911DeclID ASTWriter::GetDeclRef(const Decl *D) {
2912  if (D == 0) {
2913    return 0;
2914  }
2915  assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
2916  DeclID &ID = DeclIDs[D];
2917  if (ID == 0) {
2918    // We haven't seen this declaration before. Give it a new ID and
2919    // enqueue it in the list of declarations to emit.
2920    ID = NextDeclID++;
2921    DeclTypesToEmit.push(const_cast<Decl *>(D));
2922  } else if (ID < FirstDeclID && D->isChangedSinceDeserialization()) {
2923    // We don't add it to the replacement collection here, because we don't
2924    // have the offset yet.
2925    DeclTypesToEmit.push(const_cast<Decl *>(D));
2926    // Reset the flag, so that we don't add this decl multiple times.
2927    const_cast<Decl *>(D)->setChangedSinceDeserialization(false);
2928  }
2929
2930  return ID;
2931}
2932
2933DeclID ASTWriter::getDeclID(const Decl *D) {
2934  if (D == 0)
2935    return 0;
2936
2937  assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
2938  return DeclIDs[D];
2939}
2940
2941void ASTWriter::AddDeclarationName(DeclarationName Name, RecordDataImpl &Record) {
2942  // FIXME: Emit a stable enum for NameKind.  0 = Identifier etc.
2943  Record.push_back(Name.getNameKind());
2944  switch (Name.getNameKind()) {
2945  case DeclarationName::Identifier:
2946    AddIdentifierRef(Name.getAsIdentifierInfo(), Record);
2947    break;
2948
2949  case DeclarationName::ObjCZeroArgSelector:
2950  case DeclarationName::ObjCOneArgSelector:
2951  case DeclarationName::ObjCMultiArgSelector:
2952    AddSelectorRef(Name.getObjCSelector(), Record);
2953    break;
2954
2955  case DeclarationName::CXXConstructorName:
2956  case DeclarationName::CXXDestructorName:
2957  case DeclarationName::CXXConversionFunctionName:
2958    AddTypeRef(Name.getCXXNameType(), Record);
2959    break;
2960
2961  case DeclarationName::CXXOperatorName:
2962    Record.push_back(Name.getCXXOverloadedOperator());
2963    break;
2964
2965  case DeclarationName::CXXLiteralOperatorName:
2966    AddIdentifierRef(Name.getCXXLiteralIdentifier(), Record);
2967    break;
2968
2969  case DeclarationName::CXXUsingDirective:
2970    // No extra data to emit
2971    break;
2972  }
2973}
2974
2975void ASTWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
2976                                     DeclarationName Name, RecordDataImpl &Record) {
2977  switch (Name.getNameKind()) {
2978  case DeclarationName::CXXConstructorName:
2979  case DeclarationName::CXXDestructorName:
2980  case DeclarationName::CXXConversionFunctionName:
2981    AddTypeSourceInfo(DNLoc.NamedType.TInfo, Record);
2982    break;
2983
2984  case DeclarationName::CXXOperatorName:
2985    AddSourceLocation(
2986       SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.BeginOpNameLoc),
2987       Record);
2988    AddSourceLocation(
2989        SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc),
2990        Record);
2991    break;
2992
2993  case DeclarationName::CXXLiteralOperatorName:
2994    AddSourceLocation(
2995     SourceLocation::getFromRawEncoding(DNLoc.CXXLiteralOperatorName.OpNameLoc),
2996     Record);
2997    break;
2998
2999  case DeclarationName::Identifier:
3000  case DeclarationName::ObjCZeroArgSelector:
3001  case DeclarationName::ObjCOneArgSelector:
3002  case DeclarationName::ObjCMultiArgSelector:
3003  case DeclarationName::CXXUsingDirective:
3004    break;
3005  }
3006}
3007
3008void ASTWriter::AddDeclarationNameInfo(const DeclarationNameInfo &NameInfo,
3009                                       RecordDataImpl &Record) {
3010  AddDeclarationName(NameInfo.getName(), Record);
3011  AddSourceLocation(NameInfo.getLoc(), Record);
3012  AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName(), Record);
3013}
3014
3015void ASTWriter::AddQualifierInfo(const QualifierInfo &Info,
3016                                 RecordDataImpl &Record) {
3017  AddNestedNameSpecifier(Info.NNS, Record);
3018  AddSourceRange(Info.NNSRange, Record);
3019  Record.push_back(Info.NumTemplParamLists);
3020  for (unsigned i=0, e=Info.NumTemplParamLists; i != e; ++i)
3021    AddTemplateParameterList(Info.TemplParamLists[i], Record);
3022}
3023
3024void ASTWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS,
3025                                       RecordDataImpl &Record) {
3026  // Nested name specifiers usually aren't too long. I think that 8 would
3027  // typically accomodate the vast majority.
3028  llvm::SmallVector<NestedNameSpecifier *, 8> NestedNames;
3029
3030  // Push each of the NNS's onto a stack for serialization in reverse order.
3031  while (NNS) {
3032    NestedNames.push_back(NNS);
3033    NNS = NNS->getPrefix();
3034  }
3035
3036  Record.push_back(NestedNames.size());
3037  while(!NestedNames.empty()) {
3038    NNS = NestedNames.pop_back_val();
3039    NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
3040    Record.push_back(Kind);
3041    switch (Kind) {
3042    case NestedNameSpecifier::Identifier:
3043      AddIdentifierRef(NNS->getAsIdentifier(), Record);
3044      break;
3045
3046    case NestedNameSpecifier::Namespace:
3047      AddDeclRef(NNS->getAsNamespace(), Record);
3048      break;
3049
3050    case NestedNameSpecifier::TypeSpec:
3051    case NestedNameSpecifier::TypeSpecWithTemplate:
3052      AddTypeRef(QualType(NNS->getAsType(), 0), Record);
3053      Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
3054      break;
3055
3056    case NestedNameSpecifier::Global:
3057      // Don't need to write an associated value.
3058      break;
3059    }
3060  }
3061}
3062
3063void ASTWriter::AddTemplateName(TemplateName Name, RecordDataImpl &Record) {
3064  TemplateName::NameKind Kind = Name.getKind();
3065  Record.push_back(Kind);
3066  switch (Kind) {
3067  case TemplateName::Template:
3068    AddDeclRef(Name.getAsTemplateDecl(), Record);
3069    break;
3070
3071  case TemplateName::OverloadedTemplate: {
3072    OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
3073    Record.push_back(OvT->size());
3074    for (OverloadedTemplateStorage::iterator I = OvT->begin(), E = OvT->end();
3075           I != E; ++I)
3076      AddDeclRef(*I, Record);
3077    break;
3078  }
3079
3080  case TemplateName::QualifiedTemplate: {
3081    QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
3082    AddNestedNameSpecifier(QualT->getQualifier(), Record);
3083    Record.push_back(QualT->hasTemplateKeyword());
3084    AddDeclRef(QualT->getTemplateDecl(), Record);
3085    break;
3086  }
3087
3088  case TemplateName::DependentTemplate: {
3089    DependentTemplateName *DepT = Name.getAsDependentTemplateName();
3090    AddNestedNameSpecifier(DepT->getQualifier(), Record);
3091    Record.push_back(DepT->isIdentifier());
3092    if (DepT->isIdentifier())
3093      AddIdentifierRef(DepT->getIdentifier(), Record);
3094    else
3095      Record.push_back(DepT->getOperator());
3096    break;
3097  }
3098  }
3099}
3100
3101void ASTWriter::AddTemplateArgument(const TemplateArgument &Arg,
3102                                    RecordDataImpl &Record) {
3103  Record.push_back(Arg.getKind());
3104  switch (Arg.getKind()) {
3105  case TemplateArgument::Null:
3106    break;
3107  case TemplateArgument::Type:
3108    AddTypeRef(Arg.getAsType(), Record);
3109    break;
3110  case TemplateArgument::Declaration:
3111    AddDeclRef(Arg.getAsDecl(), Record);
3112    break;
3113  case TemplateArgument::Integral:
3114    AddAPSInt(*Arg.getAsIntegral(), Record);
3115    AddTypeRef(Arg.getIntegralType(), Record);
3116    break;
3117  case TemplateArgument::Template:
3118    AddTemplateName(Arg.getAsTemplate(), Record);
3119    break;
3120  case TemplateArgument::Expression:
3121    AddStmt(Arg.getAsExpr());
3122    break;
3123  case TemplateArgument::Pack:
3124    Record.push_back(Arg.pack_size());
3125    for (TemplateArgument::pack_iterator I=Arg.pack_begin(), E=Arg.pack_end();
3126           I != E; ++I)
3127      AddTemplateArgument(*I, Record);
3128    break;
3129  }
3130}
3131
3132void
3133ASTWriter::AddTemplateParameterList(const TemplateParameterList *TemplateParams,
3134                                    RecordDataImpl &Record) {
3135  assert(TemplateParams && "No TemplateParams!");
3136  AddSourceLocation(TemplateParams->getTemplateLoc(), Record);
3137  AddSourceLocation(TemplateParams->getLAngleLoc(), Record);
3138  AddSourceLocation(TemplateParams->getRAngleLoc(), Record);
3139  Record.push_back(TemplateParams->size());
3140  for (TemplateParameterList::const_iterator
3141         P = TemplateParams->begin(), PEnd = TemplateParams->end();
3142         P != PEnd; ++P)
3143    AddDeclRef(*P, Record);
3144}
3145
3146/// \brief Emit a template argument list.
3147void
3148ASTWriter::AddTemplateArgumentList(const TemplateArgumentList *TemplateArgs,
3149                                   RecordDataImpl &Record) {
3150  assert(TemplateArgs && "No TemplateArgs!");
3151  Record.push_back(TemplateArgs->flat_size());
3152  for (int i=0, e = TemplateArgs->flat_size(); i != e; ++i)
3153    AddTemplateArgument(TemplateArgs->get(i), Record);
3154}
3155
3156
3157void
3158ASTWriter::AddUnresolvedSet(const UnresolvedSetImpl &Set, RecordDataImpl &Record) {
3159  Record.push_back(Set.size());
3160  for (UnresolvedSetImpl::const_iterator
3161         I = Set.begin(), E = Set.end(); I != E; ++I) {
3162    AddDeclRef(I.getDecl(), Record);
3163    Record.push_back(I.getAccess());
3164  }
3165}
3166
3167void ASTWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base,
3168                                    RecordDataImpl &Record) {
3169  Record.push_back(Base.isVirtual());
3170  Record.push_back(Base.isBaseOfClass());
3171  Record.push_back(Base.getAccessSpecifierAsWritten());
3172  AddTypeSourceInfo(Base.getTypeSourceInfo(), Record);
3173  AddSourceRange(Base.getSourceRange(), Record);
3174}
3175
3176void ASTWriter::AddCXXBaseOrMemberInitializers(
3177                        const CXXBaseOrMemberInitializer * const *BaseOrMembers,
3178                        unsigned NumBaseOrMembers, RecordDataImpl &Record) {
3179  Record.push_back(NumBaseOrMembers);
3180  for (unsigned i=0; i != NumBaseOrMembers; ++i) {
3181    const CXXBaseOrMemberInitializer *Init = BaseOrMembers[i];
3182
3183    Record.push_back(Init->isBaseInitializer());
3184    if (Init->isBaseInitializer()) {
3185      AddTypeSourceInfo(Init->getBaseClassInfo(), Record);
3186      Record.push_back(Init->isBaseVirtual());
3187    } else {
3188      AddDeclRef(Init->getMember(), Record);
3189    }
3190    AddSourceLocation(Init->getMemberLocation(), Record);
3191    AddStmt(Init->getInit());
3192    AddDeclRef(Init->getAnonUnionMember(), Record);
3193    AddSourceLocation(Init->getLParenLoc(), Record);
3194    AddSourceLocation(Init->getRParenLoc(), Record);
3195    Record.push_back(Init->isWritten());
3196    if (Init->isWritten()) {
3197      Record.push_back(Init->getSourceOrder());
3198    } else {
3199      Record.push_back(Init->getNumArrayIndices());
3200      for (unsigned i=0, e=Init->getNumArrayIndices(); i != e; ++i)
3201        AddDeclRef(Init->getArrayIndex(i), Record);
3202    }
3203  }
3204}
3205
3206void ASTWriter::AddCXXDefinitionData(const CXXRecordDecl *D, RecordDataImpl &Record) {
3207  assert(D->DefinitionData);
3208  struct CXXRecordDecl::DefinitionData &Data = *D->DefinitionData;
3209  Record.push_back(Data.UserDeclaredConstructor);
3210  Record.push_back(Data.UserDeclaredCopyConstructor);
3211  Record.push_back(Data.UserDeclaredCopyAssignment);
3212  Record.push_back(Data.UserDeclaredDestructor);
3213  Record.push_back(Data.Aggregate);
3214  Record.push_back(Data.PlainOldData);
3215  Record.push_back(Data.Empty);
3216  Record.push_back(Data.Polymorphic);
3217  Record.push_back(Data.Abstract);
3218  Record.push_back(Data.HasTrivialConstructor);
3219  Record.push_back(Data.HasTrivialCopyConstructor);
3220  Record.push_back(Data.HasTrivialCopyAssignment);
3221  Record.push_back(Data.HasTrivialDestructor);
3222  Record.push_back(Data.ComputedVisibleConversions);
3223  Record.push_back(Data.DeclaredDefaultConstructor);
3224  Record.push_back(Data.DeclaredCopyConstructor);
3225  Record.push_back(Data.DeclaredCopyAssignment);
3226  Record.push_back(Data.DeclaredDestructor);
3227
3228  Record.push_back(Data.NumBases);
3229  for (unsigned i = 0; i != Data.NumBases; ++i)
3230    AddCXXBaseSpecifier(Data.Bases[i], Record);
3231
3232  // FIXME: Make VBases lazily computed when needed to avoid storing them.
3233  Record.push_back(Data.NumVBases);
3234  for (unsigned i = 0; i != Data.NumVBases; ++i)
3235    AddCXXBaseSpecifier(Data.VBases[i], Record);
3236
3237  AddUnresolvedSet(Data.Conversions, Record);
3238  AddUnresolvedSet(Data.VisibleConversions, Record);
3239  // Data.Definition is the owning decl, no need to write it.
3240  AddDeclRef(Data.FirstFriend, Record);
3241}
3242
3243void ASTWriter::ReaderInitialized(ASTReader *Reader) {
3244  assert(Reader && "Cannot remove chain");
3245  assert(!Chain && "Cannot replace chain");
3246  assert(FirstDeclID == NextDeclID &&
3247         FirstTypeID == NextTypeID &&
3248         FirstIdentID == NextIdentID &&
3249         FirstSelectorID == NextSelectorID &&
3250         FirstMacroID == NextMacroID &&
3251         "Setting chain after writing has started.");
3252  Chain = Reader;
3253
3254  FirstDeclID += Chain->getTotalNumDecls();
3255  FirstTypeID += Chain->getTotalNumTypes();
3256  FirstIdentID += Chain->getTotalNumIdentifiers();
3257  FirstSelectorID += Chain->getTotalNumSelectors();
3258  FirstMacroID += Chain->getTotalNumMacroDefinitions();
3259  NextDeclID = FirstDeclID;
3260  NextTypeID = FirstTypeID;
3261  NextIdentID = FirstIdentID;
3262  NextSelectorID = FirstSelectorID;
3263  NextMacroID = FirstMacroID;
3264}
3265
3266void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
3267  IdentifierIDs[II] = ID;
3268}
3269
3270void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
3271  // Always take the highest-numbered type index. This copes with an interesting
3272  // case for chained AST writing where we schedule writing the type and then,
3273  // later, deserialize the type from another AST. In this case, we want to
3274  // keep the higher-numbered entry so that we can properly write it out to
3275  // the AST file.
3276  TypeIdx &StoredIdx = TypeIdxs[T];
3277  if (Idx.getIndex() >= StoredIdx.getIndex())
3278    StoredIdx = Idx;
3279}
3280
3281void ASTWriter::DeclRead(DeclID ID, const Decl *D) {
3282  DeclIDs[D] = ID;
3283}
3284
3285void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
3286  SelectorIDs[S] = ID;
3287}
3288
3289void ASTWriter::MacroDefinitionRead(serialization::MacroID ID,
3290                                    MacroDefinition *MD) {
3291  MacroDefinitions[MD] = ID;
3292}
3293