blob: 0f9677715ff3ccfba61adee680a30c899ff06f04 [file] [log] [blame]
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001//===--- ASTWriter.cpp - AST File Writer ------------------------*- C++ -*-===//
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"
Douglas Gregor6623e1f2015-11-03 18:33:07 +000015#include "clang/Serialization/ModuleFileExtension.h"
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +000016#include "ASTCommon.h"
Richard Smithd88a7f12015-09-01 20:35:42 +000017#include "ASTReaderInternals.h"
18#include "MultiOnDiskHashTable.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000019#include "clang/AST/ASTContext.h"
20#include "clang/AST/Decl.h"
21#include "clang/AST/DeclContextInternals.h"
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +000022#include "clang/AST/DeclFriend.h"
Richard Smith961eae52014-03-25 01:14:22 +000023#include "clang/AST/DeclLookups.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000024#include "clang/AST/DeclTemplate.h"
Douglas Gregorfeb84b02009-04-14 21:18:50 +000025#include "clang/AST/Expr.h"
John McCallbfd822c2010-08-24 07:32:53 +000026#include "clang/AST/ExprCXX.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000027#include "clang/AST/Type.h"
John McCall8f115c62009-10-16 21:56:05 +000028#include "clang/AST/TypeLocVisitor.h"
Benjamin Kramerf3ca26982014-05-10 16:31:55 +000029#include "clang/Basic/DiagnosticOptions.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000030#include "clang/Basic/FileManager.h"
Chris Lattner226efd32010-11-23 19:19:34 +000031#include "clang/Basic/FileSystemStatCache.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000032#include "clang/Basic/SourceManager.h"
Douglas Gregor4c7626e2009-04-13 16:31:14 +000033#include "clang/Basic/SourceManagerInternals.h"
Douglas Gregorbfbde532009-04-10 21:16:55 +000034#include "clang/Basic/TargetInfo.h"
Douglas Gregorcb177f12012-10-16 23:40:58 +000035#include "clang/Basic/TargetOptions.h"
Douglas Gregor7b71e632009-04-27 22:23:34 +000036#include "clang/Basic/Version.h"
Douglas Gregor20b2ebd2011-03-23 00:50:03 +000037#include "clang/Basic/VersionTuple.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000038#include "clang/Lex/HeaderSearch.h"
39#include "clang/Lex/HeaderSearchOptions.h"
40#include "clang/Lex/MacroInfo.h"
41#include "clang/Lex/PreprocessingRecord.h"
42#include "clang/Lex/Preprocessor.h"
43#include "clang/Lex/PreprocessorOptions.h"
44#include "clang/Sema/IdentifierResolver.h"
45#include "clang/Sema/Sema.h"
46#include "clang/Serialization/ASTReader.h"
Richard Smithb5aaf5a2015-09-01 02:35:58 +000047#include "clang/Serialization/SerializationDiagnostic.h"
Douglas Gregore0a3a512009-04-14 21:55:33 +000048#include "llvm/ADT/APFloat.h"
49#include "llvm/ADT/APInt.h"
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +000050#include "llvm/ADT/Hashing.h"
Daniel Dunbarf8502d52009-10-17 23:52:28 +000051#include "llvm/ADT/StringExtras.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000052#include "llvm/Bitcode/BitstreamWriter.h"
Richard Smithaada85c2016-02-06 02:06:43 +000053#include "llvm/Support/Compression.h"
Justin Bognere1c147c2014-03-28 22:03:19 +000054#include "llvm/Support/EndianStream.h"
Michael J. Spencer740857f2010-12-21 16:45:57 +000055#include "llvm/Support/FileSystem.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000056#include "llvm/Support/MemoryBuffer.h"
Justin Bognerbb094f02014-04-18 19:57:06 +000057#include "llvm/Support/OnDiskHashTable.h"
Michael J. Spencer8aaf4992010-11-29 18:12:39 +000058#include "llvm/Support/Path.h"
Ben Langmuir487ea142014-10-23 18:05:36 +000059#include "llvm/Support/Process.h"
Douglas Gregor925296b2011-07-19 16:10:42 +000060#include <algorithm>
Chris Lattner225dd6c2009-04-11 18:40:46 +000061#include <cstdio>
Douglas Gregor09b69892011-02-10 17:09:37 +000062#include <string.h>
Douglas Gregor925296b2011-07-19 16:10:42 +000063#include <utility>
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +000064
Douglas Gregoref84c4b2009-04-09 22:27:44 +000065using namespace clang;
Sebastian Redl539c5062010-08-18 23:57:32 +000066using namespace clang::serialization;
Douglas Gregoref84c4b2009-04-09 22:27:44 +000067
Sebastian Redl3df5a082010-07-30 17:03:48 +000068template <typename T, typename Allocator>
Reid Kleckner012665e2015-05-21 00:13:09 +000069static StringRef bytes(const std::vector<T, Allocator> &v) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +000070 if (v.empty()) return StringRef();
71 return StringRef(reinterpret_cast<const char*>(&v[0]),
Benjamin Kramerd47a12a2011-04-24 17:44:50 +000072 sizeof(T) * v.size());
Sebastian Redl3df5a082010-07-30 17:03:48 +000073}
Benjamin Kramerd47a12a2011-04-24 17:44:50 +000074
75template <typename T>
Reid Kleckner012665e2015-05-21 00:13:09 +000076static StringRef bytes(const SmallVectorImpl<T> &v) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +000077 return StringRef(reinterpret_cast<const char*>(v.data()),
Benjamin Kramerd47a12a2011-04-24 17:44:50 +000078 sizeof(T) * v.size());
Sebastian Redl3df5a082010-07-30 17:03:48 +000079}
80
Douglas Gregoref84c4b2009-04-09 22:27:44 +000081//===----------------------------------------------------------------------===//
82// Type serialization
83//===----------------------------------------------------------------------===//
Chris Lattner7099dbc2009-04-27 06:16:06 +000084
Richard Smith290d8012016-04-06 17:06:00 +000085namespace clang {
Sebastian Redl42a0f6a2010-08-18 23:56:27 +000086 class ASTTypeWriter {
Sebastian Redl55c0ad52010-08-18 23:56:21 +000087 ASTWriter &Writer;
Richard Smith69c82bf2016-04-01 22:52:03 +000088 ASTRecordWriter Record;
Douglas Gregoref84c4b2009-04-09 22:27:44 +000089
Douglas Gregoref84c4b2009-04-09 22:27:44 +000090 /// \brief Type code that corresponds to the record generated.
Sebastian Redl539c5062010-08-18 23:57:32 +000091 TypeCode Code;
Richard Smith01b2cb42014-07-26 06:37:51 +000092 /// \brief Abbreviation to use for the record, if any.
93 unsigned AbbrevToUse;
Douglas Gregoref84c4b2009-04-09 22:27:44 +000094
Richard Smith290d8012016-04-06 17:06:00 +000095 public:
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +000096 ASTTypeWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record)
Richard Smith290d8012016-04-06 17:06:00 +000097 : Writer(Writer), Record(Writer, Record), Code((TypeCode)0), AbbrevToUse(0) { }
98
99 uint64_t Emit() {
100 return Record.Emit(Code, AbbrevToUse);
101 }
102
103 void Visit(QualType T) {
104 if (T.hasLocalNonFastQualifiers()) {
105 Qualifiers Qs = T.getLocalQualifiers();
106 Record.AddTypeRef(T.getLocalUnqualifiedType());
107 Record.push_back(Qs.getAsOpaqueValue());
108 Code = TYPE_EXT_QUAL;
109 AbbrevToUse = Writer.TypeExtQualAbbrev;
110 } else {
111 switch (T->getTypeClass()) {
112 // For all of the concrete, non-dependent types, call the
113 // appropriate visitor function.
114#define TYPE(Class, Base) \
115 case Type::Class: Visit##Class##Type(cast<Class##Type>(T)); break;
116#define ABSTRACT_TYPE(Class, Base)
117#include "clang/AST/TypeNodes.def"
118 }
119 }
120 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000121
122 void VisitArrayType(const ArrayType *T);
123 void VisitFunctionType(const FunctionType *T);
124 void VisitTagType(const TagType *T);
125
126#define TYPE(Class, Base) void Visit##Class##Type(const Class##Type *T);
127#define ABSTRACT_TYPE(Class, Base)
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000128#include "clang/AST/TypeNodes.def"
129 };
Richard Smith290d8012016-04-06 17:06:00 +0000130} // end namespace clang
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000131
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000132void ASTTypeWriter::VisitBuiltinType(const BuiltinType *T) {
David Blaikie83d382b2011-09-23 05:06:16 +0000133 llvm_unreachable("Built-in types are never serialized");
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000134}
135
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000136void ASTTypeWriter::VisitComplexType(const ComplexType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000137 Record.AddTypeRef(T->getElementType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000138 Code = TYPE_COMPLEX;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000139}
140
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000141void ASTTypeWriter::VisitPointerType(const PointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000142 Record.AddTypeRef(T->getPointeeType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000143 Code = TYPE_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000144}
145
Reid Kleckner8a365022013-06-24 17:51:48 +0000146void ASTTypeWriter::VisitDecayedType(const DecayedType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000147 Record.AddTypeRef(T->getOriginalType());
Reid Kleckner8a365022013-06-24 17:51:48 +0000148 Code = TYPE_DECAYED;
149}
150
Reid Kleckner0503a872013-12-05 01:23:43 +0000151void ASTTypeWriter::VisitAdjustedType(const AdjustedType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000152 Record.AddTypeRef(T->getOriginalType());
153 Record.AddTypeRef(T->getAdjustedType());
Reid Kleckner0503a872013-12-05 01:23:43 +0000154 Code = TYPE_ADJUSTED;
155}
156
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000157void ASTTypeWriter::VisitBlockPointerType(const BlockPointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000158 Record.AddTypeRef(T->getPointeeType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000159 Code = TYPE_BLOCK_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000160}
161
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000162void ASTTypeWriter::VisitLValueReferenceType(const LValueReferenceType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000163 Record.AddTypeRef(T->getPointeeTypeAsWritten());
Richard Smith0f538462011-04-12 10:38:03 +0000164 Record.push_back(T->isSpelledAsLValue());
Sebastian Redl539c5062010-08-18 23:57:32 +0000165 Code = TYPE_LVALUE_REFERENCE;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000166}
167
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000168void ASTTypeWriter::VisitRValueReferenceType(const RValueReferenceType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000169 Record.AddTypeRef(T->getPointeeTypeAsWritten());
Sebastian Redl539c5062010-08-18 23:57:32 +0000170 Code = TYPE_RVALUE_REFERENCE;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000171}
172
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000173void ASTTypeWriter::VisitMemberPointerType(const MemberPointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000174 Record.AddTypeRef(T->getPointeeType());
175 Record.AddTypeRef(QualType(T->getClass(), 0));
Sebastian Redl539c5062010-08-18 23:57:32 +0000176 Code = TYPE_MEMBER_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000177}
178
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000179void ASTTypeWriter::VisitArrayType(const ArrayType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000180 Record.AddTypeRef(T->getElementType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000181 Record.push_back(T->getSizeModifier()); // FIXME: stable values
John McCall8ccfcb52009-09-24 19:53:00 +0000182 Record.push_back(T->getIndexTypeCVRQualifiers()); // FIXME: stable values
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000183}
184
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000185void ASTTypeWriter::VisitConstantArrayType(const ConstantArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000186 VisitArrayType(T);
Richard Smith69c82bf2016-04-01 22:52:03 +0000187 Record.AddAPInt(T->getSize());
Sebastian Redl539c5062010-08-18 23:57:32 +0000188 Code = TYPE_CONSTANT_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000189}
190
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000191void ASTTypeWriter::VisitIncompleteArrayType(const IncompleteArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000192 VisitArrayType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000193 Code = TYPE_INCOMPLETE_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000194}
195
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000196void ASTTypeWriter::VisitVariableArrayType(const VariableArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000197 VisitArrayType(T);
Richard Smith69c82bf2016-04-01 22:52:03 +0000198 Record.AddSourceLocation(T->getLBracketLoc());
199 Record.AddSourceLocation(T->getRBracketLoc());
Richard Smith290d8012016-04-06 17:06:00 +0000200 Record.AddStmt(T->getSizeExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000201 Code = TYPE_VARIABLE_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000202}
203
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000204void ASTTypeWriter::VisitVectorType(const VectorType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000205 Record.AddTypeRef(T->getElementType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000206 Record.push_back(T->getNumElements());
Bob Wilsonaeb56442010-11-10 21:56:12 +0000207 Record.push_back(T->getVectorKind());
Sebastian Redl539c5062010-08-18 23:57:32 +0000208 Code = TYPE_VECTOR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000209}
210
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000211void ASTTypeWriter::VisitExtVectorType(const ExtVectorType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000212 VisitVectorType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000213 Code = TYPE_EXT_VECTOR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000214}
215
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000216void ASTTypeWriter::VisitFunctionType(const FunctionType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000217 Record.AddTypeRef(T->getReturnType());
Rafael Espindolac50c27c2010-03-30 20:24:48 +0000218 FunctionType::ExtInfo C = T->getExtInfo();
219 Record.push_back(C.getNoReturn());
Eli Friedmanc5b20b52011-04-09 08:18:08 +0000220 Record.push_back(C.getHasRegParm());
Rafael Espindola49b85ab2010-03-30 22:15:11 +0000221 Record.push_back(C.getRegParm());
Douglas Gregor8c940862010-01-18 17:14:39 +0000222 // FIXME: need to stabilize encoding of calling convention...
Rafael Espindolac50c27c2010-03-30 20:24:48 +0000223 Record.push_back(C.getCC());
John McCall31168b02011-06-15 23:02:42 +0000224 Record.push_back(C.getProducesResult());
Richard Smith01b2cb42014-07-26 06:37:51 +0000225
226 if (C.getHasRegParm() || C.getRegParm() || C.getProducesResult())
227 AbbrevToUse = 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000228}
229
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000230void ASTTypeWriter::VisitFunctionNoProtoType(const FunctionNoProtoType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000231 VisitFunctionType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000232 Code = TYPE_FUNCTION_NO_PROTO;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000233}
234
Richard Smith290d8012016-04-06 17:06:00 +0000235static void addExceptionSpec(const FunctionProtoType *T,
236 ASTRecordWriter &Record) {
Sebastian Redlfa453cf2011-03-12 11:50:43 +0000237 Record.push_back(T->getExceptionSpecType());
238 if (T->getExceptionSpecType() == EST_Dynamic) {
239 Record.push_back(T->getNumExceptions());
240 for (unsigned I = 0, N = T->getNumExceptions(); I != N; ++I)
Richard Smith69c82bf2016-04-01 22:52:03 +0000241 Record.AddTypeRef(T->getExceptionType(I));
Sebastian Redlfa453cf2011-03-12 11:50:43 +0000242 } else if (T->getExceptionSpecType() == EST_ComputedNoexcept) {
Richard Smith290d8012016-04-06 17:06:00 +0000243 Record.AddStmt(T->getNoexceptExpr());
Richard Smith8b987a92012-04-21 17:47:47 +0000244 } else if (T->getExceptionSpecType() == EST_Uninstantiated) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000245 Record.AddDeclRef(T->getExceptionSpecDecl());
246 Record.AddDeclRef(T->getExceptionSpecTemplate());
Richard Smithd3b5c9082012-07-27 04:22:15 +0000247 } else if (T->getExceptionSpecType() == EST_Unevaluated) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000248 Record.AddDeclRef(T->getExceptionSpecDecl());
Sebastian Redlfa453cf2011-03-12 11:50:43 +0000249 }
Richard Smith564417a2014-03-20 21:47:22 +0000250}
251
252void ASTTypeWriter::VisitFunctionProtoType(const FunctionProtoType *T) {
253 VisitFunctionType(T);
Richard Smith01b2cb42014-07-26 06:37:51 +0000254
Richard Smith564417a2014-03-20 21:47:22 +0000255 Record.push_back(T->isVariadic());
256 Record.push_back(T->hasTrailingReturn());
257 Record.push_back(T->getTypeQuals());
258 Record.push_back(static_cast<unsigned>(T->getRefQualifier()));
Richard Smith290d8012016-04-06 17:06:00 +0000259 addExceptionSpec(T, Record);
Richard Smith01b2cb42014-07-26 06:37:51 +0000260
261 Record.push_back(T->getNumParams());
262 for (unsigned I = 0, N = T->getNumParams(); I != N; ++I)
Richard Smith69c82bf2016-04-01 22:52:03 +0000263 Record.AddTypeRef(T->getParamType(I));
Richard Smith01b2cb42014-07-26 06:37:51 +0000264
John McCall18afab72016-03-01 00:49:02 +0000265 if (T->hasExtParameterInfos()) {
266 for (unsigned I = 0, N = T->getNumParams(); I != N; ++I)
267 Record.push_back(T->getExtParameterInfo(I).getOpaqueValue());
268 }
269
Richard Smith01b2cb42014-07-26 06:37:51 +0000270 if (T->isVariadic() || T->hasTrailingReturn() || T->getTypeQuals() ||
John McCall18afab72016-03-01 00:49:02 +0000271 T->getRefQualifier() || T->getExceptionSpecType() != EST_None ||
272 T->hasExtParameterInfos())
Richard Smith01b2cb42014-07-26 06:37:51 +0000273 AbbrevToUse = 0;
274
Sebastian Redl539c5062010-08-18 23:57:32 +0000275 Code = TYPE_FUNCTION_PROTO;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000276}
277
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000278void ASTTypeWriter::VisitUnresolvedUsingType(const UnresolvedUsingType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000279 Record.AddDeclRef(T->getDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000280 Code = TYPE_UNRESOLVED_USING;
John McCallb96ec562009-12-04 22:46:56 +0000281}
John McCallb96ec562009-12-04 22:46:56 +0000282
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000283void ASTTypeWriter::VisitTypedefType(const TypedefType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000284 Record.AddDeclRef(T->getDecl());
Argyrios Kyrtzidis45a83f92010-07-02 11:55:11 +0000285 assert(!T->isCanonicalUnqualified() && "Invalid typedef ?");
Richard Smith69c82bf2016-04-01 22:52:03 +0000286 Record.AddTypeRef(T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000287 Code = TYPE_TYPEDEF;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000288}
289
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000290void ASTTypeWriter::VisitTypeOfExprType(const TypeOfExprType *T) {
Richard Smith290d8012016-04-06 17:06:00 +0000291 Record.AddStmt(T->getUnderlyingExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000292 Code = TYPE_TYPEOF_EXPR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000293}
294
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000295void ASTTypeWriter::VisitTypeOfType(const TypeOfType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000296 Record.AddTypeRef(T->getUnderlyingType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000297 Code = TYPE_TYPEOF;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000298}
299
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000300void ASTTypeWriter::VisitDecltypeType(const DecltypeType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000301 Record.AddTypeRef(T->getUnderlyingType());
Richard Smith290d8012016-04-06 17:06:00 +0000302 Record.AddStmt(T->getUnderlyingExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000303 Code = TYPE_DECLTYPE;
Anders Carlsson81df7b82009-06-24 19:06:50 +0000304}
305
Alexis Hunte852b102011-05-24 22:41:36 +0000306void ASTTypeWriter::VisitUnaryTransformType(const UnaryTransformType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000307 Record.AddTypeRef(T->getBaseType());
308 Record.AddTypeRef(T->getUnderlyingType());
Alexis Hunte852b102011-05-24 22:41:36 +0000309 Record.push_back(T->getUTTKind());
310 Code = TYPE_UNARY_TRANSFORM;
311}
312
Richard Smith30482bc2011-02-20 03:19:35 +0000313void ASTTypeWriter::VisitAutoType(const AutoType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000314 Record.AddTypeRef(T->getDeducedType());
Richard Smithe301ba22015-11-11 02:02:15 +0000315 Record.push_back((unsigned)T->getKeyword());
Richard Smith27d807c2013-04-30 13:56:41 +0000316 if (T->getDeducedType().isNull())
317 Record.push_back(T->isDependentType());
Richard Smith30482bc2011-02-20 03:19:35 +0000318 Code = TYPE_AUTO;
319}
320
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000321void ASTTypeWriter::VisitTagType(const TagType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000322 Record.push_back(T->isDependentType());
Richard Smith69c82bf2016-04-01 22:52:03 +0000323 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
Mike Stump11289f42009-09-09 15:08:12 +0000324 assert(!T->isBeingDefined() &&
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000325 "Cannot serialize in the middle of a type definition");
326}
327
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000328void ASTTypeWriter::VisitRecordType(const RecordType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000329 VisitTagType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000330 Code = TYPE_RECORD;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000331}
332
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000333void ASTTypeWriter::VisitEnumType(const EnumType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000334 VisitTagType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000335 Code = TYPE_ENUM;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000336}
337
John McCall81904512011-01-06 01:58:22 +0000338void ASTTypeWriter::VisitAttributedType(const AttributedType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000339 Record.AddTypeRef(T->getModifiedType());
340 Record.AddTypeRef(T->getEquivalentType());
John McCall81904512011-01-06 01:58:22 +0000341 Record.push_back(T->getAttrKind());
342 Code = TYPE_ATTRIBUTED;
343}
344
Mike Stump11289f42009-09-09 15:08:12 +0000345void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000346ASTTypeWriter::VisitSubstTemplateTypeParmType(
John McCallcebee162009-10-18 09:09:24 +0000347 const SubstTemplateTypeParmType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000348 Record.AddTypeRef(QualType(T->getReplacedParameter(), 0));
349 Record.AddTypeRef(T->getReplacementType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000350 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM;
John McCallcebee162009-10-18 09:09:24 +0000351}
352
353void
Douglas Gregorada4b792011-01-14 02:55:32 +0000354ASTTypeWriter::VisitSubstTemplateTypeParmPackType(
355 const SubstTemplateTypeParmPackType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000356 Record.AddTypeRef(QualType(T->getReplacedParameter(), 0));
357 Record.AddTemplateArgument(T->getArgumentPack());
Douglas Gregorada4b792011-01-14 02:55:32 +0000358 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK;
359}
360
361void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000362ASTTypeWriter::VisitTemplateSpecializationType(
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000363 const TemplateSpecializationType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000364 Record.push_back(T->isDependentType());
Richard Smith69c82bf2016-04-01 22:52:03 +0000365 Record.AddTemplateName(T->getTemplateName());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000366 Record.push_back(T->getNumArgs());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000367 for (const auto &ArgI : *T)
Richard Smith69c82bf2016-04-01 22:52:03 +0000368 Record.AddTemplateArgument(ArgI);
369 Record.AddTypeRef(T->isTypeAlias() ? T->getAliasedType()
370 : T->isCanonicalUnqualified()
371 ? QualType()
372 : T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000373 Code = TYPE_TEMPLATE_SPECIALIZATION;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000374}
375
376void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000377ASTTypeWriter::VisitDependentSizedArrayType(const DependentSizedArrayType *T) {
Argyrios Kyrtzidis4a57bd02010-06-30 08:49:25 +0000378 VisitArrayType(T);
Richard Smith290d8012016-04-06 17:06:00 +0000379 Record.AddStmt(T->getSizeExpr());
Richard Smith69c82bf2016-04-01 22:52:03 +0000380 Record.AddSourceRange(T->getBracketsRange());
Sebastian Redl539c5062010-08-18 23:57:32 +0000381 Code = TYPE_DEPENDENT_SIZED_ARRAY;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000382}
383
384void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000385ASTTypeWriter::VisitDependentSizedExtVectorType(
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000386 const DependentSizedExtVectorType *T) {
387 // FIXME: Serialize this type (C++ only)
David Blaikie83d382b2011-09-23 05:06:16 +0000388 llvm_unreachable("Cannot serialize dependent sized extended vector types");
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000389}
390
391void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000392ASTTypeWriter::VisitTemplateTypeParmType(const TemplateTypeParmType *T) {
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000393 Record.push_back(T->getDepth());
394 Record.push_back(T->getIndex());
395 Record.push_back(T->isParameterPack());
Richard Smith69c82bf2016-04-01 22:52:03 +0000396 Record.AddDeclRef(T->getDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000397 Code = TYPE_TEMPLATE_TYPE_PARM;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000398}
399
400void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000401ASTTypeWriter::VisitDependentNameType(const DependentNameType *T) {
Argyrios Kyrtzidisbfcacee2010-06-24 08:57:31 +0000402 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000403 Record.AddNestedNameSpecifier(T->getQualifier());
404 Record.AddIdentifierRef(T->getIdentifier());
405 Record.AddTypeRef(
406 T->isCanonicalUnqualified() ? QualType() : T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000407 Code = TYPE_DEPENDENT_NAME;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000408}
409
410void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000411ASTTypeWriter::VisitDependentTemplateSpecializationType(
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000412 const DependentTemplateSpecializationType *T) {
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000413 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000414 Record.AddNestedNameSpecifier(T->getQualifier());
415 Record.AddIdentifierRef(T->getIdentifier());
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000416 Record.push_back(T->getNumArgs());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000417 for (const auto &I : *T)
Richard Smith69c82bf2016-04-01 22:52:03 +0000418 Record.AddTemplateArgument(I);
Sebastian Redl539c5062010-08-18 23:57:32 +0000419 Code = TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000420}
421
Douglas Gregord2fa7662010-12-20 02:24:11 +0000422void ASTTypeWriter::VisitPackExpansionType(const PackExpansionType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000423 Record.AddTypeRef(T->getPattern());
David Blaikie05785d12013-02-20 22:23:23 +0000424 if (Optional<unsigned> NumExpansions = T->getNumExpansions())
Douglas Gregor0dca5fd2011-01-14 17:04:44 +0000425 Record.push_back(*NumExpansions + 1);
426 else
427 Record.push_back(0);
Douglas Gregord2fa7662010-12-20 02:24:11 +0000428 Code = TYPE_PACK_EXPANSION;
429}
430
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000431void ASTTypeWriter::VisitParenType(const ParenType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000432 Record.AddTypeRef(T->getInnerType());
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000433 Code = TYPE_PAREN;
434}
435
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000436void ASTTypeWriter::VisitElaboratedType(const ElaboratedType *T) {
Abramo Bagnara6150c882010-05-11 21:36:43 +0000437 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000438 Record.AddNestedNameSpecifier(T->getQualifier());
439 Record.AddTypeRef(T->getNamedType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000440 Code = TYPE_ELABORATED;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000441}
442
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000443void ASTTypeWriter::VisitInjectedClassNameType(const InjectedClassNameType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000444 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
445 Record.AddTypeRef(T->getInjectedSpecializationType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000446 Code = TYPE_INJECTED_CLASS_NAME;
John McCalle78aac42010-03-10 03:28:59 +0000447}
448
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000449void ASTTypeWriter::VisitObjCInterfaceType(const ObjCInterfaceType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000450 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000451 Code = TYPE_OBJC_INTERFACE;
John McCall8b07ec22010-05-15 11:32:37 +0000452}
453
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000454void ASTTypeWriter::VisitObjCObjectType(const ObjCObjectType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000455 Record.AddTypeRef(T->getBaseType());
Douglas Gregore83b9562015-07-07 03:57:53 +0000456 Record.push_back(T->getTypeArgsAsWritten().size());
457 for (auto TypeArg : T->getTypeArgsAsWritten())
Richard Smith69c82bf2016-04-01 22:52:03 +0000458 Record.AddTypeRef(TypeArg);
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000459 Record.push_back(T->getNumProtocols());
Aaron Ballman1683f7b2014-03-17 15:55:30 +0000460 for (const auto *I : T->quals())
Richard Smith69c82bf2016-04-01 22:52:03 +0000461 Record.AddDeclRef(I);
Douglas Gregorab209d82015-07-07 03:58:42 +0000462 Record.push_back(T->isKindOfTypeAsWritten());
Sebastian Redl539c5062010-08-18 23:57:32 +0000463 Code = TYPE_OBJC_OBJECT;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000464}
465
Steve Narofffb4330f2009-06-17 22:40:22 +0000466void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000467ASTTypeWriter::VisitObjCObjectPointerType(const ObjCObjectPointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000468 Record.AddTypeRef(T->getPointeeType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000469 Code = TYPE_OBJC_OBJECT_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000470}
471
Eli Friedman0dfb8892011-10-06 23:00:33 +0000472void
473ASTTypeWriter::VisitAtomicType(const AtomicType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000474 Record.AddTypeRef(T->getValueType());
Eli Friedman0dfb8892011-10-06 23:00:33 +0000475 Code = TYPE_ATOMIC;
476}
477
Xiuli Pan9c14e282016-01-09 12:53:17 +0000478void
479ASTTypeWriter::VisitPipeType(const PipeType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000480 Record.AddTypeRef(T->getElementType());
Xiuli Pan9c14e282016-01-09 12:53:17 +0000481 Code = TYPE_PIPE;
482}
483
John McCall8f115c62009-10-16 21:56:05 +0000484namespace {
485
486class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> {
Richard Smith290d8012016-04-06 17:06:00 +0000487 ASTRecordWriter &Record;
John McCall8f115c62009-10-16 21:56:05 +0000488
489public:
Richard Smith290d8012016-04-06 17:06:00 +0000490 TypeLocWriter(ASTRecordWriter &Record)
491 : Record(Record) { }
John McCall8f115c62009-10-16 21:56:05 +0000492
John McCall17001972009-10-18 01:05:36 +0000493#define ABSTRACT_TYPELOC(CLASS, PARENT)
John McCall8f115c62009-10-16 21:56:05 +0000494#define TYPELOC(CLASS, PARENT) \
John McCall17001972009-10-18 01:05:36 +0000495 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000496#include "clang/AST/TypeLocNodes.def"
497
John McCall17001972009-10-18 01:05:36 +0000498 void VisitArrayTypeLoc(ArrayTypeLoc TyLoc);
499 void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000500};
501
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000502} // end anonymous namespace
John McCall8f115c62009-10-16 21:56:05 +0000503
John McCall17001972009-10-18 01:05:36 +0000504void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
505 // nothing to do
John McCall8f115c62009-10-16 21:56:05 +0000506}
John McCall17001972009-10-18 01:05:36 +0000507void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000508 Record.AddSourceLocation(TL.getBuiltinLoc());
Douglas Gregorc9b7a592010-01-18 18:04:31 +0000509 if (TL.needsExtraLocalData()) {
510 Record.push_back(TL.getWrittenTypeSpec());
511 Record.push_back(TL.getWrittenSignSpec());
512 Record.push_back(TL.getWrittenWidthSpec());
513 Record.push_back(TL.hasModeAttr());
514 }
John McCall8f115c62009-10-16 21:56:05 +0000515}
John McCall17001972009-10-18 01:05:36 +0000516void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000517 Record.AddSourceLocation(TL.getNameLoc());
John McCall8f115c62009-10-16 21:56:05 +0000518}
John McCall17001972009-10-18 01:05:36 +0000519void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000520 Record.AddSourceLocation(TL.getStarLoc());
John McCall8f115c62009-10-16 21:56:05 +0000521}
Reid Kleckner8a365022013-06-24 17:51:48 +0000522void TypeLocWriter::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
523 // nothing to do
524}
Reid Kleckner0503a872013-12-05 01:23:43 +0000525void TypeLocWriter::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
526 // nothing to do
527}
John McCall17001972009-10-18 01:05:36 +0000528void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000529 Record.AddSourceLocation(TL.getCaretLoc());
John McCall8f115c62009-10-16 21:56:05 +0000530}
John McCall17001972009-10-18 01:05:36 +0000531void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000532 Record.AddSourceLocation(TL.getAmpLoc());
John McCall8f115c62009-10-16 21:56:05 +0000533}
John McCall17001972009-10-18 01:05:36 +0000534void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000535 Record.AddSourceLocation(TL.getAmpAmpLoc());
John McCall8f115c62009-10-16 21:56:05 +0000536}
John McCall17001972009-10-18 01:05:36 +0000537void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000538 Record.AddSourceLocation(TL.getStarLoc());
539 Record.AddTypeSourceInfo(TL.getClassTInfo());
John McCall8f115c62009-10-16 21:56:05 +0000540}
John McCall17001972009-10-18 01:05:36 +0000541void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000542 Record.AddSourceLocation(TL.getLBracketLoc());
543 Record.AddSourceLocation(TL.getRBracketLoc());
John McCall17001972009-10-18 01:05:36 +0000544 Record.push_back(TL.getSizeExpr() ? 1 : 0);
545 if (TL.getSizeExpr())
Richard Smith290d8012016-04-06 17:06:00 +0000546 Record.AddStmt(TL.getSizeExpr());
John McCall8f115c62009-10-16 21:56:05 +0000547}
John McCall17001972009-10-18 01:05:36 +0000548void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
549 VisitArrayTypeLoc(TL);
550}
551void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
552 VisitArrayTypeLoc(TL);
553}
554void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
555 VisitArrayTypeLoc(TL);
556}
557void TypeLocWriter::VisitDependentSizedArrayTypeLoc(
558 DependentSizedArrayTypeLoc TL) {
559 VisitArrayTypeLoc(TL);
560}
561void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc(
562 DependentSizedExtVectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000563 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000564}
565void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000566 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000567}
568void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000569 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000570}
571void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000572 Record.AddSourceLocation(TL.getLocalRangeBegin());
573 Record.AddSourceLocation(TL.getLParenLoc());
574 Record.AddSourceLocation(TL.getRParenLoc());
575 Record.AddSourceLocation(TL.getLocalRangeEnd());
Alp Tokerb3fd5cf2014-01-21 00:32:38 +0000576 for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000577 Record.AddDeclRef(TL.getParam(i));
John McCall17001972009-10-18 01:05:36 +0000578}
579void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
580 VisitFunctionTypeLoc(TL);
581}
582void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
583 VisitFunctionTypeLoc(TL);
584}
John McCallb96ec562009-12-04 22:46:56 +0000585void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000586 Record.AddSourceLocation(TL.getNameLoc());
John McCallb96ec562009-12-04 22:46:56 +0000587}
John McCall17001972009-10-18 01:05:36 +0000588void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000589 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000590}
591void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000592 Record.AddSourceLocation(TL.getTypeofLoc());
593 Record.AddSourceLocation(TL.getLParenLoc());
594 Record.AddSourceLocation(TL.getRParenLoc());
John McCall17001972009-10-18 01:05:36 +0000595}
596void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000597 Record.AddSourceLocation(TL.getTypeofLoc());
598 Record.AddSourceLocation(TL.getLParenLoc());
599 Record.AddSourceLocation(TL.getRParenLoc());
600 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
John McCall17001972009-10-18 01:05:36 +0000601}
602void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000603 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000604}
Alexis Hunte852b102011-05-24 22:41:36 +0000605void TypeLocWriter::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000606 Record.AddSourceLocation(TL.getKWLoc());
607 Record.AddSourceLocation(TL.getLParenLoc());
608 Record.AddSourceLocation(TL.getRParenLoc());
609 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
Alexis Hunte852b102011-05-24 22:41:36 +0000610}
Richard Smith30482bc2011-02-20 03:19:35 +0000611void TypeLocWriter::VisitAutoTypeLoc(AutoTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000612 Record.AddSourceLocation(TL.getNameLoc());
Richard Smith30482bc2011-02-20 03:19:35 +0000613}
John McCall17001972009-10-18 01:05:36 +0000614void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000615 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000616}
617void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000618 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000619}
John McCall81904512011-01-06 01:58:22 +0000620void TypeLocWriter::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000621 Record.AddSourceLocation(TL.getAttrNameLoc());
John McCall81904512011-01-06 01:58:22 +0000622 if (TL.hasAttrOperand()) {
623 SourceRange range = TL.getAttrOperandParensRange();
Richard Smith69c82bf2016-04-01 22:52:03 +0000624 Record.AddSourceLocation(range.getBegin());
625 Record.AddSourceLocation(range.getEnd());
John McCall81904512011-01-06 01:58:22 +0000626 }
627 if (TL.hasAttrExprOperand()) {
628 Expr *operand = TL.getAttrExprOperand();
629 Record.push_back(operand ? 1 : 0);
Richard Smith290d8012016-04-06 17:06:00 +0000630 if (operand) Record.AddStmt(operand);
John McCall81904512011-01-06 01:58:22 +0000631 } else if (TL.hasAttrEnumOperand()) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000632 Record.AddSourceLocation(TL.getAttrEnumOperandLoc());
John McCall81904512011-01-06 01:58:22 +0000633 }
634}
John McCall17001972009-10-18 01:05:36 +0000635void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000636 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000637}
John McCallcebee162009-10-18 09:09:24 +0000638void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
639 SubstTemplateTypeParmTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000640 Record.AddSourceLocation(TL.getNameLoc());
John McCallcebee162009-10-18 09:09:24 +0000641}
Douglas Gregorada4b792011-01-14 02:55:32 +0000642void TypeLocWriter::VisitSubstTemplateTypeParmPackTypeLoc(
643 SubstTemplateTypeParmPackTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000644 Record.AddSourceLocation(TL.getNameLoc());
Douglas Gregorada4b792011-01-14 02:55:32 +0000645}
John McCall17001972009-10-18 01:05:36 +0000646void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
647 TemplateSpecializationTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000648 Record.AddSourceLocation(TL.getTemplateKeywordLoc());
649 Record.AddSourceLocation(TL.getTemplateNameLoc());
650 Record.AddSourceLocation(TL.getLAngleLoc());
651 Record.AddSourceLocation(TL.getRAngleLoc());
John McCall0ad16662009-10-29 08:12:44 +0000652 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000653 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(),
654 TL.getArgLoc(i).getLocInfo());
John McCall17001972009-10-18 01:05:36 +0000655}
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000656void TypeLocWriter::VisitParenTypeLoc(ParenTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000657 Record.AddSourceLocation(TL.getLParenLoc());
658 Record.AddSourceLocation(TL.getRParenLoc());
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000659}
Abramo Bagnara6150c882010-05-11 21:36:43 +0000660void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000661 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
662 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
John McCall17001972009-10-18 01:05:36 +0000663}
John McCalle78aac42010-03-10 03:28:59 +0000664void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000665 Record.AddSourceLocation(TL.getNameLoc());
John McCalle78aac42010-03-10 03:28:59 +0000666}
Douglas Gregorc1d2d8a2010-03-31 17:34:00 +0000667void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000668 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
669 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
670 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000671}
John McCallc392f372010-06-11 00:33:02 +0000672void TypeLocWriter::VisitDependentTemplateSpecializationTypeLoc(
673 DependentTemplateSpecializationTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000674 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
675 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
676 Record.AddSourceLocation(TL.getTemplateKeywordLoc());
677 Record.AddSourceLocation(TL.getTemplateNameLoc());
678 Record.AddSourceLocation(TL.getLAngleLoc());
679 Record.AddSourceLocation(TL.getRAngleLoc());
John McCallc392f372010-06-11 00:33:02 +0000680 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
Richard Smith69c82bf2016-04-01 22:52:03 +0000681 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(),
682 TL.getArgLoc(I).getLocInfo());
John McCallc392f372010-06-11 00:33:02 +0000683}
Douglas Gregord2fa7662010-12-20 02:24:11 +0000684void TypeLocWriter::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000685 Record.AddSourceLocation(TL.getEllipsisLoc());
Douglas Gregord2fa7662010-12-20 02:24:11 +0000686}
John McCall17001972009-10-18 01:05:36 +0000687void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000688 Record.AddSourceLocation(TL.getNameLoc());
John McCall8b07ec22010-05-15 11:32:37 +0000689}
690void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
691 Record.push_back(TL.hasBaseTypeAsWritten());
Richard Smith69c82bf2016-04-01 22:52:03 +0000692 Record.AddSourceLocation(TL.getTypeArgsLAngleLoc());
693 Record.AddSourceLocation(TL.getTypeArgsRAngleLoc());
Douglas Gregore9d95f12015-07-07 03:57:35 +0000694 for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000695 Record.AddTypeSourceInfo(TL.getTypeArgTInfo(i));
696 Record.AddSourceLocation(TL.getProtocolLAngleLoc());
697 Record.AddSourceLocation(TL.getProtocolRAngleLoc());
John McCall17001972009-10-18 01:05:36 +0000698 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000699 Record.AddSourceLocation(TL.getProtocolLoc(i));
John McCall8f115c62009-10-16 21:56:05 +0000700}
John McCallfc93cf92009-10-22 22:37:11 +0000701void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000702 Record.AddSourceLocation(TL.getStarLoc());
John McCallfc93cf92009-10-22 22:37:11 +0000703}
Eli Friedman0dfb8892011-10-06 23:00:33 +0000704void TypeLocWriter::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000705 Record.AddSourceLocation(TL.getKWLoc());
706 Record.AddSourceLocation(TL.getLParenLoc());
707 Record.AddSourceLocation(TL.getRParenLoc());
Eli Friedman0dfb8892011-10-06 23:00:33 +0000708}
Xiuli Pan9c14e282016-01-09 12:53:17 +0000709void TypeLocWriter::VisitPipeTypeLoc(PipeTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000710 Record.AddSourceLocation(TL.getKWLoc());
Xiuli Pan9c14e282016-01-09 12:53:17 +0000711}
John McCall8f115c62009-10-16 21:56:05 +0000712
Richard Smith01b2cb42014-07-26 06:37:51 +0000713void ASTWriter::WriteTypeAbbrevs() {
714 using namespace llvm;
715
716 BitCodeAbbrev *Abv;
717
718 // Abbreviation for TYPE_EXT_QUAL
719 Abv = new BitCodeAbbrev();
720 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_EXT_QUAL));
721 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
722 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 3)); // Quals
723 TypeExtQualAbbrev = Stream.EmitAbbrev(Abv);
724
725 // Abbreviation for TYPE_FUNCTION_PROTO
726 Abv = new BitCodeAbbrev();
727 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_FUNCTION_PROTO));
728 // FunctionType
729 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ReturnType
730 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // NoReturn
731 Abv->Add(BitCodeAbbrevOp(0)); // HasRegParm
732 Abv->Add(BitCodeAbbrevOp(0)); // RegParm
733 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // CC
734 Abv->Add(BitCodeAbbrevOp(0)); // ProducesResult
735 // FunctionProtoType
736 Abv->Add(BitCodeAbbrevOp(0)); // IsVariadic
737 Abv->Add(BitCodeAbbrevOp(0)); // HasTrailingReturn
738 Abv->Add(BitCodeAbbrevOp(0)); // TypeQuals
739 Abv->Add(BitCodeAbbrevOp(0)); // RefQualifier
740 Abv->Add(BitCodeAbbrevOp(EST_None)); // ExceptionSpec
741 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // NumParams
742 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
743 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Params
744 TypeFunctionProtoAbbrev = Stream.EmitAbbrev(Abv);
745}
746
Chris Lattner19cea4e2009-04-22 05:57:30 +0000747//===----------------------------------------------------------------------===//
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000748// ASTWriter Implementation
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000749//===----------------------------------------------------------------------===//
750
Chris Lattner28fa4e62009-04-26 22:26:21 +0000751static void EmitBlockID(unsigned ID, const char *Name,
752 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000753 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000754 Record.clear();
755 Record.push_back(ID);
756 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
757
758 // Emit the block name if present.
Craig Toppera13603a2014-05-22 05:54:18 +0000759 if (!Name || Name[0] == 0)
760 return;
Chris Lattner28fa4e62009-04-26 22:26:21 +0000761 Record.clear();
762 while (*Name)
763 Record.push_back(*Name++);
764 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record);
765}
766
767static void EmitRecordID(unsigned ID, const char *Name,
768 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000769 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000770 Record.clear();
771 Record.push_back(ID);
772 while (*Name)
773 Record.push_back(*Name++);
774 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000775}
776
777static void AddStmtsExprs(llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000778 ASTWriter::RecordDataImpl &Record) {
Sebastian Redl539c5062010-08-18 23:57:32 +0000779#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Chris Lattnerccac3a62009-04-27 00:49:53 +0000780 RECORD(STMT_STOP);
781 RECORD(STMT_NULL_PTR);
Richard Smith01b2cb42014-07-26 06:37:51 +0000782 RECORD(STMT_REF_PTR);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000783 RECORD(STMT_NULL);
784 RECORD(STMT_COMPOUND);
785 RECORD(STMT_CASE);
786 RECORD(STMT_DEFAULT);
787 RECORD(STMT_LABEL);
Richard Smithc202b282012-04-14 00:33:13 +0000788 RECORD(STMT_ATTRIBUTED);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000789 RECORD(STMT_IF);
790 RECORD(STMT_SWITCH);
791 RECORD(STMT_WHILE);
792 RECORD(STMT_DO);
793 RECORD(STMT_FOR);
794 RECORD(STMT_GOTO);
795 RECORD(STMT_INDIRECT_GOTO);
796 RECORD(STMT_CONTINUE);
797 RECORD(STMT_BREAK);
798 RECORD(STMT_RETURN);
799 RECORD(STMT_DECL);
Chad Rosierde70e0e2012-08-25 00:11:56 +0000800 RECORD(STMT_GCCASM);
Chad Rosiere30d4992012-08-24 23:51:02 +0000801 RECORD(STMT_MSASM);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000802 RECORD(EXPR_PREDEFINED);
803 RECORD(EXPR_DECL_REF);
804 RECORD(EXPR_INTEGER_LITERAL);
805 RECORD(EXPR_FLOATING_LITERAL);
806 RECORD(EXPR_IMAGINARY_LITERAL);
807 RECORD(EXPR_STRING_LITERAL);
808 RECORD(EXPR_CHARACTER_LITERAL);
809 RECORD(EXPR_PAREN);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000810 RECORD(EXPR_PAREN_LIST);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000811 RECORD(EXPR_UNARY_OPERATOR);
812 RECORD(EXPR_SIZEOF_ALIGN_OF);
813 RECORD(EXPR_ARRAY_SUBSCRIPT);
814 RECORD(EXPR_CALL);
815 RECORD(EXPR_MEMBER);
816 RECORD(EXPR_BINARY_OPERATOR);
817 RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR);
818 RECORD(EXPR_CONDITIONAL_OPERATOR);
819 RECORD(EXPR_IMPLICIT_CAST);
820 RECORD(EXPR_CSTYLE_CAST);
821 RECORD(EXPR_COMPOUND_LITERAL);
822 RECORD(EXPR_EXT_VECTOR_ELEMENT);
823 RECORD(EXPR_INIT_LIST);
824 RECORD(EXPR_DESIGNATED_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000825 RECORD(EXPR_DESIGNATED_INIT_UPDATE);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000826 RECORD(EXPR_IMPLICIT_VALUE_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000827 RECORD(EXPR_NO_INIT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000828 RECORD(EXPR_VA_ARG);
829 RECORD(EXPR_ADDR_LABEL);
830 RECORD(EXPR_STMT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000831 RECORD(EXPR_CHOOSE);
832 RECORD(EXPR_GNU_NULL);
833 RECORD(EXPR_SHUFFLE_VECTOR);
834 RECORD(EXPR_BLOCK);
Peter Collingbourne91147592011-04-15 00:35:48 +0000835 RECORD(EXPR_GENERIC_SELECTION);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000836 RECORD(EXPR_OBJC_STRING_LITERAL);
Patrick Beard0caa3942012-04-19 00:25:12 +0000837 RECORD(EXPR_OBJC_BOXED_EXPRESSION);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000838 RECORD(EXPR_OBJC_ARRAY_LITERAL);
839 RECORD(EXPR_OBJC_DICTIONARY_LITERAL);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000840 RECORD(EXPR_OBJC_ENCODE);
841 RECORD(EXPR_OBJC_SELECTOR_EXPR);
842 RECORD(EXPR_OBJC_PROTOCOL_EXPR);
843 RECORD(EXPR_OBJC_IVAR_REF_EXPR);
844 RECORD(EXPR_OBJC_PROPERTY_REF_EXPR);
845 RECORD(EXPR_OBJC_KVC_REF_EXPR);
846 RECORD(EXPR_OBJC_MESSAGE_EXPR);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000847 RECORD(STMT_OBJC_FOR_COLLECTION);
848 RECORD(STMT_OBJC_CATCH);
849 RECORD(STMT_OBJC_FINALLY);
850 RECORD(STMT_OBJC_AT_TRY);
851 RECORD(STMT_OBJC_AT_SYNCHRONIZED);
852 RECORD(STMT_OBJC_AT_THROW);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000853 RECORD(EXPR_OBJC_BOOL_LITERAL);
Richard Smith01b2cb42014-07-26 06:37:51 +0000854 RECORD(STMT_CXX_CATCH);
855 RECORD(STMT_CXX_TRY);
856 RECORD(STMT_CXX_FOR_RANGE);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000857 RECORD(EXPR_CXX_OPERATOR_CALL);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000858 RECORD(EXPR_CXX_MEMBER_CALL);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000859 RECORD(EXPR_CXX_CONSTRUCT);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000860 RECORD(EXPR_CXX_TEMPORARY_OBJECT);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000861 RECORD(EXPR_CXX_STATIC_CAST);
862 RECORD(EXPR_CXX_DYNAMIC_CAST);
863 RECORD(EXPR_CXX_REINTERPRET_CAST);
864 RECORD(EXPR_CXX_CONST_CAST);
865 RECORD(EXPR_CXX_FUNCTIONAL_CAST);
Richard Smithc67fdd42012-03-07 08:35:16 +0000866 RECORD(EXPR_USER_DEFINED_LITERAL);
Richard Smithcc1b96d2013-06-12 22:31:48 +0000867 RECORD(EXPR_CXX_STD_INITIALIZER_LIST);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000868 RECORD(EXPR_CXX_BOOL_LITERAL);
869 RECORD(EXPR_CXX_NULL_PTR_LITERAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000870 RECORD(EXPR_CXX_TYPEID_EXPR);
871 RECORD(EXPR_CXX_TYPEID_TYPE);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000872 RECORD(EXPR_CXX_THIS);
873 RECORD(EXPR_CXX_THROW);
874 RECORD(EXPR_CXX_DEFAULT_ARG);
Richard Smith01b2cb42014-07-26 06:37:51 +0000875 RECORD(EXPR_CXX_DEFAULT_INIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000876 RECORD(EXPR_CXX_BIND_TEMPORARY);
877 RECORD(EXPR_CXX_SCALAR_VALUE_INIT);
878 RECORD(EXPR_CXX_NEW);
879 RECORD(EXPR_CXX_DELETE);
880 RECORD(EXPR_CXX_PSEUDO_DESTRUCTOR);
881 RECORD(EXPR_EXPR_WITH_CLEANUPS);
882 RECORD(EXPR_CXX_DEPENDENT_SCOPE_MEMBER);
883 RECORD(EXPR_CXX_DEPENDENT_SCOPE_DECL_REF);
884 RECORD(EXPR_CXX_UNRESOLVED_CONSTRUCT);
885 RECORD(EXPR_CXX_UNRESOLVED_MEMBER);
886 RECORD(EXPR_CXX_UNRESOLVED_LOOKUP);
Richard Smith01b2cb42014-07-26 06:37:51 +0000887 RECORD(EXPR_CXX_EXPRESSION_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000888 RECORD(EXPR_CXX_NOEXCEPT);
889 RECORD(EXPR_OPAQUE_VALUE);
Richard Smith01b2cb42014-07-26 06:37:51 +0000890 RECORD(EXPR_BINARY_CONDITIONAL_OPERATOR);
891 RECORD(EXPR_TYPE_TRAIT);
892 RECORD(EXPR_ARRAY_TYPE_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000893 RECORD(EXPR_PACK_EXPANSION);
894 RECORD(EXPR_SIZEOF_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +0000895 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000896 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +0000897 RECORD(EXPR_FUNCTION_PARM_PACK);
898 RECORD(EXPR_MATERIALIZE_TEMPORARY);
Peter Collingbourne41f85462011-02-09 21:07:24 +0000899 RECORD(EXPR_CUDA_KERNEL_CALL);
Richard Smith01b2cb42014-07-26 06:37:51 +0000900 RECORD(EXPR_CXX_UUIDOF_EXPR);
901 RECORD(EXPR_CXX_UUIDOF_TYPE);
902 RECORD(EXPR_LAMBDA);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000903#undef RECORD
Chris Lattner28fa4e62009-04-26 22:26:21 +0000904}
Mike Stump11289f42009-09-09 15:08:12 +0000905
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000906void ASTWriter::WriteBlockInfoBlock() {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000907 RecordData Record;
908 Stream.EnterSubblock(llvm::bitc::BLOCKINFO_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +0000909
Sebastian Redl539c5062010-08-18 23:57:32 +0000910#define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record)
911#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Mike Stump11289f42009-09-09 15:08:12 +0000912
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000913 // Control Block.
914 BLOCK(CONTROL_BLOCK);
915 RECORD(METADATA);
Ben Langmuir487ea142014-10-23 18:05:36 +0000916 RECORD(SIGNATURE);
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000917 RECORD(MODULE_NAME);
Richard Smithfa715652015-08-31 22:43:10 +0000918 RECORD(MODULE_DIRECTORY);
Ben Langmuirbeee15e2014-04-14 18:00:01 +0000919 RECORD(MODULE_MAP_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000920 RECORD(IMPORTS);
Douglas Gregorfad10d82012-10-18 18:36:53 +0000921 RECORD(ORIGINAL_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000922 RECORD(ORIGINAL_PCH_DIR);
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +0000923 RECORD(ORIGINAL_FILE_ID);
Douglas Gregor3120d2c2012-10-22 18:42:04 +0000924 RECORD(INPUT_FILE_OFFSETS);
Richard Smith0516b182015-09-08 19:40:14 +0000925
926 BLOCK(OPTIONS_BLOCK);
927 RECORD(LANGUAGE_OPTIONS);
928 RECORD(TARGET_OPTIONS);
Douglas Gregor8263ffb2012-10-24 15:17:15 +0000929 RECORD(DIAGNOSTIC_OPTIONS);
Douglas Gregorc6317db2012-10-24 15:49:58 +0000930 RECORD(FILE_SYSTEM_OPTIONS);
Douglas Gregor2d302362012-10-24 16:50:34 +0000931 RECORD(HEADER_SEARCH_OPTIONS);
Douglas Gregorb6af6c22012-10-24 20:05:57 +0000932 RECORD(PREPROCESSOR_OPTIONS);
933
Douglas Gregor108cb222012-10-19 00:45:00 +0000934 BLOCK(INPUT_FILES_BLOCK);
935 RECORD(INPUT_FILE);
936
Douglas Gregor0aa21c92012-10-18 18:27:37 +0000937 // AST Top-Level Block.
938 BLOCK(AST_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000939 RECORD(TYPE_OFFSET);
940 RECORD(DECL_OFFSET);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000941 RECORD(IDENTIFIER_OFFSET);
942 RECORD(IDENTIFIER_TABLE);
Ben Langmuir332aafe2014-01-31 01:06:56 +0000943 RECORD(EAGERLY_DESERIALIZED_DECLS);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000944 RECORD(SPECIAL_TYPES);
945 RECORD(STATISTICS);
946 RECORD(TENTATIVE_DEFINITIONS);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000947 RECORD(SELECTOR_OFFSETS);
948 RECORD(METHOD_POOL);
949 RECORD(PP_COUNTER_VALUE);
Douglas Gregor258ae542009-04-27 06:38:32 +0000950 RECORD(SOURCE_LOCATION_OFFSETS);
951 RECORD(SOURCE_LOCATION_PRELOADS);
Douglas Gregor61cac2b2009-04-27 20:06:05 +0000952 RECORD(EXT_VECTOR_DECLS);
Richard Smithfa715652015-08-31 22:43:10 +0000953 RECORD(UNUSED_FILESCOPED_DECLS);
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +0000954 RECORD(PPD_ENTITIES_OFFSETS);
Richard Smithfa715652015-08-31 22:43:10 +0000955 RECORD(VTABLE_USES);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +0000956 RECORD(REFERENCED_SELECTOR_POOL);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000957 RECORD(TU_UPDATE_LEXICAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000958 RECORD(SEMA_DECL_REFS);
959 RECORD(WEAK_UNDECLARED_IDENTIFIERS);
960 RECORD(PENDING_IMPLICIT_INSTANTIATIONS);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000961 RECORD(UPDATE_VISIBLE);
962 RECORD(DECL_UPDATE_OFFSETS);
963 RECORD(DECL_UPDATES);
964 RECORD(CXX_BASE_SPECIFIER_OFFSETS);
965 RECORD(DIAG_PRAGMA_MAPPINGS);
Peter Collingbourne5df20e02011-02-15 19:46:30 +0000966 RECORD(CUDA_SPECIAL_DECL_REFS);
Douglas Gregor09b69892011-02-10 17:09:37 +0000967 RECORD(HEADER_SEARCH_TABLE);
Peter Collingbourne5df20e02011-02-15 19:46:30 +0000968 RECORD(FP_PRAGMA_OPTIONS);
969 RECORD(OPENCL_EXTENSIONS);
Alexis Hunt27a761d2011-05-04 23:29:54 +0000970 RECORD(DELEGATING_CTORS);
Douglas Gregorc2fa1692011-06-28 16:20:02 +0000971 RECORD(KNOWN_NAMESPACES);
Douglas Gregor78d0b572011-08-04 16:39:39 +0000972 RECORD(MODULE_OFFSET_MAP);
973 RECORD(SOURCE_MANAGER_LINE_TABLE);
Douglas Gregor404cdde2012-01-27 01:47:08 +0000974 RECORD(OBJC_CATEGORIES_MAP);
Douglas Gregor66e4add2011-12-19 21:09:25 +0000975 RECORD(FILE_SORTED_DECLS);
976 RECORD(IMPORTED_MODULES);
Douglas Gregor404cdde2012-01-27 01:47:08 +0000977 RECORD(OBJC_CATEGORIES);
Douglas Gregorcb28f9d2012-10-09 23:05:51 +0000978 RECORD(MACRO_OFFSET);
Richard Smithfa715652015-08-31 22:43:10 +0000979 RECORD(INTERESTING_IDENTIFIERS);
980 RECORD(UNDEFINED_BUT_USED);
Richard Smithe40f2ba2013-08-07 21:41:30 +0000981 RECORD(LATE_PARSED_TEMPLATE);
Dario Domizioli13a0a382014-05-23 12:13:25 +0000982 RECORD(OPTIMIZE_PRAGMA_OPTIONS);
Nico Weber779355f2016-03-02 23:22:00 +0000983 RECORD(MSSTRUCT_PRAGMA_OPTIONS);
Nico Weber42932312016-03-03 00:17:35 +0000984 RECORD(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS);
Richard Smithfa715652015-08-31 22:43:10 +0000985 RECORD(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES);
Richard Smithfa715652015-08-31 22:43:10 +0000986 RECORD(DELETE_EXPRS_TO_ANALYZE);
Douglas Gregor358cd442012-01-15 16:58:34 +0000987
Chris Lattner28fa4e62009-04-26 22:26:21 +0000988 // SourceManager Block.
Chris Lattner64031982009-04-27 00:40:25 +0000989 BLOCK(SOURCE_MANAGER_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000990 RECORD(SM_SLOC_FILE_ENTRY);
991 RECORD(SM_SLOC_BUFFER_ENTRY);
992 RECORD(SM_SLOC_BUFFER_BLOB);
Richard Smithaada85c2016-02-06 02:06:43 +0000993 RECORD(SM_SLOC_BUFFER_BLOB_COMPRESSED);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +0000994 RECORD(SM_SLOC_EXPANSION_ENTRY);
Mike Stump11289f42009-09-09 15:08:12 +0000995
Chris Lattner28fa4e62009-04-26 22:26:21 +0000996 // Preprocessor Block.
Chris Lattner64031982009-04-27 00:40:25 +0000997 BLOCK(PREPROCESSOR_BLOCK);
Richard Smithec216502015-02-13 19:48:37 +0000998 RECORD(PP_MACRO_DIRECTIVE_HISTORY);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000999 RECORD(PP_MACRO_FUNCTION_LIKE);
Richard Smithd7329392015-04-21 21:46:32 +00001000 RECORD(PP_MACRO_OBJECT_LIKE);
1001 RECORD(PP_MODULE_MACRO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001002 RECORD(PP_TOKEN);
Richard Smithec216502015-02-13 19:48:37 +00001003
Richard Smithfa715652015-08-31 22:43:10 +00001004 // Submodule Block.
1005 BLOCK(SUBMODULE_BLOCK);
1006 RECORD(SUBMODULE_METADATA);
1007 RECORD(SUBMODULE_DEFINITION);
1008 RECORD(SUBMODULE_UMBRELLA_HEADER);
1009 RECORD(SUBMODULE_HEADER);
1010 RECORD(SUBMODULE_TOPHEADER);
1011 RECORD(SUBMODULE_UMBRELLA_DIR);
1012 RECORD(SUBMODULE_IMPORTS);
1013 RECORD(SUBMODULE_EXPORTS);
1014 RECORD(SUBMODULE_REQUIRES);
1015 RECORD(SUBMODULE_EXCLUDED_HEADER);
1016 RECORD(SUBMODULE_LINK_LIBRARY);
1017 RECORD(SUBMODULE_CONFIG_MACRO);
1018 RECORD(SUBMODULE_CONFLICT);
1019 RECORD(SUBMODULE_PRIVATE_HEADER);
1020 RECORD(SUBMODULE_TEXTUAL_HEADER);
1021 RECORD(SUBMODULE_PRIVATE_TEXTUAL_HEADER);
1022
1023 // Comments Block.
1024 BLOCK(COMMENTS_BLOCK);
1025 RECORD(COMMENTS_RAW_COMMENT);
1026
Douglas Gregor12bfa382009-10-17 00:13:19 +00001027 // Decls and Types block.
1028 BLOCK(DECLTYPES_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001029 RECORD(TYPE_EXT_QUAL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001030 RECORD(TYPE_COMPLEX);
1031 RECORD(TYPE_POINTER);
1032 RECORD(TYPE_BLOCK_POINTER);
1033 RECORD(TYPE_LVALUE_REFERENCE);
1034 RECORD(TYPE_RVALUE_REFERENCE);
1035 RECORD(TYPE_MEMBER_POINTER);
1036 RECORD(TYPE_CONSTANT_ARRAY);
1037 RECORD(TYPE_INCOMPLETE_ARRAY);
1038 RECORD(TYPE_VARIABLE_ARRAY);
1039 RECORD(TYPE_VECTOR);
1040 RECORD(TYPE_EXT_VECTOR);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001041 RECORD(TYPE_FUNCTION_NO_PROTO);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001042 RECORD(TYPE_FUNCTION_PROTO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001043 RECORD(TYPE_TYPEDEF);
1044 RECORD(TYPE_TYPEOF_EXPR);
1045 RECORD(TYPE_TYPEOF);
1046 RECORD(TYPE_RECORD);
1047 RECORD(TYPE_ENUM);
1048 RECORD(TYPE_OBJC_INTERFACE);
Steve Narofffb4330f2009-06-17 22:40:22 +00001049 RECORD(TYPE_OBJC_OBJECT_POINTER);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001050 RECORD(TYPE_DECLTYPE);
1051 RECORD(TYPE_ELABORATED);
1052 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
1053 RECORD(TYPE_UNRESOLVED_USING);
1054 RECORD(TYPE_INJECTED_CLASS_NAME);
1055 RECORD(TYPE_OBJC_OBJECT);
1056 RECORD(TYPE_TEMPLATE_TYPE_PARM);
1057 RECORD(TYPE_TEMPLATE_SPECIALIZATION);
1058 RECORD(TYPE_DEPENDENT_NAME);
1059 RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION);
1060 RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
1061 RECORD(TYPE_PAREN);
1062 RECORD(TYPE_PACK_EXPANSION);
1063 RECORD(TYPE_ATTRIBUTED);
1064 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001065 RECORD(TYPE_AUTO);
1066 RECORD(TYPE_UNARY_TRANSFORM);
Eli Friedman0dfb8892011-10-06 23:00:33 +00001067 RECORD(TYPE_ATOMIC);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001068 RECORD(TYPE_DECAYED);
1069 RECORD(TYPE_ADJUSTED);
Richard Smithd61d4ac2015-08-22 20:13:39 +00001070 RECORD(LOCAL_REDECLARATIONS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001071 RECORD(DECL_TYPEDEF);
Richard Smith01b2cb42014-07-26 06:37:51 +00001072 RECORD(DECL_TYPEALIAS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001073 RECORD(DECL_ENUM);
1074 RECORD(DECL_RECORD);
1075 RECORD(DECL_ENUM_CONSTANT);
1076 RECORD(DECL_FUNCTION);
1077 RECORD(DECL_OBJC_METHOD);
1078 RECORD(DECL_OBJC_INTERFACE);
1079 RECORD(DECL_OBJC_PROTOCOL);
1080 RECORD(DECL_OBJC_IVAR);
1081 RECORD(DECL_OBJC_AT_DEFS_FIELD);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001082 RECORD(DECL_OBJC_CATEGORY);
1083 RECORD(DECL_OBJC_CATEGORY_IMPL);
1084 RECORD(DECL_OBJC_IMPLEMENTATION);
1085 RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
1086 RECORD(DECL_OBJC_PROPERTY);
1087 RECORD(DECL_OBJC_PROPERTY_IMPL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001088 RECORD(DECL_FIELD);
John McCall5e77d762013-04-16 07:28:30 +00001089 RECORD(DECL_MS_PROPERTY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001090 RECORD(DECL_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001091 RECORD(DECL_IMPLICIT_PARAM);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001092 RECORD(DECL_PARM_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001093 RECORD(DECL_FILE_SCOPE_ASM);
1094 RECORD(DECL_BLOCK);
1095 RECORD(DECL_CONTEXT_LEXICAL);
1096 RECORD(DECL_CONTEXT_VISIBLE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001097 RECORD(DECL_NAMESPACE);
1098 RECORD(DECL_NAMESPACE_ALIAS);
1099 RECORD(DECL_USING);
1100 RECORD(DECL_USING_SHADOW);
1101 RECORD(DECL_USING_DIRECTIVE);
1102 RECORD(DECL_UNRESOLVED_USING_VALUE);
1103 RECORD(DECL_UNRESOLVED_USING_TYPENAME);
1104 RECORD(DECL_LINKAGE_SPEC);
1105 RECORD(DECL_CXX_RECORD);
1106 RECORD(DECL_CXX_METHOD);
1107 RECORD(DECL_CXX_CONSTRUCTOR);
1108 RECORD(DECL_CXX_DESTRUCTOR);
1109 RECORD(DECL_CXX_CONVERSION);
1110 RECORD(DECL_ACCESS_SPEC);
1111 RECORD(DECL_FRIEND);
1112 RECORD(DECL_FRIEND_TEMPLATE);
1113 RECORD(DECL_CLASS_TEMPLATE);
1114 RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
1115 RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
Larisse Voufo39a1e502013-08-06 01:03:05 +00001116 RECORD(DECL_VAR_TEMPLATE);
1117 RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION);
1118 RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001119 RECORD(DECL_FUNCTION_TEMPLATE);
1120 RECORD(DECL_TEMPLATE_TYPE_PARM);
1121 RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
1122 RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
Richard Smithefc884a2016-04-13 07:41:35 +00001123 RECORD(DECL_TYPE_ALIAS_TEMPLATE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001124 RECORD(DECL_STATIC_ASSERT);
1125 RECORD(DECL_CXX_BASE_SPECIFIERS);
Richard Smithefc884a2016-04-13 07:41:35 +00001126 RECORD(DECL_CXX_CTOR_INITIALIZERS);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001127 RECORD(DECL_INDIRECTFIELD);
1128 RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smithefc884a2016-04-13 07:41:35 +00001129 RECORD(DECL_EXPANDED_TEMPLATE_TEMPLATE_PARM_PACK);
1130 RECORD(DECL_CLASS_SCOPE_FUNCTION_SPECIALIZATION);
1131 RECORD(DECL_IMPORT);
1132 RECORD(DECL_OMP_THREADPRIVATE);
1133 RECORD(DECL_EMPTY);
1134 RECORD(DECL_OBJC_TYPE_PARAM);
1135 RECORD(DECL_OMP_CAPTUREDEXPR);
1136 RECORD(DECL_PRAGMA_COMMENT);
1137 RECORD(DECL_PRAGMA_DETECT_MISMATCH);
1138 RECORD(DECL_OMP_DECLARE_REDUCTION);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001139
Douglas Gregor03412ba2011-06-03 02:27:19 +00001140 // Statements and Exprs can occur in the Decls and Types block.
1141 AddStmtsExprs(Stream, Record);
1142
Douglas Gregor92a96f52011-02-08 21:58:10 +00001143 BLOCK(PREPROCESSOR_DETAIL_BLOCK);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001144 RECORD(PPD_MACRO_EXPANSION);
Douglas Gregor92a96f52011-02-08 21:58:10 +00001145 RECORD(PPD_MACRO_DEFINITION);
1146 RECORD(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00001147
1148 // Decls and Types block.
1149 BLOCK(EXTENSION_BLOCK);
1150 RECORD(EXTENSION_METADATA);
1151
Chris Lattner28fa4e62009-04-26 22:26:21 +00001152#undef RECORD
1153#undef BLOCK
1154 Stream.ExitBlock();
1155}
1156
Richard Smith54cc3c22014-12-11 20:50:24 +00001157/// \brief Prepares a path for being written to an AST file by converting it
1158/// to an absolute path and removing nested './'s.
1159///
1160/// \return \c true if the path was changed.
Benjamin Kramer6a96ae52015-02-06 18:36:04 +00001161static bool cleanPathForOutput(FileManager &FileMgr,
1162 SmallVectorImpl<char> &Path) {
Argyrios Kyrtzidis403cbcb2015-07-31 01:39:23 +00001163 bool Changed = FileMgr.makeAbsolutePath(Path);
Mike Aizatskyaeb9dd92015-11-09 19:12:18 +00001164 return Changed | llvm::sys::path::remove_dots(Path);
Richard Smith54cc3c22014-12-11 20:50:24 +00001165}
1166
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001167/// \brief Adjusts the given filename to only write out the portion of the
1168/// filename that is not part of the system root directory.
Mike Stump11289f42009-09-09 15:08:12 +00001169///
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001170/// \param Filename the file name to adjust.
1171///
Richard Smith7ed1bc92014-12-05 22:42:13 +00001172/// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
1173/// the returned filename will be adjusted by this root directory.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001174///
1175/// \returns either the original filename (if it needs no adjustment) or the
1176/// adjusted filename (which points into the @p Filename parameter).
Mike Stump11289f42009-09-09 15:08:12 +00001177static const char *
Richard Smith7ed1bc92014-12-05 22:42:13 +00001178adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001179 assert(Filename && "No file name to adjust?");
Mike Stump11289f42009-09-09 15:08:12 +00001180
Richard Smith7ed1bc92014-12-05 22:42:13 +00001181 if (BaseDir.empty())
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001182 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001183
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001184 // Verify that the filename and the system root have the same prefix.
1185 unsigned Pos = 0;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001186 for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1187 if (Filename[Pos] != BaseDir[Pos])
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001188 return Filename; // Prefixes don't match.
Mike Stump11289f42009-09-09 15:08:12 +00001189
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001190 // We hit the end of the filename before we hit the end of the system root.
1191 if (!Filename[Pos])
1192 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001193
Richard Smith7ed1bc92014-12-05 22:42:13 +00001194 // If there's not a path separator at the end of the base directory nor
1195 // immediately after it, then this isn't within the base directory.
1196 if (!llvm::sys::path::is_separator(Filename[Pos])) {
1197 if (!llvm::sys::path::is_separator(BaseDir.back()))
1198 return Filename;
1199 } else {
1200 // If the file name has a '/' at the current position, skip over the '/'.
1201 // We distinguish relative paths from absolute paths by the
1202 // absence of '/' at the beginning of relative paths.
1203 //
1204 // FIXME: This is wrong. We distinguish them by asking if the path is
1205 // absolute, which isn't the same thing. And there might be multiple '/'s
1206 // in a row. Use a better mechanism to indicate whether we have emitted an
1207 // absolute or relative path.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001208 ++Pos;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001209 }
Mike Stump11289f42009-09-09 15:08:12 +00001210
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001211 return Filename + Pos;
1212}
Chris Lattner28fa4e62009-04-26 22:26:21 +00001213
Ben Langmuir487ea142014-10-23 18:05:36 +00001214static ASTFileSignature getSignature() {
1215 while (1) {
1216 if (ASTFileSignature S = llvm::sys::Process::GetRandomNumber())
1217 return S;
1218 // Rely on GetRandomNumber to eventually return non-zero...
1219 }
1220}
1221
Douglas Gregor112b9072012-10-18 05:31:06 +00001222/// \brief Write the control block.
Adrian Prantladbd2b12015-09-22 23:26:31 +00001223uint64_t ASTWriter::WriteControlBlock(Preprocessor &PP,
1224 ASTContext &Context,
1225 StringRef isysroot,
1226 const std::string &OutputFile) {
1227 ASTFileSignature Signature = 0;
1228
Douglas Gregorbfbde532009-04-10 21:16:55 +00001229 using namespace llvm;
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001230 Stream.EnterSubblock(CONTROL_BLOCK_ID, 5);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001231 RecordData Record;
1232
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001233 // Metadata
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001234 auto *MetadataAbbrev = new BitCodeAbbrev();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001235 MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA));
1236 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1237 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1238 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1239 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1240 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
Richard Smithe75ee0f2015-08-17 07:13:32 +00001241 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Timestamps
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001242 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1243 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
1244 unsigned MetadataAbbrevCode = Stream.EmitAbbrev(MetadataAbbrev);
Richard Smith7ed1bc92014-12-05 22:42:13 +00001245 assert((!WritingModule || isysroot.empty()) &&
1246 "writing module as a relocatable PCH?");
Mehdi Amini57a41912015-09-10 01:46:39 +00001247 {
1248 RecordData::value_type Record[] = {METADATA, VERSION_MAJOR, VERSION_MINOR,
1249 CLANG_VERSION_MAJOR, CLANG_VERSION_MINOR,
1250 !isysroot.empty(), IncludeTimestamps,
1251 ASTHasCompilerErrors};
1252 Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record,
1253 getClangFullRepositoryVersion());
1254 }
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001255 if (WritingModule) {
Chandler Carruth885e78c2015-03-24 21:18:10 +00001256 // For implicit modules we output a signature that we can use to ensure
1257 // duplicate module builds don't collide in the cache as their output order
1258 // is non-deterministic.
1259 // FIXME: Remove this when output is deterministic.
1260 if (Context.getLangOpts().ImplicitModules) {
Adrian Prantladbd2b12015-09-22 23:26:31 +00001261 Signature = getSignature();
1262 RecordData::value_type Record[] = {Signature};
Chandler Carruth885e78c2015-03-24 21:18:10 +00001263 Stream.EmitRecord(SIGNATURE, Record);
1264 }
1265
Richard Smith7ed1bc92014-12-05 22:42:13 +00001266 // Module name
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001267 auto *Abbrev = new BitCodeAbbrev();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001268 Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME));
1269 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
1270 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
Mehdi Amini57a41912015-09-10 01:46:39 +00001271 RecordData::value_type Record[] = {MODULE_NAME};
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001272 Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name);
1273 }
1274
Richard Smith7ed1bc92014-12-05 22:42:13 +00001275 if (WritingModule && WritingModule->Directory) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001276 SmallString<128> BaseDir(WritingModule->Directory->getName());
Richard Smith54cc3c22014-12-11 20:50:24 +00001277 cleanPathForOutput(Context.getSourceManager().getFileManager(), BaseDir);
Richard Smithf7b41372015-08-13 23:47:44 +00001278
1279 // If the home of the module is the current working directory, then we
1280 // want to pick up the cwd of the build process loading the module, not
1281 // our cwd, when we load this module.
1282 if (!PP.getHeaderSearchInfo()
1283 .getHeaderSearchOpts()
1284 .ModuleMapFileHomeIsCwd ||
1285 WritingModule->Directory->getName() != StringRef(".")) {
1286 // Module directory.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001287 auto *Abbrev = new BitCodeAbbrev();
Richard Smithf7b41372015-08-13 23:47:44 +00001288 Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY));
1289 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
1290 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1291
Mehdi Amini57a41912015-09-10 01:46:39 +00001292 RecordData::value_type Record[] = {MODULE_DIRECTORY};
Richard Smithf7b41372015-08-13 23:47:44 +00001293 Stream.EmitRecordWithBlob(AbbrevCode, Record, BaseDir);
1294 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001295
1296 // Write out all other paths relative to the base directory if possible.
1297 BaseDirectory.assign(BaseDir.begin(), BaseDir.end());
1298 } else if (!isysroot.empty()) {
1299 // Write out paths relative to the sysroot if possible.
1300 BaseDirectory = isysroot;
1301 }
1302
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001303 // Module map file
1304 if (WritingModule) {
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001305 Record.clear();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001306
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001307 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
1308
1309 // Primary module map file.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001310 AddPath(Map.getModuleMapFileForUniquing(WritingModule)->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001311
1312 // Additional module map files.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001313 if (auto *AdditionalModMaps =
1314 Map.getAdditionalModuleMapFiles(WritingModule)) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001315 Record.push_back(AdditionalModMaps->size());
1316 for (const FileEntry *F : *AdditionalModMaps)
Richard Smith7ed1bc92014-12-05 22:42:13 +00001317 AddPath(F->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001318 } else {
1319 Record.push_back(0);
1320 }
1321
1322 Stream.EmitRecord(MODULE_MAP_FILE, Record);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001323 }
1324
Douglas Gregor112b9072012-10-18 05:31:06 +00001325 // Imports
Douglas Gregor29cc6422011-08-17 21:07:30 +00001326 if (Chain) {
Douglas Gregor29cc6422011-08-17 21:07:30 +00001327 serialization::ModuleManager &Mgr = Chain->getModuleManager();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001328 Record.clear();
Douglas Gregordf0c1512011-08-18 04:12:04 +00001329
Richard Smith7f330cd2015-03-18 01:42:29 +00001330 for (auto *M : Mgr) {
Douglas Gregordf0c1512011-08-18 04:12:04 +00001331 // Skip modules that weren't directly imported.
Richard Smith7f330cd2015-03-18 01:42:29 +00001332 if (!M->isDirectlyImported())
Douglas Gregordf0c1512011-08-18 04:12:04 +00001333 continue;
1334
Richard Smith7f330cd2015-03-18 01:42:29 +00001335 Record.push_back((unsigned)M->Kind); // FIXME: Stable encoding
1336 AddSourceLocation(M->ImportLoc, Record);
1337 Record.push_back(M->File->getSize());
Richard Smithe75ee0f2015-08-17 07:13:32 +00001338 Record.push_back(getTimestampForOutput(M->File));
Richard Smith7f330cd2015-03-18 01:42:29 +00001339 Record.push_back(M->Signature);
1340 AddPath(M->FileName, Record);
Douglas Gregordf0c1512011-08-18 04:12:04 +00001341 }
Douglas Gregor29cc6422011-08-17 21:07:30 +00001342 Stream.EmitRecord(IMPORTS, Record);
1343 }
Mike Stump11289f42009-09-09 15:08:12 +00001344
Richard Smith0516b182015-09-08 19:40:14 +00001345 // Write the options block.
1346 Stream.EnterSubblock(OPTIONS_BLOCK_ID, 4);
1347
Douglas Gregor112b9072012-10-18 05:31:06 +00001348 // Language options.
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001349 Record.clear();
Douglas Gregor112b9072012-10-18 05:31:06 +00001350 const LangOptions &LangOpts = Context.getLangOpts();
1351#define LANGOPT(Name, Bits, Default, Description) \
1352 Record.push_back(LangOpts.Name);
1353#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
1354 Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001355#include "clang/Basic/LangOptions.def"
1356#define SANITIZER(NAME, ID) \
1357 Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
Will Dietzf54319c2013-01-18 11:30:38 +00001358#include "clang/Basic/Sanitizers.def"
Douglas Gregor112b9072012-10-18 05:31:06 +00001359
Ben Langmuircd98cb72015-06-23 18:20:18 +00001360 Record.push_back(LangOpts.ModuleFeatures.size());
1361 for (StringRef Feature : LangOpts.ModuleFeatures)
1362 AddString(Feature, Record);
1363
Douglas Gregor112b9072012-10-18 05:31:06 +00001364 Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind());
1365 AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record);
Ben Langmuird4a667a2015-06-23 18:20:23 +00001366
1367 AddString(LangOpts.CurrentModule, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001368
1369 // Comment options.
1370 Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001371 for (const auto &I : LangOpts.CommentOpts.BlockCommandNames) {
1372 AddString(I, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001373 }
Dmitri Gribenkoa7d16ce2013-04-10 15:35:17 +00001374 Record.push_back(LangOpts.CommentOpts.ParseAllComments);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001375
Samuel Antaoee8fb302016-01-06 13:42:12 +00001376 // OpenMP offloading options.
1377 Record.push_back(LangOpts.OMPTargetTriples.size());
1378 for (auto &T : LangOpts.OMPTargetTriples)
1379 AddString(T.getTriple(), Record);
1380
1381 AddString(LangOpts.OMPHostIRFile, Record);
1382
Douglas Gregor112b9072012-10-18 05:31:06 +00001383 Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1384
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001385 // Target options.
1386 Record.clear();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001387 const TargetInfo &Target = Context.getTargetInfo();
1388 const TargetOptions &TargetOpts = Target.getTargetOpts();
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001389 AddString(TargetOpts.Triple, Record);
1390 AddString(TargetOpts.CPU, Record);
1391 AddString(TargetOpts.ABI, Record);
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001392 Record.push_back(TargetOpts.FeaturesAsWritten.size());
1393 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1394 AddString(TargetOpts.FeaturesAsWritten[I], Record);
1395 }
1396 Record.push_back(TargetOpts.Features.size());
1397 for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1398 AddString(TargetOpts.Features[I], Record);
1399 }
1400 Stream.EmitRecord(TARGET_OPTIONS, Record);
1401
Douglas Gregor8263ffb2012-10-24 15:17:15 +00001402 // Diagnostic options.
1403 Record.clear();
1404 const DiagnosticOptions &DiagOpts
1405 = Context.getDiagnostics().getDiagnosticOptions();
1406#define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1407#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
1408 Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1409#include "clang/Basic/DiagnosticOptions.def"
1410 Record.push_back(DiagOpts.Warnings.size());
1411 for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1412 AddString(DiagOpts.Warnings[I], Record);
Richard Smith3be1cb22014-08-07 00:24:21 +00001413 Record.push_back(DiagOpts.Remarks.size());
1414 for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1415 AddString(DiagOpts.Remarks[I], Record);
Douglas Gregor8263ffb2012-10-24 15:17:15 +00001416 // Note: we don't serialize the log or serialization file names, because they
1417 // are generally transient files and will almost always be overridden.
1418 Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record);
1419
Douglas Gregorc6317db2012-10-24 15:49:58 +00001420 // File system options.
1421 Record.clear();
Yaron Keren8dec46c2015-08-26 08:10:22 +00001422 const FileSystemOptions &FSOpts =
1423 Context.getSourceManager().getFileManager().getFileSystemOpts();
Douglas Gregorc6317db2012-10-24 15:49:58 +00001424 AddString(FSOpts.WorkingDir, Record);
1425 Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record);
1426
Douglas Gregor2d302362012-10-24 16:50:34 +00001427 // Header search options.
1428 Record.clear();
1429 const HeaderSearchOptions &HSOpts
1430 = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1431 AddString(HSOpts.Sysroot, Record);
1432
1433 // Include entries.
1434 Record.push_back(HSOpts.UserEntries.size());
1435 for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1436 const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1437 AddString(Entry.Path, Record);
1438 Record.push_back(static_cast<unsigned>(Entry.Group));
Douglas Gregor2d302362012-10-24 16:50:34 +00001439 Record.push_back(Entry.IsFramework);
1440 Record.push_back(Entry.IgnoreSysRoot);
Douglas Gregor2d302362012-10-24 16:50:34 +00001441 }
1442
1443 // System header prefixes.
1444 Record.push_back(HSOpts.SystemHeaderPrefixes.size());
1445 for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1446 AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1447 Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1448 }
1449
1450 AddString(HSOpts.ResourceDir, Record);
1451 AddString(HSOpts.ModuleCachePath, Record);
Argyrios Kyrtzidis1594c152014-03-03 08:12:05 +00001452 AddString(HSOpts.ModuleUserBuildPath, Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001453 Record.push_back(HSOpts.DisableModuleHash);
1454 Record.push_back(HSOpts.UseBuiltinIncludes);
1455 Record.push_back(HSOpts.UseStandardSystemIncludes);
1456 Record.push_back(HSOpts.UseStandardCXXIncludes);
1457 Record.push_back(HSOpts.UseLibcxx);
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00001458 // Write out the specific module cache path that contains the module files.
1459 AddString(PP.getHeaderSearchInfo().getModuleCachePath(), Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001460 Stream.EmitRecord(HEADER_SEARCH_OPTIONS, Record);
1461
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001462 // Preprocessor options.
1463 Record.clear();
1464 const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts();
1465
1466 // Macro definitions.
1467 Record.push_back(PPOpts.Macros.size());
1468 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1469 AddString(PPOpts.Macros[I].first, Record);
1470 Record.push_back(PPOpts.Macros[I].second);
1471 }
1472
1473 // Includes
1474 Record.push_back(PPOpts.Includes.size());
1475 for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1476 AddString(PPOpts.Includes[I], Record);
1477
1478 // Macro includes
1479 Record.push_back(PPOpts.MacroIncludes.size());
1480 for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1481 AddString(PPOpts.MacroIncludes[I], Record);
1482
Douglas Gregorb6368752012-10-24 23:41:50 +00001483 Record.push_back(PPOpts.UsePredefines);
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +00001484 // Detailed record is important since it is used for the module cache hash.
1485 Record.push_back(PPOpts.DetailedRecord);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001486 AddString(PPOpts.ImplicitPCHInclude, Record);
1487 AddString(PPOpts.ImplicitPTHInclude, Record);
1488 Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1489 Stream.EmitRecord(PREPROCESSOR_OPTIONS, Record);
1490
Richard Smith0516b182015-09-08 19:40:14 +00001491 // Leave the options block.
1492 Stream.ExitBlock();
1493
Douglas Gregora3b20262011-05-06 21:43:30 +00001494 // Original file name and file ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001495 SourceManager &SM = Context.getSourceManager();
1496 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001497 auto *FileAbbrev = new BitCodeAbbrev();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001498 FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE));
1499 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001500 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1501 unsigned FileAbbrevCode = Stream.EmitAbbrev(FileAbbrev);
1502
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001503 Record.clear();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001504 Record.push_back(ORIGINAL_FILE);
Douglas Gregora3b20262011-05-06 21:43:30 +00001505 Record.push_back(SM.getMainFileID().getOpaqueValue());
Richard Smith7ed1bc92014-12-05 22:42:13 +00001506 EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName());
Douglas Gregor45fe0362009-05-12 01:31:05 +00001507 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001508
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001509 Record.clear();
1510 Record.push_back(SM.getMainFileID().getOpaqueValue());
1511 Stream.EmitRecord(ORIGINAL_FILE_ID, Record);
1512
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001513 // Original PCH directory
1514 if (!OutputFile.empty() && OutputFile != "-") {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001515 auto *Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001516 Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR));
1517 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1518 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1519
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001520 SmallString<128> OutputPath(OutputFile);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001521
Argyrios Kyrtzidisc56419e2015-07-31 00:58:32 +00001522 SM.getFileManager().makeAbsolutePath(OutputPath);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001523 StringRef origDir = llvm::sys::path::parent_path(OutputPath);
1524
Mehdi Amini57a41912015-09-10 01:46:39 +00001525 RecordData::value_type Record[] = {ORIGINAL_PCH_DIR};
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001526 Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir);
1527 }
1528
Douglas Gregor49491f72013-03-15 22:15:07 +00001529 WriteInputFiles(Context.SourceMgr,
1530 PP.getHeaderSearchInfo().getHeaderSearchOpts(),
Douglas Gregora3dd9002013-07-22 20:48:33 +00001531 PP.getLangOpts().Modules);
Douglas Gregor72be3902012-10-19 00:38:02 +00001532 Stream.ExitBlock();
Adrian Prantladbd2b12015-09-22 23:26:31 +00001533 return Signature;
Douglas Gregor72be3902012-10-19 00:38:02 +00001534}
1535
Douglas Gregor49491f72013-03-15 22:15:07 +00001536namespace {
1537 /// \brief An input file.
1538 struct InputFileEntry {
1539 const FileEntry *File;
1540 bool IsSystemFile;
Richard Smitha8cfffa2015-11-26 02:04:16 +00001541 bool IsTransient;
Douglas Gregor49491f72013-03-15 22:15:07 +00001542 bool BufferOverridden;
1543 };
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001544} // end anonymous namespace
Douglas Gregor49491f72013-03-15 22:15:07 +00001545
1546void ASTWriter::WriteInputFiles(SourceManager &SourceMgr,
1547 HeaderSearchOptions &HSOpts,
Douglas Gregora3dd9002013-07-22 20:48:33 +00001548 bool Modules) {
Douglas Gregor72be3902012-10-19 00:38:02 +00001549 using namespace llvm;
1550 Stream.EnterSubblock(INPUT_FILES_BLOCK_ID, 4);
Mehdi Amini57a41912015-09-10 01:46:39 +00001551
Douglas Gregor72be3902012-10-19 00:38:02 +00001552 // Create input-file abbreviation.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001553 auto *IFAbbrev = new BitCodeAbbrev();
Douglas Gregor72be3902012-10-19 00:38:02 +00001554 IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001555 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor72be3902012-10-19 00:38:02 +00001556 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1557 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001558 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
Richard Smitha8cfffa2015-11-26 02:04:16 +00001559 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Transient
Douglas Gregor72be3902012-10-19 00:38:02 +00001560 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1561 unsigned IFAbbrevCode = Stream.EmitAbbrev(IFAbbrev);
1562
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001563 // Get all ContentCache objects for files, sorted by whether the file is a
1564 // system one or not. System files go at the back, users files at the front.
Douglas Gregor49491f72013-03-15 22:15:07 +00001565 std::deque<InputFileEntry> SortedFiles;
Douglas Gregor72be3902012-10-19 00:38:02 +00001566 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
1567 // Get this source location entry.
1568 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
NAKAMURA Takumideca50f2012-10-19 01:53:57 +00001569 assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc);
Douglas Gregor72be3902012-10-19 00:38:02 +00001570
1571 // We only care about file entries that were not overridden.
1572 if (!SLoc->isFile())
1573 continue;
1574 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001575 if (!Cache->OrigEntry)
Douglas Gregor72be3902012-10-19 00:38:02 +00001576 continue;
1577
Douglas Gregor49491f72013-03-15 22:15:07 +00001578 InputFileEntry Entry;
1579 Entry.File = Cache->OrigEntry;
1580 Entry.IsSystemFile = Cache->IsSystemFile;
Richard Smitha8cfffa2015-11-26 02:04:16 +00001581 Entry.IsTransient = Cache->IsTransient;
Douglas Gregor49491f72013-03-15 22:15:07 +00001582 Entry.BufferOverridden = Cache->BufferOverridden;
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001583 if (Cache->IsSystemFile)
Douglas Gregor49491f72013-03-15 22:15:07 +00001584 SortedFiles.push_back(Entry);
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001585 else
Douglas Gregor49491f72013-03-15 22:15:07 +00001586 SortedFiles.push_front(Entry);
1587 }
1588
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001589 unsigned UserFilesNum = 0;
1590 // Write out all of the input files.
Richard Smithec216502015-02-13 19:48:37 +00001591 std::vector<uint64_t> InputFileOffsets;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001592 for (const auto &Entry : SortedFiles) {
Douglas Gregor49491f72013-03-15 22:15:07 +00001593 uint32_t &InputFileID = InputFileIDs[Entry.File];
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001594 if (InputFileID != 0)
1595 continue; // already recorded this file.
1596
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001597 // Record this entry's offset.
1598 InputFileOffsets.push_back(Stream.GetCurrentBitNo());
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001599
1600 InputFileID = InputFileOffsets.size();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001601
Douglas Gregor49491f72013-03-15 22:15:07 +00001602 if (!Entry.IsSystemFile)
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001603 ++UserFilesNum;
1604
Douglas Gregor72be3902012-10-19 00:38:02 +00001605 // Emit size/modification time for this file.
Mehdi Amini57a41912015-09-10 01:46:39 +00001606 // And whether this file was overridden.
1607 RecordData::value_type Record[] = {
Richard Smitha8cfffa2015-11-26 02:04:16 +00001608 INPUT_FILE,
1609 InputFileOffsets.size(),
1610 (uint64_t)Entry.File->getSize(),
1611 (uint64_t)getTimestampForOutput(Entry.File),
1612 Entry.BufferOverridden,
1613 Entry.IsTransient};
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001614
Richard Smith7ed1bc92014-12-05 22:42:13 +00001615 EmitRecordWithPath(IFAbbrevCode, Record, Entry.File->getName());
1616 }
Douglas Gregor49491f72013-03-15 22:15:07 +00001617
Douglas Gregor112b9072012-10-18 05:31:06 +00001618 Stream.ExitBlock();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001619
1620 // Create input file offsets abbreviation.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001621 auto *OffsetsAbbrev = new BitCodeAbbrev();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001622 OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1623 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001624 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1625 // input files
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001626 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Array
1627 unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(OffsetsAbbrev);
1628
1629 // Write input file offsets.
Mehdi Amini57a41912015-09-10 01:46:39 +00001630 RecordData::value_type Record[] = {INPUT_FILE_OFFSETS,
1631 InputFileOffsets.size(), UserFilesNum};
Reid Kleckner012665e2015-05-21 00:13:09 +00001632 Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, bytes(InputFileOffsets));
Douglas Gregor55abb232009-04-10 20:39:37 +00001633}
1634
Douglas Gregora7f71a92009-04-10 03:52:48 +00001635//===----------------------------------------------------------------------===//
1636// Source Manager Serialization
1637//===----------------------------------------------------------------------===//
1638
1639/// \brief Create an abbreviation for the SLocEntry that refers to a
1640/// file.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001641static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001642 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001643
1644 auto *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001645 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001646 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1647 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1648 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1649 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
Douglas Gregorb41ca8f2010-03-21 22:49:54 +00001650 // FileEntry fields.
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001651 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001652 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001653 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
1654 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
Douglas Gregor8f45df52009-04-16 22:23:12 +00001655 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001656}
1657
1658/// \brief Create an abbreviation for the SLocEntry that refers to a
1659/// buffer.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001660static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001661 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001662
1663 auto *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001664 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001665 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1666 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1667 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1668 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1669 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
Douglas Gregor8f45df52009-04-16 22:23:12 +00001670 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001671}
1672
1673/// \brief Create an abbreviation for the SLocEntry that refers to a
1674/// buffer's blob.
Richard Smithaada85c2016-02-06 02:06:43 +00001675static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream,
1676 bool Compressed) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001677 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001678
1679 auto *Abbrev = new BitCodeAbbrev();
Richard Smithaada85c2016-02-06 02:06:43 +00001680 Abbrev->Add(BitCodeAbbrevOp(Compressed ? SM_SLOC_BUFFER_BLOB_COMPRESSED
1681 : SM_SLOC_BUFFER_BLOB));
1682 if (Compressed)
1683 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Uncompressed size
Douglas Gregora7f71a92009-04-10 03:52:48 +00001684 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
Douglas Gregor8f45df52009-04-16 22:23:12 +00001685 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001686}
1687
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001688/// \brief Create an abbreviation for the SLocEntry that refers to a macro
1689/// expansion.
1690static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001691 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001692
1693 auto *Abbrev = new BitCodeAbbrev();
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001694 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001695 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1696 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1697 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1698 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
Douglas Gregor83243272009-04-15 18:05:10 +00001699 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
Douglas Gregor8f45df52009-04-16 22:23:12 +00001700 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001701}
1702
Douglas Gregor09b69892011-02-10 17:09:37 +00001703namespace {
1704 // Trait used for the on-disk hash table of header search information.
1705 class HeaderFileInfoTrait {
1706 ASTWriter &Writer;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001707 const HeaderSearch &HS;
Douglas Gregor09b69892011-02-10 17:09:37 +00001708
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001709 // Keep track of the framework names we've used during serialization.
1710 SmallVector<char, 128> FrameworkStringData;
1711 llvm::StringMap<unsigned> FrameworkNameOffset;
1712
Douglas Gregor09b69892011-02-10 17:09:37 +00001713 public:
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001714 HeaderFileInfoTrait(ASTWriter &Writer, const HeaderSearch &HS)
1715 : Writer(Writer), HS(HS) { }
Douglas Gregor09b69892011-02-10 17:09:37 +00001716
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001717 struct key_type {
1718 const FileEntry *FE;
1719 const char *Filename;
1720 };
1721 typedef const key_type &key_type_ref;
Douglas Gregor09b69892011-02-10 17:09:37 +00001722
1723 typedef HeaderFileInfo data_type;
1724 typedef const data_type &data_type_ref;
Justin Bogner25463f12014-04-18 20:27:24 +00001725 typedef unsigned hash_value_type;
1726 typedef unsigned offset_type;
Douglas Gregor09b69892011-02-10 17:09:37 +00001727
Richard Smithe75ee0f2015-08-17 07:13:32 +00001728 hash_value_type ComputeHash(key_type_ref key) {
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001729 // The hash is based only on size/time of the file, so that the reader can
1730 // match even when symlinking or excess path elements ("foo/../", "../")
1731 // change the form of the name. However, complete path is still the key.
1732 return llvm::hash_combine(key.FE->getSize(),
Richard Smithe75ee0f2015-08-17 07:13:32 +00001733 Writer.getTimestampForOutput(key.FE));
Douglas Gregor09b69892011-02-10 17:09:37 +00001734 }
1735
1736 std::pair<unsigned,unsigned>
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001737 EmitKeyDataLength(raw_ostream& Out, key_type_ref key, data_type_ref Data) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001738 using namespace llvm::support;
Richard Smith386bb072015-08-18 23:42:23 +00001739 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001740 unsigned KeyLen = strlen(key.Filename) + 1 + 8 + 8;
Richard Smith386bb072015-08-18 23:42:23 +00001741 LE.write<uint16_t>(KeyLen);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001742 unsigned DataLen = 1 + 2 + 4 + 4;
Richard Smith386bb072015-08-18 23:42:23 +00001743 for (auto ModInfo : HS.getModuleMap().findAllModulesForHeader(key.FE))
1744 if (Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule()))
1745 DataLen += 4;
1746 LE.write<uint8_t>(DataLen);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001747 return std::make_pair(KeyLen, DataLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001748 }
1749
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001750 void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001751 using namespace llvm::support;
1752 endian::Writer<little> LE(Out);
1753 LE.write<uint64_t>(key.FE->getSize());
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001754 KeyLen -= 8;
Richard Smithe75ee0f2015-08-17 07:13:32 +00001755 LE.write<uint64_t>(Writer.getTimestampForOutput(key.FE));
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001756 KeyLen -= 8;
1757 Out.write(key.Filename, KeyLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001758 }
1759
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001760 void EmitData(raw_ostream &Out, key_type_ref key,
Douglas Gregor09b69892011-02-10 17:09:37 +00001761 data_type_ref Data, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001762 using namespace llvm::support;
1763 endian::Writer<little> LE(Out);
Douglas Gregor09b69892011-02-10 17:09:37 +00001764 uint64_t Start = Out.tell(); (void)Start;
1765
Richard Smith386bb072015-08-18 23:42:23 +00001766 unsigned char Flags = (Data.isImport << 4)
1767 | (Data.isPragmaOnce << 3)
1768 | (Data.DirInfo << 1)
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001769 | Data.IndexHeaderMapHeader;
Justin Bognere1c147c2014-03-28 22:03:19 +00001770 LE.write<uint8_t>(Flags);
1771 LE.write<uint16_t>(Data.NumIncludes);
Douglas Gregor09b69892011-02-10 17:09:37 +00001772
1773 if (!Data.ControllingMacro)
Justin Bognere1c147c2014-03-28 22:03:19 +00001774 LE.write<uint32_t>(Data.ControllingMacroID);
Douglas Gregor09b69892011-02-10 17:09:37 +00001775 else
Justin Bognere1c147c2014-03-28 22:03:19 +00001776 LE.write<uint32_t>(Writer.getIdentifierRef(Data.ControllingMacro));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001777
1778 unsigned Offset = 0;
1779 if (!Data.Framework.empty()) {
1780 // If this header refers into a framework, save the framework name.
1781 llvm::StringMap<unsigned>::iterator Pos
1782 = FrameworkNameOffset.find(Data.Framework);
1783 if (Pos == FrameworkNameOffset.end()) {
1784 Offset = FrameworkStringData.size() + 1;
1785 FrameworkStringData.append(Data.Framework.begin(),
1786 Data.Framework.end());
1787 FrameworkStringData.push_back(0);
1788
1789 FrameworkNameOffset[Data.Framework] = Offset;
1790 } else
1791 Offset = Pos->second;
1792 }
Justin Bognere1c147c2014-03-28 22:03:19 +00001793 LE.write<uint32_t>(Offset);
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001794
Richard Smith386bb072015-08-18 23:42:23 +00001795 // FIXME: If the header is excluded, we should write out some
1796 // record of that fact.
1797 for (auto ModInfo : HS.getModuleMap().findAllModulesForHeader(key.FE)) {
1798 if (uint32_t ModID =
1799 Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule())) {
1800 uint32_t Value = (ModID << 2) | (unsigned)ModInfo.getRole();
1801 assert((Value >> 2) == ModID && "overflow in header module info");
1802 LE.write<uint32_t>(Value);
1803 }
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001804 }
1805
Douglas Gregor09b69892011-02-10 17:09:37 +00001806 assert(Out.tell() - Start == DataLen && "Wrong data length");
1807 }
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001808
1809 const char *strings_begin() const { return FrameworkStringData.begin(); }
1810 const char *strings_end() const { return FrameworkStringData.end(); }
Douglas Gregor09b69892011-02-10 17:09:37 +00001811 };
1812} // end anonymous namespace
1813
1814/// \brief Write the header search block for the list of files that
1815///
1816/// \param HS The header search structure to save.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001817void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001818 SmallVector<const FileEntry *, 16> FilesByUID;
Douglas Gregor09b69892011-02-10 17:09:37 +00001819 HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
1820
1821 if (FilesByUID.size() > HS.header_file_size())
1822 FilesByUID.resize(HS.header_file_size());
1823
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001824 HeaderFileInfoTrait GeneratorTrait(*this, HS);
Justin Bognerbb094f02014-04-18 19:57:06 +00001825 llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001826 SmallVector<const char *, 4> SavedStrings;
Douglas Gregor09b69892011-02-10 17:09:37 +00001827 unsigned NumHeaderSearchEntries = 0;
1828 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
1829 const FileEntry *File = FilesByUID[UID];
1830 if (!File)
1831 continue;
1832
Richard Smith386bb072015-08-18 23:42:23 +00001833 // Get the file info. This will load info from the external source if
1834 // necessary. Skip emitting this file if we have no information on it
1835 // as a header file (in which case HFI will be null) or if it hasn't
1836 // changed since it was loaded. Also skip it if it's for a modular header
1837 // from a different module; in that case, we rely on the module(s)
1838 // containing the header to provide this information.
Richard Smithd8879c82015-08-24 21:59:32 +00001839 const HeaderFileInfo *HFI =
1840 HS.getExistingFileInfo(File, /*WantExternal*/!Chain);
1841 if (!HFI || (HFI->isModuleHeader && !HFI->isCompilingModuleHeader))
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +00001842 continue;
Douglas Gregor09b69892011-02-10 17:09:37 +00001843
Richard Smith7ed1bc92014-12-05 22:42:13 +00001844 // Massage the file path into an appropriate form.
Douglas Gregor09b69892011-02-10 17:09:37 +00001845 const char *Filename = File->getName();
Richard Smith7ed1bc92014-12-05 22:42:13 +00001846 SmallString<128> FilenameTmp(Filename);
1847 if (PreparePathForOutput(FilenameTmp)) {
1848 // If we performed any translation on the file name at all, we need to
1849 // save this string, since the generator will refer to it later.
1850 Filename = strdup(FilenameTmp.c_str());
Douglas Gregor09b69892011-02-10 17:09:37 +00001851 SavedStrings.push_back(Filename);
1852 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001853
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001854 HeaderFileInfoTrait::key_type key = { File, Filename };
Richard Smith386bb072015-08-18 23:42:23 +00001855 Generator.insert(key, *HFI, GeneratorTrait);
Douglas Gregor09b69892011-02-10 17:09:37 +00001856 ++NumHeaderSearchEntries;
1857 }
1858
1859 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001860 SmallString<4096> TableData;
Douglas Gregor09b69892011-02-10 17:09:37 +00001861 uint32_t BucketOffset;
1862 {
Justin Bognere1c147c2014-03-28 22:03:19 +00001863 using namespace llvm::support;
Douglas Gregor09b69892011-02-10 17:09:37 +00001864 llvm::raw_svector_ostream Out(TableData);
1865 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00001866 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregor09b69892011-02-10 17:09:37 +00001867 BucketOffset = Generator.Emit(Out, GeneratorTrait);
1868 }
1869
1870 // Create a blob abbreviation
1871 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001872
1873 auto *Abbrev = new BitCodeAbbrev();
Douglas Gregor09b69892011-02-10 17:09:37 +00001874 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
1875 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1876 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001877 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor09b69892011-02-10 17:09:37 +00001878 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1879 unsigned TableAbbrev = Stream.EmitAbbrev(Abbrev);
1880
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001881 // Write the header search table
Mehdi Amini57a41912015-09-10 01:46:39 +00001882 RecordData::value_type Record[] = {HEADER_SEARCH_TABLE, BucketOffset,
1883 NumHeaderSearchEntries, TableData.size()};
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001884 TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end());
Yaron Keren92e1b622015-03-18 10:17:07 +00001885 Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData);
Douglas Gregor09b69892011-02-10 17:09:37 +00001886
1887 // Free all of the strings we had to duplicate.
1888 for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
David Greenebae0e352013-01-15 22:09:43 +00001889 free(const_cast<char *>(SavedStrings[I]));
Douglas Gregor09b69892011-02-10 17:09:37 +00001890}
1891
Douglas Gregora7f71a92009-04-10 03:52:48 +00001892/// \brief Writes the block containing the serialized form of the
1893/// source manager.
1894///
1895/// TODO: We should probably use an on-disk hash table (stored in a
1896/// blob), indexed based on the file name, so that we only create
1897/// entries for files that we actually need. In the common case (no
1898/// errors), we probably won't have to create file entries for any of
1899/// the files in the AST.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00001900void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
Richard Smith7ed1bc92014-12-05 22:42:13 +00001901 const Preprocessor &PP) {
Douglas Gregor258ae542009-04-27 06:38:32 +00001902 RecordData Record;
1903
Chris Lattner0910e3b2009-04-10 17:16:57 +00001904 // Enter the source manager block.
Richard Smithaada85c2016-02-06 02:06:43 +00001905 Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 4);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001906
1907 // Abbreviations for the various kinds of source-location entries.
Chris Lattnerc4976c732009-04-27 19:03:22 +00001908 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
1909 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
Richard Smithaada85c2016-02-06 02:06:43 +00001910 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream, false);
1911 unsigned SLocBufferBlobCompressedAbbrv =
1912 CreateSLocBufferBlobAbbrev(Stream, true);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001913 unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001914
Douglas Gregor258ae542009-04-27 06:38:32 +00001915 // Write out the source location entry table. We skip the first
1916 // entry, which is always the same dummy entry.
Chris Lattner12d61d32009-04-27 19:01:47 +00001917 std::vector<uint32_t> SLocEntryOffsets;
Douglas Gregor258ae542009-04-27 06:38:32 +00001918 RecordData PreloadSLocs;
Douglas Gregor925296b2011-07-19 16:10:42 +00001919 SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1);
1920 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
Sebastian Redl5c415f32010-07-22 17:01:13 +00001921 I != N; ++I) {
Douglas Gregor8655e882009-10-16 22:46:09 +00001922 // Get this source location entry.
Douglas Gregor925296b2011-07-19 16:10:42 +00001923 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00001924 FileID FID = FileID::get(I);
1925 assert(&SourceMgr.getSLocEntry(FID) == SLoc);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001926
Douglas Gregor258ae542009-04-27 06:38:32 +00001927 // Record the offset of this source-location entry.
1928 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
1929
1930 // Figure out which record code to use.
1931 unsigned Code;
1932 if (SLoc->isFile()) {
Douglas Gregor9dc32122011-11-16 20:05:18 +00001933 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
1934 if (Cache->OrigEntry) {
Sebastian Redl539c5062010-08-18 23:57:32 +00001935 Code = SM_SLOC_FILE_ENTRY;
Argyrios Kyrtzidis92dd4662011-06-02 20:01:46 +00001936 } else
Sebastian Redl539c5062010-08-18 23:57:32 +00001937 Code = SM_SLOC_BUFFER_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00001938 } else
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001939 Code = SM_SLOC_EXPANSION_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00001940 Record.clear();
1941 Record.push_back(Code);
1942
Douglas Gregor925296b2011-07-19 16:10:42 +00001943 // Starting offset of this entry within this module, so skip the dummy.
1944 Record.push_back(SLoc->getOffset() - 2);
Douglas Gregor258ae542009-04-27 06:38:32 +00001945 if (SLoc->isFile()) {
1946 const SrcMgr::FileInfo &File = SLoc->getFile();
Richard Smithb22a1d12016-03-27 20:13:24 +00001947 AddSourceLocation(File.getIncludeLoc(), Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00001948 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
1949 Record.push_back(File.hasLineDirectives());
1950
1951 const SrcMgr::ContentCache *Content = File.getContentCache();
Richard Smithaada85c2016-02-06 02:06:43 +00001952 bool EmitBlob = false;
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00001953 if (Content->OrigEntry) {
1954 assert(Content->OrigEntry == Content->ContentsEntry &&
Douglas Gregor9dc32122011-11-16 20:05:18 +00001955 "Writing to AST an overridden file is not supported");
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00001956
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001957 // The source location entry is a file. Emit input file ID.
1958 assert(InputFileIDs[Content->OrigEntry] != 0 && "Missed file entry");
1959 Record.push_back(InputFileIDs[Content->OrigEntry]);
Mike Stump11289f42009-09-09 15:08:12 +00001960
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001961 Record.push_back(File.NumCreatedFIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001962
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00001963 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001964 if (FDI != FileDeclIDs.end()) {
1965 Record.push_back(FDI->second->FirstDeclIndex);
1966 Record.push_back(FDI->second->DeclIDs.size());
1967 } else {
1968 Record.push_back(0);
1969 Record.push_back(0);
1970 }
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001971
1972 Stream.EmitRecordWithAbbrev(SLocFileAbbrv, Record);
1973
Richard Smithaada85c2016-02-06 02:06:43 +00001974 if (Content->BufferOverridden || Content->IsTransient)
1975 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00001976 } else {
1977 // The source location entry is a buffer. The blob associated
1978 // with this entry contains the contents of the buffer.
1979
1980 // We add one to the size so that we capture the trailing NULL
1981 // that is required by llvm::MemoryBuffer::getMemBuffer (on
1982 // the reader side).
Douglas Gregor874cc622010-03-16 00:35:39 +00001983 const llvm::MemoryBuffer *Buffer
Chris Lattnerfb24a3a2010-04-20 20:35:58 +00001984 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
Douglas Gregor258ae542009-04-27 06:38:32 +00001985 const char *Name = Buffer->getBufferIdentifier();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001986 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001987 StringRef(Name, strlen(Name) + 1));
Richard Smithaada85c2016-02-06 02:06:43 +00001988 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00001989
Douglas Gregor925296b2011-07-19 16:10:42 +00001990 if (strcmp(Name, "<built-in>") == 0) {
1991 PreloadSLocs.push_back(SLocEntryOffsets.size());
1992 }
Douglas Gregor258ae542009-04-27 06:38:32 +00001993 }
Richard Smithaada85c2016-02-06 02:06:43 +00001994
1995 if (EmitBlob) {
1996 // Include the implicit terminating null character in the on-disk buffer
1997 // if we're writing it uncompressed.
1998 const llvm::MemoryBuffer *Buffer =
1999 Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
2000 StringRef Blob(Buffer->getBufferStart(), Buffer->getBufferSize() + 1);
2001
2002 // Compress the buffer if possible. We expect that almost all PCM
2003 // consumers will not want its contents.
2004 SmallString<0> CompressedBuffer;
2005 if (llvm::zlib::compress(Blob.drop_back(1), CompressedBuffer) ==
2006 llvm::zlib::StatusOK) {
2007 RecordData::value_type Record[] = {SM_SLOC_BUFFER_BLOB_COMPRESSED,
2008 Blob.size() - 1};
2009 Stream.EmitRecordWithBlob(SLocBufferBlobCompressedAbbrv, Record,
2010 CompressedBuffer);
2011 } else {
2012 RecordData::value_type Record[] = {SM_SLOC_BUFFER_BLOB};
2013 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record, Blob);
2014 }
2015 }
Douglas Gregor258ae542009-04-27 06:38:32 +00002016 } else {
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002017 // The source location entry is a macro expansion.
Chandler Carruthee4c1d12011-07-26 04:56:51 +00002018 const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
Richard Smithb22a1d12016-03-27 20:13:24 +00002019 AddSourceLocation(Expansion.getSpellingLoc(), Record);
2020 AddSourceLocation(Expansion.getExpansionLocStart(), Record);
2021 AddSourceLocation(Expansion.isMacroArgExpansion()
2022 ? SourceLocation()
2023 : Expansion.getExpansionLocEnd(),
2024 Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002025
2026 // Compute the token length for this macro expansion.
Douglas Gregor925296b2011-07-19 16:10:42 +00002027 unsigned NextOffset = SourceMgr.getNextLocalOffset();
Douglas Gregor8655e882009-10-16 22:46:09 +00002028 if (I + 1 != N)
Douglas Gregor925296b2011-07-19 16:10:42 +00002029 NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset();
Douglas Gregor258ae542009-04-27 06:38:32 +00002030 Record.push_back(NextOffset - SLoc->getOffset() - 1);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002031 Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002032 }
2033 }
2034
Douglas Gregor8f45df52009-04-16 22:23:12 +00002035 Stream.ExitBlock();
Douglas Gregor258ae542009-04-27 06:38:32 +00002036
2037 if (SLocEntryOffsets.empty())
2038 return;
2039
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002040 // Write the source-location offsets table into the AST block. This
Douglas Gregor258ae542009-04-27 06:38:32 +00002041 // table is used for lazily loading source-location information.
2042 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002043
2044 auto *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00002045 Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
Douglas Gregor258ae542009-04-27 06:38:32 +00002046 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
Douglas Gregor925296b2011-07-19 16:10:42 +00002047 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
Douglas Gregor258ae542009-04-27 06:38:32 +00002048 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
2049 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(Abbrev);
Mehdi Amini57a41912015-09-10 01:46:39 +00002050 {
2051 RecordData::value_type Record[] = {
2052 SOURCE_LOCATION_OFFSETS, SLocEntryOffsets.size(),
2053 SourceMgr.getNextLocalOffset() - 1 /* skip dummy */};
2054 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
2055 bytes(SLocEntryOffsets));
2056 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002057 // Write the source location entry preloads array, telling the AST
Douglas Gregor258ae542009-04-27 06:38:32 +00002058 // reader which source locations entries it should load eagerly.
Sebastian Redl539c5062010-08-18 23:57:32 +00002059 Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
Douglas Gregor925296b2011-07-19 16:10:42 +00002060
2061 // Write the line table. It depends on remapping working, so it must come
2062 // after the source location offsets.
2063 if (SourceMgr.hasLineTable()) {
2064 LineTableInfo &LineTable = SourceMgr.getLineTable();
2065
2066 Record.clear();
Richard Smith63078492015-09-01 07:41:55 +00002067
2068 // Emit the needed file names.
2069 llvm::DenseMap<int, int> FilenameMap;
2070 for (const auto &L : LineTable) {
2071 if (L.first.ID < 0)
2072 continue;
2073 for (auto &LE : L.second) {
2074 if (FilenameMap.insert(std::make_pair(LE.FilenameID,
2075 FilenameMap.size())).second)
2076 AddPath(LineTable.getFilename(LE.FilenameID), Record);
2077 }
2078 }
2079 Record.push_back(0);
Douglas Gregor925296b2011-07-19 16:10:42 +00002080
2081 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002082 for (const auto &L : LineTable) {
Douglas Gregor925296b2011-07-19 16:10:42 +00002083 // Only emit entries for local files.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002084 if (L.first.ID < 0)
Douglas Gregor925296b2011-07-19 16:10:42 +00002085 continue;
2086
2087 // Emit the file ID
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002088 Record.push_back(L.first.ID);
Douglas Gregor925296b2011-07-19 16:10:42 +00002089
2090 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002091 Record.push_back(L.second.size());
2092 for (const auto &LE : L.second) {
2093 Record.push_back(LE.FileOffset);
2094 Record.push_back(LE.LineNo);
2095 Record.push_back(FilenameMap[LE.FilenameID]);
2096 Record.push_back((unsigned)LE.FileKind);
2097 Record.push_back(LE.IncludeOffset);
Douglas Gregor925296b2011-07-19 16:10:42 +00002098 }
2099 }
Richard Smith63078492015-09-01 07:41:55 +00002100
Douglas Gregor925296b2011-07-19 16:10:42 +00002101 Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record);
2102 }
Douglas Gregora7f71a92009-04-10 03:52:48 +00002103}
2104
Douglas Gregorc5046832009-04-27 18:38:38 +00002105//===----------------------------------------------------------------------===//
2106// Preprocessor Serialization
2107//===----------------------------------------------------------------------===//
2108
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002109static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule,
2110 const Preprocessor &PP) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002111 if (MacroInfo *MI = MD->getMacroInfo())
2112 if (MI->isBuiltinMacro())
2113 return true;
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002114
2115 if (IsModule) {
2116 SourceLocation Loc = MD->getLocation();
2117 if (Loc.isInvalid())
2118 return true;
2119 if (PP.getSourceManager().getFileID(Loc) == PP.getPredefinesFileID())
2120 return true;
2121 }
2122
2123 return false;
2124}
2125
Chris Lattnereeffaef2009-04-10 17:15:23 +00002126/// \brief Writes the block containing the serialized form of the
2127/// preprocessor.
2128///
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00002129void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002130 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
2131 if (PPRec)
2132 WritePreprocessorDetail(*PPRec);
2133
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002134 RecordData Record;
Richard Smithd7329392015-04-21 21:46:32 +00002135 RecordData ModuleMacroRecord;
Chris Lattner0910e3b2009-04-10 17:16:57 +00002136
Chris Lattner0af3ba12009-04-13 01:29:17 +00002137 // If the preprocessor __COUNTER__ value has been bumped, remember it.
2138 if (PP.getCounterValue() != 0) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002139 RecordData::value_type Record[] = {PP.getCounterValue()};
Sebastian Redl539c5062010-08-18 23:57:32 +00002140 Stream.EmitRecord(PP_COUNTER_VALUE, Record);
Douglas Gregoreda6a892009-04-26 00:07:37 +00002141 }
2142
2143 // Enter the preprocessor block.
Douglas Gregor796d76a2010-10-20 22:00:55 +00002144 Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +00002145
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002146 // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002147 // FIXME: Include a location for the use, and say which one was used.
Douglas Gregoreda6a892009-04-26 00:07:37 +00002148 if (PP.SawDateOrTime())
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002149 PP.Diag(SourceLocation(), diag::warn_module_uses_date_time) << IsModule;
Douglas Gregor796d76a2010-10-20 22:00:55 +00002150
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002151 // Loop over all the macro directives that are live at the end of the file,
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002152 // emitting each to the PP section.
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002153
Richard Smithee977932015-05-01 21:22:17 +00002154 // Construct the list of identifiers with macro directives that need to be
2155 // serialized.
2156 SmallVector<const IdentifierInfo *, 128> MacroIdentifiers;
2157 for (auto &Id : PP.getIdentifierTable())
2158 if (Id.second->hadMacroDefinition() &&
2159 (!Id.second->isFromAST() ||
2160 Id.second->hasChangedSinceDeserialization()))
2161 MacroIdentifiers.push_back(Id.second);
Douglas Gregor2e5571d2011-02-10 18:20:09 +00002162 // Sort the set of macro definitions that need to be serialized by the
2163 // name of the macro, to provide a stable ordering.
Richard Smithee977932015-05-01 21:22:17 +00002164 std::sort(MacroIdentifiers.begin(), MacroIdentifiers.end(),
2165 llvm::less_ptr<IdentifierInfo>());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002166
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002167 // Emit the macro directives as a list and associate the offset with the
2168 // identifier they belong to.
Richard Smithee977932015-05-01 21:22:17 +00002169 for (const IdentifierInfo *Name : MacroIdentifiers) {
2170 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(Name);
Richard Smithd7329392015-04-21 21:46:32 +00002171 auto StartOffset = Stream.GetCurrentBitNo();
2172
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002173 // Emit the macro directives in reverse source order.
2174 for (; MD; MD = MD->getPrevious()) {
Richard Smithd7329392015-04-21 21:46:32 +00002175 // Once we hit an ignored macro, we're done: the rest of the chain
2176 // will all be ignored macros.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002177 if (shouldIgnoreMacro(MD, IsModule, PP))
Richard Smithd7329392015-04-21 21:46:32 +00002178 break;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002179
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002180 AddSourceLocation(MD->getLocation(), Record);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002181 Record.push_back(MD->getKind());
Richard Smithdaa69e02014-07-25 04:40:03 +00002182 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
Richard Smith3981b172015-04-30 02:16:23 +00002183 Record.push_back(getMacroRef(DefMD->getInfo(), Name));
Richard Smith713369b2015-04-23 20:40:50 +00002184 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002185 Record.push_back(VisMD->isPublic());
2186 }
Richard Smithb8b2ed62015-04-23 18:18:26 +00002187 }
Richard Smithd7329392015-04-21 21:46:32 +00002188
Richard Smithb8b2ed62015-04-23 18:18:26 +00002189 // Write out any exported module macros.
Richard Smithee977932015-05-01 21:22:17 +00002190 bool EmittedModuleMacros = false;
Richard Smithb8b2ed62015-04-23 18:18:26 +00002191 if (IsModule) {
2192 auto Leafs = PP.getLeafModuleMacros(Name);
2193 SmallVector<ModuleMacro*, 8> Worklist(Leafs.begin(), Leafs.end());
2194 llvm::DenseMap<ModuleMacro*, unsigned> Visits;
2195 while (!Worklist.empty()) {
2196 auto *Macro = Worklist.pop_back_val();
Richard Smithd7329392015-04-21 21:46:32 +00002197
Richard Smithb8b2ed62015-04-23 18:18:26 +00002198 // Emit a record indicating this submodule exports this macro.
2199 ModuleMacroRecord.push_back(
2200 getSubmoduleID(Macro->getOwningModule()));
Richard Smithee977932015-05-01 21:22:17 +00002201 ModuleMacroRecord.push_back(getMacroRef(Macro->getMacroInfo(), Name));
Richard Smithb8b2ed62015-04-23 18:18:26 +00002202 for (auto *M : Macro->overrides())
2203 ModuleMacroRecord.push_back(getSubmoduleID(M->getOwningModule()));
Richard Smithd7329392015-04-21 21:46:32 +00002204
Richard Smithb8b2ed62015-04-23 18:18:26 +00002205 Stream.EmitRecord(PP_MODULE_MACRO, ModuleMacroRecord);
2206 ModuleMacroRecord.clear();
Richard Smithd7329392015-04-21 21:46:32 +00002207
Richard Smithb8b2ed62015-04-23 18:18:26 +00002208 // Enqueue overridden macros once we've visited all their ancestors.
2209 for (auto *M : Macro->overrides())
2210 if (++Visits[M] == M->getNumOverridingMacros())
2211 Worklist.push_back(M);
Richard Smithee977932015-05-01 21:22:17 +00002212
2213 EmittedModuleMacros = true;
Richard Smithd7329392015-04-21 21:46:32 +00002214 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002215 }
Richard Smithd7329392015-04-21 21:46:32 +00002216
Richard Smithee977932015-05-01 21:22:17 +00002217 if (Record.empty() && !EmittedModuleMacros)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002218 continue;
2219
Richard Smithd7329392015-04-21 21:46:32 +00002220 IdentMacroDirectivesOffsetMap[Name] = StartOffset;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002221 Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, Record);
2222 Record.clear();
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002223 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00002224
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002225 /// \brief Offsets of each of the macros into the bitstream, indexed by
2226 /// the local macro ID
2227 ///
2228 /// For each identifier that is associated with a macro, this map
2229 /// provides the offset into the bitstream where that macro is
2230 /// defined.
2231 std::vector<uint32_t> MacroOffsets;
2232
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002233 for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) {
2234 const IdentifierInfo *Name = MacroInfosToEmit[I].Name;
2235 MacroInfo *MI = MacroInfosToEmit[I].MI;
2236 MacroID ID = MacroInfosToEmit[I].ID;
Douglas Gregoreb114da2010-10-01 01:03:07 +00002237
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002238 if (ID < FirstMacroID) {
2239 assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?");
2240 continue;
Chris Lattner2199f5b2009-04-10 18:08:30 +00002241 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002242
2243 // Record the local offset of this macro.
2244 unsigned Index = ID - FirstMacroID;
2245 if (Index == MacroOffsets.size())
2246 MacroOffsets.push_back(Stream.GetCurrentBitNo());
2247 else {
2248 if (Index > MacroOffsets.size())
2249 MacroOffsets.resize(Index + 1);
2250
2251 MacroOffsets[Index] = Stream.GetCurrentBitNo();
2252 }
2253
2254 AddIdentifierRef(Name, Record);
2255 Record.push_back(inferSubmoduleIDFromLocation(MI->getDefinitionLoc()));
2256 AddSourceLocation(MI->getDefinitionLoc(), Record);
2257 AddSourceLocation(MI->getDefinitionEndLoc(), Record);
2258 Record.push_back(MI->isUsed());
Argyrios Kyrtzidis9ef53ce2014-04-09 18:21:23 +00002259 Record.push_back(MI->isUsedForHeaderGuard());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002260 unsigned Code;
2261 if (MI->isObjectLike()) {
2262 Code = PP_MACRO_OBJECT_LIKE;
2263 } else {
2264 Code = PP_MACRO_FUNCTION_LIKE;
2265
2266 Record.push_back(MI->isC99Varargs());
2267 Record.push_back(MI->isGNUVarargs());
2268 Record.push_back(MI->hasCommaPasting());
2269 Record.push_back(MI->getNumArgs());
Daniel Marjamakie4770da2015-05-29 09:15:24 +00002270 for (const IdentifierInfo *Arg : MI->args())
2271 AddIdentifierRef(Arg, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002272 }
2273
2274 // If we have a detailed preprocessing record, record the macro definition
2275 // ID that corresponds to this macro.
2276 if (PPRec)
2277 Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2278
2279 Stream.EmitRecord(Code, Record);
2280 Record.clear();
2281
2282 // Emit the tokens array.
2283 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
2284 // Note that we know that the preprocessor does not have any annotation
2285 // tokens in it because they are created by the parser, and thus can't
2286 // be in a macro definition.
2287 const Token &Tok = MI->getReplacementToken(TokNo);
John McCallf413f5e2013-05-03 00:10:13 +00002288 AddToken(Tok, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002289 Stream.EmitRecord(PP_TOKEN, Record);
2290 Record.clear();
2291 }
2292 ++NumMacros;
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002293 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002294
Douglas Gregor92a96f52011-02-08 21:58:10 +00002295 Stream.ExitBlock();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002296
2297 // Write the offsets table for macro IDs.
2298 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002299
Richard Smith13090a22015-04-10 02:02:24 +00002300 auto *Abbrev = new BitCodeAbbrev();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002301 Abbrev->Add(BitCodeAbbrevOp(MACRO_OFFSET));
2302 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2303 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2304 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2305
2306 unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
Mehdi Amini57a41912015-09-10 01:46:39 +00002307 {
2308 RecordData::value_type Record[] = {MACRO_OFFSET, MacroOffsets.size(),
2309 FirstMacroID - NUM_PREDEF_MACRO_IDS};
2310 Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record, bytes(MacroOffsets));
2311 }
Douglas Gregor92a96f52011-02-08 21:58:10 +00002312}
2313
2314void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) {
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002315 if (PPRec.local_begin() == PPRec.local_end())
Douglas Gregor92a96f52011-02-08 21:58:10 +00002316 return;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002317
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +00002318 SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002319
Douglas Gregor92a96f52011-02-08 21:58:10 +00002320 // Enter the preprocessor block.
2321 Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002322
Douglas Gregoraae92242010-03-19 21:51:54 +00002323 // If the preprocessor has a preprocessing record, emit it.
2324 unsigned NumPreprocessingRecords = 0;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002325 using namespace llvm;
2326
2327 // Set up the abbreviation for
2328 unsigned InclusionAbbrev = 0;
2329 {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002330 auto *Abbrev = new BitCodeAbbrev();
Douglas Gregor92a96f52011-02-08 21:58:10 +00002331 Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002332 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2333 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2334 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002335 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
Douglas Gregor92a96f52011-02-08 21:58:10 +00002336 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2337 InclusionAbbrev = Stream.EmitAbbrev(Abbrev);
2338 }
2339
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002340 unsigned FirstPreprocessorEntityID
2341 = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0)
2342 + NUM_PREDEF_PP_ENTITY_IDS;
2343 unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002344 RecordData Record;
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002345 for (PreprocessingRecord::iterator E = PPRec.local_begin(),
2346 EEnd = PPRec.local_end();
Douglas Gregor0d4b4312011-08-04 17:06:18 +00002347 E != EEnd;
2348 (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002349 Record.clear();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002350
Richard Smith66a81862015-05-04 02:25:31 +00002351 PreprocessedEntityOffsets.push_back(
2352 PPEntityOffset((*E)->getSourceRange(), Stream.GetCurrentBitNo()));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002353
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002354 if (auto *MD = dyn_cast<MacroDefinitionRecord>(*E)) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002355 // Record this macro definition's ID.
2356 MacroDefinitions[MD] = NextPreprocessorEntityID;
Richard Smith66a81862015-05-04 02:25:31 +00002357
Douglas Gregor92a96f52011-02-08 21:58:10 +00002358 AddIdentifierRef(MD->getName(), Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002359 Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
2360 continue;
Douglas Gregoraae92242010-03-19 21:51:54 +00002361 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002362
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002363 if (auto *ME = dyn_cast<MacroExpansion>(*E)) {
Argyrios Kyrtzidis80f78b92011-09-08 17:18:41 +00002364 Record.push_back(ME->isBuiltinMacro());
2365 if (ME->isBuiltinMacro())
2366 AddIdentifierRef(ME->getName(), Record);
2367 else
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002368 Record.push_back(MacroDefinitions[ME->getDefinition()]);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002369 Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002370 continue;
2371 }
2372
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002373 if (auto *ID = dyn_cast<InclusionDirective>(*E)) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002374 Record.push_back(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002375 Record.push_back(ID->getFileName().size());
2376 Record.push_back(ID->wasInQuotes());
2377 Record.push_back(static_cast<unsigned>(ID->getKind()));
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002378 Record.push_back(ID->importedModule());
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002379 SmallString<64> Buffer;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002380 Buffer += ID->getFileName();
Argyrios Kyrtzidis8dbcfc32012-03-08 01:08:28 +00002381 // Check that the FileEntry is not null because it was not resolved and
2382 // we create a PCH even with compiler errors.
2383 if (ID->getFile())
2384 Buffer += ID->getFile()->getName();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002385 Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002386 continue;
2387 }
2388
2389 llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
2390 }
Douglas Gregor8f45df52009-04-16 22:23:12 +00002391 Stream.ExitBlock();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002392
Douglas Gregoraae92242010-03-19 21:51:54 +00002393 // Write the offsets table for the preprocessing record.
2394 if (NumPreprocessingRecords > 0) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002395 assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
2396
Douglas Gregoraae92242010-03-19 21:51:54 +00002397 // Write the offsets table for identifier IDs.
2398 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002399
2400 auto *Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002401 Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002402 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity
Douglas Gregoraae92242010-03-19 21:51:54 +00002403 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002404 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002405
Mehdi Amini57a41912015-09-10 01:46:39 +00002406 RecordData::value_type Record[] = {PPD_ENTITIES_OFFSETS,
2407 FirstPreprocessorEntityID -
2408 NUM_PREDEF_PP_ENTITY_IDS};
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002409 Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002410 bytes(PreprocessedEntityOffsets));
Douglas Gregoraae92242010-03-19 21:51:54 +00002411 }
Chris Lattnereeffaef2009-04-10 17:15:23 +00002412}
2413
Richard Smith386bb072015-08-18 23:42:23 +00002414unsigned ASTWriter::getLocalOrImportedSubmoduleID(Module *Mod) {
Richard Smith080056b2015-08-18 21:53:42 +00002415 if (!Mod)
2416 return 0;
2417
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002418 llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod);
2419 if (Known != SubmoduleIDs.end())
2420 return Known->second;
Richard Smith386bb072015-08-18 23:42:23 +00002421
2422 if (Mod->getTopLevelModule() != WritingModule)
2423 return 0;
2424
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002425 return SubmoduleIDs[Mod] = NextSubmoduleID++;
2426}
2427
Richard Smith386bb072015-08-18 23:42:23 +00002428unsigned ASTWriter::getSubmoduleID(Module *Mod) {
2429 // FIXME: This can easily happen, if we have a reference to a submodule that
2430 // did not result in us loading a module file for that submodule. For
2431 // instance, a cross-top-level-module 'conflict' declaration will hit this.
2432 unsigned ID = getLocalOrImportedSubmoduleID(Mod);
2433 assert((ID || !Mod) &&
2434 "asked for module ID for non-local, non-imported module");
2435 return ID;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002436}
2437
Douglas Gregor253eefe2011-12-01 00:59:36 +00002438/// \brief Compute the number of modules within the given tree (including the
2439/// given module).
2440static unsigned getNumberOfModules(Module *Mod) {
2441 unsigned ChildModules = 0;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002442 for (auto Sub = Mod->submodule_begin(), SubEnd = Mod->submodule_end();
Douglas Gregor253eefe2011-12-01 00:59:36 +00002443 Sub != SubEnd; ++Sub)
Douglas Gregoreb90e832012-01-04 23:32:19 +00002444 ChildModules += getNumberOfModules(*Sub);
Douglas Gregor253eefe2011-12-01 00:59:36 +00002445
2446 return ChildModules + 1;
2447}
2448
Douglas Gregorde3ef502011-11-30 23:21:26 +00002449void ASTWriter::WriteSubmodules(Module *WritingModule) {
Douglas Gregor69021972011-11-30 17:33:56 +00002450 // Enter the submodule description block.
Richard Smith202210b2014-10-24 20:23:01 +00002451 Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/5);
Douglas Gregor69021972011-11-30 17:33:56 +00002452
2453 // Write the abbreviations needed for the submodules block.
2454 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002455
2456 auto *Abbrev = new BitCodeAbbrev();
Douglas Gregor69021972011-11-30 17:33:56 +00002457 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002458 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor69021972011-11-30 17:33:56 +00002459 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
2460 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2461 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
Richard Smith9bca2982014-03-08 00:03:56 +00002462 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
2463 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
Douglas Gregora686e1b2012-01-27 19:52:33 +00002464 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
Douglas Gregor73441092011-12-05 22:27:44 +00002465 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
Douglas Gregor73441092011-12-05 22:27:44 +00002466 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002467 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
Douglas Gregor69021972011-11-30 17:33:56 +00002468 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2469 unsigned DefinitionAbbrev = Stream.EmitAbbrev(Abbrev);
2470
2471 Abbrev = new BitCodeAbbrev();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002472 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
Douglas Gregor69021972011-11-30 17:33:56 +00002473 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2474 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(Abbrev);
2475
2476 Abbrev = new BitCodeAbbrev();
2477 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
2478 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2479 unsigned HeaderAbbrev = Stream.EmitAbbrev(Abbrev);
Douglas Gregor524e33e2011-12-08 19:11:24 +00002480
2481 Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002482 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
2483 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2484 unsigned TopHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2485
2486 Abbrev = new BitCodeAbbrev();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002487 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
2488 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2489 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(Abbrev);
2490
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002491 Abbrev = new BitCodeAbbrev();
2492 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES));
Richard Smitha3feee22013-10-28 22:18:19 +00002493 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
2494 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Feature
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002495 unsigned RequiresAbbrev = Stream.EmitAbbrev(Abbrev);
2496
Douglas Gregor59527662012-10-15 06:28:11 +00002497 Abbrev = new BitCodeAbbrev();
2498 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
2499 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2500 unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2501
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002502 Abbrev = new BitCodeAbbrev();
Richard Smith306d8922014-10-22 23:50:56 +00002503 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
2504 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2505 unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2506
2507 Abbrev = new BitCodeAbbrev();
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002508 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
2509 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2510 unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2511
2512 Abbrev = new BitCodeAbbrev();
Richard Smith202210b2014-10-24 20:23:01 +00002513 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
2514 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2515 unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2516
2517 Abbrev = new BitCodeAbbrev();
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002518 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
2519 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2520 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2521 unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(Abbrev);
2522
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002523 Abbrev = new BitCodeAbbrev();
2524 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
2525 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
2526 unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(Abbrev);
2527
Douglas Gregorfb912652013-03-20 21:10:35 +00002528 Abbrev = new BitCodeAbbrev();
2529 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT));
2530 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Other module
2531 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Message
2532 unsigned ConflictAbbrev = Stream.EmitAbbrev(Abbrev);
2533
Douglas Gregor253eefe2011-12-01 00:59:36 +00002534 // Write the submodule metadata block.
Mehdi Amini57a41912015-09-10 01:46:39 +00002535 RecordData::value_type Record[] = {getNumberOfModules(WritingModule),
2536 FirstSubmoduleID -
2537 NUM_PREDEF_SUBMODULE_IDS};
Douglas Gregor253eefe2011-12-01 00:59:36 +00002538 Stream.EmitRecord(SUBMODULE_METADATA, Record);
2539
Douglas Gregor69021972011-11-30 17:33:56 +00002540 // Write all of the submodules.
Douglas Gregorde3ef502011-11-30 23:21:26 +00002541 std::queue<Module *> Q;
Douglas Gregor69021972011-11-30 17:33:56 +00002542 Q.push(WritingModule);
Douglas Gregor69021972011-11-30 17:33:56 +00002543 while (!Q.empty()) {
Douglas Gregorde3ef502011-11-30 23:21:26 +00002544 Module *Mod = Q.front();
Douglas Gregor69021972011-11-30 17:33:56 +00002545 Q.pop();
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002546 unsigned ID = getSubmoduleID(Mod);
Mehdi Amini57a41912015-09-10 01:46:39 +00002547
2548 uint64_t ParentID = 0;
Douglas Gregor69021972011-11-30 17:33:56 +00002549 if (Mod->Parent) {
2550 assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
Mehdi Amini57a41912015-09-10 01:46:39 +00002551 ParentID = SubmoduleIDs[Mod->Parent];
Douglas Gregor69021972011-11-30 17:33:56 +00002552 }
Mehdi Amini57a41912015-09-10 01:46:39 +00002553
2554 // Emit the definition of the block.
2555 {
2556 RecordData::value_type Record[] = {
2557 SUBMODULE_DEFINITION, ID, ParentID, Mod->IsFramework, Mod->IsExplicit,
2558 Mod->IsSystem, Mod->IsExternC, Mod->InferSubmodules,
2559 Mod->InferExplicitSubmodules, Mod->InferExportWildcard,
2560 Mod->ConfigMacrosExhaustive};
2561 Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name);
2562 }
2563
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002564 // Emit the requirements.
Richard Smith080056b2015-08-18 21:53:42 +00002565 for (const auto &R : Mod->Requirements) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002566 RecordData::value_type Record[] = {SUBMODULE_REQUIRES, R.second};
Richard Smith080056b2015-08-18 21:53:42 +00002567 Stream.EmitRecordWithBlob(RequiresAbbrev, Record, R.first);
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002568 }
2569
Douglas Gregor69021972011-11-30 17:33:56 +00002570 // Emit the umbrella header, if there is one.
Richard Smith2b63d152015-05-16 02:28:53 +00002571 if (auto UmbrellaHeader = Mod->getUmbrellaHeader()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002572 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_HEADER};
Richard Smith2b63d152015-05-16 02:28:53 +00002573 Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
2574 UmbrellaHeader.NameAsWritten);
2575 } else if (auto UmbrellaDir = Mod->getUmbrellaDir()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002576 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_DIR};
2577 Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
Richard Smith2b63d152015-05-16 02:28:53 +00002578 UmbrellaDir.NameAsWritten);
Douglas Gregor69021972011-11-30 17:33:56 +00002579 }
Richard Smith306d8922014-10-22 23:50:56 +00002580
Douglas Gregor69021972011-11-30 17:33:56 +00002581 // Emit the headers.
Richard Smith202210b2014-10-24 20:23:01 +00002582 struct {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002583 unsigned RecordKind;
Richard Smith202210b2014-10-24 20:23:01 +00002584 unsigned Abbrev;
Richard Smith3c1a41a2014-12-02 00:08:08 +00002585 Module::HeaderKind HeaderKind;
Richard Smith202210b2014-10-24 20:23:01 +00002586 } HeaderLists[] = {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002587 {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal},
2588 {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual},
2589 {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private},
Richard Smith202210b2014-10-24 20:23:01 +00002590 {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev,
Richard Smith3c1a41a2014-12-02 00:08:08 +00002591 Module::HK_PrivateTextual},
2592 {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded}
Richard Smith202210b2014-10-24 20:23:01 +00002593 };
2594 for (auto &HL : HeaderLists) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002595 RecordData::value_type Record[] = {HL.RecordKind};
Richard Smith3c1a41a2014-12-02 00:08:08 +00002596 for (auto &H : Mod->Headers[HL.HeaderKind])
2597 Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten);
2598 }
2599
2600 // Emit the top headers.
2601 {
2602 auto TopHeaders = Mod->getTopHeaders(PP->getFileManager());
Mehdi Amini57a41912015-09-10 01:46:39 +00002603 RecordData::value_type Record[] = {SUBMODULE_TOPHEADER};
Richard Smith3c1a41a2014-12-02 00:08:08 +00002604 for (auto *H : TopHeaders)
2605 Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, H->getName());
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002606 }
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002607
2608 // Emit the imports.
2609 if (!Mod->Imports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002610 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00002611 for (auto *I : Mod->Imports)
2612 Record.push_back(getSubmoduleID(I));
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002613 Stream.EmitRecord(SUBMODULE_IMPORTS, Record);
2614 }
2615
Douglas Gregor24bb9232011-12-02 18:58:38 +00002616 // Emit the exports.
2617 if (!Mod->Exports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002618 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00002619 for (const auto &E : Mod->Exports) {
2620 // FIXME: This may fail; we don't require that all exported modules
2621 // are local or imported.
2622 Record.push_back(getSubmoduleID(E.getPointer()));
2623 Record.push_back(E.getInt());
Douglas Gregor24bb9232011-12-02 18:58:38 +00002624 }
2625 Stream.EmitRecord(SUBMODULE_EXPORTS, Record);
2626 }
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002627
Daniel Jasperba7f2f72013-09-24 09:14:14 +00002628 //FIXME: How do we emit the 'use'd modules? They may not be submodules.
2629 // Might be unnecessary as use declarations are only used to build the
2630 // module itself.
2631
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002632 // Emit the link libraries.
Richard Smith080056b2015-08-18 21:53:42 +00002633 for (const auto &LL : Mod->LinkLibraries) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002634 RecordData::value_type Record[] = {SUBMODULE_LINK_LIBRARY,
2635 LL.IsFramework};
Richard Smith080056b2015-08-18 21:53:42 +00002636 Stream.EmitRecordWithBlob(LinkLibraryAbbrev, Record, LL.Library);
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002637 }
2638
Douglas Gregorfb912652013-03-20 21:10:35 +00002639 // Emit the conflicts.
Richard Smith080056b2015-08-18 21:53:42 +00002640 for (const auto &C : Mod->Conflicts) {
Richard Smith080056b2015-08-18 21:53:42 +00002641 // FIXME: This may fail; we don't require that all conflicting modules
2642 // are local or imported.
Mehdi Amini57a41912015-09-10 01:46:39 +00002643 RecordData::value_type Record[] = {SUBMODULE_CONFLICT,
2644 getSubmoduleID(C.Other)};
Richard Smith080056b2015-08-18 21:53:42 +00002645 Stream.EmitRecordWithBlob(ConflictAbbrev, Record, C.Message);
Douglas Gregorfb912652013-03-20 21:10:35 +00002646 }
2647
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002648 // Emit the configuration macros.
Richard Smith080056b2015-08-18 21:53:42 +00002649 for (const auto &CM : Mod->ConfigMacros) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002650 RecordData::value_type Record[] = {SUBMODULE_CONFIG_MACRO};
Richard Smith080056b2015-08-18 21:53:42 +00002651 Stream.EmitRecordWithBlob(ConfigMacroAbbrev, Record, CM);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002652 }
2653
Douglas Gregor69021972011-11-30 17:33:56 +00002654 // Queue up the submodules of this module.
Richard Smith080056b2015-08-18 21:53:42 +00002655 for (auto *M : Mod->submodules())
2656 Q.push(M);
Douglas Gregor69021972011-11-30 17:33:56 +00002657 }
2658
2659 Stream.ExitBlock();
Richard Smith23d8d032015-05-14 00:45:20 +00002660
Richard Smith23d8d032015-05-14 00:45:20 +00002661 assert((NextSubmoduleID - FirstSubmoduleID ==
2662 getNumberOfModules(WritingModule)) &&
2663 "Wrong # of submodules; found a reference to a non-local, "
2664 "non-imported submodule?");
Douglas Gregor69021972011-11-30 17:33:56 +00002665}
2666
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002667serialization::SubmoduleID
2668ASTWriter::inferSubmoduleIDFromLocation(SourceLocation Loc) {
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002669 if (Loc.isInvalid() || !WritingModule)
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002670 return 0; // No submodule
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002671
2672 // Find the module that owns this location.
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002673 ModuleMap &ModMap = PP->getHeaderSearchInfo().getModuleMap();
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002674 Module *OwningMod
2675 = ModMap.inferModuleFromLocation(FullSourceLoc(Loc,PP->getSourceManager()));
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002676 if (!OwningMod)
2677 return 0;
2678
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002679 // Check whether this submodule is part of our own module.
2680 if (WritingModule != OwningMod && !OwningMod->isSubModuleOf(WritingModule))
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002681 return 0;
2682
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002683 return getSubmoduleID(OwningMod);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002684}
2685
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00002686void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
2687 bool isModule) {
2688 // Make sure set diagnostic pragmas don't affect the translation unit that
2689 // imports the module.
2690 // FIXME: Make diagnostic pragma sections work properly with modules.
2691 if (isModule)
2692 return;
2693
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002694 llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64>
2695 DiagStateIDMap;
2696 unsigned CurrID = 0;
2697 DiagStateIDMap[&Diag.DiagStates.front()] = ++CurrID; // the command-line one.
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002698 RecordData Record;
David Blaikie9c902b52011-09-25 23:23:43 +00002699 for (DiagnosticsEngine::DiagStatePointsTy::const_iterator
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002700 I = Diag.DiagStatePoints.begin(), E = Diag.DiagStatePoints.end();
2701 I != E; ++I) {
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002702 const DiagnosticsEngine::DiagStatePoint &point = *I;
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002703 if (point.Loc.isInvalid())
2704 continue;
2705
Richard Smithb22a1d12016-03-27 20:13:24 +00002706 AddSourceLocation(point.Loc, Record);
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002707 unsigned &DiagStateID = DiagStateIDMap[point.State];
2708 Record.push_back(DiagStateID);
2709
2710 if (DiagStateID == 0) {
2711 DiagStateID = ++CurrID;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002712 for (const auto &I : *(point.State)) {
2713 if (I.second.isPragma()) {
2714 Record.push_back(I.first);
2715 Record.push_back((unsigned)I.second.getSeverity());
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002716 }
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002717 }
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002718 Record.push_back(-1); // mark the end of the diag/map pairs for this
2719 // location.
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002720 }
2721 }
2722
Argyrios Kyrtzidisb0ca9eb2010-11-05 22:20:49 +00002723 if (!Record.empty())
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002724 Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002725}
2726
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002727void ASTWriter::WriteCXXBaseSpecifiersOffsets() {
2728 if (CXXBaseSpecifiersOffsets.empty())
2729 return;
2730
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002731 // Create a blob abbreviation for the C++ base specifiers offsets.
2732 using namespace llvm;
2733
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002734 auto *Abbrev = new BitCodeAbbrev();
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002735 Abbrev->Add(BitCodeAbbrevOp(CXX_BASE_SPECIFIER_OFFSETS));
2736 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
2737 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2738 unsigned BaseSpecifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2739
Douglas Gregorc27b2872011-08-04 00:01:48 +00002740 // Write the base specifier offsets table.
Mehdi Amini57a41912015-09-10 01:46:39 +00002741 RecordData::value_type Record[] = {CXX_BASE_SPECIFIER_OFFSETS,
2742 CXXBaseSpecifiersOffsets.size()};
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002743 Stream.EmitRecordWithBlob(BaseSpecifierOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002744 bytes(CXXBaseSpecifiersOffsets));
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002745}
2746
Douglas Gregorc5046832009-04-27 18:38:38 +00002747//===----------------------------------------------------------------------===//
2748// Type Serialization
2749//===----------------------------------------------------------------------===//
Chris Lattnereeffaef2009-04-10 17:15:23 +00002750
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002751/// \brief Write the representation of a type to the AST stream.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002752void ASTWriter::WriteType(QualType T) {
Richard Smith290d8012016-04-06 17:06:00 +00002753 TypeIdx &IdxRef = TypeIdxs[T];
2754 if (IdxRef.getIndex() == 0) // we haven't seen this type before.
2755 IdxRef = TypeIdx(NextTypeID++);
2756 TypeIdx Idx = IdxRef;
Mike Stump11289f42009-09-09 15:08:12 +00002757
Douglas Gregor9b3932c2010-10-05 18:37:06 +00002758 assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
Douglas Gregordc72caa2010-10-04 18:21:45 +00002759
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002760 RecordData Record;
Mike Stump11289f42009-09-09 15:08:12 +00002761
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002762 // Emit the type's representation.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002763 ASTTypeWriter W(*this, Record);
Richard Smith290d8012016-04-06 17:06:00 +00002764 W.Visit(T);
2765 uint64_t Offset = W.Emit();
John McCall8ccfcb52009-09-24 19:53:00 +00002766
Richard Smith290d8012016-04-06 17:06:00 +00002767 // Record the offset for this type.
2768 unsigned Index = Idx.getIndex() - FirstTypeID;
2769 if (TypeOffsets.size() == Index)
2770 TypeOffsets.push_back(Offset);
2771 else if (TypeOffsets.size() < Index) {
2772 TypeOffsets.resize(Index + 1);
2773 TypeOffsets[Index] = Offset;
John McCall8ccfcb52009-09-24 19:53:00 +00002774 } else {
Richard Smith290d8012016-04-06 17:06:00 +00002775 llvm_unreachable("Types emitted in wrong order");
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002776 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002777}
2778
Douglas Gregorc5046832009-04-27 18:38:38 +00002779//===----------------------------------------------------------------------===//
2780// Declaration Serialization
2781//===----------------------------------------------------------------------===//
2782
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002783/// \brief Write the block containing all of the declaration IDs
2784/// lexically declared within the given DeclContext.
2785///
2786/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
2787/// bistream, or 0 if no block was written.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002788uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002789 DeclContext *DC) {
Argyrios Kyrtzidiscfbfe782009-06-30 02:36:12 +00002790 if (DC->decls_empty())
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002791 return 0;
2792
Douglas Gregor8f45df52009-04-16 22:23:12 +00002793 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smith82f8fcd2015-08-06 22:07:25 +00002794 SmallVector<uint32_t, 128> KindDeclPairs;
2795 for (const auto *D : DC->decls()) {
2796 KindDeclPairs.push_back(D->getKind());
2797 KindDeclPairs.push_back(GetDeclRef(D));
2798 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002799
Douglas Gregora57c3ab2009-04-22 22:34:57 +00002800 ++NumLexicalDeclContexts;
Mehdi Amini57a41912015-09-10 01:46:39 +00002801 RecordData::value_type Record[] = {DECL_CONTEXT_LEXICAL};
Richard Smith82f8fcd2015-08-06 22:07:25 +00002802 Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record,
2803 bytes(KindDeclPairs));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002804 return Offset;
2805}
2806
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002807void ASTWriter::WriteTypeDeclOffsets() {
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002808 using namespace llvm;
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002809
2810 // Write the type offsets array
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002811 auto *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00002812 Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002813 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
Douglas Gregor5204bde2011-08-02 16:26:37 +00002814 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002815 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
2816 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
Mehdi Amini57a41912015-09-10 01:46:39 +00002817 {
2818 RecordData::value_type Record[] = {TYPE_OFFSET, TypeOffsets.size(),
2819 FirstTypeID - NUM_PREDEF_TYPE_IDS};
2820 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, bytes(TypeOffsets));
2821 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002822
2823 // Write the declaration offsets array
2824 Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00002825 Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002826 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
Douglas Gregorf7180622011-08-03 15:48:04 +00002827 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002828 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
2829 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
Mehdi Amini57a41912015-09-10 01:46:39 +00002830 {
2831 RecordData::value_type Record[] = {DECL_OFFSET, DeclOffsets.size(),
2832 FirstDeclID - NUM_PREDEF_DECL_IDS};
2833 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, bytes(DeclOffsets));
2834 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002835}
2836
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002837void ASTWriter::WriteFileDeclIDsMap() {
2838 using namespace llvm;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002839
Chandler Carruthb306d732015-03-27 00:31:20 +00002840 SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs(
2841 FileDeclIDs.begin(), FileDeclIDs.end());
2842 std::sort(SortedFileDeclIDs.begin(), SortedFileDeclIDs.end(),
2843 llvm::less_first());
2844
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002845 // Join the vectors of DeclIDs from all files.
Chandler Carruthb306d732015-03-27 00:31:20 +00002846 SmallVector<DeclID, 256> FileGroupedDeclIDs;
2847 for (auto &FileDeclEntry : SortedFileDeclIDs) {
2848 DeclIDInFileInfo &Info = *FileDeclEntry.second;
2849 Info.FirstDeclIndex = FileGroupedDeclIDs.size();
2850 for (auto &LocDeclEntry : Info.DeclIDs)
2851 FileGroupedDeclIDs.push_back(LocDeclEntry.second);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002852 }
2853
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002854 auto *Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002855 Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
Argyrios Kyrtzidis10e78462012-10-02 21:09:13 +00002856 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002857 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2858 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
Mehdi Amini57a41912015-09-10 01:46:39 +00002859 RecordData::value_type Record[] = {FILE_SORTED_DECLS,
2860 FileGroupedDeclIDs.size()};
Reid Kleckner012665e2015-05-21 00:13:09 +00002861 Stream.EmitRecordWithBlob(AbbrevCode, Record, bytes(FileGroupedDeclIDs));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002862}
2863
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002864void ASTWriter::WriteComments() {
2865 Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3);
Dmitri Gribenko7dd29d42012-07-06 18:19:34 +00002866 ArrayRef<RawComment *> RawComments = Context->Comments.getComments();
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002867 RecordData Record;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002868 for (const auto *I : RawComments) {
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002869 Record.clear();
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002870 AddSourceRange(I->getSourceRange(), Record);
2871 Record.push_back(I->getKind());
2872 Record.push_back(I->isTrailingComment());
2873 Record.push_back(I->isAlmostTrailingComment());
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002874 Stream.EmitRecord(COMMENTS_RAW_COMMENT, Record);
2875 }
2876 Stream.ExitBlock();
2877}
2878
Douglas Gregorc5046832009-04-27 18:38:38 +00002879//===----------------------------------------------------------------------===//
2880// Global Method Pool and Selector Serialization
2881//===----------------------------------------------------------------------===//
2882
Douglas Gregore84a9da2009-04-20 20:36:09 +00002883namespace {
Douglas Gregorc78d3462009-04-24 21:10:55 +00002884// Trait used for the on-disk hash table used in the method pool.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002885class ASTMethodPoolTrait {
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002886 ASTWriter &Writer;
Douglas Gregorc78d3462009-04-24 21:10:55 +00002887
2888public:
2889 typedef Selector key_type;
2890 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00002891
Sebastian Redl834bb972010-08-04 17:20:04 +00002892 struct data_type {
Sebastian Redl539c5062010-08-18 23:57:32 +00002893 SelectorID ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00002894 ObjCMethodList Instance, Factory;
2895 };
Douglas Gregorc78d3462009-04-24 21:10:55 +00002896 typedef const data_type& data_type_ref;
2897
Justin Bogner25463f12014-04-18 20:27:24 +00002898 typedef unsigned hash_value_type;
2899 typedef unsigned offset_type;
2900
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002901 explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) { }
Mike Stump11289f42009-09-09 15:08:12 +00002902
Justin Bogner25463f12014-04-18 20:27:24 +00002903 static hash_value_type ComputeHash(Selector Sel) {
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +00002904 return serialization::ComputeHash(Sel);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002905 }
Mike Stump11289f42009-09-09 15:08:12 +00002906
2907 std::pair<unsigned,unsigned>
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002908 EmitKeyDataLength(raw_ostream& Out, Selector Sel,
Douglas Gregorc78d3462009-04-24 21:10:55 +00002909 data_type_ref Methods) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002910 using namespace llvm::support;
2911 endian::Writer<little> LE(Out);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002912 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
Justin Bognere1c147c2014-03-28 22:03:19 +00002913 LE.write<uint16_t>(KeyLen);
Sebastian Redl834bb972010-08-04 17:20:04 +00002914 unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
2915 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002916 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002917 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002918 DataLen += 4;
Sebastian Redl834bb972010-08-04 17:20:04 +00002919 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002920 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002921 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002922 DataLen += 4;
Justin Bognere1c147c2014-03-28 22:03:19 +00002923 LE.write<uint16_t>(DataLen);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002924 return std::make_pair(KeyLen, DataLen);
2925 }
Mike Stump11289f42009-09-09 15:08:12 +00002926
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002927 void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002928 using namespace llvm::support;
2929 endian::Writer<little> LE(Out);
Mike Stump11289f42009-09-09 15:08:12 +00002930 uint64_t Start = Out.tell();
Douglas Gregor95c13f52009-04-25 17:48:32 +00002931 assert((Start >> 32) == 0 && "Selector key offset too large");
2932 Writer.SetSelectorOffset(Sel, Start);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002933 unsigned N = Sel.getNumArgs();
Justin Bognere1c147c2014-03-28 22:03:19 +00002934 LE.write<uint16_t>(N);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002935 if (N == 0)
2936 N = 1;
2937 for (unsigned I = 0; I != N; ++I)
Justin Bognere1c147c2014-03-28 22:03:19 +00002938 LE.write<uint32_t>(
2939 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
Douglas Gregorc78d3462009-04-24 21:10:55 +00002940 }
Mike Stump11289f42009-09-09 15:08:12 +00002941
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002942 void EmitData(raw_ostream& Out, key_type_ref,
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002943 data_type_ref Methods, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002944 using namespace llvm::support;
2945 endian::Writer<little> LE(Out);
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002946 uint64_t Start = Out.tell(); (void)Start;
Justin Bognere1c147c2014-03-28 22:03:19 +00002947 LE.write<uint32_t>(Methods.ID);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002948 unsigned NumInstanceMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00002949 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002950 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002951 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002952 ++NumInstanceMethods;
2953
2954 unsigned NumFactoryMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00002955 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002956 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002957 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002958 ++NumFactoryMethods;
2959
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002960 unsigned InstanceBits = Methods.Instance.getBits();
2961 assert(InstanceBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00002962 unsigned InstanceHasMoreThanOneDeclBit =
2963 Methods.Instance.hasMoreThanOneDecl();
2964 unsigned FullInstanceBits = (NumInstanceMethods << 3) |
2965 (InstanceHasMoreThanOneDeclBit << 2) |
2966 InstanceBits;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002967 unsigned FactoryBits = Methods.Factory.getBits();
2968 assert(FactoryBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00002969 unsigned FactoryHasMoreThanOneDeclBit =
2970 Methods.Factory.hasMoreThanOneDecl();
2971 unsigned FullFactoryBits = (NumFactoryMethods << 3) |
2972 (FactoryHasMoreThanOneDeclBit << 2) |
2973 FactoryBits;
2974 LE.write<uint16_t>(FullInstanceBits);
2975 LE.write<uint16_t>(FullFactoryBits);
Sebastian Redl834bb972010-08-04 17:20:04 +00002976 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002977 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002978 if (Method->getMethod())
2979 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Sebastian Redl834bb972010-08-04 17:20:04 +00002980 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002981 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002982 if (Method->getMethod())
2983 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002984
2985 assert(Out.tell() - Start == DataLen && "Data length is wrong");
Douglas Gregorc78d3462009-04-24 21:10:55 +00002986 }
2987};
2988} // end anonymous namespace
2989
Sebastian Redla19a67f2010-08-03 21:58:15 +00002990/// \brief Write ObjC data: selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00002991///
2992/// The method pool contains both instance and factory methods, stored
Sebastian Redla19a67f2010-08-03 21:58:15 +00002993/// in an on-disk hash table indexed by the selector. The hash table also
2994/// contains an empty entry for every other selector known to Sema.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002995void ASTWriter::WriteSelectors(Sema &SemaRef) {
Douglas Gregorc78d3462009-04-24 21:10:55 +00002996 using namespace llvm;
2997
Sebastian Redla19a67f2010-08-03 21:58:15 +00002998 // Do we have to do anything at all?
Sebastian Redl834bb972010-08-04 17:20:04 +00002999 if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
Sebastian Redla19a67f2010-08-03 21:58:15 +00003000 return;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003001 unsigned NumTableEntries = 0;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003002 // Create and write out the blob that contains selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00003003 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003004 llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003005 ASTMethodPoolTrait Trait(*this);
Mike Stump11289f42009-09-09 15:08:12 +00003006
Sebastian Redla19a67f2010-08-03 21:58:15 +00003007 // Create the on-disk hash table representation. We walk through every
3008 // selector we've seen and look it up in the method pool.
Sebastian Redld95a56e2010-08-04 18:21:41 +00003009 SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003010 for (auto &SelectorAndID : SelectorIDs) {
3011 Selector S = SelectorAndID.first;
3012 SelectorID ID = SelectorAndID.second;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003013 Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003014 ASTMethodPoolTrait::data_type Data = {
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003015 ID,
Sebastian Redl834bb972010-08-04 17:20:04 +00003016 ObjCMethodList(),
3017 ObjCMethodList()
3018 };
3019 if (F != SemaRef.MethodPool.end()) {
3020 Data.Instance = F->second.first;
3021 Data.Factory = F->second.second;
3022 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003023 // Only write this selector if it's not in an existing AST or something
Sebastian Redld95a56e2010-08-04 18:21:41 +00003024 // changed.
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003025 if (Chain && ID < FirstSelectorID) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00003026 // Selector already exists. Did it change?
3027 bool changed = false;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003028 for (ObjCMethodList *M = &Data.Instance;
3029 !changed && M && M->getMethod(); M = M->getNext()) {
3030 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003031 changed = true;
3032 }
Nico Weber2e0c8f72014-12-27 03:58:08 +00003033 for (ObjCMethodList *M = &Data.Factory; !changed && M && M->getMethod();
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003034 M = M->getNext()) {
Nico Weber2e0c8f72014-12-27 03:58:08 +00003035 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003036 changed = true;
3037 }
3038 if (!changed)
3039 continue;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003040 } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) {
Sebastian Redl6e1a2a02010-08-04 21:22:45 +00003041 // A new method pool entry.
3042 ++NumTableEntries;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003043 }
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003044 Generator.insert(S, Data, Trait);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003045 }
3046
Douglas Gregorc78d3462009-04-24 21:10:55 +00003047 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003048 SmallString<4096> MethodPool;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003049 uint32_t BucketOffset;
3050 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003051 using namespace llvm::support;
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003052 ASTMethodPoolTrait Trait(*this);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003053 llvm::raw_svector_ostream Out(MethodPool);
3054 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003055 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003056 BucketOffset = Generator.Emit(Out, Trait);
3057 }
3058
3059 // Create a blob abbreviation
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003060 auto *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003061 Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003062 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003063 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003064 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3065 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(Abbrev);
3066
Douglas Gregor95c13f52009-04-25 17:48:32 +00003067 // Write the method pool
Mehdi Amini57a41912015-09-10 01:46:39 +00003068 {
3069 RecordData::value_type Record[] = {METHOD_POOL, BucketOffset,
3070 NumTableEntries};
3071 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool);
3072 }
Douglas Gregor95c13f52009-04-25 17:48:32 +00003073
3074 // Create a blob abbreviation for the selector table offsets.
3075 Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003076 Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
Douglas Gregord4c5ed02010-10-29 22:39:52 +00003077 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
Douglas Gregor8f364fb2011-08-03 23:28:44 +00003078 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor95c13f52009-04-25 17:48:32 +00003079 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3080 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
3081
3082 // Write the selector offsets table.
Mehdi Amini57a41912015-09-10 01:46:39 +00003083 {
3084 RecordData::value_type Record[] = {
3085 SELECTOR_OFFSETS, SelectorOffsets.size(),
3086 FirstSelectorID - NUM_PREDEF_SELECTOR_IDS};
3087 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
3088 bytes(SelectorOffsets));
3089 }
Douglas Gregorc78d3462009-04-24 21:10:55 +00003090 }
3091}
3092
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003093/// \brief Write the selectors referenced in @selector expression into AST file.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003094void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003095 using namespace llvm;
3096 if (SemaRef.ReferencedSelectors.empty())
3097 return;
Sebastian Redlada023c2010-08-04 20:40:17 +00003098
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003099 RecordData Record;
Sebastian Redlada023c2010-08-04 20:40:17 +00003100
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003101 // Note: this writes out all references even for a dependent AST. But it is
Sebastian Redl51c79d82010-08-04 22:21:29 +00003102 // very tricky to fix, and given that @selector shouldn't really appear in
3103 // headers, probably not worth it. It's not a correctness issue.
Chandler Carruth12c8f652015-03-27 00:55:05 +00003104 for (auto &SelectorAndLocation : SemaRef.ReferencedSelectors) {
3105 Selector Sel = SelectorAndLocation.first;
3106 SourceLocation Loc = SelectorAndLocation.second;
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003107 AddSelectorRef(Sel, Record);
3108 AddSourceLocation(Loc, Record);
3109 }
Sebastian Redl539c5062010-08-18 23:57:32 +00003110 Stream.EmitRecord(REFERENCED_SELECTOR_POOL, Record);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003111}
3112
Douglas Gregorc5046832009-04-27 18:38:38 +00003113//===----------------------------------------------------------------------===//
3114// Identifier Table Serialization
3115//===----------------------------------------------------------------------===//
3116
Richard Smithb3761912015-02-05 23:08:52 +00003117/// Determine the declaration that should be put into the name lookup table to
3118/// represent the given declaration in this module. This is usually D itself,
3119/// but if D was imported and merged into a local declaration, we want the most
3120/// recent local declaration instead. The chosen declaration will be the most
3121/// recent declaration in any module that imports this one.
3122static NamedDecl *getDeclForLocalLookup(const LangOptions &LangOpts,
3123 NamedDecl *D) {
3124 if (!LangOpts.Modules || !D->isFromASTFile())
3125 return D;
3126
3127 if (Decl *Redecl = D->getPreviousDecl()) {
3128 // For Redeclarable decls, a prior declaration might be local.
3129 for (; Redecl; Redecl = Redecl->getPreviousDecl()) {
3130 if (!Redecl->isFromASTFile())
3131 return cast<NamedDecl>(Redecl);
Richard Smithfe620d22015-03-05 23:24:12 +00003132 // If we find a decl from a (chained-)PCH stop since we won't find a
Richard Smithb3761912015-02-05 23:08:52 +00003133 // local one.
3134 if (D->getOwningModuleID() == 0)
3135 break;
3136 }
3137 } else if (Decl *First = D->getCanonicalDecl()) {
3138 // For Mergeable decls, the first decl might be local.
3139 if (!First->isFromASTFile())
3140 return cast<NamedDecl>(First);
3141 }
3142
3143 // All declarations are imported. Our most recent declaration will also be
3144 // the most recent one in anyone who imports us.
3145 return D;
3146}
3147
Douglas Gregorc78d3462009-04-24 21:10:55 +00003148namespace {
Richard Smithcf97cf62015-04-19 01:34:23 +00003149class ASTIdentifierTableTrait {
3150 ASTWriter &Writer;
3151 Preprocessor &PP;
3152 IdentifierResolver &IdResolver;
Richard Smith9c254182015-07-19 21:41:12 +00003153 bool IsModule;
Richard Smitha534a312015-07-21 23:54:07 +00003154 bool NeedDecls;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003155 ASTWriter::RecordData *InterestingIdentifierOffsets;
Richard Smithcf97cf62015-04-19 01:34:23 +00003156
3157 /// \brief Determines whether this is an "interesting" identifier that needs a
3158 /// full IdentifierInfo structure written into the hash table. Notably, this
3159 /// doesn't check whether the name has macros defined; use PublicMacroIterator
3160 /// to check that.
Richard Smith9c254182015-07-19 21:41:12 +00003161 bool isInterestingIdentifier(const IdentifierInfo *II, uint64_t MacroOffset) {
Richard Smithd7329392015-04-21 21:46:32 +00003162 if (MacroOffset ||
3163 II->isPoisoned() ||
Richard Smith9c254182015-07-19 21:41:12 +00003164 (IsModule ? II->hasRevertedBuiltin() : II->getObjCOrBuiltinID()) ||
Richard Smithcf97cf62015-04-19 01:34:23 +00003165 II->hasRevertedTokenIDToIdentifier() ||
Richard Smitha534a312015-07-21 23:54:07 +00003166 (NeedDecls && II->getFETokenInfo<void>()))
Richard Smithcf97cf62015-04-19 01:34:23 +00003167 return true;
3168
3169 return false;
3170 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003171
Douglas Gregore84a9da2009-04-20 20:36:09 +00003172public:
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003173 typedef IdentifierInfo* key_type;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003174 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00003175
Sebastian Redl539c5062010-08-18 23:57:32 +00003176 typedef IdentID data_type;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003177 typedef data_type data_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00003178
Justin Bogner25463f12014-04-18 20:27:24 +00003179 typedef unsigned hash_value_type;
3180 typedef unsigned offset_type;
3181
Richard Smithd7329392015-04-21 21:46:32 +00003182 ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
Richard Smith33e0f7e2015-07-22 02:08:40 +00003183 IdentifierResolver &IdResolver, bool IsModule,
3184 ASTWriter::RecordData *InterestingIdentifierOffsets)
Richard Smitha534a312015-07-21 23:54:07 +00003185 : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule),
Richard Smith33e0f7e2015-07-22 02:08:40 +00003186 NeedDecls(!IsModule || !Writer.getLangOpts().CPlusPlus),
3187 InterestingIdentifierOffsets(InterestingIdentifierOffsets) {}
Douglas Gregore84a9da2009-04-20 20:36:09 +00003188
Richard Smithd79514e2016-02-05 19:03:40 +00003189 bool needDecls() const { return NeedDecls; }
3190
Justin Bogner25463f12014-04-18 20:27:24 +00003191 static hash_value_type ComputeHash(const IdentifierInfo* II) {
Daniel Dunbarf8502d52009-10-17 23:52:28 +00003192 return llvm::HashString(II->getName());
Douglas Gregore84a9da2009-04-20 20:36:09 +00003193 }
Mike Stump11289f42009-09-09 15:08:12 +00003194
Richard Smith33e0f7e2015-07-22 02:08:40 +00003195 bool isInterestingIdentifier(const IdentifierInfo *II) {
3196 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3197 return isInterestingIdentifier(II, MacroOffset);
3198 }
Richard Smith9c254182015-07-19 21:41:12 +00003199 bool isInterestingNonMacroIdentifier(const IdentifierInfo *II) {
3200 return isInterestingIdentifier(II, 0);
3201 }
3202
Mike Stump11289f42009-09-09 15:08:12 +00003203 std::pair<unsigned,unsigned>
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003204 EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) {
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003205 unsigned KeyLen = II->getLength() + 1;
Douglas Gregor1d583f22009-04-28 21:18:29 +00003206 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
Richard Smithd7329392015-04-21 21:46:32 +00003207 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3208 if (isInterestingIdentifier(II, MacroOffset)) {
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003209 DataLen += 2; // 2 bytes for builtin ID
3210 DataLen += 2; // 2 bytes for flags
Richard Smithd7329392015-04-21 21:46:32 +00003211 if (MacroOffset)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003212 DataLen += 4; // MacroDirectives offset.
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003213
Richard Smitha534a312015-07-21 23:54:07 +00003214 if (NeedDecls) {
3215 for (IdentifierResolver::iterator D = IdResolver.begin(II),
3216 DEnd = IdResolver.end();
3217 D != DEnd; ++D)
3218 DataLen += 4;
3219 }
Douglas Gregor1d583f22009-04-28 21:18:29 +00003220 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003221 using namespace llvm::support;
3222 endian::Writer<little> LE(Out);
3223
Richard Smithdf8a8312015-03-13 04:05:01 +00003224 assert((uint16_t)DataLen == DataLen && (uint16_t)KeyLen == KeyLen);
Justin Bognere1c147c2014-03-28 22:03:19 +00003225 LE.write<uint16_t>(DataLen);
Douglas Gregorab4df582009-04-28 20:01:51 +00003226 // We emit the key length after the data length so that every
3227 // string is preceded by a 16-bit length. This matches the PTH
3228 // format for storing identifiers.
Justin Bognere1c147c2014-03-28 22:03:19 +00003229 LE.write<uint16_t>(KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003230 return std::make_pair(KeyLen, DataLen);
3231 }
Mike Stump11289f42009-09-09 15:08:12 +00003232
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003233 void EmitKey(raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregore84a9da2009-04-20 20:36:09 +00003234 unsigned KeyLen) {
3235 // Record the location of the key data. This is used when generating
3236 // the mapping from persistent IDs to strings.
3237 Writer.SetIdentifierOffset(II, Out.tell());
Richard Smith33e0f7e2015-07-22 02:08:40 +00003238
3239 // Emit the offset of the key/data length information to the interesting
3240 // identifiers table if necessary.
3241 if (InterestingIdentifierOffsets && isInterestingIdentifier(II))
3242 InterestingIdentifierOffsets->push_back(Out.tell() - 4);
3243
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003244 Out.write(II->getNameStart(), KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003245 }
Mike Stump11289f42009-09-09 15:08:12 +00003246
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003247 void EmitData(raw_ostream& Out, IdentifierInfo* II,
Sebastian Redl539c5062010-08-18 23:57:32 +00003248 IdentID ID, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003249 using namespace llvm::support;
3250 endian::Writer<little> LE(Out);
Richard Smithcf97cf62015-04-19 01:34:23 +00003251
Richard Smithd7329392015-04-21 21:46:32 +00003252 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3253 if (!isInterestingIdentifier(II, MacroOffset)) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003254 LE.write<uint32_t>(ID << 1);
Douglas Gregor1d583f22009-04-28 21:18:29 +00003255 return;
3256 }
Douglas Gregorb9256522009-04-28 21:32:13 +00003257
Justin Bognere1c147c2014-03-28 22:03:19 +00003258 LE.write<uint32_t>((ID << 1) | 0x01);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003259 uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID();
3260 assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
Justin Bognere1c147c2014-03-28 22:03:19 +00003261 LE.write<uint16_t>(Bits);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003262 Bits = 0;
Richard Smithd7329392015-04-21 21:46:32 +00003263 bool HadMacroDefinition = MacroOffset != 0;
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003264 Bits = (Bits << 1) | unsigned(HadMacroDefinition);
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003265 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
3266 Bits = (Bits << 1) | unsigned(II->isPoisoned());
Richard Smith9c254182015-07-19 21:41:12 +00003267 Bits = (Bits << 1) | unsigned(II->hasRevertedBuiltin());
Argyrios Kyrtzidis3084a612010-08-11 22:55:12 +00003268 Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003269 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
Justin Bognere1c147c2014-03-28 22:03:19 +00003270 LE.write<uint16_t>(Bits);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003271
Richard Smithd7329392015-04-21 21:46:32 +00003272 if (HadMacroDefinition)
3273 LE.write<uint32_t>(MacroOffset);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003274
Richard Smitha534a312015-07-21 23:54:07 +00003275 if (NeedDecls) {
3276 // Emit the declaration IDs in reverse order, because the
3277 // IdentifierResolver provides the declarations as they would be
3278 // visible (e.g., the function "stat" would come before the struct
3279 // "stat"), but the ASTReader adds declarations to the end of the list
3280 // (so we need to see the struct "stat" before the function "stat").
3281 // Only emit declarations that aren't from a chained PCH, though.
3282 SmallVector<NamedDecl *, 16> Decls(IdResolver.begin(II),
3283 IdResolver.end());
3284 for (SmallVectorImpl<NamedDecl *>::reverse_iterator D = Decls.rbegin(),
3285 DEnd = Decls.rend();
3286 D != DEnd; ++D)
3287 LE.write<uint32_t>(
3288 Writer.getDeclID(getDeclForLocalLookup(PP.getLangOpts(), *D)));
3289 }
Douglas Gregore84a9da2009-04-20 20:36:09 +00003290 }
3291};
3292} // end anonymous namespace
3293
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003294/// \brief Write the identifier table into the AST file.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003295///
3296/// The identifier table consists of a blob containing string data
3297/// (the actual identifiers themselves) and a separate "offsets" index
3298/// that maps identifier IDs to locations within the blob.
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003299void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
3300 IdentifierResolver &IdResolver,
3301 bool IsModule) {
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003302 using namespace llvm;
3303
Richard Smith33e0f7e2015-07-22 02:08:40 +00003304 RecordData InterestingIdents;
3305
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003306 // Create and write out the blob that contains the identifier
3307 // strings.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003308 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003309 llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003310 ASTIdentifierTableTrait Trait(
3311 *this, PP, IdResolver, IsModule,
3312 (getLangOpts().CPlusPlus && IsModule) ? &InterestingIdents : nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003313
Douglas Gregore6648fb2009-04-28 20:33:11 +00003314 // Look for any identifiers that were named while processing the
3315 // headers, but are otherwise not needed. We add these to the hash
3316 // table to enable checking of the predefines buffer in the case
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003317 // where the user adds new macro definitions when building the AST
Douglas Gregore6648fb2009-04-28 20:33:11 +00003318 // file.
Chandler Carruth8440c982015-03-26 23:54:15 +00003319 SmallVector<const IdentifierInfo *, 128> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003320 for (const auto &ID : PP.getIdentifierTable())
3321 IIs.push_back(ID.second);
Chandler Carruth8440c982015-03-26 23:54:15 +00003322 // Sort the identifiers lexicographically before getting them references so
3323 // that their order is stable.
3324 std::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>());
3325 for (const IdentifierInfo *II : IIs)
Richard Smith9c254182015-07-19 21:41:12 +00003326 if (Trait.isInterestingNonMacroIdentifier(II))
3327 getIdentifierRef(II);
Douglas Gregore6648fb2009-04-28 20:33:11 +00003328
Sebastian Redlff4a2952010-07-23 23:49:55 +00003329 // Create the on-disk hash table representation. We only store offsets
3330 // for identifiers that appear here for the first time.
3331 IdentifierOffsets.resize(NextIdentID - FirstIdentID);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003332 for (auto IdentIDPair : IdentifierIDs) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003333 auto *II = const_cast<IdentifierInfo *>(IdentIDPair.first);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003334 IdentID ID = IdentIDPair.second;
3335 assert(II && "NULL identifier in identifier table");
Vassil Vassilev262f41e2016-03-30 20:16:03 +00003336 // Write out identifiers if either the ID is local or the identifier has
3337 // changed since it was loaded.
3338 if (ID >= FirstIdentID || !Chain || !II->isFromAST()
3339 || II->hasChangedSinceDeserialization() ||
Richard Smithd79514e2016-02-05 19:03:40 +00003340 (Trait.needDecls() &&
3341 II->hasFETokenInfoChangedSinceDeserialization()))
Chandler Carruth885e78c2015-03-24 21:18:10 +00003342 Generator.insert(II, ID, Trait);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003343 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003344
Douglas Gregore84a9da2009-04-20 20:36:09 +00003345 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003346 SmallString<4096> IdentifierTable;
Douglas Gregora868bbd2009-04-21 22:25:48 +00003347 uint32_t BucketOffset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003348 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003349 using namespace llvm::support;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003350 llvm::raw_svector_ostream Out(IdentifierTable);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003351 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003352 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregora868bbd2009-04-21 22:25:48 +00003353 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003354 }
3355
3356 // Create a blob abbreviation
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003357 auto *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003358 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
Douglas Gregora868bbd2009-04-21 22:25:48 +00003359 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregore84a9da2009-04-20 20:36:09 +00003360 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Douglas Gregor8f45df52009-04-16 22:23:12 +00003361 unsigned IDTableAbbrev = Stream.EmitAbbrev(Abbrev);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003362
3363 // Write the identifier table
Mehdi Amini57a41912015-09-10 01:46:39 +00003364 RecordData::value_type Record[] = {IDENTIFIER_TABLE, BucketOffset};
Yaron Keren92e1b622015-03-18 10:17:07 +00003365 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003366 }
3367
3368 // Write the offsets table for identifier IDs.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003369 auto *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003370 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
Douglas Gregor0e149972009-04-25 19:10:14 +00003371 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
Douglas Gregor1ab036c2011-08-03 21:49:18 +00003372 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor0e149972009-04-25 19:10:14 +00003373 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3374 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
3375
Douglas Gregor8d7edce2013-02-08 21:30:59 +00003376#ifndef NDEBUG
3377 for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I)
3378 assert(IdentifierOffsets[I] && "Missing identifier offset?");
3379#endif
Mehdi Amini57a41912015-09-10 01:46:39 +00003380
3381 RecordData::value_type Record[] = {IDENTIFIER_OFFSET,
3382 IdentifierOffsets.size(),
3383 FirstIdentID - NUM_PREDEF_IDENT_IDS};
Douglas Gregor0e149972009-04-25 19:10:14 +00003384 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00003385 bytes(IdentifierOffsets));
Richard Smith33e0f7e2015-07-22 02:08:40 +00003386
3387 // In C++, write the list of interesting identifiers (those that are
3388 // defined as macros, poisoned, or similar unusual things).
3389 if (!InterestingIdents.empty())
3390 Stream.EmitRecord(INTERESTING_IDENTIFIERS, InterestingIdents);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003391}
3392
Douglas Gregorc5046832009-04-27 18:38:38 +00003393//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003394// DeclContext's Name Lookup Table Serialization
3395//===----------------------------------------------------------------------===//
3396
3397namespace {
3398// Trait used for the on-disk hash table used in the method pool.
3399class ASTDeclContextNameLookupTrait {
3400 ASTWriter &Writer;
Richard Smithd88a7f12015-09-01 20:35:42 +00003401 llvm::SmallVector<DeclID, 64> DeclIDs;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003402
3403public:
Richard Smitha06c7e62015-08-26 23:55:49 +00003404 typedef DeclarationNameKey key_type;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003405 typedef key_type key_type_ref;
3406
Richard Smithd88a7f12015-09-01 20:35:42 +00003407 /// A start and end index into DeclIDs, representing a sequence of decls.
3408 typedef std::pair<unsigned, unsigned> data_type;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003409 typedef const data_type& data_type_ref;
3410
Justin Bogner25463f12014-04-18 20:27:24 +00003411 typedef unsigned hash_value_type;
3412 typedef unsigned offset_type;
3413
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003414 explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) { }
3415
Richard Smithd88a7f12015-09-01 20:35:42 +00003416 template<typename Coll>
3417 data_type getData(const Coll &Decls) {
3418 unsigned Start = DeclIDs.size();
3419 for (NamedDecl *D : Decls) {
3420 DeclIDs.push_back(
3421 Writer.GetDeclRef(getDeclForLocalLookup(Writer.getLangOpts(), D)));
3422 }
3423 return std::make_pair(Start, DeclIDs.size());
3424 }
3425
3426 data_type ImportData(const reader::ASTDeclContextNameLookupTrait::data_type &FromReader) {
3427 unsigned Start = DeclIDs.size();
3428 for (auto ID : FromReader)
3429 DeclIDs.push_back(ID);
3430 return std::make_pair(Start, DeclIDs.size());
3431 }
3432
3433 static bool EqualKey(key_type_ref a, key_type_ref b) {
3434 return a == b;
3435 }
3436
Richard Smitha06c7e62015-08-26 23:55:49 +00003437 hash_value_type ComputeHash(DeclarationNameKey Name) {
3438 return Name.getHash();
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003439 }
3440
Richard Smithd88a7f12015-09-01 20:35:42 +00003441 void EmitFileRef(raw_ostream &Out, ModuleFile *F) const {
3442 assert(Writer.hasChain() &&
3443 "have reference to loaded module file but no chain?");
3444
3445 using namespace llvm::support;
3446 endian::Writer<little>(Out)
3447 .write<uint32_t>(Writer.getChain()->getModuleFileID(F));
3448 }
3449
Richard Smitha06c7e62015-08-26 23:55:49 +00003450 std::pair<unsigned, unsigned> EmitKeyDataLength(raw_ostream &Out,
3451 DeclarationNameKey Name,
3452 data_type_ref Lookup) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003453 using namespace llvm::support;
3454 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003455 unsigned KeyLen = 1;
Richard Smitha06c7e62015-08-26 23:55:49 +00003456 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003457 case DeclarationName::Identifier:
3458 case DeclarationName::ObjCZeroArgSelector:
3459 case DeclarationName::ObjCOneArgSelector:
3460 case DeclarationName::ObjCMultiArgSelector:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003461 case DeclarationName::CXXLiteralOperatorName:
3462 KeyLen += 4;
3463 break;
3464 case DeclarationName::CXXOperatorName:
3465 KeyLen += 1;
3466 break;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003467 case DeclarationName::CXXConstructorName:
3468 case DeclarationName::CXXDestructorName:
3469 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003470 case DeclarationName::CXXUsingDirective:
3471 break;
3472 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003473 LE.write<uint16_t>(KeyLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003474
Richard Smithf02662d2015-07-30 03:17:16 +00003475 // 4 bytes for each DeclID.
Richard Smithd88a7f12015-09-01 20:35:42 +00003476 unsigned DataLen = 4 * (Lookup.second - Lookup.first);
3477 assert(uint16_t(DataLen) == DataLen &&
3478 "too many decls for serialized lookup result");
Justin Bognere1c147c2014-03-28 22:03:19 +00003479 LE.write<uint16_t>(DataLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003480
3481 return std::make_pair(KeyLen, DataLen);
3482 }
3483
Richard Smitha06c7e62015-08-26 23:55:49 +00003484 void EmitKey(raw_ostream &Out, DeclarationNameKey Name, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003485 using namespace llvm::support;
3486 endian::Writer<little> LE(Out);
Richard Smitha06c7e62015-08-26 23:55:49 +00003487 LE.write<uint8_t>(Name.getKind());
3488 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003489 case DeclarationName::Identifier:
Richard Smitha06c7e62015-08-26 23:55:49 +00003490 case DeclarationName::CXXLiteralOperatorName:
3491 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getIdentifier()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003492 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003493 case DeclarationName::ObjCZeroArgSelector:
3494 case DeclarationName::ObjCOneArgSelector:
3495 case DeclarationName::ObjCMultiArgSelector:
Richard Smitha06c7e62015-08-26 23:55:49 +00003496 LE.write<uint32_t>(Writer.getSelectorRef(Name.getSelector()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003497 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003498 case DeclarationName::CXXOperatorName:
Richard Smitha06c7e62015-08-26 23:55:49 +00003499 assert(Name.getOperatorKind() < NUM_OVERLOADED_OPERATORS &&
Benjamin Kramer53750b12012-09-19 13:40:40 +00003500 "Invalid operator?");
Richard Smitha06c7e62015-08-26 23:55:49 +00003501 LE.write<uint8_t>(Name.getOperatorKind());
Benjamin Kramer53750b12012-09-19 13:40:40 +00003502 return;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003503 case DeclarationName::CXXConstructorName:
3504 case DeclarationName::CXXDestructorName:
3505 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003506 case DeclarationName::CXXUsingDirective:
Benjamin Kramer53750b12012-09-19 13:40:40 +00003507 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003508 }
Benjamin Kramer53750b12012-09-19 13:40:40 +00003509
3510 llvm_unreachable("Invalid name kind?");
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003511 }
3512
Richard Smitha06c7e62015-08-26 23:55:49 +00003513 void EmitData(raw_ostream &Out, key_type_ref, data_type Lookup,
3514 unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003515 using namespace llvm::support;
3516 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003517 uint64_t Start = Out.tell(); (void)Start;
Richard Smithd88a7f12015-09-01 20:35:42 +00003518 for (unsigned I = Lookup.first, N = Lookup.second; I != N; ++I)
3519 LE.write<uint32_t>(DeclIDs[I]);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003520 assert(Out.tell() - Start == DataLen && "Data length is wrong");
3521 }
3522};
3523} // end anonymous namespace
3524
Chandler Carruthe972c362015-03-26 03:11:40 +00003525bool ASTWriter::isLookupResultExternal(StoredDeclsList &Result,
3526 DeclContext *DC) {
3527 return Result.hasExternalDecls() && DC->NeedToReconcileExternalVisibleStorage;
3528}
3529
3530bool ASTWriter::isLookupResultEntirelyExternal(StoredDeclsList &Result,
3531 DeclContext *DC) {
3532 for (auto *D : Result.getLookupResult())
3533 if (!getDeclForLocalLookup(getLangOpts(), D)->isFromASTFile())
3534 return false;
3535
3536 return true;
3537}
3538
Richard Smithd88a7f12015-09-01 20:35:42 +00003539void
Chandler Carruthe972c362015-03-26 03:11:40 +00003540ASTWriter::GenerateNameLookupTable(const DeclContext *ConstDC,
Richard Smithcd45dbc2014-04-19 03:48:30 +00003541 llvm::SmallVectorImpl<char> &LookupTable) {
Chandler Carruthe972c362015-03-26 03:11:40 +00003542 assert(!ConstDC->HasLazyLocalLexicalLookups &&
3543 !ConstDC->HasLazyExternalLexicalLookups &&
Richard Smith9e2341d2015-03-23 03:25:59 +00003544 "must call buildLookups first");
Richard Smithcd45dbc2014-04-19 03:48:30 +00003545
Chandler Carruthe972c362015-03-26 03:11:40 +00003546 // FIXME: We need to build the lookups table, which is logically const.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003547 auto *DC = const_cast<DeclContext*>(ConstDC);
Chandler Carruthe972c362015-03-26 03:11:40 +00003548 assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
3549
3550 // Create the on-disk hash table representation.
Richard Smithd88a7f12015-09-01 20:35:42 +00003551 MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait,
3552 ASTDeclContextNameLookupTrait> Generator;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003553 ASTDeclContextNameLookupTrait Trait(*this);
3554
Chandler Carruthe972c362015-03-26 03:11:40 +00003555 // The first step is to collect the declaration names which we need to
3556 // serialize into the name lookup table, and to collect them in a stable
3557 // order.
3558 SmallVector<DeclarationName, 16> Names;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003559
Chandler Carruthe972c362015-03-26 03:11:40 +00003560 // We also build up small sets of the constructor and conversion function
3561 // names which are visible.
3562 llvm::SmallSet<DeclarationName, 8> ConstructorNameSet, ConversionNameSet;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003563
Chandler Carruthe972c362015-03-26 03:11:40 +00003564 for (auto &Lookup : *DC->buildLookup()) {
3565 auto &Name = Lookup.first;
3566 auto &Result = Lookup.second;
3567
Douglas Gregor7dd37e52015-11-03 01:20:54 +00003568 // If there are no local declarations in our lookup result, we
3569 // don't need to write an entry for the name at all. If we can't
3570 // write out a lookup set without performing more deserialization,
3571 // just skip this entry.
3572 if (isLookupResultExternal(Result, DC) &&
Chandler Carruthe972c362015-03-26 03:11:40 +00003573 isLookupResultEntirelyExternal(Result, DC))
3574 continue;
3575
3576 // We also skip empty results. If any of the results could be external and
3577 // the currently available results are empty, then all of the results are
3578 // external and we skip it above. So the only way we get here with an empty
3579 // results is when no results could have been external *and* we have
3580 // external results.
3581 //
3582 // FIXME: While we might want to start emitting on-disk entries for negative
3583 // lookups into a decl context as an optimization, today we *have* to skip
3584 // them because there are names with empty lookup results in decl contexts
3585 // which we can't emit in any stable ordering: we lookup constructors and
3586 // conversion functions in the enclosing namespace scope creating empty
3587 // results for them. This in almost certainly a bug in Clang's name lookup,
3588 // but that is likely to be hard or impossible to fix and so we tolerate it
3589 // here by omitting lookups with empty results.
3590 if (Lookup.second.getLookupResult().empty())
3591 continue;
3592
3593 switch (Lookup.first.getNameKind()) {
3594 default:
3595 Names.push_back(Lookup.first);
3596 break;
3597
Richard Smithcd45dbc2014-04-19 03:48:30 +00003598 case DeclarationName::CXXConstructorName:
Chandler Carruthe972c362015-03-26 03:11:40 +00003599 assert(isa<CXXRecordDecl>(DC) &&
3600 "Cannot have a constructor name outside of a class!");
3601 ConstructorNameSet.insert(Name);
3602 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003603
3604 case DeclarationName::CXXConversionFunctionName:
Chandler Carruthe972c362015-03-26 03:11:40 +00003605 assert(isa<CXXRecordDecl>(DC) &&
3606 "Cannot have a conversion function name outside of a class!");
3607 ConversionNameSet.insert(Name);
Rafael Espindolac606b3e2015-03-25 04:43:15 +00003608 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003609 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00003610 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00003611
Chandler Carruthe972c362015-03-26 03:11:40 +00003612 // Sort the names into a stable order.
3613 std::sort(Names.begin(), Names.end());
3614
Chandler Carruthffbf7052015-03-26 22:27:09 +00003615 if (auto *D = dyn_cast<CXXRecordDecl>(DC)) {
Chandler Carruthe972c362015-03-26 03:11:40 +00003616 // We need to establish an ordering of constructor and conversion function
Chandler Carruthffbf7052015-03-26 22:27:09 +00003617 // names, and they don't have an intrinsic ordering.
Chandler Carruthe972c362015-03-26 03:11:40 +00003618
Chandler Carruthffbf7052015-03-26 22:27:09 +00003619 // First we try the easy case by forming the current context's constructor
3620 // name and adding that name first. This is a very useful optimization to
3621 // avoid walking the lexical declarations in many cases, and it also
3622 // handles the only case where a constructor name can come from some other
3623 // lexical context -- when that name is an implicit constructor merged from
3624 // another declaration in the redecl chain. Any non-implicit constructor or
3625 // conversion function which doesn't occur in all the lexical contexts
3626 // would be an ODR violation.
3627 auto ImplicitCtorName = Context->DeclarationNames.getCXXConstructorName(
3628 Context->getCanonicalType(Context->getRecordType(D)));
3629 if (ConstructorNameSet.erase(ImplicitCtorName))
3630 Names.push_back(ImplicitCtorName);
Chandler Carruthe972c362015-03-26 03:11:40 +00003631
Chandler Carruthffbf7052015-03-26 22:27:09 +00003632 // If we still have constructors or conversion functions, we walk all the
3633 // names in the decl and add the constructors and conversion functions
3634 // which are visible in the order they lexically occur within the context.
3635 if (!ConstructorNameSet.empty() || !ConversionNameSet.empty())
3636 for (Decl *ChildD : cast<CXXRecordDecl>(DC)->decls())
3637 if (auto *ChildND = dyn_cast<NamedDecl>(ChildD)) {
3638 auto Name = ChildND->getDeclName();
3639 switch (Name.getNameKind()) {
3640 default:
3641 continue;
3642
3643 case DeclarationName::CXXConstructorName:
3644 if (ConstructorNameSet.erase(Name))
3645 Names.push_back(Name);
3646 break;
3647
3648 case DeclarationName::CXXConversionFunctionName:
3649 if (ConversionNameSet.erase(Name))
3650 Names.push_back(Name);
3651 break;
3652 }
3653
3654 if (ConstructorNameSet.empty() && ConversionNameSet.empty())
3655 break;
Chandler Carruthe972c362015-03-26 03:11:40 +00003656 }
3657
Chandler Carruthe972c362015-03-26 03:11:40 +00003658 assert(ConstructorNameSet.empty() && "Failed to find all of the visible "
3659 "constructors by walking all the "
3660 "lexical members of the context.");
3661 assert(ConversionNameSet.empty() && "Failed to find all of the visible "
3662 "conversion functions by walking all "
3663 "the lexical members of the context.");
Richard Smith961eae52014-03-25 01:14:22 +00003664 }
3665
Chandler Carruthe972c362015-03-26 03:11:40 +00003666 // Next we need to do a lookup with each name into this decl context to fully
3667 // populate any results from external sources. We don't actually use the
3668 // results of these lookups because we only want to use the results after all
3669 // results have been loaded and the pointers into them will be stable.
3670 for (auto &Name : Names)
3671 DC->lookup(Name);
3672
3673 // Now we need to insert the results for each name into the hash table. For
3674 // constructor names and conversion function names, we actually need to merge
3675 // all of the results for them into one list of results each and insert
3676 // those.
3677 SmallVector<NamedDecl *, 8> ConstructorDecls;
3678 SmallVector<NamedDecl *, 8> ConversionDecls;
3679
3680 // Now loop over the names, either inserting them or appending for the two
3681 // special cases.
3682 for (auto &Name : Names) {
3683 DeclContext::lookup_result Result = DC->noload_lookup(Name);
3684
3685 switch (Name.getNameKind()) {
3686 default:
Richard Smithd88a7f12015-09-01 20:35:42 +00003687 Generator.insert(Name, Trait.getData(Result), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00003688 break;
3689
3690 case DeclarationName::CXXConstructorName:
3691 ConstructorDecls.append(Result.begin(), Result.end());
3692 break;
3693
3694 case DeclarationName::CXXConversionFunctionName:
3695 ConversionDecls.append(Result.begin(), Result.end());
3696 break;
3697 }
3698 }
3699
3700 // Handle our two special cases if we ended up having any. We arbitrarily use
3701 // the first declaration's name here because the name itself isn't part of
3702 // the key, only the kind of name is used.
3703 if (!ConstructorDecls.empty())
3704 Generator.insert(ConstructorDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00003705 Trait.getData(ConstructorDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00003706 if (!ConversionDecls.empty())
3707 Generator.insert(ConversionDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00003708 Trait.getData(ConversionDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00003709
Richard Smithd88a7f12015-09-01 20:35:42 +00003710 // Create the on-disk hash table. Also emit the existing imported and
3711 // merged table if there is one.
3712 auto *Lookups = Chain ? Chain->getLoadedLookupTables(DC) : nullptr;
3713 Generator.emit(LookupTable, Trait, Lookups ? &Lookups->Table : nullptr);
Richard Smith961eae52014-03-25 01:14:22 +00003714}
3715
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003716/// \brief Write the block containing all of the declaration IDs
3717/// visible from the given DeclContext.
3718///
3719/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
Sebastian Redla4071b42010-08-24 00:50:09 +00003720/// bitstream, or 0 if no block was written.
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003721uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
3722 DeclContext *DC) {
Richard Smith5fc18a92015-07-12 23:43:21 +00003723 // If we imported a key declaration of this namespace, write the visible
3724 // lookup results as an update record for it rather than including them
3725 // on this declaration. We will only look at key declarations on reload.
3726 if (isa<NamespaceDecl>(DC) && Chain &&
3727 Chain->getKeyDeclaration(cast<Decl>(DC))->isFromASTFile()) {
3728 // Only do this once, for the first local declaration of the namespace.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003729 for (auto *Prev = cast<NamespaceDecl>(DC)->getPreviousDecl(); Prev;
Richard Smith5fc18a92015-07-12 23:43:21 +00003730 Prev = Prev->getPreviousDecl())
3731 if (!Prev->isFromASTFile())
3732 return 0;
3733
3734 // Note that we need to emit an update record for the primary context.
3735 UpdatedDeclContexts.insert(DC->getPrimaryContext());
3736
3737 // Make sure all visible decls are written. They will be recorded later. We
3738 // do this using a side data structure so we can sort the names into
3739 // a deterministic order.
3740 StoredDeclsMap *Map = DC->getPrimaryContext()->buildLookup();
3741 SmallVector<std::pair<DeclarationName, DeclContext::lookup_result>, 16>
3742 LookupResults;
3743 if (Map) {
3744 LookupResults.reserve(Map->size());
3745 for (auto &Entry : *Map)
3746 LookupResults.push_back(
3747 std::make_pair(Entry.first, Entry.second.getLookupResult()));
3748 }
3749
3750 std::sort(LookupResults.begin(), LookupResults.end(), llvm::less_first());
3751 for (auto &NameAndResult : LookupResults) {
3752 DeclarationName Name = NameAndResult.first;
3753 DeclContext::lookup_result Result = NameAndResult.second;
3754 if (Name.getNameKind() == DeclarationName::CXXConstructorName ||
3755 Name.getNameKind() == DeclarationName::CXXConversionFunctionName) {
3756 // We have to work around a name lookup bug here where negative lookup
3757 // results for these names get cached in namespace lookup tables (these
3758 // names should never be looked up in a namespace).
3759 assert(Result.empty() && "Cannot have a constructor or conversion "
3760 "function name in a namespace!");
3761 continue;
3762 }
3763
3764 for (NamedDecl *ND : Result)
3765 if (!ND->isFromASTFile())
3766 GetDeclRef(ND);
3767 }
3768
3769 return 0;
3770 }
3771
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003772 if (DC->getPrimaryContext() != DC)
3773 return 0;
3774
Chandler Carruthe972c362015-03-26 03:11:40 +00003775 // Skip contexts which don't support name lookup.
3776 if (!DC->isLookupContext())
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003777 return 0;
3778
3779 // If not in C++, we perform name lookup for the translation unit via the
3780 // IdentifierInfo chains, don't bother to build a visible-declarations table.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003781 if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003782 return 0;
3783
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003784 // Serialize the contents of the mapping used for lookup. Note that,
3785 // although we have two very different code paths, the serialized
3786 // representation is the same for both cases: a declaration name,
3787 // followed by a size, followed by references to the visible
3788 // declarations that have that name.
3789 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smithf634c902012-03-16 06:12:59 +00003790 StoredDeclsMap *Map = DC->buildLookup();
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003791 if (!Map || Map->empty())
3792 return 0;
3793
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003794 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003795 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00003796 GenerateNameLookupTable(DC, LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003797
3798 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00003799 RecordData::value_type Record[] = {DECL_CONTEXT_VISIBLE};
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003800 Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
Yaron Keren92e1b622015-03-18 10:17:07 +00003801 LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003802 ++NumVisibleDeclContexts;
3803 return Offset;
3804}
3805
Sebastian Redla4071b42010-08-24 00:50:09 +00003806/// \brief Write an UPDATE_VISIBLE block for the given context.
3807///
3808/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
3809/// DeclContext in a dependent AST file. As such, they only exist for the TU
Richard Smithf634c902012-03-16 06:12:59 +00003810/// (in C++), for namespaces, and for classes with forward-declared unscoped
3811/// enumeration members (in C++11).
Sebastian Redla4071b42010-08-24 00:50:09 +00003812void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
Richard Smith961eae52014-03-25 01:14:22 +00003813 StoredDeclsMap *Map = DC->getLookupPtr();
Sebastian Redla4071b42010-08-24 00:50:09 +00003814 if (!Map || Map->empty())
3815 return;
3816
Sebastian Redla4071b42010-08-24 00:50:09 +00003817 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003818 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00003819 GenerateNameLookupTable(DC, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00003820
Richard Smith5fc18a92015-07-12 23:43:21 +00003821 // If we're updating a namespace, select a key declaration as the key for the
3822 // update record; those are the only ones that will be checked on reload.
3823 if (isa<NamespaceDecl>(DC))
3824 DC = cast<DeclContext>(Chain->getKeyDeclaration(cast<Decl>(DC)));
3825
Sebastian Redla4071b42010-08-24 00:50:09 +00003826 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00003827 RecordData::value_type Record[] = {UPDATE_VISIBLE, getDeclID(cast<Decl>(DC))};
Yaron Keren92e1b622015-03-18 10:17:07 +00003828 Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00003829}
3830
Peter Collingbourne5df20e02011-02-15 19:46:30 +00003831/// \brief Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
3832void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003833 RecordData::value_type Record[] = {Opts.fp_contract};
Peter Collingbourne5df20e02011-02-15 19:46:30 +00003834 Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
3835}
3836
3837/// \brief Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
3838void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00003839 if (!SemaRef.Context.getLangOpts().OpenCL)
Peter Collingbourne5df20e02011-02-15 19:46:30 +00003840 return;
3841
3842 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
3843 RecordData Record;
3844#define OPENCLEXT(nm) Record.push_back(Opts.nm);
3845#include "clang/Basic/OpenCLExtensions.def"
3846 Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
3847}
3848
Douglas Gregor404cdde2012-01-27 01:47:08 +00003849void ASTWriter::WriteObjCCategories() {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003850 SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
Douglas Gregor404cdde2012-01-27 01:47:08 +00003851 RecordData Categories;
3852
3853 for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
3854 unsigned Size = 0;
3855 unsigned StartIndex = Categories.size();
3856
3857 ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
3858
3859 // Allocate space for the size.
3860 Categories.push_back(0);
3861
3862 // Add the categories.
Douglas Gregor048fbfa2013-01-16 23:00:23 +00003863 for (ObjCInterfaceDecl::known_categories_iterator
3864 Cat = Class->known_categories_begin(),
3865 CatEnd = Class->known_categories_end();
3866 Cat != CatEnd; ++Cat, ++Size) {
3867 assert(getDeclID(*Cat) != 0 && "Bogus category");
3868 AddDeclRef(*Cat, Categories);
Douglas Gregor404cdde2012-01-27 01:47:08 +00003869 }
3870
3871 // Update the size.
3872 Categories[StartIndex] = Size;
3873
3874 // Record this interface -> category map.
3875 ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex };
3876 CategoriesMap.push_back(CatInfo);
3877 }
3878
3879 // Sort the categories map by the definition ID, since the reader will be
3880 // performing binary searches on this information.
3881 llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end());
3882
3883 // Emit the categories map.
3884 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003885
3886 auto *Abbrev = new BitCodeAbbrev();
Douglas Gregor404cdde2012-01-27 01:47:08 +00003887 Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
3888 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
3889 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3890 unsigned AbbrevID = Stream.EmitAbbrev(Abbrev);
Mehdi Amini57a41912015-09-10 01:46:39 +00003891
3892 RecordData::value_type Record[] = {OBJC_CATEGORIES_MAP, CategoriesMap.size()};
3893 Stream.EmitRecordWithBlob(AbbrevID, Record,
3894 reinterpret_cast<char *>(CategoriesMap.data()),
Douglas Gregor404cdde2012-01-27 01:47:08 +00003895 CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
Mehdi Amini57a41912015-09-10 01:46:39 +00003896
Douglas Gregor404cdde2012-01-27 01:47:08 +00003897 // Emit the category lists.
3898 Stream.EmitRecord(OBJC_CATEGORIES, Categories);
3899}
3900
Richard Smithe40f2ba2013-08-07 21:41:30 +00003901void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
3902 Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap;
3903
3904 if (LPTMap.empty())
3905 return;
3906
3907 RecordData Record;
Chandler Carruth52cee4d2015-03-26 09:08:15 +00003908 for (auto LPTMapEntry : LPTMap) {
3909 const FunctionDecl *FD = LPTMapEntry.first;
3910 LateParsedTemplate *LPT = LPTMapEntry.second;
3911 AddDeclRef(FD, Record);
Richard Smithe40f2ba2013-08-07 21:41:30 +00003912 AddDeclRef(LPT->D, Record);
3913 Record.push_back(LPT->Toks.size());
3914
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003915 for (const auto &Tok : LPT->Toks) {
3916 AddToken(Tok, Record);
Richard Smithe40f2ba2013-08-07 21:41:30 +00003917 }
3918 }
3919 Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record);
3920}
3921
Dario Domizioli13a0a382014-05-23 12:13:25 +00003922/// \brief Write the state of 'pragma clang optimize' at the end of the module.
3923void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
3924 RecordData Record;
3925 SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
3926 AddSourceLocation(PragmaLoc, Record);
3927 Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record);
3928}
3929
Nico Weber779355f2016-03-02 23:22:00 +00003930/// \brief Write the state of 'pragma ms_struct' at the end of the module.
3931void ASTWriter::WriteMSStructPragmaOptions(Sema &SemaRef) {
3932 RecordData Record;
3933 Record.push_back(SemaRef.MSStructPragmaOn ? PMSST_ON : PMSST_OFF);
3934 Stream.EmitRecord(MSSTRUCT_PRAGMA_OPTIONS, Record);
3935}
3936
Nico Weber42932312016-03-03 00:17:35 +00003937/// \brief Write the state of 'pragma pointers_to_members' at the end of the
3938//module.
3939void ASTWriter::WriteMSPointersToMembersPragmaOptions(Sema &SemaRef) {
3940 RecordData Record;
3941 Record.push_back(SemaRef.MSPointerToMemberRepresentationMethod);
3942 AddSourceLocation(SemaRef.ImplicitMSInheritanceAttrLoc, Record);
3943 Stream.EmitRecord(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS, Record);
3944}
3945
Douglas Gregor8f64ca12015-12-08 22:43:32 +00003946void ASTWriter::WriteModuleFileExtension(Sema &SemaRef,
3947 ModuleFileExtensionWriter &Writer) {
Douglas Gregor6623e1f2015-11-03 18:33:07 +00003948 // Enter the extension block.
3949 Stream.EnterSubblock(EXTENSION_BLOCK_ID, 4);
3950
3951 // Emit the metadata record abbreviation.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003952 auto *Abv = new llvm::BitCodeAbbrev();
Douglas Gregor6623e1f2015-11-03 18:33:07 +00003953 Abv->Add(llvm::BitCodeAbbrevOp(EXTENSION_METADATA));
3954 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
3955 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
3956 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
3957 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
3958 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
3959 unsigned Abbrev = Stream.EmitAbbrev(Abv);
3960
3961 // Emit the metadata record.
3962 RecordData Record;
3963 auto Metadata = Writer.getExtension()->getExtensionMetadata();
3964 Record.push_back(EXTENSION_METADATA);
3965 Record.push_back(Metadata.MajorVersion);
3966 Record.push_back(Metadata.MinorVersion);
3967 Record.push_back(Metadata.BlockName.size());
3968 Record.push_back(Metadata.UserInfo.size());
3969 SmallString<64> Buffer;
3970 Buffer += Metadata.BlockName;
3971 Buffer += Metadata.UserInfo;
3972 Stream.EmitRecordWithBlob(Abbrev, Record, Buffer);
3973
3974 // Emit the contents of the extension block.
Douglas Gregor8f64ca12015-12-08 22:43:32 +00003975 Writer.writeExtensionContents(SemaRef, Stream);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00003976
3977 // Exit the extension block.
3978 Stream.ExitBlock();
3979}
3980
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003981//===----------------------------------------------------------------------===//
Douglas Gregorc5046832009-04-27 18:38:38 +00003982// General Serialization Routines
3983//===----------------------------------------------------------------------===//
3984
Richard Smith69c82bf2016-04-01 22:52:03 +00003985/// \brief Emit the list of attributes to the specified record.
Richard Smith290d8012016-04-06 17:06:00 +00003986void ASTRecordWriter::AddAttributes(ArrayRef<const Attr *> Attrs) {
3987 auto &Record = *this;
Argyrios Kyrtzidis9beef8e2010-10-18 19:20:11 +00003988 Record.push_back(Attrs.size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003989 for (const auto *A : Attrs) {
Alexis Huntdcfba7b2010-08-18 23:23:40 +00003990 Record.push_back(A->getKind()); // FIXME: stable encoding, target attrs
Richard Smith290d8012016-04-06 17:06:00 +00003991 Record.AddSourceRange(A->getRange());
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00003992
Alexis Huntdcfba7b2010-08-18 23:23:40 +00003993#include "clang/Serialization/AttrPCHWrite.inc"
Daniel Dunbarfc6507e2010-05-27 02:25:39 +00003994
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00003995 }
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00003996}
3997
John McCallf413f5e2013-05-03 00:10:13 +00003998void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) {
3999 AddSourceLocation(Tok.getLocation(), Record);
4000 Record.push_back(Tok.getLength());
4001
4002 // FIXME: When reading literal tokens, reconstruct the literal pointer
4003 // if it is needed.
4004 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
4005 // FIXME: Should translate token kind to a stable encoding.
4006 Record.push_back(Tok.getKind());
4007 // FIXME: Should translate token flags to a stable encoding.
4008 Record.push_back(Tok.getFlags());
4009}
4010
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004011void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004012 Record.push_back(Str.size());
4013 Record.insert(Record.end(), Str.begin(), Str.end());
4014}
4015
Richard Smith7ed1bc92014-12-05 22:42:13 +00004016bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) {
Richard Smith54cc3c22014-12-11 20:50:24 +00004017 assert(Context && "should have context when outputting path");
Richard Smith7ed1bc92014-12-05 22:42:13 +00004018
Richard Smith54cc3c22014-12-11 20:50:24 +00004019 bool Changed =
4020 cleanPathForOutput(Context->getSourceManager().getFileManager(), Path);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004021
4022 // Remove a prefix to make the path relative, if relevant.
4023 const char *PathBegin = Path.data();
4024 const char *PathPtr =
4025 adjustFilenameForRelocatableAST(PathBegin, BaseDirectory);
4026 if (PathPtr != PathBegin) {
4027 Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin));
4028 Changed = true;
4029 }
4030
4031 return Changed;
4032}
4033
4034void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) {
4035 SmallString<128> FilePath(Path);
4036 PreparePathForOutput(FilePath);
4037 AddString(FilePath, Record);
4038}
4039
Mehdi Amini57a41912015-09-10 01:46:39 +00004040void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataRef Record,
Richard Smith7ed1bc92014-12-05 22:42:13 +00004041 StringRef Path) {
4042 SmallString<128> FilePath(Path);
4043 PreparePathForOutput(FilePath);
4044 Stream.EmitRecordWithBlob(Abbrev, Record, FilePath);
4045}
4046
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004047void ASTWriter::AddVersionTuple(const VersionTuple &Version,
4048 RecordDataImpl &Record) {
4049 Record.push_back(Version.getMajor());
David Blaikie05785d12013-02-20 22:23:23 +00004050 if (Optional<unsigned> Minor = Version.getMinor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004051 Record.push_back(*Minor + 1);
4052 else
4053 Record.push_back(0);
David Blaikie05785d12013-02-20 22:23:23 +00004054 if (Optional<unsigned> Subminor = Version.getSubminor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004055 Record.push_back(*Subminor + 1);
4056 else
4057 Record.push_back(0);
4058}
4059
Douglas Gregore84a9da2009-04-20 20:36:09 +00004060/// \brief Note that the identifier II occurs at the given offset
4061/// within the identifier table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004062void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
Sebastian Redl539c5062010-08-18 23:57:32 +00004063 IdentID ID = IdentifierIDs[II];
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004064 // Only store offsets new to this AST file. Other identifier names are looked
Sebastian Redlff4a2952010-07-23 23:49:55 +00004065 // up earlier in the chain and thus don't need an offset.
4066 if (ID >= FirstIdentID)
4067 IdentifierOffsets[ID - FirstIdentID] = Offset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00004068}
4069
Douglas Gregor95c13f52009-04-25 17:48:32 +00004070/// \brief Note that the selector Sel occurs at the given offset
4071/// within the method pool/selector table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004072void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
Douglas Gregor95c13f52009-04-25 17:48:32 +00004073 unsigned ID = SelectorIDs[Sel];
4074 assert(ID && "Unknown selector");
Sebastian Redld95a56e2010-08-04 18:21:41 +00004075 // Don't record offsets for selectors that are also available in a different
4076 // file.
4077 if (ID < FirstSelectorID)
4078 return;
4079 SelectorOffsets[ID - FirstSelectorID] = Offset;
Douglas Gregor95c13f52009-04-25 17:48:32 +00004080}
4081
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004082ASTWriter::ASTWriter(
4083 llvm::BitstreamWriter &Stream,
4084 ArrayRef<llvm::IntrusiveRefCntPtr<ModuleFileExtension>> Extensions,
4085 bool IncludeTimestamps)
Richard Smith01b2cb42014-07-26 06:37:51 +00004086 : Stream(Stream), Context(nullptr), PP(nullptr), Chain(nullptr),
Richard Smithe75ee0f2015-08-17 07:13:32 +00004087 WritingModule(nullptr), IncludeTimestamps(IncludeTimestamps),
4088 WritingAST(false), DoneWritingDeclsAndTypes(false),
4089 ASTHasCompilerErrors(false), FirstDeclID(NUM_PREDEF_DECL_IDS),
4090 NextDeclID(FirstDeclID), FirstTypeID(NUM_PREDEF_TYPE_IDS),
4091 NextTypeID(FirstTypeID), FirstIdentID(NUM_PREDEF_IDENT_IDS),
4092 NextIdentID(FirstIdentID), FirstMacroID(NUM_PREDEF_MACRO_IDS),
4093 NextMacroID(FirstMacroID), FirstSubmoduleID(NUM_PREDEF_SUBMODULE_IDS),
Richard Smith01b2cb42014-07-26 06:37:51 +00004094 NextSubmoduleID(FirstSubmoduleID),
4095 FirstSelectorID(NUM_PREDEF_SELECTOR_IDS), NextSelectorID(FirstSelectorID),
Richard Smith290d8012016-04-06 17:06:00 +00004096 NumStatements(0), NumMacros(0),
Richard Smith01b2cb42014-07-26 06:37:51 +00004097 NumLexicalDeclContexts(0), NumVisibleDeclContexts(0),
Richard Smithaa165cf2016-04-13 21:57:08 +00004098 NextCXXBaseSpecifiersID(1),
Richard Smithe75ee0f2015-08-17 07:13:32 +00004099 TypeExtQualAbbrev(0), TypeFunctionProtoAbbrev(0), DeclParmVarAbbrev(0),
Richard Smith01b2cb42014-07-26 06:37:51 +00004100 DeclContextLexicalAbbrev(0), DeclContextVisibleLookupAbbrev(0),
Richard Smitha27c26e2014-07-27 04:19:32 +00004101 UpdateVisibleAbbrev(0), DeclRecordAbbrev(0), DeclTypedefAbbrev(0),
Richard Smith01b2cb42014-07-26 06:37:51 +00004102 DeclVarAbbrev(0), DeclFieldAbbrev(0), DeclEnumAbbrev(0),
Richard Smitha27c26e2014-07-27 04:19:32 +00004103 DeclObjCIvarAbbrev(0), DeclCXXMethodAbbrev(0), DeclRefExprAbbrev(0),
4104 CharacterLiteralAbbrev(0), IntegerLiteralAbbrev(0),
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004105 ExprImplicitCastAbbrev(0) {
4106 for (const auto &Ext : Extensions) {
4107 if (auto Writer = Ext->createExtensionWriter(*this))
4108 ModuleFileExtensionWriters.push_back(std::move(Writer));
4109 }
4110}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004111
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004112ASTWriter::~ASTWriter() {
Reid Kleckner588c9372014-02-19 23:44:52 +00004113 llvm::DeleteContainerSeconds(FileDeclIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004114}
4115
Richard Smithb3761912015-02-05 23:08:52 +00004116const LangOptions &ASTWriter::getLangOpts() const {
4117 assert(WritingAST && "can't determine lang opts when not writing AST");
4118 return Context->getLangOpts();
4119}
4120
Richard Smithe75ee0f2015-08-17 07:13:32 +00004121time_t ASTWriter::getTimestampForOutput(const FileEntry *E) const {
4122 return IncludeTimestamps ? E->getModificationTime() : 0;
4123}
4124
Adrian Prantladbd2b12015-09-22 23:26:31 +00004125uint64_t ASTWriter::WriteAST(Sema &SemaRef, const std::string &OutputFile,
4126 Module *WritingModule, StringRef isysroot,
4127 bool hasErrors) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004128 WritingAST = true;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004129
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00004130 ASTHasCompilerErrors = hasErrors;
4131
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004132 // Emit the file header.
Douglas Gregor8f45df52009-04-16 22:23:12 +00004133 Stream.Emit((unsigned)'C', 8);
4134 Stream.Emit((unsigned)'P', 8);
4135 Stream.Emit((unsigned)'C', 8);
4136 Stream.Emit((unsigned)'H', 8);
Mike Stump11289f42009-09-09 15:08:12 +00004137
Chris Lattner28fa4e62009-04-26 22:26:21 +00004138 WriteBlockInfoBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004139
Douglas Gregoreda8e122011-08-09 15:13:55 +00004140 Context = &SemaRef.Context;
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004141 PP = &SemaRef.PP;
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004142 this->WritingModule = WritingModule;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004143 ASTFileSignature Signature =
4144 WriteASTCore(SemaRef, isysroot, OutputFile, WritingModule);
Craig Toppera13603a2014-05-22 05:54:18 +00004145 Context = nullptr;
4146 PP = nullptr;
4147 this->WritingModule = nullptr;
Richard Smith7ed1bc92014-12-05 22:42:13 +00004148 this->BaseDirectory.clear();
Craig Toppera13603a2014-05-22 05:54:18 +00004149
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004150 WritingAST = false;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004151 return Signature;
Sebastian Redl143413f2010-07-12 22:02:52 +00004152}
4153
Douglas Gregora94a1542011-07-27 21:45:57 +00004154template<typename Vector>
4155static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec,
4156 ASTWriter::RecordData &Record) {
Craig Toppera13603a2014-05-22 05:54:18 +00004157 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
4158 I != E; ++I) {
Douglas Gregora94a1542011-07-27 21:45:57 +00004159 Writer.AddDeclRef(*I, Record);
4160 }
4161}
4162
Adrian Prantladbd2b12015-09-22 23:26:31 +00004163uint64_t ASTWriter::WriteASTCore(Sema &SemaRef, StringRef isysroot,
4164 const std::string &OutputFile,
4165 Module *WritingModule) {
Sebastian Redl143413f2010-07-12 22:02:52 +00004166 using namespace llvm;
4167
Craig Toppera13603a2014-05-22 05:54:18 +00004168 bool isModule = WritingModule != nullptr;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004169
Douglas Gregorcf68c582011-12-01 22:20:10 +00004170 // Make sure that the AST reader knows to finalize itself.
4171 if (Chain)
4172 Chain->finalizeForWriting();
4173
Sebastian Redl143413f2010-07-12 22:02:52 +00004174 ASTContext &Context = SemaRef.Context;
4175 Preprocessor &PP = SemaRef.PP;
4176
Douglas Gregordab42432011-08-12 00:15:20 +00004177 // Set up predefined declaration IDs.
Richard Smith5fc18a92015-07-12 23:43:21 +00004178 auto RegisterPredefDecl = [&] (Decl *D, PredefinedDeclIDs ID) {
4179 if (D) {
4180 assert(D->isCanonicalDecl() && "predefined decl is not canonical");
4181 DeclIDs[D] = ID;
Richard Smith5fc18a92015-07-12 23:43:21 +00004182 }
4183 };
4184 RegisterPredefDecl(Context.getTranslationUnitDecl(),
4185 PREDEF_DECL_TRANSLATION_UNIT_ID);
4186 RegisterPredefDecl(Context.ObjCIdDecl, PREDEF_DECL_OBJC_ID_ID);
4187 RegisterPredefDecl(Context.ObjCSelDecl, PREDEF_DECL_OBJC_SEL_ID);
4188 RegisterPredefDecl(Context.ObjCClassDecl, PREDEF_DECL_OBJC_CLASS_ID);
4189 RegisterPredefDecl(Context.ObjCProtocolClassDecl,
4190 PREDEF_DECL_OBJC_PROTOCOL_ID);
4191 RegisterPredefDecl(Context.Int128Decl, PREDEF_DECL_INT_128_ID);
4192 RegisterPredefDecl(Context.UInt128Decl, PREDEF_DECL_UNSIGNED_INT_128_ID);
4193 RegisterPredefDecl(Context.ObjCInstanceTypeDecl,
4194 PREDEF_DECL_OBJC_INSTANCETYPE_ID);
4195 RegisterPredefDecl(Context.BuiltinVaListDecl, PREDEF_DECL_BUILTIN_VA_LIST_ID);
Richard Smith9b88a4c2015-07-27 05:40:23 +00004196 RegisterPredefDecl(Context.VaListTagDecl, PREDEF_DECL_VA_LIST_TAG);
Charles Davisc7d5c942015-09-17 20:55:33 +00004197 RegisterPredefDecl(Context.BuiltinMSVaListDecl,
4198 PREDEF_DECL_BUILTIN_MS_VA_LIST_ID);
Richard Smith5fc18a92015-07-12 23:43:21 +00004199 RegisterPredefDecl(Context.ExternCContext, PREDEF_DECL_EXTERN_C_CONTEXT_ID);
David Majnemerd9b1a4f2015-11-04 03:40:30 +00004200 RegisterPredefDecl(Context.MakeIntegerSeqDecl,
4201 PREDEF_DECL_MAKE_INTEGER_SEQ_ID);
Quentin Colombet043406b2016-02-03 22:41:00 +00004202 RegisterPredefDecl(Context.CFConstantStringTypeDecl,
4203 PREDEF_DECL_CF_CONSTANT_STRING_ID);
Ben Langmuirf5416742016-02-04 00:55:24 +00004204 RegisterPredefDecl(Context.CFConstantStringTagDecl,
4205 PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID);
Meador Inge5d3fb222012-06-16 03:34:49 +00004206
Chris Lattner0c797362009-09-08 18:19:27 +00004207 // Build a record containing all of the tentative definitions in this file, in
Sebastian Redl35351a92010-01-31 22:27:38 +00004208 // TentativeDefinitions order. Generally, this record will be empty for
Chris Lattner0c797362009-09-08 18:19:27 +00004209 // headers.
Douglas Gregord4df8652009-04-22 22:02:47 +00004210 RecordData TentativeDefinitions;
Douglas Gregora94a1542011-07-27 21:45:57 +00004211 AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions);
Douglas Gregoreb08bd42011-07-27 20:58:46 +00004212
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004213 // Build a record containing all of the file scoped decls in this file.
4214 RecordData UnusedFileScopedDecls;
Argyrios Kyrtzidis59852362013-03-14 04:45:00 +00004215 if (!isModule)
4216 AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls,
4217 UnusedFileScopedDecls);
Sebastian Redl08aca90252010-08-05 18:21:25 +00004218
Douglas Gregor851443c2011-08-12 01:39:19 +00004219 // Build a record containing all of the delegating constructors we still need
4220 // to resolve.
Alexis Hunt27a761d2011-05-04 23:29:54 +00004221 RecordData DelegatingCtorDecls;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004222 if (!isModule)
4223 AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004224
Douglas Gregor851443c2011-08-12 01:39:19 +00004225 // Write the set of weak, undeclared identifiers. We always write the
4226 // entire table, since later PCH files in a PCH chain are only interested in
4227 // the results at the end of the chain.
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004228 RecordData WeakUndeclaredIdentifiers;
Chandler Carruthf85d9822015-03-26 08:32:49 +00004229 for (auto &WeakUndeclaredIdentifier : SemaRef.WeakUndeclaredIdentifiers) {
4230 IdentifierInfo *II = WeakUndeclaredIdentifier.first;
4231 WeakInfo &WI = WeakUndeclaredIdentifier.second;
4232 AddIdentifierRef(II, WeakUndeclaredIdentifiers);
4233 AddIdentifierRef(WI.getAlias(), WeakUndeclaredIdentifiers);
4234 AddSourceLocation(WI.getLocation(), WeakUndeclaredIdentifiers);
4235 WeakUndeclaredIdentifiers.push_back(WI.getUsed());
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004236 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004237
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004238 // Build a record containing all of the ext_vector declarations.
4239 RecordData ExtVectorDecls;
Douglas Gregorb7098a32011-07-28 00:39:29 +00004240 AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004241
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004242 // Build a record containing all of the VTable uses information.
4243 RecordData VTableUses;
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004244 if (!SemaRef.VTableUses.empty()) {
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004245 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
4246 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
4247 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
4248 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
4249 }
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004250 }
4251
Nico Weber72889432014-09-06 01:25:55 +00004252 // Build a record containing all of the UnusedLocalTypedefNameCandidates.
4253 RecordData UnusedLocalTypedefNameCandidates;
4254 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
4255 AddDeclRef(TD, UnusedLocalTypedefNameCandidates);
4256
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004257 // Build a record containing all of pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004258 RecordData PendingInstantiations;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004259 for (const auto &I : SemaRef.PendingInstantiations) {
4260 AddDeclRef(I.first, PendingInstantiations);
4261 AddSourceLocation(I.second, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004262 }
4263 assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
4264 "There are local ones at end of translation unit!");
4265
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004266 // Build a record containing some declaration references.
4267 RecordData SemaDeclRefs;
4268 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc) {
4269 AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
4270 AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
4271 }
4272
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004273 RecordData CUDASpecialDeclRefs;
4274 if (Context.getcudaConfigureCallDecl()) {
4275 AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs);
4276 }
4277
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004278 // Build a record containing all of the known namespaces.
4279 RecordData KnownNamespaces;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004280 for (const auto &I : SemaRef.KnownNamespaces) {
4281 if (!I.second)
4282 AddDeclRef(I.first, KnownNamespaces);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004283 }
Douglas Gregor112b9072012-10-18 05:31:06 +00004284
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004285 // Build a record of all used, undefined objects that require definitions.
4286 RecordData UndefinedButUsed;
Nick Lewyckyf0f56162013-01-31 03:23:57 +00004287
4288 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004289 SemaRef.getUndefinedButUsed(Undefined);
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004290 for (const auto &I : Undefined) {
4291 AddDeclRef(I.first, UndefinedButUsed);
4292 AddSourceLocation(I.second, UndefinedButUsed);
Nick Lewycky8334af82013-01-26 00:35:08 +00004293 }
4294
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004295 // Build a record containing all delete-expressions that we would like to
4296 // analyze later in AST.
4297 RecordData DeleteExprsToAnalyze;
4298
4299 for (const auto &DeleteExprsInfo :
4300 SemaRef.getMismatchingDeleteExpressions()) {
4301 AddDeclRef(DeleteExprsInfo.first, DeleteExprsToAnalyze);
4302 DeleteExprsToAnalyze.push_back(DeleteExprsInfo.second.size());
4303 for (const auto &DeleteLoc : DeleteExprsInfo.second) {
4304 AddSourceLocation(DeleteLoc.first, DeleteExprsToAnalyze);
4305 DeleteExprsToAnalyze.push_back(DeleteLoc.second);
4306 }
4307 }
4308
Douglas Gregor112b9072012-10-18 05:31:06 +00004309 // Write the control block
Adrian Prantladbd2b12015-09-22 23:26:31 +00004310 uint64_t Signature = WriteControlBlock(PP, Context, isysroot, OutputFile);
Douglas Gregor112b9072012-10-18 05:31:06 +00004311
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004312 // Write the remaining AST contents.
Sebastian Redl539c5062010-08-18 23:57:32 +00004313 Stream.EnterSubblock(AST_BLOCK_ID, 5);
Douglas Gregor851443c2011-08-12 01:39:19 +00004314
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004315 // This is so that older clang versions, before the introduction
4316 // of the control block, can read and reject the newer PCH format.
Mehdi Amini57a41912015-09-10 01:46:39 +00004317 {
4318 RecordData Record = {VERSION_MAJOR};
4319 Stream.EmitRecord(METADATA_OLD_FORMAT, Record);
4320 }
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004321
Douglas Gregor851443c2011-08-12 01:39:19 +00004322 // Create a lexical update block containing all of the declarations in the
4323 // translation unit that do not come from other AST files.
4324 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
Richard Smith82f8fcd2015-08-06 22:07:25 +00004325 SmallVector<uint32_t, 128> NewGlobalKindDeclPairs;
4326 for (const auto *D : TU->noload_decls()) {
4327 if (!D->isFromASTFile()) {
4328 NewGlobalKindDeclPairs.push_back(D->getKind());
4329 NewGlobalKindDeclPairs.push_back(GetDeclRef(D));
4330 }
Douglas Gregor851443c2011-08-12 01:39:19 +00004331 }
4332
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004333 auto *Abv = new llvm::BitCodeAbbrev();
Douglas Gregor851443c2011-08-12 01:39:19 +00004334 Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
4335 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4336 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(Abv);
Mehdi Amini57a41912015-09-10 01:46:39 +00004337 {
4338 RecordData::value_type Record[] = {TU_UPDATE_LEXICAL};
4339 Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
4340 bytes(NewGlobalKindDeclPairs));
4341 }
4342
Douglas Gregor851443c2011-08-12 01:39:19 +00004343 // And a visible updates block for the translation unit.
4344 Abv = new llvm::BitCodeAbbrev();
4345 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
4346 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
Douglas Gregor851443c2011-08-12 01:39:19 +00004347 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4348 UpdateVisibleAbbrev = Stream.EmitAbbrev(Abv);
4349 WriteDeclContextVisibleUpdate(TU);
Richard Smithf19e1272015-03-07 00:04:49 +00004350
4351 // If we have any extern "C" names, write out a visible update for them.
4352 if (Context.ExternCContext)
4353 WriteDeclContextVisibleUpdate(Context.ExternCContext);
Douglas Gregor851443c2011-08-12 01:39:19 +00004354
4355 // If the translation unit has an anonymous namespace, and we don't already
4356 // have an update block for it, write it as an update block.
Richard Smith6ef42932014-03-20 21:02:00 +00004357 // FIXME: Why do we not do this if there's already an update block?
Douglas Gregor851443c2011-08-12 01:39:19 +00004358 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
4359 ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
Richard Smith6ef42932014-03-20 21:02:00 +00004360 if (Record.empty())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004361 Record.push_back(DeclUpdate(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE, NS));
Douglas Gregor851443c2011-08-12 01:39:19 +00004362 }
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004363
Richard Smith5652c0f2014-03-21 01:48:23 +00004364 // Add update records for all mangling numbers and static local numbers.
4365 // These aren't really update records, but this is a convenient way of
4366 // tagging this rare extra data onto the declarations.
4367 for (const auto &Number : Context.MangleNumbers)
4368 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004369 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_MANGLING_NUMBER,
4370 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004371 for (const auto &Number : Context.StaticLocalNumbers)
4372 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004373 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_STATIC_LOCAL_NUMBER,
4374 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004375
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004376 // Make sure visible decls, added to DeclContexts previously loaded from
4377 // an AST file, are registered for serialization.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004378 for (const auto *I : UpdatingVisibleDecls) {
4379 GetDeclRef(I);
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004380 }
4381
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004382 // Make sure all decls associated with an identifier are registered for
Richard Smith79bf9202015-08-24 03:33:22 +00004383 // serialization, if we're storing decls with identifiers.
4384 if (!WritingModule || !getLangOpts().CPlusPlus) {
4385 llvm::SmallVector<const IdentifierInfo*, 256> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004386 for (const auto &ID : PP.getIdentifierTable()) {
4387 const IdentifierInfo *II = ID.second;
Richard Smith79bf9202015-08-24 03:33:22 +00004388 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
4389 IIs.push_back(II);
4390 }
4391 // Sort the identifiers to visit based on their name.
4392 std::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>());
4393 for (const IdentifierInfo *II : IIs) {
4394 for (IdentifierResolver::iterator D = SemaRef.IdResolver.begin(II),
4395 DEnd = SemaRef.IdResolver.end();
4396 D != DEnd; ++D) {
4397 GetDeclRef(*D);
4398 }
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004399 }
4400 }
4401
Douglas Gregor5204bde2011-08-02 16:26:37 +00004402 // Form the record of special types.
4403 RecordData SpecialTypes;
Douglas Gregor5204bde2011-08-02 16:26:37 +00004404 AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004405 AddTypeRef(Context.getFILEType(), SpecialTypes);
4406 AddTypeRef(Context.getjmp_bufType(), SpecialTypes);
4407 AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes);
4408 AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes);
4409 AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004410 AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes);
Rafael Espindola6cfa82b2011-11-13 21:51:09 +00004411 AddTypeRef(Context.getucontext_tType(), SpecialTypes);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004412
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004413 if (Chain) {
4414 // Write the mapping information describing our module dependencies and how
4415 // each of those modules were mapped into our own offset/ID space, so that
4416 // the reader can build the appropriate mapping to its own offset/ID space.
4417 // The map consists solely of a blob with the following format:
4418 // *(module-name-len:i16 module-name:len*i8
4419 // source-location-offset:i32
4420 // identifier-id:i32
4421 // preprocessed-entity-id:i32
4422 // macro-definition-id:i32
Douglas Gregor253eefe2011-12-01 00:59:36 +00004423 // submodule-id:i32
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004424 // selector-id:i32
4425 // declaration-id:i32
4426 // c++-base-specifiers-id:i32
4427 // type-id:i32)
4428 //
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004429 auto *Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004430 Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
4431 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
4432 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(Abbrev);
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004433 SmallString<2048> Buffer;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004434 {
4435 llvm::raw_svector_ostream Out(Buffer);
Ben Langmuir785180e2014-10-20 16:27:30 +00004436 for (ModuleFile *M : Chain->ModuleMgr) {
Justin Bognere1c147c2014-03-28 22:03:19 +00004437 using namespace llvm::support;
4438 endian::Writer<little> LE(Out);
Ben Langmuir785180e2014-10-20 16:27:30 +00004439 StringRef FileName = M->FileName;
Justin Bognere1c147c2014-03-28 22:03:19 +00004440 LE.write<uint16_t>(FileName.size());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004441 Out.write(FileName.data(), FileName.size());
Ben Langmuirfe971d92014-08-16 04:54:18 +00004442
Ben Langmuir785180e2014-10-20 16:27:30 +00004443 // Note: if a base ID was uint max, it would not be possible to load
4444 // another module after it or have more than one entity inside it.
4445 uint32_t None = std::numeric_limits<uint32_t>::max();
4446
4447 auto writeBaseIDOrNone = [&](uint32_t BaseID, bool ShouldWrite) {
4448 assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
4449 if (ShouldWrite)
4450 LE.write<uint32_t>(BaseID);
4451 else
4452 LE.write<uint32_t>(None);
4453 };
4454
Ben Langmuirfe971d92014-08-16 04:54:18 +00004455 // These values should be unique within a chain, since they will be read
4456 // as keys into ContinuousRangeMaps.
Ben Langmuir785180e2014-10-20 16:27:30 +00004457 writeBaseIDOrNone(M->SLocEntryBaseOffset, M->LocalNumSLocEntries);
4458 writeBaseIDOrNone(M->BaseIdentifierID, M->LocalNumIdentifiers);
4459 writeBaseIDOrNone(M->BaseMacroID, M->LocalNumMacros);
4460 writeBaseIDOrNone(M->BasePreprocessedEntityID,
4461 M->NumPreprocessedEntities);
4462 writeBaseIDOrNone(M->BaseSubmoduleID, M->LocalNumSubmodules);
4463 writeBaseIDOrNone(M->BaseSelectorID, M->LocalNumSelectors);
4464 writeBaseIDOrNone(M->BaseDeclID, M->LocalNumDecls);
4465 writeBaseIDOrNone(M->BaseTypeIndex, M->LocalNumTypes);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004466 }
4467 }
Mehdi Amini57a41912015-09-10 01:46:39 +00004468 RecordData::value_type Record[] = {MODULE_OFFSET_MAP};
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004469 Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
4470 Buffer.data(), Buffer.size());
4471 }
Richard Smithb9eab6d2014-03-20 19:44:17 +00004472
Richard Smithb9eab6d2014-03-20 19:44:17 +00004473 RecordData DeclUpdatesOffsetsRecord;
4474
Richard Smith59442b42014-03-20 20:07:19 +00004475 // Keep writing types, declarations, and declaration update records
4476 // until we've emitted all of them.
Richard Smith01b2cb42014-07-26 06:37:51 +00004477 Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/5);
4478 WriteTypeAbbrevs();
4479 WriteDeclAbbrevs();
Richard Smith59442b42014-03-20 20:07:19 +00004480 do {
4481 WriteDeclUpdatesBlocks(DeclUpdatesOffsetsRecord);
4482 while (!DeclTypesToEmit.empty()) {
4483 DeclOrType DOT = DeclTypesToEmit.front();
4484 DeclTypesToEmit.pop();
4485 if (DOT.isType())
4486 WriteType(DOT.getType());
4487 else
4488 WriteDecl(Context, DOT.getDecl());
4489 }
4490 } while (!DeclUpdates.empty());
Richard Smithb9eab6d2014-03-20 19:44:17 +00004491 Stream.ExitBlock();
4492
Richard Smithb9eab6d2014-03-20 19:44:17 +00004493 DoneWritingDeclsAndTypes = true;
4494
4495 // These things can only be done once we've written out decls and types.
4496 WriteTypeDeclOffsets();
Richard Smith5652c0f2014-03-21 01:48:23 +00004497 if (!DeclUpdatesOffsetsRecord.empty())
4498 Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord);
Richard Smithb9eab6d2014-03-20 19:44:17 +00004499 WriteCXXBaseSpecifiersOffsets();
4500 WriteFileDeclIDsMap();
Richard Smith7ed1bc92014-12-05 22:42:13 +00004501 WriteSourceManagerBlock(Context.getSourceManager(), PP);
Richard Smithb9eab6d2014-03-20 19:44:17 +00004502 WriteComments();
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004503 WritePreprocessor(PP, isModule);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004504 WriteHeaderSearch(PP.getHeaderSearchInfo());
Sebastian Redla19a67f2010-08-03 21:58:15 +00004505 WriteSelectors(SemaRef);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00004506 WriteReferencedSelectorsPool(SemaRef);
Richard Smith9c254182015-07-19 21:41:12 +00004507 WriteLateParsedTemplates(SemaRef);
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004508 WriteIdentifierTable(PP, SemaRef.IdResolver, isModule);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004509 WriteFPPragmaOptions(SemaRef.getFPOptions());
4510 WriteOpenCLExtensions(SemaRef);
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00004511 WritePragmaDiagnosticMappings(Context.getDiagnostics(), isModule);
Douglas Gregor652d82a2009-04-18 05:55:16 +00004512
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004513 // If we're emitting a module, write out the submodule information.
4514 if (WritingModule)
4515 WriteSubmodules(WritingModule);
4516
Douglas Gregor5204bde2011-08-02 16:26:37 +00004517 Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
4518
Douglas Gregord4df8652009-04-22 22:02:47 +00004519 // Write the record containing external, unnamed definitions.
Ben Langmuir332aafe2014-01-31 01:06:56 +00004520 if (!EagerlyDeserializedDecls.empty())
4521 Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls);
Douglas Gregord4df8652009-04-22 22:02:47 +00004522
4523 // Write the record containing tentative definitions.
4524 if (!TentativeDefinitions.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004525 Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
Douglas Gregoracfc76c2009-04-22 22:18:58 +00004526
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004527 // Write the record containing unused file scoped decls.
4528 if (!UnusedFileScopedDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004529 Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004530
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004531 // Write the record containing weak undeclared identifiers.
4532 if (!WeakUndeclaredIdentifiers.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004533 Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004534 WeakUndeclaredIdentifiers);
4535
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004536 // Write the record containing ext_vector type names.
4537 if (!ExtVectorDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004538 Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
Mike Stump11289f42009-09-09 15:08:12 +00004539
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004540 // Write the record containing VTable uses information.
4541 if (!VTableUses.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004542 Stream.EmitRecord(VTABLE_USES, VTableUses);
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004543
Nico Weber72889432014-09-06 01:25:55 +00004544 // Write the record containing potentially unused local typedefs.
4545 if (!UnusedLocalTypedefNameCandidates.empty())
4546 Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
4547 UnusedLocalTypedefNameCandidates);
4548
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004549 // Write the record containing pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004550 if (!PendingInstantiations.empty())
4551 Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004552
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004553 // Write the record containing declaration references of Sema.
4554 if (!SemaDeclRefs.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004555 Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004556
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004557 // Write the record containing CUDA-specific declaration references.
4558 if (!CUDASpecialDeclRefs.empty())
4559 Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004560
4561 // Write the delegating constructors.
4562 if (!DelegatingCtorDecls.empty())
4563 Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004564
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004565 // Write the known namespaces.
4566 if (!KnownNamespaces.empty())
4567 Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
Nick Lewycky8334af82013-01-26 00:35:08 +00004568
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004569 // Write the undefined internal functions and variables, and inline functions.
4570 if (!UndefinedButUsed.empty())
4571 Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed);
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004572
4573 if (!DeleteExprsToAnalyze.empty())
4574 Stream.EmitRecord(DELETE_EXPRS_TO_ANALYZE, DeleteExprsToAnalyze);
4575
Douglas Gregor851443c2011-08-12 01:39:19 +00004576 // Write the visible updates to DeclContexts.
Richard Smithcd45dbc2014-04-19 03:48:30 +00004577 for (auto *DC : UpdatedDeclContexts)
4578 WriteDeclContextVisibleUpdate(DC);
Douglas Gregor851443c2011-08-12 01:39:19 +00004579
Douglas Gregor959bb062011-12-03 01:15:29 +00004580 if (!WritingModule) {
4581 // Write the submodules that were imported, if any.
Aaron Ballman4f45b712014-03-21 15:22:56 +00004582 struct ModuleInfo {
4583 uint64_t ID;
4584 Module *M;
4585 ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
4586 };
Richard Smith56be7542014-03-21 00:33:59 +00004587 llvm::SmallVector<ModuleInfo, 64> Imports;
Aaron Ballmanbbc31212014-03-14 20:59:21 +00004588 for (const auto *I : Context.local_imports()) {
Douglas Gregor959bb062011-12-03 01:15:29 +00004589 assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end());
Aaron Ballman4f45b712014-03-21 15:22:56 +00004590 Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()],
4591 I->getImportedModule()));
Douglas Gregor959bb062011-12-03 01:15:29 +00004592 }
Richard Smith56be7542014-03-21 00:33:59 +00004593
4594 if (!Imports.empty()) {
4595 auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
4596 return A.ID < B.ID;
4597 };
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00004598 auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
4599 return A.ID == B.ID;
4600 };
Richard Smith56be7542014-03-21 00:33:59 +00004601
4602 // Sort and deduplicate module IDs.
4603 std::sort(Imports.begin(), Imports.end(), Cmp);
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00004604 Imports.erase(std::unique(Imports.begin(), Imports.end(), Eq),
Richard Smith56be7542014-03-21 00:33:59 +00004605 Imports.end());
4606
4607 RecordData ImportedModules;
4608 for (const auto &Import : Imports) {
4609 ImportedModules.push_back(Import.ID);
4610 // FIXME: If the module has macros imported then later has declarations
4611 // imported, this location won't be the right one as a location for the
4612 // declaration imports.
Richard Smith10434f32015-05-02 02:08:26 +00004613 AddSourceLocation(PP.getModuleImportLoc(Import.M), ImportedModules);
Richard Smith56be7542014-03-21 00:33:59 +00004614 }
4615
Douglas Gregor959bb062011-12-03 01:15:29 +00004616 Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
4617 }
Douglas Gregor0a839132011-12-03 00:59:55 +00004618 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004619
Douglas Gregor404cdde2012-01-27 01:47:08 +00004620 WriteObjCCategories();
Nico Weber779355f2016-03-02 23:22:00 +00004621 if(!WritingModule) {
Dario Domizioli13a0a382014-05-23 12:13:25 +00004622 WriteOptimizePragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00004623 WriteMSStructPragmaOptions(SemaRef);
Nico Weber42932312016-03-03 00:17:35 +00004624 WriteMSPointersToMembersPragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00004625 }
Richard Smithe40f2ba2013-08-07 21:41:30 +00004626
Douglas Gregor08f01292009-04-17 22:13:46 +00004627 // Some simple statistics
Mehdi Amini57a41912015-09-10 01:46:39 +00004628 RecordData::value_type Record[] = {
4629 NumStatements, NumMacros, NumLexicalDeclContexts, NumVisibleDeclContexts};
Sebastian Redl539c5062010-08-18 23:57:32 +00004630 Stream.EmitRecord(STATISTICS, Record);
Douglas Gregor8f45df52009-04-16 22:23:12 +00004631 Stream.ExitBlock();
Adrian Prantladbd2b12015-09-22 23:26:31 +00004632
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004633 // Write the module file extension blocks.
4634 for (const auto &ExtWriter : ModuleFileExtensionWriters)
Douglas Gregor8f64ca12015-12-08 22:43:32 +00004635 WriteModuleFileExtension(SemaRef, *ExtWriter);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004636
Adrian Prantladbd2b12015-09-22 23:26:31 +00004637 return Signature;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004638}
4639
Richard Smithb9eab6d2014-03-20 19:44:17 +00004640void ASTWriter::WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord) {
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004641 if (DeclUpdates.empty())
4642 return;
4643
Richard Smith59442b42014-03-20 20:07:19 +00004644 DeclUpdateMap LocalUpdates;
4645 LocalUpdates.swap(DeclUpdates);
4646
Richard Smith6ef42932014-03-20 21:02:00 +00004647 for (auto &DeclUpdate : LocalUpdates) {
4648 const Decl *D = DeclUpdate.first;
Argyrios Kyrtzidis3ba70b82010-10-24 17:26:46 +00004649
Richard Smithd28ac5b2014-03-22 23:33:22 +00004650 bool HasUpdatedBody = false;
Richard Smith69c82bf2016-04-01 22:52:03 +00004651 RecordData RecordData;
4652 ASTRecordWriter Record(*this, RecordData);
Richard Smith6ef42932014-03-20 21:02:00 +00004653 for (auto &Update : DeclUpdate.second) {
4654 DeclUpdateKind Kind = (DeclUpdateKind)Update.getKind();
4655
Richard Smith69c82bf2016-04-01 22:52:03 +00004656 // An updated body is emitted last, so that the reader doesn't need
4657 // to skip over the lazy body to reach statements for other records.
4658 if (Kind == UPD_CXX_ADDED_FUNCTION_DEFINITION)
4659 HasUpdatedBody = true;
4660 else
4661 Record.push_back(Kind);
4662
Richard Smith6ef42932014-03-20 21:02:00 +00004663 switch (Kind) {
4664 case UPD_CXX_ADDED_IMPLICIT_MEMBER:
4665 case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION:
4666 case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE:
Richard Smithcd45dbc2014-04-19 03:48:30 +00004667 assert(Update.getDecl() && "no decl to add?");
Richard Smith6ef42932014-03-20 21:02:00 +00004668 Record.push_back(GetDeclRef(Update.getDecl()));
4669 break;
4670
Richard Smith4d235792014-08-07 18:53:08 +00004671 case UPD_CXX_ADDED_FUNCTION_DEFINITION:
Richard Smithd28ac5b2014-03-22 23:33:22 +00004672 break;
4673
Richard Smith4d235792014-08-07 18:53:08 +00004674 case UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER:
Richard Smith69c82bf2016-04-01 22:52:03 +00004675 Record.AddSourceLocation(Update.getLoc());
Richard Smith4d235792014-08-07 18:53:08 +00004676 break;
4677
John McCall32791cc2016-01-06 22:34:54 +00004678 case UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT:
Richard Smith290d8012016-04-06 17:06:00 +00004679 Record.AddStmt(const_cast<Expr *>(
4680 cast<ParmVarDecl>(Update.getDecl())->getDefaultArg()));
John McCall32791cc2016-01-06 22:34:54 +00004681 break;
4682
Richard Smithcd45dbc2014-04-19 03:48:30 +00004683 case UPD_CXX_INSTANTIATED_CLASS_DEFINITION: {
4684 auto *RD = cast<CXXRecordDecl>(D);
Chandler Carruth8a3d24d2015-03-26 04:27:10 +00004685 UpdatedDeclContexts.insert(RD->getPrimaryContext());
Richard Smith69c82bf2016-04-01 22:52:03 +00004686 Record.AddCXXDefinitionData(RD);
Richard Smithf1c23dc2016-04-13 02:12:03 +00004687 // FIXME: Use AddOffset here.
Richard Smithcd45dbc2014-04-19 03:48:30 +00004688 Record.push_back(WriteDeclContextLexicalBlock(
4689 *Context, const_cast<CXXRecordDecl *>(RD)));
4690
4691 // This state is sometimes updated by template instantiation, when we
4692 // switch from the specialization referring to the template declaration
4693 // to it referring to the template definition.
4694 if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
4695 Record.push_back(MSInfo->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00004696 Record.AddSourceLocation(MSInfo->getPointOfInstantiation());
Richard Smithcd45dbc2014-04-19 03:48:30 +00004697 } else {
4698 auto *Spec = cast<ClassTemplateSpecializationDecl>(RD);
4699 Record.push_back(Spec->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00004700 Record.AddSourceLocation(Spec->getPointOfInstantiation());
Richard Smithdf352052014-05-22 20:59:29 +00004701
4702 // The instantiation might have been resolved to a partial
4703 // specialization. If so, record which one.
4704 auto From = Spec->getInstantiatedFrom();
4705 if (auto PartialSpec =
4706 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
4707 Record.push_back(true);
Richard Smith69c82bf2016-04-01 22:52:03 +00004708 Record.AddDeclRef(PartialSpec);
4709 Record.AddTemplateArgumentList(
4710 &Spec->getTemplateInstantiationArgs());
Richard Smithdf352052014-05-22 20:59:29 +00004711 } else {
4712 Record.push_back(false);
4713 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00004714 }
4715 Record.push_back(RD->getTagKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00004716 Record.AddSourceLocation(RD->getLocation());
4717 Record.AddSourceLocation(RD->getLocStart());
4718 Record.AddSourceLocation(RD->getRBraceLoc());
Richard Smithcd45dbc2014-04-19 03:48:30 +00004719
4720 // Instantiation may change attributes; write them all out afresh.
4721 Record.push_back(D->hasAttrs());
Richard Smith69c82bf2016-04-01 22:52:03 +00004722 if (D->hasAttrs())
4723 Record.AddAttributes(D->getAttrs());
Richard Smithcd45dbc2014-04-19 03:48:30 +00004724
4725 // FIXME: Ensure we don't get here for explicit instantiations.
4726 break;
4727 }
4728
Richard Smithf8134002015-03-10 01:41:22 +00004729 case UPD_CXX_RESOLVED_DTOR_DELETE:
Richard Smith69c82bf2016-04-01 22:52:03 +00004730 Record.AddDeclRef(Update.getDecl());
Richard Smithf8134002015-03-10 01:41:22 +00004731 break;
4732
Richard Smith564417a2014-03-20 21:47:22 +00004733 case UPD_CXX_RESOLVED_EXCEPTION_SPEC:
4734 addExceptionSpec(
Richard Smith564417a2014-03-20 21:47:22 +00004735 cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>(),
4736 Record);
4737 break;
4738
Richard Smith6ef42932014-03-20 21:02:00 +00004739 case UPD_CXX_DEDUCED_RETURN_TYPE:
4740 Record.push_back(GetOrCreateTypeID(Update.getType()));
4741 break;
4742
4743 case UPD_DECL_MARKED_USED:
4744 break;
Richard Smith5652c0f2014-03-21 01:48:23 +00004745
4746 case UPD_MANGLING_NUMBER:
4747 case UPD_STATIC_LOCAL_NUMBER:
4748 Record.push_back(Update.getNumber());
4749 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00004750
Alexey Bataev97720002014-11-11 04:05:39 +00004751 case UPD_DECL_MARKED_OPENMP_THREADPRIVATE:
Richard Smith69c82bf2016-04-01 22:52:03 +00004752 Record.AddSourceRange(
4753 D->getAttr<OMPThreadPrivateDeclAttr>()->getRange());
Alexey Bataev97720002014-11-11 04:05:39 +00004754 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00004755
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00004756 case UPD_DECL_MARKED_OPENMP_DECLARETARGET:
4757 Record.AddSourceRange(
4758 D->getAttr<OMPDeclareTargetDeclAttr>()->getRange());
4759 break;
4760
Richard Smith65ebb4a2015-03-26 04:09:53 +00004761 case UPD_DECL_EXPORTED:
Richard Smith4caa4492015-05-15 02:34:32 +00004762 Record.push_back(getSubmoduleID(Update.getModule()));
Richard Smith65ebb4a2015-03-26 04:09:53 +00004763 break;
Alex Denisovfde64952015-06-26 05:28:36 +00004764
4765 case UPD_ADDED_ATTR_TO_RECORD:
Richard Smith69c82bf2016-04-01 22:52:03 +00004766 Record.AddAttributes(llvm::makeArrayRef(Update.getAttr()));
Alex Denisovfde64952015-06-26 05:28:36 +00004767 break;
Richard Smith6ef42932014-03-20 21:02:00 +00004768 }
4769 }
4770
Richard Smithd28ac5b2014-03-22 23:33:22 +00004771 if (HasUpdatedBody) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004772 const auto *Def = cast<FunctionDecl>(D);
Richard Smith4d235792014-08-07 18:53:08 +00004773 Record.push_back(UPD_CXX_ADDED_FUNCTION_DEFINITION);
Richard Smithd28ac5b2014-03-22 23:33:22 +00004774 Record.push_back(Def->isInlined());
Richard Smith69c82bf2016-04-01 22:52:03 +00004775 Record.AddSourceLocation(Def->getInnerLocStart());
Richard Smith290d8012016-04-06 17:06:00 +00004776 Record.AddFunctionDefinition(Def);
Richard Smithd28ac5b2014-03-22 23:33:22 +00004777 }
4778
Richard Smithcd45dbc2014-04-19 03:48:30 +00004779 OffsetsRecord.push_back(GetDeclRef(D));
Richard Smith69c82bf2016-04-01 22:52:03 +00004780 OffsetsRecord.push_back(Record.Emit(DECL_UPDATES));
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004781
Richard Smithc2bb8182015-03-24 06:36:48 +00004782 FlushPendingAfterDecl();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004783 }
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004784}
4785
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004786void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
Richard Smithb22a1d12016-03-27 20:13:24 +00004787 uint32_t Raw = Loc.getRawEncoding();
4788 Record.push_back((Raw << 1) | (Raw >> 31));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004789}
4790
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004791void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00004792 AddSourceLocation(Range.getBegin(), Record);
4793 AddSourceLocation(Range.getEnd(), Record);
4794}
4795
Richard Smithf144b542016-04-08 21:54:32 +00004796void ASTRecordWriter::AddAPInt(const llvm::APInt &Value) {
4797 Record->push_back(Value.getBitWidth());
Benjamin Kramer25f9ea62010-09-06 23:43:28 +00004798 const uint64_t *Words = Value.getRawData();
Richard Smithf144b542016-04-08 21:54:32 +00004799 Record->append(Words, Words + Value.getNumWords());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004800}
4801
Richard Smithf144b542016-04-08 21:54:32 +00004802void ASTRecordWriter::AddAPSInt(const llvm::APSInt &Value) {
4803 Record->push_back(Value.isUnsigned());
4804 AddAPInt(Value);
Douglas Gregor1daeb692009-04-13 18:14:40 +00004805}
4806
Richard Smithf144b542016-04-08 21:54:32 +00004807void ASTRecordWriter::AddAPFloat(const llvm::APFloat &Value) {
4808 AddAPInt(Value.bitcastToAPInt());
Douglas Gregore0a3a512009-04-14 21:55:33 +00004809}
4810
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004811void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004812 Record.push_back(getIdentifierRef(II));
4813}
4814
Sebastian Redl539c5062010-08-18 23:57:32 +00004815IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
Craig Toppera13603a2014-05-22 05:54:18 +00004816 if (!II)
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004817 return 0;
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00004818
Sebastian Redl539c5062010-08-18 23:57:32 +00004819 IdentID &ID = IdentifierIDs[II];
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00004820 if (ID == 0)
Sebastian Redlff4a2952010-07-23 23:49:55 +00004821 ID = NextIdentID++;
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004822 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004823}
4824
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004825MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004826 // Don't emit builtin macros like __LINE__ to the AST file unless they
4827 // have been redefined by the header (in which case they are not
4828 // isBuiltinMacro).
Craig Toppera13603a2014-05-22 05:54:18 +00004829 if (!MI || MI->isBuiltinMacro())
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004830 return 0;
4831
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004832 MacroID &ID = MacroIDs[MI];
4833 if (ID == 0) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004834 ID = NextMacroID++;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004835 MacroInfoToEmitData Info = { Name, MI, ID };
4836 MacroInfosToEmit.push_back(Info);
4837 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004838 return ID;
4839}
4840
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004841MacroID ASTWriter::getMacroID(MacroInfo *MI) {
Craig Toppera13603a2014-05-22 05:54:18 +00004842 if (!MI || MI->isBuiltinMacro())
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004843 return 0;
4844
4845 assert(MacroIDs.find(MI) != MacroIDs.end() && "Macro not emitted!");
4846 return MacroIDs[MI];
4847}
4848
4849uint64_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) {
Richard Smithd7329392015-04-21 21:46:32 +00004850 return IdentMacroDirectivesOffsetMap.lookup(Name);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004851}
4852
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004853void ASTWriter::AddSelectorRef(const Selector SelRef, RecordDataImpl &Record) {
Sebastian Redl834bb972010-08-04 17:20:04 +00004854 Record.push_back(getSelectorRef(SelRef));
4855}
4856
Sebastian Redl539c5062010-08-18 23:57:32 +00004857SelectorID ASTWriter::getSelectorRef(Selector Sel) {
Craig Toppera13603a2014-05-22 05:54:18 +00004858 if (Sel.getAsOpaquePtr() == nullptr) {
Sebastian Redl834bb972010-08-04 17:20:04 +00004859 return 0;
Steve Naroff2ddea052009-04-23 10:39:46 +00004860 }
4861
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004862 SelectorID SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00004863 if (SID == 0 && Chain) {
4864 // This might trigger a ReadSelector callback, which will set the ID for
4865 // this selector.
4866 Chain->LoadSelector(Sel);
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004867 SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00004868 }
Steve Naroff2ddea052009-04-23 10:39:46 +00004869 if (SID == 0) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00004870 SID = NextSelectorID++;
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004871 SelectorIDs[Sel] = SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00004872 }
Sebastian Redl834bb972010-08-04 17:20:04 +00004873 return SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00004874}
4875
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004876void ASTWriter::AddCXXTemporary(const CXXTemporary *Temp, RecordDataImpl &Record) {
Chris Lattnercba86142010-05-10 00:25:06 +00004877 AddDeclRef(Temp->getDestructor(), Record);
4878}
4879
Douglas Gregord4c5ed02010-10-29 22:39:52 +00004880void ASTWriter::AddCXXBaseSpecifiersRef(CXXBaseSpecifier const *Bases,
Richard Smithc2bb8182015-03-24 06:36:48 +00004881 CXXBaseSpecifier const *BasesEnd,
Douglas Gregord4c5ed02010-10-29 22:39:52 +00004882 RecordDataImpl &Record) {
4883 assert(Bases != BasesEnd && "Empty base-specifier sets are not recorded");
4884 CXXBaseSpecifiersToWrite.push_back(
4885 QueuedCXXBaseSpecifiers(NextCXXBaseSpecifiersID,
4886 Bases, BasesEnd));
4887 Record.push_back(NextCXXBaseSpecifiersID++);
4888}
4889
Richard Smith290d8012016-04-06 17:06:00 +00004890void ASTRecordWriter::AddTemplateArgumentLocInfo(
4891 TemplateArgument::ArgKind Kind, const TemplateArgumentLocInfo &Arg) {
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004892 switch (Kind) {
John McCall0ad16662009-10-29 08:12:44 +00004893 case TemplateArgument::Expression:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004894 AddStmt(Arg.getAsExpr());
John McCall0ad16662009-10-29 08:12:44 +00004895 break;
4896 case TemplateArgument::Type:
Richard Smith290d8012016-04-06 17:06:00 +00004897 AddTypeSourceInfo(Arg.getAsTypeSourceInfo());
John McCall0ad16662009-10-29 08:12:44 +00004898 break;
Douglas Gregor9167f8b2009-11-11 01:00:40 +00004899 case TemplateArgument::Template:
Richard Smith290d8012016-04-06 17:06:00 +00004900 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
4901 AddSourceLocation(Arg.getTemplateNameLoc());
Douglas Gregore4ff4b52011-01-05 18:58:31 +00004902 break;
4903 case TemplateArgument::TemplateExpansion:
Richard Smith290d8012016-04-06 17:06:00 +00004904 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
4905 AddSourceLocation(Arg.getTemplateNameLoc());
4906 AddSourceLocation(Arg.getTemplateEllipsisLoc());
Douglas Gregor9167f8b2009-11-11 01:00:40 +00004907 break;
John McCall0ad16662009-10-29 08:12:44 +00004908 case TemplateArgument::Null:
4909 case TemplateArgument::Integral:
4910 case TemplateArgument::Declaration:
Eli Friedmanb826a002012-09-26 02:36:12 +00004911 case TemplateArgument::NullPtr:
John McCall0ad16662009-10-29 08:12:44 +00004912 case TemplateArgument::Pack:
Eli Friedmanb826a002012-09-26 02:36:12 +00004913 // FIXME: Is this right?
John McCall0ad16662009-10-29 08:12:44 +00004914 break;
4915 }
4916}
4917
Richard Smith290d8012016-04-06 17:06:00 +00004918void ASTRecordWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg) {
4919 AddTemplateArgument(Arg.getArgument());
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00004920
4921 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
4922 bool InfoHasSameExpr
4923 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
Richard Smith290d8012016-04-06 17:06:00 +00004924 Record->push_back(InfoHasSameExpr);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00004925 if (InfoHasSameExpr)
4926 return; // Avoid storing the same expr twice.
4927 }
Richard Smith290d8012016-04-06 17:06:00 +00004928 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo());
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004929}
4930
Richard Smith290d8012016-04-06 17:06:00 +00004931void ASTRecordWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo) {
Craig Toppera13603a2014-05-22 05:54:18 +00004932 if (!TInfo) {
Richard Smith290d8012016-04-06 17:06:00 +00004933 AddTypeRef(QualType());
John McCall8f115c62009-10-16 21:56:05 +00004934 return;
4935 }
4936
Richard Smith290d8012016-04-06 17:06:00 +00004937 AddTypeLoc(TInfo->getTypeLoc());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00004938}
4939
Richard Smith290d8012016-04-06 17:06:00 +00004940void ASTRecordWriter::AddTypeLoc(TypeLoc TL) {
4941 AddTypeRef(TL.getType());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00004942
Richard Smith290d8012016-04-06 17:06:00 +00004943 TypeLocWriter TLW(*this);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00004944 for (; !TL.isNull(); TL = TL.getNextTypeLoc())
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004945 TLW.Visit(TL);
John McCall8f115c62009-10-16 21:56:05 +00004946}
4947
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004948void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
Argyrios Kyrtzidis9ab44ea2010-08-20 16:04:14 +00004949 Record.push_back(GetOrCreateTypeID(T));
4950}
4951
Richard Smith2095ffe2015-03-16 20:11:03 +00004952TypeID ASTWriter::GetOrCreateTypeID(QualType T) {
Richard Smith1fa5d642013-05-11 05:45:24 +00004953 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00004954 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
4955 if (T.isNull())
4956 return TypeIdx();
4957 assert(!T.getLocalFastQualifiers());
4958
4959 TypeIdx &Idx = TypeIdxs[T];
4960 if (Idx.getIndex() == 0) {
4961 if (DoneWritingDeclsAndTypes) {
4962 assert(0 && "New type seen after serializing all the types to emit!");
4963 return TypeIdx();
4964 }
4965
4966 // We haven't seen this type before. Assign it a new ID and put it
4967 // into the queue of types to emit.
4968 Idx = TypeIdx(NextTypeID++);
4969 DeclTypesToEmit.push(T);
4970 }
4971 return Idx;
4972 });
Argyrios Kyrtzidis082e4612010-08-20 16:04:20 +00004973}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004974
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00004975TypeID ASTWriter::getTypeID(QualType T) const {
Richard Smith1fa5d642013-05-11 05:45:24 +00004976 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00004977 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
4978 if (T.isNull())
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004979 return TypeIdx();
Richard Smith2095ffe2015-03-16 20:11:03 +00004980 assert(!T.getLocalFastQualifiers());
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004981
Richard Smith2095ffe2015-03-16 20:11:03 +00004982 TypeIdxMap::const_iterator I = TypeIdxs.find(T);
4983 assert(I != TypeIdxs.end() && "Type not emitted!");
4984 return I->second;
4985 });
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004986}
4987
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004988void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00004989 Record.push_back(GetDeclRef(D));
4990}
4991
Sebastian Redl539c5062010-08-18 23:57:32 +00004992DeclID ASTWriter::GetDeclRef(const Decl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004993 assert(WritingAST && "Cannot request a declaration ID before AST writing");
Craig Toppera13603a2014-05-22 05:54:18 +00004994
4995 if (!D) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00004996 return 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004997 }
Douglas Gregorb3163e52012-01-05 22:33:30 +00004998
4999 // If D comes from an AST file, its declaration ID is already known and
5000 // fixed.
5001 if (D->isFromASTFile())
5002 return D->getGlobalID();
5003
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005004 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
Sebastian Redl539c5062010-08-18 23:57:32 +00005005 DeclID &ID = DeclIDs[D];
Mike Stump11289f42009-09-09 15:08:12 +00005006 if (ID == 0) {
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005007 if (DoneWritingDeclsAndTypes) {
5008 assert(0 && "New decl seen after serializing all the decls to emit!");
5009 return 0;
5010 }
5011
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005012 // We haven't seen this declaration before. Give it a new ID and
5013 // enqueue it in the list of declarations to emit.
Sebastian Redlff4a2952010-07-23 23:49:55 +00005014 ID = NextDeclID++;
Douglas Gregor12bfa382009-10-17 00:13:19 +00005015 DeclTypesToEmit.push(const_cast<Decl *>(D));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005016 }
5017
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005018 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005019}
5020
Sebastian Redl539c5062010-08-18 23:57:32 +00005021DeclID ASTWriter::getDeclID(const Decl *D) {
Craig Toppera13603a2014-05-22 05:54:18 +00005022 if (!D)
Douglas Gregore84a9da2009-04-20 20:36:09 +00005023 return 0;
5024
Douglas Gregorb3163e52012-01-05 22:33:30 +00005025 // If D comes from an AST file, its declaration ID is already known and
5026 // fixed.
5027 if (D->isFromASTFile())
5028 return D->getGlobalID();
5029
Douglas Gregore84a9da2009-04-20 20:36:09 +00005030 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
5031 return DeclIDs[D];
5032}
5033
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005034void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005035 assert(ID);
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005036 assert(D);
5037
5038 SourceLocation Loc = D->getLocation();
5039 if (Loc.isInvalid())
5040 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005041
5042 // We only keep track of the file-level declarations of each file.
5043 if (!D->getLexicalDeclContext()->isFileContext())
5044 return;
Argyrios Kyrtzidise1bc99e2012-02-24 19:45:46 +00005045 // FIXME: ParmVarDecls that are part of a function type of a parameter of
5046 // a function/objc method, should not have TU as lexical context.
Argyrios Kyrtzidisffe055a82012-02-24 01:12:38 +00005047 if (isa<ParmVarDecl>(D))
5048 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005049
5050 SourceManager &SM = Context->getSourceManager();
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005051 SourceLocation FileLoc = SM.getFileLoc(Loc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005052 assert(SM.isLocalSourceLocation(FileLoc));
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005053 FileID FID;
5054 unsigned Offset;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00005055 std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005056 if (FID.isInvalid())
5057 return;
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005058 assert(SM.getSLocEntry(FID).isFile());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005059
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005060 DeclIDInFileInfo *&Info = FileDeclIDs[FID];
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005061 if (!Info)
5062 Info = new DeclIDInFileInfo();
5063
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005064 std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005065 LocDeclIDsTy &Decls = Info->DeclIDs;
5066
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005067 if (Decls.empty() || Decls.back().first <= Offset) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005068 Decls.push_back(LocDecl);
5069 return;
5070 }
5071
Benjamin Kramer45025c02013-08-24 13:22:59 +00005072 LocDeclIDsTy::iterator I =
5073 std::upper_bound(Decls.begin(), Decls.end(), LocDecl, llvm::less_first());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005074
5075 Decls.insert(I, LocDecl);
5076}
5077
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005078void ASTWriter::AddDeclarationName(DeclarationName Name, RecordDataImpl &Record) {
Chris Lattner258172e2009-04-27 07:35:58 +00005079 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc.
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005080 Record.push_back(Name.getNameKind());
5081 switch (Name.getNameKind()) {
5082 case DeclarationName::Identifier:
5083 AddIdentifierRef(Name.getAsIdentifierInfo(), Record);
5084 break;
5085
5086 case DeclarationName::ObjCZeroArgSelector:
5087 case DeclarationName::ObjCOneArgSelector:
5088 case DeclarationName::ObjCMultiArgSelector:
Steve Naroff2ddea052009-04-23 10:39:46 +00005089 AddSelectorRef(Name.getObjCSelector(), Record);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005090 break;
5091
5092 case DeclarationName::CXXConstructorName:
5093 case DeclarationName::CXXDestructorName:
5094 case DeclarationName::CXXConversionFunctionName:
5095 AddTypeRef(Name.getCXXNameType(), Record);
5096 break;
5097
5098 case DeclarationName::CXXOperatorName:
5099 Record.push_back(Name.getCXXOverloadedOperator());
5100 break;
5101
Alexis Hunt3d221f22009-11-29 07:34:05 +00005102 case DeclarationName::CXXLiteralOperatorName:
5103 AddIdentifierRef(Name.getCXXLiteralIdentifier(), Record);
5104 break;
5105
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005106 case DeclarationName::CXXUsingDirective:
5107 // No extra data to emit
5108 break;
5109 }
5110}
Chris Lattnerca025db2010-05-07 21:43:38 +00005111
Richard Smithd08aeb62014-08-28 01:33:39 +00005112unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) {
5113 assert(needsAnonymousDeclarationNumber(D) &&
5114 "expected an anonymous declaration");
5115
5116 // Number the anonymous declarations within this context, if we've not
5117 // already done so.
5118 auto It = AnonymousDeclarationNumbers.find(D);
5119 if (It == AnonymousDeclarationNumbers.end()) {
Richard Smith2b560572015-02-07 03:11:11 +00005120 auto *DC = D->getLexicalDeclContext();
5121 numberAnonymousDeclsWithin(DC, [&](const NamedDecl *ND, unsigned Number) {
5122 AnonymousDeclarationNumbers[ND] = Number;
5123 });
Richard Smithd08aeb62014-08-28 01:33:39 +00005124
5125 It = AnonymousDeclarationNumbers.find(D);
5126 assert(It != AnonymousDeclarationNumbers.end() &&
5127 "declaration not found within its lexical context");
5128 }
5129
5130 return It->second;
5131}
5132
Richard Smith290d8012016-04-06 17:06:00 +00005133void ASTRecordWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
5134 DeclarationName Name) {
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005135 switch (Name.getNameKind()) {
5136 case DeclarationName::CXXConstructorName:
5137 case DeclarationName::CXXDestructorName:
5138 case DeclarationName::CXXConversionFunctionName:
Richard Smith290d8012016-04-06 17:06:00 +00005139 AddTypeSourceInfo(DNLoc.NamedType.TInfo);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005140 break;
5141
5142 case DeclarationName::CXXOperatorName:
Richard Smith290d8012016-04-06 17:06:00 +00005143 AddSourceLocation(SourceLocation::getFromRawEncoding(
5144 DNLoc.CXXOperatorName.BeginOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005145 AddSourceLocation(
Richard Smith290d8012016-04-06 17:06:00 +00005146 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005147 break;
5148
5149 case DeclarationName::CXXLiteralOperatorName:
Richard Smith290d8012016-04-06 17:06:00 +00005150 AddSourceLocation(SourceLocation::getFromRawEncoding(
5151 DNLoc.CXXLiteralOperatorName.OpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005152 break;
5153
5154 case DeclarationName::Identifier:
5155 case DeclarationName::ObjCZeroArgSelector:
5156 case DeclarationName::ObjCOneArgSelector:
5157 case DeclarationName::ObjCMultiArgSelector:
5158 case DeclarationName::CXXUsingDirective:
5159 break;
5160 }
5161}
5162
Richard Smith290d8012016-04-06 17:06:00 +00005163void ASTRecordWriter::AddDeclarationNameInfo(
5164 const DeclarationNameInfo &NameInfo) {
5165 AddDeclarationName(NameInfo.getName());
5166 AddSourceLocation(NameInfo.getLoc());
5167 AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName());
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005168}
5169
Richard Smith290d8012016-04-06 17:06:00 +00005170void ASTRecordWriter::AddQualifierInfo(const QualifierInfo &Info) {
5171 AddNestedNameSpecifierLoc(Info.QualifierLoc);
5172 Record->push_back(Info.NumTemplParamLists);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005173 for (unsigned i=0, e=Info.NumTemplParamLists; i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005174 AddTemplateParameterList(Info.TemplParamLists[i]);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005175}
5176
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005177void ASTWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005178 RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005179 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005180 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005181 SmallVector<NestedNameSpecifier *, 8> NestedNames;
Chris Lattnerca025db2010-05-07 21:43:38 +00005182
5183 // Push each of the NNS's onto a stack for serialization in reverse order.
5184 while (NNS) {
5185 NestedNames.push_back(NNS);
5186 NNS = NNS->getPrefix();
5187 }
5188
5189 Record.push_back(NestedNames.size());
5190 while(!NestedNames.empty()) {
5191 NNS = NestedNames.pop_back_val();
5192 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
5193 Record.push_back(Kind);
5194 switch (Kind) {
5195 case NestedNameSpecifier::Identifier:
5196 AddIdentifierRef(NNS->getAsIdentifier(), Record);
5197 break;
5198
5199 case NestedNameSpecifier::Namespace:
5200 AddDeclRef(NNS->getAsNamespace(), Record);
5201 break;
5202
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005203 case NestedNameSpecifier::NamespaceAlias:
5204 AddDeclRef(NNS->getAsNamespaceAlias(), Record);
5205 break;
5206
Chris Lattnerca025db2010-05-07 21:43:38 +00005207 case NestedNameSpecifier::TypeSpec:
5208 case NestedNameSpecifier::TypeSpecWithTemplate:
5209 AddTypeRef(QualType(NNS->getAsType(), 0), Record);
5210 Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5211 break;
5212
5213 case NestedNameSpecifier::Global:
5214 // Don't need to write an associated value.
5215 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005216
5217 case NestedNameSpecifier::Super:
5218 AddDeclRef(NNS->getAsRecordDecl(), Record);
5219 break;
Chris Lattnerca025db2010-05-07 21:43:38 +00005220 }
5221 }
5222}
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005223
Richard Smith290d8012016-04-06 17:06:00 +00005224void ASTRecordWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005225 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005226 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005227 SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005228
5229 // Push each of the nested-name-specifiers's onto a stack for
5230 // serialization in reverse order.
5231 while (NNS) {
5232 NestedNames.push_back(NNS);
5233 NNS = NNS.getPrefix();
5234 }
5235
Richard Smith290d8012016-04-06 17:06:00 +00005236 Record->push_back(NestedNames.size());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005237 while(!NestedNames.empty()) {
5238 NNS = NestedNames.pop_back_val();
5239 NestedNameSpecifier::SpecifierKind Kind
5240 = NNS.getNestedNameSpecifier()->getKind();
Richard Smith290d8012016-04-06 17:06:00 +00005241 Record->push_back(Kind);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005242 switch (Kind) {
5243 case NestedNameSpecifier::Identifier:
Richard Smith290d8012016-04-06 17:06:00 +00005244 AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier());
5245 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005246 break;
5247
5248 case NestedNameSpecifier::Namespace:
Richard Smith290d8012016-04-06 17:06:00 +00005249 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace());
5250 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005251 break;
5252
5253 case NestedNameSpecifier::NamespaceAlias:
Richard Smith290d8012016-04-06 17:06:00 +00005254 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias());
5255 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005256 break;
5257
5258 case NestedNameSpecifier::TypeSpec:
5259 case NestedNameSpecifier::TypeSpecWithTemplate:
Richard Smith290d8012016-04-06 17:06:00 +00005260 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5261 AddTypeLoc(NNS.getTypeLoc());
5262 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005263 break;
5264
5265 case NestedNameSpecifier::Global:
Richard Smith290d8012016-04-06 17:06:00 +00005266 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005267 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005268
5269 case NestedNameSpecifier::Super:
Richard Smith290d8012016-04-06 17:06:00 +00005270 AddDeclRef(NNS.getNestedNameSpecifier()->getAsRecordDecl());
5271 AddSourceRange(NNS.getLocalSourceRange());
Nikola Smiljanic67860242014-09-26 00:28:20 +00005272 break;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005273 }
5274 }
5275}
5276
Richard Smith290d8012016-04-06 17:06:00 +00005277void ASTRecordWriter::AddTemplateName(TemplateName Name) {
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005278 TemplateName::NameKind Kind = Name.getKind();
Richard Smith290d8012016-04-06 17:06:00 +00005279 Record->push_back(Kind);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005280 switch (Kind) {
5281 case TemplateName::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005282 AddDeclRef(Name.getAsTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005283 break;
5284
5285 case TemplateName::OverloadedTemplate: {
5286 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
Richard Smith290d8012016-04-06 17:06:00 +00005287 Record->push_back(OvT->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005288 for (const auto &I : *OvT)
Richard Smith290d8012016-04-06 17:06:00 +00005289 AddDeclRef(I);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005290 break;
5291 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005292
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005293 case TemplateName::QualifiedTemplate: {
5294 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
Richard Smith290d8012016-04-06 17:06:00 +00005295 AddNestedNameSpecifier(QualT->getQualifier());
5296 Record->push_back(QualT->hasTemplateKeyword());
5297 AddDeclRef(QualT->getTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005298 break;
5299 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005300
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005301 case TemplateName::DependentTemplate: {
5302 DependentTemplateName *DepT = Name.getAsDependentTemplateName();
Richard Smith290d8012016-04-06 17:06:00 +00005303 AddNestedNameSpecifier(DepT->getQualifier());
5304 Record->push_back(DepT->isIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005305 if (DepT->isIdentifier())
Richard Smith290d8012016-04-06 17:06:00 +00005306 AddIdentifierRef(DepT->getIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005307 else
Richard Smith290d8012016-04-06 17:06:00 +00005308 Record->push_back(DepT->getOperator());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005309 break;
5310 }
John McCalld9dfe3a2011-06-30 08:33:18 +00005311
5312 case TemplateName::SubstTemplateTemplateParm: {
5313 SubstTemplateTemplateParmStorage *subst
5314 = Name.getAsSubstTemplateTemplateParm();
Richard Smith290d8012016-04-06 17:06:00 +00005315 AddDeclRef(subst->getParameter());
5316 AddTemplateName(subst->getReplacement());
John McCalld9dfe3a2011-06-30 08:33:18 +00005317 break;
5318 }
Douglas Gregor5590be02011-01-15 06:45:20 +00005319
5320 case TemplateName::SubstTemplateTemplateParmPack: {
5321 SubstTemplateTemplateParmPackStorage *SubstPack
5322 = Name.getAsSubstTemplateTemplateParmPack();
Richard Smith290d8012016-04-06 17:06:00 +00005323 AddDeclRef(SubstPack->getParameterPack());
5324 AddTemplateArgument(SubstPack->getArgumentPack());
Douglas Gregor5590be02011-01-15 06:45:20 +00005325 break;
5326 }
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005327 }
5328}
5329
Richard Smith290d8012016-04-06 17:06:00 +00005330void ASTRecordWriter::AddTemplateArgument(const TemplateArgument &Arg) {
5331 Record->push_back(Arg.getKind());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005332 switch (Arg.getKind()) {
5333 case TemplateArgument::Null:
5334 break;
5335 case TemplateArgument::Type:
Richard Smith290d8012016-04-06 17:06:00 +00005336 AddTypeRef(Arg.getAsType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005337 break;
5338 case TemplateArgument::Declaration:
Richard Smith290d8012016-04-06 17:06:00 +00005339 AddDeclRef(Arg.getAsDecl());
5340 AddTypeRef(Arg.getParamTypeForDecl());
Eli Friedmanb826a002012-09-26 02:36:12 +00005341 break;
5342 case TemplateArgument::NullPtr:
Richard Smith290d8012016-04-06 17:06:00 +00005343 AddTypeRef(Arg.getNullPtrType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005344 break;
5345 case TemplateArgument::Integral:
Richard Smith290d8012016-04-06 17:06:00 +00005346 AddAPSInt(Arg.getAsIntegral());
5347 AddTypeRef(Arg.getIntegralType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005348 break;
5349 case TemplateArgument::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005350 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
Douglas Gregore1d60df2011-01-14 23:41:42 +00005351 break;
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005352 case TemplateArgument::TemplateExpansion:
Richard Smith290d8012016-04-06 17:06:00 +00005353 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
David Blaikie05785d12013-02-20 22:23:23 +00005354 if (Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions())
Richard Smith290d8012016-04-06 17:06:00 +00005355 Record->push_back(*NumExpansions + 1);
Douglas Gregore1d60df2011-01-14 23:41:42 +00005356 else
Richard Smith290d8012016-04-06 17:06:00 +00005357 Record->push_back(0);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005358 break;
5359 case TemplateArgument::Expression:
5360 AddStmt(Arg.getAsExpr());
5361 break;
5362 case TemplateArgument::Pack:
Richard Smith290d8012016-04-06 17:06:00 +00005363 Record->push_back(Arg.pack_size());
Aaron Ballman2a89e852014-07-15 21:32:31 +00005364 for (const auto &P : Arg.pack_elements())
Richard Smith290d8012016-04-06 17:06:00 +00005365 AddTemplateArgument(P);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005366 break;
5367 }
5368}
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005369
5370void
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005371ASTWriter::AddTemplateParameterList(const TemplateParameterList *TemplateParams,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005372 RecordDataImpl &Record) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005373 assert(TemplateParams && "No TemplateParams!");
5374 AddSourceLocation(TemplateParams->getTemplateLoc(), Record);
5375 AddSourceLocation(TemplateParams->getLAngleLoc(), Record);
5376 AddSourceLocation(TemplateParams->getRAngleLoc(), Record);
5377 Record.push_back(TemplateParams->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005378 for (const auto &P : *TemplateParams)
5379 AddDeclRef(P, Record);
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005380}
5381
5382/// \brief Emit a template argument list.
Richard Smith290d8012016-04-06 17:06:00 +00005383void ASTRecordWriter::AddTemplateArgumentList(
5384 const TemplateArgumentList *TemplateArgs) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005385 assert(TemplateArgs && "No TemplateArgs!");
Richard Smith290d8012016-04-06 17:06:00 +00005386 Record->push_back(TemplateArgs->size());
Douglas Gregor1ccc8412010-11-07 23:05:16 +00005387 for (int i=0, e = TemplateArgs->size(); i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005388 AddTemplateArgument(TemplateArgs->get(i));
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005389}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005390
Richard Smith290d8012016-04-06 17:06:00 +00005391void ASTRecordWriter::AddASTTemplateArgumentListInfo(
5392 const ASTTemplateArgumentListInfo *ASTTemplArgList) {
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005393 assert(ASTTemplArgList && "No ASTTemplArgList!");
Richard Smith290d8012016-04-06 17:06:00 +00005394 AddSourceLocation(ASTTemplArgList->LAngleLoc);
5395 AddSourceLocation(ASTTemplArgList->RAngleLoc);
5396 Record->push_back(ASTTemplArgList->NumTemplateArgs);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005397 const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
5398 for (int i=0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005399 AddTemplateArgumentLoc(TemplArgs[i]);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005400}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005401
5402void
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00005403ASTWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set, RecordDataImpl &Record) {
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005404 Record.push_back(Set.size());
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00005405 for (ASTUnresolvedSet::const_iterator
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005406 I = Set.begin(), E = Set.end(); I != E; ++I) {
5407 AddDeclRef(I.getDecl(), Record);
5408 Record.push_back(I.getAccess());
5409 }
5410}
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005411
Richard Smith290d8012016-04-06 17:06:00 +00005412// FIXME: Move this out of the main ASTRecordWriter interface.
5413void ASTRecordWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base) {
5414 Record->push_back(Base.isVirtual());
5415 Record->push_back(Base.isBaseOfClass());
5416 Record->push_back(Base.getAccessSpecifierAsWritten());
5417 Record->push_back(Base.getInheritConstructors());
5418 AddTypeSourceInfo(Base.getTypeSourceInfo());
5419 AddSourceRange(Base.getSourceRange());
Douglas Gregor752a5952011-01-03 22:36:02 +00005420 AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
Richard Smith290d8012016-04-06 17:06:00 +00005421 : SourceLocation());
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();
Dmitry Polukhin790b5402016-04-06 10:01:46 +00005429
5430 const CXXBaseSpecifier *B = CXXBaseSpecifiersToWrite[I].Bases,
5431 *BEnd = CXXBaseSpecifiersToWrite[I].BasesEnd;
Richard Smith290d8012016-04-06 17:06:00 +00005432
5433 // Write the base specifier set.
5434 ASTRecordWriter Writer(*this, Record);
5435 Writer.push_back(BEnd - B);
Dmitry Polukhin790b5402016-04-06 10:01:46 +00005436 for (; B != BEnd; ++B)
Richard Smith290d8012016-04-06 17:06:00 +00005437 Writer.AddCXXBaseSpecifier(*B);
5438 uint64_t Offset = Writer.Emit(serialization::DECL_CXX_BASE_SPECIFIERS);
Dmitry Polukhin790b5402016-04-06 10:01:46 +00005439
Richard Smith290d8012016-04-06 17:06:00 +00005440 // Record the offset of this base-specifier set.
5441 //
5442 // FIXME: We don't need an indirect lookup table for these; instead, write
5443 // the base specifier record prior to the decl record and store its offset
5444 // from the decl record rather than its ID.
5445 unsigned Index = CXXBaseSpecifiersToWrite[I].ID - 1;
5446 if (Index == CXXBaseSpecifiersOffsets.size())
5447 CXXBaseSpecifiersOffsets.push_back(Offset);
5448 else {
5449 if (Index > CXXBaseSpecifiersOffsets.size())
5450 CXXBaseSpecifiersOffsets.resize(Index + 1);
5451 CXXBaseSpecifiersOffsets[Index] = Offset;
5452 }
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005453 }
5454
Richard Smithc2bb8182015-03-24 06:36:48 +00005455 assert(N == CXXBaseSpecifiersToWrite.size() &&
5456 "added more base specifiers while writing base specifiers");
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005457 CXXBaseSpecifiersToWrite.clear();
5458}
5459
Richard Smith290d8012016-04-06 17:06:00 +00005460// FIXME: Move this out of the main ASTRecordWriter interface.
Richard Smithaa165cf2016-04-13 21:57:08 +00005461static uint64_t
5462EmitCXXCtorInitializers(ASTWriter &W,
5463 ArrayRef<CXXCtorInitializer *> CtorInits) {
5464 ASTWriter::RecordData Record;
5465 ASTRecordWriter Writer(W, Record);
5466 Writer.push_back(CtorInits.size());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005467
Richard Smithaa165cf2016-04-13 21:57:08 +00005468 for (auto *Init : CtorInits) {
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005469 if (Init->isBaseInitializer()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00005470 Writer.push_back(CTOR_INITIALIZER_BASE);
5471 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
5472 Writer.push_back(Init->isBaseVirtual());
Alexis Hunt37a477f2011-05-04 01:19:08 +00005473 } else if (Init->isDelegatingInitializer()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00005474 Writer.push_back(CTOR_INITIALIZER_DELEGATING);
5475 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
Alexis Hunt37a477f2011-05-04 01:19:08 +00005476 } else if (Init->isMemberInitializer()){
Richard Smithaa165cf2016-04-13 21:57:08 +00005477 Writer.push_back(CTOR_INITIALIZER_MEMBER);
5478 Writer.AddDeclRef(Init->getMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005479 } else {
Richard Smithaa165cf2016-04-13 21:57:08 +00005480 Writer.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER);
5481 Writer.AddDeclRef(Init->getIndirectMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005482 }
Francois Pichetd583da02010-12-04 09:14:42 +00005483
Richard Smithaa165cf2016-04-13 21:57:08 +00005484 Writer.AddSourceLocation(Init->getMemberLocation());
5485 Writer.AddStmt(Init->getInit());
5486 Writer.AddSourceLocation(Init->getLParenLoc());
5487 Writer.AddSourceLocation(Init->getRParenLoc());
5488 Writer.push_back(Init->isWritten());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005489 if (Init->isWritten()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00005490 Writer.push_back(Init->getSourceOrder());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005491 } else {
Richard Smithaa165cf2016-04-13 21:57:08 +00005492 Writer.push_back(Init->getNumArrayIndices());
5493 for (auto *VD : Init->getArrayIndices())
5494 Writer.AddDeclRef(VD);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005495 }
5496 }
Richard Smithaa165cf2016-04-13 21:57:08 +00005497
5498 return Writer.Emit(serialization::DECL_CXX_CTOR_INITIALIZERS);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005499}
5500
Richard Smithaa165cf2016-04-13 21:57:08 +00005501// FIXME: Move this out of the main ASTRecordWriter interface.
5502void ASTRecordWriter::AddCXXCtorInitializers(
5503 ArrayRef<CXXCtorInitializer *> CtorInits) {
5504 AddOffset(EmitCXXCtorInitializers(*Writer, CtorInits));
Richard Smithc2bb8182015-03-24 06:36:48 +00005505}
5506
Richard Smith290d8012016-04-06 17:06:00 +00005507void ASTRecordWriter::AddCXXDefinitionData(const CXXRecordDecl *D) {
Richard Smith053f6c62014-05-16 23:01:30 +00005508 auto &Data = D->data();
Richard Smith290d8012016-04-06 17:06:00 +00005509 Record->push_back(Data.IsLambda);
5510 Record->push_back(Data.UserDeclaredConstructor);
5511 Record->push_back(Data.UserDeclaredSpecialMembers);
5512 Record->push_back(Data.Aggregate);
5513 Record->push_back(Data.PlainOldData);
5514 Record->push_back(Data.Empty);
5515 Record->push_back(Data.Polymorphic);
5516 Record->push_back(Data.Abstract);
5517 Record->push_back(Data.IsStandardLayout);
5518 Record->push_back(Data.HasNoNonEmptyBases);
5519 Record->push_back(Data.HasPrivateFields);
5520 Record->push_back(Data.HasProtectedFields);
5521 Record->push_back(Data.HasPublicFields);
5522 Record->push_back(Data.HasMutableFields);
5523 Record->push_back(Data.HasVariantMembers);
5524 Record->push_back(Data.HasOnlyCMembers);
5525 Record->push_back(Data.HasInClassInitializer);
5526 Record->push_back(Data.HasUninitializedReferenceMember);
5527 Record->push_back(Data.HasUninitializedFields);
5528 Record->push_back(Data.NeedOverloadResolutionForMoveConstructor);
5529 Record->push_back(Data.NeedOverloadResolutionForMoveAssignment);
5530 Record->push_back(Data.NeedOverloadResolutionForDestructor);
5531 Record->push_back(Data.DefaultedMoveConstructorIsDeleted);
5532 Record->push_back(Data.DefaultedMoveAssignmentIsDeleted);
5533 Record->push_back(Data.DefaultedDestructorIsDeleted);
5534 Record->push_back(Data.HasTrivialSpecialMembers);
5535 Record->push_back(Data.DeclaredNonTrivialSpecialMembers);
5536 Record->push_back(Data.HasIrrelevantDestructor);
5537 Record->push_back(Data.HasConstexprNonCopyMoveConstructor);
5538 Record->push_back(Data.HasDefaultedDefaultConstructor);
5539 Record->push_back(Data.DefaultedDefaultConstructorIsConstexpr);
5540 Record->push_back(Data.HasConstexprDefaultConstructor);
5541 Record->push_back(Data.HasNonLiteralTypeFieldsOrBases);
5542 Record->push_back(Data.ComputedVisibleConversions);
5543 Record->push_back(Data.UserProvidedDefaultConstructor);
5544 Record->push_back(Data.DeclaredSpecialMembers);
5545 Record->push_back(Data.ImplicitCopyConstructorHasConstParam);
5546 Record->push_back(Data.ImplicitCopyAssignmentHasConstParam);
5547 Record->push_back(Data.HasDeclaredCopyConstructorWithConstParam);
5548 Record->push_back(Data.HasDeclaredCopyAssignmentWithConstParam);
Richard Smith561fb152012-02-25 07:33:38 +00005549 // IsLambda bit is already saved.
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005550
Richard Smith290d8012016-04-06 17:06:00 +00005551 Record->push_back(Data.NumBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005552 if (Data.NumBases > 0)
Richard Smith290d8012016-04-06 17:06:00 +00005553 AddCXXBaseSpecifiersRef(Data.getBases(), Data.getBases() + Data.NumBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005554
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005555 // FIXME: Make VBases lazily computed when needed to avoid storing them.
Richard Smith290d8012016-04-06 17:06:00 +00005556 Record->push_back(Data.NumVBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005557 if (Data.NumVBases > 0)
Richard Smith290d8012016-04-06 17:06:00 +00005558 AddCXXBaseSpecifiersRef(Data.getVBases(),
5559 Data.getVBases() + Data.NumVBases);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005560
Richard Smith290d8012016-04-06 17:06:00 +00005561 AddUnresolvedSet(Data.Conversions.get(*Writer->Context));
5562 AddUnresolvedSet(Data.VisibleConversions.get(*Writer->Context));
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005563 // Data.Definition is the owning decl, no need to write it.
Richard Smith290d8012016-04-06 17:06:00 +00005564 AddDeclRef(D->getFirstFriend());
Douglas Gregor99ae8062012-02-14 17:54:36 +00005565
5566 // Add lambda-specific data.
5567 if (Data.IsLambda) {
Richard Smith053f6c62014-05-16 23:01:30 +00005568 auto &Lambda = D->getLambdaData();
Richard Smith290d8012016-04-06 17:06:00 +00005569 Record->push_back(Lambda.Dependent);
5570 Record->push_back(Lambda.IsGenericLambda);
5571 Record->push_back(Lambda.CaptureDefault);
5572 Record->push_back(Lambda.NumCaptures);
5573 Record->push_back(Lambda.NumExplicitCaptures);
5574 Record->push_back(Lambda.ManglingNumber);
5575 AddDeclRef(Lambda.ContextDecl);
5576 AddTypeSourceInfo(Lambda.MethodTyInfo);
Douglas Gregor99ae8062012-02-14 17:54:36 +00005577 for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00005578 const LambdaCapture &Capture = Lambda.Captures[I];
Richard Smith290d8012016-04-06 17:06:00 +00005579 AddSourceLocation(Capture.getLocation());
5580 Record->push_back(Capture.isImplicit());
5581 Record->push_back(Capture.getCaptureKind());
Richard Smithba71c082013-05-16 06:20:58 +00005582 switch (Capture.getCaptureKind()) {
Faisal Validc6b5962016-03-21 09:25:37 +00005583 case LCK_StarThis:
Richard Smithba71c082013-05-16 06:20:58 +00005584 case LCK_This:
Alexey Bataev39c81e22014-08-28 04:28:19 +00005585 case LCK_VLAType:
Richard Smithba71c082013-05-16 06:20:58 +00005586 break;
5587 case LCK_ByCopy:
Richard Smithbb13c9a2013-09-28 04:02:39 +00005588 case LCK_ByRef:
Richard Smithba71c082013-05-16 06:20:58 +00005589 VarDecl *Var =
Craig Toppera13603a2014-05-22 05:54:18 +00005590 Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
Richard Smith290d8012016-04-06 17:06:00 +00005591 AddDeclRef(Var);
Richard Smithba71c082013-05-16 06:20:58 +00005592 AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc()
Richard Smith290d8012016-04-06 17:06:00 +00005593 : SourceLocation());
Richard Smithba71c082013-05-16 06:20:58 +00005594 break;
5595 }
Douglas Gregor99ae8062012-02-14 17:54:36 +00005596 }
5597 }
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005598}
5599
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005600void ASTWriter::ReaderInitialized(ASTReader *Reader) {
Sebastian Redl07a89a82010-07-30 00:29:29 +00005601 assert(Reader && "Cannot remove chain");
Douglas Gregordf0c1512011-08-18 04:12:04 +00005602 assert((!Chain || Chain == Reader) && "Cannot replace chain");
Sebastian Redl07a89a82010-07-30 00:29:29 +00005603 assert(FirstDeclID == NextDeclID &&
5604 FirstTypeID == NextTypeID &&
5605 FirstIdentID == NextIdentID &&
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005606 FirstMacroID == NextMacroID &&
Douglas Gregor253eefe2011-12-01 00:59:36 +00005607 FirstSubmoduleID == NextSubmoduleID &&
Sebastian Redld95a56e2010-08-04 18:21:41 +00005608 FirstSelectorID == NextSelectorID &&
Sebastian Redl07a89a82010-07-30 00:29:29 +00005609 "Setting chain after writing has started.");
Douglas Gregor925296b2011-07-19 16:10:42 +00005610
Sebastian Redl07a89a82010-07-30 00:29:29 +00005611 Chain = Reader;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005612
Richard Smith7f330cd2015-03-18 01:42:29 +00005613 // Note, this will get called multiple times, once one the reader starts up
5614 // and again each time it's done reading a PCH or module.
Douglas Gregordf0c1512011-08-18 04:12:04 +00005615 FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls();
5616 FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes();
5617 FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005618 FirstMacroID = NUM_PREDEF_MACRO_IDS + Chain->getTotalNumMacros();
Douglas Gregor253eefe2011-12-01 00:59:36 +00005619 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
Douglas Gregordf0c1512011-08-18 04:12:04 +00005620 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005621 NextDeclID = FirstDeclID;
5622 NextTypeID = FirstTypeID;
5623 NextIdentID = FirstIdentID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005624 NextMacroID = FirstMacroID;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005625 NextSelectorID = FirstSelectorID;
Douglas Gregor253eefe2011-12-01 00:59:36 +00005626 NextSubmoduleID = FirstSubmoduleID;
Sebastian Redl07a89a82010-07-30 00:29:29 +00005627}
5628
Sebastian Redl539c5062010-08-18 23:57:32 +00005629void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005630 // Always keep the highest ID. See \p TypeRead() for more information.
5631 IdentID &StoredID = IdentifierIDs[II];
5632 if (ID > StoredID)
5633 StoredID = ID;
Sebastian Redlff4a2952010-07-23 23:49:55 +00005634}
5635
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005636void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005637 // Always keep the highest ID. See \p TypeRead() for more information.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005638 MacroID &StoredID = MacroIDs[MI];
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005639 if (ID > StoredID)
5640 StoredID = ID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005641}
5642
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00005643void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005644 // Always take the highest-numbered type index. This copes with an interesting
5645 // case for chained AST writing where we schedule writing the type and then,
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005646 // later, deserialize the type from another AST. In this case, we want to
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005647 // keep the higher-numbered entry so that we can properly write it out to
5648 // the AST file.
5649 TypeIdx &StoredIdx = TypeIdxs[T];
5650 if (Idx.getIndex() >= StoredIdx.getIndex())
5651 StoredIdx = Idx;
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00005652}
5653
Sebastian Redl539c5062010-08-18 23:57:32 +00005654void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005655 // Always keep the highest ID. See \p TypeRead() for more information.
5656 SelectorID &StoredID = SelectorIDs[S];
5657 if (ID > StoredID)
5658 StoredID = ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00005659}
Douglas Gregor91096292010-10-02 19:29:26 +00005660
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00005661void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
Richard Smith66a81862015-05-04 02:25:31 +00005662 MacroDefinitionRecord *MD) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00005663 assert(MacroDefinitions.find(MD) == MacroDefinitions.end());
Douglas Gregor91096292010-10-02 19:29:26 +00005664 MacroDefinitions[MD] = ID;
5665}
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005666
Douglas Gregore37a85a2011-12-02 17:30:13 +00005667void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
5668 assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end());
5669 SubmoduleIDs[Mod] = ID;
5670}
5671
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005672void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
John McCallf937c022011-10-07 06:10:15 +00005673 assert(D->isCompleteDefinition());
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005674 assert(!WritingAST && "Already writing the AST!");
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005675 if (auto *RD = dyn_cast<CXXRecordDecl>(D)) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005676 // We are interested when a PCH decl is modified.
Douglas Gregorb3722e22011-09-09 23:01:35 +00005677 if (RD->isFromASTFile()) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005678 // A forward reference was mutated into a definition. Rewrite it.
5679 // FIXME: This happens during template instantiation, should we
5680 // have created a new definition decl instead ?
Richard Smithcd45dbc2014-04-19 03:48:30 +00005681 assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
5682 "completed a tag from another module but not by instantiation?");
5683 DeclUpdates[RD].push_back(
5684 DeclUpdate(UPD_CXX_INSTANTIATED_CLASS_DEFINITION));
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005685 }
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005686 }
5687}
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005688
Richard Smithf983f7f2015-10-13 00:23:25 +00005689static bool isImportedDeclContext(ASTReader *Chain, const Decl *D) {
5690 if (D->isFromASTFile())
5691 return true;
5692
5693 // If we've not loaded any modules, this can't be imported.
5694 if (!Chain || !Chain->getModuleManager().size())
5695 return false;
5696
5697 // The predefined __va_list_tag struct is imported if we imported any decls.
5698 // FIXME: This is a gross hack.
5699 return D == D->getASTContext().getVaListTagDecl();
5700}
5701
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005702void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
Vassil Vassilev71eafde2016-04-06 20:56:03 +00005703 assert(DC->isLookupContext() &&
5704 "Should not add lookup results to non-lookup contexts!");
5705
Vassil Vassilev632eac32016-03-16 11:17:04 +00005706 // TU is handled elsewhere.
5707 if (isa<TranslationUnitDecl>(DC))
5708 return;
5709
5710 // Namespaces are handled elsewhere, except for template instantiations of
5711 // FunctionTemplateDecls in namespaces. We are interested in cases where the
5712 // local instantiations are added to an imported context. Only happens when
5713 // adding ADL lookup candidates, for example templated friends.
5714 if (isa<NamespaceDecl>(DC) && D->getFriendObjectKind() == Decl::FOK_None &&
5715 !isa<FunctionTemplateDecl>(D))
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005716 return;
5717
Richard Smithf983f7f2015-10-13 00:23:25 +00005718 // We're only interested in cases where a local declaration is added to an
5719 // imported context.
5720 if (D->isFromASTFile() || !isImportedDeclContext(Chain, cast<Decl>(DC)))
5721 return;
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005722
Richard Smith0f4e2c42015-08-06 04:23:48 +00005723 assert(DC == DC->getPrimaryContext() && "added to non-primary context");
Douglas Gregor9f782892013-01-21 15:25:38 +00005724 assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
Richard Smithe9a8bc32014-09-30 00:45:29 +00005725 assert(!WritingAST && "Already writing the AST!");
Richard Smithf983f7f2015-10-13 00:23:25 +00005726 if (UpdatedDeclContexts.insert(DC) && !cast<Decl>(DC)->isFromASTFile()) {
5727 // We're adding a visible declaration to a predefined decl context. Ensure
5728 // that we write out all of its lookup results so we don't get a nasty
5729 // surprise when we try to emit its lookup table.
5730 for (auto *Child : DC->decls())
5731 UpdatingVisibleDecls.push_back(Child);
5732 }
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005733 UpdatingVisibleDecls.push_back(D);
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005734}
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005735
5736void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
5737 assert(D->isImplicit());
Richard Smithf983f7f2015-10-13 00:23:25 +00005738
5739 // We're only interested in cases where a local declaration is added to an
5740 // imported context.
5741 if (D->isFromASTFile() || !isImportedDeclContext(Chain, RD))
5742 return;
5743
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005744 if (!isa<CXXMethodDecl>(D))
Richard Smithf983f7f2015-10-13 00:23:25 +00005745 return;
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005746
5747 // A decl coming from PCH was modified.
John McCallf937c022011-10-07 06:10:15 +00005748 assert(RD->isCompleteDefinition());
Richard Smithe9a8bc32014-09-30 00:45:29 +00005749 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00005750 DeclUpdates[RD].push_back(DeclUpdate(UPD_CXX_ADDED_IMPLICIT_MEMBER, D));
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005751}
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00005752
Richard Smith564417a2014-03-20 21:47:22 +00005753void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
Richard Smith9e2341d2015-03-23 03:25:59 +00005754 assert(!DoneWritingDeclsAndTypes && "Already done writing updates!");
5755 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00005756 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00005757 // If we don't already know the exception specification for this redecl
5758 // chain, add an update record for it.
5759 if (isUnresolvedExceptionSpec(cast<FunctionDecl>(D)
5760 ->getType()
5761 ->castAs<FunctionProtoType>()
5762 ->getExceptionSpecType()))
5763 DeclUpdates[D].push_back(UPD_CXX_RESOLVED_EXCEPTION_SPEC);
5764 });
Richard Smith564417a2014-03-20 21:47:22 +00005765}
5766
Richard Smith1fa5d642013-05-11 05:45:24 +00005767void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
5768 assert(!WritingAST && "Already writing the AST!");
Richard Smith9e2341d2015-03-23 03:25:59 +00005769 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00005770 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00005771 DeclUpdates[D].push_back(
5772 DeclUpdate(UPD_CXX_DEDUCED_RETURN_TYPE, ReturnType));
5773 });
Richard Smith1fa5d642013-05-11 05:45:24 +00005774}
5775
Richard Smithf8134002015-03-10 01:41:22 +00005776void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD,
5777 const FunctionDecl *Delete) {
5778 assert(!WritingAST && "Already writing the AST!");
5779 assert(Delete && "Not given an operator delete");
Richard Smith9e2341d2015-03-23 03:25:59 +00005780 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00005781 Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00005782 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_RESOLVED_DTOR_DELETE, Delete));
5783 });
Richard Smithf8134002015-03-10 01:41:22 +00005784}
5785
Sebastian Redlab238a72011-04-24 16:28:06 +00005786void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005787 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005788 if (!D->isFromASTFile())
Sebastian Redlab238a72011-04-24 16:28:06 +00005789 return; // Declaration not imported from PCH.
5790
Richard Smith4d235792014-08-07 18:53:08 +00005791 // Implicit function decl from a PCH was defined.
5792 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Sebastian Redlab238a72011-04-24 16:28:06 +00005793}
5794
Richard Smithd28ac5b2014-03-22 23:33:22 +00005795void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
5796 assert(!WritingAST && "Already writing the AST!");
5797 if (!D->isFromASTFile())
5798 return;
5799
Richard Smith9e2341d2015-03-23 03:25:59 +00005800 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Richard Smithd28ac5b2014-03-22 23:33:22 +00005801}
5802
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005803void ASTWriter::StaticDataMemberInstantiated(const VarDecl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005804 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005805 if (!D->isFromASTFile())
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005806 return;
5807
5808 // Since the actual instantiation is delayed, this really means that we need
5809 // to update the instantiation location.
Richard Smith6ef42932014-03-20 21:02:00 +00005810 DeclUpdates[D].push_back(
Aaron Ballman4f45b712014-03-21 15:22:56 +00005811 DeclUpdate(UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER,
5812 D->getMemberSpecializationInfo()->getPointOfInstantiation()));
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005813}
5814
John McCall32791cc2016-01-06 22:34:54 +00005815void ASTWriter::DefaultArgumentInstantiated(const ParmVarDecl *D) {
5816 assert(!WritingAST && "Already writing the AST!");
5817 if (!D->isFromASTFile())
5818 return;
5819
5820 DeclUpdates[D].push_back(
5821 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT, D));
5822}
5823
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005824void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
5825 const ObjCInterfaceDecl *IFD) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005826 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005827 if (!IFD->isFromASTFile())
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005828 return; // Declaration not imported from PCH.
Douglas Gregor404cdde2012-01-27 01:47:08 +00005829
5830 assert(IFD->getDefinition() && "Category on a class without a definition?");
5831 ObjCClassesWithCategories.insert(
5832 const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005833}
Argyrios Kyrtzidisb97a4022011-11-12 21:07:46 +00005834
Eli Friedman276dd182013-09-05 00:02:25 +00005835void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
5836 assert(!WritingAST && "Already writing the AST!");
5837 if (!D->isFromASTFile())
5838 return;
5839
Aaron Ballman4f45b712014-03-21 15:22:56 +00005840 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_USED));
Eli Friedman276dd182013-09-05 00:02:25 +00005841}
Alexey Bataev97720002014-11-11 04:05:39 +00005842
5843void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
5844 assert(!WritingAST && "Already writing the AST!");
5845 if (!D->isFromASTFile())
5846 return;
5847
5848 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_THREADPRIVATE));
5849}
Richard Smith65ebb4a2015-03-26 04:09:53 +00005850
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00005851void ASTWriter::DeclarationMarkedOpenMPDeclareTarget(const Decl *D) {
5852 assert(!WritingAST && "Already writing the AST!");
5853 if (!D->isFromASTFile())
5854 return;
5855
5856 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_DECLARETARGET));
5857}
5858
Richard Smith4caa4492015-05-15 02:34:32 +00005859void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) {
Richard Smith65ebb4a2015-03-26 04:09:53 +00005860 assert(!WritingAST && "Already writing the AST!");
5861 assert(D->isHidden() && "expected a hidden declaration");
Richard Smith4caa4492015-05-15 02:34:32 +00005862 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_EXPORTED, M));
Richard Smith65ebb4a2015-03-26 04:09:53 +00005863}
Alex Denisovfde64952015-06-26 05:28:36 +00005864
5865void ASTWriter::AddedAttributeToRecord(const Attr *Attr,
5866 const RecordDecl *Record) {
5867 assert(!WritingAST && "Already writing the AST!");
5868 if (!Record->isFromASTFile())
5869 return;
5870 DeclUpdates[Record].push_back(DeclUpdate(UPD_ADDED_ATTR_TO_RECORD, Attr));
5871}