blob: b554f5f1ccd084d64ad61dd48adcef0f704186b3 [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 Gregore83b9562015-07-07 03:57:53 +0000424 Record.push_back(T->getTypeArgsAsWritten().size());
425 for (auto TypeArg : T->getTypeArgsAsWritten())
Douglas Gregore9d95f12015-07-07 03:57:35 +0000426 Writer.AddTypeRef(TypeArg, Record);
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000427 Record.push_back(T->getNumProtocols());
Aaron Ballman1683f7b2014-03-17 15:55:30 +0000428 for (const auto *I : T->quals())
429 Writer.AddDeclRef(I, Record);
Douglas Gregorab209d82015-07-07 03:58:42 +0000430 Record.push_back(T->isKindOfTypeAsWritten());
Sebastian Redl539c5062010-08-18 23:57:32 +0000431 Code = TYPE_OBJC_OBJECT;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000432}
433
Steve Narofffb4330f2009-06-17 22:40:22 +0000434void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000435ASTTypeWriter::VisitObjCObjectPointerType(const ObjCObjectPointerType *T) {
Mike Stump11289f42009-09-09 15:08:12 +0000436 Writer.AddTypeRef(T->getPointeeType(), Record);
Sebastian Redl539c5062010-08-18 23:57:32 +0000437 Code = TYPE_OBJC_OBJECT_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000438}
439
Eli Friedman0dfb8892011-10-06 23:00:33 +0000440void
441ASTTypeWriter::VisitAtomicType(const AtomicType *T) {
442 Writer.AddTypeRef(T->getValueType(), Record);
443 Code = TYPE_ATOMIC;
444}
445
John McCall8f115c62009-10-16 21:56:05 +0000446namespace {
447
448class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> {
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000449 ASTWriter &Writer;
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000450 ASTWriter::RecordDataImpl &Record;
John McCall8f115c62009-10-16 21:56:05 +0000451
452public:
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000453 TypeLocWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record)
John McCall8f115c62009-10-16 21:56:05 +0000454 : Writer(Writer), Record(Record) { }
455
John McCall17001972009-10-18 01:05:36 +0000456#define ABSTRACT_TYPELOC(CLASS, PARENT)
John McCall8f115c62009-10-16 21:56:05 +0000457#define TYPELOC(CLASS, PARENT) \
John McCall17001972009-10-18 01:05:36 +0000458 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000459#include "clang/AST/TypeLocNodes.def"
460
John McCall17001972009-10-18 01:05:36 +0000461 void VisitArrayTypeLoc(ArrayTypeLoc TyLoc);
462 void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000463};
464
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000465}
John McCall8f115c62009-10-16 21:56:05 +0000466
John McCall17001972009-10-18 01:05:36 +0000467void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
468 // nothing to do
John McCall8f115c62009-10-16 21:56:05 +0000469}
John McCall17001972009-10-18 01:05:36 +0000470void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
Douglas Gregorc9b7a592010-01-18 18:04:31 +0000471 Writer.AddSourceLocation(TL.getBuiltinLoc(), Record);
472 if (TL.needsExtraLocalData()) {
473 Record.push_back(TL.getWrittenTypeSpec());
474 Record.push_back(TL.getWrittenSignSpec());
475 Record.push_back(TL.getWrittenWidthSpec());
476 Record.push_back(TL.hasModeAttr());
477 }
John McCall8f115c62009-10-16 21:56:05 +0000478}
John McCall17001972009-10-18 01:05:36 +0000479void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
480 Writer.AddSourceLocation(TL.getNameLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000481}
John McCall17001972009-10-18 01:05:36 +0000482void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) {
483 Writer.AddSourceLocation(TL.getStarLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000484}
Reid Kleckner8a365022013-06-24 17:51:48 +0000485void TypeLocWriter::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
486 // nothing to do
487}
Reid Kleckner0503a872013-12-05 01:23:43 +0000488void TypeLocWriter::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
489 // nothing to do
490}
John McCall17001972009-10-18 01:05:36 +0000491void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
492 Writer.AddSourceLocation(TL.getCaretLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000493}
John McCall17001972009-10-18 01:05:36 +0000494void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
495 Writer.AddSourceLocation(TL.getAmpLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000496}
John McCall17001972009-10-18 01:05:36 +0000497void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
498 Writer.AddSourceLocation(TL.getAmpAmpLoc(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000499}
John McCall17001972009-10-18 01:05:36 +0000500void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
501 Writer.AddSourceLocation(TL.getStarLoc(), Record);
Abramo Bagnara509357842011-03-05 14:42:21 +0000502 Writer.AddTypeSourceInfo(TL.getClassTInfo(), Record);
John McCall8f115c62009-10-16 21:56:05 +0000503}
John McCall17001972009-10-18 01:05:36 +0000504void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) {
505 Writer.AddSourceLocation(TL.getLBracketLoc(), Record);
506 Writer.AddSourceLocation(TL.getRBracketLoc(), Record);
507 Record.push_back(TL.getSizeExpr() ? 1 : 0);
508 if (TL.getSizeExpr())
509 Writer.AddStmt(TL.getSizeExpr());
John McCall8f115c62009-10-16 21:56:05 +0000510}
John McCall17001972009-10-18 01:05:36 +0000511void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
512 VisitArrayTypeLoc(TL);
513}
514void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
515 VisitArrayTypeLoc(TL);
516}
517void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
518 VisitArrayTypeLoc(TL);
519}
520void TypeLocWriter::VisitDependentSizedArrayTypeLoc(
521 DependentSizedArrayTypeLoc TL) {
522 VisitArrayTypeLoc(TL);
523}
524void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc(
525 DependentSizedExtVectorTypeLoc TL) {
526 Writer.AddSourceLocation(TL.getNameLoc(), Record);
527}
528void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) {
529 Writer.AddSourceLocation(TL.getNameLoc(), Record);
530}
531void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
532 Writer.AddSourceLocation(TL.getNameLoc(), Record);
533}
534void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
Abramo Bagnaraf2a79d92011-03-12 11:17:06 +0000535 Writer.AddSourceLocation(TL.getLocalRangeBegin(), Record);
Abramo Bagnaraaeeb9892012-10-04 21:42:10 +0000536 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
537 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
Abramo Bagnaraf2a79d92011-03-12 11:17:06 +0000538 Writer.AddSourceLocation(TL.getLocalRangeEnd(), Record);
Alp Tokerb3fd5cf2014-01-21 00:32:38 +0000539 for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i)
540 Writer.AddDeclRef(TL.getParam(i), Record);
John McCall17001972009-10-18 01:05:36 +0000541}
542void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
543 VisitFunctionTypeLoc(TL);
544}
545void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
546 VisitFunctionTypeLoc(TL);
547}
John McCallb96ec562009-12-04 22:46:56 +0000548void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
549 Writer.AddSourceLocation(TL.getNameLoc(), Record);
550}
John McCall17001972009-10-18 01:05:36 +0000551void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
552 Writer.AddSourceLocation(TL.getNameLoc(), Record);
553}
554void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
John McCalle8595032010-01-13 20:03:27 +0000555 Writer.AddSourceLocation(TL.getTypeofLoc(), Record);
556 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
557 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
John McCall17001972009-10-18 01:05:36 +0000558}
559void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
John McCalle8595032010-01-13 20:03:27 +0000560 Writer.AddSourceLocation(TL.getTypeofLoc(), Record);
561 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
562 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
563 Writer.AddTypeSourceInfo(TL.getUnderlyingTInfo(), Record);
John McCall17001972009-10-18 01:05:36 +0000564}
565void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
566 Writer.AddSourceLocation(TL.getNameLoc(), Record);
567}
Alexis Hunte852b102011-05-24 22:41:36 +0000568void TypeLocWriter::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
569 Writer.AddSourceLocation(TL.getKWLoc(), Record);
570 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
571 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
572 Writer.AddTypeSourceInfo(TL.getUnderlyingTInfo(), Record);
573}
Richard Smith30482bc2011-02-20 03:19:35 +0000574void TypeLocWriter::VisitAutoTypeLoc(AutoTypeLoc TL) {
575 Writer.AddSourceLocation(TL.getNameLoc(), Record);
576}
John McCall17001972009-10-18 01:05:36 +0000577void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) {
578 Writer.AddSourceLocation(TL.getNameLoc(), Record);
579}
580void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) {
581 Writer.AddSourceLocation(TL.getNameLoc(), Record);
582}
John McCall81904512011-01-06 01:58:22 +0000583void TypeLocWriter::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
584 Writer.AddSourceLocation(TL.getAttrNameLoc(), Record);
585 if (TL.hasAttrOperand()) {
586 SourceRange range = TL.getAttrOperandParensRange();
587 Writer.AddSourceLocation(range.getBegin(), Record);
588 Writer.AddSourceLocation(range.getEnd(), Record);
589 }
590 if (TL.hasAttrExprOperand()) {
591 Expr *operand = TL.getAttrExprOperand();
592 Record.push_back(operand ? 1 : 0);
593 if (operand) Writer.AddStmt(operand);
594 } else if (TL.hasAttrEnumOperand()) {
595 Writer.AddSourceLocation(TL.getAttrEnumOperandLoc(), Record);
596 }
597}
John McCall17001972009-10-18 01:05:36 +0000598void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
599 Writer.AddSourceLocation(TL.getNameLoc(), Record);
600}
John McCallcebee162009-10-18 09:09:24 +0000601void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
602 SubstTemplateTypeParmTypeLoc TL) {
603 Writer.AddSourceLocation(TL.getNameLoc(), Record);
604}
Douglas Gregorada4b792011-01-14 02:55:32 +0000605void TypeLocWriter::VisitSubstTemplateTypeParmPackTypeLoc(
606 SubstTemplateTypeParmPackTypeLoc TL) {
607 Writer.AddSourceLocation(TL.getNameLoc(), Record);
608}
John McCall17001972009-10-18 01:05:36 +0000609void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
610 TemplateSpecializationTypeLoc TL) {
Abramo Bagnara48c05be2012-02-06 14:41:24 +0000611 Writer.AddSourceLocation(TL.getTemplateKeywordLoc(), Record);
John McCall0ad16662009-10-29 08:12:44 +0000612 Writer.AddSourceLocation(TL.getTemplateNameLoc(), Record);
613 Writer.AddSourceLocation(TL.getLAngleLoc(), Record);
614 Writer.AddSourceLocation(TL.getRAngleLoc(), Record);
615 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +0000616 Writer.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(),
617 TL.getArgLoc(i).getLocInfo(), Record);
John McCall17001972009-10-18 01:05:36 +0000618}
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000619void TypeLocWriter::VisitParenTypeLoc(ParenTypeLoc TL) {
620 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
621 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
622}
Abramo Bagnara6150c882010-05-11 21:36:43 +0000623void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
Abramo Bagnara9033e2b2012-02-06 19:09:27 +0000624 Writer.AddSourceLocation(TL.getElaboratedKeywordLoc(), Record);
Douglas Gregor844cb502011-03-01 18:12:44 +0000625 Writer.AddNestedNameSpecifierLoc(TL.getQualifierLoc(), Record);
John McCall17001972009-10-18 01:05:36 +0000626}
John McCalle78aac42010-03-10 03:28:59 +0000627void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
628 Writer.AddSourceLocation(TL.getNameLoc(), Record);
629}
Douglas Gregorc1d2d8a2010-03-31 17:34:00 +0000630void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
Abramo Bagnara9033e2b2012-02-06 19:09:27 +0000631 Writer.AddSourceLocation(TL.getElaboratedKeywordLoc(), Record);
Douglas Gregor3d0da5f2011-03-01 01:34:45 +0000632 Writer.AddNestedNameSpecifierLoc(TL.getQualifierLoc(), Record);
John McCall17001972009-10-18 01:05:36 +0000633 Writer.AddSourceLocation(TL.getNameLoc(), Record);
634}
John McCallc392f372010-06-11 00:33:02 +0000635void TypeLocWriter::VisitDependentTemplateSpecializationTypeLoc(
636 DependentTemplateSpecializationTypeLoc TL) {
Abramo Bagnara48c05be2012-02-06 14:41:24 +0000637 Writer.AddSourceLocation(TL.getElaboratedKeywordLoc(), Record);
Douglas Gregora7a795b2011-03-01 20:11:18 +0000638 Writer.AddNestedNameSpecifierLoc(TL.getQualifierLoc(), Record);
Abramo Bagnarae0a70b22012-02-06 22:45:07 +0000639 Writer.AddSourceLocation(TL.getTemplateKeywordLoc(), Record);
Abramo Bagnara48c05be2012-02-06 14:41:24 +0000640 Writer.AddSourceLocation(TL.getTemplateNameLoc(), Record);
John McCallc392f372010-06-11 00:33:02 +0000641 Writer.AddSourceLocation(TL.getLAngleLoc(), Record);
642 Writer.AddSourceLocation(TL.getRAngleLoc(), Record);
643 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +0000644 Writer.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(),
645 TL.getArgLoc(I).getLocInfo(), Record);
John McCallc392f372010-06-11 00:33:02 +0000646}
Douglas Gregord2fa7662010-12-20 02:24:11 +0000647void TypeLocWriter::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
648 Writer.AddSourceLocation(TL.getEllipsisLoc(), Record);
649}
John McCall17001972009-10-18 01:05:36 +0000650void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
651 Writer.AddSourceLocation(TL.getNameLoc(), Record);
John McCall8b07ec22010-05-15 11:32:37 +0000652}
653void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
654 Record.push_back(TL.hasBaseTypeAsWritten());
Douglas Gregore9d95f12015-07-07 03:57:35 +0000655 Writer.AddSourceLocation(TL.getTypeArgsLAngleLoc(), Record);
656 Writer.AddSourceLocation(TL.getTypeArgsRAngleLoc(), Record);
657 for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
658 Writer.AddTypeSourceInfo(TL.getTypeArgTInfo(i), Record);
659 Writer.AddSourceLocation(TL.getProtocolLAngleLoc(), Record);
660 Writer.AddSourceLocation(TL.getProtocolRAngleLoc(), Record);
John McCall17001972009-10-18 01:05:36 +0000661 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
662 Writer.AddSourceLocation(TL.getProtocolLoc(i), Record);
John McCall8f115c62009-10-16 21:56:05 +0000663}
John McCallfc93cf92009-10-22 22:37:11 +0000664void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
665 Writer.AddSourceLocation(TL.getStarLoc(), Record);
John McCallfc93cf92009-10-22 22:37:11 +0000666}
Eli Friedman0dfb8892011-10-06 23:00:33 +0000667void TypeLocWriter::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
668 Writer.AddSourceLocation(TL.getKWLoc(), Record);
669 Writer.AddSourceLocation(TL.getLParenLoc(), Record);
670 Writer.AddSourceLocation(TL.getRParenLoc(), Record);
671}
John McCall8f115c62009-10-16 21:56:05 +0000672
Richard Smith01b2cb42014-07-26 06:37:51 +0000673void ASTWriter::WriteTypeAbbrevs() {
674 using namespace llvm;
675
676 BitCodeAbbrev *Abv;
677
678 // Abbreviation for TYPE_EXT_QUAL
679 Abv = new BitCodeAbbrev();
680 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_EXT_QUAL));
681 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
682 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 3)); // Quals
683 TypeExtQualAbbrev = Stream.EmitAbbrev(Abv);
684
685 // Abbreviation for TYPE_FUNCTION_PROTO
686 Abv = new BitCodeAbbrev();
687 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_FUNCTION_PROTO));
688 // FunctionType
689 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ReturnType
690 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // NoReturn
691 Abv->Add(BitCodeAbbrevOp(0)); // HasRegParm
692 Abv->Add(BitCodeAbbrevOp(0)); // RegParm
693 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // CC
694 Abv->Add(BitCodeAbbrevOp(0)); // ProducesResult
695 // FunctionProtoType
696 Abv->Add(BitCodeAbbrevOp(0)); // IsVariadic
697 Abv->Add(BitCodeAbbrevOp(0)); // HasTrailingReturn
698 Abv->Add(BitCodeAbbrevOp(0)); // TypeQuals
699 Abv->Add(BitCodeAbbrevOp(0)); // RefQualifier
700 Abv->Add(BitCodeAbbrevOp(EST_None)); // ExceptionSpec
701 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // NumParams
702 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
703 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Params
704 TypeFunctionProtoAbbrev = Stream.EmitAbbrev(Abv);
705}
706
Chris Lattner19cea4e2009-04-22 05:57:30 +0000707//===----------------------------------------------------------------------===//
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000708// ASTWriter Implementation
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000709//===----------------------------------------------------------------------===//
710
Chris Lattner28fa4e62009-04-26 22:26:21 +0000711static void EmitBlockID(unsigned ID, const char *Name,
712 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000713 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000714 Record.clear();
715 Record.push_back(ID);
716 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
717
718 // Emit the block name if present.
Craig Toppera13603a2014-05-22 05:54:18 +0000719 if (!Name || Name[0] == 0)
720 return;
Chris Lattner28fa4e62009-04-26 22:26:21 +0000721 Record.clear();
722 while (*Name)
723 Record.push_back(*Name++);
724 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record);
725}
726
727static void EmitRecordID(unsigned ID, const char *Name,
728 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000729 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000730 Record.clear();
731 Record.push_back(ID);
732 while (*Name)
733 Record.push_back(*Name++);
734 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000735}
736
737static void AddStmtsExprs(llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000738 ASTWriter::RecordDataImpl &Record) {
Sebastian Redl539c5062010-08-18 23:57:32 +0000739#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Chris Lattnerccac3a62009-04-27 00:49:53 +0000740 RECORD(STMT_STOP);
741 RECORD(STMT_NULL_PTR);
Richard Smith01b2cb42014-07-26 06:37:51 +0000742 RECORD(STMT_REF_PTR);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000743 RECORD(STMT_NULL);
744 RECORD(STMT_COMPOUND);
745 RECORD(STMT_CASE);
746 RECORD(STMT_DEFAULT);
747 RECORD(STMT_LABEL);
Richard Smithc202b282012-04-14 00:33:13 +0000748 RECORD(STMT_ATTRIBUTED);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000749 RECORD(STMT_IF);
750 RECORD(STMT_SWITCH);
751 RECORD(STMT_WHILE);
752 RECORD(STMT_DO);
753 RECORD(STMT_FOR);
754 RECORD(STMT_GOTO);
755 RECORD(STMT_INDIRECT_GOTO);
756 RECORD(STMT_CONTINUE);
757 RECORD(STMT_BREAK);
758 RECORD(STMT_RETURN);
759 RECORD(STMT_DECL);
Chad Rosierde70e0e2012-08-25 00:11:56 +0000760 RECORD(STMT_GCCASM);
Chad Rosiere30d4992012-08-24 23:51:02 +0000761 RECORD(STMT_MSASM);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000762 RECORD(EXPR_PREDEFINED);
763 RECORD(EXPR_DECL_REF);
764 RECORD(EXPR_INTEGER_LITERAL);
765 RECORD(EXPR_FLOATING_LITERAL);
766 RECORD(EXPR_IMAGINARY_LITERAL);
767 RECORD(EXPR_STRING_LITERAL);
768 RECORD(EXPR_CHARACTER_LITERAL);
769 RECORD(EXPR_PAREN);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000770 RECORD(EXPR_PAREN_LIST);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000771 RECORD(EXPR_UNARY_OPERATOR);
772 RECORD(EXPR_SIZEOF_ALIGN_OF);
773 RECORD(EXPR_ARRAY_SUBSCRIPT);
774 RECORD(EXPR_CALL);
775 RECORD(EXPR_MEMBER);
776 RECORD(EXPR_BINARY_OPERATOR);
777 RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR);
778 RECORD(EXPR_CONDITIONAL_OPERATOR);
779 RECORD(EXPR_IMPLICIT_CAST);
780 RECORD(EXPR_CSTYLE_CAST);
781 RECORD(EXPR_COMPOUND_LITERAL);
782 RECORD(EXPR_EXT_VECTOR_ELEMENT);
783 RECORD(EXPR_INIT_LIST);
784 RECORD(EXPR_DESIGNATED_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000785 RECORD(EXPR_DESIGNATED_INIT_UPDATE);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000786 RECORD(EXPR_IMPLICIT_VALUE_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000787 RECORD(EXPR_NO_INIT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000788 RECORD(EXPR_VA_ARG);
789 RECORD(EXPR_ADDR_LABEL);
790 RECORD(EXPR_STMT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000791 RECORD(EXPR_CHOOSE);
792 RECORD(EXPR_GNU_NULL);
793 RECORD(EXPR_SHUFFLE_VECTOR);
794 RECORD(EXPR_BLOCK);
Peter Collingbourne91147592011-04-15 00:35:48 +0000795 RECORD(EXPR_GENERIC_SELECTION);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000796 RECORD(EXPR_OBJC_STRING_LITERAL);
Patrick Beard0caa3942012-04-19 00:25:12 +0000797 RECORD(EXPR_OBJC_BOXED_EXPRESSION);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000798 RECORD(EXPR_OBJC_ARRAY_LITERAL);
799 RECORD(EXPR_OBJC_DICTIONARY_LITERAL);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000800 RECORD(EXPR_OBJC_ENCODE);
801 RECORD(EXPR_OBJC_SELECTOR_EXPR);
802 RECORD(EXPR_OBJC_PROTOCOL_EXPR);
803 RECORD(EXPR_OBJC_IVAR_REF_EXPR);
804 RECORD(EXPR_OBJC_PROPERTY_REF_EXPR);
805 RECORD(EXPR_OBJC_KVC_REF_EXPR);
806 RECORD(EXPR_OBJC_MESSAGE_EXPR);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000807 RECORD(STMT_OBJC_FOR_COLLECTION);
808 RECORD(STMT_OBJC_CATCH);
809 RECORD(STMT_OBJC_FINALLY);
810 RECORD(STMT_OBJC_AT_TRY);
811 RECORD(STMT_OBJC_AT_SYNCHRONIZED);
812 RECORD(STMT_OBJC_AT_THROW);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000813 RECORD(EXPR_OBJC_BOOL_LITERAL);
Richard Smith01b2cb42014-07-26 06:37:51 +0000814 RECORD(STMT_CXX_CATCH);
815 RECORD(STMT_CXX_TRY);
816 RECORD(STMT_CXX_FOR_RANGE);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000817 RECORD(EXPR_CXX_OPERATOR_CALL);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000818 RECORD(EXPR_CXX_MEMBER_CALL);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000819 RECORD(EXPR_CXX_CONSTRUCT);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000820 RECORD(EXPR_CXX_TEMPORARY_OBJECT);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000821 RECORD(EXPR_CXX_STATIC_CAST);
822 RECORD(EXPR_CXX_DYNAMIC_CAST);
823 RECORD(EXPR_CXX_REINTERPRET_CAST);
824 RECORD(EXPR_CXX_CONST_CAST);
825 RECORD(EXPR_CXX_FUNCTIONAL_CAST);
Richard Smithc67fdd42012-03-07 08:35:16 +0000826 RECORD(EXPR_USER_DEFINED_LITERAL);
Richard Smithcc1b96d2013-06-12 22:31:48 +0000827 RECORD(EXPR_CXX_STD_INITIALIZER_LIST);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000828 RECORD(EXPR_CXX_BOOL_LITERAL);
829 RECORD(EXPR_CXX_NULL_PTR_LITERAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000830 RECORD(EXPR_CXX_TYPEID_EXPR);
831 RECORD(EXPR_CXX_TYPEID_TYPE);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000832 RECORD(EXPR_CXX_THIS);
833 RECORD(EXPR_CXX_THROW);
834 RECORD(EXPR_CXX_DEFAULT_ARG);
Richard Smith01b2cb42014-07-26 06:37:51 +0000835 RECORD(EXPR_CXX_DEFAULT_INIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000836 RECORD(EXPR_CXX_BIND_TEMPORARY);
837 RECORD(EXPR_CXX_SCALAR_VALUE_INIT);
838 RECORD(EXPR_CXX_NEW);
839 RECORD(EXPR_CXX_DELETE);
840 RECORD(EXPR_CXX_PSEUDO_DESTRUCTOR);
841 RECORD(EXPR_EXPR_WITH_CLEANUPS);
842 RECORD(EXPR_CXX_DEPENDENT_SCOPE_MEMBER);
843 RECORD(EXPR_CXX_DEPENDENT_SCOPE_DECL_REF);
844 RECORD(EXPR_CXX_UNRESOLVED_CONSTRUCT);
845 RECORD(EXPR_CXX_UNRESOLVED_MEMBER);
846 RECORD(EXPR_CXX_UNRESOLVED_LOOKUP);
Richard Smith01b2cb42014-07-26 06:37:51 +0000847 RECORD(EXPR_CXX_EXPRESSION_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000848 RECORD(EXPR_CXX_NOEXCEPT);
849 RECORD(EXPR_OPAQUE_VALUE);
Richard Smith01b2cb42014-07-26 06:37:51 +0000850 RECORD(EXPR_BINARY_CONDITIONAL_OPERATOR);
851 RECORD(EXPR_TYPE_TRAIT);
852 RECORD(EXPR_ARRAY_TYPE_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000853 RECORD(EXPR_PACK_EXPANSION);
854 RECORD(EXPR_SIZEOF_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +0000855 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000856 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +0000857 RECORD(EXPR_FUNCTION_PARM_PACK);
858 RECORD(EXPR_MATERIALIZE_TEMPORARY);
Peter Collingbourne41f85462011-02-09 21:07:24 +0000859 RECORD(EXPR_CUDA_KERNEL_CALL);
Richard Smith01b2cb42014-07-26 06:37:51 +0000860 RECORD(EXPR_CXX_UUIDOF_EXPR);
861 RECORD(EXPR_CXX_UUIDOF_TYPE);
862 RECORD(EXPR_LAMBDA);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000863#undef RECORD
Chris Lattner28fa4e62009-04-26 22:26:21 +0000864}
Mike Stump11289f42009-09-09 15:08:12 +0000865
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000866void ASTWriter::WriteBlockInfoBlock() {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000867 RecordData Record;
868 Stream.EnterSubblock(llvm::bitc::BLOCKINFO_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +0000869
Sebastian Redl539c5062010-08-18 23:57:32 +0000870#define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record)
871#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Mike Stump11289f42009-09-09 15:08:12 +0000872
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000873 // Control Block.
874 BLOCK(CONTROL_BLOCK);
875 RECORD(METADATA);
Ben Langmuir487ea142014-10-23 18:05:36 +0000876 RECORD(SIGNATURE);
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000877 RECORD(MODULE_NAME);
878 RECORD(MODULE_MAP_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000879 RECORD(IMPORTS);
880 RECORD(LANGUAGE_OPTIONS);
881 RECORD(TARGET_OPTIONS);
Douglas Gregorfad10d82012-10-18 18:36:53 +0000882 RECORD(ORIGINAL_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000883 RECORD(ORIGINAL_PCH_DIR);
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +0000884 RECORD(ORIGINAL_FILE_ID);
Douglas Gregor3120d2c2012-10-22 18:42:04 +0000885 RECORD(INPUT_FILE_OFFSETS);
Douglas Gregor8263ffb2012-10-24 15:17:15 +0000886 RECORD(DIAGNOSTIC_OPTIONS);
Douglas Gregorc6317db2012-10-24 15:49:58 +0000887 RECORD(FILE_SYSTEM_OPTIONS);
Douglas Gregor2d302362012-10-24 16:50:34 +0000888 RECORD(HEADER_SEARCH_OPTIONS);
Douglas Gregorb6af6c22012-10-24 20:05:57 +0000889 RECORD(PREPROCESSOR_OPTIONS);
890
Douglas Gregor108cb222012-10-19 00:45:00 +0000891 BLOCK(INPUT_FILES_BLOCK);
892 RECORD(INPUT_FILE);
893
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000894 // AST Top-Level Block.
895 BLOCK(AST_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000896 RECORD(TYPE_OFFSET);
897 RECORD(DECL_OFFSET);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000898 RECORD(IDENTIFIER_OFFSET);
899 RECORD(IDENTIFIER_TABLE);
Ben Langmuir332aafe2014-01-31 01:06:56 +0000900 RECORD(EAGERLY_DESERIALIZED_DECLS);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000901 RECORD(SPECIAL_TYPES);
902 RECORD(STATISTICS);
903 RECORD(TENTATIVE_DEFINITIONS);
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +0000904 RECORD(UNUSED_FILESCOPED_DECLS);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000905 RECORD(SELECTOR_OFFSETS);
906 RECORD(METHOD_POOL);
907 RECORD(PP_COUNTER_VALUE);
Douglas Gregor258ae542009-04-27 06:38:32 +0000908 RECORD(SOURCE_LOCATION_OFFSETS);
909 RECORD(SOURCE_LOCATION_PRELOADS);
Douglas Gregor61cac2b2009-04-27 20:06:05 +0000910 RECORD(EXT_VECTOR_DECLS);
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +0000911 RECORD(PPD_ENTITIES_OFFSETS);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +0000912 RECORD(REFERENCED_SELECTOR_POOL);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000913 RECORD(TU_UPDATE_LEXICAL);
Douglas Gregor358cd442012-01-15 16:58:34 +0000914 RECORD(LOCAL_REDECLARATIONS_MAP);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000915 RECORD(SEMA_DECL_REFS);
916 RECORD(WEAK_UNDECLARED_IDENTIFIERS);
917 RECORD(PENDING_IMPLICIT_INSTANTIATIONS);
918 RECORD(DECL_REPLACEMENTS);
919 RECORD(UPDATE_VISIBLE);
920 RECORD(DECL_UPDATE_OFFSETS);
921 RECORD(DECL_UPDATES);
922 RECORD(CXX_BASE_SPECIFIER_OFFSETS);
923 RECORD(DIAG_PRAGMA_MAPPINGS);
Peter Collingbourne5df20e02011-02-15 19:46:30 +0000924 RECORD(CUDA_SPECIAL_DECL_REFS);
Douglas Gregor09b69892011-02-10 17:09:37 +0000925 RECORD(HEADER_SEARCH_TABLE);
Peter Collingbourne5df20e02011-02-15 19:46:30 +0000926 RECORD(FP_PRAGMA_OPTIONS);
927 RECORD(OPENCL_EXTENSIONS);
Alexis Hunt27a761d2011-05-04 23:29:54 +0000928 RECORD(DELEGATING_CTORS);
Douglas Gregorc2fa1692011-06-28 16:20:02 +0000929 RECORD(KNOWN_NAMESPACES);
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +0000930 RECORD(UNDEFINED_BUT_USED);
Douglas Gregor78d0b572011-08-04 16:39:39 +0000931 RECORD(MODULE_OFFSET_MAP);
932 RECORD(SOURCE_MANAGER_LINE_TABLE);
Douglas Gregor404cdde2012-01-27 01:47:08 +0000933 RECORD(OBJC_CATEGORIES_MAP);
Douglas Gregor66e4add2011-12-19 21:09:25 +0000934 RECORD(FILE_SORTED_DECLS);
935 RECORD(IMPORTED_MODULES);
Douglas Gregor358cd442012-01-15 16:58:34 +0000936 RECORD(LOCAL_REDECLARATIONS);
Douglas Gregor404cdde2012-01-27 01:47:08 +0000937 RECORD(OBJC_CATEGORIES);
Douglas Gregorcb28f9d2012-10-09 23:05:51 +0000938 RECORD(MACRO_OFFSET);
Richard Smithe40f2ba2013-08-07 21:41:30 +0000939 RECORD(LATE_PARSED_TEMPLATE);
Dario Domizioli13a0a382014-05-23 12:13:25 +0000940 RECORD(OPTIMIZE_PRAGMA_OPTIONS);
Douglas Gregor358cd442012-01-15 16:58:34 +0000941
Chris Lattner28fa4e62009-04-26 22:26:21 +0000942 // SourceManager Block.
Chris Lattner64031982009-04-27 00:40:25 +0000943 BLOCK(SOURCE_MANAGER_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000944 RECORD(SM_SLOC_FILE_ENTRY);
945 RECORD(SM_SLOC_BUFFER_ENTRY);
946 RECORD(SM_SLOC_BUFFER_BLOB);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +0000947 RECORD(SM_SLOC_EXPANSION_ENTRY);
Mike Stump11289f42009-09-09 15:08:12 +0000948
Chris Lattner28fa4e62009-04-26 22:26:21 +0000949 // Preprocessor Block.
Chris Lattner64031982009-04-27 00:40:25 +0000950 BLOCK(PREPROCESSOR_BLOCK);
Richard Smithec216502015-02-13 19:48:37 +0000951 RECORD(PP_MACRO_DIRECTIVE_HISTORY);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000952 RECORD(PP_MACRO_FUNCTION_LIKE);
Richard Smithd7329392015-04-21 21:46:32 +0000953 RECORD(PP_MACRO_OBJECT_LIKE);
954 RECORD(PP_MODULE_MACRO);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000955 RECORD(PP_TOKEN);
Richard Smithec216502015-02-13 19:48:37 +0000956
Douglas Gregor12bfa382009-10-17 00:13:19 +0000957 // Decls and Types block.
958 BLOCK(DECLTYPES_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000959 RECORD(TYPE_EXT_QUAL);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000960 RECORD(TYPE_COMPLEX);
961 RECORD(TYPE_POINTER);
962 RECORD(TYPE_BLOCK_POINTER);
963 RECORD(TYPE_LVALUE_REFERENCE);
964 RECORD(TYPE_RVALUE_REFERENCE);
965 RECORD(TYPE_MEMBER_POINTER);
966 RECORD(TYPE_CONSTANT_ARRAY);
967 RECORD(TYPE_INCOMPLETE_ARRAY);
968 RECORD(TYPE_VARIABLE_ARRAY);
969 RECORD(TYPE_VECTOR);
970 RECORD(TYPE_EXT_VECTOR);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000971 RECORD(TYPE_FUNCTION_NO_PROTO);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000972 RECORD(TYPE_FUNCTION_PROTO);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000973 RECORD(TYPE_TYPEDEF);
974 RECORD(TYPE_TYPEOF_EXPR);
975 RECORD(TYPE_TYPEOF);
976 RECORD(TYPE_RECORD);
977 RECORD(TYPE_ENUM);
978 RECORD(TYPE_OBJC_INTERFACE);
Steve Narofffb4330f2009-06-17 22:40:22 +0000979 RECORD(TYPE_OBJC_OBJECT_POINTER);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000980 RECORD(TYPE_DECLTYPE);
981 RECORD(TYPE_ELABORATED);
982 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
983 RECORD(TYPE_UNRESOLVED_USING);
984 RECORD(TYPE_INJECTED_CLASS_NAME);
985 RECORD(TYPE_OBJC_OBJECT);
986 RECORD(TYPE_TEMPLATE_TYPE_PARM);
987 RECORD(TYPE_TEMPLATE_SPECIALIZATION);
988 RECORD(TYPE_DEPENDENT_NAME);
989 RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION);
990 RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
991 RECORD(TYPE_PAREN);
992 RECORD(TYPE_PACK_EXPANSION);
993 RECORD(TYPE_ATTRIBUTED);
994 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000995 RECORD(TYPE_AUTO);
996 RECORD(TYPE_UNARY_TRANSFORM);
Eli Friedman0dfb8892011-10-06 23:00:33 +0000997 RECORD(TYPE_ATOMIC);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000998 RECORD(TYPE_DECAYED);
999 RECORD(TYPE_ADJUSTED);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001000 RECORD(DECL_TYPEDEF);
Richard Smith01b2cb42014-07-26 06:37:51 +00001001 RECORD(DECL_TYPEALIAS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001002 RECORD(DECL_ENUM);
1003 RECORD(DECL_RECORD);
1004 RECORD(DECL_ENUM_CONSTANT);
1005 RECORD(DECL_FUNCTION);
1006 RECORD(DECL_OBJC_METHOD);
1007 RECORD(DECL_OBJC_INTERFACE);
1008 RECORD(DECL_OBJC_PROTOCOL);
1009 RECORD(DECL_OBJC_IVAR);
1010 RECORD(DECL_OBJC_AT_DEFS_FIELD);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001011 RECORD(DECL_OBJC_CATEGORY);
1012 RECORD(DECL_OBJC_CATEGORY_IMPL);
1013 RECORD(DECL_OBJC_IMPLEMENTATION);
1014 RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
1015 RECORD(DECL_OBJC_PROPERTY);
1016 RECORD(DECL_OBJC_PROPERTY_IMPL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001017 RECORD(DECL_FIELD);
John McCall5e77d762013-04-16 07:28:30 +00001018 RECORD(DECL_MS_PROPERTY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001019 RECORD(DECL_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001020 RECORD(DECL_IMPLICIT_PARAM);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001021 RECORD(DECL_PARM_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001022 RECORD(DECL_FILE_SCOPE_ASM);
1023 RECORD(DECL_BLOCK);
1024 RECORD(DECL_CONTEXT_LEXICAL);
1025 RECORD(DECL_CONTEXT_VISIBLE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001026 RECORD(DECL_NAMESPACE);
1027 RECORD(DECL_NAMESPACE_ALIAS);
1028 RECORD(DECL_USING);
1029 RECORD(DECL_USING_SHADOW);
1030 RECORD(DECL_USING_DIRECTIVE);
1031 RECORD(DECL_UNRESOLVED_USING_VALUE);
1032 RECORD(DECL_UNRESOLVED_USING_TYPENAME);
1033 RECORD(DECL_LINKAGE_SPEC);
1034 RECORD(DECL_CXX_RECORD);
1035 RECORD(DECL_CXX_METHOD);
1036 RECORD(DECL_CXX_CONSTRUCTOR);
1037 RECORD(DECL_CXX_DESTRUCTOR);
1038 RECORD(DECL_CXX_CONVERSION);
1039 RECORD(DECL_ACCESS_SPEC);
1040 RECORD(DECL_FRIEND);
1041 RECORD(DECL_FRIEND_TEMPLATE);
1042 RECORD(DECL_CLASS_TEMPLATE);
1043 RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
1044 RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
Larisse Voufo39a1e502013-08-06 01:03:05 +00001045 RECORD(DECL_VAR_TEMPLATE);
1046 RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION);
1047 RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001048 RECORD(DECL_FUNCTION_TEMPLATE);
1049 RECORD(DECL_TEMPLATE_TYPE_PARM);
1050 RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
1051 RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
1052 RECORD(DECL_STATIC_ASSERT);
1053 RECORD(DECL_CXX_BASE_SPECIFIERS);
1054 RECORD(DECL_INDIRECTFIELD);
1055 RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
1056
Douglas Gregor03412ba2011-06-03 02:27:19 +00001057 // Statements and Exprs can occur in the Decls and Types block.
1058 AddStmtsExprs(Stream, Record);
1059
Douglas Gregor92a96f52011-02-08 21:58:10 +00001060 BLOCK(PREPROCESSOR_DETAIL_BLOCK);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001061 RECORD(PPD_MACRO_EXPANSION);
Douglas Gregor92a96f52011-02-08 21:58:10 +00001062 RECORD(PPD_MACRO_DEFINITION);
1063 RECORD(PPD_INCLUSION_DIRECTIVE);
1064
Chris Lattner28fa4e62009-04-26 22:26:21 +00001065#undef RECORD
1066#undef BLOCK
1067 Stream.ExitBlock();
1068}
1069
Richard Smith54cc3c22014-12-11 20:50:24 +00001070/// \brief Prepares a path for being written to an AST file by converting it
1071/// to an absolute path and removing nested './'s.
1072///
1073/// \return \c true if the path was changed.
Benjamin Kramer6a96ae52015-02-06 18:36:04 +00001074static bool cleanPathForOutput(FileManager &FileMgr,
1075 SmallVectorImpl<char> &Path) {
Argyrios Kyrtzidis403cbcb2015-07-31 01:39:23 +00001076 bool Changed = FileMgr.makeAbsolutePath(Path);
1077 return Changed | FileMgr.removeDotPaths(Path);
Richard Smith54cc3c22014-12-11 20:50:24 +00001078}
1079
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001080/// \brief Adjusts the given filename to only write out the portion of the
1081/// filename that is not part of the system root directory.
Mike Stump11289f42009-09-09 15:08:12 +00001082///
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001083/// \param Filename the file name to adjust.
1084///
Richard Smith7ed1bc92014-12-05 22:42:13 +00001085/// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
1086/// the returned filename will be adjusted by this root directory.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001087///
1088/// \returns either the original filename (if it needs no adjustment) or the
1089/// adjusted filename (which points into the @p Filename parameter).
Mike Stump11289f42009-09-09 15:08:12 +00001090static const char *
Richard Smith7ed1bc92014-12-05 22:42:13 +00001091adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001092 assert(Filename && "No file name to adjust?");
Mike Stump11289f42009-09-09 15:08:12 +00001093
Richard Smith7ed1bc92014-12-05 22:42:13 +00001094 if (BaseDir.empty())
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001095 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001096
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001097 // Verify that the filename and the system root have the same prefix.
1098 unsigned Pos = 0;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001099 for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1100 if (Filename[Pos] != BaseDir[Pos])
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001101 return Filename; // Prefixes don't match.
Mike Stump11289f42009-09-09 15:08:12 +00001102
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001103 // We hit the end of the filename before we hit the end of the system root.
1104 if (!Filename[Pos])
1105 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001106
Richard Smith7ed1bc92014-12-05 22:42:13 +00001107 // If there's not a path separator at the end of the base directory nor
1108 // immediately after it, then this isn't within the base directory.
1109 if (!llvm::sys::path::is_separator(Filename[Pos])) {
1110 if (!llvm::sys::path::is_separator(BaseDir.back()))
1111 return Filename;
1112 } else {
1113 // If the file name has a '/' at the current position, skip over the '/'.
1114 // We distinguish relative paths from absolute paths by the
1115 // absence of '/' at the beginning of relative paths.
1116 //
1117 // FIXME: This is wrong. We distinguish them by asking if the path is
1118 // absolute, which isn't the same thing. And there might be multiple '/'s
1119 // in a row. Use a better mechanism to indicate whether we have emitted an
1120 // absolute or relative path.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001121 ++Pos;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001122 }
Mike Stump11289f42009-09-09 15:08:12 +00001123
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001124 return Filename + Pos;
1125}
Chris Lattner28fa4e62009-04-26 22:26:21 +00001126
Ben Langmuir487ea142014-10-23 18:05:36 +00001127static ASTFileSignature getSignature() {
1128 while (1) {
1129 if (ASTFileSignature S = llvm::sys::Process::GetRandomNumber())
1130 return S;
1131 // Rely on GetRandomNumber to eventually return non-zero...
1132 }
1133}
1134
Douglas Gregor112b9072012-10-18 05:31:06 +00001135/// \brief Write the control block.
Douglas Gregor2d302362012-10-24 16:50:34 +00001136void ASTWriter::WriteControlBlock(Preprocessor &PP, ASTContext &Context,
1137 StringRef isysroot,
Douglas Gregor112b9072012-10-18 05:31:06 +00001138 const std::string &OutputFile) {
Douglas Gregorbfbde532009-04-10 21:16:55 +00001139 using namespace llvm;
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001140 Stream.EnterSubblock(CONTROL_BLOCK_ID, 5);
1141 RecordData Record;
Douglas Gregor112b9072012-10-18 05:31:06 +00001142
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001143 // Metadata
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001144 BitCodeAbbrev *MetadataAbbrev = new BitCodeAbbrev();
1145 MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA));
1146 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1147 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1148 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1149 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1150 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
Richard Smithe75ee0f2015-08-17 07:13:32 +00001151 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Timestamps
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001152 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1153 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
1154 unsigned MetadataAbbrevCode = Stream.EmitAbbrev(MetadataAbbrev);
1155 Record.push_back(METADATA);
Sebastian Redl539c5062010-08-18 23:57:32 +00001156 Record.push_back(VERSION_MAJOR);
1157 Record.push_back(VERSION_MINOR);
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001158 Record.push_back(CLANG_VERSION_MAJOR);
1159 Record.push_back(CLANG_VERSION_MINOR);
Richard Smith7ed1bc92014-12-05 22:42:13 +00001160 assert((!WritingModule || isysroot.empty()) &&
1161 "writing module as a relocatable PCH?");
Douglas Gregorc567ba22011-07-22 16:35:34 +00001162 Record.push_back(!isysroot.empty());
Richard Smithe75ee0f2015-08-17 07:13:32 +00001163 Record.push_back(IncludeTimestamps);
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00001164 Record.push_back(ASTHasCompilerErrors);
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001165 Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record,
1166 getClangFullRepositoryVersion());
Douglas Gregor29cc6422011-08-17 21:07:30 +00001167
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001168 if (WritingModule) {
Chandler Carruth885e78c2015-03-24 21:18:10 +00001169 // For implicit modules we output a signature that we can use to ensure
1170 // duplicate module builds don't collide in the cache as their output order
1171 // is non-deterministic.
1172 // FIXME: Remove this when output is deterministic.
1173 if (Context.getLangOpts().ImplicitModules) {
1174 Record.clear();
1175 Record.push_back(getSignature());
1176 Stream.EmitRecord(SIGNATURE, Record);
1177 }
1178
Richard Smith7ed1bc92014-12-05 22:42:13 +00001179 // Module name
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001180 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1181 Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME));
1182 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
1183 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1184 RecordData Record;
1185 Record.push_back(MODULE_NAME);
1186 Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name);
1187 }
1188
Richard Smith7ed1bc92014-12-05 22:42:13 +00001189 if (WritingModule && WritingModule->Directory) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001190 SmallString<128> BaseDir(WritingModule->Directory->getName());
Richard Smith54cc3c22014-12-11 20:50:24 +00001191 cleanPathForOutput(Context.getSourceManager().getFileManager(), BaseDir);
Richard Smithf7b41372015-08-13 23:47:44 +00001192
1193 // If the home of the module is the current working directory, then we
1194 // want to pick up the cwd of the build process loading the module, not
1195 // our cwd, when we load this module.
1196 if (!PP.getHeaderSearchInfo()
1197 .getHeaderSearchOpts()
1198 .ModuleMapFileHomeIsCwd ||
1199 WritingModule->Directory->getName() != StringRef(".")) {
1200 // Module directory.
1201 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1202 Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY));
1203 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
1204 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1205
1206 RecordData Record;
1207 Record.push_back(MODULE_DIRECTORY);
1208 Stream.EmitRecordWithBlob(AbbrevCode, Record, BaseDir);
1209 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001210
1211 // Write out all other paths relative to the base directory if possible.
1212 BaseDirectory.assign(BaseDir.begin(), BaseDir.end());
1213 } else if (!isysroot.empty()) {
1214 // Write out paths relative to the sysroot if possible.
1215 BaseDirectory = isysroot;
1216 }
1217
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001218 // Module map file
1219 if (WritingModule) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001220 Record.clear();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001221
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001222 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
1223
1224 // Primary module map file.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001225 AddPath(Map.getModuleMapFileForUniquing(WritingModule)->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001226
1227 // Additional module map files.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001228 if (auto *AdditionalModMaps =
1229 Map.getAdditionalModuleMapFiles(WritingModule)) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001230 Record.push_back(AdditionalModMaps->size());
1231 for (const FileEntry *F : *AdditionalModMaps)
Richard Smith7ed1bc92014-12-05 22:42:13 +00001232 AddPath(F->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001233 } else {
1234 Record.push_back(0);
1235 }
1236
1237 Stream.EmitRecord(MODULE_MAP_FILE, Record);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001238 }
1239
Douglas Gregor112b9072012-10-18 05:31:06 +00001240 // Imports
Douglas Gregor29cc6422011-08-17 21:07:30 +00001241 if (Chain) {
Douglas Gregor29cc6422011-08-17 21:07:30 +00001242 serialization::ModuleManager &Mgr = Chain->getModuleManager();
Douglas Gregor29cc6422011-08-17 21:07:30 +00001243 Record.clear();
Douglas Gregordf0c1512011-08-18 04:12:04 +00001244
Richard Smith7f330cd2015-03-18 01:42:29 +00001245 for (auto *M : Mgr) {
Douglas Gregordf0c1512011-08-18 04:12:04 +00001246 // Skip modules that weren't directly imported.
Richard Smith7f330cd2015-03-18 01:42:29 +00001247 if (!M->isDirectlyImported())
Douglas Gregordf0c1512011-08-18 04:12:04 +00001248 continue;
1249
Richard Smith7f330cd2015-03-18 01:42:29 +00001250 Record.push_back((unsigned)M->Kind); // FIXME: Stable encoding
1251 AddSourceLocation(M->ImportLoc, Record);
1252 Record.push_back(M->File->getSize());
Richard Smithe75ee0f2015-08-17 07:13:32 +00001253 Record.push_back(getTimestampForOutput(M->File));
Richard Smith7f330cd2015-03-18 01:42:29 +00001254 Record.push_back(M->Signature);
1255 AddPath(M->FileName, Record);
Douglas Gregordf0c1512011-08-18 04:12:04 +00001256 }
Douglas Gregor29cc6422011-08-17 21:07:30 +00001257 Stream.EmitRecord(IMPORTS, Record);
1258 }
Mike Stump11289f42009-09-09 15:08:12 +00001259
Douglas Gregor112b9072012-10-18 05:31:06 +00001260 // Language options.
1261 Record.clear();
1262 const LangOptions &LangOpts = Context.getLangOpts();
1263#define LANGOPT(Name, Bits, Default, Description) \
1264 Record.push_back(LangOpts.Name);
1265#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
1266 Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001267#include "clang/Basic/LangOptions.def"
1268#define SANITIZER(NAME, ID) \
1269 Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
Will Dietzf54319c2013-01-18 11:30:38 +00001270#include "clang/Basic/Sanitizers.def"
Douglas Gregor112b9072012-10-18 05:31:06 +00001271
Ben Langmuircd98cb72015-06-23 18:20:18 +00001272 Record.push_back(LangOpts.ModuleFeatures.size());
1273 for (StringRef Feature : LangOpts.ModuleFeatures)
1274 AddString(Feature, Record);
1275
Douglas Gregor112b9072012-10-18 05:31:06 +00001276 Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind());
1277 AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record);
Ben Langmuird4a667a2015-06-23 18:20:23 +00001278
1279 AddString(LangOpts.CurrentModule, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001280
1281 // Comment options.
1282 Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size());
1283 for (CommentOptions::BlockCommandNamesTy::const_iterator
1284 I = LangOpts.CommentOpts.BlockCommandNames.begin(),
1285 IEnd = LangOpts.CommentOpts.BlockCommandNames.end();
1286 I != IEnd; ++I) {
1287 AddString(*I, Record);
1288 }
Dmitri Gribenkoa7d16ce2013-04-10 15:35:17 +00001289 Record.push_back(LangOpts.CommentOpts.ParseAllComments);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001290
Douglas Gregor112b9072012-10-18 05:31:06 +00001291 Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1292
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001293 // Target options.
1294 Record.clear();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001295 const TargetInfo &Target = Context.getTargetInfo();
1296 const TargetOptions &TargetOpts = Target.getTargetOpts();
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001297 AddString(TargetOpts.Triple, Record);
1298 AddString(TargetOpts.CPU, Record);
1299 AddString(TargetOpts.ABI, Record);
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001300 Record.push_back(TargetOpts.FeaturesAsWritten.size());
1301 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1302 AddString(TargetOpts.FeaturesAsWritten[I], Record);
1303 }
1304 Record.push_back(TargetOpts.Features.size());
1305 for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1306 AddString(TargetOpts.Features[I], Record);
1307 }
1308 Stream.EmitRecord(TARGET_OPTIONS, Record);
1309
Douglas Gregor8263ffb2012-10-24 15:17:15 +00001310 // Diagnostic options.
1311 Record.clear();
1312 const DiagnosticOptions &DiagOpts
1313 = Context.getDiagnostics().getDiagnosticOptions();
1314#define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1315#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
1316 Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1317#include "clang/Basic/DiagnosticOptions.def"
1318 Record.push_back(DiagOpts.Warnings.size());
1319 for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1320 AddString(DiagOpts.Warnings[I], Record);
Richard Smith3be1cb22014-08-07 00:24:21 +00001321 Record.push_back(DiagOpts.Remarks.size());
1322 for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1323 AddString(DiagOpts.Remarks[I], Record);
Douglas Gregor8263ffb2012-10-24 15:17:15 +00001324 // Note: we don't serialize the log or serialization file names, because they
1325 // are generally transient files and will almost always be overridden.
1326 Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record);
1327
Douglas Gregorc6317db2012-10-24 15:49:58 +00001328 // File system options.
1329 Record.clear();
1330 const FileSystemOptions &FSOpts
1331 = Context.getSourceManager().getFileManager().getFileSystemOptions();
1332 AddString(FSOpts.WorkingDir, Record);
1333 Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record);
1334
Douglas Gregor2d302362012-10-24 16:50:34 +00001335 // Header search options.
1336 Record.clear();
1337 const HeaderSearchOptions &HSOpts
1338 = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1339 AddString(HSOpts.Sysroot, Record);
1340
1341 // Include entries.
1342 Record.push_back(HSOpts.UserEntries.size());
1343 for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1344 const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1345 AddString(Entry.Path, Record);
1346 Record.push_back(static_cast<unsigned>(Entry.Group));
Douglas Gregor2d302362012-10-24 16:50:34 +00001347 Record.push_back(Entry.IsFramework);
1348 Record.push_back(Entry.IgnoreSysRoot);
Douglas Gregor2d302362012-10-24 16:50:34 +00001349 }
1350
1351 // System header prefixes.
1352 Record.push_back(HSOpts.SystemHeaderPrefixes.size());
1353 for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1354 AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1355 Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1356 }
1357
1358 AddString(HSOpts.ResourceDir, Record);
1359 AddString(HSOpts.ModuleCachePath, Record);
Argyrios Kyrtzidis1594c152014-03-03 08:12:05 +00001360 AddString(HSOpts.ModuleUserBuildPath, Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001361 Record.push_back(HSOpts.DisableModuleHash);
1362 Record.push_back(HSOpts.UseBuiltinIncludes);
1363 Record.push_back(HSOpts.UseStandardSystemIncludes);
1364 Record.push_back(HSOpts.UseStandardCXXIncludes);
1365 Record.push_back(HSOpts.UseLibcxx);
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00001366 // Write out the specific module cache path that contains the module files.
1367 AddString(PP.getHeaderSearchInfo().getModuleCachePath(), Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001368 Stream.EmitRecord(HEADER_SEARCH_OPTIONS, Record);
1369
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001370 // Preprocessor options.
1371 Record.clear();
1372 const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts();
1373
1374 // Macro definitions.
1375 Record.push_back(PPOpts.Macros.size());
1376 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1377 AddString(PPOpts.Macros[I].first, Record);
1378 Record.push_back(PPOpts.Macros[I].second);
1379 }
1380
1381 // Includes
1382 Record.push_back(PPOpts.Includes.size());
1383 for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1384 AddString(PPOpts.Includes[I], Record);
1385
1386 // Macro includes
1387 Record.push_back(PPOpts.MacroIncludes.size());
1388 for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1389 AddString(PPOpts.MacroIncludes[I], Record);
1390
Douglas Gregorb6368752012-10-24 23:41:50 +00001391 Record.push_back(PPOpts.UsePredefines);
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +00001392 // Detailed record is important since it is used for the module cache hash.
1393 Record.push_back(PPOpts.DetailedRecord);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001394 AddString(PPOpts.ImplicitPCHInclude, Record);
1395 AddString(PPOpts.ImplicitPTHInclude, Record);
1396 Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1397 Stream.EmitRecord(PREPROCESSOR_OPTIONS, Record);
1398
Douglas Gregora3b20262011-05-06 21:43:30 +00001399 // Original file name and file ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001400 SourceManager &SM = Context.getSourceManager();
1401 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
1402 BitCodeAbbrev *FileAbbrev = new BitCodeAbbrev();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001403 FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE));
1404 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001405 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1406 unsigned FileAbbrevCode = Stream.EmitAbbrev(FileAbbrev);
1407
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001408 Record.clear();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001409 Record.push_back(ORIGINAL_FILE);
Douglas Gregora3b20262011-05-06 21:43:30 +00001410 Record.push_back(SM.getMainFileID().getOpaqueValue());
Richard Smith7ed1bc92014-12-05 22:42:13 +00001411 EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName());
Douglas Gregor45fe0362009-05-12 01:31:05 +00001412 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001413
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001414 Record.clear();
1415 Record.push_back(SM.getMainFileID().getOpaqueValue());
1416 Stream.EmitRecord(ORIGINAL_FILE_ID, Record);
1417
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001418 // Original PCH directory
1419 if (!OutputFile.empty() && OutputFile != "-") {
1420 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1421 Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR));
1422 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1423 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1424
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001425 SmallString<128> OutputPath(OutputFile);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001426
Argyrios Kyrtzidisc56419e2015-07-31 00:58:32 +00001427 SM.getFileManager().makeAbsolutePath(OutputPath);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001428 StringRef origDir = llvm::sys::path::parent_path(OutputPath);
1429
1430 RecordData Record;
1431 Record.push_back(ORIGINAL_PCH_DIR);
1432 Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir);
1433 }
1434
Douglas Gregor49491f72013-03-15 22:15:07 +00001435 WriteInputFiles(Context.SourceMgr,
1436 PP.getHeaderSearchInfo().getHeaderSearchOpts(),
Douglas Gregora3dd9002013-07-22 20:48:33 +00001437 PP.getLangOpts().Modules);
Douglas Gregor72be3902012-10-19 00:38:02 +00001438 Stream.ExitBlock();
1439}
1440
Douglas Gregor49491f72013-03-15 22:15:07 +00001441namespace {
1442 /// \brief An input file.
1443 struct InputFileEntry {
1444 const FileEntry *File;
1445 bool IsSystemFile;
1446 bool BufferOverridden;
1447 };
1448}
1449
1450void ASTWriter::WriteInputFiles(SourceManager &SourceMgr,
1451 HeaderSearchOptions &HSOpts,
Douglas Gregora3dd9002013-07-22 20:48:33 +00001452 bool Modules) {
Douglas Gregor72be3902012-10-19 00:38:02 +00001453 using namespace llvm;
1454 Stream.EnterSubblock(INPUT_FILES_BLOCK_ID, 4);
1455 RecordData Record;
1456
1457 // Create input-file abbreviation.
1458 BitCodeAbbrev *IFAbbrev = new BitCodeAbbrev();
1459 IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001460 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor72be3902012-10-19 00:38:02 +00001461 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1462 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001463 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
Douglas Gregor72be3902012-10-19 00:38:02 +00001464 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1465 unsigned IFAbbrevCode = Stream.EmitAbbrev(IFAbbrev);
1466
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001467 // Get all ContentCache objects for files, sorted by whether the file is a
1468 // system one or not. System files go at the back, users files at the front.
Douglas Gregor49491f72013-03-15 22:15:07 +00001469 std::deque<InputFileEntry> SortedFiles;
Douglas Gregor72be3902012-10-19 00:38:02 +00001470 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
1471 // Get this source location entry.
1472 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
NAKAMURA Takumideca50f2012-10-19 01:53:57 +00001473 assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc);
Douglas Gregor72be3902012-10-19 00:38:02 +00001474
1475 // We only care about file entries that were not overridden.
1476 if (!SLoc->isFile())
1477 continue;
1478 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001479 if (!Cache->OrigEntry)
Douglas Gregor72be3902012-10-19 00:38:02 +00001480 continue;
1481
Douglas Gregor49491f72013-03-15 22:15:07 +00001482 InputFileEntry Entry;
1483 Entry.File = Cache->OrigEntry;
1484 Entry.IsSystemFile = Cache->IsSystemFile;
1485 Entry.BufferOverridden = Cache->BufferOverridden;
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001486 if (Cache->IsSystemFile)
Douglas Gregor49491f72013-03-15 22:15:07 +00001487 SortedFiles.push_back(Entry);
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001488 else
Douglas Gregor49491f72013-03-15 22:15:07 +00001489 SortedFiles.push_front(Entry);
1490 }
1491
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001492 unsigned UserFilesNum = 0;
1493 // Write out all of the input files.
Richard Smithec216502015-02-13 19:48:37 +00001494 std::vector<uint64_t> InputFileOffsets;
Douglas Gregor49491f72013-03-15 22:15:07 +00001495 for (std::deque<InputFileEntry>::iterator
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001496 I = SortedFiles.begin(), E = SortedFiles.end(); I != E; ++I) {
Douglas Gregor49491f72013-03-15 22:15:07 +00001497 const InputFileEntry &Entry = *I;
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001498
Douglas Gregor49491f72013-03-15 22:15:07 +00001499 uint32_t &InputFileID = InputFileIDs[Entry.File];
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001500 if (InputFileID != 0)
1501 continue; // already recorded this file.
1502
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001503 // Record this entry's offset.
1504 InputFileOffsets.push_back(Stream.GetCurrentBitNo());
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001505
1506 InputFileID = InputFileOffsets.size();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001507
Douglas Gregor49491f72013-03-15 22:15:07 +00001508 if (!Entry.IsSystemFile)
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001509 ++UserFilesNum;
1510
Douglas Gregor72be3902012-10-19 00:38:02 +00001511 Record.clear();
1512 Record.push_back(INPUT_FILE);
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001513 Record.push_back(InputFileOffsets.size());
Douglas Gregor72be3902012-10-19 00:38:02 +00001514
1515 // Emit size/modification time for this file.
Douglas Gregor49491f72013-03-15 22:15:07 +00001516 Record.push_back(Entry.File->getSize());
Richard Smithe75ee0f2015-08-17 07:13:32 +00001517 Record.push_back(getTimestampForOutput(Entry.File));
Douglas Gregor72be3902012-10-19 00:38:02 +00001518
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001519 // Whether this file was overridden.
Douglas Gregor49491f72013-03-15 22:15:07 +00001520 Record.push_back(Entry.BufferOverridden);
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001521
Richard Smith7ed1bc92014-12-05 22:42:13 +00001522 EmitRecordWithPath(IFAbbrevCode, Record, Entry.File->getName());
1523 }
Douglas Gregor49491f72013-03-15 22:15:07 +00001524
Douglas Gregor112b9072012-10-18 05:31:06 +00001525 Stream.ExitBlock();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001526
1527 // Create input file offsets abbreviation.
1528 BitCodeAbbrev *OffsetsAbbrev = new BitCodeAbbrev();
1529 OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1530 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001531 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1532 // input files
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001533 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Array
1534 unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(OffsetsAbbrev);
1535
1536 // Write input file offsets.
1537 Record.clear();
1538 Record.push_back(INPUT_FILE_OFFSETS);
1539 Record.push_back(InputFileOffsets.size());
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001540 Record.push_back(UserFilesNum);
Reid Kleckner012665e2015-05-21 00:13:09 +00001541 Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, bytes(InputFileOffsets));
Douglas Gregor55abb232009-04-10 20:39:37 +00001542}
1543
Douglas Gregora7f71a92009-04-10 03:52:48 +00001544//===----------------------------------------------------------------------===//
1545// Source Manager Serialization
1546//===----------------------------------------------------------------------===//
1547
1548/// \brief Create an abbreviation for the SLocEntry that refers to a
1549/// file.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001550static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001551 using namespace llvm;
1552 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001553 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001554 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1555 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1556 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1557 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
Douglas Gregorb41ca8f2010-03-21 22:49:54 +00001558 // FileEntry fields.
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001559 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001560 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001561 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
1562 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
Douglas Gregor8f45df52009-04-16 22:23:12 +00001563 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001564}
1565
1566/// \brief Create an abbreviation for the SLocEntry that refers to a
1567/// buffer.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001568static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001569 using namespace llvm;
1570 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001571 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001572 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1573 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1574 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1575 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1576 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
Douglas Gregor8f45df52009-04-16 22:23:12 +00001577 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001578}
1579
1580/// \brief Create an abbreviation for the SLocEntry that refers to a
1581/// buffer's blob.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001582static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001583 using namespace llvm;
1584 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001585 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_BLOB));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001586 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
Douglas Gregor8f45df52009-04-16 22:23:12 +00001587 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001588}
1589
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001590/// \brief Create an abbreviation for the SLocEntry that refers to a macro
1591/// expansion.
1592static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001593 using namespace llvm;
1594 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001595 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001596 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1597 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1598 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1599 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
Douglas Gregor83243272009-04-15 18:05:10 +00001600 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
Douglas Gregor8f45df52009-04-16 22:23:12 +00001601 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001602}
1603
Douglas Gregor09b69892011-02-10 17:09:37 +00001604namespace {
1605 // Trait used for the on-disk hash table of header search information.
1606 class HeaderFileInfoTrait {
1607 ASTWriter &Writer;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001608 const HeaderSearch &HS;
Douglas Gregor09b69892011-02-10 17:09:37 +00001609
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001610 // Keep track of the framework names we've used during serialization.
1611 SmallVector<char, 128> FrameworkStringData;
1612 llvm::StringMap<unsigned> FrameworkNameOffset;
1613
Douglas Gregor09b69892011-02-10 17:09:37 +00001614 public:
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001615 HeaderFileInfoTrait(ASTWriter &Writer, const HeaderSearch &HS)
1616 : Writer(Writer), HS(HS) { }
Douglas Gregor09b69892011-02-10 17:09:37 +00001617
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001618 struct key_type {
1619 const FileEntry *FE;
1620 const char *Filename;
1621 };
1622 typedef const key_type &key_type_ref;
Douglas Gregor09b69892011-02-10 17:09:37 +00001623
1624 typedef HeaderFileInfo data_type;
1625 typedef const data_type &data_type_ref;
Justin Bogner25463f12014-04-18 20:27:24 +00001626 typedef unsigned hash_value_type;
1627 typedef unsigned offset_type;
Douglas Gregor09b69892011-02-10 17:09:37 +00001628
Richard Smithe75ee0f2015-08-17 07:13:32 +00001629 hash_value_type ComputeHash(key_type_ref key) {
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001630 // The hash is based only on size/time of the file, so that the reader can
1631 // match even when symlinking or excess path elements ("foo/../", "../")
1632 // change the form of the name. However, complete path is still the key.
1633 return llvm::hash_combine(key.FE->getSize(),
Richard Smithe75ee0f2015-08-17 07:13:32 +00001634 Writer.getTimestampForOutput(key.FE));
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;
Richard Smith386bb072015-08-18 23:42:23 +00001640 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001641 unsigned KeyLen = strlen(key.Filename) + 1 + 8 + 8;
Richard Smith386bb072015-08-18 23:42:23 +00001642 LE.write<uint16_t>(KeyLen);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001643 unsigned DataLen = 1 + 2 + 4 + 4;
Richard Smith386bb072015-08-18 23:42:23 +00001644 for (auto ModInfo : HS.getModuleMap().findAllModulesForHeader(key.FE))
1645 if (Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule()))
1646 DataLen += 4;
1647 LE.write<uint8_t>(DataLen);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001648 return std::make_pair(KeyLen, DataLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001649 }
1650
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001651 void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001652 using namespace llvm::support;
1653 endian::Writer<little> LE(Out);
1654 LE.write<uint64_t>(key.FE->getSize());
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001655 KeyLen -= 8;
Richard Smithe75ee0f2015-08-17 07:13:32 +00001656 LE.write<uint64_t>(Writer.getTimestampForOutput(key.FE));
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001657 KeyLen -= 8;
1658 Out.write(key.Filename, KeyLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001659 }
1660
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001661 void EmitData(raw_ostream &Out, key_type_ref key,
Douglas Gregor09b69892011-02-10 17:09:37 +00001662 data_type_ref Data, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001663 using namespace llvm::support;
1664 endian::Writer<little> LE(Out);
Douglas Gregor09b69892011-02-10 17:09:37 +00001665 uint64_t Start = Out.tell(); (void)Start;
1666
Richard Smith386bb072015-08-18 23:42:23 +00001667 unsigned char Flags = (Data.isImport << 4)
1668 | (Data.isPragmaOnce << 3)
1669 | (Data.DirInfo << 1)
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001670 | Data.IndexHeaderMapHeader;
Justin Bognere1c147c2014-03-28 22:03:19 +00001671 LE.write<uint8_t>(Flags);
1672 LE.write<uint16_t>(Data.NumIncludes);
Douglas Gregor09b69892011-02-10 17:09:37 +00001673
1674 if (!Data.ControllingMacro)
Justin Bognere1c147c2014-03-28 22:03:19 +00001675 LE.write<uint32_t>(Data.ControllingMacroID);
Douglas Gregor09b69892011-02-10 17:09:37 +00001676 else
Justin Bognere1c147c2014-03-28 22:03:19 +00001677 LE.write<uint32_t>(Writer.getIdentifierRef(Data.ControllingMacro));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001678
1679 unsigned Offset = 0;
1680 if (!Data.Framework.empty()) {
1681 // If this header refers into a framework, save the framework name.
1682 llvm::StringMap<unsigned>::iterator Pos
1683 = FrameworkNameOffset.find(Data.Framework);
1684 if (Pos == FrameworkNameOffset.end()) {
1685 Offset = FrameworkStringData.size() + 1;
1686 FrameworkStringData.append(Data.Framework.begin(),
1687 Data.Framework.end());
1688 FrameworkStringData.push_back(0);
1689
1690 FrameworkNameOffset[Data.Framework] = Offset;
1691 } else
1692 Offset = Pos->second;
1693 }
Justin Bognere1c147c2014-03-28 22:03:19 +00001694 LE.write<uint32_t>(Offset);
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001695
Richard Smith386bb072015-08-18 23:42:23 +00001696 // FIXME: If the header is excluded, we should write out some
1697 // record of that fact.
1698 for (auto ModInfo : HS.getModuleMap().findAllModulesForHeader(key.FE)) {
1699 if (uint32_t ModID =
1700 Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule())) {
1701 uint32_t Value = (ModID << 2) | (unsigned)ModInfo.getRole();
1702 assert((Value >> 2) == ModID && "overflow in header module info");
1703 LE.write<uint32_t>(Value);
1704 }
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001705 }
1706
Douglas Gregor09b69892011-02-10 17:09:37 +00001707 assert(Out.tell() - Start == DataLen && "Wrong data length");
1708 }
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001709
1710 const char *strings_begin() const { return FrameworkStringData.begin(); }
1711 const char *strings_end() const { return FrameworkStringData.end(); }
Douglas Gregor09b69892011-02-10 17:09:37 +00001712 };
1713} // end anonymous namespace
1714
1715/// \brief Write the header search block for the list of files that
1716///
1717/// \param HS The header search structure to save.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001718void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001719 SmallVector<const FileEntry *, 16> FilesByUID;
Douglas Gregor09b69892011-02-10 17:09:37 +00001720 HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
1721
1722 if (FilesByUID.size() > HS.header_file_size())
1723 FilesByUID.resize(HS.header_file_size());
1724
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001725 HeaderFileInfoTrait GeneratorTrait(*this, HS);
Justin Bognerbb094f02014-04-18 19:57:06 +00001726 llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001727 SmallVector<const char *, 4> SavedStrings;
Douglas Gregor09b69892011-02-10 17:09:37 +00001728 unsigned NumHeaderSearchEntries = 0;
1729 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
1730 const FileEntry *File = FilesByUID[UID];
1731 if (!File)
1732 continue;
1733
Richard Smith386bb072015-08-18 23:42:23 +00001734 // Get the file info. This will load info from the external source if
1735 // necessary. Skip emitting this file if we have no information on it
1736 // as a header file (in which case HFI will be null) or if it hasn't
1737 // changed since it was loaded. Also skip it if it's for a modular header
1738 // from a different module; in that case, we rely on the module(s)
1739 // containing the header to provide this information.
1740 const HeaderFileInfo *HFI = HS.getExistingFileInfo(File);
1741 if (!HFI || (HFI->External && Chain) ||
1742 (HFI->isModuleHeader && !HFI->isCompilingModuleHeader))
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +00001743 continue;
Douglas Gregor09b69892011-02-10 17:09:37 +00001744
Richard Smith7ed1bc92014-12-05 22:42:13 +00001745 // Massage the file path into an appropriate form.
Douglas Gregor09b69892011-02-10 17:09:37 +00001746 const char *Filename = File->getName();
Richard Smith7ed1bc92014-12-05 22:42:13 +00001747 SmallString<128> FilenameTmp(Filename);
1748 if (PreparePathForOutput(FilenameTmp)) {
1749 // If we performed any translation on the file name at all, we need to
1750 // save this string, since the generator will refer to it later.
1751 Filename = strdup(FilenameTmp.c_str());
Douglas Gregor09b69892011-02-10 17:09:37 +00001752 SavedStrings.push_back(Filename);
1753 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001754
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001755 HeaderFileInfoTrait::key_type key = { File, Filename };
Richard Smith386bb072015-08-18 23:42:23 +00001756 Generator.insert(key, *HFI, GeneratorTrait);
Douglas Gregor09b69892011-02-10 17:09:37 +00001757 ++NumHeaderSearchEntries;
1758 }
1759
1760 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001761 SmallString<4096> TableData;
Douglas Gregor09b69892011-02-10 17:09:37 +00001762 uint32_t BucketOffset;
1763 {
Justin Bognere1c147c2014-03-28 22:03:19 +00001764 using namespace llvm::support;
Douglas Gregor09b69892011-02-10 17:09:37 +00001765 llvm::raw_svector_ostream Out(TableData);
1766 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00001767 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregor09b69892011-02-10 17:09:37 +00001768 BucketOffset = Generator.Emit(Out, GeneratorTrait);
1769 }
1770
1771 // Create a blob abbreviation
1772 using namespace llvm;
1773 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
1774 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
1775 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1776 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001777 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor09b69892011-02-10 17:09:37 +00001778 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1779 unsigned TableAbbrev = Stream.EmitAbbrev(Abbrev);
1780
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001781 // Write the header search table
Douglas Gregor09b69892011-02-10 17:09:37 +00001782 RecordData Record;
1783 Record.push_back(HEADER_SEARCH_TABLE);
1784 Record.push_back(BucketOffset);
1785 Record.push_back(NumHeaderSearchEntries);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001786 Record.push_back(TableData.size());
1787 TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end());
Yaron Keren92e1b622015-03-18 10:17:07 +00001788 Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData);
Douglas Gregor09b69892011-02-10 17:09:37 +00001789
1790 // Free all of the strings we had to duplicate.
1791 for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
David Greenebae0e352013-01-15 22:09:43 +00001792 free(const_cast<char *>(SavedStrings[I]));
Douglas Gregor09b69892011-02-10 17:09:37 +00001793}
1794
Douglas Gregora7f71a92009-04-10 03:52:48 +00001795/// \brief Writes the block containing the serialized form of the
1796/// source manager.
1797///
1798/// TODO: We should probably use an on-disk hash table (stored in a
1799/// blob), indexed based on the file name, so that we only create
1800/// entries for files that we actually need. In the common case (no
1801/// errors), we probably won't have to create file entries for any of
1802/// the files in the AST.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00001803void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
Richard Smith7ed1bc92014-12-05 22:42:13 +00001804 const Preprocessor &PP) {
Douglas Gregor258ae542009-04-27 06:38:32 +00001805 RecordData Record;
1806
Chris Lattner0910e3b2009-04-10 17:16:57 +00001807 // Enter the source manager block.
Sebastian Redl539c5062010-08-18 23:57:32 +00001808 Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 3);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001809
1810 // Abbreviations for the various kinds of source-location entries.
Chris Lattnerc4976c732009-04-27 19:03:22 +00001811 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
1812 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
1813 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001814 unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001815
Douglas Gregor258ae542009-04-27 06:38:32 +00001816 // Write out the source location entry table. We skip the first
1817 // entry, which is always the same dummy entry.
Chris Lattner12d61d32009-04-27 19:01:47 +00001818 std::vector<uint32_t> SLocEntryOffsets;
Douglas Gregor258ae542009-04-27 06:38:32 +00001819 RecordData PreloadSLocs;
Douglas Gregor925296b2011-07-19 16:10:42 +00001820 SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1);
1821 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
Sebastian Redl5c415f32010-07-22 17:01:13 +00001822 I != N; ++I) {
Douglas Gregor8655e882009-10-16 22:46:09 +00001823 // Get this source location entry.
Douglas Gregor925296b2011-07-19 16:10:42 +00001824 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00001825 FileID FID = FileID::get(I);
1826 assert(&SourceMgr.getSLocEntry(FID) == SLoc);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001827
Douglas Gregor258ae542009-04-27 06:38:32 +00001828 // Record the offset of this source-location entry.
1829 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
1830
1831 // Figure out which record code to use.
1832 unsigned Code;
1833 if (SLoc->isFile()) {
Douglas Gregor9dc32122011-11-16 20:05:18 +00001834 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
1835 if (Cache->OrigEntry) {
Sebastian Redl539c5062010-08-18 23:57:32 +00001836 Code = SM_SLOC_FILE_ENTRY;
Argyrios Kyrtzidis92dd4662011-06-02 20:01:46 +00001837 } else
Sebastian Redl539c5062010-08-18 23:57:32 +00001838 Code = SM_SLOC_BUFFER_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00001839 } else
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001840 Code = SM_SLOC_EXPANSION_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00001841 Record.clear();
1842 Record.push_back(Code);
1843
Douglas Gregor925296b2011-07-19 16:10:42 +00001844 // Starting offset of this entry within this module, so skip the dummy.
1845 Record.push_back(SLoc->getOffset() - 2);
Douglas Gregor258ae542009-04-27 06:38:32 +00001846 if (SLoc->isFile()) {
1847 const SrcMgr::FileInfo &File = SLoc->getFile();
1848 Record.push_back(File.getIncludeLoc().getRawEncoding());
1849 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
1850 Record.push_back(File.hasLineDirectives());
1851
1852 const SrcMgr::ContentCache *Content = File.getContentCache();
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00001853 if (Content->OrigEntry) {
1854 assert(Content->OrigEntry == Content->ContentsEntry &&
Douglas Gregor9dc32122011-11-16 20:05:18 +00001855 "Writing to AST an overridden file is not supported");
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00001856
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001857 // The source location entry is a file. Emit input file ID.
1858 assert(InputFileIDs[Content->OrigEntry] != 0 && "Missed file entry");
1859 Record.push_back(InputFileIDs[Content->OrigEntry]);
Mike Stump11289f42009-09-09 15:08:12 +00001860
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001861 Record.push_back(File.NumCreatedFIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001862
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00001863 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001864 if (FDI != FileDeclIDs.end()) {
1865 Record.push_back(FDI->second->FirstDeclIndex);
1866 Record.push_back(FDI->second->DeclIDs.size());
1867 } else {
1868 Record.push_back(0);
1869 Record.push_back(0);
1870 }
Douglas Gregor9dc32122011-11-16 20:05:18 +00001871
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001872 Stream.EmitRecordWithAbbrev(SLocFileAbbrv, Record);
Douglas Gregor9dc32122011-11-16 20:05:18 +00001873
1874 if (Content->BufferOverridden) {
1875 Record.clear();
1876 Record.push_back(SM_SLOC_BUFFER_BLOB);
1877 const llvm::MemoryBuffer *Buffer
1878 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
1879 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record,
1880 StringRef(Buffer->getBufferStart(),
1881 Buffer->getBufferSize() + 1));
1882 }
Douglas Gregor258ae542009-04-27 06:38:32 +00001883 } else {
1884 // The source location entry is a buffer. The blob associated
1885 // with this entry contains the contents of the buffer.
1886
1887 // We add one to the size so that we capture the trailing NULL
1888 // that is required by llvm::MemoryBuffer::getMemBuffer (on
1889 // the reader side).
Douglas Gregor874cc622010-03-16 00:35:39 +00001890 const llvm::MemoryBuffer *Buffer
Chris Lattnerfb24a3a2010-04-20 20:35:58 +00001891 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
Douglas Gregor258ae542009-04-27 06:38:32 +00001892 const char *Name = Buffer->getBufferIdentifier();
Daniel Dunbar8100d012009-08-24 09:31:37 +00001893 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001894 StringRef(Name, strlen(Name) + 1));
Douglas Gregor258ae542009-04-27 06:38:32 +00001895 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00001896 Record.push_back(SM_SLOC_BUFFER_BLOB);
Douglas Gregor258ae542009-04-27 06:38:32 +00001897 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001898 StringRef(Buffer->getBufferStart(),
Daniel Dunbar8100d012009-08-24 09:31:37 +00001899 Buffer->getBufferSize() + 1));
Douglas Gregor258ae542009-04-27 06:38:32 +00001900
Douglas Gregor925296b2011-07-19 16:10:42 +00001901 if (strcmp(Name, "<built-in>") == 0) {
1902 PreloadSLocs.push_back(SLocEntryOffsets.size());
1903 }
Douglas Gregor258ae542009-04-27 06:38:32 +00001904 }
1905 } else {
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001906 // The source location entry is a macro expansion.
Chandler Carruthee4c1d12011-07-26 04:56:51 +00001907 const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
Chandler Carruth73ee5d72011-07-26 04:41:47 +00001908 Record.push_back(Expansion.getSpellingLoc().getRawEncoding());
1909 Record.push_back(Expansion.getExpansionLocStart().getRawEncoding());
Argyrios Kyrtzidisa1d943a2011-08-17 00:31:14 +00001910 Record.push_back(Expansion.isMacroArgExpansion() ? 0
1911 : Expansion.getExpansionLocEnd().getRawEncoding());
Douglas Gregor258ae542009-04-27 06:38:32 +00001912
1913 // Compute the token length for this macro expansion.
Douglas Gregor925296b2011-07-19 16:10:42 +00001914 unsigned NextOffset = SourceMgr.getNextLocalOffset();
Douglas Gregor8655e882009-10-16 22:46:09 +00001915 if (I + 1 != N)
Douglas Gregor925296b2011-07-19 16:10:42 +00001916 NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset();
Douglas Gregor258ae542009-04-27 06:38:32 +00001917 Record.push_back(NextOffset - SLoc->getOffset() - 1);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001918 Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00001919 }
1920 }
1921
Douglas Gregor8f45df52009-04-16 22:23:12 +00001922 Stream.ExitBlock();
Douglas Gregor258ae542009-04-27 06:38:32 +00001923
1924 if (SLocEntryOffsets.empty())
1925 return;
1926
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00001927 // Write the source-location offsets table into the AST block. This
Douglas Gregor258ae542009-04-27 06:38:32 +00001928 // table is used for lazily loading source-location information.
1929 using namespace llvm;
1930 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001931 Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
Douglas Gregor258ae542009-04-27 06:38:32 +00001932 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
Douglas Gregor925296b2011-07-19 16:10:42 +00001933 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
Douglas Gregor258ae542009-04-27 06:38:32 +00001934 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
1935 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(Abbrev);
Mike Stump11289f42009-09-09 15:08:12 +00001936
Douglas Gregor258ae542009-04-27 06:38:32 +00001937 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00001938 Record.push_back(SOURCE_LOCATION_OFFSETS);
Douglas Gregor258ae542009-04-27 06:38:32 +00001939 Record.push_back(SLocEntryOffsets.size());
Douglas Gregor925296b2011-07-19 16:10:42 +00001940 Record.push_back(SourceMgr.getNextLocalOffset() - 1); // skip dummy
Reid Kleckner012665e2015-05-21 00:13:09 +00001941 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record, bytes(SLocEntryOffsets));
Douglas Gregor258ae542009-04-27 06:38:32 +00001942
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00001943 // Write the source location entry preloads array, telling the AST
Douglas Gregor258ae542009-04-27 06:38:32 +00001944 // reader which source locations entries it should load eagerly.
Sebastian Redl539c5062010-08-18 23:57:32 +00001945 Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
Douglas Gregor925296b2011-07-19 16:10:42 +00001946
1947 // Write the line table. It depends on remapping working, so it must come
1948 // after the source location offsets.
1949 if (SourceMgr.hasLineTable()) {
1950 LineTableInfo &LineTable = SourceMgr.getLineTable();
1951
1952 Record.clear();
Richard Smith7ed1bc92014-12-05 22:42:13 +00001953 // Emit the file names.
Douglas Gregor925296b2011-07-19 16:10:42 +00001954 Record.push_back(LineTable.getNumFilenames());
Richard Smith7ed1bc92014-12-05 22:42:13 +00001955 for (unsigned I = 0, N = LineTable.getNumFilenames(); I != N; ++I)
1956 AddPath(LineTable.getFilename(I), Record);
Douglas Gregor925296b2011-07-19 16:10:42 +00001957
1958 // Emit the line entries
1959 for (LineTableInfo::iterator L = LineTable.begin(), LEnd = LineTable.end();
1960 L != LEnd; ++L) {
1961 // Only emit entries for local files.
Douglas Gregor02c2dbf2012-06-08 16:40:28 +00001962 if (L->first.ID < 0)
Douglas Gregor925296b2011-07-19 16:10:42 +00001963 continue;
1964
1965 // Emit the file ID
Douglas Gregor02c2dbf2012-06-08 16:40:28 +00001966 Record.push_back(L->first.ID);
Douglas Gregor925296b2011-07-19 16:10:42 +00001967
1968 // Emit the line entries
1969 Record.push_back(L->second.size());
1970 for (std::vector<LineEntry>::iterator LE = L->second.begin(),
1971 LEEnd = L->second.end();
1972 LE != LEEnd; ++LE) {
1973 Record.push_back(LE->FileOffset);
1974 Record.push_back(LE->LineNo);
1975 Record.push_back(LE->FilenameID);
1976 Record.push_back((unsigned)LE->FileKind);
1977 Record.push_back(LE->IncludeOffset);
1978 }
1979 }
1980 Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record);
1981 }
Douglas Gregora7f71a92009-04-10 03:52:48 +00001982}
1983
Douglas Gregorc5046832009-04-27 18:38:38 +00001984//===----------------------------------------------------------------------===//
1985// Preprocessor Serialization
1986//===----------------------------------------------------------------------===//
1987
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00001988static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule,
1989 const Preprocessor &PP) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00001990 if (MacroInfo *MI = MD->getMacroInfo())
1991 if (MI->isBuiltinMacro())
1992 return true;
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00001993
1994 if (IsModule) {
1995 SourceLocation Loc = MD->getLocation();
1996 if (Loc.isInvalid())
1997 return true;
1998 if (PP.getSourceManager().getFileID(Loc) == PP.getPredefinesFileID())
1999 return true;
2000 }
2001
2002 return false;
2003}
2004
Chris Lattnereeffaef2009-04-10 17:15:23 +00002005/// \brief Writes the block containing the serialized form of the
2006/// preprocessor.
2007///
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00002008void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002009 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
2010 if (PPRec)
2011 WritePreprocessorDetail(*PPRec);
2012
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002013 RecordData Record;
Richard Smithd7329392015-04-21 21:46:32 +00002014 RecordData ModuleMacroRecord;
Chris Lattner0910e3b2009-04-10 17:16:57 +00002015
Chris Lattner0af3ba12009-04-13 01:29:17 +00002016 // If the preprocessor __COUNTER__ value has been bumped, remember it.
2017 if (PP.getCounterValue() != 0) {
2018 Record.push_back(PP.getCounterValue());
Sebastian Redl539c5062010-08-18 23:57:32 +00002019 Stream.EmitRecord(PP_COUNTER_VALUE, Record);
Chris Lattner0af3ba12009-04-13 01:29:17 +00002020 Record.clear();
Douglas Gregoreda6a892009-04-26 00:07:37 +00002021 }
2022
2023 // Enter the preprocessor block.
Douglas Gregor796d76a2010-10-20 22:00:55 +00002024 Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +00002025
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002026 // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
Douglas Gregoreda6a892009-04-26 00:07:37 +00002027 // FIXME: use diagnostics subsystem for localization etc.
2028 if (PP.SawDateOrTime())
2029 fprintf(stderr, "warning: precompiled header used __DATE__ or __TIME__.\n");
Mike Stump11289f42009-09-09 15:08:12 +00002030
Douglas Gregor796d76a2010-10-20 22:00:55 +00002031
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002032 // Loop over all the macro directives that are live at the end of the file,
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002033 // emitting each to the PP section.
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002034
Richard Smithee977932015-05-01 21:22:17 +00002035 // Construct the list of identifiers with macro directives that need to be
2036 // serialized.
2037 SmallVector<const IdentifierInfo *, 128> MacroIdentifiers;
2038 for (auto &Id : PP.getIdentifierTable())
2039 if (Id.second->hadMacroDefinition() &&
2040 (!Id.second->isFromAST() ||
2041 Id.second->hasChangedSinceDeserialization()))
2042 MacroIdentifiers.push_back(Id.second);
Douglas Gregor2e5571d2011-02-10 18:20:09 +00002043 // Sort the set of macro definitions that need to be serialized by the
2044 // name of the macro, to provide a stable ordering.
Richard Smithee977932015-05-01 21:22:17 +00002045 std::sort(MacroIdentifiers.begin(), MacroIdentifiers.end(),
2046 llvm::less_ptr<IdentifierInfo>());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002047
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002048 // Emit the macro directives as a list and associate the offset with the
2049 // identifier they belong to.
Richard Smithee977932015-05-01 21:22:17 +00002050 for (const IdentifierInfo *Name : MacroIdentifiers) {
2051 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(Name);
Richard Smithd7329392015-04-21 21:46:32 +00002052 auto StartOffset = Stream.GetCurrentBitNo();
2053
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002054 // Emit the macro directives in reverse source order.
2055 for (; MD; MD = MD->getPrevious()) {
Richard Smithd7329392015-04-21 21:46:32 +00002056 // Once we hit an ignored macro, we're done: the rest of the chain
2057 // will all be ignored macros.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002058 if (shouldIgnoreMacro(MD, IsModule, PP))
Richard Smithd7329392015-04-21 21:46:32 +00002059 break;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002060
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002061 AddSourceLocation(MD->getLocation(), Record);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002062 Record.push_back(MD->getKind());
Richard Smithdaa69e02014-07-25 04:40:03 +00002063 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
Richard Smith3981b172015-04-30 02:16:23 +00002064 Record.push_back(getMacroRef(DefMD->getInfo(), Name));
Richard Smith713369b2015-04-23 20:40:50 +00002065 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002066 Record.push_back(VisMD->isPublic());
2067 }
Richard Smithb8b2ed62015-04-23 18:18:26 +00002068 }
Richard Smithd7329392015-04-21 21:46:32 +00002069
Richard Smithb8b2ed62015-04-23 18:18:26 +00002070 // Write out any exported module macros.
Richard Smithee977932015-05-01 21:22:17 +00002071 bool EmittedModuleMacros = false;
Richard Smithb8b2ed62015-04-23 18:18:26 +00002072 if (IsModule) {
2073 auto Leafs = PP.getLeafModuleMacros(Name);
2074 SmallVector<ModuleMacro*, 8> Worklist(Leafs.begin(), Leafs.end());
2075 llvm::DenseMap<ModuleMacro*, unsigned> Visits;
2076 while (!Worklist.empty()) {
2077 auto *Macro = Worklist.pop_back_val();
Richard Smithd7329392015-04-21 21:46:32 +00002078
Richard Smithb8b2ed62015-04-23 18:18:26 +00002079 // Emit a record indicating this submodule exports this macro.
2080 ModuleMacroRecord.push_back(
2081 getSubmoduleID(Macro->getOwningModule()));
Richard Smithee977932015-05-01 21:22:17 +00002082 ModuleMacroRecord.push_back(getMacroRef(Macro->getMacroInfo(), Name));
Richard Smithb8b2ed62015-04-23 18:18:26 +00002083 for (auto *M : Macro->overrides())
2084 ModuleMacroRecord.push_back(getSubmoduleID(M->getOwningModule()));
Richard Smithd7329392015-04-21 21:46:32 +00002085
Richard Smithb8b2ed62015-04-23 18:18:26 +00002086 Stream.EmitRecord(PP_MODULE_MACRO, ModuleMacroRecord);
2087 ModuleMacroRecord.clear();
Richard Smithd7329392015-04-21 21:46:32 +00002088
Richard Smithb8b2ed62015-04-23 18:18:26 +00002089 // Enqueue overridden macros once we've visited all their ancestors.
2090 for (auto *M : Macro->overrides())
2091 if (++Visits[M] == M->getNumOverridingMacros())
2092 Worklist.push_back(M);
Richard Smithee977932015-05-01 21:22:17 +00002093
2094 EmittedModuleMacros = true;
Richard Smithd7329392015-04-21 21:46:32 +00002095 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002096 }
Richard Smithd7329392015-04-21 21:46:32 +00002097
Richard Smithee977932015-05-01 21:22:17 +00002098 if (Record.empty() && !EmittedModuleMacros)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002099 continue;
2100
Richard Smithd7329392015-04-21 21:46:32 +00002101 IdentMacroDirectivesOffsetMap[Name] = StartOffset;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002102 Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, Record);
2103 Record.clear();
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002104 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00002105
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002106 /// \brief Offsets of each of the macros into the bitstream, indexed by
2107 /// the local macro ID
2108 ///
2109 /// For each identifier that is associated with a macro, this map
2110 /// provides the offset into the bitstream where that macro is
2111 /// defined.
2112 std::vector<uint32_t> MacroOffsets;
2113
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002114 for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) {
2115 const IdentifierInfo *Name = MacroInfosToEmit[I].Name;
2116 MacroInfo *MI = MacroInfosToEmit[I].MI;
2117 MacroID ID = MacroInfosToEmit[I].ID;
Douglas Gregoreb114da2010-10-01 01:03:07 +00002118
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002119 if (ID < FirstMacroID) {
2120 assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?");
2121 continue;
Chris Lattner2199f5b2009-04-10 18:08:30 +00002122 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002123
2124 // Record the local offset of this macro.
2125 unsigned Index = ID - FirstMacroID;
2126 if (Index == MacroOffsets.size())
2127 MacroOffsets.push_back(Stream.GetCurrentBitNo());
2128 else {
2129 if (Index > MacroOffsets.size())
2130 MacroOffsets.resize(Index + 1);
2131
2132 MacroOffsets[Index] = Stream.GetCurrentBitNo();
2133 }
2134
2135 AddIdentifierRef(Name, Record);
2136 Record.push_back(inferSubmoduleIDFromLocation(MI->getDefinitionLoc()));
2137 AddSourceLocation(MI->getDefinitionLoc(), Record);
2138 AddSourceLocation(MI->getDefinitionEndLoc(), Record);
2139 Record.push_back(MI->isUsed());
Argyrios Kyrtzidis9ef53ce2014-04-09 18:21:23 +00002140 Record.push_back(MI->isUsedForHeaderGuard());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002141 unsigned Code;
2142 if (MI->isObjectLike()) {
2143 Code = PP_MACRO_OBJECT_LIKE;
2144 } else {
2145 Code = PP_MACRO_FUNCTION_LIKE;
2146
2147 Record.push_back(MI->isC99Varargs());
2148 Record.push_back(MI->isGNUVarargs());
2149 Record.push_back(MI->hasCommaPasting());
2150 Record.push_back(MI->getNumArgs());
Daniel Marjamakie4770da2015-05-29 09:15:24 +00002151 for (const IdentifierInfo *Arg : MI->args())
2152 AddIdentifierRef(Arg, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002153 }
2154
2155 // If we have a detailed preprocessing record, record the macro definition
2156 // ID that corresponds to this macro.
2157 if (PPRec)
2158 Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2159
2160 Stream.EmitRecord(Code, Record);
2161 Record.clear();
2162
2163 // Emit the tokens array.
2164 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
2165 // Note that we know that the preprocessor does not have any annotation
2166 // tokens in it because they are created by the parser, and thus can't
2167 // be in a macro definition.
2168 const Token &Tok = MI->getReplacementToken(TokNo);
John McCallf413f5e2013-05-03 00:10:13 +00002169 AddToken(Tok, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002170 Stream.EmitRecord(PP_TOKEN, Record);
2171 Record.clear();
2172 }
2173 ++NumMacros;
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002174 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002175
Douglas Gregor92a96f52011-02-08 21:58:10 +00002176 Stream.ExitBlock();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002177
2178 // Write the offsets table for macro IDs.
2179 using namespace llvm;
Richard Smith13090a22015-04-10 02:02:24 +00002180 auto *Abbrev = new BitCodeAbbrev();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002181 Abbrev->Add(BitCodeAbbrevOp(MACRO_OFFSET));
2182 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2183 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2184 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2185
2186 unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2187 Record.clear();
2188 Record.push_back(MACRO_OFFSET);
2189 Record.push_back(MacroOffsets.size());
2190 Record.push_back(FirstMacroID - NUM_PREDEF_MACRO_IDS);
2191 Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002192 bytes(MacroOffsets));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002193}
2194
2195void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) {
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002196 if (PPRec.local_begin() == PPRec.local_end())
Douglas Gregor92a96f52011-02-08 21:58:10 +00002197 return;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002198
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +00002199 SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002200
Douglas Gregor92a96f52011-02-08 21:58:10 +00002201 // Enter the preprocessor block.
2202 Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002203
Douglas Gregoraae92242010-03-19 21:51:54 +00002204 // If the preprocessor has a preprocessing record, emit it.
2205 unsigned NumPreprocessingRecords = 0;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002206 using namespace llvm;
2207
2208 // Set up the abbreviation for
2209 unsigned InclusionAbbrev = 0;
2210 {
2211 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2212 Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002213 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2214 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2215 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002216 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
Douglas Gregor92a96f52011-02-08 21:58:10 +00002217 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2218 InclusionAbbrev = Stream.EmitAbbrev(Abbrev);
2219 }
2220
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002221 unsigned FirstPreprocessorEntityID
2222 = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0)
2223 + NUM_PREDEF_PP_ENTITY_IDS;
2224 unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002225 RecordData Record;
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002226 for (PreprocessingRecord::iterator E = PPRec.local_begin(),
2227 EEnd = PPRec.local_end();
Douglas Gregor0d4b4312011-08-04 17:06:18 +00002228 E != EEnd;
2229 (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002230 Record.clear();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002231
Richard Smith66a81862015-05-04 02:25:31 +00002232 PreprocessedEntityOffsets.push_back(
2233 PPEntityOffset((*E)->getSourceRange(), Stream.GetCurrentBitNo()));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002234
Richard Smith66a81862015-05-04 02:25:31 +00002235 if (MacroDefinitionRecord *MD = dyn_cast<MacroDefinitionRecord>(*E)) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002236 // Record this macro definition's ID.
2237 MacroDefinitions[MD] = NextPreprocessorEntityID;
Richard Smith66a81862015-05-04 02:25:31 +00002238
Douglas Gregor92a96f52011-02-08 21:58:10 +00002239 AddIdentifierRef(MD->getName(), Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002240 Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
2241 continue;
Douglas Gregoraae92242010-03-19 21:51:54 +00002242 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002243
Chandler Carrutha88a22182011-07-14 08:20:46 +00002244 if (MacroExpansion *ME = dyn_cast<MacroExpansion>(*E)) {
Argyrios Kyrtzidis80f78b92011-09-08 17:18:41 +00002245 Record.push_back(ME->isBuiltinMacro());
2246 if (ME->isBuiltinMacro())
2247 AddIdentifierRef(ME->getName(), Record);
2248 else
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002249 Record.push_back(MacroDefinitions[ME->getDefinition()]);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002250 Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002251 continue;
2252 }
2253
2254 if (InclusionDirective *ID = dyn_cast<InclusionDirective>(*E)) {
2255 Record.push_back(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002256 Record.push_back(ID->getFileName().size());
2257 Record.push_back(ID->wasInQuotes());
2258 Record.push_back(static_cast<unsigned>(ID->getKind()));
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002259 Record.push_back(ID->importedModule());
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002260 SmallString<64> Buffer;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002261 Buffer += ID->getFileName();
Argyrios Kyrtzidis8dbcfc32012-03-08 01:08:28 +00002262 // Check that the FileEntry is not null because it was not resolved and
2263 // we create a PCH even with compiler errors.
2264 if (ID->getFile())
2265 Buffer += ID->getFile()->getName();
Douglas Gregor92a96f52011-02-08 21:58:10 +00002266 Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
2267 continue;
2268 }
2269
2270 llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
2271 }
Douglas Gregor8f45df52009-04-16 22:23:12 +00002272 Stream.ExitBlock();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002273
Douglas Gregoraae92242010-03-19 21:51:54 +00002274 // Write the offsets table for the preprocessing record.
2275 if (NumPreprocessingRecords > 0) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002276 assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
2277
Douglas Gregoraae92242010-03-19 21:51:54 +00002278 // Write the offsets table for identifier IDs.
2279 using namespace llvm;
2280 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002281 Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002282 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity
Douglas Gregoraae92242010-03-19 21:51:54 +00002283 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002284 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002285
Douglas Gregoraae92242010-03-19 21:51:54 +00002286 Record.clear();
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002287 Record.push_back(PPD_ENTITIES_OFFSETS);
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002288 Record.push_back(FirstPreprocessorEntityID - NUM_PREDEF_PP_ENTITY_IDS);
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002289 Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002290 bytes(PreprocessedEntityOffsets));
Douglas Gregoraae92242010-03-19 21:51:54 +00002291 }
Chris Lattnereeffaef2009-04-10 17:15:23 +00002292}
2293
Richard Smith386bb072015-08-18 23:42:23 +00002294unsigned ASTWriter::getLocalOrImportedSubmoduleID(Module *Mod) {
Richard Smith080056b2015-08-18 21:53:42 +00002295 if (!Mod)
2296 return 0;
2297
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002298 llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod);
2299 if (Known != SubmoduleIDs.end())
2300 return Known->second;
Richard Smith386bb072015-08-18 23:42:23 +00002301
2302 if (Mod->getTopLevelModule() != WritingModule)
2303 return 0;
2304
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002305 return SubmoduleIDs[Mod] = NextSubmoduleID++;
2306}
2307
Richard Smith386bb072015-08-18 23:42:23 +00002308unsigned ASTWriter::getSubmoduleID(Module *Mod) {
2309 // FIXME: This can easily happen, if we have a reference to a submodule that
2310 // did not result in us loading a module file for that submodule. For
2311 // instance, a cross-top-level-module 'conflict' declaration will hit this.
2312 unsigned ID = getLocalOrImportedSubmoduleID(Mod);
2313 assert((ID || !Mod) &&
2314 "asked for module ID for non-local, non-imported module");
2315 return ID;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002316}
2317
Douglas Gregor253eefe2011-12-01 00:59:36 +00002318/// \brief Compute the number of modules within the given tree (including the
2319/// given module).
2320static unsigned getNumberOfModules(Module *Mod) {
2321 unsigned ChildModules = 0;
Douglas Gregoreb90e832012-01-04 23:32:19 +00002322 for (Module::submodule_iterator Sub = Mod->submodule_begin(),
2323 SubEnd = Mod->submodule_end();
Douglas Gregor253eefe2011-12-01 00:59:36 +00002324 Sub != SubEnd; ++Sub)
Douglas Gregoreb90e832012-01-04 23:32:19 +00002325 ChildModules += getNumberOfModules(*Sub);
Douglas Gregor253eefe2011-12-01 00:59:36 +00002326
2327 return ChildModules + 1;
2328}
2329
Douglas Gregorde3ef502011-11-30 23:21:26 +00002330void ASTWriter::WriteSubmodules(Module *WritingModule) {
Douglas Gregor69021972011-11-30 17:33:56 +00002331 // Enter the submodule description block.
Richard Smith202210b2014-10-24 20:23:01 +00002332 Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/5);
Douglas Gregor69021972011-11-30 17:33:56 +00002333
2334 // Write the abbreviations needed for the submodules block.
2335 using namespace llvm;
2336 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2337 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002338 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor69021972011-11-30 17:33:56 +00002339 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
2340 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2341 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
Richard Smith9bca2982014-03-08 00:03:56 +00002342 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
2343 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
Douglas Gregora686e1b2012-01-27 19:52:33 +00002344 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
Douglas Gregor73441092011-12-05 22:27:44 +00002345 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
Douglas Gregor73441092011-12-05 22:27:44 +00002346 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002347 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
Douglas Gregor69021972011-11-30 17:33:56 +00002348 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2349 unsigned DefinitionAbbrev = Stream.EmitAbbrev(Abbrev);
2350
2351 Abbrev = new BitCodeAbbrev();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002352 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
Douglas Gregor69021972011-11-30 17:33:56 +00002353 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2354 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(Abbrev);
2355
2356 Abbrev = new BitCodeAbbrev();
2357 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
2358 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2359 unsigned HeaderAbbrev = Stream.EmitAbbrev(Abbrev);
Douglas Gregor524e33e2011-12-08 19:11:24 +00002360
2361 Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002362 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
2363 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2364 unsigned TopHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2365
2366 Abbrev = new BitCodeAbbrev();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002367 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
2368 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2369 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(Abbrev);
2370
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002371 Abbrev = new BitCodeAbbrev();
2372 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES));
Richard Smitha3feee22013-10-28 22:18:19 +00002373 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
2374 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Feature
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002375 unsigned RequiresAbbrev = Stream.EmitAbbrev(Abbrev);
2376
Douglas Gregor59527662012-10-15 06:28:11 +00002377 Abbrev = new BitCodeAbbrev();
2378 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
2379 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2380 unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2381
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002382 Abbrev = new BitCodeAbbrev();
Richard Smith306d8922014-10-22 23:50:56 +00002383 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
2384 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2385 unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2386
2387 Abbrev = new BitCodeAbbrev();
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002388 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
2389 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2390 unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2391
2392 Abbrev = new BitCodeAbbrev();
Richard Smith202210b2014-10-24 20:23:01 +00002393 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
2394 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2395 unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2396
2397 Abbrev = new BitCodeAbbrev();
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002398 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
2399 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2400 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2401 unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(Abbrev);
2402
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002403 Abbrev = new BitCodeAbbrev();
2404 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
2405 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
2406 unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(Abbrev);
2407
Douglas Gregorfb912652013-03-20 21:10:35 +00002408 Abbrev = new BitCodeAbbrev();
2409 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT));
2410 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Other module
2411 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Message
2412 unsigned ConflictAbbrev = Stream.EmitAbbrev(Abbrev);
2413
Douglas Gregor253eefe2011-12-01 00:59:36 +00002414 // Write the submodule metadata block.
2415 RecordData Record;
2416 Record.push_back(getNumberOfModules(WritingModule));
2417 Record.push_back(FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS);
2418 Stream.EmitRecord(SUBMODULE_METADATA, Record);
2419
Douglas Gregor69021972011-11-30 17:33:56 +00002420 // Write all of the submodules.
Douglas Gregorde3ef502011-11-30 23:21:26 +00002421 std::queue<Module *> Q;
Douglas Gregor69021972011-11-30 17:33:56 +00002422 Q.push(WritingModule);
Douglas Gregor69021972011-11-30 17:33:56 +00002423 while (!Q.empty()) {
Douglas Gregorde3ef502011-11-30 23:21:26 +00002424 Module *Mod = Q.front();
Douglas Gregor69021972011-11-30 17:33:56 +00002425 Q.pop();
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002426 unsigned ID = getSubmoduleID(Mod);
Douglas Gregor69021972011-11-30 17:33:56 +00002427
2428 // Emit the definition of the block.
2429 Record.clear();
2430 Record.push_back(SUBMODULE_DEFINITION);
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002431 Record.push_back(ID);
Douglas Gregor69021972011-11-30 17:33:56 +00002432 if (Mod->Parent) {
2433 assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
2434 Record.push_back(SubmoduleIDs[Mod->Parent]);
2435 } else {
2436 Record.push_back(0);
2437 }
2438 Record.push_back(Mod->IsFramework);
2439 Record.push_back(Mod->IsExplicit);
Douglas Gregora686e1b2012-01-27 19:52:33 +00002440 Record.push_back(Mod->IsSystem);
Richard Smith9bca2982014-03-08 00:03:56 +00002441 Record.push_back(Mod->IsExternC);
Douglas Gregor73441092011-12-05 22:27:44 +00002442 Record.push_back(Mod->InferSubmodules);
2443 Record.push_back(Mod->InferExplicitSubmodules);
2444 Record.push_back(Mod->InferExportWildcard);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002445 Record.push_back(Mod->ConfigMacrosExhaustive);
Douglas Gregor69021972011-11-30 17:33:56 +00002446 Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name);
2447
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002448 // Emit the requirements.
Richard Smith080056b2015-08-18 21:53:42 +00002449 for (const auto &R : Mod->Requirements) {
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002450 Record.clear();
2451 Record.push_back(SUBMODULE_REQUIRES);
Richard Smith080056b2015-08-18 21:53:42 +00002452 Record.push_back(R.second);
2453 Stream.EmitRecordWithBlob(RequiresAbbrev, Record, R.first);
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002454 }
2455
Douglas Gregor69021972011-11-30 17:33:56 +00002456 // Emit the umbrella header, if there is one.
Richard Smith2b63d152015-05-16 02:28:53 +00002457 if (auto UmbrellaHeader = Mod->getUmbrellaHeader()) {
Douglas Gregor69021972011-11-30 17:33:56 +00002458 Record.clear();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002459 Record.push_back(SUBMODULE_UMBRELLA_HEADER);
Richard Smith2b63d152015-05-16 02:28:53 +00002460 Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
2461 UmbrellaHeader.NameAsWritten);
2462 } else if (auto UmbrellaDir = Mod->getUmbrellaDir()) {
Douglas Gregor524e33e2011-12-08 19:11:24 +00002463 Record.clear();
2464 Record.push_back(SUBMODULE_UMBRELLA_DIR);
2465 Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
Richard Smith2b63d152015-05-16 02:28:53 +00002466 UmbrellaDir.NameAsWritten);
Douglas Gregor69021972011-11-30 17:33:56 +00002467 }
Richard Smith306d8922014-10-22 23:50:56 +00002468
Douglas Gregor69021972011-11-30 17:33:56 +00002469 // Emit the headers.
Richard Smith202210b2014-10-24 20:23:01 +00002470 struct {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002471 unsigned RecordKind;
Richard Smith202210b2014-10-24 20:23:01 +00002472 unsigned Abbrev;
Richard Smith3c1a41a2014-12-02 00:08:08 +00002473 Module::HeaderKind HeaderKind;
Richard Smith202210b2014-10-24 20:23:01 +00002474 } HeaderLists[] = {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002475 {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal},
2476 {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual},
2477 {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private},
Richard Smith202210b2014-10-24 20:23:01 +00002478 {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev,
Richard Smith3c1a41a2014-12-02 00:08:08 +00002479 Module::HK_PrivateTextual},
2480 {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded}
Richard Smith202210b2014-10-24 20:23:01 +00002481 };
2482 for (auto &HL : HeaderLists) {
Douglas Gregor69021972011-11-30 17:33:56 +00002483 Record.clear();
Richard Smith3c1a41a2014-12-02 00:08:08 +00002484 Record.push_back(HL.RecordKind);
2485 for (auto &H : Mod->Headers[HL.HeaderKind])
2486 Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten);
2487 }
2488
2489 // Emit the top headers.
2490 {
2491 auto TopHeaders = Mod->getTopHeaders(PP->getFileManager());
2492 Record.clear();
2493 Record.push_back(SUBMODULE_TOPHEADER);
2494 for (auto *H : TopHeaders)
2495 Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, H->getName());
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002496 }
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002497
2498 // Emit the imports.
2499 if (!Mod->Imports.empty()) {
2500 Record.clear();
Richard Smith080056b2015-08-18 21:53:42 +00002501 for (auto *I : Mod->Imports)
2502 Record.push_back(getSubmoduleID(I));
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002503 Stream.EmitRecord(SUBMODULE_IMPORTS, Record);
2504 }
2505
Douglas Gregor24bb9232011-12-02 18:58:38 +00002506 // Emit the exports.
2507 if (!Mod->Exports.empty()) {
2508 Record.clear();
Richard Smith080056b2015-08-18 21:53:42 +00002509 for (const auto &E : Mod->Exports) {
2510 // FIXME: This may fail; we don't require that all exported modules
2511 // are local or imported.
2512 Record.push_back(getSubmoduleID(E.getPointer()));
2513 Record.push_back(E.getInt());
Douglas Gregor24bb9232011-12-02 18:58:38 +00002514 }
2515 Stream.EmitRecord(SUBMODULE_EXPORTS, Record);
2516 }
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002517
Daniel Jasperba7f2f72013-09-24 09:14:14 +00002518 //FIXME: How do we emit the 'use'd modules? They may not be submodules.
2519 // Might be unnecessary as use declarations are only used to build the
2520 // module itself.
2521
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002522 // Emit the link libraries.
Richard Smith080056b2015-08-18 21:53:42 +00002523 for (const auto &LL : Mod->LinkLibraries) {
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002524 Record.clear();
2525 Record.push_back(SUBMODULE_LINK_LIBRARY);
Richard Smith080056b2015-08-18 21:53:42 +00002526 Record.push_back(LL.IsFramework);
2527 Stream.EmitRecordWithBlob(LinkLibraryAbbrev, Record, LL.Library);
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002528 }
2529
Douglas Gregorfb912652013-03-20 21:10:35 +00002530 // Emit the conflicts.
Richard Smith080056b2015-08-18 21:53:42 +00002531 for (const auto &C : Mod->Conflicts) {
Douglas Gregorfb912652013-03-20 21:10:35 +00002532 Record.clear();
2533 Record.push_back(SUBMODULE_CONFLICT);
Richard Smith080056b2015-08-18 21:53:42 +00002534 // FIXME: This may fail; we don't require that all conflicting modules
2535 // are local or imported.
2536 Record.push_back(getSubmoduleID(C.Other));
2537 Stream.EmitRecordWithBlob(ConflictAbbrev, Record, C.Message);
Douglas Gregorfb912652013-03-20 21:10:35 +00002538 }
2539
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002540 // Emit the configuration macros.
Richard Smith080056b2015-08-18 21:53:42 +00002541 for (const auto &CM : Mod->ConfigMacros) {
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002542 Record.clear();
2543 Record.push_back(SUBMODULE_CONFIG_MACRO);
Richard Smith080056b2015-08-18 21:53:42 +00002544 Stream.EmitRecordWithBlob(ConfigMacroAbbrev, Record, CM);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002545 }
2546
Douglas Gregor69021972011-11-30 17:33:56 +00002547 // Queue up the submodules of this module.
Richard Smith080056b2015-08-18 21:53:42 +00002548 for (auto *M : Mod->submodules())
2549 Q.push(M);
Douglas Gregor69021972011-11-30 17:33:56 +00002550 }
2551
2552 Stream.ExitBlock();
Richard Smith23d8d032015-05-14 00:45:20 +00002553
Richard Smith23d8d032015-05-14 00:45:20 +00002554 assert((NextSubmoduleID - FirstSubmoduleID ==
2555 getNumberOfModules(WritingModule)) &&
2556 "Wrong # of submodules; found a reference to a non-local, "
2557 "non-imported submodule?");
Douglas Gregor69021972011-11-30 17:33:56 +00002558}
2559
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002560serialization::SubmoduleID
2561ASTWriter::inferSubmoduleIDFromLocation(SourceLocation Loc) {
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002562 if (Loc.isInvalid() || !WritingModule)
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002563 return 0; // No submodule
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002564
2565 // Find the module that owns this location.
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002566 ModuleMap &ModMap = PP->getHeaderSearchInfo().getModuleMap();
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002567 Module *OwningMod
2568 = ModMap.inferModuleFromLocation(FullSourceLoc(Loc,PP->getSourceManager()));
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002569 if (!OwningMod)
2570 return 0;
2571
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002572 // Check whether this submodule is part of our own module.
2573 if (WritingModule != OwningMod && !OwningMod->isSubModuleOf(WritingModule))
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002574 return 0;
2575
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002576 return getSubmoduleID(OwningMod);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002577}
2578
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00002579void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
2580 bool isModule) {
2581 // Make sure set diagnostic pragmas don't affect the translation unit that
2582 // imports the module.
2583 // FIXME: Make diagnostic pragma sections work properly with modules.
2584 if (isModule)
2585 return;
2586
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002587 llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64>
2588 DiagStateIDMap;
2589 unsigned CurrID = 0;
2590 DiagStateIDMap[&Diag.DiagStates.front()] = ++CurrID; // the command-line one.
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002591 RecordData Record;
David Blaikie9c902b52011-09-25 23:23:43 +00002592 for (DiagnosticsEngine::DiagStatePointsTy::const_iterator
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002593 I = Diag.DiagStatePoints.begin(), E = Diag.DiagStatePoints.end();
2594 I != E; ++I) {
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002595 const DiagnosticsEngine::DiagStatePoint &point = *I;
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002596 if (point.Loc.isInvalid())
2597 continue;
2598
2599 Record.push_back(point.Loc.getRawEncoding());
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002600 unsigned &DiagStateID = DiagStateIDMap[point.State];
2601 Record.push_back(DiagStateID);
2602
2603 if (DiagStateID == 0) {
2604 DiagStateID = ++CurrID;
2605 for (DiagnosticsEngine::DiagState::const_iterator
2606 I = point.State->begin(), E = point.State->end(); I != E; ++I) {
2607 if (I->second.isPragma()) {
2608 Record.push_back(I->first);
Alp Toker46df1c02014-06-12 10:15:20 +00002609 Record.push_back((unsigned)I->second.getSeverity());
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002610 }
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002611 }
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002612 Record.push_back(-1); // mark the end of the diag/map pairs for this
2613 // location.
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002614 }
2615 }
2616
Argyrios Kyrtzidisb0ca9eb2010-11-05 22:20:49 +00002617 if (!Record.empty())
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002618 Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002619}
2620
Richard Smithc2bb8182015-03-24 06:36:48 +00002621void ASTWriter::WriteCXXCtorInitializersOffsets() {
2622 if (CXXCtorInitializersOffsets.empty())
2623 return;
2624
2625 RecordData Record;
2626
2627 // Create a blob abbreviation for the C++ ctor initializer offsets.
2628 using namespace llvm;
2629
2630 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2631 Abbrev->Add(BitCodeAbbrevOp(CXX_CTOR_INITIALIZERS_OFFSETS));
2632 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
2633 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2634 unsigned CtorInitializersOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2635
2636 // Write the base specifier offsets table.
2637 Record.clear();
2638 Record.push_back(CXX_CTOR_INITIALIZERS_OFFSETS);
2639 Record.push_back(CXXCtorInitializersOffsets.size());
2640 Stream.EmitRecordWithBlob(CtorInitializersOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002641 bytes(CXXCtorInitializersOffsets));
Richard Smithc2bb8182015-03-24 06:36:48 +00002642}
2643
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002644void ASTWriter::WriteCXXBaseSpecifiersOffsets() {
2645 if (CXXBaseSpecifiersOffsets.empty())
2646 return;
2647
2648 RecordData Record;
2649
2650 // Create a blob abbreviation for the C++ base specifiers offsets.
2651 using namespace llvm;
2652
2653 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2654 Abbrev->Add(BitCodeAbbrevOp(CXX_BASE_SPECIFIER_OFFSETS));
2655 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
2656 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2657 unsigned BaseSpecifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2658
Douglas Gregorc27b2872011-08-04 00:01:48 +00002659 // Write the base specifier offsets table.
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002660 Record.clear();
2661 Record.push_back(CXX_BASE_SPECIFIER_OFFSETS);
2662 Record.push_back(CXXBaseSpecifiersOffsets.size());
2663 Stream.EmitRecordWithBlob(BaseSpecifierOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002664 bytes(CXXBaseSpecifiersOffsets));
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002665}
2666
Douglas Gregorc5046832009-04-27 18:38:38 +00002667//===----------------------------------------------------------------------===//
2668// Type Serialization
2669//===----------------------------------------------------------------------===//
Chris Lattnereeffaef2009-04-10 17:15:23 +00002670
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002671/// \brief Write the representation of a type to the AST stream.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002672void ASTWriter::WriteType(QualType T) {
Argyrios Kyrtzidisa7fbbb02010-08-20 16:04:04 +00002673 TypeIdx &Idx = TypeIdxs[T];
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00002674 if (Idx.getIndex() == 0) // we haven't seen this type before.
2675 Idx = TypeIdx(NextTypeID++);
Mike Stump11289f42009-09-09 15:08:12 +00002676
Douglas Gregor9b3932c2010-10-05 18:37:06 +00002677 assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
Douglas Gregordc72caa2010-10-04 18:21:45 +00002678
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002679 // Record the offset for this type.
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00002680 unsigned Index = Idx.getIndex() - FirstTypeID;
Sebastian Redl66c5eef2010-07-27 00:17:23 +00002681 if (TypeOffsets.size() == Index)
Douglas Gregor8f45df52009-04-16 22:23:12 +00002682 TypeOffsets.push_back(Stream.GetCurrentBitNo());
Sebastian Redl66c5eef2010-07-27 00:17:23 +00002683 else if (TypeOffsets.size() < Index) {
2684 TypeOffsets.resize(Index + 1);
2685 TypeOffsets[Index] = Stream.GetCurrentBitNo();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002686 }
2687
2688 RecordData Record;
Mike Stump11289f42009-09-09 15:08:12 +00002689
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002690 // Emit the type's representation.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002691 ASTTypeWriter W(*this, Record);
Richard Smith01b2cb42014-07-26 06:37:51 +00002692 W.AbbrevToUse = 0;
John McCall8ccfcb52009-09-24 19:53:00 +00002693
Douglas Gregor1b8fe5b72009-11-16 21:35:15 +00002694 if (T.hasLocalNonFastQualifiers()) {
2695 Qualifiers Qs = T.getLocalQualifiers();
2696 AddTypeRef(T.getLocalUnqualifiedType(), Record);
John McCall8ccfcb52009-09-24 19:53:00 +00002697 Record.push_back(Qs.getAsOpaqueValue());
Sebastian Redl539c5062010-08-18 23:57:32 +00002698 W.Code = TYPE_EXT_QUAL;
Richard Smith01b2cb42014-07-26 06:37:51 +00002699 W.AbbrevToUse = TypeExtQualAbbrev;
John McCall8ccfcb52009-09-24 19:53:00 +00002700 } else {
2701 switch (T->getTypeClass()) {
2702 // For all of the concrete, non-dependent types, call the
2703 // appropriate visitor function.
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002704#define TYPE(Class, Base) \
Mike Stump281d6d72010-01-20 02:03:14 +00002705 case Type::Class: W.Visit##Class##Type(cast<Class##Type>(T)); break;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002706#define ABSTRACT_TYPE(Class, Base)
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002707#include "clang/AST/TypeNodes.def"
John McCall8ccfcb52009-09-24 19:53:00 +00002708 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002709 }
2710
2711 // Emit the serialized record.
Richard Smith01b2cb42014-07-26 06:37:51 +00002712 Stream.EmitRecord(W.Code, Record, W.AbbrevToUse);
Douglas Gregorfeb84b02009-04-14 21:18:50 +00002713
2714 // Flush any expressions that were written as part of this type.
Douglas Gregor8f45df52009-04-16 22:23:12 +00002715 FlushStmts();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002716}
2717
Douglas Gregorc5046832009-04-27 18:38:38 +00002718//===----------------------------------------------------------------------===//
2719// Declaration Serialization
2720//===----------------------------------------------------------------------===//
2721
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002722/// \brief Write the block containing all of the declaration IDs
2723/// lexically declared within the given DeclContext.
2724///
2725/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
2726/// bistream, or 0 if no block was written.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002727uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002728 DeclContext *DC) {
Argyrios Kyrtzidiscfbfe782009-06-30 02:36:12 +00002729 if (DC->decls_empty())
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002730 return 0;
2731
Douglas Gregor8f45df52009-04-16 22:23:12 +00002732 uint64_t Offset = Stream.GetCurrentBitNo();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002733 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00002734 Record.push_back(DECL_CONTEXT_LEXICAL);
Richard Smith82f8fcd2015-08-06 22:07:25 +00002735 SmallVector<uint32_t, 128> KindDeclPairs;
2736 for (const auto *D : DC->decls()) {
2737 KindDeclPairs.push_back(D->getKind());
2738 KindDeclPairs.push_back(GetDeclRef(D));
2739 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002740
Douglas Gregora57c3ab2009-04-22 22:34:57 +00002741 ++NumLexicalDeclContexts;
Richard Smith82f8fcd2015-08-06 22:07:25 +00002742 Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record,
2743 bytes(KindDeclPairs));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002744 return Offset;
2745}
2746
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002747void ASTWriter::WriteTypeDeclOffsets() {
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002748 using namespace llvm;
2749 RecordData Record;
2750
2751 // Write the type offsets array
2752 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00002753 Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002754 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
Douglas Gregor5204bde2011-08-02 16:26:37 +00002755 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002756 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
2757 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2758 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00002759 Record.push_back(TYPE_OFFSET);
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002760 Record.push_back(TypeOffsets.size());
Douglas Gregor5204bde2011-08-02 16:26:37 +00002761 Record.push_back(FirstTypeID - NUM_PREDEF_TYPE_IDS);
Reid Kleckner012665e2015-05-21 00:13:09 +00002762 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, bytes(TypeOffsets));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002763
2764 // Write the declaration offsets array
2765 Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00002766 Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002767 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
Douglas Gregorf7180622011-08-03 15:48:04 +00002768 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002769 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
2770 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2771 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00002772 Record.push_back(DECL_OFFSET);
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002773 Record.push_back(DeclOffsets.size());
Douglas Gregor6f8912e2011-08-03 16:05:40 +00002774 Record.push_back(FirstDeclID - NUM_PREDEF_DECL_IDS);
Reid Kleckner012665e2015-05-21 00:13:09 +00002775 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, bytes(DeclOffsets));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002776}
2777
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002778void ASTWriter::WriteFileDeclIDsMap() {
2779 using namespace llvm;
2780 RecordData Record;
2781
Chandler Carruthb306d732015-03-27 00:31:20 +00002782 SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs(
2783 FileDeclIDs.begin(), FileDeclIDs.end());
2784 std::sort(SortedFileDeclIDs.begin(), SortedFileDeclIDs.end(),
2785 llvm::less_first());
2786
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002787 // Join the vectors of DeclIDs from all files.
Chandler Carruthb306d732015-03-27 00:31:20 +00002788 SmallVector<DeclID, 256> FileGroupedDeclIDs;
2789 for (auto &FileDeclEntry : SortedFileDeclIDs) {
2790 DeclIDInFileInfo &Info = *FileDeclEntry.second;
2791 Info.FirstDeclIndex = FileGroupedDeclIDs.size();
2792 for (auto &LocDeclEntry : Info.DeclIDs)
2793 FileGroupedDeclIDs.push_back(LocDeclEntry.second);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002794 }
2795
2796 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
2797 Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
Argyrios Kyrtzidis10e78462012-10-02 21:09:13 +00002798 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002799 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2800 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
2801 Record.push_back(FILE_SORTED_DECLS);
Chandler Carruthb306d732015-03-27 00:31:20 +00002802 Record.push_back(FileGroupedDeclIDs.size());
Reid Kleckner012665e2015-05-21 00:13:09 +00002803 Stream.EmitRecordWithBlob(AbbrevCode, Record, bytes(FileGroupedDeclIDs));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002804}
2805
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002806void ASTWriter::WriteComments() {
2807 Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3);
Dmitri Gribenko7dd29d42012-07-06 18:19:34 +00002808 ArrayRef<RawComment *> RawComments = Context->Comments.getComments();
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002809 RecordData Record;
Dmitri Gribenko7dd29d42012-07-06 18:19:34 +00002810 for (ArrayRef<RawComment *>::iterator I = RawComments.begin(),
2811 E = RawComments.end();
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002812 I != E; ++I) {
2813 Record.clear();
Dmitri Gribenko7dd29d42012-07-06 18:19:34 +00002814 AddSourceRange((*I)->getSourceRange(), Record);
2815 Record.push_back((*I)->getKind());
2816 Record.push_back((*I)->isTrailingComment());
2817 Record.push_back((*I)->isAlmostTrailingComment());
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002818 Stream.EmitRecord(COMMENTS_RAW_COMMENT, Record);
2819 }
2820 Stream.ExitBlock();
2821}
2822
Douglas Gregorc5046832009-04-27 18:38:38 +00002823//===----------------------------------------------------------------------===//
2824// Global Method Pool and Selector Serialization
2825//===----------------------------------------------------------------------===//
2826
Douglas Gregore84a9da2009-04-20 20:36:09 +00002827namespace {
Douglas Gregorc78d3462009-04-24 21:10:55 +00002828// Trait used for the on-disk hash table used in the method pool.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002829class ASTMethodPoolTrait {
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002830 ASTWriter &Writer;
Douglas Gregorc78d3462009-04-24 21:10:55 +00002831
2832public:
2833 typedef Selector key_type;
2834 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00002835
Sebastian Redl834bb972010-08-04 17:20:04 +00002836 struct data_type {
Sebastian Redl539c5062010-08-18 23:57:32 +00002837 SelectorID ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00002838 ObjCMethodList Instance, Factory;
2839 };
Douglas Gregorc78d3462009-04-24 21:10:55 +00002840 typedef const data_type& data_type_ref;
2841
Justin Bogner25463f12014-04-18 20:27:24 +00002842 typedef unsigned hash_value_type;
2843 typedef unsigned offset_type;
2844
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002845 explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) { }
Mike Stump11289f42009-09-09 15:08:12 +00002846
Justin Bogner25463f12014-04-18 20:27:24 +00002847 static hash_value_type ComputeHash(Selector Sel) {
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +00002848 return serialization::ComputeHash(Sel);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002849 }
Mike Stump11289f42009-09-09 15:08:12 +00002850
2851 std::pair<unsigned,unsigned>
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002852 EmitKeyDataLength(raw_ostream& Out, Selector Sel,
Douglas Gregorc78d3462009-04-24 21:10:55 +00002853 data_type_ref Methods) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002854 using namespace llvm::support;
2855 endian::Writer<little> LE(Out);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002856 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
Justin Bognere1c147c2014-03-28 22:03:19 +00002857 LE.write<uint16_t>(KeyLen);
Sebastian Redl834bb972010-08-04 17:20:04 +00002858 unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
2859 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002860 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002861 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002862 DataLen += 4;
Sebastian Redl834bb972010-08-04 17:20:04 +00002863 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002864 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002865 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002866 DataLen += 4;
Justin Bognere1c147c2014-03-28 22:03:19 +00002867 LE.write<uint16_t>(DataLen);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002868 return std::make_pair(KeyLen, DataLen);
2869 }
Mike Stump11289f42009-09-09 15:08:12 +00002870
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002871 void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002872 using namespace llvm::support;
2873 endian::Writer<little> LE(Out);
Mike Stump11289f42009-09-09 15:08:12 +00002874 uint64_t Start = Out.tell();
Douglas Gregor95c13f52009-04-25 17:48:32 +00002875 assert((Start >> 32) == 0 && "Selector key offset too large");
2876 Writer.SetSelectorOffset(Sel, Start);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002877 unsigned N = Sel.getNumArgs();
Justin Bognere1c147c2014-03-28 22:03:19 +00002878 LE.write<uint16_t>(N);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002879 if (N == 0)
2880 N = 1;
2881 for (unsigned I = 0; I != N; ++I)
Justin Bognere1c147c2014-03-28 22:03:19 +00002882 LE.write<uint32_t>(
2883 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
Douglas Gregorc78d3462009-04-24 21:10:55 +00002884 }
Mike Stump11289f42009-09-09 15:08:12 +00002885
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002886 void EmitData(raw_ostream& Out, key_type_ref,
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002887 data_type_ref Methods, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002888 using namespace llvm::support;
2889 endian::Writer<little> LE(Out);
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002890 uint64_t Start = Out.tell(); (void)Start;
Justin Bognere1c147c2014-03-28 22:03:19 +00002891 LE.write<uint32_t>(Methods.ID);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002892 unsigned NumInstanceMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00002893 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002894 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002895 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002896 ++NumInstanceMethods;
2897
2898 unsigned NumFactoryMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00002899 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002900 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002901 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002902 ++NumFactoryMethods;
2903
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002904 unsigned InstanceBits = Methods.Instance.getBits();
2905 assert(InstanceBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00002906 unsigned InstanceHasMoreThanOneDeclBit =
2907 Methods.Instance.hasMoreThanOneDecl();
2908 unsigned FullInstanceBits = (NumInstanceMethods << 3) |
2909 (InstanceHasMoreThanOneDeclBit << 2) |
2910 InstanceBits;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002911 unsigned FactoryBits = Methods.Factory.getBits();
2912 assert(FactoryBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00002913 unsigned FactoryHasMoreThanOneDeclBit =
2914 Methods.Factory.hasMoreThanOneDecl();
2915 unsigned FullFactoryBits = (NumFactoryMethods << 3) |
2916 (FactoryHasMoreThanOneDeclBit << 2) |
2917 FactoryBits;
2918 LE.write<uint16_t>(FullInstanceBits);
2919 LE.write<uint16_t>(FullFactoryBits);
Sebastian Redl834bb972010-08-04 17:20:04 +00002920 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002921 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002922 if (Method->getMethod())
2923 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Sebastian Redl834bb972010-08-04 17:20:04 +00002924 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002925 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002926 if (Method->getMethod())
2927 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002928
2929 assert(Out.tell() - Start == DataLen && "Data length is wrong");
Douglas Gregorc78d3462009-04-24 21:10:55 +00002930 }
2931};
2932} // end anonymous namespace
2933
Sebastian Redla19a67f2010-08-03 21:58:15 +00002934/// \brief Write ObjC data: selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00002935///
2936/// The method pool contains both instance and factory methods, stored
Sebastian Redla19a67f2010-08-03 21:58:15 +00002937/// in an on-disk hash table indexed by the selector. The hash table also
2938/// contains an empty entry for every other selector known to Sema.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002939void ASTWriter::WriteSelectors(Sema &SemaRef) {
Douglas Gregorc78d3462009-04-24 21:10:55 +00002940 using namespace llvm;
2941
Sebastian Redla19a67f2010-08-03 21:58:15 +00002942 // Do we have to do anything at all?
Sebastian Redl834bb972010-08-04 17:20:04 +00002943 if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
Sebastian Redla19a67f2010-08-03 21:58:15 +00002944 return;
Sebastian Redld95a56e2010-08-04 18:21:41 +00002945 unsigned NumTableEntries = 0;
Sebastian Redla19a67f2010-08-03 21:58:15 +00002946 // Create and write out the blob that contains selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00002947 {
Justin Bognerbb094f02014-04-18 19:57:06 +00002948 llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00002949 ASTMethodPoolTrait Trait(*this);
Mike Stump11289f42009-09-09 15:08:12 +00002950
Sebastian Redla19a67f2010-08-03 21:58:15 +00002951 // Create the on-disk hash table representation. We walk through every
2952 // selector we've seen and look it up in the method pool.
Sebastian Redld95a56e2010-08-04 18:21:41 +00002953 SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
Chandler Carruthacbbeb92015-03-27 00:47:43 +00002954 for (auto &SelectorAndID : SelectorIDs) {
2955 Selector S = SelectorAndID.first;
2956 SelectorID ID = SelectorAndID.second;
Sebastian Redla19a67f2010-08-03 21:58:15 +00002957 Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002958 ASTMethodPoolTrait::data_type Data = {
Chandler Carruthacbbeb92015-03-27 00:47:43 +00002959 ID,
Sebastian Redl834bb972010-08-04 17:20:04 +00002960 ObjCMethodList(),
2961 ObjCMethodList()
2962 };
2963 if (F != SemaRef.MethodPool.end()) {
2964 Data.Instance = F->second.first;
2965 Data.Factory = F->second.second;
2966 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002967 // Only write this selector if it's not in an existing AST or something
Sebastian Redld95a56e2010-08-04 18:21:41 +00002968 // changed.
Chandler Carruthacbbeb92015-03-27 00:47:43 +00002969 if (Chain && ID < FirstSelectorID) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00002970 // Selector already exists. Did it change?
2971 bool changed = false;
Nico Weber2e0c8f72014-12-27 03:58:08 +00002972 for (ObjCMethodList *M = &Data.Instance;
2973 !changed && M && M->getMethod(); M = M->getNext()) {
2974 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00002975 changed = true;
2976 }
Nico Weber2e0c8f72014-12-27 03:58:08 +00002977 for (ObjCMethodList *M = &Data.Factory; !changed && M && M->getMethod();
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002978 M = M->getNext()) {
Nico Weber2e0c8f72014-12-27 03:58:08 +00002979 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00002980 changed = true;
2981 }
2982 if (!changed)
2983 continue;
Nico Weber2e0c8f72014-12-27 03:58:08 +00002984 } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) {
Sebastian Redl6e1a2a02010-08-04 21:22:45 +00002985 // A new method pool entry.
2986 ++NumTableEntries;
Sebastian Redld95a56e2010-08-04 18:21:41 +00002987 }
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00002988 Generator.insert(S, Data, Trait);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002989 }
2990
Douglas Gregorc78d3462009-04-24 21:10:55 +00002991 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002992 SmallString<4096> MethodPool;
Douglas Gregorc78d3462009-04-24 21:10:55 +00002993 uint32_t BucketOffset;
2994 {
Justin Bognere1c147c2014-03-28 22:03:19 +00002995 using namespace llvm::support;
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002996 ASTMethodPoolTrait Trait(*this);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002997 llvm::raw_svector_ostream Out(MethodPool);
2998 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00002999 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003000 BucketOffset = Generator.Emit(Out, Trait);
3001 }
3002
3003 // Create a blob abbreviation
3004 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003005 Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003006 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003007 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003008 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3009 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(Abbrev);
3010
Douglas Gregor95c13f52009-04-25 17:48:32 +00003011 // Write the method pool
Douglas Gregorc78d3462009-04-24 21:10:55 +00003012 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00003013 Record.push_back(METHOD_POOL);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003014 Record.push_back(BucketOffset);
Sebastian Redld95a56e2010-08-04 18:21:41 +00003015 Record.push_back(NumTableEntries);
Yaron Keren92e1b622015-03-18 10:17:07 +00003016 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool);
Douglas Gregor95c13f52009-04-25 17:48:32 +00003017
3018 // Create a blob abbreviation for the selector table offsets.
3019 Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003020 Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
Douglas Gregord4c5ed02010-10-29 22:39:52 +00003021 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
Douglas Gregor8f364fb2011-08-03 23:28:44 +00003022 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor95c13f52009-04-25 17:48:32 +00003023 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3024 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
3025
3026 // Write the selector offsets table.
3027 Record.clear();
Sebastian Redl539c5062010-08-18 23:57:32 +00003028 Record.push_back(SELECTOR_OFFSETS);
Douglas Gregor95c13f52009-04-25 17:48:32 +00003029 Record.push_back(SelectorOffsets.size());
Douglas Gregor8f364fb2011-08-03 23:28:44 +00003030 Record.push_back(FirstSelectorID - NUM_PREDEF_SELECTOR_IDS);
Douglas Gregor95c13f52009-04-25 17:48:32 +00003031 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00003032 bytes(SelectorOffsets));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003033 }
3034}
3035
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003036/// \brief Write the selectors referenced in @selector expression into AST file.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003037void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003038 using namespace llvm;
3039 if (SemaRef.ReferencedSelectors.empty())
3040 return;
Sebastian Redlada023c2010-08-04 20:40:17 +00003041
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003042 RecordData Record;
Sebastian Redlada023c2010-08-04 20:40:17 +00003043
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003044 // Note: this writes out all references even for a dependent AST. But it is
Sebastian Redl51c79d82010-08-04 22:21:29 +00003045 // very tricky to fix, and given that @selector shouldn't really appear in
3046 // headers, probably not worth it. It's not a correctness issue.
Chandler Carruth12c8f652015-03-27 00:55:05 +00003047 for (auto &SelectorAndLocation : SemaRef.ReferencedSelectors) {
3048 Selector Sel = SelectorAndLocation.first;
3049 SourceLocation Loc = SelectorAndLocation.second;
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003050 AddSelectorRef(Sel, Record);
3051 AddSourceLocation(Loc, Record);
3052 }
Sebastian Redl539c5062010-08-18 23:57:32 +00003053 Stream.EmitRecord(REFERENCED_SELECTOR_POOL, Record);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003054}
3055
Douglas Gregorc5046832009-04-27 18:38:38 +00003056//===----------------------------------------------------------------------===//
3057// Identifier Table Serialization
3058//===----------------------------------------------------------------------===//
3059
Richard Smithb3761912015-02-05 23:08:52 +00003060/// Determine the declaration that should be put into the name lookup table to
3061/// represent the given declaration in this module. This is usually D itself,
3062/// but if D was imported and merged into a local declaration, we want the most
3063/// recent local declaration instead. The chosen declaration will be the most
3064/// recent declaration in any module that imports this one.
3065static NamedDecl *getDeclForLocalLookup(const LangOptions &LangOpts,
3066 NamedDecl *D) {
3067 if (!LangOpts.Modules || !D->isFromASTFile())
3068 return D;
3069
3070 if (Decl *Redecl = D->getPreviousDecl()) {
3071 // For Redeclarable decls, a prior declaration might be local.
3072 for (; Redecl; Redecl = Redecl->getPreviousDecl()) {
3073 if (!Redecl->isFromASTFile())
3074 return cast<NamedDecl>(Redecl);
Richard Smithfe620d22015-03-05 23:24:12 +00003075 // If we find a decl from a (chained-)PCH stop since we won't find a
Richard Smithb3761912015-02-05 23:08:52 +00003076 // local one.
3077 if (D->getOwningModuleID() == 0)
3078 break;
3079 }
3080 } else if (Decl *First = D->getCanonicalDecl()) {
3081 // For Mergeable decls, the first decl might be local.
3082 if (!First->isFromASTFile())
3083 return cast<NamedDecl>(First);
3084 }
3085
3086 // All declarations are imported. Our most recent declaration will also be
3087 // the most recent one in anyone who imports us.
3088 return D;
3089}
3090
Douglas Gregorc78d3462009-04-24 21:10:55 +00003091namespace {
Richard Smithcf97cf62015-04-19 01:34:23 +00003092class ASTIdentifierTableTrait {
3093 ASTWriter &Writer;
3094 Preprocessor &PP;
3095 IdentifierResolver &IdResolver;
Richard Smith9c254182015-07-19 21:41:12 +00003096 bool IsModule;
Richard Smitha534a312015-07-21 23:54:07 +00003097 bool NeedDecls;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003098 ASTWriter::RecordData *InterestingIdentifierOffsets;
Richard Smithcf97cf62015-04-19 01:34:23 +00003099
3100 /// \brief Determines whether this is an "interesting" identifier that needs a
3101 /// full IdentifierInfo structure written into the hash table. Notably, this
3102 /// doesn't check whether the name has macros defined; use PublicMacroIterator
3103 /// to check that.
Richard Smith9c254182015-07-19 21:41:12 +00003104 bool isInterestingIdentifier(const IdentifierInfo *II, uint64_t MacroOffset) {
Richard Smithd7329392015-04-21 21:46:32 +00003105 if (MacroOffset ||
3106 II->isPoisoned() ||
Richard Smith9c254182015-07-19 21:41:12 +00003107 (IsModule ? II->hasRevertedBuiltin() : II->getObjCOrBuiltinID()) ||
Richard Smithcf97cf62015-04-19 01:34:23 +00003108 II->hasRevertedTokenIDToIdentifier() ||
Richard Smitha534a312015-07-21 23:54:07 +00003109 (NeedDecls && II->getFETokenInfo<void>()))
Richard Smithcf97cf62015-04-19 01:34:23 +00003110 return true;
3111
3112 return false;
3113 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003114
Douglas Gregore84a9da2009-04-20 20:36:09 +00003115public:
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003116 typedef IdentifierInfo* key_type;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003117 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00003118
Sebastian Redl539c5062010-08-18 23:57:32 +00003119 typedef IdentID data_type;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003120 typedef data_type data_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00003121
Justin Bogner25463f12014-04-18 20:27:24 +00003122 typedef unsigned hash_value_type;
3123 typedef unsigned offset_type;
3124
Richard Smithd7329392015-04-21 21:46:32 +00003125 ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
Richard Smith33e0f7e2015-07-22 02:08:40 +00003126 IdentifierResolver &IdResolver, bool IsModule,
3127 ASTWriter::RecordData *InterestingIdentifierOffsets)
Richard Smitha534a312015-07-21 23:54:07 +00003128 : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule),
Richard Smith33e0f7e2015-07-22 02:08:40 +00003129 NeedDecls(!IsModule || !Writer.getLangOpts().CPlusPlus),
3130 InterestingIdentifierOffsets(InterestingIdentifierOffsets) {}
Douglas Gregore84a9da2009-04-20 20:36:09 +00003131
Justin Bogner25463f12014-04-18 20:27:24 +00003132 static hash_value_type ComputeHash(const IdentifierInfo* II) {
Daniel Dunbarf8502d52009-10-17 23:52:28 +00003133 return llvm::HashString(II->getName());
Douglas Gregore84a9da2009-04-20 20:36:09 +00003134 }
Mike Stump11289f42009-09-09 15:08:12 +00003135
Richard Smith33e0f7e2015-07-22 02:08:40 +00003136 bool isInterestingIdentifier(const IdentifierInfo *II) {
3137 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3138 return isInterestingIdentifier(II, MacroOffset);
3139 }
Richard Smith9c254182015-07-19 21:41:12 +00003140 bool isInterestingNonMacroIdentifier(const IdentifierInfo *II) {
3141 return isInterestingIdentifier(II, 0);
3142 }
3143
Mike Stump11289f42009-09-09 15:08:12 +00003144 std::pair<unsigned,unsigned>
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003145 EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) {
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003146 unsigned KeyLen = II->getLength() + 1;
Douglas Gregor1d583f22009-04-28 21:18:29 +00003147 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
Richard Smithd7329392015-04-21 21:46:32 +00003148 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3149 if (isInterestingIdentifier(II, MacroOffset)) {
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003150 DataLen += 2; // 2 bytes for builtin ID
3151 DataLen += 2; // 2 bytes for flags
Richard Smithd7329392015-04-21 21:46:32 +00003152 if (MacroOffset)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003153 DataLen += 4; // MacroDirectives offset.
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003154
Richard Smitha534a312015-07-21 23:54:07 +00003155 if (NeedDecls) {
3156 for (IdentifierResolver::iterator D = IdResolver.begin(II),
3157 DEnd = IdResolver.end();
3158 D != DEnd; ++D)
3159 DataLen += 4;
3160 }
Douglas Gregor1d583f22009-04-28 21:18:29 +00003161 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003162 using namespace llvm::support;
3163 endian::Writer<little> LE(Out);
3164
Richard Smithdf8a8312015-03-13 04:05:01 +00003165 assert((uint16_t)DataLen == DataLen && (uint16_t)KeyLen == KeyLen);
Justin Bognere1c147c2014-03-28 22:03:19 +00003166 LE.write<uint16_t>(DataLen);
Douglas Gregorab4df582009-04-28 20:01:51 +00003167 // We emit the key length after the data length so that every
3168 // string is preceded by a 16-bit length. This matches the PTH
3169 // format for storing identifiers.
Justin Bognere1c147c2014-03-28 22:03:19 +00003170 LE.write<uint16_t>(KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003171 return std::make_pair(KeyLen, DataLen);
3172 }
Mike Stump11289f42009-09-09 15:08:12 +00003173
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003174 void EmitKey(raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregore84a9da2009-04-20 20:36:09 +00003175 unsigned KeyLen) {
3176 // Record the location of the key data. This is used when generating
3177 // the mapping from persistent IDs to strings.
3178 Writer.SetIdentifierOffset(II, Out.tell());
Richard Smith33e0f7e2015-07-22 02:08:40 +00003179
3180 // Emit the offset of the key/data length information to the interesting
3181 // identifiers table if necessary.
3182 if (InterestingIdentifierOffsets && isInterestingIdentifier(II))
3183 InterestingIdentifierOffsets->push_back(Out.tell() - 4);
3184
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003185 Out.write(II->getNameStart(), KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003186 }
Mike Stump11289f42009-09-09 15:08:12 +00003187
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003188 void EmitData(raw_ostream& Out, IdentifierInfo* II,
Sebastian Redl539c5062010-08-18 23:57:32 +00003189 IdentID ID, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003190 using namespace llvm::support;
3191 endian::Writer<little> LE(Out);
Richard Smithcf97cf62015-04-19 01:34:23 +00003192
Richard Smithd7329392015-04-21 21:46:32 +00003193 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3194 if (!isInterestingIdentifier(II, MacroOffset)) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003195 LE.write<uint32_t>(ID << 1);
Douglas Gregor1d583f22009-04-28 21:18:29 +00003196 return;
3197 }
Douglas Gregorb9256522009-04-28 21:32:13 +00003198
Justin Bognere1c147c2014-03-28 22:03:19 +00003199 LE.write<uint32_t>((ID << 1) | 0x01);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003200 uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID();
3201 assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
Justin Bognere1c147c2014-03-28 22:03:19 +00003202 LE.write<uint16_t>(Bits);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003203 Bits = 0;
Richard Smithd7329392015-04-21 21:46:32 +00003204 bool HadMacroDefinition = MacroOffset != 0;
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003205 Bits = (Bits << 1) | unsigned(HadMacroDefinition);
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003206 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
3207 Bits = (Bits << 1) | unsigned(II->isPoisoned());
Richard Smith9c254182015-07-19 21:41:12 +00003208 Bits = (Bits << 1) | unsigned(II->hasRevertedBuiltin());
Argyrios Kyrtzidis3084a612010-08-11 22:55:12 +00003209 Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003210 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
Justin Bognere1c147c2014-03-28 22:03:19 +00003211 LE.write<uint16_t>(Bits);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003212
Richard Smithd7329392015-04-21 21:46:32 +00003213 if (HadMacroDefinition)
3214 LE.write<uint32_t>(MacroOffset);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003215
Richard Smitha534a312015-07-21 23:54:07 +00003216 if (NeedDecls) {
3217 // Emit the declaration IDs in reverse order, because the
3218 // IdentifierResolver provides the declarations as they would be
3219 // visible (e.g., the function "stat" would come before the struct
3220 // "stat"), but the ASTReader adds declarations to the end of the list
3221 // (so we need to see the struct "stat" before the function "stat").
3222 // Only emit declarations that aren't from a chained PCH, though.
3223 SmallVector<NamedDecl *, 16> Decls(IdResolver.begin(II),
3224 IdResolver.end());
3225 for (SmallVectorImpl<NamedDecl *>::reverse_iterator D = Decls.rbegin(),
3226 DEnd = Decls.rend();
3227 D != DEnd; ++D)
3228 LE.write<uint32_t>(
3229 Writer.getDeclID(getDeclForLocalLookup(PP.getLangOpts(), *D)));
3230 }
Douglas Gregore84a9da2009-04-20 20:36:09 +00003231 }
3232};
3233} // end anonymous namespace
3234
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003235/// \brief Write the identifier table into the AST file.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003236///
3237/// The identifier table consists of a blob containing string data
3238/// (the actual identifiers themselves) and a separate "offsets" index
3239/// that maps identifier IDs to locations within the blob.
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003240void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
3241 IdentifierResolver &IdResolver,
3242 bool IsModule) {
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003243 using namespace llvm;
3244
Richard Smith33e0f7e2015-07-22 02:08:40 +00003245 RecordData InterestingIdents;
3246
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003247 // Create and write out the blob that contains the identifier
3248 // strings.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003249 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003250 llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003251 ASTIdentifierTableTrait Trait(
3252 *this, PP, IdResolver, IsModule,
3253 (getLangOpts().CPlusPlus && IsModule) ? &InterestingIdents : nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003254
Douglas Gregore6648fb2009-04-28 20:33:11 +00003255 // Look for any identifiers that were named while processing the
3256 // headers, but are otherwise not needed. We add these to the hash
3257 // table to enable checking of the predefines buffer in the case
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003258 // where the user adds new macro definitions when building the AST
Douglas Gregore6648fb2009-04-28 20:33:11 +00003259 // file.
Chandler Carruth8440c982015-03-26 23:54:15 +00003260 SmallVector<const IdentifierInfo *, 128> IIs;
Douglas Gregore6648fb2009-04-28 20:33:11 +00003261 for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
3262 IDEnd = PP.getIdentifierTable().end();
3263 ID != IDEnd; ++ID)
Chandler Carruth8440c982015-03-26 23:54:15 +00003264 IIs.push_back(ID->second);
3265 // Sort the identifiers lexicographically before getting them references so
3266 // that their order is stable.
3267 std::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>());
3268 for (const IdentifierInfo *II : IIs)
Richard Smith9c254182015-07-19 21:41:12 +00003269 if (Trait.isInterestingNonMacroIdentifier(II))
3270 getIdentifierRef(II);
Douglas Gregore6648fb2009-04-28 20:33:11 +00003271
Sebastian Redlff4a2952010-07-23 23:49:55 +00003272 // Create the on-disk hash table representation. We only store offsets
3273 // for identifiers that appear here for the first time.
3274 IdentifierOffsets.resize(NextIdentID - FirstIdentID);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003275 for (auto IdentIDPair : IdentifierIDs) {
3276 IdentifierInfo *II = const_cast<IdentifierInfo *>(IdentIDPair.first);
3277 IdentID ID = IdentIDPair.second;
3278 assert(II && "NULL identifier in identifier table");
3279 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
3280 Generator.insert(II, ID, Trait);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003281 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003282
Douglas Gregore84a9da2009-04-20 20:36:09 +00003283 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003284 SmallString<4096> IdentifierTable;
Douglas Gregora868bbd2009-04-21 22:25:48 +00003285 uint32_t BucketOffset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003286 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003287 using namespace llvm::support;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003288 llvm::raw_svector_ostream Out(IdentifierTable);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003289 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003290 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregora868bbd2009-04-21 22:25:48 +00003291 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003292 }
3293
3294 // Create a blob abbreviation
3295 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003296 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
Douglas Gregora868bbd2009-04-21 22:25:48 +00003297 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregore84a9da2009-04-20 20:36:09 +00003298 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Douglas Gregor8f45df52009-04-16 22:23:12 +00003299 unsigned IDTableAbbrev = Stream.EmitAbbrev(Abbrev);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003300
3301 // Write the identifier table
3302 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00003303 Record.push_back(IDENTIFIER_TABLE);
Douglas Gregora868bbd2009-04-21 22:25:48 +00003304 Record.push_back(BucketOffset);
Yaron Keren92e1b622015-03-18 10:17:07 +00003305 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003306 }
3307
3308 // Write the offsets table for identifier IDs.
Douglas Gregor0e149972009-04-25 19:10:14 +00003309 BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003310 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
Douglas Gregor0e149972009-04-25 19:10:14 +00003311 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
Douglas Gregor1ab036c2011-08-03 21:49:18 +00003312 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor0e149972009-04-25 19:10:14 +00003313 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3314 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
3315
Douglas Gregor8d7edce2013-02-08 21:30:59 +00003316#ifndef NDEBUG
3317 for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I)
3318 assert(IdentifierOffsets[I] && "Missing identifier offset?");
3319#endif
3320
Douglas Gregor0e149972009-04-25 19:10:14 +00003321 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00003322 Record.push_back(IDENTIFIER_OFFSET);
Douglas Gregor0e149972009-04-25 19:10:14 +00003323 Record.push_back(IdentifierOffsets.size());
Douglas Gregor1ab036c2011-08-03 21:49:18 +00003324 Record.push_back(FirstIdentID - NUM_PREDEF_IDENT_IDS);
Douglas Gregor0e149972009-04-25 19:10:14 +00003325 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00003326 bytes(IdentifierOffsets));
Richard Smith33e0f7e2015-07-22 02:08:40 +00003327
3328 // In C++, write the list of interesting identifiers (those that are
3329 // defined as macros, poisoned, or similar unusual things).
3330 if (!InterestingIdents.empty())
3331 Stream.EmitRecord(INTERESTING_IDENTIFIERS, InterestingIdents);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003332}
3333
Douglas Gregorc5046832009-04-27 18:38:38 +00003334//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003335// DeclContext's Name Lookup Table Serialization
3336//===----------------------------------------------------------------------===//
3337
3338namespace {
3339// Trait used for the on-disk hash table used in the method pool.
3340class ASTDeclContextNameLookupTrait {
3341 ASTWriter &Writer;
3342
3343public:
3344 typedef DeclarationName key_type;
3345 typedef key_type key_type_ref;
3346
3347 typedef DeclContext::lookup_result data_type;
3348 typedef const data_type& data_type_ref;
3349
Justin Bogner25463f12014-04-18 20:27:24 +00003350 typedef unsigned hash_value_type;
3351 typedef unsigned offset_type;
3352
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003353 explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) { }
3354
Justin Bogner25463f12014-04-18 20:27:24 +00003355 hash_value_type ComputeHash(DeclarationName Name) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003356 llvm::FoldingSetNodeID ID;
3357 ID.AddInteger(Name.getNameKind());
3358
3359 switch (Name.getNameKind()) {
3360 case DeclarationName::Identifier:
3361 ID.AddString(Name.getAsIdentifierInfo()->getName());
3362 break;
3363 case DeclarationName::ObjCZeroArgSelector:
3364 case DeclarationName::ObjCOneArgSelector:
3365 case DeclarationName::ObjCMultiArgSelector:
3366 ID.AddInteger(serialization::ComputeHash(Name.getObjCSelector()));
3367 break;
3368 case DeclarationName::CXXConstructorName:
3369 case DeclarationName::CXXDestructorName:
3370 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003371 break;
3372 case DeclarationName::CXXOperatorName:
3373 ID.AddInteger(Name.getCXXOverloadedOperator());
3374 break;
3375 case DeclarationName::CXXLiteralOperatorName:
3376 ID.AddString(Name.getCXXLiteralIdentifier()->getName());
3377 case DeclarationName::CXXUsingDirective:
3378 break;
3379 }
3380
3381 return ID.ComputeHash();
3382 }
3383
3384 std::pair<unsigned,unsigned>
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003385 EmitKeyDataLength(raw_ostream& Out, DeclarationName Name,
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003386 data_type_ref Lookup) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003387 using namespace llvm::support;
3388 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003389 unsigned KeyLen = 1;
3390 switch (Name.getNameKind()) {
3391 case DeclarationName::Identifier:
3392 case DeclarationName::ObjCZeroArgSelector:
3393 case DeclarationName::ObjCOneArgSelector:
3394 case DeclarationName::ObjCMultiArgSelector:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003395 case DeclarationName::CXXLiteralOperatorName:
3396 KeyLen += 4;
3397 break;
3398 case DeclarationName::CXXOperatorName:
3399 KeyLen += 1;
3400 break;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003401 case DeclarationName::CXXConstructorName:
3402 case DeclarationName::CXXDestructorName:
3403 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003404 case DeclarationName::CXXUsingDirective:
3405 break;
3406 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003407 LE.write<uint16_t>(KeyLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003408
Richard Smithf02662d2015-07-30 03:17:16 +00003409 // 4 bytes for each DeclID.
3410 unsigned DataLen = 4 * Lookup.size();
Justin Bognere1c147c2014-03-28 22:03:19 +00003411 LE.write<uint16_t>(DataLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003412
3413 return std::make_pair(KeyLen, DataLen);
3414 }
3415
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003416 void EmitKey(raw_ostream& Out, DeclarationName Name, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003417 using namespace llvm::support;
3418 endian::Writer<little> LE(Out);
3419 LE.write<uint8_t>(Name.getNameKind());
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003420 switch (Name.getNameKind()) {
3421 case DeclarationName::Identifier:
Justin Bognere1c147c2014-03-28 22:03:19 +00003422 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getAsIdentifierInfo()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003423 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003424 case DeclarationName::ObjCZeroArgSelector:
3425 case DeclarationName::ObjCOneArgSelector:
3426 case DeclarationName::ObjCMultiArgSelector:
Justin Bognere1c147c2014-03-28 22:03:19 +00003427 LE.write<uint32_t>(Writer.getSelectorRef(Name.getObjCSelector()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003428 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003429 case DeclarationName::CXXOperatorName:
Benjamin Kramer53750b12012-09-19 13:40:40 +00003430 assert(Name.getCXXOverloadedOperator() < NUM_OVERLOADED_OPERATORS &&
3431 "Invalid operator?");
Justin Bognere1c147c2014-03-28 22:03:19 +00003432 LE.write<uint8_t>(Name.getCXXOverloadedOperator());
Benjamin Kramer53750b12012-09-19 13:40:40 +00003433 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003434 case DeclarationName::CXXLiteralOperatorName:
Justin Bognere1c147c2014-03-28 22:03:19 +00003435 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getCXXLiteralIdentifier()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003436 return;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003437 case DeclarationName::CXXConstructorName:
3438 case DeclarationName::CXXDestructorName:
3439 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003440 case DeclarationName::CXXUsingDirective:
Benjamin Kramer53750b12012-09-19 13:40:40 +00003441 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003442 }
Benjamin Kramer53750b12012-09-19 13:40:40 +00003443
3444 llvm_unreachable("Invalid name kind?");
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003445 }
3446
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003447 void EmitData(raw_ostream& Out, key_type_ref,
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003448 data_type Lookup, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003449 using namespace llvm::support;
3450 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003451 uint64_t Start = Out.tell(); (void)Start;
David Blaikieff7d47a2012-12-19 00:45:41 +00003452 for (DeclContext::lookup_iterator I = Lookup.begin(), E = Lookup.end();
3453 I != E; ++I)
Richard Smithb3761912015-02-05 23:08:52 +00003454 LE.write<uint32_t>(
3455 Writer.GetDeclRef(getDeclForLocalLookup(Writer.getLangOpts(), *I)));
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003456
3457 assert(Out.tell() - Start == DataLen && "Data length is wrong");
3458 }
3459};
3460} // end anonymous namespace
3461
Chandler Carruthe972c362015-03-26 03:11:40 +00003462bool ASTWriter::isLookupResultExternal(StoredDeclsList &Result,
3463 DeclContext *DC) {
3464 return Result.hasExternalDecls() && DC->NeedToReconcileExternalVisibleStorage;
3465}
3466
3467bool ASTWriter::isLookupResultEntirelyExternal(StoredDeclsList &Result,
3468 DeclContext *DC) {
3469 for (auto *D : Result.getLookupResult())
3470 if (!getDeclForLocalLookup(getLangOpts(), D)->isFromASTFile())
3471 return false;
3472
3473 return true;
3474}
3475
Richard Smithcd45dbc2014-04-19 03:48:30 +00003476uint32_t
Chandler Carruthe972c362015-03-26 03:11:40 +00003477ASTWriter::GenerateNameLookupTable(const DeclContext *ConstDC,
Richard Smithcd45dbc2014-04-19 03:48:30 +00003478 llvm::SmallVectorImpl<char> &LookupTable) {
Chandler Carruthe972c362015-03-26 03:11:40 +00003479 assert(!ConstDC->HasLazyLocalLexicalLookups &&
3480 !ConstDC->HasLazyExternalLexicalLookups &&
Richard Smith9e2341d2015-03-23 03:25:59 +00003481 "must call buildLookups first");
Richard Smithcd45dbc2014-04-19 03:48:30 +00003482
Chandler Carruthe972c362015-03-26 03:11:40 +00003483 // FIXME: We need to build the lookups table, which is logically const.
3484 DeclContext *DC = const_cast<DeclContext*>(ConstDC);
3485 assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
3486
3487 // Create the on-disk hash table representation.
Richard Smithcd45dbc2014-04-19 03:48:30 +00003488 llvm::OnDiskChainedHashTableGenerator<ASTDeclContextNameLookupTrait>
3489 Generator;
3490 ASTDeclContextNameLookupTrait Trait(*this);
3491
Chandler Carruthe972c362015-03-26 03:11:40 +00003492 // The first step is to collect the declaration names which we need to
3493 // serialize into the name lookup table, and to collect them in a stable
3494 // order.
3495 SmallVector<DeclarationName, 16> Names;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003496
Chandler Carruthe972c362015-03-26 03:11:40 +00003497 // We also build up small sets of the constructor and conversion function
3498 // names which are visible.
3499 llvm::SmallSet<DeclarationName, 8> ConstructorNameSet, ConversionNameSet;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003500
Chandler Carruthe972c362015-03-26 03:11:40 +00003501 for (auto &Lookup : *DC->buildLookup()) {
3502 auto &Name = Lookup.first;
3503 auto &Result = Lookup.second;
3504
3505 // If there are no local declarations in our lookup result, we don't
3506 // need to write an entry for the name at all unless we're rewriting
3507 // the decl context. If we can't write out a lookup set without
3508 // performing more deserialization, just skip this entry.
3509 if (isLookupResultExternal(Result, DC) && !isRewritten(cast<Decl>(DC)) &&
3510 isLookupResultEntirelyExternal(Result, DC))
3511 continue;
3512
3513 // We also skip empty results. If any of the results could be external and
3514 // the currently available results are empty, then all of the results are
3515 // external and we skip it above. So the only way we get here with an empty
3516 // results is when no results could have been external *and* we have
3517 // external results.
3518 //
3519 // FIXME: While we might want to start emitting on-disk entries for negative
3520 // lookups into a decl context as an optimization, today we *have* to skip
3521 // them because there are names with empty lookup results in decl contexts
3522 // which we can't emit in any stable ordering: we lookup constructors and
3523 // conversion functions in the enclosing namespace scope creating empty
3524 // results for them. This in almost certainly a bug in Clang's name lookup,
3525 // but that is likely to be hard or impossible to fix and so we tolerate it
3526 // here by omitting lookups with empty results.
3527 if (Lookup.second.getLookupResult().empty())
3528 continue;
3529
3530 switch (Lookup.first.getNameKind()) {
3531 default:
3532 Names.push_back(Lookup.first);
3533 break;
3534
Richard Smithcd45dbc2014-04-19 03:48:30 +00003535 case DeclarationName::CXXConstructorName:
Chandler Carruthe972c362015-03-26 03:11:40 +00003536 assert(isa<CXXRecordDecl>(DC) &&
3537 "Cannot have a constructor name outside of a class!");
3538 ConstructorNameSet.insert(Name);
3539 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003540
3541 case DeclarationName::CXXConversionFunctionName:
Chandler Carruthe972c362015-03-26 03:11:40 +00003542 assert(isa<CXXRecordDecl>(DC) &&
3543 "Cannot have a conversion function name outside of a class!");
3544 ConversionNameSet.insert(Name);
Rafael Espindolac606b3e2015-03-25 04:43:15 +00003545 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003546 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00003547 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00003548
Chandler Carruthe972c362015-03-26 03:11:40 +00003549 // Sort the names into a stable order.
3550 std::sort(Names.begin(), Names.end());
3551
Chandler Carruthffbf7052015-03-26 22:27:09 +00003552 if (auto *D = dyn_cast<CXXRecordDecl>(DC)) {
Chandler Carruthe972c362015-03-26 03:11:40 +00003553 // We need to establish an ordering of constructor and conversion function
Chandler Carruthffbf7052015-03-26 22:27:09 +00003554 // names, and they don't have an intrinsic ordering.
Chandler Carruthe972c362015-03-26 03:11:40 +00003555
Chandler Carruthffbf7052015-03-26 22:27:09 +00003556 // First we try the easy case by forming the current context's constructor
3557 // name and adding that name first. This is a very useful optimization to
3558 // avoid walking the lexical declarations in many cases, and it also
3559 // handles the only case where a constructor name can come from some other
3560 // lexical context -- when that name is an implicit constructor merged from
3561 // another declaration in the redecl chain. Any non-implicit constructor or
3562 // conversion function which doesn't occur in all the lexical contexts
3563 // would be an ODR violation.
3564 auto ImplicitCtorName = Context->DeclarationNames.getCXXConstructorName(
3565 Context->getCanonicalType(Context->getRecordType(D)));
3566 if (ConstructorNameSet.erase(ImplicitCtorName))
3567 Names.push_back(ImplicitCtorName);
Chandler Carruthe972c362015-03-26 03:11:40 +00003568
Chandler Carruthffbf7052015-03-26 22:27:09 +00003569 // If we still have constructors or conversion functions, we walk all the
3570 // names in the decl and add the constructors and conversion functions
3571 // which are visible in the order they lexically occur within the context.
3572 if (!ConstructorNameSet.empty() || !ConversionNameSet.empty())
3573 for (Decl *ChildD : cast<CXXRecordDecl>(DC)->decls())
3574 if (auto *ChildND = dyn_cast<NamedDecl>(ChildD)) {
3575 auto Name = ChildND->getDeclName();
3576 switch (Name.getNameKind()) {
3577 default:
3578 continue;
3579
3580 case DeclarationName::CXXConstructorName:
3581 if (ConstructorNameSet.erase(Name))
3582 Names.push_back(Name);
3583 break;
3584
3585 case DeclarationName::CXXConversionFunctionName:
3586 if (ConversionNameSet.erase(Name))
3587 Names.push_back(Name);
3588 break;
3589 }
3590
3591 if (ConstructorNameSet.empty() && ConversionNameSet.empty())
3592 break;
Chandler Carruthe972c362015-03-26 03:11:40 +00003593 }
3594
Chandler Carruthe972c362015-03-26 03:11:40 +00003595 assert(ConstructorNameSet.empty() && "Failed to find all of the visible "
3596 "constructors by walking all the "
3597 "lexical members of the context.");
3598 assert(ConversionNameSet.empty() && "Failed to find all of the visible "
3599 "conversion functions by walking all "
3600 "the lexical members of the context.");
Richard Smith961eae52014-03-25 01:14:22 +00003601 }
3602
Chandler Carruthe972c362015-03-26 03:11:40 +00003603 // Next we need to do a lookup with each name into this decl context to fully
3604 // populate any results from external sources. We don't actually use the
3605 // results of these lookups because we only want to use the results after all
3606 // results have been loaded and the pointers into them will be stable.
3607 for (auto &Name : Names)
3608 DC->lookup(Name);
3609
3610 // Now we need to insert the results for each name into the hash table. For
3611 // constructor names and conversion function names, we actually need to merge
3612 // all of the results for them into one list of results each and insert
3613 // those.
3614 SmallVector<NamedDecl *, 8> ConstructorDecls;
3615 SmallVector<NamedDecl *, 8> ConversionDecls;
3616
3617 // Now loop over the names, either inserting them or appending for the two
3618 // special cases.
3619 for (auto &Name : Names) {
3620 DeclContext::lookup_result Result = DC->noload_lookup(Name);
3621
3622 switch (Name.getNameKind()) {
3623 default:
3624 Generator.insert(Name, Result, Trait);
3625 break;
3626
3627 case DeclarationName::CXXConstructorName:
3628 ConstructorDecls.append(Result.begin(), Result.end());
3629 break;
3630
3631 case DeclarationName::CXXConversionFunctionName:
3632 ConversionDecls.append(Result.begin(), Result.end());
3633 break;
3634 }
3635 }
3636
3637 // Handle our two special cases if we ended up having any. We arbitrarily use
3638 // the first declaration's name here because the name itself isn't part of
3639 // the key, only the kind of name is used.
3640 if (!ConstructorDecls.empty())
3641 Generator.insert(ConstructorDecls.front()->getDeclName(),
3642 DeclContext::lookup_result(ConstructorDecls), Trait);
3643 if (!ConversionDecls.empty())
3644 Generator.insert(ConversionDecls.front()->getDeclName(),
3645 DeclContext::lookup_result(ConversionDecls), Trait);
3646
Richard Smith961eae52014-03-25 01:14:22 +00003647 // Create the on-disk hash table in a buffer.
3648 llvm::raw_svector_ostream Out(LookupTable);
3649 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003650 using namespace llvm::support;
3651 endian::Writer<little>(Out).write<uint32_t>(0);
Richard Smith961eae52014-03-25 01:14:22 +00003652 return Generator.Emit(Out, Trait);
3653}
3654
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003655/// \brief Write the block containing all of the declaration IDs
3656/// visible from the given DeclContext.
3657///
3658/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
Sebastian Redla4071b42010-08-24 00:50:09 +00003659/// bitstream, or 0 if no block was written.
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003660uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
3661 DeclContext *DC) {
Richard Smith5fc18a92015-07-12 23:43:21 +00003662 // If we imported a key declaration of this namespace, write the visible
3663 // lookup results as an update record for it rather than including them
3664 // on this declaration. We will only look at key declarations on reload.
3665 if (isa<NamespaceDecl>(DC) && Chain &&
3666 Chain->getKeyDeclaration(cast<Decl>(DC))->isFromASTFile()) {
3667 // Only do this once, for the first local declaration of the namespace.
3668 for (NamespaceDecl *Prev = cast<NamespaceDecl>(DC)->getPreviousDecl(); Prev;
3669 Prev = Prev->getPreviousDecl())
3670 if (!Prev->isFromASTFile())
3671 return 0;
3672
3673 // Note that we need to emit an update record for the primary context.
3674 UpdatedDeclContexts.insert(DC->getPrimaryContext());
3675
3676 // Make sure all visible decls are written. They will be recorded later. We
3677 // do this using a side data structure so we can sort the names into
3678 // a deterministic order.
3679 StoredDeclsMap *Map = DC->getPrimaryContext()->buildLookup();
3680 SmallVector<std::pair<DeclarationName, DeclContext::lookup_result>, 16>
3681 LookupResults;
3682 if (Map) {
3683 LookupResults.reserve(Map->size());
3684 for (auto &Entry : *Map)
3685 LookupResults.push_back(
3686 std::make_pair(Entry.first, Entry.second.getLookupResult()));
3687 }
3688
3689 std::sort(LookupResults.begin(), LookupResults.end(), llvm::less_first());
3690 for (auto &NameAndResult : LookupResults) {
3691 DeclarationName Name = NameAndResult.first;
3692 DeclContext::lookup_result Result = NameAndResult.second;
3693 if (Name.getNameKind() == DeclarationName::CXXConstructorName ||
3694 Name.getNameKind() == DeclarationName::CXXConversionFunctionName) {
3695 // We have to work around a name lookup bug here where negative lookup
3696 // results for these names get cached in namespace lookup tables (these
3697 // names should never be looked up in a namespace).
3698 assert(Result.empty() && "Cannot have a constructor or conversion "
3699 "function name in a namespace!");
3700 continue;
3701 }
3702
3703 for (NamedDecl *ND : Result)
3704 if (!ND->isFromASTFile())
3705 GetDeclRef(ND);
3706 }
3707
3708 return 0;
3709 }
3710
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003711 if (DC->getPrimaryContext() != DC)
3712 return 0;
3713
Chandler Carruthe972c362015-03-26 03:11:40 +00003714 // Skip contexts which don't support name lookup.
3715 if (!DC->isLookupContext())
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003716 return 0;
3717
3718 // If not in C++, we perform name lookup for the translation unit via the
3719 // IdentifierInfo chains, don't bother to build a visible-declarations table.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003720 if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003721 return 0;
3722
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003723 // Serialize the contents of the mapping used for lookup. Note that,
3724 // although we have two very different code paths, the serialized
3725 // representation is the same for both cases: a declaration name,
3726 // followed by a size, followed by references to the visible
3727 // declarations that have that name.
3728 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smithf634c902012-03-16 06:12:59 +00003729 StoredDeclsMap *Map = DC->buildLookup();
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003730 if (!Map || Map->empty())
3731 return 0;
3732
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003733 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003734 SmallString<4096> LookupTable;
Richard Smith961eae52014-03-25 01:14:22 +00003735 uint32_t BucketOffset = GenerateNameLookupTable(DC, LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003736
3737 // Write the lookup table
3738 RecordData Record;
3739 Record.push_back(DECL_CONTEXT_VISIBLE);
3740 Record.push_back(BucketOffset);
3741 Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
Yaron Keren92e1b622015-03-18 10:17:07 +00003742 LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003743 ++NumVisibleDeclContexts;
3744 return Offset;
3745}
3746
Sebastian Redla4071b42010-08-24 00:50:09 +00003747/// \brief Write an UPDATE_VISIBLE block for the given context.
3748///
3749/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
3750/// DeclContext in a dependent AST file. As such, they only exist for the TU
Richard Smithf634c902012-03-16 06:12:59 +00003751/// (in C++), for namespaces, and for classes with forward-declared unscoped
3752/// enumeration members (in C++11).
Sebastian Redla4071b42010-08-24 00:50:09 +00003753void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
Richard Smith0f4e2c42015-08-06 04:23:48 +00003754 if (isRewritten(cast<Decl>(DC)))
3755 return;
3756
Richard Smith961eae52014-03-25 01:14:22 +00003757 StoredDeclsMap *Map = DC->getLookupPtr();
Sebastian Redla4071b42010-08-24 00:50:09 +00003758 if (!Map || Map->empty())
3759 return;
3760
Sebastian Redla4071b42010-08-24 00:50:09 +00003761 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003762 SmallString<4096> LookupTable;
Richard Smith961eae52014-03-25 01:14:22 +00003763 uint32_t BucketOffset = GenerateNameLookupTable(DC, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00003764
Richard Smith5fc18a92015-07-12 23:43:21 +00003765 // If we're updating a namespace, select a key declaration as the key for the
3766 // update record; those are the only ones that will be checked on reload.
3767 if (isa<NamespaceDecl>(DC))
3768 DC = cast<DeclContext>(Chain->getKeyDeclaration(cast<Decl>(DC)));
3769
Sebastian Redla4071b42010-08-24 00:50:09 +00003770 // Write the lookup table
3771 RecordData Record;
3772 Record.push_back(UPDATE_VISIBLE);
3773 Record.push_back(getDeclID(cast<Decl>(DC)));
3774 Record.push_back(BucketOffset);
Yaron Keren92e1b622015-03-18 10:17:07 +00003775 Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00003776}
3777
Peter Collingbourne5df20e02011-02-15 19:46:30 +00003778/// \brief Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
3779void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) {
3780 RecordData Record;
3781 Record.push_back(Opts.fp_contract);
3782 Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
3783}
3784
3785/// \brief Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
3786void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00003787 if (!SemaRef.Context.getLangOpts().OpenCL)
Peter Collingbourne5df20e02011-02-15 19:46:30 +00003788 return;
3789
3790 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
3791 RecordData Record;
3792#define OPENCLEXT(nm) Record.push_back(Opts.nm);
3793#include "clang/Basic/OpenCLExtensions.def"
3794 Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
3795}
3796
Douglas Gregor358cd442012-01-15 16:58:34 +00003797void ASTWriter::WriteRedeclarations() {
3798 RecordData LocalRedeclChains;
3799 SmallVector<serialization::LocalRedeclarationsInfo, 2> LocalRedeclsMap;
3800
3801 for (unsigned I = 0, N = Redeclarations.size(); I != N; ++I) {
Richard Smith5fc18a92015-07-12 23:43:21 +00003802 const Decl *Key = Redeclarations[I];
3803 assert((Chain ? Chain->getKeyDeclaration(Key) == Key
3804 : Key->isFirstDecl()) &&
3805 "not the key declaration");
3806
3807 const Decl *First = Key->getCanonicalDecl();
3808 const Decl *MostRecent = First->getMostRecentDecl();
3809
3810 assert((getDeclID(First) >= NUM_PREDEF_DECL_IDS || First == Key) &&
3811 "should not have imported key decls for predefined decl");
3812
Douglas Gregor358cd442012-01-15 16:58:34 +00003813 // If we only have a single declaration, there is no point in storing
3814 // a redeclaration chain.
3815 if (First == MostRecent)
3816 continue;
3817
3818 unsigned Offset = LocalRedeclChains.size();
3819 unsigned Size = 0;
3820 LocalRedeclChains.push_back(0); // Placeholder for the size.
Richard Smith5fc18a92015-07-12 23:43:21 +00003821
Richard Smithe2f8ce92015-07-15 00:02:40 +00003822 // Collect the set of local redeclarations of this declaration, from newest
3823 // to oldest.
Richard Smith5fc18a92015-07-12 23:43:21 +00003824 for (const Decl *Prev = MostRecent; Prev;
Douglas Gregor358cd442012-01-15 16:58:34 +00003825 Prev = Prev->getPreviousDecl()) {
Richard Smith5fc18a92015-07-12 23:43:21 +00003826 if (!Prev->isFromASTFile() && Prev != Key) {
Douglas Gregor358cd442012-01-15 16:58:34 +00003827 AddDeclRef(Prev, LocalRedeclChains);
3828 ++Size;
3829 }
3830 }
Douglas Gregor6168bd22013-02-18 15:53:43 +00003831
Douglas Gregor358cd442012-01-15 16:58:34 +00003832 LocalRedeclChains[Offset] = Size;
Richard Smith5fc18a92015-07-12 23:43:21 +00003833
Douglas Gregor6168bd22013-02-18 15:53:43 +00003834 // Add the mapping from the first ID from the AST to the set of local
3835 // declarations.
Richard Smith5fc18a92015-07-12 23:43:21 +00003836 LocalRedeclarationsInfo Info = { getDeclID(Key), Offset };
Douglas Gregor358cd442012-01-15 16:58:34 +00003837 LocalRedeclsMap.push_back(Info);
Richard Smith5fc18a92015-07-12 23:43:21 +00003838
Douglas Gregor358cd442012-01-15 16:58:34 +00003839 assert(N == Redeclarations.size() &&
3840 "Deserialized a declaration we shouldn't have");
3841 }
Richard Smith5fc18a92015-07-12 23:43:21 +00003842
Douglas Gregor358cd442012-01-15 16:58:34 +00003843 if (LocalRedeclChains.empty())
3844 return;
Richard Smith5fc18a92015-07-12 23:43:21 +00003845
Douglas Gregor358cd442012-01-15 16:58:34 +00003846 // Sort the local redeclarations map by the first declaration ID,
3847 // since the reader will be performing binary searches on this information.
3848 llvm::array_pod_sort(LocalRedeclsMap.begin(), LocalRedeclsMap.end());
3849
3850 // Emit the local redeclarations map.
3851 using namespace llvm;
3852 llvm::BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
3853 Abbrev->Add(BitCodeAbbrevOp(LOCAL_REDECLARATIONS_MAP));
3854 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
3855 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3856 unsigned AbbrevID = Stream.EmitAbbrev(Abbrev);
3857
3858 RecordData Record;
3859 Record.push_back(LOCAL_REDECLARATIONS_MAP);
3860 Record.push_back(LocalRedeclsMap.size());
3861 Stream.EmitRecordWithBlob(AbbrevID, Record,
3862 reinterpret_cast<char*>(LocalRedeclsMap.data()),
3863 LocalRedeclsMap.size() * sizeof(LocalRedeclarationsInfo));
3864
3865 // Emit the redeclaration chains.
3866 Stream.EmitRecord(LOCAL_REDECLARATIONS, LocalRedeclChains);
3867}
3868
Douglas Gregor404cdde2012-01-27 01:47:08 +00003869void ASTWriter::WriteObjCCategories() {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003870 SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
Douglas Gregor404cdde2012-01-27 01:47:08 +00003871 RecordData Categories;
3872
3873 for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
3874 unsigned Size = 0;
3875 unsigned StartIndex = Categories.size();
3876
3877 ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
3878
3879 // Allocate space for the size.
3880 Categories.push_back(0);
3881
3882 // Add the categories.
Douglas Gregor048fbfa2013-01-16 23:00:23 +00003883 for (ObjCInterfaceDecl::known_categories_iterator
3884 Cat = Class->known_categories_begin(),
3885 CatEnd = Class->known_categories_end();
3886 Cat != CatEnd; ++Cat, ++Size) {
3887 assert(getDeclID(*Cat) != 0 && "Bogus category");
3888 AddDeclRef(*Cat, Categories);
Douglas Gregor404cdde2012-01-27 01:47:08 +00003889 }
3890
3891 // Update the size.
3892 Categories[StartIndex] = Size;
3893
3894 // Record this interface -> category map.
3895 ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex };
3896 CategoriesMap.push_back(CatInfo);
3897 }
3898
3899 // Sort the categories map by the definition ID, since the reader will be
3900 // performing binary searches on this information.
3901 llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end());
3902
3903 // Emit the categories map.
3904 using namespace llvm;
3905 llvm::BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
3906 Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
3907 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
3908 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3909 unsigned AbbrevID = Stream.EmitAbbrev(Abbrev);
3910
3911 RecordData Record;
3912 Record.push_back(OBJC_CATEGORIES_MAP);
3913 Record.push_back(CategoriesMap.size());
3914 Stream.EmitRecordWithBlob(AbbrevID, Record,
3915 reinterpret_cast<char*>(CategoriesMap.data()),
3916 CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
3917
3918 // Emit the category lists.
3919 Stream.EmitRecord(OBJC_CATEGORIES, Categories);
3920}
3921
Richard Smithe40f2ba2013-08-07 21:41:30 +00003922void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
3923 Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap;
3924
3925 if (LPTMap.empty())
3926 return;
3927
3928 RecordData Record;
Chandler Carruth52cee4d2015-03-26 09:08:15 +00003929 for (auto LPTMapEntry : LPTMap) {
3930 const FunctionDecl *FD = LPTMapEntry.first;
3931 LateParsedTemplate *LPT = LPTMapEntry.second;
3932 AddDeclRef(FD, Record);
Richard Smithe40f2ba2013-08-07 21:41:30 +00003933 AddDeclRef(LPT->D, Record);
3934 Record.push_back(LPT->Toks.size());
3935
3936 for (CachedTokens::iterator TokIt = LPT->Toks.begin(),
3937 TokEnd = LPT->Toks.end();
3938 TokIt != TokEnd; ++TokIt) {
3939 AddToken(*TokIt, Record);
3940 }
3941 }
3942 Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record);
3943}
3944
Dario Domizioli13a0a382014-05-23 12:13:25 +00003945/// \brief Write the state of 'pragma clang optimize' at the end of the module.
3946void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
3947 RecordData Record;
3948 SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
3949 AddSourceLocation(PragmaLoc, Record);
3950 Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record);
3951}
3952
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003953//===----------------------------------------------------------------------===//
Douglas Gregorc5046832009-04-27 18:38:38 +00003954// General Serialization Routines
3955//===----------------------------------------------------------------------===//
3956
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00003957/// \brief Write a record containing the given attributes.
Alexander Kornienko20f6fc62012-07-09 10:04:07 +00003958void ASTWriter::WriteAttributes(ArrayRef<const Attr*> Attrs,
3959 RecordDataImpl &Record) {
Argyrios Kyrtzidis9beef8e2010-10-18 19:20:11 +00003960 Record.push_back(Attrs.size());
Alexander Kornienko20f6fc62012-07-09 10:04:07 +00003961 for (ArrayRef<const Attr *>::iterator i = Attrs.begin(),
3962 e = Attrs.end(); i != e; ++i){
3963 const Attr *A = *i;
Alexis Huntdcfba7b2010-08-18 23:23:40 +00003964 Record.push_back(A->getKind()); // FIXME: stable encoding, target attrs
Argyrios Kyrtzidis309b4c42011-09-13 16:05:58 +00003965 AddSourceRange(A->getRange(), Record);
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00003966
Alexis Huntdcfba7b2010-08-18 23:23:40 +00003967#include "clang/Serialization/AttrPCHWrite.inc"
Daniel Dunbarfc6507e2010-05-27 02:25:39 +00003968
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00003969 }
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00003970}
3971
John McCallf413f5e2013-05-03 00:10:13 +00003972void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) {
3973 AddSourceLocation(Tok.getLocation(), Record);
3974 Record.push_back(Tok.getLength());
3975
3976 // FIXME: When reading literal tokens, reconstruct the literal pointer
3977 // if it is needed.
3978 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
3979 // FIXME: Should translate token kind to a stable encoding.
3980 Record.push_back(Tok.getKind());
3981 // FIXME: Should translate token flags to a stable encoding.
3982 Record.push_back(Tok.getFlags());
3983}
3984
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003985void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00003986 Record.push_back(Str.size());
3987 Record.insert(Record.end(), Str.begin(), Str.end());
3988}
3989
Richard Smith7ed1bc92014-12-05 22:42:13 +00003990bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) {
Richard Smith54cc3c22014-12-11 20:50:24 +00003991 assert(Context && "should have context when outputting path");
Richard Smith7ed1bc92014-12-05 22:42:13 +00003992
Richard Smith54cc3c22014-12-11 20:50:24 +00003993 bool Changed =
3994 cleanPathForOutput(Context->getSourceManager().getFileManager(), Path);
Richard Smith7ed1bc92014-12-05 22:42:13 +00003995
3996 // Remove a prefix to make the path relative, if relevant.
3997 const char *PathBegin = Path.data();
3998 const char *PathPtr =
3999 adjustFilenameForRelocatableAST(PathBegin, BaseDirectory);
4000 if (PathPtr != PathBegin) {
4001 Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin));
4002 Changed = true;
4003 }
4004
4005 return Changed;
4006}
4007
4008void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) {
4009 SmallString<128> FilePath(Path);
4010 PreparePathForOutput(FilePath);
4011 AddString(FilePath, Record);
4012}
4013
4014void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataImpl &Record,
4015 StringRef Path) {
4016 SmallString<128> FilePath(Path);
4017 PreparePathForOutput(FilePath);
4018 Stream.EmitRecordWithBlob(Abbrev, Record, FilePath);
4019}
4020
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004021void ASTWriter::AddVersionTuple(const VersionTuple &Version,
4022 RecordDataImpl &Record) {
4023 Record.push_back(Version.getMajor());
David Blaikie05785d12013-02-20 22:23:23 +00004024 if (Optional<unsigned> Minor = Version.getMinor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004025 Record.push_back(*Minor + 1);
4026 else
4027 Record.push_back(0);
David Blaikie05785d12013-02-20 22:23:23 +00004028 if (Optional<unsigned> Subminor = Version.getSubminor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004029 Record.push_back(*Subminor + 1);
4030 else
4031 Record.push_back(0);
4032}
4033
Douglas Gregore84a9da2009-04-20 20:36:09 +00004034/// \brief Note that the identifier II occurs at the given offset
4035/// within the identifier table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004036void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
Sebastian Redl539c5062010-08-18 23:57:32 +00004037 IdentID ID = IdentifierIDs[II];
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004038 // Only store offsets new to this AST file. Other identifier names are looked
Sebastian Redlff4a2952010-07-23 23:49:55 +00004039 // up earlier in the chain and thus don't need an offset.
4040 if (ID >= FirstIdentID)
4041 IdentifierOffsets[ID - FirstIdentID] = Offset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00004042}
4043
Douglas Gregor95c13f52009-04-25 17:48:32 +00004044/// \brief Note that the selector Sel occurs at the given offset
4045/// within the method pool/selector table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004046void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
Douglas Gregor95c13f52009-04-25 17:48:32 +00004047 unsigned ID = SelectorIDs[Sel];
4048 assert(ID && "Unknown selector");
Sebastian Redld95a56e2010-08-04 18:21:41 +00004049 // Don't record offsets for selectors that are also available in a different
4050 // file.
4051 if (ID < FirstSelectorID)
4052 return;
4053 SelectorOffsets[ID - FirstSelectorID] = Offset;
Douglas Gregor95c13f52009-04-25 17:48:32 +00004054}
4055
Richard Smithe75ee0f2015-08-17 07:13:32 +00004056ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream, bool IncludeTimestamps)
Richard Smith01b2cb42014-07-26 06:37:51 +00004057 : Stream(Stream), Context(nullptr), PP(nullptr), Chain(nullptr),
Richard Smithe75ee0f2015-08-17 07:13:32 +00004058 WritingModule(nullptr), IncludeTimestamps(IncludeTimestamps),
4059 WritingAST(false), DoneWritingDeclsAndTypes(false),
4060 ASTHasCompilerErrors(false), FirstDeclID(NUM_PREDEF_DECL_IDS),
4061 NextDeclID(FirstDeclID), FirstTypeID(NUM_PREDEF_TYPE_IDS),
4062 NextTypeID(FirstTypeID), FirstIdentID(NUM_PREDEF_IDENT_IDS),
4063 NextIdentID(FirstIdentID), FirstMacroID(NUM_PREDEF_MACRO_IDS),
4064 NextMacroID(FirstMacroID), FirstSubmoduleID(NUM_PREDEF_SUBMODULE_IDS),
Richard Smith01b2cb42014-07-26 06:37:51 +00004065 NextSubmoduleID(FirstSubmoduleID),
4066 FirstSelectorID(NUM_PREDEF_SELECTOR_IDS), NextSelectorID(FirstSelectorID),
4067 CollectedStmts(&StmtsToEmit), NumStatements(0), NumMacros(0),
4068 NumLexicalDeclContexts(0), NumVisibleDeclContexts(0),
Richard Smithc2bb8182015-03-24 06:36:48 +00004069 NextCXXBaseSpecifiersID(1), NextCXXCtorInitializersID(1),
Richard Smithe75ee0f2015-08-17 07:13:32 +00004070 TypeExtQualAbbrev(0), TypeFunctionProtoAbbrev(0), DeclParmVarAbbrev(0),
Richard Smith01b2cb42014-07-26 06:37:51 +00004071 DeclContextLexicalAbbrev(0), DeclContextVisibleLookupAbbrev(0),
Richard Smitha27c26e2014-07-27 04:19:32 +00004072 UpdateVisibleAbbrev(0), DeclRecordAbbrev(0), DeclTypedefAbbrev(0),
Richard Smith01b2cb42014-07-26 06:37:51 +00004073 DeclVarAbbrev(0), DeclFieldAbbrev(0), DeclEnumAbbrev(0),
Richard Smitha27c26e2014-07-27 04:19:32 +00004074 DeclObjCIvarAbbrev(0), DeclCXXMethodAbbrev(0), DeclRefExprAbbrev(0),
4075 CharacterLiteralAbbrev(0), IntegerLiteralAbbrev(0),
4076 ExprImplicitCastAbbrev(0) {}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004077
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004078ASTWriter::~ASTWriter() {
Reid Kleckner588c9372014-02-19 23:44:52 +00004079 llvm::DeleteContainerSeconds(FileDeclIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004080}
4081
Richard Smithb3761912015-02-05 23:08:52 +00004082const LangOptions &ASTWriter::getLangOpts() const {
4083 assert(WritingAST && "can't determine lang opts when not writing AST");
4084 return Context->getLangOpts();
4085}
4086
Richard Smithe75ee0f2015-08-17 07:13:32 +00004087time_t ASTWriter::getTimestampForOutput(const FileEntry *E) const {
4088 return IncludeTimestamps ? E->getModificationTime() : 0;
4089}
4090
Argyrios Kyrtzidisd7c16b22012-10-31 20:59:50 +00004091void ASTWriter::WriteAST(Sema &SemaRef,
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00004092 const std::string &OutputFile,
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00004093 Module *WritingModule, StringRef isysroot,
4094 bool hasErrors) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004095 WritingAST = true;
4096
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00004097 ASTHasCompilerErrors = hasErrors;
4098
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004099 // Emit the file header.
Douglas Gregor8f45df52009-04-16 22:23:12 +00004100 Stream.Emit((unsigned)'C', 8);
4101 Stream.Emit((unsigned)'P', 8);
4102 Stream.Emit((unsigned)'C', 8);
4103 Stream.Emit((unsigned)'H', 8);
Mike Stump11289f42009-09-09 15:08:12 +00004104
Chris Lattner28fa4e62009-04-26 22:26:21 +00004105 WriteBlockInfoBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004106
Douglas Gregoreda8e122011-08-09 15:13:55 +00004107 Context = &SemaRef.Context;
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004108 PP = &SemaRef.PP;
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004109 this->WritingModule = WritingModule;
Argyrios Kyrtzidisd7c16b22012-10-31 20:59:50 +00004110 WriteASTCore(SemaRef, isysroot, OutputFile, WritingModule);
Craig Toppera13603a2014-05-22 05:54:18 +00004111 Context = nullptr;
4112 PP = nullptr;
4113 this->WritingModule = nullptr;
Richard Smith7ed1bc92014-12-05 22:42:13 +00004114 this->BaseDirectory.clear();
Craig Toppera13603a2014-05-22 05:54:18 +00004115
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004116 WritingAST = false;
Sebastian Redl143413f2010-07-12 22:02:52 +00004117}
4118
Douglas Gregora94a1542011-07-27 21:45:57 +00004119template<typename Vector>
4120static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec,
4121 ASTWriter::RecordData &Record) {
Craig Toppera13603a2014-05-22 05:54:18 +00004122 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
4123 I != E; ++I) {
Douglas Gregora94a1542011-07-27 21:45:57 +00004124 Writer.AddDeclRef(*I, Record);
4125 }
4126}
4127
Argyrios Kyrtzidisd7c16b22012-10-31 20:59:50 +00004128void ASTWriter::WriteASTCore(Sema &SemaRef,
Douglas Gregorc567ba22011-07-22 16:35:34 +00004129 StringRef isysroot,
Douglas Gregorf7a700fd2011-11-30 04:39:39 +00004130 const std::string &OutputFile,
Douglas Gregorde3ef502011-11-30 23:21:26 +00004131 Module *WritingModule) {
Sebastian Redl143413f2010-07-12 22:02:52 +00004132 using namespace llvm;
4133
Craig Toppera13603a2014-05-22 05:54:18 +00004134 bool isModule = WritingModule != nullptr;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004135
Douglas Gregorcf68c582011-12-01 22:20:10 +00004136 // Make sure that the AST reader knows to finalize itself.
4137 if (Chain)
4138 Chain->finalizeForWriting();
4139
Sebastian Redl143413f2010-07-12 22:02:52 +00004140 ASTContext &Context = SemaRef.Context;
4141 Preprocessor &PP = SemaRef.PP;
4142
Douglas Gregordab42432011-08-12 00:15:20 +00004143 // Set up predefined declaration IDs.
Richard Smith5fc18a92015-07-12 23:43:21 +00004144 auto RegisterPredefDecl = [&] (Decl *D, PredefinedDeclIDs ID) {
4145 if (D) {
4146 assert(D->isCanonicalDecl() && "predefined decl is not canonical");
4147 DeclIDs[D] = ID;
4148 if (D->getMostRecentDecl() != D)
4149 Redeclarations.push_back(D);
4150 }
4151 };
4152 RegisterPredefDecl(Context.getTranslationUnitDecl(),
4153 PREDEF_DECL_TRANSLATION_UNIT_ID);
4154 RegisterPredefDecl(Context.ObjCIdDecl, PREDEF_DECL_OBJC_ID_ID);
4155 RegisterPredefDecl(Context.ObjCSelDecl, PREDEF_DECL_OBJC_SEL_ID);
4156 RegisterPredefDecl(Context.ObjCClassDecl, PREDEF_DECL_OBJC_CLASS_ID);
4157 RegisterPredefDecl(Context.ObjCProtocolClassDecl,
4158 PREDEF_DECL_OBJC_PROTOCOL_ID);
4159 RegisterPredefDecl(Context.Int128Decl, PREDEF_DECL_INT_128_ID);
4160 RegisterPredefDecl(Context.UInt128Decl, PREDEF_DECL_UNSIGNED_INT_128_ID);
4161 RegisterPredefDecl(Context.ObjCInstanceTypeDecl,
4162 PREDEF_DECL_OBJC_INSTANCETYPE_ID);
4163 RegisterPredefDecl(Context.BuiltinVaListDecl, PREDEF_DECL_BUILTIN_VA_LIST_ID);
Richard Smith9b88a4c2015-07-27 05:40:23 +00004164 RegisterPredefDecl(Context.VaListTagDecl, PREDEF_DECL_VA_LIST_TAG);
Richard Smith5fc18a92015-07-12 23:43:21 +00004165 RegisterPredefDecl(Context.ExternCContext, PREDEF_DECL_EXTERN_C_CONTEXT_ID);
Meador Inge5d3fb222012-06-16 03:34:49 +00004166
Chris Lattner0c797362009-09-08 18:19:27 +00004167 // Build a record containing all of the tentative definitions in this file, in
Sebastian Redl35351a92010-01-31 22:27:38 +00004168 // TentativeDefinitions order. Generally, this record will be empty for
Chris Lattner0c797362009-09-08 18:19:27 +00004169 // headers.
Douglas Gregord4df8652009-04-22 22:02:47 +00004170 RecordData TentativeDefinitions;
Douglas Gregora94a1542011-07-27 21:45:57 +00004171 AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions);
Douglas Gregoreb08bd42011-07-27 20:58:46 +00004172
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004173 // Build a record containing all of the file scoped decls in this file.
4174 RecordData UnusedFileScopedDecls;
Argyrios Kyrtzidis59852362013-03-14 04:45:00 +00004175 if (!isModule)
4176 AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls,
4177 UnusedFileScopedDecls);
Sebastian Redl08aca90252010-08-05 18:21:25 +00004178
Douglas Gregor851443c2011-08-12 01:39:19 +00004179 // Build a record containing all of the delegating constructors we still need
4180 // to resolve.
Alexis Hunt27a761d2011-05-04 23:29:54 +00004181 RecordData DelegatingCtorDecls;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004182 if (!isModule)
4183 AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004184
Douglas Gregor851443c2011-08-12 01:39:19 +00004185 // Write the set of weak, undeclared identifiers. We always write the
4186 // entire table, since later PCH files in a PCH chain are only interested in
4187 // the results at the end of the chain.
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004188 RecordData WeakUndeclaredIdentifiers;
Chandler Carruthf85d9822015-03-26 08:32:49 +00004189 for (auto &WeakUndeclaredIdentifier : SemaRef.WeakUndeclaredIdentifiers) {
4190 IdentifierInfo *II = WeakUndeclaredIdentifier.first;
4191 WeakInfo &WI = WeakUndeclaredIdentifier.second;
4192 AddIdentifierRef(II, WeakUndeclaredIdentifiers);
4193 AddIdentifierRef(WI.getAlias(), WeakUndeclaredIdentifiers);
4194 AddSourceLocation(WI.getLocation(), WeakUndeclaredIdentifiers);
4195 WeakUndeclaredIdentifiers.push_back(WI.getUsed());
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004196 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004197
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004198 // Build a record containing all of the ext_vector declarations.
4199 RecordData ExtVectorDecls;
Douglas Gregorb7098a32011-07-28 00:39:29 +00004200 AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004201
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004202 // Build a record containing all of the VTable uses information.
4203 RecordData VTableUses;
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004204 if (!SemaRef.VTableUses.empty()) {
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004205 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
4206 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
4207 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
4208 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
4209 }
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004210 }
4211
Nico Weber72889432014-09-06 01:25:55 +00004212 // Build a record containing all of the UnusedLocalTypedefNameCandidates.
4213 RecordData UnusedLocalTypedefNameCandidates;
4214 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
4215 AddDeclRef(TD, UnusedLocalTypedefNameCandidates);
4216
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004217 // Build a record containing all of pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004218 RecordData PendingInstantiations;
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004219 for (std::deque<Sema::PendingImplicitInstantiation>::iterator
Chandler Carruth54080172010-08-25 08:44:16 +00004220 I = SemaRef.PendingInstantiations.begin(),
4221 N = SemaRef.PendingInstantiations.end(); I != N; ++I) {
4222 AddDeclRef(I->first, PendingInstantiations);
4223 AddSourceLocation(I->second, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004224 }
4225 assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
4226 "There are local ones at end of translation unit!");
4227
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004228 // Build a record containing some declaration references.
4229 RecordData SemaDeclRefs;
4230 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc) {
4231 AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
4232 AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
4233 }
4234
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004235 RecordData CUDASpecialDeclRefs;
4236 if (Context.getcudaConfigureCallDecl()) {
4237 AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs);
4238 }
4239
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004240 // Build a record containing all of the known namespaces.
4241 RecordData KnownNamespaces;
Nick Lewycky8334af82013-01-26 00:35:08 +00004242 for (llvm::MapVector<NamespaceDecl*, bool>::iterator
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004243 I = SemaRef.KnownNamespaces.begin(),
4244 IEnd = SemaRef.KnownNamespaces.end();
4245 I != IEnd; ++I) {
4246 if (!I->second)
4247 AddDeclRef(I->first, KnownNamespaces);
4248 }
Douglas Gregor112b9072012-10-18 05:31:06 +00004249
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004250 // Build a record of all used, undefined objects that require definitions.
4251 RecordData UndefinedButUsed;
Nick Lewyckyf0f56162013-01-31 03:23:57 +00004252
4253 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004254 SemaRef.getUndefinedButUsed(Undefined);
Nick Lewyckyf0f56162013-01-31 03:23:57 +00004255 for (SmallVectorImpl<std::pair<NamedDecl *, SourceLocation> >::iterator
4256 I = Undefined.begin(), E = Undefined.end(); I != E; ++I) {
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004257 AddDeclRef(I->first, UndefinedButUsed);
4258 AddSourceLocation(I->second, UndefinedButUsed);
Nick Lewycky8334af82013-01-26 00:35:08 +00004259 }
4260
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004261 // Build a record containing all delete-expressions that we would like to
4262 // analyze later in AST.
4263 RecordData DeleteExprsToAnalyze;
4264
4265 for (const auto &DeleteExprsInfo :
4266 SemaRef.getMismatchingDeleteExpressions()) {
4267 AddDeclRef(DeleteExprsInfo.first, DeleteExprsToAnalyze);
4268 DeleteExprsToAnalyze.push_back(DeleteExprsInfo.second.size());
4269 for (const auto &DeleteLoc : DeleteExprsInfo.second) {
4270 AddSourceLocation(DeleteLoc.first, DeleteExprsToAnalyze);
4271 DeleteExprsToAnalyze.push_back(DeleteLoc.second);
4272 }
4273 }
4274
Douglas Gregor112b9072012-10-18 05:31:06 +00004275 // Write the control block
Douglas Gregor2d302362012-10-24 16:50:34 +00004276 WriteControlBlock(PP, Context, isysroot, OutputFile);
Douglas Gregor112b9072012-10-18 05:31:06 +00004277
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004278 // Write the remaining AST contents.
Douglas Gregor652d82a2009-04-18 05:55:16 +00004279 RecordData Record;
Sebastian Redl539c5062010-08-18 23:57:32 +00004280 Stream.EnterSubblock(AST_BLOCK_ID, 5);
Douglas Gregor851443c2011-08-12 01:39:19 +00004281
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004282 // This is so that older clang versions, before the introduction
4283 // of the control block, can read and reject the newer PCH format.
4284 Record.clear();
4285 Record.push_back(VERSION_MAJOR);
4286 Stream.EmitRecord(METADATA_OLD_FORMAT, Record);
4287
Douglas Gregor851443c2011-08-12 01:39:19 +00004288 // Create a lexical update block containing all of the declarations in the
4289 // translation unit that do not come from other AST files.
4290 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
Richard Smith82f8fcd2015-08-06 22:07:25 +00004291 SmallVector<uint32_t, 128> NewGlobalKindDeclPairs;
4292 for (const auto *D : TU->noload_decls()) {
4293 if (!D->isFromASTFile()) {
4294 NewGlobalKindDeclPairs.push_back(D->getKind());
4295 NewGlobalKindDeclPairs.push_back(GetDeclRef(D));
4296 }
Douglas Gregor851443c2011-08-12 01:39:19 +00004297 }
4298
4299 llvm::BitCodeAbbrev *Abv = new llvm::BitCodeAbbrev();
4300 Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
4301 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4302 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(Abv);
4303 Record.clear();
4304 Record.push_back(TU_UPDATE_LEXICAL);
4305 Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
Richard Smith82f8fcd2015-08-06 22:07:25 +00004306 bytes(NewGlobalKindDeclPairs));
Douglas Gregor851443c2011-08-12 01:39:19 +00004307
4308 // And a visible updates block for the translation unit.
4309 Abv = new llvm::BitCodeAbbrev();
4310 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
4311 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4312 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Fixed, 32));
4313 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4314 UpdateVisibleAbbrev = Stream.EmitAbbrev(Abv);
4315 WriteDeclContextVisibleUpdate(TU);
Richard Smithf19e1272015-03-07 00:04:49 +00004316
4317 // If we have any extern "C" names, write out a visible update for them.
4318 if (Context.ExternCContext)
4319 WriteDeclContextVisibleUpdate(Context.ExternCContext);
Douglas Gregor851443c2011-08-12 01:39:19 +00004320
4321 // If the translation unit has an anonymous namespace, and we don't already
4322 // have an update block for it, write it as an update block.
Richard Smith6ef42932014-03-20 21:02:00 +00004323 // FIXME: Why do we not do this if there's already an update block?
Douglas Gregor851443c2011-08-12 01:39:19 +00004324 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
4325 ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
Richard Smith6ef42932014-03-20 21:02:00 +00004326 if (Record.empty())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004327 Record.push_back(DeclUpdate(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE, NS));
Douglas Gregor851443c2011-08-12 01:39:19 +00004328 }
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004329
Richard Smith5652c0f2014-03-21 01:48:23 +00004330 // Add update records for all mangling numbers and static local numbers.
4331 // These aren't really update records, but this is a convenient way of
4332 // tagging this rare extra data onto the declarations.
4333 for (const auto &Number : Context.MangleNumbers)
4334 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004335 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_MANGLING_NUMBER,
4336 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004337 for (const auto &Number : Context.StaticLocalNumbers)
4338 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004339 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_STATIC_LOCAL_NUMBER,
4340 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004341
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004342 // Make sure visible decls, added to DeclContexts previously loaded from
4343 // an AST file, are registered for serialization.
Craig Topper2341c0d2013-07-04 03:08:24 +00004344 for (SmallVectorImpl<const Decl *>::iterator
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004345 I = UpdatingVisibleDecls.begin(),
4346 E = UpdatingVisibleDecls.end(); I != E; ++I) {
4347 GetDeclRef(*I);
4348 }
4349
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004350 // Make sure all decls associated with an identifier are registered for
4351 // serialization.
Chandler Carruth8440c982015-03-26 23:54:15 +00004352 llvm::SmallVector<const IdentifierInfo*, 256> IIs;
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004353 for (IdentifierTable::iterator ID = PP.getIdentifierTable().begin(),
4354 IDEnd = PP.getIdentifierTable().end();
4355 ID != IDEnd; ++ID) {
4356 const IdentifierInfo *II = ID->second;
Richard Smith9ab4cce2015-03-11 00:00:51 +00004357 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
Chandler Carruth8440c982015-03-26 23:54:15 +00004358 IIs.push_back(II);
Richard Smith9ab4cce2015-03-11 00:00:51 +00004359 }
Chandler Carruth8440c982015-03-26 23:54:15 +00004360 // Sort the identifiers to visit based on their name.
4361 std::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>());
4362 for (const IdentifierInfo *II : IIs) {
Richard Smith9ab4cce2015-03-11 00:00:51 +00004363 for (IdentifierResolver::iterator D = SemaRef.IdResolver.begin(II),
4364 DEnd = SemaRef.IdResolver.end();
4365 D != DEnd; ++D) {
4366 GetDeclRef(*D);
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004367 }
4368 }
4369
Douglas Gregor5204bde2011-08-02 16:26:37 +00004370 // Form the record of special types.
4371 RecordData SpecialTypes;
Douglas Gregor5204bde2011-08-02 16:26:37 +00004372 AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004373 AddTypeRef(Context.getFILEType(), SpecialTypes);
4374 AddTypeRef(Context.getjmp_bufType(), SpecialTypes);
4375 AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes);
4376 AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes);
4377 AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004378 AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes);
Rafael Espindola6cfa82b2011-11-13 21:51:09 +00004379 AddTypeRef(Context.getucontext_tType(), SpecialTypes);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004380
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004381 if (Chain) {
4382 // Write the mapping information describing our module dependencies and how
4383 // each of those modules were mapped into our own offset/ID space, so that
4384 // the reader can build the appropriate mapping to its own offset/ID space.
4385 // The map consists solely of a blob with the following format:
4386 // *(module-name-len:i16 module-name:len*i8
4387 // source-location-offset:i32
4388 // identifier-id:i32
4389 // preprocessed-entity-id:i32
4390 // macro-definition-id:i32
Douglas Gregor253eefe2011-12-01 00:59:36 +00004391 // submodule-id:i32
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004392 // selector-id:i32
4393 // declaration-id:i32
4394 // c++-base-specifiers-id:i32
4395 // type-id:i32)
4396 //
4397 llvm::BitCodeAbbrev *Abbrev = new BitCodeAbbrev();
4398 Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
4399 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
4400 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(Abbrev);
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004401 SmallString<2048> Buffer;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004402 {
4403 llvm::raw_svector_ostream Out(Buffer);
Ben Langmuir785180e2014-10-20 16:27:30 +00004404 for (ModuleFile *M : Chain->ModuleMgr) {
Justin Bognere1c147c2014-03-28 22:03:19 +00004405 using namespace llvm::support;
4406 endian::Writer<little> LE(Out);
Ben Langmuir785180e2014-10-20 16:27:30 +00004407 StringRef FileName = M->FileName;
Justin Bognere1c147c2014-03-28 22:03:19 +00004408 LE.write<uint16_t>(FileName.size());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004409 Out.write(FileName.data(), FileName.size());
Ben Langmuirfe971d92014-08-16 04:54:18 +00004410
Ben Langmuir785180e2014-10-20 16:27:30 +00004411 // Note: if a base ID was uint max, it would not be possible to load
4412 // another module after it or have more than one entity inside it.
4413 uint32_t None = std::numeric_limits<uint32_t>::max();
4414
4415 auto writeBaseIDOrNone = [&](uint32_t BaseID, bool ShouldWrite) {
4416 assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
4417 if (ShouldWrite)
4418 LE.write<uint32_t>(BaseID);
4419 else
4420 LE.write<uint32_t>(None);
4421 };
4422
Ben Langmuirfe971d92014-08-16 04:54:18 +00004423 // These values should be unique within a chain, since they will be read
4424 // as keys into ContinuousRangeMaps.
Ben Langmuir785180e2014-10-20 16:27:30 +00004425 writeBaseIDOrNone(M->SLocEntryBaseOffset, M->LocalNumSLocEntries);
4426 writeBaseIDOrNone(M->BaseIdentifierID, M->LocalNumIdentifiers);
4427 writeBaseIDOrNone(M->BaseMacroID, M->LocalNumMacros);
4428 writeBaseIDOrNone(M->BasePreprocessedEntityID,
4429 M->NumPreprocessedEntities);
4430 writeBaseIDOrNone(M->BaseSubmoduleID, M->LocalNumSubmodules);
4431 writeBaseIDOrNone(M->BaseSelectorID, M->LocalNumSelectors);
4432 writeBaseIDOrNone(M->BaseDeclID, M->LocalNumDecls);
4433 writeBaseIDOrNone(M->BaseTypeIndex, M->LocalNumTypes);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004434 }
4435 }
4436 Record.clear();
4437 Record.push_back(MODULE_OFFSET_MAP);
4438 Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
4439 Buffer.data(), Buffer.size());
4440 }
Richard Smithb9eab6d2014-03-20 19:44:17 +00004441
Richard Smithb9eab6d2014-03-20 19:44:17 +00004442 RecordData DeclUpdatesOffsetsRecord;
4443
Richard Smith59442b42014-03-20 20:07:19 +00004444 // Keep writing types, declarations, and declaration update records
4445 // until we've emitted all of them.
Richard Smith01b2cb42014-07-26 06:37:51 +00004446 Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/5);
4447 WriteTypeAbbrevs();
4448 WriteDeclAbbrevs();
Richard Smithb9eab6d2014-03-20 19:44:17 +00004449 for (DeclsToRewriteTy::iterator I = DeclsToRewrite.begin(),
4450 E = DeclsToRewrite.end();
4451 I != E; ++I)
4452 DeclTypesToEmit.push(const_cast<Decl*>(*I));
Richard Smith59442b42014-03-20 20:07:19 +00004453 do {
4454 WriteDeclUpdatesBlocks(DeclUpdatesOffsetsRecord);
4455 while (!DeclTypesToEmit.empty()) {
4456 DeclOrType DOT = DeclTypesToEmit.front();
4457 DeclTypesToEmit.pop();
4458 if (DOT.isType())
4459 WriteType(DOT.getType());
4460 else
4461 WriteDecl(Context, DOT.getDecl());
4462 }
4463 } while (!DeclUpdates.empty());
Richard Smithb9eab6d2014-03-20 19:44:17 +00004464 Stream.ExitBlock();
4465
Richard Smithb9eab6d2014-03-20 19:44:17 +00004466 DoneWritingDeclsAndTypes = true;
4467
4468 // These things can only be done once we've written out decls and types.
4469 WriteTypeDeclOffsets();
Richard Smith5652c0f2014-03-21 01:48:23 +00004470 if (!DeclUpdatesOffsetsRecord.empty())
4471 Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord);
Richard Smithb9eab6d2014-03-20 19:44:17 +00004472 WriteCXXBaseSpecifiersOffsets();
Richard Smithc2bb8182015-03-24 06:36:48 +00004473 WriteCXXCtorInitializersOffsets();
Richard Smithb9eab6d2014-03-20 19:44:17 +00004474 WriteFileDeclIDsMap();
Richard Smith7ed1bc92014-12-05 22:42:13 +00004475 WriteSourceManagerBlock(Context.getSourceManager(), PP);
Richard Smithb9eab6d2014-03-20 19:44:17 +00004476
4477 WriteComments();
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004478 WritePreprocessor(PP, isModule);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004479 WriteHeaderSearch(PP.getHeaderSearchInfo());
Sebastian Redla19a67f2010-08-03 21:58:15 +00004480 WriteSelectors(SemaRef);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00004481 WriteReferencedSelectorsPool(SemaRef);
Richard Smith9c254182015-07-19 21:41:12 +00004482 WriteLateParsedTemplates(SemaRef);
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004483 WriteIdentifierTable(PP, SemaRef.IdResolver, isModule);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004484 WriteFPPragmaOptions(SemaRef.getFPOptions());
4485 WriteOpenCLExtensions(SemaRef);
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00004486 WritePragmaDiagnosticMappings(Context.getDiagnostics(), isModule);
Douglas Gregor652d82a2009-04-18 05:55:16 +00004487
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004488 // If we're emitting a module, write out the submodule information.
4489 if (WritingModule)
4490 WriteSubmodules(WritingModule);
4491
Douglas Gregor5204bde2011-08-02 16:26:37 +00004492 Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
4493
Douglas Gregord4df8652009-04-22 22:02:47 +00004494 // Write the record containing external, unnamed definitions.
Ben Langmuir332aafe2014-01-31 01:06:56 +00004495 if (!EagerlyDeserializedDecls.empty())
4496 Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls);
Douglas Gregord4df8652009-04-22 22:02:47 +00004497
4498 // Write the record containing tentative definitions.
4499 if (!TentativeDefinitions.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004500 Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
Douglas Gregoracfc76c2009-04-22 22:18:58 +00004501
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004502 // Write the record containing unused file scoped decls.
4503 if (!UnusedFileScopedDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004504 Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004505
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004506 // Write the record containing weak undeclared identifiers.
4507 if (!WeakUndeclaredIdentifiers.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004508 Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004509 WeakUndeclaredIdentifiers);
4510
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004511 // Write the record containing ext_vector type names.
4512 if (!ExtVectorDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004513 Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
Mike Stump11289f42009-09-09 15:08:12 +00004514
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004515 // Write the record containing VTable uses information.
4516 if (!VTableUses.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004517 Stream.EmitRecord(VTABLE_USES, VTableUses);
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004518
Nico Weber72889432014-09-06 01:25:55 +00004519 // Write the record containing potentially unused local typedefs.
4520 if (!UnusedLocalTypedefNameCandidates.empty())
4521 Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
4522 UnusedLocalTypedefNameCandidates);
4523
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004524 // Write the record containing pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004525 if (!PendingInstantiations.empty())
4526 Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004527
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004528 // Write the record containing declaration references of Sema.
4529 if (!SemaDeclRefs.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004530 Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004531
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004532 // Write the record containing CUDA-specific declaration references.
4533 if (!CUDASpecialDeclRefs.empty())
4534 Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004535
4536 // Write the delegating constructors.
4537 if (!DelegatingCtorDecls.empty())
4538 Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004539
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004540 // Write the known namespaces.
4541 if (!KnownNamespaces.empty())
4542 Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
Nick Lewycky8334af82013-01-26 00:35:08 +00004543
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004544 // Write the undefined internal functions and variables, and inline functions.
4545 if (!UndefinedButUsed.empty())
4546 Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed);
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004547
4548 if (!DeleteExprsToAnalyze.empty())
4549 Stream.EmitRecord(DELETE_EXPRS_TO_ANALYZE, DeleteExprsToAnalyze);
4550
Douglas Gregor851443c2011-08-12 01:39:19 +00004551 // Write the visible updates to DeclContexts.
Richard Smithcd45dbc2014-04-19 03:48:30 +00004552 for (auto *DC : UpdatedDeclContexts)
4553 WriteDeclContextVisibleUpdate(DC);
Douglas Gregor851443c2011-08-12 01:39:19 +00004554
Douglas Gregor959bb062011-12-03 01:15:29 +00004555 if (!WritingModule) {
4556 // Write the submodules that were imported, if any.
Aaron Ballman4f45b712014-03-21 15:22:56 +00004557 struct ModuleInfo {
4558 uint64_t ID;
4559 Module *M;
4560 ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
4561 };
Richard Smith56be7542014-03-21 00:33:59 +00004562 llvm::SmallVector<ModuleInfo, 64> Imports;
Aaron Ballmanbbc31212014-03-14 20:59:21 +00004563 for (const auto *I : Context.local_imports()) {
Douglas Gregor959bb062011-12-03 01:15:29 +00004564 assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end());
Aaron Ballman4f45b712014-03-21 15:22:56 +00004565 Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()],
4566 I->getImportedModule()));
Douglas Gregor959bb062011-12-03 01:15:29 +00004567 }
Richard Smith56be7542014-03-21 00:33:59 +00004568
4569 if (!Imports.empty()) {
4570 auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
4571 return A.ID < B.ID;
4572 };
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00004573 auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
4574 return A.ID == B.ID;
4575 };
Richard Smith56be7542014-03-21 00:33:59 +00004576
4577 // Sort and deduplicate module IDs.
4578 std::sort(Imports.begin(), Imports.end(), Cmp);
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00004579 Imports.erase(std::unique(Imports.begin(), Imports.end(), Eq),
Richard Smith56be7542014-03-21 00:33:59 +00004580 Imports.end());
4581
4582 RecordData ImportedModules;
4583 for (const auto &Import : Imports) {
4584 ImportedModules.push_back(Import.ID);
4585 // FIXME: If the module has macros imported then later has declarations
4586 // imported, this location won't be the right one as a location for the
4587 // declaration imports.
Richard Smith10434f32015-05-02 02:08:26 +00004588 AddSourceLocation(PP.getModuleImportLoc(Import.M), ImportedModules);
Richard Smith56be7542014-03-21 00:33:59 +00004589 }
4590
Douglas Gregor959bb062011-12-03 01:15:29 +00004591 Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
4592 }
Douglas Gregor0a839132011-12-03 00:59:55 +00004593 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004594
Douglas Gregor851443c2011-08-12 01:39:19 +00004595 WriteDeclReplacementsBlock();
Douglas Gregor358cd442012-01-15 16:58:34 +00004596 WriteRedeclarations();
Douglas Gregor404cdde2012-01-27 01:47:08 +00004597 WriteObjCCategories();
Dario Domizioli13a0a382014-05-23 12:13:25 +00004598 if(!WritingModule)
4599 WriteOptimizePragmaOptions(SemaRef);
Richard Smithe40f2ba2013-08-07 21:41:30 +00004600
Douglas Gregor08f01292009-04-17 22:13:46 +00004601 // Some simple statistics
Douglas Gregor652d82a2009-04-18 05:55:16 +00004602 Record.clear();
Douglas Gregor08f01292009-04-17 22:13:46 +00004603 Record.push_back(NumStatements);
Douglas Gregorc3366a52009-04-21 23:56:24 +00004604 Record.push_back(NumMacros);
Douglas Gregora57c3ab2009-04-22 22:34:57 +00004605 Record.push_back(NumLexicalDeclContexts);
4606 Record.push_back(NumVisibleDeclContexts);
Sebastian Redl539c5062010-08-18 23:57:32 +00004607 Stream.EmitRecord(STATISTICS, Record);
Douglas Gregor8f45df52009-04-16 22:23:12 +00004608 Stream.ExitBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004609}
4610
Richard Smithb9eab6d2014-03-20 19:44:17 +00004611void ASTWriter::WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord) {
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004612 if (DeclUpdates.empty())
4613 return;
4614
Richard Smith59442b42014-03-20 20:07:19 +00004615 DeclUpdateMap LocalUpdates;
4616 LocalUpdates.swap(DeclUpdates);
4617
Richard Smith6ef42932014-03-20 21:02:00 +00004618 for (auto &DeclUpdate : LocalUpdates) {
4619 const Decl *D = DeclUpdate.first;
Argyrios Kyrtzidisb97a4022011-11-12 21:07:46 +00004620 if (isRewritten(D))
Argyrios Kyrtzidis3ba70b82010-10-24 17:26:46 +00004621 continue; // The decl will be written completely,no need to store updates.
4622
Richard Smithd28ac5b2014-03-22 23:33:22 +00004623 bool HasUpdatedBody = false;
Richard Smith6ef42932014-03-20 21:02:00 +00004624 RecordData Record;
4625 for (auto &Update : DeclUpdate.second) {
4626 DeclUpdateKind Kind = (DeclUpdateKind)Update.getKind();
4627
4628 Record.push_back(Kind);
4629 switch (Kind) {
4630 case UPD_CXX_ADDED_IMPLICIT_MEMBER:
4631 case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION:
4632 case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE:
Richard Smithcd45dbc2014-04-19 03:48:30 +00004633 assert(Update.getDecl() && "no decl to add?");
Richard Smith6ef42932014-03-20 21:02:00 +00004634 Record.push_back(GetDeclRef(Update.getDecl()));
4635 break;
4636
Richard Smith4d235792014-08-07 18:53:08 +00004637 case UPD_CXX_ADDED_FUNCTION_DEFINITION:
Richard Smithd28ac5b2014-03-22 23:33:22 +00004638 // An updated body is emitted last, so that the reader doesn't need
4639 // to skip over the lazy body to reach statements for other records.
4640 Record.pop_back();
4641 HasUpdatedBody = true;
4642 break;
4643
Richard Smith4d235792014-08-07 18:53:08 +00004644 case UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER:
4645 AddSourceLocation(Update.getLoc(), Record);
4646 break;
4647
Richard Smithcd45dbc2014-04-19 03:48:30 +00004648 case UPD_CXX_INSTANTIATED_CLASS_DEFINITION: {
4649 auto *RD = cast<CXXRecordDecl>(D);
Chandler Carruth8a3d24d2015-03-26 04:27:10 +00004650 UpdatedDeclContexts.insert(RD->getPrimaryContext());
Richard Smithcd45dbc2014-04-19 03:48:30 +00004651 AddCXXDefinitionData(RD, Record);
4652 Record.push_back(WriteDeclContextLexicalBlock(
4653 *Context, const_cast<CXXRecordDecl *>(RD)));
4654
4655 // This state is sometimes updated by template instantiation, when we
4656 // switch from the specialization referring to the template declaration
4657 // to it referring to the template definition.
4658 if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
4659 Record.push_back(MSInfo->getTemplateSpecializationKind());
4660 AddSourceLocation(MSInfo->getPointOfInstantiation(), Record);
4661 } else {
4662 auto *Spec = cast<ClassTemplateSpecializationDecl>(RD);
4663 Record.push_back(Spec->getTemplateSpecializationKind());
4664 AddSourceLocation(Spec->getPointOfInstantiation(), Record);
Richard Smithdf352052014-05-22 20:59:29 +00004665
4666 // The instantiation might have been resolved to a partial
4667 // specialization. If so, record which one.
4668 auto From = Spec->getInstantiatedFrom();
4669 if (auto PartialSpec =
4670 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
4671 Record.push_back(true);
4672 AddDeclRef(PartialSpec, Record);
4673 AddTemplateArgumentList(&Spec->getTemplateInstantiationArgs(),
4674 Record);
4675 } else {
4676 Record.push_back(false);
4677 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00004678 }
4679 Record.push_back(RD->getTagKind());
4680 AddSourceLocation(RD->getLocation(), Record);
4681 AddSourceLocation(RD->getLocStart(), Record);
4682 AddSourceLocation(RD->getRBraceLoc(), Record);
4683
4684 // Instantiation may change attributes; write them all out afresh.
4685 Record.push_back(D->hasAttrs());
4686 if (Record.back())
Craig Topper8c2a2a02014-08-30 16:55:39 +00004687 WriteAttributes(llvm::makeArrayRef(D->getAttrs().begin(),
4688 D->getAttrs().size()), Record);
Richard Smithcd45dbc2014-04-19 03:48:30 +00004689
4690 // FIXME: Ensure we don't get here for explicit instantiations.
4691 break;
4692 }
4693
Richard Smithf8134002015-03-10 01:41:22 +00004694 case UPD_CXX_RESOLVED_DTOR_DELETE:
4695 AddDeclRef(Update.getDecl(), Record);
4696 break;
4697
Richard Smith564417a2014-03-20 21:47:22 +00004698 case UPD_CXX_RESOLVED_EXCEPTION_SPEC:
4699 addExceptionSpec(
4700 *this,
4701 cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>(),
4702 Record);
4703 break;
4704
Richard Smith6ef42932014-03-20 21:02:00 +00004705 case UPD_CXX_DEDUCED_RETURN_TYPE:
4706 Record.push_back(GetOrCreateTypeID(Update.getType()));
4707 break;
4708
4709 case UPD_DECL_MARKED_USED:
4710 break;
Richard Smith5652c0f2014-03-21 01:48:23 +00004711
4712 case UPD_MANGLING_NUMBER:
4713 case UPD_STATIC_LOCAL_NUMBER:
4714 Record.push_back(Update.getNumber());
4715 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00004716
Alexey Bataev97720002014-11-11 04:05:39 +00004717 case UPD_DECL_MARKED_OPENMP_THREADPRIVATE:
4718 AddSourceRange(D->getAttr<OMPThreadPrivateDeclAttr>()->getRange(),
4719 Record);
4720 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00004721
4722 case UPD_DECL_EXPORTED:
Richard Smith4caa4492015-05-15 02:34:32 +00004723 Record.push_back(getSubmoduleID(Update.getModule()));
Richard Smith65ebb4a2015-03-26 04:09:53 +00004724 break;
Alex Denisovfde64952015-06-26 05:28:36 +00004725
4726 case UPD_ADDED_ATTR_TO_RECORD:
4727 WriteAttributes(llvm::makeArrayRef(Update.getAttr()), Record);
4728 break;
Richard Smith6ef42932014-03-20 21:02:00 +00004729 }
4730 }
4731
Richard Smithd28ac5b2014-03-22 23:33:22 +00004732 if (HasUpdatedBody) {
4733 const FunctionDecl *Def = cast<FunctionDecl>(D);
Richard Smith4d235792014-08-07 18:53:08 +00004734 Record.push_back(UPD_CXX_ADDED_FUNCTION_DEFINITION);
Richard Smithd28ac5b2014-03-22 23:33:22 +00004735 Record.push_back(Def->isInlined());
4736 AddSourceLocation(Def->getInnerLocStart(), Record);
4737 AddFunctionDefinition(Def, Record);
4738 }
4739
Richard Smithcd45dbc2014-04-19 03:48:30 +00004740 OffsetsRecord.push_back(GetDeclRef(D));
4741 OffsetsRecord.push_back(Stream.GetCurrentBitNo());
4742
Richard Smith6ef42932014-03-20 21:02:00 +00004743 Stream.EmitRecord(DECL_UPDATES, Record);
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004744
Richard Smithc2bb8182015-03-24 06:36:48 +00004745 FlushPendingAfterDecl();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004746 }
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004747}
4748
Argyrios Kyrtzidis97bfda92010-10-24 17:26:43 +00004749void ASTWriter::WriteDeclReplacementsBlock() {
Sebastian Redle7c1fe62010-08-13 00:28:03 +00004750 if (ReplacedDecls.empty())
4751 return;
4752
4753 RecordData Record;
Craig Topper2341c0d2013-07-04 03:08:24 +00004754 for (SmallVectorImpl<ReplacedDeclInfo>::iterator
4755 I = ReplacedDecls.begin(), E = ReplacedDecls.end(); I != E; ++I) {
Argyrios Kyrtzidis6fb60032011-10-31 07:20:15 +00004756 Record.push_back(I->ID);
4757 Record.push_back(I->Offset);
4758 Record.push_back(I->Loc);
Sebastian Redle7c1fe62010-08-13 00:28:03 +00004759 }
Sebastian Redl539c5062010-08-18 23:57:32 +00004760 Stream.EmitRecord(DECL_REPLACEMENTS, Record);
Sebastian Redle7c1fe62010-08-13 00:28:03 +00004761}
4762
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004763void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004764 Record.push_back(Loc.getRawEncoding());
4765}
4766
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004767void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00004768 AddSourceLocation(Range.getBegin(), Record);
4769 AddSourceLocation(Range.getEnd(), Record);
4770}
4771
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004772void ASTWriter::AddAPInt(const llvm::APInt &Value, RecordDataImpl &Record) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004773 Record.push_back(Value.getBitWidth());
Benjamin Kramer25f9ea62010-09-06 23:43:28 +00004774 const uint64_t *Words = Value.getRawData();
4775 Record.append(Words, Words + Value.getNumWords());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004776}
4777
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004778void ASTWriter::AddAPSInt(const llvm::APSInt &Value, RecordDataImpl &Record) {
Douglas Gregor1daeb692009-04-13 18:14:40 +00004779 Record.push_back(Value.isUnsigned());
4780 AddAPInt(Value, Record);
4781}
4782
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004783void ASTWriter::AddAPFloat(const llvm::APFloat &Value, RecordDataImpl &Record) {
Douglas Gregore0a3a512009-04-14 21:55:33 +00004784 AddAPInt(Value.bitcastToAPInt(), Record);
4785}
4786
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004787void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004788 Record.push_back(getIdentifierRef(II));
4789}
4790
Sebastian Redl539c5062010-08-18 23:57:32 +00004791IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
Craig Toppera13603a2014-05-22 05:54:18 +00004792 if (!II)
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004793 return 0;
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00004794
Sebastian Redl539c5062010-08-18 23:57:32 +00004795 IdentID &ID = IdentifierIDs[II];
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00004796 if (ID == 0)
Sebastian Redlff4a2952010-07-23 23:49:55 +00004797 ID = NextIdentID++;
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004798 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004799}
4800
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004801MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004802 // Don't emit builtin macros like __LINE__ to the AST file unless they
4803 // have been redefined by the header (in which case they are not
4804 // isBuiltinMacro).
Craig Toppera13603a2014-05-22 05:54:18 +00004805 if (!MI || MI->isBuiltinMacro())
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004806 return 0;
4807
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004808 MacroID &ID = MacroIDs[MI];
4809 if (ID == 0) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004810 ID = NextMacroID++;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004811 MacroInfoToEmitData Info = { Name, MI, ID };
4812 MacroInfosToEmit.push_back(Info);
4813 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004814 return ID;
4815}
4816
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004817MacroID ASTWriter::getMacroID(MacroInfo *MI) {
Craig Toppera13603a2014-05-22 05:54:18 +00004818 if (!MI || MI->isBuiltinMacro())
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004819 return 0;
4820
4821 assert(MacroIDs.find(MI) != MacroIDs.end() && "Macro not emitted!");
4822 return MacroIDs[MI];
4823}
4824
4825uint64_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) {
Richard Smithd7329392015-04-21 21:46:32 +00004826 return IdentMacroDirectivesOffsetMap.lookup(Name);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004827}
4828
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004829void ASTWriter::AddSelectorRef(const Selector SelRef, RecordDataImpl &Record) {
Sebastian Redl834bb972010-08-04 17:20:04 +00004830 Record.push_back(getSelectorRef(SelRef));
4831}
4832
Sebastian Redl539c5062010-08-18 23:57:32 +00004833SelectorID ASTWriter::getSelectorRef(Selector Sel) {
Craig Toppera13603a2014-05-22 05:54:18 +00004834 if (Sel.getAsOpaquePtr() == nullptr) {
Sebastian Redl834bb972010-08-04 17:20:04 +00004835 return 0;
Steve Naroff2ddea052009-04-23 10:39:46 +00004836 }
4837
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004838 SelectorID SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00004839 if (SID == 0 && Chain) {
4840 // This might trigger a ReadSelector callback, which will set the ID for
4841 // this selector.
4842 Chain->LoadSelector(Sel);
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004843 SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00004844 }
Steve Naroff2ddea052009-04-23 10:39:46 +00004845 if (SID == 0) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00004846 SID = NextSelectorID++;
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004847 SelectorIDs[Sel] = SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00004848 }
Sebastian Redl834bb972010-08-04 17:20:04 +00004849 return SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00004850}
4851
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004852void ASTWriter::AddCXXTemporary(const CXXTemporary *Temp, RecordDataImpl &Record) {
Chris Lattnercba86142010-05-10 00:25:06 +00004853 AddDeclRef(Temp->getDestructor(), Record);
4854}
4855
Richard Smithc2bb8182015-03-24 06:36:48 +00004856void ASTWriter::AddCXXCtorInitializersRef(ArrayRef<CXXCtorInitializer *> Inits,
4857 RecordDataImpl &Record) {
4858 assert(!Inits.empty() && "Empty ctor initializer sets are not recorded");
4859 CXXCtorInitializersToWrite.push_back(
4860 QueuedCXXCtorInitializers(NextCXXCtorInitializersID, Inits));
4861 Record.push_back(NextCXXCtorInitializersID++);
4862}
4863
Douglas Gregord4c5ed02010-10-29 22:39:52 +00004864void ASTWriter::AddCXXBaseSpecifiersRef(CXXBaseSpecifier const *Bases,
Richard Smithc2bb8182015-03-24 06:36:48 +00004865 CXXBaseSpecifier const *BasesEnd,
Douglas Gregord4c5ed02010-10-29 22:39:52 +00004866 RecordDataImpl &Record) {
4867 assert(Bases != BasesEnd && "Empty base-specifier sets are not recorded");
4868 CXXBaseSpecifiersToWrite.push_back(
4869 QueuedCXXBaseSpecifiers(NextCXXBaseSpecifiersID,
4870 Bases, BasesEnd));
4871 Record.push_back(NextCXXBaseSpecifiersID++);
4872}
4873
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004874void ASTWriter::AddTemplateArgumentLocInfo(TemplateArgument::ArgKind Kind,
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004875 const TemplateArgumentLocInfo &Arg,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004876 RecordDataImpl &Record) {
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004877 switch (Kind) {
John McCall0ad16662009-10-29 08:12:44 +00004878 case TemplateArgument::Expression:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004879 AddStmt(Arg.getAsExpr());
John McCall0ad16662009-10-29 08:12:44 +00004880 break;
4881 case TemplateArgument::Type:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004882 AddTypeSourceInfo(Arg.getAsTypeSourceInfo(), Record);
John McCall0ad16662009-10-29 08:12:44 +00004883 break;
Douglas Gregor9167f8b2009-11-11 01:00:40 +00004884 case TemplateArgument::Template:
Douglas Gregor9d802122011-03-02 17:09:35 +00004885 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc(), Record);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00004886 AddSourceLocation(Arg.getTemplateNameLoc(), Record);
Douglas Gregore4ff4b52011-01-05 18:58:31 +00004887 break;
4888 case TemplateArgument::TemplateExpansion:
Douglas Gregor9d802122011-03-02 17:09:35 +00004889 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc(), Record);
Douglas Gregore4ff4b52011-01-05 18:58:31 +00004890 AddSourceLocation(Arg.getTemplateNameLoc(), Record);
Douglas Gregoreb29d182011-01-05 17:40:24 +00004891 AddSourceLocation(Arg.getTemplateEllipsisLoc(), Record);
Douglas Gregor9167f8b2009-11-11 01:00:40 +00004892 break;
John McCall0ad16662009-10-29 08:12:44 +00004893 case TemplateArgument::Null:
4894 case TemplateArgument::Integral:
4895 case TemplateArgument::Declaration:
Eli Friedmanb826a002012-09-26 02:36:12 +00004896 case TemplateArgument::NullPtr:
John McCall0ad16662009-10-29 08:12:44 +00004897 case TemplateArgument::Pack:
Eli Friedmanb826a002012-09-26 02:36:12 +00004898 // FIXME: Is this right?
John McCall0ad16662009-10-29 08:12:44 +00004899 break;
4900 }
4901}
4902
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004903void ASTWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004904 RecordDataImpl &Record) {
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004905 AddTemplateArgument(Arg.getArgument(), Record);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00004906
4907 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
4908 bool InfoHasSameExpr
4909 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
4910 Record.push_back(InfoHasSameExpr);
4911 if (InfoHasSameExpr)
4912 return; // Avoid storing the same expr twice.
4913 }
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004914 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo(),
4915 Record);
4916}
4917
Douglas Gregora9d87bc2011-02-25 00:36:19 +00004918void ASTWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo,
4919 RecordDataImpl &Record) {
Craig Toppera13603a2014-05-22 05:54:18 +00004920 if (!TInfo) {
John McCall8f115c62009-10-16 21:56:05 +00004921 AddTypeRef(QualType(), Record);
4922 return;
4923 }
4924
Douglas Gregora9d87bc2011-02-25 00:36:19 +00004925 AddTypeLoc(TInfo->getTypeLoc(), Record);
4926}
4927
4928void ASTWriter::AddTypeLoc(TypeLoc TL, RecordDataImpl &Record) {
4929 AddTypeRef(TL.getType(), Record);
4930
John McCall8f115c62009-10-16 21:56:05 +00004931 TypeLocWriter TLW(*this, Record);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00004932 for (; !TL.isNull(); TL = TL.getNextTypeLoc())
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004933 TLW.Visit(TL);
John McCall8f115c62009-10-16 21:56:05 +00004934}
4935
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004936void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
Argyrios Kyrtzidis9ab44ea2010-08-20 16:04:14 +00004937 Record.push_back(GetOrCreateTypeID(T));
4938}
4939
Richard Smith2095ffe2015-03-16 20:11:03 +00004940TypeID ASTWriter::GetOrCreateTypeID(QualType T) {
Richard Smith1fa5d642013-05-11 05:45:24 +00004941 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00004942 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
4943 if (T.isNull())
4944 return TypeIdx();
4945 assert(!T.getLocalFastQualifiers());
4946
4947 TypeIdx &Idx = TypeIdxs[T];
4948 if (Idx.getIndex() == 0) {
4949 if (DoneWritingDeclsAndTypes) {
4950 assert(0 && "New type seen after serializing all the types to emit!");
4951 return TypeIdx();
4952 }
4953
4954 // We haven't seen this type before. Assign it a new ID and put it
4955 // into the queue of types to emit.
4956 Idx = TypeIdx(NextTypeID++);
4957 DeclTypesToEmit.push(T);
4958 }
4959 return Idx;
4960 });
Argyrios Kyrtzidis082e4612010-08-20 16:04:20 +00004961}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004962
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00004963TypeID ASTWriter::getTypeID(QualType T) const {
Richard Smith1fa5d642013-05-11 05:45:24 +00004964 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00004965 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
4966 if (T.isNull())
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004967 return TypeIdx();
Richard Smith2095ffe2015-03-16 20:11:03 +00004968 assert(!T.getLocalFastQualifiers());
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004969
Richard Smith2095ffe2015-03-16 20:11:03 +00004970 TypeIdxMap::const_iterator I = TypeIdxs.find(T);
4971 assert(I != TypeIdxs.end() && "Type not emitted!");
4972 return I->second;
4973 });
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004974}
4975
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004976void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00004977 Record.push_back(GetDeclRef(D));
4978}
4979
Sebastian Redl539c5062010-08-18 23:57:32 +00004980DeclID ASTWriter::GetDeclRef(const Decl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004981 assert(WritingAST && "Cannot request a declaration ID before AST writing");
Craig Toppera13603a2014-05-22 05:54:18 +00004982
4983 if (!D) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00004984 return 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004985 }
Douglas Gregorb3163e52012-01-05 22:33:30 +00004986
4987 // If D comes from an AST file, its declaration ID is already known and
4988 // fixed.
4989 if (D->isFromASTFile())
4990 return D->getGlobalID();
4991
Douglas Gregor9b3932c2010-10-05 18:37:06 +00004992 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
Sebastian Redl539c5062010-08-18 23:57:32 +00004993 DeclID &ID = DeclIDs[D];
Mike Stump11289f42009-09-09 15:08:12 +00004994 if (ID == 0) {
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004995 if (DoneWritingDeclsAndTypes) {
4996 assert(0 && "New decl seen after serializing all the decls to emit!");
4997 return 0;
4998 }
4999
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005000 // We haven't seen this declaration before. Give it a new ID and
5001 // enqueue it in the list of declarations to emit.
Sebastian Redlff4a2952010-07-23 23:49:55 +00005002 ID = NextDeclID++;
Douglas Gregor12bfa382009-10-17 00:13:19 +00005003 DeclTypesToEmit.push(const_cast<Decl *>(D));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005004 }
5005
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005006 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005007}
5008
Sebastian Redl539c5062010-08-18 23:57:32 +00005009DeclID ASTWriter::getDeclID(const Decl *D) {
Craig Toppera13603a2014-05-22 05:54:18 +00005010 if (!D)
Douglas Gregore84a9da2009-04-20 20:36:09 +00005011 return 0;
5012
Douglas Gregorb3163e52012-01-05 22:33:30 +00005013 // If D comes from an AST file, its declaration ID is already known and
5014 // fixed.
5015 if (D->isFromASTFile())
5016 return D->getGlobalID();
5017
Douglas Gregore84a9da2009-04-20 20:36:09 +00005018 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
5019 return DeclIDs[D];
5020}
5021
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005022void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005023 assert(ID);
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005024 assert(D);
5025
5026 SourceLocation Loc = D->getLocation();
5027 if (Loc.isInvalid())
5028 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005029
5030 // We only keep track of the file-level declarations of each file.
5031 if (!D->getLexicalDeclContext()->isFileContext())
5032 return;
Argyrios Kyrtzidise1bc99e2012-02-24 19:45:46 +00005033 // FIXME: ParmVarDecls that are part of a function type of a parameter of
5034 // a function/objc method, should not have TU as lexical context.
Argyrios Kyrtzidisffe055a82012-02-24 01:12:38 +00005035 if (isa<ParmVarDecl>(D))
5036 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005037
5038 SourceManager &SM = Context->getSourceManager();
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005039 SourceLocation FileLoc = SM.getFileLoc(Loc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005040 assert(SM.isLocalSourceLocation(FileLoc));
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005041 FileID FID;
5042 unsigned Offset;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00005043 std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005044 if (FID.isInvalid())
5045 return;
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005046 assert(SM.getSLocEntry(FID).isFile());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005047
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005048 DeclIDInFileInfo *&Info = FileDeclIDs[FID];
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005049 if (!Info)
5050 Info = new DeclIDInFileInfo();
5051
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005052 std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005053 LocDeclIDsTy &Decls = Info->DeclIDs;
5054
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005055 if (Decls.empty() || Decls.back().first <= Offset) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005056 Decls.push_back(LocDecl);
5057 return;
5058 }
5059
Benjamin Kramer45025c02013-08-24 13:22:59 +00005060 LocDeclIDsTy::iterator I =
5061 std::upper_bound(Decls.begin(), Decls.end(), LocDecl, llvm::less_first());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005062
5063 Decls.insert(I, LocDecl);
5064}
5065
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005066void ASTWriter::AddDeclarationName(DeclarationName Name, RecordDataImpl &Record) {
Chris Lattner258172e2009-04-27 07:35:58 +00005067 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc.
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005068 Record.push_back(Name.getNameKind());
5069 switch (Name.getNameKind()) {
5070 case DeclarationName::Identifier:
5071 AddIdentifierRef(Name.getAsIdentifierInfo(), Record);
5072 break;
5073
5074 case DeclarationName::ObjCZeroArgSelector:
5075 case DeclarationName::ObjCOneArgSelector:
5076 case DeclarationName::ObjCMultiArgSelector:
Steve Naroff2ddea052009-04-23 10:39:46 +00005077 AddSelectorRef(Name.getObjCSelector(), Record);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005078 break;
5079
5080 case DeclarationName::CXXConstructorName:
5081 case DeclarationName::CXXDestructorName:
5082 case DeclarationName::CXXConversionFunctionName:
5083 AddTypeRef(Name.getCXXNameType(), Record);
5084 break;
5085
5086 case DeclarationName::CXXOperatorName:
5087 Record.push_back(Name.getCXXOverloadedOperator());
5088 break;
5089
Alexis Hunt3d221f22009-11-29 07:34:05 +00005090 case DeclarationName::CXXLiteralOperatorName:
5091 AddIdentifierRef(Name.getCXXLiteralIdentifier(), Record);
5092 break;
5093
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005094 case DeclarationName::CXXUsingDirective:
5095 // No extra data to emit
5096 break;
5097 }
5098}
Chris Lattnerca025db2010-05-07 21:43:38 +00005099
Richard Smithd08aeb62014-08-28 01:33:39 +00005100unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) {
5101 assert(needsAnonymousDeclarationNumber(D) &&
5102 "expected an anonymous declaration");
5103
5104 // Number the anonymous declarations within this context, if we've not
5105 // already done so.
5106 auto It = AnonymousDeclarationNumbers.find(D);
5107 if (It == AnonymousDeclarationNumbers.end()) {
Richard Smith2b560572015-02-07 03:11:11 +00005108 auto *DC = D->getLexicalDeclContext();
5109 numberAnonymousDeclsWithin(DC, [&](const NamedDecl *ND, unsigned Number) {
5110 AnonymousDeclarationNumbers[ND] = Number;
5111 });
Richard Smithd08aeb62014-08-28 01:33:39 +00005112
5113 It = AnonymousDeclarationNumbers.find(D);
5114 assert(It != AnonymousDeclarationNumbers.end() &&
5115 "declaration not found within its lexical context");
5116 }
5117
5118 return It->second;
5119}
5120
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005121void ASTWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005122 DeclarationName Name, RecordDataImpl &Record) {
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005123 switch (Name.getNameKind()) {
5124 case DeclarationName::CXXConstructorName:
5125 case DeclarationName::CXXDestructorName:
5126 case DeclarationName::CXXConversionFunctionName:
5127 AddTypeSourceInfo(DNLoc.NamedType.TInfo, Record);
5128 break;
5129
5130 case DeclarationName::CXXOperatorName:
5131 AddSourceLocation(
5132 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.BeginOpNameLoc),
5133 Record);
5134 AddSourceLocation(
5135 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc),
5136 Record);
5137 break;
5138
5139 case DeclarationName::CXXLiteralOperatorName:
5140 AddSourceLocation(
5141 SourceLocation::getFromRawEncoding(DNLoc.CXXLiteralOperatorName.OpNameLoc),
5142 Record);
5143 break;
5144
5145 case DeclarationName::Identifier:
5146 case DeclarationName::ObjCZeroArgSelector:
5147 case DeclarationName::ObjCOneArgSelector:
5148 case DeclarationName::ObjCMultiArgSelector:
5149 case DeclarationName::CXXUsingDirective:
5150 break;
5151 }
5152}
5153
5154void ASTWriter::AddDeclarationNameInfo(const DeclarationNameInfo &NameInfo,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005155 RecordDataImpl &Record) {
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005156 AddDeclarationName(NameInfo.getName(), Record);
5157 AddSourceLocation(NameInfo.getLoc(), Record);
5158 AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName(), Record);
5159}
5160
5161void ASTWriter::AddQualifierInfo(const QualifierInfo &Info,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005162 RecordDataImpl &Record) {
Douglas Gregor14454802011-02-25 02:25:35 +00005163 AddNestedNameSpecifierLoc(Info.QualifierLoc, Record);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005164 Record.push_back(Info.NumTemplParamLists);
5165 for (unsigned i=0, e=Info.NumTemplParamLists; i != e; ++i)
5166 AddTemplateParameterList(Info.TemplParamLists[i], Record);
5167}
5168
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005169void ASTWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005170 RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005171 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005172 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005173 SmallVector<NestedNameSpecifier *, 8> NestedNames;
Chris Lattnerca025db2010-05-07 21:43:38 +00005174
5175 // Push each of the NNS's onto a stack for serialization in reverse order.
5176 while (NNS) {
5177 NestedNames.push_back(NNS);
5178 NNS = NNS->getPrefix();
5179 }
5180
5181 Record.push_back(NestedNames.size());
5182 while(!NestedNames.empty()) {
5183 NNS = NestedNames.pop_back_val();
5184 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
5185 Record.push_back(Kind);
5186 switch (Kind) {
5187 case NestedNameSpecifier::Identifier:
5188 AddIdentifierRef(NNS->getAsIdentifier(), Record);
5189 break;
5190
5191 case NestedNameSpecifier::Namespace:
5192 AddDeclRef(NNS->getAsNamespace(), Record);
5193 break;
5194
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005195 case NestedNameSpecifier::NamespaceAlias:
5196 AddDeclRef(NNS->getAsNamespaceAlias(), Record);
5197 break;
5198
Chris Lattnerca025db2010-05-07 21:43:38 +00005199 case NestedNameSpecifier::TypeSpec:
5200 case NestedNameSpecifier::TypeSpecWithTemplate:
5201 AddTypeRef(QualType(NNS->getAsType(), 0), Record);
5202 Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5203 break;
5204
5205 case NestedNameSpecifier::Global:
5206 // Don't need to write an associated value.
5207 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005208
5209 case NestedNameSpecifier::Super:
5210 AddDeclRef(NNS->getAsRecordDecl(), Record);
5211 break;
Chris Lattnerca025db2010-05-07 21:43:38 +00005212 }
5213 }
5214}
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005215
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005216void ASTWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS,
5217 RecordDataImpl &Record) {
5218 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005219 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005220 SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005221
5222 // Push each of the nested-name-specifiers's onto a stack for
5223 // serialization in reverse order.
5224 while (NNS) {
5225 NestedNames.push_back(NNS);
5226 NNS = NNS.getPrefix();
5227 }
5228
5229 Record.push_back(NestedNames.size());
5230 while(!NestedNames.empty()) {
5231 NNS = NestedNames.pop_back_val();
5232 NestedNameSpecifier::SpecifierKind Kind
5233 = NNS.getNestedNameSpecifier()->getKind();
5234 Record.push_back(Kind);
5235 switch (Kind) {
5236 case NestedNameSpecifier::Identifier:
5237 AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier(), Record);
5238 AddSourceRange(NNS.getLocalSourceRange(), Record);
5239 break;
5240
5241 case NestedNameSpecifier::Namespace:
5242 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace(), Record);
5243 AddSourceRange(NNS.getLocalSourceRange(), Record);
5244 break;
5245
5246 case NestedNameSpecifier::NamespaceAlias:
5247 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias(), Record);
5248 AddSourceRange(NNS.getLocalSourceRange(), Record);
5249 break;
5250
5251 case NestedNameSpecifier::TypeSpec:
5252 case NestedNameSpecifier::TypeSpecWithTemplate:
5253 Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5254 AddTypeLoc(NNS.getTypeLoc(), Record);
5255 AddSourceLocation(NNS.getLocalSourceRange().getEnd(), Record);
5256 break;
5257
5258 case NestedNameSpecifier::Global:
5259 AddSourceLocation(NNS.getLocalSourceRange().getEnd(), Record);
5260 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005261
5262 case NestedNameSpecifier::Super:
5263 AddDeclRef(NNS.getNestedNameSpecifier()->getAsRecordDecl(), Record);
5264 AddSourceRange(NNS.getLocalSourceRange(), Record);
5265 break;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005266 }
5267 }
5268}
5269
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005270void ASTWriter::AddTemplateName(TemplateName Name, RecordDataImpl &Record) {
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005271 TemplateName::NameKind Kind = Name.getKind();
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005272 Record.push_back(Kind);
5273 switch (Kind) {
5274 case TemplateName::Template:
5275 AddDeclRef(Name.getAsTemplateDecl(), Record);
5276 break;
5277
5278 case TemplateName::OverloadedTemplate: {
5279 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
5280 Record.push_back(OvT->size());
5281 for (OverloadedTemplateStorage::iterator I = OvT->begin(), E = OvT->end();
5282 I != E; ++I)
5283 AddDeclRef(*I, Record);
5284 break;
5285 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005286
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005287 case TemplateName::QualifiedTemplate: {
5288 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
5289 AddNestedNameSpecifier(QualT->getQualifier(), Record);
5290 Record.push_back(QualT->hasTemplateKeyword());
5291 AddDeclRef(QualT->getTemplateDecl(), Record);
5292 break;
5293 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005294
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005295 case TemplateName::DependentTemplate: {
5296 DependentTemplateName *DepT = Name.getAsDependentTemplateName();
5297 AddNestedNameSpecifier(DepT->getQualifier(), Record);
5298 Record.push_back(DepT->isIdentifier());
5299 if (DepT->isIdentifier())
5300 AddIdentifierRef(DepT->getIdentifier(), Record);
5301 else
5302 Record.push_back(DepT->getOperator());
5303 break;
5304 }
John McCalld9dfe3a2011-06-30 08:33:18 +00005305
5306 case TemplateName::SubstTemplateTemplateParm: {
5307 SubstTemplateTemplateParmStorage *subst
5308 = Name.getAsSubstTemplateTemplateParm();
5309 AddDeclRef(subst->getParameter(), Record);
5310 AddTemplateName(subst->getReplacement(), Record);
5311 break;
5312 }
Douglas Gregor5590be02011-01-15 06:45:20 +00005313
5314 case TemplateName::SubstTemplateTemplateParmPack: {
5315 SubstTemplateTemplateParmPackStorage *SubstPack
5316 = Name.getAsSubstTemplateTemplateParmPack();
5317 AddDeclRef(SubstPack->getParameterPack(), Record);
5318 AddTemplateArgument(SubstPack->getArgumentPack(), Record);
5319 break;
5320 }
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005321 }
5322}
5323
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005324void ASTWriter::AddTemplateArgument(const TemplateArgument &Arg,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005325 RecordDataImpl &Record) {
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005326 Record.push_back(Arg.getKind());
5327 switch (Arg.getKind()) {
5328 case TemplateArgument::Null:
5329 break;
5330 case TemplateArgument::Type:
5331 AddTypeRef(Arg.getAsType(), Record);
5332 break;
5333 case TemplateArgument::Declaration:
5334 AddDeclRef(Arg.getAsDecl(), Record);
David Blaikie952a9b12014-10-17 18:00:12 +00005335 AddTypeRef(Arg.getParamTypeForDecl(), Record);
Eli Friedmanb826a002012-09-26 02:36:12 +00005336 break;
5337 case TemplateArgument::NullPtr:
5338 AddTypeRef(Arg.getNullPtrType(), Record);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005339 break;
5340 case TemplateArgument::Integral:
Benjamin Kramer6003ad52012-06-07 15:09:51 +00005341 AddAPSInt(Arg.getAsIntegral(), Record);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005342 AddTypeRef(Arg.getIntegralType(), Record);
5343 break;
5344 case TemplateArgument::Template:
Douglas Gregore1d60df2011-01-14 23:41:42 +00005345 AddTemplateName(Arg.getAsTemplateOrTemplatePattern(), Record);
5346 break;
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005347 case TemplateArgument::TemplateExpansion:
5348 AddTemplateName(Arg.getAsTemplateOrTemplatePattern(), Record);
David Blaikie05785d12013-02-20 22:23:23 +00005349 if (Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions())
Douglas Gregore1d60df2011-01-14 23:41:42 +00005350 Record.push_back(*NumExpansions + 1);
5351 else
5352 Record.push_back(0);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005353 break;
5354 case TemplateArgument::Expression:
5355 AddStmt(Arg.getAsExpr());
5356 break;
5357 case TemplateArgument::Pack:
5358 Record.push_back(Arg.pack_size());
Aaron Ballman2a89e852014-07-15 21:32:31 +00005359 for (const auto &P : Arg.pack_elements())
5360 AddTemplateArgument(P, Record);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005361 break;
5362 }
5363}
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005364
5365void
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005366ASTWriter::AddTemplateParameterList(const TemplateParameterList *TemplateParams,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005367 RecordDataImpl &Record) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005368 assert(TemplateParams && "No TemplateParams!");
5369 AddSourceLocation(TemplateParams->getTemplateLoc(), Record);
5370 AddSourceLocation(TemplateParams->getLAngleLoc(), Record);
5371 AddSourceLocation(TemplateParams->getRAngleLoc(), Record);
5372 Record.push_back(TemplateParams->size());
5373 for (TemplateParameterList::const_iterator
5374 P = TemplateParams->begin(), PEnd = TemplateParams->end();
5375 P != PEnd; ++P)
5376 AddDeclRef(*P, Record);
5377}
5378
5379/// \brief Emit a template argument list.
5380void
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005381ASTWriter::AddTemplateArgumentList(const TemplateArgumentList *TemplateArgs,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005382 RecordDataImpl &Record) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005383 assert(TemplateArgs && "No TemplateArgs!");
Douglas Gregor1ccc8412010-11-07 23:05:16 +00005384 Record.push_back(TemplateArgs->size());
5385 for (int i=0, e = TemplateArgs->size(); i != e; ++i)
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005386 AddTemplateArgument(TemplateArgs->get(i), Record);
5387}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005388
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005389void
5390ASTWriter::AddASTTemplateArgumentListInfo
5391(const ASTTemplateArgumentListInfo *ASTTemplArgList, RecordDataImpl &Record) {
5392 assert(ASTTemplArgList && "No ASTTemplArgList!");
5393 AddSourceLocation(ASTTemplArgList->LAngleLoc, Record);
5394 AddSourceLocation(ASTTemplArgList->RAngleLoc, Record);
5395 Record.push_back(ASTTemplArgList->NumTemplateArgs);
5396 const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
5397 for (int i=0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
5398 AddTemplateArgumentLoc(TemplArgs[i], Record);
5399}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005400
5401void
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00005402ASTWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set, RecordDataImpl &Record) {
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005403 Record.push_back(Set.size());
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00005404 for (ASTUnresolvedSet::const_iterator
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005405 I = Set.begin(), E = Set.end(); I != E; ++I) {
5406 AddDeclRef(I.getDecl(), Record);
5407 Record.push_back(I.getAccess());
5408 }
5409}
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005410
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005411void ASTWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005412 RecordDataImpl &Record) {
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005413 Record.push_back(Base.isVirtual());
5414 Record.push_back(Base.isBaseOfClass());
5415 Record.push_back(Base.getAccessSpecifierAsWritten());
Sebastian Redl08905022011-02-05 19:23:19 +00005416 Record.push_back(Base.getInheritConstructors());
Nick Lewycky19b9f952010-07-26 16:56:01 +00005417 AddTypeSourceInfo(Base.getTypeSourceInfo(), Record);
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005418 AddSourceRange(Base.getSourceRange(), Record);
Douglas Gregor752a5952011-01-03 22:36:02 +00005419 AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
5420 : SourceLocation(),
5421 Record);
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005422}
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00005423
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005424void ASTWriter::FlushCXXBaseSpecifiers() {
5425 RecordData Record;
Richard Smithc2bb8182015-03-24 06:36:48 +00005426 unsigned N = CXXBaseSpecifiersToWrite.size();
5427 for (unsigned I = 0; I != N; ++I) {
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005428 Record.clear();
5429
5430 // Record the offset of this base-specifier set.
Douglas Gregorc27b2872011-08-04 00:01:48 +00005431 unsigned Index = CXXBaseSpecifiersToWrite[I].ID - 1;
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005432 if (Index == CXXBaseSpecifiersOffsets.size())
5433 CXXBaseSpecifiersOffsets.push_back(Stream.GetCurrentBitNo());
5434 else {
5435 if (Index > CXXBaseSpecifiersOffsets.size())
5436 CXXBaseSpecifiersOffsets.resize(Index + 1);
5437 CXXBaseSpecifiersOffsets[Index] = Stream.GetCurrentBitNo();
5438 }
5439
5440 const CXXBaseSpecifier *B = CXXBaseSpecifiersToWrite[I].Bases,
5441 *BEnd = CXXBaseSpecifiersToWrite[I].BasesEnd;
5442 Record.push_back(BEnd - B);
5443 for (; B != BEnd; ++B)
5444 AddCXXBaseSpecifier(*B, Record);
5445 Stream.EmitRecord(serialization::DECL_CXX_BASE_SPECIFIERS, Record);
Douglas Gregord5853042010-10-30 04:28:16 +00005446
5447 // Flush any expressions that were written as part of the base specifiers.
5448 FlushStmts();
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005449 }
5450
Richard Smithc2bb8182015-03-24 06:36:48 +00005451 assert(N == CXXBaseSpecifiersToWrite.size() &&
5452 "added more base specifiers while writing base specifiers");
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005453 CXXBaseSpecifiersToWrite.clear();
5454}
5455
Alexis Hunt1d792652011-01-08 20:30:50 +00005456void ASTWriter::AddCXXCtorInitializers(
5457 const CXXCtorInitializer * const *CtorInitializers,
5458 unsigned NumCtorInitializers,
5459 RecordDataImpl &Record) {
5460 Record.push_back(NumCtorInitializers);
5461 for (unsigned i=0; i != NumCtorInitializers; ++i) {
5462 const CXXCtorInitializer *Init = CtorInitializers[i];
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005463
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005464 if (Init->isBaseInitializer()) {
Alexis Hunt37a477f2011-05-04 01:19:08 +00005465 Record.push_back(CTOR_INITIALIZER_BASE);
Douglas Gregord73f3dd2011-11-01 01:16:03 +00005466 AddTypeSourceInfo(Init->getTypeSourceInfo(), Record);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005467 Record.push_back(Init->isBaseVirtual());
Alexis Hunt37a477f2011-05-04 01:19:08 +00005468 } else if (Init->isDelegatingInitializer()) {
5469 Record.push_back(CTOR_INITIALIZER_DELEGATING);
Douglas Gregord73f3dd2011-11-01 01:16:03 +00005470 AddTypeSourceInfo(Init->getTypeSourceInfo(), Record);
Alexis Hunt37a477f2011-05-04 01:19:08 +00005471 } else if (Init->isMemberInitializer()){
5472 Record.push_back(CTOR_INITIALIZER_MEMBER);
5473 AddDeclRef(Init->getMember(), Record);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005474 } else {
Alexis Hunt37a477f2011-05-04 01:19:08 +00005475 Record.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER);
5476 AddDeclRef(Init->getIndirectMember(), Record);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005477 }
Francois Pichetd583da02010-12-04 09:14:42 +00005478
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005479 AddSourceLocation(Init->getMemberLocation(), Record);
5480 AddStmt(Init->getInit());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005481 AddSourceLocation(Init->getLParenLoc(), Record);
5482 AddSourceLocation(Init->getRParenLoc(), Record);
5483 Record.push_back(Init->isWritten());
5484 if (Init->isWritten()) {
5485 Record.push_back(Init->getSourceOrder());
5486 } else {
5487 Record.push_back(Init->getNumArrayIndices());
5488 for (unsigned i=0, e=Init->getNumArrayIndices(); i != e; ++i)
5489 AddDeclRef(Init->getArrayIndex(i), Record);
5490 }
5491 }
5492}
5493
Richard Smithc2bb8182015-03-24 06:36:48 +00005494void ASTWriter::FlushCXXCtorInitializers() {
5495 RecordData Record;
5496
5497 unsigned N = CXXCtorInitializersToWrite.size();
Daniel Jasperc77b0a12015-03-24 08:06:38 +00005498 (void)N; // Silence unused warning in non-assert builds.
Richard Smithc2bb8182015-03-24 06:36:48 +00005499 for (auto &Init : CXXCtorInitializersToWrite) {
5500 Record.clear();
5501
5502 // Record the offset of this mem-initializer list.
5503 unsigned Index = Init.ID - 1;
5504 if (Index == CXXCtorInitializersOffsets.size())
5505 CXXCtorInitializersOffsets.push_back(Stream.GetCurrentBitNo());
5506 else {
5507 if (Index > CXXCtorInitializersOffsets.size())
5508 CXXCtorInitializersOffsets.resize(Index + 1);
5509 CXXCtorInitializersOffsets[Index] = Stream.GetCurrentBitNo();
5510 }
5511
5512 AddCXXCtorInitializers(Init.Inits.data(), Init.Inits.size(), Record);
5513 Stream.EmitRecord(serialization::DECL_CXX_CTOR_INITIALIZERS, Record);
5514
5515 // Flush any expressions that were written as part of the initializers.
5516 FlushStmts();
5517 }
5518
5519 assert(N == CXXCtorInitializersToWrite.size() &&
5520 "added more ctor initializers while writing ctor initializers");
5521 CXXCtorInitializersToWrite.clear();
5522}
5523
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005524void ASTWriter::AddCXXDefinitionData(const CXXRecordDecl *D, RecordDataImpl &Record) {
Richard Smith053f6c62014-05-16 23:01:30 +00005525 auto &Data = D->data();
Douglas Gregor99ae8062012-02-14 17:54:36 +00005526 Record.push_back(Data.IsLambda);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005527 Record.push_back(Data.UserDeclaredConstructor);
Richard Smith328aae52012-11-30 05:11:39 +00005528 Record.push_back(Data.UserDeclaredSpecialMembers);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005529 Record.push_back(Data.Aggregate);
5530 Record.push_back(Data.PlainOldData);
5531 Record.push_back(Data.Empty);
5532 Record.push_back(Data.Polymorphic);
5533 Record.push_back(Data.Abstract);
Chandler Carruth583edf82011-04-30 10:07:30 +00005534 Record.push_back(Data.IsStandardLayout);
Chandler Carruthb1963742011-04-30 09:17:45 +00005535 Record.push_back(Data.HasNoNonEmptyBases);
5536 Record.push_back(Data.HasPrivateFields);
5537 Record.push_back(Data.HasProtectedFields);
5538 Record.push_back(Data.HasPublicFields);
Douglas Gregor61226d32011-05-13 01:05:07 +00005539 Record.push_back(Data.HasMutableFields);
Richard Smithab44d5b2013-12-10 08:25:00 +00005540 Record.push_back(Data.HasVariantMembers);
Richard Smith561fb152012-02-25 07:33:38 +00005541 Record.push_back(Data.HasOnlyCMembers);
Richard Smithe2648ba2012-05-07 01:07:30 +00005542 Record.push_back(Data.HasInClassInitializer);
Richard Smith593f9932012-12-08 02:01:17 +00005543 Record.push_back(Data.HasUninitializedReferenceMember);
Richard Smith6b02d462012-12-08 08:32:28 +00005544 Record.push_back(Data.NeedOverloadResolutionForMoveConstructor);
5545 Record.push_back(Data.NeedOverloadResolutionForMoveAssignment);
5546 Record.push_back(Data.NeedOverloadResolutionForDestructor);
5547 Record.push_back(Data.DefaultedMoveConstructorIsDeleted);
5548 Record.push_back(Data.DefaultedMoveAssignmentIsDeleted);
5549 Record.push_back(Data.DefaultedDestructorIsDeleted);
Richard Smith328aae52012-11-30 05:11:39 +00005550 Record.push_back(Data.HasTrivialSpecialMembers);
Richard Smithb45a6f72014-04-17 20:33:01 +00005551 Record.push_back(Data.DeclaredNonTrivialSpecialMembers);
Richard Smith328aae52012-11-30 05:11:39 +00005552 Record.push_back(Data.HasIrrelevantDestructor);
Richard Smith111af8d2011-08-10 18:11:37 +00005553 Record.push_back(Data.HasConstexprNonCopyMoveConstructor);
Richard Smith561fb152012-02-25 07:33:38 +00005554 Record.push_back(Data.DefaultedDefaultConstructorIsConstexpr);
Richard Smith561fb152012-02-25 07:33:38 +00005555 Record.push_back(Data.HasConstexprDefaultConstructor);
Chandler Carruthe71d0622011-04-24 02:49:34 +00005556 Record.push_back(Data.HasNonLiteralTypeFieldsOrBases);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005557 Record.push_back(Data.ComputedVisibleConversions);
Alexis Huntea6f0322011-05-11 22:34:38 +00005558 Record.push_back(Data.UserProvidedDefaultConstructor);
Richard Smith328aae52012-11-30 05:11:39 +00005559 Record.push_back(Data.DeclaredSpecialMembers);
Richard Smith1c33fe82012-11-28 06:23:12 +00005560 Record.push_back(Data.ImplicitCopyConstructorHasConstParam);
5561 Record.push_back(Data.ImplicitCopyAssignmentHasConstParam);
5562 Record.push_back(Data.HasDeclaredCopyConstructorWithConstParam);
5563 Record.push_back(Data.HasDeclaredCopyAssignmentWithConstParam);
Richard Smith561fb152012-02-25 07:33:38 +00005564 // IsLambda bit is already saved.
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005565
5566 Record.push_back(Data.NumBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005567 if (Data.NumBases > 0)
5568 AddCXXBaseSpecifiersRef(Data.getBases(), Data.getBases() + Data.NumBases,
5569 Record);
5570
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005571 // FIXME: Make VBases lazily computed when needed to avoid storing them.
5572 Record.push_back(Data.NumVBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005573 if (Data.NumVBases > 0)
5574 AddCXXBaseSpecifiersRef(Data.getVBases(), Data.getVBases() + Data.NumVBases,
5575 Record);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005576
Richard Smitha4ba74c2013-08-30 04:46:40 +00005577 AddUnresolvedSet(Data.Conversions.get(*Context), Record);
5578 AddUnresolvedSet(Data.VisibleConversions.get(*Context), Record);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005579 // Data.Definition is the owning decl, no need to write it.
Richard Smith68ad0e72013-06-26 02:41:25 +00005580 AddDeclRef(D->getFirstFriend(), Record);
Douglas Gregor99ae8062012-02-14 17:54:36 +00005581
5582 // Add lambda-specific data.
5583 if (Data.IsLambda) {
Richard Smith053f6c62014-05-16 23:01:30 +00005584 auto &Lambda = D->getLambdaData();
Douglas Gregor680e9e02012-02-21 19:11:17 +00005585 Record.push_back(Lambda.Dependent);
Faisal Valic1a6dc42013-10-23 16:10:50 +00005586 Record.push_back(Lambda.IsGenericLambda);
5587 Record.push_back(Lambda.CaptureDefault);
Douglas Gregor99ae8062012-02-14 17:54:36 +00005588 Record.push_back(Lambda.NumCaptures);
5589 Record.push_back(Lambda.NumExplicitCaptures);
Douglas Gregor63798542012-02-20 19:44:39 +00005590 Record.push_back(Lambda.ManglingNumber);
Douglas Gregor7fcbd902012-02-21 00:37:24 +00005591 AddDeclRef(Lambda.ContextDecl, Record);
Eli Friedmand564afb2012-09-19 01:18:11 +00005592 AddTypeSourceInfo(Lambda.MethodTyInfo, Record);
Douglas Gregor99ae8062012-02-14 17:54:36 +00005593 for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00005594 const LambdaCapture &Capture = Lambda.Captures[I];
Douglas Gregor99ae8062012-02-14 17:54:36 +00005595 AddSourceLocation(Capture.getLocation(), Record);
5596 Record.push_back(Capture.isImplicit());
Richard Smithba71c082013-05-16 06:20:58 +00005597 Record.push_back(Capture.getCaptureKind());
5598 switch (Capture.getCaptureKind()) {
5599 case LCK_This:
Alexey Bataev39c81e22014-08-28 04:28:19 +00005600 case LCK_VLAType:
Richard Smithba71c082013-05-16 06:20:58 +00005601 break;
5602 case LCK_ByCopy:
Richard Smithbb13c9a2013-09-28 04:02:39 +00005603 case LCK_ByRef:
Richard Smithba71c082013-05-16 06:20:58 +00005604 VarDecl *Var =
Craig Toppera13603a2014-05-22 05:54:18 +00005605 Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
Richard Smithba71c082013-05-16 06:20:58 +00005606 AddDeclRef(Var, Record);
5607 AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc()
5608 : SourceLocation(),
5609 Record);
5610 break;
5611 }
Douglas Gregor99ae8062012-02-14 17:54:36 +00005612 }
5613 }
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005614}
5615
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005616void ASTWriter::ReaderInitialized(ASTReader *Reader) {
Sebastian Redl07a89a82010-07-30 00:29:29 +00005617 assert(Reader && "Cannot remove chain");
Douglas Gregordf0c1512011-08-18 04:12:04 +00005618 assert((!Chain || Chain == Reader) && "Cannot replace chain");
Sebastian Redl07a89a82010-07-30 00:29:29 +00005619 assert(FirstDeclID == NextDeclID &&
5620 FirstTypeID == NextTypeID &&
5621 FirstIdentID == NextIdentID &&
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005622 FirstMacroID == NextMacroID &&
Douglas Gregor253eefe2011-12-01 00:59:36 +00005623 FirstSubmoduleID == NextSubmoduleID &&
Sebastian Redld95a56e2010-08-04 18:21:41 +00005624 FirstSelectorID == NextSelectorID &&
Sebastian Redl07a89a82010-07-30 00:29:29 +00005625 "Setting chain after writing has started.");
Douglas Gregor925296b2011-07-19 16:10:42 +00005626
Sebastian Redl07a89a82010-07-30 00:29:29 +00005627 Chain = Reader;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005628
Richard Smith7f330cd2015-03-18 01:42:29 +00005629 // Note, this will get called multiple times, once one the reader starts up
5630 // and again each time it's done reading a PCH or module.
Douglas Gregordf0c1512011-08-18 04:12:04 +00005631 FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls();
5632 FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes();
5633 FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005634 FirstMacroID = NUM_PREDEF_MACRO_IDS + Chain->getTotalNumMacros();
Douglas Gregor253eefe2011-12-01 00:59:36 +00005635 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
Douglas Gregordf0c1512011-08-18 04:12:04 +00005636 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005637 NextDeclID = FirstDeclID;
5638 NextTypeID = FirstTypeID;
5639 NextIdentID = FirstIdentID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005640 NextMacroID = FirstMacroID;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005641 NextSelectorID = FirstSelectorID;
Douglas Gregor253eefe2011-12-01 00:59:36 +00005642 NextSubmoduleID = FirstSubmoduleID;
Sebastian Redl07a89a82010-07-30 00:29:29 +00005643}
5644
Sebastian Redl539c5062010-08-18 23:57:32 +00005645void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005646 // Always keep the highest ID. See \p TypeRead() for more information.
5647 IdentID &StoredID = IdentifierIDs[II];
5648 if (ID > StoredID)
5649 StoredID = ID;
Sebastian Redlff4a2952010-07-23 23:49:55 +00005650}
5651
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005652void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005653 // Always keep the highest ID. See \p TypeRead() for more information.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005654 MacroID &StoredID = MacroIDs[MI];
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005655 if (ID > StoredID)
5656 StoredID = ID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005657}
5658
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00005659void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005660 // Always take the highest-numbered type index. This copes with an interesting
5661 // case for chained AST writing where we schedule writing the type and then,
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005662 // later, deserialize the type from another AST. In this case, we want to
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005663 // keep the higher-numbered entry so that we can properly write it out to
5664 // the AST file.
5665 TypeIdx &StoredIdx = TypeIdxs[T];
5666 if (Idx.getIndex() >= StoredIdx.getIndex())
5667 StoredIdx = Idx;
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00005668}
5669
Sebastian Redl539c5062010-08-18 23:57:32 +00005670void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005671 // Always keep the highest ID. See \p TypeRead() for more information.
5672 SelectorID &StoredID = SelectorIDs[S];
5673 if (ID > StoredID)
5674 StoredID = ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00005675}
Douglas Gregor91096292010-10-02 19:29:26 +00005676
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00005677void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
Richard Smith66a81862015-05-04 02:25:31 +00005678 MacroDefinitionRecord *MD) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00005679 assert(MacroDefinitions.find(MD) == MacroDefinitions.end());
Douglas Gregor91096292010-10-02 19:29:26 +00005680 MacroDefinitions[MD] = ID;
5681}
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005682
Douglas Gregore37a85a2011-12-02 17:30:13 +00005683void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
5684 assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end());
5685 SubmoduleIDs[Mod] = ID;
5686}
5687
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005688void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
John McCallf937c022011-10-07 06:10:15 +00005689 assert(D->isCompleteDefinition());
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005690 assert(!WritingAST && "Already writing the AST!");
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005691 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(D)) {
5692 // We are interested when a PCH decl is modified.
Douglas Gregorb3722e22011-09-09 23:01:35 +00005693 if (RD->isFromASTFile()) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005694 // A forward reference was mutated into a definition. Rewrite it.
5695 // FIXME: This happens during template instantiation, should we
5696 // have created a new definition decl instead ?
Richard Smithcd45dbc2014-04-19 03:48:30 +00005697 assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
5698 "completed a tag from another module but not by instantiation?");
5699 DeclUpdates[RD].push_back(
5700 DeclUpdate(UPD_CXX_INSTANTIATED_CLASS_DEFINITION));
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005701 }
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005702 }
5703}
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005704
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005705void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
5706 // TU and namespaces are handled elsewhere.
5707 if (isa<TranslationUnitDecl>(DC) || isa<NamespaceDecl>(DC))
5708 return;
5709
Douglas Gregorb3722e22011-09-09 23:01:35 +00005710 if (!(!D->isFromASTFile() && cast<Decl>(DC)->isFromASTFile()))
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005711 return; // Not a source decl added to a DeclContext from PCH.
5712
Richard Smith0f4e2c42015-08-06 04:23:48 +00005713 assert(DC == DC->getPrimaryContext() && "added to non-primary context");
Douglas Gregor9f782892013-01-21 15:25:38 +00005714 assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
Richard Smithe9a8bc32014-09-30 00:45:29 +00005715 assert(!WritingAST && "Already writing the AST!");
Chandler Carruth8a3d24d2015-03-26 04:27:10 +00005716 UpdatedDeclContexts.insert(DC);
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005717 UpdatingVisibleDecls.push_back(D);
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005718}
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005719
5720void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
5721 assert(D->isImplicit());
Douglas Gregorb3722e22011-09-09 23:01:35 +00005722 if (!(!D->isFromASTFile() && RD->isFromASTFile()))
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005723 return; // Not a source member added to a class from PCH.
5724 if (!isa<CXXMethodDecl>(D))
5725 return; // We are interested in lazily declared implicit methods.
5726
5727 // A decl coming from PCH was modified.
John McCallf937c022011-10-07 06:10:15 +00005728 assert(RD->isCompleteDefinition());
Richard Smithe9a8bc32014-09-30 00:45:29 +00005729 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00005730 DeclUpdates[RD].push_back(DeclUpdate(UPD_CXX_ADDED_IMPLICIT_MEMBER, D));
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005731}
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00005732
5733void ASTWriter::AddedCXXTemplateSpecialization(const ClassTemplateDecl *TD,
5734 const ClassTemplateSpecializationDecl *D) {
Argyrios Kyrtzidisef80a012010-10-28 07:38:47 +00005735 // The specializations set is kept in the canonical template.
5736 TD = TD->getCanonicalDecl();
Douglas Gregorb3722e22011-09-09 23:01:35 +00005737 if (!(!D->isFromASTFile() && TD->isFromASTFile()))
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00005738 return; // Not a source specialization added to a template from PCH.
5739
Richard Smithe9a8bc32014-09-30 00:45:29 +00005740 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00005741 DeclUpdates[TD].push_back(DeclUpdate(UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION,
5742 D));
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00005743}
Douglas Gregorf88e35b2010-11-30 06:16:57 +00005744
Larisse Voufo39a1e502013-08-06 01:03:05 +00005745void ASTWriter::AddedCXXTemplateSpecialization(
5746 const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
5747 // The specializations set is kept in the canonical template.
Larisse Voufo39a1e502013-08-06 01:03:05 +00005748 TD = TD->getCanonicalDecl();
5749 if (!(!D->isFromASTFile() && TD->isFromASTFile()))
5750 return; // Not a source specialization added to a template from PCH.
5751
Richard Smithe9a8bc32014-09-30 00:45:29 +00005752 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00005753 DeclUpdates[TD].push_back(DeclUpdate(UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION,
5754 D));
Larisse Voufo39a1e502013-08-06 01:03:05 +00005755}
5756
Sebastian Redl9ab988f2011-04-14 14:07:59 +00005757void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
5758 const FunctionDecl *D) {
5759 // The specializations set is kept in the canonical template.
5760 TD = TD->getCanonicalDecl();
Douglas Gregorb3722e22011-09-09 23:01:35 +00005761 if (!(!D->isFromASTFile() && TD->isFromASTFile()))
Sebastian Redl9ab988f2011-04-14 14:07:59 +00005762 return; // Not a source specialization added to a template from PCH.
5763
Richard Smithe9a8bc32014-09-30 00:45:29 +00005764 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00005765 DeclUpdates[TD].push_back(DeclUpdate(UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION,
5766 D));
Sebastian Redl9ab988f2011-04-14 14:07:59 +00005767}
5768
Richard Smith564417a2014-03-20 21:47:22 +00005769void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
Richard Smith9e2341d2015-03-23 03:25:59 +00005770 assert(!DoneWritingDeclsAndTypes && "Already done writing updates!");
5771 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00005772 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00005773 // If we don't already know the exception specification for this redecl
5774 // chain, add an update record for it.
5775 if (isUnresolvedExceptionSpec(cast<FunctionDecl>(D)
5776 ->getType()
5777 ->castAs<FunctionProtoType>()
5778 ->getExceptionSpecType()))
5779 DeclUpdates[D].push_back(UPD_CXX_RESOLVED_EXCEPTION_SPEC);
5780 });
Richard Smith564417a2014-03-20 21:47:22 +00005781}
5782
Richard Smith1fa5d642013-05-11 05:45:24 +00005783void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
5784 assert(!WritingAST && "Already writing the AST!");
Richard Smith9e2341d2015-03-23 03:25:59 +00005785 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00005786 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00005787 DeclUpdates[D].push_back(
5788 DeclUpdate(UPD_CXX_DEDUCED_RETURN_TYPE, ReturnType));
5789 });
Richard Smith1fa5d642013-05-11 05:45:24 +00005790}
5791
Richard Smithf8134002015-03-10 01:41:22 +00005792void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD,
5793 const FunctionDecl *Delete) {
5794 assert(!WritingAST && "Already writing the AST!");
5795 assert(Delete && "Not given an operator delete");
Richard Smith9e2341d2015-03-23 03:25:59 +00005796 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00005797 Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00005798 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_RESOLVED_DTOR_DELETE, Delete));
5799 });
Richard Smithf8134002015-03-10 01:41:22 +00005800}
5801
Sebastian Redlab238a72011-04-24 16:28:06 +00005802void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005803 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005804 if (!D->isFromASTFile())
Sebastian Redlab238a72011-04-24 16:28:06 +00005805 return; // Declaration not imported from PCH.
5806
Richard Smith4d235792014-08-07 18:53:08 +00005807 // Implicit function decl from a PCH was defined.
5808 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Sebastian Redlab238a72011-04-24 16:28:06 +00005809}
5810
Richard Smithd28ac5b2014-03-22 23:33:22 +00005811void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
5812 assert(!WritingAST && "Already writing the AST!");
5813 if (!D->isFromASTFile())
5814 return;
5815
Richard Smith9e2341d2015-03-23 03:25:59 +00005816 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Richard Smithd28ac5b2014-03-22 23:33:22 +00005817}
5818
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005819void ASTWriter::StaticDataMemberInstantiated(const VarDecl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005820 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005821 if (!D->isFromASTFile())
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005822 return;
5823
5824 // Since the actual instantiation is delayed, this really means that we need
5825 // to update the instantiation location.
Richard Smith6ef42932014-03-20 21:02:00 +00005826 DeclUpdates[D].push_back(
Aaron Ballman4f45b712014-03-21 15:22:56 +00005827 DeclUpdate(UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER,
5828 D->getMemberSpecializationInfo()->getPointOfInstantiation()));
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005829}
5830
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005831void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
5832 const ObjCInterfaceDecl *IFD) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005833 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005834 if (!IFD->isFromASTFile())
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005835 return; // Declaration not imported from PCH.
Douglas Gregor404cdde2012-01-27 01:47:08 +00005836
5837 assert(IFD->getDefinition() && "Category on a class without a definition?");
5838 ObjCClassesWithCategories.insert(
5839 const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005840}
Argyrios Kyrtzidisb97a4022011-11-12 21:07:46 +00005841
Argyrios Kyrtzidis0ca3a8b2011-11-12 21:07:52 +00005842
Argyrios Kyrtzidis846e61a2011-11-14 04:52:29 +00005843void ASTWriter::AddedObjCPropertyInClassExtension(const ObjCPropertyDecl *Prop,
5844 const ObjCPropertyDecl *OrigProp,
5845 const ObjCCategoryDecl *ClassExt) {
5846 const ObjCInterfaceDecl *D = ClassExt->getClassInterface();
5847 if (!D)
5848 return;
5849
5850 assert(!WritingAST && "Already writing the AST!");
5851 if (!D->isFromASTFile())
5852 return; // Declaration not imported from PCH.
5853
5854 RewriteDecl(D);
5855}
Eli Friedman276dd182013-09-05 00:02:25 +00005856
5857void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
5858 assert(!WritingAST && "Already writing the AST!");
5859 if (!D->isFromASTFile())
5860 return;
5861
Aaron Ballman4f45b712014-03-21 15:22:56 +00005862 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_USED));
Eli Friedman276dd182013-09-05 00:02:25 +00005863}
Alexey Bataev97720002014-11-11 04:05:39 +00005864
5865void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
5866 assert(!WritingAST && "Already writing the AST!");
5867 if (!D->isFromASTFile())
5868 return;
5869
5870 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_THREADPRIVATE));
5871}
Richard Smith65ebb4a2015-03-26 04:09:53 +00005872
Richard Smith4caa4492015-05-15 02:34:32 +00005873void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) {
Richard Smith65ebb4a2015-03-26 04:09:53 +00005874 assert(!WritingAST && "Already writing the AST!");
5875 assert(D->isHidden() && "expected a hidden declaration");
Richard Smith4caa4492015-05-15 02:34:32 +00005876 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_EXPORTED, M));
Richard Smith65ebb4a2015-03-26 04:09:53 +00005877}
Alex Denisovfde64952015-06-26 05:28:36 +00005878
5879void ASTWriter::AddedAttributeToRecord(const Attr *Attr,
5880 const RecordDecl *Record) {
5881 assert(!WritingAST && "Already writing the AST!");
5882 if (!Record->isFromASTFile())
5883 return;
5884 DeclUpdates[Record].push_back(DeclUpdate(UPD_ADDED_ATTR_TO_RECORD, Attr));
5885}