blob: e86399886c0b3a994b4719f07d1bbc5bcff3470b [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 Redl77f46032010-07-09 21:00:24 +0000746void PCHWriter::WriteMetadata(ASTContext &Context, const PCHReader *Chain,
747 const char *isysroot) {
Douglas Gregor2bec0412009-04-10 21:16:55 +0000748 using namespace llvm;
Douglas Gregorb64c1932009-05-12 01:31:05 +0000749
Douglas Gregore650c8c2009-07-07 00:12:59 +0000750 // Metadata
751 const TargetInfo &Target = Context.Target;
752 BitCodeAbbrev *MetaAbbrev = new BitCodeAbbrev();
Sebastian Redl77f46032010-07-09 21:00:24 +0000753 MetaAbbrev->Add(BitCodeAbbrevOp(
754 Chain ? pch::CHAINED_METADATA : pch::METADATA));
Douglas Gregore650c8c2009-07-07 00:12:59 +0000755 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // PCH major
756 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // PCH minor
757 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang major
758 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang minor
759 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
Sebastian Redl77f46032010-07-09 21:00:24 +0000760 // Target triple or chained PCH name
761 MetaAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Douglas Gregore650c8c2009-07-07 00:12:59 +0000762 unsigned MetaAbbrevCode = Stream.EmitAbbrev(MetaAbbrev);
Mike Stump1eb44332009-09-09 15:08:12 +0000763
Douglas Gregore650c8c2009-07-07 00:12:59 +0000764 RecordData Record;
Sebastian Redl77f46032010-07-09 21:00:24 +0000765 Record.push_back(Chain ? pch::CHAINED_METADATA : pch::METADATA);
Douglas Gregore650c8c2009-07-07 00:12:59 +0000766 Record.push_back(pch::VERSION_MAJOR);
767 Record.push_back(pch::VERSION_MINOR);
768 Record.push_back(CLANG_VERSION_MAJOR);
769 Record.push_back(CLANG_VERSION_MINOR);
770 Record.push_back(isysroot != 0);
Sebastian Redl77f46032010-07-09 21:00:24 +0000771 // FIXME: This writes the absolute path for chained headers.
772 const std::string &BlobStr = Chain ? Chain->getFileName() : Target.getTriple().getTriple();
773 Stream.EmitRecordWithBlob(MetaAbbrevCode, Record, BlobStr);
Mike Stump1eb44332009-09-09 15:08:12 +0000774
Douglas Gregorb64c1932009-05-12 01:31:05 +0000775 // Original file name
776 SourceManager &SM = Context.getSourceManager();
777 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
778 BitCodeAbbrev *FileAbbrev = new BitCodeAbbrev();
779 FileAbbrev->Add(BitCodeAbbrevOp(pch::ORIGINAL_FILE_NAME));
780 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
781 unsigned FileAbbrevCode = Stream.EmitAbbrev(FileAbbrev);
782
783 llvm::sys::Path MainFilePath(MainFile->getName());
Mike Stump1eb44332009-09-09 15:08:12 +0000784
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +0000785 MainFilePath.makeAbsolute();
Douglas Gregorb64c1932009-05-12 01:31:05 +0000786
Kovarththanan Rajaratnamaba54a92010-03-14 07:15:57 +0000787 const char *MainFileNameStr = MainFilePath.c_str();
Mike Stump1eb44332009-09-09 15:08:12 +0000788 MainFileNameStr = adjustFilenameForRelocatablePCH(MainFileNameStr,
Douglas Gregore650c8c2009-07-07 00:12:59 +0000789 isysroot);
Douglas Gregorb64c1932009-05-12 01:31:05 +0000790 RecordData Record;
791 Record.push_back(pch::ORIGINAL_FILE_NAME);
Daniel Dunbarec312a12009-08-24 09:31:37 +0000792 Stream.EmitRecordWithBlob(FileAbbrevCode, Record, MainFileNameStr);
Douglas Gregorb64c1932009-05-12 01:31:05 +0000793 }
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +0000794
Ted Kremenekf7a96a32010-01-22 22:12:47 +0000795 // Repository branch/version information.
796 BitCodeAbbrev *RepoAbbrev = new BitCodeAbbrev();
797 RepoAbbrev->Add(BitCodeAbbrevOp(pch::VERSION_CONTROL_BRANCH_REVISION));
798 RepoAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
799 unsigned RepoAbbrevCode = Stream.EmitAbbrev(RepoAbbrev);
Douglas Gregor445e23e2009-10-05 21:07:28 +0000800 Record.clear();
Ted Kremenek5b4ec632010-01-22 20:59:36 +0000801 Record.push_back(pch::VERSION_CONTROL_BRANCH_REVISION);
Ted Kremenekf7a96a32010-01-22 22:12:47 +0000802 Stream.EmitRecordWithBlob(RepoAbbrevCode, Record,
803 getClangFullRepositoryVersion());
Douglas Gregor2bec0412009-04-10 21:16:55 +0000804}
805
806/// \brief Write the LangOptions structure.
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000807void PCHWriter::WriteLanguageOptions(const LangOptions &LangOpts) {
808 RecordData Record;
809 Record.push_back(LangOpts.Trigraphs);
810 Record.push_back(LangOpts.BCPLComment); // BCPL-style '//' comments.
811 Record.push_back(LangOpts.DollarIdents); // '$' allowed in identifiers.
812 Record.push_back(LangOpts.AsmPreprocessor); // Preprocessor in asm mode.
813 Record.push_back(LangOpts.GNUMode); // True in gnu99 mode false in c99 mode (etc)
Chandler Carrutheb5d7b72010-04-17 20:17:31 +0000814 Record.push_back(LangOpts.GNUKeywords); // Allow GNU-extension keywords
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000815 Record.push_back(LangOpts.ImplicitInt); // C89 implicit 'int'.
816 Record.push_back(LangOpts.Digraphs); // C94, C99 and C++
817 Record.push_back(LangOpts.HexFloats); // C99 Hexadecimal float constants.
818 Record.push_back(LangOpts.C99); // C99 Support
819 Record.push_back(LangOpts.Microsoft); // Microsoft extensions.
820 Record.push_back(LangOpts.CPlusPlus); // C++ Support
821 Record.push_back(LangOpts.CPlusPlus0x); // C++0x Support
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000822 Record.push_back(LangOpts.CXXOperatorNames); // Treat C++ operator names as keywords.
Mike Stump1eb44332009-09-09 15:08:12 +0000823
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000824 Record.push_back(LangOpts.ObjC1); // Objective-C 1 support enabled.
825 Record.push_back(LangOpts.ObjC2); // Objective-C 2 support enabled.
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +0000826 Record.push_back(LangOpts.ObjCNonFragileABI); // Objective-C
Fariborz Jahanian412e7982010-02-09 19:31:38 +0000827 // modern abi enabled.
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +0000828 Record.push_back(LangOpts.ObjCNonFragileABI2); // Objective-C enhanced
Fariborz Jahanian412e7982010-02-09 19:31:38 +0000829 // modern abi enabled.
Fariborz Jahanian4c9d8d02010-04-22 21:01:59 +0000830 Record.push_back(LangOpts.NoConstantCFStrings); // non cfstring generation enabled..
Mike Stump1eb44332009-09-09 15:08:12 +0000831
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000832 Record.push_back(LangOpts.PascalStrings); // Allow Pascal strings
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000833 Record.push_back(LangOpts.WritableStrings); // Allow writable strings
834 Record.push_back(LangOpts.LaxVectorConversions);
Nate Begemanb9e7e632009-06-25 23:01:11 +0000835 Record.push_back(LangOpts.AltiVec);
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000836 Record.push_back(LangOpts.Exceptions); // Support exception handling.
Daniel Dunbar73482882010-02-10 18:48:44 +0000837 Record.push_back(LangOpts.SjLjExceptions);
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000838
839 Record.push_back(LangOpts.NeXTRuntime); // Use NeXT runtime.
840 Record.push_back(LangOpts.Freestanding); // Freestanding implementation
841 Record.push_back(LangOpts.NoBuiltin); // Do not use builtin functions (-fno-builtin)
842
Chris Lattnerea5ce472009-04-27 07:35:58 +0000843 // Whether static initializers are protected by locks.
844 Record.push_back(LangOpts.ThreadsafeStatics);
Douglas Gregor972d9542009-09-03 14:36:33 +0000845 Record.push_back(LangOpts.POSIXThreads);
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000846 Record.push_back(LangOpts.Blocks); // block extension to C
847 Record.push_back(LangOpts.EmitAllDecls); // Emit all declarations, even if
848 // they are unused.
849 Record.push_back(LangOpts.MathErrno); // Math functions must respect errno
850 // (modulo the platform support).
851
Chris Lattnera4d71452010-06-26 21:25:03 +0000852 Record.push_back(LangOpts.getSignedOverflowBehavior());
853 Record.push_back(LangOpts.HeinousExtensions);
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000854
855 Record.push_back(LangOpts.Optimize); // Whether __OPTIMIZE__ should be defined.
Mike Stump1eb44332009-09-09 15:08:12 +0000856 Record.push_back(LangOpts.OptimizeSize); // Whether __OPTIMIZE_SIZE__ should be
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000857 // defined.
858 Record.push_back(LangOpts.Static); // Should __STATIC__ be defined (as
859 // opposed to __DYNAMIC__).
860 Record.push_back(LangOpts.PICLevel); // The value for __PIC__, if non-zero.
861
862 Record.push_back(LangOpts.GNUInline); // Should GNU inline semantics be
863 // used (instead of C99 semantics).
864 Record.push_back(LangOpts.NoInline); // Should __NO_INLINE__ be defined.
Anders Carlssona33d9b42009-05-13 19:49:53 +0000865 Record.push_back(LangOpts.AccessControl); // Whether C++ access control should
866 // be enabled.
Eli Friedman15b91762009-06-05 07:05:05 +0000867 Record.push_back(LangOpts.CharIsSigned); // Whether char is a signed or
868 // unsigned type
John Thompsona6fda122009-11-05 20:14:16 +0000869 Record.push_back(LangOpts.ShortWChar); // force wchar_t to be unsigned short
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000870 Record.push_back(LangOpts.getGCMode());
871 Record.push_back(LangOpts.getVisibilityMode());
Daniel Dunbarab8e2812009-09-21 04:16:19 +0000872 Record.push_back(LangOpts.getStackProtectorMode());
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000873 Record.push_back(LangOpts.InstantiationDepth);
Nate Begemanb9e7e632009-06-25 23:01:11 +0000874 Record.push_back(LangOpts.OpenCL);
Mike Stump9c276ae2009-12-12 01:27:46 +0000875 Record.push_back(LangOpts.CatchUndefined);
Anders Carlsson92f58222009-08-22 22:30:33 +0000876 Record.push_back(LangOpts.ElideConstructors);
Douglas Gregora0068fc2010-07-09 17:35:33 +0000877 Record.push_back(LangOpts.SpellChecking);
Douglas Gregorc9490c02009-04-16 22:23:12 +0000878 Stream.EmitRecord(pch::LANGUAGE_OPTIONS, Record);
Douglas Gregor0a0428e2009-04-10 20:39:37 +0000879}
880
Douglas Gregor14f79002009-04-10 03:52:48 +0000881//===----------------------------------------------------------------------===//
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000882// stat cache Serialization
883//===----------------------------------------------------------------------===//
884
885namespace {
886// Trait used for the on-disk hash table of stat cache results.
Benjamin Kramerbd218282009-11-28 10:07:24 +0000887class PCHStatCacheTrait {
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000888public:
889 typedef const char * key_type;
890 typedef key_type key_type_ref;
Mike Stump1eb44332009-09-09 15:08:12 +0000891
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000892 typedef std::pair<int, struct stat> data_type;
893 typedef const data_type& data_type_ref;
894
895 static unsigned ComputeHash(const char *path) {
Daniel Dunbar2596e422009-10-17 23:52:28 +0000896 return llvm::HashString(path);
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000897 }
Mike Stump1eb44332009-09-09 15:08:12 +0000898
899 std::pair<unsigned,unsigned>
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000900 EmitKeyDataLength(llvm::raw_ostream& Out, const char *path,
901 data_type_ref Data) {
902 unsigned StrLen = strlen(path);
903 clang::io::Emit16(Out, StrLen);
904 unsigned DataLen = 1; // result value
905 if (Data.first == 0)
906 DataLen += 4 + 4 + 2 + 8 + 8;
907 clang::io::Emit8(Out, DataLen);
908 return std::make_pair(StrLen + 1, DataLen);
909 }
Mike Stump1eb44332009-09-09 15:08:12 +0000910
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000911 void EmitKey(llvm::raw_ostream& Out, const char *path, unsigned KeyLen) {
912 Out.write(path, KeyLen);
913 }
Mike Stump1eb44332009-09-09 15:08:12 +0000914
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000915 void EmitData(llvm::raw_ostream& Out, key_type_ref,
916 data_type_ref Data, unsigned DataLen) {
917 using namespace clang::io;
918 uint64_t Start = Out.tell(); (void)Start;
Mike Stump1eb44332009-09-09 15:08:12 +0000919
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000920 // Result of stat()
921 Emit8(Out, Data.first? 1 : 0);
Mike Stump1eb44332009-09-09 15:08:12 +0000922
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000923 if (Data.first == 0) {
924 Emit32(Out, (uint32_t) Data.second.st_ino);
925 Emit32(Out, (uint32_t) Data.second.st_dev);
926 Emit16(Out, (uint16_t) Data.second.st_mode);
927 Emit64(Out, (uint64_t) Data.second.st_mtime);
928 Emit64(Out, (uint64_t) Data.second.st_size);
929 }
930
931 assert(Out.tell() - Start == DataLen && "Wrong data length");
932 }
933};
934} // end anonymous namespace
935
936/// \brief Write the stat() system call cache to the PCH file.
Douglas Gregordd41ed52010-07-12 23:48:14 +0000937void PCHWriter::WriteStatCache(MemorizeStatCalls &StatCalls) {
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000938 // Build the on-disk hash table containing information about every
939 // stat() call.
940 OnDiskChainedHashTableGenerator<PCHStatCacheTrait> Generator;
941 unsigned NumStatEntries = 0;
Mike Stump1eb44332009-09-09 15:08:12 +0000942 for (MemorizeStatCalls::iterator Stat = StatCalls.begin(),
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000943 StatEnd = StatCalls.end();
Douglas Gregore650c8c2009-07-07 00:12:59 +0000944 Stat != StatEnd; ++Stat, ++NumStatEntries) {
945 const char *Filename = Stat->first();
Douglas Gregore650c8c2009-07-07 00:12:59 +0000946 Generator.insert(Filename, Stat->second);
947 }
Mike Stump1eb44332009-09-09 15:08:12 +0000948
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000949 // Create the on-disk hash table in a buffer.
Mike Stump1eb44332009-09-09 15:08:12 +0000950 llvm::SmallString<4096> StatCacheData;
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000951 uint32_t BucketOffset;
952 {
953 llvm::raw_svector_ostream Out(StatCacheData);
954 // Make sure that no bucket is at offset 0
955 clang::io::Emit32(Out, 0);
956 BucketOffset = Generator.Emit(Out);
957 }
958
959 // Create a blob abbreviation
960 using namespace llvm;
961 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
962 Abbrev->Add(BitCodeAbbrevOp(pch::STAT_CACHE));
963 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
964 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
965 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
966 unsigned StatCacheAbbrev = Stream.EmitAbbrev(Abbrev);
967
968 // Write the stat cache
969 RecordData Record;
970 Record.push_back(pch::STAT_CACHE);
971 Record.push_back(BucketOffset);
972 Record.push_back(NumStatEntries);
Daniel Dunbarec312a12009-08-24 09:31:37 +0000973 Stream.EmitRecordWithBlob(StatCacheAbbrev, Record, StatCacheData.str());
Douglas Gregor4fed3f42009-04-27 18:38:38 +0000974}
975
976//===----------------------------------------------------------------------===//
Douglas Gregor14f79002009-04-10 03:52:48 +0000977// Source Manager Serialization
978//===----------------------------------------------------------------------===//
979
980/// \brief Create an abbreviation for the SLocEntry that refers to a
981/// file.
Douglas Gregorc9490c02009-04-16 22:23:12 +0000982static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregor14f79002009-04-10 03:52:48 +0000983 using namespace llvm;
984 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
985 Abbrev->Add(BitCodeAbbrevOp(pch::SM_SLOC_FILE_ENTRY));
986 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
987 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
988 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
989 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
Douglas Gregor2d52be52010-03-21 22:49:54 +0000990 // FileEntry fields.
991 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
992 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
Douglas Gregor12fab312010-03-16 16:35:32 +0000993 // HeaderFileInfo fields.
994 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isImport
995 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // DirInfo
996 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumIncludes
997 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // ControllingMacro
Douglas Gregor14f79002009-04-10 03:52:48 +0000998 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
Douglas Gregorc9490c02009-04-16 22:23:12 +0000999 return Stream.EmitAbbrev(Abbrev);
Douglas Gregor14f79002009-04-10 03:52:48 +00001000}
1001
1002/// \brief Create an abbreviation for the SLocEntry that refers to a
1003/// buffer.
Douglas Gregorc9490c02009-04-16 22:23:12 +00001004static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregor14f79002009-04-10 03:52:48 +00001005 using namespace llvm;
1006 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1007 Abbrev->Add(BitCodeAbbrevOp(pch::SM_SLOC_BUFFER_ENTRY));
1008 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1009 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1010 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1011 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1012 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
Douglas Gregorc9490c02009-04-16 22:23:12 +00001013 return Stream.EmitAbbrev(Abbrev);
Douglas Gregor14f79002009-04-10 03:52:48 +00001014}
1015
1016/// \brief Create an abbreviation for the SLocEntry that refers to a
1017/// buffer's blob.
Douglas Gregorc9490c02009-04-16 22:23:12 +00001018static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregor14f79002009-04-10 03:52:48 +00001019 using namespace llvm;
1020 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1021 Abbrev->Add(BitCodeAbbrevOp(pch::SM_SLOC_BUFFER_BLOB));
1022 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
Douglas Gregorc9490c02009-04-16 22:23:12 +00001023 return Stream.EmitAbbrev(Abbrev);
Douglas Gregor14f79002009-04-10 03:52:48 +00001024}
1025
1026/// \brief Create an abbreviation for the SLocEntry that refers to an
1027/// buffer.
Douglas Gregorc9490c02009-04-16 22:23:12 +00001028static unsigned CreateSLocInstantiationAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregor14f79002009-04-10 03:52:48 +00001029 using namespace llvm;
1030 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1031 Abbrev->Add(BitCodeAbbrevOp(pch::SM_SLOC_INSTANTIATION_ENTRY));
1032 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1033 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1034 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1035 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
Douglas Gregorf60e9912009-04-15 18:05:10 +00001036 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
Douglas Gregorc9490c02009-04-16 22:23:12 +00001037 return Stream.EmitAbbrev(Abbrev);
Douglas Gregor14f79002009-04-10 03:52:48 +00001038}
1039
1040/// \brief Writes the block containing the serialized form of the
1041/// source manager.
1042///
1043/// TODO: We should probably use an on-disk hash table (stored in a
1044/// blob), indexed based on the file name, so that we only create
1045/// entries for files that we actually need. In the common case (no
1046/// errors), we probably won't have to create file entries for any of
1047/// the files in the AST.
Douglas Gregor2eafc1b2009-04-26 00:07:37 +00001048void PCHWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
Douglas Gregore650c8c2009-07-07 00:12:59 +00001049 const Preprocessor &PP,
1050 const char *isysroot) {
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001051 RecordData Record;
1052
Chris Lattnerf04ad692009-04-10 17:16:57 +00001053 // Enter the source manager block.
Douglas Gregorc9490c02009-04-16 22:23:12 +00001054 Stream.EnterSubblock(pch::SOURCE_MANAGER_BLOCK_ID, 3);
Douglas Gregor14f79002009-04-10 03:52:48 +00001055
1056 // Abbreviations for the various kinds of source-location entries.
Chris Lattner828e18c2009-04-27 19:03:22 +00001057 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
1058 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
1059 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream);
1060 unsigned SLocInstantiationAbbrv = CreateSLocInstantiationAbbrev(Stream);
Douglas Gregor14f79002009-04-10 03:52:48 +00001061
Douglas Gregorbd945002009-04-13 16:31:14 +00001062 // Write the line table.
1063 if (SourceMgr.hasLineTable()) {
1064 LineTableInfo &LineTable = SourceMgr.getLineTable();
1065
1066 // Emit the file names
1067 Record.push_back(LineTable.getNumFilenames());
1068 for (unsigned I = 0, N = LineTable.getNumFilenames(); I != N; ++I) {
1069 // Emit the file name
1070 const char *Filename = LineTable.getFilename(I);
Douglas Gregore650c8c2009-07-07 00:12:59 +00001071 Filename = adjustFilenameForRelocatablePCH(Filename, isysroot);
Douglas Gregorbd945002009-04-13 16:31:14 +00001072 unsigned FilenameLen = Filename? strlen(Filename) : 0;
1073 Record.push_back(FilenameLen);
1074 if (FilenameLen)
1075 Record.insert(Record.end(), Filename, Filename + FilenameLen);
1076 }
Mike Stump1eb44332009-09-09 15:08:12 +00001077
Douglas Gregorbd945002009-04-13 16:31:14 +00001078 // Emit the line entries
1079 for (LineTableInfo::iterator L = LineTable.begin(), LEnd = LineTable.end();
1080 L != LEnd; ++L) {
1081 // Emit the file ID
1082 Record.push_back(L->first);
Mike Stump1eb44332009-09-09 15:08:12 +00001083
Douglas Gregorbd945002009-04-13 16:31:14 +00001084 // Emit the line entries
1085 Record.push_back(L->second.size());
Mike Stump1eb44332009-09-09 15:08:12 +00001086 for (std::vector<LineEntry>::iterator LE = L->second.begin(),
Douglas Gregorbd945002009-04-13 16:31:14 +00001087 LEEnd = L->second.end();
1088 LE != LEEnd; ++LE) {
1089 Record.push_back(LE->FileOffset);
1090 Record.push_back(LE->LineNo);
1091 Record.push_back(LE->FilenameID);
1092 Record.push_back((unsigned)LE->FileKind);
1093 Record.push_back(LE->IncludeOffset);
1094 }
Douglas Gregorbd945002009-04-13 16:31:14 +00001095 }
Zhongxing Xu3d8216a2009-05-22 08:38:27 +00001096 Stream.EmitRecord(pch::SM_LINE_TABLE, Record);
Douglas Gregorbd945002009-04-13 16:31:14 +00001097 }
1098
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001099 // Write out the source location entry table. We skip the first
1100 // entry, which is always the same dummy entry.
Chris Lattner090d9b52009-04-27 19:01:47 +00001101 std::vector<uint32_t> SLocEntryOffsets;
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001102 RecordData PreloadSLocs;
1103 SLocEntryOffsets.reserve(SourceMgr.sloc_entry_size() - 1);
Douglas Gregorbdfe48a2009-10-16 22:46:09 +00001104 for (unsigned I = 1, N = SourceMgr.sloc_entry_size(); I != N; ++I) {
1105 // Get this source location entry.
1106 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getSLocEntry(I);
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00001107
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001108 // Record the offset of this source-location entry.
1109 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
1110
1111 // Figure out which record code to use.
1112 unsigned Code;
1113 if (SLoc->isFile()) {
1114 if (SLoc->getFile().getContentCache()->Entry)
1115 Code = pch::SM_SLOC_FILE_ENTRY;
1116 else
1117 Code = pch::SM_SLOC_BUFFER_ENTRY;
1118 } else
1119 Code = pch::SM_SLOC_INSTANTIATION_ENTRY;
1120 Record.clear();
1121 Record.push_back(Code);
1122
1123 Record.push_back(SLoc->getOffset());
1124 if (SLoc->isFile()) {
1125 const SrcMgr::FileInfo &File = SLoc->getFile();
1126 Record.push_back(File.getIncludeLoc().getRawEncoding());
1127 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
1128 Record.push_back(File.hasLineDirectives());
1129
1130 const SrcMgr::ContentCache *Content = File.getContentCache();
1131 if (Content->Entry) {
1132 // The source location entry is a file. The blob associated
1133 // with this entry is the file name.
Mike Stump1eb44332009-09-09 15:08:12 +00001134
Douglas Gregor2d52be52010-03-21 22:49:54 +00001135 // Emit size/modification time for this file.
1136 Record.push_back(Content->Entry->getSize());
1137 Record.push_back(Content->Entry->getModificationTime());
1138
Douglas Gregor12fab312010-03-16 16:35:32 +00001139 // Emit header-search information associated with this file.
1140 HeaderFileInfo HFI;
1141 HeaderSearch &HS = PP.getHeaderSearchInfo();
1142 if (Content->Entry->getUID() < HS.header_file_size())
1143 HFI = HS.header_file_begin()[Content->Entry->getUID()];
1144 Record.push_back(HFI.isImport);
1145 Record.push_back(HFI.DirInfo);
1146 Record.push_back(HFI.NumIncludes);
1147 AddIdentifierRef(HFI.ControllingMacro, Record);
1148
Douglas Gregore650c8c2009-07-07 00:12:59 +00001149 // Turn the file name into an absolute path, if it isn't already.
1150 const char *Filename = Content->Entry->getName();
1151 llvm::sys::Path FilePath(Filename, strlen(Filename));
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00001152 FilePath.makeAbsolute();
Kovarththanan Rajaratnamaba54a92010-03-14 07:15:57 +00001153 Filename = FilePath.c_str();
Mike Stump1eb44332009-09-09 15:08:12 +00001154
Douglas Gregore650c8c2009-07-07 00:12:59 +00001155 Filename = adjustFilenameForRelocatablePCH(Filename, isysroot);
Daniel Dunbarec312a12009-08-24 09:31:37 +00001156 Stream.EmitRecordWithBlob(SLocFileAbbrv, Record, Filename);
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001157
1158 // FIXME: For now, preload all file source locations, so that
1159 // we get the appropriate File entries in the reader. This is
1160 // a temporary measure.
1161 PreloadSLocs.push_back(SLocEntryOffsets.size());
1162 } else {
1163 // The source location entry is a buffer. The blob associated
1164 // with this entry contains the contents of the buffer.
1165
1166 // We add one to the size so that we capture the trailing NULL
1167 // that is required by llvm::MemoryBuffer::getMemBuffer (on
1168 // the reader side).
Douglas Gregor36c35ba2010-03-16 00:35:39 +00001169 const llvm::MemoryBuffer *Buffer
Chris Lattnere127a0d2010-04-20 20:35:58 +00001170 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001171 const char *Name = Buffer->getBufferIdentifier();
Daniel Dunbarec312a12009-08-24 09:31:37 +00001172 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
1173 llvm::StringRef(Name, strlen(Name) + 1));
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001174 Record.clear();
1175 Record.push_back(pch::SM_SLOC_BUFFER_BLOB);
1176 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record,
Daniel Dunbarec312a12009-08-24 09:31:37 +00001177 llvm::StringRef(Buffer->getBufferStart(),
1178 Buffer->getBufferSize() + 1));
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001179
1180 if (strcmp(Name, "<built-in>") == 0)
1181 PreloadSLocs.push_back(SLocEntryOffsets.size());
1182 }
1183 } else {
1184 // The source location entry is an instantiation.
1185 const SrcMgr::InstantiationInfo &Inst = SLoc->getInstantiation();
1186 Record.push_back(Inst.getSpellingLoc().getRawEncoding());
1187 Record.push_back(Inst.getInstantiationLocStart().getRawEncoding());
1188 Record.push_back(Inst.getInstantiationLocEnd().getRawEncoding());
1189
1190 // Compute the token length for this macro expansion.
1191 unsigned NextOffset = SourceMgr.getNextOffset();
Douglas Gregorbdfe48a2009-10-16 22:46:09 +00001192 if (I + 1 != N)
1193 NextOffset = SourceMgr.getSLocEntry(I + 1).getOffset();
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001194 Record.push_back(NextOffset - SLoc->getOffset() - 1);
1195 Stream.EmitRecordWithAbbrev(SLocInstantiationAbbrv, Record);
1196 }
1197 }
1198
Douglas Gregorc9490c02009-04-16 22:23:12 +00001199 Stream.ExitBlock();
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001200
1201 if (SLocEntryOffsets.empty())
1202 return;
1203
1204 // Write the source-location offsets table into the PCH block. This
1205 // table is used for lazily loading source-location information.
1206 using namespace llvm;
1207 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1208 Abbrev->Add(BitCodeAbbrevOp(pch::SOURCE_LOCATION_OFFSETS));
1209 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
1210 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // next offset
1211 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
1212 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(Abbrev);
Mike Stump1eb44332009-09-09 15:08:12 +00001213
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001214 Record.clear();
1215 Record.push_back(pch::SOURCE_LOCATION_OFFSETS);
1216 Record.push_back(SLocEntryOffsets.size());
1217 Record.push_back(SourceMgr.getNextOffset());
1218 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
Mike Stump1eb44332009-09-09 15:08:12 +00001219 (const char *)&SLocEntryOffsets.front(),
Chris Lattner090d9b52009-04-27 19:01:47 +00001220 SLocEntryOffsets.size()*sizeof(SLocEntryOffsets[0]));
Douglas Gregor7f94b0b2009-04-27 06:38:32 +00001221
1222 // Write the source location entry preloads array, telling the PCH
1223 // reader which source locations entries it should load eagerly.
1224 Stream.EmitRecord(pch::SOURCE_LOCATION_PRELOADS, PreloadSLocs);
Douglas Gregor14f79002009-04-10 03:52:48 +00001225}
1226
Douglas Gregor4fed3f42009-04-27 18:38:38 +00001227//===----------------------------------------------------------------------===//
1228// Preprocessor Serialization
1229//===----------------------------------------------------------------------===//
1230
Chris Lattner0b1fb982009-04-10 17:15:23 +00001231/// \brief Writes the block containing the serialized form of the
1232/// preprocessor.
1233///
Chris Lattnerdf961c22009-04-10 18:08:30 +00001234void PCHWriter::WritePreprocessor(const Preprocessor &PP) {
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001235 RecordData Record;
Chris Lattnerf04ad692009-04-10 17:16:57 +00001236
Chris Lattnerc1f9d822009-04-13 01:29:17 +00001237 // If the preprocessor __COUNTER__ value has been bumped, remember it.
1238 if (PP.getCounterValue() != 0) {
1239 Record.push_back(PP.getCounterValue());
Douglas Gregorc9490c02009-04-16 22:23:12 +00001240 Stream.EmitRecord(pch::PP_COUNTER_VALUE, Record);
Chris Lattnerc1f9d822009-04-13 01:29:17 +00001241 Record.clear();
Douglas Gregor2eafc1b2009-04-26 00:07:37 +00001242 }
1243
1244 // Enter the preprocessor block.
1245 Stream.EnterSubblock(pch::PREPROCESSOR_BLOCK_ID, 2);
Mike Stump1eb44332009-09-09 15:08:12 +00001246
Douglas Gregor2eafc1b2009-04-26 00:07:37 +00001247 // If the PCH file contains __DATE__ or __TIME__ emit a warning about this.
1248 // FIXME: use diagnostics subsystem for localization etc.
1249 if (PP.SawDateOrTime())
1250 fprintf(stderr, "warning: precompiled header used __DATE__ or __TIME__.\n");
Mike Stump1eb44332009-09-09 15:08:12 +00001251
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001252 // Loop over all the macro definitions that are live at the end of the file,
1253 // emitting each to the PP section.
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001254 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001255 for (Preprocessor::macro_iterator I = PP.macro_begin(), E = PP.macro_end();
1256 I != E; ++I) {
Chris Lattner42d42b52009-04-10 21:41:48 +00001257 // FIXME: This emits macros in hash table order, we should do it in a stable
1258 // order so that output is reproducible.
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001259 MacroInfo *MI = I->second;
1260
1261 // Don't emit builtin macros like __LINE__ to the PCH file unless they have
1262 // been redefined by the header (in which case they are not isBuiltinMacro).
1263 if (MI->isBuiltinMacro())
1264 continue;
1265
Chris Lattner7356a312009-04-11 21:15:38 +00001266 AddIdentifierRef(I->first, Record);
Douglas Gregor37e26842009-04-21 23:56:24 +00001267 MacroOffsets[I->first] = Stream.GetCurrentBitNo();
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001268 Record.push_back(MI->getDefinitionLoc().getRawEncoding());
1269 Record.push_back(MI->isUsed());
Mike Stump1eb44332009-09-09 15:08:12 +00001270
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001271 unsigned Code;
1272 if (MI->isObjectLike()) {
1273 Code = pch::PP_MACRO_OBJECT_LIKE;
1274 } else {
1275 Code = pch::PP_MACRO_FUNCTION_LIKE;
Mike Stump1eb44332009-09-09 15:08:12 +00001276
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001277 Record.push_back(MI->isC99Varargs());
1278 Record.push_back(MI->isGNUVarargs());
1279 Record.push_back(MI->getNumArgs());
1280 for (MacroInfo::arg_iterator I = MI->arg_begin(), E = MI->arg_end();
1281 I != E; ++I)
Chris Lattner7356a312009-04-11 21:15:38 +00001282 AddIdentifierRef(*I, Record);
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001283 }
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001284
1285 // If we have a detailed preprocessing record, record the macro definition
1286 // ID that corresponds to this macro.
1287 if (PPRec)
1288 Record.push_back(getMacroDefinitionID(PPRec->findMacroDefinition(MI)));
1289
Douglas Gregorc9490c02009-04-16 22:23:12 +00001290 Stream.EmitRecord(Code, Record);
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001291 Record.clear();
1292
Chris Lattnerdf961c22009-04-10 18:08:30 +00001293 // Emit the tokens array.
1294 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
1295 // Note that we know that the preprocessor does not have any annotation
1296 // tokens in it because they are created by the parser, and thus can't be
1297 // in a macro definition.
1298 const Token &Tok = MI->getReplacementToken(TokNo);
Mike Stump1eb44332009-09-09 15:08:12 +00001299
Chris Lattnerdf961c22009-04-10 18:08:30 +00001300 Record.push_back(Tok.getLocation().getRawEncoding());
1301 Record.push_back(Tok.getLength());
1302
Chris Lattnerdf961c22009-04-10 18:08:30 +00001303 // FIXME: When reading literal tokens, reconstruct the literal pointer if
1304 // it is needed.
Chris Lattner7356a312009-04-11 21:15:38 +00001305 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
Mike Stump1eb44332009-09-09 15:08:12 +00001306
Chris Lattnerdf961c22009-04-10 18:08:30 +00001307 // FIXME: Should translate token kind to a stable encoding.
1308 Record.push_back(Tok.getKind());
1309 // FIXME: Should translate token flags to a stable encoding.
1310 Record.push_back(Tok.getFlags());
Mike Stump1eb44332009-09-09 15:08:12 +00001311
Douglas Gregorc9490c02009-04-16 22:23:12 +00001312 Stream.EmitRecord(pch::PP_TOKEN, Record);
Chris Lattnerdf961c22009-04-10 18:08:30 +00001313 Record.clear();
1314 }
Douglas Gregor37e26842009-04-21 23:56:24 +00001315 ++NumMacros;
Chris Lattner7c5d24e2009-04-10 18:00:12 +00001316 }
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001317
1318 // If the preprocessor has a preprocessing record, emit it.
1319 unsigned NumPreprocessingRecords = 0;
1320 if (PPRec) {
1321 for (PreprocessingRecord::iterator E = PPRec->begin(), EEnd = PPRec->end();
1322 E != EEnd; ++E) {
1323 Record.clear();
1324
1325 if (MacroInstantiation *MI = dyn_cast<MacroInstantiation>(*E)) {
1326 Record.push_back(NumPreprocessingRecords++);
1327 AddSourceLocation(MI->getSourceRange().getBegin(), Record);
1328 AddSourceLocation(MI->getSourceRange().getEnd(), Record);
1329 AddIdentifierRef(MI->getName(), Record);
1330 Record.push_back(getMacroDefinitionID(MI->getDefinition()));
1331 Stream.EmitRecord(pch::PP_MACRO_INSTANTIATION, Record);
1332 continue;
1333 }
1334
1335 if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) {
1336 // Record this macro definition's location.
1337 pch::IdentID ID = getMacroDefinitionID(MD);
1338 if (ID != MacroDefinitionOffsets.size()) {
1339 if (ID > MacroDefinitionOffsets.size())
1340 MacroDefinitionOffsets.resize(ID + 1);
1341
1342 MacroDefinitionOffsets[ID] = Stream.GetCurrentBitNo();
1343 } else
1344 MacroDefinitionOffsets.push_back(Stream.GetCurrentBitNo());
1345
1346 Record.push_back(NumPreprocessingRecords++);
1347 Record.push_back(ID);
1348 AddSourceLocation(MD->getSourceRange().getBegin(), Record);
1349 AddSourceLocation(MD->getSourceRange().getEnd(), Record);
1350 AddIdentifierRef(MD->getName(), Record);
1351 AddSourceLocation(MD->getLocation(), Record);
1352 Stream.EmitRecord(pch::PP_MACRO_DEFINITION, Record);
1353 continue;
1354 }
1355 }
1356 }
1357
Douglas Gregorc9490c02009-04-16 22:23:12 +00001358 Stream.ExitBlock();
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00001359
1360 // Write the offsets table for the preprocessing record.
1361 if (NumPreprocessingRecords > 0) {
1362 // Write the offsets table for identifier IDs.
1363 using namespace llvm;
1364 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1365 Abbrev->Add(BitCodeAbbrevOp(pch::MACRO_DEFINITION_OFFSETS));
1366 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of records
1367 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macro defs
1368 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1369 unsigned MacroDefOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1370
1371 Record.clear();
1372 Record.push_back(pch::MACRO_DEFINITION_OFFSETS);
1373 Record.push_back(NumPreprocessingRecords);
1374 Record.push_back(MacroDefinitionOffsets.size());
1375 Stream.EmitRecordWithBlob(MacroDefOffsetAbbrev, Record,
1376 (const char *)&MacroDefinitionOffsets.front(),
1377 MacroDefinitionOffsets.size() * sizeof(uint32_t));
1378 }
Chris Lattner0b1fb982009-04-10 17:15:23 +00001379}
1380
Douglas Gregor4fed3f42009-04-27 18:38:38 +00001381//===----------------------------------------------------------------------===//
1382// Type Serialization
1383//===----------------------------------------------------------------------===//
Chris Lattner0b1fb982009-04-10 17:15:23 +00001384
Douglas Gregor2cf26342009-04-09 22:27:44 +00001385/// \brief Write the representation of a type to the PCH stream.
John McCall0953e762009-09-24 19:53:00 +00001386void PCHWriter::WriteType(QualType T) {
Douglas Gregor8038d512009-04-10 17:25:41 +00001387 pch::TypeID &ID = TypeIDs[T];
Chris Lattnerf04ad692009-04-10 17:16:57 +00001388 if (ID == 0) // we haven't seen this type before.
Douglas Gregor2cf26342009-04-09 22:27:44 +00001389 ID = NextTypeID++;
Mike Stump1eb44332009-09-09 15:08:12 +00001390
Douglas Gregor2cf26342009-04-09 22:27:44 +00001391 // Record the offset for this type.
1392 if (TypeOffsets.size() == ID - pch::NUM_PREDEF_TYPE_IDS)
Douglas Gregorc9490c02009-04-16 22:23:12 +00001393 TypeOffsets.push_back(Stream.GetCurrentBitNo());
Douglas Gregor2cf26342009-04-09 22:27:44 +00001394 else if (TypeOffsets.size() < ID - pch::NUM_PREDEF_TYPE_IDS) {
1395 TypeOffsets.resize(ID + 1 - pch::NUM_PREDEF_TYPE_IDS);
Douglas Gregorc9490c02009-04-16 22:23:12 +00001396 TypeOffsets[ID - pch::NUM_PREDEF_TYPE_IDS] = Stream.GetCurrentBitNo();
Douglas Gregor2cf26342009-04-09 22:27:44 +00001397 }
1398
1399 RecordData Record;
Mike Stump1eb44332009-09-09 15:08:12 +00001400
Douglas Gregor2cf26342009-04-09 22:27:44 +00001401 // Emit the type's representation.
1402 PCHTypeWriter W(*this, Record);
John McCall0953e762009-09-24 19:53:00 +00001403
Douglas Gregora4923eb2009-11-16 21:35:15 +00001404 if (T.hasLocalNonFastQualifiers()) {
1405 Qualifiers Qs = T.getLocalQualifiers();
1406 AddTypeRef(T.getLocalUnqualifiedType(), Record);
John McCall0953e762009-09-24 19:53:00 +00001407 Record.push_back(Qs.getAsOpaqueValue());
1408 W.Code = pch::TYPE_EXT_QUAL;
1409 } else {
1410 switch (T->getTypeClass()) {
1411 // For all of the concrete, non-dependent types, call the
1412 // appropriate visitor function.
Douglas Gregor2cf26342009-04-09 22:27:44 +00001413#define TYPE(Class, Base) \
Mike Stumpb7166332010-01-20 02:03:14 +00001414 case Type::Class: W.Visit##Class##Type(cast<Class##Type>(T)); break;
Douglas Gregor2cf26342009-04-09 22:27:44 +00001415#define ABSTRACT_TYPE(Class, Base)
Douglas Gregor2cf26342009-04-09 22:27:44 +00001416#include "clang/AST/TypeNodes.def"
John McCall0953e762009-09-24 19:53:00 +00001417 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00001418 }
1419
1420 // Emit the serialized record.
Douglas Gregorc9490c02009-04-16 22:23:12 +00001421 Stream.EmitRecord(W.Code, Record);
Douglas Gregor0b748912009-04-14 21:18:50 +00001422
1423 // Flush any expressions that were written as part of this type.
Douglas Gregorc9490c02009-04-16 22:23:12 +00001424 FlushStmts();
Douglas Gregor2cf26342009-04-09 22:27:44 +00001425}
1426
Douglas Gregor4fed3f42009-04-27 18:38:38 +00001427//===----------------------------------------------------------------------===//
1428// Declaration Serialization
1429//===----------------------------------------------------------------------===//
1430
Douglas Gregor2cf26342009-04-09 22:27:44 +00001431/// \brief Write the block containing all of the declaration IDs
1432/// lexically declared within the given DeclContext.
1433///
1434/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
1435/// bistream, or 0 if no block was written.
Mike Stump1eb44332009-09-09 15:08:12 +00001436uint64_t PCHWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
Douglas Gregor2cf26342009-04-09 22:27:44 +00001437 DeclContext *DC) {
Argyrios Kyrtzidis17945a02009-06-30 02:36:12 +00001438 if (DC->decls_empty())
Douglas Gregor2cf26342009-04-09 22:27:44 +00001439 return 0;
1440
Douglas Gregorc9490c02009-04-16 22:23:12 +00001441 uint64_t Offset = Stream.GetCurrentBitNo();
Douglas Gregor2cf26342009-04-09 22:27:44 +00001442 RecordData Record;
Argyrios Kyrtzidis17945a02009-06-30 02:36:12 +00001443 for (DeclContext::decl_iterator D = DC->decls_begin(), DEnd = DC->decls_end();
1444 D != DEnd; ++D)
Douglas Gregor2cf26342009-04-09 22:27:44 +00001445 AddDeclRef(*D, Record);
1446
Douglas Gregor25123082009-04-22 22:34:57 +00001447 ++NumLexicalDeclContexts;
Douglas Gregorc9490c02009-04-16 22:23:12 +00001448 Stream.EmitRecord(pch::DECL_CONTEXT_LEXICAL, Record);
Douglas Gregor2cf26342009-04-09 22:27:44 +00001449 return Offset;
1450}
1451
1452/// \brief Write the block containing all of the declaration IDs
1453/// visible from the given DeclContext.
1454///
1455/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
1456/// bistream, or 0 if no block was written.
1457uint64_t PCHWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
1458 DeclContext *DC) {
1459 if (DC->getPrimaryContext() != DC)
1460 return 0;
1461
Argyrios Kyrtzidis67643342010-06-29 22:47:00 +00001462 // Since there is no name lookup into functions or methods, don't bother to
1463 // build a visible-declarations table for these entities.
1464 if (DC->isFunctionOrMethod())
1465 return 0;
1466
1467 // If not in C++, we perform name lookup for the translation unit via the
1468 // IdentifierInfo chains, don't bother to build a visible-declarations table.
1469 // FIXME: In C++ we need the visible declarations in order to "see" the
1470 // friend declarations, is there a way to do this without writing the table ?
1471 if (DC->isTranslationUnit() && !Context.getLangOptions().CPlusPlus)
Douglas Gregor58f06992009-04-18 15:49:20 +00001472 return 0;
1473
Douglas Gregor2cf26342009-04-09 22:27:44 +00001474 // Force the DeclContext to build a its name-lookup table.
Argyrios Kyrtzidis17945a02009-06-30 02:36:12 +00001475 DC->lookup(DeclarationName());
Douglas Gregor2cf26342009-04-09 22:27:44 +00001476
1477 // Serialize the contents of the mapping used for lookup. Note that,
1478 // although we have two very different code paths, the serialized
1479 // representation is the same for both cases: a declaration name,
1480 // followed by a size, followed by references to the visible
1481 // declarations that have that name.
Douglas Gregorc9490c02009-04-16 22:23:12 +00001482 uint64_t Offset = Stream.GetCurrentBitNo();
Douglas Gregor2cf26342009-04-09 22:27:44 +00001483 RecordData Record;
1484 StoredDeclsMap *Map = static_cast<StoredDeclsMap*>(DC->getLookupPtr());
Douglas Gregor8c700062009-04-13 21:20:57 +00001485 if (!Map)
1486 return 0;
1487
Douglas Gregor2cf26342009-04-09 22:27:44 +00001488 for (StoredDeclsMap::iterator D = Map->begin(), DEnd = Map->end();
1489 D != DEnd; ++D) {
1490 AddDeclarationName(D->first, Record);
1491 DeclContext::lookup_result Result = D->second.getLookupResult(Context);
1492 Record.push_back(Result.second - Result.first);
Mike Stump1eb44332009-09-09 15:08:12 +00001493 for (; Result.first != Result.second; ++Result.first)
Douglas Gregor2cf26342009-04-09 22:27:44 +00001494 AddDeclRef(*Result.first, Record);
1495 }
1496
1497 if (Record.size() == 0)
1498 return 0;
1499
Douglas Gregorc9490c02009-04-16 22:23:12 +00001500 Stream.EmitRecord(pch::DECL_CONTEXT_VISIBLE, Record);
Douglas Gregor25123082009-04-22 22:34:57 +00001501 ++NumVisibleDeclContexts;
Douglas Gregor2cf26342009-04-09 22:27:44 +00001502 return Offset;
1503}
1504
Douglas Gregor4fed3f42009-04-27 18:38:38 +00001505//===----------------------------------------------------------------------===//
1506// Global Method Pool and Selector Serialization
1507//===----------------------------------------------------------------------===//
1508
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001509namespace {
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001510// Trait used for the on-disk hash table used in the method pool.
Benjamin Kramerbd218282009-11-28 10:07:24 +00001511class PCHMethodPoolTrait {
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001512 PCHWriter &Writer;
1513
1514public:
1515 typedef Selector key_type;
1516 typedef key_type key_type_ref;
Mike Stump1eb44332009-09-09 15:08:12 +00001517
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001518 typedef std::pair<ObjCMethodList, ObjCMethodList> data_type;
1519 typedef const data_type& data_type_ref;
1520
1521 explicit PCHMethodPoolTrait(PCHWriter &Writer) : Writer(Writer) { }
Mike Stump1eb44332009-09-09 15:08:12 +00001522
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001523 static unsigned ComputeHash(Selector Sel) {
1524 unsigned N = Sel.getNumArgs();
1525 if (N == 0)
1526 ++N;
1527 unsigned R = 5381;
1528 for (unsigned I = 0; I != N; ++I)
1529 if (IdentifierInfo *II = Sel.getIdentifierInfoForSlot(I))
Daniel Dunbar2596e422009-10-17 23:52:28 +00001530 R = llvm::HashString(II->getName(), R);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001531 return R;
1532 }
Mike Stump1eb44332009-09-09 15:08:12 +00001533
1534 std::pair<unsigned,unsigned>
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001535 EmitKeyDataLength(llvm::raw_ostream& Out, Selector Sel,
1536 data_type_ref Methods) {
1537 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
1538 clang::io::Emit16(Out, KeyLen);
1539 unsigned DataLen = 2 + 2; // 2 bytes for each of the method counts
Mike Stump1eb44332009-09-09 15:08:12 +00001540 for (const ObjCMethodList *Method = &Methods.first; Method;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001541 Method = Method->Next)
1542 if (Method->Method)
1543 DataLen += 4;
Mike Stump1eb44332009-09-09 15:08:12 +00001544 for (const ObjCMethodList *Method = &Methods.second; Method;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001545 Method = Method->Next)
1546 if (Method->Method)
1547 DataLen += 4;
1548 clang::io::Emit16(Out, DataLen);
1549 return std::make_pair(KeyLen, DataLen);
1550 }
Mike Stump1eb44332009-09-09 15:08:12 +00001551
Douglas Gregor83941df2009-04-25 17:48:32 +00001552 void EmitKey(llvm::raw_ostream& Out, Selector Sel, unsigned) {
Mike Stump1eb44332009-09-09 15:08:12 +00001553 uint64_t Start = Out.tell();
Douglas Gregor83941df2009-04-25 17:48:32 +00001554 assert((Start >> 32) == 0 && "Selector key offset too large");
1555 Writer.SetSelectorOffset(Sel, Start);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001556 unsigned N = Sel.getNumArgs();
1557 clang::io::Emit16(Out, N);
1558 if (N == 0)
1559 N = 1;
1560 for (unsigned I = 0; I != N; ++I)
Mike Stump1eb44332009-09-09 15:08:12 +00001561 clang::io::Emit32(Out,
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001562 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
1563 }
Mike Stump1eb44332009-09-09 15:08:12 +00001564
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001565 void EmitData(llvm::raw_ostream& Out, key_type_ref,
Douglas Gregora67e58c2009-04-24 21:49:02 +00001566 data_type_ref Methods, unsigned DataLen) {
1567 uint64_t Start = Out.tell(); (void)Start;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001568 unsigned NumInstanceMethods = 0;
Mike Stump1eb44332009-09-09 15:08:12 +00001569 for (const ObjCMethodList *Method = &Methods.first; Method;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001570 Method = Method->Next)
1571 if (Method->Method)
1572 ++NumInstanceMethods;
1573
1574 unsigned NumFactoryMethods = 0;
Mike Stump1eb44332009-09-09 15:08:12 +00001575 for (const ObjCMethodList *Method = &Methods.second; Method;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001576 Method = Method->Next)
1577 if (Method->Method)
1578 ++NumFactoryMethods;
1579
1580 clang::io::Emit16(Out, NumInstanceMethods);
1581 clang::io::Emit16(Out, NumFactoryMethods);
Mike Stump1eb44332009-09-09 15:08:12 +00001582 for (const ObjCMethodList *Method = &Methods.first; Method;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001583 Method = Method->Next)
1584 if (Method->Method)
1585 clang::io::Emit32(Out, Writer.getDeclID(Method->Method));
Mike Stump1eb44332009-09-09 15:08:12 +00001586 for (const ObjCMethodList *Method = &Methods.second; Method;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001587 Method = Method->Next)
1588 if (Method->Method)
1589 clang::io::Emit32(Out, Writer.getDeclID(Method->Method));
Douglas Gregora67e58c2009-04-24 21:49:02 +00001590
1591 assert(Out.tell() - Start == DataLen && "Data length is wrong");
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001592 }
1593};
1594} // end anonymous namespace
1595
1596/// \brief Write the method pool into the PCH file.
1597///
1598/// The method pool contains both instance and factory methods, stored
1599/// in an on-disk hash table indexed by the selector.
1600void PCHWriter::WriteMethodPool(Sema &SemaRef) {
1601 using namespace llvm;
1602
1603 // Create and write out the blob that contains the instance and
1604 // factor method pools.
1605 bool Empty = true;
1606 {
1607 OnDiskChainedHashTableGenerator<PCHMethodPoolTrait> Generator;
Mike Stump1eb44332009-09-09 15:08:12 +00001608
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001609 // Create the on-disk hash table representation. Start by
1610 // iterating through the instance method pool.
1611 PCHMethodPoolTrait::key_type Key;
Douglas Gregor83941df2009-04-25 17:48:32 +00001612 unsigned NumSelectorsInMethodPool = 0;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001613 for (llvm::DenseMap<Selector, ObjCMethodList>::iterator
Mike Stump1eb44332009-09-09 15:08:12 +00001614 Instance = SemaRef.InstanceMethodPool.begin(),
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001615 InstanceEnd = SemaRef.InstanceMethodPool.end();
1616 Instance != InstanceEnd; ++Instance) {
1617 // Check whether there is a factory method with the same
1618 // selector.
1619 llvm::DenseMap<Selector, ObjCMethodList>::iterator Factory
1620 = SemaRef.FactoryMethodPool.find(Instance->first);
1621
1622 if (Factory == SemaRef.FactoryMethodPool.end())
1623 Generator.insert(Instance->first,
Mike Stump1eb44332009-09-09 15:08:12 +00001624 std::make_pair(Instance->second,
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001625 ObjCMethodList()));
1626 else
1627 Generator.insert(Instance->first,
1628 std::make_pair(Instance->second, Factory->second));
1629
Douglas Gregor83941df2009-04-25 17:48:32 +00001630 ++NumSelectorsInMethodPool;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001631 Empty = false;
1632 }
1633
1634 // Now iterate through the factory method pool, to pick up any
1635 // selectors that weren't already in the instance method pool.
1636 for (llvm::DenseMap<Selector, ObjCMethodList>::iterator
Mike Stump1eb44332009-09-09 15:08:12 +00001637 Factory = SemaRef.FactoryMethodPool.begin(),
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001638 FactoryEnd = SemaRef.FactoryMethodPool.end();
1639 Factory != FactoryEnd; ++Factory) {
1640 // Check whether there is an instance method with the same
1641 // selector. If so, there is no work to do here.
1642 llvm::DenseMap<Selector, ObjCMethodList>::iterator Instance
1643 = SemaRef.InstanceMethodPool.find(Factory->first);
1644
Douglas Gregor83941df2009-04-25 17:48:32 +00001645 if (Instance == SemaRef.InstanceMethodPool.end()) {
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001646 Generator.insert(Factory->first,
1647 std::make_pair(ObjCMethodList(), Factory->second));
Douglas Gregor83941df2009-04-25 17:48:32 +00001648 ++NumSelectorsInMethodPool;
1649 }
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001650
1651 Empty = false;
1652 }
1653
Douglas Gregor83941df2009-04-25 17:48:32 +00001654 if (Empty && SelectorOffsets.empty())
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001655 return;
1656
1657 // Create the on-disk hash table in a buffer.
Mike Stump1eb44332009-09-09 15:08:12 +00001658 llvm::SmallString<4096> MethodPool;
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001659 uint32_t BucketOffset;
Douglas Gregor83941df2009-04-25 17:48:32 +00001660 SelectorOffsets.resize(SelVector.size());
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001661 {
1662 PCHMethodPoolTrait Trait(*this);
1663 llvm::raw_svector_ostream Out(MethodPool);
1664 // Make sure that no bucket is at offset 0
Douglas Gregora67e58c2009-04-24 21:49:02 +00001665 clang::io::Emit32(Out, 0);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001666 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor83941df2009-04-25 17:48:32 +00001667
1668 // For every selector that we have seen but which was not
1669 // written into the hash table, write the selector itself and
1670 // record it's offset.
1671 for (unsigned I = 0, N = SelVector.size(); I != N; ++I)
1672 if (SelectorOffsets[I] == 0)
1673 Trait.EmitKey(Out, SelVector[I], 0);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001674 }
1675
1676 // Create a blob abbreviation
1677 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1678 Abbrev->Add(BitCodeAbbrevOp(pch::METHOD_POOL));
1679 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor83941df2009-04-25 17:48:32 +00001680 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001681 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1682 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(Abbrev);
1683
Douglas Gregor83941df2009-04-25 17:48:32 +00001684 // Write the method pool
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001685 RecordData Record;
1686 Record.push_back(pch::METHOD_POOL);
1687 Record.push_back(BucketOffset);
Douglas Gregor83941df2009-04-25 17:48:32 +00001688 Record.push_back(NumSelectorsInMethodPool);
Daniel Dunbarec312a12009-08-24 09:31:37 +00001689 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool.str());
Douglas Gregor83941df2009-04-25 17:48:32 +00001690
1691 // Create a blob abbreviation for the selector table offsets.
1692 Abbrev = new BitCodeAbbrev();
1693 Abbrev->Add(BitCodeAbbrevOp(pch::SELECTOR_OFFSETS));
1694 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // index
1695 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1696 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1697
1698 // Write the selector offsets table.
1699 Record.clear();
1700 Record.push_back(pch::SELECTOR_OFFSETS);
1701 Record.push_back(SelectorOffsets.size());
1702 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
1703 (const char *)&SelectorOffsets.front(),
1704 SelectorOffsets.size() * 4);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001705 }
1706}
1707
Douglas Gregor4fed3f42009-04-27 18:38:38 +00001708//===----------------------------------------------------------------------===//
1709// Identifier Table Serialization
1710//===----------------------------------------------------------------------===//
1711
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001712namespace {
Benjamin Kramerbd218282009-11-28 10:07:24 +00001713class PCHIdentifierTableTrait {
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001714 PCHWriter &Writer;
Douglas Gregor37e26842009-04-21 23:56:24 +00001715 Preprocessor &PP;
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001716
Douglas Gregora92193e2009-04-28 21:18:29 +00001717 /// \brief Determines whether this is an "interesting" identifier
1718 /// that needs a full IdentifierInfo structure written into the hash
1719 /// table.
1720 static bool isInterestingIdentifier(const IdentifierInfo *II) {
1721 return II->isPoisoned() ||
1722 II->isExtensionToken() ||
1723 II->hasMacroDefinition() ||
1724 II->getObjCOrBuiltinID() ||
1725 II->getFETokenInfo<void>();
1726 }
1727
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001728public:
1729 typedef const IdentifierInfo* key_type;
1730 typedef key_type key_type_ref;
Mike Stump1eb44332009-09-09 15:08:12 +00001731
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001732 typedef pch::IdentID data_type;
1733 typedef data_type data_type_ref;
Mike Stump1eb44332009-09-09 15:08:12 +00001734
1735 PCHIdentifierTableTrait(PCHWriter &Writer, Preprocessor &PP)
Douglas Gregor37e26842009-04-21 23:56:24 +00001736 : Writer(Writer), PP(PP) { }
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001737
1738 static unsigned ComputeHash(const IdentifierInfo* II) {
Daniel Dunbar2596e422009-10-17 23:52:28 +00001739 return llvm::HashString(II->getName());
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001740 }
Mike Stump1eb44332009-09-09 15:08:12 +00001741
1742 std::pair<unsigned,unsigned>
1743 EmitKeyDataLength(llvm::raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001744 pch::IdentID ID) {
Daniel Dunbare013d682009-10-18 20:26:12 +00001745 unsigned KeyLen = II->getLength() + 1;
Douglas Gregora92193e2009-04-28 21:18:29 +00001746 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
1747 if (isInterestingIdentifier(II)) {
Douglas Gregor5998da52009-04-28 21:32:13 +00001748 DataLen += 2; // 2 bytes for builtin ID, flags
Mike Stump1eb44332009-09-09 15:08:12 +00001749 if (II->hasMacroDefinition() &&
Douglas Gregora92193e2009-04-28 21:18:29 +00001750 !PP.getMacroInfo(const_cast<IdentifierInfo *>(II))->isBuiltinMacro())
Douglas Gregor5998da52009-04-28 21:32:13 +00001751 DataLen += 4;
Douglas Gregora92193e2009-04-28 21:18:29 +00001752 for (IdentifierResolver::iterator D = IdentifierResolver::begin(II),
1753 DEnd = IdentifierResolver::end();
1754 D != DEnd; ++D)
1755 DataLen += sizeof(pch::DeclID);
1756 }
Douglas Gregor668c1a42009-04-21 22:25:48 +00001757 clang::io::Emit16(Out, DataLen);
Douglas Gregor02fc7512009-04-28 20:01:51 +00001758 // We emit the key length after the data length so that every
1759 // string is preceded by a 16-bit length. This matches the PTH
1760 // format for storing identifiers.
Douglas Gregord6595a42009-04-25 21:04:17 +00001761 clang::io::Emit16(Out, KeyLen);
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001762 return std::make_pair(KeyLen, DataLen);
1763 }
Mike Stump1eb44332009-09-09 15:08:12 +00001764
1765 void EmitKey(llvm::raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001766 unsigned KeyLen) {
1767 // Record the location of the key data. This is used when generating
1768 // the mapping from persistent IDs to strings.
1769 Writer.SetIdentifierOffset(II, Out.tell());
Daniel Dunbare013d682009-10-18 20:26:12 +00001770 Out.write(II->getNameStart(), KeyLen);
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001771 }
Mike Stump1eb44332009-09-09 15:08:12 +00001772
1773 void EmitData(llvm::raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001774 pch::IdentID ID, unsigned) {
Douglas Gregora92193e2009-04-28 21:18:29 +00001775 if (!isInterestingIdentifier(II)) {
1776 clang::io::Emit32(Out, ID << 1);
1777 return;
1778 }
Douglas Gregor5998da52009-04-28 21:32:13 +00001779
Douglas Gregora92193e2009-04-28 21:18:29 +00001780 clang::io::Emit32(Out, (ID << 1) | 0x01);
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001781 uint32_t Bits = 0;
Mike Stump1eb44332009-09-09 15:08:12 +00001782 bool hasMacroDefinition =
1783 II->hasMacroDefinition() &&
Douglas Gregor37e26842009-04-21 23:56:24 +00001784 !PP.getMacroInfo(const_cast<IdentifierInfo *>(II))->isBuiltinMacro();
Douglas Gregor5998da52009-04-28 21:32:13 +00001785 Bits = (uint32_t)II->getObjCOrBuiltinID();
Daniel Dunbarb0b84382009-12-18 20:58:47 +00001786 Bits = (Bits << 1) | unsigned(hasMacroDefinition);
1787 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
1788 Bits = (Bits << 1) | unsigned(II->isPoisoned());
1789 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
Douglas Gregor5998da52009-04-28 21:32:13 +00001790 clang::io::Emit16(Out, Bits);
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001791
Douglas Gregor37e26842009-04-21 23:56:24 +00001792 if (hasMacroDefinition)
Douglas Gregor5998da52009-04-28 21:32:13 +00001793 clang::io::Emit32(Out, Writer.getMacroOffset(II));
Douglas Gregor37e26842009-04-21 23:56:24 +00001794
Douglas Gregor668c1a42009-04-21 22:25:48 +00001795 // Emit the declaration IDs in reverse order, because the
1796 // IdentifierResolver provides the declarations as they would be
1797 // visible (e.g., the function "stat" would come before the struct
1798 // "stat"), but IdentifierResolver::AddDeclToIdentifierChain()
1799 // adds declarations to the end of the list (so we need to see the
1800 // struct "status" before the function "status").
Mike Stump1eb44332009-09-09 15:08:12 +00001801 llvm::SmallVector<Decl *, 16> Decls(IdentifierResolver::begin(II),
Douglas Gregor668c1a42009-04-21 22:25:48 +00001802 IdentifierResolver::end());
1803 for (llvm::SmallVector<Decl *, 16>::reverse_iterator D = Decls.rbegin(),
1804 DEnd = Decls.rend();
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001805 D != DEnd; ++D)
Douglas Gregor668c1a42009-04-21 22:25:48 +00001806 clang::io::Emit32(Out, Writer.getDeclID(*D));
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001807 }
1808};
1809} // end anonymous namespace
1810
Douglas Gregorafaf3082009-04-11 00:14:32 +00001811/// \brief Write the identifier table into the PCH file.
1812///
1813/// The identifier table consists of a blob containing string data
1814/// (the actual identifiers themselves) and a separate "offsets" index
1815/// that maps identifier IDs to locations within the blob.
Douglas Gregor37e26842009-04-21 23:56:24 +00001816void PCHWriter::WriteIdentifierTable(Preprocessor &PP) {
Douglas Gregorafaf3082009-04-11 00:14:32 +00001817 using namespace llvm;
1818
1819 // Create and write out the blob that contains the identifier
1820 // strings.
Douglas Gregorafaf3082009-04-11 00:14:32 +00001821 {
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001822 OnDiskChainedHashTableGenerator<PCHIdentifierTableTrait> Generator;
Mike Stump1eb44332009-09-09 15:08:12 +00001823
Douglas Gregor92b059e2009-04-28 20:33:11 +00001824 // Look for any identifiers that were named while processing the
1825 // headers, but are otherwise not needed. We add these to the hash
1826 // table to enable checking of the predefines buffer in the case
1827 // where the user adds new macro definitions when building the PCH
1828 // file.
1829 for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
1830 IDEnd = PP.getIdentifierTable().end();
1831 ID != IDEnd; ++ID)
1832 getIdentifierRef(ID->second);
1833
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001834 // Create the on-disk hash table representation.
Douglas Gregor92b059e2009-04-28 20:33:11 +00001835 IdentifierOffsets.resize(IdentifierIDs.size());
Douglas Gregorafaf3082009-04-11 00:14:32 +00001836 for (llvm::DenseMap<const IdentifierInfo *, pch::IdentID>::iterator
1837 ID = IdentifierIDs.begin(), IDEnd = IdentifierIDs.end();
1838 ID != IDEnd; ++ID) {
1839 assert(ID->first && "NULL identifier in identifier table");
Douglas Gregor02fc7512009-04-28 20:01:51 +00001840 Generator.insert(ID->first, ID->second);
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001841 }
Douglas Gregorafaf3082009-04-11 00:14:32 +00001842
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001843 // Create the on-disk hash table in a buffer.
Mike Stump1eb44332009-09-09 15:08:12 +00001844 llvm::SmallString<4096> IdentifierTable;
Douglas Gregor668c1a42009-04-21 22:25:48 +00001845 uint32_t BucketOffset;
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001846 {
Douglas Gregor37e26842009-04-21 23:56:24 +00001847 PCHIdentifierTableTrait Trait(*this, PP);
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001848 llvm::raw_svector_ostream Out(IdentifierTable);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00001849 // Make sure that no bucket is at offset 0
Douglas Gregora67e58c2009-04-24 21:49:02 +00001850 clang::io::Emit32(Out, 0);
Douglas Gregor668c1a42009-04-21 22:25:48 +00001851 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregorafaf3082009-04-11 00:14:32 +00001852 }
1853
1854 // Create a blob abbreviation
1855 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1856 Abbrev->Add(BitCodeAbbrevOp(pch::IDENTIFIER_TABLE));
Douglas Gregor668c1a42009-04-21 22:25:48 +00001857 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor3251ceb2009-04-20 20:36:09 +00001858 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Douglas Gregorc9490c02009-04-16 22:23:12 +00001859 unsigned IDTableAbbrev = Stream.EmitAbbrev(Abbrev);
Douglas Gregorafaf3082009-04-11 00:14:32 +00001860
1861 // Write the identifier table
1862 RecordData Record;
1863 Record.push_back(pch::IDENTIFIER_TABLE);
Douglas Gregor668c1a42009-04-21 22:25:48 +00001864 Record.push_back(BucketOffset);
Daniel Dunbarec312a12009-08-24 09:31:37 +00001865 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable.str());
Douglas Gregorafaf3082009-04-11 00:14:32 +00001866 }
1867
1868 // Write the offsets table for identifier IDs.
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00001869 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1870 Abbrev->Add(BitCodeAbbrevOp(pch::IDENTIFIER_OFFSET));
1871 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
1872 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1873 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
1874
1875 RecordData Record;
1876 Record.push_back(pch::IDENTIFIER_OFFSET);
1877 Record.push_back(IdentifierOffsets.size());
1878 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
1879 (const char *)&IdentifierOffsets.front(),
1880 IdentifierOffsets.size() * sizeof(uint32_t));
Douglas Gregorafaf3082009-04-11 00:14:32 +00001881}
1882
Douglas Gregor4fed3f42009-04-27 18:38:38 +00001883//===----------------------------------------------------------------------===//
1884// General Serialization Routines
1885//===----------------------------------------------------------------------===//
1886
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001887/// \brief Write a record containing the given attributes.
1888void PCHWriter::WriteAttributeRecord(const Attr *Attr) {
1889 RecordData Record;
1890 for (; Attr; Attr = Attr->getNext()) {
Anton Korobeynikov82d0a412010-01-10 12:58:08 +00001891 Record.push_back(Attr->getKind()); // FIXME: stable encoding, target attrs
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001892 Record.push_back(Attr->isInherited());
1893 switch (Attr->getKind()) {
Anton Korobeynikov82d0a412010-01-10 12:58:08 +00001894 default:
1895 assert(0 && "Does not support PCH writing for this attribute yet!");
1896 break;
Sean Hunt387475d2010-06-16 23:43:53 +00001897 case attr::Alias:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001898 AddString(cast<AliasAttr>(Attr)->getAliasee(), Record);
1899 break;
1900
Sean Hunt387475d2010-06-16 23:43:53 +00001901 case attr::AlignMac68k:
Daniel Dunbar4e9255f2010-05-27 02:25:39 +00001902 break;
1903
Sean Hunt387475d2010-06-16 23:43:53 +00001904 case attr::Aligned:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001905 Record.push_back(cast<AlignedAttr>(Attr)->getAlignment());
1906 break;
1907
Sean Hunt387475d2010-06-16 23:43:53 +00001908 case attr::AlwaysInline:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001909 break;
Mike Stump1eb44332009-09-09 15:08:12 +00001910
Sean Hunt387475d2010-06-16 23:43:53 +00001911 case attr::AnalyzerNoReturn:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001912 break;
1913
Sean Hunt387475d2010-06-16 23:43:53 +00001914 case attr::Annotate:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001915 AddString(cast<AnnotateAttr>(Attr)->getAnnotation(), Record);
1916 break;
1917
Sean Hunt387475d2010-06-16 23:43:53 +00001918 case attr::AsmLabel:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001919 AddString(cast<AsmLabelAttr>(Attr)->getLabel(), Record);
1920 break;
1921
Sean Hunt387475d2010-06-16 23:43:53 +00001922 case attr::BaseCheck:
Sean Hunt7725e672009-11-25 04:20:27 +00001923 break;
1924
Sean Hunt387475d2010-06-16 23:43:53 +00001925 case attr::Blocks:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001926 Record.push_back(cast<BlocksAttr>(Attr)->getType()); // FIXME: stable
1927 break;
1928
Sean Hunt387475d2010-06-16 23:43:53 +00001929 case attr::CDecl:
Eli Friedman8f4c59e2009-11-09 18:38:53 +00001930 break;
1931
Sean Hunt387475d2010-06-16 23:43:53 +00001932 case attr::Cleanup:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001933 AddDeclRef(cast<CleanupAttr>(Attr)->getFunctionDecl(), Record);
1934 break;
1935
Sean Hunt387475d2010-06-16 23:43:53 +00001936 case attr::Const:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001937 break;
1938
Sean Hunt387475d2010-06-16 23:43:53 +00001939 case attr::Constructor:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001940 Record.push_back(cast<ConstructorAttr>(Attr)->getPriority());
1941 break;
1942
Sean Hunt387475d2010-06-16 23:43:53 +00001943 case attr::DLLExport:
1944 case attr::DLLImport:
1945 case attr::Deprecated:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001946 break;
1947
Sean Hunt387475d2010-06-16 23:43:53 +00001948 case attr::Destructor:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001949 Record.push_back(cast<DestructorAttr>(Attr)->getPriority());
1950 break;
1951
Sean Hunt387475d2010-06-16 23:43:53 +00001952 case attr::FastCall:
1953 case attr::Final:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001954 break;
1955
Sean Hunt387475d2010-06-16 23:43:53 +00001956 case attr::Format: {
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001957 const FormatAttr *Format = cast<FormatAttr>(Attr);
1958 AddString(Format->getType(), Record);
1959 Record.push_back(Format->getFormatIdx());
1960 Record.push_back(Format->getFirstArg());
1961 break;
1962 }
1963
Sean Hunt387475d2010-06-16 23:43:53 +00001964 case attr::FormatArg: {
Fariborz Jahanian5b160922009-05-20 17:41:43 +00001965 const FormatArgAttr *Format = cast<FormatArgAttr>(Attr);
1966 Record.push_back(Format->getFormatIdx());
1967 break;
1968 }
1969
Sean Hunt387475d2010-06-16 23:43:53 +00001970 case attr::Sentinel : {
Fariborz Jahanian5b530052009-05-13 18:09:35 +00001971 const SentinelAttr *Sentinel = cast<SentinelAttr>(Attr);
1972 Record.push_back(Sentinel->getSentinel());
1973 Record.push_back(Sentinel->getNullPos());
1974 break;
1975 }
Mike Stump1eb44332009-09-09 15:08:12 +00001976
Sean Hunt387475d2010-06-16 23:43:53 +00001977 case attr::GNUInline:
1978 case attr::Hiding:
1979 case attr::IBAction:
1980 case attr::IBOutlet:
1981 case attr::Malloc:
1982 case attr::NoDebug:
1983 case attr::NoInline:
1984 case attr::NoReturn:
1985 case attr::NoThrow:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001986 break;
1987
Sean Hunt387475d2010-06-16 23:43:53 +00001988 case attr::IBOutletCollection: {
Ted Kremenek857e9182010-05-19 17:38:06 +00001989 const IBOutletCollectionAttr *ICA = cast<IBOutletCollectionAttr>(Attr);
1990 AddDeclRef(ICA->getClass(), Record);
1991 break;
1992 }
1993
Sean Hunt387475d2010-06-16 23:43:53 +00001994 case attr::NonNull: {
Douglas Gregor68a2eb02009-04-15 21:30:51 +00001995 const NonNullAttr *NonNull = cast<NonNullAttr>(Attr);
1996 Record.push_back(NonNull->size());
1997 Record.insert(Record.end(), NonNull->begin(), NonNull->end());
1998 break;
1999 }
2000
Sean Hunt387475d2010-06-16 23:43:53 +00002001 case attr::CFReturnsNotRetained:
2002 case attr::CFReturnsRetained:
2003 case attr::NSReturnsNotRetained:
2004 case attr::NSReturnsRetained:
2005 case attr::ObjCException:
2006 case attr::ObjCNSObject:
2007 case attr::Overloadable:
2008 case attr::Override:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002009 break;
2010
Sean Hunt387475d2010-06-16 23:43:53 +00002011 case attr::MaxFieldAlignment:
Daniel Dunbar8a2c92c2010-05-27 01:12:46 +00002012 Record.push_back(cast<MaxFieldAlignmentAttr>(Attr)->getAlignment());
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002013 break;
2014
Sean Hunt387475d2010-06-16 23:43:53 +00002015 case attr::Packed:
Anders Carlssona860e752009-08-08 18:23:56 +00002016 break;
Mike Stump1eb44332009-09-09 15:08:12 +00002017
Sean Hunt387475d2010-06-16 23:43:53 +00002018 case attr::Pure:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002019 break;
2020
Sean Hunt387475d2010-06-16 23:43:53 +00002021 case attr::Regparm:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002022 Record.push_back(cast<RegparmAttr>(Attr)->getNumParams());
2023 break;
Mike Stump1eb44332009-09-09 15:08:12 +00002024
Sean Hunt387475d2010-06-16 23:43:53 +00002025 case attr::ReqdWorkGroupSize:
Nate Begeman6f3d8382009-06-26 06:32:41 +00002026 Record.push_back(cast<ReqdWorkGroupSizeAttr>(Attr)->getXDim());
2027 Record.push_back(cast<ReqdWorkGroupSizeAttr>(Attr)->getYDim());
2028 Record.push_back(cast<ReqdWorkGroupSizeAttr>(Attr)->getZDim());
2029 break;
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002030
Sean Hunt387475d2010-06-16 23:43:53 +00002031 case attr::Section:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002032 AddString(cast<SectionAttr>(Attr)->getName(), Record);
2033 break;
2034
Sean Hunt387475d2010-06-16 23:43:53 +00002035 case attr::StdCall:
2036 case attr::TransparentUnion:
2037 case attr::Unavailable:
2038 case attr::Unused:
2039 case attr::Used:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002040 break;
2041
Sean Hunt387475d2010-06-16 23:43:53 +00002042 case attr::Visibility:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002043 // FIXME: stable encoding
Mike Stump1eb44332009-09-09 15:08:12 +00002044 Record.push_back(cast<VisibilityAttr>(Attr)->getVisibility());
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002045 break;
2046
Sean Hunt387475d2010-06-16 23:43:53 +00002047 case attr::WarnUnusedResult:
2048 case attr::Weak:
2049 case attr::WeakRef:
2050 case attr::WeakImport:
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002051 break;
2052 }
2053 }
2054
Douglas Gregorc9490c02009-04-16 22:23:12 +00002055 Stream.EmitRecord(pch::DECL_ATTR, Record);
Douglas Gregor68a2eb02009-04-15 21:30:51 +00002056}
2057
2058void PCHWriter::AddString(const std::string &Str, RecordData &Record) {
2059 Record.push_back(Str.size());
2060 Record.insert(Record.end(), Str.begin(), Str.end());
2061}
2062
Douglas Gregor3251ceb2009-04-20 20:36:09 +00002063/// \brief Note that the identifier II occurs at the given offset
2064/// within the identifier table.
2065void PCHWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
Douglas Gregor2b3a5a82009-04-25 19:10:14 +00002066 IdentifierOffsets[IdentifierIDs[II] - 1] = Offset;
Douglas Gregor3251ceb2009-04-20 20:36:09 +00002067}
2068
Douglas Gregor83941df2009-04-25 17:48:32 +00002069/// \brief Note that the selector Sel occurs at the given offset
2070/// within the method pool/selector table.
2071void PCHWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
2072 unsigned ID = SelectorIDs[Sel];
2073 assert(ID && "Unknown selector");
2074 SelectorOffsets[ID - 1] = Offset;
2075}
2076
Mike Stump1eb44332009-09-09 15:08:12 +00002077PCHWriter::PCHWriter(llvm::BitstreamWriter &Stream)
2078 : Stream(Stream), NextTypeID(pch::NUM_PREDEF_TYPE_IDS),
Argyrios Kyrtzidis919e6932010-06-28 22:28:35 +00002079 CollectedStmts(&StmtsToEmit), NumStatements(0), NumMacros(0),
2080 NumLexicalDeclContexts(0), NumVisibleDeclContexts(0) { }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002081
Douglas Gregore650c8c2009-07-07 00:12:59 +00002082void PCHWriter::WritePCH(Sema &SemaRef, MemorizeStatCalls *StatCalls,
Sebastian Redla93e3b52010-07-08 22:01:51 +00002083 const PCHReader *Chain, const char *isysroot) {
Douglas Gregor2cf26342009-04-09 22:27:44 +00002084 // Emit the file header.
Douglas Gregorc9490c02009-04-16 22:23:12 +00002085 Stream.Emit((unsigned)'C', 8);
2086 Stream.Emit((unsigned)'P', 8);
2087 Stream.Emit((unsigned)'C', 8);
2088 Stream.Emit((unsigned)'H', 8);
Mike Stump1eb44332009-09-09 15:08:12 +00002089
Chris Lattnerb145b1e2009-04-26 22:26:21 +00002090 WriteBlockInfoBlock();
Douglas Gregor2cf26342009-04-09 22:27:44 +00002091
Sebastian Redl1dc13a12010-07-12 22:02:52 +00002092 if (Chain)
2093 WritePCHChain(SemaRef, StatCalls, Chain, isysroot);
2094 else
2095 WritePCHCore(SemaRef, StatCalls, isysroot);
2096}
2097
2098void PCHWriter::WritePCHCore(Sema &SemaRef, MemorizeStatCalls *StatCalls,
2099 const char *isysroot) {
2100 using namespace llvm;
2101
2102 ASTContext &Context = SemaRef.Context;
2103 Preprocessor &PP = SemaRef.PP;
2104
Douglas Gregor2cf26342009-04-09 22:27:44 +00002105 // The translation unit is the first declaration we'll emit.
2106 DeclIDs[Context.getTranslationUnitDecl()] = 1;
Douglas Gregor61d60ee2009-10-17 00:13:19 +00002107 DeclTypesToEmit.push(Context.getTranslationUnitDecl());
Douglas Gregor2cf26342009-04-09 22:27:44 +00002108
Douglas Gregor2deaea32009-04-22 18:49:13 +00002109 // Make sure that we emit IdentifierInfos (and any attached
2110 // declarations) for builtins.
2111 {
2112 IdentifierTable &Table = PP.getIdentifierTable();
2113 llvm::SmallVector<const char *, 32> BuiltinNames;
2114 Context.BuiltinInfo.GetBuiltinNames(BuiltinNames,
2115 Context.getLangOptions().NoBuiltin);
2116 for (unsigned I = 0, N = BuiltinNames.size(); I != N; ++I)
2117 getIdentifierRef(&Table.get(BuiltinNames[I]));
2118 }
2119
Chris Lattner63d65f82009-09-08 18:19:27 +00002120 // Build a record containing all of the tentative definitions in this file, in
Sebastian Redle9d12b62010-01-31 22:27:38 +00002121 // TentativeDefinitions order. Generally, this record will be empty for
Chris Lattner63d65f82009-09-08 18:19:27 +00002122 // headers.
Douglas Gregor4c0e86b2009-04-22 22:02:47 +00002123 RecordData TentativeDefinitions;
Sebastian Redle9d12b62010-01-31 22:27:38 +00002124 for (unsigned i = 0, e = SemaRef.TentativeDefinitions.size(); i != e; ++i) {
2125 AddDeclRef(SemaRef.TentativeDefinitions[i], TentativeDefinitions);
Chris Lattner63d65f82009-09-08 18:19:27 +00002126 }
Douglas Gregor4c0e86b2009-04-22 22:02:47 +00002127
Tanya Lattnere6bbc012010-02-12 00:07:30 +00002128 // Build a record containing all of the static unused functions in this file.
2129 RecordData UnusedStaticFuncs;
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00002130 for (unsigned i=0, e = SemaRef.UnusedStaticFuncs.size(); i !=e; ++i)
Tanya Lattnere6bbc012010-02-12 00:07:30 +00002131 AddDeclRef(SemaRef.UnusedStaticFuncs[i], UnusedStaticFuncs);
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00002132
Douglas Gregor14c22f22009-04-22 22:18:58 +00002133 // Build a record containing all of the locally-scoped external
2134 // declarations in this header file. Generally, this record will be
2135 // empty.
2136 RecordData LocallyScopedExternalDecls;
Chris Lattner63d65f82009-09-08 18:19:27 +00002137 // FIXME: This is filling in the PCH file in densemap order which is
2138 // nondeterminstic!
Mike Stump1eb44332009-09-09 15:08:12 +00002139 for (llvm::DenseMap<DeclarationName, NamedDecl *>::iterator
Douglas Gregor14c22f22009-04-22 22:18:58 +00002140 TD = SemaRef.LocallyScopedExternalDecls.begin(),
2141 TDEnd = SemaRef.LocallyScopedExternalDecls.end();
2142 TD != TDEnd; ++TD)
2143 AddDeclRef(TD->second, LocallyScopedExternalDecls);
2144
Douglas Gregorb81c1702009-04-27 20:06:05 +00002145 // Build a record containing all of the ext_vector declarations.
2146 RecordData ExtVectorDecls;
2147 for (unsigned I = 0, N = SemaRef.ExtVectorDecls.size(); I != N; ++I)
2148 AddDeclRef(SemaRef.ExtVectorDecls[I], ExtVectorDecls);
2149
Argyrios Kyrtzidisd455add2010-07-06 15:37:04 +00002150 // Build a record containing all of the VTable uses information.
2151 RecordData VTableUses;
2152 VTableUses.push_back(SemaRef.VTableUses.size());
2153 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
2154 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
2155 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
2156 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
2157 }
2158
2159 // Build a record containing all of dynamic classes declarations.
2160 RecordData DynamicClasses;
2161 for (unsigned I = 0, N = SemaRef.DynamicClasses.size(); I != N; ++I)
2162 AddDeclRef(SemaRef.DynamicClasses[I], DynamicClasses);
2163
Douglas Gregor2cf26342009-04-09 22:27:44 +00002164 // Write the remaining PCH contents.
Douglas Gregorad1de002009-04-18 05:55:16 +00002165 RecordData Record;
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00002166 Stream.EnterSubblock(pch::PCH_BLOCK_ID, 5);
Sebastian Redl1dc13a12010-07-12 22:02:52 +00002167 WriteMetadata(Context, 0, isysroot);
2168 WriteLanguageOptions(Context.getLangOptions());
Douglas Gregore650c8c2009-07-07 00:12:59 +00002169 if (StatCalls && !isysroot)
Douglas Gregordd41ed52010-07-12 23:48:14 +00002170 WriteStatCache(*StatCalls);
Douglas Gregore650c8c2009-07-07 00:12:59 +00002171 WriteSourceManagerBlock(Context.getSourceManager(), PP, isysroot);
Steve Naroffc15cb2a2009-07-18 15:33:26 +00002172 // Write the record of special types.
2173 Record.clear();
Mike Stump1eb44332009-09-09 15:08:12 +00002174
Steve Naroffc15cb2a2009-07-18 15:33:26 +00002175 AddTypeRef(Context.getBuiltinVaListType(), Record);
2176 AddTypeRef(Context.getObjCIdType(), Record);
2177 AddTypeRef(Context.getObjCSelType(), Record);
2178 AddTypeRef(Context.getObjCProtoType(), Record);
2179 AddTypeRef(Context.getObjCClassType(), Record);
2180 AddTypeRef(Context.getRawCFConstantStringType(), Record);
2181 AddTypeRef(Context.getRawObjCFastEnumerationStateType(), Record);
2182 AddTypeRef(Context.getFILEType(), Record);
Mike Stump782fa302009-07-28 02:25:19 +00002183 AddTypeRef(Context.getjmp_bufType(), Record);
2184 AddTypeRef(Context.getsigjmp_bufType(), Record);
Douglas Gregord1571ac2009-08-21 00:27:50 +00002185 AddTypeRef(Context.ObjCIdRedefinitionType, Record);
2186 AddTypeRef(Context.ObjCClassRedefinitionType, Record);
Mike Stumpadaaad32009-10-20 02:12:22 +00002187 AddTypeRef(Context.getRawBlockdescriptorType(), Record);
Mike Stump083c25e2009-10-22 00:49:09 +00002188 AddTypeRef(Context.getRawBlockdescriptorExtendedType(), Record);
Fariborz Jahanian2bb5dda2010-04-23 17:41:07 +00002189 AddTypeRef(Context.ObjCSelRedefinitionType, Record);
2190 AddTypeRef(Context.getRawNSConstantStringType(), Record);
Argyrios Kyrtzidis00611382010-07-04 21:44:19 +00002191 Record.push_back(Context.isInt128Installed());
Steve Naroffc15cb2a2009-07-18 15:33:26 +00002192 Stream.EmitRecord(pch::SPECIAL_TYPES, Record);
Mike Stump1eb44332009-09-09 15:08:12 +00002193
Douglas Gregor366809a2009-04-26 03:49:13 +00002194 // Keep writing types and declarations until all types and
2195 // declarations have been written.
Douglas Gregor61d60ee2009-10-17 00:13:19 +00002196 Stream.EnterSubblock(pch::DECLTYPES_BLOCK_ID, 3);
2197 WriteDeclsBlockAbbrevs();
2198 while (!DeclTypesToEmit.empty()) {
2199 DeclOrType DOT = DeclTypesToEmit.front();
2200 DeclTypesToEmit.pop();
2201 if (DOT.isType())
2202 WriteType(DOT.getType());
2203 else
2204 WriteDecl(Context, DOT.getDecl());
2205 }
2206 Stream.ExitBlock();
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00002207
Douglas Gregor813a97b2009-10-17 17:25:45 +00002208 WritePreprocessor(PP);
Douglas Gregorf0aaf7a2009-04-24 21:10:55 +00002209 WriteMethodPool(SemaRef);
Douglas Gregor37e26842009-04-21 23:56:24 +00002210 WriteIdentifierTable(PP);
Douglas Gregor8f5dc7f2009-04-25 18:35:21 +00002211
2212 // Write the type offsets array
2213 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2214 Abbrev->Add(BitCodeAbbrevOp(pch::TYPE_OFFSET));
2215 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
2216 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
2217 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2218 Record.clear();
2219 Record.push_back(pch::TYPE_OFFSET);
2220 Record.push_back(TypeOffsets.size());
2221 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record,
Mike Stump1eb44332009-09-09 15:08:12 +00002222 (const char *)&TypeOffsets.front(),
Chris Lattnerc732f5a2009-04-27 18:24:17 +00002223 TypeOffsets.size() * sizeof(TypeOffsets[0]));
Mike Stump1eb44332009-09-09 15:08:12 +00002224
Douglas Gregor8f5dc7f2009-04-25 18:35:21 +00002225 // Write the declaration offsets array
2226 Abbrev = new BitCodeAbbrev();
2227 Abbrev->Add(BitCodeAbbrevOp(pch::DECL_OFFSET));
2228 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
2229 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
2230 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2231 Record.clear();
2232 Record.push_back(pch::DECL_OFFSET);
2233 Record.push_back(DeclOffsets.size());
2234 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record,
Mike Stump1eb44332009-09-09 15:08:12 +00002235 (const char *)&DeclOffsets.front(),
Chris Lattnerc732f5a2009-04-27 18:24:17 +00002236 DeclOffsets.size() * sizeof(DeclOffsets[0]));
Douglas Gregorad1de002009-04-18 05:55:16 +00002237
Douglas Gregor4c0e86b2009-04-22 22:02:47 +00002238 // Write the record containing external, unnamed definitions.
Douglas Gregorfdd01722009-04-14 00:24:19 +00002239 if (!ExternalDefinitions.empty())
Douglas Gregorc9490c02009-04-16 22:23:12 +00002240 Stream.EmitRecord(pch::EXTERNAL_DEFINITIONS, ExternalDefinitions);
Douglas Gregor4c0e86b2009-04-22 22:02:47 +00002241
2242 // Write the record containing tentative definitions.
2243 if (!TentativeDefinitions.empty())
2244 Stream.EmitRecord(pch::TENTATIVE_DEFINITIONS, TentativeDefinitions);
Douglas Gregor14c22f22009-04-22 22:18:58 +00002245
Tanya Lattnere6bbc012010-02-12 00:07:30 +00002246 // Write the record containing unused static functions.
2247 if (!UnusedStaticFuncs.empty())
2248 Stream.EmitRecord(pch::UNUSED_STATIC_FUNCS, UnusedStaticFuncs);
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00002249
Douglas Gregor14c22f22009-04-22 22:18:58 +00002250 // Write the record containing locally-scoped external definitions.
2251 if (!LocallyScopedExternalDecls.empty())
Mike Stump1eb44332009-09-09 15:08:12 +00002252 Stream.EmitRecord(pch::LOCALLY_SCOPED_EXTERNAL_DECLS,
Douglas Gregor14c22f22009-04-22 22:18:58 +00002253 LocallyScopedExternalDecls);
Douglas Gregorb81c1702009-04-27 20:06:05 +00002254
2255 // Write the record containing ext_vector type names.
2256 if (!ExtVectorDecls.empty())
2257 Stream.EmitRecord(pch::EXT_VECTOR_DECLS, ExtVectorDecls);
Mike Stump1eb44332009-09-09 15:08:12 +00002258
Argyrios Kyrtzidisd455add2010-07-06 15:37:04 +00002259 // Write the record containing VTable uses information.
2260 if (!VTableUses.empty())
2261 Stream.EmitRecord(pch::VTABLE_USES, VTableUses);
2262
2263 // Write the record containing dynamic classes declarations.
2264 if (!DynamicClasses.empty())
2265 Stream.EmitRecord(pch::DYNAMIC_CLASSES, DynamicClasses);
2266
Douglas Gregor3e1af842009-04-17 22:13:46 +00002267 // Some simple statistics
Douglas Gregorad1de002009-04-18 05:55:16 +00002268 Record.clear();
Douglas Gregor3e1af842009-04-17 22:13:46 +00002269 Record.push_back(NumStatements);
Douglas Gregor37e26842009-04-21 23:56:24 +00002270 Record.push_back(NumMacros);
Douglas Gregor25123082009-04-22 22:34:57 +00002271 Record.push_back(NumLexicalDeclContexts);
2272 Record.push_back(NumVisibleDeclContexts);
Douglas Gregor3e1af842009-04-17 22:13:46 +00002273 Stream.EmitRecord(pch::STATISTICS, Record);
Douglas Gregorc9490c02009-04-16 22:23:12 +00002274 Stream.ExitBlock();
Douglas Gregor2cf26342009-04-09 22:27:44 +00002275}
2276
Sebastian Redl1dc13a12010-07-12 22:02:52 +00002277void PCHWriter::WritePCHChain(Sema &SemaRef, MemorizeStatCalls *StatCalls,
2278 const PCHReader *Chain, const char *isysroot) {
2279 using namespace llvm;
2280
2281 ASTContext &Context = SemaRef.Context;
2282 Preprocessor &PP = SemaRef.PP;
2283 (void)PP;
2284
2285 RecordData Record;
2286 Stream.EnterSubblock(pch::PCH_BLOCK_ID, 5);
2287 WriteMetadata(Context, Chain, isysroot);
2288 // FIXME: StatCache
2289 // FIXME: Source manager block
2290
2291 // The special types are in the chained PCH.
2292
2293 // We don't start with the translation unit, but with its decls that
2294 // don't come from the other PCH.
2295 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
2296 // FIXME: We don't want to iterate over everything here, because it needlessly
2297 // deserializes the entire original PCH. Instead we only want to iterate over
2298 // the stuff that's already there.
2299 // All in good time, though.
2300 for (DeclContext::decl_iterator I = TU->decls_begin(), E = TU->decls_end();
2301 I != E; ++I) {
2302 if ((*I)->getPCHLevel() == 0) {
2303 (*I)->dump();
2304 DeclTypesToEmit.push(*I);
2305 }
2306 }
2307
2308 Stream.EnterSubblock(pch::DECLTYPES_BLOCK_ID, 3);
2309 WriteDeclsBlockAbbrevs();
2310 while (!DeclTypesToEmit.empty()) {
2311 DeclOrType DOT = DeclTypesToEmit.front();
2312 DeclTypesToEmit.pop();
2313 if (DOT.isType())
2314 WriteType(DOT.getType());
2315 else
2316 WriteDecl(Context, DOT.getDecl());
2317 }
2318 Stream.ExitBlock();
2319
2320 // FIXME: Preprocessor
2321 // FIXME: Method pool
2322 // FIXME: Identifier table
2323 // FIXME: Type offsets
2324 // FIXME: Declaration offsets
2325 // FIXME: External unnamed definitions
2326 // FIXME: Tentative definitions
2327 // FIXME: Unused static functions
2328 // FIXME: Locally-scoped external definitions
2329 // FIXME: ext_vector type names
2330 // FIXME: Dynamic classes declarations
2331 // FIXME: Statistics
2332 Stream.ExitBlock();
2333}
2334
Douglas Gregor2cf26342009-04-09 22:27:44 +00002335void PCHWriter::AddSourceLocation(SourceLocation Loc, RecordData &Record) {
2336 Record.push_back(Loc.getRawEncoding());
2337}
2338
Chris Lattner6ad9ac02010-05-07 21:43:38 +00002339void PCHWriter::AddSourceRange(SourceRange Range, RecordData &Record) {
2340 AddSourceLocation(Range.getBegin(), Record);
2341 AddSourceLocation(Range.getEnd(), Record);
2342}
2343
Douglas Gregor2cf26342009-04-09 22:27:44 +00002344void PCHWriter::AddAPInt(const llvm::APInt &Value, RecordData &Record) {
2345 Record.push_back(Value.getBitWidth());
2346 unsigned N = Value.getNumWords();
2347 const uint64_t* Words = Value.getRawData();
2348 for (unsigned I = 0; I != N; ++I)
2349 Record.push_back(Words[I]);
2350}
2351
Douglas Gregor0a2b45e2009-04-13 18:14:40 +00002352void PCHWriter::AddAPSInt(const llvm::APSInt &Value, RecordData &Record) {
2353 Record.push_back(Value.isUnsigned());
2354 AddAPInt(Value, Record);
2355}
2356
Douglas Gregor17fc2232009-04-14 21:55:33 +00002357void PCHWriter::AddAPFloat(const llvm::APFloat &Value, RecordData &Record) {
2358 AddAPInt(Value.bitcastToAPInt(), Record);
2359}
2360
Douglas Gregor2cf26342009-04-09 22:27:44 +00002361void PCHWriter::AddIdentifierRef(const IdentifierInfo *II, RecordData &Record) {
Douglas Gregor2deaea32009-04-22 18:49:13 +00002362 Record.push_back(getIdentifierRef(II));
2363}
2364
2365pch::IdentID PCHWriter::getIdentifierRef(const IdentifierInfo *II) {
2366 if (II == 0)
2367 return 0;
Douglas Gregorafaf3082009-04-11 00:14:32 +00002368
2369 pch::IdentID &ID = IdentifierIDs[II];
2370 if (ID == 0)
2371 ID = IdentifierIDs.size();
Douglas Gregor2deaea32009-04-22 18:49:13 +00002372 return ID;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002373}
2374
Douglas Gregor6a5a23f2010-03-19 21:51:54 +00002375pch::IdentID PCHWriter::getMacroDefinitionID(MacroDefinition *MD) {
2376 if (MD == 0)
2377 return 0;
2378
2379 pch::IdentID &ID = MacroDefinitions[MD];
2380 if (ID == 0)
2381 ID = MacroDefinitions.size();
2382 return ID;
2383}
2384
Steve Naroff90cd1bb2009-04-23 10:39:46 +00002385void PCHWriter::AddSelectorRef(const Selector SelRef, RecordData &Record) {
2386 if (SelRef.getAsOpaquePtr() == 0) {
2387 Record.push_back(0);
2388 return;
2389 }
2390
2391 pch::SelectorID &SID = SelectorIDs[SelRef];
2392 if (SID == 0) {
2393 SID = SelectorIDs.size();
2394 SelVector.push_back(SelRef);
2395 }
2396 Record.push_back(SID);
2397}
2398
Chris Lattnerd2598362010-05-10 00:25:06 +00002399void PCHWriter::AddCXXTemporary(const CXXTemporary *Temp, RecordData &Record) {
2400 AddDeclRef(Temp->getDestructor(), Record);
2401}
2402
Argyrios Kyrtzidis44f8c372010-06-22 09:54:59 +00002403void PCHWriter::AddTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind,
2404 const TemplateArgumentLocInfo &Arg,
2405 RecordData &Record) {
2406 switch (Kind) {
John McCall833ca992009-10-29 08:12:44 +00002407 case TemplateArgument::Expression:
Argyrios Kyrtzidis44f8c372010-06-22 09:54:59 +00002408 AddStmt(Arg.getAsExpr());
John McCall833ca992009-10-29 08:12:44 +00002409 break;
2410 case TemplateArgument::Type:
Argyrios Kyrtzidis44f8c372010-06-22 09:54:59 +00002411 AddTypeSourceInfo(Arg.getAsTypeSourceInfo(), Record);
John McCall833ca992009-10-29 08:12:44 +00002412 break;
Douglas Gregor788cd062009-11-11 01:00:40 +00002413 case TemplateArgument::Template:
Argyrios Kyrtzidis17cfded2010-06-28 09:31:42 +00002414 AddSourceRange(Arg.getTemplateQualifierRange(), Record);
2415 AddSourceLocation(Arg.getTemplateNameLoc(), Record);
Douglas Gregor788cd062009-11-11 01:00:40 +00002416 break;
John McCall833ca992009-10-29 08:12:44 +00002417 case TemplateArgument::Null:
2418 case TemplateArgument::Integral:
2419 case TemplateArgument::Declaration:
2420 case TemplateArgument::Pack:
2421 break;
2422 }
2423}
2424
Argyrios Kyrtzidis44f8c372010-06-22 09:54:59 +00002425void PCHWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg,
2426 RecordData &Record) {
2427 AddTemplateArgument(Arg.getArgument(), Record);
Argyrios Kyrtzidis17cfded2010-06-28 09:31:42 +00002428
2429 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
2430 bool InfoHasSameExpr
2431 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
2432 Record.push_back(InfoHasSameExpr);
2433 if (InfoHasSameExpr)
2434 return; // Avoid storing the same expr twice.
2435 }
Argyrios Kyrtzidis44f8c372010-06-22 09:54:59 +00002436 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo(),
2437 Record);
2438}
2439
John McCalla93c9342009-12-07 02:54:59 +00002440void PCHWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo, RecordData &Record) {
2441 if (TInfo == 0) {
John McCalla1ee0c52009-10-16 21:56:05 +00002442 AddTypeRef(QualType(), Record);
2443 return;
2444 }
2445
John McCalla93c9342009-12-07 02:54:59 +00002446 AddTypeRef(TInfo->getType(), Record);
John McCalla1ee0c52009-10-16 21:56:05 +00002447 TypeLocWriter TLW(*this, Record);
John McCalla93c9342009-12-07 02:54:59 +00002448 for (TypeLoc TL = TInfo->getTypeLoc(); !TL.isNull(); TL = TL.getNextTypeLoc())
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00002449 TLW.Visit(TL);
John McCalla1ee0c52009-10-16 21:56:05 +00002450}
2451
Douglas Gregor2cf26342009-04-09 22:27:44 +00002452void PCHWriter::AddTypeRef(QualType T, RecordData &Record) {
2453 if (T.isNull()) {
2454 Record.push_back(pch::PREDEF_TYPE_NULL_ID);
2455 return;
2456 }
2457
Douglas Gregora4923eb2009-11-16 21:35:15 +00002458 unsigned FastQuals = T.getLocalFastQualifiers();
John McCall0953e762009-09-24 19:53:00 +00002459 T.removeFastQualifiers();
2460
Douglas Gregora4923eb2009-11-16 21:35:15 +00002461 if (T.hasLocalNonFastQualifiers()) {
John McCall0953e762009-09-24 19:53:00 +00002462 pch::TypeID &ID = TypeIDs[T];
2463 if (ID == 0) {
2464 // We haven't seen these qualifiers applied to this type before.
2465 // Assign it a new ID. This is the only time we enqueue a
2466 // qualified type, and it has no CV qualifiers.
2467 ID = NextTypeID++;
Douglas Gregor61d60ee2009-10-17 00:13:19 +00002468 DeclTypesToEmit.push(T);
John McCall0953e762009-09-24 19:53:00 +00002469 }
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00002470
John McCall0953e762009-09-24 19:53:00 +00002471 // Encode the type qualifiers in the type reference.
2472 Record.push_back((ID << Qualifiers::FastWidth) | FastQuals);
2473 return;
2474 }
2475
Douglas Gregora4923eb2009-11-16 21:35:15 +00002476 assert(!T.hasLocalQualifiers());
Kovarththanan Rajaratnam11a18f12010-03-14 07:06:50 +00002477
Douglas Gregor2cf26342009-04-09 22:27:44 +00002478 if (const BuiltinType *BT = dyn_cast<BuiltinType>(T.getTypePtr())) {
Douglas Gregore1d918e2009-04-10 23:10:45 +00002479 pch::TypeID ID = 0;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002480 switch (BT->getKind()) {
2481 case BuiltinType::Void: ID = pch::PREDEF_TYPE_VOID_ID; break;
2482 case BuiltinType::Bool: ID = pch::PREDEF_TYPE_BOOL_ID; break;
2483 case BuiltinType::Char_U: ID = pch::PREDEF_TYPE_CHAR_U_ID; break;
2484 case BuiltinType::UChar: ID = pch::PREDEF_TYPE_UCHAR_ID; break;
2485 case BuiltinType::UShort: ID = pch::PREDEF_TYPE_USHORT_ID; break;
2486 case BuiltinType::UInt: ID = pch::PREDEF_TYPE_UINT_ID; break;
2487 case BuiltinType::ULong: ID = pch::PREDEF_TYPE_ULONG_ID; break;
2488 case BuiltinType::ULongLong: ID = pch::PREDEF_TYPE_ULONGLONG_ID; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +00002489 case BuiltinType::UInt128: ID = pch::PREDEF_TYPE_UINT128_ID; break;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002490 case BuiltinType::Char_S: ID = pch::PREDEF_TYPE_CHAR_S_ID; break;
2491 case BuiltinType::SChar: ID = pch::PREDEF_TYPE_SCHAR_ID; break;
2492 case BuiltinType::WChar: ID = pch::PREDEF_TYPE_WCHAR_ID; break;
2493 case BuiltinType::Short: ID = pch::PREDEF_TYPE_SHORT_ID; break;
2494 case BuiltinType::Int: ID = pch::PREDEF_TYPE_INT_ID; break;
2495 case BuiltinType::Long: ID = pch::PREDEF_TYPE_LONG_ID; break;
2496 case BuiltinType::LongLong: ID = pch::PREDEF_TYPE_LONGLONG_ID; break;
Chris Lattner2df9ced2009-04-30 02:43:43 +00002497 case BuiltinType::Int128: ID = pch::PREDEF_TYPE_INT128_ID; break;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002498 case BuiltinType::Float: ID = pch::PREDEF_TYPE_FLOAT_ID; break;
2499 case BuiltinType::Double: ID = pch::PREDEF_TYPE_DOUBLE_ID; break;
2500 case BuiltinType::LongDouble: ID = pch::PREDEF_TYPE_LONGDOUBLE_ID; break;
Sebastian Redl6e8ed162009-05-10 18:38:11 +00002501 case BuiltinType::NullPtr: ID = pch::PREDEF_TYPE_NULLPTR_ID; break;
Alisdair Meredithf5c209d2009-07-14 06:30:34 +00002502 case BuiltinType::Char16: ID = pch::PREDEF_TYPE_CHAR16_ID; break;
2503 case BuiltinType::Char32: ID = pch::PREDEF_TYPE_CHAR32_ID; break;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002504 case BuiltinType::Overload: ID = pch::PREDEF_TYPE_OVERLOAD_ID; break;
2505 case BuiltinType::Dependent: ID = pch::PREDEF_TYPE_DEPENDENT_ID; break;
Steve Naroffde2e22d2009-07-15 18:40:39 +00002506 case BuiltinType::ObjCId: ID = pch::PREDEF_TYPE_OBJC_ID; break;
2507 case BuiltinType::ObjCClass: ID = pch::PREDEF_TYPE_OBJC_CLASS; break;
Fariborz Jahanian13dcd002009-11-21 19:53:08 +00002508 case BuiltinType::ObjCSel: ID = pch::PREDEF_TYPE_OBJC_SEL; break;
Anders Carlssone89d1592009-06-26 18:41:36 +00002509 case BuiltinType::UndeducedAuto:
2510 assert(0 && "Should not see undeduced auto here");
2511 break;
Douglas Gregor2cf26342009-04-09 22:27:44 +00002512 }
2513
John McCall0953e762009-09-24 19:53:00 +00002514 Record.push_back((ID << Qualifiers::FastWidth) | FastQuals);
Douglas Gregor2cf26342009-04-09 22:27:44 +00002515 return;
2516 }
2517
John McCall0953e762009-09-24 19:53:00 +00002518 pch::TypeID &ID = TypeIDs[T];
Douglas Gregor366809a2009-04-26 03:49:13 +00002519 if (ID == 0) {
2520 // We haven't seen this type before. Assign it a new ID and put it
John McCall0953e762009-09-24 19:53:00 +00002521 // into the queue of types to emit.
Douglas Gregor2cf26342009-04-09 22:27:44 +00002522 ID = NextTypeID++;
Douglas Gregor61d60ee2009-10-17 00:13:19 +00002523 DeclTypesToEmit.push(T);
Douglas Gregor366809a2009-04-26 03:49:13 +00002524 }
Douglas Gregor2cf26342009-04-09 22:27:44 +00002525
2526 // Encode the type qualifiers in the type reference.
John McCall0953e762009-09-24 19:53:00 +00002527 Record.push_back((ID << Qualifiers::FastWidth) | FastQuals);
Douglas Gregor2cf26342009-04-09 22:27:44 +00002528}
2529
2530void PCHWriter::AddDeclRef(const Decl *D, RecordData &Record) {
2531 if (D == 0) {
2532 Record.push_back(0);
2533 return;
2534 }
2535
Douglas Gregor8038d512009-04-10 17:25:41 +00002536 pch::DeclID &ID = DeclIDs[D];
Mike Stump1eb44332009-09-09 15:08:12 +00002537 if (ID == 0) {
Douglas Gregor2cf26342009-04-09 22:27:44 +00002538 // We haven't seen this declaration before. Give it a new ID and
2539 // enqueue it in the list of declarations to emit.
2540 ID = DeclIDs.size();
Douglas Gregor61d60ee2009-10-17 00:13:19 +00002541 DeclTypesToEmit.push(const_cast<Decl *>(D));
Douglas Gregor2cf26342009-04-09 22:27:44 +00002542 }
2543
2544 Record.push_back(ID);
2545}
2546
Douglas Gregor3251ceb2009-04-20 20:36:09 +00002547pch::DeclID PCHWriter::getDeclID(const Decl *D) {
2548 if (D == 0)
2549 return 0;
2550
2551 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
2552 return DeclIDs[D];
2553}
2554
Douglas Gregor2cf26342009-04-09 22:27:44 +00002555void PCHWriter::AddDeclarationName(DeclarationName Name, RecordData &Record) {
Chris Lattnerea5ce472009-04-27 07:35:58 +00002556 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc.
Douglas Gregor2cf26342009-04-09 22:27:44 +00002557 Record.push_back(Name.getNameKind());
2558 switch (Name.getNameKind()) {
2559 case DeclarationName::Identifier:
2560 AddIdentifierRef(Name.getAsIdentifierInfo(), Record);
2561 break;
2562
2563 case DeclarationName::ObjCZeroArgSelector:
2564 case DeclarationName::ObjCOneArgSelector:
2565 case DeclarationName::ObjCMultiArgSelector:
Steve Naroff90cd1bb2009-04-23 10:39:46 +00002566 AddSelectorRef(Name.getObjCSelector(), Record);
Douglas Gregor2cf26342009-04-09 22:27:44 +00002567 break;
2568
2569 case DeclarationName::CXXConstructorName:
2570 case DeclarationName::CXXDestructorName:
2571 case DeclarationName::CXXConversionFunctionName:
2572 AddTypeRef(Name.getCXXNameType(), Record);
2573 break;
2574
2575 case DeclarationName::CXXOperatorName:
2576 Record.push_back(Name.getCXXOverloadedOperator());
2577 break;
2578
Sean Hunt3e518bd2009-11-29 07:34:05 +00002579 case DeclarationName::CXXLiteralOperatorName:
2580 AddIdentifierRef(Name.getCXXLiteralIdentifier(), Record);
2581 break;
2582
Douglas Gregor2cf26342009-04-09 22:27:44 +00002583 case DeclarationName::CXXUsingDirective:
2584 // No extra data to emit
2585 break;
2586 }
2587}
Chris Lattner6ad9ac02010-05-07 21:43:38 +00002588
2589void PCHWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS,
2590 RecordData &Record) {
2591 // Nested name specifiers usually aren't too long. I think that 8 would
2592 // typically accomodate the vast majority.
2593 llvm::SmallVector<NestedNameSpecifier *, 8> NestedNames;
2594
2595 // Push each of the NNS's onto a stack for serialization in reverse order.
2596 while (NNS) {
2597 NestedNames.push_back(NNS);
2598 NNS = NNS->getPrefix();
2599 }
2600
2601 Record.push_back(NestedNames.size());
2602 while(!NestedNames.empty()) {
2603 NNS = NestedNames.pop_back_val();
2604 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
2605 Record.push_back(Kind);
2606 switch (Kind) {
2607 case NestedNameSpecifier::Identifier:
2608 AddIdentifierRef(NNS->getAsIdentifier(), Record);
2609 break;
2610
2611 case NestedNameSpecifier::Namespace:
2612 AddDeclRef(NNS->getAsNamespace(), Record);
2613 break;
2614
2615 case NestedNameSpecifier::TypeSpec:
2616 case NestedNameSpecifier::TypeSpecWithTemplate:
2617 AddTypeRef(QualType(NNS->getAsType(), 0), Record);
2618 Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
2619 break;
2620
2621 case NestedNameSpecifier::Global:
2622 // Don't need to write an associated value.
2623 break;
2624 }
2625 }
2626}
Argyrios Kyrtzidis90b715e2010-06-19 19:28:53 +00002627
2628void PCHWriter::AddTemplateName(TemplateName Name, RecordData &Record) {
2629 TemplateName::NameKind Kind = Name.getKind();
2630 Record.push_back(Kind);
2631 switch (Kind) {
2632 case TemplateName::Template:
2633 AddDeclRef(Name.getAsTemplateDecl(), Record);
2634 break;
2635
2636 case TemplateName::OverloadedTemplate: {
2637 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
2638 Record.push_back(OvT->size());
2639 for (OverloadedTemplateStorage::iterator I = OvT->begin(), E = OvT->end();
2640 I != E; ++I)
2641 AddDeclRef(*I, Record);
2642 break;
2643 }
2644
2645 case TemplateName::QualifiedTemplate: {
2646 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
2647 AddNestedNameSpecifier(QualT->getQualifier(), Record);
2648 Record.push_back(QualT->hasTemplateKeyword());
2649 AddDeclRef(QualT->getTemplateDecl(), Record);
2650 break;
2651 }
2652
2653 case TemplateName::DependentTemplate: {
2654 DependentTemplateName *DepT = Name.getAsDependentTemplateName();
2655 AddNestedNameSpecifier(DepT->getQualifier(), Record);
2656 Record.push_back(DepT->isIdentifier());
2657 if (DepT->isIdentifier())
2658 AddIdentifierRef(DepT->getIdentifier(), Record);
2659 else
2660 Record.push_back(DepT->getOperator());
2661 break;
2662 }
2663 }
2664}
2665
2666void PCHWriter::AddTemplateArgument(const TemplateArgument &Arg,
2667 RecordData &Record) {
2668 Record.push_back(Arg.getKind());
2669 switch (Arg.getKind()) {
2670 case TemplateArgument::Null:
2671 break;
2672 case TemplateArgument::Type:
2673 AddTypeRef(Arg.getAsType(), Record);
2674 break;
2675 case TemplateArgument::Declaration:
2676 AddDeclRef(Arg.getAsDecl(), Record);
2677 break;
2678 case TemplateArgument::Integral:
2679 AddAPSInt(*Arg.getAsIntegral(), Record);
2680 AddTypeRef(Arg.getIntegralType(), Record);
2681 break;
2682 case TemplateArgument::Template:
2683 AddTemplateName(Arg.getAsTemplate(), Record);
2684 break;
2685 case TemplateArgument::Expression:
2686 AddStmt(Arg.getAsExpr());
2687 break;
2688 case TemplateArgument::Pack:
2689 Record.push_back(Arg.pack_size());
2690 for (TemplateArgument::pack_iterator I=Arg.pack_begin(), E=Arg.pack_end();
2691 I != E; ++I)
2692 AddTemplateArgument(*I, Record);
2693 break;
2694 }
2695}
Argyrios Kyrtzidisdd41c142010-06-23 13:48:30 +00002696
2697void
2698PCHWriter::AddTemplateParameterList(const TemplateParameterList *TemplateParams,
2699 RecordData &Record) {
2700 assert(TemplateParams && "No TemplateParams!");
2701 AddSourceLocation(TemplateParams->getTemplateLoc(), Record);
2702 AddSourceLocation(TemplateParams->getLAngleLoc(), Record);
2703 AddSourceLocation(TemplateParams->getRAngleLoc(), Record);
2704 Record.push_back(TemplateParams->size());
2705 for (TemplateParameterList::const_iterator
2706 P = TemplateParams->begin(), PEnd = TemplateParams->end();
2707 P != PEnd; ++P)
2708 AddDeclRef(*P, Record);
2709}
2710
2711/// \brief Emit a template argument list.
2712void
2713PCHWriter::AddTemplateArgumentList(const TemplateArgumentList *TemplateArgs,
2714 RecordData &Record) {
2715 assert(TemplateArgs && "No TemplateArgs!");
2716 Record.push_back(TemplateArgs->flat_size());
2717 for (int i=0, e = TemplateArgs->flat_size(); i != e; ++i)
2718 AddTemplateArgument(TemplateArgs->get(i), Record);
2719}
Argyrios Kyrtzidis37ffed32010-07-02 11:55:32 +00002720
2721
2722void
2723PCHWriter::AddUnresolvedSet(const UnresolvedSetImpl &Set, RecordData &Record) {
2724 Record.push_back(Set.size());
2725 for (UnresolvedSetImpl::const_iterator
2726 I = Set.begin(), E = Set.end(); I != E; ++I) {
2727 AddDeclRef(I.getDecl(), Record);
2728 Record.push_back(I.getAccess());
2729 }
2730}
Argyrios Kyrtzidis0745d0a2010-07-02 23:30:27 +00002731
2732void PCHWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base,
2733 RecordData &Record) {
2734 Record.push_back(Base.isVirtual());
2735 Record.push_back(Base.isBaseOfClass());
2736 Record.push_back(Base.getAccessSpecifierAsWritten());
2737 AddTypeRef(Base.getType(), Record);
2738 AddSourceRange(Base.getSourceRange(), Record);
2739}