blob: 1a8d616efa8b886e2facd8a162439293bef437b8 [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>
Reid Kleckner012665e2015-05-21 00:13:09 +000063static StringRef bytes(const std::vector<T, Allocator> &v) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +000064 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>
Reid Kleckner012665e2015-05-21 00:13:09 +000070static StringRef bytes(const SmallVectorImpl<T> &v) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +000071 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 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000101}
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000102
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
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000461}
John McCall8f115c62009-10-16 21:56:05 +0000462
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);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000777 RECORD(EXPR_DESIGNATED_INIT_UPDATE);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000778 RECORD(EXPR_IMPLICIT_VALUE_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000779 RECORD(EXPR_NO_INIT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000780 RECORD(EXPR_VA_ARG);
781 RECORD(EXPR_ADDR_LABEL);
782 RECORD(EXPR_STMT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000783 RECORD(EXPR_CHOOSE);
784 RECORD(EXPR_GNU_NULL);
785 RECORD(EXPR_SHUFFLE_VECTOR);
786 RECORD(EXPR_BLOCK);
Peter Collingbourne91147592011-04-15 00:35:48 +0000787 RECORD(EXPR_GENERIC_SELECTION);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000788 RECORD(EXPR_OBJC_STRING_LITERAL);
Patrick Beard0caa3942012-04-19 00:25:12 +0000789 RECORD(EXPR_OBJC_BOXED_EXPRESSION);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000790 RECORD(EXPR_OBJC_ARRAY_LITERAL);
791 RECORD(EXPR_OBJC_DICTIONARY_LITERAL);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000792 RECORD(EXPR_OBJC_ENCODE);
793 RECORD(EXPR_OBJC_SELECTOR_EXPR);
794 RECORD(EXPR_OBJC_PROTOCOL_EXPR);
795 RECORD(EXPR_OBJC_IVAR_REF_EXPR);
796 RECORD(EXPR_OBJC_PROPERTY_REF_EXPR);
797 RECORD(EXPR_OBJC_KVC_REF_EXPR);
798 RECORD(EXPR_OBJC_MESSAGE_EXPR);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000799 RECORD(STMT_OBJC_FOR_COLLECTION);
800 RECORD(STMT_OBJC_CATCH);
801 RECORD(STMT_OBJC_FINALLY);
802 RECORD(STMT_OBJC_AT_TRY);
803 RECORD(STMT_OBJC_AT_SYNCHRONIZED);
804 RECORD(STMT_OBJC_AT_THROW);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000805 RECORD(EXPR_OBJC_BOOL_LITERAL);
Richard Smith01b2cb42014-07-26 06:37:51 +0000806 RECORD(STMT_CXX_CATCH);
807 RECORD(STMT_CXX_TRY);
808 RECORD(STMT_CXX_FOR_RANGE);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000809 RECORD(EXPR_CXX_OPERATOR_CALL);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000810 RECORD(EXPR_CXX_MEMBER_CALL);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000811 RECORD(EXPR_CXX_CONSTRUCT);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000812 RECORD(EXPR_CXX_TEMPORARY_OBJECT);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000813 RECORD(EXPR_CXX_STATIC_CAST);
814 RECORD(EXPR_CXX_DYNAMIC_CAST);
815 RECORD(EXPR_CXX_REINTERPRET_CAST);
816 RECORD(EXPR_CXX_CONST_CAST);
817 RECORD(EXPR_CXX_FUNCTIONAL_CAST);
Richard Smithc67fdd42012-03-07 08:35:16 +0000818 RECORD(EXPR_USER_DEFINED_LITERAL);
Richard Smithcc1b96d2013-06-12 22:31:48 +0000819 RECORD(EXPR_CXX_STD_INITIALIZER_LIST);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000820 RECORD(EXPR_CXX_BOOL_LITERAL);
821 RECORD(EXPR_CXX_NULL_PTR_LITERAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000822 RECORD(EXPR_CXX_TYPEID_EXPR);
823 RECORD(EXPR_CXX_TYPEID_TYPE);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000824 RECORD(EXPR_CXX_THIS);
825 RECORD(EXPR_CXX_THROW);
826 RECORD(EXPR_CXX_DEFAULT_ARG);
Richard Smith01b2cb42014-07-26 06:37:51 +0000827 RECORD(EXPR_CXX_DEFAULT_INIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000828 RECORD(EXPR_CXX_BIND_TEMPORARY);
829 RECORD(EXPR_CXX_SCALAR_VALUE_INIT);
830 RECORD(EXPR_CXX_NEW);
831 RECORD(EXPR_CXX_DELETE);
832 RECORD(EXPR_CXX_PSEUDO_DESTRUCTOR);
833 RECORD(EXPR_EXPR_WITH_CLEANUPS);
834 RECORD(EXPR_CXX_DEPENDENT_SCOPE_MEMBER);
835 RECORD(EXPR_CXX_DEPENDENT_SCOPE_DECL_REF);
836 RECORD(EXPR_CXX_UNRESOLVED_CONSTRUCT);
837 RECORD(EXPR_CXX_UNRESOLVED_MEMBER);
838 RECORD(EXPR_CXX_UNRESOLVED_LOOKUP);
Richard Smith01b2cb42014-07-26 06:37:51 +0000839 RECORD(EXPR_CXX_EXPRESSION_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000840 RECORD(EXPR_CXX_NOEXCEPT);
841 RECORD(EXPR_OPAQUE_VALUE);
Richard Smith01b2cb42014-07-26 06:37:51 +0000842 RECORD(EXPR_BINARY_CONDITIONAL_OPERATOR);
843 RECORD(EXPR_TYPE_TRAIT);
844 RECORD(EXPR_ARRAY_TYPE_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000845 RECORD(EXPR_PACK_EXPANSION);
846 RECORD(EXPR_SIZEOF_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +0000847 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000848 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +0000849 RECORD(EXPR_FUNCTION_PARM_PACK);
850 RECORD(EXPR_MATERIALIZE_TEMPORARY);
Peter Collingbourne41f85462011-02-09 21:07:24 +0000851 RECORD(EXPR_CUDA_KERNEL_CALL);
Richard Smith01b2cb42014-07-26 06:37:51 +0000852 RECORD(EXPR_CXX_UUIDOF_EXPR);
853 RECORD(EXPR_CXX_UUIDOF_TYPE);
854 RECORD(EXPR_LAMBDA);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000855#undef RECORD
Chris Lattner28fa4e62009-04-26 22:26:21 +0000856}
Mike Stump11289f42009-09-09 15:08:12 +0000857
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000858void ASTWriter::WriteBlockInfoBlock() {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000859 RecordData Record;
860 Stream.EnterSubblock(llvm::bitc::BLOCKINFO_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +0000861
Sebastian Redl539c5062010-08-18 23:57:32 +0000862#define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record)
863#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Mike Stump11289f42009-09-09 15:08:12 +0000864
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000865 // Control Block.
866 BLOCK(CONTROL_BLOCK);
867 RECORD(METADATA);
Ben Langmuir487ea142014-10-23 18:05:36 +0000868 RECORD(SIGNATURE);
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000869 RECORD(MODULE_NAME);
870 RECORD(MODULE_MAP_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000871 RECORD(IMPORTS);
Richard Smith7f330cd2015-03-18 01:42:29 +0000872 RECORD(KNOWN_MODULE_FILES);
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000873 RECORD(LANGUAGE_OPTIONS);
874 RECORD(TARGET_OPTIONS);
Douglas Gregorfad10d82012-10-18 18:36:53 +0000875 RECORD(ORIGINAL_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000876 RECORD(ORIGINAL_PCH_DIR);
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +0000877 RECORD(ORIGINAL_FILE_ID);
Douglas Gregor3120d2c2012-10-22 18:42:04 +0000878 RECORD(INPUT_FILE_OFFSETS);
Douglas Gregor8263ffb2012-10-24 15:17:15 +0000879 RECORD(DIAGNOSTIC_OPTIONS);
Douglas Gregorc6317db2012-10-24 15:49:58 +0000880 RECORD(FILE_SYSTEM_OPTIONS);
Douglas Gregor2d302362012-10-24 16:50:34 +0000881 RECORD(HEADER_SEARCH_OPTIONS);
Douglas Gregorb6af6c22012-10-24 20:05:57 +0000882 RECORD(PREPROCESSOR_OPTIONS);
883
Douglas Gregor108cb222012-10-19 00:45:00 +0000884 BLOCK(INPUT_FILES_BLOCK);
885 RECORD(INPUT_FILE);
886
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000887 // AST Top-Level Block.
888 BLOCK(AST_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000889 RECORD(TYPE_OFFSET);
890 RECORD(DECL_OFFSET);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000891 RECORD(IDENTIFIER_OFFSET);
892 RECORD(IDENTIFIER_TABLE);
Ben Langmuir332aafe2014-01-31 01:06:56 +0000893 RECORD(EAGERLY_DESERIALIZED_DECLS);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000894 RECORD(SPECIAL_TYPES);
895 RECORD(STATISTICS);
896 RECORD(TENTATIVE_DEFINITIONS);
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +0000897 RECORD(UNUSED_FILESCOPED_DECLS);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000898 RECORD(SELECTOR_OFFSETS);
899 RECORD(METHOD_POOL);
900 RECORD(PP_COUNTER_VALUE);
Douglas Gregor258ae542009-04-27 06:38:32 +0000901 RECORD(SOURCE_LOCATION_OFFSETS);
902 RECORD(SOURCE_LOCATION_PRELOADS);
Douglas Gregor61cac2b2009-04-27 20:06:05 +0000903 RECORD(EXT_VECTOR_DECLS);
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +0000904 RECORD(PPD_ENTITIES_OFFSETS);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +0000905 RECORD(REFERENCED_SELECTOR_POOL);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000906 RECORD(TU_UPDATE_LEXICAL);
Douglas Gregor358cd442012-01-15 16:58:34 +0000907 RECORD(LOCAL_REDECLARATIONS_MAP);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000908 RECORD(SEMA_DECL_REFS);
909 RECORD(WEAK_UNDECLARED_IDENTIFIERS);
910 RECORD(PENDING_IMPLICIT_INSTANTIATIONS);
911 RECORD(DECL_REPLACEMENTS);
912 RECORD(UPDATE_VISIBLE);
913 RECORD(DECL_UPDATE_OFFSETS);
914 RECORD(DECL_UPDATES);
915 RECORD(CXX_BASE_SPECIFIER_OFFSETS);
916 RECORD(DIAG_PRAGMA_MAPPINGS);
Peter Collingbourne5df20e02011-02-15 19:46:30 +0000917 RECORD(CUDA_SPECIAL_DECL_REFS);
Douglas Gregor09b69892011-02-10 17:09:37 +0000918 RECORD(HEADER_SEARCH_TABLE);
Peter Collingbourne5df20e02011-02-15 19:46:30 +0000919 RECORD(FP_PRAGMA_OPTIONS);
920 RECORD(OPENCL_EXTENSIONS);
Alexis Hunt27a761d2011-05-04 23:29:54 +0000921 RECORD(DELEGATING_CTORS);
Douglas Gregorc2fa1692011-06-28 16:20:02 +0000922 RECORD(KNOWN_NAMESPACES);
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +0000923 RECORD(UNDEFINED_BUT_USED);
Douglas Gregor78d0b572011-08-04 16:39:39 +0000924 RECORD(MODULE_OFFSET_MAP);
925 RECORD(SOURCE_MANAGER_LINE_TABLE);
Douglas Gregor404cdde2012-01-27 01:47:08 +0000926 RECORD(OBJC_CATEGORIES_MAP);
Douglas Gregor66e4add2011-12-19 21:09:25 +0000927 RECORD(FILE_SORTED_DECLS);
928 RECORD(IMPORTED_MODULES);
Douglas Gregor358cd442012-01-15 16:58:34 +0000929 RECORD(LOCAL_REDECLARATIONS);
Douglas Gregor404cdde2012-01-27 01:47:08 +0000930 RECORD(OBJC_CATEGORIES);
Douglas Gregorcb28f9d2012-10-09 23:05:51 +0000931 RECORD(MACRO_OFFSET);
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);
Richard Smithec216502015-02-13 19:48:37 +0000944 RECORD(PP_MACRO_DIRECTIVE_HISTORY);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000945 RECORD(PP_MACRO_FUNCTION_LIKE);
Richard Smithd7329392015-04-21 21:46:32 +0000946 RECORD(PP_MACRO_OBJECT_LIKE);
947 RECORD(PP_MODULE_MACRO);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000948 RECORD(PP_TOKEN);
Richard Smithec216502015-02-13 19:48:37 +0000949
Douglas Gregor12bfa382009-10-17 00:13:19 +0000950 // Decls and Types block.
951 BLOCK(DECLTYPES_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000952 RECORD(TYPE_EXT_QUAL);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000953 RECORD(TYPE_COMPLEX);
954 RECORD(TYPE_POINTER);
955 RECORD(TYPE_BLOCK_POINTER);
956 RECORD(TYPE_LVALUE_REFERENCE);
957 RECORD(TYPE_RVALUE_REFERENCE);
958 RECORD(TYPE_MEMBER_POINTER);
959 RECORD(TYPE_CONSTANT_ARRAY);
960 RECORD(TYPE_INCOMPLETE_ARRAY);
961 RECORD(TYPE_VARIABLE_ARRAY);
962 RECORD(TYPE_VECTOR);
963 RECORD(TYPE_EXT_VECTOR);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000964 RECORD(TYPE_FUNCTION_NO_PROTO);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000965 RECORD(TYPE_FUNCTION_PROTO);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000966 RECORD(TYPE_TYPEDEF);
967 RECORD(TYPE_TYPEOF_EXPR);
968 RECORD(TYPE_TYPEOF);
969 RECORD(TYPE_RECORD);
970 RECORD(TYPE_ENUM);
971 RECORD(TYPE_OBJC_INTERFACE);
Steve Narofffb4330f2009-06-17 22:40:22 +0000972 RECORD(TYPE_OBJC_OBJECT_POINTER);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000973 RECORD(TYPE_DECLTYPE);
974 RECORD(TYPE_ELABORATED);
975 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
976 RECORD(TYPE_UNRESOLVED_USING);
977 RECORD(TYPE_INJECTED_CLASS_NAME);
978 RECORD(TYPE_OBJC_OBJECT);
979 RECORD(TYPE_TEMPLATE_TYPE_PARM);
980 RECORD(TYPE_TEMPLATE_SPECIALIZATION);
981 RECORD(TYPE_DEPENDENT_NAME);
982 RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION);
983 RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
984 RECORD(TYPE_PAREN);
985 RECORD(TYPE_PACK_EXPANSION);
986 RECORD(TYPE_ATTRIBUTED);
987 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000988 RECORD(TYPE_AUTO);
989 RECORD(TYPE_UNARY_TRANSFORM);
Eli Friedman0dfb8892011-10-06 23:00:33 +0000990 RECORD(TYPE_ATOMIC);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000991 RECORD(TYPE_DECAYED);
992 RECORD(TYPE_ADJUSTED);
Chris Lattnerdb397b62009-04-26 22:32:16 +0000993 RECORD(DECL_TYPEDEF);
Richard Smith01b2cb42014-07-26 06:37:51 +0000994 RECORD(DECL_TYPEALIAS);
Chris Lattnerdb397b62009-04-26 22:32:16 +0000995 RECORD(DECL_ENUM);
996 RECORD(DECL_RECORD);
997 RECORD(DECL_ENUM_CONSTANT);
998 RECORD(DECL_FUNCTION);
999 RECORD(DECL_OBJC_METHOD);
1000 RECORD(DECL_OBJC_INTERFACE);
1001 RECORD(DECL_OBJC_PROTOCOL);
1002 RECORD(DECL_OBJC_IVAR);
1003 RECORD(DECL_OBJC_AT_DEFS_FIELD);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001004 RECORD(DECL_OBJC_CATEGORY);
1005 RECORD(DECL_OBJC_CATEGORY_IMPL);
1006 RECORD(DECL_OBJC_IMPLEMENTATION);
1007 RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
1008 RECORD(DECL_OBJC_PROPERTY);
1009 RECORD(DECL_OBJC_PROPERTY_IMPL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001010 RECORD(DECL_FIELD);
John McCall5e77d762013-04-16 07:28:30 +00001011 RECORD(DECL_MS_PROPERTY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001012 RECORD(DECL_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001013 RECORD(DECL_IMPLICIT_PARAM);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001014 RECORD(DECL_PARM_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001015 RECORD(DECL_FILE_SCOPE_ASM);
1016 RECORD(DECL_BLOCK);
1017 RECORD(DECL_CONTEXT_LEXICAL);
1018 RECORD(DECL_CONTEXT_VISIBLE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001019 RECORD(DECL_NAMESPACE);
1020 RECORD(DECL_NAMESPACE_ALIAS);
1021 RECORD(DECL_USING);
1022 RECORD(DECL_USING_SHADOW);
1023 RECORD(DECL_USING_DIRECTIVE);
1024 RECORD(DECL_UNRESOLVED_USING_VALUE);
1025 RECORD(DECL_UNRESOLVED_USING_TYPENAME);
1026 RECORD(DECL_LINKAGE_SPEC);
1027 RECORD(DECL_CXX_RECORD);
1028 RECORD(DECL_CXX_METHOD);
1029 RECORD(DECL_CXX_CONSTRUCTOR);
1030 RECORD(DECL_CXX_DESTRUCTOR);
1031 RECORD(DECL_CXX_CONVERSION);
1032 RECORD(DECL_ACCESS_SPEC);
1033 RECORD(DECL_FRIEND);
1034 RECORD(DECL_FRIEND_TEMPLATE);
1035 RECORD(DECL_CLASS_TEMPLATE);
1036 RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
1037 RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
Larisse Voufo39a1e502013-08-06 01:03:05 +00001038 RECORD(DECL_VAR_TEMPLATE);
1039 RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION);
1040 RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001041 RECORD(DECL_FUNCTION_TEMPLATE);
1042 RECORD(DECL_TEMPLATE_TYPE_PARM);
1043 RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
1044 RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
1045 RECORD(DECL_STATIC_ASSERT);
1046 RECORD(DECL_CXX_BASE_SPECIFIERS);
1047 RECORD(DECL_INDIRECTFIELD);
1048 RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
1049
Douglas Gregor03412ba2011-06-03 02:27:19 +00001050 // Statements and Exprs can occur in the Decls and Types block.
1051 AddStmtsExprs(Stream, Record);
1052
Douglas Gregor92a96f52011-02-08 21:58:10 +00001053 BLOCK(PREPROCESSOR_DETAIL_BLOCK);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001054 RECORD(PPD_MACRO_EXPANSION);
Douglas Gregor92a96f52011-02-08 21:58:10 +00001055 RECORD(PPD_MACRO_DEFINITION);
1056 RECORD(PPD_INCLUSION_DIRECTIVE);
1057
Chris Lattner28fa4e62009-04-26 22:26:21 +00001058#undef RECORD
1059#undef BLOCK
1060 Stream.ExitBlock();
1061}
1062
Richard Smith54cc3c22014-12-11 20:50:24 +00001063/// \brief Prepares a path for being written to an AST file by converting it
1064/// to an absolute path and removing nested './'s.
1065///
1066/// \return \c true if the path was changed.
Benjamin Kramer6a96ae52015-02-06 18:36:04 +00001067static bool cleanPathForOutput(FileManager &FileMgr,
1068 SmallVectorImpl<char> &Path) {
Richard Smith54cc3c22014-12-11 20:50:24 +00001069 bool Changed = false;
1070
1071 if (!llvm::sys::path::is_absolute(StringRef(Path.data(), Path.size()))) {
1072 llvm::sys::fs::make_absolute(Path);
1073 Changed = true;
1074 }
1075
1076 return Changed | FileMgr.removeDotPaths(Path);
1077}
1078
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001079/// \brief Adjusts the given filename to only write out the portion of the
1080/// filename that is not part of the system root directory.
Mike Stump11289f42009-09-09 15:08:12 +00001081///
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001082/// \param Filename the file name to adjust.
1083///
Richard Smith7ed1bc92014-12-05 22:42:13 +00001084/// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
1085/// the returned filename will be adjusted by this root directory.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001086///
1087/// \returns either the original filename (if it needs no adjustment) or the
1088/// adjusted filename (which points into the @p Filename parameter).
Mike Stump11289f42009-09-09 15:08:12 +00001089static const char *
Richard Smith7ed1bc92014-12-05 22:42:13 +00001090adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001091 assert(Filename && "No file name to adjust?");
Mike Stump11289f42009-09-09 15:08:12 +00001092
Richard Smith7ed1bc92014-12-05 22:42:13 +00001093 if (BaseDir.empty())
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001094 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001095
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001096 // Verify that the filename and the system root have the same prefix.
1097 unsigned Pos = 0;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001098 for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1099 if (Filename[Pos] != BaseDir[Pos])
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001100 return Filename; // Prefixes don't match.
Mike Stump11289f42009-09-09 15:08:12 +00001101
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001102 // We hit the end of the filename before we hit the end of the system root.
1103 if (!Filename[Pos])
1104 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001105
Richard Smith7ed1bc92014-12-05 22:42:13 +00001106 // If there's not a path separator at the end of the base directory nor
1107 // immediately after it, then this isn't within the base directory.
1108 if (!llvm::sys::path::is_separator(Filename[Pos])) {
1109 if (!llvm::sys::path::is_separator(BaseDir.back()))
1110 return Filename;
1111 } else {
1112 // If the file name has a '/' at the current position, skip over the '/'.
1113 // We distinguish relative paths from absolute paths by the
1114 // absence of '/' at the beginning of relative paths.
1115 //
1116 // FIXME: This is wrong. We distinguish them by asking if the path is
1117 // absolute, which isn't the same thing. And there might be multiple '/'s
1118 // in a row. Use a better mechanism to indicate whether we have emitted an
1119 // absolute or relative path.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001120 ++Pos;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001121 }
Mike Stump11289f42009-09-09 15:08:12 +00001122
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001123 return Filename + Pos;
1124}
Chris Lattner28fa4e62009-04-26 22:26:21 +00001125
Ben Langmuir487ea142014-10-23 18:05:36 +00001126static ASTFileSignature getSignature() {
1127 while (1) {
1128 if (ASTFileSignature S = llvm::sys::Process::GetRandomNumber())
1129 return S;
1130 // Rely on GetRandomNumber to eventually return non-zero...
1131 }
1132}
1133
Douglas Gregor112b9072012-10-18 05:31:06 +00001134/// \brief Write the control block.
Douglas Gregor2d302362012-10-24 16:50:34 +00001135void ASTWriter::WriteControlBlock(Preprocessor &PP, ASTContext &Context,
1136 StringRef isysroot,
Douglas Gregor112b9072012-10-18 05:31:06 +00001137 const std::string &OutputFile) {
Douglas Gregorbfbde532009-04-10 21:16:55 +00001138 using namespace llvm;
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001139 Stream.EnterSubblock(CONTROL_BLOCK_ID, 5);
1140 RecordData Record;
Douglas Gregor112b9072012-10-18 05:31:06 +00001141
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001142 // Metadata
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001143 BitCodeAbbrev *MetadataAbbrev = new BitCodeAbbrev();
1144 MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA));
1145 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1146 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1147 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1148 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1149 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
1150 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1151 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
1152 unsigned MetadataAbbrevCode = Stream.EmitAbbrev(MetadataAbbrev);
1153 Record.push_back(METADATA);
Sebastian Redl539c5062010-08-18 23:57:32 +00001154 Record.push_back(VERSION_MAJOR);
1155 Record.push_back(VERSION_MINOR);
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001156 Record.push_back(CLANG_VERSION_MAJOR);
1157 Record.push_back(CLANG_VERSION_MINOR);
Richard Smith7ed1bc92014-12-05 22:42:13 +00001158 assert((!WritingModule || isysroot.empty()) &&
1159 "writing module as a relocatable PCH?");
Douglas Gregorc567ba22011-07-22 16:35:34 +00001160 Record.push_back(!isysroot.empty());
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00001161 Record.push_back(ASTHasCompilerErrors);
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001162 Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record,
1163 getClangFullRepositoryVersion());
Douglas Gregor29cc6422011-08-17 21:07:30 +00001164
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001165 if (WritingModule) {
Chandler Carruth885e78c2015-03-24 21:18:10 +00001166 // For implicit modules we output a signature that we can use to ensure
1167 // duplicate module builds don't collide in the cache as their output order
1168 // is non-deterministic.
1169 // FIXME: Remove this when output is deterministic.
1170 if (Context.getLangOpts().ImplicitModules) {
1171 Record.clear();
1172 Record.push_back(getSignature());
1173 Stream.EmitRecord(SIGNATURE, Record);
1174 }
1175
Richard Smith7ed1bc92014-12-05 22:42:13 +00001176 // Module name
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001177 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1178 Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME));
1179 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
1180 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1181 RecordData Record;
1182 Record.push_back(MODULE_NAME);
1183 Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name);
1184 }
1185
Richard Smith7ed1bc92014-12-05 22:42:13 +00001186 if (WritingModule && WritingModule->Directory) {
1187 // Module directory.
1188 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1189 Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY));
1190 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
1191 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1192 RecordData Record;
1193 Record.push_back(MODULE_DIRECTORY);
1194
1195 SmallString<128> BaseDir(WritingModule->Directory->getName());
Richard Smith54cc3c22014-12-11 20:50:24 +00001196 cleanPathForOutput(Context.getSourceManager().getFileManager(), BaseDir);
Richard Smith7ed1bc92014-12-05 22:42:13 +00001197 Stream.EmitRecordWithBlob(AbbrevCode, Record, BaseDir);
1198
1199 // Write out all other paths relative to the base directory if possible.
1200 BaseDirectory.assign(BaseDir.begin(), BaseDir.end());
1201 } else if (!isysroot.empty()) {
1202 // Write out paths relative to the sysroot if possible.
1203 BaseDirectory = isysroot;
1204 }
1205
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001206 // Module map file
1207 if (WritingModule) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001208 Record.clear();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001209
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001210 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
1211
1212 // Primary module map file.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001213 AddPath(Map.getModuleMapFileForUniquing(WritingModule)->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001214
1215 // Additional module map files.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001216 if (auto *AdditionalModMaps =
1217 Map.getAdditionalModuleMapFiles(WritingModule)) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001218 Record.push_back(AdditionalModMaps->size());
1219 for (const FileEntry *F : *AdditionalModMaps)
Richard Smith7ed1bc92014-12-05 22:42:13 +00001220 AddPath(F->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001221 } else {
1222 Record.push_back(0);
1223 }
1224
1225 Stream.EmitRecord(MODULE_MAP_FILE, Record);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001226 }
1227
Douglas Gregor112b9072012-10-18 05:31:06 +00001228 // Imports
Douglas Gregor29cc6422011-08-17 21:07:30 +00001229 if (Chain) {
Douglas Gregor29cc6422011-08-17 21:07:30 +00001230 serialization::ModuleManager &Mgr = Chain->getModuleManager();
Douglas Gregor29cc6422011-08-17 21:07:30 +00001231 Record.clear();
Douglas Gregordf0c1512011-08-18 04:12:04 +00001232
Richard Smith7f330cd2015-03-18 01:42:29 +00001233 for (auto *M : Mgr) {
Douglas Gregordf0c1512011-08-18 04:12:04 +00001234 // Skip modules that weren't directly imported.
Richard Smith7f330cd2015-03-18 01:42:29 +00001235 if (!M->isDirectlyImported())
Douglas Gregordf0c1512011-08-18 04:12:04 +00001236 continue;
1237
Richard Smith7f330cd2015-03-18 01:42:29 +00001238 Record.push_back((unsigned)M->Kind); // FIXME: Stable encoding
1239 AddSourceLocation(M->ImportLoc, Record);
1240 Record.push_back(M->File->getSize());
1241 Record.push_back(M->File->getModificationTime());
1242 Record.push_back(M->Signature);
1243 AddPath(M->FileName, Record);
Douglas Gregordf0c1512011-08-18 04:12:04 +00001244 }
Douglas Gregor29cc6422011-08-17 21:07:30 +00001245 Stream.EmitRecord(IMPORTS, Record);
Richard Smith7f330cd2015-03-18 01:42:29 +00001246
1247 // Also emit a list of known module files that were not imported,
1248 // but are made available by this module.
1249 // FIXME: Should we also include a signature here?
1250 Record.clear();
1251 for (auto *E : Mgr.getAdditionalKnownModuleFiles())
1252 AddPath(E->getName(), Record);
1253 if (!Record.empty())
1254 Stream.EmitRecord(KNOWN_MODULE_FILES, Record);
Douglas Gregor29cc6422011-08-17 21:07:30 +00001255 }
Mike Stump11289f42009-09-09 15:08:12 +00001256
Douglas Gregor112b9072012-10-18 05:31:06 +00001257 // Language options.
1258 Record.clear();
1259 const LangOptions &LangOpts = Context.getLangOpts();
1260#define LANGOPT(Name, Bits, Default, Description) \
1261 Record.push_back(LangOpts.Name);
1262#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
1263 Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001264#include "clang/Basic/LangOptions.def"
1265#define SANITIZER(NAME, ID) \
1266 Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
Will Dietzf54319c2013-01-18 11:30:38 +00001267#include "clang/Basic/Sanitizers.def"
Douglas Gregor112b9072012-10-18 05:31:06 +00001268
Ben Langmuircd98cb72015-06-23 18:20:18 +00001269 Record.push_back(LangOpts.ModuleFeatures.size());
1270 for (StringRef Feature : LangOpts.ModuleFeatures)
1271 AddString(Feature, Record);
1272
Douglas Gregor112b9072012-10-18 05:31:06 +00001273 Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind());
1274 AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record);
Ben Langmuird4a667a2015-06-23 18:20:23 +00001275
1276 AddString(LangOpts.CurrentModule, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001277
1278 // Comment options.
1279 Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size());
1280 for (CommentOptions::BlockCommandNamesTy::const_iterator
1281 I = LangOpts.CommentOpts.BlockCommandNames.begin(),
1282 IEnd = LangOpts.CommentOpts.BlockCommandNames.end();
1283 I != IEnd; ++I) {
1284 AddString(*I, Record);
1285 }
Dmitri Gribenkoa7d16ce2013-04-10 15:35:17 +00001286 Record.push_back(LangOpts.CommentOpts.ParseAllComments);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001287
Douglas Gregor112b9072012-10-18 05:31:06 +00001288 Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1289
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001290 // Target options.
1291 Record.clear();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001292 const TargetInfo &Target = Context.getTargetInfo();
1293 const TargetOptions &TargetOpts = Target.getTargetOpts();
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001294 AddString(TargetOpts.Triple, Record);
1295 AddString(TargetOpts.CPU, Record);
1296 AddString(TargetOpts.ABI, Record);
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001297 Record.push_back(TargetOpts.FeaturesAsWritten.size());
1298 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1299 AddString(TargetOpts.FeaturesAsWritten[I], Record);
1300 }
1301 Record.push_back(TargetOpts.Features.size());
1302 for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1303 AddString(TargetOpts.Features[I], Record);
1304 }
1305 Stream.EmitRecord(TARGET_OPTIONS, Record);
1306
Douglas Gregor8263ffb2012-10-24 15:17:15 +00001307 // Diagnostic options.
1308 Record.clear();
1309 const DiagnosticOptions &DiagOpts
1310 = Context.getDiagnostics().getDiagnosticOptions();
1311#define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1312#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
1313 Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1314#include "clang/Basic/DiagnosticOptions.def"
1315 Record.push_back(DiagOpts.Warnings.size());
1316 for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1317 AddString(DiagOpts.Warnings[I], Record);
Richard Smith3be1cb22014-08-07 00:24:21 +00001318 Record.push_back(DiagOpts.Remarks.size());
1319 for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1320 AddString(DiagOpts.Remarks[I], Record);
Douglas Gregor8263ffb2012-10-24 15:17:15 +00001321 // Note: we don't serialize the log or serialization file names, because they
1322 // are generally transient files and will almost always be overridden.
1323 Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record);
1324
Douglas Gregorc6317db2012-10-24 15:49:58 +00001325 // File system options.
1326 Record.clear();
1327 const FileSystemOptions &FSOpts
1328 = Context.getSourceManager().getFileManager().getFileSystemOptions();
1329 AddString(FSOpts.WorkingDir, Record);
1330 Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record);
1331
Douglas Gregor2d302362012-10-24 16:50:34 +00001332 // Header search options.
1333 Record.clear();
1334 const HeaderSearchOptions &HSOpts
1335 = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1336 AddString(HSOpts.Sysroot, Record);
1337
1338 // Include entries.
1339 Record.push_back(HSOpts.UserEntries.size());
1340 for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1341 const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1342 AddString(Entry.Path, Record);
1343 Record.push_back(static_cast<unsigned>(Entry.Group));
Douglas Gregor2d302362012-10-24 16:50:34 +00001344 Record.push_back(Entry.IsFramework);
1345 Record.push_back(Entry.IgnoreSysRoot);
Douglas Gregor2d302362012-10-24 16:50:34 +00001346 }
1347
1348 // System header prefixes.
1349 Record.push_back(HSOpts.SystemHeaderPrefixes.size());
1350 for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1351 AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1352 Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1353 }
1354
1355 AddString(HSOpts.ResourceDir, Record);
1356 AddString(HSOpts.ModuleCachePath, Record);
Argyrios Kyrtzidis1594c152014-03-03 08:12:05 +00001357 AddString(HSOpts.ModuleUserBuildPath, Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001358 Record.push_back(HSOpts.DisableModuleHash);
1359 Record.push_back(HSOpts.UseBuiltinIncludes);
1360 Record.push_back(HSOpts.UseStandardSystemIncludes);
1361 Record.push_back(HSOpts.UseStandardCXXIncludes);
1362 Record.push_back(HSOpts.UseLibcxx);
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00001363 // Write out the specific module cache path that contains the module files.
1364 AddString(PP.getHeaderSearchInfo().getModuleCachePath(), Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001365 Stream.EmitRecord(HEADER_SEARCH_OPTIONS, Record);
1366
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001367 // Preprocessor options.
1368 Record.clear();
1369 const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts();
1370
1371 // Macro definitions.
1372 Record.push_back(PPOpts.Macros.size());
1373 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1374 AddString(PPOpts.Macros[I].first, Record);
1375 Record.push_back(PPOpts.Macros[I].second);
1376 }
1377
1378 // Includes
1379 Record.push_back(PPOpts.Includes.size());
1380 for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1381 AddString(PPOpts.Includes[I], Record);
1382
1383 // Macro includes
1384 Record.push_back(PPOpts.MacroIncludes.size());
1385 for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1386 AddString(PPOpts.MacroIncludes[I], Record);
1387
Douglas Gregorb6368752012-10-24 23:41:50 +00001388 Record.push_back(PPOpts.UsePredefines);
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +00001389 // Detailed record is important since it is used for the module cache hash.
1390 Record.push_back(PPOpts.DetailedRecord);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001391 AddString(PPOpts.ImplicitPCHInclude, Record);
1392 AddString(PPOpts.ImplicitPTHInclude, Record);
1393 Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1394 Stream.EmitRecord(PREPROCESSOR_OPTIONS, Record);
1395
Douglas Gregora3b20262011-05-06 21:43:30 +00001396 // Original file name and file ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001397 SourceManager &SM = Context.getSourceManager();
1398 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
1399 BitCodeAbbrev *FileAbbrev = new BitCodeAbbrev();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001400 FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE));
1401 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001402 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1403 unsigned FileAbbrevCode = Stream.EmitAbbrev(FileAbbrev);
1404
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001405 Record.clear();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001406 Record.push_back(ORIGINAL_FILE);
Douglas Gregora3b20262011-05-06 21:43:30 +00001407 Record.push_back(SM.getMainFileID().getOpaqueValue());
Richard Smith7ed1bc92014-12-05 22:42:13 +00001408 EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName());
Douglas Gregor45fe0362009-05-12 01:31:05 +00001409 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001410
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001411 Record.clear();
1412 Record.push_back(SM.getMainFileID().getOpaqueValue());
1413 Stream.EmitRecord(ORIGINAL_FILE_ID, Record);
1414
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001415 // Original PCH directory
1416 if (!OutputFile.empty() && OutputFile != "-") {
1417 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1418 Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR));
1419 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1420 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1421
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001422 SmallString<128> OutputPath(OutputFile);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001423
1424 llvm::sys::fs::make_absolute(OutputPath);
1425 StringRef origDir = llvm::sys::path::parent_path(OutputPath);
1426
1427 RecordData Record;
1428 Record.push_back(ORIGINAL_PCH_DIR);
1429 Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir);
1430 }
1431
Douglas Gregor49491f72013-03-15 22:15:07 +00001432 WriteInputFiles(Context.SourceMgr,
1433 PP.getHeaderSearchInfo().getHeaderSearchOpts(),
Douglas Gregora3dd9002013-07-22 20:48:33 +00001434 PP.getLangOpts().Modules);
Douglas Gregor72be3902012-10-19 00:38:02 +00001435 Stream.ExitBlock();
1436}
1437
Douglas Gregor49491f72013-03-15 22:15:07 +00001438namespace {
1439 /// \brief An input file.
1440 struct InputFileEntry {
1441 const FileEntry *File;
1442 bool IsSystemFile;
1443 bool BufferOverridden;
1444 };
1445}
1446
1447void ASTWriter::WriteInputFiles(SourceManager &SourceMgr,
1448 HeaderSearchOptions &HSOpts,
Douglas Gregora3dd9002013-07-22 20:48:33 +00001449 bool Modules) {
Douglas Gregor72be3902012-10-19 00:38:02 +00001450 using namespace llvm;
1451 Stream.EnterSubblock(INPUT_FILES_BLOCK_ID, 4);
1452 RecordData Record;
1453
1454 // Create input-file abbreviation.
1455 BitCodeAbbrev *IFAbbrev = new BitCodeAbbrev();
1456 IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001457 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor72be3902012-10-19 00:38:02 +00001458 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1459 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001460 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
Douglas Gregor72be3902012-10-19 00:38:02 +00001461 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1462 unsigned IFAbbrevCode = Stream.EmitAbbrev(IFAbbrev);
1463
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001464 // Get all ContentCache objects for files, sorted by whether the file is a
1465 // system one or not. System files go at the back, users files at the front.
Douglas Gregor49491f72013-03-15 22:15:07 +00001466 std::deque<InputFileEntry> SortedFiles;
Douglas Gregor72be3902012-10-19 00:38:02 +00001467 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
1468 // Get this source location entry.
1469 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
NAKAMURA Takumideca50f2012-10-19 01:53:57 +00001470 assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc);
Douglas Gregor72be3902012-10-19 00:38:02 +00001471
1472 // We only care about file entries that were not overridden.
1473 if (!SLoc->isFile())
1474 continue;
1475 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001476 if (!Cache->OrigEntry)
Douglas Gregor72be3902012-10-19 00:38:02 +00001477 continue;
1478
Douglas Gregor49491f72013-03-15 22:15:07 +00001479 InputFileEntry Entry;
1480 Entry.File = Cache->OrigEntry;
1481 Entry.IsSystemFile = Cache->IsSystemFile;
1482 Entry.BufferOverridden = Cache->BufferOverridden;
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001483 if (Cache->IsSystemFile)
Douglas Gregor49491f72013-03-15 22:15:07 +00001484 SortedFiles.push_back(Entry);
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001485 else
Douglas Gregor49491f72013-03-15 22:15:07 +00001486 SortedFiles.push_front(Entry);
1487 }
1488
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001489 unsigned UserFilesNum = 0;
1490 // Write out all of the input files.
Richard Smithec216502015-02-13 19:48:37 +00001491 std::vector<uint64_t> InputFileOffsets;
Douglas Gregor49491f72013-03-15 22:15:07 +00001492 for (std::deque<InputFileEntry>::iterator
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001493 I = SortedFiles.begin(), E = SortedFiles.end(); I != E; ++I) {
Douglas Gregor49491f72013-03-15 22:15:07 +00001494 const InputFileEntry &Entry = *I;
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001495
Douglas Gregor49491f72013-03-15 22:15:07 +00001496 uint32_t &InputFileID = InputFileIDs[Entry.File];
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001497 if (InputFileID != 0)
1498 continue; // already recorded this file.
1499
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001500 // Record this entry's offset.
1501 InputFileOffsets.push_back(Stream.GetCurrentBitNo());
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001502
1503 InputFileID = InputFileOffsets.size();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001504
Douglas Gregor49491f72013-03-15 22:15:07 +00001505 if (!Entry.IsSystemFile)
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001506 ++UserFilesNum;
1507
Douglas Gregor72be3902012-10-19 00:38:02 +00001508 Record.clear();
1509 Record.push_back(INPUT_FILE);
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001510 Record.push_back(InputFileOffsets.size());
Douglas Gregor72be3902012-10-19 00:38:02 +00001511
1512 // Emit size/modification time for this file.
Douglas Gregor49491f72013-03-15 22:15:07 +00001513 Record.push_back(Entry.File->getSize());
1514 Record.push_back(Entry.File->getModificationTime());
Douglas Gregor72be3902012-10-19 00:38:02 +00001515
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001516 // Whether this file was overridden.
Douglas Gregor49491f72013-03-15 22:15:07 +00001517 Record.push_back(Entry.BufferOverridden);
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001518
Richard Smith7ed1bc92014-12-05 22:42:13 +00001519 EmitRecordWithPath(IFAbbrevCode, Record, Entry.File->getName());
1520 }
Douglas Gregor49491f72013-03-15 22:15:07 +00001521
Douglas Gregor112b9072012-10-18 05:31:06 +00001522 Stream.ExitBlock();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001523
1524 // Create input file offsets abbreviation.
1525 BitCodeAbbrev *OffsetsAbbrev = new BitCodeAbbrev();
1526 OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1527 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001528 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1529 // input files
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001530 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Array
1531 unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(OffsetsAbbrev);
1532
1533 // Write input file offsets.
1534 Record.clear();
1535 Record.push_back(INPUT_FILE_OFFSETS);
1536 Record.push_back(InputFileOffsets.size());
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001537 Record.push_back(UserFilesNum);
Reid Kleckner012665e2015-05-21 00:13:09 +00001538 Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, bytes(InputFileOffsets));
Douglas Gregor55abb232009-04-10 20:39:37 +00001539}
1540
Douglas Gregora7f71a92009-04-10 03:52:48 +00001541//===----------------------------------------------------------------------===//
1542// Source Manager Serialization
1543//===----------------------------------------------------------------------===//
1544
1545/// \brief Create an abbreviation for the SLocEntry that refers to a
1546/// file.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001547static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001548 using namespace llvm;
1549 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001550 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001551 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1552 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1553 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1554 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
Douglas Gregorb41ca8f2010-03-21 22:49:54 +00001555 // FileEntry fields.
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001556 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001557 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001558 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
1559 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
Douglas Gregor8f45df52009-04-16 22:23:12 +00001560 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001561}
1562
1563/// \brief Create an abbreviation for the SLocEntry that refers to a
1564/// buffer.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001565static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001566 using namespace llvm;
1567 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001568 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001569 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1570 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1571 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1572 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1573 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
Douglas Gregor8f45df52009-04-16 22:23:12 +00001574 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001575}
1576
1577/// \brief Create an abbreviation for the SLocEntry that refers to a
1578/// buffer's blob.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001579static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001580 using namespace llvm;
1581 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001582 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_BLOB));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001583 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
Douglas Gregor8f45df52009-04-16 22:23:12 +00001584 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001585}
1586
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001587/// \brief Create an abbreviation for the SLocEntry that refers to a macro
1588/// expansion.
1589static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001590 using namespace llvm;
1591 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001592 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001593 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1594 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1595 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1596 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
Douglas Gregor83243272009-04-15 18:05:10 +00001597 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
Douglas Gregor8f45df52009-04-16 22:23:12 +00001598 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001599}
1600
Douglas Gregor09b69892011-02-10 17:09:37 +00001601namespace {
1602 // Trait used for the on-disk hash table of header search information.
1603 class HeaderFileInfoTrait {
1604 ASTWriter &Writer;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001605 const HeaderSearch &HS;
Douglas Gregor09b69892011-02-10 17:09:37 +00001606
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001607 // Keep track of the framework names we've used during serialization.
1608 SmallVector<char, 128> FrameworkStringData;
1609 llvm::StringMap<unsigned> FrameworkNameOffset;
1610
Douglas Gregor09b69892011-02-10 17:09:37 +00001611 public:
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001612 HeaderFileInfoTrait(ASTWriter &Writer, const HeaderSearch &HS)
1613 : Writer(Writer), HS(HS) { }
Douglas Gregor09b69892011-02-10 17:09:37 +00001614
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001615 struct key_type {
1616 const FileEntry *FE;
1617 const char *Filename;
1618 };
1619 typedef const key_type &key_type_ref;
Douglas Gregor09b69892011-02-10 17:09:37 +00001620
1621 typedef HeaderFileInfo data_type;
1622 typedef const data_type &data_type_ref;
Justin Bogner25463f12014-04-18 20:27:24 +00001623 typedef unsigned hash_value_type;
1624 typedef unsigned offset_type;
Douglas Gregor09b69892011-02-10 17:09:37 +00001625
Justin Bogner25463f12014-04-18 20:27:24 +00001626 static hash_value_type ComputeHash(key_type_ref key) {
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001627 // The hash is based only on size/time of the file, so that the reader can
1628 // match even when symlinking or excess path elements ("foo/../", "../")
1629 // change the form of the name. However, complete path is still the key.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001630 //
1631 // FIXME: Using the mtime here will cause problems for explicit module
1632 // imports.
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001633 return llvm::hash_combine(key.FE->getSize(),
1634 key.FE->getModificationTime());
Douglas Gregor09b69892011-02-10 17:09:37 +00001635 }
1636
1637 std::pair<unsigned,unsigned>
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001638 EmitKeyDataLength(raw_ostream& Out, key_type_ref key, data_type_ref Data) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001639 using namespace llvm::support;
1640 endian::Writer<little> Writer(Out);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001641 unsigned KeyLen = strlen(key.Filename) + 1 + 8 + 8;
Justin Bognere1c147c2014-03-28 22:03:19 +00001642 Writer.write<uint16_t>(KeyLen);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001643 unsigned DataLen = 1 + 2 + 4 + 4;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001644 if (Data.isModuleHeader)
1645 DataLen += 4;
Justin Bognere1c147c2014-03-28 22:03:19 +00001646 Writer.write<uint8_t>(DataLen);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001647 return std::make_pair(KeyLen, DataLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001648 }
1649
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001650 void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001651 using namespace llvm::support;
1652 endian::Writer<little> LE(Out);
1653 LE.write<uint64_t>(key.FE->getSize());
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001654 KeyLen -= 8;
Justin Bognere1c147c2014-03-28 22:03:19 +00001655 LE.write<uint64_t>(key.FE->getModificationTime());
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001656 KeyLen -= 8;
1657 Out.write(key.Filename, KeyLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001658 }
1659
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001660 void EmitData(raw_ostream &Out, key_type_ref key,
Douglas Gregor09b69892011-02-10 17:09:37 +00001661 data_type_ref Data, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001662 using namespace llvm::support;
1663 endian::Writer<little> LE(Out);
Douglas Gregor09b69892011-02-10 17:09:37 +00001664 uint64_t Start = Out.tell(); (void)Start;
1665
Lawrence Crowlb53e5482013-06-20 21:14:14 +00001666 unsigned char Flags = (Data.HeaderRole << 6)
1667 | (Data.isImport << 5)
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001668 | (Data.isPragmaOnce << 4)
1669 | (Data.DirInfo << 2)
1670 | (Data.Resolved << 1)
1671 | Data.IndexHeaderMapHeader;
Justin Bognere1c147c2014-03-28 22:03:19 +00001672 LE.write<uint8_t>(Flags);
1673 LE.write<uint16_t>(Data.NumIncludes);
Douglas Gregor09b69892011-02-10 17:09:37 +00001674
1675 if (!Data.ControllingMacro)
Justin Bognere1c147c2014-03-28 22:03:19 +00001676 LE.write<uint32_t>(Data.ControllingMacroID);
Douglas Gregor09b69892011-02-10 17:09:37 +00001677 else
Justin Bognere1c147c2014-03-28 22:03:19 +00001678 LE.write<uint32_t>(Writer.getIdentifierRef(Data.ControllingMacro));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001679
1680 unsigned Offset = 0;
1681 if (!Data.Framework.empty()) {
1682 // If this header refers into a framework, save the framework name.
1683 llvm::StringMap<unsigned>::iterator Pos
1684 = FrameworkNameOffset.find(Data.Framework);
1685 if (Pos == FrameworkNameOffset.end()) {
1686 Offset = FrameworkStringData.size() + 1;
1687 FrameworkStringData.append(Data.Framework.begin(),
1688 Data.Framework.end());
1689 FrameworkStringData.push_back(0);
1690
1691 FrameworkNameOffset[Data.Framework] = Offset;
1692 } else
1693 Offset = Pos->second;
1694 }
Justin Bognere1c147c2014-03-28 22:03:19 +00001695 LE.write<uint32_t>(Offset);
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001696
1697 if (Data.isModuleHeader) {
Lawrence Crowlb53e5482013-06-20 21:14:14 +00001698 Module *Mod = HS.findModuleForHeader(key.FE).getModule();
Justin Bognere1c147c2014-03-28 22:03:19 +00001699 LE.write<uint32_t>(Writer.getExistingSubmoduleID(Mod));
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001700 }
1701
Douglas Gregor09b69892011-02-10 17:09:37 +00001702 assert(Out.tell() - Start == DataLen && "Wrong data length");
1703 }
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001704
1705 const char *strings_begin() const { return FrameworkStringData.begin(); }
1706 const char *strings_end() const { return FrameworkStringData.end(); }
Douglas Gregor09b69892011-02-10 17:09:37 +00001707 };
1708} // end anonymous namespace
1709
1710/// \brief Write the header search block for the list of files that
1711///
1712/// \param HS The header search structure to save.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001713void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001714 SmallVector<const FileEntry *, 16> FilesByUID;
Douglas Gregor09b69892011-02-10 17:09:37 +00001715 HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
1716
1717 if (FilesByUID.size() > HS.header_file_size())
1718 FilesByUID.resize(HS.header_file_size());
1719
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001720 HeaderFileInfoTrait GeneratorTrait(*this, HS);
Justin Bognerbb094f02014-04-18 19:57:06 +00001721 llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001722 SmallVector<const char *, 4> SavedStrings;
Douglas Gregor09b69892011-02-10 17:09:37 +00001723 unsigned NumHeaderSearchEntries = 0;
1724 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
1725 const FileEntry *File = FilesByUID[UID];
1726 if (!File)
1727 continue;
1728
Argyrios Kyrtzidisf5ab0342011-11-13 22:08:39 +00001729 // Use HeaderSearch's getFileInfo to make sure we get the HeaderFileInfo
1730 // from the external source if it was not provided already.
Ben Langmuird285c502014-03-13 16:46:36 +00001731 HeaderFileInfo HFI;
1732 if (!HS.tryGetFileInfo(File, HFI) ||
1733 (HFI.External && Chain) ||
1734 (HFI.isModuleHeader && !HFI.isCompilingModuleHeader))
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +00001735 continue;
Douglas Gregor09b69892011-02-10 17:09:37 +00001736
Richard Smith7ed1bc92014-12-05 22:42:13 +00001737 // Massage the file path into an appropriate form.
Douglas Gregor09b69892011-02-10 17:09:37 +00001738 const char *Filename = File->getName();
Richard Smith7ed1bc92014-12-05 22:42:13 +00001739 SmallString<128> FilenameTmp(Filename);
1740 if (PreparePathForOutput(FilenameTmp)) {
1741 // If we performed any translation on the file name at all, we need to
1742 // save this string, since the generator will refer to it later.
1743 Filename = strdup(FilenameTmp.c_str());
Douglas Gregor09b69892011-02-10 17:09:37 +00001744 SavedStrings.push_back(Filename);
1745 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001746
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001747 HeaderFileInfoTrait::key_type key = { File, Filename };
1748 Generator.insert(key, HFI, GeneratorTrait);
Douglas Gregor09b69892011-02-10 17:09:37 +00001749 ++NumHeaderSearchEntries;
1750 }
1751
1752 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001753 SmallString<4096> TableData;
Douglas Gregor09b69892011-02-10 17:09:37 +00001754 uint32_t BucketOffset;
1755 {
Justin Bognere1c147c2014-03-28 22:03:19 +00001756 using namespace llvm::support;
Douglas Gregor09b69892011-02-10 17:09:37 +00001757 llvm::raw_svector_ostream Out(TableData);
1758 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00001759 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregor09b69892011-02-10 17:09:37 +00001760 BucketOffset = Generator.Emit(Out, GeneratorTrait);
1761 }
1762
1763 // Create a blob abbreviation
1764 using namespace llvm;
1765 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1766 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
1767 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1768 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001769 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor09b69892011-02-10 17:09:37 +00001770 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1771 unsigned TableAbbrev = Stream.EmitAbbrev(Abbrev);
1772
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001773 // Write the header search table
Douglas Gregor09b69892011-02-10 17:09:37 +00001774 RecordData Record;
1775 Record.push_back(HEADER_SEARCH_TABLE);
1776 Record.push_back(BucketOffset);
1777 Record.push_back(NumHeaderSearchEntries);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001778 Record.push_back(TableData.size());
1779 TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end());
Yaron Keren92e1b622015-03-18 10:17:07 +00001780 Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData);
Douglas Gregor09b69892011-02-10 17:09:37 +00001781
1782 // Free all of the strings we had to duplicate.
1783 for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
David Greenebae0e352013-01-15 22:09:43 +00001784 free(const_cast<char *>(SavedStrings[I]));
Douglas Gregor09b69892011-02-10 17:09:37 +00001785}
1786
Douglas Gregora7f71a92009-04-10 03:52:48 +00001787/// \brief Writes the block containing the serialized form of the
1788/// source manager.
1789///
1790/// TODO: We should probably use an on-disk hash table (stored in a
1791/// blob), indexed based on the file name, so that we only create
1792/// entries for files that we actually need. In the common case (no
1793/// errors), we probably won't have to create file entries for any of
1794/// the files in the AST.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00001795void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
Richard Smith7ed1bc92014-12-05 22:42:13 +00001796 const Preprocessor &PP) {
Douglas Gregor258ae542009-04-27 06:38:32 +00001797 RecordData Record;
1798
Chris Lattner0910e3b2009-04-10 17:16:57 +00001799 // Enter the source manager block.
Sebastian Redl539c5062010-08-18 23:57:32 +00001800 Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 3);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001801
1802 // Abbreviations for the various kinds of source-location entries.
Chris Lattnerc4976c732009-04-27 19:03:22 +00001803 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
1804 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
1805 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001806 unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001807
Douglas Gregor258ae542009-04-27 06:38:32 +00001808 // Write out the source location entry table. We skip the first
1809 // entry, which is always the same dummy entry.
Chris Lattner12d61d32009-04-27 19:01:47 +00001810 std::vector<uint32_t> SLocEntryOffsets;
Douglas Gregor258ae542009-04-27 06:38:32 +00001811 RecordData PreloadSLocs;
Douglas Gregor925296b2011-07-19 16:10:42 +00001812 SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1);
1813 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
Sebastian Redl5c415f32010-07-22 17:01:13 +00001814 I != N; ++I) {
Douglas Gregor8655e882009-10-16 22:46:09 +00001815 // Get this source location entry.
Douglas Gregor925296b2011-07-19 16:10:42 +00001816 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00001817 FileID FID = FileID::get(I);
1818 assert(&SourceMgr.getSLocEntry(FID) == SLoc);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001819
Douglas Gregor258ae542009-04-27 06:38:32 +00001820 // Record the offset of this source-location entry.
1821 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
1822
1823 // Figure out which record code to use.
1824 unsigned Code;
1825 if (SLoc->isFile()) {
Douglas Gregor9dc32122011-11-16 20:05:18 +00001826 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
1827 if (Cache->OrigEntry) {
Sebastian Redl539c5062010-08-18 23:57:32 +00001828 Code = SM_SLOC_FILE_ENTRY;
Argyrios Kyrtzidis92dd4662011-06-02 20:01:46 +00001829 } else
Sebastian Redl539c5062010-08-18 23:57:32 +00001830 Code = SM_SLOC_BUFFER_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00001831 } else
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001832 Code = SM_SLOC_EXPANSION_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00001833 Record.clear();
1834 Record.push_back(Code);
1835
Douglas Gregor925296b2011-07-19 16:10:42 +00001836 // Starting offset of this entry within this module, so skip the dummy.
1837 Record.push_back(SLoc->getOffset() - 2);
Douglas Gregor258ae542009-04-27 06:38:32 +00001838 if (SLoc->isFile()) {
1839 const SrcMgr::FileInfo &File = SLoc->getFile();
1840 Record.push_back(File.getIncludeLoc().getRawEncoding());
1841 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
1842 Record.push_back(File.hasLineDirectives());
1843
1844 const SrcMgr::ContentCache *Content = File.getContentCache();
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00001845 if (Content->OrigEntry) {
1846 assert(Content->OrigEntry == Content->ContentsEntry &&
Douglas Gregor9dc32122011-11-16 20:05:18 +00001847 "Writing to AST an overridden file is not supported");
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00001848
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001849 // The source location entry is a file. Emit input file ID.
1850 assert(InputFileIDs[Content->OrigEntry] != 0 && "Missed file entry");
1851 Record.push_back(InputFileIDs[Content->OrigEntry]);
Mike Stump11289f42009-09-09 15:08:12 +00001852
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001853 Record.push_back(File.NumCreatedFIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001854
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00001855 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001856 if (FDI != FileDeclIDs.end()) {
1857 Record.push_back(FDI->second->FirstDeclIndex);
1858 Record.push_back(FDI->second->DeclIDs.size());
1859 } else {
1860 Record.push_back(0);
1861 Record.push_back(0);
1862 }
Douglas Gregor9dc32122011-11-16 20:05:18 +00001863
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001864 Stream.EmitRecordWithAbbrev(SLocFileAbbrv, Record);
Douglas Gregor9dc32122011-11-16 20:05:18 +00001865
1866 if (Content->BufferOverridden) {
1867 Record.clear();
1868 Record.push_back(SM_SLOC_BUFFER_BLOB);
1869 const llvm::MemoryBuffer *Buffer
1870 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
1871 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record,
1872 StringRef(Buffer->getBufferStart(),
1873 Buffer->getBufferSize() + 1));
1874 }
Douglas Gregor258ae542009-04-27 06:38:32 +00001875 } else {
1876 // The source location entry is a buffer. The blob associated
1877 // with this entry contains the contents of the buffer.
1878
1879 // We add one to the size so that we capture the trailing NULL
1880 // that is required by llvm::MemoryBuffer::getMemBuffer (on
1881 // the reader side).
Douglas Gregor874cc622010-03-16 00:35:39 +00001882 const llvm::MemoryBuffer *Buffer
Chris Lattnerfb24a3a2010-04-20 20:35:58 +00001883 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
Douglas Gregor258ae542009-04-27 06:38:32 +00001884 const char *Name = Buffer->getBufferIdentifier();
Daniel Dunbar8100d012009-08-24 09:31:37 +00001885 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001886 StringRef(Name, strlen(Name) + 1));
Douglas Gregor258ae542009-04-27 06:38:32 +00001887 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00001888 Record.push_back(SM_SLOC_BUFFER_BLOB);
Douglas Gregor258ae542009-04-27 06:38:32 +00001889 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001890 StringRef(Buffer->getBufferStart(),
Daniel Dunbar8100d012009-08-24 09:31:37 +00001891 Buffer->getBufferSize() + 1));
Douglas Gregor258ae542009-04-27 06:38:32 +00001892
Douglas Gregor925296b2011-07-19 16:10:42 +00001893 if (strcmp(Name, "<built-in>") == 0) {
1894 PreloadSLocs.push_back(SLocEntryOffsets.size());
1895 }
Douglas Gregor258ae542009-04-27 06:38:32 +00001896 }
1897 } else {
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001898 // The source location entry is a macro expansion.
Chandler Carruthee4c1d12011-07-26 04:56:51 +00001899 const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
Chandler Carruth73ee5d72011-07-26 04:41:47 +00001900 Record.push_back(Expansion.getSpellingLoc().getRawEncoding());
1901 Record.push_back(Expansion.getExpansionLocStart().getRawEncoding());
Argyrios Kyrtzidisa1d943a2011-08-17 00:31:14 +00001902 Record.push_back(Expansion.isMacroArgExpansion() ? 0
1903 : Expansion.getExpansionLocEnd().getRawEncoding());
Douglas Gregor258ae542009-04-27 06:38:32 +00001904
1905 // Compute the token length for this macro expansion.
Douglas Gregor925296b2011-07-19 16:10:42 +00001906 unsigned NextOffset = SourceMgr.getNextLocalOffset();
Douglas Gregor8655e882009-10-16 22:46:09 +00001907 if (I + 1 != N)
Douglas Gregor925296b2011-07-19 16:10:42 +00001908 NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset();
Douglas Gregor258ae542009-04-27 06:38:32 +00001909 Record.push_back(NextOffset - SLoc->getOffset() - 1);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001910 Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00001911 }
1912 }
1913
Douglas Gregor8f45df52009-04-16 22:23:12 +00001914 Stream.ExitBlock();
Douglas Gregor258ae542009-04-27 06:38:32 +00001915
1916 if (SLocEntryOffsets.empty())
1917 return;
1918
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00001919 // Write the source-location offsets table into the AST block. This
Douglas Gregor258ae542009-04-27 06:38:32 +00001920 // table is used for lazily loading source-location information.
1921 using namespace llvm;
1922 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001923 Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
Douglas Gregor258ae542009-04-27 06:38:32 +00001924 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
Douglas Gregor925296b2011-07-19 16:10:42 +00001925 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
Douglas Gregor258ae542009-04-27 06:38:32 +00001926 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
1927 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(Abbrev);
Mike Stump11289f42009-09-09 15:08:12 +00001928
Douglas Gregor258ae542009-04-27 06:38:32 +00001929 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00001930 Record.push_back(SOURCE_LOCATION_OFFSETS);
Douglas Gregor258ae542009-04-27 06:38:32 +00001931 Record.push_back(SLocEntryOffsets.size());
Douglas Gregor925296b2011-07-19 16:10:42 +00001932 Record.push_back(SourceMgr.getNextLocalOffset() - 1); // skip dummy
Reid Kleckner012665e2015-05-21 00:13:09 +00001933 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record, bytes(SLocEntryOffsets));
Douglas Gregor258ae542009-04-27 06:38:32 +00001934
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00001935 // Write the source location entry preloads array, telling the AST
Douglas Gregor258ae542009-04-27 06:38:32 +00001936 // reader which source locations entries it should load eagerly.
Sebastian Redl539c5062010-08-18 23:57:32 +00001937 Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
Douglas Gregor925296b2011-07-19 16:10:42 +00001938
1939 // Write the line table. It depends on remapping working, so it must come
1940 // after the source location offsets.
1941 if (SourceMgr.hasLineTable()) {
1942 LineTableInfo &LineTable = SourceMgr.getLineTable();
1943
1944 Record.clear();
Richard Smith7ed1bc92014-12-05 22:42:13 +00001945 // Emit the file names.
Douglas Gregor925296b2011-07-19 16:10:42 +00001946 Record.push_back(LineTable.getNumFilenames());
Richard Smith7ed1bc92014-12-05 22:42:13 +00001947 for (unsigned I = 0, N = LineTable.getNumFilenames(); I != N; ++I)
1948 AddPath(LineTable.getFilename(I), Record);
Douglas Gregor925296b2011-07-19 16:10:42 +00001949
1950 // Emit the line entries
1951 for (LineTableInfo::iterator L = LineTable.begin(), LEnd = LineTable.end();
1952 L != LEnd; ++L) {
1953 // Only emit entries for local files.
Douglas Gregor02c2dbf2012-06-08 16:40:28 +00001954 if (L->first.ID < 0)
Douglas Gregor925296b2011-07-19 16:10:42 +00001955 continue;
1956
1957 // Emit the file ID
Douglas Gregor02c2dbf2012-06-08 16:40:28 +00001958 Record.push_back(L->first.ID);
Douglas Gregor925296b2011-07-19 16:10:42 +00001959
1960 // Emit the line entries
1961 Record.push_back(L->second.size());
1962 for (std::vector<LineEntry>::iterator LE = L->second.begin(),
1963 LEEnd = L->second.end();
1964 LE != LEEnd; ++LE) {
1965 Record.push_back(LE->FileOffset);
1966 Record.push_back(LE->LineNo);
1967 Record.push_back(LE->FilenameID);
1968 Record.push_back((unsigned)LE->FileKind);
1969 Record.push_back(LE->IncludeOffset);
1970 }
1971 }
1972 Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record);
1973 }
Douglas Gregora7f71a92009-04-10 03:52:48 +00001974}
1975
Douglas Gregorc5046832009-04-27 18:38:38 +00001976//===----------------------------------------------------------------------===//
1977// Preprocessor Serialization
1978//===----------------------------------------------------------------------===//
1979
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00001980static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule,
1981 const Preprocessor &PP) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00001982 if (MacroInfo *MI = MD->getMacroInfo())
1983 if (MI->isBuiltinMacro())
1984 return true;
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00001985
1986 if (IsModule) {
1987 SourceLocation Loc = MD->getLocation();
1988 if (Loc.isInvalid())
1989 return true;
1990 if (PP.getSourceManager().getFileID(Loc) == PP.getPredefinesFileID())
1991 return true;
1992 }
1993
1994 return false;
1995}
1996
Chris Lattnereeffaef2009-04-10 17:15:23 +00001997/// \brief Writes the block containing the serialized form of the
1998/// preprocessor.
1999///
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00002000void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002001 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
2002 if (PPRec)
2003 WritePreprocessorDetail(*PPRec);
2004
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002005 RecordData Record;
Richard Smithd7329392015-04-21 21:46:32 +00002006 RecordData ModuleMacroRecord;
Chris Lattner0910e3b2009-04-10 17:16:57 +00002007
Chris Lattner0af3ba12009-04-13 01:29:17 +00002008 // If the preprocessor __COUNTER__ value has been bumped, remember it.
2009 if (PP.getCounterValue() != 0) {
2010 Record.push_back(PP.getCounterValue());
Sebastian Redl539c5062010-08-18 23:57:32 +00002011 Stream.EmitRecord(PP_COUNTER_VALUE, Record);
Chris Lattner0af3ba12009-04-13 01:29:17 +00002012 Record.clear();
Douglas Gregoreda6a892009-04-26 00:07:37 +00002013 }
2014
2015 // Enter the preprocessor block.
Douglas Gregor796d76a2010-10-20 22:00:55 +00002016 Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +00002017
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002018 // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
Douglas Gregoreda6a892009-04-26 00:07:37 +00002019 // FIXME: use diagnostics subsystem for localization etc.
2020 if (PP.SawDateOrTime())
2021 fprintf(stderr, "warning: precompiled header used __DATE__ or __TIME__.\n");
Mike Stump11289f42009-09-09 15:08:12 +00002022
Douglas Gregor796d76a2010-10-20 22:00:55 +00002023
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002024 // Loop over all the macro directives that are live at the end of the file,
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002025 // emitting each to the PP section.
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002026
Richard Smithee977932015-05-01 21:22:17 +00002027 // Construct the list of identifiers with macro directives that need to be
2028 // serialized.
2029 SmallVector<const IdentifierInfo *, 128> MacroIdentifiers;
2030 for (auto &Id : PP.getIdentifierTable())
2031 if (Id.second->hadMacroDefinition() &&
2032 (!Id.second->isFromAST() ||
2033 Id.second->hasChangedSinceDeserialization()))
2034 MacroIdentifiers.push_back(Id.second);
Douglas Gregor2e5571d2011-02-10 18:20:09 +00002035 // Sort the set of macro definitions that need to be serialized by the
2036 // name of the macro, to provide a stable ordering.
Richard Smithee977932015-05-01 21:22:17 +00002037 std::sort(MacroIdentifiers.begin(), MacroIdentifiers.end(),
2038 llvm::less_ptr<IdentifierInfo>());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002039
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002040 // Emit the macro directives as a list and associate the offset with the
2041 // identifier they belong to.
Richard Smithee977932015-05-01 21:22:17 +00002042 for (const IdentifierInfo *Name : MacroIdentifiers) {
2043 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(Name);
Richard Smithd7329392015-04-21 21:46:32 +00002044 auto StartOffset = Stream.GetCurrentBitNo();
2045
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002046 // Emit the macro directives in reverse source order.
2047 for (; MD; MD = MD->getPrevious()) {
Richard Smithd7329392015-04-21 21:46:32 +00002048 // Once we hit an ignored macro, we're done: the rest of the chain
2049 // will all be ignored macros.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002050 if (shouldIgnoreMacro(MD, IsModule, PP))
Richard Smithd7329392015-04-21 21:46:32 +00002051 break;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002052
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002053 AddSourceLocation(MD->getLocation(), Record);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002054 Record.push_back(MD->getKind());
Richard Smithdaa69e02014-07-25 04:40:03 +00002055 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
Richard Smith3981b172015-04-30 02:16:23 +00002056 Record.push_back(getMacroRef(DefMD->getInfo(), Name));
Richard Smith713369b2015-04-23 20:40:50 +00002057 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002058 Record.push_back(VisMD->isPublic());
2059 }
Richard Smithb8b2ed62015-04-23 18:18:26 +00002060 }
Richard Smithd7329392015-04-21 21:46:32 +00002061
Richard Smithb8b2ed62015-04-23 18:18:26 +00002062 // Write out any exported module macros.
Richard Smithee977932015-05-01 21:22:17 +00002063 bool EmittedModuleMacros = false;
Richard Smithb8b2ed62015-04-23 18:18:26 +00002064 if (IsModule) {
2065 auto Leafs = PP.getLeafModuleMacros(Name);
2066 SmallVector<ModuleMacro*, 8> Worklist(Leafs.begin(), Leafs.end());
2067 llvm::DenseMap<ModuleMacro*, unsigned> Visits;
2068 while (!Worklist.empty()) {
2069 auto *Macro = Worklist.pop_back_val();
Richard Smithd7329392015-04-21 21:46:32 +00002070
Richard Smithb8b2ed62015-04-23 18:18:26 +00002071 // Emit a record indicating this submodule exports this macro.
2072 ModuleMacroRecord.push_back(
2073 getSubmoduleID(Macro->getOwningModule()));
Richard Smithee977932015-05-01 21:22:17 +00002074 ModuleMacroRecord.push_back(getMacroRef(Macro->getMacroInfo(), Name));
Richard Smithb8b2ed62015-04-23 18:18:26 +00002075 for (auto *M : Macro->overrides())
2076 ModuleMacroRecord.push_back(getSubmoduleID(M->getOwningModule()));
Richard Smithd7329392015-04-21 21:46:32 +00002077
Richard Smithb8b2ed62015-04-23 18:18:26 +00002078 Stream.EmitRecord(PP_MODULE_MACRO, ModuleMacroRecord);
2079 ModuleMacroRecord.clear();
Richard Smithd7329392015-04-21 21:46:32 +00002080
Richard Smithb8b2ed62015-04-23 18:18:26 +00002081 // Enqueue overridden macros once we've visited all their ancestors.
2082 for (auto *M : Macro->overrides())
2083 if (++Visits[M] == M->getNumOverridingMacros())
2084 Worklist.push_back(M);
Richard Smithee977932015-05-01 21:22:17 +00002085
2086 EmittedModuleMacros = true;
Richard Smithd7329392015-04-21 21:46:32 +00002087 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002088 }
Richard Smithd7329392015-04-21 21:46:32 +00002089
Richard Smithee977932015-05-01 21:22:17 +00002090 if (Record.empty() && !EmittedModuleMacros)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002091 continue;
2092
Richard Smithd7329392015-04-21 21:46:32 +00002093 IdentMacroDirectivesOffsetMap[Name] = StartOffset;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002094 Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, Record);
2095 Record.clear();
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002096 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00002097
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002098 /// \brief Offsets of each of the macros into the bitstream, indexed by
2099 /// the local macro ID
2100 ///
2101 /// For each identifier that is associated with a macro, this map
2102 /// provides the offset into the bitstream where that macro is
2103 /// defined.
2104 std::vector<uint32_t> MacroOffsets;
2105
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002106 for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) {
2107 const IdentifierInfo *Name = MacroInfosToEmit[I].Name;
2108 MacroInfo *MI = MacroInfosToEmit[I].MI;
2109 MacroID ID = MacroInfosToEmit[I].ID;
Douglas Gregoreb114da2010-10-01 01:03:07 +00002110
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002111 if (ID < FirstMacroID) {
2112 assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?");
2113 continue;
Chris Lattner2199f5b2009-04-10 18:08:30 +00002114 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002115
2116 // Record the local offset of this macro.
2117 unsigned Index = ID - FirstMacroID;
2118 if (Index == MacroOffsets.size())
2119 MacroOffsets.push_back(Stream.GetCurrentBitNo());
2120 else {
2121 if (Index > MacroOffsets.size())
2122 MacroOffsets.resize(Index + 1);
2123
2124 MacroOffsets[Index] = Stream.GetCurrentBitNo();
2125 }
2126
2127 AddIdentifierRef(Name, Record);
2128 Record.push_back(inferSubmoduleIDFromLocation(MI->getDefinitionLoc()));
2129 AddSourceLocation(MI->getDefinitionLoc(), Record);
2130 AddSourceLocation(MI->getDefinitionEndLoc(), Record);
2131 Record.push_back(MI->isUsed());
Argyrios Kyrtzidis9ef53ce2014-04-09 18:21:23 +00002132 Record.push_back(MI->isUsedForHeaderGuard());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002133 unsigned Code;
2134 if (MI->isObjectLike()) {
2135 Code = PP_MACRO_OBJECT_LIKE;
2136 } else {
2137 Code = PP_MACRO_FUNCTION_LIKE;
2138
2139 Record.push_back(MI->isC99Varargs());
2140 Record.push_back(MI->isGNUVarargs());
2141 Record.push_back(MI->hasCommaPasting());
2142 Record.push_back(MI->getNumArgs());
Daniel Marjamakie4770da2015-05-29 09:15:24 +00002143 for (const IdentifierInfo *Arg : MI->args())
2144 AddIdentifierRef(Arg, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002145 }
2146
2147 // If we have a detailed preprocessing record, record the macro definition
2148 // ID that corresponds to this macro.
2149 if (PPRec)
2150 Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2151
2152 Stream.EmitRecord(Code, Record);
2153 Record.clear();
2154
2155 // Emit the tokens array.
2156 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
2157 // Note that we know that the preprocessor does not have any annotation
2158 // tokens in it because they are created by the parser, and thus can't
2159 // be in a macro definition.
2160 const Token &Tok = MI->getReplacementToken(TokNo);
John McCallf413f5e2013-05-03 00:10:13 +00002161 AddToken(Tok, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002162 Stream.EmitRecord(PP_TOKEN, Record);
2163 Record.clear();
2164 }
2165 ++NumMacros;
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002166 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002167
Douglas Gregor92a96f52011-02-08 21:58:10 +00002168 Stream.ExitBlock();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002169
2170 // Write the offsets table for macro IDs.
2171 using namespace llvm;
Richard Smith13090a22015-04-10 02:02:24 +00002172 auto *Abbrev = new BitCodeAbbrev();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002173 Abbrev->Add(BitCodeAbbrevOp(MACRO_OFFSET));
2174 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2175 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2176 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2177
2178 unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2179 Record.clear();
2180 Record.push_back(MACRO_OFFSET);
2181 Record.push_back(MacroOffsets.size());
2182 Record.push_back(FirstMacroID - NUM_PREDEF_MACRO_IDS);
2183 Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002184 bytes(MacroOffsets));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002185}
2186
2187void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) {
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002188 if (PPRec.local_begin() == PPRec.local_end())
Douglas Gregor92a96f52011-02-08 21:58:10 +00002189 return;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002190
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +00002191 SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002192
Douglas Gregor92a96f52011-02-08 21:58:10 +00002193 // Enter the preprocessor block.
2194 Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002195
Douglas Gregoraae92242010-03-19 21:51:54 +00002196 // If the preprocessor has a preprocessing record, emit it.
2197 unsigned NumPreprocessingRecords = 0;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002198 using namespace llvm;
2199
2200 // Set up the abbreviation for
2201 unsigned InclusionAbbrev = 0;
2202 {
2203 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2204 Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002205 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2206 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2207 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002208 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
Douglas Gregor92a96f52011-02-08 21:58:10 +00002209 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2210 InclusionAbbrev = Stream.EmitAbbrev(Abbrev);
2211 }
2212
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002213 unsigned FirstPreprocessorEntityID
2214 = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0)
2215 + NUM_PREDEF_PP_ENTITY_IDS;
2216 unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002217 RecordData Record;
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002218 for (PreprocessingRecord::iterator E = PPRec.local_begin(),
2219 EEnd = PPRec.local_end();
Douglas Gregor0d4b4312011-08-04 17:06:18 +00002220 E != EEnd;
2221 (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002222 Record.clear();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002223
Richard Smith66a81862015-05-04 02:25:31 +00002224 PreprocessedEntityOffsets.push_back(
2225 PPEntityOffset((*E)->getSourceRange(), Stream.GetCurrentBitNo()));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002226
Richard Smith66a81862015-05-04 02:25:31 +00002227 if (MacroDefinitionRecord *MD = dyn_cast<MacroDefinitionRecord>(*E)) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002228 // Record this macro definition's ID.
2229 MacroDefinitions[MD] = NextPreprocessorEntityID;
Richard Smith66a81862015-05-04 02:25:31 +00002230
Douglas Gregor92a96f52011-02-08 21:58:10 +00002231 AddIdentifierRef(MD->getName(), Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002232 Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
2233 continue;
Douglas Gregoraae92242010-03-19 21:51:54 +00002234 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002235
Chandler Carrutha88a22182011-07-14 08:20:46 +00002236 if (MacroExpansion *ME = dyn_cast<MacroExpansion>(*E)) {
Argyrios Kyrtzidis80f78b92011-09-08 17:18:41 +00002237 Record.push_back(ME->isBuiltinMacro());
2238 if (ME->isBuiltinMacro())
2239 AddIdentifierRef(ME->getName(), Record);
2240 else
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002241 Record.push_back(MacroDefinitions[ME->getDefinition()]);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002242 Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002243 continue;
2244 }
2245
2246 if (InclusionDirective *ID = dyn_cast<InclusionDirective>(*E)) {
2247 Record.push_back(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002248 Record.push_back(ID->getFileName().size());
2249 Record.push_back(ID->wasInQuotes());
2250 Record.push_back(static_cast<unsigned>(ID->getKind()));
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002251 Record.push_back(ID->importedModule());
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002252 SmallString<64> Buffer;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002253 Buffer += ID->getFileName();
Argyrios Kyrtzidis8dbcfc32012-03-08 01:08:28 +00002254 // Check that the FileEntry is not null because it was not resolved and
2255 // we create a PCH even with compiler errors.
2256 if (ID->getFile())
2257 Buffer += ID->getFile()->getName();
Douglas Gregor92a96f52011-02-08 21:58:10 +00002258 Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
2259 continue;
2260 }
2261
2262 llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
2263 }
Douglas Gregor8f45df52009-04-16 22:23:12 +00002264 Stream.ExitBlock();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002265
Douglas Gregoraae92242010-03-19 21:51:54 +00002266 // Write the offsets table for the preprocessing record.
2267 if (NumPreprocessingRecords > 0) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002268 assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
2269
Douglas Gregoraae92242010-03-19 21:51:54 +00002270 // Write the offsets table for identifier IDs.
2271 using namespace llvm;
2272 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002273 Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002274 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity
Douglas Gregoraae92242010-03-19 21:51:54 +00002275 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002276 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002277
Douglas Gregoraae92242010-03-19 21:51:54 +00002278 Record.clear();
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002279 Record.push_back(PPD_ENTITIES_OFFSETS);
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002280 Record.push_back(FirstPreprocessorEntityID - NUM_PREDEF_PP_ENTITY_IDS);
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002281 Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002282 bytes(PreprocessedEntityOffsets));
Douglas Gregoraae92242010-03-19 21:51:54 +00002283 }
Chris Lattnereeffaef2009-04-10 17:15:23 +00002284}
2285
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002286unsigned ASTWriter::getSubmoduleID(Module *Mod) {
2287 llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod);
2288 if (Known != SubmoduleIDs.end())
2289 return Known->second;
2290
2291 return SubmoduleIDs[Mod] = NextSubmoduleID++;
2292}
2293
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002294unsigned ASTWriter::getExistingSubmoduleID(Module *Mod) const {
2295 if (!Mod)
2296 return 0;
2297
2298 llvm::DenseMap<Module *, unsigned>::const_iterator
2299 Known = SubmoduleIDs.find(Mod);
2300 if (Known != SubmoduleIDs.end())
2301 return Known->second;
2302
2303 return 0;
2304}
2305
Douglas Gregor253eefe2011-12-01 00:59:36 +00002306/// \brief Compute the number of modules within the given tree (including the
2307/// given module).
2308static unsigned getNumberOfModules(Module *Mod) {
2309 unsigned ChildModules = 0;
Douglas Gregoreb90e832012-01-04 23:32:19 +00002310 for (Module::submodule_iterator Sub = Mod->submodule_begin(),
2311 SubEnd = Mod->submodule_end();
Douglas Gregor253eefe2011-12-01 00:59:36 +00002312 Sub != SubEnd; ++Sub)
Douglas Gregoreb90e832012-01-04 23:32:19 +00002313 ChildModules += getNumberOfModules(*Sub);
Douglas Gregor253eefe2011-12-01 00:59:36 +00002314
2315 return ChildModules + 1;
2316}
2317
Douglas Gregorde3ef502011-11-30 23:21:26 +00002318void ASTWriter::WriteSubmodules(Module *WritingModule) {
Douglas Gregor69021972011-11-30 17:33:56 +00002319 // Enter the submodule description block.
Richard Smith202210b2014-10-24 20:23:01 +00002320 Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/5);
Douglas Gregor69021972011-11-30 17:33:56 +00002321
2322 // Write the abbreviations needed for the submodules block.
2323 using namespace llvm;
2324 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2325 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002326 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor69021972011-11-30 17:33:56 +00002327 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
2328 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2329 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
Richard Smith9bca2982014-03-08 00:03:56 +00002330 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
2331 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
Douglas Gregora686e1b2012-01-27 19:52:33 +00002332 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
Douglas Gregor73441092011-12-05 22:27:44 +00002333 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
Douglas Gregor73441092011-12-05 22:27:44 +00002334 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002335 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
Douglas Gregor69021972011-11-30 17:33:56 +00002336 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2337 unsigned DefinitionAbbrev = Stream.EmitAbbrev(Abbrev);
2338
2339 Abbrev = new BitCodeAbbrev();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002340 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
Douglas Gregor69021972011-11-30 17:33:56 +00002341 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2342 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(Abbrev);
2343
2344 Abbrev = new BitCodeAbbrev();
2345 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
2346 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2347 unsigned HeaderAbbrev = Stream.EmitAbbrev(Abbrev);
Douglas Gregor524e33e2011-12-08 19:11:24 +00002348
2349 Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002350 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
2351 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2352 unsigned TopHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2353
2354 Abbrev = new BitCodeAbbrev();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002355 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
2356 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2357 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(Abbrev);
2358
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002359 Abbrev = new BitCodeAbbrev();
2360 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES));
Richard Smitha3feee22013-10-28 22:18:19 +00002361 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
2362 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Feature
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002363 unsigned RequiresAbbrev = Stream.EmitAbbrev(Abbrev);
2364
Douglas Gregor59527662012-10-15 06:28:11 +00002365 Abbrev = new BitCodeAbbrev();
2366 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
2367 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2368 unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2369
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002370 Abbrev = new BitCodeAbbrev();
Richard Smith306d8922014-10-22 23:50:56 +00002371 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
2372 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2373 unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2374
2375 Abbrev = new BitCodeAbbrev();
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002376 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
2377 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2378 unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2379
2380 Abbrev = new BitCodeAbbrev();
Richard Smith202210b2014-10-24 20:23:01 +00002381 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
2382 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2383 unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2384
2385 Abbrev = new BitCodeAbbrev();
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002386 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
2387 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2388 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2389 unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(Abbrev);
2390
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002391 Abbrev = new BitCodeAbbrev();
2392 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
2393 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
2394 unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(Abbrev);
2395
Douglas Gregorfb912652013-03-20 21:10:35 +00002396 Abbrev = new BitCodeAbbrev();
2397 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT));
2398 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Other module
2399 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Message
2400 unsigned ConflictAbbrev = Stream.EmitAbbrev(Abbrev);
2401
Douglas Gregor253eefe2011-12-01 00:59:36 +00002402 // Write the submodule metadata block.
2403 RecordData Record;
2404 Record.push_back(getNumberOfModules(WritingModule));
2405 Record.push_back(FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS);
2406 Stream.EmitRecord(SUBMODULE_METADATA, Record);
2407
Douglas Gregor69021972011-11-30 17:33:56 +00002408 // Write all of the submodules.
Douglas Gregorde3ef502011-11-30 23:21:26 +00002409 std::queue<Module *> Q;
Douglas Gregor69021972011-11-30 17:33:56 +00002410 Q.push(WritingModule);
Douglas Gregor69021972011-11-30 17:33:56 +00002411 while (!Q.empty()) {
Douglas Gregorde3ef502011-11-30 23:21:26 +00002412 Module *Mod = Q.front();
Douglas Gregor69021972011-11-30 17:33:56 +00002413 Q.pop();
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002414 unsigned ID = getSubmoduleID(Mod);
Douglas Gregor69021972011-11-30 17:33:56 +00002415
2416 // Emit the definition of the block.
2417 Record.clear();
2418 Record.push_back(SUBMODULE_DEFINITION);
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002419 Record.push_back(ID);
Douglas Gregor69021972011-11-30 17:33:56 +00002420 if (Mod->Parent) {
2421 assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
2422 Record.push_back(SubmoduleIDs[Mod->Parent]);
2423 } else {
2424 Record.push_back(0);
2425 }
2426 Record.push_back(Mod->IsFramework);
2427 Record.push_back(Mod->IsExplicit);
Douglas Gregora686e1b2012-01-27 19:52:33 +00002428 Record.push_back(Mod->IsSystem);
Richard Smith9bca2982014-03-08 00:03:56 +00002429 Record.push_back(Mod->IsExternC);
Douglas Gregor73441092011-12-05 22:27:44 +00002430 Record.push_back(Mod->InferSubmodules);
2431 Record.push_back(Mod->InferExplicitSubmodules);
2432 Record.push_back(Mod->InferExportWildcard);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002433 Record.push_back(Mod->ConfigMacrosExhaustive);
Douglas Gregor69021972011-11-30 17:33:56 +00002434 Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name);
2435
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002436 // Emit the requirements.
Richard Smitha3feee22013-10-28 22:18:19 +00002437 for (unsigned I = 0, N = Mod->Requirements.size(); I != N; ++I) {
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002438 Record.clear();
2439 Record.push_back(SUBMODULE_REQUIRES);
Richard Smitha3feee22013-10-28 22:18:19 +00002440 Record.push_back(Mod->Requirements[I].second);
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002441 Stream.EmitRecordWithBlob(RequiresAbbrev, Record,
Richard Smitha3feee22013-10-28 22:18:19 +00002442 Mod->Requirements[I].first);
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002443 }
2444
Douglas Gregor69021972011-11-30 17:33:56 +00002445 // Emit the umbrella header, if there is one.
Richard Smith2b63d152015-05-16 02:28:53 +00002446 if (auto UmbrellaHeader = Mod->getUmbrellaHeader()) {
Douglas Gregor69021972011-11-30 17:33:56 +00002447 Record.clear();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002448 Record.push_back(SUBMODULE_UMBRELLA_HEADER);
Richard Smith2b63d152015-05-16 02:28:53 +00002449 Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
2450 UmbrellaHeader.NameAsWritten);
2451 } else if (auto UmbrellaDir = Mod->getUmbrellaDir()) {
Douglas Gregor524e33e2011-12-08 19:11:24 +00002452 Record.clear();
2453 Record.push_back(SUBMODULE_UMBRELLA_DIR);
2454 Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
Richard Smith2b63d152015-05-16 02:28:53 +00002455 UmbrellaDir.NameAsWritten);
Douglas Gregor69021972011-11-30 17:33:56 +00002456 }
Richard Smith306d8922014-10-22 23:50:56 +00002457
Douglas Gregor69021972011-11-30 17:33:56 +00002458 // Emit the headers.
Richard Smith202210b2014-10-24 20:23:01 +00002459 struct {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002460 unsigned RecordKind;
Richard Smith202210b2014-10-24 20:23:01 +00002461 unsigned Abbrev;
Richard Smith3c1a41a2014-12-02 00:08:08 +00002462 Module::HeaderKind HeaderKind;
Richard Smith202210b2014-10-24 20:23:01 +00002463 } HeaderLists[] = {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002464 {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal},
2465 {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual},
2466 {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private},
Richard Smith202210b2014-10-24 20:23:01 +00002467 {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev,
Richard Smith3c1a41a2014-12-02 00:08:08 +00002468 Module::HK_PrivateTextual},
2469 {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded}
Richard Smith202210b2014-10-24 20:23:01 +00002470 };
2471 for (auto &HL : HeaderLists) {
Douglas Gregor69021972011-11-30 17:33:56 +00002472 Record.clear();
Richard Smith3c1a41a2014-12-02 00:08:08 +00002473 Record.push_back(HL.RecordKind);
2474 for (auto &H : Mod->Headers[HL.HeaderKind])
2475 Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten);
2476 }
2477
2478 // Emit the top headers.
2479 {
2480 auto TopHeaders = Mod->getTopHeaders(PP->getFileManager());
2481 Record.clear();
2482 Record.push_back(SUBMODULE_TOPHEADER);
2483 for (auto *H : TopHeaders)
2484 Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, H->getName());
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002485 }
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002486
2487 // Emit the imports.
2488 if (!Mod->Imports.empty()) {
2489 Record.clear();
2490 for (unsigned I = 0, N = Mod->Imports.size(); I != N; ++I) {
Douglas Gregor18b58642011-12-12 23:17:57 +00002491 unsigned ImportedID = getSubmoduleID(Mod->Imports[I]);
Richard Smith7ed1bc92014-12-05 22:42:13 +00002492 assert(ImportedID && "Unknown submodule!");
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002493 Record.push_back(ImportedID);
2494 }
2495 Stream.EmitRecord(SUBMODULE_IMPORTS, Record);
2496 }
2497
Douglas Gregor24bb9232011-12-02 18:58:38 +00002498 // Emit the exports.
2499 if (!Mod->Exports.empty()) {
2500 Record.clear();
2501 for (unsigned I = 0, N = Mod->Exports.size(); I != N; ++I) {
Douglas Gregor18b58642011-12-12 23:17:57 +00002502 if (Module *Exported = Mod->Exports[I].getPointer()) {
Richard Smith23d8d032015-05-14 00:45:20 +00002503 unsigned ExportedID = getSubmoduleID(Exported);
Douglas Gregor18b58642011-12-12 23:17:57 +00002504 Record.push_back(ExportedID);
2505 } else {
2506 Record.push_back(0);
2507 }
2508
Douglas Gregor24bb9232011-12-02 18:58:38 +00002509 Record.push_back(Mod->Exports[I].getInt());
2510 }
2511 Stream.EmitRecord(SUBMODULE_EXPORTS, Record);
2512 }
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002513
Daniel Jasperba7f2f72013-09-24 09:14:14 +00002514 //FIXME: How do we emit the 'use'd modules? They may not be submodules.
2515 // Might be unnecessary as use declarations are only used to build the
2516 // module itself.
2517
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002518 // Emit the link libraries.
2519 for (unsigned I = 0, N = Mod->LinkLibraries.size(); I != N; ++I) {
2520 Record.clear();
2521 Record.push_back(SUBMODULE_LINK_LIBRARY);
2522 Record.push_back(Mod->LinkLibraries[I].IsFramework);
2523 Stream.EmitRecordWithBlob(LinkLibraryAbbrev, Record,
2524 Mod->LinkLibraries[I].Library);
2525 }
2526
Douglas Gregorfb912652013-03-20 21:10:35 +00002527 // Emit the conflicts.
2528 for (unsigned I = 0, N = Mod->Conflicts.size(); I != N; ++I) {
2529 Record.clear();
2530 Record.push_back(SUBMODULE_CONFLICT);
2531 unsigned OtherID = getSubmoduleID(Mod->Conflicts[I].Other);
2532 assert(OtherID && "Unknown submodule!");
2533 Record.push_back(OtherID);
2534 Stream.EmitRecordWithBlob(ConflictAbbrev, Record,
2535 Mod->Conflicts[I].Message);
2536 }
2537
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002538 // Emit the configuration macros.
2539 for (unsigned I = 0, N = Mod->ConfigMacros.size(); I != N; ++I) {
2540 Record.clear();
2541 Record.push_back(SUBMODULE_CONFIG_MACRO);
2542 Stream.EmitRecordWithBlob(ConfigMacroAbbrev, Record,
2543 Mod->ConfigMacros[I]);
2544 }
2545
Douglas Gregor69021972011-11-30 17:33:56 +00002546 // Queue up the submodules of this module.
Douglas Gregoreb90e832012-01-04 23:32:19 +00002547 for (Module::submodule_iterator Sub = Mod->submodule_begin(),
2548 SubEnd = Mod->submodule_end();
Douglas Gregor69021972011-11-30 17:33:56 +00002549 Sub != SubEnd; ++Sub)
Douglas Gregoreb90e832012-01-04 23:32:19 +00002550 Q.push(*Sub);
Douglas Gregor69021972011-11-30 17:33:56 +00002551 }
2552
2553 Stream.ExitBlock();
Richard Smith23d8d032015-05-14 00:45:20 +00002554
2555 // FIXME: This can easily happen, if we have a reference to a submodule that
2556 // did not result in us loading a module file for that submodule. For
2557 // instance, a cross-top-level-module 'conflict' declaration will hit this.
2558 assert((NextSubmoduleID - FirstSubmoduleID ==
2559 getNumberOfModules(WritingModule)) &&
2560 "Wrong # of submodules; found a reference to a non-local, "
2561 "non-imported submodule?");
Douglas Gregor69021972011-11-30 17:33:56 +00002562}
2563
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002564serialization::SubmoduleID
2565ASTWriter::inferSubmoduleIDFromLocation(SourceLocation Loc) {
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002566 if (Loc.isInvalid() || !WritingModule)
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002567 return 0; // No submodule
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002568
2569 // Find the module that owns this location.
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002570 ModuleMap &ModMap = PP->getHeaderSearchInfo().getModuleMap();
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002571 Module *OwningMod
2572 = ModMap.inferModuleFromLocation(FullSourceLoc(Loc,PP->getSourceManager()));
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002573 if (!OwningMod)
2574 return 0;
2575
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002576 // Check whether this submodule is part of our own module.
2577 if (WritingModule != OwningMod && !OwningMod->isSubModuleOf(WritingModule))
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002578 return 0;
2579
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002580 return getSubmoduleID(OwningMod);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002581}
2582
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00002583void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
2584 bool isModule) {
2585 // Make sure set diagnostic pragmas don't affect the translation unit that
2586 // imports the module.
2587 // FIXME: Make diagnostic pragma sections work properly with modules.
2588 if (isModule)
2589 return;
2590
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002591 llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64>
2592 DiagStateIDMap;
2593 unsigned CurrID = 0;
2594 DiagStateIDMap[&Diag.DiagStates.front()] = ++CurrID; // the command-line one.
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002595 RecordData Record;
David Blaikie9c902b52011-09-25 23:23:43 +00002596 for (DiagnosticsEngine::DiagStatePointsTy::const_iterator
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002597 I = Diag.DiagStatePoints.begin(), E = Diag.DiagStatePoints.end();
2598 I != E; ++I) {
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002599 const DiagnosticsEngine::DiagStatePoint &point = *I;
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002600 if (point.Loc.isInvalid())
2601 continue;
2602
2603 Record.push_back(point.Loc.getRawEncoding());
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002604 unsigned &DiagStateID = DiagStateIDMap[point.State];
2605 Record.push_back(DiagStateID);
2606
2607 if (DiagStateID == 0) {
2608 DiagStateID = ++CurrID;
2609 for (DiagnosticsEngine::DiagState::const_iterator
2610 I = point.State->begin(), E = point.State->end(); I != E; ++I) {
2611 if (I->second.isPragma()) {
2612 Record.push_back(I->first);
Alp Toker46df1c02014-06-12 10:15:20 +00002613 Record.push_back((unsigned)I->second.getSeverity());
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002614 }
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002615 }
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002616 Record.push_back(-1); // mark the end of the diag/map pairs for this
2617 // location.
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002618 }
2619 }
2620
Argyrios Kyrtzidisb0ca9eb2010-11-05 22:20:49 +00002621 if (!Record.empty())
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002622 Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002623}
2624
Richard Smithc2bb8182015-03-24 06:36:48 +00002625void ASTWriter::WriteCXXCtorInitializersOffsets() {
2626 if (CXXCtorInitializersOffsets.empty())
2627 return;
2628
2629 RecordData Record;
2630
2631 // Create a blob abbreviation for the C++ ctor initializer offsets.
2632 using namespace llvm;
2633
2634 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2635 Abbrev->Add(BitCodeAbbrevOp(CXX_CTOR_INITIALIZERS_OFFSETS));
2636 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
2637 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2638 unsigned CtorInitializersOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2639
2640 // Write the base specifier offsets table.
2641 Record.clear();
2642 Record.push_back(CXX_CTOR_INITIALIZERS_OFFSETS);
2643 Record.push_back(CXXCtorInitializersOffsets.size());
2644 Stream.EmitRecordWithBlob(CtorInitializersOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002645 bytes(CXXCtorInitializersOffsets));
Richard Smithc2bb8182015-03-24 06:36:48 +00002646}
2647
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002648void ASTWriter::WriteCXXBaseSpecifiersOffsets() {
2649 if (CXXBaseSpecifiersOffsets.empty())
2650 return;
2651
2652 RecordData Record;
2653
2654 // Create a blob abbreviation for the C++ base specifiers offsets.
2655 using namespace llvm;
2656
2657 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2658 Abbrev->Add(BitCodeAbbrevOp(CXX_BASE_SPECIFIER_OFFSETS));
2659 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
2660 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2661 unsigned BaseSpecifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2662
Douglas Gregorc27b2872011-08-04 00:01:48 +00002663 // Write the base specifier offsets table.
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002664 Record.clear();
2665 Record.push_back(CXX_BASE_SPECIFIER_OFFSETS);
2666 Record.push_back(CXXBaseSpecifiersOffsets.size());
2667 Stream.EmitRecordWithBlob(BaseSpecifierOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002668 bytes(CXXBaseSpecifiersOffsets));
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002669}
2670
Douglas Gregorc5046832009-04-27 18:38:38 +00002671//===----------------------------------------------------------------------===//
2672// Type Serialization
2673//===----------------------------------------------------------------------===//
Chris Lattnereeffaef2009-04-10 17:15:23 +00002674
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002675/// \brief Write the representation of a type to the AST stream.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002676void ASTWriter::WriteType(QualType T) {
Argyrios Kyrtzidisa7fbbb02010-08-20 16:04:04 +00002677 TypeIdx &Idx = TypeIdxs[T];
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00002678 if (Idx.getIndex() == 0) // we haven't seen this type before.
2679 Idx = TypeIdx(NextTypeID++);
Mike Stump11289f42009-09-09 15:08:12 +00002680
Douglas Gregor9b3932c2010-10-05 18:37:06 +00002681 assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
Douglas Gregordc72caa2010-10-04 18:21:45 +00002682
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002683 // Record the offset for this type.
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00002684 unsigned Index = Idx.getIndex() - FirstTypeID;
Sebastian Redl66c5eef2010-07-27 00:17:23 +00002685 if (TypeOffsets.size() == Index)
Douglas Gregor8f45df52009-04-16 22:23:12 +00002686 TypeOffsets.push_back(Stream.GetCurrentBitNo());
Sebastian Redl66c5eef2010-07-27 00:17:23 +00002687 else if (TypeOffsets.size() < Index) {
2688 TypeOffsets.resize(Index + 1);
2689 TypeOffsets[Index] = Stream.GetCurrentBitNo();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002690 }
2691
2692 RecordData Record;
Mike Stump11289f42009-09-09 15:08:12 +00002693
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002694 // Emit the type's representation.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002695 ASTTypeWriter W(*this, Record);
Richard Smith01b2cb42014-07-26 06:37:51 +00002696 W.AbbrevToUse = 0;
John McCall8ccfcb52009-09-24 19:53:00 +00002697
Douglas Gregor1b8fe5b72009-11-16 21:35:15 +00002698 if (T.hasLocalNonFastQualifiers()) {
2699 Qualifiers Qs = T.getLocalQualifiers();
2700 AddTypeRef(T.getLocalUnqualifiedType(), Record);
John McCall8ccfcb52009-09-24 19:53:00 +00002701 Record.push_back(Qs.getAsOpaqueValue());
Sebastian Redl539c5062010-08-18 23:57:32 +00002702 W.Code = TYPE_EXT_QUAL;
Richard Smith01b2cb42014-07-26 06:37:51 +00002703 W.AbbrevToUse = TypeExtQualAbbrev;
John McCall8ccfcb52009-09-24 19:53:00 +00002704 } else {
2705 switch (T->getTypeClass()) {
2706 // For all of the concrete, non-dependent types, call the
2707 // appropriate visitor function.
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002708#define TYPE(Class, Base) \
Mike Stump281d6d72010-01-20 02:03:14 +00002709 case Type::Class: W.Visit##Class##Type(cast<Class##Type>(T)); break;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002710#define ABSTRACT_TYPE(Class, Base)
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002711#include "clang/AST/TypeNodes.def"
John McCall8ccfcb52009-09-24 19:53:00 +00002712 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002713 }
2714
2715 // Emit the serialized record.
Richard Smith01b2cb42014-07-26 06:37:51 +00002716 Stream.EmitRecord(W.Code, Record, W.AbbrevToUse);
Douglas Gregorfeb84b02009-04-14 21:18:50 +00002717
2718 // Flush any expressions that were written as part of this type.
Douglas Gregor8f45df52009-04-16 22:23:12 +00002719 FlushStmts();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002720}
2721
Douglas Gregorc5046832009-04-27 18:38:38 +00002722//===----------------------------------------------------------------------===//
2723// Declaration Serialization
2724//===----------------------------------------------------------------------===//
2725
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002726/// \brief Write the block containing all of the declaration IDs
2727/// lexically declared within the given DeclContext.
2728///
2729/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
2730/// bistream, or 0 if no block was written.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002731uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002732 DeclContext *DC) {
Argyrios Kyrtzidiscfbfe782009-06-30 02:36:12 +00002733 if (DC->decls_empty())
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002734 return 0;
2735
Douglas Gregor8f45df52009-04-16 22:23:12 +00002736 uint64_t Offset = Stream.GetCurrentBitNo();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002737 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00002738 Record.push_back(DECL_CONTEXT_LEXICAL);
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002739 SmallVector<KindDeclIDPair, 64> Decls;
Aaron Ballman629afae2014-03-07 19:56:05 +00002740 for (const auto *D : DC->decls())
2741 Decls.push_back(std::make_pair(D->getKind(), GetDeclRef(D)));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002742
Douglas Gregora57c3ab2009-04-22 22:34:57 +00002743 ++NumLexicalDeclContexts;
Reid Kleckner012665e2015-05-21 00:13:09 +00002744 Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record, bytes(Decls));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002745 return Offset;
2746}
2747
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002748void ASTWriter::WriteTypeDeclOffsets() {
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002749 using namespace llvm;
2750 RecordData Record;
2751
2752 // Write the type offsets array
2753 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00002754 Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002755 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
Douglas Gregor5204bde2011-08-02 16:26:37 +00002756 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002757 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
2758 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2759 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00002760 Record.push_back(TYPE_OFFSET);
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002761 Record.push_back(TypeOffsets.size());
Douglas Gregor5204bde2011-08-02 16:26:37 +00002762 Record.push_back(FirstTypeID - NUM_PREDEF_TYPE_IDS);
Reid Kleckner012665e2015-05-21 00:13:09 +00002763 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, bytes(TypeOffsets));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002764
2765 // Write the declaration offsets array
2766 Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00002767 Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002768 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
Douglas Gregorf7180622011-08-03 15:48:04 +00002769 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002770 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
2771 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2772 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00002773 Record.push_back(DECL_OFFSET);
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002774 Record.push_back(DeclOffsets.size());
Douglas Gregor6f8912e2011-08-03 16:05:40 +00002775 Record.push_back(FirstDeclID - NUM_PREDEF_DECL_IDS);
Reid Kleckner012665e2015-05-21 00:13:09 +00002776 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, bytes(DeclOffsets));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002777}
2778
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002779void ASTWriter::WriteFileDeclIDsMap() {
2780 using namespace llvm;
2781 RecordData Record;
2782
Chandler Carruthb306d732015-03-27 00:31:20 +00002783 SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs(
2784 FileDeclIDs.begin(), FileDeclIDs.end());
2785 std::sort(SortedFileDeclIDs.begin(), SortedFileDeclIDs.end(),
2786 llvm::less_first());
2787
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002788 // Join the vectors of DeclIDs from all files.
Chandler Carruthb306d732015-03-27 00:31:20 +00002789 SmallVector<DeclID, 256> FileGroupedDeclIDs;
2790 for (auto &FileDeclEntry : SortedFileDeclIDs) {
2791 DeclIDInFileInfo &Info = *FileDeclEntry.second;
2792 Info.FirstDeclIndex = FileGroupedDeclIDs.size();
2793 for (auto &LocDeclEntry : Info.DeclIDs)
2794 FileGroupedDeclIDs.push_back(LocDeclEntry.second);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002795 }
2796
2797 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2798 Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
Argyrios Kyrtzidis10e78462012-10-02 21:09:13 +00002799 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002800 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2801 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
2802 Record.push_back(FILE_SORTED_DECLS);
Chandler Carruthb306d732015-03-27 00:31:20 +00002803 Record.push_back(FileGroupedDeclIDs.size());
Reid Kleckner012665e2015-05-21 00:13:09 +00002804 Stream.EmitRecordWithBlob(AbbrevCode, Record, bytes(FileGroupedDeclIDs));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002805}
2806
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002807void ASTWriter::WriteComments() {
2808 Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3);
Dmitri Gribenko7dd29d42012-07-06 18:19:34 +00002809 ArrayRef<RawComment *> RawComments = Context->Comments.getComments();
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002810 RecordData Record;
Dmitri Gribenko7dd29d42012-07-06 18:19:34 +00002811 for (ArrayRef<RawComment *>::iterator I = RawComments.begin(),
2812 E = RawComments.end();
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002813 I != E; ++I) {
2814 Record.clear();
Dmitri Gribenko7dd29d42012-07-06 18:19:34 +00002815 AddSourceRange((*I)->getSourceRange(), Record);
2816 Record.push_back((*I)->getKind());
2817 Record.push_back((*I)->isTrailingComment());
2818 Record.push_back((*I)->isAlmostTrailingComment());
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002819 Stream.EmitRecord(COMMENTS_RAW_COMMENT, Record);
2820 }
2821 Stream.ExitBlock();
2822}
2823
Douglas Gregorc5046832009-04-27 18:38:38 +00002824//===----------------------------------------------------------------------===//
2825// Global Method Pool and Selector Serialization
2826//===----------------------------------------------------------------------===//
2827
Douglas Gregore84a9da2009-04-20 20:36:09 +00002828namespace {
Douglas Gregorc78d3462009-04-24 21:10:55 +00002829// Trait used for the on-disk hash table used in the method pool.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002830class ASTMethodPoolTrait {
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002831 ASTWriter &Writer;
Douglas Gregorc78d3462009-04-24 21:10:55 +00002832
2833public:
2834 typedef Selector key_type;
2835 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00002836
Sebastian Redl834bb972010-08-04 17:20:04 +00002837 struct data_type {
Sebastian Redl539c5062010-08-18 23:57:32 +00002838 SelectorID ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00002839 ObjCMethodList Instance, Factory;
2840 };
Douglas Gregorc78d3462009-04-24 21:10:55 +00002841 typedef const data_type& data_type_ref;
2842
Justin Bogner25463f12014-04-18 20:27:24 +00002843 typedef unsigned hash_value_type;
2844 typedef unsigned offset_type;
2845
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002846 explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) { }
Mike Stump11289f42009-09-09 15:08:12 +00002847
Justin Bogner25463f12014-04-18 20:27:24 +00002848 static hash_value_type ComputeHash(Selector Sel) {
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +00002849 return serialization::ComputeHash(Sel);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002850 }
Mike Stump11289f42009-09-09 15:08:12 +00002851
2852 std::pair<unsigned,unsigned>
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002853 EmitKeyDataLength(raw_ostream& Out, Selector Sel,
Douglas Gregorc78d3462009-04-24 21:10:55 +00002854 data_type_ref Methods) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002855 using namespace llvm::support;
2856 endian::Writer<little> LE(Out);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002857 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
Justin Bognere1c147c2014-03-28 22:03:19 +00002858 LE.write<uint16_t>(KeyLen);
Sebastian Redl834bb972010-08-04 17:20:04 +00002859 unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
2860 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002861 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002862 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002863 DataLen += 4;
Sebastian Redl834bb972010-08-04 17:20:04 +00002864 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002865 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002866 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002867 DataLen += 4;
Justin Bognere1c147c2014-03-28 22:03:19 +00002868 LE.write<uint16_t>(DataLen);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002869 return std::make_pair(KeyLen, DataLen);
2870 }
Mike Stump11289f42009-09-09 15:08:12 +00002871
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002872 void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002873 using namespace llvm::support;
2874 endian::Writer<little> LE(Out);
Mike Stump11289f42009-09-09 15:08:12 +00002875 uint64_t Start = Out.tell();
Douglas Gregor95c13f52009-04-25 17:48:32 +00002876 assert((Start >> 32) == 0 && "Selector key offset too large");
2877 Writer.SetSelectorOffset(Sel, Start);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002878 unsigned N = Sel.getNumArgs();
Justin Bognere1c147c2014-03-28 22:03:19 +00002879 LE.write<uint16_t>(N);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002880 if (N == 0)
2881 N = 1;
2882 for (unsigned I = 0; I != N; ++I)
Justin Bognere1c147c2014-03-28 22:03:19 +00002883 LE.write<uint32_t>(
2884 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
Douglas Gregorc78d3462009-04-24 21:10:55 +00002885 }
Mike Stump11289f42009-09-09 15:08:12 +00002886
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002887 void EmitData(raw_ostream& Out, key_type_ref,
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002888 data_type_ref Methods, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002889 using namespace llvm::support;
2890 endian::Writer<little> LE(Out);
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002891 uint64_t Start = Out.tell(); (void)Start;
Justin Bognere1c147c2014-03-28 22:03:19 +00002892 LE.write<uint32_t>(Methods.ID);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002893 unsigned NumInstanceMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00002894 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002895 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002896 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002897 ++NumInstanceMethods;
2898
2899 unsigned NumFactoryMethods = 0;
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 ++NumFactoryMethods;
2904
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002905 unsigned InstanceBits = Methods.Instance.getBits();
2906 assert(InstanceBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00002907 unsigned InstanceHasMoreThanOneDeclBit =
2908 Methods.Instance.hasMoreThanOneDecl();
2909 unsigned FullInstanceBits = (NumInstanceMethods << 3) |
2910 (InstanceHasMoreThanOneDeclBit << 2) |
2911 InstanceBits;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002912 unsigned FactoryBits = Methods.Factory.getBits();
2913 assert(FactoryBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00002914 unsigned FactoryHasMoreThanOneDeclBit =
2915 Methods.Factory.hasMoreThanOneDecl();
2916 unsigned FullFactoryBits = (NumFactoryMethods << 3) |
2917 (FactoryHasMoreThanOneDeclBit << 2) |
2918 FactoryBits;
2919 LE.write<uint16_t>(FullInstanceBits);
2920 LE.write<uint16_t>(FullFactoryBits);
Sebastian Redl834bb972010-08-04 17:20:04 +00002921 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002922 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002923 if (Method->getMethod())
2924 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Sebastian Redl834bb972010-08-04 17:20:04 +00002925 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002926 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002927 if (Method->getMethod())
2928 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002929
2930 assert(Out.tell() - Start == DataLen && "Data length is wrong");
Douglas Gregorc78d3462009-04-24 21:10:55 +00002931 }
2932};
2933} // end anonymous namespace
2934
Sebastian Redla19a67f2010-08-03 21:58:15 +00002935/// \brief Write ObjC data: selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00002936///
2937/// The method pool contains both instance and factory methods, stored
Sebastian Redla19a67f2010-08-03 21:58:15 +00002938/// in an on-disk hash table indexed by the selector. The hash table also
2939/// contains an empty entry for every other selector known to Sema.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002940void ASTWriter::WriteSelectors(Sema &SemaRef) {
Douglas Gregorc78d3462009-04-24 21:10:55 +00002941 using namespace llvm;
2942
Sebastian Redla19a67f2010-08-03 21:58:15 +00002943 // Do we have to do anything at all?
Sebastian Redl834bb972010-08-04 17:20:04 +00002944 if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
Sebastian Redla19a67f2010-08-03 21:58:15 +00002945 return;
Sebastian Redld95a56e2010-08-04 18:21:41 +00002946 unsigned NumTableEntries = 0;
Sebastian Redla19a67f2010-08-03 21:58:15 +00002947 // Create and write out the blob that contains selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00002948 {
Justin Bognerbb094f02014-04-18 19:57:06 +00002949 llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00002950 ASTMethodPoolTrait Trait(*this);
Mike Stump11289f42009-09-09 15:08:12 +00002951
Sebastian Redla19a67f2010-08-03 21:58:15 +00002952 // Create the on-disk hash table representation. We walk through every
2953 // selector we've seen and look it up in the method pool.
Sebastian Redld95a56e2010-08-04 18:21:41 +00002954 SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
Chandler Carruthacbbeb92015-03-27 00:47:43 +00002955 for (auto &SelectorAndID : SelectorIDs) {
2956 Selector S = SelectorAndID.first;
2957 SelectorID ID = SelectorAndID.second;
Sebastian Redla19a67f2010-08-03 21:58:15 +00002958 Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002959 ASTMethodPoolTrait::data_type Data = {
Chandler Carruthacbbeb92015-03-27 00:47:43 +00002960 ID,
Sebastian Redl834bb972010-08-04 17:20:04 +00002961 ObjCMethodList(),
2962 ObjCMethodList()
2963 };
2964 if (F != SemaRef.MethodPool.end()) {
2965 Data.Instance = F->second.first;
2966 Data.Factory = F->second.second;
2967 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002968 // Only write this selector if it's not in an existing AST or something
Sebastian Redld95a56e2010-08-04 18:21:41 +00002969 // changed.
Chandler Carruthacbbeb92015-03-27 00:47:43 +00002970 if (Chain && ID < FirstSelectorID) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00002971 // Selector already exists. Did it change?
2972 bool changed = false;
Nico Weber2e0c8f72014-12-27 03:58:08 +00002973 for (ObjCMethodList *M = &Data.Instance;
2974 !changed && M && M->getMethod(); M = M->getNext()) {
2975 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00002976 changed = true;
2977 }
Nico Weber2e0c8f72014-12-27 03:58:08 +00002978 for (ObjCMethodList *M = &Data.Factory; !changed && M && M->getMethod();
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002979 M = M->getNext()) {
Nico Weber2e0c8f72014-12-27 03:58:08 +00002980 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00002981 changed = true;
2982 }
2983 if (!changed)
2984 continue;
Nico Weber2e0c8f72014-12-27 03:58:08 +00002985 } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) {
Sebastian Redl6e1a2a02010-08-04 21:22:45 +00002986 // A new method pool entry.
2987 ++NumTableEntries;
Sebastian Redld95a56e2010-08-04 18:21:41 +00002988 }
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00002989 Generator.insert(S, Data, Trait);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002990 }
2991
Douglas Gregorc78d3462009-04-24 21:10:55 +00002992 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002993 SmallString<4096> MethodPool;
Douglas Gregorc78d3462009-04-24 21:10:55 +00002994 uint32_t BucketOffset;
2995 {
Justin Bognere1c147c2014-03-28 22:03:19 +00002996 using namespace llvm::support;
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002997 ASTMethodPoolTrait Trait(*this);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002998 llvm::raw_svector_ostream Out(MethodPool);
2999 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003000 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003001 BucketOffset = Generator.Emit(Out, Trait);
3002 }
3003
3004 // Create a blob abbreviation
3005 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003006 Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003007 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003008 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003009 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3010 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(Abbrev);
3011
Douglas Gregor95c13f52009-04-25 17:48:32 +00003012 // Write the method pool
Douglas Gregorc78d3462009-04-24 21:10:55 +00003013 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00003014 Record.push_back(METHOD_POOL);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003015 Record.push_back(BucketOffset);
Sebastian Redld95a56e2010-08-04 18:21:41 +00003016 Record.push_back(NumTableEntries);
Yaron Keren92e1b622015-03-18 10:17:07 +00003017 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool);
Douglas Gregor95c13f52009-04-25 17:48:32 +00003018
3019 // Create a blob abbreviation for the selector table offsets.
3020 Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003021 Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
Douglas Gregord4c5ed02010-10-29 22:39:52 +00003022 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
Douglas Gregor8f364fb2011-08-03 23:28:44 +00003023 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor95c13f52009-04-25 17:48:32 +00003024 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3025 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
3026
3027 // Write the selector offsets table.
3028 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00003029 Record.push_back(SELECTOR_OFFSETS);
Douglas Gregor95c13f52009-04-25 17:48:32 +00003030 Record.push_back(SelectorOffsets.size());
Douglas Gregor8f364fb2011-08-03 23:28:44 +00003031 Record.push_back(FirstSelectorID - NUM_PREDEF_SELECTOR_IDS);
Douglas Gregor95c13f52009-04-25 17:48:32 +00003032 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00003033 bytes(SelectorOffsets));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003034 }
3035}
3036
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003037/// \brief Write the selectors referenced in @selector expression into AST file.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003038void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003039 using namespace llvm;
3040 if (SemaRef.ReferencedSelectors.empty())
3041 return;
Sebastian Redlada023c2010-08-04 20:40:17 +00003042
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003043 RecordData Record;
Sebastian Redlada023c2010-08-04 20:40:17 +00003044
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003045 // Note: this writes out all references even for a dependent AST. But it is
Sebastian Redl51c79d82010-08-04 22:21:29 +00003046 // very tricky to fix, and given that @selector shouldn't really appear in
3047 // headers, probably not worth it. It's not a correctness issue.
Chandler Carruth12c8f652015-03-27 00:55:05 +00003048 for (auto &SelectorAndLocation : SemaRef.ReferencedSelectors) {
3049 Selector Sel = SelectorAndLocation.first;
3050 SourceLocation Loc = SelectorAndLocation.second;
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003051 AddSelectorRef(Sel, Record);
3052 AddSourceLocation(Loc, Record);
3053 }
Sebastian Redl539c5062010-08-18 23:57:32 +00003054 Stream.EmitRecord(REFERENCED_SELECTOR_POOL, Record);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003055}
3056
Douglas Gregorc5046832009-04-27 18:38:38 +00003057//===----------------------------------------------------------------------===//
3058// Identifier Table Serialization
3059//===----------------------------------------------------------------------===//
3060
Richard Smithb3761912015-02-05 23:08:52 +00003061/// Determine the declaration that should be put into the name lookup table to
3062/// represent the given declaration in this module. This is usually D itself,
3063/// but if D was imported and merged into a local declaration, we want the most
3064/// recent local declaration instead. The chosen declaration will be the most
3065/// recent declaration in any module that imports this one.
3066static NamedDecl *getDeclForLocalLookup(const LangOptions &LangOpts,
3067 NamedDecl *D) {
3068 if (!LangOpts.Modules || !D->isFromASTFile())
3069 return D;
3070
3071 if (Decl *Redecl = D->getPreviousDecl()) {
3072 // For Redeclarable decls, a prior declaration might be local.
3073 for (; Redecl; Redecl = Redecl->getPreviousDecl()) {
3074 if (!Redecl->isFromASTFile())
3075 return cast<NamedDecl>(Redecl);
Richard Smithfe620d22015-03-05 23:24:12 +00003076 // If we find a decl from a (chained-)PCH stop since we won't find a
Richard Smithb3761912015-02-05 23:08:52 +00003077 // local one.
3078 if (D->getOwningModuleID() == 0)
3079 break;
3080 }
3081 } else if (Decl *First = D->getCanonicalDecl()) {
3082 // For Mergeable decls, the first decl might be local.
3083 if (!First->isFromASTFile())
3084 return cast<NamedDecl>(First);
3085 }
3086
3087 // All declarations are imported. Our most recent declaration will also be
3088 // the most recent one in anyone who imports us.
3089 return D;
3090}
3091
Douglas Gregorc78d3462009-04-24 21:10:55 +00003092namespace {
Richard Smithcf97cf62015-04-19 01:34:23 +00003093class ASTIdentifierTableTrait {
3094 ASTWriter &Writer;
3095 Preprocessor &PP;
3096 IdentifierResolver &IdResolver;
Richard Smithcf97cf62015-04-19 01:34:23 +00003097
3098 /// \brief Determines whether this is an "interesting" identifier that needs a
3099 /// full IdentifierInfo structure written into the hash table. Notably, this
3100 /// doesn't check whether the name has macros defined; use PublicMacroIterator
3101 /// to check that.
Richard Smithd7329392015-04-21 21:46:32 +00003102 bool isInterestingIdentifier(IdentifierInfo *II, uint64_t MacroOffset) {
3103 if (MacroOffset ||
3104 II->isPoisoned() ||
Richard Smithcf97cf62015-04-19 01:34:23 +00003105 II->isExtensionToken() ||
3106 II->getObjCOrBuiltinID() ||
3107 II->hasRevertedTokenIDToIdentifier() ||
3108 II->getFETokenInfo<void>())
3109 return true;
3110
3111 return false;
3112 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003113
Douglas Gregore84a9da2009-04-20 20:36:09 +00003114public:
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003115 typedef IdentifierInfo* key_type;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003116 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00003117
Sebastian Redl539c5062010-08-18 23:57:32 +00003118 typedef IdentID data_type;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003119 typedef data_type data_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00003120
Justin Bogner25463f12014-04-18 20:27:24 +00003121 typedef unsigned hash_value_type;
3122 typedef unsigned offset_type;
3123
Richard Smithd7329392015-04-21 21:46:32 +00003124 ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
3125 IdentifierResolver &IdResolver)
3126 : Writer(Writer), PP(PP), IdResolver(IdResolver) {}
Douglas Gregore84a9da2009-04-20 20:36:09 +00003127
Justin Bogner25463f12014-04-18 20:27:24 +00003128 static hash_value_type ComputeHash(const IdentifierInfo* II) {
Daniel Dunbarf8502d52009-10-17 23:52:28 +00003129 return llvm::HashString(II->getName());
Douglas Gregore84a9da2009-04-20 20:36:09 +00003130 }
Mike Stump11289f42009-09-09 15:08:12 +00003131
3132 std::pair<unsigned,unsigned>
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003133 EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) {
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003134 unsigned KeyLen = II->getLength() + 1;
Douglas Gregor1d583f22009-04-28 21:18:29 +00003135 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
Richard Smithd7329392015-04-21 21:46:32 +00003136 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3137 if (isInterestingIdentifier(II, MacroOffset)) {
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003138 DataLen += 2; // 2 bytes for builtin ID
3139 DataLen += 2; // 2 bytes for flags
Richard Smithd7329392015-04-21 21:46:32 +00003140 if (MacroOffset)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003141 DataLen += 4; // MacroDirectives offset.
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003142
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003143 for (IdentifierResolver::iterator D = IdResolver.begin(II),
3144 DEnd = IdResolver.end();
Douglas Gregor1d583f22009-04-28 21:18:29 +00003145 D != DEnd; ++D)
Richard Smithdaa69e02014-07-25 04:40:03 +00003146 DataLen += 4;
Douglas Gregor1d583f22009-04-28 21:18:29 +00003147 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003148 using namespace llvm::support;
3149 endian::Writer<little> LE(Out);
3150
Richard Smithdf8a8312015-03-13 04:05:01 +00003151 assert((uint16_t)DataLen == DataLen && (uint16_t)KeyLen == KeyLen);
Justin Bognere1c147c2014-03-28 22:03:19 +00003152 LE.write<uint16_t>(DataLen);
Douglas Gregorab4df582009-04-28 20:01:51 +00003153 // We emit the key length after the data length so that every
3154 // string is preceded by a 16-bit length. This matches the PTH
3155 // format for storing identifiers.
Justin Bognere1c147c2014-03-28 22:03:19 +00003156 LE.write<uint16_t>(KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003157 return std::make_pair(KeyLen, DataLen);
3158 }
Mike Stump11289f42009-09-09 15:08:12 +00003159
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003160 void EmitKey(raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregore84a9da2009-04-20 20:36:09 +00003161 unsigned KeyLen) {
3162 // Record the location of the key data. This is used when generating
3163 // the mapping from persistent IDs to strings.
3164 Writer.SetIdentifierOffset(II, Out.tell());
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003165 Out.write(II->getNameStart(), KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003166 }
Mike Stump11289f42009-09-09 15:08:12 +00003167
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003168 void EmitData(raw_ostream& Out, IdentifierInfo* II,
Sebastian Redl539c5062010-08-18 23:57:32 +00003169 IdentID ID, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003170 using namespace llvm::support;
3171 endian::Writer<little> LE(Out);
Richard Smithcf97cf62015-04-19 01:34:23 +00003172
Richard Smithd7329392015-04-21 21:46:32 +00003173 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3174 if (!isInterestingIdentifier(II, MacroOffset)) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003175 LE.write<uint32_t>(ID << 1);
Douglas Gregor1d583f22009-04-28 21:18:29 +00003176 return;
3177 }
Douglas Gregorb9256522009-04-28 21:32:13 +00003178
Justin Bognere1c147c2014-03-28 22:03:19 +00003179 LE.write<uint32_t>((ID << 1) | 0x01);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003180 uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID();
3181 assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
Justin Bognere1c147c2014-03-28 22:03:19 +00003182 LE.write<uint16_t>(Bits);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003183 Bits = 0;
Richard Smithd7329392015-04-21 21:46:32 +00003184 bool HadMacroDefinition = MacroOffset != 0;
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003185 Bits = (Bits << 1) | unsigned(HadMacroDefinition);
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003186 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
3187 Bits = (Bits << 1) | unsigned(II->isPoisoned());
Argyrios Kyrtzidis3084a612010-08-11 22:55:12 +00003188 Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003189 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
Justin Bognere1c147c2014-03-28 22:03:19 +00003190 LE.write<uint16_t>(Bits);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003191
Richard Smithd7329392015-04-21 21:46:32 +00003192 if (HadMacroDefinition)
3193 LE.write<uint32_t>(MacroOffset);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003194
Douglas Gregora868bbd2009-04-21 22:25:48 +00003195 // Emit the declaration IDs in reverse order, because the
3196 // IdentifierResolver provides the declarations as they would be
3197 // visible (e.g., the function "stat" would come before the struct
Richard Smithb3761912015-02-05 23:08:52 +00003198 // "stat"), but the ASTReader adds declarations to the end of the list
3199 // (so we need to see the struct "stat" before the function "stat").
Sebastian Redlff4a2952010-07-23 23:49:55 +00003200 // Only emit declarations that aren't from a chained PCH, though.
Richard Smithb3761912015-02-05 23:08:52 +00003201 SmallVector<NamedDecl *, 16> Decls(IdResolver.begin(II), IdResolver.end());
3202 for (SmallVectorImpl<NamedDecl *>::reverse_iterator D = Decls.rbegin(),
3203 DEnd = Decls.rend();
Douglas Gregore84a9da2009-04-20 20:36:09 +00003204 D != DEnd; ++D)
Richard Smithb3761912015-02-05 23:08:52 +00003205 LE.write<uint32_t>(
3206 Writer.getDeclID(getDeclForLocalLookup(PP.getLangOpts(), *D)));
Douglas Gregore84a9da2009-04-20 20:36:09 +00003207 }
3208};
3209} // end anonymous namespace
3210
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003211/// \brief Write the identifier table into the AST file.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003212///
3213/// The identifier table consists of a blob containing string data
3214/// (the actual identifiers themselves) and a separate "offsets" index
3215/// that maps identifier IDs to locations within the blob.
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003216void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
3217 IdentifierResolver &IdResolver,
3218 bool IsModule) {
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003219 using namespace llvm;
3220
3221 // Create and write out the blob that contains the identifier
3222 // strings.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003223 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003224 llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
Richard Smithd7329392015-04-21 21:46:32 +00003225 ASTIdentifierTableTrait Trait(*this, PP, IdResolver);
Mike Stump11289f42009-09-09 15:08:12 +00003226
Douglas Gregore6648fb2009-04-28 20:33:11 +00003227 // Look for any identifiers that were named while processing the
3228 // headers, but are otherwise not needed. We add these to the hash
3229 // table to enable checking of the predefines buffer in the case
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003230 // where the user adds new macro definitions when building the AST
Douglas Gregore6648fb2009-04-28 20:33:11 +00003231 // file.
Chandler Carruth8440c982015-03-26 23:54:15 +00003232 SmallVector<const IdentifierInfo *, 128> IIs;
Douglas Gregore6648fb2009-04-28 20:33:11 +00003233 for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
3234 IDEnd = PP.getIdentifierTable().end();
3235 ID != IDEnd; ++ID)
Chandler Carruth8440c982015-03-26 23:54:15 +00003236 IIs.push_back(ID->second);
3237 // Sort the identifiers lexicographically before getting them references so
3238 // that their order is stable.
3239 std::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>());
3240 for (const IdentifierInfo *II : IIs)
3241 getIdentifierRef(II);
Douglas Gregore6648fb2009-04-28 20:33:11 +00003242
Sebastian Redlff4a2952010-07-23 23:49:55 +00003243 // Create the on-disk hash table representation. We only store offsets
3244 // for identifiers that appear here for the first time.
3245 IdentifierOffsets.resize(NextIdentID - FirstIdentID);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003246 for (auto IdentIDPair : IdentifierIDs) {
3247 IdentifierInfo *II = const_cast<IdentifierInfo *>(IdentIDPair.first);
3248 IdentID ID = IdentIDPair.second;
3249 assert(II && "NULL identifier in identifier table");
3250 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
3251 Generator.insert(II, ID, Trait);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003252 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003253
Douglas Gregore84a9da2009-04-20 20:36:09 +00003254 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003255 SmallString<4096> IdentifierTable;
Douglas Gregora868bbd2009-04-21 22:25:48 +00003256 uint32_t BucketOffset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003257 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003258 using namespace llvm::support;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003259 llvm::raw_svector_ostream Out(IdentifierTable);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003260 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003261 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregora868bbd2009-04-21 22:25:48 +00003262 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003263 }
3264
3265 // Create a blob abbreviation
3266 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003267 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
Douglas Gregora868bbd2009-04-21 22:25:48 +00003268 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregore84a9da2009-04-20 20:36:09 +00003269 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Douglas Gregor8f45df52009-04-16 22:23:12 +00003270 unsigned IDTableAbbrev = Stream.EmitAbbrev(Abbrev);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003271
3272 // Write the identifier table
3273 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00003274 Record.push_back(IDENTIFIER_TABLE);
Douglas Gregora868bbd2009-04-21 22:25:48 +00003275 Record.push_back(BucketOffset);
Yaron Keren92e1b622015-03-18 10:17:07 +00003276 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003277 }
3278
3279 // Write the offsets table for identifier IDs.
Douglas Gregor0e149972009-04-25 19:10:14 +00003280 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003281 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
Douglas Gregor0e149972009-04-25 19:10:14 +00003282 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
Douglas Gregor1ab036c2011-08-03 21:49:18 +00003283 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor0e149972009-04-25 19:10:14 +00003284 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3285 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
3286
Douglas Gregor8d7edce2013-02-08 21:30:59 +00003287#ifndef NDEBUG
3288 for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I)
3289 assert(IdentifierOffsets[I] && "Missing identifier offset?");
3290#endif
3291
Douglas Gregor0e149972009-04-25 19:10:14 +00003292 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00003293 Record.push_back(IDENTIFIER_OFFSET);
Douglas Gregor0e149972009-04-25 19:10:14 +00003294 Record.push_back(IdentifierOffsets.size());
Douglas Gregor1ab036c2011-08-03 21:49:18 +00003295 Record.push_back(FirstIdentID - NUM_PREDEF_IDENT_IDS);
Douglas Gregor0e149972009-04-25 19:10:14 +00003296 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00003297 bytes(IdentifierOffsets));
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003298}
3299
Douglas Gregorc5046832009-04-27 18:38:38 +00003300//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003301// DeclContext's Name Lookup Table Serialization
3302//===----------------------------------------------------------------------===//
3303
3304namespace {
3305// Trait used for the on-disk hash table used in the method pool.
3306class ASTDeclContextNameLookupTrait {
3307 ASTWriter &Writer;
3308
3309public:
3310 typedef DeclarationName key_type;
3311 typedef key_type key_type_ref;
3312
3313 typedef DeclContext::lookup_result data_type;
3314 typedef const data_type& data_type_ref;
3315
Justin Bogner25463f12014-04-18 20:27:24 +00003316 typedef unsigned hash_value_type;
3317 typedef unsigned offset_type;
3318
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003319 explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) { }
3320
Justin Bogner25463f12014-04-18 20:27:24 +00003321 hash_value_type ComputeHash(DeclarationName Name) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003322 llvm::FoldingSetNodeID ID;
3323 ID.AddInteger(Name.getNameKind());
3324
3325 switch (Name.getNameKind()) {
3326 case DeclarationName::Identifier:
3327 ID.AddString(Name.getAsIdentifierInfo()->getName());
3328 break;
3329 case DeclarationName::ObjCZeroArgSelector:
3330 case DeclarationName::ObjCOneArgSelector:
3331 case DeclarationName::ObjCMultiArgSelector:
3332 ID.AddInteger(serialization::ComputeHash(Name.getObjCSelector()));
3333 break;
3334 case DeclarationName::CXXConstructorName:
3335 case DeclarationName::CXXDestructorName:
3336 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003337 break;
3338 case DeclarationName::CXXOperatorName:
3339 ID.AddInteger(Name.getCXXOverloadedOperator());
3340 break;
3341 case DeclarationName::CXXLiteralOperatorName:
3342 ID.AddString(Name.getCXXLiteralIdentifier()->getName());
3343 case DeclarationName::CXXUsingDirective:
3344 break;
3345 }
3346
3347 return ID.ComputeHash();
3348 }
3349
3350 std::pair<unsigned,unsigned>
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003351 EmitKeyDataLength(raw_ostream& Out, DeclarationName Name,
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003352 data_type_ref Lookup) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003353 using namespace llvm::support;
3354 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003355 unsigned KeyLen = 1;
3356 switch (Name.getNameKind()) {
3357 case DeclarationName::Identifier:
3358 case DeclarationName::ObjCZeroArgSelector:
3359 case DeclarationName::ObjCOneArgSelector:
3360 case DeclarationName::ObjCMultiArgSelector:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003361 case DeclarationName::CXXLiteralOperatorName:
3362 KeyLen += 4;
3363 break;
3364 case DeclarationName::CXXOperatorName:
3365 KeyLen += 1;
3366 break;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003367 case DeclarationName::CXXConstructorName:
3368 case DeclarationName::CXXDestructorName:
3369 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003370 case DeclarationName::CXXUsingDirective:
3371 break;
3372 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003373 LE.write<uint16_t>(KeyLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003374
3375 // 2 bytes for num of decls and 4 for each DeclID.
David Blaikieff7d47a2012-12-19 00:45:41 +00003376 unsigned DataLen = 2 + 4 * Lookup.size();
Justin Bognere1c147c2014-03-28 22:03:19 +00003377 LE.write<uint16_t>(DataLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003378
3379 return std::make_pair(KeyLen, DataLen);
3380 }
3381
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003382 void EmitKey(raw_ostream& Out, DeclarationName Name, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003383 using namespace llvm::support;
3384 endian::Writer<little> LE(Out);
3385 LE.write<uint8_t>(Name.getNameKind());
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003386 switch (Name.getNameKind()) {
3387 case DeclarationName::Identifier:
Justin Bognere1c147c2014-03-28 22:03:19 +00003388 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getAsIdentifierInfo()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003389 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003390 case DeclarationName::ObjCZeroArgSelector:
3391 case DeclarationName::ObjCOneArgSelector:
3392 case DeclarationName::ObjCMultiArgSelector:
Justin Bognere1c147c2014-03-28 22:03:19 +00003393 LE.write<uint32_t>(Writer.getSelectorRef(Name.getObjCSelector()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003394 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003395 case DeclarationName::CXXOperatorName:
Benjamin Kramer53750b12012-09-19 13:40:40 +00003396 assert(Name.getCXXOverloadedOperator() < NUM_OVERLOADED_OPERATORS &&
3397 "Invalid operator?");
Justin Bognere1c147c2014-03-28 22:03:19 +00003398 LE.write<uint8_t>(Name.getCXXOverloadedOperator());
Benjamin Kramer53750b12012-09-19 13:40:40 +00003399 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003400 case DeclarationName::CXXLiteralOperatorName:
Justin Bognere1c147c2014-03-28 22:03:19 +00003401 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getCXXLiteralIdentifier()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003402 return;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003403 case DeclarationName::CXXConstructorName:
3404 case DeclarationName::CXXDestructorName:
3405 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003406 case DeclarationName::CXXUsingDirective:
Benjamin Kramer53750b12012-09-19 13:40:40 +00003407 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003408 }
Benjamin Kramer53750b12012-09-19 13:40:40 +00003409
3410 llvm_unreachable("Invalid name kind?");
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003411 }
3412
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003413 void EmitData(raw_ostream& Out, key_type_ref,
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003414 data_type Lookup, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003415 using namespace llvm::support;
3416 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003417 uint64_t Start = Out.tell(); (void)Start;
Justin Bognere1c147c2014-03-28 22:03:19 +00003418 LE.write<uint16_t>(Lookup.size());
David Blaikieff7d47a2012-12-19 00:45:41 +00003419 for (DeclContext::lookup_iterator I = Lookup.begin(), E = Lookup.end();
3420 I != E; ++I)
Richard Smithb3761912015-02-05 23:08:52 +00003421 LE.write<uint32_t>(
3422 Writer.GetDeclRef(getDeclForLocalLookup(Writer.getLangOpts(), *I)));
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003423
3424 assert(Out.tell() - Start == DataLen && "Data length is wrong");
3425 }
3426};
3427} // end anonymous namespace
3428
Chandler Carruthe972c362015-03-26 03:11:40 +00003429bool ASTWriter::isLookupResultExternal(StoredDeclsList &Result,
3430 DeclContext *DC) {
3431 return Result.hasExternalDecls() && DC->NeedToReconcileExternalVisibleStorage;
3432}
3433
3434bool ASTWriter::isLookupResultEntirelyExternal(StoredDeclsList &Result,
3435 DeclContext *DC) {
3436 for (auto *D : Result.getLookupResult())
3437 if (!getDeclForLocalLookup(getLangOpts(), D)->isFromASTFile())
3438 return false;
3439
3440 return true;
3441}
3442
Richard Smithcd45dbc2014-04-19 03:48:30 +00003443uint32_t
Chandler Carruthe972c362015-03-26 03:11:40 +00003444ASTWriter::GenerateNameLookupTable(const DeclContext *ConstDC,
Richard Smithcd45dbc2014-04-19 03:48:30 +00003445 llvm::SmallVectorImpl<char> &LookupTable) {
Chandler Carruthe972c362015-03-26 03:11:40 +00003446 assert(!ConstDC->HasLazyLocalLexicalLookups &&
3447 !ConstDC->HasLazyExternalLexicalLookups &&
Richard Smith9e2341d2015-03-23 03:25:59 +00003448 "must call buildLookups first");
Richard Smithcd45dbc2014-04-19 03:48:30 +00003449
Chandler Carruthe972c362015-03-26 03:11:40 +00003450 // FIXME: We need to build the lookups table, which is logically const.
3451 DeclContext *DC = const_cast<DeclContext*>(ConstDC);
3452 assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
3453
3454 // Create the on-disk hash table representation.
Richard Smithcd45dbc2014-04-19 03:48:30 +00003455 llvm::OnDiskChainedHashTableGenerator<ASTDeclContextNameLookupTrait>
3456 Generator;
3457 ASTDeclContextNameLookupTrait Trait(*this);
3458
Chandler Carruthe972c362015-03-26 03:11:40 +00003459 // The first step is to collect the declaration names which we need to
3460 // serialize into the name lookup table, and to collect them in a stable
3461 // order.
3462 SmallVector<DeclarationName, 16> Names;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003463
Chandler Carruthe972c362015-03-26 03:11:40 +00003464 // We also build up small sets of the constructor and conversion function
3465 // names which are visible.
3466 llvm::SmallSet<DeclarationName, 8> ConstructorNameSet, ConversionNameSet;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003467
Chandler Carruthe972c362015-03-26 03:11:40 +00003468 for (auto &Lookup : *DC->buildLookup()) {
3469 auto &Name = Lookup.first;
3470 auto &Result = Lookup.second;
3471
3472 // If there are no local declarations in our lookup result, we don't
3473 // need to write an entry for the name at all unless we're rewriting
3474 // the decl context. If we can't write out a lookup set without
3475 // performing more deserialization, just skip this entry.
3476 if (isLookupResultExternal(Result, DC) && !isRewritten(cast<Decl>(DC)) &&
3477 isLookupResultEntirelyExternal(Result, DC))
3478 continue;
3479
3480 // We also skip empty results. If any of the results could be external and
3481 // the currently available results are empty, then all of the results are
3482 // external and we skip it above. So the only way we get here with an empty
3483 // results is when no results could have been external *and* we have
3484 // external results.
3485 //
3486 // FIXME: While we might want to start emitting on-disk entries for negative
3487 // lookups into a decl context as an optimization, today we *have* to skip
3488 // them because there are names with empty lookup results in decl contexts
3489 // which we can't emit in any stable ordering: we lookup constructors and
3490 // conversion functions in the enclosing namespace scope creating empty
3491 // results for them. This in almost certainly a bug in Clang's name lookup,
3492 // but that is likely to be hard or impossible to fix and so we tolerate it
3493 // here by omitting lookups with empty results.
3494 if (Lookup.second.getLookupResult().empty())
3495 continue;
3496
3497 switch (Lookup.first.getNameKind()) {
3498 default:
3499 Names.push_back(Lookup.first);
3500 break;
3501
Richard Smithcd45dbc2014-04-19 03:48:30 +00003502 case DeclarationName::CXXConstructorName:
Chandler Carruthe972c362015-03-26 03:11:40 +00003503 assert(isa<CXXRecordDecl>(DC) &&
3504 "Cannot have a constructor name outside of a class!");
3505 ConstructorNameSet.insert(Name);
3506 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003507
3508 case DeclarationName::CXXConversionFunctionName:
Chandler Carruthe972c362015-03-26 03:11:40 +00003509 assert(isa<CXXRecordDecl>(DC) &&
3510 "Cannot have a conversion function name outside of a class!");
3511 ConversionNameSet.insert(Name);
Rafael Espindolac606b3e2015-03-25 04:43:15 +00003512 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003513 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00003514 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00003515
Chandler Carruthe972c362015-03-26 03:11:40 +00003516 // Sort the names into a stable order.
3517 std::sort(Names.begin(), Names.end());
3518
Chandler Carruthffbf7052015-03-26 22:27:09 +00003519 if (auto *D = dyn_cast<CXXRecordDecl>(DC)) {
Chandler Carruthe972c362015-03-26 03:11:40 +00003520 // We need to establish an ordering of constructor and conversion function
Chandler Carruthffbf7052015-03-26 22:27:09 +00003521 // names, and they don't have an intrinsic ordering.
Chandler Carruthe972c362015-03-26 03:11:40 +00003522
Chandler Carruthffbf7052015-03-26 22:27:09 +00003523 // First we try the easy case by forming the current context's constructor
3524 // name and adding that name first. This is a very useful optimization to
3525 // avoid walking the lexical declarations in many cases, and it also
3526 // handles the only case where a constructor name can come from some other
3527 // lexical context -- when that name is an implicit constructor merged from
3528 // another declaration in the redecl chain. Any non-implicit constructor or
3529 // conversion function which doesn't occur in all the lexical contexts
3530 // would be an ODR violation.
3531 auto ImplicitCtorName = Context->DeclarationNames.getCXXConstructorName(
3532 Context->getCanonicalType(Context->getRecordType(D)));
3533 if (ConstructorNameSet.erase(ImplicitCtorName))
3534 Names.push_back(ImplicitCtorName);
Chandler Carruthe972c362015-03-26 03:11:40 +00003535
Chandler Carruthffbf7052015-03-26 22:27:09 +00003536 // If we still have constructors or conversion functions, we walk all the
3537 // names in the decl and add the constructors and conversion functions
3538 // which are visible in the order they lexically occur within the context.
3539 if (!ConstructorNameSet.empty() || !ConversionNameSet.empty())
3540 for (Decl *ChildD : cast<CXXRecordDecl>(DC)->decls())
3541 if (auto *ChildND = dyn_cast<NamedDecl>(ChildD)) {
3542 auto Name = ChildND->getDeclName();
3543 switch (Name.getNameKind()) {
3544 default:
3545 continue;
3546
3547 case DeclarationName::CXXConstructorName:
3548 if (ConstructorNameSet.erase(Name))
3549 Names.push_back(Name);
3550 break;
3551
3552 case DeclarationName::CXXConversionFunctionName:
3553 if (ConversionNameSet.erase(Name))
3554 Names.push_back(Name);
3555 break;
3556 }
3557
3558 if (ConstructorNameSet.empty() && ConversionNameSet.empty())
3559 break;
Chandler Carruthe972c362015-03-26 03:11:40 +00003560 }
3561
Chandler Carruthe972c362015-03-26 03:11:40 +00003562 assert(ConstructorNameSet.empty() && "Failed to find all of the visible "
3563 "constructors by walking all the "
3564 "lexical members of the context.");
3565 assert(ConversionNameSet.empty() && "Failed to find all of the visible "
3566 "conversion functions by walking all "
3567 "the lexical members of the context.");
Richard Smith961eae52014-03-25 01:14:22 +00003568 }
3569
Chandler Carruthe972c362015-03-26 03:11:40 +00003570 // Next we need to do a lookup with each name into this decl context to fully
3571 // populate any results from external sources. We don't actually use the
3572 // results of these lookups because we only want to use the results after all
3573 // results have been loaded and the pointers into them will be stable.
3574 for (auto &Name : Names)
3575 DC->lookup(Name);
3576
3577 // Now we need to insert the results for each name into the hash table. For
3578 // constructor names and conversion function names, we actually need to merge
3579 // all of the results for them into one list of results each and insert
3580 // those.
3581 SmallVector<NamedDecl *, 8> ConstructorDecls;
3582 SmallVector<NamedDecl *, 8> ConversionDecls;
3583
3584 // Now loop over the names, either inserting them or appending for the two
3585 // special cases.
3586 for (auto &Name : Names) {
3587 DeclContext::lookup_result Result = DC->noload_lookup(Name);
3588
3589 switch (Name.getNameKind()) {
3590 default:
3591 Generator.insert(Name, Result, Trait);
3592 break;
3593
3594 case DeclarationName::CXXConstructorName:
3595 ConstructorDecls.append(Result.begin(), Result.end());
3596 break;
3597
3598 case DeclarationName::CXXConversionFunctionName:
3599 ConversionDecls.append(Result.begin(), Result.end());
3600 break;
3601 }
3602 }
3603
3604 // Handle our two special cases if we ended up having any. We arbitrarily use
3605 // the first declaration's name here because the name itself isn't part of
3606 // the key, only the kind of name is used.
3607 if (!ConstructorDecls.empty())
3608 Generator.insert(ConstructorDecls.front()->getDeclName(),
3609 DeclContext::lookup_result(ConstructorDecls), Trait);
3610 if (!ConversionDecls.empty())
3611 Generator.insert(ConversionDecls.front()->getDeclName(),
3612 DeclContext::lookup_result(ConversionDecls), Trait);
3613
Richard Smith961eae52014-03-25 01:14:22 +00003614 // Create the on-disk hash table in a buffer.
3615 llvm::raw_svector_ostream Out(LookupTable);
3616 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003617 using namespace llvm::support;
3618 endian::Writer<little>(Out).write<uint32_t>(0);
Richard Smith961eae52014-03-25 01:14:22 +00003619 return Generator.Emit(Out, Trait);
3620}
3621
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003622/// \brief Write the block containing all of the declaration IDs
3623/// visible from the given DeclContext.
3624///
3625/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
Sebastian Redla4071b42010-08-24 00:50:09 +00003626/// bitstream, or 0 if no block was written.
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003627uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
3628 DeclContext *DC) {
3629 if (DC->getPrimaryContext() != DC)
3630 return 0;
3631
Chandler Carruthe972c362015-03-26 03:11:40 +00003632 // Skip contexts which don't support name lookup.
3633 if (!DC->isLookupContext())
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003634 return 0;
3635
3636 // If not in C++, we perform name lookup for the translation unit via the
3637 // IdentifierInfo chains, don't bother to build a visible-declarations table.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003638 if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003639 return 0;
3640
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003641 // Serialize the contents of the mapping used for lookup. Note that,
3642 // although we have two very different code paths, the serialized
3643 // representation is the same for both cases: a declaration name,
3644 // followed by a size, followed by references to the visible
3645 // declarations that have that name.
3646 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smithf634c902012-03-16 06:12:59 +00003647 StoredDeclsMap *Map = DC->buildLookup();
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003648 if (!Map || Map->empty())
3649 return 0;
3650
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003651 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003652 SmallString<4096> LookupTable;
Richard Smith961eae52014-03-25 01:14:22 +00003653 uint32_t BucketOffset = GenerateNameLookupTable(DC, LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003654
3655 // Write the lookup table
3656 RecordData Record;
3657 Record.push_back(DECL_CONTEXT_VISIBLE);
3658 Record.push_back(BucketOffset);
3659 Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
Yaron Keren92e1b622015-03-18 10:17:07 +00003660 LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003661 ++NumVisibleDeclContexts;
3662 return Offset;
3663}
3664
Sebastian Redla4071b42010-08-24 00:50:09 +00003665/// \brief Write an UPDATE_VISIBLE block for the given context.
3666///
3667/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
3668/// DeclContext in a dependent AST file. As such, they only exist for the TU
Richard Smithf634c902012-03-16 06:12:59 +00003669/// (in C++), for namespaces, and for classes with forward-declared unscoped
3670/// enumeration members (in C++11).
Sebastian Redla4071b42010-08-24 00:50:09 +00003671void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
Richard Smith961eae52014-03-25 01:14:22 +00003672 StoredDeclsMap *Map = DC->getLookupPtr();
Sebastian Redla4071b42010-08-24 00:50:09 +00003673 if (!Map || Map->empty())
3674 return;
3675
Sebastian Redla4071b42010-08-24 00:50:09 +00003676 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003677 SmallString<4096> LookupTable;
Richard Smith961eae52014-03-25 01:14:22 +00003678 uint32_t BucketOffset = GenerateNameLookupTable(DC, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00003679
3680 // Write the lookup table
3681 RecordData Record;
3682 Record.push_back(UPDATE_VISIBLE);
3683 Record.push_back(getDeclID(cast<Decl>(DC)));
3684 Record.push_back(BucketOffset);
Yaron Keren92e1b622015-03-18 10:17:07 +00003685 Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00003686}
3687
Peter Collingbourne5df20e02011-02-15 19:46:30 +00003688/// \brief Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
3689void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) {
3690 RecordData Record;
3691 Record.push_back(Opts.fp_contract);
3692 Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
3693}
3694
3695/// \brief Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
3696void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00003697 if (!SemaRef.Context.getLangOpts().OpenCL)
Peter Collingbourne5df20e02011-02-15 19:46:30 +00003698 return;
3699
3700 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
3701 RecordData Record;
3702#define OPENCLEXT(nm) Record.push_back(Opts.nm);
3703#include "clang/Basic/OpenCLExtensions.def"
3704 Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
3705}
3706
Douglas Gregor358cd442012-01-15 16:58:34 +00003707void ASTWriter::WriteRedeclarations() {
3708 RecordData LocalRedeclChains;
3709 SmallVector<serialization::LocalRedeclarationsInfo, 2> LocalRedeclsMap;
3710
3711 for (unsigned I = 0, N = Redeclarations.size(); I != N; ++I) {
3712 Decl *First = Redeclarations[I];
Rafael Espindola3f9e4442013-10-19 02:13:21 +00003713 assert(First->isFirstDecl() && "Not the first declaration?");
Douglas Gregor358cd442012-01-15 16:58:34 +00003714
3715 Decl *MostRecent = First->getMostRecentDecl();
3716
3717 // If we only have a single declaration, there is no point in storing
3718 // a redeclaration chain.
3719 if (First == MostRecent)
3720 continue;
3721
3722 unsigned Offset = LocalRedeclChains.size();
3723 unsigned Size = 0;
3724 LocalRedeclChains.push_back(0); // Placeholder for the size.
3725
3726 // Collect the set of local redeclarations of this declaration.
Douglas Gregor6168bd22013-02-18 15:53:43 +00003727 for (Decl *Prev = MostRecent; Prev != First;
Douglas Gregor358cd442012-01-15 16:58:34 +00003728 Prev = Prev->getPreviousDecl()) {
3729 if (!Prev->isFromASTFile()) {
3730 AddDeclRef(Prev, LocalRedeclChains);
3731 ++Size;
3732 }
3733 }
Douglas Gregor6168bd22013-02-18 15:53:43 +00003734
Douglas Gregor358cd442012-01-15 16:58:34 +00003735 LocalRedeclChains[Offset] = Size;
3736
3737 // Reverse the set of local redeclarations, so that we store them in
3738 // order (since we found them in reverse order).
3739 std::reverse(LocalRedeclChains.end() - Size, LocalRedeclChains.end());
3740
Douglas Gregor6168bd22013-02-18 15:53:43 +00003741 // Add the mapping from the first ID from the AST to the set of local
3742 // declarations.
Douglas Gregor358cd442012-01-15 16:58:34 +00003743 LocalRedeclarationsInfo Info = { getDeclID(First), Offset };
3744 LocalRedeclsMap.push_back(Info);
3745
3746 assert(N == Redeclarations.size() &&
3747 "Deserialized a declaration we shouldn't have");
3748 }
3749
3750 if (LocalRedeclChains.empty())
3751 return;
3752
3753 // Sort the local redeclarations map by the first declaration ID,
3754 // since the reader will be performing binary searches on this information.
3755 llvm::array_pod_sort(LocalRedeclsMap.begin(), LocalRedeclsMap.end());
3756
3757 // Emit the local redeclarations map.
3758 using namespace llvm;
3759 llvm::BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
3760 Abbrev->Add(BitCodeAbbrevOp(LOCAL_REDECLARATIONS_MAP));
3761 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
3762 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3763 unsigned AbbrevID = Stream.EmitAbbrev(Abbrev);
3764
3765 RecordData Record;
3766 Record.push_back(LOCAL_REDECLARATIONS_MAP);
3767 Record.push_back(LocalRedeclsMap.size());
3768 Stream.EmitRecordWithBlob(AbbrevID, Record,
3769 reinterpret_cast<char*>(LocalRedeclsMap.data()),
3770 LocalRedeclsMap.size() * sizeof(LocalRedeclarationsInfo));
3771
3772 // Emit the redeclaration chains.
3773 Stream.EmitRecord(LOCAL_REDECLARATIONS, LocalRedeclChains);
3774}
3775
Douglas Gregor404cdde2012-01-27 01:47:08 +00003776void ASTWriter::WriteObjCCategories() {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003777 SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
Douglas Gregor404cdde2012-01-27 01:47:08 +00003778 RecordData Categories;
3779
3780 for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
3781 unsigned Size = 0;
3782 unsigned StartIndex = Categories.size();
3783
3784 ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
3785
3786 // Allocate space for the size.
3787 Categories.push_back(0);
3788
3789 // Add the categories.
Douglas Gregor048fbfa2013-01-16 23:00:23 +00003790 for (ObjCInterfaceDecl::known_categories_iterator
3791 Cat = Class->known_categories_begin(),
3792 CatEnd = Class->known_categories_end();
3793 Cat != CatEnd; ++Cat, ++Size) {
3794 assert(getDeclID(*Cat) != 0 && "Bogus category");
3795 AddDeclRef(*Cat, Categories);
Douglas Gregor404cdde2012-01-27 01:47:08 +00003796 }
3797
3798 // Update the size.
3799 Categories[StartIndex] = Size;
3800
3801 // Record this interface -> category map.
3802 ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex };
3803 CategoriesMap.push_back(CatInfo);
3804 }
3805
3806 // Sort the categories map by the definition ID, since the reader will be
3807 // performing binary searches on this information.
3808 llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end());
3809
3810 // Emit the categories map.
3811 using namespace llvm;
3812 llvm::BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
3813 Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
3814 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
3815 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3816 unsigned AbbrevID = Stream.EmitAbbrev(Abbrev);
3817
3818 RecordData Record;
3819 Record.push_back(OBJC_CATEGORIES_MAP);
3820 Record.push_back(CategoriesMap.size());
3821 Stream.EmitRecordWithBlob(AbbrevID, Record,
3822 reinterpret_cast<char*>(CategoriesMap.data()),
3823 CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
3824
3825 // Emit the category lists.
3826 Stream.EmitRecord(OBJC_CATEGORIES, Categories);
3827}
3828
Richard Smithe40f2ba2013-08-07 21:41:30 +00003829void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
3830 Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap;
3831
3832 if (LPTMap.empty())
3833 return;
3834
3835 RecordData Record;
Chandler Carruth52cee4d2015-03-26 09:08:15 +00003836 for (auto LPTMapEntry : LPTMap) {
3837 const FunctionDecl *FD = LPTMapEntry.first;
3838 LateParsedTemplate *LPT = LPTMapEntry.second;
3839 AddDeclRef(FD, Record);
Richard Smithe40f2ba2013-08-07 21:41:30 +00003840 AddDeclRef(LPT->D, Record);
3841 Record.push_back(LPT->Toks.size());
3842
3843 for (CachedTokens::iterator TokIt = LPT->Toks.begin(),
3844 TokEnd = LPT->Toks.end();
3845 TokIt != TokEnd; ++TokIt) {
3846 AddToken(*TokIt, Record);
3847 }
3848 }
3849 Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record);
3850}
3851
Dario Domizioli13a0a382014-05-23 12:13:25 +00003852/// \brief Write the state of 'pragma clang optimize' at the end of the module.
3853void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
3854 RecordData Record;
3855 SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
3856 AddSourceLocation(PragmaLoc, Record);
3857 Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record);
3858}
3859
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003860//===----------------------------------------------------------------------===//
Douglas Gregorc5046832009-04-27 18:38:38 +00003861// General Serialization Routines
3862//===----------------------------------------------------------------------===//
3863
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00003864/// \brief Write a record containing the given attributes.
Alexander Kornienko20f6fc62012-07-09 10:04:07 +00003865void ASTWriter::WriteAttributes(ArrayRef<const Attr*> Attrs,
3866 RecordDataImpl &Record) {
Argyrios Kyrtzidis9beef8e2010-10-18 19:20:11 +00003867 Record.push_back(Attrs.size());
Alexander Kornienko20f6fc62012-07-09 10:04:07 +00003868 for (ArrayRef<const Attr *>::iterator i = Attrs.begin(),
3869 e = Attrs.end(); i != e; ++i){
3870 const Attr *A = *i;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00003871 Record.push_back(A->getKind()); // FIXME: stable encoding, target attrs
Argyrios Kyrtzidis309b4c42011-09-13 16:05:58 +00003872 AddSourceRange(A->getRange(), Record);
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00003873
Alexis Huntdcfba7b2010-08-18 23:23:40 +00003874#include "clang/Serialization/AttrPCHWrite.inc"
Daniel Dunbarfc6507e2010-05-27 02:25:39 +00003875
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00003876 }
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00003877}
3878
John McCallf413f5e2013-05-03 00:10:13 +00003879void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) {
3880 AddSourceLocation(Tok.getLocation(), Record);
3881 Record.push_back(Tok.getLength());
3882
3883 // FIXME: When reading literal tokens, reconstruct the literal pointer
3884 // if it is needed.
3885 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
3886 // FIXME: Should translate token kind to a stable encoding.
3887 Record.push_back(Tok.getKind());
3888 // FIXME: Should translate token flags to a stable encoding.
3889 Record.push_back(Tok.getFlags());
3890}
3891
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003892void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00003893 Record.push_back(Str.size());
3894 Record.insert(Record.end(), Str.begin(), Str.end());
3895}
3896
Richard Smith7ed1bc92014-12-05 22:42:13 +00003897bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) {
Richard Smith54cc3c22014-12-11 20:50:24 +00003898 assert(Context && "should have context when outputting path");
Richard Smith7ed1bc92014-12-05 22:42:13 +00003899
Richard Smith54cc3c22014-12-11 20:50:24 +00003900 bool Changed =
3901 cleanPathForOutput(Context->getSourceManager().getFileManager(), Path);
Richard Smith7ed1bc92014-12-05 22:42:13 +00003902
3903 // Remove a prefix to make the path relative, if relevant.
3904 const char *PathBegin = Path.data();
3905 const char *PathPtr =
3906 adjustFilenameForRelocatableAST(PathBegin, BaseDirectory);
3907 if (PathPtr != PathBegin) {
3908 Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin));
3909 Changed = true;
3910 }
3911
3912 return Changed;
3913}
3914
3915void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) {
3916 SmallString<128> FilePath(Path);
3917 PreparePathForOutput(FilePath);
3918 AddString(FilePath, Record);
3919}
3920
3921void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataImpl &Record,
3922 StringRef Path) {
3923 SmallString<128> FilePath(Path);
3924 PreparePathForOutput(FilePath);
3925 Stream.EmitRecordWithBlob(Abbrev, Record, FilePath);
3926}
3927
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00003928void ASTWriter::AddVersionTuple(const VersionTuple &Version,
3929 RecordDataImpl &Record) {
3930 Record.push_back(Version.getMajor());
David Blaikie05785d12013-02-20 22:23:23 +00003931 if (Optional<unsigned> Minor = Version.getMinor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00003932 Record.push_back(*Minor + 1);
3933 else
3934 Record.push_back(0);
David Blaikie05785d12013-02-20 22:23:23 +00003935 if (Optional<unsigned> Subminor = Version.getSubminor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00003936 Record.push_back(*Subminor + 1);
3937 else
3938 Record.push_back(0);
3939}
3940
Douglas Gregore84a9da2009-04-20 20:36:09 +00003941/// \brief Note that the identifier II occurs at the given offset
3942/// within the identifier table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003943void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
Sebastian Redl539c5062010-08-18 23:57:32 +00003944 IdentID ID = IdentifierIDs[II];
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003945 // Only store offsets new to this AST file. Other identifier names are looked
Sebastian Redlff4a2952010-07-23 23:49:55 +00003946 // up earlier in the chain and thus don't need an offset.
3947 if (ID >= FirstIdentID)
3948 IdentifierOffsets[ID - FirstIdentID] = Offset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003949}
3950
Douglas Gregor95c13f52009-04-25 17:48:32 +00003951/// \brief Note that the selector Sel occurs at the given offset
3952/// within the method pool/selector table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003953void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
Douglas Gregor95c13f52009-04-25 17:48:32 +00003954 unsigned ID = SelectorIDs[Sel];
3955 assert(ID && "Unknown selector");
Sebastian Redld95a56e2010-08-04 18:21:41 +00003956 // Don't record offsets for selectors that are also available in a different
3957 // file.
3958 if (ID < FirstSelectorID)
3959 return;
3960 SelectorOffsets[ID - FirstSelectorID] = Offset;
Douglas Gregor95c13f52009-04-25 17:48:32 +00003961}
3962
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003963ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream)
Richard Smith01b2cb42014-07-26 06:37:51 +00003964 : Stream(Stream), Context(nullptr), PP(nullptr), Chain(nullptr),
3965 WritingModule(nullptr), WritingAST(false),
3966 DoneWritingDeclsAndTypes(false), ASTHasCompilerErrors(false),
3967 FirstDeclID(NUM_PREDEF_DECL_IDS), NextDeclID(FirstDeclID),
3968 FirstTypeID(NUM_PREDEF_TYPE_IDS), NextTypeID(FirstTypeID),
3969 FirstIdentID(NUM_PREDEF_IDENT_IDS), NextIdentID(FirstIdentID),
3970 FirstMacroID(NUM_PREDEF_MACRO_IDS), NextMacroID(FirstMacroID),
3971 FirstSubmoduleID(NUM_PREDEF_SUBMODULE_IDS),
3972 NextSubmoduleID(FirstSubmoduleID),
3973 FirstSelectorID(NUM_PREDEF_SELECTOR_IDS), NextSelectorID(FirstSelectorID),
3974 CollectedStmts(&StmtsToEmit), NumStatements(0), NumMacros(0),
3975 NumLexicalDeclContexts(0), NumVisibleDeclContexts(0),
Richard Smithc2bb8182015-03-24 06:36:48 +00003976 NextCXXBaseSpecifiersID(1), NextCXXCtorInitializersID(1),
3977 TypeExtQualAbbrev(0),
Richard Smith01b2cb42014-07-26 06:37:51 +00003978 TypeFunctionProtoAbbrev(0), DeclParmVarAbbrev(0),
3979 DeclContextLexicalAbbrev(0), DeclContextVisibleLookupAbbrev(0),
Richard Smitha27c26e2014-07-27 04:19:32 +00003980 UpdateVisibleAbbrev(0), DeclRecordAbbrev(0), DeclTypedefAbbrev(0),
Richard Smith01b2cb42014-07-26 06:37:51 +00003981 DeclVarAbbrev(0), DeclFieldAbbrev(0), DeclEnumAbbrev(0),
Richard Smitha27c26e2014-07-27 04:19:32 +00003982 DeclObjCIvarAbbrev(0), DeclCXXMethodAbbrev(0), DeclRefExprAbbrev(0),
3983 CharacterLiteralAbbrev(0), IntegerLiteralAbbrev(0),
3984 ExprImplicitCastAbbrev(0) {}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003985
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003986ASTWriter::~ASTWriter() {
Reid Kleckner588c9372014-02-19 23:44:52 +00003987 llvm::DeleteContainerSeconds(FileDeclIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003988}
3989
Richard Smithb3761912015-02-05 23:08:52 +00003990const LangOptions &ASTWriter::getLangOpts() const {
3991 assert(WritingAST && "can't determine lang opts when not writing AST");
3992 return Context->getLangOpts();
3993}
3994
Argyrios Kyrtzidisd7c16b22012-10-31 20:59:50 +00003995void ASTWriter::WriteAST(Sema &SemaRef,
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00003996 const std::string &OutputFile,
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00003997 Module *WritingModule, StringRef isysroot,
3998 bool hasErrors) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00003999 WritingAST = true;
4000
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00004001 ASTHasCompilerErrors = hasErrors;
4002
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004003 // Emit the file header.
Douglas Gregor8f45df52009-04-16 22:23:12 +00004004 Stream.Emit((unsigned)'C', 8);
4005 Stream.Emit((unsigned)'P', 8);
4006 Stream.Emit((unsigned)'C', 8);
4007 Stream.Emit((unsigned)'H', 8);
Mike Stump11289f42009-09-09 15:08:12 +00004008
Chris Lattner28fa4e62009-04-26 22:26:21 +00004009 WriteBlockInfoBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004010
Douglas Gregoreda8e122011-08-09 15:13:55 +00004011 Context = &SemaRef.Context;
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004012 PP = &SemaRef.PP;
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004013 this->WritingModule = WritingModule;
Argyrios Kyrtzidisd7c16b22012-10-31 20:59:50 +00004014 WriteASTCore(SemaRef, isysroot, OutputFile, WritingModule);
Craig Toppera13603a2014-05-22 05:54:18 +00004015 Context = nullptr;
4016 PP = nullptr;
4017 this->WritingModule = nullptr;
Richard Smith7ed1bc92014-12-05 22:42:13 +00004018 this->BaseDirectory.clear();
Craig Toppera13603a2014-05-22 05:54:18 +00004019
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004020 WritingAST = false;
Sebastian Redl143413f2010-07-12 22:02:52 +00004021}
4022
Douglas Gregora94a1542011-07-27 21:45:57 +00004023template<typename Vector>
4024static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec,
4025 ASTWriter::RecordData &Record) {
Craig Toppera13603a2014-05-22 05:54:18 +00004026 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
4027 I != E; ++I) {
Douglas Gregora94a1542011-07-27 21:45:57 +00004028 Writer.AddDeclRef(*I, Record);
4029 }
4030}
4031
Argyrios Kyrtzidisd7c16b22012-10-31 20:59:50 +00004032void ASTWriter::WriteASTCore(Sema &SemaRef,
Douglas Gregorc567ba22011-07-22 16:35:34 +00004033 StringRef isysroot,
Douglas Gregorf7a700fd2011-11-30 04:39:39 +00004034 const std::string &OutputFile,
Douglas Gregorde3ef502011-11-30 23:21:26 +00004035 Module *WritingModule) {
Sebastian Redl143413f2010-07-12 22:02:52 +00004036 using namespace llvm;
4037
Craig Toppera13603a2014-05-22 05:54:18 +00004038 bool isModule = WritingModule != nullptr;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004039
Douglas Gregorcf68c582011-12-01 22:20:10 +00004040 // Make sure that the AST reader knows to finalize itself.
4041 if (Chain)
4042 Chain->finalizeForWriting();
4043
Sebastian Redl143413f2010-07-12 22:02:52 +00004044 ASTContext &Context = SemaRef.Context;
4045 Preprocessor &PP = SemaRef.PP;
4046
Douglas Gregordab42432011-08-12 00:15:20 +00004047 // Set up predefined declaration IDs.
4048 DeclIDs[Context.getTranslationUnitDecl()] = PREDEF_DECL_TRANSLATION_UNIT_ID;
Douglas Gregor3ea72692011-08-12 05:46:01 +00004049 if (Context.ObjCIdDecl)
4050 DeclIDs[Context.ObjCIdDecl] = PREDEF_DECL_OBJC_ID_ID;
Douglas Gregor52e02802011-08-12 06:17:30 +00004051 if (Context.ObjCSelDecl)
4052 DeclIDs[Context.ObjCSelDecl] = PREDEF_DECL_OBJC_SEL_ID;
Douglas Gregor0a586182011-08-12 05:59:41 +00004053 if (Context.ObjCClassDecl)
4054 DeclIDs[Context.ObjCClassDecl] = PREDEF_DECL_OBJC_CLASS_ID;
Douglas Gregord53ae832012-01-17 18:09:05 +00004055 if (Context.ObjCProtocolClassDecl)
4056 DeclIDs[Context.ObjCProtocolClassDecl] = PREDEF_DECL_OBJC_PROTOCOL_ID;
Douglas Gregor801c99d2011-08-12 06:49:56 +00004057 if (Context.Int128Decl)
4058 DeclIDs[Context.Int128Decl] = PREDEF_DECL_INT_128_ID;
4059 if (Context.UInt128Decl)
4060 DeclIDs[Context.UInt128Decl] = PREDEF_DECL_UNSIGNED_INT_128_ID;
Douglas Gregorbab8a962011-09-08 01:46:34 +00004061 if (Context.ObjCInstanceTypeDecl)
4062 DeclIDs[Context.ObjCInstanceTypeDecl] = PREDEF_DECL_OBJC_INSTANCETYPE_ID;
Meador Inge5d3fb222012-06-16 03:34:49 +00004063 if (Context.BuiltinVaListDecl)
4064 DeclIDs[Context.getBuiltinVaListDecl()] = PREDEF_DECL_BUILTIN_VA_LIST_ID;
Richard Smithf19e1272015-03-07 00:04:49 +00004065 if (Context.ExternCContext)
4066 DeclIDs[Context.ExternCContext] = PREDEF_DECL_EXTERN_C_CONTEXT_ID;
Meador Inge5d3fb222012-06-16 03:34:49 +00004067
Chris Lattner0c797362009-09-08 18:19:27 +00004068 // Build a record containing all of the tentative definitions in this file, in
Sebastian Redl35351a92010-01-31 22:27:38 +00004069 // TentativeDefinitions order. Generally, this record will be empty for
Chris Lattner0c797362009-09-08 18:19:27 +00004070 // headers.
Douglas Gregord4df8652009-04-22 22:02:47 +00004071 RecordData TentativeDefinitions;
Douglas Gregora94a1542011-07-27 21:45:57 +00004072 AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions);
Douglas Gregoreb08bd42011-07-27 20:58:46 +00004073
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004074 // Build a record containing all of the file scoped decls in this file.
4075 RecordData UnusedFileScopedDecls;
Argyrios Kyrtzidis59852362013-03-14 04:45:00 +00004076 if (!isModule)
4077 AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls,
4078 UnusedFileScopedDecls);
Sebastian Redl08aca90252010-08-05 18:21:25 +00004079
Douglas Gregor851443c2011-08-12 01:39:19 +00004080 // Build a record containing all of the delegating constructors we still need
4081 // to resolve.
Alexis Hunt27a761d2011-05-04 23:29:54 +00004082 RecordData DelegatingCtorDecls;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004083 if (!isModule)
4084 AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004085
Douglas Gregor851443c2011-08-12 01:39:19 +00004086 // Write the set of weak, undeclared identifiers. We always write the
4087 // entire table, since later PCH files in a PCH chain are only interested in
4088 // the results at the end of the chain.
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004089 RecordData WeakUndeclaredIdentifiers;
Chandler Carruthf85d9822015-03-26 08:32:49 +00004090 for (auto &WeakUndeclaredIdentifier : SemaRef.WeakUndeclaredIdentifiers) {
4091 IdentifierInfo *II = WeakUndeclaredIdentifier.first;
4092 WeakInfo &WI = WeakUndeclaredIdentifier.second;
4093 AddIdentifierRef(II, WeakUndeclaredIdentifiers);
4094 AddIdentifierRef(WI.getAlias(), WeakUndeclaredIdentifiers);
4095 AddSourceLocation(WI.getLocation(), WeakUndeclaredIdentifiers);
4096 WeakUndeclaredIdentifiers.push_back(WI.getUsed());
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004097 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004098
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004099 // Build a record containing all of the ext_vector declarations.
4100 RecordData ExtVectorDecls;
Douglas Gregorb7098a32011-07-28 00:39:29 +00004101 AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004102
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004103 // Build a record containing all of the VTable uses information.
4104 RecordData VTableUses;
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004105 if (!SemaRef.VTableUses.empty()) {
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004106 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
4107 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
4108 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
4109 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
4110 }
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004111 }
4112
Nico Weber72889432014-09-06 01:25:55 +00004113 // Build a record containing all of the UnusedLocalTypedefNameCandidates.
4114 RecordData UnusedLocalTypedefNameCandidates;
4115 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
4116 AddDeclRef(TD, UnusedLocalTypedefNameCandidates);
4117
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004118 // Build a record containing all of pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004119 RecordData PendingInstantiations;
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004120 for (std::deque<Sema::PendingImplicitInstantiation>::iterator
Chandler Carruth54080172010-08-25 08:44:16 +00004121 I = SemaRef.PendingInstantiations.begin(),
4122 N = SemaRef.PendingInstantiations.end(); I != N; ++I) {
4123 AddDeclRef(I->first, PendingInstantiations);
4124 AddSourceLocation(I->second, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004125 }
4126 assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
4127 "There are local ones at end of translation unit!");
4128
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004129 // Build a record containing some declaration references.
4130 RecordData SemaDeclRefs;
4131 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc) {
4132 AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
4133 AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
4134 }
4135
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004136 RecordData CUDASpecialDeclRefs;
4137 if (Context.getcudaConfigureCallDecl()) {
4138 AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs);
4139 }
4140
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004141 // Build a record containing all of the known namespaces.
4142 RecordData KnownNamespaces;
Nick Lewycky8334af82013-01-26 00:35:08 +00004143 for (llvm::MapVector<NamespaceDecl*, bool>::iterator
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004144 I = SemaRef.KnownNamespaces.begin(),
4145 IEnd = SemaRef.KnownNamespaces.end();
4146 I != IEnd; ++I) {
4147 if (!I->second)
4148 AddDeclRef(I->first, KnownNamespaces);
4149 }
Douglas Gregor112b9072012-10-18 05:31:06 +00004150
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004151 // Build a record of all used, undefined objects that require definitions.
4152 RecordData UndefinedButUsed;
Nick Lewyckyf0f56162013-01-31 03:23:57 +00004153
4154 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004155 SemaRef.getUndefinedButUsed(Undefined);
Nick Lewyckyf0f56162013-01-31 03:23:57 +00004156 for (SmallVectorImpl<std::pair<NamedDecl *, SourceLocation> >::iterator
4157 I = Undefined.begin(), E = Undefined.end(); I != E; ++I) {
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004158 AddDeclRef(I->first, UndefinedButUsed);
4159 AddSourceLocation(I->second, UndefinedButUsed);
Nick Lewycky8334af82013-01-26 00:35:08 +00004160 }
4161
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004162 // Build a record containing all delete-expressions that we would like to
4163 // analyze later in AST.
4164 RecordData DeleteExprsToAnalyze;
4165
4166 for (const auto &DeleteExprsInfo :
4167 SemaRef.getMismatchingDeleteExpressions()) {
4168 AddDeclRef(DeleteExprsInfo.first, DeleteExprsToAnalyze);
4169 DeleteExprsToAnalyze.push_back(DeleteExprsInfo.second.size());
4170 for (const auto &DeleteLoc : DeleteExprsInfo.second) {
4171 AddSourceLocation(DeleteLoc.first, DeleteExprsToAnalyze);
4172 DeleteExprsToAnalyze.push_back(DeleteLoc.second);
4173 }
4174 }
4175
Douglas Gregor112b9072012-10-18 05:31:06 +00004176 // Write the control block
Douglas Gregor2d302362012-10-24 16:50:34 +00004177 WriteControlBlock(PP, Context, isysroot, OutputFile);
Douglas Gregor112b9072012-10-18 05:31:06 +00004178
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004179 // Write the remaining AST contents.
Douglas Gregor652d82a2009-04-18 05:55:16 +00004180 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00004181 Stream.EnterSubblock(AST_BLOCK_ID, 5);
Douglas Gregor851443c2011-08-12 01:39:19 +00004182
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004183 // This is so that older clang versions, before the introduction
4184 // of the control block, can read and reject the newer PCH format.
4185 Record.clear();
4186 Record.push_back(VERSION_MAJOR);
4187 Stream.EmitRecord(METADATA_OLD_FORMAT, Record);
4188
Douglas Gregor851443c2011-08-12 01:39:19 +00004189 // Create a lexical update block containing all of the declarations in the
4190 // translation unit that do not come from other AST files.
4191 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
4192 SmallVector<KindDeclIDPair, 64> NewGlobalDecls;
Aaron Ballman629afae2014-03-07 19:56:05 +00004193 for (const auto *I : TU->noload_decls()) {
4194 if (!I->isFromASTFile())
4195 NewGlobalDecls.push_back(std::make_pair(I->getKind(), GetDeclRef(I)));
Douglas Gregor851443c2011-08-12 01:39:19 +00004196 }
4197
4198 llvm::BitCodeAbbrev *Abv = new llvm::BitCodeAbbrev();
4199 Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
4200 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4201 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(Abv);
4202 Record.clear();
4203 Record.push_back(TU_UPDATE_LEXICAL);
4204 Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00004205 bytes(NewGlobalDecls));
Douglas Gregor851443c2011-08-12 01:39:19 +00004206
4207 // And a visible updates block for the translation unit.
4208 Abv = new llvm::BitCodeAbbrev();
4209 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
4210 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4211 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed, 32));
4212 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4213 UpdateVisibleAbbrev = Stream.EmitAbbrev(Abv);
4214 WriteDeclContextVisibleUpdate(TU);
Richard Smithf19e1272015-03-07 00:04:49 +00004215
4216 // If we have any extern "C" names, write out a visible update for them.
4217 if (Context.ExternCContext)
4218 WriteDeclContextVisibleUpdate(Context.ExternCContext);
Douglas Gregor851443c2011-08-12 01:39:19 +00004219
4220 // If the translation unit has an anonymous namespace, and we don't already
4221 // have an update block for it, write it as an update block.
Richard Smith6ef42932014-03-20 21:02:00 +00004222 // FIXME: Why do we not do this if there's already an update block?
Douglas Gregor851443c2011-08-12 01:39:19 +00004223 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
4224 ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
Richard Smith6ef42932014-03-20 21:02:00 +00004225 if (Record.empty())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004226 Record.push_back(DeclUpdate(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE, NS));
Douglas Gregor851443c2011-08-12 01:39:19 +00004227 }
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004228
Richard Smith5652c0f2014-03-21 01:48:23 +00004229 // Add update records for all mangling numbers and static local numbers.
4230 // These aren't really update records, but this is a convenient way of
4231 // tagging this rare extra data onto the declarations.
4232 for (const auto &Number : Context.MangleNumbers)
4233 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004234 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_MANGLING_NUMBER,
4235 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004236 for (const auto &Number : Context.StaticLocalNumbers)
4237 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004238 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_STATIC_LOCAL_NUMBER,
4239 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004240
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004241 // Make sure visible decls, added to DeclContexts previously loaded from
4242 // an AST file, are registered for serialization.
Craig Topper2341c0d2013-07-04 03:08:24 +00004243 for (SmallVectorImpl<const Decl *>::iterator
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004244 I = UpdatingVisibleDecls.begin(),
4245 E = UpdatingVisibleDecls.end(); I != E; ++I) {
4246 GetDeclRef(*I);
4247 }
4248
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004249 // Make sure all decls associated with an identifier are registered for
4250 // serialization.
Chandler Carruth8440c982015-03-26 23:54:15 +00004251 llvm::SmallVector<const IdentifierInfo*, 256> IIs;
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004252 for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
4253 IDEnd = PP.getIdentifierTable().end();
4254 ID != IDEnd; ++ID) {
4255 const IdentifierInfo *II = ID->second;
Richard Smith9ab4cce2015-03-11 00:00:51 +00004256 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
Chandler Carruth8440c982015-03-26 23:54:15 +00004257 IIs.push_back(II);
Richard Smith9ab4cce2015-03-11 00:00:51 +00004258 }
Chandler Carruth8440c982015-03-26 23:54:15 +00004259 // Sort the identifiers to visit based on their name.
4260 std::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>());
4261 for (const IdentifierInfo *II : IIs) {
Richard Smith9ab4cce2015-03-11 00:00:51 +00004262 for (IdentifierResolver::iterator D = SemaRef.IdResolver.begin(II),
4263 DEnd = SemaRef.IdResolver.end();
4264 D != DEnd; ++D) {
4265 GetDeclRef(*D);
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004266 }
4267 }
4268
Douglas Gregor5204bde2011-08-02 16:26:37 +00004269 // Form the record of special types.
4270 RecordData SpecialTypes;
Douglas Gregor5204bde2011-08-02 16:26:37 +00004271 AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004272 AddTypeRef(Context.getFILEType(), SpecialTypes);
4273 AddTypeRef(Context.getjmp_bufType(), SpecialTypes);
4274 AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes);
4275 AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes);
4276 AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004277 AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes);
Rafael Espindola6cfa82b2011-11-13 21:51:09 +00004278 AddTypeRef(Context.getucontext_tType(), SpecialTypes);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004279
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004280 if (Chain) {
4281 // Write the mapping information describing our module dependencies and how
4282 // each of those modules were mapped into our own offset/ID space, so that
4283 // the reader can build the appropriate mapping to its own offset/ID space.
4284 // The map consists solely of a blob with the following format:
4285 // *(module-name-len:i16 module-name:len*i8
4286 // source-location-offset:i32
4287 // identifier-id:i32
4288 // preprocessed-entity-id:i32
4289 // macro-definition-id:i32
Douglas Gregor253eefe2011-12-01 00:59:36 +00004290 // submodule-id:i32
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004291 // selector-id:i32
4292 // declaration-id:i32
4293 // c++-base-specifiers-id:i32
4294 // type-id:i32)
4295 //
4296 llvm::BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
4297 Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
4298 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
4299 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(Abbrev);
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004300 SmallString<2048> Buffer;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004301 {
4302 llvm::raw_svector_ostream Out(Buffer);
Ben Langmuir785180e2014-10-20 16:27:30 +00004303 for (ModuleFile *M : Chain->ModuleMgr) {
Justin Bognere1c147c2014-03-28 22:03:19 +00004304 using namespace llvm::support;
4305 endian::Writer<little> LE(Out);
Ben Langmuir785180e2014-10-20 16:27:30 +00004306 StringRef FileName = M->FileName;
Justin Bognere1c147c2014-03-28 22:03:19 +00004307 LE.write<uint16_t>(FileName.size());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004308 Out.write(FileName.data(), FileName.size());
Ben Langmuirfe971d92014-08-16 04:54:18 +00004309
Ben Langmuir785180e2014-10-20 16:27:30 +00004310 // Note: if a base ID was uint max, it would not be possible to load
4311 // another module after it or have more than one entity inside it.
4312 uint32_t None = std::numeric_limits<uint32_t>::max();
4313
4314 auto writeBaseIDOrNone = [&](uint32_t BaseID, bool ShouldWrite) {
4315 assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
4316 if (ShouldWrite)
4317 LE.write<uint32_t>(BaseID);
4318 else
4319 LE.write<uint32_t>(None);
4320 };
4321
Ben Langmuirfe971d92014-08-16 04:54:18 +00004322 // These values should be unique within a chain, since they will be read
4323 // as keys into ContinuousRangeMaps.
Ben Langmuir785180e2014-10-20 16:27:30 +00004324 writeBaseIDOrNone(M->SLocEntryBaseOffset, M->LocalNumSLocEntries);
4325 writeBaseIDOrNone(M->BaseIdentifierID, M->LocalNumIdentifiers);
4326 writeBaseIDOrNone(M->BaseMacroID, M->LocalNumMacros);
4327 writeBaseIDOrNone(M->BasePreprocessedEntityID,
4328 M->NumPreprocessedEntities);
4329 writeBaseIDOrNone(M->BaseSubmoduleID, M->LocalNumSubmodules);
4330 writeBaseIDOrNone(M->BaseSelectorID, M->LocalNumSelectors);
4331 writeBaseIDOrNone(M->BaseDeclID, M->LocalNumDecls);
4332 writeBaseIDOrNone(M->BaseTypeIndex, M->LocalNumTypes);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004333 }
4334 }
4335 Record.clear();
4336 Record.push_back(MODULE_OFFSET_MAP);
4337 Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
4338 Buffer.data(), Buffer.size());
4339 }
Richard Smithb9eab6d2014-03-20 19:44:17 +00004340
Richard Smithb9eab6d2014-03-20 19:44:17 +00004341 RecordData DeclUpdatesOffsetsRecord;
4342
Richard Smith59442b42014-03-20 20:07:19 +00004343 // Keep writing types, declarations, and declaration update records
4344 // until we've emitted all of them.
Richard Smith01b2cb42014-07-26 06:37:51 +00004345 Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/5);
4346 WriteTypeAbbrevs();
4347 WriteDeclAbbrevs();
Richard Smithb9eab6d2014-03-20 19:44:17 +00004348 for (DeclsToRewriteTy::iterator I = DeclsToRewrite.begin(),
4349 E = DeclsToRewrite.end();
4350 I != E; ++I)
4351 DeclTypesToEmit.push(const_cast<Decl*>(*I));
Richard Smith59442b42014-03-20 20:07:19 +00004352 do {
4353 WriteDeclUpdatesBlocks(DeclUpdatesOffsetsRecord);
4354 while (!DeclTypesToEmit.empty()) {
4355 DeclOrType DOT = DeclTypesToEmit.front();
4356 DeclTypesToEmit.pop();
4357 if (DOT.isType())
4358 WriteType(DOT.getType());
4359 else
4360 WriteDecl(Context, DOT.getDecl());
4361 }
4362 } while (!DeclUpdates.empty());
Richard Smithb9eab6d2014-03-20 19:44:17 +00004363 Stream.ExitBlock();
4364
Richard Smithb9eab6d2014-03-20 19:44:17 +00004365 DoneWritingDeclsAndTypes = true;
4366
4367 // These things can only be done once we've written out decls and types.
4368 WriteTypeDeclOffsets();
Richard Smith5652c0f2014-03-21 01:48:23 +00004369 if (!DeclUpdatesOffsetsRecord.empty())
4370 Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord);
Richard Smithb9eab6d2014-03-20 19:44:17 +00004371 WriteCXXBaseSpecifiersOffsets();
Richard Smithc2bb8182015-03-24 06:36:48 +00004372 WriteCXXCtorInitializersOffsets();
Richard Smithb9eab6d2014-03-20 19:44:17 +00004373 WriteFileDeclIDsMap();
Richard Smith7ed1bc92014-12-05 22:42:13 +00004374 WriteSourceManagerBlock(Context.getSourceManager(), PP);
Richard Smithb9eab6d2014-03-20 19:44:17 +00004375
4376 WriteComments();
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004377 WritePreprocessor(PP, isModule);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004378 WriteHeaderSearch(PP.getHeaderSearchInfo());
Sebastian Redla19a67f2010-08-03 21:58:15 +00004379 WriteSelectors(SemaRef);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00004380 WriteReferencedSelectorsPool(SemaRef);
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004381 WriteIdentifierTable(PP, SemaRef.IdResolver, isModule);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004382 WriteFPPragmaOptions(SemaRef.getFPOptions());
4383 WriteOpenCLExtensions(SemaRef);
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00004384 WritePragmaDiagnosticMappings(Context.getDiagnostics(), isModule);
Douglas Gregor652d82a2009-04-18 05:55:16 +00004385
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004386 // If we're emitting a module, write out the submodule information.
4387 if (WritingModule)
4388 WriteSubmodules(WritingModule);
4389
Douglas Gregor5204bde2011-08-02 16:26:37 +00004390 Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
4391
Douglas Gregord4df8652009-04-22 22:02:47 +00004392 // Write the record containing external, unnamed definitions.
Ben Langmuir332aafe2014-01-31 01:06:56 +00004393 if (!EagerlyDeserializedDecls.empty())
4394 Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls);
Douglas Gregord4df8652009-04-22 22:02:47 +00004395
4396 // Write the record containing tentative definitions.
4397 if (!TentativeDefinitions.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004398 Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
Douglas Gregoracfc76c2009-04-22 22:18:58 +00004399
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004400 // Write the record containing unused file scoped decls.
4401 if (!UnusedFileScopedDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004402 Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004403
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004404 // Write the record containing weak undeclared identifiers.
4405 if (!WeakUndeclaredIdentifiers.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004406 Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004407 WeakUndeclaredIdentifiers);
4408
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004409 // Write the record containing ext_vector type names.
4410 if (!ExtVectorDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004411 Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
Mike Stump11289f42009-09-09 15:08:12 +00004412
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004413 // Write the record containing VTable uses information.
4414 if (!VTableUses.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004415 Stream.EmitRecord(VTABLE_USES, VTableUses);
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004416
Nico Weber72889432014-09-06 01:25:55 +00004417 // Write the record containing potentially unused local typedefs.
4418 if (!UnusedLocalTypedefNameCandidates.empty())
4419 Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
4420 UnusedLocalTypedefNameCandidates);
4421
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004422 // Write the record containing pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004423 if (!PendingInstantiations.empty())
4424 Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004425
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004426 // Write the record containing declaration references of Sema.
4427 if (!SemaDeclRefs.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004428 Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004429
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004430 // Write the record containing CUDA-specific declaration references.
4431 if (!CUDASpecialDeclRefs.empty())
4432 Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004433
4434 // Write the delegating constructors.
4435 if (!DelegatingCtorDecls.empty())
4436 Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004437
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004438 // Write the known namespaces.
4439 if (!KnownNamespaces.empty())
4440 Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
Nick Lewycky8334af82013-01-26 00:35:08 +00004441
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004442 // Write the undefined internal functions and variables, and inline functions.
4443 if (!UndefinedButUsed.empty())
4444 Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed);
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004445
4446 if (!DeleteExprsToAnalyze.empty())
4447 Stream.EmitRecord(DELETE_EXPRS_TO_ANALYZE, DeleteExprsToAnalyze);
4448
Douglas Gregor851443c2011-08-12 01:39:19 +00004449 // Write the visible updates to DeclContexts.
Richard Smithcd45dbc2014-04-19 03:48:30 +00004450 for (auto *DC : UpdatedDeclContexts)
4451 WriteDeclContextVisibleUpdate(DC);
Douglas Gregor851443c2011-08-12 01:39:19 +00004452
Douglas Gregor959bb062011-12-03 01:15:29 +00004453 if (!WritingModule) {
4454 // Write the submodules that were imported, if any.
Aaron Ballman4f45b712014-03-21 15:22:56 +00004455 struct ModuleInfo {
4456 uint64_t ID;
4457 Module *M;
4458 ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
4459 };
Richard Smith56be7542014-03-21 00:33:59 +00004460 llvm::SmallVector<ModuleInfo, 64> Imports;
Aaron Ballmanbbc31212014-03-14 20:59:21 +00004461 for (const auto *I : Context.local_imports()) {
Douglas Gregor959bb062011-12-03 01:15:29 +00004462 assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end());
Aaron Ballman4f45b712014-03-21 15:22:56 +00004463 Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()],
4464 I->getImportedModule()));
Douglas Gregor959bb062011-12-03 01:15:29 +00004465 }
Richard Smith56be7542014-03-21 00:33:59 +00004466
4467 if (!Imports.empty()) {
4468 auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
4469 return A.ID < B.ID;
4470 };
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00004471 auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
4472 return A.ID == B.ID;
4473 };
Richard Smith56be7542014-03-21 00:33:59 +00004474
4475 // Sort and deduplicate module IDs.
4476 std::sort(Imports.begin(), Imports.end(), Cmp);
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00004477 Imports.erase(std::unique(Imports.begin(), Imports.end(), Eq),
Richard Smith56be7542014-03-21 00:33:59 +00004478 Imports.end());
4479
4480 RecordData ImportedModules;
4481 for (const auto &Import : Imports) {
4482 ImportedModules.push_back(Import.ID);
4483 // FIXME: If the module has macros imported then later has declarations
4484 // imported, this location won't be the right one as a location for the
4485 // declaration imports.
Richard Smith10434f32015-05-02 02:08:26 +00004486 AddSourceLocation(PP.getModuleImportLoc(Import.M), ImportedModules);
Richard Smith56be7542014-03-21 00:33:59 +00004487 }
4488
Douglas Gregor959bb062011-12-03 01:15:29 +00004489 Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
4490 }
Douglas Gregor0a839132011-12-03 00:59:55 +00004491 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004492
Douglas Gregor851443c2011-08-12 01:39:19 +00004493 WriteDeclReplacementsBlock();
Douglas Gregor358cd442012-01-15 16:58:34 +00004494 WriteRedeclarations();
Douglas Gregor404cdde2012-01-27 01:47:08 +00004495 WriteObjCCategories();
Richard Smithe40f2ba2013-08-07 21:41:30 +00004496 WriteLateParsedTemplates(SemaRef);
Dario Domizioli13a0a382014-05-23 12:13:25 +00004497 if(!WritingModule)
4498 WriteOptimizePragmaOptions(SemaRef);
Richard Smithe40f2ba2013-08-07 21:41:30 +00004499
Douglas Gregor08f01292009-04-17 22:13:46 +00004500 // Some simple statistics
Douglas Gregor652d82a2009-04-18 05:55:16 +00004501 Record.clear();
Douglas Gregor08f01292009-04-17 22:13:46 +00004502 Record.push_back(NumStatements);
Douglas Gregorc3366a52009-04-21 23:56:24 +00004503 Record.push_back(NumMacros);
Douglas Gregora57c3ab2009-04-22 22:34:57 +00004504 Record.push_back(NumLexicalDeclContexts);
4505 Record.push_back(NumVisibleDeclContexts);
Sebastian Redl539c5062010-08-18 23:57:32 +00004506 Stream.EmitRecord(STATISTICS, Record);
Douglas Gregor8f45df52009-04-16 22:23:12 +00004507 Stream.ExitBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004508}
4509
Richard Smithb9eab6d2014-03-20 19:44:17 +00004510void ASTWriter::WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord) {
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004511 if (DeclUpdates.empty())
4512 return;
4513
Richard Smith59442b42014-03-20 20:07:19 +00004514 DeclUpdateMap LocalUpdates;
4515 LocalUpdates.swap(DeclUpdates);
4516
Richard Smith6ef42932014-03-20 21:02:00 +00004517 for (auto &DeclUpdate : LocalUpdates) {
4518 const Decl *D = DeclUpdate.first;
Argyrios Kyrtzidisb97a4022011-11-12 21:07:46 +00004519 if (isRewritten(D))
Argyrios Kyrtzidis3ba70b82010-10-24 17:26:46 +00004520 continue; // The decl will be written completely,no need to store updates.
4521
Richard Smithd28ac5b2014-03-22 23:33:22 +00004522 bool HasUpdatedBody = false;
Richard Smith6ef42932014-03-20 21:02:00 +00004523 RecordData Record;
4524 for (auto &Update : DeclUpdate.second) {
4525 DeclUpdateKind Kind = (DeclUpdateKind)Update.getKind();
4526
4527 Record.push_back(Kind);
4528 switch (Kind) {
4529 case UPD_CXX_ADDED_IMPLICIT_MEMBER:
4530 case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION:
4531 case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE:
Richard Smithcd45dbc2014-04-19 03:48:30 +00004532 assert(Update.getDecl() && "no decl to add?");
Richard Smith6ef42932014-03-20 21:02:00 +00004533 Record.push_back(GetDeclRef(Update.getDecl()));
4534 break;
4535
Richard Smith4d235792014-08-07 18:53:08 +00004536 case UPD_CXX_ADDED_FUNCTION_DEFINITION:
Richard Smithd28ac5b2014-03-22 23:33:22 +00004537 // An updated body is emitted last, so that the reader doesn't need
4538 // to skip over the lazy body to reach statements for other records.
4539 Record.pop_back();
4540 HasUpdatedBody = true;
4541 break;
4542
Richard Smith4d235792014-08-07 18:53:08 +00004543 case UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER:
4544 AddSourceLocation(Update.getLoc(), Record);
4545 break;
4546
Richard Smithcd45dbc2014-04-19 03:48:30 +00004547 case UPD_CXX_INSTANTIATED_CLASS_DEFINITION: {
4548 auto *RD = cast<CXXRecordDecl>(D);
Chandler Carruth8a3d24d2015-03-26 04:27:10 +00004549 UpdatedDeclContexts.insert(RD->getPrimaryContext());
Richard Smithcd45dbc2014-04-19 03:48:30 +00004550 AddCXXDefinitionData(RD, Record);
4551 Record.push_back(WriteDeclContextLexicalBlock(
4552 *Context, const_cast<CXXRecordDecl *>(RD)));
4553
4554 // This state is sometimes updated by template instantiation, when we
4555 // switch from the specialization referring to the template declaration
4556 // to it referring to the template definition.
4557 if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
4558 Record.push_back(MSInfo->getTemplateSpecializationKind());
4559 AddSourceLocation(MSInfo->getPointOfInstantiation(), Record);
4560 } else {
4561 auto *Spec = cast<ClassTemplateSpecializationDecl>(RD);
4562 Record.push_back(Spec->getTemplateSpecializationKind());
4563 AddSourceLocation(Spec->getPointOfInstantiation(), Record);
Richard Smithdf352052014-05-22 20:59:29 +00004564
4565 // The instantiation might have been resolved to a partial
4566 // specialization. If so, record which one.
4567 auto From = Spec->getInstantiatedFrom();
4568 if (auto PartialSpec =
4569 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
4570 Record.push_back(true);
4571 AddDeclRef(PartialSpec, Record);
4572 AddTemplateArgumentList(&Spec->getTemplateInstantiationArgs(),
4573 Record);
4574 } else {
4575 Record.push_back(false);
4576 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00004577 }
4578 Record.push_back(RD->getTagKind());
4579 AddSourceLocation(RD->getLocation(), Record);
4580 AddSourceLocation(RD->getLocStart(), Record);
4581 AddSourceLocation(RD->getRBraceLoc(), Record);
4582
4583 // Instantiation may change attributes; write them all out afresh.
4584 Record.push_back(D->hasAttrs());
4585 if (Record.back())
Craig Topper8c2a2a02014-08-30 16:55:39 +00004586 WriteAttributes(llvm::makeArrayRef(D->getAttrs().begin(),
4587 D->getAttrs().size()), Record);
Richard Smithcd45dbc2014-04-19 03:48:30 +00004588
4589 // FIXME: Ensure we don't get here for explicit instantiations.
4590 break;
4591 }
4592
Richard Smithf8134002015-03-10 01:41:22 +00004593 case UPD_CXX_RESOLVED_DTOR_DELETE:
4594 AddDeclRef(Update.getDecl(), Record);
4595 break;
4596
Richard Smith564417a2014-03-20 21:47:22 +00004597 case UPD_CXX_RESOLVED_EXCEPTION_SPEC:
4598 addExceptionSpec(
4599 *this,
4600 cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>(),
4601 Record);
4602 break;
4603
Richard Smith6ef42932014-03-20 21:02:00 +00004604 case UPD_CXX_DEDUCED_RETURN_TYPE:
4605 Record.push_back(GetOrCreateTypeID(Update.getType()));
4606 break;
4607
4608 case UPD_DECL_MARKED_USED:
4609 break;
Richard Smith5652c0f2014-03-21 01:48:23 +00004610
4611 case UPD_MANGLING_NUMBER:
4612 case UPD_STATIC_LOCAL_NUMBER:
4613 Record.push_back(Update.getNumber());
4614 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00004615
Alexey Bataev97720002014-11-11 04:05:39 +00004616 case UPD_DECL_MARKED_OPENMP_THREADPRIVATE:
4617 AddSourceRange(D->getAttr<OMPThreadPrivateDeclAttr>()->getRange(),
4618 Record);
4619 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00004620
4621 case UPD_DECL_EXPORTED:
Richard Smith4caa4492015-05-15 02:34:32 +00004622 Record.push_back(getSubmoduleID(Update.getModule()));
Richard Smith65ebb4a2015-03-26 04:09:53 +00004623 break;
Richard Smith6ef42932014-03-20 21:02:00 +00004624 }
4625 }
4626
Richard Smithd28ac5b2014-03-22 23:33:22 +00004627 if (HasUpdatedBody) {
4628 const FunctionDecl *Def = cast<FunctionDecl>(D);
Richard Smith4d235792014-08-07 18:53:08 +00004629 Record.push_back(UPD_CXX_ADDED_FUNCTION_DEFINITION);
Richard Smithd28ac5b2014-03-22 23:33:22 +00004630 Record.push_back(Def->isInlined());
4631 AddSourceLocation(Def->getInnerLocStart(), Record);
4632 AddFunctionDefinition(Def, Record);
4633 }
4634
Richard Smithcd45dbc2014-04-19 03:48:30 +00004635 OffsetsRecord.push_back(GetDeclRef(D));
4636 OffsetsRecord.push_back(Stream.GetCurrentBitNo());
4637
Richard Smith6ef42932014-03-20 21:02:00 +00004638 Stream.EmitRecord(DECL_UPDATES, Record);
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004639
Richard Smithc2bb8182015-03-24 06:36:48 +00004640 FlushPendingAfterDecl();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004641 }
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004642}
4643
Argyrios Kyrtzidis97bfda92010-10-24 17:26:43 +00004644void ASTWriter::WriteDeclReplacementsBlock() {
Sebastian Redle7c1fe62010-08-13 00:28:03 +00004645 if (ReplacedDecls.empty())
4646 return;
4647
4648 RecordData Record;
Craig Topper2341c0d2013-07-04 03:08:24 +00004649 for (SmallVectorImpl<ReplacedDeclInfo>::iterator
4650 I = ReplacedDecls.begin(), E = ReplacedDecls.end(); I != E; ++I) {
Argyrios Kyrtzidis6fb60032011-10-31 07:20:15 +00004651 Record.push_back(I->ID);
4652 Record.push_back(I->Offset);
4653 Record.push_back(I->Loc);
Sebastian Redle7c1fe62010-08-13 00:28:03 +00004654 }
Sebastian Redl539c5062010-08-18 23:57:32 +00004655 Stream.EmitRecord(DECL_REPLACEMENTS, Record);
Sebastian Redle7c1fe62010-08-13 00:28:03 +00004656}
4657
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004658void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004659 Record.push_back(Loc.getRawEncoding());
4660}
4661
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004662void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00004663 AddSourceLocation(Range.getBegin(), Record);
4664 AddSourceLocation(Range.getEnd(), Record);
4665}
4666
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004667void ASTWriter::AddAPInt(const llvm::APInt &Value, RecordDataImpl &Record) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004668 Record.push_back(Value.getBitWidth());
Benjamin Kramer25f9ea62010-09-06 23:43:28 +00004669 const uint64_t *Words = Value.getRawData();
4670 Record.append(Words, Words + Value.getNumWords());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004671}
4672
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004673void ASTWriter::AddAPSInt(const llvm::APSInt &Value, RecordDataImpl &Record) {
Douglas Gregor1daeb692009-04-13 18:14:40 +00004674 Record.push_back(Value.isUnsigned());
4675 AddAPInt(Value, Record);
4676}
4677
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004678void ASTWriter::AddAPFloat(const llvm::APFloat &Value, RecordDataImpl &Record) {
Douglas Gregore0a3a512009-04-14 21:55:33 +00004679 AddAPInt(Value.bitcastToAPInt(), Record);
4680}
4681
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004682void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004683 Record.push_back(getIdentifierRef(II));
4684}
4685
Sebastian Redl539c5062010-08-18 23:57:32 +00004686IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
Craig Toppera13603a2014-05-22 05:54:18 +00004687 if (!II)
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004688 return 0;
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00004689
Sebastian Redl539c5062010-08-18 23:57:32 +00004690 IdentID &ID = IdentifierIDs[II];
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00004691 if (ID == 0)
Sebastian Redlff4a2952010-07-23 23:49:55 +00004692 ID = NextIdentID++;
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004693 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004694}
4695
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004696MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004697 // Don't emit builtin macros like __LINE__ to the AST file unless they
4698 // have been redefined by the header (in which case they are not
4699 // isBuiltinMacro).
Craig Toppera13603a2014-05-22 05:54:18 +00004700 if (!MI || MI->isBuiltinMacro())
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004701 return 0;
4702
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004703 MacroID &ID = MacroIDs[MI];
4704 if (ID == 0) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004705 ID = NextMacroID++;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004706 MacroInfoToEmitData Info = { Name, MI, ID };
4707 MacroInfosToEmit.push_back(Info);
4708 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004709 return ID;
4710}
4711
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004712MacroID ASTWriter::getMacroID(MacroInfo *MI) {
Craig Toppera13603a2014-05-22 05:54:18 +00004713 if (!MI || MI->isBuiltinMacro())
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004714 return 0;
4715
4716 assert(MacroIDs.find(MI) != MacroIDs.end() && "Macro not emitted!");
4717 return MacroIDs[MI];
4718}
4719
4720uint64_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) {
Richard Smithd7329392015-04-21 21:46:32 +00004721 return IdentMacroDirectivesOffsetMap.lookup(Name);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004722}
4723
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004724void ASTWriter::AddSelectorRef(const Selector SelRef, RecordDataImpl &Record) {
Sebastian Redl834bb972010-08-04 17:20:04 +00004725 Record.push_back(getSelectorRef(SelRef));
4726}
4727
Sebastian Redl539c5062010-08-18 23:57:32 +00004728SelectorID ASTWriter::getSelectorRef(Selector Sel) {
Craig Toppera13603a2014-05-22 05:54:18 +00004729 if (Sel.getAsOpaquePtr() == nullptr) {
Sebastian Redl834bb972010-08-04 17:20:04 +00004730 return 0;
Steve Naroff2ddea052009-04-23 10:39:46 +00004731 }
4732
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004733 SelectorID SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00004734 if (SID == 0 && Chain) {
4735 // This might trigger a ReadSelector callback, which will set the ID for
4736 // this selector.
4737 Chain->LoadSelector(Sel);
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004738 SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00004739 }
Steve Naroff2ddea052009-04-23 10:39:46 +00004740 if (SID == 0) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00004741 SID = NextSelectorID++;
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004742 SelectorIDs[Sel] = SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00004743 }
Sebastian Redl834bb972010-08-04 17:20:04 +00004744 return SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00004745}
4746
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004747void ASTWriter::AddCXXTemporary(const CXXTemporary *Temp, RecordDataImpl &Record) {
Chris Lattnercba86142010-05-10 00:25:06 +00004748 AddDeclRef(Temp->getDestructor(), Record);
4749}
4750
Richard Smithc2bb8182015-03-24 06:36:48 +00004751void ASTWriter::AddCXXCtorInitializersRef(ArrayRef<CXXCtorInitializer *> Inits,
4752 RecordDataImpl &Record) {
4753 assert(!Inits.empty() && "Empty ctor initializer sets are not recorded");
4754 CXXCtorInitializersToWrite.push_back(
4755 QueuedCXXCtorInitializers(NextCXXCtorInitializersID, Inits));
4756 Record.push_back(NextCXXCtorInitializersID++);
4757}
4758
Douglas Gregord4c5ed02010-10-29 22:39:52 +00004759void ASTWriter::AddCXXBaseSpecifiersRef(CXXBaseSpecifier const *Bases,
Richard Smithc2bb8182015-03-24 06:36:48 +00004760 CXXBaseSpecifier const *BasesEnd,
Douglas Gregord4c5ed02010-10-29 22:39:52 +00004761 RecordDataImpl &Record) {
4762 assert(Bases != BasesEnd && "Empty base-specifier sets are not recorded");
4763 CXXBaseSpecifiersToWrite.push_back(
4764 QueuedCXXBaseSpecifiers(NextCXXBaseSpecifiersID,
4765 Bases, BasesEnd));
4766 Record.push_back(NextCXXBaseSpecifiersID++);
4767}
4768
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004769void ASTWriter::AddTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind,
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004770 const TemplateArgumentLocInfo &Arg,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004771 RecordDataImpl &Record) {
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004772 switch (Kind) {
John McCall0ad16662009-10-29 08:12:44 +00004773 case TemplateArgument::Expression:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004774 AddStmt(Arg.getAsExpr());
John McCall0ad16662009-10-29 08:12:44 +00004775 break;
4776 case TemplateArgument::Type:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004777 AddTypeSourceInfo(Arg.getAsTypeSourceInfo(), Record);
John McCall0ad16662009-10-29 08:12:44 +00004778 break;
Douglas Gregor9167f8b2009-11-11 01:00:40 +00004779 case TemplateArgument::Template:
Douglas Gregor9d802122011-03-02 17:09:35 +00004780 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc(), Record);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00004781 AddSourceLocation(Arg.getTemplateNameLoc(), Record);
Douglas Gregore4ff4b52011-01-05 18:58:31 +00004782 break;
4783 case TemplateArgument::TemplateExpansion:
Douglas Gregor9d802122011-03-02 17:09:35 +00004784 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc(), Record);
Douglas Gregore4ff4b52011-01-05 18:58:31 +00004785 AddSourceLocation(Arg.getTemplateNameLoc(), Record);
Douglas Gregoreb29d182011-01-05 17:40:24 +00004786 AddSourceLocation(Arg.getTemplateEllipsisLoc(), Record);
Douglas Gregor9167f8b2009-11-11 01:00:40 +00004787 break;
John McCall0ad16662009-10-29 08:12:44 +00004788 case TemplateArgument::Null:
4789 case TemplateArgument::Integral:
4790 case TemplateArgument::Declaration:
Eli Friedmanb826a002012-09-26 02:36:12 +00004791 case TemplateArgument::NullPtr:
John McCall0ad16662009-10-29 08:12:44 +00004792 case TemplateArgument::Pack:
Eli Friedmanb826a002012-09-26 02:36:12 +00004793 // FIXME: Is this right?
John McCall0ad16662009-10-29 08:12:44 +00004794 break;
4795 }
4796}
4797
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004798void ASTWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004799 RecordDataImpl &Record) {
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004800 AddTemplateArgument(Arg.getArgument(), Record);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00004801
4802 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
4803 bool InfoHasSameExpr
4804 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
4805 Record.push_back(InfoHasSameExpr);
4806 if (InfoHasSameExpr)
4807 return; // Avoid storing the same expr twice.
4808 }
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004809 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo(),
4810 Record);
4811}
4812
Douglas Gregora9d87bc2011-02-25 00:36:19 +00004813void ASTWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo,
4814 RecordDataImpl &Record) {
Craig Toppera13603a2014-05-22 05:54:18 +00004815 if (!TInfo) {
John McCall8f115c62009-10-16 21:56:05 +00004816 AddTypeRef(QualType(), Record);
4817 return;
4818 }
4819
Douglas Gregora9d87bc2011-02-25 00:36:19 +00004820 AddTypeLoc(TInfo->getTypeLoc(), Record);
4821}
4822
4823void ASTWriter::AddTypeLoc(TypeLoc TL, RecordDataImpl &Record) {
4824 AddTypeRef(TL.getType(), Record);
4825
John McCall8f115c62009-10-16 21:56:05 +00004826 TypeLocWriter TLW(*this, Record);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00004827 for (; !TL.isNull(); TL = TL.getNextTypeLoc())
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004828 TLW.Visit(TL);
John McCall8f115c62009-10-16 21:56:05 +00004829}
4830
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004831void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
Argyrios Kyrtzidis9ab44ea2010-08-20 16:04:14 +00004832 Record.push_back(GetOrCreateTypeID(T));
4833}
4834
Richard Smith2095ffe2015-03-16 20:11:03 +00004835TypeID ASTWriter::GetOrCreateTypeID(QualType T) {
Richard Smith1fa5d642013-05-11 05:45:24 +00004836 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00004837 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
4838 if (T.isNull())
4839 return TypeIdx();
4840 assert(!T.getLocalFastQualifiers());
4841
4842 TypeIdx &Idx = TypeIdxs[T];
4843 if (Idx.getIndex() == 0) {
4844 if (DoneWritingDeclsAndTypes) {
4845 assert(0 && "New type seen after serializing all the types to emit!");
4846 return TypeIdx();
4847 }
4848
4849 // We haven't seen this type before. Assign it a new ID and put it
4850 // into the queue of types to emit.
4851 Idx = TypeIdx(NextTypeID++);
4852 DeclTypesToEmit.push(T);
4853 }
4854 return Idx;
4855 });
Argyrios Kyrtzidis082e4612010-08-20 16:04:20 +00004856}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004857
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00004858TypeID ASTWriter::getTypeID(QualType T) const {
Richard Smith1fa5d642013-05-11 05:45:24 +00004859 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00004860 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
4861 if (T.isNull())
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004862 return TypeIdx();
Richard Smith2095ffe2015-03-16 20:11:03 +00004863 assert(!T.getLocalFastQualifiers());
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004864
Richard Smith2095ffe2015-03-16 20:11:03 +00004865 TypeIdxMap::const_iterator I = TypeIdxs.find(T);
4866 assert(I != TypeIdxs.end() && "Type not emitted!");
4867 return I->second;
4868 });
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004869}
4870
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004871void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00004872 Record.push_back(GetDeclRef(D));
4873}
4874
Sebastian Redl539c5062010-08-18 23:57:32 +00004875DeclID ASTWriter::GetDeclRef(const Decl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004876 assert(WritingAST && "Cannot request a declaration ID before AST writing");
Craig Toppera13603a2014-05-22 05:54:18 +00004877
4878 if (!D) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00004879 return 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004880 }
Douglas Gregorb3163e52012-01-05 22:33:30 +00004881
4882 // If D comes from an AST file, its declaration ID is already known and
4883 // fixed.
4884 if (D->isFromASTFile())
4885 return D->getGlobalID();
4886
Douglas Gregor9b3932c2010-10-05 18:37:06 +00004887 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
Sebastian Redl539c5062010-08-18 23:57:32 +00004888 DeclID &ID = DeclIDs[D];
Mike Stump11289f42009-09-09 15:08:12 +00004889 if (ID == 0) {
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004890 if (DoneWritingDeclsAndTypes) {
4891 assert(0 && "New decl seen after serializing all the decls to emit!");
4892 return 0;
4893 }
4894
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004895 // We haven't seen this declaration before. Give it a new ID and
4896 // enqueue it in the list of declarations to emit.
Sebastian Redlff4a2952010-07-23 23:49:55 +00004897 ID = NextDeclID++;
Douglas Gregor12bfa382009-10-17 00:13:19 +00004898 DeclTypesToEmit.push(const_cast<Decl *>(D));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004899 }
4900
Sebastian Redl66c5eef2010-07-27 00:17:23 +00004901 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004902}
4903
Sebastian Redl539c5062010-08-18 23:57:32 +00004904DeclID ASTWriter::getDeclID(const Decl *D) {
Craig Toppera13603a2014-05-22 05:54:18 +00004905 if (!D)
Douglas Gregore84a9da2009-04-20 20:36:09 +00004906 return 0;
4907
Douglas Gregorb3163e52012-01-05 22:33:30 +00004908 // If D comes from an AST file, its declaration ID is already known and
4909 // fixed.
4910 if (D->isFromASTFile())
4911 return D->getGlobalID();
4912
Douglas Gregore84a9da2009-04-20 20:36:09 +00004913 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
4914 return DeclIDs[D];
4915}
4916
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00004917void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004918 assert(ID);
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00004919 assert(D);
4920
4921 SourceLocation Loc = D->getLocation();
4922 if (Loc.isInvalid())
4923 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004924
4925 // We only keep track of the file-level declarations of each file.
4926 if (!D->getLexicalDeclContext()->isFileContext())
4927 return;
Argyrios Kyrtzidise1bc99e2012-02-24 19:45:46 +00004928 // FIXME: ParmVarDecls that are part of a function type of a parameter of
4929 // a function/objc method, should not have TU as lexical context.
Argyrios Kyrtzidisffe055a82012-02-24 01:12:38 +00004930 if (isa<ParmVarDecl>(D))
4931 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004932
4933 SourceManager &SM = Context->getSourceManager();
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00004934 SourceLocation FileLoc = SM.getFileLoc(Loc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004935 assert(SM.isLocalSourceLocation(FileLoc));
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00004936 FileID FID;
4937 unsigned Offset;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00004938 std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004939 if (FID.isInvalid())
4940 return;
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00004941 assert(SM.getSLocEntry(FID).isFile());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004942
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00004943 DeclIDInFileInfo *&Info = FileDeclIDs[FID];
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004944 if (!Info)
4945 Info = new DeclIDInFileInfo();
4946
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00004947 std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004948 LocDeclIDsTy &Decls = Info->DeclIDs;
4949
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00004950 if (Decls.empty() || Decls.back().first <= Offset) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004951 Decls.push_back(LocDecl);
4952 return;
4953 }
4954
Benjamin Kramer45025c02013-08-24 13:22:59 +00004955 LocDeclIDsTy::iterator I =
4956 std::upper_bound(Decls.begin(), Decls.end(), LocDecl, llvm::less_first());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004957
4958 Decls.insert(I, LocDecl);
4959}
4960
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004961void ASTWriter::AddDeclarationName(DeclarationName Name, RecordDataImpl &Record) {
Chris Lattner258172e2009-04-27 07:35:58 +00004962 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc.
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004963 Record.push_back(Name.getNameKind());
4964 switch (Name.getNameKind()) {
4965 case DeclarationName::Identifier:
4966 AddIdentifierRef(Name.getAsIdentifierInfo(), Record);
4967 break;
4968
4969 case DeclarationName::ObjCZeroArgSelector:
4970 case DeclarationName::ObjCOneArgSelector:
4971 case DeclarationName::ObjCMultiArgSelector:
Steve Naroff2ddea052009-04-23 10:39:46 +00004972 AddSelectorRef(Name.getObjCSelector(), Record);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004973 break;
4974
4975 case DeclarationName::CXXConstructorName:
4976 case DeclarationName::CXXDestructorName:
4977 case DeclarationName::CXXConversionFunctionName:
4978 AddTypeRef(Name.getCXXNameType(), Record);
4979 break;
4980
4981 case DeclarationName::CXXOperatorName:
4982 Record.push_back(Name.getCXXOverloadedOperator());
4983 break;
4984
Alexis Hunt3d221f22009-11-29 07:34:05 +00004985 case DeclarationName::CXXLiteralOperatorName:
4986 AddIdentifierRef(Name.getCXXLiteralIdentifier(), Record);
4987 break;
4988
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004989 case DeclarationName::CXXUsingDirective:
4990 // No extra data to emit
4991 break;
4992 }
4993}
Chris Lattnerca025db2010-05-07 21:43:38 +00004994
Richard Smithd08aeb62014-08-28 01:33:39 +00004995unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) {
4996 assert(needsAnonymousDeclarationNumber(D) &&
4997 "expected an anonymous declaration");
4998
4999 // Number the anonymous declarations within this context, if we've not
5000 // already done so.
5001 auto It = AnonymousDeclarationNumbers.find(D);
5002 if (It == AnonymousDeclarationNumbers.end()) {
Richard Smith2b560572015-02-07 03:11:11 +00005003 auto *DC = D->getLexicalDeclContext();
5004 numberAnonymousDeclsWithin(DC, [&](const NamedDecl *ND, unsigned Number) {
5005 AnonymousDeclarationNumbers[ND] = Number;
5006 });
Richard Smithd08aeb62014-08-28 01:33:39 +00005007
5008 It = AnonymousDeclarationNumbers.find(D);
5009 assert(It != AnonymousDeclarationNumbers.end() &&
5010 "declaration not found within its lexical context");
5011 }
5012
5013 return It->second;
5014}
5015
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005016void ASTWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005017 DeclarationName Name, RecordDataImpl &Record) {
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005018 switch (Name.getNameKind()) {
5019 case DeclarationName::CXXConstructorName:
5020 case DeclarationName::CXXDestructorName:
5021 case DeclarationName::CXXConversionFunctionName:
5022 AddTypeSourceInfo(DNLoc.NamedType.TInfo, Record);
5023 break;
5024
5025 case DeclarationName::CXXOperatorName:
5026 AddSourceLocation(
5027 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.BeginOpNameLoc),
5028 Record);
5029 AddSourceLocation(
5030 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc),
5031 Record);
5032 break;
5033
5034 case DeclarationName::CXXLiteralOperatorName:
5035 AddSourceLocation(
5036 SourceLocation::getFromRawEncoding(DNLoc.CXXLiteralOperatorName.OpNameLoc),
5037 Record);
5038 break;
5039
5040 case DeclarationName::Identifier:
5041 case DeclarationName::ObjCZeroArgSelector:
5042 case DeclarationName::ObjCOneArgSelector:
5043 case DeclarationName::ObjCMultiArgSelector:
5044 case DeclarationName::CXXUsingDirective:
5045 break;
5046 }
5047}
5048
5049void ASTWriter::AddDeclarationNameInfo(const DeclarationNameInfo &NameInfo,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005050 RecordDataImpl &Record) {
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005051 AddDeclarationName(NameInfo.getName(), Record);
5052 AddSourceLocation(NameInfo.getLoc(), Record);
5053 AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName(), Record);
5054}
5055
5056void ASTWriter::AddQualifierInfo(const QualifierInfo &Info,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005057 RecordDataImpl &Record) {
Douglas Gregor14454802011-02-25 02:25:35 +00005058 AddNestedNameSpecifierLoc(Info.QualifierLoc, Record);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005059 Record.push_back(Info.NumTemplParamLists);
5060 for (unsigned i=0, e=Info.NumTemplParamLists; i != e; ++i)
5061 AddTemplateParameterList(Info.TemplParamLists[i], Record);
5062}
5063
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005064void ASTWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005065 RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005066 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005067 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005068 SmallVector<NestedNameSpecifier *, 8> NestedNames;
Chris Lattnerca025db2010-05-07 21:43:38 +00005069
5070 // Push each of the NNS's onto a stack for serialization in reverse order.
5071 while (NNS) {
5072 NestedNames.push_back(NNS);
5073 NNS = NNS->getPrefix();
5074 }
5075
5076 Record.push_back(NestedNames.size());
5077 while(!NestedNames.empty()) {
5078 NNS = NestedNames.pop_back_val();
5079 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
5080 Record.push_back(Kind);
5081 switch (Kind) {
5082 case NestedNameSpecifier::Identifier:
5083 AddIdentifierRef(NNS->getAsIdentifier(), Record);
5084 break;
5085
5086 case NestedNameSpecifier::Namespace:
5087 AddDeclRef(NNS->getAsNamespace(), Record);
5088 break;
5089
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005090 case NestedNameSpecifier::NamespaceAlias:
5091 AddDeclRef(NNS->getAsNamespaceAlias(), Record);
5092 break;
5093
Chris Lattnerca025db2010-05-07 21:43:38 +00005094 case NestedNameSpecifier::TypeSpec:
5095 case NestedNameSpecifier::TypeSpecWithTemplate:
5096 AddTypeRef(QualType(NNS->getAsType(), 0), Record);
5097 Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5098 break;
5099
5100 case NestedNameSpecifier::Global:
5101 // Don't need to write an associated value.
5102 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005103
5104 case NestedNameSpecifier::Super:
5105 AddDeclRef(NNS->getAsRecordDecl(), Record);
5106 break;
Chris Lattnerca025db2010-05-07 21:43:38 +00005107 }
5108 }
5109}
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005110
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005111void ASTWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS,
5112 RecordDataImpl &Record) {
5113 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005114 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005115 SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005116
5117 // Push each of the nested-name-specifiers's onto a stack for
5118 // serialization in reverse order.
5119 while (NNS) {
5120 NestedNames.push_back(NNS);
5121 NNS = NNS.getPrefix();
5122 }
5123
5124 Record.push_back(NestedNames.size());
5125 while(!NestedNames.empty()) {
5126 NNS = NestedNames.pop_back_val();
5127 NestedNameSpecifier::SpecifierKind Kind
5128 = NNS.getNestedNameSpecifier()->getKind();
5129 Record.push_back(Kind);
5130 switch (Kind) {
5131 case NestedNameSpecifier::Identifier:
5132 AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier(), Record);
5133 AddSourceRange(NNS.getLocalSourceRange(), Record);
5134 break;
5135
5136 case NestedNameSpecifier::Namespace:
5137 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace(), Record);
5138 AddSourceRange(NNS.getLocalSourceRange(), Record);
5139 break;
5140
5141 case NestedNameSpecifier::NamespaceAlias:
5142 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias(), Record);
5143 AddSourceRange(NNS.getLocalSourceRange(), Record);
5144 break;
5145
5146 case NestedNameSpecifier::TypeSpec:
5147 case NestedNameSpecifier::TypeSpecWithTemplate:
5148 Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5149 AddTypeLoc(NNS.getTypeLoc(), Record);
5150 AddSourceLocation(NNS.getLocalSourceRange().getEnd(), Record);
5151 break;
5152
5153 case NestedNameSpecifier::Global:
5154 AddSourceLocation(NNS.getLocalSourceRange().getEnd(), Record);
5155 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005156
5157 case NestedNameSpecifier::Super:
5158 AddDeclRef(NNS.getNestedNameSpecifier()->getAsRecordDecl(), Record);
5159 AddSourceRange(NNS.getLocalSourceRange(), Record);
5160 break;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005161 }
5162 }
5163}
5164
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005165void ASTWriter::AddTemplateName(TemplateName Name, RecordDataImpl &Record) {
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005166 TemplateName::NameKind Kind = Name.getKind();
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005167 Record.push_back(Kind);
5168 switch (Kind) {
5169 case TemplateName::Template:
5170 AddDeclRef(Name.getAsTemplateDecl(), Record);
5171 break;
5172
5173 case TemplateName::OverloadedTemplate: {
5174 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
5175 Record.push_back(OvT->size());
5176 for (OverloadedTemplateStorage::iterator I = OvT->begin(), E = OvT->end();
5177 I != E; ++I)
5178 AddDeclRef(*I, Record);
5179 break;
5180 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005181
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005182 case TemplateName::QualifiedTemplate: {
5183 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
5184 AddNestedNameSpecifier(QualT->getQualifier(), Record);
5185 Record.push_back(QualT->hasTemplateKeyword());
5186 AddDeclRef(QualT->getTemplateDecl(), Record);
5187 break;
5188 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005189
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005190 case TemplateName::DependentTemplate: {
5191 DependentTemplateName *DepT = Name.getAsDependentTemplateName();
5192 AddNestedNameSpecifier(DepT->getQualifier(), Record);
5193 Record.push_back(DepT->isIdentifier());
5194 if (DepT->isIdentifier())
5195 AddIdentifierRef(DepT->getIdentifier(), Record);
5196 else
5197 Record.push_back(DepT->getOperator());
5198 break;
5199 }
John McCalld9dfe3a2011-06-30 08:33:18 +00005200
5201 case TemplateName::SubstTemplateTemplateParm: {
5202 SubstTemplateTemplateParmStorage *subst
5203 = Name.getAsSubstTemplateTemplateParm();
5204 AddDeclRef(subst->getParameter(), Record);
5205 AddTemplateName(subst->getReplacement(), Record);
5206 break;
5207 }
Douglas Gregor5590be02011-01-15 06:45:20 +00005208
5209 case TemplateName::SubstTemplateTemplateParmPack: {
5210 SubstTemplateTemplateParmPackStorage *SubstPack
5211 = Name.getAsSubstTemplateTemplateParmPack();
5212 AddDeclRef(SubstPack->getParameterPack(), Record);
5213 AddTemplateArgument(SubstPack->getArgumentPack(), Record);
5214 break;
5215 }
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005216 }
5217}
5218
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005219void ASTWriter::AddTemplateArgument(const TemplateArgument &Arg,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005220 RecordDataImpl &Record) {
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005221 Record.push_back(Arg.getKind());
5222 switch (Arg.getKind()) {
5223 case TemplateArgument::Null:
5224 break;
5225 case TemplateArgument::Type:
5226 AddTypeRef(Arg.getAsType(), Record);
5227 break;
5228 case TemplateArgument::Declaration:
5229 AddDeclRef(Arg.getAsDecl(), Record);
David Blaikie952a9b12014-10-17 18:00:12 +00005230 AddTypeRef(Arg.getParamTypeForDecl(), Record);
Eli Friedmanb826a002012-09-26 02:36:12 +00005231 break;
5232 case TemplateArgument::NullPtr:
5233 AddTypeRef(Arg.getNullPtrType(), Record);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005234 break;
5235 case TemplateArgument::Integral:
Benjamin Kramer6003ad52012-06-07 15:09:51 +00005236 AddAPSInt(Arg.getAsIntegral(), Record);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005237 AddTypeRef(Arg.getIntegralType(), Record);
5238 break;
5239 case TemplateArgument::Template:
Douglas Gregore1d60df2011-01-14 23:41:42 +00005240 AddTemplateName(Arg.getAsTemplateOrTemplatePattern(), Record);
5241 break;
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005242 case TemplateArgument::TemplateExpansion:
5243 AddTemplateName(Arg.getAsTemplateOrTemplatePattern(), Record);
David Blaikie05785d12013-02-20 22:23:23 +00005244 if (Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions())
Douglas Gregore1d60df2011-01-14 23:41:42 +00005245 Record.push_back(*NumExpansions + 1);
5246 else
5247 Record.push_back(0);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005248 break;
5249 case TemplateArgument::Expression:
5250 AddStmt(Arg.getAsExpr());
5251 break;
5252 case TemplateArgument::Pack:
5253 Record.push_back(Arg.pack_size());
Aaron Ballman2a89e852014-07-15 21:32:31 +00005254 for (const auto &P : Arg.pack_elements())
5255 AddTemplateArgument(P, Record);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005256 break;
5257 }
5258}
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005259
5260void
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005261ASTWriter::AddTemplateParameterList(const TemplateParameterList *TemplateParams,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005262 RecordDataImpl &Record) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005263 assert(TemplateParams && "No TemplateParams!");
5264 AddSourceLocation(TemplateParams->getTemplateLoc(), Record);
5265 AddSourceLocation(TemplateParams->getLAngleLoc(), Record);
5266 AddSourceLocation(TemplateParams->getRAngleLoc(), Record);
5267 Record.push_back(TemplateParams->size());
5268 for (TemplateParameterList::const_iterator
5269 P = TemplateParams->begin(), PEnd = TemplateParams->end();
5270 P != PEnd; ++P)
5271 AddDeclRef(*P, Record);
5272}
5273
5274/// \brief Emit a template argument list.
5275void
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005276ASTWriter::AddTemplateArgumentList(const TemplateArgumentList *TemplateArgs,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005277 RecordDataImpl &Record) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005278 assert(TemplateArgs && "No TemplateArgs!");
Douglas Gregor1ccc8412010-11-07 23:05:16 +00005279 Record.push_back(TemplateArgs->size());
5280 for (int i=0, e = TemplateArgs->size(); i != e; ++i)
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005281 AddTemplateArgument(TemplateArgs->get(i), Record);
5282}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005283
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005284void
5285ASTWriter::AddASTTemplateArgumentListInfo
5286(const ASTTemplateArgumentListInfo *ASTTemplArgList, RecordDataImpl &Record) {
5287 assert(ASTTemplArgList && "No ASTTemplArgList!");
5288 AddSourceLocation(ASTTemplArgList->LAngleLoc, Record);
5289 AddSourceLocation(ASTTemplArgList->RAngleLoc, Record);
5290 Record.push_back(ASTTemplArgList->NumTemplateArgs);
5291 const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
5292 for (int i=0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
5293 AddTemplateArgumentLoc(TemplArgs[i], Record);
5294}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005295
5296void
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00005297ASTWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set, RecordDataImpl &Record) {
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005298 Record.push_back(Set.size());
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00005299 for (ASTUnresolvedSet::const_iterator
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005300 I = Set.begin(), E = Set.end(); I != E; ++I) {
5301 AddDeclRef(I.getDecl(), Record);
5302 Record.push_back(I.getAccess());
5303 }
5304}
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005305
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005306void ASTWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005307 RecordDataImpl &Record) {
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005308 Record.push_back(Base.isVirtual());
5309 Record.push_back(Base.isBaseOfClass());
5310 Record.push_back(Base.getAccessSpecifierAsWritten());
Sebastian Redl08905022011-02-05 19:23:19 +00005311 Record.push_back(Base.getInheritConstructors());
Nick Lewycky19b9f952010-07-26 16:56:01 +00005312 AddTypeSourceInfo(Base.getTypeSourceInfo(), Record);
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005313 AddSourceRange(Base.getSourceRange(), Record);
Douglas Gregor752a5952011-01-03 22:36:02 +00005314 AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
5315 : SourceLocation(),
5316 Record);
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005317}
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00005318
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005319void ASTWriter::FlushCXXBaseSpecifiers() {
5320 RecordData Record;
Richard Smithc2bb8182015-03-24 06:36:48 +00005321 unsigned N = CXXBaseSpecifiersToWrite.size();
5322 for (unsigned I = 0; I != N; ++I) {
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005323 Record.clear();
5324
5325 // Record the offset of this base-specifier set.
Douglas Gregorc27b2872011-08-04 00:01:48 +00005326 unsigned Index = CXXBaseSpecifiersToWrite[I].ID - 1;
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005327 if (Index == CXXBaseSpecifiersOffsets.size())
5328 CXXBaseSpecifiersOffsets.push_back(Stream.GetCurrentBitNo());
5329 else {
5330 if (Index > CXXBaseSpecifiersOffsets.size())
5331 CXXBaseSpecifiersOffsets.resize(Index + 1);
5332 CXXBaseSpecifiersOffsets[Index] = Stream.GetCurrentBitNo();
5333 }
5334
5335 const CXXBaseSpecifier *B = CXXBaseSpecifiersToWrite[I].Bases,
5336 *BEnd = CXXBaseSpecifiersToWrite[I].BasesEnd;
5337 Record.push_back(BEnd - B);
5338 for (; B != BEnd; ++B)
5339 AddCXXBaseSpecifier(*B, Record);
5340 Stream.EmitRecord(serialization::DECL_CXX_BASE_SPECIFIERS, Record);
Douglas Gregord5853042010-10-30 04:28:16 +00005341
5342 // Flush any expressions that were written as part of the base specifiers.
5343 FlushStmts();
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005344 }
5345
Richard Smithc2bb8182015-03-24 06:36:48 +00005346 assert(N == CXXBaseSpecifiersToWrite.size() &&
5347 "added more base specifiers while writing base specifiers");
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005348 CXXBaseSpecifiersToWrite.clear();
5349}
5350
Alexis Hunt1d792652011-01-08 20:30:50 +00005351void ASTWriter::AddCXXCtorInitializers(
5352 const CXXCtorInitializer * const *CtorInitializers,
5353 unsigned NumCtorInitializers,
5354 RecordDataImpl &Record) {
5355 Record.push_back(NumCtorInitializers);
5356 for (unsigned i=0; i != NumCtorInitializers; ++i) {
5357 const CXXCtorInitializer *Init = CtorInitializers[i];
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005358
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005359 if (Init->isBaseInitializer()) {
Alexis Hunt37a477f2011-05-04 01:19:08 +00005360 Record.push_back(CTOR_INITIALIZER_BASE);
Douglas Gregord73f3dd2011-11-01 01:16:03 +00005361 AddTypeSourceInfo(Init->getTypeSourceInfo(), Record);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005362 Record.push_back(Init->isBaseVirtual());
Alexis Hunt37a477f2011-05-04 01:19:08 +00005363 } else if (Init->isDelegatingInitializer()) {
5364 Record.push_back(CTOR_INITIALIZER_DELEGATING);
Douglas Gregord73f3dd2011-11-01 01:16:03 +00005365 AddTypeSourceInfo(Init->getTypeSourceInfo(), Record);
Alexis Hunt37a477f2011-05-04 01:19:08 +00005366 } else if (Init->isMemberInitializer()){
5367 Record.push_back(CTOR_INITIALIZER_MEMBER);
5368 AddDeclRef(Init->getMember(), Record);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005369 } else {
Alexis Hunt37a477f2011-05-04 01:19:08 +00005370 Record.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER);
5371 AddDeclRef(Init->getIndirectMember(), Record);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005372 }
Francois Pichetd583da02010-12-04 09:14:42 +00005373
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005374 AddSourceLocation(Init->getMemberLocation(), Record);
5375 AddStmt(Init->getInit());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005376 AddSourceLocation(Init->getLParenLoc(), Record);
5377 AddSourceLocation(Init->getRParenLoc(), Record);
5378 Record.push_back(Init->isWritten());
5379 if (Init->isWritten()) {
5380 Record.push_back(Init->getSourceOrder());
5381 } else {
5382 Record.push_back(Init->getNumArrayIndices());
5383 for (unsigned i=0, e=Init->getNumArrayIndices(); i != e; ++i)
5384 AddDeclRef(Init->getArrayIndex(i), Record);
5385 }
5386 }
5387}
5388
Richard Smithc2bb8182015-03-24 06:36:48 +00005389void ASTWriter::FlushCXXCtorInitializers() {
5390 RecordData Record;
5391
5392 unsigned N = CXXCtorInitializersToWrite.size();
Daniel Jasperc77b0a12015-03-24 08:06:38 +00005393 (void)N; // Silence unused warning in non-assert builds.
Richard Smithc2bb8182015-03-24 06:36:48 +00005394 for (auto &Init : CXXCtorInitializersToWrite) {
5395 Record.clear();
5396
5397 // Record the offset of this mem-initializer list.
5398 unsigned Index = Init.ID - 1;
5399 if (Index == CXXCtorInitializersOffsets.size())
5400 CXXCtorInitializersOffsets.push_back(Stream.GetCurrentBitNo());
5401 else {
5402 if (Index > CXXCtorInitializersOffsets.size())
5403 CXXCtorInitializersOffsets.resize(Index + 1);
5404 CXXCtorInitializersOffsets[Index] = Stream.GetCurrentBitNo();
5405 }
5406
5407 AddCXXCtorInitializers(Init.Inits.data(), Init.Inits.size(), Record);
5408 Stream.EmitRecord(serialization::DECL_CXX_CTOR_INITIALIZERS, Record);
5409
5410 // Flush any expressions that were written as part of the initializers.
5411 FlushStmts();
5412 }
5413
5414 assert(N == CXXCtorInitializersToWrite.size() &&
5415 "added more ctor initializers while writing ctor initializers");
5416 CXXCtorInitializersToWrite.clear();
5417}
5418
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005419void ASTWriter::AddCXXDefinitionData(const CXXRecordDecl *D, RecordDataImpl &Record) {
Richard Smith053f6c62014-05-16 23:01:30 +00005420 auto &Data = D->data();
Douglas Gregor99ae8062012-02-14 17:54:36 +00005421 Record.push_back(Data.IsLambda);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005422 Record.push_back(Data.UserDeclaredConstructor);
Richard Smith328aae52012-11-30 05:11:39 +00005423 Record.push_back(Data.UserDeclaredSpecialMembers);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005424 Record.push_back(Data.Aggregate);
5425 Record.push_back(Data.PlainOldData);
5426 Record.push_back(Data.Empty);
5427 Record.push_back(Data.Polymorphic);
5428 Record.push_back(Data.Abstract);
Chandler Carruth583edf82011-04-30 10:07:30 +00005429 Record.push_back(Data.IsStandardLayout);
Chandler Carruthb1963742011-04-30 09:17:45 +00005430 Record.push_back(Data.HasNoNonEmptyBases);
5431 Record.push_back(Data.HasPrivateFields);
5432 Record.push_back(Data.HasProtectedFields);
5433 Record.push_back(Data.HasPublicFields);
Douglas Gregor61226d32011-05-13 01:05:07 +00005434 Record.push_back(Data.HasMutableFields);
Richard Smithab44d5b2013-12-10 08:25:00 +00005435 Record.push_back(Data.HasVariantMembers);
Richard Smith561fb152012-02-25 07:33:38 +00005436 Record.push_back(Data.HasOnlyCMembers);
Richard Smithe2648ba2012-05-07 01:07:30 +00005437 Record.push_back(Data.HasInClassInitializer);
Richard Smith593f9932012-12-08 02:01:17 +00005438 Record.push_back(Data.HasUninitializedReferenceMember);
Richard Smith6b02d462012-12-08 08:32:28 +00005439 Record.push_back(Data.NeedOverloadResolutionForMoveConstructor);
5440 Record.push_back(Data.NeedOverloadResolutionForMoveAssignment);
5441 Record.push_back(Data.NeedOverloadResolutionForDestructor);
5442 Record.push_back(Data.DefaultedMoveConstructorIsDeleted);
5443 Record.push_back(Data.DefaultedMoveAssignmentIsDeleted);
5444 Record.push_back(Data.DefaultedDestructorIsDeleted);
Richard Smith328aae52012-11-30 05:11:39 +00005445 Record.push_back(Data.HasTrivialSpecialMembers);
Richard Smithb45a6f72014-04-17 20:33:01 +00005446 Record.push_back(Data.DeclaredNonTrivialSpecialMembers);
Richard Smith328aae52012-11-30 05:11:39 +00005447 Record.push_back(Data.HasIrrelevantDestructor);
Richard Smith111af8d2011-08-10 18:11:37 +00005448 Record.push_back(Data.HasConstexprNonCopyMoveConstructor);
Richard Smith561fb152012-02-25 07:33:38 +00005449 Record.push_back(Data.DefaultedDefaultConstructorIsConstexpr);
Richard Smith561fb152012-02-25 07:33:38 +00005450 Record.push_back(Data.HasConstexprDefaultConstructor);
Chandler Carruthe71d0622011-04-24 02:49:34 +00005451 Record.push_back(Data.HasNonLiteralTypeFieldsOrBases);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005452 Record.push_back(Data.ComputedVisibleConversions);
Alexis Huntea6f0322011-05-11 22:34:38 +00005453 Record.push_back(Data.UserProvidedDefaultConstructor);
Richard Smith328aae52012-11-30 05:11:39 +00005454 Record.push_back(Data.DeclaredSpecialMembers);
Richard Smith1c33fe82012-11-28 06:23:12 +00005455 Record.push_back(Data.ImplicitCopyConstructorHasConstParam);
5456 Record.push_back(Data.ImplicitCopyAssignmentHasConstParam);
5457 Record.push_back(Data.HasDeclaredCopyConstructorWithConstParam);
5458 Record.push_back(Data.HasDeclaredCopyAssignmentWithConstParam);
Richard Smith561fb152012-02-25 07:33:38 +00005459 // IsLambda bit is already saved.
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005460
5461 Record.push_back(Data.NumBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005462 if (Data.NumBases > 0)
5463 AddCXXBaseSpecifiersRef(Data.getBases(), Data.getBases() + Data.NumBases,
5464 Record);
5465
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005466 // FIXME: Make VBases lazily computed when needed to avoid storing them.
5467 Record.push_back(Data.NumVBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005468 if (Data.NumVBases > 0)
5469 AddCXXBaseSpecifiersRef(Data.getVBases(), Data.getVBases() + Data.NumVBases,
5470 Record);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005471
Richard Smitha4ba74c2013-08-30 04:46:40 +00005472 AddUnresolvedSet(Data.Conversions.get(*Context), Record);
5473 AddUnresolvedSet(Data.VisibleConversions.get(*Context), Record);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005474 // Data.Definition is the owning decl, no need to write it.
Richard Smith68ad0e72013-06-26 02:41:25 +00005475 AddDeclRef(D->getFirstFriend(), Record);
Douglas Gregor99ae8062012-02-14 17:54:36 +00005476
5477 // Add lambda-specific data.
5478 if (Data.IsLambda) {
Richard Smith053f6c62014-05-16 23:01:30 +00005479 auto &Lambda = D->getLambdaData();
Douglas Gregor680e9e02012-02-21 19:11:17 +00005480 Record.push_back(Lambda.Dependent);
Faisal Valic1a6dc42013-10-23 16:10:50 +00005481 Record.push_back(Lambda.IsGenericLambda);
5482 Record.push_back(Lambda.CaptureDefault);
Douglas Gregor99ae8062012-02-14 17:54:36 +00005483 Record.push_back(Lambda.NumCaptures);
5484 Record.push_back(Lambda.NumExplicitCaptures);
Douglas Gregor63798542012-02-20 19:44:39 +00005485 Record.push_back(Lambda.ManglingNumber);
Douglas Gregor7fcbd902012-02-21 00:37:24 +00005486 AddDeclRef(Lambda.ContextDecl, Record);
Eli Friedmand564afb2012-09-19 01:18:11 +00005487 AddTypeSourceInfo(Lambda.MethodTyInfo, Record);
Douglas Gregor99ae8062012-02-14 17:54:36 +00005488 for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00005489 const LambdaCapture &Capture = Lambda.Captures[I];
Douglas Gregor99ae8062012-02-14 17:54:36 +00005490 AddSourceLocation(Capture.getLocation(), Record);
5491 Record.push_back(Capture.isImplicit());
Richard Smithba71c082013-05-16 06:20:58 +00005492 Record.push_back(Capture.getCaptureKind());
5493 switch (Capture.getCaptureKind()) {
5494 case LCK_This:
Alexey Bataev39c81e22014-08-28 04:28:19 +00005495 case LCK_VLAType:
Richard Smithba71c082013-05-16 06:20:58 +00005496 break;
5497 case LCK_ByCopy:
Richard Smithbb13c9a2013-09-28 04:02:39 +00005498 case LCK_ByRef:
Richard Smithba71c082013-05-16 06:20:58 +00005499 VarDecl *Var =
Craig Toppera13603a2014-05-22 05:54:18 +00005500 Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
Richard Smithba71c082013-05-16 06:20:58 +00005501 AddDeclRef(Var, Record);
5502 AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc()
5503 : SourceLocation(),
5504 Record);
5505 break;
5506 }
Douglas Gregor99ae8062012-02-14 17:54:36 +00005507 }
5508 }
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005509}
5510
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005511void ASTWriter::ReaderInitialized(ASTReader *Reader) {
Sebastian Redl07a89a82010-07-30 00:29:29 +00005512 assert(Reader && "Cannot remove chain");
Douglas Gregordf0c1512011-08-18 04:12:04 +00005513 assert((!Chain || Chain == Reader) && "Cannot replace chain");
Sebastian Redl07a89a82010-07-30 00:29:29 +00005514 assert(FirstDeclID == NextDeclID &&
5515 FirstTypeID == NextTypeID &&
5516 FirstIdentID == NextIdentID &&
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005517 FirstMacroID == NextMacroID &&
Douglas Gregor253eefe2011-12-01 00:59:36 +00005518 FirstSubmoduleID == NextSubmoduleID &&
Sebastian Redld95a56e2010-08-04 18:21:41 +00005519 FirstSelectorID == NextSelectorID &&
Sebastian Redl07a89a82010-07-30 00:29:29 +00005520 "Setting chain after writing has started.");
Douglas Gregor925296b2011-07-19 16:10:42 +00005521
Sebastian Redl07a89a82010-07-30 00:29:29 +00005522 Chain = Reader;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005523
Richard Smith7f330cd2015-03-18 01:42:29 +00005524 // Note, this will get called multiple times, once one the reader starts up
5525 // and again each time it's done reading a PCH or module.
Douglas Gregordf0c1512011-08-18 04:12:04 +00005526 FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls();
5527 FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes();
5528 FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005529 FirstMacroID = NUM_PREDEF_MACRO_IDS + Chain->getTotalNumMacros();
Douglas Gregor253eefe2011-12-01 00:59:36 +00005530 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
Douglas Gregordf0c1512011-08-18 04:12:04 +00005531 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005532 NextDeclID = FirstDeclID;
5533 NextTypeID = FirstTypeID;
5534 NextIdentID = FirstIdentID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005535 NextMacroID = FirstMacroID;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005536 NextSelectorID = FirstSelectorID;
Douglas Gregor253eefe2011-12-01 00:59:36 +00005537 NextSubmoduleID = FirstSubmoduleID;
Sebastian Redl07a89a82010-07-30 00:29:29 +00005538}
5539
Sebastian Redl539c5062010-08-18 23:57:32 +00005540void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005541 // Always keep the highest ID. See \p TypeRead() for more information.
5542 IdentID &StoredID = IdentifierIDs[II];
5543 if (ID > StoredID)
5544 StoredID = ID;
Sebastian Redlff4a2952010-07-23 23:49:55 +00005545}
5546
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005547void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005548 // Always keep the highest ID. See \p TypeRead() for more information.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005549 MacroID &StoredID = MacroIDs[MI];
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005550 if (ID > StoredID)
5551 StoredID = ID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005552}
5553
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00005554void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005555 // Always take the highest-numbered type index. This copes with an interesting
5556 // case for chained AST writing where we schedule writing the type and then,
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005557 // later, deserialize the type from another AST. In this case, we want to
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005558 // keep the higher-numbered entry so that we can properly write it out to
5559 // the AST file.
5560 TypeIdx &StoredIdx = TypeIdxs[T];
5561 if (Idx.getIndex() >= StoredIdx.getIndex())
5562 StoredIdx = Idx;
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00005563}
5564
Sebastian Redl539c5062010-08-18 23:57:32 +00005565void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005566 // Always keep the highest ID. See \p TypeRead() for more information.
5567 SelectorID &StoredID = SelectorIDs[S];
5568 if (ID > StoredID)
5569 StoredID = ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00005570}
Douglas Gregor91096292010-10-02 19:29:26 +00005571
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00005572void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
Richard Smith66a81862015-05-04 02:25:31 +00005573 MacroDefinitionRecord *MD) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00005574 assert(MacroDefinitions.find(MD) == MacroDefinitions.end());
Douglas Gregor91096292010-10-02 19:29:26 +00005575 MacroDefinitions[MD] = ID;
5576}
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005577
Douglas Gregore37a85a2011-12-02 17:30:13 +00005578void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
5579 assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end());
5580 SubmoduleIDs[Mod] = ID;
5581}
5582
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005583void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
John McCallf937c022011-10-07 06:10:15 +00005584 assert(D->isCompleteDefinition());
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005585 assert(!WritingAST && "Already writing the AST!");
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005586 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
5587 // We are interested when a PCH decl is modified.
Douglas Gregorb3722e22011-09-09 23:01:35 +00005588 if (RD->isFromASTFile()) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005589 // A forward reference was mutated into a definition. Rewrite it.
5590 // FIXME: This happens during template instantiation, should we
5591 // have created a new definition decl instead ?
Richard Smithcd45dbc2014-04-19 03:48:30 +00005592 assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
5593 "completed a tag from another module but not by instantiation?");
5594 DeclUpdates[RD].push_back(
5595 DeclUpdate(UPD_CXX_INSTANTIATED_CLASS_DEFINITION));
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005596 }
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005597 }
5598}
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005599
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005600void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
5601 // TU and namespaces are handled elsewhere.
5602 if (isa<TranslationUnitDecl>(DC) || isa<NamespaceDecl>(DC))
5603 return;
5604
Douglas Gregorb3722e22011-09-09 23:01:35 +00005605 if (!(!D->isFromASTFile() && cast<Decl>(DC)->isFromASTFile()))
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005606 return; // Not a source decl added to a DeclContext from PCH.
5607
Douglas Gregor9f782892013-01-21 15:25:38 +00005608 assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
Richard Smithe9a8bc32014-09-30 00:45:29 +00005609 assert(!WritingAST && "Already writing the AST!");
Chandler Carruth8a3d24d2015-03-26 04:27:10 +00005610 UpdatedDeclContexts.insert(DC);
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005611 UpdatingVisibleDecls.push_back(D);
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005612}
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005613
5614void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
5615 assert(D->isImplicit());
Douglas Gregorb3722e22011-09-09 23:01:35 +00005616 if (!(!D->isFromASTFile() && RD->isFromASTFile()))
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005617 return; // Not a source member added to a class from PCH.
5618 if (!isa<CXXMethodDecl>(D))
5619 return; // We are interested in lazily declared implicit methods.
5620
5621 // A decl coming from PCH was modified.
John McCallf937c022011-10-07 06:10:15 +00005622 assert(RD->isCompleteDefinition());
Richard Smithe9a8bc32014-09-30 00:45:29 +00005623 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00005624 DeclUpdates[RD].push_back(DeclUpdate(UPD_CXX_ADDED_IMPLICIT_MEMBER, D));
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005625}
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00005626
5627void ASTWriter::AddedCXXTemplateSpecialization(const ClassTemplateDecl *TD,
5628 const ClassTemplateSpecializationDecl *D) {
Argyrios Kyrtzidisef80a012010-10-28 07:38:47 +00005629 // The specializations set is kept in the canonical template.
5630 TD = TD->getCanonicalDecl();
Douglas Gregorb3722e22011-09-09 23:01:35 +00005631 if (!(!D->isFromASTFile() && TD->isFromASTFile()))
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00005632 return; // Not a source specialization added to a template from PCH.
5633
Richard Smithe9a8bc32014-09-30 00:45:29 +00005634 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00005635 DeclUpdates[TD].push_back(DeclUpdate(UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION,
5636 D));
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00005637}
Douglas Gregorf88e35b2010-11-30 06:16:57 +00005638
Larisse Voufo39a1e502013-08-06 01:03:05 +00005639void ASTWriter::AddedCXXTemplateSpecialization(
5640 const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
5641 // The specializations set is kept in the canonical template.
Larisse Voufo39a1e502013-08-06 01:03:05 +00005642 TD = TD->getCanonicalDecl();
5643 if (!(!D->isFromASTFile() && TD->isFromASTFile()))
5644 return; // Not a source specialization added to a template from PCH.
5645
Richard Smithe9a8bc32014-09-30 00:45:29 +00005646 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00005647 DeclUpdates[TD].push_back(DeclUpdate(UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION,
5648 D));
Larisse Voufo39a1e502013-08-06 01:03:05 +00005649}
5650
Sebastian Redl9ab988f2011-04-14 14:07:59 +00005651void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
5652 const FunctionDecl *D) {
5653 // The specializations set is kept in the canonical template.
5654 TD = TD->getCanonicalDecl();
Douglas Gregorb3722e22011-09-09 23:01:35 +00005655 if (!(!D->isFromASTFile() && TD->isFromASTFile()))
Sebastian Redl9ab988f2011-04-14 14:07:59 +00005656 return; // Not a source specialization added to a template from PCH.
5657
Richard Smithe9a8bc32014-09-30 00:45:29 +00005658 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00005659 DeclUpdates[TD].push_back(DeclUpdate(UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION,
5660 D));
Sebastian Redl9ab988f2011-04-14 14:07:59 +00005661}
5662
Richard Smith564417a2014-03-20 21:47:22 +00005663void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
Richard Smith9e2341d2015-03-23 03:25:59 +00005664 assert(!DoneWritingDeclsAndTypes && "Already done writing updates!");
5665 if (!Chain) return;
5666 Chain->forEachFormerlyCanonicalImportedDecl(FD, [&](const Decl *D) {
5667 // If we don't already know the exception specification for this redecl
5668 // chain, add an update record for it.
5669 if (isUnresolvedExceptionSpec(cast<FunctionDecl>(D)
5670 ->getType()
5671 ->castAs<FunctionProtoType>()
5672 ->getExceptionSpecType()))
5673 DeclUpdates[D].push_back(UPD_CXX_RESOLVED_EXCEPTION_SPEC);
5674 });
Richard Smith564417a2014-03-20 21:47:22 +00005675}
5676
Richard Smith1fa5d642013-05-11 05:45:24 +00005677void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
5678 assert(!WritingAST && "Already writing the AST!");
Richard Smith9e2341d2015-03-23 03:25:59 +00005679 if (!Chain) return;
5680 Chain->forEachFormerlyCanonicalImportedDecl(FD, [&](const Decl *D) {
5681 DeclUpdates[D].push_back(
5682 DeclUpdate(UPD_CXX_DEDUCED_RETURN_TYPE, ReturnType));
5683 });
Richard Smith1fa5d642013-05-11 05:45:24 +00005684}
5685
Richard Smithf8134002015-03-10 01:41:22 +00005686void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD,
5687 const FunctionDecl *Delete) {
5688 assert(!WritingAST && "Already writing the AST!");
5689 assert(Delete && "Not given an operator delete");
Richard Smith9e2341d2015-03-23 03:25:59 +00005690 if (!Chain) return;
5691 Chain->forEachFormerlyCanonicalImportedDecl(DD, [&](const Decl *D) {
5692 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_RESOLVED_DTOR_DELETE, Delete));
5693 });
Richard Smithf8134002015-03-10 01:41:22 +00005694}
5695
Sebastian Redlab238a72011-04-24 16:28:06 +00005696void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005697 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005698 if (!D->isFromASTFile())
Sebastian Redlab238a72011-04-24 16:28:06 +00005699 return; // Declaration not imported from PCH.
5700
Richard Smith4d235792014-08-07 18:53:08 +00005701 // Implicit function decl from a PCH was defined.
5702 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Sebastian Redlab238a72011-04-24 16:28:06 +00005703}
5704
Richard Smithd28ac5b2014-03-22 23:33:22 +00005705void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
5706 assert(!WritingAST && "Already writing the AST!");
5707 if (!D->isFromASTFile())
5708 return;
5709
Richard Smith9e2341d2015-03-23 03:25:59 +00005710 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Richard Smithd28ac5b2014-03-22 23:33:22 +00005711}
5712
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005713void ASTWriter::StaticDataMemberInstantiated(const VarDecl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005714 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005715 if (!D->isFromASTFile())
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005716 return;
5717
5718 // Since the actual instantiation is delayed, this really means that we need
5719 // to update the instantiation location.
Richard Smith6ef42932014-03-20 21:02:00 +00005720 DeclUpdates[D].push_back(
Aaron Ballman4f45b712014-03-21 15:22:56 +00005721 DeclUpdate(UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER,
5722 D->getMemberSpecializationInfo()->getPointOfInstantiation()));
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005723}
5724
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005725void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
5726 const ObjCInterfaceDecl *IFD) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005727 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005728 if (!IFD->isFromASTFile())
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005729 return; // Declaration not imported from PCH.
Douglas Gregor404cdde2012-01-27 01:47:08 +00005730
5731 assert(IFD->getDefinition() && "Category on a class without a definition?");
5732 ObjCClassesWithCategories.insert(
5733 const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005734}
Argyrios Kyrtzidisb97a4022011-11-12 21:07:46 +00005735
Argyrios Kyrtzidis0ca3a8b2011-11-12 21:07:52 +00005736
Argyrios Kyrtzidis846e61a2011-11-14 04:52:29 +00005737void ASTWriter::AddedObjCPropertyInClassExtension(const ObjCPropertyDecl *Prop,
5738 const ObjCPropertyDecl *OrigProp,
5739 const ObjCCategoryDecl *ClassExt) {
5740 const ObjCInterfaceDecl *D = ClassExt->getClassInterface();
5741 if (!D)
5742 return;
5743
5744 assert(!WritingAST && "Already writing the AST!");
5745 if (!D->isFromASTFile())
5746 return; // Declaration not imported from PCH.
5747
5748 RewriteDecl(D);
5749}
Eli Friedman276dd182013-09-05 00:02:25 +00005750
5751void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
5752 assert(!WritingAST && "Already writing the AST!");
5753 if (!D->isFromASTFile())
5754 return;
5755
Aaron Ballman4f45b712014-03-21 15:22:56 +00005756 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_USED));
Eli Friedman276dd182013-09-05 00:02:25 +00005757}
Alexey Bataev97720002014-11-11 04:05:39 +00005758
5759void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
5760 assert(!WritingAST && "Already writing the AST!");
5761 if (!D->isFromASTFile())
5762 return;
5763
5764 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_THREADPRIVATE));
5765}
Richard Smith65ebb4a2015-03-26 04:09:53 +00005766
Richard Smith4caa4492015-05-15 02:34:32 +00005767void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) {
Richard Smith65ebb4a2015-03-26 04:09:53 +00005768 assert(!WritingAST && "Already writing the AST!");
5769 assert(D->isHidden() && "expected a hidden declaration");
Richard Smith4caa4492015-05-15 02:34:32 +00005770 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_EXPORTED, M));
Richard Smith65ebb4a2015-03-26 04:09:53 +00005771}