blob: d8ce4e3b6eea8e8e1a5e7565d7adb175f3e844c5 [file] [log] [blame]
Chris Lattnere127a0d2010-04-20 20:35:58 +00001//===--- PCHWriter.cpp - Precompiled Headers Writer -----------------------===//
Douglas Gregor2cf26342009-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 Gregore7785042009-04-20 15:53:59 +000015#include "../Sema/Sema.h" // FIXME: move header into include/clang/Sema
Mike Stump1eb44332009-09-09 15:08:12 +000016#include "../Sema/IdentifierResolver.h" // FIXME: move header
Douglas Gregor2cf26342009-04-09 22:27:44 +000017#include "clang/AST/ASTContext.h"
18#include "clang/AST/Decl.h"
19#include "clang/AST/DeclContextInternals.h"
Douglas Gregor0b748912009-04-14 21:18:50 +000020#include "clang/AST/Expr.h"
Douglas Gregor2cf26342009-04-09 22:27:44 +000021#include "clang/AST/Type.h"
John McCalla1ee0c52009-10-16 21:56:05 +000022#include "clang/AST/TypeLocVisitor.h"
Sebastian Redl77f46032010-07-09 21:00:24 +000023#include "clang/Frontend/PCHReader.h"
Chris Lattner7c5d24e2009-04-10 18:00:12 +000024#include "clang/Lex/MacroInfo.h"
Douglas Gregor6a5a23f2010-03-19 21:51:54 +000025#include "clang/Lex/PreprocessingRecord.h"
Chris Lattner7c5d24e2009-04-10 18:00:12 +000026#include "clang/Lex/Preprocessor.h"
Steve Naroff83d63c72009-04-24 20:03:17 +000027#include "clang/Lex/HeaderSearch.h"
Douglas Gregor14f79002009-04-10 03:52:48 +000028#include "clang/Basic/FileManager.h"
Douglas Gregor3251ceb2009-04-20 20:36:09 +000029#include "clang/Basic/OnDiskHashTable.h"
Douglas Gregor14f79002009-04-10 03:52:48 +000030#include "clang/Basic/SourceManager.h"
Douglas Gregorbd945002009-04-13 16:31:14 +000031#include "clang/Basic/SourceManagerInternals.h"
Douglas Gregor2bec0412009-04-10 21:16:55 +000032#include "clang/Basic/TargetInfo.h"
Douglas Gregorab41e632009-04-27 22:23:34 +000033#include "clang/Basic/Version.h"
Douglas Gregor17fc2232009-04-14 21:55:33 +000034#include "llvm/ADT/APFloat.h"
35#include "llvm/ADT/APInt.h"
Daniel Dunbar2596e422009-10-17 23:52:28 +000036#include "llvm/ADT/StringExtras.h"
Douglas Gregor2cf26342009-04-09 22:27:44 +000037#include "llvm/Bitcode/BitstreamWriter.h"
Douglas Gregor14f79002009-04-10 03:52:48 +000038#include "llvm/Support/MemoryBuffer.h"
Douglas Gregorb64c1932009-05-12 01:31:05 +000039#include "llvm/System/Path.h"
Chris Lattner3c304bd2009-04-11 18:40:46 +000040#include <cstdio>
Douglas Gregor2cf26342009-04-09 22:27:44 +000041using namespace clang;
42
43//===----------------------------------------------------------------------===//
44// Type serialization
45//===----------------------------------------------------------------------===//
Chris Lattner12b1c762009-04-27 06:16:06 +000046
Douglas Gregor2cf26342009-04-09 22:27:44 +000047namespace {
Benjamin Kramerbd218282009-11-28 10:07:24 +000048 class PCHTypeWriter {
Douglas Gregor2cf26342009-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 Stump1eb44332009-09-09 15:08:12 +000056 PCHTypeWriter(PCHWriter &Writer, PCHWriter::RecordData &Record)
Douglas Gregor4fed3f42009-04-27 18:38:38 +000057 : Writer(Writer), Record(Record), Code(pch::TYPE_EXT_QUAL) { }
Douglas Gregor2cf26342009-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 Gregor2cf26342009-04-09 22:27:44 +000065#include "clang/AST/TypeNodes.def"
66 };
67}
68
Douglas Gregor2cf26342009-04-09 22:27:44 +000069void PCHTypeWriter::VisitBuiltinType(const BuiltinType *T) {
70 assert(false && "Built-in types are never serialized");
71}
72
Douglas Gregor2cf26342009-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 Stump1eb44332009-09-09 15:08:12 +000084 Writer.AddTypeRef(T->getPointeeType(), Record);
Douglas Gregor2cf26342009-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 Stump1eb44332009-09-09 15:08:12 +000099 Writer.AddTypeRef(T->getPointeeType(), Record);
100 Writer.AddTypeRef(QualType(T->getClass(), 0), Record);
Douglas Gregor2cf26342009-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 McCall0953e762009-09-24 19:53:00 +0000107 Record.push_back(T->getIndexTypeCVRQualifiers()); // FIXME: stable values
Douglas Gregor2cf26342009-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 Gregor7e7eb3d2009-07-06 15:59:29 +0000123 Writer.AddSourceLocation(T->getLBracketLoc(), Record);
124 Writer.AddSourceLocation(T->getRBracketLoc(), Record);
Douglas Gregorc9490c02009-04-16 22:23:12 +0000125 Writer.AddStmt(T->getSizeExpr());
Douglas Gregor2cf26342009-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 Lattner788b0fd2010-06-23 06:00:24 +0000132 Record.push_back(T->getAltiVecSpecific());
Douglas Gregor2cf26342009-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 Espindola264ba482010-03-30 20:24:48 +0000143 FunctionType::ExtInfo C = T->getExtInfo();
144 Record.push_back(C.getNoReturn());
Rafael Espindola425ef722010-03-30 22:15:11 +0000145 Record.push_back(C.getRegParm());
Douglas Gregorab8bbf42010-01-18 17:14:39 +0000146 // FIXME: need to stabilize encoding of calling convention...
Rafael Espindola264ba482010-03-30 20:24:48 +0000147 Record.push_back(C.getCC());
Douglas Gregor2cf26342009-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 Redl465226e2009-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 Gregor2cf26342009-04-09 22:27:44 +0000167 Code = pch::TYPE_FUNCTION_PROTO;
168}
169
John McCalled976492009-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 McCalled976492009-12-04 22:46:56 +0000174
Douglas Gregor2cf26342009-04-09 22:27:44 +0000175void PCHTypeWriter::VisitTypedefType(const TypedefType *T) {
176 Writer.AddDeclRef(T->getDecl(), Record);
Argyrios Kyrtzidis9763e222010-07-02 11:55:11 +0000177 assert(!T->isCanonicalUnqualified() && "Invalid typedef ?");
178 Writer.AddTypeRef(T->getCanonicalTypeInternal(), Record);
Douglas Gregor2cf26342009-04-09 22:27:44 +0000179 Code = pch::TYPE_TYPEDEF;
180}
181
182void PCHTypeWriter::VisitTypeOfExprType(const TypeOfExprType *T) {
Douglas Gregorc9490c02009-04-16 22:23:12 +0000183 Writer.AddStmt(T->getUnderlyingExpr());
Douglas Gregor2cf26342009-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 Carlsson395b4752009-06-24 19:06:50 +0000192void PCHTypeWriter::VisitDecltypeType(const DecltypeType *T) {
193 Writer.AddStmt(T->getUnderlyingExpr());
194 Code = pch::TYPE_DECLTYPE;
195}
196
Douglas Gregor2cf26342009-04-09 22:27:44 +0000197void PCHTypeWriter::VisitTagType(const TagType *T) {
Argyrios Kyrtzidisbe191102010-07-08 13:09:53 +0000198 Record.push_back(T->isDependentType());
Douglas Gregor2cf26342009-04-09 22:27:44 +0000199 Writer.AddDeclRef(T->getDecl(), Record);
Mike Stump1eb44332009-09-09 15:08:12 +0000200 assert(!T->isBeingDefined() &&
Douglas Gregor2cf26342009-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 Stump1eb44332009-09-09 15:08:12 +0000214void
John McCall49a832b2009-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 Gregor2cf26342009-04-09 22:27:44 +0000223PCHTypeWriter::VisitTemplateSpecializationType(
224 const TemplateSpecializationType *T) {
Argyrios Kyrtzidisbe191102010-07-08 13:09:53 +0000225 Record.push_back(T->isDependentType());
Argyrios Kyrtzidis90b715e2010-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 Kyrtzidis9763e222010-07-02 11:55:11 +0000231 Writer.AddTypeRef(T->isCanonicalUnqualified() ? QualType()
232 : T->getCanonicalTypeInternal(),
233 Record);
Argyrios Kyrtzidis90b715e2010-06-19 19:28:53 +0000234 Code = pch::TYPE_TEMPLATE_SPECIALIZATION;
235}
236
237void
238PCHTypeWriter::VisitDependentSizedArrayType(const DependentSizedArrayType *T) {
Argyrios Kyrtzidisae8b17f2010-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 Kyrtzidis90b715e2010-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 Kyrtzidis8dfbd8b2010-06-24 08:57:31 +0000263 Record.push_back(T->getKeyword());
264 Writer.AddNestedNameSpecifier(T->getQualifier(), Record);
265 Writer.AddIdentifierRef(T->getIdentifier(), Record);
Argyrios Kyrtzidisf48d45e2010-07-02 11:55:24 +0000266 Writer.AddTypeRef(T->isCanonicalUnqualified() ? QualType()
267 : T->getCanonicalTypeInternal(),
268 Record);
Argyrios Kyrtzidis8dfbd8b2010-06-24 08:57:31 +0000269 Code = pch::TYPE_DEPENDENT_NAME;
Argyrios Kyrtzidis90b715e2010-06-19 19:28:53 +0000270}
271
272void
273PCHTypeWriter::VisitDependentTemplateSpecializationType(
274 const DependentTemplateSpecializationType *T) {
Argyrios Kyrtzidis3acad622010-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 Gregor2cf26342009-04-09 22:27:44 +0000283}
284
Abramo Bagnara465d41b2010-05-11 21:36:43 +0000285void PCHTypeWriter::VisitElaboratedType(const ElaboratedType *T) {
Abramo Bagnara465d41b2010-05-11 21:36:43 +0000286 Record.push_back(T->getKeyword());
Argyrios Kyrtzidis3acad622010-06-25 16:24:58 +0000287 Writer.AddNestedNameSpecifier(T->getQualifier(), Record);
288 Writer.AddTypeRef(T->getNamedType(), Record);
Abramo Bagnara465d41b2010-05-11 21:36:43 +0000289 Code = pch::TYPE_ELABORATED;
Douglas Gregor2cf26342009-04-09 22:27:44 +0000290}
291
John McCall3cb0ebd2010-03-10 03:28:59 +0000292void PCHTypeWriter::VisitInjectedClassNameType(const InjectedClassNameType *T) {
293 Writer.AddDeclRef(T->getDecl(), Record);
John McCall31f17ec2010-04-27 00:57:59 +0000294 Writer.AddTypeRef(T->getInjectedSpecializationType(), Record);
John McCall3cb0ebd2010-03-10 03:28:59 +0000295 Code = pch::TYPE_INJECTED_CLASS_NAME;
296}
297
Douglas Gregor2cf26342009-04-09 22:27:44 +0000298void PCHTypeWriter::VisitObjCInterfaceType(const ObjCInterfaceType *T) {
299 Writer.AddDeclRef(T->getDecl(), Record);
John McCallc12c5bb2010-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 Gregor2cf26342009-04-09 22:27:44 +0000305 Record.push_back(T->getNumProtocols());
John McCallc12c5bb2010-05-15 11:32:37 +0000306 for (ObjCObjectType::qual_iterator I = T->qual_begin(),
Steve Naroff446ee4e2009-05-27 16:21:00 +0000307 E = T->qual_end(); I != E; ++I)
308 Writer.AddDeclRef(*I, Record);
John McCallc12c5bb2010-05-15 11:32:37 +0000309 Code = pch::TYPE_OBJC_OBJECT;
Douglas Gregor2cf26342009-04-09 22:27:44 +0000310}
311
Steve Naroffd1b3c2d2009-06-17 22:40:22 +0000312void
313PCHTypeWriter::VisitObjCObjectPointerType(const ObjCObjectPointerType *T) {
Mike Stump1eb44332009-09-09 15:08:12 +0000314 Writer.AddTypeRef(T->getPointeeType(), Record);
Steve Naroffd1b3c2d2009-06-17 22:40:22 +0000315 Code = pch::TYPE_OBJC_OBJECT_POINTER;
Douglas Gregor2cf26342009-04-09 22:27:44 +0000316}
317
John McCalla1ee0c52009-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 McCall51bd8032009-10-18 01:05:36 +0000328#define ABSTRACT_TYPELOC(CLASS, PARENT)
John McCalla1ee0c52009-10-16 21:56:05 +0000329#define TYPELOC(CLASS, PARENT) \
John McCall51bd8032009-10-18 01:05:36 +0000330 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
John McCalla1ee0c52009-10-16 21:56:05 +0000331#include "clang/AST/TypeLocNodes.def"
332
John McCall51bd8032009-10-18 01:05:36 +0000333 void VisitArrayTypeLoc(ArrayTypeLoc TyLoc);
334 void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc);
John McCalla1ee0c52009-10-16 21:56:05 +0000335};
336
337}
338
John McCall51bd8032009-10-18 01:05:36 +0000339void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
340 // nothing to do
John McCalla1ee0c52009-10-16 21:56:05 +0000341}
John McCall51bd8032009-10-18 01:05:36 +0000342void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
Douglas Gregorddf889a2010-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 McCalla1ee0c52009-10-16 21:56:05 +0000350}
John McCall51bd8032009-10-18 01:05:36 +0000351void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
352 Writer.AddSourceLocation(TL.getNameLoc(), Record);
John McCalla1ee0c52009-10-16 21:56:05 +0000353}
John McCall51bd8032009-10-18 01:05:36 +0000354void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) {
355 Writer.AddSourceLocation(TL.getStarLoc(), Record);
John McCalla1ee0c52009-10-16 21:56:05 +0000356}
John McCall51bd8032009-10-18 01:05:36 +0000357void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
358 Writer.AddSourceLocation(TL.getCaretLoc(), Record);
John McCalla1ee0c52009-10-16 21:56:05 +0000359}
John McCall51bd8032009-10-18 01:05:36 +0000360void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
361 Writer.AddSourceLocation(TL.getAmpLoc(), Record);
John McCalla1ee0c52009-10-16 21:56:05 +0000362}
John McCall51bd8032009-10-18 01:05:36 +0000363void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
364 Writer.AddSourceLocation(TL.getAmpAmpLoc(), Record);
John McCalla1ee0c52009-10-16 21:56:05 +0000365}
John McCall51bd8032009-10-18 01:05:36 +0000366void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
367 Writer.AddSourceLocation(TL.getStarLoc(), Record);
John McCalla1ee0c52009-10-16 21:56:05 +0000368}
John McCall51bd8032009-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 McCalla1ee0c52009-10-16 21:56:05 +0000375}
John McCall51bd8032009-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 McCalled976492009-12-04 22:46:56 +0000411void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
412 Writer.AddSourceLocation(TL.getNameLoc(), Record);
413}
John McCall51bd8032009-10-18 01:05:36 +0000414void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
415 Writer.AddSourceLocation(TL.getNameLoc(), Record);
416}
417void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
John McCallcfb708c2010-01-13 20:03:27 +0000418 Writer.AddSourceLocation(TL.getTypeofLoc(), Record);
419 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
420 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
John McCall51bd8032009-10-18 01:05:36 +0000421}
422void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
John McCallcfb708c2010-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 McCall51bd8032009-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 McCall51bd8032009-10-18 01:05:36 +0000437void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
438 Writer.AddSourceLocation(TL.getNameLoc(), Record);
439}
John McCall49a832b2009-10-18 09:09:24 +0000440void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
441 SubstTemplateTypeParmTypeLoc TL) {
442 Writer.AddSourceLocation(TL.getNameLoc(), Record);
443}
John McCall51bd8032009-10-18 01:05:36 +0000444void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
445 TemplateSpecializationTypeLoc TL) {
John McCall833ca992009-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 Kyrtzidis44f8c372010-06-22 09:54:59 +0000450 Writer.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(),
451 TL.getArgLoc(i).getLocInfo(), Record);
John McCall51bd8032009-10-18 01:05:36 +0000452}
Abramo Bagnara465d41b2010-05-11 21:36:43 +0000453void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
Abramo Bagnarae4da7a02010-05-19 21:37:53 +0000454 Writer.AddSourceLocation(TL.getKeywordLoc(), Record);
455 Writer.AddSourceRange(TL.getQualifierRange(), Record);
John McCall51bd8032009-10-18 01:05:36 +0000456}
John McCall3cb0ebd2010-03-10 03:28:59 +0000457void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
458 Writer.AddSourceLocation(TL.getNameLoc(), Record);
459}
Douglas Gregor4714c122010-03-31 17:34:00 +0000460void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
Abramo Bagnarae4da7a02010-05-19 21:37:53 +0000461 Writer.AddSourceLocation(TL.getKeywordLoc(), Record);
462 Writer.AddSourceRange(TL.getQualifierRange(), Record);
John McCall51bd8032009-10-18 01:05:36 +0000463 Writer.AddSourceLocation(TL.getNameLoc(), Record);
464}
John McCall33500952010-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 Kyrtzidis44f8c372010-06-22 09:54:59 +0000473 Writer.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(),
474 TL.getArgLoc(I).getLocInfo(), Record);
John McCall33500952010-06-11 00:33:02 +0000475}
John McCall51bd8032009-10-18 01:05:36 +0000476void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
477 Writer.AddSourceLocation(TL.getNameLoc(), Record);
John McCallc12c5bb2010-05-15 11:32:37 +0000478}
479void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
480 Record.push_back(TL.hasBaseTypeAsWritten());
John McCall51bd8032009-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 McCalla1ee0c52009-10-16 21:56:05 +0000485}
John McCall54e14c42009-10-22 22:37:11 +0000486void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
487 Writer.AddSourceLocation(TL.getStarLoc(), Record);
John McCall54e14c42009-10-22 22:37:11 +0000488}
John McCalla1ee0c52009-10-16 21:56:05 +0000489
Chris Lattner4dcf151a2009-04-22 05:57:30 +0000490//===----------------------------------------------------------------------===//
Douglas Gregor2cf26342009-04-09 22:27:44 +0000491// PCHWriter Implementation
492//===----------------------------------------------------------------------===//
493
Chris Lattnerb145b1e2009-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 Lattner0558df22009-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 Weinigeb7f9612010-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 Lattner0558df22009-04-27 00:49:53 +0000597#undef RECORD
Chris Lattnerb145b1e2009-04-26 22:26:21 +0000598}
Mike Stump1eb44332009-09-09 15:08:12 +0000599
Chris Lattnerb145b1e2009-04-26 22:26:21 +0000600void PCHWriter::WriteBlockInfoBlock() {
601 RecordData Record;
602 Stream.EnterSubblock(llvm::bitc::BLOCKINFO_BLOCK_ID, 3);
Mike Stump1eb44332009-09-09 15:08:12 +0000603
Chris Lattner2f4efd12009-04-27 00:40:25 +0000604#define BLOCK(X) EmitBlockID(pch::X ## _ID, #X, Stream, Record)
Chris Lattnerb145b1e2009-04-26 22:26:21 +0000605#define RECORD(X) EmitRecordID(pch::X, #X, Stream, Record)
Mike Stump1eb44332009-09-09 15:08:12 +0000606
Chris Lattnerb145b1e2009-04-26 22:26:21 +0000607 // PCH Top-Level Block.
Chris Lattner2f4efd12009-04-27 00:40:25 +0000608 BLOCK(PCH_BLOCK);
Zhongxing Xu51e774d2009-06-03 09:23:28 +0000609 RECORD(ORIGINAL_FILE_NAME);
Chris Lattnerb145b1e2009-04-26 22:26:21 +0000610 RECORD(TYPE_OFFSET);
611 RECORD(DECL_OFFSET);
612 RECORD(LANGUAGE_OPTIONS);
Douglas Gregorab41e632009-04-27 22:23:34 +0000613 RECORD(METADATA);
Chris Lattnerb145b1e2009-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 Lattnere6bbc012010-02-12 00:07:30 +0000620 RECORD(UNUSED_STATIC_FUNCS);
Chris Lattnerb145b1e2009-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 Gregor7f94b0b2009-04-27 06:38:32 +0000625 RECORD(SOURCE_LOCATION_OFFSETS);
626 RECORD(SOURCE_LOCATION_PRELOADS);
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000627 RECORD(STAT_CACHE);
Douglas Gregorb81c1702009-04-27 20:06:05 +0000628 RECORD(EXT_VECTOR_DECLS);
Ted Kremenek5b4ec632010-01-22 20:59:36 +0000629 RECORD(VERSION_CONTROL_BRANCH_REVISION);
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000630 RECORD(UNUSED_STATIC_FUNCS);
631 RECORD(MACRO_DEFINITION_OFFSETS);
Sebastian Redla93e3b52010-07-08 22:01:51 +0000632 RECORD(CHAINED_METADATA);
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000633
Chris Lattnerb145b1e2009-04-26 22:26:21 +0000634 // SourceManager Block.
Chris Lattner2f4efd12009-04-27 00:40:25 +0000635 BLOCK(SOURCE_MANAGER_BLOCK);
Chris Lattnerb145b1e2009-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 Stump1eb44332009-09-09 15:08:12 +0000641
Chris Lattnerb145b1e2009-04-26 22:26:21 +0000642 // Preprocessor Block.
Chris Lattner2f4efd12009-04-27 00:40:25 +0000643 BLOCK(PREPROCESSOR_BLOCK);
Chris Lattnerb145b1e2009-04-26 22:26:21 +0000644 RECORD(PP_MACRO_OBJECT_LIKE);
645 RECORD(PP_MACRO_FUNCTION_LIKE);
646 RECORD(PP_TOKEN);
Douglas Gregor6a5a23f2010-03-19 21:51:54 +0000647 RECORD(PP_MACRO_INSTANTIATION);
648 RECORD(PP_MACRO_DEFINITION);
649
Douglas Gregor61d60ee2009-10-17 00:13:19 +0000650 // Decls and Types block.
651 BLOCK(DECLTYPES_BLOCK);
Chris Lattnerb145b1e2009-04-26 22:26:21 +0000652 RECORD(TYPE_EXT_QUAL);
Chris Lattnerb145b1e2009-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 McCalla53d2cb2010-05-16 02:12:35 +0000672 RECORD(TYPE_OBJC_OBJECT);
Steve Naroffd1b3c2d2009-06-17 22:40:22 +0000673 RECORD(TYPE_OBJC_OBJECT_POINTER);
Chris Lattner0ff8cda2009-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 Lattnerb145b1e2009-04-26 22:26:21 +0000694 RECORD(DECL_FIELD);
695 RECORD(DECL_VAR);
Chris Lattner0ff8cda2009-04-26 22:32:16 +0000696 RECORD(DECL_IMPLICIT_PARAM);
Chris Lattnerb145b1e2009-04-26 22:26:21 +0000697 RECORD(DECL_PARM_VAR);
Chris Lattner0ff8cda2009-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 Gregor61d60ee2009-10-17 00:13:19 +0000702 // Statements and Exprs can occur in the Decls and Types block.
Chris Lattner0558df22009-04-27 00:49:53 +0000703 AddStmtsExprs(Stream, Record);
Chris Lattnerb145b1e2009-04-26 22:26:21 +0000704#undef RECORD
705#undef BLOCK
706 Stream.ExitBlock();
707}
708
Douglas Gregore650c8c2009-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 Stump1eb44332009-09-09 15:08:12 +0000711///
Douglas Gregore650c8c2009-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 Stump1eb44332009-09-09 15:08:12 +0000719static const char *
Douglas Gregore650c8c2009-07-07 00:12:59 +0000720adjustFilenameForRelocatablePCH(const char *Filename, const char *isysroot) {
721 assert(Filename && "No file name to adjust?");
Mike Stump1eb44332009-09-09 15:08:12 +0000722
Douglas Gregore650c8c2009-07-07 00:12:59 +0000723 if (!isysroot)
724 return Filename;
Mike Stump1eb44332009-09-09 15:08:12 +0000725
Douglas Gregore650c8c2009-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 Stump1eb44332009-09-09 15:08:12 +0000731
Douglas Gregore650c8c2009-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 Stump1eb44332009-09-09 15:08:12 +0000735
Douglas Gregore650c8c2009-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 Stump1eb44332009-09-09 15:08:12 +0000741
Douglas Gregore650c8c2009-07-07 00:12:59 +0000742 return Filename + Pos;
743}
Chris Lattnerb145b1e2009-04-26 22:26:21 +0000744
Douglas Gregorab41e632009-04-27 22:23:34 +0000745/// \brief Write the PCH metadata (e.g., i686-apple-darwin9).
Sebastian Redl30c514c2010-07-14 23:45:08 +0000746void PCHWriter::WriteMetadata(ASTContext &Context, const char *isysroot) {
Douglas Gregor2bec0412009-04-10 21:16:55 +0000747 using namespace llvm;
Douglas Gregorb64c1932009-05-12 01:31:05 +0000748
Douglas Gregore650c8c2009-07-07 00:12:59 +0000749 // Metadata
750 const TargetInfo &Target = Context.Target;
751 BitCodeAbbrev *MetaAbbrev = new BitCodeAbbrev();
Sebastian Redl77f46032010-07-09 21:00:24 +0000752 MetaAbbrev->Add(BitCodeAbbrevOp(
753 Chain ? pch::CHAINED_METADATA : pch::METADATA));
Douglas Gregore650c8c2009-07-07 00:12:59 +0000754 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // PCH major
755 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // PCH minor
756 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang major
757 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang minor
758 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
Sebastian Redl77f46032010-07-09 21:00:24 +0000759 // Target triple or chained PCH name
760 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Douglas Gregore650c8c2009-07-07 00:12:59 +0000761 unsigned MetaAbbrevCode = Stream.EmitAbbrev(MetaAbbrev);
Mike Stump1eb44332009-09-09 15:08:12 +0000762
Douglas Gregore650c8c2009-07-07 00:12:59 +0000763 RecordData Record;
Sebastian Redl77f46032010-07-09 21:00:24 +0000764 Record.push_back(Chain ? pch::CHAINED_METADATA : pch::METADATA);
Douglas Gregore650c8c2009-07-07 00:12:59 +0000765 Record.push_back(pch::VERSION_MAJOR);
766 Record.push_back(pch::VERSION_MINOR);
767 Record.push_back(CLANG_VERSION_MAJOR);
768 Record.push_back(CLANG_VERSION_MINOR);
769 Record.push_back(isysroot != 0);
Sebastian Redl77f46032010-07-09 21:00:24 +0000770 // FIXME: This writes the absolute path for chained headers.
771 const std::string &BlobStr = Chain ? Chain->getFileName() : Target.getTriple().getTriple();
772 Stream.EmitRecordWithBlob(MetaAbbrevCode, Record, BlobStr);
Mike Stump1eb44332009-09-09 15:08:12 +0000773
Douglas Gregorb64c1932009-05-12 01:31:05 +0000774 // Original file name
775 SourceManager &SM = Context.getSourceManager();
776 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
777 BitCodeAbbrev *FileAbbrev = new BitCodeAbbrev();
778 FileAbbrev->Add(BitCodeAbbrevOp(pch::ORIGINAL_FILE_NAME));
779 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
780 unsigned FileAbbrevCode = Stream.EmitAbbrev(FileAbbrev);
781
782 llvm::sys::Path MainFilePath(MainFile->getName());
Mike Stump1eb44332009-09-09 15:08:12 +0000783
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +0000784 MainFilePath.makeAbsolute();
Douglas Gregorb64c1932009-05-12 01:31:05 +0000785
Kovarththanan Rajaratnamaba54a92010-03-14 07:15:57 +0000786 const char *MainFileNameStr = MainFilePath.c_str();
Mike Stump1eb44332009-09-09 15:08:12 +0000787 MainFileNameStr = adjustFilenameForRelocatablePCH(MainFileNameStr,
Douglas Gregore650c8c2009-07-07 00:12:59 +0000788 isysroot);
Douglas Gregorb64c1932009-05-12 01:31:05 +0000789 RecordData Record;
790 Record.push_back(pch::ORIGINAL_FILE_NAME);
Daniel Dunbarec312a12009-08-24 09:31:37 +0000791 Stream.EmitRecordWithBlob(FileAbbrevCode, Record, MainFileNameStr);
Douglas Gregorb64c1932009-05-12 01:31:05 +0000792 }
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +0000793
Ted Kremenekf7a96a32010-01-22 22:12:47 +0000794 // Repository branch/version information.
795 BitCodeAbbrev *RepoAbbrev = new BitCodeAbbrev();
796 RepoAbbrev->Add(BitCodeAbbrevOp(pch::VERSION_CONTROL_BRANCH_REVISION));
797 RepoAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
798 unsigned RepoAbbrevCode = Stream.EmitAbbrev(RepoAbbrev);
Douglas Gregor445e23e2009-10-05 21:07:28 +0000799 Record.clear();
Ted Kremenek5b4ec632010-01-22 20:59:36 +0000800 Record.push_back(pch::VERSION_CONTROL_BRANCH_REVISION);
Ted Kremenekf7a96a32010-01-22 22:12:47 +0000801 Stream.EmitRecordWithBlob(RepoAbbrevCode, Record,
802 getClangFullRepositoryVersion());
Douglas Gregor2bec0412009-04-10 21:16:55 +0000803}
804
805/// \brief Write the LangOptions structure.
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000806void PCHWriter::WriteLanguageOptions(const LangOptions &LangOpts) {
807 RecordData Record;
808 Record.push_back(LangOpts.Trigraphs);
809 Record.push_back(LangOpts.BCPLComment); // BCPL-style '//' comments.
810 Record.push_back(LangOpts.DollarIdents); // '$' allowed in identifiers.
811 Record.push_back(LangOpts.AsmPreprocessor); // Preprocessor in asm mode.
812 Record.push_back(LangOpts.GNUMode); // True in gnu99 mode false in c99 mode (etc)
Chandler Carrutheb5d7b72010-04-17 20:17:31 +0000813 Record.push_back(LangOpts.GNUKeywords); // Allow GNU-extension keywords
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000814 Record.push_back(LangOpts.ImplicitInt); // C89 implicit 'int'.
815 Record.push_back(LangOpts.Digraphs); // C94, C99 and C++
816 Record.push_back(LangOpts.HexFloats); // C99 Hexadecimal float constants.
817 Record.push_back(LangOpts.C99); // C99 Support
818 Record.push_back(LangOpts.Microsoft); // Microsoft extensions.
819 Record.push_back(LangOpts.CPlusPlus); // C++ Support
820 Record.push_back(LangOpts.CPlusPlus0x); // C++0x Support
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000821 Record.push_back(LangOpts.CXXOperatorNames); // Treat C++ operator names as keywords.
Mike Stump1eb44332009-09-09 15:08:12 +0000822
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000823 Record.push_back(LangOpts.ObjC1); // Objective-C 1 support enabled.
824 Record.push_back(LangOpts.ObjC2); // Objective-C 2 support enabled.
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +0000825 Record.push_back(LangOpts.ObjCNonFragileABI); // Objective-C
Fariborz Jahanian412e7982010-02-09 19:31:38 +0000826 // modern abi enabled.
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +0000827 Record.push_back(LangOpts.ObjCNonFragileABI2); // Objective-C enhanced
Fariborz Jahanian412e7982010-02-09 19:31:38 +0000828 // modern abi enabled.
Fariborz Jahanian4c9d8d02010-04-22 21:01:59 +0000829 Record.push_back(LangOpts.NoConstantCFStrings); // non cfstring generation enabled..
Mike Stump1eb44332009-09-09 15:08:12 +0000830
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000831 Record.push_back(LangOpts.PascalStrings); // Allow Pascal strings
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000832 Record.push_back(LangOpts.WritableStrings); // Allow writable strings
833 Record.push_back(LangOpts.LaxVectorConversions);
Nate Begemanb9e7e632009-06-25 23:01:11 +0000834 Record.push_back(LangOpts.AltiVec);
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000835 Record.push_back(LangOpts.Exceptions); // Support exception handling.
Daniel Dunbar73482882010-02-10 18:48:44 +0000836 Record.push_back(LangOpts.SjLjExceptions);
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000837
838 Record.push_back(LangOpts.NeXTRuntime); // Use NeXT runtime.
839 Record.push_back(LangOpts.Freestanding); // Freestanding implementation
840 Record.push_back(LangOpts.NoBuiltin); // Do not use builtin functions (-fno-builtin)
841
Chris Lattnerea5ce472009-04-27 07:35:58 +0000842 // Whether static initializers are protected by locks.
843 Record.push_back(LangOpts.ThreadsafeStatics);
Douglas Gregor972d9542009-09-03 14:36:33 +0000844 Record.push_back(LangOpts.POSIXThreads);
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000845 Record.push_back(LangOpts.Blocks); // block extension to C
846 Record.push_back(LangOpts.EmitAllDecls); // Emit all declarations, even if
847 // they are unused.
848 Record.push_back(LangOpts.MathErrno); // Math functions must respect errno
849 // (modulo the platform support).
850
Chris Lattnera4d71452010-06-26 21:25:03 +0000851 Record.push_back(LangOpts.getSignedOverflowBehavior());
852 Record.push_back(LangOpts.HeinousExtensions);
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000853
854 Record.push_back(LangOpts.Optimize); // Whether __OPTIMIZE__ should be defined.
Mike Stump1eb44332009-09-09 15:08:12 +0000855 Record.push_back(LangOpts.OptimizeSize); // Whether __OPTIMIZE_SIZE__ should be
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000856 // defined.
857 Record.push_back(LangOpts.Static); // Should __STATIC__ be defined (as
858 // opposed to __DYNAMIC__).
859 Record.push_back(LangOpts.PICLevel); // The value for __PIC__, if non-zero.
860
861 Record.push_back(LangOpts.GNUInline); // Should GNU inline semantics be
862 // used (instead of C99 semantics).
863 Record.push_back(LangOpts.NoInline); // Should __NO_INLINE__ be defined.
Anders Carlssona33d9b42009-05-13 19:49:53 +0000864 Record.push_back(LangOpts.AccessControl); // Whether C++ access control should
865 // be enabled.
Eli Friedman15b91762009-06-05 07:05:05 +0000866 Record.push_back(LangOpts.CharIsSigned); // Whether char is a signed or
867 // unsigned type
John Thompsona6fda122009-11-05 20:14:16 +0000868 Record.push_back(LangOpts.ShortWChar); // force wchar_t to be unsigned short
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000869 Record.push_back(LangOpts.getGCMode());
870 Record.push_back(LangOpts.getVisibilityMode());
Daniel Dunbarab8e2812009-09-21 04:16:19 +0000871 Record.push_back(LangOpts.getStackProtectorMode());
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000872 Record.push_back(LangOpts.InstantiationDepth);
Nate Begemanb9e7e632009-06-25 23:01:11 +0000873 Record.push_back(LangOpts.OpenCL);
Mike Stump9c276ae2009-12-12 01:27:46 +0000874 Record.push_back(LangOpts.CatchUndefined);
Anders Carlsson92f58222009-08-22 22:30:33 +0000875 Record.push_back(LangOpts.ElideConstructors);
Douglas Gregora0068fc2010-07-09 17:35:33 +0000876 Record.push_back(LangOpts.SpellChecking);
Douglas Gregorc9490c02009-04-16 22:23:12 +0000877 Stream.EmitRecord(pch::LANGUAGE_OPTIONS, Record);
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000878}
879
Douglas Gregor14f79002009-04-10 03:52:48 +0000880//===----------------------------------------------------------------------===//
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000881// stat cache Serialization
882//===----------------------------------------------------------------------===//
883
884namespace {
885// Trait used for the on-disk hash table of stat cache results.
Benjamin Kramerbd218282009-11-28 10:07:24 +0000886class PCHStatCacheTrait {
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000887public:
888 typedef const char * key_type;
889 typedef key_type key_type_ref;
Mike Stump1eb44332009-09-09 15:08:12 +0000890
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000891 typedef std::pair<int, struct stat> data_type;
892 typedef const data_type& data_type_ref;
893
894 static unsigned ComputeHash(const char *path) {
Daniel Dunbar2596e422009-10-17 23:52:28 +0000895 return llvm::HashString(path);
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000896 }
Mike Stump1eb44332009-09-09 15:08:12 +0000897
898 std::pair<unsigned,unsigned>
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000899 EmitKeyDataLength(llvm::raw_ostream& Out, const char *path,
900 data_type_ref Data) {
901 unsigned StrLen = strlen(path);
902 clang::io::Emit16(Out, StrLen);
903 unsigned DataLen = 1; // result value
904 if (Data.first == 0)
905 DataLen += 4 + 4 + 2 + 8 + 8;
906 clang::io::Emit8(Out, DataLen);
907 return std::make_pair(StrLen + 1, DataLen);
908 }
Mike Stump1eb44332009-09-09 15:08:12 +0000909
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000910 void EmitKey(llvm::raw_ostream& Out, const char *path, unsigned KeyLen) {
911 Out.write(path, KeyLen);
912 }
Mike Stump1eb44332009-09-09 15:08:12 +0000913
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000914 void EmitData(llvm::raw_ostream& Out, key_type_ref,
915 data_type_ref Data, unsigned DataLen) {
916 using namespace clang::io;
917 uint64_t Start = Out.tell(); (void)Start;
Mike Stump1eb44332009-09-09 15:08:12 +0000918
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000919 // Result of stat()
920 Emit8(Out, Data.first? 1 : 0);
Mike Stump1eb44332009-09-09 15:08:12 +0000921
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000922 if (Data.first == 0) {
923 Emit32(Out, (uint32_t) Data.second.st_ino);
924 Emit32(Out, (uint32_t) Data.second.st_dev);
925 Emit16(Out, (uint16_t) Data.second.st_mode);
926 Emit64(Out, (uint64_t) Data.second.st_mtime);
927 Emit64(Out, (uint64_t) Data.second.st_size);
928 }
929
930 assert(Out.tell() - Start == DataLen && "Wrong data length");
931 }
932};
933} // end anonymous namespace
934
935/// \brief Write the stat() system call cache to the PCH file.
Douglas Gregordd41ed52010-07-12 23:48:14 +0000936void PCHWriter::WriteStatCache(MemorizeStatCalls &StatCalls) {
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000937 // Build the on-disk hash table containing information about every
938 // stat() call.
939 OnDiskChainedHashTableGenerator<PCHStatCacheTrait> Generator;
940 unsigned NumStatEntries = 0;
Mike Stump1eb44332009-09-09 15:08:12 +0000941 for (MemorizeStatCalls::iterator Stat = StatCalls.begin(),
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000942 StatEnd = StatCalls.end();
Douglas Gregore650c8c2009-07-07 00:12:59 +0000943 Stat != StatEnd; ++Stat, ++NumStatEntries) {
944 const char *Filename = Stat->first();
Douglas Gregore650c8c2009-07-07 00:12:59 +0000945 Generator.insert(Filename, Stat->second);
946 }
Mike Stump1eb44332009-09-09 15:08:12 +0000947
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000948 // Create the on-disk hash table in a buffer.
Mike Stump1eb44332009-09-09 15:08:12 +0000949 llvm::SmallString<4096> StatCacheData;
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000950 uint32_t BucketOffset;
951 {
952 llvm::raw_svector_ostream Out(StatCacheData);
953 // Make sure that no bucket is at offset 0
954 clang::io::Emit32(Out, 0);
955 BucketOffset = Generator.Emit(Out);
956 }
957
958 // Create a blob abbreviation
959 using namespace llvm;
960 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
961 Abbrev->Add(BitCodeAbbrevOp(pch::STAT_CACHE));
962 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
963 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
964 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
965 unsigned StatCacheAbbrev = Stream.EmitAbbrev(Abbrev);
966
967 // Write the stat cache
968 RecordData Record;
969 Record.push_back(pch::STAT_CACHE);
970 Record.push_back(BucketOffset);
971 Record.push_back(NumStatEntries);
Daniel Dunbarec312a12009-08-24 09:31:37 +0000972 Stream.EmitRecordWithBlob(StatCacheAbbrev, Record, StatCacheData.str());
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000973}
974
975//===----------------------------------------------------------------------===//
Douglas Gregor14f79002009-04-10 03:52:48 +0000976// Source Manager Serialization
977//===----------------------------------------------------------------------===//
978
979/// \brief Create an abbreviation for the SLocEntry that refers to a
980/// file.
Douglas Gregorc9490c02009-04-16 22:23:12 +0000981static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregor14f79002009-04-10 03:52:48 +0000982 using namespace llvm;
983 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
984 Abbrev->Add(BitCodeAbbrevOp(pch::SM_SLOC_FILE_ENTRY));
985 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
986 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
987 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
988 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
Douglas Gregor2d52be52010-03-21 22:49:54 +0000989 // FileEntry fields.
990 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
991 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
Douglas Gregor12fab312010-03-16 16:35:32 +0000992 // HeaderFileInfo fields.
993 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isImport
994 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // DirInfo
995 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumIncludes
996 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // ControllingMacro
Douglas Gregor14f79002009-04-10 03:52:48 +0000997 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
Douglas Gregorc9490c02009-04-16 22:23:12 +0000998 return Stream.EmitAbbrev(Abbrev);
Douglas Gregor14f79002009-04-10 03:52:48 +0000999}
1000
1001/// \brief Create an abbreviation for the SLocEntry that refers to a
1002/// buffer.
Douglas Gregorc9490c02009-04-16 22:23:12 +00001003static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregor14f79002009-04-10 03:52:48 +00001004 using namespace llvm;
1005 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1006 Abbrev->Add(BitCodeAbbrevOp(pch::SM_SLOC_BUFFER_ENTRY));
1007 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1008 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1009 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1010 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1011 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
Douglas Gregorc9490c02009-04-16 22:23:12 +00001012 return Stream.EmitAbbrev(Abbrev);
Douglas Gregor14f79002009-04-10 03:52:48 +00001013}
1014
1015/// \brief Create an abbreviation for the SLocEntry that refers to a
1016/// buffer's blob.
Douglas Gregorc9490c02009-04-16 22:23:12 +00001017static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregor14f79002009-04-10 03:52:48 +00001018 using namespace llvm;
1019 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1020 Abbrev->Add(BitCodeAbbrevOp(pch::SM_SLOC_BUFFER_BLOB));
1021 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
Douglas Gregorc9490c02009-04-16 22:23:12 +00001022 return Stream.EmitAbbrev(Abbrev);
Douglas Gregor14f79002009-04-10 03:52:48 +00001023}
1024
1025/// \brief Create an abbreviation for the SLocEntry that refers to an
1026/// buffer.
Douglas Gregorc9490c02009-04-16 22:23:12 +00001027static unsigned CreateSLocInstantiationAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregor14f79002009-04-10 03:52:48 +00001028 using namespace llvm;
1029 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1030 Abbrev->Add(BitCodeAbbrevOp(pch::SM_SLOC_INSTANTIATION_ENTRY));
1031 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1032 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1033 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1034 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
Douglas Gregorf60e9912009-04-15 18:05:10 +00001035 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
Douglas Gregorc9490c02009-04-16 22:23:12 +00001036 return Stream.EmitAbbrev(Abbrev);
Douglas Gregor14f79002009-04-10 03:52:48 +00001037}
1038
1039/// \brief Writes the block containing the serialized form of the
1040/// source manager.
1041///
1042/// TODO: We should probably use an on-disk hash table (stored in a
1043/// blob), indexed based on the file name, so that we only create
1044/// entries for files that we actually need. In the common case (no
1045/// errors), we probably won't have to create file entries for any of
1046/// the files in the AST.
Douglas Gregor2eafc1b2009-04-26 00:07:37 +00001047void PCHWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
Douglas Gregore650c8c2009-07-07 00:12:59 +00001048 const Preprocessor &PP,
1049 const char *isysroot) {
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001050 RecordData Record;
1051
Chris Lattnerf04ad692009-04-10 17:16:57 +00001052 // Enter the source manager block.
Douglas Gregorc9490c02009-04-16 22:23:12 +00001053 Stream.EnterSubblock(pch::SOURCE_MANAGER_BLOCK_ID, 3);
Douglas Gregor14f79002009-04-10 03:52:48 +00001054
1055 // Abbreviations for the various kinds of source-location entries.
Chris Lattner828e18c2009-04-27 19:03:22 +00001056 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
1057 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
1058 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream);
1059 unsigned SLocInstantiationAbbrv = CreateSLocInstantiationAbbrev(Stream);
Douglas Gregor14f79002009-04-10 03:52:48 +00001060
Douglas Gregorbd945002009-04-13 16:31:14 +00001061 // Write the line table.
1062 if (SourceMgr.hasLineTable()) {
1063 LineTableInfo &LineTable = SourceMgr.getLineTable();
1064
1065 // Emit the file names
1066 Record.push_back(LineTable.getNumFilenames());
1067 for (unsigned I = 0, N = LineTable.getNumFilenames(); I != N; ++I) {
1068 // Emit the file name
1069 const char *Filename = LineTable.getFilename(I);
Douglas Gregore650c8c2009-07-07 00:12:59 +00001070 Filename = adjustFilenameForRelocatablePCH(Filename, isysroot);
Douglas Gregorbd945002009-04-13 16:31:14 +00001071 unsigned FilenameLen = Filename? strlen(Filename) : 0;
1072 Record.push_back(FilenameLen);
1073 if (FilenameLen)
1074 Record.insert(Record.end(), Filename, Filename + FilenameLen);
1075 }
Mike Stump1eb44332009-09-09 15:08:12 +00001076
Douglas Gregorbd945002009-04-13 16:31:14 +00001077 // Emit the line entries
1078 for (LineTableInfo::iterator L = LineTable.begin(), LEnd = LineTable.end();
1079 L != LEnd; ++L) {
1080 // Emit the file ID
1081 Record.push_back(L->first);
Mike Stump1eb44332009-09-09 15:08:12 +00001082
Douglas Gregorbd945002009-04-13 16:31:14 +00001083 // Emit the line entries
1084 Record.push_back(L->second.size());
Mike Stump1eb44332009-09-09 15:08:12 +00001085 for (std::vector<LineEntry>::iterator LE = L->second.begin(),
Douglas Gregorbd945002009-04-13 16:31:14 +00001086 LEEnd = L->second.end();
1087 LE != LEEnd; ++LE) {
1088 Record.push_back(LE->FileOffset);
1089 Record.push_back(LE->LineNo);
1090 Record.push_back(LE->FilenameID);
1091 Record.push_back((unsigned)LE->FileKind);
1092 Record.push_back(LE->IncludeOffset);
1093 }
Douglas Gregorbd945002009-04-13 16:31:14 +00001094 }
Zhongxing Xu3d8216a2009-05-22 08:38:27 +00001095 Stream.EmitRecord(pch::SM_LINE_TABLE, Record);
Douglas Gregorbd945002009-04-13 16:31:14 +00001096 }
1097
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001098 // Write out the source location entry table. We skip the first
1099 // entry, which is always the same dummy entry.
Chris Lattner090d9b52009-04-27 19:01:47 +00001100 std::vector<uint32_t> SLocEntryOffsets;
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001101 RecordData PreloadSLocs;
1102 SLocEntryOffsets.reserve(SourceMgr.sloc_entry_size() - 1);
Douglas Gregorbdfe48a2009-10-16 22:46:09 +00001103 for (unsigned I = 1, N = SourceMgr.sloc_entry_size(); I != N; ++I) {
1104 // Get this source location entry.
1105 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getSLocEntry(I);
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00001106
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001107 // Record the offset of this source-location entry.
1108 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
1109
1110 // Figure out which record code to use.
1111 unsigned Code;
1112 if (SLoc->isFile()) {
1113 if (SLoc->getFile().getContentCache()->Entry)
1114 Code = pch::SM_SLOC_FILE_ENTRY;
1115 else
1116 Code = pch::SM_SLOC_BUFFER_ENTRY;
1117 } else
1118 Code = pch::SM_SLOC_INSTANTIATION_ENTRY;
1119 Record.clear();
1120 Record.push_back(Code);
1121
1122 Record.push_back(SLoc->getOffset());
1123 if (SLoc->isFile()) {
1124 const SrcMgr::FileInfo &File = SLoc->getFile();
1125 Record.push_back(File.getIncludeLoc().getRawEncoding());
1126 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
1127 Record.push_back(File.hasLineDirectives());
1128
1129 const SrcMgr::ContentCache *Content = File.getContentCache();
1130 if (Content->Entry) {
1131 // The source location entry is a file. The blob associated
1132 // with this entry is the file name.
Mike Stump1eb44332009-09-09 15:08:12 +00001133
Douglas Gregor2d52be52010-03-21 22:49:54 +00001134 // Emit size/modification time for this file.
1135 Record.push_back(Content->Entry->getSize());
1136 Record.push_back(Content->Entry->getModificationTime());
1137
Douglas Gregor12fab312010-03-16 16:35:32 +00001138 // Emit header-search information associated with this file.
1139 HeaderFileInfo HFI;
1140 HeaderSearch &HS = PP.getHeaderSearchInfo();
1141 if (Content->Entry->getUID() < HS.header_file_size())
1142 HFI = HS.header_file_begin()[Content->Entry->getUID()];
1143 Record.push_back(HFI.isImport);
1144 Record.push_back(HFI.DirInfo);
1145 Record.push_back(HFI.NumIncludes);
1146 AddIdentifierRef(HFI.ControllingMacro, Record);
1147
Douglas Gregore650c8c2009-07-07 00:12:59 +00001148 // Turn the file name into an absolute path, if it isn't already.
1149 const char *Filename = Content->Entry->getName();
1150 llvm::sys::Path FilePath(Filename, strlen(Filename));
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00001151 FilePath.makeAbsolute();
Kovarththanan Rajaratnamaba54a92010-03-14 07:15:57 +00001152 Filename = FilePath.c_str();
Mike Stump1eb44332009-09-09 15:08:12 +00001153
Douglas Gregore650c8c2009-07-07 00:12:59 +00001154 Filename = adjustFilenameForRelocatablePCH(Filename, isysroot);
Daniel Dunbarec312a12009-08-24 09:31:37 +00001155 Stream.EmitRecordWithBlob(SLocFileAbbrv, Record, Filename);
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001156
1157 // FIXME: For now, preload all file source locations, so that
1158 // we get the appropriate File entries in the reader. This is
1159 // a temporary measure.
1160 PreloadSLocs.push_back(SLocEntryOffsets.size());
1161 } else {
1162 // The source location entry is a buffer. The blob associated
1163 // with this entry contains the contents of the buffer.
1164
1165 // We add one to the size so that we capture the trailing NULL
1166 // that is required by llvm::MemoryBuffer::getMemBuffer (on
1167 // the reader side).
Douglas Gregor36c35ba2010-03-16 00:35:39 +00001168 const llvm::MemoryBuffer *Buffer
Chris Lattnere127a0d2010-04-20 20:35:58 +00001169 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001170 const char *Name = Buffer->getBufferIdentifier();
Daniel Dunbarec312a12009-08-24 09:31:37 +00001171 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
1172 llvm::StringRef(Name, strlen(Name) + 1));
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001173 Record.clear();
1174 Record.push_back(pch::SM_SLOC_BUFFER_BLOB);
1175 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record,
Daniel Dunbarec312a12009-08-24 09:31:37 +00001176 llvm::StringRef(Buffer->getBufferStart(),
1177 Buffer->getBufferSize() + 1));
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001178
1179 if (strcmp(Name, "<built-in>") == 0)
1180 PreloadSLocs.push_back(SLocEntryOffsets.size());
1181 }
1182 } else {
1183 // The source location entry is an instantiation.
1184 const SrcMgr::InstantiationInfo &Inst = SLoc->getInstantiation();
1185 Record.push_back(Inst.getSpellingLoc().getRawEncoding());
1186 Record.push_back(Inst.getInstantiationLocStart().getRawEncoding());
1187 Record.push_back(Inst.getInstantiationLocEnd().getRawEncoding());
1188
1189 // Compute the token length for this macro expansion.
1190 unsigned NextOffset = SourceMgr.getNextOffset();
Douglas Gregorbdfe48a2009-10-16 22:46:09 +00001191 if (I + 1 != N)
1192 NextOffset = SourceMgr.getSLocEntry(I + 1).getOffset();
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001193 Record.push_back(NextOffset - SLoc->getOffset() - 1);
1194 Stream.EmitRecordWithAbbrev(SLocInstantiationAbbrv, Record);
1195 }
1196 }
1197
Douglas Gregorc9490c02009-04-16 22:23:12 +00001198 Stream.ExitBlock();
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001199
1200 if (SLocEntryOffsets.empty())
1201 return;
1202
1203 // Write the source-location offsets table into the PCH block. This
1204 // table is used for lazily loading source-location information.
1205 using namespace llvm;
1206 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1207 Abbrev->Add(BitCodeAbbrevOp(pch::SOURCE_LOCATION_OFFSETS));
1208 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
1209 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // next offset
1210 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
1211 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(Abbrev);
Mike Stump1eb44332009-09-09 15:08:12 +00001212
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001213 Record.clear();
1214 Record.push_back(pch::SOURCE_LOCATION_OFFSETS);
1215 Record.push_back(SLocEntryOffsets.size());
1216 Record.push_back(SourceMgr.getNextOffset());
1217 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
Mike Stump1eb44332009-09-09 15:08:12 +00001218 (const char *)&SLocEntryOffsets.front(),
Chris Lattner090d9b52009-04-27 19:01:47 +00001219 SLocEntryOffsets.size()*sizeof(SLocEntryOffsets[0]));
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001220
1221 // Write the source location entry preloads array, telling the PCH
1222 // reader which source locations entries it should load eagerly.
1223 Stream.EmitRecord(pch::SOURCE_LOCATION_PRELOADS, PreloadSLocs);
Douglas Gregor14f79002009-04-10 03:52:48 +00001224}
1225
Douglas Gregor4fed3f42009-04-27 18:38:38 +00001226//===----------------------------------------------------------------------===//
1227// Preprocessor Serialization
1228//===----------------------------------------------------------------------===//
1229
Chris Lattner0b1fb982009-04-10 17:15:23 +00001230/// \brief Writes the block containing the serialized form of the
1231/// preprocessor.
1232///
Chris Lattnerdf961c22009-04-10 18:08:30 +00001233void PCHWriter::WritePreprocessor(const Preprocessor &PP) {
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001234 RecordData Record;
Chris Lattnerf04ad692009-04-10 17:16:57 +00001235
Chris Lattnerc1f9d822009-04-13 01:29:17 +00001236 // If the preprocessor __COUNTER__ value has been bumped, remember it.
1237 if (PP.getCounterValue() != 0) {
1238 Record.push_back(PP.getCounterValue());
Douglas Gregorc9490c02009-04-16 22:23:12 +00001239 Stream.EmitRecord(pch::PP_COUNTER_VALUE, Record);
Chris Lattnerc1f9d822009-04-13 01:29:17 +00001240 Record.clear();
Douglas Gregor2eafc1b2009-04-26 00:07:37 +00001241 }
1242
1243 // Enter the preprocessor block.
1244 Stream.EnterSubblock(pch::PREPROCESSOR_BLOCK_ID, 2);
Mike Stump1eb44332009-09-09 15:08:12 +00001245
Douglas Gregor2eafc1b2009-04-26 00:07:37 +00001246 // If the PCH file contains __DATE__ or __TIME__ emit a warning about this.
1247 // FIXME: use diagnostics subsystem for localization etc.
1248 if (PP.SawDateOrTime())
1249 fprintf(stderr, "warning: precompiled header used __DATE__ or __TIME__.\n");
Mike Stump1eb44332009-09-09 15:08:12 +00001250
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001251 // Loop over all the macro definitions that are live at the end of the file,
1252 // emitting each to the PP section.
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001253 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001254 for (Preprocessor::macro_iterator I = PP.macro_begin(), E = PP.macro_end();
1255 I != E; ++I) {
Chris Lattner42d42b52009-04-10 21:41:48 +00001256 // FIXME: This emits macros in hash table order, we should do it in a stable
1257 // order so that output is reproducible.
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001258 MacroInfo *MI = I->second;
1259
1260 // Don't emit builtin macros like __LINE__ to the PCH file unless they have
1261 // been redefined by the header (in which case they are not isBuiltinMacro).
1262 if (MI->isBuiltinMacro())
1263 continue;
1264
Chris Lattner7356a312009-04-11 21:15:38 +00001265 AddIdentifierRef(I->first, Record);
Douglas Gregor37e26842009-04-21 23:56:24 +00001266 MacroOffsets[I->first] = Stream.GetCurrentBitNo();
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001267 Record.push_back(MI->getDefinitionLoc().getRawEncoding());
1268 Record.push_back(MI->isUsed());
Mike Stump1eb44332009-09-09 15:08:12 +00001269
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001270 unsigned Code;
1271 if (MI->isObjectLike()) {
1272 Code = pch::PP_MACRO_OBJECT_LIKE;
1273 } else {
1274 Code = pch::PP_MACRO_FUNCTION_LIKE;
Mike Stump1eb44332009-09-09 15:08:12 +00001275
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001276 Record.push_back(MI->isC99Varargs());
1277 Record.push_back(MI->isGNUVarargs());
1278 Record.push_back(MI->getNumArgs());
1279 for (MacroInfo::arg_iterator I = MI->arg_begin(), E = MI->arg_end();
1280 I != E; ++I)
Chris Lattner7356a312009-04-11 21:15:38 +00001281 AddIdentifierRef(*I, Record);
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001282 }
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001283
1284 // If we have a detailed preprocessing record, record the macro definition
1285 // ID that corresponds to this macro.
1286 if (PPRec)
1287 Record.push_back(getMacroDefinitionID(PPRec->findMacroDefinition(MI)));
1288
Douglas Gregorc9490c02009-04-16 22:23:12 +00001289 Stream.EmitRecord(Code, Record);
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001290 Record.clear();
1291
Chris Lattnerdf961c22009-04-10 18:08:30 +00001292 // Emit the tokens array.
1293 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
1294 // Note that we know that the preprocessor does not have any annotation
1295 // tokens in it because they are created by the parser, and thus can't be
1296 // in a macro definition.
1297 const Token &Tok = MI->getReplacementToken(TokNo);
Mike Stump1eb44332009-09-09 15:08:12 +00001298
Chris Lattnerdf961c22009-04-10 18:08:30 +00001299 Record.push_back(Tok.getLocation().getRawEncoding());
1300 Record.push_back(Tok.getLength());
1301
Chris Lattnerdf961c22009-04-10 18:08:30 +00001302 // FIXME: When reading literal tokens, reconstruct the literal pointer if
1303 // it is needed.
Chris Lattner7356a312009-04-11 21:15:38 +00001304 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
Mike Stump1eb44332009-09-09 15:08:12 +00001305
Chris Lattnerdf961c22009-04-10 18:08:30 +00001306 // FIXME: Should translate token kind to a stable encoding.
1307 Record.push_back(Tok.getKind());
1308 // FIXME: Should translate token flags to a stable encoding.
1309 Record.push_back(Tok.getFlags());
Mike Stump1eb44332009-09-09 15:08:12 +00001310
Douglas Gregorc9490c02009-04-16 22:23:12 +00001311 Stream.EmitRecord(pch::PP_TOKEN, Record);
Chris Lattnerdf961c22009-04-10 18:08:30 +00001312 Record.clear();
1313 }
Douglas Gregor37e26842009-04-21 23:56:24 +00001314 ++NumMacros;
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001315 }
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001316
1317 // If the preprocessor has a preprocessing record, emit it.
1318 unsigned NumPreprocessingRecords = 0;
1319 if (PPRec) {
1320 for (PreprocessingRecord::iterator E = PPRec->begin(), EEnd = PPRec->end();
1321 E != EEnd; ++E) {
1322 Record.clear();
1323
1324 if (MacroInstantiation *MI = dyn_cast<MacroInstantiation>(*E)) {
1325 Record.push_back(NumPreprocessingRecords++);
1326 AddSourceLocation(MI->getSourceRange().getBegin(), Record);
1327 AddSourceLocation(MI->getSourceRange().getEnd(), Record);
1328 AddIdentifierRef(MI->getName(), Record);
1329 Record.push_back(getMacroDefinitionID(MI->getDefinition()));
1330 Stream.EmitRecord(pch::PP_MACRO_INSTANTIATION, Record);
1331 continue;
1332 }
1333
1334 if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) {
1335 // Record this macro definition's location.
1336 pch::IdentID ID = getMacroDefinitionID(MD);
1337 if (ID != MacroDefinitionOffsets.size()) {
1338 if (ID > MacroDefinitionOffsets.size())
1339 MacroDefinitionOffsets.resize(ID + 1);
1340
1341 MacroDefinitionOffsets[ID] = Stream.GetCurrentBitNo();
1342 } else
1343 MacroDefinitionOffsets.push_back(Stream.GetCurrentBitNo());
1344
1345 Record.push_back(NumPreprocessingRecords++);
1346 Record.push_back(ID);
1347 AddSourceLocation(MD->getSourceRange().getBegin(), Record);
1348 AddSourceLocation(MD->getSourceRange().getEnd(), Record);
1349 AddIdentifierRef(MD->getName(), Record);
1350 AddSourceLocation(MD->getLocation(), Record);
1351 Stream.EmitRecord(pch::PP_MACRO_DEFINITION, Record);
1352 continue;
1353 }
1354 }
1355 }
1356
Douglas Gregorc9490c02009-04-16 22:23:12 +00001357 Stream.ExitBlock();
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001358
1359 // Write the offsets table for the preprocessing record.
1360 if (NumPreprocessingRecords > 0) {
1361 // Write the offsets table for identifier IDs.
1362 using namespace llvm;
1363 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1364 Abbrev->Add(BitCodeAbbrevOp(pch::MACRO_DEFINITION_OFFSETS));
1365 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of records
1366 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macro defs
1367 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1368 unsigned MacroDefOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1369
1370 Record.clear();
1371 Record.push_back(pch::MACRO_DEFINITION_OFFSETS);
1372 Record.push_back(NumPreprocessingRecords);
1373 Record.push_back(MacroDefinitionOffsets.size());
1374 Stream.EmitRecordWithBlob(MacroDefOffsetAbbrev, Record,
1375 (const char *)&MacroDefinitionOffsets.front(),
1376 MacroDefinitionOffsets.size() * sizeof(uint32_t));
1377 }
Chris Lattner0b1fb982009-04-10 17:15:23 +00001378}
1379
Douglas Gregor4fed3f42009-04-27 18:38:38 +00001380//===----------------------------------------------------------------------===//
1381// Type Serialization
1382//===----------------------------------------------------------------------===//
Chris Lattner0b1fb982009-04-10 17:15:23 +00001383
Douglas Gregor2cf26342009-04-09 22:27:44 +00001384/// \brief Write the representation of a type to the PCH stream.
John McCall0953e762009-09-24 19:53:00 +00001385void PCHWriter::WriteType(QualType T) {
Douglas Gregor8038d512009-04-10 17:25:41 +00001386 pch::TypeID &ID = TypeIDs[T];
Chris Lattnerf04ad692009-04-10 17:16:57 +00001387 if (ID == 0) // we haven't seen this type before.
Douglas Gregor2cf26342009-04-09 22:27:44 +00001388 ID = NextTypeID++;
Mike Stump1eb44332009-09-09 15:08:12 +00001389
Douglas Gregor2cf26342009-04-09 22:27:44 +00001390 // Record the offset for this type.
1391 if (TypeOffsets.size() == ID - pch::NUM_PREDEF_TYPE_IDS)
Douglas Gregorc9490c02009-04-16 22:23:12 +00001392 TypeOffsets.push_back(Stream.GetCurrentBitNo());
Douglas Gregor2cf26342009-04-09 22:27:44 +00001393 else if (TypeOffsets.size() < ID - pch::NUM_PREDEF_TYPE_IDS) {
1394 TypeOffsets.resize(ID + 1 - pch::NUM_PREDEF_TYPE_IDS);
Douglas Gregorc9490c02009-04-16 22:23:12 +00001395 TypeOffsets[ID - pch::NUM_PREDEF_TYPE_IDS] = Stream.GetCurrentBitNo();
Douglas Gregor2cf26342009-04-09 22:27:44 +00001396 }
1397
1398 RecordData Record;
Mike Stump1eb44332009-09-09 15:08:12 +00001399
Douglas Gregor2cf26342009-04-09 22:27:44 +00001400 // Emit the type's representation.
1401 PCHTypeWriter W(*this, Record);
John McCall0953e762009-09-24 19:53:00 +00001402
Douglas Gregora4923eb2009-11-16 21:35:15 +00001403 if (T.hasLocalNonFastQualifiers()) {
1404 Qualifiers Qs = T.getLocalQualifiers();
1405 AddTypeRef(T.getLocalUnqualifiedType(), Record);
John McCall0953e762009-09-24 19:53:00 +00001406 Record.push_back(Qs.getAsOpaqueValue());
1407 W.Code = pch::TYPE_EXT_QUAL;
1408 } else {
1409 switch (T->getTypeClass()) {
1410 // For all of the concrete, non-dependent types, call the
1411 // appropriate visitor function.
Douglas Gregor2cf26342009-04-09 22:27:44 +00001412#define TYPE(Class, Base) \
Mike Stumpb7166332010-01-20 02:03:14 +00001413 case Type::Class: W.Visit##Class##Type(cast<Class##Type>(T)); break;
Douglas Gregor2cf26342009-04-09 22:27:44 +00001414#define ABSTRACT_TYPE(Class, Base)
Douglas Gregor2cf26342009-04-09 22:27:44 +00001415#include "clang/AST/TypeNodes.def"
John McCall0953e762009-09-24 19:53:00 +00001416 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00001417 }
1418
1419 // Emit the serialized record.
Douglas Gregorc9490c02009-04-16 22:23:12 +00001420 Stream.EmitRecord(W.Code, Record);
Douglas Gregor0b748912009-04-14 21:18:50 +00001421
1422 // Flush any expressions that were written as part of this type.
Douglas Gregorc9490c02009-04-16 22:23:12 +00001423 FlushStmts();
Douglas Gregor2cf26342009-04-09 22:27:44 +00001424}
1425
Douglas Gregor4fed3f42009-04-27 18:38:38 +00001426//===----------------------------------------------------------------------===//
1427// Declaration Serialization
1428//===----------------------------------------------------------------------===//
1429
Douglas Gregor2cf26342009-04-09 22:27:44 +00001430/// \brief Write the block containing all of the declaration IDs
1431/// lexically declared within the given DeclContext.
1432///
1433/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
1434/// bistream, or 0 if no block was written.
Mike Stump1eb44332009-09-09 15:08:12 +00001435uint64_t PCHWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
Douglas Gregor2cf26342009-04-09 22:27:44 +00001436 DeclContext *DC) {
Argyrios Kyrtzidis17945a02009-06-30 02:36:12 +00001437 if (DC->decls_empty())
Douglas Gregor2cf26342009-04-09 22:27:44 +00001438 return 0;
1439
Douglas Gregorc9490c02009-04-16 22:23:12 +00001440 uint64_t Offset = Stream.GetCurrentBitNo();
Douglas Gregor2cf26342009-04-09 22:27:44 +00001441 RecordData Record;
Argyrios Kyrtzidis17945a02009-06-30 02:36:12 +00001442 for (DeclContext::decl_iterator D = DC->decls_begin(), DEnd = DC->decls_end();
1443 D != DEnd; ++D)
Douglas Gregor2cf26342009-04-09 22:27:44 +00001444 AddDeclRef(*D, Record);
1445
Douglas Gregor25123082009-04-22 22:34:57 +00001446 ++NumLexicalDeclContexts;
Douglas Gregorc9490c02009-04-16 22:23:12 +00001447 Stream.EmitRecord(pch::DECL_CONTEXT_LEXICAL, Record);
Douglas Gregor2cf26342009-04-09 22:27:44 +00001448 return Offset;
1449}
1450
1451/// \brief Write the block containing all of the declaration IDs
1452/// visible from the given DeclContext.
1453///
1454/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
1455/// bistream, or 0 if no block was written.
1456uint64_t PCHWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
1457 DeclContext *DC) {
1458 if (DC->getPrimaryContext() != DC)
1459 return 0;
1460
Argyrios Kyrtzidis67643342010-06-29 22:47:00 +00001461 // Since there is no name lookup into functions or methods, don't bother to
1462 // build a visible-declarations table for these entities.
1463 if (DC->isFunctionOrMethod())
1464 return 0;
1465
1466 // If not in C++, we perform name lookup for the translation unit via the
1467 // IdentifierInfo chains, don't bother to build a visible-declarations table.
1468 // FIXME: In C++ we need the visible declarations in order to "see" the
1469 // friend declarations, is there a way to do this without writing the table ?
1470 if (DC->isTranslationUnit() && !Context.getLangOptions().CPlusPlus)
Douglas Gregor58f06992009-04-18 15:49:20 +00001471 return 0;
1472
Douglas Gregor2cf26342009-04-09 22:27:44 +00001473 // Force the DeclContext to build a its name-lookup table.
Argyrios Kyrtzidis17945a02009-06-30 02:36:12 +00001474 DC->lookup(DeclarationName());
Douglas Gregor2cf26342009-04-09 22:27:44 +00001475
1476 // Serialize the contents of the mapping used for lookup. Note that,
1477 // although we have two very different code paths, the serialized
1478 // representation is the same for both cases: a declaration name,
1479 // followed by a size, followed by references to the visible
1480 // declarations that have that name.
Douglas Gregorc9490c02009-04-16 22:23:12 +00001481 uint64_t Offset = Stream.GetCurrentBitNo();
Douglas Gregor2cf26342009-04-09 22:27:44 +00001482 RecordData Record;
1483 StoredDeclsMap *Map = static_cast<StoredDeclsMap*>(DC->getLookupPtr());
Douglas Gregor8c700062009-04-13 21:20:57 +00001484 if (!Map)
1485 return 0;
1486
Douglas Gregor2cf26342009-04-09 22:27:44 +00001487 for (StoredDeclsMap::iterator D = Map->begin(), DEnd = Map->end();
1488 D != DEnd; ++D) {
1489 AddDeclarationName(D->first, Record);
1490 DeclContext::lookup_result Result = D->second.getLookupResult(Context);
1491 Record.push_back(Result.second - Result.first);
Mike Stump1eb44332009-09-09 15:08:12 +00001492 for (; Result.first != Result.second; ++Result.first)
Douglas Gregor2cf26342009-04-09 22:27:44 +00001493 AddDeclRef(*Result.first, Record);
1494 }
1495
1496 if (Record.size() == 0)
1497 return 0;
1498
Douglas Gregorc9490c02009-04-16 22:23:12 +00001499 Stream.EmitRecord(pch::DECL_CONTEXT_VISIBLE, Record);
Douglas Gregor25123082009-04-22 22:34:57 +00001500 ++NumVisibleDeclContexts;
Douglas Gregor2cf26342009-04-09 22:27:44 +00001501 return Offset;
1502}
1503
Sebastian Redl1476ed42010-07-16 16:36:56 +00001504void PCHWriter::WriteTypeDeclOffsets() {
1505 using namespace llvm;
1506 RecordData Record;
1507
1508 // Write the type offsets array
1509 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1510 Abbrev->Add(BitCodeAbbrevOp(pch::TYPE_OFFSET));
1511 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
1512 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
1513 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1514 Record.clear();
1515 Record.push_back(pch::TYPE_OFFSET);
1516 Record.push_back(TypeOffsets.size());
1517 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record,
1518 (const char *)&TypeOffsets.front(),
1519 TypeOffsets.size() * sizeof(TypeOffsets[0]));
1520
1521 // Write the declaration offsets array
1522 Abbrev = new BitCodeAbbrev();
1523 Abbrev->Add(BitCodeAbbrevOp(pch::DECL_OFFSET));
1524 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
1525 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
1526 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1527 Record.clear();
1528 Record.push_back(pch::DECL_OFFSET);
1529 Record.push_back(DeclOffsets.size());
1530 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record,
1531 (const char *)&DeclOffsets.front(),
1532 DeclOffsets.size() * sizeof(DeclOffsets[0]));
1533}
1534
Douglas Gregor4fed3f42009-04-27 18:38:38 +00001535//===----------------------------------------------------------------------===//
1536// Global Method Pool and Selector Serialization
1537//===----------------------------------------------------------------------===//
1538
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001539namespace {
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001540// Trait used for the on-disk hash table used in the method pool.
Benjamin Kramerbd218282009-11-28 10:07:24 +00001541class PCHMethodPoolTrait {
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001542 PCHWriter &Writer;
1543
1544public:
1545 typedef Selector key_type;
1546 typedef key_type key_type_ref;
Mike Stump1eb44332009-09-09 15:08:12 +00001547
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001548 typedef std::pair<ObjCMethodList, ObjCMethodList> data_type;
1549 typedef const data_type& data_type_ref;
1550
1551 explicit PCHMethodPoolTrait(PCHWriter &Writer) : Writer(Writer) { }
Mike Stump1eb44332009-09-09 15:08:12 +00001552
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001553 static unsigned ComputeHash(Selector Sel) {
1554 unsigned N = Sel.getNumArgs();
1555 if (N == 0)
1556 ++N;
1557 unsigned R = 5381;
1558 for (unsigned I = 0; I != N; ++I)
1559 if (IdentifierInfo *II = Sel.getIdentifierInfoForSlot(I))
Daniel Dunbar2596e422009-10-17 23:52:28 +00001560 R = llvm::HashString(II->getName(), R);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001561 return R;
1562 }
Mike Stump1eb44332009-09-09 15:08:12 +00001563
1564 std::pair<unsigned,unsigned>
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001565 EmitKeyDataLength(llvm::raw_ostream& Out, Selector Sel,
1566 data_type_ref Methods) {
1567 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
1568 clang::io::Emit16(Out, KeyLen);
1569 unsigned DataLen = 2 + 2; // 2 bytes for each of the method counts
Mike Stump1eb44332009-09-09 15:08:12 +00001570 for (const ObjCMethodList *Method = &Methods.first; Method;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001571 Method = Method->Next)
1572 if (Method->Method)
1573 DataLen += 4;
Mike Stump1eb44332009-09-09 15:08:12 +00001574 for (const ObjCMethodList *Method = &Methods.second; Method;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001575 Method = Method->Next)
1576 if (Method->Method)
1577 DataLen += 4;
1578 clang::io::Emit16(Out, DataLen);
1579 return std::make_pair(KeyLen, DataLen);
1580 }
Mike Stump1eb44332009-09-09 15:08:12 +00001581
Douglas Gregor83941df2009-04-25 17:48:32 +00001582 void EmitKey(llvm::raw_ostream& Out, Selector Sel, unsigned) {
Mike Stump1eb44332009-09-09 15:08:12 +00001583 uint64_t Start = Out.tell();
Douglas Gregor83941df2009-04-25 17:48:32 +00001584 assert((Start >> 32) == 0 && "Selector key offset too large");
1585 Writer.SetSelectorOffset(Sel, Start);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001586 unsigned N = Sel.getNumArgs();
1587 clang::io::Emit16(Out, N);
1588 if (N == 0)
1589 N = 1;
1590 for (unsigned I = 0; I != N; ++I)
Mike Stump1eb44332009-09-09 15:08:12 +00001591 clang::io::Emit32(Out,
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001592 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
1593 }
Mike Stump1eb44332009-09-09 15:08:12 +00001594
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001595 void EmitData(llvm::raw_ostream& Out, key_type_ref,
Douglas Gregora67e58c2009-04-24 21:49:02 +00001596 data_type_ref Methods, unsigned DataLen) {
1597 uint64_t Start = Out.tell(); (void)Start;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001598 unsigned NumInstanceMethods = 0;
Mike Stump1eb44332009-09-09 15:08:12 +00001599 for (const ObjCMethodList *Method = &Methods.first; Method;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001600 Method = Method->Next)
1601 if (Method->Method)
1602 ++NumInstanceMethods;
1603
1604 unsigned NumFactoryMethods = 0;
Mike Stump1eb44332009-09-09 15:08:12 +00001605 for (const ObjCMethodList *Method = &Methods.second; Method;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001606 Method = Method->Next)
1607 if (Method->Method)
1608 ++NumFactoryMethods;
1609
1610 clang::io::Emit16(Out, NumInstanceMethods);
1611 clang::io::Emit16(Out, NumFactoryMethods);
Mike Stump1eb44332009-09-09 15:08:12 +00001612 for (const ObjCMethodList *Method = &Methods.first; Method;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001613 Method = Method->Next)
1614 if (Method->Method)
1615 clang::io::Emit32(Out, Writer.getDeclID(Method->Method));
Mike Stump1eb44332009-09-09 15:08:12 +00001616 for (const ObjCMethodList *Method = &Methods.second; Method;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001617 Method = Method->Next)
1618 if (Method->Method)
1619 clang::io::Emit32(Out, Writer.getDeclID(Method->Method));
Douglas Gregora67e58c2009-04-24 21:49:02 +00001620
1621 assert(Out.tell() - Start == DataLen && "Data length is wrong");
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001622 }
1623};
1624} // end anonymous namespace
1625
1626/// \brief Write the method pool into the PCH file.
1627///
1628/// The method pool contains both instance and factory methods, stored
1629/// in an on-disk hash table indexed by the selector.
1630void PCHWriter::WriteMethodPool(Sema &SemaRef) {
1631 using namespace llvm;
1632
1633 // Create and write out the blob that contains the instance and
1634 // factor method pools.
1635 bool Empty = true;
1636 {
1637 OnDiskChainedHashTableGenerator<PCHMethodPoolTrait> Generator;
Mike Stump1eb44332009-09-09 15:08:12 +00001638
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001639 // Create the on-disk hash table representation. Start by
1640 // iterating through the instance method pool.
1641 PCHMethodPoolTrait::key_type Key;
Douglas Gregor83941df2009-04-25 17:48:32 +00001642 unsigned NumSelectorsInMethodPool = 0;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001643 for (llvm::DenseMap<Selector, ObjCMethodList>::iterator
Mike Stump1eb44332009-09-09 15:08:12 +00001644 Instance = SemaRef.InstanceMethodPool.begin(),
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001645 InstanceEnd = SemaRef.InstanceMethodPool.end();
1646 Instance != InstanceEnd; ++Instance) {
1647 // Check whether there is a factory method with the same
1648 // selector.
1649 llvm::DenseMap<Selector, ObjCMethodList>::iterator Factory
1650 = SemaRef.FactoryMethodPool.find(Instance->first);
1651
1652 if (Factory == SemaRef.FactoryMethodPool.end())
1653 Generator.insert(Instance->first,
Mike Stump1eb44332009-09-09 15:08:12 +00001654 std::make_pair(Instance->second,
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001655 ObjCMethodList()));
1656 else
1657 Generator.insert(Instance->first,
1658 std::make_pair(Instance->second, Factory->second));
1659
Douglas Gregor83941df2009-04-25 17:48:32 +00001660 ++NumSelectorsInMethodPool;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001661 Empty = false;
1662 }
1663
1664 // Now iterate through the factory method pool, to pick up any
1665 // selectors that weren't already in the instance method pool.
1666 for (llvm::DenseMap<Selector, ObjCMethodList>::iterator
Mike Stump1eb44332009-09-09 15:08:12 +00001667 Factory = SemaRef.FactoryMethodPool.begin(),
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001668 FactoryEnd = SemaRef.FactoryMethodPool.end();
1669 Factory != FactoryEnd; ++Factory) {
1670 // Check whether there is an instance method with the same
1671 // selector. If so, there is no work to do here.
1672 llvm::DenseMap<Selector, ObjCMethodList>::iterator Instance
1673 = SemaRef.InstanceMethodPool.find(Factory->first);
1674
Douglas Gregor83941df2009-04-25 17:48:32 +00001675 if (Instance == SemaRef.InstanceMethodPool.end()) {
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001676 Generator.insert(Factory->first,
1677 std::make_pair(ObjCMethodList(), Factory->second));
Douglas Gregor83941df2009-04-25 17:48:32 +00001678 ++NumSelectorsInMethodPool;
1679 }
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001680
1681 Empty = false;
1682 }
1683
Douglas Gregor83941df2009-04-25 17:48:32 +00001684 if (Empty && SelectorOffsets.empty())
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001685 return;
1686
1687 // Create the on-disk hash table in a buffer.
Mike Stump1eb44332009-09-09 15:08:12 +00001688 llvm::SmallString<4096> MethodPool;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001689 uint32_t BucketOffset;
Douglas Gregor83941df2009-04-25 17:48:32 +00001690 SelectorOffsets.resize(SelVector.size());
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001691 {
1692 PCHMethodPoolTrait Trait(*this);
1693 llvm::raw_svector_ostream Out(MethodPool);
1694 // Make sure that no bucket is at offset 0
Douglas Gregora67e58c2009-04-24 21:49:02 +00001695 clang::io::Emit32(Out, 0);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001696 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor83941df2009-04-25 17:48:32 +00001697
1698 // For every selector that we have seen but which was not
1699 // written into the hash table, write the selector itself and
1700 // record it's offset.
1701 for (unsigned I = 0, N = SelVector.size(); I != N; ++I)
1702 if (SelectorOffsets[I] == 0)
1703 Trait.EmitKey(Out, SelVector[I], 0);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001704 }
1705
1706 // Create a blob abbreviation
1707 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1708 Abbrev->Add(BitCodeAbbrevOp(pch::METHOD_POOL));
1709 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor83941df2009-04-25 17:48:32 +00001710 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001711 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1712 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(Abbrev);
1713
Douglas Gregor83941df2009-04-25 17:48:32 +00001714 // Write the method pool
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001715 RecordData Record;
1716 Record.push_back(pch::METHOD_POOL);
1717 Record.push_back(BucketOffset);
Douglas Gregor83941df2009-04-25 17:48:32 +00001718 Record.push_back(NumSelectorsInMethodPool);
Daniel Dunbarec312a12009-08-24 09:31:37 +00001719 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool.str());
Douglas Gregor83941df2009-04-25 17:48:32 +00001720
1721 // Create a blob abbreviation for the selector table offsets.
1722 Abbrev = new BitCodeAbbrev();
1723 Abbrev->Add(BitCodeAbbrevOp(pch::SELECTOR_OFFSETS));
1724 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // index
1725 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1726 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1727
1728 // Write the selector offsets table.
1729 Record.clear();
1730 Record.push_back(pch::SELECTOR_OFFSETS);
1731 Record.push_back(SelectorOffsets.size());
1732 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
1733 (const char *)&SelectorOffsets.front(),
1734 SelectorOffsets.size() * 4);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001735 }
1736}
1737
Douglas Gregor4fed3f42009-04-27 18:38:38 +00001738//===----------------------------------------------------------------------===//
1739// Identifier Table Serialization
1740//===----------------------------------------------------------------------===//
1741
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001742namespace {
Benjamin Kramerbd218282009-11-28 10:07:24 +00001743class PCHIdentifierTableTrait {
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001744 PCHWriter &Writer;
Douglas Gregor37e26842009-04-21 23:56:24 +00001745 Preprocessor &PP;
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001746
Douglas Gregora92193e2009-04-28 21:18:29 +00001747 /// \brief Determines whether this is an "interesting" identifier
1748 /// that needs a full IdentifierInfo structure written into the hash
1749 /// table.
1750 static bool isInterestingIdentifier(const IdentifierInfo *II) {
1751 return II->isPoisoned() ||
1752 II->isExtensionToken() ||
1753 II->hasMacroDefinition() ||
1754 II->getObjCOrBuiltinID() ||
1755 II->getFETokenInfo<void>();
1756 }
1757
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001758public:
1759 typedef const IdentifierInfo* key_type;
1760 typedef key_type key_type_ref;
Mike Stump1eb44332009-09-09 15:08:12 +00001761
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001762 typedef pch::IdentID data_type;
1763 typedef data_type data_type_ref;
Mike Stump1eb44332009-09-09 15:08:12 +00001764
1765 PCHIdentifierTableTrait(PCHWriter &Writer, Preprocessor &PP)
Douglas Gregor37e26842009-04-21 23:56:24 +00001766 : Writer(Writer), PP(PP) { }
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001767
1768 static unsigned ComputeHash(const IdentifierInfo* II) {
Daniel Dunbar2596e422009-10-17 23:52:28 +00001769 return llvm::HashString(II->getName());
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001770 }
Mike Stump1eb44332009-09-09 15:08:12 +00001771
1772 std::pair<unsigned,unsigned>
1773 EmitKeyDataLength(llvm::raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001774 pch::IdentID ID) {
Daniel Dunbare013d682009-10-18 20:26:12 +00001775 unsigned KeyLen = II->getLength() + 1;
Douglas Gregora92193e2009-04-28 21:18:29 +00001776 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
1777 if (isInterestingIdentifier(II)) {
Douglas Gregor5998da52009-04-28 21:32:13 +00001778 DataLen += 2; // 2 bytes for builtin ID, flags
Mike Stump1eb44332009-09-09 15:08:12 +00001779 if (II->hasMacroDefinition() &&
Douglas Gregora92193e2009-04-28 21:18:29 +00001780 !PP.getMacroInfo(const_cast<IdentifierInfo *>(II))->isBuiltinMacro())
Douglas Gregor5998da52009-04-28 21:32:13 +00001781 DataLen += 4;
Douglas Gregora92193e2009-04-28 21:18:29 +00001782 for (IdentifierResolver::iterator D = IdentifierResolver::begin(II),
1783 DEnd = IdentifierResolver::end();
1784 D != DEnd; ++D)
1785 DataLen += sizeof(pch::DeclID);
1786 }
Douglas Gregor668c1a42009-04-21 22:25:48 +00001787 clang::io::Emit16(Out, DataLen);
Douglas Gregor02fc7512009-04-28 20:01:51 +00001788 // We emit the key length after the data length so that every
1789 // string is preceded by a 16-bit length. This matches the PTH
1790 // format for storing identifiers.
Douglas Gregord6595a42009-04-25 21:04:17 +00001791 clang::io::Emit16(Out, KeyLen);
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001792 return std::make_pair(KeyLen, DataLen);
1793 }
Mike Stump1eb44332009-09-09 15:08:12 +00001794
1795 void EmitKey(llvm::raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001796 unsigned KeyLen) {
1797 // Record the location of the key data. This is used when generating
1798 // the mapping from persistent IDs to strings.
1799 Writer.SetIdentifierOffset(II, Out.tell());
Daniel Dunbare013d682009-10-18 20:26:12 +00001800 Out.write(II->getNameStart(), KeyLen);
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001801 }
Mike Stump1eb44332009-09-09 15:08:12 +00001802
1803 void EmitData(llvm::raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001804 pch::IdentID ID, unsigned) {
Douglas Gregora92193e2009-04-28 21:18:29 +00001805 if (!isInterestingIdentifier(II)) {
1806 clang::io::Emit32(Out, ID << 1);
1807 return;
1808 }
Douglas Gregor5998da52009-04-28 21:32:13 +00001809
Douglas Gregora92193e2009-04-28 21:18:29 +00001810 clang::io::Emit32(Out, (ID << 1) | 0x01);
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001811 uint32_t Bits = 0;
Mike Stump1eb44332009-09-09 15:08:12 +00001812 bool hasMacroDefinition =
1813 II->hasMacroDefinition() &&
Douglas Gregor37e26842009-04-21 23:56:24 +00001814 !PP.getMacroInfo(const_cast<IdentifierInfo *>(II))->isBuiltinMacro();
Douglas Gregor5998da52009-04-28 21:32:13 +00001815 Bits = (uint32_t)II->getObjCOrBuiltinID();
Daniel Dunbarb0b84382009-12-18 20:58:47 +00001816 Bits = (Bits << 1) | unsigned(hasMacroDefinition);
1817 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
1818 Bits = (Bits << 1) | unsigned(II->isPoisoned());
1819 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
Douglas Gregor5998da52009-04-28 21:32:13 +00001820 clang::io::Emit16(Out, Bits);
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001821
Douglas Gregor37e26842009-04-21 23:56:24 +00001822 if (hasMacroDefinition)
Douglas Gregor5998da52009-04-28 21:32:13 +00001823 clang::io::Emit32(Out, Writer.getMacroOffset(II));
Douglas Gregor37e26842009-04-21 23:56:24 +00001824
Douglas Gregor668c1a42009-04-21 22:25:48 +00001825 // Emit the declaration IDs in reverse order, because the
1826 // IdentifierResolver provides the declarations as they would be
1827 // visible (e.g., the function "stat" would come before the struct
1828 // "stat"), but IdentifierResolver::AddDeclToIdentifierChain()
1829 // adds declarations to the end of the list (so we need to see the
1830 // struct "status" before the function "status").
Mike Stump1eb44332009-09-09 15:08:12 +00001831 llvm::SmallVector<Decl *, 16> Decls(IdentifierResolver::begin(II),
Douglas Gregor668c1a42009-04-21 22:25:48 +00001832 IdentifierResolver::end());
1833 for (llvm::SmallVector<Decl *, 16>::reverse_iterator D = Decls.rbegin(),
1834 DEnd = Decls.rend();
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001835 D != DEnd; ++D)
Douglas Gregor668c1a42009-04-21 22:25:48 +00001836 clang::io::Emit32(Out, Writer.getDeclID(*D));
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001837 }
1838};
1839} // end anonymous namespace
1840
Douglas Gregorafaf3082009-04-11 00:14:32 +00001841/// \brief Write the identifier table into the PCH file.
1842///
1843/// The identifier table consists of a blob containing string data
1844/// (the actual identifiers themselves) and a separate "offsets" index
1845/// that maps identifier IDs to locations within the blob.
Douglas Gregor37e26842009-04-21 23:56:24 +00001846void PCHWriter::WriteIdentifierTable(Preprocessor &PP) {
Douglas Gregorafaf3082009-04-11 00:14:32 +00001847 using namespace llvm;
1848
1849 // Create and write out the blob that contains the identifier
1850 // strings.
Douglas Gregorafaf3082009-04-11 00:14:32 +00001851 {
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001852 OnDiskChainedHashTableGenerator<PCHIdentifierTableTrait> Generator;
Mike Stump1eb44332009-09-09 15:08:12 +00001853
Douglas Gregor92b059e2009-04-28 20:33:11 +00001854 // Look for any identifiers that were named while processing the
1855 // headers, but are otherwise not needed. We add these to the hash
1856 // table to enable checking of the predefines buffer in the case
1857 // where the user adds new macro definitions when building the PCH
1858 // file.
1859 for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
1860 IDEnd = PP.getIdentifierTable().end();
1861 ID != IDEnd; ++ID)
1862 getIdentifierRef(ID->second);
1863
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001864 // Create the on-disk hash table representation.
Douglas Gregor92b059e2009-04-28 20:33:11 +00001865 IdentifierOffsets.resize(IdentifierIDs.size());
Douglas Gregorafaf3082009-04-11 00:14:32 +00001866 for (llvm::DenseMap<const IdentifierInfo *, pch::IdentID>::iterator
1867 ID = IdentifierIDs.begin(), IDEnd = IdentifierIDs.end();
1868 ID != IDEnd; ++ID) {
1869 assert(ID->first && "NULL identifier in identifier table");
Douglas Gregor02fc7512009-04-28 20:01:51 +00001870 Generator.insert(ID->first, ID->second);
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001871 }
Douglas Gregorafaf3082009-04-11 00:14:32 +00001872
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001873 // Create the on-disk hash table in a buffer.
Mike Stump1eb44332009-09-09 15:08:12 +00001874 llvm::SmallString<4096> IdentifierTable;
Douglas Gregor668c1a42009-04-21 22:25:48 +00001875 uint32_t BucketOffset;
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001876 {
Douglas Gregor37e26842009-04-21 23:56:24 +00001877 PCHIdentifierTableTrait Trait(*this, PP);
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001878 llvm::raw_svector_ostream Out(IdentifierTable);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001879 // Make sure that no bucket is at offset 0
Douglas Gregora67e58c2009-04-24 21:49:02 +00001880 clang::io::Emit32(Out, 0);
Douglas Gregor668c1a42009-04-21 22:25:48 +00001881 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregorafaf3082009-04-11 00:14:32 +00001882 }
1883
1884 // Create a blob abbreviation
1885 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1886 Abbrev->Add(BitCodeAbbrevOp(pch::IDENTIFIER_TABLE));
Douglas Gregor668c1a42009-04-21 22:25:48 +00001887 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001888 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Douglas Gregorc9490c02009-04-16 22:23:12 +00001889 unsigned IDTableAbbrev = Stream.EmitAbbrev(Abbrev);
Douglas Gregorafaf3082009-04-11 00:14:32 +00001890
1891 // Write the identifier table
1892 RecordData Record;
1893 Record.push_back(pch::IDENTIFIER_TABLE);
Douglas Gregor668c1a42009-04-21 22:25:48 +00001894 Record.push_back(BucketOffset);
Daniel Dunbarec312a12009-08-24 09:31:37 +00001895 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable.str());
Douglas Gregorafaf3082009-04-11 00:14:32 +00001896 }
1897
1898 // Write the offsets table for identifier IDs.
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00001899 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1900 Abbrev->Add(BitCodeAbbrevOp(pch::IDENTIFIER_OFFSET));
1901 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
1902 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1903 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1904
1905 RecordData Record;
1906 Record.push_back(pch::IDENTIFIER_OFFSET);
1907 Record.push_back(IdentifierOffsets.size());
1908 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
1909 (const char *)&IdentifierOffsets.front(),
1910 IdentifierOffsets.size() * sizeof(uint32_t));
Douglas Gregorafaf3082009-04-11 00:14:32 +00001911}
1912
Douglas Gregor4fed3f42009-04-27 18:38:38 +00001913//===----------------------------------------------------------------------===//
1914// General Serialization Routines
1915//===----------------------------------------------------------------------===//
1916
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001917/// \brief Write a record containing the given attributes.
1918void PCHWriter::WriteAttributeRecord(const Attr *Attr) {
1919 RecordData Record;
1920 for (; Attr; Attr = Attr->getNext()) {
Anton Korobeynikov82d0a412010-01-10 12:58:08 +00001921 Record.push_back(Attr->getKind()); // FIXME: stable encoding, target attrs
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001922 Record.push_back(Attr->isInherited());
1923 switch (Attr->getKind()) {
Anton Korobeynikov82d0a412010-01-10 12:58:08 +00001924 default:
1925 assert(0 && "Does not support PCH writing for this attribute yet!");
1926 break;
Sean Hunt387475d2010-06-16 23:43:53 +00001927 case attr::Alias:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001928 AddString(cast<AliasAttr>(Attr)->getAliasee(), Record);
1929 break;
1930
Sean Hunt387475d2010-06-16 23:43:53 +00001931 case attr::AlignMac68k:
Daniel Dunbar4e9255f2010-05-27 02:25:39 +00001932 break;
1933
Sean Hunt387475d2010-06-16 23:43:53 +00001934 case attr::Aligned:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001935 Record.push_back(cast<AlignedAttr>(Attr)->getAlignment());
1936 break;
1937
Sean Hunt387475d2010-06-16 23:43:53 +00001938 case attr::AlwaysInline:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001939 break;
Mike Stump1eb44332009-09-09 15:08:12 +00001940
Sean Hunt387475d2010-06-16 23:43:53 +00001941 case attr::AnalyzerNoReturn:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001942 break;
1943
Sean Hunt387475d2010-06-16 23:43:53 +00001944 case attr::Annotate:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001945 AddString(cast<AnnotateAttr>(Attr)->getAnnotation(), Record);
1946 break;
1947
Sean Hunt387475d2010-06-16 23:43:53 +00001948 case attr::AsmLabel:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001949 AddString(cast<AsmLabelAttr>(Attr)->getLabel(), Record);
1950 break;
1951
Sean Hunt387475d2010-06-16 23:43:53 +00001952 case attr::BaseCheck:
Sean Hunt7725e672009-11-25 04:20:27 +00001953 break;
1954
Sean Hunt387475d2010-06-16 23:43:53 +00001955 case attr::Blocks:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001956 Record.push_back(cast<BlocksAttr>(Attr)->getType()); // FIXME: stable
1957 break;
1958
Sean Hunt387475d2010-06-16 23:43:53 +00001959 case attr::CDecl:
Eli Friedman8f4c59e2009-11-09 18:38:53 +00001960 break;
1961
Sean Hunt387475d2010-06-16 23:43:53 +00001962 case attr::Cleanup:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001963 AddDeclRef(cast<CleanupAttr>(Attr)->getFunctionDecl(), Record);
1964 break;
1965
Sean Hunt387475d2010-06-16 23:43:53 +00001966 case attr::Const:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001967 break;
1968
Sean Hunt387475d2010-06-16 23:43:53 +00001969 case attr::Constructor:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001970 Record.push_back(cast<ConstructorAttr>(Attr)->getPriority());
1971 break;
1972
Sean Hunt387475d2010-06-16 23:43:53 +00001973 case attr::DLLExport:
1974 case attr::DLLImport:
1975 case attr::Deprecated:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001976 break;
1977
Sean Hunt387475d2010-06-16 23:43:53 +00001978 case attr::Destructor:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001979 Record.push_back(cast<DestructorAttr>(Attr)->getPriority());
1980 break;
1981
Sean Hunt387475d2010-06-16 23:43:53 +00001982 case attr::FastCall:
1983 case attr::Final:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001984 break;
1985
Sean Hunt387475d2010-06-16 23:43:53 +00001986 case attr::Format: {
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001987 const FormatAttr *Format = cast<FormatAttr>(Attr);
1988 AddString(Format->getType(), Record);
1989 Record.push_back(Format->getFormatIdx());
1990 Record.push_back(Format->getFirstArg());
1991 break;
1992 }
1993
Sean Hunt387475d2010-06-16 23:43:53 +00001994 case attr::FormatArg: {
Fariborz Jahanian5b160922009-05-20 17:41:43 +00001995 const FormatArgAttr *Format = cast<FormatArgAttr>(Attr);
1996 Record.push_back(Format->getFormatIdx());
1997 break;
1998 }
1999
Sean Hunt387475d2010-06-16 23:43:53 +00002000 case attr::Sentinel : {
Fariborz Jahanian5b530052009-05-13 18:09:35 +00002001 const SentinelAttr *Sentinel = cast<SentinelAttr>(Attr);
2002 Record.push_back(Sentinel->getSentinel());
2003 Record.push_back(Sentinel->getNullPos());
2004 break;
2005 }
Mike Stump1eb44332009-09-09 15:08:12 +00002006
Sean Hunt387475d2010-06-16 23:43:53 +00002007 case attr::GNUInline:
2008 case attr::Hiding:
2009 case attr::IBAction:
2010 case attr::IBOutlet:
2011 case attr::Malloc:
2012 case attr::NoDebug:
2013 case attr::NoInline:
2014 case attr::NoReturn:
2015 case attr::NoThrow:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002016 break;
2017
Sean Hunt387475d2010-06-16 23:43:53 +00002018 case attr::IBOutletCollection: {
Ted Kremenek857e9182010-05-19 17:38:06 +00002019 const IBOutletCollectionAttr *ICA = cast<IBOutletCollectionAttr>(Attr);
2020 AddDeclRef(ICA->getClass(), Record);
2021 break;
2022 }
2023
Sean Hunt387475d2010-06-16 23:43:53 +00002024 case attr::NonNull: {
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002025 const NonNullAttr *NonNull = cast<NonNullAttr>(Attr);
2026 Record.push_back(NonNull->size());
2027 Record.insert(Record.end(), NonNull->begin(), NonNull->end());
2028 break;
2029 }
2030
Sean Hunt387475d2010-06-16 23:43:53 +00002031 case attr::CFReturnsNotRetained:
2032 case attr::CFReturnsRetained:
2033 case attr::NSReturnsNotRetained:
2034 case attr::NSReturnsRetained:
2035 case attr::ObjCException:
2036 case attr::ObjCNSObject:
2037 case attr::Overloadable:
2038 case attr::Override:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002039 break;
2040
Sean Hunt387475d2010-06-16 23:43:53 +00002041 case attr::MaxFieldAlignment:
Daniel Dunbar8a2c92c2010-05-27 01:12:46 +00002042 Record.push_back(cast<MaxFieldAlignmentAttr>(Attr)->getAlignment());
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002043 break;
2044
Sean Hunt387475d2010-06-16 23:43:53 +00002045 case attr::Packed:
Anders Carlssona860e752009-08-08 18:23:56 +00002046 break;
Mike Stump1eb44332009-09-09 15:08:12 +00002047
Sean Hunt387475d2010-06-16 23:43:53 +00002048 case attr::Pure:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002049 break;
2050
Sean Hunt387475d2010-06-16 23:43:53 +00002051 case attr::Regparm:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002052 Record.push_back(cast<RegparmAttr>(Attr)->getNumParams());
2053 break;
Mike Stump1eb44332009-09-09 15:08:12 +00002054
Sean Hunt387475d2010-06-16 23:43:53 +00002055 case attr::ReqdWorkGroupSize:
Nate Begeman6f3d8382009-06-26 06:32:41 +00002056 Record.push_back(cast<ReqdWorkGroupSizeAttr>(Attr)->getXDim());
2057 Record.push_back(cast<ReqdWorkGroupSizeAttr>(Attr)->getYDim());
2058 Record.push_back(cast<ReqdWorkGroupSizeAttr>(Attr)->getZDim());
2059 break;
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002060
Sean Hunt387475d2010-06-16 23:43:53 +00002061 case attr::Section:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002062 AddString(cast<SectionAttr>(Attr)->getName(), Record);
2063 break;
2064
Sean Hunt387475d2010-06-16 23:43:53 +00002065 case attr::StdCall:
2066 case attr::TransparentUnion:
2067 case attr::Unavailable:
2068 case attr::Unused:
2069 case attr::Used:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002070 break;
2071
Sean Hunt387475d2010-06-16 23:43:53 +00002072 case attr::Visibility:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002073 // FIXME: stable encoding
Mike Stump1eb44332009-09-09 15:08:12 +00002074 Record.push_back(cast<VisibilityAttr>(Attr)->getVisibility());
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002075 break;
2076
Sean Hunt387475d2010-06-16 23:43:53 +00002077 case attr::WarnUnusedResult:
2078 case attr::Weak:
2079 case attr::WeakRef:
2080 case attr::WeakImport:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002081 break;
2082 }
2083 }
2084
Douglas Gregorc9490c02009-04-16 22:23:12 +00002085 Stream.EmitRecord(pch::DECL_ATTR, Record);
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002086}
2087
2088void PCHWriter::AddString(const std::string &Str, RecordData &Record) {
2089 Record.push_back(Str.size());
2090 Record.insert(Record.end(), Str.begin(), Str.end());
2091}
2092
Douglas Gregor3251ceb2009-04-20 20:36:09 +00002093/// \brief Note that the identifier II occurs at the given offset
2094/// within the identifier table.
2095void PCHWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00002096 IdentifierOffsets[IdentifierIDs[II] - 1] = Offset;
Douglas Gregor3251ceb2009-04-20 20:36:09 +00002097}
2098
Douglas Gregor83941df2009-04-25 17:48:32 +00002099/// \brief Note that the selector Sel occurs at the given offset
2100/// within the method pool/selector table.
2101void PCHWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
2102 unsigned ID = SelectorIDs[Sel];
2103 assert(ID && "Unknown selector");
2104 SelectorOffsets[ID - 1] = Offset;
2105}
2106
Sebastian Redl30c514c2010-07-14 23:45:08 +00002107PCHWriter::PCHWriter(llvm::BitstreamWriter &Stream, PCHReader *Chain)
Sebastian Redl1476ed42010-07-16 16:36:56 +00002108 : Stream(Stream), Chain(Chain), FirstDeclID(1),
2109 FirstTypeID(pch::NUM_PREDEF_TYPE_IDS),
Argyrios Kyrtzidis919e6932010-06-28 22:28:35 +00002110 CollectedStmts(&StmtsToEmit), NumStatements(0), NumMacros(0),
Sebastian Redl30c514c2010-07-14 23:45:08 +00002111 NumLexicalDeclContexts(0), NumVisibleDeclContexts(0) {
Sebastian Redl1476ed42010-07-16 16:36:56 +00002112 if (Chain) {
Sebastian Redl30c514c2010-07-14 23:45:08 +00002113 Chain->setDeserializationListener(this);
Sebastian Redl1476ed42010-07-16 16:36:56 +00002114 FirstDeclID += Chain->getTotalNumDecls();
2115 FirstTypeID += Chain->getTotalNumTypes();
2116 }
2117 NextTypeID = FirstTypeID;
Sebastian Redl30c514c2010-07-14 23:45:08 +00002118}
Douglas Gregor2cf26342009-04-09 22:27:44 +00002119
Douglas Gregore650c8c2009-07-07 00:12:59 +00002120void PCHWriter::WritePCH(Sema &SemaRef, MemorizeStatCalls *StatCalls,
Sebastian Redl30c514c2010-07-14 23:45:08 +00002121 const char *isysroot) {
Douglas Gregor2cf26342009-04-09 22:27:44 +00002122 // Emit the file header.
Douglas Gregorc9490c02009-04-16 22:23:12 +00002123 Stream.Emit((unsigned)'C', 8);
2124 Stream.Emit((unsigned)'P', 8);
2125 Stream.Emit((unsigned)'C', 8);
2126 Stream.Emit((unsigned)'H', 8);
Mike Stump1eb44332009-09-09 15:08:12 +00002127
Chris Lattnerb145b1e2009-04-26 22:26:21 +00002128 WriteBlockInfoBlock();
Douglas Gregor2cf26342009-04-09 22:27:44 +00002129
Sebastian Redl1dc13a12010-07-12 22:02:52 +00002130 if (Chain)
Sebastian Redl30c514c2010-07-14 23:45:08 +00002131 WritePCHChain(SemaRef, StatCalls, isysroot);
Sebastian Redl1dc13a12010-07-12 22:02:52 +00002132 else
2133 WritePCHCore(SemaRef, StatCalls, isysroot);
2134}
2135
2136void PCHWriter::WritePCHCore(Sema &SemaRef, MemorizeStatCalls *StatCalls,
2137 const char *isysroot) {
2138 using namespace llvm;
2139
2140 ASTContext &Context = SemaRef.Context;
2141 Preprocessor &PP = SemaRef.PP;
2142
Douglas Gregor2cf26342009-04-09 22:27:44 +00002143 // The translation unit is the first declaration we'll emit.
2144 DeclIDs[Context.getTranslationUnitDecl()] = 1;
Douglas Gregor61d60ee2009-10-17 00:13:19 +00002145 DeclTypesToEmit.push(Context.getTranslationUnitDecl());
Douglas Gregor2cf26342009-04-09 22:27:44 +00002146
Douglas Gregor2deaea32009-04-22 18:49:13 +00002147 // Make sure that we emit IdentifierInfos (and any attached
2148 // declarations) for builtins.
2149 {
2150 IdentifierTable &Table = PP.getIdentifierTable();
2151 llvm::SmallVector<const char *, 32> BuiltinNames;
2152 Context.BuiltinInfo.GetBuiltinNames(BuiltinNames,
2153 Context.getLangOptions().NoBuiltin);
2154 for (unsigned I = 0, N = BuiltinNames.size(); I != N; ++I)
2155 getIdentifierRef(&Table.get(BuiltinNames[I]));
2156 }
2157
Chris Lattner63d65f82009-09-08 18:19:27 +00002158 // Build a record containing all of the tentative definitions in this file, in
Sebastian Redle9d12b62010-01-31 22:27:38 +00002159 // TentativeDefinitions order. Generally, this record will be empty for
Chris Lattner63d65f82009-09-08 18:19:27 +00002160 // headers.
Douglas Gregor4c0e86b2009-04-22 22:02:47 +00002161 RecordData TentativeDefinitions;
Sebastian Redle9d12b62010-01-31 22:27:38 +00002162 for (unsigned i = 0, e = SemaRef.TentativeDefinitions.size(); i != e; ++i) {
2163 AddDeclRef(SemaRef.TentativeDefinitions[i], TentativeDefinitions);
Chris Lattner63d65f82009-09-08 18:19:27 +00002164 }
Douglas Gregor4c0e86b2009-04-22 22:02:47 +00002165
Tanya Lattnere6bbc012010-02-12 00:07:30 +00002166 // Build a record containing all of the static unused functions in this file.
2167 RecordData UnusedStaticFuncs;
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00002168 for (unsigned i=0, e = SemaRef.UnusedStaticFuncs.size(); i !=e; ++i)
Tanya Lattnere6bbc012010-02-12 00:07:30 +00002169 AddDeclRef(SemaRef.UnusedStaticFuncs[i], UnusedStaticFuncs);
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00002170
Douglas Gregor14c22f22009-04-22 22:18:58 +00002171 // Build a record containing all of the locally-scoped external
2172 // declarations in this header file. Generally, this record will be
2173 // empty.
2174 RecordData LocallyScopedExternalDecls;
Chris Lattner63d65f82009-09-08 18:19:27 +00002175 // FIXME: This is filling in the PCH file in densemap order which is
2176 // nondeterminstic!
Mike Stump1eb44332009-09-09 15:08:12 +00002177 for (llvm::DenseMap<DeclarationName, NamedDecl *>::iterator
Douglas Gregor14c22f22009-04-22 22:18:58 +00002178 TD = SemaRef.LocallyScopedExternalDecls.begin(),
2179 TDEnd = SemaRef.LocallyScopedExternalDecls.end();
2180 TD != TDEnd; ++TD)
2181 AddDeclRef(TD->second, LocallyScopedExternalDecls);
2182
Douglas Gregorb81c1702009-04-27 20:06:05 +00002183 // Build a record containing all of the ext_vector declarations.
2184 RecordData ExtVectorDecls;
2185 for (unsigned I = 0, N = SemaRef.ExtVectorDecls.size(); I != N; ++I)
2186 AddDeclRef(SemaRef.ExtVectorDecls[I], ExtVectorDecls);
2187
Argyrios Kyrtzidisd455add2010-07-06 15:37:04 +00002188 // Build a record containing all of the VTable uses information.
2189 RecordData VTableUses;
2190 VTableUses.push_back(SemaRef.VTableUses.size());
2191 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
2192 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
2193 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
2194 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
2195 }
2196
2197 // Build a record containing all of dynamic classes declarations.
2198 RecordData DynamicClasses;
2199 for (unsigned I = 0, N = SemaRef.DynamicClasses.size(); I != N; ++I)
2200 AddDeclRef(SemaRef.DynamicClasses[I], DynamicClasses);
2201
Douglas Gregor2cf26342009-04-09 22:27:44 +00002202 // Write the remaining PCH contents.
Douglas Gregorad1de002009-04-18 05:55:16 +00002203 RecordData Record;
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00002204 Stream.EnterSubblock(pch::PCH_BLOCK_ID, 5);
Sebastian Redl30c514c2010-07-14 23:45:08 +00002205 WriteMetadata(Context, isysroot);
Sebastian Redl1dc13a12010-07-12 22:02:52 +00002206 WriteLanguageOptions(Context.getLangOptions());
Douglas Gregore650c8c2009-07-07 00:12:59 +00002207 if (StatCalls && !isysroot)
Douglas Gregordd41ed52010-07-12 23:48:14 +00002208 WriteStatCache(*StatCalls);
Douglas Gregore650c8c2009-07-07 00:12:59 +00002209 WriteSourceManagerBlock(Context.getSourceManager(), PP, isysroot);
Steve Naroffc15cb2a2009-07-18 15:33:26 +00002210 // Write the record of special types.
2211 Record.clear();
Mike Stump1eb44332009-09-09 15:08:12 +00002212
Steve Naroffc15cb2a2009-07-18 15:33:26 +00002213 AddTypeRef(Context.getBuiltinVaListType(), Record);
2214 AddTypeRef(Context.getObjCIdType(), Record);
2215 AddTypeRef(Context.getObjCSelType(), Record);
2216 AddTypeRef(Context.getObjCProtoType(), Record);
2217 AddTypeRef(Context.getObjCClassType(), Record);
2218 AddTypeRef(Context.getRawCFConstantStringType(), Record);
2219 AddTypeRef(Context.getRawObjCFastEnumerationStateType(), Record);
2220 AddTypeRef(Context.getFILEType(), Record);
Mike Stump782fa302009-07-28 02:25:19 +00002221 AddTypeRef(Context.getjmp_bufType(), Record);
2222 AddTypeRef(Context.getsigjmp_bufType(), Record);
Douglas Gregord1571ac2009-08-21 00:27:50 +00002223 AddTypeRef(Context.ObjCIdRedefinitionType, Record);
2224 AddTypeRef(Context.ObjCClassRedefinitionType, Record);
Mike Stumpadaaad32009-10-20 02:12:22 +00002225 AddTypeRef(Context.getRawBlockdescriptorType(), Record);
Mike Stump083c25e2009-10-22 00:49:09 +00002226 AddTypeRef(Context.getRawBlockdescriptorExtendedType(), Record);
Fariborz Jahanian2bb5dda2010-04-23 17:41:07 +00002227 AddTypeRef(Context.ObjCSelRedefinitionType, Record);
2228 AddTypeRef(Context.getRawNSConstantStringType(), Record);
Argyrios Kyrtzidis00611382010-07-04 21:44:19 +00002229 Record.push_back(Context.isInt128Installed());
Steve Naroffc15cb2a2009-07-18 15:33:26 +00002230 Stream.EmitRecord(pch::SPECIAL_TYPES, Record);
Mike Stump1eb44332009-09-09 15:08:12 +00002231
Douglas Gregor366809a2009-04-26 03:49:13 +00002232 // Keep writing types and declarations until all types and
2233 // declarations have been written.
Douglas Gregor61d60ee2009-10-17 00:13:19 +00002234 Stream.EnterSubblock(pch::DECLTYPES_BLOCK_ID, 3);
2235 WriteDeclsBlockAbbrevs();
2236 while (!DeclTypesToEmit.empty()) {
2237 DeclOrType DOT = DeclTypesToEmit.front();
2238 DeclTypesToEmit.pop();
2239 if (DOT.isType())
2240 WriteType(DOT.getType());
2241 else
2242 WriteDecl(Context, DOT.getDecl());
2243 }
2244 Stream.ExitBlock();
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00002245
Douglas Gregor813a97b2009-10-17 17:25:45 +00002246 WritePreprocessor(PP);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00002247 WriteMethodPool(SemaRef);
Douglas Gregor37e26842009-04-21 23:56:24 +00002248 WriteIdentifierTable(PP);
Douglas Gregor8f5dc7f2009-04-25 18:35:21 +00002249
Sebastian Redl1476ed42010-07-16 16:36:56 +00002250 WriteTypeDeclOffsets();
Douglas Gregorad1de002009-04-18 05:55:16 +00002251
Douglas Gregor4c0e86b2009-04-22 22:02:47 +00002252 // Write the record containing external, unnamed definitions.
Douglas Gregorfdd01722009-04-14 00:24:19 +00002253 if (!ExternalDefinitions.empty())
Douglas Gregorc9490c02009-04-16 22:23:12 +00002254 Stream.EmitRecord(pch::EXTERNAL_DEFINITIONS, ExternalDefinitions);
Douglas Gregor4c0e86b2009-04-22 22:02:47 +00002255
2256 // Write the record containing tentative definitions.
2257 if (!TentativeDefinitions.empty())
2258 Stream.EmitRecord(pch::TENTATIVE_DEFINITIONS, TentativeDefinitions);
Douglas Gregor14c22f22009-04-22 22:18:58 +00002259
Tanya Lattnere6bbc012010-02-12 00:07:30 +00002260 // Write the record containing unused static functions.
2261 if (!UnusedStaticFuncs.empty())
2262 Stream.EmitRecord(pch::UNUSED_STATIC_FUNCS, UnusedStaticFuncs);
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00002263
Douglas Gregor14c22f22009-04-22 22:18:58 +00002264 // Write the record containing locally-scoped external definitions.
2265 if (!LocallyScopedExternalDecls.empty())
Mike Stump1eb44332009-09-09 15:08:12 +00002266 Stream.EmitRecord(pch::LOCALLY_SCOPED_EXTERNAL_DECLS,
Douglas Gregor14c22f22009-04-22 22:18:58 +00002267 LocallyScopedExternalDecls);
Douglas Gregorb81c1702009-04-27 20:06:05 +00002268
2269 // Write the record containing ext_vector type names.
2270 if (!ExtVectorDecls.empty())
2271 Stream.EmitRecord(pch::EXT_VECTOR_DECLS, ExtVectorDecls);
Mike Stump1eb44332009-09-09 15:08:12 +00002272
Argyrios Kyrtzidisd455add2010-07-06 15:37:04 +00002273 // Write the record containing VTable uses information.
2274 if (!VTableUses.empty())
2275 Stream.EmitRecord(pch::VTABLE_USES, VTableUses);
2276
2277 // Write the record containing dynamic classes declarations.
2278 if (!DynamicClasses.empty())
2279 Stream.EmitRecord(pch::DYNAMIC_CLASSES, DynamicClasses);
2280
Douglas Gregor3e1af842009-04-17 22:13:46 +00002281 // Some simple statistics
Douglas Gregorad1de002009-04-18 05:55:16 +00002282 Record.clear();
Douglas Gregor3e1af842009-04-17 22:13:46 +00002283 Record.push_back(NumStatements);
Douglas Gregor37e26842009-04-21 23:56:24 +00002284 Record.push_back(NumMacros);
Douglas Gregor25123082009-04-22 22:34:57 +00002285 Record.push_back(NumLexicalDeclContexts);
2286 Record.push_back(NumVisibleDeclContexts);
Douglas Gregor3e1af842009-04-17 22:13:46 +00002287 Stream.EmitRecord(pch::STATISTICS, Record);
Douglas Gregorc9490c02009-04-16 22:23:12 +00002288 Stream.ExitBlock();
Douglas Gregor2cf26342009-04-09 22:27:44 +00002289}
2290
Sebastian Redl1dc13a12010-07-12 22:02:52 +00002291void PCHWriter::WritePCHChain(Sema &SemaRef, MemorizeStatCalls *StatCalls,
Sebastian Redl30c514c2010-07-14 23:45:08 +00002292 const char *isysroot) {
Sebastian Redl1dc13a12010-07-12 22:02:52 +00002293 using namespace llvm;
2294
2295 ASTContext &Context = SemaRef.Context;
2296 Preprocessor &PP = SemaRef.PP;
2297 (void)PP;
Sebastian Redl1476ed42010-07-16 16:36:56 +00002298
Sebastian Redl1dc13a12010-07-12 22:02:52 +00002299 RecordData Record;
2300 Stream.EnterSubblock(pch::PCH_BLOCK_ID, 5);
Sebastian Redl30c514c2010-07-14 23:45:08 +00002301 WriteMetadata(Context, isysroot);
Sebastian Redl1476ed42010-07-16 16:36:56 +00002302 if (StatCalls && !isysroot)
2303 WriteStatCache(*StatCalls);
2304 // FIXME: Source manager block should only write new stuff, which could be
2305 // done by tracking the largest ID in the chain
2306 WriteSourceManagerBlock(Context.getSourceManager(), PP, isysroot);
Sebastian Redl1dc13a12010-07-12 22:02:52 +00002307
2308 // The special types are in the chained PCH.
2309
2310 // We don't start with the translation unit, but with its decls that
2311 // don't come from the other PCH.
2312 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
2313 // FIXME: We don't want to iterate over everything here, because it needlessly
2314 // deserializes the entire original PCH. Instead we only want to iterate over
2315 // the stuff that's already there.
2316 // All in good time, though.
2317 for (DeclContext::decl_iterator I = TU->decls_begin(), E = TU->decls_end();
2318 I != E; ++I) {
2319 if ((*I)->getPCHLevel() == 0) {
Sebastian Redl1dc13a12010-07-12 22:02:52 +00002320 DeclTypesToEmit.push(*I);
2321 }
2322 }
2323
2324 Stream.EnterSubblock(pch::DECLTYPES_BLOCK_ID, 3);
2325 WriteDeclsBlockAbbrevs();
2326 while (!DeclTypesToEmit.empty()) {
2327 DeclOrType DOT = DeclTypesToEmit.front();
2328 DeclTypesToEmit.pop();
2329 if (DOT.isType())
2330 WriteType(DOT.getType());
2331 else
2332 WriteDecl(Context, DOT.getDecl());
2333 }
2334 Stream.ExitBlock();
2335
2336 // FIXME: Preprocessor
2337 // FIXME: Method pool
2338 // FIXME: Identifier table
Sebastian Redl1476ed42010-07-16 16:36:56 +00002339 WriteTypeDeclOffsets();
Sebastian Redl1dc13a12010-07-12 22:02:52 +00002340 // FIXME: External unnamed definitions
2341 // FIXME: Tentative definitions
2342 // FIXME: Unused static functions
2343 // FIXME: Locally-scoped external definitions
2344 // FIXME: ext_vector type names
2345 // FIXME: Dynamic classes declarations
2346 // FIXME: Statistics
2347 Stream.ExitBlock();
2348}
2349
Douglas Gregor2cf26342009-04-09 22:27:44 +00002350void PCHWriter::AddSourceLocation(SourceLocation Loc, RecordData &Record) {
2351 Record.push_back(Loc.getRawEncoding());
2352}
2353
Chris Lattner6ad9ac02010-05-07 21:43:38 +00002354void PCHWriter::AddSourceRange(SourceRange Range, RecordData &Record) {
2355 AddSourceLocation(Range.getBegin(), Record);
2356 AddSourceLocation(Range.getEnd(), Record);
2357}
2358
Douglas Gregor2cf26342009-04-09 22:27:44 +00002359void PCHWriter::AddAPInt(const llvm::APInt &Value, RecordData &Record) {
2360 Record.push_back(Value.getBitWidth());
2361 unsigned N = Value.getNumWords();
2362 const uint64_t* Words = Value.getRawData();
2363 for (unsigned I = 0; I != N; ++I)
2364 Record.push_back(Words[I]);
2365}
2366
Douglas Gregor0a2b45e2009-04-13 18:14:40 +00002367void PCHWriter::AddAPSInt(const llvm::APSInt &Value, RecordData &Record) {
2368 Record.push_back(Value.isUnsigned());
2369 AddAPInt(Value, Record);
2370}
2371
Douglas Gregor17fc2232009-04-14 21:55:33 +00002372void PCHWriter::AddAPFloat(const llvm::APFloat &Value, RecordData &Record) {
2373 AddAPInt(Value.bitcastToAPInt(), Record);
2374}
2375
Douglas Gregor2cf26342009-04-09 22:27:44 +00002376void PCHWriter::AddIdentifierRef(const IdentifierInfo *II, RecordData &Record) {
Douglas Gregor2deaea32009-04-22 18:49:13 +00002377 Record.push_back(getIdentifierRef(II));
2378}
2379
2380pch::IdentID PCHWriter::getIdentifierRef(const IdentifierInfo *II) {
2381 if (II == 0)
2382 return 0;
Douglas Gregorafaf3082009-04-11 00:14:32 +00002383
2384 pch::IdentID &ID = IdentifierIDs[II];
2385 if (ID == 0)
2386 ID = IdentifierIDs.size();
Douglas Gregor2deaea32009-04-22 18:49:13 +00002387 return ID;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002388}
2389
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00002390pch::IdentID PCHWriter::getMacroDefinitionID(MacroDefinition *MD) {
2391 if (MD == 0)
2392 return 0;
2393
2394 pch::IdentID &ID = MacroDefinitions[MD];
2395 if (ID == 0)
2396 ID = MacroDefinitions.size();
2397 return ID;
2398}
2399
Steve Naroff90cd1bb2009-04-23 10:39:46 +00002400void PCHWriter::AddSelectorRef(const Selector SelRef, RecordData &Record) {
2401 if (SelRef.getAsOpaquePtr() == 0) {
2402 Record.push_back(0);
2403 return;
2404 }
2405
2406 pch::SelectorID &SID = SelectorIDs[SelRef];
2407 if (SID == 0) {
2408 SID = SelectorIDs.size();
2409 SelVector.push_back(SelRef);
2410 }
2411 Record.push_back(SID);
2412}
2413
Chris Lattnerd2598362010-05-10 00:25:06 +00002414void PCHWriter::AddCXXTemporary(const CXXTemporary *Temp, RecordData &Record) {
2415 AddDeclRef(Temp->getDestructor(), Record);
2416}
2417
Argyrios Kyrtzidis44f8c372010-06-22 09:54:59 +00002418void PCHWriter::AddTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind,
2419 const TemplateArgumentLocInfo &Arg,
2420 RecordData &Record) {
2421 switch (Kind) {
John McCall833ca992009-10-29 08:12:44 +00002422 case TemplateArgument::Expression:
Argyrios Kyrtzidis44f8c372010-06-22 09:54:59 +00002423 AddStmt(Arg.getAsExpr());
John McCall833ca992009-10-29 08:12:44 +00002424 break;
2425 case TemplateArgument::Type:
Argyrios Kyrtzidis44f8c372010-06-22 09:54:59 +00002426 AddTypeSourceInfo(Arg.getAsTypeSourceInfo(), Record);
John McCall833ca992009-10-29 08:12:44 +00002427 break;
Douglas Gregor788cd062009-11-11 01:00:40 +00002428 case TemplateArgument::Template:
Argyrios Kyrtzidis17cfded2010-06-28 09:31:42 +00002429 AddSourceRange(Arg.getTemplateQualifierRange(), Record);
2430 AddSourceLocation(Arg.getTemplateNameLoc(), Record);
Douglas Gregor788cd062009-11-11 01:00:40 +00002431 break;
John McCall833ca992009-10-29 08:12:44 +00002432 case TemplateArgument::Null:
2433 case TemplateArgument::Integral:
2434 case TemplateArgument::Declaration:
2435 case TemplateArgument::Pack:
2436 break;
2437 }
2438}
2439
Argyrios Kyrtzidis44f8c372010-06-22 09:54:59 +00002440void PCHWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg,
2441 RecordData &Record) {
2442 AddTemplateArgument(Arg.getArgument(), Record);
Argyrios Kyrtzidis17cfded2010-06-28 09:31:42 +00002443
2444 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
2445 bool InfoHasSameExpr
2446 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
2447 Record.push_back(InfoHasSameExpr);
2448 if (InfoHasSameExpr)
2449 return; // Avoid storing the same expr twice.
2450 }
Argyrios Kyrtzidis44f8c372010-06-22 09:54:59 +00002451 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo(),
2452 Record);
2453}
2454
John McCalla93c9342009-12-07 02:54:59 +00002455void PCHWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo, RecordData &Record) {
2456 if (TInfo == 0) {
John McCalla1ee0c52009-10-16 21:56:05 +00002457 AddTypeRef(QualType(), Record);
2458 return;
2459 }
2460
John McCalla93c9342009-12-07 02:54:59 +00002461 AddTypeRef(TInfo->getType(), Record);
John McCalla1ee0c52009-10-16 21:56:05 +00002462 TypeLocWriter TLW(*this, Record);
John McCalla93c9342009-12-07 02:54:59 +00002463 for (TypeLoc TL = TInfo->getTypeLoc(); !TL.isNull(); TL = TL.getNextTypeLoc())
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00002464 TLW.Visit(TL);
John McCalla1ee0c52009-10-16 21:56:05 +00002465}
2466
Douglas Gregor2cf26342009-04-09 22:27:44 +00002467void PCHWriter::AddTypeRef(QualType T, RecordData &Record) {
2468 if (T.isNull()) {
2469 Record.push_back(pch::PREDEF_TYPE_NULL_ID);
2470 return;
2471 }
2472
Douglas Gregora4923eb2009-11-16 21:35:15 +00002473 unsigned FastQuals = T.getLocalFastQualifiers();
John McCall0953e762009-09-24 19:53:00 +00002474 T.removeFastQualifiers();
2475
Douglas Gregora4923eb2009-11-16 21:35:15 +00002476 if (T.hasLocalNonFastQualifiers()) {
John McCall0953e762009-09-24 19:53:00 +00002477 pch::TypeID &ID = TypeIDs[T];
2478 if (ID == 0) {
2479 // We haven't seen these qualifiers applied to this type before.
2480 // Assign it a new ID. This is the only time we enqueue a
2481 // qualified type, and it has no CV qualifiers.
2482 ID = NextTypeID++;
Douglas Gregor61d60ee2009-10-17 00:13:19 +00002483 DeclTypesToEmit.push(T);
John McCall0953e762009-09-24 19:53:00 +00002484 }
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00002485
John McCall0953e762009-09-24 19:53:00 +00002486 // Encode the type qualifiers in the type reference.
2487 Record.push_back((ID << Qualifiers::FastWidth) | FastQuals);
2488 return;
2489 }
2490
Douglas Gregora4923eb2009-11-16 21:35:15 +00002491 assert(!T.hasLocalQualifiers());
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00002492
Douglas Gregor2cf26342009-04-09 22:27:44 +00002493 if (const BuiltinType *BT = dyn_cast<BuiltinType>(T.getTypePtr())) {
Douglas Gregore1d918e2009-04-10 23:10:45 +00002494 pch::TypeID ID = 0;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002495 switch (BT->getKind()) {
2496 case BuiltinType::Void: ID = pch::PREDEF_TYPE_VOID_ID; break;
2497 case BuiltinType::Bool: ID = pch::PREDEF_TYPE_BOOL_ID; break;
2498 case BuiltinType::Char_U: ID = pch::PREDEF_TYPE_CHAR_U_ID; break;
2499 case BuiltinType::UChar: ID = pch::PREDEF_TYPE_UCHAR_ID; break;
2500 case BuiltinType::UShort: ID = pch::PREDEF_TYPE_USHORT_ID; break;
2501 case BuiltinType::UInt: ID = pch::PREDEF_TYPE_UINT_ID; break;
2502 case BuiltinType::ULong: ID = pch::PREDEF_TYPE_ULONG_ID; break;
2503 case BuiltinType::ULongLong: ID = pch::PREDEF_TYPE_ULONGLONG_ID; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +00002504 case BuiltinType::UInt128: ID = pch::PREDEF_TYPE_UINT128_ID; break;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002505 case BuiltinType::Char_S: ID = pch::PREDEF_TYPE_CHAR_S_ID; break;
2506 case BuiltinType::SChar: ID = pch::PREDEF_TYPE_SCHAR_ID; break;
2507 case BuiltinType::WChar: ID = pch::PREDEF_TYPE_WCHAR_ID; break;
2508 case BuiltinType::Short: ID = pch::PREDEF_TYPE_SHORT_ID; break;
2509 case BuiltinType::Int: ID = pch::PREDEF_TYPE_INT_ID; break;
2510 case BuiltinType::Long: ID = pch::PREDEF_TYPE_LONG_ID; break;
2511 case BuiltinType::LongLong: ID = pch::PREDEF_TYPE_LONGLONG_ID; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +00002512 case BuiltinType::Int128: ID = pch::PREDEF_TYPE_INT128_ID; break;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002513 case BuiltinType::Float: ID = pch::PREDEF_TYPE_FLOAT_ID; break;
2514 case BuiltinType::Double: ID = pch::PREDEF_TYPE_DOUBLE_ID; break;
2515 case BuiltinType::LongDouble: ID = pch::PREDEF_TYPE_LONGDOUBLE_ID; break;
Sebastian Redl6e8ed162009-05-10 18:38:11 +00002516 case BuiltinType::NullPtr: ID = pch::PREDEF_TYPE_NULLPTR_ID; break;
Alisdair Meredithf5c209d2009-07-14 06:30:34 +00002517 case BuiltinType::Char16: ID = pch::PREDEF_TYPE_CHAR16_ID; break;
2518 case BuiltinType::Char32: ID = pch::PREDEF_TYPE_CHAR32_ID; break;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002519 case BuiltinType::Overload: ID = pch::PREDEF_TYPE_OVERLOAD_ID; break;
2520 case BuiltinType::Dependent: ID = pch::PREDEF_TYPE_DEPENDENT_ID; break;
Steve Naroffde2e22d2009-07-15 18:40:39 +00002521 case BuiltinType::ObjCId: ID = pch::PREDEF_TYPE_OBJC_ID; break;
2522 case BuiltinType::ObjCClass: ID = pch::PREDEF_TYPE_OBJC_CLASS; break;
Fariborz Jahanian13dcd002009-11-21 19:53:08 +00002523 case BuiltinType::ObjCSel: ID = pch::PREDEF_TYPE_OBJC_SEL; break;
Anders Carlssone89d1592009-06-26 18:41:36 +00002524 case BuiltinType::UndeducedAuto:
2525 assert(0 && "Should not see undeduced auto here");
2526 break;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002527 }
2528
John McCall0953e762009-09-24 19:53:00 +00002529 Record.push_back((ID << Qualifiers::FastWidth) | FastQuals);
Douglas Gregor2cf26342009-04-09 22:27:44 +00002530 return;
2531 }
2532
John McCall0953e762009-09-24 19:53:00 +00002533 pch::TypeID &ID = TypeIDs[T];
Douglas Gregor366809a2009-04-26 03:49:13 +00002534 if (ID == 0) {
2535 // We haven't seen this type before. Assign it a new ID and put it
John McCall0953e762009-09-24 19:53:00 +00002536 // into the queue of types to emit.
Douglas Gregor2cf26342009-04-09 22:27:44 +00002537 ID = NextTypeID++;
Douglas Gregor61d60ee2009-10-17 00:13:19 +00002538 DeclTypesToEmit.push(T);
Douglas Gregor366809a2009-04-26 03:49:13 +00002539 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002540
2541 // Encode the type qualifiers in the type reference.
John McCall0953e762009-09-24 19:53:00 +00002542 Record.push_back((ID << Qualifiers::FastWidth) | FastQuals);
Douglas Gregor2cf26342009-04-09 22:27:44 +00002543}
2544
2545void PCHWriter::AddDeclRef(const Decl *D, RecordData &Record) {
2546 if (D == 0) {
2547 Record.push_back(0);
2548 return;
2549 }
2550
Douglas Gregor8038d512009-04-10 17:25:41 +00002551 pch::DeclID &ID = DeclIDs[D];
Mike Stump1eb44332009-09-09 15:08:12 +00002552 if (ID == 0) {
Douglas Gregor2cf26342009-04-09 22:27:44 +00002553 // We haven't seen this declaration before. Give it a new ID and
2554 // enqueue it in the list of declarations to emit.
2555 ID = DeclIDs.size();
Douglas Gregor61d60ee2009-10-17 00:13:19 +00002556 DeclTypesToEmit.push(const_cast<Decl *>(D));
Douglas Gregor2cf26342009-04-09 22:27:44 +00002557 }
2558
2559 Record.push_back(ID);
2560}
2561
Douglas Gregor3251ceb2009-04-20 20:36:09 +00002562pch::DeclID PCHWriter::getDeclID(const Decl *D) {
2563 if (D == 0)
2564 return 0;
2565
2566 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
2567 return DeclIDs[D];
2568}
2569
Douglas Gregor2cf26342009-04-09 22:27:44 +00002570void PCHWriter::AddDeclarationName(DeclarationName Name, RecordData &Record) {
Chris Lattnerea5ce472009-04-27 07:35:58 +00002571 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc.
Douglas Gregor2cf26342009-04-09 22:27:44 +00002572 Record.push_back(Name.getNameKind());
2573 switch (Name.getNameKind()) {
2574 case DeclarationName::Identifier:
2575 AddIdentifierRef(Name.getAsIdentifierInfo(), Record);
2576 break;
2577
2578 case DeclarationName::ObjCZeroArgSelector:
2579 case DeclarationName::ObjCOneArgSelector:
2580 case DeclarationName::ObjCMultiArgSelector:
Steve Naroff90cd1bb2009-04-23 10:39:46 +00002581 AddSelectorRef(Name.getObjCSelector(), Record);
Douglas Gregor2cf26342009-04-09 22:27:44 +00002582 break;
2583
2584 case DeclarationName::CXXConstructorName:
2585 case DeclarationName::CXXDestructorName:
2586 case DeclarationName::CXXConversionFunctionName:
2587 AddTypeRef(Name.getCXXNameType(), Record);
2588 break;
2589
2590 case DeclarationName::CXXOperatorName:
2591 Record.push_back(Name.getCXXOverloadedOperator());
2592 break;
2593
Sean Hunt3e518bd2009-11-29 07:34:05 +00002594 case DeclarationName::CXXLiteralOperatorName:
2595 AddIdentifierRef(Name.getCXXLiteralIdentifier(), Record);
2596 break;
2597
Douglas Gregor2cf26342009-04-09 22:27:44 +00002598 case DeclarationName::CXXUsingDirective:
2599 // No extra data to emit
2600 break;
2601 }
2602}
Chris Lattner6ad9ac02010-05-07 21:43:38 +00002603
2604void PCHWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS,
2605 RecordData &Record) {
2606 // Nested name specifiers usually aren't too long. I think that 8 would
2607 // typically accomodate the vast majority.
2608 llvm::SmallVector<NestedNameSpecifier *, 8> NestedNames;
2609
2610 // Push each of the NNS's onto a stack for serialization in reverse order.
2611 while (NNS) {
2612 NestedNames.push_back(NNS);
2613 NNS = NNS->getPrefix();
2614 }
2615
2616 Record.push_back(NestedNames.size());
2617 while(!NestedNames.empty()) {
2618 NNS = NestedNames.pop_back_val();
2619 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
2620 Record.push_back(Kind);
2621 switch (Kind) {
2622 case NestedNameSpecifier::Identifier:
2623 AddIdentifierRef(NNS->getAsIdentifier(), Record);
2624 break;
2625
2626 case NestedNameSpecifier::Namespace:
2627 AddDeclRef(NNS->getAsNamespace(), Record);
2628 break;
2629
2630 case NestedNameSpecifier::TypeSpec:
2631 case NestedNameSpecifier::TypeSpecWithTemplate:
2632 AddTypeRef(QualType(NNS->getAsType(), 0), Record);
2633 Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
2634 break;
2635
2636 case NestedNameSpecifier::Global:
2637 // Don't need to write an associated value.
2638 break;
2639 }
2640 }
2641}
Argyrios Kyrtzidis90b715e2010-06-19 19:28:53 +00002642
2643void PCHWriter::AddTemplateName(TemplateName Name, RecordData &Record) {
2644 TemplateName::NameKind Kind = Name.getKind();
2645 Record.push_back(Kind);
2646 switch (Kind) {
2647 case TemplateName::Template:
2648 AddDeclRef(Name.getAsTemplateDecl(), Record);
2649 break;
2650
2651 case TemplateName::OverloadedTemplate: {
2652 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
2653 Record.push_back(OvT->size());
2654 for (OverloadedTemplateStorage::iterator I = OvT->begin(), E = OvT->end();
2655 I != E; ++I)
2656 AddDeclRef(*I, Record);
2657 break;
2658 }
2659
2660 case TemplateName::QualifiedTemplate: {
2661 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
2662 AddNestedNameSpecifier(QualT->getQualifier(), Record);
2663 Record.push_back(QualT->hasTemplateKeyword());
2664 AddDeclRef(QualT->getTemplateDecl(), Record);
2665 break;
2666 }
2667
2668 case TemplateName::DependentTemplate: {
2669 DependentTemplateName *DepT = Name.getAsDependentTemplateName();
2670 AddNestedNameSpecifier(DepT->getQualifier(), Record);
2671 Record.push_back(DepT->isIdentifier());
2672 if (DepT->isIdentifier())
2673 AddIdentifierRef(DepT->getIdentifier(), Record);
2674 else
2675 Record.push_back(DepT->getOperator());
2676 break;
2677 }
2678 }
2679}
2680
2681void PCHWriter::AddTemplateArgument(const TemplateArgument &Arg,
2682 RecordData &Record) {
2683 Record.push_back(Arg.getKind());
2684 switch (Arg.getKind()) {
2685 case TemplateArgument::Null:
2686 break;
2687 case TemplateArgument::Type:
2688 AddTypeRef(Arg.getAsType(), Record);
2689 break;
2690 case TemplateArgument::Declaration:
2691 AddDeclRef(Arg.getAsDecl(), Record);
2692 break;
2693 case TemplateArgument::Integral:
2694 AddAPSInt(*Arg.getAsIntegral(), Record);
2695 AddTypeRef(Arg.getIntegralType(), Record);
2696 break;
2697 case TemplateArgument::Template:
2698 AddTemplateName(Arg.getAsTemplate(), Record);
2699 break;
2700 case TemplateArgument::Expression:
2701 AddStmt(Arg.getAsExpr());
2702 break;
2703 case TemplateArgument::Pack:
2704 Record.push_back(Arg.pack_size());
2705 for (TemplateArgument::pack_iterator I=Arg.pack_begin(), E=Arg.pack_end();
2706 I != E; ++I)
2707 AddTemplateArgument(*I, Record);
2708 break;
2709 }
2710}
Argyrios Kyrtzidisdd41c142010-06-23 13:48:30 +00002711
2712void
2713PCHWriter::AddTemplateParameterList(const TemplateParameterList *TemplateParams,
2714 RecordData &Record) {
2715 assert(TemplateParams && "No TemplateParams!");
2716 AddSourceLocation(TemplateParams->getTemplateLoc(), Record);
2717 AddSourceLocation(TemplateParams->getLAngleLoc(), Record);
2718 AddSourceLocation(TemplateParams->getRAngleLoc(), Record);
2719 Record.push_back(TemplateParams->size());
2720 for (TemplateParameterList::const_iterator
2721 P = TemplateParams->begin(), PEnd = TemplateParams->end();
2722 P != PEnd; ++P)
2723 AddDeclRef(*P, Record);
2724}
2725
2726/// \brief Emit a template argument list.
2727void
2728PCHWriter::AddTemplateArgumentList(const TemplateArgumentList *TemplateArgs,
2729 RecordData &Record) {
2730 assert(TemplateArgs && "No TemplateArgs!");
2731 Record.push_back(TemplateArgs->flat_size());
2732 for (int i=0, e = TemplateArgs->flat_size(); i != e; ++i)
2733 AddTemplateArgument(TemplateArgs->get(i), Record);
2734}
Argyrios Kyrtzidis37ffed32010-07-02 11:55:32 +00002735
2736
2737void
2738PCHWriter::AddUnresolvedSet(const UnresolvedSetImpl &Set, RecordData &Record) {
2739 Record.push_back(Set.size());
2740 for (UnresolvedSetImpl::const_iterator
2741 I = Set.begin(), E = Set.end(); I != E; ++I) {
2742 AddDeclRef(I.getDecl(), Record);
2743 Record.push_back(I.getAccess());
2744 }
2745}
Argyrios Kyrtzidis0745d0a2010-07-02 23:30:27 +00002746
2747void PCHWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base,
2748 RecordData &Record) {
2749 Record.push_back(Base.isVirtual());
2750 Record.push_back(Base.isBaseOfClass());
2751 Record.push_back(Base.getAccessSpecifierAsWritten());
2752 AddTypeRef(Base.getType(), Record);
2753 AddSourceRange(Base.getSourceRange(), Record);
2754}
Sebastian Redl30c514c2010-07-14 23:45:08 +00002755
2756void PCHWriter::TypeRead(pch::TypeID ID, QualType T) {
Sebastian Redl1476ed42010-07-16 16:36:56 +00002757 TypeIDs[T] = ID;
Sebastian Redl30c514c2010-07-14 23:45:08 +00002758}
2759
2760void PCHWriter::DeclRead(pch::DeclID ID, const Decl *D) {
Sebastian Redl1476ed42010-07-16 16:36:56 +00002761 DeclIDs[D] = ID;
Sebastian Redl30c514c2010-07-14 23:45:08 +00002762}
2763