blob: 6c60d45503de88f56b8d7a24988c8646a78c3a2d [file] [log] [blame]
Sebastian Redld6522cf2010-08-18 23:56:31 +00001//===--- ASTWriter.cpp - AST File Writer ----------------------------------===//
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
Sebastian Redl55c0ad52010-08-18 23:56:21 +000010// This file defines the ASTWriter class, which writes AST files.
Douglas Gregoref84c4b2009-04-09 22:27:44 +000011//
12//===----------------------------------------------------------------------===//
13
Sebastian Redl1914c6f2010-08-18 23:56:37 +000014#include "clang/Serialization/ASTWriter.h"
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +000015#include "ASTCommon.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000016#include "clang/AST/ASTContext.h"
17#include "clang/AST/Decl.h"
18#include "clang/AST/DeclContextInternals.h"
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +000019#include "clang/AST/DeclFriend.h"
Richard Smith961eae52014-03-25 01:14:22 +000020#include "clang/AST/DeclLookups.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000021#include "clang/AST/DeclTemplate.h"
Douglas Gregorfeb84b02009-04-14 21:18:50 +000022#include "clang/AST/Expr.h"
John McCallbfd822c2010-08-24 07:32:53 +000023#include "clang/AST/ExprCXX.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000024#include "clang/AST/Type.h"
John McCall8f115c62009-10-16 21:56:05 +000025#include "clang/AST/TypeLocVisitor.h"
Benjamin Kramerf3ca26982014-05-10 16:31:55 +000026#include "clang/Basic/DiagnosticOptions.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000027#include "clang/Basic/FileManager.h"
Chris Lattner226efd32010-11-23 19:19:34 +000028#include "clang/Basic/FileSystemStatCache.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000029#include "clang/Basic/SourceManager.h"
Douglas Gregor4c7626e2009-04-13 16:31:14 +000030#include "clang/Basic/SourceManagerInternals.h"
Douglas Gregorbfbde532009-04-10 21:16:55 +000031#include "clang/Basic/TargetInfo.h"
Douglas Gregorcb177f12012-10-16 23:40:58 +000032#include "clang/Basic/TargetOptions.h"
Douglas Gregor7b71e632009-04-27 22:23:34 +000033#include "clang/Basic/Version.h"
Douglas Gregor20b2ebd2011-03-23 00:50:03 +000034#include "clang/Basic/VersionTuple.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000035#include "clang/Lex/HeaderSearch.h"
36#include "clang/Lex/HeaderSearchOptions.h"
37#include "clang/Lex/MacroInfo.h"
38#include "clang/Lex/PreprocessingRecord.h"
39#include "clang/Lex/Preprocessor.h"
40#include "clang/Lex/PreprocessorOptions.h"
41#include "clang/Sema/IdentifierResolver.h"
42#include "clang/Sema/Sema.h"
43#include "clang/Serialization/ASTReader.h"
Douglas Gregore0a3a512009-04-14 21:55:33 +000044#include "llvm/ADT/APFloat.h"
45#include "llvm/ADT/APInt.h"
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +000046#include "llvm/ADT/Hashing.h"
Daniel Dunbarf8502d52009-10-17 23:52:28 +000047#include "llvm/ADT/StringExtras.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000048#include "llvm/Bitcode/BitstreamWriter.h"
Justin Bognere1c147c2014-03-28 22:03:19 +000049#include "llvm/Support/EndianStream.h"
Michael J. Spencer740857f2010-12-21 16:45:57 +000050#include "llvm/Support/FileSystem.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000051#include "llvm/Support/MemoryBuffer.h"
Justin Bognerbb094f02014-04-18 19:57:06 +000052#include "llvm/Support/OnDiskHashTable.h"
Michael J. Spencer8aaf4992010-11-29 18:12:39 +000053#include "llvm/Support/Path.h"
Ben Langmuir487ea142014-10-23 18:05:36 +000054#include "llvm/Support/Process.h"
Douglas Gregor925296b2011-07-19 16:10:42 +000055#include <algorithm>
Chris Lattner225dd6c2009-04-11 18:40:46 +000056#include <cstdio>
Douglas Gregor09b69892011-02-10 17:09:37 +000057#include <string.h>
Douglas Gregor925296b2011-07-19 16:10:42 +000058#include <utility>
Douglas Gregoref84c4b2009-04-09 22:27:44 +000059using namespace clang;
Sebastian Redl539c5062010-08-18 23:57:32 +000060using namespace clang::serialization;
Douglas Gregoref84c4b2009-04-09 22:27:44 +000061
Sebastian Redl3df5a082010-07-30 17:03:48 +000062template <typename T, typename Allocator>
Chris Lattner0e62c1c2011-07-23 10:55:15 +000063static StringRef data(const std::vector<T, Allocator> &v) {
64 if (v.empty()) return StringRef();
65 return StringRef(reinterpret_cast<const char*>(&v[0]),
Benjamin Kramerd47a12a2011-04-24 17:44:50 +000066 sizeof(T) * v.size());
Sebastian Redl3df5a082010-07-30 17:03:48 +000067}
Benjamin Kramerd47a12a2011-04-24 17:44:50 +000068
69template <typename T>
Chris Lattner0e62c1c2011-07-23 10:55:15 +000070static StringRef data(const SmallVectorImpl<T> &v) {
71 return StringRef(reinterpret_cast<const char*>(v.data()),
Benjamin Kramerd47a12a2011-04-24 17:44:50 +000072 sizeof(T) * v.size());
Sebastian Redl3df5a082010-07-30 17:03:48 +000073}
74
Douglas Gregoref84c4b2009-04-09 22:27:44 +000075//===----------------------------------------------------------------------===//
76// Type serialization
77//===----------------------------------------------------------------------===//
Chris Lattner7099dbc2009-04-27 06:16:06 +000078
Douglas Gregoref84c4b2009-04-09 22:27:44 +000079namespace {
Sebastian Redl42a0f6a2010-08-18 23:56:27 +000080 class ASTTypeWriter {
Sebastian Redl55c0ad52010-08-18 23:56:21 +000081 ASTWriter &Writer;
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +000082 ASTWriter::RecordDataImpl &Record;
Douglas Gregoref84c4b2009-04-09 22:27:44 +000083
84 public:
85 /// \brief Type code that corresponds to the record generated.
Sebastian Redl539c5062010-08-18 23:57:32 +000086 TypeCode Code;
Richard Smith01b2cb42014-07-26 06:37:51 +000087 /// \brief Abbreviation to use for the record, if any.
88 unsigned AbbrevToUse;
Douglas Gregoref84c4b2009-04-09 22:27:44 +000089
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +000090 ASTTypeWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record)
Sebastian Redl539c5062010-08-18 23:57:32 +000091 : Writer(Writer), Record(Record), Code(TYPE_EXT_QUAL) { }
Douglas Gregoref84c4b2009-04-09 22:27:44 +000092
93 void VisitArrayType(const ArrayType *T);
94 void VisitFunctionType(const FunctionType *T);
95 void VisitTagType(const TagType *T);
96
97#define TYPE(Class, Base) void Visit##Class##Type(const Class##Type *T);
98#define ABSTRACT_TYPE(Class, Base)
Douglas Gregoref84c4b2009-04-09 22:27:44 +000099#include "clang/AST/TypeNodes.def"
100 };
101}
102
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000103void ASTTypeWriter::VisitBuiltinType(const BuiltinType *T) {
David Blaikie83d382b2011-09-23 05:06:16 +0000104 llvm_unreachable("Built-in types are never serialized");
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000105}
106
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000107void ASTTypeWriter::VisitComplexType(const ComplexType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000108 Writer.AddTypeRef(T->getElementType(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000109 Code = TYPE_COMPLEX;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000110}
111
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000112void ASTTypeWriter::VisitPointerType(const PointerType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000113 Writer.AddTypeRef(T->getPointeeType(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000114 Code = TYPE_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000115}
116
Reid Kleckner8a365022013-06-24 17:51:48 +0000117void ASTTypeWriter::VisitDecayedType(const DecayedType *T) {
118 Writer.AddTypeRef(T->getOriginalType(), Record);
119 Code = TYPE_DECAYED;
120}
121
Reid Kleckner0503a872013-12-05 01:23:43 +0000122void ASTTypeWriter::VisitAdjustedType(const AdjustedType *T) {
123 Writer.AddTypeRef(T->getOriginalType(), Record);
124 Writer.AddTypeRef(T->getAdjustedType(), Record);
125 Code = TYPE_ADJUSTED;
126}
127
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000128void ASTTypeWriter::VisitBlockPointerType(const BlockPointerType *T) {
Mike Stump11289f42009-09-09 15:08:12 +0000129 Writer.AddTypeRef(T->getPointeeType(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000130 Code = TYPE_BLOCK_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000131}
132
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000133void ASTTypeWriter::VisitLValueReferenceType(const LValueReferenceType *T) {
Richard Smith0f538462011-04-12 10:38:03 +0000134 Writer.AddTypeRef(T->getPointeeTypeAsWritten(), Record);
135 Record.push_back(T->isSpelledAsLValue());
Sebastian Redl539c5062010-08-18 23:57:32 +0000136 Code = TYPE_LVALUE_REFERENCE;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000137}
138
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000139void ASTTypeWriter::VisitRValueReferenceType(const RValueReferenceType *T) {
Richard Smith0f538462011-04-12 10:38:03 +0000140 Writer.AddTypeRef(T->getPointeeTypeAsWritten(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000141 Code = TYPE_RVALUE_REFERENCE;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000142}
143
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000144void ASTTypeWriter::VisitMemberPointerType(const MemberPointerType *T) {
Mike Stump11289f42009-09-09 15:08:12 +0000145 Writer.AddTypeRef(T->getPointeeType(), Record);
146 Writer.AddTypeRef(QualType(T->getClass(), 0), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000147 Code = TYPE_MEMBER_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000148}
149
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000150void ASTTypeWriter::VisitArrayType(const ArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000151 Writer.AddTypeRef(T->getElementType(), Record);
152 Record.push_back(T->getSizeModifier()); // FIXME: stable values
John McCall8ccfcb52009-09-24 19:53:00 +0000153 Record.push_back(T->getIndexTypeCVRQualifiers()); // FIXME: stable values
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000154}
155
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000156void ASTTypeWriter::VisitConstantArrayType(const ConstantArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000157 VisitArrayType(T);
158 Writer.AddAPInt(T->getSize(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000159 Code = TYPE_CONSTANT_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000160}
161
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000162void ASTTypeWriter::VisitIncompleteArrayType(const IncompleteArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000163 VisitArrayType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000164 Code = TYPE_INCOMPLETE_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000165}
166
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000167void ASTTypeWriter::VisitVariableArrayType(const VariableArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000168 VisitArrayType(T);
Douglas Gregor04318252009-07-06 15:59:29 +0000169 Writer.AddSourceLocation(T->getLBracketLoc(), Record);
170 Writer.AddSourceLocation(T->getRBracketLoc(), Record);
Douglas Gregor8f45df52009-04-16 22:23:12 +0000171 Writer.AddStmt(T->getSizeExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000172 Code = TYPE_VARIABLE_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000173}
174
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000175void ASTTypeWriter::VisitVectorType(const VectorType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000176 Writer.AddTypeRef(T->getElementType(), Record);
177 Record.push_back(T->getNumElements());
Bob Wilsonaeb56442010-11-10 21:56:12 +0000178 Record.push_back(T->getVectorKind());
Sebastian Redl539c5062010-08-18 23:57:32 +0000179 Code = TYPE_VECTOR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000180}
181
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000182void ASTTypeWriter::VisitExtVectorType(const ExtVectorType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000183 VisitVectorType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000184 Code = TYPE_EXT_VECTOR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000185}
186
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000187void ASTTypeWriter::VisitFunctionType(const FunctionType *T) {
Alp Toker314cc812014-01-25 16:55:45 +0000188 Writer.AddTypeRef(T->getReturnType(), Record);
Rafael Espindolac50c27c2010-03-30 20:24:48 +0000189 FunctionType::ExtInfo C = T->getExtInfo();
190 Record.push_back(C.getNoReturn());
Eli Friedmanc5b20b52011-04-09 08:18:08 +0000191 Record.push_back(C.getHasRegParm());
Rafael Espindola49b85ab2010-03-30 22:15:11 +0000192 Record.push_back(C.getRegParm());
Douglas Gregor8c940862010-01-18 17:14:39 +0000193 // FIXME: need to stabilize encoding of calling convention...
Rafael Espindolac50c27c2010-03-30 20:24:48 +0000194 Record.push_back(C.getCC());
John McCall31168b02011-06-15 23:02:42 +0000195 Record.push_back(C.getProducesResult());
Richard Smith01b2cb42014-07-26 06:37:51 +0000196
197 if (C.getHasRegParm() || C.getRegParm() || C.getProducesResult())
198 AbbrevToUse = 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000199}
200
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000201void ASTTypeWriter::VisitFunctionNoProtoType(const FunctionNoProtoType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000202 VisitFunctionType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000203 Code = TYPE_FUNCTION_NO_PROTO;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000204}
205
Richard Smith564417a2014-03-20 21:47:22 +0000206static void addExceptionSpec(ASTWriter &Writer, const FunctionProtoType *T,
207 ASTWriter::RecordDataImpl &Record) {
Sebastian Redlfa453cf2011-03-12 11:50:43 +0000208 Record.push_back(T->getExceptionSpecType());
209 if (T->getExceptionSpecType() == EST_Dynamic) {
210 Record.push_back(T->getNumExceptions());
211 for (unsigned I = 0, N = T->getNumExceptions(); I != N; ++I)
212 Writer.AddTypeRef(T->getExceptionType(I), Record);
213 } else if (T->getExceptionSpecType() == EST_ComputedNoexcept) {
214 Writer.AddStmt(T->getNoexceptExpr());
Richard Smith8b987a92012-04-21 17:47:47 +0000215 } else if (T->getExceptionSpecType() == EST_Uninstantiated) {
216 Writer.AddDeclRef(T->getExceptionSpecDecl(), Record);
217 Writer.AddDeclRef(T->getExceptionSpecTemplate(), Record);
Richard Smithd3b5c9082012-07-27 04:22:15 +0000218 } else if (T->getExceptionSpecType() == EST_Unevaluated) {
219 Writer.AddDeclRef(T->getExceptionSpecDecl(), Record);
Sebastian Redlfa453cf2011-03-12 11:50:43 +0000220 }
Richard Smith564417a2014-03-20 21:47:22 +0000221}
222
223void ASTTypeWriter::VisitFunctionProtoType(const FunctionProtoType *T) {
224 VisitFunctionType(T);
Richard Smith01b2cb42014-07-26 06:37:51 +0000225
Richard Smith564417a2014-03-20 21:47:22 +0000226 Record.push_back(T->isVariadic());
227 Record.push_back(T->hasTrailingReturn());
228 Record.push_back(T->getTypeQuals());
229 Record.push_back(static_cast<unsigned>(T->getRefQualifier()));
230 addExceptionSpec(Writer, T, Record);
Richard Smith01b2cb42014-07-26 06:37:51 +0000231
232 Record.push_back(T->getNumParams());
233 for (unsigned I = 0, N = T->getNumParams(); I != N; ++I)
234 Writer.AddTypeRef(T->getParamType(I), Record);
235
236 if (T->isVariadic() || T->hasTrailingReturn() || T->getTypeQuals() ||
237 T->getRefQualifier() || T->getExceptionSpecType() != EST_None)
238 AbbrevToUse = 0;
239
Sebastian Redl539c5062010-08-18 23:57:32 +0000240 Code = TYPE_FUNCTION_PROTO;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000241}
242
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000243void ASTTypeWriter::VisitUnresolvedUsingType(const UnresolvedUsingType *T) {
John McCallb96ec562009-12-04 22:46:56 +0000244 Writer.AddDeclRef(T->getDecl(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000245 Code = TYPE_UNRESOLVED_USING;
John McCallb96ec562009-12-04 22:46:56 +0000246}
John McCallb96ec562009-12-04 22:46:56 +0000247
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000248void ASTTypeWriter::VisitTypedefType(const TypedefType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000249 Writer.AddDeclRef(T->getDecl(), Record);
Argyrios Kyrtzidis45a83f92010-07-02 11:55:11 +0000250 assert(!T->isCanonicalUnqualified() && "Invalid typedef ?");
251 Writer.AddTypeRef(T->getCanonicalTypeInternal(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000252 Code = TYPE_TYPEDEF;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000253}
254
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000255void ASTTypeWriter::VisitTypeOfExprType(const TypeOfExprType *T) {
Douglas Gregor8f45df52009-04-16 22:23:12 +0000256 Writer.AddStmt(T->getUnderlyingExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000257 Code = TYPE_TYPEOF_EXPR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000258}
259
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000260void ASTTypeWriter::VisitTypeOfType(const TypeOfType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000261 Writer.AddTypeRef(T->getUnderlyingType(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000262 Code = TYPE_TYPEOF;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000263}
264
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000265void ASTTypeWriter::VisitDecltypeType(const DecltypeType *T) {
Douglas Gregor81495f32012-02-12 18:42:33 +0000266 Writer.AddTypeRef(T->getUnderlyingType(), Record);
Anders Carlsson81df7b82009-06-24 19:06:50 +0000267 Writer.AddStmt(T->getUnderlyingExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000268 Code = TYPE_DECLTYPE;
Anders Carlsson81df7b82009-06-24 19:06:50 +0000269}
270
Alexis Hunte852b102011-05-24 22:41:36 +0000271void ASTTypeWriter::VisitUnaryTransformType(const UnaryTransformType *T) {
272 Writer.AddTypeRef(T->getBaseType(), Record);
273 Writer.AddTypeRef(T->getUnderlyingType(), Record);
274 Record.push_back(T->getUTTKind());
275 Code = TYPE_UNARY_TRANSFORM;
276}
277
Richard Smith30482bc2011-02-20 03:19:35 +0000278void ASTTypeWriter::VisitAutoType(const AutoType *T) {
279 Writer.AddTypeRef(T->getDeducedType(), Record);
Richard Smith74aeef52013-04-26 16:15:35 +0000280 Record.push_back(T->isDecltypeAuto());
Richard Smith27d807c2013-04-30 13:56:41 +0000281 if (T->getDeducedType().isNull())
282 Record.push_back(T->isDependentType());
Richard Smith30482bc2011-02-20 03:19:35 +0000283 Code = TYPE_AUTO;
284}
285
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000286void ASTTypeWriter::VisitTagType(const TagType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000287 Record.push_back(T->isDependentType());
Douglas Gregorf3bccd72012-01-17 19:21:53 +0000288 Writer.AddDeclRef(T->getDecl()->getCanonicalDecl(), Record);
Mike Stump11289f42009-09-09 15:08:12 +0000289 assert(!T->isBeingDefined() &&
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000290 "Cannot serialize in the middle of a type definition");
291}
292
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000293void ASTTypeWriter::VisitRecordType(const RecordType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000294 VisitTagType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000295 Code = TYPE_RECORD;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000296}
297
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000298void ASTTypeWriter::VisitEnumType(const EnumType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000299 VisitTagType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000300 Code = TYPE_ENUM;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000301}
302
John McCall81904512011-01-06 01:58:22 +0000303void ASTTypeWriter::VisitAttributedType(const AttributedType *T) {
304 Writer.AddTypeRef(T->getModifiedType(), Record);
305 Writer.AddTypeRef(T->getEquivalentType(), Record);
306 Record.push_back(T->getAttrKind());
307 Code = TYPE_ATTRIBUTED;
308}
309
Mike Stump11289f42009-09-09 15:08:12 +0000310void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000311ASTTypeWriter::VisitSubstTemplateTypeParmType(
John McCallcebee162009-10-18 09:09:24 +0000312 const SubstTemplateTypeParmType *T) {
313 Writer.AddTypeRef(QualType(T->getReplacedParameter(), 0), Record);
314 Writer.AddTypeRef(T->getReplacementType(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000315 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM;
John McCallcebee162009-10-18 09:09:24 +0000316}
317
318void
Douglas Gregorada4b792011-01-14 02:55:32 +0000319ASTTypeWriter::VisitSubstTemplateTypeParmPackType(
320 const SubstTemplateTypeParmPackType *T) {
321 Writer.AddTypeRef(QualType(T->getReplacedParameter(), 0), Record);
322 Writer.AddTemplateArgument(T->getArgumentPack(), Record);
323 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK;
324}
325
326void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000327ASTTypeWriter::VisitTemplateSpecializationType(
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000328 const TemplateSpecializationType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000329 Record.push_back(T->isDependentType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000330 Writer.AddTemplateName(T->getTemplateName(), Record);
331 Record.push_back(T->getNumArgs());
332 for (TemplateSpecializationType::iterator ArgI = T->begin(), ArgE = T->end();
333 ArgI != ArgE; ++ArgI)
334 Writer.AddTemplateArgument(*ArgI, Record);
Richard Smith3f1b5d02011-05-05 21:57:07 +0000335 Writer.AddTypeRef(T->isTypeAlias() ? T->getAliasedType() :
336 T->isCanonicalUnqualified() ? QualType()
Argyrios Kyrtzidis45a83f92010-07-02 11:55:11 +0000337 : T->getCanonicalTypeInternal(),
338 Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000339 Code = TYPE_TEMPLATE_SPECIALIZATION;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000340}
341
342void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000343ASTTypeWriter::VisitDependentSizedArrayType(const DependentSizedArrayType *T) {
Argyrios Kyrtzidis4a57bd02010-06-30 08:49:25 +0000344 VisitArrayType(T);
345 Writer.AddStmt(T->getSizeExpr());
346 Writer.AddSourceRange(T->getBracketsRange(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000347 Code = TYPE_DEPENDENT_SIZED_ARRAY;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000348}
349
350void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000351ASTTypeWriter::VisitDependentSizedExtVectorType(
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000352 const DependentSizedExtVectorType *T) {
353 // FIXME: Serialize this type (C++ only)
David Blaikie83d382b2011-09-23 05:06:16 +0000354 llvm_unreachable("Cannot serialize dependent sized extended vector types");
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000355}
356
357void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000358ASTTypeWriter::VisitTemplateTypeParmType(const TemplateTypeParmType *T) {
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000359 Record.push_back(T->getDepth());
360 Record.push_back(T->getIndex());
361 Record.push_back(T->isParameterPack());
Chandler Carruth08836322011-05-01 00:51:33 +0000362 Writer.AddDeclRef(T->getDecl(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000363 Code = TYPE_TEMPLATE_TYPE_PARM;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000364}
365
366void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000367ASTTypeWriter::VisitDependentNameType(const DependentNameType *T) {
Argyrios Kyrtzidisbfcacee2010-06-24 08:57:31 +0000368 Record.push_back(T->getKeyword());
369 Writer.AddNestedNameSpecifier(T->getQualifier(), Record);
370 Writer.AddIdentifierRef(T->getIdentifier(), Record);
Argyrios Kyrtzidise9290952010-07-02 11:55:24 +0000371 Writer.AddTypeRef(T->isCanonicalUnqualified() ? QualType()
372 : T->getCanonicalTypeInternal(),
373 Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000374 Code = TYPE_DEPENDENT_NAME;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000375}
376
377void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000378ASTTypeWriter::VisitDependentTemplateSpecializationType(
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000379 const DependentTemplateSpecializationType *T) {
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000380 Record.push_back(T->getKeyword());
381 Writer.AddNestedNameSpecifier(T->getQualifier(), Record);
382 Writer.AddIdentifierRef(T->getIdentifier(), Record);
383 Record.push_back(T->getNumArgs());
384 for (DependentTemplateSpecializationType::iterator
385 I = T->begin(), E = T->end(); I != E; ++I)
386 Writer.AddTemplateArgument(*I, Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000387 Code = TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000388}
389
Douglas Gregord2fa7662010-12-20 02:24:11 +0000390void ASTTypeWriter::VisitPackExpansionType(const PackExpansionType *T) {
391 Writer.AddTypeRef(T->getPattern(), Record);
David Blaikie05785d12013-02-20 22:23:23 +0000392 if (Optional<unsigned> NumExpansions = T->getNumExpansions())
Douglas Gregor0dca5fd2011-01-14 17:04:44 +0000393 Record.push_back(*NumExpansions + 1);
394 else
395 Record.push_back(0);
Douglas Gregord2fa7662010-12-20 02:24:11 +0000396 Code = TYPE_PACK_EXPANSION;
397}
398
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000399void ASTTypeWriter::VisitParenType(const ParenType *T) {
400 Writer.AddTypeRef(T->getInnerType(), Record);
401 Code = TYPE_PAREN;
402}
403
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000404void ASTTypeWriter::VisitElaboratedType(const ElaboratedType *T) {
Abramo Bagnara6150c882010-05-11 21:36:43 +0000405 Record.push_back(T->getKeyword());
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000406 Writer.AddNestedNameSpecifier(T->getQualifier(), Record);
407 Writer.AddTypeRef(T->getNamedType(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000408 Code = TYPE_ELABORATED;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000409}
410
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000411void ASTTypeWriter::VisitInjectedClassNameType(const InjectedClassNameType *T) {
Douglas Gregor9f218892012-03-26 15:52:37 +0000412 Writer.AddDeclRef(T->getDecl()->getCanonicalDecl(), Record);
John McCall2408e322010-04-27 00:57:59 +0000413 Writer.AddTypeRef(T->getInjectedSpecializationType(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000414 Code = TYPE_INJECTED_CLASS_NAME;
John McCalle78aac42010-03-10 03:28:59 +0000415}
416
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000417void ASTTypeWriter::VisitObjCInterfaceType(const ObjCInterfaceType *T) {
Douglas Gregorf3bccd72012-01-17 19:21:53 +0000418 Writer.AddDeclRef(T->getDecl()->getCanonicalDecl(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000419 Code = TYPE_OBJC_INTERFACE;
John McCall8b07ec22010-05-15 11:32:37 +0000420}
421
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000422void ASTTypeWriter::VisitObjCObjectType(const ObjCObjectType *T) {
John McCall8b07ec22010-05-15 11:32:37 +0000423 Writer.AddTypeRef(T->getBaseType(), Record);
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000424 Record.push_back(T->getNumProtocols());
Aaron Ballman1683f7b2014-03-17 15:55:30 +0000425 for (const auto *I : T->quals())
426 Writer.AddDeclRef(I, Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000427 Code = TYPE_OBJC_OBJECT;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000428}
429
Steve Narofffb4330f2009-06-17 22:40:22 +0000430void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000431ASTTypeWriter::VisitObjCObjectPointerType(const ObjCObjectPointerType *T) {
Mike Stump11289f42009-09-09 15:08:12 +0000432 Writer.AddTypeRef(T->getPointeeType(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000433 Code = TYPE_OBJC_OBJECT_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000434}
435
Eli Friedman0dfb8892011-10-06 23:00:33 +0000436void
437ASTTypeWriter::VisitAtomicType(const AtomicType *T) {
438 Writer.AddTypeRef(T->getValueType(), Record);
439 Code = TYPE_ATOMIC;
440}
441
John McCall8f115c62009-10-16 21:56:05 +0000442namespace {
443
444class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> {
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000445 ASTWriter &Writer;
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000446 ASTWriter::RecordDataImpl &Record;
John McCall8f115c62009-10-16 21:56:05 +0000447
448public:
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000449 TypeLocWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record)
John McCall8f115c62009-10-16 21:56:05 +0000450 : Writer(Writer), Record(Record) { }
451
John McCall17001972009-10-18 01:05:36 +0000452#define ABSTRACT_TYPELOC(CLASS, PARENT)
John McCall8f115c62009-10-16 21:56:05 +0000453#define TYPELOC(CLASS, PARENT) \
John McCall17001972009-10-18 01:05:36 +0000454 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000455#include "clang/AST/TypeLocNodes.def"
456
John McCall17001972009-10-18 01:05:36 +0000457 void VisitArrayTypeLoc(ArrayTypeLoc TyLoc);
458 void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000459};
460
461}
462
John McCall17001972009-10-18 01:05:36 +0000463void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
464 // nothing to do
John McCall8f115c62009-10-16 21:56:05 +0000465}
John McCall17001972009-10-18 01:05:36 +0000466void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
Douglas Gregorc9b7a592010-01-18 18:04:31 +0000467 Writer.AddSourceLocation(TL.getBuiltinLoc(), Record);
468 if (TL.needsExtraLocalData()) {
469 Record.push_back(TL.getWrittenTypeSpec());
470 Record.push_back(TL.getWrittenSignSpec());
471 Record.push_back(TL.getWrittenWidthSpec());
472 Record.push_back(TL.hasModeAttr());
473 }
John McCall8f115c62009-10-16 21:56:05 +0000474}
John McCall17001972009-10-18 01:05:36 +0000475void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
476 Writer.AddSourceLocation(TL.getNameLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000477}
John McCall17001972009-10-18 01:05:36 +0000478void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) {
479 Writer.AddSourceLocation(TL.getStarLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000480}
Reid Kleckner8a365022013-06-24 17:51:48 +0000481void TypeLocWriter::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
482 // nothing to do
483}
Reid Kleckner0503a872013-12-05 01:23:43 +0000484void TypeLocWriter::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
485 // nothing to do
486}
John McCall17001972009-10-18 01:05:36 +0000487void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
488 Writer.AddSourceLocation(TL.getCaretLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000489}
John McCall17001972009-10-18 01:05:36 +0000490void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
491 Writer.AddSourceLocation(TL.getAmpLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000492}
John McCall17001972009-10-18 01:05:36 +0000493void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
494 Writer.AddSourceLocation(TL.getAmpAmpLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000495}
John McCall17001972009-10-18 01:05:36 +0000496void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
497 Writer.AddSourceLocation(TL.getStarLoc(), Record);
Abramo Bagnara509357842011-03-05 14:42:21 +0000498 Writer.AddTypeSourceInfo(TL.getClassTInfo(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000499}
John McCall17001972009-10-18 01:05:36 +0000500void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) {
501 Writer.AddSourceLocation(TL.getLBracketLoc(), Record);
502 Writer.AddSourceLocation(TL.getRBracketLoc(), Record);
503 Record.push_back(TL.getSizeExpr() ? 1 : 0);
504 if (TL.getSizeExpr())
505 Writer.AddStmt(TL.getSizeExpr());
John McCall8f115c62009-10-16 21:56:05 +0000506}
John McCall17001972009-10-18 01:05:36 +0000507void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
508 VisitArrayTypeLoc(TL);
509}
510void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
511 VisitArrayTypeLoc(TL);
512}
513void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
514 VisitArrayTypeLoc(TL);
515}
516void TypeLocWriter::VisitDependentSizedArrayTypeLoc(
517 DependentSizedArrayTypeLoc TL) {
518 VisitArrayTypeLoc(TL);
519}
520void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc(
521 DependentSizedExtVectorTypeLoc TL) {
522 Writer.AddSourceLocation(TL.getNameLoc(), Record);
523}
524void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) {
525 Writer.AddSourceLocation(TL.getNameLoc(), Record);
526}
527void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
528 Writer.AddSourceLocation(TL.getNameLoc(), Record);
529}
530void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
Abramo Bagnaraf2a79d92011-03-12 11:17:06 +0000531 Writer.AddSourceLocation(TL.getLocalRangeBegin(), Record);
Abramo Bagnaraaeeb9892012-10-04 21:42:10 +0000532 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
533 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
Abramo Bagnaraf2a79d92011-03-12 11:17:06 +0000534 Writer.AddSourceLocation(TL.getLocalRangeEnd(), Record);
Alp Tokerb3fd5cf2014-01-21 00:32:38 +0000535 for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i)
536 Writer.AddDeclRef(TL.getParam(i), Record);
John McCall17001972009-10-18 01:05:36 +0000537}
538void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
539 VisitFunctionTypeLoc(TL);
540}
541void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
542 VisitFunctionTypeLoc(TL);
543}
John McCallb96ec562009-12-04 22:46:56 +0000544void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
545 Writer.AddSourceLocation(TL.getNameLoc(), Record);
546}
John McCall17001972009-10-18 01:05:36 +0000547void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
548 Writer.AddSourceLocation(TL.getNameLoc(), Record);
549}
550void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
John McCalle8595032010-01-13 20:03:27 +0000551 Writer.AddSourceLocation(TL.getTypeofLoc(), Record);
552 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
553 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
John McCall17001972009-10-18 01:05:36 +0000554}
555void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
John McCalle8595032010-01-13 20:03:27 +0000556 Writer.AddSourceLocation(TL.getTypeofLoc(), Record);
557 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
558 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
559 Writer.AddTypeSourceInfo(TL.getUnderlyingTInfo(), Record);
John McCall17001972009-10-18 01:05:36 +0000560}
561void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
562 Writer.AddSourceLocation(TL.getNameLoc(), Record);
563}
Alexis Hunte852b102011-05-24 22:41:36 +0000564void TypeLocWriter::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
565 Writer.AddSourceLocation(TL.getKWLoc(), Record);
566 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
567 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
568 Writer.AddTypeSourceInfo(TL.getUnderlyingTInfo(), Record);
569}
Richard Smith30482bc2011-02-20 03:19:35 +0000570void TypeLocWriter::VisitAutoTypeLoc(AutoTypeLoc TL) {
571 Writer.AddSourceLocation(TL.getNameLoc(), Record);
572}
John McCall17001972009-10-18 01:05:36 +0000573void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) {
574 Writer.AddSourceLocation(TL.getNameLoc(), Record);
575}
576void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) {
577 Writer.AddSourceLocation(TL.getNameLoc(), Record);
578}
John McCall81904512011-01-06 01:58:22 +0000579void TypeLocWriter::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
580 Writer.AddSourceLocation(TL.getAttrNameLoc(), Record);
581 if (TL.hasAttrOperand()) {
582 SourceRange range = TL.getAttrOperandParensRange();
583 Writer.AddSourceLocation(range.getBegin(), Record);
584 Writer.AddSourceLocation(range.getEnd(), Record);
585 }
586 if (TL.hasAttrExprOperand()) {
587 Expr *operand = TL.getAttrExprOperand();
588 Record.push_back(operand ? 1 : 0);
589 if (operand) Writer.AddStmt(operand);
590 } else if (TL.hasAttrEnumOperand()) {
591 Writer.AddSourceLocation(TL.getAttrEnumOperandLoc(), Record);
592 }
593}
John McCall17001972009-10-18 01:05:36 +0000594void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
595 Writer.AddSourceLocation(TL.getNameLoc(), Record);
596}
John McCallcebee162009-10-18 09:09:24 +0000597void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
598 SubstTemplateTypeParmTypeLoc TL) {
599 Writer.AddSourceLocation(TL.getNameLoc(), Record);
600}
Douglas Gregorada4b792011-01-14 02:55:32 +0000601void TypeLocWriter::VisitSubstTemplateTypeParmPackTypeLoc(
602 SubstTemplateTypeParmPackTypeLoc TL) {
603 Writer.AddSourceLocation(TL.getNameLoc(), Record);
604}
John McCall17001972009-10-18 01:05:36 +0000605void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
606 TemplateSpecializationTypeLoc TL) {
Abramo Bagnara48c05be2012-02-06 14:41:24 +0000607 Writer.AddSourceLocation(TL.getTemplateKeywordLoc(), Record);
John McCall0ad16662009-10-29 08:12:44 +0000608 Writer.AddSourceLocation(TL.getTemplateNameLoc(), Record);
609 Writer.AddSourceLocation(TL.getLAngleLoc(), Record);
610 Writer.AddSourceLocation(TL.getRAngleLoc(), Record);
611 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +0000612 Writer.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(),
613 TL.getArgLoc(i).getLocInfo(), Record);
John McCall17001972009-10-18 01:05:36 +0000614}
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000615void TypeLocWriter::VisitParenTypeLoc(ParenTypeLoc TL) {
616 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
617 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
618}
Abramo Bagnara6150c882010-05-11 21:36:43 +0000619void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
Abramo Bagnara9033e2b2012-02-06 19:09:27 +0000620 Writer.AddSourceLocation(TL.getElaboratedKeywordLoc(), Record);
Douglas Gregor844cb502011-03-01 18:12:44 +0000621 Writer.AddNestedNameSpecifierLoc(TL.getQualifierLoc(), Record);
John McCall17001972009-10-18 01:05:36 +0000622}
John McCalle78aac42010-03-10 03:28:59 +0000623void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
624 Writer.AddSourceLocation(TL.getNameLoc(), Record);
625}
Douglas Gregorc1d2d8a2010-03-31 17:34:00 +0000626void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
Abramo Bagnara9033e2b2012-02-06 19:09:27 +0000627 Writer.AddSourceLocation(TL.getElaboratedKeywordLoc(), Record);
Douglas Gregor3d0da5f2011-03-01 01:34:45 +0000628 Writer.AddNestedNameSpecifierLoc(TL.getQualifierLoc(), Record);
John McCall17001972009-10-18 01:05:36 +0000629 Writer.AddSourceLocation(TL.getNameLoc(), Record);
630}
John McCallc392f372010-06-11 00:33:02 +0000631void TypeLocWriter::VisitDependentTemplateSpecializationTypeLoc(
632 DependentTemplateSpecializationTypeLoc TL) {
Abramo Bagnara48c05be2012-02-06 14:41:24 +0000633 Writer.AddSourceLocation(TL.getElaboratedKeywordLoc(), Record);
Douglas Gregora7a795b2011-03-01 20:11:18 +0000634 Writer.AddNestedNameSpecifierLoc(TL.getQualifierLoc(), Record);
Abramo Bagnarae0a70b22012-02-06 22:45:07 +0000635 Writer.AddSourceLocation(TL.getTemplateKeywordLoc(), Record);
Abramo Bagnara48c05be2012-02-06 14:41:24 +0000636 Writer.AddSourceLocation(TL.getTemplateNameLoc(), Record);
John McCallc392f372010-06-11 00:33:02 +0000637 Writer.AddSourceLocation(TL.getLAngleLoc(), Record);
638 Writer.AddSourceLocation(TL.getRAngleLoc(), Record);
639 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +0000640 Writer.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(),
641 TL.getArgLoc(I).getLocInfo(), Record);
John McCallc392f372010-06-11 00:33:02 +0000642}
Douglas Gregord2fa7662010-12-20 02:24:11 +0000643void TypeLocWriter::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
644 Writer.AddSourceLocation(TL.getEllipsisLoc(), Record);
645}
John McCall17001972009-10-18 01:05:36 +0000646void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
647 Writer.AddSourceLocation(TL.getNameLoc(), Record);
John McCall8b07ec22010-05-15 11:32:37 +0000648}
649void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
650 Record.push_back(TL.hasBaseTypeAsWritten());
John McCall17001972009-10-18 01:05:36 +0000651 Writer.AddSourceLocation(TL.getLAngleLoc(), Record);
652 Writer.AddSourceLocation(TL.getRAngleLoc(), Record);
653 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
654 Writer.AddSourceLocation(TL.getProtocolLoc(i), Record);
John McCall8f115c62009-10-16 21:56:05 +0000655}
John McCallfc93cf92009-10-22 22:37:11 +0000656void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
657 Writer.AddSourceLocation(TL.getStarLoc(), Record);
John McCallfc93cf92009-10-22 22:37:11 +0000658}
Eli Friedman0dfb8892011-10-06 23:00:33 +0000659void TypeLocWriter::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
660 Writer.AddSourceLocation(TL.getKWLoc(), Record);
661 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
662 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
663}
John McCall8f115c62009-10-16 21:56:05 +0000664
Richard Smith01b2cb42014-07-26 06:37:51 +0000665void ASTWriter::WriteTypeAbbrevs() {
666 using namespace llvm;
667
668 BitCodeAbbrev *Abv;
669
670 // Abbreviation for TYPE_EXT_QUAL
671 Abv = new BitCodeAbbrev();
672 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_EXT_QUAL));
673 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
674 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 3)); // Quals
675 TypeExtQualAbbrev = Stream.EmitAbbrev(Abv);
676
677 // Abbreviation for TYPE_FUNCTION_PROTO
678 Abv = new BitCodeAbbrev();
679 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_FUNCTION_PROTO));
680 // FunctionType
681 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ReturnType
682 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // NoReturn
683 Abv->Add(BitCodeAbbrevOp(0)); // HasRegParm
684 Abv->Add(BitCodeAbbrevOp(0)); // RegParm
685 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // CC
686 Abv->Add(BitCodeAbbrevOp(0)); // ProducesResult
687 // FunctionProtoType
688 Abv->Add(BitCodeAbbrevOp(0)); // IsVariadic
689 Abv->Add(BitCodeAbbrevOp(0)); // HasTrailingReturn
690 Abv->Add(BitCodeAbbrevOp(0)); // TypeQuals
691 Abv->Add(BitCodeAbbrevOp(0)); // RefQualifier
692 Abv->Add(BitCodeAbbrevOp(EST_None)); // ExceptionSpec
693 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // NumParams
694 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
695 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Params
696 TypeFunctionProtoAbbrev = Stream.EmitAbbrev(Abv);
697}
698
Chris Lattner19cea4e2009-04-22 05:57:30 +0000699//===----------------------------------------------------------------------===//
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000700// ASTWriter Implementation
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000701//===----------------------------------------------------------------------===//
702
Chris Lattner28fa4e62009-04-26 22:26:21 +0000703static void EmitBlockID(unsigned ID, const char *Name,
704 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000705 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000706 Record.clear();
707 Record.push_back(ID);
708 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
709
710 // Emit the block name if present.
Craig Toppera13603a2014-05-22 05:54:18 +0000711 if (!Name || Name[0] == 0)
712 return;
Chris Lattner28fa4e62009-04-26 22:26:21 +0000713 Record.clear();
714 while (*Name)
715 Record.push_back(*Name++);
716 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record);
717}
718
719static void EmitRecordID(unsigned ID, const char *Name,
720 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000721 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000722 Record.clear();
723 Record.push_back(ID);
724 while (*Name)
725 Record.push_back(*Name++);
726 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000727}
728
729static void AddStmtsExprs(llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000730 ASTWriter::RecordDataImpl &Record) {
Sebastian Redl539c5062010-08-18 23:57:32 +0000731#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Chris Lattnerccac3a62009-04-27 00:49:53 +0000732 RECORD(STMT_STOP);
733 RECORD(STMT_NULL_PTR);
Richard Smith01b2cb42014-07-26 06:37:51 +0000734 RECORD(STMT_REF_PTR);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000735 RECORD(STMT_NULL);
736 RECORD(STMT_COMPOUND);
737 RECORD(STMT_CASE);
738 RECORD(STMT_DEFAULT);
739 RECORD(STMT_LABEL);
Richard Smithc202b282012-04-14 00:33:13 +0000740 RECORD(STMT_ATTRIBUTED);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000741 RECORD(STMT_IF);
742 RECORD(STMT_SWITCH);
743 RECORD(STMT_WHILE);
744 RECORD(STMT_DO);
745 RECORD(STMT_FOR);
746 RECORD(STMT_GOTO);
747 RECORD(STMT_INDIRECT_GOTO);
748 RECORD(STMT_CONTINUE);
749 RECORD(STMT_BREAK);
750 RECORD(STMT_RETURN);
751 RECORD(STMT_DECL);
Chad Rosierde70e0e2012-08-25 00:11:56 +0000752 RECORD(STMT_GCCASM);
Chad Rosiere30d4992012-08-24 23:51:02 +0000753 RECORD(STMT_MSASM);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000754 RECORD(EXPR_PREDEFINED);
755 RECORD(EXPR_DECL_REF);
756 RECORD(EXPR_INTEGER_LITERAL);
757 RECORD(EXPR_FLOATING_LITERAL);
758 RECORD(EXPR_IMAGINARY_LITERAL);
759 RECORD(EXPR_STRING_LITERAL);
760 RECORD(EXPR_CHARACTER_LITERAL);
761 RECORD(EXPR_PAREN);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000762 RECORD(EXPR_PAREN_LIST);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000763 RECORD(EXPR_UNARY_OPERATOR);
764 RECORD(EXPR_SIZEOF_ALIGN_OF);
765 RECORD(EXPR_ARRAY_SUBSCRIPT);
766 RECORD(EXPR_CALL);
767 RECORD(EXPR_MEMBER);
768 RECORD(EXPR_BINARY_OPERATOR);
769 RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR);
770 RECORD(EXPR_CONDITIONAL_OPERATOR);
771 RECORD(EXPR_IMPLICIT_CAST);
772 RECORD(EXPR_CSTYLE_CAST);
773 RECORD(EXPR_COMPOUND_LITERAL);
774 RECORD(EXPR_EXT_VECTOR_ELEMENT);
775 RECORD(EXPR_INIT_LIST);
776 RECORD(EXPR_DESIGNATED_INIT);
777 RECORD(EXPR_IMPLICIT_VALUE_INIT);
778 RECORD(EXPR_VA_ARG);
779 RECORD(EXPR_ADDR_LABEL);
780 RECORD(EXPR_STMT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000781 RECORD(EXPR_CHOOSE);
782 RECORD(EXPR_GNU_NULL);
783 RECORD(EXPR_SHUFFLE_VECTOR);
784 RECORD(EXPR_BLOCK);
Peter Collingbourne91147592011-04-15 00:35:48 +0000785 RECORD(EXPR_GENERIC_SELECTION);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000786 RECORD(EXPR_OBJC_STRING_LITERAL);
Patrick Beard0caa3942012-04-19 00:25:12 +0000787 RECORD(EXPR_OBJC_BOXED_EXPRESSION);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000788 RECORD(EXPR_OBJC_ARRAY_LITERAL);
789 RECORD(EXPR_OBJC_DICTIONARY_LITERAL);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000790 RECORD(EXPR_OBJC_ENCODE);
791 RECORD(EXPR_OBJC_SELECTOR_EXPR);
792 RECORD(EXPR_OBJC_PROTOCOL_EXPR);
793 RECORD(EXPR_OBJC_IVAR_REF_EXPR);
794 RECORD(EXPR_OBJC_PROPERTY_REF_EXPR);
795 RECORD(EXPR_OBJC_KVC_REF_EXPR);
796 RECORD(EXPR_OBJC_MESSAGE_EXPR);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000797 RECORD(STMT_OBJC_FOR_COLLECTION);
798 RECORD(STMT_OBJC_CATCH);
799 RECORD(STMT_OBJC_FINALLY);
800 RECORD(STMT_OBJC_AT_TRY);
801 RECORD(STMT_OBJC_AT_SYNCHRONIZED);
802 RECORD(STMT_OBJC_AT_THROW);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000803 RECORD(EXPR_OBJC_BOOL_LITERAL);
Richard Smith01b2cb42014-07-26 06:37:51 +0000804 RECORD(STMT_CXX_CATCH);
805 RECORD(STMT_CXX_TRY);
806 RECORD(STMT_CXX_FOR_RANGE);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000807 RECORD(EXPR_CXX_OPERATOR_CALL);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000808 RECORD(EXPR_CXX_MEMBER_CALL);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000809 RECORD(EXPR_CXX_CONSTRUCT);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000810 RECORD(EXPR_CXX_TEMPORARY_OBJECT);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000811 RECORD(EXPR_CXX_STATIC_CAST);
812 RECORD(EXPR_CXX_DYNAMIC_CAST);
813 RECORD(EXPR_CXX_REINTERPRET_CAST);
814 RECORD(EXPR_CXX_CONST_CAST);
815 RECORD(EXPR_CXX_FUNCTIONAL_CAST);
Richard Smithc67fdd42012-03-07 08:35:16 +0000816 RECORD(EXPR_USER_DEFINED_LITERAL);
Richard Smithcc1b96d2013-06-12 22:31:48 +0000817 RECORD(EXPR_CXX_STD_INITIALIZER_LIST);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000818 RECORD(EXPR_CXX_BOOL_LITERAL);
819 RECORD(EXPR_CXX_NULL_PTR_LITERAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000820 RECORD(EXPR_CXX_TYPEID_EXPR);
821 RECORD(EXPR_CXX_TYPEID_TYPE);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000822 RECORD(EXPR_CXX_THIS);
823 RECORD(EXPR_CXX_THROW);
824 RECORD(EXPR_CXX_DEFAULT_ARG);
Richard Smith01b2cb42014-07-26 06:37:51 +0000825 RECORD(EXPR_CXX_DEFAULT_INIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000826 RECORD(EXPR_CXX_BIND_TEMPORARY);
827 RECORD(EXPR_CXX_SCALAR_VALUE_INIT);
828 RECORD(EXPR_CXX_NEW);
829 RECORD(EXPR_CXX_DELETE);
830 RECORD(EXPR_CXX_PSEUDO_DESTRUCTOR);
831 RECORD(EXPR_EXPR_WITH_CLEANUPS);
832 RECORD(EXPR_CXX_DEPENDENT_SCOPE_MEMBER);
833 RECORD(EXPR_CXX_DEPENDENT_SCOPE_DECL_REF);
834 RECORD(EXPR_CXX_UNRESOLVED_CONSTRUCT);
835 RECORD(EXPR_CXX_UNRESOLVED_MEMBER);
836 RECORD(EXPR_CXX_UNRESOLVED_LOOKUP);
Richard Smith01b2cb42014-07-26 06:37:51 +0000837 RECORD(EXPR_CXX_EXPRESSION_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000838 RECORD(EXPR_CXX_NOEXCEPT);
839 RECORD(EXPR_OPAQUE_VALUE);
Richard Smith01b2cb42014-07-26 06:37:51 +0000840 RECORD(EXPR_BINARY_CONDITIONAL_OPERATOR);
841 RECORD(EXPR_TYPE_TRAIT);
842 RECORD(EXPR_ARRAY_TYPE_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000843 RECORD(EXPR_PACK_EXPANSION);
844 RECORD(EXPR_SIZEOF_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +0000845 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000846 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +0000847 RECORD(EXPR_FUNCTION_PARM_PACK);
848 RECORD(EXPR_MATERIALIZE_TEMPORARY);
Peter Collingbourne41f85462011-02-09 21:07:24 +0000849 RECORD(EXPR_CUDA_KERNEL_CALL);
Richard Smith01b2cb42014-07-26 06:37:51 +0000850 RECORD(EXPR_CXX_UUIDOF_EXPR);
851 RECORD(EXPR_CXX_UUIDOF_TYPE);
852 RECORD(EXPR_LAMBDA);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000853#undef RECORD
Chris Lattner28fa4e62009-04-26 22:26:21 +0000854}
Mike Stump11289f42009-09-09 15:08:12 +0000855
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000856void ASTWriter::WriteBlockInfoBlock() {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000857 RecordData Record;
858 Stream.EnterSubblock(llvm::bitc::BLOCKINFO_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +0000859
Sebastian Redl539c5062010-08-18 23:57:32 +0000860#define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record)
861#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Mike Stump11289f42009-09-09 15:08:12 +0000862
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000863 // Control Block.
864 BLOCK(CONTROL_BLOCK);
865 RECORD(METADATA);
Ben Langmuir487ea142014-10-23 18:05:36 +0000866 RECORD(SIGNATURE);
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000867 RECORD(MODULE_NAME);
868 RECORD(MODULE_MAP_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000869 RECORD(IMPORTS);
870 RECORD(LANGUAGE_OPTIONS);
871 RECORD(TARGET_OPTIONS);
Douglas Gregorfad10d82012-10-18 18:36:53 +0000872 RECORD(ORIGINAL_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000873 RECORD(ORIGINAL_PCH_DIR);
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +0000874 RECORD(ORIGINAL_FILE_ID);
Douglas Gregor3120d2c2012-10-22 18:42:04 +0000875 RECORD(INPUT_FILE_OFFSETS);
Douglas Gregor8263ffb2012-10-24 15:17:15 +0000876 RECORD(DIAGNOSTIC_OPTIONS);
Douglas Gregorc6317db2012-10-24 15:49:58 +0000877 RECORD(FILE_SYSTEM_OPTIONS);
Douglas Gregor2d302362012-10-24 16:50:34 +0000878 RECORD(HEADER_SEARCH_OPTIONS);
Douglas Gregorb6af6c22012-10-24 20:05:57 +0000879 RECORD(PREPROCESSOR_OPTIONS);
880
Douglas Gregor108cb222012-10-19 00:45:00 +0000881 BLOCK(INPUT_FILES_BLOCK);
882 RECORD(INPUT_FILE);
883
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000884 // AST Top-Level Block.
885 BLOCK(AST_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000886 RECORD(TYPE_OFFSET);
887 RECORD(DECL_OFFSET);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000888 RECORD(IDENTIFIER_OFFSET);
889 RECORD(IDENTIFIER_TABLE);
Ben Langmuir332aafe2014-01-31 01:06:56 +0000890 RECORD(EAGERLY_DESERIALIZED_DECLS);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000891 RECORD(SPECIAL_TYPES);
892 RECORD(STATISTICS);
893 RECORD(TENTATIVE_DEFINITIONS);
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +0000894 RECORD(UNUSED_FILESCOPED_DECLS);
Richard Smith78165b52013-01-10 23:43:47 +0000895 RECORD(LOCALLY_SCOPED_EXTERN_C_DECLS);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000896 RECORD(SELECTOR_OFFSETS);
897 RECORD(METHOD_POOL);
898 RECORD(PP_COUNTER_VALUE);
Douglas Gregor258ae542009-04-27 06:38:32 +0000899 RECORD(SOURCE_LOCATION_OFFSETS);
900 RECORD(SOURCE_LOCATION_PRELOADS);
Douglas Gregor61cac2b2009-04-27 20:06:05 +0000901 RECORD(EXT_VECTOR_DECLS);
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +0000902 RECORD(PPD_ENTITIES_OFFSETS);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +0000903 RECORD(REFERENCED_SELECTOR_POOL);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000904 RECORD(TU_UPDATE_LEXICAL);
Douglas Gregor358cd442012-01-15 16:58:34 +0000905 RECORD(LOCAL_REDECLARATIONS_MAP);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000906 RECORD(SEMA_DECL_REFS);
907 RECORD(WEAK_UNDECLARED_IDENTIFIERS);
908 RECORD(PENDING_IMPLICIT_INSTANTIATIONS);
909 RECORD(DECL_REPLACEMENTS);
910 RECORD(UPDATE_VISIBLE);
911 RECORD(DECL_UPDATE_OFFSETS);
912 RECORD(DECL_UPDATES);
913 RECORD(CXX_BASE_SPECIFIER_OFFSETS);
914 RECORD(DIAG_PRAGMA_MAPPINGS);
Peter Collingbourne5df20e02011-02-15 19:46:30 +0000915 RECORD(CUDA_SPECIAL_DECL_REFS);
Douglas Gregor09b69892011-02-10 17:09:37 +0000916 RECORD(HEADER_SEARCH_TABLE);
Peter Collingbourne5df20e02011-02-15 19:46:30 +0000917 RECORD(FP_PRAGMA_OPTIONS);
918 RECORD(OPENCL_EXTENSIONS);
Alexis Hunt27a761d2011-05-04 23:29:54 +0000919 RECORD(DELEGATING_CTORS);
Douglas Gregorc2fa1692011-06-28 16:20:02 +0000920 RECORD(KNOWN_NAMESPACES);
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +0000921 RECORD(UNDEFINED_BUT_USED);
Douglas Gregor78d0b572011-08-04 16:39:39 +0000922 RECORD(MODULE_OFFSET_MAP);
923 RECORD(SOURCE_MANAGER_LINE_TABLE);
Douglas Gregor404cdde2012-01-27 01:47:08 +0000924 RECORD(OBJC_CATEGORIES_MAP);
Douglas Gregor66e4add2011-12-19 21:09:25 +0000925 RECORD(FILE_SORTED_DECLS);
926 RECORD(IMPORTED_MODULES);
Douglas Gregor358cd442012-01-15 16:58:34 +0000927 RECORD(MERGED_DECLARATIONS);
928 RECORD(LOCAL_REDECLARATIONS);
Douglas Gregor404cdde2012-01-27 01:47:08 +0000929 RECORD(OBJC_CATEGORIES);
Douglas Gregorcb28f9d2012-10-09 23:05:51 +0000930 RECORD(MACRO_OFFSET);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +0000931 RECORD(MACRO_TABLE);
Richard Smithe40f2ba2013-08-07 21:41:30 +0000932 RECORD(LATE_PARSED_TEMPLATE);
Dario Domizioli13a0a382014-05-23 12:13:25 +0000933 RECORD(OPTIMIZE_PRAGMA_OPTIONS);
Douglas Gregor358cd442012-01-15 16:58:34 +0000934
Chris Lattner28fa4e62009-04-26 22:26:21 +0000935 // SourceManager Block.
Chris Lattner64031982009-04-27 00:40:25 +0000936 BLOCK(SOURCE_MANAGER_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000937 RECORD(SM_SLOC_FILE_ENTRY);
938 RECORD(SM_SLOC_BUFFER_ENTRY);
939 RECORD(SM_SLOC_BUFFER_BLOB);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +0000940 RECORD(SM_SLOC_EXPANSION_ENTRY);
Mike Stump11289f42009-09-09 15:08:12 +0000941
Chris Lattner28fa4e62009-04-26 22:26:21 +0000942 // Preprocessor Block.
Chris Lattner64031982009-04-27 00:40:25 +0000943 BLOCK(PREPROCESSOR_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000944 RECORD(PP_MACRO_OBJECT_LIKE);
945 RECORD(PP_MACRO_FUNCTION_LIKE);
946 RECORD(PP_TOKEN);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000947
Douglas Gregor12bfa382009-10-17 00:13:19 +0000948 // Decls and Types block.
949 BLOCK(DECLTYPES_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000950 RECORD(TYPE_EXT_QUAL);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000951 RECORD(TYPE_COMPLEX);
952 RECORD(TYPE_POINTER);
953 RECORD(TYPE_BLOCK_POINTER);
954 RECORD(TYPE_LVALUE_REFERENCE);
955 RECORD(TYPE_RVALUE_REFERENCE);
956 RECORD(TYPE_MEMBER_POINTER);
957 RECORD(TYPE_CONSTANT_ARRAY);
958 RECORD(TYPE_INCOMPLETE_ARRAY);
959 RECORD(TYPE_VARIABLE_ARRAY);
960 RECORD(TYPE_VECTOR);
961 RECORD(TYPE_EXT_VECTOR);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000962 RECORD(TYPE_FUNCTION_NO_PROTO);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000963 RECORD(TYPE_FUNCTION_PROTO);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000964 RECORD(TYPE_TYPEDEF);
965 RECORD(TYPE_TYPEOF_EXPR);
966 RECORD(TYPE_TYPEOF);
967 RECORD(TYPE_RECORD);
968 RECORD(TYPE_ENUM);
969 RECORD(TYPE_OBJC_INTERFACE);
Steve Narofffb4330f2009-06-17 22:40:22 +0000970 RECORD(TYPE_OBJC_OBJECT_POINTER);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000971 RECORD(TYPE_DECLTYPE);
972 RECORD(TYPE_ELABORATED);
973 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
974 RECORD(TYPE_UNRESOLVED_USING);
975 RECORD(TYPE_INJECTED_CLASS_NAME);
976 RECORD(TYPE_OBJC_OBJECT);
977 RECORD(TYPE_TEMPLATE_TYPE_PARM);
978 RECORD(TYPE_TEMPLATE_SPECIALIZATION);
979 RECORD(TYPE_DEPENDENT_NAME);
980 RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION);
981 RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
982 RECORD(TYPE_PAREN);
983 RECORD(TYPE_PACK_EXPANSION);
984 RECORD(TYPE_ATTRIBUTED);
985 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000986 RECORD(TYPE_AUTO);
987 RECORD(TYPE_UNARY_TRANSFORM);
Eli Friedman0dfb8892011-10-06 23:00:33 +0000988 RECORD(TYPE_ATOMIC);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000989 RECORD(TYPE_DECAYED);
990 RECORD(TYPE_ADJUSTED);
Chris Lattnerdb397b62009-04-26 22:32:16 +0000991 RECORD(DECL_TYPEDEF);
Richard Smith01b2cb42014-07-26 06:37:51 +0000992 RECORD(DECL_TYPEALIAS);
Chris Lattnerdb397b62009-04-26 22:32:16 +0000993 RECORD(DECL_ENUM);
994 RECORD(DECL_RECORD);
995 RECORD(DECL_ENUM_CONSTANT);
996 RECORD(DECL_FUNCTION);
997 RECORD(DECL_OBJC_METHOD);
998 RECORD(DECL_OBJC_INTERFACE);
999 RECORD(DECL_OBJC_PROTOCOL);
1000 RECORD(DECL_OBJC_IVAR);
1001 RECORD(DECL_OBJC_AT_DEFS_FIELD);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001002 RECORD(DECL_OBJC_CATEGORY);
1003 RECORD(DECL_OBJC_CATEGORY_IMPL);
1004 RECORD(DECL_OBJC_IMPLEMENTATION);
1005 RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
1006 RECORD(DECL_OBJC_PROPERTY);
1007 RECORD(DECL_OBJC_PROPERTY_IMPL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001008 RECORD(DECL_FIELD);
John McCall5e77d762013-04-16 07:28:30 +00001009 RECORD(DECL_MS_PROPERTY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001010 RECORD(DECL_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001011 RECORD(DECL_IMPLICIT_PARAM);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001012 RECORD(DECL_PARM_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001013 RECORD(DECL_FILE_SCOPE_ASM);
1014 RECORD(DECL_BLOCK);
1015 RECORD(DECL_CONTEXT_LEXICAL);
1016 RECORD(DECL_CONTEXT_VISIBLE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001017 RECORD(DECL_NAMESPACE);
1018 RECORD(DECL_NAMESPACE_ALIAS);
1019 RECORD(DECL_USING);
1020 RECORD(DECL_USING_SHADOW);
1021 RECORD(DECL_USING_DIRECTIVE);
1022 RECORD(DECL_UNRESOLVED_USING_VALUE);
1023 RECORD(DECL_UNRESOLVED_USING_TYPENAME);
1024 RECORD(DECL_LINKAGE_SPEC);
1025 RECORD(DECL_CXX_RECORD);
1026 RECORD(DECL_CXX_METHOD);
1027 RECORD(DECL_CXX_CONSTRUCTOR);
1028 RECORD(DECL_CXX_DESTRUCTOR);
1029 RECORD(DECL_CXX_CONVERSION);
1030 RECORD(DECL_ACCESS_SPEC);
1031 RECORD(DECL_FRIEND);
1032 RECORD(DECL_FRIEND_TEMPLATE);
1033 RECORD(DECL_CLASS_TEMPLATE);
1034 RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
1035 RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
Larisse Voufo39a1e502013-08-06 01:03:05 +00001036 RECORD(DECL_VAR_TEMPLATE);
1037 RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION);
1038 RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001039 RECORD(DECL_FUNCTION_TEMPLATE);
1040 RECORD(DECL_TEMPLATE_TYPE_PARM);
1041 RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
1042 RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
1043 RECORD(DECL_STATIC_ASSERT);
1044 RECORD(DECL_CXX_BASE_SPECIFIERS);
1045 RECORD(DECL_INDIRECTFIELD);
1046 RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
1047
Douglas Gregor03412ba2011-06-03 02:27:19 +00001048 // Statements and Exprs can occur in the Decls and Types block.
1049 AddStmtsExprs(Stream, Record);
1050
Douglas Gregor92a96f52011-02-08 21:58:10 +00001051 BLOCK(PREPROCESSOR_DETAIL_BLOCK);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001052 RECORD(PPD_MACRO_EXPANSION);
Douglas Gregor92a96f52011-02-08 21:58:10 +00001053 RECORD(PPD_MACRO_DEFINITION);
1054 RECORD(PPD_INCLUSION_DIRECTIVE);
1055
Chris Lattner28fa4e62009-04-26 22:26:21 +00001056#undef RECORD
1057#undef BLOCK
1058 Stream.ExitBlock();
1059}
1060
Richard Smith54cc3c22014-12-11 20:50:24 +00001061/// \brief Prepares a path for being written to an AST file by converting it
1062/// to an absolute path and removing nested './'s.
1063///
1064/// \return \c true if the path was changed.
1065bool cleanPathForOutput(FileManager &FileMgr, SmallVectorImpl<char> &Path) {
1066 bool Changed = false;
1067
1068 if (!llvm::sys::path::is_absolute(StringRef(Path.data(), Path.size()))) {
1069 llvm::sys::fs::make_absolute(Path);
1070 Changed = true;
1071 }
1072
1073 return Changed | FileMgr.removeDotPaths(Path);
1074}
1075
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001076/// \brief Adjusts the given filename to only write out the portion of the
1077/// filename that is not part of the system root directory.
Mike Stump11289f42009-09-09 15:08:12 +00001078///
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001079/// \param Filename the file name to adjust.
1080///
Richard Smith7ed1bc92014-12-05 22:42:13 +00001081/// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
1082/// the returned filename will be adjusted by this root directory.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001083///
1084/// \returns either the original filename (if it needs no adjustment) or the
1085/// adjusted filename (which points into the @p Filename parameter).
Mike Stump11289f42009-09-09 15:08:12 +00001086static const char *
Richard Smith7ed1bc92014-12-05 22:42:13 +00001087adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001088 assert(Filename && "No file name to adjust?");
Mike Stump11289f42009-09-09 15:08:12 +00001089
Richard Smith7ed1bc92014-12-05 22:42:13 +00001090 if (BaseDir.empty())
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001091 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001092
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001093 // Verify that the filename and the system root have the same prefix.
1094 unsigned Pos = 0;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001095 for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1096 if (Filename[Pos] != BaseDir[Pos])
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001097 return Filename; // Prefixes don't match.
Mike Stump11289f42009-09-09 15:08:12 +00001098
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001099 // We hit the end of the filename before we hit the end of the system root.
1100 if (!Filename[Pos])
1101 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001102
Richard Smith7ed1bc92014-12-05 22:42:13 +00001103 // If there's not a path separator at the end of the base directory nor
1104 // immediately after it, then this isn't within the base directory.
1105 if (!llvm::sys::path::is_separator(Filename[Pos])) {
1106 if (!llvm::sys::path::is_separator(BaseDir.back()))
1107 return Filename;
1108 } else {
1109 // If the file name has a '/' at the current position, skip over the '/'.
1110 // We distinguish relative paths from absolute paths by the
1111 // absence of '/' at the beginning of relative paths.
1112 //
1113 // FIXME: This is wrong. We distinguish them by asking if the path is
1114 // absolute, which isn't the same thing. And there might be multiple '/'s
1115 // in a row. Use a better mechanism to indicate whether we have emitted an
1116 // absolute or relative path.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001117 ++Pos;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001118 }
Mike Stump11289f42009-09-09 15:08:12 +00001119
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001120 return Filename + Pos;
1121}
Chris Lattner28fa4e62009-04-26 22:26:21 +00001122
Ben Langmuir487ea142014-10-23 18:05:36 +00001123static ASTFileSignature getSignature() {
1124 while (1) {
1125 if (ASTFileSignature S = llvm::sys::Process::GetRandomNumber())
1126 return S;
1127 // Rely on GetRandomNumber to eventually return non-zero...
1128 }
1129}
1130
Douglas Gregor112b9072012-10-18 05:31:06 +00001131/// \brief Write the control block.
Douglas Gregor2d302362012-10-24 16:50:34 +00001132void ASTWriter::WriteControlBlock(Preprocessor &PP, ASTContext &Context,
1133 StringRef isysroot,
Douglas Gregor112b9072012-10-18 05:31:06 +00001134 const std::string &OutputFile) {
Douglas Gregorbfbde532009-04-10 21:16:55 +00001135 using namespace llvm;
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001136 Stream.EnterSubblock(CONTROL_BLOCK_ID, 5);
1137 RecordData Record;
Douglas Gregor112b9072012-10-18 05:31:06 +00001138
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001139 // Metadata
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001140 BitCodeAbbrev *MetadataAbbrev = new BitCodeAbbrev();
1141 MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA));
1142 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1143 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1144 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1145 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1146 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
1147 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1148 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
1149 unsigned MetadataAbbrevCode = Stream.EmitAbbrev(MetadataAbbrev);
1150 Record.push_back(METADATA);
Sebastian Redl539c5062010-08-18 23:57:32 +00001151 Record.push_back(VERSION_MAJOR);
1152 Record.push_back(VERSION_MINOR);
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001153 Record.push_back(CLANG_VERSION_MAJOR);
1154 Record.push_back(CLANG_VERSION_MINOR);
Richard Smith7ed1bc92014-12-05 22:42:13 +00001155 assert((!WritingModule || isysroot.empty()) &&
1156 "writing module as a relocatable PCH?");
Douglas Gregorc567ba22011-07-22 16:35:34 +00001157 Record.push_back(!isysroot.empty());
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00001158 Record.push_back(ASTHasCompilerErrors);
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001159 Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record,
1160 getClangFullRepositoryVersion());
Douglas Gregor29cc6422011-08-17 21:07:30 +00001161
Ben Langmuir487ea142014-10-23 18:05:36 +00001162 // Signature
1163 Record.clear();
1164 Record.push_back(getSignature());
1165 Stream.EmitRecord(SIGNATURE, Record);
1166
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001167 if (WritingModule) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001168 // Module name
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001169 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1170 Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME));
1171 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
1172 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1173 RecordData Record;
1174 Record.push_back(MODULE_NAME);
1175 Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name);
1176 }
1177
Richard Smith7ed1bc92014-12-05 22:42:13 +00001178 if (WritingModule && WritingModule->Directory) {
1179 // Module directory.
1180 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1181 Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY));
1182 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
1183 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1184 RecordData Record;
1185 Record.push_back(MODULE_DIRECTORY);
1186
1187 SmallString<128> BaseDir(WritingModule->Directory->getName());
Richard Smith54cc3c22014-12-11 20:50:24 +00001188 cleanPathForOutput(Context.getSourceManager().getFileManager(), BaseDir);
Richard Smith7ed1bc92014-12-05 22:42:13 +00001189 Stream.EmitRecordWithBlob(AbbrevCode, Record, BaseDir);
1190
1191 // Write out all other paths relative to the base directory if possible.
1192 BaseDirectory.assign(BaseDir.begin(), BaseDir.end());
1193 } else if (!isysroot.empty()) {
1194 // Write out paths relative to the sysroot if possible.
1195 BaseDirectory = isysroot;
1196 }
1197
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001198 // Module map file
1199 if (WritingModule) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001200 Record.clear();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001201
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001202 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
1203
1204 // Primary module map file.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001205 AddPath(Map.getModuleMapFileForUniquing(WritingModule)->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001206
1207 // Additional module map files.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001208 if (auto *AdditionalModMaps =
1209 Map.getAdditionalModuleMapFiles(WritingModule)) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001210 Record.push_back(AdditionalModMaps->size());
1211 for (const FileEntry *F : *AdditionalModMaps)
Richard Smith7ed1bc92014-12-05 22:42:13 +00001212 AddPath(F->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001213 } else {
1214 Record.push_back(0);
1215 }
1216
1217 Stream.EmitRecord(MODULE_MAP_FILE, Record);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001218 }
1219
Douglas Gregor112b9072012-10-18 05:31:06 +00001220 // Imports
Douglas Gregor29cc6422011-08-17 21:07:30 +00001221 if (Chain) {
Douglas Gregor29cc6422011-08-17 21:07:30 +00001222 serialization::ModuleManager &Mgr = Chain->getModuleManager();
Douglas Gregor29cc6422011-08-17 21:07:30 +00001223 Record.clear();
Douglas Gregordf0c1512011-08-18 04:12:04 +00001224
1225 for (ModuleManager::ModuleIterator M = Mgr.begin(), MEnd = Mgr.end();
1226 M != MEnd; ++M) {
1227 // Skip modules that weren't directly imported.
1228 if (!(*M)->isDirectlyImported())
1229 continue;
1230
1231 Record.push_back((unsigned)(*M)->Kind); // FIXME: Stable encoding
Argyrios Kyrtzidis2ec29362012-11-15 18:57:22 +00001232 AddSourceLocation((*M)->ImportLoc, Record);
Douglas Gregor7029ce12013-03-19 00:28:20 +00001233 Record.push_back((*M)->File->getSize());
1234 Record.push_back((*M)->File->getModificationTime());
Ben Langmuir487ea142014-10-23 18:05:36 +00001235 Record.push_back((*M)->Signature);
Richard Smith7ed1bc92014-12-05 22:42:13 +00001236 AddPath((*M)->FileName, Record);
Douglas Gregordf0c1512011-08-18 04:12:04 +00001237 }
Douglas Gregor29cc6422011-08-17 21:07:30 +00001238 Stream.EmitRecord(IMPORTS, Record);
1239 }
Mike Stump11289f42009-09-09 15:08:12 +00001240
Douglas Gregor112b9072012-10-18 05:31:06 +00001241 // Language options.
1242 Record.clear();
1243 const LangOptions &LangOpts = Context.getLangOpts();
1244#define LANGOPT(Name, Bits, Default, Description) \
1245 Record.push_back(LangOpts.Name);
1246#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
1247 Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001248#include "clang/Basic/LangOptions.def"
1249#define SANITIZER(NAME, ID) \
1250 Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
Will Dietzf54319c2013-01-18 11:30:38 +00001251#include "clang/Basic/Sanitizers.def"
Douglas Gregor112b9072012-10-18 05:31:06 +00001252
1253 Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind());
1254 AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record);
1255
1256 Record.push_back(LangOpts.CurrentModule.size());
1257 Record.append(LangOpts.CurrentModule.begin(), LangOpts.CurrentModule.end());
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001258
1259 // Comment options.
1260 Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size());
1261 for (CommentOptions::BlockCommandNamesTy::const_iterator
1262 I = LangOpts.CommentOpts.BlockCommandNames.begin(),
1263 IEnd = LangOpts.CommentOpts.BlockCommandNames.end();
1264 I != IEnd; ++I) {
1265 AddString(*I, Record);
1266 }
Dmitri Gribenkoa7d16ce2013-04-10 15:35:17 +00001267 Record.push_back(LangOpts.CommentOpts.ParseAllComments);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001268
Douglas Gregor112b9072012-10-18 05:31:06 +00001269 Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1270
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001271 // Target options.
1272 Record.clear();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001273 const TargetInfo &Target = Context.getTargetInfo();
1274 const TargetOptions &TargetOpts = Target.getTargetOpts();
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001275 AddString(TargetOpts.Triple, Record);
1276 AddString(TargetOpts.CPU, Record);
1277 AddString(TargetOpts.ABI, Record);
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001278 Record.push_back(TargetOpts.FeaturesAsWritten.size());
1279 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1280 AddString(TargetOpts.FeaturesAsWritten[I], Record);
1281 }
1282 Record.push_back(TargetOpts.Features.size());
1283 for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1284 AddString(TargetOpts.Features[I], Record);
1285 }
1286 Stream.EmitRecord(TARGET_OPTIONS, Record);
1287
Douglas Gregor8263ffb2012-10-24 15:17:15 +00001288 // Diagnostic options.
1289 Record.clear();
1290 const DiagnosticOptions &DiagOpts
1291 = Context.getDiagnostics().getDiagnosticOptions();
1292#define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1293#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
1294 Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1295#include "clang/Basic/DiagnosticOptions.def"
1296 Record.push_back(DiagOpts.Warnings.size());
1297 for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1298 AddString(DiagOpts.Warnings[I], Record);
Richard Smith3be1cb22014-08-07 00:24:21 +00001299 Record.push_back(DiagOpts.Remarks.size());
1300 for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1301 AddString(DiagOpts.Remarks[I], Record);
Douglas Gregor8263ffb2012-10-24 15:17:15 +00001302 // Note: we don't serialize the log or serialization file names, because they
1303 // are generally transient files and will almost always be overridden.
1304 Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record);
1305
Douglas Gregorc6317db2012-10-24 15:49:58 +00001306 // File system options.
1307 Record.clear();
1308 const FileSystemOptions &FSOpts
1309 = Context.getSourceManager().getFileManager().getFileSystemOptions();
1310 AddString(FSOpts.WorkingDir, Record);
1311 Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record);
1312
Douglas Gregor2d302362012-10-24 16:50:34 +00001313 // Header search options.
1314 Record.clear();
1315 const HeaderSearchOptions &HSOpts
1316 = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1317 AddString(HSOpts.Sysroot, Record);
1318
1319 // Include entries.
1320 Record.push_back(HSOpts.UserEntries.size());
1321 for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1322 const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1323 AddString(Entry.Path, Record);
1324 Record.push_back(static_cast<unsigned>(Entry.Group));
Douglas Gregor2d302362012-10-24 16:50:34 +00001325 Record.push_back(Entry.IsFramework);
1326 Record.push_back(Entry.IgnoreSysRoot);
Douglas Gregor2d302362012-10-24 16:50:34 +00001327 }
1328
1329 // System header prefixes.
1330 Record.push_back(HSOpts.SystemHeaderPrefixes.size());
1331 for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1332 AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1333 Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1334 }
1335
1336 AddString(HSOpts.ResourceDir, Record);
1337 AddString(HSOpts.ModuleCachePath, Record);
Argyrios Kyrtzidis1594c152014-03-03 08:12:05 +00001338 AddString(HSOpts.ModuleUserBuildPath, Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001339 Record.push_back(HSOpts.DisableModuleHash);
1340 Record.push_back(HSOpts.UseBuiltinIncludes);
1341 Record.push_back(HSOpts.UseStandardSystemIncludes);
1342 Record.push_back(HSOpts.UseStandardCXXIncludes);
1343 Record.push_back(HSOpts.UseLibcxx);
1344 Stream.EmitRecord(HEADER_SEARCH_OPTIONS, Record);
1345
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001346 // Preprocessor options.
1347 Record.clear();
1348 const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts();
1349
1350 // Macro definitions.
1351 Record.push_back(PPOpts.Macros.size());
1352 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1353 AddString(PPOpts.Macros[I].first, Record);
1354 Record.push_back(PPOpts.Macros[I].second);
1355 }
1356
1357 // Includes
1358 Record.push_back(PPOpts.Includes.size());
1359 for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1360 AddString(PPOpts.Includes[I], Record);
1361
1362 // Macro includes
1363 Record.push_back(PPOpts.MacroIncludes.size());
1364 for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1365 AddString(PPOpts.MacroIncludes[I], Record);
1366
Douglas Gregorb6368752012-10-24 23:41:50 +00001367 Record.push_back(PPOpts.UsePredefines);
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +00001368 // Detailed record is important since it is used for the module cache hash.
1369 Record.push_back(PPOpts.DetailedRecord);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001370 AddString(PPOpts.ImplicitPCHInclude, Record);
1371 AddString(PPOpts.ImplicitPTHInclude, Record);
1372 Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1373 Stream.EmitRecord(PREPROCESSOR_OPTIONS, Record);
1374
Douglas Gregora3b20262011-05-06 21:43:30 +00001375 // Original file name and file ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001376 SourceManager &SM = Context.getSourceManager();
1377 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
1378 BitCodeAbbrev *FileAbbrev = new BitCodeAbbrev();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001379 FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE));
1380 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001381 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1382 unsigned FileAbbrevCode = Stream.EmitAbbrev(FileAbbrev);
1383
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001384 Record.clear();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001385 Record.push_back(ORIGINAL_FILE);
Douglas Gregora3b20262011-05-06 21:43:30 +00001386 Record.push_back(SM.getMainFileID().getOpaqueValue());
Richard Smith7ed1bc92014-12-05 22:42:13 +00001387 EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName());
Douglas Gregor45fe0362009-05-12 01:31:05 +00001388 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001389
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001390 Record.clear();
1391 Record.push_back(SM.getMainFileID().getOpaqueValue());
1392 Stream.EmitRecord(ORIGINAL_FILE_ID, Record);
1393
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001394 // Original PCH directory
1395 if (!OutputFile.empty() && OutputFile != "-") {
1396 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1397 Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR));
1398 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1399 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1400
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001401 SmallString<128> OutputPath(OutputFile);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001402
1403 llvm::sys::fs::make_absolute(OutputPath);
1404 StringRef origDir = llvm::sys::path::parent_path(OutputPath);
1405
1406 RecordData Record;
1407 Record.push_back(ORIGINAL_PCH_DIR);
1408 Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir);
1409 }
1410
Douglas Gregor49491f72013-03-15 22:15:07 +00001411 WriteInputFiles(Context.SourceMgr,
1412 PP.getHeaderSearchInfo().getHeaderSearchOpts(),
Douglas Gregora3dd9002013-07-22 20:48:33 +00001413 PP.getLangOpts().Modules);
Douglas Gregor72be3902012-10-19 00:38:02 +00001414 Stream.ExitBlock();
1415}
1416
Douglas Gregor49491f72013-03-15 22:15:07 +00001417namespace {
1418 /// \brief An input file.
1419 struct InputFileEntry {
1420 const FileEntry *File;
1421 bool IsSystemFile;
1422 bool BufferOverridden;
1423 };
1424}
1425
1426void ASTWriter::WriteInputFiles(SourceManager &SourceMgr,
1427 HeaderSearchOptions &HSOpts,
Douglas Gregora3dd9002013-07-22 20:48:33 +00001428 bool Modules) {
Douglas Gregor72be3902012-10-19 00:38:02 +00001429 using namespace llvm;
1430 Stream.EnterSubblock(INPUT_FILES_BLOCK_ID, 4);
1431 RecordData Record;
1432
1433 // Create input-file abbreviation.
1434 BitCodeAbbrev *IFAbbrev = new BitCodeAbbrev();
1435 IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001436 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor72be3902012-10-19 00:38:02 +00001437 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1438 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001439 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
Douglas Gregor72be3902012-10-19 00:38:02 +00001440 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1441 unsigned IFAbbrevCode = Stream.EmitAbbrev(IFAbbrev);
1442
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001443 // Get all ContentCache objects for files, sorted by whether the file is a
1444 // system one or not. System files go at the back, users files at the front.
Douglas Gregor49491f72013-03-15 22:15:07 +00001445 std::deque<InputFileEntry> SortedFiles;
Douglas Gregor72be3902012-10-19 00:38:02 +00001446 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
1447 // Get this source location entry.
1448 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
NAKAMURA Takumideca50f2012-10-19 01:53:57 +00001449 assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc);
Douglas Gregor72be3902012-10-19 00:38:02 +00001450
1451 // We only care about file entries that were not overridden.
1452 if (!SLoc->isFile())
1453 continue;
1454 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001455 if (!Cache->OrigEntry)
Douglas Gregor72be3902012-10-19 00:38:02 +00001456 continue;
1457
Douglas Gregor49491f72013-03-15 22:15:07 +00001458 InputFileEntry Entry;
1459 Entry.File = Cache->OrigEntry;
1460 Entry.IsSystemFile = Cache->IsSystemFile;
1461 Entry.BufferOverridden = Cache->BufferOverridden;
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001462 if (Cache->IsSystemFile)
Douglas Gregor49491f72013-03-15 22:15:07 +00001463 SortedFiles.push_back(Entry);
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001464 else
Douglas Gregor49491f72013-03-15 22:15:07 +00001465 SortedFiles.push_front(Entry);
1466 }
1467
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001468 unsigned UserFilesNum = 0;
1469 // Write out all of the input files.
1470 std::vector<uint32_t> InputFileOffsets;
Douglas Gregor49491f72013-03-15 22:15:07 +00001471 for (std::deque<InputFileEntry>::iterator
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001472 I = SortedFiles.begin(), E = SortedFiles.end(); I != E; ++I) {
Douglas Gregor49491f72013-03-15 22:15:07 +00001473 const InputFileEntry &Entry = *I;
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001474
Douglas Gregor49491f72013-03-15 22:15:07 +00001475 uint32_t &InputFileID = InputFileIDs[Entry.File];
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001476 if (InputFileID != 0)
1477 continue; // already recorded this file.
1478
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001479 // Record this entry's offset.
1480 InputFileOffsets.push_back(Stream.GetCurrentBitNo());
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001481
1482 InputFileID = InputFileOffsets.size();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001483
Douglas Gregor49491f72013-03-15 22:15:07 +00001484 if (!Entry.IsSystemFile)
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001485 ++UserFilesNum;
1486
Douglas Gregor72be3902012-10-19 00:38:02 +00001487 Record.clear();
1488 Record.push_back(INPUT_FILE);
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001489 Record.push_back(InputFileOffsets.size());
Douglas Gregor72be3902012-10-19 00:38:02 +00001490
1491 // Emit size/modification time for this file.
Douglas Gregor49491f72013-03-15 22:15:07 +00001492 Record.push_back(Entry.File->getSize());
1493 Record.push_back(Entry.File->getModificationTime());
Douglas Gregor72be3902012-10-19 00:38:02 +00001494
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001495 // Whether this file was overridden.
Douglas Gregor49491f72013-03-15 22:15:07 +00001496 Record.push_back(Entry.BufferOverridden);
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001497
Richard Smith7ed1bc92014-12-05 22:42:13 +00001498 EmitRecordWithPath(IFAbbrevCode, Record, Entry.File->getName());
1499 }
Douglas Gregor49491f72013-03-15 22:15:07 +00001500
Douglas Gregor112b9072012-10-18 05:31:06 +00001501 Stream.ExitBlock();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001502
1503 // Create input file offsets abbreviation.
1504 BitCodeAbbrev *OffsetsAbbrev = new BitCodeAbbrev();
1505 OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1506 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001507 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1508 // input files
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001509 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Array
1510 unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(OffsetsAbbrev);
1511
1512 // Write input file offsets.
1513 Record.clear();
1514 Record.push_back(INPUT_FILE_OFFSETS);
1515 Record.push_back(InputFileOffsets.size());
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001516 Record.push_back(UserFilesNum);
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001517 Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, data(InputFileOffsets));
Douglas Gregor55abb232009-04-10 20:39:37 +00001518}
1519
Douglas Gregora7f71a92009-04-10 03:52:48 +00001520//===----------------------------------------------------------------------===//
1521// Source Manager Serialization
1522//===----------------------------------------------------------------------===//
1523
1524/// \brief Create an abbreviation for the SLocEntry that refers to a
1525/// file.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001526static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001527 using namespace llvm;
1528 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001529 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001530 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1531 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1532 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1533 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
Douglas Gregorb41ca8f2010-03-21 22:49:54 +00001534 // FileEntry fields.
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001535 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001536 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001537 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
1538 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
Douglas Gregor8f45df52009-04-16 22:23:12 +00001539 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001540}
1541
1542/// \brief Create an abbreviation for the SLocEntry that refers to a
1543/// buffer.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001544static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001545 using namespace llvm;
1546 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001547 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001548 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1549 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1550 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1551 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1552 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
Douglas Gregor8f45df52009-04-16 22:23:12 +00001553 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001554}
1555
1556/// \brief Create an abbreviation for the SLocEntry that refers to a
1557/// buffer's blob.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001558static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001559 using namespace llvm;
1560 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001561 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_BLOB));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001562 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
Douglas Gregor8f45df52009-04-16 22:23:12 +00001563 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001564}
1565
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001566/// \brief Create an abbreviation for the SLocEntry that refers to a macro
1567/// expansion.
1568static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001569 using namespace llvm;
1570 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001571 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001572 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1573 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1574 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1575 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
Douglas Gregor83243272009-04-15 18:05:10 +00001576 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
Douglas Gregor8f45df52009-04-16 22:23:12 +00001577 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001578}
1579
Douglas Gregor09b69892011-02-10 17:09:37 +00001580namespace {
1581 // Trait used for the on-disk hash table of header search information.
1582 class HeaderFileInfoTrait {
1583 ASTWriter &Writer;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001584 const HeaderSearch &HS;
Douglas Gregor09b69892011-02-10 17:09:37 +00001585
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001586 // Keep track of the framework names we've used during serialization.
1587 SmallVector<char, 128> FrameworkStringData;
1588 llvm::StringMap<unsigned> FrameworkNameOffset;
1589
Douglas Gregor09b69892011-02-10 17:09:37 +00001590 public:
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001591 HeaderFileInfoTrait(ASTWriter &Writer, const HeaderSearch &HS)
1592 : Writer(Writer), HS(HS) { }
Douglas Gregor09b69892011-02-10 17:09:37 +00001593
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001594 struct key_type {
1595 const FileEntry *FE;
1596 const char *Filename;
1597 };
1598 typedef const key_type &key_type_ref;
Douglas Gregor09b69892011-02-10 17:09:37 +00001599
1600 typedef HeaderFileInfo data_type;
1601 typedef const data_type &data_type_ref;
Justin Bogner25463f12014-04-18 20:27:24 +00001602 typedef unsigned hash_value_type;
1603 typedef unsigned offset_type;
Douglas Gregor09b69892011-02-10 17:09:37 +00001604
Justin Bogner25463f12014-04-18 20:27:24 +00001605 static hash_value_type ComputeHash(key_type_ref key) {
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001606 // The hash is based only on size/time of the file, so that the reader can
1607 // match even when symlinking or excess path elements ("foo/../", "../")
1608 // change the form of the name. However, complete path is still the key.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001609 //
1610 // FIXME: Using the mtime here will cause problems for explicit module
1611 // imports.
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001612 return llvm::hash_combine(key.FE->getSize(),
1613 key.FE->getModificationTime());
Douglas Gregor09b69892011-02-10 17:09:37 +00001614 }
1615
1616 std::pair<unsigned,unsigned>
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001617 EmitKeyDataLength(raw_ostream& Out, key_type_ref key, data_type_ref Data) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001618 using namespace llvm::support;
1619 endian::Writer<little> Writer(Out);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001620 unsigned KeyLen = strlen(key.Filename) + 1 + 8 + 8;
Justin Bognere1c147c2014-03-28 22:03:19 +00001621 Writer.write<uint16_t>(KeyLen);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001622 unsigned DataLen = 1 + 2 + 4 + 4;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001623 if (Data.isModuleHeader)
1624 DataLen += 4;
Justin Bognere1c147c2014-03-28 22:03:19 +00001625 Writer.write<uint8_t>(DataLen);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001626 return std::make_pair(KeyLen, DataLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001627 }
1628
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001629 void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001630 using namespace llvm::support;
1631 endian::Writer<little> LE(Out);
1632 LE.write<uint64_t>(key.FE->getSize());
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001633 KeyLen -= 8;
Justin Bognere1c147c2014-03-28 22:03:19 +00001634 LE.write<uint64_t>(key.FE->getModificationTime());
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001635 KeyLen -= 8;
1636 Out.write(key.Filename, KeyLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001637 }
1638
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001639 void EmitData(raw_ostream &Out, key_type_ref key,
Douglas Gregor09b69892011-02-10 17:09:37 +00001640 data_type_ref Data, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001641 using namespace llvm::support;
1642 endian::Writer<little> LE(Out);
Douglas Gregor09b69892011-02-10 17:09:37 +00001643 uint64_t Start = Out.tell(); (void)Start;
1644
Lawrence Crowlb53e5482013-06-20 21:14:14 +00001645 unsigned char Flags = (Data.HeaderRole << 6)
1646 | (Data.isImport << 5)
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001647 | (Data.isPragmaOnce << 4)
1648 | (Data.DirInfo << 2)
1649 | (Data.Resolved << 1)
1650 | Data.IndexHeaderMapHeader;
Justin Bognere1c147c2014-03-28 22:03:19 +00001651 LE.write<uint8_t>(Flags);
1652 LE.write<uint16_t>(Data.NumIncludes);
Douglas Gregor09b69892011-02-10 17:09:37 +00001653
1654 if (!Data.ControllingMacro)
Justin Bognere1c147c2014-03-28 22:03:19 +00001655 LE.write<uint32_t>(Data.ControllingMacroID);
Douglas Gregor09b69892011-02-10 17:09:37 +00001656 else
Justin Bognere1c147c2014-03-28 22:03:19 +00001657 LE.write<uint32_t>(Writer.getIdentifierRef(Data.ControllingMacro));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001658
1659 unsigned Offset = 0;
1660 if (!Data.Framework.empty()) {
1661 // If this header refers into a framework, save the framework name.
1662 llvm::StringMap<unsigned>::iterator Pos
1663 = FrameworkNameOffset.find(Data.Framework);
1664 if (Pos == FrameworkNameOffset.end()) {
1665 Offset = FrameworkStringData.size() + 1;
1666 FrameworkStringData.append(Data.Framework.begin(),
1667 Data.Framework.end());
1668 FrameworkStringData.push_back(0);
1669
1670 FrameworkNameOffset[Data.Framework] = Offset;
1671 } else
1672 Offset = Pos->second;
1673 }
Justin Bognere1c147c2014-03-28 22:03:19 +00001674 LE.write<uint32_t>(Offset);
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001675
1676 if (Data.isModuleHeader) {
Lawrence Crowlb53e5482013-06-20 21:14:14 +00001677 Module *Mod = HS.findModuleForHeader(key.FE).getModule();
Justin Bognere1c147c2014-03-28 22:03:19 +00001678 LE.write<uint32_t>(Writer.getExistingSubmoduleID(Mod));
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001679 }
1680
Douglas Gregor09b69892011-02-10 17:09:37 +00001681 assert(Out.tell() - Start == DataLen && "Wrong data length");
1682 }
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001683
1684 const char *strings_begin() const { return FrameworkStringData.begin(); }
1685 const char *strings_end() const { return FrameworkStringData.end(); }
Douglas Gregor09b69892011-02-10 17:09:37 +00001686 };
1687} // end anonymous namespace
1688
1689/// \brief Write the header search block for the list of files that
1690///
1691/// \param HS The header search structure to save.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001692void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001693 SmallVector<const FileEntry *, 16> FilesByUID;
Douglas Gregor09b69892011-02-10 17:09:37 +00001694 HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
1695
1696 if (FilesByUID.size() > HS.header_file_size())
1697 FilesByUID.resize(HS.header_file_size());
1698
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001699 HeaderFileInfoTrait GeneratorTrait(*this, HS);
Justin Bognerbb094f02014-04-18 19:57:06 +00001700 llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001701 SmallVector<const char *, 4> SavedStrings;
Douglas Gregor09b69892011-02-10 17:09:37 +00001702 unsigned NumHeaderSearchEntries = 0;
1703 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
1704 const FileEntry *File = FilesByUID[UID];
1705 if (!File)
1706 continue;
1707
Argyrios Kyrtzidisf5ab0342011-11-13 22:08:39 +00001708 // Use HeaderSearch's getFileInfo to make sure we get the HeaderFileInfo
1709 // from the external source if it was not provided already.
Ben Langmuird285c502014-03-13 16:46:36 +00001710 HeaderFileInfo HFI;
1711 if (!HS.tryGetFileInfo(File, HFI) ||
1712 (HFI.External && Chain) ||
1713 (HFI.isModuleHeader && !HFI.isCompilingModuleHeader))
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +00001714 continue;
Douglas Gregor09b69892011-02-10 17:09:37 +00001715
Richard Smith7ed1bc92014-12-05 22:42:13 +00001716 // Massage the file path into an appropriate form.
Douglas Gregor09b69892011-02-10 17:09:37 +00001717 const char *Filename = File->getName();
Richard Smith7ed1bc92014-12-05 22:42:13 +00001718 SmallString<128> FilenameTmp(Filename);
1719 if (PreparePathForOutput(FilenameTmp)) {
1720 // If we performed any translation on the file name at all, we need to
1721 // save this string, since the generator will refer to it later.
1722 Filename = strdup(FilenameTmp.c_str());
Douglas Gregor09b69892011-02-10 17:09:37 +00001723 SavedStrings.push_back(Filename);
1724 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001725
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001726 HeaderFileInfoTrait::key_type key = { File, Filename };
1727 Generator.insert(key, HFI, GeneratorTrait);
Douglas Gregor09b69892011-02-10 17:09:37 +00001728 ++NumHeaderSearchEntries;
1729 }
1730
1731 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001732 SmallString<4096> TableData;
Douglas Gregor09b69892011-02-10 17:09:37 +00001733 uint32_t BucketOffset;
1734 {
Justin Bognere1c147c2014-03-28 22:03:19 +00001735 using namespace llvm::support;
Douglas Gregor09b69892011-02-10 17:09:37 +00001736 llvm::raw_svector_ostream Out(TableData);
1737 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00001738 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregor09b69892011-02-10 17:09:37 +00001739 BucketOffset = Generator.Emit(Out, GeneratorTrait);
1740 }
1741
1742 // Create a blob abbreviation
1743 using namespace llvm;
1744 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1745 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
1746 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1747 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001748 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor09b69892011-02-10 17:09:37 +00001749 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1750 unsigned TableAbbrev = Stream.EmitAbbrev(Abbrev);
1751
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001752 // Write the header search table
Douglas Gregor09b69892011-02-10 17:09:37 +00001753 RecordData Record;
1754 Record.push_back(HEADER_SEARCH_TABLE);
1755 Record.push_back(BucketOffset);
1756 Record.push_back(NumHeaderSearchEntries);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001757 Record.push_back(TableData.size());
1758 TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end());
Douglas Gregor09b69892011-02-10 17:09:37 +00001759 Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData.str());
1760
1761 // Free all of the strings we had to duplicate.
1762 for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
David Greenebae0e352013-01-15 22:09:43 +00001763 free(const_cast<char *>(SavedStrings[I]));
Douglas Gregor09b69892011-02-10 17:09:37 +00001764}
1765
Douglas Gregora7f71a92009-04-10 03:52:48 +00001766/// \brief Writes the block containing the serialized form of the
1767/// source manager.
1768///
1769/// TODO: We should probably use an on-disk hash table (stored in a
1770/// blob), indexed based on the file name, so that we only create
1771/// entries for files that we actually need. In the common case (no
1772/// errors), we probably won't have to create file entries for any of
1773/// the files in the AST.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00001774void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
Richard Smith7ed1bc92014-12-05 22:42:13 +00001775 const Preprocessor &PP) {
Douglas Gregor258ae542009-04-27 06:38:32 +00001776 RecordData Record;
1777
Chris Lattner0910e3b2009-04-10 17:16:57 +00001778 // Enter the source manager block.
Sebastian Redl539c5062010-08-18 23:57:32 +00001779 Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 3);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001780
1781 // Abbreviations for the various kinds of source-location entries.
Chris Lattnerc4976c732009-04-27 19:03:22 +00001782 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
1783 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
1784 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001785 unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001786
Douglas Gregor258ae542009-04-27 06:38:32 +00001787 // Write out the source location entry table. We skip the first
1788 // entry, which is always the same dummy entry.
Chris Lattner12d61d32009-04-27 19:01:47 +00001789 std::vector<uint32_t> SLocEntryOffsets;
Douglas Gregor258ae542009-04-27 06:38:32 +00001790 RecordData PreloadSLocs;
Douglas Gregor925296b2011-07-19 16:10:42 +00001791 SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1);
1792 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
Sebastian Redl5c415f32010-07-22 17:01:13 +00001793 I != N; ++I) {
Douglas Gregor8655e882009-10-16 22:46:09 +00001794 // Get this source location entry.
Douglas Gregor925296b2011-07-19 16:10:42 +00001795 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00001796 FileID FID = FileID::get(I);
1797 assert(&SourceMgr.getSLocEntry(FID) == SLoc);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001798
Douglas Gregor258ae542009-04-27 06:38:32 +00001799 // Record the offset of this source-location entry.
1800 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
1801
1802 // Figure out which record code to use.
1803 unsigned Code;
1804 if (SLoc->isFile()) {
Douglas Gregor9dc32122011-11-16 20:05:18 +00001805 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
1806 if (Cache->OrigEntry) {
Sebastian Redl539c5062010-08-18 23:57:32 +00001807 Code = SM_SLOC_FILE_ENTRY;
Argyrios Kyrtzidis92dd4662011-06-02 20:01:46 +00001808 } else
Sebastian Redl539c5062010-08-18 23:57:32 +00001809 Code = SM_SLOC_BUFFER_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00001810 } else
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001811 Code = SM_SLOC_EXPANSION_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00001812 Record.clear();
1813 Record.push_back(Code);
1814
Douglas Gregor925296b2011-07-19 16:10:42 +00001815 // Starting offset of this entry within this module, so skip the dummy.
1816 Record.push_back(SLoc->getOffset() - 2);
Douglas Gregor258ae542009-04-27 06:38:32 +00001817 if (SLoc->isFile()) {
1818 const SrcMgr::FileInfo &File = SLoc->getFile();
1819 Record.push_back(File.getIncludeLoc().getRawEncoding());
1820 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
1821 Record.push_back(File.hasLineDirectives());
1822
1823 const SrcMgr::ContentCache *Content = File.getContentCache();
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00001824 if (Content->OrigEntry) {
1825 assert(Content->OrigEntry == Content->ContentsEntry &&
Douglas Gregor9dc32122011-11-16 20:05:18 +00001826 "Writing to AST an overridden file is not supported");
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00001827
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001828 // The source location entry is a file. Emit input file ID.
1829 assert(InputFileIDs[Content->OrigEntry] != 0 && "Missed file entry");
1830 Record.push_back(InputFileIDs[Content->OrigEntry]);
Mike Stump11289f42009-09-09 15:08:12 +00001831
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001832 Record.push_back(File.NumCreatedFIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001833
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00001834 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001835 if (FDI != FileDeclIDs.end()) {
1836 Record.push_back(FDI->second->FirstDeclIndex);
1837 Record.push_back(FDI->second->DeclIDs.size());
1838 } else {
1839 Record.push_back(0);
1840 Record.push_back(0);
1841 }
Douglas Gregor9dc32122011-11-16 20:05:18 +00001842
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001843 Stream.EmitRecordWithAbbrev(SLocFileAbbrv, Record);
Douglas Gregor9dc32122011-11-16 20:05:18 +00001844
1845 if (Content->BufferOverridden) {
1846 Record.clear();
1847 Record.push_back(SM_SLOC_BUFFER_BLOB);
1848 const llvm::MemoryBuffer *Buffer
1849 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
1850 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record,
1851 StringRef(Buffer->getBufferStart(),
1852 Buffer->getBufferSize() + 1));
1853 }
Douglas Gregor258ae542009-04-27 06:38:32 +00001854 } else {
1855 // The source location entry is a buffer. The blob associated
1856 // with this entry contains the contents of the buffer.
1857
1858 // We add one to the size so that we capture the trailing NULL
1859 // that is required by llvm::MemoryBuffer::getMemBuffer (on
1860 // the reader side).
Douglas Gregor874cc622010-03-16 00:35:39 +00001861 const llvm::MemoryBuffer *Buffer
Chris Lattnerfb24a3a2010-04-20 20:35:58 +00001862 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
Douglas Gregor258ae542009-04-27 06:38:32 +00001863 const char *Name = Buffer->getBufferIdentifier();
Daniel Dunbar8100d012009-08-24 09:31:37 +00001864 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001865 StringRef(Name, strlen(Name) + 1));
Douglas Gregor258ae542009-04-27 06:38:32 +00001866 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00001867 Record.push_back(SM_SLOC_BUFFER_BLOB);
Douglas Gregor258ae542009-04-27 06:38:32 +00001868 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001869 StringRef(Buffer->getBufferStart(),
Daniel Dunbar8100d012009-08-24 09:31:37 +00001870 Buffer->getBufferSize() + 1));
Douglas Gregor258ae542009-04-27 06:38:32 +00001871
Douglas Gregor925296b2011-07-19 16:10:42 +00001872 if (strcmp(Name, "<built-in>") == 0) {
1873 PreloadSLocs.push_back(SLocEntryOffsets.size());
1874 }
Douglas Gregor258ae542009-04-27 06:38:32 +00001875 }
1876 } else {
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001877 // The source location entry is a macro expansion.
Chandler Carruthee4c1d12011-07-26 04:56:51 +00001878 const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
Chandler Carruth73ee5d72011-07-26 04:41:47 +00001879 Record.push_back(Expansion.getSpellingLoc().getRawEncoding());
1880 Record.push_back(Expansion.getExpansionLocStart().getRawEncoding());
Argyrios Kyrtzidisa1d943a2011-08-17 00:31:14 +00001881 Record.push_back(Expansion.isMacroArgExpansion() ? 0
1882 : Expansion.getExpansionLocEnd().getRawEncoding());
Douglas Gregor258ae542009-04-27 06:38:32 +00001883
1884 // Compute the token length for this macro expansion.
Douglas Gregor925296b2011-07-19 16:10:42 +00001885 unsigned NextOffset = SourceMgr.getNextLocalOffset();
Douglas Gregor8655e882009-10-16 22:46:09 +00001886 if (I + 1 != N)
Douglas Gregor925296b2011-07-19 16:10:42 +00001887 NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset();
Douglas Gregor258ae542009-04-27 06:38:32 +00001888 Record.push_back(NextOffset - SLoc->getOffset() - 1);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001889 Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00001890 }
1891 }
1892
Douglas Gregor8f45df52009-04-16 22:23:12 +00001893 Stream.ExitBlock();
Douglas Gregor258ae542009-04-27 06:38:32 +00001894
1895 if (SLocEntryOffsets.empty())
1896 return;
1897
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00001898 // Write the source-location offsets table into the AST block. This
Douglas Gregor258ae542009-04-27 06:38:32 +00001899 // table is used for lazily loading source-location information.
1900 using namespace llvm;
1901 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001902 Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
Douglas Gregor258ae542009-04-27 06:38:32 +00001903 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
Douglas Gregor925296b2011-07-19 16:10:42 +00001904 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
Douglas Gregor258ae542009-04-27 06:38:32 +00001905 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
1906 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(Abbrev);
Mike Stump11289f42009-09-09 15:08:12 +00001907
Douglas Gregor258ae542009-04-27 06:38:32 +00001908 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00001909 Record.push_back(SOURCE_LOCATION_OFFSETS);
Douglas Gregor258ae542009-04-27 06:38:32 +00001910 Record.push_back(SLocEntryOffsets.size());
Douglas Gregor925296b2011-07-19 16:10:42 +00001911 Record.push_back(SourceMgr.getNextLocalOffset() - 1); // skip dummy
Benjamin Kramerd47a12a2011-04-24 17:44:50 +00001912 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record, data(SLocEntryOffsets));
Douglas Gregor258ae542009-04-27 06:38:32 +00001913
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00001914 // Write the source location entry preloads array, telling the AST
Douglas Gregor258ae542009-04-27 06:38:32 +00001915 // reader which source locations entries it should load eagerly.
Sebastian Redl539c5062010-08-18 23:57:32 +00001916 Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
Douglas Gregor925296b2011-07-19 16:10:42 +00001917
1918 // Write the line table. It depends on remapping working, so it must come
1919 // after the source location offsets.
1920 if (SourceMgr.hasLineTable()) {
1921 LineTableInfo &LineTable = SourceMgr.getLineTable();
1922
1923 Record.clear();
Richard Smith7ed1bc92014-12-05 22:42:13 +00001924 // Emit the file names.
Douglas Gregor925296b2011-07-19 16:10:42 +00001925 Record.push_back(LineTable.getNumFilenames());
Richard Smith7ed1bc92014-12-05 22:42:13 +00001926 for (unsigned I = 0, N = LineTable.getNumFilenames(); I != N; ++I)
1927 AddPath(LineTable.getFilename(I), Record);
Douglas Gregor925296b2011-07-19 16:10:42 +00001928
1929 // Emit the line entries
1930 for (LineTableInfo::iterator L = LineTable.begin(), LEnd = LineTable.end();
1931 L != LEnd; ++L) {
1932 // Only emit entries for local files.
Douglas Gregor02c2dbf2012-06-08 16:40:28 +00001933 if (L->first.ID < 0)
Douglas Gregor925296b2011-07-19 16:10:42 +00001934 continue;
1935
1936 // Emit the file ID
Douglas Gregor02c2dbf2012-06-08 16:40:28 +00001937 Record.push_back(L->first.ID);
Douglas Gregor925296b2011-07-19 16:10:42 +00001938
1939 // Emit the line entries
1940 Record.push_back(L->second.size());
1941 for (std::vector<LineEntry>::iterator LE = L->second.begin(),
1942 LEEnd = L->second.end();
1943 LE != LEEnd; ++LE) {
1944 Record.push_back(LE->FileOffset);
1945 Record.push_back(LE->LineNo);
1946 Record.push_back(LE->FilenameID);
1947 Record.push_back((unsigned)LE->FileKind);
1948 Record.push_back(LE->IncludeOffset);
1949 }
1950 }
1951 Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record);
1952 }
Douglas Gregora7f71a92009-04-10 03:52:48 +00001953}
1954
Douglas Gregorc5046832009-04-27 18:38:38 +00001955//===----------------------------------------------------------------------===//
1956// Preprocessor Serialization
1957//===----------------------------------------------------------------------===//
1958
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001959namespace {
1960class ASTMacroTableTrait {
1961public:
1962 typedef IdentID key_type;
1963 typedef key_type key_type_ref;
1964
1965 struct Data {
1966 uint32_t MacroDirectivesOffset;
1967 };
1968
1969 typedef Data data_type;
1970 typedef const data_type &data_type_ref;
Justin Bogner25463f12014-04-18 20:27:24 +00001971 typedef unsigned hash_value_type;
1972 typedef unsigned offset_type;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001973
Justin Bogner25463f12014-04-18 20:27:24 +00001974 static hash_value_type ComputeHash(IdentID IdID) {
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001975 return llvm::hash_value(IdID);
1976 }
1977
1978 std::pair<unsigned,unsigned>
1979 static EmitKeyDataLength(raw_ostream& Out,
1980 key_type_ref Key, data_type_ref Data) {
1981 unsigned KeyLen = 4; // IdentID.
1982 unsigned DataLen = 4; // MacroDirectivesOffset.
1983 return std::make_pair(KeyLen, DataLen);
1984 }
1985
1986 static void EmitKey(raw_ostream& Out, key_type_ref Key, unsigned KeyLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001987 using namespace llvm::support;
1988 endian::Writer<little>(Out).write<uint32_t>(Key);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001989 }
1990
1991 static void EmitData(raw_ostream& Out, key_type_ref Key, data_type_ref Data,
1992 unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001993 using namespace llvm::support;
1994 endian::Writer<little>(Out).write<uint32_t>(Data.MacroDirectivesOffset);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00001995 }
1996};
1997} // end anonymous namespace
1998
Benjamin Kramer04bf1872013-09-22 14:10:29 +00001999static int compareMacroDirectives(
2000 const std::pair<const IdentifierInfo *, MacroDirective *> *X,
2001 const std::pair<const IdentifierInfo *, MacroDirective *> *Y) {
2002 return X->first->getName().compare(Y->first->getName());
Douglas Gregor2e5571d2011-02-10 18:20:09 +00002003}
2004
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002005static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule,
2006 const Preprocessor &PP) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002007 if (MacroInfo *MI = MD->getMacroInfo())
2008 if (MI->isBuiltinMacro())
2009 return true;
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002010
2011 if (IsModule) {
Richard Smithe657bbd2014-07-18 22:13:40 +00002012 // Re-export any imported directives.
Richard Smithdaa69e02014-07-25 04:40:03 +00002013 if (MD->isImported())
2014 return false;
Richard Smithe657bbd2014-07-18 22:13:40 +00002015
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002016 SourceLocation Loc = MD->getLocation();
2017 if (Loc.isInvalid())
2018 return true;
2019 if (PP.getSourceManager().getFileID(Loc) == PP.getPredefinesFileID())
2020 return true;
2021 }
2022
2023 return false;
2024}
2025
Chris Lattnereeffaef2009-04-10 17:15:23 +00002026/// \brief Writes the block containing the serialized form of the
2027/// preprocessor.
2028///
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00002029void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002030 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
2031 if (PPRec)
2032 WritePreprocessorDetail(*PPRec);
2033
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002034 RecordData Record;
Chris Lattner0910e3b2009-04-10 17:16:57 +00002035
Chris Lattner0af3ba12009-04-13 01:29:17 +00002036 // If the preprocessor __COUNTER__ value has been bumped, remember it.
2037 if (PP.getCounterValue() != 0) {
2038 Record.push_back(PP.getCounterValue());
Sebastian Redl539c5062010-08-18 23:57:32 +00002039 Stream.EmitRecord(PP_COUNTER_VALUE, Record);
Chris Lattner0af3ba12009-04-13 01:29:17 +00002040 Record.clear();
Douglas Gregoreda6a892009-04-26 00:07:37 +00002041 }
2042
2043 // Enter the preprocessor block.
Douglas Gregor796d76a2010-10-20 22:00:55 +00002044 Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +00002045
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002046 // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
Douglas Gregoreda6a892009-04-26 00:07:37 +00002047 // FIXME: use diagnostics subsystem for localization etc.
2048 if (PP.SawDateOrTime())
2049 fprintf(stderr, "warning: precompiled header used __DATE__ or __TIME__.\n");
Mike Stump11289f42009-09-09 15:08:12 +00002050
Douglas Gregor796d76a2010-10-20 22:00:55 +00002051
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002052 // Loop over all the macro directives that are live at the end of the file,
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002053 // emitting each to the PP section.
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002054
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002055 // Construct the list of macro directives that need to be serialized.
Argyrios Kyrtzidis09c9e812013-02-20 00:54:57 +00002056 SmallVector<std::pair<const IdentifierInfo *, MacroDirective *>, 2>
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002057 MacroDirectives;
2058 for (Preprocessor::macro_iterator
2059 I = PP.macro_begin(/*IncludeExternalMacros=*/false),
2060 E = PP.macro_end(/*IncludeExternalMacros=*/false);
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002061 I != E; ++I) {
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002062 MacroDirectives.push_back(std::make_pair(I->first, I->second));
Douglas Gregor2e5571d2011-02-10 18:20:09 +00002063 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00002064
Douglas Gregor2e5571d2011-02-10 18:20:09 +00002065 // Sort the set of macro definitions that need to be serialized by the
2066 // name of the macro, to provide a stable ordering.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002067 llvm::array_pod_sort(MacroDirectives.begin(), MacroDirectives.end(),
2068 &compareMacroDirectives);
2069
Justin Bognerbb094f02014-04-18 19:57:06 +00002070 llvm::OnDiskChainedHashTableGenerator<ASTMacroTableTrait> Generator;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002071
2072 // Emit the macro directives as a list and associate the offset with the
2073 // identifier they belong to.
2074 for (unsigned I = 0, N = MacroDirectives.size(); I != N; ++I) {
2075 const IdentifierInfo *Name = MacroDirectives[I].first;
2076 uint64_t MacroDirectiveOffset = Stream.GetCurrentBitNo();
2077 MacroDirective *MD = MacroDirectives[I].second;
2078
2079 // If the macro or identifier need no updates, don't write the macro history
2080 // for this one.
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002081 // FIXME: Chain the macro history instead of re-writing it.
2082 if (MD->isFromPCH() &&
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002083 Name->isFromAST() && !Name->hasChangedSinceDeserialization())
2084 continue;
2085
2086 // Emit the macro directives in reverse source order.
2087 for (; MD; MD = MD->getPrevious()) {
2088 if (shouldIgnoreMacro(MD, IsModule, PP))
2089 continue;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002090
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002091 AddSourceLocation(MD->getLocation(), Record);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002092 Record.push_back(MD->getKind());
Richard Smithdaa69e02014-07-25 04:40:03 +00002093 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002094 MacroID InfoID = getMacroRef(DefMD->getInfo(), Name);
2095 Record.push_back(InfoID);
Richard Smithdaa69e02014-07-25 04:40:03 +00002096 Record.push_back(DefMD->getOwningModuleID());
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002097 Record.push_back(DefMD->isAmbiguous());
Richard Smithdaa69e02014-07-25 04:40:03 +00002098 } else if (auto *UndefMD = dyn_cast<UndefMacroDirective>(MD)) {
2099 Record.push_back(UndefMD->getOwningModuleID());
2100 } else {
2101 auto *VisMD = cast<VisibilityMacroDirective>(MD);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002102 Record.push_back(VisMD->isPublic());
2103 }
Richard Smithdaa69e02014-07-25 04:40:03 +00002104
2105 if (MD->isImported()) {
2106 auto Overrides = MD->getOverriddenModules();
2107 Record.push_back(Overrides.size());
2108 for (auto Override : Overrides)
2109 Record.push_back(Override);
2110 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002111 }
2112 if (Record.empty())
2113 continue;
2114
2115 Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, Record);
2116 Record.clear();
2117
2118 IdentMacroDirectivesOffsetMap[Name] = MacroDirectiveOffset;
2119
2120 IdentID NameID = getIdentifierRef(Name);
2121 ASTMacroTableTrait::Data data;
2122 data.MacroDirectivesOffset = MacroDirectiveOffset;
2123 Generator.insert(NameID, data);
2124 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00002125
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002126 /// \brief Offsets of each of the macros into the bitstream, indexed by
2127 /// the local macro ID
2128 ///
2129 /// For each identifier that is associated with a macro, this map
2130 /// provides the offset into the bitstream where that macro is
2131 /// defined.
2132 std::vector<uint32_t> MacroOffsets;
2133
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002134 for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) {
2135 const IdentifierInfo *Name = MacroInfosToEmit[I].Name;
2136 MacroInfo *MI = MacroInfosToEmit[I].MI;
2137 MacroID ID = MacroInfosToEmit[I].ID;
Douglas Gregoreb114da2010-10-01 01:03:07 +00002138
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002139 if (ID < FirstMacroID) {
2140 assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?");
2141 continue;
Chris Lattner2199f5b2009-04-10 18:08:30 +00002142 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002143
2144 // Record the local offset of this macro.
2145 unsigned Index = ID - FirstMacroID;
2146 if (Index == MacroOffsets.size())
2147 MacroOffsets.push_back(Stream.GetCurrentBitNo());
2148 else {
2149 if (Index > MacroOffsets.size())
2150 MacroOffsets.resize(Index + 1);
2151
2152 MacroOffsets[Index] = Stream.GetCurrentBitNo();
2153 }
2154
2155 AddIdentifierRef(Name, Record);
2156 Record.push_back(inferSubmoduleIDFromLocation(MI->getDefinitionLoc()));
2157 AddSourceLocation(MI->getDefinitionLoc(), Record);
2158 AddSourceLocation(MI->getDefinitionEndLoc(), Record);
2159 Record.push_back(MI->isUsed());
Argyrios Kyrtzidis9ef53ce2014-04-09 18:21:23 +00002160 Record.push_back(MI->isUsedForHeaderGuard());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002161 unsigned Code;
2162 if (MI->isObjectLike()) {
2163 Code = PP_MACRO_OBJECT_LIKE;
2164 } else {
2165 Code = PP_MACRO_FUNCTION_LIKE;
2166
2167 Record.push_back(MI->isC99Varargs());
2168 Record.push_back(MI->isGNUVarargs());
2169 Record.push_back(MI->hasCommaPasting());
2170 Record.push_back(MI->getNumArgs());
2171 for (MacroInfo::arg_iterator I = MI->arg_begin(), E = MI->arg_end();
2172 I != E; ++I)
2173 AddIdentifierRef(*I, Record);
2174 }
2175
2176 // If we have a detailed preprocessing record, record the macro definition
2177 // ID that corresponds to this macro.
2178 if (PPRec)
2179 Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2180
2181 Stream.EmitRecord(Code, Record);
2182 Record.clear();
2183
2184 // Emit the tokens array.
2185 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
2186 // Note that we know that the preprocessor does not have any annotation
2187 // tokens in it because they are created by the parser, and thus can't
2188 // be in a macro definition.
2189 const Token &Tok = MI->getReplacementToken(TokNo);
John McCallf413f5e2013-05-03 00:10:13 +00002190 AddToken(Tok, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002191 Stream.EmitRecord(PP_TOKEN, Record);
2192 Record.clear();
2193 }
2194 ++NumMacros;
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002195 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002196
Douglas Gregor92a96f52011-02-08 21:58:10 +00002197 Stream.ExitBlock();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002198
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002199 // Create the on-disk hash table in a buffer.
2200 SmallString<4096> MacroTable;
2201 uint32_t BucketOffset;
2202 {
Justin Bognere1c147c2014-03-28 22:03:19 +00002203 using namespace llvm::support;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002204 llvm::raw_svector_ostream Out(MacroTable);
2205 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00002206 endian::Writer<little>(Out).write<uint32_t>(0);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002207 BucketOffset = Generator.Emit(Out);
2208 }
2209
2210 // Write the macro table
2211 using namespace llvm;
2212 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2213 Abbrev->Add(BitCodeAbbrevOp(MACRO_TABLE));
2214 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2215 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2216 unsigned MacroTableAbbrev = Stream.EmitAbbrev(Abbrev);
2217
2218 Record.push_back(MACRO_TABLE);
2219 Record.push_back(BucketOffset);
2220 Stream.EmitRecordWithBlob(MacroTableAbbrev, Record, MacroTable.str());
2221 Record.clear();
2222
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002223 // Write the offsets table for macro IDs.
2224 using namespace llvm;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002225 Abbrev = new BitCodeAbbrev();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002226 Abbrev->Add(BitCodeAbbrevOp(MACRO_OFFSET));
2227 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2228 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2229 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2230
2231 unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2232 Record.clear();
2233 Record.push_back(MACRO_OFFSET);
2234 Record.push_back(MacroOffsets.size());
2235 Record.push_back(FirstMacroID - NUM_PREDEF_MACRO_IDS);
2236 Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record,
2237 data(MacroOffsets));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002238}
2239
2240void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) {
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002241 if (PPRec.local_begin() == PPRec.local_end())
Douglas Gregor92a96f52011-02-08 21:58:10 +00002242 return;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002243
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +00002244 SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002245
Douglas Gregor92a96f52011-02-08 21:58:10 +00002246 // Enter the preprocessor block.
2247 Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002248
Douglas Gregoraae92242010-03-19 21:51:54 +00002249 // If the preprocessor has a preprocessing record, emit it.
2250 unsigned NumPreprocessingRecords = 0;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002251 using namespace llvm;
2252
2253 // Set up the abbreviation for
2254 unsigned InclusionAbbrev = 0;
2255 {
2256 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2257 Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002258 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2259 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2260 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002261 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
Douglas Gregor92a96f52011-02-08 21:58:10 +00002262 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2263 InclusionAbbrev = Stream.EmitAbbrev(Abbrev);
2264 }
2265
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002266 unsigned FirstPreprocessorEntityID
2267 = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0)
2268 + NUM_PREDEF_PP_ENTITY_IDS;
2269 unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002270 RecordData Record;
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002271 for (PreprocessingRecord::iterator E = PPRec.local_begin(),
2272 EEnd = PPRec.local_end();
Douglas Gregor0d4b4312011-08-04 17:06:18 +00002273 E != EEnd;
2274 (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002275 Record.clear();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002276
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +00002277 PreprocessedEntityOffsets.push_back(PPEntityOffset((*E)->getSourceRange(),
2278 Stream.GetCurrentBitNo()));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002279
Douglas Gregor92a96f52011-02-08 21:58:10 +00002280 if (MacroDefinition *MD = dyn_cast<MacroDefinition>(*E)) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002281 // Record this macro definition's ID.
2282 MacroDefinitions[MD] = NextPreprocessorEntityID;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002283
Douglas Gregor92a96f52011-02-08 21:58:10 +00002284 AddIdentifierRef(MD->getName(), Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002285 Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
2286 continue;
Douglas Gregoraae92242010-03-19 21:51:54 +00002287 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002288
Chandler Carrutha88a22182011-07-14 08:20:46 +00002289 if (MacroExpansion *ME = dyn_cast<MacroExpansion>(*E)) {
Argyrios Kyrtzidis80f78b92011-09-08 17:18:41 +00002290 Record.push_back(ME->isBuiltinMacro());
2291 if (ME->isBuiltinMacro())
2292 AddIdentifierRef(ME->getName(), Record);
2293 else
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002294 Record.push_back(MacroDefinitions[ME->getDefinition()]);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002295 Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002296 continue;
2297 }
2298
2299 if (InclusionDirective *ID = dyn_cast<InclusionDirective>(*E)) {
2300 Record.push_back(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002301 Record.push_back(ID->getFileName().size());
2302 Record.push_back(ID->wasInQuotes());
2303 Record.push_back(static_cast<unsigned>(ID->getKind()));
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002304 Record.push_back(ID->importedModule());
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002305 SmallString<64> Buffer;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002306 Buffer += ID->getFileName();
Argyrios Kyrtzidis8dbcfc32012-03-08 01:08:28 +00002307 // Check that the FileEntry is not null because it was not resolved and
2308 // we create a PCH even with compiler errors.
2309 if (ID->getFile())
2310 Buffer += ID->getFile()->getName();
Douglas Gregor92a96f52011-02-08 21:58:10 +00002311 Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
2312 continue;
2313 }
2314
2315 llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
2316 }
Douglas Gregor8f45df52009-04-16 22:23:12 +00002317 Stream.ExitBlock();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002318
Douglas Gregoraae92242010-03-19 21:51:54 +00002319 // Write the offsets table for the preprocessing record.
2320 if (NumPreprocessingRecords > 0) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002321 assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
2322
Douglas Gregoraae92242010-03-19 21:51:54 +00002323 // Write the offsets table for identifier IDs.
2324 using namespace llvm;
2325 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002326 Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002327 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity
Douglas Gregoraae92242010-03-19 21:51:54 +00002328 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002329 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002330
Douglas Gregoraae92242010-03-19 21:51:54 +00002331 Record.clear();
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002332 Record.push_back(PPD_ENTITIES_OFFSETS);
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002333 Record.push_back(FirstPreprocessorEntityID - NUM_PREDEF_PP_ENTITY_IDS);
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002334 Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
2335 data(PreprocessedEntityOffsets));
Douglas Gregoraae92242010-03-19 21:51:54 +00002336 }
Chris Lattnereeffaef2009-04-10 17:15:23 +00002337}
2338
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002339unsigned ASTWriter::getSubmoduleID(Module *Mod) {
2340 llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod);
2341 if (Known != SubmoduleIDs.end())
2342 return Known->second;
2343
2344 return SubmoduleIDs[Mod] = NextSubmoduleID++;
2345}
2346
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002347unsigned ASTWriter::getExistingSubmoduleID(Module *Mod) const {
2348 if (!Mod)
2349 return 0;
2350
2351 llvm::DenseMap<Module *, unsigned>::const_iterator
2352 Known = SubmoduleIDs.find(Mod);
2353 if (Known != SubmoduleIDs.end())
2354 return Known->second;
2355
2356 return 0;
2357}
2358
Douglas Gregor253eefe2011-12-01 00:59:36 +00002359/// \brief Compute the number of modules within the given tree (including the
2360/// given module).
2361static unsigned getNumberOfModules(Module *Mod) {
2362 unsigned ChildModules = 0;
Douglas Gregoreb90e832012-01-04 23:32:19 +00002363 for (Module::submodule_iterator Sub = Mod->submodule_begin(),
2364 SubEnd = Mod->submodule_end();
Douglas Gregor253eefe2011-12-01 00:59:36 +00002365 Sub != SubEnd; ++Sub)
Douglas Gregoreb90e832012-01-04 23:32:19 +00002366 ChildModules += getNumberOfModules(*Sub);
Douglas Gregor253eefe2011-12-01 00:59:36 +00002367
2368 return ChildModules + 1;
2369}
2370
Douglas Gregorde3ef502011-11-30 23:21:26 +00002371void ASTWriter::WriteSubmodules(Module *WritingModule) {
Douglas Gregor60382512011-12-05 16:35:23 +00002372 // Determine the dependencies of our module and each of it's submodules.
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002373 // FIXME: This feels like it belongs somewhere else, but there are no
2374 // other consumers of this information.
2375 SourceManager &SrcMgr = PP->getSourceManager();
2376 ModuleMap &ModMap = PP->getHeaderSearchInfo().getModuleMap();
Aaron Ballmanbbc31212014-03-14 20:59:21 +00002377 for (const auto *I : Context->local_imports()) {
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002378 if (Module *ImportedFrom
2379 = ModMap.inferModuleFromLocation(FullSourceLoc(I->getLocation(),
2380 SrcMgr))) {
2381 ImportedFrom->Imports.push_back(I->getImportedModule());
2382 }
2383 }
2384
Douglas Gregor69021972011-11-30 17:33:56 +00002385 // Enter the submodule description block.
Richard Smith202210b2014-10-24 20:23:01 +00002386 Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/5);
Douglas Gregor69021972011-11-30 17:33:56 +00002387
2388 // Write the abbreviations needed for the submodules block.
2389 using namespace llvm;
2390 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2391 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002392 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor69021972011-11-30 17:33:56 +00002393 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
2394 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2395 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
Richard Smith9bca2982014-03-08 00:03:56 +00002396 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
2397 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
Douglas Gregora686e1b2012-01-27 19:52:33 +00002398 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
Douglas Gregor73441092011-12-05 22:27:44 +00002399 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
Douglas Gregor73441092011-12-05 22:27:44 +00002400 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002401 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
Douglas Gregor69021972011-11-30 17:33:56 +00002402 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2403 unsigned DefinitionAbbrev = Stream.EmitAbbrev(Abbrev);
2404
2405 Abbrev = new BitCodeAbbrev();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002406 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
Douglas Gregor69021972011-11-30 17:33:56 +00002407 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2408 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(Abbrev);
2409
2410 Abbrev = new BitCodeAbbrev();
2411 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
2412 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2413 unsigned HeaderAbbrev = Stream.EmitAbbrev(Abbrev);
Douglas Gregor524e33e2011-12-08 19:11:24 +00002414
2415 Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002416 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
2417 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2418 unsigned TopHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2419
2420 Abbrev = new BitCodeAbbrev();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002421 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
2422 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2423 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(Abbrev);
2424
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002425 Abbrev = new BitCodeAbbrev();
2426 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES));
Richard Smitha3feee22013-10-28 22:18:19 +00002427 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
2428 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Feature
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002429 unsigned RequiresAbbrev = Stream.EmitAbbrev(Abbrev);
2430
Douglas Gregor59527662012-10-15 06:28:11 +00002431 Abbrev = new BitCodeAbbrev();
2432 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
2433 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2434 unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2435
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002436 Abbrev = new BitCodeAbbrev();
Richard Smith306d8922014-10-22 23:50:56 +00002437 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
2438 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2439 unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2440
2441 Abbrev = new BitCodeAbbrev();
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002442 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
2443 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2444 unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2445
2446 Abbrev = new BitCodeAbbrev();
Richard Smith202210b2014-10-24 20:23:01 +00002447 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
2448 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2449 unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2450
2451 Abbrev = new BitCodeAbbrev();
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002452 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
2453 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2454 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2455 unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(Abbrev);
2456
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002457 Abbrev = new BitCodeAbbrev();
2458 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
2459 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
2460 unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(Abbrev);
2461
Douglas Gregorfb912652013-03-20 21:10:35 +00002462 Abbrev = new BitCodeAbbrev();
2463 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT));
2464 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Other module
2465 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Message
2466 unsigned ConflictAbbrev = Stream.EmitAbbrev(Abbrev);
2467
Douglas Gregor253eefe2011-12-01 00:59:36 +00002468 // Write the submodule metadata block.
2469 RecordData Record;
2470 Record.push_back(getNumberOfModules(WritingModule));
2471 Record.push_back(FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS);
2472 Stream.EmitRecord(SUBMODULE_METADATA, Record);
2473
Douglas Gregor69021972011-11-30 17:33:56 +00002474 // Write all of the submodules.
Douglas Gregorde3ef502011-11-30 23:21:26 +00002475 std::queue<Module *> Q;
Douglas Gregor69021972011-11-30 17:33:56 +00002476 Q.push(WritingModule);
Douglas Gregor69021972011-11-30 17:33:56 +00002477 while (!Q.empty()) {
Douglas Gregorde3ef502011-11-30 23:21:26 +00002478 Module *Mod = Q.front();
Douglas Gregor69021972011-11-30 17:33:56 +00002479 Q.pop();
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002480 unsigned ID = getSubmoduleID(Mod);
Douglas Gregor69021972011-11-30 17:33:56 +00002481
2482 // Emit the definition of the block.
2483 Record.clear();
2484 Record.push_back(SUBMODULE_DEFINITION);
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002485 Record.push_back(ID);
Douglas Gregor69021972011-11-30 17:33:56 +00002486 if (Mod->Parent) {
2487 assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
2488 Record.push_back(SubmoduleIDs[Mod->Parent]);
2489 } else {
2490 Record.push_back(0);
2491 }
2492 Record.push_back(Mod->IsFramework);
2493 Record.push_back(Mod->IsExplicit);
Douglas Gregora686e1b2012-01-27 19:52:33 +00002494 Record.push_back(Mod->IsSystem);
Richard Smith9bca2982014-03-08 00:03:56 +00002495 Record.push_back(Mod->IsExternC);
Douglas Gregor73441092011-12-05 22:27:44 +00002496 Record.push_back(Mod->InferSubmodules);
2497 Record.push_back(Mod->InferExplicitSubmodules);
2498 Record.push_back(Mod->InferExportWildcard);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002499 Record.push_back(Mod->ConfigMacrosExhaustive);
Douglas Gregor69021972011-11-30 17:33:56 +00002500 Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name);
2501
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002502 // Emit the requirements.
Richard Smitha3feee22013-10-28 22:18:19 +00002503 for (unsigned I = 0, N = Mod->Requirements.size(); I != N; ++I) {
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002504 Record.clear();
2505 Record.push_back(SUBMODULE_REQUIRES);
Richard Smitha3feee22013-10-28 22:18:19 +00002506 Record.push_back(Mod->Requirements[I].second);
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002507 Stream.EmitRecordWithBlob(RequiresAbbrev, Record,
Richard Smitha3feee22013-10-28 22:18:19 +00002508 Mod->Requirements[I].first);
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002509 }
2510
Douglas Gregor69021972011-11-30 17:33:56 +00002511 // Emit the umbrella header, if there is one.
Douglas Gregor73141fa2011-12-08 17:39:04 +00002512 if (const FileEntry *UmbrellaHeader = Mod->getUmbrellaHeader()) {
Douglas Gregor69021972011-11-30 17:33:56 +00002513 Record.clear();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002514 Record.push_back(SUBMODULE_UMBRELLA_HEADER);
Douglas Gregor69021972011-11-30 17:33:56 +00002515 Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
Douglas Gregor73141fa2011-12-08 17:39:04 +00002516 UmbrellaHeader->getName());
Douglas Gregor524e33e2011-12-08 19:11:24 +00002517 } else if (const DirectoryEntry *UmbrellaDir = Mod->getUmbrellaDir()) {
2518 Record.clear();
2519 Record.push_back(SUBMODULE_UMBRELLA_DIR);
2520 Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
2521 UmbrellaDir->getName());
Douglas Gregor69021972011-11-30 17:33:56 +00002522 }
Richard Smith306d8922014-10-22 23:50:56 +00002523
Douglas Gregor69021972011-11-30 17:33:56 +00002524 // Emit the headers.
Richard Smith202210b2014-10-24 20:23:01 +00002525 struct {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002526 unsigned RecordKind;
Richard Smith202210b2014-10-24 20:23:01 +00002527 unsigned Abbrev;
Richard Smith3c1a41a2014-12-02 00:08:08 +00002528 Module::HeaderKind HeaderKind;
Richard Smith202210b2014-10-24 20:23:01 +00002529 } HeaderLists[] = {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002530 {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal},
2531 {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual},
2532 {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private},
Richard Smith202210b2014-10-24 20:23:01 +00002533 {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev,
Richard Smith3c1a41a2014-12-02 00:08:08 +00002534 Module::HK_PrivateTextual},
2535 {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded}
Richard Smith202210b2014-10-24 20:23:01 +00002536 };
2537 for (auto &HL : HeaderLists) {
Douglas Gregor69021972011-11-30 17:33:56 +00002538 Record.clear();
Richard Smith3c1a41a2014-12-02 00:08:08 +00002539 Record.push_back(HL.RecordKind);
2540 for (auto &H : Mod->Headers[HL.HeaderKind])
2541 Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten);
2542 }
2543
2544 // Emit the top headers.
2545 {
2546 auto TopHeaders = Mod->getTopHeaders(PP->getFileManager());
2547 Record.clear();
2548 Record.push_back(SUBMODULE_TOPHEADER);
2549 for (auto *H : TopHeaders)
2550 Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, H->getName());
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002551 }
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002552
2553 // Emit the imports.
2554 if (!Mod->Imports.empty()) {
2555 Record.clear();
2556 for (unsigned I = 0, N = Mod->Imports.size(); I != N; ++I) {
Douglas Gregor18b58642011-12-12 23:17:57 +00002557 unsigned ImportedID = getSubmoduleID(Mod->Imports[I]);
Richard Smith7ed1bc92014-12-05 22:42:13 +00002558 assert(ImportedID && "Unknown submodule!");
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002559 Record.push_back(ImportedID);
2560 }
2561 Stream.EmitRecord(SUBMODULE_IMPORTS, Record);
2562 }
2563
Douglas Gregor24bb9232011-12-02 18:58:38 +00002564 // Emit the exports.
2565 if (!Mod->Exports.empty()) {
2566 Record.clear();
2567 for (unsigned I = 0, N = Mod->Exports.size(); I != N; ++I) {
Douglas Gregor18b58642011-12-12 23:17:57 +00002568 if (Module *Exported = Mod->Exports[I].getPointer()) {
2569 unsigned ExportedID = SubmoduleIDs[Exported];
2570 assert(ExportedID > 0 && "Unknown submodule ID?");
2571 Record.push_back(ExportedID);
2572 } else {
2573 Record.push_back(0);
2574 }
2575
Douglas Gregor24bb9232011-12-02 18:58:38 +00002576 Record.push_back(Mod->Exports[I].getInt());
2577 }
2578 Stream.EmitRecord(SUBMODULE_EXPORTS, Record);
2579 }
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002580
Daniel Jasperba7f2f72013-09-24 09:14:14 +00002581 //FIXME: How do we emit the 'use'd modules? They may not be submodules.
2582 // Might be unnecessary as use declarations are only used to build the
2583 // module itself.
2584
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002585 // Emit the link libraries.
2586 for (unsigned I = 0, N = Mod->LinkLibraries.size(); I != N; ++I) {
2587 Record.clear();
2588 Record.push_back(SUBMODULE_LINK_LIBRARY);
2589 Record.push_back(Mod->LinkLibraries[I].IsFramework);
2590 Stream.EmitRecordWithBlob(LinkLibraryAbbrev, Record,
2591 Mod->LinkLibraries[I].Library);
2592 }
2593
Douglas Gregorfb912652013-03-20 21:10:35 +00002594 // Emit the conflicts.
2595 for (unsigned I = 0, N = Mod->Conflicts.size(); I != N; ++I) {
2596 Record.clear();
2597 Record.push_back(SUBMODULE_CONFLICT);
2598 unsigned OtherID = getSubmoduleID(Mod->Conflicts[I].Other);
2599 assert(OtherID && "Unknown submodule!");
2600 Record.push_back(OtherID);
2601 Stream.EmitRecordWithBlob(ConflictAbbrev, Record,
2602 Mod->Conflicts[I].Message);
2603 }
2604
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002605 // Emit the configuration macros.
2606 for (unsigned I = 0, N = Mod->ConfigMacros.size(); I != N; ++I) {
2607 Record.clear();
2608 Record.push_back(SUBMODULE_CONFIG_MACRO);
2609 Stream.EmitRecordWithBlob(ConfigMacroAbbrev, Record,
2610 Mod->ConfigMacros[I]);
2611 }
2612
Douglas Gregor69021972011-11-30 17:33:56 +00002613 // Queue up the submodules of this module.
Douglas Gregoreb90e832012-01-04 23:32:19 +00002614 for (Module::submodule_iterator Sub = Mod->submodule_begin(),
2615 SubEnd = Mod->submodule_end();
Douglas Gregor69021972011-11-30 17:33:56 +00002616 Sub != SubEnd; ++Sub)
Douglas Gregoreb90e832012-01-04 23:32:19 +00002617 Q.push(*Sub);
Douglas Gregor69021972011-11-30 17:33:56 +00002618 }
2619
2620 Stream.ExitBlock();
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002621
2622 assert((NextSubmoduleID - FirstSubmoduleID
2623 == getNumberOfModules(WritingModule)) && "Wrong # of submodules");
Douglas Gregor69021972011-11-30 17:33:56 +00002624}
2625
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002626serialization::SubmoduleID
2627ASTWriter::inferSubmoduleIDFromLocation(SourceLocation Loc) {
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002628 if (Loc.isInvalid() || !WritingModule)
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002629 return 0; // No submodule
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002630
2631 // Find the module that owns this location.
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002632 ModuleMap &ModMap = PP->getHeaderSearchInfo().getModuleMap();
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002633 Module *OwningMod
2634 = ModMap.inferModuleFromLocation(FullSourceLoc(Loc,PP->getSourceManager()));
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002635 if (!OwningMod)
2636 return 0;
2637
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002638 // Check whether this submodule is part of our own module.
2639 if (WritingModule != OwningMod && !OwningMod->isSubModuleOf(WritingModule))
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002640 return 0;
2641
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002642 return getSubmoduleID(OwningMod);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002643}
2644
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00002645void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
2646 bool isModule) {
2647 // Make sure set diagnostic pragmas don't affect the translation unit that
2648 // imports the module.
2649 // FIXME: Make diagnostic pragma sections work properly with modules.
2650 if (isModule)
2651 return;
2652
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002653 llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64>
2654 DiagStateIDMap;
2655 unsigned CurrID = 0;
2656 DiagStateIDMap[&Diag.DiagStates.front()] = ++CurrID; // the command-line one.
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002657 RecordData Record;
David Blaikie9c902b52011-09-25 23:23:43 +00002658 for (DiagnosticsEngine::DiagStatePointsTy::const_iterator
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002659 I = Diag.DiagStatePoints.begin(), E = Diag.DiagStatePoints.end();
2660 I != E; ++I) {
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002661 const DiagnosticsEngine::DiagStatePoint &point = *I;
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002662 if (point.Loc.isInvalid())
2663 continue;
2664
2665 Record.push_back(point.Loc.getRawEncoding());
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002666 unsigned &DiagStateID = DiagStateIDMap[point.State];
2667 Record.push_back(DiagStateID);
2668
2669 if (DiagStateID == 0) {
2670 DiagStateID = ++CurrID;
2671 for (DiagnosticsEngine::DiagState::const_iterator
2672 I = point.State->begin(), E = point.State->end(); I != E; ++I) {
2673 if (I->second.isPragma()) {
2674 Record.push_back(I->first);
Alp Toker46df1c02014-06-12 10:15:20 +00002675 Record.push_back((unsigned)I->second.getSeverity());
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002676 }
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002677 }
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002678 Record.push_back(-1); // mark the end of the diag/map pairs for this
2679 // location.
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002680 }
2681 }
2682
Argyrios Kyrtzidisb0ca9eb2010-11-05 22:20:49 +00002683 if (!Record.empty())
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002684 Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002685}
2686
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002687void ASTWriter::WriteCXXBaseSpecifiersOffsets() {
2688 if (CXXBaseSpecifiersOffsets.empty())
2689 return;
2690
2691 RecordData Record;
2692
2693 // Create a blob abbreviation for the C++ base specifiers offsets.
2694 using namespace llvm;
2695
2696 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2697 Abbrev->Add(BitCodeAbbrevOp(CXX_BASE_SPECIFIER_OFFSETS));
2698 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
2699 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2700 unsigned BaseSpecifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2701
Douglas Gregorc27b2872011-08-04 00:01:48 +00002702 // Write the base specifier offsets table.
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002703 Record.clear();
2704 Record.push_back(CXX_BASE_SPECIFIER_OFFSETS);
2705 Record.push_back(CXXBaseSpecifiersOffsets.size());
2706 Stream.EmitRecordWithBlob(BaseSpecifierOffsetAbbrev, Record,
Benjamin Kramerd47a12a2011-04-24 17:44:50 +00002707 data(CXXBaseSpecifiersOffsets));
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002708}
2709
Douglas Gregorc5046832009-04-27 18:38:38 +00002710//===----------------------------------------------------------------------===//
2711// Type Serialization
2712//===----------------------------------------------------------------------===//
Chris Lattnereeffaef2009-04-10 17:15:23 +00002713
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002714/// \brief Write the representation of a type to the AST stream.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002715void ASTWriter::WriteType(QualType T) {
Argyrios Kyrtzidisa7fbbb02010-08-20 16:04:04 +00002716 TypeIdx &Idx = TypeIdxs[T];
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00002717 if (Idx.getIndex() == 0) // we haven't seen this type before.
2718 Idx = TypeIdx(NextTypeID++);
Mike Stump11289f42009-09-09 15:08:12 +00002719
Douglas Gregor9b3932c2010-10-05 18:37:06 +00002720 assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
Douglas Gregordc72caa2010-10-04 18:21:45 +00002721
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002722 // Record the offset for this type.
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00002723 unsigned Index = Idx.getIndex() - FirstTypeID;
Sebastian Redl66c5eef2010-07-27 00:17:23 +00002724 if (TypeOffsets.size() == Index)
Douglas Gregor8f45df52009-04-16 22:23:12 +00002725 TypeOffsets.push_back(Stream.GetCurrentBitNo());
Sebastian Redl66c5eef2010-07-27 00:17:23 +00002726 else if (TypeOffsets.size() < Index) {
2727 TypeOffsets.resize(Index + 1);
2728 TypeOffsets[Index] = Stream.GetCurrentBitNo();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002729 }
2730
2731 RecordData Record;
Mike Stump11289f42009-09-09 15:08:12 +00002732
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002733 // Emit the type's representation.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002734 ASTTypeWriter W(*this, Record);
Richard Smith01b2cb42014-07-26 06:37:51 +00002735 W.AbbrevToUse = 0;
John McCall8ccfcb52009-09-24 19:53:00 +00002736
Douglas Gregor1b8fe5b72009-11-16 21:35:15 +00002737 if (T.hasLocalNonFastQualifiers()) {
2738 Qualifiers Qs = T.getLocalQualifiers();
2739 AddTypeRef(T.getLocalUnqualifiedType(), Record);
John McCall8ccfcb52009-09-24 19:53:00 +00002740 Record.push_back(Qs.getAsOpaqueValue());
Sebastian Redl539c5062010-08-18 23:57:32 +00002741 W.Code = TYPE_EXT_QUAL;
Richard Smith01b2cb42014-07-26 06:37:51 +00002742 W.AbbrevToUse = TypeExtQualAbbrev;
John McCall8ccfcb52009-09-24 19:53:00 +00002743 } else {
2744 switch (T->getTypeClass()) {
2745 // For all of the concrete, non-dependent types, call the
2746 // appropriate visitor function.
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002747#define TYPE(Class, Base) \
Mike Stump281d6d72010-01-20 02:03:14 +00002748 case Type::Class: W.Visit##Class##Type(cast<Class##Type>(T)); break;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002749#define ABSTRACT_TYPE(Class, Base)
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002750#include "clang/AST/TypeNodes.def"
John McCall8ccfcb52009-09-24 19:53:00 +00002751 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002752 }
2753
2754 // Emit the serialized record.
Richard Smith01b2cb42014-07-26 06:37:51 +00002755 Stream.EmitRecord(W.Code, Record, W.AbbrevToUse);
Douglas Gregorfeb84b02009-04-14 21:18:50 +00002756
2757 // Flush any expressions that were written as part of this type.
Douglas Gregor8f45df52009-04-16 22:23:12 +00002758 FlushStmts();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002759}
2760
Douglas Gregorc5046832009-04-27 18:38:38 +00002761//===----------------------------------------------------------------------===//
2762// Declaration Serialization
2763//===----------------------------------------------------------------------===//
2764
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002765/// \brief Write the block containing all of the declaration IDs
2766/// lexically declared within the given DeclContext.
2767///
2768/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
2769/// bistream, or 0 if no block was written.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002770uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002771 DeclContext *DC) {
Argyrios Kyrtzidiscfbfe782009-06-30 02:36:12 +00002772 if (DC->decls_empty())
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002773 return 0;
2774
Douglas Gregor8f45df52009-04-16 22:23:12 +00002775 uint64_t Offset = Stream.GetCurrentBitNo();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002776 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00002777 Record.push_back(DECL_CONTEXT_LEXICAL);
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002778 SmallVector<KindDeclIDPair, 64> Decls;
Aaron Ballman629afae2014-03-07 19:56:05 +00002779 for (const auto *D : DC->decls())
2780 Decls.push_back(std::make_pair(D->getKind(), GetDeclRef(D)));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002781
Douglas Gregora57c3ab2009-04-22 22:34:57 +00002782 ++NumLexicalDeclContexts;
Benjamin Kramerd47a12a2011-04-24 17:44:50 +00002783 Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record, data(Decls));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002784 return Offset;
2785}
2786
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002787void ASTWriter::WriteTypeDeclOffsets() {
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002788 using namespace llvm;
2789 RecordData Record;
2790
2791 // Write the type offsets array
2792 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00002793 Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002794 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
Douglas Gregor5204bde2011-08-02 16:26:37 +00002795 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002796 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
2797 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2798 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00002799 Record.push_back(TYPE_OFFSET);
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002800 Record.push_back(TypeOffsets.size());
Douglas Gregor5204bde2011-08-02 16:26:37 +00002801 Record.push_back(FirstTypeID - NUM_PREDEF_TYPE_IDS);
Benjamin Kramerd47a12a2011-04-24 17:44:50 +00002802 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, data(TypeOffsets));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002803
2804 // Write the declaration offsets array
2805 Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00002806 Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002807 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
Douglas Gregorf7180622011-08-03 15:48:04 +00002808 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002809 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
2810 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2811 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00002812 Record.push_back(DECL_OFFSET);
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002813 Record.push_back(DeclOffsets.size());
Douglas Gregor6f8912e2011-08-03 16:05:40 +00002814 Record.push_back(FirstDeclID - NUM_PREDEF_DECL_IDS);
Benjamin Kramerd47a12a2011-04-24 17:44:50 +00002815 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, data(DeclOffsets));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002816}
2817
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002818void ASTWriter::WriteFileDeclIDsMap() {
2819 using namespace llvm;
2820 RecordData Record;
2821
2822 // Join the vectors of DeclIDs from all files.
2823 SmallVector<DeclID, 256> FileSortedIDs;
2824 for (FileDeclIDsTy::iterator
2825 FI = FileDeclIDs.begin(), FE = FileDeclIDs.end(); FI != FE; ++FI) {
2826 DeclIDInFileInfo &Info = *FI->second;
2827 Info.FirstDeclIndex = FileSortedIDs.size();
2828 for (LocDeclIDsTy::iterator
2829 DI = Info.DeclIDs.begin(), DE = Info.DeclIDs.end(); DI != DE; ++DI)
2830 FileSortedIDs.push_back(DI->second);
2831 }
2832
2833 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2834 Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
Argyrios Kyrtzidis10e78462012-10-02 21:09:13 +00002835 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002836 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2837 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
2838 Record.push_back(FILE_SORTED_DECLS);
Argyrios Kyrtzidis10e78462012-10-02 21:09:13 +00002839 Record.push_back(FileSortedIDs.size());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002840 Stream.EmitRecordWithBlob(AbbrevCode, Record, data(FileSortedIDs));
2841}
2842
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002843void ASTWriter::WriteComments() {
2844 Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3);
Dmitri Gribenko7dd29d42012-07-06 18:19:34 +00002845 ArrayRef<RawComment *> RawComments = Context->Comments.getComments();
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002846 RecordData Record;
Dmitri Gribenko7dd29d42012-07-06 18:19:34 +00002847 for (ArrayRef<RawComment *>::iterator I = RawComments.begin(),
2848 E = RawComments.end();
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002849 I != E; ++I) {
2850 Record.clear();
Dmitri Gribenko7dd29d42012-07-06 18:19:34 +00002851 AddSourceRange((*I)->getSourceRange(), Record);
2852 Record.push_back((*I)->getKind());
2853 Record.push_back((*I)->isTrailingComment());
2854 Record.push_back((*I)->isAlmostTrailingComment());
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002855 Stream.EmitRecord(COMMENTS_RAW_COMMENT, Record);
2856 }
2857 Stream.ExitBlock();
2858}
2859
Douglas Gregorc5046832009-04-27 18:38:38 +00002860//===----------------------------------------------------------------------===//
2861// Global Method Pool and Selector Serialization
2862//===----------------------------------------------------------------------===//
2863
Douglas Gregore84a9da2009-04-20 20:36:09 +00002864namespace {
Douglas Gregorc78d3462009-04-24 21:10:55 +00002865// Trait used for the on-disk hash table used in the method pool.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002866class ASTMethodPoolTrait {
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002867 ASTWriter &Writer;
Douglas Gregorc78d3462009-04-24 21:10:55 +00002868
2869public:
2870 typedef Selector key_type;
2871 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00002872
Sebastian Redl834bb972010-08-04 17:20:04 +00002873 struct data_type {
Sebastian Redl539c5062010-08-18 23:57:32 +00002874 SelectorID ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00002875 ObjCMethodList Instance, Factory;
2876 };
Douglas Gregorc78d3462009-04-24 21:10:55 +00002877 typedef const data_type& data_type_ref;
2878
Justin Bogner25463f12014-04-18 20:27:24 +00002879 typedef unsigned hash_value_type;
2880 typedef unsigned offset_type;
2881
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002882 explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) { }
Mike Stump11289f42009-09-09 15:08:12 +00002883
Justin Bogner25463f12014-04-18 20:27:24 +00002884 static hash_value_type ComputeHash(Selector Sel) {
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +00002885 return serialization::ComputeHash(Sel);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002886 }
Mike Stump11289f42009-09-09 15:08:12 +00002887
2888 std::pair<unsigned,unsigned>
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002889 EmitKeyDataLength(raw_ostream& Out, Selector Sel,
Douglas Gregorc78d3462009-04-24 21:10:55 +00002890 data_type_ref Methods) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002891 using namespace llvm::support;
2892 endian::Writer<little> LE(Out);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002893 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
Justin Bognere1c147c2014-03-28 22:03:19 +00002894 LE.write<uint16_t>(KeyLen);
Sebastian Redl834bb972010-08-04 17:20:04 +00002895 unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
2896 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002897 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002898 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002899 DataLen += 4;
Sebastian Redl834bb972010-08-04 17:20:04 +00002900 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002901 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002902 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002903 DataLen += 4;
Justin Bognere1c147c2014-03-28 22:03:19 +00002904 LE.write<uint16_t>(DataLen);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002905 return std::make_pair(KeyLen, DataLen);
2906 }
Mike Stump11289f42009-09-09 15:08:12 +00002907
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002908 void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002909 using namespace llvm::support;
2910 endian::Writer<little> LE(Out);
Mike Stump11289f42009-09-09 15:08:12 +00002911 uint64_t Start = Out.tell();
Douglas Gregor95c13f52009-04-25 17:48:32 +00002912 assert((Start >> 32) == 0 && "Selector key offset too large");
2913 Writer.SetSelectorOffset(Sel, Start);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002914 unsigned N = Sel.getNumArgs();
Justin Bognere1c147c2014-03-28 22:03:19 +00002915 LE.write<uint16_t>(N);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002916 if (N == 0)
2917 N = 1;
2918 for (unsigned I = 0; I != N; ++I)
Justin Bognere1c147c2014-03-28 22:03:19 +00002919 LE.write<uint32_t>(
2920 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
Douglas Gregorc78d3462009-04-24 21:10:55 +00002921 }
Mike Stump11289f42009-09-09 15:08:12 +00002922
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002923 void EmitData(raw_ostream& Out, key_type_ref,
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002924 data_type_ref Methods, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002925 using namespace llvm::support;
2926 endian::Writer<little> LE(Out);
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002927 uint64_t Start = Out.tell(); (void)Start;
Justin Bognere1c147c2014-03-28 22:03:19 +00002928 LE.write<uint32_t>(Methods.ID);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002929 unsigned NumInstanceMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00002930 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002931 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002932 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002933 ++NumInstanceMethods;
2934
2935 unsigned NumFactoryMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00002936 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002937 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002938 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002939 ++NumFactoryMethods;
2940
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002941 unsigned InstanceBits = Methods.Instance.getBits();
2942 assert(InstanceBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00002943 unsigned InstanceHasMoreThanOneDeclBit =
2944 Methods.Instance.hasMoreThanOneDecl();
2945 unsigned FullInstanceBits = (NumInstanceMethods << 3) |
2946 (InstanceHasMoreThanOneDeclBit << 2) |
2947 InstanceBits;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002948 unsigned FactoryBits = Methods.Factory.getBits();
2949 assert(FactoryBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00002950 unsigned FactoryHasMoreThanOneDeclBit =
2951 Methods.Factory.hasMoreThanOneDecl();
2952 unsigned FullFactoryBits = (NumFactoryMethods << 3) |
2953 (FactoryHasMoreThanOneDeclBit << 2) |
2954 FactoryBits;
2955 LE.write<uint16_t>(FullInstanceBits);
2956 LE.write<uint16_t>(FullFactoryBits);
Sebastian Redl834bb972010-08-04 17:20:04 +00002957 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002958 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002959 if (Method->getMethod())
2960 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Sebastian Redl834bb972010-08-04 17:20:04 +00002961 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002962 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002963 if (Method->getMethod())
2964 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002965
2966 assert(Out.tell() - Start == DataLen && "Data length is wrong");
Douglas Gregorc78d3462009-04-24 21:10:55 +00002967 }
2968};
2969} // end anonymous namespace
2970
Sebastian Redla19a67f2010-08-03 21:58:15 +00002971/// \brief Write ObjC data: selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00002972///
2973/// The method pool contains both instance and factory methods, stored
Sebastian Redla19a67f2010-08-03 21:58:15 +00002974/// in an on-disk hash table indexed by the selector. The hash table also
2975/// contains an empty entry for every other selector known to Sema.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002976void ASTWriter::WriteSelectors(Sema &SemaRef) {
Douglas Gregorc78d3462009-04-24 21:10:55 +00002977 using namespace llvm;
2978
Sebastian Redla19a67f2010-08-03 21:58:15 +00002979 // Do we have to do anything at all?
Sebastian Redl834bb972010-08-04 17:20:04 +00002980 if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
Sebastian Redla19a67f2010-08-03 21:58:15 +00002981 return;
Sebastian Redld95a56e2010-08-04 18:21:41 +00002982 unsigned NumTableEntries = 0;
Sebastian Redla19a67f2010-08-03 21:58:15 +00002983 // Create and write out the blob that contains selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00002984 {
Justin Bognerbb094f02014-04-18 19:57:06 +00002985 llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00002986 ASTMethodPoolTrait Trait(*this);
Mike Stump11289f42009-09-09 15:08:12 +00002987
Sebastian Redla19a67f2010-08-03 21:58:15 +00002988 // Create the on-disk hash table representation. We walk through every
2989 // selector we've seen and look it up in the method pool.
Sebastian Redld95a56e2010-08-04 18:21:41 +00002990 SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
Sebastian Redl539c5062010-08-18 23:57:32 +00002991 for (llvm::DenseMap<Selector, SelectorID>::iterator
Sebastian Redl834bb972010-08-04 17:20:04 +00002992 I = SelectorIDs.begin(), E = SelectorIDs.end();
2993 I != E; ++I) {
2994 Selector S = I->first;
Sebastian Redla19a67f2010-08-03 21:58:15 +00002995 Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002996 ASTMethodPoolTrait::data_type Data = {
Sebastian Redl834bb972010-08-04 17:20:04 +00002997 I->second,
2998 ObjCMethodList(),
2999 ObjCMethodList()
3000 };
3001 if (F != SemaRef.MethodPool.end()) {
3002 Data.Instance = F->second.first;
3003 Data.Factory = F->second.second;
3004 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003005 // Only write this selector if it's not in an existing AST or something
Sebastian Redld95a56e2010-08-04 18:21:41 +00003006 // changed.
3007 if (Chain && I->second < FirstSelectorID) {
3008 // Selector already exists. Did it change?
3009 bool changed = false;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003010 for (ObjCMethodList *M = &Data.Instance;
3011 !changed && M && M->getMethod(); M = M->getNext()) {
3012 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003013 changed = true;
3014 }
Nico Weber2e0c8f72014-12-27 03:58:08 +00003015 for (ObjCMethodList *M = &Data.Factory; !changed && M && M->getMethod();
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003016 M = M->getNext()) {
Nico Weber2e0c8f72014-12-27 03:58:08 +00003017 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003018 changed = true;
3019 }
3020 if (!changed)
3021 continue;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003022 } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) {
Sebastian Redl6e1a2a02010-08-04 21:22:45 +00003023 // A new method pool entry.
3024 ++NumTableEntries;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003025 }
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003026 Generator.insert(S, Data, Trait);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003027 }
3028
Douglas Gregorc78d3462009-04-24 21:10:55 +00003029 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003030 SmallString<4096> MethodPool;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003031 uint32_t BucketOffset;
3032 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003033 using namespace llvm::support;
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003034 ASTMethodPoolTrait Trait(*this);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003035 llvm::raw_svector_ostream Out(MethodPool);
3036 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003037 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003038 BucketOffset = Generator.Emit(Out, Trait);
3039 }
3040
3041 // Create a blob abbreviation
3042 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003043 Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003044 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003045 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003046 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3047 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(Abbrev);
3048
Douglas Gregor95c13f52009-04-25 17:48:32 +00003049 // Write the method pool
Douglas Gregorc78d3462009-04-24 21:10:55 +00003050 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00003051 Record.push_back(METHOD_POOL);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003052 Record.push_back(BucketOffset);
Sebastian Redld95a56e2010-08-04 18:21:41 +00003053 Record.push_back(NumTableEntries);
Daniel Dunbar8100d012009-08-24 09:31:37 +00003054 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool.str());
Douglas Gregor95c13f52009-04-25 17:48:32 +00003055
3056 // Create a blob abbreviation for the selector table offsets.
3057 Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003058 Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
Douglas Gregord4c5ed02010-10-29 22:39:52 +00003059 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
Douglas Gregor8f364fb2011-08-03 23:28:44 +00003060 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor95c13f52009-04-25 17:48:32 +00003061 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3062 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
3063
3064 // Write the selector offsets table.
3065 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00003066 Record.push_back(SELECTOR_OFFSETS);
Douglas Gregor95c13f52009-04-25 17:48:32 +00003067 Record.push_back(SelectorOffsets.size());
Douglas Gregor8f364fb2011-08-03 23:28:44 +00003068 Record.push_back(FirstSelectorID - NUM_PREDEF_SELECTOR_IDS);
Douglas Gregor95c13f52009-04-25 17:48:32 +00003069 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
Benjamin Kramerd47a12a2011-04-24 17:44:50 +00003070 data(SelectorOffsets));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003071 }
3072}
3073
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003074/// \brief Write the selectors referenced in @selector expression into AST file.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003075void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003076 using namespace llvm;
3077 if (SemaRef.ReferencedSelectors.empty())
3078 return;
Sebastian Redlada023c2010-08-04 20:40:17 +00003079
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003080 RecordData Record;
Sebastian Redlada023c2010-08-04 20:40:17 +00003081
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003082 // Note: this writes out all references even for a dependent AST. But it is
Sebastian Redl51c79d82010-08-04 22:21:29 +00003083 // very tricky to fix, and given that @selector shouldn't really appear in
3084 // headers, probably not worth it. It's not a correctness issue.
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003085 for (DenseMap<Selector, SourceLocation>::iterator S =
3086 SemaRef.ReferencedSelectors.begin(),
3087 E = SemaRef.ReferencedSelectors.end(); S != E; ++S) {
3088 Selector Sel = (*S).first;
3089 SourceLocation Loc = (*S).second;
3090 AddSelectorRef(Sel, Record);
3091 AddSourceLocation(Loc, Record);
3092 }
Sebastian Redl539c5062010-08-18 23:57:32 +00003093 Stream.EmitRecord(REFERENCED_SELECTOR_POOL, Record);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003094}
3095
Douglas Gregorc5046832009-04-27 18:38:38 +00003096//===----------------------------------------------------------------------===//
3097// Identifier Table Serialization
3098//===----------------------------------------------------------------------===//
3099
Douglas Gregorc78d3462009-04-24 21:10:55 +00003100namespace {
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003101class ASTIdentifierTableTrait {
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003102 ASTWriter &Writer;
Douglas Gregorc3366a52009-04-21 23:56:24 +00003103 Preprocessor &PP;
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003104 IdentifierResolver &IdResolver;
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003105 bool IsModule;
3106
Douglas Gregor1d583f22009-04-28 21:18:29 +00003107 /// \brief Determines whether this is an "interesting" identifier
3108 /// that needs a full IdentifierInfo structure written into the hash
3109 /// table.
Argyrios Kyrtzidis09c9e812013-02-20 00:54:57 +00003110 bool isInterestingIdentifier(IdentifierInfo *II, MacroDirective *&Macro) {
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003111 if (II->isPoisoned() ||
3112 II->isExtensionToken() ||
3113 II->getObjCOrBuiltinID() ||
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003114 II->hasRevertedTokenIDToIdentifier() ||
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003115 II->getFETokenInfo<void>())
3116 return true;
3117
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003118 return hadMacroDefinition(II, Macro);
Douglas Gregord7910e92011-09-14 22:14:14 +00003119 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003120
Argyrios Kyrtzidis09c9e812013-02-20 00:54:57 +00003121 bool hadMacroDefinition(IdentifierInfo *II, MacroDirective *&Macro) {
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003122 if (!II->hadMacroDefinition())
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003123 return false;
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003124
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003125 if (Macro || (Macro = PP.getMacroDirectiveHistory(II))) {
3126 if (!IsModule)
3127 return !shouldIgnoreMacro(Macro, IsModule, PP);
Richard Smithdaa69e02014-07-25 04:40:03 +00003128
3129 MacroState State;
3130 if (getFirstPublicSubmoduleMacro(Macro, State))
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003131 return true;
3132 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003133
3134 return false;
Douglas Gregor1d583f22009-04-28 21:18:29 +00003135 }
3136
Richard Smithdaa69e02014-07-25 04:40:03 +00003137 enum class SubmoduleMacroState {
3138 /// We've seen nothing about this macro.
3139 None,
3140 /// We've seen a public visibility directive.
3141 Public,
3142 /// We've either exported a macro for this module or found that the
3143 /// module's definition of this macro is private.
3144 Done
3145 };
3146 typedef llvm::DenseMap<SubmoduleID, SubmoduleMacroState> MacroState;
Richard Smith49f906a2014-03-01 00:08:04 +00003147
3148 MacroDirective *
Richard Smithdaa69e02014-07-25 04:40:03 +00003149 getFirstPublicSubmoduleMacro(MacroDirective *MD, MacroState &State) {
3150 if (MacroDirective *NextMD = getPublicSubmoduleMacro(MD, State))
3151 return NextMD;
Craig Toppera13603a2014-05-22 05:54:18 +00003152 return nullptr;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003153 }
3154
Richard Smith49f906a2014-03-01 00:08:04 +00003155 MacroDirective *
Richard Smithdaa69e02014-07-25 04:40:03 +00003156 getNextPublicSubmoduleMacro(MacroDirective *MD, MacroState &State) {
Richard Smith49f906a2014-03-01 00:08:04 +00003157 if (MacroDirective *NextMD =
Richard Smithdaa69e02014-07-25 04:40:03 +00003158 getPublicSubmoduleMacro(MD->getPrevious(), State))
3159 return NextMD;
Craig Toppera13603a2014-05-22 05:54:18 +00003160 return nullptr;
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00003161 }
3162
Richard Smithdaa69e02014-07-25 04:40:03 +00003163 /// \brief Traverses the macro directives history and returns the next
3164 /// public macro definition or undefinition that has not been found so far.
3165 ///
Richard Smith49f906a2014-03-01 00:08:04 +00003166 /// A macro that is defined in submodule A and undefined in submodule B
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00003167 /// will still be considered as defined/exported from submodule A.
Richard Smith49f906a2014-03-01 00:08:04 +00003168 MacroDirective *getPublicSubmoduleMacro(MacroDirective *MD,
Richard Smithdaa69e02014-07-25 04:40:03 +00003169 MacroState &State) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00003170 if (!MD)
Craig Toppera13603a2014-05-22 05:54:18 +00003171 return nullptr;
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00003172
Richard Smith49f906a2014-03-01 00:08:04 +00003173 Optional<bool> IsPublic;
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00003174 for (; MD; MD = MD->getPrevious()) {
Richard Smithdaa69e02014-07-25 04:40:03 +00003175 // Once we hit an ignored macro, we're done: the rest of the chain
3176 // will all be ignored macros.
3177 if (shouldIgnoreMacro(MD, IsModule, PP))
3178 break;
Richard Smith57721ac2014-07-21 04:10:40 +00003179
Richard Smithdaa69e02014-07-25 04:40:03 +00003180 // If this macro was imported, re-export it.
3181 if (MD->isImported())
3182 return MD;
Richard Smith57721ac2014-07-21 04:10:40 +00003183
Richard Smithdaa69e02014-07-25 04:40:03 +00003184 SubmoduleID ModID = getSubmoduleID(MD);
3185 auto &S = State[ModID];
3186 assert(ModID && "found macro in no submodule");
Richard Smith49f906a2014-03-01 00:08:04 +00003187
Richard Smithdaa69e02014-07-25 04:40:03 +00003188 if (S == SubmoduleMacroState::Done)
Argyrios Kyrtzidis3e612b42013-04-03 05:11:33 +00003189 continue;
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00003190
Richard Smithdaa69e02014-07-25 04:40:03 +00003191 if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
3192 // The latest visibility directive for a name in a submodule affects all
3193 // the directives that come before it.
3194 if (S == SubmoduleMacroState::None)
3195 S = VisMD->isPublic() ? SubmoduleMacroState::Public
3196 : SubmoduleMacroState::Done;
3197 } else {
3198 S = SubmoduleMacroState::Done;
Richard Smith49f906a2014-03-01 00:08:04 +00003199 return MD;
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00003200 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003201 }
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00003202
Craig Toppera13603a2014-05-22 05:54:18 +00003203 return nullptr;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003204 }
3205
Richard Smithdaa69e02014-07-25 04:40:03 +00003206 ArrayRef<SubmoduleID>
3207 getOverriddenSubmodules(MacroDirective *MD,
3208 SmallVectorImpl<SubmoduleID> &ScratchSpace) {
3209 assert(!isa<VisibilityMacroDirective>(MD) &&
3210 "only #define and #undef can override");
3211 if (MD->isImported())
3212 return MD->getOverriddenModules();
3213
3214 ScratchSpace.clear();
3215 SubmoduleID ModID = getSubmoduleID(MD);
3216 for (MD = MD->getPrevious(); MD; MD = MD->getPrevious()) {
3217 if (shouldIgnoreMacro(MD, IsModule, PP))
3218 break;
3219
3220 // If this is a definition from a submodule import, that submodule's
3221 // definition is overridden by the definition or undefinition that we
3222 // started with.
3223 if (MD->isImported()) {
3224 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
3225 SubmoduleID DefModuleID = DefMD->getInfo()->getOwningModuleID();
3226 assert(DefModuleID && "imported macro has no owning module");
3227 ScratchSpace.push_back(DefModuleID);
3228 } else if (auto *UndefMD = dyn_cast<UndefMacroDirective>(MD)) {
3229 // If we override a #undef, we override anything that #undef overrides.
3230 // We don't need to override it, since an active #undef doesn't affect
3231 // the meaning of a macro.
3232 auto Overrides = UndefMD->getOverriddenModules();
3233 ScratchSpace.insert(ScratchSpace.end(),
3234 Overrides.begin(), Overrides.end());
3235 }
3236 }
3237
3238 // Stop once we leave the original macro's submodule.
3239 //
3240 // Either this submodule #included another submodule of the same
3241 // module or it just happened to be built after the other module.
3242 // In the former case, we override the submodule's macro.
3243 //
3244 // FIXME: In the latter case, we shouldn't do so, but we can't tell
3245 // these cases apart.
3246 //
3247 // FIXME: We can leave this submodule and re-enter it if it #includes a
3248 // header within a different submodule of the same module. In such cases
3249 // the overrides list will be incomplete.
3250 SubmoduleID DirectiveModuleID = getSubmoduleID(MD);
3251 if (DirectiveModuleID != ModID) {
3252 if (DirectiveModuleID && !MD->isImported())
3253 ScratchSpace.push_back(DirectiveModuleID);
3254 break;
3255 }
3256 }
3257
3258 std::sort(ScratchSpace.begin(), ScratchSpace.end());
3259 ScratchSpace.erase(std::unique(ScratchSpace.begin(), ScratchSpace.end()),
3260 ScratchSpace.end());
3261 return ScratchSpace;
3262 }
3263
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003264 SubmoduleID getSubmoduleID(MacroDirective *MD) {
Richard Smith57721ac2014-07-21 04:10:40 +00003265 return Writer.inferSubmoduleIDFromLocation(MD->getLocation());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003266 }
3267
Douglas Gregore84a9da2009-04-20 20:36:09 +00003268public:
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003269 typedef IdentifierInfo* key_type;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003270 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00003271
Sebastian Redl539c5062010-08-18 23:57:32 +00003272 typedef IdentID data_type;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003273 typedef data_type data_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00003274
Justin Bogner25463f12014-04-18 20:27:24 +00003275 typedef unsigned hash_value_type;
3276 typedef unsigned offset_type;
3277
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003278 ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
3279 IdentifierResolver &IdResolver, bool IsModule)
3280 : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule) { }
Douglas Gregore84a9da2009-04-20 20:36:09 +00003281
Justin Bogner25463f12014-04-18 20:27:24 +00003282 static hash_value_type ComputeHash(const IdentifierInfo* II) {
Daniel Dunbarf8502d52009-10-17 23:52:28 +00003283 return llvm::HashString(II->getName());
Douglas Gregore84a9da2009-04-20 20:36:09 +00003284 }
Mike Stump11289f42009-09-09 15:08:12 +00003285
3286 std::pair<unsigned,unsigned>
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003287 EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) {
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003288 unsigned KeyLen = II->getLength() + 1;
Douglas Gregor1d583f22009-04-28 21:18:29 +00003289 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
Craig Toppera13603a2014-05-22 05:54:18 +00003290 MacroDirective *Macro = nullptr;
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003291 if (isInterestingIdentifier(II, Macro)) {
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003292 DataLen += 2; // 2 bytes for builtin ID
3293 DataLen += 2; // 2 bytes for flags
Argyrios Kyrtzidis719736c2013-01-19 03:14:56 +00003294 if (hadMacroDefinition(II, Macro)) {
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003295 DataLen += 4; // MacroDirectives offset.
3296 if (IsModule) {
Richard Smithdaa69e02014-07-25 04:40:03 +00003297 MacroState State;
3298 SmallVector<SubmoduleID, 16> Scratch;
3299 for (MacroDirective *MD = getFirstPublicSubmoduleMacro(Macro, State);
3300 MD; MD = getNextPublicSubmoduleMacro(MD, State)) {
Richard Smith49f906a2014-03-01 00:08:04 +00003301 DataLen += 4; // MacroInfo ID or ModuleID.
Richard Smithdaa69e02014-07-25 04:40:03 +00003302 if (unsigned NumOverrides =
3303 getOverriddenSubmodules(MD, Scratch).size())
3304 DataLen += 4 * (1 + NumOverrides);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003305 }
Richard Smithdaa69e02014-07-25 04:40:03 +00003306 DataLen += 4; // 0 terminator.
Argyrios Kyrtzidis719736c2013-01-19 03:14:56 +00003307 }
Argyrios Kyrtzidis719736c2013-01-19 03:14:56 +00003308 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003309
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003310 for (IdentifierResolver::iterator D = IdResolver.begin(II),
3311 DEnd = IdResolver.end();
Douglas Gregor1d583f22009-04-28 21:18:29 +00003312 D != DEnd; ++D)
Richard Smithdaa69e02014-07-25 04:40:03 +00003313 DataLen += 4;
Douglas Gregor1d583f22009-04-28 21:18:29 +00003314 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003315 using namespace llvm::support;
3316 endian::Writer<little> LE(Out);
3317
3318 LE.write<uint16_t>(DataLen);
Douglas Gregorab4df582009-04-28 20:01:51 +00003319 // We emit the key length after the data length so that every
3320 // string is preceded by a 16-bit length. This matches the PTH
3321 // format for storing identifiers.
Justin Bognere1c147c2014-03-28 22:03:19 +00003322 LE.write<uint16_t>(KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003323 return std::make_pair(KeyLen, DataLen);
3324 }
Mike Stump11289f42009-09-09 15:08:12 +00003325
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003326 void EmitKey(raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregore84a9da2009-04-20 20:36:09 +00003327 unsigned KeyLen) {
3328 // Record the location of the key data. This is used when generating
3329 // the mapping from persistent IDs to strings.
3330 Writer.SetIdentifierOffset(II, Out.tell());
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003331 Out.write(II->getNameStart(), KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003332 }
Mike Stump11289f42009-09-09 15:08:12 +00003333
Richard Smith49f906a2014-03-01 00:08:04 +00003334 static void emitMacroOverrides(raw_ostream &Out,
Craig Topper00bbdcf2014-06-28 23:22:23 +00003335 ArrayRef<SubmoduleID> Overridden) {
Richard Smith49f906a2014-03-01 00:08:04 +00003336 if (!Overridden.empty()) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003337 using namespace llvm::support;
3338 endian::Writer<little> LE(Out);
3339 LE.write<uint32_t>(Overridden.size() | 0x80000000U);
Richard Smithdaa69e02014-07-25 04:40:03 +00003340 for (unsigned I = 0, N = Overridden.size(); I != N; ++I) {
3341 assert(Overridden[I] && "zero module ID for override");
Justin Bognere1c147c2014-03-28 22:03:19 +00003342 LE.write<uint32_t>(Overridden[I]);
Richard Smithdaa69e02014-07-25 04:40:03 +00003343 }
Richard Smith49f906a2014-03-01 00:08:04 +00003344 }
3345 }
3346
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003347 void EmitData(raw_ostream& Out, IdentifierInfo* II,
Sebastian Redl539c5062010-08-18 23:57:32 +00003348 IdentID ID, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003349 using namespace llvm::support;
3350 endian::Writer<little> LE(Out);
Craig Toppera13603a2014-05-22 05:54:18 +00003351 MacroDirective *Macro = nullptr;
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003352 if (!isInterestingIdentifier(II, Macro)) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003353 LE.write<uint32_t>(ID << 1);
Douglas Gregor1d583f22009-04-28 21:18:29 +00003354 return;
3355 }
Douglas Gregorb9256522009-04-28 21:32:13 +00003356
Justin Bognere1c147c2014-03-28 22:03:19 +00003357 LE.write<uint32_t>((ID << 1) | 0x01);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003358 uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID();
3359 assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
Justin Bognere1c147c2014-03-28 22:03:19 +00003360 LE.write<uint16_t>(Bits);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003361 Bits = 0;
3362 bool HadMacroDefinition = hadMacroDefinition(II, Macro);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003363 Bits = (Bits << 1) | unsigned(HadMacroDefinition);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003364 Bits = (Bits << 1) | unsigned(IsModule);
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003365 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
3366 Bits = (Bits << 1) | unsigned(II->isPoisoned());
Argyrios Kyrtzidis3084a612010-08-11 22:55:12 +00003367 Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003368 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
Justin Bognere1c147c2014-03-28 22:03:19 +00003369 LE.write<uint16_t>(Bits);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003370
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003371 if (HadMacroDefinition) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003372 LE.write<uint32_t>(Writer.getMacroDirectivesOffset(II));
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003373 if (IsModule) {
3374 // Write the IDs of macros coming from different submodules.
Richard Smithdaa69e02014-07-25 04:40:03 +00003375 MacroState State;
3376 SmallVector<SubmoduleID, 16> Scratch;
3377 for (MacroDirective *MD = getFirstPublicSubmoduleMacro(Macro, State);
3378 MD; MD = getNextPublicSubmoduleMacro(MD, State)) {
Richard Smith49f906a2014-03-01 00:08:04 +00003379 if (DefMacroDirective *DefMD = dyn_cast<DefMacroDirective>(MD)) {
Richard Smithdaa69e02014-07-25 04:40:03 +00003380 // FIXME: If this macro directive was created by #pragma pop_macros,
3381 // or if it was created implicitly by resolving conflicting macros,
3382 // it may be for a different submodule from the one in the MacroInfo
3383 // object. If so, we should write out its owning ModuleID.
3384 MacroID InfoID = Writer.getMacroID(DefMD->getInfo());
Richard Smith49f906a2014-03-01 00:08:04 +00003385 assert(InfoID);
Justin Bognere1c147c2014-03-28 22:03:19 +00003386 LE.write<uint32_t>(InfoID << 1);
Richard Smith49f906a2014-03-01 00:08:04 +00003387 } else {
Richard Smithdaa69e02014-07-25 04:40:03 +00003388 auto *UndefMD = cast<UndefMacroDirective>(MD);
3389 SubmoduleID Mod = UndefMD->isImported()
3390 ? UndefMD->getOwningModuleID()
3391 : getSubmoduleID(UndefMD);
3392 LE.write<uint32_t>((Mod << 1) | 1);
Richard Smith49f906a2014-03-01 00:08:04 +00003393 }
Richard Smithdaa69e02014-07-25 04:40:03 +00003394 emitMacroOverrides(Out, getOverriddenSubmodules(MD, Scratch));
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003395 }
Richard Smithdaa69e02014-07-25 04:40:03 +00003396 LE.write<uint32_t>(0xdeadbeef);
Argyrios Kyrtzidis719736c2013-01-19 03:14:56 +00003397 }
Douglas Gregor7b8e4bc2011-12-02 15:45:10 +00003398 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003399
Douglas Gregora868bbd2009-04-21 22:25:48 +00003400 // Emit the declaration IDs in reverse order, because the
3401 // IdentifierResolver provides the declarations as they would be
3402 // visible (e.g., the function "stat" would come before the struct
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003403 // "stat"), but the ASTReader adds declarations to the end of the list
3404 // (so we need to see the struct "status" before the function "status").
Sebastian Redlff4a2952010-07-23 23:49:55 +00003405 // Only emit declarations that aren't from a chained PCH, though.
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003406 SmallVector<Decl *, 16> Decls(IdResolver.begin(II),
3407 IdResolver.end());
Craig Topper2341c0d2013-07-04 03:08:24 +00003408 for (SmallVectorImpl<Decl *>::reverse_iterator D = Decls.rbegin(),
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003409 DEnd = Decls.rend();
Douglas Gregore84a9da2009-04-20 20:36:09 +00003410 D != DEnd; ++D)
Justin Bognere1c147c2014-03-28 22:03:19 +00003411 LE.write<uint32_t>(Writer.getDeclID(getMostRecentLocalDecl(*D)));
Argyrios Kyrtzidise5edbf92013-04-26 21:33:35 +00003412 }
3413
3414 /// \brief Returns the most recent local decl or the given decl if there are
3415 /// no local ones. The given decl is assumed to be the most recent one.
3416 Decl *getMostRecentLocalDecl(Decl *Orig) {
3417 // The only way a "from AST file" decl would be more recent from a local one
3418 // is if it came from a module.
3419 if (!PP.getLangOpts().Modules)
3420 return Orig;
3421
3422 // Look for a local in the decl chain.
3423 for (Decl *D = Orig; D; D = D->getPreviousDecl()) {
3424 if (!D->isFromASTFile())
3425 return D;
3426 // If we come up a decl from a (chained-)PCH stop since we won't find a
3427 // local one.
3428 if (D->getOwningModuleID() == 0)
3429 break;
3430 }
3431
3432 return Orig;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003433 }
3434};
3435} // end anonymous namespace
3436
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003437/// \brief Write the identifier table into the AST file.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003438///
3439/// The identifier table consists of a blob containing string data
3440/// (the actual identifiers themselves) and a separate "offsets" index
3441/// that maps identifier IDs to locations within the blob.
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003442void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
3443 IdentifierResolver &IdResolver,
3444 bool IsModule) {
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003445 using namespace llvm;
3446
3447 // Create and write out the blob that contains the identifier
3448 // strings.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003449 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003450 llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003451 ASTIdentifierTableTrait Trait(*this, PP, IdResolver, IsModule);
Mike Stump11289f42009-09-09 15:08:12 +00003452
Douglas Gregore6648fb2009-04-28 20:33:11 +00003453 // Look for any identifiers that were named while processing the
3454 // headers, but are otherwise not needed. We add these to the hash
3455 // table to enable checking of the predefines buffer in the case
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003456 // where the user adds new macro definitions when building the AST
Douglas Gregore6648fb2009-04-28 20:33:11 +00003457 // file.
3458 for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
3459 IDEnd = PP.getIdentifierTable().end();
3460 ID != IDEnd; ++ID)
3461 getIdentifierRef(ID->second);
3462
Sebastian Redlff4a2952010-07-23 23:49:55 +00003463 // Create the on-disk hash table representation. We only store offsets
3464 // for identifiers that appear here for the first time.
3465 IdentifierOffsets.resize(NextIdentID - FirstIdentID);
Sebastian Redl539c5062010-08-18 23:57:32 +00003466 for (llvm::DenseMap<const IdentifierInfo *, IdentID>::iterator
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003467 ID = IdentifierIDs.begin(), IDEnd = IdentifierIDs.end();
3468 ID != IDEnd; ++ID) {
3469 assert(ID->first && "NULL identifier in identifier table");
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003470 if (!Chain || !ID->first->isFromAST() ||
3471 ID->first->hasChangedSinceDeserialization())
Douglas Gregor8d7edce2013-02-08 21:30:59 +00003472 Generator.insert(const_cast<IdentifierInfo *>(ID->first), ID->second,
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003473 Trait);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003474 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003475
Douglas Gregore84a9da2009-04-20 20:36:09 +00003476 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003477 SmallString<4096> IdentifierTable;
Douglas Gregora868bbd2009-04-21 22:25:48 +00003478 uint32_t BucketOffset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003479 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003480 using namespace llvm::support;
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003481 ASTIdentifierTableTrait Trait(*this, PP, IdResolver, IsModule);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003482 llvm::raw_svector_ostream Out(IdentifierTable);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003483 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003484 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregora868bbd2009-04-21 22:25:48 +00003485 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003486 }
3487
3488 // Create a blob abbreviation
3489 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003490 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
Douglas Gregora868bbd2009-04-21 22:25:48 +00003491 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregore84a9da2009-04-20 20:36:09 +00003492 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Douglas Gregor8f45df52009-04-16 22:23:12 +00003493 unsigned IDTableAbbrev = Stream.EmitAbbrev(Abbrev);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003494
3495 // Write the identifier table
3496 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00003497 Record.push_back(IDENTIFIER_TABLE);
Douglas Gregora868bbd2009-04-21 22:25:48 +00003498 Record.push_back(BucketOffset);
Daniel Dunbar8100d012009-08-24 09:31:37 +00003499 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable.str());
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003500 }
3501
3502 // Write the offsets table for identifier IDs.
Douglas Gregor0e149972009-04-25 19:10:14 +00003503 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003504 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
Douglas Gregor0e149972009-04-25 19:10:14 +00003505 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
Douglas Gregor1ab036c2011-08-03 21:49:18 +00003506 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor0e149972009-04-25 19:10:14 +00003507 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3508 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
3509
Douglas Gregor8d7edce2013-02-08 21:30:59 +00003510#ifndef NDEBUG
3511 for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I)
3512 assert(IdentifierOffsets[I] && "Missing identifier offset?");
3513#endif
3514
Douglas Gregor0e149972009-04-25 19:10:14 +00003515 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00003516 Record.push_back(IDENTIFIER_OFFSET);
Douglas Gregor0e149972009-04-25 19:10:14 +00003517 Record.push_back(IdentifierOffsets.size());
Douglas Gregor1ab036c2011-08-03 21:49:18 +00003518 Record.push_back(FirstIdentID - NUM_PREDEF_IDENT_IDS);
Douglas Gregor0e149972009-04-25 19:10:14 +00003519 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
Benjamin Kramerd47a12a2011-04-24 17:44:50 +00003520 data(IdentifierOffsets));
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003521}
3522
Douglas Gregorc5046832009-04-27 18:38:38 +00003523//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003524// DeclContext's Name Lookup Table Serialization
3525//===----------------------------------------------------------------------===//
3526
Richard Smithbb853c72014-08-13 01:23:33 +00003527/// Determine the declaration that should be put into the name lookup table to
3528/// represent the given declaration in this module. This is usually D itself,
3529/// but if D was imported and merged into a local declaration, we want the most
3530/// recent local declaration instead. The chosen declaration will be the most
3531/// recent declaration in any module that imports this one.
3532static NamedDecl *getDeclForLocalLookup(NamedDecl *D) {
Richard Smith8c913ec2014-08-14 02:21:01 +00003533 if (!D->isFromASTFile())
3534 return D;
3535
3536 if (Decl *Redecl = D->getPreviousDecl()) {
3537 // For Redeclarable decls, a prior declaration might be local.
3538 for (; Redecl; Redecl = Redecl->getPreviousDecl())
3539 if (!Redecl->isFromASTFile())
3540 return cast<NamedDecl>(Redecl);
3541 } else if (Decl *First = D->getCanonicalDecl()) {
3542 // For Mergeable decls, the first decl might be local.
3543 if (!First->isFromASTFile())
3544 return cast<NamedDecl>(First);
3545 }
3546
3547 // All declarations are imported. Our most recent declaration will also be
3548 // the most recent one in anyone who imports us.
Richard Smithbb853c72014-08-13 01:23:33 +00003549 return D;
3550}
3551
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003552namespace {
3553// Trait used for the on-disk hash table used in the method pool.
3554class ASTDeclContextNameLookupTrait {
3555 ASTWriter &Writer;
3556
3557public:
3558 typedef DeclarationName key_type;
3559 typedef key_type key_type_ref;
3560
3561 typedef DeclContext::lookup_result data_type;
3562 typedef const data_type& data_type_ref;
3563
Justin Bogner25463f12014-04-18 20:27:24 +00003564 typedef unsigned hash_value_type;
3565 typedef unsigned offset_type;
3566
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003567 explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) { }
3568
Justin Bogner25463f12014-04-18 20:27:24 +00003569 hash_value_type ComputeHash(DeclarationName Name) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003570 llvm::FoldingSetNodeID ID;
3571 ID.AddInteger(Name.getNameKind());
3572
3573 switch (Name.getNameKind()) {
3574 case DeclarationName::Identifier:
3575 ID.AddString(Name.getAsIdentifierInfo()->getName());
3576 break;
3577 case DeclarationName::ObjCZeroArgSelector:
3578 case DeclarationName::ObjCOneArgSelector:
3579 case DeclarationName::ObjCMultiArgSelector:
3580 ID.AddInteger(serialization::ComputeHash(Name.getObjCSelector()));
3581 break;
3582 case DeclarationName::CXXConstructorName:
3583 case DeclarationName::CXXDestructorName:
3584 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003585 break;
3586 case DeclarationName::CXXOperatorName:
3587 ID.AddInteger(Name.getCXXOverloadedOperator());
3588 break;
3589 case DeclarationName::CXXLiteralOperatorName:
3590 ID.AddString(Name.getCXXLiteralIdentifier()->getName());
3591 case DeclarationName::CXXUsingDirective:
3592 break;
3593 }
3594
3595 return ID.ComputeHash();
3596 }
3597
3598 std::pair<unsigned,unsigned>
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003599 EmitKeyDataLength(raw_ostream& Out, DeclarationName Name,
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003600 data_type_ref Lookup) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003601 using namespace llvm::support;
3602 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003603 unsigned KeyLen = 1;
3604 switch (Name.getNameKind()) {
3605 case DeclarationName::Identifier:
3606 case DeclarationName::ObjCZeroArgSelector:
3607 case DeclarationName::ObjCOneArgSelector:
3608 case DeclarationName::ObjCMultiArgSelector:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003609 case DeclarationName::CXXLiteralOperatorName:
3610 KeyLen += 4;
3611 break;
3612 case DeclarationName::CXXOperatorName:
3613 KeyLen += 1;
3614 break;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003615 case DeclarationName::CXXConstructorName:
3616 case DeclarationName::CXXDestructorName:
3617 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003618 case DeclarationName::CXXUsingDirective:
3619 break;
3620 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003621 LE.write<uint16_t>(KeyLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003622
3623 // 2 bytes for num of decls and 4 for each DeclID.
David Blaikieff7d47a2012-12-19 00:45:41 +00003624 unsigned DataLen = 2 + 4 * Lookup.size();
Justin Bognere1c147c2014-03-28 22:03:19 +00003625 LE.write<uint16_t>(DataLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003626
3627 return std::make_pair(KeyLen, DataLen);
3628 }
3629
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003630 void EmitKey(raw_ostream& Out, DeclarationName Name, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003631 using namespace llvm::support;
3632 endian::Writer<little> LE(Out);
3633 LE.write<uint8_t>(Name.getNameKind());
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003634 switch (Name.getNameKind()) {
3635 case DeclarationName::Identifier:
Justin Bognere1c147c2014-03-28 22:03:19 +00003636 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getAsIdentifierInfo()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003637 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003638 case DeclarationName::ObjCZeroArgSelector:
3639 case DeclarationName::ObjCOneArgSelector:
3640 case DeclarationName::ObjCMultiArgSelector:
Justin Bognere1c147c2014-03-28 22:03:19 +00003641 LE.write<uint32_t>(Writer.getSelectorRef(Name.getObjCSelector()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003642 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003643 case DeclarationName::CXXOperatorName:
Benjamin Kramer53750b12012-09-19 13:40:40 +00003644 assert(Name.getCXXOverloadedOperator() < NUM_OVERLOADED_OPERATORS &&
3645 "Invalid operator?");
Justin Bognere1c147c2014-03-28 22:03:19 +00003646 LE.write<uint8_t>(Name.getCXXOverloadedOperator());
Benjamin Kramer53750b12012-09-19 13:40:40 +00003647 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003648 case DeclarationName::CXXLiteralOperatorName:
Justin Bognere1c147c2014-03-28 22:03:19 +00003649 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getCXXLiteralIdentifier()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003650 return;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003651 case DeclarationName::CXXConstructorName:
3652 case DeclarationName::CXXDestructorName:
3653 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003654 case DeclarationName::CXXUsingDirective:
Benjamin Kramer53750b12012-09-19 13:40:40 +00003655 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003656 }
Benjamin Kramer53750b12012-09-19 13:40:40 +00003657
3658 llvm_unreachable("Invalid name kind?");
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003659 }
3660
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003661 void EmitData(raw_ostream& Out, key_type_ref,
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003662 data_type Lookup, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003663 using namespace llvm::support;
3664 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003665 uint64_t Start = Out.tell(); (void)Start;
Justin Bognere1c147c2014-03-28 22:03:19 +00003666 LE.write<uint16_t>(Lookup.size());
David Blaikieff7d47a2012-12-19 00:45:41 +00003667 for (DeclContext::lookup_iterator I = Lookup.begin(), E = Lookup.end();
3668 I != E; ++I)
Richard Smithbb853c72014-08-13 01:23:33 +00003669 LE.write<uint32_t>(Writer.GetDeclRef(getDeclForLocalLookup(*I)));
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003670
3671 assert(Out.tell() - Start == DataLen && "Data length is wrong");
3672 }
3673};
3674} // end anonymous namespace
3675
Richard Smithcd45dbc2014-04-19 03:48:30 +00003676template<typename Visitor>
3677static void visitLocalLookupResults(const DeclContext *ConstDC,
3678 bool NeedToReconcileExternalVisibleStorage,
3679 Visitor AddLookupResult) {
3680 // FIXME: We need to build the lookups table, which is logically const.
3681 DeclContext *DC = const_cast<DeclContext*>(ConstDC);
Richard Smith961eae52014-03-25 01:14:22 +00003682 assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
3683
Richard Smith961eae52014-03-25 01:14:22 +00003684 SmallVector<DeclarationName, 16> ExternalNames;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003685 for (auto &Lookup : *DC->buildLookup()) {
Richard Smith961eae52014-03-25 01:14:22 +00003686 if (Lookup.second.hasExternalDecls() ||
Richard Smithcd45dbc2014-04-19 03:48:30 +00003687 NeedToReconcileExternalVisibleStorage) {
Richard Smith961eae52014-03-25 01:14:22 +00003688 // We don't know for sure what declarations are found by this name,
3689 // because the external source might have a different set from the set
3690 // that are in the lookup map, and we can't update it now without
3691 // risking invalidating our lookup iterator. So add it to a queue to
3692 // deal with later.
3693 ExternalNames.push_back(Lookup.first);
3694 continue;
3695 }
3696
3697 AddLookupResult(Lookup.first, Lookup.second.getLookupResult());
3698 }
3699
3700 // Add the names we needed to defer. Note, this shouldn't add any new decls
3701 // to the list we need to serialize: any new declarations we find here should
3702 // be imported from an external source.
3703 // FIXME: What if the external source isn't an ASTReader?
3704 for (const auto &Name : ExternalNames)
Richard Smithcd45dbc2014-04-19 03:48:30 +00003705 AddLookupResult(Name, DC->lookup(Name));
3706}
3707
3708void ASTWriter::AddUpdatedDeclContext(const DeclContext *DC) {
David Blaikie82e95a32014-11-19 07:49:47 +00003709 if (UpdatedDeclContexts.insert(DC).second && WritingAST) {
Richard Smithcd45dbc2014-04-19 03:48:30 +00003710 // Ensure we emit all the visible declarations.
3711 visitLocalLookupResults(DC, DC->NeedToReconcileExternalVisibleStorage,
3712 [&](DeclarationName Name,
3713 DeclContext::lookup_const_result Result) {
3714 for (auto *Decl : Result)
Richard Smithbb853c72014-08-13 01:23:33 +00003715 GetDeclRef(getDeclForLocalLookup(Decl));
Richard Smithcd45dbc2014-04-19 03:48:30 +00003716 });
3717 }
3718}
3719
3720uint32_t
3721ASTWriter::GenerateNameLookupTable(const DeclContext *DC,
3722 llvm::SmallVectorImpl<char> &LookupTable) {
3723 assert(!DC->LookupPtr.getInt() && "must call buildLookups first");
3724
3725 llvm::OnDiskChainedHashTableGenerator<ASTDeclContextNameLookupTrait>
3726 Generator;
3727 ASTDeclContextNameLookupTrait Trait(*this);
3728
3729 // Create the on-disk hash table representation.
3730 DeclarationName ConstructorName;
3731 DeclarationName ConversionName;
3732 SmallVector<NamedDecl *, 8> ConstructorDecls;
3733 SmallVector<NamedDecl *, 4> ConversionDecls;
3734
3735 visitLocalLookupResults(DC, DC->NeedToReconcileExternalVisibleStorage,
3736 [&](DeclarationName Name,
3737 DeclContext::lookup_result Result) {
3738 if (Result.empty())
3739 return;
3740
3741 // Different DeclarationName values of certain kinds are mapped to
3742 // identical serialized keys, because we don't want to use type
3743 // identifiers in the keys (since type ids are local to the module).
3744 switch (Name.getNameKind()) {
3745 case DeclarationName::CXXConstructorName:
3746 // There may be different CXXConstructorName DeclarationName values
3747 // in a DeclContext because a UsingDecl that inherits constructors
3748 // has the DeclarationName of the inherited constructors.
3749 if (!ConstructorName)
3750 ConstructorName = Name;
3751 ConstructorDecls.append(Result.begin(), Result.end());
3752 return;
3753
3754 case DeclarationName::CXXConversionFunctionName:
3755 if (!ConversionName)
3756 ConversionName = Name;
3757 ConversionDecls.append(Result.begin(), Result.end());
3758 return;
3759
3760 default:
3761 break;
3762 }
3763
3764 Generator.insert(Name, Result, Trait);
3765 });
Richard Smith961eae52014-03-25 01:14:22 +00003766
Stephan Tolksdorfa6a08632014-03-27 19:22:19 +00003767 // Add the constructors.
3768 if (!ConstructorDecls.empty()) {
3769 Generator.insert(ConstructorName,
3770 DeclContext::lookup_result(ConstructorDecls.begin(),
3771 ConstructorDecls.end()),
3772 Trait);
3773 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00003774
Stephan Tolksdorfa6a08632014-03-27 19:22:19 +00003775 // Add the conversion functions.
Richard Smith961eae52014-03-25 01:14:22 +00003776 if (!ConversionDecls.empty()) {
3777 Generator.insert(ConversionName,
3778 DeclContext::lookup_result(ConversionDecls.begin(),
3779 ConversionDecls.end()),
3780 Trait);
3781 }
3782
3783 // Create the on-disk hash table in a buffer.
3784 llvm::raw_svector_ostream Out(LookupTable);
3785 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003786 using namespace llvm::support;
3787 endian::Writer<little>(Out).write<uint32_t>(0);
Richard Smith961eae52014-03-25 01:14:22 +00003788 return Generator.Emit(Out, Trait);
3789}
3790
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003791/// \brief Write the block containing all of the declaration IDs
3792/// visible from the given DeclContext.
3793///
3794/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
Sebastian Redla4071b42010-08-24 00:50:09 +00003795/// bitstream, or 0 if no block was written.
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003796uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
3797 DeclContext *DC) {
3798 if (DC->getPrimaryContext() != DC)
3799 return 0;
3800
3801 // Since there is no name lookup into functions or methods, don't bother to
3802 // build a visible-declarations table for these entities.
3803 if (DC->isFunctionOrMethod())
3804 return 0;
3805
3806 // If not in C++, we perform name lookup for the translation unit via the
3807 // IdentifierInfo chains, don't bother to build a visible-declarations table.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003808 if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003809 return 0;
3810
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003811 // Serialize the contents of the mapping used for lookup. Note that,
3812 // although we have two very different code paths, the serialized
3813 // representation is the same for both cases: a declaration name,
3814 // followed by a size, followed by references to the visible
3815 // declarations that have that name.
3816 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smithf634c902012-03-16 06:12:59 +00003817 StoredDeclsMap *Map = DC->buildLookup();
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003818 if (!Map || Map->empty())
3819 return 0;
3820
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003821 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003822 SmallString<4096> LookupTable;
Richard Smith961eae52014-03-25 01:14:22 +00003823 uint32_t BucketOffset = GenerateNameLookupTable(DC, LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003824
3825 // Write the lookup table
3826 RecordData Record;
3827 Record.push_back(DECL_CONTEXT_VISIBLE);
3828 Record.push_back(BucketOffset);
3829 Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
3830 LookupTable.str());
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003831 ++NumVisibleDeclContexts;
3832 return Offset;
3833}
3834
Sebastian Redla4071b42010-08-24 00:50:09 +00003835/// \brief Write an UPDATE_VISIBLE block for the given context.
3836///
3837/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
3838/// DeclContext in a dependent AST file. As such, they only exist for the TU
Richard Smithf634c902012-03-16 06:12:59 +00003839/// (in C++), for namespaces, and for classes with forward-declared unscoped
3840/// enumeration members (in C++11).
Sebastian Redla4071b42010-08-24 00:50:09 +00003841void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
Richard Smith961eae52014-03-25 01:14:22 +00003842 StoredDeclsMap *Map = DC->getLookupPtr();
Sebastian Redla4071b42010-08-24 00:50:09 +00003843 if (!Map || Map->empty())
3844 return;
3845
Sebastian Redla4071b42010-08-24 00:50:09 +00003846 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003847 SmallString<4096> LookupTable;
Richard Smith961eae52014-03-25 01:14:22 +00003848 uint32_t BucketOffset = GenerateNameLookupTable(DC, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00003849
3850 // Write the lookup table
3851 RecordData Record;
3852 Record.push_back(UPDATE_VISIBLE);
3853 Record.push_back(getDeclID(cast<Decl>(DC)));
3854 Record.push_back(BucketOffset);
3855 Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable.str());
3856}
3857
Peter Collingbourne5df20e02011-02-15 19:46:30 +00003858/// \brief Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
3859void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) {
3860 RecordData Record;
3861 Record.push_back(Opts.fp_contract);
3862 Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
3863}
3864
3865/// \brief Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
3866void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00003867 if (!SemaRef.Context.getLangOpts().OpenCL)
Peter Collingbourne5df20e02011-02-15 19:46:30 +00003868 return;
3869
3870 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
3871 RecordData Record;
3872#define OPENCLEXT(nm) Record.push_back(Opts.nm);
3873#include "clang/Basic/OpenCLExtensions.def"
3874 Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
3875}
3876
Douglas Gregor358cd442012-01-15 16:58:34 +00003877void ASTWriter::WriteRedeclarations() {
3878 RecordData LocalRedeclChains;
3879 SmallVector<serialization::LocalRedeclarationsInfo, 2> LocalRedeclsMap;
3880
3881 for (unsigned I = 0, N = Redeclarations.size(); I != N; ++I) {
3882 Decl *First = Redeclarations[I];
Rafael Espindola3f9e4442013-10-19 02:13:21 +00003883 assert(First->isFirstDecl() && "Not the first declaration?");
Douglas Gregor358cd442012-01-15 16:58:34 +00003884
3885 Decl *MostRecent = First->getMostRecentDecl();
3886
3887 // If we only have a single declaration, there is no point in storing
3888 // a redeclaration chain.
3889 if (First == MostRecent)
3890 continue;
3891
3892 unsigned Offset = LocalRedeclChains.size();
3893 unsigned Size = 0;
3894 LocalRedeclChains.push_back(0); // Placeholder for the size.
3895
3896 // Collect the set of local redeclarations of this declaration.
Douglas Gregor6168bd22013-02-18 15:53:43 +00003897 for (Decl *Prev = MostRecent; Prev != First;
Douglas Gregor358cd442012-01-15 16:58:34 +00003898 Prev = Prev->getPreviousDecl()) {
3899 if (!Prev->isFromASTFile()) {
3900 AddDeclRef(Prev, LocalRedeclChains);
3901 ++Size;
3902 }
3903 }
Douglas Gregor6168bd22013-02-18 15:53:43 +00003904
3905 if (!First->isFromASTFile() && Chain) {
3906 Decl *FirstFromAST = MostRecent;
3907 for (Decl *Prev = MostRecent; Prev; Prev = Prev->getPreviousDecl()) {
3908 if (Prev->isFromASTFile())
3909 FirstFromAST = Prev;
3910 }
3911
Richard Smith2516ba22014-08-11 18:35:44 +00003912 // FIXME: Do we need to do this for the first declaration from each
3913 // redeclaration chain that was merged into this one?
Douglas Gregor6168bd22013-02-18 15:53:43 +00003914 Chain->MergedDecls[FirstFromAST].push_back(getDeclID(First));
3915 }
3916
Douglas Gregor358cd442012-01-15 16:58:34 +00003917 LocalRedeclChains[Offset] = Size;
3918
3919 // Reverse the set of local redeclarations, so that we store them in
3920 // order (since we found them in reverse order).
3921 std::reverse(LocalRedeclChains.end() - Size, LocalRedeclChains.end());
3922
Douglas Gregor6168bd22013-02-18 15:53:43 +00003923 // Add the mapping from the first ID from the AST to the set of local
3924 // declarations.
Douglas Gregor358cd442012-01-15 16:58:34 +00003925 LocalRedeclarationsInfo Info = { getDeclID(First), Offset };
3926 LocalRedeclsMap.push_back(Info);
3927
3928 assert(N == Redeclarations.size() &&
3929 "Deserialized a declaration we shouldn't have");
3930 }
3931
3932 if (LocalRedeclChains.empty())
3933 return;
3934
3935 // Sort the local redeclarations map by the first declaration ID,
3936 // since the reader will be performing binary searches on this information.
3937 llvm::array_pod_sort(LocalRedeclsMap.begin(), LocalRedeclsMap.end());
3938
3939 // Emit the local redeclarations map.
3940 using namespace llvm;
3941 llvm::BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
3942 Abbrev->Add(BitCodeAbbrevOp(LOCAL_REDECLARATIONS_MAP));
3943 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
3944 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3945 unsigned AbbrevID = Stream.EmitAbbrev(Abbrev);
3946
3947 RecordData Record;
3948 Record.push_back(LOCAL_REDECLARATIONS_MAP);
3949 Record.push_back(LocalRedeclsMap.size());
3950 Stream.EmitRecordWithBlob(AbbrevID, Record,
3951 reinterpret_cast<char*>(LocalRedeclsMap.data()),
3952 LocalRedeclsMap.size() * sizeof(LocalRedeclarationsInfo));
3953
3954 // Emit the redeclaration chains.
3955 Stream.EmitRecord(LOCAL_REDECLARATIONS, LocalRedeclChains);
3956}
3957
Douglas Gregor404cdde2012-01-27 01:47:08 +00003958void ASTWriter::WriteObjCCategories() {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003959 SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
Douglas Gregor404cdde2012-01-27 01:47:08 +00003960 RecordData Categories;
3961
3962 for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
3963 unsigned Size = 0;
3964 unsigned StartIndex = Categories.size();
3965
3966 ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
3967
3968 // Allocate space for the size.
3969 Categories.push_back(0);
3970
3971 // Add the categories.
Douglas Gregor048fbfa2013-01-16 23:00:23 +00003972 for (ObjCInterfaceDecl::known_categories_iterator
3973 Cat = Class->known_categories_begin(),
3974 CatEnd = Class->known_categories_end();
3975 Cat != CatEnd; ++Cat, ++Size) {
3976 assert(getDeclID(*Cat) != 0 && "Bogus category");
3977 AddDeclRef(*Cat, Categories);
Douglas Gregor404cdde2012-01-27 01:47:08 +00003978 }
3979
3980 // Update the size.
3981 Categories[StartIndex] = Size;
3982
3983 // Record this interface -> category map.
3984 ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex };
3985 CategoriesMap.push_back(CatInfo);
3986 }
3987
3988 // Sort the categories map by the definition ID, since the reader will be
3989 // performing binary searches on this information.
3990 llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end());
3991
3992 // Emit the categories map.
3993 using namespace llvm;
3994 llvm::BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
3995 Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
3996 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
3997 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3998 unsigned AbbrevID = Stream.EmitAbbrev(Abbrev);
3999
4000 RecordData Record;
4001 Record.push_back(OBJC_CATEGORIES_MAP);
4002 Record.push_back(CategoriesMap.size());
4003 Stream.EmitRecordWithBlob(AbbrevID, Record,
4004 reinterpret_cast<char*>(CategoriesMap.data()),
4005 CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
4006
4007 // Emit the category lists.
4008 Stream.EmitRecord(OBJC_CATEGORIES, Categories);
4009}
4010
Douglas Gregor464b0ca2011-12-22 21:40:42 +00004011void ASTWriter::WriteMergedDecls() {
4012 if (!Chain || Chain->MergedDecls.empty())
4013 return;
4014
4015 RecordData Record;
4016 for (ASTReader::MergedDeclsMap::iterator I = Chain->MergedDecls.begin(),
4017 IEnd = Chain->MergedDecls.end();
4018 I != IEnd; ++I) {
Douglas Gregor64af53c2012-01-05 22:27:05 +00004019 DeclID CanonID = I->first->isFromASTFile()? I->first->getGlobalID()
Richard Smithcd45dbc2014-04-19 03:48:30 +00004020 : GetDeclRef(I->first);
Douglas Gregor464b0ca2011-12-22 21:40:42 +00004021 assert(CanonID && "Merged declaration not known?");
4022
4023 Record.push_back(CanonID);
4024 Record.push_back(I->second.size());
4025 Record.append(I->second.begin(), I->second.end());
4026 }
4027 Stream.EmitRecord(MERGED_DECLARATIONS, Record);
4028}
4029
Richard Smithe40f2ba2013-08-07 21:41:30 +00004030void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
4031 Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap;
4032
4033 if (LPTMap.empty())
4034 return;
4035
4036 RecordData Record;
4037 for (Sema::LateParsedTemplateMapT::iterator It = LPTMap.begin(),
4038 ItEnd = LPTMap.end();
4039 It != ItEnd; ++It) {
4040 LateParsedTemplate *LPT = It->second;
4041 AddDeclRef(It->first, Record);
4042 AddDeclRef(LPT->D, Record);
4043 Record.push_back(LPT->Toks.size());
4044
4045 for (CachedTokens::iterator TokIt = LPT->Toks.begin(),
4046 TokEnd = LPT->Toks.end();
4047 TokIt != TokEnd; ++TokIt) {
4048 AddToken(*TokIt, Record);
4049 }
4050 }
4051 Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record);
4052}
4053
Dario Domizioli13a0a382014-05-23 12:13:25 +00004054/// \brief Write the state of 'pragma clang optimize' at the end of the module.
4055void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
4056 RecordData Record;
4057 SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
4058 AddSourceLocation(PragmaLoc, Record);
4059 Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record);
4060}
4061
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00004062//===----------------------------------------------------------------------===//
Douglas Gregorc5046832009-04-27 18:38:38 +00004063// General Serialization Routines
4064//===----------------------------------------------------------------------===//
4065
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004066/// \brief Write a record containing the given attributes.
Alexander Kornienko20f6fc62012-07-09 10:04:07 +00004067void ASTWriter::WriteAttributes(ArrayRef<const Attr*> Attrs,
4068 RecordDataImpl &Record) {
Argyrios Kyrtzidis9beef8e2010-10-18 19:20:11 +00004069 Record.push_back(Attrs.size());
Alexander Kornienko20f6fc62012-07-09 10:04:07 +00004070 for (ArrayRef<const Attr *>::iterator i = Attrs.begin(),
4071 e = Attrs.end(); i != e; ++i){
4072 const Attr *A = *i;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00004073 Record.push_back(A->getKind()); // FIXME: stable encoding, target attrs
Argyrios Kyrtzidis309b4c42011-09-13 16:05:58 +00004074 AddSourceRange(A->getRange(), Record);
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004075
Alexis Huntdcfba7b2010-08-18 23:23:40 +00004076#include "clang/Serialization/AttrPCHWrite.inc"
Daniel Dunbarfc6507e2010-05-27 02:25:39 +00004077
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004078 }
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004079}
4080
John McCallf413f5e2013-05-03 00:10:13 +00004081void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) {
4082 AddSourceLocation(Tok.getLocation(), Record);
4083 Record.push_back(Tok.getLength());
4084
4085 // FIXME: When reading literal tokens, reconstruct the literal pointer
4086 // if it is needed.
4087 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
4088 // FIXME: Should translate token kind to a stable encoding.
4089 Record.push_back(Tok.getKind());
4090 // FIXME: Should translate token flags to a stable encoding.
4091 Record.push_back(Tok.getFlags());
4092}
4093
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004094void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004095 Record.push_back(Str.size());
4096 Record.insert(Record.end(), Str.begin(), Str.end());
4097}
4098
Richard Smith7ed1bc92014-12-05 22:42:13 +00004099bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) {
Richard Smith54cc3c22014-12-11 20:50:24 +00004100 assert(Context && "should have context when outputting path");
Richard Smith7ed1bc92014-12-05 22:42:13 +00004101
Richard Smith54cc3c22014-12-11 20:50:24 +00004102 bool Changed =
4103 cleanPathForOutput(Context->getSourceManager().getFileManager(), Path);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004104
4105 // Remove a prefix to make the path relative, if relevant.
4106 const char *PathBegin = Path.data();
4107 const char *PathPtr =
4108 adjustFilenameForRelocatableAST(PathBegin, BaseDirectory);
4109 if (PathPtr != PathBegin) {
4110 Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin));
4111 Changed = true;
4112 }
4113
4114 return Changed;
4115}
4116
4117void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) {
4118 SmallString<128> FilePath(Path);
4119 PreparePathForOutput(FilePath);
4120 AddString(FilePath, Record);
4121}
4122
4123void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataImpl &Record,
4124 StringRef Path) {
4125 SmallString<128> FilePath(Path);
4126 PreparePathForOutput(FilePath);
4127 Stream.EmitRecordWithBlob(Abbrev, Record, FilePath);
4128}
4129
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004130void ASTWriter::AddVersionTuple(const VersionTuple &Version,
4131 RecordDataImpl &Record) {
4132 Record.push_back(Version.getMajor());
David Blaikie05785d12013-02-20 22:23:23 +00004133 if (Optional<unsigned> Minor = Version.getMinor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004134 Record.push_back(*Minor + 1);
4135 else
4136 Record.push_back(0);
David Blaikie05785d12013-02-20 22:23:23 +00004137 if (Optional<unsigned> Subminor = Version.getSubminor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004138 Record.push_back(*Subminor + 1);
4139 else
4140 Record.push_back(0);
4141}
4142
Douglas Gregore84a9da2009-04-20 20:36:09 +00004143/// \brief Note that the identifier II occurs at the given offset
4144/// within the identifier table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004145void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
Sebastian Redl539c5062010-08-18 23:57:32 +00004146 IdentID ID = IdentifierIDs[II];
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004147 // Only store offsets new to this AST file. Other identifier names are looked
Sebastian Redlff4a2952010-07-23 23:49:55 +00004148 // up earlier in the chain and thus don't need an offset.
4149 if (ID >= FirstIdentID)
4150 IdentifierOffsets[ID - FirstIdentID] = Offset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00004151}
4152
Douglas Gregor95c13f52009-04-25 17:48:32 +00004153/// \brief Note that the selector Sel occurs at the given offset
4154/// within the method pool/selector table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004155void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
Douglas Gregor95c13f52009-04-25 17:48:32 +00004156 unsigned ID = SelectorIDs[Sel];
4157 assert(ID && "Unknown selector");
Sebastian Redld95a56e2010-08-04 18:21:41 +00004158 // Don't record offsets for selectors that are also available in a different
4159 // file.
4160 if (ID < FirstSelectorID)
4161 return;
4162 SelectorOffsets[ID - FirstSelectorID] = Offset;
Douglas Gregor95c13f52009-04-25 17:48:32 +00004163}
4164
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004165ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream)
Richard Smith01b2cb42014-07-26 06:37:51 +00004166 : Stream(Stream), Context(nullptr), PP(nullptr), Chain(nullptr),
4167 WritingModule(nullptr), WritingAST(false),
4168 DoneWritingDeclsAndTypes(false), ASTHasCompilerErrors(false),
4169 FirstDeclID(NUM_PREDEF_DECL_IDS), NextDeclID(FirstDeclID),
4170 FirstTypeID(NUM_PREDEF_TYPE_IDS), NextTypeID(FirstTypeID),
4171 FirstIdentID(NUM_PREDEF_IDENT_IDS), NextIdentID(FirstIdentID),
4172 FirstMacroID(NUM_PREDEF_MACRO_IDS), NextMacroID(FirstMacroID),
4173 FirstSubmoduleID(NUM_PREDEF_SUBMODULE_IDS),
4174 NextSubmoduleID(FirstSubmoduleID),
4175 FirstSelectorID(NUM_PREDEF_SELECTOR_IDS), NextSelectorID(FirstSelectorID),
4176 CollectedStmts(&StmtsToEmit), NumStatements(0), NumMacros(0),
4177 NumLexicalDeclContexts(0), NumVisibleDeclContexts(0),
4178 NextCXXBaseSpecifiersID(1), TypeExtQualAbbrev(0),
4179 TypeFunctionProtoAbbrev(0), DeclParmVarAbbrev(0),
4180 DeclContextLexicalAbbrev(0), DeclContextVisibleLookupAbbrev(0),
Richard Smitha27c26e2014-07-27 04:19:32 +00004181 UpdateVisibleAbbrev(0), DeclRecordAbbrev(0), DeclTypedefAbbrev(0),
Richard Smith01b2cb42014-07-26 06:37:51 +00004182 DeclVarAbbrev(0), DeclFieldAbbrev(0), DeclEnumAbbrev(0),
Richard Smitha27c26e2014-07-27 04:19:32 +00004183 DeclObjCIvarAbbrev(0), DeclCXXMethodAbbrev(0), DeclRefExprAbbrev(0),
4184 CharacterLiteralAbbrev(0), IntegerLiteralAbbrev(0),
4185 ExprImplicitCastAbbrev(0) {}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004186
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004187ASTWriter::~ASTWriter() {
Reid Kleckner588c9372014-02-19 23:44:52 +00004188 llvm::DeleteContainerSeconds(FileDeclIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004189}
4190
Argyrios Kyrtzidisd7c16b22012-10-31 20:59:50 +00004191void ASTWriter::WriteAST(Sema &SemaRef,
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00004192 const std::string &OutputFile,
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00004193 Module *WritingModule, StringRef isysroot,
4194 bool hasErrors) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004195 WritingAST = true;
4196
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00004197 ASTHasCompilerErrors = hasErrors;
4198
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004199 // Emit the file header.
Douglas Gregor8f45df52009-04-16 22:23:12 +00004200 Stream.Emit((unsigned)'C', 8);
4201 Stream.Emit((unsigned)'P', 8);
4202 Stream.Emit((unsigned)'C', 8);
4203 Stream.Emit((unsigned)'H', 8);
Mike Stump11289f42009-09-09 15:08:12 +00004204
Chris Lattner28fa4e62009-04-26 22:26:21 +00004205 WriteBlockInfoBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004206
Douglas Gregoreda8e122011-08-09 15:13:55 +00004207 Context = &SemaRef.Context;
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004208 PP = &SemaRef.PP;
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004209 this->WritingModule = WritingModule;
Argyrios Kyrtzidisd7c16b22012-10-31 20:59:50 +00004210 WriteASTCore(SemaRef, isysroot, OutputFile, WritingModule);
Craig Toppera13603a2014-05-22 05:54:18 +00004211 Context = nullptr;
4212 PP = nullptr;
4213 this->WritingModule = nullptr;
Richard Smith7ed1bc92014-12-05 22:42:13 +00004214 this->BaseDirectory.clear();
Craig Toppera13603a2014-05-22 05:54:18 +00004215
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004216 WritingAST = false;
Sebastian Redl143413f2010-07-12 22:02:52 +00004217}
4218
Douglas Gregora94a1542011-07-27 21:45:57 +00004219template<typename Vector>
4220static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec,
4221 ASTWriter::RecordData &Record) {
Craig Toppera13603a2014-05-22 05:54:18 +00004222 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
4223 I != E; ++I) {
Douglas Gregora94a1542011-07-27 21:45:57 +00004224 Writer.AddDeclRef(*I, Record);
4225 }
4226}
4227
Argyrios Kyrtzidisd7c16b22012-10-31 20:59:50 +00004228void ASTWriter::WriteASTCore(Sema &SemaRef,
Douglas Gregorc567ba22011-07-22 16:35:34 +00004229 StringRef isysroot,
Douglas Gregorf7a700fd2011-11-30 04:39:39 +00004230 const std::string &OutputFile,
Douglas Gregorde3ef502011-11-30 23:21:26 +00004231 Module *WritingModule) {
Sebastian Redl143413f2010-07-12 22:02:52 +00004232 using namespace llvm;
4233
Craig Toppera13603a2014-05-22 05:54:18 +00004234 bool isModule = WritingModule != nullptr;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004235
Douglas Gregorcf68c582011-12-01 22:20:10 +00004236 // Make sure that the AST reader knows to finalize itself.
4237 if (Chain)
4238 Chain->finalizeForWriting();
4239
Sebastian Redl143413f2010-07-12 22:02:52 +00004240 ASTContext &Context = SemaRef.Context;
4241 Preprocessor &PP = SemaRef.PP;
4242
Douglas Gregordab42432011-08-12 00:15:20 +00004243 // Set up predefined declaration IDs.
4244 DeclIDs[Context.getTranslationUnitDecl()] = PREDEF_DECL_TRANSLATION_UNIT_ID;
Douglas Gregor3ea72692011-08-12 05:46:01 +00004245 if (Context.ObjCIdDecl)
4246 DeclIDs[Context.ObjCIdDecl] = PREDEF_DECL_OBJC_ID_ID;
Douglas Gregor52e02802011-08-12 06:17:30 +00004247 if (Context.ObjCSelDecl)
4248 DeclIDs[Context.ObjCSelDecl] = PREDEF_DECL_OBJC_SEL_ID;
Douglas Gregor0a586182011-08-12 05:59:41 +00004249 if (Context.ObjCClassDecl)
4250 DeclIDs[Context.ObjCClassDecl] = PREDEF_DECL_OBJC_CLASS_ID;
Douglas Gregord53ae832012-01-17 18:09:05 +00004251 if (Context.ObjCProtocolClassDecl)
4252 DeclIDs[Context.ObjCProtocolClassDecl] = PREDEF_DECL_OBJC_PROTOCOL_ID;
Douglas Gregor801c99d2011-08-12 06:49:56 +00004253 if (Context.Int128Decl)
4254 DeclIDs[Context.Int128Decl] = PREDEF_DECL_INT_128_ID;
4255 if (Context.UInt128Decl)
4256 DeclIDs[Context.UInt128Decl] = PREDEF_DECL_UNSIGNED_INT_128_ID;
Douglas Gregorbab8a962011-09-08 01:46:34 +00004257 if (Context.ObjCInstanceTypeDecl)
4258 DeclIDs[Context.ObjCInstanceTypeDecl] = PREDEF_DECL_OBJC_INSTANCETYPE_ID;
Meador Inge5d3fb222012-06-16 03:34:49 +00004259 if (Context.BuiltinVaListDecl)
4260 DeclIDs[Context.getBuiltinVaListDecl()] = PREDEF_DECL_BUILTIN_VA_LIST_ID;
4261
Douglas Gregor851443c2011-08-12 01:39:19 +00004262 if (!Chain) {
4263 // Make sure that we emit IdentifierInfos (and any attached
4264 // declarations) for builtins. We don't need to do this when we're
4265 // emitting chained PCH files, because all of the builtins will be
4266 // in the original PCH file.
4267 // FIXME: Modules won't like this at all.
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004268 IdentifierTable &Table = PP.getIdentifierTable();
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004269 SmallVector<const char *, 32> BuiltinNames;
Eli Benderskye3cef2a2013-07-11 16:53:04 +00004270 if (!Context.getLangOpts().NoBuiltin) {
4271 Context.BuiltinInfo.GetBuiltinNames(BuiltinNames);
4272 }
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004273 for (unsigned I = 0, N = BuiltinNames.size(); I != N; ++I)
4274 getIdentifierRef(&Table.get(BuiltinNames[I]));
4275 }
4276
Douglas Gregor935bc7a22011-10-27 09:33:13 +00004277 // If there are any out-of-date identifiers, bring them up to date.
4278 if (ExternalPreprocessorSource *ExtSource = PP.getExternalSource()) {
Douglas Gregore68cf272013-01-07 16:56:53 +00004279 // Find out-of-date identifiers.
4280 SmallVector<IdentifierInfo *, 4> OutOfDate;
Douglas Gregor935bc7a22011-10-27 09:33:13 +00004281 for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
4282 IDEnd = PP.getIdentifierTable().end();
Douglas Gregore68cf272013-01-07 16:56:53 +00004283 ID != IDEnd; ++ID) {
Douglas Gregor935bc7a22011-10-27 09:33:13 +00004284 if (ID->second->isOutOfDate())
Douglas Gregore68cf272013-01-07 16:56:53 +00004285 OutOfDate.push_back(ID->second);
4286 }
4287
4288 // Update the out-of-date identifiers.
4289 for (unsigned I = 0, N = OutOfDate.size(); I != N; ++I) {
4290 ExtSource->updateOutOfDateIdentifier(*OutOfDate[I]);
4291 }
Douglas Gregor935bc7a22011-10-27 09:33:13 +00004292 }
4293
Richard Smithcd45dbc2014-04-19 03:48:30 +00004294 // If we saw any DeclContext updates before we started writing the AST file,
4295 // make sure all visible decls in those DeclContexts are written out.
4296 if (!UpdatedDeclContexts.empty()) {
4297 auto OldUpdatedDeclContexts = std::move(UpdatedDeclContexts);
4298 UpdatedDeclContexts.clear();
4299 for (auto *DC : OldUpdatedDeclContexts)
4300 AddUpdatedDeclContext(DC);
4301 }
4302
Chris Lattner0c797362009-09-08 18:19:27 +00004303 // Build a record containing all of the tentative definitions in this file, in
Sebastian Redl35351a92010-01-31 22:27:38 +00004304 // TentativeDefinitions order. Generally, this record will be empty for
Chris Lattner0c797362009-09-08 18:19:27 +00004305 // headers.
Douglas Gregord4df8652009-04-22 22:02:47 +00004306 RecordData TentativeDefinitions;
Douglas Gregora94a1542011-07-27 21:45:57 +00004307 AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions);
Douglas Gregoreb08bd42011-07-27 20:58:46 +00004308
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004309 // Build a record containing all of the file scoped decls in this file.
4310 RecordData UnusedFileScopedDecls;
Argyrios Kyrtzidis59852362013-03-14 04:45:00 +00004311 if (!isModule)
4312 AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls,
4313 UnusedFileScopedDecls);
Sebastian Redl08aca90252010-08-05 18:21:25 +00004314
Douglas Gregor851443c2011-08-12 01:39:19 +00004315 // Build a record containing all of the delegating constructors we still need
4316 // to resolve.
Alexis Hunt27a761d2011-05-04 23:29:54 +00004317 RecordData DelegatingCtorDecls;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004318 if (!isModule)
4319 AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004320
Douglas Gregor851443c2011-08-12 01:39:19 +00004321 // Write the set of weak, undeclared identifiers. We always write the
4322 // entire table, since later PCH files in a PCH chain are only interested in
4323 // the results at the end of the chain.
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004324 RecordData WeakUndeclaredIdentifiers;
4325 if (!SemaRef.WeakUndeclaredIdentifiers.empty()) {
Douglas Gregor1c4bfe52011-07-28 18:09:57 +00004326 for (llvm::DenseMap<IdentifierInfo*,WeakInfo>::iterator
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004327 I = SemaRef.WeakUndeclaredIdentifiers.begin(),
4328 E = SemaRef.WeakUndeclaredIdentifiers.end(); I != E; ++I) {
4329 AddIdentifierRef(I->first, WeakUndeclaredIdentifiers);
4330 AddIdentifierRef(I->second.getAlias(), WeakUndeclaredIdentifiers);
4331 AddSourceLocation(I->second.getLocation(), WeakUndeclaredIdentifiers);
4332 WeakUndeclaredIdentifiers.push_back(I->second.getUsed());
4333 }
4334 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004335
Richard Smith78165b52013-01-10 23:43:47 +00004336 // Build a record containing all of the locally-scoped extern "C"
Douglas Gregoracfc76c2009-04-22 22:18:58 +00004337 // declarations in this header file. Generally, this record will be
4338 // empty.
Richard Smith78165b52013-01-10 23:43:47 +00004339 RecordData LocallyScopedExternCDecls;
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004340 // FIXME: This is filling in the AST file in densemap order which is
Chris Lattner0c797362009-09-08 18:19:27 +00004341 // nondeterminstic!
Mike Stump11289f42009-09-09 15:08:12 +00004342 for (llvm::DenseMap<DeclarationName, NamedDecl *>::iterator
Richard Smith78165b52013-01-10 23:43:47 +00004343 TD = SemaRef.LocallyScopedExternCDecls.begin(),
4344 TDEnd = SemaRef.LocallyScopedExternCDecls.end();
Douglas Gregordc5c9582011-07-28 14:20:37 +00004345 TD != TDEnd; ++TD) {
Douglas Gregorb3722e22011-09-09 23:01:35 +00004346 if (!TD->second->isFromASTFile())
Richard Smith78165b52013-01-10 23:43:47 +00004347 AddDeclRef(TD->second, LocallyScopedExternCDecls);
Douglas Gregordc5c9582011-07-28 14:20:37 +00004348 }
4349
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004350 // Build a record containing all of the ext_vector declarations.
4351 RecordData ExtVectorDecls;
Douglas Gregorb7098a32011-07-28 00:39:29 +00004352 AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004353
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004354 // Build a record containing all of the VTable uses information.
4355 RecordData VTableUses;
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004356 if (!SemaRef.VTableUses.empty()) {
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004357 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
4358 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
4359 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
4360 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
4361 }
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004362 }
4363
Nico Weber72889432014-09-06 01:25:55 +00004364 // Build a record containing all of the UnusedLocalTypedefNameCandidates.
4365 RecordData UnusedLocalTypedefNameCandidates;
4366 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
4367 AddDeclRef(TD, UnusedLocalTypedefNameCandidates);
4368
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004369 // Build a record containing all of dynamic classes declarations.
4370 RecordData DynamicClasses;
Douglas Gregor32002192011-07-28 00:53:40 +00004371 AddLazyVectorDecls(*this, SemaRef.DynamicClasses, DynamicClasses);
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004372
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004373 // Build a record containing all of pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004374 RecordData PendingInstantiations;
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004375 for (std::deque<Sema::PendingImplicitInstantiation>::iterator
Chandler Carruth54080172010-08-25 08:44:16 +00004376 I = SemaRef.PendingInstantiations.begin(),
4377 N = SemaRef.PendingInstantiations.end(); I != N; ++I) {
4378 AddDeclRef(I->first, PendingInstantiations);
4379 AddSourceLocation(I->second, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004380 }
4381 assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
4382 "There are local ones at end of translation unit!");
4383
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004384 // Build a record containing some declaration references.
4385 RecordData SemaDeclRefs;
4386 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc) {
4387 AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
4388 AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
4389 }
4390
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004391 RecordData CUDASpecialDeclRefs;
4392 if (Context.getcudaConfigureCallDecl()) {
4393 AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs);
4394 }
4395
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004396 // Build a record containing all of the known namespaces.
4397 RecordData KnownNamespaces;
Nick Lewycky8334af82013-01-26 00:35:08 +00004398 for (llvm::MapVector<NamespaceDecl*, bool>::iterator
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004399 I = SemaRef.KnownNamespaces.begin(),
4400 IEnd = SemaRef.KnownNamespaces.end();
4401 I != IEnd; ++I) {
4402 if (!I->second)
4403 AddDeclRef(I->first, KnownNamespaces);
4404 }
Douglas Gregor112b9072012-10-18 05:31:06 +00004405
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004406 // Build a record of all used, undefined objects that require definitions.
4407 RecordData UndefinedButUsed;
Nick Lewyckyf0f56162013-01-31 03:23:57 +00004408
4409 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004410 SemaRef.getUndefinedButUsed(Undefined);
Nick Lewyckyf0f56162013-01-31 03:23:57 +00004411 for (SmallVectorImpl<std::pair<NamedDecl *, SourceLocation> >::iterator
4412 I = Undefined.begin(), E = Undefined.end(); I != E; ++I) {
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004413 AddDeclRef(I->first, UndefinedButUsed);
4414 AddSourceLocation(I->second, UndefinedButUsed);
Nick Lewycky8334af82013-01-26 00:35:08 +00004415 }
4416
Douglas Gregor112b9072012-10-18 05:31:06 +00004417 // Write the control block
Douglas Gregor2d302362012-10-24 16:50:34 +00004418 WriteControlBlock(PP, Context, isysroot, OutputFile);
Douglas Gregor112b9072012-10-18 05:31:06 +00004419
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004420 // Write the remaining AST contents.
Douglas Gregor652d82a2009-04-18 05:55:16 +00004421 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00004422 Stream.EnterSubblock(AST_BLOCK_ID, 5);
Douglas Gregor851443c2011-08-12 01:39:19 +00004423
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004424 // This is so that older clang versions, before the introduction
4425 // of the control block, can read and reject the newer PCH format.
4426 Record.clear();
4427 Record.push_back(VERSION_MAJOR);
4428 Stream.EmitRecord(METADATA_OLD_FORMAT, Record);
4429
Douglas Gregor851443c2011-08-12 01:39:19 +00004430 // Create a lexical update block containing all of the declarations in the
4431 // translation unit that do not come from other AST files.
4432 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
4433 SmallVector<KindDeclIDPair, 64> NewGlobalDecls;
Aaron Ballman629afae2014-03-07 19:56:05 +00004434 for (const auto *I : TU->noload_decls()) {
4435 if (!I->isFromASTFile())
4436 NewGlobalDecls.push_back(std::make_pair(I->getKind(), GetDeclRef(I)));
Douglas Gregor851443c2011-08-12 01:39:19 +00004437 }
4438
4439 llvm::BitCodeAbbrev *Abv = new llvm::BitCodeAbbrev();
4440 Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
4441 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4442 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(Abv);
4443 Record.clear();
4444 Record.push_back(TU_UPDATE_LEXICAL);
4445 Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
4446 data(NewGlobalDecls));
4447
4448 // And a visible updates block for the translation unit.
4449 Abv = new llvm::BitCodeAbbrev();
4450 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
4451 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4452 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed, 32));
4453 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4454 UpdateVisibleAbbrev = Stream.EmitAbbrev(Abv);
4455 WriteDeclContextVisibleUpdate(TU);
4456
4457 // If the translation unit has an anonymous namespace, and we don't already
4458 // have an update block for it, write it as an update block.
Richard Smith6ef42932014-03-20 21:02:00 +00004459 // FIXME: Why do we not do this if there's already an update block?
Douglas Gregor851443c2011-08-12 01:39:19 +00004460 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
4461 ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
Richard Smith6ef42932014-03-20 21:02:00 +00004462 if (Record.empty())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004463 Record.push_back(DeclUpdate(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE, NS));
Douglas Gregor851443c2011-08-12 01:39:19 +00004464 }
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004465
Richard Smith5652c0f2014-03-21 01:48:23 +00004466 // Add update records for all mangling numbers and static local numbers.
4467 // These aren't really update records, but this is a convenient way of
4468 // tagging this rare extra data onto the declarations.
4469 for (const auto &Number : Context.MangleNumbers)
4470 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004471 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_MANGLING_NUMBER,
4472 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004473 for (const auto &Number : Context.StaticLocalNumbers)
4474 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004475 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_STATIC_LOCAL_NUMBER,
4476 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004477
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004478 // Make sure visible decls, added to DeclContexts previously loaded from
4479 // an AST file, are registered for serialization.
Craig Topper2341c0d2013-07-04 03:08:24 +00004480 for (SmallVectorImpl<const Decl *>::iterator
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004481 I = UpdatingVisibleDecls.begin(),
4482 E = UpdatingVisibleDecls.end(); I != E; ++I) {
4483 GetDeclRef(*I);
4484 }
4485
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004486 // Make sure all decls associated with an identifier are registered for
4487 // serialization.
4488 for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
4489 IDEnd = PP.getIdentifierTable().end();
4490 ID != IDEnd; ++ID) {
4491 const IdentifierInfo *II = ID->second;
4492 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization()) {
4493 for (IdentifierResolver::iterator D = SemaRef.IdResolver.begin(II),
4494 DEnd = SemaRef.IdResolver.end();
4495 D != DEnd; ++D) {
4496 GetDeclRef(*D);
4497 }
4498 }
4499 }
4500
Douglas Gregor5204bde2011-08-02 16:26:37 +00004501 // Form the record of special types.
4502 RecordData SpecialTypes;
Douglas Gregor5204bde2011-08-02 16:26:37 +00004503 AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004504 AddTypeRef(Context.getFILEType(), SpecialTypes);
4505 AddTypeRef(Context.getjmp_bufType(), SpecialTypes);
4506 AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes);
4507 AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes);
4508 AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004509 AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes);
Rafael Espindola6cfa82b2011-11-13 21:51:09 +00004510 AddTypeRef(Context.getucontext_tType(), SpecialTypes);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004511
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004512 if (Chain) {
4513 // Write the mapping information describing our module dependencies and how
4514 // each of those modules were mapped into our own offset/ID space, so that
4515 // the reader can build the appropriate mapping to its own offset/ID space.
4516 // The map consists solely of a blob with the following format:
4517 // *(module-name-len:i16 module-name:len*i8
4518 // source-location-offset:i32
4519 // identifier-id:i32
4520 // preprocessed-entity-id:i32
4521 // macro-definition-id:i32
Douglas Gregor253eefe2011-12-01 00:59:36 +00004522 // submodule-id:i32
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004523 // selector-id:i32
4524 // declaration-id:i32
4525 // c++-base-specifiers-id:i32
4526 // type-id:i32)
4527 //
4528 llvm::BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
4529 Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
4530 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
4531 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(Abbrev);
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004532 SmallString<2048> Buffer;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004533 {
4534 llvm::raw_svector_ostream Out(Buffer);
Ben Langmuir785180e2014-10-20 16:27:30 +00004535 for (ModuleFile *M : Chain->ModuleMgr) {
Justin Bognere1c147c2014-03-28 22:03:19 +00004536 using namespace llvm::support;
4537 endian::Writer<little> LE(Out);
Ben Langmuir785180e2014-10-20 16:27:30 +00004538 StringRef FileName = M->FileName;
Justin Bognere1c147c2014-03-28 22:03:19 +00004539 LE.write<uint16_t>(FileName.size());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004540 Out.write(FileName.data(), FileName.size());
Ben Langmuirfe971d92014-08-16 04:54:18 +00004541
Ben Langmuir785180e2014-10-20 16:27:30 +00004542 // Note: if a base ID was uint max, it would not be possible to load
4543 // another module after it or have more than one entity inside it.
4544 uint32_t None = std::numeric_limits<uint32_t>::max();
4545
4546 auto writeBaseIDOrNone = [&](uint32_t BaseID, bool ShouldWrite) {
4547 assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
4548 if (ShouldWrite)
4549 LE.write<uint32_t>(BaseID);
4550 else
4551 LE.write<uint32_t>(None);
4552 };
4553
Ben Langmuirfe971d92014-08-16 04:54:18 +00004554 // These values should be unique within a chain, since they will be read
4555 // as keys into ContinuousRangeMaps.
Ben Langmuir785180e2014-10-20 16:27:30 +00004556 writeBaseIDOrNone(M->SLocEntryBaseOffset, M->LocalNumSLocEntries);
4557 writeBaseIDOrNone(M->BaseIdentifierID, M->LocalNumIdentifiers);
4558 writeBaseIDOrNone(M->BaseMacroID, M->LocalNumMacros);
4559 writeBaseIDOrNone(M->BasePreprocessedEntityID,
4560 M->NumPreprocessedEntities);
4561 writeBaseIDOrNone(M->BaseSubmoduleID, M->LocalNumSubmodules);
4562 writeBaseIDOrNone(M->BaseSelectorID, M->LocalNumSelectors);
4563 writeBaseIDOrNone(M->BaseDeclID, M->LocalNumDecls);
4564 writeBaseIDOrNone(M->BaseTypeIndex, M->LocalNumTypes);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004565 }
4566 }
4567 Record.clear();
4568 Record.push_back(MODULE_OFFSET_MAP);
4569 Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
4570 Buffer.data(), Buffer.size());
4571 }
Richard Smithb9eab6d2014-03-20 19:44:17 +00004572
Richard Smithb9eab6d2014-03-20 19:44:17 +00004573 RecordData DeclUpdatesOffsetsRecord;
4574
Richard Smith59442b42014-03-20 20:07:19 +00004575 // Keep writing types, declarations, and declaration update records
4576 // until we've emitted all of them.
Richard Smith01b2cb42014-07-26 06:37:51 +00004577 Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/5);
4578 WriteTypeAbbrevs();
4579 WriteDeclAbbrevs();
Richard Smithb9eab6d2014-03-20 19:44:17 +00004580 for (DeclsToRewriteTy::iterator I = DeclsToRewrite.begin(),
4581 E = DeclsToRewrite.end();
4582 I != E; ++I)
4583 DeclTypesToEmit.push(const_cast<Decl*>(*I));
Richard Smith59442b42014-03-20 20:07:19 +00004584 do {
4585 WriteDeclUpdatesBlocks(DeclUpdatesOffsetsRecord);
4586 while (!DeclTypesToEmit.empty()) {
4587 DeclOrType DOT = DeclTypesToEmit.front();
4588 DeclTypesToEmit.pop();
4589 if (DOT.isType())
4590 WriteType(DOT.getType());
4591 else
4592 WriteDecl(Context, DOT.getDecl());
4593 }
4594 } while (!DeclUpdates.empty());
Richard Smithb9eab6d2014-03-20 19:44:17 +00004595 Stream.ExitBlock();
4596
Richard Smithb9eab6d2014-03-20 19:44:17 +00004597 DoneWritingDeclsAndTypes = true;
4598
4599 // These things can only be done once we've written out decls and types.
4600 WriteTypeDeclOffsets();
Richard Smith5652c0f2014-03-21 01:48:23 +00004601 if (!DeclUpdatesOffsetsRecord.empty())
4602 Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord);
Richard Smithb9eab6d2014-03-20 19:44:17 +00004603 WriteCXXBaseSpecifiersOffsets();
4604 WriteFileDeclIDsMap();
Richard Smith7ed1bc92014-12-05 22:42:13 +00004605 WriteSourceManagerBlock(Context.getSourceManager(), PP);
Richard Smithb9eab6d2014-03-20 19:44:17 +00004606
4607 WriteComments();
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004608 WritePreprocessor(PP, isModule);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004609 WriteHeaderSearch(PP.getHeaderSearchInfo());
Sebastian Redla19a67f2010-08-03 21:58:15 +00004610 WriteSelectors(SemaRef);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00004611 WriteReferencedSelectorsPool(SemaRef);
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004612 WriteIdentifierTable(PP, SemaRef.IdResolver, isModule);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004613 WriteFPPragmaOptions(SemaRef.getFPOptions());
4614 WriteOpenCLExtensions(SemaRef);
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00004615 WritePragmaDiagnosticMappings(Context.getDiagnostics(), isModule);
Douglas Gregor652d82a2009-04-18 05:55:16 +00004616
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004617 // If we're emitting a module, write out the submodule information.
4618 if (WritingModule)
4619 WriteSubmodules(WritingModule);
4620
Douglas Gregor5204bde2011-08-02 16:26:37 +00004621 Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
4622
Douglas Gregord4df8652009-04-22 22:02:47 +00004623 // Write the record containing external, unnamed definitions.
Ben Langmuir332aafe2014-01-31 01:06:56 +00004624 if (!EagerlyDeserializedDecls.empty())
4625 Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls);
Douglas Gregord4df8652009-04-22 22:02:47 +00004626
4627 // Write the record containing tentative definitions.
4628 if (!TentativeDefinitions.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004629 Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
Douglas Gregoracfc76c2009-04-22 22:18:58 +00004630
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004631 // Write the record containing unused file scoped decls.
4632 if (!UnusedFileScopedDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004633 Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004634
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004635 // Write the record containing weak undeclared identifiers.
4636 if (!WeakUndeclaredIdentifiers.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004637 Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004638 WeakUndeclaredIdentifiers);
4639
Richard Smith78165b52013-01-10 23:43:47 +00004640 // Write the record containing locally-scoped extern "C" definitions.
4641 if (!LocallyScopedExternCDecls.empty())
4642 Stream.EmitRecord(LOCALLY_SCOPED_EXTERN_C_DECLS,
4643 LocallyScopedExternCDecls);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004644
4645 // Write the record containing ext_vector type names.
4646 if (!ExtVectorDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004647 Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
Mike Stump11289f42009-09-09 15:08:12 +00004648
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004649 // Write the record containing VTable uses information.
4650 if (!VTableUses.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004651 Stream.EmitRecord(VTABLE_USES, VTableUses);
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004652
4653 // Write the record containing dynamic classes declarations.
4654 if (!DynamicClasses.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004655 Stream.EmitRecord(DYNAMIC_CLASSES, DynamicClasses);
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004656
Nico Weber72889432014-09-06 01:25:55 +00004657 // Write the record containing potentially unused local typedefs.
4658 if (!UnusedLocalTypedefNameCandidates.empty())
4659 Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
4660 UnusedLocalTypedefNameCandidates);
4661
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004662 // Write the record containing pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004663 if (!PendingInstantiations.empty())
4664 Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004665
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004666 // Write the record containing declaration references of Sema.
4667 if (!SemaDeclRefs.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004668 Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004669
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004670 // Write the record containing CUDA-specific declaration references.
4671 if (!CUDASpecialDeclRefs.empty())
4672 Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004673
4674 // Write the delegating constructors.
4675 if (!DelegatingCtorDecls.empty())
4676 Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004677
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004678 // Write the known namespaces.
4679 if (!KnownNamespaces.empty())
4680 Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
Nick Lewycky8334af82013-01-26 00:35:08 +00004681
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004682 // Write the undefined internal functions and variables, and inline functions.
4683 if (!UndefinedButUsed.empty())
4684 Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004685
Douglas Gregor851443c2011-08-12 01:39:19 +00004686 // Write the visible updates to DeclContexts.
Richard Smithcd45dbc2014-04-19 03:48:30 +00004687 for (auto *DC : UpdatedDeclContexts)
4688 WriteDeclContextVisibleUpdate(DC);
Douglas Gregor851443c2011-08-12 01:39:19 +00004689
Douglas Gregor959bb062011-12-03 01:15:29 +00004690 if (!WritingModule) {
4691 // Write the submodules that were imported, if any.
Aaron Ballman4f45b712014-03-21 15:22:56 +00004692 struct ModuleInfo {
4693 uint64_t ID;
4694 Module *M;
4695 ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
4696 };
Richard Smith56be7542014-03-21 00:33:59 +00004697 llvm::SmallVector<ModuleInfo, 64> Imports;
Aaron Ballmanbbc31212014-03-14 20:59:21 +00004698 for (const auto *I : Context.local_imports()) {
Douglas Gregor959bb062011-12-03 01:15:29 +00004699 assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end());
Aaron Ballman4f45b712014-03-21 15:22:56 +00004700 Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()],
4701 I->getImportedModule()));
Douglas Gregor959bb062011-12-03 01:15:29 +00004702 }
Richard Smith56be7542014-03-21 00:33:59 +00004703
4704 if (!Imports.empty()) {
4705 auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
4706 return A.ID < B.ID;
4707 };
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00004708 auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
4709 return A.ID == B.ID;
4710 };
Richard Smith56be7542014-03-21 00:33:59 +00004711
4712 // Sort and deduplicate module IDs.
4713 std::sort(Imports.begin(), Imports.end(), Cmp);
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00004714 Imports.erase(std::unique(Imports.begin(), Imports.end(), Eq),
Richard Smith56be7542014-03-21 00:33:59 +00004715 Imports.end());
4716
4717 RecordData ImportedModules;
4718 for (const auto &Import : Imports) {
4719 ImportedModules.push_back(Import.ID);
4720 // FIXME: If the module has macros imported then later has declarations
4721 // imported, this location won't be the right one as a location for the
4722 // declaration imports.
4723 AddSourceLocation(Import.M->MacroVisibilityLoc, ImportedModules);
4724 }
4725
Douglas Gregor959bb062011-12-03 01:15:29 +00004726 Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
4727 }
Douglas Gregor0a839132011-12-03 00:59:55 +00004728 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004729
Douglas Gregor851443c2011-08-12 01:39:19 +00004730 WriteDeclReplacementsBlock();
Douglas Gregor358cd442012-01-15 16:58:34 +00004731 WriteRedeclarations();
Douglas Gregor6168bd22013-02-18 15:53:43 +00004732 WriteMergedDecls();
Douglas Gregor404cdde2012-01-27 01:47:08 +00004733 WriteObjCCategories();
Richard Smithe40f2ba2013-08-07 21:41:30 +00004734 WriteLateParsedTemplates(SemaRef);
Dario Domizioli13a0a382014-05-23 12:13:25 +00004735 if(!WritingModule)
4736 WriteOptimizePragmaOptions(SemaRef);
Richard Smithe40f2ba2013-08-07 21:41:30 +00004737
Douglas Gregor08f01292009-04-17 22:13:46 +00004738 // Some simple statistics
Douglas Gregor652d82a2009-04-18 05:55:16 +00004739 Record.clear();
Douglas Gregor08f01292009-04-17 22:13:46 +00004740 Record.push_back(NumStatements);
Douglas Gregorc3366a52009-04-21 23:56:24 +00004741 Record.push_back(NumMacros);
Douglas Gregora57c3ab2009-04-22 22:34:57 +00004742 Record.push_back(NumLexicalDeclContexts);
4743 Record.push_back(NumVisibleDeclContexts);
Sebastian Redl539c5062010-08-18 23:57:32 +00004744 Stream.EmitRecord(STATISTICS, Record);
Douglas Gregor8f45df52009-04-16 22:23:12 +00004745 Stream.ExitBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004746}
4747
Richard Smithb9eab6d2014-03-20 19:44:17 +00004748void ASTWriter::WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord) {
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004749 if (DeclUpdates.empty())
4750 return;
4751
Richard Smith59442b42014-03-20 20:07:19 +00004752 DeclUpdateMap LocalUpdates;
4753 LocalUpdates.swap(DeclUpdates);
4754
Richard Smith6ef42932014-03-20 21:02:00 +00004755 for (auto &DeclUpdate : LocalUpdates) {
4756 const Decl *D = DeclUpdate.first;
Argyrios Kyrtzidisb97a4022011-11-12 21:07:46 +00004757 if (isRewritten(D))
Argyrios Kyrtzidis3ba70b82010-10-24 17:26:46 +00004758 continue; // The decl will be written completely,no need to store updates.
4759
Richard Smithd28ac5b2014-03-22 23:33:22 +00004760 bool HasUpdatedBody = false;
Richard Smith6ef42932014-03-20 21:02:00 +00004761 RecordData Record;
4762 for (auto &Update : DeclUpdate.second) {
4763 DeclUpdateKind Kind = (DeclUpdateKind)Update.getKind();
4764
4765 Record.push_back(Kind);
4766 switch (Kind) {
4767 case UPD_CXX_ADDED_IMPLICIT_MEMBER:
4768 case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION:
4769 case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE:
Richard Smithcd45dbc2014-04-19 03:48:30 +00004770 assert(Update.getDecl() && "no decl to add?");
Richard Smith6ef42932014-03-20 21:02:00 +00004771 Record.push_back(GetDeclRef(Update.getDecl()));
4772 break;
4773
Richard Smith4d235792014-08-07 18:53:08 +00004774 case UPD_CXX_ADDED_FUNCTION_DEFINITION:
Richard Smithd28ac5b2014-03-22 23:33:22 +00004775 // An updated body is emitted last, so that the reader doesn't need
4776 // to skip over the lazy body to reach statements for other records.
4777 Record.pop_back();
4778 HasUpdatedBody = true;
4779 break;
4780
Richard Smith4d235792014-08-07 18:53:08 +00004781 case UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER:
4782 AddSourceLocation(Update.getLoc(), Record);
4783 break;
4784
Richard Smithcd45dbc2014-04-19 03:48:30 +00004785 case UPD_CXX_INSTANTIATED_CLASS_DEFINITION: {
4786 auto *RD = cast<CXXRecordDecl>(D);
4787 AddUpdatedDeclContext(RD->getPrimaryContext());
4788 AddCXXDefinitionData(RD, Record);
4789 Record.push_back(WriteDeclContextLexicalBlock(
4790 *Context, const_cast<CXXRecordDecl *>(RD)));
4791
4792 // This state is sometimes updated by template instantiation, when we
4793 // switch from the specialization referring to the template declaration
4794 // to it referring to the template definition.
4795 if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
4796 Record.push_back(MSInfo->getTemplateSpecializationKind());
4797 AddSourceLocation(MSInfo->getPointOfInstantiation(), Record);
4798 } else {
4799 auto *Spec = cast<ClassTemplateSpecializationDecl>(RD);
4800 Record.push_back(Spec->getTemplateSpecializationKind());
4801 AddSourceLocation(Spec->getPointOfInstantiation(), Record);
Richard Smithdf352052014-05-22 20:59:29 +00004802
4803 // The instantiation might have been resolved to a partial
4804 // specialization. If so, record which one.
4805 auto From = Spec->getInstantiatedFrom();
4806 if (auto PartialSpec =
4807 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
4808 Record.push_back(true);
4809 AddDeclRef(PartialSpec, Record);
4810 AddTemplateArgumentList(&Spec->getTemplateInstantiationArgs(),
4811 Record);
4812 } else {
4813 Record.push_back(false);
4814 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00004815 }
4816 Record.push_back(RD->getTagKind());
4817 AddSourceLocation(RD->getLocation(), Record);
4818 AddSourceLocation(RD->getLocStart(), Record);
4819 AddSourceLocation(RD->getRBraceLoc(), Record);
4820
4821 // Instantiation may change attributes; write them all out afresh.
4822 Record.push_back(D->hasAttrs());
4823 if (Record.back())
Craig Topper8c2a2a02014-08-30 16:55:39 +00004824 WriteAttributes(llvm::makeArrayRef(D->getAttrs().begin(),
4825 D->getAttrs().size()), Record);
Richard Smithcd45dbc2014-04-19 03:48:30 +00004826
4827 // FIXME: Ensure we don't get here for explicit instantiations.
4828 break;
4829 }
4830
Richard Smith564417a2014-03-20 21:47:22 +00004831 case UPD_CXX_RESOLVED_EXCEPTION_SPEC:
4832 addExceptionSpec(
4833 *this,
4834 cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>(),
4835 Record);
4836 break;
4837
Richard Smith6ef42932014-03-20 21:02:00 +00004838 case UPD_CXX_DEDUCED_RETURN_TYPE:
4839 Record.push_back(GetOrCreateTypeID(Update.getType()));
4840 break;
4841
4842 case UPD_DECL_MARKED_USED:
4843 break;
Richard Smith5652c0f2014-03-21 01:48:23 +00004844
4845 case UPD_MANGLING_NUMBER:
4846 case UPD_STATIC_LOCAL_NUMBER:
4847 Record.push_back(Update.getNumber());
4848 break;
Alexey Bataev97720002014-11-11 04:05:39 +00004849 case UPD_DECL_MARKED_OPENMP_THREADPRIVATE:
4850 AddSourceRange(D->getAttr<OMPThreadPrivateDeclAttr>()->getRange(),
4851 Record);
4852 break;
Richard Smith6ef42932014-03-20 21:02:00 +00004853 }
4854 }
4855
Richard Smithd28ac5b2014-03-22 23:33:22 +00004856 if (HasUpdatedBody) {
4857 const FunctionDecl *Def = cast<FunctionDecl>(D);
Richard Smith4d235792014-08-07 18:53:08 +00004858 Record.push_back(UPD_CXX_ADDED_FUNCTION_DEFINITION);
Richard Smithd28ac5b2014-03-22 23:33:22 +00004859 Record.push_back(Def->isInlined());
4860 AddSourceLocation(Def->getInnerLocStart(), Record);
4861 AddFunctionDefinition(Def, Record);
Richard Smith4d235792014-08-07 18:53:08 +00004862 if (auto *DD = dyn_cast<CXXDestructorDecl>(Def))
4863 Record.push_back(GetDeclRef(DD->getOperatorDelete()));
Richard Smithd28ac5b2014-03-22 23:33:22 +00004864 }
4865
Richard Smithcd45dbc2014-04-19 03:48:30 +00004866 OffsetsRecord.push_back(GetDeclRef(D));
4867 OffsetsRecord.push_back(Stream.GetCurrentBitNo());
4868
Richard Smith6ef42932014-03-20 21:02:00 +00004869 Stream.EmitRecord(DECL_UPDATES, Record);
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004870
Richard Smithb9eab6d2014-03-20 19:44:17 +00004871 // Flush any statements that were written as part of this update record.
4872 FlushStmts();
Richard Smithcd45dbc2014-04-19 03:48:30 +00004873
4874 // Flush C++ base specifiers, if there are any.
4875 FlushCXXBaseSpecifiers();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004876 }
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004877}
4878
Argyrios Kyrtzidis97bfda92010-10-24 17:26:43 +00004879void ASTWriter::WriteDeclReplacementsBlock() {
Sebastian Redle7c1fe62010-08-13 00:28:03 +00004880 if (ReplacedDecls.empty())
4881 return;
4882
4883 RecordData Record;
Craig Topper2341c0d2013-07-04 03:08:24 +00004884 for (SmallVectorImpl<ReplacedDeclInfo>::iterator
4885 I = ReplacedDecls.begin(), E = ReplacedDecls.end(); I != E; ++I) {
Argyrios Kyrtzidis6fb60032011-10-31 07:20:15 +00004886 Record.push_back(I->ID);
4887 Record.push_back(I->Offset);
4888 Record.push_back(I->Loc);
Sebastian Redle7c1fe62010-08-13 00:28:03 +00004889 }
Sebastian Redl539c5062010-08-18 23:57:32 +00004890 Stream.EmitRecord(DECL_REPLACEMENTS, Record);
Sebastian Redle7c1fe62010-08-13 00:28:03 +00004891}
4892
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004893void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004894 Record.push_back(Loc.getRawEncoding());
4895}
4896
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004897void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00004898 AddSourceLocation(Range.getBegin(), Record);
4899 AddSourceLocation(Range.getEnd(), Record);
4900}
4901
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004902void ASTWriter::AddAPInt(const llvm::APInt &Value, RecordDataImpl &Record) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004903 Record.push_back(Value.getBitWidth());
Benjamin Kramer25f9ea62010-09-06 23:43:28 +00004904 const uint64_t *Words = Value.getRawData();
4905 Record.append(Words, Words + Value.getNumWords());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004906}
4907
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004908void ASTWriter::AddAPSInt(const llvm::APSInt &Value, RecordDataImpl &Record) {
Douglas Gregor1daeb692009-04-13 18:14:40 +00004909 Record.push_back(Value.isUnsigned());
4910 AddAPInt(Value, Record);
4911}
4912
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004913void ASTWriter::AddAPFloat(const llvm::APFloat &Value, RecordDataImpl &Record) {
Douglas Gregore0a3a512009-04-14 21:55:33 +00004914 AddAPInt(Value.bitcastToAPInt(), Record);
4915}
4916
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004917void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004918 Record.push_back(getIdentifierRef(II));
4919}
4920
Sebastian Redl539c5062010-08-18 23:57:32 +00004921IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
Craig Toppera13603a2014-05-22 05:54:18 +00004922 if (!II)
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004923 return 0;
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00004924
Sebastian Redl539c5062010-08-18 23:57:32 +00004925 IdentID &ID = IdentifierIDs[II];
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00004926 if (ID == 0)
Sebastian Redlff4a2952010-07-23 23:49:55 +00004927 ID = NextIdentID++;
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004928 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004929}
4930
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004931MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004932 // Don't emit builtin macros like __LINE__ to the AST file unless they
4933 // have been redefined by the header (in which case they are not
4934 // isBuiltinMacro).
Craig Toppera13603a2014-05-22 05:54:18 +00004935 if (!MI || MI->isBuiltinMacro())
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004936 return 0;
4937
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004938 MacroID &ID = MacroIDs[MI];
4939 if (ID == 0) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004940 ID = NextMacroID++;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004941 MacroInfoToEmitData Info = { Name, MI, ID };
4942 MacroInfosToEmit.push_back(Info);
4943 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004944 return ID;
4945}
4946
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004947MacroID ASTWriter::getMacroID(MacroInfo *MI) {
Craig Toppera13603a2014-05-22 05:54:18 +00004948 if (!MI || MI->isBuiltinMacro())
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004949 return 0;
4950
4951 assert(MacroIDs.find(MI) != MacroIDs.end() && "Macro not emitted!");
4952 return MacroIDs[MI];
4953}
4954
4955uint64_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) {
4956 assert(IdentMacroDirectivesOffsetMap[Name] && "not set!");
4957 return IdentMacroDirectivesOffsetMap[Name];
4958}
4959
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004960void ASTWriter::AddSelectorRef(const Selector SelRef, RecordDataImpl &Record) {
Sebastian Redl834bb972010-08-04 17:20:04 +00004961 Record.push_back(getSelectorRef(SelRef));
4962}
4963
Sebastian Redl539c5062010-08-18 23:57:32 +00004964SelectorID ASTWriter::getSelectorRef(Selector Sel) {
Craig Toppera13603a2014-05-22 05:54:18 +00004965 if (Sel.getAsOpaquePtr() == nullptr) {
Sebastian Redl834bb972010-08-04 17:20:04 +00004966 return 0;
Steve Naroff2ddea052009-04-23 10:39:46 +00004967 }
4968
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004969 SelectorID SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00004970 if (SID == 0 && Chain) {
4971 // This might trigger a ReadSelector callback, which will set the ID for
4972 // this selector.
4973 Chain->LoadSelector(Sel);
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004974 SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00004975 }
Steve Naroff2ddea052009-04-23 10:39:46 +00004976 if (SID == 0) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00004977 SID = NextSelectorID++;
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004978 SelectorIDs[Sel] = SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00004979 }
Sebastian Redl834bb972010-08-04 17:20:04 +00004980 return SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00004981}
4982
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004983void ASTWriter::AddCXXTemporary(const CXXTemporary *Temp, RecordDataImpl &Record) {
Chris Lattnercba86142010-05-10 00:25:06 +00004984 AddDeclRef(Temp->getDestructor(), Record);
4985}
4986
Douglas Gregord4c5ed02010-10-29 22:39:52 +00004987void ASTWriter::AddCXXBaseSpecifiersRef(CXXBaseSpecifier const *Bases,
4988 CXXBaseSpecifier const *BasesEnd,
4989 RecordDataImpl &Record) {
4990 assert(Bases != BasesEnd && "Empty base-specifier sets are not recorded");
4991 CXXBaseSpecifiersToWrite.push_back(
4992 QueuedCXXBaseSpecifiers(NextCXXBaseSpecifiersID,
4993 Bases, BasesEnd));
4994 Record.push_back(NextCXXBaseSpecifiersID++);
4995}
4996
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004997void ASTWriter::AddTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind,
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004998 const TemplateArgumentLocInfo &Arg,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004999 RecordDataImpl &Record) {
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005000 switch (Kind) {
John McCall0ad16662009-10-29 08:12:44 +00005001 case TemplateArgument::Expression:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005002 AddStmt(Arg.getAsExpr());
John McCall0ad16662009-10-29 08:12:44 +00005003 break;
5004 case TemplateArgument::Type:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005005 AddTypeSourceInfo(Arg.getAsTypeSourceInfo(), Record);
John McCall0ad16662009-10-29 08:12:44 +00005006 break;
Douglas Gregor9167f8b2009-11-11 01:00:40 +00005007 case TemplateArgument::Template:
Douglas Gregor9d802122011-03-02 17:09:35 +00005008 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc(), Record);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00005009 AddSourceLocation(Arg.getTemplateNameLoc(), Record);
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005010 break;
5011 case TemplateArgument::TemplateExpansion:
Douglas Gregor9d802122011-03-02 17:09:35 +00005012 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc(), Record);
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005013 AddSourceLocation(Arg.getTemplateNameLoc(), Record);
Douglas Gregoreb29d182011-01-05 17:40:24 +00005014 AddSourceLocation(Arg.getTemplateEllipsisLoc(), Record);
Douglas Gregor9167f8b2009-11-11 01:00:40 +00005015 break;
John McCall0ad16662009-10-29 08:12:44 +00005016 case TemplateArgument::Null:
5017 case TemplateArgument::Integral:
5018 case TemplateArgument::Declaration:
Eli Friedmanb826a002012-09-26 02:36:12 +00005019 case TemplateArgument::NullPtr:
John McCall0ad16662009-10-29 08:12:44 +00005020 case TemplateArgument::Pack:
Eli Friedmanb826a002012-09-26 02:36:12 +00005021 // FIXME: Is this right?
John McCall0ad16662009-10-29 08:12:44 +00005022 break;
5023 }
5024}
5025
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005026void ASTWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005027 RecordDataImpl &Record) {
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005028 AddTemplateArgument(Arg.getArgument(), Record);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00005029
5030 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
5031 bool InfoHasSameExpr
5032 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
5033 Record.push_back(InfoHasSameExpr);
5034 if (InfoHasSameExpr)
5035 return; // Avoid storing the same expr twice.
5036 }
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005037 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo(),
5038 Record);
5039}
5040
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005041void ASTWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo,
5042 RecordDataImpl &Record) {
Craig Toppera13603a2014-05-22 05:54:18 +00005043 if (!TInfo) {
John McCall8f115c62009-10-16 21:56:05 +00005044 AddTypeRef(QualType(), Record);
5045 return;
5046 }
5047
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005048 AddTypeLoc(TInfo->getTypeLoc(), Record);
5049}
5050
5051void ASTWriter::AddTypeLoc(TypeLoc TL, RecordDataImpl &Record) {
5052 AddTypeRef(TL.getType(), Record);
5053
John McCall8f115c62009-10-16 21:56:05 +00005054 TypeLocWriter TLW(*this, Record);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005055 for (; !TL.isNull(); TL = TL.getNextTypeLoc())
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00005056 TLW.Visit(TL);
John McCall8f115c62009-10-16 21:56:05 +00005057}
5058
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005059void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
Argyrios Kyrtzidis9ab44ea2010-08-20 16:04:14 +00005060 Record.push_back(GetOrCreateTypeID(T));
5061}
5062
Douglas Gregoreda8e122011-08-09 15:13:55 +00005063TypeID ASTWriter::GetOrCreateTypeID( QualType T) {
Richard Smith1fa5d642013-05-11 05:45:24 +00005064 assert(Context);
Douglas Gregoreda8e122011-08-09 15:13:55 +00005065 return MakeTypeID(*Context, T,
Argyrios Kyrtzidis082e4612010-08-20 16:04:20 +00005066 std::bind1st(std::mem_fun(&ASTWriter::GetOrCreateTypeIdx), this));
5067}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005068
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00005069TypeID ASTWriter::getTypeID(QualType T) const {
Richard Smith1fa5d642013-05-11 05:45:24 +00005070 assert(Context);
Douglas Gregoreda8e122011-08-09 15:13:55 +00005071 return MakeTypeID(*Context, T,
Argyrios Kyrtzidis082e4612010-08-20 16:04:20 +00005072 std::bind1st(std::mem_fun(&ASTWriter::getTypeIdx), this));
Argyrios Kyrtzidise394f2c2010-08-20 16:04:09 +00005073}
5074
5075TypeIdx ASTWriter::GetOrCreateTypeIdx(QualType T) {
5076 if (T.isNull())
5077 return TypeIdx();
5078 assert(!T.getLocalFastQualifiers());
5079
Argyrios Kyrtzidisa7fbbb02010-08-20 16:04:04 +00005080 TypeIdx &Idx = TypeIdxs[T];
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00005081 if (Idx.getIndex() == 0) {
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005082 if (DoneWritingDeclsAndTypes) {
5083 assert(0 && "New type seen after serializing all the types to emit!");
5084 return TypeIdx();
5085 }
5086
Douglas Gregor1970d882009-04-26 03:49:13 +00005087 // We haven't seen this type before. Assign it a new ID and put it
John McCall8ccfcb52009-09-24 19:53:00 +00005088 // into the queue of types to emit.
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00005089 Idx = TypeIdx(NextTypeID++);
Douglas Gregor12bfa382009-10-17 00:13:19 +00005090 DeclTypesToEmit.push(T);
Douglas Gregor1970d882009-04-26 03:49:13 +00005091 }
Argyrios Kyrtzidise394f2c2010-08-20 16:04:09 +00005092 return Idx;
5093}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005094
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00005095TypeIdx ASTWriter::getTypeIdx(QualType T) const {
Argyrios Kyrtzidise394f2c2010-08-20 16:04:09 +00005096 if (T.isNull())
5097 return TypeIdx();
5098 assert(!T.getLocalFastQualifiers());
5099
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00005100 TypeIdxMap::const_iterator I = TypeIdxs.find(T);
5101 assert(I != TypeIdxs.end() && "Type not emitted!");
5102 return I->second;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005103}
5104
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005105void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005106 Record.push_back(GetDeclRef(D));
5107}
5108
Sebastian Redl539c5062010-08-18 23:57:32 +00005109DeclID ASTWriter::GetDeclRef(const Decl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005110 assert(WritingAST && "Cannot request a declaration ID before AST writing");
Craig Toppera13603a2014-05-22 05:54:18 +00005111
5112 if (!D) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005113 return 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005114 }
Douglas Gregorb3163e52012-01-05 22:33:30 +00005115
5116 // If D comes from an AST file, its declaration ID is already known and
5117 // fixed.
5118 if (D->isFromASTFile())
5119 return D->getGlobalID();
5120
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005121 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
Sebastian Redl539c5062010-08-18 23:57:32 +00005122 DeclID &ID = DeclIDs[D];
Mike Stump11289f42009-09-09 15:08:12 +00005123 if (ID == 0) {
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005124 if (DoneWritingDeclsAndTypes) {
5125 assert(0 && "New decl seen after serializing all the decls to emit!");
5126 return 0;
5127 }
5128
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005129 // We haven't seen this declaration before. Give it a new ID and
5130 // enqueue it in the list of declarations to emit.
Sebastian Redlff4a2952010-07-23 23:49:55 +00005131 ID = NextDeclID++;
Douglas Gregor12bfa382009-10-17 00:13:19 +00005132 DeclTypesToEmit.push(const_cast<Decl *>(D));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005133 }
5134
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005135 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005136}
5137
Sebastian Redl539c5062010-08-18 23:57:32 +00005138DeclID ASTWriter::getDeclID(const Decl *D) {
Craig Toppera13603a2014-05-22 05:54:18 +00005139 if (!D)
Douglas Gregore84a9da2009-04-20 20:36:09 +00005140 return 0;
5141
Douglas Gregorb3163e52012-01-05 22:33:30 +00005142 // If D comes from an AST file, its declaration ID is already known and
5143 // fixed.
5144 if (D->isFromASTFile())
5145 return D->getGlobalID();
5146
Douglas Gregore84a9da2009-04-20 20:36:09 +00005147 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
5148 return DeclIDs[D];
5149}
5150
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005151void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005152 assert(ID);
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005153 assert(D);
5154
5155 SourceLocation Loc = D->getLocation();
5156 if (Loc.isInvalid())
5157 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005158
5159 // We only keep track of the file-level declarations of each file.
5160 if (!D->getLexicalDeclContext()->isFileContext())
5161 return;
Argyrios Kyrtzidise1bc99e2012-02-24 19:45:46 +00005162 // FIXME: ParmVarDecls that are part of a function type of a parameter of
5163 // a function/objc method, should not have TU as lexical context.
Argyrios Kyrtzidisffe055a82012-02-24 01:12:38 +00005164 if (isa<ParmVarDecl>(D))
5165 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005166
5167 SourceManager &SM = Context->getSourceManager();
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005168 SourceLocation FileLoc = SM.getFileLoc(Loc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005169 assert(SM.isLocalSourceLocation(FileLoc));
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005170 FileID FID;
5171 unsigned Offset;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00005172 std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005173 if (FID.isInvalid())
5174 return;
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005175 assert(SM.getSLocEntry(FID).isFile());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005176
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005177 DeclIDInFileInfo *&Info = FileDeclIDs[FID];
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005178 if (!Info)
5179 Info = new DeclIDInFileInfo();
5180
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005181 std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005182 LocDeclIDsTy &Decls = Info->DeclIDs;
5183
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005184 if (Decls.empty() || Decls.back().first <= Offset) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005185 Decls.push_back(LocDecl);
5186 return;
5187 }
5188
Benjamin Kramer45025c02013-08-24 13:22:59 +00005189 LocDeclIDsTy::iterator I =
5190 std::upper_bound(Decls.begin(), Decls.end(), LocDecl, llvm::less_first());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005191
5192 Decls.insert(I, LocDecl);
5193}
5194
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005195void ASTWriter::AddDeclarationName(DeclarationName Name, RecordDataImpl &Record) {
Chris Lattner258172e2009-04-27 07:35:58 +00005196 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc.
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005197 Record.push_back(Name.getNameKind());
5198 switch (Name.getNameKind()) {
5199 case DeclarationName::Identifier:
5200 AddIdentifierRef(Name.getAsIdentifierInfo(), Record);
5201 break;
5202
5203 case DeclarationName::ObjCZeroArgSelector:
5204 case DeclarationName::ObjCOneArgSelector:
5205 case DeclarationName::ObjCMultiArgSelector:
Steve Naroff2ddea052009-04-23 10:39:46 +00005206 AddSelectorRef(Name.getObjCSelector(), Record);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005207 break;
5208
5209 case DeclarationName::CXXConstructorName:
5210 case DeclarationName::CXXDestructorName:
5211 case DeclarationName::CXXConversionFunctionName:
5212 AddTypeRef(Name.getCXXNameType(), Record);
5213 break;
5214
5215 case DeclarationName::CXXOperatorName:
5216 Record.push_back(Name.getCXXOverloadedOperator());
5217 break;
5218
Alexis Hunt3d221f22009-11-29 07:34:05 +00005219 case DeclarationName::CXXLiteralOperatorName:
5220 AddIdentifierRef(Name.getCXXLiteralIdentifier(), Record);
5221 break;
5222
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005223 case DeclarationName::CXXUsingDirective:
5224 // No extra data to emit
5225 break;
5226 }
5227}
Chris Lattnerca025db2010-05-07 21:43:38 +00005228
Richard Smithd08aeb62014-08-28 01:33:39 +00005229unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) {
5230 assert(needsAnonymousDeclarationNumber(D) &&
5231 "expected an anonymous declaration");
5232
5233 // Number the anonymous declarations within this context, if we've not
5234 // already done so.
5235 auto It = AnonymousDeclarationNumbers.find(D);
5236 if (It == AnonymousDeclarationNumbers.end()) {
5237 unsigned Index = 0;
5238 for (Decl *LexicalD : D->getLexicalDeclContext()->decls()) {
5239 auto *ND = dyn_cast<NamedDecl>(LexicalD);
5240 if (!ND || !needsAnonymousDeclarationNumber(ND))
5241 continue;
5242 AnonymousDeclarationNumbers[ND] = Index++;
5243 }
5244
5245 It = AnonymousDeclarationNumbers.find(D);
5246 assert(It != AnonymousDeclarationNumbers.end() &&
5247 "declaration not found within its lexical context");
5248 }
5249
5250 return It->second;
5251}
5252
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005253void ASTWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005254 DeclarationName Name, RecordDataImpl &Record) {
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005255 switch (Name.getNameKind()) {
5256 case DeclarationName::CXXConstructorName:
5257 case DeclarationName::CXXDestructorName:
5258 case DeclarationName::CXXConversionFunctionName:
5259 AddTypeSourceInfo(DNLoc.NamedType.TInfo, Record);
5260 break;
5261
5262 case DeclarationName::CXXOperatorName:
5263 AddSourceLocation(
5264 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.BeginOpNameLoc),
5265 Record);
5266 AddSourceLocation(
5267 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc),
5268 Record);
5269 break;
5270
5271 case DeclarationName::CXXLiteralOperatorName:
5272 AddSourceLocation(
5273 SourceLocation::getFromRawEncoding(DNLoc.CXXLiteralOperatorName.OpNameLoc),
5274 Record);
5275 break;
5276
5277 case DeclarationName::Identifier:
5278 case DeclarationName::ObjCZeroArgSelector:
5279 case DeclarationName::ObjCOneArgSelector:
5280 case DeclarationName::ObjCMultiArgSelector:
5281 case DeclarationName::CXXUsingDirective:
5282 break;
5283 }
5284}
5285
5286void ASTWriter::AddDeclarationNameInfo(const DeclarationNameInfo &NameInfo,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005287 RecordDataImpl &Record) {
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005288 AddDeclarationName(NameInfo.getName(), Record);
5289 AddSourceLocation(NameInfo.getLoc(), Record);
5290 AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName(), Record);
5291}
5292
5293void ASTWriter::AddQualifierInfo(const QualifierInfo &Info,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005294 RecordDataImpl &Record) {
Douglas Gregor14454802011-02-25 02:25:35 +00005295 AddNestedNameSpecifierLoc(Info.QualifierLoc, Record);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005296 Record.push_back(Info.NumTemplParamLists);
5297 for (unsigned i=0, e=Info.NumTemplParamLists; i != e; ++i)
5298 AddTemplateParameterList(Info.TemplParamLists[i], Record);
5299}
5300
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005301void ASTWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005302 RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005303 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005304 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005305 SmallVector<NestedNameSpecifier *, 8> NestedNames;
Chris Lattnerca025db2010-05-07 21:43:38 +00005306
5307 // Push each of the NNS's onto a stack for serialization in reverse order.
5308 while (NNS) {
5309 NestedNames.push_back(NNS);
5310 NNS = NNS->getPrefix();
5311 }
5312
5313 Record.push_back(NestedNames.size());
5314 while(!NestedNames.empty()) {
5315 NNS = NestedNames.pop_back_val();
5316 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
5317 Record.push_back(Kind);
5318 switch (Kind) {
5319 case NestedNameSpecifier::Identifier:
5320 AddIdentifierRef(NNS->getAsIdentifier(), Record);
5321 break;
5322
5323 case NestedNameSpecifier::Namespace:
5324 AddDeclRef(NNS->getAsNamespace(), Record);
5325 break;
5326
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005327 case NestedNameSpecifier::NamespaceAlias:
5328 AddDeclRef(NNS->getAsNamespaceAlias(), Record);
5329 break;
5330
Chris Lattnerca025db2010-05-07 21:43:38 +00005331 case NestedNameSpecifier::TypeSpec:
5332 case NestedNameSpecifier::TypeSpecWithTemplate:
5333 AddTypeRef(QualType(NNS->getAsType(), 0), Record);
5334 Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5335 break;
5336
5337 case NestedNameSpecifier::Global:
5338 // Don't need to write an associated value.
5339 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005340
5341 case NestedNameSpecifier::Super:
5342 AddDeclRef(NNS->getAsRecordDecl(), Record);
5343 break;
Chris Lattnerca025db2010-05-07 21:43:38 +00005344 }
5345 }
5346}
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005347
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005348void ASTWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS,
5349 RecordDataImpl &Record) {
5350 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005351 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005352 SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005353
5354 // Push each of the nested-name-specifiers's onto a stack for
5355 // serialization in reverse order.
5356 while (NNS) {
5357 NestedNames.push_back(NNS);
5358 NNS = NNS.getPrefix();
5359 }
5360
5361 Record.push_back(NestedNames.size());
5362 while(!NestedNames.empty()) {
5363 NNS = NestedNames.pop_back_val();
5364 NestedNameSpecifier::SpecifierKind Kind
5365 = NNS.getNestedNameSpecifier()->getKind();
5366 Record.push_back(Kind);
5367 switch (Kind) {
5368 case NestedNameSpecifier::Identifier:
5369 AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier(), Record);
5370 AddSourceRange(NNS.getLocalSourceRange(), Record);
5371 break;
5372
5373 case NestedNameSpecifier::Namespace:
5374 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace(), Record);
5375 AddSourceRange(NNS.getLocalSourceRange(), Record);
5376 break;
5377
5378 case NestedNameSpecifier::NamespaceAlias:
5379 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias(), Record);
5380 AddSourceRange(NNS.getLocalSourceRange(), Record);
5381 break;
5382
5383 case NestedNameSpecifier::TypeSpec:
5384 case NestedNameSpecifier::TypeSpecWithTemplate:
5385 Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5386 AddTypeLoc(NNS.getTypeLoc(), Record);
5387 AddSourceLocation(NNS.getLocalSourceRange().getEnd(), Record);
5388 break;
5389
5390 case NestedNameSpecifier::Global:
5391 AddSourceLocation(NNS.getLocalSourceRange().getEnd(), Record);
5392 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005393
5394 case NestedNameSpecifier::Super:
5395 AddDeclRef(NNS.getNestedNameSpecifier()->getAsRecordDecl(), Record);
5396 AddSourceRange(NNS.getLocalSourceRange(), Record);
5397 break;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005398 }
5399 }
5400}
5401
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005402void ASTWriter::AddTemplateName(TemplateName Name, RecordDataImpl &Record) {
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005403 TemplateName::NameKind Kind = Name.getKind();
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005404 Record.push_back(Kind);
5405 switch (Kind) {
5406 case TemplateName::Template:
5407 AddDeclRef(Name.getAsTemplateDecl(), Record);
5408 break;
5409
5410 case TemplateName::OverloadedTemplate: {
5411 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
5412 Record.push_back(OvT->size());
5413 for (OverloadedTemplateStorage::iterator I = OvT->begin(), E = OvT->end();
5414 I != E; ++I)
5415 AddDeclRef(*I, Record);
5416 break;
5417 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005418
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005419 case TemplateName::QualifiedTemplate: {
5420 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
5421 AddNestedNameSpecifier(QualT->getQualifier(), Record);
5422 Record.push_back(QualT->hasTemplateKeyword());
5423 AddDeclRef(QualT->getTemplateDecl(), Record);
5424 break;
5425 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005426
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005427 case TemplateName::DependentTemplate: {
5428 DependentTemplateName *DepT = Name.getAsDependentTemplateName();
5429 AddNestedNameSpecifier(DepT->getQualifier(), Record);
5430 Record.push_back(DepT->isIdentifier());
5431 if (DepT->isIdentifier())
5432 AddIdentifierRef(DepT->getIdentifier(), Record);
5433 else
5434 Record.push_back(DepT->getOperator());
5435 break;
5436 }
John McCalld9dfe3a2011-06-30 08:33:18 +00005437
5438 case TemplateName::SubstTemplateTemplateParm: {
5439 SubstTemplateTemplateParmStorage *subst
5440 = Name.getAsSubstTemplateTemplateParm();
5441 AddDeclRef(subst->getParameter(), Record);
5442 AddTemplateName(subst->getReplacement(), Record);
5443 break;
5444 }
Douglas Gregor5590be02011-01-15 06:45:20 +00005445
5446 case TemplateName::SubstTemplateTemplateParmPack: {
5447 SubstTemplateTemplateParmPackStorage *SubstPack
5448 = Name.getAsSubstTemplateTemplateParmPack();
5449 AddDeclRef(SubstPack->getParameterPack(), Record);
5450 AddTemplateArgument(SubstPack->getArgumentPack(), Record);
5451 break;
5452 }
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005453 }
5454}
5455
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005456void ASTWriter::AddTemplateArgument(const TemplateArgument &Arg,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005457 RecordDataImpl &Record) {
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005458 Record.push_back(Arg.getKind());
5459 switch (Arg.getKind()) {
5460 case TemplateArgument::Null:
5461 break;
5462 case TemplateArgument::Type:
5463 AddTypeRef(Arg.getAsType(), Record);
5464 break;
5465 case TemplateArgument::Declaration:
5466 AddDeclRef(Arg.getAsDecl(), Record);
David Blaikie952a9b12014-10-17 18:00:12 +00005467 AddTypeRef(Arg.getParamTypeForDecl(), Record);
Eli Friedmanb826a002012-09-26 02:36:12 +00005468 break;
5469 case TemplateArgument::NullPtr:
5470 AddTypeRef(Arg.getNullPtrType(), Record);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005471 break;
5472 case TemplateArgument::Integral:
Benjamin Kramer6003ad52012-06-07 15:09:51 +00005473 AddAPSInt(Arg.getAsIntegral(), Record);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005474 AddTypeRef(Arg.getIntegralType(), Record);
5475 break;
5476 case TemplateArgument::Template:
Douglas Gregore1d60df2011-01-14 23:41:42 +00005477 AddTemplateName(Arg.getAsTemplateOrTemplatePattern(), Record);
5478 break;
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005479 case TemplateArgument::TemplateExpansion:
5480 AddTemplateName(Arg.getAsTemplateOrTemplatePattern(), Record);
David Blaikie05785d12013-02-20 22:23:23 +00005481 if (Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions())
Douglas Gregore1d60df2011-01-14 23:41:42 +00005482 Record.push_back(*NumExpansions + 1);
5483 else
5484 Record.push_back(0);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005485 break;
5486 case TemplateArgument::Expression:
5487 AddStmt(Arg.getAsExpr());
5488 break;
5489 case TemplateArgument::Pack:
5490 Record.push_back(Arg.pack_size());
Aaron Ballman2a89e852014-07-15 21:32:31 +00005491 for (const auto &P : Arg.pack_elements())
5492 AddTemplateArgument(P, Record);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005493 break;
5494 }
5495}
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005496
5497void
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005498ASTWriter::AddTemplateParameterList(const TemplateParameterList *TemplateParams,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005499 RecordDataImpl &Record) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005500 assert(TemplateParams && "No TemplateParams!");
5501 AddSourceLocation(TemplateParams->getTemplateLoc(), Record);
5502 AddSourceLocation(TemplateParams->getLAngleLoc(), Record);
5503 AddSourceLocation(TemplateParams->getRAngleLoc(), Record);
5504 Record.push_back(TemplateParams->size());
5505 for (TemplateParameterList::const_iterator
5506 P = TemplateParams->begin(), PEnd = TemplateParams->end();
5507 P != PEnd; ++P)
5508 AddDeclRef(*P, Record);
5509}
5510
5511/// \brief Emit a template argument list.
5512void
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005513ASTWriter::AddTemplateArgumentList(const TemplateArgumentList *TemplateArgs,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005514 RecordDataImpl &Record) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005515 assert(TemplateArgs && "No TemplateArgs!");
Douglas Gregor1ccc8412010-11-07 23:05:16 +00005516 Record.push_back(TemplateArgs->size());
5517 for (int i=0, e = TemplateArgs->size(); i != e; ++i)
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005518 AddTemplateArgument(TemplateArgs->get(i), Record);
5519}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005520
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005521void
5522ASTWriter::AddASTTemplateArgumentListInfo
5523(const ASTTemplateArgumentListInfo *ASTTemplArgList, RecordDataImpl &Record) {
5524 assert(ASTTemplArgList && "No ASTTemplArgList!");
5525 AddSourceLocation(ASTTemplArgList->LAngleLoc, Record);
5526 AddSourceLocation(ASTTemplArgList->RAngleLoc, Record);
5527 Record.push_back(ASTTemplArgList->NumTemplateArgs);
5528 const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
5529 for (int i=0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
5530 AddTemplateArgumentLoc(TemplArgs[i], Record);
5531}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005532
5533void
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00005534ASTWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set, RecordDataImpl &Record) {
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005535 Record.push_back(Set.size());
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00005536 for (ASTUnresolvedSet::const_iterator
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005537 I = Set.begin(), E = Set.end(); I != E; ++I) {
5538 AddDeclRef(I.getDecl(), Record);
5539 Record.push_back(I.getAccess());
5540 }
5541}
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005542
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005543void ASTWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005544 RecordDataImpl &Record) {
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005545 Record.push_back(Base.isVirtual());
5546 Record.push_back(Base.isBaseOfClass());
5547 Record.push_back(Base.getAccessSpecifierAsWritten());
Sebastian Redl08905022011-02-05 19:23:19 +00005548 Record.push_back(Base.getInheritConstructors());
Nick Lewycky19b9f952010-07-26 16:56:01 +00005549 AddTypeSourceInfo(Base.getTypeSourceInfo(), Record);
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005550 AddSourceRange(Base.getSourceRange(), Record);
Douglas Gregor752a5952011-01-03 22:36:02 +00005551 AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
5552 : SourceLocation(),
5553 Record);
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005554}
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00005555
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005556void ASTWriter::FlushCXXBaseSpecifiers() {
5557 RecordData Record;
5558 for (unsigned I = 0, N = CXXBaseSpecifiersToWrite.size(); I != N; ++I) {
5559 Record.clear();
5560
5561 // Record the offset of this base-specifier set.
Douglas Gregorc27b2872011-08-04 00:01:48 +00005562 unsigned Index = CXXBaseSpecifiersToWrite[I].ID - 1;
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005563 if (Index == CXXBaseSpecifiersOffsets.size())
5564 CXXBaseSpecifiersOffsets.push_back(Stream.GetCurrentBitNo());
5565 else {
5566 if (Index > CXXBaseSpecifiersOffsets.size())
5567 CXXBaseSpecifiersOffsets.resize(Index + 1);
5568 CXXBaseSpecifiersOffsets[Index] = Stream.GetCurrentBitNo();
5569 }
5570
5571 const CXXBaseSpecifier *B = CXXBaseSpecifiersToWrite[I].Bases,
5572 *BEnd = CXXBaseSpecifiersToWrite[I].BasesEnd;
5573 Record.push_back(BEnd - B);
5574 for (; B != BEnd; ++B)
5575 AddCXXBaseSpecifier(*B, Record);
5576 Stream.EmitRecord(serialization::DECL_CXX_BASE_SPECIFIERS, Record);
Douglas Gregord5853042010-10-30 04:28:16 +00005577
5578 // Flush any expressions that were written as part of the base specifiers.
5579 FlushStmts();
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005580 }
5581
5582 CXXBaseSpecifiersToWrite.clear();
5583}
5584
Alexis Hunt1d792652011-01-08 20:30:50 +00005585void ASTWriter::AddCXXCtorInitializers(
5586 const CXXCtorInitializer * const *CtorInitializers,
5587 unsigned NumCtorInitializers,
5588 RecordDataImpl &Record) {
5589 Record.push_back(NumCtorInitializers);
5590 for (unsigned i=0; i != NumCtorInitializers; ++i) {
5591 const CXXCtorInitializer *Init = CtorInitializers[i];
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005592
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005593 if (Init->isBaseInitializer()) {
Alexis Hunt37a477f2011-05-04 01:19:08 +00005594 Record.push_back(CTOR_INITIALIZER_BASE);
Douglas Gregord73f3dd2011-11-01 01:16:03 +00005595 AddTypeSourceInfo(Init->getTypeSourceInfo(), Record);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005596 Record.push_back(Init->isBaseVirtual());
Alexis Hunt37a477f2011-05-04 01:19:08 +00005597 } else if (Init->isDelegatingInitializer()) {
5598 Record.push_back(CTOR_INITIALIZER_DELEGATING);
Douglas Gregord73f3dd2011-11-01 01:16:03 +00005599 AddTypeSourceInfo(Init->getTypeSourceInfo(), Record);
Alexis Hunt37a477f2011-05-04 01:19:08 +00005600 } else if (Init->isMemberInitializer()){
5601 Record.push_back(CTOR_INITIALIZER_MEMBER);
5602 AddDeclRef(Init->getMember(), Record);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005603 } else {
Alexis Hunt37a477f2011-05-04 01:19:08 +00005604 Record.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER);
5605 AddDeclRef(Init->getIndirectMember(), Record);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005606 }
Francois Pichetd583da02010-12-04 09:14:42 +00005607
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005608 AddSourceLocation(Init->getMemberLocation(), Record);
5609 AddStmt(Init->getInit());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005610 AddSourceLocation(Init->getLParenLoc(), Record);
5611 AddSourceLocation(Init->getRParenLoc(), Record);
5612 Record.push_back(Init->isWritten());
5613 if (Init->isWritten()) {
5614 Record.push_back(Init->getSourceOrder());
5615 } else {
5616 Record.push_back(Init->getNumArrayIndices());
5617 for (unsigned i=0, e=Init->getNumArrayIndices(); i != e; ++i)
5618 AddDeclRef(Init->getArrayIndex(i), Record);
5619 }
5620 }
5621}
5622
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005623void ASTWriter::AddCXXDefinitionData(const CXXRecordDecl *D, RecordDataImpl &Record) {
Richard Smith053f6c62014-05-16 23:01:30 +00005624 auto &Data = D->data();
Douglas Gregor99ae8062012-02-14 17:54:36 +00005625 Record.push_back(Data.IsLambda);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005626 Record.push_back(Data.UserDeclaredConstructor);
Richard Smith328aae52012-11-30 05:11:39 +00005627 Record.push_back(Data.UserDeclaredSpecialMembers);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005628 Record.push_back(Data.Aggregate);
5629 Record.push_back(Data.PlainOldData);
5630 Record.push_back(Data.Empty);
5631 Record.push_back(Data.Polymorphic);
5632 Record.push_back(Data.Abstract);
Chandler Carruth583edf82011-04-30 10:07:30 +00005633 Record.push_back(Data.IsStandardLayout);
Chandler Carruthb1963742011-04-30 09:17:45 +00005634 Record.push_back(Data.HasNoNonEmptyBases);
5635 Record.push_back(Data.HasPrivateFields);
5636 Record.push_back(Data.HasProtectedFields);
5637 Record.push_back(Data.HasPublicFields);
Douglas Gregor61226d32011-05-13 01:05:07 +00005638 Record.push_back(Data.HasMutableFields);
Richard Smithab44d5b2013-12-10 08:25:00 +00005639 Record.push_back(Data.HasVariantMembers);
Richard Smith561fb152012-02-25 07:33:38 +00005640 Record.push_back(Data.HasOnlyCMembers);
Richard Smithe2648ba2012-05-07 01:07:30 +00005641 Record.push_back(Data.HasInClassInitializer);
Richard Smith593f9932012-12-08 02:01:17 +00005642 Record.push_back(Data.HasUninitializedReferenceMember);
Richard Smith6b02d462012-12-08 08:32:28 +00005643 Record.push_back(Data.NeedOverloadResolutionForMoveConstructor);
5644 Record.push_back(Data.NeedOverloadResolutionForMoveAssignment);
5645 Record.push_back(Data.NeedOverloadResolutionForDestructor);
5646 Record.push_back(Data.DefaultedMoveConstructorIsDeleted);
5647 Record.push_back(Data.DefaultedMoveAssignmentIsDeleted);
5648 Record.push_back(Data.DefaultedDestructorIsDeleted);
Richard Smith328aae52012-11-30 05:11:39 +00005649 Record.push_back(Data.HasTrivialSpecialMembers);
Richard Smithb45a6f72014-04-17 20:33:01 +00005650 Record.push_back(Data.DeclaredNonTrivialSpecialMembers);
Richard Smith328aae52012-11-30 05:11:39 +00005651 Record.push_back(Data.HasIrrelevantDestructor);
Richard Smith111af8d2011-08-10 18:11:37 +00005652 Record.push_back(Data.HasConstexprNonCopyMoveConstructor);
Richard Smith561fb152012-02-25 07:33:38 +00005653 Record.push_back(Data.DefaultedDefaultConstructorIsConstexpr);
Richard Smith561fb152012-02-25 07:33:38 +00005654 Record.push_back(Data.HasConstexprDefaultConstructor);
Chandler Carruthe71d0622011-04-24 02:49:34 +00005655 Record.push_back(Data.HasNonLiteralTypeFieldsOrBases);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005656 Record.push_back(Data.ComputedVisibleConversions);
Alexis Huntea6f0322011-05-11 22:34:38 +00005657 Record.push_back(Data.UserProvidedDefaultConstructor);
Richard Smith328aae52012-11-30 05:11:39 +00005658 Record.push_back(Data.DeclaredSpecialMembers);
Richard Smith1c33fe82012-11-28 06:23:12 +00005659 Record.push_back(Data.ImplicitCopyConstructorHasConstParam);
5660 Record.push_back(Data.ImplicitCopyAssignmentHasConstParam);
5661 Record.push_back(Data.HasDeclaredCopyConstructorWithConstParam);
5662 Record.push_back(Data.HasDeclaredCopyAssignmentWithConstParam);
Richard Smith561fb152012-02-25 07:33:38 +00005663 // IsLambda bit is already saved.
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005664
5665 Record.push_back(Data.NumBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005666 if (Data.NumBases > 0)
5667 AddCXXBaseSpecifiersRef(Data.getBases(), Data.getBases() + Data.NumBases,
5668 Record);
5669
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005670 // FIXME: Make VBases lazily computed when needed to avoid storing them.
5671 Record.push_back(Data.NumVBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005672 if (Data.NumVBases > 0)
5673 AddCXXBaseSpecifiersRef(Data.getVBases(), Data.getVBases() + Data.NumVBases,
5674 Record);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005675
Richard Smitha4ba74c2013-08-30 04:46:40 +00005676 AddUnresolvedSet(Data.Conversions.get(*Context), Record);
5677 AddUnresolvedSet(Data.VisibleConversions.get(*Context), Record);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005678 // Data.Definition is the owning decl, no need to write it.
Richard Smith68ad0e72013-06-26 02:41:25 +00005679 AddDeclRef(D->getFirstFriend(), Record);
Douglas Gregor99ae8062012-02-14 17:54:36 +00005680
5681 // Add lambda-specific data.
5682 if (Data.IsLambda) {
Richard Smith053f6c62014-05-16 23:01:30 +00005683 auto &Lambda = D->getLambdaData();
Douglas Gregor680e9e02012-02-21 19:11:17 +00005684 Record.push_back(Lambda.Dependent);
Faisal Valic1a6dc42013-10-23 16:10:50 +00005685 Record.push_back(Lambda.IsGenericLambda);
5686 Record.push_back(Lambda.CaptureDefault);
Douglas Gregor99ae8062012-02-14 17:54:36 +00005687 Record.push_back(Lambda.NumCaptures);
5688 Record.push_back(Lambda.NumExplicitCaptures);
Douglas Gregor63798542012-02-20 19:44:39 +00005689 Record.push_back(Lambda.ManglingNumber);
Douglas Gregor7fcbd902012-02-21 00:37:24 +00005690 AddDeclRef(Lambda.ContextDecl, Record);
Eli Friedmand564afb2012-09-19 01:18:11 +00005691 AddTypeSourceInfo(Lambda.MethodTyInfo, Record);
Douglas Gregor99ae8062012-02-14 17:54:36 +00005692 for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00005693 const LambdaCapture &Capture = Lambda.Captures[I];
Douglas Gregor99ae8062012-02-14 17:54:36 +00005694 AddSourceLocation(Capture.getLocation(), Record);
5695 Record.push_back(Capture.isImplicit());
Richard Smithba71c082013-05-16 06:20:58 +00005696 Record.push_back(Capture.getCaptureKind());
5697 switch (Capture.getCaptureKind()) {
5698 case LCK_This:
Alexey Bataev39c81e22014-08-28 04:28:19 +00005699 case LCK_VLAType:
Richard Smithba71c082013-05-16 06:20:58 +00005700 break;
5701 case LCK_ByCopy:
Richard Smithbb13c9a2013-09-28 04:02:39 +00005702 case LCK_ByRef:
Richard Smithba71c082013-05-16 06:20:58 +00005703 VarDecl *Var =
Craig Toppera13603a2014-05-22 05:54:18 +00005704 Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
Richard Smithba71c082013-05-16 06:20:58 +00005705 AddDeclRef(Var, Record);
5706 AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc()
5707 : SourceLocation(),
5708 Record);
5709 break;
5710 }
Douglas Gregor99ae8062012-02-14 17:54:36 +00005711 }
5712 }
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005713}
5714
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005715void ASTWriter::ReaderInitialized(ASTReader *Reader) {
Sebastian Redl07a89a82010-07-30 00:29:29 +00005716 assert(Reader && "Cannot remove chain");
Douglas Gregordf0c1512011-08-18 04:12:04 +00005717 assert((!Chain || Chain == Reader) && "Cannot replace chain");
Sebastian Redl07a89a82010-07-30 00:29:29 +00005718 assert(FirstDeclID == NextDeclID &&
5719 FirstTypeID == NextTypeID &&
5720 FirstIdentID == NextIdentID &&
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005721 FirstMacroID == NextMacroID &&
Douglas Gregor253eefe2011-12-01 00:59:36 +00005722 FirstSubmoduleID == NextSubmoduleID &&
Sebastian Redld95a56e2010-08-04 18:21:41 +00005723 FirstSelectorID == NextSelectorID &&
Sebastian Redl07a89a82010-07-30 00:29:29 +00005724 "Setting chain after writing has started.");
Douglas Gregor925296b2011-07-19 16:10:42 +00005725
Sebastian Redl07a89a82010-07-30 00:29:29 +00005726 Chain = Reader;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005727
Douglas Gregordf0c1512011-08-18 04:12:04 +00005728 FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls();
5729 FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes();
5730 FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005731 FirstMacroID = NUM_PREDEF_MACRO_IDS + Chain->getTotalNumMacros();
Douglas Gregor253eefe2011-12-01 00:59:36 +00005732 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
Douglas Gregordf0c1512011-08-18 04:12:04 +00005733 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005734 NextDeclID = FirstDeclID;
5735 NextTypeID = FirstTypeID;
5736 NextIdentID = FirstIdentID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005737 NextMacroID = FirstMacroID;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005738 NextSelectorID = FirstSelectorID;
Douglas Gregor253eefe2011-12-01 00:59:36 +00005739 NextSubmoduleID = FirstSubmoduleID;
Sebastian Redl07a89a82010-07-30 00:29:29 +00005740}
5741
Sebastian Redl539c5062010-08-18 23:57:32 +00005742void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005743 // Always keep the highest ID. See \p TypeRead() for more information.
5744 IdentID &StoredID = IdentifierIDs[II];
5745 if (ID > StoredID)
5746 StoredID = ID;
Sebastian Redlff4a2952010-07-23 23:49:55 +00005747}
5748
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005749void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005750 // Always keep the highest ID. See \p TypeRead() for more information.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005751 MacroID &StoredID = MacroIDs[MI];
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005752 if (ID > StoredID)
5753 StoredID = ID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005754}
5755
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00005756void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005757 // Always take the highest-numbered type index. This copes with an interesting
5758 // case for chained AST writing where we schedule writing the type and then,
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005759 // later, deserialize the type from another AST. In this case, we want to
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005760 // keep the higher-numbered entry so that we can properly write it out to
5761 // the AST file.
5762 TypeIdx &StoredIdx = TypeIdxs[T];
5763 if (Idx.getIndex() >= StoredIdx.getIndex())
5764 StoredIdx = Idx;
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00005765}
5766
Sebastian Redl539c5062010-08-18 23:57:32 +00005767void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005768 // Always keep the highest ID. See \p TypeRead() for more information.
5769 SelectorID &StoredID = SelectorIDs[S];
5770 if (ID > StoredID)
5771 StoredID = ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00005772}
Douglas Gregor91096292010-10-02 19:29:26 +00005773
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00005774void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
Douglas Gregor91096292010-10-02 19:29:26 +00005775 MacroDefinition *MD) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00005776 assert(MacroDefinitions.find(MD) == MacroDefinitions.end());
Douglas Gregor91096292010-10-02 19:29:26 +00005777 MacroDefinitions[MD] = ID;
5778}
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005779
Douglas Gregore37a85a2011-12-02 17:30:13 +00005780void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
5781 assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end());
5782 SubmoduleIDs[Mod] = ID;
5783}
5784
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005785void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
John McCallf937c022011-10-07 06:10:15 +00005786 assert(D->isCompleteDefinition());
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005787 assert(!WritingAST && "Already writing the AST!");
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005788 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
5789 // We are interested when a PCH decl is modified.
Douglas Gregorb3722e22011-09-09 23:01:35 +00005790 if (RD->isFromASTFile()) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005791 // A forward reference was mutated into a definition. Rewrite it.
5792 // FIXME: This happens during template instantiation, should we
5793 // have created a new definition decl instead ?
Richard Smithcd45dbc2014-04-19 03:48:30 +00005794 assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
5795 "completed a tag from another module but not by instantiation?");
5796 DeclUpdates[RD].push_back(
5797 DeclUpdate(UPD_CXX_INSTANTIATED_CLASS_DEFINITION));
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005798 }
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005799 }
5800}
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005801
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005802void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
5803 // TU and namespaces are handled elsewhere.
5804 if (isa<TranslationUnitDecl>(DC) || isa<NamespaceDecl>(DC))
5805 return;
5806
Douglas Gregorb3722e22011-09-09 23:01:35 +00005807 if (!(!D->isFromASTFile() && cast<Decl>(DC)->isFromASTFile()))
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005808 return; // Not a source decl added to a DeclContext from PCH.
5809
Douglas Gregor9f782892013-01-21 15:25:38 +00005810 assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
Richard Smithe9a8bc32014-09-30 00:45:29 +00005811 assert(!WritingAST && "Already writing the AST!");
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005812 AddUpdatedDeclContext(DC);
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005813 UpdatingVisibleDecls.push_back(D);
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005814}
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005815
5816void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
5817 assert(D->isImplicit());
Douglas Gregorb3722e22011-09-09 23:01:35 +00005818 if (!(!D->isFromASTFile() && RD->isFromASTFile()))
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005819 return; // Not a source member added to a class from PCH.
5820 if (!isa<CXXMethodDecl>(D))
5821 return; // We are interested in lazily declared implicit methods.
5822
5823 // A decl coming from PCH was modified.
John McCallf937c022011-10-07 06:10:15 +00005824 assert(RD->isCompleteDefinition());
Richard Smithe9a8bc32014-09-30 00:45:29 +00005825 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00005826 DeclUpdates[RD].push_back(DeclUpdate(UPD_CXX_ADDED_IMPLICIT_MEMBER, D));
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005827}
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00005828
5829void ASTWriter::AddedCXXTemplateSpecialization(const ClassTemplateDecl *TD,
5830 const ClassTemplateSpecializationDecl *D) {
Argyrios Kyrtzidisef80a012010-10-28 07:38:47 +00005831 // The specializations set is kept in the canonical template.
5832 TD = TD->getCanonicalDecl();
Douglas Gregorb3722e22011-09-09 23:01:35 +00005833 if (!(!D->isFromASTFile() && TD->isFromASTFile()))
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00005834 return; // Not a source specialization added to a template from PCH.
5835
Richard Smithe9a8bc32014-09-30 00:45:29 +00005836 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00005837 DeclUpdates[TD].push_back(DeclUpdate(UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION,
5838 D));
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00005839}
Douglas Gregorf88e35b2010-11-30 06:16:57 +00005840
Larisse Voufo39a1e502013-08-06 01:03:05 +00005841void ASTWriter::AddedCXXTemplateSpecialization(
5842 const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
5843 // The specializations set is kept in the canonical template.
Larisse Voufo39a1e502013-08-06 01:03:05 +00005844 TD = TD->getCanonicalDecl();
5845 if (!(!D->isFromASTFile() && TD->isFromASTFile()))
5846 return; // Not a source specialization added to a template from PCH.
5847
Richard Smithe9a8bc32014-09-30 00:45:29 +00005848 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00005849 DeclUpdates[TD].push_back(DeclUpdate(UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION,
5850 D));
Larisse Voufo39a1e502013-08-06 01:03:05 +00005851}
5852
Sebastian Redl9ab988f2011-04-14 14:07:59 +00005853void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
5854 const FunctionDecl *D) {
5855 // The specializations set is kept in the canonical template.
5856 TD = TD->getCanonicalDecl();
Douglas Gregorb3722e22011-09-09 23:01:35 +00005857 if (!(!D->isFromASTFile() && TD->isFromASTFile()))
Sebastian Redl9ab988f2011-04-14 14:07:59 +00005858 return; // Not a source specialization added to a template from PCH.
5859
Richard Smithe9a8bc32014-09-30 00:45:29 +00005860 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00005861 DeclUpdates[TD].push_back(DeclUpdate(UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION,
5862 D));
Sebastian Redl9ab988f2011-04-14 14:07:59 +00005863}
5864
Richard Smith564417a2014-03-20 21:47:22 +00005865void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
5866 assert(!WritingAST && "Already writing the AST!");
5867 FD = FD->getCanonicalDecl();
5868 if (!FD->isFromASTFile())
5869 return; // Not a function declared in PCH and defined outside.
5870
5871 DeclUpdates[FD].push_back(UPD_CXX_RESOLVED_EXCEPTION_SPEC);
5872}
5873
Richard Smith1fa5d642013-05-11 05:45:24 +00005874void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
5875 assert(!WritingAST && "Already writing the AST!");
5876 FD = FD->getCanonicalDecl();
5877 if (!FD->isFromASTFile())
5878 return; // Not a function declared in PCH and defined outside.
5879
Aaron Ballman4f45b712014-03-21 15:22:56 +00005880 DeclUpdates[FD].push_back(DeclUpdate(UPD_CXX_DEDUCED_RETURN_TYPE, ReturnType));
Richard Smith1fa5d642013-05-11 05:45:24 +00005881}
5882
Sebastian Redlab238a72011-04-24 16:28:06 +00005883void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005884 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005885 if (!D->isFromASTFile())
Sebastian Redlab238a72011-04-24 16:28:06 +00005886 return; // Declaration not imported from PCH.
5887
Richard Smith4d235792014-08-07 18:53:08 +00005888 // Implicit function decl from a PCH was defined.
5889 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Sebastian Redlab238a72011-04-24 16:28:06 +00005890}
5891
Richard Smithd28ac5b2014-03-22 23:33:22 +00005892void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
5893 assert(!WritingAST && "Already writing the AST!");
5894 if (!D->isFromASTFile())
5895 return;
5896
Richard Smithd28ac5b2014-03-22 23:33:22 +00005897 DeclUpdates[D].push_back(
Richard Smith4d235792014-08-07 18:53:08 +00005898 DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Richard Smithd28ac5b2014-03-22 23:33:22 +00005899}
5900
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005901void ASTWriter::StaticDataMemberInstantiated(const VarDecl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005902 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005903 if (!D->isFromASTFile())
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005904 return;
5905
5906 // Since the actual instantiation is delayed, this really means that we need
5907 // to update the instantiation location.
Richard Smith6ef42932014-03-20 21:02:00 +00005908 DeclUpdates[D].push_back(
Aaron Ballman4f45b712014-03-21 15:22:56 +00005909 DeclUpdate(UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER,
5910 D->getMemberSpecializationInfo()->getPointOfInstantiation()));
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005911}
5912
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005913void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
5914 const ObjCInterfaceDecl *IFD) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005915 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005916 if (!IFD->isFromASTFile())
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005917 return; // Declaration not imported from PCH.
Douglas Gregor404cdde2012-01-27 01:47:08 +00005918
5919 assert(IFD->getDefinition() && "Category on a class without a definition?");
5920 ObjCClassesWithCategories.insert(
5921 const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005922}
Argyrios Kyrtzidisb97a4022011-11-12 21:07:46 +00005923
Argyrios Kyrtzidis0ca3a8b2011-11-12 21:07:52 +00005924
Argyrios Kyrtzidis846e61a2011-11-14 04:52:29 +00005925void ASTWriter::AddedObjCPropertyInClassExtension(const ObjCPropertyDecl *Prop,
5926 const ObjCPropertyDecl *OrigProp,
5927 const ObjCCategoryDecl *ClassExt) {
5928 const ObjCInterfaceDecl *D = ClassExt->getClassInterface();
5929 if (!D)
5930 return;
5931
5932 assert(!WritingAST && "Already writing the AST!");
5933 if (!D->isFromASTFile())
5934 return; // Declaration not imported from PCH.
5935
5936 RewriteDecl(D);
5937}
Eli Friedman276dd182013-09-05 00:02:25 +00005938
5939void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
5940 assert(!WritingAST && "Already writing the AST!");
5941 if (!D->isFromASTFile())
5942 return;
5943
Aaron Ballman4f45b712014-03-21 15:22:56 +00005944 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_USED));
Eli Friedman276dd182013-09-05 00:02:25 +00005945}
Alexey Bataev97720002014-11-11 04:05:39 +00005946
5947void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
5948 assert(!WritingAST && "Already writing the AST!");
5949 if (!D->isFromASTFile())
5950 return;
5951
5952 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_THREADPRIVATE));
5953}