blob: 8799061d0a1764321aac85b5dd02df698de42b05 [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 Smith5811c402016-04-06 06:26:08 +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 Smith5811c402016-04-06 06:26:08 +000095 public:
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +000096 ASTTypeWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record)
Richard Smith5811c402016-04-06 06:26:08 +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 Smith5811c402016-04-06 06:26:08 +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 Smith5811c402016-04-06 06:26:08 +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 Smith5811c402016-04-06 06:26:08 +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 Smith5811c402016-04-06 06:26:08 +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 Smith5811c402016-04-06 06:26:08 +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 Smith5811c402016-04-06 06:26:08 +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 Smith5811c402016-04-06 06:26:08 +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 Smith5811c402016-04-06 06:26:08 +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 Smith5811c402016-04-06 06:26:08 +0000487 ASTRecordWriter &Record;
John McCall8f115c62009-10-16 21:56:05 +0000488
489public:
Richard Smith5811c402016-04-06 06:26:08 +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 Smith5811c402016-04-06 06:26:08 +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 Smith5811c402016-04-06 06:26:08 +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);
986 RECORD(CXX_CTOR_INITIALIZERS_OFFSETS);
987 RECORD(DELETE_EXPRS_TO_ANALYZE);
Douglas Gregor358cd442012-01-15 16:58:34 +0000988
Chris Lattner28fa4e62009-04-26 22:26:21 +0000989 // SourceManager Block.
Chris Lattner64031982009-04-27 00:40:25 +0000990 BLOCK(SOURCE_MANAGER_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +0000991 RECORD(SM_SLOC_FILE_ENTRY);
992 RECORD(SM_SLOC_BUFFER_ENTRY);
993 RECORD(SM_SLOC_BUFFER_BLOB);
Richard Smithaada85c2016-02-06 02:06:43 +0000994 RECORD(SM_SLOC_BUFFER_BLOB_COMPRESSED);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +0000995 RECORD(SM_SLOC_EXPANSION_ENTRY);
Mike Stump11289f42009-09-09 15:08:12 +0000996
Chris Lattner28fa4e62009-04-26 22:26:21 +0000997 // Preprocessor Block.
Chris Lattner64031982009-04-27 00:40:25 +0000998 BLOCK(PREPROCESSOR_BLOCK);
Richard Smithec216502015-02-13 19:48:37 +0000999 RECORD(PP_MACRO_DIRECTIVE_HISTORY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001000 RECORD(PP_MACRO_FUNCTION_LIKE);
Richard Smithd7329392015-04-21 21:46:32 +00001001 RECORD(PP_MACRO_OBJECT_LIKE);
1002 RECORD(PP_MODULE_MACRO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001003 RECORD(PP_TOKEN);
Richard Smithec216502015-02-13 19:48:37 +00001004
Richard Smithfa715652015-08-31 22:43:10 +00001005 // Submodule Block.
1006 BLOCK(SUBMODULE_BLOCK);
1007 RECORD(SUBMODULE_METADATA);
1008 RECORD(SUBMODULE_DEFINITION);
1009 RECORD(SUBMODULE_UMBRELLA_HEADER);
1010 RECORD(SUBMODULE_HEADER);
1011 RECORD(SUBMODULE_TOPHEADER);
1012 RECORD(SUBMODULE_UMBRELLA_DIR);
1013 RECORD(SUBMODULE_IMPORTS);
1014 RECORD(SUBMODULE_EXPORTS);
1015 RECORD(SUBMODULE_REQUIRES);
1016 RECORD(SUBMODULE_EXCLUDED_HEADER);
1017 RECORD(SUBMODULE_LINK_LIBRARY);
1018 RECORD(SUBMODULE_CONFIG_MACRO);
1019 RECORD(SUBMODULE_CONFLICT);
1020 RECORD(SUBMODULE_PRIVATE_HEADER);
1021 RECORD(SUBMODULE_TEXTUAL_HEADER);
1022 RECORD(SUBMODULE_PRIVATE_TEXTUAL_HEADER);
1023
1024 // Comments Block.
1025 BLOCK(COMMENTS_BLOCK);
1026 RECORD(COMMENTS_RAW_COMMENT);
1027
Douglas Gregor12bfa382009-10-17 00:13:19 +00001028 // Decls and Types block.
1029 BLOCK(DECLTYPES_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001030 RECORD(TYPE_EXT_QUAL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001031 RECORD(TYPE_COMPLEX);
1032 RECORD(TYPE_POINTER);
1033 RECORD(TYPE_BLOCK_POINTER);
1034 RECORD(TYPE_LVALUE_REFERENCE);
1035 RECORD(TYPE_RVALUE_REFERENCE);
1036 RECORD(TYPE_MEMBER_POINTER);
1037 RECORD(TYPE_CONSTANT_ARRAY);
1038 RECORD(TYPE_INCOMPLETE_ARRAY);
1039 RECORD(TYPE_VARIABLE_ARRAY);
1040 RECORD(TYPE_VECTOR);
1041 RECORD(TYPE_EXT_VECTOR);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001042 RECORD(TYPE_FUNCTION_NO_PROTO);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001043 RECORD(TYPE_FUNCTION_PROTO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001044 RECORD(TYPE_TYPEDEF);
1045 RECORD(TYPE_TYPEOF_EXPR);
1046 RECORD(TYPE_TYPEOF);
1047 RECORD(TYPE_RECORD);
1048 RECORD(TYPE_ENUM);
1049 RECORD(TYPE_OBJC_INTERFACE);
Steve Narofffb4330f2009-06-17 22:40:22 +00001050 RECORD(TYPE_OBJC_OBJECT_POINTER);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001051 RECORD(TYPE_DECLTYPE);
1052 RECORD(TYPE_ELABORATED);
1053 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
1054 RECORD(TYPE_UNRESOLVED_USING);
1055 RECORD(TYPE_INJECTED_CLASS_NAME);
1056 RECORD(TYPE_OBJC_OBJECT);
1057 RECORD(TYPE_TEMPLATE_TYPE_PARM);
1058 RECORD(TYPE_TEMPLATE_SPECIALIZATION);
1059 RECORD(TYPE_DEPENDENT_NAME);
1060 RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION);
1061 RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
1062 RECORD(TYPE_PAREN);
1063 RECORD(TYPE_PACK_EXPANSION);
1064 RECORD(TYPE_ATTRIBUTED);
1065 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001066 RECORD(TYPE_AUTO);
1067 RECORD(TYPE_UNARY_TRANSFORM);
Eli Friedman0dfb8892011-10-06 23:00:33 +00001068 RECORD(TYPE_ATOMIC);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001069 RECORD(TYPE_DECAYED);
1070 RECORD(TYPE_ADJUSTED);
Richard Smithd61d4ac2015-08-22 20:13:39 +00001071 RECORD(LOCAL_REDECLARATIONS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001072 RECORD(DECL_TYPEDEF);
Richard Smith01b2cb42014-07-26 06:37:51 +00001073 RECORD(DECL_TYPEALIAS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001074 RECORD(DECL_ENUM);
1075 RECORD(DECL_RECORD);
1076 RECORD(DECL_ENUM_CONSTANT);
1077 RECORD(DECL_FUNCTION);
1078 RECORD(DECL_OBJC_METHOD);
1079 RECORD(DECL_OBJC_INTERFACE);
1080 RECORD(DECL_OBJC_PROTOCOL);
1081 RECORD(DECL_OBJC_IVAR);
1082 RECORD(DECL_OBJC_AT_DEFS_FIELD);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001083 RECORD(DECL_OBJC_CATEGORY);
1084 RECORD(DECL_OBJC_CATEGORY_IMPL);
1085 RECORD(DECL_OBJC_IMPLEMENTATION);
1086 RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
1087 RECORD(DECL_OBJC_PROPERTY);
1088 RECORD(DECL_OBJC_PROPERTY_IMPL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001089 RECORD(DECL_FIELD);
John McCall5e77d762013-04-16 07:28:30 +00001090 RECORD(DECL_MS_PROPERTY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001091 RECORD(DECL_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001092 RECORD(DECL_IMPLICIT_PARAM);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001093 RECORD(DECL_PARM_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001094 RECORD(DECL_FILE_SCOPE_ASM);
1095 RECORD(DECL_BLOCK);
1096 RECORD(DECL_CONTEXT_LEXICAL);
1097 RECORD(DECL_CONTEXT_VISIBLE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001098 RECORD(DECL_NAMESPACE);
1099 RECORD(DECL_NAMESPACE_ALIAS);
1100 RECORD(DECL_USING);
1101 RECORD(DECL_USING_SHADOW);
1102 RECORD(DECL_USING_DIRECTIVE);
1103 RECORD(DECL_UNRESOLVED_USING_VALUE);
1104 RECORD(DECL_UNRESOLVED_USING_TYPENAME);
1105 RECORD(DECL_LINKAGE_SPEC);
1106 RECORD(DECL_CXX_RECORD);
1107 RECORD(DECL_CXX_METHOD);
1108 RECORD(DECL_CXX_CONSTRUCTOR);
1109 RECORD(DECL_CXX_DESTRUCTOR);
1110 RECORD(DECL_CXX_CONVERSION);
1111 RECORD(DECL_ACCESS_SPEC);
1112 RECORD(DECL_FRIEND);
1113 RECORD(DECL_FRIEND_TEMPLATE);
1114 RECORD(DECL_CLASS_TEMPLATE);
1115 RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
1116 RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
Larisse Voufo39a1e502013-08-06 01:03:05 +00001117 RECORD(DECL_VAR_TEMPLATE);
1118 RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION);
1119 RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001120 RECORD(DECL_FUNCTION_TEMPLATE);
1121 RECORD(DECL_TEMPLATE_TYPE_PARM);
1122 RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
1123 RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
1124 RECORD(DECL_STATIC_ASSERT);
1125 RECORD(DECL_CXX_BASE_SPECIFIERS);
1126 RECORD(DECL_INDIRECTFIELD);
1127 RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
1128
Douglas Gregor03412ba2011-06-03 02:27:19 +00001129 // Statements and Exprs can occur in the Decls and Types block.
1130 AddStmtsExprs(Stream, Record);
1131
Douglas Gregor92a96f52011-02-08 21:58:10 +00001132 BLOCK(PREPROCESSOR_DETAIL_BLOCK);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001133 RECORD(PPD_MACRO_EXPANSION);
Douglas Gregor92a96f52011-02-08 21:58:10 +00001134 RECORD(PPD_MACRO_DEFINITION);
1135 RECORD(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00001136
1137 // Decls and Types block.
1138 BLOCK(EXTENSION_BLOCK);
1139 RECORD(EXTENSION_METADATA);
1140
Chris Lattner28fa4e62009-04-26 22:26:21 +00001141#undef RECORD
1142#undef BLOCK
1143 Stream.ExitBlock();
1144}
1145
Richard Smith54cc3c22014-12-11 20:50:24 +00001146/// \brief Prepares a path for being written to an AST file by converting it
1147/// to an absolute path and removing nested './'s.
1148///
1149/// \return \c true if the path was changed.
Benjamin Kramer6a96ae52015-02-06 18:36:04 +00001150static bool cleanPathForOutput(FileManager &FileMgr,
1151 SmallVectorImpl<char> &Path) {
Argyrios Kyrtzidis403cbcb2015-07-31 01:39:23 +00001152 bool Changed = FileMgr.makeAbsolutePath(Path);
Mike Aizatskyaeb9dd92015-11-09 19:12:18 +00001153 return Changed | llvm::sys::path::remove_dots(Path);
Richard Smith54cc3c22014-12-11 20:50:24 +00001154}
1155
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001156/// \brief Adjusts the given filename to only write out the portion of the
1157/// filename that is not part of the system root directory.
Mike Stump11289f42009-09-09 15:08:12 +00001158///
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001159/// \param Filename the file name to adjust.
1160///
Richard Smith7ed1bc92014-12-05 22:42:13 +00001161/// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
1162/// the returned filename will be adjusted by this root directory.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001163///
1164/// \returns either the original filename (if it needs no adjustment) or the
1165/// adjusted filename (which points into the @p Filename parameter).
Mike Stump11289f42009-09-09 15:08:12 +00001166static const char *
Richard Smith7ed1bc92014-12-05 22:42:13 +00001167adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001168 assert(Filename && "No file name to adjust?");
Mike Stump11289f42009-09-09 15:08:12 +00001169
Richard Smith7ed1bc92014-12-05 22:42:13 +00001170 if (BaseDir.empty())
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001171 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001172
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001173 // Verify that the filename and the system root have the same prefix.
1174 unsigned Pos = 0;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001175 for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1176 if (Filename[Pos] != BaseDir[Pos])
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001177 return Filename; // Prefixes don't match.
Mike Stump11289f42009-09-09 15:08:12 +00001178
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001179 // We hit the end of the filename before we hit the end of the system root.
1180 if (!Filename[Pos])
1181 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001182
Richard Smith7ed1bc92014-12-05 22:42:13 +00001183 // If there's not a path separator at the end of the base directory nor
1184 // immediately after it, then this isn't within the base directory.
1185 if (!llvm::sys::path::is_separator(Filename[Pos])) {
1186 if (!llvm::sys::path::is_separator(BaseDir.back()))
1187 return Filename;
1188 } else {
1189 // If the file name has a '/' at the current position, skip over the '/'.
1190 // We distinguish relative paths from absolute paths by the
1191 // absence of '/' at the beginning of relative paths.
1192 //
1193 // FIXME: This is wrong. We distinguish them by asking if the path is
1194 // absolute, which isn't the same thing. And there might be multiple '/'s
1195 // in a row. Use a better mechanism to indicate whether we have emitted an
1196 // absolute or relative path.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001197 ++Pos;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001198 }
Mike Stump11289f42009-09-09 15:08:12 +00001199
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001200 return Filename + Pos;
1201}
Chris Lattner28fa4e62009-04-26 22:26:21 +00001202
Ben Langmuir487ea142014-10-23 18:05:36 +00001203static ASTFileSignature getSignature() {
1204 while (1) {
1205 if (ASTFileSignature S = llvm::sys::Process::GetRandomNumber())
1206 return S;
1207 // Rely on GetRandomNumber to eventually return non-zero...
1208 }
1209}
1210
Douglas Gregor112b9072012-10-18 05:31:06 +00001211/// \brief Write the control block.
Adrian Prantladbd2b12015-09-22 23:26:31 +00001212uint64_t ASTWriter::WriteControlBlock(Preprocessor &PP,
1213 ASTContext &Context,
1214 StringRef isysroot,
1215 const std::string &OutputFile) {
1216 ASTFileSignature Signature = 0;
1217
Douglas Gregorbfbde532009-04-10 21:16:55 +00001218 using namespace llvm;
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001219 Stream.EnterSubblock(CONTROL_BLOCK_ID, 5);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001220 RecordData Record;
1221
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001222 // Metadata
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001223 auto *MetadataAbbrev = new BitCodeAbbrev();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001224 MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA));
1225 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1226 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1227 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1228 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1229 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
Richard Smithe75ee0f2015-08-17 07:13:32 +00001230 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Timestamps
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001231 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1232 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
1233 unsigned MetadataAbbrevCode = Stream.EmitAbbrev(MetadataAbbrev);
Richard Smith7ed1bc92014-12-05 22:42:13 +00001234 assert((!WritingModule || isysroot.empty()) &&
1235 "writing module as a relocatable PCH?");
Mehdi Amini57a41912015-09-10 01:46:39 +00001236 {
1237 RecordData::value_type Record[] = {METADATA, VERSION_MAJOR, VERSION_MINOR,
1238 CLANG_VERSION_MAJOR, CLANG_VERSION_MINOR,
1239 !isysroot.empty(), IncludeTimestamps,
1240 ASTHasCompilerErrors};
1241 Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record,
1242 getClangFullRepositoryVersion());
1243 }
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001244 if (WritingModule) {
Chandler Carruth885e78c2015-03-24 21:18:10 +00001245 // For implicit modules we output a signature that we can use to ensure
1246 // duplicate module builds don't collide in the cache as their output order
1247 // is non-deterministic.
1248 // FIXME: Remove this when output is deterministic.
1249 if (Context.getLangOpts().ImplicitModules) {
Adrian Prantladbd2b12015-09-22 23:26:31 +00001250 Signature = getSignature();
1251 RecordData::value_type Record[] = {Signature};
Chandler Carruth885e78c2015-03-24 21:18:10 +00001252 Stream.EmitRecord(SIGNATURE, Record);
1253 }
1254
Richard Smith7ed1bc92014-12-05 22:42:13 +00001255 // Module name
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001256 auto *Abbrev = new BitCodeAbbrev();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001257 Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME));
1258 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
1259 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
Mehdi Amini57a41912015-09-10 01:46:39 +00001260 RecordData::value_type Record[] = {MODULE_NAME};
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001261 Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name);
1262 }
1263
Richard Smith7ed1bc92014-12-05 22:42:13 +00001264 if (WritingModule && WritingModule->Directory) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001265 SmallString<128> BaseDir(WritingModule->Directory->getName());
Richard Smith54cc3c22014-12-11 20:50:24 +00001266 cleanPathForOutput(Context.getSourceManager().getFileManager(), BaseDir);
Richard Smithf7b41372015-08-13 23:47:44 +00001267
1268 // If the home of the module is the current working directory, then we
1269 // want to pick up the cwd of the build process loading the module, not
1270 // our cwd, when we load this module.
1271 if (!PP.getHeaderSearchInfo()
1272 .getHeaderSearchOpts()
1273 .ModuleMapFileHomeIsCwd ||
1274 WritingModule->Directory->getName() != StringRef(".")) {
1275 // Module directory.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001276 auto *Abbrev = new BitCodeAbbrev();
Richard Smithf7b41372015-08-13 23:47:44 +00001277 Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY));
1278 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
1279 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1280
Mehdi Amini57a41912015-09-10 01:46:39 +00001281 RecordData::value_type Record[] = {MODULE_DIRECTORY};
Richard Smithf7b41372015-08-13 23:47:44 +00001282 Stream.EmitRecordWithBlob(AbbrevCode, Record, BaseDir);
1283 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001284
1285 // Write out all other paths relative to the base directory if possible.
1286 BaseDirectory.assign(BaseDir.begin(), BaseDir.end());
1287 } else if (!isysroot.empty()) {
1288 // Write out paths relative to the sysroot if possible.
1289 BaseDirectory = isysroot;
1290 }
1291
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001292 // Module map file
1293 if (WritingModule) {
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001294 Record.clear();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001295
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001296 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
1297
1298 // Primary module map file.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001299 AddPath(Map.getModuleMapFileForUniquing(WritingModule)->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001300
1301 // Additional module map files.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001302 if (auto *AdditionalModMaps =
1303 Map.getAdditionalModuleMapFiles(WritingModule)) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001304 Record.push_back(AdditionalModMaps->size());
1305 for (const FileEntry *F : *AdditionalModMaps)
Richard Smith7ed1bc92014-12-05 22:42:13 +00001306 AddPath(F->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001307 } else {
1308 Record.push_back(0);
1309 }
1310
1311 Stream.EmitRecord(MODULE_MAP_FILE, Record);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001312 }
1313
Douglas Gregor112b9072012-10-18 05:31:06 +00001314 // Imports
Douglas Gregor29cc6422011-08-17 21:07:30 +00001315 if (Chain) {
Douglas Gregor29cc6422011-08-17 21:07:30 +00001316 serialization::ModuleManager &Mgr = Chain->getModuleManager();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001317 Record.clear();
Douglas Gregordf0c1512011-08-18 04:12:04 +00001318
Richard Smith7f330cd2015-03-18 01:42:29 +00001319 for (auto *M : Mgr) {
Douglas Gregordf0c1512011-08-18 04:12:04 +00001320 // Skip modules that weren't directly imported.
Richard Smith7f330cd2015-03-18 01:42:29 +00001321 if (!M->isDirectlyImported())
Douglas Gregordf0c1512011-08-18 04:12:04 +00001322 continue;
1323
Richard Smith7f330cd2015-03-18 01:42:29 +00001324 Record.push_back((unsigned)M->Kind); // FIXME: Stable encoding
1325 AddSourceLocation(M->ImportLoc, Record);
1326 Record.push_back(M->File->getSize());
Richard Smithe75ee0f2015-08-17 07:13:32 +00001327 Record.push_back(getTimestampForOutput(M->File));
Richard Smith7f330cd2015-03-18 01:42:29 +00001328 Record.push_back(M->Signature);
1329 AddPath(M->FileName, Record);
Douglas Gregordf0c1512011-08-18 04:12:04 +00001330 }
Douglas Gregor29cc6422011-08-17 21:07:30 +00001331 Stream.EmitRecord(IMPORTS, Record);
1332 }
Mike Stump11289f42009-09-09 15:08:12 +00001333
Richard Smith0516b182015-09-08 19:40:14 +00001334 // Write the options block.
1335 Stream.EnterSubblock(OPTIONS_BLOCK_ID, 4);
1336
Douglas Gregor112b9072012-10-18 05:31:06 +00001337 // Language options.
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001338 Record.clear();
Douglas Gregor112b9072012-10-18 05:31:06 +00001339 const LangOptions &LangOpts = Context.getLangOpts();
1340#define LANGOPT(Name, Bits, Default, Description) \
1341 Record.push_back(LangOpts.Name);
1342#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
1343 Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001344#include "clang/Basic/LangOptions.def"
1345#define SANITIZER(NAME, ID) \
1346 Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
Will Dietzf54319c2013-01-18 11:30:38 +00001347#include "clang/Basic/Sanitizers.def"
Douglas Gregor112b9072012-10-18 05:31:06 +00001348
Ben Langmuircd98cb72015-06-23 18:20:18 +00001349 Record.push_back(LangOpts.ModuleFeatures.size());
1350 for (StringRef Feature : LangOpts.ModuleFeatures)
1351 AddString(Feature, Record);
1352
Douglas Gregor112b9072012-10-18 05:31:06 +00001353 Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind());
1354 AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record);
Ben Langmuird4a667a2015-06-23 18:20:23 +00001355
1356 AddString(LangOpts.CurrentModule, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001357
1358 // Comment options.
1359 Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001360 for (const auto &I : LangOpts.CommentOpts.BlockCommandNames) {
1361 AddString(I, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001362 }
Dmitri Gribenkoa7d16ce2013-04-10 15:35:17 +00001363 Record.push_back(LangOpts.CommentOpts.ParseAllComments);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001364
Samuel Antaoee8fb302016-01-06 13:42:12 +00001365 // OpenMP offloading options.
1366 Record.push_back(LangOpts.OMPTargetTriples.size());
1367 for (auto &T : LangOpts.OMPTargetTriples)
1368 AddString(T.getTriple(), Record);
1369
1370 AddString(LangOpts.OMPHostIRFile, Record);
1371
Douglas Gregor112b9072012-10-18 05:31:06 +00001372 Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1373
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001374 // Target options.
1375 Record.clear();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001376 const TargetInfo &Target = Context.getTargetInfo();
1377 const TargetOptions &TargetOpts = Target.getTargetOpts();
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001378 AddString(TargetOpts.Triple, Record);
1379 AddString(TargetOpts.CPU, Record);
1380 AddString(TargetOpts.ABI, Record);
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001381 Record.push_back(TargetOpts.FeaturesAsWritten.size());
1382 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1383 AddString(TargetOpts.FeaturesAsWritten[I], Record);
1384 }
1385 Record.push_back(TargetOpts.Features.size());
1386 for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1387 AddString(TargetOpts.Features[I], Record);
1388 }
1389 Stream.EmitRecord(TARGET_OPTIONS, Record);
1390
Douglas Gregor8263ffb2012-10-24 15:17:15 +00001391 // Diagnostic options.
1392 Record.clear();
1393 const DiagnosticOptions &DiagOpts
1394 = Context.getDiagnostics().getDiagnosticOptions();
1395#define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1396#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
1397 Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1398#include "clang/Basic/DiagnosticOptions.def"
1399 Record.push_back(DiagOpts.Warnings.size());
1400 for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1401 AddString(DiagOpts.Warnings[I], Record);
Richard Smith3be1cb22014-08-07 00:24:21 +00001402 Record.push_back(DiagOpts.Remarks.size());
1403 for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1404 AddString(DiagOpts.Remarks[I], Record);
Douglas Gregor8263ffb2012-10-24 15:17:15 +00001405 // Note: we don't serialize the log or serialization file names, because they
1406 // are generally transient files and will almost always be overridden.
1407 Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record);
1408
Douglas Gregorc6317db2012-10-24 15:49:58 +00001409 // File system options.
1410 Record.clear();
Yaron Keren8dec46c2015-08-26 08:10:22 +00001411 const FileSystemOptions &FSOpts =
1412 Context.getSourceManager().getFileManager().getFileSystemOpts();
Douglas Gregorc6317db2012-10-24 15:49:58 +00001413 AddString(FSOpts.WorkingDir, Record);
1414 Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record);
1415
Douglas Gregor2d302362012-10-24 16:50:34 +00001416 // Header search options.
1417 Record.clear();
1418 const HeaderSearchOptions &HSOpts
1419 = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1420 AddString(HSOpts.Sysroot, Record);
1421
1422 // Include entries.
1423 Record.push_back(HSOpts.UserEntries.size());
1424 for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1425 const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1426 AddString(Entry.Path, Record);
1427 Record.push_back(static_cast<unsigned>(Entry.Group));
Douglas Gregor2d302362012-10-24 16:50:34 +00001428 Record.push_back(Entry.IsFramework);
1429 Record.push_back(Entry.IgnoreSysRoot);
Douglas Gregor2d302362012-10-24 16:50:34 +00001430 }
1431
1432 // System header prefixes.
1433 Record.push_back(HSOpts.SystemHeaderPrefixes.size());
1434 for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1435 AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1436 Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1437 }
1438
1439 AddString(HSOpts.ResourceDir, Record);
1440 AddString(HSOpts.ModuleCachePath, Record);
Argyrios Kyrtzidis1594c152014-03-03 08:12:05 +00001441 AddString(HSOpts.ModuleUserBuildPath, Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001442 Record.push_back(HSOpts.DisableModuleHash);
1443 Record.push_back(HSOpts.UseBuiltinIncludes);
1444 Record.push_back(HSOpts.UseStandardSystemIncludes);
1445 Record.push_back(HSOpts.UseStandardCXXIncludes);
1446 Record.push_back(HSOpts.UseLibcxx);
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00001447 // Write out the specific module cache path that contains the module files.
1448 AddString(PP.getHeaderSearchInfo().getModuleCachePath(), Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001449 Stream.EmitRecord(HEADER_SEARCH_OPTIONS, Record);
1450
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001451 // Preprocessor options.
1452 Record.clear();
1453 const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts();
1454
1455 // Macro definitions.
1456 Record.push_back(PPOpts.Macros.size());
1457 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1458 AddString(PPOpts.Macros[I].first, Record);
1459 Record.push_back(PPOpts.Macros[I].second);
1460 }
1461
1462 // Includes
1463 Record.push_back(PPOpts.Includes.size());
1464 for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1465 AddString(PPOpts.Includes[I], Record);
1466
1467 // Macro includes
1468 Record.push_back(PPOpts.MacroIncludes.size());
1469 for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1470 AddString(PPOpts.MacroIncludes[I], Record);
1471
Douglas Gregorb6368752012-10-24 23:41:50 +00001472 Record.push_back(PPOpts.UsePredefines);
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +00001473 // Detailed record is important since it is used for the module cache hash.
1474 Record.push_back(PPOpts.DetailedRecord);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001475 AddString(PPOpts.ImplicitPCHInclude, Record);
1476 AddString(PPOpts.ImplicitPTHInclude, Record);
1477 Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1478 Stream.EmitRecord(PREPROCESSOR_OPTIONS, Record);
1479
Richard Smith0516b182015-09-08 19:40:14 +00001480 // Leave the options block.
1481 Stream.ExitBlock();
1482
Douglas Gregora3b20262011-05-06 21:43:30 +00001483 // Original file name and file ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001484 SourceManager &SM = Context.getSourceManager();
1485 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001486 auto *FileAbbrev = new BitCodeAbbrev();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001487 FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE));
1488 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001489 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1490 unsigned FileAbbrevCode = Stream.EmitAbbrev(FileAbbrev);
1491
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001492 Record.clear();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001493 Record.push_back(ORIGINAL_FILE);
Douglas Gregora3b20262011-05-06 21:43:30 +00001494 Record.push_back(SM.getMainFileID().getOpaqueValue());
Richard Smith7ed1bc92014-12-05 22:42:13 +00001495 EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName());
Douglas Gregor45fe0362009-05-12 01:31:05 +00001496 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001497
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001498 Record.clear();
1499 Record.push_back(SM.getMainFileID().getOpaqueValue());
1500 Stream.EmitRecord(ORIGINAL_FILE_ID, Record);
1501
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001502 // Original PCH directory
1503 if (!OutputFile.empty() && OutputFile != "-") {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001504 auto *Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001505 Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR));
1506 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1507 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
1508
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001509 SmallString<128> OutputPath(OutputFile);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001510
Argyrios Kyrtzidisc56419e2015-07-31 00:58:32 +00001511 SM.getFileManager().makeAbsolutePath(OutputPath);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001512 StringRef origDir = llvm::sys::path::parent_path(OutputPath);
1513
Mehdi Amini57a41912015-09-10 01:46:39 +00001514 RecordData::value_type Record[] = {ORIGINAL_PCH_DIR};
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001515 Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir);
1516 }
1517
Douglas Gregor49491f72013-03-15 22:15:07 +00001518 WriteInputFiles(Context.SourceMgr,
1519 PP.getHeaderSearchInfo().getHeaderSearchOpts(),
Douglas Gregora3dd9002013-07-22 20:48:33 +00001520 PP.getLangOpts().Modules);
Douglas Gregor72be3902012-10-19 00:38:02 +00001521 Stream.ExitBlock();
Adrian Prantladbd2b12015-09-22 23:26:31 +00001522 return Signature;
Douglas Gregor72be3902012-10-19 00:38:02 +00001523}
1524
Douglas Gregor49491f72013-03-15 22:15:07 +00001525namespace {
1526 /// \brief An input file.
1527 struct InputFileEntry {
1528 const FileEntry *File;
1529 bool IsSystemFile;
Richard Smitha8cfffa2015-11-26 02:04:16 +00001530 bool IsTransient;
Douglas Gregor49491f72013-03-15 22:15:07 +00001531 bool BufferOverridden;
1532 };
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001533} // end anonymous namespace
Douglas Gregor49491f72013-03-15 22:15:07 +00001534
1535void ASTWriter::WriteInputFiles(SourceManager &SourceMgr,
1536 HeaderSearchOptions &HSOpts,
Douglas Gregora3dd9002013-07-22 20:48:33 +00001537 bool Modules) {
Douglas Gregor72be3902012-10-19 00:38:02 +00001538 using namespace llvm;
1539 Stream.EnterSubblock(INPUT_FILES_BLOCK_ID, 4);
Mehdi Amini57a41912015-09-10 01:46:39 +00001540
Douglas Gregor72be3902012-10-19 00:38:02 +00001541 // Create input-file abbreviation.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001542 auto *IFAbbrev = new BitCodeAbbrev();
Douglas Gregor72be3902012-10-19 00:38:02 +00001543 IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001544 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor72be3902012-10-19 00:38:02 +00001545 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1546 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001547 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
Richard Smitha8cfffa2015-11-26 02:04:16 +00001548 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Transient
Douglas Gregor72be3902012-10-19 00:38:02 +00001549 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
1550 unsigned IFAbbrevCode = Stream.EmitAbbrev(IFAbbrev);
1551
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001552 // Get all ContentCache objects for files, sorted by whether the file is a
1553 // system one or not. System files go at the back, users files at the front.
Douglas Gregor49491f72013-03-15 22:15:07 +00001554 std::deque<InputFileEntry> SortedFiles;
Douglas Gregor72be3902012-10-19 00:38:02 +00001555 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
1556 // Get this source location entry.
1557 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
NAKAMURA Takumideca50f2012-10-19 01:53:57 +00001558 assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc);
Douglas Gregor72be3902012-10-19 00:38:02 +00001559
1560 // We only care about file entries that were not overridden.
1561 if (!SLoc->isFile())
1562 continue;
1563 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001564 if (!Cache->OrigEntry)
Douglas Gregor72be3902012-10-19 00:38:02 +00001565 continue;
1566
Douglas Gregor49491f72013-03-15 22:15:07 +00001567 InputFileEntry Entry;
1568 Entry.File = Cache->OrigEntry;
1569 Entry.IsSystemFile = Cache->IsSystemFile;
Richard Smitha8cfffa2015-11-26 02:04:16 +00001570 Entry.IsTransient = Cache->IsTransient;
Douglas Gregor49491f72013-03-15 22:15:07 +00001571 Entry.BufferOverridden = Cache->BufferOverridden;
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001572 if (Cache->IsSystemFile)
Douglas Gregor49491f72013-03-15 22:15:07 +00001573 SortedFiles.push_back(Entry);
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001574 else
Douglas Gregor49491f72013-03-15 22:15:07 +00001575 SortedFiles.push_front(Entry);
1576 }
1577
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001578 unsigned UserFilesNum = 0;
1579 // Write out all of the input files.
Richard Smithec216502015-02-13 19:48:37 +00001580 std::vector<uint64_t> InputFileOffsets;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001581 for (const auto &Entry : SortedFiles) {
Douglas Gregor49491f72013-03-15 22:15:07 +00001582 uint32_t &InputFileID = InputFileIDs[Entry.File];
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001583 if (InputFileID != 0)
1584 continue; // already recorded this file.
1585
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001586 // Record this entry's offset.
1587 InputFileOffsets.push_back(Stream.GetCurrentBitNo());
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001588
1589 InputFileID = InputFileOffsets.size();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001590
Douglas Gregor49491f72013-03-15 22:15:07 +00001591 if (!Entry.IsSystemFile)
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001592 ++UserFilesNum;
1593
Douglas Gregor72be3902012-10-19 00:38:02 +00001594 // Emit size/modification time for this file.
Mehdi Amini57a41912015-09-10 01:46:39 +00001595 // And whether this file was overridden.
1596 RecordData::value_type Record[] = {
Richard Smitha8cfffa2015-11-26 02:04:16 +00001597 INPUT_FILE,
1598 InputFileOffsets.size(),
1599 (uint64_t)Entry.File->getSize(),
1600 (uint64_t)getTimestampForOutput(Entry.File),
1601 Entry.BufferOverridden,
1602 Entry.IsTransient};
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001603
Richard Smith7ed1bc92014-12-05 22:42:13 +00001604 EmitRecordWithPath(IFAbbrevCode, Record, Entry.File->getName());
1605 }
Douglas Gregor49491f72013-03-15 22:15:07 +00001606
Douglas Gregor112b9072012-10-18 05:31:06 +00001607 Stream.ExitBlock();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001608
1609 // Create input file offsets abbreviation.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001610 auto *OffsetsAbbrev = new BitCodeAbbrev();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001611 OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1612 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001613 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1614 // input files
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001615 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Array
1616 unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(OffsetsAbbrev);
1617
1618 // Write input file offsets.
Mehdi Amini57a41912015-09-10 01:46:39 +00001619 RecordData::value_type Record[] = {INPUT_FILE_OFFSETS,
1620 InputFileOffsets.size(), UserFilesNum};
Reid Kleckner012665e2015-05-21 00:13:09 +00001621 Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, bytes(InputFileOffsets));
Douglas Gregor55abb232009-04-10 20:39:37 +00001622}
1623
Douglas Gregora7f71a92009-04-10 03:52:48 +00001624//===----------------------------------------------------------------------===//
1625// Source Manager Serialization
1626//===----------------------------------------------------------------------===//
1627
1628/// \brief Create an abbreviation for the SLocEntry that refers to a
1629/// file.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001630static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001631 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001632
1633 auto *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001634 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001635 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1636 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1637 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1638 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
Douglas Gregorb41ca8f2010-03-21 22:49:54 +00001639 // FileEntry fields.
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001640 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001641 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001642 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
1643 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
Douglas Gregor8f45df52009-04-16 22:23:12 +00001644 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001645}
1646
1647/// \brief Create an abbreviation for the SLocEntry that refers to a
1648/// buffer.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001649static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001650 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001651
1652 auto *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00001653 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001654 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1655 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
1656 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Characteristic
1657 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1658 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
Douglas Gregor8f45df52009-04-16 22:23:12 +00001659 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001660}
1661
1662/// \brief Create an abbreviation for the SLocEntry that refers to a
1663/// buffer's blob.
Richard Smithaada85c2016-02-06 02:06:43 +00001664static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream,
1665 bool Compressed) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001666 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001667
1668 auto *Abbrev = new BitCodeAbbrev();
Richard Smithaada85c2016-02-06 02:06:43 +00001669 Abbrev->Add(BitCodeAbbrevOp(Compressed ? SM_SLOC_BUFFER_BLOB_COMPRESSED
1670 : SM_SLOC_BUFFER_BLOB));
1671 if (Compressed)
1672 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Uncompressed size
Douglas Gregora7f71a92009-04-10 03:52:48 +00001673 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
Douglas Gregor8f45df52009-04-16 22:23:12 +00001674 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001675}
1676
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001677/// \brief Create an abbreviation for the SLocEntry that refers to a macro
1678/// expansion.
1679static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001680 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001681
1682 auto *Abbrev = new BitCodeAbbrev();
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001683 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001684 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1685 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1686 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1687 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
Douglas Gregor83243272009-04-15 18:05:10 +00001688 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
Douglas Gregor8f45df52009-04-16 22:23:12 +00001689 return Stream.EmitAbbrev(Abbrev);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001690}
1691
Douglas Gregor09b69892011-02-10 17:09:37 +00001692namespace {
1693 // Trait used for the on-disk hash table of header search information.
1694 class HeaderFileInfoTrait {
1695 ASTWriter &Writer;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001696 const HeaderSearch &HS;
Douglas Gregor09b69892011-02-10 17:09:37 +00001697
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001698 // Keep track of the framework names we've used during serialization.
1699 SmallVector<char, 128> FrameworkStringData;
1700 llvm::StringMap<unsigned> FrameworkNameOffset;
1701
Douglas Gregor09b69892011-02-10 17:09:37 +00001702 public:
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001703 HeaderFileInfoTrait(ASTWriter &Writer, const HeaderSearch &HS)
1704 : Writer(Writer), HS(HS) { }
Douglas Gregor09b69892011-02-10 17:09:37 +00001705
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001706 struct key_type {
1707 const FileEntry *FE;
1708 const char *Filename;
1709 };
1710 typedef const key_type &key_type_ref;
Douglas Gregor09b69892011-02-10 17:09:37 +00001711
1712 typedef HeaderFileInfo data_type;
1713 typedef const data_type &data_type_ref;
Justin Bogner25463f12014-04-18 20:27:24 +00001714 typedef unsigned hash_value_type;
1715 typedef unsigned offset_type;
Douglas Gregor09b69892011-02-10 17:09:37 +00001716
Richard Smithe75ee0f2015-08-17 07:13:32 +00001717 hash_value_type ComputeHash(key_type_ref key) {
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001718 // The hash is based only on size/time of the file, so that the reader can
1719 // match even when symlinking or excess path elements ("foo/../", "../")
1720 // change the form of the name. However, complete path is still the key.
1721 return llvm::hash_combine(key.FE->getSize(),
Richard Smithe75ee0f2015-08-17 07:13:32 +00001722 Writer.getTimestampForOutput(key.FE));
Douglas Gregor09b69892011-02-10 17:09:37 +00001723 }
1724
1725 std::pair<unsigned,unsigned>
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001726 EmitKeyDataLength(raw_ostream& Out, key_type_ref key, data_type_ref Data) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001727 using namespace llvm::support;
Richard Smith386bb072015-08-18 23:42:23 +00001728 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001729 unsigned KeyLen = strlen(key.Filename) + 1 + 8 + 8;
Richard Smith386bb072015-08-18 23:42:23 +00001730 LE.write<uint16_t>(KeyLen);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001731 unsigned DataLen = 1 + 2 + 4 + 4;
Richard Smith386bb072015-08-18 23:42:23 +00001732 for (auto ModInfo : HS.getModuleMap().findAllModulesForHeader(key.FE))
1733 if (Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule()))
1734 DataLen += 4;
1735 LE.write<uint8_t>(DataLen);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001736 return std::make_pair(KeyLen, DataLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001737 }
1738
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001739 void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001740 using namespace llvm::support;
1741 endian::Writer<little> LE(Out);
1742 LE.write<uint64_t>(key.FE->getSize());
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001743 KeyLen -= 8;
Richard Smithe75ee0f2015-08-17 07:13:32 +00001744 LE.write<uint64_t>(Writer.getTimestampForOutput(key.FE));
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001745 KeyLen -= 8;
1746 Out.write(key.Filename, KeyLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001747 }
1748
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001749 void EmitData(raw_ostream &Out, key_type_ref key,
Douglas Gregor09b69892011-02-10 17:09:37 +00001750 data_type_ref Data, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001751 using namespace llvm::support;
1752 endian::Writer<little> LE(Out);
Douglas Gregor09b69892011-02-10 17:09:37 +00001753 uint64_t Start = Out.tell(); (void)Start;
1754
Richard Smith386bb072015-08-18 23:42:23 +00001755 unsigned char Flags = (Data.isImport << 4)
1756 | (Data.isPragmaOnce << 3)
1757 | (Data.DirInfo << 1)
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001758 | Data.IndexHeaderMapHeader;
Justin Bognere1c147c2014-03-28 22:03:19 +00001759 LE.write<uint8_t>(Flags);
1760 LE.write<uint16_t>(Data.NumIncludes);
Douglas Gregor09b69892011-02-10 17:09:37 +00001761
1762 if (!Data.ControllingMacro)
Justin Bognere1c147c2014-03-28 22:03:19 +00001763 LE.write<uint32_t>(Data.ControllingMacroID);
Douglas Gregor09b69892011-02-10 17:09:37 +00001764 else
Justin Bognere1c147c2014-03-28 22:03:19 +00001765 LE.write<uint32_t>(Writer.getIdentifierRef(Data.ControllingMacro));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001766
1767 unsigned Offset = 0;
1768 if (!Data.Framework.empty()) {
1769 // If this header refers into a framework, save the framework name.
1770 llvm::StringMap<unsigned>::iterator Pos
1771 = FrameworkNameOffset.find(Data.Framework);
1772 if (Pos == FrameworkNameOffset.end()) {
1773 Offset = FrameworkStringData.size() + 1;
1774 FrameworkStringData.append(Data.Framework.begin(),
1775 Data.Framework.end());
1776 FrameworkStringData.push_back(0);
1777
1778 FrameworkNameOffset[Data.Framework] = Offset;
1779 } else
1780 Offset = Pos->second;
1781 }
Justin Bognere1c147c2014-03-28 22:03:19 +00001782 LE.write<uint32_t>(Offset);
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001783
Richard Smith386bb072015-08-18 23:42:23 +00001784 // FIXME: If the header is excluded, we should write out some
1785 // record of that fact.
1786 for (auto ModInfo : HS.getModuleMap().findAllModulesForHeader(key.FE)) {
1787 if (uint32_t ModID =
1788 Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule())) {
1789 uint32_t Value = (ModID << 2) | (unsigned)ModInfo.getRole();
1790 assert((Value >> 2) == ModID && "overflow in header module info");
1791 LE.write<uint32_t>(Value);
1792 }
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001793 }
1794
Douglas Gregor09b69892011-02-10 17:09:37 +00001795 assert(Out.tell() - Start == DataLen && "Wrong data length");
1796 }
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001797
1798 const char *strings_begin() const { return FrameworkStringData.begin(); }
1799 const char *strings_end() const { return FrameworkStringData.end(); }
Douglas Gregor09b69892011-02-10 17:09:37 +00001800 };
1801} // end anonymous namespace
1802
1803/// \brief Write the header search block for the list of files that
1804///
1805/// \param HS The header search structure to save.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001806void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001807 SmallVector<const FileEntry *, 16> FilesByUID;
Douglas Gregor09b69892011-02-10 17:09:37 +00001808 HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
1809
1810 if (FilesByUID.size() > HS.header_file_size())
1811 FilesByUID.resize(HS.header_file_size());
1812
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001813 HeaderFileInfoTrait GeneratorTrait(*this, HS);
Justin Bognerbb094f02014-04-18 19:57:06 +00001814 llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001815 SmallVector<const char *, 4> SavedStrings;
Douglas Gregor09b69892011-02-10 17:09:37 +00001816 unsigned NumHeaderSearchEntries = 0;
1817 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
1818 const FileEntry *File = FilesByUID[UID];
1819 if (!File)
1820 continue;
1821
Richard Smith386bb072015-08-18 23:42:23 +00001822 // Get the file info. This will load info from the external source if
1823 // necessary. Skip emitting this file if we have no information on it
1824 // as a header file (in which case HFI will be null) or if it hasn't
1825 // changed since it was loaded. Also skip it if it's for a modular header
1826 // from a different module; in that case, we rely on the module(s)
1827 // containing the header to provide this information.
Richard Smithd8879c82015-08-24 21:59:32 +00001828 const HeaderFileInfo *HFI =
1829 HS.getExistingFileInfo(File, /*WantExternal*/!Chain);
1830 if (!HFI || (HFI->isModuleHeader && !HFI->isCompilingModuleHeader))
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +00001831 continue;
Douglas Gregor09b69892011-02-10 17:09:37 +00001832
Richard Smith7ed1bc92014-12-05 22:42:13 +00001833 // Massage the file path into an appropriate form.
Douglas Gregor09b69892011-02-10 17:09:37 +00001834 const char *Filename = File->getName();
Richard Smith7ed1bc92014-12-05 22:42:13 +00001835 SmallString<128> FilenameTmp(Filename);
1836 if (PreparePathForOutput(FilenameTmp)) {
1837 // If we performed any translation on the file name at all, we need to
1838 // save this string, since the generator will refer to it later.
1839 Filename = strdup(FilenameTmp.c_str());
Douglas Gregor09b69892011-02-10 17:09:37 +00001840 SavedStrings.push_back(Filename);
1841 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001842
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001843 HeaderFileInfoTrait::key_type key = { File, Filename };
Richard Smith386bb072015-08-18 23:42:23 +00001844 Generator.insert(key, *HFI, GeneratorTrait);
Douglas Gregor09b69892011-02-10 17:09:37 +00001845 ++NumHeaderSearchEntries;
1846 }
1847
1848 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001849 SmallString<4096> TableData;
Douglas Gregor09b69892011-02-10 17:09:37 +00001850 uint32_t BucketOffset;
1851 {
Justin Bognere1c147c2014-03-28 22:03:19 +00001852 using namespace llvm::support;
Douglas Gregor09b69892011-02-10 17:09:37 +00001853 llvm::raw_svector_ostream Out(TableData);
1854 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00001855 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregor09b69892011-02-10 17:09:37 +00001856 BucketOffset = Generator.Emit(Out, GeneratorTrait);
1857 }
1858
1859 // Create a blob abbreviation
1860 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001861
1862 auto *Abbrev = new BitCodeAbbrev();
Douglas Gregor09b69892011-02-10 17:09:37 +00001863 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
1864 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1865 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001866 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor09b69892011-02-10 17:09:37 +00001867 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1868 unsigned TableAbbrev = Stream.EmitAbbrev(Abbrev);
1869
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001870 // Write the header search table
Mehdi Amini57a41912015-09-10 01:46:39 +00001871 RecordData::value_type Record[] = {HEADER_SEARCH_TABLE, BucketOffset,
1872 NumHeaderSearchEntries, TableData.size()};
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001873 TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end());
Yaron Keren92e1b622015-03-18 10:17:07 +00001874 Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData);
Douglas Gregor09b69892011-02-10 17:09:37 +00001875
1876 // Free all of the strings we had to duplicate.
1877 for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
David Greenebae0e352013-01-15 22:09:43 +00001878 free(const_cast<char *>(SavedStrings[I]));
Douglas Gregor09b69892011-02-10 17:09:37 +00001879}
1880
Douglas Gregora7f71a92009-04-10 03:52:48 +00001881/// \brief Writes the block containing the serialized form of the
1882/// source manager.
1883///
1884/// TODO: We should probably use an on-disk hash table (stored in a
1885/// blob), indexed based on the file name, so that we only create
1886/// entries for files that we actually need. In the common case (no
1887/// errors), we probably won't have to create file entries for any of
1888/// the files in the AST.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00001889void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
Richard Smith7ed1bc92014-12-05 22:42:13 +00001890 const Preprocessor &PP) {
Douglas Gregor258ae542009-04-27 06:38:32 +00001891 RecordData Record;
1892
Chris Lattner0910e3b2009-04-10 17:16:57 +00001893 // Enter the source manager block.
Richard Smithaada85c2016-02-06 02:06:43 +00001894 Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 4);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001895
1896 // Abbreviations for the various kinds of source-location entries.
Chris Lattnerc4976c732009-04-27 19:03:22 +00001897 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
1898 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
Richard Smithaada85c2016-02-06 02:06:43 +00001899 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream, false);
1900 unsigned SLocBufferBlobCompressedAbbrv =
1901 CreateSLocBufferBlobAbbrev(Stream, true);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001902 unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
Douglas Gregora7f71a92009-04-10 03:52:48 +00001903
Douglas Gregor258ae542009-04-27 06:38:32 +00001904 // Write out the source location entry table. We skip the first
1905 // entry, which is always the same dummy entry.
Chris Lattner12d61d32009-04-27 19:01:47 +00001906 std::vector<uint32_t> SLocEntryOffsets;
Douglas Gregor258ae542009-04-27 06:38:32 +00001907 RecordData PreloadSLocs;
Douglas Gregor925296b2011-07-19 16:10:42 +00001908 SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1);
1909 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
Sebastian Redl5c415f32010-07-22 17:01:13 +00001910 I != N; ++I) {
Douglas Gregor8655e882009-10-16 22:46:09 +00001911 // Get this source location entry.
Douglas Gregor925296b2011-07-19 16:10:42 +00001912 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00001913 FileID FID = FileID::get(I);
1914 assert(&SourceMgr.getSLocEntry(FID) == SLoc);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001915
Douglas Gregor258ae542009-04-27 06:38:32 +00001916 // Record the offset of this source-location entry.
1917 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
1918
1919 // Figure out which record code to use.
1920 unsigned Code;
1921 if (SLoc->isFile()) {
Douglas Gregor9dc32122011-11-16 20:05:18 +00001922 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
1923 if (Cache->OrigEntry) {
Sebastian Redl539c5062010-08-18 23:57:32 +00001924 Code = SM_SLOC_FILE_ENTRY;
Argyrios Kyrtzidis92dd4662011-06-02 20:01:46 +00001925 } else
Sebastian Redl539c5062010-08-18 23:57:32 +00001926 Code = SM_SLOC_BUFFER_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00001927 } else
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001928 Code = SM_SLOC_EXPANSION_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00001929 Record.clear();
1930 Record.push_back(Code);
1931
Douglas Gregor925296b2011-07-19 16:10:42 +00001932 // Starting offset of this entry within this module, so skip the dummy.
1933 Record.push_back(SLoc->getOffset() - 2);
Douglas Gregor258ae542009-04-27 06:38:32 +00001934 if (SLoc->isFile()) {
1935 const SrcMgr::FileInfo &File = SLoc->getFile();
Richard Smithb22a1d12016-03-27 20:13:24 +00001936 AddSourceLocation(File.getIncludeLoc(), Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00001937 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
1938 Record.push_back(File.hasLineDirectives());
1939
1940 const SrcMgr::ContentCache *Content = File.getContentCache();
Richard Smithaada85c2016-02-06 02:06:43 +00001941 bool EmitBlob = false;
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00001942 if (Content->OrigEntry) {
1943 assert(Content->OrigEntry == Content->ContentsEntry &&
Douglas Gregor9dc32122011-11-16 20:05:18 +00001944 "Writing to AST an overridden file is not supported");
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00001945
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001946 // The source location entry is a file. Emit input file ID.
1947 assert(InputFileIDs[Content->OrigEntry] != 0 && "Missed file entry");
1948 Record.push_back(InputFileIDs[Content->OrigEntry]);
Mike Stump11289f42009-09-09 15:08:12 +00001949
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001950 Record.push_back(File.NumCreatedFIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001951
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00001952 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001953 if (FDI != FileDeclIDs.end()) {
1954 Record.push_back(FDI->second->FirstDeclIndex);
1955 Record.push_back(FDI->second->DeclIDs.size());
1956 } else {
1957 Record.push_back(0);
1958 Record.push_back(0);
1959 }
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001960
1961 Stream.EmitRecordWithAbbrev(SLocFileAbbrv, Record);
1962
Richard Smithaada85c2016-02-06 02:06:43 +00001963 if (Content->BufferOverridden || Content->IsTransient)
1964 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00001965 } else {
1966 // The source location entry is a buffer. The blob associated
1967 // with this entry contains the contents of the buffer.
1968
1969 // We add one to the size so that we capture the trailing NULL
1970 // that is required by llvm::MemoryBuffer::getMemBuffer (on
1971 // the reader side).
Douglas Gregor874cc622010-03-16 00:35:39 +00001972 const llvm::MemoryBuffer *Buffer
Chris Lattnerfb24a3a2010-04-20 20:35:58 +00001973 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
Douglas Gregor258ae542009-04-27 06:38:32 +00001974 const char *Name = Buffer->getBufferIdentifier();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001975 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
Chris Lattner0e62c1c2011-07-23 10:55:15 +00001976 StringRef(Name, strlen(Name) + 1));
Richard Smithaada85c2016-02-06 02:06:43 +00001977 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00001978
Douglas Gregor925296b2011-07-19 16:10:42 +00001979 if (strcmp(Name, "<built-in>") == 0) {
1980 PreloadSLocs.push_back(SLocEntryOffsets.size());
1981 }
Douglas Gregor258ae542009-04-27 06:38:32 +00001982 }
Richard Smithaada85c2016-02-06 02:06:43 +00001983
1984 if (EmitBlob) {
1985 // Include the implicit terminating null character in the on-disk buffer
1986 // if we're writing it uncompressed.
1987 const llvm::MemoryBuffer *Buffer =
1988 Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
1989 StringRef Blob(Buffer->getBufferStart(), Buffer->getBufferSize() + 1);
1990
1991 // Compress the buffer if possible. We expect that almost all PCM
1992 // consumers will not want its contents.
1993 SmallString<0> CompressedBuffer;
1994 if (llvm::zlib::compress(Blob.drop_back(1), CompressedBuffer) ==
1995 llvm::zlib::StatusOK) {
1996 RecordData::value_type Record[] = {SM_SLOC_BUFFER_BLOB_COMPRESSED,
1997 Blob.size() - 1};
1998 Stream.EmitRecordWithBlob(SLocBufferBlobCompressedAbbrv, Record,
1999 CompressedBuffer);
2000 } else {
2001 RecordData::value_type Record[] = {SM_SLOC_BUFFER_BLOB};
2002 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record, Blob);
2003 }
2004 }
Douglas Gregor258ae542009-04-27 06:38:32 +00002005 } else {
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002006 // The source location entry is a macro expansion.
Chandler Carruthee4c1d12011-07-26 04:56:51 +00002007 const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
Richard Smithb22a1d12016-03-27 20:13:24 +00002008 AddSourceLocation(Expansion.getSpellingLoc(), Record);
2009 AddSourceLocation(Expansion.getExpansionLocStart(), Record);
2010 AddSourceLocation(Expansion.isMacroArgExpansion()
2011 ? SourceLocation()
2012 : Expansion.getExpansionLocEnd(),
2013 Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002014
2015 // Compute the token length for this macro expansion.
Douglas Gregor925296b2011-07-19 16:10:42 +00002016 unsigned NextOffset = SourceMgr.getNextLocalOffset();
Douglas Gregor8655e882009-10-16 22:46:09 +00002017 if (I + 1 != N)
Douglas Gregor925296b2011-07-19 16:10:42 +00002018 NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset();
Douglas Gregor258ae542009-04-27 06:38:32 +00002019 Record.push_back(NextOffset - SLoc->getOffset() - 1);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002020 Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002021 }
2022 }
2023
Douglas Gregor8f45df52009-04-16 22:23:12 +00002024 Stream.ExitBlock();
Douglas Gregor258ae542009-04-27 06:38:32 +00002025
2026 if (SLocEntryOffsets.empty())
2027 return;
2028
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002029 // Write the source-location offsets table into the AST block. This
Douglas Gregor258ae542009-04-27 06:38:32 +00002030 // table is used for lazily loading source-location information.
2031 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002032
2033 auto *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00002034 Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
Douglas Gregor258ae542009-04-27 06:38:32 +00002035 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
Douglas Gregor925296b2011-07-19 16:10:42 +00002036 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
Douglas Gregor258ae542009-04-27 06:38:32 +00002037 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
2038 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(Abbrev);
Mehdi Amini57a41912015-09-10 01:46:39 +00002039 {
2040 RecordData::value_type Record[] = {
2041 SOURCE_LOCATION_OFFSETS, SLocEntryOffsets.size(),
2042 SourceMgr.getNextLocalOffset() - 1 /* skip dummy */};
2043 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
2044 bytes(SLocEntryOffsets));
2045 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002046 // Write the source location entry preloads array, telling the AST
Douglas Gregor258ae542009-04-27 06:38:32 +00002047 // reader which source locations entries it should load eagerly.
Sebastian Redl539c5062010-08-18 23:57:32 +00002048 Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
Douglas Gregor925296b2011-07-19 16:10:42 +00002049
2050 // Write the line table. It depends on remapping working, so it must come
2051 // after the source location offsets.
2052 if (SourceMgr.hasLineTable()) {
2053 LineTableInfo &LineTable = SourceMgr.getLineTable();
2054
2055 Record.clear();
Richard Smith63078492015-09-01 07:41:55 +00002056
2057 // Emit the needed file names.
2058 llvm::DenseMap<int, int> FilenameMap;
2059 for (const auto &L : LineTable) {
2060 if (L.first.ID < 0)
2061 continue;
2062 for (auto &LE : L.second) {
2063 if (FilenameMap.insert(std::make_pair(LE.FilenameID,
2064 FilenameMap.size())).second)
2065 AddPath(LineTable.getFilename(LE.FilenameID), Record);
2066 }
2067 }
2068 Record.push_back(0);
Douglas Gregor925296b2011-07-19 16:10:42 +00002069
2070 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002071 for (const auto &L : LineTable) {
Douglas Gregor925296b2011-07-19 16:10:42 +00002072 // Only emit entries for local files.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002073 if (L.first.ID < 0)
Douglas Gregor925296b2011-07-19 16:10:42 +00002074 continue;
2075
2076 // Emit the file ID
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002077 Record.push_back(L.first.ID);
Douglas Gregor925296b2011-07-19 16:10:42 +00002078
2079 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002080 Record.push_back(L.second.size());
2081 for (const auto &LE : L.second) {
2082 Record.push_back(LE.FileOffset);
2083 Record.push_back(LE.LineNo);
2084 Record.push_back(FilenameMap[LE.FilenameID]);
2085 Record.push_back((unsigned)LE.FileKind);
2086 Record.push_back(LE.IncludeOffset);
Douglas Gregor925296b2011-07-19 16:10:42 +00002087 }
2088 }
Richard Smith63078492015-09-01 07:41:55 +00002089
Douglas Gregor925296b2011-07-19 16:10:42 +00002090 Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record);
2091 }
Douglas Gregora7f71a92009-04-10 03:52:48 +00002092}
2093
Douglas Gregorc5046832009-04-27 18:38:38 +00002094//===----------------------------------------------------------------------===//
2095// Preprocessor Serialization
2096//===----------------------------------------------------------------------===//
2097
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002098static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule,
2099 const Preprocessor &PP) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002100 if (MacroInfo *MI = MD->getMacroInfo())
2101 if (MI->isBuiltinMacro())
2102 return true;
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002103
2104 if (IsModule) {
2105 SourceLocation Loc = MD->getLocation();
2106 if (Loc.isInvalid())
2107 return true;
2108 if (PP.getSourceManager().getFileID(Loc) == PP.getPredefinesFileID())
2109 return true;
2110 }
2111
2112 return false;
2113}
2114
Chris Lattnereeffaef2009-04-10 17:15:23 +00002115/// \brief Writes the block containing the serialized form of the
2116/// preprocessor.
2117///
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00002118void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002119 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
2120 if (PPRec)
2121 WritePreprocessorDetail(*PPRec);
2122
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002123 RecordData Record;
Richard Smithd7329392015-04-21 21:46:32 +00002124 RecordData ModuleMacroRecord;
Chris Lattner0910e3b2009-04-10 17:16:57 +00002125
Chris Lattner0af3ba12009-04-13 01:29:17 +00002126 // If the preprocessor __COUNTER__ value has been bumped, remember it.
2127 if (PP.getCounterValue() != 0) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002128 RecordData::value_type Record[] = {PP.getCounterValue()};
Sebastian Redl539c5062010-08-18 23:57:32 +00002129 Stream.EmitRecord(PP_COUNTER_VALUE, Record);
Douglas Gregoreda6a892009-04-26 00:07:37 +00002130 }
2131
2132 // Enter the preprocessor block.
Douglas Gregor796d76a2010-10-20 22:00:55 +00002133 Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +00002134
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002135 // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002136 // FIXME: Include a location for the use, and say which one was used.
Douglas Gregoreda6a892009-04-26 00:07:37 +00002137 if (PP.SawDateOrTime())
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002138 PP.Diag(SourceLocation(), diag::warn_module_uses_date_time) << IsModule;
Douglas Gregor796d76a2010-10-20 22:00:55 +00002139
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002140 // Loop over all the macro directives that are live at the end of the file,
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002141 // emitting each to the PP section.
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002142
Richard Smithee977932015-05-01 21:22:17 +00002143 // Construct the list of identifiers with macro directives that need to be
2144 // serialized.
2145 SmallVector<const IdentifierInfo *, 128> MacroIdentifiers;
2146 for (auto &Id : PP.getIdentifierTable())
2147 if (Id.second->hadMacroDefinition() &&
2148 (!Id.second->isFromAST() ||
2149 Id.second->hasChangedSinceDeserialization()))
2150 MacroIdentifiers.push_back(Id.second);
Douglas Gregor2e5571d2011-02-10 18:20:09 +00002151 // Sort the set of macro definitions that need to be serialized by the
2152 // name of the macro, to provide a stable ordering.
Richard Smithee977932015-05-01 21:22:17 +00002153 std::sort(MacroIdentifiers.begin(), MacroIdentifiers.end(),
2154 llvm::less_ptr<IdentifierInfo>());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002155
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002156 // Emit the macro directives as a list and associate the offset with the
2157 // identifier they belong to.
Richard Smithee977932015-05-01 21:22:17 +00002158 for (const IdentifierInfo *Name : MacroIdentifiers) {
2159 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(Name);
Richard Smithd7329392015-04-21 21:46:32 +00002160 auto StartOffset = Stream.GetCurrentBitNo();
2161
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002162 // Emit the macro directives in reverse source order.
2163 for (; MD; MD = MD->getPrevious()) {
Richard Smithd7329392015-04-21 21:46:32 +00002164 // Once we hit an ignored macro, we're done: the rest of the chain
2165 // will all be ignored macros.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002166 if (shouldIgnoreMacro(MD, IsModule, PP))
Richard Smithd7329392015-04-21 21:46:32 +00002167 break;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002168
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002169 AddSourceLocation(MD->getLocation(), Record);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002170 Record.push_back(MD->getKind());
Richard Smithdaa69e02014-07-25 04:40:03 +00002171 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
Richard Smith3981b172015-04-30 02:16:23 +00002172 Record.push_back(getMacroRef(DefMD->getInfo(), Name));
Richard Smith713369b2015-04-23 20:40:50 +00002173 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002174 Record.push_back(VisMD->isPublic());
2175 }
Richard Smithb8b2ed62015-04-23 18:18:26 +00002176 }
Richard Smithd7329392015-04-21 21:46:32 +00002177
Richard Smithb8b2ed62015-04-23 18:18:26 +00002178 // Write out any exported module macros.
Richard Smithee977932015-05-01 21:22:17 +00002179 bool EmittedModuleMacros = false;
Richard Smithb8b2ed62015-04-23 18:18:26 +00002180 if (IsModule) {
2181 auto Leafs = PP.getLeafModuleMacros(Name);
2182 SmallVector<ModuleMacro*, 8> Worklist(Leafs.begin(), Leafs.end());
2183 llvm::DenseMap<ModuleMacro*, unsigned> Visits;
2184 while (!Worklist.empty()) {
2185 auto *Macro = Worklist.pop_back_val();
Richard Smithd7329392015-04-21 21:46:32 +00002186
Richard Smithb8b2ed62015-04-23 18:18:26 +00002187 // Emit a record indicating this submodule exports this macro.
2188 ModuleMacroRecord.push_back(
2189 getSubmoduleID(Macro->getOwningModule()));
Richard Smithee977932015-05-01 21:22:17 +00002190 ModuleMacroRecord.push_back(getMacroRef(Macro->getMacroInfo(), Name));
Richard Smithb8b2ed62015-04-23 18:18:26 +00002191 for (auto *M : Macro->overrides())
2192 ModuleMacroRecord.push_back(getSubmoduleID(M->getOwningModule()));
Richard Smithd7329392015-04-21 21:46:32 +00002193
Richard Smithb8b2ed62015-04-23 18:18:26 +00002194 Stream.EmitRecord(PP_MODULE_MACRO, ModuleMacroRecord);
2195 ModuleMacroRecord.clear();
Richard Smithd7329392015-04-21 21:46:32 +00002196
Richard Smithb8b2ed62015-04-23 18:18:26 +00002197 // Enqueue overridden macros once we've visited all their ancestors.
2198 for (auto *M : Macro->overrides())
2199 if (++Visits[M] == M->getNumOverridingMacros())
2200 Worklist.push_back(M);
Richard Smithee977932015-05-01 21:22:17 +00002201
2202 EmittedModuleMacros = true;
Richard Smithd7329392015-04-21 21:46:32 +00002203 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002204 }
Richard Smithd7329392015-04-21 21:46:32 +00002205
Richard Smithee977932015-05-01 21:22:17 +00002206 if (Record.empty() && !EmittedModuleMacros)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002207 continue;
2208
Richard Smithd7329392015-04-21 21:46:32 +00002209 IdentMacroDirectivesOffsetMap[Name] = StartOffset;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002210 Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, Record);
2211 Record.clear();
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002212 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00002213
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002214 /// \brief Offsets of each of the macros into the bitstream, indexed by
2215 /// the local macro ID
2216 ///
2217 /// For each identifier that is associated with a macro, this map
2218 /// provides the offset into the bitstream where that macro is
2219 /// defined.
2220 std::vector<uint32_t> MacroOffsets;
2221
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002222 for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) {
2223 const IdentifierInfo *Name = MacroInfosToEmit[I].Name;
2224 MacroInfo *MI = MacroInfosToEmit[I].MI;
2225 MacroID ID = MacroInfosToEmit[I].ID;
Douglas Gregoreb114da2010-10-01 01:03:07 +00002226
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002227 if (ID < FirstMacroID) {
2228 assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?");
2229 continue;
Chris Lattner2199f5b2009-04-10 18:08:30 +00002230 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002231
2232 // Record the local offset of this macro.
2233 unsigned Index = ID - FirstMacroID;
2234 if (Index == MacroOffsets.size())
2235 MacroOffsets.push_back(Stream.GetCurrentBitNo());
2236 else {
2237 if (Index > MacroOffsets.size())
2238 MacroOffsets.resize(Index + 1);
2239
2240 MacroOffsets[Index] = Stream.GetCurrentBitNo();
2241 }
2242
2243 AddIdentifierRef(Name, Record);
2244 Record.push_back(inferSubmoduleIDFromLocation(MI->getDefinitionLoc()));
2245 AddSourceLocation(MI->getDefinitionLoc(), Record);
2246 AddSourceLocation(MI->getDefinitionEndLoc(), Record);
2247 Record.push_back(MI->isUsed());
Argyrios Kyrtzidis9ef53ce2014-04-09 18:21:23 +00002248 Record.push_back(MI->isUsedForHeaderGuard());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002249 unsigned Code;
2250 if (MI->isObjectLike()) {
2251 Code = PP_MACRO_OBJECT_LIKE;
2252 } else {
2253 Code = PP_MACRO_FUNCTION_LIKE;
2254
2255 Record.push_back(MI->isC99Varargs());
2256 Record.push_back(MI->isGNUVarargs());
2257 Record.push_back(MI->hasCommaPasting());
2258 Record.push_back(MI->getNumArgs());
Daniel Marjamakie4770da2015-05-29 09:15:24 +00002259 for (const IdentifierInfo *Arg : MI->args())
2260 AddIdentifierRef(Arg, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002261 }
2262
2263 // If we have a detailed preprocessing record, record the macro definition
2264 // ID that corresponds to this macro.
2265 if (PPRec)
2266 Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2267
2268 Stream.EmitRecord(Code, Record);
2269 Record.clear();
2270
2271 // Emit the tokens array.
2272 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
2273 // Note that we know that the preprocessor does not have any annotation
2274 // tokens in it because they are created by the parser, and thus can't
2275 // be in a macro definition.
2276 const Token &Tok = MI->getReplacementToken(TokNo);
John McCallf413f5e2013-05-03 00:10:13 +00002277 AddToken(Tok, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002278 Stream.EmitRecord(PP_TOKEN, Record);
2279 Record.clear();
2280 }
2281 ++NumMacros;
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002282 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002283
Douglas Gregor92a96f52011-02-08 21:58:10 +00002284 Stream.ExitBlock();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002285
2286 // Write the offsets table for macro IDs.
2287 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002288
Richard Smith13090a22015-04-10 02:02:24 +00002289 auto *Abbrev = new BitCodeAbbrev();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002290 Abbrev->Add(BitCodeAbbrevOp(MACRO_OFFSET));
2291 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2292 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2293 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2294
2295 unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
Mehdi Amini57a41912015-09-10 01:46:39 +00002296 {
2297 RecordData::value_type Record[] = {MACRO_OFFSET, MacroOffsets.size(),
2298 FirstMacroID - NUM_PREDEF_MACRO_IDS};
2299 Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record, bytes(MacroOffsets));
2300 }
Douglas Gregor92a96f52011-02-08 21:58:10 +00002301}
2302
2303void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) {
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002304 if (PPRec.local_begin() == PPRec.local_end())
Douglas Gregor92a96f52011-02-08 21:58:10 +00002305 return;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002306
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +00002307 SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002308
Douglas Gregor92a96f52011-02-08 21:58:10 +00002309 // Enter the preprocessor block.
2310 Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002311
Douglas Gregoraae92242010-03-19 21:51:54 +00002312 // If the preprocessor has a preprocessing record, emit it.
2313 unsigned NumPreprocessingRecords = 0;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002314 using namespace llvm;
2315
2316 // Set up the abbreviation for
2317 unsigned InclusionAbbrev = 0;
2318 {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002319 auto *Abbrev = new BitCodeAbbrev();
Douglas Gregor92a96f52011-02-08 21:58:10 +00002320 Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002321 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2322 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2323 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002324 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
Douglas Gregor92a96f52011-02-08 21:58:10 +00002325 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2326 InclusionAbbrev = Stream.EmitAbbrev(Abbrev);
2327 }
2328
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002329 unsigned FirstPreprocessorEntityID
2330 = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0)
2331 + NUM_PREDEF_PP_ENTITY_IDS;
2332 unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002333 RecordData Record;
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002334 for (PreprocessingRecord::iterator E = PPRec.local_begin(),
2335 EEnd = PPRec.local_end();
Douglas Gregor0d4b4312011-08-04 17:06:18 +00002336 E != EEnd;
2337 (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002338 Record.clear();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002339
Richard Smith66a81862015-05-04 02:25:31 +00002340 PreprocessedEntityOffsets.push_back(
2341 PPEntityOffset((*E)->getSourceRange(), Stream.GetCurrentBitNo()));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002342
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002343 if (auto *MD = dyn_cast<MacroDefinitionRecord>(*E)) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002344 // Record this macro definition's ID.
2345 MacroDefinitions[MD] = NextPreprocessorEntityID;
Richard Smith66a81862015-05-04 02:25:31 +00002346
Douglas Gregor92a96f52011-02-08 21:58:10 +00002347 AddIdentifierRef(MD->getName(), Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002348 Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
2349 continue;
Douglas Gregoraae92242010-03-19 21:51:54 +00002350 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002351
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002352 if (auto *ME = dyn_cast<MacroExpansion>(*E)) {
Argyrios Kyrtzidis80f78b92011-09-08 17:18:41 +00002353 Record.push_back(ME->isBuiltinMacro());
2354 if (ME->isBuiltinMacro())
2355 AddIdentifierRef(ME->getName(), Record);
2356 else
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002357 Record.push_back(MacroDefinitions[ME->getDefinition()]);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002358 Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002359 continue;
2360 }
2361
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002362 if (auto *ID = dyn_cast<InclusionDirective>(*E)) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002363 Record.push_back(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002364 Record.push_back(ID->getFileName().size());
2365 Record.push_back(ID->wasInQuotes());
2366 Record.push_back(static_cast<unsigned>(ID->getKind()));
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002367 Record.push_back(ID->importedModule());
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002368 SmallString<64> Buffer;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002369 Buffer += ID->getFileName();
Argyrios Kyrtzidis8dbcfc32012-03-08 01:08:28 +00002370 // Check that the FileEntry is not null because it was not resolved and
2371 // we create a PCH even with compiler errors.
2372 if (ID->getFile())
2373 Buffer += ID->getFile()->getName();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002374 Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002375 continue;
2376 }
2377
2378 llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
2379 }
Douglas Gregor8f45df52009-04-16 22:23:12 +00002380 Stream.ExitBlock();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002381
Douglas Gregoraae92242010-03-19 21:51:54 +00002382 // Write the offsets table for the preprocessing record.
2383 if (NumPreprocessingRecords > 0) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002384 assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
2385
Douglas Gregoraae92242010-03-19 21:51:54 +00002386 // Write the offsets table for identifier IDs.
2387 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002388
2389 auto *Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002390 Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002391 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity
Douglas Gregoraae92242010-03-19 21:51:54 +00002392 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002393 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002394
Mehdi Amini57a41912015-09-10 01:46:39 +00002395 RecordData::value_type Record[] = {PPD_ENTITIES_OFFSETS,
2396 FirstPreprocessorEntityID -
2397 NUM_PREDEF_PP_ENTITY_IDS};
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002398 Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002399 bytes(PreprocessedEntityOffsets));
Douglas Gregoraae92242010-03-19 21:51:54 +00002400 }
Chris Lattnereeffaef2009-04-10 17:15:23 +00002401}
2402
Richard Smith386bb072015-08-18 23:42:23 +00002403unsigned ASTWriter::getLocalOrImportedSubmoduleID(Module *Mod) {
Richard Smith080056b2015-08-18 21:53:42 +00002404 if (!Mod)
2405 return 0;
2406
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002407 llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod);
2408 if (Known != SubmoduleIDs.end())
2409 return Known->second;
Richard Smith386bb072015-08-18 23:42:23 +00002410
2411 if (Mod->getTopLevelModule() != WritingModule)
2412 return 0;
2413
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002414 return SubmoduleIDs[Mod] = NextSubmoduleID++;
2415}
2416
Richard Smith386bb072015-08-18 23:42:23 +00002417unsigned ASTWriter::getSubmoduleID(Module *Mod) {
2418 // FIXME: This can easily happen, if we have a reference to a submodule that
2419 // did not result in us loading a module file for that submodule. For
2420 // instance, a cross-top-level-module 'conflict' declaration will hit this.
2421 unsigned ID = getLocalOrImportedSubmoduleID(Mod);
2422 assert((ID || !Mod) &&
2423 "asked for module ID for non-local, non-imported module");
2424 return ID;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002425}
2426
Douglas Gregor253eefe2011-12-01 00:59:36 +00002427/// \brief Compute the number of modules within the given tree (including the
2428/// given module).
2429static unsigned getNumberOfModules(Module *Mod) {
2430 unsigned ChildModules = 0;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002431 for (auto Sub = Mod->submodule_begin(), SubEnd = Mod->submodule_end();
Douglas Gregor253eefe2011-12-01 00:59:36 +00002432 Sub != SubEnd; ++Sub)
Douglas Gregoreb90e832012-01-04 23:32:19 +00002433 ChildModules += getNumberOfModules(*Sub);
Douglas Gregor253eefe2011-12-01 00:59:36 +00002434
2435 return ChildModules + 1;
2436}
2437
Douglas Gregorde3ef502011-11-30 23:21:26 +00002438void ASTWriter::WriteSubmodules(Module *WritingModule) {
Douglas Gregor69021972011-11-30 17:33:56 +00002439 // Enter the submodule description block.
Richard Smith202210b2014-10-24 20:23:01 +00002440 Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/5);
Douglas Gregor69021972011-11-30 17:33:56 +00002441
2442 // Write the abbreviations needed for the submodules block.
2443 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002444
2445 auto *Abbrev = new BitCodeAbbrev();
Douglas Gregor69021972011-11-30 17:33:56 +00002446 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002447 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor69021972011-11-30 17:33:56 +00002448 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
2449 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2450 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
Richard Smith9bca2982014-03-08 00:03:56 +00002451 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
2452 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
Douglas Gregora686e1b2012-01-27 19:52:33 +00002453 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
Douglas Gregor73441092011-12-05 22:27:44 +00002454 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
Douglas Gregor73441092011-12-05 22:27:44 +00002455 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002456 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
Douglas Gregor69021972011-11-30 17:33:56 +00002457 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2458 unsigned DefinitionAbbrev = Stream.EmitAbbrev(Abbrev);
2459
2460 Abbrev = new BitCodeAbbrev();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002461 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
Douglas Gregor69021972011-11-30 17:33:56 +00002462 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2463 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(Abbrev);
2464
2465 Abbrev = new BitCodeAbbrev();
2466 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
2467 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2468 unsigned HeaderAbbrev = Stream.EmitAbbrev(Abbrev);
Douglas Gregor524e33e2011-12-08 19:11:24 +00002469
2470 Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002471 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
2472 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2473 unsigned TopHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2474
2475 Abbrev = new BitCodeAbbrev();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002476 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
2477 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2478 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(Abbrev);
2479
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002480 Abbrev = new BitCodeAbbrev();
2481 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES));
Richard Smitha3feee22013-10-28 22:18:19 +00002482 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
2483 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Feature
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002484 unsigned RequiresAbbrev = Stream.EmitAbbrev(Abbrev);
2485
Douglas Gregor59527662012-10-15 06:28:11 +00002486 Abbrev = new BitCodeAbbrev();
2487 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
2488 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2489 unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2490
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002491 Abbrev = new BitCodeAbbrev();
Richard Smith306d8922014-10-22 23:50:56 +00002492 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
2493 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2494 unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2495
2496 Abbrev = new BitCodeAbbrev();
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002497 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
2498 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2499 unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2500
2501 Abbrev = new BitCodeAbbrev();
Richard Smith202210b2014-10-24 20:23:01 +00002502 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
2503 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2504 unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(Abbrev);
2505
2506 Abbrev = new BitCodeAbbrev();
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002507 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
2508 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2509 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
2510 unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(Abbrev);
2511
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002512 Abbrev = new BitCodeAbbrev();
2513 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
2514 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
2515 unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(Abbrev);
2516
Douglas Gregorfb912652013-03-20 21:10:35 +00002517 Abbrev = new BitCodeAbbrev();
2518 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT));
2519 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Other module
2520 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Message
2521 unsigned ConflictAbbrev = Stream.EmitAbbrev(Abbrev);
2522
Douglas Gregor253eefe2011-12-01 00:59:36 +00002523 // Write the submodule metadata block.
Mehdi Amini57a41912015-09-10 01:46:39 +00002524 RecordData::value_type Record[] = {getNumberOfModules(WritingModule),
2525 FirstSubmoduleID -
2526 NUM_PREDEF_SUBMODULE_IDS};
Douglas Gregor253eefe2011-12-01 00:59:36 +00002527 Stream.EmitRecord(SUBMODULE_METADATA, Record);
2528
Douglas Gregor69021972011-11-30 17:33:56 +00002529 // Write all of the submodules.
Douglas Gregorde3ef502011-11-30 23:21:26 +00002530 std::queue<Module *> Q;
Douglas Gregor69021972011-11-30 17:33:56 +00002531 Q.push(WritingModule);
Douglas Gregor69021972011-11-30 17:33:56 +00002532 while (!Q.empty()) {
Douglas Gregorde3ef502011-11-30 23:21:26 +00002533 Module *Mod = Q.front();
Douglas Gregor69021972011-11-30 17:33:56 +00002534 Q.pop();
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002535 unsigned ID = getSubmoduleID(Mod);
Mehdi Amini57a41912015-09-10 01:46:39 +00002536
2537 uint64_t ParentID = 0;
Douglas Gregor69021972011-11-30 17:33:56 +00002538 if (Mod->Parent) {
2539 assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
Mehdi Amini57a41912015-09-10 01:46:39 +00002540 ParentID = SubmoduleIDs[Mod->Parent];
Douglas Gregor69021972011-11-30 17:33:56 +00002541 }
Mehdi Amini57a41912015-09-10 01:46:39 +00002542
2543 // Emit the definition of the block.
2544 {
2545 RecordData::value_type Record[] = {
2546 SUBMODULE_DEFINITION, ID, ParentID, Mod->IsFramework, Mod->IsExplicit,
2547 Mod->IsSystem, Mod->IsExternC, Mod->InferSubmodules,
2548 Mod->InferExplicitSubmodules, Mod->InferExportWildcard,
2549 Mod->ConfigMacrosExhaustive};
2550 Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name);
2551 }
2552
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002553 // Emit the requirements.
Richard Smith080056b2015-08-18 21:53:42 +00002554 for (const auto &R : Mod->Requirements) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002555 RecordData::value_type Record[] = {SUBMODULE_REQUIRES, R.second};
Richard Smith080056b2015-08-18 21:53:42 +00002556 Stream.EmitRecordWithBlob(RequiresAbbrev, Record, R.first);
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002557 }
2558
Douglas Gregor69021972011-11-30 17:33:56 +00002559 // Emit the umbrella header, if there is one.
Richard Smith2b63d152015-05-16 02:28:53 +00002560 if (auto UmbrellaHeader = Mod->getUmbrellaHeader()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002561 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_HEADER};
Richard Smith2b63d152015-05-16 02:28:53 +00002562 Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
2563 UmbrellaHeader.NameAsWritten);
2564 } else if (auto UmbrellaDir = Mod->getUmbrellaDir()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002565 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_DIR};
2566 Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
Richard Smith2b63d152015-05-16 02:28:53 +00002567 UmbrellaDir.NameAsWritten);
Douglas Gregor69021972011-11-30 17:33:56 +00002568 }
Richard Smith306d8922014-10-22 23:50:56 +00002569
Douglas Gregor69021972011-11-30 17:33:56 +00002570 // Emit the headers.
Richard Smith202210b2014-10-24 20:23:01 +00002571 struct {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002572 unsigned RecordKind;
Richard Smith202210b2014-10-24 20:23:01 +00002573 unsigned Abbrev;
Richard Smith3c1a41a2014-12-02 00:08:08 +00002574 Module::HeaderKind HeaderKind;
Richard Smith202210b2014-10-24 20:23:01 +00002575 } HeaderLists[] = {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002576 {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal},
2577 {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual},
2578 {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private},
Richard Smith202210b2014-10-24 20:23:01 +00002579 {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev,
Richard Smith3c1a41a2014-12-02 00:08:08 +00002580 Module::HK_PrivateTextual},
2581 {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded}
Richard Smith202210b2014-10-24 20:23:01 +00002582 };
2583 for (auto &HL : HeaderLists) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002584 RecordData::value_type Record[] = {HL.RecordKind};
Richard Smith3c1a41a2014-12-02 00:08:08 +00002585 for (auto &H : Mod->Headers[HL.HeaderKind])
2586 Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten);
2587 }
2588
2589 // Emit the top headers.
2590 {
2591 auto TopHeaders = Mod->getTopHeaders(PP->getFileManager());
Mehdi Amini57a41912015-09-10 01:46:39 +00002592 RecordData::value_type Record[] = {SUBMODULE_TOPHEADER};
Richard Smith3c1a41a2014-12-02 00:08:08 +00002593 for (auto *H : TopHeaders)
2594 Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, H->getName());
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002595 }
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002596
2597 // Emit the imports.
2598 if (!Mod->Imports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002599 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00002600 for (auto *I : Mod->Imports)
2601 Record.push_back(getSubmoduleID(I));
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002602 Stream.EmitRecord(SUBMODULE_IMPORTS, Record);
2603 }
2604
Douglas Gregor24bb9232011-12-02 18:58:38 +00002605 // Emit the exports.
2606 if (!Mod->Exports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002607 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00002608 for (const auto &E : Mod->Exports) {
2609 // FIXME: This may fail; we don't require that all exported modules
2610 // are local or imported.
2611 Record.push_back(getSubmoduleID(E.getPointer()));
2612 Record.push_back(E.getInt());
Douglas Gregor24bb9232011-12-02 18:58:38 +00002613 }
2614 Stream.EmitRecord(SUBMODULE_EXPORTS, Record);
2615 }
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002616
Daniel Jasperba7f2f72013-09-24 09:14:14 +00002617 //FIXME: How do we emit the 'use'd modules? They may not be submodules.
2618 // Might be unnecessary as use declarations are only used to build the
2619 // module itself.
2620
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002621 // Emit the link libraries.
Richard Smith080056b2015-08-18 21:53:42 +00002622 for (const auto &LL : Mod->LinkLibraries) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002623 RecordData::value_type Record[] = {SUBMODULE_LINK_LIBRARY,
2624 LL.IsFramework};
Richard Smith080056b2015-08-18 21:53:42 +00002625 Stream.EmitRecordWithBlob(LinkLibraryAbbrev, Record, LL.Library);
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002626 }
2627
Douglas Gregorfb912652013-03-20 21:10:35 +00002628 // Emit the conflicts.
Richard Smith080056b2015-08-18 21:53:42 +00002629 for (const auto &C : Mod->Conflicts) {
Richard Smith080056b2015-08-18 21:53:42 +00002630 // FIXME: This may fail; we don't require that all conflicting modules
2631 // are local or imported.
Mehdi Amini57a41912015-09-10 01:46:39 +00002632 RecordData::value_type Record[] = {SUBMODULE_CONFLICT,
2633 getSubmoduleID(C.Other)};
Richard Smith080056b2015-08-18 21:53:42 +00002634 Stream.EmitRecordWithBlob(ConflictAbbrev, Record, C.Message);
Douglas Gregorfb912652013-03-20 21:10:35 +00002635 }
2636
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002637 // Emit the configuration macros.
Richard Smith080056b2015-08-18 21:53:42 +00002638 for (const auto &CM : Mod->ConfigMacros) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002639 RecordData::value_type Record[] = {SUBMODULE_CONFIG_MACRO};
Richard Smith080056b2015-08-18 21:53:42 +00002640 Stream.EmitRecordWithBlob(ConfigMacroAbbrev, Record, CM);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002641 }
2642
Douglas Gregor69021972011-11-30 17:33:56 +00002643 // Queue up the submodules of this module.
Richard Smith080056b2015-08-18 21:53:42 +00002644 for (auto *M : Mod->submodules())
2645 Q.push(M);
Douglas Gregor69021972011-11-30 17:33:56 +00002646 }
2647
2648 Stream.ExitBlock();
Richard Smith23d8d032015-05-14 00:45:20 +00002649
Richard Smith23d8d032015-05-14 00:45:20 +00002650 assert((NextSubmoduleID - FirstSubmoduleID ==
2651 getNumberOfModules(WritingModule)) &&
2652 "Wrong # of submodules; found a reference to a non-local, "
2653 "non-imported submodule?");
Douglas Gregor69021972011-11-30 17:33:56 +00002654}
2655
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002656serialization::SubmoduleID
2657ASTWriter::inferSubmoduleIDFromLocation(SourceLocation Loc) {
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002658 if (Loc.isInvalid() || !WritingModule)
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002659 return 0; // No submodule
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002660
2661 // Find the module that owns this location.
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002662 ModuleMap &ModMap = PP->getHeaderSearchInfo().getModuleMap();
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002663 Module *OwningMod
2664 = ModMap.inferModuleFromLocation(FullSourceLoc(Loc,PP->getSourceManager()));
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002665 if (!OwningMod)
2666 return 0;
2667
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002668 // Check whether this submodule is part of our own module.
2669 if (WritingModule != OwningMod && !OwningMod->isSubModuleOf(WritingModule))
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002670 return 0;
2671
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002672 return getSubmoduleID(OwningMod);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00002673}
2674
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00002675void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
2676 bool isModule) {
2677 // Make sure set diagnostic pragmas don't affect the translation unit that
2678 // imports the module.
2679 // FIXME: Make diagnostic pragma sections work properly with modules.
2680 if (isModule)
2681 return;
2682
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002683 llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64>
2684 DiagStateIDMap;
2685 unsigned CurrID = 0;
2686 DiagStateIDMap[&Diag.DiagStates.front()] = ++CurrID; // the command-line one.
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002687 RecordData Record;
David Blaikie9c902b52011-09-25 23:23:43 +00002688 for (DiagnosticsEngine::DiagStatePointsTy::const_iterator
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002689 I = Diag.DiagStatePoints.begin(), E = Diag.DiagStatePoints.end();
2690 I != E; ++I) {
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002691 const DiagnosticsEngine::DiagStatePoint &point = *I;
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002692 if (point.Loc.isInvalid())
2693 continue;
2694
Richard Smithb22a1d12016-03-27 20:13:24 +00002695 AddSourceLocation(point.Loc, Record);
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002696 unsigned &DiagStateID = DiagStateIDMap[point.State];
2697 Record.push_back(DiagStateID);
2698
2699 if (DiagStateID == 0) {
2700 DiagStateID = ++CurrID;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002701 for (const auto &I : *(point.State)) {
2702 if (I.second.isPragma()) {
2703 Record.push_back(I.first);
2704 Record.push_back((unsigned)I.second.getSeverity());
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002705 }
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002706 }
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002707 Record.push_back(-1); // mark the end of the diag/map pairs for this
2708 // location.
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002709 }
2710 }
2711
Argyrios Kyrtzidisb0ca9eb2010-11-05 22:20:49 +00002712 if (!Record.empty())
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002713 Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002714}
2715
Richard Smithc2bb8182015-03-24 06:36:48 +00002716void ASTWriter::WriteCXXCtorInitializersOffsets() {
2717 if (CXXCtorInitializersOffsets.empty())
2718 return;
2719
Richard Smithc2bb8182015-03-24 06:36:48 +00002720 // Create a blob abbreviation for the C++ ctor initializer offsets.
2721 using namespace llvm;
2722
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002723 auto *Abbrev = new BitCodeAbbrev();
Richard Smithc2bb8182015-03-24 06:36:48 +00002724 Abbrev->Add(BitCodeAbbrevOp(CXX_CTOR_INITIALIZERS_OFFSETS));
2725 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
2726 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2727 unsigned CtorInitializersOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2728
2729 // Write the base specifier offsets table.
Mehdi Amini57a41912015-09-10 01:46:39 +00002730 RecordData::value_type Record[] = {CXX_CTOR_INITIALIZERS_OFFSETS,
2731 CXXCtorInitializersOffsets.size()};
Richard Smithc2bb8182015-03-24 06:36:48 +00002732 Stream.EmitRecordWithBlob(CtorInitializersOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002733 bytes(CXXCtorInitializersOffsets));
Richard Smithc2bb8182015-03-24 06:36:48 +00002734}
2735
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002736void ASTWriter::WriteCXXBaseSpecifiersOffsets() {
2737 if (CXXBaseSpecifiersOffsets.empty())
2738 return;
2739
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002740 // Create a blob abbreviation for the C++ base specifiers offsets.
2741 using namespace llvm;
2742
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002743 auto *Abbrev = new BitCodeAbbrev();
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002744 Abbrev->Add(BitCodeAbbrevOp(CXX_BASE_SPECIFIER_OFFSETS));
2745 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
2746 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2747 unsigned BaseSpecifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
2748
Douglas Gregorc27b2872011-08-04 00:01:48 +00002749 // Write the base specifier offsets table.
Mehdi Amini57a41912015-09-10 01:46:39 +00002750 RecordData::value_type Record[] = {CXX_BASE_SPECIFIER_OFFSETS,
2751 CXXBaseSpecifiersOffsets.size()};
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002752 Stream.EmitRecordWithBlob(BaseSpecifierOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002753 bytes(CXXBaseSpecifiersOffsets));
Anders Carlsson9bb83e82011-03-06 18:41:18 +00002754}
2755
Douglas Gregorc5046832009-04-27 18:38:38 +00002756//===----------------------------------------------------------------------===//
2757// Type Serialization
2758//===----------------------------------------------------------------------===//
Chris Lattnereeffaef2009-04-10 17:15:23 +00002759
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002760/// \brief Write the representation of a type to the AST stream.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002761void ASTWriter::WriteType(QualType T) {
Argyrios Kyrtzidisa7fbbb02010-08-20 16:04:04 +00002762 TypeIdx &Idx = TypeIdxs[T];
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00002763 if (Idx.getIndex() == 0) // we haven't seen this type before.
2764 Idx = TypeIdx(NextTypeID++);
Mike Stump11289f42009-09-09 15:08:12 +00002765
Douglas Gregor9b3932c2010-10-05 18:37:06 +00002766 assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
Douglas Gregordc72caa2010-10-04 18:21:45 +00002767
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002768 RecordData Record;
Mike Stump11289f42009-09-09 15:08:12 +00002769
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002770 // Emit the type's representation.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002771 ASTTypeWriter W(*this, Record);
Richard Smith5811c402016-04-06 06:26:08 +00002772 W.Visit(T);
2773 uint64_t Offset = W.Emit();
John McCall8ccfcb52009-09-24 19:53:00 +00002774
Richard Smith5811c402016-04-06 06:26:08 +00002775 // Record the offset for this type.
2776 unsigned Index = Idx.getIndex() - FirstTypeID;
2777 if (TypeOffsets.size() == Index)
2778 TypeOffsets.push_back(Offset);
2779 else if (TypeOffsets.size() < Index) {
2780 TypeOffsets.resize(Index + 1);
2781 TypeOffsets[Index] = Offset;
John McCall8ccfcb52009-09-24 19:53:00 +00002782 } else {
Richard Smith5811c402016-04-06 06:26:08 +00002783 llvm_unreachable("Types emitted in wrong order");
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002784 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002785}
2786
Douglas Gregorc5046832009-04-27 18:38:38 +00002787//===----------------------------------------------------------------------===//
2788// Declaration Serialization
2789//===----------------------------------------------------------------------===//
2790
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002791/// \brief Write the block containing all of the declaration IDs
2792/// lexically declared within the given DeclContext.
2793///
2794/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
2795/// bistream, or 0 if no block was written.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002796uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002797 DeclContext *DC) {
Argyrios Kyrtzidiscfbfe782009-06-30 02:36:12 +00002798 if (DC->decls_empty())
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002799 return 0;
2800
Douglas Gregor8f45df52009-04-16 22:23:12 +00002801 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smith82f8fcd2015-08-06 22:07:25 +00002802 SmallVector<uint32_t, 128> KindDeclPairs;
2803 for (const auto *D : DC->decls()) {
2804 KindDeclPairs.push_back(D->getKind());
2805 KindDeclPairs.push_back(GetDeclRef(D));
2806 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002807
Douglas Gregora57c3ab2009-04-22 22:34:57 +00002808 ++NumLexicalDeclContexts;
Mehdi Amini57a41912015-09-10 01:46:39 +00002809 RecordData::value_type Record[] = {DECL_CONTEXT_LEXICAL};
Richard Smith82f8fcd2015-08-06 22:07:25 +00002810 Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record,
2811 bytes(KindDeclPairs));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002812 return Offset;
2813}
2814
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002815void ASTWriter::WriteTypeDeclOffsets() {
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002816 using namespace llvm;
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002817
2818 // Write the type offsets array
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002819 auto *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00002820 Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002821 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
Douglas Gregor5204bde2011-08-02 16:26:37 +00002822 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002823 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
2824 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
Mehdi Amini57a41912015-09-10 01:46:39 +00002825 {
2826 RecordData::value_type Record[] = {TYPE_OFFSET, TypeOffsets.size(),
2827 FirstTypeID - NUM_PREDEF_TYPE_IDS};
2828 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, bytes(TypeOffsets));
2829 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002830
2831 // Write the declaration offsets array
2832 Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00002833 Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002834 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
Douglas Gregorf7180622011-08-03 15:48:04 +00002835 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002836 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
2837 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
Mehdi Amini57a41912015-09-10 01:46:39 +00002838 {
2839 RecordData::value_type Record[] = {DECL_OFFSET, DeclOffsets.size(),
2840 FirstDeclID - NUM_PREDEF_DECL_IDS};
2841 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, bytes(DeclOffsets));
2842 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00002843}
2844
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002845void ASTWriter::WriteFileDeclIDsMap() {
2846 using namespace llvm;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002847
Chandler Carruthb306d732015-03-27 00:31:20 +00002848 SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs(
2849 FileDeclIDs.begin(), FileDeclIDs.end());
2850 std::sort(SortedFileDeclIDs.begin(), SortedFileDeclIDs.end(),
2851 llvm::less_first());
2852
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002853 // Join the vectors of DeclIDs from all files.
Chandler Carruthb306d732015-03-27 00:31:20 +00002854 SmallVector<DeclID, 256> FileGroupedDeclIDs;
2855 for (auto &FileDeclEntry : SortedFileDeclIDs) {
2856 DeclIDInFileInfo &Info = *FileDeclEntry.second;
2857 Info.FirstDeclIndex = FileGroupedDeclIDs.size();
2858 for (auto &LocDeclEntry : Info.DeclIDs)
2859 FileGroupedDeclIDs.push_back(LocDeclEntry.second);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002860 }
2861
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002862 auto *Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002863 Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
Argyrios Kyrtzidis10e78462012-10-02 21:09:13 +00002864 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002865 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2866 unsigned AbbrevCode = Stream.EmitAbbrev(Abbrev);
Mehdi Amini57a41912015-09-10 01:46:39 +00002867 RecordData::value_type Record[] = {FILE_SORTED_DECLS,
2868 FileGroupedDeclIDs.size()};
Reid Kleckner012665e2015-05-21 00:13:09 +00002869 Stream.EmitRecordWithBlob(AbbrevCode, Record, bytes(FileGroupedDeclIDs));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002870}
2871
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002872void ASTWriter::WriteComments() {
2873 Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3);
Dmitri Gribenko7dd29d42012-07-06 18:19:34 +00002874 ArrayRef<RawComment *> RawComments = Context->Comments.getComments();
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002875 RecordData Record;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002876 for (const auto *I : RawComments) {
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002877 Record.clear();
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002878 AddSourceRange(I->getSourceRange(), Record);
2879 Record.push_back(I->getKind());
2880 Record.push_back(I->isTrailingComment());
2881 Record.push_back(I->isAlmostTrailingComment());
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00002882 Stream.EmitRecord(COMMENTS_RAW_COMMENT, Record);
2883 }
2884 Stream.ExitBlock();
2885}
2886
Douglas Gregorc5046832009-04-27 18:38:38 +00002887//===----------------------------------------------------------------------===//
2888// Global Method Pool and Selector Serialization
2889//===----------------------------------------------------------------------===//
2890
Douglas Gregore84a9da2009-04-20 20:36:09 +00002891namespace {
Douglas Gregorc78d3462009-04-24 21:10:55 +00002892// Trait used for the on-disk hash table used in the method pool.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002893class ASTMethodPoolTrait {
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002894 ASTWriter &Writer;
Douglas Gregorc78d3462009-04-24 21:10:55 +00002895
2896public:
2897 typedef Selector key_type;
2898 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00002899
Sebastian Redl834bb972010-08-04 17:20:04 +00002900 struct data_type {
Sebastian Redl539c5062010-08-18 23:57:32 +00002901 SelectorID ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00002902 ObjCMethodList Instance, Factory;
2903 };
Douglas Gregorc78d3462009-04-24 21:10:55 +00002904 typedef const data_type& data_type_ref;
2905
Justin Bogner25463f12014-04-18 20:27:24 +00002906 typedef unsigned hash_value_type;
2907 typedef unsigned offset_type;
2908
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002909 explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) { }
Mike Stump11289f42009-09-09 15:08:12 +00002910
Justin Bogner25463f12014-04-18 20:27:24 +00002911 static hash_value_type ComputeHash(Selector Sel) {
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +00002912 return serialization::ComputeHash(Sel);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002913 }
Mike Stump11289f42009-09-09 15:08:12 +00002914
2915 std::pair<unsigned,unsigned>
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002916 EmitKeyDataLength(raw_ostream& Out, Selector Sel,
Douglas Gregorc78d3462009-04-24 21:10:55 +00002917 data_type_ref Methods) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002918 using namespace llvm::support;
2919 endian::Writer<little> LE(Out);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002920 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
Justin Bognere1c147c2014-03-28 22:03:19 +00002921 LE.write<uint16_t>(KeyLen);
Sebastian Redl834bb972010-08-04 17:20:04 +00002922 unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
2923 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002924 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002925 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002926 DataLen += 4;
Sebastian Redl834bb972010-08-04 17:20:04 +00002927 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002928 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002929 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002930 DataLen += 4;
Justin Bognere1c147c2014-03-28 22:03:19 +00002931 LE.write<uint16_t>(DataLen);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002932 return std::make_pair(KeyLen, DataLen);
2933 }
Mike Stump11289f42009-09-09 15:08:12 +00002934
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002935 void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002936 using namespace llvm::support;
2937 endian::Writer<little> LE(Out);
Mike Stump11289f42009-09-09 15:08:12 +00002938 uint64_t Start = Out.tell();
Douglas Gregor95c13f52009-04-25 17:48:32 +00002939 assert((Start >> 32) == 0 && "Selector key offset too large");
2940 Writer.SetSelectorOffset(Sel, Start);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002941 unsigned N = Sel.getNumArgs();
Justin Bognere1c147c2014-03-28 22:03:19 +00002942 LE.write<uint16_t>(N);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002943 if (N == 0)
2944 N = 1;
2945 for (unsigned I = 0; I != N; ++I)
Justin Bognere1c147c2014-03-28 22:03:19 +00002946 LE.write<uint32_t>(
2947 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
Douglas Gregorc78d3462009-04-24 21:10:55 +00002948 }
Mike Stump11289f42009-09-09 15:08:12 +00002949
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002950 void EmitData(raw_ostream& Out, key_type_ref,
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002951 data_type_ref Methods, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002952 using namespace llvm::support;
2953 endian::Writer<little> LE(Out);
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002954 uint64_t Start = Out.tell(); (void)Start;
Justin Bognere1c147c2014-03-28 22:03:19 +00002955 LE.write<uint32_t>(Methods.ID);
Douglas Gregorc78d3462009-04-24 21:10:55 +00002956 unsigned NumInstanceMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00002957 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002958 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002959 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002960 ++NumInstanceMethods;
2961
2962 unsigned NumFactoryMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00002963 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002964 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002965 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00002966 ++NumFactoryMethods;
2967
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002968 unsigned InstanceBits = Methods.Instance.getBits();
2969 assert(InstanceBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00002970 unsigned InstanceHasMoreThanOneDeclBit =
2971 Methods.Instance.hasMoreThanOneDecl();
2972 unsigned FullInstanceBits = (NumInstanceMethods << 3) |
2973 (InstanceHasMoreThanOneDeclBit << 2) |
2974 InstanceBits;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002975 unsigned FactoryBits = Methods.Factory.getBits();
2976 assert(FactoryBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00002977 unsigned FactoryHasMoreThanOneDeclBit =
2978 Methods.Factory.hasMoreThanOneDecl();
2979 unsigned FullFactoryBits = (NumFactoryMethods << 3) |
2980 (FactoryHasMoreThanOneDeclBit << 2) |
2981 FactoryBits;
2982 LE.write<uint16_t>(FullInstanceBits);
2983 LE.write<uint16_t>(FullFactoryBits);
Sebastian Redl834bb972010-08-04 17:20:04 +00002984 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002985 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002986 if (Method->getMethod())
2987 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Sebastian Redl834bb972010-08-04 17:20:04 +00002988 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00002989 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00002990 if (Method->getMethod())
2991 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Douglas Gregor4647cfa2009-04-24 21:49:02 +00002992
2993 assert(Out.tell() - Start == DataLen && "Data length is wrong");
Douglas Gregorc78d3462009-04-24 21:10:55 +00002994 }
2995};
2996} // end anonymous namespace
2997
Sebastian Redla19a67f2010-08-03 21:58:15 +00002998/// \brief Write ObjC data: selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00002999///
3000/// The method pool contains both instance and factory methods, stored
Sebastian Redla19a67f2010-08-03 21:58:15 +00003001/// in an on-disk hash table indexed by the selector. The hash table also
3002/// contains an empty entry for every other selector known to Sema.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003003void ASTWriter::WriteSelectors(Sema &SemaRef) {
Douglas Gregorc78d3462009-04-24 21:10:55 +00003004 using namespace llvm;
3005
Sebastian Redla19a67f2010-08-03 21:58:15 +00003006 // Do we have to do anything at all?
Sebastian Redl834bb972010-08-04 17:20:04 +00003007 if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
Sebastian Redla19a67f2010-08-03 21:58:15 +00003008 return;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003009 unsigned NumTableEntries = 0;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003010 // Create and write out the blob that contains selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00003011 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003012 llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003013 ASTMethodPoolTrait Trait(*this);
Mike Stump11289f42009-09-09 15:08:12 +00003014
Sebastian Redla19a67f2010-08-03 21:58:15 +00003015 // Create the on-disk hash table representation. We walk through every
3016 // selector we've seen and look it up in the method pool.
Sebastian Redld95a56e2010-08-04 18:21:41 +00003017 SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003018 for (auto &SelectorAndID : SelectorIDs) {
3019 Selector S = SelectorAndID.first;
3020 SelectorID ID = SelectorAndID.second;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003021 Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003022 ASTMethodPoolTrait::data_type Data = {
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003023 ID,
Sebastian Redl834bb972010-08-04 17:20:04 +00003024 ObjCMethodList(),
3025 ObjCMethodList()
3026 };
3027 if (F != SemaRef.MethodPool.end()) {
3028 Data.Instance = F->second.first;
3029 Data.Factory = F->second.second;
3030 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003031 // Only write this selector if it's not in an existing AST or something
Sebastian Redld95a56e2010-08-04 18:21:41 +00003032 // changed.
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003033 if (Chain && ID < FirstSelectorID) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00003034 // Selector already exists. Did it change?
3035 bool changed = false;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003036 for (ObjCMethodList *M = &Data.Instance;
3037 !changed && M && M->getMethod(); M = M->getNext()) {
3038 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003039 changed = true;
3040 }
Nico Weber2e0c8f72014-12-27 03:58:08 +00003041 for (ObjCMethodList *M = &Data.Factory; !changed && M && M->getMethod();
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003042 M = M->getNext()) {
Nico Weber2e0c8f72014-12-27 03:58:08 +00003043 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003044 changed = true;
3045 }
3046 if (!changed)
3047 continue;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003048 } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) {
Sebastian Redl6e1a2a02010-08-04 21:22:45 +00003049 // A new method pool entry.
3050 ++NumTableEntries;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003051 }
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003052 Generator.insert(S, Data, Trait);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003053 }
3054
Douglas Gregorc78d3462009-04-24 21:10:55 +00003055 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003056 SmallString<4096> MethodPool;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003057 uint32_t BucketOffset;
3058 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003059 using namespace llvm::support;
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003060 ASTMethodPoolTrait Trait(*this);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003061 llvm::raw_svector_ostream Out(MethodPool);
3062 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003063 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003064 BucketOffset = Generator.Emit(Out, Trait);
3065 }
3066
3067 // Create a blob abbreviation
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003068 auto *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003069 Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003070 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003071 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003072 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3073 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(Abbrev);
3074
Douglas Gregor95c13f52009-04-25 17:48:32 +00003075 // Write the method pool
Mehdi Amini57a41912015-09-10 01:46:39 +00003076 {
3077 RecordData::value_type Record[] = {METHOD_POOL, BucketOffset,
3078 NumTableEntries};
3079 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool);
3080 }
Douglas Gregor95c13f52009-04-25 17:48:32 +00003081
3082 // Create a blob abbreviation for the selector table offsets.
3083 Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003084 Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
Douglas Gregord4c5ed02010-10-29 22:39:52 +00003085 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
Douglas Gregor8f364fb2011-08-03 23:28:44 +00003086 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor95c13f52009-04-25 17:48:32 +00003087 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3088 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
3089
3090 // Write the selector offsets table.
Mehdi Amini57a41912015-09-10 01:46:39 +00003091 {
3092 RecordData::value_type Record[] = {
3093 SELECTOR_OFFSETS, SelectorOffsets.size(),
3094 FirstSelectorID - NUM_PREDEF_SELECTOR_IDS};
3095 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
3096 bytes(SelectorOffsets));
3097 }
Douglas Gregorc78d3462009-04-24 21:10:55 +00003098 }
3099}
3100
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003101/// \brief Write the selectors referenced in @selector expression into AST file.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003102void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003103 using namespace llvm;
3104 if (SemaRef.ReferencedSelectors.empty())
3105 return;
Sebastian Redlada023c2010-08-04 20:40:17 +00003106
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003107 RecordData Record;
Sebastian Redlada023c2010-08-04 20:40:17 +00003108
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003109 // Note: this writes out all references even for a dependent AST. But it is
Sebastian Redl51c79d82010-08-04 22:21:29 +00003110 // very tricky to fix, and given that @selector shouldn't really appear in
3111 // headers, probably not worth it. It's not a correctness issue.
Chandler Carruth12c8f652015-03-27 00:55:05 +00003112 for (auto &SelectorAndLocation : SemaRef.ReferencedSelectors) {
3113 Selector Sel = SelectorAndLocation.first;
3114 SourceLocation Loc = SelectorAndLocation.second;
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003115 AddSelectorRef(Sel, Record);
3116 AddSourceLocation(Loc, Record);
3117 }
Sebastian Redl539c5062010-08-18 23:57:32 +00003118 Stream.EmitRecord(REFERENCED_SELECTOR_POOL, Record);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003119}
3120
Douglas Gregorc5046832009-04-27 18:38:38 +00003121//===----------------------------------------------------------------------===//
3122// Identifier Table Serialization
3123//===----------------------------------------------------------------------===//
3124
Richard Smithb3761912015-02-05 23:08:52 +00003125/// Determine the declaration that should be put into the name lookup table to
3126/// represent the given declaration in this module. This is usually D itself,
3127/// but if D was imported and merged into a local declaration, we want the most
3128/// recent local declaration instead. The chosen declaration will be the most
3129/// recent declaration in any module that imports this one.
3130static NamedDecl *getDeclForLocalLookup(const LangOptions &LangOpts,
3131 NamedDecl *D) {
3132 if (!LangOpts.Modules || !D->isFromASTFile())
3133 return D;
3134
3135 if (Decl *Redecl = D->getPreviousDecl()) {
3136 // For Redeclarable decls, a prior declaration might be local.
3137 for (; Redecl; Redecl = Redecl->getPreviousDecl()) {
3138 if (!Redecl->isFromASTFile())
3139 return cast<NamedDecl>(Redecl);
Richard Smithfe620d22015-03-05 23:24:12 +00003140 // If we find a decl from a (chained-)PCH stop since we won't find a
Richard Smithb3761912015-02-05 23:08:52 +00003141 // local one.
3142 if (D->getOwningModuleID() == 0)
3143 break;
3144 }
3145 } else if (Decl *First = D->getCanonicalDecl()) {
3146 // For Mergeable decls, the first decl might be local.
3147 if (!First->isFromASTFile())
3148 return cast<NamedDecl>(First);
3149 }
3150
3151 // All declarations are imported. Our most recent declaration will also be
3152 // the most recent one in anyone who imports us.
3153 return D;
3154}
3155
Douglas Gregorc78d3462009-04-24 21:10:55 +00003156namespace {
Richard Smithcf97cf62015-04-19 01:34:23 +00003157class ASTIdentifierTableTrait {
3158 ASTWriter &Writer;
3159 Preprocessor &PP;
3160 IdentifierResolver &IdResolver;
Richard Smith9c254182015-07-19 21:41:12 +00003161 bool IsModule;
Richard Smitha534a312015-07-21 23:54:07 +00003162 bool NeedDecls;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003163 ASTWriter::RecordData *InterestingIdentifierOffsets;
Richard Smithcf97cf62015-04-19 01:34:23 +00003164
3165 /// \brief Determines whether this is an "interesting" identifier that needs a
3166 /// full IdentifierInfo structure written into the hash table. Notably, this
3167 /// doesn't check whether the name has macros defined; use PublicMacroIterator
3168 /// to check that.
Richard Smith9c254182015-07-19 21:41:12 +00003169 bool isInterestingIdentifier(const IdentifierInfo *II, uint64_t MacroOffset) {
Richard Smithd7329392015-04-21 21:46:32 +00003170 if (MacroOffset ||
3171 II->isPoisoned() ||
Richard Smith9c254182015-07-19 21:41:12 +00003172 (IsModule ? II->hasRevertedBuiltin() : II->getObjCOrBuiltinID()) ||
Richard Smithcf97cf62015-04-19 01:34:23 +00003173 II->hasRevertedTokenIDToIdentifier() ||
Richard Smitha534a312015-07-21 23:54:07 +00003174 (NeedDecls && II->getFETokenInfo<void>()))
Richard Smithcf97cf62015-04-19 01:34:23 +00003175 return true;
3176
3177 return false;
3178 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003179
Douglas Gregore84a9da2009-04-20 20:36:09 +00003180public:
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003181 typedef IdentifierInfo* key_type;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003182 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00003183
Sebastian Redl539c5062010-08-18 23:57:32 +00003184 typedef IdentID data_type;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003185 typedef data_type data_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00003186
Justin Bogner25463f12014-04-18 20:27:24 +00003187 typedef unsigned hash_value_type;
3188 typedef unsigned offset_type;
3189
Richard Smithd7329392015-04-21 21:46:32 +00003190 ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
Richard Smith33e0f7e2015-07-22 02:08:40 +00003191 IdentifierResolver &IdResolver, bool IsModule,
3192 ASTWriter::RecordData *InterestingIdentifierOffsets)
Richard Smitha534a312015-07-21 23:54:07 +00003193 : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule),
Richard Smith33e0f7e2015-07-22 02:08:40 +00003194 NeedDecls(!IsModule || !Writer.getLangOpts().CPlusPlus),
3195 InterestingIdentifierOffsets(InterestingIdentifierOffsets) {}
Douglas Gregore84a9da2009-04-20 20:36:09 +00003196
Richard Smithd79514e2016-02-05 19:03:40 +00003197 bool needDecls() const { return NeedDecls; }
3198
Justin Bogner25463f12014-04-18 20:27:24 +00003199 static hash_value_type ComputeHash(const IdentifierInfo* II) {
Daniel Dunbarf8502d52009-10-17 23:52:28 +00003200 return llvm::HashString(II->getName());
Douglas Gregore84a9da2009-04-20 20:36:09 +00003201 }
Mike Stump11289f42009-09-09 15:08:12 +00003202
Richard Smith33e0f7e2015-07-22 02:08:40 +00003203 bool isInterestingIdentifier(const IdentifierInfo *II) {
3204 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3205 return isInterestingIdentifier(II, MacroOffset);
3206 }
Richard Smith9c254182015-07-19 21:41:12 +00003207 bool isInterestingNonMacroIdentifier(const IdentifierInfo *II) {
3208 return isInterestingIdentifier(II, 0);
3209 }
3210
Mike Stump11289f42009-09-09 15:08:12 +00003211 std::pair<unsigned,unsigned>
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003212 EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) {
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003213 unsigned KeyLen = II->getLength() + 1;
Douglas Gregor1d583f22009-04-28 21:18:29 +00003214 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
Richard Smithd7329392015-04-21 21:46:32 +00003215 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3216 if (isInterestingIdentifier(II, MacroOffset)) {
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003217 DataLen += 2; // 2 bytes for builtin ID
3218 DataLen += 2; // 2 bytes for flags
Richard Smithd7329392015-04-21 21:46:32 +00003219 if (MacroOffset)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003220 DataLen += 4; // MacroDirectives offset.
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003221
Richard Smitha534a312015-07-21 23:54:07 +00003222 if (NeedDecls) {
3223 for (IdentifierResolver::iterator D = IdResolver.begin(II),
3224 DEnd = IdResolver.end();
3225 D != DEnd; ++D)
3226 DataLen += 4;
3227 }
Douglas Gregor1d583f22009-04-28 21:18:29 +00003228 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003229 using namespace llvm::support;
3230 endian::Writer<little> LE(Out);
3231
Richard Smithdf8a8312015-03-13 04:05:01 +00003232 assert((uint16_t)DataLen == DataLen && (uint16_t)KeyLen == KeyLen);
Justin Bognere1c147c2014-03-28 22:03:19 +00003233 LE.write<uint16_t>(DataLen);
Douglas Gregorab4df582009-04-28 20:01:51 +00003234 // We emit the key length after the data length so that every
3235 // string is preceded by a 16-bit length. This matches the PTH
3236 // format for storing identifiers.
Justin Bognere1c147c2014-03-28 22:03:19 +00003237 LE.write<uint16_t>(KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003238 return std::make_pair(KeyLen, DataLen);
3239 }
Mike Stump11289f42009-09-09 15:08:12 +00003240
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003241 void EmitKey(raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregore84a9da2009-04-20 20:36:09 +00003242 unsigned KeyLen) {
3243 // Record the location of the key data. This is used when generating
3244 // the mapping from persistent IDs to strings.
3245 Writer.SetIdentifierOffset(II, Out.tell());
Richard Smith33e0f7e2015-07-22 02:08:40 +00003246
3247 // Emit the offset of the key/data length information to the interesting
3248 // identifiers table if necessary.
3249 if (InterestingIdentifierOffsets && isInterestingIdentifier(II))
3250 InterestingIdentifierOffsets->push_back(Out.tell() - 4);
3251
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003252 Out.write(II->getNameStart(), KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003253 }
Mike Stump11289f42009-09-09 15:08:12 +00003254
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003255 void EmitData(raw_ostream& Out, IdentifierInfo* II,
Sebastian Redl539c5062010-08-18 23:57:32 +00003256 IdentID ID, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003257 using namespace llvm::support;
3258 endian::Writer<little> LE(Out);
Richard Smithcf97cf62015-04-19 01:34:23 +00003259
Richard Smithd7329392015-04-21 21:46:32 +00003260 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3261 if (!isInterestingIdentifier(II, MacroOffset)) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003262 LE.write<uint32_t>(ID << 1);
Douglas Gregor1d583f22009-04-28 21:18:29 +00003263 return;
3264 }
Douglas Gregorb9256522009-04-28 21:32:13 +00003265
Justin Bognere1c147c2014-03-28 22:03:19 +00003266 LE.write<uint32_t>((ID << 1) | 0x01);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003267 uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID();
3268 assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
Justin Bognere1c147c2014-03-28 22:03:19 +00003269 LE.write<uint16_t>(Bits);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003270 Bits = 0;
Richard Smithd7329392015-04-21 21:46:32 +00003271 bool HadMacroDefinition = MacroOffset != 0;
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003272 Bits = (Bits << 1) | unsigned(HadMacroDefinition);
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003273 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
3274 Bits = (Bits << 1) | unsigned(II->isPoisoned());
Richard Smith9c254182015-07-19 21:41:12 +00003275 Bits = (Bits << 1) | unsigned(II->hasRevertedBuiltin());
Argyrios Kyrtzidis3084a612010-08-11 22:55:12 +00003276 Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003277 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
Justin Bognere1c147c2014-03-28 22:03:19 +00003278 LE.write<uint16_t>(Bits);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003279
Richard Smithd7329392015-04-21 21:46:32 +00003280 if (HadMacroDefinition)
3281 LE.write<uint32_t>(MacroOffset);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003282
Richard Smitha534a312015-07-21 23:54:07 +00003283 if (NeedDecls) {
3284 // Emit the declaration IDs in reverse order, because the
3285 // IdentifierResolver provides the declarations as they would be
3286 // visible (e.g., the function "stat" would come before the struct
3287 // "stat"), but the ASTReader adds declarations to the end of the list
3288 // (so we need to see the struct "stat" before the function "stat").
3289 // Only emit declarations that aren't from a chained PCH, though.
3290 SmallVector<NamedDecl *, 16> Decls(IdResolver.begin(II),
3291 IdResolver.end());
3292 for (SmallVectorImpl<NamedDecl *>::reverse_iterator D = Decls.rbegin(),
3293 DEnd = Decls.rend();
3294 D != DEnd; ++D)
3295 LE.write<uint32_t>(
3296 Writer.getDeclID(getDeclForLocalLookup(PP.getLangOpts(), *D)));
3297 }
Douglas Gregore84a9da2009-04-20 20:36:09 +00003298 }
3299};
3300} // end anonymous namespace
3301
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003302/// \brief Write the identifier table into the AST file.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003303///
3304/// The identifier table consists of a blob containing string data
3305/// (the actual identifiers themselves) and a separate "offsets" index
3306/// that maps identifier IDs to locations within the blob.
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003307void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
3308 IdentifierResolver &IdResolver,
3309 bool IsModule) {
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003310 using namespace llvm;
3311
Richard Smith33e0f7e2015-07-22 02:08:40 +00003312 RecordData InterestingIdents;
3313
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003314 // Create and write out the blob that contains the identifier
3315 // strings.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003316 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003317 llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003318 ASTIdentifierTableTrait Trait(
3319 *this, PP, IdResolver, IsModule,
3320 (getLangOpts().CPlusPlus && IsModule) ? &InterestingIdents : nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003321
Douglas Gregore6648fb2009-04-28 20:33:11 +00003322 // Look for any identifiers that were named while processing the
3323 // headers, but are otherwise not needed. We add these to the hash
3324 // table to enable checking of the predefines buffer in the case
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003325 // where the user adds new macro definitions when building the AST
Douglas Gregore6648fb2009-04-28 20:33:11 +00003326 // file.
Chandler Carruth8440c982015-03-26 23:54:15 +00003327 SmallVector<const IdentifierInfo *, 128> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003328 for (const auto &ID : PP.getIdentifierTable())
3329 IIs.push_back(ID.second);
Chandler Carruth8440c982015-03-26 23:54:15 +00003330 // Sort the identifiers lexicographically before getting them references so
3331 // that their order is stable.
3332 std::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>());
3333 for (const IdentifierInfo *II : IIs)
Richard Smith9c254182015-07-19 21:41:12 +00003334 if (Trait.isInterestingNonMacroIdentifier(II))
3335 getIdentifierRef(II);
Douglas Gregore6648fb2009-04-28 20:33:11 +00003336
Sebastian Redlff4a2952010-07-23 23:49:55 +00003337 // Create the on-disk hash table representation. We only store offsets
3338 // for identifiers that appear here for the first time.
3339 IdentifierOffsets.resize(NextIdentID - FirstIdentID);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003340 for (auto IdentIDPair : IdentifierIDs) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003341 auto *II = const_cast<IdentifierInfo *>(IdentIDPair.first);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003342 IdentID ID = IdentIDPair.second;
3343 assert(II && "NULL identifier in identifier table");
Vassil Vassilev262f41e2016-03-30 20:16:03 +00003344 // Write out identifiers if either the ID is local or the identifier has
3345 // changed since it was loaded.
3346 if (ID >= FirstIdentID || !Chain || !II->isFromAST()
3347 || II->hasChangedSinceDeserialization() ||
Richard Smithd79514e2016-02-05 19:03:40 +00003348 (Trait.needDecls() &&
3349 II->hasFETokenInfoChangedSinceDeserialization()))
Chandler Carruth885e78c2015-03-24 21:18:10 +00003350 Generator.insert(II, ID, Trait);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003351 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003352
Douglas Gregore84a9da2009-04-20 20:36:09 +00003353 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003354 SmallString<4096> IdentifierTable;
Douglas Gregora868bbd2009-04-21 22:25:48 +00003355 uint32_t BucketOffset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003356 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003357 using namespace llvm::support;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003358 llvm::raw_svector_ostream Out(IdentifierTable);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003359 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003360 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregora868bbd2009-04-21 22:25:48 +00003361 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003362 }
3363
3364 // Create a blob abbreviation
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003365 auto *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003366 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
Douglas Gregora868bbd2009-04-21 22:25:48 +00003367 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregore84a9da2009-04-20 20:36:09 +00003368 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
Douglas Gregor8f45df52009-04-16 22:23:12 +00003369 unsigned IDTableAbbrev = Stream.EmitAbbrev(Abbrev);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003370
3371 // Write the identifier table
Mehdi Amini57a41912015-09-10 01:46:39 +00003372 RecordData::value_type Record[] = {IDENTIFIER_TABLE, BucketOffset};
Yaron Keren92e1b622015-03-18 10:17:07 +00003373 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003374 }
3375
3376 // Write the offsets table for identifier IDs.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003377 auto *Abbrev = new BitCodeAbbrev();
Sebastian Redl539c5062010-08-18 23:57:32 +00003378 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
Douglas Gregor0e149972009-04-25 19:10:14 +00003379 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
Douglas Gregor1ab036c2011-08-03 21:49:18 +00003380 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor0e149972009-04-25 19:10:14 +00003381 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3382 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(Abbrev);
3383
Douglas Gregor8d7edce2013-02-08 21:30:59 +00003384#ifndef NDEBUG
3385 for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I)
3386 assert(IdentifierOffsets[I] && "Missing identifier offset?");
3387#endif
Mehdi Amini57a41912015-09-10 01:46:39 +00003388
3389 RecordData::value_type Record[] = {IDENTIFIER_OFFSET,
3390 IdentifierOffsets.size(),
3391 FirstIdentID - NUM_PREDEF_IDENT_IDS};
Douglas Gregor0e149972009-04-25 19:10:14 +00003392 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00003393 bytes(IdentifierOffsets));
Richard Smith33e0f7e2015-07-22 02:08:40 +00003394
3395 // In C++, write the list of interesting identifiers (those that are
3396 // defined as macros, poisoned, or similar unusual things).
3397 if (!InterestingIdents.empty())
3398 Stream.EmitRecord(INTERESTING_IDENTIFIERS, InterestingIdents);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003399}
3400
Douglas Gregorc5046832009-04-27 18:38:38 +00003401//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003402// DeclContext's Name Lookup Table Serialization
3403//===----------------------------------------------------------------------===//
3404
3405namespace {
3406// Trait used for the on-disk hash table used in the method pool.
3407class ASTDeclContextNameLookupTrait {
3408 ASTWriter &Writer;
Richard Smithd88a7f12015-09-01 20:35:42 +00003409 llvm::SmallVector<DeclID, 64> DeclIDs;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003410
3411public:
Richard Smitha06c7e62015-08-26 23:55:49 +00003412 typedef DeclarationNameKey key_type;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003413 typedef key_type key_type_ref;
3414
Richard Smithd88a7f12015-09-01 20:35:42 +00003415 /// A start and end index into DeclIDs, representing a sequence of decls.
3416 typedef std::pair<unsigned, unsigned> data_type;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003417 typedef const data_type& data_type_ref;
3418
Justin Bogner25463f12014-04-18 20:27:24 +00003419 typedef unsigned hash_value_type;
3420 typedef unsigned offset_type;
3421
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003422 explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) { }
3423
Richard Smithd88a7f12015-09-01 20:35:42 +00003424 template<typename Coll>
3425 data_type getData(const Coll &Decls) {
3426 unsigned Start = DeclIDs.size();
3427 for (NamedDecl *D : Decls) {
3428 DeclIDs.push_back(
3429 Writer.GetDeclRef(getDeclForLocalLookup(Writer.getLangOpts(), D)));
3430 }
3431 return std::make_pair(Start, DeclIDs.size());
3432 }
3433
3434 data_type ImportData(const reader::ASTDeclContextNameLookupTrait::data_type &FromReader) {
3435 unsigned Start = DeclIDs.size();
3436 for (auto ID : FromReader)
3437 DeclIDs.push_back(ID);
3438 return std::make_pair(Start, DeclIDs.size());
3439 }
3440
3441 static bool EqualKey(key_type_ref a, key_type_ref b) {
3442 return a == b;
3443 }
3444
Richard Smitha06c7e62015-08-26 23:55:49 +00003445 hash_value_type ComputeHash(DeclarationNameKey Name) {
3446 return Name.getHash();
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003447 }
3448
Richard Smithd88a7f12015-09-01 20:35:42 +00003449 void EmitFileRef(raw_ostream &Out, ModuleFile *F) const {
3450 assert(Writer.hasChain() &&
3451 "have reference to loaded module file but no chain?");
3452
3453 using namespace llvm::support;
3454 endian::Writer<little>(Out)
3455 .write<uint32_t>(Writer.getChain()->getModuleFileID(F));
3456 }
3457
Richard Smitha06c7e62015-08-26 23:55:49 +00003458 std::pair<unsigned, unsigned> EmitKeyDataLength(raw_ostream &Out,
3459 DeclarationNameKey Name,
3460 data_type_ref Lookup) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003461 using namespace llvm::support;
3462 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003463 unsigned KeyLen = 1;
Richard Smitha06c7e62015-08-26 23:55:49 +00003464 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003465 case DeclarationName::Identifier:
3466 case DeclarationName::ObjCZeroArgSelector:
3467 case DeclarationName::ObjCOneArgSelector:
3468 case DeclarationName::ObjCMultiArgSelector:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003469 case DeclarationName::CXXLiteralOperatorName:
3470 KeyLen += 4;
3471 break;
3472 case DeclarationName::CXXOperatorName:
3473 KeyLen += 1;
3474 break;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003475 case DeclarationName::CXXConstructorName:
3476 case DeclarationName::CXXDestructorName:
3477 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003478 case DeclarationName::CXXUsingDirective:
3479 break;
3480 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003481 LE.write<uint16_t>(KeyLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003482
Richard Smithf02662d2015-07-30 03:17:16 +00003483 // 4 bytes for each DeclID.
Richard Smithd88a7f12015-09-01 20:35:42 +00003484 unsigned DataLen = 4 * (Lookup.second - Lookup.first);
3485 assert(uint16_t(DataLen) == DataLen &&
3486 "too many decls for serialized lookup result");
Justin Bognere1c147c2014-03-28 22:03:19 +00003487 LE.write<uint16_t>(DataLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003488
3489 return std::make_pair(KeyLen, DataLen);
3490 }
3491
Richard Smitha06c7e62015-08-26 23:55:49 +00003492 void EmitKey(raw_ostream &Out, DeclarationNameKey Name, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003493 using namespace llvm::support;
3494 endian::Writer<little> LE(Out);
Richard Smitha06c7e62015-08-26 23:55:49 +00003495 LE.write<uint8_t>(Name.getKind());
3496 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003497 case DeclarationName::Identifier:
Richard Smitha06c7e62015-08-26 23:55:49 +00003498 case DeclarationName::CXXLiteralOperatorName:
3499 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getIdentifier()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003500 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003501 case DeclarationName::ObjCZeroArgSelector:
3502 case DeclarationName::ObjCOneArgSelector:
3503 case DeclarationName::ObjCMultiArgSelector:
Richard Smitha06c7e62015-08-26 23:55:49 +00003504 LE.write<uint32_t>(Writer.getSelectorRef(Name.getSelector()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003505 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003506 case DeclarationName::CXXOperatorName:
Richard Smitha06c7e62015-08-26 23:55:49 +00003507 assert(Name.getOperatorKind() < NUM_OVERLOADED_OPERATORS &&
Benjamin Kramer53750b12012-09-19 13:40:40 +00003508 "Invalid operator?");
Richard Smitha06c7e62015-08-26 23:55:49 +00003509 LE.write<uint8_t>(Name.getOperatorKind());
Benjamin Kramer53750b12012-09-19 13:40:40 +00003510 return;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003511 case DeclarationName::CXXConstructorName:
3512 case DeclarationName::CXXDestructorName:
3513 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003514 case DeclarationName::CXXUsingDirective:
Benjamin Kramer53750b12012-09-19 13:40:40 +00003515 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003516 }
Benjamin Kramer53750b12012-09-19 13:40:40 +00003517
3518 llvm_unreachable("Invalid name kind?");
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003519 }
3520
Richard Smitha06c7e62015-08-26 23:55:49 +00003521 void EmitData(raw_ostream &Out, key_type_ref, data_type Lookup,
3522 unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003523 using namespace llvm::support;
3524 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003525 uint64_t Start = Out.tell(); (void)Start;
Richard Smithd88a7f12015-09-01 20:35:42 +00003526 for (unsigned I = Lookup.first, N = Lookup.second; I != N; ++I)
3527 LE.write<uint32_t>(DeclIDs[I]);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003528 assert(Out.tell() - Start == DataLen && "Data length is wrong");
3529 }
3530};
3531} // end anonymous namespace
3532
Chandler Carruthe972c362015-03-26 03:11:40 +00003533bool ASTWriter::isLookupResultExternal(StoredDeclsList &Result,
3534 DeclContext *DC) {
3535 return Result.hasExternalDecls() && DC->NeedToReconcileExternalVisibleStorage;
3536}
3537
3538bool ASTWriter::isLookupResultEntirelyExternal(StoredDeclsList &Result,
3539 DeclContext *DC) {
3540 for (auto *D : Result.getLookupResult())
3541 if (!getDeclForLocalLookup(getLangOpts(), D)->isFromASTFile())
3542 return false;
3543
3544 return true;
3545}
3546
Richard Smithd88a7f12015-09-01 20:35:42 +00003547void
Chandler Carruthe972c362015-03-26 03:11:40 +00003548ASTWriter::GenerateNameLookupTable(const DeclContext *ConstDC,
Richard Smithcd45dbc2014-04-19 03:48:30 +00003549 llvm::SmallVectorImpl<char> &LookupTable) {
Chandler Carruthe972c362015-03-26 03:11:40 +00003550 assert(!ConstDC->HasLazyLocalLexicalLookups &&
3551 !ConstDC->HasLazyExternalLexicalLookups &&
Richard Smith9e2341d2015-03-23 03:25:59 +00003552 "must call buildLookups first");
Richard Smithcd45dbc2014-04-19 03:48:30 +00003553
Chandler Carruthe972c362015-03-26 03:11:40 +00003554 // FIXME: We need to build the lookups table, which is logically const.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003555 auto *DC = const_cast<DeclContext*>(ConstDC);
Chandler Carruthe972c362015-03-26 03:11:40 +00003556 assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
3557
3558 // Create the on-disk hash table representation.
Richard Smithd88a7f12015-09-01 20:35:42 +00003559 MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait,
3560 ASTDeclContextNameLookupTrait> Generator;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003561 ASTDeclContextNameLookupTrait Trait(*this);
3562
Chandler Carruthe972c362015-03-26 03:11:40 +00003563 // The first step is to collect the declaration names which we need to
3564 // serialize into the name lookup table, and to collect them in a stable
3565 // order.
3566 SmallVector<DeclarationName, 16> Names;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003567
Chandler Carruthe972c362015-03-26 03:11:40 +00003568 // We also build up small sets of the constructor and conversion function
3569 // names which are visible.
3570 llvm::SmallSet<DeclarationName, 8> ConstructorNameSet, ConversionNameSet;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003571
Chandler Carruthe972c362015-03-26 03:11:40 +00003572 for (auto &Lookup : *DC->buildLookup()) {
3573 auto &Name = Lookup.first;
3574 auto &Result = Lookup.second;
3575
Douglas Gregor7dd37e52015-11-03 01:20:54 +00003576 // If there are no local declarations in our lookup result, we
3577 // don't need to write an entry for the name at all. If we can't
3578 // write out a lookup set without performing more deserialization,
3579 // just skip this entry.
3580 if (isLookupResultExternal(Result, DC) &&
Chandler Carruthe972c362015-03-26 03:11:40 +00003581 isLookupResultEntirelyExternal(Result, DC))
3582 continue;
3583
3584 // We also skip empty results. If any of the results could be external and
3585 // the currently available results are empty, then all of the results are
3586 // external and we skip it above. So the only way we get here with an empty
3587 // results is when no results could have been external *and* we have
3588 // external results.
3589 //
3590 // FIXME: While we might want to start emitting on-disk entries for negative
3591 // lookups into a decl context as an optimization, today we *have* to skip
3592 // them because there are names with empty lookup results in decl contexts
3593 // which we can't emit in any stable ordering: we lookup constructors and
3594 // conversion functions in the enclosing namespace scope creating empty
3595 // results for them. This in almost certainly a bug in Clang's name lookup,
3596 // but that is likely to be hard or impossible to fix and so we tolerate it
3597 // here by omitting lookups with empty results.
3598 if (Lookup.second.getLookupResult().empty())
3599 continue;
3600
3601 switch (Lookup.first.getNameKind()) {
3602 default:
3603 Names.push_back(Lookup.first);
3604 break;
3605
Richard Smithcd45dbc2014-04-19 03:48:30 +00003606 case DeclarationName::CXXConstructorName:
Chandler Carruthe972c362015-03-26 03:11:40 +00003607 assert(isa<CXXRecordDecl>(DC) &&
3608 "Cannot have a constructor name outside of a class!");
3609 ConstructorNameSet.insert(Name);
3610 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003611
3612 case DeclarationName::CXXConversionFunctionName:
Chandler Carruthe972c362015-03-26 03:11:40 +00003613 assert(isa<CXXRecordDecl>(DC) &&
3614 "Cannot have a conversion function name outside of a class!");
3615 ConversionNameSet.insert(Name);
Rafael Espindolac606b3e2015-03-25 04:43:15 +00003616 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003617 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00003618 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00003619
Chandler Carruthe972c362015-03-26 03:11:40 +00003620 // Sort the names into a stable order.
3621 std::sort(Names.begin(), Names.end());
3622
Chandler Carruthffbf7052015-03-26 22:27:09 +00003623 if (auto *D = dyn_cast<CXXRecordDecl>(DC)) {
Chandler Carruthe972c362015-03-26 03:11:40 +00003624 // We need to establish an ordering of constructor and conversion function
Chandler Carruthffbf7052015-03-26 22:27:09 +00003625 // names, and they don't have an intrinsic ordering.
Chandler Carruthe972c362015-03-26 03:11:40 +00003626
Chandler Carruthffbf7052015-03-26 22:27:09 +00003627 // First we try the easy case by forming the current context's constructor
3628 // name and adding that name first. This is a very useful optimization to
3629 // avoid walking the lexical declarations in many cases, and it also
3630 // handles the only case where a constructor name can come from some other
3631 // lexical context -- when that name is an implicit constructor merged from
3632 // another declaration in the redecl chain. Any non-implicit constructor or
3633 // conversion function which doesn't occur in all the lexical contexts
3634 // would be an ODR violation.
3635 auto ImplicitCtorName = Context->DeclarationNames.getCXXConstructorName(
3636 Context->getCanonicalType(Context->getRecordType(D)));
3637 if (ConstructorNameSet.erase(ImplicitCtorName))
3638 Names.push_back(ImplicitCtorName);
Chandler Carruthe972c362015-03-26 03:11:40 +00003639
Chandler Carruthffbf7052015-03-26 22:27:09 +00003640 // If we still have constructors or conversion functions, we walk all the
3641 // names in the decl and add the constructors and conversion functions
3642 // which are visible in the order they lexically occur within the context.
3643 if (!ConstructorNameSet.empty() || !ConversionNameSet.empty())
3644 for (Decl *ChildD : cast<CXXRecordDecl>(DC)->decls())
3645 if (auto *ChildND = dyn_cast<NamedDecl>(ChildD)) {
3646 auto Name = ChildND->getDeclName();
3647 switch (Name.getNameKind()) {
3648 default:
3649 continue;
3650
3651 case DeclarationName::CXXConstructorName:
3652 if (ConstructorNameSet.erase(Name))
3653 Names.push_back(Name);
3654 break;
3655
3656 case DeclarationName::CXXConversionFunctionName:
3657 if (ConversionNameSet.erase(Name))
3658 Names.push_back(Name);
3659 break;
3660 }
3661
3662 if (ConstructorNameSet.empty() && ConversionNameSet.empty())
3663 break;
Chandler Carruthe972c362015-03-26 03:11:40 +00003664 }
3665
Chandler Carruthe972c362015-03-26 03:11:40 +00003666 assert(ConstructorNameSet.empty() && "Failed to find all of the visible "
3667 "constructors by walking all the "
3668 "lexical members of the context.");
3669 assert(ConversionNameSet.empty() && "Failed to find all of the visible "
3670 "conversion functions by walking all "
3671 "the lexical members of the context.");
Richard Smith961eae52014-03-25 01:14:22 +00003672 }
3673
Chandler Carruthe972c362015-03-26 03:11:40 +00003674 // Next we need to do a lookup with each name into this decl context to fully
3675 // populate any results from external sources. We don't actually use the
3676 // results of these lookups because we only want to use the results after all
3677 // results have been loaded and the pointers into them will be stable.
3678 for (auto &Name : Names)
3679 DC->lookup(Name);
3680
3681 // Now we need to insert the results for each name into the hash table. For
3682 // constructor names and conversion function names, we actually need to merge
3683 // all of the results for them into one list of results each and insert
3684 // those.
3685 SmallVector<NamedDecl *, 8> ConstructorDecls;
3686 SmallVector<NamedDecl *, 8> ConversionDecls;
3687
3688 // Now loop over the names, either inserting them or appending for the two
3689 // special cases.
3690 for (auto &Name : Names) {
3691 DeclContext::lookup_result Result = DC->noload_lookup(Name);
3692
3693 switch (Name.getNameKind()) {
3694 default:
Richard Smithd88a7f12015-09-01 20:35:42 +00003695 Generator.insert(Name, Trait.getData(Result), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00003696 break;
3697
3698 case DeclarationName::CXXConstructorName:
3699 ConstructorDecls.append(Result.begin(), Result.end());
3700 break;
3701
3702 case DeclarationName::CXXConversionFunctionName:
3703 ConversionDecls.append(Result.begin(), Result.end());
3704 break;
3705 }
3706 }
3707
3708 // Handle our two special cases if we ended up having any. We arbitrarily use
3709 // the first declaration's name here because the name itself isn't part of
3710 // the key, only the kind of name is used.
3711 if (!ConstructorDecls.empty())
3712 Generator.insert(ConstructorDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00003713 Trait.getData(ConstructorDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00003714 if (!ConversionDecls.empty())
3715 Generator.insert(ConversionDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00003716 Trait.getData(ConversionDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00003717
Richard Smithd88a7f12015-09-01 20:35:42 +00003718 // Create the on-disk hash table. Also emit the existing imported and
3719 // merged table if there is one.
3720 auto *Lookups = Chain ? Chain->getLoadedLookupTables(DC) : nullptr;
3721 Generator.emit(LookupTable, Trait, Lookups ? &Lookups->Table : nullptr);
Richard Smith961eae52014-03-25 01:14:22 +00003722}
3723
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003724/// \brief Write the block containing all of the declaration IDs
3725/// visible from the given DeclContext.
3726///
3727/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
Sebastian Redla4071b42010-08-24 00:50:09 +00003728/// bitstream, or 0 if no block was written.
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003729uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
3730 DeclContext *DC) {
Richard Smith5fc18a92015-07-12 23:43:21 +00003731 // If we imported a key declaration of this namespace, write the visible
3732 // lookup results as an update record for it rather than including them
3733 // on this declaration. We will only look at key declarations on reload.
3734 if (isa<NamespaceDecl>(DC) && Chain &&
3735 Chain->getKeyDeclaration(cast<Decl>(DC))->isFromASTFile()) {
3736 // Only do this once, for the first local declaration of the namespace.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003737 for (auto *Prev = cast<NamespaceDecl>(DC)->getPreviousDecl(); Prev;
Richard Smith5fc18a92015-07-12 23:43:21 +00003738 Prev = Prev->getPreviousDecl())
3739 if (!Prev->isFromASTFile())
3740 return 0;
3741
3742 // Note that we need to emit an update record for the primary context.
3743 UpdatedDeclContexts.insert(DC->getPrimaryContext());
3744
3745 // Make sure all visible decls are written. They will be recorded later. We
3746 // do this using a side data structure so we can sort the names into
3747 // a deterministic order.
3748 StoredDeclsMap *Map = DC->getPrimaryContext()->buildLookup();
3749 SmallVector<std::pair<DeclarationName, DeclContext::lookup_result>, 16>
3750 LookupResults;
3751 if (Map) {
3752 LookupResults.reserve(Map->size());
3753 for (auto &Entry : *Map)
3754 LookupResults.push_back(
3755 std::make_pair(Entry.first, Entry.second.getLookupResult()));
3756 }
3757
3758 std::sort(LookupResults.begin(), LookupResults.end(), llvm::less_first());
3759 for (auto &NameAndResult : LookupResults) {
3760 DeclarationName Name = NameAndResult.first;
3761 DeclContext::lookup_result Result = NameAndResult.second;
3762 if (Name.getNameKind() == DeclarationName::CXXConstructorName ||
3763 Name.getNameKind() == DeclarationName::CXXConversionFunctionName) {
3764 // We have to work around a name lookup bug here where negative lookup
3765 // results for these names get cached in namespace lookup tables (these
3766 // names should never be looked up in a namespace).
3767 assert(Result.empty() && "Cannot have a constructor or conversion "
3768 "function name in a namespace!");
3769 continue;
3770 }
3771
3772 for (NamedDecl *ND : Result)
3773 if (!ND->isFromASTFile())
3774 GetDeclRef(ND);
3775 }
3776
3777 return 0;
3778 }
3779
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003780 if (DC->getPrimaryContext() != DC)
3781 return 0;
3782
Chandler Carruthe972c362015-03-26 03:11:40 +00003783 // Skip contexts which don't support name lookup.
3784 if (!DC->isLookupContext())
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003785 return 0;
3786
3787 // If not in C++, we perform name lookup for the translation unit via the
3788 // IdentifierInfo chains, don't bother to build a visible-declarations table.
David Blaikiebbafb8a2012-03-11 07:00:24 +00003789 if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003790 return 0;
3791
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003792 // Serialize the contents of the mapping used for lookup. Note that,
3793 // although we have two very different code paths, the serialized
3794 // representation is the same for both cases: a declaration name,
3795 // followed by a size, followed by references to the visible
3796 // declarations that have that name.
3797 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smithf634c902012-03-16 06:12:59 +00003798 StoredDeclsMap *Map = DC->buildLookup();
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003799 if (!Map || Map->empty())
3800 return 0;
3801
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003802 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003803 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00003804 GenerateNameLookupTable(DC, LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003805
3806 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00003807 RecordData::value_type Record[] = {DECL_CONTEXT_VISIBLE};
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003808 Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
Yaron Keren92e1b622015-03-18 10:17:07 +00003809 LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00003810 ++NumVisibleDeclContexts;
3811 return Offset;
3812}
3813
Sebastian Redla4071b42010-08-24 00:50:09 +00003814/// \brief Write an UPDATE_VISIBLE block for the given context.
3815///
3816/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
3817/// DeclContext in a dependent AST file. As such, they only exist for the TU
Richard Smithf634c902012-03-16 06:12:59 +00003818/// (in C++), for namespaces, and for classes with forward-declared unscoped
3819/// enumeration members (in C++11).
Sebastian Redla4071b42010-08-24 00:50:09 +00003820void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
Richard Smith961eae52014-03-25 01:14:22 +00003821 StoredDeclsMap *Map = DC->getLookupPtr();
Sebastian Redla4071b42010-08-24 00:50:09 +00003822 if (!Map || Map->empty())
3823 return;
3824
Sebastian Redla4071b42010-08-24 00:50:09 +00003825 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003826 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00003827 GenerateNameLookupTable(DC, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00003828
Richard Smith5fc18a92015-07-12 23:43:21 +00003829 // If we're updating a namespace, select a key declaration as the key for the
3830 // update record; those are the only ones that will be checked on reload.
3831 if (isa<NamespaceDecl>(DC))
3832 DC = cast<DeclContext>(Chain->getKeyDeclaration(cast<Decl>(DC)));
3833
Sebastian Redla4071b42010-08-24 00:50:09 +00003834 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00003835 RecordData::value_type Record[] = {UPDATE_VISIBLE, getDeclID(cast<Decl>(DC))};
Yaron Keren92e1b622015-03-18 10:17:07 +00003836 Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00003837}
3838
Peter Collingbourne5df20e02011-02-15 19:46:30 +00003839/// \brief Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
3840void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003841 RecordData::value_type Record[] = {Opts.fp_contract};
Peter Collingbourne5df20e02011-02-15 19:46:30 +00003842 Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
3843}
3844
3845/// \brief Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
3846void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00003847 if (!SemaRef.Context.getLangOpts().OpenCL)
Peter Collingbourne5df20e02011-02-15 19:46:30 +00003848 return;
3849
3850 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
3851 RecordData Record;
3852#define OPENCLEXT(nm) Record.push_back(Opts.nm);
3853#include "clang/Basic/OpenCLExtensions.def"
3854 Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
3855}
3856
Douglas Gregor404cdde2012-01-27 01:47:08 +00003857void ASTWriter::WriteObjCCategories() {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00003858 SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
Douglas Gregor404cdde2012-01-27 01:47:08 +00003859 RecordData Categories;
3860
3861 for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
3862 unsigned Size = 0;
3863 unsigned StartIndex = Categories.size();
3864
3865 ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
3866
3867 // Allocate space for the size.
3868 Categories.push_back(0);
3869
3870 // Add the categories.
Douglas Gregor048fbfa2013-01-16 23:00:23 +00003871 for (ObjCInterfaceDecl::known_categories_iterator
3872 Cat = Class->known_categories_begin(),
3873 CatEnd = Class->known_categories_end();
3874 Cat != CatEnd; ++Cat, ++Size) {
3875 assert(getDeclID(*Cat) != 0 && "Bogus category");
3876 AddDeclRef(*Cat, Categories);
Douglas Gregor404cdde2012-01-27 01:47:08 +00003877 }
3878
3879 // Update the size.
3880 Categories[StartIndex] = Size;
3881
3882 // Record this interface -> category map.
3883 ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex };
3884 CategoriesMap.push_back(CatInfo);
3885 }
3886
3887 // Sort the categories map by the definition ID, since the reader will be
3888 // performing binary searches on this information.
3889 llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end());
3890
3891 // Emit the categories map.
3892 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003893
3894 auto *Abbrev = new BitCodeAbbrev();
Douglas Gregor404cdde2012-01-27 01:47:08 +00003895 Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
3896 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
3897 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
3898 unsigned AbbrevID = Stream.EmitAbbrev(Abbrev);
Mehdi Amini57a41912015-09-10 01:46:39 +00003899
3900 RecordData::value_type Record[] = {OBJC_CATEGORIES_MAP, CategoriesMap.size()};
3901 Stream.EmitRecordWithBlob(AbbrevID, Record,
3902 reinterpret_cast<char *>(CategoriesMap.data()),
Douglas Gregor404cdde2012-01-27 01:47:08 +00003903 CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
Mehdi Amini57a41912015-09-10 01:46:39 +00003904
Douglas Gregor404cdde2012-01-27 01:47:08 +00003905 // Emit the category lists.
3906 Stream.EmitRecord(OBJC_CATEGORIES, Categories);
3907}
3908
Richard Smithe40f2ba2013-08-07 21:41:30 +00003909void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
3910 Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap;
3911
3912 if (LPTMap.empty())
3913 return;
3914
3915 RecordData Record;
Chandler Carruth52cee4d2015-03-26 09:08:15 +00003916 for (auto LPTMapEntry : LPTMap) {
3917 const FunctionDecl *FD = LPTMapEntry.first;
3918 LateParsedTemplate *LPT = LPTMapEntry.second;
3919 AddDeclRef(FD, Record);
Richard Smithe40f2ba2013-08-07 21:41:30 +00003920 AddDeclRef(LPT->D, Record);
3921 Record.push_back(LPT->Toks.size());
3922
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003923 for (const auto &Tok : LPT->Toks) {
3924 AddToken(Tok, Record);
Richard Smithe40f2ba2013-08-07 21:41:30 +00003925 }
3926 }
3927 Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record);
3928}
3929
Dario Domizioli13a0a382014-05-23 12:13:25 +00003930/// \brief Write the state of 'pragma clang optimize' at the end of the module.
3931void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
3932 RecordData Record;
3933 SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
3934 AddSourceLocation(PragmaLoc, Record);
3935 Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record);
3936}
3937
Nico Weber779355f2016-03-02 23:22:00 +00003938/// \brief Write the state of 'pragma ms_struct' at the end of the module.
3939void ASTWriter::WriteMSStructPragmaOptions(Sema &SemaRef) {
3940 RecordData Record;
3941 Record.push_back(SemaRef.MSStructPragmaOn ? PMSST_ON : PMSST_OFF);
3942 Stream.EmitRecord(MSSTRUCT_PRAGMA_OPTIONS, Record);
3943}
3944
Nico Weber42932312016-03-03 00:17:35 +00003945/// \brief Write the state of 'pragma pointers_to_members' at the end of the
3946//module.
3947void ASTWriter::WriteMSPointersToMembersPragmaOptions(Sema &SemaRef) {
3948 RecordData Record;
3949 Record.push_back(SemaRef.MSPointerToMemberRepresentationMethod);
3950 AddSourceLocation(SemaRef.ImplicitMSInheritanceAttrLoc, Record);
3951 Stream.EmitRecord(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS, Record);
3952}
3953
Douglas Gregor8f64ca12015-12-08 22:43:32 +00003954void ASTWriter::WriteModuleFileExtension(Sema &SemaRef,
3955 ModuleFileExtensionWriter &Writer) {
Douglas Gregor6623e1f2015-11-03 18:33:07 +00003956 // Enter the extension block.
3957 Stream.EnterSubblock(EXTENSION_BLOCK_ID, 4);
3958
3959 // Emit the metadata record abbreviation.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003960 auto *Abv = new llvm::BitCodeAbbrev();
Douglas Gregor6623e1f2015-11-03 18:33:07 +00003961 Abv->Add(llvm::BitCodeAbbrevOp(EXTENSION_METADATA));
3962 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
3963 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
3964 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
3965 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
3966 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
3967 unsigned Abbrev = Stream.EmitAbbrev(Abv);
3968
3969 // Emit the metadata record.
3970 RecordData Record;
3971 auto Metadata = Writer.getExtension()->getExtensionMetadata();
3972 Record.push_back(EXTENSION_METADATA);
3973 Record.push_back(Metadata.MajorVersion);
3974 Record.push_back(Metadata.MinorVersion);
3975 Record.push_back(Metadata.BlockName.size());
3976 Record.push_back(Metadata.UserInfo.size());
3977 SmallString<64> Buffer;
3978 Buffer += Metadata.BlockName;
3979 Buffer += Metadata.UserInfo;
3980 Stream.EmitRecordWithBlob(Abbrev, Record, Buffer);
3981
3982 // Emit the contents of the extension block.
Douglas Gregor8f64ca12015-12-08 22:43:32 +00003983 Writer.writeExtensionContents(SemaRef, Stream);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00003984
3985 // Exit the extension block.
3986 Stream.ExitBlock();
3987}
3988
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003989//===----------------------------------------------------------------------===//
Douglas Gregorc5046832009-04-27 18:38:38 +00003990// General Serialization Routines
3991//===----------------------------------------------------------------------===//
3992
Richard Smith69c82bf2016-04-01 22:52:03 +00003993/// \brief Emit the list of attributes to the specified record.
Richard Smith5811c402016-04-06 06:26:08 +00003994void ASTRecordWriter::AddAttributes(ArrayRef<const Attr *> Attrs) {
3995 auto &Record = *this;
Argyrios Kyrtzidis9beef8e2010-10-18 19:20:11 +00003996 Record.push_back(Attrs.size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003997 for (const auto *A : Attrs) {
Alexis Huntdcfba7b2010-08-18 23:23:40 +00003998 Record.push_back(A->getKind()); // FIXME: stable encoding, target attrs
Richard Smith5811c402016-04-06 06:26:08 +00003999 Record.AddSourceRange(A->getRange());
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004000
Alexis Huntdcfba7b2010-08-18 23:23:40 +00004001#include "clang/Serialization/AttrPCHWrite.inc"
Daniel Dunbarfc6507e2010-05-27 02:25:39 +00004002
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004003 }
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004004}
4005
John McCallf413f5e2013-05-03 00:10:13 +00004006void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) {
4007 AddSourceLocation(Tok.getLocation(), Record);
4008 Record.push_back(Tok.getLength());
4009
4010 // FIXME: When reading literal tokens, reconstruct the literal pointer
4011 // if it is needed.
4012 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
4013 // FIXME: Should translate token kind to a stable encoding.
4014 Record.push_back(Tok.getKind());
4015 // FIXME: Should translate token flags to a stable encoding.
4016 Record.push_back(Tok.getFlags());
4017}
4018
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004019void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004020 Record.push_back(Str.size());
4021 Record.insert(Record.end(), Str.begin(), Str.end());
4022}
4023
Richard Smith7ed1bc92014-12-05 22:42:13 +00004024bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) {
Richard Smith54cc3c22014-12-11 20:50:24 +00004025 assert(Context && "should have context when outputting path");
Richard Smith7ed1bc92014-12-05 22:42:13 +00004026
Richard Smith54cc3c22014-12-11 20:50:24 +00004027 bool Changed =
4028 cleanPathForOutput(Context->getSourceManager().getFileManager(), Path);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004029
4030 // Remove a prefix to make the path relative, if relevant.
4031 const char *PathBegin = Path.data();
4032 const char *PathPtr =
4033 adjustFilenameForRelocatableAST(PathBegin, BaseDirectory);
4034 if (PathPtr != PathBegin) {
4035 Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin));
4036 Changed = true;
4037 }
4038
4039 return Changed;
4040}
4041
4042void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) {
4043 SmallString<128> FilePath(Path);
4044 PreparePathForOutput(FilePath);
4045 AddString(FilePath, Record);
4046}
4047
Mehdi Amini57a41912015-09-10 01:46:39 +00004048void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataRef Record,
Richard Smith7ed1bc92014-12-05 22:42:13 +00004049 StringRef Path) {
4050 SmallString<128> FilePath(Path);
4051 PreparePathForOutput(FilePath);
4052 Stream.EmitRecordWithBlob(Abbrev, Record, FilePath);
4053}
4054
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004055void ASTWriter::AddVersionTuple(const VersionTuple &Version,
4056 RecordDataImpl &Record) {
4057 Record.push_back(Version.getMajor());
David Blaikie05785d12013-02-20 22:23:23 +00004058 if (Optional<unsigned> Minor = Version.getMinor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004059 Record.push_back(*Minor + 1);
4060 else
4061 Record.push_back(0);
David Blaikie05785d12013-02-20 22:23:23 +00004062 if (Optional<unsigned> Subminor = Version.getSubminor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004063 Record.push_back(*Subminor + 1);
4064 else
4065 Record.push_back(0);
4066}
4067
Douglas Gregore84a9da2009-04-20 20:36:09 +00004068/// \brief Note that the identifier II occurs at the given offset
4069/// within the identifier table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004070void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
Sebastian Redl539c5062010-08-18 23:57:32 +00004071 IdentID ID = IdentifierIDs[II];
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004072 // Only store offsets new to this AST file. Other identifier names are looked
Sebastian Redlff4a2952010-07-23 23:49:55 +00004073 // up earlier in the chain and thus don't need an offset.
4074 if (ID >= FirstIdentID)
4075 IdentifierOffsets[ID - FirstIdentID] = Offset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00004076}
4077
Douglas Gregor95c13f52009-04-25 17:48:32 +00004078/// \brief Note that the selector Sel occurs at the given offset
4079/// within the method pool/selector table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004080void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
Douglas Gregor95c13f52009-04-25 17:48:32 +00004081 unsigned ID = SelectorIDs[Sel];
4082 assert(ID && "Unknown selector");
Sebastian Redld95a56e2010-08-04 18:21:41 +00004083 // Don't record offsets for selectors that are also available in a different
4084 // file.
4085 if (ID < FirstSelectorID)
4086 return;
4087 SelectorOffsets[ID - FirstSelectorID] = Offset;
Douglas Gregor95c13f52009-04-25 17:48:32 +00004088}
4089
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004090ASTWriter::ASTWriter(
4091 llvm::BitstreamWriter &Stream,
4092 ArrayRef<llvm::IntrusiveRefCntPtr<ModuleFileExtension>> Extensions,
4093 bool IncludeTimestamps)
Richard Smith01b2cb42014-07-26 06:37:51 +00004094 : Stream(Stream), Context(nullptr), PP(nullptr), Chain(nullptr),
Richard Smithe75ee0f2015-08-17 07:13:32 +00004095 WritingModule(nullptr), IncludeTimestamps(IncludeTimestamps),
4096 WritingAST(false), DoneWritingDeclsAndTypes(false),
4097 ASTHasCompilerErrors(false), FirstDeclID(NUM_PREDEF_DECL_IDS),
4098 NextDeclID(FirstDeclID), FirstTypeID(NUM_PREDEF_TYPE_IDS),
4099 NextTypeID(FirstTypeID), FirstIdentID(NUM_PREDEF_IDENT_IDS),
4100 NextIdentID(FirstIdentID), FirstMacroID(NUM_PREDEF_MACRO_IDS),
4101 NextMacroID(FirstMacroID), FirstSubmoduleID(NUM_PREDEF_SUBMODULE_IDS),
Richard Smith01b2cb42014-07-26 06:37:51 +00004102 NextSubmoduleID(FirstSubmoduleID),
4103 FirstSelectorID(NUM_PREDEF_SELECTOR_IDS), NextSelectorID(FirstSelectorID),
Richard Smith5811c402016-04-06 06:26:08 +00004104 NumStatements(0), NumMacros(0),
Richard Smith01b2cb42014-07-26 06:37:51 +00004105 NumLexicalDeclContexts(0), NumVisibleDeclContexts(0),
Richard Smithc2bb8182015-03-24 06:36:48 +00004106 NextCXXBaseSpecifiersID(1), NextCXXCtorInitializersID(1),
Richard Smithe75ee0f2015-08-17 07:13:32 +00004107 TypeExtQualAbbrev(0), TypeFunctionProtoAbbrev(0), DeclParmVarAbbrev(0),
Richard Smith01b2cb42014-07-26 06:37:51 +00004108 DeclContextLexicalAbbrev(0), DeclContextVisibleLookupAbbrev(0),
Richard Smitha27c26e2014-07-27 04:19:32 +00004109 UpdateVisibleAbbrev(0), DeclRecordAbbrev(0), DeclTypedefAbbrev(0),
Richard Smith01b2cb42014-07-26 06:37:51 +00004110 DeclVarAbbrev(0), DeclFieldAbbrev(0), DeclEnumAbbrev(0),
Richard Smitha27c26e2014-07-27 04:19:32 +00004111 DeclObjCIvarAbbrev(0), DeclCXXMethodAbbrev(0), DeclRefExprAbbrev(0),
4112 CharacterLiteralAbbrev(0), IntegerLiteralAbbrev(0),
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004113 ExprImplicitCastAbbrev(0) {
4114 for (const auto &Ext : Extensions) {
4115 if (auto Writer = Ext->createExtensionWriter(*this))
4116 ModuleFileExtensionWriters.push_back(std::move(Writer));
4117 }
4118}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004119
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004120ASTWriter::~ASTWriter() {
Reid Kleckner588c9372014-02-19 23:44:52 +00004121 llvm::DeleteContainerSeconds(FileDeclIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004122}
4123
Richard Smithb3761912015-02-05 23:08:52 +00004124const LangOptions &ASTWriter::getLangOpts() const {
4125 assert(WritingAST && "can't determine lang opts when not writing AST");
4126 return Context->getLangOpts();
4127}
4128
Richard Smithe75ee0f2015-08-17 07:13:32 +00004129time_t ASTWriter::getTimestampForOutput(const FileEntry *E) const {
4130 return IncludeTimestamps ? E->getModificationTime() : 0;
4131}
4132
Adrian Prantladbd2b12015-09-22 23:26:31 +00004133uint64_t ASTWriter::WriteAST(Sema &SemaRef, const std::string &OutputFile,
4134 Module *WritingModule, StringRef isysroot,
4135 bool hasErrors) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004136 WritingAST = true;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004137
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00004138 ASTHasCompilerErrors = hasErrors;
4139
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004140 // Emit the file header.
Douglas Gregor8f45df52009-04-16 22:23:12 +00004141 Stream.Emit((unsigned)'C', 8);
4142 Stream.Emit((unsigned)'P', 8);
4143 Stream.Emit((unsigned)'C', 8);
4144 Stream.Emit((unsigned)'H', 8);
Mike Stump11289f42009-09-09 15:08:12 +00004145
Chris Lattner28fa4e62009-04-26 22:26:21 +00004146 WriteBlockInfoBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004147
Douglas Gregoreda8e122011-08-09 15:13:55 +00004148 Context = &SemaRef.Context;
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004149 PP = &SemaRef.PP;
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004150 this->WritingModule = WritingModule;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004151 ASTFileSignature Signature =
4152 WriteASTCore(SemaRef, isysroot, OutputFile, WritingModule);
Craig Toppera13603a2014-05-22 05:54:18 +00004153 Context = nullptr;
4154 PP = nullptr;
4155 this->WritingModule = nullptr;
Richard Smith7ed1bc92014-12-05 22:42:13 +00004156 this->BaseDirectory.clear();
Craig Toppera13603a2014-05-22 05:54:18 +00004157
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004158 WritingAST = false;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004159 return Signature;
Sebastian Redl143413f2010-07-12 22:02:52 +00004160}
4161
Douglas Gregora94a1542011-07-27 21:45:57 +00004162template<typename Vector>
4163static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec,
4164 ASTWriter::RecordData &Record) {
Craig Toppera13603a2014-05-22 05:54:18 +00004165 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
4166 I != E; ++I) {
Douglas Gregora94a1542011-07-27 21:45:57 +00004167 Writer.AddDeclRef(*I, Record);
4168 }
4169}
4170
Adrian Prantladbd2b12015-09-22 23:26:31 +00004171uint64_t ASTWriter::WriteASTCore(Sema &SemaRef, StringRef isysroot,
4172 const std::string &OutputFile,
4173 Module *WritingModule) {
Sebastian Redl143413f2010-07-12 22:02:52 +00004174 using namespace llvm;
4175
Craig Toppera13603a2014-05-22 05:54:18 +00004176 bool isModule = WritingModule != nullptr;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004177
Douglas Gregorcf68c582011-12-01 22:20:10 +00004178 // Make sure that the AST reader knows to finalize itself.
4179 if (Chain)
4180 Chain->finalizeForWriting();
4181
Sebastian Redl143413f2010-07-12 22:02:52 +00004182 ASTContext &Context = SemaRef.Context;
4183 Preprocessor &PP = SemaRef.PP;
4184
Douglas Gregordab42432011-08-12 00:15:20 +00004185 // Set up predefined declaration IDs.
Richard Smith5fc18a92015-07-12 23:43:21 +00004186 auto RegisterPredefDecl = [&] (Decl *D, PredefinedDeclIDs ID) {
4187 if (D) {
4188 assert(D->isCanonicalDecl() && "predefined decl is not canonical");
4189 DeclIDs[D] = ID;
Richard Smith5fc18a92015-07-12 23:43:21 +00004190 }
4191 };
4192 RegisterPredefDecl(Context.getTranslationUnitDecl(),
4193 PREDEF_DECL_TRANSLATION_UNIT_ID);
4194 RegisterPredefDecl(Context.ObjCIdDecl, PREDEF_DECL_OBJC_ID_ID);
4195 RegisterPredefDecl(Context.ObjCSelDecl, PREDEF_DECL_OBJC_SEL_ID);
4196 RegisterPredefDecl(Context.ObjCClassDecl, PREDEF_DECL_OBJC_CLASS_ID);
4197 RegisterPredefDecl(Context.ObjCProtocolClassDecl,
4198 PREDEF_DECL_OBJC_PROTOCOL_ID);
4199 RegisterPredefDecl(Context.Int128Decl, PREDEF_DECL_INT_128_ID);
4200 RegisterPredefDecl(Context.UInt128Decl, PREDEF_DECL_UNSIGNED_INT_128_ID);
4201 RegisterPredefDecl(Context.ObjCInstanceTypeDecl,
4202 PREDEF_DECL_OBJC_INSTANCETYPE_ID);
4203 RegisterPredefDecl(Context.BuiltinVaListDecl, PREDEF_DECL_BUILTIN_VA_LIST_ID);
Richard Smith9b88a4c2015-07-27 05:40:23 +00004204 RegisterPredefDecl(Context.VaListTagDecl, PREDEF_DECL_VA_LIST_TAG);
Charles Davisc7d5c942015-09-17 20:55:33 +00004205 RegisterPredefDecl(Context.BuiltinMSVaListDecl,
4206 PREDEF_DECL_BUILTIN_MS_VA_LIST_ID);
Richard Smith5fc18a92015-07-12 23:43:21 +00004207 RegisterPredefDecl(Context.ExternCContext, PREDEF_DECL_EXTERN_C_CONTEXT_ID);
David Majnemerd9b1a4f2015-11-04 03:40:30 +00004208 RegisterPredefDecl(Context.MakeIntegerSeqDecl,
4209 PREDEF_DECL_MAKE_INTEGER_SEQ_ID);
Quentin Colombet043406b2016-02-03 22:41:00 +00004210 RegisterPredefDecl(Context.CFConstantStringTypeDecl,
4211 PREDEF_DECL_CF_CONSTANT_STRING_ID);
Ben Langmuirf5416742016-02-04 00:55:24 +00004212 RegisterPredefDecl(Context.CFConstantStringTagDecl,
4213 PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID);
Meador Inge5d3fb222012-06-16 03:34:49 +00004214
Chris Lattner0c797362009-09-08 18:19:27 +00004215 // Build a record containing all of the tentative definitions in this file, in
Sebastian Redl35351a92010-01-31 22:27:38 +00004216 // TentativeDefinitions order. Generally, this record will be empty for
Chris Lattner0c797362009-09-08 18:19:27 +00004217 // headers.
Douglas Gregord4df8652009-04-22 22:02:47 +00004218 RecordData TentativeDefinitions;
Douglas Gregora94a1542011-07-27 21:45:57 +00004219 AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions);
Douglas Gregoreb08bd42011-07-27 20:58:46 +00004220
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004221 // Build a record containing all of the file scoped decls in this file.
4222 RecordData UnusedFileScopedDecls;
Argyrios Kyrtzidis59852362013-03-14 04:45:00 +00004223 if (!isModule)
4224 AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls,
4225 UnusedFileScopedDecls);
Sebastian Redl08aca90252010-08-05 18:21:25 +00004226
Douglas Gregor851443c2011-08-12 01:39:19 +00004227 // Build a record containing all of the delegating constructors we still need
4228 // to resolve.
Alexis Hunt27a761d2011-05-04 23:29:54 +00004229 RecordData DelegatingCtorDecls;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004230 if (!isModule)
4231 AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004232
Douglas Gregor851443c2011-08-12 01:39:19 +00004233 // Write the set of weak, undeclared identifiers. We always write the
4234 // entire table, since later PCH files in a PCH chain are only interested in
4235 // the results at the end of the chain.
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004236 RecordData WeakUndeclaredIdentifiers;
Chandler Carruthf85d9822015-03-26 08:32:49 +00004237 for (auto &WeakUndeclaredIdentifier : SemaRef.WeakUndeclaredIdentifiers) {
4238 IdentifierInfo *II = WeakUndeclaredIdentifier.first;
4239 WeakInfo &WI = WeakUndeclaredIdentifier.second;
4240 AddIdentifierRef(II, WeakUndeclaredIdentifiers);
4241 AddIdentifierRef(WI.getAlias(), WeakUndeclaredIdentifiers);
4242 AddSourceLocation(WI.getLocation(), WeakUndeclaredIdentifiers);
4243 WeakUndeclaredIdentifiers.push_back(WI.getUsed());
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004244 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004245
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004246 // Build a record containing all of the ext_vector declarations.
4247 RecordData ExtVectorDecls;
Douglas Gregorb7098a32011-07-28 00:39:29 +00004248 AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004249
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004250 // Build a record containing all of the VTable uses information.
4251 RecordData VTableUses;
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004252 if (!SemaRef.VTableUses.empty()) {
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004253 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
4254 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
4255 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
4256 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
4257 }
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004258 }
4259
Nico Weber72889432014-09-06 01:25:55 +00004260 // Build a record containing all of the UnusedLocalTypedefNameCandidates.
4261 RecordData UnusedLocalTypedefNameCandidates;
4262 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
4263 AddDeclRef(TD, UnusedLocalTypedefNameCandidates);
4264
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004265 // Build a record containing all of pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004266 RecordData PendingInstantiations;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004267 for (const auto &I : SemaRef.PendingInstantiations) {
4268 AddDeclRef(I.first, PendingInstantiations);
4269 AddSourceLocation(I.second, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004270 }
4271 assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
4272 "There are local ones at end of translation unit!");
4273
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004274 // Build a record containing some declaration references.
4275 RecordData SemaDeclRefs;
4276 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc) {
4277 AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
4278 AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
4279 }
4280
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004281 RecordData CUDASpecialDeclRefs;
4282 if (Context.getcudaConfigureCallDecl()) {
4283 AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs);
4284 }
4285
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004286 // Build a record containing all of the known namespaces.
4287 RecordData KnownNamespaces;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004288 for (const auto &I : SemaRef.KnownNamespaces) {
4289 if (!I.second)
4290 AddDeclRef(I.first, KnownNamespaces);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004291 }
Douglas Gregor112b9072012-10-18 05:31:06 +00004292
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004293 // Build a record of all used, undefined objects that require definitions.
4294 RecordData UndefinedButUsed;
Nick Lewyckyf0f56162013-01-31 03:23:57 +00004295
4296 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004297 SemaRef.getUndefinedButUsed(Undefined);
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004298 for (const auto &I : Undefined) {
4299 AddDeclRef(I.first, UndefinedButUsed);
4300 AddSourceLocation(I.second, UndefinedButUsed);
Nick Lewycky8334af82013-01-26 00:35:08 +00004301 }
4302
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004303 // Build a record containing all delete-expressions that we would like to
4304 // analyze later in AST.
4305 RecordData DeleteExprsToAnalyze;
4306
4307 for (const auto &DeleteExprsInfo :
4308 SemaRef.getMismatchingDeleteExpressions()) {
4309 AddDeclRef(DeleteExprsInfo.first, DeleteExprsToAnalyze);
4310 DeleteExprsToAnalyze.push_back(DeleteExprsInfo.second.size());
4311 for (const auto &DeleteLoc : DeleteExprsInfo.second) {
4312 AddSourceLocation(DeleteLoc.first, DeleteExprsToAnalyze);
4313 DeleteExprsToAnalyze.push_back(DeleteLoc.second);
4314 }
4315 }
4316
Douglas Gregor112b9072012-10-18 05:31:06 +00004317 // Write the control block
Adrian Prantladbd2b12015-09-22 23:26:31 +00004318 uint64_t Signature = WriteControlBlock(PP, Context, isysroot, OutputFile);
Douglas Gregor112b9072012-10-18 05:31:06 +00004319
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004320 // Write the remaining AST contents.
Sebastian Redl539c5062010-08-18 23:57:32 +00004321 Stream.EnterSubblock(AST_BLOCK_ID, 5);
Douglas Gregor851443c2011-08-12 01:39:19 +00004322
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004323 // This is so that older clang versions, before the introduction
4324 // of the control block, can read and reject the newer PCH format.
Mehdi Amini57a41912015-09-10 01:46:39 +00004325 {
4326 RecordData Record = {VERSION_MAJOR};
4327 Stream.EmitRecord(METADATA_OLD_FORMAT, Record);
4328 }
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004329
Douglas Gregor851443c2011-08-12 01:39:19 +00004330 // Create a lexical update block containing all of the declarations in the
4331 // translation unit that do not come from other AST files.
4332 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
Richard Smith82f8fcd2015-08-06 22:07:25 +00004333 SmallVector<uint32_t, 128> NewGlobalKindDeclPairs;
4334 for (const auto *D : TU->noload_decls()) {
4335 if (!D->isFromASTFile()) {
4336 NewGlobalKindDeclPairs.push_back(D->getKind());
4337 NewGlobalKindDeclPairs.push_back(GetDeclRef(D));
4338 }
Douglas Gregor851443c2011-08-12 01:39:19 +00004339 }
4340
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004341 auto *Abv = new llvm::BitCodeAbbrev();
Douglas Gregor851443c2011-08-12 01:39:19 +00004342 Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
4343 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4344 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(Abv);
Mehdi Amini57a41912015-09-10 01:46:39 +00004345 {
4346 RecordData::value_type Record[] = {TU_UPDATE_LEXICAL};
4347 Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
4348 bytes(NewGlobalKindDeclPairs));
4349 }
4350
Douglas Gregor851443c2011-08-12 01:39:19 +00004351 // And a visible updates block for the translation unit.
4352 Abv = new llvm::BitCodeAbbrev();
4353 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
4354 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
Douglas Gregor851443c2011-08-12 01:39:19 +00004355 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
4356 UpdateVisibleAbbrev = Stream.EmitAbbrev(Abv);
4357 WriteDeclContextVisibleUpdate(TU);
Richard Smithf19e1272015-03-07 00:04:49 +00004358
4359 // If we have any extern "C" names, write out a visible update for them.
4360 if (Context.ExternCContext)
4361 WriteDeclContextVisibleUpdate(Context.ExternCContext);
Douglas Gregor851443c2011-08-12 01:39:19 +00004362
4363 // If the translation unit has an anonymous namespace, and we don't already
4364 // have an update block for it, write it as an update block.
Richard Smith6ef42932014-03-20 21:02:00 +00004365 // FIXME: Why do we not do this if there's already an update block?
Douglas Gregor851443c2011-08-12 01:39:19 +00004366 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
4367 ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
Richard Smith6ef42932014-03-20 21:02:00 +00004368 if (Record.empty())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004369 Record.push_back(DeclUpdate(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE, NS));
Douglas Gregor851443c2011-08-12 01:39:19 +00004370 }
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004371
Richard Smith5652c0f2014-03-21 01:48:23 +00004372 // Add update records for all mangling numbers and static local numbers.
4373 // These aren't really update records, but this is a convenient way of
4374 // tagging this rare extra data onto the declarations.
4375 for (const auto &Number : Context.MangleNumbers)
4376 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004377 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_MANGLING_NUMBER,
4378 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004379 for (const auto &Number : Context.StaticLocalNumbers)
4380 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004381 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_STATIC_LOCAL_NUMBER,
4382 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004383
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004384 // Make sure visible decls, added to DeclContexts previously loaded from
4385 // an AST file, are registered for serialization.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004386 for (const auto *I : UpdatingVisibleDecls) {
4387 GetDeclRef(I);
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004388 }
4389
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004390 // Make sure all decls associated with an identifier are registered for
Richard Smith79bf9202015-08-24 03:33:22 +00004391 // serialization, if we're storing decls with identifiers.
4392 if (!WritingModule || !getLangOpts().CPlusPlus) {
4393 llvm::SmallVector<const IdentifierInfo*, 256> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004394 for (const auto &ID : PP.getIdentifierTable()) {
4395 const IdentifierInfo *II = ID.second;
Richard Smith79bf9202015-08-24 03:33:22 +00004396 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
4397 IIs.push_back(II);
4398 }
4399 // Sort the identifiers to visit based on their name.
4400 std::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>());
4401 for (const IdentifierInfo *II : IIs) {
4402 for (IdentifierResolver::iterator D = SemaRef.IdResolver.begin(II),
4403 DEnd = SemaRef.IdResolver.end();
4404 D != DEnd; ++D) {
4405 GetDeclRef(*D);
4406 }
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004407 }
4408 }
4409
Douglas Gregor5204bde2011-08-02 16:26:37 +00004410 // Form the record of special types.
4411 RecordData SpecialTypes;
Douglas Gregor5204bde2011-08-02 16:26:37 +00004412 AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004413 AddTypeRef(Context.getFILEType(), SpecialTypes);
4414 AddTypeRef(Context.getjmp_bufType(), SpecialTypes);
4415 AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes);
4416 AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes);
4417 AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004418 AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes);
Rafael Espindola6cfa82b2011-11-13 21:51:09 +00004419 AddTypeRef(Context.getucontext_tType(), SpecialTypes);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004420
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004421 if (Chain) {
4422 // Write the mapping information describing our module dependencies and how
4423 // each of those modules were mapped into our own offset/ID space, so that
4424 // the reader can build the appropriate mapping to its own offset/ID space.
4425 // The map consists solely of a blob with the following format:
4426 // *(module-name-len:i16 module-name:len*i8
4427 // source-location-offset:i32
4428 // identifier-id:i32
4429 // preprocessed-entity-id:i32
4430 // macro-definition-id:i32
Douglas Gregor253eefe2011-12-01 00:59:36 +00004431 // submodule-id:i32
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004432 // selector-id:i32
4433 // declaration-id:i32
4434 // c++-base-specifiers-id:i32
4435 // type-id:i32)
4436 //
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004437 auto *Abbrev = new BitCodeAbbrev();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004438 Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
4439 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
4440 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(Abbrev);
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004441 SmallString<2048> Buffer;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004442 {
4443 llvm::raw_svector_ostream Out(Buffer);
Ben Langmuir785180e2014-10-20 16:27:30 +00004444 for (ModuleFile *M : Chain->ModuleMgr) {
Justin Bognere1c147c2014-03-28 22:03:19 +00004445 using namespace llvm::support;
4446 endian::Writer<little> LE(Out);
Ben Langmuir785180e2014-10-20 16:27:30 +00004447 StringRef FileName = M->FileName;
Justin Bognere1c147c2014-03-28 22:03:19 +00004448 LE.write<uint16_t>(FileName.size());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004449 Out.write(FileName.data(), FileName.size());
Ben Langmuirfe971d92014-08-16 04:54:18 +00004450
Ben Langmuir785180e2014-10-20 16:27:30 +00004451 // Note: if a base ID was uint max, it would not be possible to load
4452 // another module after it or have more than one entity inside it.
4453 uint32_t None = std::numeric_limits<uint32_t>::max();
4454
4455 auto writeBaseIDOrNone = [&](uint32_t BaseID, bool ShouldWrite) {
4456 assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
4457 if (ShouldWrite)
4458 LE.write<uint32_t>(BaseID);
4459 else
4460 LE.write<uint32_t>(None);
4461 };
4462
Ben Langmuirfe971d92014-08-16 04:54:18 +00004463 // These values should be unique within a chain, since they will be read
4464 // as keys into ContinuousRangeMaps.
Ben Langmuir785180e2014-10-20 16:27:30 +00004465 writeBaseIDOrNone(M->SLocEntryBaseOffset, M->LocalNumSLocEntries);
4466 writeBaseIDOrNone(M->BaseIdentifierID, M->LocalNumIdentifiers);
4467 writeBaseIDOrNone(M->BaseMacroID, M->LocalNumMacros);
4468 writeBaseIDOrNone(M->BasePreprocessedEntityID,
4469 M->NumPreprocessedEntities);
4470 writeBaseIDOrNone(M->BaseSubmoduleID, M->LocalNumSubmodules);
4471 writeBaseIDOrNone(M->BaseSelectorID, M->LocalNumSelectors);
4472 writeBaseIDOrNone(M->BaseDeclID, M->LocalNumDecls);
4473 writeBaseIDOrNone(M->BaseTypeIndex, M->LocalNumTypes);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004474 }
4475 }
Mehdi Amini57a41912015-09-10 01:46:39 +00004476 RecordData::value_type Record[] = {MODULE_OFFSET_MAP};
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004477 Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
4478 Buffer.data(), Buffer.size());
4479 }
Richard Smithb9eab6d2014-03-20 19:44:17 +00004480
Richard Smithb9eab6d2014-03-20 19:44:17 +00004481 RecordData DeclUpdatesOffsetsRecord;
4482
Richard Smith59442b42014-03-20 20:07:19 +00004483 // Keep writing types, declarations, and declaration update records
4484 // until we've emitted all of them.
Richard Smith01b2cb42014-07-26 06:37:51 +00004485 Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/5);
4486 WriteTypeAbbrevs();
4487 WriteDeclAbbrevs();
Richard Smith59442b42014-03-20 20:07:19 +00004488 do {
4489 WriteDeclUpdatesBlocks(DeclUpdatesOffsetsRecord);
4490 while (!DeclTypesToEmit.empty()) {
4491 DeclOrType DOT = DeclTypesToEmit.front();
4492 DeclTypesToEmit.pop();
4493 if (DOT.isType())
4494 WriteType(DOT.getType());
4495 else
4496 WriteDecl(Context, DOT.getDecl());
4497 }
4498 } while (!DeclUpdates.empty());
Richard Smithb9eab6d2014-03-20 19:44:17 +00004499 Stream.ExitBlock();
4500
Richard Smithb9eab6d2014-03-20 19:44:17 +00004501 DoneWritingDeclsAndTypes = true;
4502
4503 // These things can only be done once we've written out decls and types.
4504 WriteTypeDeclOffsets();
Richard Smith5652c0f2014-03-21 01:48:23 +00004505 if (!DeclUpdatesOffsetsRecord.empty())
4506 Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord);
Richard Smithb9eab6d2014-03-20 19:44:17 +00004507 WriteCXXBaseSpecifiersOffsets();
Richard Smithc2bb8182015-03-24 06:36:48 +00004508 WriteCXXCtorInitializersOffsets();
Richard Smithb9eab6d2014-03-20 19:44:17 +00004509 WriteFileDeclIDsMap();
Richard Smith7ed1bc92014-12-05 22:42:13 +00004510 WriteSourceManagerBlock(Context.getSourceManager(), PP);
Richard Smithb9eab6d2014-03-20 19:44:17 +00004511 WriteComments();
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004512 WritePreprocessor(PP, isModule);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004513 WriteHeaderSearch(PP.getHeaderSearchInfo());
Sebastian Redla19a67f2010-08-03 21:58:15 +00004514 WriteSelectors(SemaRef);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00004515 WriteReferencedSelectorsPool(SemaRef);
Richard Smith9c254182015-07-19 21:41:12 +00004516 WriteLateParsedTemplates(SemaRef);
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004517 WriteIdentifierTable(PP, SemaRef.IdResolver, isModule);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004518 WriteFPPragmaOptions(SemaRef.getFPOptions());
4519 WriteOpenCLExtensions(SemaRef);
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00004520 WritePragmaDiagnosticMappings(Context.getDiagnostics(), isModule);
Douglas Gregor652d82a2009-04-18 05:55:16 +00004521
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004522 // If we're emitting a module, write out the submodule information.
4523 if (WritingModule)
4524 WriteSubmodules(WritingModule);
4525
Douglas Gregor5204bde2011-08-02 16:26:37 +00004526 Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
4527
Douglas Gregord4df8652009-04-22 22:02:47 +00004528 // Write the record containing external, unnamed definitions.
Ben Langmuir332aafe2014-01-31 01:06:56 +00004529 if (!EagerlyDeserializedDecls.empty())
4530 Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls);
Douglas Gregord4df8652009-04-22 22:02:47 +00004531
4532 // Write the record containing tentative definitions.
4533 if (!TentativeDefinitions.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004534 Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
Douglas Gregoracfc76c2009-04-22 22:18:58 +00004535
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004536 // Write the record containing unused file scoped decls.
4537 if (!UnusedFileScopedDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004538 Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004539
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004540 // Write the record containing weak undeclared identifiers.
4541 if (!WeakUndeclaredIdentifiers.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004542 Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004543 WeakUndeclaredIdentifiers);
4544
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004545 // Write the record containing ext_vector type names.
4546 if (!ExtVectorDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004547 Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
Mike Stump11289f42009-09-09 15:08:12 +00004548
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004549 // Write the record containing VTable uses information.
4550 if (!VTableUses.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004551 Stream.EmitRecord(VTABLE_USES, VTableUses);
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004552
Nico Weber72889432014-09-06 01:25:55 +00004553 // Write the record containing potentially unused local typedefs.
4554 if (!UnusedLocalTypedefNameCandidates.empty())
4555 Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
4556 UnusedLocalTypedefNameCandidates);
4557
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004558 // Write the record containing pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004559 if (!PendingInstantiations.empty())
4560 Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004561
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004562 // Write the record containing declaration references of Sema.
4563 if (!SemaDeclRefs.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004564 Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004565
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004566 // Write the record containing CUDA-specific declaration references.
4567 if (!CUDASpecialDeclRefs.empty())
4568 Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004569
4570 // Write the delegating constructors.
4571 if (!DelegatingCtorDecls.empty())
4572 Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004573
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004574 // Write the known namespaces.
4575 if (!KnownNamespaces.empty())
4576 Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
Nick Lewycky8334af82013-01-26 00:35:08 +00004577
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004578 // Write the undefined internal functions and variables, and inline functions.
4579 if (!UndefinedButUsed.empty())
4580 Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed);
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004581
4582 if (!DeleteExprsToAnalyze.empty())
4583 Stream.EmitRecord(DELETE_EXPRS_TO_ANALYZE, DeleteExprsToAnalyze);
4584
Douglas Gregor851443c2011-08-12 01:39:19 +00004585 // Write the visible updates to DeclContexts.
Richard Smithcd45dbc2014-04-19 03:48:30 +00004586 for (auto *DC : UpdatedDeclContexts)
4587 WriteDeclContextVisibleUpdate(DC);
Douglas Gregor851443c2011-08-12 01:39:19 +00004588
Douglas Gregor959bb062011-12-03 01:15:29 +00004589 if (!WritingModule) {
4590 // Write the submodules that were imported, if any.
Aaron Ballman4f45b712014-03-21 15:22:56 +00004591 struct ModuleInfo {
4592 uint64_t ID;
4593 Module *M;
4594 ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
4595 };
Richard Smith56be7542014-03-21 00:33:59 +00004596 llvm::SmallVector<ModuleInfo, 64> Imports;
Aaron Ballmanbbc31212014-03-14 20:59:21 +00004597 for (const auto *I : Context.local_imports()) {
Douglas Gregor959bb062011-12-03 01:15:29 +00004598 assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end());
Aaron Ballman4f45b712014-03-21 15:22:56 +00004599 Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()],
4600 I->getImportedModule()));
Douglas Gregor959bb062011-12-03 01:15:29 +00004601 }
Richard Smith56be7542014-03-21 00:33:59 +00004602
4603 if (!Imports.empty()) {
4604 auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
4605 return A.ID < B.ID;
4606 };
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00004607 auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
4608 return A.ID == B.ID;
4609 };
Richard Smith56be7542014-03-21 00:33:59 +00004610
4611 // Sort and deduplicate module IDs.
4612 std::sort(Imports.begin(), Imports.end(), Cmp);
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00004613 Imports.erase(std::unique(Imports.begin(), Imports.end(), Eq),
Richard Smith56be7542014-03-21 00:33:59 +00004614 Imports.end());
4615
4616 RecordData ImportedModules;
4617 for (const auto &Import : Imports) {
4618 ImportedModules.push_back(Import.ID);
4619 // FIXME: If the module has macros imported then later has declarations
4620 // imported, this location won't be the right one as a location for the
4621 // declaration imports.
Richard Smith10434f32015-05-02 02:08:26 +00004622 AddSourceLocation(PP.getModuleImportLoc(Import.M), ImportedModules);
Richard Smith56be7542014-03-21 00:33:59 +00004623 }
4624
Douglas Gregor959bb062011-12-03 01:15:29 +00004625 Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
4626 }
Douglas Gregor0a839132011-12-03 00:59:55 +00004627 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004628
Douglas Gregor404cdde2012-01-27 01:47:08 +00004629 WriteObjCCategories();
Nico Weber779355f2016-03-02 23:22:00 +00004630 if(!WritingModule) {
Dario Domizioli13a0a382014-05-23 12:13:25 +00004631 WriteOptimizePragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00004632 WriteMSStructPragmaOptions(SemaRef);
Nico Weber42932312016-03-03 00:17:35 +00004633 WriteMSPointersToMembersPragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00004634 }
Richard Smithe40f2ba2013-08-07 21:41:30 +00004635
Douglas Gregor08f01292009-04-17 22:13:46 +00004636 // Some simple statistics
Mehdi Amini57a41912015-09-10 01:46:39 +00004637 RecordData::value_type Record[] = {
4638 NumStatements, NumMacros, NumLexicalDeclContexts, NumVisibleDeclContexts};
Sebastian Redl539c5062010-08-18 23:57:32 +00004639 Stream.EmitRecord(STATISTICS, Record);
Douglas Gregor8f45df52009-04-16 22:23:12 +00004640 Stream.ExitBlock();
Adrian Prantladbd2b12015-09-22 23:26:31 +00004641
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004642 // Write the module file extension blocks.
4643 for (const auto &ExtWriter : ModuleFileExtensionWriters)
Douglas Gregor8f64ca12015-12-08 22:43:32 +00004644 WriteModuleFileExtension(SemaRef, *ExtWriter);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004645
Adrian Prantladbd2b12015-09-22 23:26:31 +00004646 return Signature;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004647}
4648
Richard Smithb9eab6d2014-03-20 19:44:17 +00004649void ASTWriter::WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord) {
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004650 if (DeclUpdates.empty())
4651 return;
4652
Richard Smith59442b42014-03-20 20:07:19 +00004653 DeclUpdateMap LocalUpdates;
4654 LocalUpdates.swap(DeclUpdates);
4655
Richard Smith6ef42932014-03-20 21:02:00 +00004656 for (auto &DeclUpdate : LocalUpdates) {
4657 const Decl *D = DeclUpdate.first;
Argyrios Kyrtzidis3ba70b82010-10-24 17:26:46 +00004658
Richard Smithd28ac5b2014-03-22 23:33:22 +00004659 bool HasUpdatedBody = false;
Richard Smith69c82bf2016-04-01 22:52:03 +00004660 RecordData RecordData;
4661 ASTRecordWriter Record(*this, RecordData);
Richard Smith6ef42932014-03-20 21:02:00 +00004662 for (auto &Update : DeclUpdate.second) {
4663 DeclUpdateKind Kind = (DeclUpdateKind)Update.getKind();
4664
Richard Smith69c82bf2016-04-01 22:52:03 +00004665 // An updated body is emitted last, so that the reader doesn't need
4666 // to skip over the lazy body to reach statements for other records.
4667 if (Kind == UPD_CXX_ADDED_FUNCTION_DEFINITION)
4668 HasUpdatedBody = true;
4669 else
4670 Record.push_back(Kind);
4671
Richard Smith6ef42932014-03-20 21:02:00 +00004672 switch (Kind) {
4673 case UPD_CXX_ADDED_IMPLICIT_MEMBER:
4674 case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION:
4675 case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE:
Richard Smithcd45dbc2014-04-19 03:48:30 +00004676 assert(Update.getDecl() && "no decl to add?");
Richard Smith6ef42932014-03-20 21:02:00 +00004677 Record.push_back(GetDeclRef(Update.getDecl()));
4678 break;
4679
Richard Smith4d235792014-08-07 18:53:08 +00004680 case UPD_CXX_ADDED_FUNCTION_DEFINITION:
Richard Smithd28ac5b2014-03-22 23:33:22 +00004681 break;
4682
Richard Smith4d235792014-08-07 18:53:08 +00004683 case UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER:
Richard Smith69c82bf2016-04-01 22:52:03 +00004684 Record.AddSourceLocation(Update.getLoc());
Richard Smith4d235792014-08-07 18:53:08 +00004685 break;
4686
John McCall32791cc2016-01-06 22:34:54 +00004687 case UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT:
Richard Smith5811c402016-04-06 06:26:08 +00004688 Record.AddStmt(const_cast<Expr *>(
4689 cast<ParmVarDecl>(Update.getDecl())->getDefaultArg()));
John McCall32791cc2016-01-06 22:34:54 +00004690 break;
4691
Richard Smithcd45dbc2014-04-19 03:48:30 +00004692 case UPD_CXX_INSTANTIATED_CLASS_DEFINITION: {
4693 auto *RD = cast<CXXRecordDecl>(D);
Chandler Carruth8a3d24d2015-03-26 04:27:10 +00004694 UpdatedDeclContexts.insert(RD->getPrimaryContext());
Richard Smith69c82bf2016-04-01 22:52:03 +00004695 Record.AddCXXDefinitionData(RD);
Richard Smithcd45dbc2014-04-19 03:48:30 +00004696 Record.push_back(WriteDeclContextLexicalBlock(
4697 *Context, const_cast<CXXRecordDecl *>(RD)));
4698
4699 // This state is sometimes updated by template instantiation, when we
4700 // switch from the specialization referring to the template declaration
4701 // to it referring to the template definition.
4702 if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
4703 Record.push_back(MSInfo->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00004704 Record.AddSourceLocation(MSInfo->getPointOfInstantiation());
Richard Smithcd45dbc2014-04-19 03:48:30 +00004705 } else {
4706 auto *Spec = cast<ClassTemplateSpecializationDecl>(RD);
4707 Record.push_back(Spec->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00004708 Record.AddSourceLocation(Spec->getPointOfInstantiation());
Richard Smithdf352052014-05-22 20:59:29 +00004709
4710 // The instantiation might have been resolved to a partial
4711 // specialization. If so, record which one.
4712 auto From = Spec->getInstantiatedFrom();
4713 if (auto PartialSpec =
4714 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
4715 Record.push_back(true);
Richard Smith69c82bf2016-04-01 22:52:03 +00004716 Record.AddDeclRef(PartialSpec);
4717 Record.AddTemplateArgumentList(
4718 &Spec->getTemplateInstantiationArgs());
Richard Smithdf352052014-05-22 20:59:29 +00004719 } else {
4720 Record.push_back(false);
4721 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00004722 }
4723 Record.push_back(RD->getTagKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00004724 Record.AddSourceLocation(RD->getLocation());
4725 Record.AddSourceLocation(RD->getLocStart());
4726 Record.AddSourceLocation(RD->getRBraceLoc());
Richard Smithcd45dbc2014-04-19 03:48:30 +00004727
4728 // Instantiation may change attributes; write them all out afresh.
4729 Record.push_back(D->hasAttrs());
Richard Smith69c82bf2016-04-01 22:52:03 +00004730 if (D->hasAttrs())
4731 Record.AddAttributes(D->getAttrs());
Richard Smithcd45dbc2014-04-19 03:48:30 +00004732
4733 // FIXME: Ensure we don't get here for explicit instantiations.
4734 break;
4735 }
4736
Richard Smithf8134002015-03-10 01:41:22 +00004737 case UPD_CXX_RESOLVED_DTOR_DELETE:
Richard Smith69c82bf2016-04-01 22:52:03 +00004738 Record.AddDeclRef(Update.getDecl());
Richard Smithf8134002015-03-10 01:41:22 +00004739 break;
4740
Richard Smith564417a2014-03-20 21:47:22 +00004741 case UPD_CXX_RESOLVED_EXCEPTION_SPEC:
4742 addExceptionSpec(
Richard Smith564417a2014-03-20 21:47:22 +00004743 cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>(),
4744 Record);
4745 break;
4746
Richard Smith6ef42932014-03-20 21:02:00 +00004747 case UPD_CXX_DEDUCED_RETURN_TYPE:
4748 Record.push_back(GetOrCreateTypeID(Update.getType()));
4749 break;
4750
4751 case UPD_DECL_MARKED_USED:
4752 break;
Richard Smith5652c0f2014-03-21 01:48:23 +00004753
4754 case UPD_MANGLING_NUMBER:
4755 case UPD_STATIC_LOCAL_NUMBER:
4756 Record.push_back(Update.getNumber());
4757 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00004758
Alexey Bataev97720002014-11-11 04:05:39 +00004759 case UPD_DECL_MARKED_OPENMP_THREADPRIVATE:
Richard Smith69c82bf2016-04-01 22:52:03 +00004760 Record.AddSourceRange(
4761 D->getAttr<OMPThreadPrivateDeclAttr>()->getRange());
Alexey Bataev97720002014-11-11 04:05:39 +00004762 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00004763
4764 case UPD_DECL_EXPORTED:
Richard Smith4caa4492015-05-15 02:34:32 +00004765 Record.push_back(getSubmoduleID(Update.getModule()));
Richard Smith65ebb4a2015-03-26 04:09:53 +00004766 break;
Alex Denisovfde64952015-06-26 05:28:36 +00004767
4768 case UPD_ADDED_ATTR_TO_RECORD:
Richard Smith69c82bf2016-04-01 22:52:03 +00004769 Record.AddAttributes(llvm::makeArrayRef(Update.getAttr()));
Alex Denisovfde64952015-06-26 05:28:36 +00004770 break;
Richard Smith6ef42932014-03-20 21:02:00 +00004771 }
4772 }
4773
Richard Smithd28ac5b2014-03-22 23:33:22 +00004774 if (HasUpdatedBody) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004775 const auto *Def = cast<FunctionDecl>(D);
Richard Smith4d235792014-08-07 18:53:08 +00004776 Record.push_back(UPD_CXX_ADDED_FUNCTION_DEFINITION);
Richard Smithd28ac5b2014-03-22 23:33:22 +00004777 Record.push_back(Def->isInlined());
Richard Smith69c82bf2016-04-01 22:52:03 +00004778 Record.AddSourceLocation(Def->getInnerLocStart());
Richard Smith5811c402016-04-06 06:26:08 +00004779 Record.AddFunctionDefinition(Def);
Richard Smithd28ac5b2014-03-22 23:33:22 +00004780 }
4781
Richard Smithcd45dbc2014-04-19 03:48:30 +00004782 OffsetsRecord.push_back(GetDeclRef(D));
Richard Smith69c82bf2016-04-01 22:52:03 +00004783 OffsetsRecord.push_back(Record.Emit(DECL_UPDATES));
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004784
Richard Smithc2bb8182015-03-24 06:36:48 +00004785 FlushPendingAfterDecl();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004786 }
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004787}
4788
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004789void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
Richard Smithb22a1d12016-03-27 20:13:24 +00004790 uint32_t Raw = Loc.getRawEncoding();
4791 Record.push_back((Raw << 1) | (Raw >> 31));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004792}
4793
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004794void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00004795 AddSourceLocation(Range.getBegin(), Record);
4796 AddSourceLocation(Range.getEnd(), Record);
4797}
4798
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004799void ASTWriter::AddAPInt(const llvm::APInt &Value, RecordDataImpl &Record) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004800 Record.push_back(Value.getBitWidth());
Benjamin Kramer25f9ea62010-09-06 23:43:28 +00004801 const uint64_t *Words = Value.getRawData();
4802 Record.append(Words, Words + Value.getNumWords());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004803}
4804
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004805void ASTWriter::AddAPSInt(const llvm::APSInt &Value, RecordDataImpl &Record) {
Douglas Gregor1daeb692009-04-13 18:14:40 +00004806 Record.push_back(Value.isUnsigned());
4807 AddAPInt(Value, Record);
4808}
4809
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004810void ASTWriter::AddAPFloat(const llvm::APFloat &Value, RecordDataImpl &Record) {
Douglas Gregore0a3a512009-04-14 21:55:33 +00004811 AddAPInt(Value.bitcastToAPInt(), Record);
4812}
4813
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004814void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004815 Record.push_back(getIdentifierRef(II));
4816}
4817
Sebastian Redl539c5062010-08-18 23:57:32 +00004818IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
Craig Toppera13603a2014-05-22 05:54:18 +00004819 if (!II)
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004820 return 0;
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00004821
Sebastian Redl539c5062010-08-18 23:57:32 +00004822 IdentID &ID = IdentifierIDs[II];
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00004823 if (ID == 0)
Sebastian Redlff4a2952010-07-23 23:49:55 +00004824 ID = NextIdentID++;
Douglas Gregor4621c6a2009-04-22 18:49:13 +00004825 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004826}
4827
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004828MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004829 // Don't emit builtin macros like __LINE__ to the AST file unless they
4830 // have been redefined by the header (in which case they are not
4831 // isBuiltinMacro).
Craig Toppera13603a2014-05-22 05:54:18 +00004832 if (!MI || MI->isBuiltinMacro())
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004833 return 0;
4834
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004835 MacroID &ID = MacroIDs[MI];
4836 if (ID == 0) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004837 ID = NextMacroID++;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004838 MacroInfoToEmitData Info = { Name, MI, ID };
4839 MacroInfosToEmit.push_back(Info);
4840 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00004841 return ID;
4842}
4843
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004844MacroID ASTWriter::getMacroID(MacroInfo *MI) {
Craig Toppera13603a2014-05-22 05:54:18 +00004845 if (!MI || MI->isBuiltinMacro())
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004846 return 0;
4847
4848 assert(MacroIDs.find(MI) != MacroIDs.end() && "Macro not emitted!");
4849 return MacroIDs[MI];
4850}
4851
4852uint64_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) {
Richard Smithd7329392015-04-21 21:46:32 +00004853 return IdentMacroDirectivesOffsetMap.lookup(Name);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00004854}
4855
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004856void ASTWriter::AddSelectorRef(const Selector SelRef, RecordDataImpl &Record) {
Sebastian Redl834bb972010-08-04 17:20:04 +00004857 Record.push_back(getSelectorRef(SelRef));
4858}
4859
Sebastian Redl539c5062010-08-18 23:57:32 +00004860SelectorID ASTWriter::getSelectorRef(Selector Sel) {
Craig Toppera13603a2014-05-22 05:54:18 +00004861 if (Sel.getAsOpaquePtr() == nullptr) {
Sebastian Redl834bb972010-08-04 17:20:04 +00004862 return 0;
Steve Naroff2ddea052009-04-23 10:39:46 +00004863 }
4864
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004865 SelectorID SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00004866 if (SID == 0 && Chain) {
4867 // This might trigger a ReadSelector callback, which will set the ID for
4868 // this selector.
4869 Chain->LoadSelector(Sel);
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004870 SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00004871 }
Steve Naroff2ddea052009-04-23 10:39:46 +00004872 if (SID == 0) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00004873 SID = NextSelectorID++;
Douglas Gregor8d7edce2013-02-08 21:30:59 +00004874 SelectorIDs[Sel] = SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00004875 }
Sebastian Redl834bb972010-08-04 17:20:04 +00004876 return SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00004877}
4878
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004879void ASTWriter::AddCXXTemporary(const CXXTemporary *Temp, RecordDataImpl &Record) {
Chris Lattnercba86142010-05-10 00:25:06 +00004880 AddDeclRef(Temp->getDestructor(), Record);
4881}
4882
Richard Smithc2bb8182015-03-24 06:36:48 +00004883void ASTWriter::AddCXXCtorInitializersRef(ArrayRef<CXXCtorInitializer *> Inits,
4884 RecordDataImpl &Record) {
4885 assert(!Inits.empty() && "Empty ctor initializer sets are not recorded");
4886 CXXCtorInitializersToWrite.push_back(
4887 QueuedCXXCtorInitializers(NextCXXCtorInitializersID, Inits));
4888 Record.push_back(NextCXXCtorInitializersID++);
4889}
4890
Douglas Gregord4c5ed02010-10-29 22:39:52 +00004891void ASTWriter::AddCXXBaseSpecifiersRef(CXXBaseSpecifier const *Bases,
Richard Smithc2bb8182015-03-24 06:36:48 +00004892 CXXBaseSpecifier const *BasesEnd,
Douglas Gregord4c5ed02010-10-29 22:39:52 +00004893 RecordDataImpl &Record) {
4894 assert(Bases != BasesEnd && "Empty base-specifier sets are not recorded");
4895 CXXBaseSpecifiersToWrite.push_back(
4896 QueuedCXXBaseSpecifiers(NextCXXBaseSpecifiersID,
4897 Bases, BasesEnd));
4898 Record.push_back(NextCXXBaseSpecifiersID++);
4899}
4900
Richard Smith5811c402016-04-06 06:26:08 +00004901void ASTRecordWriter::AddTemplateArgumentLocInfo(
4902 TemplateArgument::ArgKind Kind, const TemplateArgumentLocInfo &Arg) {
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004903 switch (Kind) {
John McCall0ad16662009-10-29 08:12:44 +00004904 case TemplateArgument::Expression:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004905 AddStmt(Arg.getAsExpr());
John McCall0ad16662009-10-29 08:12:44 +00004906 break;
4907 case TemplateArgument::Type:
Richard Smith5811c402016-04-06 06:26:08 +00004908 AddTypeSourceInfo(Arg.getAsTypeSourceInfo());
John McCall0ad16662009-10-29 08:12:44 +00004909 break;
Douglas Gregor9167f8b2009-11-11 01:00:40 +00004910 case TemplateArgument::Template:
Richard Smith5811c402016-04-06 06:26:08 +00004911 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
4912 AddSourceLocation(Arg.getTemplateNameLoc());
Douglas Gregore4ff4b52011-01-05 18:58:31 +00004913 break;
4914 case TemplateArgument::TemplateExpansion:
Richard Smith5811c402016-04-06 06:26:08 +00004915 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
4916 AddSourceLocation(Arg.getTemplateNameLoc());
4917 AddSourceLocation(Arg.getTemplateEllipsisLoc());
Douglas Gregor9167f8b2009-11-11 01:00:40 +00004918 break;
John McCall0ad16662009-10-29 08:12:44 +00004919 case TemplateArgument::Null:
4920 case TemplateArgument::Integral:
4921 case TemplateArgument::Declaration:
Eli Friedmanb826a002012-09-26 02:36:12 +00004922 case TemplateArgument::NullPtr:
John McCall0ad16662009-10-29 08:12:44 +00004923 case TemplateArgument::Pack:
Eli Friedmanb826a002012-09-26 02:36:12 +00004924 // FIXME: Is this right?
John McCall0ad16662009-10-29 08:12:44 +00004925 break;
4926 }
4927}
4928
Richard Smith5811c402016-04-06 06:26:08 +00004929void ASTRecordWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg) {
4930 AddTemplateArgument(Arg.getArgument());
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00004931
4932 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
4933 bool InfoHasSameExpr
4934 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
Richard Smith5811c402016-04-06 06:26:08 +00004935 Record->push_back(InfoHasSameExpr);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00004936 if (InfoHasSameExpr)
4937 return; // Avoid storing the same expr twice.
4938 }
Richard Smith5811c402016-04-06 06:26:08 +00004939 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo());
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00004940}
4941
Richard Smith5811c402016-04-06 06:26:08 +00004942void ASTRecordWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo) {
Craig Toppera13603a2014-05-22 05:54:18 +00004943 if (!TInfo) {
Richard Smith5811c402016-04-06 06:26:08 +00004944 AddTypeRef(QualType());
John McCall8f115c62009-10-16 21:56:05 +00004945 return;
4946 }
4947
Richard Smith5811c402016-04-06 06:26:08 +00004948 AddTypeLoc(TInfo->getTypeLoc());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00004949}
4950
Richard Smith5811c402016-04-06 06:26:08 +00004951void ASTRecordWriter::AddTypeLoc(TypeLoc TL) {
4952 AddTypeRef(TL.getType());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00004953
Richard Smith5811c402016-04-06 06:26:08 +00004954 TypeLocWriter TLW(*this);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00004955 for (; !TL.isNull(); TL = TL.getNextTypeLoc())
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004956 TLW.Visit(TL);
John McCall8f115c62009-10-16 21:56:05 +00004957}
4958
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00004959void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
Argyrios Kyrtzidis9ab44ea2010-08-20 16:04:14 +00004960 Record.push_back(GetOrCreateTypeID(T));
4961}
4962
Richard Smith2095ffe2015-03-16 20:11:03 +00004963TypeID ASTWriter::GetOrCreateTypeID(QualType T) {
Richard Smith1fa5d642013-05-11 05:45:24 +00004964 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00004965 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
4966 if (T.isNull())
4967 return TypeIdx();
4968 assert(!T.getLocalFastQualifiers());
4969
4970 TypeIdx &Idx = TypeIdxs[T];
4971 if (Idx.getIndex() == 0) {
4972 if (DoneWritingDeclsAndTypes) {
4973 assert(0 && "New type seen after serializing all the types to emit!");
4974 return TypeIdx();
4975 }
4976
4977 // We haven't seen this type before. Assign it a new ID and put it
4978 // into the queue of types to emit.
4979 Idx = TypeIdx(NextTypeID++);
4980 DeclTypesToEmit.push(T);
4981 }
4982 return Idx;
4983 });
Argyrios Kyrtzidis082e4612010-08-20 16:04:20 +00004984}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004985
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00004986TypeID ASTWriter::getTypeID(QualType T) const {
Richard Smith1fa5d642013-05-11 05:45:24 +00004987 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00004988 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
4989 if (T.isNull())
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004990 return TypeIdx();
Richard Smith2095ffe2015-03-16 20:11:03 +00004991 assert(!T.getLocalFastQualifiers());
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004992
Richard Smith2095ffe2015-03-16 20:11:03 +00004993 TypeIdxMap::const_iterator I = TypeIdxs.find(T);
4994 assert(I != TypeIdxs.end() && "Type not emitted!");
4995 return I->second;
4996 });
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004997}
4998
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00004999void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005000 Record.push_back(GetDeclRef(D));
5001}
5002
Sebastian Redl539c5062010-08-18 23:57:32 +00005003DeclID ASTWriter::GetDeclRef(const Decl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005004 assert(WritingAST && "Cannot request a declaration ID before AST writing");
Craig Toppera13603a2014-05-22 05:54:18 +00005005
5006 if (!D) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005007 return 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005008 }
Douglas Gregorb3163e52012-01-05 22:33:30 +00005009
5010 // If D comes from an AST file, its declaration ID is already known and
5011 // fixed.
5012 if (D->isFromASTFile())
5013 return D->getGlobalID();
5014
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005015 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
Sebastian Redl539c5062010-08-18 23:57:32 +00005016 DeclID &ID = DeclIDs[D];
Mike Stump11289f42009-09-09 15:08:12 +00005017 if (ID == 0) {
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005018 if (DoneWritingDeclsAndTypes) {
5019 assert(0 && "New decl seen after serializing all the decls to emit!");
5020 return 0;
5021 }
5022
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005023 // We haven't seen this declaration before. Give it a new ID and
5024 // enqueue it in the list of declarations to emit.
Sebastian Redlff4a2952010-07-23 23:49:55 +00005025 ID = NextDeclID++;
Douglas Gregor12bfa382009-10-17 00:13:19 +00005026 DeclTypesToEmit.push(const_cast<Decl *>(D));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005027 }
5028
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005029 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005030}
5031
Sebastian Redl539c5062010-08-18 23:57:32 +00005032DeclID ASTWriter::getDeclID(const Decl *D) {
Craig Toppera13603a2014-05-22 05:54:18 +00005033 if (!D)
Douglas Gregore84a9da2009-04-20 20:36:09 +00005034 return 0;
5035
Douglas Gregorb3163e52012-01-05 22:33:30 +00005036 // If D comes from an AST file, its declaration ID is already known and
5037 // fixed.
5038 if (D->isFromASTFile())
5039 return D->getGlobalID();
5040
Douglas Gregore84a9da2009-04-20 20:36:09 +00005041 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
5042 return DeclIDs[D];
5043}
5044
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005045void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005046 assert(ID);
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005047 assert(D);
5048
5049 SourceLocation Loc = D->getLocation();
5050 if (Loc.isInvalid())
5051 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005052
5053 // We only keep track of the file-level declarations of each file.
5054 if (!D->getLexicalDeclContext()->isFileContext())
5055 return;
Argyrios Kyrtzidise1bc99e2012-02-24 19:45:46 +00005056 // FIXME: ParmVarDecls that are part of a function type of a parameter of
5057 // a function/objc method, should not have TU as lexical context.
Argyrios Kyrtzidisffe055a82012-02-24 01:12:38 +00005058 if (isa<ParmVarDecl>(D))
5059 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005060
5061 SourceManager &SM = Context->getSourceManager();
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005062 SourceLocation FileLoc = SM.getFileLoc(Loc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005063 assert(SM.isLocalSourceLocation(FileLoc));
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005064 FileID FID;
5065 unsigned Offset;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00005066 std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005067 if (FID.isInvalid())
5068 return;
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005069 assert(SM.getSLocEntry(FID).isFile());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005070
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005071 DeclIDInFileInfo *&Info = FileDeclIDs[FID];
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005072 if (!Info)
5073 Info = new DeclIDInFileInfo();
5074
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005075 std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005076 LocDeclIDsTy &Decls = Info->DeclIDs;
5077
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005078 if (Decls.empty() || Decls.back().first <= Offset) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005079 Decls.push_back(LocDecl);
5080 return;
5081 }
5082
Benjamin Kramer45025c02013-08-24 13:22:59 +00005083 LocDeclIDsTy::iterator I =
5084 std::upper_bound(Decls.begin(), Decls.end(), LocDecl, llvm::less_first());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005085
5086 Decls.insert(I, LocDecl);
5087}
5088
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005089void ASTWriter::AddDeclarationName(DeclarationName Name, RecordDataImpl &Record) {
Chris Lattner258172e2009-04-27 07:35:58 +00005090 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc.
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005091 Record.push_back(Name.getNameKind());
5092 switch (Name.getNameKind()) {
5093 case DeclarationName::Identifier:
5094 AddIdentifierRef(Name.getAsIdentifierInfo(), Record);
5095 break;
5096
5097 case DeclarationName::ObjCZeroArgSelector:
5098 case DeclarationName::ObjCOneArgSelector:
5099 case DeclarationName::ObjCMultiArgSelector:
Steve Naroff2ddea052009-04-23 10:39:46 +00005100 AddSelectorRef(Name.getObjCSelector(), Record);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005101 break;
5102
5103 case DeclarationName::CXXConstructorName:
5104 case DeclarationName::CXXDestructorName:
5105 case DeclarationName::CXXConversionFunctionName:
5106 AddTypeRef(Name.getCXXNameType(), Record);
5107 break;
5108
5109 case DeclarationName::CXXOperatorName:
5110 Record.push_back(Name.getCXXOverloadedOperator());
5111 break;
5112
Alexis Hunt3d221f22009-11-29 07:34:05 +00005113 case DeclarationName::CXXLiteralOperatorName:
5114 AddIdentifierRef(Name.getCXXLiteralIdentifier(), Record);
5115 break;
5116
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005117 case DeclarationName::CXXUsingDirective:
5118 // No extra data to emit
5119 break;
5120 }
5121}
Chris Lattnerca025db2010-05-07 21:43:38 +00005122
Richard Smithd08aeb62014-08-28 01:33:39 +00005123unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) {
5124 assert(needsAnonymousDeclarationNumber(D) &&
5125 "expected an anonymous declaration");
5126
5127 // Number the anonymous declarations within this context, if we've not
5128 // already done so.
5129 auto It = AnonymousDeclarationNumbers.find(D);
5130 if (It == AnonymousDeclarationNumbers.end()) {
Richard Smith2b560572015-02-07 03:11:11 +00005131 auto *DC = D->getLexicalDeclContext();
5132 numberAnonymousDeclsWithin(DC, [&](const NamedDecl *ND, unsigned Number) {
5133 AnonymousDeclarationNumbers[ND] = Number;
5134 });
Richard Smithd08aeb62014-08-28 01:33:39 +00005135
5136 It = AnonymousDeclarationNumbers.find(D);
5137 assert(It != AnonymousDeclarationNumbers.end() &&
5138 "declaration not found within its lexical context");
5139 }
5140
5141 return It->second;
5142}
5143
Richard Smith5811c402016-04-06 06:26:08 +00005144void ASTRecordWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
5145 DeclarationName Name) {
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005146 switch (Name.getNameKind()) {
5147 case DeclarationName::CXXConstructorName:
5148 case DeclarationName::CXXDestructorName:
5149 case DeclarationName::CXXConversionFunctionName:
Richard Smith5811c402016-04-06 06:26:08 +00005150 AddTypeSourceInfo(DNLoc.NamedType.TInfo);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005151 break;
5152
5153 case DeclarationName::CXXOperatorName:
Richard Smith5811c402016-04-06 06:26:08 +00005154 AddSourceLocation(SourceLocation::getFromRawEncoding(
5155 DNLoc.CXXOperatorName.BeginOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005156 AddSourceLocation(
Richard Smith5811c402016-04-06 06:26:08 +00005157 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005158 break;
5159
5160 case DeclarationName::CXXLiteralOperatorName:
Richard Smith5811c402016-04-06 06:26:08 +00005161 AddSourceLocation(SourceLocation::getFromRawEncoding(
5162 DNLoc.CXXLiteralOperatorName.OpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005163 break;
5164
5165 case DeclarationName::Identifier:
5166 case DeclarationName::ObjCZeroArgSelector:
5167 case DeclarationName::ObjCOneArgSelector:
5168 case DeclarationName::ObjCMultiArgSelector:
5169 case DeclarationName::CXXUsingDirective:
5170 break;
5171 }
5172}
5173
Richard Smith5811c402016-04-06 06:26:08 +00005174void ASTRecordWriter::AddDeclarationNameInfo(
5175 const DeclarationNameInfo &NameInfo) {
5176 AddDeclarationName(NameInfo.getName());
5177 AddSourceLocation(NameInfo.getLoc());
5178 AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName());
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005179}
5180
Richard Smith5811c402016-04-06 06:26:08 +00005181void ASTRecordWriter::AddQualifierInfo(const QualifierInfo &Info) {
5182 AddNestedNameSpecifierLoc(Info.QualifierLoc);
5183 Record->push_back(Info.NumTemplParamLists);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005184 for (unsigned i=0, e=Info.NumTemplParamLists; i != e; ++i)
Richard Smith5811c402016-04-06 06:26:08 +00005185 AddTemplateParameterList(Info.TemplParamLists[i]);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005186}
5187
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005188void ASTWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005189 RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005190 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005191 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005192 SmallVector<NestedNameSpecifier *, 8> NestedNames;
Chris Lattnerca025db2010-05-07 21:43:38 +00005193
5194 // Push each of the NNS's onto a stack for serialization in reverse order.
5195 while (NNS) {
5196 NestedNames.push_back(NNS);
5197 NNS = NNS->getPrefix();
5198 }
5199
5200 Record.push_back(NestedNames.size());
5201 while(!NestedNames.empty()) {
5202 NNS = NestedNames.pop_back_val();
5203 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
5204 Record.push_back(Kind);
5205 switch (Kind) {
5206 case NestedNameSpecifier::Identifier:
5207 AddIdentifierRef(NNS->getAsIdentifier(), Record);
5208 break;
5209
5210 case NestedNameSpecifier::Namespace:
5211 AddDeclRef(NNS->getAsNamespace(), Record);
5212 break;
5213
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005214 case NestedNameSpecifier::NamespaceAlias:
5215 AddDeclRef(NNS->getAsNamespaceAlias(), Record);
5216 break;
5217
Chris Lattnerca025db2010-05-07 21:43:38 +00005218 case NestedNameSpecifier::TypeSpec:
5219 case NestedNameSpecifier::TypeSpecWithTemplate:
5220 AddTypeRef(QualType(NNS->getAsType(), 0), Record);
5221 Record.push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5222 break;
5223
5224 case NestedNameSpecifier::Global:
5225 // Don't need to write an associated value.
5226 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005227
5228 case NestedNameSpecifier::Super:
5229 AddDeclRef(NNS->getAsRecordDecl(), Record);
5230 break;
Chris Lattnerca025db2010-05-07 21:43:38 +00005231 }
5232 }
5233}
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005234
Richard Smith5811c402016-04-06 06:26:08 +00005235void ASTRecordWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005236 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005237 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005238 SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005239
5240 // Push each of the nested-name-specifiers's onto a stack for
5241 // serialization in reverse order.
5242 while (NNS) {
5243 NestedNames.push_back(NNS);
5244 NNS = NNS.getPrefix();
5245 }
5246
Richard Smith5811c402016-04-06 06:26:08 +00005247 Record->push_back(NestedNames.size());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005248 while(!NestedNames.empty()) {
5249 NNS = NestedNames.pop_back_val();
5250 NestedNameSpecifier::SpecifierKind Kind
5251 = NNS.getNestedNameSpecifier()->getKind();
Richard Smith5811c402016-04-06 06:26:08 +00005252 Record->push_back(Kind);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005253 switch (Kind) {
5254 case NestedNameSpecifier::Identifier:
Richard Smith5811c402016-04-06 06:26:08 +00005255 AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier());
5256 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005257 break;
5258
5259 case NestedNameSpecifier::Namespace:
Richard Smith5811c402016-04-06 06:26:08 +00005260 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace());
5261 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005262 break;
5263
5264 case NestedNameSpecifier::NamespaceAlias:
Richard Smith5811c402016-04-06 06:26:08 +00005265 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias());
5266 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005267 break;
5268
5269 case NestedNameSpecifier::TypeSpec:
5270 case NestedNameSpecifier::TypeSpecWithTemplate:
Richard Smith5811c402016-04-06 06:26:08 +00005271 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5272 AddTypeLoc(NNS.getTypeLoc());
5273 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005274 break;
5275
5276 case NestedNameSpecifier::Global:
Richard Smith5811c402016-04-06 06:26:08 +00005277 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005278 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005279
5280 case NestedNameSpecifier::Super:
Richard Smith5811c402016-04-06 06:26:08 +00005281 AddDeclRef(NNS.getNestedNameSpecifier()->getAsRecordDecl());
5282 AddSourceRange(NNS.getLocalSourceRange());
Nikola Smiljanic67860242014-09-26 00:28:20 +00005283 break;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005284 }
5285 }
5286}
5287
Richard Smith5811c402016-04-06 06:26:08 +00005288void ASTRecordWriter::AddTemplateName(TemplateName Name) {
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005289 TemplateName::NameKind Kind = Name.getKind();
Richard Smith5811c402016-04-06 06:26:08 +00005290 Record->push_back(Kind);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005291 switch (Kind) {
5292 case TemplateName::Template:
Richard Smith5811c402016-04-06 06:26:08 +00005293 AddDeclRef(Name.getAsTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005294 break;
5295
5296 case TemplateName::OverloadedTemplate: {
5297 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
Richard Smith5811c402016-04-06 06:26:08 +00005298 Record->push_back(OvT->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005299 for (const auto &I : *OvT)
Richard Smith5811c402016-04-06 06:26:08 +00005300 AddDeclRef(I);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005301 break;
5302 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005303
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005304 case TemplateName::QualifiedTemplate: {
5305 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
Richard Smith5811c402016-04-06 06:26:08 +00005306 AddNestedNameSpecifier(QualT->getQualifier());
5307 Record->push_back(QualT->hasTemplateKeyword());
5308 AddDeclRef(QualT->getTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005309 break;
5310 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005311
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005312 case TemplateName::DependentTemplate: {
5313 DependentTemplateName *DepT = Name.getAsDependentTemplateName();
Richard Smith5811c402016-04-06 06:26:08 +00005314 AddNestedNameSpecifier(DepT->getQualifier());
5315 Record->push_back(DepT->isIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005316 if (DepT->isIdentifier())
Richard Smith5811c402016-04-06 06:26:08 +00005317 AddIdentifierRef(DepT->getIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005318 else
Richard Smith5811c402016-04-06 06:26:08 +00005319 Record->push_back(DepT->getOperator());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005320 break;
5321 }
John McCalld9dfe3a2011-06-30 08:33:18 +00005322
5323 case TemplateName::SubstTemplateTemplateParm: {
5324 SubstTemplateTemplateParmStorage *subst
5325 = Name.getAsSubstTemplateTemplateParm();
Richard Smith5811c402016-04-06 06:26:08 +00005326 AddDeclRef(subst->getParameter());
5327 AddTemplateName(subst->getReplacement());
John McCalld9dfe3a2011-06-30 08:33:18 +00005328 break;
5329 }
Douglas Gregor5590be02011-01-15 06:45:20 +00005330
5331 case TemplateName::SubstTemplateTemplateParmPack: {
5332 SubstTemplateTemplateParmPackStorage *SubstPack
5333 = Name.getAsSubstTemplateTemplateParmPack();
Richard Smith5811c402016-04-06 06:26:08 +00005334 AddDeclRef(SubstPack->getParameterPack());
5335 AddTemplateArgument(SubstPack->getArgumentPack());
Douglas Gregor5590be02011-01-15 06:45:20 +00005336 break;
5337 }
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005338 }
5339}
5340
Richard Smith5811c402016-04-06 06:26:08 +00005341void ASTRecordWriter::AddTemplateArgument(const TemplateArgument &Arg) {
5342 Record->push_back(Arg.getKind());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005343 switch (Arg.getKind()) {
5344 case TemplateArgument::Null:
5345 break;
5346 case TemplateArgument::Type:
Richard Smith5811c402016-04-06 06:26:08 +00005347 AddTypeRef(Arg.getAsType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005348 break;
5349 case TemplateArgument::Declaration:
Richard Smith5811c402016-04-06 06:26:08 +00005350 AddDeclRef(Arg.getAsDecl());
5351 AddTypeRef(Arg.getParamTypeForDecl());
Eli Friedmanb826a002012-09-26 02:36:12 +00005352 break;
5353 case TemplateArgument::NullPtr:
Richard Smith5811c402016-04-06 06:26:08 +00005354 AddTypeRef(Arg.getNullPtrType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005355 break;
5356 case TemplateArgument::Integral:
Richard Smith5811c402016-04-06 06:26:08 +00005357 AddAPSInt(Arg.getAsIntegral());
5358 AddTypeRef(Arg.getIntegralType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005359 break;
5360 case TemplateArgument::Template:
Richard Smith5811c402016-04-06 06:26:08 +00005361 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
Douglas Gregore1d60df2011-01-14 23:41:42 +00005362 break;
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005363 case TemplateArgument::TemplateExpansion:
Richard Smith5811c402016-04-06 06:26:08 +00005364 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
David Blaikie05785d12013-02-20 22:23:23 +00005365 if (Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions())
Richard Smith5811c402016-04-06 06:26:08 +00005366 Record->push_back(*NumExpansions + 1);
Douglas Gregore1d60df2011-01-14 23:41:42 +00005367 else
Richard Smith5811c402016-04-06 06:26:08 +00005368 Record->push_back(0);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005369 break;
5370 case TemplateArgument::Expression:
5371 AddStmt(Arg.getAsExpr());
5372 break;
5373 case TemplateArgument::Pack:
Richard Smith5811c402016-04-06 06:26:08 +00005374 Record->push_back(Arg.pack_size());
Aaron Ballman2a89e852014-07-15 21:32:31 +00005375 for (const auto &P : Arg.pack_elements())
Richard Smith5811c402016-04-06 06:26:08 +00005376 AddTemplateArgument(P);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005377 break;
5378 }
5379}
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005380
5381void
Sebastian Redl55c0ad52010-08-18 23:56:21 +00005382ASTWriter::AddTemplateParameterList(const TemplateParameterList *TemplateParams,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005383 RecordDataImpl &Record) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005384 assert(TemplateParams && "No TemplateParams!");
5385 AddSourceLocation(TemplateParams->getTemplateLoc(), Record);
5386 AddSourceLocation(TemplateParams->getLAngleLoc(), Record);
5387 AddSourceLocation(TemplateParams->getRAngleLoc(), Record);
5388 Record.push_back(TemplateParams->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005389 for (const auto &P : *TemplateParams)
5390 AddDeclRef(P, Record);
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005391}
5392
5393/// \brief Emit a template argument list.
Richard Smith5811c402016-04-06 06:26:08 +00005394void ASTRecordWriter::AddTemplateArgumentList(
5395 const TemplateArgumentList *TemplateArgs) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005396 assert(TemplateArgs && "No TemplateArgs!");
Richard Smith5811c402016-04-06 06:26:08 +00005397 Record->push_back(TemplateArgs->size());
Douglas Gregor1ccc8412010-11-07 23:05:16 +00005398 for (int i=0, e = TemplateArgs->size(); i != e; ++i)
Richard Smith5811c402016-04-06 06:26:08 +00005399 AddTemplateArgument(TemplateArgs->get(i));
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005400}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005401
Richard Smith5811c402016-04-06 06:26:08 +00005402void ASTRecordWriter::AddASTTemplateArgumentListInfo(
5403 const ASTTemplateArgumentListInfo *ASTTemplArgList) {
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005404 assert(ASTTemplArgList && "No ASTTemplArgList!");
Richard Smith5811c402016-04-06 06:26:08 +00005405 AddSourceLocation(ASTTemplArgList->LAngleLoc);
5406 AddSourceLocation(ASTTemplArgList->RAngleLoc);
5407 Record->push_back(ASTTemplArgList->NumTemplateArgs);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005408 const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
5409 for (int i=0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
Richard Smith5811c402016-04-06 06:26:08 +00005410 AddTemplateArgumentLoc(TemplArgs[i]);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005411}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005412
5413void
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00005414ASTWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set, RecordDataImpl &Record) {
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005415 Record.push_back(Set.size());
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00005416 for (ASTUnresolvedSet::const_iterator
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005417 I = Set.begin(), E = Set.end(); I != E; ++I) {
5418 AddDeclRef(I.getDecl(), Record);
5419 Record.push_back(I.getAccess());
5420 }
5421}
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005422
Richard Smith5811c402016-04-06 06:26:08 +00005423// FIXME: Move this out of the main ASTRecordWriter interface.
5424void ASTRecordWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base) {
5425 Record->push_back(Base.isVirtual());
5426 Record->push_back(Base.isBaseOfClass());
5427 Record->push_back(Base.getAccessSpecifierAsWritten());
5428 Record->push_back(Base.getInheritConstructors());
5429 AddTypeSourceInfo(Base.getTypeSourceInfo());
5430 AddSourceRange(Base.getSourceRange());
Douglas Gregor752a5952011-01-03 22:36:02 +00005431 AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
Richard Smith5811c402016-04-06 06:26:08 +00005432 : SourceLocation());
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005433}
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00005434
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005435void ASTWriter::FlushCXXBaseSpecifiers() {
5436 RecordData Record;
Richard Smithc2bb8182015-03-24 06:36:48 +00005437 unsigned N = CXXBaseSpecifiersToWrite.size();
5438 for (unsigned I = 0; I != N; ++I) {
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005439 Record.clear();
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005440
5441 const CXXBaseSpecifier *B = CXXBaseSpecifiersToWrite[I].Bases,
5442 *BEnd = CXXBaseSpecifiersToWrite[I].BasesEnd;
Richard Smith5811c402016-04-06 06:26:08 +00005443
5444 // Write the base specifier set.
5445 ASTRecordWriter Writer(*this, Record);
5446 Writer.push_back(BEnd - B);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005447 for (; B != BEnd; ++B)
Richard Smith5811c402016-04-06 06:26:08 +00005448 Writer.AddCXXBaseSpecifier(*B);
5449 uint64_t Offset = Writer.Emit(serialization::DECL_CXX_BASE_SPECIFIERS);
Douglas Gregord5853042010-10-30 04:28:16 +00005450
Richard Smith5811c402016-04-06 06:26:08 +00005451 // Record the offset of this base-specifier set.
5452 //
5453 // FIXME: We don't need an indirect lookup table for these; instead, write
5454 // the base specifier record prior to the decl record and store its offset
5455 // from the decl record rather than its ID.
5456 unsigned Index = CXXBaseSpecifiersToWrite[I].ID - 1;
5457 if (Index == CXXBaseSpecifiersOffsets.size())
5458 CXXBaseSpecifiersOffsets.push_back(Offset);
5459 else {
5460 if (Index > CXXBaseSpecifiersOffsets.size())
5461 CXXBaseSpecifiersOffsets.resize(Index + 1);
5462 CXXBaseSpecifiersOffsets[Index] = Offset;
5463 }
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005464 }
5465
Richard Smithc2bb8182015-03-24 06:36:48 +00005466 assert(N == CXXBaseSpecifiersToWrite.size() &&
5467 "added more base specifiers while writing base specifiers");
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005468 CXXBaseSpecifiersToWrite.clear();
5469}
5470
Richard Smith5811c402016-04-06 06:26:08 +00005471// FIXME: Move this out of the main ASTRecordWriter interface.
5472void ASTRecordWriter::AddCXXCtorInitializers(
5473 const CXXCtorInitializer *const *CtorInitializers,
5474 unsigned NumCtorInitializers) {
5475 Record->push_back(NumCtorInitializers);
Alexis Hunt1d792652011-01-08 20:30:50 +00005476 for (unsigned i=0; i != NumCtorInitializers; ++i) {
5477 const CXXCtorInitializer *Init = CtorInitializers[i];
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005478
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005479 if (Init->isBaseInitializer()) {
Richard Smith5811c402016-04-06 06:26:08 +00005480 Record->push_back(CTOR_INITIALIZER_BASE);
5481 AddTypeSourceInfo(Init->getTypeSourceInfo());
5482 Record->push_back(Init->isBaseVirtual());
Alexis Hunt37a477f2011-05-04 01:19:08 +00005483 } else if (Init->isDelegatingInitializer()) {
Richard Smith5811c402016-04-06 06:26:08 +00005484 Record->push_back(CTOR_INITIALIZER_DELEGATING);
5485 AddTypeSourceInfo(Init->getTypeSourceInfo());
Alexis Hunt37a477f2011-05-04 01:19:08 +00005486 } else if (Init->isMemberInitializer()){
Richard Smith5811c402016-04-06 06:26:08 +00005487 Record->push_back(CTOR_INITIALIZER_MEMBER);
5488 AddDeclRef(Init->getMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005489 } else {
Richard Smith5811c402016-04-06 06:26:08 +00005490 Record->push_back(CTOR_INITIALIZER_INDIRECT_MEMBER);
5491 AddDeclRef(Init->getIndirectMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005492 }
Francois Pichetd583da02010-12-04 09:14:42 +00005493
Richard Smith5811c402016-04-06 06:26:08 +00005494 AddSourceLocation(Init->getMemberLocation());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005495 AddStmt(Init->getInit());
Richard Smith5811c402016-04-06 06:26:08 +00005496 AddSourceLocation(Init->getLParenLoc());
5497 AddSourceLocation(Init->getRParenLoc());
5498 Record->push_back(Init->isWritten());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005499 if (Init->isWritten()) {
Richard Smith5811c402016-04-06 06:26:08 +00005500 Record->push_back(Init->getSourceOrder());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005501 } else {
Richard Smith5811c402016-04-06 06:26:08 +00005502 Record->push_back(Init->getNumArrayIndices());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005503 for (unsigned i=0, e=Init->getNumArrayIndices(); i != e; ++i)
Richard Smith5811c402016-04-06 06:26:08 +00005504 AddDeclRef(Init->getArrayIndex(i));
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005505 }
5506 }
5507}
5508
Richard Smithc2bb8182015-03-24 06:36:48 +00005509void ASTWriter::FlushCXXCtorInitializers() {
5510 RecordData Record;
5511
5512 unsigned N = CXXCtorInitializersToWrite.size();
Daniel Jasperc77b0a12015-03-24 08:06:38 +00005513 (void)N; // Silence unused warning in non-assert builds.
Richard Smithc2bb8182015-03-24 06:36:48 +00005514 for (auto &Init : CXXCtorInitializersToWrite) {
5515 Record.clear();
5516
Richard Smith5811c402016-04-06 06:26:08 +00005517 ASTRecordWriter Writer(*this, Record);
5518 Writer.AddCXXCtorInitializers(Init.Inits.data(), Init.Inits.size());
5519 uint64_t Offset = Writer.Emit(serialization::DECL_CXX_CTOR_INITIALIZERS);
5520
Richard Smithc2bb8182015-03-24 06:36:48 +00005521 // Record the offset of this mem-initializer list.
5522 unsigned Index = Init.ID - 1;
5523 if (Index == CXXCtorInitializersOffsets.size())
Richard Smith5811c402016-04-06 06:26:08 +00005524 CXXCtorInitializersOffsets.push_back(Offset);
Richard Smithc2bb8182015-03-24 06:36:48 +00005525 else {
5526 if (Index > CXXCtorInitializersOffsets.size())
5527 CXXCtorInitializersOffsets.resize(Index + 1);
Richard Smith5811c402016-04-06 06:26:08 +00005528 CXXCtorInitializersOffsets[Index] = Offset;
Richard Smithc2bb8182015-03-24 06:36:48 +00005529 }
Richard Smithc2bb8182015-03-24 06:36:48 +00005530 }
5531
5532 assert(N == CXXCtorInitializersToWrite.size() &&
5533 "added more ctor initializers while writing ctor initializers");
5534 CXXCtorInitializersToWrite.clear();
5535}
5536
Richard Smith5811c402016-04-06 06:26:08 +00005537void ASTRecordWriter::AddCXXDefinitionData(const CXXRecordDecl *D) {
Richard Smith053f6c62014-05-16 23:01:30 +00005538 auto &Data = D->data();
Richard Smith5811c402016-04-06 06:26:08 +00005539 Record->push_back(Data.IsLambda);
5540 Record->push_back(Data.UserDeclaredConstructor);
5541 Record->push_back(Data.UserDeclaredSpecialMembers);
5542 Record->push_back(Data.Aggregate);
5543 Record->push_back(Data.PlainOldData);
5544 Record->push_back(Data.Empty);
5545 Record->push_back(Data.Polymorphic);
5546 Record->push_back(Data.Abstract);
5547 Record->push_back(Data.IsStandardLayout);
5548 Record->push_back(Data.HasNoNonEmptyBases);
5549 Record->push_back(Data.HasPrivateFields);
5550 Record->push_back(Data.HasProtectedFields);
5551 Record->push_back(Data.HasPublicFields);
5552 Record->push_back(Data.HasMutableFields);
5553 Record->push_back(Data.HasVariantMembers);
5554 Record->push_back(Data.HasOnlyCMembers);
5555 Record->push_back(Data.HasInClassInitializer);
5556 Record->push_back(Data.HasUninitializedReferenceMember);
5557 Record->push_back(Data.HasUninitializedFields);
5558 Record->push_back(Data.NeedOverloadResolutionForMoveConstructor);
5559 Record->push_back(Data.NeedOverloadResolutionForMoveAssignment);
5560 Record->push_back(Data.NeedOverloadResolutionForDestructor);
5561 Record->push_back(Data.DefaultedMoveConstructorIsDeleted);
5562 Record->push_back(Data.DefaultedMoveAssignmentIsDeleted);
5563 Record->push_back(Data.DefaultedDestructorIsDeleted);
5564 Record->push_back(Data.HasTrivialSpecialMembers);
5565 Record->push_back(Data.DeclaredNonTrivialSpecialMembers);
5566 Record->push_back(Data.HasIrrelevantDestructor);
5567 Record->push_back(Data.HasConstexprNonCopyMoveConstructor);
5568 Record->push_back(Data.HasDefaultedDefaultConstructor);
5569 Record->push_back(Data.DefaultedDefaultConstructorIsConstexpr);
5570 Record->push_back(Data.HasConstexprDefaultConstructor);
5571 Record->push_back(Data.HasNonLiteralTypeFieldsOrBases);
5572 Record->push_back(Data.ComputedVisibleConversions);
5573 Record->push_back(Data.UserProvidedDefaultConstructor);
5574 Record->push_back(Data.DeclaredSpecialMembers);
5575 Record->push_back(Data.ImplicitCopyConstructorHasConstParam);
5576 Record->push_back(Data.ImplicitCopyAssignmentHasConstParam);
5577 Record->push_back(Data.HasDeclaredCopyConstructorWithConstParam);
5578 Record->push_back(Data.HasDeclaredCopyAssignmentWithConstParam);
Richard Smith561fb152012-02-25 07:33:38 +00005579 // IsLambda bit is already saved.
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005580
Richard Smith5811c402016-04-06 06:26:08 +00005581 Record->push_back(Data.NumBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005582 if (Data.NumBases > 0)
Richard Smith5811c402016-04-06 06:26:08 +00005583 AddCXXBaseSpecifiersRef(Data.getBases(), Data.getBases() + Data.NumBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005584
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005585 // FIXME: Make VBases lazily computed when needed to avoid storing them.
Richard Smith5811c402016-04-06 06:26:08 +00005586 Record->push_back(Data.NumVBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005587 if (Data.NumVBases > 0)
Richard Smith5811c402016-04-06 06:26:08 +00005588 AddCXXBaseSpecifiersRef(Data.getVBases(),
5589 Data.getVBases() + Data.NumVBases);
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005590
Richard Smith5811c402016-04-06 06:26:08 +00005591 AddUnresolvedSet(Data.Conversions.get(*Writer->Context));
5592 AddUnresolvedSet(Data.VisibleConversions.get(*Writer->Context));
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005593 // Data.Definition is the owning decl, no need to write it.
Richard Smith5811c402016-04-06 06:26:08 +00005594 AddDeclRef(D->getFirstFriend());
Douglas Gregor99ae8062012-02-14 17:54:36 +00005595
5596 // Add lambda-specific data.
5597 if (Data.IsLambda) {
Richard Smith053f6c62014-05-16 23:01:30 +00005598 auto &Lambda = D->getLambdaData();
Richard Smith5811c402016-04-06 06:26:08 +00005599 Record->push_back(Lambda.Dependent);
5600 Record->push_back(Lambda.IsGenericLambda);
5601 Record->push_back(Lambda.CaptureDefault);
5602 Record->push_back(Lambda.NumCaptures);
5603 Record->push_back(Lambda.NumExplicitCaptures);
5604 Record->push_back(Lambda.ManglingNumber);
5605 AddDeclRef(Lambda.ContextDecl);
5606 AddTypeSourceInfo(Lambda.MethodTyInfo);
Douglas Gregor99ae8062012-02-14 17:54:36 +00005607 for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00005608 const LambdaCapture &Capture = Lambda.Captures[I];
Richard Smith5811c402016-04-06 06:26:08 +00005609 AddSourceLocation(Capture.getLocation());
5610 Record->push_back(Capture.isImplicit());
5611 Record->push_back(Capture.getCaptureKind());
Richard Smithba71c082013-05-16 06:20:58 +00005612 switch (Capture.getCaptureKind()) {
Faisal Validc6b5962016-03-21 09:25:37 +00005613 case LCK_StarThis:
Richard Smithba71c082013-05-16 06:20:58 +00005614 case LCK_This:
Alexey Bataev39c81e22014-08-28 04:28:19 +00005615 case LCK_VLAType:
Richard Smithba71c082013-05-16 06:20:58 +00005616 break;
5617 case LCK_ByCopy:
Richard Smithbb13c9a2013-09-28 04:02:39 +00005618 case LCK_ByRef:
Richard Smithba71c082013-05-16 06:20:58 +00005619 VarDecl *Var =
Craig Toppera13603a2014-05-22 05:54:18 +00005620 Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
Richard Smith5811c402016-04-06 06:26:08 +00005621 AddDeclRef(Var);
Richard Smithba71c082013-05-16 06:20:58 +00005622 AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc()
Richard Smith5811c402016-04-06 06:26:08 +00005623 : SourceLocation());
Richard Smithba71c082013-05-16 06:20:58 +00005624 break;
5625 }
Douglas Gregor99ae8062012-02-14 17:54:36 +00005626 }
5627 }
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005628}
5629
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005630void ASTWriter::ReaderInitialized(ASTReader *Reader) {
Sebastian Redl07a89a82010-07-30 00:29:29 +00005631 assert(Reader && "Cannot remove chain");
Douglas Gregordf0c1512011-08-18 04:12:04 +00005632 assert((!Chain || Chain == Reader) && "Cannot replace chain");
Sebastian Redl07a89a82010-07-30 00:29:29 +00005633 assert(FirstDeclID == NextDeclID &&
5634 FirstTypeID == NextTypeID &&
5635 FirstIdentID == NextIdentID &&
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005636 FirstMacroID == NextMacroID &&
Douglas Gregor253eefe2011-12-01 00:59:36 +00005637 FirstSubmoduleID == NextSubmoduleID &&
Sebastian Redld95a56e2010-08-04 18:21:41 +00005638 FirstSelectorID == NextSelectorID &&
Sebastian Redl07a89a82010-07-30 00:29:29 +00005639 "Setting chain after writing has started.");
Douglas Gregor925296b2011-07-19 16:10:42 +00005640
Sebastian Redl07a89a82010-07-30 00:29:29 +00005641 Chain = Reader;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005642
Richard Smith7f330cd2015-03-18 01:42:29 +00005643 // Note, this will get called multiple times, once one the reader starts up
5644 // and again each time it's done reading a PCH or module.
Douglas Gregordf0c1512011-08-18 04:12:04 +00005645 FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls();
5646 FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes();
5647 FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005648 FirstMacroID = NUM_PREDEF_MACRO_IDS + Chain->getTotalNumMacros();
Douglas Gregor253eefe2011-12-01 00:59:36 +00005649 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
Douglas Gregordf0c1512011-08-18 04:12:04 +00005650 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005651 NextDeclID = FirstDeclID;
5652 NextTypeID = FirstTypeID;
5653 NextIdentID = FirstIdentID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005654 NextMacroID = FirstMacroID;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005655 NextSelectorID = FirstSelectorID;
Douglas Gregor253eefe2011-12-01 00:59:36 +00005656 NextSubmoduleID = FirstSubmoduleID;
Sebastian Redl07a89a82010-07-30 00:29:29 +00005657}
5658
Sebastian Redl539c5062010-08-18 23:57:32 +00005659void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005660 // Always keep the highest ID. See \p TypeRead() for more information.
5661 IdentID &StoredID = IdentifierIDs[II];
5662 if (ID > StoredID)
5663 StoredID = ID;
Sebastian Redlff4a2952010-07-23 23:49:55 +00005664}
5665
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005666void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005667 // Always keep the highest ID. See \p TypeRead() for more information.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005668 MacroID &StoredID = MacroIDs[MI];
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005669 if (ID > StoredID)
5670 StoredID = ID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005671}
5672
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00005673void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005674 // Always take the highest-numbered type index. This copes with an interesting
5675 // case for chained AST writing where we schedule writing the type and then,
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005676 // later, deserialize the type from another AST. In this case, we want to
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005677 // keep the higher-numbered entry so that we can properly write it out to
5678 // the AST file.
5679 TypeIdx &StoredIdx = TypeIdxs[T];
5680 if (Idx.getIndex() >= StoredIdx.getIndex())
5681 StoredIdx = Idx;
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00005682}
5683
Sebastian Redl539c5062010-08-18 23:57:32 +00005684void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005685 // Always keep the highest ID. See \p TypeRead() for more information.
5686 SelectorID &StoredID = SelectorIDs[S];
5687 if (ID > StoredID)
5688 StoredID = ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00005689}
Douglas Gregor91096292010-10-02 19:29:26 +00005690
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00005691void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
Richard Smith66a81862015-05-04 02:25:31 +00005692 MacroDefinitionRecord *MD) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00005693 assert(MacroDefinitions.find(MD) == MacroDefinitions.end());
Douglas Gregor91096292010-10-02 19:29:26 +00005694 MacroDefinitions[MD] = ID;
5695}
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005696
Douglas Gregore37a85a2011-12-02 17:30:13 +00005697void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
5698 assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end());
5699 SubmoduleIDs[Mod] = ID;
5700}
5701
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005702void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
John McCallf937c022011-10-07 06:10:15 +00005703 assert(D->isCompleteDefinition());
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005704 assert(!WritingAST && "Already writing the AST!");
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005705 if (auto *RD = dyn_cast<CXXRecordDecl>(D)) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005706 // We are interested when a PCH decl is modified.
Douglas Gregorb3722e22011-09-09 23:01:35 +00005707 if (RD->isFromASTFile()) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005708 // A forward reference was mutated into a definition. Rewrite it.
5709 // FIXME: This happens during template instantiation, should we
5710 // have created a new definition decl instead ?
Richard Smithcd45dbc2014-04-19 03:48:30 +00005711 assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
5712 "completed a tag from another module but not by instantiation?");
5713 DeclUpdates[RD].push_back(
5714 DeclUpdate(UPD_CXX_INSTANTIATED_CLASS_DEFINITION));
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005715 }
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00005716 }
5717}
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005718
Richard Smithf983f7f2015-10-13 00:23:25 +00005719static bool isImportedDeclContext(ASTReader *Chain, const Decl *D) {
5720 if (D->isFromASTFile())
5721 return true;
5722
5723 // If we've not loaded any modules, this can't be imported.
5724 if (!Chain || !Chain->getModuleManager().size())
5725 return false;
5726
5727 // The predefined __va_list_tag struct is imported if we imported any decls.
5728 // FIXME: This is a gross hack.
5729 return D == D->getASTContext().getVaListTagDecl();
5730}
5731
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005732void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
Vassil Vassilev632eac32016-03-16 11:17:04 +00005733 // TU is handled elsewhere.
5734 if (isa<TranslationUnitDecl>(DC))
5735 return;
5736
5737 // Namespaces are handled elsewhere, except for template instantiations of
5738 // FunctionTemplateDecls in namespaces. We are interested in cases where the
5739 // local instantiations are added to an imported context. Only happens when
5740 // adding ADL lookup candidates, for example templated friends.
5741 if (isa<NamespaceDecl>(DC) && D->getFriendObjectKind() == Decl::FOK_None &&
5742 !isa<FunctionTemplateDecl>(D))
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005743 return;
5744
Richard Smithf983f7f2015-10-13 00:23:25 +00005745 // We're only interested in cases where a local declaration is added to an
5746 // imported context.
5747 if (D->isFromASTFile() || !isImportedDeclContext(Chain, cast<Decl>(DC)))
5748 return;
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005749
Richard Smith0f4e2c42015-08-06 04:23:48 +00005750 assert(DC == DC->getPrimaryContext() && "added to non-primary context");
Douglas Gregor9f782892013-01-21 15:25:38 +00005751 assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
Richard Smithe9a8bc32014-09-30 00:45:29 +00005752 assert(!WritingAST && "Already writing the AST!");
Richard Smithf983f7f2015-10-13 00:23:25 +00005753 if (UpdatedDeclContexts.insert(DC) && !cast<Decl>(DC)->isFromASTFile()) {
5754 // We're adding a visible declaration to a predefined decl context. Ensure
5755 // that we write out all of its lookup results so we don't get a nasty
5756 // surprise when we try to emit its lookup table.
5757 for (auto *Child : DC->decls())
5758 UpdatingVisibleDecls.push_back(Child);
5759 }
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005760 UpdatingVisibleDecls.push_back(D);
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00005761}
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005762
5763void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
5764 assert(D->isImplicit());
Richard Smithf983f7f2015-10-13 00:23:25 +00005765
5766 // We're only interested in cases where a local declaration is added to an
5767 // imported context.
5768 if (D->isFromASTFile() || !isImportedDeclContext(Chain, RD))
5769 return;
5770
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005771 if (!isa<CXXMethodDecl>(D))
Richard Smithf983f7f2015-10-13 00:23:25 +00005772 return;
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005773
5774 // A decl coming from PCH was modified.
John McCallf937c022011-10-07 06:10:15 +00005775 assert(RD->isCompleteDefinition());
Richard Smithe9a8bc32014-09-30 00:45:29 +00005776 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00005777 DeclUpdates[RD].push_back(DeclUpdate(UPD_CXX_ADDED_IMPLICIT_MEMBER, D));
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00005778}
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00005779
Richard Smith564417a2014-03-20 21:47:22 +00005780void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
Richard Smith9e2341d2015-03-23 03:25:59 +00005781 assert(!DoneWritingDeclsAndTypes && "Already done writing updates!");
5782 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00005783 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00005784 // If we don't already know the exception specification for this redecl
5785 // chain, add an update record for it.
5786 if (isUnresolvedExceptionSpec(cast<FunctionDecl>(D)
5787 ->getType()
5788 ->castAs<FunctionProtoType>()
5789 ->getExceptionSpecType()))
5790 DeclUpdates[D].push_back(UPD_CXX_RESOLVED_EXCEPTION_SPEC);
5791 });
Richard Smith564417a2014-03-20 21:47:22 +00005792}
5793
Richard Smith1fa5d642013-05-11 05:45:24 +00005794void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
5795 assert(!WritingAST && "Already writing the AST!");
Richard Smith9e2341d2015-03-23 03:25:59 +00005796 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00005797 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00005798 DeclUpdates[D].push_back(
5799 DeclUpdate(UPD_CXX_DEDUCED_RETURN_TYPE, ReturnType));
5800 });
Richard Smith1fa5d642013-05-11 05:45:24 +00005801}
5802
Richard Smithf8134002015-03-10 01:41:22 +00005803void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD,
5804 const FunctionDecl *Delete) {
5805 assert(!WritingAST && "Already writing the AST!");
5806 assert(Delete && "Not given an operator delete");
Richard Smith9e2341d2015-03-23 03:25:59 +00005807 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00005808 Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00005809 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_RESOLVED_DTOR_DELETE, Delete));
5810 });
Richard Smithf8134002015-03-10 01:41:22 +00005811}
5812
Sebastian Redlab238a72011-04-24 16:28:06 +00005813void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005814 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005815 if (!D->isFromASTFile())
Sebastian Redlab238a72011-04-24 16:28:06 +00005816 return; // Declaration not imported from PCH.
5817
Richard Smith4d235792014-08-07 18:53:08 +00005818 // Implicit function decl from a PCH was defined.
5819 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Sebastian Redlab238a72011-04-24 16:28:06 +00005820}
5821
Richard Smithd28ac5b2014-03-22 23:33:22 +00005822void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
5823 assert(!WritingAST && "Already writing the AST!");
5824 if (!D->isFromASTFile())
5825 return;
5826
Richard Smith9e2341d2015-03-23 03:25:59 +00005827 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Richard Smithd28ac5b2014-03-22 23:33:22 +00005828}
5829
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005830void ASTWriter::StaticDataMemberInstantiated(const VarDecl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005831 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005832 if (!D->isFromASTFile())
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005833 return;
5834
5835 // Since the actual instantiation is delayed, this really means that we need
5836 // to update the instantiation location.
Richard Smith6ef42932014-03-20 21:02:00 +00005837 DeclUpdates[D].push_back(
Aaron Ballman4f45b712014-03-21 15:22:56 +00005838 DeclUpdate(UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER,
5839 D->getMemberSpecializationInfo()->getPointOfInstantiation()));
Sebastian Redl2ac2c722011-04-29 08:19:30 +00005840}
5841
John McCall32791cc2016-01-06 22:34:54 +00005842void ASTWriter::DefaultArgumentInstantiated(const ParmVarDecl *D) {
5843 assert(!WritingAST && "Already writing the AST!");
5844 if (!D->isFromASTFile())
5845 return;
5846
5847 DeclUpdates[D].push_back(
5848 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT, D));
5849}
5850
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005851void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
5852 const ObjCInterfaceDecl *IFD) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005853 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00005854 if (!IFD->isFromASTFile())
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005855 return; // Declaration not imported from PCH.
Douglas Gregor404cdde2012-01-27 01:47:08 +00005856
5857 assert(IFD->getDefinition() && "Category on a class without a definition?");
5858 ObjCClassesWithCategories.insert(
5859 const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00005860}
Argyrios Kyrtzidisb97a4022011-11-12 21:07:46 +00005861
Eli Friedman276dd182013-09-05 00:02:25 +00005862void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
5863 assert(!WritingAST && "Already writing the AST!");
5864 if (!D->isFromASTFile())
5865 return;
5866
Aaron Ballman4f45b712014-03-21 15:22:56 +00005867 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_USED));
Eli Friedman276dd182013-09-05 00:02:25 +00005868}
Alexey Bataev97720002014-11-11 04:05:39 +00005869
5870void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
5871 assert(!WritingAST && "Already writing the AST!");
5872 if (!D->isFromASTFile())
5873 return;
5874
5875 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_THREADPRIVATE));
5876}
Richard Smith65ebb4a2015-03-26 04:09:53 +00005877
Richard Smith4caa4492015-05-15 02:34:32 +00005878void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) {
Richard Smith65ebb4a2015-03-26 04:09:53 +00005879 assert(!WritingAST && "Already writing the AST!");
5880 assert(D->isHidden() && "expected a hidden declaration");
Richard Smith4caa4492015-05-15 02:34:32 +00005881 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_EXPORTED, M));
Richard Smith65ebb4a2015-03-26 04:09:53 +00005882}
Alex Denisovfde64952015-06-26 05:28:36 +00005883
5884void ASTWriter::AddedAttributeToRecord(const Attr *Attr,
5885 const RecordDecl *Record) {
5886 assert(!WritingAST && "Already writing the AST!");
5887 if (!Record->isFromASTFile())
5888 return;
5889 DeclUpdates[Record].push_back(DeclUpdate(UPD_ADDED_ATTR_TO_RECORD, Attr));
5890}