ASTWriter.cpp revision 910f8008fea79120489a53593fe971b0b8a4a740
1//===--- ASTWriter.cpp - AST File Writer ----------------------------------===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10//  This file defines the ASTWriter class, which writes AST files.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang/Serialization/ASTWriter.h"
15#include "ASTCommon.h"
16#include "clang/Sema/Sema.h"
17#include "clang/Sema/IdentifierResolver.h"
18#include "clang/AST/ASTContext.h"
19#include "clang/AST/Decl.h"
20#include "clang/AST/DeclContextInternals.h"
21#include "clang/AST/DeclTemplate.h"
22#include "clang/AST/DeclFriend.h"
23#include "clang/AST/Expr.h"
24#include "clang/AST/ExprCXX.h"
25#include "clang/AST/Type.h"
26#include "clang/AST/TypeLocVisitor.h"
27#include "clang/Serialization/ASTReader.h"
28#include "clang/Lex/MacroInfo.h"
29#include "clang/Lex/PreprocessingRecord.h"
30#include "clang/Lex/Preprocessor.h"
31#include "clang/Lex/HeaderSearch.h"
32#include "clang/Basic/FileManager.h"
33#include "clang/Basic/OnDiskHashTable.h"
34#include "clang/Basic/SourceManager.h"
35#include "clang/Basic/SourceManagerInternals.h"
36#include "clang/Basic/TargetInfo.h"
37#include "clang/Basic/Version.h"
38#include "llvm/ADT/APFloat.h"
39#include "llvm/ADT/APInt.h"
40#include "llvm/ADT/StringExtras.h"
41#include "llvm/Bitcode/BitstreamWriter.h"
42#include "llvm/Support/MemoryBuffer.h"
43#include "llvm/System/Path.h"
44#include <cstdio>
45using namespace clang;
46using namespace clang::serialization;
47
48template <typename T, typename Allocator>
49T *data(std::vector<T, Allocator> &v) {
50  return v.empty() ? 0 : &v.front();
51}
52template <typename T, typename Allocator>
53const T *data(const std::vector<T, Allocator> &v) {
54  return v.empty() ? 0 : &v.front();
55}
56
57//===----------------------------------------------------------------------===//
58// Type serialization
59//===----------------------------------------------------------------------===//
60
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
1444void ASTWriter::WriteUserDiagnosticMappings(const Diagnostic &Diag) {
1445  RecordData Record;
1446  for (unsigned i = 0; i != diag::DIAG_UPPER_LIMIT; ++i) {
1447    diag::Mapping Map = Diag.getDiagnosticMappingInfo(i);
1448    if (Map & 0x8) { // user mapping.
1449      Record.push_back(i);
1450      Record.push_back(Map & 0x7);
1451    }
1452  }
1453
1454  if (!Record.empty())
1455    Stream.EmitRecord(DIAG_USER_MAPPINGS, Record);
1456}
1457
1458//===----------------------------------------------------------------------===//
1459// Type Serialization
1460//===----------------------------------------------------------------------===//
1461
1462/// \brief Write the representation of a type to the AST stream.
1463void ASTWriter::WriteType(QualType T) {
1464  TypeIdx &Idx = TypeIdxs[T];
1465  if (Idx.getIndex() == 0) // we haven't seen this type before.
1466    Idx = TypeIdx(NextTypeID++);
1467
1468  assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
1469
1470  // Record the offset for this type.
1471  unsigned Index = Idx.getIndex() - FirstTypeID;
1472  if (TypeOffsets.size() == Index)
1473    TypeOffsets.push_back(Stream.GetCurrentBitNo());
1474  else if (TypeOffsets.size() < Index) {
1475    TypeOffsets.resize(Index + 1);
1476    TypeOffsets[Index] = Stream.GetCurrentBitNo();
1477  }
1478
1479  RecordData Record;
1480
1481  // Emit the type's representation.
1482  ASTTypeWriter W(*this, Record);
1483
1484  if (T.hasLocalNonFastQualifiers()) {
1485    Qualifiers Qs = T.getLocalQualifiers();
1486    AddTypeRef(T.getLocalUnqualifiedType(), Record);
1487    Record.push_back(Qs.getAsOpaqueValue());
1488    W.Code = TYPE_EXT_QUAL;
1489  } else {
1490    switch (T->getTypeClass()) {
1491      // For all of the concrete, non-dependent types, call the
1492      // appropriate visitor function.
1493#define TYPE(Class, Base) \
1494    case Type::Class: W.Visit##Class##Type(cast<Class##Type>(T)); break;
1495#define ABSTRACT_TYPE(Class, Base)
1496#include "clang/AST/TypeNodes.def"
1497    }
1498  }
1499
1500  // Emit the serialized record.
1501  Stream.EmitRecord(W.Code, Record);
1502
1503  // Flush any expressions that were written as part of this type.
1504  FlushStmts();
1505}
1506
1507//===----------------------------------------------------------------------===//
1508// Declaration Serialization
1509//===----------------------------------------------------------------------===//
1510
1511/// \brief Write the block containing all of the declaration IDs
1512/// lexically declared within the given DeclContext.
1513///
1514/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
1515/// bistream, or 0 if no block was written.
1516uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
1517                                                 DeclContext *DC) {
1518  if (DC->decls_empty())
1519    return 0;
1520
1521  uint64_t Offset = Stream.GetCurrentBitNo();
1522  RecordData Record;
1523  Record.push_back(DECL_CONTEXT_LEXICAL);
1524  llvm::SmallVector<KindDeclIDPair, 64> Decls;
1525  for (DeclContext::decl_iterator D = DC->decls_begin(), DEnd = DC->decls_end();
1526         D != DEnd; ++D)
1527    Decls.push_back(std::make_pair((*D)->getKind(), GetDeclRef(*D)));
1528
1529  ++NumLexicalDeclContexts;
1530  Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record,
1531                            reinterpret_cast<char*>(Decls.data()),
1532                            Decls.size() * sizeof(KindDeclIDPair));
1533  return Offset;
1534}
1535
1536void ASTWriter::WriteTypeDeclOffsets() {
1537  using namespace llvm;
1538  RecordData Record;
1539
1540  // Write the type offsets array
1541  BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1542  Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
1543  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
1544  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
1545  unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1546  Record.clear();
1547  Record.push_back(TYPE_OFFSET);
1548  Record.push_back(TypeOffsets.size());
1549  Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record,
1550                            (const char *)data(TypeOffsets),
1551                            TypeOffsets.size() * sizeof(TypeOffsets[0]));
1552
1553  // Write the declaration offsets array
1554  Abbrev = new BitCodeAbbrev();
1555  Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
1556  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
1557  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
1558  unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1559  Record.clear();
1560  Record.push_back(DECL_OFFSET);
1561  Record.push_back(DeclOffsets.size());
1562  Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record,
1563                            (const char *)data(DeclOffsets),
1564                            DeclOffsets.size() * sizeof(DeclOffsets[0]));
1565}
1566
1567//===----------------------------------------------------------------------===//
1568// Global Method Pool and Selector Serialization
1569//===----------------------------------------------------------------------===//
1570
1571namespace {
1572// Trait used for the on-disk hash table used in the method pool.
1573class ASTMethodPoolTrait {
1574  ASTWriter &Writer;
1575
1576public:
1577  typedef Selector key_type;
1578  typedef key_type key_type_ref;
1579
1580  struct data_type {
1581    SelectorID ID;
1582    ObjCMethodList Instance, Factory;
1583  };
1584  typedef const data_type& data_type_ref;
1585
1586  explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) { }
1587
1588  static unsigned ComputeHash(Selector Sel) {
1589    return serialization::ComputeHash(Sel);
1590  }
1591
1592  std::pair<unsigned,unsigned>
1593    EmitKeyDataLength(llvm::raw_ostream& Out, Selector Sel,
1594                      data_type_ref Methods) {
1595    unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
1596    clang::io::Emit16(Out, KeyLen);
1597    unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
1598    for (const ObjCMethodList *Method = &Methods.Instance; Method;
1599         Method = Method->Next)
1600      if (Method->Method)
1601        DataLen += 4;
1602    for (const ObjCMethodList *Method = &Methods.Factory; Method;
1603         Method = Method->Next)
1604      if (Method->Method)
1605        DataLen += 4;
1606    clang::io::Emit16(Out, DataLen);
1607    return std::make_pair(KeyLen, DataLen);
1608  }
1609
1610  void EmitKey(llvm::raw_ostream& Out, Selector Sel, unsigned) {
1611    uint64_t Start = Out.tell();
1612    assert((Start >> 32) == 0 && "Selector key offset too large");
1613    Writer.SetSelectorOffset(Sel, Start);
1614    unsigned N = Sel.getNumArgs();
1615    clang::io::Emit16(Out, N);
1616    if (N == 0)
1617      N = 1;
1618    for (unsigned I = 0; I != N; ++I)
1619      clang::io::Emit32(Out,
1620                    Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
1621  }
1622
1623  void EmitData(llvm::raw_ostream& Out, key_type_ref,
1624                data_type_ref Methods, unsigned DataLen) {
1625    uint64_t Start = Out.tell(); (void)Start;
1626    clang::io::Emit32(Out, Methods.ID);
1627    unsigned NumInstanceMethods = 0;
1628    for (const ObjCMethodList *Method = &Methods.Instance; Method;
1629         Method = Method->Next)
1630      if (Method->Method)
1631        ++NumInstanceMethods;
1632
1633    unsigned NumFactoryMethods = 0;
1634    for (const ObjCMethodList *Method = &Methods.Factory; Method;
1635         Method = Method->Next)
1636      if (Method->Method)
1637        ++NumFactoryMethods;
1638
1639    clang::io::Emit16(Out, NumInstanceMethods);
1640    clang::io::Emit16(Out, NumFactoryMethods);
1641    for (const ObjCMethodList *Method = &Methods.Instance; Method;
1642         Method = Method->Next)
1643      if (Method->Method)
1644        clang::io::Emit32(Out, Writer.getDeclID(Method->Method));
1645    for (const ObjCMethodList *Method = &Methods.Factory; Method;
1646         Method = Method->Next)
1647      if (Method->Method)
1648        clang::io::Emit32(Out, Writer.getDeclID(Method->Method));
1649
1650    assert(Out.tell() - Start == DataLen && "Data length is wrong");
1651  }
1652};
1653} // end anonymous namespace
1654
1655/// \brief Write ObjC data: selectors and the method pool.
1656///
1657/// The method pool contains both instance and factory methods, stored
1658/// in an on-disk hash table indexed by the selector. The hash table also
1659/// contains an empty entry for every other selector known to Sema.
1660void ASTWriter::WriteSelectors(Sema &SemaRef) {
1661  using namespace llvm;
1662
1663  // Do we have to do anything at all?
1664  if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
1665    return;
1666  unsigned NumTableEntries = 0;
1667  // Create and write out the blob that contains selectors and the method pool.
1668  {
1669    OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
1670    ASTMethodPoolTrait Trait(*this);
1671
1672    // Create the on-disk hash table representation. We walk through every
1673    // selector we've seen and look it up in the method pool.
1674    SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
1675    for (llvm::DenseMap<Selector, SelectorID>::iterator
1676             I = SelectorIDs.begin(), E = SelectorIDs.end();
1677         I != E; ++I) {
1678      Selector S = I->first;
1679      Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
1680      ASTMethodPoolTrait::data_type Data = {
1681        I->second,
1682        ObjCMethodList(),
1683        ObjCMethodList()
1684      };
1685      if (F != SemaRef.MethodPool.end()) {
1686        Data.Instance = F->second.first;
1687        Data.Factory = F->second.second;
1688      }
1689      // Only write this selector if it's not in an existing AST or something
1690      // changed.
1691      if (Chain && I->second < FirstSelectorID) {
1692        // Selector already exists. Did it change?
1693        bool changed = false;
1694        for (ObjCMethodList *M = &Data.Instance; !changed && M && M->Method;
1695             M = M->Next) {
1696          if (M->Method->getPCHLevel() == 0)
1697            changed = true;
1698        }
1699        for (ObjCMethodList *M = &Data.Factory; !changed && M && M->Method;
1700             M = M->Next) {
1701          if (M->Method->getPCHLevel() == 0)
1702            changed = true;
1703        }
1704        if (!changed)
1705          continue;
1706      } else if (Data.Instance.Method || Data.Factory.Method) {
1707        // A new method pool entry.
1708        ++NumTableEntries;
1709      }
1710      Generator.insert(S, Data, Trait);
1711    }
1712
1713    // Create the on-disk hash table in a buffer.
1714    llvm::SmallString<4096> MethodPool;
1715    uint32_t BucketOffset;
1716    {
1717      ASTMethodPoolTrait Trait(*this);
1718      llvm::raw_svector_ostream Out(MethodPool);
1719      // Make sure that no bucket is at offset 0
1720      clang::io::Emit32(Out, 0);
1721      BucketOffset = Generator.Emit(Out, Trait);
1722    }
1723
1724    // Create a blob abbreviation
1725    BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1726    Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
1727    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1728    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1729    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1730    unsigned MethodPoolAbbrev = Stream.EmitAbbrev(Abbrev);
1731
1732    // Write the method pool
1733    RecordData Record;
1734    Record.push_back(METHOD_POOL);
1735    Record.push_back(BucketOffset);
1736    Record.push_back(NumTableEntries);
1737    Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool.str());
1738
1739    // Create a blob abbreviation for the selector table offsets.
1740    Abbrev = new BitCodeAbbrev();
1741    Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
1742    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
1743    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1744    unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1745
1746    // Write the selector offsets table.
1747    Record.clear();
1748    Record.push_back(SELECTOR_OFFSETS);
1749    Record.push_back(SelectorOffsets.size());
1750    Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
1751                              (const char *)data(SelectorOffsets),
1752                              SelectorOffsets.size() * 4);
1753  }
1754}
1755
1756/// \brief Write the selectors referenced in @selector expression into AST file.
1757void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
1758  using namespace llvm;
1759  if (SemaRef.ReferencedSelectors.empty())
1760    return;
1761
1762  RecordData Record;
1763
1764  // Note: this writes out all references even for a dependent AST. But it is
1765  // very tricky to fix, and given that @selector shouldn't really appear in
1766  // headers, probably not worth it. It's not a correctness issue.
1767  for (DenseMap<Selector, SourceLocation>::iterator S =
1768       SemaRef.ReferencedSelectors.begin(),
1769       E = SemaRef.ReferencedSelectors.end(); S != E; ++S) {
1770    Selector Sel = (*S).first;
1771    SourceLocation Loc = (*S).second;
1772    AddSelectorRef(Sel, Record);
1773    AddSourceLocation(Loc, Record);
1774  }
1775  Stream.EmitRecord(REFERENCED_SELECTOR_POOL, Record);
1776}
1777
1778//===----------------------------------------------------------------------===//
1779// Identifier Table Serialization
1780//===----------------------------------------------------------------------===//
1781
1782namespace {
1783class ASTIdentifierTableTrait {
1784  ASTWriter &Writer;
1785  Preprocessor &PP;
1786
1787  /// \brief Determines whether this is an "interesting" identifier
1788  /// that needs a full IdentifierInfo structure written into the hash
1789  /// table.
1790  static bool isInterestingIdentifier(const IdentifierInfo *II) {
1791    return II->isPoisoned() ||
1792      II->isExtensionToken() ||
1793      II->hasMacroDefinition() ||
1794      II->getObjCOrBuiltinID() ||
1795      II->getFETokenInfo<void>();
1796  }
1797
1798public:
1799  typedef const IdentifierInfo* key_type;
1800  typedef key_type  key_type_ref;
1801
1802  typedef IdentID data_type;
1803  typedef data_type data_type_ref;
1804
1805  ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP)
1806    : Writer(Writer), PP(PP) { }
1807
1808  static unsigned ComputeHash(const IdentifierInfo* II) {
1809    return llvm::HashString(II->getName());
1810  }
1811
1812  std::pair<unsigned,unsigned>
1813    EmitKeyDataLength(llvm::raw_ostream& Out, const IdentifierInfo* II,
1814                      IdentID ID) {
1815    unsigned KeyLen = II->getLength() + 1;
1816    unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
1817    if (isInterestingIdentifier(II)) {
1818      DataLen += 2; // 2 bytes for builtin ID, flags
1819      if (II->hasMacroDefinition() &&
1820          !PP.getMacroInfo(const_cast<IdentifierInfo *>(II))->isBuiltinMacro())
1821        DataLen += 4;
1822      for (IdentifierResolver::iterator D = IdentifierResolver::begin(II),
1823                                     DEnd = IdentifierResolver::end();
1824           D != DEnd; ++D)
1825        DataLen += sizeof(DeclID);
1826    }
1827    clang::io::Emit16(Out, DataLen);
1828    // We emit the key length after the data length so that every
1829    // string is preceded by a 16-bit length. This matches the PTH
1830    // format for storing identifiers.
1831    clang::io::Emit16(Out, KeyLen);
1832    return std::make_pair(KeyLen, DataLen);
1833  }
1834
1835  void EmitKey(llvm::raw_ostream& Out, const IdentifierInfo* II,
1836               unsigned KeyLen) {
1837    // Record the location of the key data.  This is used when generating
1838    // the mapping from persistent IDs to strings.
1839    Writer.SetIdentifierOffset(II, Out.tell());
1840    Out.write(II->getNameStart(), KeyLen);
1841  }
1842
1843  void EmitData(llvm::raw_ostream& Out, const IdentifierInfo* II,
1844                IdentID ID, unsigned) {
1845    if (!isInterestingIdentifier(II)) {
1846      clang::io::Emit32(Out, ID << 1);
1847      return;
1848    }
1849
1850    clang::io::Emit32(Out, (ID << 1) | 0x01);
1851    uint32_t Bits = 0;
1852    bool hasMacroDefinition =
1853      II->hasMacroDefinition() &&
1854      !PP.getMacroInfo(const_cast<IdentifierInfo *>(II))->isBuiltinMacro();
1855    Bits = (uint32_t)II->getObjCOrBuiltinID();
1856    Bits = (Bits << 1) | unsigned(hasMacroDefinition);
1857    Bits = (Bits << 1) | unsigned(II->isExtensionToken());
1858    Bits = (Bits << 1) | unsigned(II->isPoisoned());
1859    Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
1860    Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
1861    clang::io::Emit16(Out, Bits);
1862
1863    if (hasMacroDefinition)
1864      clang::io::Emit32(Out, Writer.getMacroOffset(II));
1865
1866    // Emit the declaration IDs in reverse order, because the
1867    // IdentifierResolver provides the declarations as they would be
1868    // visible (e.g., the function "stat" would come before the struct
1869    // "stat"), but IdentifierResolver::AddDeclToIdentifierChain()
1870    // adds declarations to the end of the list (so we need to see the
1871    // struct "status" before the function "status").
1872    // Only emit declarations that aren't from a chained PCH, though.
1873    llvm::SmallVector<Decl *, 16> Decls(IdentifierResolver::begin(II),
1874                                        IdentifierResolver::end());
1875    for (llvm::SmallVector<Decl *, 16>::reverse_iterator D = Decls.rbegin(),
1876                                                      DEnd = Decls.rend();
1877         D != DEnd; ++D)
1878      clang::io::Emit32(Out, Writer.getDeclID(*D));
1879  }
1880};
1881} // end anonymous namespace
1882
1883/// \brief Write the identifier table into the AST file.
1884///
1885/// The identifier table consists of a blob containing string data
1886/// (the actual identifiers themselves) and a separate "offsets" index
1887/// that maps identifier IDs to locations within the blob.
1888void ASTWriter::WriteIdentifierTable(Preprocessor &PP) {
1889  using namespace llvm;
1890
1891  // Create and write out the blob that contains the identifier
1892  // strings.
1893  {
1894    OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
1895    ASTIdentifierTableTrait Trait(*this, PP);
1896
1897    // Look for any identifiers that were named while processing the
1898    // headers, but are otherwise not needed. We add these to the hash
1899    // table to enable checking of the predefines buffer in the case
1900    // where the user adds new macro definitions when building the AST
1901    // file.
1902    for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
1903                                IDEnd = PP.getIdentifierTable().end();
1904         ID != IDEnd; ++ID)
1905      getIdentifierRef(ID->second);
1906
1907    // Create the on-disk hash table representation. We only store offsets
1908    // for identifiers that appear here for the first time.
1909    IdentifierOffsets.resize(NextIdentID - FirstIdentID);
1910    for (llvm::DenseMap<const IdentifierInfo *, IdentID>::iterator
1911           ID = IdentifierIDs.begin(), IDEnd = IdentifierIDs.end();
1912         ID != IDEnd; ++ID) {
1913      assert(ID->first && "NULL identifier in identifier table");
1914      if (!Chain || !ID->first->isFromAST())
1915        Generator.insert(ID->first, ID->second, Trait);
1916    }
1917
1918    // Create the on-disk hash table in a buffer.
1919    llvm::SmallString<4096> IdentifierTable;
1920    uint32_t BucketOffset;
1921    {
1922      ASTIdentifierTableTrait Trait(*this, PP);
1923      llvm::raw_svector_ostream Out(IdentifierTable);
1924      // Make sure that no bucket is at offset 0
1925      clang::io::Emit32(Out, 0);
1926      BucketOffset = Generator.Emit(Out, Trait);
1927    }
1928
1929    // Create a blob abbreviation
1930    BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1931    Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
1932    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1933    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1934    unsigned IDTableAbbrev = Stream.EmitAbbrev(Abbrev);
1935
1936    // Write the identifier table
1937    RecordData Record;
1938    Record.push_back(IDENTIFIER_TABLE);
1939    Record.push_back(BucketOffset);
1940    Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable.str());
1941  }
1942
1943  // Write the offsets table for identifier IDs.
1944  BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1945  Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
1946  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
1947  Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1948  unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1949
1950  RecordData Record;
1951  Record.push_back(IDENTIFIER_OFFSET);
1952  Record.push_back(IdentifierOffsets.size());
1953  Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
1954                            (const char *)data(IdentifierOffsets),
1955                            IdentifierOffsets.size() * sizeof(uint32_t));
1956}
1957
1958//===----------------------------------------------------------------------===//
1959// DeclContext's Name Lookup Table Serialization
1960//===----------------------------------------------------------------------===//
1961
1962namespace {
1963// Trait used for the on-disk hash table used in the method pool.
1964class ASTDeclContextNameLookupTrait {
1965  ASTWriter &Writer;
1966
1967public:
1968  typedef DeclarationName key_type;
1969  typedef key_type key_type_ref;
1970
1971  typedef DeclContext::lookup_result data_type;
1972  typedef const data_type& data_type_ref;
1973
1974  explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) { }
1975
1976  unsigned ComputeHash(DeclarationName Name) {
1977    llvm::FoldingSetNodeID ID;
1978    ID.AddInteger(Name.getNameKind());
1979
1980    switch (Name.getNameKind()) {
1981    case DeclarationName::Identifier:
1982      ID.AddString(Name.getAsIdentifierInfo()->getName());
1983      break;
1984    case DeclarationName::ObjCZeroArgSelector:
1985    case DeclarationName::ObjCOneArgSelector:
1986    case DeclarationName::ObjCMultiArgSelector:
1987      ID.AddInteger(serialization::ComputeHash(Name.getObjCSelector()));
1988      break;
1989    case DeclarationName::CXXConstructorName:
1990    case DeclarationName::CXXDestructorName:
1991    case DeclarationName::CXXConversionFunctionName:
1992      ID.AddInteger(Writer.GetOrCreateTypeID(Name.getCXXNameType()));
1993      break;
1994    case DeclarationName::CXXOperatorName:
1995      ID.AddInteger(Name.getCXXOverloadedOperator());
1996      break;
1997    case DeclarationName::CXXLiteralOperatorName:
1998      ID.AddString(Name.getCXXLiteralIdentifier()->getName());
1999    case DeclarationName::CXXUsingDirective:
2000      break;
2001    }
2002
2003    return ID.ComputeHash();
2004  }
2005
2006  std::pair<unsigned,unsigned>
2007    EmitKeyDataLength(llvm::raw_ostream& Out, DeclarationName Name,
2008                      data_type_ref Lookup) {
2009    unsigned KeyLen = 1;
2010    switch (Name.getNameKind()) {
2011    case DeclarationName::Identifier:
2012    case DeclarationName::ObjCZeroArgSelector:
2013    case DeclarationName::ObjCOneArgSelector:
2014    case DeclarationName::ObjCMultiArgSelector:
2015    case DeclarationName::CXXConstructorName:
2016    case DeclarationName::CXXDestructorName:
2017    case DeclarationName::CXXConversionFunctionName:
2018    case DeclarationName::CXXLiteralOperatorName:
2019      KeyLen += 4;
2020      break;
2021    case DeclarationName::CXXOperatorName:
2022      KeyLen += 1;
2023      break;
2024    case DeclarationName::CXXUsingDirective:
2025      break;
2026    }
2027    clang::io::Emit16(Out, KeyLen);
2028
2029    // 2 bytes for num of decls and 4 for each DeclID.
2030    unsigned DataLen = 2 + 4 * (Lookup.second - Lookup.first);
2031    clang::io::Emit16(Out, DataLen);
2032
2033    return std::make_pair(KeyLen, DataLen);
2034  }
2035
2036  void EmitKey(llvm::raw_ostream& Out, DeclarationName Name, unsigned) {
2037    using namespace clang::io;
2038
2039    assert(Name.getNameKind() < 0x100 && "Invalid name kind ?");
2040    Emit8(Out, Name.getNameKind());
2041    switch (Name.getNameKind()) {
2042    case DeclarationName::Identifier:
2043      Emit32(Out, Writer.getIdentifierRef(Name.getAsIdentifierInfo()));
2044      break;
2045    case DeclarationName::ObjCZeroArgSelector:
2046    case DeclarationName::ObjCOneArgSelector:
2047    case DeclarationName::ObjCMultiArgSelector:
2048      Emit32(Out, Writer.getSelectorRef(Name.getObjCSelector()));
2049      break;
2050    case DeclarationName::CXXConstructorName:
2051    case DeclarationName::CXXDestructorName:
2052    case DeclarationName::CXXConversionFunctionName:
2053      Emit32(Out, Writer.getTypeID(Name.getCXXNameType()));
2054      break;
2055    case DeclarationName::CXXOperatorName:
2056      assert(Name.getCXXOverloadedOperator() < 0x100 && "Invalid operator ?");
2057      Emit8(Out, Name.getCXXOverloadedOperator());
2058      break;
2059    case DeclarationName::CXXLiteralOperatorName:
2060      Emit32(Out, Writer.getIdentifierRef(Name.getCXXLiteralIdentifier()));
2061      break;
2062    case DeclarationName::CXXUsingDirective:
2063      break;
2064    }
2065  }
2066
2067  void EmitData(llvm::raw_ostream& Out, key_type_ref,
2068                data_type Lookup, unsigned DataLen) {
2069    uint64_t Start = Out.tell(); (void)Start;
2070    clang::io::Emit16(Out, Lookup.second - Lookup.first);
2071    for (; Lookup.first != Lookup.second; ++Lookup.first)
2072      clang::io::Emit32(Out, Writer.GetDeclRef(*Lookup.first));
2073
2074    assert(Out.tell() - Start == DataLen && "Data length is wrong");
2075  }
2076};
2077} // end anonymous namespace
2078
2079/// \brief Write the block containing all of the declaration IDs
2080/// visible from the given DeclContext.
2081///
2082/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
2083/// bitstream, or 0 if no block was written.
2084uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
2085                                                 DeclContext *DC) {
2086  if (DC->getPrimaryContext() != DC)
2087    return 0;
2088
2089  // Since there is no name lookup into functions or methods, don't bother to
2090  // build a visible-declarations table for these entities.
2091  if (DC->isFunctionOrMethod())
2092    return 0;
2093
2094  // If not in C++, we perform name lookup for the translation unit via the
2095  // IdentifierInfo chains, don't bother to build a visible-declarations table.
2096  // FIXME: In C++ we need the visible declarations in order to "see" the
2097  // friend declarations, is there a way to do this without writing the table ?
2098  if (DC->isTranslationUnit() && !Context.getLangOptions().CPlusPlus)
2099    return 0;
2100
2101  // Force the DeclContext to build a its name-lookup table.
2102  if (DC->hasExternalVisibleStorage())
2103    DC->MaterializeVisibleDeclsFromExternalStorage();
2104  else
2105    DC->lookup(DeclarationName());
2106
2107  // Serialize the contents of the mapping used for lookup. Note that,
2108  // although we have two very different code paths, the serialized
2109  // representation is the same for both cases: a declaration name,
2110  // followed by a size, followed by references to the visible
2111  // declarations that have that name.
2112  uint64_t Offset = Stream.GetCurrentBitNo();
2113  StoredDeclsMap *Map = static_cast<StoredDeclsMap*>(DC->getLookupPtr());
2114  if (!Map || Map->empty())
2115    return 0;
2116
2117  OnDiskChainedHashTableGenerator<ASTDeclContextNameLookupTrait> Generator;
2118  ASTDeclContextNameLookupTrait Trait(*this);
2119
2120  // Create the on-disk hash table representation.
2121  for (StoredDeclsMap::iterator D = Map->begin(), DEnd = Map->end();
2122       D != DEnd; ++D) {
2123    DeclarationName Name = D->first;
2124    DeclContext::lookup_result Result = D->second.getLookupResult();
2125    Generator.insert(Name, Result, Trait);
2126  }
2127
2128  // Create the on-disk hash table in a buffer.
2129  llvm::SmallString<4096> LookupTable;
2130  uint32_t BucketOffset;
2131  {
2132    llvm::raw_svector_ostream Out(LookupTable);
2133    // Make sure that no bucket is at offset 0
2134    clang::io::Emit32(Out, 0);
2135    BucketOffset = Generator.Emit(Out, Trait);
2136  }
2137
2138  // Write the lookup table
2139  RecordData Record;
2140  Record.push_back(DECL_CONTEXT_VISIBLE);
2141  Record.push_back(BucketOffset);
2142  Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
2143                            LookupTable.str());
2144
2145  Stream.EmitRecord(DECL_CONTEXT_VISIBLE, Record);
2146  ++NumVisibleDeclContexts;
2147  return Offset;
2148}
2149
2150/// \brief Write an UPDATE_VISIBLE block for the given context.
2151///
2152/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
2153/// DeclContext in a dependent AST file. As such, they only exist for the TU
2154/// (in C++) and for namespaces.
2155void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
2156  // Make the context build its lookup table, but don't make it load external
2157  // decls.
2158  DC->lookup(DeclarationName());
2159
2160  StoredDeclsMap *Map = static_cast<StoredDeclsMap*>(DC->getLookupPtr());
2161  if (!Map || Map->empty())
2162    return;
2163
2164  OnDiskChainedHashTableGenerator<ASTDeclContextNameLookupTrait> Generator;
2165  ASTDeclContextNameLookupTrait Trait(*this);
2166
2167  // Create the hash table.
2168  for (StoredDeclsMap::iterator D = Map->begin(), DEnd = Map->end();
2169       D != DEnd; ++D) {
2170    DeclarationName Name = D->first;
2171    DeclContext::lookup_result Result = D->second.getLookupResult();
2172    // For any name that appears in this table, the results are complete, i.e.
2173    // they overwrite results from previous PCHs. Merging is always a mess.
2174    Generator.insert(Name, Result, Trait);
2175  }
2176
2177  // Create the on-disk hash table in a buffer.
2178  llvm::SmallString<4096> LookupTable;
2179  uint32_t BucketOffset;
2180  {
2181    llvm::raw_svector_ostream Out(LookupTable);
2182    // Make sure that no bucket is at offset 0
2183    clang::io::Emit32(Out, 0);
2184    BucketOffset = Generator.Emit(Out, Trait);
2185  }
2186
2187  // Write the lookup table
2188  RecordData Record;
2189  Record.push_back(UPDATE_VISIBLE);
2190  Record.push_back(getDeclID(cast<Decl>(DC)));
2191  Record.push_back(BucketOffset);
2192  Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable.str());
2193}
2194
2195//===----------------------------------------------------------------------===//
2196// General Serialization Routines
2197//===----------------------------------------------------------------------===//
2198
2199/// \brief Write a record containing the given attributes.
2200void ASTWriter::WriteAttributes(const AttrVec &Attrs, RecordDataImpl &Record) {
2201  Record.push_back(Attrs.size());
2202  for (AttrVec::const_iterator i = Attrs.begin(), e = Attrs.end(); i != e; ++i){
2203    const Attr * A = *i;
2204    Record.push_back(A->getKind()); // FIXME: stable encoding, target attrs
2205    AddSourceLocation(A->getLocation(), Record);
2206    Record.push_back(A->isInherited());
2207
2208#include "clang/Serialization/AttrPCHWrite.inc"
2209
2210  }
2211}
2212
2213void ASTWriter::AddString(llvm::StringRef Str, RecordDataImpl &Record) {
2214  Record.push_back(Str.size());
2215  Record.insert(Record.end(), Str.begin(), Str.end());
2216}
2217
2218/// \brief Note that the identifier II occurs at the given offset
2219/// within the identifier table.
2220void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
2221  IdentID ID = IdentifierIDs[II];
2222  // Only store offsets new to this AST file. Other identifier names are looked
2223  // up earlier in the chain and thus don't need an offset.
2224  if (ID >= FirstIdentID)
2225    IdentifierOffsets[ID - FirstIdentID] = Offset;
2226}
2227
2228/// \brief Note that the selector Sel occurs at the given offset
2229/// within the method pool/selector table.
2230void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
2231  unsigned ID = SelectorIDs[Sel];
2232  assert(ID && "Unknown selector");
2233  // Don't record offsets for selectors that are also available in a different
2234  // file.
2235  if (ID < FirstSelectorID)
2236    return;
2237  SelectorOffsets[ID - FirstSelectorID] = Offset;
2238}
2239
2240ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream)
2241  : Stream(Stream), Chain(0), FirstDeclID(1), NextDeclID(FirstDeclID),
2242    FirstTypeID(NUM_PREDEF_TYPE_IDS), NextTypeID(FirstTypeID),
2243    FirstIdentID(1), NextIdentID(FirstIdentID), FirstSelectorID(1),
2244    NextSelectorID(FirstSelectorID), FirstMacroID(1), NextMacroID(FirstMacroID),
2245    CollectedStmts(&StmtsToEmit),
2246    NumStatements(0), NumMacros(0), NumLexicalDeclContexts(0),
2247    NumVisibleDeclContexts(0), FirstCXXBaseSpecifiersID(1),
2248    NextCXXBaseSpecifiersID(1)
2249{
2250}
2251
2252void ASTWriter::WriteAST(Sema &SemaRef, MemorizeStatCalls *StatCalls,
2253                         const char *isysroot) {
2254  // Emit the file header.
2255  Stream.Emit((unsigned)'C', 8);
2256  Stream.Emit((unsigned)'P', 8);
2257  Stream.Emit((unsigned)'C', 8);
2258  Stream.Emit((unsigned)'H', 8);
2259
2260  WriteBlockInfoBlock();
2261
2262  if (Chain)
2263    WriteASTChain(SemaRef, StatCalls, isysroot);
2264  else
2265    WriteASTCore(SemaRef, StatCalls, isysroot);
2266}
2267
2268void ASTWriter::WriteASTCore(Sema &SemaRef, MemorizeStatCalls *StatCalls,
2269                             const char *isysroot) {
2270  using namespace llvm;
2271
2272  ASTContext &Context = SemaRef.Context;
2273  Preprocessor &PP = SemaRef.PP;
2274
2275  // The translation unit is the first declaration we'll emit.
2276  DeclIDs[Context.getTranslationUnitDecl()] = 1;
2277  ++NextDeclID;
2278  DeclTypesToEmit.push(Context.getTranslationUnitDecl());
2279
2280  // Make sure that we emit IdentifierInfos (and any attached
2281  // declarations) for builtins.
2282  {
2283    IdentifierTable &Table = PP.getIdentifierTable();
2284    llvm::SmallVector<const char *, 32> BuiltinNames;
2285    Context.BuiltinInfo.GetBuiltinNames(BuiltinNames,
2286                                        Context.getLangOptions().NoBuiltin);
2287    for (unsigned I = 0, N = BuiltinNames.size(); I != N; ++I)
2288      getIdentifierRef(&Table.get(BuiltinNames[I]));
2289  }
2290
2291  // Build a record containing all of the tentative definitions in this file, in
2292  // TentativeDefinitions order.  Generally, this record will be empty for
2293  // headers.
2294  RecordData TentativeDefinitions;
2295  for (unsigned i = 0, e = SemaRef.TentativeDefinitions.size(); i != e; ++i) {
2296    AddDeclRef(SemaRef.TentativeDefinitions[i], TentativeDefinitions);
2297  }
2298
2299  // Build a record containing all of the file scoped decls in this file.
2300  RecordData UnusedFileScopedDecls;
2301  for (unsigned i=0, e = SemaRef.UnusedFileScopedDecls.size(); i !=e; ++i)
2302    AddDeclRef(SemaRef.UnusedFileScopedDecls[i], UnusedFileScopedDecls);
2303
2304  RecordData WeakUndeclaredIdentifiers;
2305  if (!SemaRef.WeakUndeclaredIdentifiers.empty()) {
2306    WeakUndeclaredIdentifiers.push_back(
2307                                      SemaRef.WeakUndeclaredIdentifiers.size());
2308    for (llvm::DenseMap<IdentifierInfo*,Sema::WeakInfo>::iterator
2309         I = SemaRef.WeakUndeclaredIdentifiers.begin(),
2310         E = SemaRef.WeakUndeclaredIdentifiers.end(); I != E; ++I) {
2311      AddIdentifierRef(I->first, WeakUndeclaredIdentifiers);
2312      AddIdentifierRef(I->second.getAlias(), WeakUndeclaredIdentifiers);
2313      AddSourceLocation(I->second.getLocation(), WeakUndeclaredIdentifiers);
2314      WeakUndeclaredIdentifiers.push_back(I->second.getUsed());
2315    }
2316  }
2317
2318  // Build a record containing all of the locally-scoped external
2319  // declarations in this header file. Generally, this record will be
2320  // empty.
2321  RecordData LocallyScopedExternalDecls;
2322  // FIXME: This is filling in the AST file in densemap order which is
2323  // nondeterminstic!
2324  for (llvm::DenseMap<DeclarationName, NamedDecl *>::iterator
2325         TD = SemaRef.LocallyScopedExternalDecls.begin(),
2326         TDEnd = SemaRef.LocallyScopedExternalDecls.end();
2327       TD != TDEnd; ++TD)
2328    AddDeclRef(TD->second, LocallyScopedExternalDecls);
2329
2330  // Build a record containing all of the ext_vector declarations.
2331  RecordData ExtVectorDecls;
2332  for (unsigned I = 0, N = SemaRef.ExtVectorDecls.size(); I != N; ++I)
2333    AddDeclRef(SemaRef.ExtVectorDecls[I], ExtVectorDecls);
2334
2335  // Build a record containing all of the VTable uses information.
2336  RecordData VTableUses;
2337  if (!SemaRef.VTableUses.empty()) {
2338    VTableUses.push_back(SemaRef.VTableUses.size());
2339    for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
2340      AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
2341      AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
2342      VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
2343    }
2344  }
2345
2346  // Build a record containing all of dynamic classes declarations.
2347  RecordData DynamicClasses;
2348  for (unsigned I = 0, N = SemaRef.DynamicClasses.size(); I != N; ++I)
2349    AddDeclRef(SemaRef.DynamicClasses[I], DynamicClasses);
2350
2351  // Build a record containing all of pending implicit instantiations.
2352  RecordData PendingInstantiations;
2353  for (std::deque<Sema::PendingImplicitInstantiation>::iterator
2354         I = SemaRef.PendingInstantiations.begin(),
2355         N = SemaRef.PendingInstantiations.end(); I != N; ++I) {
2356    AddDeclRef(I->first, PendingInstantiations);
2357    AddSourceLocation(I->second, PendingInstantiations);
2358  }
2359  assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
2360         "There are local ones at end of translation unit!");
2361
2362  // Build a record containing some declaration references.
2363  RecordData SemaDeclRefs;
2364  if (SemaRef.StdNamespace || SemaRef.StdBadAlloc) {
2365    AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
2366    AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
2367  }
2368
2369  // Write the remaining AST contents.
2370  RecordData Record;
2371  Stream.EnterSubblock(AST_BLOCK_ID, 5);
2372  WriteMetadata(Context, isysroot);
2373  WriteLanguageOptions(Context.getLangOptions());
2374  if (StatCalls && !isysroot)
2375    WriteStatCache(*StatCalls);
2376  WriteSourceManagerBlock(Context.getSourceManager(), PP, isysroot);
2377  // Write the record of special types.
2378  Record.clear();
2379
2380  AddTypeRef(Context.getBuiltinVaListType(), Record);
2381  AddTypeRef(Context.getObjCIdType(), Record);
2382  AddTypeRef(Context.getObjCSelType(), Record);
2383  AddTypeRef(Context.getObjCProtoType(), Record);
2384  AddTypeRef(Context.getObjCClassType(), Record);
2385  AddTypeRef(Context.getRawCFConstantStringType(), Record);
2386  AddTypeRef(Context.getRawObjCFastEnumerationStateType(), Record);
2387  AddTypeRef(Context.getFILEType(), Record);
2388  AddTypeRef(Context.getjmp_bufType(), Record);
2389  AddTypeRef(Context.getsigjmp_bufType(), Record);
2390  AddTypeRef(Context.ObjCIdRedefinitionType, Record);
2391  AddTypeRef(Context.ObjCClassRedefinitionType, Record);
2392  AddTypeRef(Context.getRawBlockdescriptorType(), Record);
2393  AddTypeRef(Context.getRawBlockdescriptorExtendedType(), Record);
2394  AddTypeRef(Context.ObjCSelRedefinitionType, Record);
2395  AddTypeRef(Context.getRawNSConstantStringType(), Record);
2396  Record.push_back(Context.isInt128Installed());
2397  Stream.EmitRecord(SPECIAL_TYPES, Record);
2398
2399  // Keep writing types and declarations until all types and
2400  // declarations have been written.
2401  Stream.EnterSubblock(DECLTYPES_BLOCK_ID, 3);
2402  WriteDeclsBlockAbbrevs();
2403  while (!DeclTypesToEmit.empty()) {
2404    DeclOrType DOT = DeclTypesToEmit.front();
2405    DeclTypesToEmit.pop();
2406    if (DOT.isType())
2407      WriteType(DOT.getType());
2408    else
2409      WriteDecl(Context, DOT.getDecl());
2410  }
2411  Stream.ExitBlock();
2412
2413  WritePreprocessor(PP);
2414  WriteSelectors(SemaRef);
2415  WriteReferencedSelectorsPool(SemaRef);
2416  WriteIdentifierTable(PP);
2417
2418  WriteTypeDeclOffsets();
2419  WriteUserDiagnosticMappings(Context.getDiagnostics());
2420
2421  // Write the C++ base-specifier set offsets.
2422  if (!CXXBaseSpecifiersOffsets.empty()) {
2423    // Create a blob abbreviation for the C++ base specifiers offsets.
2424    using namespace llvm;
2425
2426    BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2427    Abbrev->Add(BitCodeAbbrevOp(CXX_BASE_SPECIFIER_OFFSETS));
2428    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
2429    Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2430    unsigned BaseSpecifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2431
2432    // Write the selector offsets table.
2433    Record.clear();
2434    Record.push_back(CXX_BASE_SPECIFIER_OFFSETS);
2435    Record.push_back(CXXBaseSpecifiersOffsets.size());
2436    Stream.EmitRecordWithBlob(BaseSpecifierOffsetAbbrev, Record,
2437                              (const char *)CXXBaseSpecifiersOffsets.data(),
2438                            CXXBaseSpecifiersOffsets.size() * sizeof(uint32_t));
2439  }
2440
2441  // Write the record containing external, unnamed definitions.
2442  if (!ExternalDefinitions.empty())
2443    Stream.EmitRecord(EXTERNAL_DEFINITIONS, ExternalDefinitions);
2444
2445  // Write the record containing tentative definitions.
2446  if (!TentativeDefinitions.empty())
2447    Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
2448
2449  // Write the record containing unused file scoped decls.
2450  if (!UnusedFileScopedDecls.empty())
2451    Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
2452
2453  // Write the record containing weak undeclared identifiers.
2454  if (!WeakUndeclaredIdentifiers.empty())
2455    Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
2456                      WeakUndeclaredIdentifiers);
2457
2458  // Write the record containing locally-scoped external definitions.
2459  if (!LocallyScopedExternalDecls.empty())
2460    Stream.EmitRecord(LOCALLY_SCOPED_EXTERNAL_DECLS,
2461                      LocallyScopedExternalDecls);
2462
2463  // Write the record containing ext_vector type names.
2464  if (!ExtVectorDecls.empty())
2465    Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
2466
2467  // Write the record containing VTable uses information.
2468  if (!VTableUses.empty())
2469    Stream.EmitRecord(VTABLE_USES, VTableUses);
2470
2471  // Write the record containing dynamic classes declarations.
2472  if (!DynamicClasses.empty())
2473    Stream.EmitRecord(DYNAMIC_CLASSES, DynamicClasses);
2474
2475  // Write the record containing pending implicit instantiations.
2476  if (!PendingInstantiations.empty())
2477    Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
2478
2479  // Write the record containing declaration references of Sema.
2480  if (!SemaDeclRefs.empty())
2481    Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
2482
2483  // Some simple statistics
2484  Record.clear();
2485  Record.push_back(NumStatements);
2486  Record.push_back(NumMacros);
2487  Record.push_back(NumLexicalDeclContexts);
2488  Record.push_back(NumVisibleDeclContexts);
2489  Stream.EmitRecord(STATISTICS, Record);
2490  Stream.ExitBlock();
2491}
2492
2493void ASTWriter::WriteASTChain(Sema &SemaRef, MemorizeStatCalls *StatCalls,
2494                              const char *isysroot) {
2495  using namespace llvm;
2496
2497  ASTContext &Context = SemaRef.Context;
2498  Preprocessor &PP = SemaRef.PP;
2499
2500  RecordData Record;
2501  Stream.EnterSubblock(AST_BLOCK_ID, 5);
2502  WriteMetadata(Context, isysroot);
2503  if (StatCalls && !isysroot)
2504    WriteStatCache(*StatCalls);
2505  // FIXME: Source manager block should only write new stuff, which could be
2506  // done by tracking the largest ID in the chain
2507  WriteSourceManagerBlock(Context.getSourceManager(), PP, isysroot);
2508
2509  // The special types are in the chained PCH.
2510
2511  // We don't start with the translation unit, but with its decls that
2512  // don't come from the chained PCH.
2513  const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
2514  llvm::SmallVector<KindDeclIDPair, 64> NewGlobalDecls;
2515  for (DeclContext::decl_iterator I = TU->noload_decls_begin(),
2516                                  E = TU->noload_decls_end();
2517       I != E; ++I) {
2518    if ((*I)->getPCHLevel() == 0)
2519      NewGlobalDecls.push_back(std::make_pair((*I)->getKind(), GetDeclRef(*I)));
2520    else if ((*I)->isChangedSinceDeserialization())
2521      (void)GetDeclRef(*I); // Make sure it's written, but don't record it.
2522  }
2523  // We also need to write a lexical updates block for the TU.
2524  llvm::BitCodeAbbrev *Abv = new llvm::BitCodeAbbrev();
2525  Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
2526  Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
2527  unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(Abv);
2528  Record.clear();
2529  Record.push_back(TU_UPDATE_LEXICAL);
2530  Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
2531                          reinterpret_cast<const char*>(NewGlobalDecls.data()),
2532                          NewGlobalDecls.size() * sizeof(KindDeclIDPair));
2533  // And a visible updates block for the DeclContexts.
2534  Abv = new llvm::BitCodeAbbrev();
2535  Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
2536  Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
2537  Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed, 32));
2538  Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
2539  UpdateVisibleAbbrev = Stream.EmitAbbrev(Abv);
2540  WriteDeclContextVisibleUpdate(TU);
2541
2542  // Build a record containing all of the new tentative definitions in this
2543  // file, in TentativeDefinitions order.
2544  RecordData TentativeDefinitions;
2545  for (unsigned i = 0, e = SemaRef.TentativeDefinitions.size(); i != e; ++i) {
2546    if (SemaRef.TentativeDefinitions[i]->getPCHLevel() == 0)
2547      AddDeclRef(SemaRef.TentativeDefinitions[i], TentativeDefinitions);
2548  }
2549
2550  // Build a record containing all of the file scoped decls in this file.
2551  RecordData UnusedFileScopedDecls;
2552  for (unsigned i=0, e = SemaRef.UnusedFileScopedDecls.size(); i !=e; ++i) {
2553    if (SemaRef.UnusedFileScopedDecls[i]->getPCHLevel() == 0)
2554      AddDeclRef(SemaRef.UnusedFileScopedDecls[i], UnusedFileScopedDecls);
2555  }
2556
2557  // We write the entire table, overwriting the tables from the chain.
2558  RecordData WeakUndeclaredIdentifiers;
2559  if (!SemaRef.WeakUndeclaredIdentifiers.empty()) {
2560    WeakUndeclaredIdentifiers.push_back(
2561                                      SemaRef.WeakUndeclaredIdentifiers.size());
2562    for (llvm::DenseMap<IdentifierInfo*,Sema::WeakInfo>::iterator
2563         I = SemaRef.WeakUndeclaredIdentifiers.begin(),
2564         E = SemaRef.WeakUndeclaredIdentifiers.end(); I != E; ++I) {
2565      AddIdentifierRef(I->first, WeakUndeclaredIdentifiers);
2566      AddIdentifierRef(I->second.getAlias(), WeakUndeclaredIdentifiers);
2567      AddSourceLocation(I->second.getLocation(), WeakUndeclaredIdentifiers);
2568      WeakUndeclaredIdentifiers.push_back(I->second.getUsed());
2569    }
2570  }
2571
2572  // Build a record containing all of the locally-scoped external
2573  // declarations in this header file. Generally, this record will be
2574  // empty.
2575  RecordData LocallyScopedExternalDecls;
2576  // FIXME: This is filling in the AST file in densemap order which is
2577  // nondeterminstic!
2578  for (llvm::DenseMap<DeclarationName, NamedDecl *>::iterator
2579         TD = SemaRef.LocallyScopedExternalDecls.begin(),
2580         TDEnd = SemaRef.LocallyScopedExternalDecls.end();
2581       TD != TDEnd; ++TD) {
2582    if (TD->second->getPCHLevel() == 0)
2583      AddDeclRef(TD->second, LocallyScopedExternalDecls);
2584  }
2585
2586  // Build a record containing all of the ext_vector declarations.
2587  RecordData ExtVectorDecls;
2588  for (unsigned I = 0, N = SemaRef.ExtVectorDecls.size(); I != N; ++I) {
2589    if (SemaRef.ExtVectorDecls[I]->getPCHLevel() == 0)
2590      AddDeclRef(SemaRef.ExtVectorDecls[I], ExtVectorDecls);
2591  }
2592
2593  // Build a record containing all of the VTable uses information.
2594  // We write everything here, because it's too hard to determine whether
2595  // a use is new to this part.
2596  RecordData VTableUses;
2597  if (!SemaRef.VTableUses.empty()) {
2598    VTableUses.push_back(SemaRef.VTableUses.size());
2599    for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
2600      AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
2601      AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
2602      VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
2603    }
2604  }
2605
2606  // Build a record containing all of dynamic classes declarations.
2607  RecordData DynamicClasses;
2608  for (unsigned I = 0, N = SemaRef.DynamicClasses.size(); I != N; ++I)
2609    if (SemaRef.DynamicClasses[I]->getPCHLevel() == 0)
2610      AddDeclRef(SemaRef.DynamicClasses[I], DynamicClasses);
2611
2612  // Build a record containing all of pending implicit instantiations.
2613  RecordData PendingInstantiations;
2614  for (std::deque<Sema::PendingImplicitInstantiation>::iterator
2615         I = SemaRef.PendingInstantiations.begin(),
2616         N = SemaRef.PendingInstantiations.end(); I != N; ++I) {
2617    if (I->first->getPCHLevel() == 0) {
2618      AddDeclRef(I->first, PendingInstantiations);
2619      AddSourceLocation(I->second, PendingInstantiations);
2620    }
2621  }
2622  assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
2623         "There are local ones at end of translation unit!");
2624
2625  // Build a record containing some declaration references.
2626  // It's not worth the effort to avoid duplication here.
2627  RecordData SemaDeclRefs;
2628  if (SemaRef.StdNamespace || SemaRef.StdBadAlloc) {
2629    AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
2630    AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
2631  }
2632
2633  Stream.EnterSubblock(DECLTYPES_BLOCK_ID, 3);
2634  WriteDeclsBlockAbbrevs();
2635  for (DeclsToRewriteTy::iterator
2636         I = DeclsToRewrite.begin(), E = DeclsToRewrite.end(); I != E; ++I)
2637    DeclTypesToEmit.push(const_cast<Decl*>(*I));
2638  while (!DeclTypesToEmit.empty()) {
2639    DeclOrType DOT = DeclTypesToEmit.front();
2640    DeclTypesToEmit.pop();
2641    if (DOT.isType())
2642      WriteType(DOT.getType());
2643    else
2644      WriteDecl(Context, DOT.getDecl());
2645  }
2646  Stream.ExitBlock();
2647
2648  WritePreprocessor(PP);
2649  WriteSelectors(SemaRef);
2650  WriteReferencedSelectorsPool(SemaRef);
2651  WriteIdentifierTable(PP);
2652  WriteTypeDeclOffsets();
2653  // FIXME: For chained PCH only write the new mappings (we currently
2654  // write all of them again).
2655  WriteUserDiagnosticMappings(Context.getDiagnostics());
2656
2657  /// Build a record containing first declarations from a chained PCH and the
2658  /// most recent declarations in this AST that they point to.
2659  RecordData FirstLatestDeclIDs;
2660  for (FirstLatestDeclMap::iterator
2661        I = FirstLatestDecls.begin(), E = FirstLatestDecls.end(); I != E; ++I) {
2662    assert(I->first->getPCHLevel() > I->second->getPCHLevel() &&
2663           "Expected first & second to be in different PCHs");
2664    AddDeclRef(I->first, FirstLatestDeclIDs);
2665    AddDeclRef(I->second, FirstLatestDeclIDs);
2666  }
2667  if (!FirstLatestDeclIDs.empty())
2668    Stream.EmitRecord(REDECLS_UPDATE_LATEST, FirstLatestDeclIDs);
2669
2670  // Write the record containing external, unnamed definitions.
2671  if (!ExternalDefinitions.empty())
2672    Stream.EmitRecord(EXTERNAL_DEFINITIONS, ExternalDefinitions);
2673
2674  // Write the record containing tentative definitions.
2675  if (!TentativeDefinitions.empty())
2676    Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
2677
2678  // Write the record containing unused file scoped decls.
2679  if (!UnusedFileScopedDecls.empty())
2680    Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
2681
2682  // Write the record containing weak undeclared identifiers.
2683  if (!WeakUndeclaredIdentifiers.empty())
2684    Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
2685                      WeakUndeclaredIdentifiers);
2686
2687  // Write the record containing locally-scoped external definitions.
2688  if (!LocallyScopedExternalDecls.empty())
2689    Stream.EmitRecord(LOCALLY_SCOPED_EXTERNAL_DECLS,
2690                      LocallyScopedExternalDecls);
2691
2692  // Write the record containing ext_vector type names.
2693  if (!ExtVectorDecls.empty())
2694    Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
2695
2696  // Write the record containing VTable uses information.
2697  if (!VTableUses.empty())
2698    Stream.EmitRecord(VTABLE_USES, VTableUses);
2699
2700  // Write the record containing dynamic classes declarations.
2701  if (!DynamicClasses.empty())
2702    Stream.EmitRecord(DYNAMIC_CLASSES, DynamicClasses);
2703
2704  // Write the record containing pending implicit instantiations.
2705  if (!PendingInstantiations.empty())
2706    Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
2707
2708  // Write the record containing declaration references of Sema.
2709  if (!SemaDeclRefs.empty())
2710    Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
2711
2712  // Write the updates to DeclContexts.
2713  for (llvm::SmallPtrSet<const DeclContext *, 16>::iterator
2714           I = UpdatedDeclContexts.begin(),
2715           E = UpdatedDeclContexts.end();
2716         I != E; ++I)
2717    WriteDeclContextVisibleUpdate(*I);
2718
2719  WriteDeclUpdatesBlocks();
2720
2721  Record.clear();
2722  Record.push_back(NumStatements);
2723  Record.push_back(NumMacros);
2724  Record.push_back(NumLexicalDeclContexts);
2725  Record.push_back(NumVisibleDeclContexts);
2726  WriteDeclReplacementsBlock();
2727  Stream.EmitRecord(STATISTICS, Record);
2728  Stream.ExitBlock();
2729}
2730
2731void ASTWriter::WriteDeclUpdatesBlocks() {
2732  if (DeclUpdates.empty())
2733    return;
2734
2735  RecordData OffsetsRecord;
2736  Stream.EnterSubblock(DECL_UPDATES_BLOCK_ID, 3);
2737  for (DeclUpdateMap::iterator
2738         I = DeclUpdates.begin(), E = DeclUpdates.end(); I != E; ++I) {
2739    const Decl *D = I->first;
2740    UpdateRecord &URec = I->second;
2741
2742    if (DeclsToRewrite.count(D))
2743      continue; // The decl will be written completely,no need to store updates.
2744
2745    uint64_t Offset = Stream.GetCurrentBitNo();
2746    Stream.EmitRecord(DECL_UPDATES, URec);
2747
2748    OffsetsRecord.push_back(GetDeclRef(D));
2749    OffsetsRecord.push_back(Offset);
2750  }
2751  Stream.ExitBlock();
2752  Stream.EmitRecord(DECL_UPDATE_OFFSETS, OffsetsRecord);
2753}
2754
2755void ASTWriter::WriteDeclReplacementsBlock() {
2756  if (ReplacedDecls.empty())
2757    return;
2758
2759  RecordData Record;
2760  for (llvm::SmallVector<std::pair<DeclID, uint64_t>, 16>::iterator
2761           I = ReplacedDecls.begin(), E = ReplacedDecls.end(); I != E; ++I) {
2762    Record.push_back(I->first);
2763    Record.push_back(I->second);
2764  }
2765  Stream.EmitRecord(DECL_REPLACEMENTS, Record);
2766}
2767
2768void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
2769  Record.push_back(Loc.getRawEncoding());
2770}
2771
2772void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
2773  AddSourceLocation(Range.getBegin(), Record);
2774  AddSourceLocation(Range.getEnd(), Record);
2775}
2776
2777void ASTWriter::AddAPInt(const llvm::APInt &Value, RecordDataImpl &Record) {
2778  Record.push_back(Value.getBitWidth());
2779  const uint64_t *Words = Value.getRawData();
2780  Record.append(Words, Words + Value.getNumWords());
2781}
2782
2783void ASTWriter::AddAPSInt(const llvm::APSInt &Value, RecordDataImpl &Record) {
2784  Record.push_back(Value.isUnsigned());
2785  AddAPInt(Value, Record);
2786}
2787
2788void ASTWriter::AddAPFloat(const llvm::APFloat &Value, RecordDataImpl &Record) {
2789  AddAPInt(Value.bitcastToAPInt(), Record);
2790}
2791
2792void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
2793  Record.push_back(getIdentifierRef(II));
2794}
2795
2796IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
2797  if (II == 0)
2798    return 0;
2799
2800  IdentID &ID = IdentifierIDs[II];
2801  if (ID == 0)
2802    ID = NextIdentID++;
2803  return ID;
2804}
2805
2806MacroID ASTWriter::getMacroDefinitionID(MacroDefinition *MD) {
2807  if (MD == 0)
2808    return 0;
2809
2810  MacroID &ID = MacroDefinitions[MD];
2811  if (ID == 0)
2812    ID = NextMacroID++;
2813  return ID;
2814}
2815
2816void ASTWriter::AddSelectorRef(const Selector SelRef, RecordDataImpl &Record) {
2817  Record.push_back(getSelectorRef(SelRef));
2818}
2819
2820SelectorID ASTWriter::getSelectorRef(Selector Sel) {
2821  if (Sel.getAsOpaquePtr() == 0) {
2822    return 0;
2823  }
2824
2825  SelectorID &SID = SelectorIDs[Sel];
2826  if (SID == 0 && Chain) {
2827    // This might trigger a ReadSelector callback, which will set the ID for
2828    // this selector.
2829    Chain->LoadSelector(Sel);
2830  }
2831  if (SID == 0) {
2832    SID = NextSelectorID++;
2833  }
2834  return SID;
2835}
2836
2837void ASTWriter::AddCXXTemporary(const CXXTemporary *Temp, RecordDataImpl &Record) {
2838  AddDeclRef(Temp->getDestructor(), Record);
2839}
2840
2841void ASTWriter::AddCXXBaseSpecifiersRef(CXXBaseSpecifier const *Bases,
2842                                      CXXBaseSpecifier const *BasesEnd,
2843                                        RecordDataImpl &Record) {
2844  assert(Bases != BasesEnd && "Empty base-specifier sets are not recorded");
2845  CXXBaseSpecifiersToWrite.push_back(
2846                                QueuedCXXBaseSpecifiers(NextCXXBaseSpecifiersID,
2847                                                        Bases, BasesEnd));
2848  Record.push_back(NextCXXBaseSpecifiersID++);
2849}
2850
2851void ASTWriter::AddTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind,
2852                                           const TemplateArgumentLocInfo &Arg,
2853                                           RecordDataImpl &Record) {
2854  switch (Kind) {
2855  case TemplateArgument::Expression:
2856    AddStmt(Arg.getAsExpr());
2857    break;
2858  case TemplateArgument::Type:
2859    AddTypeSourceInfo(Arg.getAsTypeSourceInfo(), Record);
2860    break;
2861  case TemplateArgument::Template:
2862    AddSourceRange(Arg.getTemplateQualifierRange(), Record);
2863    AddSourceLocation(Arg.getTemplateNameLoc(), Record);
2864    break;
2865  case TemplateArgument::Null:
2866  case TemplateArgument::Integral:
2867  case TemplateArgument::Declaration:
2868  case TemplateArgument::Pack:
2869    break;
2870  }
2871}
2872
2873void ASTWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg,
2874                                       RecordDataImpl &Record) {
2875  AddTemplateArgument(Arg.getArgument(), Record);
2876
2877  if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
2878    bool InfoHasSameExpr
2879      = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
2880    Record.push_back(InfoHasSameExpr);
2881    if (InfoHasSameExpr)
2882      return; // Avoid storing the same expr twice.
2883  }
2884  AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo(),
2885                             Record);
2886}
2887
2888void ASTWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo, RecordDataImpl &Record) {
2889  if (TInfo == 0) {
2890    AddTypeRef(QualType(), Record);
2891    return;
2892  }
2893
2894  AddTypeRef(TInfo->getType(), Record);
2895  TypeLocWriter TLW(*this, Record);
2896  for (TypeLoc TL = TInfo->getTypeLoc(); !TL.isNull(); TL = TL.getNextTypeLoc())
2897    TLW.Visit(TL);
2898}
2899
2900void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
2901  Record.push_back(GetOrCreateTypeID(T));
2902}
2903
2904TypeID ASTWriter::GetOrCreateTypeID(QualType T) {
2905  return MakeTypeID(T,
2906              std::bind1st(std::mem_fun(&ASTWriter::GetOrCreateTypeIdx), this));
2907}
2908
2909TypeID ASTWriter::getTypeID(QualType T) const {
2910  return MakeTypeID(T,
2911              std::bind1st(std::mem_fun(&ASTWriter::getTypeIdx), this));
2912}
2913
2914TypeIdx ASTWriter::GetOrCreateTypeIdx(QualType T) {
2915  if (T.isNull())
2916    return TypeIdx();
2917  assert(!T.getLocalFastQualifiers());
2918
2919  TypeIdx &Idx = TypeIdxs[T];
2920  if (Idx.getIndex() == 0) {
2921    // We haven't seen this type before. Assign it a new ID and put it
2922    // into the queue of types to emit.
2923    Idx = TypeIdx(NextTypeID++);
2924    DeclTypesToEmit.push(T);
2925  }
2926  return Idx;
2927}
2928
2929TypeIdx ASTWriter::getTypeIdx(QualType T) const {
2930  if (T.isNull())
2931    return TypeIdx();
2932  assert(!T.getLocalFastQualifiers());
2933
2934  TypeIdxMap::const_iterator I = TypeIdxs.find(T);
2935  assert(I != TypeIdxs.end() && "Type not emitted!");
2936  return I->second;
2937}
2938
2939void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
2940  Record.push_back(GetDeclRef(D));
2941}
2942
2943DeclID ASTWriter::GetDeclRef(const Decl *D) {
2944  if (D == 0) {
2945    return 0;
2946  }
2947  assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
2948  DeclID &ID = DeclIDs[D];
2949  if (ID == 0) {
2950    // We haven't seen this declaration before. Give it a new ID and
2951    // enqueue it in the list of declarations to emit.
2952    ID = NextDeclID++;
2953    DeclTypesToEmit.push(const_cast<Decl *>(D));
2954  } else if (ID < FirstDeclID && D->isChangedSinceDeserialization()) {
2955    // We don't add it to the replacement collection here, because we don't
2956    // have the offset yet.
2957    DeclTypesToEmit.push(const_cast<Decl *>(D));
2958    // Reset the flag, so that we don't add this decl multiple times.
2959    const_cast<Decl *>(D)->setChangedSinceDeserialization(false);
2960  }
2961
2962  return ID;
2963}
2964
2965DeclID ASTWriter::getDeclID(const Decl *D) {
2966  if (D == 0)
2967    return 0;
2968
2969  assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
2970  return DeclIDs[D];
2971}
2972
2973void ASTWriter::AddDeclarationName(DeclarationName Name, RecordDataImpl &Record) {
2974  // FIXME: Emit a stable enum for NameKind.  0 = Identifier etc.
2975  Record.push_back(Name.getNameKind());
2976  switch (Name.getNameKind()) {
2977  case DeclarationName::Identifier:
2978    AddIdentifierRef(Name.getAsIdentifierInfo(), Record);
2979    break;
2980
2981  case DeclarationName::ObjCZeroArgSelector:
2982  case DeclarationName::ObjCOneArgSelector:
2983  case DeclarationName::ObjCMultiArgSelector:
2984    AddSelectorRef(Name.getObjCSelector(), Record);
2985    break;
2986
2987  case DeclarationName::CXXConstructorName:
2988  case DeclarationName::CXXDestructorName:
2989  case DeclarationName::CXXConversionFunctionName:
2990    AddTypeRef(Name.getCXXNameType(), Record);
2991    break;
2992
2993  case DeclarationName::CXXOperatorName:
2994    Record.push_back(Name.getCXXOverloadedOperator());
2995    break;
2996
2997  case DeclarationName::CXXLiteralOperatorName:
2998    AddIdentifierRef(Name.getCXXLiteralIdentifier(), Record);
2999    break;
3000
3001  case DeclarationName::CXXUsingDirective:
3002    // No extra data to emit
3003    break;
3004  }
3005}
3006
3007void ASTWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
3008                                     DeclarationName Name, RecordDataImpl &Record) {
3009  switch (Name.getNameKind()) {
3010  case DeclarationName::CXXConstructorName:
3011  case DeclarationName::CXXDestructorName:
3012  case DeclarationName::CXXConversionFunctionName:
3013    AddTypeSourceInfo(DNLoc.NamedType.TInfo, Record);
3014    break;
3015
3016  case DeclarationName::CXXOperatorName:
3017    AddSourceLocation(
3018       SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.BeginOpNameLoc),
3019       Record);
3020    AddSourceLocation(
3021        SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc),
3022        Record);
3023    break;
3024
3025  case DeclarationName::CXXLiteralOperatorName:
3026    AddSourceLocation(
3027     SourceLocation::getFromRawEncoding(DNLoc.CXXLiteralOperatorName.OpNameLoc),
3028     Record);
3029    break;
3030
3031  case DeclarationName::Identifier:
3032  case DeclarationName::ObjCZeroArgSelector:
3033  case DeclarationName::ObjCOneArgSelector:
3034  case DeclarationName::ObjCMultiArgSelector:
3035  case DeclarationName::CXXUsingDirective:
3036    break;
3037  }
3038}
3039
3040void ASTWriter::AddDeclarationNameInfo(const DeclarationNameInfo &NameInfo,
3041                                       RecordDataImpl &Record) {
3042  AddDeclarationName(NameInfo.getName(), Record);
3043  AddSourceLocation(NameInfo.getLoc(), Record);
3044  AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName(), Record);
3045}
3046
3047void ASTWriter::AddQualifierInfo(const QualifierInfo &Info,
3048                                 RecordDataImpl &Record) {
3049  AddNestedNameSpecifier(Info.NNS, Record);
3050  AddSourceRange(Info.NNSRange, Record);
3051  Record.push_back(Info.NumTemplParamLists);
3052  for (unsigned i=0, e=Info.NumTemplParamLists; i != e; ++i)
3053    AddTemplateParameterList(Info.TemplParamLists[i], Record);
3054}
3055
3056void ASTWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS,
3057                                       RecordDataImpl &Record) {
3058  // Nested name specifiers usually aren't too long. I think that 8 would
3059  // typically accomodate the vast majority.
3060  llvm::SmallVector<NestedNameSpecifier *, 8> NestedNames;
3061
3062  // Push each of the NNS's onto a stack for serialization in reverse order.
3063  while (NNS) {
3064    NestedNames.push_back(NNS);
3065    NNS = NNS->getPrefix();
3066  }
3067
3068  Record.push_back(NestedNames.size());
3069  while(!NestedNames.empty()) {
3070    NNS = NestedNames.pop_back_val();
3071    NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
3072    Record.push_back(Kind);
3073    switch (Kind) {
3074    case NestedNameSpecifier::Identifier:
3075      AddIdentifierRef(NNS->getAsIdentifier(), Record);
3076      break;
3077
3078    case NestedNameSpecifier::Namespace:
3079      AddDeclRef(NNS->getAsNamespace(), Record);
3080      break;
3081
3082    case NestedNameSpecifier::TypeSpec:
3083    case NestedNameSpecifier::TypeSpecWithTemplate:
3084      AddTypeRef(QualType(NNS->getAsType(), 0), Record);
3085      Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
3086      break;
3087
3088    case NestedNameSpecifier::Global:
3089      // Don't need to write an associated value.
3090      break;
3091    }
3092  }
3093}
3094
3095void ASTWriter::AddTemplateName(TemplateName Name, RecordDataImpl &Record) {
3096  TemplateName::NameKind Kind = Name.getKind();
3097  Record.push_back(Kind);
3098  switch (Kind) {
3099  case TemplateName::Template:
3100    AddDeclRef(Name.getAsTemplateDecl(), Record);
3101    break;
3102
3103  case TemplateName::OverloadedTemplate: {
3104    OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
3105    Record.push_back(OvT->size());
3106    for (OverloadedTemplateStorage::iterator I = OvT->begin(), E = OvT->end();
3107           I != E; ++I)
3108      AddDeclRef(*I, Record);
3109    break;
3110  }
3111
3112  case TemplateName::QualifiedTemplate: {
3113    QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
3114    AddNestedNameSpecifier(QualT->getQualifier(), Record);
3115    Record.push_back(QualT->hasTemplateKeyword());
3116    AddDeclRef(QualT->getTemplateDecl(), Record);
3117    break;
3118  }
3119
3120  case TemplateName::DependentTemplate: {
3121    DependentTemplateName *DepT = Name.getAsDependentTemplateName();
3122    AddNestedNameSpecifier(DepT->getQualifier(), Record);
3123    Record.push_back(DepT->isIdentifier());
3124    if (DepT->isIdentifier())
3125      AddIdentifierRef(DepT->getIdentifier(), Record);
3126    else
3127      Record.push_back(DepT->getOperator());
3128    break;
3129  }
3130  }
3131}
3132
3133void ASTWriter::AddTemplateArgument(const TemplateArgument &Arg,
3134                                    RecordDataImpl &Record) {
3135  Record.push_back(Arg.getKind());
3136  switch (Arg.getKind()) {
3137  case TemplateArgument::Null:
3138    break;
3139  case TemplateArgument::Type:
3140    AddTypeRef(Arg.getAsType(), Record);
3141    break;
3142  case TemplateArgument::Declaration:
3143    AddDeclRef(Arg.getAsDecl(), Record);
3144    break;
3145  case TemplateArgument::Integral:
3146    AddAPSInt(*Arg.getAsIntegral(), Record);
3147    AddTypeRef(Arg.getIntegralType(), Record);
3148    break;
3149  case TemplateArgument::Template:
3150    AddTemplateName(Arg.getAsTemplate(), Record);
3151    break;
3152  case TemplateArgument::Expression:
3153    AddStmt(Arg.getAsExpr());
3154    break;
3155  case TemplateArgument::Pack:
3156    Record.push_back(Arg.pack_size());
3157    for (TemplateArgument::pack_iterator I=Arg.pack_begin(), E=Arg.pack_end();
3158           I != E; ++I)
3159      AddTemplateArgument(*I, Record);
3160    break;
3161  }
3162}
3163
3164void
3165ASTWriter::AddTemplateParameterList(const TemplateParameterList *TemplateParams,
3166                                    RecordDataImpl &Record) {
3167  assert(TemplateParams && "No TemplateParams!");
3168  AddSourceLocation(TemplateParams->getTemplateLoc(), Record);
3169  AddSourceLocation(TemplateParams->getLAngleLoc(), Record);
3170  AddSourceLocation(TemplateParams->getRAngleLoc(), Record);
3171  Record.push_back(TemplateParams->size());
3172  for (TemplateParameterList::const_iterator
3173         P = TemplateParams->begin(), PEnd = TemplateParams->end();
3174         P != PEnd; ++P)
3175    AddDeclRef(*P, Record);
3176}
3177
3178/// \brief Emit a template argument list.
3179void
3180ASTWriter::AddTemplateArgumentList(const TemplateArgumentList *TemplateArgs,
3181                                   RecordDataImpl &Record) {
3182  assert(TemplateArgs && "No TemplateArgs!");
3183  Record.push_back(TemplateArgs->size());
3184  for (int i=0, e = TemplateArgs->size(); i != e; ++i)
3185    AddTemplateArgument(TemplateArgs->get(i), Record);
3186}
3187
3188
3189void
3190ASTWriter::AddUnresolvedSet(const UnresolvedSetImpl &Set, RecordDataImpl &Record) {
3191  Record.push_back(Set.size());
3192  for (UnresolvedSetImpl::const_iterator
3193         I = Set.begin(), E = Set.end(); I != E; ++I) {
3194    AddDeclRef(I.getDecl(), Record);
3195    Record.push_back(I.getAccess());
3196  }
3197}
3198
3199void ASTWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base,
3200                                    RecordDataImpl &Record) {
3201  Record.push_back(Base.isVirtual());
3202  Record.push_back(Base.isBaseOfClass());
3203  Record.push_back(Base.getAccessSpecifierAsWritten());
3204  AddTypeSourceInfo(Base.getTypeSourceInfo(), Record);
3205  AddSourceRange(Base.getSourceRange(), Record);
3206}
3207
3208void ASTWriter::FlushCXXBaseSpecifiers() {
3209  RecordData Record;
3210  for (unsigned I = 0, N = CXXBaseSpecifiersToWrite.size(); I != N; ++I) {
3211    Record.clear();
3212
3213    // Record the offset of this base-specifier set.
3214    unsigned Index = CXXBaseSpecifiersToWrite[I].ID - FirstCXXBaseSpecifiersID;
3215    if (Index == CXXBaseSpecifiersOffsets.size())
3216      CXXBaseSpecifiersOffsets.push_back(Stream.GetCurrentBitNo());
3217    else {
3218      if (Index > CXXBaseSpecifiersOffsets.size())
3219        CXXBaseSpecifiersOffsets.resize(Index + 1);
3220      CXXBaseSpecifiersOffsets[Index] = Stream.GetCurrentBitNo();
3221    }
3222
3223    const CXXBaseSpecifier *B = CXXBaseSpecifiersToWrite[I].Bases,
3224                        *BEnd = CXXBaseSpecifiersToWrite[I].BasesEnd;
3225    Record.push_back(BEnd - B);
3226    for (; B != BEnd; ++B)
3227      AddCXXBaseSpecifier(*B, Record);
3228    Stream.EmitRecord(serialization::DECL_CXX_BASE_SPECIFIERS, Record);
3229
3230    // Flush any expressions that were written as part of the base specifiers.
3231    FlushStmts();
3232  }
3233
3234  CXXBaseSpecifiersToWrite.clear();
3235}
3236
3237void ASTWriter::AddCXXBaseOrMemberInitializers(
3238                        const CXXBaseOrMemberInitializer * const *BaseOrMembers,
3239                        unsigned NumBaseOrMembers, RecordDataImpl &Record) {
3240  Record.push_back(NumBaseOrMembers);
3241  for (unsigned i=0; i != NumBaseOrMembers; ++i) {
3242    const CXXBaseOrMemberInitializer *Init = BaseOrMembers[i];
3243
3244    Record.push_back(Init->isBaseInitializer());
3245    if (Init->isBaseInitializer()) {
3246      AddTypeSourceInfo(Init->getBaseClassInfo(), Record);
3247      Record.push_back(Init->isBaseVirtual());
3248    } else {
3249      AddDeclRef(Init->getMember(), Record);
3250    }
3251    AddSourceLocation(Init->getMemberLocation(), Record);
3252    AddStmt(Init->getInit());
3253    AddDeclRef(Init->getAnonUnionMember(), Record);
3254    AddSourceLocation(Init->getLParenLoc(), Record);
3255    AddSourceLocation(Init->getRParenLoc(), Record);
3256    Record.push_back(Init->isWritten());
3257    if (Init->isWritten()) {
3258      Record.push_back(Init->getSourceOrder());
3259    } else {
3260      Record.push_back(Init->getNumArrayIndices());
3261      for (unsigned i=0, e=Init->getNumArrayIndices(); i != e; ++i)
3262        AddDeclRef(Init->getArrayIndex(i), Record);
3263    }
3264  }
3265}
3266
3267void ASTWriter::AddCXXDefinitionData(const CXXRecordDecl *D, RecordDataImpl &Record) {
3268  assert(D->DefinitionData);
3269  struct CXXRecordDecl::DefinitionData &Data = *D->DefinitionData;
3270  Record.push_back(Data.UserDeclaredConstructor);
3271  Record.push_back(Data.UserDeclaredCopyConstructor);
3272  Record.push_back(Data.UserDeclaredCopyAssignment);
3273  Record.push_back(Data.UserDeclaredDestructor);
3274  Record.push_back(Data.Aggregate);
3275  Record.push_back(Data.PlainOldData);
3276  Record.push_back(Data.Empty);
3277  Record.push_back(Data.Polymorphic);
3278  Record.push_back(Data.Abstract);
3279  Record.push_back(Data.HasTrivialConstructor);
3280  Record.push_back(Data.HasTrivialCopyConstructor);
3281  Record.push_back(Data.HasTrivialCopyAssignment);
3282  Record.push_back(Data.HasTrivialDestructor);
3283  Record.push_back(Data.ComputedVisibleConversions);
3284  Record.push_back(Data.DeclaredDefaultConstructor);
3285  Record.push_back(Data.DeclaredCopyConstructor);
3286  Record.push_back(Data.DeclaredCopyAssignment);
3287  Record.push_back(Data.DeclaredDestructor);
3288
3289  Record.push_back(Data.NumBases);
3290  if (Data.NumBases > 0)
3291    AddCXXBaseSpecifiersRef(Data.getBases(), Data.getBases() + Data.NumBases,
3292                            Record);
3293
3294  // FIXME: Make VBases lazily computed when needed to avoid storing them.
3295  Record.push_back(Data.NumVBases);
3296  if (Data.NumVBases > 0)
3297    AddCXXBaseSpecifiersRef(Data.getVBases(), Data.getVBases() + Data.NumVBases,
3298                            Record);
3299
3300  AddUnresolvedSet(Data.Conversions, Record);
3301  AddUnresolvedSet(Data.VisibleConversions, Record);
3302  // Data.Definition is the owning decl, no need to write it.
3303  AddDeclRef(Data.FirstFriend, Record);
3304}
3305
3306void ASTWriter::ReaderInitialized(ASTReader *Reader) {
3307  assert(Reader && "Cannot remove chain");
3308  assert(!Chain && "Cannot replace chain");
3309  assert(FirstDeclID == NextDeclID &&
3310         FirstTypeID == NextTypeID &&
3311         FirstIdentID == NextIdentID &&
3312         FirstSelectorID == NextSelectorID &&
3313         FirstMacroID == NextMacroID &&
3314         FirstCXXBaseSpecifiersID == NextCXXBaseSpecifiersID &&
3315         "Setting chain after writing has started.");
3316  Chain = Reader;
3317
3318  FirstDeclID += Chain->getTotalNumDecls();
3319  FirstTypeID += Chain->getTotalNumTypes();
3320  FirstIdentID += Chain->getTotalNumIdentifiers();
3321  FirstSelectorID += Chain->getTotalNumSelectors();
3322  FirstMacroID += Chain->getTotalNumMacroDefinitions();
3323  FirstCXXBaseSpecifiersID += Chain->getTotalNumCXXBaseSpecifiers();
3324  NextDeclID = FirstDeclID;
3325  NextTypeID = FirstTypeID;
3326  NextIdentID = FirstIdentID;
3327  NextSelectorID = FirstSelectorID;
3328  NextMacroID = FirstMacroID;
3329  NextCXXBaseSpecifiersID = FirstCXXBaseSpecifiersID;
3330}
3331
3332void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
3333  IdentifierIDs[II] = ID;
3334}
3335
3336void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
3337  // Always take the highest-numbered type index. This copes with an interesting
3338  // case for chained AST writing where we schedule writing the type and then,
3339  // later, deserialize the type from another AST. In this case, we want to
3340  // keep the higher-numbered entry so that we can properly write it out to
3341  // the AST file.
3342  TypeIdx &StoredIdx = TypeIdxs[T];
3343  if (Idx.getIndex() >= StoredIdx.getIndex())
3344    StoredIdx = Idx;
3345}
3346
3347void ASTWriter::DeclRead(DeclID ID, const Decl *D) {
3348  DeclIDs[D] = ID;
3349}
3350
3351void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
3352  SelectorIDs[S] = ID;
3353}
3354
3355void ASTWriter::MacroDefinitionRead(serialization::MacroID ID,
3356                                    MacroDefinition *MD) {
3357  MacroDefinitions[MD] = ID;
3358}
3359
3360void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
3361  assert(D->isDefinition());
3362  if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
3363    // We are interested when a PCH decl is modified.
3364    if (RD->getPCHLevel() > 0) {
3365      // A forward reference was mutated into a definition. Rewrite it.
3366      // FIXME: This happens during template instantiation, should we
3367      // have created a new definition decl instead ?
3368      RewriteDecl(RD);
3369    }
3370
3371    for (CXXRecordDecl::redecl_iterator
3372           I = RD->redecls_begin(), E = RD->redecls_end(); I != E; ++I) {
3373      CXXRecordDecl *Redecl = cast<CXXRecordDecl>(*I);
3374      if (Redecl == RD)
3375        continue;
3376
3377      // We are interested when a PCH decl is modified.
3378      if (Redecl->getPCHLevel() > 0) {
3379        UpdateRecord &Record = DeclUpdates[Redecl];
3380        Record.push_back(UPD_CXX_SET_DEFINITIONDATA);
3381        assert(Redecl->DefinitionData);
3382        assert(Redecl->DefinitionData->Definition == D);
3383        AddDeclRef(D, Record); // the DefinitionDecl
3384      }
3385    }
3386  }
3387}
3388void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
3389  // TU and namespaces are handled elsewhere.
3390  if (isa<TranslationUnitDecl>(DC) || isa<NamespaceDecl>(DC))
3391    return;
3392
3393  if (!(D->getPCHLevel() == 0 && cast<Decl>(DC)->getPCHLevel() > 0))
3394    return; // Not a source decl added to a DeclContext from PCH.
3395
3396  AddUpdatedDeclContext(DC);
3397}
3398
3399void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
3400  assert(D->isImplicit());
3401  if (!(D->getPCHLevel() == 0 && RD->getPCHLevel() > 0))
3402    return; // Not a source member added to a class from PCH.
3403  if (!isa<CXXMethodDecl>(D))
3404    return; // We are interested in lazily declared implicit methods.
3405
3406  // A decl coming from PCH was modified.
3407  assert(RD->isDefinition());
3408  UpdateRecord &Record = DeclUpdates[RD];
3409  Record.push_back(UPD_CXX_ADDED_IMPLICIT_MEMBER);
3410  AddDeclRef(D, Record);
3411}
3412
3413void ASTWriter::AddedCXXTemplateSpecialization(const ClassTemplateDecl *TD,
3414                                     const ClassTemplateSpecializationDecl *D) {
3415  // The specializations set is kept in the canonical template.
3416  TD = TD->getCanonicalDecl();
3417  if (!(D->getPCHLevel() == 0 && TD->getPCHLevel() > 0))
3418    return; // Not a source specialization added to a template from PCH.
3419
3420  UpdateRecord &Record = DeclUpdates[TD];
3421  Record.push_back(UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION);
3422  AddDeclRef(D, Record);
3423}
3424