blob: 10701d1a25e160655e5361371c13a2ad38f58b36 [file] [log] [blame]
Chris Lattnerfb24a3a2010-04-20 20:35:58 +00001//===--- PCHWriter.cpp - Precompiled Headers Writer -----------------------===//
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002//
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 PCHWriter class, which writes a precompiled header.
11//
12//===----------------------------------------------------------------------===//
13
14#include "clang/Frontend/PCHWriter.h"
Douglas Gregor162dd022009-04-20 15:53:59 +000015#include "../Sema/Sema.h" // FIXME: move header into include/clang/Sema
Mike Stump11289f42009-09-09 15:08:12 +000016#include "../Sema/IdentifierResolver.h" // FIXME: move header
Douglas Gregoref84c4b2009-04-09 22:27:44 +000017#include "clang/AST/ASTContext.h"
18#include "clang/AST/Decl.h"
19#include "clang/AST/DeclContextInternals.h"
Douglas Gregorfeb84b02009-04-14 21:18:50 +000020#include "clang/AST/Expr.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000021#include "clang/AST/Type.h"
John McCall8f115c62009-10-16 21:56:05 +000022#include "clang/AST/TypeLocVisitor.h"
Sebastian Redl4d3af3e2010-07-09 21:00:24 +000023#include "clang/Frontend/PCHReader.h"
Chris Lattnerbaa52f42009-04-10 18:00:12 +000024#include "clang/Lex/MacroInfo.h"
Douglas Gregoraae92242010-03-19 21:51:54 +000025#include "clang/Lex/PreprocessingRecord.h"
Chris Lattnerbaa52f42009-04-10 18:00:12 +000026#include "clang/Lex/Preprocessor.h"
Steve Naroff3fa455a2009-04-24 20:03:17 +000027#include "clang/Lex/HeaderSearch.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000028#include "clang/Basic/FileManager.h"
Douglas Gregore84a9da2009-04-20 20:36:09 +000029#include "clang/Basic/OnDiskHashTable.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000030#include "clang/Basic/SourceManager.h"
Douglas Gregor4c7626e2009-04-13 16:31:14 +000031#include "clang/Basic/SourceManagerInternals.h"
Douglas Gregorbfbde532009-04-10 21:16:55 +000032#include "clang/Basic/TargetInfo.h"
Douglas Gregor7b71e632009-04-27 22:23:34 +000033#include "clang/Basic/Version.h"
Douglas Gregore0a3a512009-04-14 21:55:33 +000034#include "llvm/ADT/APFloat.h"
35#include "llvm/ADT/APInt.h"
Daniel Dunbarf8502d52009-10-17 23:52:28 +000036#include "llvm/ADT/StringExtras.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000037#include "llvm/Bitcode/BitstreamWriter.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000038#include "llvm/Support/MemoryBuffer.h"
Douglas Gregor45fe0362009-05-12 01:31:05 +000039#include "llvm/System/Path.h"
Chris Lattner225dd6c2009-04-11 18:40:46 +000040#include <cstdio>
Douglas Gregoref84c4b2009-04-09 22:27:44 +000041using namespace clang;
42
43//===----------------------------------------------------------------------===//
44// Type serialization
45//===----------------------------------------------------------------------===//
Chris Lattner7099dbc2009-04-27 06:16:06 +000046
Douglas Gregoref84c4b2009-04-09 22:27:44 +000047namespace {
Benjamin Kramer16634c22009-11-28 10:07:24 +000048 class PCHTypeWriter {
Douglas Gregoref84c4b2009-04-09 22:27:44 +000049 PCHWriter &Writer;
50 PCHWriter::RecordData &Record;
51
52 public:
53 /// \brief Type code that corresponds to the record generated.
54 pch::TypeCode Code;
55
Mike Stump11289f42009-09-09 15:08:12 +000056 PCHTypeWriter(PCHWriter &Writer, PCHWriter::RecordData &Record)
Douglas Gregorc5046832009-04-27 18:38:38 +000057 : Writer(Writer), Record(Record), Code(pch::TYPE_EXT_QUAL) { }
Douglas Gregoref84c4b2009-04-09 22:27:44 +000058
59 void VisitArrayType(const ArrayType *T);
60 void VisitFunctionType(const FunctionType *T);
61 void VisitTagType(const TagType *T);
62
63#define TYPE(Class, Base) void Visit##Class##Type(const Class##Type *T);
64#define ABSTRACT_TYPE(Class, Base)
Douglas Gregoref84c4b2009-04-09 22:27:44 +000065#include "clang/AST/TypeNodes.def"
66 };
67}
68
Douglas Gregoref84c4b2009-04-09 22:27:44 +000069void PCHTypeWriter::VisitBuiltinType(const BuiltinType *T) {
70 assert(false && "Built-in types are never serialized");
71}
72
Douglas Gregoref84c4b2009-04-09 22:27:44 +000073void PCHTypeWriter::VisitComplexType(const ComplexType *T) {
74 Writer.AddTypeRef(T->getElementType(), Record);
75 Code = pch::TYPE_COMPLEX;
76}
77
78void PCHTypeWriter::VisitPointerType(const PointerType *T) {
79 Writer.AddTypeRef(T->getPointeeType(), Record);
80 Code = pch::TYPE_POINTER;
81}
82
83void PCHTypeWriter::VisitBlockPointerType(const BlockPointerType *T) {
Mike Stump11289f42009-09-09 15:08:12 +000084 Writer.AddTypeRef(T->getPointeeType(), Record);
Douglas Gregoref84c4b2009-04-09 22:27:44 +000085 Code = pch::TYPE_BLOCK_POINTER;
86}
87
88void PCHTypeWriter::VisitLValueReferenceType(const LValueReferenceType *T) {
89 Writer.AddTypeRef(T->getPointeeType(), Record);
90 Code = pch::TYPE_LVALUE_REFERENCE;
91}
92
93void PCHTypeWriter::VisitRValueReferenceType(const RValueReferenceType *T) {
94 Writer.AddTypeRef(T->getPointeeType(), Record);
95 Code = pch::TYPE_RVALUE_REFERENCE;
96}
97
98void PCHTypeWriter::VisitMemberPointerType(const MemberPointerType *T) {
Mike Stump11289f42009-09-09 15:08:12 +000099 Writer.AddTypeRef(T->getPointeeType(), Record);
100 Writer.AddTypeRef(QualType(T->getClass(), 0), Record);
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000101 Code = pch::TYPE_MEMBER_POINTER;
102}
103
104void PCHTypeWriter::VisitArrayType(const ArrayType *T) {
105 Writer.AddTypeRef(T->getElementType(), Record);
106 Record.push_back(T->getSizeModifier()); // FIXME: stable values
John McCall8ccfcb52009-09-24 19:53:00 +0000107 Record.push_back(T->getIndexTypeCVRQualifiers()); // FIXME: stable values
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000108}
109
110void PCHTypeWriter::VisitConstantArrayType(const ConstantArrayType *T) {
111 VisitArrayType(T);
112 Writer.AddAPInt(T->getSize(), Record);
113 Code = pch::TYPE_CONSTANT_ARRAY;
114}
115
116void PCHTypeWriter::VisitIncompleteArrayType(const IncompleteArrayType *T) {
117 VisitArrayType(T);
118 Code = pch::TYPE_INCOMPLETE_ARRAY;
119}
120
121void PCHTypeWriter::VisitVariableArrayType(const VariableArrayType *T) {
122 VisitArrayType(T);
Douglas Gregor04318252009-07-06 15:59:29 +0000123 Writer.AddSourceLocation(T->getLBracketLoc(), Record);
124 Writer.AddSourceLocation(T->getRBracketLoc(), Record);
Douglas Gregor8f45df52009-04-16 22:23:12 +0000125 Writer.AddStmt(T->getSizeExpr());
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000126 Code = pch::TYPE_VARIABLE_ARRAY;
127}
128
129void PCHTypeWriter::VisitVectorType(const VectorType *T) {
130 Writer.AddTypeRef(T->getElementType(), Record);
131 Record.push_back(T->getNumElements());
Chris Lattner37141f42010-06-23 06:00:24 +0000132 Record.push_back(T->getAltiVecSpecific());
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000133 Code = pch::TYPE_VECTOR;
134}
135
136void PCHTypeWriter::VisitExtVectorType(const ExtVectorType *T) {
137 VisitVectorType(T);
138 Code = pch::TYPE_EXT_VECTOR;
139}
140
141void PCHTypeWriter::VisitFunctionType(const FunctionType *T) {
142 Writer.AddTypeRef(T->getResultType(), Record);
Rafael Espindolac50c27c2010-03-30 20:24:48 +0000143 FunctionType::ExtInfo C = T->getExtInfo();
144 Record.push_back(C.getNoReturn());
Rafael Espindola49b85ab2010-03-30 22:15:11 +0000145 Record.push_back(C.getRegParm());
Douglas Gregor8c940862010-01-18 17:14:39 +0000146 // FIXME: need to stabilize encoding of calling convention...
Rafael Espindolac50c27c2010-03-30 20:24:48 +0000147 Record.push_back(C.getCC());
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000148}
149
150void PCHTypeWriter::VisitFunctionNoProtoType(const FunctionNoProtoType *T) {
151 VisitFunctionType(T);
152 Code = pch::TYPE_FUNCTION_NO_PROTO;
153}
154
155void PCHTypeWriter::VisitFunctionProtoType(const FunctionProtoType *T) {
156 VisitFunctionType(T);
157 Record.push_back(T->getNumArgs());
158 for (unsigned I = 0, N = T->getNumArgs(); I != N; ++I)
159 Writer.AddTypeRef(T->getArgType(I), Record);
160 Record.push_back(T->isVariadic());
161 Record.push_back(T->getTypeQuals());
Sebastian Redl5068f77ac2009-05-27 22:11:52 +0000162 Record.push_back(T->hasExceptionSpec());
163 Record.push_back(T->hasAnyExceptionSpec());
164 Record.push_back(T->getNumExceptions());
165 for (unsigned I = 0, N = T->getNumExceptions(); I != N; ++I)
166 Writer.AddTypeRef(T->getExceptionType(I), Record);
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000167 Code = pch::TYPE_FUNCTION_PROTO;
168}
169
John McCallb96ec562009-12-04 22:46:56 +0000170void PCHTypeWriter::VisitUnresolvedUsingType(const UnresolvedUsingType *T) {
171 Writer.AddDeclRef(T->getDecl(), Record);
172 Code = pch::TYPE_UNRESOLVED_USING;
173}
John McCallb96ec562009-12-04 22:46:56 +0000174
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000175void PCHTypeWriter::VisitTypedefType(const TypedefType *T) {
176 Writer.AddDeclRef(T->getDecl(), Record);
Argyrios Kyrtzidis45a83f92010-07-02 11:55:11 +0000177 assert(!T->isCanonicalUnqualified() && "Invalid typedef ?");
178 Writer.AddTypeRef(T->getCanonicalTypeInternal(), Record);
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000179 Code = pch::TYPE_TYPEDEF;
180}
181
182void PCHTypeWriter::VisitTypeOfExprType(const TypeOfExprType *T) {
Douglas Gregor8f45df52009-04-16 22:23:12 +0000183 Writer.AddStmt(T->getUnderlyingExpr());
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000184 Code = pch::TYPE_TYPEOF_EXPR;
185}
186
187void PCHTypeWriter::VisitTypeOfType(const TypeOfType *T) {
188 Writer.AddTypeRef(T->getUnderlyingType(), Record);
189 Code = pch::TYPE_TYPEOF;
190}
191
Anders Carlsson81df7b82009-06-24 19:06:50 +0000192void PCHTypeWriter::VisitDecltypeType(const DecltypeType *T) {
193 Writer.AddStmt(T->getUnderlyingExpr());
194 Code = pch::TYPE_DECLTYPE;
195}
196
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000197void PCHTypeWriter::VisitTagType(const TagType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000198 Record.push_back(T->isDependentType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000199 Writer.AddDeclRef(T->getDecl(), Record);
Mike Stump11289f42009-09-09 15:08:12 +0000200 assert(!T->isBeingDefined() &&
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000201 "Cannot serialize in the middle of a type definition");
202}
203
204void PCHTypeWriter::VisitRecordType(const RecordType *T) {
205 VisitTagType(T);
206 Code = pch::TYPE_RECORD;
207}
208
209void PCHTypeWriter::VisitEnumType(const EnumType *T) {
210 VisitTagType(T);
211 Code = pch::TYPE_ENUM;
212}
213
Mike Stump11289f42009-09-09 15:08:12 +0000214void
John McCallcebee162009-10-18 09:09:24 +0000215PCHTypeWriter::VisitSubstTemplateTypeParmType(
216 const SubstTemplateTypeParmType *T) {
217 Writer.AddTypeRef(QualType(T->getReplacedParameter(), 0), Record);
218 Writer.AddTypeRef(T->getReplacementType(), Record);
219 Code = pch::TYPE_SUBST_TEMPLATE_TYPE_PARM;
220}
221
222void
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000223PCHTypeWriter::VisitTemplateSpecializationType(
224 const TemplateSpecializationType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000225 Record.push_back(T->isDependentType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000226 Writer.AddTemplateName(T->getTemplateName(), Record);
227 Record.push_back(T->getNumArgs());
228 for (TemplateSpecializationType::iterator ArgI = T->begin(), ArgE = T->end();
229 ArgI != ArgE; ++ArgI)
230 Writer.AddTemplateArgument(*ArgI, Record);
Argyrios Kyrtzidis45a83f92010-07-02 11:55:11 +0000231 Writer.AddTypeRef(T->isCanonicalUnqualified() ? QualType()
232 : T->getCanonicalTypeInternal(),
233 Record);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000234 Code = pch::TYPE_TEMPLATE_SPECIALIZATION;
235}
236
237void
238PCHTypeWriter::VisitDependentSizedArrayType(const DependentSizedArrayType *T) {
Argyrios Kyrtzidis4a57bd02010-06-30 08:49:25 +0000239 VisitArrayType(T);
240 Writer.AddStmt(T->getSizeExpr());
241 Writer.AddSourceRange(T->getBracketsRange(), Record);
242 Code = pch::TYPE_DEPENDENT_SIZED_ARRAY;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000243}
244
245void
246PCHTypeWriter::VisitDependentSizedExtVectorType(
247 const DependentSizedExtVectorType *T) {
248 // FIXME: Serialize this type (C++ only)
249 assert(false && "Cannot serialize dependent sized extended vector types");
250}
251
252void
253PCHTypeWriter::VisitTemplateTypeParmType(const TemplateTypeParmType *T) {
254 Record.push_back(T->getDepth());
255 Record.push_back(T->getIndex());
256 Record.push_back(T->isParameterPack());
257 Writer.AddIdentifierRef(T->getName(), Record);
258 Code = pch::TYPE_TEMPLATE_TYPE_PARM;
259}
260
261void
262PCHTypeWriter::VisitDependentNameType(const DependentNameType *T) {
Argyrios Kyrtzidisbfcacee2010-06-24 08:57:31 +0000263 Record.push_back(T->getKeyword());
264 Writer.AddNestedNameSpecifier(T->getQualifier(), Record);
265 Writer.AddIdentifierRef(T->getIdentifier(), Record);
Argyrios Kyrtzidise9290952010-07-02 11:55:24 +0000266 Writer.AddTypeRef(T->isCanonicalUnqualified() ? QualType()
267 : T->getCanonicalTypeInternal(),
268 Record);
Argyrios Kyrtzidisbfcacee2010-06-24 08:57:31 +0000269 Code = pch::TYPE_DEPENDENT_NAME;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000270}
271
272void
273PCHTypeWriter::VisitDependentTemplateSpecializationType(
274 const DependentTemplateSpecializationType *T) {
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000275 Record.push_back(T->getKeyword());
276 Writer.AddNestedNameSpecifier(T->getQualifier(), Record);
277 Writer.AddIdentifierRef(T->getIdentifier(), Record);
278 Record.push_back(T->getNumArgs());
279 for (DependentTemplateSpecializationType::iterator
280 I = T->begin(), E = T->end(); I != E; ++I)
281 Writer.AddTemplateArgument(*I, Record);
282 Code = pch::TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000283}
284
Abramo Bagnara6150c882010-05-11 21:36:43 +0000285void PCHTypeWriter::VisitElaboratedType(const ElaboratedType *T) {
Abramo Bagnara6150c882010-05-11 21:36:43 +0000286 Record.push_back(T->getKeyword());
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000287 Writer.AddNestedNameSpecifier(T->getQualifier(), Record);
288 Writer.AddTypeRef(T->getNamedType(), Record);
Abramo Bagnara6150c882010-05-11 21:36:43 +0000289 Code = pch::TYPE_ELABORATED;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000290}
291
John McCalle78aac42010-03-10 03:28:59 +0000292void PCHTypeWriter::VisitInjectedClassNameType(const InjectedClassNameType *T) {
293 Writer.AddDeclRef(T->getDecl(), Record);
John McCall2408e322010-04-27 00:57:59 +0000294 Writer.AddTypeRef(T->getInjectedSpecializationType(), Record);
John McCalle78aac42010-03-10 03:28:59 +0000295 Code = pch::TYPE_INJECTED_CLASS_NAME;
296}
297
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000298void PCHTypeWriter::VisitObjCInterfaceType(const ObjCInterfaceType *T) {
299 Writer.AddDeclRef(T->getDecl(), Record);
John McCall8b07ec22010-05-15 11:32:37 +0000300 Code = pch::TYPE_OBJC_INTERFACE;
301}
302
303void PCHTypeWriter::VisitObjCObjectType(const ObjCObjectType *T) {
304 Writer.AddTypeRef(T->getBaseType(), Record);
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000305 Record.push_back(T->getNumProtocols());
John McCall8b07ec22010-05-15 11:32:37 +0000306 for (ObjCObjectType::qual_iterator I = T->qual_begin(),
Steve Naroff4fc95aa2009-05-27 16:21:00 +0000307 E = T->qual_end(); I != E; ++I)
308 Writer.AddDeclRef(*I, Record);
John McCall8b07ec22010-05-15 11:32:37 +0000309 Code = pch::TYPE_OBJC_OBJECT;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000310}
311
Steve Narofffb4330f2009-06-17 22:40:22 +0000312void
313PCHTypeWriter::VisitObjCObjectPointerType(const ObjCObjectPointerType *T) {
Mike Stump11289f42009-09-09 15:08:12 +0000314 Writer.AddTypeRef(T->getPointeeType(), Record);
Steve Narofffb4330f2009-06-17 22:40:22 +0000315 Code = pch::TYPE_OBJC_OBJECT_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000316}
317
John McCall8f115c62009-10-16 21:56:05 +0000318namespace {
319
320class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> {
321 PCHWriter &Writer;
322 PCHWriter::RecordData &Record;
323
324public:
325 TypeLocWriter(PCHWriter &Writer, PCHWriter::RecordData &Record)
326 : Writer(Writer), Record(Record) { }
327
John McCall17001972009-10-18 01:05:36 +0000328#define ABSTRACT_TYPELOC(CLASS, PARENT)
John McCall8f115c62009-10-16 21:56:05 +0000329#define TYPELOC(CLASS, PARENT) \
John McCall17001972009-10-18 01:05:36 +0000330 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000331#include "clang/AST/TypeLocNodes.def"
332
John McCall17001972009-10-18 01:05:36 +0000333 void VisitArrayTypeLoc(ArrayTypeLoc TyLoc);
334 void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000335};
336
337}
338
John McCall17001972009-10-18 01:05:36 +0000339void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
340 // nothing to do
John McCall8f115c62009-10-16 21:56:05 +0000341}
John McCall17001972009-10-18 01:05:36 +0000342void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
Douglas Gregorc9b7a592010-01-18 18:04:31 +0000343 Writer.AddSourceLocation(TL.getBuiltinLoc(), Record);
344 if (TL.needsExtraLocalData()) {
345 Record.push_back(TL.getWrittenTypeSpec());
346 Record.push_back(TL.getWrittenSignSpec());
347 Record.push_back(TL.getWrittenWidthSpec());
348 Record.push_back(TL.hasModeAttr());
349 }
John McCall8f115c62009-10-16 21:56:05 +0000350}
John McCall17001972009-10-18 01:05:36 +0000351void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
352 Writer.AddSourceLocation(TL.getNameLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000353}
John McCall17001972009-10-18 01:05:36 +0000354void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) {
355 Writer.AddSourceLocation(TL.getStarLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000356}
John McCall17001972009-10-18 01:05:36 +0000357void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
358 Writer.AddSourceLocation(TL.getCaretLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000359}
John McCall17001972009-10-18 01:05:36 +0000360void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
361 Writer.AddSourceLocation(TL.getAmpLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000362}
John McCall17001972009-10-18 01:05:36 +0000363void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
364 Writer.AddSourceLocation(TL.getAmpAmpLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000365}
John McCall17001972009-10-18 01:05:36 +0000366void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
367 Writer.AddSourceLocation(TL.getStarLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000368}
John McCall17001972009-10-18 01:05:36 +0000369void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) {
370 Writer.AddSourceLocation(TL.getLBracketLoc(), Record);
371 Writer.AddSourceLocation(TL.getRBracketLoc(), Record);
372 Record.push_back(TL.getSizeExpr() ? 1 : 0);
373 if (TL.getSizeExpr())
374 Writer.AddStmt(TL.getSizeExpr());
John McCall8f115c62009-10-16 21:56:05 +0000375}
John McCall17001972009-10-18 01:05:36 +0000376void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
377 VisitArrayTypeLoc(TL);
378}
379void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
380 VisitArrayTypeLoc(TL);
381}
382void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
383 VisitArrayTypeLoc(TL);
384}
385void TypeLocWriter::VisitDependentSizedArrayTypeLoc(
386 DependentSizedArrayTypeLoc TL) {
387 VisitArrayTypeLoc(TL);
388}
389void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc(
390 DependentSizedExtVectorTypeLoc TL) {
391 Writer.AddSourceLocation(TL.getNameLoc(), Record);
392}
393void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) {
394 Writer.AddSourceLocation(TL.getNameLoc(), Record);
395}
396void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
397 Writer.AddSourceLocation(TL.getNameLoc(), Record);
398}
399void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
400 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
401 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
402 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
403 Writer.AddDeclRef(TL.getArg(i), Record);
404}
405void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
406 VisitFunctionTypeLoc(TL);
407}
408void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
409 VisitFunctionTypeLoc(TL);
410}
John McCallb96ec562009-12-04 22:46:56 +0000411void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
412 Writer.AddSourceLocation(TL.getNameLoc(), Record);
413}
John McCall17001972009-10-18 01:05:36 +0000414void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
415 Writer.AddSourceLocation(TL.getNameLoc(), Record);
416}
417void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
John McCalle8595032010-01-13 20:03:27 +0000418 Writer.AddSourceLocation(TL.getTypeofLoc(), Record);
419 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
420 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
John McCall17001972009-10-18 01:05:36 +0000421}
422void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
John McCalle8595032010-01-13 20:03:27 +0000423 Writer.AddSourceLocation(TL.getTypeofLoc(), Record);
424 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
425 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
426 Writer.AddTypeSourceInfo(TL.getUnderlyingTInfo(), Record);
John McCall17001972009-10-18 01:05:36 +0000427}
428void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
429 Writer.AddSourceLocation(TL.getNameLoc(), Record);
430}
431void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) {
432 Writer.AddSourceLocation(TL.getNameLoc(), Record);
433}
434void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) {
435 Writer.AddSourceLocation(TL.getNameLoc(), Record);
436}
John McCall17001972009-10-18 01:05:36 +0000437void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
438 Writer.AddSourceLocation(TL.getNameLoc(), Record);
439}
John McCallcebee162009-10-18 09:09:24 +0000440void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
441 SubstTemplateTypeParmTypeLoc TL) {
442 Writer.AddSourceLocation(TL.getNameLoc(), Record);
443}
John McCall17001972009-10-18 01:05:36 +0000444void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
445 TemplateSpecializationTypeLoc TL) {
John McCall0ad16662009-10-29 08:12:44 +0000446 Writer.AddSourceLocation(TL.getTemplateNameLoc(), Record);
447 Writer.AddSourceLocation(TL.getLAngleLoc(), Record);
448 Writer.AddSourceLocation(TL.getRAngleLoc(), Record);
449 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +0000450 Writer.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(),
451 TL.getArgLoc(i).getLocInfo(), Record);
John McCall17001972009-10-18 01:05:36 +0000452}
Abramo Bagnara6150c882010-05-11 21:36:43 +0000453void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
Abramo Bagnarad7548482010-05-19 21:37:53 +0000454 Writer.AddSourceLocation(TL.getKeywordLoc(), Record);
455 Writer.AddSourceRange(TL.getQualifierRange(), Record);
John McCall17001972009-10-18 01:05:36 +0000456}
John McCalle78aac42010-03-10 03:28:59 +0000457void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
458 Writer.AddSourceLocation(TL.getNameLoc(), Record);
459}
Douglas Gregorc1d2d8a2010-03-31 17:34:00 +0000460void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
Abramo Bagnarad7548482010-05-19 21:37:53 +0000461 Writer.AddSourceLocation(TL.getKeywordLoc(), Record);
462 Writer.AddSourceRange(TL.getQualifierRange(), Record);
John McCall17001972009-10-18 01:05:36 +0000463 Writer.AddSourceLocation(TL.getNameLoc(), Record);
464}
John McCallc392f372010-06-11 00:33:02 +0000465void TypeLocWriter::VisitDependentTemplateSpecializationTypeLoc(
466 DependentTemplateSpecializationTypeLoc TL) {
467 Writer.AddSourceLocation(TL.getKeywordLoc(), Record);
468 Writer.AddSourceRange(TL.getQualifierRange(), Record);
469 Writer.AddSourceLocation(TL.getNameLoc(), Record);
470 Writer.AddSourceLocation(TL.getLAngleLoc(), Record);
471 Writer.AddSourceLocation(TL.getRAngleLoc(), Record);
472 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +0000473 Writer.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(),
474 TL.getArgLoc(I).getLocInfo(), Record);
John McCallc392f372010-06-11 00:33:02 +0000475}
John McCall17001972009-10-18 01:05:36 +0000476void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
477 Writer.AddSourceLocation(TL.getNameLoc(), Record);
John McCall8b07ec22010-05-15 11:32:37 +0000478}
479void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
480 Record.push_back(TL.hasBaseTypeAsWritten());
John McCall17001972009-10-18 01:05:36 +0000481 Writer.AddSourceLocation(TL.getLAngleLoc(), Record);
482 Writer.AddSourceLocation(TL.getRAngleLoc(), Record);
483 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
484 Writer.AddSourceLocation(TL.getProtocolLoc(i), Record);
John McCall8f115c62009-10-16 21:56:05 +0000485}
John McCallfc93cf92009-10-22 22:37:11 +0000486void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
487 Writer.AddSourceLocation(TL.getStarLoc(), Record);
John McCallfc93cf92009-10-22 22:37:11 +0000488}
John McCall8f115c62009-10-16 21:56:05 +0000489
Chris Lattner19cea4e2009-04-22 05:57:30 +0000490//===----------------------------------------------------------------------===//
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000491// PCHWriter Implementation
492//===----------------------------------------------------------------------===//
493
Chris Lattner28fa4e62009-04-26 22:26:21 +0000494static void EmitBlockID(unsigned ID, const char *Name,
495 llvm::BitstreamWriter &Stream,
496 PCHWriter::RecordData &Record) {
497 Record.clear();
498 Record.push_back(ID);
499 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
500
501 // Emit the block name if present.
502 if (Name == 0 || Name[0] == 0) return;
503 Record.clear();
504 while (*Name)
505 Record.push_back(*Name++);
506 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record);
507}
508
509static void EmitRecordID(unsigned ID, const char *Name,
510 llvm::BitstreamWriter &Stream,
511 PCHWriter::RecordData &Record) {
512 Record.clear();
513 Record.push_back(ID);
514 while (*Name)
515 Record.push_back(*Name++);
516 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000517}
518
519static void AddStmtsExprs(llvm::BitstreamWriter &Stream,
520 PCHWriter::RecordData &Record) {
521#define RECORD(X) EmitRecordID(pch::X, #X, Stream, Record)
522 RECORD(STMT_STOP);
523 RECORD(STMT_NULL_PTR);
524 RECORD(STMT_NULL);
525 RECORD(STMT_COMPOUND);
526 RECORD(STMT_CASE);
527 RECORD(STMT_DEFAULT);
528 RECORD(STMT_LABEL);
529 RECORD(STMT_IF);
530 RECORD(STMT_SWITCH);
531 RECORD(STMT_WHILE);
532 RECORD(STMT_DO);
533 RECORD(STMT_FOR);
534 RECORD(STMT_GOTO);
535 RECORD(STMT_INDIRECT_GOTO);
536 RECORD(STMT_CONTINUE);
537 RECORD(STMT_BREAK);
538 RECORD(STMT_RETURN);
539 RECORD(STMT_DECL);
540 RECORD(STMT_ASM);
541 RECORD(EXPR_PREDEFINED);
542 RECORD(EXPR_DECL_REF);
543 RECORD(EXPR_INTEGER_LITERAL);
544 RECORD(EXPR_FLOATING_LITERAL);
545 RECORD(EXPR_IMAGINARY_LITERAL);
546 RECORD(EXPR_STRING_LITERAL);
547 RECORD(EXPR_CHARACTER_LITERAL);
548 RECORD(EXPR_PAREN);
549 RECORD(EXPR_UNARY_OPERATOR);
550 RECORD(EXPR_SIZEOF_ALIGN_OF);
551 RECORD(EXPR_ARRAY_SUBSCRIPT);
552 RECORD(EXPR_CALL);
553 RECORD(EXPR_MEMBER);
554 RECORD(EXPR_BINARY_OPERATOR);
555 RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR);
556 RECORD(EXPR_CONDITIONAL_OPERATOR);
557 RECORD(EXPR_IMPLICIT_CAST);
558 RECORD(EXPR_CSTYLE_CAST);
559 RECORD(EXPR_COMPOUND_LITERAL);
560 RECORD(EXPR_EXT_VECTOR_ELEMENT);
561 RECORD(EXPR_INIT_LIST);
562 RECORD(EXPR_DESIGNATED_INIT);
563 RECORD(EXPR_IMPLICIT_VALUE_INIT);
564 RECORD(EXPR_VA_ARG);
565 RECORD(EXPR_ADDR_LABEL);
566 RECORD(EXPR_STMT);
567 RECORD(EXPR_TYPES_COMPATIBLE);
568 RECORD(EXPR_CHOOSE);
569 RECORD(EXPR_GNU_NULL);
570 RECORD(EXPR_SHUFFLE_VECTOR);
571 RECORD(EXPR_BLOCK);
572 RECORD(EXPR_BLOCK_DECL_REF);
573 RECORD(EXPR_OBJC_STRING_LITERAL);
574 RECORD(EXPR_OBJC_ENCODE);
575 RECORD(EXPR_OBJC_SELECTOR_EXPR);
576 RECORD(EXPR_OBJC_PROTOCOL_EXPR);
577 RECORD(EXPR_OBJC_IVAR_REF_EXPR);
578 RECORD(EXPR_OBJC_PROPERTY_REF_EXPR);
579 RECORD(EXPR_OBJC_KVC_REF_EXPR);
580 RECORD(EXPR_OBJC_MESSAGE_EXPR);
581 RECORD(EXPR_OBJC_SUPER_EXPR);
582 RECORD(STMT_OBJC_FOR_COLLECTION);
583 RECORD(STMT_OBJC_CATCH);
584 RECORD(STMT_OBJC_FINALLY);
585 RECORD(STMT_OBJC_AT_TRY);
586 RECORD(STMT_OBJC_AT_SYNCHRONIZED);
587 RECORD(STMT_OBJC_AT_THROW);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000588 RECORD(EXPR_CXX_OPERATOR_CALL);
589 RECORD(EXPR_CXX_CONSTRUCT);
590 RECORD(EXPR_CXX_STATIC_CAST);
591 RECORD(EXPR_CXX_DYNAMIC_CAST);
592 RECORD(EXPR_CXX_REINTERPRET_CAST);
593 RECORD(EXPR_CXX_CONST_CAST);
594 RECORD(EXPR_CXX_FUNCTIONAL_CAST);
595 RECORD(EXPR_CXX_BOOL_LITERAL);
596 RECORD(EXPR_CXX_NULL_PTR_LITERAL);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000597#undef RECORD
Chris Lattner28fa4e62009-04-26 22:26:21 +0000598}
Mike Stump11289f42009-09-09 15:08:12 +0000599
Chris Lattner28fa4e62009-04-26 22:26:21 +0000600void PCHWriter::WriteBlockInfoBlock() {
601 RecordData Record;
602 Stream.EnterSubblock(llvm::bitc::BLOCKINFO_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +0000603
Chris Lattner64031982009-04-27 00:40:25 +0000604#define BLOCK(X) EmitBlockID(pch::X ## _ID, #X, Stream, Record)
Chris Lattner28fa4e62009-04-26 22:26:21 +0000605#define RECORD(X) EmitRecordID(pch::X, #X, Stream, Record)
Mike Stump11289f42009-09-09 15:08:12 +0000606
Chris Lattner28fa4e62009-04-26 22:26:21 +0000607 // PCH Top-Level Block.
Chris Lattner64031982009-04-27 00:40:25 +0000608 BLOCK(PCH_BLOCK);
Zhongxing Xub027cdf2009-06-03 09:23:28 +0000609 RECORD(ORIGINAL_FILE_NAME);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000610 RECORD(TYPE_OFFSET);
611 RECORD(DECL_OFFSET);
612 RECORD(LANGUAGE_OPTIONS);
Douglas Gregor7b71e632009-04-27 22:23:34 +0000613 RECORD(METADATA);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000614 RECORD(IDENTIFIER_OFFSET);
615 RECORD(IDENTIFIER_TABLE);
616 RECORD(EXTERNAL_DEFINITIONS);
617 RECORD(SPECIAL_TYPES);
618 RECORD(STATISTICS);
619 RECORD(TENTATIVE_DEFINITIONS);
Tanya Lattner90073802010-02-12 00:07:30 +0000620 RECORD(UNUSED_STATIC_FUNCS);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000621 RECORD(LOCALLY_SCOPED_EXTERNAL_DECLS);
622 RECORD(SELECTOR_OFFSETS);
623 RECORD(METHOD_POOL);
624 RECORD(PP_COUNTER_VALUE);
Douglas Gregor258ae542009-04-27 06:38:32 +0000625 RECORD(SOURCE_LOCATION_OFFSETS);
626 RECORD(SOURCE_LOCATION_PRELOADS);
Douglas Gregorc5046832009-04-27 18:38:38 +0000627 RECORD(STAT_CACHE);
Douglas Gregor61cac2b2009-04-27 20:06:05 +0000628 RECORD(EXT_VECTOR_DECLS);
Ted Kremenek17437132010-01-22 20:59:36 +0000629 RECORD(VERSION_CONTROL_BRANCH_REVISION);
Douglas Gregoraae92242010-03-19 21:51:54 +0000630 RECORD(UNUSED_STATIC_FUNCS);
631 RECORD(MACRO_DEFINITION_OFFSETS);
Sebastian Redl595c5132010-07-08 22:01:51 +0000632 RECORD(CHAINED_METADATA);
Douglas Gregoraae92242010-03-19 21:51:54 +0000633
Chris Lattner28fa4e62009-04-26 22:26:21 +0000634 // SourceManager Block.
Chris Lattner64031982009-04-27 00:40:25 +0000635 BLOCK(SOURCE_MANAGER_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000636 RECORD(SM_SLOC_FILE_ENTRY);
637 RECORD(SM_SLOC_BUFFER_ENTRY);
638 RECORD(SM_SLOC_BUFFER_BLOB);
639 RECORD(SM_SLOC_INSTANTIATION_ENTRY);
640 RECORD(SM_LINE_TABLE);
Mike Stump11289f42009-09-09 15:08:12 +0000641
Chris Lattner28fa4e62009-04-26 22:26:21 +0000642 // Preprocessor Block.
Chris Lattner64031982009-04-27 00:40:25 +0000643 BLOCK(PREPROCESSOR_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000644 RECORD(PP_MACRO_OBJECT_LIKE);
645 RECORD(PP_MACRO_FUNCTION_LIKE);
646 RECORD(PP_TOKEN);
Douglas Gregoraae92242010-03-19 21:51:54 +0000647 RECORD(PP_MACRO_INSTANTIATION);
648 RECORD(PP_MACRO_DEFINITION);
649
Douglas Gregor12bfa382009-10-17 00:13:19 +0000650 // Decls and Types block.
651 BLOCK(DECLTYPES_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000652 RECORD(TYPE_EXT_QUAL);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000653 RECORD(TYPE_COMPLEX);
654 RECORD(TYPE_POINTER);
655 RECORD(TYPE_BLOCK_POINTER);
656 RECORD(TYPE_LVALUE_REFERENCE);
657 RECORD(TYPE_RVALUE_REFERENCE);
658 RECORD(TYPE_MEMBER_POINTER);
659 RECORD(TYPE_CONSTANT_ARRAY);
660 RECORD(TYPE_INCOMPLETE_ARRAY);
661 RECORD(TYPE_VARIABLE_ARRAY);
662 RECORD(TYPE_VECTOR);
663 RECORD(TYPE_EXT_VECTOR);
664 RECORD(TYPE_FUNCTION_PROTO);
665 RECORD(TYPE_FUNCTION_NO_PROTO);
666 RECORD(TYPE_TYPEDEF);
667 RECORD(TYPE_TYPEOF_EXPR);
668 RECORD(TYPE_TYPEOF);
669 RECORD(TYPE_RECORD);
670 RECORD(TYPE_ENUM);
671 RECORD(TYPE_OBJC_INTERFACE);
John McCall94f619a2010-05-16 02:12:35 +0000672 RECORD(TYPE_OBJC_OBJECT);
Steve Narofffb4330f2009-06-17 22:40:22 +0000673 RECORD(TYPE_OBJC_OBJECT_POINTER);
Chris Lattnerdb397b62009-04-26 22:32:16 +0000674 RECORD(DECL_ATTR);
675 RECORD(DECL_TRANSLATION_UNIT);
676 RECORD(DECL_TYPEDEF);
677 RECORD(DECL_ENUM);
678 RECORD(DECL_RECORD);
679 RECORD(DECL_ENUM_CONSTANT);
680 RECORD(DECL_FUNCTION);
681 RECORD(DECL_OBJC_METHOD);
682 RECORD(DECL_OBJC_INTERFACE);
683 RECORD(DECL_OBJC_PROTOCOL);
684 RECORD(DECL_OBJC_IVAR);
685 RECORD(DECL_OBJC_AT_DEFS_FIELD);
686 RECORD(DECL_OBJC_CLASS);
687 RECORD(DECL_OBJC_FORWARD_PROTOCOL);
688 RECORD(DECL_OBJC_CATEGORY);
689 RECORD(DECL_OBJC_CATEGORY_IMPL);
690 RECORD(DECL_OBJC_IMPLEMENTATION);
691 RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
692 RECORD(DECL_OBJC_PROPERTY);
693 RECORD(DECL_OBJC_PROPERTY_IMPL);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000694 RECORD(DECL_FIELD);
695 RECORD(DECL_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +0000696 RECORD(DECL_IMPLICIT_PARAM);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000697 RECORD(DECL_PARM_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +0000698 RECORD(DECL_FILE_SCOPE_ASM);
699 RECORD(DECL_BLOCK);
700 RECORD(DECL_CONTEXT_LEXICAL);
701 RECORD(DECL_CONTEXT_VISIBLE);
Douglas Gregor12bfa382009-10-17 00:13:19 +0000702 // Statements and Exprs can occur in the Decls and Types block.
Chris Lattnerccac3a62009-04-27 00:49:53 +0000703 AddStmtsExprs(Stream, Record);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000704#undef RECORD
705#undef BLOCK
706 Stream.ExitBlock();
707}
708
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000709/// \brief Adjusts the given filename to only write out the portion of the
710/// filename that is not part of the system root directory.
Mike Stump11289f42009-09-09 15:08:12 +0000711///
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000712/// \param Filename the file name to adjust.
713///
714/// \param isysroot When non-NULL, the PCH file is a relocatable PCH file and
715/// the returned filename will be adjusted by this system root.
716///
717/// \returns either the original filename (if it needs no adjustment) or the
718/// adjusted filename (which points into the @p Filename parameter).
Mike Stump11289f42009-09-09 15:08:12 +0000719static const char *
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000720adjustFilenameForRelocatablePCH(const char *Filename, const char *isysroot) {
721 assert(Filename && "No file name to adjust?");
Mike Stump11289f42009-09-09 15:08:12 +0000722
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000723 if (!isysroot)
724 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +0000725
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000726 // Verify that the filename and the system root have the same prefix.
727 unsigned Pos = 0;
728 for (; Filename[Pos] && isysroot[Pos]; ++Pos)
729 if (Filename[Pos] != isysroot[Pos])
730 return Filename; // Prefixes don't match.
Mike Stump11289f42009-09-09 15:08:12 +0000731
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000732 // We hit the end of the filename before we hit the end of the system root.
733 if (!Filename[Pos])
734 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +0000735
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000736 // If the file name has a '/' at the current position, skip over the '/'.
737 // We distinguish sysroot-based includes from absolute includes by the
738 // absence of '/' at the beginning of sysroot-based includes.
739 if (Filename[Pos] == '/')
740 ++Pos;
Mike Stump11289f42009-09-09 15:08:12 +0000741
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000742 return Filename + Pos;
743}
Chris Lattner28fa4e62009-04-26 22:26:21 +0000744
Douglas Gregor7b71e632009-04-27 22:23:34 +0000745/// \brief Write the PCH metadata (e.g., i686-apple-darwin9).
Sebastian Redl4d3af3e2010-07-09 21:00:24 +0000746void PCHWriter::WriteMetadata(ASTContext &Context, const PCHReader *Chain,
747 const char *isysroot) {
Douglas Gregorbfbde532009-04-10 21:16:55 +0000748 using namespace llvm;
Douglas Gregor45fe0362009-05-12 01:31:05 +0000749
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000750 // Metadata
751 const TargetInfo &Target = Context.Target;
752 BitCodeAbbrev *MetaAbbrev = new BitCodeAbbrev();
Sebastian Redl4d3af3e2010-07-09 21:00:24 +0000753 MetaAbbrev->Add(BitCodeAbbrevOp(
754 Chain ? pch::CHAINED_METADATA : pch::METADATA));
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000755 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // PCH major
756 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // PCH minor
757 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang major
758 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang minor
759 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
Sebastian Redl4d3af3e2010-07-09 21:00:24 +0000760 // Target triple or chained PCH name
761 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000762 unsigned MetaAbbrevCode = Stream.EmitAbbrev(MetaAbbrev);
Mike Stump11289f42009-09-09 15:08:12 +0000763
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000764 RecordData Record;
Sebastian Redl4d3af3e2010-07-09 21:00:24 +0000765 Record.push_back(Chain ? pch::CHAINED_METADATA : pch::METADATA);
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000766 Record.push_back(pch::VERSION_MAJOR);
767 Record.push_back(pch::VERSION_MINOR);
768 Record.push_back(CLANG_VERSION_MAJOR);
769 Record.push_back(CLANG_VERSION_MINOR);
770 Record.push_back(isysroot != 0);
Sebastian Redl4d3af3e2010-07-09 21:00:24 +0000771 // FIXME: This writes the absolute path for chained headers.
772 const std::string &BlobStr = Chain ? Chain->getFileName() : Target.getTriple().getTriple();
773 Stream.EmitRecordWithBlob(MetaAbbrevCode, Record, BlobStr);
Mike Stump11289f42009-09-09 15:08:12 +0000774
Douglas Gregor45fe0362009-05-12 01:31:05 +0000775 // Original file name
776 SourceManager &SM = Context.getSourceManager();
777 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
778 BitCodeAbbrev *FileAbbrev = new BitCodeAbbrev();
779 FileAbbrev->Add(BitCodeAbbrevOp(pch::ORIGINAL_FILE_NAME));
780 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
781 unsigned FileAbbrevCode = Stream.EmitAbbrev(FileAbbrev);
782
783 llvm::sys::Path MainFilePath(MainFile->getName());
Mike Stump11289f42009-09-09 15:08:12 +0000784
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +0000785 MainFilePath.makeAbsolute();
Douglas Gregor45fe0362009-05-12 01:31:05 +0000786
Kovarththanan Rajaratnamd16d38c2010-03-14 07:15:57 +0000787 const char *MainFileNameStr = MainFilePath.c_str();
Mike Stump11289f42009-09-09 15:08:12 +0000788 MainFileNameStr = adjustFilenameForRelocatablePCH(MainFileNameStr,
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000789 isysroot);
Douglas Gregor45fe0362009-05-12 01:31:05 +0000790 RecordData Record;
791 Record.push_back(pch::ORIGINAL_FILE_NAME);
Daniel Dunbar8100d012009-08-24 09:31:37 +0000792 Stream.EmitRecordWithBlob(FileAbbrevCode, Record, MainFileNameStr);
Douglas Gregor45fe0362009-05-12 01:31:05 +0000793 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +0000794
Ted Kremenek18e066f2010-01-22 22:12:47 +0000795 // Repository branch/version information.
796 BitCodeAbbrev *RepoAbbrev = new BitCodeAbbrev();
797 RepoAbbrev->Add(BitCodeAbbrevOp(pch::VERSION_CONTROL_BRANCH_REVISION));
798 RepoAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
799 unsigned RepoAbbrevCode = Stream.EmitAbbrev(RepoAbbrev);
Douglas Gregord54f3a12009-10-05 21:07:28 +0000800 Record.clear();
Ted Kremenek17437132010-01-22 20:59:36 +0000801 Record.push_back(pch::VERSION_CONTROL_BRANCH_REVISION);
Ted Kremenek18e066f2010-01-22 22:12:47 +0000802 Stream.EmitRecordWithBlob(RepoAbbrevCode, Record,
803 getClangFullRepositoryVersion());
Douglas Gregorbfbde532009-04-10 21:16:55 +0000804}
805
806/// \brief Write the LangOptions structure.
Douglas Gregor55abb232009-04-10 20:39:37 +0000807void PCHWriter::WriteLanguageOptions(const LangOptions &LangOpts) {
808 RecordData Record;
809 Record.push_back(LangOpts.Trigraphs);
810 Record.push_back(LangOpts.BCPLComment); // BCPL-style '//' comments.
811 Record.push_back(LangOpts.DollarIdents); // '$' allowed in identifiers.
812 Record.push_back(LangOpts.AsmPreprocessor); // Preprocessor in asm mode.
813 Record.push_back(LangOpts.GNUMode); // True in gnu99 mode false in c99 mode (etc)
Chandler Carruthe03aa552010-04-17 20:17:31 +0000814 Record.push_back(LangOpts.GNUKeywords); // Allow GNU-extension keywords
Douglas Gregor55abb232009-04-10 20:39:37 +0000815 Record.push_back(LangOpts.ImplicitInt); // C89 implicit 'int'.
816 Record.push_back(LangOpts.Digraphs); // C94, C99 and C++
817 Record.push_back(LangOpts.HexFloats); // C99 Hexadecimal float constants.
818 Record.push_back(LangOpts.C99); // C99 Support
819 Record.push_back(LangOpts.Microsoft); // Microsoft extensions.
820 Record.push_back(LangOpts.CPlusPlus); // C++ Support
821 Record.push_back(LangOpts.CPlusPlus0x); // C++0x Support
Douglas Gregor55abb232009-04-10 20:39:37 +0000822 Record.push_back(LangOpts.CXXOperatorNames); // Treat C++ operator names as keywords.
Mike Stump11289f42009-09-09 15:08:12 +0000823
Douglas Gregor55abb232009-04-10 20:39:37 +0000824 Record.push_back(LangOpts.ObjC1); // Objective-C 1 support enabled.
825 Record.push_back(LangOpts.ObjC2); // Objective-C 2 support enabled.
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +0000826 Record.push_back(LangOpts.ObjCNonFragileABI); // Objective-C
Fariborz Jahanian45878032010-02-09 19:31:38 +0000827 // modern abi enabled.
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +0000828 Record.push_back(LangOpts.ObjCNonFragileABI2); // Objective-C enhanced
Fariborz Jahanian45878032010-02-09 19:31:38 +0000829 // modern abi enabled.
Fariborz Jahanian62c56022010-04-22 21:01:59 +0000830 Record.push_back(LangOpts.NoConstantCFStrings); // non cfstring generation enabled..
Mike Stump11289f42009-09-09 15:08:12 +0000831
Douglas Gregor55abb232009-04-10 20:39:37 +0000832 Record.push_back(LangOpts.PascalStrings); // Allow Pascal strings
Douglas Gregor55abb232009-04-10 20:39:37 +0000833 Record.push_back(LangOpts.WritableStrings); // Allow writable strings
834 Record.push_back(LangOpts.LaxVectorConversions);
Nate Begemanf2911662009-06-25 23:01:11 +0000835 Record.push_back(LangOpts.AltiVec);
Douglas Gregor55abb232009-04-10 20:39:37 +0000836 Record.push_back(LangOpts.Exceptions); // Support exception handling.
Daniel Dunbar925152c2010-02-10 18:48:44 +0000837 Record.push_back(LangOpts.SjLjExceptions);
Douglas Gregor55abb232009-04-10 20:39:37 +0000838
839 Record.push_back(LangOpts.NeXTRuntime); // Use NeXT runtime.
840 Record.push_back(LangOpts.Freestanding); // Freestanding implementation
841 Record.push_back(LangOpts.NoBuiltin); // Do not use builtin functions (-fno-builtin)
842
Chris Lattner258172e2009-04-27 07:35:58 +0000843 // Whether static initializers are protected by locks.
844 Record.push_back(LangOpts.ThreadsafeStatics);
Douglas Gregorb3286fe2009-09-03 14:36:33 +0000845 Record.push_back(LangOpts.POSIXThreads);
Douglas Gregor55abb232009-04-10 20:39:37 +0000846 Record.push_back(LangOpts.Blocks); // block extension to C
847 Record.push_back(LangOpts.EmitAllDecls); // Emit all declarations, even if
848 // they are unused.
849 Record.push_back(LangOpts.MathErrno); // Math functions must respect errno
850 // (modulo the platform support).
851
Chris Lattner51924e512010-06-26 21:25:03 +0000852 Record.push_back(LangOpts.getSignedOverflowBehavior());
853 Record.push_back(LangOpts.HeinousExtensions);
Douglas Gregor55abb232009-04-10 20:39:37 +0000854
855 Record.push_back(LangOpts.Optimize); // Whether __OPTIMIZE__ should be defined.
Mike Stump11289f42009-09-09 15:08:12 +0000856 Record.push_back(LangOpts.OptimizeSize); // Whether __OPTIMIZE_SIZE__ should be
Douglas Gregor55abb232009-04-10 20:39:37 +0000857 // defined.
858 Record.push_back(LangOpts.Static); // Should __STATIC__ be defined (as
859 // opposed to __DYNAMIC__).
860 Record.push_back(LangOpts.PICLevel); // The value for __PIC__, if non-zero.
861
862 Record.push_back(LangOpts.GNUInline); // Should GNU inline semantics be
863 // used (instead of C99 semantics).
864 Record.push_back(LangOpts.NoInline); // Should __NO_INLINE__ be defined.
Anders Carlsson5879fbd2009-05-13 19:49:53 +0000865 Record.push_back(LangOpts.AccessControl); // Whether C++ access control should
866 // be enabled.
Eli Friedman9ffd4a92009-06-05 07:05:05 +0000867 Record.push_back(LangOpts.CharIsSigned); // Whether char is a signed or
868 // unsigned type
John Thompsoned4e2952009-11-05 20:14:16 +0000869 Record.push_back(LangOpts.ShortWChar); // force wchar_t to be unsigned short
Douglas Gregor55abb232009-04-10 20:39:37 +0000870 Record.push_back(LangOpts.getGCMode());
871 Record.push_back(LangOpts.getVisibilityMode());
Daniel Dunbar143021e2009-09-21 04:16:19 +0000872 Record.push_back(LangOpts.getStackProtectorMode());
Douglas Gregor55abb232009-04-10 20:39:37 +0000873 Record.push_back(LangOpts.InstantiationDepth);
Nate Begemanf2911662009-06-25 23:01:11 +0000874 Record.push_back(LangOpts.OpenCL);
Mike Stumpd9546382009-12-12 01:27:46 +0000875 Record.push_back(LangOpts.CatchUndefined);
Anders Carlsson9cedbef2009-08-22 22:30:33 +0000876 Record.push_back(LangOpts.ElideConstructors);
Douglas Gregor8ed0c0b2010-07-09 17:35:33 +0000877 Record.push_back(LangOpts.SpellChecking);
Douglas Gregor8f45df52009-04-16 22:23:12 +0000878 Stream.EmitRecord(pch::LANGUAGE_OPTIONS, Record);
Douglas Gregor55abb232009-04-10 20:39:37 +0000879}
880
Douglas Gregora7f71a92009-04-10 03:52:48 +0000881//===----------------------------------------------------------------------===//
Douglas Gregorc5046832009-04-27 18:38:38 +0000882// stat cache Serialization
883//===----------------------------------------------------------------------===//
884
885namespace {
886// Trait used for the on-disk hash table of stat cache results.
Benjamin Kramer16634c22009-11-28 10:07:24 +0000887class PCHStatCacheTrait {
Douglas Gregorc5046832009-04-27 18:38:38 +0000888public:
889 typedef const char * key_type;
890 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +0000891
Douglas Gregorc5046832009-04-27 18:38:38 +0000892 typedef std::pair<int, struct stat> data_type;
893 typedef const data_type& data_type_ref;
894
895 static unsigned ComputeHash(const char *path) {
Daniel Dunbarf8502d52009-10-17 23:52:28 +0000896 return llvm::HashString(path);
Douglas Gregorc5046832009-04-27 18:38:38 +0000897 }
Mike Stump11289f42009-09-09 15:08:12 +0000898
899 std::pair<unsigned,unsigned>
Douglas Gregorc5046832009-04-27 18:38:38 +0000900 EmitKeyDataLength(llvm::raw_ostream& Out, const char *path,
901 data_type_ref Data) {
902 unsigned StrLen = strlen(path);
903 clang::io::Emit16(Out, StrLen);
904 unsigned DataLen = 1; // result value
905 if (Data.first == 0)
906 DataLen += 4 + 4 + 2 + 8 + 8;
907 clang::io::Emit8(Out, DataLen);
908 return std::make_pair(StrLen + 1, DataLen);
909 }
Mike Stump11289f42009-09-09 15:08:12 +0000910
Douglas Gregorc5046832009-04-27 18:38:38 +0000911 void EmitKey(llvm::raw_ostream& Out, const char *path, unsigned KeyLen) {
912 Out.write(path, KeyLen);
913 }
Mike Stump11289f42009-09-09 15:08:12 +0000914
Douglas Gregorc5046832009-04-27 18:38:38 +0000915 void EmitData(llvm::raw_ostream& Out, key_type_ref,
916 data_type_ref Data, unsigned DataLen) {
917 using namespace clang::io;
918 uint64_t Start = Out.tell(); (void)Start;
Mike Stump11289f42009-09-09 15:08:12 +0000919
Douglas Gregorc5046832009-04-27 18:38:38 +0000920 // Result of stat()
921 Emit8(Out, Data.first? 1 : 0);
Mike Stump11289f42009-09-09 15:08:12 +0000922
Douglas Gregorc5046832009-04-27 18:38:38 +0000923 if (Data.first == 0) {
924 Emit32(Out, (uint32_t) Data.second.st_ino);
925 Emit32(Out, (uint32_t) Data.second.st_dev);
926 Emit16(Out, (uint16_t) Data.second.st_mode);
927 Emit64(Out, (uint64_t) Data.second.st_mtime);
928 Emit64(Out, (uint64_t) Data.second.st_size);
929 }
930
931 assert(Out.tell() - Start == DataLen && "Wrong data length");
932 }
933};
934} // end anonymous namespace
935
936/// \brief Write the stat() system call cache to the PCH file.
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000937void PCHWriter::WriteStatCache(MemorizeStatCalls &StatCalls,
938 const char *isysroot) {
Douglas Gregorc5046832009-04-27 18:38:38 +0000939 // Build the on-disk hash table containing information about every
940 // stat() call.
941 OnDiskChainedHashTableGenerator<PCHStatCacheTrait> Generator;
942 unsigned NumStatEntries = 0;
Mike Stump11289f42009-09-09 15:08:12 +0000943 for (MemorizeStatCalls::iterator Stat = StatCalls.begin(),
Douglas Gregorc5046832009-04-27 18:38:38 +0000944 StatEnd = StatCalls.end();
Douglas Gregor0086a5a2009-07-07 00:12:59 +0000945 Stat != StatEnd; ++Stat, ++NumStatEntries) {
946 const char *Filename = Stat->first();
947 Filename = adjustFilenameForRelocatablePCH(Filename, isysroot);
948 Generator.insert(Filename, Stat->second);
949 }
Mike Stump11289f42009-09-09 15:08:12 +0000950
Douglas Gregorc5046832009-04-27 18:38:38 +0000951 // Create the on-disk hash table in a buffer.
Mike Stump11289f42009-09-09 15:08:12 +0000952 llvm::SmallString<4096> StatCacheData;
Douglas Gregorc5046832009-04-27 18:38:38 +0000953 uint32_t BucketOffset;
954 {
955 llvm::raw_svector_ostream Out(StatCacheData);
956 // Make sure that no bucket is at offset 0
957 clang::io::Emit32(Out, 0);
958 BucketOffset = Generator.Emit(Out);
959 }
960
961 // Create a blob abbreviation
962 using namespace llvm;
963 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
964 Abbrev->Add(BitCodeAbbrevOp(pch::STAT_CACHE));
965 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
966 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
967 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
968 unsigned StatCacheAbbrev = Stream.EmitAbbrev(Abbrev);
969
970 // Write the stat cache
971 RecordData Record;
972 Record.push_back(pch::STAT_CACHE);
973 Record.push_back(BucketOffset);
974 Record.push_back(NumStatEntries);
Daniel Dunbar8100d012009-08-24 09:31:37 +0000975 Stream.EmitRecordWithBlob(StatCacheAbbrev, Record, StatCacheData.str());
Douglas Gregorc5046832009-04-27 18:38:38 +0000976}
977
978//===----------------------------------------------------------------------===//
Douglas Gregora7f71a92009-04-10 03:52:48 +0000979// Source Manager Serialization
980//===----------------------------------------------------------------------===//
981
982/// \brief Create an abbreviation for the SLocEntry that refers to a
983/// file.
Douglas Gregor8f45df52009-04-16 22:23:12 +0000984static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +0000985 using namespace llvm;
986 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
987 Abbrev->Add(BitCodeAbbrevOp(pch::SM_SLOC_FILE_ENTRY));
988 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
989 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
990 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
991 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
Douglas Gregorb41ca8f2010-03-21 22:49:54 +0000992 // FileEntry fields.
993 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
994 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
Douglas Gregor5712ebc2010-03-16 16:35:32 +0000995 // HeaderFileInfo fields.
996 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isImport
997 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // DirInfo
998 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumIncludes
999 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // ControllingMacro
Douglas Gregora7f71a92009-04-10 03:52:48 +00001000 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
Douglas Gregor8f45df52009-04-16 22:23:12 +00001001 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001002}
1003
1004/// \brief Create an abbreviation for the SLocEntry that refers to a
1005/// buffer.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001006static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001007 using namespace llvm;
1008 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1009 Abbrev->Add(BitCodeAbbrevOp(pch::SM_SLOC_BUFFER_ENTRY));
1010 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1011 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1012 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1013 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1014 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
Douglas Gregor8f45df52009-04-16 22:23:12 +00001015 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001016}
1017
1018/// \brief Create an abbreviation for the SLocEntry that refers to a
1019/// buffer's blob.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001020static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001021 using namespace llvm;
1022 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1023 Abbrev->Add(BitCodeAbbrevOp(pch::SM_SLOC_BUFFER_BLOB));
1024 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
Douglas Gregor8f45df52009-04-16 22:23:12 +00001025 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001026}
1027
1028/// \brief Create an abbreviation for the SLocEntry that refers to an
1029/// buffer.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001030static unsigned CreateSLocInstantiationAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001031 using namespace llvm;
1032 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1033 Abbrev->Add(BitCodeAbbrevOp(pch::SM_SLOC_INSTANTIATION_ENTRY));
1034 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1035 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1036 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1037 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
Douglas Gregor83243272009-04-15 18:05:10 +00001038 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
Douglas Gregor8f45df52009-04-16 22:23:12 +00001039 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001040}
1041
1042/// \brief Writes the block containing the serialized form of the
1043/// source manager.
1044///
1045/// TODO: We should probably use an on-disk hash table (stored in a
1046/// blob), indexed based on the file name, so that we only create
1047/// entries for files that we actually need. In the common case (no
1048/// errors), we probably won't have to create file entries for any of
1049/// the files in the AST.
Douglas Gregoreda6a892009-04-26 00:07:37 +00001050void PCHWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001051 const Preprocessor &PP,
1052 const char *isysroot) {
Douglas Gregor258ae542009-04-27 06:38:32 +00001053 RecordData Record;
1054
Chris Lattner0910e3b2009-04-10 17:16:57 +00001055 // Enter the source manager block.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001056 Stream.EnterSubblock(pch::SOURCE_MANAGER_BLOCK_ID, 3);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001057
1058 // Abbreviations for the various kinds of source-location entries.
Chris Lattnerc4976c732009-04-27 19:03:22 +00001059 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
1060 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
1061 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream);
1062 unsigned SLocInstantiationAbbrv = CreateSLocInstantiationAbbrev(Stream);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001063
Douglas Gregor4c7626e2009-04-13 16:31:14 +00001064 // Write the line table.
1065 if (SourceMgr.hasLineTable()) {
1066 LineTableInfo &LineTable = SourceMgr.getLineTable();
1067
1068 // Emit the file names
1069 Record.push_back(LineTable.getNumFilenames());
1070 for (unsigned I = 0, N = LineTable.getNumFilenames(); I != N; ++I) {
1071 // Emit the file name
1072 const char *Filename = LineTable.getFilename(I);
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001073 Filename = adjustFilenameForRelocatablePCH(Filename, isysroot);
Douglas Gregor4c7626e2009-04-13 16:31:14 +00001074 unsigned FilenameLen = Filename? strlen(Filename) : 0;
1075 Record.push_back(FilenameLen);
1076 if (FilenameLen)
1077 Record.insert(Record.end(), Filename, Filename + FilenameLen);
1078 }
Mike Stump11289f42009-09-09 15:08:12 +00001079
Douglas Gregor4c7626e2009-04-13 16:31:14 +00001080 // Emit the line entries
1081 for (LineTableInfo::iterator L = LineTable.begin(), LEnd = LineTable.end();
1082 L != LEnd; ++L) {
1083 // Emit the file ID
1084 Record.push_back(L->first);
Mike Stump11289f42009-09-09 15:08:12 +00001085
Douglas Gregor4c7626e2009-04-13 16:31:14 +00001086 // Emit the line entries
1087 Record.push_back(L->second.size());
Mike Stump11289f42009-09-09 15:08:12 +00001088 for (std::vector<LineEntry>::iterator LE = L->second.begin(),
Douglas Gregor4c7626e2009-04-13 16:31:14 +00001089 LEEnd = L->second.end();
1090 LE != LEEnd; ++LE) {
1091 Record.push_back(LE->FileOffset);
1092 Record.push_back(LE->LineNo);
1093 Record.push_back(LE->FilenameID);
1094 Record.push_back((unsigned)LE->FileKind);
1095 Record.push_back(LE->IncludeOffset);
1096 }
Douglas Gregor4c7626e2009-04-13 16:31:14 +00001097 }
Zhongxing Xu5a187dd2009-05-22 08:38:27 +00001098 Stream.EmitRecord(pch::SM_LINE_TABLE, Record);
Douglas Gregor4c7626e2009-04-13 16:31:14 +00001099 }
1100
Douglas Gregor258ae542009-04-27 06:38:32 +00001101 // Write out the source location entry table. We skip the first
1102 // entry, which is always the same dummy entry.
Chris Lattner12d61d32009-04-27 19:01:47 +00001103 std::vector<uint32_t> SLocEntryOffsets;
Douglas Gregor258ae542009-04-27 06:38:32 +00001104 RecordData PreloadSLocs;
1105 SLocEntryOffsets.reserve(SourceMgr.sloc_entry_size() - 1);
Douglas Gregor8655e882009-10-16 22:46:09 +00001106 for (unsigned I = 1, N = SourceMgr.sloc_entry_size(); I != N; ++I) {
1107 // Get this source location entry.
1108 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getSLocEntry(I);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001109
Douglas Gregor258ae542009-04-27 06:38:32 +00001110 // Record the offset of this source-location entry.
1111 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
1112
1113 // Figure out which record code to use.
1114 unsigned Code;
1115 if (SLoc->isFile()) {
1116 if (SLoc->getFile().getContentCache()->Entry)
1117 Code = pch::SM_SLOC_FILE_ENTRY;
1118 else
1119 Code = pch::SM_SLOC_BUFFER_ENTRY;
1120 } else
1121 Code = pch::SM_SLOC_INSTANTIATION_ENTRY;
1122 Record.clear();
1123 Record.push_back(Code);
1124
1125 Record.push_back(SLoc->getOffset());
1126 if (SLoc->isFile()) {
1127 const SrcMgr::FileInfo &File = SLoc->getFile();
1128 Record.push_back(File.getIncludeLoc().getRawEncoding());
1129 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
1130 Record.push_back(File.hasLineDirectives());
1131
1132 const SrcMgr::ContentCache *Content = File.getContentCache();
1133 if (Content->Entry) {
1134 // The source location entry is a file. The blob associated
1135 // with this entry is the file name.
Mike Stump11289f42009-09-09 15:08:12 +00001136
Douglas Gregorb41ca8f2010-03-21 22:49:54 +00001137 // Emit size/modification time for this file.
1138 Record.push_back(Content->Entry->getSize());
1139 Record.push_back(Content->Entry->getModificationTime());
1140
Douglas Gregor5712ebc2010-03-16 16:35:32 +00001141 // Emit header-search information associated with this file.
1142 HeaderFileInfo HFI;
1143 HeaderSearch &HS = PP.getHeaderSearchInfo();
1144 if (Content->Entry->getUID() < HS.header_file_size())
1145 HFI = HS.header_file_begin()[Content->Entry->getUID()];
1146 Record.push_back(HFI.isImport);
1147 Record.push_back(HFI.DirInfo);
1148 Record.push_back(HFI.NumIncludes);
1149 AddIdentifierRef(HFI.ControllingMacro, Record);
1150
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001151 // Turn the file name into an absolute path, if it isn't already.
1152 const char *Filename = Content->Entry->getName();
1153 llvm::sys::Path FilePath(Filename, strlen(Filename));
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001154 FilePath.makeAbsolute();
Kovarththanan Rajaratnamd16d38c2010-03-14 07:15:57 +00001155 Filename = FilePath.c_str();
Mike Stump11289f42009-09-09 15:08:12 +00001156
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001157 Filename = adjustFilenameForRelocatablePCH(Filename, isysroot);
Daniel Dunbar8100d012009-08-24 09:31:37 +00001158 Stream.EmitRecordWithBlob(SLocFileAbbrv, Record, Filename);
Douglas Gregor258ae542009-04-27 06:38:32 +00001159
1160 // FIXME: For now, preload all file source locations, so that
1161 // we get the appropriate File entries in the reader. This is
1162 // a temporary measure.
1163 PreloadSLocs.push_back(SLocEntryOffsets.size());
1164 } else {
1165 // The source location entry is a buffer. The blob associated
1166 // with this entry contains the contents of the buffer.
1167
1168 // We add one to the size so that we capture the trailing NULL
1169 // that is required by llvm::MemoryBuffer::getMemBuffer (on
1170 // the reader side).
Douglas Gregor874cc622010-03-16 00:35:39 +00001171 const llvm::MemoryBuffer *Buffer
Chris Lattnerfb24a3a2010-04-20 20:35:58 +00001172 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
Douglas Gregor258ae542009-04-27 06:38:32 +00001173 const char *Name = Buffer->getBufferIdentifier();
Daniel Dunbar8100d012009-08-24 09:31:37 +00001174 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
1175 llvm::StringRef(Name, strlen(Name) + 1));
Douglas Gregor258ae542009-04-27 06:38:32 +00001176 Record.clear();
1177 Record.push_back(pch::SM_SLOC_BUFFER_BLOB);
1178 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record,
Daniel Dunbar8100d012009-08-24 09:31:37 +00001179 llvm::StringRef(Buffer->getBufferStart(),
1180 Buffer->getBufferSize() + 1));
Douglas Gregor258ae542009-04-27 06:38:32 +00001181
1182 if (strcmp(Name, "<built-in>") == 0)
1183 PreloadSLocs.push_back(SLocEntryOffsets.size());
1184 }
1185 } else {
1186 // The source location entry is an instantiation.
1187 const SrcMgr::InstantiationInfo &Inst = SLoc->getInstantiation();
1188 Record.push_back(Inst.getSpellingLoc().getRawEncoding());
1189 Record.push_back(Inst.getInstantiationLocStart().getRawEncoding());
1190 Record.push_back(Inst.getInstantiationLocEnd().getRawEncoding());
1191
1192 // Compute the token length for this macro expansion.
1193 unsigned NextOffset = SourceMgr.getNextOffset();
Douglas Gregor8655e882009-10-16 22:46:09 +00001194 if (I + 1 != N)
1195 NextOffset = SourceMgr.getSLocEntry(I + 1).getOffset();
Douglas Gregor258ae542009-04-27 06:38:32 +00001196 Record.push_back(NextOffset - SLoc->getOffset() - 1);
1197 Stream.EmitRecordWithAbbrev(SLocInstantiationAbbrv, Record);
1198 }
1199 }
1200
Douglas Gregor8f45df52009-04-16 22:23:12 +00001201 Stream.ExitBlock();
Douglas Gregor258ae542009-04-27 06:38:32 +00001202
1203 if (SLocEntryOffsets.empty())
1204 return;
1205
1206 // Write the source-location offsets table into the PCH block. This
1207 // table is used for lazily loading source-location information.
1208 using namespace llvm;
1209 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1210 Abbrev->Add(BitCodeAbbrevOp(pch::SOURCE_LOCATION_OFFSETS));
1211 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
1212 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // next offset
1213 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
1214 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(Abbrev);
Mike Stump11289f42009-09-09 15:08:12 +00001215
Douglas Gregor258ae542009-04-27 06:38:32 +00001216 Record.clear();
1217 Record.push_back(pch::SOURCE_LOCATION_OFFSETS);
1218 Record.push_back(SLocEntryOffsets.size());
1219 Record.push_back(SourceMgr.getNextOffset());
1220 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
Mike Stump11289f42009-09-09 15:08:12 +00001221 (const char *)&SLocEntryOffsets.front(),
Chris Lattner12d61d32009-04-27 19:01:47 +00001222 SLocEntryOffsets.size()*sizeof(SLocEntryOffsets[0]));
Douglas Gregor258ae542009-04-27 06:38:32 +00001223
1224 // Write the source location entry preloads array, telling the PCH
1225 // reader which source locations entries it should load eagerly.
1226 Stream.EmitRecord(pch::SOURCE_LOCATION_PRELOADS, PreloadSLocs);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001227}
1228
Douglas Gregorc5046832009-04-27 18:38:38 +00001229//===----------------------------------------------------------------------===//
1230// Preprocessor Serialization
1231//===----------------------------------------------------------------------===//
1232
Chris Lattnereeffaef2009-04-10 17:15:23 +00001233/// \brief Writes the block containing the serialized form of the
1234/// preprocessor.
1235///
Chris Lattner2199f5b2009-04-10 18:08:30 +00001236void PCHWriter::WritePreprocessor(const Preprocessor &PP) {
Chris Lattnerbaa52f42009-04-10 18:00:12 +00001237 RecordData Record;
Chris Lattner0910e3b2009-04-10 17:16:57 +00001238
Chris Lattner0af3ba12009-04-13 01:29:17 +00001239 // If the preprocessor __COUNTER__ value has been bumped, remember it.
1240 if (PP.getCounterValue() != 0) {
1241 Record.push_back(PP.getCounterValue());
Douglas Gregor8f45df52009-04-16 22:23:12 +00001242 Stream.EmitRecord(pch::PP_COUNTER_VALUE, Record);
Chris Lattner0af3ba12009-04-13 01:29:17 +00001243 Record.clear();
Douglas Gregoreda6a892009-04-26 00:07:37 +00001244 }
1245
1246 // Enter the preprocessor block.
1247 Stream.EnterSubblock(pch::PREPROCESSOR_BLOCK_ID, 2);
Mike Stump11289f42009-09-09 15:08:12 +00001248
Douglas Gregoreda6a892009-04-26 00:07:37 +00001249 // If the PCH file contains __DATE__ or __TIME__ emit a warning about this.
1250 // FIXME: use diagnostics subsystem for localization etc.
1251 if (PP.SawDateOrTime())
1252 fprintf(stderr, "warning: precompiled header used __DATE__ or __TIME__.\n");
Mike Stump11289f42009-09-09 15:08:12 +00001253
Chris Lattnerbaa52f42009-04-10 18:00:12 +00001254 // Loop over all the macro definitions that are live at the end of the file,
1255 // emitting each to the PP section.
Douglas Gregoraae92242010-03-19 21:51:54 +00001256 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
Chris Lattnerbaa52f42009-04-10 18:00:12 +00001257 for (Preprocessor::macro_iterator I = PP.macro_begin(), E = PP.macro_end();
1258 I != E; ++I) {
Chris Lattner34321bc2009-04-10 21:41:48 +00001259 // FIXME: This emits macros in hash table order, we should do it in a stable
1260 // order so that output is reproducible.
Chris Lattnerbaa52f42009-04-10 18:00:12 +00001261 MacroInfo *MI = I->second;
1262
1263 // Don't emit builtin macros like __LINE__ to the PCH file unless they have
1264 // been redefined by the header (in which case they are not isBuiltinMacro).
1265 if (MI->isBuiltinMacro())
1266 continue;
1267
Chris Lattnerc523d8e2009-04-11 21:15:38 +00001268 AddIdentifierRef(I->first, Record);
Douglas Gregorc3366a52009-04-21 23:56:24 +00001269 MacroOffsets[I->first] = Stream.GetCurrentBitNo();
Chris Lattnerbaa52f42009-04-10 18:00:12 +00001270 Record.push_back(MI->getDefinitionLoc().getRawEncoding());
1271 Record.push_back(MI->isUsed());
Mike Stump11289f42009-09-09 15:08:12 +00001272
Chris Lattnerbaa52f42009-04-10 18:00:12 +00001273 unsigned Code;
1274 if (MI->isObjectLike()) {
1275 Code = pch::PP_MACRO_OBJECT_LIKE;
1276 } else {
1277 Code = pch::PP_MACRO_FUNCTION_LIKE;
Mike Stump11289f42009-09-09 15:08:12 +00001278
Chris Lattnerbaa52f42009-04-10 18:00:12 +00001279 Record.push_back(MI->isC99Varargs());
1280 Record.push_back(MI->isGNUVarargs());
1281 Record.push_back(MI->getNumArgs());
1282 for (MacroInfo::arg_iterator I = MI->arg_begin(), E = MI->arg_end();
1283 I != E; ++I)
Chris Lattnerc523d8e2009-04-11 21:15:38 +00001284 AddIdentifierRef(*I, Record);
Chris Lattnerbaa52f42009-04-10 18:00:12 +00001285 }
Douglas Gregoraae92242010-03-19 21:51:54 +00001286
1287 // If we have a detailed preprocessing record, record the macro definition
1288 // ID that corresponds to this macro.
1289 if (PPRec)
1290 Record.push_back(getMacroDefinitionID(PPRec->findMacroDefinition(MI)));
1291
Douglas Gregor8f45df52009-04-16 22:23:12 +00001292 Stream.EmitRecord(Code, Record);
Chris Lattnerbaa52f42009-04-10 18:00:12 +00001293 Record.clear();
1294
Chris Lattner2199f5b2009-04-10 18:08:30 +00001295 // Emit the tokens array.
1296 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
1297 // Note that we know that the preprocessor does not have any annotation
1298 // tokens in it because they are created by the parser, and thus can't be
1299 // in a macro definition.
1300 const Token &Tok = MI->getReplacementToken(TokNo);
Mike Stump11289f42009-09-09 15:08:12 +00001301
Chris Lattner2199f5b2009-04-10 18:08:30 +00001302 Record.push_back(Tok.getLocation().getRawEncoding());
1303 Record.push_back(Tok.getLength());
1304
Chris Lattner2199f5b2009-04-10 18:08:30 +00001305 // FIXME: When reading literal tokens, reconstruct the literal pointer if
1306 // it is needed.
Chris Lattnerc523d8e2009-04-11 21:15:38 +00001307 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
Mike Stump11289f42009-09-09 15:08:12 +00001308
Chris Lattner2199f5b2009-04-10 18:08:30 +00001309 // FIXME: Should translate token kind to a stable encoding.
1310 Record.push_back(Tok.getKind());
1311 // FIXME: Should translate token flags to a stable encoding.
1312 Record.push_back(Tok.getFlags());
Mike Stump11289f42009-09-09 15:08:12 +00001313
Douglas Gregor8f45df52009-04-16 22:23:12 +00001314 Stream.EmitRecord(pch::PP_TOKEN, Record);
Chris Lattner2199f5b2009-04-10 18:08:30 +00001315 Record.clear();
1316 }
Douglas Gregorc3366a52009-04-21 23:56:24 +00001317 ++NumMacros;
Chris Lattnerbaa52f42009-04-10 18:00:12 +00001318 }
Douglas Gregoraae92242010-03-19 21:51:54 +00001319
1320 // If the preprocessor has a preprocessing record, emit it.
1321 unsigned NumPreprocessingRecords = 0;
1322 if (PPRec) {
1323 for (PreprocessingRecord::iterator E = PPRec->begin(), EEnd = PPRec->end();
1324 E != EEnd; ++E) {
1325 Record.clear();
1326
1327 if (MacroInstantiation *MI = dyn_cast<MacroInstantiation>(*E)) {
1328 Record.push_back(NumPreprocessingRecords++);
1329 AddSourceLocation(MI->getSourceRange().getBegin(), Record);
1330 AddSourceLocation(MI->getSourceRange().getEnd(), Record);
1331 AddIdentifierRef(MI->getName(), Record);
1332 Record.push_back(getMacroDefinitionID(MI->getDefinition()));
1333 Stream.EmitRecord(pch::PP_MACRO_INSTANTIATION, Record);
1334 continue;
1335 }
1336
1337 if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) {
1338 // Record this macro definition's location.
1339 pch::IdentID ID = getMacroDefinitionID(MD);
1340 if (ID != MacroDefinitionOffsets.size()) {
1341 if (ID > MacroDefinitionOffsets.size())
1342 MacroDefinitionOffsets.resize(ID + 1);
1343
1344 MacroDefinitionOffsets[ID] = Stream.GetCurrentBitNo();
1345 } else
1346 MacroDefinitionOffsets.push_back(Stream.GetCurrentBitNo());
1347
1348 Record.push_back(NumPreprocessingRecords++);
1349 Record.push_back(ID);
1350 AddSourceLocation(MD->getSourceRange().getBegin(), Record);
1351 AddSourceLocation(MD->getSourceRange().getEnd(), Record);
1352 AddIdentifierRef(MD->getName(), Record);
1353 AddSourceLocation(MD->getLocation(), Record);
1354 Stream.EmitRecord(pch::PP_MACRO_DEFINITION, Record);
1355 continue;
1356 }
1357 }
1358 }
1359
Douglas Gregor8f45df52009-04-16 22:23:12 +00001360 Stream.ExitBlock();
Douglas Gregoraae92242010-03-19 21:51:54 +00001361
1362 // Write the offsets table for the preprocessing record.
1363 if (NumPreprocessingRecords > 0) {
1364 // Write the offsets table for identifier IDs.
1365 using namespace llvm;
1366 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1367 Abbrev->Add(BitCodeAbbrevOp(pch::MACRO_DEFINITION_OFFSETS));
1368 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of records
1369 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macro defs
1370 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1371 unsigned MacroDefOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1372
1373 Record.clear();
1374 Record.push_back(pch::MACRO_DEFINITION_OFFSETS);
1375 Record.push_back(NumPreprocessingRecords);
1376 Record.push_back(MacroDefinitionOffsets.size());
1377 Stream.EmitRecordWithBlob(MacroDefOffsetAbbrev, Record,
1378 (const char *)&MacroDefinitionOffsets.front(),
1379 MacroDefinitionOffsets.size() * sizeof(uint32_t));
1380 }
Chris Lattnereeffaef2009-04-10 17:15:23 +00001381}
1382
Douglas Gregorc5046832009-04-27 18:38:38 +00001383//===----------------------------------------------------------------------===//
1384// Type Serialization
1385//===----------------------------------------------------------------------===//
Chris Lattnereeffaef2009-04-10 17:15:23 +00001386
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001387/// \brief Write the representation of a type to the PCH stream.
John McCall8ccfcb52009-09-24 19:53:00 +00001388void PCHWriter::WriteType(QualType T) {
Douglas Gregor1e9bf3b2009-04-10 17:25:41 +00001389 pch::TypeID &ID = TypeIDs[T];
Chris Lattner0910e3b2009-04-10 17:16:57 +00001390 if (ID == 0) // we haven't seen this type before.
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001391 ID = NextTypeID++;
Mike Stump11289f42009-09-09 15:08:12 +00001392
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001393 // Record the offset for this type.
1394 if (TypeOffsets.size() == ID - pch::NUM_PREDEF_TYPE_IDS)
Douglas Gregor8f45df52009-04-16 22:23:12 +00001395 TypeOffsets.push_back(Stream.GetCurrentBitNo());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001396 else if (TypeOffsets.size() < ID - pch::NUM_PREDEF_TYPE_IDS) {
1397 TypeOffsets.resize(ID + 1 - pch::NUM_PREDEF_TYPE_IDS);
Douglas Gregor8f45df52009-04-16 22:23:12 +00001398 TypeOffsets[ID - pch::NUM_PREDEF_TYPE_IDS] = Stream.GetCurrentBitNo();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001399 }
1400
1401 RecordData Record;
Mike Stump11289f42009-09-09 15:08:12 +00001402
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001403 // Emit the type's representation.
1404 PCHTypeWriter W(*this, Record);
John McCall8ccfcb52009-09-24 19:53:00 +00001405
Douglas Gregor1b8fe5b72009-11-16 21:35:15 +00001406 if (T.hasLocalNonFastQualifiers()) {
1407 Qualifiers Qs = T.getLocalQualifiers();
1408 AddTypeRef(T.getLocalUnqualifiedType(), Record);
John McCall8ccfcb52009-09-24 19:53:00 +00001409 Record.push_back(Qs.getAsOpaqueValue());
1410 W.Code = pch::TYPE_EXT_QUAL;
1411 } else {
1412 switch (T->getTypeClass()) {
1413 // For all of the concrete, non-dependent types, call the
1414 // appropriate visitor function.
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001415#define TYPE(Class, Base) \
Mike Stump281d6d72010-01-20 02:03:14 +00001416 case Type::Class: W.Visit##Class##Type(cast<Class##Type>(T)); break;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001417#define ABSTRACT_TYPE(Class, Base)
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001418#include "clang/AST/TypeNodes.def"
John McCall8ccfcb52009-09-24 19:53:00 +00001419 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001420 }
1421
1422 // Emit the serialized record.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001423 Stream.EmitRecord(W.Code, Record);
Douglas Gregorfeb84b02009-04-14 21:18:50 +00001424
1425 // Flush any expressions that were written as part of this type.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001426 FlushStmts();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001427}
1428
Douglas Gregorc5046832009-04-27 18:38:38 +00001429//===----------------------------------------------------------------------===//
1430// Declaration Serialization
1431//===----------------------------------------------------------------------===//
1432
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001433/// \brief Write the block containing all of the declaration IDs
1434/// lexically declared within the given DeclContext.
1435///
1436/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
1437/// bistream, or 0 if no block was written.
Mike Stump11289f42009-09-09 15:08:12 +00001438uint64_t PCHWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001439 DeclContext *DC) {
Argyrios Kyrtzidiscfbfe782009-06-30 02:36:12 +00001440 if (DC->decls_empty())
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001441 return 0;
1442
Douglas Gregor8f45df52009-04-16 22:23:12 +00001443 uint64_t Offset = Stream.GetCurrentBitNo();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001444 RecordData Record;
Argyrios Kyrtzidiscfbfe782009-06-30 02:36:12 +00001445 for (DeclContext::decl_iterator D = DC->decls_begin(), DEnd = DC->decls_end();
1446 D != DEnd; ++D)
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001447 AddDeclRef(*D, Record);
1448
Douglas Gregora57c3ab2009-04-22 22:34:57 +00001449 ++NumLexicalDeclContexts;
Douglas Gregor8f45df52009-04-16 22:23:12 +00001450 Stream.EmitRecord(pch::DECL_CONTEXT_LEXICAL, Record);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001451 return Offset;
1452}
1453
1454/// \brief Write the block containing all of the declaration IDs
1455/// visible from the given DeclContext.
1456///
1457/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
1458/// bistream, or 0 if no block was written.
1459uint64_t PCHWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
1460 DeclContext *DC) {
1461 if (DC->getPrimaryContext() != DC)
1462 return 0;
1463
Argyrios Kyrtzidis74d28bd2010-06-29 22:47:00 +00001464 // Since there is no name lookup into functions or methods, don't bother to
1465 // build a visible-declarations table for these entities.
1466 if (DC->isFunctionOrMethod())
1467 return 0;
1468
1469 // If not in C++, we perform name lookup for the translation unit via the
1470 // IdentifierInfo chains, don't bother to build a visible-declarations table.
1471 // FIXME: In C++ we need the visible declarations in order to "see" the
1472 // friend declarations, is there a way to do this without writing the table ?
1473 if (DC->isTranslationUnit() && !Context.getLangOptions().CPlusPlus)
Douglas Gregor13d190f2009-04-18 15:49:20 +00001474 return 0;
1475
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001476 // Force the DeclContext to build a its name-lookup table.
Argyrios Kyrtzidiscfbfe782009-06-30 02:36:12 +00001477 DC->lookup(DeclarationName());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001478
1479 // Serialize the contents of the mapping used for lookup. Note that,
1480 // although we have two very different code paths, the serialized
1481 // representation is the same for both cases: a declaration name,
1482 // followed by a size, followed by references to the visible
1483 // declarations that have that name.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001484 uint64_t Offset = Stream.GetCurrentBitNo();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001485 RecordData Record;
1486 StoredDeclsMap *Map = static_cast<StoredDeclsMap*>(DC->getLookupPtr());
Douglas Gregor183671e2009-04-13 21:20:57 +00001487 if (!Map)
1488 return 0;
1489
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001490 for (StoredDeclsMap::iterator D = Map->begin(), DEnd = Map->end();
1491 D != DEnd; ++D) {
1492 AddDeclarationName(D->first, Record);
1493 DeclContext::lookup_result Result = D->second.getLookupResult(Context);
1494 Record.push_back(Result.second - Result.first);
Mike Stump11289f42009-09-09 15:08:12 +00001495 for (; Result.first != Result.second; ++Result.first)
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001496 AddDeclRef(*Result.first, Record);
1497 }
1498
1499 if (Record.size() == 0)
1500 return 0;
1501
Douglas Gregor8f45df52009-04-16 22:23:12 +00001502 Stream.EmitRecord(pch::DECL_CONTEXT_VISIBLE, Record);
Douglas Gregora57c3ab2009-04-22 22:34:57 +00001503 ++NumVisibleDeclContexts;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00001504 return Offset;
1505}
1506
Douglas Gregorc5046832009-04-27 18:38:38 +00001507//===----------------------------------------------------------------------===//
1508// Global Method Pool and Selector Serialization
1509//===----------------------------------------------------------------------===//
1510
Douglas Gregore84a9da2009-04-20 20:36:09 +00001511namespace {
Douglas Gregorc78d3462009-04-24 21:10:55 +00001512// Trait used for the on-disk hash table used in the method pool.
Benjamin Kramer16634c22009-11-28 10:07:24 +00001513class PCHMethodPoolTrait {
Douglas Gregorc78d3462009-04-24 21:10:55 +00001514 PCHWriter &Writer;
1515
1516public:
1517 typedef Selector key_type;
1518 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00001519
Douglas Gregorc78d3462009-04-24 21:10:55 +00001520 typedef std::pair<ObjCMethodList, ObjCMethodList> data_type;
1521 typedef const data_type& data_type_ref;
1522
1523 explicit PCHMethodPoolTrait(PCHWriter &Writer) : Writer(Writer) { }
Mike Stump11289f42009-09-09 15:08:12 +00001524
Douglas Gregorc78d3462009-04-24 21:10:55 +00001525 static unsigned ComputeHash(Selector Sel) {
1526 unsigned N = Sel.getNumArgs();
1527 if (N == 0)
1528 ++N;
1529 unsigned R = 5381;
1530 for (unsigned I = 0; I != N; ++I)
1531 if (IdentifierInfo *II = Sel.getIdentifierInfoForSlot(I))
Daniel Dunbarf8502d52009-10-17 23:52:28 +00001532 R = llvm::HashString(II->getName(), R);
Douglas Gregorc78d3462009-04-24 21:10:55 +00001533 return R;
1534 }
Mike Stump11289f42009-09-09 15:08:12 +00001535
1536 std::pair<unsigned,unsigned>
Douglas Gregorc78d3462009-04-24 21:10:55 +00001537 EmitKeyDataLength(llvm::raw_ostream& Out, Selector Sel,
1538 data_type_ref Methods) {
1539 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
1540 clang::io::Emit16(Out, KeyLen);
1541 unsigned DataLen = 2 + 2; // 2 bytes for each of the method counts
Mike Stump11289f42009-09-09 15:08:12 +00001542 for (const ObjCMethodList *Method = &Methods.first; Method;
Douglas Gregorc78d3462009-04-24 21:10:55 +00001543 Method = Method->Next)
1544 if (Method->Method)
1545 DataLen += 4;
Mike Stump11289f42009-09-09 15:08:12 +00001546 for (const ObjCMethodList *Method = &Methods.second; Method;
Douglas Gregorc78d3462009-04-24 21:10:55 +00001547 Method = Method->Next)
1548 if (Method->Method)
1549 DataLen += 4;
1550 clang::io::Emit16(Out, DataLen);
1551 return std::make_pair(KeyLen, DataLen);
1552 }
Mike Stump11289f42009-09-09 15:08:12 +00001553
Douglas Gregor95c13f52009-04-25 17:48:32 +00001554 void EmitKey(llvm::raw_ostream& Out, Selector Sel, unsigned) {
Mike Stump11289f42009-09-09 15:08:12 +00001555 uint64_t Start = Out.tell();
Douglas Gregor95c13f52009-04-25 17:48:32 +00001556 assert((Start >> 32) == 0 && "Selector key offset too large");
1557 Writer.SetSelectorOffset(Sel, Start);
Douglas Gregorc78d3462009-04-24 21:10:55 +00001558 unsigned N = Sel.getNumArgs();
1559 clang::io::Emit16(Out, N);
1560 if (N == 0)
1561 N = 1;
1562 for (unsigned I = 0; I != N; ++I)
Mike Stump11289f42009-09-09 15:08:12 +00001563 clang::io::Emit32(Out,
Douglas Gregorc78d3462009-04-24 21:10:55 +00001564 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
1565 }
Mike Stump11289f42009-09-09 15:08:12 +00001566
Douglas Gregorc78d3462009-04-24 21:10:55 +00001567 void EmitData(llvm::raw_ostream& Out, key_type_ref,
Douglas Gregor4647cfa2009-04-24 21:49:02 +00001568 data_type_ref Methods, unsigned DataLen) {
1569 uint64_t Start = Out.tell(); (void)Start;
Douglas Gregorc78d3462009-04-24 21:10:55 +00001570 unsigned NumInstanceMethods = 0;
Mike Stump11289f42009-09-09 15:08:12 +00001571 for (const ObjCMethodList *Method = &Methods.first; Method;
Douglas Gregorc78d3462009-04-24 21:10:55 +00001572 Method = Method->Next)
1573 if (Method->Method)
1574 ++NumInstanceMethods;
1575
1576 unsigned NumFactoryMethods = 0;
Mike Stump11289f42009-09-09 15:08:12 +00001577 for (const ObjCMethodList *Method = &Methods.second; Method;
Douglas Gregorc78d3462009-04-24 21:10:55 +00001578 Method = Method->Next)
1579 if (Method->Method)
1580 ++NumFactoryMethods;
1581
1582 clang::io::Emit16(Out, NumInstanceMethods);
1583 clang::io::Emit16(Out, NumFactoryMethods);
Mike Stump11289f42009-09-09 15:08:12 +00001584 for (const ObjCMethodList *Method = &Methods.first; Method;
Douglas Gregorc78d3462009-04-24 21:10:55 +00001585 Method = Method->Next)
1586 if (Method->Method)
1587 clang::io::Emit32(Out, Writer.getDeclID(Method->Method));
Mike Stump11289f42009-09-09 15:08:12 +00001588 for (const ObjCMethodList *Method = &Methods.second; Method;
Douglas Gregorc78d3462009-04-24 21:10:55 +00001589 Method = Method->Next)
1590 if (Method->Method)
1591 clang::io::Emit32(Out, Writer.getDeclID(Method->Method));
Douglas Gregor4647cfa2009-04-24 21:49:02 +00001592
1593 assert(Out.tell() - Start == DataLen && "Data length is wrong");
Douglas Gregorc78d3462009-04-24 21:10:55 +00001594 }
1595};
1596} // end anonymous namespace
1597
1598/// \brief Write the method pool into the PCH file.
1599///
1600/// The method pool contains both instance and factory methods, stored
1601/// in an on-disk hash table indexed by the selector.
1602void PCHWriter::WriteMethodPool(Sema &SemaRef) {
1603 using namespace llvm;
1604
1605 // Create and write out the blob that contains the instance and
1606 // factor method pools.
1607 bool Empty = true;
1608 {
1609 OnDiskChainedHashTableGenerator<PCHMethodPoolTrait> Generator;
Mike Stump11289f42009-09-09 15:08:12 +00001610
Douglas Gregorc78d3462009-04-24 21:10:55 +00001611 // Create the on-disk hash table representation. Start by
1612 // iterating through the instance method pool.
1613 PCHMethodPoolTrait::key_type Key;
Douglas Gregor95c13f52009-04-25 17:48:32 +00001614 unsigned NumSelectorsInMethodPool = 0;
Douglas Gregorc78d3462009-04-24 21:10:55 +00001615 for (llvm::DenseMap<Selector, ObjCMethodList>::iterator
Mike Stump11289f42009-09-09 15:08:12 +00001616 Instance = SemaRef.InstanceMethodPool.begin(),
Douglas Gregorc78d3462009-04-24 21:10:55 +00001617 InstanceEnd = SemaRef.InstanceMethodPool.end();
1618 Instance != InstanceEnd; ++Instance) {
1619 // Check whether there is a factory method with the same
1620 // selector.
1621 llvm::DenseMap<Selector, ObjCMethodList>::iterator Factory
1622 = SemaRef.FactoryMethodPool.find(Instance->first);
1623
1624 if (Factory == SemaRef.FactoryMethodPool.end())
1625 Generator.insert(Instance->first,
Mike Stump11289f42009-09-09 15:08:12 +00001626 std::make_pair(Instance->second,
Douglas Gregorc78d3462009-04-24 21:10:55 +00001627 ObjCMethodList()));
1628 else
1629 Generator.insert(Instance->first,
1630 std::make_pair(Instance->second, Factory->second));
1631
Douglas Gregor95c13f52009-04-25 17:48:32 +00001632 ++NumSelectorsInMethodPool;
Douglas Gregorc78d3462009-04-24 21:10:55 +00001633 Empty = false;
1634 }
1635
1636 // Now iterate through the factory method pool, to pick up any
1637 // selectors that weren't already in the instance method pool.
1638 for (llvm::DenseMap<Selector, ObjCMethodList>::iterator
Mike Stump11289f42009-09-09 15:08:12 +00001639 Factory = SemaRef.FactoryMethodPool.begin(),
Douglas Gregorc78d3462009-04-24 21:10:55 +00001640 FactoryEnd = SemaRef.FactoryMethodPool.end();
1641 Factory != FactoryEnd; ++Factory) {
1642 // Check whether there is an instance method with the same
1643 // selector. If so, there is no work to do here.
1644 llvm::DenseMap<Selector, ObjCMethodList>::iterator Instance
1645 = SemaRef.InstanceMethodPool.find(Factory->first);
1646
Douglas Gregor95c13f52009-04-25 17:48:32 +00001647 if (Instance == SemaRef.InstanceMethodPool.end()) {
Douglas Gregorc78d3462009-04-24 21:10:55 +00001648 Generator.insert(Factory->first,
1649 std::make_pair(ObjCMethodList(), Factory->second));
Douglas Gregor95c13f52009-04-25 17:48:32 +00001650 ++NumSelectorsInMethodPool;
1651 }
Douglas Gregorc78d3462009-04-24 21:10:55 +00001652
1653 Empty = false;
1654 }
1655
Douglas Gregor95c13f52009-04-25 17:48:32 +00001656 if (Empty && SelectorOffsets.empty())
Douglas Gregorc78d3462009-04-24 21:10:55 +00001657 return;
1658
1659 // Create the on-disk hash table in a buffer.
Mike Stump11289f42009-09-09 15:08:12 +00001660 llvm::SmallString<4096> MethodPool;
Douglas Gregorc78d3462009-04-24 21:10:55 +00001661 uint32_t BucketOffset;
Douglas Gregor95c13f52009-04-25 17:48:32 +00001662 SelectorOffsets.resize(SelVector.size());
Douglas Gregorc78d3462009-04-24 21:10:55 +00001663 {
1664 PCHMethodPoolTrait Trait(*this);
1665 llvm::raw_svector_ostream Out(MethodPool);
1666 // Make sure that no bucket is at offset 0
Douglas Gregor4647cfa2009-04-24 21:49:02 +00001667 clang::io::Emit32(Out, 0);
Douglas Gregorc78d3462009-04-24 21:10:55 +00001668 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor95c13f52009-04-25 17:48:32 +00001669
1670 // For every selector that we have seen but which was not
1671 // written into the hash table, write the selector itself and
1672 // record it's offset.
1673 for (unsigned I = 0, N = SelVector.size(); I != N; ++I)
1674 if (SelectorOffsets[I] == 0)
1675 Trait.EmitKey(Out, SelVector[I], 0);
Douglas Gregorc78d3462009-04-24 21:10:55 +00001676 }
1677
1678 // Create a blob abbreviation
1679 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1680 Abbrev->Add(BitCodeAbbrevOp(pch::METHOD_POOL));
1681 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor95c13f52009-04-25 17:48:32 +00001682 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregorc78d3462009-04-24 21:10:55 +00001683 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1684 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(Abbrev);
1685
Douglas Gregor95c13f52009-04-25 17:48:32 +00001686 // Write the method pool
Douglas Gregorc78d3462009-04-24 21:10:55 +00001687 RecordData Record;
1688 Record.push_back(pch::METHOD_POOL);
1689 Record.push_back(BucketOffset);
Douglas Gregor95c13f52009-04-25 17:48:32 +00001690 Record.push_back(NumSelectorsInMethodPool);
Daniel Dunbar8100d012009-08-24 09:31:37 +00001691 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool.str());
Douglas Gregor95c13f52009-04-25 17:48:32 +00001692
1693 // Create a blob abbreviation for the selector table offsets.
1694 Abbrev = new BitCodeAbbrev();
1695 Abbrev->Add(BitCodeAbbrevOp(pch::SELECTOR_OFFSETS));
1696 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // index
1697 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1698 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1699
1700 // Write the selector offsets table.
1701 Record.clear();
1702 Record.push_back(pch::SELECTOR_OFFSETS);
1703 Record.push_back(SelectorOffsets.size());
1704 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
1705 (const char *)&SelectorOffsets.front(),
1706 SelectorOffsets.size() * 4);
Douglas Gregorc78d3462009-04-24 21:10:55 +00001707 }
1708}
1709
Douglas Gregorc5046832009-04-27 18:38:38 +00001710//===----------------------------------------------------------------------===//
1711// Identifier Table Serialization
1712//===----------------------------------------------------------------------===//
1713
Douglas Gregorc78d3462009-04-24 21:10:55 +00001714namespace {
Benjamin Kramer16634c22009-11-28 10:07:24 +00001715class PCHIdentifierTableTrait {
Douglas Gregore84a9da2009-04-20 20:36:09 +00001716 PCHWriter &Writer;
Douglas Gregorc3366a52009-04-21 23:56:24 +00001717 Preprocessor &PP;
Douglas Gregore84a9da2009-04-20 20:36:09 +00001718
Douglas Gregor1d583f22009-04-28 21:18:29 +00001719 /// \brief Determines whether this is an "interesting" identifier
1720 /// that needs a full IdentifierInfo structure written into the hash
1721 /// table.
1722 static bool isInterestingIdentifier(const IdentifierInfo *II) {
1723 return II->isPoisoned() ||
1724 II->isExtensionToken() ||
1725 II->hasMacroDefinition() ||
1726 II->getObjCOrBuiltinID() ||
1727 II->getFETokenInfo<void>();
1728 }
1729
Douglas Gregore84a9da2009-04-20 20:36:09 +00001730public:
1731 typedef const IdentifierInfo* key_type;
1732 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00001733
Douglas Gregore84a9da2009-04-20 20:36:09 +00001734 typedef pch::IdentID data_type;
1735 typedef data_type data_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00001736
1737 PCHIdentifierTableTrait(PCHWriter &Writer, Preprocessor &PP)
Douglas Gregorc3366a52009-04-21 23:56:24 +00001738 : Writer(Writer), PP(PP) { }
Douglas Gregore84a9da2009-04-20 20:36:09 +00001739
1740 static unsigned ComputeHash(const IdentifierInfo* II) {
Daniel Dunbarf8502d52009-10-17 23:52:28 +00001741 return llvm::HashString(II->getName());
Douglas Gregore84a9da2009-04-20 20:36:09 +00001742 }
Mike Stump11289f42009-09-09 15:08:12 +00001743
1744 std::pair<unsigned,unsigned>
1745 EmitKeyDataLength(llvm::raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregore84a9da2009-04-20 20:36:09 +00001746 pch::IdentID ID) {
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00001747 unsigned KeyLen = II->getLength() + 1;
Douglas Gregor1d583f22009-04-28 21:18:29 +00001748 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
1749 if (isInterestingIdentifier(II)) {
Douglas Gregorb9256522009-04-28 21:32:13 +00001750 DataLen += 2; // 2 bytes for builtin ID, flags
Mike Stump11289f42009-09-09 15:08:12 +00001751 if (II->hasMacroDefinition() &&
Douglas Gregor1d583f22009-04-28 21:18:29 +00001752 !PP.getMacroInfo(const_cast<IdentifierInfo *>(II))->isBuiltinMacro())
Douglas Gregorb9256522009-04-28 21:32:13 +00001753 DataLen += 4;
Douglas Gregor1d583f22009-04-28 21:18:29 +00001754 for (IdentifierResolver::iterator D = IdentifierResolver::begin(II),
1755 DEnd = IdentifierResolver::end();
1756 D != DEnd; ++D)
1757 DataLen += sizeof(pch::DeclID);
1758 }
Douglas Gregora868bbd2009-04-21 22:25:48 +00001759 clang::io::Emit16(Out, DataLen);
Douglas Gregorab4df582009-04-28 20:01:51 +00001760 // We emit the key length after the data length so that every
1761 // string is preceded by a 16-bit length. This matches the PTH
1762 // format for storing identifiers.
Douglas Gregor5287b4e2009-04-25 21:04:17 +00001763 clang::io::Emit16(Out, KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00001764 return std::make_pair(KeyLen, DataLen);
1765 }
Mike Stump11289f42009-09-09 15:08:12 +00001766
1767 void EmitKey(llvm::raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregore84a9da2009-04-20 20:36:09 +00001768 unsigned KeyLen) {
1769 // Record the location of the key data. This is used when generating
1770 // the mapping from persistent IDs to strings.
1771 Writer.SetIdentifierOffset(II, Out.tell());
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00001772 Out.write(II->getNameStart(), KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00001773 }
Mike Stump11289f42009-09-09 15:08:12 +00001774
1775 void EmitData(llvm::raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregore84a9da2009-04-20 20:36:09 +00001776 pch::IdentID ID, unsigned) {
Douglas Gregor1d583f22009-04-28 21:18:29 +00001777 if (!isInterestingIdentifier(II)) {
1778 clang::io::Emit32(Out, ID << 1);
1779 return;
1780 }
Douglas Gregorb9256522009-04-28 21:32:13 +00001781
Douglas Gregor1d583f22009-04-28 21:18:29 +00001782 clang::io::Emit32(Out, (ID << 1) | 0x01);
Douglas Gregore84a9da2009-04-20 20:36:09 +00001783 uint32_t Bits = 0;
Mike Stump11289f42009-09-09 15:08:12 +00001784 bool hasMacroDefinition =
1785 II->hasMacroDefinition() &&
Douglas Gregorc3366a52009-04-21 23:56:24 +00001786 !PP.getMacroInfo(const_cast<IdentifierInfo *>(II))->isBuiltinMacro();
Douglas Gregorb9256522009-04-28 21:32:13 +00001787 Bits = (uint32_t)II->getObjCOrBuiltinID();
Daniel Dunbar91b640a2009-12-18 20:58:47 +00001788 Bits = (Bits << 1) | unsigned(hasMacroDefinition);
1789 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
1790 Bits = (Bits << 1) | unsigned(II->isPoisoned());
1791 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
Douglas Gregorb9256522009-04-28 21:32:13 +00001792 clang::io::Emit16(Out, Bits);
Douglas Gregore84a9da2009-04-20 20:36:09 +00001793
Douglas Gregorc3366a52009-04-21 23:56:24 +00001794 if (hasMacroDefinition)
Douglas Gregorb9256522009-04-28 21:32:13 +00001795 clang::io::Emit32(Out, Writer.getMacroOffset(II));
Douglas Gregorc3366a52009-04-21 23:56:24 +00001796
Douglas Gregora868bbd2009-04-21 22:25:48 +00001797 // Emit the declaration IDs in reverse order, because the
1798 // IdentifierResolver provides the declarations as they would be
1799 // visible (e.g., the function "stat" would come before the struct
1800 // "stat"), but IdentifierResolver::AddDeclToIdentifierChain()
1801 // adds declarations to the end of the list (so we need to see the
1802 // struct "status" before the function "status").
Mike Stump11289f42009-09-09 15:08:12 +00001803 llvm::SmallVector<Decl *, 16> Decls(IdentifierResolver::begin(II),
Douglas Gregora868bbd2009-04-21 22:25:48 +00001804 IdentifierResolver::end());
1805 for (llvm::SmallVector<Decl *, 16>::reverse_iterator D = Decls.rbegin(),
1806 DEnd = Decls.rend();
Douglas Gregore84a9da2009-04-20 20:36:09 +00001807 D != DEnd; ++D)
Douglas Gregora868bbd2009-04-21 22:25:48 +00001808 clang::io::Emit32(Out, Writer.getDeclID(*D));
Douglas Gregore84a9da2009-04-20 20:36:09 +00001809 }
1810};
1811} // end anonymous namespace
1812
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00001813/// \brief Write the identifier table into the PCH file.
1814///
1815/// The identifier table consists of a blob containing string data
1816/// (the actual identifiers themselves) and a separate "offsets" index
1817/// that maps identifier IDs to locations within the blob.
Douglas Gregorc3366a52009-04-21 23:56:24 +00001818void PCHWriter::WriteIdentifierTable(Preprocessor &PP) {
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00001819 using namespace llvm;
1820
1821 // Create and write out the blob that contains the identifier
1822 // strings.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00001823 {
Douglas Gregore84a9da2009-04-20 20:36:09 +00001824 OnDiskChainedHashTableGenerator<PCHIdentifierTableTrait> Generator;
Mike Stump11289f42009-09-09 15:08:12 +00001825
Douglas Gregore6648fb2009-04-28 20:33:11 +00001826 // Look for any identifiers that were named while processing the
1827 // headers, but are otherwise not needed. We add these to the hash
1828 // table to enable checking of the predefines buffer in the case
1829 // where the user adds new macro definitions when building the PCH
1830 // file.
1831 for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
1832 IDEnd = PP.getIdentifierTable().end();
1833 ID != IDEnd; ++ID)
1834 getIdentifierRef(ID->second);
1835
Douglas Gregore84a9da2009-04-20 20:36:09 +00001836 // Create the on-disk hash table representation.
Douglas Gregore6648fb2009-04-28 20:33:11 +00001837 IdentifierOffsets.resize(IdentifierIDs.size());
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00001838 for (llvm::DenseMap<const IdentifierInfo *, pch::IdentID>::iterator
1839 ID = IdentifierIDs.begin(), IDEnd = IdentifierIDs.end();
1840 ID != IDEnd; ++ID) {
1841 assert(ID->first && "NULL identifier in identifier table");
Douglas Gregorab4df582009-04-28 20:01:51 +00001842 Generator.insert(ID->first, ID->second);
Douglas Gregore84a9da2009-04-20 20:36:09 +00001843 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00001844
Douglas Gregore84a9da2009-04-20 20:36:09 +00001845 // Create the on-disk hash table in a buffer.
Mike Stump11289f42009-09-09 15:08:12 +00001846 llvm::SmallString<4096> IdentifierTable;
Douglas Gregora868bbd2009-04-21 22:25:48 +00001847 uint32_t BucketOffset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00001848 {
Douglas Gregorc3366a52009-04-21 23:56:24 +00001849 PCHIdentifierTableTrait Trait(*this, PP);
Douglas Gregore84a9da2009-04-20 20:36:09 +00001850 llvm::raw_svector_ostream Out(IdentifierTable);
Douglas Gregorc78d3462009-04-24 21:10:55 +00001851 // Make sure that no bucket is at offset 0
Douglas Gregor4647cfa2009-04-24 21:49:02 +00001852 clang::io::Emit32(Out, 0);
Douglas Gregora868bbd2009-04-21 22:25:48 +00001853 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00001854 }
1855
1856 // Create a blob abbreviation
1857 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1858 Abbrev->Add(BitCodeAbbrevOp(pch::IDENTIFIER_TABLE));
Douglas Gregora868bbd2009-04-21 22:25:48 +00001859 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregore84a9da2009-04-20 20:36:09 +00001860 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Douglas Gregor8f45df52009-04-16 22:23:12 +00001861 unsigned IDTableAbbrev = Stream.EmitAbbrev(Abbrev);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00001862
1863 // Write the identifier table
1864 RecordData Record;
1865 Record.push_back(pch::IDENTIFIER_TABLE);
Douglas Gregora868bbd2009-04-21 22:25:48 +00001866 Record.push_back(BucketOffset);
Daniel Dunbar8100d012009-08-24 09:31:37 +00001867 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable.str());
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00001868 }
1869
1870 // Write the offsets table for identifier IDs.
Douglas Gregor0e149972009-04-25 19:10:14 +00001871 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1872 Abbrev->Add(BitCodeAbbrevOp(pch::IDENTIFIER_OFFSET));
1873 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
1874 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1875 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1876
1877 RecordData Record;
1878 Record.push_back(pch::IDENTIFIER_OFFSET);
1879 Record.push_back(IdentifierOffsets.size());
1880 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
1881 (const char *)&IdentifierOffsets.front(),
1882 IdentifierOffsets.size() * sizeof(uint32_t));
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00001883}
1884
Douglas Gregorc5046832009-04-27 18:38:38 +00001885//===----------------------------------------------------------------------===//
1886// General Serialization Routines
1887//===----------------------------------------------------------------------===//
1888
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001889/// \brief Write a record containing the given attributes.
1890void PCHWriter::WriteAttributeRecord(const Attr *Attr) {
1891 RecordData Record;
1892 for (; Attr; Attr = Attr->getNext()) {
Anton Korobeynikov55bcea12010-01-10 12:58:08 +00001893 Record.push_back(Attr->getKind()); // FIXME: stable encoding, target attrs
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001894 Record.push_back(Attr->isInherited());
1895 switch (Attr->getKind()) {
Anton Korobeynikov55bcea12010-01-10 12:58:08 +00001896 default:
1897 assert(0 && "Does not support PCH writing for this attribute yet!");
1898 break;
Alexis Hunt344393e2010-06-16 23:43:53 +00001899 case attr::Alias:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001900 AddString(cast<AliasAttr>(Attr)->getAliasee(), Record);
1901 break;
1902
Alexis Hunt344393e2010-06-16 23:43:53 +00001903 case attr::AlignMac68k:
Daniel Dunbarfc6507e2010-05-27 02:25:39 +00001904 break;
1905
Alexis Hunt344393e2010-06-16 23:43:53 +00001906 case attr::Aligned:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001907 Record.push_back(cast<AlignedAttr>(Attr)->getAlignment());
1908 break;
1909
Alexis Hunt344393e2010-06-16 23:43:53 +00001910 case attr::AlwaysInline:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001911 break;
Mike Stump11289f42009-09-09 15:08:12 +00001912
Alexis Hunt344393e2010-06-16 23:43:53 +00001913 case attr::AnalyzerNoReturn:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001914 break;
1915
Alexis Hunt344393e2010-06-16 23:43:53 +00001916 case attr::Annotate:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001917 AddString(cast<AnnotateAttr>(Attr)->getAnnotation(), Record);
1918 break;
1919
Alexis Hunt344393e2010-06-16 23:43:53 +00001920 case attr::AsmLabel:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001921 AddString(cast<AsmLabelAttr>(Attr)->getLabel(), Record);
1922 break;
1923
Alexis Hunt344393e2010-06-16 23:43:53 +00001924 case attr::BaseCheck:
Alexis Hunt54a02542009-11-25 04:20:27 +00001925 break;
1926
Alexis Hunt344393e2010-06-16 23:43:53 +00001927 case attr::Blocks:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001928 Record.push_back(cast<BlocksAttr>(Attr)->getType()); // FIXME: stable
1929 break;
1930
Alexis Hunt344393e2010-06-16 23:43:53 +00001931 case attr::CDecl:
Eli Friedmane4310c82009-11-09 18:38:53 +00001932 break;
1933
Alexis Hunt344393e2010-06-16 23:43:53 +00001934 case attr::Cleanup:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001935 AddDeclRef(cast<CleanupAttr>(Attr)->getFunctionDecl(), Record);
1936 break;
1937
Alexis Hunt344393e2010-06-16 23:43:53 +00001938 case attr::Const:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001939 break;
1940
Alexis Hunt344393e2010-06-16 23:43:53 +00001941 case attr::Constructor:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001942 Record.push_back(cast<ConstructorAttr>(Attr)->getPriority());
1943 break;
1944
Alexis Hunt344393e2010-06-16 23:43:53 +00001945 case attr::DLLExport:
1946 case attr::DLLImport:
1947 case attr::Deprecated:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001948 break;
1949
Alexis Hunt344393e2010-06-16 23:43:53 +00001950 case attr::Destructor:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001951 Record.push_back(cast<DestructorAttr>(Attr)->getPriority());
1952 break;
1953
Alexis Hunt344393e2010-06-16 23:43:53 +00001954 case attr::FastCall:
1955 case attr::Final:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001956 break;
1957
Alexis Hunt344393e2010-06-16 23:43:53 +00001958 case attr::Format: {
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001959 const FormatAttr *Format = cast<FormatAttr>(Attr);
1960 AddString(Format->getType(), Record);
1961 Record.push_back(Format->getFormatIdx());
1962 Record.push_back(Format->getFirstArg());
1963 break;
1964 }
1965
Alexis Hunt344393e2010-06-16 23:43:53 +00001966 case attr::FormatArg: {
Fariborz Jahanianf1c25022009-05-20 17:41:43 +00001967 const FormatArgAttr *Format = cast<FormatArgAttr>(Attr);
1968 Record.push_back(Format->getFormatIdx());
1969 break;
1970 }
1971
Alexis Hunt344393e2010-06-16 23:43:53 +00001972 case attr::Sentinel : {
Fariborz Jahanian027b8862009-05-13 18:09:35 +00001973 const SentinelAttr *Sentinel = cast<SentinelAttr>(Attr);
1974 Record.push_back(Sentinel->getSentinel());
1975 Record.push_back(Sentinel->getNullPos());
1976 break;
1977 }
Mike Stump11289f42009-09-09 15:08:12 +00001978
Alexis Hunt344393e2010-06-16 23:43:53 +00001979 case attr::GNUInline:
1980 case attr::Hiding:
1981 case attr::IBAction:
1982 case attr::IBOutlet:
1983 case attr::Malloc:
1984 case attr::NoDebug:
1985 case attr::NoInline:
1986 case attr::NoReturn:
1987 case attr::NoThrow:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001988 break;
1989
Alexis Hunt344393e2010-06-16 23:43:53 +00001990 case attr::IBOutletCollection: {
Ted Kremenek26bde772010-05-19 17:38:06 +00001991 const IBOutletCollectionAttr *ICA = cast<IBOutletCollectionAttr>(Attr);
1992 AddDeclRef(ICA->getClass(), Record);
1993 break;
1994 }
1995
Alexis Hunt344393e2010-06-16 23:43:53 +00001996 case attr::NonNull: {
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00001997 const NonNullAttr *NonNull = cast<NonNullAttr>(Attr);
1998 Record.push_back(NonNull->size());
1999 Record.insert(Record.end(), NonNull->begin(), NonNull->end());
2000 break;
2001 }
2002
Alexis Hunt344393e2010-06-16 23:43:53 +00002003 case attr::CFReturnsNotRetained:
2004 case attr::CFReturnsRetained:
2005 case attr::NSReturnsNotRetained:
2006 case attr::NSReturnsRetained:
2007 case attr::ObjCException:
2008 case attr::ObjCNSObject:
2009 case attr::Overloadable:
2010 case attr::Override:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00002011 break;
2012
Alexis Hunt344393e2010-06-16 23:43:53 +00002013 case attr::MaxFieldAlignment:
Daniel Dunbar40130442010-05-27 01:12:46 +00002014 Record.push_back(cast<MaxFieldAlignmentAttr>(Attr)->getAlignment());
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00002015 break;
2016
Alexis Hunt344393e2010-06-16 23:43:53 +00002017 case attr::Packed:
Anders Carlsson68e0b682009-08-08 18:23:56 +00002018 break;
Mike Stump11289f42009-09-09 15:08:12 +00002019
Alexis Hunt344393e2010-06-16 23:43:53 +00002020 case attr::Pure:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00002021 break;
2022
Alexis Hunt344393e2010-06-16 23:43:53 +00002023 case attr::Regparm:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00002024 Record.push_back(cast<RegparmAttr>(Attr)->getNumParams());
2025 break;
Mike Stump11289f42009-09-09 15:08:12 +00002026
Alexis Hunt344393e2010-06-16 23:43:53 +00002027 case attr::ReqdWorkGroupSize:
Nate Begemanf2758702009-06-26 06:32:41 +00002028 Record.push_back(cast<ReqdWorkGroupSizeAttr>(Attr)->getXDim());
2029 Record.push_back(cast<ReqdWorkGroupSizeAttr>(Attr)->getYDim());
2030 Record.push_back(cast<ReqdWorkGroupSizeAttr>(Attr)->getZDim());
2031 break;
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00002032
Alexis Hunt344393e2010-06-16 23:43:53 +00002033 case attr::Section:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00002034 AddString(cast<SectionAttr>(Attr)->getName(), Record);
2035 break;
2036
Alexis Hunt344393e2010-06-16 23:43:53 +00002037 case attr::StdCall:
2038 case attr::TransparentUnion:
2039 case attr::Unavailable:
2040 case attr::Unused:
2041 case attr::Used:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00002042 break;
2043
Alexis Hunt344393e2010-06-16 23:43:53 +00002044 case attr::Visibility:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00002045 // FIXME: stable encoding
Mike Stump11289f42009-09-09 15:08:12 +00002046 Record.push_back(cast<VisibilityAttr>(Attr)->getVisibility());
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00002047 break;
2048
Alexis Hunt344393e2010-06-16 23:43:53 +00002049 case attr::WarnUnusedResult:
2050 case attr::Weak:
2051 case attr::WeakRef:
2052 case attr::WeakImport:
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00002053 break;
2054 }
2055 }
2056
Douglas Gregor8f45df52009-04-16 22:23:12 +00002057 Stream.EmitRecord(pch::DECL_ATTR, Record);
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00002058}
2059
2060void PCHWriter::AddString(const std::string &Str, RecordData &Record) {
2061 Record.push_back(Str.size());
2062 Record.insert(Record.end(), Str.begin(), Str.end());
2063}
2064
Douglas Gregore84a9da2009-04-20 20:36:09 +00002065/// \brief Note that the identifier II occurs at the given offset
2066/// within the identifier table.
2067void PCHWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
Douglas Gregor0e149972009-04-25 19:10:14 +00002068 IdentifierOffsets[IdentifierIDs[II] - 1] = Offset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00002069}
2070
Douglas Gregor95c13f52009-04-25 17:48:32 +00002071/// \brief Note that the selector Sel occurs at the given offset
2072/// within the method pool/selector table.
2073void PCHWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
2074 unsigned ID = SelectorIDs[Sel];
2075 assert(ID && "Unknown selector");
2076 SelectorOffsets[ID - 1] = Offset;
2077}
2078
Mike Stump11289f42009-09-09 15:08:12 +00002079PCHWriter::PCHWriter(llvm::BitstreamWriter &Stream)
2080 : Stream(Stream), NextTypeID(pch::NUM_PREDEF_TYPE_IDS),
Argyrios Kyrtzidisd0795b22010-06-28 22:28:35 +00002081 CollectedStmts(&StmtsToEmit), NumStatements(0), NumMacros(0),
2082 NumLexicalDeclContexts(0), NumVisibleDeclContexts(0) { }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002083
Douglas Gregor0086a5a2009-07-07 00:12:59 +00002084void PCHWriter::WritePCH(Sema &SemaRef, MemorizeStatCalls *StatCalls,
Sebastian Redl595c5132010-07-08 22:01:51 +00002085 const PCHReader *Chain, const char *isysroot) {
Douglas Gregor745ed142009-04-25 18:35:21 +00002086 using namespace llvm;
2087
Douglas Gregor162dd022009-04-20 15:53:59 +00002088 ASTContext &Context = SemaRef.Context;
2089 Preprocessor &PP = SemaRef.PP;
2090
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002091 // Emit the file header.
Douglas Gregor8f45df52009-04-16 22:23:12 +00002092 Stream.Emit((unsigned)'C', 8);
2093 Stream.Emit((unsigned)'P', 8);
2094 Stream.Emit((unsigned)'C', 8);
2095 Stream.Emit((unsigned)'H', 8);
Mike Stump11289f42009-09-09 15:08:12 +00002096
Chris Lattner28fa4e62009-04-26 22:26:21 +00002097 WriteBlockInfoBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002098
2099 // The translation unit is the first declaration we'll emit.
2100 DeclIDs[Context.getTranslationUnitDecl()] = 1;
Douglas Gregor12bfa382009-10-17 00:13:19 +00002101 DeclTypesToEmit.push(Context.getTranslationUnitDecl());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002102
Douglas Gregor4621c6a2009-04-22 18:49:13 +00002103 // Make sure that we emit IdentifierInfos (and any attached
2104 // declarations) for builtins.
2105 {
2106 IdentifierTable &Table = PP.getIdentifierTable();
2107 llvm::SmallVector<const char *, 32> BuiltinNames;
2108 Context.BuiltinInfo.GetBuiltinNames(BuiltinNames,
2109 Context.getLangOptions().NoBuiltin);
2110 for (unsigned I = 0, N = BuiltinNames.size(); I != N; ++I)
2111 getIdentifierRef(&Table.get(BuiltinNames[I]));
2112 }
2113
Chris Lattner0c797362009-09-08 18:19:27 +00002114 // Build a record containing all of the tentative definitions in this file, in
Sebastian Redl35351a92010-01-31 22:27:38 +00002115 // TentativeDefinitions order. Generally, this record will be empty for
Chris Lattner0c797362009-09-08 18:19:27 +00002116 // headers.
Douglas Gregord4df8652009-04-22 22:02:47 +00002117 RecordData TentativeDefinitions;
Sebastian Redl35351a92010-01-31 22:27:38 +00002118 for (unsigned i = 0, e = SemaRef.TentativeDefinitions.size(); i != e; ++i) {
2119 AddDeclRef(SemaRef.TentativeDefinitions[i], TentativeDefinitions);
Chris Lattner0c797362009-09-08 18:19:27 +00002120 }
Douglas Gregord4df8652009-04-22 22:02:47 +00002121
Tanya Lattner90073802010-02-12 00:07:30 +00002122 // Build a record containing all of the static unused functions in this file.
2123 RecordData UnusedStaticFuncs;
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00002124 for (unsigned i=0, e = SemaRef.UnusedStaticFuncs.size(); i !=e; ++i)
Tanya Lattner90073802010-02-12 00:07:30 +00002125 AddDeclRef(SemaRef.UnusedStaticFuncs[i], UnusedStaticFuncs);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00002126
Douglas Gregoracfc76c2009-04-22 22:18:58 +00002127 // Build a record containing all of the locally-scoped external
2128 // declarations in this header file. Generally, this record will be
2129 // empty.
2130 RecordData LocallyScopedExternalDecls;
Chris Lattner0c797362009-09-08 18:19:27 +00002131 // FIXME: This is filling in the PCH file in densemap order which is
2132 // nondeterminstic!
Mike Stump11289f42009-09-09 15:08:12 +00002133 for (llvm::DenseMap<DeclarationName, NamedDecl *>::iterator
Douglas Gregoracfc76c2009-04-22 22:18:58 +00002134 TD = SemaRef.LocallyScopedExternalDecls.begin(),
2135 TDEnd = SemaRef.LocallyScopedExternalDecls.end();
2136 TD != TDEnd; ++TD)
2137 AddDeclRef(TD->second, LocallyScopedExternalDecls);
2138
Douglas Gregor61cac2b2009-04-27 20:06:05 +00002139 // Build a record containing all of the ext_vector declarations.
2140 RecordData ExtVectorDecls;
2141 for (unsigned I = 0, N = SemaRef.ExtVectorDecls.size(); I != N; ++I)
2142 AddDeclRef(SemaRef.ExtVectorDecls[I], ExtVectorDecls);
2143
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00002144 // Build a record containing all of the VTable uses information.
2145 RecordData VTableUses;
2146 VTableUses.push_back(SemaRef.VTableUses.size());
2147 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
2148 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
2149 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
2150 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
2151 }
2152
2153 // Build a record containing all of dynamic classes declarations.
2154 RecordData DynamicClasses;
2155 for (unsigned I = 0, N = SemaRef.DynamicClasses.size(); I != N; ++I)
2156 AddDeclRef(SemaRef.DynamicClasses[I], DynamicClasses);
2157
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002158 // Write the remaining PCH contents.
Douglas Gregor652d82a2009-04-18 05:55:16 +00002159 RecordData Record;
Douglas Gregoraae92242010-03-19 21:51:54 +00002160 Stream.EnterSubblock(pch::PCH_BLOCK_ID, 5);
Sebastian Redl4d3af3e2010-07-09 21:00:24 +00002161 WriteMetadata(Context, Chain, isysroot);
2162 if (!Chain)
2163 WriteLanguageOptions(Context.getLangOptions());
Douglas Gregor0086a5a2009-07-07 00:12:59 +00002164 if (StatCalls && !isysroot)
2165 WriteStatCache(*StatCalls, isysroot);
2166 WriteSourceManagerBlock(Context.getSourceManager(), PP, isysroot);
Steve Naroffc277ad12009-07-18 15:33:26 +00002167 // Write the record of special types.
2168 Record.clear();
Mike Stump11289f42009-09-09 15:08:12 +00002169
Steve Naroffc277ad12009-07-18 15:33:26 +00002170 AddTypeRef(Context.getBuiltinVaListType(), Record);
2171 AddTypeRef(Context.getObjCIdType(), Record);
2172 AddTypeRef(Context.getObjCSelType(), Record);
2173 AddTypeRef(Context.getObjCProtoType(), Record);
2174 AddTypeRef(Context.getObjCClassType(), Record);
2175 AddTypeRef(Context.getRawCFConstantStringType(), Record);
2176 AddTypeRef(Context.getRawObjCFastEnumerationStateType(), Record);
2177 AddTypeRef(Context.getFILEType(), Record);
Mike Stumpa4de80b2009-07-28 02:25:19 +00002178 AddTypeRef(Context.getjmp_bufType(), Record);
2179 AddTypeRef(Context.getsigjmp_bufType(), Record);
Douglas Gregora8eed7d2009-08-21 00:27:50 +00002180 AddTypeRef(Context.ObjCIdRedefinitionType, Record);
2181 AddTypeRef(Context.ObjCClassRedefinitionType, Record);
Mike Stumpd0153282009-10-20 02:12:22 +00002182 AddTypeRef(Context.getRawBlockdescriptorType(), Record);
Mike Stumpe1b19ba2009-10-22 00:49:09 +00002183 AddTypeRef(Context.getRawBlockdescriptorExtendedType(), Record);
Fariborz Jahaniane804c282010-04-23 17:41:07 +00002184 AddTypeRef(Context.ObjCSelRedefinitionType, Record);
2185 AddTypeRef(Context.getRawNSConstantStringType(), Record);
Argyrios Kyrtzidise862cbc2010-07-04 21:44:19 +00002186 Record.push_back(Context.isInt128Installed());
Steve Naroffc277ad12009-07-18 15:33:26 +00002187 Stream.EmitRecord(pch::SPECIAL_TYPES, Record);
Mike Stump11289f42009-09-09 15:08:12 +00002188
Douglas Gregor1970d882009-04-26 03:49:13 +00002189 // Keep writing types and declarations until all types and
2190 // declarations have been written.
Douglas Gregor12bfa382009-10-17 00:13:19 +00002191 Stream.EnterSubblock(pch::DECLTYPES_BLOCK_ID, 3);
2192 WriteDeclsBlockAbbrevs();
2193 while (!DeclTypesToEmit.empty()) {
2194 DeclOrType DOT = DeclTypesToEmit.front();
2195 DeclTypesToEmit.pop();
2196 if (DOT.isType())
2197 WriteType(DOT.getType());
2198 else
2199 WriteDecl(Context, DOT.getDecl());
2200 }
2201 Stream.ExitBlock();
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00002202
Douglas Gregor45053152009-10-17 17:25:45 +00002203 WritePreprocessor(PP);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002204 WriteMethodPool(SemaRef);
Douglas Gregorc3366a52009-04-21 23:56:24 +00002205 WriteIdentifierTable(PP);
Douglas Gregor745ed142009-04-25 18:35:21 +00002206
2207 // Write the type offsets array
2208 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2209 Abbrev->Add(BitCodeAbbrevOp(pch::TYPE_OFFSET));
2210 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
2211 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
2212 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2213 Record.clear();
2214 Record.push_back(pch::TYPE_OFFSET);
2215 Record.push_back(TypeOffsets.size());
2216 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record,
Mike Stump11289f42009-09-09 15:08:12 +00002217 (const char *)&TypeOffsets.front(),
Chris Lattnereeb05692009-04-27 18:24:17 +00002218 TypeOffsets.size() * sizeof(TypeOffsets[0]));
Mike Stump11289f42009-09-09 15:08:12 +00002219
Douglas Gregor745ed142009-04-25 18:35:21 +00002220 // Write the declaration offsets array
2221 Abbrev = new BitCodeAbbrev();
2222 Abbrev->Add(BitCodeAbbrevOp(pch::DECL_OFFSET));
2223 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
2224 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
2225 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2226 Record.clear();
2227 Record.push_back(pch::DECL_OFFSET);
2228 Record.push_back(DeclOffsets.size());
2229 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record,
Mike Stump11289f42009-09-09 15:08:12 +00002230 (const char *)&DeclOffsets.front(),
Chris Lattnereeb05692009-04-27 18:24:17 +00002231 DeclOffsets.size() * sizeof(DeclOffsets[0]));
Douglas Gregor652d82a2009-04-18 05:55:16 +00002232
Douglas Gregord4df8652009-04-22 22:02:47 +00002233 // Write the record containing external, unnamed definitions.
Douglas Gregor1a0d0b92009-04-14 00:24:19 +00002234 if (!ExternalDefinitions.empty())
Douglas Gregor8f45df52009-04-16 22:23:12 +00002235 Stream.EmitRecord(pch::EXTERNAL_DEFINITIONS, ExternalDefinitions);
Douglas Gregord4df8652009-04-22 22:02:47 +00002236
2237 // Write the record containing tentative definitions.
2238 if (!TentativeDefinitions.empty())
2239 Stream.EmitRecord(pch::TENTATIVE_DEFINITIONS, TentativeDefinitions);
Douglas Gregoracfc76c2009-04-22 22:18:58 +00002240
Tanya Lattner90073802010-02-12 00:07:30 +00002241 // Write the record containing unused static functions.
2242 if (!UnusedStaticFuncs.empty())
2243 Stream.EmitRecord(pch::UNUSED_STATIC_FUNCS, UnusedStaticFuncs);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00002244
Douglas Gregoracfc76c2009-04-22 22:18:58 +00002245 // Write the record containing locally-scoped external definitions.
2246 if (!LocallyScopedExternalDecls.empty())
Mike Stump11289f42009-09-09 15:08:12 +00002247 Stream.EmitRecord(pch::LOCALLY_SCOPED_EXTERNAL_DECLS,
Douglas Gregoracfc76c2009-04-22 22:18:58 +00002248 LocallyScopedExternalDecls);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00002249
2250 // Write the record containing ext_vector type names.
2251 if (!ExtVectorDecls.empty())
2252 Stream.EmitRecord(pch::EXT_VECTOR_DECLS, ExtVectorDecls);
Mike Stump11289f42009-09-09 15:08:12 +00002253
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00002254 // Write the record containing VTable uses information.
2255 if (!VTableUses.empty())
2256 Stream.EmitRecord(pch::VTABLE_USES, VTableUses);
2257
2258 // Write the record containing dynamic classes declarations.
2259 if (!DynamicClasses.empty())
2260 Stream.EmitRecord(pch::DYNAMIC_CLASSES, DynamicClasses);
2261
Douglas Gregor08f01292009-04-17 22:13:46 +00002262 // Some simple statistics
Douglas Gregor652d82a2009-04-18 05:55:16 +00002263 Record.clear();
Douglas Gregor08f01292009-04-17 22:13:46 +00002264 Record.push_back(NumStatements);
Douglas Gregorc3366a52009-04-21 23:56:24 +00002265 Record.push_back(NumMacros);
Douglas Gregora57c3ab2009-04-22 22:34:57 +00002266 Record.push_back(NumLexicalDeclContexts);
2267 Record.push_back(NumVisibleDeclContexts);
Douglas Gregor08f01292009-04-17 22:13:46 +00002268 Stream.EmitRecord(pch::STATISTICS, Record);
Douglas Gregor8f45df52009-04-16 22:23:12 +00002269 Stream.ExitBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002270}
2271
2272void PCHWriter::AddSourceLocation(SourceLocation Loc, RecordData &Record) {
2273 Record.push_back(Loc.getRawEncoding());
2274}
2275
Chris Lattnerca025db2010-05-07 21:43:38 +00002276void PCHWriter::AddSourceRange(SourceRange Range, RecordData &Record) {
2277 AddSourceLocation(Range.getBegin(), Record);
2278 AddSourceLocation(Range.getEnd(), Record);
2279}
2280
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002281void PCHWriter::AddAPInt(const llvm::APInt &Value, RecordData &Record) {
2282 Record.push_back(Value.getBitWidth());
2283 unsigned N = Value.getNumWords();
2284 const uint64_t* Words = Value.getRawData();
2285 for (unsigned I = 0; I != N; ++I)
2286 Record.push_back(Words[I]);
2287}
2288
Douglas Gregor1daeb692009-04-13 18:14:40 +00002289void PCHWriter::AddAPSInt(const llvm::APSInt &Value, RecordData &Record) {
2290 Record.push_back(Value.isUnsigned());
2291 AddAPInt(Value, Record);
2292}
2293
Douglas Gregore0a3a512009-04-14 21:55:33 +00002294void PCHWriter::AddAPFloat(const llvm::APFloat &Value, RecordData &Record) {
2295 AddAPInt(Value.bitcastToAPInt(), Record);
2296}
2297
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002298void PCHWriter::AddIdentifierRef(const IdentifierInfo *II, RecordData &Record) {
Douglas Gregor4621c6a2009-04-22 18:49:13 +00002299 Record.push_back(getIdentifierRef(II));
2300}
2301
2302pch::IdentID PCHWriter::getIdentifierRef(const IdentifierInfo *II) {
2303 if (II == 0)
2304 return 0;
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00002305
2306 pch::IdentID &ID = IdentifierIDs[II];
2307 if (ID == 0)
2308 ID = IdentifierIDs.size();
Douglas Gregor4621c6a2009-04-22 18:49:13 +00002309 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002310}
2311
Douglas Gregoraae92242010-03-19 21:51:54 +00002312pch::IdentID PCHWriter::getMacroDefinitionID(MacroDefinition *MD) {
2313 if (MD == 0)
2314 return 0;
2315
2316 pch::IdentID &ID = MacroDefinitions[MD];
2317 if (ID == 0)
2318 ID = MacroDefinitions.size();
2319 return ID;
2320}
2321
Steve Naroff2ddea052009-04-23 10:39:46 +00002322void PCHWriter::AddSelectorRef(const Selector SelRef, RecordData &Record) {
2323 if (SelRef.getAsOpaquePtr() == 0) {
2324 Record.push_back(0);
2325 return;
2326 }
2327
2328 pch::SelectorID &SID = SelectorIDs[SelRef];
2329 if (SID == 0) {
2330 SID = SelectorIDs.size();
2331 SelVector.push_back(SelRef);
2332 }
2333 Record.push_back(SID);
2334}
2335
Chris Lattnercba86142010-05-10 00:25:06 +00002336void PCHWriter::AddCXXTemporary(const CXXTemporary *Temp, RecordData &Record) {
2337 AddDeclRef(Temp->getDestructor(), Record);
2338}
2339
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00002340void PCHWriter::AddTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind,
2341 const TemplateArgumentLocInfo &Arg,
2342 RecordData &Record) {
2343 switch (Kind) {
John McCall0ad16662009-10-29 08:12:44 +00002344 case TemplateArgument::Expression:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00002345 AddStmt(Arg.getAsExpr());
John McCall0ad16662009-10-29 08:12:44 +00002346 break;
2347 case TemplateArgument::Type:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00002348 AddTypeSourceInfo(Arg.getAsTypeSourceInfo(), Record);
John McCall0ad16662009-10-29 08:12:44 +00002349 break;
Douglas Gregor9167f8b2009-11-11 01:00:40 +00002350 case TemplateArgument::Template:
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00002351 AddSourceRange(Arg.getTemplateQualifierRange(), Record);
2352 AddSourceLocation(Arg.getTemplateNameLoc(), Record);
Douglas Gregor9167f8b2009-11-11 01:00:40 +00002353 break;
John McCall0ad16662009-10-29 08:12:44 +00002354 case TemplateArgument::Null:
2355 case TemplateArgument::Integral:
2356 case TemplateArgument::Declaration:
2357 case TemplateArgument::Pack:
2358 break;
2359 }
2360}
2361
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00002362void PCHWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg,
2363 RecordData &Record) {
2364 AddTemplateArgument(Arg.getArgument(), Record);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00002365
2366 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
2367 bool InfoHasSameExpr
2368 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
2369 Record.push_back(InfoHasSameExpr);
2370 if (InfoHasSameExpr)
2371 return; // Avoid storing the same expr twice.
2372 }
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00002373 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo(),
2374 Record);
2375}
2376
John McCallbcd03502009-12-07 02:54:59 +00002377void PCHWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo, RecordData &Record) {
2378 if (TInfo == 0) {
John McCall8f115c62009-10-16 21:56:05 +00002379 AddTypeRef(QualType(), Record);
2380 return;
2381 }
2382
John McCallbcd03502009-12-07 02:54:59 +00002383 AddTypeRef(TInfo->getType(), Record);
John McCall8f115c62009-10-16 21:56:05 +00002384 TypeLocWriter TLW(*this, Record);
John McCallbcd03502009-12-07 02:54:59 +00002385 for (TypeLoc TL = TInfo->getTypeLoc(); !TL.isNull(); TL = TL.getNextTypeLoc())
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00002386 TLW.Visit(TL);
John McCall8f115c62009-10-16 21:56:05 +00002387}
2388
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002389void PCHWriter::AddTypeRef(QualType T, RecordData &Record) {
2390 if (T.isNull()) {
2391 Record.push_back(pch::PREDEF_TYPE_NULL_ID);
2392 return;
2393 }
2394
Douglas Gregor1b8fe5b72009-11-16 21:35:15 +00002395 unsigned FastQuals = T.getLocalFastQualifiers();
John McCall8ccfcb52009-09-24 19:53:00 +00002396 T.removeFastQualifiers();
2397
Douglas Gregor1b8fe5b72009-11-16 21:35:15 +00002398 if (T.hasLocalNonFastQualifiers()) {
John McCall8ccfcb52009-09-24 19:53:00 +00002399 pch::TypeID &ID = TypeIDs[T];
2400 if (ID == 0) {
2401 // We haven't seen these qualifiers applied to this type before.
2402 // Assign it a new ID. This is the only time we enqueue a
2403 // qualified type, and it has no CV qualifiers.
2404 ID = NextTypeID++;
Douglas Gregor12bfa382009-10-17 00:13:19 +00002405 DeclTypesToEmit.push(T);
John McCall8ccfcb52009-09-24 19:53:00 +00002406 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00002407
John McCall8ccfcb52009-09-24 19:53:00 +00002408 // Encode the type qualifiers in the type reference.
2409 Record.push_back((ID << Qualifiers::FastWidth) | FastQuals);
2410 return;
2411 }
2412
Douglas Gregor1b8fe5b72009-11-16 21:35:15 +00002413 assert(!T.hasLocalQualifiers());
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00002414
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002415 if (const BuiltinType *BT = dyn_cast<BuiltinType>(T.getTypePtr())) {
Douglas Gregor92863e42009-04-10 23:10:45 +00002416 pch::TypeID ID = 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002417 switch (BT->getKind()) {
2418 case BuiltinType::Void: ID = pch::PREDEF_TYPE_VOID_ID; break;
2419 case BuiltinType::Bool: ID = pch::PREDEF_TYPE_BOOL_ID; break;
2420 case BuiltinType::Char_U: ID = pch::PREDEF_TYPE_CHAR_U_ID; break;
2421 case BuiltinType::UChar: ID = pch::PREDEF_TYPE_UCHAR_ID; break;
2422 case BuiltinType::UShort: ID = pch::PREDEF_TYPE_USHORT_ID; break;
2423 case BuiltinType::UInt: ID = pch::PREDEF_TYPE_UINT_ID; break;
2424 case BuiltinType::ULong: ID = pch::PREDEF_TYPE_ULONG_ID; break;
2425 case BuiltinType::ULongLong: ID = pch::PREDEF_TYPE_ULONGLONG_ID; break;
Chris Lattnerf122cef2009-04-30 02:43:43 +00002426 case BuiltinType::UInt128: ID = pch::PREDEF_TYPE_UINT128_ID; break;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002427 case BuiltinType::Char_S: ID = pch::PREDEF_TYPE_CHAR_S_ID; break;
2428 case BuiltinType::SChar: ID = pch::PREDEF_TYPE_SCHAR_ID; break;
2429 case BuiltinType::WChar: ID = pch::PREDEF_TYPE_WCHAR_ID; break;
2430 case BuiltinType::Short: ID = pch::PREDEF_TYPE_SHORT_ID; break;
2431 case BuiltinType::Int: ID = pch::PREDEF_TYPE_INT_ID; break;
2432 case BuiltinType::Long: ID = pch::PREDEF_TYPE_LONG_ID; break;
2433 case BuiltinType::LongLong: ID = pch::PREDEF_TYPE_LONGLONG_ID; break;
Chris Lattnerf122cef2009-04-30 02:43:43 +00002434 case BuiltinType::Int128: ID = pch::PREDEF_TYPE_INT128_ID; break;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002435 case BuiltinType::Float: ID = pch::PREDEF_TYPE_FLOAT_ID; break;
2436 case BuiltinType::Double: ID = pch::PREDEF_TYPE_DOUBLE_ID; break;
2437 case BuiltinType::LongDouble: ID = pch::PREDEF_TYPE_LONGDOUBLE_ID; break;
Sebastian Redl576fd422009-05-10 18:38:11 +00002438 case BuiltinType::NullPtr: ID = pch::PREDEF_TYPE_NULLPTR_ID; break;
Alisdair Mereditha9ad47d2009-07-14 06:30:34 +00002439 case BuiltinType::Char16: ID = pch::PREDEF_TYPE_CHAR16_ID; break;
2440 case BuiltinType::Char32: ID = pch::PREDEF_TYPE_CHAR32_ID; break;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002441 case BuiltinType::Overload: ID = pch::PREDEF_TYPE_OVERLOAD_ID; break;
2442 case BuiltinType::Dependent: ID = pch::PREDEF_TYPE_DEPENDENT_ID; break;
Steve Naroff1329fa02009-07-15 18:40:39 +00002443 case BuiltinType::ObjCId: ID = pch::PREDEF_TYPE_OBJC_ID; break;
2444 case BuiltinType::ObjCClass: ID = pch::PREDEF_TYPE_OBJC_CLASS; break;
Fariborz Jahanian252ba5f2009-11-21 19:53:08 +00002445 case BuiltinType::ObjCSel: ID = pch::PREDEF_TYPE_OBJC_SEL; break;
Anders Carlsson082acde2009-06-26 18:41:36 +00002446 case BuiltinType::UndeducedAuto:
2447 assert(0 && "Should not see undeduced auto here");
2448 break;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002449 }
2450
John McCall8ccfcb52009-09-24 19:53:00 +00002451 Record.push_back((ID << Qualifiers::FastWidth) | FastQuals);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002452 return;
2453 }
2454
John McCall8ccfcb52009-09-24 19:53:00 +00002455 pch::TypeID &ID = TypeIDs[T];
Douglas Gregor1970d882009-04-26 03:49:13 +00002456 if (ID == 0) {
2457 // We haven't seen this type before. Assign it a new ID and put it
John McCall8ccfcb52009-09-24 19:53:00 +00002458 // into the queue of types to emit.
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002459 ID = NextTypeID++;
Douglas Gregor12bfa382009-10-17 00:13:19 +00002460 DeclTypesToEmit.push(T);
Douglas Gregor1970d882009-04-26 03:49:13 +00002461 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002462
2463 // Encode the type qualifiers in the type reference.
John McCall8ccfcb52009-09-24 19:53:00 +00002464 Record.push_back((ID << Qualifiers::FastWidth) | FastQuals);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002465}
2466
2467void PCHWriter::AddDeclRef(const Decl *D, RecordData &Record) {
2468 if (D == 0) {
2469 Record.push_back(0);
2470 return;
2471 }
2472
Douglas Gregor1e9bf3b2009-04-10 17:25:41 +00002473 pch::DeclID &ID = DeclIDs[D];
Mike Stump11289f42009-09-09 15:08:12 +00002474 if (ID == 0) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002475 // We haven't seen this declaration before. Give it a new ID and
2476 // enqueue it in the list of declarations to emit.
2477 ID = DeclIDs.size();
Douglas Gregor12bfa382009-10-17 00:13:19 +00002478 DeclTypesToEmit.push(const_cast<Decl *>(D));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002479 }
2480
2481 Record.push_back(ID);
2482}
2483
Douglas Gregore84a9da2009-04-20 20:36:09 +00002484pch::DeclID PCHWriter::getDeclID(const Decl *D) {
2485 if (D == 0)
2486 return 0;
2487
2488 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
2489 return DeclIDs[D];
2490}
2491
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002492void PCHWriter::AddDeclarationName(DeclarationName Name, RecordData &Record) {
Chris Lattner258172e2009-04-27 07:35:58 +00002493 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc.
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002494 Record.push_back(Name.getNameKind());
2495 switch (Name.getNameKind()) {
2496 case DeclarationName::Identifier:
2497 AddIdentifierRef(Name.getAsIdentifierInfo(), Record);
2498 break;
2499
2500 case DeclarationName::ObjCZeroArgSelector:
2501 case DeclarationName::ObjCOneArgSelector:
2502 case DeclarationName::ObjCMultiArgSelector:
Steve Naroff2ddea052009-04-23 10:39:46 +00002503 AddSelectorRef(Name.getObjCSelector(), Record);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002504 break;
2505
2506 case DeclarationName::CXXConstructorName:
2507 case DeclarationName::CXXDestructorName:
2508 case DeclarationName::CXXConversionFunctionName:
2509 AddTypeRef(Name.getCXXNameType(), Record);
2510 break;
2511
2512 case DeclarationName::CXXOperatorName:
2513 Record.push_back(Name.getCXXOverloadedOperator());
2514 break;
2515
Alexis Hunt3d221f22009-11-29 07:34:05 +00002516 case DeclarationName::CXXLiteralOperatorName:
2517 AddIdentifierRef(Name.getCXXLiteralIdentifier(), Record);
2518 break;
2519
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002520 case DeclarationName::CXXUsingDirective:
2521 // No extra data to emit
2522 break;
2523 }
2524}
Chris Lattnerca025db2010-05-07 21:43:38 +00002525
2526void PCHWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS,
2527 RecordData &Record) {
2528 // Nested name specifiers usually aren't too long. I think that 8 would
2529 // typically accomodate the vast majority.
2530 llvm::SmallVector<NestedNameSpecifier *, 8> NestedNames;
2531
2532 // Push each of the NNS's onto a stack for serialization in reverse order.
2533 while (NNS) {
2534 NestedNames.push_back(NNS);
2535 NNS = NNS->getPrefix();
2536 }
2537
2538 Record.push_back(NestedNames.size());
2539 while(!NestedNames.empty()) {
2540 NNS = NestedNames.pop_back_val();
2541 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
2542 Record.push_back(Kind);
2543 switch (Kind) {
2544 case NestedNameSpecifier::Identifier:
2545 AddIdentifierRef(NNS->getAsIdentifier(), Record);
2546 break;
2547
2548 case NestedNameSpecifier::Namespace:
2549 AddDeclRef(NNS->getAsNamespace(), Record);
2550 break;
2551
2552 case NestedNameSpecifier::TypeSpec:
2553 case NestedNameSpecifier::TypeSpecWithTemplate:
2554 AddTypeRef(QualType(NNS->getAsType(), 0), Record);
2555 Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
2556 break;
2557
2558 case NestedNameSpecifier::Global:
2559 // Don't need to write an associated value.
2560 break;
2561 }
2562 }
2563}
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00002564
2565void PCHWriter::AddTemplateName(TemplateName Name, RecordData &Record) {
2566 TemplateName::NameKind Kind = Name.getKind();
2567 Record.push_back(Kind);
2568 switch (Kind) {
2569 case TemplateName::Template:
2570 AddDeclRef(Name.getAsTemplateDecl(), Record);
2571 break;
2572
2573 case TemplateName::OverloadedTemplate: {
2574 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
2575 Record.push_back(OvT->size());
2576 for (OverloadedTemplateStorage::iterator I = OvT->begin(), E = OvT->end();
2577 I != E; ++I)
2578 AddDeclRef(*I, Record);
2579 break;
2580 }
2581
2582 case TemplateName::QualifiedTemplate: {
2583 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
2584 AddNestedNameSpecifier(QualT->getQualifier(), Record);
2585 Record.push_back(QualT->hasTemplateKeyword());
2586 AddDeclRef(QualT->getTemplateDecl(), Record);
2587 break;
2588 }
2589
2590 case TemplateName::DependentTemplate: {
2591 DependentTemplateName *DepT = Name.getAsDependentTemplateName();
2592 AddNestedNameSpecifier(DepT->getQualifier(), Record);
2593 Record.push_back(DepT->isIdentifier());
2594 if (DepT->isIdentifier())
2595 AddIdentifierRef(DepT->getIdentifier(), Record);
2596 else
2597 Record.push_back(DepT->getOperator());
2598 break;
2599 }
2600 }
2601}
2602
2603void PCHWriter::AddTemplateArgument(const TemplateArgument &Arg,
2604 RecordData &Record) {
2605 Record.push_back(Arg.getKind());
2606 switch (Arg.getKind()) {
2607 case TemplateArgument::Null:
2608 break;
2609 case TemplateArgument::Type:
2610 AddTypeRef(Arg.getAsType(), Record);
2611 break;
2612 case TemplateArgument::Declaration:
2613 AddDeclRef(Arg.getAsDecl(), Record);
2614 break;
2615 case TemplateArgument::Integral:
2616 AddAPSInt(*Arg.getAsIntegral(), Record);
2617 AddTypeRef(Arg.getIntegralType(), Record);
2618 break;
2619 case TemplateArgument::Template:
2620 AddTemplateName(Arg.getAsTemplate(), Record);
2621 break;
2622 case TemplateArgument::Expression:
2623 AddStmt(Arg.getAsExpr());
2624 break;
2625 case TemplateArgument::Pack:
2626 Record.push_back(Arg.pack_size());
2627 for (TemplateArgument::pack_iterator I=Arg.pack_begin(), E=Arg.pack_end();
2628 I != E; ++I)
2629 AddTemplateArgument(*I, Record);
2630 break;
2631 }
2632}
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00002633
2634void
2635PCHWriter::AddTemplateParameterList(const TemplateParameterList *TemplateParams,
2636 RecordData &Record) {
2637 assert(TemplateParams && "No TemplateParams!");
2638 AddSourceLocation(TemplateParams->getTemplateLoc(), Record);
2639 AddSourceLocation(TemplateParams->getLAngleLoc(), Record);
2640 AddSourceLocation(TemplateParams->getRAngleLoc(), Record);
2641 Record.push_back(TemplateParams->size());
2642 for (TemplateParameterList::const_iterator
2643 P = TemplateParams->begin(), PEnd = TemplateParams->end();
2644 P != PEnd; ++P)
2645 AddDeclRef(*P, Record);
2646}
2647
2648/// \brief Emit a template argument list.
2649void
2650PCHWriter::AddTemplateArgumentList(const TemplateArgumentList *TemplateArgs,
2651 RecordData &Record) {
2652 assert(TemplateArgs && "No TemplateArgs!");
2653 Record.push_back(TemplateArgs->flat_size());
2654 for (int i=0, e = TemplateArgs->flat_size(); i != e; ++i)
2655 AddTemplateArgument(TemplateArgs->get(i), Record);
2656}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00002657
2658
2659void
2660PCHWriter::AddUnresolvedSet(const UnresolvedSetImpl &Set, RecordData &Record) {
2661 Record.push_back(Set.size());
2662 for (UnresolvedSetImpl::const_iterator
2663 I = Set.begin(), E = Set.end(); I != E; ++I) {
2664 AddDeclRef(I.getDecl(), Record);
2665 Record.push_back(I.getAccess());
2666 }
2667}
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00002668
2669void PCHWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base,
2670 RecordData &Record) {
2671 Record.push_back(Base.isVirtual());
2672 Record.push_back(Base.isBaseOfClass());
2673 Record.push_back(Base.getAccessSpecifierAsWritten());
2674 AddTypeRef(Base.getType(), Record);
2675 AddSourceRange(Base.getSourceRange(), Record);
2676}